Warn against using `length' to compute display width of a string.
[emacs.git] / src / buffer.c
blobefb9a80f35d226bd15588a99facd06bef2966730
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 *, EMACS_INT, EMACS_INT);
159 static Lisp_Object buffer_lisp_local_variables (struct buffer *);
161 /* For debugging; temporary. See set_buffer_internal. */
162 /* Lisp_Object Qlisp_mode, Vcheck_symbol; */
164 void
165 nsberror (Lisp_Object spec)
167 if (STRINGP (spec))
168 error ("No buffer named %s", SDATA (spec));
169 error ("Invalid buffer argument");
172 DEFUN ("buffer-live-p", Fbuffer_live_p, Sbuffer_live_p, 1, 1, 0,
173 doc: /* Return non-nil if OBJECT is a buffer which has not been killed.
174 Value is nil if OBJECT is not a buffer or if it has been killed. */)
175 (Lisp_Object object)
177 return ((BUFFERP (object) && ! NILP (BVAR (XBUFFER (object), name)))
178 ? Qt : Qnil);
181 DEFUN ("buffer-list", Fbuffer_list, Sbuffer_list, 0, 1, 0,
182 doc: /* Return a list of all existing live buffers.
183 If the optional arg FRAME is a frame, we return the buffer list in the
184 proper order for that frame: the buffers show in FRAME come first,
185 followed by the rest of the buffers. */)
186 (Lisp_Object frame)
188 Lisp_Object general;
189 general = Fmapcar (Qcdr, Vbuffer_alist);
191 if (FRAMEP (frame))
193 Lisp_Object framelist, prevlist, tail;
194 Lisp_Object args[3];
196 CHECK_FRAME (frame);
197 framelist = Fcopy_sequence (XFRAME (frame)->buffer_list);
198 prevlist = Fnreverse (Fcopy_sequence
199 (XFRAME (frame)->buried_buffer_list));
201 /* Remove from GENERAL any buffer that duplicates one in
202 FRAMELIST or PREVLIST. */
203 tail = framelist;
204 while (CONSP (tail))
206 general = Fdelq (XCAR (tail), general);
207 tail = XCDR (tail);
209 tail = prevlist;
210 while (CONSP (tail))
212 general = Fdelq (XCAR (tail), general);
213 tail = XCDR (tail);
216 args[0] = framelist;
217 args[1] = general;
218 args[2] = prevlist;
219 return Fnconc (3, args);
221 else
222 return general;
225 /* Like Fassoc, but use Fstring_equal to compare
226 (which ignores text properties),
227 and don't ever QUIT. */
229 static Lisp_Object
230 assoc_ignore_text_properties (register Lisp_Object key, Lisp_Object list)
232 register Lisp_Object tail;
233 for (tail = list; CONSP (tail); tail = XCDR (tail))
235 register Lisp_Object elt, tem;
236 elt = XCAR (tail);
237 tem = Fstring_equal (Fcar (elt), key);
238 if (!NILP (tem))
239 return elt;
241 return Qnil;
244 DEFUN ("get-buffer", Fget_buffer, Sget_buffer, 1, 1, 0,
245 doc: /* Return the buffer named BUFFER-OR-NAME.
246 BUFFER-OR-NAME must be either a string or a buffer. If BUFFER-OR-NAME
247 is a string and there is no buffer with that name, return nil. If
248 BUFFER-OR-NAME is a buffer, return it as given. */)
249 (register Lisp_Object buffer_or_name)
251 if (BUFFERP (buffer_or_name))
252 return buffer_or_name;
253 CHECK_STRING (buffer_or_name);
255 return Fcdr (assoc_ignore_text_properties (buffer_or_name, Vbuffer_alist));
258 DEFUN ("get-file-buffer", Fget_file_buffer, Sget_file_buffer, 1, 1, 0,
259 doc: /* Return the buffer visiting file FILENAME (a string).
260 The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.
261 If there is no such live buffer, return nil.
262 See also `find-buffer-visiting'. */)
263 (register Lisp_Object filename)
265 register Lisp_Object tail, buf, tem;
266 Lisp_Object handler;
268 CHECK_STRING (filename);
269 filename = Fexpand_file_name (filename, Qnil);
271 /* If the file name has special constructs in it,
272 call the corresponding file handler. */
273 handler = Ffind_file_name_handler (filename, Qget_file_buffer);
274 if (!NILP (handler))
276 Lisp_Object handled_buf = call2 (handler, Qget_file_buffer,
277 filename);
278 return BUFFERP (handled_buf) ? handled_buf : Qnil;
281 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
283 buf = Fcdr (XCAR (tail));
284 if (!BUFFERP (buf)) continue;
285 if (!STRINGP (BVAR (XBUFFER (buf), filename))) continue;
286 tem = Fstring_equal (BVAR (XBUFFER (buf), filename), filename);
287 if (!NILP (tem))
288 return buf;
290 return Qnil;
293 Lisp_Object
294 get_truename_buffer (register Lisp_Object filename)
296 register Lisp_Object tail, buf, tem;
298 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
300 buf = Fcdr (XCAR (tail));
301 if (!BUFFERP (buf)) continue;
302 if (!STRINGP (BVAR (XBUFFER (buf), file_truename))) continue;
303 tem = Fstring_equal (BVAR (XBUFFER (buf), file_truename), filename);
304 if (!NILP (tem))
305 return buf;
307 return Qnil;
310 DEFUN ("get-buffer-create", Fget_buffer_create, Sget_buffer_create, 1, 1, 0,
311 doc: /* Return the buffer specified by BUFFER-OR-NAME, creating a new one if needed.
312 If BUFFER-OR-NAME is a string and a live buffer with that name exists,
313 return that buffer. If no such buffer exists, create a new buffer with
314 that name and return it. If BUFFER-OR-NAME starts with a space, the new
315 buffer does not keep undo information.
317 If BUFFER-OR-NAME is a buffer instead of a string, return it as given,
318 even if it is dead. The return value is never nil. */)
319 (register Lisp_Object buffer_or_name)
321 register Lisp_Object buffer, name;
322 register struct buffer *b;
324 buffer = Fget_buffer (buffer_or_name);
325 if (!NILP (buffer))
326 return buffer;
328 if (SCHARS (buffer_or_name) == 0)
329 error ("Empty string for buffer name is not allowed");
331 b = allocate_buffer ();
333 /* An ordinary buffer uses its own struct buffer_text. */
334 b->text = &b->own_text;
335 b->base_buffer = 0;
337 BUF_GAP_SIZE (b) = 20;
338 BLOCK_INPUT;
339 /* We allocate extra 1-byte at the tail and keep it always '\0' for
340 anchoring a search. */
341 alloc_buffer_text (b, BUF_GAP_SIZE (b) + 1);
342 UNBLOCK_INPUT;
343 if (! BUF_BEG_ADDR (b))
344 buffer_memory_full (BUF_GAP_SIZE (b) + 1);
346 b->pt = BEG;
347 b->begv = BEG;
348 b->zv = BEG;
349 b->pt_byte = BEG_BYTE;
350 b->begv_byte = BEG_BYTE;
351 b->zv_byte = BEG_BYTE;
353 BUF_GPT (b) = BEG;
354 BUF_GPT_BYTE (b) = BEG_BYTE;
356 BUF_Z (b) = BEG;
357 BUF_Z_BYTE (b) = BEG_BYTE;
358 BUF_MODIFF (b) = 1;
359 BUF_CHARS_MODIFF (b) = 1;
360 BUF_OVERLAY_MODIFF (b) = 1;
361 BUF_SAVE_MODIFF (b) = 1;
362 BUF_INTERVALS (b) = 0;
363 BUF_UNCHANGED_MODIFIED (b) = 1;
364 BUF_OVERLAY_UNCHANGED_MODIFIED (b) = 1;
365 BUF_END_UNCHANGED (b) = 0;
366 BUF_BEG_UNCHANGED (b) = 0;
367 *(BUF_GPT_ADDR (b)) = *(BUF_Z_ADDR (b)) = 0; /* Put an anchor '\0'. */
368 b->text->inhibit_shrinking = 0;
370 b->newline_cache = 0;
371 b->width_run_cache = 0;
372 BVAR (b, width_table) = Qnil;
373 b->prevent_redisplay_optimizations_p = 1;
375 /* Put this on the chain of all buffers including killed ones. */
376 b->header.next.buffer = all_buffers;
377 all_buffers = b;
379 /* An ordinary buffer normally doesn't need markers
380 to handle BEGV and ZV. */
381 BVAR (b, pt_marker) = Qnil;
382 BVAR (b, begv_marker) = Qnil;
383 BVAR (b, zv_marker) = Qnil;
385 name = Fcopy_sequence (buffer_or_name);
386 STRING_SET_INTERVALS (name, NULL_INTERVAL);
387 BVAR (b, name) = name;
389 BVAR (b, undo_list) = (SREF (name, 0) != ' ') ? Qnil : Qt;
391 reset_buffer (b);
392 reset_buffer_local_variables (b, 1);
394 BVAR (b, mark) = Fmake_marker ();
395 BUF_MARKERS (b) = NULL;
396 BVAR (b, name) = name;
398 /* Put this in the alist of all live buffers. */
399 XSETBUFFER (buffer, b);
400 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buffer), Qnil));
401 /* And run buffer-list-update-hook. */
402 if (!NILP (Vrun_hooks))
403 call1 (Vrun_hooks, Qbuffer_list_update_hook);
405 /* An error in calling the function here (should someone redefine it)
406 can lead to infinite regress until you run out of stack. rms
407 says that's not worth protecting against. */
408 if (!NILP (Ffboundp (Qucs_set_table_for_input)))
409 /* buffer is on buffer-alist, so no gcpro. */
410 call1 (Qucs_set_table_for_input, buffer);
412 return buffer;
416 /* Return a list of overlays which is a copy of the overlay list
417 LIST, but for buffer B. */
419 static struct Lisp_Overlay *
420 copy_overlays (struct buffer *b, struct Lisp_Overlay *list)
422 Lisp_Object buffer;
423 struct Lisp_Overlay *result = NULL, *tail = NULL;
425 XSETBUFFER (buffer, b);
427 for (; list; list = list->next)
429 Lisp_Object overlay, start, end, old_overlay;
430 EMACS_INT charpos;
432 XSETMISC (old_overlay, list);
433 charpos = marker_position (OVERLAY_START (old_overlay));
434 start = Fmake_marker ();
435 Fset_marker (start, make_number (charpos), buffer);
436 XMARKER (start)->insertion_type
437 = XMARKER (OVERLAY_START (old_overlay))->insertion_type;
439 charpos = marker_position (OVERLAY_END (old_overlay));
440 end = Fmake_marker ();
441 Fset_marker (end, make_number (charpos), buffer);
442 XMARKER (end)->insertion_type
443 = XMARKER (OVERLAY_END (old_overlay))->insertion_type;
445 overlay = allocate_misc ();
446 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
447 OVERLAY_START (overlay) = start;
448 OVERLAY_END (overlay) = end;
449 OVERLAY_PLIST (overlay) = Fcopy_sequence (OVERLAY_PLIST (old_overlay));
450 XOVERLAY (overlay)->next = NULL;
452 if (tail)
453 tail = tail->next = XOVERLAY (overlay);
454 else
455 result = tail = XOVERLAY (overlay);
458 return result;
462 /* Clone per-buffer values of buffer FROM.
464 Buffer TO gets the same per-buffer values as FROM, with the
465 following exceptions: (1) TO's name is left untouched, (2) markers
466 are copied and made to refer to TO, and (3) overlay lists are
467 copied. */
469 static void
470 clone_per_buffer_values (struct buffer *from, struct buffer *to)
472 Lisp_Object to_buffer;
473 int offset;
475 XSETBUFFER (to_buffer, to);
477 /* buffer-local Lisp variables start at `undo_list',
478 tho only the ones from `name' on are GC'd normally. */
479 for (offset = PER_BUFFER_VAR_OFFSET (FIRST_FIELD_PER_BUFFER);
480 offset <= PER_BUFFER_VAR_OFFSET (LAST_FIELD_PER_BUFFER);
481 offset += sizeof (Lisp_Object))
483 Lisp_Object obj;
485 /* Don't touch the `name' which should be unique for every buffer. */
486 if (offset == PER_BUFFER_VAR_OFFSET (name))
487 continue;
489 obj = PER_BUFFER_VALUE (from, offset);
490 if (MARKERP (obj) && XMARKER (obj)->buffer == from)
492 struct Lisp_Marker *m = XMARKER (obj);
493 obj = Fmake_marker ();
494 XMARKER (obj)->insertion_type = m->insertion_type;
495 set_marker_both (obj, to_buffer, m->charpos, m->bytepos);
498 PER_BUFFER_VALUE (to, offset) = obj;
501 memcpy (to->local_flags, from->local_flags, sizeof to->local_flags);
503 to->overlays_before = copy_overlays (to, from->overlays_before);
504 to->overlays_after = copy_overlays (to, from->overlays_after);
506 /* Get (a copy of) the alist of Lisp-level local variables of FROM
507 and install that in TO. */
508 BVAR (to, local_var_alist) = buffer_lisp_local_variables (from);
512 /* If buffer B has markers to record PT, BEGV and ZV when it is not
513 current, update these markers. */
515 static void
516 record_buffer_markers (struct buffer *b)
518 if (! NILP (BVAR (b, pt_marker)))
520 Lisp_Object buffer;
522 eassert (!NILP (BVAR (b, begv_marker)));
523 eassert (!NILP (BVAR (b, zv_marker)));
525 XSETBUFFER (buffer, b);
526 set_marker_both (BVAR (b, pt_marker), buffer, b->pt, b->pt_byte);
527 set_marker_both (BVAR (b, begv_marker), buffer, b->begv, b->begv_byte);
528 set_marker_both (BVAR (b, zv_marker), buffer, b->zv, b->zv_byte);
533 /* If buffer B has markers to record PT, BEGV and ZV when it is not
534 current, fetch these values into B->begv etc. */
536 static void
537 fetch_buffer_markers (struct buffer *b)
539 if (! NILP (BVAR (b, pt_marker)))
541 Lisp_Object m;
543 eassert (!NILP (BVAR (b, begv_marker)));
544 eassert (!NILP (BVAR (b, zv_marker)));
546 m = BVAR (b, pt_marker);
547 SET_BUF_PT_BOTH (b, marker_position (m), marker_byte_position (m));
549 m = BVAR (b, begv_marker);
550 SET_BUF_BEGV_BOTH (b, marker_position (m), marker_byte_position (m));
552 m = BVAR (b, zv_marker);
553 SET_BUF_ZV_BOTH (b, marker_position (m), marker_byte_position (m));
558 DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer,
559 2, 3,
560 "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
561 doc: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
562 BASE-BUFFER should be a live buffer, or the name of an existing buffer.
563 NAME should be a string which is not the name of an existing buffer.
564 Optional argument CLONE non-nil means preserve BASE-BUFFER's state,
565 such as major and minor modes, in the indirect buffer.
566 CLONE nil means the indirect buffer's state is reset to default values. */)
567 (Lisp_Object base_buffer, Lisp_Object name, Lisp_Object clone)
569 Lisp_Object buf, tem;
570 struct buffer *b;
572 CHECK_STRING (name);
573 buf = Fget_buffer (name);
574 if (!NILP (buf))
575 error ("Buffer name `%s' is in use", SDATA (name));
577 tem = base_buffer;
578 base_buffer = Fget_buffer (base_buffer);
579 if (NILP (base_buffer))
580 error ("No such buffer: `%s'", SDATA (tem));
581 if (NILP (BVAR (XBUFFER (base_buffer), name)))
582 error ("Base buffer has been killed");
584 if (SCHARS (name) == 0)
585 error ("Empty string for buffer name is not allowed");
587 b = allocate_buffer ();
589 b->base_buffer = (XBUFFER (base_buffer)->base_buffer
590 ? XBUFFER (base_buffer)->base_buffer
591 : XBUFFER (base_buffer));
593 /* Use the base buffer's text object. */
594 b->text = b->base_buffer->text;
596 b->pt = b->base_buffer->pt;
597 b->begv = b->base_buffer->begv;
598 b->zv = b->base_buffer->zv;
599 b->pt_byte = b->base_buffer->pt_byte;
600 b->begv_byte = b->base_buffer->begv_byte;
601 b->zv_byte = b->base_buffer->zv_byte;
603 b->newline_cache = 0;
604 b->width_run_cache = 0;
605 BVAR (b, width_table) = Qnil;
607 /* Put this on the chain of all buffers including killed ones. */
608 b->header.next.buffer = all_buffers;
609 all_buffers = b;
611 name = Fcopy_sequence (name);
612 STRING_SET_INTERVALS (name, NULL_INTERVAL);
613 BVAR (b, name) = name;
615 reset_buffer (b);
616 reset_buffer_local_variables (b, 1);
618 /* Put this in the alist of all live buffers. */
619 XSETBUFFER (buf, b);
620 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
622 BVAR (b, mark) = Fmake_marker ();
623 BVAR (b, name) = name;
625 /* The multibyte status belongs to the base buffer. */
626 BVAR (b, enable_multibyte_characters) = BVAR (b->base_buffer, enable_multibyte_characters);
628 /* Make sure the base buffer has markers for its narrowing. */
629 if (NILP (BVAR (b->base_buffer, pt_marker)))
631 eassert (NILP (BVAR (b->base_buffer, begv_marker)));
632 eassert (NILP (BVAR (b->base_buffer, zv_marker)));
634 BVAR (b->base_buffer, pt_marker) = Fmake_marker ();
635 set_marker_both (BVAR (b->base_buffer, pt_marker), base_buffer,
636 b->base_buffer->pt,
637 b->base_buffer->pt_byte);
639 BVAR (b->base_buffer, begv_marker) = Fmake_marker ();
640 set_marker_both (BVAR (b->base_buffer, begv_marker), base_buffer,
641 b->base_buffer->begv,
642 b->base_buffer->begv_byte);
644 BVAR (b->base_buffer, zv_marker) = Fmake_marker ();
645 set_marker_both (BVAR (b->base_buffer, zv_marker), base_buffer,
646 b->base_buffer->zv,
647 b->base_buffer->zv_byte);
648 XMARKER (BVAR (b->base_buffer, zv_marker))->insertion_type = 1;
651 if (NILP (clone))
653 /* Give the indirect buffer markers for its narrowing. */
654 BVAR (b, pt_marker) = Fmake_marker ();
655 set_marker_both (BVAR (b, pt_marker), buf, b->pt, b->pt_byte);
656 BVAR (b, begv_marker) = Fmake_marker ();
657 set_marker_both (BVAR (b, begv_marker), buf, b->begv, b->begv_byte);
658 BVAR (b, zv_marker) = Fmake_marker ();
659 set_marker_both (BVAR (b, zv_marker), buf, b->zv, b->zv_byte);
660 XMARKER (BVAR (b, zv_marker))->insertion_type = 1;
662 else
664 struct buffer *old_b = current_buffer;
666 clone_per_buffer_values (b->base_buffer, b);
667 BVAR (b, filename) = Qnil;
668 BVAR (b, file_truename) = Qnil;
669 BVAR (b, display_count) = make_number (0);
670 BVAR (b, backed_up) = Qnil;
671 BVAR (b, auto_save_file_name) = Qnil;
672 set_buffer_internal_1 (b);
673 Fset (intern ("buffer-save-without-query"), Qnil);
674 Fset (intern ("buffer-file-number"), Qnil);
675 Fset (intern ("buffer-stale-function"), Qnil);
676 set_buffer_internal_1 (old_b);
679 /* Run buffer-list-update-hook. */
680 if (!NILP (Vrun_hooks))
681 call1 (Vrun_hooks, Qbuffer_list_update_hook);
683 return buf;
686 void
687 delete_all_overlays (struct buffer *b)
689 Lisp_Object overlay;
691 /* `reset_buffer' blindly sets the list of overlays to NULL, so we
692 have to empty the list, otherwise we end up with overlays that
693 think they belong to this buffer while the buffer doesn't know about
694 them any more. */
695 while (b->overlays_before)
697 XSETMISC (overlay, b->overlays_before);
698 Fdelete_overlay (overlay);
700 while (b->overlays_after)
702 XSETMISC (overlay, b->overlays_after);
703 Fdelete_overlay (overlay);
705 eassert (b->overlays_before == NULL);
706 eassert (b->overlays_after == NULL);
709 /* Reinitialize everything about a buffer except its name and contents
710 and local variables.
711 If called on an already-initialized buffer, the list of overlays
712 should be deleted before calling this function, otherwise we end up
713 with overlays that claim to belong to the buffer but the buffer
714 claims it doesn't belong to it. */
716 void
717 reset_buffer (register struct buffer *b)
719 BVAR (b, filename) = Qnil;
720 BVAR (b, file_truename) = Qnil;
721 BVAR (b, directory) = (current_buffer) ? BVAR (current_buffer, directory) : Qnil;
722 b->modtime = 0;
723 b->modtime_size = -1;
724 XSETFASTINT (BVAR (b, save_length), 0);
725 b->last_window_start = 1;
726 /* It is more conservative to start out "changed" than "unchanged". */
727 b->clip_changed = 0;
728 b->prevent_redisplay_optimizations_p = 1;
729 BVAR (b, backed_up) = Qnil;
730 BUF_AUTOSAVE_MODIFF (b) = 0;
731 b->auto_save_failure_time = 0;
732 BVAR (b, auto_save_file_name) = Qnil;
733 BVAR (b, read_only) = Qnil;
734 b->overlays_before = NULL;
735 b->overlays_after = NULL;
736 b->overlay_center = BEG;
737 BVAR (b, mark_active) = Qnil;
738 BVAR (b, point_before_scroll) = Qnil;
739 BVAR (b, file_format) = Qnil;
740 BVAR (b, auto_save_file_format) = Qt;
741 BVAR (b, last_selected_window) = Qnil;
742 XSETINT (BVAR (b, display_count), 0);
743 BVAR (b, display_time) = Qnil;
744 BVAR (b, enable_multibyte_characters) = BVAR (&buffer_defaults, enable_multibyte_characters);
745 BVAR (b, cursor_type) = BVAR (&buffer_defaults, cursor_type);
746 BVAR (b, extra_line_spacing) = BVAR (&buffer_defaults, extra_line_spacing);
748 b->display_error_modiff = 0;
751 /* Reset buffer B's local variables info.
752 Don't use this on a buffer that has already been in use;
753 it does not treat permanent locals consistently.
754 Instead, use Fkill_all_local_variables.
756 If PERMANENT_TOO is 1, then we reset permanent
757 buffer-local variables. If PERMANENT_TOO is 0,
758 we preserve those. */
760 static void
761 reset_buffer_local_variables (register struct buffer *b, int permanent_too)
763 register int offset;
764 int i;
766 /* Reset the major mode to Fundamental, together with all the
767 things that depend on the major mode.
768 default-major-mode is handled at a higher level.
769 We ignore it here. */
770 BVAR (b, major_mode) = Qfundamental_mode;
771 BVAR (b, keymap) = Qnil;
772 BVAR (b, mode_name) = QSFundamental;
773 BVAR (b, minor_modes) = Qnil;
775 /* If the standard case table has been altered and invalidated,
776 fix up its insides first. */
777 if (! (CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[0])
778 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[1])
779 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[2])))
780 Fset_standard_case_table (Vascii_downcase_table);
782 BVAR (b, downcase_table) = Vascii_downcase_table;
783 BVAR (b, upcase_table) = XCHAR_TABLE (Vascii_downcase_table)->extras[0];
784 BVAR (b, case_canon_table) = XCHAR_TABLE (Vascii_downcase_table)->extras[1];
785 BVAR (b, case_eqv_table) = XCHAR_TABLE (Vascii_downcase_table)->extras[2];
786 BVAR (b, invisibility_spec) = Qt;
788 /* Reset all (or most) per-buffer variables to their defaults. */
789 if (permanent_too)
790 BVAR (b, local_var_alist) = Qnil;
791 else
793 Lisp_Object tmp, prop, last = Qnil;
794 for (tmp = BVAR (b, local_var_alist); CONSP (tmp); tmp = XCDR (tmp))
795 if (!NILP (prop = Fget (XCAR (XCAR (tmp)), Qpermanent_local)))
797 /* If permanent-local, keep it. */
798 last = tmp;
799 if (EQ (prop, Qpermanent_local_hook))
801 /* This is a partially permanent hook variable.
802 Preserve only the elements that want to be preserved. */
803 Lisp_Object list, newlist;
804 list = XCDR (XCAR (tmp));
805 if (!CONSP (list))
806 newlist = list;
807 else
808 for (newlist = Qnil; CONSP (list); list = XCDR (list))
810 Lisp_Object elt = XCAR (list);
811 /* Preserve element ELT if it's t,
812 if it is a function with a `permanent-local-hook' property,
813 or if it's not a symbol. */
814 if (! SYMBOLP (elt)
815 || EQ (elt, Qt)
816 || !NILP (Fget (elt, Qpermanent_local_hook)))
817 newlist = Fcons (elt, newlist);
819 XSETCDR (XCAR (tmp), Fnreverse (newlist));
822 /* Delete this local variable. */
823 else if (NILP (last))
824 BVAR (b, local_var_alist) = XCDR (tmp);
825 else
826 XSETCDR (last, XCDR (tmp));
829 for (i = 0; i < last_per_buffer_idx; ++i)
830 if (permanent_too || buffer_permanent_local_flags[i] == 0)
831 SET_PER_BUFFER_VALUE_P (b, i, 0);
833 /* For each slot that has a default value,
834 copy that into the slot. */
836 /* buffer-local Lisp variables start at `undo_list',
837 tho only the ones from `name' on are GC'd normally. */
838 for (offset = PER_BUFFER_VAR_OFFSET (FIRST_FIELD_PER_BUFFER);
839 offset <= PER_BUFFER_VAR_OFFSET (LAST_FIELD_PER_BUFFER);
840 offset += sizeof (Lisp_Object))
842 int idx = PER_BUFFER_IDX (offset);
843 if ((idx > 0
844 && (permanent_too
845 || buffer_permanent_local_flags[idx] == 0)))
846 PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
850 /* We split this away from generate-new-buffer, because rename-buffer
851 and set-visited-file-name ought to be able to use this to really
852 rename the buffer properly. */
854 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name,
855 Sgenerate_new_buffer_name, 1, 2, 0,
856 doc: /* Return a string that is the name of no existing buffer based on NAME.
857 If there is no live buffer named NAME, then return NAME.
858 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
859 \(starting at 2) until an unused name is found, and then return that name.
860 Optional second argument IGNORE specifies a name that is okay to use (if
861 it is in the sequence to be tried) even if a buffer with that name exists. */)
862 (register Lisp_Object name, Lisp_Object ignore)
864 register Lisp_Object gentemp, tem;
865 EMACS_INT count;
866 char number[INT_BUFSIZE_BOUND (EMACS_INT) + sizeof "<>"];
868 CHECK_STRING (name);
870 tem = Fstring_equal (name, ignore);
871 if (!NILP (tem))
872 return name;
873 tem = Fget_buffer (name);
874 if (NILP (tem))
875 return name;
877 count = 1;
878 while (1)
880 sprintf (number, "<%"pI"d>", ++count);
881 gentemp = concat2 (name, build_string (number));
882 tem = Fstring_equal (gentemp, ignore);
883 if (!NILP (tem))
884 return gentemp;
885 tem = Fget_buffer (gentemp);
886 if (NILP (tem))
887 return gentemp;
892 DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
893 doc: /* Return the name of BUFFER, as a string.
894 BUFFER defaults to the current buffer.
895 Return nil if BUFFER has been killed. */)
896 (register Lisp_Object buffer)
898 if (NILP (buffer))
899 return BVAR (current_buffer, name);
900 CHECK_BUFFER (buffer);
901 return BVAR (XBUFFER (buffer), name);
904 DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
905 doc: /* Return name of file BUFFER is visiting, or nil if none.
906 No argument or nil as argument means use the current buffer. */)
907 (register Lisp_Object buffer)
909 if (NILP (buffer))
910 return BVAR (current_buffer, filename);
911 CHECK_BUFFER (buffer);
912 return BVAR (XBUFFER (buffer), filename);
915 DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
916 0, 1, 0,
917 doc: /* Return the base buffer of indirect buffer BUFFER.
918 If BUFFER is not indirect, return nil.
919 BUFFER defaults to the current buffer. */)
920 (register Lisp_Object buffer)
922 struct buffer *base;
923 Lisp_Object base_buffer;
925 if (NILP (buffer))
926 base = current_buffer->base_buffer;
927 else
929 CHECK_BUFFER (buffer);
930 base = XBUFFER (buffer)->base_buffer;
933 if (! base)
934 return Qnil;
935 XSETBUFFER (base_buffer, base);
936 return base_buffer;
939 DEFUN ("buffer-local-value", Fbuffer_local_value,
940 Sbuffer_local_value, 2, 2, 0,
941 doc: /* Return the value of VARIABLE in BUFFER.
942 If VARIABLE does not have a buffer-local binding in BUFFER, the value
943 is the default binding of the variable. */)
944 (register Lisp_Object variable, register Lisp_Object buffer)
946 register struct buffer *buf;
947 register Lisp_Object result;
948 struct Lisp_Symbol *sym;
950 CHECK_SYMBOL (variable);
951 CHECK_BUFFER (buffer);
952 buf = XBUFFER (buffer);
953 sym = XSYMBOL (variable);
955 start:
956 switch (sym->redirect)
958 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
959 case SYMBOL_PLAINVAL: result = SYMBOL_VAL (sym); break;
960 case SYMBOL_LOCALIZED:
961 { /* Look in local_var_alist. */
962 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
963 XSETSYMBOL (variable, sym); /* Update In case of aliasing. */
964 result = Fassoc (variable, BVAR (buf, local_var_alist));
965 if (!NILP (result))
967 if (blv->fwd)
968 { /* What binding is loaded right now? */
969 Lisp_Object current_alist_element = blv->valcell;
971 /* The value of the currently loaded binding is not
972 stored in it, but rather in the realvalue slot.
973 Store that value into the binding it belongs to
974 in case that is the one we are about to use. */
976 XSETCDR (current_alist_element,
977 do_symval_forwarding (blv->fwd));
979 /* Now get the (perhaps updated) value out of the binding. */
980 result = XCDR (result);
982 else
983 result = Fdefault_value (variable);
984 break;
986 case SYMBOL_FORWARDED:
988 union Lisp_Fwd *fwd = SYMBOL_FWD (sym);
989 if (BUFFER_OBJFWDP (fwd))
990 result = PER_BUFFER_VALUE (buf, XBUFFER_OBJFWD (fwd)->offset);
991 else
992 result = Fdefault_value (variable);
993 break;
995 default: abort ();
998 if (!EQ (result, Qunbound))
999 return result;
1001 xsignal1 (Qvoid_variable, variable);
1004 /* Return an alist of the Lisp-level buffer-local bindings of
1005 buffer BUF. That is, don't include the variables maintained
1006 in special slots in the buffer object. */
1008 static Lisp_Object
1009 buffer_lisp_local_variables (struct buffer *buf)
1011 Lisp_Object result = Qnil;
1012 register Lisp_Object tail;
1013 for (tail = BVAR (buf, local_var_alist); CONSP (tail); tail = XCDR (tail))
1015 Lisp_Object val, elt;
1017 elt = XCAR (tail);
1019 /* Reference each variable in the alist in buf.
1020 If inquiring about the current buffer, this gets the current values,
1021 so store them into the alist so the alist is up to date.
1022 If inquiring about some other buffer, this swaps out any values
1023 for that buffer, making the alist up to date automatically. */
1024 val = find_symbol_value (XCAR (elt));
1025 /* Use the current buffer value only if buf is the current buffer. */
1026 if (buf != current_buffer)
1027 val = XCDR (elt);
1029 result = Fcons (EQ (val, Qunbound)
1030 ? XCAR (elt)
1031 : Fcons (XCAR (elt), val),
1032 result);
1035 return result;
1038 DEFUN ("buffer-local-variables", Fbuffer_local_variables,
1039 Sbuffer_local_variables, 0, 1, 0,
1040 doc: /* Return an alist of variables that are buffer-local in BUFFER.
1041 Most elements look like (SYMBOL . VALUE), describing one variable.
1042 For a symbol that is locally unbound, just the symbol appears in the value.
1043 Note that storing new VALUEs in these elements doesn't change the variables.
1044 No argument or nil as argument means use current buffer as BUFFER. */)
1045 (register Lisp_Object buffer)
1047 register struct buffer *buf;
1048 register Lisp_Object result;
1050 if (NILP (buffer))
1051 buf = current_buffer;
1052 else
1054 CHECK_BUFFER (buffer);
1055 buf = XBUFFER (buffer);
1058 result = buffer_lisp_local_variables (buf);
1060 /* Add on all the variables stored in special slots. */
1062 int offset, idx;
1064 /* buffer-local Lisp variables start at `undo_list',
1065 tho only the ones from `name' on are GC'd normally. */
1066 for (offset = PER_BUFFER_VAR_OFFSET (FIRST_FIELD_PER_BUFFER);
1067 offset <= PER_BUFFER_VAR_OFFSET (LAST_FIELD_PER_BUFFER);
1068 /* sizeof EMACS_INT == sizeof Lisp_Object */
1069 offset += (sizeof (EMACS_INT)))
1071 idx = PER_BUFFER_IDX (offset);
1072 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
1073 && SYMBOLP (PER_BUFFER_SYMBOL (offset)))
1075 Lisp_Object sym = PER_BUFFER_SYMBOL (offset);
1076 Lisp_Object val = PER_BUFFER_VALUE (buf, offset);
1077 result = Fcons (EQ (val, Qunbound) ? sym : Fcons (sym, val),
1078 result);
1083 return result;
1086 DEFUN ("buffer-modified-p", Fbuffer_modified_p, Sbuffer_modified_p,
1087 0, 1, 0,
1088 doc: /* Return t if BUFFER was modified since its file was last read or saved.
1089 No argument or nil as argument means use current buffer as BUFFER. */)
1090 (register Lisp_Object buffer)
1092 register struct buffer *buf;
1093 if (NILP (buffer))
1094 buf = current_buffer;
1095 else
1097 CHECK_BUFFER (buffer);
1098 buf = XBUFFER (buffer);
1101 return BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf) ? Qt : Qnil;
1104 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p, Sset_buffer_modified_p,
1105 1, 1, 0,
1106 doc: /* Mark current buffer as modified or unmodified according to FLAG.
1107 A non-nil FLAG means mark the buffer modified. */)
1108 (register Lisp_Object flag)
1110 register int already;
1111 register Lisp_Object fn;
1112 Lisp_Object buffer, window;
1114 #ifdef CLASH_DETECTION
1115 /* If buffer becoming modified, lock the file.
1116 If buffer becoming unmodified, unlock the file. */
1118 fn = BVAR (current_buffer, file_truename);
1119 /* Test buffer-file-name so that binding it to nil is effective. */
1120 if (!NILP (fn) && ! NILP (BVAR (current_buffer, filename)))
1122 already = SAVE_MODIFF < MODIFF;
1123 if (!already && !NILP (flag))
1124 lock_file (fn);
1125 else if (already && NILP (flag))
1126 unlock_file (fn);
1128 #endif /* CLASH_DETECTION */
1130 /* Here we have a problem. SAVE_MODIFF is used here to encode
1131 buffer-modified-p (as SAVE_MODIFF<MODIFF) as well as
1132 recent-auto-save-p (as SAVE_MODIFF<auto_save_modified). So if we
1133 modify SAVE_MODIFF to affect one, we may affect the other
1134 as well.
1135 E.g. if FLAG is nil we need to set SAVE_MODIFF to MODIFF, but
1136 if SAVE_MODIFF<auto_save_modified that means we risk changing
1137 recent-auto-save-p from t to nil.
1138 Vice versa, if FLAG is non-nil and SAVE_MODIFF>=auto_save_modified
1139 we risk changing recent-auto-save-p from nil to t. */
1140 SAVE_MODIFF = (NILP (flag)
1141 /* FIXME: This unavoidably sets recent-auto-save-p to nil. */
1142 ? MODIFF
1143 /* Let's try to preserve recent-auto-save-p. */
1144 : SAVE_MODIFF < MODIFF ? SAVE_MODIFF
1145 /* If SAVE_MODIFF == auto_save_modified == MODIFF,
1146 we can either decrease SAVE_MODIFF and auto_save_modified
1147 or increase MODIFF. */
1148 : MODIFF++);
1150 /* Set update_mode_lines only if buffer is displayed in some window.
1151 Packages like jit-lock or lazy-lock preserve a buffer's modified
1152 state by recording/restoring the state around blocks of code.
1153 Setting update_mode_lines makes redisplay consider all windows
1154 (on all frames). Stealth fontification of buffers not displayed
1155 would incur additional redisplay costs if we'd set
1156 update_modes_lines unconditionally.
1158 Ideally, I think there should be another mechanism for fontifying
1159 buffers without "modifying" buffers, or redisplay should be
1160 smarter about updating the `*' in mode lines. --gerd */
1161 XSETBUFFER (buffer, current_buffer);
1162 window = Fget_buffer_window (buffer, Qt);
1163 if (WINDOWP (window))
1165 ++update_mode_lines;
1166 current_buffer->prevent_redisplay_optimizations_p = 1;
1169 return flag;
1172 DEFUN ("restore-buffer-modified-p", Frestore_buffer_modified_p,
1173 Srestore_buffer_modified_p, 1, 1, 0,
1174 doc: /* Like `set-buffer-modified-p', with a difference concerning redisplay.
1175 It is not ensured that mode lines will be updated to show the modified
1176 state of the current buffer. Use with care. */)
1177 (Lisp_Object flag)
1179 #ifdef CLASH_DETECTION
1180 Lisp_Object fn;
1182 /* If buffer becoming modified, lock the file.
1183 If buffer becoming unmodified, unlock the file. */
1185 fn = BVAR (current_buffer, file_truename);
1186 /* Test buffer-file-name so that binding it to nil is effective. */
1187 if (!NILP (fn) && ! NILP (BVAR (current_buffer, filename)))
1189 int already = SAVE_MODIFF < MODIFF;
1190 if (!already && !NILP (flag))
1191 lock_file (fn);
1192 else if (already && NILP (flag))
1193 unlock_file (fn);
1195 #endif /* CLASH_DETECTION */
1197 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1198 return flag;
1201 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick, Sbuffer_modified_tick,
1202 0, 1, 0,
1203 doc: /* Return BUFFER's tick counter, incremented for each change in text.
1204 Each buffer has a tick counter which is incremented each time the
1205 text in that buffer is changed. It wraps around occasionally.
1206 No argument or nil as argument means use current buffer as BUFFER. */)
1207 (register Lisp_Object buffer)
1209 register struct buffer *buf;
1210 if (NILP (buffer))
1211 buf = current_buffer;
1212 else
1214 CHECK_BUFFER (buffer);
1215 buf = XBUFFER (buffer);
1218 return make_number (BUF_MODIFF (buf));
1221 DEFUN ("buffer-chars-modified-tick", Fbuffer_chars_modified_tick,
1222 Sbuffer_chars_modified_tick, 0, 1, 0,
1223 doc: /* Return BUFFER's character-change tick counter.
1224 Each buffer has a character-change tick counter, which is set to the
1225 value of the buffer's tick counter \(see `buffer-modified-tick'), each
1226 time text in that buffer is inserted or deleted. By comparing the
1227 values returned by two individual calls of `buffer-chars-modified-tick',
1228 you can tell whether a character change occurred in that buffer in
1229 between these calls. No argument or nil as argument means use current
1230 buffer as BUFFER. */)
1231 (register Lisp_Object buffer)
1233 register struct buffer *buf;
1234 if (NILP (buffer))
1235 buf = current_buffer;
1236 else
1238 CHECK_BUFFER (buffer);
1239 buf = XBUFFER (buffer);
1242 return make_number (BUF_CHARS_MODIFF (buf));
1245 DEFUN ("rename-buffer", Frename_buffer, Srename_buffer, 1, 2,
1246 "(list (read-string \"Rename buffer (to new name): \" \
1247 nil 'buffer-name-history (buffer-name (current-buffer))) \
1248 current-prefix-arg)",
1249 doc: /* Change current buffer's name to NEWNAME (a string).
1250 If second arg UNIQUE is nil or omitted, it is an error if a
1251 buffer named NEWNAME already exists.
1252 If UNIQUE is non-nil, come up with a new name using
1253 `generate-new-buffer-name'.
1254 Interactively, you can set UNIQUE with a prefix argument.
1255 We return the name we actually gave the buffer.
1256 This does not change the name of the visited file (if any). */)
1257 (register Lisp_Object newname, Lisp_Object unique)
1259 register Lisp_Object tem, buf;
1261 CHECK_STRING (newname);
1263 if (SCHARS (newname) == 0)
1264 error ("Empty string is invalid as a buffer name");
1266 tem = Fget_buffer (newname);
1267 if (!NILP (tem))
1269 /* Don't short-circuit if UNIQUE is t. That is a useful way to
1270 rename the buffer automatically so you can create another
1271 with the original name. It makes UNIQUE equivalent to
1272 (rename-buffer (generate-new-buffer-name NEWNAME)). */
1273 if (NILP (unique) && XBUFFER (tem) == current_buffer)
1274 return BVAR (current_buffer, name);
1275 if (!NILP (unique))
1276 newname = Fgenerate_new_buffer_name (newname, BVAR (current_buffer, name));
1277 else
1278 error ("Buffer name `%s' is in use", SDATA (newname));
1281 BVAR (current_buffer, name) = newname;
1283 /* Catch redisplay's attention. Unless we do this, the mode lines for
1284 any windows displaying current_buffer will stay unchanged. */
1285 update_mode_lines++;
1287 XSETBUFFER (buf, current_buffer);
1288 Fsetcar (Frassq (buf, Vbuffer_alist), newname);
1289 if (NILP (BVAR (current_buffer, filename))
1290 && !NILP (BVAR (current_buffer, auto_save_file_name)))
1291 call0 (intern ("rename-auto-save-file"));
1293 /* Run buffer-list-update-hook. */
1294 if (!NILP (Vrun_hooks))
1295 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1297 /* Refetch since that last call may have done GC. */
1298 return BVAR (current_buffer, name);
1301 DEFUN ("other-buffer", Fother_buffer, Sother_buffer, 0, 3, 0,
1302 doc: /* Return most recently selected buffer other than BUFFER.
1303 Buffers not visible in windows are preferred to visible buffers, unless
1304 optional second argument VISIBLE-OK is non-nil. Ignore the argument
1305 BUFFER unless it denotes a live buffer. If the optional third argument
1306 FRAME is non-nil, use that frame's buffer list instead of the selected
1307 frame's buffer list.
1309 The buffer is found by scanning the selected or specified frame's buffer
1310 list first, followed by the list of all buffers. If no other buffer
1311 exists, return the buffer `*scratch*' (creating it if necessary). */)
1312 (register Lisp_Object buffer, Lisp_Object visible_ok, Lisp_Object frame)
1314 Lisp_Object Fset_buffer_major_mode (Lisp_Object buffer);
1315 Lisp_Object tail, buf, pred;
1316 Lisp_Object notsogood = Qnil;
1318 if (NILP (frame))
1319 frame = selected_frame;
1321 CHECK_FRAME (frame);
1323 pred = frame_buffer_predicate (frame);
1324 /* Consider buffers that have been seen in the frame first. */
1325 tail = XFRAME (frame)->buffer_list;
1326 for (; CONSP (tail); tail = XCDR (tail))
1328 buf = XCAR (tail);
1329 if (BUFFERP (buf) && !EQ (buf, buffer)
1330 && !NILP (BVAR (XBUFFER (buf), name))
1331 && (SREF (BVAR (XBUFFER (buf), name), 0) != ' ')
1332 /* If the frame has a buffer_predicate, disregard buffers that
1333 don't fit the predicate. */
1334 && (NILP (pred) || !NILP (call1 (pred, buf))))
1336 if (!NILP (visible_ok)
1337 || NILP (Fget_buffer_window (buf, Qvisible)))
1338 return buf;
1339 else if (NILP (notsogood))
1340 notsogood = buf;
1344 /* Consider alist of all buffers next. */
1345 tail = Vbuffer_alist;
1346 for (; CONSP (tail); tail = XCDR (tail))
1348 buf = Fcdr (XCAR (tail));
1349 if (BUFFERP (buf) && !EQ (buf, buffer)
1350 && !NILP (BVAR (XBUFFER (buf), name))
1351 && (SREF (BVAR (XBUFFER (buf), name), 0) != ' ')
1352 /* If the frame has a buffer_predicate, disregard buffers that
1353 don't fit the predicate. */
1354 && (NILP (pred) || !NILP (call1 (pred, buf))))
1356 if (!NILP (visible_ok)
1357 || NILP (Fget_buffer_window (buf, Qvisible)))
1358 return buf;
1359 else if (NILP (notsogood))
1360 notsogood = buf;
1364 if (!NILP (notsogood))
1365 return notsogood;
1366 else
1368 buf = Fget_buffer (build_string ("*scratch*"));
1369 if (NILP (buf))
1371 buf = Fget_buffer_create (build_string ("*scratch*"));
1372 Fset_buffer_major_mode (buf);
1374 return buf;
1378 /* The following function is a safe variant of Fother_buffer: It doesn't
1379 pay attention to any frame-local buffer lists, doesn't care about
1380 visibility of buffers, and doesn't evaluate any frame predicates. */
1382 Lisp_Object
1383 other_buffer_safely (Lisp_Object buffer)
1385 Lisp_Object Fset_buffer_major_mode (Lisp_Object buffer);
1386 Lisp_Object tail, buf;
1388 tail = Vbuffer_alist;
1389 for (; CONSP (tail); tail = XCDR (tail))
1391 buf = Fcdr (XCAR (tail));
1392 if (BUFFERP (buf) && !EQ (buf, buffer)
1393 && !NILP (BVAR (XBUFFER (buf), name))
1394 && (SREF (BVAR (XBUFFER (buf), name), 0) != ' '))
1395 return buf;
1398 buf = Fget_buffer (build_string ("*scratch*"));
1399 if (NILP (buf))
1401 buf = Fget_buffer_create (build_string ("*scratch*"));
1402 Fset_buffer_major_mode (buf);
1405 return buf;
1408 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo, Sbuffer_enable_undo,
1409 0, 1, "",
1410 doc: /* Start keeping undo information for buffer BUFFER.
1411 No argument or nil as argument means do this for the current buffer. */)
1412 (register Lisp_Object buffer)
1414 Lisp_Object real_buffer;
1416 if (NILP (buffer))
1417 XSETBUFFER (real_buffer, current_buffer);
1418 else
1420 real_buffer = Fget_buffer (buffer);
1421 if (NILP (real_buffer))
1422 nsberror (buffer);
1425 if (EQ (BVAR (XBUFFER (real_buffer), undo_list), Qt))
1426 BVAR (XBUFFER (real_buffer), undo_list) = Qnil;
1428 return Qnil;
1432 DEFVAR_LISP ("kill-buffer-hook", ..., "\
1433 Hook to be run (by `run-hooks', which see) when a buffer is killed.\n\
1434 The buffer being killed will be current while the hook is running.\n\
1435 See `kill-buffer'."
1437 DEFUN ("kill-buffer", Fkill_buffer, Skill_buffer, 0, 1, "bKill buffer: ",
1438 doc: /* Kill buffer BUFFER-OR-NAME.
1439 The argument may be a buffer or the name of an existing buffer.
1440 Argument nil or omitted means kill the current buffer. Return t if the
1441 buffer is actually killed, nil otherwise.
1443 This function calls `replace-buffer-in-windows' for cleaning up all
1444 windows currently displaying the buffer to be killed. The functions in
1445 `kill-buffer-query-functions' are called with the buffer to be killed as
1446 the current buffer. If any of them returns nil, the buffer is not
1447 killed. The hook `kill-buffer-hook' is run before the buffer is
1448 actually killed. The buffer being killed will be current while the hook
1449 is running.
1451 Any processes that have this buffer as the `process-buffer' are killed
1452 with SIGHUP. */)
1453 (Lisp_Object buffer_or_name)
1455 Lisp_Object buffer;
1456 register struct buffer *b;
1457 register Lisp_Object tem;
1458 register struct Lisp_Marker *m;
1459 struct gcpro gcpro1;
1461 if (NILP (buffer_or_name))
1462 buffer = Fcurrent_buffer ();
1463 else
1464 buffer = Fget_buffer (buffer_or_name);
1465 if (NILP (buffer))
1466 nsberror (buffer_or_name);
1468 b = XBUFFER (buffer);
1470 /* Avoid trouble for buffer already dead. */
1471 if (NILP (BVAR (b, name)))
1472 return Qnil;
1474 /* Query if the buffer is still modified. */
1475 if (INTERACTIVE && !NILP (BVAR (b, filename))
1476 && BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
1478 GCPRO1 (buffer);
1479 tem = do_yes_or_no_p (format2 ("Buffer %s modified; kill anyway? ",
1480 BVAR (b, name), make_number (0)));
1481 UNGCPRO;
1482 if (NILP (tem))
1483 return Qnil;
1486 /* Run hooks with the buffer to be killed the current buffer. */
1488 int count = SPECPDL_INDEX ();
1489 Lisp_Object arglist[1];
1491 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1492 set_buffer_internal (b);
1494 /* First run the query functions; if any query is answered no,
1495 don't kill the buffer. */
1496 arglist[0] = Qkill_buffer_query_functions;
1497 tem = Frun_hook_with_args_until_failure (1, arglist);
1498 if (NILP (tem))
1499 return unbind_to (count, Qnil);
1501 /* Then run the hooks. */
1502 Frun_hooks (1, &Qkill_buffer_hook);
1503 unbind_to (count, Qnil);
1506 /* We have no more questions to ask. Verify that it is valid
1507 to kill the buffer. This must be done after the questions
1508 since anything can happen within do_yes_or_no_p. */
1510 /* Don't kill the minibuffer now current. */
1511 if (EQ (buffer, XWINDOW (minibuf_window)->buffer))
1512 return Qnil;
1514 if (NILP (BVAR (b, name)))
1515 return Qnil;
1517 /* When we kill a base buffer, kill all its indirect buffers.
1518 We do it at this stage so nothing terrible happens if they
1519 ask questions or their hooks get errors. */
1520 if (! b->base_buffer)
1522 struct buffer *other;
1524 GCPRO1 (buffer);
1526 for (other = all_buffers; other; other = other->header.next.buffer)
1527 /* all_buffers contains dead buffers too;
1528 don't re-kill them. */
1529 if (other->base_buffer == b && !NILP (BVAR (other, name)))
1531 Lisp_Object buf;
1532 XSETBUFFER (buf, other);
1533 Fkill_buffer (buf);
1536 UNGCPRO;
1539 /* Run replace_buffer_in_windows before making another buffer current
1540 since set-window-buffer-start-and-point will refuse to make another
1541 buffer current if the selected window does not show the current
1542 buffer. (Bug#10114) */
1543 replace_buffer_in_windows (buffer);
1545 /* Make this buffer not be current.
1546 In the process, notice if this is the sole visible buffer
1547 and give up if so. */
1548 if (b == current_buffer)
1550 tem = Fother_buffer (buffer, Qnil, Qnil);
1551 Fset_buffer (tem);
1552 if (b == current_buffer)
1553 return Qnil;
1556 /* Notice if the buffer to kill is the sole visible buffer
1557 when we're currently in the mini-buffer, and give up if so. */
1558 XSETBUFFER (tem, current_buffer);
1559 if (EQ (tem, XWINDOW (minibuf_window)->buffer))
1561 tem = Fother_buffer (buffer, Qnil, Qnil);
1562 if (EQ (buffer, tem))
1563 return Qnil;
1566 /* Now there is no question: we can kill the buffer. */
1568 #ifdef CLASH_DETECTION
1569 /* Unlock this buffer's file, if it is locked. */
1570 unlock_buffer (b);
1571 #endif /* CLASH_DETECTION */
1573 GCPRO1 (buffer);
1574 kill_buffer_processes (buffer);
1575 UNGCPRO;
1577 /* Killing buffer processes may run sentinels which may
1578 have called kill-buffer. */
1580 if (NILP (BVAR (b, name)))
1581 return Qnil;
1583 /* These may run Lisp code and into infinite loops (if someone
1584 insisted on circular lists) so allow quitting here. */
1585 frames_discard_buffer (buffer);
1587 clear_charpos_cache (b);
1589 tem = Vinhibit_quit;
1590 Vinhibit_quit = Qt;
1591 /* Remove the buffer from the list of all buffers. */
1592 Vbuffer_alist = Fdelq (Frassq (buffer, Vbuffer_alist), Vbuffer_alist);
1593 /* If replace_buffer_in_windows didn't do its job correctly fix that
1594 now. */
1595 replace_buffer_in_windows_safely (buffer);
1596 Vinhibit_quit = tem;
1598 /* Delete any auto-save file, if we saved it in this session.
1599 But not if the buffer is modified. */
1600 if (STRINGP (BVAR (b, auto_save_file_name))
1601 && BUF_AUTOSAVE_MODIFF (b) != 0
1602 && BUF_SAVE_MODIFF (b) < BUF_AUTOSAVE_MODIFF (b)
1603 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
1604 && NILP (Fsymbol_value (intern ("auto-save-visited-file-name"))))
1606 Lisp_Object delete;
1607 delete = Fsymbol_value (intern ("delete-auto-save-files"));
1608 if (! NILP (delete))
1609 internal_delete_file (BVAR (b, auto_save_file_name));
1612 if (b->base_buffer)
1614 /* Unchain all markers that belong to this indirect buffer.
1615 Don't unchain the markers that belong to the base buffer
1616 or its other indirect buffers. */
1617 for (m = BUF_MARKERS (b); m; )
1619 struct Lisp_Marker *next = m->next;
1620 if (m->buffer == b)
1621 unchain_marker (m);
1622 m = next;
1625 else
1627 /* Unchain all markers of this buffer and its indirect buffers.
1628 and leave them pointing nowhere. */
1629 for (m = BUF_MARKERS (b); m; )
1631 struct Lisp_Marker *next = m->next;
1632 m->buffer = 0;
1633 m->next = NULL;
1634 m = next;
1636 BUF_MARKERS (b) = NULL;
1637 BUF_INTERVALS (b) = NULL_INTERVAL;
1639 /* Perhaps we should explicitly free the interval tree here... */
1642 /* Reset the local variables, so that this buffer's local values
1643 won't be protected from GC. They would be protected
1644 if they happened to remain cached in their symbols.
1645 This gets rid of them for certain. */
1646 swap_out_buffer_local_variables (b);
1647 reset_buffer_local_variables (b, 1);
1649 BVAR (b, name) = Qnil;
1651 BLOCK_INPUT;
1652 if (! b->base_buffer)
1653 free_buffer_text (b);
1655 if (b->newline_cache)
1657 free_region_cache (b->newline_cache);
1658 b->newline_cache = 0;
1660 if (b->width_run_cache)
1662 free_region_cache (b->width_run_cache);
1663 b->width_run_cache = 0;
1665 BVAR (b, width_table) = Qnil;
1666 UNBLOCK_INPUT;
1667 BVAR (b, undo_list) = Qnil;
1669 /* Run buffer-list-update-hook. */
1670 if (!NILP (Vrun_hooks))
1671 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1673 return Qt;
1676 /* Move association for BUFFER to the front of buffer (a)lists. Since
1677 we do this each time BUFFER is selected visibly, the more recently
1678 selected buffers are always closer to the front of those lists. This
1679 means that other_buffer is more likely to choose a relevant buffer.
1681 Note that this moves BUFFER to the front of the buffer lists of the
1682 selected frame even if BUFFER is not shown there. If BUFFER is not
1683 shown in the selected frame, consider the present behavior a feature.
1684 `select-window' gets this right since it shows BUFFER in the selected
1685 window when calling us. */
1687 void
1688 record_buffer (Lisp_Object buffer)
1690 Lisp_Object aelt, aelt_cons, tem;
1691 register struct frame *f = XFRAME (selected_frame);
1693 CHECK_BUFFER (buffer);
1695 /* Update Vbuffer_alist (we know that it has an entry for BUFFER).
1696 Don't allow quitting since this might leave the buffer list in an
1697 inconsistent state. */
1698 tem = Vinhibit_quit;
1699 Vinhibit_quit = Qt;
1700 aelt = Frassq (buffer, Vbuffer_alist);
1701 aelt_cons = Fmemq (aelt, Vbuffer_alist);
1702 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
1703 XSETCDR (aelt_cons, Vbuffer_alist);
1704 Vbuffer_alist = aelt_cons;
1705 Vinhibit_quit = tem;
1707 /* Update buffer list of selected frame. */
1708 f->buffer_list = Fcons (buffer, Fdelq (buffer, f->buffer_list));
1709 f->buried_buffer_list = Fdelq (buffer, f->buried_buffer_list);
1711 /* Run buffer-list-update-hook. */
1712 if (!NILP (Vrun_hooks))
1713 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1717 /* Move BUFFER to the end of the buffer (a)lists. Do nothing if the
1718 buffer is killed. For the selected frame's buffer list this moves
1719 BUFFER to its end even if it was never shown in that frame. If
1720 this happens we have a feature, hence `bury-buffer-internal' should be
1721 called only when BUFFER was shown in the selected frame. */
1723 DEFUN ("bury-buffer-internal", Fbury_buffer_internal, Sbury_buffer_internal,
1724 1, 1, 0,
1725 doc: /* Move BUFFER to the end of the buffer list. */)
1726 (Lisp_Object buffer)
1728 Lisp_Object aelt, aelt_cons, tem;
1729 register struct frame *f = XFRAME (selected_frame);
1731 CHECK_BUFFER (buffer);
1733 /* Update Vbuffer_alist (we know that it has an entry for BUFFER).
1734 Don't allow quitting since this might leave the buffer list in an
1735 inconsistent state. */
1736 tem = Vinhibit_quit;
1737 Vinhibit_quit = Qt;
1738 aelt = Frassq (buffer, Vbuffer_alist);
1739 aelt_cons = Fmemq (aelt, Vbuffer_alist);
1740 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
1741 XSETCDR (aelt_cons, Qnil);
1742 Vbuffer_alist = nconc2 (Vbuffer_alist, aelt_cons);
1743 Vinhibit_quit = tem;
1745 /* Update buffer lists of selected frame. */
1746 f->buffer_list = Fdelq (buffer, f->buffer_list);
1747 f->buried_buffer_list = Fcons (buffer, Fdelq (buffer, f->buried_buffer_list));
1749 /* Run buffer-list-update-hook. */
1750 if (!NILP (Vrun_hooks))
1751 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1753 return Qnil;
1756 DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode, Sset_buffer_major_mode, 1, 1, 0,
1757 doc: /* Set an appropriate major mode for BUFFER.
1758 For the *scratch* buffer, use `initial-major-mode', otherwise choose a mode
1759 according to `default-major-mode'.
1760 Use this function before selecting the buffer, since it may need to inspect
1761 the current buffer's major mode. */)
1762 (Lisp_Object buffer)
1764 int count;
1765 Lisp_Object function;
1767 CHECK_BUFFER (buffer);
1769 if (STRINGP (BVAR (XBUFFER (buffer), name))
1770 && strcmp (SSDATA (BVAR (XBUFFER (buffer), name)), "*scratch*") == 0)
1771 function = find_symbol_value (intern ("initial-major-mode"));
1772 else
1774 function = BVAR (&buffer_defaults, major_mode);
1775 if (NILP (function)
1776 && NILP (Fget (BVAR (current_buffer, major_mode), Qmode_class)))
1777 function = BVAR (current_buffer, major_mode);
1780 if (NILP (function) || EQ (function, Qfundamental_mode))
1781 return Qnil;
1783 count = SPECPDL_INDEX ();
1785 /* To select a nonfundamental mode,
1786 select the buffer temporarily and then call the mode function. */
1788 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1790 Fset_buffer (buffer);
1791 call0 (function);
1793 return unbind_to (count, Qnil);
1796 DEFUN ("current-buffer", Fcurrent_buffer, Scurrent_buffer, 0, 0, 0,
1797 doc: /* Return the current buffer as a Lisp object. */)
1798 (void)
1800 register Lisp_Object buf;
1801 XSETBUFFER (buf, current_buffer);
1802 return buf;
1805 /* Set the current buffer to B.
1807 We previously set windows_or_buffers_changed here to invalidate
1808 global unchanged information in beg_unchanged and end_unchanged.
1809 This is no longer necessary because we now compute unchanged
1810 information on a buffer-basis. Every action affecting other
1811 windows than the selected one requires a select_window at some
1812 time, and that increments windows_or_buffers_changed. */
1814 void
1815 set_buffer_internal (register struct buffer *b)
1817 if (current_buffer != b)
1818 set_buffer_internal_1 (b);
1821 /* Set the current buffer to B, and do not set windows_or_buffers_changed.
1822 This is used by redisplay. */
1824 void
1825 set_buffer_internal_1 (register struct buffer *b)
1827 register struct buffer *old_buf;
1828 register Lisp_Object tail;
1830 #ifdef USE_MMAP_FOR_BUFFERS
1831 if (b->text->beg == NULL)
1832 enlarge_buffer_text (b, 0);
1833 #endif /* USE_MMAP_FOR_BUFFERS */
1835 if (current_buffer == b)
1836 return;
1838 old_buf = current_buffer;
1839 current_buffer = b;
1840 last_known_column_point = -1; /* invalidate indentation cache */
1842 if (old_buf)
1844 /* Put the undo list back in the base buffer, so that it appears
1845 that an indirect buffer shares the undo list of its base. */
1846 if (old_buf->base_buffer)
1847 BVAR (old_buf->base_buffer, undo_list) = BVAR (old_buf, undo_list);
1849 /* If the old current buffer has markers to record PT, BEGV and ZV
1850 when it is not current, update them now. */
1851 record_buffer_markers (old_buf);
1854 /* Get the undo list from the base buffer, so that it appears
1855 that an indirect buffer shares the undo list of its base. */
1856 if (b->base_buffer)
1857 BVAR (b, undo_list) = BVAR (b->base_buffer, undo_list);
1859 /* If the new current buffer has markers to record PT, BEGV and ZV
1860 when it is not current, fetch them now. */
1861 fetch_buffer_markers (b);
1863 /* Look down buffer's list of local Lisp variables
1864 to find and update any that forward into C variables. */
1868 for (tail = BVAR (b, local_var_alist); CONSP (tail); tail = XCDR (tail))
1870 Lisp_Object var = XCAR (XCAR (tail));
1871 struct Lisp_Symbol *sym = XSYMBOL (var);
1872 if (sym->redirect == SYMBOL_LOCALIZED /* Just to be sure. */
1873 && SYMBOL_BLV (sym)->fwd)
1874 /* Just reference the variable
1875 to cause it to become set for this buffer. */
1876 Fsymbol_value (var);
1879 /* Do the same with any others that were local to the previous buffer */
1880 while (b != old_buf && (b = old_buf, b));
1883 /* Switch to buffer B temporarily for redisplay purposes.
1884 This avoids certain things that don't need to be done within redisplay. */
1886 void
1887 set_buffer_temp (struct buffer *b)
1889 register struct buffer *old_buf;
1891 if (current_buffer == b)
1892 return;
1894 old_buf = current_buffer;
1895 current_buffer = b;
1897 /* If the old current buffer has markers to record PT, BEGV and ZV
1898 when it is not current, update them now. */
1899 record_buffer_markers (old_buf);
1901 /* If the new current buffer has markers to record PT, BEGV and ZV
1902 when it is not current, fetch them now. */
1903 fetch_buffer_markers (b);
1906 DEFUN ("set-buffer", Fset_buffer, Sset_buffer, 1, 1, 0,
1907 doc: /* Make buffer BUFFER-OR-NAME current for editing operations.
1908 BUFFER-OR-NAME may be a buffer or the name of an existing buffer. See
1909 also `save-excursion' when you want to make a buffer current
1910 temporarily. This function does not display the buffer, so its effect
1911 ends when the current command terminates. Use `switch-to-buffer' or
1912 `pop-to-buffer' to switch buffers permanently. */)
1913 (register Lisp_Object buffer_or_name)
1915 register Lisp_Object buffer;
1916 buffer = Fget_buffer (buffer_or_name);
1917 if (NILP (buffer))
1918 nsberror (buffer_or_name);
1919 if (NILP (BVAR (XBUFFER (buffer), name)))
1920 error ("Selecting deleted buffer");
1921 set_buffer_internal (XBUFFER (buffer));
1922 return buffer;
1925 /* Set the current buffer to BUFFER provided it is alive. */
1927 Lisp_Object
1928 set_buffer_if_live (Lisp_Object buffer)
1930 if (! NILP (BVAR (XBUFFER (buffer), name)))
1931 Fset_buffer (buffer);
1932 return Qnil;
1935 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only,
1936 Sbarf_if_buffer_read_only, 0, 0, 0,
1937 doc: /* Signal a `buffer-read-only' error if the current buffer is read-only. */)
1938 (void)
1940 if (!NILP (BVAR (current_buffer, read_only))
1941 && NILP (Vinhibit_read_only))
1942 xsignal1 (Qbuffer_read_only, Fcurrent_buffer ());
1943 return Qnil;
1946 DEFUN ("erase-buffer", Ferase_buffer, Serase_buffer, 0, 0, "*",
1947 doc: /* Delete the entire contents of the current buffer.
1948 Any narrowing restriction in effect (see `narrow-to-region') is removed,
1949 so the buffer is truly empty after this. */)
1950 (void)
1952 Fwiden ();
1954 del_range (BEG, Z);
1956 current_buffer->last_window_start = 1;
1957 /* Prevent warnings, or suspension of auto saving, that would happen
1958 if future size is less than past size. Use of erase-buffer
1959 implies that the future text is not really related to the past text. */
1960 XSETFASTINT (BVAR (current_buffer, save_length), 0);
1961 return Qnil;
1964 void
1965 validate_region (register Lisp_Object *b, register Lisp_Object *e)
1967 CHECK_NUMBER_COERCE_MARKER (*b);
1968 CHECK_NUMBER_COERCE_MARKER (*e);
1970 if (XINT (*b) > XINT (*e))
1972 Lisp_Object tem;
1973 tem = *b; *b = *e; *e = tem;
1976 if (!(BEGV <= XINT (*b) && XINT (*b) <= XINT (*e)
1977 && XINT (*e) <= ZV))
1978 args_out_of_range (*b, *e);
1981 /* Advance BYTE_POS up to a character boundary
1982 and return the adjusted position. */
1984 static EMACS_INT
1985 advance_to_char_boundary (EMACS_INT byte_pos)
1987 int c;
1989 if (byte_pos == BEG)
1990 /* Beginning of buffer is always a character boundary. */
1991 return BEG;
1993 c = FETCH_BYTE (byte_pos);
1994 if (! CHAR_HEAD_P (c))
1996 /* We should advance BYTE_POS only when C is a constituent of a
1997 multibyte sequence. */
1998 EMACS_INT orig_byte_pos = byte_pos;
2002 byte_pos--;
2003 c = FETCH_BYTE (byte_pos);
2005 while (! CHAR_HEAD_P (c) && byte_pos > BEG);
2006 INC_POS (byte_pos);
2007 if (byte_pos < orig_byte_pos)
2008 byte_pos = orig_byte_pos;
2009 /* If C is a constituent of a multibyte sequence, BYTE_POS was
2010 surely advance to the correct character boundary. If C is
2011 not, BYTE_POS was unchanged. */
2014 return byte_pos;
2017 #ifdef REL_ALLOC
2018 extern void r_alloc_reset_variable (POINTER_TYPE *, POINTER_TYPE *);
2019 #endif /* REL_ALLOC */
2021 DEFUN ("buffer-swap-text", Fbuffer_swap_text, Sbuffer_swap_text,
2022 1, 1, 0,
2023 doc: /* Swap the text between current buffer and BUFFER. */)
2024 (Lisp_Object buffer)
2026 struct buffer *other_buffer;
2027 CHECK_BUFFER (buffer);
2028 other_buffer = XBUFFER (buffer);
2030 if (NILP (BVAR (other_buffer, name)))
2031 error ("Cannot swap a dead buffer's text");
2033 /* Actually, it probably works just fine.
2034 * if (other_buffer == current_buffer)
2035 * error ("Cannot swap a buffer's text with itself"); */
2037 /* Actually, this may be workable as well, tho probably only if they're
2038 *both* indirect. */
2039 if (other_buffer->base_buffer
2040 || current_buffer->base_buffer)
2041 error ("Cannot swap indirect buffers's text");
2043 { /* This is probably harder to make work. */
2044 struct buffer *other;
2045 for (other = all_buffers; other; other = other->header.next.buffer)
2046 if (other->base_buffer == other_buffer
2047 || other->base_buffer == current_buffer)
2048 error ("One of the buffers to swap has indirect buffers");
2051 #define swapfield(field, type) \
2052 do { \
2053 type tmp##field = other_buffer->field; \
2054 other_buffer->field = current_buffer->field; \
2055 current_buffer->field = tmp##field; \
2056 } while (0)
2057 #define swapfield_(field, type) \
2058 do { \
2059 type tmp##field = BVAR (other_buffer, field); \
2060 BVAR (other_buffer, field) = BVAR (current_buffer, field); \
2061 BVAR (current_buffer, field) = tmp##field; \
2062 } while (0)
2064 swapfield (own_text, struct buffer_text);
2065 eassert (current_buffer->text == &current_buffer->own_text);
2066 eassert (other_buffer->text == &other_buffer->own_text);
2067 #ifdef REL_ALLOC
2068 r_alloc_reset_variable ((POINTER_TYPE **) &current_buffer->own_text.beg,
2069 (POINTER_TYPE **) &other_buffer->own_text.beg);
2070 r_alloc_reset_variable ((POINTER_TYPE **) &other_buffer->own_text.beg,
2071 (POINTER_TYPE **) &current_buffer->own_text.beg);
2072 #endif /* REL_ALLOC */
2074 swapfield (pt, EMACS_INT);
2075 swapfield (pt_byte, EMACS_INT);
2076 swapfield (begv, EMACS_INT);
2077 swapfield (begv_byte, EMACS_INT);
2078 swapfield (zv, EMACS_INT);
2079 swapfield (zv_byte, EMACS_INT);
2080 eassert (!current_buffer->base_buffer);
2081 eassert (!other_buffer->base_buffer);
2082 current_buffer->clip_changed = 1; other_buffer->clip_changed = 1;
2083 swapfield (newline_cache, struct region_cache *);
2084 swapfield (width_run_cache, struct region_cache *);
2085 current_buffer->prevent_redisplay_optimizations_p = 1;
2086 other_buffer->prevent_redisplay_optimizations_p = 1;
2087 swapfield (overlays_before, struct Lisp_Overlay *);
2088 swapfield (overlays_after, struct Lisp_Overlay *);
2089 swapfield (overlay_center, EMACS_INT);
2090 swapfield_ (undo_list, Lisp_Object);
2091 swapfield_ (mark, Lisp_Object);
2092 swapfield_ (enable_multibyte_characters, Lisp_Object);
2093 swapfield_ (bidi_display_reordering, Lisp_Object);
2094 swapfield_ (bidi_paragraph_direction, Lisp_Object);
2095 /* FIXME: Not sure what we should do with these *_marker fields.
2096 Hopefully they're just nil anyway. */
2097 swapfield_ (pt_marker, Lisp_Object);
2098 swapfield_ (begv_marker, Lisp_Object);
2099 swapfield_ (zv_marker, Lisp_Object);
2100 BVAR (current_buffer, point_before_scroll) = Qnil;
2101 BVAR (other_buffer, point_before_scroll) = Qnil;
2103 current_buffer->text->modiff++; other_buffer->text->modiff++;
2104 current_buffer->text->chars_modiff++; other_buffer->text->chars_modiff++;
2105 current_buffer->text->overlay_modiff++; other_buffer->text->overlay_modiff++;
2106 current_buffer->text->beg_unchanged = current_buffer->text->gpt;
2107 current_buffer->text->end_unchanged = current_buffer->text->gpt;
2108 other_buffer->text->beg_unchanged = other_buffer->text->gpt;
2109 other_buffer->text->end_unchanged = other_buffer->text->gpt;
2111 struct Lisp_Marker *m;
2112 for (m = BUF_MARKERS (current_buffer); m; m = m->next)
2113 if (m->buffer == other_buffer)
2114 m->buffer = current_buffer;
2115 else
2116 /* Since there's no indirect buffer in sight, markers on
2117 BUF_MARKERS(buf) should either be for `buf' or dead. */
2118 eassert (!m->buffer);
2119 for (m = BUF_MARKERS (other_buffer); m; m = m->next)
2120 if (m->buffer == current_buffer)
2121 m->buffer = other_buffer;
2122 else
2123 /* Since there's no indirect buffer in sight, markers on
2124 BUF_MARKERS(buf) should either be for `buf' or dead. */
2125 eassert (!m->buffer);
2127 { /* Some of the C code expects that w->buffer == w->pointm->buffer.
2128 So since we just swapped the markers between the two buffers, we need
2129 to undo the effect of this swap for window markers. */
2130 Lisp_Object w = Fselected_window (), ws = Qnil;
2131 Lisp_Object buf1, buf2;
2132 XSETBUFFER (buf1, current_buffer); XSETBUFFER (buf2, other_buffer);
2134 while (NILP (Fmemq (w, ws)))
2136 ws = Fcons (w, ws);
2137 if (MARKERP (XWINDOW (w)->pointm)
2138 && (EQ (XWINDOW (w)->buffer, buf1)
2139 || EQ (XWINDOW (w)->buffer, buf2)))
2140 Fset_marker (XWINDOW (w)->pointm,
2141 make_number (BUF_BEGV (XBUFFER (XWINDOW (w)->buffer))),
2142 XWINDOW (w)->buffer);
2143 w = Fnext_window (w, Qt, Qt);
2147 if (current_buffer->text->intervals)
2148 (eassert (EQ (current_buffer->text->intervals->up.obj, buffer)),
2149 XSETBUFFER (current_buffer->text->intervals->up.obj, current_buffer));
2150 if (other_buffer->text->intervals)
2151 (eassert (EQ (other_buffer->text->intervals->up.obj, Fcurrent_buffer ())),
2152 XSETBUFFER (other_buffer->text->intervals->up.obj, other_buffer));
2154 return Qnil;
2157 DEFUN ("set-buffer-multibyte", Fset_buffer_multibyte, Sset_buffer_multibyte,
2158 1, 1, 0,
2159 doc: /* Set the multibyte flag of the current buffer to FLAG.
2160 If FLAG is t, this makes the buffer a multibyte buffer.
2161 If FLAG is nil, this makes the buffer a single-byte buffer.
2162 In these cases, the buffer contents remain unchanged as a sequence of
2163 bytes but the contents viewed as characters do change.
2164 If FLAG is `to', this makes the buffer a multibyte buffer by changing
2165 all eight-bit bytes to eight-bit characters.
2166 If the multibyte flag was really changed, undo information of the
2167 current buffer is cleared. */)
2168 (Lisp_Object flag)
2170 struct Lisp_Marker *tail, *markers;
2171 struct buffer *other;
2172 EMACS_INT begv, zv;
2173 int narrowed = (BEG != BEGV || Z != ZV);
2174 int modified_p = !NILP (Fbuffer_modified_p (Qnil));
2175 Lisp_Object old_undo = BVAR (current_buffer, undo_list);
2176 struct gcpro gcpro1;
2178 if (current_buffer->base_buffer)
2179 error ("Cannot do `set-buffer-multibyte' on an indirect buffer");
2181 /* Do nothing if nothing actually changes. */
2182 if (NILP (flag) == NILP (BVAR (current_buffer, enable_multibyte_characters)))
2183 return flag;
2185 GCPRO1 (old_undo);
2187 /* Don't record these buffer changes. We will put a special undo entry
2188 instead. */
2189 BVAR (current_buffer, undo_list) = Qt;
2191 /* If the cached position is for this buffer, clear it out. */
2192 clear_charpos_cache (current_buffer);
2194 if (NILP (flag))
2195 begv = BEGV_BYTE, zv = ZV_BYTE;
2196 else
2197 begv = BEGV, zv = ZV;
2199 if (narrowed)
2200 Fwiden ();
2202 if (NILP (flag))
2204 EMACS_INT pos, stop;
2205 unsigned char *p;
2207 /* Do this first, so it can use CHAR_TO_BYTE
2208 to calculate the old correspondences. */
2209 set_intervals_multibyte (0);
2211 BVAR (current_buffer, enable_multibyte_characters) = Qnil;
2213 Z = Z_BYTE;
2214 BEGV = BEGV_BYTE;
2215 ZV = ZV_BYTE;
2216 GPT = GPT_BYTE;
2217 TEMP_SET_PT_BOTH (PT_BYTE, PT_BYTE);
2220 for (tail = BUF_MARKERS (current_buffer); tail; tail = tail->next)
2221 tail->charpos = tail->bytepos;
2223 /* Convert multibyte form of 8-bit characters to unibyte. */
2224 pos = BEG;
2225 stop = GPT;
2226 p = BEG_ADDR;
2227 while (1)
2229 int c, bytes;
2231 if (pos == stop)
2233 if (pos == Z)
2234 break;
2235 p = GAP_END_ADDR;
2236 stop = Z;
2238 if (ASCII_BYTE_P (*p))
2239 p++, pos++;
2240 else if (CHAR_BYTE8_HEAD_P (*p))
2242 c = STRING_CHAR_AND_LENGTH (p, bytes);
2243 /* Delete all bytes for this 8-bit character but the
2244 last one, and change the last one to the character
2245 code. */
2246 bytes--;
2247 del_range_2 (pos, pos, pos + bytes, pos + bytes, 0);
2248 p = GAP_END_ADDR;
2249 *p++ = c;
2250 pos++;
2251 if (begv > pos)
2252 begv -= bytes;
2253 if (zv > pos)
2254 zv -= bytes;
2255 stop = Z;
2257 else
2259 bytes = BYTES_BY_CHAR_HEAD (*p);
2260 p += bytes, pos += bytes;
2263 if (narrowed)
2264 Fnarrow_to_region (make_number (begv), make_number (zv));
2266 else
2268 EMACS_INT pt = PT;
2269 EMACS_INT pos, stop;
2270 unsigned char *p, *pend;
2272 /* Be sure not to have a multibyte sequence striding over the GAP.
2273 Ex: We change this: "...abc\302 _GAP_ \241def..."
2274 to: "...abc _GAP_ \302\241def..." */
2276 if (EQ (flag, Qt)
2277 && GPT_BYTE > 1 && GPT_BYTE < Z_BYTE
2278 && ! CHAR_HEAD_P (*(GAP_END_ADDR)))
2280 unsigned char *q = GPT_ADDR - 1;
2282 while (! CHAR_HEAD_P (*q) && q > BEG_ADDR) q--;
2283 if (LEADING_CODE_P (*q))
2285 EMACS_INT new_gpt = GPT_BYTE - (GPT_ADDR - q);
2287 move_gap_both (new_gpt, new_gpt);
2291 /* Make the buffer contents valid as multibyte by converting
2292 8-bit characters to multibyte form. */
2293 pos = BEG;
2294 stop = GPT;
2295 p = BEG_ADDR;
2296 pend = GPT_ADDR;
2297 while (1)
2299 int bytes;
2301 if (pos == stop)
2303 if (pos == Z)
2304 break;
2305 p = GAP_END_ADDR;
2306 pend = Z_ADDR;
2307 stop = Z;
2310 if (ASCII_BYTE_P (*p))
2311 p++, pos++;
2312 else if (EQ (flag, Qt)
2313 && ! CHAR_BYTE8_HEAD_P (*p)
2314 && (bytes = MULTIBYTE_LENGTH (p, pend)) > 0)
2315 p += bytes, pos += bytes;
2316 else
2318 unsigned char tmp[MAX_MULTIBYTE_LENGTH];
2319 int c;
2321 c = BYTE8_TO_CHAR (*p);
2322 bytes = CHAR_STRING (c, tmp);
2323 *p = tmp[0];
2324 TEMP_SET_PT_BOTH (pos + 1, pos + 1);
2325 bytes--;
2326 insert_1_both ((char *) tmp + 1, bytes, bytes, 1, 0, 0);
2327 /* Now the gap is after the just inserted data. */
2328 pos = GPT;
2329 p = GAP_END_ADDR;
2330 if (pos <= begv)
2331 begv += bytes;
2332 if (pos <= zv)
2333 zv += bytes;
2334 if (pos <= pt)
2335 pt += bytes;
2336 pend = Z_ADDR;
2337 stop = Z;
2341 if (pt != PT)
2342 TEMP_SET_PT (pt);
2344 if (narrowed)
2345 Fnarrow_to_region (make_number (begv), make_number (zv));
2347 /* Do this first, so that chars_in_text asks the right question.
2348 set_intervals_multibyte needs it too. */
2349 BVAR (current_buffer, enable_multibyte_characters) = Qt;
2351 GPT_BYTE = advance_to_char_boundary (GPT_BYTE);
2352 GPT = chars_in_text (BEG_ADDR, GPT_BYTE - BEG_BYTE) + BEG;
2354 Z = chars_in_text (GAP_END_ADDR, Z_BYTE - GPT_BYTE) + GPT;
2356 BEGV_BYTE = advance_to_char_boundary (BEGV_BYTE);
2357 if (BEGV_BYTE > GPT_BYTE)
2358 BEGV = chars_in_text (GAP_END_ADDR, BEGV_BYTE - GPT_BYTE) + GPT;
2359 else
2360 BEGV = chars_in_text (BEG_ADDR, BEGV_BYTE - BEG_BYTE) + BEG;
2362 ZV_BYTE = advance_to_char_boundary (ZV_BYTE);
2363 if (ZV_BYTE > GPT_BYTE)
2364 ZV = chars_in_text (GAP_END_ADDR, ZV_BYTE - GPT_BYTE) + GPT;
2365 else
2366 ZV = chars_in_text (BEG_ADDR, ZV_BYTE - BEG_BYTE) + BEG;
2369 EMACS_INT byte = advance_to_char_boundary (PT_BYTE);
2370 EMACS_INT position;
2372 if (byte > GPT_BYTE)
2373 position = chars_in_text (GAP_END_ADDR, byte - GPT_BYTE) + GPT;
2374 else
2375 position = chars_in_text (BEG_ADDR, byte - BEG_BYTE) + BEG;
2376 TEMP_SET_PT_BOTH (position, byte);
2379 tail = markers = BUF_MARKERS (current_buffer);
2381 /* This prevents BYTE_TO_CHAR (that is, buf_bytepos_to_charpos) from
2382 getting confused by the markers that have not yet been updated.
2383 It is also a signal that it should never create a marker. */
2384 BUF_MARKERS (current_buffer) = NULL;
2386 for (; tail; tail = tail->next)
2388 tail->bytepos = advance_to_char_boundary (tail->bytepos);
2389 tail->charpos = BYTE_TO_CHAR (tail->bytepos);
2392 /* Make sure no markers were put on the chain
2393 while the chain value was incorrect. */
2394 if (BUF_MARKERS (current_buffer))
2395 abort ();
2397 BUF_MARKERS (current_buffer) = markers;
2399 /* Do this last, so it can calculate the new correspondences
2400 between chars and bytes. */
2401 set_intervals_multibyte (1);
2404 if (!EQ (old_undo, Qt))
2406 /* Represent all the above changes by a special undo entry. */
2407 BVAR (current_buffer, undo_list) = Fcons (list3 (Qapply,
2408 intern ("set-buffer-multibyte"),
2409 NILP (flag) ? Qt : Qnil),
2410 old_undo);
2413 UNGCPRO;
2415 /* Changing the multibyteness of a buffer means that all windows
2416 showing that buffer must be updated thoroughly. */
2417 current_buffer->prevent_redisplay_optimizations_p = 1;
2418 ++windows_or_buffers_changed;
2420 /* Copy this buffer's new multibyte status
2421 into all of its indirect buffers. */
2422 for (other = all_buffers; other; other = other->header.next.buffer)
2423 if (other->base_buffer == current_buffer && !NILP (BVAR (other, name)))
2425 BVAR (other, enable_multibyte_characters)
2426 = BVAR (current_buffer, enable_multibyte_characters);
2427 other->prevent_redisplay_optimizations_p = 1;
2430 /* Restore the modifiedness of the buffer. */
2431 if (!modified_p && !NILP (Fbuffer_modified_p (Qnil)))
2432 Fset_buffer_modified_p (Qnil);
2434 /* Update coding systems of this buffer's process (if any). */
2436 Lisp_Object process;
2438 process = Fget_buffer_process (Fcurrent_buffer ());
2439 if (PROCESSP (process))
2440 setup_process_coding_systems (process);
2443 return flag;
2446 DEFUN ("kill-all-local-variables", Fkill_all_local_variables,
2447 Skill_all_local_variables, 0, 0, 0,
2448 doc: /* Switch to Fundamental mode by killing current buffer's local variables.
2449 Most local variable bindings are eliminated so that the default values
2450 become effective once more. Also, the syntax table is set from
2451 `standard-syntax-table', the local keymap is set to nil,
2452 and the abbrev table from `fundamental-mode-abbrev-table'.
2453 This function also forces redisplay of the mode line.
2455 Every function to select a new major mode starts by
2456 calling this function.
2458 As a special exception, local variables whose names have
2459 a non-nil `permanent-local' property are not eliminated by this function.
2461 The first thing this function does is run
2462 the normal hook `change-major-mode-hook'. */)
2463 (void)
2465 Frun_hooks (1, &Qchange_major_mode_hook);
2467 /* Make sure none of the bindings in local_var_alist
2468 remain swapped in, in their symbols. */
2470 swap_out_buffer_local_variables (current_buffer);
2472 /* Actually eliminate all local bindings of this buffer. */
2474 reset_buffer_local_variables (current_buffer, 0);
2476 /* Force mode-line redisplay. Useful here because all major mode
2477 commands call this function. */
2478 update_mode_lines++;
2480 return Qnil;
2483 /* Make sure no local variables remain set up with buffer B
2484 for their current values. */
2486 static void
2487 swap_out_buffer_local_variables (struct buffer *b)
2489 Lisp_Object oalist, alist, buffer;
2491 XSETBUFFER (buffer, b);
2492 oalist = BVAR (b, local_var_alist);
2494 for (alist = oalist; CONSP (alist); alist = XCDR (alist))
2496 Lisp_Object sym = XCAR (XCAR (alist));
2497 eassert (XSYMBOL (sym)->redirect == SYMBOL_LOCALIZED);
2498 /* Need not do anything if some other buffer's binding is
2499 now cached. */
2500 if (EQ (SYMBOL_BLV (XSYMBOL (sym))->where, buffer))
2502 /* Symbol is set up for this buffer's old local value:
2503 swap it out! */
2504 swap_in_global_binding (XSYMBOL (sym));
2509 /* Find all the overlays in the current buffer that contain position POS.
2510 Return the number found, and store them in a vector in *VEC_PTR.
2511 Store in *LEN_PTR the size allocated for the vector.
2512 Store in *NEXT_PTR the next position after POS where an overlay starts,
2513 or ZV if there are no more overlays between POS and ZV.
2514 Store in *PREV_PTR the previous position before POS where an overlay ends,
2515 or where an overlay starts which ends at or after POS;
2516 or BEGV if there are no such overlays from BEGV to POS.
2517 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2519 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2520 when this function is called.
2522 If EXTEND is non-zero, we make the vector bigger if necessary.
2523 If EXTEND is zero, we never extend the vector,
2524 and we store only as many overlays as will fit.
2525 But we still return the total number of overlays.
2527 If CHANGE_REQ is true, then any position written into *PREV_PTR or
2528 *NEXT_PTR is guaranteed to be not equal to POS, unless it is the
2529 default (BEGV or ZV). */
2531 ptrdiff_t
2532 overlays_at (EMACS_INT pos, int extend, Lisp_Object **vec_ptr,
2533 ptrdiff_t *len_ptr,
2534 EMACS_INT *next_ptr, EMACS_INT *prev_ptr, int change_req)
2536 Lisp_Object overlay, start, end;
2537 struct Lisp_Overlay *tail;
2538 ptrdiff_t idx = 0;
2539 ptrdiff_t len = *len_ptr;
2540 Lisp_Object *vec = *vec_ptr;
2541 EMACS_INT next = ZV;
2542 EMACS_INT prev = BEGV;
2543 int inhibit_storing = 0;
2545 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2547 EMACS_INT startpos, endpos;
2549 XSETMISC (overlay, tail);
2551 start = OVERLAY_START (overlay);
2552 end = OVERLAY_END (overlay);
2553 endpos = OVERLAY_POSITION (end);
2554 if (endpos < pos)
2556 if (prev < endpos)
2557 prev = endpos;
2558 break;
2560 startpos = OVERLAY_POSITION (start);
2561 /* This one ends at or after POS
2562 so its start counts for PREV_PTR if it's before POS. */
2563 if (prev < startpos && startpos < pos)
2564 prev = startpos;
2565 if (endpos == pos)
2566 continue;
2567 if (startpos <= pos)
2569 if (idx == len)
2571 /* The supplied vector is full.
2572 Either make it bigger, or don't store any more in it. */
2573 if (extend)
2575 vec = xpalloc (vec, len_ptr, 1, OVERLAY_COUNT_MAX,
2576 sizeof *vec);
2577 *vec_ptr = vec;
2578 len = *len_ptr;
2580 else
2581 inhibit_storing = 1;
2584 if (!inhibit_storing)
2585 vec[idx] = overlay;
2586 /* Keep counting overlays even if we can't return them all. */
2587 idx++;
2589 else if (startpos < next)
2590 next = startpos;
2593 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2595 EMACS_INT startpos, endpos;
2597 XSETMISC (overlay, tail);
2599 start = OVERLAY_START (overlay);
2600 end = OVERLAY_END (overlay);
2601 startpos = OVERLAY_POSITION (start);
2602 if (pos < startpos)
2604 if (startpos < next)
2605 next = startpos;
2606 break;
2608 endpos = OVERLAY_POSITION (end);
2609 if (pos < endpos)
2611 if (idx == len)
2613 if (extend)
2615 vec = xpalloc (vec, len_ptr, 1, OVERLAY_COUNT_MAX,
2616 sizeof *vec);
2617 *vec_ptr = vec;
2618 len = *len_ptr;
2620 else
2621 inhibit_storing = 1;
2624 if (!inhibit_storing)
2625 vec[idx] = overlay;
2626 idx++;
2628 if (startpos < pos && startpos > prev)
2629 prev = startpos;
2631 else if (endpos < pos && endpos > prev)
2632 prev = endpos;
2633 else if (endpos == pos && startpos > prev
2634 && (!change_req || startpos < pos))
2635 prev = startpos;
2638 if (next_ptr)
2639 *next_ptr = next;
2640 if (prev_ptr)
2641 *prev_ptr = prev;
2642 return idx;
2645 /* Find all the overlays in the current buffer that overlap the range
2646 BEG-END, or are empty at BEG, or are empty at END provided END
2647 denotes the position at the end of the current buffer.
2649 Return the number found, and store them in a vector in *VEC_PTR.
2650 Store in *LEN_PTR the size allocated for the vector.
2651 Store in *NEXT_PTR the next position after POS where an overlay starts,
2652 or ZV if there are no more overlays.
2653 Store in *PREV_PTR the previous position before POS where an overlay ends,
2654 or BEGV if there are no previous overlays.
2655 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2657 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2658 when this function is called.
2660 If EXTEND is non-zero, we make the vector bigger if necessary.
2661 If EXTEND is zero, we never extend the vector,
2662 and we store only as many overlays as will fit.
2663 But we still return the total number of overlays. */
2665 static ptrdiff_t
2666 overlays_in (EMACS_INT beg, EMACS_INT end, int extend,
2667 Lisp_Object **vec_ptr, ptrdiff_t *len_ptr,
2668 EMACS_INT *next_ptr, EMACS_INT *prev_ptr)
2670 Lisp_Object overlay, ostart, oend;
2671 struct Lisp_Overlay *tail;
2672 ptrdiff_t idx = 0;
2673 ptrdiff_t len = *len_ptr;
2674 Lisp_Object *vec = *vec_ptr;
2675 EMACS_INT next = ZV;
2676 EMACS_INT prev = BEGV;
2677 int inhibit_storing = 0;
2678 int end_is_Z = end == Z;
2680 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2682 EMACS_INT startpos, endpos;
2684 XSETMISC (overlay, tail);
2686 ostart = OVERLAY_START (overlay);
2687 oend = OVERLAY_END (overlay);
2688 endpos = OVERLAY_POSITION (oend);
2689 if (endpos < beg)
2691 if (prev < endpos)
2692 prev = endpos;
2693 break;
2695 startpos = OVERLAY_POSITION (ostart);
2696 /* Count an interval if it overlaps the range, is empty at the
2697 start of the range, or is empty at END provided END denotes the
2698 end of the buffer. */
2699 if ((beg < endpos && startpos < end)
2700 || (startpos == endpos
2701 && (beg == endpos || (end_is_Z && endpos == end))))
2703 if (idx == len)
2705 /* The supplied vector is full.
2706 Either make it bigger, or don't store any more in it. */
2707 if (extend)
2709 vec = xpalloc (vec, len_ptr, 1, OVERLAY_COUNT_MAX,
2710 sizeof *vec);
2711 *vec_ptr = vec;
2712 len = *len_ptr;
2714 else
2715 inhibit_storing = 1;
2718 if (!inhibit_storing)
2719 vec[idx] = overlay;
2720 /* Keep counting overlays even if we can't return them all. */
2721 idx++;
2723 else if (startpos < next)
2724 next = startpos;
2727 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2729 EMACS_INT startpos, endpos;
2731 XSETMISC (overlay, tail);
2733 ostart = OVERLAY_START (overlay);
2734 oend = OVERLAY_END (overlay);
2735 startpos = OVERLAY_POSITION (ostart);
2736 if (end < startpos)
2738 if (startpos < next)
2739 next = startpos;
2740 break;
2742 endpos = OVERLAY_POSITION (oend);
2743 /* Count an interval if it overlaps the range, is empty at the
2744 start of the range, or is empty at END provided END denotes the
2745 end of the buffer. */
2746 if ((beg < endpos && startpos < end)
2747 || (startpos == endpos
2748 && (beg == endpos || (end_is_Z && endpos == end))))
2750 if (idx == len)
2752 if (extend)
2754 vec = xpalloc (vec, len_ptr, 1, OVERLAY_COUNT_MAX,
2755 sizeof *vec);
2756 *vec_ptr = vec;
2757 len = *len_ptr;
2759 else
2760 inhibit_storing = 1;
2763 if (!inhibit_storing)
2764 vec[idx] = overlay;
2765 idx++;
2767 else if (endpos < beg && endpos > prev)
2768 prev = endpos;
2771 if (next_ptr)
2772 *next_ptr = next;
2773 if (prev_ptr)
2774 *prev_ptr = prev;
2775 return idx;
2779 /* Return non-zero if there exists an overlay with a non-nil
2780 `mouse-face' property overlapping OVERLAY. */
2783 mouse_face_overlay_overlaps (Lisp_Object overlay)
2785 EMACS_INT start = OVERLAY_POSITION (OVERLAY_START (overlay));
2786 EMACS_INT end = OVERLAY_POSITION (OVERLAY_END (overlay));
2787 ptrdiff_t n, i, size;
2788 Lisp_Object *v, tem;
2790 size = 10;
2791 v = (Lisp_Object *) alloca (size * sizeof *v);
2792 n = overlays_in (start, end, 0, &v, &size, NULL, NULL);
2793 if (n > size)
2795 v = (Lisp_Object *) alloca (n * sizeof *v);
2796 overlays_in (start, end, 0, &v, &n, NULL, NULL);
2799 for (i = 0; i < n; ++i)
2800 if (!EQ (v[i], overlay)
2801 && (tem = Foverlay_get (overlay, Qmouse_face),
2802 !NILP (tem)))
2803 break;
2805 return i < n;
2810 /* Fast function to just test if we're at an overlay boundary. */
2812 overlay_touches_p (EMACS_INT pos)
2814 Lisp_Object overlay;
2815 struct Lisp_Overlay *tail;
2817 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2819 EMACS_INT endpos;
2821 XSETMISC (overlay ,tail);
2822 if (!OVERLAYP (overlay))
2823 abort ();
2825 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2826 if (endpos < pos)
2827 break;
2828 if (endpos == pos || OVERLAY_POSITION (OVERLAY_START (overlay)) == pos)
2829 return 1;
2832 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2834 EMACS_INT startpos;
2836 XSETMISC (overlay, tail);
2837 if (!OVERLAYP (overlay))
2838 abort ();
2840 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2841 if (pos < startpos)
2842 break;
2843 if (startpos == pos || OVERLAY_POSITION (OVERLAY_END (overlay)) == pos)
2844 return 1;
2846 return 0;
2849 struct sortvec
2851 Lisp_Object overlay;
2852 EMACS_INT beg, end;
2853 EMACS_INT priority;
2856 static int
2857 compare_overlays (const void *v1, const void *v2)
2859 const struct sortvec *s1 = (const struct sortvec *) v1;
2860 const struct sortvec *s2 = (const struct sortvec *) v2;
2861 if (s1->priority != s2->priority)
2862 return s1->priority < s2->priority ? -1 : 1;
2863 if (s1->beg != s2->beg)
2864 return s1->beg < s2->beg ? -1 : 1;
2865 if (s1->end != s2->end)
2866 return s2->end < s1->end ? -1 : 1;
2867 /* Avoid the non-determinism of qsort by choosing an arbitrary ordering
2868 between "equal" overlays. The result can still change between
2869 invocations of Emacs, but it won't change in the middle of
2870 `find_field' (bug#6830). */
2871 return XHASH (s1->overlay) < XHASH (s2->overlay) ? -1 : 1;
2874 /* Sort an array of overlays by priority. The array is modified in place.
2875 The return value is the new size; this may be smaller than the original
2876 size if some of the overlays were invalid or were window-specific. */
2877 ptrdiff_t
2878 sort_overlays (Lisp_Object *overlay_vec, ptrdiff_t noverlays, struct window *w)
2880 ptrdiff_t i, j;
2881 struct sortvec *sortvec;
2882 sortvec = (struct sortvec *) alloca (noverlays * sizeof (struct sortvec));
2884 /* Put the valid and relevant overlays into sortvec. */
2886 for (i = 0, j = 0; i < noverlays; i++)
2888 Lisp_Object tem;
2889 Lisp_Object overlay;
2891 overlay = overlay_vec[i];
2892 if (OVERLAY_VALID (overlay)
2893 && OVERLAY_POSITION (OVERLAY_START (overlay)) > 0
2894 && OVERLAY_POSITION (OVERLAY_END (overlay)) > 0)
2896 /* If we're interested in a specific window, then ignore
2897 overlays that are limited to some other window. */
2898 if (w)
2900 Lisp_Object window;
2902 window = Foverlay_get (overlay, Qwindow);
2903 if (WINDOWP (window) && XWINDOW (window) != w)
2904 continue;
2907 /* This overlay is good and counts: put it into sortvec. */
2908 sortvec[j].overlay = overlay;
2909 sortvec[j].beg = OVERLAY_POSITION (OVERLAY_START (overlay));
2910 sortvec[j].end = OVERLAY_POSITION (OVERLAY_END (overlay));
2911 tem = Foverlay_get (overlay, Qpriority);
2912 if (INTEGERP (tem))
2913 sortvec[j].priority = XINT (tem);
2914 else
2915 sortvec[j].priority = 0;
2916 j++;
2919 noverlays = j;
2921 /* Sort the overlays into the proper order: increasing priority. */
2923 if (noverlays > 1)
2924 qsort (sortvec, noverlays, sizeof (struct sortvec), compare_overlays);
2926 for (i = 0; i < noverlays; i++)
2927 overlay_vec[i] = sortvec[i].overlay;
2928 return (noverlays);
2931 struct sortstr
2933 Lisp_Object string, string2;
2934 ptrdiff_t size;
2935 EMACS_INT priority;
2938 struct sortstrlist
2940 struct sortstr *buf; /* An array that expands as needed; never freed. */
2941 ptrdiff_t size; /* Allocated length of that array. */
2942 ptrdiff_t used; /* How much of the array is currently in use. */
2943 ptrdiff_t bytes; /* Total length of the strings in buf. */
2946 /* Buffers for storing information about the overlays touching a given
2947 position. These could be automatic variables in overlay_strings, but
2948 it's more efficient to hold onto the memory instead of repeatedly
2949 allocating and freeing it. */
2950 static struct sortstrlist overlay_heads, overlay_tails;
2951 static unsigned char *overlay_str_buf;
2953 /* Allocated length of overlay_str_buf. */
2954 static ptrdiff_t overlay_str_len;
2956 /* A comparison function suitable for passing to qsort. */
2957 static int
2958 cmp_for_strings (const void *as1, const void *as2)
2960 struct sortstr *s1 = (struct sortstr *)as1;
2961 struct sortstr *s2 = (struct sortstr *)as2;
2962 if (s1->size != s2->size)
2963 return s2->size < s1->size ? -1 : 1;
2964 if (s1->priority != s2->priority)
2965 return s1->priority < s2->priority ? -1 : 1;
2966 return 0;
2969 static void
2970 record_overlay_string (struct sortstrlist *ssl, Lisp_Object str,
2971 Lisp_Object str2, Lisp_Object pri, ptrdiff_t size)
2973 EMACS_INT nbytes;
2975 if (ssl->used == ssl->size)
2976 ssl->buf = xpalloc (ssl->buf, &ssl->size, 5, -1, sizeof *ssl->buf);
2977 ssl->buf[ssl->used].string = str;
2978 ssl->buf[ssl->used].string2 = str2;
2979 ssl->buf[ssl->used].size = size;
2980 ssl->buf[ssl->used].priority = (INTEGERP (pri) ? XINT (pri) : 0);
2981 ssl->used++;
2983 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
2984 nbytes = SCHARS (str);
2985 else if (! STRING_MULTIBYTE (str))
2986 nbytes = count_size_as_multibyte (SDATA (str),
2987 SBYTES (str));
2988 else
2989 nbytes = SBYTES (str);
2991 if (INT_ADD_OVERFLOW (ssl->bytes, nbytes))
2992 memory_full (SIZE_MAX);
2993 ssl->bytes += nbytes;
2995 if (STRINGP (str2))
2997 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
2998 nbytes = SCHARS (str2);
2999 else if (! STRING_MULTIBYTE (str2))
3000 nbytes = count_size_as_multibyte (SDATA (str2),
3001 SBYTES (str2));
3002 else
3003 nbytes = SBYTES (str2);
3005 if (INT_ADD_OVERFLOW (ssl->bytes, nbytes))
3006 memory_full (SIZE_MAX);
3007 ssl->bytes += nbytes;
3011 /* Return the concatenation of the strings associated with overlays that
3012 begin or end at POS, ignoring overlays that are specific to a window
3013 other than W. The strings are concatenated in the appropriate order:
3014 shorter overlays nest inside longer ones, and higher priority inside
3015 lower. Normally all of the after-strings come first, but zero-sized
3016 overlays have their after-strings ride along with the before-strings
3017 because it would look strange to print them inside-out.
3019 Returns the string length, and stores the contents indirectly through
3020 PSTR, if that variable is non-null. The string may be overwritten by
3021 subsequent calls. */
3023 EMACS_INT
3024 overlay_strings (EMACS_INT pos, struct window *w, unsigned char **pstr)
3026 Lisp_Object overlay, window, str;
3027 struct Lisp_Overlay *ov;
3028 EMACS_INT startpos, endpos;
3029 int multibyte = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
3031 overlay_heads.used = overlay_heads.bytes = 0;
3032 overlay_tails.used = overlay_tails.bytes = 0;
3033 for (ov = current_buffer->overlays_before; ov; ov = ov->next)
3035 XSETMISC (overlay, ov);
3036 eassert (OVERLAYP (overlay));
3038 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3039 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3040 if (endpos < pos)
3041 break;
3042 if (endpos != pos && startpos != pos)
3043 continue;
3044 window = Foverlay_get (overlay, Qwindow);
3045 if (WINDOWP (window) && XWINDOW (window) != w)
3046 continue;
3047 if (startpos == pos
3048 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3049 record_overlay_string (&overlay_heads, str,
3050 (startpos == endpos
3051 ? Foverlay_get (overlay, Qafter_string)
3052 : Qnil),
3053 Foverlay_get (overlay, Qpriority),
3054 endpos - startpos);
3055 else if (endpos == pos
3056 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3057 record_overlay_string (&overlay_tails, str, Qnil,
3058 Foverlay_get (overlay, Qpriority),
3059 endpos - startpos);
3061 for (ov = current_buffer->overlays_after; ov; ov = ov->next)
3063 XSETMISC (overlay, ov);
3064 eassert (OVERLAYP (overlay));
3066 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3067 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3068 if (startpos > pos)
3069 break;
3070 if (endpos != pos && startpos != pos)
3071 continue;
3072 window = Foverlay_get (overlay, Qwindow);
3073 if (WINDOWP (window) && XWINDOW (window) != w)
3074 continue;
3075 if (startpos == pos
3076 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3077 record_overlay_string (&overlay_heads, str,
3078 (startpos == endpos
3079 ? Foverlay_get (overlay, Qafter_string)
3080 : Qnil),
3081 Foverlay_get (overlay, Qpriority),
3082 endpos - startpos);
3083 else if (endpos == pos
3084 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3085 record_overlay_string (&overlay_tails, str, Qnil,
3086 Foverlay_get (overlay, Qpriority),
3087 endpos - startpos);
3089 if (overlay_tails.used > 1)
3090 qsort (overlay_tails.buf, overlay_tails.used, sizeof (struct sortstr),
3091 cmp_for_strings);
3092 if (overlay_heads.used > 1)
3093 qsort (overlay_heads.buf, overlay_heads.used, sizeof (struct sortstr),
3094 cmp_for_strings);
3095 if (overlay_heads.bytes || overlay_tails.bytes)
3097 Lisp_Object tem;
3098 EMACS_INT i;
3099 unsigned char *p;
3100 ptrdiff_t total;
3102 if (INT_ADD_OVERFLOW (overlay_heads.bytes, overlay_tails.bytes))
3103 memory_full (SIZE_MAX);
3104 total = overlay_heads.bytes + overlay_tails.bytes;
3105 if (total > overlay_str_len)
3106 overlay_str_buf = xpalloc (overlay_str_buf, &overlay_str_len,
3107 total - overlay_str_len, -1, 1);
3109 p = overlay_str_buf;
3110 for (i = overlay_tails.used; --i >= 0;)
3112 EMACS_INT nbytes;
3113 tem = overlay_tails.buf[i].string;
3114 nbytes = copy_text (SDATA (tem), p,
3115 SBYTES (tem),
3116 STRING_MULTIBYTE (tem), multibyte);
3117 p += nbytes;
3119 for (i = 0; i < overlay_heads.used; ++i)
3121 EMACS_INT nbytes;
3122 tem = overlay_heads.buf[i].string;
3123 nbytes = copy_text (SDATA (tem), p,
3124 SBYTES (tem),
3125 STRING_MULTIBYTE (tem), multibyte);
3126 p += nbytes;
3127 tem = overlay_heads.buf[i].string2;
3128 if (STRINGP (tem))
3130 nbytes = copy_text (SDATA (tem), p,
3131 SBYTES (tem),
3132 STRING_MULTIBYTE (tem), multibyte);
3133 p += nbytes;
3136 if (p != overlay_str_buf + total)
3137 abort ();
3138 if (pstr)
3139 *pstr = overlay_str_buf;
3140 return total;
3142 return 0;
3145 /* Shift overlays in BUF's overlay lists, to center the lists at POS. */
3147 void
3148 recenter_overlay_lists (struct buffer *buf, EMACS_INT pos)
3150 Lisp_Object overlay, beg, end;
3151 struct Lisp_Overlay *prev, *tail, *next;
3153 /* See if anything in overlays_before should move to overlays_after. */
3155 /* We don't strictly need prev in this loop; it should always be nil.
3156 But we use it for symmetry and in case that should cease to be true
3157 with some future change. */
3158 prev = NULL;
3159 for (tail = buf->overlays_before; tail; prev = tail, tail = next)
3161 next = tail->next;
3162 XSETMISC (overlay, tail);
3164 /* If the overlay is not valid, get rid of it. */
3165 if (!OVERLAY_VALID (overlay))
3166 #if 1
3167 abort ();
3168 #else
3170 /* Splice the cons cell TAIL out of overlays_before. */
3171 if (!NILP (prev))
3172 XCDR (prev) = next;
3173 else
3174 buf->overlays_before = next;
3175 tail = prev;
3176 continue;
3178 #endif
3180 beg = OVERLAY_START (overlay);
3181 end = OVERLAY_END (overlay);
3183 if (OVERLAY_POSITION (end) > pos)
3185 /* OVERLAY needs to be moved. */
3186 EMACS_INT where = OVERLAY_POSITION (beg);
3187 struct Lisp_Overlay *other, *other_prev;
3189 /* Splice the cons cell TAIL out of overlays_before. */
3190 if (prev)
3191 prev->next = next;
3192 else
3193 buf->overlays_before = next;
3195 /* Search thru overlays_after for where to put it. */
3196 other_prev = NULL;
3197 for (other = buf->overlays_after; other;
3198 other_prev = other, other = other->next)
3200 Lisp_Object otherbeg, otheroverlay;
3202 XSETMISC (otheroverlay, other);
3203 eassert (OVERLAY_VALID (otheroverlay));
3205 otherbeg = OVERLAY_START (otheroverlay);
3206 if (OVERLAY_POSITION (otherbeg) >= where)
3207 break;
3210 /* Add TAIL to overlays_after before OTHER. */
3211 tail->next = other;
3212 if (other_prev)
3213 other_prev->next = tail;
3214 else
3215 buf->overlays_after = tail;
3216 tail = prev;
3218 else
3219 /* We've reached the things that should stay in overlays_before.
3220 All the rest of overlays_before must end even earlier,
3221 so stop now. */
3222 break;
3225 /* See if anything in overlays_after should be in overlays_before. */
3226 prev = NULL;
3227 for (tail = buf->overlays_after; tail; prev = tail, tail = next)
3229 next = tail->next;
3230 XSETMISC (overlay, tail);
3232 /* If the overlay is not valid, get rid of it. */
3233 if (!OVERLAY_VALID (overlay))
3234 #if 1
3235 abort ();
3236 #else
3238 /* Splice the cons cell TAIL out of overlays_after. */
3239 if (!NILP (prev))
3240 XCDR (prev) = next;
3241 else
3242 buf->overlays_after = next;
3243 tail = prev;
3244 continue;
3246 #endif
3248 beg = OVERLAY_START (overlay);
3249 end = OVERLAY_END (overlay);
3251 /* Stop looking, when we know that nothing further
3252 can possibly end before POS. */
3253 if (OVERLAY_POSITION (beg) > pos)
3254 break;
3256 if (OVERLAY_POSITION (end) <= pos)
3258 /* OVERLAY needs to be moved. */
3259 EMACS_INT where = OVERLAY_POSITION (end);
3260 struct Lisp_Overlay *other, *other_prev;
3262 /* Splice the cons cell TAIL out of overlays_after. */
3263 if (prev)
3264 prev->next = next;
3265 else
3266 buf->overlays_after = next;
3268 /* Search thru overlays_before for where to put it. */
3269 other_prev = NULL;
3270 for (other = buf->overlays_before; other;
3271 other_prev = other, other = other->next)
3273 Lisp_Object otherend, otheroverlay;
3275 XSETMISC (otheroverlay, other);
3276 eassert (OVERLAY_VALID (otheroverlay));
3278 otherend = OVERLAY_END (otheroverlay);
3279 if (OVERLAY_POSITION (otherend) <= where)
3280 break;
3283 /* Add TAIL to overlays_before before OTHER. */
3284 tail->next = other;
3285 if (other_prev)
3286 other_prev->next = tail;
3287 else
3288 buf->overlays_before = tail;
3289 tail = prev;
3293 buf->overlay_center = pos;
3296 void
3297 adjust_overlays_for_insert (EMACS_INT pos, EMACS_INT length)
3299 /* After an insertion, the lists are still sorted properly,
3300 but we may need to update the value of the overlay center. */
3301 if (current_buffer->overlay_center >= pos)
3302 current_buffer->overlay_center += length;
3305 void
3306 adjust_overlays_for_delete (EMACS_INT pos, EMACS_INT length)
3308 if (current_buffer->overlay_center < pos)
3309 /* The deletion was to our right. No change needed; the before- and
3310 after-lists are still consistent. */
3312 else if (current_buffer->overlay_center > pos + length)
3313 /* The deletion was to our left. We need to adjust the center value
3314 to account for the change in position, but the lists are consistent
3315 given the new value. */
3316 current_buffer->overlay_center -= length;
3317 else
3318 /* We're right in the middle. There might be things on the after-list
3319 that now belong on the before-list. Recentering will move them,
3320 and also update the center point. */
3321 recenter_overlay_lists (current_buffer, pos);
3324 /* Fix up overlays that were garbled as a result of permuting markers
3325 in the range START through END. Any overlay with at least one
3326 endpoint in this range will need to be unlinked from the overlay
3327 list and reinserted in its proper place.
3328 Such an overlay might even have negative size at this point.
3329 If so, we'll make the overlay empty. */
3330 void
3331 fix_start_end_in_overlays (register EMACS_INT start, register EMACS_INT end)
3333 Lisp_Object overlay;
3334 struct Lisp_Overlay *before_list IF_LINT (= NULL);
3335 struct Lisp_Overlay *after_list IF_LINT (= NULL);
3336 /* These are either nil, indicating that before_list or after_list
3337 should be assigned, or the cons cell the cdr of which should be
3338 assigned. */
3339 struct Lisp_Overlay *beforep = NULL, *afterp = NULL;
3340 /* 'Parent', likewise, indicates a cons cell or
3341 current_buffer->overlays_before or overlays_after, depending
3342 which loop we're in. */
3343 struct Lisp_Overlay *tail, *parent;
3344 EMACS_INT startpos, endpos;
3346 /* This algorithm shifts links around instead of consing and GCing.
3347 The loop invariant is that before_list (resp. after_list) is a
3348 well-formed list except that its last element, the CDR of beforep
3349 (resp. afterp) if beforep (afterp) isn't nil or before_list
3350 (after_list) if it is, is still uninitialized. So it's not a bug
3351 that before_list isn't initialized, although it may look
3352 strange. */
3353 for (parent = NULL, tail = current_buffer->overlays_before; tail;)
3355 XSETMISC (overlay, tail);
3357 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3358 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3360 /* If the overlay is backwards, make it empty. */
3361 if (endpos < startpos)
3363 startpos = endpos;
3364 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3365 Qnil);
3368 if (endpos < start)
3369 break;
3371 if (endpos < end
3372 || (startpos >= start && startpos < end))
3374 /* Add it to the end of the wrong list. Later on,
3375 recenter_overlay_lists will move it to the right place. */
3376 if (endpos < current_buffer->overlay_center)
3378 if (!afterp)
3379 after_list = tail;
3380 else
3381 afterp->next = tail;
3382 afterp = tail;
3384 else
3386 if (!beforep)
3387 before_list = tail;
3388 else
3389 beforep->next = tail;
3390 beforep = tail;
3392 if (!parent)
3393 current_buffer->overlays_before = tail->next;
3394 else
3395 parent->next = tail->next;
3396 tail = tail->next;
3398 else
3399 parent = tail, tail = parent->next;
3401 for (parent = NULL, tail = current_buffer->overlays_after; tail;)
3403 XSETMISC (overlay, tail);
3405 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3406 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3408 /* If the overlay is backwards, make it empty. */
3409 if (endpos < startpos)
3411 startpos = endpos;
3412 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3413 Qnil);
3416 if (startpos >= end)
3417 break;
3419 if (startpos >= start
3420 || (endpos >= start && endpos < end))
3422 if (endpos < current_buffer->overlay_center)
3424 if (!afterp)
3425 after_list = tail;
3426 else
3427 afterp->next = tail;
3428 afterp = tail;
3430 else
3432 if (!beforep)
3433 before_list = tail;
3434 else
3435 beforep->next = tail;
3436 beforep = tail;
3438 if (!parent)
3439 current_buffer->overlays_after = tail->next;
3440 else
3441 parent->next = tail->next;
3442 tail = tail->next;
3444 else
3445 parent = tail, tail = parent->next;
3448 /* Splice the constructed (wrong) lists into the buffer's lists,
3449 and let the recenter function make it sane again. */
3450 if (beforep)
3452 beforep->next = current_buffer->overlays_before;
3453 current_buffer->overlays_before = before_list;
3455 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3457 if (afterp)
3459 afterp->next = current_buffer->overlays_after;
3460 current_buffer->overlays_after = after_list;
3462 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3465 /* We have two types of overlay: the one whose ending marker is
3466 after-insertion-marker (this is the usual case) and the one whose
3467 ending marker is before-insertion-marker. When `overlays_before'
3468 contains overlays of the latter type and the former type in this
3469 order and both overlays end at inserting position, inserting a text
3470 increases only the ending marker of the latter type, which results
3471 in incorrect ordering of `overlays_before'.
3473 This function fixes ordering of overlays in the slot
3474 `overlays_before' of the buffer *BP. Before the insertion, `point'
3475 was at PREV, and now is at POS. */
3477 void
3478 fix_overlays_before (struct buffer *bp, EMACS_INT prev, EMACS_INT pos)
3480 /* If parent is nil, replace overlays_before; otherwise, parent->next. */
3481 struct Lisp_Overlay *tail = bp->overlays_before, *parent = NULL, *right_pair;
3482 Lisp_Object tem;
3483 EMACS_INT end IF_LINT (= 0);
3485 /* After the insertion, the several overlays may be in incorrect
3486 order. The possibility is that, in the list `overlays_before',
3487 an overlay which ends at POS appears after an overlay which ends
3488 at PREV. Since POS is greater than PREV, we must fix the
3489 ordering of these overlays, by moving overlays ends at POS before
3490 the overlays ends at PREV. */
3492 /* At first, find a place where disordered overlays should be linked
3493 in. It is where an overlay which end before POS exists. (i.e. an
3494 overlay whose ending marker is after-insertion-marker if disorder
3495 exists). */
3496 while (tail
3497 && (XSETMISC (tem, tail),
3498 (end = OVERLAY_POSITION (OVERLAY_END (tem))) >= pos))
3500 parent = tail;
3501 tail = tail->next;
3504 /* If we don't find such an overlay,
3505 or the found one ends before PREV,
3506 or the found one is the last one in the list,
3507 we don't have to fix anything. */
3508 if (!tail || end < prev || !tail->next)
3509 return;
3511 right_pair = parent;
3512 parent = tail;
3513 tail = tail->next;
3515 /* Now, end position of overlays in the list TAIL should be before
3516 or equal to PREV. In the loop, an overlay which ends at POS is
3517 moved ahead to the place indicated by the CDR of RIGHT_PAIR. If
3518 we found an overlay which ends before PREV, the remaining
3519 overlays are in correct order. */
3520 while (tail)
3522 XSETMISC (tem, tail);
3523 end = OVERLAY_POSITION (OVERLAY_END (tem));
3525 if (end == pos)
3526 { /* This overlay is disordered. */
3527 struct Lisp_Overlay *found = tail;
3529 /* Unlink the found overlay. */
3530 tail = found->next;
3531 parent->next = tail;
3532 /* Move an overlay at RIGHT_PLACE to the next of the found one,
3533 and link it into the right place. */
3534 if (!right_pair)
3536 found->next = bp->overlays_before;
3537 bp->overlays_before = found;
3539 else
3541 found->next = right_pair->next;
3542 right_pair->next = found;
3545 else if (end == prev)
3547 parent = tail;
3548 tail = tail->next;
3550 else /* No more disordered overlay. */
3551 break;
3555 DEFUN ("overlayp", Foverlayp, Soverlayp, 1, 1, 0,
3556 doc: /* Return t if OBJECT is an overlay. */)
3557 (Lisp_Object object)
3559 return (OVERLAYP (object) ? Qt : Qnil);
3562 DEFUN ("make-overlay", Fmake_overlay, Smake_overlay, 2, 5, 0,
3563 doc: /* Create a new overlay with range BEG to END in BUFFER.
3564 If omitted, BUFFER defaults to the current buffer.
3565 BEG and END may be integers or markers.
3566 The fourth arg FRONT-ADVANCE, if non-nil, makes the marker
3567 for the front of the overlay advance when text is inserted there
3568 \(which means the text *is not* included in the overlay).
3569 The fifth arg REAR-ADVANCE, if non-nil, makes the marker
3570 for the rear of the overlay advance when text is inserted there
3571 \(which means the text *is* included in the overlay). */)
3572 (Lisp_Object beg, Lisp_Object end, Lisp_Object buffer, Lisp_Object front_advance, Lisp_Object rear_advance)
3574 Lisp_Object overlay;
3575 struct buffer *b;
3577 if (NILP (buffer))
3578 XSETBUFFER (buffer, current_buffer);
3579 else
3580 CHECK_BUFFER (buffer);
3581 if (MARKERP (beg)
3582 && ! EQ (Fmarker_buffer (beg), buffer))
3583 error ("Marker points into wrong buffer");
3584 if (MARKERP (end)
3585 && ! EQ (Fmarker_buffer (end), buffer))
3586 error ("Marker points into wrong buffer");
3588 CHECK_NUMBER_COERCE_MARKER (beg);
3589 CHECK_NUMBER_COERCE_MARKER (end);
3591 if (XINT (beg) > XINT (end))
3593 Lisp_Object temp;
3594 temp = beg; beg = end; end = temp;
3597 b = XBUFFER (buffer);
3599 beg = Fset_marker (Fmake_marker (), beg, buffer);
3600 end = Fset_marker (Fmake_marker (), end, buffer);
3602 if (!NILP (front_advance))
3603 XMARKER (beg)->insertion_type = 1;
3604 if (!NILP (rear_advance))
3605 XMARKER (end)->insertion_type = 1;
3607 overlay = allocate_misc ();
3608 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
3609 XOVERLAY (overlay)->start = beg;
3610 XOVERLAY (overlay)->end = end;
3611 XOVERLAY (overlay)->plist = Qnil;
3612 XOVERLAY (overlay)->next = NULL;
3614 /* Put the new overlay on the wrong list. */
3615 end = OVERLAY_END (overlay);
3616 if (OVERLAY_POSITION (end) < b->overlay_center)
3618 if (b->overlays_after)
3619 XOVERLAY (overlay)->next = b->overlays_after;
3620 b->overlays_after = XOVERLAY (overlay);
3622 else
3624 if (b->overlays_before)
3625 XOVERLAY (overlay)->next = b->overlays_before;
3626 b->overlays_before = XOVERLAY (overlay);
3629 /* This puts it in the right list, and in the right order. */
3630 recenter_overlay_lists (b, b->overlay_center);
3632 /* We don't need to redisplay the region covered by the overlay, because
3633 the overlay has no properties at the moment. */
3635 return overlay;
3638 /* Mark a section of BUF as needing redisplay because of overlays changes. */
3640 static void
3641 modify_overlay (struct buffer *buf, EMACS_INT start, EMACS_INT end)
3643 if (start > end)
3645 EMACS_INT temp = start;
3646 start = end;
3647 end = temp;
3650 BUF_COMPUTE_UNCHANGED (buf, start, end);
3652 /* If this is a buffer not in the selected window,
3653 we must do other windows. */
3654 if (buf != XBUFFER (XWINDOW (selected_window)->buffer))
3655 windows_or_buffers_changed = 1;
3656 /* If multiple windows show this buffer, we must do other windows. */
3657 else if (buffer_shared > 1)
3658 windows_or_buffers_changed = 1;
3659 /* If we modify an overlay at the end of the buffer, we cannot
3660 be sure that window end is still valid. */
3661 else if (end >= ZV && start <= ZV)
3662 windows_or_buffers_changed = 1;
3664 ++BUF_OVERLAY_MODIFF (buf);
3668 static struct Lisp_Overlay *
3669 unchain_overlay (struct Lisp_Overlay *list, struct Lisp_Overlay *overlay)
3671 struct Lisp_Overlay *tmp, *prev;
3672 for (tmp = list, prev = NULL; tmp; prev = tmp, tmp = tmp->next)
3673 if (tmp == overlay)
3675 if (prev)
3676 prev->next = tmp->next;
3677 else
3678 list = tmp->next;
3679 overlay->next = NULL;
3680 break;
3682 return list;
3685 DEFUN ("move-overlay", Fmove_overlay, Smove_overlay, 3, 4, 0,
3686 doc: /* Set the endpoints of OVERLAY to BEG and END in BUFFER.
3687 If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.
3688 If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current
3689 buffer. */)
3690 (Lisp_Object overlay, Lisp_Object beg, Lisp_Object end, Lisp_Object buffer)
3692 struct buffer *b, *ob;
3693 Lisp_Object obuffer;
3694 int count = SPECPDL_INDEX ();
3696 CHECK_OVERLAY (overlay);
3697 if (NILP (buffer))
3698 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3699 if (NILP (buffer))
3700 XSETBUFFER (buffer, current_buffer);
3701 CHECK_BUFFER (buffer);
3703 if (MARKERP (beg)
3704 && ! EQ (Fmarker_buffer (beg), buffer))
3705 error ("Marker points into wrong buffer");
3706 if (MARKERP (end)
3707 && ! EQ (Fmarker_buffer (end), buffer))
3708 error ("Marker points into wrong buffer");
3710 CHECK_NUMBER_COERCE_MARKER (beg);
3711 CHECK_NUMBER_COERCE_MARKER (end);
3713 if (XINT (beg) == XINT (end) && ! NILP (Foverlay_get (overlay, Qevaporate)))
3714 return Fdelete_overlay (overlay);
3716 if (XINT (beg) > XINT (end))
3718 Lisp_Object temp;
3719 temp = beg; beg = end; end = temp;
3722 specbind (Qinhibit_quit, Qt);
3724 obuffer = Fmarker_buffer (OVERLAY_START (overlay));
3725 b = XBUFFER (buffer);
3726 ob = BUFFERP (obuffer) ? XBUFFER (obuffer) : (struct buffer *) 0;
3728 /* If the overlay has changed buffers, do a thorough redisplay. */
3729 if (!EQ (buffer, obuffer))
3731 /* Redisplay where the overlay was. */
3732 if (!NILP (obuffer))
3734 EMACS_INT o_beg;
3735 EMACS_INT o_end;
3737 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3738 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3740 modify_overlay (ob, o_beg, o_end);
3743 /* Redisplay where the overlay is going to be. */
3744 modify_overlay (b, XINT (beg), XINT (end));
3746 else
3747 /* Redisplay the area the overlay has just left, or just enclosed. */
3749 EMACS_INT o_beg, o_end;
3751 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3752 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3754 if (o_beg == XINT (beg))
3755 modify_overlay (b, o_end, XINT (end));
3756 else if (o_end == XINT (end))
3757 modify_overlay (b, o_beg, XINT (beg));
3758 else
3760 if (XINT (beg) < o_beg) o_beg = XINT (beg);
3761 if (XINT (end) > o_end) o_end = XINT (end);
3762 modify_overlay (b, o_beg, o_end);
3766 if (!NILP (obuffer))
3768 ob->overlays_before
3769 = unchain_overlay (ob->overlays_before, XOVERLAY (overlay));
3770 ob->overlays_after
3771 = unchain_overlay (ob->overlays_after, XOVERLAY (overlay));
3772 eassert (XOVERLAY (overlay)->next == NULL);
3775 Fset_marker (OVERLAY_START (overlay), beg, buffer);
3776 Fset_marker (OVERLAY_END (overlay), end, buffer);
3778 /* Put the overlay on the wrong list. */
3779 end = OVERLAY_END (overlay);
3780 if (OVERLAY_POSITION (end) < b->overlay_center)
3782 XOVERLAY (overlay)->next = b->overlays_after;
3783 b->overlays_after = XOVERLAY (overlay);
3785 else
3787 XOVERLAY (overlay)->next = b->overlays_before;
3788 b->overlays_before = XOVERLAY (overlay);
3791 /* This puts it in the right list, and in the right order. */
3792 recenter_overlay_lists (b, b->overlay_center);
3794 return unbind_to (count, overlay);
3797 DEFUN ("delete-overlay", Fdelete_overlay, Sdelete_overlay, 1, 1, 0,
3798 doc: /* Delete the overlay OVERLAY from its buffer. */)
3799 (Lisp_Object overlay)
3801 Lisp_Object buffer;
3802 struct buffer *b;
3803 int count = SPECPDL_INDEX ();
3805 CHECK_OVERLAY (overlay);
3807 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3808 if (NILP (buffer))
3809 return Qnil;
3811 b = XBUFFER (buffer);
3812 specbind (Qinhibit_quit, Qt);
3814 b->overlays_before = unchain_overlay (b->overlays_before,XOVERLAY (overlay));
3815 b->overlays_after = unchain_overlay (b->overlays_after, XOVERLAY (overlay));
3816 eassert (XOVERLAY (overlay)->next == NULL);
3817 modify_overlay (b,
3818 marker_position (OVERLAY_START (overlay)),
3819 marker_position (OVERLAY_END (overlay)));
3820 Fset_marker (OVERLAY_START (overlay), Qnil, Qnil);
3821 Fset_marker (OVERLAY_END (overlay), Qnil, Qnil);
3823 /* When deleting an overlay with before or after strings, turn off
3824 display optimizations for the affected buffer, on the basis that
3825 these strings may contain newlines. This is easier to do than to
3826 check for that situation during redisplay. */
3827 if (!windows_or_buffers_changed
3828 && (!NILP (Foverlay_get (overlay, Qbefore_string))
3829 || !NILP (Foverlay_get (overlay, Qafter_string))))
3830 b->prevent_redisplay_optimizations_p = 1;
3832 return unbind_to (count, Qnil);
3835 /* Overlay dissection functions. */
3837 DEFUN ("overlay-start", Foverlay_start, Soverlay_start, 1, 1, 0,
3838 doc: /* Return the position at which OVERLAY starts. */)
3839 (Lisp_Object overlay)
3841 CHECK_OVERLAY (overlay);
3843 return (Fmarker_position (OVERLAY_START (overlay)));
3846 DEFUN ("overlay-end", Foverlay_end, Soverlay_end, 1, 1, 0,
3847 doc: /* Return the position at which OVERLAY ends. */)
3848 (Lisp_Object overlay)
3850 CHECK_OVERLAY (overlay);
3852 return (Fmarker_position (OVERLAY_END (overlay)));
3855 DEFUN ("overlay-buffer", Foverlay_buffer, Soverlay_buffer, 1, 1, 0,
3856 doc: /* Return the buffer OVERLAY belongs to.
3857 Return nil if OVERLAY has been deleted. */)
3858 (Lisp_Object overlay)
3860 CHECK_OVERLAY (overlay);
3862 return Fmarker_buffer (OVERLAY_START (overlay));
3865 DEFUN ("overlay-properties", Foverlay_properties, Soverlay_properties, 1, 1, 0,
3866 doc: /* Return a list of the properties on OVERLAY.
3867 This is a copy of OVERLAY's plist; modifying its conses has no effect on
3868 OVERLAY. */)
3869 (Lisp_Object overlay)
3871 CHECK_OVERLAY (overlay);
3873 return Fcopy_sequence (XOVERLAY (overlay)->plist);
3877 DEFUN ("overlays-at", Foverlays_at, Soverlays_at, 1, 1, 0,
3878 doc: /* Return a list of the overlays that contain the character at POS. */)
3879 (Lisp_Object pos)
3881 ptrdiff_t len, noverlays;
3882 Lisp_Object *overlay_vec;
3883 Lisp_Object result;
3885 CHECK_NUMBER_COERCE_MARKER (pos);
3887 len = 10;
3888 /* We can't use alloca here because overlays_at can call xrealloc. */
3889 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3891 /* Put all the overlays we want in a vector in overlay_vec.
3892 Store the length in len. */
3893 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3894 (EMACS_INT *) 0, (EMACS_INT *) 0, 0);
3896 /* Make a list of them all. */
3897 result = Flist (noverlays, overlay_vec);
3899 xfree (overlay_vec);
3900 return result;
3903 DEFUN ("overlays-in", Foverlays_in, Soverlays_in, 2, 2, 0,
3904 doc: /* Return a list of the overlays that overlap the region BEG ... END.
3905 Overlap means that at least one character is contained within the overlay
3906 and also contained within the specified region.
3907 Empty overlays are included in the result if they are located at BEG,
3908 between BEG and END, or at END provided END denotes the position at the
3909 end of the buffer. */)
3910 (Lisp_Object beg, Lisp_Object end)
3912 ptrdiff_t len, noverlays;
3913 Lisp_Object *overlay_vec;
3914 Lisp_Object result;
3916 CHECK_NUMBER_COERCE_MARKER (beg);
3917 CHECK_NUMBER_COERCE_MARKER (end);
3919 len = 10;
3920 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3922 /* Put all the overlays we want in a vector in overlay_vec.
3923 Store the length in len. */
3924 noverlays = overlays_in (XINT (beg), XINT (end), 1, &overlay_vec, &len,
3925 NULL, NULL);
3927 /* Make a list of them all. */
3928 result = Flist (noverlays, overlay_vec);
3930 xfree (overlay_vec);
3931 return result;
3934 DEFUN ("next-overlay-change", Fnext_overlay_change, Snext_overlay_change,
3935 1, 1, 0,
3936 doc: /* Return the next position after POS where an overlay starts or ends.
3937 If there are no overlay boundaries from POS to (point-max),
3938 the value is (point-max). */)
3939 (Lisp_Object pos)
3941 ptrdiff_t i, len, noverlays;
3942 EMACS_INT endpos;
3943 Lisp_Object *overlay_vec;
3945 CHECK_NUMBER_COERCE_MARKER (pos);
3947 len = 10;
3948 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3950 /* Put all the overlays we want in a vector in overlay_vec.
3951 Store the length in len.
3952 endpos gets the position where the next overlay starts. */
3953 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3954 &endpos, (EMACS_INT *) 0, 1);
3956 /* If any of these overlays ends before endpos,
3957 use its ending point instead. */
3958 for (i = 0; i < noverlays; i++)
3960 Lisp_Object oend;
3961 EMACS_INT oendpos;
3963 oend = OVERLAY_END (overlay_vec[i]);
3964 oendpos = OVERLAY_POSITION (oend);
3965 if (oendpos < endpos)
3966 endpos = oendpos;
3969 xfree (overlay_vec);
3970 return make_number (endpos);
3973 DEFUN ("previous-overlay-change", Fprevious_overlay_change,
3974 Sprevious_overlay_change, 1, 1, 0,
3975 doc: /* Return the previous position before POS where an overlay starts or ends.
3976 If there are no overlay boundaries from (point-min) to POS,
3977 the value is (point-min). */)
3978 (Lisp_Object pos)
3980 EMACS_INT prevpos;
3981 Lisp_Object *overlay_vec;
3982 ptrdiff_t len;
3984 CHECK_NUMBER_COERCE_MARKER (pos);
3986 /* At beginning of buffer, we know the answer;
3987 avoid bug subtracting 1 below. */
3988 if (XINT (pos) == BEGV)
3989 return pos;
3991 len = 10;
3992 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3994 /* Put all the overlays we want in a vector in overlay_vec.
3995 Store the length in len.
3996 prevpos gets the position of the previous change. */
3997 overlays_at (XINT (pos), 1, &overlay_vec, &len,
3998 (EMACS_INT *) 0, &prevpos, 1);
4000 xfree (overlay_vec);
4001 return make_number (prevpos);
4004 /* These functions are for debugging overlays. */
4006 DEFUN ("overlay-lists", Foverlay_lists, Soverlay_lists, 0, 0, 0,
4007 doc: /* Return a pair of lists giving all the overlays of the current buffer.
4008 The car has all the overlays before the overlay center;
4009 the cdr has all the overlays after the overlay center.
4010 Recentering overlays moves overlays between these lists.
4011 The lists you get are copies, so that changing them has no effect.
4012 However, the overlays you get are the real objects that the buffer uses. */)
4013 (void)
4015 struct Lisp_Overlay *ol;
4016 Lisp_Object before = Qnil, after = Qnil, tmp;
4017 for (ol = current_buffer->overlays_before; ol; ol = ol->next)
4019 XSETMISC (tmp, ol);
4020 before = Fcons (tmp, before);
4022 for (ol = current_buffer->overlays_after; ol; ol = ol->next)
4024 XSETMISC (tmp, ol);
4025 after = Fcons (tmp, after);
4027 return Fcons (Fnreverse (before), Fnreverse (after));
4030 DEFUN ("overlay-recenter", Foverlay_recenter, Soverlay_recenter, 1, 1, 0,
4031 doc: /* Recenter the overlays of the current buffer around position POS.
4032 That makes overlay lookup faster for positions near POS (but perhaps slower
4033 for positions far away from POS). */)
4034 (Lisp_Object pos)
4036 CHECK_NUMBER_COERCE_MARKER (pos);
4038 recenter_overlay_lists (current_buffer, XINT (pos));
4039 return Qnil;
4042 DEFUN ("overlay-get", Foverlay_get, Soverlay_get, 2, 2, 0,
4043 doc: /* Get the property of overlay OVERLAY with property name PROP. */)
4044 (Lisp_Object overlay, Lisp_Object prop)
4046 CHECK_OVERLAY (overlay);
4047 return lookup_char_property (XOVERLAY (overlay)->plist, prop, 0);
4050 DEFUN ("overlay-put", Foverlay_put, Soverlay_put, 3, 3, 0,
4051 doc: /* Set one property of overlay OVERLAY: give property PROP value VALUE.
4052 VALUE will be returned.*/)
4053 (Lisp_Object overlay, Lisp_Object prop, Lisp_Object value)
4055 Lisp_Object tail, buffer;
4056 int changed;
4058 CHECK_OVERLAY (overlay);
4060 buffer = Fmarker_buffer (OVERLAY_START (overlay));
4062 for (tail = XOVERLAY (overlay)->plist;
4063 CONSP (tail) && CONSP (XCDR (tail));
4064 tail = XCDR (XCDR (tail)))
4065 if (EQ (XCAR (tail), prop))
4067 changed = !EQ (XCAR (XCDR (tail)), value);
4068 XSETCAR (XCDR (tail), value);
4069 goto found;
4071 /* It wasn't in the list, so add it to the front. */
4072 changed = !NILP (value);
4073 XOVERLAY (overlay)->plist
4074 = Fcons (prop, Fcons (value, XOVERLAY (overlay)->plist));
4075 found:
4076 if (! NILP (buffer))
4078 if (changed)
4079 modify_overlay (XBUFFER (buffer),
4080 marker_position (OVERLAY_START (overlay)),
4081 marker_position (OVERLAY_END (overlay)));
4082 if (EQ (prop, Qevaporate) && ! NILP (value)
4083 && (OVERLAY_POSITION (OVERLAY_START (overlay))
4084 == OVERLAY_POSITION (OVERLAY_END (overlay))))
4085 Fdelete_overlay (overlay);
4088 return value;
4091 /* Subroutine of report_overlay_modification. */
4093 /* Lisp vector holding overlay hook functions to call.
4094 Vector elements come in pairs.
4095 Each even-index element is a list of hook functions.
4096 The following odd-index element is the overlay they came from.
4098 Before the buffer change, we fill in this vector
4099 as we call overlay hook functions.
4100 After the buffer change, we get the functions to call from this vector.
4101 This way we always call the same functions before and after the change. */
4102 static Lisp_Object last_overlay_modification_hooks;
4104 /* Number of elements actually used in last_overlay_modification_hooks. */
4105 static int last_overlay_modification_hooks_used;
4107 /* Add one functionlist/overlay pair
4108 to the end of last_overlay_modification_hooks. */
4110 static void
4111 add_overlay_mod_hooklist (Lisp_Object functionlist, Lisp_Object overlay)
4113 int oldsize = ASIZE (last_overlay_modification_hooks);
4115 if (last_overlay_modification_hooks_used == oldsize)
4116 last_overlay_modification_hooks = larger_vector
4117 (last_overlay_modification_hooks, oldsize * 2, Qnil);
4118 ASET (last_overlay_modification_hooks, last_overlay_modification_hooks_used,
4119 functionlist); last_overlay_modification_hooks_used++;
4120 ASET (last_overlay_modification_hooks, last_overlay_modification_hooks_used,
4121 overlay); last_overlay_modification_hooks_used++;
4124 /* Run the modification-hooks of overlays that include
4125 any part of the text in START to END.
4126 If this change is an insertion, also
4127 run the insert-before-hooks of overlay starting at END,
4128 and the insert-after-hooks of overlay ending at START.
4130 This is called both before and after the modification.
4131 AFTER is nonzero when we call after the modification.
4133 ARG1, ARG2, ARG3 are arguments to pass to the hook functions.
4134 When AFTER is nonzero, they are the start position,
4135 the position after the inserted new text,
4136 and the length of deleted or replaced old text. */
4138 void
4139 report_overlay_modification (Lisp_Object start, Lisp_Object end, int after,
4140 Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3)
4142 Lisp_Object prop, overlay;
4143 struct Lisp_Overlay *tail;
4144 /* 1 if this change is an insertion. */
4145 int insertion = (after ? XFASTINT (arg3) == 0 : EQ (start, end));
4146 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4148 overlay = Qnil;
4149 tail = NULL;
4151 /* We used to run the functions as soon as we found them and only register
4152 them in last_overlay_modification_hooks for the purpose of the `after'
4153 case. But running elisp code as we traverse the list of overlays is
4154 painful because the list can be modified by the elisp code so we had to
4155 copy at several places. We now simply do a read-only traversal that
4156 only collects the functions to run and we run them afterwards. It's
4157 simpler, especially since all the code was already there. -stef */
4159 if (!after)
4161 /* We are being called before a change.
4162 Scan the overlays to find the functions to call. */
4163 last_overlay_modification_hooks_used = 0;
4164 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4166 EMACS_INT startpos, endpos;
4167 Lisp_Object ostart, oend;
4169 XSETMISC (overlay, tail);
4171 ostart = OVERLAY_START (overlay);
4172 oend = OVERLAY_END (overlay);
4173 endpos = OVERLAY_POSITION (oend);
4174 if (XFASTINT (start) > endpos)
4175 break;
4176 startpos = OVERLAY_POSITION (ostart);
4177 if (insertion && (XFASTINT (start) == startpos
4178 || XFASTINT (end) == startpos))
4180 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4181 if (!NILP (prop))
4182 add_overlay_mod_hooklist (prop, overlay);
4184 if (insertion && (XFASTINT (start) == endpos
4185 || XFASTINT (end) == endpos))
4187 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4188 if (!NILP (prop))
4189 add_overlay_mod_hooklist (prop, overlay);
4191 /* Test for intersecting intervals. This does the right thing
4192 for both insertion and deletion. */
4193 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4195 prop = Foverlay_get (overlay, Qmodification_hooks);
4196 if (!NILP (prop))
4197 add_overlay_mod_hooklist (prop, overlay);
4201 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4203 EMACS_INT startpos, endpos;
4204 Lisp_Object ostart, oend;
4206 XSETMISC (overlay, tail);
4208 ostart = OVERLAY_START (overlay);
4209 oend = OVERLAY_END (overlay);
4210 startpos = OVERLAY_POSITION (ostart);
4211 endpos = OVERLAY_POSITION (oend);
4212 if (XFASTINT (end) < startpos)
4213 break;
4214 if (insertion && (XFASTINT (start) == startpos
4215 || XFASTINT (end) == startpos))
4217 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4218 if (!NILP (prop))
4219 add_overlay_mod_hooklist (prop, overlay);
4221 if (insertion && (XFASTINT (start) == endpos
4222 || XFASTINT (end) == endpos))
4224 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4225 if (!NILP (prop))
4226 add_overlay_mod_hooklist (prop, overlay);
4228 /* Test for intersecting intervals. This does the right thing
4229 for both insertion and deletion. */
4230 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4232 prop = Foverlay_get (overlay, Qmodification_hooks);
4233 if (!NILP (prop))
4234 add_overlay_mod_hooklist (prop, overlay);
4239 GCPRO4 (overlay, arg1, arg2, arg3);
4241 /* Call the functions recorded in last_overlay_modification_hooks.
4242 First copy the vector contents, in case some of these hooks
4243 do subsequent modification of the buffer. */
4244 int size = last_overlay_modification_hooks_used;
4245 Lisp_Object *copy = (Lisp_Object *) alloca (size * sizeof (Lisp_Object));
4246 int i;
4248 memcpy (copy, XVECTOR (last_overlay_modification_hooks)->contents,
4249 size * sizeof (Lisp_Object));
4250 gcpro1.var = copy;
4251 gcpro1.nvars = size;
4253 for (i = 0; i < size;)
4255 Lisp_Object prop_i, overlay_i;
4256 prop_i = copy[i++];
4257 overlay_i = copy[i++];
4258 call_overlay_mod_hooks (prop_i, overlay_i, after, arg1, arg2, arg3);
4261 UNGCPRO;
4264 static void
4265 call_overlay_mod_hooks (Lisp_Object list, Lisp_Object overlay, int after,
4266 Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3)
4268 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4270 GCPRO4 (list, arg1, arg2, arg3);
4272 while (CONSP (list))
4274 if (NILP (arg3))
4275 call4 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2);
4276 else
4277 call5 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2, arg3);
4278 list = XCDR (list);
4280 UNGCPRO;
4283 /* Delete any zero-sized overlays at position POS, if the `evaporate'
4284 property is set. */
4285 void
4286 evaporate_overlays (EMACS_INT pos)
4288 Lisp_Object overlay, hit_list;
4289 struct Lisp_Overlay *tail;
4291 hit_list = Qnil;
4292 if (pos <= current_buffer->overlay_center)
4293 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4295 EMACS_INT endpos;
4296 XSETMISC (overlay, tail);
4297 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
4298 if (endpos < pos)
4299 break;
4300 if (endpos == pos && OVERLAY_POSITION (OVERLAY_START (overlay)) == pos
4301 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4302 hit_list = Fcons (overlay, hit_list);
4304 else
4305 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4307 EMACS_INT startpos;
4308 XSETMISC (overlay, tail);
4309 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
4310 if (startpos > pos)
4311 break;
4312 if (startpos == pos && OVERLAY_POSITION (OVERLAY_END (overlay)) == pos
4313 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4314 hit_list = Fcons (overlay, hit_list);
4316 for (; CONSP (hit_list); hit_list = XCDR (hit_list))
4317 Fdelete_overlay (XCAR (hit_list));
4320 /* Somebody has tried to store a value with an unacceptable type
4321 in the slot with offset OFFSET. */
4323 void
4324 buffer_slot_type_mismatch (Lisp_Object newval, int type)
4326 Lisp_Object predicate;
4328 switch (type)
4330 case_Lisp_Int: predicate = Qintegerp; break;
4331 case Lisp_String: predicate = Qstringp; break;
4332 case Lisp_Symbol: predicate = Qsymbolp; break;
4333 default: abort ();
4336 wrong_type_argument (predicate, newval);
4340 /***********************************************************************
4341 Allocation with mmap
4342 ***********************************************************************/
4344 #ifdef USE_MMAP_FOR_BUFFERS
4346 #include <sys/types.h>
4347 #include <sys/mman.h>
4349 #ifndef MAP_ANON
4350 #ifdef MAP_ANONYMOUS
4351 #define MAP_ANON MAP_ANONYMOUS
4352 #else
4353 #define MAP_ANON 0
4354 #endif
4355 #endif
4357 #ifndef MAP_FAILED
4358 #define MAP_FAILED ((void *) -1)
4359 #endif
4361 #include <stdio.h>
4363 #if MAP_ANON == 0
4364 #include <fcntl.h>
4365 #endif
4367 #include "coding.h"
4370 /* Memory is allocated in regions which are mapped using mmap(2).
4371 The current implementation lets the system select mapped
4372 addresses; we're not using MAP_FIXED in general, except when
4373 trying to enlarge regions.
4375 Each mapped region starts with a mmap_region structure, the user
4376 area starts after that structure, aligned to MEM_ALIGN.
4378 +-----------------------+
4379 | struct mmap_info + |
4380 | padding |
4381 +-----------------------+
4382 | user data |
4385 +-----------------------+ */
4387 struct mmap_region
4389 /* User-specified size. */
4390 size_t nbytes_specified;
4392 /* Number of bytes mapped */
4393 size_t nbytes_mapped;
4395 /* Pointer to the location holding the address of the memory
4396 allocated with the mmap'd block. The variable actually points
4397 after this structure. */
4398 POINTER_TYPE **var;
4400 /* Next and previous in list of all mmap'd regions. */
4401 struct mmap_region *next, *prev;
4404 /* Doubly-linked list of mmap'd regions. */
4406 static struct mmap_region *mmap_regions;
4408 /* File descriptor for mmap. If we don't have anonymous mapping,
4409 /dev/zero will be opened on it. */
4411 static int mmap_fd;
4413 /* Temporary storage for mmap_set_vars, see there. */
4415 static struct mmap_region *mmap_regions_1;
4416 static int mmap_fd_1;
4418 /* Page size on this system. */
4420 static int mmap_page_size;
4422 /* 1 means mmap has been initialized. */
4424 static int mmap_initialized_p;
4426 /* Value is X rounded up to the next multiple of N. */
4428 #define ROUND(X, N) (((X) + (N) - 1) / (N) * (N))
4430 /* Size of mmap_region structure plus padding. */
4432 #define MMAP_REGION_STRUCT_SIZE \
4433 ROUND (sizeof (struct mmap_region), MEM_ALIGN)
4435 /* Given a pointer P to the start of the user-visible part of a mapped
4436 region, return a pointer to the start of the region. */
4438 #define MMAP_REGION(P) \
4439 ((struct mmap_region *) ((char *) (P) - MMAP_REGION_STRUCT_SIZE))
4441 /* Given a pointer P to the start of a mapped region, return a pointer
4442 to the start of the user-visible part of the region. */
4444 #define MMAP_USER_AREA(P) \
4445 ((POINTER_TYPE *) ((char *) (P) + MMAP_REGION_STRUCT_SIZE))
4447 #define MEM_ALIGN sizeof (double)
4449 /* Predicate returning true if part of the address range [START .. END]
4450 is currently mapped. Used to prevent overwriting an existing
4451 memory mapping.
4453 Default is to conservatively assume the address range is occupied by
4454 something else. This can be overridden by system configuration
4455 files if system-specific means to determine this exists. */
4457 #ifndef MMAP_ALLOCATED_P
4458 #define MMAP_ALLOCATED_P(start, end) 1
4459 #endif
4461 /* Perform necessary initializations for the use of mmap. */
4463 static void
4464 mmap_init (void)
4466 #if MAP_ANON == 0
4467 /* The value of mmap_fd is initially 0 in temacs, and -1
4468 in a dumped Emacs. */
4469 if (mmap_fd <= 0)
4471 /* No anonymous mmap -- we need the file descriptor. */
4472 mmap_fd = open ("/dev/zero", O_RDONLY);
4473 if (mmap_fd == -1)
4474 fatal ("Cannot open /dev/zero: %s", emacs_strerror (errno));
4476 #endif /* MAP_ANON == 0 */
4478 if (mmap_initialized_p)
4479 return;
4480 mmap_initialized_p = 1;
4482 #if MAP_ANON != 0
4483 mmap_fd = -1;
4484 #endif
4486 mmap_page_size = getpagesize ();
4489 /* Return a region overlapping address range START...END, or null if
4490 none. END is not including, i.e. the last byte in the range
4491 is at END - 1. */
4493 static struct mmap_region *
4494 mmap_find (POINTER_TYPE *start, POINTER_TYPE *end)
4496 struct mmap_region *r;
4497 char *s = (char *) start, *e = (char *) end;
4499 for (r = mmap_regions; r; r = r->next)
4501 char *rstart = (char *) r;
4502 char *rend = rstart + r->nbytes_mapped;
4504 if (/* First byte of range, i.e. START, in this region? */
4505 (s >= rstart && s < rend)
4506 /* Last byte of range, i.e. END - 1, in this region? */
4507 || (e > rstart && e <= rend)
4508 /* First byte of this region in the range? */
4509 || (rstart >= s && rstart < e)
4510 /* Last byte of this region in the range? */
4511 || (rend > s && rend <= e))
4512 break;
4515 return r;
4519 /* Unmap a region. P is a pointer to the start of the user-araa of
4520 the region. Value is non-zero if successful. */
4522 static int
4523 mmap_free_1 (struct mmap_region *r)
4525 if (r->next)
4526 r->next->prev = r->prev;
4527 if (r->prev)
4528 r->prev->next = r->next;
4529 else
4530 mmap_regions = r->next;
4532 if (munmap ((POINTER_TYPE *) r, r->nbytes_mapped) == -1)
4534 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4535 return 0;
4538 return 1;
4542 /* Enlarge region R by NPAGES pages. NPAGES < 0 means shrink R.
4543 Value is non-zero if successful. */
4545 static int
4546 mmap_enlarge (struct mmap_region *r, int npages)
4548 char *region_end = (char *) r + r->nbytes_mapped;
4549 size_t nbytes;
4550 int success = 0;
4552 if (npages < 0)
4554 /* Unmap pages at the end of the region. */
4555 nbytes = - npages * mmap_page_size;
4556 if (munmap (region_end - nbytes, nbytes) == -1)
4557 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4558 else
4560 r->nbytes_mapped -= nbytes;
4561 success = 1;
4564 else if (npages > 0)
4566 nbytes = npages * mmap_page_size;
4568 /* Try to map additional pages at the end of the region. We
4569 cannot do this if the address range is already occupied by
4570 something else because mmap deletes any previous mapping.
4571 I'm not sure this is worth doing, let's see. */
4572 if (!MMAP_ALLOCATED_P (region_end, region_end + nbytes))
4574 POINTER_TYPE *p;
4576 p = mmap (region_end, nbytes, PROT_READ | PROT_WRITE,
4577 MAP_ANON | MAP_PRIVATE | MAP_FIXED, mmap_fd, 0);
4578 if (p == MAP_FAILED)
4579 ; /* fprintf (stderr, "mmap: %s\n", emacs_strerror (errno)); */
4580 else if (p != (POINTER_TYPE *) region_end)
4582 /* Kernels are free to choose a different address. In
4583 that case, unmap what we've mapped above; we have
4584 no use for it. */
4585 if (munmap (p, nbytes) == -1)
4586 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4588 else
4590 r->nbytes_mapped += nbytes;
4591 success = 1;
4596 return success;
4600 /* Set or reset variables holding references to mapped regions. If
4601 RESTORE_P is zero, set all variables to null. If RESTORE_P is
4602 non-zero, set all variables to the start of the user-areas
4603 of mapped regions.
4605 This function is called from Fdump_emacs to ensure that the dumped
4606 Emacs doesn't contain references to memory that won't be mapped
4607 when Emacs starts. */
4609 void
4610 mmap_set_vars (int restore_p)
4612 struct mmap_region *r;
4614 if (restore_p)
4616 mmap_regions = mmap_regions_1;
4617 mmap_fd = mmap_fd_1;
4618 for (r = mmap_regions; r; r = r->next)
4619 *r->var = MMAP_USER_AREA (r);
4621 else
4623 for (r = mmap_regions; r; r = r->next)
4624 *r->var = NULL;
4625 mmap_regions_1 = mmap_regions;
4626 mmap_regions = NULL;
4627 mmap_fd_1 = mmap_fd;
4628 mmap_fd = -1;
4633 /* Allocate a block of storage large enough to hold NBYTES bytes of
4634 data. A pointer to the data is returned in *VAR. VAR is thus the
4635 address of some variable which will use the data area.
4637 The allocation of 0 bytes is valid.
4639 If we can't allocate the necessary memory, set *VAR to null, and
4640 return null. */
4642 static POINTER_TYPE *
4643 mmap_alloc (POINTER_TYPE **var, size_t nbytes)
4645 void *p;
4646 size_t map;
4648 mmap_init ();
4650 map = ROUND (nbytes + MMAP_REGION_STRUCT_SIZE, mmap_page_size);
4651 p = mmap (NULL, map, PROT_READ | PROT_WRITE, MAP_ANON | MAP_PRIVATE,
4652 mmap_fd, 0);
4654 if (p == MAP_FAILED)
4656 if (errno != ENOMEM)
4657 fprintf (stderr, "mmap: %s\n", emacs_strerror (errno));
4658 p = NULL;
4660 else
4662 struct mmap_region *r = (struct mmap_region *) p;
4664 r->nbytes_specified = nbytes;
4665 r->nbytes_mapped = map;
4666 r->var = var;
4667 r->prev = NULL;
4668 r->next = mmap_regions;
4669 if (r->next)
4670 r->next->prev = r;
4671 mmap_regions = r;
4673 p = MMAP_USER_AREA (p);
4676 return *var = p;
4680 /* Free a block of relocatable storage whose data is pointed to by
4681 PTR. Store 0 in *PTR to show there's no block allocated. */
4683 static void
4684 mmap_free (POINTER_TYPE **var)
4686 mmap_init ();
4688 if (*var)
4690 mmap_free_1 (MMAP_REGION (*var));
4691 *var = NULL;
4696 /* Given a pointer at address VAR to data allocated with mmap_alloc,
4697 resize it to size NBYTES. Change *VAR to reflect the new block,
4698 and return this value. If more memory cannot be allocated, then
4699 leave *VAR unchanged, and return null. */
4701 static POINTER_TYPE *
4702 mmap_realloc (POINTER_TYPE **var, size_t nbytes)
4704 POINTER_TYPE *result;
4706 mmap_init ();
4708 if (*var == NULL)
4709 result = mmap_alloc (var, nbytes);
4710 else if (nbytes == 0)
4712 mmap_free (var);
4713 result = mmap_alloc (var, nbytes);
4715 else
4717 struct mmap_region *r = MMAP_REGION (*var);
4718 size_t room = r->nbytes_mapped - MMAP_REGION_STRUCT_SIZE;
4720 if (room < nbytes)
4722 /* Must enlarge. */
4723 POINTER_TYPE *old_ptr = *var;
4725 /* Try to map additional pages at the end of the region.
4726 If that fails, allocate a new region, copy data
4727 from the old region, then free it. */
4728 if (mmap_enlarge (r, (ROUND (nbytes - room, mmap_page_size)
4729 / mmap_page_size)))
4731 r->nbytes_specified = nbytes;
4732 *var = result = old_ptr;
4734 else if (mmap_alloc (var, nbytes))
4736 memcpy (*var, old_ptr, r->nbytes_specified);
4737 mmap_free_1 (MMAP_REGION (old_ptr));
4738 result = *var;
4739 r = MMAP_REGION (result);
4740 r->nbytes_specified = nbytes;
4742 else
4744 *var = old_ptr;
4745 result = NULL;
4748 else if (room - nbytes >= mmap_page_size)
4750 /* Shrinking by at least a page. Let's give some
4751 memory back to the system.
4753 The extra parens are to make the division happens first,
4754 on positive values, so we know it will round towards
4755 zero. */
4756 mmap_enlarge (r, - ((room - nbytes) / mmap_page_size));
4757 result = *var;
4758 r->nbytes_specified = nbytes;
4760 else
4762 /* Leave it alone. */
4763 result = *var;
4764 r->nbytes_specified = nbytes;
4768 return result;
4772 #endif /* USE_MMAP_FOR_BUFFERS */
4776 /***********************************************************************
4777 Buffer-text Allocation
4778 ***********************************************************************/
4780 #ifdef REL_ALLOC
4781 extern POINTER_TYPE *r_alloc (POINTER_TYPE **, size_t);
4782 extern POINTER_TYPE *r_re_alloc (POINTER_TYPE **, size_t);
4783 extern void r_alloc_free (POINTER_TYPE **ptr);
4784 #endif /* REL_ALLOC */
4787 /* Allocate NBYTES bytes for buffer B's text buffer. */
4789 static void
4790 alloc_buffer_text (struct buffer *b, ptrdiff_t nbytes)
4792 POINTER_TYPE *p;
4794 BLOCK_INPUT;
4795 #if defined USE_MMAP_FOR_BUFFERS
4796 p = mmap_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4797 #elif defined REL_ALLOC
4798 p = r_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4799 #else
4800 p = xmalloc (nbytes);
4801 #endif
4803 if (p == NULL)
4805 UNBLOCK_INPUT;
4806 memory_full (nbytes);
4809 b->text->beg = (unsigned char *) p;
4810 UNBLOCK_INPUT;
4813 /* Enlarge buffer B's text buffer by DELTA bytes. DELTA < 0 means
4814 shrink it. */
4816 void
4817 enlarge_buffer_text (struct buffer *b, EMACS_INT delta)
4819 POINTER_TYPE *p;
4820 ptrdiff_t nbytes = (BUF_Z_BYTE (b) - BUF_BEG_BYTE (b) + BUF_GAP_SIZE (b) + 1
4821 + delta);
4822 BLOCK_INPUT;
4823 #if defined USE_MMAP_FOR_BUFFERS
4824 p = mmap_realloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4825 #elif defined REL_ALLOC
4826 p = r_re_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4827 #else
4828 p = xrealloc (b->text->beg, nbytes);
4829 #endif
4831 if (p == NULL)
4833 UNBLOCK_INPUT;
4834 memory_full (nbytes);
4837 BUF_BEG_ADDR (b) = (unsigned char *) p;
4838 UNBLOCK_INPUT;
4842 /* Free buffer B's text buffer. */
4844 static void
4845 free_buffer_text (struct buffer *b)
4847 BLOCK_INPUT;
4849 #if defined USE_MMAP_FOR_BUFFERS
4850 mmap_free ((POINTER_TYPE **) &b->text->beg);
4851 #elif defined REL_ALLOC
4852 r_alloc_free ((POINTER_TYPE **) &b->text->beg);
4853 #else
4854 xfree (b->text->beg);
4855 #endif
4857 BUF_BEG_ADDR (b) = NULL;
4858 UNBLOCK_INPUT;
4863 /***********************************************************************
4864 Initialization
4865 ***********************************************************************/
4867 void
4868 init_buffer_once (void)
4870 int idx;
4872 memset (buffer_permanent_local_flags, 0, sizeof buffer_permanent_local_flags);
4874 /* Make sure all markable slots in buffer_defaults
4875 are initialized reasonably, so mark_buffer won't choke. */
4876 reset_buffer (&buffer_defaults);
4877 eassert (EQ (BVAR (&buffer_defaults, name), make_number (0)));
4878 reset_buffer_local_variables (&buffer_defaults, 1);
4879 eassert (EQ (BVAR (&buffer_local_symbols, name), make_number (0)));
4880 reset_buffer (&buffer_local_symbols);
4881 reset_buffer_local_variables (&buffer_local_symbols, 1);
4882 /* Prevent GC from getting confused. */
4883 buffer_defaults.text = &buffer_defaults.own_text;
4884 buffer_local_symbols.text = &buffer_local_symbols.own_text;
4885 BUF_INTERVALS (&buffer_defaults) = 0;
4886 BUF_INTERVALS (&buffer_local_symbols) = 0;
4887 XSETPVECTYPESIZE (&buffer_defaults, PVEC_BUFFER, 0);
4888 XSETBUFFER (Vbuffer_defaults, &buffer_defaults);
4889 XSETPVECTYPESIZE (&buffer_local_symbols, PVEC_BUFFER, 0);
4890 XSETBUFFER (Vbuffer_local_symbols, &buffer_local_symbols);
4892 /* Set up the default values of various buffer slots. */
4893 /* Must do these before making the first buffer! */
4895 /* real setup is done in bindings.el */
4896 BVAR (&buffer_defaults, mode_line_format) = make_pure_c_string ("%-");
4897 BVAR (&buffer_defaults, header_line_format) = Qnil;
4898 BVAR (&buffer_defaults, abbrev_mode) = Qnil;
4899 BVAR (&buffer_defaults, overwrite_mode) = Qnil;
4900 BVAR (&buffer_defaults, case_fold_search) = Qt;
4901 BVAR (&buffer_defaults, auto_fill_function) = Qnil;
4902 BVAR (&buffer_defaults, selective_display) = Qnil;
4903 #ifndef old
4904 BVAR (&buffer_defaults, selective_display_ellipses) = Qt;
4905 #endif
4906 BVAR (&buffer_defaults, abbrev_table) = Qnil;
4907 BVAR (&buffer_defaults, display_table) = Qnil;
4908 BVAR (&buffer_defaults, undo_list) = Qnil;
4909 BVAR (&buffer_defaults, mark_active) = Qnil;
4910 BVAR (&buffer_defaults, file_format) = Qnil;
4911 BVAR (&buffer_defaults, auto_save_file_format) = Qt;
4912 buffer_defaults.overlays_before = NULL;
4913 buffer_defaults.overlays_after = NULL;
4914 buffer_defaults.overlay_center = BEG;
4916 XSETFASTINT (BVAR (&buffer_defaults, tab_width), 8);
4917 BVAR (&buffer_defaults, truncate_lines) = Qnil;
4918 BVAR (&buffer_defaults, word_wrap) = Qnil;
4919 BVAR (&buffer_defaults, ctl_arrow) = Qt;
4920 BVAR (&buffer_defaults, bidi_display_reordering) = Qt;
4921 BVAR (&buffer_defaults, bidi_paragraph_direction) = Qnil;
4922 BVAR (&buffer_defaults, cursor_type) = Qt;
4923 BVAR (&buffer_defaults, extra_line_spacing) = Qnil;
4924 BVAR (&buffer_defaults, cursor_in_non_selected_windows) = Qt;
4926 BVAR (&buffer_defaults, enable_multibyte_characters) = Qt;
4927 BVAR (&buffer_defaults, buffer_file_coding_system) = Qnil;
4928 XSETFASTINT (BVAR (&buffer_defaults, fill_column), 70);
4929 XSETFASTINT (BVAR (&buffer_defaults, left_margin), 0);
4930 BVAR (&buffer_defaults, cache_long_line_scans) = Qnil;
4931 BVAR (&buffer_defaults, file_truename) = Qnil;
4932 XSETFASTINT (BVAR (&buffer_defaults, display_count), 0);
4933 XSETFASTINT (BVAR (&buffer_defaults, left_margin_cols), 0);
4934 XSETFASTINT (BVAR (&buffer_defaults, right_margin_cols), 0);
4935 BVAR (&buffer_defaults, left_fringe_width) = Qnil;
4936 BVAR (&buffer_defaults, right_fringe_width) = Qnil;
4937 BVAR (&buffer_defaults, fringes_outside_margins) = Qnil;
4938 BVAR (&buffer_defaults, scroll_bar_width) = Qnil;
4939 BVAR (&buffer_defaults, vertical_scroll_bar_type) = Qt;
4940 BVAR (&buffer_defaults, indicate_empty_lines) = Qnil;
4941 BVAR (&buffer_defaults, indicate_buffer_boundaries) = Qnil;
4942 BVAR (&buffer_defaults, fringe_indicator_alist) = Qnil;
4943 BVAR (&buffer_defaults, fringe_cursor_alist) = Qnil;
4944 BVAR (&buffer_defaults, scroll_up_aggressively) = Qnil;
4945 BVAR (&buffer_defaults, scroll_down_aggressively) = Qnil;
4946 BVAR (&buffer_defaults, display_time) = Qnil;
4948 /* Assign the local-flags to the slots that have default values.
4949 The local flag is a bit that is used in the buffer
4950 to say that it has its own local value for the slot.
4951 The local flag bits are in the local_var_flags slot of the buffer. */
4953 /* Nothing can work if this isn't true */
4954 { verify (sizeof (EMACS_INT) == sizeof (Lisp_Object)); }
4956 /* 0 means not a lisp var, -1 means always local, else mask */
4957 memset (&buffer_local_flags, 0, sizeof buffer_local_flags);
4958 XSETINT (BVAR (&buffer_local_flags, filename), -1);
4959 XSETINT (BVAR (&buffer_local_flags, directory), -1);
4960 XSETINT (BVAR (&buffer_local_flags, backed_up), -1);
4961 XSETINT (BVAR (&buffer_local_flags, save_length), -1);
4962 XSETINT (BVAR (&buffer_local_flags, auto_save_file_name), -1);
4963 XSETINT (BVAR (&buffer_local_flags, read_only), -1);
4964 XSETINT (BVAR (&buffer_local_flags, major_mode), -1);
4965 XSETINT (BVAR (&buffer_local_flags, mode_name), -1);
4966 XSETINT (BVAR (&buffer_local_flags, undo_list), -1);
4967 XSETINT (BVAR (&buffer_local_flags, mark_active), -1);
4968 XSETINT (BVAR (&buffer_local_flags, point_before_scroll), -1);
4969 XSETINT (BVAR (&buffer_local_flags, file_truename), -1);
4970 XSETINT (BVAR (&buffer_local_flags, invisibility_spec), -1);
4971 XSETINT (BVAR (&buffer_local_flags, file_format), -1);
4972 XSETINT (BVAR (&buffer_local_flags, auto_save_file_format), -1);
4973 XSETINT (BVAR (&buffer_local_flags, display_count), -1);
4974 XSETINT (BVAR (&buffer_local_flags, display_time), -1);
4975 XSETINT (BVAR (&buffer_local_flags, enable_multibyte_characters), -1);
4977 idx = 1;
4978 XSETFASTINT (BVAR (&buffer_local_flags, mode_line_format), idx); ++idx;
4979 XSETFASTINT (BVAR (&buffer_local_flags, abbrev_mode), idx); ++idx;
4980 XSETFASTINT (BVAR (&buffer_local_flags, overwrite_mode), idx); ++idx;
4981 XSETFASTINT (BVAR (&buffer_local_flags, case_fold_search), idx); ++idx;
4982 XSETFASTINT (BVAR (&buffer_local_flags, auto_fill_function), idx); ++idx;
4983 XSETFASTINT (BVAR (&buffer_local_flags, selective_display), idx); ++idx;
4984 #ifndef old
4985 XSETFASTINT (BVAR (&buffer_local_flags, selective_display_ellipses), idx); ++idx;
4986 #endif
4987 XSETFASTINT (BVAR (&buffer_local_flags, tab_width), idx); ++idx;
4988 XSETFASTINT (BVAR (&buffer_local_flags, truncate_lines), idx); ++idx;
4989 XSETFASTINT (BVAR (&buffer_local_flags, word_wrap), idx); ++idx;
4990 XSETFASTINT (BVAR (&buffer_local_flags, ctl_arrow), idx); ++idx;
4991 XSETFASTINT (BVAR (&buffer_local_flags, fill_column), idx); ++idx;
4992 XSETFASTINT (BVAR (&buffer_local_flags, left_margin), idx); ++idx;
4993 XSETFASTINT (BVAR (&buffer_local_flags, abbrev_table), idx); ++idx;
4994 XSETFASTINT (BVAR (&buffer_local_flags, display_table), idx); ++idx;
4995 XSETFASTINT (BVAR (&buffer_local_flags, syntax_table), idx); ++idx;
4996 XSETFASTINT (BVAR (&buffer_local_flags, cache_long_line_scans), idx); ++idx;
4997 XSETFASTINT (BVAR (&buffer_local_flags, category_table), idx); ++idx;
4998 XSETFASTINT (BVAR (&buffer_local_flags, bidi_display_reordering), idx); ++idx;
4999 XSETFASTINT (BVAR (&buffer_local_flags, bidi_paragraph_direction), idx); ++idx;
5000 XSETFASTINT (BVAR (&buffer_local_flags, buffer_file_coding_system), idx);
5001 /* Make this one a permanent local. */
5002 buffer_permanent_local_flags[idx++] = 1;
5003 XSETFASTINT (BVAR (&buffer_local_flags, left_margin_cols), idx); ++idx;
5004 XSETFASTINT (BVAR (&buffer_local_flags, right_margin_cols), idx); ++idx;
5005 XSETFASTINT (BVAR (&buffer_local_flags, left_fringe_width), idx); ++idx;
5006 XSETFASTINT (BVAR (&buffer_local_flags, right_fringe_width), idx); ++idx;
5007 XSETFASTINT (BVAR (&buffer_local_flags, fringes_outside_margins), idx); ++idx;
5008 XSETFASTINT (BVAR (&buffer_local_flags, scroll_bar_width), idx); ++idx;
5009 XSETFASTINT (BVAR (&buffer_local_flags, vertical_scroll_bar_type), idx); ++idx;
5010 XSETFASTINT (BVAR (&buffer_local_flags, indicate_empty_lines), idx); ++idx;
5011 XSETFASTINT (BVAR (&buffer_local_flags, indicate_buffer_boundaries), idx); ++idx;
5012 XSETFASTINT (BVAR (&buffer_local_flags, fringe_indicator_alist), idx); ++idx;
5013 XSETFASTINT (BVAR (&buffer_local_flags, fringe_cursor_alist), idx); ++idx;
5014 XSETFASTINT (BVAR (&buffer_local_flags, scroll_up_aggressively), idx); ++idx;
5015 XSETFASTINT (BVAR (&buffer_local_flags, scroll_down_aggressively), idx); ++idx;
5016 XSETFASTINT (BVAR (&buffer_local_flags, header_line_format), idx); ++idx;
5017 XSETFASTINT (BVAR (&buffer_local_flags, cursor_type), idx); ++idx;
5018 XSETFASTINT (BVAR (&buffer_local_flags, extra_line_spacing), idx); ++idx;
5019 XSETFASTINT (BVAR (&buffer_local_flags, cursor_in_non_selected_windows), idx); ++idx;
5021 /* Need more room? */
5022 if (idx >= MAX_PER_BUFFER_VARS)
5023 abort ();
5024 last_per_buffer_idx = idx;
5026 Vbuffer_alist = Qnil;
5027 current_buffer = 0;
5028 all_buffers = 0;
5030 QSFundamental = make_pure_c_string ("Fundamental");
5032 Qfundamental_mode = intern_c_string ("fundamental-mode");
5033 BVAR (&buffer_defaults, major_mode) = Qfundamental_mode;
5035 Qmode_class = intern_c_string ("mode-class");
5037 Qprotected_field = intern_c_string ("protected-field");
5039 Qpermanent_local = intern_c_string ("permanent-local");
5041 Qkill_buffer_hook = intern_c_string ("kill-buffer-hook");
5042 Fput (Qkill_buffer_hook, Qpermanent_local, Qt);
5044 Qucs_set_table_for_input = intern_c_string ("ucs-set-table-for-input");
5046 /* super-magic invisible buffer */
5047 Vprin1_to_string_buffer = Fget_buffer_create (make_pure_c_string (" prin1"));
5048 Vbuffer_alist = Qnil;
5050 Fset_buffer (Fget_buffer_create (make_pure_c_string ("*scratch*")));
5052 inhibit_modification_hooks = 0;
5055 void
5056 init_buffer (void)
5058 char *pwd;
5059 Lisp_Object temp;
5060 ptrdiff_t len;
5062 #ifdef USE_MMAP_FOR_BUFFERS
5064 /* When using the ralloc implementation based on mmap(2), buffer
5065 text pointers will have been set to null in the dumped Emacs.
5066 Map new memory. */
5067 struct buffer *b;
5069 for (b = all_buffers; b; b = b->header.next.buffer)
5070 if (b->text->beg == NULL)
5071 enlarge_buffer_text (b, 0);
5073 #endif /* USE_MMAP_FOR_BUFFERS */
5075 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5076 if (NILP (BVAR (&buffer_defaults, enable_multibyte_characters)))
5077 Fset_buffer_multibyte (Qnil);
5079 pwd = get_current_dir_name ();
5081 if (!pwd)
5082 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno));
5084 /* Maybe this should really use some standard subroutine
5085 whose definition is filename syntax dependent. */
5086 len = strlen (pwd);
5087 if (!(IS_DIRECTORY_SEP (pwd[len - 1])))
5089 /* Grow buffer to add directory separator and '\0'. */
5090 pwd = (char *) realloc (pwd, len + 2);
5091 if (!pwd)
5092 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno));
5093 pwd[len] = DIRECTORY_SEP;
5094 pwd[len + 1] = '\0';
5097 BVAR (current_buffer, directory) = make_unibyte_string (pwd, strlen (pwd));
5098 if (! NILP (BVAR (&buffer_defaults, enable_multibyte_characters)))
5099 /* At this moment, we still don't know how to decode the
5100 directory name. So, we keep the bytes in multibyte form so
5101 that ENCODE_FILE correctly gets the original bytes. */
5102 BVAR (current_buffer, directory)
5103 = string_to_multibyte (BVAR (current_buffer, directory));
5105 /* Add /: to the front of the name
5106 if it would otherwise be treated as magic. */
5107 temp = Ffind_file_name_handler (BVAR (current_buffer, directory), Qt);
5108 if (! NILP (temp)
5109 /* If the default dir is just /, TEMP is non-nil
5110 because of the ange-ftp completion handler.
5111 However, it is not necessary to turn / into /:/.
5112 So avoid doing that. */
5113 && strcmp ("/", SSDATA (BVAR (current_buffer, directory))))
5114 BVAR (current_buffer, directory)
5115 = concat2 (build_string ("/:"), BVAR (current_buffer, directory));
5117 temp = get_minibuffer (0);
5118 BVAR (XBUFFER (temp), directory) = BVAR (current_buffer, directory);
5120 free (pwd);
5123 /* Similar to defvar_lisp but define a variable whose value is the Lisp
5124 Object stored in the current buffer. address is the address of the slot
5125 in the buffer that is current now. */
5127 /* TYPE is nil for a general Lisp variable.
5128 An integer specifies a type; then only Lisp values
5129 with that type code are allowed (except that nil is allowed too).
5130 LNAME is the Lisp-level variable name.
5131 VNAME is the name of the buffer slot.
5132 DOC is a dummy where you write the doc string as a comment. */
5133 #define DEFVAR_PER_BUFFER(lname, vname, type, doc) \
5134 do { \
5135 static struct Lisp_Buffer_Objfwd bo_fwd; \
5136 defvar_per_buffer (&bo_fwd, lname, vname, type); \
5137 } while (0)
5139 static void
5140 defvar_per_buffer (struct Lisp_Buffer_Objfwd *bo_fwd, const char *namestring,
5141 Lisp_Object *address, Lisp_Object type)
5143 struct Lisp_Symbol *sym;
5144 int offset;
5146 sym = XSYMBOL (intern (namestring));
5147 offset = (char *)address - (char *)current_buffer;
5149 bo_fwd->type = Lisp_Fwd_Buffer_Obj;
5150 bo_fwd->offset = offset;
5151 bo_fwd->slottype = type;
5152 sym->declared_special = 1;
5153 sym->redirect = SYMBOL_FORWARDED;
5155 /* I tried to do the job without a cast, but it seems impossible.
5156 union Lisp_Fwd *fwd; &(fwd->u_buffer_objfwd) = bo_fwd; */
5157 SET_SYMBOL_FWD (sym, (union Lisp_Fwd *)bo_fwd);
5159 XSETSYMBOL (PER_BUFFER_SYMBOL (offset), sym);
5161 if (PER_BUFFER_IDX (offset) == 0)
5162 /* Did a DEFVAR_PER_BUFFER without initializing the corresponding
5163 slot of buffer_local_flags */
5164 abort ();
5168 /* initialize the buffer routines */
5169 void
5170 syms_of_buffer (void)
5172 staticpro (&last_overlay_modification_hooks);
5173 last_overlay_modification_hooks
5174 = Fmake_vector (make_number (10), Qnil);
5176 staticpro (&Vbuffer_defaults);
5177 staticpro (&Vbuffer_local_symbols);
5178 staticpro (&Qfundamental_mode);
5179 staticpro (&Qmode_class);
5180 staticpro (&QSFundamental);
5181 staticpro (&Vbuffer_alist);
5182 staticpro (&Qprotected_field);
5183 staticpro (&Qpermanent_local);
5184 staticpro (&Qkill_buffer_hook);
5186 DEFSYM (Qpermanent_local_hook, "permanent-local-hook");
5187 DEFSYM (Qoverlayp, "overlayp");
5188 DEFSYM (Qevaporate, "evaporate");
5189 DEFSYM (Qmodification_hooks, "modification-hooks");
5190 DEFSYM (Qinsert_in_front_hooks, "insert-in-front-hooks");
5191 DEFSYM (Qinsert_behind_hooks, "insert-behind-hooks");
5192 DEFSYM (Qget_file_buffer, "get-file-buffer");
5193 DEFSYM (Qpriority, "priority");
5194 DEFSYM (Qbefore_string, "before-string");
5195 DEFSYM (Qafter_string, "after-string");
5196 DEFSYM (Qfirst_change_hook, "first-change-hook");
5197 DEFSYM (Qbefore_change_functions, "before-change-functions");
5198 DEFSYM (Qafter_change_functions, "after-change-functions");
5199 DEFSYM (Qkill_buffer_query_functions, "kill-buffer-query-functions");
5201 /* The next one is initialized in init_buffer_once. */
5202 staticpro (&Qucs_set_table_for_input);
5204 Fput (Qprotected_field, Qerror_conditions,
5205 pure_cons (Qprotected_field, pure_cons (Qerror, Qnil)));
5206 Fput (Qprotected_field, Qerror_message,
5207 make_pure_c_string ("Attempt to modify a protected field"));
5209 DEFVAR_BUFFER_DEFAULTS ("default-mode-line-format",
5210 mode_line_format,
5211 doc: /* Default value of `mode-line-format' for buffers that don't override it.
5212 This is the same as (default-value 'mode-line-format). */);
5214 DEFVAR_BUFFER_DEFAULTS ("default-header-line-format",
5215 header_line_format,
5216 doc: /* Default value of `header-line-format' for buffers that don't override it.
5217 This is the same as (default-value 'header-line-format). */);
5219 DEFVAR_BUFFER_DEFAULTS ("default-cursor-type", cursor_type,
5220 doc: /* Default value of `cursor-type' for buffers that don't override it.
5221 This is the same as (default-value 'cursor-type). */);
5223 DEFVAR_BUFFER_DEFAULTS ("default-line-spacing",
5224 extra_line_spacing,
5225 doc: /* Default value of `line-spacing' for buffers that don't override it.
5226 This is the same as (default-value 'line-spacing). */);
5228 DEFVAR_BUFFER_DEFAULTS ("default-cursor-in-non-selected-windows",
5229 cursor_in_non_selected_windows,
5230 doc: /* Default value of `cursor-in-non-selected-windows'.
5231 This is the same as (default-value 'cursor-in-non-selected-windows). */);
5233 DEFVAR_BUFFER_DEFAULTS ("default-abbrev-mode",
5234 abbrev_mode,
5235 doc: /* Default value of `abbrev-mode' for buffers that do not override it.
5236 This is the same as (default-value 'abbrev-mode). */);
5238 DEFVAR_BUFFER_DEFAULTS ("default-ctl-arrow",
5239 ctl_arrow,
5240 doc: /* Default value of `ctl-arrow' for buffers that do not override it.
5241 This is the same as (default-value 'ctl-arrow). */);
5243 DEFVAR_BUFFER_DEFAULTS ("default-enable-multibyte-characters",
5244 enable_multibyte_characters,
5245 doc: /* *Default value of `enable-multibyte-characters' for buffers not overriding it.
5246 This is the same as (default-value 'enable-multibyte-characters). */);
5248 DEFVAR_BUFFER_DEFAULTS ("default-buffer-file-coding-system",
5249 buffer_file_coding_system,
5250 doc: /* Default value of `buffer-file-coding-system' for buffers not overriding it.
5251 This is the same as (default-value 'buffer-file-coding-system). */);
5253 DEFVAR_BUFFER_DEFAULTS ("default-truncate-lines",
5254 truncate_lines,
5255 doc: /* Default value of `truncate-lines' for buffers that do not override it.
5256 This is the same as (default-value 'truncate-lines). */);
5258 DEFVAR_BUFFER_DEFAULTS ("default-fill-column",
5259 fill_column,
5260 doc: /* Default value of `fill-column' for buffers that do not override it.
5261 This is the same as (default-value 'fill-column). */);
5263 DEFVAR_BUFFER_DEFAULTS ("default-left-margin",
5264 left_margin,
5265 doc: /* Default value of `left-margin' for buffers that do not override it.
5266 This is the same as (default-value 'left-margin). */);
5268 DEFVAR_BUFFER_DEFAULTS ("default-tab-width",
5269 tab_width,
5270 doc: /* Default value of `tab-width' for buffers that do not override it.
5271 This is the same as (default-value 'tab-width). */);
5273 DEFVAR_BUFFER_DEFAULTS ("default-case-fold-search",
5274 case_fold_search,
5275 doc: /* Default value of `case-fold-search' for buffers that don't override it.
5276 This is the same as (default-value 'case-fold-search). */);
5278 DEFVAR_BUFFER_DEFAULTS ("default-left-margin-width",
5279 left_margin_cols,
5280 doc: /* Default value of `left-margin-width' for buffers that don't override it.
5281 This is the same as (default-value 'left-margin-width). */);
5283 DEFVAR_BUFFER_DEFAULTS ("default-right-margin-width",
5284 right_margin_cols,
5285 doc: /* Default value of `right-margin-width' for buffers that don't override it.
5286 This is the same as (default-value 'right-margin-width). */);
5288 DEFVAR_BUFFER_DEFAULTS ("default-left-fringe-width",
5289 left_fringe_width,
5290 doc: /* Default value of `left-fringe-width' for buffers that don't override it.
5291 This is the same as (default-value 'left-fringe-width). */);
5293 DEFVAR_BUFFER_DEFAULTS ("default-right-fringe-width",
5294 right_fringe_width,
5295 doc: /* Default value of `right-fringe-width' for buffers that don't override it.
5296 This is the same as (default-value 'right-fringe-width). */);
5298 DEFVAR_BUFFER_DEFAULTS ("default-fringes-outside-margins",
5299 fringes_outside_margins,
5300 doc: /* Default value of `fringes-outside-margins' for buffers that don't override it.
5301 This is the same as (default-value 'fringes-outside-margins). */);
5303 DEFVAR_BUFFER_DEFAULTS ("default-scroll-bar-width",
5304 scroll_bar_width,
5305 doc: /* Default value of `scroll-bar-width' for buffers that don't override it.
5306 This is the same as (default-value 'scroll-bar-width). */);
5308 DEFVAR_BUFFER_DEFAULTS ("default-vertical-scroll-bar",
5309 vertical_scroll_bar_type,
5310 doc: /* Default value of `vertical-scroll-bar' for buffers that don't override it.
5311 This is the same as (default-value 'vertical-scroll-bar). */);
5313 DEFVAR_BUFFER_DEFAULTS ("default-indicate-empty-lines",
5314 indicate_empty_lines,
5315 doc: /* Default value of `indicate-empty-lines' for buffers that don't override it.
5316 This is the same as (default-value 'indicate-empty-lines). */);
5318 DEFVAR_BUFFER_DEFAULTS ("default-indicate-buffer-boundaries",
5319 indicate_buffer_boundaries,
5320 doc: /* Default value of `indicate-buffer-boundaries' for buffers that don't override it.
5321 This is the same as (default-value 'indicate-buffer-boundaries). */);
5323 DEFVAR_BUFFER_DEFAULTS ("default-fringe-indicator-alist",
5324 fringe_indicator_alist,
5325 doc: /* Default value of `fringe-indicator-alist' for buffers that don't override it.
5326 This is the same as (default-value 'fringe-indicator-alist'). */);
5328 DEFVAR_BUFFER_DEFAULTS ("default-fringe-cursor-alist",
5329 fringe_cursor_alist,
5330 doc: /* Default value of `fringe-cursor-alist' for buffers that don't override it.
5331 This is the same as (default-value 'fringe-cursor-alist'). */);
5333 DEFVAR_BUFFER_DEFAULTS ("default-scroll-up-aggressively",
5334 scroll_up_aggressively,
5335 doc: /* Default value of `scroll-up-aggressively'.
5336 This value applies in buffers that don't have their own local values.
5337 This is the same as (default-value 'scroll-up-aggressively). */);
5339 DEFVAR_BUFFER_DEFAULTS ("default-scroll-down-aggressively",
5340 scroll_down_aggressively,
5341 doc: /* Default value of `scroll-down-aggressively'.
5342 This value applies in buffers that don't have their own local values.
5343 This is the same as (default-value 'scroll-down-aggressively). */);
5345 DEFVAR_PER_BUFFER ("header-line-format",
5346 &BVAR (current_buffer, header_line_format),
5347 Qnil,
5348 doc: /* Analogous to `mode-line-format', but controls the header line.
5349 The header line appears, optionally, at the top of a window;
5350 the mode line appears at the bottom. */);
5352 DEFVAR_PER_BUFFER ("mode-line-format", &BVAR (current_buffer, mode_line_format),
5353 Qnil,
5354 doc: /* Template for displaying mode line for current buffer.
5355 Each buffer has its own value of this variable.
5356 Value may be nil, a string, a symbol or a list or cons cell.
5357 A value of nil means don't display a mode line.
5358 For a symbol, its value is used (but it is ignored if t or nil).
5359 A string appearing directly as the value of a symbol is processed verbatim
5360 in that the %-constructs below are not recognized.
5361 Note that unless the symbol is marked as a `risky-local-variable', all
5362 properties in any strings, as well as all :eval and :propertize forms
5363 in the value of that symbol will be ignored.
5364 For a list of the form `(:eval FORM)', FORM is evaluated and the result
5365 is used as a mode line element. Be careful--FORM should not load any files,
5366 because that can cause an infinite recursion.
5367 For a list of the form `(:propertize ELT PROPS...)', ELT is displayed
5368 with the specified properties PROPS applied.
5369 For a list whose car is a symbol, the symbol's value is taken,
5370 and if that is non-nil, the cadr of the list is processed recursively.
5371 Otherwise, the caddr of the list (if there is one) is processed.
5372 For a list whose car is a string or list, each element is processed
5373 recursively and the results are effectively concatenated.
5374 For a list whose car is an integer, the cdr of the list is processed
5375 and padded (if the number is positive) or truncated (if negative)
5376 to the width specified by that number.
5377 A string is printed verbatim in the mode line except for %-constructs:
5378 (%-constructs are allowed when the string is the entire mode-line-format
5379 or when it is found in a cons-cell or a list)
5380 %b -- print buffer name. %f -- print visited file name.
5381 %F -- print frame name.
5382 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.
5383 %& is like %*, but ignore read-only-ness.
5384 % means buffer is read-only and * means it is modified.
5385 For a modified read-only buffer, %* gives % and %+ gives *.
5386 %s -- print process status. %l -- print the current line number.
5387 %c -- print the current column number (this makes editing slower).
5388 To make the column number update correctly in all cases,
5389 `column-number-mode' must be non-nil.
5390 %i -- print the size of the buffer.
5391 %I -- like %i, but use k, M, G, etc., to abbreviate.
5392 %p -- print percent of buffer above top of window, or Top, Bot or All.
5393 %P -- print percent of buffer above bottom of window, perhaps plus Top,
5394 or print Bottom or All.
5395 %n -- print Narrow if appropriate.
5396 %t -- visited file is text or binary (if OS supports this distinction).
5397 %z -- print mnemonics of keyboard, terminal, and buffer coding systems.
5398 %Z -- like %z, but including the end-of-line format.
5399 %e -- print error message about full memory.
5400 %@ -- print @ or hyphen. @ means that default-directory is on a
5401 remote machine.
5402 %[ -- print one [ for each recursive editing level. %] similar.
5403 %% -- print %. %- -- print infinitely many dashes.
5404 Decimal digits after the % specify field width to which to pad. */);
5406 DEFVAR_BUFFER_DEFAULTS ("default-major-mode", major_mode,
5407 doc: /* *Value of `major-mode' for new buffers. */);
5409 DEFVAR_PER_BUFFER ("major-mode", &BVAR (current_buffer, major_mode),
5410 make_number (Lisp_Symbol),
5411 doc: /* Symbol for current buffer's major mode.
5412 The default value (normally `fundamental-mode') affects new buffers.
5413 A value of nil means to use the current buffer's major mode, provided
5414 it is not marked as "special".
5416 When a mode is used by default, `find-file' switches to it before it
5417 reads the contents into the buffer and before it finishes setting up
5418 the buffer. Thus, the mode and its hooks should not expect certain
5419 variables such as `buffer-read-only' and `buffer-file-coding-system'
5420 to be set up. */);
5422 DEFVAR_PER_BUFFER ("mode-name", &BVAR (current_buffer, mode_name),
5423 Qnil,
5424 doc: /* Pretty name of current buffer's major mode.
5425 Usually a string, but can use any of the constructs for `mode-line-format',
5426 which see.
5427 Format with `format-mode-line' to produce a string value. */);
5429 DEFVAR_PER_BUFFER ("local-abbrev-table", &BVAR (current_buffer, abbrev_table), Qnil,
5430 doc: /* Local (mode-specific) abbrev table of current buffer. */);
5432 DEFVAR_PER_BUFFER ("abbrev-mode", &BVAR (current_buffer, abbrev_mode), Qnil,
5433 doc: /* Non-nil if Abbrev mode is enabled.
5434 Use the command `abbrev-mode' to change this variable. */);
5436 DEFVAR_PER_BUFFER ("case-fold-search", &BVAR (current_buffer, case_fold_search),
5437 Qnil,
5438 doc: /* *Non-nil if searches and matches should ignore case. */);
5440 DEFVAR_PER_BUFFER ("fill-column", &BVAR (current_buffer, fill_column),
5441 make_number (LISP_INT_TAG),
5442 doc: /* *Column beyond which automatic line-wrapping should happen.
5443 Interactively, you can set the buffer local value using \\[set-fill-column]. */);
5445 DEFVAR_PER_BUFFER ("left-margin", &BVAR (current_buffer, left_margin),
5446 make_number (LISP_INT_TAG),
5447 doc: /* *Column for the default `indent-line-function' to indent to.
5448 Linefeed indents to this column in Fundamental mode. */);
5450 DEFVAR_PER_BUFFER ("tab-width", &BVAR (current_buffer, tab_width),
5451 make_number (LISP_INT_TAG),
5452 doc: /* *Distance between tab stops (for display of tab characters), in columns.
5453 This should be an integer greater than zero. */);
5455 DEFVAR_PER_BUFFER ("ctl-arrow", &BVAR (current_buffer, ctl_arrow), Qnil,
5456 doc: /* *Non-nil means display control chars with uparrow.
5457 A value of nil means use backslash and octal digits.
5458 This variable does not apply to characters whose display is specified
5459 in the current display table (if there is one). */);
5461 DEFVAR_PER_BUFFER ("enable-multibyte-characters",
5462 &BVAR (current_buffer, enable_multibyte_characters),
5463 Qnil,
5464 doc: /* Non-nil means the buffer contents are regarded as multi-byte characters.
5465 Otherwise they are regarded as unibyte. This affects the display,
5466 file I/O and the behavior of various editing commands.
5468 This variable is buffer-local but you cannot set it directly;
5469 use the function `set-buffer-multibyte' to change a buffer's representation.
5470 See also Info node `(elisp)Text Representations'. */);
5471 XSYMBOL (intern_c_string ("enable-multibyte-characters"))->constant = 1;
5473 DEFVAR_PER_BUFFER ("buffer-file-coding-system",
5474 &BVAR (current_buffer, buffer_file_coding_system), Qnil,
5475 doc: /* Coding system to be used for encoding the buffer contents on saving.
5476 This variable applies to saving the buffer, and also to `write-region'
5477 and other functions that use `write-region'.
5478 It does not apply to sending output to subprocesses, however.
5480 If this is nil, the buffer is saved without any code conversion
5481 unless some coding system is specified in `file-coding-system-alist'
5482 for the buffer file.
5484 If the text to be saved cannot be encoded as specified by this variable,
5485 an alternative encoding is selected by `select-safe-coding-system', which see.
5487 The variable `coding-system-for-write', if non-nil, overrides this variable.
5489 This variable is never applied to a way of decoding a file while reading it. */);
5491 DEFVAR_PER_BUFFER ("bidi-display-reordering",
5492 &BVAR (current_buffer, bidi_display_reordering), Qnil,
5493 doc: /* Non-nil means reorder bidirectional text for display in the visual order. */);
5495 DEFVAR_PER_BUFFER ("bidi-paragraph-direction",
5496 &BVAR (current_buffer, bidi_paragraph_direction), Qnil,
5497 doc: /* *If non-nil, forces directionality of text paragraphs in the buffer.
5499 If this is nil (the default), the direction of each paragraph is
5500 determined by the first strong directional character of its text.
5501 The values of `right-to-left' and `left-to-right' override that.
5502 Any other value is treated as nil.
5504 This variable has no effect unless the buffer's value of
5505 \`bidi-display-reordering' is non-nil. */);
5507 DEFVAR_PER_BUFFER ("truncate-lines", &BVAR (current_buffer, truncate_lines), Qnil,
5508 doc: /* *Non-nil means do not display continuation lines.
5509 Instead, give each line of text just one screen line.
5511 Note that this is overridden by the variable
5512 `truncate-partial-width-windows' if that variable is non-nil
5513 and this buffer is not full-frame width.
5515 Minibuffers set this variable to nil. */);
5517 DEFVAR_PER_BUFFER ("word-wrap", &BVAR (current_buffer, word_wrap), Qnil,
5518 doc: /* *Non-nil means to use word-wrapping for continuation lines.
5519 When word-wrapping is on, continuation lines are wrapped at the space
5520 or tab character nearest to the right window edge.
5521 If nil, continuation lines are wrapped at the right screen edge.
5523 This variable has no effect if long lines are truncated (see
5524 `truncate-lines' and `truncate-partial-width-windows'). If you use
5525 word-wrapping, you might want to reduce the value of
5526 `truncate-partial-width-windows', since wrapping can make text readable
5527 in narrower windows. */);
5529 DEFVAR_PER_BUFFER ("default-directory", &BVAR (current_buffer, directory),
5530 make_number (Lisp_String),
5531 doc: /* Name of default directory of current buffer. Should end with slash.
5532 To interactively change the default directory, use command `cd'. */);
5534 DEFVAR_PER_BUFFER ("auto-fill-function", &BVAR (current_buffer, auto_fill_function),
5535 Qnil,
5536 doc: /* Function called (if non-nil) to perform auto-fill.
5537 It is called after self-inserting any character specified in
5538 the `auto-fill-chars' table.
5539 NOTE: This variable is not a hook;
5540 its value may not be a list of functions. */);
5542 DEFVAR_PER_BUFFER ("buffer-file-name", &BVAR (current_buffer, filename),
5543 make_number (Lisp_String),
5544 doc: /* Name of file visited in current buffer, or nil if not visiting a file. */);
5546 DEFVAR_PER_BUFFER ("buffer-file-truename", &BVAR (current_buffer, file_truename),
5547 make_number (Lisp_String),
5548 doc: /* Abbreviated truename of file visited in current buffer, or nil if none.
5549 The truename of a file is calculated by `file-truename'
5550 and then abbreviated with `abbreviate-file-name'. */);
5552 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
5553 &BVAR (current_buffer, auto_save_file_name),
5554 make_number (Lisp_String),
5555 doc: /* Name of file for auto-saving current buffer.
5556 If it is nil, that means don't auto-save this buffer. */);
5558 DEFVAR_PER_BUFFER ("buffer-read-only", &BVAR (current_buffer, read_only), Qnil,
5559 doc: /* Non-nil if this buffer is read-only. */);
5561 DEFVAR_PER_BUFFER ("buffer-backed-up", &BVAR (current_buffer, backed_up), Qnil,
5562 doc: /* Non-nil if this buffer's file has been backed up.
5563 Backing up is done before the first time the file is saved. */);
5565 DEFVAR_PER_BUFFER ("buffer-saved-size", &BVAR (current_buffer, save_length),
5566 make_number (LISP_INT_TAG),
5567 doc: /* Length of current buffer when last read in, saved or auto-saved.
5568 0 initially.
5569 -1 means auto-saving turned off until next real save.
5571 If you set this to -2, that means don't turn off auto-saving in this buffer
5572 if its text size shrinks. If you use `buffer-swap-text' on a buffer,
5573 you probably should set this to -2 in that buffer. */);
5575 DEFVAR_PER_BUFFER ("selective-display", &BVAR (current_buffer, selective_display),
5576 Qnil,
5577 doc: /* Non-nil enables selective display.
5578 An integer N as value means display only lines
5579 that start with less than N columns of space.
5580 A value of t means that the character ^M makes itself and
5581 all the rest of the line invisible; also, when saving the buffer
5582 in a file, save the ^M as a newline. */);
5584 #ifndef old
5585 DEFVAR_PER_BUFFER ("selective-display-ellipses",
5586 &BVAR (current_buffer, selective_display_ellipses),
5587 Qnil,
5588 doc: /* Non-nil means display ... on previous line when a line is invisible. */);
5589 #endif
5591 DEFVAR_PER_BUFFER ("overwrite-mode", &BVAR (current_buffer, overwrite_mode), Qnil,
5592 doc: /* Non-nil if self-insertion should replace existing text.
5593 The value should be one of `overwrite-mode-textual',
5594 `overwrite-mode-binary', or nil.
5595 If it is `overwrite-mode-textual', self-insertion still
5596 inserts at the end of a line, and inserts when point is before a tab,
5597 until the tab is filled in.
5598 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too. */);
5600 DEFVAR_PER_BUFFER ("buffer-display-table", &BVAR (current_buffer, display_table),
5601 Qnil,
5602 doc: /* Display table that controls display of the contents of current buffer.
5604 If this variable is nil, the value of `standard-display-table' is used.
5605 Each window can have its own, overriding display table, see
5606 `set-window-display-table' and `window-display-table'.
5608 The display table is a char-table created with `make-display-table'.
5609 A char-table is an array indexed by character codes. Normal array
5610 primitives `aref' and `aset' can be used to access elements of a char-table.
5612 Each of the char-table elements control how to display the corresponding
5613 text character: the element at index C in the table says how to display
5614 the character whose code is C. Each element should be a vector of
5615 characters or nil. The value nil means display the character in the
5616 default fashion; otherwise, the characters from the vector are delivered
5617 to the screen instead of the original character.
5619 For example, (aset buffer-display-table ?X [?Y]) tells Emacs
5620 to display a capital Y instead of each X character.
5622 In addition, a char-table has six extra slots to control the display of:
5624 the end of a truncated screen line (extra-slot 0, a single character);
5625 the end of a continued line (extra-slot 1, a single character);
5626 the escape character used to display character codes in octal
5627 (extra-slot 2, a single character);
5628 the character used as an arrow for control characters (extra-slot 3,
5629 a single character);
5630 the decoration indicating the presence of invisible lines (extra-slot 4,
5631 a vector of characters);
5632 the character used to draw the border between side-by-side windows
5633 (extra-slot 5, a single character).
5635 See also the functions `display-table-slot' and `set-display-table-slot'. */);
5637 DEFVAR_PER_BUFFER ("left-margin-width", &BVAR (current_buffer, left_margin_cols),
5638 Qnil,
5639 doc: /* *Width of left marginal area for display of a buffer.
5640 A value of nil means no marginal area. */);
5642 DEFVAR_PER_BUFFER ("right-margin-width", &BVAR (current_buffer, right_margin_cols),
5643 Qnil,
5644 doc: /* *Width of right marginal area for display of a buffer.
5645 A value of nil means no marginal area. */);
5647 DEFVAR_PER_BUFFER ("left-fringe-width", &BVAR (current_buffer, left_fringe_width),
5648 Qnil,
5649 doc: /* *Width of this buffer's left fringe (in pixels).
5650 A value of 0 means no left fringe is shown in this buffer's window.
5651 A value of nil means to use the left fringe width from the window's frame. */);
5653 DEFVAR_PER_BUFFER ("right-fringe-width", &BVAR (current_buffer, right_fringe_width),
5654 Qnil,
5655 doc: /* *Width of this buffer's right fringe (in pixels).
5656 A value of 0 means no right fringe is shown in this buffer's window.
5657 A value of nil means to use the right fringe width from the window's frame. */);
5659 DEFVAR_PER_BUFFER ("fringes-outside-margins", &BVAR (current_buffer, fringes_outside_margins),
5660 Qnil,
5661 doc: /* *Non-nil means to display fringes outside display margins.
5662 A value of nil means to display fringes between margins and buffer text. */);
5664 DEFVAR_PER_BUFFER ("scroll-bar-width", &BVAR (current_buffer, scroll_bar_width),
5665 Qnil,
5666 doc: /* *Width of this buffer's scroll bars in pixels.
5667 A value of nil means to use the scroll bar width from the window's frame. */);
5669 DEFVAR_PER_BUFFER ("vertical-scroll-bar", &BVAR (current_buffer, vertical_scroll_bar_type),
5670 Qnil,
5671 doc: /* *Position of this buffer's vertical scroll bar.
5672 The value takes effect whenever you tell a window to display this buffer;
5673 for instance, with `set-window-buffer' or when `display-buffer' displays it.
5675 A value of `left' or `right' means put the vertical scroll bar at that side
5676 of the window; a value of nil means don't show any vertical scroll bars.
5677 A value of t (the default) means do whatever the window's frame specifies. */);
5679 DEFVAR_PER_BUFFER ("indicate-empty-lines",
5680 &BVAR (current_buffer, indicate_empty_lines), Qnil,
5681 doc: /* *Visually indicate empty lines after the buffer end.
5682 If non-nil, a bitmap is displayed in the left fringe of a window on
5683 window-systems. */);
5685 DEFVAR_PER_BUFFER ("indicate-buffer-boundaries",
5686 &BVAR (current_buffer, indicate_buffer_boundaries), Qnil,
5687 doc: /* *Visually indicate buffer boundaries and scrolling.
5688 If non-nil, the first and last line of the buffer are marked in the fringe
5689 of a window on window-systems with angle bitmaps, or if the window can be
5690 scrolled, the top and bottom line of the window are marked with up and down
5691 arrow bitmaps.
5693 If value is a symbol `left' or `right', both angle and arrow bitmaps
5694 are displayed in the left or right fringe, resp. Any other value
5695 that doesn't look like an alist means display the angle bitmaps in
5696 the left fringe but no arrows.
5698 You can exercise more precise control by using an alist as the
5699 value. Each alist element (INDICATOR . POSITION) specifies
5700 where to show one of the indicators. INDICATOR is one of `top',
5701 `bottom', `up', `down', or t, which specifies the default position,
5702 and POSITION is one of `left', `right', or nil, meaning do not show
5703 this indicator.
5705 For example, ((top . left) (t . right)) places the top angle bitmap in
5706 left fringe, the bottom angle bitmap in right fringe, and both arrow
5707 bitmaps in right fringe. To show just the angle bitmaps in the left
5708 fringe, but no arrow bitmaps, use ((top . left) (bottom . left)). */);
5710 DEFVAR_PER_BUFFER ("fringe-indicator-alist",
5711 &BVAR (current_buffer, fringe_indicator_alist), Qnil,
5712 doc: /* *Mapping from logical to physical fringe indicator bitmaps.
5713 The value is an alist where each element (INDICATOR . BITMAPS)
5714 specifies the fringe bitmaps used to display a specific logical
5715 fringe indicator.
5717 INDICATOR specifies the logical indicator type which is one of the
5718 following symbols: `truncation' , `continuation', `overlay-arrow',
5719 `top', `bottom', `top-bottom', `up', `down', empty-line', or `unknown'.
5721 BITMAPS is a list of symbols (LEFT RIGHT [LEFT1 RIGHT1]) which specifies
5722 the actual bitmap shown in the left or right fringe for the logical
5723 indicator. LEFT and RIGHT are the bitmaps shown in the left and/or
5724 right fringe for the specific indicator. The LEFT1 or RIGHT1 bitmaps
5725 are used only for the `bottom' and `top-bottom' indicators when the
5726 last (only) line has no final newline. BITMAPS may also be a single
5727 symbol which is used in both left and right fringes. */);
5729 DEFVAR_PER_BUFFER ("fringe-cursor-alist",
5730 &BVAR (current_buffer, fringe_cursor_alist), Qnil,
5731 doc: /* *Mapping from logical to physical fringe cursor bitmaps.
5732 The value is an alist where each element (CURSOR . BITMAP)
5733 specifies the fringe bitmaps used to display a specific logical
5734 cursor type in the fringe.
5736 CURSOR specifies the logical cursor type which is one of the following
5737 symbols: `box' , `hollow', `bar', `hbar', or `hollow-small'. The last
5738 one is used to show a hollow cursor on narrow lines display lines
5739 where the normal hollow cursor will not fit.
5741 BITMAP is the corresponding fringe bitmap shown for the logical
5742 cursor type. */);
5744 DEFVAR_PER_BUFFER ("scroll-up-aggressively",
5745 &BVAR (current_buffer, scroll_up_aggressively), Qnil,
5746 doc: /* How far to scroll windows upward.
5747 If you move point off the bottom, the window scrolls automatically.
5748 This variable controls how far it scrolls. The value nil, the default,
5749 means scroll to center point. A fraction means scroll to put point
5750 that fraction of the window's height from the bottom of the window.
5751 When the value is 0.0, point goes at the bottom line, which in the
5752 simple case that you moved off with C-f means scrolling just one line.
5753 1.0 means point goes at the top, so that in that simple case, the
5754 window scrolls by a full window height. Meaningful values are
5755 between 0.0 and 1.0, inclusive. */);
5757 DEFVAR_PER_BUFFER ("scroll-down-aggressively",
5758 &BVAR (current_buffer, scroll_down_aggressively), Qnil,
5759 doc: /* How far to scroll windows downward.
5760 If you move point off the top, the window scrolls automatically.
5761 This variable controls how far it scrolls. The value nil, the default,
5762 means scroll to center point. A fraction means scroll to put point
5763 that fraction of the window's height from the top of the window.
5764 When the value is 0.0, point goes at the top line, which in the
5765 simple case that you moved off with C-b means scrolling just one line.
5766 1.0 means point goes at the bottom, so that in that simple case, the
5767 window scrolls by a full window height. Meaningful values are
5768 between 0.0 and 1.0, inclusive. */);
5770 /*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
5771 "Don't ask.");
5774 DEFVAR_LISP ("before-change-functions", Vbefore_change_functions,
5775 doc: /* List of functions to call before each text change.
5776 Two arguments are passed to each function: the positions of
5777 the beginning and end of the range of old text to be changed.
5778 \(For an insertion, the beginning and end are at the same place.)
5779 No information is given about the length of the text after the change.
5781 Buffer changes made while executing the `before-change-functions'
5782 don't call any before-change or after-change functions.
5783 That's because `inhibit-modification-hooks' is temporarily set non-nil.
5785 If an unhandled error happens in running these functions,
5786 the variable's value remains nil. That prevents the error
5787 from happening repeatedly and making Emacs nonfunctional. */);
5788 Vbefore_change_functions = Qnil;
5790 DEFVAR_LISP ("after-change-functions", Vafter_change_functions,
5791 doc: /* List of functions to call after each text change.
5792 Three arguments are passed to each function: the positions of
5793 the beginning and end of the range of changed text,
5794 and the length in bytes of the pre-change text replaced by that range.
5795 \(For an insertion, the pre-change length is zero;
5796 for a deletion, that length is the number of bytes deleted,
5797 and the post-change beginning and end are at the same place.)
5799 Buffer changes made while executing the `after-change-functions'
5800 don't call any before-change or after-change functions.
5801 That's because `inhibit-modification-hooks' is temporarily set non-nil.
5803 If an unhandled error happens in running these functions,
5804 the variable's value remains nil. That prevents the error
5805 from happening repeatedly and making Emacs nonfunctional. */);
5806 Vafter_change_functions = Qnil;
5808 DEFVAR_LISP ("first-change-hook", Vfirst_change_hook,
5809 doc: /* A list of functions to call before changing a buffer which is unmodified.
5810 The functions are run using the `run-hooks' function. */);
5811 Vfirst_change_hook = Qnil;
5813 DEFVAR_PER_BUFFER ("buffer-undo-list", &BVAR (current_buffer, undo_list), Qnil,
5814 doc: /* List of undo entries in current buffer.
5815 Recent changes come first; older changes follow newer.
5817 An entry (BEG . END) represents an insertion which begins at
5818 position BEG and ends at position END.
5820 An entry (TEXT . POSITION) represents the deletion of the string TEXT
5821 from (abs POSITION). If POSITION is positive, point was at the front
5822 of the text being deleted; if negative, point was at the end.
5824 An entry (t HIGH . LOW) indicates that the buffer previously had
5825 \"unmodified\" status. HIGH and LOW are the high and low 16-bit portions
5826 of the visited file's modification time, as of that time. If the
5827 modification time of the most recent save is different, this entry is
5828 obsolete.
5830 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property
5831 was modified between BEG and END. PROPERTY is the property name,
5832 and VALUE is the old value.
5834 An entry (apply FUN-NAME . ARGS) means undo the change with
5835 \(apply FUN-NAME ARGS).
5837 An entry (apply DELTA BEG END FUN-NAME . ARGS) supports selective undo
5838 in the active region. BEG and END is the range affected by this entry
5839 and DELTA is the number of bytes added or deleted in that range by
5840 this change.
5842 An entry (MARKER . DISTANCE) indicates that the marker MARKER
5843 was adjusted in position by the offset DISTANCE (an integer).
5845 An entry of the form POSITION indicates that point was at the buffer
5846 location given by the integer. Undoing an entry of this form places
5847 point at POSITION.
5849 Entries with value `nil' mark undo boundaries. The undo command treats
5850 the changes between two undo boundaries as a single step to be undone.
5852 If the value of the variable is t, undo information is not recorded. */);
5854 DEFVAR_PER_BUFFER ("mark-active", &BVAR (current_buffer, mark_active), Qnil,
5855 doc: /* Non-nil means the mark and region are currently active in this buffer. */);
5857 DEFVAR_PER_BUFFER ("cache-long-line-scans", &BVAR (current_buffer, cache_long_line_scans), Qnil,
5858 doc: /* Non-nil means that Emacs should use caches to handle long lines more quickly.
5860 Normally, the line-motion functions work by scanning the buffer for
5861 newlines. Columnar operations (like `move-to-column' and
5862 `compute-motion') also work by scanning the buffer, summing character
5863 widths as they go. This works well for ordinary text, but if the
5864 buffer's lines are very long (say, more than 500 characters), these
5865 motion functions will take longer to execute. Emacs may also take
5866 longer to update the display.
5868 If `cache-long-line-scans' is non-nil, these motion functions cache the
5869 results of their scans, and consult the cache to avoid rescanning
5870 regions of the buffer until the text is modified. The caches are most
5871 beneficial when they prevent the most searching---that is, when the
5872 buffer contains long lines and large regions of characters with the
5873 same, fixed screen width.
5875 When `cache-long-line-scans' is non-nil, processing short lines will
5876 become slightly slower (because of the overhead of consulting the
5877 cache), and the caches will use memory roughly proportional to the
5878 number of newlines and characters whose screen width varies.
5880 The caches require no explicit maintenance; their accuracy is
5881 maintained internally by the Emacs primitives. Enabling or disabling
5882 the cache should not affect the behavior of any of the motion
5883 functions; it should only affect their performance. */);
5885 DEFVAR_PER_BUFFER ("point-before-scroll", &BVAR (current_buffer, point_before_scroll), Qnil,
5886 doc: /* Value of point before the last series of scroll operations, or nil. */);
5888 DEFVAR_PER_BUFFER ("buffer-file-format", &BVAR (current_buffer, file_format), Qnil,
5889 doc: /* List of formats to use when saving this buffer.
5890 Formats are defined by `format-alist'. This variable is
5891 set when a file is visited. */);
5893 DEFVAR_PER_BUFFER ("buffer-auto-save-file-format",
5894 &BVAR (current_buffer, auto_save_file_format), Qnil,
5895 doc: /* *Format in which to write auto-save files.
5896 Should be a list of symbols naming formats that are defined in `format-alist'.
5897 If it is t, which is the default, auto-save files are written in the
5898 same format as a regular save would use. */);
5900 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
5901 &BVAR (current_buffer, invisibility_spec), Qnil,
5902 doc: /* Invisibility spec of this buffer.
5903 The default is t, which means that text is invisible
5904 if it has a non-nil `invisible' property.
5905 If the value is a list, a text character is invisible if its `invisible'
5906 property is an element in that list (or is a list with members in common).
5907 If an element is a cons cell of the form (PROP . ELLIPSIS),
5908 then characters with property value PROP are invisible,
5909 and they have an ellipsis as well if ELLIPSIS is non-nil. */);
5911 DEFVAR_PER_BUFFER ("buffer-display-count",
5912 &BVAR (current_buffer, display_count), Qnil,
5913 doc: /* A number incremented each time this buffer is displayed in a window.
5914 The function `set-window-buffer' increments it. */);
5916 DEFVAR_PER_BUFFER ("buffer-display-time",
5917 &BVAR (current_buffer, display_time), Qnil,
5918 doc: /* Time stamp updated each time this buffer is displayed in a window.
5919 The function `set-window-buffer' updates this variable
5920 to the value obtained by calling `current-time'.
5921 If the buffer has never been shown in a window, the value is nil. */);
5923 DEFVAR_LISP ("transient-mark-mode", Vtransient_mark_mode,
5924 doc: /* Non-nil if Transient Mark mode is enabled.
5925 See the command `transient-mark-mode' for a description of this minor mode.
5927 Non-nil also enables highlighting of the region whenever the mark is active.
5928 The variable `highlight-nonselected-windows' controls whether to highlight
5929 all windows or just the selected window.
5931 Lisp programs may give this variable certain special values:
5933 - A value of `lambda' enables Transient Mark mode temporarily.
5934 It is disabled again after any subsequent action that would
5935 normally deactivate the mark (e.g. buffer modification).
5937 - A value of (only . OLDVAL) enables Transient Mark mode
5938 temporarily. After any subsequent point motion command that is
5939 not shift-translated, or any other action that would normally
5940 deactivate the mark (e.g. buffer modification), the value of
5941 `transient-mark-mode' is set to OLDVAL. */);
5942 Vtransient_mark_mode = Qnil;
5944 DEFVAR_LISP ("inhibit-read-only", Vinhibit_read_only,
5945 doc: /* *Non-nil means disregard read-only status of buffers or characters.
5946 If the value is t, disregard `buffer-read-only' and all `read-only'
5947 text properties. If the value is a list, disregard `buffer-read-only'
5948 and disregard a `read-only' text property if the property value
5949 is a member of the list. */);
5950 Vinhibit_read_only = Qnil;
5952 DEFVAR_PER_BUFFER ("cursor-type", &BVAR (current_buffer, cursor_type), Qnil,
5953 doc: /* Cursor to use when this buffer is in the selected window.
5954 Values are interpreted as follows:
5956 t use the cursor specified for the frame
5957 nil don't display a cursor
5958 box display a filled box cursor
5959 hollow display a hollow box cursor
5960 bar display a vertical bar cursor with default width
5961 (bar . WIDTH) display a vertical bar cursor with width WIDTH
5962 hbar display a horizontal bar cursor with default height
5963 (hbar . HEIGHT) display a horizontal bar cursor with height HEIGHT
5964 ANYTHING ELSE display a hollow box cursor
5966 When the buffer is displayed in a non-selected window, the
5967 cursor's appearance is instead controlled by the variable
5968 `cursor-in-non-selected-windows'. */);
5970 DEFVAR_PER_BUFFER ("line-spacing",
5971 &BVAR (current_buffer, extra_line_spacing), Qnil,
5972 doc: /* Additional space to put between lines when displaying a buffer.
5973 The space is measured in pixels, and put below lines on graphic displays,
5974 see `display-graphic-p'.
5975 If value is a floating point number, it specifies the spacing relative
5976 to the default frame line height. A value of nil means add no extra space. */);
5978 DEFVAR_PER_BUFFER ("cursor-in-non-selected-windows",
5979 &BVAR (current_buffer, cursor_in_non_selected_windows), Qnil,
5980 doc: /* *Non-nil means show a cursor in non-selected windows.
5981 If nil, only shows a cursor in the selected window.
5982 If t, displays a cursor related to the usual cursor type
5983 \(a solid box becomes hollow, a bar becomes a narrower bar).
5984 You can also specify the cursor type as in the `cursor-type' variable.
5985 Use Custom to set this variable and update the display." */);
5987 DEFVAR_LISP ("kill-buffer-query-functions", Vkill_buffer_query_functions,
5988 doc: /* List of functions called with no args to query before killing a buffer.
5989 The buffer being killed will be current while the functions are running.
5990 If any of them returns nil, the buffer is not killed. */);
5991 Vkill_buffer_query_functions = Qnil;
5993 DEFVAR_LISP ("change-major-mode-hook", Vchange_major_mode_hook,
5994 doc: /* Normal hook run before changing the major mode of a buffer.
5995 The function `kill-all-local-variables' runs this before doing anything else. */);
5996 Vchange_major_mode_hook = Qnil;
5997 DEFSYM (Qchange_major_mode_hook, "change-major-mode-hook");
5999 DEFVAR_LISP ("buffer-list-update-hook", Vbuffer_list_update_hook,
6000 doc: /* Hook run when the buffer list changes.
6001 Functions running this hook are `get-buffer-create',
6002 `make-indirect-buffer', `rename-buffer', `kill-buffer',
6003 and `bury-buffer-internal'. */);
6004 Vbuffer_list_update_hook = Qnil;
6005 DEFSYM (Qbuffer_list_update_hook, "buffer-list-update-hook");
6007 defsubr (&Sbuffer_live_p);
6008 defsubr (&Sbuffer_list);
6009 defsubr (&Sget_buffer);
6010 defsubr (&Sget_file_buffer);
6011 defsubr (&Sget_buffer_create);
6012 defsubr (&Smake_indirect_buffer);
6013 defsubr (&Sgenerate_new_buffer_name);
6014 defsubr (&Sbuffer_name);
6015 /*defsubr (&Sbuffer_number);*/
6016 defsubr (&Sbuffer_file_name);
6017 defsubr (&Sbuffer_base_buffer);
6018 defsubr (&Sbuffer_local_value);
6019 defsubr (&Sbuffer_local_variables);
6020 defsubr (&Sbuffer_modified_p);
6021 defsubr (&Sset_buffer_modified_p);
6022 defsubr (&Sbuffer_modified_tick);
6023 defsubr (&Sbuffer_chars_modified_tick);
6024 defsubr (&Srename_buffer);
6025 defsubr (&Sother_buffer);
6026 defsubr (&Sbuffer_enable_undo);
6027 defsubr (&Skill_buffer);
6028 defsubr (&Sbury_buffer_internal);
6029 defsubr (&Sset_buffer_major_mode);
6030 defsubr (&Scurrent_buffer);
6031 defsubr (&Sset_buffer);
6032 defsubr (&Sbarf_if_buffer_read_only);
6033 defsubr (&Serase_buffer);
6034 defsubr (&Sbuffer_swap_text);
6035 defsubr (&Sset_buffer_multibyte);
6036 defsubr (&Skill_all_local_variables);
6038 defsubr (&Soverlayp);
6039 defsubr (&Smake_overlay);
6040 defsubr (&Sdelete_overlay);
6041 defsubr (&Smove_overlay);
6042 defsubr (&Soverlay_start);
6043 defsubr (&Soverlay_end);
6044 defsubr (&Soverlay_buffer);
6045 defsubr (&Soverlay_properties);
6046 defsubr (&Soverlays_at);
6047 defsubr (&Soverlays_in);
6048 defsubr (&Snext_overlay_change);
6049 defsubr (&Sprevious_overlay_change);
6050 defsubr (&Soverlay_recenter);
6051 defsubr (&Soverlay_lists);
6052 defsubr (&Soverlay_get);
6053 defsubr (&Soverlay_put);
6054 defsubr (&Srestore_buffer_modified_p);
6057 void
6058 keys_of_buffer (void)
6060 initial_define_key (control_x_map, 'b', "switch-to-buffer");
6061 initial_define_key (control_x_map, 'k', "kill-buffer");
6063 /* This must not be in syms_of_buffer, because Qdisabled is not
6064 initialized when that function gets called. */
6065 Fput (intern_c_string ("erase-buffer"), Qdisabled, Qt);