Merge from trunk.
[emacs.git] / src / buffer.c
blobb176bfed3febf70809943716faab9ce5278262e6
1 /* Buffer manipulation primitives for GNU Emacs.
3 Copyright (C) 1985-1989, 1993-1995, 1997-2012 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 *, ptrdiff_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 *, ptrdiff_t, ptrdiff_t);
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'. */
364 b->text->inhibit_shrinking = 0;
366 b->newline_cache = 0;
367 b->width_run_cache = 0;
368 BVAR (b, width_table) = Qnil;
369 b->prevent_redisplay_optimizations_p = 1;
371 /* Put this on the chain of all buffers including killed ones. */
372 b->header.next.buffer = all_buffers;
373 all_buffers = b;
375 /* An ordinary buffer normally doesn't need markers
376 to handle BEGV and ZV. */
377 BVAR (b, pt_marker) = Qnil;
378 BVAR (b, begv_marker) = Qnil;
379 BVAR (b, zv_marker) = Qnil;
381 name = Fcopy_sequence (buffer_or_name);
382 STRING_SET_INTERVALS (name, NULL_INTERVAL);
383 BVAR (b, name) = name;
385 BVAR (b, undo_list) = (SREF (name, 0) != ' ') ? Qnil : Qt;
387 reset_buffer (b);
388 reset_buffer_local_variables (b, 1);
390 BVAR (b, mark) = Fmake_marker ();
391 BUF_MARKERS (b) = NULL;
392 BVAR (b, name) = name;
394 /* Put this in the alist of all live buffers. */
395 XSETBUFFER (buffer, b);
396 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buffer), Qnil));
397 /* And run buffer-list-update-hook. */
398 if (!NILP (Vrun_hooks))
399 call1 (Vrun_hooks, Qbuffer_list_update_hook);
401 /* An error in calling the function here (should someone redefine it)
402 can lead to infinite regress until you run out of stack. rms
403 says that's not worth protecting against. */
404 if (!NILP (Ffboundp (Qucs_set_table_for_input)))
405 /* buffer is on buffer-alist, so no gcpro. */
406 call1 (Qucs_set_table_for_input, buffer);
408 return buffer;
412 /* Return a list of overlays which is a copy of the overlay list
413 LIST, but for buffer B. */
415 static struct Lisp_Overlay *
416 copy_overlays (struct buffer *b, struct Lisp_Overlay *list)
418 Lisp_Object buffer;
419 struct Lisp_Overlay *result = NULL, *tail = NULL;
421 XSETBUFFER (buffer, b);
423 for (; list; list = list->next)
425 Lisp_Object overlay, start, end, old_overlay;
426 ptrdiff_t charpos;
428 XSETMISC (old_overlay, list);
429 charpos = marker_position (OVERLAY_START (old_overlay));
430 start = Fmake_marker ();
431 Fset_marker (start, make_number (charpos), buffer);
432 XMARKER (start)->insertion_type
433 = XMARKER (OVERLAY_START (old_overlay))->insertion_type;
435 charpos = marker_position (OVERLAY_END (old_overlay));
436 end = Fmake_marker ();
437 Fset_marker (end, make_number (charpos), buffer);
438 XMARKER (end)->insertion_type
439 = XMARKER (OVERLAY_END (old_overlay))->insertion_type;
441 overlay = allocate_misc ();
442 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
443 OVERLAY_START (overlay) = start;
444 OVERLAY_END (overlay) = end;
445 OVERLAY_PLIST (overlay) = Fcopy_sequence (OVERLAY_PLIST (old_overlay));
446 XOVERLAY (overlay)->next = NULL;
448 if (tail)
449 tail = tail->next = XOVERLAY (overlay);
450 else
451 result = tail = XOVERLAY (overlay);
454 return result;
458 /* Clone per-buffer values of buffer FROM.
460 Buffer TO gets the same per-buffer values as FROM, with the
461 following exceptions: (1) TO's name is left untouched, (2) markers
462 are copied and made to refer to TO, and (3) overlay lists are
463 copied. */
465 static void
466 clone_per_buffer_values (struct buffer *from, struct buffer *to)
468 Lisp_Object to_buffer;
469 int offset;
471 XSETBUFFER (to_buffer, to);
473 /* buffer-local Lisp variables start at `undo_list',
474 tho only the ones from `name' on are GC'd normally. */
475 for (offset = PER_BUFFER_VAR_OFFSET (FIRST_FIELD_PER_BUFFER);
476 offset <= PER_BUFFER_VAR_OFFSET (LAST_FIELD_PER_BUFFER);
477 offset += sizeof (Lisp_Object))
479 Lisp_Object obj;
481 /* Don't touch the `name' which should be unique for every buffer. */
482 if (offset == PER_BUFFER_VAR_OFFSET (name))
483 continue;
485 obj = PER_BUFFER_VALUE (from, offset);
486 if (MARKERP (obj) && XMARKER (obj)->buffer == from)
488 struct Lisp_Marker *m = XMARKER (obj);
489 obj = Fmake_marker ();
490 XMARKER (obj)->insertion_type = m->insertion_type;
491 set_marker_both (obj, to_buffer, m->charpos, m->bytepos);
494 PER_BUFFER_VALUE (to, offset) = obj;
497 memcpy (to->local_flags, from->local_flags, sizeof to->local_flags);
499 to->overlays_before = copy_overlays (to, from->overlays_before);
500 to->overlays_after = copy_overlays (to, from->overlays_after);
502 /* Get (a copy of) the alist of Lisp-level local variables of FROM
503 and install that in TO. */
504 BVAR (to, local_var_alist) = buffer_lisp_local_variables (from);
508 /* If buffer B has markers to record PT, BEGV and ZV when it is not
509 current, update these markers. */
511 static void
512 record_buffer_markers (struct buffer *b)
514 if (! NILP (BVAR (b, pt_marker)))
516 Lisp_Object buffer;
518 eassert (!NILP (BVAR (b, begv_marker)));
519 eassert (!NILP (BVAR (b, zv_marker)));
521 XSETBUFFER (buffer, b);
522 set_marker_both (BVAR (b, pt_marker), buffer, b->pt, b->pt_byte);
523 set_marker_both (BVAR (b, begv_marker), buffer, b->begv, b->begv_byte);
524 set_marker_both (BVAR (b, zv_marker), buffer, b->zv, b->zv_byte);
529 /* If buffer B has markers to record PT, BEGV and ZV when it is not
530 current, fetch these values into B->begv etc. */
532 static void
533 fetch_buffer_markers (struct buffer *b)
535 if (! NILP (BVAR (b, pt_marker)))
537 Lisp_Object m;
539 eassert (!NILP (BVAR (b, begv_marker)));
540 eassert (!NILP (BVAR (b, zv_marker)));
542 m = BVAR (b, pt_marker);
543 SET_BUF_PT_BOTH (b, marker_position (m), marker_byte_position (m));
545 m = BVAR (b, begv_marker);
546 SET_BUF_BEGV_BOTH (b, marker_position (m), marker_byte_position (m));
548 m = BVAR (b, zv_marker);
549 SET_BUF_ZV_BOTH (b, marker_position (m), marker_byte_position (m));
554 DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer,
555 2, 3,
556 "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
557 doc: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
558 BASE-BUFFER should be a live buffer, or the name of an existing buffer.
559 NAME should be a string which is not the name of an existing buffer.
560 Optional argument CLONE non-nil means preserve BASE-BUFFER's state,
561 such as major and minor modes, in the indirect buffer.
562 CLONE nil means the indirect buffer's state is reset to default values. */)
563 (Lisp_Object base_buffer, Lisp_Object name, Lisp_Object clone)
565 Lisp_Object buf, tem;
566 struct buffer *b;
568 CHECK_STRING (name);
569 buf = Fget_buffer (name);
570 if (!NILP (buf))
571 error ("Buffer name `%s' is in use", SDATA (name));
573 tem = base_buffer;
574 base_buffer = Fget_buffer (base_buffer);
575 if (NILP (base_buffer))
576 error ("No such buffer: `%s'", SDATA (tem));
577 if (NILP (BVAR (XBUFFER (base_buffer), name)))
578 error ("Base buffer has been killed");
580 if (SCHARS (name) == 0)
581 error ("Empty string for buffer name is not allowed");
583 b = allocate_buffer ();
585 b->base_buffer = (XBUFFER (base_buffer)->base_buffer
586 ? XBUFFER (base_buffer)->base_buffer
587 : XBUFFER (base_buffer));
589 /* Use the base buffer's text object. */
590 b->text = b->base_buffer->text;
592 b->pt = b->base_buffer->pt;
593 b->begv = b->base_buffer->begv;
594 b->zv = b->base_buffer->zv;
595 b->pt_byte = b->base_buffer->pt_byte;
596 b->begv_byte = b->base_buffer->begv_byte;
597 b->zv_byte = b->base_buffer->zv_byte;
599 b->newline_cache = 0;
600 b->width_run_cache = 0;
601 BVAR (b, width_table) = Qnil;
603 /* Put this on the chain of all buffers including killed ones. */
604 b->header.next.buffer = all_buffers;
605 all_buffers = b;
607 name = Fcopy_sequence (name);
608 STRING_SET_INTERVALS (name, NULL_INTERVAL);
609 BVAR (b, name) = name;
611 reset_buffer (b);
612 reset_buffer_local_variables (b, 1);
614 /* Put this in the alist of all live buffers. */
615 XSETBUFFER (buf, b);
616 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
618 BVAR (b, mark) = Fmake_marker ();
619 BVAR (b, name) = name;
621 /* The multibyte status belongs to the base buffer. */
622 BVAR (b, enable_multibyte_characters) = BVAR (b->base_buffer, enable_multibyte_characters);
624 /* Make sure the base buffer has markers for its narrowing. */
625 if (NILP (BVAR (b->base_buffer, pt_marker)))
627 eassert (NILP (BVAR (b->base_buffer, begv_marker)));
628 eassert (NILP (BVAR (b->base_buffer, zv_marker)));
630 BVAR (b->base_buffer, pt_marker) = Fmake_marker ();
631 set_marker_both (BVAR (b->base_buffer, pt_marker), base_buffer,
632 b->base_buffer->pt,
633 b->base_buffer->pt_byte);
635 BVAR (b->base_buffer, begv_marker) = Fmake_marker ();
636 set_marker_both (BVAR (b->base_buffer, begv_marker), base_buffer,
637 b->base_buffer->begv,
638 b->base_buffer->begv_byte);
640 BVAR (b->base_buffer, zv_marker) = Fmake_marker ();
641 set_marker_both (BVAR (b->base_buffer, zv_marker), base_buffer,
642 b->base_buffer->zv,
643 b->base_buffer->zv_byte);
644 XMARKER (BVAR (b->base_buffer, zv_marker))->insertion_type = 1;
647 if (NILP (clone))
649 /* Give the indirect buffer markers for its narrowing. */
650 BVAR (b, pt_marker) = Fmake_marker ();
651 set_marker_both (BVAR (b, pt_marker), buf, b->pt, b->pt_byte);
652 BVAR (b, begv_marker) = Fmake_marker ();
653 set_marker_both (BVAR (b, begv_marker), buf, b->begv, b->begv_byte);
654 BVAR (b, zv_marker) = Fmake_marker ();
655 set_marker_both (BVAR (b, zv_marker), buf, b->zv, b->zv_byte);
656 XMARKER (BVAR (b, zv_marker))->insertion_type = 1;
658 else
660 struct buffer *old_b = current_buffer;
662 clone_per_buffer_values (b->base_buffer, b);
663 BVAR (b, filename) = Qnil;
664 BVAR (b, file_truename) = Qnil;
665 BVAR (b, display_count) = make_number (0);
666 BVAR (b, backed_up) = Qnil;
667 BVAR (b, auto_save_file_name) = Qnil;
668 set_buffer_internal_1 (b);
669 Fset (intern ("buffer-save-without-query"), Qnil);
670 Fset (intern ("buffer-file-number"), Qnil);
671 Fset (intern ("buffer-stale-function"), Qnil);
672 set_buffer_internal_1 (old_b);
675 /* Run buffer-list-update-hook. */
676 if (!NILP (Vrun_hooks))
677 call1 (Vrun_hooks, Qbuffer_list_update_hook);
679 return buf;
682 void
683 delete_all_overlays (struct buffer *b)
685 Lisp_Object overlay;
687 /* `reset_buffer' blindly sets the list of overlays to NULL, so we
688 have to empty the list, otherwise we end up with overlays that
689 think they belong to this buffer while the buffer doesn't know about
690 them any more. */
691 while (b->overlays_before)
693 XSETMISC (overlay, b->overlays_before);
694 Fdelete_overlay (overlay);
696 while (b->overlays_after)
698 XSETMISC (overlay, b->overlays_after);
699 Fdelete_overlay (overlay);
701 eassert (b->overlays_before == NULL);
702 eassert (b->overlays_after == NULL);
705 /* Reinitialize everything about a buffer except its name and contents
706 and local variables.
707 If called on an already-initialized buffer, the list of overlays
708 should be deleted before calling this function, otherwise we end up
709 with overlays that claim to belong to the buffer but the buffer
710 claims it doesn't belong to it. */
712 void
713 reset_buffer (register struct buffer *b)
715 BVAR (b, filename) = Qnil;
716 BVAR (b, file_truename) = Qnil;
717 BVAR (b, directory) = (current_buffer) ? BVAR (current_buffer, directory) : Qnil;
718 b->modtime = 0;
719 b->modtime_size = -1;
720 XSETFASTINT (BVAR (b, save_length), 0);
721 b->last_window_start = 1;
722 /* It is more conservative to start out "changed" than "unchanged". */
723 b->clip_changed = 0;
724 b->prevent_redisplay_optimizations_p = 1;
725 BVAR (b, backed_up) = Qnil;
726 BUF_AUTOSAVE_MODIFF (b) = 0;
727 b->auto_save_failure_time = 0;
728 BVAR (b, auto_save_file_name) = Qnil;
729 BVAR (b, read_only) = Qnil;
730 b->overlays_before = NULL;
731 b->overlays_after = NULL;
732 b->overlay_center = BEG;
733 BVAR (b, mark_active) = Qnil;
734 BVAR (b, point_before_scroll) = Qnil;
735 BVAR (b, file_format) = Qnil;
736 BVAR (b, auto_save_file_format) = Qt;
737 BVAR (b, last_selected_window) = Qnil;
738 XSETINT (BVAR (b, display_count), 0);
739 BVAR (b, display_time) = Qnil;
740 BVAR (b, enable_multibyte_characters) = BVAR (&buffer_defaults, enable_multibyte_characters);
741 BVAR (b, cursor_type) = BVAR (&buffer_defaults, cursor_type);
742 BVAR (b, extra_line_spacing) = BVAR (&buffer_defaults, extra_line_spacing);
744 b->display_error_modiff = 0;
747 /* Reset buffer B's local variables info.
748 Don't use this on a buffer that has already been in use;
749 it does not treat permanent locals consistently.
750 Instead, use Fkill_all_local_variables.
752 If PERMANENT_TOO is 1, then we reset permanent
753 buffer-local variables. If PERMANENT_TOO is 0,
754 we preserve those. */
756 static void
757 reset_buffer_local_variables (register struct buffer *b, int permanent_too)
759 register int offset;
760 int i;
762 /* Reset the major mode to Fundamental, together with all the
763 things that depend on the major mode.
764 default-major-mode is handled at a higher level.
765 We ignore it here. */
766 BVAR (b, major_mode) = Qfundamental_mode;
767 BVAR (b, keymap) = Qnil;
768 BVAR (b, mode_name) = QSFundamental;
769 BVAR (b, minor_modes) = Qnil;
771 /* If the standard case table has been altered and invalidated,
772 fix up its insides first. */
773 if (! (CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[0])
774 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[1])
775 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[2])))
776 Fset_standard_case_table (Vascii_downcase_table);
778 BVAR (b, downcase_table) = Vascii_downcase_table;
779 BVAR (b, upcase_table) = XCHAR_TABLE (Vascii_downcase_table)->extras[0];
780 BVAR (b, case_canon_table) = XCHAR_TABLE (Vascii_downcase_table)->extras[1];
781 BVAR (b, case_eqv_table) = XCHAR_TABLE (Vascii_downcase_table)->extras[2];
782 BVAR (b, invisibility_spec) = Qt;
784 /* Reset all (or most) per-buffer variables to their defaults. */
785 if (permanent_too)
786 BVAR (b, local_var_alist) = Qnil;
787 else
789 Lisp_Object tmp, prop, last = Qnil;
790 for (tmp = BVAR (b, local_var_alist); CONSP (tmp); tmp = XCDR (tmp))
791 if (!NILP (prop = Fget (XCAR (XCAR (tmp)), Qpermanent_local)))
793 /* If permanent-local, keep it. */
794 last = tmp;
795 if (EQ (prop, Qpermanent_local_hook))
797 /* This is a partially permanent hook variable.
798 Preserve only the elements that want to be preserved. */
799 Lisp_Object list, newlist;
800 list = XCDR (XCAR (tmp));
801 if (!CONSP (list))
802 newlist = list;
803 else
804 for (newlist = Qnil; CONSP (list); list = XCDR (list))
806 Lisp_Object elt = XCAR (list);
807 /* Preserve element ELT if it's t,
808 if it is a function with a `permanent-local-hook' property,
809 or if it's not a symbol. */
810 if (! SYMBOLP (elt)
811 || EQ (elt, Qt)
812 || !NILP (Fget (elt, Qpermanent_local_hook)))
813 newlist = Fcons (elt, newlist);
815 XSETCDR (XCAR (tmp), Fnreverse (newlist));
818 /* Delete this local variable. */
819 else if (NILP (last))
820 BVAR (b, local_var_alist) = XCDR (tmp);
821 else
822 XSETCDR (last, XCDR (tmp));
825 for (i = 0; i < last_per_buffer_idx; ++i)
826 if (permanent_too || buffer_permanent_local_flags[i] == 0)
827 SET_PER_BUFFER_VALUE_P (b, i, 0);
829 /* For each slot that has a default value,
830 copy that into the slot. */
832 /* buffer-local Lisp variables start at `undo_list',
833 tho only the ones from `name' on are GC'd normally. */
834 for (offset = PER_BUFFER_VAR_OFFSET (FIRST_FIELD_PER_BUFFER);
835 offset <= PER_BUFFER_VAR_OFFSET (LAST_FIELD_PER_BUFFER);
836 offset += sizeof (Lisp_Object))
838 int idx = PER_BUFFER_IDX (offset);
839 if ((idx > 0
840 && (permanent_too
841 || buffer_permanent_local_flags[idx] == 0)))
842 PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
846 /* We split this away from generate-new-buffer, because rename-buffer
847 and set-visited-file-name ought to be able to use this to really
848 rename the buffer properly. */
850 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name,
851 Sgenerate_new_buffer_name, 1, 2, 0,
852 doc: /* Return a string that is the name of no existing buffer based on NAME.
853 If there is no live buffer named NAME, then return NAME.
854 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
855 \(starting at 2) until an unused name is found, and then return that name.
856 Optional second argument IGNORE specifies a name that is okay to use (if
857 it is in the sequence to be tried) even if a buffer with that name exists. */)
858 (register Lisp_Object name, Lisp_Object ignore)
860 register Lisp_Object gentemp, tem;
861 ptrdiff_t count;
862 char number[INT_BUFSIZE_BOUND (ptrdiff_t) + sizeof "<>"];
864 CHECK_STRING (name);
866 tem = Fstring_equal (name, ignore);
867 if (!NILP (tem))
868 return name;
869 tem = Fget_buffer (name);
870 if (NILP (tem))
871 return name;
873 count = 1;
874 while (1)
876 sprintf (number, "<%"pD"d>", ++count);
877 gentemp = concat2 (name, build_string (number));
878 tem = Fstring_equal (gentemp, ignore);
879 if (!NILP (tem))
880 return gentemp;
881 tem = Fget_buffer (gentemp);
882 if (NILP (tem))
883 return gentemp;
888 DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
889 doc: /* Return the name of BUFFER, as a string.
890 BUFFER defaults to the current buffer.
891 Return nil if BUFFER has been killed. */)
892 (register Lisp_Object buffer)
894 if (NILP (buffer))
895 return BVAR (current_buffer, name);
896 CHECK_BUFFER (buffer);
897 return BVAR (XBUFFER (buffer), name);
900 DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
901 doc: /* Return name of file BUFFER is visiting, or nil if none.
902 No argument or nil as argument means use the current buffer. */)
903 (register Lisp_Object buffer)
905 if (NILP (buffer))
906 return BVAR (current_buffer, filename);
907 CHECK_BUFFER (buffer);
908 return BVAR (XBUFFER (buffer), filename);
911 DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
912 0, 1, 0,
913 doc: /* Return the base buffer of indirect buffer BUFFER.
914 If BUFFER is not indirect, return nil.
915 BUFFER defaults to the current buffer. */)
916 (register Lisp_Object buffer)
918 struct buffer *base;
919 Lisp_Object base_buffer;
921 if (NILP (buffer))
922 base = current_buffer->base_buffer;
923 else
925 CHECK_BUFFER (buffer);
926 base = XBUFFER (buffer)->base_buffer;
929 if (! base)
930 return Qnil;
931 XSETBUFFER (base_buffer, base);
932 return base_buffer;
935 DEFUN ("buffer-local-value", Fbuffer_local_value,
936 Sbuffer_local_value, 2, 2, 0,
937 doc: /* Return the value of VARIABLE in BUFFER.
938 If VARIABLE does not have a buffer-local binding in BUFFER, the value
939 is the default binding of the variable. */)
940 (register Lisp_Object variable, register Lisp_Object buffer)
942 register struct buffer *buf;
943 register Lisp_Object result;
944 struct Lisp_Symbol *sym;
946 CHECK_SYMBOL (variable);
947 CHECK_BUFFER (buffer);
948 buf = XBUFFER (buffer);
949 sym = XSYMBOL (variable);
951 start:
952 switch (sym->redirect)
954 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
955 case SYMBOL_PLAINVAL: result = SYMBOL_VAL (sym); break;
956 case SYMBOL_LOCALIZED:
957 { /* Look in local_var_alist. */
958 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
959 XSETSYMBOL (variable, sym); /* Update In case of aliasing. */
960 result = Fassoc (variable, BVAR (buf, local_var_alist));
961 if (!NILP (result))
963 if (blv->fwd)
964 { /* What binding is loaded right now? */
965 Lisp_Object current_alist_element = blv->valcell;
967 /* The value of the currently loaded binding is not
968 stored in it, but rather in the realvalue slot.
969 Store that value into the binding it belongs to
970 in case that is the one we are about to use. */
972 XSETCDR (current_alist_element,
973 do_symval_forwarding (blv->fwd));
975 /* Now get the (perhaps updated) value out of the binding. */
976 result = XCDR (result);
978 else
979 result = Fdefault_value (variable);
980 break;
982 case SYMBOL_FORWARDED:
984 union Lisp_Fwd *fwd = SYMBOL_FWD (sym);
985 if (BUFFER_OBJFWDP (fwd))
986 result = PER_BUFFER_VALUE (buf, XBUFFER_OBJFWD (fwd)->offset);
987 else
988 result = Fdefault_value (variable);
989 break;
991 default: abort ();
994 if (!EQ (result, Qunbound))
995 return result;
997 xsignal1 (Qvoid_variable, variable);
1000 /* Return an alist of the Lisp-level buffer-local bindings of
1001 buffer BUF. That is, don't include the variables maintained
1002 in special slots in the buffer object. */
1004 static Lisp_Object
1005 buffer_lisp_local_variables (struct buffer *buf)
1007 Lisp_Object result = Qnil;
1008 register Lisp_Object tail;
1009 for (tail = BVAR (buf, local_var_alist); CONSP (tail); tail = XCDR (tail))
1011 Lisp_Object val, elt;
1013 elt = XCAR (tail);
1015 /* Reference each variable in the alist in buf.
1016 If inquiring about the current buffer, this gets the current values,
1017 so store them into the alist so the alist is up to date.
1018 If inquiring about some other buffer, this swaps out any values
1019 for that buffer, making the alist up to date automatically. */
1020 val = find_symbol_value (XCAR (elt));
1021 /* Use the current buffer value only if buf is the current buffer. */
1022 if (buf != current_buffer)
1023 val = XCDR (elt);
1025 result = Fcons (Fcons (XCAR (elt), val), result);
1028 return result;
1031 DEFUN ("buffer-local-variables", Fbuffer_local_variables,
1032 Sbuffer_local_variables, 0, 1, 0,
1033 doc: /* Return an alist of variables that are buffer-local in BUFFER.
1034 Most elements look like (SYMBOL . VALUE), describing one variable.
1035 For a symbol that is locally unbound, just the symbol appears in the value.
1036 Note that storing new VALUEs in these elements doesn't change the variables.
1037 No argument or nil as argument means use current buffer as BUFFER. */)
1038 (register Lisp_Object buffer)
1040 register struct buffer *buf;
1041 register Lisp_Object result;
1043 if (NILP (buffer))
1044 buf = current_buffer;
1045 else
1047 CHECK_BUFFER (buffer);
1048 buf = XBUFFER (buffer);
1051 result = buffer_lisp_local_variables (buf);
1053 /* Add on all the variables stored in special slots. */
1055 int offset, idx;
1057 /* buffer-local Lisp variables start at `undo_list',
1058 tho only the ones from `name' on are GC'd normally. */
1059 for (offset = PER_BUFFER_VAR_OFFSET (FIRST_FIELD_PER_BUFFER);
1060 offset <= PER_BUFFER_VAR_OFFSET (LAST_FIELD_PER_BUFFER);
1061 /* sizeof EMACS_INT == sizeof Lisp_Object */
1062 offset += (sizeof (EMACS_INT)))
1064 idx = PER_BUFFER_IDX (offset);
1065 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
1066 && SYMBOLP (PER_BUFFER_SYMBOL (offset)))
1067 result = Fcons (Fcons (PER_BUFFER_SYMBOL (offset),
1068 PER_BUFFER_VALUE (buf, offset)),
1069 result);
1073 return result;
1076 DEFUN ("buffer-modified-p", Fbuffer_modified_p, Sbuffer_modified_p,
1077 0, 1, 0,
1078 doc: /* Return t if BUFFER was modified since its file was last read or saved.
1079 No argument or nil as argument means use current buffer as BUFFER. */)
1080 (register Lisp_Object buffer)
1082 register struct buffer *buf;
1083 if (NILP (buffer))
1084 buf = current_buffer;
1085 else
1087 CHECK_BUFFER (buffer);
1088 buf = XBUFFER (buffer);
1091 return BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf) ? Qt : Qnil;
1094 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p, Sset_buffer_modified_p,
1095 1, 1, 0,
1096 doc: /* Mark current buffer as modified or unmodified according to FLAG.
1097 A non-nil FLAG means mark the buffer modified. */)
1098 (register Lisp_Object flag)
1100 register int already;
1101 register Lisp_Object fn;
1102 Lisp_Object buffer, window;
1104 #ifdef CLASH_DETECTION
1105 /* If buffer becoming modified, lock the file.
1106 If buffer becoming unmodified, unlock the file. */
1108 fn = BVAR (current_buffer, file_truename);
1109 /* Test buffer-file-name so that binding it to nil is effective. */
1110 if (!NILP (fn) && ! NILP (BVAR (current_buffer, filename)))
1112 already = SAVE_MODIFF < MODIFF;
1113 if (!already && !NILP (flag))
1114 lock_file (fn);
1115 else if (already && NILP (flag))
1116 unlock_file (fn);
1118 #endif /* CLASH_DETECTION */
1120 /* Here we have a problem. SAVE_MODIFF is used here to encode
1121 buffer-modified-p (as SAVE_MODIFF<MODIFF) as well as
1122 recent-auto-save-p (as SAVE_MODIFF<auto_save_modified). So if we
1123 modify SAVE_MODIFF to affect one, we may affect the other
1124 as well.
1125 E.g. if FLAG is nil we need to set SAVE_MODIFF to MODIFF, but
1126 if SAVE_MODIFF<auto_save_modified that means we risk changing
1127 recent-auto-save-p from t to nil.
1128 Vice versa, if FLAG is non-nil and SAVE_MODIFF>=auto_save_modified
1129 we risk changing recent-auto-save-p from nil to t. */
1130 SAVE_MODIFF = (NILP (flag)
1131 /* FIXME: This unavoidably sets recent-auto-save-p to nil. */
1132 ? MODIFF
1133 /* Let's try to preserve recent-auto-save-p. */
1134 : SAVE_MODIFF < MODIFF ? SAVE_MODIFF
1135 /* If SAVE_MODIFF == auto_save_modified == MODIFF,
1136 we can either decrease SAVE_MODIFF and auto_save_modified
1137 or increase MODIFF. */
1138 : MODIFF++);
1140 /* Set update_mode_lines only if buffer is displayed in some window.
1141 Packages like jit-lock or lazy-lock preserve a buffer's modified
1142 state by recording/restoring the state around blocks of code.
1143 Setting update_mode_lines makes redisplay consider all windows
1144 (on all frames). Stealth fontification of buffers not displayed
1145 would incur additional redisplay costs if we'd set
1146 update_modes_lines unconditionally.
1148 Ideally, I think there should be another mechanism for fontifying
1149 buffers without "modifying" buffers, or redisplay should be
1150 smarter about updating the `*' in mode lines. --gerd */
1151 XSETBUFFER (buffer, current_buffer);
1152 window = Fget_buffer_window (buffer, Qt);
1153 if (WINDOWP (window))
1155 ++update_mode_lines;
1156 current_buffer->prevent_redisplay_optimizations_p = 1;
1159 return flag;
1162 DEFUN ("restore-buffer-modified-p", Frestore_buffer_modified_p,
1163 Srestore_buffer_modified_p, 1, 1, 0,
1164 doc: /* Like `set-buffer-modified-p', with a difference concerning redisplay.
1165 It is not ensured that mode lines will be updated to show the modified
1166 state of the current buffer. Use with care. */)
1167 (Lisp_Object flag)
1169 #ifdef CLASH_DETECTION
1170 Lisp_Object fn;
1172 /* If buffer becoming modified, lock the file.
1173 If buffer becoming unmodified, unlock the file. */
1175 fn = BVAR (current_buffer, file_truename);
1176 /* Test buffer-file-name so that binding it to nil is effective. */
1177 if (!NILP (fn) && ! NILP (BVAR (current_buffer, filename)))
1179 int already = SAVE_MODIFF < MODIFF;
1180 if (!already && !NILP (flag))
1181 lock_file (fn);
1182 else if (already && NILP (flag))
1183 unlock_file (fn);
1185 #endif /* CLASH_DETECTION */
1187 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1188 return flag;
1191 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick, Sbuffer_modified_tick,
1192 0, 1, 0,
1193 doc: /* Return BUFFER's tick counter, incremented for each change in text.
1194 Each buffer has a tick counter which is incremented each time the
1195 text in that buffer is changed. It wraps around occasionally.
1196 No argument or nil as argument means use current buffer as BUFFER. */)
1197 (register Lisp_Object buffer)
1199 register struct buffer *buf;
1200 if (NILP (buffer))
1201 buf = current_buffer;
1202 else
1204 CHECK_BUFFER (buffer);
1205 buf = XBUFFER (buffer);
1208 return make_number (BUF_MODIFF (buf));
1211 DEFUN ("buffer-chars-modified-tick", Fbuffer_chars_modified_tick,
1212 Sbuffer_chars_modified_tick, 0, 1, 0,
1213 doc: /* Return BUFFER's character-change tick counter.
1214 Each buffer has a character-change tick counter, which is set to the
1215 value of the buffer's tick counter \(see `buffer-modified-tick'), each
1216 time text in that buffer is inserted or deleted. By comparing the
1217 values returned by two individual calls of `buffer-chars-modified-tick',
1218 you can tell whether a character change occurred in that buffer in
1219 between these calls. No argument or nil as argument means use current
1220 buffer as BUFFER. */)
1221 (register Lisp_Object buffer)
1223 register struct buffer *buf;
1224 if (NILP (buffer))
1225 buf = current_buffer;
1226 else
1228 CHECK_BUFFER (buffer);
1229 buf = XBUFFER (buffer);
1232 return make_number (BUF_CHARS_MODIFF (buf));
1235 DEFUN ("rename-buffer", Frename_buffer, Srename_buffer, 1, 2,
1236 "(list (read-string \"Rename buffer (to new name): \" \
1237 nil 'buffer-name-history (buffer-name (current-buffer))) \
1238 current-prefix-arg)",
1239 doc: /* Change current buffer's name to NEWNAME (a string).
1240 If second arg UNIQUE is nil or omitted, it is an error if a
1241 buffer named NEWNAME already exists.
1242 If UNIQUE is non-nil, come up with a new name using
1243 `generate-new-buffer-name'.
1244 Interactively, you can set UNIQUE with a prefix argument.
1245 We return the name we actually gave the buffer.
1246 This does not change the name of the visited file (if any). */)
1247 (register Lisp_Object newname, Lisp_Object unique)
1249 register Lisp_Object tem, buf;
1251 CHECK_STRING (newname);
1253 if (SCHARS (newname) == 0)
1254 error ("Empty string is invalid as a buffer name");
1256 tem = Fget_buffer (newname);
1257 if (!NILP (tem))
1259 /* Don't short-circuit if UNIQUE is t. That is a useful way to
1260 rename the buffer automatically so you can create another
1261 with the original name. It makes UNIQUE equivalent to
1262 (rename-buffer (generate-new-buffer-name NEWNAME)). */
1263 if (NILP (unique) && XBUFFER (tem) == current_buffer)
1264 return BVAR (current_buffer, name);
1265 if (!NILP (unique))
1266 newname = Fgenerate_new_buffer_name (newname, BVAR (current_buffer, name));
1267 else
1268 error ("Buffer name `%s' is in use", SDATA (newname));
1271 BVAR (current_buffer, name) = newname;
1273 /* Catch redisplay's attention. Unless we do this, the mode lines for
1274 any windows displaying current_buffer will stay unchanged. */
1275 update_mode_lines++;
1277 XSETBUFFER (buf, current_buffer);
1278 Fsetcar (Frassq (buf, Vbuffer_alist), newname);
1279 if (NILP (BVAR (current_buffer, filename))
1280 && !NILP (BVAR (current_buffer, auto_save_file_name)))
1281 call0 (intern ("rename-auto-save-file"));
1283 /* Run buffer-list-update-hook. */
1284 if (!NILP (Vrun_hooks))
1285 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1287 /* Refetch since that last call may have done GC. */
1288 return BVAR (current_buffer, name);
1291 DEFUN ("other-buffer", Fother_buffer, Sother_buffer, 0, 3, 0,
1292 doc: /* Return most recently selected buffer other than BUFFER.
1293 Buffers not visible in windows are preferred to visible buffers, unless
1294 optional second argument VISIBLE-OK is non-nil. Ignore the argument
1295 BUFFER unless it denotes a live buffer. If the optional third argument
1296 FRAME is non-nil, use that frame's buffer list instead of the selected
1297 frame's buffer list.
1299 The buffer is found by scanning the selected or specified frame's buffer
1300 list first, followed by the list of all buffers. If no other buffer
1301 exists, return the buffer `*scratch*' (creating it if necessary). */)
1302 (register Lisp_Object buffer, Lisp_Object visible_ok, Lisp_Object frame)
1304 Lisp_Object Fset_buffer_major_mode (Lisp_Object buffer);
1305 Lisp_Object tail, buf, pred;
1306 Lisp_Object notsogood = Qnil;
1308 if (NILP (frame))
1309 frame = selected_frame;
1311 CHECK_FRAME (frame);
1313 pred = frame_buffer_predicate (frame);
1314 /* Consider buffers that have been seen in the frame first. */
1315 tail = XFRAME (frame)->buffer_list;
1316 for (; CONSP (tail); tail = XCDR (tail))
1318 buf = XCAR (tail);
1319 if (BUFFERP (buf) && !EQ (buf, buffer)
1320 && !NILP (BVAR (XBUFFER (buf), name))
1321 && (SREF (BVAR (XBUFFER (buf), name), 0) != ' ')
1322 /* If the frame has a buffer_predicate, disregard buffers that
1323 don't fit the predicate. */
1324 && (NILP (pred) || !NILP (call1 (pred, buf))))
1326 if (!NILP (visible_ok)
1327 || NILP (Fget_buffer_window (buf, Qvisible)))
1328 return buf;
1329 else if (NILP (notsogood))
1330 notsogood = buf;
1334 /* Consider alist of all buffers next. */
1335 tail = Vbuffer_alist;
1336 for (; CONSP (tail); tail = XCDR (tail))
1338 buf = Fcdr (XCAR (tail));
1339 if (BUFFERP (buf) && !EQ (buf, buffer)
1340 && !NILP (BVAR (XBUFFER (buf), name))
1341 && (SREF (BVAR (XBUFFER (buf), name), 0) != ' ')
1342 /* If the frame has a buffer_predicate, disregard buffers that
1343 don't fit the predicate. */
1344 && (NILP (pred) || !NILP (call1 (pred, buf))))
1346 if (!NILP (visible_ok)
1347 || NILP (Fget_buffer_window (buf, Qvisible)))
1348 return buf;
1349 else if (NILP (notsogood))
1350 notsogood = buf;
1354 if (!NILP (notsogood))
1355 return notsogood;
1356 else
1358 buf = Fget_buffer (build_string ("*scratch*"));
1359 if (NILP (buf))
1361 buf = Fget_buffer_create (build_string ("*scratch*"));
1362 Fset_buffer_major_mode (buf);
1364 return buf;
1368 /* The following function is a safe variant of Fother_buffer: It doesn't
1369 pay attention to any frame-local buffer lists, doesn't care about
1370 visibility of buffers, and doesn't evaluate any frame predicates. */
1372 Lisp_Object
1373 other_buffer_safely (Lisp_Object buffer)
1375 Lisp_Object Fset_buffer_major_mode (Lisp_Object buffer);
1376 Lisp_Object tail, buf;
1378 tail = Vbuffer_alist;
1379 for (; CONSP (tail); tail = XCDR (tail))
1381 buf = Fcdr (XCAR (tail));
1382 if (BUFFERP (buf) && !EQ (buf, buffer)
1383 && !NILP (BVAR (XBUFFER (buf), name))
1384 && (SREF (BVAR (XBUFFER (buf), name), 0) != ' '))
1385 return buf;
1388 buf = Fget_buffer (build_string ("*scratch*"));
1389 if (NILP (buf))
1391 buf = Fget_buffer_create (build_string ("*scratch*"));
1392 Fset_buffer_major_mode (buf);
1395 return buf;
1398 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo, Sbuffer_enable_undo,
1399 0, 1, "",
1400 doc: /* Start keeping undo information for buffer BUFFER.
1401 No argument or nil as argument means do this for the current buffer. */)
1402 (register Lisp_Object buffer)
1404 Lisp_Object real_buffer;
1406 if (NILP (buffer))
1407 XSETBUFFER (real_buffer, current_buffer);
1408 else
1410 real_buffer = Fget_buffer (buffer);
1411 if (NILP (real_buffer))
1412 nsberror (buffer);
1415 if (EQ (BVAR (XBUFFER (real_buffer), undo_list), Qt))
1416 BVAR (XBUFFER (real_buffer), undo_list) = Qnil;
1418 return Qnil;
1422 DEFVAR_LISP ("kill-buffer-hook", ..., "\
1423 Hook to be run (by `run-hooks', which see) when a buffer is killed.\n\
1424 The buffer being killed will be current while the hook is running.\n\
1425 See `kill-buffer'."
1427 DEFUN ("kill-buffer", Fkill_buffer, Skill_buffer, 0, 1, "bKill buffer: ",
1428 doc: /* Kill buffer BUFFER-OR-NAME.
1429 The argument may be a buffer or the name of an existing buffer.
1430 Argument nil or omitted means kill the current buffer. Return t if the
1431 buffer is actually killed, nil otherwise.
1433 This function calls `replace-buffer-in-windows' for cleaning up all
1434 windows currently displaying the buffer to be killed. The functions in
1435 `kill-buffer-query-functions' are called with the buffer to be killed as
1436 the current buffer. If any of them returns nil, the buffer is not
1437 killed. The hook `kill-buffer-hook' is run before the buffer is
1438 actually killed. The buffer being killed will be current while the hook
1439 is running.
1441 Any processes that have this buffer as the `process-buffer' are killed
1442 with SIGHUP. */)
1443 (Lisp_Object buffer_or_name)
1445 Lisp_Object buffer;
1446 register struct buffer *b;
1447 register Lisp_Object tem;
1448 register struct Lisp_Marker *m;
1449 struct gcpro gcpro1;
1451 if (NILP (buffer_or_name))
1452 buffer = Fcurrent_buffer ();
1453 else
1454 buffer = Fget_buffer (buffer_or_name);
1455 if (NILP (buffer))
1456 nsberror (buffer_or_name);
1458 b = XBUFFER (buffer);
1460 /* Avoid trouble for buffer already dead. */
1461 if (NILP (BVAR (b, name)))
1462 return Qnil;
1464 /* Query if the buffer is still modified. */
1465 if (INTERACTIVE && !NILP (BVAR (b, filename))
1466 && BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
1468 GCPRO1 (buffer);
1469 tem = do_yes_or_no_p (format2 ("Buffer %s modified; kill anyway? ",
1470 BVAR (b, name), make_number (0)));
1471 UNGCPRO;
1472 if (NILP (tem))
1473 return Qnil;
1476 /* Run hooks with the buffer to be killed the current buffer. */
1478 ptrdiff_t count = SPECPDL_INDEX ();
1479 Lisp_Object arglist[1];
1481 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1482 set_buffer_internal (b);
1484 /* First run the query functions; if any query is answered no,
1485 don't kill the buffer. */
1486 arglist[0] = Qkill_buffer_query_functions;
1487 tem = Frun_hook_with_args_until_failure (1, arglist);
1488 if (NILP (tem))
1489 return unbind_to (count, Qnil);
1491 /* Then run the hooks. */
1492 Frun_hooks (1, &Qkill_buffer_hook);
1493 unbind_to (count, Qnil);
1496 /* We have no more questions to ask. Verify that it is valid
1497 to kill the buffer. This must be done after the questions
1498 since anything can happen within do_yes_or_no_p. */
1500 /* Don't kill the minibuffer now current. */
1501 if (EQ (buffer, XWINDOW (minibuf_window)->buffer))
1502 return Qnil;
1504 if (NILP (BVAR (b, name)))
1505 return Qnil;
1507 /* When we kill a base buffer, kill all its indirect buffers.
1508 We do it at this stage so nothing terrible happens if they
1509 ask questions or their hooks get errors. */
1510 if (! b->base_buffer)
1512 struct buffer *other;
1514 GCPRO1 (buffer);
1516 for (other = all_buffers; other; other = other->header.next.buffer)
1517 /* all_buffers contains dead buffers too;
1518 don't re-kill them. */
1519 if (other->base_buffer == b && !NILP (BVAR (other, name)))
1521 Lisp_Object buf;
1522 XSETBUFFER (buf, other);
1523 Fkill_buffer (buf);
1526 UNGCPRO;
1529 /* Run replace_buffer_in_windows before making another buffer current
1530 since set-window-buffer-start-and-point will refuse to make another
1531 buffer current if the selected window does not show the current
1532 buffer. (Bug#10114) */
1533 replace_buffer_in_windows (buffer);
1535 /* Make this buffer not be current.
1536 In the process, notice if this is the sole visible buffer
1537 and give up if so. */
1538 if (b == current_buffer)
1540 tem = Fother_buffer (buffer, Qnil, Qnil);
1541 Fset_buffer (tem);
1542 if (b == current_buffer)
1543 return Qnil;
1546 /* Notice if the buffer to kill is the sole visible buffer
1547 when we're currently in the mini-buffer, and give up if so. */
1548 XSETBUFFER (tem, current_buffer);
1549 if (EQ (tem, XWINDOW (minibuf_window)->buffer))
1551 tem = Fother_buffer (buffer, Qnil, Qnil);
1552 if (EQ (buffer, tem))
1553 return Qnil;
1556 /* Now there is no question: we can kill the buffer. */
1558 #ifdef CLASH_DETECTION
1559 /* Unlock this buffer's file, if it is locked. */
1560 unlock_buffer (b);
1561 #endif /* CLASH_DETECTION */
1563 GCPRO1 (buffer);
1564 kill_buffer_processes (buffer);
1565 UNGCPRO;
1567 /* Killing buffer processes may run sentinels which may
1568 have called kill-buffer. */
1570 if (NILP (BVAR (b, name)))
1571 return Qnil;
1573 /* These may run Lisp code and into infinite loops (if someone
1574 insisted on circular lists) so allow quitting here. */
1575 frames_discard_buffer (buffer);
1577 clear_charpos_cache (b);
1579 tem = Vinhibit_quit;
1580 Vinhibit_quit = Qt;
1581 /* Remove the buffer from the list of all buffers. */
1582 Vbuffer_alist = Fdelq (Frassq (buffer, Vbuffer_alist), Vbuffer_alist);
1583 /* If replace_buffer_in_windows didn't do its job correctly fix that
1584 now. */
1585 replace_buffer_in_windows_safely (buffer);
1586 Vinhibit_quit = tem;
1588 /* Delete any auto-save file, if we saved it in this session.
1589 But not if the buffer is modified. */
1590 if (STRINGP (BVAR (b, auto_save_file_name))
1591 && BUF_AUTOSAVE_MODIFF (b) != 0
1592 && BUF_SAVE_MODIFF (b) < BUF_AUTOSAVE_MODIFF (b)
1593 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
1594 && NILP (Fsymbol_value (intern ("auto-save-visited-file-name"))))
1596 Lisp_Object delete;
1597 delete = Fsymbol_value (intern ("delete-auto-save-files"));
1598 if (! NILP (delete))
1599 internal_delete_file (BVAR (b, auto_save_file_name));
1602 if (b->base_buffer)
1604 /* Unchain all markers that belong to this indirect buffer.
1605 Don't unchain the markers that belong to the base buffer
1606 or its other indirect buffers. */
1607 for (m = BUF_MARKERS (b); m; )
1609 struct Lisp_Marker *next = m->next;
1610 if (m->buffer == b)
1611 unchain_marker (m);
1612 m = next;
1615 else
1617 /* Unchain all markers of this buffer and its indirect buffers.
1618 and leave them pointing nowhere. */
1619 for (m = BUF_MARKERS (b); m; )
1621 struct Lisp_Marker *next = m->next;
1622 m->buffer = 0;
1623 m->next = NULL;
1624 m = next;
1626 BUF_MARKERS (b) = NULL;
1627 BUF_INTERVALS (b) = NULL_INTERVAL;
1629 /* Perhaps we should explicitly free the interval tree here... */
1632 /* Reset the local variables, so that this buffer's local values
1633 won't be protected from GC. They would be protected
1634 if they happened to remain cached in their symbols.
1635 This gets rid of them for certain. */
1636 swap_out_buffer_local_variables (b);
1637 reset_buffer_local_variables (b, 1);
1639 BVAR (b, name) = Qnil;
1641 BLOCK_INPUT;
1642 if (! b->base_buffer)
1643 free_buffer_text (b);
1645 if (b->newline_cache)
1647 free_region_cache (b->newline_cache);
1648 b->newline_cache = 0;
1650 if (b->width_run_cache)
1652 free_region_cache (b->width_run_cache);
1653 b->width_run_cache = 0;
1655 BVAR (b, width_table) = Qnil;
1656 UNBLOCK_INPUT;
1657 BVAR (b, undo_list) = Qnil;
1659 /* Run buffer-list-update-hook. */
1660 if (!NILP (Vrun_hooks))
1661 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1663 return Qt;
1666 /* Move association for BUFFER to the front of buffer (a)lists. Since
1667 we do this each time BUFFER is selected visibly, the more recently
1668 selected buffers are always closer to the front of those lists. This
1669 means that other_buffer is more likely to choose a relevant buffer.
1671 Note that this moves BUFFER to the front of the buffer lists of the
1672 selected frame even if BUFFER is not shown there. If BUFFER is not
1673 shown in the selected frame, consider the present behavior a feature.
1674 `select-window' gets this right since it shows BUFFER in the selected
1675 window when calling us. */
1677 void
1678 record_buffer (Lisp_Object buffer)
1680 Lisp_Object aelt, aelt_cons, tem;
1681 register struct frame *f = XFRAME (selected_frame);
1683 CHECK_BUFFER (buffer);
1685 /* Update Vbuffer_alist (we know that it has an entry for BUFFER).
1686 Don't allow quitting since this might leave the buffer list in an
1687 inconsistent state. */
1688 tem = Vinhibit_quit;
1689 Vinhibit_quit = Qt;
1690 aelt = Frassq (buffer, Vbuffer_alist);
1691 aelt_cons = Fmemq (aelt, Vbuffer_alist);
1692 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
1693 XSETCDR (aelt_cons, Vbuffer_alist);
1694 Vbuffer_alist = aelt_cons;
1695 Vinhibit_quit = tem;
1697 /* Update buffer list of selected frame. */
1698 f->buffer_list = Fcons (buffer, Fdelq (buffer, f->buffer_list));
1699 f->buried_buffer_list = Fdelq (buffer, f->buried_buffer_list);
1701 /* Run buffer-list-update-hook. */
1702 if (!NILP (Vrun_hooks))
1703 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1707 /* Move BUFFER to the end of the buffer (a)lists. Do nothing if the
1708 buffer is killed. For the selected frame's buffer list this moves
1709 BUFFER to its end even if it was never shown in that frame. If
1710 this happens we have a feature, hence `unrecord-buffer' should be
1711 called only when BUFFER was shown in the selected frame. */
1713 DEFUN ("bury-buffer-internal", Fbury_buffer_internal, Sbury_buffer_internal,
1714 1, 1, 0,
1715 doc: /* Move BUFFER to the end of the buffer list. */)
1716 (Lisp_Object buffer)
1718 Lisp_Object aelt, aelt_cons, tem;
1719 register struct frame *f = XFRAME (selected_frame);
1721 CHECK_BUFFER (buffer);
1723 /* Update Vbuffer_alist (we know that it has an entry for BUFFER).
1724 Don't allow quitting since this might leave the buffer list in an
1725 inconsistent state. */
1726 tem = Vinhibit_quit;
1727 Vinhibit_quit = Qt;
1728 aelt = Frassq (buffer, Vbuffer_alist);
1729 aelt_cons = Fmemq (aelt, Vbuffer_alist);
1730 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
1731 XSETCDR (aelt_cons, Qnil);
1732 Vbuffer_alist = nconc2 (Vbuffer_alist, aelt_cons);
1733 Vinhibit_quit = tem;
1735 /* Update buffer lists of selected frame. */
1736 f->buffer_list = Fdelq (buffer, f->buffer_list);
1737 f->buried_buffer_list = Fcons (buffer, Fdelq (buffer, f->buried_buffer_list));
1739 /* Run buffer-list-update-hook. */
1740 if (!NILP (Vrun_hooks))
1741 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1743 return Qnil;
1746 DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode, Sset_buffer_major_mode, 1, 1, 0,
1747 doc: /* Set an appropriate major mode for BUFFER.
1748 For the *scratch* buffer, use `initial-major-mode', otherwise choose a mode
1749 according to `default-major-mode'.
1750 Use this function before selecting the buffer, since it may need to inspect
1751 the current buffer's major mode. */)
1752 (Lisp_Object buffer)
1754 ptrdiff_t count;
1755 Lisp_Object function;
1757 CHECK_BUFFER (buffer);
1759 if (STRINGP (BVAR (XBUFFER (buffer), name))
1760 && strcmp (SSDATA (BVAR (XBUFFER (buffer), name)), "*scratch*") == 0)
1761 function = find_symbol_value (intern ("initial-major-mode"));
1762 else
1764 function = BVAR (&buffer_defaults, major_mode);
1765 if (NILP (function)
1766 && NILP (Fget (BVAR (current_buffer, major_mode), Qmode_class)))
1767 function = BVAR (current_buffer, major_mode);
1770 if (NILP (function) || EQ (function, Qfundamental_mode))
1771 return Qnil;
1773 count = SPECPDL_INDEX ();
1775 /* To select a nonfundamental mode,
1776 select the buffer temporarily and then call the mode function. */
1778 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1780 Fset_buffer (buffer);
1781 call0 (function);
1783 return unbind_to (count, Qnil);
1786 DEFUN ("current-buffer", Fcurrent_buffer, Scurrent_buffer, 0, 0, 0,
1787 doc: /* Return the current buffer as a Lisp object. */)
1788 (void)
1790 register Lisp_Object buf;
1791 XSETBUFFER (buf, current_buffer);
1792 return buf;
1795 /* Set the current buffer to B.
1797 We previously set windows_or_buffers_changed here to invalidate
1798 global unchanged information in beg_unchanged and end_unchanged.
1799 This is no longer necessary because we now compute unchanged
1800 information on a buffer-basis. Every action affecting other
1801 windows than the selected one requires a select_window at some
1802 time, and that increments windows_or_buffers_changed. */
1804 void
1805 set_buffer_internal (register struct buffer *b)
1807 if (current_buffer != b)
1808 set_buffer_internal_1 (b);
1811 /* Set the current buffer to B, and do not set windows_or_buffers_changed.
1812 This is used by redisplay. */
1814 void
1815 set_buffer_internal_1 (register struct buffer *b)
1817 register struct buffer *old_buf;
1818 register Lisp_Object tail;
1820 #ifdef USE_MMAP_FOR_BUFFERS
1821 if (b->text->beg == NULL)
1822 enlarge_buffer_text (b, 0);
1823 #endif /* USE_MMAP_FOR_BUFFERS */
1825 if (current_buffer == b)
1826 return;
1828 old_buf = current_buffer;
1829 current_buffer = b;
1830 last_known_column_point = -1; /* invalidate indentation cache */
1832 if (old_buf)
1834 /* Put the undo list back in the base buffer, so that it appears
1835 that an indirect buffer shares the undo list of its base. */
1836 if (old_buf->base_buffer)
1837 BVAR (old_buf->base_buffer, undo_list) = BVAR (old_buf, undo_list);
1839 /* If the old current buffer has markers to record PT, BEGV and ZV
1840 when it is not current, update them now. */
1841 record_buffer_markers (old_buf);
1844 /* Get the undo list from the base buffer, so that it appears
1845 that an indirect buffer shares the undo list of its base. */
1846 if (b->base_buffer)
1847 BVAR (b, undo_list) = BVAR (b->base_buffer, undo_list);
1849 /* If the new current buffer has markers to record PT, BEGV and ZV
1850 when it is not current, fetch them now. */
1851 fetch_buffer_markers (b);
1853 /* Look down buffer's list of local Lisp variables
1854 to find and update any that forward into C variables. */
1858 for (tail = BVAR (b, local_var_alist); CONSP (tail); tail = XCDR (tail))
1860 Lisp_Object var = XCAR (XCAR (tail));
1861 struct Lisp_Symbol *sym = XSYMBOL (var);
1862 if (sym->redirect == SYMBOL_LOCALIZED /* Just to be sure. */
1863 && SYMBOL_BLV (sym)->fwd)
1864 /* Just reference the variable
1865 to cause it to become set for this buffer. */
1866 Fsymbol_value (var);
1869 /* Do the same with any others that were local to the previous buffer */
1870 while (b != old_buf && (b = old_buf, b));
1873 /* Switch to buffer B temporarily for redisplay purposes.
1874 This avoids certain things that don't need to be done within redisplay. */
1876 void
1877 set_buffer_temp (struct buffer *b)
1879 register struct buffer *old_buf;
1881 if (current_buffer == b)
1882 return;
1884 old_buf = current_buffer;
1885 current_buffer = b;
1887 /* If the old current buffer has markers to record PT, BEGV and ZV
1888 when it is not current, update them now. */
1889 record_buffer_markers (old_buf);
1891 /* If the new current buffer has markers to record PT, BEGV and ZV
1892 when it is not current, fetch them now. */
1893 fetch_buffer_markers (b);
1896 DEFUN ("set-buffer", Fset_buffer, Sset_buffer, 1, 1, 0,
1897 doc: /* Make buffer BUFFER-OR-NAME current for editing operations.
1898 BUFFER-OR-NAME may be a buffer or the name of an existing buffer. See
1899 also `save-excursion' when you want to make a buffer current
1900 temporarily. This function does not display the buffer, so its effect
1901 ends when the current command terminates. Use `switch-to-buffer' or
1902 `pop-to-buffer' to switch buffers permanently. */)
1903 (register Lisp_Object buffer_or_name)
1905 register Lisp_Object buffer;
1906 buffer = Fget_buffer (buffer_or_name);
1907 if (NILP (buffer))
1908 nsberror (buffer_or_name);
1909 if (NILP (BVAR (XBUFFER (buffer), name)))
1910 error ("Selecting deleted buffer");
1911 set_buffer_internal (XBUFFER (buffer));
1912 return buffer;
1915 /* Set the current buffer to BUFFER provided it is alive. */
1917 Lisp_Object
1918 set_buffer_if_live (Lisp_Object buffer)
1920 if (! NILP (BVAR (XBUFFER (buffer), name)))
1921 Fset_buffer (buffer);
1922 return Qnil;
1925 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only,
1926 Sbarf_if_buffer_read_only, 0, 0, 0,
1927 doc: /* Signal a `buffer-read-only' error if the current buffer is read-only. */)
1928 (void)
1930 if (!NILP (BVAR (current_buffer, read_only))
1931 && NILP (Vinhibit_read_only))
1932 xsignal1 (Qbuffer_read_only, Fcurrent_buffer ());
1933 return Qnil;
1936 DEFUN ("erase-buffer", Ferase_buffer, Serase_buffer, 0, 0, "*",
1937 doc: /* Delete the entire contents of the current buffer.
1938 Any narrowing restriction in effect (see `narrow-to-region') is removed,
1939 so the buffer is truly empty after this. */)
1940 (void)
1942 Fwiden ();
1944 del_range (BEG, Z);
1946 current_buffer->last_window_start = 1;
1947 /* Prevent warnings, or suspension of auto saving, that would happen
1948 if future size is less than past size. Use of erase-buffer
1949 implies that the future text is not really related to the past text. */
1950 XSETFASTINT (BVAR (current_buffer, save_length), 0);
1951 return Qnil;
1954 void
1955 validate_region (register Lisp_Object *b, register Lisp_Object *e)
1957 CHECK_NUMBER_COERCE_MARKER (*b);
1958 CHECK_NUMBER_COERCE_MARKER (*e);
1960 if (XINT (*b) > XINT (*e))
1962 Lisp_Object tem;
1963 tem = *b; *b = *e; *e = tem;
1966 if (! (BEGV <= XINT (*b) && XINT (*e) <= ZV))
1967 args_out_of_range (*b, *e);
1970 /* Advance BYTE_POS up to a character boundary
1971 and return the adjusted position. */
1973 static ptrdiff_t
1974 advance_to_char_boundary (ptrdiff_t byte_pos)
1976 int c;
1978 if (byte_pos == BEG)
1979 /* Beginning of buffer is always a character boundary. */
1980 return BEG;
1982 c = FETCH_BYTE (byte_pos);
1983 if (! CHAR_HEAD_P (c))
1985 /* We should advance BYTE_POS only when C is a constituent of a
1986 multibyte sequence. */
1987 ptrdiff_t orig_byte_pos = byte_pos;
1991 byte_pos--;
1992 c = FETCH_BYTE (byte_pos);
1994 while (! CHAR_HEAD_P (c) && byte_pos > BEG);
1995 INC_POS (byte_pos);
1996 if (byte_pos < orig_byte_pos)
1997 byte_pos = orig_byte_pos;
1998 /* If C is a constituent of a multibyte sequence, BYTE_POS was
1999 surely advance to the correct character boundary. If C is
2000 not, BYTE_POS was unchanged. */
2003 return byte_pos;
2006 #ifdef REL_ALLOC
2007 extern void r_alloc_reset_variable (POINTER_TYPE *, POINTER_TYPE *);
2008 #endif /* REL_ALLOC */
2010 DEFUN ("buffer-swap-text", Fbuffer_swap_text, Sbuffer_swap_text,
2011 1, 1, 0,
2012 doc: /* Swap the text between current buffer and BUFFER. */)
2013 (Lisp_Object buffer)
2015 struct buffer *other_buffer;
2016 CHECK_BUFFER (buffer);
2017 other_buffer = XBUFFER (buffer);
2019 if (NILP (BVAR (other_buffer, name)))
2020 error ("Cannot swap a dead buffer's text");
2022 /* Actually, it probably works just fine.
2023 * if (other_buffer == current_buffer)
2024 * error ("Cannot swap a buffer's text with itself"); */
2026 /* Actually, this may be workable as well, tho probably only if they're
2027 *both* indirect. */
2028 if (other_buffer->base_buffer
2029 || current_buffer->base_buffer)
2030 error ("Cannot swap indirect buffers's text");
2032 { /* This is probably harder to make work. */
2033 struct buffer *other;
2034 for (other = all_buffers; other; other = other->header.next.buffer)
2035 if (other->base_buffer == other_buffer
2036 || other->base_buffer == current_buffer)
2037 error ("One of the buffers to swap has indirect buffers");
2040 #define swapfield(field, type) \
2041 do { \
2042 type tmp##field = other_buffer->field; \
2043 other_buffer->field = current_buffer->field; \
2044 current_buffer->field = tmp##field; \
2045 } while (0)
2046 #define swapfield_(field, type) \
2047 do { \
2048 type tmp##field = BVAR (other_buffer, field); \
2049 BVAR (other_buffer, field) = BVAR (current_buffer, field); \
2050 BVAR (current_buffer, field) = tmp##field; \
2051 } while (0)
2053 swapfield (own_text, struct buffer_text);
2054 eassert (current_buffer->text == &current_buffer->own_text);
2055 eassert (other_buffer->text == &other_buffer->own_text);
2056 #ifdef REL_ALLOC
2057 r_alloc_reset_variable ((POINTER_TYPE **) &current_buffer->own_text.beg,
2058 (POINTER_TYPE **) &other_buffer->own_text.beg);
2059 r_alloc_reset_variable ((POINTER_TYPE **) &other_buffer->own_text.beg,
2060 (POINTER_TYPE **) &current_buffer->own_text.beg);
2061 #endif /* REL_ALLOC */
2063 swapfield (pt, ptrdiff_t);
2064 swapfield (pt_byte, ptrdiff_t);
2065 swapfield (begv, ptrdiff_t);
2066 swapfield (begv_byte, ptrdiff_t);
2067 swapfield (zv, ptrdiff_t);
2068 swapfield (zv_byte, ptrdiff_t);
2069 eassert (!current_buffer->base_buffer);
2070 eassert (!other_buffer->base_buffer);
2071 current_buffer->clip_changed = 1; other_buffer->clip_changed = 1;
2072 swapfield (newline_cache, struct region_cache *);
2073 swapfield (width_run_cache, struct region_cache *);
2074 current_buffer->prevent_redisplay_optimizations_p = 1;
2075 other_buffer->prevent_redisplay_optimizations_p = 1;
2076 swapfield (overlays_before, struct Lisp_Overlay *);
2077 swapfield (overlays_after, struct Lisp_Overlay *);
2078 swapfield (overlay_center, ptrdiff_t);
2079 swapfield_ (undo_list, Lisp_Object);
2080 swapfield_ (mark, Lisp_Object);
2081 swapfield_ (enable_multibyte_characters, Lisp_Object);
2082 swapfield_ (bidi_display_reordering, Lisp_Object);
2083 swapfield_ (bidi_paragraph_direction, Lisp_Object);
2084 /* FIXME: Not sure what we should do with these *_marker fields.
2085 Hopefully they're just nil anyway. */
2086 swapfield_ (pt_marker, Lisp_Object);
2087 swapfield_ (begv_marker, Lisp_Object);
2088 swapfield_ (zv_marker, Lisp_Object);
2089 BVAR (current_buffer, point_before_scroll) = Qnil;
2090 BVAR (other_buffer, point_before_scroll) = Qnil;
2092 current_buffer->text->modiff++; other_buffer->text->modiff++;
2093 current_buffer->text->chars_modiff++; other_buffer->text->chars_modiff++;
2094 current_buffer->text->overlay_modiff++; other_buffer->text->overlay_modiff++;
2095 current_buffer->text->beg_unchanged = current_buffer->text->gpt;
2096 current_buffer->text->end_unchanged = current_buffer->text->gpt;
2097 other_buffer->text->beg_unchanged = other_buffer->text->gpt;
2098 other_buffer->text->end_unchanged = other_buffer->text->gpt;
2100 struct Lisp_Marker *m;
2101 for (m = BUF_MARKERS (current_buffer); m; m = m->next)
2102 if (m->buffer == other_buffer)
2103 m->buffer = current_buffer;
2104 else
2105 /* Since there's no indirect buffer in sight, markers on
2106 BUF_MARKERS(buf) should either be for `buf' or dead. */
2107 eassert (!m->buffer);
2108 for (m = BUF_MARKERS (other_buffer); m; m = m->next)
2109 if (m->buffer == current_buffer)
2110 m->buffer = other_buffer;
2111 else
2112 /* Since there's no indirect buffer in sight, markers on
2113 BUF_MARKERS(buf) should either be for `buf' or dead. */
2114 eassert (!m->buffer);
2116 { /* Some of the C code expects that w->buffer == w->pointm->buffer.
2117 So since we just swapped the markers between the two buffers, we need
2118 to undo the effect of this swap for window markers. */
2119 Lisp_Object w = Fselected_window (), ws = Qnil;
2120 Lisp_Object buf1, buf2;
2121 XSETBUFFER (buf1, current_buffer); XSETBUFFER (buf2, other_buffer);
2123 while (NILP (Fmemq (w, ws)))
2125 ws = Fcons (w, ws);
2126 if (MARKERP (XWINDOW (w)->pointm)
2127 && (EQ (XWINDOW (w)->buffer, buf1)
2128 || EQ (XWINDOW (w)->buffer, buf2)))
2129 Fset_marker (XWINDOW (w)->pointm,
2130 make_number (BUF_BEGV (XBUFFER (XWINDOW (w)->buffer))),
2131 XWINDOW (w)->buffer);
2132 w = Fnext_window (w, Qt, Qt);
2136 if (current_buffer->text->intervals)
2137 (eassert (EQ (current_buffer->text->intervals->up.obj, buffer)),
2138 XSETBUFFER (current_buffer->text->intervals->up.obj, current_buffer));
2139 if (other_buffer->text->intervals)
2140 (eassert (EQ (other_buffer->text->intervals->up.obj, Fcurrent_buffer ())),
2141 XSETBUFFER (other_buffer->text->intervals->up.obj, other_buffer));
2143 return Qnil;
2146 DEFUN ("set-buffer-multibyte", Fset_buffer_multibyte, Sset_buffer_multibyte,
2147 1, 1, 0,
2148 doc: /* Set the multibyte flag of the current buffer to FLAG.
2149 If FLAG is t, this makes the buffer a multibyte buffer.
2150 If FLAG is nil, this makes the buffer a single-byte buffer.
2151 In these cases, the buffer contents remain unchanged as a sequence of
2152 bytes but the contents viewed as characters do change.
2153 If FLAG is `to', this makes the buffer a multibyte buffer by changing
2154 all eight-bit bytes to eight-bit characters.
2155 If the multibyte flag was really changed, undo information of the
2156 current buffer is cleared. */)
2157 (Lisp_Object flag)
2159 struct Lisp_Marker *tail, *markers;
2160 struct buffer *other;
2161 ptrdiff_t begv, zv;
2162 int narrowed = (BEG != BEGV || Z != ZV);
2163 int modified_p = !NILP (Fbuffer_modified_p (Qnil));
2164 Lisp_Object old_undo = BVAR (current_buffer, undo_list);
2165 struct gcpro gcpro1;
2167 if (current_buffer->base_buffer)
2168 error ("Cannot do `set-buffer-multibyte' on an indirect buffer");
2170 /* Do nothing if nothing actually changes. */
2171 if (NILP (flag) == NILP (BVAR (current_buffer, enable_multibyte_characters)))
2172 return flag;
2174 GCPRO1 (old_undo);
2176 /* Don't record these buffer changes. We will put a special undo entry
2177 instead. */
2178 BVAR (current_buffer, undo_list) = Qt;
2180 /* If the cached position is for this buffer, clear it out. */
2181 clear_charpos_cache (current_buffer);
2183 if (NILP (flag))
2184 begv = BEGV_BYTE, zv = ZV_BYTE;
2185 else
2186 begv = BEGV, zv = ZV;
2188 if (narrowed)
2189 Fwiden ();
2191 if (NILP (flag))
2193 ptrdiff_t pos, stop;
2194 unsigned char *p;
2196 /* Do this first, so it can use CHAR_TO_BYTE
2197 to calculate the old correspondences. */
2198 set_intervals_multibyte (0);
2200 BVAR (current_buffer, enable_multibyte_characters) = Qnil;
2202 Z = Z_BYTE;
2203 BEGV = BEGV_BYTE;
2204 ZV = ZV_BYTE;
2205 GPT = GPT_BYTE;
2206 TEMP_SET_PT_BOTH (PT_BYTE, PT_BYTE);
2209 for (tail = BUF_MARKERS (current_buffer); tail; tail = tail->next)
2210 tail->charpos = tail->bytepos;
2212 /* Convert multibyte form of 8-bit characters to unibyte. */
2213 pos = BEG;
2214 stop = GPT;
2215 p = BEG_ADDR;
2216 while (1)
2218 int c, bytes;
2220 if (pos == stop)
2222 if (pos == Z)
2223 break;
2224 p = GAP_END_ADDR;
2225 stop = Z;
2227 if (ASCII_BYTE_P (*p))
2228 p++, pos++;
2229 else if (CHAR_BYTE8_HEAD_P (*p))
2231 c = STRING_CHAR_AND_LENGTH (p, bytes);
2232 /* Delete all bytes for this 8-bit character but the
2233 last one, and change the last one to the character
2234 code. */
2235 bytes--;
2236 del_range_2 (pos, pos, pos + bytes, pos + bytes, 0);
2237 p = GAP_END_ADDR;
2238 *p++ = c;
2239 pos++;
2240 if (begv > pos)
2241 begv -= bytes;
2242 if (zv > pos)
2243 zv -= bytes;
2244 stop = Z;
2246 else
2248 bytes = BYTES_BY_CHAR_HEAD (*p);
2249 p += bytes, pos += bytes;
2252 if (narrowed)
2253 Fnarrow_to_region (make_number (begv), make_number (zv));
2255 else
2257 ptrdiff_t pt = PT;
2258 ptrdiff_t pos, stop;
2259 unsigned char *p, *pend;
2261 /* Be sure not to have a multibyte sequence striding over the GAP.
2262 Ex: We change this: "...abc\302 _GAP_ \241def..."
2263 to: "...abc _GAP_ \302\241def..." */
2265 if (EQ (flag, Qt)
2266 && GPT_BYTE > 1 && GPT_BYTE < Z_BYTE
2267 && ! CHAR_HEAD_P (*(GAP_END_ADDR)))
2269 unsigned char *q = GPT_ADDR - 1;
2271 while (! CHAR_HEAD_P (*q) && q > BEG_ADDR) q--;
2272 if (LEADING_CODE_P (*q))
2274 ptrdiff_t new_gpt = GPT_BYTE - (GPT_ADDR - q);
2276 move_gap_both (new_gpt, new_gpt);
2280 /* Make the buffer contents valid as multibyte by converting
2281 8-bit characters to multibyte form. */
2282 pos = BEG;
2283 stop = GPT;
2284 p = BEG_ADDR;
2285 pend = GPT_ADDR;
2286 while (1)
2288 int bytes;
2290 if (pos == stop)
2292 if (pos == Z)
2293 break;
2294 p = GAP_END_ADDR;
2295 pend = Z_ADDR;
2296 stop = Z;
2299 if (ASCII_BYTE_P (*p))
2300 p++, pos++;
2301 else if (EQ (flag, Qt)
2302 && ! CHAR_BYTE8_HEAD_P (*p)
2303 && (bytes = MULTIBYTE_LENGTH (p, pend)) > 0)
2304 p += bytes, pos += bytes;
2305 else
2307 unsigned char tmp[MAX_MULTIBYTE_LENGTH];
2308 int c;
2310 c = BYTE8_TO_CHAR (*p);
2311 bytes = CHAR_STRING (c, tmp);
2312 *p = tmp[0];
2313 TEMP_SET_PT_BOTH (pos + 1, pos + 1);
2314 bytes--;
2315 insert_1_both ((char *) tmp + 1, bytes, bytes, 1, 0, 0);
2316 /* Now the gap is after the just inserted data. */
2317 pos = GPT;
2318 p = GAP_END_ADDR;
2319 if (pos <= begv)
2320 begv += bytes;
2321 if (pos <= zv)
2322 zv += bytes;
2323 if (pos <= pt)
2324 pt += bytes;
2325 pend = Z_ADDR;
2326 stop = Z;
2330 if (pt != PT)
2331 TEMP_SET_PT (pt);
2333 if (narrowed)
2334 Fnarrow_to_region (make_number (begv), make_number (zv));
2336 /* Do this first, so that chars_in_text asks the right question.
2337 set_intervals_multibyte needs it too. */
2338 BVAR (current_buffer, enable_multibyte_characters) = Qt;
2340 GPT_BYTE = advance_to_char_boundary (GPT_BYTE);
2341 GPT = chars_in_text (BEG_ADDR, GPT_BYTE - BEG_BYTE) + BEG;
2343 Z = chars_in_text (GAP_END_ADDR, Z_BYTE - GPT_BYTE) + GPT;
2345 BEGV_BYTE = advance_to_char_boundary (BEGV_BYTE);
2346 if (BEGV_BYTE > GPT_BYTE)
2347 BEGV = chars_in_text (GAP_END_ADDR, BEGV_BYTE - GPT_BYTE) + GPT;
2348 else
2349 BEGV = chars_in_text (BEG_ADDR, BEGV_BYTE - BEG_BYTE) + BEG;
2351 ZV_BYTE = advance_to_char_boundary (ZV_BYTE);
2352 if (ZV_BYTE > GPT_BYTE)
2353 ZV = chars_in_text (GAP_END_ADDR, ZV_BYTE - GPT_BYTE) + GPT;
2354 else
2355 ZV = chars_in_text (BEG_ADDR, ZV_BYTE - BEG_BYTE) + BEG;
2358 ptrdiff_t byte = advance_to_char_boundary (PT_BYTE);
2359 ptrdiff_t position;
2361 if (byte > GPT_BYTE)
2362 position = chars_in_text (GAP_END_ADDR, byte - GPT_BYTE) + GPT;
2363 else
2364 position = chars_in_text (BEG_ADDR, byte - BEG_BYTE) + BEG;
2365 TEMP_SET_PT_BOTH (position, byte);
2368 tail = markers = BUF_MARKERS (current_buffer);
2370 /* This prevents BYTE_TO_CHAR (that is, buf_bytepos_to_charpos) from
2371 getting confused by the markers that have not yet been updated.
2372 It is also a signal that it should never create a marker. */
2373 BUF_MARKERS (current_buffer) = NULL;
2375 for (; tail; tail = tail->next)
2377 tail->bytepos = advance_to_char_boundary (tail->bytepos);
2378 tail->charpos = BYTE_TO_CHAR (tail->bytepos);
2381 /* Make sure no markers were put on the chain
2382 while the chain value was incorrect. */
2383 if (BUF_MARKERS (current_buffer))
2384 abort ();
2386 BUF_MARKERS (current_buffer) = markers;
2388 /* Do this last, so it can calculate the new correspondences
2389 between chars and bytes. */
2390 set_intervals_multibyte (1);
2393 if (!EQ (old_undo, Qt))
2395 /* Represent all the above changes by a special undo entry. */
2396 BVAR (current_buffer, undo_list) = Fcons (list3 (Qapply,
2397 intern ("set-buffer-multibyte"),
2398 NILP (flag) ? Qt : Qnil),
2399 old_undo);
2402 UNGCPRO;
2404 /* Changing the multibyteness of a buffer means that all windows
2405 showing that buffer must be updated thoroughly. */
2406 current_buffer->prevent_redisplay_optimizations_p = 1;
2407 ++windows_or_buffers_changed;
2409 /* Copy this buffer's new multibyte status
2410 into all of its indirect buffers. */
2411 for (other = all_buffers; other; other = other->header.next.buffer)
2412 if (other->base_buffer == current_buffer && !NILP (BVAR (other, name)))
2414 BVAR (other, enable_multibyte_characters)
2415 = BVAR (current_buffer, enable_multibyte_characters);
2416 other->prevent_redisplay_optimizations_p = 1;
2419 /* Restore the modifiedness of the buffer. */
2420 if (!modified_p && !NILP (Fbuffer_modified_p (Qnil)))
2421 Fset_buffer_modified_p (Qnil);
2423 /* Update coding systems of this buffer's process (if any). */
2425 Lisp_Object process;
2427 process = Fget_buffer_process (Fcurrent_buffer ());
2428 if (PROCESSP (process))
2429 setup_process_coding_systems (process);
2432 return flag;
2435 DEFUN ("kill-all-local-variables", Fkill_all_local_variables,
2436 Skill_all_local_variables, 0, 0, 0,
2437 doc: /* Switch to Fundamental mode by killing current buffer's local variables.
2438 Most local variable bindings are eliminated so that the default values
2439 become effective once more. Also, the syntax table is set from
2440 `standard-syntax-table', the local keymap is set to nil,
2441 and the abbrev table from `fundamental-mode-abbrev-table'.
2442 This function also forces redisplay of the mode line.
2444 Every function to select a new major mode starts by
2445 calling this function.
2447 As a special exception, local variables whose names have
2448 a non-nil `permanent-local' property are not eliminated by this function.
2450 The first thing this function does is run
2451 the normal hook `change-major-mode-hook'. */)
2452 (void)
2454 Frun_hooks (1, &Qchange_major_mode_hook);
2456 /* Make sure none of the bindings in local_var_alist
2457 remain swapped in, in their symbols. */
2459 swap_out_buffer_local_variables (current_buffer);
2461 /* Actually eliminate all local bindings of this buffer. */
2463 reset_buffer_local_variables (current_buffer, 0);
2465 /* Force mode-line redisplay. Useful here because all major mode
2466 commands call this function. */
2467 update_mode_lines++;
2469 return Qnil;
2472 /* Make sure no local variables remain set up with buffer B
2473 for their current values. */
2475 static void
2476 swap_out_buffer_local_variables (struct buffer *b)
2478 Lisp_Object oalist, alist, buffer;
2480 XSETBUFFER (buffer, b);
2481 oalist = BVAR (b, local_var_alist);
2483 for (alist = oalist; CONSP (alist); alist = XCDR (alist))
2485 Lisp_Object sym = XCAR (XCAR (alist));
2486 eassert (XSYMBOL (sym)->redirect == SYMBOL_LOCALIZED);
2487 /* Need not do anything if some other buffer's binding is
2488 now cached. */
2489 if (EQ (SYMBOL_BLV (XSYMBOL (sym))->where, buffer))
2491 /* Symbol is set up for this buffer's old local value:
2492 swap it out! */
2493 swap_in_global_binding (XSYMBOL (sym));
2498 /* Find all the overlays in the current buffer that contain position POS.
2499 Return the number found, and store them in a vector in *VEC_PTR.
2500 Store in *LEN_PTR the size allocated for the vector.
2501 Store in *NEXT_PTR the next position after POS where an overlay starts,
2502 or ZV if there are no more overlays between POS and ZV.
2503 Store in *PREV_PTR the previous position before POS where an overlay ends,
2504 or where an overlay starts which ends at or after POS;
2505 or BEGV if there are no such overlays from BEGV to POS.
2506 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2508 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2509 when this function is called.
2511 If EXTEND is non-zero, we make the vector bigger if necessary.
2512 If EXTEND is zero, we never extend the vector,
2513 and we store only as many overlays as will fit.
2514 But we still return the total number of overlays.
2516 If CHANGE_REQ is true, then any position written into *PREV_PTR or
2517 *NEXT_PTR is guaranteed to be not equal to POS, unless it is the
2518 default (BEGV or ZV). */
2520 ptrdiff_t
2521 overlays_at (EMACS_INT pos, int extend, Lisp_Object **vec_ptr,
2522 ptrdiff_t *len_ptr,
2523 ptrdiff_t *next_ptr, ptrdiff_t *prev_ptr, int change_req)
2525 Lisp_Object overlay, start, end;
2526 struct Lisp_Overlay *tail;
2527 ptrdiff_t idx = 0;
2528 ptrdiff_t len = *len_ptr;
2529 Lisp_Object *vec = *vec_ptr;
2530 ptrdiff_t next = ZV;
2531 ptrdiff_t prev = BEGV;
2532 int inhibit_storing = 0;
2534 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2536 ptrdiff_t startpos, endpos;
2538 XSETMISC (overlay, tail);
2540 start = OVERLAY_START (overlay);
2541 end = OVERLAY_END (overlay);
2542 endpos = OVERLAY_POSITION (end);
2543 if (endpos < pos)
2545 if (prev < endpos)
2546 prev = endpos;
2547 break;
2549 startpos = OVERLAY_POSITION (start);
2550 /* This one ends at or after POS
2551 so its start counts for PREV_PTR if it's before POS. */
2552 if (prev < startpos && startpos < pos)
2553 prev = startpos;
2554 if (endpos == pos)
2555 continue;
2556 if (startpos <= pos)
2558 if (idx == len)
2560 /* The supplied vector is full.
2561 Either make it bigger, or don't store any more in it. */
2562 if (extend)
2564 vec = xpalloc (vec, len_ptr, 1, OVERLAY_COUNT_MAX,
2565 sizeof *vec);
2566 *vec_ptr = vec;
2567 len = *len_ptr;
2569 else
2570 inhibit_storing = 1;
2573 if (!inhibit_storing)
2574 vec[idx] = overlay;
2575 /* Keep counting overlays even if we can't return them all. */
2576 idx++;
2578 else if (startpos < next)
2579 next = startpos;
2582 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2584 ptrdiff_t startpos, endpos;
2586 XSETMISC (overlay, tail);
2588 start = OVERLAY_START (overlay);
2589 end = OVERLAY_END (overlay);
2590 startpos = OVERLAY_POSITION (start);
2591 if (pos < startpos)
2593 if (startpos < next)
2594 next = startpos;
2595 break;
2597 endpos = OVERLAY_POSITION (end);
2598 if (pos < endpos)
2600 if (idx == len)
2602 if (extend)
2604 vec = xpalloc (vec, len_ptr, 1, OVERLAY_COUNT_MAX,
2605 sizeof *vec);
2606 *vec_ptr = vec;
2607 len = *len_ptr;
2609 else
2610 inhibit_storing = 1;
2613 if (!inhibit_storing)
2614 vec[idx] = overlay;
2615 idx++;
2617 if (startpos < pos && startpos > prev)
2618 prev = startpos;
2620 else if (endpos < pos && endpos > prev)
2621 prev = endpos;
2622 else if (endpos == pos && startpos > prev
2623 && (!change_req || startpos < pos))
2624 prev = startpos;
2627 if (next_ptr)
2628 *next_ptr = next;
2629 if (prev_ptr)
2630 *prev_ptr = prev;
2631 return idx;
2634 /* Find all the overlays in the current buffer that overlap the range
2635 BEG-END, or are empty at BEG, or are empty at END provided END
2636 denotes the position at the end of the current buffer.
2638 Return the number found, and store them in a vector in *VEC_PTR.
2639 Store in *LEN_PTR the size allocated for the vector.
2640 Store in *NEXT_PTR the next position after POS where an overlay starts,
2641 or ZV if there are no more overlays.
2642 Store in *PREV_PTR the previous position before POS where an overlay ends,
2643 or BEGV if there are no previous overlays.
2644 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2646 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2647 when this function is called.
2649 If EXTEND is non-zero, we make the vector bigger if necessary.
2650 If EXTEND is zero, we never extend the vector,
2651 and we store only as many overlays as will fit.
2652 But we still return the total number of overlays. */
2654 static ptrdiff_t
2655 overlays_in (EMACS_INT beg, EMACS_INT end, int extend,
2656 Lisp_Object **vec_ptr, ptrdiff_t *len_ptr,
2657 ptrdiff_t *next_ptr, ptrdiff_t *prev_ptr)
2659 Lisp_Object overlay, ostart, oend;
2660 struct Lisp_Overlay *tail;
2661 ptrdiff_t idx = 0;
2662 ptrdiff_t len = *len_ptr;
2663 Lisp_Object *vec = *vec_ptr;
2664 ptrdiff_t next = ZV;
2665 ptrdiff_t prev = BEGV;
2666 int inhibit_storing = 0;
2667 int end_is_Z = end == Z;
2669 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2671 ptrdiff_t startpos, endpos;
2673 XSETMISC (overlay, tail);
2675 ostart = OVERLAY_START (overlay);
2676 oend = OVERLAY_END (overlay);
2677 endpos = OVERLAY_POSITION (oend);
2678 if (endpos < beg)
2680 if (prev < endpos)
2681 prev = endpos;
2682 break;
2684 startpos = OVERLAY_POSITION (ostart);
2685 /* Count an interval if it overlaps the range, is empty at the
2686 start of the range, or is empty at END provided END denotes the
2687 end of the buffer. */
2688 if ((beg < endpos && startpos < end)
2689 || (startpos == endpos
2690 && (beg == endpos || (end_is_Z && endpos == end))))
2692 if (idx == len)
2694 /* The supplied vector is full.
2695 Either make it bigger, or don't store any more in it. */
2696 if (extend)
2698 vec = xpalloc (vec, len_ptr, 1, OVERLAY_COUNT_MAX,
2699 sizeof *vec);
2700 *vec_ptr = vec;
2701 len = *len_ptr;
2703 else
2704 inhibit_storing = 1;
2707 if (!inhibit_storing)
2708 vec[idx] = overlay;
2709 /* Keep counting overlays even if we can't return them all. */
2710 idx++;
2712 else if (startpos < next)
2713 next = startpos;
2716 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2718 ptrdiff_t startpos, endpos;
2720 XSETMISC (overlay, tail);
2722 ostart = OVERLAY_START (overlay);
2723 oend = OVERLAY_END (overlay);
2724 startpos = OVERLAY_POSITION (ostart);
2725 if (end < startpos)
2727 if (startpos < next)
2728 next = startpos;
2729 break;
2731 endpos = OVERLAY_POSITION (oend);
2732 /* Count an interval if it overlaps the range, is empty at the
2733 start of the range, or is empty at END provided END denotes the
2734 end of the buffer. */
2735 if ((beg < endpos && startpos < end)
2736 || (startpos == endpos
2737 && (beg == endpos || (end_is_Z && endpos == end))))
2739 if (idx == len)
2741 if (extend)
2743 vec = xpalloc (vec, len_ptr, 1, OVERLAY_COUNT_MAX,
2744 sizeof *vec);
2745 *vec_ptr = vec;
2746 len = *len_ptr;
2748 else
2749 inhibit_storing = 1;
2752 if (!inhibit_storing)
2753 vec[idx] = overlay;
2754 idx++;
2756 else if (endpos < beg && endpos > prev)
2757 prev = endpos;
2760 if (next_ptr)
2761 *next_ptr = next;
2762 if (prev_ptr)
2763 *prev_ptr = prev;
2764 return idx;
2768 /* Return non-zero if there exists an overlay with a non-nil
2769 `mouse-face' property overlapping OVERLAY. */
2772 mouse_face_overlay_overlaps (Lisp_Object overlay)
2774 ptrdiff_t start = OVERLAY_POSITION (OVERLAY_START (overlay));
2775 ptrdiff_t end = OVERLAY_POSITION (OVERLAY_END (overlay));
2776 ptrdiff_t n, i, size;
2777 Lisp_Object *v, tem;
2779 size = 10;
2780 v = (Lisp_Object *) alloca (size * sizeof *v);
2781 n = overlays_in (start, end, 0, &v, &size, NULL, NULL);
2782 if (n > size)
2784 v = (Lisp_Object *) alloca (n * sizeof *v);
2785 overlays_in (start, end, 0, &v, &n, NULL, NULL);
2788 for (i = 0; i < n; ++i)
2789 if (!EQ (v[i], overlay)
2790 && (tem = Foverlay_get (overlay, Qmouse_face),
2791 !NILP (tem)))
2792 break;
2794 return i < n;
2799 /* Fast function to just test if we're at an overlay boundary. */
2801 overlay_touches_p (ptrdiff_t pos)
2803 Lisp_Object overlay;
2804 struct Lisp_Overlay *tail;
2806 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2808 ptrdiff_t endpos;
2810 XSETMISC (overlay ,tail);
2811 if (!OVERLAYP (overlay))
2812 abort ();
2814 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2815 if (endpos < pos)
2816 break;
2817 if (endpos == pos || OVERLAY_POSITION (OVERLAY_START (overlay)) == pos)
2818 return 1;
2821 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2823 ptrdiff_t startpos;
2825 XSETMISC (overlay, tail);
2826 if (!OVERLAYP (overlay))
2827 abort ();
2829 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2830 if (pos < startpos)
2831 break;
2832 if (startpos == pos || OVERLAY_POSITION (OVERLAY_END (overlay)) == pos)
2833 return 1;
2835 return 0;
2838 struct sortvec
2840 Lisp_Object overlay;
2841 ptrdiff_t beg, end;
2842 EMACS_INT priority;
2845 static int
2846 compare_overlays (const void *v1, const void *v2)
2848 const struct sortvec *s1 = (const struct sortvec *) v1;
2849 const struct sortvec *s2 = (const struct sortvec *) v2;
2850 if (s1->priority != s2->priority)
2851 return s1->priority < s2->priority ? -1 : 1;
2852 if (s1->beg != s2->beg)
2853 return s1->beg < s2->beg ? -1 : 1;
2854 if (s1->end != s2->end)
2855 return s2->end < s1->end ? -1 : 1;
2856 return 0;
2859 /* Sort an array of overlays by priority. The array is modified in place.
2860 The return value is the new size; this may be smaller than the original
2861 size if some of the overlays were invalid or were window-specific. */
2862 ptrdiff_t
2863 sort_overlays (Lisp_Object *overlay_vec, ptrdiff_t noverlays, struct window *w)
2865 ptrdiff_t i, j;
2866 struct sortvec *sortvec;
2867 sortvec = (struct sortvec *) alloca (noverlays * sizeof (struct sortvec));
2869 /* Put the valid and relevant overlays into sortvec. */
2871 for (i = 0, j = 0; i < noverlays; i++)
2873 Lisp_Object tem;
2874 Lisp_Object overlay;
2876 overlay = overlay_vec[i];
2877 if (OVERLAY_VALID (overlay)
2878 && OVERLAY_POSITION (OVERLAY_START (overlay)) > 0
2879 && OVERLAY_POSITION (OVERLAY_END (overlay)) > 0)
2881 /* If we're interested in a specific window, then ignore
2882 overlays that are limited to some other window. */
2883 if (w)
2885 Lisp_Object window;
2887 window = Foverlay_get (overlay, Qwindow);
2888 if (WINDOWP (window) && XWINDOW (window) != w)
2889 continue;
2892 /* This overlay is good and counts: put it into sortvec. */
2893 sortvec[j].overlay = overlay;
2894 sortvec[j].beg = OVERLAY_POSITION (OVERLAY_START (overlay));
2895 sortvec[j].end = OVERLAY_POSITION (OVERLAY_END (overlay));
2896 tem = Foverlay_get (overlay, Qpriority);
2897 if (INTEGERP (tem))
2898 sortvec[j].priority = XINT (tem);
2899 else
2900 sortvec[j].priority = 0;
2901 j++;
2904 noverlays = j;
2906 /* Sort the overlays into the proper order: increasing priority. */
2908 if (noverlays > 1)
2909 qsort (sortvec, noverlays, sizeof (struct sortvec), compare_overlays);
2911 for (i = 0; i < noverlays; i++)
2912 overlay_vec[i] = sortvec[i].overlay;
2913 return (noverlays);
2916 struct sortstr
2918 Lisp_Object string, string2;
2919 ptrdiff_t size;
2920 EMACS_INT priority;
2923 struct sortstrlist
2925 struct sortstr *buf; /* An array that expands as needed; never freed. */
2926 ptrdiff_t size; /* Allocated length of that array. */
2927 ptrdiff_t used; /* How much of the array is currently in use. */
2928 ptrdiff_t bytes; /* Total length of the strings in buf. */
2931 /* Buffers for storing information about the overlays touching a given
2932 position. These could be automatic variables in overlay_strings, but
2933 it's more efficient to hold onto the memory instead of repeatedly
2934 allocating and freeing it. */
2935 static struct sortstrlist overlay_heads, overlay_tails;
2936 static unsigned char *overlay_str_buf;
2938 /* Allocated length of overlay_str_buf. */
2939 static ptrdiff_t overlay_str_len;
2941 /* A comparison function suitable for passing to qsort. */
2942 static int
2943 cmp_for_strings (const void *as1, const void *as2)
2945 struct sortstr *s1 = (struct sortstr *)as1;
2946 struct sortstr *s2 = (struct sortstr *)as2;
2947 if (s1->size != s2->size)
2948 return s2->size < s1->size ? -1 : 1;
2949 if (s1->priority != s2->priority)
2950 return s1->priority < s2->priority ? -1 : 1;
2951 return 0;
2954 static void
2955 record_overlay_string (struct sortstrlist *ssl, Lisp_Object str,
2956 Lisp_Object str2, Lisp_Object pri, ptrdiff_t size)
2958 ptrdiff_t nbytes;
2960 if (ssl->used == ssl->size)
2961 ssl->buf = xpalloc (ssl->buf, &ssl->size, 5, -1, sizeof *ssl->buf);
2962 ssl->buf[ssl->used].string = str;
2963 ssl->buf[ssl->used].string2 = str2;
2964 ssl->buf[ssl->used].size = size;
2965 ssl->buf[ssl->used].priority = (INTEGERP (pri) ? XINT (pri) : 0);
2966 ssl->used++;
2968 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
2969 nbytes = SCHARS (str);
2970 else if (! STRING_MULTIBYTE (str))
2971 nbytes = count_size_as_multibyte (SDATA (str),
2972 SBYTES (str));
2973 else
2974 nbytes = SBYTES (str);
2976 if (INT_ADD_OVERFLOW (ssl->bytes, nbytes))
2977 memory_full (SIZE_MAX);
2978 ssl->bytes += nbytes;
2980 if (STRINGP (str2))
2982 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
2983 nbytes = SCHARS (str2);
2984 else if (! STRING_MULTIBYTE (str2))
2985 nbytes = count_size_as_multibyte (SDATA (str2),
2986 SBYTES (str2));
2987 else
2988 nbytes = SBYTES (str2);
2990 if (INT_ADD_OVERFLOW (ssl->bytes, nbytes))
2991 memory_full (SIZE_MAX);
2992 ssl->bytes += nbytes;
2996 /* Return the concatenation of the strings associated with overlays that
2997 begin or end at POS, ignoring overlays that are specific to a window
2998 other than W. The strings are concatenated in the appropriate order:
2999 shorter overlays nest inside longer ones, and higher priority inside
3000 lower. Normally all of the after-strings come first, but zero-sized
3001 overlays have their after-strings ride along with the before-strings
3002 because it would look strange to print them inside-out.
3004 Returns the string length, and stores the contents indirectly through
3005 PSTR, if that variable is non-null. The string may be overwritten by
3006 subsequent calls. */
3008 ptrdiff_t
3009 overlay_strings (ptrdiff_t pos, struct window *w, unsigned char **pstr)
3011 Lisp_Object overlay, window, str;
3012 struct Lisp_Overlay *ov;
3013 ptrdiff_t startpos, endpos;
3014 int multibyte = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
3016 overlay_heads.used = overlay_heads.bytes = 0;
3017 overlay_tails.used = overlay_tails.bytes = 0;
3018 for (ov = current_buffer->overlays_before; ov; ov = ov->next)
3020 XSETMISC (overlay, ov);
3021 eassert (OVERLAYP (overlay));
3023 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3024 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3025 if (endpos < pos)
3026 break;
3027 if (endpos != pos && startpos != pos)
3028 continue;
3029 window = Foverlay_get (overlay, Qwindow);
3030 if (WINDOWP (window) && XWINDOW (window) != w)
3031 continue;
3032 if (startpos == pos
3033 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3034 record_overlay_string (&overlay_heads, str,
3035 (startpos == endpos
3036 ? Foverlay_get (overlay, Qafter_string)
3037 : Qnil),
3038 Foverlay_get (overlay, Qpriority),
3039 endpos - startpos);
3040 else if (endpos == pos
3041 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3042 record_overlay_string (&overlay_tails, str, Qnil,
3043 Foverlay_get (overlay, Qpriority),
3044 endpos - startpos);
3046 for (ov = current_buffer->overlays_after; ov; ov = ov->next)
3048 XSETMISC (overlay, ov);
3049 eassert (OVERLAYP (overlay));
3051 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3052 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3053 if (startpos > pos)
3054 break;
3055 if (endpos != pos && startpos != pos)
3056 continue;
3057 window = Foverlay_get (overlay, Qwindow);
3058 if (WINDOWP (window) && XWINDOW (window) != w)
3059 continue;
3060 if (startpos == pos
3061 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3062 record_overlay_string (&overlay_heads, str,
3063 (startpos == endpos
3064 ? Foverlay_get (overlay, Qafter_string)
3065 : Qnil),
3066 Foverlay_get (overlay, Qpriority),
3067 endpos - startpos);
3068 else if (endpos == pos
3069 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3070 record_overlay_string (&overlay_tails, str, Qnil,
3071 Foverlay_get (overlay, Qpriority),
3072 endpos - startpos);
3074 if (overlay_tails.used > 1)
3075 qsort (overlay_tails.buf, overlay_tails.used, sizeof (struct sortstr),
3076 cmp_for_strings);
3077 if (overlay_heads.used > 1)
3078 qsort (overlay_heads.buf, overlay_heads.used, sizeof (struct sortstr),
3079 cmp_for_strings);
3080 if (overlay_heads.bytes || overlay_tails.bytes)
3082 Lisp_Object tem;
3083 ptrdiff_t i;
3084 unsigned char *p;
3085 ptrdiff_t total;
3087 if (INT_ADD_OVERFLOW (overlay_heads.bytes, overlay_tails.bytes))
3088 memory_full (SIZE_MAX);
3089 total = overlay_heads.bytes + overlay_tails.bytes;
3090 if (total > overlay_str_len)
3091 overlay_str_buf = xpalloc (overlay_str_buf, &overlay_str_len,
3092 total - overlay_str_len, -1, 1);
3094 p = overlay_str_buf;
3095 for (i = overlay_tails.used; --i >= 0;)
3097 ptrdiff_t nbytes;
3098 tem = overlay_tails.buf[i].string;
3099 nbytes = copy_text (SDATA (tem), p,
3100 SBYTES (tem),
3101 STRING_MULTIBYTE (tem), multibyte);
3102 p += nbytes;
3104 for (i = 0; i < overlay_heads.used; ++i)
3106 ptrdiff_t nbytes;
3107 tem = overlay_heads.buf[i].string;
3108 nbytes = copy_text (SDATA (tem), p,
3109 SBYTES (tem),
3110 STRING_MULTIBYTE (tem), multibyte);
3111 p += nbytes;
3112 tem = overlay_heads.buf[i].string2;
3113 if (STRINGP (tem))
3115 nbytes = copy_text (SDATA (tem), p,
3116 SBYTES (tem),
3117 STRING_MULTIBYTE (tem), multibyte);
3118 p += nbytes;
3121 if (p != overlay_str_buf + total)
3122 abort ();
3123 if (pstr)
3124 *pstr = overlay_str_buf;
3125 return total;
3127 return 0;
3130 /* Shift overlays in BUF's overlay lists, to center the lists at POS. */
3132 void
3133 recenter_overlay_lists (struct buffer *buf, ptrdiff_t pos)
3135 Lisp_Object overlay, beg, end;
3136 struct Lisp_Overlay *prev, *tail, *next;
3138 /* See if anything in overlays_before should move to overlays_after. */
3140 /* We don't strictly need prev in this loop; it should always be nil.
3141 But we use it for symmetry and in case that should cease to be true
3142 with some future change. */
3143 prev = NULL;
3144 for (tail = buf->overlays_before; tail; prev = tail, tail = next)
3146 next = tail->next;
3147 XSETMISC (overlay, tail);
3149 /* If the overlay is not valid, get rid of it. */
3150 if (!OVERLAY_VALID (overlay))
3151 #if 1
3152 abort ();
3153 #else
3155 /* Splice the cons cell TAIL out of overlays_before. */
3156 if (!NILP (prev))
3157 XCDR (prev) = next;
3158 else
3159 buf->overlays_before = next;
3160 tail = prev;
3161 continue;
3163 #endif
3165 beg = OVERLAY_START (overlay);
3166 end = OVERLAY_END (overlay);
3168 if (OVERLAY_POSITION (end) > pos)
3170 /* OVERLAY needs to be moved. */
3171 ptrdiff_t where = OVERLAY_POSITION (beg);
3172 struct Lisp_Overlay *other, *other_prev;
3174 /* Splice the cons cell TAIL out of overlays_before. */
3175 if (prev)
3176 prev->next = next;
3177 else
3178 buf->overlays_before = next;
3180 /* Search thru overlays_after for where to put it. */
3181 other_prev = NULL;
3182 for (other = buf->overlays_after; other;
3183 other_prev = other, other = other->next)
3185 Lisp_Object otherbeg, otheroverlay;
3187 XSETMISC (otheroverlay, other);
3188 eassert (OVERLAY_VALID (otheroverlay));
3190 otherbeg = OVERLAY_START (otheroverlay);
3191 if (OVERLAY_POSITION (otherbeg) >= where)
3192 break;
3195 /* Add TAIL to overlays_after before OTHER. */
3196 tail->next = other;
3197 if (other_prev)
3198 other_prev->next = tail;
3199 else
3200 buf->overlays_after = tail;
3201 tail = prev;
3203 else
3204 /* We've reached the things that should stay in overlays_before.
3205 All the rest of overlays_before must end even earlier,
3206 so stop now. */
3207 break;
3210 /* See if anything in overlays_after should be in overlays_before. */
3211 prev = NULL;
3212 for (tail = buf->overlays_after; tail; prev = tail, tail = next)
3214 next = tail->next;
3215 XSETMISC (overlay, tail);
3217 /* If the overlay is not valid, get rid of it. */
3218 if (!OVERLAY_VALID (overlay))
3219 #if 1
3220 abort ();
3221 #else
3223 /* Splice the cons cell TAIL out of overlays_after. */
3224 if (!NILP (prev))
3225 XCDR (prev) = next;
3226 else
3227 buf->overlays_after = next;
3228 tail = prev;
3229 continue;
3231 #endif
3233 beg = OVERLAY_START (overlay);
3234 end = OVERLAY_END (overlay);
3236 /* Stop looking, when we know that nothing further
3237 can possibly end before POS. */
3238 if (OVERLAY_POSITION (beg) > pos)
3239 break;
3241 if (OVERLAY_POSITION (end) <= pos)
3243 /* OVERLAY needs to be moved. */
3244 ptrdiff_t where = OVERLAY_POSITION (end);
3245 struct Lisp_Overlay *other, *other_prev;
3247 /* Splice the cons cell TAIL out of overlays_after. */
3248 if (prev)
3249 prev->next = next;
3250 else
3251 buf->overlays_after = next;
3253 /* Search thru overlays_before for where to put it. */
3254 other_prev = NULL;
3255 for (other = buf->overlays_before; other;
3256 other_prev = other, other = other->next)
3258 Lisp_Object otherend, otheroverlay;
3260 XSETMISC (otheroverlay, other);
3261 eassert (OVERLAY_VALID (otheroverlay));
3263 otherend = OVERLAY_END (otheroverlay);
3264 if (OVERLAY_POSITION (otherend) <= where)
3265 break;
3268 /* Add TAIL to overlays_before before OTHER. */
3269 tail->next = other;
3270 if (other_prev)
3271 other_prev->next = tail;
3272 else
3273 buf->overlays_before = tail;
3274 tail = prev;
3278 buf->overlay_center = pos;
3281 void
3282 adjust_overlays_for_insert (ptrdiff_t pos, ptrdiff_t length)
3284 /* After an insertion, the lists are still sorted properly,
3285 but we may need to update the value of the overlay center. */
3286 if (current_buffer->overlay_center >= pos)
3287 current_buffer->overlay_center += length;
3290 void
3291 adjust_overlays_for_delete (ptrdiff_t pos, ptrdiff_t length)
3293 if (current_buffer->overlay_center < pos)
3294 /* The deletion was to our right. No change needed; the before- and
3295 after-lists are still consistent. */
3297 else if (current_buffer->overlay_center - pos > length)
3298 /* The deletion was to our left. We need to adjust the center value
3299 to account for the change in position, but the lists are consistent
3300 given the new value. */
3301 current_buffer->overlay_center -= length;
3302 else
3303 /* We're right in the middle. There might be things on the after-list
3304 that now belong on the before-list. Recentering will move them,
3305 and also update the center point. */
3306 recenter_overlay_lists (current_buffer, pos);
3309 /* Fix up overlays that were garbled as a result of permuting markers
3310 in the range START through END. Any overlay with at least one
3311 endpoint in this range will need to be unlinked from the overlay
3312 list and reinserted in its proper place.
3313 Such an overlay might even have negative size at this point.
3314 If so, we'll make the overlay empty. */
3315 void
3316 fix_start_end_in_overlays (register ptrdiff_t start, register ptrdiff_t end)
3318 Lisp_Object overlay;
3319 struct Lisp_Overlay *before_list IF_LINT (= NULL);
3320 struct Lisp_Overlay *after_list IF_LINT (= NULL);
3321 /* These are either nil, indicating that before_list or after_list
3322 should be assigned, or the cons cell the cdr of which should be
3323 assigned. */
3324 struct Lisp_Overlay *beforep = NULL, *afterp = NULL;
3325 /* 'Parent', likewise, indicates a cons cell or
3326 current_buffer->overlays_before or overlays_after, depending
3327 which loop we're in. */
3328 struct Lisp_Overlay *tail, *parent;
3329 ptrdiff_t startpos, endpos;
3331 /* This algorithm shifts links around instead of consing and GCing.
3332 The loop invariant is that before_list (resp. after_list) is a
3333 well-formed list except that its last element, the CDR of beforep
3334 (resp. afterp) if beforep (afterp) isn't nil or before_list
3335 (after_list) if it is, is still uninitialized. So it's not a bug
3336 that before_list isn't initialized, although it may look
3337 strange. */
3338 for (parent = NULL, tail = current_buffer->overlays_before; tail;)
3340 XSETMISC (overlay, tail);
3342 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3343 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3345 /* If the overlay is backwards, make it empty. */
3346 if (endpos < startpos)
3348 startpos = endpos;
3349 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3350 Qnil);
3353 if (endpos < start)
3354 break;
3356 if (endpos < end
3357 || (startpos >= start && startpos < end))
3359 /* Add it to the end of the wrong list. Later on,
3360 recenter_overlay_lists will move it to the right place. */
3361 if (endpos < current_buffer->overlay_center)
3363 if (!afterp)
3364 after_list = tail;
3365 else
3366 afterp->next = tail;
3367 afterp = tail;
3369 else
3371 if (!beforep)
3372 before_list = tail;
3373 else
3374 beforep->next = tail;
3375 beforep = tail;
3377 if (!parent)
3378 current_buffer->overlays_before = tail->next;
3379 else
3380 parent->next = tail->next;
3381 tail = tail->next;
3383 else
3384 parent = tail, tail = parent->next;
3386 for (parent = NULL, tail = current_buffer->overlays_after; tail;)
3388 XSETMISC (overlay, tail);
3390 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3391 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3393 /* If the overlay is backwards, make it empty. */
3394 if (endpos < startpos)
3396 startpos = endpos;
3397 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3398 Qnil);
3401 if (startpos >= end)
3402 break;
3404 if (startpos >= start
3405 || (endpos >= start && endpos < end))
3407 if (endpos < current_buffer->overlay_center)
3409 if (!afterp)
3410 after_list = tail;
3411 else
3412 afterp->next = tail;
3413 afterp = tail;
3415 else
3417 if (!beforep)
3418 before_list = tail;
3419 else
3420 beforep->next = tail;
3421 beforep = tail;
3423 if (!parent)
3424 current_buffer->overlays_after = tail->next;
3425 else
3426 parent->next = tail->next;
3427 tail = tail->next;
3429 else
3430 parent = tail, tail = parent->next;
3433 /* Splice the constructed (wrong) lists into the buffer's lists,
3434 and let the recenter function make it sane again. */
3435 if (beforep)
3437 beforep->next = current_buffer->overlays_before;
3438 current_buffer->overlays_before = before_list;
3440 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3442 if (afterp)
3444 afterp->next = current_buffer->overlays_after;
3445 current_buffer->overlays_after = after_list;
3447 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3450 /* We have two types of overlay: the one whose ending marker is
3451 after-insertion-marker (this is the usual case) and the one whose
3452 ending marker is before-insertion-marker. When `overlays_before'
3453 contains overlays of the latter type and the former type in this
3454 order and both overlays end at inserting position, inserting a text
3455 increases only the ending marker of the latter type, which results
3456 in incorrect ordering of `overlays_before'.
3458 This function fixes ordering of overlays in the slot
3459 `overlays_before' of the buffer *BP. Before the insertion, `point'
3460 was at PREV, and now is at POS. */
3462 void
3463 fix_overlays_before (struct buffer *bp, ptrdiff_t prev, ptrdiff_t pos)
3465 /* If parent is nil, replace overlays_before; otherwise, parent->next. */
3466 struct Lisp_Overlay *tail = bp->overlays_before, *parent = NULL, *right_pair;
3467 Lisp_Object tem;
3468 ptrdiff_t end IF_LINT (= 0);
3470 /* After the insertion, the several overlays may be in incorrect
3471 order. The possibility is that, in the list `overlays_before',
3472 an overlay which ends at POS appears after an overlay which ends
3473 at PREV. Since POS is greater than PREV, we must fix the
3474 ordering of these overlays, by moving overlays ends at POS before
3475 the overlays ends at PREV. */
3477 /* At first, find a place where disordered overlays should be linked
3478 in. It is where an overlay which end before POS exists. (i.e. an
3479 overlay whose ending marker is after-insertion-marker if disorder
3480 exists). */
3481 while (tail
3482 && (XSETMISC (tem, tail),
3483 (end = OVERLAY_POSITION (OVERLAY_END (tem))) >= pos))
3485 parent = tail;
3486 tail = tail->next;
3489 /* If we don't find such an overlay,
3490 or the found one ends before PREV,
3491 or the found one is the last one in the list,
3492 we don't have to fix anything. */
3493 if (!tail || end < prev || !tail->next)
3494 return;
3496 right_pair = parent;
3497 parent = tail;
3498 tail = tail->next;
3500 /* Now, end position of overlays in the list TAIL should be before
3501 or equal to PREV. In the loop, an overlay which ends at POS is
3502 moved ahead to the place indicated by the CDR of RIGHT_PAIR. If
3503 we found an overlay which ends before PREV, the remaining
3504 overlays are in correct order. */
3505 while (tail)
3507 XSETMISC (tem, tail);
3508 end = OVERLAY_POSITION (OVERLAY_END (tem));
3510 if (end == pos)
3511 { /* This overlay is disordered. */
3512 struct Lisp_Overlay *found = tail;
3514 /* Unlink the found overlay. */
3515 tail = found->next;
3516 parent->next = tail;
3517 /* Move an overlay at RIGHT_PLACE to the next of the found one,
3518 and link it into the right place. */
3519 if (!right_pair)
3521 found->next = bp->overlays_before;
3522 bp->overlays_before = found;
3524 else
3526 found->next = right_pair->next;
3527 right_pair->next = found;
3530 else if (end == prev)
3532 parent = tail;
3533 tail = tail->next;
3535 else /* No more disordered overlay. */
3536 break;
3540 DEFUN ("overlayp", Foverlayp, Soverlayp, 1, 1, 0,
3541 doc: /* Return t if OBJECT is an overlay. */)
3542 (Lisp_Object object)
3544 return (OVERLAYP (object) ? Qt : Qnil);
3547 DEFUN ("make-overlay", Fmake_overlay, Smake_overlay, 2, 5, 0,
3548 doc: /* Create a new overlay with range BEG to END in BUFFER.
3549 If omitted, BUFFER defaults to the current buffer.
3550 BEG and END may be integers or markers.
3551 The fourth arg FRONT-ADVANCE, if non-nil, makes the marker
3552 for the front of the overlay advance when text is inserted there
3553 \(which means the text *is not* included in the overlay).
3554 The fifth arg REAR-ADVANCE, if non-nil, makes the marker
3555 for the rear of the overlay advance when text is inserted there
3556 \(which means the text *is* included in the overlay). */)
3557 (Lisp_Object beg, Lisp_Object end, Lisp_Object buffer, Lisp_Object front_advance, Lisp_Object rear_advance)
3559 Lisp_Object overlay;
3560 struct buffer *b;
3562 if (NILP (buffer))
3563 XSETBUFFER (buffer, current_buffer);
3564 else
3565 CHECK_BUFFER (buffer);
3566 if (MARKERP (beg)
3567 && ! EQ (Fmarker_buffer (beg), buffer))
3568 error ("Marker points into wrong buffer");
3569 if (MARKERP (end)
3570 && ! EQ (Fmarker_buffer (end), buffer))
3571 error ("Marker points into wrong buffer");
3573 CHECK_NUMBER_COERCE_MARKER (beg);
3574 CHECK_NUMBER_COERCE_MARKER (end);
3576 if (XINT (beg) > XINT (end))
3578 Lisp_Object temp;
3579 temp = beg; beg = end; end = temp;
3582 b = XBUFFER (buffer);
3584 beg = Fset_marker (Fmake_marker (), beg, buffer);
3585 end = Fset_marker (Fmake_marker (), end, buffer);
3587 if (!NILP (front_advance))
3588 XMARKER (beg)->insertion_type = 1;
3589 if (!NILP (rear_advance))
3590 XMARKER (end)->insertion_type = 1;
3592 overlay = allocate_misc ();
3593 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
3594 XOVERLAY (overlay)->start = beg;
3595 XOVERLAY (overlay)->end = end;
3596 XOVERLAY (overlay)->plist = Qnil;
3597 XOVERLAY (overlay)->next = NULL;
3599 /* Put the new overlay on the wrong list. */
3600 end = OVERLAY_END (overlay);
3601 if (OVERLAY_POSITION (end) < b->overlay_center)
3603 if (b->overlays_after)
3604 XOVERLAY (overlay)->next = b->overlays_after;
3605 b->overlays_after = XOVERLAY (overlay);
3607 else
3609 if (b->overlays_before)
3610 XOVERLAY (overlay)->next = b->overlays_before;
3611 b->overlays_before = XOVERLAY (overlay);
3614 /* This puts it in the right list, and in the right order. */
3615 recenter_overlay_lists (b, b->overlay_center);
3617 /* We don't need to redisplay the region covered by the overlay, because
3618 the overlay has no properties at the moment. */
3620 return overlay;
3623 /* Mark a section of BUF as needing redisplay because of overlays changes. */
3625 static void
3626 modify_overlay (struct buffer *buf, ptrdiff_t start, ptrdiff_t end)
3628 if (start > end)
3630 ptrdiff_t temp = start;
3631 start = end;
3632 end = temp;
3635 BUF_COMPUTE_UNCHANGED (buf, start, end);
3637 /* If this is a buffer not in the selected window,
3638 we must do other windows. */
3639 if (buf != XBUFFER (XWINDOW (selected_window)->buffer))
3640 windows_or_buffers_changed = 1;
3641 /* If multiple windows show this buffer, we must do other windows. */
3642 else if (buffer_shared > 1)
3643 windows_or_buffers_changed = 1;
3644 /* If we modify an overlay at the end of the buffer, we cannot
3645 be sure that window end is still valid. */
3646 else if (end >= ZV && start <= ZV)
3647 windows_or_buffers_changed = 1;
3649 ++BUF_OVERLAY_MODIFF (buf);
3653 static struct Lisp_Overlay *
3654 unchain_overlay (struct Lisp_Overlay *list, struct Lisp_Overlay *overlay)
3656 struct Lisp_Overlay *tmp, *prev;
3657 for (tmp = list, prev = NULL; tmp; prev = tmp, tmp = tmp->next)
3658 if (tmp == overlay)
3660 if (prev)
3661 prev->next = tmp->next;
3662 else
3663 list = tmp->next;
3664 overlay->next = NULL;
3665 break;
3667 return list;
3670 DEFUN ("move-overlay", Fmove_overlay, Smove_overlay, 3, 4, 0,
3671 doc: /* Set the endpoints of OVERLAY to BEG and END in BUFFER.
3672 If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.
3673 If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current
3674 buffer. */)
3675 (Lisp_Object overlay, Lisp_Object beg, Lisp_Object end, Lisp_Object buffer)
3677 struct buffer *b, *ob;
3678 Lisp_Object obuffer;
3679 ptrdiff_t count = SPECPDL_INDEX ();
3680 ptrdiff_t n_beg, n_end;
3682 CHECK_OVERLAY (overlay);
3683 if (NILP (buffer))
3684 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3685 if (NILP (buffer))
3686 XSETBUFFER (buffer, current_buffer);
3687 CHECK_BUFFER (buffer);
3689 if (MARKERP (beg)
3690 && ! EQ (Fmarker_buffer (beg), buffer))
3691 error ("Marker points into wrong buffer");
3692 if (MARKERP (end)
3693 && ! EQ (Fmarker_buffer (end), buffer))
3694 error ("Marker points into wrong buffer");
3696 CHECK_NUMBER_COERCE_MARKER (beg);
3697 CHECK_NUMBER_COERCE_MARKER (end);
3699 if (XINT (beg) > XINT (end))
3701 Lisp_Object temp;
3702 temp = beg; beg = end; end = temp;
3705 Fset_marker (OVERLAY_START (overlay), beg, buffer);
3706 Fset_marker (OVERLAY_END (overlay), end, buffer);
3707 n_beg = marker_position (OVERLAY_START (overlay));
3708 n_end = marker_position (OVERLAY_END (overlay));
3710 if (n_beg == n_end && ! NILP (Foverlay_get (overlay, Qevaporate)))
3711 return Fdelete_overlay (overlay);
3713 specbind (Qinhibit_quit, Qt);
3715 obuffer = Fmarker_buffer (OVERLAY_START (overlay));
3716 b = XBUFFER (buffer);
3717 ob = BUFFERP (obuffer) ? XBUFFER (obuffer) : (struct buffer *) 0;
3719 /* If the overlay has changed buffers, do a thorough redisplay. */
3720 if (!EQ (buffer, obuffer))
3722 /* Redisplay where the overlay was. */
3723 if (!NILP (obuffer))
3725 ptrdiff_t o_beg;
3726 ptrdiff_t o_end;
3728 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3729 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3731 modify_overlay (ob, o_beg, o_end);
3734 /* Redisplay where the overlay is going to be. */
3735 modify_overlay (b, n_beg, n_end);
3737 else
3738 /* Redisplay the area the overlay has just left, or just enclosed. */
3740 ptrdiff_t o_beg, o_end;
3742 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3743 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3745 if (o_beg == n_beg)
3746 modify_overlay (b, o_end, n_end);
3747 else if (o_end == n_end)
3748 modify_overlay (b, o_beg, n_beg);
3749 else
3750 modify_overlay (b, min (o_beg, n_beg), max (o_end, n_end));
3753 if (!NILP (obuffer))
3755 ob->overlays_before
3756 = unchain_overlay (ob->overlays_before, XOVERLAY (overlay));
3757 ob->overlays_after
3758 = unchain_overlay (ob->overlays_after, XOVERLAY (overlay));
3759 eassert (XOVERLAY (overlay)->next == NULL);
3762 /* Put the overlay on the wrong list. */
3763 if (n_end < b->overlay_center)
3765 XOVERLAY (overlay)->next = b->overlays_after;
3766 b->overlays_after = XOVERLAY (overlay);
3768 else
3770 XOVERLAY (overlay)->next = b->overlays_before;
3771 b->overlays_before = XOVERLAY (overlay);
3774 /* This puts it in the right list, and in the right order. */
3775 recenter_overlay_lists (b, b->overlay_center);
3777 return unbind_to (count, overlay);
3780 DEFUN ("delete-overlay", Fdelete_overlay, Sdelete_overlay, 1, 1, 0,
3781 doc: /* Delete the overlay OVERLAY from its buffer. */)
3782 (Lisp_Object overlay)
3784 Lisp_Object buffer;
3785 struct buffer *b;
3786 ptrdiff_t count = SPECPDL_INDEX ();
3788 CHECK_OVERLAY (overlay);
3790 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3791 if (NILP (buffer))
3792 return Qnil;
3794 b = XBUFFER (buffer);
3795 specbind (Qinhibit_quit, Qt);
3797 b->overlays_before = unchain_overlay (b->overlays_before,XOVERLAY (overlay));
3798 b->overlays_after = unchain_overlay (b->overlays_after, XOVERLAY (overlay));
3799 eassert (XOVERLAY (overlay)->next == NULL);
3800 modify_overlay (b,
3801 marker_position (OVERLAY_START (overlay)),
3802 marker_position (OVERLAY_END (overlay)));
3803 Fset_marker (OVERLAY_START (overlay), Qnil, Qnil);
3804 Fset_marker (OVERLAY_END (overlay), Qnil, Qnil);
3806 /* When deleting an overlay with before or after strings, turn off
3807 display optimizations for the affected buffer, on the basis that
3808 these strings may contain newlines. This is easier to do than to
3809 check for that situation during redisplay. */
3810 if (!windows_or_buffers_changed
3811 && (!NILP (Foverlay_get (overlay, Qbefore_string))
3812 || !NILP (Foverlay_get (overlay, Qafter_string))))
3813 b->prevent_redisplay_optimizations_p = 1;
3815 return unbind_to (count, Qnil);
3818 /* Overlay dissection functions. */
3820 DEFUN ("overlay-start", Foverlay_start, Soverlay_start, 1, 1, 0,
3821 doc: /* Return the position at which OVERLAY starts. */)
3822 (Lisp_Object overlay)
3824 CHECK_OVERLAY (overlay);
3826 return (Fmarker_position (OVERLAY_START (overlay)));
3829 DEFUN ("overlay-end", Foverlay_end, Soverlay_end, 1, 1, 0,
3830 doc: /* Return the position at which OVERLAY ends. */)
3831 (Lisp_Object overlay)
3833 CHECK_OVERLAY (overlay);
3835 return (Fmarker_position (OVERLAY_END (overlay)));
3838 DEFUN ("overlay-buffer", Foverlay_buffer, Soverlay_buffer, 1, 1, 0,
3839 doc: /* Return the buffer OVERLAY belongs to.
3840 Return nil if OVERLAY has been deleted. */)
3841 (Lisp_Object overlay)
3843 CHECK_OVERLAY (overlay);
3845 return Fmarker_buffer (OVERLAY_START (overlay));
3848 DEFUN ("overlay-properties", Foverlay_properties, Soverlay_properties, 1, 1, 0,
3849 doc: /* Return a list of the properties on OVERLAY.
3850 This is a copy of OVERLAY's plist; modifying its conses has no effect on
3851 OVERLAY. */)
3852 (Lisp_Object overlay)
3854 CHECK_OVERLAY (overlay);
3856 return Fcopy_sequence (XOVERLAY (overlay)->plist);
3860 DEFUN ("overlays-at", Foverlays_at, Soverlays_at, 1, 1, 0,
3861 doc: /* Return a list of the overlays that contain the character at POS. */)
3862 (Lisp_Object pos)
3864 ptrdiff_t len, noverlays;
3865 Lisp_Object *overlay_vec;
3866 Lisp_Object result;
3868 CHECK_NUMBER_COERCE_MARKER (pos);
3870 len = 10;
3871 /* We can't use alloca here because overlays_at can call xrealloc. */
3872 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3874 /* Put all the overlays we want in a vector in overlay_vec.
3875 Store the length in len. */
3876 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3877 0, 0, 0);
3879 /* Make a list of them all. */
3880 result = Flist (noverlays, overlay_vec);
3882 xfree (overlay_vec);
3883 return result;
3886 DEFUN ("overlays-in", Foverlays_in, Soverlays_in, 2, 2, 0,
3887 doc: /* Return a list of the overlays that overlap the region BEG ... END.
3888 Overlap means that at least one character is contained within the overlay
3889 and also contained within the specified region.
3890 Empty overlays are included in the result if they are located at BEG,
3891 between BEG and END, or at END provided END denotes the position at the
3892 end of the buffer. */)
3893 (Lisp_Object beg, Lisp_Object end)
3895 ptrdiff_t len, noverlays;
3896 Lisp_Object *overlay_vec;
3897 Lisp_Object result;
3899 CHECK_NUMBER_COERCE_MARKER (beg);
3900 CHECK_NUMBER_COERCE_MARKER (end);
3902 len = 10;
3903 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3905 /* Put all the overlays we want in a vector in overlay_vec.
3906 Store the length in len. */
3907 noverlays = overlays_in (XINT (beg), XINT (end), 1, &overlay_vec, &len,
3908 NULL, NULL);
3910 /* Make a list of them all. */
3911 result = Flist (noverlays, overlay_vec);
3913 xfree (overlay_vec);
3914 return result;
3917 DEFUN ("next-overlay-change", Fnext_overlay_change, Snext_overlay_change,
3918 1, 1, 0,
3919 doc: /* Return the next position after POS where an overlay starts or ends.
3920 If there are no overlay boundaries from POS to (point-max),
3921 the value is (point-max). */)
3922 (Lisp_Object pos)
3924 ptrdiff_t i, len, noverlays;
3925 ptrdiff_t endpos;
3926 Lisp_Object *overlay_vec;
3928 CHECK_NUMBER_COERCE_MARKER (pos);
3930 len = 10;
3931 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3933 /* Put all the overlays we want in a vector in overlay_vec.
3934 Store the length in len.
3935 endpos gets the position where the next overlay starts. */
3936 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3937 &endpos, 0, 1);
3939 /* If any of these overlays ends before endpos,
3940 use its ending point instead. */
3941 for (i = 0; i < noverlays; i++)
3943 Lisp_Object oend;
3944 ptrdiff_t oendpos;
3946 oend = OVERLAY_END (overlay_vec[i]);
3947 oendpos = OVERLAY_POSITION (oend);
3948 if (oendpos < endpos)
3949 endpos = oendpos;
3952 xfree (overlay_vec);
3953 return make_number (endpos);
3956 DEFUN ("previous-overlay-change", Fprevious_overlay_change,
3957 Sprevious_overlay_change, 1, 1, 0,
3958 doc: /* Return the previous position before POS where an overlay starts or ends.
3959 If there are no overlay boundaries from (point-min) to POS,
3960 the value is (point-min). */)
3961 (Lisp_Object pos)
3963 ptrdiff_t prevpos;
3964 Lisp_Object *overlay_vec;
3965 ptrdiff_t len;
3967 CHECK_NUMBER_COERCE_MARKER (pos);
3969 /* At beginning of buffer, we know the answer;
3970 avoid bug subtracting 1 below. */
3971 if (XINT (pos) == BEGV)
3972 return pos;
3974 len = 10;
3975 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3977 /* Put all the overlays we want in a vector in overlay_vec.
3978 Store the length in len.
3979 prevpos gets the position of the previous change. */
3980 overlays_at (XINT (pos), 1, &overlay_vec, &len,
3981 0, &prevpos, 1);
3983 xfree (overlay_vec);
3984 return make_number (prevpos);
3987 /* These functions are for debugging overlays. */
3989 DEFUN ("overlay-lists", Foverlay_lists, Soverlay_lists, 0, 0, 0,
3990 doc: /* Return a pair of lists giving all the overlays of the current buffer.
3991 The car has all the overlays before the overlay center;
3992 the cdr has all the overlays after the overlay center.
3993 Recentering overlays moves overlays between these lists.
3994 The lists you get are copies, so that changing them has no effect.
3995 However, the overlays you get are the real objects that the buffer uses. */)
3996 (void)
3998 struct Lisp_Overlay *ol;
3999 Lisp_Object before = Qnil, after = Qnil, tmp;
4000 for (ol = current_buffer->overlays_before; ol; ol = ol->next)
4002 XSETMISC (tmp, ol);
4003 before = Fcons (tmp, before);
4005 for (ol = current_buffer->overlays_after; ol; ol = ol->next)
4007 XSETMISC (tmp, ol);
4008 after = Fcons (tmp, after);
4010 return Fcons (Fnreverse (before), Fnreverse (after));
4013 DEFUN ("overlay-recenter", Foverlay_recenter, Soverlay_recenter, 1, 1, 0,
4014 doc: /* Recenter the overlays of the current buffer around position POS.
4015 That makes overlay lookup faster for positions near POS (but perhaps slower
4016 for positions far away from POS). */)
4017 (Lisp_Object pos)
4019 ptrdiff_t p;
4020 CHECK_NUMBER_COERCE_MARKER (pos);
4022 p = clip_to_bounds (PTRDIFF_MIN, XINT (pos), PTRDIFF_MAX);
4023 recenter_overlay_lists (current_buffer, p);
4024 return Qnil;
4027 DEFUN ("overlay-get", Foverlay_get, Soverlay_get, 2, 2, 0,
4028 doc: /* Get the property of overlay OVERLAY with property name PROP. */)
4029 (Lisp_Object overlay, Lisp_Object prop)
4031 CHECK_OVERLAY (overlay);
4032 return lookup_char_property (XOVERLAY (overlay)->plist, prop, 0);
4035 DEFUN ("overlay-put", Foverlay_put, Soverlay_put, 3, 3, 0,
4036 doc: /* Set one property of overlay OVERLAY: give property PROP value VALUE.
4037 VALUE will be returned.*/)
4038 (Lisp_Object overlay, Lisp_Object prop, Lisp_Object value)
4040 Lisp_Object tail, buffer;
4041 int changed;
4043 CHECK_OVERLAY (overlay);
4045 buffer = Fmarker_buffer (OVERLAY_START (overlay));
4047 for (tail = XOVERLAY (overlay)->plist;
4048 CONSP (tail) && CONSP (XCDR (tail));
4049 tail = XCDR (XCDR (tail)))
4050 if (EQ (XCAR (tail), prop))
4052 changed = !EQ (XCAR (XCDR (tail)), value);
4053 XSETCAR (XCDR (tail), value);
4054 goto found;
4056 /* It wasn't in the list, so add it to the front. */
4057 changed = !NILP (value);
4058 XOVERLAY (overlay)->plist
4059 = Fcons (prop, Fcons (value, XOVERLAY (overlay)->plist));
4060 found:
4061 if (! NILP (buffer))
4063 if (changed)
4064 modify_overlay (XBUFFER (buffer),
4065 marker_position (OVERLAY_START (overlay)),
4066 marker_position (OVERLAY_END (overlay)));
4067 if (EQ (prop, Qevaporate) && ! NILP (value)
4068 && (OVERLAY_POSITION (OVERLAY_START (overlay))
4069 == OVERLAY_POSITION (OVERLAY_END (overlay))))
4070 Fdelete_overlay (overlay);
4073 return value;
4076 /* Subroutine of report_overlay_modification. */
4078 /* Lisp vector holding overlay hook functions to call.
4079 Vector elements come in pairs.
4080 Each even-index element is a list of hook functions.
4081 The following odd-index element is the overlay they came from.
4083 Before the buffer change, we fill in this vector
4084 as we call overlay hook functions.
4085 After the buffer change, we get the functions to call from this vector.
4086 This way we always call the same functions before and after the change. */
4087 static Lisp_Object last_overlay_modification_hooks;
4089 /* Number of elements actually used in last_overlay_modification_hooks. */
4090 static ptrdiff_t last_overlay_modification_hooks_used;
4092 /* Add one functionlist/overlay pair
4093 to the end of last_overlay_modification_hooks. */
4095 static void
4096 add_overlay_mod_hooklist (Lisp_Object functionlist, Lisp_Object overlay)
4098 ptrdiff_t oldsize = ASIZE (last_overlay_modification_hooks);
4100 if (oldsize - 1 <= last_overlay_modification_hooks_used)
4101 last_overlay_modification_hooks =
4102 larger_vector (last_overlay_modification_hooks, 2, -1);
4103 ASET (last_overlay_modification_hooks, last_overlay_modification_hooks_used,
4104 functionlist); last_overlay_modification_hooks_used++;
4105 ASET (last_overlay_modification_hooks, last_overlay_modification_hooks_used,
4106 overlay); last_overlay_modification_hooks_used++;
4109 /* Run the modification-hooks of overlays that include
4110 any part of the text in START to END.
4111 If this change is an insertion, also
4112 run the insert-before-hooks of overlay starting at END,
4113 and the insert-after-hooks of overlay ending at START.
4115 This is called both before and after the modification.
4116 AFTER is nonzero when we call after the modification.
4118 ARG1, ARG2, ARG3 are arguments to pass to the hook functions.
4119 When AFTER is nonzero, they are the start position,
4120 the position after the inserted new text,
4121 and the length of deleted or replaced old text. */
4123 void
4124 report_overlay_modification (Lisp_Object start, Lisp_Object end, int after,
4125 Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3)
4127 Lisp_Object prop, overlay;
4128 struct Lisp_Overlay *tail;
4129 /* 1 if this change is an insertion. */
4130 int insertion = (after ? XFASTINT (arg3) == 0 : EQ (start, end));
4131 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4133 overlay = Qnil;
4134 tail = NULL;
4136 /* We used to run the functions as soon as we found them and only register
4137 them in last_overlay_modification_hooks for the purpose of the `after'
4138 case. But running elisp code as we traverse the list of overlays is
4139 painful because the list can be modified by the elisp code so we had to
4140 copy at several places. We now simply do a read-only traversal that
4141 only collects the functions to run and we run them afterwards. It's
4142 simpler, especially since all the code was already there. -stef */
4144 if (!after)
4146 /* We are being called before a change.
4147 Scan the overlays to find the functions to call. */
4148 last_overlay_modification_hooks_used = 0;
4149 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4151 ptrdiff_t startpos, endpos;
4152 Lisp_Object ostart, oend;
4154 XSETMISC (overlay, tail);
4156 ostart = OVERLAY_START (overlay);
4157 oend = OVERLAY_END (overlay);
4158 endpos = OVERLAY_POSITION (oend);
4159 if (XFASTINT (start) > endpos)
4160 break;
4161 startpos = OVERLAY_POSITION (ostart);
4162 if (insertion && (XFASTINT (start) == startpos
4163 || XFASTINT (end) == startpos))
4165 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4166 if (!NILP (prop))
4167 add_overlay_mod_hooklist (prop, overlay);
4169 if (insertion && (XFASTINT (start) == endpos
4170 || XFASTINT (end) == endpos))
4172 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4173 if (!NILP (prop))
4174 add_overlay_mod_hooklist (prop, overlay);
4176 /* Test for intersecting intervals. This does the right thing
4177 for both insertion and deletion. */
4178 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4180 prop = Foverlay_get (overlay, Qmodification_hooks);
4181 if (!NILP (prop))
4182 add_overlay_mod_hooklist (prop, overlay);
4186 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4188 ptrdiff_t startpos, endpos;
4189 Lisp_Object ostart, oend;
4191 XSETMISC (overlay, tail);
4193 ostart = OVERLAY_START (overlay);
4194 oend = OVERLAY_END (overlay);
4195 startpos = OVERLAY_POSITION (ostart);
4196 endpos = OVERLAY_POSITION (oend);
4197 if (XFASTINT (end) < startpos)
4198 break;
4199 if (insertion && (XFASTINT (start) == startpos
4200 || XFASTINT (end) == startpos))
4202 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4203 if (!NILP (prop))
4204 add_overlay_mod_hooklist (prop, overlay);
4206 if (insertion && (XFASTINT (start) == endpos
4207 || XFASTINT (end) == endpos))
4209 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4210 if (!NILP (prop))
4211 add_overlay_mod_hooklist (prop, overlay);
4213 /* Test for intersecting intervals. This does the right thing
4214 for both insertion and deletion. */
4215 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4217 prop = Foverlay_get (overlay, Qmodification_hooks);
4218 if (!NILP (prop))
4219 add_overlay_mod_hooklist (prop, overlay);
4224 GCPRO4 (overlay, arg1, arg2, arg3);
4226 /* Call the functions recorded in last_overlay_modification_hooks.
4227 First copy the vector contents, in case some of these hooks
4228 do subsequent modification of the buffer. */
4229 ptrdiff_t size = last_overlay_modification_hooks_used;
4230 Lisp_Object *copy = (Lisp_Object *) alloca (size * sizeof (Lisp_Object));
4231 ptrdiff_t i;
4233 memcpy (copy, XVECTOR (last_overlay_modification_hooks)->contents,
4234 size * sizeof (Lisp_Object));
4235 gcpro1.var = copy;
4236 gcpro1.nvars = size;
4238 for (i = 0; i < size;)
4240 Lisp_Object prop_i, overlay_i;
4241 prop_i = copy[i++];
4242 overlay_i = copy[i++];
4243 call_overlay_mod_hooks (prop_i, overlay_i, after, arg1, arg2, arg3);
4246 UNGCPRO;
4249 static void
4250 call_overlay_mod_hooks (Lisp_Object list, Lisp_Object overlay, int after,
4251 Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3)
4253 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4255 GCPRO4 (list, arg1, arg2, arg3);
4257 while (CONSP (list))
4259 if (NILP (arg3))
4260 call4 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2);
4261 else
4262 call5 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2, arg3);
4263 list = XCDR (list);
4265 UNGCPRO;
4268 /* Delete any zero-sized overlays at position POS, if the `evaporate'
4269 property is set. */
4270 void
4271 evaporate_overlays (ptrdiff_t pos)
4273 Lisp_Object overlay, hit_list;
4274 struct Lisp_Overlay *tail;
4276 hit_list = Qnil;
4277 if (pos <= current_buffer->overlay_center)
4278 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4280 ptrdiff_t endpos;
4281 XSETMISC (overlay, tail);
4282 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
4283 if (endpos < pos)
4284 break;
4285 if (endpos == pos && OVERLAY_POSITION (OVERLAY_START (overlay)) == pos
4286 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4287 hit_list = Fcons (overlay, hit_list);
4289 else
4290 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4292 ptrdiff_t startpos;
4293 XSETMISC (overlay, tail);
4294 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
4295 if (startpos > pos)
4296 break;
4297 if (startpos == pos && OVERLAY_POSITION (OVERLAY_END (overlay)) == pos
4298 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4299 hit_list = Fcons (overlay, hit_list);
4301 for (; CONSP (hit_list); hit_list = XCDR (hit_list))
4302 Fdelete_overlay (XCAR (hit_list));
4305 /* Somebody has tried to store a value with an unacceptable type
4306 in the slot with offset OFFSET. */
4308 void
4309 buffer_slot_type_mismatch (Lisp_Object newval, int type)
4311 Lisp_Object predicate;
4313 switch (type)
4315 case_Lisp_Int: predicate = Qintegerp; break;
4316 case Lisp_String: predicate = Qstringp; break;
4317 case Lisp_Symbol: predicate = Qsymbolp; break;
4318 default: abort ();
4321 wrong_type_argument (predicate, newval);
4325 /***********************************************************************
4326 Allocation with mmap
4327 ***********************************************************************/
4329 #ifdef USE_MMAP_FOR_BUFFERS
4331 #include <sys/types.h>
4332 #include <sys/mman.h>
4334 #ifndef MAP_ANON
4335 #ifdef MAP_ANONYMOUS
4336 #define MAP_ANON MAP_ANONYMOUS
4337 #else
4338 #define MAP_ANON 0
4339 #endif
4340 #endif
4342 #ifndef MAP_FAILED
4343 #define MAP_FAILED ((void *) -1)
4344 #endif
4346 #include <stdio.h>
4348 #if MAP_ANON == 0
4349 #include <fcntl.h>
4350 #endif
4352 #include "coding.h"
4355 /* Memory is allocated in regions which are mapped using mmap(2).
4356 The current implementation lets the system select mapped
4357 addresses; we're not using MAP_FIXED in general, except when
4358 trying to enlarge regions.
4360 Each mapped region starts with a mmap_region structure, the user
4361 area starts after that structure, aligned to MEM_ALIGN.
4363 +-----------------------+
4364 | struct mmap_info + |
4365 | padding |
4366 +-----------------------+
4367 | user data |
4370 +-----------------------+ */
4372 struct mmap_region
4374 /* User-specified size. */
4375 size_t nbytes_specified;
4377 /* Number of bytes mapped */
4378 size_t nbytes_mapped;
4380 /* Pointer to the location holding the address of the memory
4381 allocated with the mmap'd block. The variable actually points
4382 after this structure. */
4383 POINTER_TYPE **var;
4385 /* Next and previous in list of all mmap'd regions. */
4386 struct mmap_region *next, *prev;
4389 /* Doubly-linked list of mmap'd regions. */
4391 static struct mmap_region *mmap_regions;
4393 /* File descriptor for mmap. If we don't have anonymous mapping,
4394 /dev/zero will be opened on it. */
4396 static int mmap_fd;
4398 /* Temporary storage for mmap_set_vars, see there. */
4400 static struct mmap_region *mmap_regions_1;
4401 static int mmap_fd_1;
4403 /* Page size on this system. */
4405 static int mmap_page_size;
4407 /* 1 means mmap has been initialized. */
4409 static int mmap_initialized_p;
4411 /* Value is X rounded up to the next multiple of N. */
4413 #define ROUND(X, N) (((X) + (N) - 1) / (N) * (N))
4415 /* Size of mmap_region structure plus padding. */
4417 #define MMAP_REGION_STRUCT_SIZE \
4418 ROUND (sizeof (struct mmap_region), MEM_ALIGN)
4420 /* Given a pointer P to the start of the user-visible part of a mapped
4421 region, return a pointer to the start of the region. */
4423 #define MMAP_REGION(P) \
4424 ((struct mmap_region *) ((char *) (P) - MMAP_REGION_STRUCT_SIZE))
4426 /* Given a pointer P to the start of a mapped region, return a pointer
4427 to the start of the user-visible part of the region. */
4429 #define MMAP_USER_AREA(P) \
4430 ((POINTER_TYPE *) ((char *) (P) + MMAP_REGION_STRUCT_SIZE))
4432 #define MEM_ALIGN sizeof (double)
4434 /* Predicate returning true if part of the address range [START .. END]
4435 is currently mapped. Used to prevent overwriting an existing
4436 memory mapping.
4438 Default is to conservatively assume the address range is occupied by
4439 something else. This can be overridden by system configuration
4440 files if system-specific means to determine this exists. */
4442 #ifndef MMAP_ALLOCATED_P
4443 #define MMAP_ALLOCATED_P(start, end) 1
4444 #endif
4446 /* Perform necessary initializations for the use of mmap. */
4448 static void
4449 mmap_init (void)
4451 #if MAP_ANON == 0
4452 /* The value of mmap_fd is initially 0 in temacs, and -1
4453 in a dumped Emacs. */
4454 if (mmap_fd <= 0)
4456 /* No anonymous mmap -- we need the file descriptor. */
4457 mmap_fd = open ("/dev/zero", O_RDONLY);
4458 if (mmap_fd == -1)
4459 fatal ("Cannot open /dev/zero: %s", emacs_strerror (errno));
4461 #endif /* MAP_ANON == 0 */
4463 if (mmap_initialized_p)
4464 return;
4465 mmap_initialized_p = 1;
4467 #if MAP_ANON != 0
4468 mmap_fd = -1;
4469 #endif
4471 mmap_page_size = getpagesize ();
4474 /* Return a region overlapping address range START...END, or null if
4475 none. END is not including, i.e. the last byte in the range
4476 is at END - 1. */
4478 static struct mmap_region *
4479 mmap_find (POINTER_TYPE *start, POINTER_TYPE *end)
4481 struct mmap_region *r;
4482 char *s = (char *) start, *e = (char *) end;
4484 for (r = mmap_regions; r; r = r->next)
4486 char *rstart = (char *) r;
4487 char *rend = rstart + r->nbytes_mapped;
4489 if (/* First byte of range, i.e. START, in this region? */
4490 (s >= rstart && s < rend)
4491 /* Last byte of range, i.e. END - 1, in this region? */
4492 || (e > rstart && e <= rend)
4493 /* First byte of this region in the range? */
4494 || (rstart >= s && rstart < e)
4495 /* Last byte of this region in the range? */
4496 || (rend > s && rend <= e))
4497 break;
4500 return r;
4504 /* Unmap a region. P is a pointer to the start of the user-araa of
4505 the region. Value is non-zero if successful. */
4507 static int
4508 mmap_free_1 (struct mmap_region *r)
4510 if (r->next)
4511 r->next->prev = r->prev;
4512 if (r->prev)
4513 r->prev->next = r->next;
4514 else
4515 mmap_regions = r->next;
4517 if (munmap ((POINTER_TYPE *) r, r->nbytes_mapped) == -1)
4519 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4520 return 0;
4523 return 1;
4527 /* Enlarge region R by NPAGES pages. NPAGES < 0 means shrink R.
4528 Value is non-zero if successful. */
4530 static int
4531 mmap_enlarge (struct mmap_region *r, int npages)
4533 char *region_end = (char *) r + r->nbytes_mapped;
4534 size_t nbytes;
4535 int success = 0;
4537 if (npages < 0)
4539 /* Unmap pages at the end of the region. */
4540 nbytes = - npages * mmap_page_size;
4541 if (munmap (region_end - nbytes, nbytes) == -1)
4542 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4543 else
4545 r->nbytes_mapped -= nbytes;
4546 success = 1;
4549 else if (npages > 0)
4551 nbytes = npages * mmap_page_size;
4553 /* Try to map additional pages at the end of the region. We
4554 cannot do this if the address range is already occupied by
4555 something else because mmap deletes any previous mapping.
4556 I'm not sure this is worth doing, let's see. */
4557 if (!MMAP_ALLOCATED_P (region_end, region_end + nbytes))
4559 POINTER_TYPE *p;
4561 p = mmap (region_end, nbytes, PROT_READ | PROT_WRITE,
4562 MAP_ANON | MAP_PRIVATE | MAP_FIXED, mmap_fd, 0);
4563 if (p == MAP_FAILED)
4564 ; /* fprintf (stderr, "mmap: %s\n", emacs_strerror (errno)); */
4565 else if (p != (POINTER_TYPE *) region_end)
4567 /* Kernels are free to choose a different address. In
4568 that case, unmap what we've mapped above; we have
4569 no use for it. */
4570 if (munmap (p, nbytes) == -1)
4571 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4573 else
4575 r->nbytes_mapped += nbytes;
4576 success = 1;
4581 return success;
4585 /* Set or reset variables holding references to mapped regions. If
4586 RESTORE_P is zero, set all variables to null. If RESTORE_P is
4587 non-zero, set all variables to the start of the user-areas
4588 of mapped regions.
4590 This function is called from Fdump_emacs to ensure that the dumped
4591 Emacs doesn't contain references to memory that won't be mapped
4592 when Emacs starts. */
4594 void
4595 mmap_set_vars (int restore_p)
4597 struct mmap_region *r;
4599 if (restore_p)
4601 mmap_regions = mmap_regions_1;
4602 mmap_fd = mmap_fd_1;
4603 for (r = mmap_regions; r; r = r->next)
4604 *r->var = MMAP_USER_AREA (r);
4606 else
4608 for (r = mmap_regions; r; r = r->next)
4609 *r->var = NULL;
4610 mmap_regions_1 = mmap_regions;
4611 mmap_regions = NULL;
4612 mmap_fd_1 = mmap_fd;
4613 mmap_fd = -1;
4618 /* Allocate a block of storage large enough to hold NBYTES bytes of
4619 data. A pointer to the data is returned in *VAR. VAR is thus the
4620 address of some variable which will use the data area.
4622 The allocation of 0 bytes is valid.
4624 If we can't allocate the necessary memory, set *VAR to null, and
4625 return null. */
4627 static POINTER_TYPE *
4628 mmap_alloc (POINTER_TYPE **var, size_t nbytes)
4630 void *p;
4631 size_t map;
4633 mmap_init ();
4635 map = ROUND (nbytes + MMAP_REGION_STRUCT_SIZE, mmap_page_size);
4636 p = mmap (NULL, map, PROT_READ | PROT_WRITE, MAP_ANON | MAP_PRIVATE,
4637 mmap_fd, 0);
4639 if (p == MAP_FAILED)
4641 if (errno != ENOMEM)
4642 fprintf (stderr, "mmap: %s\n", emacs_strerror (errno));
4643 p = NULL;
4645 else
4647 struct mmap_region *r = (struct mmap_region *) p;
4649 r->nbytes_specified = nbytes;
4650 r->nbytes_mapped = map;
4651 r->var = var;
4652 r->prev = NULL;
4653 r->next = mmap_regions;
4654 if (r->next)
4655 r->next->prev = r;
4656 mmap_regions = r;
4658 p = MMAP_USER_AREA (p);
4661 return *var = p;
4665 /* Free a block of relocatable storage whose data is pointed to by
4666 PTR. Store 0 in *PTR to show there's no block allocated. */
4668 static void
4669 mmap_free (POINTER_TYPE **var)
4671 mmap_init ();
4673 if (*var)
4675 mmap_free_1 (MMAP_REGION (*var));
4676 *var = NULL;
4681 /* Given a pointer at address VAR to data allocated with mmap_alloc,
4682 resize it to size NBYTES. Change *VAR to reflect the new block,
4683 and return this value. If more memory cannot be allocated, then
4684 leave *VAR unchanged, and return null. */
4686 static POINTER_TYPE *
4687 mmap_realloc (POINTER_TYPE **var, size_t nbytes)
4689 POINTER_TYPE *result;
4691 mmap_init ();
4693 if (*var == NULL)
4694 result = mmap_alloc (var, nbytes);
4695 else if (nbytes == 0)
4697 mmap_free (var);
4698 result = mmap_alloc (var, nbytes);
4700 else
4702 struct mmap_region *r = MMAP_REGION (*var);
4703 size_t room = r->nbytes_mapped - MMAP_REGION_STRUCT_SIZE;
4705 if (room < nbytes)
4707 /* Must enlarge. */
4708 POINTER_TYPE *old_ptr = *var;
4710 /* Try to map additional pages at the end of the region.
4711 If that fails, allocate a new region, copy data
4712 from the old region, then free it. */
4713 if (mmap_enlarge (r, (ROUND (nbytes - room, mmap_page_size)
4714 / mmap_page_size)))
4716 r->nbytes_specified = nbytes;
4717 *var = result = old_ptr;
4719 else if (mmap_alloc (var, nbytes))
4721 memcpy (*var, old_ptr, r->nbytes_specified);
4722 mmap_free_1 (MMAP_REGION (old_ptr));
4723 result = *var;
4724 r = MMAP_REGION (result);
4725 r->nbytes_specified = nbytes;
4727 else
4729 *var = old_ptr;
4730 result = NULL;
4733 else if (room - nbytes >= mmap_page_size)
4735 /* Shrinking by at least a page. Let's give some
4736 memory back to the system.
4738 The extra parens are to make the division happens first,
4739 on positive values, so we know it will round towards
4740 zero. */
4741 mmap_enlarge (r, - ((room - nbytes) / mmap_page_size));
4742 result = *var;
4743 r->nbytes_specified = nbytes;
4745 else
4747 /* Leave it alone. */
4748 result = *var;
4749 r->nbytes_specified = nbytes;
4753 return result;
4757 #endif /* USE_MMAP_FOR_BUFFERS */
4761 /***********************************************************************
4762 Buffer-text Allocation
4763 ***********************************************************************/
4765 #ifdef REL_ALLOC
4766 extern POINTER_TYPE *r_alloc (POINTER_TYPE **, size_t);
4767 extern POINTER_TYPE *r_re_alloc (POINTER_TYPE **, size_t);
4768 extern void r_alloc_free (POINTER_TYPE **ptr);
4769 #endif /* REL_ALLOC */
4772 /* Allocate NBYTES bytes for buffer B's text buffer. */
4774 static void
4775 alloc_buffer_text (struct buffer *b, ptrdiff_t nbytes)
4777 POINTER_TYPE *p;
4779 BLOCK_INPUT;
4780 #if defined USE_MMAP_FOR_BUFFERS
4781 p = mmap_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4782 #elif defined REL_ALLOC
4783 p = r_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4784 #else
4785 p = xmalloc (nbytes);
4786 #endif
4788 if (p == NULL)
4790 UNBLOCK_INPUT;
4791 memory_full (nbytes);
4794 b->text->beg = (unsigned char *) p;
4795 UNBLOCK_INPUT;
4798 /* Enlarge buffer B's text buffer by DELTA bytes. DELTA < 0 means
4799 shrink it. */
4801 void
4802 enlarge_buffer_text (struct buffer *b, ptrdiff_t delta)
4804 POINTER_TYPE *p;
4805 ptrdiff_t nbytes = (BUF_Z_BYTE (b) - BUF_BEG_BYTE (b) + BUF_GAP_SIZE (b) + 1
4806 + delta);
4807 BLOCK_INPUT;
4808 #if defined USE_MMAP_FOR_BUFFERS
4809 p = mmap_realloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4810 #elif defined REL_ALLOC
4811 p = r_re_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4812 #else
4813 p = xrealloc (b->text->beg, nbytes);
4814 #endif
4816 if (p == NULL)
4818 UNBLOCK_INPUT;
4819 memory_full (nbytes);
4822 BUF_BEG_ADDR (b) = (unsigned char *) p;
4823 UNBLOCK_INPUT;
4827 /* Free buffer B's text buffer. */
4829 static void
4830 free_buffer_text (struct buffer *b)
4832 BLOCK_INPUT;
4834 #if defined USE_MMAP_FOR_BUFFERS
4835 mmap_free ((POINTER_TYPE **) &b->text->beg);
4836 #elif defined REL_ALLOC
4837 r_alloc_free ((POINTER_TYPE **) &b->text->beg);
4838 #else
4839 xfree (b->text->beg);
4840 #endif
4842 BUF_BEG_ADDR (b) = NULL;
4843 UNBLOCK_INPUT;
4848 /***********************************************************************
4849 Initialization
4850 ***********************************************************************/
4852 void
4853 init_buffer_once (void)
4855 int idx;
4857 memset (buffer_permanent_local_flags, 0, sizeof buffer_permanent_local_flags);
4859 /* Make sure all markable slots in buffer_defaults
4860 are initialized reasonably, so mark_buffer won't choke. */
4861 reset_buffer (&buffer_defaults);
4862 eassert (EQ (BVAR (&buffer_defaults, name), make_number (0)));
4863 reset_buffer_local_variables (&buffer_defaults, 1);
4864 eassert (EQ (BVAR (&buffer_local_symbols, name), make_number (0)));
4865 reset_buffer (&buffer_local_symbols);
4866 reset_buffer_local_variables (&buffer_local_symbols, 1);
4867 /* Prevent GC from getting confused. */
4868 buffer_defaults.text = &buffer_defaults.own_text;
4869 buffer_local_symbols.text = &buffer_local_symbols.own_text;
4870 BUF_INTERVALS (&buffer_defaults) = 0;
4871 BUF_INTERVALS (&buffer_local_symbols) = 0;
4872 XSETPVECTYPESIZE (&buffer_defaults, PVEC_BUFFER, 0);
4873 XSETBUFFER (Vbuffer_defaults, &buffer_defaults);
4874 XSETPVECTYPESIZE (&buffer_local_symbols, PVEC_BUFFER, 0);
4875 XSETBUFFER (Vbuffer_local_symbols, &buffer_local_symbols);
4877 /* Set up the default values of various buffer slots. */
4878 /* Must do these before making the first buffer! */
4880 /* real setup is done in bindings.el */
4881 BVAR (&buffer_defaults, mode_line_format) = make_pure_c_string ("%-");
4882 BVAR (&buffer_defaults, header_line_format) = Qnil;
4883 BVAR (&buffer_defaults, abbrev_mode) = Qnil;
4884 BVAR (&buffer_defaults, overwrite_mode) = Qnil;
4885 BVAR (&buffer_defaults, case_fold_search) = Qt;
4886 BVAR (&buffer_defaults, auto_fill_function) = Qnil;
4887 BVAR (&buffer_defaults, selective_display) = Qnil;
4888 #ifndef old
4889 BVAR (&buffer_defaults, selective_display_ellipses) = Qt;
4890 #endif
4891 BVAR (&buffer_defaults, abbrev_table) = Qnil;
4892 BVAR (&buffer_defaults, display_table) = Qnil;
4893 BVAR (&buffer_defaults, undo_list) = Qnil;
4894 BVAR (&buffer_defaults, mark_active) = Qnil;
4895 BVAR (&buffer_defaults, file_format) = Qnil;
4896 BVAR (&buffer_defaults, auto_save_file_format) = Qt;
4897 buffer_defaults.overlays_before = NULL;
4898 buffer_defaults.overlays_after = NULL;
4899 buffer_defaults.overlay_center = BEG;
4901 XSETFASTINT (BVAR (&buffer_defaults, tab_width), 8);
4902 BVAR (&buffer_defaults, truncate_lines) = Qnil;
4903 BVAR (&buffer_defaults, word_wrap) = Qnil;
4904 BVAR (&buffer_defaults, ctl_arrow) = Qt;
4905 BVAR (&buffer_defaults, bidi_display_reordering) = Qt;
4906 BVAR (&buffer_defaults, bidi_paragraph_direction) = Qnil;
4907 BVAR (&buffer_defaults, cursor_type) = Qt;
4908 BVAR (&buffer_defaults, extra_line_spacing) = Qnil;
4909 BVAR (&buffer_defaults, cursor_in_non_selected_windows) = Qt;
4911 BVAR (&buffer_defaults, enable_multibyte_characters) = Qt;
4912 BVAR (&buffer_defaults, buffer_file_coding_system) = Qnil;
4913 XSETFASTINT (BVAR (&buffer_defaults, fill_column), 70);
4914 XSETFASTINT (BVAR (&buffer_defaults, left_margin), 0);
4915 BVAR (&buffer_defaults, cache_long_line_scans) = Qnil;
4916 BVAR (&buffer_defaults, file_truename) = Qnil;
4917 XSETFASTINT (BVAR (&buffer_defaults, display_count), 0);
4918 XSETFASTINT (BVAR (&buffer_defaults, left_margin_cols), 0);
4919 XSETFASTINT (BVAR (&buffer_defaults, right_margin_cols), 0);
4920 BVAR (&buffer_defaults, left_fringe_width) = Qnil;
4921 BVAR (&buffer_defaults, right_fringe_width) = Qnil;
4922 BVAR (&buffer_defaults, fringes_outside_margins) = Qnil;
4923 BVAR (&buffer_defaults, scroll_bar_width) = Qnil;
4924 BVAR (&buffer_defaults, vertical_scroll_bar_type) = Qt;
4925 BVAR (&buffer_defaults, indicate_empty_lines) = Qnil;
4926 BVAR (&buffer_defaults, indicate_buffer_boundaries) = Qnil;
4927 BVAR (&buffer_defaults, fringe_indicator_alist) = Qnil;
4928 BVAR (&buffer_defaults, fringe_cursor_alist) = Qnil;
4929 BVAR (&buffer_defaults, scroll_up_aggressively) = Qnil;
4930 BVAR (&buffer_defaults, scroll_down_aggressively) = Qnil;
4931 BVAR (&buffer_defaults, display_time) = Qnil;
4933 /* Assign the local-flags to the slots that have default values.
4934 The local flag is a bit that is used in the buffer
4935 to say that it has its own local value for the slot.
4936 The local flag bits are in the local_var_flags slot of the buffer. */
4938 /* Nothing can work if this isn't true */
4939 { verify (sizeof (EMACS_INT) == sizeof (Lisp_Object)); }
4941 /* 0 means not a lisp var, -1 means always local, else mask */
4942 memset (&buffer_local_flags, 0, sizeof buffer_local_flags);
4943 XSETINT (BVAR (&buffer_local_flags, filename), -1);
4944 XSETINT (BVAR (&buffer_local_flags, directory), -1);
4945 XSETINT (BVAR (&buffer_local_flags, backed_up), -1);
4946 XSETINT (BVAR (&buffer_local_flags, save_length), -1);
4947 XSETINT (BVAR (&buffer_local_flags, auto_save_file_name), -1);
4948 XSETINT (BVAR (&buffer_local_flags, read_only), -1);
4949 XSETINT (BVAR (&buffer_local_flags, major_mode), -1);
4950 XSETINT (BVAR (&buffer_local_flags, mode_name), -1);
4951 XSETINT (BVAR (&buffer_local_flags, undo_list), -1);
4952 XSETINT (BVAR (&buffer_local_flags, mark_active), -1);
4953 XSETINT (BVAR (&buffer_local_flags, point_before_scroll), -1);
4954 XSETINT (BVAR (&buffer_local_flags, file_truename), -1);
4955 XSETINT (BVAR (&buffer_local_flags, invisibility_spec), -1);
4956 XSETINT (BVAR (&buffer_local_flags, file_format), -1);
4957 XSETINT (BVAR (&buffer_local_flags, auto_save_file_format), -1);
4958 XSETINT (BVAR (&buffer_local_flags, display_count), -1);
4959 XSETINT (BVAR (&buffer_local_flags, display_time), -1);
4960 XSETINT (BVAR (&buffer_local_flags, enable_multibyte_characters), -1);
4962 idx = 1;
4963 XSETFASTINT (BVAR (&buffer_local_flags, mode_line_format), idx); ++idx;
4964 XSETFASTINT (BVAR (&buffer_local_flags, abbrev_mode), idx); ++idx;
4965 XSETFASTINT (BVAR (&buffer_local_flags, overwrite_mode), idx); ++idx;
4966 XSETFASTINT (BVAR (&buffer_local_flags, case_fold_search), idx); ++idx;
4967 XSETFASTINT (BVAR (&buffer_local_flags, auto_fill_function), idx); ++idx;
4968 XSETFASTINT (BVAR (&buffer_local_flags, selective_display), idx); ++idx;
4969 #ifndef old
4970 XSETFASTINT (BVAR (&buffer_local_flags, selective_display_ellipses), idx); ++idx;
4971 #endif
4972 XSETFASTINT (BVAR (&buffer_local_flags, tab_width), idx); ++idx;
4973 XSETFASTINT (BVAR (&buffer_local_flags, truncate_lines), idx); ++idx;
4974 XSETFASTINT (BVAR (&buffer_local_flags, word_wrap), idx); ++idx;
4975 XSETFASTINT (BVAR (&buffer_local_flags, ctl_arrow), idx); ++idx;
4976 XSETFASTINT (BVAR (&buffer_local_flags, fill_column), idx); ++idx;
4977 XSETFASTINT (BVAR (&buffer_local_flags, left_margin), idx); ++idx;
4978 XSETFASTINT (BVAR (&buffer_local_flags, abbrev_table), idx); ++idx;
4979 XSETFASTINT (BVAR (&buffer_local_flags, display_table), idx); ++idx;
4980 XSETFASTINT (BVAR (&buffer_local_flags, syntax_table), idx); ++idx;
4981 XSETFASTINT (BVAR (&buffer_local_flags, cache_long_line_scans), idx); ++idx;
4982 XSETFASTINT (BVAR (&buffer_local_flags, category_table), idx); ++idx;
4983 XSETFASTINT (BVAR (&buffer_local_flags, bidi_display_reordering), idx); ++idx;
4984 XSETFASTINT (BVAR (&buffer_local_flags, bidi_paragraph_direction), idx); ++idx;
4985 XSETFASTINT (BVAR (&buffer_local_flags, buffer_file_coding_system), idx);
4986 /* Make this one a permanent local. */
4987 buffer_permanent_local_flags[idx++] = 1;
4988 XSETFASTINT (BVAR (&buffer_local_flags, left_margin_cols), idx); ++idx;
4989 XSETFASTINT (BVAR (&buffer_local_flags, right_margin_cols), idx); ++idx;
4990 XSETFASTINT (BVAR (&buffer_local_flags, left_fringe_width), idx); ++idx;
4991 XSETFASTINT (BVAR (&buffer_local_flags, right_fringe_width), idx); ++idx;
4992 XSETFASTINT (BVAR (&buffer_local_flags, fringes_outside_margins), idx); ++idx;
4993 XSETFASTINT (BVAR (&buffer_local_flags, scroll_bar_width), idx); ++idx;
4994 XSETFASTINT (BVAR (&buffer_local_flags, vertical_scroll_bar_type), idx); ++idx;
4995 XSETFASTINT (BVAR (&buffer_local_flags, indicate_empty_lines), idx); ++idx;
4996 XSETFASTINT (BVAR (&buffer_local_flags, indicate_buffer_boundaries), idx); ++idx;
4997 XSETFASTINT (BVAR (&buffer_local_flags, fringe_indicator_alist), idx); ++idx;
4998 XSETFASTINT (BVAR (&buffer_local_flags, fringe_cursor_alist), idx); ++idx;
4999 XSETFASTINT (BVAR (&buffer_local_flags, scroll_up_aggressively), idx); ++idx;
5000 XSETFASTINT (BVAR (&buffer_local_flags, scroll_down_aggressively), idx); ++idx;
5001 XSETFASTINT (BVAR (&buffer_local_flags, header_line_format), idx); ++idx;
5002 XSETFASTINT (BVAR (&buffer_local_flags, cursor_type), idx); ++idx;
5003 XSETFASTINT (BVAR (&buffer_local_flags, extra_line_spacing), idx); ++idx;
5004 XSETFASTINT (BVAR (&buffer_local_flags, cursor_in_non_selected_windows), idx); ++idx;
5006 /* Need more room? */
5007 if (idx >= MAX_PER_BUFFER_VARS)
5008 abort ();
5009 last_per_buffer_idx = idx;
5011 Vbuffer_alist = Qnil;
5012 current_buffer = 0;
5013 all_buffers = 0;
5015 QSFundamental = make_pure_c_string ("Fundamental");
5017 Qfundamental_mode = intern_c_string ("fundamental-mode");
5018 BVAR (&buffer_defaults, major_mode) = Qfundamental_mode;
5020 Qmode_class = intern_c_string ("mode-class");
5022 Qprotected_field = intern_c_string ("protected-field");
5024 Qpermanent_local = intern_c_string ("permanent-local");
5026 Qkill_buffer_hook = intern_c_string ("kill-buffer-hook");
5027 Fput (Qkill_buffer_hook, Qpermanent_local, Qt);
5029 Qucs_set_table_for_input = intern_c_string ("ucs-set-table-for-input");
5031 /* super-magic invisible buffer */
5032 Vprin1_to_string_buffer = Fget_buffer_create (make_pure_c_string (" prin1"));
5033 Vbuffer_alist = Qnil;
5035 Fset_buffer (Fget_buffer_create (make_pure_c_string ("*scratch*")));
5037 inhibit_modification_hooks = 0;
5040 void
5041 init_buffer (void)
5043 char *pwd;
5044 Lisp_Object temp;
5045 ptrdiff_t len;
5047 #ifdef USE_MMAP_FOR_BUFFERS
5049 /* When using the ralloc implementation based on mmap(2), buffer
5050 text pointers will have been set to null in the dumped Emacs.
5051 Map new memory. */
5052 struct buffer *b;
5054 for (b = all_buffers; b; b = b->header.next.buffer)
5055 if (b->text->beg == NULL)
5056 enlarge_buffer_text (b, 0);
5058 #endif /* USE_MMAP_FOR_BUFFERS */
5060 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5061 if (NILP (BVAR (&buffer_defaults, enable_multibyte_characters)))
5062 Fset_buffer_multibyte (Qnil);
5064 pwd = get_current_dir_name ();
5066 if (!pwd)
5067 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno));
5069 /* Maybe this should really use some standard subroutine
5070 whose definition is filename syntax dependent. */
5071 len = strlen (pwd);
5072 if (!(IS_DIRECTORY_SEP (pwd[len - 1])))
5074 /* Grow buffer to add directory separator and '\0'. */
5075 pwd = (char *) realloc (pwd, len + 2);
5076 if (!pwd)
5077 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno));
5078 pwd[len] = DIRECTORY_SEP;
5079 pwd[len + 1] = '\0';
5082 BVAR (current_buffer, directory) = make_unibyte_string (pwd, strlen (pwd));
5083 if (! NILP (BVAR (&buffer_defaults, enable_multibyte_characters)))
5084 /* At this moment, we still don't know how to decode the
5085 directory name. So, we keep the bytes in multibyte form so
5086 that ENCODE_FILE correctly gets the original bytes. */
5087 BVAR (current_buffer, directory)
5088 = string_to_multibyte (BVAR (current_buffer, directory));
5090 /* Add /: to the front of the name
5091 if it would otherwise be treated as magic. */
5092 temp = Ffind_file_name_handler (BVAR (current_buffer, directory), Qt);
5093 if (! NILP (temp)
5094 /* If the default dir is just /, TEMP is non-nil
5095 because of the ange-ftp completion handler.
5096 However, it is not necessary to turn / into /:/.
5097 So avoid doing that. */
5098 && strcmp ("/", SSDATA (BVAR (current_buffer, directory))))
5099 BVAR (current_buffer, directory)
5100 = concat2 (build_string ("/:"), BVAR (current_buffer, directory));
5102 temp = get_minibuffer (0);
5103 BVAR (XBUFFER (temp), directory) = BVAR (current_buffer, directory);
5105 free (pwd);
5108 /* Similar to defvar_lisp but define a variable whose value is the Lisp
5109 Object stored in the current buffer. address is the address of the slot
5110 in the buffer that is current now. */
5112 /* TYPE is nil for a general Lisp variable.
5113 An integer specifies a type; then only Lisp values
5114 with that type code are allowed (except that nil is allowed too).
5115 LNAME is the Lisp-level variable name.
5116 VNAME is the name of the buffer slot.
5117 DOC is a dummy where you write the doc string as a comment. */
5118 #define DEFVAR_PER_BUFFER(lname, vname, type, doc) \
5119 do { \
5120 static struct Lisp_Buffer_Objfwd bo_fwd; \
5121 defvar_per_buffer (&bo_fwd, lname, vname, type); \
5122 } while (0)
5124 static void
5125 defvar_per_buffer (struct Lisp_Buffer_Objfwd *bo_fwd, const char *namestring,
5126 Lisp_Object *address, Lisp_Object type)
5128 struct Lisp_Symbol *sym;
5129 int offset;
5131 sym = XSYMBOL (intern (namestring));
5132 offset = (char *)address - (char *)current_buffer;
5134 bo_fwd->type = Lisp_Fwd_Buffer_Obj;
5135 bo_fwd->offset = offset;
5136 bo_fwd->slottype = type;
5137 sym->declared_special = 1;
5138 sym->redirect = SYMBOL_FORWARDED;
5140 /* I tried to do the job without a cast, but it seems impossible.
5141 union Lisp_Fwd *fwd; &(fwd->u_buffer_objfwd) = bo_fwd; */
5142 SET_SYMBOL_FWD (sym, (union Lisp_Fwd *)bo_fwd);
5144 XSETSYMBOL (PER_BUFFER_SYMBOL (offset), sym);
5146 if (PER_BUFFER_IDX (offset) == 0)
5147 /* Did a DEFVAR_PER_BUFFER without initializing the corresponding
5148 slot of buffer_local_flags */
5149 abort ();
5153 /* initialize the buffer routines */
5154 void
5155 syms_of_buffer (void)
5157 staticpro (&last_overlay_modification_hooks);
5158 last_overlay_modification_hooks
5159 = Fmake_vector (make_number (10), Qnil);
5161 staticpro (&Vbuffer_defaults);
5162 staticpro (&Vbuffer_local_symbols);
5163 staticpro (&Qfundamental_mode);
5164 staticpro (&Qmode_class);
5165 staticpro (&QSFundamental);
5166 staticpro (&Vbuffer_alist);
5167 staticpro (&Qprotected_field);
5168 staticpro (&Qpermanent_local);
5169 staticpro (&Qkill_buffer_hook);
5171 DEFSYM (Qpermanent_local_hook, "permanent-local-hook");
5172 DEFSYM (Qoverlayp, "overlayp");
5173 DEFSYM (Qevaporate, "evaporate");
5174 DEFSYM (Qmodification_hooks, "modification-hooks");
5175 DEFSYM (Qinsert_in_front_hooks, "insert-in-front-hooks");
5176 DEFSYM (Qinsert_behind_hooks, "insert-behind-hooks");
5177 DEFSYM (Qget_file_buffer, "get-file-buffer");
5178 DEFSYM (Qpriority, "priority");
5179 DEFSYM (Qbefore_string, "before-string");
5180 DEFSYM (Qafter_string, "after-string");
5181 DEFSYM (Qfirst_change_hook, "first-change-hook");
5182 DEFSYM (Qbefore_change_functions, "before-change-functions");
5183 DEFSYM (Qafter_change_functions, "after-change-functions");
5184 DEFSYM (Qkill_buffer_query_functions, "kill-buffer-query-functions");
5186 /* The next one is initialized in init_buffer_once. */
5187 staticpro (&Qucs_set_table_for_input);
5189 Fput (Qprotected_field, Qerror_conditions,
5190 pure_cons (Qprotected_field, pure_cons (Qerror, Qnil)));
5191 Fput (Qprotected_field, Qerror_message,
5192 make_pure_c_string ("Attempt to modify a protected field"));
5194 DEFVAR_BUFFER_DEFAULTS ("default-mode-line-format",
5195 mode_line_format,
5196 doc: /* Default value of `mode-line-format' for buffers that don't override it.
5197 This is the same as (default-value 'mode-line-format). */);
5199 DEFVAR_BUFFER_DEFAULTS ("default-header-line-format",
5200 header_line_format,
5201 doc: /* Default value of `header-line-format' for buffers that don't override it.
5202 This is the same as (default-value 'header-line-format). */);
5204 DEFVAR_BUFFER_DEFAULTS ("default-cursor-type", cursor_type,
5205 doc: /* Default value of `cursor-type' for buffers that don't override it.
5206 This is the same as (default-value 'cursor-type). */);
5208 DEFVAR_BUFFER_DEFAULTS ("default-line-spacing",
5209 extra_line_spacing,
5210 doc: /* Default value of `line-spacing' for buffers that don't override it.
5211 This is the same as (default-value 'line-spacing). */);
5213 DEFVAR_BUFFER_DEFAULTS ("default-cursor-in-non-selected-windows",
5214 cursor_in_non_selected_windows,
5215 doc: /* Default value of `cursor-in-non-selected-windows'.
5216 This is the same as (default-value 'cursor-in-non-selected-windows). */);
5218 DEFVAR_BUFFER_DEFAULTS ("default-abbrev-mode",
5219 abbrev_mode,
5220 doc: /* Default value of `abbrev-mode' for buffers that do not override it.
5221 This is the same as (default-value 'abbrev-mode). */);
5223 DEFVAR_BUFFER_DEFAULTS ("default-ctl-arrow",
5224 ctl_arrow,
5225 doc: /* Default value of `ctl-arrow' for buffers that do not override it.
5226 This is the same as (default-value 'ctl-arrow). */);
5228 DEFVAR_BUFFER_DEFAULTS ("default-enable-multibyte-characters",
5229 enable_multibyte_characters,
5230 doc: /* *Default value of `enable-multibyte-characters' for buffers not overriding it.
5231 This is the same as (default-value 'enable-multibyte-characters). */);
5233 DEFVAR_BUFFER_DEFAULTS ("default-buffer-file-coding-system",
5234 buffer_file_coding_system,
5235 doc: /* Default value of `buffer-file-coding-system' for buffers not overriding it.
5236 This is the same as (default-value 'buffer-file-coding-system). */);
5238 DEFVAR_BUFFER_DEFAULTS ("default-truncate-lines",
5239 truncate_lines,
5240 doc: /* Default value of `truncate-lines' for buffers that do not override it.
5241 This is the same as (default-value 'truncate-lines). */);
5243 DEFVAR_BUFFER_DEFAULTS ("default-fill-column",
5244 fill_column,
5245 doc: /* Default value of `fill-column' for buffers that do not override it.
5246 This is the same as (default-value 'fill-column). */);
5248 DEFVAR_BUFFER_DEFAULTS ("default-left-margin",
5249 left_margin,
5250 doc: /* Default value of `left-margin' for buffers that do not override it.
5251 This is the same as (default-value 'left-margin). */);
5253 DEFVAR_BUFFER_DEFAULTS ("default-tab-width",
5254 tab_width,
5255 doc: /* Default value of `tab-width' for buffers that do not override it.
5256 This is the same as (default-value 'tab-width). */);
5258 DEFVAR_BUFFER_DEFAULTS ("default-case-fold-search",
5259 case_fold_search,
5260 doc: /* Default value of `case-fold-search' for buffers that don't override it.
5261 This is the same as (default-value 'case-fold-search). */);
5263 DEFVAR_BUFFER_DEFAULTS ("default-left-margin-width",
5264 left_margin_cols,
5265 doc: /* Default value of `left-margin-width' for buffers that don't override it.
5266 This is the same as (default-value 'left-margin-width). */);
5268 DEFVAR_BUFFER_DEFAULTS ("default-right-margin-width",
5269 right_margin_cols,
5270 doc: /* Default value of `right-margin-width' for buffers that don't override it.
5271 This is the same as (default-value 'right-margin-width). */);
5273 DEFVAR_BUFFER_DEFAULTS ("default-left-fringe-width",
5274 left_fringe_width,
5275 doc: /* Default value of `left-fringe-width' for buffers that don't override it.
5276 This is the same as (default-value 'left-fringe-width). */);
5278 DEFVAR_BUFFER_DEFAULTS ("default-right-fringe-width",
5279 right_fringe_width,
5280 doc: /* Default value of `right-fringe-width' for buffers that don't override it.
5281 This is the same as (default-value 'right-fringe-width). */);
5283 DEFVAR_BUFFER_DEFAULTS ("default-fringes-outside-margins",
5284 fringes_outside_margins,
5285 doc: /* Default value of `fringes-outside-margins' for buffers that don't override it.
5286 This is the same as (default-value 'fringes-outside-margins). */);
5288 DEFVAR_BUFFER_DEFAULTS ("default-scroll-bar-width",
5289 scroll_bar_width,
5290 doc: /* Default value of `scroll-bar-width' for buffers that don't override it.
5291 This is the same as (default-value 'scroll-bar-width). */);
5293 DEFVAR_BUFFER_DEFAULTS ("default-vertical-scroll-bar",
5294 vertical_scroll_bar_type,
5295 doc: /* Default value of `vertical-scroll-bar' for buffers that don't override it.
5296 This is the same as (default-value 'vertical-scroll-bar). */);
5298 DEFVAR_BUFFER_DEFAULTS ("default-indicate-empty-lines",
5299 indicate_empty_lines,
5300 doc: /* Default value of `indicate-empty-lines' for buffers that don't override it.
5301 This is the same as (default-value 'indicate-empty-lines). */);
5303 DEFVAR_BUFFER_DEFAULTS ("default-indicate-buffer-boundaries",
5304 indicate_buffer_boundaries,
5305 doc: /* Default value of `indicate-buffer-boundaries' for buffers that don't override it.
5306 This is the same as (default-value 'indicate-buffer-boundaries). */);
5308 DEFVAR_BUFFER_DEFAULTS ("default-fringe-indicator-alist",
5309 fringe_indicator_alist,
5310 doc: /* Default value of `fringe-indicator-alist' for buffers that don't override it.
5311 This is the same as (default-value 'fringe-indicator-alist'). */);
5313 DEFVAR_BUFFER_DEFAULTS ("default-fringe-cursor-alist",
5314 fringe_cursor_alist,
5315 doc: /* Default value of `fringe-cursor-alist' for buffers that don't override it.
5316 This is the same as (default-value 'fringe-cursor-alist'). */);
5318 DEFVAR_BUFFER_DEFAULTS ("default-scroll-up-aggressively",
5319 scroll_up_aggressively,
5320 doc: /* Default value of `scroll-up-aggressively'.
5321 This value applies in buffers that don't have their own local values.
5322 This is the same as (default-value 'scroll-up-aggressively). */);
5324 DEFVAR_BUFFER_DEFAULTS ("default-scroll-down-aggressively",
5325 scroll_down_aggressively,
5326 doc: /* Default value of `scroll-down-aggressively'.
5327 This value applies in buffers that don't have their own local values.
5328 This is the same as (default-value 'scroll-down-aggressively). */);
5330 DEFVAR_PER_BUFFER ("header-line-format",
5331 &BVAR (current_buffer, header_line_format),
5332 Qnil,
5333 doc: /* Analogous to `mode-line-format', but controls the header line.
5334 The header line appears, optionally, at the top of a window;
5335 the mode line appears at the bottom. */);
5337 DEFVAR_PER_BUFFER ("mode-line-format", &BVAR (current_buffer, mode_line_format),
5338 Qnil,
5339 doc: /* Template for displaying mode line for current buffer.
5340 Each buffer has its own value of this variable.
5341 Value may be nil, a string, a symbol or a list or cons cell.
5342 A value of nil means don't display a mode line.
5343 For a symbol, its value is used (but it is ignored if t or nil).
5344 A string appearing directly as the value of a symbol is processed verbatim
5345 in that the %-constructs below are not recognized.
5346 Note that unless the symbol is marked as a `risky-local-variable', all
5347 properties in any strings, as well as all :eval and :propertize forms
5348 in the value of that symbol will be ignored.
5349 For a list of the form `(:eval FORM)', FORM is evaluated and the result
5350 is used as a mode line element. Be careful--FORM should not load any files,
5351 because that can cause an infinite recursion.
5352 For a list of the form `(:propertize ELT PROPS...)', ELT is displayed
5353 with the specified properties PROPS applied.
5354 For a list whose car is a symbol, the symbol's value is taken,
5355 and if that is non-nil, the cadr of the list is processed recursively.
5356 Otherwise, the caddr of the list (if there is one) is processed.
5357 For a list whose car is a string or list, each element is processed
5358 recursively and the results are effectively concatenated.
5359 For a list whose car is an integer, the cdr of the list is processed
5360 and padded (if the number is positive) or truncated (if negative)
5361 to the width specified by that number.
5362 A string is printed verbatim in the mode line except for %-constructs:
5363 (%-constructs are allowed when the string is the entire mode-line-format
5364 or when it is found in a cons-cell or a list)
5365 %b -- print buffer name. %f -- print visited file name.
5366 %F -- print frame name.
5367 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.
5368 %& is like %*, but ignore read-only-ness.
5369 % means buffer is read-only and * means it is modified.
5370 For a modified read-only buffer, %* gives % and %+ gives *.
5371 %s -- print process status. %l -- print the current line number.
5372 %c -- print the current column number (this makes editing slower).
5373 To make the column number update correctly in all cases,
5374 `column-number-mode' must be non-nil.
5375 %i -- print the size of the buffer.
5376 %I -- like %i, but use k, M, G, etc., to abbreviate.
5377 %p -- print percent of buffer above top of window, or Top, Bot or All.
5378 %P -- print percent of buffer above bottom of window, perhaps plus Top,
5379 or print Bottom or All.
5380 %n -- print Narrow if appropriate.
5381 %t -- visited file is text or binary (if OS supports this distinction).
5382 %z -- print mnemonics of keyboard, terminal, and buffer coding systems.
5383 %Z -- like %z, but including the end-of-line format.
5384 %e -- print error message about full memory.
5385 %@ -- print @ or hyphen. @ means that default-directory is on a
5386 remote machine.
5387 %[ -- print one [ for each recursive editing level. %] similar.
5388 %% -- print %. %- -- print infinitely many dashes.
5389 Decimal digits after the % specify field width to which to pad. */);
5391 DEFVAR_BUFFER_DEFAULTS ("default-major-mode", major_mode,
5392 doc: /* *Value of `major-mode' for new buffers. */);
5394 DEFVAR_PER_BUFFER ("major-mode", &BVAR (current_buffer, major_mode),
5395 make_number (Lisp_Symbol),
5396 doc: /* Symbol for current buffer's major mode.
5397 The default value (normally `fundamental-mode') affects new buffers.
5398 A value of nil means to use the current buffer's major mode, provided
5399 it is not marked as "special".
5401 When a mode is used by default, `find-file' switches to it before it
5402 reads the contents into the buffer and before it finishes setting up
5403 the buffer. Thus, the mode and its hooks should not expect certain
5404 variables such as `buffer-read-only' and `buffer-file-coding-system'
5405 to be set up. */);
5407 DEFVAR_PER_BUFFER ("mode-name", &BVAR (current_buffer, mode_name),
5408 Qnil,
5409 doc: /* Pretty name of current buffer's major mode.
5410 Usually a string, but can use any of the constructs for `mode-line-format',
5411 which see.
5412 Format with `format-mode-line' to produce a string value. */);
5414 DEFVAR_PER_BUFFER ("local-abbrev-table", &BVAR (current_buffer, abbrev_table), Qnil,
5415 doc: /* Local (mode-specific) abbrev table of current buffer. */);
5417 DEFVAR_PER_BUFFER ("abbrev-mode", &BVAR (current_buffer, abbrev_mode), Qnil,
5418 doc: /* Non-nil if Abbrev mode is enabled.
5419 Use the command `abbrev-mode' to change this variable. */);
5421 DEFVAR_PER_BUFFER ("case-fold-search", &BVAR (current_buffer, case_fold_search),
5422 Qnil,
5423 doc: /* *Non-nil if searches and matches should ignore case. */);
5425 DEFVAR_PER_BUFFER ("fill-column", &BVAR (current_buffer, fill_column),
5426 make_number (LISP_INT_TAG),
5427 doc: /* *Column beyond which automatic line-wrapping should happen.
5428 Interactively, you can set the buffer local value using \\[set-fill-column]. */);
5430 DEFVAR_PER_BUFFER ("left-margin", &BVAR (current_buffer, left_margin),
5431 make_number (LISP_INT_TAG),
5432 doc: /* *Column for the default `indent-line-function' to indent to.
5433 Linefeed indents to this column in Fundamental mode. */);
5435 DEFVAR_PER_BUFFER ("tab-width", &BVAR (current_buffer, tab_width),
5436 make_number (LISP_INT_TAG),
5437 doc: /* *Distance between tab stops (for display of tab characters), in columns.
5438 This should be an integer greater than zero. */);
5440 DEFVAR_PER_BUFFER ("ctl-arrow", &BVAR (current_buffer, ctl_arrow), Qnil,
5441 doc: /* *Non-nil means display control chars with uparrow.
5442 A value of nil means use backslash and octal digits.
5443 This variable does not apply to characters whose display is specified
5444 in the current display table (if there is one). */);
5446 DEFVAR_PER_BUFFER ("enable-multibyte-characters",
5447 &BVAR (current_buffer, enable_multibyte_characters),
5448 Qnil,
5449 doc: /* Non-nil means the buffer contents are regarded as multi-byte characters.
5450 Otherwise they are regarded as unibyte. This affects the display,
5451 file I/O and the behavior of various editing commands.
5453 This variable is buffer-local but you cannot set it directly;
5454 use the function `set-buffer-multibyte' to change a buffer's representation.
5455 See also Info node `(elisp)Text Representations'. */);
5456 XSYMBOL (intern_c_string ("enable-multibyte-characters"))->constant = 1;
5458 DEFVAR_PER_BUFFER ("buffer-file-coding-system",
5459 &BVAR (current_buffer, buffer_file_coding_system), Qnil,
5460 doc: /* Coding system to be used for encoding the buffer contents on saving.
5461 This variable applies to saving the buffer, and also to `write-region'
5462 and other functions that use `write-region'.
5463 It does not apply to sending output to subprocesses, however.
5465 If this is nil, the buffer is saved without any code conversion
5466 unless some coding system is specified in `file-coding-system-alist'
5467 for the buffer file.
5469 If the text to be saved cannot be encoded as specified by this variable,
5470 an alternative encoding is selected by `select-safe-coding-system', which see.
5472 The variable `coding-system-for-write', if non-nil, overrides this variable.
5474 This variable is never applied to a way of decoding a file while reading it. */);
5476 DEFVAR_PER_BUFFER ("bidi-display-reordering",
5477 &BVAR (current_buffer, bidi_display_reordering), Qnil,
5478 doc: /* Non-nil means reorder bidirectional text for display in the visual order. */);
5480 DEFVAR_PER_BUFFER ("bidi-paragraph-direction",
5481 &BVAR (current_buffer, bidi_paragraph_direction), Qnil,
5482 doc: /* *If non-nil, forces directionality of text paragraphs in the buffer.
5484 If this is nil (the default), the direction of each paragraph is
5485 determined by the first strong directional character of its text.
5486 The values of `right-to-left' and `left-to-right' override that.
5487 Any other value is treated as nil.
5489 This variable has no effect unless the buffer's value of
5490 \`bidi-display-reordering' is non-nil. */);
5492 DEFVAR_PER_BUFFER ("truncate-lines", &BVAR (current_buffer, truncate_lines), Qnil,
5493 doc: /* *Non-nil means do not display continuation lines.
5494 Instead, give each line of text just one screen line.
5496 Note that this is overridden by the variable
5497 `truncate-partial-width-windows' if that variable is non-nil
5498 and this buffer is not full-frame width.
5500 Minibuffers set this variable to nil. */);
5502 DEFVAR_PER_BUFFER ("word-wrap", &BVAR (current_buffer, word_wrap), Qnil,
5503 doc: /* *Non-nil means to use word-wrapping for continuation lines.
5504 When word-wrapping is on, continuation lines are wrapped at the space
5505 or tab character nearest to the right window edge.
5506 If nil, continuation lines are wrapped at the right screen edge.
5508 This variable has no effect if long lines are truncated (see
5509 `truncate-lines' and `truncate-partial-width-windows'). If you use
5510 word-wrapping, you might want to reduce the value of
5511 `truncate-partial-width-windows', since wrapping can make text readable
5512 in narrower windows. */);
5514 DEFVAR_PER_BUFFER ("default-directory", &BVAR (current_buffer, directory),
5515 make_number (Lisp_String),
5516 doc: /* Name of default directory of current buffer. Should end with slash.
5517 To interactively change the default directory, use command `cd'. */);
5519 DEFVAR_PER_BUFFER ("auto-fill-function", &BVAR (current_buffer, auto_fill_function),
5520 Qnil,
5521 doc: /* Function called (if non-nil) to perform auto-fill.
5522 It is called after self-inserting any character specified in
5523 the `auto-fill-chars' table.
5524 NOTE: This variable is not a hook;
5525 its value may not be a list of functions. */);
5527 DEFVAR_PER_BUFFER ("buffer-file-name", &BVAR (current_buffer, filename),
5528 make_number (Lisp_String),
5529 doc: /* Name of file visited in current buffer, or nil if not visiting a file. */);
5531 DEFVAR_PER_BUFFER ("buffer-file-truename", &BVAR (current_buffer, file_truename),
5532 make_number (Lisp_String),
5533 doc: /* Abbreviated truename of file visited in current buffer, or nil if none.
5534 The truename of a file is calculated by `file-truename'
5535 and then abbreviated with `abbreviate-file-name'. */);
5537 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
5538 &BVAR (current_buffer, auto_save_file_name),
5539 make_number (Lisp_String),
5540 doc: /* Name of file for auto-saving current buffer.
5541 If it is nil, that means don't auto-save this buffer. */);
5543 DEFVAR_PER_BUFFER ("buffer-read-only", &BVAR (current_buffer, read_only), Qnil,
5544 doc: /* Non-nil if this buffer is read-only. */);
5546 DEFVAR_PER_BUFFER ("buffer-backed-up", &BVAR (current_buffer, backed_up), Qnil,
5547 doc: /* Non-nil if this buffer's file has been backed up.
5548 Backing up is done before the first time the file is saved. */);
5550 DEFVAR_PER_BUFFER ("buffer-saved-size", &BVAR (current_buffer, save_length),
5551 make_number (LISP_INT_TAG),
5552 doc: /* Length of current buffer when last read in, saved or auto-saved.
5553 0 initially.
5554 -1 means auto-saving turned off until next real save.
5556 If you set this to -2, that means don't turn off auto-saving in this buffer
5557 if its text size shrinks. If you use `buffer-swap-text' on a buffer,
5558 you probably should set this to -2 in that buffer. */);
5560 DEFVAR_PER_BUFFER ("selective-display", &BVAR (current_buffer, selective_display),
5561 Qnil,
5562 doc: /* Non-nil enables selective display.
5563 An integer N as value means display only lines
5564 that start with less than N columns of space.
5565 A value of t means that the character ^M makes itself and
5566 all the rest of the line invisible; also, when saving the buffer
5567 in a file, save the ^M as a newline. */);
5569 #ifndef old
5570 DEFVAR_PER_BUFFER ("selective-display-ellipses",
5571 &BVAR (current_buffer, selective_display_ellipses),
5572 Qnil,
5573 doc: /* Non-nil means display ... on previous line when a line is invisible. */);
5574 #endif
5576 DEFVAR_PER_BUFFER ("overwrite-mode", &BVAR (current_buffer, overwrite_mode), Qnil,
5577 doc: /* Non-nil if self-insertion should replace existing text.
5578 The value should be one of `overwrite-mode-textual',
5579 `overwrite-mode-binary', or nil.
5580 If it is `overwrite-mode-textual', self-insertion still
5581 inserts at the end of a line, and inserts when point is before a tab,
5582 until the tab is filled in.
5583 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too. */);
5585 DEFVAR_PER_BUFFER ("buffer-display-table", &BVAR (current_buffer, display_table),
5586 Qnil,
5587 doc: /* Display table that controls display of the contents of current buffer.
5589 If this variable is nil, the value of `standard-display-table' is used.
5590 Each window can have its own, overriding display table, see
5591 `set-window-display-table' and `window-display-table'.
5593 The display table is a char-table created with `make-display-table'.
5594 A char-table is an array indexed by character codes. Normal array
5595 primitives `aref' and `aset' can be used to access elements of a char-table.
5597 Each of the char-table elements control how to display the corresponding
5598 text character: the element at index C in the table says how to display
5599 the character whose code is C. Each element should be a vector of
5600 characters or nil. The value nil means display the character in the
5601 default fashion; otherwise, the characters from the vector are delivered
5602 to the screen instead of the original character.
5604 For example, (aset buffer-display-table ?X [?Y]) tells Emacs
5605 to display a capital Y instead of each X character.
5607 In addition, a char-table has six extra slots to control the display of:
5609 the end of a truncated screen line (extra-slot 0, a single character);
5610 the end of a continued line (extra-slot 1, a single character);
5611 the escape character used to display character codes in octal
5612 (extra-slot 2, a single character);
5613 the character used as an arrow for control characters (extra-slot 3,
5614 a single character);
5615 the decoration indicating the presence of invisible lines (extra-slot 4,
5616 a vector of characters);
5617 the character used to draw the border between side-by-side windows
5618 (extra-slot 5, a single character).
5620 See also the functions `display-table-slot' and `set-display-table-slot'. */);
5622 DEFVAR_PER_BUFFER ("left-margin-width", &BVAR (current_buffer, left_margin_cols),
5623 Qnil,
5624 doc: /* *Width of left marginal area for display of a buffer.
5625 A value of nil means no marginal area. */);
5627 DEFVAR_PER_BUFFER ("right-margin-width", &BVAR (current_buffer, right_margin_cols),
5628 Qnil,
5629 doc: /* *Width of right marginal area for display of a buffer.
5630 A value of nil means no marginal area. */);
5632 DEFVAR_PER_BUFFER ("left-fringe-width", &BVAR (current_buffer, left_fringe_width),
5633 Qnil,
5634 doc: /* *Width of this buffer's left fringe (in pixels).
5635 A value of 0 means no left fringe is shown in this buffer's window.
5636 A value of nil means to use the left fringe width from the window's frame. */);
5638 DEFVAR_PER_BUFFER ("right-fringe-width", &BVAR (current_buffer, right_fringe_width),
5639 Qnil,
5640 doc: /* *Width of this buffer's right fringe (in pixels).
5641 A value of 0 means no right fringe is shown in this buffer's window.
5642 A value of nil means to use the right fringe width from the window's frame. */);
5644 DEFVAR_PER_BUFFER ("fringes-outside-margins", &BVAR (current_buffer, fringes_outside_margins),
5645 Qnil,
5646 doc: /* *Non-nil means to display fringes outside display margins.
5647 A value of nil means to display fringes between margins and buffer text. */);
5649 DEFVAR_PER_BUFFER ("scroll-bar-width", &BVAR (current_buffer, scroll_bar_width),
5650 Qnil,
5651 doc: /* *Width of this buffer's scroll bars in pixels.
5652 A value of nil means to use the scroll bar width from the window's frame. */);
5654 DEFVAR_PER_BUFFER ("vertical-scroll-bar", &BVAR (current_buffer, vertical_scroll_bar_type),
5655 Qnil,
5656 doc: /* *Position of this buffer's vertical scroll bar.
5657 The value takes effect whenever you tell a window to display this buffer;
5658 for instance, with `set-window-buffer' or when `display-buffer' displays it.
5660 A value of `left' or `right' means put the vertical scroll bar at that side
5661 of the window; a value of nil means don't show any vertical scroll bars.
5662 A value of t (the default) means do whatever the window's frame specifies. */);
5664 DEFVAR_PER_BUFFER ("indicate-empty-lines",
5665 &BVAR (current_buffer, indicate_empty_lines), Qnil,
5666 doc: /* *Visually indicate empty lines after the buffer end.
5667 If non-nil, a bitmap is displayed in the left fringe of a window on
5668 window-systems. */);
5670 DEFVAR_PER_BUFFER ("indicate-buffer-boundaries",
5671 &BVAR (current_buffer, indicate_buffer_boundaries), Qnil,
5672 doc: /* *Visually indicate buffer boundaries and scrolling.
5673 If non-nil, the first and last line of the buffer are marked in the fringe
5674 of a window on window-systems with angle bitmaps, or if the window can be
5675 scrolled, the top and bottom line of the window are marked with up and down
5676 arrow bitmaps.
5678 If value is a symbol `left' or `right', both angle and arrow bitmaps
5679 are displayed in the left or right fringe, resp. Any other value
5680 that doesn't look like an alist means display the angle bitmaps in
5681 the left fringe but no arrows.
5683 You can exercise more precise control by using an alist as the
5684 value. Each alist element (INDICATOR . POSITION) specifies
5685 where to show one of the indicators. INDICATOR is one of `top',
5686 `bottom', `up', `down', or t, which specifies the default position,
5687 and POSITION is one of `left', `right', or nil, meaning do not show
5688 this indicator.
5690 For example, ((top . left) (t . right)) places the top angle bitmap in
5691 left fringe, the bottom angle bitmap in right fringe, and both arrow
5692 bitmaps in right fringe. To show just the angle bitmaps in the left
5693 fringe, but no arrow bitmaps, use ((top . left) (bottom . left)). */);
5695 DEFVAR_PER_BUFFER ("fringe-indicator-alist",
5696 &BVAR (current_buffer, fringe_indicator_alist), Qnil,
5697 doc: /* *Mapping from logical to physical fringe indicator bitmaps.
5698 The value is an alist where each element (INDICATOR . BITMAPS)
5699 specifies the fringe bitmaps used to display a specific logical
5700 fringe indicator.
5702 INDICATOR specifies the logical indicator type which is one of the
5703 following symbols: `truncation' , `continuation', `overlay-arrow',
5704 `top', `bottom', `top-bottom', `up', `down', empty-line', or `unknown'.
5706 BITMAPS is a list of symbols (LEFT RIGHT [LEFT1 RIGHT1]) which specifies
5707 the actual bitmap shown in the left or right fringe for the logical
5708 indicator. LEFT and RIGHT are the bitmaps shown in the left and/or
5709 right fringe for the specific indicator. The LEFT1 or RIGHT1 bitmaps
5710 are used only for the `bottom' and `top-bottom' indicators when the
5711 last (only) line has no final newline. BITMAPS may also be a single
5712 symbol which is used in both left and right fringes. */);
5714 DEFVAR_PER_BUFFER ("fringe-cursor-alist",
5715 &BVAR (current_buffer, fringe_cursor_alist), Qnil,
5716 doc: /* *Mapping from logical to physical fringe cursor bitmaps.
5717 The value is an alist where each element (CURSOR . BITMAP)
5718 specifies the fringe bitmaps used to display a specific logical
5719 cursor type in the fringe.
5721 CURSOR specifies the logical cursor type which is one of the following
5722 symbols: `box' , `hollow', `bar', `hbar', or `hollow-small'. The last
5723 one is used to show a hollow cursor on narrow lines display lines
5724 where the normal hollow cursor will not fit.
5726 BITMAP is the corresponding fringe bitmap shown for the logical
5727 cursor type. */);
5729 DEFVAR_PER_BUFFER ("scroll-up-aggressively",
5730 &BVAR (current_buffer, scroll_up_aggressively), Qnil,
5731 doc: /* How far to scroll windows upward.
5732 If you move point off the bottom, the window scrolls automatically.
5733 This variable controls how far it scrolls. The value nil, the default,
5734 means scroll to center point. A fraction means scroll to put point
5735 that fraction of the window's height from the bottom of the window.
5736 When the value is 0.0, point goes at the bottom line, which in the
5737 simple case that you moved off with C-f means scrolling just one line.
5738 1.0 means point goes at the top, so that in that simple case, the
5739 window scrolls by a full window height. Meaningful values are
5740 between 0.0 and 1.0, inclusive. */);
5742 DEFVAR_PER_BUFFER ("scroll-down-aggressively",
5743 &BVAR (current_buffer, scroll_down_aggressively), Qnil,
5744 doc: /* How far to scroll windows downward.
5745 If you move point off the top, the window scrolls automatically.
5746 This variable controls how far it scrolls. The value nil, the default,
5747 means scroll to center point. A fraction means scroll to put point
5748 that fraction of the window's height from the top of the window.
5749 When the value is 0.0, point goes at the top line, which in the
5750 simple case that you moved off with C-b means scrolling just one line.
5751 1.0 means point goes at the bottom, so that in that simple case, the
5752 window scrolls by a full window height. Meaningful values are
5753 between 0.0 and 1.0, inclusive. */);
5755 /*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
5756 "Don't ask.");
5759 DEFVAR_LISP ("before-change-functions", Vbefore_change_functions,
5760 doc: /* List of functions to call before each text change.
5761 Two arguments are passed to each function: the positions of
5762 the beginning and end of the range of old text to be changed.
5763 \(For an insertion, the beginning and end are at the same place.)
5764 No information is given about the length of the text after the change.
5766 Buffer changes made while executing the `before-change-functions'
5767 don't call any before-change or after-change functions.
5768 That's because `inhibit-modification-hooks' is temporarily set non-nil.
5770 If an unhandled error happens in running these functions,
5771 the variable's value remains nil. That prevents the error
5772 from happening repeatedly and making Emacs nonfunctional. */);
5773 Vbefore_change_functions = Qnil;
5775 DEFVAR_LISP ("after-change-functions", Vafter_change_functions,
5776 doc: /* List of functions to call after each text change.
5777 Three arguments are passed to each function: the positions of
5778 the beginning and end of the range of changed text,
5779 and the length in bytes of the pre-change text replaced by that range.
5780 \(For an insertion, the pre-change length is zero;
5781 for a deletion, that length is the number of bytes deleted,
5782 and the post-change beginning and end are at the same place.)
5784 Buffer changes made while executing the `after-change-functions'
5785 don't call any before-change or after-change functions.
5786 That's because `inhibit-modification-hooks' is temporarily set non-nil.
5788 If an unhandled error happens in running these functions,
5789 the variable's value remains nil. That prevents the error
5790 from happening repeatedly and making Emacs nonfunctional. */);
5791 Vafter_change_functions = Qnil;
5793 DEFVAR_LISP ("first-change-hook", Vfirst_change_hook,
5794 doc: /* A list of functions to call before changing a buffer which is unmodified.
5795 The functions are run using the `run-hooks' function. */);
5796 Vfirst_change_hook = Qnil;
5798 DEFVAR_PER_BUFFER ("buffer-undo-list", &BVAR (current_buffer, undo_list), Qnil,
5799 doc: /* List of undo entries in current buffer.
5800 Recent changes come first; older changes follow newer.
5802 An entry (BEG . END) represents an insertion which begins at
5803 position BEG and ends at position END.
5805 An entry (TEXT . POSITION) represents the deletion of the string TEXT
5806 from (abs POSITION). If POSITION is positive, point was at the front
5807 of the text being deleted; if negative, point was at the end.
5809 An entry (t HIGH . LOW) indicates that the buffer previously had
5810 \"unmodified\" status. HIGH and LOW are the high and low 16-bit portions
5811 of the visited file's modification time, as of that time. If the
5812 modification time of the most recent save is different, this entry is
5813 obsolete.
5815 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property
5816 was modified between BEG and END. PROPERTY is the property name,
5817 and VALUE is the old value.
5819 An entry (apply FUN-NAME . ARGS) means undo the change with
5820 \(apply FUN-NAME ARGS).
5822 An entry (apply DELTA BEG END FUN-NAME . ARGS) supports selective undo
5823 in the active region. BEG and END is the range affected by this entry
5824 and DELTA is the number of bytes added or deleted in that range by
5825 this change.
5827 An entry (MARKER . DISTANCE) indicates that the marker MARKER
5828 was adjusted in position by the offset DISTANCE (an integer).
5830 An entry of the form POSITION indicates that point was at the buffer
5831 location given by the integer. Undoing an entry of this form places
5832 point at POSITION.
5834 Entries with value `nil' mark undo boundaries. The undo command treats
5835 the changes between two undo boundaries as a single step to be undone.
5837 If the value of the variable is t, undo information is not recorded. */);
5839 DEFVAR_PER_BUFFER ("mark-active", &BVAR (current_buffer, mark_active), Qnil,
5840 doc: /* Non-nil means the mark and region are currently active in this buffer. */);
5842 DEFVAR_PER_BUFFER ("cache-long-line-scans", &BVAR (current_buffer, cache_long_line_scans), Qnil,
5843 doc: /* Non-nil means that Emacs should use caches to handle long lines more quickly.
5845 Normally, the line-motion functions work by scanning the buffer for
5846 newlines. Columnar operations (like `move-to-column' and
5847 `compute-motion') also work by scanning the buffer, summing character
5848 widths as they go. This works well for ordinary text, but if the
5849 buffer's lines are very long (say, more than 500 characters), these
5850 motion functions will take longer to execute. Emacs may also take
5851 longer to update the display.
5853 If `cache-long-line-scans' is non-nil, these motion functions cache the
5854 results of their scans, and consult the cache to avoid rescanning
5855 regions of the buffer until the text is modified. The caches are most
5856 beneficial when they prevent the most searching---that is, when the
5857 buffer contains long lines and large regions of characters with the
5858 same, fixed screen width.
5860 When `cache-long-line-scans' is non-nil, processing short lines will
5861 become slightly slower (because of the overhead of consulting the
5862 cache), and the caches will use memory roughly proportional to the
5863 number of newlines and characters whose screen width varies.
5865 The caches require no explicit maintenance; their accuracy is
5866 maintained internally by the Emacs primitives. Enabling or disabling
5867 the cache should not affect the behavior of any of the motion
5868 functions; it should only affect their performance. */);
5870 DEFVAR_PER_BUFFER ("point-before-scroll", &BVAR (current_buffer, point_before_scroll), Qnil,
5871 doc: /* Value of point before the last series of scroll operations, or nil. */);
5873 DEFVAR_PER_BUFFER ("buffer-file-format", &BVAR (current_buffer, file_format), Qnil,
5874 doc: /* List of formats to use when saving this buffer.
5875 Formats are defined by `format-alist'. This variable is
5876 set when a file is visited. */);
5878 DEFVAR_PER_BUFFER ("buffer-auto-save-file-format",
5879 &BVAR (current_buffer, auto_save_file_format), Qnil,
5880 doc: /* *Format in which to write auto-save files.
5881 Should be a list of symbols naming formats that are defined in `format-alist'.
5882 If it is t, which is the default, auto-save files are written in the
5883 same format as a regular save would use. */);
5885 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
5886 &BVAR (current_buffer, invisibility_spec), Qnil,
5887 doc: /* Invisibility spec of this buffer.
5888 The default is t, which means that text is invisible
5889 if it has a non-nil `invisible' property.
5890 If the value is a list, a text character is invisible if its `invisible'
5891 property is an element in that list (or is a list with members in common).
5892 If an element is a cons cell of the form (PROP . ELLIPSIS),
5893 then characters with property value PROP are invisible,
5894 and they have an ellipsis as well if ELLIPSIS is non-nil. */);
5896 DEFVAR_PER_BUFFER ("buffer-display-count",
5897 &BVAR (current_buffer, display_count), Qnil,
5898 doc: /* A number incremented each time this buffer is displayed in a window.
5899 The function `set-window-buffer' increments it. */);
5901 DEFVAR_PER_BUFFER ("buffer-display-time",
5902 &BVAR (current_buffer, display_time), Qnil,
5903 doc: /* Time stamp updated each time this buffer is displayed in a window.
5904 The function `set-window-buffer' updates this variable
5905 to the value obtained by calling `current-time'.
5906 If the buffer has never been shown in a window, the value is nil. */);
5908 DEFVAR_LISP ("transient-mark-mode", Vtransient_mark_mode,
5909 doc: /* Non-nil if Transient Mark mode is enabled.
5910 See the command `transient-mark-mode' for a description of this minor mode.
5912 Non-nil also enables highlighting of the region whenever the mark is active.
5913 The variable `highlight-nonselected-windows' controls whether to highlight
5914 all windows or just the selected window.
5916 Lisp programs may give this variable certain special values:
5918 - A value of `lambda' enables Transient Mark mode temporarily.
5919 It is disabled again after any subsequent action that would
5920 normally deactivate the mark (e.g. buffer modification).
5922 - A value of (only . OLDVAL) enables Transient Mark mode
5923 temporarily. After any subsequent point motion command that is
5924 not shift-translated, or any other action that would normally
5925 deactivate the mark (e.g. buffer modification), the value of
5926 `transient-mark-mode' is set to OLDVAL. */);
5927 Vtransient_mark_mode = Qnil;
5929 DEFVAR_LISP ("inhibit-read-only", Vinhibit_read_only,
5930 doc: /* *Non-nil means disregard read-only status of buffers or characters.
5931 If the value is t, disregard `buffer-read-only' and all `read-only'
5932 text properties. If the value is a list, disregard `buffer-read-only'
5933 and disregard a `read-only' text property if the property value
5934 is a member of the list. */);
5935 Vinhibit_read_only = Qnil;
5937 DEFVAR_PER_BUFFER ("cursor-type", &BVAR (current_buffer, cursor_type), Qnil,
5938 doc: /* Cursor to use when this buffer is in the selected window.
5939 Values are interpreted as follows:
5941 t use the cursor specified for the frame
5942 nil don't display a cursor
5943 box display a filled box cursor
5944 hollow display a hollow box cursor
5945 bar display a vertical bar cursor with default width
5946 (bar . WIDTH) display a vertical bar cursor with width WIDTH
5947 hbar display a horizontal bar cursor with default height
5948 (hbar . HEIGHT) display a horizontal bar cursor with height HEIGHT
5949 ANYTHING ELSE display a hollow box cursor
5951 When the buffer is displayed in a non-selected window, the
5952 cursor's appearance is instead controlled by the variable
5953 `cursor-in-non-selected-windows'. */);
5955 DEFVAR_PER_BUFFER ("line-spacing",
5956 &BVAR (current_buffer, extra_line_spacing), Qnil,
5957 doc: /* Additional space to put between lines when displaying a buffer.
5958 The space is measured in pixels, and put below lines on graphic displays,
5959 see `display-graphic-p'.
5960 If value is a floating point number, it specifies the spacing relative
5961 to the default frame line height. A value of nil means add no extra space. */);
5963 DEFVAR_PER_BUFFER ("cursor-in-non-selected-windows",
5964 &BVAR (current_buffer, cursor_in_non_selected_windows), Qnil,
5965 doc: /* *Non-nil means show a cursor in non-selected windows.
5966 If nil, only shows a cursor in the selected window.
5967 If t, displays a cursor related to the usual cursor type
5968 \(a solid box becomes hollow, a bar becomes a narrower bar).
5969 You can also specify the cursor type as in the `cursor-type' variable.
5970 Use Custom to set this variable and update the display." */);
5972 DEFVAR_LISP ("kill-buffer-query-functions", Vkill_buffer_query_functions,
5973 doc: /* List of functions called with no args to query before killing a buffer.
5974 The buffer being killed will be current while the functions are running.
5975 If any of them returns nil, the buffer is not killed. */);
5976 Vkill_buffer_query_functions = Qnil;
5978 DEFVAR_LISP ("change-major-mode-hook", Vchange_major_mode_hook,
5979 doc: /* Normal hook run before changing the major mode of a buffer.
5980 The function `kill-all-local-variables' runs this before doing anything else. */);
5981 Vchange_major_mode_hook = Qnil;
5982 DEFSYM (Qchange_major_mode_hook, "change-major-mode-hook");
5984 DEFVAR_LISP ("buffer-list-update-hook", Vbuffer_list_update_hook,
5985 doc: /* Hook run when the buffer list changes.
5986 Functions running this hook are `get-buffer-create',
5987 `make-indirect-buffer', `rename-buffer', `kill-buffer',
5988 `record-buffer' and `unrecord-buffer'. */);
5989 Vbuffer_list_update_hook = Qnil;
5990 DEFSYM (Qbuffer_list_update_hook, "buffer-list-update-hook");
5992 defsubr (&Sbuffer_live_p);
5993 defsubr (&Sbuffer_list);
5994 defsubr (&Sget_buffer);
5995 defsubr (&Sget_file_buffer);
5996 defsubr (&Sget_buffer_create);
5997 defsubr (&Smake_indirect_buffer);
5998 defsubr (&Sgenerate_new_buffer_name);
5999 defsubr (&Sbuffer_name);
6000 /*defsubr (&Sbuffer_number);*/
6001 defsubr (&Sbuffer_file_name);
6002 defsubr (&Sbuffer_base_buffer);
6003 defsubr (&Sbuffer_local_value);
6004 defsubr (&Sbuffer_local_variables);
6005 defsubr (&Sbuffer_modified_p);
6006 defsubr (&Sset_buffer_modified_p);
6007 defsubr (&Sbuffer_modified_tick);
6008 defsubr (&Sbuffer_chars_modified_tick);
6009 defsubr (&Srename_buffer);
6010 defsubr (&Sother_buffer);
6011 defsubr (&Sbuffer_enable_undo);
6012 defsubr (&Skill_buffer);
6013 defsubr (&Sbury_buffer_internal);
6014 defsubr (&Sset_buffer_major_mode);
6015 defsubr (&Scurrent_buffer);
6016 defsubr (&Sset_buffer);
6017 defsubr (&Sbarf_if_buffer_read_only);
6018 defsubr (&Serase_buffer);
6019 defsubr (&Sbuffer_swap_text);
6020 defsubr (&Sset_buffer_multibyte);
6021 defsubr (&Skill_all_local_variables);
6023 defsubr (&Soverlayp);
6024 defsubr (&Smake_overlay);
6025 defsubr (&Sdelete_overlay);
6026 defsubr (&Smove_overlay);
6027 defsubr (&Soverlay_start);
6028 defsubr (&Soverlay_end);
6029 defsubr (&Soverlay_buffer);
6030 defsubr (&Soverlay_properties);
6031 defsubr (&Soverlays_at);
6032 defsubr (&Soverlays_in);
6033 defsubr (&Snext_overlay_change);
6034 defsubr (&Sprevious_overlay_change);
6035 defsubr (&Soverlay_recenter);
6036 defsubr (&Soverlay_lists);
6037 defsubr (&Soverlay_get);
6038 defsubr (&Soverlay_put);
6039 defsubr (&Srestore_buffer_modified_p);
6042 void
6043 keys_of_buffer (void)
6045 initial_define_key (control_x_map, 'b', "switch-to-buffer");
6046 initial_define_key (control_x_map, 'k', "kill-buffer");
6048 /* This must not be in syms_of_buffer, because Qdisabled is not
6049 initialized when that function gets called. */
6050 Fput (intern_c_string ("erase-buffer"), Qdisabled, Qt);