* NEWS, MH-E-NEWS: Update for MH-E release 8.2.90.
[emacs.git] / src / buffer.c
blob1b8b1117893e427eed58ca139e6524ce8818b3e9
1 /* Buffer manipulation primitives for GNU Emacs.
3 Copyright (C) 1985-1989, 1993-1995, 1997-2011 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 3 of the License, or
10 (at your option) 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. If not, see <http://www.gnu.org/licenses/>. */
20 #include <config.h>
22 #include <sys/types.h>
23 #include <sys/stat.h>
24 #include <sys/param.h>
25 #include <errno.h>
26 #include <stdio.h>
27 #include <setjmp.h>
28 #include <unistd.h>
30 #include <verify.h>
32 #include "lisp.h"
33 #include "intervals.h"
34 #include "window.h"
35 #include "commands.h"
36 #include "buffer.h"
37 #include "character.h"
38 #include "region-cache.h"
39 #include "indent.h"
40 #include "blockinput.h"
41 #include "keyboard.h"
42 #include "keymap.h"
43 #include "frame.h"
45 struct buffer *current_buffer; /* the current buffer */
47 /* First buffer in chain of all buffers (in reverse order of creation).
48 Threaded through ->header.next.buffer. */
50 struct buffer *all_buffers;
52 /* This structure holds the default values of the buffer-local variables
53 defined with DEFVAR_PER_BUFFER, that have special slots in each buffer.
54 The default value occupies the same slot in this structure
55 as an individual buffer's value occupies in that buffer.
56 Setting the default value also goes through the alist of buffers
57 and stores into each buffer that does not say it has a local value. */
59 DECL_ALIGN (struct buffer, buffer_defaults);
61 /* A Lisp_Object pointer to the above, used for staticpro */
63 static Lisp_Object Vbuffer_defaults;
65 /* This structure marks which slots in a buffer have corresponding
66 default values in buffer_defaults.
67 Each such slot has a nonzero value in this structure.
68 The value has only one nonzero bit.
70 When a buffer has its own local value for a slot,
71 the entry for that slot (found in the same slot in this structure)
72 is turned on in the buffer's local_flags array.
74 If a slot in this structure is -1, then even though there may
75 be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
76 and the corresponding slot in buffer_defaults is not used.
78 If a slot in this structure corresponding to a DEFVAR_PER_BUFFER is
79 zero, that is a bug */
81 struct buffer buffer_local_flags;
83 /* This structure holds the names of symbols whose values may be
84 buffer-local. It is indexed and accessed in the same way as the above. */
86 DECL_ALIGN (struct buffer, buffer_local_symbols);
88 /* A Lisp_Object pointer to the above, used for staticpro */
89 static Lisp_Object Vbuffer_local_symbols;
91 /* Return the symbol of the per-buffer variable at offset OFFSET in
92 the buffer structure. */
94 #define PER_BUFFER_SYMBOL(OFFSET) \
95 (*(Lisp_Object *)((OFFSET) + (char *) &buffer_local_symbols))
97 /* Maximum length of an overlay vector. */
98 #define OVERLAY_COUNT_MAX \
99 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, \
100 min (PTRDIFF_MAX, SIZE_MAX) / sizeof (Lisp_Object)))
102 /* Flags indicating which built-in buffer-local variables
103 are permanent locals. */
104 static char buffer_permanent_local_flags[MAX_PER_BUFFER_VARS];
106 /* Number of per-buffer variables used. */
108 int last_per_buffer_idx;
110 static Lisp_Object Fset_buffer_major_mode (Lisp_Object);
111 static Lisp_Object Fdelete_overlay (Lisp_Object);
112 static void call_overlay_mod_hooks (Lisp_Object list, Lisp_Object overlay,
113 int after, Lisp_Object arg1,
114 Lisp_Object arg2, Lisp_Object arg3);
115 static void swap_out_buffer_local_variables (struct buffer *b);
116 static void reset_buffer_local_variables (struct buffer *b, int permanent_too);
118 /* Alist of all buffer names vs the buffers. */
119 /* This used to be a variable, but is no longer,
120 to prevent lossage due to user rplac'ing this alist or its elements. */
121 Lisp_Object Vbuffer_alist;
123 static Lisp_Object Qkill_buffer_query_functions;
125 /* Hook run before changing a major mode. */
126 static Lisp_Object Qchange_major_mode_hook;
128 Lisp_Object Qfirst_change_hook;
129 Lisp_Object Qbefore_change_functions;
130 Lisp_Object Qafter_change_functions;
131 static Lisp_Object Qucs_set_table_for_input;
133 static Lisp_Object Qfundamental_mode, Qmode_class, Qpermanent_local;
134 static Lisp_Object Qpermanent_local_hook;
136 static Lisp_Object Qprotected_field;
138 static Lisp_Object QSFundamental; /* A string "Fundamental" */
140 static Lisp_Object Qkill_buffer_hook;
141 static Lisp_Object Qbuffer_list_update_hook;
143 static Lisp_Object Qget_file_buffer;
145 static Lisp_Object Qoverlayp;
147 Lisp_Object Qpriority, Qbefore_string, Qafter_string;
149 static Lisp_Object Qevaporate;
151 Lisp_Object Qmodification_hooks;
152 Lisp_Object Qinsert_in_front_hooks;
153 Lisp_Object Qinsert_behind_hooks;
155 static void alloc_buffer_text (struct buffer *, size_t);
156 static void free_buffer_text (struct buffer *b);
157 static struct Lisp_Overlay * copy_overlays (struct buffer *, struct Lisp_Overlay *);
158 static void modify_overlay (struct buffer *, EMACS_INT, EMACS_INT);
159 static Lisp_Object buffer_lisp_local_variables (struct buffer *);
161 /* For debugging; temporary. See set_buffer_internal. */
162 /* Lisp_Object Qlisp_mode, Vcheck_symbol; */
164 void
165 nsberror (Lisp_Object spec)
167 if (STRINGP (spec))
168 error ("No buffer named %s", SDATA (spec));
169 error ("Invalid buffer argument");
172 DEFUN ("buffer-live-p", Fbuffer_live_p, Sbuffer_live_p, 1, 1, 0,
173 doc: /* Return non-nil if OBJECT is a buffer which has not been killed.
174 Value is nil if OBJECT is not a buffer or if it has been killed. */)
175 (Lisp_Object object)
177 return ((BUFFERP (object) && ! NILP (BVAR (XBUFFER (object), name)))
178 ? Qt : Qnil);
181 DEFUN ("buffer-list", Fbuffer_list, Sbuffer_list, 0, 1, 0,
182 doc: /* Return a list of all existing live buffers.
183 If the optional arg FRAME is a frame, we return the buffer list in the
184 proper order for that frame: the buffers show in FRAME come first,
185 followed by the rest of the buffers. */)
186 (Lisp_Object frame)
188 Lisp_Object general;
189 general = Fmapcar (Qcdr, Vbuffer_alist);
191 if (FRAMEP (frame))
193 Lisp_Object framelist, prevlist, tail;
194 Lisp_Object args[3];
196 CHECK_FRAME (frame);
197 framelist = Fcopy_sequence (XFRAME (frame)->buffer_list);
198 prevlist = Fnreverse (Fcopy_sequence
199 (XFRAME (frame)->buried_buffer_list));
201 /* Remove from GENERAL any buffer that duplicates one in
202 FRAMELIST or PREVLIST. */
203 tail = framelist;
204 while (CONSP (tail))
206 general = Fdelq (XCAR (tail), general);
207 tail = XCDR (tail);
209 tail = prevlist;
210 while (CONSP (tail))
212 general = Fdelq (XCAR (tail), general);
213 tail = XCDR (tail);
216 args[0] = framelist;
217 args[1] = general;
218 args[2] = prevlist;
219 return Fnconc (3, args);
221 else
222 return general;
225 /* Like Fassoc, but use Fstring_equal to compare
226 (which ignores text properties),
227 and don't ever QUIT. */
229 static Lisp_Object
230 assoc_ignore_text_properties (register Lisp_Object key, Lisp_Object list)
232 register Lisp_Object tail;
233 for (tail = list; CONSP (tail); tail = XCDR (tail))
235 register Lisp_Object elt, tem;
236 elt = XCAR (tail);
237 tem = Fstring_equal (Fcar (elt), key);
238 if (!NILP (tem))
239 return elt;
241 return Qnil;
244 DEFUN ("get-buffer", Fget_buffer, Sget_buffer, 1, 1, 0,
245 doc: /* Return the buffer named BUFFER-OR-NAME.
246 BUFFER-OR-NAME must be either a string or a buffer. If BUFFER-OR-NAME
247 is a string and there is no buffer with that name, return nil. If
248 BUFFER-OR-NAME is a buffer, return it as given. */)
249 (register Lisp_Object buffer_or_name)
251 if (BUFFERP (buffer_or_name))
252 return buffer_or_name;
253 CHECK_STRING (buffer_or_name);
255 return Fcdr (assoc_ignore_text_properties (buffer_or_name, Vbuffer_alist));
258 DEFUN ("get-file-buffer", Fget_file_buffer, Sget_file_buffer, 1, 1, 0,
259 doc: /* Return the buffer visiting file FILENAME (a string).
260 The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.
261 If there is no such live buffer, return nil.
262 See also `find-buffer-visiting'. */)
263 (register Lisp_Object filename)
265 register Lisp_Object tail, buf, tem;
266 Lisp_Object handler;
268 CHECK_STRING (filename);
269 filename = Fexpand_file_name (filename, Qnil);
271 /* If the file name has special constructs in it,
272 call the corresponding file handler. */
273 handler = Ffind_file_name_handler (filename, Qget_file_buffer);
274 if (!NILP (handler))
275 return call2 (handler, Qget_file_buffer, filename);
277 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
279 buf = Fcdr (XCAR (tail));
280 if (!BUFFERP (buf)) continue;
281 if (!STRINGP (BVAR (XBUFFER (buf), filename))) continue;
282 tem = Fstring_equal (BVAR (XBUFFER (buf), filename), filename);
283 if (!NILP (tem))
284 return buf;
286 return Qnil;
289 Lisp_Object
290 get_truename_buffer (register Lisp_Object filename)
292 register Lisp_Object tail, buf, tem;
294 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
296 buf = Fcdr (XCAR (tail));
297 if (!BUFFERP (buf)) continue;
298 if (!STRINGP (BVAR (XBUFFER (buf), file_truename))) continue;
299 tem = Fstring_equal (BVAR (XBUFFER (buf), file_truename), filename);
300 if (!NILP (tem))
301 return buf;
303 return Qnil;
306 DEFUN ("get-buffer-create", Fget_buffer_create, Sget_buffer_create, 1, 1, 0,
307 doc: /* Return the buffer specified by BUFFER-OR-NAME, creating a new one if needed.
308 If BUFFER-OR-NAME is a string and a live buffer with that name exists,
309 return that buffer. If no such buffer exists, create a new buffer with
310 that name and return it. If BUFFER-OR-NAME starts with a space, the new
311 buffer does not keep undo information.
313 If BUFFER-OR-NAME is a buffer instead of a string, return it as given,
314 even if it is dead. The return value is never nil. */)
315 (register Lisp_Object buffer_or_name)
317 register Lisp_Object buffer, name;
318 register struct buffer *b;
320 buffer = Fget_buffer (buffer_or_name);
321 if (!NILP (buffer))
322 return buffer;
324 if (SCHARS (buffer_or_name) == 0)
325 error ("Empty string for buffer name is not allowed");
327 b = allocate_buffer ();
329 /* An ordinary buffer uses its own struct buffer_text. */
330 b->text = &b->own_text;
331 b->base_buffer = 0;
333 BUF_GAP_SIZE (b) = 20;
334 BLOCK_INPUT;
335 /* We allocate extra 1-byte at the tail and keep it always '\0' for
336 anchoring a search. */
337 alloc_buffer_text (b, BUF_GAP_SIZE (b) + 1);
338 UNBLOCK_INPUT;
339 if (! BUF_BEG_ADDR (b))
340 buffer_memory_full (BUF_GAP_SIZE (b) + 1);
342 b->pt = BEG;
343 b->begv = BEG;
344 b->zv = BEG;
345 b->pt_byte = BEG_BYTE;
346 b->begv_byte = BEG_BYTE;
347 b->zv_byte = BEG_BYTE;
349 BUF_GPT (b) = BEG;
350 BUF_GPT_BYTE (b) = BEG_BYTE;
352 BUF_Z (b) = BEG;
353 BUF_Z_BYTE (b) = BEG_BYTE;
354 BUF_MODIFF (b) = 1;
355 BUF_CHARS_MODIFF (b) = 1;
356 BUF_OVERLAY_MODIFF (b) = 1;
357 BUF_SAVE_MODIFF (b) = 1;
358 BUF_INTERVALS (b) = 0;
359 BUF_UNCHANGED_MODIFIED (b) = 1;
360 BUF_OVERLAY_UNCHANGED_MODIFIED (b) = 1;
361 BUF_END_UNCHANGED (b) = 0;
362 BUF_BEG_UNCHANGED (b) = 0;
363 *(BUF_GPT_ADDR (b)) = *(BUF_Z_ADDR (b)) = 0; /* Put an anchor '\0'. */
365 b->newline_cache = 0;
366 b->width_run_cache = 0;
367 BVAR (b, width_table) = Qnil;
368 b->prevent_redisplay_optimizations_p = 1;
370 /* Put this on the chain of all buffers including killed ones. */
371 b->header.next.buffer = all_buffers;
372 all_buffers = b;
374 /* An ordinary buffer normally doesn't need markers
375 to handle BEGV and ZV. */
376 BVAR (b, pt_marker) = Qnil;
377 BVAR (b, begv_marker) = Qnil;
378 BVAR (b, zv_marker) = Qnil;
380 name = Fcopy_sequence (buffer_or_name);
381 STRING_SET_INTERVALS (name, NULL_INTERVAL);
382 BVAR (b, name) = name;
384 BVAR (b, undo_list) = (SREF (name, 0) != ' ') ? Qnil : Qt;
386 reset_buffer (b);
387 reset_buffer_local_variables (b, 1);
389 BVAR (b, mark) = Fmake_marker ();
390 BUF_MARKERS (b) = NULL;
391 BVAR (b, name) = name;
393 /* Put this in the alist of all live buffers. */
394 XSETBUFFER (buffer, b);
395 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buffer), Qnil));
396 /* And run buffer-list-update-hook. */
397 if (!NILP (Vrun_hooks))
398 call1 (Vrun_hooks, Qbuffer_list_update_hook);
400 /* An error in calling the function here (should someone redefine it)
401 can lead to infinite regress until you run out of stack. rms
402 says that's not worth protecting against. */
403 if (!NILP (Ffboundp (Qucs_set_table_for_input)))
404 /* buffer is on buffer-alist, so no gcpro. */
405 call1 (Qucs_set_table_for_input, buffer);
407 return buffer;
411 /* Return a list of overlays which is a copy of the overlay list
412 LIST, but for buffer B. */
414 static struct Lisp_Overlay *
415 copy_overlays (struct buffer *b, struct Lisp_Overlay *list)
417 Lisp_Object buffer;
418 struct Lisp_Overlay *result = NULL, *tail = NULL;
420 XSETBUFFER (buffer, b);
422 for (; list; list = list->next)
424 Lisp_Object overlay, start, end, old_overlay;
425 EMACS_INT charpos;
427 XSETMISC (old_overlay, list);
428 charpos = marker_position (OVERLAY_START (old_overlay));
429 start = Fmake_marker ();
430 Fset_marker (start, make_number (charpos), buffer);
431 XMARKER (start)->insertion_type
432 = XMARKER (OVERLAY_START (old_overlay))->insertion_type;
434 charpos = marker_position (OVERLAY_END (old_overlay));
435 end = Fmake_marker ();
436 Fset_marker (end, make_number (charpos), buffer);
437 XMARKER (end)->insertion_type
438 = XMARKER (OVERLAY_END (old_overlay))->insertion_type;
440 overlay = allocate_misc ();
441 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
442 OVERLAY_START (overlay) = start;
443 OVERLAY_END (overlay) = end;
444 OVERLAY_PLIST (overlay) = Fcopy_sequence (OVERLAY_PLIST (old_overlay));
445 XOVERLAY (overlay)->next = NULL;
447 if (tail)
448 tail = tail->next = XOVERLAY (overlay);
449 else
450 result = tail = XOVERLAY (overlay);
453 return result;
457 /* Clone per-buffer values of buffer FROM.
459 Buffer TO gets the same per-buffer values as FROM, with the
460 following exceptions: (1) TO's name is left untouched, (2) markers
461 are copied and made to refer to TO, and (3) overlay lists are
462 copied. */
464 static void
465 clone_per_buffer_values (struct buffer *from, struct buffer *to)
467 Lisp_Object to_buffer;
468 int offset;
470 XSETBUFFER (to_buffer, to);
472 /* buffer-local Lisp variables start at `undo_list',
473 tho only the ones from `name' on are GC'd normally. */
474 for (offset = PER_BUFFER_VAR_OFFSET (FIRST_FIELD_PER_BUFFER);
475 offset <= PER_BUFFER_VAR_OFFSET (LAST_FIELD_PER_BUFFER);
476 offset += sizeof (Lisp_Object))
478 Lisp_Object obj;
480 /* Don't touch the `name' which should be unique for every buffer. */
481 if (offset == PER_BUFFER_VAR_OFFSET (name))
482 continue;
484 obj = PER_BUFFER_VALUE (from, offset);
485 if (MARKERP (obj) && XMARKER (obj)->buffer == from)
487 struct Lisp_Marker *m = XMARKER (obj);
488 obj = Fmake_marker ();
489 XMARKER (obj)->insertion_type = m->insertion_type;
490 set_marker_both (obj, to_buffer, m->charpos, m->bytepos);
493 PER_BUFFER_VALUE (to, offset) = obj;
496 memcpy (to->local_flags, from->local_flags, sizeof to->local_flags);
498 to->overlays_before = copy_overlays (to, from->overlays_before);
499 to->overlays_after = copy_overlays (to, from->overlays_after);
501 /* Get (a copy of) the alist of Lisp-level local variables of FROM
502 and install that in TO. */
503 BVAR (to, local_var_alist) = buffer_lisp_local_variables (from);
507 /* If buffer B has markers to record PT, BEGV and ZV when it is not
508 current, update these markers. */
510 static void
511 record_buffer_markers (struct buffer *b)
513 if (! NILP (BVAR (b, pt_marker)))
515 Lisp_Object buffer;
517 eassert (!NILP (BVAR (b, begv_marker)));
518 eassert (!NILP (BVAR (b, zv_marker)));
520 XSETBUFFER (buffer, b);
521 set_marker_both (BVAR (b, pt_marker), buffer, b->pt, b->pt_byte);
522 set_marker_both (BVAR (b, begv_marker), buffer, b->begv, b->begv_byte);
523 set_marker_both (BVAR (b, zv_marker), buffer, b->zv, b->zv_byte);
528 /* If buffer B has markers to record PT, BEGV and ZV when it is not
529 current, fetch these values into B->begv etc. */
531 static void
532 fetch_buffer_markers (struct buffer *b)
534 if (! NILP (BVAR (b, pt_marker)))
536 Lisp_Object m;
538 eassert (!NILP (BVAR (b, begv_marker)));
539 eassert (!NILP (BVAR (b, zv_marker)));
541 m = BVAR (b, pt_marker);
542 SET_BUF_PT_BOTH (b, marker_position (m), marker_byte_position (m));
544 m = BVAR (b, begv_marker);
545 SET_BUF_BEGV_BOTH (b, marker_position (m), marker_byte_position (m));
547 m = BVAR (b, zv_marker);
548 SET_BUF_ZV_BOTH (b, marker_position (m), marker_byte_position (m));
553 DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer,
554 2, 3,
555 "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
556 doc: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
557 BASE-BUFFER should be a live buffer, or the name of an existing buffer.
558 NAME should be a string which is not the name of an existing buffer.
559 Optional argument CLONE non-nil means preserve BASE-BUFFER's state,
560 such as major and minor modes, in the indirect buffer.
561 CLONE nil means the indirect buffer's state is reset to default values. */)
562 (Lisp_Object base_buffer, Lisp_Object name, Lisp_Object clone)
564 Lisp_Object buf, tem;
565 struct buffer *b;
567 CHECK_STRING (name);
568 buf = Fget_buffer (name);
569 if (!NILP (buf))
570 error ("Buffer name `%s' is in use", SDATA (name));
572 tem = base_buffer;
573 base_buffer = Fget_buffer (base_buffer);
574 if (NILP (base_buffer))
575 error ("No such buffer: `%s'", SDATA (tem));
576 if (NILP (BVAR (XBUFFER (base_buffer), name)))
577 error ("Base buffer has been killed");
579 if (SCHARS (name) == 0)
580 error ("Empty string for buffer name is not allowed");
582 b = allocate_buffer ();
584 b->base_buffer = (XBUFFER (base_buffer)->base_buffer
585 ? XBUFFER (base_buffer)->base_buffer
586 : XBUFFER (base_buffer));
588 /* Use the base buffer's text object. */
589 b->text = b->base_buffer->text;
591 b->pt = b->base_buffer->pt;
592 b->begv = b->base_buffer->begv;
593 b->zv = b->base_buffer->zv;
594 b->pt_byte = b->base_buffer->pt_byte;
595 b->begv_byte = b->base_buffer->begv_byte;
596 b->zv_byte = b->base_buffer->zv_byte;
598 b->newline_cache = 0;
599 b->width_run_cache = 0;
600 BVAR (b, width_table) = Qnil;
602 /* Put this on the chain of all buffers including killed ones. */
603 b->header.next.buffer = all_buffers;
604 all_buffers = b;
606 name = Fcopy_sequence (name);
607 STRING_SET_INTERVALS (name, NULL_INTERVAL);
608 BVAR (b, name) = name;
610 reset_buffer (b);
611 reset_buffer_local_variables (b, 1);
613 /* Put this in the alist of all live buffers. */
614 XSETBUFFER (buf, b);
615 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
617 BVAR (b, mark) = Fmake_marker ();
618 BVAR (b, name) = name;
620 /* The multibyte status belongs to the base buffer. */
621 BVAR (b, enable_multibyte_characters) = BVAR (b->base_buffer, enable_multibyte_characters);
623 /* Make sure the base buffer has markers for its narrowing. */
624 if (NILP (BVAR (b->base_buffer, pt_marker)))
626 eassert (NILP (BVAR (b->base_buffer, begv_marker)));
627 eassert (NILP (BVAR (b->base_buffer, zv_marker)));
629 BVAR (b->base_buffer, pt_marker) = Fmake_marker ();
630 set_marker_both (BVAR (b->base_buffer, pt_marker), base_buffer,
631 b->base_buffer->pt,
632 b->base_buffer->pt_byte);
634 BVAR (b->base_buffer, begv_marker) = Fmake_marker ();
635 set_marker_both (BVAR (b->base_buffer, begv_marker), base_buffer,
636 b->base_buffer->begv,
637 b->base_buffer->begv_byte);
639 BVAR (b->base_buffer, zv_marker) = Fmake_marker ();
640 set_marker_both (BVAR (b->base_buffer, zv_marker), base_buffer,
641 b->base_buffer->zv,
642 b->base_buffer->zv_byte);
643 XMARKER (BVAR (b->base_buffer, zv_marker))->insertion_type = 1;
646 if (NILP (clone))
648 /* Give the indirect buffer markers for its narrowing. */
649 BVAR (b, pt_marker) = Fmake_marker ();
650 set_marker_both (BVAR (b, pt_marker), buf, b->pt, b->pt_byte);
651 BVAR (b, begv_marker) = Fmake_marker ();
652 set_marker_both (BVAR (b, begv_marker), buf, b->begv, b->begv_byte);
653 BVAR (b, zv_marker) = Fmake_marker ();
654 set_marker_both (BVAR (b, zv_marker), buf, b->zv, b->zv_byte);
655 XMARKER (BVAR (b, zv_marker))->insertion_type = 1;
657 else
659 struct buffer *old_b = current_buffer;
661 clone_per_buffer_values (b->base_buffer, b);
662 BVAR (b, filename) = Qnil;
663 BVAR (b, file_truename) = Qnil;
664 BVAR (b, display_count) = make_number (0);
665 BVAR (b, backed_up) = Qnil;
666 BVAR (b, auto_save_file_name) = Qnil;
667 set_buffer_internal_1 (b);
668 Fset (intern ("buffer-save-without-query"), Qnil);
669 Fset (intern ("buffer-file-number"), Qnil);
670 Fset (intern ("buffer-stale-function"), Qnil);
671 set_buffer_internal_1 (old_b);
674 /* Run buffer-list-update-hook. */
675 if (!NILP (Vrun_hooks))
676 call1 (Vrun_hooks, Qbuffer_list_update_hook);
678 return buf;
681 void
682 delete_all_overlays (struct buffer *b)
684 Lisp_Object overlay;
686 /* `reset_buffer' blindly sets the list of overlays to NULL, so we
687 have to empty the list, otherwise we end up with overlays that
688 think they belong to this buffer while the buffer doesn't know about
689 them any more. */
690 while (b->overlays_before)
692 XSETMISC (overlay, b->overlays_before);
693 Fdelete_overlay (overlay);
695 while (b->overlays_after)
697 XSETMISC (overlay, b->overlays_after);
698 Fdelete_overlay (overlay);
700 eassert (b->overlays_before == NULL);
701 eassert (b->overlays_after == NULL);
704 /* Reinitialize everything about a buffer except its name and contents
705 and local variables.
706 If called on an already-initialized buffer, the list of overlays
707 should be deleted before calling this function, otherwise we end up
708 with overlays that claim to belong to the buffer but the buffer
709 claims it doesn't belong to it. */
711 void
712 reset_buffer (register struct buffer *b)
714 BVAR (b, filename) = Qnil;
715 BVAR (b, file_truename) = Qnil;
716 BVAR (b, directory) = (current_buffer) ? BVAR (current_buffer, directory) : Qnil;
717 b->modtime = 0;
718 b->modtime_size = -1;
719 XSETFASTINT (BVAR (b, save_length), 0);
720 b->last_window_start = 1;
721 /* It is more conservative to start out "changed" than "unchanged". */
722 b->clip_changed = 0;
723 b->prevent_redisplay_optimizations_p = 1;
724 BVAR (b, backed_up) = Qnil;
725 BUF_AUTOSAVE_MODIFF (b) = 0;
726 b->auto_save_failure_time = -1;
727 BVAR (b, auto_save_file_name) = Qnil;
728 BVAR (b, read_only) = Qnil;
729 b->overlays_before = NULL;
730 b->overlays_after = NULL;
731 b->overlay_center = BEG;
732 BVAR (b, mark_active) = Qnil;
733 BVAR (b, point_before_scroll) = Qnil;
734 BVAR (b, file_format) = Qnil;
735 BVAR (b, auto_save_file_format) = Qt;
736 BVAR (b, last_selected_window) = Qnil;
737 XSETINT (BVAR (b, display_count), 0);
738 BVAR (b, display_time) = Qnil;
739 BVAR (b, enable_multibyte_characters) = BVAR (&buffer_defaults, enable_multibyte_characters);
740 BVAR (b, cursor_type) = BVAR (&buffer_defaults, cursor_type);
741 BVAR (b, extra_line_spacing) = BVAR (&buffer_defaults, extra_line_spacing);
743 b->display_error_modiff = 0;
746 /* Reset buffer B's local variables info.
747 Don't use this on a buffer that has already been in use;
748 it does not treat permanent locals consistently.
749 Instead, use Fkill_all_local_variables.
751 If PERMANENT_TOO is 1, then we reset permanent
752 buffer-local variables. If PERMANENT_TOO is 0,
753 we preserve those. */
755 static void
756 reset_buffer_local_variables (register struct buffer *b, int permanent_too)
758 register int offset;
759 int i;
761 /* Reset the major mode to Fundamental, together with all the
762 things that depend on the major mode.
763 default-major-mode is handled at a higher level.
764 We ignore it here. */
765 BVAR (b, major_mode) = Qfundamental_mode;
766 BVAR (b, keymap) = Qnil;
767 BVAR (b, mode_name) = QSFundamental;
768 BVAR (b, minor_modes) = Qnil;
770 /* If the standard case table has been altered and invalidated,
771 fix up its insides first. */
772 if (! (CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[0])
773 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[1])
774 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[2])))
775 Fset_standard_case_table (Vascii_downcase_table);
777 BVAR (b, downcase_table) = Vascii_downcase_table;
778 BVAR (b, upcase_table) = XCHAR_TABLE (Vascii_downcase_table)->extras[0];
779 BVAR (b, case_canon_table) = XCHAR_TABLE (Vascii_downcase_table)->extras[1];
780 BVAR (b, case_eqv_table) = XCHAR_TABLE (Vascii_downcase_table)->extras[2];
781 BVAR (b, invisibility_spec) = Qt;
783 /* Reset all (or most) per-buffer variables to their defaults. */
784 if (permanent_too)
785 BVAR (b, local_var_alist) = Qnil;
786 else
788 Lisp_Object tmp, prop, last = Qnil;
789 for (tmp = BVAR (b, local_var_alist); CONSP (tmp); tmp = XCDR (tmp))
790 if (!NILP (prop = Fget (XCAR (XCAR (tmp)), Qpermanent_local)))
792 /* If permanent-local, keep it. */
793 last = tmp;
794 if (EQ (prop, Qpermanent_local_hook))
796 /* This is a partially permanent hook variable.
797 Preserve only the elements that want to be preserved. */
798 Lisp_Object list, newlist;
799 list = XCDR (XCAR (tmp));
800 if (!CONSP (list))
801 newlist = list;
802 else
803 for (newlist = Qnil; CONSP (list); list = XCDR (list))
805 Lisp_Object elt = XCAR (list);
806 /* Preserve element ELT if it's t,
807 if it is a function with a `permanent-local-hook' property,
808 or if it's not a symbol. */
809 if (! SYMBOLP (elt)
810 || EQ (elt, Qt)
811 || !NILP (Fget (elt, Qpermanent_local_hook)))
812 newlist = Fcons (elt, newlist);
814 XSETCDR (XCAR (tmp), Fnreverse (newlist));
817 /* Delete this local variable. */
818 else if (NILP (last))
819 BVAR (b, local_var_alist) = XCDR (tmp);
820 else
821 XSETCDR (last, XCDR (tmp));
824 for (i = 0; i < last_per_buffer_idx; ++i)
825 if (permanent_too || buffer_permanent_local_flags[i] == 0)
826 SET_PER_BUFFER_VALUE_P (b, i, 0);
828 /* For each slot that has a default value,
829 copy that into the slot. */
831 /* buffer-local Lisp variables start at `undo_list',
832 tho only the ones from `name' on are GC'd normally. */
833 for (offset = PER_BUFFER_VAR_OFFSET (FIRST_FIELD_PER_BUFFER);
834 offset <= PER_BUFFER_VAR_OFFSET (LAST_FIELD_PER_BUFFER);
835 offset += sizeof (Lisp_Object))
837 int idx = PER_BUFFER_IDX (offset);
838 if ((idx > 0
839 && (permanent_too
840 || buffer_permanent_local_flags[idx] == 0)))
841 PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
845 /* We split this away from generate-new-buffer, because rename-buffer
846 and set-visited-file-name ought to be able to use this to really
847 rename the buffer properly. */
849 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name,
850 Sgenerate_new_buffer_name, 1, 2, 0,
851 doc: /* Return a string that is the name of no existing buffer based on NAME.
852 If there is no live buffer named NAME, then return NAME.
853 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
854 \(starting at 2) until an unused name is found, and then return that name.
855 Optional second argument IGNORE specifies a name that is okay to use (if
856 it is in the sequence to be tried) even if a buffer with that name exists. */)
857 (register Lisp_Object name, Lisp_Object ignore)
859 register Lisp_Object gentemp, tem;
860 EMACS_INT count;
861 char number[INT_BUFSIZE_BOUND (EMACS_INT) + sizeof "<>"];
863 CHECK_STRING (name);
865 tem = Fstring_equal (name, ignore);
866 if (!NILP (tem))
867 return name;
868 tem = Fget_buffer (name);
869 if (NILP (tem))
870 return name;
872 count = 1;
873 while (1)
875 sprintf (number, "<%"pI"d>", ++count);
876 gentemp = concat2 (name, build_string (number));
877 tem = Fstring_equal (gentemp, ignore);
878 if (!NILP (tem))
879 return gentemp;
880 tem = Fget_buffer (gentemp);
881 if (NILP (tem))
882 return gentemp;
887 DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
888 doc: /* Return the name of BUFFER, as a string.
889 BUFFER defaults to the current buffer.
890 Return nil if BUFFER has been killed. */)
891 (register Lisp_Object buffer)
893 if (NILP (buffer))
894 return BVAR (current_buffer, name);
895 CHECK_BUFFER (buffer);
896 return BVAR (XBUFFER (buffer), name);
899 DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
900 doc: /* Return name of file BUFFER is visiting, or nil if none.
901 No argument or nil as argument means use the current buffer. */)
902 (register Lisp_Object buffer)
904 if (NILP (buffer))
905 return BVAR (current_buffer, filename);
906 CHECK_BUFFER (buffer);
907 return BVAR (XBUFFER (buffer), filename);
910 DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
911 0, 1, 0,
912 doc: /* Return the base buffer of indirect buffer BUFFER.
913 If BUFFER is not indirect, return nil.
914 BUFFER defaults to the current buffer. */)
915 (register Lisp_Object buffer)
917 struct buffer *base;
918 Lisp_Object base_buffer;
920 if (NILP (buffer))
921 base = current_buffer->base_buffer;
922 else
924 CHECK_BUFFER (buffer);
925 base = XBUFFER (buffer)->base_buffer;
928 if (! base)
929 return Qnil;
930 XSETBUFFER (base_buffer, base);
931 return base_buffer;
934 DEFUN ("buffer-local-value", Fbuffer_local_value,
935 Sbuffer_local_value, 2, 2, 0,
936 doc: /* Return the value of VARIABLE in BUFFER.
937 If VARIABLE does not have a buffer-local binding in BUFFER, the value
938 is the default binding of the variable. */)
939 (register Lisp_Object variable, register Lisp_Object buffer)
941 register struct buffer *buf;
942 register Lisp_Object result;
943 struct Lisp_Symbol *sym;
945 CHECK_SYMBOL (variable);
946 CHECK_BUFFER (buffer);
947 buf = XBUFFER (buffer);
948 sym = XSYMBOL (variable);
950 start:
951 switch (sym->redirect)
953 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
954 case SYMBOL_PLAINVAL: result = SYMBOL_VAL (sym); break;
955 case SYMBOL_LOCALIZED:
956 { /* Look in local_var_alist. */
957 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
958 XSETSYMBOL (variable, sym); /* Update In case of aliasing. */
959 result = Fassoc (variable, BVAR (buf, local_var_alist));
960 if (!NILP (result))
962 if (blv->fwd)
963 { /* What binding is loaded right now? */
964 Lisp_Object current_alist_element = blv->valcell;
966 /* The value of the currently loaded binding is not
967 stored in it, but rather in the realvalue slot.
968 Store that value into the binding it belongs to
969 in case that is the one we are about to use. */
971 XSETCDR (current_alist_element,
972 do_symval_forwarding (blv->fwd));
974 /* Now get the (perhaps updated) value out of the binding. */
975 result = XCDR (result);
977 else
978 result = Fdefault_value (variable);
979 break;
981 case SYMBOL_FORWARDED:
983 union Lisp_Fwd *fwd = SYMBOL_FWD (sym);
984 if (BUFFER_OBJFWDP (fwd))
985 result = PER_BUFFER_VALUE (buf, XBUFFER_OBJFWD (fwd)->offset);
986 else
987 result = Fdefault_value (variable);
988 break;
990 default: abort ();
993 if (!EQ (result, Qunbound))
994 return result;
996 xsignal1 (Qvoid_variable, variable);
999 /* Return an alist of the Lisp-level buffer-local bindings of
1000 buffer BUF. That is, don't include the variables maintained
1001 in special slots in the buffer object. */
1003 static Lisp_Object
1004 buffer_lisp_local_variables (struct buffer *buf)
1006 Lisp_Object result = Qnil;
1007 register Lisp_Object tail;
1008 for (tail = BVAR (buf, local_var_alist); CONSP (tail); tail = XCDR (tail))
1010 Lisp_Object val, elt;
1012 elt = XCAR (tail);
1014 /* Reference each variable in the alist in buf.
1015 If inquiring about the current buffer, this gets the current values,
1016 so store them into the alist so the alist is up to date.
1017 If inquiring about some other buffer, this swaps out any values
1018 for that buffer, making the alist up to date automatically. */
1019 val = find_symbol_value (XCAR (elt));
1020 /* Use the current buffer value only if buf is the current buffer. */
1021 if (buf != current_buffer)
1022 val = XCDR (elt);
1024 result = Fcons (Fcons (XCAR (elt), val), result);
1027 return result;
1030 DEFUN ("buffer-local-variables", Fbuffer_local_variables,
1031 Sbuffer_local_variables, 0, 1, 0,
1032 doc: /* Return an alist of variables that are buffer-local in BUFFER.
1033 Most elements look like (SYMBOL . VALUE), describing one variable.
1034 For a symbol that is locally unbound, just the symbol appears in the value.
1035 Note that storing new VALUEs in these elements doesn't change the variables.
1036 No argument or nil as argument means use current buffer as BUFFER. */)
1037 (register Lisp_Object buffer)
1039 register struct buffer *buf;
1040 register Lisp_Object result;
1042 if (NILP (buffer))
1043 buf = current_buffer;
1044 else
1046 CHECK_BUFFER (buffer);
1047 buf = XBUFFER (buffer);
1050 result = buffer_lisp_local_variables (buf);
1052 /* Add on all the variables stored in special slots. */
1054 int offset, idx;
1056 /* buffer-local Lisp variables start at `undo_list',
1057 tho only the ones from `name' on are GC'd normally. */
1058 for (offset = PER_BUFFER_VAR_OFFSET (FIRST_FIELD_PER_BUFFER);
1059 offset <= PER_BUFFER_VAR_OFFSET (LAST_FIELD_PER_BUFFER);
1060 /* sizeof EMACS_INT == sizeof Lisp_Object */
1061 offset += (sizeof (EMACS_INT)))
1063 idx = PER_BUFFER_IDX (offset);
1064 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
1065 && SYMBOLP (PER_BUFFER_SYMBOL (offset)))
1066 result = Fcons (Fcons (PER_BUFFER_SYMBOL (offset),
1067 PER_BUFFER_VALUE (buf, offset)),
1068 result);
1072 return result;
1075 DEFUN ("buffer-modified-p", Fbuffer_modified_p, Sbuffer_modified_p,
1076 0, 1, 0,
1077 doc: /* Return t if BUFFER was modified since its file was last read or saved.
1078 No argument or nil as argument means use current buffer as BUFFER. */)
1079 (register Lisp_Object buffer)
1081 register struct buffer *buf;
1082 if (NILP (buffer))
1083 buf = current_buffer;
1084 else
1086 CHECK_BUFFER (buffer);
1087 buf = XBUFFER (buffer);
1090 return BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf) ? Qt : Qnil;
1093 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p, Sset_buffer_modified_p,
1094 1, 1, 0,
1095 doc: /* Mark current buffer as modified or unmodified according to FLAG.
1096 A non-nil FLAG means mark the buffer modified. */)
1097 (register Lisp_Object flag)
1099 register int already;
1100 register Lisp_Object fn;
1101 Lisp_Object buffer, window;
1103 #ifdef CLASH_DETECTION
1104 /* If buffer becoming modified, lock the file.
1105 If buffer becoming unmodified, unlock the file. */
1107 fn = BVAR (current_buffer, file_truename);
1108 /* Test buffer-file-name so that binding it to nil is effective. */
1109 if (!NILP (fn) && ! NILP (BVAR (current_buffer, filename)))
1111 already = SAVE_MODIFF < MODIFF;
1112 if (!already && !NILP (flag))
1113 lock_file (fn);
1114 else if (already && NILP (flag))
1115 unlock_file (fn);
1117 #endif /* CLASH_DETECTION */
1119 /* Here we have a problem. SAVE_MODIFF is used here to encode
1120 buffer-modified-p (as SAVE_MODIFF<MODIFF) as well as
1121 recent-auto-save-p (as SAVE_MODIFF<auto_save_modified). So if we
1122 modify SAVE_MODIFF to affect one, we may affect the other
1123 as well.
1124 E.g. if FLAG is nil we need to set SAVE_MODIFF to MODIFF, but
1125 if SAVE_MODIFF<auto_save_modified that means we risk changing
1126 recent-auto-save-p from t to nil.
1127 Vice versa, if FLAG is non-nil and SAVE_MODIFF>=auto_save_modified
1128 we risk changing recent-auto-save-p from nil to t. */
1129 SAVE_MODIFF = (NILP (flag)
1130 /* FIXME: This unavoidably sets recent-auto-save-p to nil. */
1131 ? MODIFF
1132 /* Let's try to preserve recent-auto-save-p. */
1133 : SAVE_MODIFF < MODIFF ? SAVE_MODIFF
1134 /* If SAVE_MODIFF == auto_save_modified == MODIFF,
1135 we can either decrease SAVE_MODIFF and auto_save_modified
1136 or increase MODIFF. */
1137 : MODIFF++);
1139 /* Set update_mode_lines only if buffer is displayed in some window.
1140 Packages like jit-lock or lazy-lock preserve a buffer's modified
1141 state by recording/restoring the state around blocks of code.
1142 Setting update_mode_lines makes redisplay consider all windows
1143 (on all frames). Stealth fontification of buffers not displayed
1144 would incur additional redisplay costs if we'd set
1145 update_modes_lines unconditionally.
1147 Ideally, I think there should be another mechanism for fontifying
1148 buffers without "modifying" buffers, or redisplay should be
1149 smarter about updating the `*' in mode lines. --gerd */
1150 XSETBUFFER (buffer, current_buffer);
1151 window = Fget_buffer_window (buffer, Qt);
1152 if (WINDOWP (window))
1154 ++update_mode_lines;
1155 current_buffer->prevent_redisplay_optimizations_p = 1;
1158 return flag;
1161 DEFUN ("restore-buffer-modified-p", Frestore_buffer_modified_p,
1162 Srestore_buffer_modified_p, 1, 1, 0,
1163 doc: /* Like `set-buffer-modified-p', with a difference concerning redisplay.
1164 It is not ensured that mode lines will be updated to show the modified
1165 state of the current buffer. Use with care. */)
1166 (Lisp_Object flag)
1168 #ifdef CLASH_DETECTION
1169 Lisp_Object fn;
1171 /* If buffer becoming modified, lock the file.
1172 If buffer becoming unmodified, unlock the file. */
1174 fn = BVAR (current_buffer, file_truename);
1175 /* Test buffer-file-name so that binding it to nil is effective. */
1176 if (!NILP (fn) && ! NILP (BVAR (current_buffer, filename)))
1178 int already = SAVE_MODIFF < MODIFF;
1179 if (!already && !NILP (flag))
1180 lock_file (fn);
1181 else if (already && NILP (flag))
1182 unlock_file (fn);
1184 #endif /* CLASH_DETECTION */
1186 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1187 return flag;
1190 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick, Sbuffer_modified_tick,
1191 0, 1, 0,
1192 doc: /* Return BUFFER's tick counter, incremented for each change in text.
1193 Each buffer has a tick counter which is incremented each time the
1194 text in that buffer is changed. It wraps around occasionally.
1195 No argument or nil as argument means use current buffer as BUFFER. */)
1196 (register Lisp_Object buffer)
1198 register struct buffer *buf;
1199 if (NILP (buffer))
1200 buf = current_buffer;
1201 else
1203 CHECK_BUFFER (buffer);
1204 buf = XBUFFER (buffer);
1207 return make_number (BUF_MODIFF (buf));
1210 DEFUN ("buffer-chars-modified-tick", Fbuffer_chars_modified_tick,
1211 Sbuffer_chars_modified_tick, 0, 1, 0,
1212 doc: /* Return BUFFER's character-change tick counter.
1213 Each buffer has a character-change tick counter, which is set to the
1214 value of the buffer's tick counter \(see `buffer-modified-tick'), each
1215 time text in that buffer is inserted or deleted. By comparing the
1216 values returned by two individual calls of `buffer-chars-modified-tick',
1217 you can tell whether a character change occurred in that buffer in
1218 between these calls. No argument or nil as argument means use current
1219 buffer as BUFFER. */)
1220 (register Lisp_Object buffer)
1222 register struct buffer *buf;
1223 if (NILP (buffer))
1224 buf = current_buffer;
1225 else
1227 CHECK_BUFFER (buffer);
1228 buf = XBUFFER (buffer);
1231 return make_number (BUF_CHARS_MODIFF (buf));
1234 DEFUN ("rename-buffer", Frename_buffer, Srename_buffer, 1, 2,
1235 "(list (read-string \"Rename buffer (to new name): \" \
1236 nil 'buffer-name-history (buffer-name (current-buffer))) \
1237 current-prefix-arg)",
1238 doc: /* Change current buffer's name to NEWNAME (a string).
1239 If second arg UNIQUE is nil or omitted, it is an error if a
1240 buffer named NEWNAME already exists.
1241 If UNIQUE is non-nil, come up with a new name using
1242 `generate-new-buffer-name'.
1243 Interactively, you can set UNIQUE with a prefix argument.
1244 We return the name we actually gave the buffer.
1245 This does not change the name of the visited file (if any). */)
1246 (register Lisp_Object newname, Lisp_Object unique)
1248 register Lisp_Object tem, buf;
1250 CHECK_STRING (newname);
1252 if (SCHARS (newname) == 0)
1253 error ("Empty string is invalid as a buffer name");
1255 tem = Fget_buffer (newname);
1256 if (!NILP (tem))
1258 /* Don't short-circuit if UNIQUE is t. That is a useful way to
1259 rename the buffer automatically so you can create another
1260 with the original name. It makes UNIQUE equivalent to
1261 (rename-buffer (generate-new-buffer-name NEWNAME)). */
1262 if (NILP (unique) && XBUFFER (tem) == current_buffer)
1263 return BVAR (current_buffer, name);
1264 if (!NILP (unique))
1265 newname = Fgenerate_new_buffer_name (newname, BVAR (current_buffer, name));
1266 else
1267 error ("Buffer name `%s' is in use", SDATA (newname));
1270 BVAR (current_buffer, name) = newname;
1272 /* Catch redisplay's attention. Unless we do this, the mode lines for
1273 any windows displaying current_buffer will stay unchanged. */
1274 update_mode_lines++;
1276 XSETBUFFER (buf, current_buffer);
1277 Fsetcar (Frassq (buf, Vbuffer_alist), newname);
1278 if (NILP (BVAR (current_buffer, filename))
1279 && !NILP (BVAR (current_buffer, auto_save_file_name)))
1280 call0 (intern ("rename-auto-save-file"));
1282 /* Run buffer-list-update-hook. */
1283 if (!NILP (Vrun_hooks))
1284 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1286 /* Refetch since that last call may have done GC. */
1287 return BVAR (current_buffer, name);
1290 DEFUN ("other-buffer", Fother_buffer, Sother_buffer, 0, 3, 0,
1291 doc: /* Return most recently selected buffer other than BUFFER.
1292 Buffers not visible in windows are preferred to visible buffers, unless
1293 optional second argument VISIBLE-OK is non-nil. Ignore the argument
1294 BUFFER unless it denotes a live buffer. If the optional third argument
1295 FRAME is non-nil, use that frame's buffer list instead of the selected
1296 frame's buffer list.
1298 The buffer is found by scanning the selected or specified frame's buffer
1299 list first, followed by the list of all buffers. If no other buffer
1300 exists, return the buffer `*scratch*' (creating it if necessary). */)
1301 (register Lisp_Object buffer, Lisp_Object visible_ok, Lisp_Object frame)
1303 Lisp_Object Fset_buffer_major_mode (Lisp_Object buffer);
1304 Lisp_Object tail, buf, pred;
1305 Lisp_Object notsogood = Qnil;
1307 if (NILP (frame))
1308 frame = selected_frame;
1310 CHECK_FRAME (frame);
1312 pred = frame_buffer_predicate (frame);
1313 /* Consider buffers that have been seen in the frame first. */
1314 tail = XFRAME (frame)->buffer_list;
1315 for (; CONSP (tail); tail = XCDR (tail))
1317 buf = XCAR (tail);
1318 if (BUFFERP (buf) && !EQ (buf, buffer)
1319 && !NILP (BVAR (XBUFFER (buf), name))
1320 && (SREF (BVAR (XBUFFER (buf), name), 0) != ' ')
1321 /* If the frame has a buffer_predicate, disregard buffers that
1322 don't fit the predicate. */
1323 && (NILP (pred) || !NILP (call1 (pred, buf))))
1325 if (!NILP (visible_ok)
1326 || NILP (Fget_buffer_window (buf, Qvisible)))
1327 return buf;
1328 else if (NILP (notsogood))
1329 notsogood = buf;
1333 /* Consider alist of all buffers next. */
1334 tail = Vbuffer_alist;
1335 for (; CONSP (tail); tail = XCDR (tail))
1337 buf = Fcdr (XCAR (tail));
1338 if (BUFFERP (buf) && !EQ (buf, buffer)
1339 && !NILP (BVAR (XBUFFER (buf), name))
1340 && (SREF (BVAR (XBUFFER (buf), name), 0) != ' ')
1341 /* If the frame has a buffer_predicate, disregard buffers that
1342 don't fit the predicate. */
1343 && (NILP (pred) || !NILP (call1 (pred, buf))))
1345 if (!NILP (visible_ok)
1346 || NILP (Fget_buffer_window (buf, Qvisible)))
1347 return buf;
1348 else if (NILP (notsogood))
1349 notsogood = buf;
1353 if (!NILP (notsogood))
1354 return notsogood;
1355 else
1357 buf = Fget_buffer (build_string ("*scratch*"));
1358 if (NILP (buf))
1360 buf = Fget_buffer_create (build_string ("*scratch*"));
1361 Fset_buffer_major_mode (buf);
1363 return buf;
1367 /* The following function is a safe variant of Fother_buffer: It doesn't
1368 pay attention to any frame-local buffer lists, doesn't care about
1369 visibility of buffers, and doesn't evaluate any frame predicates. */
1371 Lisp_Object
1372 other_buffer_safely (Lisp_Object buffer)
1374 Lisp_Object Fset_buffer_major_mode (Lisp_Object buffer);
1375 Lisp_Object tail, buf;
1377 tail = Vbuffer_alist;
1378 for (; CONSP (tail); tail = XCDR (tail))
1380 buf = Fcdr (XCAR (tail));
1381 if (BUFFERP (buf) && !EQ (buf, buffer)
1382 && !NILP (BVAR (XBUFFER (buf), name))
1383 && (SREF (BVAR (XBUFFER (buf), name), 0) != ' '))
1384 return buf;
1387 buf = Fget_buffer (build_string ("*scratch*"));
1388 if (NILP (buf))
1390 buf = Fget_buffer_create (build_string ("*scratch*"));
1391 Fset_buffer_major_mode (buf);
1394 return buf;
1397 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo, Sbuffer_enable_undo,
1398 0, 1, "",
1399 doc: /* Start keeping undo information for buffer BUFFER.
1400 No argument or nil as argument means do this for the current buffer. */)
1401 (register Lisp_Object buffer)
1403 Lisp_Object real_buffer;
1405 if (NILP (buffer))
1406 XSETBUFFER (real_buffer, current_buffer);
1407 else
1409 real_buffer = Fget_buffer (buffer);
1410 if (NILP (real_buffer))
1411 nsberror (buffer);
1414 if (EQ (BVAR (XBUFFER (real_buffer), undo_list), Qt))
1415 BVAR (XBUFFER (real_buffer), undo_list) = Qnil;
1417 return Qnil;
1421 DEFVAR_LISP ("kill-buffer-hook", ..., "\
1422 Hook to be run (by `run-hooks', which see) when a buffer is killed.\n\
1423 The buffer being killed will be current while the hook is running.\n\
1424 See `kill-buffer'."
1426 DEFUN ("kill-buffer", Fkill_buffer, Skill_buffer, 0, 1, "bKill buffer: ",
1427 doc: /* Kill buffer BUFFER-OR-NAME.
1428 The argument may be a buffer or the name of an existing buffer.
1429 Argument nil or omitted means kill the current buffer. Return t if the
1430 buffer is actually killed, nil otherwise.
1432 This function calls `replace-buffer-in-windows' for cleaning up all
1433 windows currently displaying the buffer to be killed. The functions in
1434 `kill-buffer-query-functions' are called with the buffer to be killed as
1435 the current buffer. If any of them returns nil, the buffer is not
1436 killed. The hook `kill-buffer-hook' is run before the buffer is
1437 actually killed. The buffer being killed will be current while the hook
1438 is running.
1440 Any processes that have this buffer as the `process-buffer' are killed
1441 with SIGHUP. */)
1442 (Lisp_Object buffer_or_name)
1444 Lisp_Object buffer;
1445 register struct buffer *b;
1446 register Lisp_Object tem;
1447 register struct Lisp_Marker *m;
1448 struct gcpro gcpro1;
1450 if (NILP (buffer_or_name))
1451 buffer = Fcurrent_buffer ();
1452 else
1453 buffer = Fget_buffer (buffer_or_name);
1454 if (NILP (buffer))
1455 nsberror (buffer_or_name);
1457 b = XBUFFER (buffer);
1459 /* Avoid trouble for buffer already dead. */
1460 if (NILP (BVAR (b, name)))
1461 return Qnil;
1463 /* Query if the buffer is still modified. */
1464 if (INTERACTIVE && !NILP (BVAR (b, filename))
1465 && BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
1467 GCPRO1 (buffer);
1468 tem = do_yes_or_no_p (format2 ("Buffer %s modified; kill anyway? ",
1469 BVAR (b, name), make_number (0)));
1470 UNGCPRO;
1471 if (NILP (tem))
1472 return Qnil;
1475 /* Run hooks with the buffer to be killed the current buffer. */
1477 int count = SPECPDL_INDEX ();
1478 Lisp_Object arglist[1];
1480 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1481 set_buffer_internal (b);
1483 /* First run the query functions; if any query is answered no,
1484 don't kill the buffer. */
1485 arglist[0] = Qkill_buffer_query_functions;
1486 tem = Frun_hook_with_args_until_failure (1, arglist);
1487 if (NILP (tem))
1488 return unbind_to (count, Qnil);
1490 /* Then run the hooks. */
1491 Frun_hooks (1, &Qkill_buffer_hook);
1492 unbind_to (count, Qnil);
1495 /* We have no more questions to ask. Verify that it is valid
1496 to kill the buffer. This must be done after the questions
1497 since anything can happen within do_yes_or_no_p. */
1499 /* Don't kill the minibuffer now current. */
1500 if (EQ (buffer, XWINDOW (minibuf_window)->buffer))
1501 return Qnil;
1503 if (NILP (BVAR (b, name)))
1504 return Qnil;
1506 /* When we kill a base buffer, kill all its indirect buffers.
1507 We do it at this stage so nothing terrible happens if they
1508 ask questions or their hooks get errors. */
1509 if (! b->base_buffer)
1511 struct buffer *other;
1513 GCPRO1 (buffer);
1515 for (other = all_buffers; other; other = other->header.next.buffer)
1516 /* all_buffers contains dead buffers too;
1517 don't re-kill them. */
1518 if (other->base_buffer == b && !NILP (BVAR (other, name)))
1520 Lisp_Object buf;
1521 XSETBUFFER (buf, other);
1522 Fkill_buffer (buf);
1525 UNGCPRO;
1528 /* Make this buffer not be current.
1529 In the process, notice if this is the sole visible buffer
1530 and give up if so. */
1531 if (b == current_buffer)
1533 tem = Fother_buffer (buffer, Qnil, Qnil);
1534 Fset_buffer (tem);
1535 if (b == current_buffer)
1536 return Qnil;
1539 /* Notice if the buffer to kill is the sole visible buffer
1540 when we're currently in the mini-buffer, and give up if so. */
1541 XSETBUFFER (tem, current_buffer);
1542 if (EQ (tem, XWINDOW (minibuf_window)->buffer))
1544 tem = Fother_buffer (buffer, Qnil, Qnil);
1545 if (EQ (buffer, tem))
1546 return Qnil;
1549 /* Now there is no question: we can kill the buffer. */
1551 #ifdef CLASH_DETECTION
1552 /* Unlock this buffer's file, if it is locked. */
1553 unlock_buffer (b);
1554 #endif /* CLASH_DETECTION */
1556 GCPRO1 (buffer);
1557 kill_buffer_processes (buffer);
1558 UNGCPRO;
1560 /* Killing buffer processes may run sentinels which may
1561 have called kill-buffer. */
1563 if (NILP (BVAR (b, name)))
1564 return Qnil;
1566 /* These may run Lisp code and into infinite loops (if someone
1567 insisted on circular lists) so allow quitting here. */
1568 replace_buffer_in_windows (buffer);
1569 frames_discard_buffer (buffer);
1571 clear_charpos_cache (b);
1573 tem = Vinhibit_quit;
1574 Vinhibit_quit = Qt;
1575 /* Remove the buffer from the list of all buffers. */
1576 Vbuffer_alist = Fdelq (Frassq (buffer, Vbuffer_alist), Vbuffer_alist);
1577 /* If replace_buffer_in_windows didn't do its job correctly fix that
1578 now. */
1579 replace_buffer_in_windows_safely (buffer);
1580 Vinhibit_quit = tem;
1582 /* Delete any auto-save file, if we saved it in this session.
1583 But not if the buffer is modified. */
1584 if (STRINGP (BVAR (b, auto_save_file_name))
1585 && BUF_AUTOSAVE_MODIFF (b) != 0
1586 && BUF_SAVE_MODIFF (b) < BUF_AUTOSAVE_MODIFF (b)
1587 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
1588 && NILP (Fsymbol_value (intern ("auto-save-visited-file-name"))))
1590 Lisp_Object delete;
1591 delete = Fsymbol_value (intern ("delete-auto-save-files"));
1592 if (! NILP (delete))
1593 internal_delete_file (BVAR (b, auto_save_file_name));
1596 if (b->base_buffer)
1598 /* Unchain all markers that belong to this indirect buffer.
1599 Don't unchain the markers that belong to the base buffer
1600 or its other indirect buffers. */
1601 for (m = BUF_MARKERS (b); m; )
1603 struct Lisp_Marker *next = m->next;
1604 if (m->buffer == b)
1605 unchain_marker (m);
1606 m = next;
1609 else
1611 /* Unchain all markers of this buffer and its indirect buffers.
1612 and leave them pointing nowhere. */
1613 for (m = BUF_MARKERS (b); m; )
1615 struct Lisp_Marker *next = m->next;
1616 m->buffer = 0;
1617 m->next = NULL;
1618 m = next;
1620 BUF_MARKERS (b) = NULL;
1621 BUF_INTERVALS (b) = NULL_INTERVAL;
1623 /* Perhaps we should explicitly free the interval tree here... */
1626 /* Reset the local variables, so that this buffer's local values
1627 won't be protected from GC. They would be protected
1628 if they happened to remain encached in their symbols.
1629 This gets rid of them for certain. */
1630 swap_out_buffer_local_variables (b);
1631 reset_buffer_local_variables (b, 1);
1633 BVAR (b, name) = Qnil;
1635 BLOCK_INPUT;
1636 if (! b->base_buffer)
1637 free_buffer_text (b);
1639 if (b->newline_cache)
1641 free_region_cache (b->newline_cache);
1642 b->newline_cache = 0;
1644 if (b->width_run_cache)
1646 free_region_cache (b->width_run_cache);
1647 b->width_run_cache = 0;
1649 BVAR (b, width_table) = Qnil;
1650 UNBLOCK_INPUT;
1651 BVAR (b, undo_list) = Qnil;
1653 /* Run buffer-list-update-hook. */
1654 if (!NILP (Vrun_hooks))
1655 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1657 return Qt;
1660 /* Move association for BUFFER to the front of buffer (a)lists. Since
1661 we do this each time BUFFER is selected visibly, the more recently
1662 selected buffers are always closer to the front of those lists. This
1663 means that other_buffer is more likely to choose a relevant buffer.
1665 Note that this moves BUFFER to the front of the buffer lists of the
1666 selected frame even if BUFFER is not shown there. If BUFFER is not
1667 shown in the selected frame, consider the present behavior a feature.
1668 `select-window' gets this right since it shows BUFFER in the selected
1669 window when calling us. */
1671 void
1672 record_buffer (Lisp_Object buffer)
1674 Lisp_Object aelt, aelt_cons, tem;
1675 register struct frame *f = XFRAME (selected_frame);
1677 CHECK_BUFFER (buffer);
1679 /* Update Vbuffer_alist (we know that it has an entry for BUFFER).
1680 Don't allow quitting since this might leave the buffer list in an
1681 inconsistent state. */
1682 tem = Vinhibit_quit;
1683 Vinhibit_quit = Qt;
1684 aelt = Frassq (buffer, Vbuffer_alist);
1685 aelt_cons = Fmemq (aelt, Vbuffer_alist);
1686 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
1687 XSETCDR (aelt_cons, Vbuffer_alist);
1688 Vbuffer_alist = aelt_cons;
1689 Vinhibit_quit = tem;
1691 /* Update buffer list of selected frame. */
1692 f->buffer_list = Fcons (buffer, Fdelq (buffer, f->buffer_list));
1693 f->buried_buffer_list = Fdelq (buffer, f->buried_buffer_list);
1695 /* Run buffer-list-update-hook. */
1696 if (!NILP (Vrun_hooks))
1697 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1700 DEFUN ("record-buffer", Frecord_buffer, Srecord_buffer, 1, 1, 0,
1701 doc: /* Move BUFFER to the front of the buffer list.
1702 Return BUFFER. */)
1703 (Lisp_Object buffer)
1705 CHECK_BUFFER (buffer);
1707 record_buffer (buffer);
1709 return buffer;
1712 /* Move BUFFER to the end of the buffer (a)lists. Do nothing if the
1713 buffer is killed. For the selected frame's buffer list this moves
1714 BUFFER to its end even if it was never shown in that frame. If
1715 this happens we have a feature, hence `unrecord-buffer' should be
1716 called only when BUFFER was shown in the selected frame. */
1718 DEFUN ("unrecord-buffer", Funrecord_buffer, Sunrecord_buffer, 1, 1, 0,
1719 doc: /* Move BUFFER to the end of the buffer list.
1720 Return BUFFER. */)
1721 (Lisp_Object buffer)
1723 Lisp_Object aelt, aelt_cons, tem;
1724 register struct frame *f = XFRAME (selected_frame);
1726 CHECK_BUFFER (buffer);
1728 /* Update Vbuffer_alist (we know that it has an entry for BUFFER).
1729 Don't allow quitting since this might leave the buffer list in an
1730 inconsistent state. */
1731 tem = Vinhibit_quit;
1732 Vinhibit_quit = Qt;
1733 aelt = Frassq (buffer, Vbuffer_alist);
1734 aelt_cons = Fmemq (aelt, Vbuffer_alist);
1735 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
1736 XSETCDR (aelt_cons, Qnil);
1737 Vbuffer_alist = nconc2 (Vbuffer_alist, aelt_cons);
1738 Vinhibit_quit = tem;
1740 /* Update buffer lists of selected frame. */
1741 f->buffer_list = Fdelq (buffer, f->buffer_list);
1742 f->buried_buffer_list = Fcons (buffer, Fdelq (buffer, f->buried_buffer_list));
1744 /* Run buffer-list-update-hook. */
1745 if (!NILP (Vrun_hooks))
1746 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1748 return buffer;
1751 DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode, Sset_buffer_major_mode, 1, 1, 0,
1752 doc: /* Set an appropriate major mode for BUFFER.
1753 For the *scratch* buffer, use `initial-major-mode', otherwise choose a mode
1754 according to `default-major-mode'.
1755 Use this function before selecting the buffer, since it may need to inspect
1756 the current buffer's major mode. */)
1757 (Lisp_Object buffer)
1759 int count;
1760 Lisp_Object function;
1762 CHECK_BUFFER (buffer);
1764 if (STRINGP (BVAR (XBUFFER (buffer), name))
1765 && strcmp (SSDATA (BVAR (XBUFFER (buffer), name)), "*scratch*") == 0)
1766 function = find_symbol_value (intern ("initial-major-mode"));
1767 else
1769 function = BVAR (&buffer_defaults, major_mode);
1770 if (NILP (function)
1771 && NILP (Fget (BVAR (current_buffer, major_mode), Qmode_class)))
1772 function = BVAR (current_buffer, major_mode);
1775 if (NILP (function) || EQ (function, Qfundamental_mode))
1776 return Qnil;
1778 count = SPECPDL_INDEX ();
1780 /* To select a nonfundamental mode,
1781 select the buffer temporarily and then call the mode function. */
1783 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1785 Fset_buffer (buffer);
1786 call0 (function);
1788 return unbind_to (count, Qnil);
1791 DEFUN ("current-buffer", Fcurrent_buffer, Scurrent_buffer, 0, 0, 0,
1792 doc: /* Return the current buffer as a Lisp object. */)
1793 (void)
1795 register Lisp_Object buf;
1796 XSETBUFFER (buf, current_buffer);
1797 return buf;
1800 /* Set the current buffer to B.
1802 We previously set windows_or_buffers_changed here to invalidate
1803 global unchanged information in beg_unchanged and end_unchanged.
1804 This is no longer necessary because we now compute unchanged
1805 information on a buffer-basis. Every action affecting other
1806 windows than the selected one requires a select_window at some
1807 time, and that increments windows_or_buffers_changed. */
1809 void
1810 set_buffer_internal (register struct buffer *b)
1812 if (current_buffer != b)
1813 set_buffer_internal_1 (b);
1816 /* Set the current buffer to B, and do not set windows_or_buffers_changed.
1817 This is used by redisplay. */
1819 void
1820 set_buffer_internal_1 (register struct buffer *b)
1822 register struct buffer *old_buf;
1823 register Lisp_Object tail;
1825 #ifdef USE_MMAP_FOR_BUFFERS
1826 if (b->text->beg == NULL)
1827 enlarge_buffer_text (b, 0);
1828 #endif /* USE_MMAP_FOR_BUFFERS */
1830 if (current_buffer == b)
1831 return;
1833 old_buf = current_buffer;
1834 current_buffer = b;
1835 last_known_column_point = -1; /* invalidate indentation cache */
1837 if (old_buf)
1839 /* Put the undo list back in the base buffer, so that it appears
1840 that an indirect buffer shares the undo list of its base. */
1841 if (old_buf->base_buffer)
1842 BVAR (old_buf->base_buffer, undo_list) = BVAR (old_buf, undo_list);
1844 /* If the old current buffer has markers to record PT, BEGV and ZV
1845 when it is not current, update them now. */
1846 record_buffer_markers (old_buf);
1849 /* Get the undo list from the base buffer, so that it appears
1850 that an indirect buffer shares the undo list of its base. */
1851 if (b->base_buffer)
1852 BVAR (b, undo_list) = BVAR (b->base_buffer, undo_list);
1854 /* If the new current buffer has markers to record PT, BEGV and ZV
1855 when it is not current, fetch them now. */
1856 fetch_buffer_markers (b);
1858 /* Look down buffer's list of local Lisp variables
1859 to find and update any that forward into C variables. */
1863 for (tail = BVAR (b, local_var_alist); CONSP (tail); tail = XCDR (tail))
1865 Lisp_Object var = XCAR (XCAR (tail));
1866 struct Lisp_Symbol *sym = XSYMBOL (var);
1867 if (sym->redirect == SYMBOL_LOCALIZED /* Just to be sure. */
1868 && SYMBOL_BLV (sym)->fwd)
1869 /* Just reference the variable
1870 to cause it to become set for this buffer. */
1871 Fsymbol_value (var);
1874 /* Do the same with any others that were local to the previous buffer */
1875 while (b != old_buf && (b = old_buf, b));
1878 /* Switch to buffer B temporarily for redisplay purposes.
1879 This avoids certain things that don't need to be done within redisplay. */
1881 void
1882 set_buffer_temp (struct buffer *b)
1884 register struct buffer *old_buf;
1886 if (current_buffer == b)
1887 return;
1889 old_buf = current_buffer;
1890 current_buffer = b;
1892 /* If the old current buffer has markers to record PT, BEGV and ZV
1893 when it is not current, update them now. */
1894 record_buffer_markers (old_buf);
1896 /* If the new current buffer has markers to record PT, BEGV and ZV
1897 when it is not current, fetch them now. */
1898 fetch_buffer_markers (b);
1901 DEFUN ("set-buffer", Fset_buffer, Sset_buffer, 1, 1, 0,
1902 doc: /* Make buffer BUFFER-OR-NAME current for editing operations.
1903 BUFFER-OR-NAME may be a buffer or the name of an existing buffer. See
1904 also `save-excursion' when you want to make a buffer current
1905 temporarily. This function does not display the buffer, so its effect
1906 ends when the current command terminates. Use `switch-to-buffer' or
1907 `pop-to-buffer' to switch buffers permanently. */)
1908 (register Lisp_Object buffer_or_name)
1910 register Lisp_Object buffer;
1911 buffer = Fget_buffer (buffer_or_name);
1912 if (NILP (buffer))
1913 nsberror (buffer_or_name);
1914 if (NILP (BVAR (XBUFFER (buffer), name)))
1915 error ("Selecting deleted buffer");
1916 set_buffer_internal (XBUFFER (buffer));
1917 return buffer;
1920 /* Set the current buffer to BUFFER provided it is alive. */
1922 Lisp_Object
1923 set_buffer_if_live (Lisp_Object buffer)
1925 if (! NILP (BVAR (XBUFFER (buffer), name)))
1926 Fset_buffer (buffer);
1927 return Qnil;
1930 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only,
1931 Sbarf_if_buffer_read_only, 0, 0, 0,
1932 doc: /* Signal a `buffer-read-only' error if the current buffer is read-only. */)
1933 (void)
1935 if (!NILP (BVAR (current_buffer, read_only))
1936 && NILP (Vinhibit_read_only))
1937 xsignal1 (Qbuffer_read_only, Fcurrent_buffer ());
1938 return Qnil;
1941 DEFUN ("erase-buffer", Ferase_buffer, Serase_buffer, 0, 0, "*",
1942 doc: /* Delete the entire contents of the current buffer.
1943 Any narrowing restriction in effect (see `narrow-to-region') is removed,
1944 so the buffer is truly empty after this. */)
1945 (void)
1947 Fwiden ();
1949 del_range (BEG, Z);
1951 current_buffer->last_window_start = 1;
1952 /* Prevent warnings, or suspension of auto saving, that would happen
1953 if future size is less than past size. Use of erase-buffer
1954 implies that the future text is not really related to the past text. */
1955 XSETFASTINT (BVAR (current_buffer, save_length), 0);
1956 return Qnil;
1959 void
1960 validate_region (register Lisp_Object *b, register Lisp_Object *e)
1962 CHECK_NUMBER_COERCE_MARKER (*b);
1963 CHECK_NUMBER_COERCE_MARKER (*e);
1965 if (XINT (*b) > XINT (*e))
1967 Lisp_Object tem;
1968 tem = *b; *b = *e; *e = tem;
1971 if (!(BEGV <= XINT (*b) && XINT (*b) <= XINT (*e)
1972 && XINT (*e) <= ZV))
1973 args_out_of_range (*b, *e);
1976 /* Advance BYTE_POS up to a character boundary
1977 and return the adjusted position. */
1979 static EMACS_INT
1980 advance_to_char_boundary (EMACS_INT byte_pos)
1982 int c;
1984 if (byte_pos == BEG)
1985 /* Beginning of buffer is always a character boundary. */
1986 return BEG;
1988 c = FETCH_BYTE (byte_pos);
1989 if (! CHAR_HEAD_P (c))
1991 /* We should advance BYTE_POS only when C is a constituent of a
1992 multibyte sequence. */
1993 EMACS_INT orig_byte_pos = byte_pos;
1997 byte_pos--;
1998 c = FETCH_BYTE (byte_pos);
2000 while (! CHAR_HEAD_P (c) && byte_pos > BEG);
2001 INC_POS (byte_pos);
2002 if (byte_pos < orig_byte_pos)
2003 byte_pos = orig_byte_pos;
2004 /* If C is a constituent of a multibyte sequence, BYTE_POS was
2005 surely advance to the correct character boundary. If C is
2006 not, BYTE_POS was unchanged. */
2009 return byte_pos;
2012 #ifdef REL_ALLOC
2013 extern void r_alloc_reset_variable (POINTER_TYPE *, POINTER_TYPE *);
2014 #endif /* REL_ALLOC */
2016 DEFUN ("buffer-swap-text", Fbuffer_swap_text, Sbuffer_swap_text,
2017 1, 1, 0,
2018 doc: /* Swap the text between current buffer and BUFFER. */)
2019 (Lisp_Object buffer)
2021 struct buffer *other_buffer;
2022 CHECK_BUFFER (buffer);
2023 other_buffer = XBUFFER (buffer);
2025 if (NILP (BVAR (other_buffer, name)))
2026 error ("Cannot swap a dead buffer's text");
2028 /* Actually, it probably works just fine.
2029 * if (other_buffer == current_buffer)
2030 * error ("Cannot swap a buffer's text with itself"); */
2032 /* Actually, this may be workable as well, tho probably only if they're
2033 *both* indirect. */
2034 if (other_buffer->base_buffer
2035 || current_buffer->base_buffer)
2036 error ("Cannot swap indirect buffers's text");
2038 { /* This is probably harder to make work. */
2039 struct buffer *other;
2040 for (other = all_buffers; other; other = other->header.next.buffer)
2041 if (other->base_buffer == other_buffer
2042 || other->base_buffer == current_buffer)
2043 error ("One of the buffers to swap has indirect buffers");
2046 #define swapfield(field, type) \
2047 do { \
2048 type tmp##field = other_buffer->field; \
2049 other_buffer->field = current_buffer->field; \
2050 current_buffer->field = tmp##field; \
2051 } while (0)
2052 #define swapfield_(field, type) \
2053 do { \
2054 type tmp##field = BVAR (other_buffer, field); \
2055 BVAR (other_buffer, field) = BVAR (current_buffer, field); \
2056 BVAR (current_buffer, field) = tmp##field; \
2057 } while (0)
2059 swapfield (own_text, struct buffer_text);
2060 eassert (current_buffer->text == &current_buffer->own_text);
2061 eassert (other_buffer->text == &other_buffer->own_text);
2062 #ifdef REL_ALLOC
2063 r_alloc_reset_variable ((POINTER_TYPE **) &current_buffer->own_text.beg,
2064 (POINTER_TYPE **) &other_buffer->own_text.beg);
2065 r_alloc_reset_variable ((POINTER_TYPE **) &other_buffer->own_text.beg,
2066 (POINTER_TYPE **) &current_buffer->own_text.beg);
2067 #endif /* REL_ALLOC */
2069 swapfield (pt, EMACS_INT);
2070 swapfield (pt_byte, EMACS_INT);
2071 swapfield (begv, EMACS_INT);
2072 swapfield (begv_byte, EMACS_INT);
2073 swapfield (zv, EMACS_INT);
2074 swapfield (zv_byte, EMACS_INT);
2075 eassert (!current_buffer->base_buffer);
2076 eassert (!other_buffer->base_buffer);
2077 current_buffer->clip_changed = 1; other_buffer->clip_changed = 1;
2078 swapfield (newline_cache, struct region_cache *);
2079 swapfield (width_run_cache, struct region_cache *);
2080 current_buffer->prevent_redisplay_optimizations_p = 1;
2081 other_buffer->prevent_redisplay_optimizations_p = 1;
2082 swapfield (overlays_before, struct Lisp_Overlay *);
2083 swapfield (overlays_after, struct Lisp_Overlay *);
2084 swapfield (overlay_center, EMACS_INT);
2085 swapfield_ (undo_list, Lisp_Object);
2086 swapfield_ (mark, Lisp_Object);
2087 swapfield_ (enable_multibyte_characters, Lisp_Object);
2088 swapfield_ (bidi_display_reordering, Lisp_Object);
2089 swapfield_ (bidi_paragraph_direction, Lisp_Object);
2090 /* FIXME: Not sure what we should do with these *_marker fields.
2091 Hopefully they're just nil anyway. */
2092 swapfield_ (pt_marker, Lisp_Object);
2093 swapfield_ (begv_marker, Lisp_Object);
2094 swapfield_ (zv_marker, Lisp_Object);
2095 BVAR (current_buffer, point_before_scroll) = Qnil;
2096 BVAR (other_buffer, point_before_scroll) = Qnil;
2098 current_buffer->text->modiff++; other_buffer->text->modiff++;
2099 current_buffer->text->chars_modiff++; other_buffer->text->chars_modiff++;
2100 current_buffer->text->overlay_modiff++; other_buffer->text->overlay_modiff++;
2101 current_buffer->text->beg_unchanged = current_buffer->text->gpt;
2102 current_buffer->text->end_unchanged = current_buffer->text->gpt;
2103 other_buffer->text->beg_unchanged = other_buffer->text->gpt;
2104 other_buffer->text->end_unchanged = other_buffer->text->gpt;
2106 struct Lisp_Marker *m;
2107 for (m = BUF_MARKERS (current_buffer); m; m = m->next)
2108 if (m->buffer == other_buffer)
2109 m->buffer = current_buffer;
2110 else
2111 /* Since there's no indirect buffer in sight, markers on
2112 BUF_MARKERS(buf) should either be for `buf' or dead. */
2113 eassert (!m->buffer);
2114 for (m = BUF_MARKERS (other_buffer); m; m = m->next)
2115 if (m->buffer == current_buffer)
2116 m->buffer = other_buffer;
2117 else
2118 /* Since there's no indirect buffer in sight, markers on
2119 BUF_MARKERS(buf) should either be for `buf' or dead. */
2120 eassert (!m->buffer);
2122 { /* Some of the C code expects that w->buffer == w->pointm->buffer.
2123 So since we just swapped the markers between the two buffers, we need
2124 to undo the effect of this swap for window markers. */
2125 Lisp_Object w = Fselected_window (), ws = Qnil;
2126 Lisp_Object buf1, buf2;
2127 XSETBUFFER (buf1, current_buffer); XSETBUFFER (buf2, other_buffer);
2129 while (NILP (Fmemq (w, ws)))
2131 ws = Fcons (w, ws);
2132 if (MARKERP (XWINDOW (w)->pointm)
2133 && (EQ (XWINDOW (w)->buffer, buf1)
2134 || EQ (XWINDOW (w)->buffer, buf2)))
2135 Fset_marker (XWINDOW (w)->pointm,
2136 make_number (BUF_BEGV (XBUFFER (XWINDOW (w)->buffer))),
2137 XWINDOW (w)->buffer);
2138 w = Fnext_window (w, Qt, Qt);
2142 if (current_buffer->text->intervals)
2143 (eassert (EQ (current_buffer->text->intervals->up.obj, buffer)),
2144 XSETBUFFER (current_buffer->text->intervals->up.obj, current_buffer));
2145 if (other_buffer->text->intervals)
2146 (eassert (EQ (other_buffer->text->intervals->up.obj, Fcurrent_buffer ())),
2147 XSETBUFFER (other_buffer->text->intervals->up.obj, other_buffer));
2149 return Qnil;
2152 DEFUN ("set-buffer-multibyte", Fset_buffer_multibyte, Sset_buffer_multibyte,
2153 1, 1, 0,
2154 doc: /* Set the multibyte flag of the current buffer to FLAG.
2155 If FLAG is t, this makes the buffer a multibyte buffer.
2156 If FLAG is nil, this makes the buffer a single-byte buffer.
2157 In these cases, the buffer contents remain unchanged as a sequence of
2158 bytes but the contents viewed as characters do change.
2159 If FLAG is `to', this makes the buffer a multibyte buffer by changing
2160 all eight-bit bytes to eight-bit characters.
2161 If the multibyte flag was really changed, undo information of the
2162 current buffer is cleared. */)
2163 (Lisp_Object flag)
2165 struct Lisp_Marker *tail, *markers;
2166 struct buffer *other;
2167 EMACS_INT begv, zv;
2168 int narrowed = (BEG != BEGV || Z != ZV);
2169 int modified_p = !NILP (Fbuffer_modified_p (Qnil));
2170 Lisp_Object old_undo = BVAR (current_buffer, undo_list);
2171 struct gcpro gcpro1;
2173 if (current_buffer->base_buffer)
2174 error ("Cannot do `set-buffer-multibyte' on an indirect buffer");
2176 /* Do nothing if nothing actually changes. */
2177 if (NILP (flag) == NILP (BVAR (current_buffer, enable_multibyte_characters)))
2178 return flag;
2180 GCPRO1 (old_undo);
2182 /* Don't record these buffer changes. We will put a special undo entry
2183 instead. */
2184 BVAR (current_buffer, undo_list) = Qt;
2186 /* If the cached position is for this buffer, clear it out. */
2187 clear_charpos_cache (current_buffer);
2189 if (NILP (flag))
2190 begv = BEGV_BYTE, zv = ZV_BYTE;
2191 else
2192 begv = BEGV, zv = ZV;
2194 if (narrowed)
2195 Fwiden ();
2197 if (NILP (flag))
2199 EMACS_INT pos, stop;
2200 unsigned char *p;
2202 /* Do this first, so it can use CHAR_TO_BYTE
2203 to calculate the old correspondences. */
2204 set_intervals_multibyte (0);
2206 BVAR (current_buffer, enable_multibyte_characters) = Qnil;
2208 Z = Z_BYTE;
2209 BEGV = BEGV_BYTE;
2210 ZV = ZV_BYTE;
2211 GPT = GPT_BYTE;
2212 TEMP_SET_PT_BOTH (PT_BYTE, PT_BYTE);
2215 for (tail = BUF_MARKERS (current_buffer); tail; tail = tail->next)
2216 tail->charpos = tail->bytepos;
2218 /* Convert multibyte form of 8-bit characters to unibyte. */
2219 pos = BEG;
2220 stop = GPT;
2221 p = BEG_ADDR;
2222 while (1)
2224 int c, bytes;
2226 if (pos == stop)
2228 if (pos == Z)
2229 break;
2230 p = GAP_END_ADDR;
2231 stop = Z;
2233 if (ASCII_BYTE_P (*p))
2234 p++, pos++;
2235 else if (CHAR_BYTE8_HEAD_P (*p))
2237 c = STRING_CHAR_AND_LENGTH (p, bytes);
2238 /* Delete all bytes for this 8-bit character but the
2239 last one, and change the last one to the character
2240 code. */
2241 bytes--;
2242 del_range_2 (pos, pos, pos + bytes, pos + bytes, 0);
2243 p = GAP_END_ADDR;
2244 *p++ = c;
2245 pos++;
2246 if (begv > pos)
2247 begv -= bytes;
2248 if (zv > pos)
2249 zv -= bytes;
2250 stop = Z;
2252 else
2254 bytes = BYTES_BY_CHAR_HEAD (*p);
2255 p += bytes, pos += bytes;
2258 if (narrowed)
2259 Fnarrow_to_region (make_number (begv), make_number (zv));
2261 else
2263 EMACS_INT pt = PT;
2264 EMACS_INT pos, stop;
2265 unsigned char *p, *pend;
2267 /* Be sure not to have a multibyte sequence striding over the GAP.
2268 Ex: We change this: "...abc\302 _GAP_ \241def..."
2269 to: "...abc _GAP_ \302\241def..." */
2271 if (EQ (flag, Qt)
2272 && GPT_BYTE > 1 && GPT_BYTE < Z_BYTE
2273 && ! CHAR_HEAD_P (*(GAP_END_ADDR)))
2275 unsigned char *q = GPT_ADDR - 1;
2277 while (! CHAR_HEAD_P (*q) && q > BEG_ADDR) q--;
2278 if (LEADING_CODE_P (*q))
2280 EMACS_INT new_gpt = GPT_BYTE - (GPT_ADDR - q);
2282 move_gap_both (new_gpt, new_gpt);
2286 /* Make the buffer contents valid as multibyte by converting
2287 8-bit characters to multibyte form. */
2288 pos = BEG;
2289 stop = GPT;
2290 p = BEG_ADDR;
2291 pend = GPT_ADDR;
2292 while (1)
2294 int bytes;
2296 if (pos == stop)
2298 if (pos == Z)
2299 break;
2300 p = GAP_END_ADDR;
2301 pend = Z_ADDR;
2302 stop = Z;
2305 if (ASCII_BYTE_P (*p))
2306 p++, pos++;
2307 else if (EQ (flag, Qt)
2308 && ! CHAR_BYTE8_HEAD_P (*p)
2309 && (bytes = MULTIBYTE_LENGTH (p, pend)) > 0)
2310 p += bytes, pos += bytes;
2311 else
2313 unsigned char tmp[MAX_MULTIBYTE_LENGTH];
2314 int c;
2316 c = BYTE8_TO_CHAR (*p);
2317 bytes = CHAR_STRING (c, tmp);
2318 *p = tmp[0];
2319 TEMP_SET_PT_BOTH (pos + 1, pos + 1);
2320 bytes--;
2321 insert_1_both ((char *) tmp + 1, bytes, bytes, 1, 0, 0);
2322 /* Now the gap is after the just inserted data. */
2323 pos = GPT;
2324 p = GAP_END_ADDR;
2325 if (pos <= begv)
2326 begv += bytes;
2327 if (pos <= zv)
2328 zv += bytes;
2329 if (pos <= pt)
2330 pt += bytes;
2331 pend = Z_ADDR;
2332 stop = Z;
2336 if (pt != PT)
2337 TEMP_SET_PT (pt);
2339 if (narrowed)
2340 Fnarrow_to_region (make_number (begv), make_number (zv));
2342 /* Do this first, so that chars_in_text asks the right question.
2343 set_intervals_multibyte needs it too. */
2344 BVAR (current_buffer, enable_multibyte_characters) = Qt;
2346 GPT_BYTE = advance_to_char_boundary (GPT_BYTE);
2347 GPT = chars_in_text (BEG_ADDR, GPT_BYTE - BEG_BYTE) + BEG;
2349 Z = chars_in_text (GAP_END_ADDR, Z_BYTE - GPT_BYTE) + GPT;
2351 BEGV_BYTE = advance_to_char_boundary (BEGV_BYTE);
2352 if (BEGV_BYTE > GPT_BYTE)
2353 BEGV = chars_in_text (GAP_END_ADDR, BEGV_BYTE - GPT_BYTE) + GPT;
2354 else
2355 BEGV = chars_in_text (BEG_ADDR, BEGV_BYTE - BEG_BYTE) + BEG;
2357 ZV_BYTE = advance_to_char_boundary (ZV_BYTE);
2358 if (ZV_BYTE > GPT_BYTE)
2359 ZV = chars_in_text (GAP_END_ADDR, ZV_BYTE - GPT_BYTE) + GPT;
2360 else
2361 ZV = chars_in_text (BEG_ADDR, ZV_BYTE - BEG_BYTE) + BEG;
2364 EMACS_INT byte = advance_to_char_boundary (PT_BYTE);
2365 EMACS_INT position;
2367 if (byte > GPT_BYTE)
2368 position = chars_in_text (GAP_END_ADDR, byte - GPT_BYTE) + GPT;
2369 else
2370 position = chars_in_text (BEG_ADDR, byte - BEG_BYTE) + BEG;
2371 TEMP_SET_PT_BOTH (position, byte);
2374 tail = markers = BUF_MARKERS (current_buffer);
2376 /* This prevents BYTE_TO_CHAR (that is, buf_bytepos_to_charpos) from
2377 getting confused by the markers that have not yet been updated.
2378 It is also a signal that it should never create a marker. */
2379 BUF_MARKERS (current_buffer) = NULL;
2381 for (; tail; tail = tail->next)
2383 tail->bytepos = advance_to_char_boundary (tail->bytepos);
2384 tail->charpos = BYTE_TO_CHAR (tail->bytepos);
2387 /* Make sure no markers were put on the chain
2388 while the chain value was incorrect. */
2389 if (BUF_MARKERS (current_buffer))
2390 abort ();
2392 BUF_MARKERS (current_buffer) = markers;
2394 /* Do this last, so it can calculate the new correspondences
2395 between chars and bytes. */
2396 set_intervals_multibyte (1);
2399 if (!EQ (old_undo, Qt))
2401 /* Represent all the above changes by a special undo entry. */
2402 BVAR (current_buffer, undo_list) = Fcons (list3 (Qapply,
2403 intern ("set-buffer-multibyte"),
2404 NILP (flag) ? Qt : Qnil),
2405 old_undo);
2408 UNGCPRO;
2410 /* Changing the multibyteness of a buffer means that all windows
2411 showing that buffer must be updated thoroughly. */
2412 current_buffer->prevent_redisplay_optimizations_p = 1;
2413 ++windows_or_buffers_changed;
2415 /* Copy this buffer's new multibyte status
2416 into all of its indirect buffers. */
2417 for (other = all_buffers; other; other = other->header.next.buffer)
2418 if (other->base_buffer == current_buffer && !NILP (BVAR (other, name)))
2420 BVAR (other, enable_multibyte_characters)
2421 = BVAR (current_buffer, enable_multibyte_characters);
2422 other->prevent_redisplay_optimizations_p = 1;
2425 /* Restore the modifiedness of the buffer. */
2426 if (!modified_p && !NILP (Fbuffer_modified_p (Qnil)))
2427 Fset_buffer_modified_p (Qnil);
2429 /* Update coding systems of this buffer's process (if any). */
2431 Lisp_Object process;
2433 process = Fget_buffer_process (Fcurrent_buffer ());
2434 if (PROCESSP (process))
2435 setup_process_coding_systems (process);
2438 return flag;
2441 DEFUN ("kill-all-local-variables", Fkill_all_local_variables,
2442 Skill_all_local_variables, 0, 0, 0,
2443 doc: /* Switch to Fundamental mode by killing current buffer's local variables.
2444 Most local variable bindings are eliminated so that the default values
2445 become effective once more. Also, the syntax table is set from
2446 `standard-syntax-table', the local keymap is set to nil,
2447 and the abbrev table from `fundamental-mode-abbrev-table'.
2448 This function also forces redisplay of the mode line.
2450 Every function to select a new major mode starts by
2451 calling this function.
2453 As a special exception, local variables whose names have
2454 a non-nil `permanent-local' property are not eliminated by this function.
2456 The first thing this function does is run
2457 the normal hook `change-major-mode-hook'. */)
2458 (void)
2460 Frun_hooks (1, &Qchange_major_mode_hook);
2462 /* Make sure none of the bindings in local_var_alist
2463 remain swapped in, in their symbols. */
2465 swap_out_buffer_local_variables (current_buffer);
2467 /* Actually eliminate all local bindings of this buffer. */
2469 reset_buffer_local_variables (current_buffer, 0);
2471 /* Force mode-line redisplay. Useful here because all major mode
2472 commands call this function. */
2473 update_mode_lines++;
2475 return Qnil;
2478 /* Make sure no local variables remain set up with buffer B
2479 for their current values. */
2481 static void
2482 swap_out_buffer_local_variables (struct buffer *b)
2484 Lisp_Object oalist, alist, buffer;
2486 XSETBUFFER (buffer, b);
2487 oalist = BVAR (b, local_var_alist);
2489 for (alist = oalist; CONSP (alist); alist = XCDR (alist))
2491 Lisp_Object sym = XCAR (XCAR (alist));
2492 eassert (XSYMBOL (sym)->redirect == SYMBOL_LOCALIZED);
2493 /* Need not do anything if some other buffer's binding is
2494 now encached. */
2495 if (EQ (SYMBOL_BLV (XSYMBOL (sym))->where, buffer))
2497 /* Symbol is set up for this buffer's old local value:
2498 swap it out! */
2499 swap_in_global_binding (XSYMBOL (sym));
2504 /* Find all the overlays in the current buffer that contain position POS.
2505 Return the number found, and store them in a vector in *VEC_PTR.
2506 Store in *LEN_PTR the size allocated for the vector.
2507 Store in *NEXT_PTR the next position after POS where an overlay starts,
2508 or ZV if there are no more overlays between POS and ZV.
2509 Store in *PREV_PTR the previous position before POS where an overlay ends,
2510 or where an overlay starts which ends at or after POS;
2511 or BEGV if there are no such overlays from BEGV to POS.
2512 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2514 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2515 when this function is called.
2517 If EXTEND is non-zero, we make the vector bigger if necessary.
2518 If EXTEND is zero, we never extend the vector,
2519 and we store only as many overlays as will fit.
2520 But we still return the total number of overlays.
2522 If CHANGE_REQ is true, then any position written into *PREV_PTR or
2523 *NEXT_PTR is guaranteed to be not equal to POS, unless it is the
2524 default (BEGV or ZV). */
2526 ptrdiff_t
2527 overlays_at (EMACS_INT pos, int extend, Lisp_Object **vec_ptr,
2528 ptrdiff_t *len_ptr,
2529 EMACS_INT *next_ptr, EMACS_INT *prev_ptr, int change_req)
2531 Lisp_Object overlay, start, end;
2532 struct Lisp_Overlay *tail;
2533 ptrdiff_t idx = 0;
2534 ptrdiff_t len = *len_ptr;
2535 Lisp_Object *vec = *vec_ptr;
2536 EMACS_INT next = ZV;
2537 EMACS_INT prev = BEGV;
2538 int inhibit_storing = 0;
2540 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2542 EMACS_INT startpos, endpos;
2544 XSETMISC (overlay, tail);
2546 start = OVERLAY_START (overlay);
2547 end = OVERLAY_END (overlay);
2548 endpos = OVERLAY_POSITION (end);
2549 if (endpos < pos)
2551 if (prev < endpos)
2552 prev = endpos;
2553 break;
2555 startpos = OVERLAY_POSITION (start);
2556 /* This one ends at or after POS
2557 so its start counts for PREV_PTR if it's before POS. */
2558 if (prev < startpos && startpos < pos)
2559 prev = startpos;
2560 if (endpos == pos)
2561 continue;
2562 if (startpos <= pos)
2564 if (idx == len)
2566 /* The supplied vector is full.
2567 Either make it bigger, or don't store any more in it. */
2568 if (extend)
2570 if ((OVERLAY_COUNT_MAX - 4) / 2 < len)
2571 memory_full (SIZE_MAX);
2572 /* Make it work with an initial len == 0. */
2573 len = len * 2 + 4;
2574 *len_ptr = len;
2575 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2576 *vec_ptr = vec;
2578 else
2579 inhibit_storing = 1;
2582 if (!inhibit_storing)
2583 vec[idx] = overlay;
2584 /* Keep counting overlays even if we can't return them all. */
2585 idx++;
2587 else if (startpos < next)
2588 next = startpos;
2591 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2593 EMACS_INT startpos, endpos;
2595 XSETMISC (overlay, tail);
2597 start = OVERLAY_START (overlay);
2598 end = OVERLAY_END (overlay);
2599 startpos = OVERLAY_POSITION (start);
2600 if (pos < startpos)
2602 if (startpos < next)
2603 next = startpos;
2604 break;
2606 endpos = OVERLAY_POSITION (end);
2607 if (pos < endpos)
2609 if (idx == len)
2611 if (extend)
2613 if ((OVERLAY_COUNT_MAX - 4) / 2 < len)
2614 memory_full (SIZE_MAX);
2615 /* Make it work with an initial len == 0. */
2616 len = len * 2 + 4;
2617 *len_ptr = len;
2618 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2619 *vec_ptr = vec;
2621 else
2622 inhibit_storing = 1;
2625 if (!inhibit_storing)
2626 vec[idx] = overlay;
2627 idx++;
2629 if (startpos < pos && startpos > prev)
2630 prev = startpos;
2632 else if (endpos < pos && endpos > prev)
2633 prev = endpos;
2634 else if (endpos == pos && startpos > prev
2635 && (!change_req || startpos < pos))
2636 prev = startpos;
2639 if (next_ptr)
2640 *next_ptr = next;
2641 if (prev_ptr)
2642 *prev_ptr = prev;
2643 return idx;
2646 /* Find all the overlays in the current buffer that overlap the range
2647 BEG-END, or are empty at BEG, or are empty at END provided END
2648 denotes the position at the end of the current buffer.
2650 Return the number found, and store them in a vector in *VEC_PTR.
2651 Store in *LEN_PTR the size allocated for the vector.
2652 Store in *NEXT_PTR the next position after POS where an overlay starts,
2653 or ZV if there are no more overlays.
2654 Store in *PREV_PTR the previous position before POS where an overlay ends,
2655 or BEGV if there are no previous overlays.
2656 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2658 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2659 when this function is called.
2661 If EXTEND is non-zero, we make the vector bigger if necessary.
2662 If EXTEND is zero, we never extend the vector,
2663 and we store only as many overlays as will fit.
2664 But we still return the total number of overlays. */
2666 static ptrdiff_t
2667 overlays_in (EMACS_INT beg, EMACS_INT end, int extend,
2668 Lisp_Object **vec_ptr, ptrdiff_t *len_ptr,
2669 EMACS_INT *next_ptr, EMACS_INT *prev_ptr)
2671 Lisp_Object overlay, ostart, oend;
2672 struct Lisp_Overlay *tail;
2673 ptrdiff_t idx = 0;
2674 ptrdiff_t len = *len_ptr;
2675 Lisp_Object *vec = *vec_ptr;
2676 EMACS_INT next = ZV;
2677 EMACS_INT prev = BEGV;
2678 int inhibit_storing = 0;
2679 int end_is_Z = end == Z;
2681 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2683 EMACS_INT startpos, endpos;
2685 XSETMISC (overlay, tail);
2687 ostart = OVERLAY_START (overlay);
2688 oend = OVERLAY_END (overlay);
2689 endpos = OVERLAY_POSITION (oend);
2690 if (endpos < beg)
2692 if (prev < endpos)
2693 prev = endpos;
2694 break;
2696 startpos = OVERLAY_POSITION (ostart);
2697 /* Count an interval if it overlaps the range, is empty at the
2698 start of the range, or is empty at END provided END denotes the
2699 end of the buffer. */
2700 if ((beg < endpos && startpos < end)
2701 || (startpos == endpos
2702 && (beg == endpos || (end_is_Z && endpos == end))))
2704 if (idx == len)
2706 /* The supplied vector is full.
2707 Either make it bigger, or don't store any more in it. */
2708 if (extend)
2710 if ((OVERLAY_COUNT_MAX - 4) / 2 < len)
2711 memory_full (SIZE_MAX);
2712 /* Make it work with an initial len == 0. */
2713 len = len * 2 + 4;
2714 *len_ptr = len;
2715 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2716 *vec_ptr = vec;
2718 else
2719 inhibit_storing = 1;
2722 if (!inhibit_storing)
2723 vec[idx] = overlay;
2724 /* Keep counting overlays even if we can't return them all. */
2725 idx++;
2727 else if (startpos < next)
2728 next = startpos;
2731 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2733 EMACS_INT startpos, endpos;
2735 XSETMISC (overlay, tail);
2737 ostart = OVERLAY_START (overlay);
2738 oend = OVERLAY_END (overlay);
2739 startpos = OVERLAY_POSITION (ostart);
2740 if (end < startpos)
2742 if (startpos < next)
2743 next = startpos;
2744 break;
2746 endpos = OVERLAY_POSITION (oend);
2747 /* Count an interval if it overlaps the range, is empty at the
2748 start of the range, or is empty at END provided END denotes the
2749 end of the buffer. */
2750 if ((beg < endpos && startpos < end)
2751 || (startpos == endpos
2752 && (beg == endpos || (end_is_Z && endpos == end))))
2754 if (idx == len)
2756 if (extend)
2758 if ((OVERLAY_COUNT_MAX - 4) / 2 < len)
2759 memory_full (SIZE_MAX);
2760 /* Make it work with an initial len == 0. */
2761 len = len * 2 + 4;
2762 *len_ptr = len;
2763 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2764 *vec_ptr = vec;
2766 else
2767 inhibit_storing = 1;
2770 if (!inhibit_storing)
2771 vec[idx] = overlay;
2772 idx++;
2774 else if (endpos < beg && endpos > prev)
2775 prev = endpos;
2778 if (next_ptr)
2779 *next_ptr = next;
2780 if (prev_ptr)
2781 *prev_ptr = prev;
2782 return idx;
2786 /* Return non-zero if there exists an overlay with a non-nil
2787 `mouse-face' property overlapping OVERLAY. */
2790 mouse_face_overlay_overlaps (Lisp_Object overlay)
2792 EMACS_INT start = OVERLAY_POSITION (OVERLAY_START (overlay));
2793 EMACS_INT end = OVERLAY_POSITION (OVERLAY_END (overlay));
2794 ptrdiff_t n, i, size;
2795 Lisp_Object *v, tem;
2797 size = 10;
2798 v = (Lisp_Object *) alloca (size * sizeof *v);
2799 n = overlays_in (start, end, 0, &v, &size, NULL, NULL);
2800 if (n > size)
2802 v = (Lisp_Object *) alloca (n * sizeof *v);
2803 overlays_in (start, end, 0, &v, &n, NULL, NULL);
2806 for (i = 0; i < n; ++i)
2807 if (!EQ (v[i], overlay)
2808 && (tem = Foverlay_get (overlay, Qmouse_face),
2809 !NILP (tem)))
2810 break;
2812 return i < n;
2817 /* Fast function to just test if we're at an overlay boundary. */
2819 overlay_touches_p (EMACS_INT pos)
2821 Lisp_Object overlay;
2822 struct Lisp_Overlay *tail;
2824 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2826 EMACS_INT endpos;
2828 XSETMISC (overlay ,tail);
2829 if (!OVERLAYP (overlay))
2830 abort ();
2832 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2833 if (endpos < pos)
2834 break;
2835 if (endpos == pos || OVERLAY_POSITION (OVERLAY_START (overlay)) == pos)
2836 return 1;
2839 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2841 EMACS_INT startpos;
2843 XSETMISC (overlay, tail);
2844 if (!OVERLAYP (overlay))
2845 abort ();
2847 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2848 if (pos < startpos)
2849 break;
2850 if (startpos == pos || OVERLAY_POSITION (OVERLAY_END (overlay)) == pos)
2851 return 1;
2853 return 0;
2856 struct sortvec
2858 Lisp_Object overlay;
2859 EMACS_INT beg, end;
2860 EMACS_INT priority;
2863 static int
2864 compare_overlays (const void *v1, const void *v2)
2866 const struct sortvec *s1 = (const struct sortvec *) v1;
2867 const struct sortvec *s2 = (const struct sortvec *) v2;
2868 if (s1->priority != s2->priority)
2869 return s1->priority < s2->priority ? -1 : 1;
2870 if (s1->beg != s2->beg)
2871 return s1->beg < s2->beg ? -1 : 1;
2872 if (s1->end != s2->end)
2873 return s2->end < s1->end ? -1 : 1;
2874 return 0;
2877 /* Sort an array of overlays by priority. The array is modified in place.
2878 The return value is the new size; this may be smaller than the original
2879 size if some of the overlays were invalid or were window-specific. */
2880 ptrdiff_t
2881 sort_overlays (Lisp_Object *overlay_vec, ptrdiff_t noverlays, struct window *w)
2883 ptrdiff_t i, j;
2884 struct sortvec *sortvec;
2885 sortvec = (struct sortvec *) alloca (noverlays * sizeof (struct sortvec));
2887 /* Put the valid and relevant overlays into sortvec. */
2889 for (i = 0, j = 0; i < noverlays; i++)
2891 Lisp_Object tem;
2892 Lisp_Object overlay;
2894 overlay = overlay_vec[i];
2895 if (OVERLAY_VALID (overlay)
2896 && OVERLAY_POSITION (OVERLAY_START (overlay)) > 0
2897 && OVERLAY_POSITION (OVERLAY_END (overlay)) > 0)
2899 /* If we're interested in a specific window, then ignore
2900 overlays that are limited to some other window. */
2901 if (w)
2903 Lisp_Object window;
2905 window = Foverlay_get (overlay, Qwindow);
2906 if (WINDOWP (window) && XWINDOW (window) != w)
2907 continue;
2910 /* This overlay is good and counts: put it into sortvec. */
2911 sortvec[j].overlay = overlay;
2912 sortvec[j].beg = OVERLAY_POSITION (OVERLAY_START (overlay));
2913 sortvec[j].end = OVERLAY_POSITION (OVERLAY_END (overlay));
2914 tem = Foverlay_get (overlay, Qpriority);
2915 if (INTEGERP (tem))
2916 sortvec[j].priority = XINT (tem);
2917 else
2918 sortvec[j].priority = 0;
2919 j++;
2922 noverlays = j;
2924 /* Sort the overlays into the proper order: increasing priority. */
2926 if (noverlays > 1)
2927 qsort (sortvec, noverlays, sizeof (struct sortvec), compare_overlays);
2929 for (i = 0; i < noverlays; i++)
2930 overlay_vec[i] = sortvec[i].overlay;
2931 return (noverlays);
2934 struct sortstr
2936 Lisp_Object string, string2;
2937 ptrdiff_t size;
2938 EMACS_INT priority;
2941 struct sortstrlist
2943 struct sortstr *buf; /* An array that expands as needed; never freed. */
2944 ptrdiff_t size; /* Allocated length of that array. */
2945 ptrdiff_t used; /* How much of the array is currently in use. */
2946 EMACS_INT bytes; /* Total length of the strings in buf. */
2949 /* Buffers for storing information about the overlays touching a given
2950 position. These could be automatic variables in overlay_strings, but
2951 it's more efficient to hold onto the memory instead of repeatedly
2952 allocating and freeing it. */
2953 static struct sortstrlist overlay_heads, overlay_tails;
2954 static unsigned char *overlay_str_buf;
2956 /* Allocated length of overlay_str_buf. */
2957 static EMACS_INT overlay_str_len;
2959 /* A comparison function suitable for passing to qsort. */
2960 static int
2961 cmp_for_strings (const void *as1, const void *as2)
2963 struct sortstr *s1 = (struct sortstr *)as1;
2964 struct sortstr *s2 = (struct sortstr *)as2;
2965 if (s1->size != s2->size)
2966 return s2->size < s1->size ? -1 : 1;
2967 if (s1->priority != s2->priority)
2968 return s1->priority < s2->priority ? -1 : 1;
2969 return 0;
2972 static void
2973 record_overlay_string (struct sortstrlist *ssl, Lisp_Object str,
2974 Lisp_Object str2, Lisp_Object pri, ptrdiff_t size)
2976 EMACS_INT nbytes;
2978 if (ssl->used == ssl->size)
2980 if (min (PTRDIFF_MAX, SIZE_MAX) / (sizeof (struct sortstr) * 2)
2981 < ssl->size)
2982 memory_full (SIZE_MAX);
2983 else if (0 < ssl->size)
2984 ssl->size *= 2;
2985 else
2986 ssl->size = 5;
2987 ssl->buf = ((struct sortstr *)
2988 xrealloc (ssl->buf, ssl->size * sizeof (struct sortstr)));
2990 ssl->buf[ssl->used].string = str;
2991 ssl->buf[ssl->used].string2 = str2;
2992 ssl->buf[ssl->used].size = size;
2993 ssl->buf[ssl->used].priority = (INTEGERP (pri) ? XINT (pri) : 0);
2994 ssl->used++;
2996 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
2997 nbytes = SCHARS (str);
2998 else if (! STRING_MULTIBYTE (str))
2999 nbytes = count_size_as_multibyte (SDATA (str),
3000 SBYTES (str));
3001 else
3002 nbytes = SBYTES (str);
3004 ssl->bytes += nbytes;
3006 if (STRINGP (str2))
3008 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
3009 nbytes = SCHARS (str2);
3010 else if (! STRING_MULTIBYTE (str2))
3011 nbytes = count_size_as_multibyte (SDATA (str2),
3012 SBYTES (str2));
3013 else
3014 nbytes = SBYTES (str2);
3016 ssl->bytes += nbytes;
3020 /* Return the concatenation of the strings associated with overlays that
3021 begin or end at POS, ignoring overlays that are specific to a window
3022 other than W. The strings are concatenated in the appropriate order:
3023 shorter overlays nest inside longer ones, and higher priority inside
3024 lower. Normally all of the after-strings come first, but zero-sized
3025 overlays have their after-strings ride along with the before-strings
3026 because it would look strange to print them inside-out.
3028 Returns the string length, and stores the contents indirectly through
3029 PSTR, if that variable is non-null. The string may be overwritten by
3030 subsequent calls. */
3032 EMACS_INT
3033 overlay_strings (EMACS_INT pos, struct window *w, unsigned char **pstr)
3035 Lisp_Object overlay, window, str;
3036 struct Lisp_Overlay *ov;
3037 EMACS_INT startpos, endpos;
3038 int multibyte = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
3040 overlay_heads.used = overlay_heads.bytes = 0;
3041 overlay_tails.used = overlay_tails.bytes = 0;
3042 for (ov = current_buffer->overlays_before; ov; ov = ov->next)
3044 XSETMISC (overlay, ov);
3045 eassert (OVERLAYP (overlay));
3047 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3048 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3049 if (endpos < pos)
3050 break;
3051 if (endpos != pos && startpos != pos)
3052 continue;
3053 window = Foverlay_get (overlay, Qwindow);
3054 if (WINDOWP (window) && XWINDOW (window) != w)
3055 continue;
3056 if (startpos == pos
3057 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3058 record_overlay_string (&overlay_heads, str,
3059 (startpos == endpos
3060 ? Foverlay_get (overlay, Qafter_string)
3061 : Qnil),
3062 Foverlay_get (overlay, Qpriority),
3063 endpos - startpos);
3064 else if (endpos == pos
3065 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3066 record_overlay_string (&overlay_tails, str, Qnil,
3067 Foverlay_get (overlay, Qpriority),
3068 endpos - startpos);
3070 for (ov = current_buffer->overlays_after; ov; ov = ov->next)
3072 XSETMISC (overlay, ov);
3073 eassert (OVERLAYP (overlay));
3075 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3076 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3077 if (startpos > pos)
3078 break;
3079 if (endpos != pos && startpos != pos)
3080 continue;
3081 window = Foverlay_get (overlay, Qwindow);
3082 if (WINDOWP (window) && XWINDOW (window) != w)
3083 continue;
3084 if (startpos == pos
3085 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3086 record_overlay_string (&overlay_heads, str,
3087 (startpos == endpos
3088 ? Foverlay_get (overlay, Qafter_string)
3089 : Qnil),
3090 Foverlay_get (overlay, Qpriority),
3091 endpos - startpos);
3092 else if (endpos == pos
3093 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3094 record_overlay_string (&overlay_tails, str, Qnil,
3095 Foverlay_get (overlay, Qpriority),
3096 endpos - startpos);
3098 if (overlay_tails.used > 1)
3099 qsort (overlay_tails.buf, overlay_tails.used, sizeof (struct sortstr),
3100 cmp_for_strings);
3101 if (overlay_heads.used > 1)
3102 qsort (overlay_heads.buf, overlay_heads.used, sizeof (struct sortstr),
3103 cmp_for_strings);
3104 if (overlay_heads.bytes || overlay_tails.bytes)
3106 Lisp_Object tem;
3107 EMACS_INT i;
3108 unsigned char *p;
3109 EMACS_INT total = overlay_heads.bytes + overlay_tails.bytes;
3111 if (total > overlay_str_len)
3113 overlay_str_len = total;
3114 overlay_str_buf = (unsigned char *)xrealloc (overlay_str_buf,
3115 total);
3117 p = overlay_str_buf;
3118 for (i = overlay_tails.used; --i >= 0;)
3120 EMACS_INT nbytes;
3121 tem = overlay_tails.buf[i].string;
3122 nbytes = copy_text (SDATA (tem), p,
3123 SBYTES (tem),
3124 STRING_MULTIBYTE (tem), multibyte);
3125 p += nbytes;
3127 for (i = 0; i < overlay_heads.used; ++i)
3129 EMACS_INT nbytes;
3130 tem = overlay_heads.buf[i].string;
3131 nbytes = copy_text (SDATA (tem), p,
3132 SBYTES (tem),
3133 STRING_MULTIBYTE (tem), multibyte);
3134 p += nbytes;
3135 tem = overlay_heads.buf[i].string2;
3136 if (STRINGP (tem))
3138 nbytes = copy_text (SDATA (tem), p,
3139 SBYTES (tem),
3140 STRING_MULTIBYTE (tem), multibyte);
3141 p += nbytes;
3144 if (p != overlay_str_buf + total)
3145 abort ();
3146 if (pstr)
3147 *pstr = overlay_str_buf;
3148 return total;
3150 return 0;
3153 /* Shift overlays in BUF's overlay lists, to center the lists at POS. */
3155 void
3156 recenter_overlay_lists (struct buffer *buf, EMACS_INT pos)
3158 Lisp_Object overlay, beg, end;
3159 struct Lisp_Overlay *prev, *tail, *next;
3161 /* See if anything in overlays_before should move to overlays_after. */
3163 /* We don't strictly need prev in this loop; it should always be nil.
3164 But we use it for symmetry and in case that should cease to be true
3165 with some future change. */
3166 prev = NULL;
3167 for (tail = buf->overlays_before; tail; prev = tail, tail = next)
3169 next = tail->next;
3170 XSETMISC (overlay, tail);
3172 /* If the overlay is not valid, get rid of it. */
3173 if (!OVERLAY_VALID (overlay))
3174 #if 1
3175 abort ();
3176 #else
3178 /* Splice the cons cell TAIL out of overlays_before. */
3179 if (!NILP (prev))
3180 XCDR (prev) = next;
3181 else
3182 buf->overlays_before = next;
3183 tail = prev;
3184 continue;
3186 #endif
3188 beg = OVERLAY_START (overlay);
3189 end = OVERLAY_END (overlay);
3191 if (OVERLAY_POSITION (end) > pos)
3193 /* OVERLAY needs to be moved. */
3194 EMACS_INT where = OVERLAY_POSITION (beg);
3195 struct Lisp_Overlay *other, *other_prev;
3197 /* Splice the cons cell TAIL out of overlays_before. */
3198 if (prev)
3199 prev->next = next;
3200 else
3201 buf->overlays_before = next;
3203 /* Search thru overlays_after for where to put it. */
3204 other_prev = NULL;
3205 for (other = buf->overlays_after; other;
3206 other_prev = other, other = other->next)
3208 Lisp_Object otherbeg, otheroverlay;
3210 XSETMISC (otheroverlay, other);
3211 eassert (OVERLAY_VALID (otheroverlay));
3213 otherbeg = OVERLAY_START (otheroverlay);
3214 if (OVERLAY_POSITION (otherbeg) >= where)
3215 break;
3218 /* Add TAIL to overlays_after before OTHER. */
3219 tail->next = other;
3220 if (other_prev)
3221 other_prev->next = tail;
3222 else
3223 buf->overlays_after = tail;
3224 tail = prev;
3226 else
3227 /* We've reached the things that should stay in overlays_before.
3228 All the rest of overlays_before must end even earlier,
3229 so stop now. */
3230 break;
3233 /* See if anything in overlays_after should be in overlays_before. */
3234 prev = NULL;
3235 for (tail = buf->overlays_after; tail; prev = tail, tail = next)
3237 next = tail->next;
3238 XSETMISC (overlay, tail);
3240 /* If the overlay is not valid, get rid of it. */
3241 if (!OVERLAY_VALID (overlay))
3242 #if 1
3243 abort ();
3244 #else
3246 /* Splice the cons cell TAIL out of overlays_after. */
3247 if (!NILP (prev))
3248 XCDR (prev) = next;
3249 else
3250 buf->overlays_after = next;
3251 tail = prev;
3252 continue;
3254 #endif
3256 beg = OVERLAY_START (overlay);
3257 end = OVERLAY_END (overlay);
3259 /* Stop looking, when we know that nothing further
3260 can possibly end before POS. */
3261 if (OVERLAY_POSITION (beg) > pos)
3262 break;
3264 if (OVERLAY_POSITION (end) <= pos)
3266 /* OVERLAY needs to be moved. */
3267 EMACS_INT where = OVERLAY_POSITION (end);
3268 struct Lisp_Overlay *other, *other_prev;
3270 /* Splice the cons cell TAIL out of overlays_after. */
3271 if (prev)
3272 prev->next = next;
3273 else
3274 buf->overlays_after = next;
3276 /* Search thru overlays_before for where to put it. */
3277 other_prev = NULL;
3278 for (other = buf->overlays_before; other;
3279 other_prev = other, other = other->next)
3281 Lisp_Object otherend, otheroverlay;
3283 XSETMISC (otheroverlay, other);
3284 eassert (OVERLAY_VALID (otheroverlay));
3286 otherend = OVERLAY_END (otheroverlay);
3287 if (OVERLAY_POSITION (otherend) <= where)
3288 break;
3291 /* Add TAIL to overlays_before before OTHER. */
3292 tail->next = other;
3293 if (other_prev)
3294 other_prev->next = tail;
3295 else
3296 buf->overlays_before = tail;
3297 tail = prev;
3301 buf->overlay_center = pos;
3304 void
3305 adjust_overlays_for_insert (EMACS_INT pos, EMACS_INT length)
3307 /* After an insertion, the lists are still sorted properly,
3308 but we may need to update the value of the overlay center. */
3309 if (current_buffer->overlay_center >= pos)
3310 current_buffer->overlay_center += length;
3313 void
3314 adjust_overlays_for_delete (EMACS_INT pos, EMACS_INT length)
3316 if (current_buffer->overlay_center < pos)
3317 /* The deletion was to our right. No change needed; the before- and
3318 after-lists are still consistent. */
3320 else if (current_buffer->overlay_center > pos + length)
3321 /* The deletion was to our left. We need to adjust the center value
3322 to account for the change in position, but the lists are consistent
3323 given the new value. */
3324 current_buffer->overlay_center -= length;
3325 else
3326 /* We're right in the middle. There might be things on the after-list
3327 that now belong on the before-list. Recentering will move them,
3328 and also update the center point. */
3329 recenter_overlay_lists (current_buffer, pos);
3332 /* Fix up overlays that were garbled as a result of permuting markers
3333 in the range START through END. Any overlay with at least one
3334 endpoint in this range will need to be unlinked from the overlay
3335 list and reinserted in its proper place.
3336 Such an overlay might even have negative size at this point.
3337 If so, we'll make the overlay empty. */
3338 void
3339 fix_start_end_in_overlays (register EMACS_INT start, register EMACS_INT end)
3341 Lisp_Object overlay;
3342 struct Lisp_Overlay *before_list IF_LINT (= NULL);
3343 struct Lisp_Overlay *after_list IF_LINT (= NULL);
3344 /* These are either nil, indicating that before_list or after_list
3345 should be assigned, or the cons cell the cdr of which should be
3346 assigned. */
3347 struct Lisp_Overlay *beforep = NULL, *afterp = NULL;
3348 /* 'Parent', likewise, indicates a cons cell or
3349 current_buffer->overlays_before or overlays_after, depending
3350 which loop we're in. */
3351 struct Lisp_Overlay *tail, *parent;
3352 EMACS_INT startpos, endpos;
3354 /* This algorithm shifts links around instead of consing and GCing.
3355 The loop invariant is that before_list (resp. after_list) is a
3356 well-formed list except that its last element, the CDR of beforep
3357 (resp. afterp) if beforep (afterp) isn't nil or before_list
3358 (after_list) if it is, is still uninitialized. So it's not a bug
3359 that before_list isn't initialized, although it may look
3360 strange. */
3361 for (parent = NULL, tail = current_buffer->overlays_before; tail;)
3363 XSETMISC (overlay, tail);
3365 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3366 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3368 /* If the overlay is backwards, make it empty. */
3369 if (endpos < startpos)
3371 startpos = endpos;
3372 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3373 Qnil);
3376 if (endpos < start)
3377 break;
3379 if (endpos < end
3380 || (startpos >= start && startpos < end))
3382 /* Add it to the end of the wrong list. Later on,
3383 recenter_overlay_lists will move it to the right place. */
3384 if (endpos < current_buffer->overlay_center)
3386 if (!afterp)
3387 after_list = tail;
3388 else
3389 afterp->next = tail;
3390 afterp = tail;
3392 else
3394 if (!beforep)
3395 before_list = tail;
3396 else
3397 beforep->next = tail;
3398 beforep = tail;
3400 if (!parent)
3401 current_buffer->overlays_before = tail->next;
3402 else
3403 parent->next = tail->next;
3404 tail = tail->next;
3406 else
3407 parent = tail, tail = parent->next;
3409 for (parent = NULL, tail = current_buffer->overlays_after; tail;)
3411 XSETMISC (overlay, tail);
3413 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3414 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3416 /* If the overlay is backwards, make it empty. */
3417 if (endpos < startpos)
3419 startpos = endpos;
3420 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3421 Qnil);
3424 if (startpos >= end)
3425 break;
3427 if (startpos >= start
3428 || (endpos >= start && endpos < end))
3430 if (endpos < current_buffer->overlay_center)
3432 if (!afterp)
3433 after_list = tail;
3434 else
3435 afterp->next = tail;
3436 afterp = tail;
3438 else
3440 if (!beforep)
3441 before_list = tail;
3442 else
3443 beforep->next = tail;
3444 beforep = tail;
3446 if (!parent)
3447 current_buffer->overlays_after = tail->next;
3448 else
3449 parent->next = tail->next;
3450 tail = tail->next;
3452 else
3453 parent = tail, tail = parent->next;
3456 /* Splice the constructed (wrong) lists into the buffer's lists,
3457 and let the recenter function make it sane again. */
3458 if (beforep)
3460 beforep->next = current_buffer->overlays_before;
3461 current_buffer->overlays_before = before_list;
3463 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3465 if (afterp)
3467 afterp->next = current_buffer->overlays_after;
3468 current_buffer->overlays_after = after_list;
3470 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3473 /* We have two types of overlay: the one whose ending marker is
3474 after-insertion-marker (this is the usual case) and the one whose
3475 ending marker is before-insertion-marker. When `overlays_before'
3476 contains overlays of the latter type and the former type in this
3477 order and both overlays end at inserting position, inserting a text
3478 increases only the ending marker of the latter type, which results
3479 in incorrect ordering of `overlays_before'.
3481 This function fixes ordering of overlays in the slot
3482 `overlays_before' of the buffer *BP. Before the insertion, `point'
3483 was at PREV, and now is at POS. */
3485 void
3486 fix_overlays_before (struct buffer *bp, EMACS_INT prev, EMACS_INT pos)
3488 /* If parent is nil, replace overlays_before; otherwise, parent->next. */
3489 struct Lisp_Overlay *tail = bp->overlays_before, *parent = NULL, *right_pair;
3490 Lisp_Object tem;
3491 EMACS_INT end IF_LINT (= 0);
3493 /* After the insertion, the several overlays may be in incorrect
3494 order. The possibility is that, in the list `overlays_before',
3495 an overlay which ends at POS appears after an overlay which ends
3496 at PREV. Since POS is greater than PREV, we must fix the
3497 ordering of these overlays, by moving overlays ends at POS before
3498 the overlays ends at PREV. */
3500 /* At first, find a place where disordered overlays should be linked
3501 in. It is where an overlay which end before POS exists. (i.e. an
3502 overlay whose ending marker is after-insertion-marker if disorder
3503 exists). */
3504 while (tail
3505 && (XSETMISC (tem, tail),
3506 (end = OVERLAY_POSITION (OVERLAY_END (tem))) >= pos))
3508 parent = tail;
3509 tail = tail->next;
3512 /* If we don't find such an overlay,
3513 or the found one ends before PREV,
3514 or the found one is the last one in the list,
3515 we don't have to fix anything. */
3516 if (!tail || end < prev || !tail->next)
3517 return;
3519 right_pair = parent;
3520 parent = tail;
3521 tail = tail->next;
3523 /* Now, end position of overlays in the list TAIL should be before
3524 or equal to PREV. In the loop, an overlay which ends at POS is
3525 moved ahead to the place indicated by the CDR of RIGHT_PAIR. If
3526 we found an overlay which ends before PREV, the remaining
3527 overlays are in correct order. */
3528 while (tail)
3530 XSETMISC (tem, tail);
3531 end = OVERLAY_POSITION (OVERLAY_END (tem));
3533 if (end == pos)
3534 { /* This overlay is disordered. */
3535 struct Lisp_Overlay *found = tail;
3537 /* Unlink the found overlay. */
3538 tail = found->next;
3539 parent->next = tail;
3540 /* Move an overlay at RIGHT_PLACE to the next of the found one,
3541 and link it into the right place. */
3542 if (!right_pair)
3544 found->next = bp->overlays_before;
3545 bp->overlays_before = found;
3547 else
3549 found->next = right_pair->next;
3550 right_pair->next = found;
3553 else if (end == prev)
3555 parent = tail;
3556 tail = tail->next;
3558 else /* No more disordered overlay. */
3559 break;
3563 DEFUN ("overlayp", Foverlayp, Soverlayp, 1, 1, 0,
3564 doc: /* Return t if OBJECT is an overlay. */)
3565 (Lisp_Object object)
3567 return (OVERLAYP (object) ? Qt : Qnil);
3570 DEFUN ("make-overlay", Fmake_overlay, Smake_overlay, 2, 5, 0,
3571 doc: /* Create a new overlay with range BEG to END in BUFFER.
3572 If omitted, BUFFER defaults to the current buffer.
3573 BEG and END may be integers or markers.
3574 The fourth arg FRONT-ADVANCE, if non-nil, makes the marker
3575 for the front of the overlay advance when text is inserted there
3576 \(which means the text *is not* included in the overlay).
3577 The fifth arg REAR-ADVANCE, if non-nil, makes the marker
3578 for the rear of the overlay advance when text is inserted there
3579 \(which means the text *is* included in the overlay). */)
3580 (Lisp_Object beg, Lisp_Object end, Lisp_Object buffer, Lisp_Object front_advance, Lisp_Object rear_advance)
3582 Lisp_Object overlay;
3583 struct buffer *b;
3585 if (NILP (buffer))
3586 XSETBUFFER (buffer, current_buffer);
3587 else
3588 CHECK_BUFFER (buffer);
3589 if (MARKERP (beg)
3590 && ! EQ (Fmarker_buffer (beg), buffer))
3591 error ("Marker points into wrong buffer");
3592 if (MARKERP (end)
3593 && ! EQ (Fmarker_buffer (end), buffer))
3594 error ("Marker points into wrong buffer");
3596 CHECK_NUMBER_COERCE_MARKER (beg);
3597 CHECK_NUMBER_COERCE_MARKER (end);
3599 if (XINT (beg) > XINT (end))
3601 Lisp_Object temp;
3602 temp = beg; beg = end; end = temp;
3605 b = XBUFFER (buffer);
3607 beg = Fset_marker (Fmake_marker (), beg, buffer);
3608 end = Fset_marker (Fmake_marker (), end, buffer);
3610 if (!NILP (front_advance))
3611 XMARKER (beg)->insertion_type = 1;
3612 if (!NILP (rear_advance))
3613 XMARKER (end)->insertion_type = 1;
3615 overlay = allocate_misc ();
3616 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
3617 XOVERLAY (overlay)->start = beg;
3618 XOVERLAY (overlay)->end = end;
3619 XOVERLAY (overlay)->plist = Qnil;
3620 XOVERLAY (overlay)->next = NULL;
3622 /* Put the new overlay on the wrong list. */
3623 end = OVERLAY_END (overlay);
3624 if (OVERLAY_POSITION (end) < b->overlay_center)
3626 if (b->overlays_after)
3627 XOVERLAY (overlay)->next = b->overlays_after;
3628 b->overlays_after = XOVERLAY (overlay);
3630 else
3632 if (b->overlays_before)
3633 XOVERLAY (overlay)->next = b->overlays_before;
3634 b->overlays_before = XOVERLAY (overlay);
3637 /* This puts it in the right list, and in the right order. */
3638 recenter_overlay_lists (b, b->overlay_center);
3640 /* We don't need to redisplay the region covered by the overlay, because
3641 the overlay has no properties at the moment. */
3643 return overlay;
3646 /* Mark a section of BUF as needing redisplay because of overlays changes. */
3648 static void
3649 modify_overlay (struct buffer *buf, EMACS_INT start, EMACS_INT end)
3651 if (start > end)
3653 EMACS_INT temp = start;
3654 start = end;
3655 end = temp;
3658 BUF_COMPUTE_UNCHANGED (buf, start, end);
3660 /* If this is a buffer not in the selected window,
3661 we must do other windows. */
3662 if (buf != XBUFFER (XWINDOW (selected_window)->buffer))
3663 windows_or_buffers_changed = 1;
3664 /* If multiple windows show this buffer, we must do other windows. */
3665 else if (buffer_shared > 1)
3666 windows_or_buffers_changed = 1;
3667 /* If we modify an overlay at the end of the buffer, we cannot
3668 be sure that window end is still valid. */
3669 else if (end >= ZV && start <= ZV)
3670 windows_or_buffers_changed = 1;
3672 ++BUF_OVERLAY_MODIFF (buf);
3676 static struct Lisp_Overlay *
3677 unchain_overlay (struct Lisp_Overlay *list, struct Lisp_Overlay *overlay)
3679 struct Lisp_Overlay *tmp, *prev;
3680 for (tmp = list, prev = NULL; tmp; prev = tmp, tmp = tmp->next)
3681 if (tmp == overlay)
3683 if (prev)
3684 prev->next = tmp->next;
3685 else
3686 list = tmp->next;
3687 overlay->next = NULL;
3688 break;
3690 return list;
3693 DEFUN ("move-overlay", Fmove_overlay, Smove_overlay, 3, 4, 0,
3694 doc: /* Set the endpoints of OVERLAY to BEG and END in BUFFER.
3695 If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.
3696 If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current
3697 buffer. */)
3698 (Lisp_Object overlay, Lisp_Object beg, Lisp_Object end, Lisp_Object buffer)
3700 struct buffer *b, *ob;
3701 Lisp_Object obuffer;
3702 int count = SPECPDL_INDEX ();
3704 CHECK_OVERLAY (overlay);
3705 if (NILP (buffer))
3706 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3707 if (NILP (buffer))
3708 XSETBUFFER (buffer, current_buffer);
3709 CHECK_BUFFER (buffer);
3711 if (MARKERP (beg)
3712 && ! EQ (Fmarker_buffer (beg), buffer))
3713 error ("Marker points into wrong buffer");
3714 if (MARKERP (end)
3715 && ! EQ (Fmarker_buffer (end), buffer))
3716 error ("Marker points into wrong buffer");
3718 CHECK_NUMBER_COERCE_MARKER (beg);
3719 CHECK_NUMBER_COERCE_MARKER (end);
3721 if (XINT (beg) == XINT (end) && ! NILP (Foverlay_get (overlay, Qevaporate)))
3722 return Fdelete_overlay (overlay);
3724 if (XINT (beg) > XINT (end))
3726 Lisp_Object temp;
3727 temp = beg; beg = end; end = temp;
3730 specbind (Qinhibit_quit, Qt);
3732 obuffer = Fmarker_buffer (OVERLAY_START (overlay));
3733 b = XBUFFER (buffer);
3734 ob = BUFFERP (obuffer) ? XBUFFER (obuffer) : (struct buffer *) 0;
3736 /* If the overlay has changed buffers, do a thorough redisplay. */
3737 if (!EQ (buffer, obuffer))
3739 /* Redisplay where the overlay was. */
3740 if (!NILP (obuffer))
3742 EMACS_INT o_beg;
3743 EMACS_INT o_end;
3745 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3746 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3748 modify_overlay (ob, o_beg, o_end);
3751 /* Redisplay where the overlay is going to be. */
3752 modify_overlay (b, XINT (beg), XINT (end));
3754 else
3755 /* Redisplay the area the overlay has just left, or just enclosed. */
3757 EMACS_INT o_beg, o_end;
3759 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3760 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3762 if (o_beg == XINT (beg))
3763 modify_overlay (b, o_end, XINT (end));
3764 else if (o_end == XINT (end))
3765 modify_overlay (b, o_beg, XINT (beg));
3766 else
3768 if (XINT (beg) < o_beg) o_beg = XINT (beg);
3769 if (XINT (end) > o_end) o_end = XINT (end);
3770 modify_overlay (b, o_beg, o_end);
3774 if (!NILP (obuffer))
3776 ob->overlays_before
3777 = unchain_overlay (ob->overlays_before, XOVERLAY (overlay));
3778 ob->overlays_after
3779 = unchain_overlay (ob->overlays_after, XOVERLAY (overlay));
3780 eassert (XOVERLAY (overlay)->next == NULL);
3783 Fset_marker (OVERLAY_START (overlay), beg, buffer);
3784 Fset_marker (OVERLAY_END (overlay), end, buffer);
3786 /* Put the overlay on the wrong list. */
3787 end = OVERLAY_END (overlay);
3788 if (OVERLAY_POSITION (end) < b->overlay_center)
3790 XOVERLAY (overlay)->next = b->overlays_after;
3791 b->overlays_after = XOVERLAY (overlay);
3793 else
3795 XOVERLAY (overlay)->next = b->overlays_before;
3796 b->overlays_before = XOVERLAY (overlay);
3799 /* This puts it in the right list, and in the right order. */
3800 recenter_overlay_lists (b, b->overlay_center);
3802 return unbind_to (count, overlay);
3805 DEFUN ("delete-overlay", Fdelete_overlay, Sdelete_overlay, 1, 1, 0,
3806 doc: /* Delete the overlay OVERLAY from its buffer. */)
3807 (Lisp_Object overlay)
3809 Lisp_Object buffer;
3810 struct buffer *b;
3811 int count = SPECPDL_INDEX ();
3813 CHECK_OVERLAY (overlay);
3815 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3816 if (NILP (buffer))
3817 return Qnil;
3819 b = XBUFFER (buffer);
3820 specbind (Qinhibit_quit, Qt);
3822 b->overlays_before = unchain_overlay (b->overlays_before,XOVERLAY (overlay));
3823 b->overlays_after = unchain_overlay (b->overlays_after, XOVERLAY (overlay));
3824 eassert (XOVERLAY (overlay)->next == NULL);
3825 modify_overlay (b,
3826 marker_position (OVERLAY_START (overlay)),
3827 marker_position (OVERLAY_END (overlay)));
3828 Fset_marker (OVERLAY_START (overlay), Qnil, Qnil);
3829 Fset_marker (OVERLAY_END (overlay), Qnil, Qnil);
3831 /* When deleting an overlay with before or after strings, turn off
3832 display optimizations for the affected buffer, on the basis that
3833 these strings may contain newlines. This is easier to do than to
3834 check for that situation during redisplay. */
3835 if (!windows_or_buffers_changed
3836 && (!NILP (Foverlay_get (overlay, Qbefore_string))
3837 || !NILP (Foverlay_get (overlay, Qafter_string))))
3838 b->prevent_redisplay_optimizations_p = 1;
3840 return unbind_to (count, Qnil);
3843 /* Overlay dissection functions. */
3845 DEFUN ("overlay-start", Foverlay_start, Soverlay_start, 1, 1, 0,
3846 doc: /* Return the position at which OVERLAY starts. */)
3847 (Lisp_Object overlay)
3849 CHECK_OVERLAY (overlay);
3851 return (Fmarker_position (OVERLAY_START (overlay)));
3854 DEFUN ("overlay-end", Foverlay_end, Soverlay_end, 1, 1, 0,
3855 doc: /* Return the position at which OVERLAY ends. */)
3856 (Lisp_Object overlay)
3858 CHECK_OVERLAY (overlay);
3860 return (Fmarker_position (OVERLAY_END (overlay)));
3863 DEFUN ("overlay-buffer", Foverlay_buffer, Soverlay_buffer, 1, 1, 0,
3864 doc: /* Return the buffer OVERLAY belongs to.
3865 Return nil if OVERLAY has been deleted. */)
3866 (Lisp_Object overlay)
3868 CHECK_OVERLAY (overlay);
3870 return Fmarker_buffer (OVERLAY_START (overlay));
3873 DEFUN ("overlay-properties", Foverlay_properties, Soverlay_properties, 1, 1, 0,
3874 doc: /* Return a list of the properties on OVERLAY.
3875 This is a copy of OVERLAY's plist; modifying its conses has no effect on
3876 OVERLAY. */)
3877 (Lisp_Object overlay)
3879 CHECK_OVERLAY (overlay);
3881 return Fcopy_sequence (XOVERLAY (overlay)->plist);
3885 DEFUN ("overlays-at", Foverlays_at, Soverlays_at, 1, 1, 0,
3886 doc: /* Return a list of the overlays that contain the character at POS. */)
3887 (Lisp_Object pos)
3889 ptrdiff_t len, noverlays;
3890 Lisp_Object *overlay_vec;
3891 Lisp_Object result;
3893 CHECK_NUMBER_COERCE_MARKER (pos);
3895 len = 10;
3896 /* We can't use alloca here because overlays_at can call xrealloc. */
3897 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3899 /* Put all the overlays we want in a vector in overlay_vec.
3900 Store the length in len. */
3901 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3902 (EMACS_INT *) 0, (EMACS_INT *) 0, 0);
3904 /* Make a list of them all. */
3905 result = Flist (noverlays, overlay_vec);
3907 xfree (overlay_vec);
3908 return result;
3911 DEFUN ("overlays-in", Foverlays_in, Soverlays_in, 2, 2, 0,
3912 doc: /* Return a list of the overlays that overlap the region BEG ... END.
3913 Overlap means that at least one character is contained within the overlay
3914 and also contained within the specified region.
3915 Empty overlays are included in the result if they are located at BEG,
3916 between BEG and END, or at END provided END denotes the position at the
3917 end of the buffer. */)
3918 (Lisp_Object beg, Lisp_Object end)
3920 ptrdiff_t len, noverlays;
3921 Lisp_Object *overlay_vec;
3922 Lisp_Object result;
3924 CHECK_NUMBER_COERCE_MARKER (beg);
3925 CHECK_NUMBER_COERCE_MARKER (end);
3927 len = 10;
3928 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3930 /* Put all the overlays we want in a vector in overlay_vec.
3931 Store the length in len. */
3932 noverlays = overlays_in (XINT (beg), XINT (end), 1, &overlay_vec, &len,
3933 NULL, NULL);
3935 /* Make a list of them all. */
3936 result = Flist (noverlays, overlay_vec);
3938 xfree (overlay_vec);
3939 return result;
3942 DEFUN ("next-overlay-change", Fnext_overlay_change, Snext_overlay_change,
3943 1, 1, 0,
3944 doc: /* Return the next position after POS where an overlay starts or ends.
3945 If there are no overlay boundaries from POS to (point-max),
3946 the value is (point-max). */)
3947 (Lisp_Object pos)
3949 ptrdiff_t i, len, noverlays;
3950 EMACS_INT endpos;
3951 Lisp_Object *overlay_vec;
3953 CHECK_NUMBER_COERCE_MARKER (pos);
3955 len = 10;
3956 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3958 /* Put all the overlays we want in a vector in overlay_vec.
3959 Store the length in len.
3960 endpos gets the position where the next overlay starts. */
3961 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3962 &endpos, (EMACS_INT *) 0, 1);
3964 /* If any of these overlays ends before endpos,
3965 use its ending point instead. */
3966 for (i = 0; i < noverlays; i++)
3968 Lisp_Object oend;
3969 EMACS_INT oendpos;
3971 oend = OVERLAY_END (overlay_vec[i]);
3972 oendpos = OVERLAY_POSITION (oend);
3973 if (oendpos < endpos)
3974 endpos = oendpos;
3977 xfree (overlay_vec);
3978 return make_number (endpos);
3981 DEFUN ("previous-overlay-change", Fprevious_overlay_change,
3982 Sprevious_overlay_change, 1, 1, 0,
3983 doc: /* Return the previous position before POS where an overlay starts or ends.
3984 If there are no overlay boundaries from (point-min) to POS,
3985 the value is (point-min). */)
3986 (Lisp_Object pos)
3988 EMACS_INT prevpos;
3989 Lisp_Object *overlay_vec;
3990 ptrdiff_t len;
3992 CHECK_NUMBER_COERCE_MARKER (pos);
3994 /* At beginning of buffer, we know the answer;
3995 avoid bug subtracting 1 below. */
3996 if (XINT (pos) == BEGV)
3997 return pos;
3999 len = 10;
4000 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
4002 /* Put all the overlays we want in a vector in overlay_vec.
4003 Store the length in len.
4004 prevpos gets the position of the previous change. */
4005 overlays_at (XINT (pos), 1, &overlay_vec, &len,
4006 (EMACS_INT *) 0, &prevpos, 1);
4008 xfree (overlay_vec);
4009 return make_number (prevpos);
4012 /* These functions are for debugging overlays. */
4014 DEFUN ("overlay-lists", Foverlay_lists, Soverlay_lists, 0, 0, 0,
4015 doc: /* Return a pair of lists giving all the overlays of the current buffer.
4016 The car has all the overlays before the overlay center;
4017 the cdr has all the overlays after the overlay center.
4018 Recentering overlays moves overlays between these lists.
4019 The lists you get are copies, so that changing them has no effect.
4020 However, the overlays you get are the real objects that the buffer uses. */)
4021 (void)
4023 struct Lisp_Overlay *ol;
4024 Lisp_Object before = Qnil, after = Qnil, tmp;
4025 for (ol = current_buffer->overlays_before; ol; ol = ol->next)
4027 XSETMISC (tmp, ol);
4028 before = Fcons (tmp, before);
4030 for (ol = current_buffer->overlays_after; ol; ol = ol->next)
4032 XSETMISC (tmp, ol);
4033 after = Fcons (tmp, after);
4035 return Fcons (Fnreverse (before), Fnreverse (after));
4038 DEFUN ("overlay-recenter", Foverlay_recenter, Soverlay_recenter, 1, 1, 0,
4039 doc: /* Recenter the overlays of the current buffer around position POS.
4040 That makes overlay lookup faster for positions near POS (but perhaps slower
4041 for positions far away from POS). */)
4042 (Lisp_Object pos)
4044 CHECK_NUMBER_COERCE_MARKER (pos);
4046 recenter_overlay_lists (current_buffer, XINT (pos));
4047 return Qnil;
4050 DEFUN ("overlay-get", Foverlay_get, Soverlay_get, 2, 2, 0,
4051 doc: /* Get the property of overlay OVERLAY with property name PROP. */)
4052 (Lisp_Object overlay, Lisp_Object prop)
4054 CHECK_OVERLAY (overlay);
4055 return lookup_char_property (XOVERLAY (overlay)->plist, prop, 0);
4058 DEFUN ("overlay-put", Foverlay_put, Soverlay_put, 3, 3, 0,
4059 doc: /* Set one property of overlay OVERLAY: give property PROP value VALUE.
4060 VALUE will be returned.*/)
4061 (Lisp_Object overlay, Lisp_Object prop, Lisp_Object value)
4063 Lisp_Object tail, buffer;
4064 int changed;
4066 CHECK_OVERLAY (overlay);
4068 buffer = Fmarker_buffer (OVERLAY_START (overlay));
4070 for (tail = XOVERLAY (overlay)->plist;
4071 CONSP (tail) && CONSP (XCDR (tail));
4072 tail = XCDR (XCDR (tail)))
4073 if (EQ (XCAR (tail), prop))
4075 changed = !EQ (XCAR (XCDR (tail)), value);
4076 XSETCAR (XCDR (tail), value);
4077 goto found;
4079 /* It wasn't in the list, so add it to the front. */
4080 changed = !NILP (value);
4081 XOVERLAY (overlay)->plist
4082 = Fcons (prop, Fcons (value, XOVERLAY (overlay)->plist));
4083 found:
4084 if (! NILP (buffer))
4086 if (changed)
4087 modify_overlay (XBUFFER (buffer),
4088 marker_position (OVERLAY_START (overlay)),
4089 marker_position (OVERLAY_END (overlay)));
4090 if (EQ (prop, Qevaporate) && ! NILP (value)
4091 && (OVERLAY_POSITION (OVERLAY_START (overlay))
4092 == OVERLAY_POSITION (OVERLAY_END (overlay))))
4093 Fdelete_overlay (overlay);
4096 return value;
4099 /* Subroutine of report_overlay_modification. */
4101 /* Lisp vector holding overlay hook functions to call.
4102 Vector elements come in pairs.
4103 Each even-index element is a list of hook functions.
4104 The following odd-index element is the overlay they came from.
4106 Before the buffer change, we fill in this vector
4107 as we call overlay hook functions.
4108 After the buffer change, we get the functions to call from this vector.
4109 This way we always call the same functions before and after the change. */
4110 static Lisp_Object last_overlay_modification_hooks;
4112 /* Number of elements actually used in last_overlay_modification_hooks. */
4113 static int last_overlay_modification_hooks_used;
4115 /* Add one functionlist/overlay pair
4116 to the end of last_overlay_modification_hooks. */
4118 static void
4119 add_overlay_mod_hooklist (Lisp_Object functionlist, Lisp_Object overlay)
4121 int oldsize = ASIZE (last_overlay_modification_hooks);
4123 if (last_overlay_modification_hooks_used == oldsize)
4124 last_overlay_modification_hooks = larger_vector
4125 (last_overlay_modification_hooks, oldsize * 2, Qnil);
4126 ASET (last_overlay_modification_hooks, last_overlay_modification_hooks_used,
4127 functionlist); last_overlay_modification_hooks_used++;
4128 ASET (last_overlay_modification_hooks, last_overlay_modification_hooks_used,
4129 overlay); last_overlay_modification_hooks_used++;
4132 /* Run the modification-hooks of overlays that include
4133 any part of the text in START to END.
4134 If this change is an insertion, also
4135 run the insert-before-hooks of overlay starting at END,
4136 and the insert-after-hooks of overlay ending at START.
4138 This is called both before and after the modification.
4139 AFTER is nonzero when we call after the modification.
4141 ARG1, ARG2, ARG3 are arguments to pass to the hook functions.
4142 When AFTER is nonzero, they are the start position,
4143 the position after the inserted new text,
4144 and the length of deleted or replaced old text. */
4146 void
4147 report_overlay_modification (Lisp_Object start, Lisp_Object end, int after,
4148 Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3)
4150 Lisp_Object prop, overlay;
4151 struct Lisp_Overlay *tail;
4152 /* 1 if this change is an insertion. */
4153 int insertion = (after ? XFASTINT (arg3) == 0 : EQ (start, end));
4154 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4156 overlay = Qnil;
4157 tail = NULL;
4159 /* We used to run the functions as soon as we found them and only register
4160 them in last_overlay_modification_hooks for the purpose of the `after'
4161 case. But running elisp code as we traverse the list of overlays is
4162 painful because the list can be modified by the elisp code so we had to
4163 copy at several places. We now simply do a read-only traversal that
4164 only collects the functions to run and we run them afterwards. It's
4165 simpler, especially since all the code was already there. -stef */
4167 if (!after)
4169 /* We are being called before a change.
4170 Scan the overlays to find the functions to call. */
4171 last_overlay_modification_hooks_used = 0;
4172 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4174 EMACS_INT startpos, endpos;
4175 Lisp_Object ostart, oend;
4177 XSETMISC (overlay, tail);
4179 ostart = OVERLAY_START (overlay);
4180 oend = OVERLAY_END (overlay);
4181 endpos = OVERLAY_POSITION (oend);
4182 if (XFASTINT (start) > endpos)
4183 break;
4184 startpos = OVERLAY_POSITION (ostart);
4185 if (insertion && (XFASTINT (start) == startpos
4186 || XFASTINT (end) == startpos))
4188 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4189 if (!NILP (prop))
4190 add_overlay_mod_hooklist (prop, overlay);
4192 if (insertion && (XFASTINT (start) == endpos
4193 || XFASTINT (end) == endpos))
4195 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4196 if (!NILP (prop))
4197 add_overlay_mod_hooklist (prop, overlay);
4199 /* Test for intersecting intervals. This does the right thing
4200 for both insertion and deletion. */
4201 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4203 prop = Foverlay_get (overlay, Qmodification_hooks);
4204 if (!NILP (prop))
4205 add_overlay_mod_hooklist (prop, overlay);
4209 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4211 EMACS_INT startpos, endpos;
4212 Lisp_Object ostart, oend;
4214 XSETMISC (overlay, tail);
4216 ostart = OVERLAY_START (overlay);
4217 oend = OVERLAY_END (overlay);
4218 startpos = OVERLAY_POSITION (ostart);
4219 endpos = OVERLAY_POSITION (oend);
4220 if (XFASTINT (end) < startpos)
4221 break;
4222 if (insertion && (XFASTINT (start) == startpos
4223 || XFASTINT (end) == startpos))
4225 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4226 if (!NILP (prop))
4227 add_overlay_mod_hooklist (prop, overlay);
4229 if (insertion && (XFASTINT (start) == endpos
4230 || XFASTINT (end) == endpos))
4232 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4233 if (!NILP (prop))
4234 add_overlay_mod_hooklist (prop, overlay);
4236 /* Test for intersecting intervals. This does the right thing
4237 for both insertion and deletion. */
4238 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4240 prop = Foverlay_get (overlay, Qmodification_hooks);
4241 if (!NILP (prop))
4242 add_overlay_mod_hooklist (prop, overlay);
4247 GCPRO4 (overlay, arg1, arg2, arg3);
4249 /* Call the functions recorded in last_overlay_modification_hooks.
4250 First copy the vector contents, in case some of these hooks
4251 do subsequent modification of the buffer. */
4252 int size = last_overlay_modification_hooks_used;
4253 Lisp_Object *copy = (Lisp_Object *) alloca (size * sizeof (Lisp_Object));
4254 int i;
4256 memcpy (copy, XVECTOR (last_overlay_modification_hooks)->contents,
4257 size * sizeof (Lisp_Object));
4258 gcpro1.var = copy;
4259 gcpro1.nvars = size;
4261 for (i = 0; i < size;)
4263 Lisp_Object prop_i, overlay_i;
4264 prop_i = copy[i++];
4265 overlay_i = copy[i++];
4266 call_overlay_mod_hooks (prop_i, overlay_i, after, arg1, arg2, arg3);
4269 UNGCPRO;
4272 static void
4273 call_overlay_mod_hooks (Lisp_Object list, Lisp_Object overlay, int after,
4274 Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3)
4276 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4278 GCPRO4 (list, arg1, arg2, arg3);
4280 while (CONSP (list))
4282 if (NILP (arg3))
4283 call4 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2);
4284 else
4285 call5 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2, arg3);
4286 list = XCDR (list);
4288 UNGCPRO;
4291 /* Delete any zero-sized overlays at position POS, if the `evaporate'
4292 property is set. */
4293 void
4294 evaporate_overlays (EMACS_INT pos)
4296 Lisp_Object overlay, hit_list;
4297 struct Lisp_Overlay *tail;
4299 hit_list = Qnil;
4300 if (pos <= current_buffer->overlay_center)
4301 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4303 EMACS_INT endpos;
4304 XSETMISC (overlay, tail);
4305 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
4306 if (endpos < pos)
4307 break;
4308 if (endpos == pos && OVERLAY_POSITION (OVERLAY_START (overlay)) == pos
4309 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4310 hit_list = Fcons (overlay, hit_list);
4312 else
4313 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4315 EMACS_INT startpos;
4316 XSETMISC (overlay, tail);
4317 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
4318 if (startpos > pos)
4319 break;
4320 if (startpos == pos && OVERLAY_POSITION (OVERLAY_END (overlay)) == pos
4321 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4322 hit_list = Fcons (overlay, hit_list);
4324 for (; CONSP (hit_list); hit_list = XCDR (hit_list))
4325 Fdelete_overlay (XCAR (hit_list));
4328 /* Somebody has tried to store a value with an unacceptable type
4329 in the slot with offset OFFSET. */
4331 void
4332 buffer_slot_type_mismatch (Lisp_Object newval, int type)
4334 Lisp_Object predicate;
4336 switch (type)
4338 case_Lisp_Int: predicate = Qintegerp; break;
4339 case Lisp_String: predicate = Qstringp; break;
4340 case Lisp_Symbol: predicate = Qsymbolp; break;
4341 default: abort ();
4344 wrong_type_argument (predicate, newval);
4348 /***********************************************************************
4349 Allocation with mmap
4350 ***********************************************************************/
4352 #ifdef USE_MMAP_FOR_BUFFERS
4354 #include <sys/types.h>
4355 #include <sys/mman.h>
4357 #ifndef MAP_ANON
4358 #ifdef MAP_ANONYMOUS
4359 #define MAP_ANON MAP_ANONYMOUS
4360 #else
4361 #define MAP_ANON 0
4362 #endif
4363 #endif
4365 #ifndef MAP_FAILED
4366 #define MAP_FAILED ((void *) -1)
4367 #endif
4369 #include <stdio.h>
4371 #if MAP_ANON == 0
4372 #include <fcntl.h>
4373 #endif
4375 #include "coding.h"
4378 /* Memory is allocated in regions which are mapped using mmap(2).
4379 The current implementation lets the system select mapped
4380 addresses; we're not using MAP_FIXED in general, except when
4381 trying to enlarge regions.
4383 Each mapped region starts with a mmap_region structure, the user
4384 area starts after that structure, aligned to MEM_ALIGN.
4386 +-----------------------+
4387 | struct mmap_info + |
4388 | padding |
4389 +-----------------------+
4390 | user data |
4393 +-----------------------+ */
4395 struct mmap_region
4397 /* User-specified size. */
4398 size_t nbytes_specified;
4400 /* Number of bytes mapped */
4401 size_t nbytes_mapped;
4403 /* Pointer to the location holding the address of the memory
4404 allocated with the mmap'd block. The variable actually points
4405 after this structure. */
4406 POINTER_TYPE **var;
4408 /* Next and previous in list of all mmap'd regions. */
4409 struct mmap_region *next, *prev;
4412 /* Doubly-linked list of mmap'd regions. */
4414 static struct mmap_region *mmap_regions;
4416 /* File descriptor for mmap. If we don't have anonymous mapping,
4417 /dev/zero will be opened on it. */
4419 static int mmap_fd;
4421 /* Temporary storage for mmap_set_vars, see there. */
4423 static struct mmap_region *mmap_regions_1;
4424 static int mmap_fd_1;
4426 /* Page size on this system. */
4428 static int mmap_page_size;
4430 /* 1 means mmap has been intialized. */
4432 static int mmap_initialized_p;
4434 /* Value is X rounded up to the next multiple of N. */
4436 #define ROUND(X, N) (((X) + (N) - 1) / (N) * (N))
4438 /* Size of mmap_region structure plus padding. */
4440 #define MMAP_REGION_STRUCT_SIZE \
4441 ROUND (sizeof (struct mmap_region), MEM_ALIGN)
4443 /* Given a pointer P to the start of the user-visible part of a mapped
4444 region, return a pointer to the start of the region. */
4446 #define MMAP_REGION(P) \
4447 ((struct mmap_region *) ((char *) (P) - MMAP_REGION_STRUCT_SIZE))
4449 /* Given a pointer P to the start of a mapped region, return a pointer
4450 to the start of the user-visible part of the region. */
4452 #define MMAP_USER_AREA(P) \
4453 ((POINTER_TYPE *) ((char *) (P) + MMAP_REGION_STRUCT_SIZE))
4455 #define MEM_ALIGN sizeof (double)
4457 /* Predicate returning true if part of the address range [START .. END]
4458 is currently mapped. Used to prevent overwriting an existing
4459 memory mapping.
4461 Default is to conservativly assume the address range is occupied by
4462 something else. This can be overridden by system configuration
4463 files if system-specific means to determine this exists. */
4465 #ifndef MMAP_ALLOCATED_P
4466 #define MMAP_ALLOCATED_P(start, end) 1
4467 #endif
4469 /* Perform necessary intializations for the use of mmap. */
4471 static void
4472 mmap_init (void)
4474 #if MAP_ANON == 0
4475 /* The value of mmap_fd is initially 0 in temacs, and -1
4476 in a dumped Emacs. */
4477 if (mmap_fd <= 0)
4479 /* No anonymous mmap -- we need the file descriptor. */
4480 mmap_fd = open ("/dev/zero", O_RDONLY);
4481 if (mmap_fd == -1)
4482 fatal ("Cannot open /dev/zero: %s", emacs_strerror (errno));
4484 #endif /* MAP_ANON == 0 */
4486 if (mmap_initialized_p)
4487 return;
4488 mmap_initialized_p = 1;
4490 #if MAP_ANON != 0
4491 mmap_fd = -1;
4492 #endif
4494 mmap_page_size = getpagesize ();
4497 /* Return a region overlapping address range START...END, or null if
4498 none. END is not including, i.e. the last byte in the range
4499 is at END - 1. */
4501 static struct mmap_region *
4502 mmap_find (POINTER_TYPE *start, POINTER_TYPE *end);
4504 struct mmap_region *r;
4505 char *s = (char *) start, *e = (char *) end;
4507 for (r = mmap_regions; r; r = r->next)
4509 char *rstart = (char *) r;
4510 char *rend = rstart + r->nbytes_mapped;
4512 if (/* First byte of range, i.e. START, in this region? */
4513 (s >= rstart && s < rend)
4514 /* Last byte of range, i.e. END - 1, in this region? */
4515 || (e > rstart && e <= rend)
4516 /* First byte of this region in the range? */
4517 || (rstart >= s && rstart < e)
4518 /* Last byte of this region in the range? */
4519 || (rend > s && rend <= e))
4520 break;
4523 return r;
4527 /* Unmap a region. P is a pointer to the start of the user-araa of
4528 the region. Value is non-zero if successful. */
4530 static int
4531 mmap_free_1 (struct mmap_region *r)
4533 if (r->next)
4534 r->next->prev = r->prev;
4535 if (r->prev)
4536 r->prev->next = r->next;
4537 else
4538 mmap_regions = r->next;
4540 if (munmap ((POINTER_TYPE *) r, r->nbytes_mapped) == -1)
4542 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4543 return 0;
4546 return 1;
4550 /* Enlarge region R by NPAGES pages. NPAGES < 0 means shrink R.
4551 Value is non-zero if successful. */
4553 static int
4554 mmap_enlarge (struct mmap_region *r, int npages)
4556 char *region_end = (char *) r + r->nbytes_mapped;
4557 size_t nbytes;
4558 int success = 0;
4560 if (npages < 0)
4562 /* Unmap pages at the end of the region. */
4563 nbytes = - npages * mmap_page_size;
4564 if (munmap (region_end - nbytes, nbytes) == -1)
4565 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4566 else
4568 r->nbytes_mapped -= nbytes;
4569 success = 1;
4572 else if (npages > 0)
4574 nbytes = npages * mmap_page_size;
4576 /* Try to map additional pages at the end of the region. We
4577 cannot do this if the address range is already occupied by
4578 something else because mmap deletes any previous mapping.
4579 I'm not sure this is worth doing, let's see. */
4580 if (!MMAP_ALLOCATED_P (region_end, region_end + nbytes))
4582 POINTER_TYPE *p;
4584 p = mmap (region_end, nbytes, PROT_READ | PROT_WRITE,
4585 MAP_ANON | MAP_PRIVATE | MAP_FIXED, mmap_fd, 0);
4586 if (p == MAP_FAILED)
4587 ; /* fprintf (stderr, "mmap: %s\n", emacs_strerror (errno)); */
4588 else if (p != (POINTER_TYPE *) region_end)
4590 /* Kernels are free to choose a different address. In
4591 that case, unmap what we've mapped above; we have
4592 no use for it. */
4593 if (munmap (p, nbytes) == -1)
4594 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4596 else
4598 r->nbytes_mapped += nbytes;
4599 success = 1;
4604 return success;
4608 /* Set or reset variables holding references to mapped regions. If
4609 RESTORE_P is zero, set all variables to null. If RESTORE_P is
4610 non-zero, set all variables to the start of the user-areas
4611 of mapped regions.
4613 This function is called from Fdump_emacs to ensure that the dumped
4614 Emacs doesn't contain references to memory that won't be mapped
4615 when Emacs starts. */
4617 void
4618 mmap_set_vars (int restore_p)
4620 struct mmap_region *r;
4622 if (restore_p)
4624 mmap_regions = mmap_regions_1;
4625 mmap_fd = mmap_fd_1;
4626 for (r = mmap_regions; r; r = r->next)
4627 *r->var = MMAP_USER_AREA (r);
4629 else
4631 for (r = mmap_regions; r; r = r->next)
4632 *r->var = NULL;
4633 mmap_regions_1 = mmap_regions;
4634 mmap_regions = NULL;
4635 mmap_fd_1 = mmap_fd;
4636 mmap_fd = -1;
4641 /* Allocate a block of storage large enough to hold NBYTES bytes of
4642 data. A pointer to the data is returned in *VAR. VAR is thus the
4643 address of some variable which will use the data area.
4645 The allocation of 0 bytes is valid.
4647 If we can't allocate the necessary memory, set *VAR to null, and
4648 return null. */
4650 static POINTER_TYPE *
4651 mmap_alloc (POINTER_TYPE **var, size_t nbytes)
4653 void *p;
4654 size_t map;
4656 mmap_init ();
4658 map = ROUND (nbytes + MMAP_REGION_STRUCT_SIZE, mmap_page_size);
4659 p = mmap (NULL, map, PROT_READ | PROT_WRITE, MAP_ANON | MAP_PRIVATE,
4660 mmap_fd, 0);
4662 if (p == MAP_FAILED)
4664 if (errno != ENOMEM)
4665 fprintf (stderr, "mmap: %s\n", emacs_strerror (errno));
4666 p = NULL;
4668 else
4670 struct mmap_region *r = (struct mmap_region *) p;
4672 r->nbytes_specified = nbytes;
4673 r->nbytes_mapped = map;
4674 r->var = var;
4675 r->prev = NULL;
4676 r->next = mmap_regions;
4677 if (r->next)
4678 r->next->prev = r;
4679 mmap_regions = r;
4681 p = MMAP_USER_AREA (p);
4684 return *var = p;
4688 /* Free a block of relocatable storage whose data is pointed to by
4689 PTR. Store 0 in *PTR to show there's no block allocated. */
4691 static void
4692 mmap_free (POINTER_TYPE **var)
4694 mmap_init ();
4696 if (*var)
4698 mmap_free_1 (MMAP_REGION (*var));
4699 *var = NULL;
4704 /* Given a pointer at address VAR to data allocated with mmap_alloc,
4705 resize it to size NBYTES. Change *VAR to reflect the new block,
4706 and return this value. If more memory cannot be allocated, then
4707 leave *VAR unchanged, and return null. */
4709 static POINTER_TYPE *
4710 mmap_realloc (POINTER_TYPE **var, size_t nbytes)
4712 POINTER_TYPE *result;
4714 mmap_init ();
4716 if (*var == NULL)
4717 result = mmap_alloc (var, nbytes);
4718 else if (nbytes == 0)
4720 mmap_free (var);
4721 result = mmap_alloc (var, nbytes);
4723 else
4725 struct mmap_region *r = MMAP_REGION (*var);
4726 size_t room = r->nbytes_mapped - MMAP_REGION_STRUCT_SIZE;
4728 if (room < nbytes)
4730 /* Must enlarge. */
4731 POINTER_TYPE *old_ptr = *var;
4733 /* Try to map additional pages at the end of the region.
4734 If that fails, allocate a new region, copy data
4735 from the old region, then free it. */
4736 if (mmap_enlarge (r, (ROUND (nbytes - room, mmap_page_size)
4737 / mmap_page_size)))
4739 r->nbytes_specified = nbytes;
4740 *var = result = old_ptr;
4742 else if (mmap_alloc (var, nbytes))
4744 memcpy (*var, old_ptr, r->nbytes_specified);
4745 mmap_free_1 (MMAP_REGION (old_ptr));
4746 result = *var;
4747 r = MMAP_REGION (result);
4748 r->nbytes_specified = nbytes;
4750 else
4752 *var = old_ptr;
4753 result = NULL;
4756 else if (room - nbytes >= mmap_page_size)
4758 /* Shrinking by at least a page. Let's give some
4759 memory back to the system.
4761 The extra parens are to make the division happens first,
4762 on positive values, so we know it will round towards
4763 zero. */
4764 mmap_enlarge (r, - ((room - nbytes) / mmap_page_size));
4765 result = *var;
4766 r->nbytes_specified = nbytes;
4768 else
4770 /* Leave it alone. */
4771 result = *var;
4772 r->nbytes_specified = nbytes;
4776 return result;
4780 #endif /* USE_MMAP_FOR_BUFFERS */
4784 /***********************************************************************
4785 Buffer-text Allocation
4786 ***********************************************************************/
4788 #ifdef REL_ALLOC
4789 extern POINTER_TYPE *r_alloc (POINTER_TYPE **, size_t);
4790 extern POINTER_TYPE *r_re_alloc (POINTER_TYPE **, size_t);
4791 extern void r_alloc_free (POINTER_TYPE **ptr);
4792 #endif /* REL_ALLOC */
4795 /* Allocate NBYTES bytes for buffer B's text buffer. */
4797 static void
4798 alloc_buffer_text (struct buffer *b, size_t nbytes)
4800 POINTER_TYPE *p;
4802 BLOCK_INPUT;
4803 #if defined USE_MMAP_FOR_BUFFERS
4804 p = mmap_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4805 #elif defined REL_ALLOC
4806 p = r_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4807 #else
4808 p = xmalloc (nbytes);
4809 #endif
4811 if (p == NULL)
4813 UNBLOCK_INPUT;
4814 memory_full (nbytes);
4817 b->text->beg = (unsigned char *) p;
4818 UNBLOCK_INPUT;
4821 /* Enlarge buffer B's text buffer by DELTA bytes. DELTA < 0 means
4822 shrink it. */
4824 void
4825 enlarge_buffer_text (struct buffer *b, EMACS_INT delta)
4827 POINTER_TYPE *p;
4828 size_t nbytes = (BUF_Z_BYTE (b) - BUF_BEG_BYTE (b) + BUF_GAP_SIZE (b) + 1
4829 + delta);
4830 BLOCK_INPUT;
4831 #if defined USE_MMAP_FOR_BUFFERS
4832 p = mmap_realloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4833 #elif defined REL_ALLOC
4834 p = r_re_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4835 #else
4836 p = xrealloc (b->text->beg, nbytes);
4837 #endif
4839 if (p == NULL)
4841 UNBLOCK_INPUT;
4842 memory_full (nbytes);
4845 BUF_BEG_ADDR (b) = (unsigned char *) p;
4846 UNBLOCK_INPUT;
4850 /* Free buffer B's text buffer. */
4852 static void
4853 free_buffer_text (struct buffer *b)
4855 BLOCK_INPUT;
4857 #if defined USE_MMAP_FOR_BUFFERS
4858 mmap_free ((POINTER_TYPE **) &b->text->beg);
4859 #elif defined REL_ALLOC
4860 r_alloc_free ((POINTER_TYPE **) &b->text->beg);
4861 #else
4862 xfree (b->text->beg);
4863 #endif
4865 BUF_BEG_ADDR (b) = NULL;
4866 UNBLOCK_INPUT;
4871 /***********************************************************************
4872 Initialization
4873 ***********************************************************************/
4875 void
4876 init_buffer_once (void)
4878 int idx;
4880 memset (buffer_permanent_local_flags, 0, sizeof buffer_permanent_local_flags);
4882 /* Make sure all markable slots in buffer_defaults
4883 are initialized reasonably, so mark_buffer won't choke. */
4884 reset_buffer (&buffer_defaults);
4885 eassert (EQ (BVAR (&buffer_defaults, name), make_number (0)));
4886 reset_buffer_local_variables (&buffer_defaults, 1);
4887 eassert (EQ (BVAR (&buffer_local_symbols, name), make_number (0)));
4888 reset_buffer (&buffer_local_symbols);
4889 reset_buffer_local_variables (&buffer_local_symbols, 1);
4890 /* Prevent GC from getting confused. */
4891 buffer_defaults.text = &buffer_defaults.own_text;
4892 buffer_local_symbols.text = &buffer_local_symbols.own_text;
4893 BUF_INTERVALS (&buffer_defaults) = 0;
4894 BUF_INTERVALS (&buffer_local_symbols) = 0;
4895 XSETPVECTYPESIZE (&buffer_defaults, PVEC_BUFFER, 0);
4896 XSETBUFFER (Vbuffer_defaults, &buffer_defaults);
4897 XSETPVECTYPESIZE (&buffer_local_symbols, PVEC_BUFFER, 0);
4898 XSETBUFFER (Vbuffer_local_symbols, &buffer_local_symbols);
4900 /* Set up the default values of various buffer slots. */
4901 /* Must do these before making the first buffer! */
4903 /* real setup is done in bindings.el */
4904 BVAR (&buffer_defaults, mode_line_format) = make_pure_c_string ("%-");
4905 BVAR (&buffer_defaults, header_line_format) = Qnil;
4906 BVAR (&buffer_defaults, abbrev_mode) = Qnil;
4907 BVAR (&buffer_defaults, overwrite_mode) = Qnil;
4908 BVAR (&buffer_defaults, case_fold_search) = Qt;
4909 BVAR (&buffer_defaults, auto_fill_function) = Qnil;
4910 BVAR (&buffer_defaults, selective_display) = Qnil;
4911 #ifndef old
4912 BVAR (&buffer_defaults, selective_display_ellipses) = Qt;
4913 #endif
4914 BVAR (&buffer_defaults, abbrev_table) = Qnil;
4915 BVAR (&buffer_defaults, display_table) = Qnil;
4916 BVAR (&buffer_defaults, undo_list) = Qnil;
4917 BVAR (&buffer_defaults, mark_active) = Qnil;
4918 BVAR (&buffer_defaults, file_format) = Qnil;
4919 BVAR (&buffer_defaults, auto_save_file_format) = Qt;
4920 buffer_defaults.overlays_before = NULL;
4921 buffer_defaults.overlays_after = NULL;
4922 buffer_defaults.overlay_center = BEG;
4924 XSETFASTINT (BVAR (&buffer_defaults, tab_width), 8);
4925 BVAR (&buffer_defaults, truncate_lines) = Qnil;
4926 BVAR (&buffer_defaults, word_wrap) = Qnil;
4927 BVAR (&buffer_defaults, ctl_arrow) = Qt;
4928 BVAR (&buffer_defaults, bidi_display_reordering) = Qnil;
4929 BVAR (&buffer_defaults, bidi_paragraph_direction) = Qnil;
4930 BVAR (&buffer_defaults, cursor_type) = Qt;
4931 BVAR (&buffer_defaults, extra_line_spacing) = Qnil;
4932 BVAR (&buffer_defaults, cursor_in_non_selected_windows) = Qt;
4934 BVAR (&buffer_defaults, enable_multibyte_characters) = Qt;
4935 BVAR (&buffer_defaults, buffer_file_coding_system) = Qnil;
4936 XSETFASTINT (BVAR (&buffer_defaults, fill_column), 70);
4937 XSETFASTINT (BVAR (&buffer_defaults, left_margin), 0);
4938 BVAR (&buffer_defaults, cache_long_line_scans) = Qnil;
4939 BVAR (&buffer_defaults, file_truename) = Qnil;
4940 XSETFASTINT (BVAR (&buffer_defaults, display_count), 0);
4941 XSETFASTINT (BVAR (&buffer_defaults, left_margin_cols), 0);
4942 XSETFASTINT (BVAR (&buffer_defaults, right_margin_cols), 0);
4943 BVAR (&buffer_defaults, left_fringe_width) = Qnil;
4944 BVAR (&buffer_defaults, right_fringe_width) = Qnil;
4945 BVAR (&buffer_defaults, fringes_outside_margins) = Qnil;
4946 BVAR (&buffer_defaults, scroll_bar_width) = Qnil;
4947 BVAR (&buffer_defaults, vertical_scroll_bar_type) = Qt;
4948 BVAR (&buffer_defaults, indicate_empty_lines) = Qnil;
4949 BVAR (&buffer_defaults, indicate_buffer_boundaries) = Qnil;
4950 BVAR (&buffer_defaults, fringe_indicator_alist) = Qnil;
4951 BVAR (&buffer_defaults, fringe_cursor_alist) = Qnil;
4952 BVAR (&buffer_defaults, scroll_up_aggressively) = Qnil;
4953 BVAR (&buffer_defaults, scroll_down_aggressively) = Qnil;
4954 BVAR (&buffer_defaults, display_time) = Qnil;
4956 /* Assign the local-flags to the slots that have default values.
4957 The local flag is a bit that is used in the buffer
4958 to say that it has its own local value for the slot.
4959 The local flag bits are in the local_var_flags slot of the buffer. */
4961 /* Nothing can work if this isn't true */
4962 { verify (sizeof (EMACS_INT) == sizeof (Lisp_Object)); }
4964 /* 0 means not a lisp var, -1 means always local, else mask */
4965 memset (&buffer_local_flags, 0, sizeof buffer_local_flags);
4966 XSETINT (BVAR (&buffer_local_flags, filename), -1);
4967 XSETINT (BVAR (&buffer_local_flags, directory), -1);
4968 XSETINT (BVAR (&buffer_local_flags, backed_up), -1);
4969 XSETINT (BVAR (&buffer_local_flags, save_length), -1);
4970 XSETINT (BVAR (&buffer_local_flags, auto_save_file_name), -1);
4971 XSETINT (BVAR (&buffer_local_flags, read_only), -1);
4972 XSETINT (BVAR (&buffer_local_flags, major_mode), -1);
4973 XSETINT (BVAR (&buffer_local_flags, mode_name), -1);
4974 XSETINT (BVAR (&buffer_local_flags, undo_list), -1);
4975 XSETINT (BVAR (&buffer_local_flags, mark_active), -1);
4976 XSETINT (BVAR (&buffer_local_flags, point_before_scroll), -1);
4977 XSETINT (BVAR (&buffer_local_flags, file_truename), -1);
4978 XSETINT (BVAR (&buffer_local_flags, invisibility_spec), -1);
4979 XSETINT (BVAR (&buffer_local_flags, file_format), -1);
4980 XSETINT (BVAR (&buffer_local_flags, auto_save_file_format), -1);
4981 XSETINT (BVAR (&buffer_local_flags, display_count), -1);
4982 XSETINT (BVAR (&buffer_local_flags, display_time), -1);
4983 XSETINT (BVAR (&buffer_local_flags, enable_multibyte_characters), -1);
4985 idx = 1;
4986 XSETFASTINT (BVAR (&buffer_local_flags, mode_line_format), idx); ++idx;
4987 XSETFASTINT (BVAR (&buffer_local_flags, abbrev_mode), idx); ++idx;
4988 XSETFASTINT (BVAR (&buffer_local_flags, overwrite_mode), idx); ++idx;
4989 XSETFASTINT (BVAR (&buffer_local_flags, case_fold_search), idx); ++idx;
4990 XSETFASTINT (BVAR (&buffer_local_flags, auto_fill_function), idx); ++idx;
4991 XSETFASTINT (BVAR (&buffer_local_flags, selective_display), idx); ++idx;
4992 #ifndef old
4993 XSETFASTINT (BVAR (&buffer_local_flags, selective_display_ellipses), idx); ++idx;
4994 #endif
4995 XSETFASTINT (BVAR (&buffer_local_flags, tab_width), idx); ++idx;
4996 XSETFASTINT (BVAR (&buffer_local_flags, truncate_lines), idx); ++idx;
4997 XSETFASTINT (BVAR (&buffer_local_flags, word_wrap), idx); ++idx;
4998 XSETFASTINT (BVAR (&buffer_local_flags, ctl_arrow), idx); ++idx;
4999 XSETFASTINT (BVAR (&buffer_local_flags, fill_column), idx); ++idx;
5000 XSETFASTINT (BVAR (&buffer_local_flags, left_margin), idx); ++idx;
5001 XSETFASTINT (BVAR (&buffer_local_flags, abbrev_table), idx); ++idx;
5002 XSETFASTINT (BVAR (&buffer_local_flags, display_table), idx); ++idx;
5003 XSETFASTINT (BVAR (&buffer_local_flags, syntax_table), idx); ++idx;
5004 XSETFASTINT (BVAR (&buffer_local_flags, cache_long_line_scans), idx); ++idx;
5005 XSETFASTINT (BVAR (&buffer_local_flags, category_table), idx); ++idx;
5006 XSETFASTINT (BVAR (&buffer_local_flags, bidi_display_reordering), idx); ++idx;
5007 XSETFASTINT (BVAR (&buffer_local_flags, bidi_paragraph_direction), idx); ++idx;
5008 XSETFASTINT (BVAR (&buffer_local_flags, buffer_file_coding_system), idx);
5009 /* Make this one a permanent local. */
5010 buffer_permanent_local_flags[idx++] = 1;
5011 XSETFASTINT (BVAR (&buffer_local_flags, left_margin_cols), idx); ++idx;
5012 XSETFASTINT (BVAR (&buffer_local_flags, right_margin_cols), idx); ++idx;
5013 XSETFASTINT (BVAR (&buffer_local_flags, left_fringe_width), idx); ++idx;
5014 XSETFASTINT (BVAR (&buffer_local_flags, right_fringe_width), idx); ++idx;
5015 XSETFASTINT (BVAR (&buffer_local_flags, fringes_outside_margins), idx); ++idx;
5016 XSETFASTINT (BVAR (&buffer_local_flags, scroll_bar_width), idx); ++idx;
5017 XSETFASTINT (BVAR (&buffer_local_flags, vertical_scroll_bar_type), idx); ++idx;
5018 XSETFASTINT (BVAR (&buffer_local_flags, indicate_empty_lines), idx); ++idx;
5019 XSETFASTINT (BVAR (&buffer_local_flags, indicate_buffer_boundaries), idx); ++idx;
5020 XSETFASTINT (BVAR (&buffer_local_flags, fringe_indicator_alist), idx); ++idx;
5021 XSETFASTINT (BVAR (&buffer_local_flags, fringe_cursor_alist), idx); ++idx;
5022 XSETFASTINT (BVAR (&buffer_local_flags, scroll_up_aggressively), idx); ++idx;
5023 XSETFASTINT (BVAR (&buffer_local_flags, scroll_down_aggressively), idx); ++idx;
5024 XSETFASTINT (BVAR (&buffer_local_flags, header_line_format), idx); ++idx;
5025 XSETFASTINT (BVAR (&buffer_local_flags, cursor_type), idx); ++idx;
5026 XSETFASTINT (BVAR (&buffer_local_flags, extra_line_spacing), idx); ++idx;
5027 XSETFASTINT (BVAR (&buffer_local_flags, cursor_in_non_selected_windows), idx); ++idx;
5029 /* Need more room? */
5030 if (idx >= MAX_PER_BUFFER_VARS)
5031 abort ();
5032 last_per_buffer_idx = idx;
5034 Vbuffer_alist = Qnil;
5035 current_buffer = 0;
5036 all_buffers = 0;
5038 QSFundamental = make_pure_c_string ("Fundamental");
5040 Qfundamental_mode = intern_c_string ("fundamental-mode");
5041 BVAR (&buffer_defaults, major_mode) = Qfundamental_mode;
5043 Qmode_class = intern_c_string ("mode-class");
5045 Qprotected_field = intern_c_string ("protected-field");
5047 Qpermanent_local = intern_c_string ("permanent-local");
5049 Qkill_buffer_hook = intern_c_string ("kill-buffer-hook");
5050 Fput (Qkill_buffer_hook, Qpermanent_local, Qt);
5052 Qucs_set_table_for_input = intern_c_string ("ucs-set-table-for-input");
5054 /* super-magic invisible buffer */
5055 Vprin1_to_string_buffer = Fget_buffer_create (make_pure_c_string (" prin1"));
5056 Vbuffer_alist = Qnil;
5058 Fset_buffer (Fget_buffer_create (make_pure_c_string ("*scratch*")));
5060 inhibit_modification_hooks = 0;
5063 void
5064 init_buffer (void)
5066 char *pwd;
5067 Lisp_Object temp;
5068 ptrdiff_t len;
5070 #ifdef USE_MMAP_FOR_BUFFERS
5072 /* When using the ralloc implementation based on mmap(2), buffer
5073 text pointers will have been set to null in the dumped Emacs.
5074 Map new memory. */
5075 struct buffer *b;
5077 for (b = all_buffers; b; b = b->header.next.buffer)
5078 if (b->text->beg == NULL)
5079 enlarge_buffer_text (b, 0);
5081 #endif /* USE_MMAP_FOR_BUFFERS */
5083 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5084 if (NILP (BVAR (&buffer_defaults, enable_multibyte_characters)))
5085 Fset_buffer_multibyte (Qnil);
5087 pwd = get_current_dir_name ();
5089 if (!pwd)
5090 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno));
5092 /* Maybe this should really use some standard subroutine
5093 whose definition is filename syntax dependent. */
5094 len = strlen (pwd);
5095 if (!(IS_DIRECTORY_SEP (pwd[len - 1])))
5097 /* Grow buffer to add directory separator and '\0'. */
5098 pwd = (char *) realloc (pwd, len + 2);
5099 if (!pwd)
5100 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno));
5101 pwd[len] = DIRECTORY_SEP;
5102 pwd[len + 1] = '\0';
5105 BVAR (current_buffer, directory) = make_unibyte_string (pwd, strlen (pwd));
5106 if (! NILP (BVAR (&buffer_defaults, enable_multibyte_characters)))
5107 /* At this moment, we still don't know how to decode the
5108 directory name. So, we keep the bytes in multibyte form so
5109 that ENCODE_FILE correctly gets the original bytes. */
5110 BVAR (current_buffer, directory)
5111 = string_to_multibyte (BVAR (current_buffer, directory));
5113 /* Add /: to the front of the name
5114 if it would otherwise be treated as magic. */
5115 temp = Ffind_file_name_handler (BVAR (current_buffer, directory), Qt);
5116 if (! NILP (temp)
5117 /* If the default dir is just /, TEMP is non-nil
5118 because of the ange-ftp completion handler.
5119 However, it is not necessary to turn / into /:/.
5120 So avoid doing that. */
5121 && strcmp ("/", SSDATA (BVAR (current_buffer, directory))))
5122 BVAR (current_buffer, directory)
5123 = concat2 (build_string ("/:"), BVAR (current_buffer, directory));
5125 temp = get_minibuffer (0);
5126 BVAR (XBUFFER (temp), directory) = BVAR (current_buffer, directory);
5128 free (pwd);
5131 /* Similar to defvar_lisp but define a variable whose value is the Lisp
5132 Object stored in the current buffer. address is the address of the slot
5133 in the buffer that is current now. */
5135 /* TYPE is nil for a general Lisp variable.
5136 An integer specifies a type; then only Lisp values
5137 with that type code are allowed (except that nil is allowed too).
5138 LNAME is the Lisp-level variable name.
5139 VNAME is the name of the buffer slot.
5140 DOC is a dummy where you write the doc string as a comment. */
5141 #define DEFVAR_PER_BUFFER(lname, vname, type, doc) \
5142 do { \
5143 static struct Lisp_Buffer_Objfwd bo_fwd; \
5144 defvar_per_buffer (&bo_fwd, lname, vname, type); \
5145 } while (0)
5147 static void
5148 defvar_per_buffer (struct Lisp_Buffer_Objfwd *bo_fwd, const char *namestring,
5149 Lisp_Object *address, Lisp_Object type)
5151 struct Lisp_Symbol *sym;
5152 int offset;
5154 sym = XSYMBOL (intern (namestring));
5155 offset = (char *)address - (char *)current_buffer;
5157 bo_fwd->type = Lisp_Fwd_Buffer_Obj;
5158 bo_fwd->offset = offset;
5159 bo_fwd->slottype = type;
5160 sym->declared_special = 1;
5161 sym->redirect = SYMBOL_FORWARDED;
5163 /* I tried to do the job without a cast, but it seems impossible.
5164 union Lisp_Fwd *fwd; &(fwd->u_buffer_objfwd) = bo_fwd; */
5165 SET_SYMBOL_FWD (sym, (union Lisp_Fwd *)bo_fwd);
5167 XSETSYMBOL (PER_BUFFER_SYMBOL (offset), sym);
5169 if (PER_BUFFER_IDX (offset) == 0)
5170 /* Did a DEFVAR_PER_BUFFER without initializing the corresponding
5171 slot of buffer_local_flags */
5172 abort ();
5176 /* initialize the buffer routines */
5177 void
5178 syms_of_buffer (void)
5180 staticpro (&last_overlay_modification_hooks);
5181 last_overlay_modification_hooks
5182 = Fmake_vector (make_number (10), Qnil);
5184 staticpro (&Vbuffer_defaults);
5185 staticpro (&Vbuffer_local_symbols);
5186 staticpro (&Qfundamental_mode);
5187 staticpro (&Qmode_class);
5188 staticpro (&QSFundamental);
5189 staticpro (&Vbuffer_alist);
5190 staticpro (&Qprotected_field);
5191 staticpro (&Qpermanent_local);
5192 staticpro (&Qkill_buffer_hook);
5194 DEFSYM (Qpermanent_local_hook, "permanent-local-hook");
5195 DEFSYM (Qoverlayp, "overlayp");
5196 DEFSYM (Qevaporate, "evaporate");
5197 DEFSYM (Qmodification_hooks, "modification-hooks");
5198 DEFSYM (Qinsert_in_front_hooks, "insert-in-front-hooks");
5199 DEFSYM (Qinsert_behind_hooks, "insert-behind-hooks");
5200 DEFSYM (Qget_file_buffer, "get-file-buffer");
5201 DEFSYM (Qpriority, "priority");
5202 DEFSYM (Qbefore_string, "before-string");
5203 DEFSYM (Qafter_string, "after-string");
5204 DEFSYM (Qfirst_change_hook, "first-change-hook");
5205 DEFSYM (Qbefore_change_functions, "before-change-functions");
5206 DEFSYM (Qafter_change_functions, "after-change-functions");
5207 DEFSYM (Qkill_buffer_query_functions, "kill-buffer-query-functions");
5209 /* The next one is initialized in init_buffer_once. */
5210 staticpro (&Qucs_set_table_for_input);
5212 Fput (Qprotected_field, Qerror_conditions,
5213 pure_cons (Qprotected_field, pure_cons (Qerror, Qnil)));
5214 Fput (Qprotected_field, Qerror_message,
5215 make_pure_c_string ("Attempt to modify a protected field"));
5217 DEFVAR_BUFFER_DEFAULTS ("default-mode-line-format",
5218 mode_line_format,
5219 doc: /* Default value of `mode-line-format' for buffers that don't override it.
5220 This is the same as (default-value 'mode-line-format). */);
5222 DEFVAR_BUFFER_DEFAULTS ("default-header-line-format",
5223 header_line_format,
5224 doc: /* Default value of `header-line-format' for buffers that don't override it.
5225 This is the same as (default-value 'header-line-format). */);
5227 DEFVAR_BUFFER_DEFAULTS ("default-cursor-type", cursor_type,
5228 doc: /* Default value of `cursor-type' for buffers that don't override it.
5229 This is the same as (default-value 'cursor-type). */);
5231 DEFVAR_BUFFER_DEFAULTS ("default-line-spacing",
5232 extra_line_spacing,
5233 doc: /* Default value of `line-spacing' for buffers that don't override it.
5234 This is the same as (default-value 'line-spacing). */);
5236 DEFVAR_BUFFER_DEFAULTS ("default-cursor-in-non-selected-windows",
5237 cursor_in_non_selected_windows,
5238 doc: /* Default value of `cursor-in-non-selected-windows'.
5239 This is the same as (default-value 'cursor-in-non-selected-windows). */);
5241 DEFVAR_BUFFER_DEFAULTS ("default-abbrev-mode",
5242 abbrev_mode,
5243 doc: /* Default value of `abbrev-mode' for buffers that do not override it.
5244 This is the same as (default-value 'abbrev-mode). */);
5246 DEFVAR_BUFFER_DEFAULTS ("default-ctl-arrow",
5247 ctl_arrow,
5248 doc: /* Default value of `ctl-arrow' for buffers that do not override it.
5249 This is the same as (default-value 'ctl-arrow). */);
5251 DEFVAR_BUFFER_DEFAULTS ("default-enable-multibyte-characters",
5252 enable_multibyte_characters,
5253 doc: /* *Default value of `enable-multibyte-characters' for buffers not overriding it.
5254 This is the same as (default-value 'enable-multibyte-characters). */);
5256 DEFVAR_BUFFER_DEFAULTS ("default-buffer-file-coding-system",
5257 buffer_file_coding_system,
5258 doc: /* Default value of `buffer-file-coding-system' for buffers not overriding it.
5259 This is the same as (default-value 'buffer-file-coding-system). */);
5261 DEFVAR_BUFFER_DEFAULTS ("default-truncate-lines",
5262 truncate_lines,
5263 doc: /* Default value of `truncate-lines' for buffers that do not override it.
5264 This is the same as (default-value 'truncate-lines). */);
5266 DEFVAR_BUFFER_DEFAULTS ("default-fill-column",
5267 fill_column,
5268 doc: /* Default value of `fill-column' for buffers that do not override it.
5269 This is the same as (default-value 'fill-column). */);
5271 DEFVAR_BUFFER_DEFAULTS ("default-left-margin",
5272 left_margin,
5273 doc: /* Default value of `left-margin' for buffers that do not override it.
5274 This is the same as (default-value 'left-margin). */);
5276 DEFVAR_BUFFER_DEFAULTS ("default-tab-width",
5277 tab_width,
5278 doc: /* Default value of `tab-width' for buffers that do not override it.
5279 This is the same as (default-value 'tab-width). */);
5281 DEFVAR_BUFFER_DEFAULTS ("default-case-fold-search",
5282 case_fold_search,
5283 doc: /* Default value of `case-fold-search' for buffers that don't override it.
5284 This is the same as (default-value 'case-fold-search). */);
5286 DEFVAR_BUFFER_DEFAULTS ("default-left-margin-width",
5287 left_margin_cols,
5288 doc: /* Default value of `left-margin-width' for buffers that don't override it.
5289 This is the same as (default-value 'left-margin-width). */);
5291 DEFVAR_BUFFER_DEFAULTS ("default-right-margin-width",
5292 right_margin_cols,
5293 doc: /* Default value of `right-margin-width' for buffers that don't override it.
5294 This is the same as (default-value 'right-margin-width). */);
5296 DEFVAR_BUFFER_DEFAULTS ("default-left-fringe-width",
5297 left_fringe_width,
5298 doc: /* Default value of `left-fringe-width' for buffers that don't override it.
5299 This is the same as (default-value 'left-fringe-width). */);
5301 DEFVAR_BUFFER_DEFAULTS ("default-right-fringe-width",
5302 right_fringe_width,
5303 doc: /* Default value of `right-fringe-width' for buffers that don't override it.
5304 This is the same as (default-value 'right-fringe-width). */);
5306 DEFVAR_BUFFER_DEFAULTS ("default-fringes-outside-margins",
5307 fringes_outside_margins,
5308 doc: /* Default value of `fringes-outside-margins' for buffers that don't override it.
5309 This is the same as (default-value 'fringes-outside-margins). */);
5311 DEFVAR_BUFFER_DEFAULTS ("default-scroll-bar-width",
5312 scroll_bar_width,
5313 doc: /* Default value of `scroll-bar-width' for buffers that don't override it.
5314 This is the same as (default-value 'scroll-bar-width). */);
5316 DEFVAR_BUFFER_DEFAULTS ("default-vertical-scroll-bar",
5317 vertical_scroll_bar_type,
5318 doc: /* Default value of `vertical-scroll-bar' for buffers that don't override it.
5319 This is the same as (default-value 'vertical-scroll-bar). */);
5321 DEFVAR_BUFFER_DEFAULTS ("default-indicate-empty-lines",
5322 indicate_empty_lines,
5323 doc: /* Default value of `indicate-empty-lines' for buffers that don't override it.
5324 This is the same as (default-value 'indicate-empty-lines). */);
5326 DEFVAR_BUFFER_DEFAULTS ("default-indicate-buffer-boundaries",
5327 indicate_buffer_boundaries,
5328 doc: /* Default value of `indicate-buffer-boundaries' for buffers that don't override it.
5329 This is the same as (default-value 'indicate-buffer-boundaries). */);
5331 DEFVAR_BUFFER_DEFAULTS ("default-fringe-indicator-alist",
5332 fringe_indicator_alist,
5333 doc: /* Default value of `fringe-indicator-alist' for buffers that don't override it.
5334 This is the same as (default-value 'fringe-indicator-alist'). */);
5336 DEFVAR_BUFFER_DEFAULTS ("default-fringe-cursor-alist",
5337 fringe_cursor_alist,
5338 doc: /* Default value of `fringe-cursor-alist' for buffers that don't override it.
5339 This is the same as (default-value 'fringe-cursor-alist'). */);
5341 DEFVAR_BUFFER_DEFAULTS ("default-scroll-up-aggressively",
5342 scroll_up_aggressively,
5343 doc: /* Default value of `scroll-up-aggressively'.
5344 This value applies in buffers that don't have their own local values.
5345 This is the same as (default-value 'scroll-up-aggressively). */);
5347 DEFVAR_BUFFER_DEFAULTS ("default-scroll-down-aggressively",
5348 scroll_down_aggressively,
5349 doc: /* Default value of `scroll-down-aggressively'.
5350 This value applies in buffers that don't have their own local values.
5351 This is the same as (default-value 'scroll-down-aggressively). */);
5353 DEFVAR_PER_BUFFER ("header-line-format",
5354 &BVAR (current_buffer, header_line_format),
5355 Qnil,
5356 doc: /* Analogous to `mode-line-format', but controls the header line.
5357 The header line appears, optionally, at the top of a window;
5358 the mode line appears at the bottom. */);
5360 DEFVAR_PER_BUFFER ("mode-line-format", &BVAR (current_buffer, mode_line_format),
5361 Qnil,
5362 doc: /* Template for displaying mode line for current buffer.
5363 Each buffer has its own value of this variable.
5364 Value may be nil, a string, a symbol or a list or cons cell.
5365 A value of nil means don't display a mode line.
5366 For a symbol, its value is used (but it is ignored if t or nil).
5367 A string appearing directly as the value of a symbol is processed verbatim
5368 in that the %-constructs below are not recognized.
5369 Note that unless the symbol is marked as a `risky-local-variable', all
5370 properties in any strings, as well as all :eval and :propertize forms
5371 in the value of that symbol will be ignored.
5372 For a list of the form `(:eval FORM)', FORM is evaluated and the result
5373 is used as a mode line element. Be careful--FORM should not load any files,
5374 because that can cause an infinite recursion.
5375 For a list of the form `(:propertize ELT PROPS...)', ELT is displayed
5376 with the specified properties PROPS applied.
5377 For a list whose car is a symbol, the symbol's value is taken,
5378 and if that is non-nil, the cadr of the list is processed recursively.
5379 Otherwise, the caddr of the list (if there is one) is processed.
5380 For a list whose car is a string or list, each element is processed
5381 recursively and the results are effectively concatenated.
5382 For a list whose car is an integer, the cdr of the list is processed
5383 and padded (if the number is positive) or truncated (if negative)
5384 to the width specified by that number.
5385 A string is printed verbatim in the mode line except for %-constructs:
5386 (%-constructs are allowed when the string is the entire mode-line-format
5387 or when it is found in a cons-cell or a list)
5388 %b -- print buffer name. %f -- print visited file name.
5389 %F -- print frame name.
5390 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.
5391 %& is like %*, but ignore read-only-ness.
5392 % means buffer is read-only and * means it is modified.
5393 For a modified read-only buffer, %* gives % and %+ gives *.
5394 %s -- print process status. %l -- print the current line number.
5395 %c -- print the current column number (this makes editing slower).
5396 To make the column number update correctly in all cases,
5397 `column-number-mode' must be non-nil.
5398 %i -- print the size of the buffer.
5399 %I -- like %i, but use k, M, G, etc., to abbreviate.
5400 %p -- print percent of buffer above top of window, or Top, Bot or All.
5401 %P -- print percent of buffer above bottom of window, perhaps plus Top,
5402 or print Bottom or All.
5403 %n -- print Narrow if appropriate.
5404 %t -- visited file is text or binary (if OS supports this distinction).
5405 %z -- print mnemonics of keyboard, terminal, and buffer coding systems.
5406 %Z -- like %z, but including the end-of-line format.
5407 %e -- print error message about full memory.
5408 %@ -- print @ or hyphen. @ means that default-directory is on a
5409 remote machine.
5410 %[ -- print one [ for each recursive editing level. %] similar.
5411 %% -- print %. %- -- print infinitely many dashes.
5412 Decimal digits after the % specify field width to which to pad. */);
5414 DEFVAR_BUFFER_DEFAULTS ("default-major-mode", major_mode,
5415 doc: /* *Value of `major-mode' for new buffers. */);
5417 DEFVAR_PER_BUFFER ("major-mode", &BVAR (current_buffer, major_mode),
5418 make_number (Lisp_Symbol),
5419 doc: /* Symbol for current buffer's major mode.
5420 The default value (normally `fundamental-mode') affects new buffers.
5421 A value of nil means to use the current buffer's major mode, provided
5422 it is not marked as "special".
5424 When a mode is used by default, `find-file' switches to it before it
5425 reads the contents into the buffer and before it finishes setting up
5426 the buffer. Thus, the mode and its hooks should not expect certain
5427 variables such as `buffer-read-only' and `buffer-file-coding-system'
5428 to be set up. */);
5430 DEFVAR_PER_BUFFER ("mode-name", &BVAR (current_buffer, mode_name),
5431 Qnil,
5432 doc: /* Pretty name of current buffer's major mode.
5433 Usually a string, but can use any of the constructs for `mode-line-format',
5434 which see.
5435 Format with `format-mode-line' to produce a string value. */);
5437 DEFVAR_PER_BUFFER ("local-abbrev-table", &BVAR (current_buffer, abbrev_table), Qnil,
5438 doc: /* Local (mode-specific) abbrev table of current buffer. */);
5440 DEFVAR_PER_BUFFER ("abbrev-mode", &BVAR (current_buffer, abbrev_mode), Qnil,
5441 doc: /* Non-nil if Abbrev mode is enabled.
5442 Use the command `abbrev-mode' to change this variable. */);
5444 DEFVAR_PER_BUFFER ("case-fold-search", &BVAR (current_buffer, case_fold_search),
5445 Qnil,
5446 doc: /* *Non-nil if searches and matches should ignore case. */);
5448 DEFVAR_PER_BUFFER ("fill-column", &BVAR (current_buffer, fill_column),
5449 make_number (LISP_INT_TAG),
5450 doc: /* *Column beyond which automatic line-wrapping should happen.
5451 Interactively, you can set the buffer local value using \\[set-fill-column]. */);
5453 DEFVAR_PER_BUFFER ("left-margin", &BVAR (current_buffer, left_margin),
5454 make_number (LISP_INT_TAG),
5455 doc: /* *Column for the default `indent-line-function' to indent to.
5456 Linefeed indents to this column in Fundamental mode. */);
5458 DEFVAR_PER_BUFFER ("tab-width", &BVAR (current_buffer, tab_width),
5459 make_number (LISP_INT_TAG),
5460 doc: /* *Distance between tab stops (for display of tab characters), in columns.
5461 This should be an integer greater than zero. */);
5463 DEFVAR_PER_BUFFER ("ctl-arrow", &BVAR (current_buffer, ctl_arrow), Qnil,
5464 doc: /* *Non-nil means display control chars with uparrow.
5465 A value of nil means use backslash and octal digits.
5466 This variable does not apply to characters whose display is specified
5467 in the current display table (if there is one). */);
5469 DEFVAR_PER_BUFFER ("enable-multibyte-characters",
5470 &BVAR (current_buffer, enable_multibyte_characters),
5471 Qnil,
5472 doc: /* Non-nil means the buffer contents are regarded as multi-byte characters.
5473 Otherwise they are regarded as unibyte. This affects the display,
5474 file I/O and the behavior of various editing commands.
5476 This variable is buffer-local but you cannot set it directly;
5477 use the function `set-buffer-multibyte' to change a buffer's representation.
5478 Changing its default value with `setq-default' is supported.
5479 See also variable `default-enable-multibyte-characters' and Info node
5480 `(elisp)Text Representations'. */);
5481 XSYMBOL (intern_c_string ("enable-multibyte-characters"))->constant = 1;
5483 DEFVAR_PER_BUFFER ("buffer-file-coding-system",
5484 &BVAR (current_buffer, buffer_file_coding_system), Qnil,
5485 doc: /* Coding system to be used for encoding the buffer contents on saving.
5486 This variable applies to saving the buffer, and also to `write-region'
5487 and other functions that use `write-region'.
5488 It does not apply to sending output to subprocesses, however.
5490 If this is nil, the buffer is saved without any code conversion
5491 unless some coding system is specified in `file-coding-system-alist'
5492 for the buffer file.
5494 If the text to be saved cannot be encoded as specified by this variable,
5495 an alternative encoding is selected by `select-safe-coding-system', which see.
5497 The variable `coding-system-for-write', if non-nil, overrides this variable.
5499 This variable is never applied to a way of decoding a file while reading it. */);
5501 DEFVAR_PER_BUFFER ("bidi-display-reordering",
5502 &BVAR (current_buffer, bidi_display_reordering), Qnil,
5503 doc: /* Non-nil means reorder bidirectional text for display in the visual order. */);
5505 DEFVAR_PER_BUFFER ("bidi-paragraph-direction",
5506 &BVAR (current_buffer, bidi_paragraph_direction), Qnil,
5507 doc: /* *If non-nil, forces directionality of text paragraphs in the buffer.
5509 If this is nil (the default), the direction of each paragraph is
5510 determined by the first strong directional character of its text.
5511 The values of `right-to-left' and `left-to-right' override that.
5512 Any other value is treated as nil.
5514 This variable has no effect unless the buffer's value of
5515 \`bidi-display-reordering' is non-nil. */);
5517 DEFVAR_PER_BUFFER ("truncate-lines", &BVAR (current_buffer, truncate_lines), Qnil,
5518 doc: /* *Non-nil means do not display continuation lines.
5519 Instead, give each line of text just one screen line.
5521 Note that this is overridden by the variable
5522 `truncate-partial-width-windows' if that variable is non-nil
5523 and this buffer is not full-frame width. */);
5525 DEFVAR_PER_BUFFER ("word-wrap", &BVAR (current_buffer, word_wrap), Qnil,
5526 doc: /* *Non-nil means to use word-wrapping for continuation lines.
5527 When word-wrapping is on, continuation lines are wrapped at the space
5528 or tab character nearest to the right window edge.
5529 If nil, continuation lines are wrapped at the right screen edge.
5531 This variable has no effect if long lines are truncated (see
5532 `truncate-lines' and `truncate-partial-width-windows'). If you use
5533 word-wrapping, you might want to reduce the value of
5534 `truncate-partial-width-windows', since wrapping can make text readable
5535 in narrower windows. */);
5537 DEFVAR_PER_BUFFER ("default-directory", &BVAR (current_buffer, directory),
5538 make_number (Lisp_String),
5539 doc: /* Name of default directory of current buffer. Should end with slash.
5540 To interactively change the default directory, use command `cd'. */);
5542 DEFVAR_PER_BUFFER ("auto-fill-function", &BVAR (current_buffer, auto_fill_function),
5543 Qnil,
5544 doc: /* Function called (if non-nil) to perform auto-fill.
5545 It is called after self-inserting any character specified in
5546 the `auto-fill-chars' table.
5547 NOTE: This variable is not a hook;
5548 its value may not be a list of functions. */);
5550 DEFVAR_PER_BUFFER ("buffer-file-name", &BVAR (current_buffer, filename),
5551 make_number (Lisp_String),
5552 doc: /* Name of file visited in current buffer, or nil if not visiting a file. */);
5554 DEFVAR_PER_BUFFER ("buffer-file-truename", &BVAR (current_buffer, file_truename),
5555 make_number (Lisp_String),
5556 doc: /* Abbreviated truename of file visited in current buffer, or nil if none.
5557 The truename of a file is calculated by `file-truename'
5558 and then abbreviated with `abbreviate-file-name'. */);
5560 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
5561 &BVAR (current_buffer, auto_save_file_name),
5562 make_number (Lisp_String),
5563 doc: /* Name of file for auto-saving current buffer.
5564 If it is nil, that means don't auto-save this buffer. */);
5566 DEFVAR_PER_BUFFER ("buffer-read-only", &BVAR (current_buffer, read_only), Qnil,
5567 doc: /* Non-nil if this buffer is read-only. */);
5569 DEFVAR_PER_BUFFER ("buffer-backed-up", &BVAR (current_buffer, backed_up), Qnil,
5570 doc: /* Non-nil if this buffer's file has been backed up.
5571 Backing up is done before the first time the file is saved. */);
5573 DEFVAR_PER_BUFFER ("buffer-saved-size", &BVAR (current_buffer, save_length),
5574 make_number (LISP_INT_TAG),
5575 doc: /* Length of current buffer when last read in, saved or auto-saved.
5576 0 initially.
5577 -1 means auto-saving turned off until next real save.
5579 If you set this to -2, that means don't turn off auto-saving in this buffer
5580 if its text size shrinks. If you use `buffer-swap-text' on a buffer,
5581 you probably should set this to -2 in that buffer. */);
5583 DEFVAR_PER_BUFFER ("selective-display", &BVAR (current_buffer, selective_display),
5584 Qnil,
5585 doc: /* Non-nil enables selective display.
5586 An integer N as value means display only lines
5587 that start with less than N columns of space.
5588 A value of t means that the character ^M makes itself and
5589 all the rest of the line invisible; also, when saving the buffer
5590 in a file, save the ^M as a newline. */);
5592 #ifndef old
5593 DEFVAR_PER_BUFFER ("selective-display-ellipses",
5594 &BVAR (current_buffer, selective_display_ellipses),
5595 Qnil,
5596 doc: /* Non-nil means display ... on previous line when a line is invisible. */);
5597 #endif
5599 DEFVAR_PER_BUFFER ("overwrite-mode", &BVAR (current_buffer, overwrite_mode), Qnil,
5600 doc: /* Non-nil if self-insertion should replace existing text.
5601 The value should be one of `overwrite-mode-textual',
5602 `overwrite-mode-binary', or nil.
5603 If it is `overwrite-mode-textual', self-insertion still
5604 inserts at the end of a line, and inserts when point is before a tab,
5605 until the tab is filled in.
5606 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too. */);
5608 DEFVAR_PER_BUFFER ("buffer-display-table", &BVAR (current_buffer, display_table),
5609 Qnil,
5610 doc: /* Display table that controls display of the contents of current buffer.
5612 If this variable is nil, the value of `standard-display-table' is used.
5613 Each window can have its own, overriding display table, see
5614 `set-window-display-table' and `window-display-table'.
5616 The display table is a char-table created with `make-display-table'.
5617 A char-table is an array indexed by character codes. Normal array
5618 primitives `aref' and `aset' can be used to access elements of a char-table.
5620 Each of the char-table elements control how to display the corresponding
5621 text character: the element at index C in the table says how to display
5622 the character whose code is C. Each element should be a vector of
5623 characters or nil. The value nil means display the character in the
5624 default fashion; otherwise, the characters from the vector are delivered
5625 to the screen instead of the original character.
5627 For example, (aset buffer-display-table ?X [?Y]) tells Emacs
5628 to display a capital Y instead of each X character.
5630 In addition, a char-table has six extra slots to control the display of:
5632 the end of a truncated screen line (extra-slot 0, a single character);
5633 the end of a continued line (extra-slot 1, a single character);
5634 the escape character used to display character codes in octal
5635 (extra-slot 2, a single character);
5636 the character used as an arrow for control characters (extra-slot 3,
5637 a single character);
5638 the decoration indicating the presence of invisible lines (extra-slot 4,
5639 a vector of characters);
5640 the character used to draw the border between side-by-side windows
5641 (extra-slot 5, a single character).
5643 See also the functions `display-table-slot' and `set-display-table-slot'. */);
5645 DEFVAR_PER_BUFFER ("left-margin-width", &BVAR (current_buffer, left_margin_cols),
5646 Qnil,
5647 doc: /* *Width of left marginal area for display of a buffer.
5648 A value of nil means no marginal area. */);
5650 DEFVAR_PER_BUFFER ("right-margin-width", &BVAR (current_buffer, right_margin_cols),
5651 Qnil,
5652 doc: /* *Width of right marginal area for display of a buffer.
5653 A value of nil means no marginal area. */);
5655 DEFVAR_PER_BUFFER ("left-fringe-width", &BVAR (current_buffer, left_fringe_width),
5656 Qnil,
5657 doc: /* *Width of this buffer's left fringe (in pixels).
5658 A value of 0 means no left fringe is shown in this buffer's window.
5659 A value of nil means to use the left fringe width from the window's frame. */);
5661 DEFVAR_PER_BUFFER ("right-fringe-width", &BVAR (current_buffer, right_fringe_width),
5662 Qnil,
5663 doc: /* *Width of this buffer's right fringe (in pixels).
5664 A value of 0 means no right fringe is shown in this buffer's window.
5665 A value of nil means to use the right fringe width from the window's frame. */);
5667 DEFVAR_PER_BUFFER ("fringes-outside-margins", &BVAR (current_buffer, fringes_outside_margins),
5668 Qnil,
5669 doc: /* *Non-nil means to display fringes outside display margins.
5670 A value of nil means to display fringes between margins and buffer text. */);
5672 DEFVAR_PER_BUFFER ("scroll-bar-width", &BVAR (current_buffer, scroll_bar_width),
5673 Qnil,
5674 doc: /* *Width of this buffer's scroll bars in pixels.
5675 A value of nil means to use the scroll bar width from the window's frame. */);
5677 DEFVAR_PER_BUFFER ("vertical-scroll-bar", &BVAR (current_buffer, vertical_scroll_bar_type),
5678 Qnil,
5679 doc: /* *Position of this buffer's vertical scroll bar.
5680 The value takes effect whenever you tell a window to display this buffer;
5681 for instance, with `set-window-buffer' or when `display-buffer' displays it.
5683 A value of `left' or `right' means put the vertical scroll bar at that side
5684 of the window; a value of nil means don't show any vertical scroll bars.
5685 A value of t (the default) means do whatever the window's frame specifies. */);
5687 DEFVAR_PER_BUFFER ("indicate-empty-lines",
5688 &BVAR (current_buffer, indicate_empty_lines), Qnil,
5689 doc: /* *Visually indicate empty lines after the buffer end.
5690 If non-nil, a bitmap is displayed in the left fringe of a window on
5691 window-systems. */);
5693 DEFVAR_PER_BUFFER ("indicate-buffer-boundaries",
5694 &BVAR (current_buffer, indicate_buffer_boundaries), Qnil,
5695 doc: /* *Visually indicate buffer boundaries and scrolling.
5696 If non-nil, the first and last line of the buffer are marked in the fringe
5697 of a window on window-systems with angle bitmaps, or if the window can be
5698 scrolled, the top and bottom line of the window are marked with up and down
5699 arrow bitmaps.
5701 If value is a symbol `left' or `right', both angle and arrow bitmaps
5702 are displayed in the left or right fringe, resp. Any other value
5703 that doesn't look like an alist means display the angle bitmaps in
5704 the left fringe but no arrows.
5706 You can exercise more precise control by using an alist as the
5707 value. Each alist element (INDICATOR . POSITION) specifies
5708 where to show one of the indicators. INDICATOR is one of `top',
5709 `bottom', `up', `down', or t, which specifies the default position,
5710 and POSITION is one of `left', `right', or nil, meaning do not show
5711 this indicator.
5713 For example, ((top . left) (t . right)) places the top angle bitmap in
5714 left fringe, the bottom angle bitmap in right fringe, and both arrow
5715 bitmaps in right fringe. To show just the angle bitmaps in the left
5716 fringe, but no arrow bitmaps, use ((top . left) (bottom . left)). */);
5718 DEFVAR_PER_BUFFER ("fringe-indicator-alist",
5719 &BVAR (current_buffer, fringe_indicator_alist), Qnil,
5720 doc: /* *Mapping from logical to physical fringe indicator bitmaps.
5721 The value is an alist where each element (INDICATOR . BITMAPS)
5722 specifies the fringe bitmaps used to display a specific logical
5723 fringe indicator.
5725 INDICATOR specifies the logical indicator type which is one of the
5726 following symbols: `truncation' , `continuation', `overlay-arrow',
5727 `top', `bottom', `top-bottom', `up', `down', empty-line', or `unknown'.
5729 BITMAPS is a list of symbols (LEFT RIGHT [LEFT1 RIGHT1]) which specifies
5730 the actual bitmap shown in the left or right fringe for the logical
5731 indicator. LEFT and RIGHT are the bitmaps shown in the left and/or
5732 right fringe for the specific indicator. The LEFT1 or RIGHT1 bitmaps
5733 are used only for the `bottom' and `top-bottom' indicators when the
5734 last (only) line has no final newline. BITMAPS may also be a single
5735 symbol which is used in both left and right fringes. */);
5737 DEFVAR_PER_BUFFER ("fringe-cursor-alist",
5738 &BVAR (current_buffer, fringe_cursor_alist), Qnil,
5739 doc: /* *Mapping from logical to physical fringe cursor bitmaps.
5740 The value is an alist where each element (CURSOR . BITMAP)
5741 specifies the fringe bitmaps used to display a specific logical
5742 cursor type in the fringe.
5744 CURSOR specifies the logical cursor type which is one of the following
5745 symbols: `box' , `hollow', `bar', `hbar', or `hollow-small'. The last
5746 one is used to show a hollow cursor on narrow lines display lines
5747 where the normal hollow cursor will not fit.
5749 BITMAP is the corresponding fringe bitmap shown for the logical
5750 cursor type. */);
5752 DEFVAR_PER_BUFFER ("scroll-up-aggressively",
5753 &BVAR (current_buffer, scroll_up_aggressively), Qnil,
5754 doc: /* How far to scroll windows upward.
5755 If you move point off the bottom, the window scrolls automatically.
5756 This variable controls how far it scrolls. The value nil, the default,
5757 means scroll to center point. A fraction means scroll to put point
5758 that fraction of the window's height from the bottom of the window.
5759 When the value is 0.0, point goes at the bottom line, which in the
5760 simple case that you moved off with C-f means scrolling just one line.
5761 1.0 means point goes at the top, so that in that simple case, the
5762 window scrolls by a full window height. Meaningful values are
5763 between 0.0 and 1.0, inclusive. */);
5765 DEFVAR_PER_BUFFER ("scroll-down-aggressively",
5766 &BVAR (current_buffer, scroll_down_aggressively), Qnil,
5767 doc: /* How far to scroll windows downward.
5768 If you move point off the top, the window scrolls automatically.
5769 This variable controls how far it scrolls. The value nil, the default,
5770 means scroll to center point. A fraction means scroll to put point
5771 that fraction of the window's height from the top of the window.
5772 When the value is 0.0, point goes at the top line, which in the
5773 simple case that you moved off with C-b means scrolling just one line.
5774 1.0 means point goes at the bottom, so that in that simple case, the
5775 window scrolls by a full window height. Meaningful values are
5776 between 0.0 and 1.0, inclusive. */);
5778 /*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
5779 "Don't ask.");
5782 DEFVAR_LISP ("before-change-functions", Vbefore_change_functions,
5783 doc: /* List of functions to call before each text change.
5784 Two arguments are passed to each function: the positions of
5785 the beginning and end of the range of old text to be changed.
5786 \(For an insertion, the beginning and end are at the same place.)
5787 No information is given about the length of the text after the change.
5789 Buffer changes made while executing the `before-change-functions'
5790 don't call any before-change or after-change functions.
5791 That's because `inhibit-modification-hooks' is temporarily set non-nil.
5793 If an unhandled error happens in running these functions,
5794 the variable's value remains nil. That prevents the error
5795 from happening repeatedly and making Emacs nonfunctional. */);
5796 Vbefore_change_functions = Qnil;
5798 DEFVAR_LISP ("after-change-functions", Vafter_change_functions,
5799 doc: /* List of functions to call after each text change.
5800 Three arguments are passed to each function: the positions of
5801 the beginning and end of the range of changed text,
5802 and the length in bytes of the pre-change text replaced by that range.
5803 \(For an insertion, the pre-change length is zero;
5804 for a deletion, that length is the number of bytes deleted,
5805 and the post-change beginning and end are at the same place.)
5807 Buffer changes made while executing the `after-change-functions'
5808 don't call any before-change or after-change functions.
5809 That's because `inhibit-modification-hooks' is temporarily set non-nil.
5811 If an unhandled error happens in running these functions,
5812 the variable's value remains nil. That prevents the error
5813 from happening repeatedly and making Emacs nonfunctional. */);
5814 Vafter_change_functions = Qnil;
5816 DEFVAR_LISP ("first-change-hook", Vfirst_change_hook,
5817 doc: /* A list of functions to call before changing a buffer which is unmodified.
5818 The functions are run using the `run-hooks' function. */);
5819 Vfirst_change_hook = Qnil;
5821 DEFVAR_PER_BUFFER ("buffer-undo-list", &BVAR (current_buffer, undo_list), Qnil,
5822 doc: /* List of undo entries in current buffer.
5823 Recent changes come first; older changes follow newer.
5825 An entry (BEG . END) represents an insertion which begins at
5826 position BEG and ends at position END.
5828 An entry (TEXT . POSITION) represents the deletion of the string TEXT
5829 from (abs POSITION). If POSITION is positive, point was at the front
5830 of the text being deleted; if negative, point was at the end.
5832 An entry (t HIGH . LOW) indicates that the buffer previously had
5833 \"unmodified\" status. HIGH and LOW are the high and low 16-bit portions
5834 of the visited file's modification time, as of that time. If the
5835 modification time of the most recent save is different, this entry is
5836 obsolete.
5838 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property
5839 was modified between BEG and END. PROPERTY is the property name,
5840 and VALUE is the old value.
5842 An entry (apply FUN-NAME . ARGS) means undo the change with
5843 \(apply FUN-NAME ARGS).
5845 An entry (apply DELTA BEG END FUN-NAME . ARGS) supports selective undo
5846 in the active region. BEG and END is the range affected by this entry
5847 and DELTA is the number of bytes added or deleted in that range by
5848 this change.
5850 An entry (MARKER . DISTANCE) indicates that the marker MARKER
5851 was adjusted in position by the offset DISTANCE (an integer).
5853 An entry of the form POSITION indicates that point was at the buffer
5854 location given by the integer. Undoing an entry of this form places
5855 point at POSITION.
5857 Entries with value `nil' mark undo boundaries. The undo command treats
5858 the changes between two undo boundaries as a single step to be undone.
5860 If the value of the variable is t, undo information is not recorded. */);
5862 DEFVAR_PER_BUFFER ("mark-active", &BVAR (current_buffer, mark_active), Qnil,
5863 doc: /* Non-nil means the mark and region are currently active in this buffer. */);
5865 DEFVAR_PER_BUFFER ("cache-long-line-scans", &BVAR (current_buffer, cache_long_line_scans), Qnil,
5866 doc: /* Non-nil means that Emacs should use caches to handle long lines more quickly.
5868 Normally, the line-motion functions work by scanning the buffer for
5869 newlines. Columnar operations (like `move-to-column' and
5870 `compute-motion') also work by scanning the buffer, summing character
5871 widths as they go. This works well for ordinary text, but if the
5872 buffer's lines are very long (say, more than 500 characters), these
5873 motion functions will take longer to execute. Emacs may also take
5874 longer to update the display.
5876 If `cache-long-line-scans' is non-nil, these motion functions cache the
5877 results of their scans, and consult the cache to avoid rescanning
5878 regions of the buffer until the text is modified. The caches are most
5879 beneficial when they prevent the most searching---that is, when the
5880 buffer contains long lines and large regions of characters with the
5881 same, fixed screen width.
5883 When `cache-long-line-scans' is non-nil, processing short lines will
5884 become slightly slower (because of the overhead of consulting the
5885 cache), and the caches will use memory roughly proportional to the
5886 number of newlines and characters whose screen width varies.
5888 The caches require no explicit maintenance; their accuracy is
5889 maintained internally by the Emacs primitives. Enabling or disabling
5890 the cache should not affect the behavior of any of the motion
5891 functions; it should only affect their performance. */);
5893 DEFVAR_PER_BUFFER ("point-before-scroll", &BVAR (current_buffer, point_before_scroll), Qnil,
5894 doc: /* Value of point before the last series of scroll operations, or nil. */);
5896 DEFVAR_PER_BUFFER ("buffer-file-format", &BVAR (current_buffer, file_format), Qnil,
5897 doc: /* List of formats to use when saving this buffer.
5898 Formats are defined by `format-alist'. This variable is
5899 set when a file is visited. */);
5901 DEFVAR_PER_BUFFER ("buffer-auto-save-file-format",
5902 &BVAR (current_buffer, auto_save_file_format), Qnil,
5903 doc: /* *Format in which to write auto-save files.
5904 Should be a list of symbols naming formats that are defined in `format-alist'.
5905 If it is t, which is the default, auto-save files are written in the
5906 same format as a regular save would use. */);
5908 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
5909 &BVAR (current_buffer, invisibility_spec), Qnil,
5910 doc: /* Invisibility spec of this buffer.
5911 The default is t, which means that text is invisible
5912 if it has a non-nil `invisible' property.
5913 If the value is a list, a text character is invisible if its `invisible'
5914 property is an element in that list (or is a list with members in common).
5915 If an element is a cons cell of the form (PROP . ELLIPSIS),
5916 then characters with property value PROP are invisible,
5917 and they have an ellipsis as well if ELLIPSIS is non-nil. */);
5919 DEFVAR_PER_BUFFER ("buffer-display-count",
5920 &BVAR (current_buffer, display_count), Qnil,
5921 doc: /* A number incremented each time this buffer is displayed in a window.
5922 The function `set-window-buffer' increments it. */);
5924 DEFVAR_PER_BUFFER ("buffer-display-time",
5925 &BVAR (current_buffer, display_time), Qnil,
5926 doc: /* Time stamp updated each time this buffer is displayed in a window.
5927 The function `set-window-buffer' updates this variable
5928 to the value obtained by calling `current-time'.
5929 If the buffer has never been shown in a window, the value is nil. */);
5931 DEFVAR_LISP ("transient-mark-mode", Vtransient_mark_mode,
5932 doc: /* Non-nil if Transient Mark mode is enabled.
5933 See the command `transient-mark-mode' for a description of this minor mode.
5935 Non-nil also enables highlighting of the region whenever the mark is active.
5936 The variable `highlight-nonselected-windows' controls whether to highlight
5937 all windows or just the selected window.
5939 Lisp programs may give this variable certain special values:
5941 - A value of `lambda' enables Transient Mark mode temporarily.
5942 It is disabled again after any subsequent action that would
5943 normally deactivate the mark (e.g. buffer modification).
5945 - A value of (only . OLDVAL) enables Transient Mark mode
5946 temporarily. After any subsequent point motion command that is
5947 not shift-translated, or any other action that would normally
5948 deactivate the mark (e.g. buffer modification), the value of
5949 `transient-mark-mode' is set to OLDVAL. */);
5950 Vtransient_mark_mode = Qnil;
5952 DEFVAR_LISP ("inhibit-read-only", Vinhibit_read_only,
5953 doc: /* *Non-nil means disregard read-only status of buffers or characters.
5954 If the value is t, disregard `buffer-read-only' and all `read-only'
5955 text properties. If the value is a list, disregard `buffer-read-only'
5956 and disregard a `read-only' text property if the property value
5957 is a member of the list. */);
5958 Vinhibit_read_only = Qnil;
5960 DEFVAR_PER_BUFFER ("cursor-type", &BVAR (current_buffer, cursor_type), Qnil,
5961 doc: /* Cursor to use when this buffer is in the selected window.
5962 Values are interpreted as follows:
5964 t use the cursor specified for the frame
5965 nil don't display a cursor
5966 box display a filled box cursor
5967 hollow display a hollow box cursor
5968 bar display a vertical bar cursor with default width
5969 (bar . WIDTH) display a vertical bar cursor with width WIDTH
5970 hbar display a horizontal bar cursor with default height
5971 (hbar . HEIGHT) display a horizontal bar cursor with height HEIGHT
5972 ANYTHING ELSE display a hollow box cursor
5974 When the buffer is displayed in a non-selected window, the
5975 cursor's appearance is instead controlled by the variable
5976 `cursor-in-non-selected-windows'. */);
5978 DEFVAR_PER_BUFFER ("line-spacing",
5979 &BVAR (current_buffer, extra_line_spacing), Qnil,
5980 doc: /* Additional space to put between lines when displaying a buffer.
5981 The space is measured in pixels, and put below lines on graphic displays,
5982 see `display-graphic-p'.
5983 If value is a floating point number, it specifies the spacing relative
5984 to the default frame line height. A value of nil means add no extra space. */);
5986 DEFVAR_PER_BUFFER ("cursor-in-non-selected-windows",
5987 &BVAR (current_buffer, cursor_in_non_selected_windows), Qnil,
5988 doc: /* *Non-nil means show a cursor in non-selected windows.
5989 If nil, only shows a cursor in the selected window.
5990 If t, displays a cursor related to the usual cursor type
5991 \(a solid box becomes hollow, a bar becomes a narrower bar).
5992 You can also specify the cursor type as in the `cursor-type' variable.
5993 Use Custom to set this variable and update the display." */);
5995 DEFVAR_LISP ("kill-buffer-query-functions", Vkill_buffer_query_functions,
5996 doc: /* List of functions called with no args to query before killing a buffer.
5997 The buffer being killed will be current while the functions are running.
5998 If any of them returns nil, the buffer is not killed. */);
5999 Vkill_buffer_query_functions = Qnil;
6001 DEFVAR_LISP ("change-major-mode-hook", Vchange_major_mode_hook,
6002 doc: /* Normal hook run before changing the major mode of a buffer.
6003 The function `kill-all-local-variables' runs this before doing anything else. */);
6004 Vchange_major_mode_hook = Qnil;
6005 DEFSYM (Qchange_major_mode_hook, "change-major-mode-hook");
6007 DEFVAR_LISP ("buffer-list-update-hook", Vbuffer_list_update_hook,
6008 doc: /* Hook run when the buffer list changes.
6009 Functions running this hook are `get-buffer-create',
6010 `make-indirect-buffer', `rename-buffer', `kill-buffer',
6011 `record-buffer' and `unrecord-buffer'. */);
6012 Vbuffer_list_update_hook = Qnil;
6013 DEFSYM (Qbuffer_list_update_hook, "buffer-list-update-hook");
6015 defsubr (&Sbuffer_live_p);
6016 defsubr (&Sbuffer_list);
6017 defsubr (&Sget_buffer);
6018 defsubr (&Sget_file_buffer);
6019 defsubr (&Sget_buffer_create);
6020 defsubr (&Smake_indirect_buffer);
6021 defsubr (&Sgenerate_new_buffer_name);
6022 defsubr (&Sbuffer_name);
6023 /*defsubr (&Sbuffer_number);*/
6024 defsubr (&Sbuffer_file_name);
6025 defsubr (&Sbuffer_base_buffer);
6026 defsubr (&Sbuffer_local_value);
6027 defsubr (&Sbuffer_local_variables);
6028 defsubr (&Sbuffer_modified_p);
6029 defsubr (&Sset_buffer_modified_p);
6030 defsubr (&Sbuffer_modified_tick);
6031 defsubr (&Sbuffer_chars_modified_tick);
6032 defsubr (&Srename_buffer);
6033 defsubr (&Sother_buffer);
6034 defsubr (&Sbuffer_enable_undo);
6035 defsubr (&Skill_buffer);
6036 defsubr (&Srecord_buffer);
6037 defsubr (&Sunrecord_buffer);
6038 defsubr (&Sset_buffer_major_mode);
6039 defsubr (&Scurrent_buffer);
6040 defsubr (&Sset_buffer);
6041 defsubr (&Sbarf_if_buffer_read_only);
6042 defsubr (&Serase_buffer);
6043 defsubr (&Sbuffer_swap_text);
6044 defsubr (&Sset_buffer_multibyte);
6045 defsubr (&Skill_all_local_variables);
6047 defsubr (&Soverlayp);
6048 defsubr (&Smake_overlay);
6049 defsubr (&Sdelete_overlay);
6050 defsubr (&Smove_overlay);
6051 defsubr (&Soverlay_start);
6052 defsubr (&Soverlay_end);
6053 defsubr (&Soverlay_buffer);
6054 defsubr (&Soverlay_properties);
6055 defsubr (&Soverlays_at);
6056 defsubr (&Soverlays_in);
6057 defsubr (&Snext_overlay_change);
6058 defsubr (&Sprevious_overlay_change);
6059 defsubr (&Soverlay_recenter);
6060 defsubr (&Soverlay_lists);
6061 defsubr (&Soverlay_get);
6062 defsubr (&Soverlay_put);
6063 defsubr (&Srestore_buffer_modified_p);
6066 void
6067 keys_of_buffer (void)
6069 initial_define_key (control_x_map, 'b', "switch-to-buffer");
6070 initial_define_key (control_x_map, 'k', "kill-buffer");
6072 /* This must not be in syms_of_buffer, because Qdisabled is not
6073 initialized when that function gets called. */
6074 Fput (intern_c_string ("erase-buffer"), Qdisabled, Qt);