Make url-queue not kill a random buffer on error
[emacs.git] / src / buffer.c
bloba6f61a1936afc2fb8ca588141d0ec376b3ca3015
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))
275 return call2 (handler, Qget_file_buffer, filename);
277 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
279 buf = Fcdr (XCAR (tail));
280 if (!BUFFERP (buf)) continue;
281 if (!STRINGP (BVAR (XBUFFER (buf), filename))) continue;
282 tem = Fstring_equal (BVAR (XBUFFER (buf), filename), filename);
283 if (!NILP (tem))
284 return buf;
286 return Qnil;
289 Lisp_Object
290 get_truename_buffer (register Lisp_Object filename)
292 register Lisp_Object tail, buf, tem;
294 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
296 buf = Fcdr (XCAR (tail));
297 if (!BUFFERP (buf)) continue;
298 if (!STRINGP (BVAR (XBUFFER (buf), file_truename))) continue;
299 tem = Fstring_equal (BVAR (XBUFFER (buf), file_truename), filename);
300 if (!NILP (tem))
301 return buf;
303 return Qnil;
306 DEFUN ("get-buffer-create", Fget_buffer_create, Sget_buffer_create, 1, 1, 0,
307 doc: /* Return the buffer specified by BUFFER-OR-NAME, creating a new one if needed.
308 If BUFFER-OR-NAME is a string and a live buffer with that name exists,
309 return that buffer. If no such buffer exists, create a new buffer with
310 that name and return it. If BUFFER-OR-NAME starts with a space, the new
311 buffer does not keep undo information.
313 If BUFFER-OR-NAME is a buffer instead of a string, return it as given,
314 even if it is dead. The return value is never nil. */)
315 (register Lisp_Object buffer_or_name)
317 register Lisp_Object buffer, name;
318 register struct buffer *b;
320 buffer = Fget_buffer (buffer_or_name);
321 if (!NILP (buffer))
322 return buffer;
324 if (SCHARS (buffer_or_name) == 0)
325 error ("Empty string for buffer name is not allowed");
327 b = allocate_buffer ();
329 /* An ordinary buffer uses its own struct buffer_text. */
330 b->text = &b->own_text;
331 b->base_buffer = 0;
333 BUF_GAP_SIZE (b) = 20;
334 BLOCK_INPUT;
335 /* We allocate extra 1-byte at the tail and keep it always '\0' for
336 anchoring a search. */
337 alloc_buffer_text (b, BUF_GAP_SIZE (b) + 1);
338 UNBLOCK_INPUT;
339 if (! BUF_BEG_ADDR (b))
340 buffer_memory_full (BUF_GAP_SIZE (b) + 1);
342 b->pt = BEG;
343 b->begv = BEG;
344 b->zv = BEG;
345 b->pt_byte = BEG_BYTE;
346 b->begv_byte = BEG_BYTE;
347 b->zv_byte = BEG_BYTE;
349 BUF_GPT (b) = BEG;
350 BUF_GPT_BYTE (b) = BEG_BYTE;
352 BUF_Z (b) = BEG;
353 BUF_Z_BYTE (b) = BEG_BYTE;
354 BUF_MODIFF (b) = 1;
355 BUF_CHARS_MODIFF (b) = 1;
356 BUF_OVERLAY_MODIFF (b) = 1;
357 BUF_SAVE_MODIFF (b) = 1;
358 BUF_INTERVALS (b) = 0;
359 BUF_UNCHANGED_MODIFIED (b) = 1;
360 BUF_OVERLAY_UNCHANGED_MODIFIED (b) = 1;
361 BUF_END_UNCHANGED (b) = 0;
362 BUF_BEG_UNCHANGED (b) = 0;
363 *(BUF_GPT_ADDR (b)) = *(BUF_Z_ADDR (b)) = 0; /* Put an anchor '\0'. */
364 b->text->inhibit_shrinking = 0;
366 b->newline_cache = 0;
367 b->width_run_cache = 0;
368 BVAR (b, width_table) = Qnil;
369 b->prevent_redisplay_optimizations_p = 1;
371 /* Put this on the chain of all buffers including killed ones. */
372 b->header.next.buffer = all_buffers;
373 all_buffers = b;
375 /* An ordinary buffer normally doesn't need markers
376 to handle BEGV and ZV. */
377 BVAR (b, pt_marker) = Qnil;
378 BVAR (b, begv_marker) = Qnil;
379 BVAR (b, zv_marker) = Qnil;
381 name = Fcopy_sequence (buffer_or_name);
382 STRING_SET_INTERVALS (name, NULL_INTERVAL);
383 BVAR (b, name) = name;
385 BVAR (b, undo_list) = (SREF (name, 0) != ' ') ? Qnil : Qt;
387 reset_buffer (b);
388 reset_buffer_local_variables (b, 1);
390 BVAR (b, mark) = Fmake_marker ();
391 BUF_MARKERS (b) = NULL;
392 BVAR (b, name) = name;
394 /* Put this in the alist of all live buffers. */
395 XSETBUFFER (buffer, b);
396 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buffer), Qnil));
397 /* And run buffer-list-update-hook. */
398 if (!NILP (Vrun_hooks))
399 call1 (Vrun_hooks, Qbuffer_list_update_hook);
401 /* An error in calling the function here (should someone redefine it)
402 can lead to infinite regress until you run out of stack. rms
403 says that's not worth protecting against. */
404 if (!NILP (Ffboundp (Qucs_set_table_for_input)))
405 /* buffer is on buffer-alist, so no gcpro. */
406 call1 (Qucs_set_table_for_input, buffer);
408 return buffer;
412 /* Return a list of overlays which is a copy of the overlay list
413 LIST, but for buffer B. */
415 static struct Lisp_Overlay *
416 copy_overlays (struct buffer *b, struct Lisp_Overlay *list)
418 Lisp_Object buffer;
419 struct Lisp_Overlay *result = NULL, *tail = NULL;
421 XSETBUFFER (buffer, b);
423 for (; list; list = list->next)
425 Lisp_Object overlay, start, end, old_overlay;
426 EMACS_INT charpos;
428 XSETMISC (old_overlay, list);
429 charpos = marker_position (OVERLAY_START (old_overlay));
430 start = Fmake_marker ();
431 Fset_marker (start, make_number (charpos), buffer);
432 XMARKER (start)->insertion_type
433 = XMARKER (OVERLAY_START (old_overlay))->insertion_type;
435 charpos = marker_position (OVERLAY_END (old_overlay));
436 end = Fmake_marker ();
437 Fset_marker (end, make_number (charpos), buffer);
438 XMARKER (end)->insertion_type
439 = XMARKER (OVERLAY_END (old_overlay))->insertion_type;
441 overlay = allocate_misc ();
442 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
443 OVERLAY_START (overlay) = start;
444 OVERLAY_END (overlay) = end;
445 OVERLAY_PLIST (overlay) = Fcopy_sequence (OVERLAY_PLIST (old_overlay));
446 XOVERLAY (overlay)->next = NULL;
448 if (tail)
449 tail = tail->next = XOVERLAY (overlay);
450 else
451 result = tail = XOVERLAY (overlay);
454 return result;
458 /* Clone per-buffer values of buffer FROM.
460 Buffer TO gets the same per-buffer values as FROM, with the
461 following exceptions: (1) TO's name is left untouched, (2) markers
462 are copied and made to refer to TO, and (3) overlay lists are
463 copied. */
465 static void
466 clone_per_buffer_values (struct buffer *from, struct buffer *to)
468 Lisp_Object to_buffer;
469 int offset;
471 XSETBUFFER (to_buffer, to);
473 /* buffer-local Lisp variables start at `undo_list',
474 tho only the ones from `name' on are GC'd normally. */
475 for (offset = PER_BUFFER_VAR_OFFSET (FIRST_FIELD_PER_BUFFER);
476 offset <= PER_BUFFER_VAR_OFFSET (LAST_FIELD_PER_BUFFER);
477 offset += sizeof (Lisp_Object))
479 Lisp_Object obj;
481 /* Don't touch the `name' which should be unique for every buffer. */
482 if (offset == PER_BUFFER_VAR_OFFSET (name))
483 continue;
485 obj = PER_BUFFER_VALUE (from, offset);
486 if (MARKERP (obj) && XMARKER (obj)->buffer == from)
488 struct Lisp_Marker *m = XMARKER (obj);
489 obj = Fmake_marker ();
490 XMARKER (obj)->insertion_type = m->insertion_type;
491 set_marker_both (obj, to_buffer, m->charpos, m->bytepos);
494 PER_BUFFER_VALUE (to, offset) = obj;
497 memcpy (to->local_flags, from->local_flags, sizeof to->local_flags);
499 to->overlays_before = copy_overlays (to, from->overlays_before);
500 to->overlays_after = copy_overlays (to, from->overlays_after);
502 /* Get (a copy of) the alist of Lisp-level local variables of FROM
503 and install that in TO. */
504 BVAR (to, local_var_alist) = buffer_lisp_local_variables (from);
508 /* If buffer B has markers to record PT, BEGV and ZV when it is not
509 current, update these markers. */
511 static void
512 record_buffer_markers (struct buffer *b)
514 if (! NILP (BVAR (b, pt_marker)))
516 Lisp_Object buffer;
518 eassert (!NILP (BVAR (b, begv_marker)));
519 eassert (!NILP (BVAR (b, zv_marker)));
521 XSETBUFFER (buffer, b);
522 set_marker_both (BVAR (b, pt_marker), buffer, b->pt, b->pt_byte);
523 set_marker_both (BVAR (b, begv_marker), buffer, b->begv, b->begv_byte);
524 set_marker_both (BVAR (b, zv_marker), buffer, b->zv, b->zv_byte);
529 /* If buffer B has markers to record PT, BEGV and ZV when it is not
530 current, fetch these values into B->begv etc. */
532 static void
533 fetch_buffer_markers (struct buffer *b)
535 if (! NILP (BVAR (b, pt_marker)))
537 Lisp_Object m;
539 eassert (!NILP (BVAR (b, begv_marker)));
540 eassert (!NILP (BVAR (b, zv_marker)));
542 m = BVAR (b, pt_marker);
543 SET_BUF_PT_BOTH (b, marker_position (m), marker_byte_position (m));
545 m = BVAR (b, begv_marker);
546 SET_BUF_BEGV_BOTH (b, marker_position (m), marker_byte_position (m));
548 m = BVAR (b, zv_marker);
549 SET_BUF_ZV_BOTH (b, marker_position (m), marker_byte_position (m));
554 DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer,
555 2, 3,
556 "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
557 doc: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
558 BASE-BUFFER should be a live buffer, or the name of an existing buffer.
559 NAME should be a string which is not the name of an existing buffer.
560 Optional argument CLONE non-nil means preserve BASE-BUFFER's state,
561 such as major and minor modes, in the indirect buffer.
562 CLONE nil means the indirect buffer's state is reset to default values. */)
563 (Lisp_Object base_buffer, Lisp_Object name, Lisp_Object clone)
565 Lisp_Object buf, tem;
566 struct buffer *b;
568 CHECK_STRING (name);
569 buf = Fget_buffer (name);
570 if (!NILP (buf))
571 error ("Buffer name `%s' is in use", SDATA (name));
573 tem = base_buffer;
574 base_buffer = Fget_buffer (base_buffer);
575 if (NILP (base_buffer))
576 error ("No such buffer: `%s'", SDATA (tem));
577 if (NILP (BVAR (XBUFFER (base_buffer), name)))
578 error ("Base buffer has been killed");
580 if (SCHARS (name) == 0)
581 error ("Empty string for buffer name is not allowed");
583 b = allocate_buffer ();
585 b->base_buffer = (XBUFFER (base_buffer)->base_buffer
586 ? XBUFFER (base_buffer)->base_buffer
587 : XBUFFER (base_buffer));
589 /* Use the base buffer's text object. */
590 b->text = b->base_buffer->text;
592 b->pt = b->base_buffer->pt;
593 b->begv = b->base_buffer->begv;
594 b->zv = b->base_buffer->zv;
595 b->pt_byte = b->base_buffer->pt_byte;
596 b->begv_byte = b->base_buffer->begv_byte;
597 b->zv_byte = b->base_buffer->zv_byte;
599 b->newline_cache = 0;
600 b->width_run_cache = 0;
601 BVAR (b, width_table) = Qnil;
603 /* Put this on the chain of all buffers including killed ones. */
604 b->header.next.buffer = all_buffers;
605 all_buffers = b;
607 name = Fcopy_sequence (name);
608 STRING_SET_INTERVALS (name, NULL_INTERVAL);
609 BVAR (b, name) = name;
611 reset_buffer (b);
612 reset_buffer_local_variables (b, 1);
614 /* Put this in the alist of all live buffers. */
615 XSETBUFFER (buf, b);
616 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
618 BVAR (b, mark) = Fmake_marker ();
619 BVAR (b, name) = name;
621 /* The multibyte status belongs to the base buffer. */
622 BVAR (b, enable_multibyte_characters) = BVAR (b->base_buffer, enable_multibyte_characters);
624 /* Make sure the base buffer has markers for its narrowing. */
625 if (NILP (BVAR (b->base_buffer, pt_marker)))
627 eassert (NILP (BVAR (b->base_buffer, begv_marker)));
628 eassert (NILP (BVAR (b->base_buffer, zv_marker)));
630 BVAR (b->base_buffer, pt_marker) = Fmake_marker ();
631 set_marker_both (BVAR (b->base_buffer, pt_marker), base_buffer,
632 b->base_buffer->pt,
633 b->base_buffer->pt_byte);
635 BVAR (b->base_buffer, begv_marker) = Fmake_marker ();
636 set_marker_both (BVAR (b->base_buffer, begv_marker), base_buffer,
637 b->base_buffer->begv,
638 b->base_buffer->begv_byte);
640 BVAR (b->base_buffer, zv_marker) = Fmake_marker ();
641 set_marker_both (BVAR (b->base_buffer, zv_marker), base_buffer,
642 b->base_buffer->zv,
643 b->base_buffer->zv_byte);
644 XMARKER (BVAR (b->base_buffer, zv_marker))->insertion_type = 1;
647 if (NILP (clone))
649 /* Give the indirect buffer markers for its narrowing. */
650 BVAR (b, pt_marker) = Fmake_marker ();
651 set_marker_both (BVAR (b, pt_marker), buf, b->pt, b->pt_byte);
652 BVAR (b, begv_marker) = Fmake_marker ();
653 set_marker_both (BVAR (b, begv_marker), buf, b->begv, b->begv_byte);
654 BVAR (b, zv_marker) = Fmake_marker ();
655 set_marker_both (BVAR (b, zv_marker), buf, b->zv, b->zv_byte);
656 XMARKER (BVAR (b, zv_marker))->insertion_type = 1;
658 else
660 struct buffer *old_b = current_buffer;
662 clone_per_buffer_values (b->base_buffer, b);
663 BVAR (b, filename) = Qnil;
664 BVAR (b, file_truename) = Qnil;
665 BVAR (b, display_count) = make_number (0);
666 BVAR (b, backed_up) = Qnil;
667 BVAR (b, auto_save_file_name) = Qnil;
668 set_buffer_internal_1 (b);
669 Fset (intern ("buffer-save-without-query"), Qnil);
670 Fset (intern ("buffer-file-number"), Qnil);
671 Fset (intern ("buffer-stale-function"), Qnil);
672 set_buffer_internal_1 (old_b);
675 /* Run buffer-list-update-hook. */
676 if (!NILP (Vrun_hooks))
677 call1 (Vrun_hooks, Qbuffer_list_update_hook);
679 return buf;
682 void
683 delete_all_overlays (struct buffer *b)
685 Lisp_Object overlay;
687 /* `reset_buffer' blindly sets the list of overlays to NULL, so we
688 have to empty the list, otherwise we end up with overlays that
689 think they belong to this buffer while the buffer doesn't know about
690 them any more. */
691 while (b->overlays_before)
693 XSETMISC (overlay, b->overlays_before);
694 Fdelete_overlay (overlay);
696 while (b->overlays_after)
698 XSETMISC (overlay, b->overlays_after);
699 Fdelete_overlay (overlay);
701 eassert (b->overlays_before == NULL);
702 eassert (b->overlays_after == NULL);
705 /* Reinitialize everything about a buffer except its name and contents
706 and local variables.
707 If called on an already-initialized buffer, the list of overlays
708 should be deleted before calling this function, otherwise we end up
709 with overlays that claim to belong to the buffer but the buffer
710 claims it doesn't belong to it. */
712 void
713 reset_buffer (register struct buffer *b)
715 BVAR (b, filename) = Qnil;
716 BVAR (b, file_truename) = Qnil;
717 BVAR (b, directory) = (current_buffer) ? BVAR (current_buffer, directory) : Qnil;
718 b->modtime = 0;
719 b->modtime_size = -1;
720 XSETFASTINT (BVAR (b, save_length), 0);
721 b->last_window_start = 1;
722 /* It is more conservative to start out "changed" than "unchanged". */
723 b->clip_changed = 0;
724 b->prevent_redisplay_optimizations_p = 1;
725 BVAR (b, backed_up) = Qnil;
726 BUF_AUTOSAVE_MODIFF (b) = 0;
727 b->auto_save_failure_time = 0;
728 BVAR (b, auto_save_file_name) = Qnil;
729 BVAR (b, read_only) = Qnil;
730 b->overlays_before = NULL;
731 b->overlays_after = NULL;
732 b->overlay_center = BEG;
733 BVAR (b, mark_active) = Qnil;
734 BVAR (b, point_before_scroll) = Qnil;
735 BVAR (b, file_format) = Qnil;
736 BVAR (b, auto_save_file_format) = Qt;
737 BVAR (b, last_selected_window) = Qnil;
738 XSETINT (BVAR (b, display_count), 0);
739 BVAR (b, display_time) = Qnil;
740 BVAR (b, enable_multibyte_characters) = BVAR (&buffer_defaults, enable_multibyte_characters);
741 BVAR (b, cursor_type) = BVAR (&buffer_defaults, cursor_type);
742 BVAR (b, extra_line_spacing) = BVAR (&buffer_defaults, extra_line_spacing);
744 b->display_error_modiff = 0;
747 /* Reset buffer B's local variables info.
748 Don't use this on a buffer that has already been in use;
749 it does not treat permanent locals consistently.
750 Instead, use Fkill_all_local_variables.
752 If PERMANENT_TOO is 1, then we reset permanent
753 buffer-local variables. If PERMANENT_TOO is 0,
754 we preserve those. */
756 static void
757 reset_buffer_local_variables (register struct buffer *b, int permanent_too)
759 register int offset;
760 int i;
762 /* Reset the major mode to Fundamental, together with all the
763 things that depend on the major mode.
764 default-major-mode is handled at a higher level.
765 We ignore it here. */
766 BVAR (b, major_mode) = Qfundamental_mode;
767 BVAR (b, keymap) = Qnil;
768 BVAR (b, mode_name) = QSFundamental;
769 BVAR (b, minor_modes) = Qnil;
771 /* If the standard case table has been altered and invalidated,
772 fix up its insides first. */
773 if (! (CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[0])
774 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[1])
775 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[2])))
776 Fset_standard_case_table (Vascii_downcase_table);
778 BVAR (b, downcase_table) = Vascii_downcase_table;
779 BVAR (b, upcase_table) = XCHAR_TABLE (Vascii_downcase_table)->extras[0];
780 BVAR (b, case_canon_table) = XCHAR_TABLE (Vascii_downcase_table)->extras[1];
781 BVAR (b, case_eqv_table) = XCHAR_TABLE (Vascii_downcase_table)->extras[2];
782 BVAR (b, invisibility_spec) = Qt;
784 /* Reset all (or most) per-buffer variables to their defaults. */
785 if (permanent_too)
786 BVAR (b, local_var_alist) = Qnil;
787 else
789 Lisp_Object tmp, prop, last = Qnil;
790 for (tmp = BVAR (b, local_var_alist); CONSP (tmp); tmp = XCDR (tmp))
791 if (!NILP (prop = Fget (XCAR (XCAR (tmp)), Qpermanent_local)))
793 /* If permanent-local, keep it. */
794 last = tmp;
795 if (EQ (prop, Qpermanent_local_hook))
797 /* This is a partially permanent hook variable.
798 Preserve only the elements that want to be preserved. */
799 Lisp_Object list, newlist;
800 list = XCDR (XCAR (tmp));
801 if (!CONSP (list))
802 newlist = list;
803 else
804 for (newlist = Qnil; CONSP (list); list = XCDR (list))
806 Lisp_Object elt = XCAR (list);
807 /* Preserve element ELT if it's t,
808 if it is a function with a `permanent-local-hook' property,
809 or if it's not a symbol. */
810 if (! SYMBOLP (elt)
811 || EQ (elt, Qt)
812 || !NILP (Fget (elt, Qpermanent_local_hook)))
813 newlist = Fcons (elt, newlist);
815 XSETCDR (XCAR (tmp), Fnreverse (newlist));
818 /* Delete this local variable. */
819 else if (NILP (last))
820 BVAR (b, local_var_alist) = XCDR (tmp);
821 else
822 XSETCDR (last, XCDR (tmp));
825 for (i = 0; i < last_per_buffer_idx; ++i)
826 if (permanent_too || buffer_permanent_local_flags[i] == 0)
827 SET_PER_BUFFER_VALUE_P (b, i, 0);
829 /* For each slot that has a default value,
830 copy that into the slot. */
832 /* buffer-local Lisp variables start at `undo_list',
833 tho only the ones from `name' on are GC'd normally. */
834 for (offset = PER_BUFFER_VAR_OFFSET (FIRST_FIELD_PER_BUFFER);
835 offset <= PER_BUFFER_VAR_OFFSET (LAST_FIELD_PER_BUFFER);
836 offset += sizeof (Lisp_Object))
838 int idx = PER_BUFFER_IDX (offset);
839 if ((idx > 0
840 && (permanent_too
841 || buffer_permanent_local_flags[idx] == 0)))
842 PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
846 /* We split this away from generate-new-buffer, because rename-buffer
847 and set-visited-file-name ought to be able to use this to really
848 rename the buffer properly. */
850 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name,
851 Sgenerate_new_buffer_name, 1, 2, 0,
852 doc: /* Return a string that is the name of no existing buffer based on NAME.
853 If there is no live buffer named NAME, then return NAME.
854 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
855 \(starting at 2) until an unused name is found, and then return that name.
856 Optional second argument IGNORE specifies a name that is okay to use (if
857 it is in the sequence to be tried) even if a buffer with that name exists. */)
858 (register Lisp_Object name, Lisp_Object ignore)
860 register Lisp_Object gentemp, tem;
861 EMACS_INT count;
862 char number[INT_BUFSIZE_BOUND (EMACS_INT) + sizeof "<>"];
864 CHECK_STRING (name);
866 tem = Fstring_equal (name, ignore);
867 if (!NILP (tem))
868 return name;
869 tem = Fget_buffer (name);
870 if (NILP (tem))
871 return name;
873 count = 1;
874 while (1)
876 sprintf (number, "<%"pI"d>", ++count);
877 gentemp = concat2 (name, build_string (number));
878 tem = Fstring_equal (gentemp, ignore);
879 if (!NILP (tem))
880 return gentemp;
881 tem = Fget_buffer (gentemp);
882 if (NILP (tem))
883 return gentemp;
888 DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
889 doc: /* Return the name of BUFFER, as a string.
890 BUFFER defaults to the current buffer.
891 Return nil if BUFFER has been killed. */)
892 (register Lisp_Object buffer)
894 if (NILP (buffer))
895 return BVAR (current_buffer, name);
896 CHECK_BUFFER (buffer);
897 return BVAR (XBUFFER (buffer), name);
900 DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
901 doc: /* Return name of file BUFFER is visiting, or nil if none.
902 No argument or nil as argument means use the current buffer. */)
903 (register Lisp_Object buffer)
905 if (NILP (buffer))
906 return BVAR (current_buffer, filename);
907 CHECK_BUFFER (buffer);
908 return BVAR (XBUFFER (buffer), filename);
911 DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
912 0, 1, 0,
913 doc: /* Return the base buffer of indirect buffer BUFFER.
914 If BUFFER is not indirect, return nil.
915 BUFFER defaults to the current buffer. */)
916 (register Lisp_Object buffer)
918 struct buffer *base;
919 Lisp_Object base_buffer;
921 if (NILP (buffer))
922 base = current_buffer->base_buffer;
923 else
925 CHECK_BUFFER (buffer);
926 base = XBUFFER (buffer)->base_buffer;
929 if (! base)
930 return Qnil;
931 XSETBUFFER (base_buffer, base);
932 return base_buffer;
935 DEFUN ("buffer-local-value", Fbuffer_local_value,
936 Sbuffer_local_value, 2, 2, 0,
937 doc: /* Return the value of VARIABLE in BUFFER.
938 If VARIABLE does not have a buffer-local binding in BUFFER, the value
939 is the default binding of the variable. */)
940 (register Lisp_Object variable, register Lisp_Object buffer)
942 register struct buffer *buf;
943 register Lisp_Object result;
944 struct Lisp_Symbol *sym;
946 CHECK_SYMBOL (variable);
947 CHECK_BUFFER (buffer);
948 buf = XBUFFER (buffer);
949 sym = XSYMBOL (variable);
951 start:
952 switch (sym->redirect)
954 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
955 case SYMBOL_PLAINVAL: result = SYMBOL_VAL (sym); break;
956 case SYMBOL_LOCALIZED:
957 { /* Look in local_var_alist. */
958 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
959 XSETSYMBOL (variable, sym); /* Update In case of aliasing. */
960 result = Fassoc (variable, BVAR (buf, local_var_alist));
961 if (!NILP (result))
963 if (blv->fwd)
964 { /* What binding is loaded right now? */
965 Lisp_Object current_alist_element = blv->valcell;
967 /* The value of the currently loaded binding is not
968 stored in it, but rather in the realvalue slot.
969 Store that value into the binding it belongs to
970 in case that is the one we are about to use. */
972 XSETCDR (current_alist_element,
973 do_symval_forwarding (blv->fwd));
975 /* Now get the (perhaps updated) value out of the binding. */
976 result = XCDR (result);
978 else
979 result = Fdefault_value (variable);
980 break;
982 case SYMBOL_FORWARDED:
984 union Lisp_Fwd *fwd = SYMBOL_FWD (sym);
985 if (BUFFER_OBJFWDP (fwd))
986 result = PER_BUFFER_VALUE (buf, XBUFFER_OBJFWD (fwd)->offset);
987 else
988 result = Fdefault_value (variable);
989 break;
991 default: abort ();
994 if (!EQ (result, Qunbound))
995 return result;
997 xsignal1 (Qvoid_variable, variable);
1000 /* Return an alist of the Lisp-level buffer-local bindings of
1001 buffer BUF. That is, don't include the variables maintained
1002 in special slots in the buffer object. */
1004 static Lisp_Object
1005 buffer_lisp_local_variables (struct buffer *buf)
1007 Lisp_Object result = Qnil;
1008 register Lisp_Object tail;
1009 for (tail = BVAR (buf, local_var_alist); CONSP (tail); tail = XCDR (tail))
1011 Lisp_Object val, elt;
1013 elt = XCAR (tail);
1015 /* Reference each variable in the alist in buf.
1016 If inquiring about the current buffer, this gets the current values,
1017 so store them into the alist so the alist is up to date.
1018 If inquiring about some other buffer, this swaps out any values
1019 for that buffer, making the alist up to date automatically. */
1020 val = find_symbol_value (XCAR (elt));
1021 /* Use the current buffer value only if buf is the current buffer. */
1022 if (buf != current_buffer)
1023 val = XCDR (elt);
1025 result = Fcons (EQ (val, Qunbound)
1026 ? XCAR (elt)
1027 : Fcons (XCAR (elt), val),
1028 result);
1031 return result;
1034 DEFUN ("buffer-local-variables", Fbuffer_local_variables,
1035 Sbuffer_local_variables, 0, 1, 0,
1036 doc: /* Return an alist of variables that are buffer-local in BUFFER.
1037 Most elements look like (SYMBOL . VALUE), describing one variable.
1038 For a symbol that is locally unbound, just the symbol appears in the value.
1039 Note that storing new VALUEs in these elements doesn't change the variables.
1040 No argument or nil as argument means use current buffer as BUFFER. */)
1041 (register Lisp_Object buffer)
1043 register struct buffer *buf;
1044 register Lisp_Object result;
1046 if (NILP (buffer))
1047 buf = current_buffer;
1048 else
1050 CHECK_BUFFER (buffer);
1051 buf = XBUFFER (buffer);
1054 result = buffer_lisp_local_variables (buf);
1056 /* Add on all the variables stored in special slots. */
1058 int offset, idx;
1060 /* buffer-local Lisp variables start at `undo_list',
1061 tho only the ones from `name' on are GC'd normally. */
1062 for (offset = PER_BUFFER_VAR_OFFSET (FIRST_FIELD_PER_BUFFER);
1063 offset <= PER_BUFFER_VAR_OFFSET (LAST_FIELD_PER_BUFFER);
1064 /* sizeof EMACS_INT == sizeof Lisp_Object */
1065 offset += (sizeof (EMACS_INT)))
1067 idx = PER_BUFFER_IDX (offset);
1068 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
1069 && SYMBOLP (PER_BUFFER_SYMBOL (offset)))
1071 Lisp_Object sym = PER_BUFFER_SYMBOL (offset);
1072 Lisp_Object val = PER_BUFFER_VALUE (buf, offset);
1073 result = Fcons (EQ (val, Qunbound) ? sym : Fcons (sym, val),
1074 result);
1079 return result;
1082 DEFUN ("buffer-modified-p", Fbuffer_modified_p, Sbuffer_modified_p,
1083 0, 1, 0,
1084 doc: /* Return t if BUFFER was modified since its file was last read or saved.
1085 No argument or nil as argument means use current buffer as BUFFER. */)
1086 (register Lisp_Object buffer)
1088 register struct buffer *buf;
1089 if (NILP (buffer))
1090 buf = current_buffer;
1091 else
1093 CHECK_BUFFER (buffer);
1094 buf = XBUFFER (buffer);
1097 return BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf) ? Qt : Qnil;
1100 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p, Sset_buffer_modified_p,
1101 1, 1, 0,
1102 doc: /* Mark current buffer as modified or unmodified according to FLAG.
1103 A non-nil FLAG means mark the buffer modified. */)
1104 (register Lisp_Object flag)
1106 register int already;
1107 register Lisp_Object fn;
1108 Lisp_Object buffer, window;
1110 #ifdef CLASH_DETECTION
1111 /* If buffer becoming modified, lock the file.
1112 If buffer becoming unmodified, unlock the file. */
1114 fn = BVAR (current_buffer, file_truename);
1115 /* Test buffer-file-name so that binding it to nil is effective. */
1116 if (!NILP (fn) && ! NILP (BVAR (current_buffer, filename)))
1118 already = SAVE_MODIFF < MODIFF;
1119 if (!already && !NILP (flag))
1120 lock_file (fn);
1121 else if (already && NILP (flag))
1122 unlock_file (fn);
1124 #endif /* CLASH_DETECTION */
1126 /* Here we have a problem. SAVE_MODIFF is used here to encode
1127 buffer-modified-p (as SAVE_MODIFF<MODIFF) as well as
1128 recent-auto-save-p (as SAVE_MODIFF<auto_save_modified). So if we
1129 modify SAVE_MODIFF to affect one, we may affect the other
1130 as well.
1131 E.g. if FLAG is nil we need to set SAVE_MODIFF to MODIFF, but
1132 if SAVE_MODIFF<auto_save_modified that means we risk changing
1133 recent-auto-save-p from t to nil.
1134 Vice versa, if FLAG is non-nil and SAVE_MODIFF>=auto_save_modified
1135 we risk changing recent-auto-save-p from nil to t. */
1136 SAVE_MODIFF = (NILP (flag)
1137 /* FIXME: This unavoidably sets recent-auto-save-p to nil. */
1138 ? MODIFF
1139 /* Let's try to preserve recent-auto-save-p. */
1140 : SAVE_MODIFF < MODIFF ? SAVE_MODIFF
1141 /* If SAVE_MODIFF == auto_save_modified == MODIFF,
1142 we can either decrease SAVE_MODIFF and auto_save_modified
1143 or increase MODIFF. */
1144 : MODIFF++);
1146 /* Set update_mode_lines only if buffer is displayed in some window.
1147 Packages like jit-lock or lazy-lock preserve a buffer's modified
1148 state by recording/restoring the state around blocks of code.
1149 Setting update_mode_lines makes redisplay consider all windows
1150 (on all frames). Stealth fontification of buffers not displayed
1151 would incur additional redisplay costs if we'd set
1152 update_modes_lines unconditionally.
1154 Ideally, I think there should be another mechanism for fontifying
1155 buffers without "modifying" buffers, or redisplay should be
1156 smarter about updating the `*' in mode lines. --gerd */
1157 XSETBUFFER (buffer, current_buffer);
1158 window = Fget_buffer_window (buffer, Qt);
1159 if (WINDOWP (window))
1161 ++update_mode_lines;
1162 current_buffer->prevent_redisplay_optimizations_p = 1;
1165 return flag;
1168 DEFUN ("restore-buffer-modified-p", Frestore_buffer_modified_p,
1169 Srestore_buffer_modified_p, 1, 1, 0,
1170 doc: /* Like `set-buffer-modified-p', with a difference concerning redisplay.
1171 It is not ensured that mode lines will be updated to show the modified
1172 state of the current buffer. Use with care. */)
1173 (Lisp_Object flag)
1175 #ifdef CLASH_DETECTION
1176 Lisp_Object fn;
1178 /* If buffer becoming modified, lock the file.
1179 If buffer becoming unmodified, unlock the file. */
1181 fn = BVAR (current_buffer, file_truename);
1182 /* Test buffer-file-name so that binding it to nil is effective. */
1183 if (!NILP (fn) && ! NILP (BVAR (current_buffer, filename)))
1185 int already = SAVE_MODIFF < MODIFF;
1186 if (!already && !NILP (flag))
1187 lock_file (fn);
1188 else if (already && NILP (flag))
1189 unlock_file (fn);
1191 #endif /* CLASH_DETECTION */
1193 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1194 return flag;
1197 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick, Sbuffer_modified_tick,
1198 0, 1, 0,
1199 doc: /* Return BUFFER's tick counter, incremented for each change in text.
1200 Each buffer has a tick counter which is incremented each time the
1201 text in that buffer is changed. It wraps around occasionally.
1202 No argument or nil as argument means use current buffer as BUFFER. */)
1203 (register Lisp_Object buffer)
1205 register struct buffer *buf;
1206 if (NILP (buffer))
1207 buf = current_buffer;
1208 else
1210 CHECK_BUFFER (buffer);
1211 buf = XBUFFER (buffer);
1214 return make_number (BUF_MODIFF (buf));
1217 DEFUN ("buffer-chars-modified-tick", Fbuffer_chars_modified_tick,
1218 Sbuffer_chars_modified_tick, 0, 1, 0,
1219 doc: /* Return BUFFER's character-change tick counter.
1220 Each buffer has a character-change tick counter, which is set to the
1221 value of the buffer's tick counter \(see `buffer-modified-tick'), each
1222 time text in that buffer is inserted or deleted. By comparing the
1223 values returned by two individual calls of `buffer-chars-modified-tick',
1224 you can tell whether a character change occurred in that buffer in
1225 between these calls. No argument or nil as argument means use current
1226 buffer as BUFFER. */)
1227 (register Lisp_Object buffer)
1229 register struct buffer *buf;
1230 if (NILP (buffer))
1231 buf = current_buffer;
1232 else
1234 CHECK_BUFFER (buffer);
1235 buf = XBUFFER (buffer);
1238 return make_number (BUF_CHARS_MODIFF (buf));
1241 DEFUN ("rename-buffer", Frename_buffer, Srename_buffer, 1, 2,
1242 "(list (read-string \"Rename buffer (to new name): \" \
1243 nil 'buffer-name-history (buffer-name (current-buffer))) \
1244 current-prefix-arg)",
1245 doc: /* Change current buffer's name to NEWNAME (a string).
1246 If second arg UNIQUE is nil or omitted, it is an error if a
1247 buffer named NEWNAME already exists.
1248 If UNIQUE is non-nil, come up with a new name using
1249 `generate-new-buffer-name'.
1250 Interactively, you can set UNIQUE with a prefix argument.
1251 We return the name we actually gave the buffer.
1252 This does not change the name of the visited file (if any). */)
1253 (register Lisp_Object newname, Lisp_Object unique)
1255 register Lisp_Object tem, buf;
1257 CHECK_STRING (newname);
1259 if (SCHARS (newname) == 0)
1260 error ("Empty string is invalid as a buffer name");
1262 tem = Fget_buffer (newname);
1263 if (!NILP (tem))
1265 /* Don't short-circuit if UNIQUE is t. That is a useful way to
1266 rename the buffer automatically so you can create another
1267 with the original name. It makes UNIQUE equivalent to
1268 (rename-buffer (generate-new-buffer-name NEWNAME)). */
1269 if (NILP (unique) && XBUFFER (tem) == current_buffer)
1270 return BVAR (current_buffer, name);
1271 if (!NILP (unique))
1272 newname = Fgenerate_new_buffer_name (newname, BVAR (current_buffer, name));
1273 else
1274 error ("Buffer name `%s' is in use", SDATA (newname));
1277 BVAR (current_buffer, name) = newname;
1279 /* Catch redisplay's attention. Unless we do this, the mode lines for
1280 any windows displaying current_buffer will stay unchanged. */
1281 update_mode_lines++;
1283 XSETBUFFER (buf, current_buffer);
1284 Fsetcar (Frassq (buf, Vbuffer_alist), newname);
1285 if (NILP (BVAR (current_buffer, filename))
1286 && !NILP (BVAR (current_buffer, auto_save_file_name)))
1287 call0 (intern ("rename-auto-save-file"));
1289 /* Run buffer-list-update-hook. */
1290 if (!NILP (Vrun_hooks))
1291 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1293 /* Refetch since that last call may have done GC. */
1294 return BVAR (current_buffer, name);
1297 DEFUN ("other-buffer", Fother_buffer, Sother_buffer, 0, 3, 0,
1298 doc: /* Return most recently selected buffer other than BUFFER.
1299 Buffers not visible in windows are preferred to visible buffers, unless
1300 optional second argument VISIBLE-OK is non-nil. Ignore the argument
1301 BUFFER unless it denotes a live buffer. If the optional third argument
1302 FRAME is non-nil, use that frame's buffer list instead of the selected
1303 frame's buffer list.
1305 The buffer is found by scanning the selected or specified frame's buffer
1306 list first, followed by the list of all buffers. If no other buffer
1307 exists, return the buffer `*scratch*' (creating it if necessary). */)
1308 (register Lisp_Object buffer, Lisp_Object visible_ok, Lisp_Object frame)
1310 Lisp_Object Fset_buffer_major_mode (Lisp_Object buffer);
1311 Lisp_Object tail, buf, pred;
1312 Lisp_Object notsogood = Qnil;
1314 if (NILP (frame))
1315 frame = selected_frame;
1317 CHECK_FRAME (frame);
1319 pred = frame_buffer_predicate (frame);
1320 /* Consider buffers that have been seen in the frame first. */
1321 tail = XFRAME (frame)->buffer_list;
1322 for (; CONSP (tail); tail = XCDR (tail))
1324 buf = XCAR (tail);
1325 if (BUFFERP (buf) && !EQ (buf, buffer)
1326 && !NILP (BVAR (XBUFFER (buf), name))
1327 && (SREF (BVAR (XBUFFER (buf), name), 0) != ' ')
1328 /* If the frame has a buffer_predicate, disregard buffers that
1329 don't fit the predicate. */
1330 && (NILP (pred) || !NILP (call1 (pred, buf))))
1332 if (!NILP (visible_ok)
1333 || NILP (Fget_buffer_window (buf, Qvisible)))
1334 return buf;
1335 else if (NILP (notsogood))
1336 notsogood = buf;
1340 /* Consider alist of all buffers next. */
1341 tail = Vbuffer_alist;
1342 for (; CONSP (tail); tail = XCDR (tail))
1344 buf = Fcdr (XCAR (tail));
1345 if (BUFFERP (buf) && !EQ (buf, buffer)
1346 && !NILP (BVAR (XBUFFER (buf), name))
1347 && (SREF (BVAR (XBUFFER (buf), name), 0) != ' ')
1348 /* If the frame has a buffer_predicate, disregard buffers that
1349 don't fit the predicate. */
1350 && (NILP (pred) || !NILP (call1 (pred, buf))))
1352 if (!NILP (visible_ok)
1353 || NILP (Fget_buffer_window (buf, Qvisible)))
1354 return buf;
1355 else if (NILP (notsogood))
1356 notsogood = buf;
1360 if (!NILP (notsogood))
1361 return notsogood;
1362 else
1364 buf = Fget_buffer (build_string ("*scratch*"));
1365 if (NILP (buf))
1367 buf = Fget_buffer_create (build_string ("*scratch*"));
1368 Fset_buffer_major_mode (buf);
1370 return buf;
1374 /* The following function is a safe variant of Fother_buffer: It doesn't
1375 pay attention to any frame-local buffer lists, doesn't care about
1376 visibility of buffers, and doesn't evaluate any frame predicates. */
1378 Lisp_Object
1379 other_buffer_safely (Lisp_Object buffer)
1381 Lisp_Object Fset_buffer_major_mode (Lisp_Object buffer);
1382 Lisp_Object tail, buf;
1384 tail = Vbuffer_alist;
1385 for (; CONSP (tail); tail = XCDR (tail))
1387 buf = Fcdr (XCAR (tail));
1388 if (BUFFERP (buf) && !EQ (buf, buffer)
1389 && !NILP (BVAR (XBUFFER (buf), name))
1390 && (SREF (BVAR (XBUFFER (buf), name), 0) != ' '))
1391 return buf;
1394 buf = Fget_buffer (build_string ("*scratch*"));
1395 if (NILP (buf))
1397 buf = Fget_buffer_create (build_string ("*scratch*"));
1398 Fset_buffer_major_mode (buf);
1401 return buf;
1404 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo, Sbuffer_enable_undo,
1405 0, 1, "",
1406 doc: /* Start keeping undo information for buffer BUFFER.
1407 No argument or nil as argument means do this for the current buffer. */)
1408 (register Lisp_Object buffer)
1410 Lisp_Object real_buffer;
1412 if (NILP (buffer))
1413 XSETBUFFER (real_buffer, current_buffer);
1414 else
1416 real_buffer = Fget_buffer (buffer);
1417 if (NILP (real_buffer))
1418 nsberror (buffer);
1421 if (EQ (BVAR (XBUFFER (real_buffer), undo_list), Qt))
1422 BVAR (XBUFFER (real_buffer), undo_list) = Qnil;
1424 return Qnil;
1428 DEFVAR_LISP ("kill-buffer-hook", ..., "\
1429 Hook to be run (by `run-hooks', which see) when a buffer is killed.\n\
1430 The buffer being killed will be current while the hook is running.\n\
1431 See `kill-buffer'."
1433 DEFUN ("kill-buffer", Fkill_buffer, Skill_buffer, 0, 1, "bKill buffer: ",
1434 doc: /* Kill buffer BUFFER-OR-NAME.
1435 The argument may be a buffer or the name of an existing buffer.
1436 Argument nil or omitted means kill the current buffer. Return t if the
1437 buffer is actually killed, nil otherwise.
1439 This function calls `replace-buffer-in-windows' for cleaning up all
1440 windows currently displaying the buffer to be killed. The functions in
1441 `kill-buffer-query-functions' are called with the buffer to be killed as
1442 the current buffer. If any of them returns nil, the buffer is not
1443 killed. The hook `kill-buffer-hook' is run before the buffer is
1444 actually killed. The buffer being killed will be current while the hook
1445 is running.
1447 Any processes that have this buffer as the `process-buffer' are killed
1448 with SIGHUP. */)
1449 (Lisp_Object buffer_or_name)
1451 Lisp_Object buffer;
1452 register struct buffer *b;
1453 register Lisp_Object tem;
1454 register struct Lisp_Marker *m;
1455 struct gcpro gcpro1;
1457 if (NILP (buffer_or_name))
1458 buffer = Fcurrent_buffer ();
1459 else
1460 buffer = Fget_buffer (buffer_or_name);
1461 if (NILP (buffer))
1462 nsberror (buffer_or_name);
1464 b = XBUFFER (buffer);
1466 /* Avoid trouble for buffer already dead. */
1467 if (NILP (BVAR (b, name)))
1468 return Qnil;
1470 /* Query if the buffer is still modified. */
1471 if (INTERACTIVE && !NILP (BVAR (b, filename))
1472 && BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
1474 GCPRO1 (buffer);
1475 tem = do_yes_or_no_p (format2 ("Buffer %s modified; kill anyway? ",
1476 BVAR (b, name), make_number (0)));
1477 UNGCPRO;
1478 if (NILP (tem))
1479 return Qnil;
1482 /* Run hooks with the buffer to be killed the current buffer. */
1484 int count = SPECPDL_INDEX ();
1485 Lisp_Object arglist[1];
1487 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1488 set_buffer_internal (b);
1490 /* First run the query functions; if any query is answered no,
1491 don't kill the buffer. */
1492 arglist[0] = Qkill_buffer_query_functions;
1493 tem = Frun_hook_with_args_until_failure (1, arglist);
1494 if (NILP (tem))
1495 return unbind_to (count, Qnil);
1497 /* Then run the hooks. */
1498 Frun_hooks (1, &Qkill_buffer_hook);
1499 unbind_to (count, Qnil);
1502 /* We have no more questions to ask. Verify that it is valid
1503 to kill the buffer. This must be done after the questions
1504 since anything can happen within do_yes_or_no_p. */
1506 /* Don't kill the minibuffer now current. */
1507 if (EQ (buffer, XWINDOW (minibuf_window)->buffer))
1508 return Qnil;
1510 if (NILP (BVAR (b, name)))
1511 return Qnil;
1513 /* When we kill a base buffer, kill all its indirect buffers.
1514 We do it at this stage so nothing terrible happens if they
1515 ask questions or their hooks get errors. */
1516 if (! b->base_buffer)
1518 struct buffer *other;
1520 GCPRO1 (buffer);
1522 for (other = all_buffers; other; other = other->header.next.buffer)
1523 /* all_buffers contains dead buffers too;
1524 don't re-kill them. */
1525 if (other->base_buffer == b && !NILP (BVAR (other, name)))
1527 Lisp_Object buf;
1528 XSETBUFFER (buf, other);
1529 Fkill_buffer (buf);
1532 UNGCPRO;
1535 /* Run replace_buffer_in_windows before making another buffer current
1536 since set-window-buffer-start-and-point will refuse to make another
1537 buffer current if the selected window does not show the current
1538 buffer. (Bug#10114) */
1539 replace_buffer_in_windows (buffer);
1541 /* Make this buffer not be current.
1542 In the process, notice if this is the sole visible buffer
1543 and give up if so. */
1544 if (b == current_buffer)
1546 tem = Fother_buffer (buffer, Qnil, Qnil);
1547 Fset_buffer (tem);
1548 if (b == current_buffer)
1549 return Qnil;
1552 /* Notice if the buffer to kill is the sole visible buffer
1553 when we're currently in the mini-buffer, and give up if so. */
1554 XSETBUFFER (tem, current_buffer);
1555 if (EQ (tem, XWINDOW (minibuf_window)->buffer))
1557 tem = Fother_buffer (buffer, Qnil, Qnil);
1558 if (EQ (buffer, tem))
1559 return Qnil;
1562 /* Now there is no question: we can kill the buffer. */
1564 #ifdef CLASH_DETECTION
1565 /* Unlock this buffer's file, if it is locked. */
1566 unlock_buffer (b);
1567 #endif /* CLASH_DETECTION */
1569 GCPRO1 (buffer);
1570 kill_buffer_processes (buffer);
1571 UNGCPRO;
1573 /* Killing buffer processes may run sentinels which may
1574 have called kill-buffer. */
1576 if (NILP (BVAR (b, name)))
1577 return Qnil;
1579 /* These may run Lisp code and into infinite loops (if someone
1580 insisted on circular lists) so allow quitting here. */
1581 frames_discard_buffer (buffer);
1583 clear_charpos_cache (b);
1585 tem = Vinhibit_quit;
1586 Vinhibit_quit = Qt;
1587 /* Remove the buffer from the list of all buffers. */
1588 Vbuffer_alist = Fdelq (Frassq (buffer, Vbuffer_alist), Vbuffer_alist);
1589 /* If replace_buffer_in_windows didn't do its job correctly fix that
1590 now. */
1591 replace_buffer_in_windows_safely (buffer);
1592 Vinhibit_quit = tem;
1594 /* Delete any auto-save file, if we saved it in this session.
1595 But not if the buffer is modified. */
1596 if (STRINGP (BVAR (b, auto_save_file_name))
1597 && BUF_AUTOSAVE_MODIFF (b) != 0
1598 && BUF_SAVE_MODIFF (b) < BUF_AUTOSAVE_MODIFF (b)
1599 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
1600 && NILP (Fsymbol_value (intern ("auto-save-visited-file-name"))))
1602 Lisp_Object delete;
1603 delete = Fsymbol_value (intern ("delete-auto-save-files"));
1604 if (! NILP (delete))
1605 internal_delete_file (BVAR (b, auto_save_file_name));
1608 if (b->base_buffer)
1610 /* Unchain all markers that belong to this indirect buffer.
1611 Don't unchain the markers that belong to the base buffer
1612 or its other indirect buffers. */
1613 for (m = BUF_MARKERS (b); m; )
1615 struct Lisp_Marker *next = m->next;
1616 if (m->buffer == b)
1617 unchain_marker (m);
1618 m = next;
1621 else
1623 /* Unchain all markers of this buffer and its indirect buffers.
1624 and leave them pointing nowhere. */
1625 for (m = BUF_MARKERS (b); m; )
1627 struct Lisp_Marker *next = m->next;
1628 m->buffer = 0;
1629 m->next = NULL;
1630 m = next;
1632 BUF_MARKERS (b) = NULL;
1633 BUF_INTERVALS (b) = NULL_INTERVAL;
1635 /* Perhaps we should explicitly free the interval tree here... */
1638 /* Reset the local variables, so that this buffer's local values
1639 won't be protected from GC. They would be protected
1640 if they happened to remain cached in their symbols.
1641 This gets rid of them for certain. */
1642 swap_out_buffer_local_variables (b);
1643 reset_buffer_local_variables (b, 1);
1645 BVAR (b, name) = Qnil;
1647 BLOCK_INPUT;
1648 if (! b->base_buffer)
1649 free_buffer_text (b);
1651 if (b->newline_cache)
1653 free_region_cache (b->newline_cache);
1654 b->newline_cache = 0;
1656 if (b->width_run_cache)
1658 free_region_cache (b->width_run_cache);
1659 b->width_run_cache = 0;
1661 BVAR (b, width_table) = Qnil;
1662 UNBLOCK_INPUT;
1663 BVAR (b, undo_list) = Qnil;
1665 /* Run buffer-list-update-hook. */
1666 if (!NILP (Vrun_hooks))
1667 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1669 return Qt;
1672 /* Move association for BUFFER to the front of buffer (a)lists. Since
1673 we do this each time BUFFER is selected visibly, the more recently
1674 selected buffers are always closer to the front of those lists. This
1675 means that other_buffer is more likely to choose a relevant buffer.
1677 Note that this moves BUFFER to the front of the buffer lists of the
1678 selected frame even if BUFFER is not shown there. If BUFFER is not
1679 shown in the selected frame, consider the present behavior a feature.
1680 `select-window' gets this right since it shows BUFFER in the selected
1681 window when calling us. */
1683 void
1684 record_buffer (Lisp_Object buffer)
1686 Lisp_Object aelt, aelt_cons, tem;
1687 register struct frame *f = XFRAME (selected_frame);
1689 CHECK_BUFFER (buffer);
1691 /* Update Vbuffer_alist (we know that it has an entry for BUFFER).
1692 Don't allow quitting since this might leave the buffer list in an
1693 inconsistent state. */
1694 tem = Vinhibit_quit;
1695 Vinhibit_quit = Qt;
1696 aelt = Frassq (buffer, Vbuffer_alist);
1697 aelt_cons = Fmemq (aelt, Vbuffer_alist);
1698 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
1699 XSETCDR (aelt_cons, Vbuffer_alist);
1700 Vbuffer_alist = aelt_cons;
1701 Vinhibit_quit = tem;
1703 /* Update buffer list of selected frame. */
1704 f->buffer_list = Fcons (buffer, Fdelq (buffer, f->buffer_list));
1705 f->buried_buffer_list = Fdelq (buffer, f->buried_buffer_list);
1707 /* Run buffer-list-update-hook. */
1708 if (!NILP (Vrun_hooks))
1709 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1713 /* Move BUFFER to the end of the buffer (a)lists. Do nothing if the
1714 buffer is killed. For the selected frame's buffer list this moves
1715 BUFFER to its end even if it was never shown in that frame. If
1716 this happens we have a feature, hence `unrecord-buffer' should be
1717 called only when BUFFER was shown in the selected frame. */
1719 DEFUN ("bury-buffer-internal", Fbury_buffer_internal, Sbury_buffer_internal,
1720 1, 1, 0,
1721 doc: /* Move BUFFER to the end of the buffer list. */)
1722 (Lisp_Object buffer)
1724 Lisp_Object aelt, aelt_cons, tem;
1725 register struct frame *f = XFRAME (selected_frame);
1727 CHECK_BUFFER (buffer);
1729 /* Update Vbuffer_alist (we know that it has an entry for BUFFER).
1730 Don't allow quitting since this might leave the buffer list in an
1731 inconsistent state. */
1732 tem = Vinhibit_quit;
1733 Vinhibit_quit = Qt;
1734 aelt = Frassq (buffer, Vbuffer_alist);
1735 aelt_cons = Fmemq (aelt, Vbuffer_alist);
1736 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
1737 XSETCDR (aelt_cons, Qnil);
1738 Vbuffer_alist = nconc2 (Vbuffer_alist, aelt_cons);
1739 Vinhibit_quit = tem;
1741 /* Update buffer lists of selected frame. */
1742 f->buffer_list = Fdelq (buffer, f->buffer_list);
1743 f->buried_buffer_list = Fcons (buffer, Fdelq (buffer, f->buried_buffer_list));
1745 /* Run buffer-list-update-hook. */
1746 if (!NILP (Vrun_hooks))
1747 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1749 return Qnil;
1752 DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode, Sset_buffer_major_mode, 1, 1, 0,
1753 doc: /* Set an appropriate major mode for BUFFER.
1754 For the *scratch* buffer, use `initial-major-mode', otherwise choose a mode
1755 according to `default-major-mode'.
1756 Use this function before selecting the buffer, since it may need to inspect
1757 the current buffer's major mode. */)
1758 (Lisp_Object buffer)
1760 int count;
1761 Lisp_Object function;
1763 CHECK_BUFFER (buffer);
1765 if (STRINGP (BVAR (XBUFFER (buffer), name))
1766 && strcmp (SSDATA (BVAR (XBUFFER (buffer), name)), "*scratch*") == 0)
1767 function = find_symbol_value (intern ("initial-major-mode"));
1768 else
1770 function = BVAR (&buffer_defaults, major_mode);
1771 if (NILP (function)
1772 && NILP (Fget (BVAR (current_buffer, major_mode), Qmode_class)))
1773 function = BVAR (current_buffer, major_mode);
1776 if (NILP (function) || EQ (function, Qfundamental_mode))
1777 return Qnil;
1779 count = SPECPDL_INDEX ();
1781 /* To select a nonfundamental mode,
1782 select the buffer temporarily and then call the mode function. */
1784 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1786 Fset_buffer (buffer);
1787 call0 (function);
1789 return unbind_to (count, Qnil);
1792 DEFUN ("current-buffer", Fcurrent_buffer, Scurrent_buffer, 0, 0, 0,
1793 doc: /* Return the current buffer as a Lisp object. */)
1794 (void)
1796 register Lisp_Object buf;
1797 XSETBUFFER (buf, current_buffer);
1798 return buf;
1801 /* Set the current buffer to B.
1803 We previously set windows_or_buffers_changed here to invalidate
1804 global unchanged information in beg_unchanged and end_unchanged.
1805 This is no longer necessary because we now compute unchanged
1806 information on a buffer-basis. Every action affecting other
1807 windows than the selected one requires a select_window at some
1808 time, and that increments windows_or_buffers_changed. */
1810 void
1811 set_buffer_internal (register struct buffer *b)
1813 if (current_buffer != b)
1814 set_buffer_internal_1 (b);
1817 /* Set the current buffer to B, and do not set windows_or_buffers_changed.
1818 This is used by redisplay. */
1820 void
1821 set_buffer_internal_1 (register struct buffer *b)
1823 register struct buffer *old_buf;
1824 register Lisp_Object tail;
1826 #ifdef USE_MMAP_FOR_BUFFERS
1827 if (b->text->beg == NULL)
1828 enlarge_buffer_text (b, 0);
1829 #endif /* USE_MMAP_FOR_BUFFERS */
1831 if (current_buffer == b)
1832 return;
1834 old_buf = current_buffer;
1835 current_buffer = b;
1836 last_known_column_point = -1; /* invalidate indentation cache */
1838 if (old_buf)
1840 /* Put the undo list back in the base buffer, so that it appears
1841 that an indirect buffer shares the undo list of its base. */
1842 if (old_buf->base_buffer)
1843 BVAR (old_buf->base_buffer, undo_list) = BVAR (old_buf, undo_list);
1845 /* If the old current buffer has markers to record PT, BEGV and ZV
1846 when it is not current, update them now. */
1847 record_buffer_markers (old_buf);
1850 /* Get the undo list from the base buffer, so that it appears
1851 that an indirect buffer shares the undo list of its base. */
1852 if (b->base_buffer)
1853 BVAR (b, undo_list) = BVAR (b->base_buffer, undo_list);
1855 /* If the new current buffer has markers to record PT, BEGV and ZV
1856 when it is not current, fetch them now. */
1857 fetch_buffer_markers (b);
1859 /* Look down buffer's list of local Lisp variables
1860 to find and update any that forward into C variables. */
1864 for (tail = BVAR (b, local_var_alist); CONSP (tail); tail = XCDR (tail))
1866 Lisp_Object var = XCAR (XCAR (tail));
1867 struct Lisp_Symbol *sym = XSYMBOL (var);
1868 if (sym->redirect == SYMBOL_LOCALIZED /* Just to be sure. */
1869 && SYMBOL_BLV (sym)->fwd)
1870 /* Just reference the variable
1871 to cause it to become set for this buffer. */
1872 Fsymbol_value (var);
1875 /* Do the same with any others that were local to the previous buffer */
1876 while (b != old_buf && (b = old_buf, b));
1879 /* Switch to buffer B temporarily for redisplay purposes.
1880 This avoids certain things that don't need to be done within redisplay. */
1882 void
1883 set_buffer_temp (struct buffer *b)
1885 register struct buffer *old_buf;
1887 if (current_buffer == b)
1888 return;
1890 old_buf = current_buffer;
1891 current_buffer = b;
1893 /* If the old current buffer has markers to record PT, BEGV and ZV
1894 when it is not current, update them now. */
1895 record_buffer_markers (old_buf);
1897 /* If the new current buffer has markers to record PT, BEGV and ZV
1898 when it is not current, fetch them now. */
1899 fetch_buffer_markers (b);
1902 DEFUN ("set-buffer", Fset_buffer, Sset_buffer, 1, 1, 0,
1903 doc: /* Make buffer BUFFER-OR-NAME current for editing operations.
1904 BUFFER-OR-NAME may be a buffer or the name of an existing buffer. See
1905 also `save-excursion' when you want to make a buffer current
1906 temporarily. This function does not display the buffer, so its effect
1907 ends when the current command terminates. Use `switch-to-buffer' or
1908 `pop-to-buffer' to switch buffers permanently. */)
1909 (register Lisp_Object buffer_or_name)
1911 register Lisp_Object buffer;
1912 buffer = Fget_buffer (buffer_or_name);
1913 if (NILP (buffer))
1914 nsberror (buffer_or_name);
1915 if (NILP (BVAR (XBUFFER (buffer), name)))
1916 error ("Selecting deleted buffer");
1917 set_buffer_internal (XBUFFER (buffer));
1918 return buffer;
1921 /* Set the current buffer to BUFFER provided it is alive. */
1923 Lisp_Object
1924 set_buffer_if_live (Lisp_Object buffer)
1926 if (! NILP (BVAR (XBUFFER (buffer), name)))
1927 Fset_buffer (buffer);
1928 return Qnil;
1931 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only,
1932 Sbarf_if_buffer_read_only, 0, 0, 0,
1933 doc: /* Signal a `buffer-read-only' error if the current buffer is read-only. */)
1934 (void)
1936 if (!NILP (BVAR (current_buffer, read_only))
1937 && NILP (Vinhibit_read_only))
1938 xsignal1 (Qbuffer_read_only, Fcurrent_buffer ());
1939 return Qnil;
1942 DEFUN ("erase-buffer", Ferase_buffer, Serase_buffer, 0, 0, "*",
1943 doc: /* Delete the entire contents of the current buffer.
1944 Any narrowing restriction in effect (see `narrow-to-region') is removed,
1945 so the buffer is truly empty after this. */)
1946 (void)
1948 Fwiden ();
1950 del_range (BEG, Z);
1952 current_buffer->last_window_start = 1;
1953 /* Prevent warnings, or suspension of auto saving, that would happen
1954 if future size is less than past size. Use of erase-buffer
1955 implies that the future text is not really related to the past text. */
1956 XSETFASTINT (BVAR (current_buffer, save_length), 0);
1957 return Qnil;
1960 void
1961 validate_region (register Lisp_Object *b, register Lisp_Object *e)
1963 CHECK_NUMBER_COERCE_MARKER (*b);
1964 CHECK_NUMBER_COERCE_MARKER (*e);
1966 if (XINT (*b) > XINT (*e))
1968 Lisp_Object tem;
1969 tem = *b; *b = *e; *e = tem;
1972 if (!(BEGV <= XINT (*b) && XINT (*b) <= XINT (*e)
1973 && XINT (*e) <= ZV))
1974 args_out_of_range (*b, *e);
1977 /* Advance BYTE_POS up to a character boundary
1978 and return the adjusted position. */
1980 static EMACS_INT
1981 advance_to_char_boundary (EMACS_INT byte_pos)
1983 int c;
1985 if (byte_pos == BEG)
1986 /* Beginning of buffer is always a character boundary. */
1987 return BEG;
1989 c = FETCH_BYTE (byte_pos);
1990 if (! CHAR_HEAD_P (c))
1992 /* We should advance BYTE_POS only when C is a constituent of a
1993 multibyte sequence. */
1994 EMACS_INT orig_byte_pos = byte_pos;
1998 byte_pos--;
1999 c = FETCH_BYTE (byte_pos);
2001 while (! CHAR_HEAD_P (c) && byte_pos > BEG);
2002 INC_POS (byte_pos);
2003 if (byte_pos < orig_byte_pos)
2004 byte_pos = orig_byte_pos;
2005 /* If C is a constituent of a multibyte sequence, BYTE_POS was
2006 surely advance to the correct character boundary. If C is
2007 not, BYTE_POS was unchanged. */
2010 return byte_pos;
2013 #ifdef REL_ALLOC
2014 extern void r_alloc_reset_variable (POINTER_TYPE *, POINTER_TYPE *);
2015 #endif /* REL_ALLOC */
2017 DEFUN ("buffer-swap-text", Fbuffer_swap_text, Sbuffer_swap_text,
2018 1, 1, 0,
2019 doc: /* Swap the text between current buffer and BUFFER. */)
2020 (Lisp_Object buffer)
2022 struct buffer *other_buffer;
2023 CHECK_BUFFER (buffer);
2024 other_buffer = XBUFFER (buffer);
2026 if (NILP (BVAR (other_buffer, name)))
2027 error ("Cannot swap a dead buffer's text");
2029 /* Actually, it probably works just fine.
2030 * if (other_buffer == current_buffer)
2031 * error ("Cannot swap a buffer's text with itself"); */
2033 /* Actually, this may be workable as well, tho probably only if they're
2034 *both* indirect. */
2035 if (other_buffer->base_buffer
2036 || current_buffer->base_buffer)
2037 error ("Cannot swap indirect buffers's text");
2039 { /* This is probably harder to make work. */
2040 struct buffer *other;
2041 for (other = all_buffers; other; other = other->header.next.buffer)
2042 if (other->base_buffer == other_buffer
2043 || other->base_buffer == current_buffer)
2044 error ("One of the buffers to swap has indirect buffers");
2047 #define swapfield(field, type) \
2048 do { \
2049 type tmp##field = other_buffer->field; \
2050 other_buffer->field = current_buffer->field; \
2051 current_buffer->field = tmp##field; \
2052 } while (0)
2053 #define swapfield_(field, type) \
2054 do { \
2055 type tmp##field = BVAR (other_buffer, field); \
2056 BVAR (other_buffer, field) = BVAR (current_buffer, field); \
2057 BVAR (current_buffer, field) = tmp##field; \
2058 } while (0)
2060 swapfield (own_text, struct buffer_text);
2061 eassert (current_buffer->text == &current_buffer->own_text);
2062 eassert (other_buffer->text == &other_buffer->own_text);
2063 #ifdef REL_ALLOC
2064 r_alloc_reset_variable ((POINTER_TYPE **) &current_buffer->own_text.beg,
2065 (POINTER_TYPE **) &other_buffer->own_text.beg);
2066 r_alloc_reset_variable ((POINTER_TYPE **) &other_buffer->own_text.beg,
2067 (POINTER_TYPE **) &current_buffer->own_text.beg);
2068 #endif /* REL_ALLOC */
2070 swapfield (pt, EMACS_INT);
2071 swapfield (pt_byte, EMACS_INT);
2072 swapfield (begv, EMACS_INT);
2073 swapfield (begv_byte, EMACS_INT);
2074 swapfield (zv, EMACS_INT);
2075 swapfield (zv_byte, EMACS_INT);
2076 eassert (!current_buffer->base_buffer);
2077 eassert (!other_buffer->base_buffer);
2078 current_buffer->clip_changed = 1; other_buffer->clip_changed = 1;
2079 swapfield (newline_cache, struct region_cache *);
2080 swapfield (width_run_cache, struct region_cache *);
2081 current_buffer->prevent_redisplay_optimizations_p = 1;
2082 other_buffer->prevent_redisplay_optimizations_p = 1;
2083 swapfield (overlays_before, struct Lisp_Overlay *);
2084 swapfield (overlays_after, struct Lisp_Overlay *);
2085 swapfield (overlay_center, EMACS_INT);
2086 swapfield_ (undo_list, Lisp_Object);
2087 swapfield_ (mark, Lisp_Object);
2088 swapfield_ (enable_multibyte_characters, Lisp_Object);
2089 swapfield_ (bidi_display_reordering, Lisp_Object);
2090 swapfield_ (bidi_paragraph_direction, Lisp_Object);
2091 /* FIXME: Not sure what we should do with these *_marker fields.
2092 Hopefully they're just nil anyway. */
2093 swapfield_ (pt_marker, Lisp_Object);
2094 swapfield_ (begv_marker, Lisp_Object);
2095 swapfield_ (zv_marker, Lisp_Object);
2096 BVAR (current_buffer, point_before_scroll) = Qnil;
2097 BVAR (other_buffer, point_before_scroll) = Qnil;
2099 current_buffer->text->modiff++; other_buffer->text->modiff++;
2100 current_buffer->text->chars_modiff++; other_buffer->text->chars_modiff++;
2101 current_buffer->text->overlay_modiff++; other_buffer->text->overlay_modiff++;
2102 current_buffer->text->beg_unchanged = current_buffer->text->gpt;
2103 current_buffer->text->end_unchanged = current_buffer->text->gpt;
2104 other_buffer->text->beg_unchanged = other_buffer->text->gpt;
2105 other_buffer->text->end_unchanged = other_buffer->text->gpt;
2107 struct Lisp_Marker *m;
2108 for (m = BUF_MARKERS (current_buffer); m; m = m->next)
2109 if (m->buffer == other_buffer)
2110 m->buffer = current_buffer;
2111 else
2112 /* Since there's no indirect buffer in sight, markers on
2113 BUF_MARKERS(buf) should either be for `buf' or dead. */
2114 eassert (!m->buffer);
2115 for (m = BUF_MARKERS (other_buffer); m; m = m->next)
2116 if (m->buffer == current_buffer)
2117 m->buffer = other_buffer;
2118 else
2119 /* Since there's no indirect buffer in sight, markers on
2120 BUF_MARKERS(buf) should either be for `buf' or dead. */
2121 eassert (!m->buffer);
2123 { /* Some of the C code expects that w->buffer == w->pointm->buffer.
2124 So since we just swapped the markers between the two buffers, we need
2125 to undo the effect of this swap for window markers. */
2126 Lisp_Object w = Fselected_window (), ws = Qnil;
2127 Lisp_Object buf1, buf2;
2128 XSETBUFFER (buf1, current_buffer); XSETBUFFER (buf2, other_buffer);
2130 while (NILP (Fmemq (w, ws)))
2132 ws = Fcons (w, ws);
2133 if (MARKERP (XWINDOW (w)->pointm)
2134 && (EQ (XWINDOW (w)->buffer, buf1)
2135 || EQ (XWINDOW (w)->buffer, buf2)))
2136 Fset_marker (XWINDOW (w)->pointm,
2137 make_number (BUF_BEGV (XBUFFER (XWINDOW (w)->buffer))),
2138 XWINDOW (w)->buffer);
2139 w = Fnext_window (w, Qt, Qt);
2143 if (current_buffer->text->intervals)
2144 (eassert (EQ (current_buffer->text->intervals->up.obj, buffer)),
2145 XSETBUFFER (current_buffer->text->intervals->up.obj, current_buffer));
2146 if (other_buffer->text->intervals)
2147 (eassert (EQ (other_buffer->text->intervals->up.obj, Fcurrent_buffer ())),
2148 XSETBUFFER (other_buffer->text->intervals->up.obj, other_buffer));
2150 return Qnil;
2153 DEFUN ("set-buffer-multibyte", Fset_buffer_multibyte, Sset_buffer_multibyte,
2154 1, 1, 0,
2155 doc: /* Set the multibyte flag of the current buffer to FLAG.
2156 If FLAG is t, this makes the buffer a multibyte buffer.
2157 If FLAG is nil, this makes the buffer a single-byte buffer.
2158 In these cases, the buffer contents remain unchanged as a sequence of
2159 bytes but the contents viewed as characters do change.
2160 If FLAG is `to', this makes the buffer a multibyte buffer by changing
2161 all eight-bit bytes to eight-bit characters.
2162 If the multibyte flag was really changed, undo information of the
2163 current buffer is cleared. */)
2164 (Lisp_Object flag)
2166 struct Lisp_Marker *tail, *markers;
2167 struct buffer *other;
2168 EMACS_INT begv, zv;
2169 int narrowed = (BEG != BEGV || Z != ZV);
2170 int modified_p = !NILP (Fbuffer_modified_p (Qnil));
2171 Lisp_Object old_undo = BVAR (current_buffer, undo_list);
2172 struct gcpro gcpro1;
2174 if (current_buffer->base_buffer)
2175 error ("Cannot do `set-buffer-multibyte' on an indirect buffer");
2177 /* Do nothing if nothing actually changes. */
2178 if (NILP (flag) == NILP (BVAR (current_buffer, enable_multibyte_characters)))
2179 return flag;
2181 GCPRO1 (old_undo);
2183 /* Don't record these buffer changes. We will put a special undo entry
2184 instead. */
2185 BVAR (current_buffer, undo_list) = Qt;
2187 /* If the cached position is for this buffer, clear it out. */
2188 clear_charpos_cache (current_buffer);
2190 if (NILP (flag))
2191 begv = BEGV_BYTE, zv = ZV_BYTE;
2192 else
2193 begv = BEGV, zv = ZV;
2195 if (narrowed)
2196 Fwiden ();
2198 if (NILP (flag))
2200 EMACS_INT pos, stop;
2201 unsigned char *p;
2203 /* Do this first, so it can use CHAR_TO_BYTE
2204 to calculate the old correspondences. */
2205 set_intervals_multibyte (0);
2207 BVAR (current_buffer, enable_multibyte_characters) = Qnil;
2209 Z = Z_BYTE;
2210 BEGV = BEGV_BYTE;
2211 ZV = ZV_BYTE;
2212 GPT = GPT_BYTE;
2213 TEMP_SET_PT_BOTH (PT_BYTE, PT_BYTE);
2216 for (tail = BUF_MARKERS (current_buffer); tail; tail = tail->next)
2217 tail->charpos = tail->bytepos;
2219 /* Convert multibyte form of 8-bit characters to unibyte. */
2220 pos = BEG;
2221 stop = GPT;
2222 p = BEG_ADDR;
2223 while (1)
2225 int c, bytes;
2227 if (pos == stop)
2229 if (pos == Z)
2230 break;
2231 p = GAP_END_ADDR;
2232 stop = Z;
2234 if (ASCII_BYTE_P (*p))
2235 p++, pos++;
2236 else if (CHAR_BYTE8_HEAD_P (*p))
2238 c = STRING_CHAR_AND_LENGTH (p, bytes);
2239 /* Delete all bytes for this 8-bit character but the
2240 last one, and change the last one to the character
2241 code. */
2242 bytes--;
2243 del_range_2 (pos, pos, pos + bytes, pos + bytes, 0);
2244 p = GAP_END_ADDR;
2245 *p++ = c;
2246 pos++;
2247 if (begv > pos)
2248 begv -= bytes;
2249 if (zv > pos)
2250 zv -= bytes;
2251 stop = Z;
2253 else
2255 bytes = BYTES_BY_CHAR_HEAD (*p);
2256 p += bytes, pos += bytes;
2259 if (narrowed)
2260 Fnarrow_to_region (make_number (begv), make_number (zv));
2262 else
2264 EMACS_INT pt = PT;
2265 EMACS_INT pos, stop;
2266 unsigned char *p, *pend;
2268 /* Be sure not to have a multibyte sequence striding over the GAP.
2269 Ex: We change this: "...abc\302 _GAP_ \241def..."
2270 to: "...abc _GAP_ \302\241def..." */
2272 if (EQ (flag, Qt)
2273 && GPT_BYTE > 1 && GPT_BYTE < Z_BYTE
2274 && ! CHAR_HEAD_P (*(GAP_END_ADDR)))
2276 unsigned char *q = GPT_ADDR - 1;
2278 while (! CHAR_HEAD_P (*q) && q > BEG_ADDR) q--;
2279 if (LEADING_CODE_P (*q))
2281 EMACS_INT new_gpt = GPT_BYTE - (GPT_ADDR - q);
2283 move_gap_both (new_gpt, new_gpt);
2287 /* Make the buffer contents valid as multibyte by converting
2288 8-bit characters to multibyte form. */
2289 pos = BEG;
2290 stop = GPT;
2291 p = BEG_ADDR;
2292 pend = GPT_ADDR;
2293 while (1)
2295 int bytes;
2297 if (pos == stop)
2299 if (pos == Z)
2300 break;
2301 p = GAP_END_ADDR;
2302 pend = Z_ADDR;
2303 stop = Z;
2306 if (ASCII_BYTE_P (*p))
2307 p++, pos++;
2308 else if (EQ (flag, Qt)
2309 && ! CHAR_BYTE8_HEAD_P (*p)
2310 && (bytes = MULTIBYTE_LENGTH (p, pend)) > 0)
2311 p += bytes, pos += bytes;
2312 else
2314 unsigned char tmp[MAX_MULTIBYTE_LENGTH];
2315 int c;
2317 c = BYTE8_TO_CHAR (*p);
2318 bytes = CHAR_STRING (c, tmp);
2319 *p = tmp[0];
2320 TEMP_SET_PT_BOTH (pos + 1, pos + 1);
2321 bytes--;
2322 insert_1_both ((char *) tmp + 1, bytes, bytes, 1, 0, 0);
2323 /* Now the gap is after the just inserted data. */
2324 pos = GPT;
2325 p = GAP_END_ADDR;
2326 if (pos <= begv)
2327 begv += bytes;
2328 if (pos <= zv)
2329 zv += bytes;
2330 if (pos <= pt)
2331 pt += bytes;
2332 pend = Z_ADDR;
2333 stop = Z;
2337 if (pt != PT)
2338 TEMP_SET_PT (pt);
2340 if (narrowed)
2341 Fnarrow_to_region (make_number (begv), make_number (zv));
2343 /* Do this first, so that chars_in_text asks the right question.
2344 set_intervals_multibyte needs it too. */
2345 BVAR (current_buffer, enable_multibyte_characters) = Qt;
2347 GPT_BYTE = advance_to_char_boundary (GPT_BYTE);
2348 GPT = chars_in_text (BEG_ADDR, GPT_BYTE - BEG_BYTE) + BEG;
2350 Z = chars_in_text (GAP_END_ADDR, Z_BYTE - GPT_BYTE) + GPT;
2352 BEGV_BYTE = advance_to_char_boundary (BEGV_BYTE);
2353 if (BEGV_BYTE > GPT_BYTE)
2354 BEGV = chars_in_text (GAP_END_ADDR, BEGV_BYTE - GPT_BYTE) + GPT;
2355 else
2356 BEGV = chars_in_text (BEG_ADDR, BEGV_BYTE - BEG_BYTE) + BEG;
2358 ZV_BYTE = advance_to_char_boundary (ZV_BYTE);
2359 if (ZV_BYTE > GPT_BYTE)
2360 ZV = chars_in_text (GAP_END_ADDR, ZV_BYTE - GPT_BYTE) + GPT;
2361 else
2362 ZV = chars_in_text (BEG_ADDR, ZV_BYTE - BEG_BYTE) + BEG;
2365 EMACS_INT byte = advance_to_char_boundary (PT_BYTE);
2366 EMACS_INT position;
2368 if (byte > GPT_BYTE)
2369 position = chars_in_text (GAP_END_ADDR, byte - GPT_BYTE) + GPT;
2370 else
2371 position = chars_in_text (BEG_ADDR, byte - BEG_BYTE) + BEG;
2372 TEMP_SET_PT_BOTH (position, byte);
2375 tail = markers = BUF_MARKERS (current_buffer);
2377 /* This prevents BYTE_TO_CHAR (that is, buf_bytepos_to_charpos) from
2378 getting confused by the markers that have not yet been updated.
2379 It is also a signal that it should never create a marker. */
2380 BUF_MARKERS (current_buffer) = NULL;
2382 for (; tail; tail = tail->next)
2384 tail->bytepos = advance_to_char_boundary (tail->bytepos);
2385 tail->charpos = BYTE_TO_CHAR (tail->bytepos);
2388 /* Make sure no markers were put on the chain
2389 while the chain value was incorrect. */
2390 if (BUF_MARKERS (current_buffer))
2391 abort ();
2393 BUF_MARKERS (current_buffer) = markers;
2395 /* Do this last, so it can calculate the new correspondences
2396 between chars and bytes. */
2397 set_intervals_multibyte (1);
2400 if (!EQ (old_undo, Qt))
2402 /* Represent all the above changes by a special undo entry. */
2403 BVAR (current_buffer, undo_list) = Fcons (list3 (Qapply,
2404 intern ("set-buffer-multibyte"),
2405 NILP (flag) ? Qt : Qnil),
2406 old_undo);
2409 UNGCPRO;
2411 /* Changing the multibyteness of a buffer means that all windows
2412 showing that buffer must be updated thoroughly. */
2413 current_buffer->prevent_redisplay_optimizations_p = 1;
2414 ++windows_or_buffers_changed;
2416 /* Copy this buffer's new multibyte status
2417 into all of its indirect buffers. */
2418 for (other = all_buffers; other; other = other->header.next.buffer)
2419 if (other->base_buffer == current_buffer && !NILP (BVAR (other, name)))
2421 BVAR (other, enable_multibyte_characters)
2422 = BVAR (current_buffer, enable_multibyte_characters);
2423 other->prevent_redisplay_optimizations_p = 1;
2426 /* Restore the modifiedness of the buffer. */
2427 if (!modified_p && !NILP (Fbuffer_modified_p (Qnil)))
2428 Fset_buffer_modified_p (Qnil);
2430 /* Update coding systems of this buffer's process (if any). */
2432 Lisp_Object process;
2434 process = Fget_buffer_process (Fcurrent_buffer ());
2435 if (PROCESSP (process))
2436 setup_process_coding_systems (process);
2439 return flag;
2442 DEFUN ("kill-all-local-variables", Fkill_all_local_variables,
2443 Skill_all_local_variables, 0, 0, 0,
2444 doc: /* Switch to Fundamental mode by killing current buffer's local variables.
2445 Most local variable bindings are eliminated so that the default values
2446 become effective once more. Also, the syntax table is set from
2447 `standard-syntax-table', the local keymap is set to nil,
2448 and the abbrev table from `fundamental-mode-abbrev-table'.
2449 This function also forces redisplay of the mode line.
2451 Every function to select a new major mode starts by
2452 calling this function.
2454 As a special exception, local variables whose names have
2455 a non-nil `permanent-local' property are not eliminated by this function.
2457 The first thing this function does is run
2458 the normal hook `change-major-mode-hook'. */)
2459 (void)
2461 Frun_hooks (1, &Qchange_major_mode_hook);
2463 /* Make sure none of the bindings in local_var_alist
2464 remain swapped in, in their symbols. */
2466 swap_out_buffer_local_variables (current_buffer);
2468 /* Actually eliminate all local bindings of this buffer. */
2470 reset_buffer_local_variables (current_buffer, 0);
2472 /* Force mode-line redisplay. Useful here because all major mode
2473 commands call this function. */
2474 update_mode_lines++;
2476 return Qnil;
2479 /* Make sure no local variables remain set up with buffer B
2480 for their current values. */
2482 static void
2483 swap_out_buffer_local_variables (struct buffer *b)
2485 Lisp_Object oalist, alist, buffer;
2487 XSETBUFFER (buffer, b);
2488 oalist = BVAR (b, local_var_alist);
2490 for (alist = oalist; CONSP (alist); alist = XCDR (alist))
2492 Lisp_Object sym = XCAR (XCAR (alist));
2493 eassert (XSYMBOL (sym)->redirect == SYMBOL_LOCALIZED);
2494 /* Need not do anything if some other buffer's binding is
2495 now cached. */
2496 if (EQ (SYMBOL_BLV (XSYMBOL (sym))->where, buffer))
2498 /* Symbol is set up for this buffer's old local value:
2499 swap it out! */
2500 swap_in_global_binding (XSYMBOL (sym));
2505 /* Find all the overlays in the current buffer that contain position POS.
2506 Return the number found, and store them in a vector in *VEC_PTR.
2507 Store in *LEN_PTR the size allocated for the vector.
2508 Store in *NEXT_PTR the next position after POS where an overlay starts,
2509 or ZV if there are no more overlays between POS and ZV.
2510 Store in *PREV_PTR the previous position before POS where an overlay ends,
2511 or where an overlay starts which ends at or after POS;
2512 or BEGV if there are no such overlays from BEGV to POS.
2513 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2515 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2516 when this function is called.
2518 If EXTEND is non-zero, we make the vector bigger if necessary.
2519 If EXTEND is zero, we never extend the vector,
2520 and we store only as many overlays as will fit.
2521 But we still return the total number of overlays.
2523 If CHANGE_REQ is true, then any position written into *PREV_PTR or
2524 *NEXT_PTR is guaranteed to be not equal to POS, unless it is the
2525 default (BEGV or ZV). */
2527 ptrdiff_t
2528 overlays_at (EMACS_INT pos, int extend, Lisp_Object **vec_ptr,
2529 ptrdiff_t *len_ptr,
2530 EMACS_INT *next_ptr, EMACS_INT *prev_ptr, int change_req)
2532 Lisp_Object overlay, start, end;
2533 struct Lisp_Overlay *tail;
2534 ptrdiff_t idx = 0;
2535 ptrdiff_t len = *len_ptr;
2536 Lisp_Object *vec = *vec_ptr;
2537 EMACS_INT next = ZV;
2538 EMACS_INT prev = BEGV;
2539 int inhibit_storing = 0;
2541 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2543 EMACS_INT startpos, endpos;
2545 XSETMISC (overlay, tail);
2547 start = OVERLAY_START (overlay);
2548 end = OVERLAY_END (overlay);
2549 endpos = OVERLAY_POSITION (end);
2550 if (endpos < pos)
2552 if (prev < endpos)
2553 prev = endpos;
2554 break;
2556 startpos = OVERLAY_POSITION (start);
2557 /* This one ends at or after POS
2558 so its start counts for PREV_PTR if it's before POS. */
2559 if (prev < startpos && startpos < pos)
2560 prev = startpos;
2561 if (endpos == pos)
2562 continue;
2563 if (startpos <= pos)
2565 if (idx == len)
2567 /* The supplied vector is full.
2568 Either make it bigger, or don't store any more in it. */
2569 if (extend)
2571 vec = xpalloc (vec, len_ptr, 1, OVERLAY_COUNT_MAX,
2572 sizeof *vec);
2573 *vec_ptr = vec;
2574 len = *len_ptr;
2576 else
2577 inhibit_storing = 1;
2580 if (!inhibit_storing)
2581 vec[idx] = overlay;
2582 /* Keep counting overlays even if we can't return them all. */
2583 idx++;
2585 else if (startpos < next)
2586 next = startpos;
2589 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2591 EMACS_INT startpos, endpos;
2593 XSETMISC (overlay, tail);
2595 start = OVERLAY_START (overlay);
2596 end = OVERLAY_END (overlay);
2597 startpos = OVERLAY_POSITION (start);
2598 if (pos < startpos)
2600 if (startpos < next)
2601 next = startpos;
2602 break;
2604 endpos = OVERLAY_POSITION (end);
2605 if (pos < endpos)
2607 if (idx == len)
2609 if (extend)
2611 vec = xpalloc (vec, len_ptr, 1, OVERLAY_COUNT_MAX,
2612 sizeof *vec);
2613 *vec_ptr = vec;
2614 len = *len_ptr;
2616 else
2617 inhibit_storing = 1;
2620 if (!inhibit_storing)
2621 vec[idx] = overlay;
2622 idx++;
2624 if (startpos < pos && startpos > prev)
2625 prev = startpos;
2627 else if (endpos < pos && endpos > prev)
2628 prev = endpos;
2629 else if (endpos == pos && startpos > prev
2630 && (!change_req || startpos < pos))
2631 prev = startpos;
2634 if (next_ptr)
2635 *next_ptr = next;
2636 if (prev_ptr)
2637 *prev_ptr = prev;
2638 return idx;
2641 /* Find all the overlays in the current buffer that overlap the range
2642 BEG-END, or are empty at BEG, or are empty at END provided END
2643 denotes the position at the end of the current buffer.
2645 Return the number found, and store them in a vector in *VEC_PTR.
2646 Store in *LEN_PTR the size allocated for the vector.
2647 Store in *NEXT_PTR the next position after POS where an overlay starts,
2648 or ZV if there are no more overlays.
2649 Store in *PREV_PTR the previous position before POS where an overlay ends,
2650 or BEGV if there are no previous overlays.
2651 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2653 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2654 when this function is called.
2656 If EXTEND is non-zero, we make the vector bigger if necessary.
2657 If EXTEND is zero, we never extend the vector,
2658 and we store only as many overlays as will fit.
2659 But we still return the total number of overlays. */
2661 static ptrdiff_t
2662 overlays_in (EMACS_INT beg, EMACS_INT end, int extend,
2663 Lisp_Object **vec_ptr, ptrdiff_t *len_ptr,
2664 EMACS_INT *next_ptr, EMACS_INT *prev_ptr)
2666 Lisp_Object overlay, ostart, oend;
2667 struct Lisp_Overlay *tail;
2668 ptrdiff_t idx = 0;
2669 ptrdiff_t len = *len_ptr;
2670 Lisp_Object *vec = *vec_ptr;
2671 EMACS_INT next = ZV;
2672 EMACS_INT prev = BEGV;
2673 int inhibit_storing = 0;
2674 int end_is_Z = end == Z;
2676 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2678 EMACS_INT startpos, endpos;
2680 XSETMISC (overlay, tail);
2682 ostart = OVERLAY_START (overlay);
2683 oend = OVERLAY_END (overlay);
2684 endpos = OVERLAY_POSITION (oend);
2685 if (endpos < beg)
2687 if (prev < endpos)
2688 prev = endpos;
2689 break;
2691 startpos = OVERLAY_POSITION (ostart);
2692 /* Count an interval if it overlaps the range, is empty at the
2693 start of the range, or is empty at END provided END denotes the
2694 end of the buffer. */
2695 if ((beg < endpos && startpos < end)
2696 || (startpos == endpos
2697 && (beg == endpos || (end_is_Z && endpos == end))))
2699 if (idx == len)
2701 /* The supplied vector is full.
2702 Either make it bigger, or don't store any more in it. */
2703 if (extend)
2705 vec = xpalloc (vec, len_ptr, 1, OVERLAY_COUNT_MAX,
2706 sizeof *vec);
2707 *vec_ptr = vec;
2708 len = *len_ptr;
2710 else
2711 inhibit_storing = 1;
2714 if (!inhibit_storing)
2715 vec[idx] = overlay;
2716 /* Keep counting overlays even if we can't return them all. */
2717 idx++;
2719 else if (startpos < next)
2720 next = startpos;
2723 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2725 EMACS_INT startpos, endpos;
2727 XSETMISC (overlay, tail);
2729 ostart = OVERLAY_START (overlay);
2730 oend = OVERLAY_END (overlay);
2731 startpos = OVERLAY_POSITION (ostart);
2732 if (end < startpos)
2734 if (startpos < next)
2735 next = startpos;
2736 break;
2738 endpos = OVERLAY_POSITION (oend);
2739 /* Count an interval if it overlaps the range, is empty at the
2740 start of the range, or is empty at END provided END denotes the
2741 end of the buffer. */
2742 if ((beg < endpos && startpos < end)
2743 || (startpos == endpos
2744 && (beg == endpos || (end_is_Z && endpos == end))))
2746 if (idx == len)
2748 if (extend)
2750 vec = xpalloc (vec, len_ptr, 1, OVERLAY_COUNT_MAX,
2751 sizeof *vec);
2752 *vec_ptr = vec;
2753 len = *len_ptr;
2755 else
2756 inhibit_storing = 1;
2759 if (!inhibit_storing)
2760 vec[idx] = overlay;
2761 idx++;
2763 else if (endpos < beg && endpos > prev)
2764 prev = endpos;
2767 if (next_ptr)
2768 *next_ptr = next;
2769 if (prev_ptr)
2770 *prev_ptr = prev;
2771 return idx;
2775 /* Return non-zero if there exists an overlay with a non-nil
2776 `mouse-face' property overlapping OVERLAY. */
2779 mouse_face_overlay_overlaps (Lisp_Object overlay)
2781 EMACS_INT start = OVERLAY_POSITION (OVERLAY_START (overlay));
2782 EMACS_INT end = OVERLAY_POSITION (OVERLAY_END (overlay));
2783 ptrdiff_t n, i, size;
2784 Lisp_Object *v, tem;
2786 size = 10;
2787 v = (Lisp_Object *) alloca (size * sizeof *v);
2788 n = overlays_in (start, end, 0, &v, &size, NULL, NULL);
2789 if (n > size)
2791 v = (Lisp_Object *) alloca (n * sizeof *v);
2792 overlays_in (start, end, 0, &v, &n, NULL, NULL);
2795 for (i = 0; i < n; ++i)
2796 if (!EQ (v[i], overlay)
2797 && (tem = Foverlay_get (overlay, Qmouse_face),
2798 !NILP (tem)))
2799 break;
2801 return i < n;
2806 /* Fast function to just test if we're at an overlay boundary. */
2808 overlay_touches_p (EMACS_INT pos)
2810 Lisp_Object overlay;
2811 struct Lisp_Overlay *tail;
2813 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2815 EMACS_INT endpos;
2817 XSETMISC (overlay ,tail);
2818 if (!OVERLAYP (overlay))
2819 abort ();
2821 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2822 if (endpos < pos)
2823 break;
2824 if (endpos == pos || OVERLAY_POSITION (OVERLAY_START (overlay)) == pos)
2825 return 1;
2828 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2830 EMACS_INT startpos;
2832 XSETMISC (overlay, tail);
2833 if (!OVERLAYP (overlay))
2834 abort ();
2836 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2837 if (pos < startpos)
2838 break;
2839 if (startpos == pos || OVERLAY_POSITION (OVERLAY_END (overlay)) == pos)
2840 return 1;
2842 return 0;
2845 struct sortvec
2847 Lisp_Object overlay;
2848 EMACS_INT beg, end;
2849 EMACS_INT priority;
2852 static int
2853 compare_overlays (const void *v1, const void *v2)
2855 const struct sortvec *s1 = (const struct sortvec *) v1;
2856 const struct sortvec *s2 = (const struct sortvec *) v2;
2857 if (s1->priority != s2->priority)
2858 return s1->priority < s2->priority ? -1 : 1;
2859 if (s1->beg != s2->beg)
2860 return s1->beg < s2->beg ? -1 : 1;
2861 if (s1->end != s2->end)
2862 return s2->end < s1->end ? -1 : 1;
2863 return 0;
2866 /* Sort an array of overlays by priority. The array is modified in place.
2867 The return value is the new size; this may be smaller than the original
2868 size if some of the overlays were invalid or were window-specific. */
2869 ptrdiff_t
2870 sort_overlays (Lisp_Object *overlay_vec, ptrdiff_t noverlays, struct window *w)
2872 ptrdiff_t i, j;
2873 struct sortvec *sortvec;
2874 sortvec = (struct sortvec *) alloca (noverlays * sizeof (struct sortvec));
2876 /* Put the valid and relevant overlays into sortvec. */
2878 for (i = 0, j = 0; i < noverlays; i++)
2880 Lisp_Object tem;
2881 Lisp_Object overlay;
2883 overlay = overlay_vec[i];
2884 if (OVERLAY_VALID (overlay)
2885 && OVERLAY_POSITION (OVERLAY_START (overlay)) > 0
2886 && OVERLAY_POSITION (OVERLAY_END (overlay)) > 0)
2888 /* If we're interested in a specific window, then ignore
2889 overlays that are limited to some other window. */
2890 if (w)
2892 Lisp_Object window;
2894 window = Foverlay_get (overlay, Qwindow);
2895 if (WINDOWP (window) && XWINDOW (window) != w)
2896 continue;
2899 /* This overlay is good and counts: put it into sortvec. */
2900 sortvec[j].overlay = overlay;
2901 sortvec[j].beg = OVERLAY_POSITION (OVERLAY_START (overlay));
2902 sortvec[j].end = OVERLAY_POSITION (OVERLAY_END (overlay));
2903 tem = Foverlay_get (overlay, Qpriority);
2904 if (INTEGERP (tem))
2905 sortvec[j].priority = XINT (tem);
2906 else
2907 sortvec[j].priority = 0;
2908 j++;
2911 noverlays = j;
2913 /* Sort the overlays into the proper order: increasing priority. */
2915 if (noverlays > 1)
2916 qsort (sortvec, noverlays, sizeof (struct sortvec), compare_overlays);
2918 for (i = 0; i < noverlays; i++)
2919 overlay_vec[i] = sortvec[i].overlay;
2920 return (noverlays);
2923 struct sortstr
2925 Lisp_Object string, string2;
2926 ptrdiff_t size;
2927 EMACS_INT priority;
2930 struct sortstrlist
2932 struct sortstr *buf; /* An array that expands as needed; never freed. */
2933 ptrdiff_t size; /* Allocated length of that array. */
2934 ptrdiff_t used; /* How much of the array is currently in use. */
2935 ptrdiff_t bytes; /* Total length of the strings in buf. */
2938 /* Buffers for storing information about the overlays touching a given
2939 position. These could be automatic variables in overlay_strings, but
2940 it's more efficient to hold onto the memory instead of repeatedly
2941 allocating and freeing it. */
2942 static struct sortstrlist overlay_heads, overlay_tails;
2943 static unsigned char *overlay_str_buf;
2945 /* Allocated length of overlay_str_buf. */
2946 static ptrdiff_t overlay_str_len;
2948 /* A comparison function suitable for passing to qsort. */
2949 static int
2950 cmp_for_strings (const void *as1, const void *as2)
2952 struct sortstr *s1 = (struct sortstr *)as1;
2953 struct sortstr *s2 = (struct sortstr *)as2;
2954 if (s1->size != s2->size)
2955 return s2->size < s1->size ? -1 : 1;
2956 if (s1->priority != s2->priority)
2957 return s1->priority < s2->priority ? -1 : 1;
2958 return 0;
2961 static void
2962 record_overlay_string (struct sortstrlist *ssl, Lisp_Object str,
2963 Lisp_Object str2, Lisp_Object pri, ptrdiff_t size)
2965 EMACS_INT nbytes;
2967 if (ssl->used == ssl->size)
2968 ssl->buf = xpalloc (ssl->buf, &ssl->size, 5, -1, sizeof *ssl->buf);
2969 ssl->buf[ssl->used].string = str;
2970 ssl->buf[ssl->used].string2 = str2;
2971 ssl->buf[ssl->used].size = size;
2972 ssl->buf[ssl->used].priority = (INTEGERP (pri) ? XINT (pri) : 0);
2973 ssl->used++;
2975 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
2976 nbytes = SCHARS (str);
2977 else if (! STRING_MULTIBYTE (str))
2978 nbytes = count_size_as_multibyte (SDATA (str),
2979 SBYTES (str));
2980 else
2981 nbytes = SBYTES (str);
2983 if (INT_ADD_OVERFLOW (ssl->bytes, nbytes))
2984 memory_full (SIZE_MAX);
2985 ssl->bytes += nbytes;
2987 if (STRINGP (str2))
2989 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
2990 nbytes = SCHARS (str2);
2991 else if (! STRING_MULTIBYTE (str2))
2992 nbytes = count_size_as_multibyte (SDATA (str2),
2993 SBYTES (str2));
2994 else
2995 nbytes = SBYTES (str2);
2997 if (INT_ADD_OVERFLOW (ssl->bytes, nbytes))
2998 memory_full (SIZE_MAX);
2999 ssl->bytes += nbytes;
3003 /* Return the concatenation of the strings associated with overlays that
3004 begin or end at POS, ignoring overlays that are specific to a window
3005 other than W. The strings are concatenated in the appropriate order:
3006 shorter overlays nest inside longer ones, and higher priority inside
3007 lower. Normally all of the after-strings come first, but zero-sized
3008 overlays have their after-strings ride along with the before-strings
3009 because it would look strange to print them inside-out.
3011 Returns the string length, and stores the contents indirectly through
3012 PSTR, if that variable is non-null. The string may be overwritten by
3013 subsequent calls. */
3015 EMACS_INT
3016 overlay_strings (EMACS_INT pos, struct window *w, unsigned char **pstr)
3018 Lisp_Object overlay, window, str;
3019 struct Lisp_Overlay *ov;
3020 EMACS_INT startpos, endpos;
3021 int multibyte = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
3023 overlay_heads.used = overlay_heads.bytes = 0;
3024 overlay_tails.used = overlay_tails.bytes = 0;
3025 for (ov = current_buffer->overlays_before; ov; ov = ov->next)
3027 XSETMISC (overlay, ov);
3028 eassert (OVERLAYP (overlay));
3030 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3031 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3032 if (endpos < pos)
3033 break;
3034 if (endpos != pos && startpos != pos)
3035 continue;
3036 window = Foverlay_get (overlay, Qwindow);
3037 if (WINDOWP (window) && XWINDOW (window) != w)
3038 continue;
3039 if (startpos == pos
3040 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3041 record_overlay_string (&overlay_heads, str,
3042 (startpos == endpos
3043 ? Foverlay_get (overlay, Qafter_string)
3044 : Qnil),
3045 Foverlay_get (overlay, Qpriority),
3046 endpos - startpos);
3047 else if (endpos == pos
3048 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3049 record_overlay_string (&overlay_tails, str, Qnil,
3050 Foverlay_get (overlay, Qpriority),
3051 endpos - startpos);
3053 for (ov = current_buffer->overlays_after; ov; ov = ov->next)
3055 XSETMISC (overlay, ov);
3056 eassert (OVERLAYP (overlay));
3058 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3059 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3060 if (startpos > pos)
3061 break;
3062 if (endpos != pos && startpos != pos)
3063 continue;
3064 window = Foverlay_get (overlay, Qwindow);
3065 if (WINDOWP (window) && XWINDOW (window) != w)
3066 continue;
3067 if (startpos == pos
3068 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3069 record_overlay_string (&overlay_heads, str,
3070 (startpos == endpos
3071 ? Foverlay_get (overlay, Qafter_string)
3072 : Qnil),
3073 Foverlay_get (overlay, Qpriority),
3074 endpos - startpos);
3075 else if (endpos == pos
3076 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3077 record_overlay_string (&overlay_tails, str, Qnil,
3078 Foverlay_get (overlay, Qpriority),
3079 endpos - startpos);
3081 if (overlay_tails.used > 1)
3082 qsort (overlay_tails.buf, overlay_tails.used, sizeof (struct sortstr),
3083 cmp_for_strings);
3084 if (overlay_heads.used > 1)
3085 qsort (overlay_heads.buf, overlay_heads.used, sizeof (struct sortstr),
3086 cmp_for_strings);
3087 if (overlay_heads.bytes || overlay_tails.bytes)
3089 Lisp_Object tem;
3090 EMACS_INT i;
3091 unsigned char *p;
3092 ptrdiff_t total;
3094 if (INT_ADD_OVERFLOW (overlay_heads.bytes, overlay_tails.bytes))
3095 memory_full (SIZE_MAX);
3096 total = overlay_heads.bytes + overlay_tails.bytes;
3097 if (total > overlay_str_len)
3098 overlay_str_buf = xpalloc (overlay_str_buf, &overlay_str_len,
3099 total - overlay_str_len, -1, 1);
3101 p = overlay_str_buf;
3102 for (i = overlay_tails.used; --i >= 0;)
3104 EMACS_INT nbytes;
3105 tem = overlay_tails.buf[i].string;
3106 nbytes = copy_text (SDATA (tem), p,
3107 SBYTES (tem),
3108 STRING_MULTIBYTE (tem), multibyte);
3109 p += nbytes;
3111 for (i = 0; i < overlay_heads.used; ++i)
3113 EMACS_INT nbytes;
3114 tem = overlay_heads.buf[i].string;
3115 nbytes = copy_text (SDATA (tem), p,
3116 SBYTES (tem),
3117 STRING_MULTIBYTE (tem), multibyte);
3118 p += nbytes;
3119 tem = overlay_heads.buf[i].string2;
3120 if (STRINGP (tem))
3122 nbytes = copy_text (SDATA (tem), p,
3123 SBYTES (tem),
3124 STRING_MULTIBYTE (tem), multibyte);
3125 p += nbytes;
3128 if (p != overlay_str_buf + total)
3129 abort ();
3130 if (pstr)
3131 *pstr = overlay_str_buf;
3132 return total;
3134 return 0;
3137 /* Shift overlays in BUF's overlay lists, to center the lists at POS. */
3139 void
3140 recenter_overlay_lists (struct buffer *buf, EMACS_INT pos)
3142 Lisp_Object overlay, beg, end;
3143 struct Lisp_Overlay *prev, *tail, *next;
3145 /* See if anything in overlays_before should move to overlays_after. */
3147 /* We don't strictly need prev in this loop; it should always be nil.
3148 But we use it for symmetry and in case that should cease to be true
3149 with some future change. */
3150 prev = NULL;
3151 for (tail = buf->overlays_before; tail; prev = tail, tail = next)
3153 next = tail->next;
3154 XSETMISC (overlay, tail);
3156 /* If the overlay is not valid, get rid of it. */
3157 if (!OVERLAY_VALID (overlay))
3158 #if 1
3159 abort ();
3160 #else
3162 /* Splice the cons cell TAIL out of overlays_before. */
3163 if (!NILP (prev))
3164 XCDR (prev) = next;
3165 else
3166 buf->overlays_before = next;
3167 tail = prev;
3168 continue;
3170 #endif
3172 beg = OVERLAY_START (overlay);
3173 end = OVERLAY_END (overlay);
3175 if (OVERLAY_POSITION (end) > pos)
3177 /* OVERLAY needs to be moved. */
3178 EMACS_INT where = OVERLAY_POSITION (beg);
3179 struct Lisp_Overlay *other, *other_prev;
3181 /* Splice the cons cell TAIL out of overlays_before. */
3182 if (prev)
3183 prev->next = next;
3184 else
3185 buf->overlays_before = next;
3187 /* Search thru overlays_after for where to put it. */
3188 other_prev = NULL;
3189 for (other = buf->overlays_after; other;
3190 other_prev = other, other = other->next)
3192 Lisp_Object otherbeg, otheroverlay;
3194 XSETMISC (otheroverlay, other);
3195 eassert (OVERLAY_VALID (otheroverlay));
3197 otherbeg = OVERLAY_START (otheroverlay);
3198 if (OVERLAY_POSITION (otherbeg) >= where)
3199 break;
3202 /* Add TAIL to overlays_after before OTHER. */
3203 tail->next = other;
3204 if (other_prev)
3205 other_prev->next = tail;
3206 else
3207 buf->overlays_after = tail;
3208 tail = prev;
3210 else
3211 /* We've reached the things that should stay in overlays_before.
3212 All the rest of overlays_before must end even earlier,
3213 so stop now. */
3214 break;
3217 /* See if anything in overlays_after should be in overlays_before. */
3218 prev = NULL;
3219 for (tail = buf->overlays_after; tail; prev = tail, tail = next)
3221 next = tail->next;
3222 XSETMISC (overlay, tail);
3224 /* If the overlay is not valid, get rid of it. */
3225 if (!OVERLAY_VALID (overlay))
3226 #if 1
3227 abort ();
3228 #else
3230 /* Splice the cons cell TAIL out of overlays_after. */
3231 if (!NILP (prev))
3232 XCDR (prev) = next;
3233 else
3234 buf->overlays_after = next;
3235 tail = prev;
3236 continue;
3238 #endif
3240 beg = OVERLAY_START (overlay);
3241 end = OVERLAY_END (overlay);
3243 /* Stop looking, when we know that nothing further
3244 can possibly end before POS. */
3245 if (OVERLAY_POSITION (beg) > pos)
3246 break;
3248 if (OVERLAY_POSITION (end) <= pos)
3250 /* OVERLAY needs to be moved. */
3251 EMACS_INT where = OVERLAY_POSITION (end);
3252 struct Lisp_Overlay *other, *other_prev;
3254 /* Splice the cons cell TAIL out of overlays_after. */
3255 if (prev)
3256 prev->next = next;
3257 else
3258 buf->overlays_after = next;
3260 /* Search thru overlays_before for where to put it. */
3261 other_prev = NULL;
3262 for (other = buf->overlays_before; other;
3263 other_prev = other, other = other->next)
3265 Lisp_Object otherend, otheroverlay;
3267 XSETMISC (otheroverlay, other);
3268 eassert (OVERLAY_VALID (otheroverlay));
3270 otherend = OVERLAY_END (otheroverlay);
3271 if (OVERLAY_POSITION (otherend) <= where)
3272 break;
3275 /* Add TAIL to overlays_before before OTHER. */
3276 tail->next = other;
3277 if (other_prev)
3278 other_prev->next = tail;
3279 else
3280 buf->overlays_before = tail;
3281 tail = prev;
3285 buf->overlay_center = pos;
3288 void
3289 adjust_overlays_for_insert (EMACS_INT pos, EMACS_INT length)
3291 /* After an insertion, the lists are still sorted properly,
3292 but we may need to update the value of the overlay center. */
3293 if (current_buffer->overlay_center >= pos)
3294 current_buffer->overlay_center += length;
3297 void
3298 adjust_overlays_for_delete (EMACS_INT pos, EMACS_INT length)
3300 if (current_buffer->overlay_center < pos)
3301 /* The deletion was to our right. No change needed; the before- and
3302 after-lists are still consistent. */
3304 else if (current_buffer->overlay_center > pos + length)
3305 /* The deletion was to our left. We need to adjust the center value
3306 to account for the change in position, but the lists are consistent
3307 given the new value. */
3308 current_buffer->overlay_center -= length;
3309 else
3310 /* We're right in the middle. There might be things on the after-list
3311 that now belong on the before-list. Recentering will move them,
3312 and also update the center point. */
3313 recenter_overlay_lists (current_buffer, pos);
3316 /* Fix up overlays that were garbled as a result of permuting markers
3317 in the range START through END. Any overlay with at least one
3318 endpoint in this range will need to be unlinked from the overlay
3319 list and reinserted in its proper place.
3320 Such an overlay might even have negative size at this point.
3321 If so, we'll make the overlay empty. */
3322 void
3323 fix_start_end_in_overlays (register EMACS_INT start, register EMACS_INT end)
3325 Lisp_Object overlay;
3326 struct Lisp_Overlay *before_list IF_LINT (= NULL);
3327 struct Lisp_Overlay *after_list IF_LINT (= NULL);
3328 /* These are either nil, indicating that before_list or after_list
3329 should be assigned, or the cons cell the cdr of which should be
3330 assigned. */
3331 struct Lisp_Overlay *beforep = NULL, *afterp = NULL;
3332 /* 'Parent', likewise, indicates a cons cell or
3333 current_buffer->overlays_before or overlays_after, depending
3334 which loop we're in. */
3335 struct Lisp_Overlay *tail, *parent;
3336 EMACS_INT startpos, endpos;
3338 /* This algorithm shifts links around instead of consing and GCing.
3339 The loop invariant is that before_list (resp. after_list) is a
3340 well-formed list except that its last element, the CDR of beforep
3341 (resp. afterp) if beforep (afterp) isn't nil or before_list
3342 (after_list) if it is, is still uninitialized. So it's not a bug
3343 that before_list isn't initialized, although it may look
3344 strange. */
3345 for (parent = NULL, tail = current_buffer->overlays_before; tail;)
3347 XSETMISC (overlay, tail);
3349 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3350 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3352 /* If the overlay is backwards, make it empty. */
3353 if (endpos < startpos)
3355 startpos = endpos;
3356 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3357 Qnil);
3360 if (endpos < start)
3361 break;
3363 if (endpos < end
3364 || (startpos >= start && startpos < end))
3366 /* Add it to the end of the wrong list. Later on,
3367 recenter_overlay_lists will move it to the right place. */
3368 if (endpos < current_buffer->overlay_center)
3370 if (!afterp)
3371 after_list = tail;
3372 else
3373 afterp->next = tail;
3374 afterp = tail;
3376 else
3378 if (!beforep)
3379 before_list = tail;
3380 else
3381 beforep->next = tail;
3382 beforep = tail;
3384 if (!parent)
3385 current_buffer->overlays_before = tail->next;
3386 else
3387 parent->next = tail->next;
3388 tail = tail->next;
3390 else
3391 parent = tail, tail = parent->next;
3393 for (parent = NULL, tail = current_buffer->overlays_after; tail;)
3395 XSETMISC (overlay, tail);
3397 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3398 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3400 /* If the overlay is backwards, make it empty. */
3401 if (endpos < startpos)
3403 startpos = endpos;
3404 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3405 Qnil);
3408 if (startpos >= end)
3409 break;
3411 if (startpos >= start
3412 || (endpos >= start && endpos < end))
3414 if (endpos < current_buffer->overlay_center)
3416 if (!afterp)
3417 after_list = tail;
3418 else
3419 afterp->next = tail;
3420 afterp = tail;
3422 else
3424 if (!beforep)
3425 before_list = tail;
3426 else
3427 beforep->next = tail;
3428 beforep = tail;
3430 if (!parent)
3431 current_buffer->overlays_after = tail->next;
3432 else
3433 parent->next = tail->next;
3434 tail = tail->next;
3436 else
3437 parent = tail, tail = parent->next;
3440 /* Splice the constructed (wrong) lists into the buffer's lists,
3441 and let the recenter function make it sane again. */
3442 if (beforep)
3444 beforep->next = current_buffer->overlays_before;
3445 current_buffer->overlays_before = before_list;
3447 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3449 if (afterp)
3451 afterp->next = current_buffer->overlays_after;
3452 current_buffer->overlays_after = after_list;
3454 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3457 /* We have two types of overlay: the one whose ending marker is
3458 after-insertion-marker (this is the usual case) and the one whose
3459 ending marker is before-insertion-marker. When `overlays_before'
3460 contains overlays of the latter type and the former type in this
3461 order and both overlays end at inserting position, inserting a text
3462 increases only the ending marker of the latter type, which results
3463 in incorrect ordering of `overlays_before'.
3465 This function fixes ordering of overlays in the slot
3466 `overlays_before' of the buffer *BP. Before the insertion, `point'
3467 was at PREV, and now is at POS. */
3469 void
3470 fix_overlays_before (struct buffer *bp, EMACS_INT prev, EMACS_INT pos)
3472 /* If parent is nil, replace overlays_before; otherwise, parent->next. */
3473 struct Lisp_Overlay *tail = bp->overlays_before, *parent = NULL, *right_pair;
3474 Lisp_Object tem;
3475 EMACS_INT end IF_LINT (= 0);
3477 /* After the insertion, the several overlays may be in incorrect
3478 order. The possibility is that, in the list `overlays_before',
3479 an overlay which ends at POS appears after an overlay which ends
3480 at PREV. Since POS is greater than PREV, we must fix the
3481 ordering of these overlays, by moving overlays ends at POS before
3482 the overlays ends at PREV. */
3484 /* At first, find a place where disordered overlays should be linked
3485 in. It is where an overlay which end before POS exists. (i.e. an
3486 overlay whose ending marker is after-insertion-marker if disorder
3487 exists). */
3488 while (tail
3489 && (XSETMISC (tem, tail),
3490 (end = OVERLAY_POSITION (OVERLAY_END (tem))) >= pos))
3492 parent = tail;
3493 tail = tail->next;
3496 /* If we don't find such an overlay,
3497 or the found one ends before PREV,
3498 or the found one is the last one in the list,
3499 we don't have to fix anything. */
3500 if (!tail || end < prev || !tail->next)
3501 return;
3503 right_pair = parent;
3504 parent = tail;
3505 tail = tail->next;
3507 /* Now, end position of overlays in the list TAIL should be before
3508 or equal to PREV. In the loop, an overlay which ends at POS is
3509 moved ahead to the place indicated by the CDR of RIGHT_PAIR. If
3510 we found an overlay which ends before PREV, the remaining
3511 overlays are in correct order. */
3512 while (tail)
3514 XSETMISC (tem, tail);
3515 end = OVERLAY_POSITION (OVERLAY_END (tem));
3517 if (end == pos)
3518 { /* This overlay is disordered. */
3519 struct Lisp_Overlay *found = tail;
3521 /* Unlink the found overlay. */
3522 tail = found->next;
3523 parent->next = tail;
3524 /* Move an overlay at RIGHT_PLACE to the next of the found one,
3525 and link it into the right place. */
3526 if (!right_pair)
3528 found->next = bp->overlays_before;
3529 bp->overlays_before = found;
3531 else
3533 found->next = right_pair->next;
3534 right_pair->next = found;
3537 else if (end == prev)
3539 parent = tail;
3540 tail = tail->next;
3542 else /* No more disordered overlay. */
3543 break;
3547 DEFUN ("overlayp", Foverlayp, Soverlayp, 1, 1, 0,
3548 doc: /* Return t if OBJECT is an overlay. */)
3549 (Lisp_Object object)
3551 return (OVERLAYP (object) ? Qt : Qnil);
3554 DEFUN ("make-overlay", Fmake_overlay, Smake_overlay, 2, 5, 0,
3555 doc: /* Create a new overlay with range BEG to END in BUFFER.
3556 If omitted, BUFFER defaults to the current buffer.
3557 BEG and END may be integers or markers.
3558 The fourth arg FRONT-ADVANCE, if non-nil, makes the marker
3559 for the front of the overlay advance when text is inserted there
3560 \(which means the text *is not* included in the overlay).
3561 The fifth arg REAR-ADVANCE, if non-nil, makes the marker
3562 for the rear of the overlay advance when text is inserted there
3563 \(which means the text *is* included in the overlay). */)
3564 (Lisp_Object beg, Lisp_Object end, Lisp_Object buffer, Lisp_Object front_advance, Lisp_Object rear_advance)
3566 Lisp_Object overlay;
3567 struct buffer *b;
3569 if (NILP (buffer))
3570 XSETBUFFER (buffer, current_buffer);
3571 else
3572 CHECK_BUFFER (buffer);
3573 if (MARKERP (beg)
3574 && ! EQ (Fmarker_buffer (beg), buffer))
3575 error ("Marker points into wrong buffer");
3576 if (MARKERP (end)
3577 && ! EQ (Fmarker_buffer (end), buffer))
3578 error ("Marker points into wrong buffer");
3580 CHECK_NUMBER_COERCE_MARKER (beg);
3581 CHECK_NUMBER_COERCE_MARKER (end);
3583 if (XINT (beg) > XINT (end))
3585 Lisp_Object temp;
3586 temp = beg; beg = end; end = temp;
3589 b = XBUFFER (buffer);
3591 beg = Fset_marker (Fmake_marker (), beg, buffer);
3592 end = Fset_marker (Fmake_marker (), end, buffer);
3594 if (!NILP (front_advance))
3595 XMARKER (beg)->insertion_type = 1;
3596 if (!NILP (rear_advance))
3597 XMARKER (end)->insertion_type = 1;
3599 overlay = allocate_misc ();
3600 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
3601 XOVERLAY (overlay)->start = beg;
3602 XOVERLAY (overlay)->end = end;
3603 XOVERLAY (overlay)->plist = Qnil;
3604 XOVERLAY (overlay)->next = NULL;
3606 /* Put the new overlay on the wrong list. */
3607 end = OVERLAY_END (overlay);
3608 if (OVERLAY_POSITION (end) < b->overlay_center)
3610 if (b->overlays_after)
3611 XOVERLAY (overlay)->next = b->overlays_after;
3612 b->overlays_after = XOVERLAY (overlay);
3614 else
3616 if (b->overlays_before)
3617 XOVERLAY (overlay)->next = b->overlays_before;
3618 b->overlays_before = XOVERLAY (overlay);
3621 /* This puts it in the right list, and in the right order. */
3622 recenter_overlay_lists (b, b->overlay_center);
3624 /* We don't need to redisplay the region covered by the overlay, because
3625 the overlay has no properties at the moment. */
3627 return overlay;
3630 /* Mark a section of BUF as needing redisplay because of overlays changes. */
3632 static void
3633 modify_overlay (struct buffer *buf, EMACS_INT start, EMACS_INT end)
3635 if (start > end)
3637 EMACS_INT temp = start;
3638 start = end;
3639 end = temp;
3642 BUF_COMPUTE_UNCHANGED (buf, start, end);
3644 /* If this is a buffer not in the selected window,
3645 we must do other windows. */
3646 if (buf != XBUFFER (XWINDOW (selected_window)->buffer))
3647 windows_or_buffers_changed = 1;
3648 /* If multiple windows show this buffer, we must do other windows. */
3649 else if (buffer_shared > 1)
3650 windows_or_buffers_changed = 1;
3651 /* If we modify an overlay at the end of the buffer, we cannot
3652 be sure that window end is still valid. */
3653 else if (end >= ZV && start <= ZV)
3654 windows_or_buffers_changed = 1;
3656 ++BUF_OVERLAY_MODIFF (buf);
3660 static struct Lisp_Overlay *
3661 unchain_overlay (struct Lisp_Overlay *list, struct Lisp_Overlay *overlay)
3663 struct Lisp_Overlay *tmp, *prev;
3664 for (tmp = list, prev = NULL; tmp; prev = tmp, tmp = tmp->next)
3665 if (tmp == overlay)
3667 if (prev)
3668 prev->next = tmp->next;
3669 else
3670 list = tmp->next;
3671 overlay->next = NULL;
3672 break;
3674 return list;
3677 DEFUN ("move-overlay", Fmove_overlay, Smove_overlay, 3, 4, 0,
3678 doc: /* Set the endpoints of OVERLAY to BEG and END in BUFFER.
3679 If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.
3680 If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current
3681 buffer. */)
3682 (Lisp_Object overlay, Lisp_Object beg, Lisp_Object end, Lisp_Object buffer)
3684 struct buffer *b, *ob;
3685 Lisp_Object obuffer;
3686 int count = SPECPDL_INDEX ();
3688 CHECK_OVERLAY (overlay);
3689 if (NILP (buffer))
3690 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3691 if (NILP (buffer))
3692 XSETBUFFER (buffer, current_buffer);
3693 CHECK_BUFFER (buffer);
3695 if (MARKERP (beg)
3696 && ! EQ (Fmarker_buffer (beg), buffer))
3697 error ("Marker points into wrong buffer");
3698 if (MARKERP (end)
3699 && ! EQ (Fmarker_buffer (end), buffer))
3700 error ("Marker points into wrong buffer");
3702 CHECK_NUMBER_COERCE_MARKER (beg);
3703 CHECK_NUMBER_COERCE_MARKER (end);
3705 if (XINT (beg) == XINT (end) && ! NILP (Foverlay_get (overlay, Qevaporate)))
3706 return Fdelete_overlay (overlay);
3708 if (XINT (beg) > XINT (end))
3710 Lisp_Object temp;
3711 temp = beg; beg = end; end = temp;
3714 specbind (Qinhibit_quit, Qt);
3716 obuffer = Fmarker_buffer (OVERLAY_START (overlay));
3717 b = XBUFFER (buffer);
3718 ob = BUFFERP (obuffer) ? XBUFFER (obuffer) : (struct buffer *) 0;
3720 /* If the overlay has changed buffers, do a thorough redisplay. */
3721 if (!EQ (buffer, obuffer))
3723 /* Redisplay where the overlay was. */
3724 if (!NILP (obuffer))
3726 EMACS_INT o_beg;
3727 EMACS_INT o_end;
3729 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3730 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3732 modify_overlay (ob, o_beg, o_end);
3735 /* Redisplay where the overlay is going to be. */
3736 modify_overlay (b, XINT (beg), XINT (end));
3738 else
3739 /* Redisplay the area the overlay has just left, or just enclosed. */
3741 EMACS_INT o_beg, o_end;
3743 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3744 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3746 if (o_beg == XINT (beg))
3747 modify_overlay (b, o_end, XINT (end));
3748 else if (o_end == XINT (end))
3749 modify_overlay (b, o_beg, XINT (beg));
3750 else
3752 if (XINT (beg) < o_beg) o_beg = XINT (beg);
3753 if (XINT (end) > o_end) o_end = XINT (end);
3754 modify_overlay (b, o_beg, o_end);
3758 if (!NILP (obuffer))
3760 ob->overlays_before
3761 = unchain_overlay (ob->overlays_before, XOVERLAY (overlay));
3762 ob->overlays_after
3763 = unchain_overlay (ob->overlays_after, XOVERLAY (overlay));
3764 eassert (XOVERLAY (overlay)->next == NULL);
3767 Fset_marker (OVERLAY_START (overlay), beg, buffer);
3768 Fset_marker (OVERLAY_END (overlay), end, buffer);
3770 /* Put the overlay on the wrong list. */
3771 end = OVERLAY_END (overlay);
3772 if (OVERLAY_POSITION (end) < b->overlay_center)
3774 XOVERLAY (overlay)->next = b->overlays_after;
3775 b->overlays_after = XOVERLAY (overlay);
3777 else
3779 XOVERLAY (overlay)->next = b->overlays_before;
3780 b->overlays_before = XOVERLAY (overlay);
3783 /* This puts it in the right list, and in the right order. */
3784 recenter_overlay_lists (b, b->overlay_center);
3786 return unbind_to (count, overlay);
3789 DEFUN ("delete-overlay", Fdelete_overlay, Sdelete_overlay, 1, 1, 0,
3790 doc: /* Delete the overlay OVERLAY from its buffer. */)
3791 (Lisp_Object overlay)
3793 Lisp_Object buffer;
3794 struct buffer *b;
3795 int count = SPECPDL_INDEX ();
3797 CHECK_OVERLAY (overlay);
3799 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3800 if (NILP (buffer))
3801 return Qnil;
3803 b = XBUFFER (buffer);
3804 specbind (Qinhibit_quit, Qt);
3806 b->overlays_before = unchain_overlay (b->overlays_before,XOVERLAY (overlay));
3807 b->overlays_after = unchain_overlay (b->overlays_after, XOVERLAY (overlay));
3808 eassert (XOVERLAY (overlay)->next == NULL);
3809 modify_overlay (b,
3810 marker_position (OVERLAY_START (overlay)),
3811 marker_position (OVERLAY_END (overlay)));
3812 Fset_marker (OVERLAY_START (overlay), Qnil, Qnil);
3813 Fset_marker (OVERLAY_END (overlay), Qnil, Qnil);
3815 /* When deleting an overlay with before or after strings, turn off
3816 display optimizations for the affected buffer, on the basis that
3817 these strings may contain newlines. This is easier to do than to
3818 check for that situation during redisplay. */
3819 if (!windows_or_buffers_changed
3820 && (!NILP (Foverlay_get (overlay, Qbefore_string))
3821 || !NILP (Foverlay_get (overlay, Qafter_string))))
3822 b->prevent_redisplay_optimizations_p = 1;
3824 return unbind_to (count, Qnil);
3827 /* Overlay dissection functions. */
3829 DEFUN ("overlay-start", Foverlay_start, Soverlay_start, 1, 1, 0,
3830 doc: /* Return the position at which OVERLAY starts. */)
3831 (Lisp_Object overlay)
3833 CHECK_OVERLAY (overlay);
3835 return (Fmarker_position (OVERLAY_START (overlay)));
3838 DEFUN ("overlay-end", Foverlay_end, Soverlay_end, 1, 1, 0,
3839 doc: /* Return the position at which OVERLAY ends. */)
3840 (Lisp_Object overlay)
3842 CHECK_OVERLAY (overlay);
3844 return (Fmarker_position (OVERLAY_END (overlay)));
3847 DEFUN ("overlay-buffer", Foverlay_buffer, Soverlay_buffer, 1, 1, 0,
3848 doc: /* Return the buffer OVERLAY belongs to.
3849 Return nil if OVERLAY has been deleted. */)
3850 (Lisp_Object overlay)
3852 CHECK_OVERLAY (overlay);
3854 return Fmarker_buffer (OVERLAY_START (overlay));
3857 DEFUN ("overlay-properties", Foverlay_properties, Soverlay_properties, 1, 1, 0,
3858 doc: /* Return a list of the properties on OVERLAY.
3859 This is a copy of OVERLAY's plist; modifying its conses has no effect on
3860 OVERLAY. */)
3861 (Lisp_Object overlay)
3863 CHECK_OVERLAY (overlay);
3865 return Fcopy_sequence (XOVERLAY (overlay)->plist);
3869 DEFUN ("overlays-at", Foverlays_at, Soverlays_at, 1, 1, 0,
3870 doc: /* Return a list of the overlays that contain the character at POS. */)
3871 (Lisp_Object pos)
3873 ptrdiff_t len, noverlays;
3874 Lisp_Object *overlay_vec;
3875 Lisp_Object result;
3877 CHECK_NUMBER_COERCE_MARKER (pos);
3879 len = 10;
3880 /* We can't use alloca here because overlays_at can call xrealloc. */
3881 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3883 /* Put all the overlays we want in a vector in overlay_vec.
3884 Store the length in len. */
3885 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3886 (EMACS_INT *) 0, (EMACS_INT *) 0, 0);
3888 /* Make a list of them all. */
3889 result = Flist (noverlays, overlay_vec);
3891 xfree (overlay_vec);
3892 return result;
3895 DEFUN ("overlays-in", Foverlays_in, Soverlays_in, 2, 2, 0,
3896 doc: /* Return a list of the overlays that overlap the region BEG ... END.
3897 Overlap means that at least one character is contained within the overlay
3898 and also contained within the specified region.
3899 Empty overlays are included in the result if they are located at BEG,
3900 between BEG and END, or at END provided END denotes the position at the
3901 end of the buffer. */)
3902 (Lisp_Object beg, Lisp_Object end)
3904 ptrdiff_t len, noverlays;
3905 Lisp_Object *overlay_vec;
3906 Lisp_Object result;
3908 CHECK_NUMBER_COERCE_MARKER (beg);
3909 CHECK_NUMBER_COERCE_MARKER (end);
3911 len = 10;
3912 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3914 /* Put all the overlays we want in a vector in overlay_vec.
3915 Store the length in len. */
3916 noverlays = overlays_in (XINT (beg), XINT (end), 1, &overlay_vec, &len,
3917 NULL, NULL);
3919 /* Make a list of them all. */
3920 result = Flist (noverlays, overlay_vec);
3922 xfree (overlay_vec);
3923 return result;
3926 DEFUN ("next-overlay-change", Fnext_overlay_change, Snext_overlay_change,
3927 1, 1, 0,
3928 doc: /* Return the next position after POS where an overlay starts or ends.
3929 If there are no overlay boundaries from POS to (point-max),
3930 the value is (point-max). */)
3931 (Lisp_Object pos)
3933 ptrdiff_t i, len, noverlays;
3934 EMACS_INT endpos;
3935 Lisp_Object *overlay_vec;
3937 CHECK_NUMBER_COERCE_MARKER (pos);
3939 len = 10;
3940 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3942 /* Put all the overlays we want in a vector in overlay_vec.
3943 Store the length in len.
3944 endpos gets the position where the next overlay starts. */
3945 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3946 &endpos, (EMACS_INT *) 0, 1);
3948 /* If any of these overlays ends before endpos,
3949 use its ending point instead. */
3950 for (i = 0; i < noverlays; i++)
3952 Lisp_Object oend;
3953 EMACS_INT oendpos;
3955 oend = OVERLAY_END (overlay_vec[i]);
3956 oendpos = OVERLAY_POSITION (oend);
3957 if (oendpos < endpos)
3958 endpos = oendpos;
3961 xfree (overlay_vec);
3962 return make_number (endpos);
3965 DEFUN ("previous-overlay-change", Fprevious_overlay_change,
3966 Sprevious_overlay_change, 1, 1, 0,
3967 doc: /* Return the previous position before POS where an overlay starts or ends.
3968 If there are no overlay boundaries from (point-min) to POS,
3969 the value is (point-min). */)
3970 (Lisp_Object pos)
3972 EMACS_INT prevpos;
3973 Lisp_Object *overlay_vec;
3974 ptrdiff_t len;
3976 CHECK_NUMBER_COERCE_MARKER (pos);
3978 /* At beginning of buffer, we know the answer;
3979 avoid bug subtracting 1 below. */
3980 if (XINT (pos) == BEGV)
3981 return pos;
3983 len = 10;
3984 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3986 /* Put all the overlays we want in a vector in overlay_vec.
3987 Store the length in len.
3988 prevpos gets the position of the previous change. */
3989 overlays_at (XINT (pos), 1, &overlay_vec, &len,
3990 (EMACS_INT *) 0, &prevpos, 1);
3992 xfree (overlay_vec);
3993 return make_number (prevpos);
3996 /* These functions are for debugging overlays. */
3998 DEFUN ("overlay-lists", Foverlay_lists, Soverlay_lists, 0, 0, 0,
3999 doc: /* Return a pair of lists giving all the overlays of the current buffer.
4000 The car has all the overlays before the overlay center;
4001 the cdr has all the overlays after the overlay center.
4002 Recentering overlays moves overlays between these lists.
4003 The lists you get are copies, so that changing them has no effect.
4004 However, the overlays you get are the real objects that the buffer uses. */)
4005 (void)
4007 struct Lisp_Overlay *ol;
4008 Lisp_Object before = Qnil, after = Qnil, tmp;
4009 for (ol = current_buffer->overlays_before; ol; ol = ol->next)
4011 XSETMISC (tmp, ol);
4012 before = Fcons (tmp, before);
4014 for (ol = current_buffer->overlays_after; ol; ol = ol->next)
4016 XSETMISC (tmp, ol);
4017 after = Fcons (tmp, after);
4019 return Fcons (Fnreverse (before), Fnreverse (after));
4022 DEFUN ("overlay-recenter", Foverlay_recenter, Soverlay_recenter, 1, 1, 0,
4023 doc: /* Recenter the overlays of the current buffer around position POS.
4024 That makes overlay lookup faster for positions near POS (but perhaps slower
4025 for positions far away from POS). */)
4026 (Lisp_Object pos)
4028 CHECK_NUMBER_COERCE_MARKER (pos);
4030 recenter_overlay_lists (current_buffer, XINT (pos));
4031 return Qnil;
4034 DEFUN ("overlay-get", Foverlay_get, Soverlay_get, 2, 2, 0,
4035 doc: /* Get the property of overlay OVERLAY with property name PROP. */)
4036 (Lisp_Object overlay, Lisp_Object prop)
4038 CHECK_OVERLAY (overlay);
4039 return lookup_char_property (XOVERLAY (overlay)->plist, prop, 0);
4042 DEFUN ("overlay-put", Foverlay_put, Soverlay_put, 3, 3, 0,
4043 doc: /* Set one property of overlay OVERLAY: give property PROP value VALUE.
4044 VALUE will be returned.*/)
4045 (Lisp_Object overlay, Lisp_Object prop, Lisp_Object value)
4047 Lisp_Object tail, buffer;
4048 int changed;
4050 CHECK_OVERLAY (overlay);
4052 buffer = Fmarker_buffer (OVERLAY_START (overlay));
4054 for (tail = XOVERLAY (overlay)->plist;
4055 CONSP (tail) && CONSP (XCDR (tail));
4056 tail = XCDR (XCDR (tail)))
4057 if (EQ (XCAR (tail), prop))
4059 changed = !EQ (XCAR (XCDR (tail)), value);
4060 XSETCAR (XCDR (tail), value);
4061 goto found;
4063 /* It wasn't in the list, so add it to the front. */
4064 changed = !NILP (value);
4065 XOVERLAY (overlay)->plist
4066 = Fcons (prop, Fcons (value, XOVERLAY (overlay)->plist));
4067 found:
4068 if (! NILP (buffer))
4070 if (changed)
4071 modify_overlay (XBUFFER (buffer),
4072 marker_position (OVERLAY_START (overlay)),
4073 marker_position (OVERLAY_END (overlay)));
4074 if (EQ (prop, Qevaporate) && ! NILP (value)
4075 && (OVERLAY_POSITION (OVERLAY_START (overlay))
4076 == OVERLAY_POSITION (OVERLAY_END (overlay))))
4077 Fdelete_overlay (overlay);
4080 return value;
4083 /* Subroutine of report_overlay_modification. */
4085 /* Lisp vector holding overlay hook functions to call.
4086 Vector elements come in pairs.
4087 Each even-index element is a list of hook functions.
4088 The following odd-index element is the overlay they came from.
4090 Before the buffer change, we fill in this vector
4091 as we call overlay hook functions.
4092 After the buffer change, we get the functions to call from this vector.
4093 This way we always call the same functions before and after the change. */
4094 static Lisp_Object last_overlay_modification_hooks;
4096 /* Number of elements actually used in last_overlay_modification_hooks. */
4097 static int last_overlay_modification_hooks_used;
4099 /* Add one functionlist/overlay pair
4100 to the end of last_overlay_modification_hooks. */
4102 static void
4103 add_overlay_mod_hooklist (Lisp_Object functionlist, Lisp_Object overlay)
4105 int oldsize = ASIZE (last_overlay_modification_hooks);
4107 if (last_overlay_modification_hooks_used == oldsize)
4108 last_overlay_modification_hooks = larger_vector
4109 (last_overlay_modification_hooks, oldsize * 2, Qnil);
4110 ASET (last_overlay_modification_hooks, last_overlay_modification_hooks_used,
4111 functionlist); last_overlay_modification_hooks_used++;
4112 ASET (last_overlay_modification_hooks, last_overlay_modification_hooks_used,
4113 overlay); last_overlay_modification_hooks_used++;
4116 /* Run the modification-hooks of overlays that include
4117 any part of the text in START to END.
4118 If this change is an insertion, also
4119 run the insert-before-hooks of overlay starting at END,
4120 and the insert-after-hooks of overlay ending at START.
4122 This is called both before and after the modification.
4123 AFTER is nonzero when we call after the modification.
4125 ARG1, ARG2, ARG3 are arguments to pass to the hook functions.
4126 When AFTER is nonzero, they are the start position,
4127 the position after the inserted new text,
4128 and the length of deleted or replaced old text. */
4130 void
4131 report_overlay_modification (Lisp_Object start, Lisp_Object end, int after,
4132 Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3)
4134 Lisp_Object prop, overlay;
4135 struct Lisp_Overlay *tail;
4136 /* 1 if this change is an insertion. */
4137 int insertion = (after ? XFASTINT (arg3) == 0 : EQ (start, end));
4138 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4140 overlay = Qnil;
4141 tail = NULL;
4143 /* We used to run the functions as soon as we found them and only register
4144 them in last_overlay_modification_hooks for the purpose of the `after'
4145 case. But running elisp code as we traverse the list of overlays is
4146 painful because the list can be modified by the elisp code so we had to
4147 copy at several places. We now simply do a read-only traversal that
4148 only collects the functions to run and we run them afterwards. It's
4149 simpler, especially since all the code was already there. -stef */
4151 if (!after)
4153 /* We are being called before a change.
4154 Scan the overlays to find the functions to call. */
4155 last_overlay_modification_hooks_used = 0;
4156 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4158 EMACS_INT startpos, endpos;
4159 Lisp_Object ostart, oend;
4161 XSETMISC (overlay, tail);
4163 ostart = OVERLAY_START (overlay);
4164 oend = OVERLAY_END (overlay);
4165 endpos = OVERLAY_POSITION (oend);
4166 if (XFASTINT (start) > endpos)
4167 break;
4168 startpos = OVERLAY_POSITION (ostart);
4169 if (insertion && (XFASTINT (start) == startpos
4170 || XFASTINT (end) == startpos))
4172 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4173 if (!NILP (prop))
4174 add_overlay_mod_hooklist (prop, overlay);
4176 if (insertion && (XFASTINT (start) == endpos
4177 || XFASTINT (end) == endpos))
4179 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4180 if (!NILP (prop))
4181 add_overlay_mod_hooklist (prop, overlay);
4183 /* Test for intersecting intervals. This does the right thing
4184 for both insertion and deletion. */
4185 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4187 prop = Foverlay_get (overlay, Qmodification_hooks);
4188 if (!NILP (prop))
4189 add_overlay_mod_hooklist (prop, overlay);
4193 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4195 EMACS_INT startpos, endpos;
4196 Lisp_Object ostart, oend;
4198 XSETMISC (overlay, tail);
4200 ostart = OVERLAY_START (overlay);
4201 oend = OVERLAY_END (overlay);
4202 startpos = OVERLAY_POSITION (ostart);
4203 endpos = OVERLAY_POSITION (oend);
4204 if (XFASTINT (end) < startpos)
4205 break;
4206 if (insertion && (XFASTINT (start) == startpos
4207 || XFASTINT (end) == startpos))
4209 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4210 if (!NILP (prop))
4211 add_overlay_mod_hooklist (prop, overlay);
4213 if (insertion && (XFASTINT (start) == endpos
4214 || XFASTINT (end) == endpos))
4216 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4217 if (!NILP (prop))
4218 add_overlay_mod_hooklist (prop, overlay);
4220 /* Test for intersecting intervals. This does the right thing
4221 for both insertion and deletion. */
4222 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4224 prop = Foverlay_get (overlay, Qmodification_hooks);
4225 if (!NILP (prop))
4226 add_overlay_mod_hooklist (prop, overlay);
4231 GCPRO4 (overlay, arg1, arg2, arg3);
4233 /* Call the functions recorded in last_overlay_modification_hooks.
4234 First copy the vector contents, in case some of these hooks
4235 do subsequent modification of the buffer. */
4236 int size = last_overlay_modification_hooks_used;
4237 Lisp_Object *copy = (Lisp_Object *) alloca (size * sizeof (Lisp_Object));
4238 int i;
4240 memcpy (copy, XVECTOR (last_overlay_modification_hooks)->contents,
4241 size * sizeof (Lisp_Object));
4242 gcpro1.var = copy;
4243 gcpro1.nvars = size;
4245 for (i = 0; i < size;)
4247 Lisp_Object prop_i, overlay_i;
4248 prop_i = copy[i++];
4249 overlay_i = copy[i++];
4250 call_overlay_mod_hooks (prop_i, overlay_i, after, arg1, arg2, arg3);
4253 UNGCPRO;
4256 static void
4257 call_overlay_mod_hooks (Lisp_Object list, Lisp_Object overlay, int after,
4258 Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3)
4260 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4262 GCPRO4 (list, arg1, arg2, arg3);
4264 while (CONSP (list))
4266 if (NILP (arg3))
4267 call4 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2);
4268 else
4269 call5 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2, arg3);
4270 list = XCDR (list);
4272 UNGCPRO;
4275 /* Delete any zero-sized overlays at position POS, if the `evaporate'
4276 property is set. */
4277 void
4278 evaporate_overlays (EMACS_INT pos)
4280 Lisp_Object overlay, hit_list;
4281 struct Lisp_Overlay *tail;
4283 hit_list = Qnil;
4284 if (pos <= current_buffer->overlay_center)
4285 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4287 EMACS_INT endpos;
4288 XSETMISC (overlay, tail);
4289 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
4290 if (endpos < pos)
4291 break;
4292 if (endpos == pos && OVERLAY_POSITION (OVERLAY_START (overlay)) == pos
4293 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4294 hit_list = Fcons (overlay, hit_list);
4296 else
4297 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4299 EMACS_INT startpos;
4300 XSETMISC (overlay, tail);
4301 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
4302 if (startpos > pos)
4303 break;
4304 if (startpos == pos && OVERLAY_POSITION (OVERLAY_END (overlay)) == pos
4305 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4306 hit_list = Fcons (overlay, hit_list);
4308 for (; CONSP (hit_list); hit_list = XCDR (hit_list))
4309 Fdelete_overlay (XCAR (hit_list));
4312 /* Somebody has tried to store a value with an unacceptable type
4313 in the slot with offset OFFSET. */
4315 void
4316 buffer_slot_type_mismatch (Lisp_Object newval, int type)
4318 Lisp_Object predicate;
4320 switch (type)
4322 case_Lisp_Int: predicate = Qintegerp; break;
4323 case Lisp_String: predicate = Qstringp; break;
4324 case Lisp_Symbol: predicate = Qsymbolp; break;
4325 default: abort ();
4328 wrong_type_argument (predicate, newval);
4332 /***********************************************************************
4333 Allocation with mmap
4334 ***********************************************************************/
4336 #ifdef USE_MMAP_FOR_BUFFERS
4338 #include <sys/types.h>
4339 #include <sys/mman.h>
4341 #ifndef MAP_ANON
4342 #ifdef MAP_ANONYMOUS
4343 #define MAP_ANON MAP_ANONYMOUS
4344 #else
4345 #define MAP_ANON 0
4346 #endif
4347 #endif
4349 #ifndef MAP_FAILED
4350 #define MAP_FAILED ((void *) -1)
4351 #endif
4353 #include <stdio.h>
4355 #if MAP_ANON == 0
4356 #include <fcntl.h>
4357 #endif
4359 #include "coding.h"
4362 /* Memory is allocated in regions which are mapped using mmap(2).
4363 The current implementation lets the system select mapped
4364 addresses; we're not using MAP_FIXED in general, except when
4365 trying to enlarge regions.
4367 Each mapped region starts with a mmap_region structure, the user
4368 area starts after that structure, aligned to MEM_ALIGN.
4370 +-----------------------+
4371 | struct mmap_info + |
4372 | padding |
4373 +-----------------------+
4374 | user data |
4377 +-----------------------+ */
4379 struct mmap_region
4381 /* User-specified size. */
4382 size_t nbytes_specified;
4384 /* Number of bytes mapped */
4385 size_t nbytes_mapped;
4387 /* Pointer to the location holding the address of the memory
4388 allocated with the mmap'd block. The variable actually points
4389 after this structure. */
4390 POINTER_TYPE **var;
4392 /* Next and previous in list of all mmap'd regions. */
4393 struct mmap_region *next, *prev;
4396 /* Doubly-linked list of mmap'd regions. */
4398 static struct mmap_region *mmap_regions;
4400 /* File descriptor for mmap. If we don't have anonymous mapping,
4401 /dev/zero will be opened on it. */
4403 static int mmap_fd;
4405 /* Temporary storage for mmap_set_vars, see there. */
4407 static struct mmap_region *mmap_regions_1;
4408 static int mmap_fd_1;
4410 /* Page size on this system. */
4412 static int mmap_page_size;
4414 /* 1 means mmap has been initialized. */
4416 static int mmap_initialized_p;
4418 /* Value is X rounded up to the next multiple of N. */
4420 #define ROUND(X, N) (((X) + (N) - 1) / (N) * (N))
4422 /* Size of mmap_region structure plus padding. */
4424 #define MMAP_REGION_STRUCT_SIZE \
4425 ROUND (sizeof (struct mmap_region), MEM_ALIGN)
4427 /* Given a pointer P to the start of the user-visible part of a mapped
4428 region, return a pointer to the start of the region. */
4430 #define MMAP_REGION(P) \
4431 ((struct mmap_region *) ((char *) (P) - MMAP_REGION_STRUCT_SIZE))
4433 /* Given a pointer P to the start of a mapped region, return a pointer
4434 to the start of the user-visible part of the region. */
4436 #define MMAP_USER_AREA(P) \
4437 ((POINTER_TYPE *) ((char *) (P) + MMAP_REGION_STRUCT_SIZE))
4439 #define MEM_ALIGN sizeof (double)
4441 /* Predicate returning true if part of the address range [START .. END]
4442 is currently mapped. Used to prevent overwriting an existing
4443 memory mapping.
4445 Default is to conservatively assume the address range is occupied by
4446 something else. This can be overridden by system configuration
4447 files if system-specific means to determine this exists. */
4449 #ifndef MMAP_ALLOCATED_P
4450 #define MMAP_ALLOCATED_P(start, end) 1
4451 #endif
4453 /* Perform necessary initializations for the use of mmap. */
4455 static void
4456 mmap_init (void)
4458 #if MAP_ANON == 0
4459 /* The value of mmap_fd is initially 0 in temacs, and -1
4460 in a dumped Emacs. */
4461 if (mmap_fd <= 0)
4463 /* No anonymous mmap -- we need the file descriptor. */
4464 mmap_fd = open ("/dev/zero", O_RDONLY);
4465 if (mmap_fd == -1)
4466 fatal ("Cannot open /dev/zero: %s", emacs_strerror (errno));
4468 #endif /* MAP_ANON == 0 */
4470 if (mmap_initialized_p)
4471 return;
4472 mmap_initialized_p = 1;
4474 #if MAP_ANON != 0
4475 mmap_fd = -1;
4476 #endif
4478 mmap_page_size = getpagesize ();
4481 /* Return a region overlapping address range START...END, or null if
4482 none. END is not including, i.e. the last byte in the range
4483 is at END - 1. */
4485 static struct mmap_region *
4486 mmap_find (POINTER_TYPE *start, POINTER_TYPE *end)
4488 struct mmap_region *r;
4489 char *s = (char *) start, *e = (char *) end;
4491 for (r = mmap_regions; r; r = r->next)
4493 char *rstart = (char *) r;
4494 char *rend = rstart + r->nbytes_mapped;
4496 if (/* First byte of range, i.e. START, in this region? */
4497 (s >= rstart && s < rend)
4498 /* Last byte of range, i.e. END - 1, in this region? */
4499 || (e > rstart && e <= rend)
4500 /* First byte of this region in the range? */
4501 || (rstart >= s && rstart < e)
4502 /* Last byte of this region in the range? */
4503 || (rend > s && rend <= e))
4504 break;
4507 return r;
4511 /* Unmap a region. P is a pointer to the start of the user-araa of
4512 the region. Value is non-zero if successful. */
4514 static int
4515 mmap_free_1 (struct mmap_region *r)
4517 if (r->next)
4518 r->next->prev = r->prev;
4519 if (r->prev)
4520 r->prev->next = r->next;
4521 else
4522 mmap_regions = r->next;
4524 if (munmap ((POINTER_TYPE *) r, r->nbytes_mapped) == -1)
4526 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4527 return 0;
4530 return 1;
4534 /* Enlarge region R by NPAGES pages. NPAGES < 0 means shrink R.
4535 Value is non-zero if successful. */
4537 static int
4538 mmap_enlarge (struct mmap_region *r, int npages)
4540 char *region_end = (char *) r + r->nbytes_mapped;
4541 size_t nbytes;
4542 int success = 0;
4544 if (npages < 0)
4546 /* Unmap pages at the end of the region. */
4547 nbytes = - npages * mmap_page_size;
4548 if (munmap (region_end - nbytes, nbytes) == -1)
4549 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4550 else
4552 r->nbytes_mapped -= nbytes;
4553 success = 1;
4556 else if (npages > 0)
4558 nbytes = npages * mmap_page_size;
4560 /* Try to map additional pages at the end of the region. We
4561 cannot do this if the address range is already occupied by
4562 something else because mmap deletes any previous mapping.
4563 I'm not sure this is worth doing, let's see. */
4564 if (!MMAP_ALLOCATED_P (region_end, region_end + nbytes))
4566 POINTER_TYPE *p;
4568 p = mmap (region_end, nbytes, PROT_READ | PROT_WRITE,
4569 MAP_ANON | MAP_PRIVATE | MAP_FIXED, mmap_fd, 0);
4570 if (p == MAP_FAILED)
4571 ; /* fprintf (stderr, "mmap: %s\n", emacs_strerror (errno)); */
4572 else if (p != (POINTER_TYPE *) region_end)
4574 /* Kernels are free to choose a different address. In
4575 that case, unmap what we've mapped above; we have
4576 no use for it. */
4577 if (munmap (p, nbytes) == -1)
4578 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4580 else
4582 r->nbytes_mapped += nbytes;
4583 success = 1;
4588 return success;
4592 /* Set or reset variables holding references to mapped regions. If
4593 RESTORE_P is zero, set all variables to null. If RESTORE_P is
4594 non-zero, set all variables to the start of the user-areas
4595 of mapped regions.
4597 This function is called from Fdump_emacs to ensure that the dumped
4598 Emacs doesn't contain references to memory that won't be mapped
4599 when Emacs starts. */
4601 void
4602 mmap_set_vars (int restore_p)
4604 struct mmap_region *r;
4606 if (restore_p)
4608 mmap_regions = mmap_regions_1;
4609 mmap_fd = mmap_fd_1;
4610 for (r = mmap_regions; r; r = r->next)
4611 *r->var = MMAP_USER_AREA (r);
4613 else
4615 for (r = mmap_regions; r; r = r->next)
4616 *r->var = NULL;
4617 mmap_regions_1 = mmap_regions;
4618 mmap_regions = NULL;
4619 mmap_fd_1 = mmap_fd;
4620 mmap_fd = -1;
4625 /* Allocate a block of storage large enough to hold NBYTES bytes of
4626 data. A pointer to the data is returned in *VAR. VAR is thus the
4627 address of some variable which will use the data area.
4629 The allocation of 0 bytes is valid.
4631 If we can't allocate the necessary memory, set *VAR to null, and
4632 return null. */
4634 static POINTER_TYPE *
4635 mmap_alloc (POINTER_TYPE **var, size_t nbytes)
4637 void *p;
4638 size_t map;
4640 mmap_init ();
4642 map = ROUND (nbytes + MMAP_REGION_STRUCT_SIZE, mmap_page_size);
4643 p = mmap (NULL, map, PROT_READ | PROT_WRITE, MAP_ANON | MAP_PRIVATE,
4644 mmap_fd, 0);
4646 if (p == MAP_FAILED)
4648 if (errno != ENOMEM)
4649 fprintf (stderr, "mmap: %s\n", emacs_strerror (errno));
4650 p = NULL;
4652 else
4654 struct mmap_region *r = (struct mmap_region *) p;
4656 r->nbytes_specified = nbytes;
4657 r->nbytes_mapped = map;
4658 r->var = var;
4659 r->prev = NULL;
4660 r->next = mmap_regions;
4661 if (r->next)
4662 r->next->prev = r;
4663 mmap_regions = r;
4665 p = MMAP_USER_AREA (p);
4668 return *var = p;
4672 /* Free a block of relocatable storage whose data is pointed to by
4673 PTR. Store 0 in *PTR to show there's no block allocated. */
4675 static void
4676 mmap_free (POINTER_TYPE **var)
4678 mmap_init ();
4680 if (*var)
4682 mmap_free_1 (MMAP_REGION (*var));
4683 *var = NULL;
4688 /* Given a pointer at address VAR to data allocated with mmap_alloc,
4689 resize it to size NBYTES. Change *VAR to reflect the new block,
4690 and return this value. If more memory cannot be allocated, then
4691 leave *VAR unchanged, and return null. */
4693 static POINTER_TYPE *
4694 mmap_realloc (POINTER_TYPE **var, size_t nbytes)
4696 POINTER_TYPE *result;
4698 mmap_init ();
4700 if (*var == NULL)
4701 result = mmap_alloc (var, nbytes);
4702 else if (nbytes == 0)
4704 mmap_free (var);
4705 result = mmap_alloc (var, nbytes);
4707 else
4709 struct mmap_region *r = MMAP_REGION (*var);
4710 size_t room = r->nbytes_mapped - MMAP_REGION_STRUCT_SIZE;
4712 if (room < nbytes)
4714 /* Must enlarge. */
4715 POINTER_TYPE *old_ptr = *var;
4717 /* Try to map additional pages at the end of the region.
4718 If that fails, allocate a new region, copy data
4719 from the old region, then free it. */
4720 if (mmap_enlarge (r, (ROUND (nbytes - room, mmap_page_size)
4721 / mmap_page_size)))
4723 r->nbytes_specified = nbytes;
4724 *var = result = old_ptr;
4726 else if (mmap_alloc (var, nbytes))
4728 memcpy (*var, old_ptr, r->nbytes_specified);
4729 mmap_free_1 (MMAP_REGION (old_ptr));
4730 result = *var;
4731 r = MMAP_REGION (result);
4732 r->nbytes_specified = nbytes;
4734 else
4736 *var = old_ptr;
4737 result = NULL;
4740 else if (room - nbytes >= mmap_page_size)
4742 /* Shrinking by at least a page. Let's give some
4743 memory back to the system.
4745 The extra parens are to make the division happens first,
4746 on positive values, so we know it will round towards
4747 zero. */
4748 mmap_enlarge (r, - ((room - nbytes) / mmap_page_size));
4749 result = *var;
4750 r->nbytes_specified = nbytes;
4752 else
4754 /* Leave it alone. */
4755 result = *var;
4756 r->nbytes_specified = nbytes;
4760 return result;
4764 #endif /* USE_MMAP_FOR_BUFFERS */
4768 /***********************************************************************
4769 Buffer-text Allocation
4770 ***********************************************************************/
4772 #ifdef REL_ALLOC
4773 extern POINTER_TYPE *r_alloc (POINTER_TYPE **, size_t);
4774 extern POINTER_TYPE *r_re_alloc (POINTER_TYPE **, size_t);
4775 extern void r_alloc_free (POINTER_TYPE **ptr);
4776 #endif /* REL_ALLOC */
4779 /* Allocate NBYTES bytes for buffer B's text buffer. */
4781 static void
4782 alloc_buffer_text (struct buffer *b, ptrdiff_t nbytes)
4784 POINTER_TYPE *p;
4786 BLOCK_INPUT;
4787 #if defined USE_MMAP_FOR_BUFFERS
4788 p = mmap_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4789 #elif defined REL_ALLOC
4790 p = r_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4791 #else
4792 p = xmalloc (nbytes);
4793 #endif
4795 if (p == NULL)
4797 UNBLOCK_INPUT;
4798 memory_full (nbytes);
4801 b->text->beg = (unsigned char *) p;
4802 UNBLOCK_INPUT;
4805 /* Enlarge buffer B's text buffer by DELTA bytes. DELTA < 0 means
4806 shrink it. */
4808 void
4809 enlarge_buffer_text (struct buffer *b, EMACS_INT delta)
4811 POINTER_TYPE *p;
4812 ptrdiff_t nbytes = (BUF_Z_BYTE (b) - BUF_BEG_BYTE (b) + BUF_GAP_SIZE (b) + 1
4813 + delta);
4814 BLOCK_INPUT;
4815 #if defined USE_MMAP_FOR_BUFFERS
4816 p = mmap_realloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4817 #elif defined REL_ALLOC
4818 p = r_re_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4819 #else
4820 p = xrealloc (b->text->beg, nbytes);
4821 #endif
4823 if (p == NULL)
4825 UNBLOCK_INPUT;
4826 memory_full (nbytes);
4829 BUF_BEG_ADDR (b) = (unsigned char *) p;
4830 UNBLOCK_INPUT;
4834 /* Free buffer B's text buffer. */
4836 static void
4837 free_buffer_text (struct buffer *b)
4839 BLOCK_INPUT;
4841 #if defined USE_MMAP_FOR_BUFFERS
4842 mmap_free ((POINTER_TYPE **) &b->text->beg);
4843 #elif defined REL_ALLOC
4844 r_alloc_free ((POINTER_TYPE **) &b->text->beg);
4845 #else
4846 xfree (b->text->beg);
4847 #endif
4849 BUF_BEG_ADDR (b) = NULL;
4850 UNBLOCK_INPUT;
4855 /***********************************************************************
4856 Initialization
4857 ***********************************************************************/
4859 void
4860 init_buffer_once (void)
4862 int idx;
4864 memset (buffer_permanent_local_flags, 0, sizeof buffer_permanent_local_flags);
4866 /* Make sure all markable slots in buffer_defaults
4867 are initialized reasonably, so mark_buffer won't choke. */
4868 reset_buffer (&buffer_defaults);
4869 eassert (EQ (BVAR (&buffer_defaults, name), make_number (0)));
4870 reset_buffer_local_variables (&buffer_defaults, 1);
4871 eassert (EQ (BVAR (&buffer_local_symbols, name), make_number (0)));
4872 reset_buffer (&buffer_local_symbols);
4873 reset_buffer_local_variables (&buffer_local_symbols, 1);
4874 /* Prevent GC from getting confused. */
4875 buffer_defaults.text = &buffer_defaults.own_text;
4876 buffer_local_symbols.text = &buffer_local_symbols.own_text;
4877 BUF_INTERVALS (&buffer_defaults) = 0;
4878 BUF_INTERVALS (&buffer_local_symbols) = 0;
4879 XSETPVECTYPESIZE (&buffer_defaults, PVEC_BUFFER, 0);
4880 XSETBUFFER (Vbuffer_defaults, &buffer_defaults);
4881 XSETPVECTYPESIZE (&buffer_local_symbols, PVEC_BUFFER, 0);
4882 XSETBUFFER (Vbuffer_local_symbols, &buffer_local_symbols);
4884 /* Set up the default values of various buffer slots. */
4885 /* Must do these before making the first buffer! */
4887 /* real setup is done in bindings.el */
4888 BVAR (&buffer_defaults, mode_line_format) = make_pure_c_string ("%-");
4889 BVAR (&buffer_defaults, header_line_format) = Qnil;
4890 BVAR (&buffer_defaults, abbrev_mode) = Qnil;
4891 BVAR (&buffer_defaults, overwrite_mode) = Qnil;
4892 BVAR (&buffer_defaults, case_fold_search) = Qt;
4893 BVAR (&buffer_defaults, auto_fill_function) = Qnil;
4894 BVAR (&buffer_defaults, selective_display) = Qnil;
4895 #ifndef old
4896 BVAR (&buffer_defaults, selective_display_ellipses) = Qt;
4897 #endif
4898 BVAR (&buffer_defaults, abbrev_table) = Qnil;
4899 BVAR (&buffer_defaults, display_table) = Qnil;
4900 BVAR (&buffer_defaults, undo_list) = Qnil;
4901 BVAR (&buffer_defaults, mark_active) = Qnil;
4902 BVAR (&buffer_defaults, file_format) = Qnil;
4903 BVAR (&buffer_defaults, auto_save_file_format) = Qt;
4904 buffer_defaults.overlays_before = NULL;
4905 buffer_defaults.overlays_after = NULL;
4906 buffer_defaults.overlay_center = BEG;
4908 XSETFASTINT (BVAR (&buffer_defaults, tab_width), 8);
4909 BVAR (&buffer_defaults, truncate_lines) = Qnil;
4910 BVAR (&buffer_defaults, word_wrap) = Qnil;
4911 BVAR (&buffer_defaults, ctl_arrow) = Qt;
4912 BVAR (&buffer_defaults, bidi_display_reordering) = Qt;
4913 BVAR (&buffer_defaults, bidi_paragraph_direction) = Qnil;
4914 BVAR (&buffer_defaults, cursor_type) = Qt;
4915 BVAR (&buffer_defaults, extra_line_spacing) = Qnil;
4916 BVAR (&buffer_defaults, cursor_in_non_selected_windows) = Qt;
4918 BVAR (&buffer_defaults, enable_multibyte_characters) = Qt;
4919 BVAR (&buffer_defaults, buffer_file_coding_system) = Qnil;
4920 XSETFASTINT (BVAR (&buffer_defaults, fill_column), 70);
4921 XSETFASTINT (BVAR (&buffer_defaults, left_margin), 0);
4922 BVAR (&buffer_defaults, cache_long_line_scans) = Qnil;
4923 BVAR (&buffer_defaults, file_truename) = Qnil;
4924 XSETFASTINT (BVAR (&buffer_defaults, display_count), 0);
4925 XSETFASTINT (BVAR (&buffer_defaults, left_margin_cols), 0);
4926 XSETFASTINT (BVAR (&buffer_defaults, right_margin_cols), 0);
4927 BVAR (&buffer_defaults, left_fringe_width) = Qnil;
4928 BVAR (&buffer_defaults, right_fringe_width) = Qnil;
4929 BVAR (&buffer_defaults, fringes_outside_margins) = Qnil;
4930 BVAR (&buffer_defaults, scroll_bar_width) = Qnil;
4931 BVAR (&buffer_defaults, vertical_scroll_bar_type) = Qt;
4932 BVAR (&buffer_defaults, indicate_empty_lines) = Qnil;
4933 BVAR (&buffer_defaults, indicate_buffer_boundaries) = Qnil;
4934 BVAR (&buffer_defaults, fringe_indicator_alist) = Qnil;
4935 BVAR (&buffer_defaults, fringe_cursor_alist) = Qnil;
4936 BVAR (&buffer_defaults, scroll_up_aggressively) = Qnil;
4937 BVAR (&buffer_defaults, scroll_down_aggressively) = Qnil;
4938 BVAR (&buffer_defaults, display_time) = Qnil;
4940 /* Assign the local-flags to the slots that have default values.
4941 The local flag is a bit that is used in the buffer
4942 to say that it has its own local value for the slot.
4943 The local flag bits are in the local_var_flags slot of the buffer. */
4945 /* Nothing can work if this isn't true */
4946 { verify (sizeof (EMACS_INT) == sizeof (Lisp_Object)); }
4948 /* 0 means not a lisp var, -1 means always local, else mask */
4949 memset (&buffer_local_flags, 0, sizeof buffer_local_flags);
4950 XSETINT (BVAR (&buffer_local_flags, filename), -1);
4951 XSETINT (BVAR (&buffer_local_flags, directory), -1);
4952 XSETINT (BVAR (&buffer_local_flags, backed_up), -1);
4953 XSETINT (BVAR (&buffer_local_flags, save_length), -1);
4954 XSETINT (BVAR (&buffer_local_flags, auto_save_file_name), -1);
4955 XSETINT (BVAR (&buffer_local_flags, read_only), -1);
4956 XSETINT (BVAR (&buffer_local_flags, major_mode), -1);
4957 XSETINT (BVAR (&buffer_local_flags, mode_name), -1);
4958 XSETINT (BVAR (&buffer_local_flags, undo_list), -1);
4959 XSETINT (BVAR (&buffer_local_flags, mark_active), -1);
4960 XSETINT (BVAR (&buffer_local_flags, point_before_scroll), -1);
4961 XSETINT (BVAR (&buffer_local_flags, file_truename), -1);
4962 XSETINT (BVAR (&buffer_local_flags, invisibility_spec), -1);
4963 XSETINT (BVAR (&buffer_local_flags, file_format), -1);
4964 XSETINT (BVAR (&buffer_local_flags, auto_save_file_format), -1);
4965 XSETINT (BVAR (&buffer_local_flags, display_count), -1);
4966 XSETINT (BVAR (&buffer_local_flags, display_time), -1);
4967 XSETINT (BVAR (&buffer_local_flags, enable_multibyte_characters), -1);
4969 idx = 1;
4970 XSETFASTINT (BVAR (&buffer_local_flags, mode_line_format), idx); ++idx;
4971 XSETFASTINT (BVAR (&buffer_local_flags, abbrev_mode), idx); ++idx;
4972 XSETFASTINT (BVAR (&buffer_local_flags, overwrite_mode), idx); ++idx;
4973 XSETFASTINT (BVAR (&buffer_local_flags, case_fold_search), idx); ++idx;
4974 XSETFASTINT (BVAR (&buffer_local_flags, auto_fill_function), idx); ++idx;
4975 XSETFASTINT (BVAR (&buffer_local_flags, selective_display), idx); ++idx;
4976 #ifndef old
4977 XSETFASTINT (BVAR (&buffer_local_flags, selective_display_ellipses), idx); ++idx;
4978 #endif
4979 XSETFASTINT (BVAR (&buffer_local_flags, tab_width), idx); ++idx;
4980 XSETFASTINT (BVAR (&buffer_local_flags, truncate_lines), idx); ++idx;
4981 XSETFASTINT (BVAR (&buffer_local_flags, word_wrap), idx); ++idx;
4982 XSETFASTINT (BVAR (&buffer_local_flags, ctl_arrow), idx); ++idx;
4983 XSETFASTINT (BVAR (&buffer_local_flags, fill_column), idx); ++idx;
4984 XSETFASTINT (BVAR (&buffer_local_flags, left_margin), idx); ++idx;
4985 XSETFASTINT (BVAR (&buffer_local_flags, abbrev_table), idx); ++idx;
4986 XSETFASTINT (BVAR (&buffer_local_flags, display_table), idx); ++idx;
4987 XSETFASTINT (BVAR (&buffer_local_flags, syntax_table), idx); ++idx;
4988 XSETFASTINT (BVAR (&buffer_local_flags, cache_long_line_scans), idx); ++idx;
4989 XSETFASTINT (BVAR (&buffer_local_flags, category_table), idx); ++idx;
4990 XSETFASTINT (BVAR (&buffer_local_flags, bidi_display_reordering), idx); ++idx;
4991 XSETFASTINT (BVAR (&buffer_local_flags, bidi_paragraph_direction), idx); ++idx;
4992 XSETFASTINT (BVAR (&buffer_local_flags, buffer_file_coding_system), idx);
4993 /* Make this one a permanent local. */
4994 buffer_permanent_local_flags[idx++] = 1;
4995 XSETFASTINT (BVAR (&buffer_local_flags, left_margin_cols), idx); ++idx;
4996 XSETFASTINT (BVAR (&buffer_local_flags, right_margin_cols), idx); ++idx;
4997 XSETFASTINT (BVAR (&buffer_local_flags, left_fringe_width), idx); ++idx;
4998 XSETFASTINT (BVAR (&buffer_local_flags, right_fringe_width), idx); ++idx;
4999 XSETFASTINT (BVAR (&buffer_local_flags, fringes_outside_margins), idx); ++idx;
5000 XSETFASTINT (BVAR (&buffer_local_flags, scroll_bar_width), idx); ++idx;
5001 XSETFASTINT (BVAR (&buffer_local_flags, vertical_scroll_bar_type), idx); ++idx;
5002 XSETFASTINT (BVAR (&buffer_local_flags, indicate_empty_lines), idx); ++idx;
5003 XSETFASTINT (BVAR (&buffer_local_flags, indicate_buffer_boundaries), idx); ++idx;
5004 XSETFASTINT (BVAR (&buffer_local_flags, fringe_indicator_alist), idx); ++idx;
5005 XSETFASTINT (BVAR (&buffer_local_flags, fringe_cursor_alist), idx); ++idx;
5006 XSETFASTINT (BVAR (&buffer_local_flags, scroll_up_aggressively), idx); ++idx;
5007 XSETFASTINT (BVAR (&buffer_local_flags, scroll_down_aggressively), idx); ++idx;
5008 XSETFASTINT (BVAR (&buffer_local_flags, header_line_format), idx); ++idx;
5009 XSETFASTINT (BVAR (&buffer_local_flags, cursor_type), idx); ++idx;
5010 XSETFASTINT (BVAR (&buffer_local_flags, extra_line_spacing), idx); ++idx;
5011 XSETFASTINT (BVAR (&buffer_local_flags, cursor_in_non_selected_windows), idx); ++idx;
5013 /* Need more room? */
5014 if (idx >= MAX_PER_BUFFER_VARS)
5015 abort ();
5016 last_per_buffer_idx = idx;
5018 Vbuffer_alist = Qnil;
5019 current_buffer = 0;
5020 all_buffers = 0;
5022 QSFundamental = make_pure_c_string ("Fundamental");
5024 Qfundamental_mode = intern_c_string ("fundamental-mode");
5025 BVAR (&buffer_defaults, major_mode) = Qfundamental_mode;
5027 Qmode_class = intern_c_string ("mode-class");
5029 Qprotected_field = intern_c_string ("protected-field");
5031 Qpermanent_local = intern_c_string ("permanent-local");
5033 Qkill_buffer_hook = intern_c_string ("kill-buffer-hook");
5034 Fput (Qkill_buffer_hook, Qpermanent_local, Qt);
5036 Qucs_set_table_for_input = intern_c_string ("ucs-set-table-for-input");
5038 /* super-magic invisible buffer */
5039 Vprin1_to_string_buffer = Fget_buffer_create (make_pure_c_string (" prin1"));
5040 Vbuffer_alist = Qnil;
5042 Fset_buffer (Fget_buffer_create (make_pure_c_string ("*scratch*")));
5044 inhibit_modification_hooks = 0;
5047 void
5048 init_buffer (void)
5050 char *pwd;
5051 Lisp_Object temp;
5052 ptrdiff_t len;
5054 #ifdef USE_MMAP_FOR_BUFFERS
5056 /* When using the ralloc implementation based on mmap(2), buffer
5057 text pointers will have been set to null in the dumped Emacs.
5058 Map new memory. */
5059 struct buffer *b;
5061 for (b = all_buffers; b; b = b->header.next.buffer)
5062 if (b->text->beg == NULL)
5063 enlarge_buffer_text (b, 0);
5065 #endif /* USE_MMAP_FOR_BUFFERS */
5067 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5068 if (NILP (BVAR (&buffer_defaults, enable_multibyte_characters)))
5069 Fset_buffer_multibyte (Qnil);
5071 pwd = get_current_dir_name ();
5073 if (!pwd)
5074 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno));
5076 /* Maybe this should really use some standard subroutine
5077 whose definition is filename syntax dependent. */
5078 len = strlen (pwd);
5079 if (!(IS_DIRECTORY_SEP (pwd[len - 1])))
5081 /* Grow buffer to add directory separator and '\0'. */
5082 pwd = (char *) realloc (pwd, len + 2);
5083 if (!pwd)
5084 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno));
5085 pwd[len] = DIRECTORY_SEP;
5086 pwd[len + 1] = '\0';
5089 BVAR (current_buffer, directory) = make_unibyte_string (pwd, strlen (pwd));
5090 if (! NILP (BVAR (&buffer_defaults, enable_multibyte_characters)))
5091 /* At this moment, we still don't know how to decode the
5092 directory name. So, we keep the bytes in multibyte form so
5093 that ENCODE_FILE correctly gets the original bytes. */
5094 BVAR (current_buffer, directory)
5095 = string_to_multibyte (BVAR (current_buffer, directory));
5097 /* Add /: to the front of the name
5098 if it would otherwise be treated as magic. */
5099 temp = Ffind_file_name_handler (BVAR (current_buffer, directory), Qt);
5100 if (! NILP (temp)
5101 /* If the default dir is just /, TEMP is non-nil
5102 because of the ange-ftp completion handler.
5103 However, it is not necessary to turn / into /:/.
5104 So avoid doing that. */
5105 && strcmp ("/", SSDATA (BVAR (current_buffer, directory))))
5106 BVAR (current_buffer, directory)
5107 = concat2 (build_string ("/:"), BVAR (current_buffer, directory));
5109 temp = get_minibuffer (0);
5110 BVAR (XBUFFER (temp), directory) = BVAR (current_buffer, directory);
5112 free (pwd);
5115 /* Similar to defvar_lisp but define a variable whose value is the Lisp
5116 Object stored in the current buffer. address is the address of the slot
5117 in the buffer that is current now. */
5119 /* TYPE is nil for a general Lisp variable.
5120 An integer specifies a type; then only Lisp values
5121 with that type code are allowed (except that nil is allowed too).
5122 LNAME is the Lisp-level variable name.
5123 VNAME is the name of the buffer slot.
5124 DOC is a dummy where you write the doc string as a comment. */
5125 #define DEFVAR_PER_BUFFER(lname, vname, type, doc) \
5126 do { \
5127 static struct Lisp_Buffer_Objfwd bo_fwd; \
5128 defvar_per_buffer (&bo_fwd, lname, vname, type); \
5129 } while (0)
5131 static void
5132 defvar_per_buffer (struct Lisp_Buffer_Objfwd *bo_fwd, const char *namestring,
5133 Lisp_Object *address, Lisp_Object type)
5135 struct Lisp_Symbol *sym;
5136 int offset;
5138 sym = XSYMBOL (intern (namestring));
5139 offset = (char *)address - (char *)current_buffer;
5141 bo_fwd->type = Lisp_Fwd_Buffer_Obj;
5142 bo_fwd->offset = offset;
5143 bo_fwd->slottype = type;
5144 sym->declared_special = 1;
5145 sym->redirect = SYMBOL_FORWARDED;
5147 /* I tried to do the job without a cast, but it seems impossible.
5148 union Lisp_Fwd *fwd; &(fwd->u_buffer_objfwd) = bo_fwd; */
5149 SET_SYMBOL_FWD (sym, (union Lisp_Fwd *)bo_fwd);
5151 XSETSYMBOL (PER_BUFFER_SYMBOL (offset), sym);
5153 if (PER_BUFFER_IDX (offset) == 0)
5154 /* Did a DEFVAR_PER_BUFFER without initializing the corresponding
5155 slot of buffer_local_flags */
5156 abort ();
5160 /* initialize the buffer routines */
5161 void
5162 syms_of_buffer (void)
5164 staticpro (&last_overlay_modification_hooks);
5165 last_overlay_modification_hooks
5166 = Fmake_vector (make_number (10), Qnil);
5168 staticpro (&Vbuffer_defaults);
5169 staticpro (&Vbuffer_local_symbols);
5170 staticpro (&Qfundamental_mode);
5171 staticpro (&Qmode_class);
5172 staticpro (&QSFundamental);
5173 staticpro (&Vbuffer_alist);
5174 staticpro (&Qprotected_field);
5175 staticpro (&Qpermanent_local);
5176 staticpro (&Qkill_buffer_hook);
5178 DEFSYM (Qpermanent_local_hook, "permanent-local-hook");
5179 DEFSYM (Qoverlayp, "overlayp");
5180 DEFSYM (Qevaporate, "evaporate");
5181 DEFSYM (Qmodification_hooks, "modification-hooks");
5182 DEFSYM (Qinsert_in_front_hooks, "insert-in-front-hooks");
5183 DEFSYM (Qinsert_behind_hooks, "insert-behind-hooks");
5184 DEFSYM (Qget_file_buffer, "get-file-buffer");
5185 DEFSYM (Qpriority, "priority");
5186 DEFSYM (Qbefore_string, "before-string");
5187 DEFSYM (Qafter_string, "after-string");
5188 DEFSYM (Qfirst_change_hook, "first-change-hook");
5189 DEFSYM (Qbefore_change_functions, "before-change-functions");
5190 DEFSYM (Qafter_change_functions, "after-change-functions");
5191 DEFSYM (Qkill_buffer_query_functions, "kill-buffer-query-functions");
5193 /* The next one is initialized in init_buffer_once. */
5194 staticpro (&Qucs_set_table_for_input);
5196 Fput (Qprotected_field, Qerror_conditions,
5197 pure_cons (Qprotected_field, pure_cons (Qerror, Qnil)));
5198 Fput (Qprotected_field, Qerror_message,
5199 make_pure_c_string ("Attempt to modify a protected field"));
5201 DEFVAR_BUFFER_DEFAULTS ("default-mode-line-format",
5202 mode_line_format,
5203 doc: /* Default value of `mode-line-format' for buffers that don't override it.
5204 This is the same as (default-value 'mode-line-format). */);
5206 DEFVAR_BUFFER_DEFAULTS ("default-header-line-format",
5207 header_line_format,
5208 doc: /* Default value of `header-line-format' for buffers that don't override it.
5209 This is the same as (default-value 'header-line-format). */);
5211 DEFVAR_BUFFER_DEFAULTS ("default-cursor-type", cursor_type,
5212 doc: /* Default value of `cursor-type' for buffers that don't override it.
5213 This is the same as (default-value 'cursor-type). */);
5215 DEFVAR_BUFFER_DEFAULTS ("default-line-spacing",
5216 extra_line_spacing,
5217 doc: /* Default value of `line-spacing' for buffers that don't override it.
5218 This is the same as (default-value 'line-spacing). */);
5220 DEFVAR_BUFFER_DEFAULTS ("default-cursor-in-non-selected-windows",
5221 cursor_in_non_selected_windows,
5222 doc: /* Default value of `cursor-in-non-selected-windows'.
5223 This is the same as (default-value 'cursor-in-non-selected-windows). */);
5225 DEFVAR_BUFFER_DEFAULTS ("default-abbrev-mode",
5226 abbrev_mode,
5227 doc: /* Default value of `abbrev-mode' for buffers that do not override it.
5228 This is the same as (default-value 'abbrev-mode). */);
5230 DEFVAR_BUFFER_DEFAULTS ("default-ctl-arrow",
5231 ctl_arrow,
5232 doc: /* Default value of `ctl-arrow' for buffers that do not override it.
5233 This is the same as (default-value 'ctl-arrow). */);
5235 DEFVAR_BUFFER_DEFAULTS ("default-enable-multibyte-characters",
5236 enable_multibyte_characters,
5237 doc: /* *Default value of `enable-multibyte-characters' for buffers not overriding it.
5238 This is the same as (default-value 'enable-multibyte-characters). */);
5240 DEFVAR_BUFFER_DEFAULTS ("default-buffer-file-coding-system",
5241 buffer_file_coding_system,
5242 doc: /* Default value of `buffer-file-coding-system' for buffers not overriding it.
5243 This is the same as (default-value 'buffer-file-coding-system). */);
5245 DEFVAR_BUFFER_DEFAULTS ("default-truncate-lines",
5246 truncate_lines,
5247 doc: /* Default value of `truncate-lines' for buffers that do not override it.
5248 This is the same as (default-value 'truncate-lines). */);
5250 DEFVAR_BUFFER_DEFAULTS ("default-fill-column",
5251 fill_column,
5252 doc: /* Default value of `fill-column' for buffers that do not override it.
5253 This is the same as (default-value 'fill-column). */);
5255 DEFVAR_BUFFER_DEFAULTS ("default-left-margin",
5256 left_margin,
5257 doc: /* Default value of `left-margin' for buffers that do not override it.
5258 This is the same as (default-value 'left-margin). */);
5260 DEFVAR_BUFFER_DEFAULTS ("default-tab-width",
5261 tab_width,
5262 doc: /* Default value of `tab-width' for buffers that do not override it.
5263 This is the same as (default-value 'tab-width). */);
5265 DEFVAR_BUFFER_DEFAULTS ("default-case-fold-search",
5266 case_fold_search,
5267 doc: /* Default value of `case-fold-search' for buffers that don't override it.
5268 This is the same as (default-value 'case-fold-search). */);
5270 DEFVAR_BUFFER_DEFAULTS ("default-left-margin-width",
5271 left_margin_cols,
5272 doc: /* Default value of `left-margin-width' for buffers that don't override it.
5273 This is the same as (default-value 'left-margin-width). */);
5275 DEFVAR_BUFFER_DEFAULTS ("default-right-margin-width",
5276 right_margin_cols,
5277 doc: /* Default value of `right-margin-width' for buffers that don't override it.
5278 This is the same as (default-value 'right-margin-width). */);
5280 DEFVAR_BUFFER_DEFAULTS ("default-left-fringe-width",
5281 left_fringe_width,
5282 doc: /* Default value of `left-fringe-width' for buffers that don't override it.
5283 This is the same as (default-value 'left-fringe-width). */);
5285 DEFVAR_BUFFER_DEFAULTS ("default-right-fringe-width",
5286 right_fringe_width,
5287 doc: /* Default value of `right-fringe-width' for buffers that don't override it.
5288 This is the same as (default-value 'right-fringe-width). */);
5290 DEFVAR_BUFFER_DEFAULTS ("default-fringes-outside-margins",
5291 fringes_outside_margins,
5292 doc: /* Default value of `fringes-outside-margins' for buffers that don't override it.
5293 This is the same as (default-value 'fringes-outside-margins). */);
5295 DEFVAR_BUFFER_DEFAULTS ("default-scroll-bar-width",
5296 scroll_bar_width,
5297 doc: /* Default value of `scroll-bar-width' for buffers that don't override it.
5298 This is the same as (default-value 'scroll-bar-width). */);
5300 DEFVAR_BUFFER_DEFAULTS ("default-vertical-scroll-bar",
5301 vertical_scroll_bar_type,
5302 doc: /* Default value of `vertical-scroll-bar' for buffers that don't override it.
5303 This is the same as (default-value 'vertical-scroll-bar). */);
5305 DEFVAR_BUFFER_DEFAULTS ("default-indicate-empty-lines",
5306 indicate_empty_lines,
5307 doc: /* Default value of `indicate-empty-lines' for buffers that don't override it.
5308 This is the same as (default-value 'indicate-empty-lines). */);
5310 DEFVAR_BUFFER_DEFAULTS ("default-indicate-buffer-boundaries",
5311 indicate_buffer_boundaries,
5312 doc: /* Default value of `indicate-buffer-boundaries' for buffers that don't override it.
5313 This is the same as (default-value 'indicate-buffer-boundaries). */);
5315 DEFVAR_BUFFER_DEFAULTS ("default-fringe-indicator-alist",
5316 fringe_indicator_alist,
5317 doc: /* Default value of `fringe-indicator-alist' for buffers that don't override it.
5318 This is the same as (default-value 'fringe-indicator-alist'). */);
5320 DEFVAR_BUFFER_DEFAULTS ("default-fringe-cursor-alist",
5321 fringe_cursor_alist,
5322 doc: /* Default value of `fringe-cursor-alist' for buffers that don't override it.
5323 This is the same as (default-value 'fringe-cursor-alist'). */);
5325 DEFVAR_BUFFER_DEFAULTS ("default-scroll-up-aggressively",
5326 scroll_up_aggressively,
5327 doc: /* Default value of `scroll-up-aggressively'.
5328 This value applies in buffers that don't have their own local values.
5329 This is the same as (default-value 'scroll-up-aggressively). */);
5331 DEFVAR_BUFFER_DEFAULTS ("default-scroll-down-aggressively",
5332 scroll_down_aggressively,
5333 doc: /* Default value of `scroll-down-aggressively'.
5334 This value applies in buffers that don't have their own local values.
5335 This is the same as (default-value 'scroll-down-aggressively). */);
5337 DEFVAR_PER_BUFFER ("header-line-format",
5338 &BVAR (current_buffer, header_line_format),
5339 Qnil,
5340 doc: /* Analogous to `mode-line-format', but controls the header line.
5341 The header line appears, optionally, at the top of a window;
5342 the mode line appears at the bottom. */);
5344 DEFVAR_PER_BUFFER ("mode-line-format", &BVAR (current_buffer, mode_line_format),
5345 Qnil,
5346 doc: /* Template for displaying mode line for current buffer.
5347 Each buffer has its own value of this variable.
5348 Value may be nil, a string, a symbol or a list or cons cell.
5349 A value of nil means don't display a mode line.
5350 For a symbol, its value is used (but it is ignored if t or nil).
5351 A string appearing directly as the value of a symbol is processed verbatim
5352 in that the %-constructs below are not recognized.
5353 Note that unless the symbol is marked as a `risky-local-variable', all
5354 properties in any strings, as well as all :eval and :propertize forms
5355 in the value of that symbol will be ignored.
5356 For a list of the form `(:eval FORM)', FORM is evaluated and the result
5357 is used as a mode line element. Be careful--FORM should not load any files,
5358 because that can cause an infinite recursion.
5359 For a list of the form `(:propertize ELT PROPS...)', ELT is displayed
5360 with the specified properties PROPS applied.
5361 For a list whose car is a symbol, the symbol's value is taken,
5362 and if that is non-nil, the cadr of the list is processed recursively.
5363 Otherwise, the caddr of the list (if there is one) is processed.
5364 For a list whose car is a string or list, each element is processed
5365 recursively and the results are effectively concatenated.
5366 For a list whose car is an integer, the cdr of the list is processed
5367 and padded (if the number is positive) or truncated (if negative)
5368 to the width specified by that number.
5369 A string is printed verbatim in the mode line except for %-constructs:
5370 (%-constructs are allowed when the string is the entire mode-line-format
5371 or when it is found in a cons-cell or a list)
5372 %b -- print buffer name. %f -- print visited file name.
5373 %F -- print frame name.
5374 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.
5375 %& is like %*, but ignore read-only-ness.
5376 % means buffer is read-only and * means it is modified.
5377 For a modified read-only buffer, %* gives % and %+ gives *.
5378 %s -- print process status. %l -- print the current line number.
5379 %c -- print the current column number (this makes editing slower).
5380 To make the column number update correctly in all cases,
5381 `column-number-mode' must be non-nil.
5382 %i -- print the size of the buffer.
5383 %I -- like %i, but use k, M, G, etc., to abbreviate.
5384 %p -- print percent of buffer above top of window, or Top, Bot or All.
5385 %P -- print percent of buffer above bottom of window, perhaps plus Top,
5386 or print Bottom or All.
5387 %n -- print Narrow if appropriate.
5388 %t -- visited file is text or binary (if OS supports this distinction).
5389 %z -- print mnemonics of keyboard, terminal, and buffer coding systems.
5390 %Z -- like %z, but including the end-of-line format.
5391 %e -- print error message about full memory.
5392 %@ -- print @ or hyphen. @ means that default-directory is on a
5393 remote machine.
5394 %[ -- print one [ for each recursive editing level. %] similar.
5395 %% -- print %. %- -- print infinitely many dashes.
5396 Decimal digits after the % specify field width to which to pad. */);
5398 DEFVAR_BUFFER_DEFAULTS ("default-major-mode", major_mode,
5399 doc: /* *Value of `major-mode' for new buffers. */);
5401 DEFVAR_PER_BUFFER ("major-mode", &BVAR (current_buffer, major_mode),
5402 make_number (Lisp_Symbol),
5403 doc: /* Symbol for current buffer's major mode.
5404 The default value (normally `fundamental-mode') affects new buffers.
5405 A value of nil means to use the current buffer's major mode, provided
5406 it is not marked as "special".
5408 When a mode is used by default, `find-file' switches to it before it
5409 reads the contents into the buffer and before it finishes setting up
5410 the buffer. Thus, the mode and its hooks should not expect certain
5411 variables such as `buffer-read-only' and `buffer-file-coding-system'
5412 to be set up. */);
5414 DEFVAR_PER_BUFFER ("mode-name", &BVAR (current_buffer, mode_name),
5415 Qnil,
5416 doc: /* Pretty name of current buffer's major mode.
5417 Usually a string, but can use any of the constructs for `mode-line-format',
5418 which see.
5419 Format with `format-mode-line' to produce a string value. */);
5421 DEFVAR_PER_BUFFER ("local-abbrev-table", &BVAR (current_buffer, abbrev_table), Qnil,
5422 doc: /* Local (mode-specific) abbrev table of current buffer. */);
5424 DEFVAR_PER_BUFFER ("abbrev-mode", &BVAR (current_buffer, abbrev_mode), Qnil,
5425 doc: /* Non-nil if Abbrev mode is enabled.
5426 Use the command `abbrev-mode' to change this variable. */);
5428 DEFVAR_PER_BUFFER ("case-fold-search", &BVAR (current_buffer, case_fold_search),
5429 Qnil,
5430 doc: /* *Non-nil if searches and matches should ignore case. */);
5432 DEFVAR_PER_BUFFER ("fill-column", &BVAR (current_buffer, fill_column),
5433 make_number (LISP_INT_TAG),
5434 doc: /* *Column beyond which automatic line-wrapping should happen.
5435 Interactively, you can set the buffer local value using \\[set-fill-column]. */);
5437 DEFVAR_PER_BUFFER ("left-margin", &BVAR (current_buffer, left_margin),
5438 make_number (LISP_INT_TAG),
5439 doc: /* *Column for the default `indent-line-function' to indent to.
5440 Linefeed indents to this column in Fundamental mode. */);
5442 DEFVAR_PER_BUFFER ("tab-width", &BVAR (current_buffer, tab_width),
5443 make_number (LISP_INT_TAG),
5444 doc: /* *Distance between tab stops (for display of tab characters), in columns.
5445 This should be an integer greater than zero. */);
5447 DEFVAR_PER_BUFFER ("ctl-arrow", &BVAR (current_buffer, ctl_arrow), Qnil,
5448 doc: /* *Non-nil means display control chars with uparrow.
5449 A value of nil means use backslash and octal digits.
5450 This variable does not apply to characters whose display is specified
5451 in the current display table (if there is one). */);
5453 DEFVAR_PER_BUFFER ("enable-multibyte-characters",
5454 &BVAR (current_buffer, enable_multibyte_characters),
5455 Qnil,
5456 doc: /* Non-nil means the buffer contents are regarded as multi-byte characters.
5457 Otherwise they are regarded as unibyte. This affects the display,
5458 file I/O and the behavior of various editing commands.
5460 This variable is buffer-local but you cannot set it directly;
5461 use the function `set-buffer-multibyte' to change a buffer's representation.
5462 See also Info node `(elisp)Text Representations'. */);
5463 XSYMBOL (intern_c_string ("enable-multibyte-characters"))->constant = 1;
5465 DEFVAR_PER_BUFFER ("buffer-file-coding-system",
5466 &BVAR (current_buffer, buffer_file_coding_system), Qnil,
5467 doc: /* Coding system to be used for encoding the buffer contents on saving.
5468 This variable applies to saving the buffer, and also to `write-region'
5469 and other functions that use `write-region'.
5470 It does not apply to sending output to subprocesses, however.
5472 If this is nil, the buffer is saved without any code conversion
5473 unless some coding system is specified in `file-coding-system-alist'
5474 for the buffer file.
5476 If the text to be saved cannot be encoded as specified by this variable,
5477 an alternative encoding is selected by `select-safe-coding-system', which see.
5479 The variable `coding-system-for-write', if non-nil, overrides this variable.
5481 This variable is never applied to a way of decoding a file while reading it. */);
5483 DEFVAR_PER_BUFFER ("bidi-display-reordering",
5484 &BVAR (current_buffer, bidi_display_reordering), Qnil,
5485 doc: /* Non-nil means reorder bidirectional text for display in the visual order. */);
5487 DEFVAR_PER_BUFFER ("bidi-paragraph-direction",
5488 &BVAR (current_buffer, bidi_paragraph_direction), Qnil,
5489 doc: /* *If non-nil, forces directionality of text paragraphs in the buffer.
5491 If this is nil (the default), the direction of each paragraph is
5492 determined by the first strong directional character of its text.
5493 The values of `right-to-left' and `left-to-right' override that.
5494 Any other value is treated as nil.
5496 This variable has no effect unless the buffer's value of
5497 \`bidi-display-reordering' is non-nil. */);
5499 DEFVAR_PER_BUFFER ("truncate-lines", &BVAR (current_buffer, truncate_lines), Qnil,
5500 doc: /* *Non-nil means do not display continuation lines.
5501 Instead, give each line of text just one screen line.
5503 Note that this is overridden by the variable
5504 `truncate-partial-width-windows' if that variable is non-nil
5505 and this buffer is not full-frame width.
5507 Minibuffers set this variable to nil. */);
5509 DEFVAR_PER_BUFFER ("word-wrap", &BVAR (current_buffer, word_wrap), Qnil,
5510 doc: /* *Non-nil means to use word-wrapping for continuation lines.
5511 When word-wrapping is on, continuation lines are wrapped at the space
5512 or tab character nearest to the right window edge.
5513 If nil, continuation lines are wrapped at the right screen edge.
5515 This variable has no effect if long lines are truncated (see
5516 `truncate-lines' and `truncate-partial-width-windows'). If you use
5517 word-wrapping, you might want to reduce the value of
5518 `truncate-partial-width-windows', since wrapping can make text readable
5519 in narrower windows. */);
5521 DEFVAR_PER_BUFFER ("default-directory", &BVAR (current_buffer, directory),
5522 make_number (Lisp_String),
5523 doc: /* Name of default directory of current buffer. Should end with slash.
5524 To interactively change the default directory, use command `cd'. */);
5526 DEFVAR_PER_BUFFER ("auto-fill-function", &BVAR (current_buffer, auto_fill_function),
5527 Qnil,
5528 doc: /* Function called (if non-nil) to perform auto-fill.
5529 It is called after self-inserting any character specified in
5530 the `auto-fill-chars' table.
5531 NOTE: This variable is not a hook;
5532 its value may not be a list of functions. */);
5534 DEFVAR_PER_BUFFER ("buffer-file-name", &BVAR (current_buffer, filename),
5535 make_number (Lisp_String),
5536 doc: /* Name of file visited in current buffer, or nil if not visiting a file. */);
5538 DEFVAR_PER_BUFFER ("buffer-file-truename", &BVAR (current_buffer, file_truename),
5539 make_number (Lisp_String),
5540 doc: /* Abbreviated truename of file visited in current buffer, or nil if none.
5541 The truename of a file is calculated by `file-truename'
5542 and then abbreviated with `abbreviate-file-name'. */);
5544 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
5545 &BVAR (current_buffer, auto_save_file_name),
5546 make_number (Lisp_String),
5547 doc: /* Name of file for auto-saving current buffer.
5548 If it is nil, that means don't auto-save this buffer. */);
5550 DEFVAR_PER_BUFFER ("buffer-read-only", &BVAR (current_buffer, read_only), Qnil,
5551 doc: /* Non-nil if this buffer is read-only. */);
5553 DEFVAR_PER_BUFFER ("buffer-backed-up", &BVAR (current_buffer, backed_up), Qnil,
5554 doc: /* Non-nil if this buffer's file has been backed up.
5555 Backing up is done before the first time the file is saved. */);
5557 DEFVAR_PER_BUFFER ("buffer-saved-size", &BVAR (current_buffer, save_length),
5558 make_number (LISP_INT_TAG),
5559 doc: /* Length of current buffer when last read in, saved or auto-saved.
5560 0 initially.
5561 -1 means auto-saving turned off until next real save.
5563 If you set this to -2, that means don't turn off auto-saving in this buffer
5564 if its text size shrinks. If you use `buffer-swap-text' on a buffer,
5565 you probably should set this to -2 in that buffer. */);
5567 DEFVAR_PER_BUFFER ("selective-display", &BVAR (current_buffer, selective_display),
5568 Qnil,
5569 doc: /* Non-nil enables selective display.
5570 An integer N as value means display only lines
5571 that start with less than N columns of space.
5572 A value of t means that the character ^M makes itself and
5573 all the rest of the line invisible; also, when saving the buffer
5574 in a file, save the ^M as a newline. */);
5576 #ifndef old
5577 DEFVAR_PER_BUFFER ("selective-display-ellipses",
5578 &BVAR (current_buffer, selective_display_ellipses),
5579 Qnil,
5580 doc: /* Non-nil means display ... on previous line when a line is invisible. */);
5581 #endif
5583 DEFVAR_PER_BUFFER ("overwrite-mode", &BVAR (current_buffer, overwrite_mode), Qnil,
5584 doc: /* Non-nil if self-insertion should replace existing text.
5585 The value should be one of `overwrite-mode-textual',
5586 `overwrite-mode-binary', or nil.
5587 If it is `overwrite-mode-textual', self-insertion still
5588 inserts at the end of a line, and inserts when point is before a tab,
5589 until the tab is filled in.
5590 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too. */);
5592 DEFVAR_PER_BUFFER ("buffer-display-table", &BVAR (current_buffer, display_table),
5593 Qnil,
5594 doc: /* Display table that controls display of the contents of current buffer.
5596 If this variable is nil, the value of `standard-display-table' is used.
5597 Each window can have its own, overriding display table, see
5598 `set-window-display-table' and `window-display-table'.
5600 The display table is a char-table created with `make-display-table'.
5601 A char-table is an array indexed by character codes. Normal array
5602 primitives `aref' and `aset' can be used to access elements of a char-table.
5604 Each of the char-table elements control how to display the corresponding
5605 text character: the element at index C in the table says how to display
5606 the character whose code is C. Each element should be a vector of
5607 characters or nil. The value nil means display the character in the
5608 default fashion; otherwise, the characters from the vector are delivered
5609 to the screen instead of the original character.
5611 For example, (aset buffer-display-table ?X [?Y]) tells Emacs
5612 to display a capital Y instead of each X character.
5614 In addition, a char-table has six extra slots to control the display of:
5616 the end of a truncated screen line (extra-slot 0, a single character);
5617 the end of a continued line (extra-slot 1, a single character);
5618 the escape character used to display character codes in octal
5619 (extra-slot 2, a single character);
5620 the character used as an arrow for control characters (extra-slot 3,
5621 a single character);
5622 the decoration indicating the presence of invisible lines (extra-slot 4,
5623 a vector of characters);
5624 the character used to draw the border between side-by-side windows
5625 (extra-slot 5, a single character).
5627 See also the functions `display-table-slot' and `set-display-table-slot'. */);
5629 DEFVAR_PER_BUFFER ("left-margin-width", &BVAR (current_buffer, left_margin_cols),
5630 Qnil,
5631 doc: /* *Width of left marginal area for display of a buffer.
5632 A value of nil means no marginal area. */);
5634 DEFVAR_PER_BUFFER ("right-margin-width", &BVAR (current_buffer, right_margin_cols),
5635 Qnil,
5636 doc: /* *Width of right marginal area for display of a buffer.
5637 A value of nil means no marginal area. */);
5639 DEFVAR_PER_BUFFER ("left-fringe-width", &BVAR (current_buffer, left_fringe_width),
5640 Qnil,
5641 doc: /* *Width of this buffer's left fringe (in pixels).
5642 A value of 0 means no left fringe is shown in this buffer's window.
5643 A value of nil means to use the left fringe width from the window's frame. */);
5645 DEFVAR_PER_BUFFER ("right-fringe-width", &BVAR (current_buffer, right_fringe_width),
5646 Qnil,
5647 doc: /* *Width of this buffer's right fringe (in pixels).
5648 A value of 0 means no right fringe is shown in this buffer's window.
5649 A value of nil means to use the right fringe width from the window's frame. */);
5651 DEFVAR_PER_BUFFER ("fringes-outside-margins", &BVAR (current_buffer, fringes_outside_margins),
5652 Qnil,
5653 doc: /* *Non-nil means to display fringes outside display margins.
5654 A value of nil means to display fringes between margins and buffer text. */);
5656 DEFVAR_PER_BUFFER ("scroll-bar-width", &BVAR (current_buffer, scroll_bar_width),
5657 Qnil,
5658 doc: /* *Width of this buffer's scroll bars in pixels.
5659 A value of nil means to use the scroll bar width from the window's frame. */);
5661 DEFVAR_PER_BUFFER ("vertical-scroll-bar", &BVAR (current_buffer, vertical_scroll_bar_type),
5662 Qnil,
5663 doc: /* *Position of this buffer's vertical scroll bar.
5664 The value takes effect whenever you tell a window to display this buffer;
5665 for instance, with `set-window-buffer' or when `display-buffer' displays it.
5667 A value of `left' or `right' means put the vertical scroll bar at that side
5668 of the window; a value of nil means don't show any vertical scroll bars.
5669 A value of t (the default) means do whatever the window's frame specifies. */);
5671 DEFVAR_PER_BUFFER ("indicate-empty-lines",
5672 &BVAR (current_buffer, indicate_empty_lines), Qnil,
5673 doc: /* *Visually indicate empty lines after the buffer end.
5674 If non-nil, a bitmap is displayed in the left fringe of a window on
5675 window-systems. */);
5677 DEFVAR_PER_BUFFER ("indicate-buffer-boundaries",
5678 &BVAR (current_buffer, indicate_buffer_boundaries), Qnil,
5679 doc: /* *Visually indicate buffer boundaries and scrolling.
5680 If non-nil, the first and last line of the buffer are marked in the fringe
5681 of a window on window-systems with angle bitmaps, or if the window can be
5682 scrolled, the top and bottom line of the window are marked with up and down
5683 arrow bitmaps.
5685 If value is a symbol `left' or `right', both angle and arrow bitmaps
5686 are displayed in the left or right fringe, resp. Any other value
5687 that doesn't look like an alist means display the angle bitmaps in
5688 the left fringe but no arrows.
5690 You can exercise more precise control by using an alist as the
5691 value. Each alist element (INDICATOR . POSITION) specifies
5692 where to show one of the indicators. INDICATOR is one of `top',
5693 `bottom', `up', `down', or t, which specifies the default position,
5694 and POSITION is one of `left', `right', or nil, meaning do not show
5695 this indicator.
5697 For example, ((top . left) (t . right)) places the top angle bitmap in
5698 left fringe, the bottom angle bitmap in right fringe, and both arrow
5699 bitmaps in right fringe. To show just the angle bitmaps in the left
5700 fringe, but no arrow bitmaps, use ((top . left) (bottom . left)). */);
5702 DEFVAR_PER_BUFFER ("fringe-indicator-alist",
5703 &BVAR (current_buffer, fringe_indicator_alist), Qnil,
5704 doc: /* *Mapping from logical to physical fringe indicator bitmaps.
5705 The value is an alist where each element (INDICATOR . BITMAPS)
5706 specifies the fringe bitmaps used to display a specific logical
5707 fringe indicator.
5709 INDICATOR specifies the logical indicator type which is one of the
5710 following symbols: `truncation' , `continuation', `overlay-arrow',
5711 `top', `bottom', `top-bottom', `up', `down', empty-line', or `unknown'.
5713 BITMAPS is a list of symbols (LEFT RIGHT [LEFT1 RIGHT1]) which specifies
5714 the actual bitmap shown in the left or right fringe for the logical
5715 indicator. LEFT and RIGHT are the bitmaps shown in the left and/or
5716 right fringe for the specific indicator. The LEFT1 or RIGHT1 bitmaps
5717 are used only for the `bottom' and `top-bottom' indicators when the
5718 last (only) line has no final newline. BITMAPS may also be a single
5719 symbol which is used in both left and right fringes. */);
5721 DEFVAR_PER_BUFFER ("fringe-cursor-alist",
5722 &BVAR (current_buffer, fringe_cursor_alist), Qnil,
5723 doc: /* *Mapping from logical to physical fringe cursor bitmaps.
5724 The value is an alist where each element (CURSOR . BITMAP)
5725 specifies the fringe bitmaps used to display a specific logical
5726 cursor type in the fringe.
5728 CURSOR specifies the logical cursor type which is one of the following
5729 symbols: `box' , `hollow', `bar', `hbar', or `hollow-small'. The last
5730 one is used to show a hollow cursor on narrow lines display lines
5731 where the normal hollow cursor will not fit.
5733 BITMAP is the corresponding fringe bitmap shown for the logical
5734 cursor type. */);
5736 DEFVAR_PER_BUFFER ("scroll-up-aggressively",
5737 &BVAR (current_buffer, scroll_up_aggressively), Qnil,
5738 doc: /* How far to scroll windows upward.
5739 If you move point off the bottom, the window scrolls automatically.
5740 This variable controls how far it scrolls. The value nil, the default,
5741 means scroll to center point. A fraction means scroll to put point
5742 that fraction of the window's height from the bottom of the window.
5743 When the value is 0.0, point goes at the bottom line, which in the
5744 simple case that you moved off with C-f means scrolling just one line.
5745 1.0 means point goes at the top, so that in that simple case, the
5746 window scrolls by a full window height. Meaningful values are
5747 between 0.0 and 1.0, inclusive. */);
5749 DEFVAR_PER_BUFFER ("scroll-down-aggressively",
5750 &BVAR (current_buffer, scroll_down_aggressively), Qnil,
5751 doc: /* How far to scroll windows downward.
5752 If you move point off the top, the window scrolls automatically.
5753 This variable controls how far it scrolls. The value nil, the default,
5754 means scroll to center point. A fraction means scroll to put point
5755 that fraction of the window's height from the top of the window.
5756 When the value is 0.0, point goes at the top line, which in the
5757 simple case that you moved off with C-b means scrolling just one line.
5758 1.0 means point goes at the bottom, so that in that simple case, the
5759 window scrolls by a full window height. Meaningful values are
5760 between 0.0 and 1.0, inclusive. */);
5762 /*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
5763 "Don't ask.");
5766 DEFVAR_LISP ("before-change-functions", Vbefore_change_functions,
5767 doc: /* List of functions to call before each text change.
5768 Two arguments are passed to each function: the positions of
5769 the beginning and end of the range of old text to be changed.
5770 \(For an insertion, the beginning and end are at the same place.)
5771 No information is given about the length of the text after the change.
5773 Buffer changes made while executing the `before-change-functions'
5774 don't call any before-change or after-change functions.
5775 That's because `inhibit-modification-hooks' is temporarily set non-nil.
5777 If an unhandled error happens in running these functions,
5778 the variable's value remains nil. That prevents the error
5779 from happening repeatedly and making Emacs nonfunctional. */);
5780 Vbefore_change_functions = Qnil;
5782 DEFVAR_LISP ("after-change-functions", Vafter_change_functions,
5783 doc: /* List of functions to call after each text change.
5784 Three arguments are passed to each function: the positions of
5785 the beginning and end of the range of changed text,
5786 and the length in bytes of the pre-change text replaced by that range.
5787 \(For an insertion, the pre-change length is zero;
5788 for a deletion, that length is the number of bytes deleted,
5789 and the post-change beginning and end are at the same place.)
5791 Buffer changes made while executing the `after-change-functions'
5792 don't call any before-change or after-change functions.
5793 That's because `inhibit-modification-hooks' is temporarily set non-nil.
5795 If an unhandled error happens in running these functions,
5796 the variable's value remains nil. That prevents the error
5797 from happening repeatedly and making Emacs nonfunctional. */);
5798 Vafter_change_functions = Qnil;
5800 DEFVAR_LISP ("first-change-hook", Vfirst_change_hook,
5801 doc: /* A list of functions to call before changing a buffer which is unmodified.
5802 The functions are run using the `run-hooks' function. */);
5803 Vfirst_change_hook = Qnil;
5805 DEFVAR_PER_BUFFER ("buffer-undo-list", &BVAR (current_buffer, undo_list), Qnil,
5806 doc: /* List of undo entries in current buffer.
5807 Recent changes come first; older changes follow newer.
5809 An entry (BEG . END) represents an insertion which begins at
5810 position BEG and ends at position END.
5812 An entry (TEXT . POSITION) represents the deletion of the string TEXT
5813 from (abs POSITION). If POSITION is positive, point was at the front
5814 of the text being deleted; if negative, point was at the end.
5816 An entry (t HIGH . LOW) indicates that the buffer previously had
5817 \"unmodified\" status. HIGH and LOW are the high and low 16-bit portions
5818 of the visited file's modification time, as of that time. If the
5819 modification time of the most recent save is different, this entry is
5820 obsolete.
5822 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property
5823 was modified between BEG and END. PROPERTY is the property name,
5824 and VALUE is the old value.
5826 An entry (apply FUN-NAME . ARGS) means undo the change with
5827 \(apply FUN-NAME ARGS).
5829 An entry (apply DELTA BEG END FUN-NAME . ARGS) supports selective undo
5830 in the active region. BEG and END is the range affected by this entry
5831 and DELTA is the number of bytes added or deleted in that range by
5832 this change.
5834 An entry (MARKER . DISTANCE) indicates that the marker MARKER
5835 was adjusted in position by the offset DISTANCE (an integer).
5837 An entry of the form POSITION indicates that point was at the buffer
5838 location given by the integer. Undoing an entry of this form places
5839 point at POSITION.
5841 Entries with value `nil' mark undo boundaries. The undo command treats
5842 the changes between two undo boundaries as a single step to be undone.
5844 If the value of the variable is t, undo information is not recorded. */);
5846 DEFVAR_PER_BUFFER ("mark-active", &BVAR (current_buffer, mark_active), Qnil,
5847 doc: /* Non-nil means the mark and region are currently active in this buffer. */);
5849 DEFVAR_PER_BUFFER ("cache-long-line-scans", &BVAR (current_buffer, cache_long_line_scans), Qnil,
5850 doc: /* Non-nil means that Emacs should use caches to handle long lines more quickly.
5852 Normally, the line-motion functions work by scanning the buffer for
5853 newlines. Columnar operations (like `move-to-column' and
5854 `compute-motion') also work by scanning the buffer, summing character
5855 widths as they go. This works well for ordinary text, but if the
5856 buffer's lines are very long (say, more than 500 characters), these
5857 motion functions will take longer to execute. Emacs may also take
5858 longer to update the display.
5860 If `cache-long-line-scans' is non-nil, these motion functions cache the
5861 results of their scans, and consult the cache to avoid rescanning
5862 regions of the buffer until the text is modified. The caches are most
5863 beneficial when they prevent the most searching---that is, when the
5864 buffer contains long lines and large regions of characters with the
5865 same, fixed screen width.
5867 When `cache-long-line-scans' is non-nil, processing short lines will
5868 become slightly slower (because of the overhead of consulting the
5869 cache), and the caches will use memory roughly proportional to the
5870 number of newlines and characters whose screen width varies.
5872 The caches require no explicit maintenance; their accuracy is
5873 maintained internally by the Emacs primitives. Enabling or disabling
5874 the cache should not affect the behavior of any of the motion
5875 functions; it should only affect their performance. */);
5877 DEFVAR_PER_BUFFER ("point-before-scroll", &BVAR (current_buffer, point_before_scroll), Qnil,
5878 doc: /* Value of point before the last series of scroll operations, or nil. */);
5880 DEFVAR_PER_BUFFER ("buffer-file-format", &BVAR (current_buffer, file_format), Qnil,
5881 doc: /* List of formats to use when saving this buffer.
5882 Formats are defined by `format-alist'. This variable is
5883 set when a file is visited. */);
5885 DEFVAR_PER_BUFFER ("buffer-auto-save-file-format",
5886 &BVAR (current_buffer, auto_save_file_format), Qnil,
5887 doc: /* *Format in which to write auto-save files.
5888 Should be a list of symbols naming formats that are defined in `format-alist'.
5889 If it is t, which is the default, auto-save files are written in the
5890 same format as a regular save would use. */);
5892 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
5893 &BVAR (current_buffer, invisibility_spec), Qnil,
5894 doc: /* Invisibility spec of this buffer.
5895 The default is t, which means that text is invisible
5896 if it has a non-nil `invisible' property.
5897 If the value is a list, a text character is invisible if its `invisible'
5898 property is an element in that list (or is a list with members in common).
5899 If an element is a cons cell of the form (PROP . ELLIPSIS),
5900 then characters with property value PROP are invisible,
5901 and they have an ellipsis as well if ELLIPSIS is non-nil. */);
5903 DEFVAR_PER_BUFFER ("buffer-display-count",
5904 &BVAR (current_buffer, display_count), Qnil,
5905 doc: /* A number incremented each time this buffer is displayed in a window.
5906 The function `set-window-buffer' increments it. */);
5908 DEFVAR_PER_BUFFER ("buffer-display-time",
5909 &BVAR (current_buffer, display_time), Qnil,
5910 doc: /* Time stamp updated each time this buffer is displayed in a window.
5911 The function `set-window-buffer' updates this variable
5912 to the value obtained by calling `current-time'.
5913 If the buffer has never been shown in a window, the value is nil. */);
5915 DEFVAR_LISP ("transient-mark-mode", Vtransient_mark_mode,
5916 doc: /* Non-nil if Transient Mark mode is enabled.
5917 See the command `transient-mark-mode' for a description of this minor mode.
5919 Non-nil also enables highlighting of the region whenever the mark is active.
5920 The variable `highlight-nonselected-windows' controls whether to highlight
5921 all windows or just the selected window.
5923 Lisp programs may give this variable certain special values:
5925 - A value of `lambda' enables Transient Mark mode temporarily.
5926 It is disabled again after any subsequent action that would
5927 normally deactivate the mark (e.g. buffer modification).
5929 - A value of (only . OLDVAL) enables Transient Mark mode
5930 temporarily. After any subsequent point motion command that is
5931 not shift-translated, or any other action that would normally
5932 deactivate the mark (e.g. buffer modification), the value of
5933 `transient-mark-mode' is set to OLDVAL. */);
5934 Vtransient_mark_mode = Qnil;
5936 DEFVAR_LISP ("inhibit-read-only", Vinhibit_read_only,
5937 doc: /* *Non-nil means disregard read-only status of buffers or characters.
5938 If the value is t, disregard `buffer-read-only' and all `read-only'
5939 text properties. If the value is a list, disregard `buffer-read-only'
5940 and disregard a `read-only' text property if the property value
5941 is a member of the list. */);
5942 Vinhibit_read_only = Qnil;
5944 DEFVAR_PER_BUFFER ("cursor-type", &BVAR (current_buffer, cursor_type), Qnil,
5945 doc: /* Cursor to use when this buffer is in the selected window.
5946 Values are interpreted as follows:
5948 t use the cursor specified for the frame
5949 nil don't display a cursor
5950 box display a filled box cursor
5951 hollow display a hollow box cursor
5952 bar display a vertical bar cursor with default width
5953 (bar . WIDTH) display a vertical bar cursor with width WIDTH
5954 hbar display a horizontal bar cursor with default height
5955 (hbar . HEIGHT) display a horizontal bar cursor with height HEIGHT
5956 ANYTHING ELSE display a hollow box cursor
5958 When the buffer is displayed in a non-selected window, the
5959 cursor's appearance is instead controlled by the variable
5960 `cursor-in-non-selected-windows'. */);
5962 DEFVAR_PER_BUFFER ("line-spacing",
5963 &BVAR (current_buffer, extra_line_spacing), Qnil,
5964 doc: /* Additional space to put between lines when displaying a buffer.
5965 The space is measured in pixels, and put below lines on graphic displays,
5966 see `display-graphic-p'.
5967 If value is a floating point number, it specifies the spacing relative
5968 to the default frame line height. A value of nil means add no extra space. */);
5970 DEFVAR_PER_BUFFER ("cursor-in-non-selected-windows",
5971 &BVAR (current_buffer, cursor_in_non_selected_windows), Qnil,
5972 doc: /* *Non-nil means show a cursor in non-selected windows.
5973 If nil, only shows a cursor in the selected window.
5974 If t, displays a cursor related to the usual cursor type
5975 \(a solid box becomes hollow, a bar becomes a narrower bar).
5976 You can also specify the cursor type as in the `cursor-type' variable.
5977 Use Custom to set this variable and update the display." */);
5979 DEFVAR_LISP ("kill-buffer-query-functions", Vkill_buffer_query_functions,
5980 doc: /* List of functions called with no args to query before killing a buffer.
5981 The buffer being killed will be current while the functions are running.
5982 If any of them returns nil, the buffer is not killed. */);
5983 Vkill_buffer_query_functions = Qnil;
5985 DEFVAR_LISP ("change-major-mode-hook", Vchange_major_mode_hook,
5986 doc: /* Normal hook run before changing the major mode of a buffer.
5987 The function `kill-all-local-variables' runs this before doing anything else. */);
5988 Vchange_major_mode_hook = Qnil;
5989 DEFSYM (Qchange_major_mode_hook, "change-major-mode-hook");
5991 DEFVAR_LISP ("buffer-list-update-hook", Vbuffer_list_update_hook,
5992 doc: /* Hook run when the buffer list changes.
5993 Functions running this hook are `get-buffer-create',
5994 `make-indirect-buffer', `rename-buffer', `kill-buffer',
5995 `record-buffer' and `unrecord-buffer'. */);
5996 Vbuffer_list_update_hook = Qnil;
5997 DEFSYM (Qbuffer_list_update_hook, "buffer-list-update-hook");
5999 defsubr (&Sbuffer_live_p);
6000 defsubr (&Sbuffer_list);
6001 defsubr (&Sget_buffer);
6002 defsubr (&Sget_file_buffer);
6003 defsubr (&Sget_buffer_create);
6004 defsubr (&Smake_indirect_buffer);
6005 defsubr (&Sgenerate_new_buffer_name);
6006 defsubr (&Sbuffer_name);
6007 /*defsubr (&Sbuffer_number);*/
6008 defsubr (&Sbuffer_file_name);
6009 defsubr (&Sbuffer_base_buffer);
6010 defsubr (&Sbuffer_local_value);
6011 defsubr (&Sbuffer_local_variables);
6012 defsubr (&Sbuffer_modified_p);
6013 defsubr (&Sset_buffer_modified_p);
6014 defsubr (&Sbuffer_modified_tick);
6015 defsubr (&Sbuffer_chars_modified_tick);
6016 defsubr (&Srename_buffer);
6017 defsubr (&Sother_buffer);
6018 defsubr (&Sbuffer_enable_undo);
6019 defsubr (&Skill_buffer);
6020 defsubr (&Sbury_buffer_internal);
6021 defsubr (&Sset_buffer_major_mode);
6022 defsubr (&Scurrent_buffer);
6023 defsubr (&Sset_buffer);
6024 defsubr (&Sbarf_if_buffer_read_only);
6025 defsubr (&Serase_buffer);
6026 defsubr (&Sbuffer_swap_text);
6027 defsubr (&Sset_buffer_multibyte);
6028 defsubr (&Skill_all_local_variables);
6030 defsubr (&Soverlayp);
6031 defsubr (&Smake_overlay);
6032 defsubr (&Sdelete_overlay);
6033 defsubr (&Smove_overlay);
6034 defsubr (&Soverlay_start);
6035 defsubr (&Soverlay_end);
6036 defsubr (&Soverlay_buffer);
6037 defsubr (&Soverlay_properties);
6038 defsubr (&Soverlays_at);
6039 defsubr (&Soverlays_in);
6040 defsubr (&Snext_overlay_change);
6041 defsubr (&Sprevious_overlay_change);
6042 defsubr (&Soverlay_recenter);
6043 defsubr (&Soverlay_lists);
6044 defsubr (&Soverlay_get);
6045 defsubr (&Soverlay_put);
6046 defsubr (&Srestore_buffer_modified_p);
6049 void
6050 keys_of_buffer (void)
6052 initial_define_key (control_x_map, 'b', "switch-to-buffer");
6053 initial_define_key (control_x_map, 'k', "kill-buffer");
6055 /* This must not be in syms_of_buffer, because Qdisabled is not
6056 initialized when that function gets called. */
6057 Fput (intern_c_string ("erase-buffer"), Qdisabled, Qt);