*** empty log message ***
[bpt/emacs.git] / src / buffer.c
1 /* Buffer manipulation primitives for GNU Emacs.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994,
3 1995, 1997, 1998, 1999, 2000, 2001, 2002,
4 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
5
6 This file is part of GNU Emacs.
7
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
11 any later version.
12
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
17
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
22
23 #include <config.h>
24
25 #include <sys/types.h>
26 #include <sys/stat.h>
27 #include <sys/param.h>
28 #include <errno.h>
29 #include <stdio.h>
30
31 #ifndef USE_CRT_DLL
32 extern int errno;
33 #endif
34
35
36 #ifdef HAVE_UNISTD_H
37 #include <unistd.h>
38 #endif
39
40 #include "lisp.h"
41 #include "intervals.h"
42 #include "window.h"
43 #include "commands.h"
44 #include "buffer.h"
45 #include "charset.h"
46 #include "region-cache.h"
47 #include "indent.h"
48 #include "blockinput.h"
49 #include "keyboard.h"
50 #include "keymap.h"
51 #include "frame.h"
52
53 struct buffer *current_buffer; /* the current buffer */
54
55 /* First buffer in chain of all buffers (in reverse order of creation).
56 Threaded through ->next. */
57
58 struct buffer *all_buffers;
59
60 /* This structure holds the default values of the buffer-local variables
61 defined with DEFVAR_PER_BUFFER, that have special slots in each buffer.
62 The default value occupies the same slot in this structure
63 as an individual buffer's value occupies in that buffer.
64 Setting the default value also goes through the alist of buffers
65 and stores into each buffer that does not say it has a local value. */
66
67 DECL_ALIGN (struct buffer, buffer_defaults);
68
69 /* A Lisp_Object pointer to the above, used for staticpro */
70
71 static Lisp_Object Vbuffer_defaults;
72
73 /* This structure marks which slots in a buffer have corresponding
74 default values in buffer_defaults.
75 Each such slot has a nonzero value in this structure.
76 The value has only one nonzero bit.
77
78 When a buffer has its own local value for a slot,
79 the entry for that slot (found in the same slot in this structure)
80 is turned on in the buffer's local_flags array.
81
82 If a slot in this structure is -1, then even though there may
83 be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
84 and the corresponding slot in buffer_defaults is not used.
85
86 If a slot is -2, then there is no DEFVAR_PER_BUFFER for it,
87 but there is a default value which is copied into each buffer.
88
89 If a slot in this structure corresponding to a DEFVAR_PER_BUFFER is
90 zero, that is a bug */
91
92 struct buffer buffer_local_flags;
93
94 /* This structure holds the names of symbols whose values may be
95 buffer-local. It is indexed and accessed in the same way as the above. */
96
97 DECL_ALIGN (struct buffer, buffer_local_symbols);
98
99 /* A Lisp_Object pointer to the above, used for staticpro */
100 static Lisp_Object Vbuffer_local_symbols;
101
102 /* This structure holds the required types for the values in the
103 buffer-local slots. If a slot contains Qnil, then the
104 corresponding buffer slot may contain a value of any type. If a
105 slot contains an integer, then prospective values' tags must be
106 equal to that integer (except nil is always allowed).
107 When a tag does not match, the function
108 buffer_slot_type_mismatch will signal an error.
109
110 If a slot here contains -1, the corresponding variable is read-only. */
111 struct buffer buffer_local_types;
112
113 /* Flags indicating which built-in buffer-local variables
114 are permanent locals. */
115 static char buffer_permanent_local_flags[MAX_PER_BUFFER_VARS];
116
117 /* Number of per-buffer variables used. */
118
119 int last_per_buffer_idx;
120
121 Lisp_Object Fset_buffer ();
122 void set_buffer_internal ();
123 void set_buffer_internal_1 ();
124 static void call_overlay_mod_hooks ();
125 static void swap_out_buffer_local_variables ();
126 static void reset_buffer_local_variables ();
127
128 /* Alist of all buffer names vs the buffers. */
129 /* This used to be a variable, but is no longer,
130 to prevent lossage due to user rplac'ing this alist or its elements. */
131 Lisp_Object Vbuffer_alist;
132
133 /* Functions to call before and after each text change. */
134 Lisp_Object Vbefore_change_functions;
135 Lisp_Object Vafter_change_functions;
136
137 Lisp_Object Vtransient_mark_mode;
138
139 /* t means ignore all read-only text properties.
140 A list means ignore such a property if its value is a member of the list.
141 Any non-nil value means ignore buffer-read-only. */
142 Lisp_Object Vinhibit_read_only;
143
144 /* List of functions to call that can query about killing a buffer.
145 If any of these functions returns nil, we don't kill it. */
146 Lisp_Object Vkill_buffer_query_functions;
147 Lisp_Object Qkill_buffer_query_functions;
148
149 /* Hook run before changing a major mode. */
150 Lisp_Object Vchange_major_mode_hook, Qchange_major_mode_hook;
151
152 /* List of functions to call before changing an unmodified buffer. */
153 Lisp_Object Vfirst_change_hook;
154
155 Lisp_Object Qfirst_change_hook;
156 Lisp_Object Qbefore_change_functions;
157 Lisp_Object Qafter_change_functions;
158 Lisp_Object Qucs_set_table_for_input;
159
160 /* If nonzero, all modification hooks are suppressed. */
161 int inhibit_modification_hooks;
162
163 Lisp_Object Qfundamental_mode, Qmode_class, Qpermanent_local;
164
165 Lisp_Object Qprotected_field;
166
167 Lisp_Object QSFundamental; /* A string "Fundamental" */
168
169 Lisp_Object Qkill_buffer_hook;
170
171 Lisp_Object Qget_file_buffer;
172
173 Lisp_Object Qoverlayp;
174
175 Lisp_Object Qpriority, Qwindow, Qevaporate, Qbefore_string, Qafter_string;
176
177 Lisp_Object Qmodification_hooks;
178 Lisp_Object Qinsert_in_front_hooks;
179 Lisp_Object Qinsert_behind_hooks;
180
181 static void alloc_buffer_text P_ ((struct buffer *, size_t));
182 static void free_buffer_text P_ ((struct buffer *b));
183 static struct Lisp_Overlay * copy_overlays P_ ((struct buffer *, struct Lisp_Overlay *));
184 static void modify_overlay P_ ((struct buffer *, EMACS_INT, EMACS_INT));
185 static Lisp_Object buffer_lisp_local_variables P_ ((struct buffer *));
186
187
188 /* For debugging; temporary. See set_buffer_internal. */
189 /* Lisp_Object Qlisp_mode, Vcheck_symbol; */
190
191 void
192 nsberror (spec)
193 Lisp_Object spec;
194 {
195 if (STRINGP (spec))
196 error ("No buffer named %s", SDATA (spec));
197 error ("Invalid buffer argument");
198 }
199 \f
200 DEFUN ("buffer-live-p", Fbuffer_live_p, Sbuffer_live_p, 1, 1, 0,
201 doc: /* Return non-nil if OBJECT is a buffer which has not been killed.
202 Value is nil if OBJECT is not a buffer or if it has been killed. */)
203 (object)
204 Lisp_Object object;
205 {
206 return ((BUFFERP (object) && ! NILP (XBUFFER (object)->name))
207 ? Qt : Qnil);
208 }
209
210 DEFUN ("buffer-list", Fbuffer_list, Sbuffer_list, 0, 1, 0,
211 doc: /* Return a list of all existing live buffers.
212 If the optional arg FRAME is a frame, we return the buffer list
213 in the proper order for that frame: the buffers in FRAME's `buffer-list'
214 frame parameter come first, followed by the rest of the buffers. */)
215 (frame)
216 Lisp_Object frame;
217 {
218 Lisp_Object framelist, general;
219 general = Fmapcar (Qcdr, Vbuffer_alist);
220
221 if (FRAMEP (frame))
222 {
223 Lisp_Object tail;
224
225 CHECK_FRAME (frame);
226
227 framelist = Fcopy_sequence (XFRAME (frame)->buffer_list);
228
229 /* Remove from GENERAL any buffer that duplicates one in FRAMELIST. */
230 tail = framelist;
231 while (! NILP (tail))
232 {
233 general = Fdelq (XCAR (tail), general);
234 tail = XCDR (tail);
235 }
236 return nconc2 (framelist, general);
237 }
238
239 return general;
240 }
241
242 /* Like Fassoc, but use Fstring_equal to compare
243 (which ignores text properties),
244 and don't ever QUIT. */
245
246 static Lisp_Object
247 assoc_ignore_text_properties (key, list)
248 register Lisp_Object key;
249 Lisp_Object list;
250 {
251 register Lisp_Object tail;
252 for (tail = list; CONSP (tail); tail = XCDR (tail))
253 {
254 register Lisp_Object elt, tem;
255 elt = XCAR (tail);
256 tem = Fstring_equal (Fcar (elt), key);
257 if (!NILP (tem))
258 return elt;
259 }
260 return Qnil;
261 }
262
263 DEFUN ("get-buffer", Fget_buffer, Sget_buffer, 1, 1, 0,
264 doc: /* Return the buffer named NAME (a string).
265 If there is no live buffer named NAME, return nil.
266 NAME may also be a buffer; if so, the value is that buffer. */)
267 (name)
268 register Lisp_Object name;
269 {
270 if (BUFFERP (name))
271 return name;
272 CHECK_STRING (name);
273
274 return Fcdr (assoc_ignore_text_properties (name, Vbuffer_alist));
275 }
276
277 DEFUN ("get-file-buffer", Fget_file_buffer, Sget_file_buffer, 1, 1, 0,
278 doc: /* Return the buffer visiting file FILENAME (a string).
279 The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.
280 If there is no such live buffer, return nil.
281 See also `find-buffer-visiting'. */)
282 (filename)
283 register Lisp_Object filename;
284 {
285 register Lisp_Object tail, buf, tem;
286 Lisp_Object handler;
287
288 CHECK_STRING (filename);
289 filename = Fexpand_file_name (filename, Qnil);
290
291 /* If the file name has special constructs in it,
292 call the corresponding file handler. */
293 handler = Ffind_file_name_handler (filename, Qget_file_buffer);
294 if (!NILP (handler))
295 return call2 (handler, Qget_file_buffer, filename);
296
297 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
298 {
299 buf = Fcdr (XCAR (tail));
300 if (!BUFFERP (buf)) continue;
301 if (!STRINGP (XBUFFER (buf)->filename)) continue;
302 tem = Fstring_equal (XBUFFER (buf)->filename, filename);
303 if (!NILP (tem))
304 return buf;
305 }
306 return Qnil;
307 }
308
309 Lisp_Object
310 get_truename_buffer (filename)
311 register Lisp_Object filename;
312 {
313 register Lisp_Object tail, buf, tem;
314
315 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
316 {
317 buf = Fcdr (XCAR (tail));
318 if (!BUFFERP (buf)) continue;
319 if (!STRINGP (XBUFFER (buf)->file_truename)) continue;
320 tem = Fstring_equal (XBUFFER (buf)->file_truename, filename);
321 if (!NILP (tem))
322 return buf;
323 }
324 return Qnil;
325 }
326
327 /* Incremented for each buffer created, to assign the buffer number. */
328 int buffer_count;
329
330 DEFUN ("get-buffer-create", Fget_buffer_create, Sget_buffer_create, 1, 1, 0,
331 doc: /* Return the buffer named NAME, or create such a buffer and return it.
332 A new buffer is created if there is no live buffer named NAME.
333 If NAME starts with a space, the new buffer does not keep undo information.
334 If NAME is a buffer instead of a string, then it is the value returned.
335 The value is never nil. */)
336 (name)
337 register Lisp_Object name;
338 {
339 register Lisp_Object buf;
340 register struct buffer *b;
341
342 buf = Fget_buffer (name);
343 if (!NILP (buf))
344 return buf;
345
346 if (SCHARS (name) == 0)
347 error ("Empty string for buffer name is not allowed");
348
349 b = (struct buffer *) allocate_buffer ();
350
351 b->size = sizeof (struct buffer) / sizeof (EMACS_INT);
352
353 /* An ordinary buffer uses its own struct buffer_text. */
354 b->text = &b->own_text;
355 b->base_buffer = 0;
356
357 BUF_GAP_SIZE (b) = 20;
358 BLOCK_INPUT;
359 /* We allocate extra 1-byte at the tail and keep it always '\0' for
360 anchoring a search. */
361 alloc_buffer_text (b, BUF_GAP_SIZE (b) + 1);
362 UNBLOCK_INPUT;
363 if (! BUF_BEG_ADDR (b))
364 buffer_memory_full ();
365
366 BUF_PT (b) = BEG;
367 BUF_GPT (b) = BEG;
368 BUF_BEGV (b) = BEG;
369 BUF_ZV (b) = BEG;
370 BUF_Z (b) = BEG;
371 BUF_PT_BYTE (b) = BEG_BYTE;
372 BUF_GPT_BYTE (b) = BEG_BYTE;
373 BUF_BEGV_BYTE (b) = BEG_BYTE;
374 BUF_ZV_BYTE (b) = BEG_BYTE;
375 BUF_Z_BYTE (b) = BEG_BYTE;
376 BUF_MODIFF (b) = 1;
377 BUF_CHARS_MODIFF (b) = 1;
378 BUF_OVERLAY_MODIFF (b) = 1;
379 BUF_SAVE_MODIFF (b) = 1;
380 BUF_INTERVALS (b) = 0;
381 BUF_UNCHANGED_MODIFIED (b) = 1;
382 BUF_OVERLAY_UNCHANGED_MODIFIED (b) = 1;
383 BUF_END_UNCHANGED (b) = 0;
384 BUF_BEG_UNCHANGED (b) = 0;
385 *(BUF_GPT_ADDR (b)) = *(BUF_Z_ADDR (b)) = 0; /* Put an anchor '\0'. */
386
387 b->newline_cache = 0;
388 b->width_run_cache = 0;
389 b->width_table = Qnil;
390 b->prevent_redisplay_optimizations_p = 1;
391
392 /* Put this on the chain of all buffers including killed ones. */
393 b->next = all_buffers;
394 all_buffers = b;
395
396 /* An ordinary buffer normally doesn't need markers
397 to handle BEGV and ZV. */
398 b->pt_marker = Qnil;
399 b->begv_marker = Qnil;
400 b->zv_marker = Qnil;
401
402 name = Fcopy_sequence (name);
403 STRING_SET_INTERVALS (name, NULL_INTERVAL);
404 b->name = name;
405
406 if (SREF (name, 0) != ' ')
407 b->undo_list = Qnil;
408 else
409 b->undo_list = Qt;
410
411 reset_buffer (b);
412 reset_buffer_local_variables (b, 1);
413
414 b->mark = Fmake_marker ();
415 BUF_MARKERS (b) = NULL;
416 b->name = name;
417
418 /* Put this in the alist of all live buffers. */
419 XSETBUFFER (buf, b);
420 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
421
422 /* An error in calling the function here (should someone redefine it)
423 can lead to infinite regress until you run out of stack. rms
424 says that's not worth protecting against. */
425 if (!NILP (Ffboundp (Qucs_set_table_for_input)))
426 /* buf is on buffer-alist, so no gcpro. */
427 call1 (Qucs_set_table_for_input, buf);
428
429 return buf;
430 }
431
432
433 /* Return a list of overlays which is a copy of the overlay list
434 LIST, but for buffer B. */
435
436 static struct Lisp_Overlay *
437 copy_overlays (b, list)
438 struct buffer *b;
439 struct Lisp_Overlay *list;
440 {
441 Lisp_Object buffer;
442 struct Lisp_Overlay *result = NULL, *tail = NULL;
443
444 XSETBUFFER (buffer, b);
445
446 for (; list; list = list->next)
447 {
448 Lisp_Object overlay, start, end, old_overlay;
449 EMACS_INT charpos;
450
451 XSETMISC (old_overlay, list);
452 charpos = marker_position (OVERLAY_START (old_overlay));
453 start = Fmake_marker ();
454 Fset_marker (start, make_number (charpos), buffer);
455 XMARKER (start)->insertion_type
456 = XMARKER (OVERLAY_START (old_overlay))->insertion_type;
457
458 charpos = marker_position (OVERLAY_END (old_overlay));
459 end = Fmake_marker ();
460 Fset_marker (end, make_number (charpos), buffer);
461 XMARKER (end)->insertion_type
462 = XMARKER (OVERLAY_END (old_overlay))->insertion_type;
463
464 overlay = allocate_misc ();
465 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
466 OVERLAY_START (overlay) = start;
467 OVERLAY_END (overlay) = end;
468 OVERLAY_PLIST (overlay) = Fcopy_sequence (OVERLAY_PLIST (old_overlay));
469 XOVERLAY (overlay)->next = NULL;
470
471 if (tail)
472 tail = tail->next = XOVERLAY (overlay);
473 else
474 result = tail = XOVERLAY (overlay);
475 }
476
477 return result;
478 }
479
480
481 /* Clone per-buffer values of buffer FROM.
482
483 Buffer TO gets the same per-buffer values as FROM, with the
484 following exceptions: (1) TO's name is left untouched, (2) markers
485 are copied and made to refer to TO, and (3) overlay lists are
486 copied. */
487
488 static void
489 clone_per_buffer_values (from, to)
490 struct buffer *from, *to;
491 {
492 Lisp_Object to_buffer;
493 int offset;
494
495 XSETBUFFER (to_buffer, to);
496
497 for (offset = PER_BUFFER_VAR_OFFSET (name) + sizeof (Lisp_Object);
498 offset < sizeof *to;
499 offset += sizeof (Lisp_Object))
500 {
501 Lisp_Object obj;
502
503 obj = PER_BUFFER_VALUE (from, offset);
504 if (MARKERP (obj))
505 {
506 struct Lisp_Marker *m = XMARKER (obj);
507 obj = Fmake_marker ();
508 XMARKER (obj)->insertion_type = m->insertion_type;
509 set_marker_both (obj, to_buffer, m->charpos, m->bytepos);
510 }
511
512 PER_BUFFER_VALUE (to, offset) = obj;
513 }
514
515 bcopy (from->local_flags, to->local_flags, sizeof to->local_flags);
516
517 to->overlays_before = copy_overlays (to, from->overlays_before);
518 to->overlays_after = copy_overlays (to, from->overlays_after);
519
520 /* Get (a copy of) the alist of Lisp-level local variables of FROM
521 and install that in TO. */
522 to->local_var_alist = buffer_lisp_local_variables (from);
523 }
524
525 DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer,
526 2, 3,
527 "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
528 doc: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
529 BASE-BUFFER should be a live buffer, or the name of an existing buffer.
530 NAME should be a string which is not the name of an existing buffer.
531 Optional argument CLONE non-nil means preserve BASE-BUFFER's state,
532 such as major and minor modes, in the indirect buffer.
533 CLONE nil means the indirect buffer's state is reset to default values. */)
534 (base_buffer, name, clone)
535 Lisp_Object base_buffer, name, clone;
536 {
537 Lisp_Object buf, tem;
538 struct buffer *b;
539
540 CHECK_STRING (name);
541 buf = Fget_buffer (name);
542 if (!NILP (buf))
543 error ("Buffer name `%s' is in use", SDATA (name));
544
545 tem = base_buffer;
546 base_buffer = Fget_buffer (base_buffer);
547 if (NILP (base_buffer))
548 error ("No such buffer: `%s'", SDATA (tem));
549 if (NILP (XBUFFER (base_buffer)->name))
550 error ("Base buffer has been killed");
551
552 if (SCHARS (name) == 0)
553 error ("Empty string for buffer name is not allowed");
554
555 b = (struct buffer *) allocate_buffer ();
556 b->size = sizeof (struct buffer) / sizeof (EMACS_INT);
557
558 if (XBUFFER (base_buffer)->base_buffer)
559 b->base_buffer = XBUFFER (base_buffer)->base_buffer;
560 else
561 b->base_buffer = XBUFFER (base_buffer);
562
563 /* Use the base buffer's text object. */
564 b->text = b->base_buffer->text;
565
566 BUF_BEGV (b) = BUF_BEGV (b->base_buffer);
567 BUF_ZV (b) = BUF_ZV (b->base_buffer);
568 BUF_PT (b) = BUF_PT (b->base_buffer);
569 BUF_BEGV_BYTE (b) = BUF_BEGV_BYTE (b->base_buffer);
570 BUF_ZV_BYTE (b) = BUF_ZV_BYTE (b->base_buffer);
571 BUF_PT_BYTE (b) = BUF_PT_BYTE (b->base_buffer);
572
573 b->newline_cache = 0;
574 b->width_run_cache = 0;
575 b->width_table = Qnil;
576
577 /* Put this on the chain of all buffers including killed ones. */
578 b->next = all_buffers;
579 all_buffers = b;
580
581 name = Fcopy_sequence (name);
582 STRING_SET_INTERVALS (name, NULL_INTERVAL);
583 b->name = name;
584
585 reset_buffer (b);
586 reset_buffer_local_variables (b, 1);
587
588 /* Put this in the alist of all live buffers. */
589 XSETBUFFER (buf, b);
590 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
591
592 b->mark = Fmake_marker ();
593 b->name = name;
594
595 /* The multibyte status belongs to the base buffer. */
596 b->enable_multibyte_characters = b->base_buffer->enable_multibyte_characters;
597
598 /* Make sure the base buffer has markers for its narrowing. */
599 if (NILP (b->base_buffer->pt_marker))
600 {
601 b->base_buffer->pt_marker = Fmake_marker ();
602 set_marker_both (b->base_buffer->pt_marker, base_buffer,
603 BUF_PT (b->base_buffer),
604 BUF_PT_BYTE (b->base_buffer));
605 }
606 if (NILP (b->base_buffer->begv_marker))
607 {
608 b->base_buffer->begv_marker = Fmake_marker ();
609 set_marker_both (b->base_buffer->begv_marker, base_buffer,
610 BUF_BEGV (b->base_buffer),
611 BUF_BEGV_BYTE (b->base_buffer));
612 }
613 if (NILP (b->base_buffer->zv_marker))
614 {
615 b->base_buffer->zv_marker = Fmake_marker ();
616 set_marker_both (b->base_buffer->zv_marker, base_buffer,
617 BUF_ZV (b->base_buffer),
618 BUF_ZV_BYTE (b->base_buffer));
619 XMARKER (b->base_buffer->zv_marker)->insertion_type = 1;
620 }
621
622 if (NILP (clone))
623 {
624 /* Give the indirect buffer markers for its narrowing. */
625 b->pt_marker = Fmake_marker ();
626 set_marker_both (b->pt_marker, buf, BUF_PT (b), BUF_PT_BYTE (b));
627 b->begv_marker = Fmake_marker ();
628 set_marker_both (b->begv_marker, buf, BUF_BEGV (b), BUF_BEGV_BYTE (b));
629 b->zv_marker = Fmake_marker ();
630 set_marker_both (b->zv_marker, buf, BUF_ZV (b), BUF_ZV_BYTE (b));
631 XMARKER (b->zv_marker)->insertion_type = 1;
632 }
633 else
634 {
635 struct buffer *old_b = current_buffer;
636
637 clone_per_buffer_values (b->base_buffer, b);
638 b->filename = Qnil;
639 b->file_truename = Qnil;
640 b->display_count = make_number (0);
641 b->backed_up = Qnil;
642 b->auto_save_file_name = Qnil;
643 set_buffer_internal_1 (b);
644 Fset (intern ("buffer-save-without-query"), Qnil);
645 Fset (intern ("buffer-file-number"), Qnil);
646 Fset (intern ("buffer-stale-function"), Qnil);
647 set_buffer_internal_1 (old_b);
648 }
649
650 return buf;
651 }
652
653 void
654 delete_all_overlays (b)
655 struct buffer *b;
656 {
657 Lisp_Object overlay;
658
659 /* `reset_buffer' blindly sets the list of overlays to NULL, so we
660 have to empty the list, otherwise we end up with overlays that
661 think they belong to this buffer while the buffer doesn't know about
662 them any more. */
663 while (b->overlays_before)
664 {
665 XSETMISC (overlay, b->overlays_before);
666 Fdelete_overlay (overlay);
667 }
668 while (b->overlays_after)
669 {
670 XSETMISC (overlay, b->overlays_after);
671 Fdelete_overlay (overlay);
672 }
673 eassert (b->overlays_before == NULL);
674 eassert (b->overlays_after == NULL);
675 }
676
677 /* Reinitialize everything about a buffer except its name and contents
678 and local variables.
679 If called on an already-initialized buffer, the list of overlays
680 should be deleted before calling this function, otherwise we end up
681 with overlays that claim to belong to the buffer but the buffer
682 claims it doesn't belong to it. */
683
684 void
685 reset_buffer (b)
686 register struct buffer *b;
687 {
688 b->filename = Qnil;
689 b->file_truename = Qnil;
690 b->directory = (current_buffer) ? current_buffer->directory : Qnil;
691 b->modtime = 0;
692 XSETFASTINT (b->save_length, 0);
693 b->last_window_start = 1;
694 /* It is more conservative to start out "changed" than "unchanged". */
695 b->clip_changed = 0;
696 b->prevent_redisplay_optimizations_p = 1;
697 b->backed_up = Qnil;
698 b->auto_save_modified = 0;
699 b->auto_save_failure_time = -1;
700 b->auto_save_file_name = Qnil;
701 b->read_only = Qnil;
702 b->overlays_before = NULL;
703 b->overlays_after = NULL;
704 b->overlay_center = BEG;
705 b->mark_active = Qnil;
706 b->point_before_scroll = Qnil;
707 b->file_format = Qnil;
708 b->auto_save_file_format = Qt;
709 b->last_selected_window = Qnil;
710 XSETINT (b->display_count, 0);
711 b->display_time = Qnil;
712 b->enable_multibyte_characters = buffer_defaults.enable_multibyte_characters;
713 b->cursor_type = buffer_defaults.cursor_type;
714 b->extra_line_spacing = buffer_defaults.extra_line_spacing;
715
716 b->display_error_modiff = 0;
717 }
718
719 /* Reset buffer B's local variables info.
720 Don't use this on a buffer that has already been in use;
721 it does not treat permanent locals consistently.
722 Instead, use Fkill_all_local_variables.
723
724 If PERMANENT_TOO is 1, then we reset permanent built-in
725 buffer-local variables. If PERMANENT_TOO is 0,
726 we preserve those. */
727
728 static void
729 reset_buffer_local_variables (b, permanent_too)
730 register struct buffer *b;
731 int permanent_too;
732 {
733 register int offset;
734 int i;
735
736 /* Reset the major mode to Fundamental, together with all the
737 things that depend on the major mode.
738 default-major-mode is handled at a higher level.
739 We ignore it here. */
740 b->major_mode = Qfundamental_mode;
741 b->keymap = Qnil;
742 b->mode_name = QSFundamental;
743 b->minor_modes = Qnil;
744
745 /* If the standard case table has been altered and invalidated,
746 fix up its insides first. */
747 if (! (CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[0])
748 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[1])
749 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[2])))
750 Fset_standard_case_table (Vascii_downcase_table);
751
752 b->downcase_table = Vascii_downcase_table;
753 b->upcase_table = XCHAR_TABLE (Vascii_downcase_table)->extras[0];
754 b->case_canon_table = XCHAR_TABLE (Vascii_downcase_table)->extras[1];
755 b->case_eqv_table = XCHAR_TABLE (Vascii_downcase_table)->extras[2];
756 b->invisibility_spec = Qt;
757 #ifndef DOS_NT
758 b->buffer_file_type = Qnil;
759 #endif
760
761 /* Reset all (or most) per-buffer variables to their defaults. */
762 b->local_var_alist = Qnil;
763 for (i = 0; i < last_per_buffer_idx; ++i)
764 if (permanent_too || buffer_permanent_local_flags[i] == 0)
765 SET_PER_BUFFER_VALUE_P (b, i, 0);
766
767 /* For each slot that has a default value,
768 copy that into the slot. */
769
770 for (offset = PER_BUFFER_VAR_OFFSET (name);
771 offset < sizeof *b;
772 offset += sizeof (Lisp_Object))
773 {
774 int idx = PER_BUFFER_IDX (offset);
775 if ((idx > 0
776 && (permanent_too
777 || buffer_permanent_local_flags[idx] == 0))
778 /* Is -2 used anywhere? */
779 || idx == -2)
780 PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
781 }
782 }
783
784 /* We split this away from generate-new-buffer, because rename-buffer
785 and set-visited-file-name ought to be able to use this to really
786 rename the buffer properly. */
787
788 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name, Sgenerate_new_buffer_name,
789 1, 2, 0,
790 doc: /* Return a string that is the name of no existing buffer based on NAME.
791 If there is no live buffer named NAME, then return NAME.
792 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
793 \(starting at 2) until an unused name is found, and then return that name.
794 Optional second argument IGNORE specifies a name that is okay to use (if
795 it is in the sequence to be tried) even if a buffer with that name exists. */)
796 (name, ignore)
797 register Lisp_Object name, ignore;
798 {
799 register Lisp_Object gentemp, tem;
800 int count;
801 char number[10];
802
803 CHECK_STRING (name);
804
805 tem = Fstring_equal (name, ignore);
806 if (!NILP (tem))
807 return name;
808 tem = Fget_buffer (name);
809 if (NILP (tem))
810 return name;
811
812 count = 1;
813 while (1)
814 {
815 sprintf (number, "<%d>", ++count);
816 gentemp = concat2 (name, build_string (number));
817 tem = Fstring_equal (gentemp, ignore);
818 if (!NILP (tem))
819 return gentemp;
820 tem = Fget_buffer (gentemp);
821 if (NILP (tem))
822 return gentemp;
823 }
824 }
825
826 \f
827 DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
828 doc: /* Return the name of BUFFER, as a string.
829 With no argument or nil as argument, return the name of the current buffer. */)
830 (buffer)
831 register Lisp_Object buffer;
832 {
833 if (NILP (buffer))
834 return current_buffer->name;
835 CHECK_BUFFER (buffer);
836 return XBUFFER (buffer)->name;
837 }
838
839 DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
840 doc: /* Return name of file BUFFER is visiting, or nil if none.
841 No argument or nil as argument means use the current buffer. */)
842 (buffer)
843 register Lisp_Object buffer;
844 {
845 if (NILP (buffer))
846 return current_buffer->filename;
847 CHECK_BUFFER (buffer);
848 return XBUFFER (buffer)->filename;
849 }
850
851 DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
852 0, 1, 0,
853 doc: /* Return the base buffer of indirect buffer BUFFER.
854 If BUFFER is not indirect, return nil.
855 BUFFER defaults to the current buffer. */)
856 (buffer)
857 register Lisp_Object buffer;
858 {
859 struct buffer *base;
860 Lisp_Object base_buffer;
861
862 if (NILP (buffer))
863 base = current_buffer->base_buffer;
864 else
865 {
866 CHECK_BUFFER (buffer);
867 base = XBUFFER (buffer)->base_buffer;
868 }
869
870 if (! base)
871 return Qnil;
872 XSETBUFFER (base_buffer, base);
873 return base_buffer;
874 }
875
876 DEFUN ("buffer-local-value", Fbuffer_local_value,
877 Sbuffer_local_value, 2, 2, 0,
878 doc: /* Return the value of VARIABLE in BUFFER.
879 If VARIABLE does not have a buffer-local binding in BUFFER, the value
880 is the default binding of the variable. */)
881 (variable, buffer)
882 register Lisp_Object variable;
883 register Lisp_Object buffer;
884 {
885 register struct buffer *buf;
886 register Lisp_Object result;
887
888 CHECK_SYMBOL (variable);
889 CHECK_BUFFER (buffer);
890 buf = XBUFFER (buffer);
891
892 if (SYMBOLP (variable))
893 variable = indirect_variable (variable);
894
895 /* Look in local_var_list */
896 result = Fassoc (variable, buf->local_var_alist);
897 if (NILP (result))
898 {
899 int offset, idx;
900 int found = 0;
901
902 /* Look in special slots */
903 for (offset = PER_BUFFER_VAR_OFFSET (name);
904 offset < sizeof (struct buffer);
905 /* sizeof EMACS_INT == sizeof Lisp_Object */
906 offset += (sizeof (EMACS_INT)))
907 {
908 idx = PER_BUFFER_IDX (offset);
909 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
910 && SYMBOLP (PER_BUFFER_SYMBOL (offset))
911 && EQ (PER_BUFFER_SYMBOL (offset), variable))
912 {
913 result = PER_BUFFER_VALUE (buf, offset);
914 found = 1;
915 break;
916 }
917 }
918
919 if (!found)
920 result = Fdefault_value (variable);
921 }
922 else
923 {
924 Lisp_Object valcontents;
925 Lisp_Object current_alist_element;
926
927 /* What binding is loaded right now? */
928 valcontents = SYMBOL_VALUE (variable);
929 current_alist_element
930 = XCAR (XBUFFER_LOCAL_VALUE (valcontents)->cdr);
931
932 /* The value of the currently loaded binding is not
933 stored in it, but rather in the realvalue slot.
934 Store that value into the binding it belongs to
935 in case that is the one we are about to use. */
936
937 Fsetcdr (current_alist_element,
938 do_symval_forwarding (XBUFFER_LOCAL_VALUE (valcontents)->realvalue));
939
940 /* Now get the (perhaps updated) value out of the binding. */
941 result = XCDR (result);
942 }
943
944 if (!EQ (result, Qunbound))
945 return result;
946
947 xsignal1 (Qvoid_variable, variable);
948 }
949
950 /* Return an alist of the Lisp-level buffer-local bindings of
951 buffer BUF. That is, don't include the variables maintained
952 in special slots in the buffer object. */
953
954 static Lisp_Object
955 buffer_lisp_local_variables (buf)
956 struct buffer *buf;
957 {
958 Lisp_Object result = Qnil;
959 register Lisp_Object tail;
960 for (tail = buf->local_var_alist; CONSP (tail); tail = XCDR (tail))
961 {
962 Lisp_Object val, elt;
963
964 elt = XCAR (tail);
965
966 /* Reference each variable in the alist in buf.
967 If inquiring about the current buffer, this gets the current values,
968 so store them into the alist so the alist is up to date.
969 If inquiring about some other buffer, this swaps out any values
970 for that buffer, making the alist up to date automatically. */
971 val = find_symbol_value (XCAR (elt));
972 /* Use the current buffer value only if buf is the current buffer. */
973 if (buf != current_buffer)
974 val = XCDR (elt);
975
976 /* If symbol is unbound, put just the symbol in the list. */
977 if (EQ (val, Qunbound))
978 result = Fcons (XCAR (elt), result);
979 /* Otherwise, put (symbol . value) in the list. */
980 else
981 result = Fcons (Fcons (XCAR (elt), val), result);
982 }
983
984 return result;
985 }
986
987 DEFUN ("buffer-local-variables", Fbuffer_local_variables,
988 Sbuffer_local_variables, 0, 1, 0,
989 doc: /* Return an alist of variables that are buffer-local in BUFFER.
990 Most elements look like (SYMBOL . VALUE), describing one variable.
991 For a symbol that is locally unbound, just the symbol appears in the value.
992 Note that storing new VALUEs in these elements doesn't change the variables.
993 No argument or nil as argument means use current buffer as BUFFER. */)
994 (buffer)
995 register Lisp_Object buffer;
996 {
997 register struct buffer *buf;
998 register Lisp_Object result;
999
1000 if (NILP (buffer))
1001 buf = current_buffer;
1002 else
1003 {
1004 CHECK_BUFFER (buffer);
1005 buf = XBUFFER (buffer);
1006 }
1007
1008 result = buffer_lisp_local_variables (buf);
1009
1010 /* Add on all the variables stored in special slots. */
1011 {
1012 int offset, idx;
1013
1014 for (offset = PER_BUFFER_VAR_OFFSET (name);
1015 offset < sizeof (struct buffer);
1016 /* sizeof EMACS_INT == sizeof Lisp_Object */
1017 offset += (sizeof (EMACS_INT)))
1018 {
1019 idx = PER_BUFFER_IDX (offset);
1020 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
1021 && SYMBOLP (PER_BUFFER_SYMBOL (offset)))
1022 result = Fcons (Fcons (PER_BUFFER_SYMBOL (offset),
1023 PER_BUFFER_VALUE (buf, offset)),
1024 result);
1025 }
1026 }
1027
1028 return result;
1029 }
1030 \f
1031 DEFUN ("buffer-modified-p", Fbuffer_modified_p, Sbuffer_modified_p,
1032 0, 1, 0,
1033 doc: /* Return t if BUFFER was modified since its file was last read or saved.
1034 No argument or nil as argument means use current buffer as BUFFER. */)
1035 (buffer)
1036 register Lisp_Object buffer;
1037 {
1038 register struct buffer *buf;
1039 if (NILP (buffer))
1040 buf = current_buffer;
1041 else
1042 {
1043 CHECK_BUFFER (buffer);
1044 buf = XBUFFER (buffer);
1045 }
1046
1047 return BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf) ? Qt : Qnil;
1048 }
1049
1050 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p, Sset_buffer_modified_p,
1051 1, 1, 0,
1052 doc: /* Mark current buffer as modified or unmodified according to FLAG.
1053 A non-nil FLAG means mark the buffer modified. */)
1054 (flag)
1055 register Lisp_Object flag;
1056 {
1057 register int already;
1058 register Lisp_Object fn;
1059 Lisp_Object buffer, window;
1060
1061 #ifdef CLASH_DETECTION
1062 /* If buffer becoming modified, lock the file.
1063 If buffer becoming unmodified, unlock the file. */
1064
1065 fn = current_buffer->file_truename;
1066 /* Test buffer-file-name so that binding it to nil is effective. */
1067 if (!NILP (fn) && ! NILP (current_buffer->filename))
1068 {
1069 already = SAVE_MODIFF < MODIFF;
1070 if (!already && !NILP (flag))
1071 lock_file (fn);
1072 else if (already && NILP (flag))
1073 unlock_file (fn);
1074 }
1075 #endif /* CLASH_DETECTION */
1076
1077 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1078
1079 /* Set update_mode_lines only if buffer is displayed in some window.
1080 Packages like jit-lock or lazy-lock preserve a buffer's modified
1081 state by recording/restoring the state around blocks of code.
1082 Setting update_mode_lines makes redisplay consider all windows
1083 (on all frames). Stealth fontification of buffers not displayed
1084 would incur additional redisplay costs if we'd set
1085 update_modes_lines unconditionally.
1086
1087 Ideally, I think there should be another mechanism for fontifying
1088 buffers without "modifying" buffers, or redisplay should be
1089 smarter about updating the `*' in mode lines. --gerd */
1090 XSETBUFFER (buffer, current_buffer);
1091 window = Fget_buffer_window (buffer, Qt);
1092 if (WINDOWP (window))
1093 {
1094 ++update_mode_lines;
1095 current_buffer->prevent_redisplay_optimizations_p = 1;
1096 }
1097
1098 return flag;
1099 }
1100
1101 DEFUN ("restore-buffer-modified-p", Frestore_buffer_modified_p,
1102 Srestore_buffer_modified_p, 1, 1, 0,
1103 doc: /* Like `set-buffer-modified-p', with a difference concerning redisplay.
1104 It is not ensured that mode lines will be updated to show the modified
1105 state of the current buffer. Use with care. */)
1106 (flag)
1107 Lisp_Object flag;
1108 {
1109 #ifdef CLASH_DETECTION
1110 Lisp_Object fn;
1111
1112 /* If buffer becoming modified, lock the file.
1113 If buffer becoming unmodified, unlock the file. */
1114
1115 fn = current_buffer->file_truename;
1116 /* Test buffer-file-name so that binding it to nil is effective. */
1117 if (!NILP (fn) && ! NILP (current_buffer->filename))
1118 {
1119 int already = SAVE_MODIFF < MODIFF;
1120 if (!already && !NILP (flag))
1121 lock_file (fn);
1122 else if (already && NILP (flag))
1123 unlock_file (fn);
1124 }
1125 #endif /* CLASH_DETECTION */
1126
1127 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1128 return flag;
1129 }
1130
1131 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick, Sbuffer_modified_tick,
1132 0, 1, 0,
1133 doc: /* Return BUFFER's tick counter, incremented for each change in text.
1134 Each buffer has a tick counter which is incremented each time the
1135 text in that buffer is changed. It wraps around occasionally.
1136 No argument or nil as argument means use current buffer as BUFFER. */)
1137 (buffer)
1138 register Lisp_Object buffer;
1139 {
1140 register struct buffer *buf;
1141 if (NILP (buffer))
1142 buf = current_buffer;
1143 else
1144 {
1145 CHECK_BUFFER (buffer);
1146 buf = XBUFFER (buffer);
1147 }
1148
1149 return make_number (BUF_MODIFF (buf));
1150 }
1151
1152 DEFUN ("buffer-chars-modified-tick", Fbuffer_chars_modified_tick,
1153 Sbuffer_chars_modified_tick, 0, 1, 0,
1154 doc: /* Return BUFFER's character-change tick counter.
1155 Each buffer has a character-change tick counter, which is set to the
1156 value of the buffer's tick counter \(see `buffer-modified-tick'), each
1157 time text in that buffer is inserted or deleted. By comparing the
1158 values returned by two individual calls of `buffer-chars-modified-tick',
1159 you can tell whether a character change occurred in that buffer in
1160 between these calls. No argument or nil as argument means use current
1161 buffer as BUFFER. */)
1162 (buffer)
1163 register Lisp_Object buffer;
1164 {
1165 register struct buffer *buf;
1166 if (NILP (buffer))
1167 buf = current_buffer;
1168 else
1169 {
1170 CHECK_BUFFER (buffer);
1171 buf = XBUFFER (buffer);
1172 }
1173
1174 return make_number (BUF_CHARS_MODIFF (buf));
1175 }
1176 \f
1177 DEFUN ("rename-buffer", Frename_buffer, Srename_buffer, 1, 2,
1178 "sRename buffer (to new name): \nP",
1179 doc: /* Change current buffer's name to NEWNAME (a string).
1180 If second arg UNIQUE is nil or omitted, it is an error if a
1181 buffer named NEWNAME already exists.
1182 If UNIQUE is non-nil, come up with a new name using
1183 `generate-new-buffer-name'.
1184 Interactively, you can set UNIQUE with a prefix argument.
1185 We return the name we actually gave the buffer.
1186 This does not change the name of the visited file (if any). */)
1187 (newname, unique)
1188 register Lisp_Object newname, unique;
1189 {
1190 register Lisp_Object tem, buf;
1191
1192 CHECK_STRING (newname);
1193
1194 if (SCHARS (newname) == 0)
1195 error ("Empty string is invalid as a buffer name");
1196
1197 tem = Fget_buffer (newname);
1198 if (!NILP (tem))
1199 {
1200 /* Don't short-circuit if UNIQUE is t. That is a useful way to
1201 rename the buffer automatically so you can create another
1202 with the original name. It makes UNIQUE equivalent to
1203 (rename-buffer (generate-new-buffer-name NEWNAME)). */
1204 if (NILP (unique) && XBUFFER (tem) == current_buffer)
1205 return current_buffer->name;
1206 if (!NILP (unique))
1207 newname = Fgenerate_new_buffer_name (newname, current_buffer->name);
1208 else
1209 error ("Buffer name `%s' is in use", SDATA (newname));
1210 }
1211
1212 current_buffer->name = newname;
1213
1214 /* Catch redisplay's attention. Unless we do this, the mode lines for
1215 any windows displaying current_buffer will stay unchanged. */
1216 update_mode_lines++;
1217
1218 XSETBUFFER (buf, current_buffer);
1219 Fsetcar (Frassq (buf, Vbuffer_alist), newname);
1220 if (NILP (current_buffer->filename)
1221 && !NILP (current_buffer->auto_save_file_name))
1222 call0 (intern ("rename-auto-save-file"));
1223 /* Refetch since that last call may have done GC. */
1224 return current_buffer->name;
1225 }
1226
1227 DEFUN ("other-buffer", Fother_buffer, Sother_buffer, 0, 3, 0,
1228 doc: /* Return most recently selected buffer other than BUFFER.
1229 Buffers not visible in windows are preferred to visible buffers,
1230 unless optional second argument VISIBLE-OK is non-nil.
1231 If the optional third argument FRAME is non-nil, use that frame's
1232 buffer list instead of the selected frame's buffer list.
1233 If no other buffer exists, the buffer `*scratch*' is returned.
1234 If BUFFER is omitted or nil, some interesting buffer is returned. */)
1235 (buffer, visible_ok, frame)
1236 register Lisp_Object buffer, visible_ok, frame;
1237 {
1238 Lisp_Object Fset_buffer_major_mode ();
1239 register Lisp_Object tail, buf, notsogood, tem, pred, add_ons;
1240 notsogood = Qnil;
1241
1242 if (NILP (frame))
1243 frame = selected_frame;
1244
1245 tail = Vbuffer_alist;
1246 pred = frame_buffer_predicate (frame);
1247
1248 /* Consider buffers that have been seen in the selected frame
1249 before other buffers. */
1250
1251 tem = frame_buffer_list (frame);
1252 add_ons = Qnil;
1253 while (CONSP (tem))
1254 {
1255 if (BUFFERP (XCAR (tem)))
1256 add_ons = Fcons (Fcons (Qnil, XCAR (tem)), add_ons);
1257 tem = XCDR (tem);
1258 }
1259 tail = nconc2 (Fnreverse (add_ons), tail);
1260
1261 for (; CONSP (tail); tail = XCDR (tail))
1262 {
1263 buf = Fcdr (XCAR (tail));
1264 if (EQ (buf, buffer))
1265 continue;
1266 if (NILP (buf))
1267 continue;
1268 if (NILP (XBUFFER (buf)->name))
1269 continue;
1270 if (SREF (XBUFFER (buf)->name, 0) == ' ')
1271 continue;
1272 /* If the selected frame has a buffer_predicate,
1273 disregard buffers that don't fit the predicate. */
1274 if (!NILP (pred))
1275 {
1276 tem = call1 (pred, buf);
1277 if (NILP (tem))
1278 continue;
1279 }
1280
1281 if (NILP (visible_ok))
1282 tem = Fget_buffer_window (buf, Qvisible);
1283 else
1284 tem = Qnil;
1285 if (NILP (tem))
1286 return buf;
1287 if (NILP (notsogood))
1288 notsogood = buf;
1289 }
1290 if (!NILP (notsogood))
1291 return notsogood;
1292 buf = Fget_buffer (build_string ("*scratch*"));
1293 if (NILP (buf))
1294 {
1295 buf = Fget_buffer_create (build_string ("*scratch*"));
1296 Fset_buffer_major_mode (buf);
1297 }
1298 return buf;
1299 }
1300 \f
1301 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo, Sbuffer_enable_undo,
1302 0, 1, "",
1303 doc: /* Start keeping undo information for buffer BUFFER.
1304 No argument or nil as argument means do this for the current buffer. */)
1305 (buffer)
1306 register Lisp_Object buffer;
1307 {
1308 Lisp_Object real_buffer;
1309
1310 if (NILP (buffer))
1311 XSETBUFFER (real_buffer, current_buffer);
1312 else
1313 {
1314 real_buffer = Fget_buffer (buffer);
1315 if (NILP (real_buffer))
1316 nsberror (buffer);
1317 }
1318
1319 if (EQ (XBUFFER (real_buffer)->undo_list, Qt))
1320 XBUFFER (real_buffer)->undo_list = Qnil;
1321
1322 return Qnil;
1323 }
1324
1325 /*
1326 DEFVAR_LISP ("kill-buffer-hook", no_cell, "\
1327 Hook to be run (by `run-hooks', which see) when a buffer is killed.\n\
1328 The buffer being killed will be current while the hook is running.\n\
1329 See `kill-buffer'."
1330 */
1331 DEFUN ("kill-buffer", Fkill_buffer, Skill_buffer, 1, 1, "bKill buffer: ",
1332 doc: /* Kill the buffer BUFFER.
1333 The argument may be a buffer or the name of a buffer.
1334 With a nil argument, kill the current buffer.
1335
1336 Value is t if the buffer is actually killed, nil otherwise.
1337
1338 The functions in `kill-buffer-query-functions' are called with BUFFER as
1339 the current buffer. If any of them returns nil, the buffer is not killed.
1340
1341 The hook `kill-buffer-hook' is run before the buffer is actually killed.
1342 The buffer being killed will be current while the hook is running.
1343
1344 Any processes that have this buffer as the `process-buffer' are killed
1345 with SIGHUP. */)
1346 (buffer)
1347 Lisp_Object buffer;
1348 {
1349 Lisp_Object buf;
1350 register struct buffer *b;
1351 register Lisp_Object tem;
1352 register struct Lisp_Marker *m;
1353 struct gcpro gcpro1;
1354
1355 if (NILP (buffer))
1356 buf = Fcurrent_buffer ();
1357 else
1358 buf = Fget_buffer (buffer);
1359 if (NILP (buf))
1360 nsberror (buffer);
1361
1362 b = XBUFFER (buf);
1363
1364 /* Avoid trouble for buffer already dead. */
1365 if (NILP (b->name))
1366 return Qnil;
1367
1368 /* Query if the buffer is still modified. */
1369 if (INTERACTIVE && !NILP (b->filename)
1370 && BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
1371 {
1372 GCPRO1 (buf);
1373 tem = do_yes_or_no_p (format2 ("Buffer %s modified; kill anyway? ",
1374 b->name, make_number (0)));
1375 UNGCPRO;
1376 if (NILP (tem))
1377 return Qnil;
1378 }
1379
1380 /* Run hooks with the buffer to be killed the current buffer. */
1381 {
1382 int count = SPECPDL_INDEX ();
1383 Lisp_Object arglist[1];
1384
1385 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1386 set_buffer_internal (b);
1387
1388 /* First run the query functions; if any query is answered no,
1389 don't kill the buffer. */
1390 arglist[0] = Qkill_buffer_query_functions;
1391 tem = Frun_hook_with_args_until_failure (1, arglist);
1392 if (NILP (tem))
1393 return unbind_to (count, Qnil);
1394
1395 /* Then run the hooks. */
1396 Frun_hooks (1, &Qkill_buffer_hook);
1397 unbind_to (count, Qnil);
1398 }
1399
1400 /* We have no more questions to ask. Verify that it is valid
1401 to kill the buffer. This must be done after the questions
1402 since anything can happen within do_yes_or_no_p. */
1403
1404 /* Don't kill the minibuffer now current. */
1405 if (EQ (buf, XWINDOW (minibuf_window)->buffer))
1406 return Qnil;
1407
1408 if (NILP (b->name))
1409 return Qnil;
1410
1411 /* When we kill a base buffer, kill all its indirect buffers.
1412 We do it at this stage so nothing terrible happens if they
1413 ask questions or their hooks get errors. */
1414 if (! b->base_buffer)
1415 {
1416 struct buffer *other;
1417
1418 GCPRO1 (buf);
1419
1420 for (other = all_buffers; other; other = other->next)
1421 /* all_buffers contains dead buffers too;
1422 don't re-kill them. */
1423 if (other->base_buffer == b && !NILP (other->name))
1424 {
1425 Lisp_Object buf;
1426 XSETBUFFER (buf, other);
1427 Fkill_buffer (buf);
1428 }
1429
1430 UNGCPRO;
1431 }
1432
1433 /* Make this buffer not be current.
1434 In the process, notice if this is the sole visible buffer
1435 and give up if so. */
1436 if (b == current_buffer)
1437 {
1438 tem = Fother_buffer (buf, Qnil, Qnil);
1439 Fset_buffer (tem);
1440 if (b == current_buffer)
1441 return Qnil;
1442 }
1443
1444 /* Notice if the buffer to kill is the sole visible buffer
1445 when we're currently in the mini-buffer, and give up if so. */
1446 XSETBUFFER (tem, current_buffer);
1447 if (EQ (tem, XWINDOW (minibuf_window)->buffer))
1448 {
1449 tem = Fother_buffer (buf, Qnil, Qnil);
1450 if (EQ (buf, tem))
1451 return Qnil;
1452 }
1453
1454 /* Now there is no question: we can kill the buffer. */
1455
1456 #ifdef CLASH_DETECTION
1457 /* Unlock this buffer's file, if it is locked. */
1458 unlock_buffer (b);
1459 #endif /* CLASH_DETECTION */
1460
1461 kill_buffer_processes (buf);
1462 clear_charpos_cache (b);
1463
1464 tem = Vinhibit_quit;
1465 Vinhibit_quit = Qt;
1466 replace_buffer_in_all_windows (buf);
1467 Vbuffer_alist = Fdelq (Frassq (buf, Vbuffer_alist), Vbuffer_alist);
1468 frames_discard_buffer (buf);
1469 Vinhibit_quit = tem;
1470
1471 /* Delete any auto-save file, if we saved it in this session.
1472 But not if the buffer is modified. */
1473 if (STRINGP (b->auto_save_file_name)
1474 && b->auto_save_modified != 0
1475 && BUF_SAVE_MODIFF (b) < b->auto_save_modified
1476 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
1477 && NILP (Fsymbol_value (intern ("auto-save-visited-file-name"))))
1478 {
1479 Lisp_Object tem;
1480 tem = Fsymbol_value (intern ("delete-auto-save-files"));
1481 if (! NILP (tem))
1482 internal_delete_file (b->auto_save_file_name);
1483 }
1484
1485 if (b->base_buffer)
1486 {
1487 /* Unchain all markers that belong to this indirect buffer.
1488 Don't unchain the markers that belong to the base buffer
1489 or its other indirect buffers. */
1490 for (m = BUF_MARKERS (b); m; )
1491 {
1492 struct Lisp_Marker *next = m->next;
1493 if (m->buffer == b)
1494 unchain_marker (m);
1495 m = next;
1496 }
1497 }
1498 else
1499 {
1500 /* Unchain all markers of this buffer and its indirect buffers.
1501 and leave them pointing nowhere. */
1502 for (m = BUF_MARKERS (b); m; )
1503 {
1504 struct Lisp_Marker *next = m->next;
1505 m->buffer = 0;
1506 m->next = NULL;
1507 m = next;
1508 }
1509 BUF_MARKERS (b) = NULL;
1510 BUF_INTERVALS (b) = NULL_INTERVAL;
1511
1512 /* Perhaps we should explicitly free the interval tree here... */
1513 }
1514
1515 /* Reset the local variables, so that this buffer's local values
1516 won't be protected from GC. They would be protected
1517 if they happened to remain encached in their symbols.
1518 This gets rid of them for certain. */
1519 swap_out_buffer_local_variables (b);
1520 reset_buffer_local_variables (b, 1);
1521
1522 b->name = Qnil;
1523
1524 BLOCK_INPUT;
1525 if (! b->base_buffer)
1526 free_buffer_text (b);
1527
1528 if (b->newline_cache)
1529 {
1530 free_region_cache (b->newline_cache);
1531 b->newline_cache = 0;
1532 }
1533 if (b->width_run_cache)
1534 {
1535 free_region_cache (b->width_run_cache);
1536 b->width_run_cache = 0;
1537 }
1538 b->width_table = Qnil;
1539 UNBLOCK_INPUT;
1540 b->undo_list = Qnil;
1541
1542 return Qt;
1543 }
1544 \f
1545 /* Move the assoc for buffer BUF to the front of buffer-alist. Since
1546 we do this each time BUF is selected visibly, the more recently
1547 selected buffers are always closer to the front of the list. This
1548 means that other_buffer is more likely to choose a relevant buffer. */
1549
1550 void
1551 record_buffer (buf)
1552 Lisp_Object buf;
1553 {
1554 register Lisp_Object link, prev;
1555 Lisp_Object frame;
1556 frame = selected_frame;
1557
1558 prev = Qnil;
1559 for (link = Vbuffer_alist; CONSP (link); link = XCDR (link))
1560 {
1561 if (EQ (XCDR (XCAR (link)), buf))
1562 break;
1563 prev = link;
1564 }
1565
1566 /* Effectively do Vbuffer_alist = Fdelq (link, Vbuffer_alist);
1567 we cannot use Fdelq itself here because it allows quitting. */
1568
1569 if (NILP (prev))
1570 Vbuffer_alist = XCDR (Vbuffer_alist);
1571 else
1572 XSETCDR (prev, XCDR (XCDR (prev)));
1573
1574 XSETCDR (link, Vbuffer_alist);
1575 Vbuffer_alist = link;
1576
1577 /* Now move this buffer to the front of frame_buffer_list also. */
1578
1579 prev = Qnil;
1580 for (link = frame_buffer_list (frame); CONSP (link);
1581 link = XCDR (link))
1582 {
1583 if (EQ (XCAR (link), buf))
1584 break;
1585 prev = link;
1586 }
1587
1588 /* Effectively do delq. */
1589
1590 if (CONSP (link))
1591 {
1592 if (NILP (prev))
1593 set_frame_buffer_list (frame,
1594 XCDR (frame_buffer_list (frame)));
1595 else
1596 XSETCDR (prev, XCDR (XCDR (prev)));
1597
1598 XSETCDR (link, frame_buffer_list (frame));
1599 set_frame_buffer_list (frame, link);
1600 }
1601 else
1602 set_frame_buffer_list (frame, Fcons (buf, frame_buffer_list (frame)));
1603 }
1604
1605 DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode, Sset_buffer_major_mode, 1, 1, 0,
1606 doc: /* Set an appropriate major mode for BUFFER.
1607 For the *scratch* buffer, use `initial-major-mode', otherwise choose a mode
1608 according to `default-major-mode'.
1609 Use this function before selecting the buffer, since it may need to inspect
1610 the current buffer's major mode. */)
1611 (buffer)
1612 Lisp_Object buffer;
1613 {
1614 int count;
1615 Lisp_Object function;
1616
1617 CHECK_BUFFER (buffer);
1618
1619 if (STRINGP (XBUFFER (buffer)->name)
1620 && strcmp (SDATA (XBUFFER (buffer)->name), "*scratch*") == 0)
1621 function = find_symbol_value (intern ("initial-major-mode"));
1622 else
1623 {
1624 function = buffer_defaults.major_mode;
1625 if (NILP (function)
1626 && NILP (Fget (current_buffer->major_mode, Qmode_class)))
1627 function = current_buffer->major_mode;
1628 }
1629
1630 if (NILP (function) || EQ (function, Qfundamental_mode))
1631 return Qnil;
1632
1633 count = SPECPDL_INDEX ();
1634
1635 /* To select a nonfundamental mode,
1636 select the buffer temporarily and then call the mode function. */
1637
1638 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1639
1640 Fset_buffer (buffer);
1641 call0 (function);
1642
1643 return unbind_to (count, Qnil);
1644 }
1645
1646 /* If switching buffers in WINDOW would be an error, return
1647 a C string saying what the error would be. */
1648
1649 char *
1650 no_switch_window (window)
1651 Lisp_Object window;
1652 {
1653 Lisp_Object tem;
1654 if (EQ (minibuf_window, window))
1655 return "Cannot switch buffers in minibuffer window";
1656 tem = Fwindow_dedicated_p (window);
1657 if (EQ (tem, Qt))
1658 return "Cannot switch buffers in a dedicated window";
1659 return NULL;
1660 }
1661
1662 /* Switch to buffer BUFFER in the selected window.
1663 If NORECORD is non-nil, don't call record_buffer. */
1664
1665 Lisp_Object
1666 switch_to_buffer_1 (buffer, norecord)
1667 Lisp_Object buffer, norecord;
1668 {
1669 register Lisp_Object buf;
1670
1671 if (NILP (buffer))
1672 buf = Fother_buffer (Fcurrent_buffer (), Qnil, Qnil);
1673 else
1674 {
1675 buf = Fget_buffer (buffer);
1676 if (NILP (buf))
1677 {
1678 buf = Fget_buffer_create (buffer);
1679 Fset_buffer_major_mode (buf);
1680 }
1681 }
1682 Fset_buffer (buf);
1683 if (NILP (norecord))
1684 record_buffer (buf);
1685
1686 Fset_window_buffer (EQ (selected_window, minibuf_window)
1687 ? Fnext_window (minibuf_window, Qnil, Qnil)
1688 : selected_window,
1689 buf, Qnil);
1690
1691 return buf;
1692 }
1693
1694 DEFUN ("switch-to-buffer", Fswitch_to_buffer, Sswitch_to_buffer, 1, 2, "BSwitch to buffer: ",
1695 doc: /* Select buffer BUFFER in the current window.
1696 If BUFFER does not identify an existing buffer,
1697 then this function creates a buffer with that name.
1698
1699 When called from Lisp, BUFFER may be a buffer, a string \(a buffer name),
1700 or nil. If BUFFER is nil, then this function chooses a buffer
1701 using `other-buffer'.
1702 Optional second arg NORECORD non-nil means
1703 do not put this buffer at the front of the list of recently selected ones.
1704 This function returns the buffer it switched to.
1705
1706 WARNING: This is NOT the way to work on another buffer temporarily
1707 within a Lisp program! Use `set-buffer' instead. That avoids messing with
1708 the window-buffer correspondences. */)
1709 (buffer, norecord)
1710 Lisp_Object buffer, norecord;
1711 {
1712 char *err;
1713
1714 if (EQ (buffer, Fwindow_buffer (selected_window)))
1715 {
1716 /* Basically a NOP. Avoid signalling an error in the case where
1717 the selected window is dedicated, or a minibuffer. */
1718
1719 /* But do put this buffer at the front of the buffer list,
1720 unless that has been inhibited. Note that even if
1721 BUFFER is at the front of the main buffer-list already,
1722 we still want to move it to the front of the frame's buffer list. */
1723 if (NILP (norecord))
1724 record_buffer (buffer);
1725 return Fset_buffer (buffer);
1726 }
1727
1728 err = no_switch_window (selected_window);
1729 if (err) error (err);
1730
1731 return switch_to_buffer_1 (buffer, norecord);
1732 }
1733
1734 DEFUN ("pop-to-buffer", Fpop_to_buffer, Spop_to_buffer, 1, 3, 0,
1735 doc: /* Select buffer BUFFER in some window, preferably a different one.
1736 BUFFER may be a buffer, a string \(a buffer name), or nil.
1737 If BUFFER is a string which is not the name of an existing buffer,
1738 then this function creates a buffer with that name.
1739 If BUFFER is nil, then it chooses some other buffer.
1740 If `pop-up-windows' is non-nil, windows can be split to do this.
1741 If optional second arg OTHER-WINDOW is non-nil, insist on finding another
1742 window even if BUFFER is already visible in the selected window,
1743 and ignore `same-window-regexps' and `same-window-buffer-names'.
1744 This function returns the buffer it switched to.
1745 This uses the function `display-buffer' as a subroutine; see the documentation
1746 of `display-buffer' for additional customization information.
1747
1748 Optional third arg NORECORD non-nil means
1749 do not put this buffer at the front of the list of recently selected ones. */)
1750 (buffer, other_window, norecord)
1751 Lisp_Object buffer, other_window, norecord;
1752 {
1753 register Lisp_Object buf;
1754 if (NILP (buffer))
1755 buf = Fother_buffer (Fcurrent_buffer (), Qnil, Qnil);
1756 else
1757 {
1758 buf = Fget_buffer (buffer);
1759 if (NILP (buf))
1760 {
1761 buf = Fget_buffer_create (buffer);
1762 Fset_buffer_major_mode (buf);
1763 }
1764 }
1765 Fset_buffer (buf);
1766 Fselect_window (Fdisplay_buffer (buf, other_window, Qnil), norecord);
1767 return buf;
1768 }
1769
1770 DEFUN ("current-buffer", Fcurrent_buffer, Scurrent_buffer, 0, 0, 0,
1771 doc: /* Return the current buffer as a Lisp object. */)
1772 ()
1773 {
1774 register Lisp_Object buf;
1775 XSETBUFFER (buf, current_buffer);
1776 return buf;
1777 }
1778 \f
1779 /* Set the current buffer to B.
1780
1781 We previously set windows_or_buffers_changed here to invalidate
1782 global unchanged information in beg_unchanged and end_unchanged.
1783 This is no longer necessary because we now compute unchanged
1784 information on a buffer-basis. Every action affecting other
1785 windows than the selected one requires a select_window at some
1786 time, and that increments windows_or_buffers_changed. */
1787
1788 void
1789 set_buffer_internal (b)
1790 register struct buffer *b;
1791 {
1792 if (current_buffer != b)
1793 set_buffer_internal_1 (b);
1794 }
1795
1796 /* Set the current buffer to B, and do not set windows_or_buffers_changed.
1797 This is used by redisplay. */
1798
1799 void
1800 set_buffer_internal_1 (b)
1801 register struct buffer *b;
1802 {
1803 register struct buffer *old_buf;
1804 register Lisp_Object tail, valcontents;
1805 Lisp_Object tem;
1806
1807 #ifdef USE_MMAP_FOR_BUFFERS
1808 if (b->text->beg == NULL)
1809 enlarge_buffer_text (b, 0);
1810 #endif /* USE_MMAP_FOR_BUFFERS */
1811
1812 if (current_buffer == b)
1813 return;
1814
1815 old_buf = current_buffer;
1816 current_buffer = b;
1817 last_known_column_point = -1; /* invalidate indentation cache */
1818
1819 if (old_buf)
1820 {
1821 /* Put the undo list back in the base buffer, so that it appears
1822 that an indirect buffer shares the undo list of its base. */
1823 if (old_buf->base_buffer)
1824 old_buf->base_buffer->undo_list = old_buf->undo_list;
1825
1826 /* If the old current buffer has markers to record PT, BEGV and ZV
1827 when it is not current, update them now. */
1828 if (! NILP (old_buf->pt_marker))
1829 {
1830 Lisp_Object obuf;
1831 XSETBUFFER (obuf, old_buf);
1832 set_marker_both (old_buf->pt_marker, obuf,
1833 BUF_PT (old_buf), BUF_PT_BYTE (old_buf));
1834 }
1835 if (! NILP (old_buf->begv_marker))
1836 {
1837 Lisp_Object obuf;
1838 XSETBUFFER (obuf, old_buf);
1839 set_marker_both (old_buf->begv_marker, obuf,
1840 BUF_BEGV (old_buf), BUF_BEGV_BYTE (old_buf));
1841 }
1842 if (! NILP (old_buf->zv_marker))
1843 {
1844 Lisp_Object obuf;
1845 XSETBUFFER (obuf, old_buf);
1846 set_marker_both (old_buf->zv_marker, obuf,
1847 BUF_ZV (old_buf), BUF_ZV_BYTE (old_buf));
1848 }
1849 }
1850
1851 /* Get the undo list from the base buffer, so that it appears
1852 that an indirect buffer shares the undo list of its base. */
1853 if (b->base_buffer)
1854 b->undo_list = b->base_buffer->undo_list;
1855
1856 /* If the new current buffer has markers to record PT, BEGV and ZV
1857 when it is not current, fetch them now. */
1858 if (! NILP (b->pt_marker))
1859 {
1860 BUF_PT (b) = marker_position (b->pt_marker);
1861 BUF_PT_BYTE (b) = marker_byte_position (b->pt_marker);
1862 }
1863 if (! NILP (b->begv_marker))
1864 {
1865 BUF_BEGV (b) = marker_position (b->begv_marker);
1866 BUF_BEGV_BYTE (b) = marker_byte_position (b->begv_marker);
1867 }
1868 if (! NILP (b->zv_marker))
1869 {
1870 BUF_ZV (b) = marker_position (b->zv_marker);
1871 BUF_ZV_BYTE (b) = marker_byte_position (b->zv_marker);
1872 }
1873
1874 /* Look down buffer's list of local Lisp variables
1875 to find and update any that forward into C variables. */
1876
1877 for (tail = b->local_var_alist; CONSP (tail); tail = XCDR (tail))
1878 {
1879 valcontents = SYMBOL_VALUE (XCAR (XCAR (tail)));
1880 if ((BUFFER_LOCAL_VALUEP (valcontents)
1881 || SOME_BUFFER_LOCAL_VALUEP (valcontents))
1882 && (tem = XBUFFER_LOCAL_VALUE (valcontents)->realvalue,
1883 (BOOLFWDP (tem) || INTFWDP (tem) || OBJFWDP (tem))))
1884 /* Just reference the variable
1885 to cause it to become set for this buffer. */
1886 Fsymbol_value (XCAR (XCAR (tail)));
1887 }
1888
1889 /* Do the same with any others that were local to the previous buffer */
1890
1891 if (old_buf)
1892 for (tail = old_buf->local_var_alist; CONSP (tail); tail = XCDR (tail))
1893 {
1894 valcontents = SYMBOL_VALUE (XCAR (XCAR (tail)));
1895 if ((BUFFER_LOCAL_VALUEP (valcontents)
1896 || SOME_BUFFER_LOCAL_VALUEP (valcontents))
1897 && (tem = XBUFFER_LOCAL_VALUE (valcontents)->realvalue,
1898 (BOOLFWDP (tem) || INTFWDP (tem) || OBJFWDP (tem))))
1899 /* Just reference the variable
1900 to cause it to become set for this buffer. */
1901 Fsymbol_value (XCAR (XCAR (tail)));
1902 }
1903 }
1904
1905 /* Switch to buffer B temporarily for redisplay purposes.
1906 This avoids certain things that don't need to be done within redisplay. */
1907
1908 void
1909 set_buffer_temp (b)
1910 struct buffer *b;
1911 {
1912 register struct buffer *old_buf;
1913
1914 if (current_buffer == b)
1915 return;
1916
1917 old_buf = current_buffer;
1918 current_buffer = b;
1919
1920 if (old_buf)
1921 {
1922 /* If the old current buffer has markers to record PT, BEGV and ZV
1923 when it is not current, update them now. */
1924 if (! NILP (old_buf->pt_marker))
1925 {
1926 Lisp_Object obuf;
1927 XSETBUFFER (obuf, old_buf);
1928 set_marker_both (old_buf->pt_marker, obuf,
1929 BUF_PT (old_buf), BUF_PT_BYTE (old_buf));
1930 }
1931 if (! NILP (old_buf->begv_marker))
1932 {
1933 Lisp_Object obuf;
1934 XSETBUFFER (obuf, old_buf);
1935 set_marker_both (old_buf->begv_marker, obuf,
1936 BUF_BEGV (old_buf), BUF_BEGV_BYTE (old_buf));
1937 }
1938 if (! NILP (old_buf->zv_marker))
1939 {
1940 Lisp_Object obuf;
1941 XSETBUFFER (obuf, old_buf);
1942 set_marker_both (old_buf->zv_marker, obuf,
1943 BUF_ZV (old_buf), BUF_ZV_BYTE (old_buf));
1944 }
1945 }
1946
1947 /* If the new current buffer has markers to record PT, BEGV and ZV
1948 when it is not current, fetch them now. */
1949 if (! NILP (b->pt_marker))
1950 {
1951 BUF_PT (b) = marker_position (b->pt_marker);
1952 BUF_PT_BYTE (b) = marker_byte_position (b->pt_marker);
1953 }
1954 if (! NILP (b->begv_marker))
1955 {
1956 BUF_BEGV (b) = marker_position (b->begv_marker);
1957 BUF_BEGV_BYTE (b) = marker_byte_position (b->begv_marker);
1958 }
1959 if (! NILP (b->zv_marker))
1960 {
1961 BUF_ZV (b) = marker_position (b->zv_marker);
1962 BUF_ZV_BYTE (b) = marker_byte_position (b->zv_marker);
1963 }
1964 }
1965
1966 DEFUN ("set-buffer", Fset_buffer, Sset_buffer, 1, 1, 0,
1967 doc: /* Make the buffer BUFFER current for editing operations.
1968 BUFFER may be a buffer or the name of an existing buffer.
1969 See also `save-excursion' when you want to make a buffer current temporarily.
1970 This function does not display the buffer, so its effect ends
1971 when the current command terminates.
1972 Use `switch-to-buffer' or `pop-to-buffer' to switch buffers permanently. */)
1973 (buffer)
1974 register Lisp_Object buffer;
1975 {
1976 register Lisp_Object buf;
1977 buf = Fget_buffer (buffer);
1978 if (NILP (buf))
1979 nsberror (buffer);
1980 if (NILP (XBUFFER (buf)->name))
1981 error ("Selecting deleted buffer");
1982 set_buffer_internal (XBUFFER (buf));
1983 return buf;
1984 }
1985
1986 /* Set the current buffer to BUFFER provided it is alive. */
1987
1988 Lisp_Object
1989 set_buffer_if_live (buffer)
1990 Lisp_Object buffer;
1991 {
1992 if (! NILP (XBUFFER (buffer)->name))
1993 Fset_buffer (buffer);
1994 return Qnil;
1995 }
1996 \f
1997 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only,
1998 Sbarf_if_buffer_read_only, 0, 0, 0,
1999 doc: /* Signal a `buffer-read-only' error if the current buffer is read-only. */)
2000 ()
2001 {
2002 if (!NILP (current_buffer->read_only)
2003 && NILP (Vinhibit_read_only))
2004 xsignal1 (Qbuffer_read_only, Fcurrent_buffer ());
2005 return Qnil;
2006 }
2007
2008 DEFUN ("bury-buffer", Fbury_buffer, Sbury_buffer, 0, 1, "",
2009 doc: /* Put BUFFER at the end of the list of all buffers.
2010 There it is the least likely candidate for `other-buffer' to return;
2011 thus, the least likely buffer for \\[switch-to-buffer] to select by default.
2012 You can specify a buffer name as BUFFER, or an actual buffer object.
2013 If BUFFER is nil or omitted, bury the current buffer.
2014 Also, if BUFFER is nil or omitted, remove the current buffer from the
2015 selected window if it is displayed there. */)
2016 (buffer)
2017 register Lisp_Object buffer;
2018 {
2019 /* Figure out what buffer we're going to bury. */
2020 if (NILP (buffer))
2021 {
2022 Lisp_Object tem;
2023 XSETBUFFER (buffer, current_buffer);
2024
2025 tem = Fwindow_buffer (selected_window);
2026 /* If we're burying the current buffer, unshow it. */
2027 if (EQ (buffer, tem))
2028 {
2029 if (NILP (Fwindow_dedicated_p (selected_window)))
2030 Fswitch_to_buffer (Fother_buffer (buffer, Qnil, Qnil), Qnil);
2031 else if (NILP (XWINDOW (selected_window)->parent))
2032 Ficonify_frame (Fwindow_frame (selected_window));
2033 else
2034 Fdelete_window (selected_window);
2035 }
2036 }
2037 else
2038 {
2039 Lisp_Object buf1;
2040
2041 buf1 = Fget_buffer (buffer);
2042 if (NILP (buf1))
2043 nsberror (buffer);
2044 buffer = buf1;
2045 }
2046
2047 /* Move buffer to the end of the buffer list. Do nothing if the
2048 buffer is killed. */
2049 if (!NILP (XBUFFER (buffer)->name))
2050 {
2051 Lisp_Object aelt, link;
2052
2053 aelt = Frassq (buffer, Vbuffer_alist);
2054 link = Fmemq (aelt, Vbuffer_alist);
2055 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
2056 XSETCDR (link, Qnil);
2057 Vbuffer_alist = nconc2 (Vbuffer_alist, link);
2058
2059 /* Removing BUFFER from frame-specific lists
2060 has the effect of putting BUFFER at the end
2061 of the combined list in each frame. */
2062 frames_discard_buffer (buffer);
2063 }
2064
2065 return Qnil;
2066 }
2067 \f
2068 DEFUN ("erase-buffer", Ferase_buffer, Serase_buffer, 0, 0, "*",
2069 doc: /* Delete the entire contents of the current buffer.
2070 Any narrowing restriction in effect (see `narrow-to-region') is removed,
2071 so the buffer is truly empty after this. */)
2072 ()
2073 {
2074 Fwiden ();
2075
2076 del_range (BEG, Z);
2077
2078 current_buffer->last_window_start = 1;
2079 /* Prevent warnings, or suspension of auto saving, that would happen
2080 if future size is less than past size. Use of erase-buffer
2081 implies that the future text is not really related to the past text. */
2082 XSETFASTINT (current_buffer->save_length, 0);
2083 return Qnil;
2084 }
2085
2086 void
2087 validate_region (b, e)
2088 register Lisp_Object *b, *e;
2089 {
2090 CHECK_NUMBER_COERCE_MARKER (*b);
2091 CHECK_NUMBER_COERCE_MARKER (*e);
2092
2093 if (XINT (*b) > XINT (*e))
2094 {
2095 Lisp_Object tem;
2096 tem = *b; *b = *e; *e = tem;
2097 }
2098
2099 if (!(BEGV <= XINT (*b) && XINT (*b) <= XINT (*e)
2100 && XINT (*e) <= ZV))
2101 args_out_of_range (*b, *e);
2102 }
2103 \f
2104 /* Advance BYTE_POS up to a character boundary
2105 and return the adjusted position. */
2106
2107 static int
2108 advance_to_char_boundary (byte_pos)
2109 int byte_pos;
2110 {
2111 int c;
2112
2113 if (byte_pos == BEG)
2114 /* Beginning of buffer is always a character boundary. */
2115 return BEG;
2116
2117 c = FETCH_BYTE (byte_pos);
2118 if (! CHAR_HEAD_P (c))
2119 {
2120 /* We should advance BYTE_POS only when C is a constituent of a
2121 multibyte sequence. */
2122 int orig_byte_pos = byte_pos;
2123
2124 do
2125 {
2126 byte_pos--;
2127 c = FETCH_BYTE (byte_pos);
2128 }
2129 while (! CHAR_HEAD_P (c) && byte_pos > BEG);
2130 INC_POS (byte_pos);
2131 if (byte_pos < orig_byte_pos)
2132 byte_pos = orig_byte_pos;
2133 /* If C is a constituent of a multibyte sequence, BYTE_POS was
2134 surely advance to the correct character boundary. If C is
2135 not, BYTE_POS was unchanged. */
2136 }
2137
2138 return byte_pos;
2139 }
2140
2141 DEFUN ("set-buffer-multibyte", Fset_buffer_multibyte, Sset_buffer_multibyte,
2142 1, 1, 0,
2143 doc: /* Set the multibyte flag of the current buffer to FLAG.
2144 If FLAG is t, this makes the buffer a multibyte buffer.
2145 If FLAG is nil, this makes the buffer a single-byte buffer.
2146 The buffer contents remain unchanged as a sequence of bytes
2147 but the contents viewed as characters do change.
2148 If the multibyte flag was really changed, undo information of the
2149 current buffer is cleared. */)
2150 (flag)
2151 Lisp_Object flag;
2152 {
2153 struct Lisp_Marker *tail, *markers;
2154 struct buffer *other;
2155 int begv, zv;
2156 int narrowed = (BEG != BEGV || Z != ZV);
2157 int modified_p = !NILP (Fbuffer_modified_p (Qnil));
2158 Lisp_Object old_undo = current_buffer->undo_list;
2159 struct gcpro gcpro1;
2160
2161 if (current_buffer->base_buffer)
2162 error ("Cannot do `set-buffer-multibyte' on an indirect buffer");
2163
2164 /* Do nothing if nothing actually changes. */
2165 if (NILP (flag) == NILP (current_buffer->enable_multibyte_characters))
2166 return flag;
2167
2168 GCPRO1 (old_undo);
2169
2170 /* Don't record these buffer changes. We will put a special undo entry
2171 instead. */
2172 current_buffer->undo_list = Qt;
2173
2174 /* If the cached position is for this buffer, clear it out. */
2175 clear_charpos_cache (current_buffer);
2176
2177 if (NILP (flag))
2178 begv = BEGV_BYTE, zv = ZV_BYTE;
2179 else
2180 begv = BEGV, zv = ZV;
2181
2182 if (narrowed)
2183 Fwiden ();
2184
2185 if (NILP (flag))
2186 {
2187 int pos, stop;
2188 unsigned char *p;
2189
2190 /* Do this first, so it can use CHAR_TO_BYTE
2191 to calculate the old correspondences. */
2192 set_intervals_multibyte (0);
2193
2194 current_buffer->enable_multibyte_characters = Qnil;
2195
2196 Z = Z_BYTE;
2197 BEGV = BEGV_BYTE;
2198 ZV = ZV_BYTE;
2199 GPT = GPT_BYTE;
2200 TEMP_SET_PT_BOTH (PT_BYTE, PT_BYTE);
2201
2202
2203 for (tail = BUF_MARKERS (current_buffer); tail; tail = tail->next)
2204 tail->charpos = tail->bytepos;
2205
2206 /* Convert multibyte form of 8-bit characters to unibyte. */
2207 pos = BEG;
2208 stop = GPT;
2209 p = BEG_ADDR;
2210 while (1)
2211 {
2212 int c, bytes;
2213
2214 if (pos == stop)
2215 {
2216 if (pos == Z)
2217 break;
2218 p = GAP_END_ADDR;
2219 stop = Z;
2220 }
2221 if (MULTIBYTE_STR_AS_UNIBYTE_P (p, bytes))
2222 p += bytes, pos += bytes;
2223 else
2224 {
2225 c = STRING_CHAR (p, stop - pos);
2226 /* Delete all bytes for this 8-bit character but the
2227 last one, and change the last one to the charcter
2228 code. */
2229 bytes--;
2230 del_range_2 (pos, pos, pos + bytes, pos + bytes, 0);
2231 p = GAP_END_ADDR;
2232 *p++ = c;
2233 pos++;
2234 if (begv > pos)
2235 begv -= bytes;
2236 if (zv > pos)
2237 zv -= bytes;
2238 stop = Z;
2239 }
2240 }
2241 if (narrowed)
2242 Fnarrow_to_region (make_number (begv), make_number (zv));
2243 }
2244 else
2245 {
2246 int pt = PT;
2247 int pos, stop;
2248 unsigned char *p;
2249
2250 /* Be sure not to have a multibyte sequence striding over the GAP.
2251 Ex: We change this: "...abc\201 _GAP_ \241def..."
2252 to: "...abc _GAP_ \201\241def..." */
2253
2254 if (GPT_BYTE > 1 && GPT_BYTE < Z_BYTE
2255 && ! CHAR_HEAD_P (*(GAP_END_ADDR)))
2256 {
2257 unsigned char *p = GPT_ADDR - 1;
2258
2259 while (! CHAR_HEAD_P (*p) && p > BEG_ADDR) p--;
2260 if (BASE_LEADING_CODE_P (*p))
2261 {
2262 int new_gpt = GPT_BYTE - (GPT_ADDR - p);
2263
2264 move_gap_both (new_gpt, new_gpt);
2265 }
2266 }
2267
2268 /* Make the buffer contents valid as multibyte by converting
2269 8-bit characters to multibyte form. */
2270 pos = BEG;
2271 stop = GPT;
2272 p = BEG_ADDR;
2273 while (1)
2274 {
2275 int bytes;
2276
2277 if (pos == stop)
2278 {
2279 if (pos == Z)
2280 break;
2281 p = GAP_END_ADDR;
2282 stop = Z;
2283 }
2284
2285 if (UNIBYTE_STR_AS_MULTIBYTE_P (p, stop - pos, bytes))
2286 p += bytes, pos += bytes;
2287 else
2288 {
2289 unsigned char tmp[MAX_MULTIBYTE_LENGTH];
2290
2291 bytes = CHAR_STRING (*p, tmp);
2292 *p = tmp[0];
2293 TEMP_SET_PT_BOTH (pos + 1, pos + 1);
2294 bytes--;
2295 insert_1_both (tmp + 1, bytes, bytes, 1, 0, 0);
2296 /* Now the gap is after the just inserted data. */
2297 pos = GPT;
2298 p = GAP_END_ADDR;
2299 if (pos <= begv)
2300 begv += bytes;
2301 if (pos <= zv)
2302 zv += bytes;
2303 if (pos <= pt)
2304 pt += bytes;
2305 stop = Z;
2306 }
2307 }
2308
2309 if (pt != PT)
2310 TEMP_SET_PT (pt);
2311
2312 if (narrowed)
2313 Fnarrow_to_region (make_number (begv), make_number (zv));
2314
2315 /* Do this first, so that chars_in_text asks the right question.
2316 set_intervals_multibyte needs it too. */
2317 current_buffer->enable_multibyte_characters = Qt;
2318
2319 GPT_BYTE = advance_to_char_boundary (GPT_BYTE);
2320 GPT = chars_in_text (BEG_ADDR, GPT_BYTE - BEG_BYTE) + BEG;
2321
2322 Z = chars_in_text (GAP_END_ADDR, Z_BYTE - GPT_BYTE) + GPT;
2323
2324 BEGV_BYTE = advance_to_char_boundary (BEGV_BYTE);
2325 if (BEGV_BYTE > GPT_BYTE)
2326 BEGV = chars_in_text (GAP_END_ADDR, BEGV_BYTE - GPT_BYTE) + GPT;
2327 else
2328 BEGV = chars_in_text (BEG_ADDR, BEGV_BYTE - BEG_BYTE) + BEG;
2329
2330 ZV_BYTE = advance_to_char_boundary (ZV_BYTE);
2331 if (ZV_BYTE > GPT_BYTE)
2332 ZV = chars_in_text (GAP_END_ADDR, ZV_BYTE - GPT_BYTE) + GPT;
2333 else
2334 ZV = chars_in_text (BEG_ADDR, ZV_BYTE - BEG_BYTE) + BEG;
2335
2336 {
2337 int pt_byte = advance_to_char_boundary (PT_BYTE);
2338 int pt;
2339
2340 if (pt_byte > GPT_BYTE)
2341 pt = chars_in_text (GAP_END_ADDR, pt_byte - GPT_BYTE) + GPT;
2342 else
2343 pt = chars_in_text (BEG_ADDR, pt_byte - BEG_BYTE) + BEG;
2344 TEMP_SET_PT_BOTH (pt, pt_byte);
2345 }
2346
2347 tail = markers = BUF_MARKERS (current_buffer);
2348
2349 /* This prevents BYTE_TO_CHAR (that is, buf_bytepos_to_charpos) from
2350 getting confused by the markers that have not yet been updated.
2351 It is also a signal that it should never create a marker. */
2352 BUF_MARKERS (current_buffer) = NULL;
2353
2354 for (; tail; tail = tail->next)
2355 {
2356 tail->bytepos = advance_to_char_boundary (tail->bytepos);
2357 tail->charpos = BYTE_TO_CHAR (tail->bytepos);
2358 }
2359
2360 /* Make sure no markers were put on the chain
2361 while the chain value was incorrect. */
2362 if (BUF_MARKERS (current_buffer))
2363 abort ();
2364
2365 BUF_MARKERS (current_buffer) = markers;
2366
2367 /* Do this last, so it can calculate the new correspondences
2368 between chars and bytes. */
2369 set_intervals_multibyte (1);
2370 }
2371
2372 if (!EQ (old_undo, Qt))
2373 {
2374 /* Represent all the above changes by a special undo entry. */
2375 extern Lisp_Object Qapply;
2376 current_buffer->undo_list = Fcons (list3 (Qapply,
2377 intern ("set-buffer-multibyte"),
2378 NILP (flag) ? Qt : Qnil),
2379 old_undo);
2380 }
2381
2382 UNGCPRO;
2383
2384 /* Changing the multibyteness of a buffer means that all windows
2385 showing that buffer must be updated thoroughly. */
2386 current_buffer->prevent_redisplay_optimizations_p = 1;
2387 ++windows_or_buffers_changed;
2388
2389 /* Copy this buffer's new multibyte status
2390 into all of its indirect buffers. */
2391 for (other = all_buffers; other; other = other->next)
2392 if (other->base_buffer == current_buffer && !NILP (other->name))
2393 {
2394 other->enable_multibyte_characters
2395 = current_buffer->enable_multibyte_characters;
2396 other->prevent_redisplay_optimizations_p = 1;
2397 }
2398
2399 /* Restore the modifiedness of the buffer. */
2400 if (!modified_p && !NILP (Fbuffer_modified_p (Qnil)))
2401 Fset_buffer_modified_p (Qnil);
2402
2403 #ifdef subprocesses
2404 /* Update coding systems of this buffer's process (if any). */
2405 {
2406 Lisp_Object process;
2407
2408 process = Fget_buffer_process (Fcurrent_buffer ());
2409 if (PROCESSP (process))
2410 setup_process_coding_systems (process);
2411 }
2412 #endif /* subprocesses */
2413
2414 return flag;
2415 }
2416 \f
2417 DEFUN ("kill-all-local-variables", Fkill_all_local_variables, Skill_all_local_variables,
2418 0, 0, 0,
2419 doc: /* Switch to Fundamental mode by killing current buffer's local variables.
2420 Most local variable bindings are eliminated so that the default values
2421 become effective once more. Also, the syntax table is set from
2422 `standard-syntax-table', the local keymap is set to nil,
2423 and the abbrev table from `fundamental-mode-abbrev-table'.
2424 This function also forces redisplay of the mode line.
2425
2426 Every function to select a new major mode starts by
2427 calling this function.
2428
2429 As a special exception, local variables whose names have
2430 a non-nil `permanent-local' property are not eliminated by this function.
2431
2432 The first thing this function does is run
2433 the normal hook `change-major-mode-hook'. */)
2434 ()
2435 {
2436 register Lisp_Object alist, sym, tem;
2437 Lisp_Object oalist;
2438
2439 if (!NILP (Vrun_hooks))
2440 call1 (Vrun_hooks, Qchange_major_mode_hook);
2441 oalist = current_buffer->local_var_alist;
2442
2443 /* Make sure none of the bindings in oalist
2444 remain swapped in, in their symbols. */
2445
2446 swap_out_buffer_local_variables (current_buffer);
2447
2448 /* Actually eliminate all local bindings of this buffer. */
2449
2450 reset_buffer_local_variables (current_buffer, 0);
2451
2452 /* Any which are supposed to be permanent,
2453 make local again, with the same values they had. */
2454
2455 for (alist = oalist; !NILP (alist); alist = XCDR (alist))
2456 {
2457 sym = XCAR (XCAR (alist));
2458 tem = Fget (sym, Qpermanent_local);
2459 if (! NILP (tem))
2460 {
2461 Fmake_local_variable (sym);
2462 Fset (sym, XCDR (XCAR (alist)));
2463 }
2464 }
2465
2466 /* Force mode-line redisplay. Useful here because all major mode
2467 commands call this function. */
2468 update_mode_lines++;
2469
2470 return Qnil;
2471 }
2472
2473 /* Make sure no local variables remain set up with buffer B
2474 for their current values. */
2475
2476 static void
2477 swap_out_buffer_local_variables (b)
2478 struct buffer *b;
2479 {
2480 Lisp_Object oalist, alist, sym, tem, buffer;
2481
2482 XSETBUFFER (buffer, b);
2483 oalist = b->local_var_alist;
2484
2485 for (alist = oalist; !NILP (alist); alist = XCDR (alist))
2486 {
2487 sym = XCAR (XCAR (alist));
2488
2489 /* Need not do anything if some other buffer's binding is now encached. */
2490 tem = XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->buffer;
2491 if (BUFFERP (tem) && XBUFFER (tem) == current_buffer)
2492 {
2493 /* Symbol is set up for this buffer's old local value.
2494 Set it up for the current buffer with the default value. */
2495
2496 tem = XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->cdr;
2497 /* Store the symbol's current value into the alist entry
2498 it is currently set up for. This is so that, if the
2499 local is marked permanent, and we make it local again
2500 later in Fkill_all_local_variables, we don't lose the value. */
2501 XSETCDR (XCAR (tem),
2502 do_symval_forwarding (XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->realvalue));
2503 /* Switch to the symbol's default-value alist entry. */
2504 XSETCAR (tem, tem);
2505 /* Mark it as current for buffer B. */
2506 XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->buffer = buffer;
2507 /* Store the current value into any forwarding in the symbol. */
2508 store_symval_forwarding (sym,
2509 XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->realvalue,
2510 XCDR (tem), NULL);
2511 }
2512 }
2513 }
2514 \f
2515 /* Find all the overlays in the current buffer that contain position POS.
2516 Return the number found, and store them in a vector in *VEC_PTR.
2517 Store in *LEN_PTR the size allocated for the vector.
2518 Store in *NEXT_PTR the next position after POS where an overlay starts,
2519 or ZV if there are no more overlays between POS and ZV.
2520 Store in *PREV_PTR the previous position before POS where an overlay ends,
2521 or where an overlay starts which ends at or after POS;
2522 or BEGV if there are no such overlays from BEGV to POS.
2523 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2524
2525 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2526 when this function is called.
2527
2528 If EXTEND is non-zero, we make the vector bigger if necessary.
2529 If EXTEND is zero, we never extend the vector,
2530 and we store only as many overlays as will fit.
2531 But we still return the total number of overlays.
2532
2533 If CHANGE_REQ is true, then any position written into *PREV_PTR or
2534 *NEXT_PTR is guaranteed to be not equal to POS, unless it is the
2535 default (BEGV or ZV). */
2536
2537 int
2538 overlays_at (pos, extend, vec_ptr, len_ptr, next_ptr, prev_ptr, change_req)
2539 EMACS_INT pos;
2540 int extend;
2541 Lisp_Object **vec_ptr;
2542 int *len_ptr;
2543 int *next_ptr;
2544 int *prev_ptr;
2545 int change_req;
2546 {
2547 Lisp_Object overlay, start, end;
2548 struct Lisp_Overlay *tail;
2549 int idx = 0;
2550 int len = *len_ptr;
2551 Lisp_Object *vec = *vec_ptr;
2552 int next = ZV;
2553 int prev = BEGV;
2554 int inhibit_storing = 0;
2555
2556 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2557 {
2558 int startpos, endpos;
2559
2560 XSETMISC (overlay, tail);
2561
2562 start = OVERLAY_START (overlay);
2563 end = OVERLAY_END (overlay);
2564 endpos = OVERLAY_POSITION (end);
2565 if (endpos < pos)
2566 {
2567 if (prev < endpos)
2568 prev = endpos;
2569 break;
2570 }
2571 startpos = OVERLAY_POSITION (start);
2572 /* This one ends at or after POS
2573 so its start counts for PREV_PTR if it's before POS. */
2574 if (prev < startpos && startpos < pos)
2575 prev = startpos;
2576 if (endpos == pos)
2577 continue;
2578 if (startpos <= pos)
2579 {
2580 if (idx == len)
2581 {
2582 /* The supplied vector is full.
2583 Either make it bigger, or don't store any more in it. */
2584 if (extend)
2585 {
2586 /* Make it work with an initial len == 0. */
2587 len *= 2;
2588 if (len == 0)
2589 len = 4;
2590 *len_ptr = len;
2591 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2592 *vec_ptr = vec;
2593 }
2594 else
2595 inhibit_storing = 1;
2596 }
2597
2598 if (!inhibit_storing)
2599 vec[idx] = overlay;
2600 /* Keep counting overlays even if we can't return them all. */
2601 idx++;
2602 }
2603 else if (startpos < next)
2604 next = startpos;
2605 }
2606
2607 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2608 {
2609 int startpos, endpos;
2610
2611 XSETMISC (overlay, tail);
2612
2613 start = OVERLAY_START (overlay);
2614 end = OVERLAY_END (overlay);
2615 startpos = OVERLAY_POSITION (start);
2616 if (pos < startpos)
2617 {
2618 if (startpos < next)
2619 next = startpos;
2620 break;
2621 }
2622 endpos = OVERLAY_POSITION (end);
2623 if (pos < endpos)
2624 {
2625 if (idx == len)
2626 {
2627 if (extend)
2628 {
2629 /* Make it work with an initial len == 0. */
2630 len *= 2;
2631 if (len == 0)
2632 len = 4;
2633 *len_ptr = len;
2634 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2635 *vec_ptr = vec;
2636 }
2637 else
2638 inhibit_storing = 1;
2639 }
2640
2641 if (!inhibit_storing)
2642 vec[idx] = overlay;
2643 idx++;
2644
2645 if (startpos < pos && startpos > prev)
2646 prev = startpos;
2647 }
2648 else if (endpos < pos && endpos > prev)
2649 prev = endpos;
2650 else if (endpos == pos && startpos > prev
2651 && (!change_req || startpos < pos))
2652 prev = startpos;
2653 }
2654
2655 if (next_ptr)
2656 *next_ptr = next;
2657 if (prev_ptr)
2658 *prev_ptr = prev;
2659 return idx;
2660 }
2661 \f
2662 /* Find all the overlays in the current buffer that overlap the range BEG-END
2663 or are empty at BEG.
2664
2665 Return the number found, and store them in a vector in *VEC_PTR.
2666 Store in *LEN_PTR the size allocated for the vector.
2667 Store in *NEXT_PTR the next position after POS where an overlay starts,
2668 or ZV if there are no more overlays.
2669 Store in *PREV_PTR the previous position before POS where an overlay ends,
2670 or BEGV if there are no previous overlays.
2671 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2672
2673 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2674 when this function is called.
2675
2676 If EXTEND is non-zero, we make the vector bigger if necessary.
2677 If EXTEND is zero, we never extend the vector,
2678 and we store only as many overlays as will fit.
2679 But we still return the total number of overlays. */
2680
2681 static int
2682 overlays_in (beg, end, extend, vec_ptr, len_ptr, next_ptr, prev_ptr)
2683 int beg, end;
2684 int extend;
2685 Lisp_Object **vec_ptr;
2686 int *len_ptr;
2687 int *next_ptr;
2688 int *prev_ptr;
2689 {
2690 Lisp_Object overlay, ostart, oend;
2691 struct Lisp_Overlay *tail;
2692 int idx = 0;
2693 int len = *len_ptr;
2694 Lisp_Object *vec = *vec_ptr;
2695 int next = ZV;
2696 int prev = BEGV;
2697 int inhibit_storing = 0;
2698
2699 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2700 {
2701 int startpos, endpos;
2702
2703 XSETMISC (overlay, tail);
2704
2705 ostart = OVERLAY_START (overlay);
2706 oend = OVERLAY_END (overlay);
2707 endpos = OVERLAY_POSITION (oend);
2708 if (endpos < beg)
2709 {
2710 if (prev < endpos)
2711 prev = endpos;
2712 break;
2713 }
2714 startpos = OVERLAY_POSITION (ostart);
2715 /* Count an interval if it either overlaps the range
2716 or is empty at the start of the range. */
2717 if ((beg < endpos && startpos < end)
2718 || (startpos == endpos && beg == endpos))
2719 {
2720 if (idx == len)
2721 {
2722 /* The supplied vector is full.
2723 Either make it bigger, or don't store any more in it. */
2724 if (extend)
2725 {
2726 /* Make it work with an initial len == 0. */
2727 len *= 2;
2728 if (len == 0)
2729 len = 4;
2730 *len_ptr = len;
2731 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2732 *vec_ptr = vec;
2733 }
2734 else
2735 inhibit_storing = 1;
2736 }
2737
2738 if (!inhibit_storing)
2739 vec[idx] = overlay;
2740 /* Keep counting overlays even if we can't return them all. */
2741 idx++;
2742 }
2743 else if (startpos < next)
2744 next = startpos;
2745 }
2746
2747 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2748 {
2749 int startpos, endpos;
2750
2751 XSETMISC (overlay, tail);
2752
2753 ostart = OVERLAY_START (overlay);
2754 oend = OVERLAY_END (overlay);
2755 startpos = OVERLAY_POSITION (ostart);
2756 if (end < startpos)
2757 {
2758 if (startpos < next)
2759 next = startpos;
2760 break;
2761 }
2762 endpos = OVERLAY_POSITION (oend);
2763 /* Count an interval if it either overlaps the range
2764 or is empty at the start of the range. */
2765 if ((beg < endpos && startpos < end)
2766 || (startpos == endpos && beg == endpos))
2767 {
2768 if (idx == len)
2769 {
2770 if (extend)
2771 {
2772 /* Make it work with an initial len == 0. */
2773 len *= 2;
2774 if (len == 0)
2775 len = 4;
2776 *len_ptr = len;
2777 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2778 *vec_ptr = vec;
2779 }
2780 else
2781 inhibit_storing = 1;
2782 }
2783
2784 if (!inhibit_storing)
2785 vec[idx] = overlay;
2786 idx++;
2787 }
2788 else if (endpos < beg && endpos > prev)
2789 prev = endpos;
2790 }
2791
2792 if (next_ptr)
2793 *next_ptr = next;
2794 if (prev_ptr)
2795 *prev_ptr = prev;
2796 return idx;
2797 }
2798
2799
2800 /* Return non-zero if there exists an overlay with a non-nil
2801 `mouse-face' property overlapping OVERLAY. */
2802
2803 int
2804 mouse_face_overlay_overlaps (overlay)
2805 Lisp_Object overlay;
2806 {
2807 int start = OVERLAY_POSITION (OVERLAY_START (overlay));
2808 int end = OVERLAY_POSITION (OVERLAY_END (overlay));
2809 int n, i, size;
2810 Lisp_Object *v, tem;
2811
2812 size = 10;
2813 v = (Lisp_Object *) alloca (size * sizeof *v);
2814 n = overlays_in (start, end, 0, &v, &size, NULL, NULL);
2815 if (n > size)
2816 {
2817 v = (Lisp_Object *) alloca (n * sizeof *v);
2818 overlays_in (start, end, 0, &v, &n, NULL, NULL);
2819 }
2820
2821 for (i = 0; i < n; ++i)
2822 if (!EQ (v[i], overlay)
2823 && (tem = Foverlay_get (overlay, Qmouse_face),
2824 !NILP (tem)))
2825 break;
2826
2827 return i < n;
2828 }
2829
2830
2831 \f
2832 /* Fast function to just test if we're at an overlay boundary. */
2833 int
2834 overlay_touches_p (pos)
2835 int pos;
2836 {
2837 Lisp_Object overlay;
2838 struct Lisp_Overlay *tail;
2839
2840 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2841 {
2842 int endpos;
2843
2844 XSETMISC (overlay ,tail);
2845 if (!GC_OVERLAYP (overlay))
2846 abort ();
2847
2848 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2849 if (endpos < pos)
2850 break;
2851 if (endpos == pos || OVERLAY_POSITION (OVERLAY_START (overlay)) == pos)
2852 return 1;
2853 }
2854
2855 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2856 {
2857 int startpos;
2858
2859 XSETMISC (overlay, tail);
2860 if (!GC_OVERLAYP (overlay))
2861 abort ();
2862
2863 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2864 if (pos < startpos)
2865 break;
2866 if (startpos == pos || OVERLAY_POSITION (OVERLAY_END (overlay)) == pos)
2867 return 1;
2868 }
2869 return 0;
2870 }
2871 \f
2872 struct sortvec
2873 {
2874 Lisp_Object overlay;
2875 int beg, end;
2876 int priority;
2877 };
2878
2879 static int
2880 compare_overlays (v1, v2)
2881 const void *v1, *v2;
2882 {
2883 const struct sortvec *s1 = (const struct sortvec *) v1;
2884 const struct sortvec *s2 = (const struct sortvec *) v2;
2885 if (s1->priority != s2->priority)
2886 return s1->priority - s2->priority;
2887 if (s1->beg != s2->beg)
2888 return s1->beg - s2->beg;
2889 if (s1->end != s2->end)
2890 return s2->end - s1->end;
2891 return 0;
2892 }
2893
2894 /* Sort an array of overlays by priority. The array is modified in place.
2895 The return value is the new size; this may be smaller than the original
2896 size if some of the overlays were invalid or were window-specific. */
2897 int
2898 sort_overlays (overlay_vec, noverlays, w)
2899 Lisp_Object *overlay_vec;
2900 int noverlays;
2901 struct window *w;
2902 {
2903 int i, j;
2904 struct sortvec *sortvec;
2905 sortvec = (struct sortvec *) alloca (noverlays * sizeof (struct sortvec));
2906
2907 /* Put the valid and relevant overlays into sortvec. */
2908
2909 for (i = 0, j = 0; i < noverlays; i++)
2910 {
2911 Lisp_Object tem;
2912 Lisp_Object overlay;
2913
2914 overlay = overlay_vec[i];
2915 if (OVERLAY_VALID (overlay)
2916 && OVERLAY_POSITION (OVERLAY_START (overlay)) > 0
2917 && OVERLAY_POSITION (OVERLAY_END (overlay)) > 0)
2918 {
2919 /* If we're interested in a specific window, then ignore
2920 overlays that are limited to some other window. */
2921 if (w)
2922 {
2923 Lisp_Object window;
2924
2925 window = Foverlay_get (overlay, Qwindow);
2926 if (WINDOWP (window) && XWINDOW (window) != w)
2927 continue;
2928 }
2929
2930 /* This overlay is good and counts: put it into sortvec. */
2931 sortvec[j].overlay = overlay;
2932 sortvec[j].beg = OVERLAY_POSITION (OVERLAY_START (overlay));
2933 sortvec[j].end = OVERLAY_POSITION (OVERLAY_END (overlay));
2934 tem = Foverlay_get (overlay, Qpriority);
2935 if (INTEGERP (tem))
2936 sortvec[j].priority = XINT (tem);
2937 else
2938 sortvec[j].priority = 0;
2939 j++;
2940 }
2941 }
2942 noverlays = j;
2943
2944 /* Sort the overlays into the proper order: increasing priority. */
2945
2946 if (noverlays > 1)
2947 qsort (sortvec, noverlays, sizeof (struct sortvec), compare_overlays);
2948
2949 for (i = 0; i < noverlays; i++)
2950 overlay_vec[i] = sortvec[i].overlay;
2951 return (noverlays);
2952 }
2953 \f
2954 struct sortstr
2955 {
2956 Lisp_Object string, string2;
2957 int size;
2958 int priority;
2959 };
2960
2961 struct sortstrlist
2962 {
2963 struct sortstr *buf; /* An array that expands as needed; never freed. */
2964 int size; /* Allocated length of that array. */
2965 int used; /* How much of the array is currently in use. */
2966 int bytes; /* Total length of the strings in buf. */
2967 };
2968
2969 /* Buffers for storing information about the overlays touching a given
2970 position. These could be automatic variables in overlay_strings, but
2971 it's more efficient to hold onto the memory instead of repeatedly
2972 allocating and freeing it. */
2973 static struct sortstrlist overlay_heads, overlay_tails;
2974 static unsigned char *overlay_str_buf;
2975
2976 /* Allocated length of overlay_str_buf. */
2977 static int overlay_str_len;
2978
2979 /* A comparison function suitable for passing to qsort. */
2980 static int
2981 cmp_for_strings (as1, as2)
2982 char *as1, *as2;
2983 {
2984 struct sortstr *s1 = (struct sortstr *)as1;
2985 struct sortstr *s2 = (struct sortstr *)as2;
2986 if (s1->size != s2->size)
2987 return s2->size - s1->size;
2988 if (s1->priority != s2->priority)
2989 return s1->priority - s2->priority;
2990 return 0;
2991 }
2992
2993 static void
2994 record_overlay_string (ssl, str, str2, pri, size)
2995 struct sortstrlist *ssl;
2996 Lisp_Object str, str2, pri;
2997 int size;
2998 {
2999 int nbytes;
3000
3001 if (ssl->used == ssl->size)
3002 {
3003 if (ssl->buf)
3004 ssl->size *= 2;
3005 else
3006 ssl->size = 5;
3007 ssl->buf = ((struct sortstr *)
3008 xrealloc (ssl->buf, ssl->size * sizeof (struct sortstr)));
3009 }
3010 ssl->buf[ssl->used].string = str;
3011 ssl->buf[ssl->used].string2 = str2;
3012 ssl->buf[ssl->used].size = size;
3013 ssl->buf[ssl->used].priority = (INTEGERP (pri) ? XINT (pri) : 0);
3014 ssl->used++;
3015
3016 if (NILP (current_buffer->enable_multibyte_characters))
3017 nbytes = SCHARS (str);
3018 else if (! STRING_MULTIBYTE (str))
3019 nbytes = count_size_as_multibyte (SDATA (str),
3020 SBYTES (str));
3021 else
3022 nbytes = SBYTES (str);
3023
3024 ssl->bytes += nbytes;
3025
3026 if (STRINGP (str2))
3027 {
3028 if (NILP (current_buffer->enable_multibyte_characters))
3029 nbytes = SCHARS (str2);
3030 else if (! STRING_MULTIBYTE (str2))
3031 nbytes = count_size_as_multibyte (SDATA (str2),
3032 SBYTES (str2));
3033 else
3034 nbytes = SBYTES (str2);
3035
3036 ssl->bytes += nbytes;
3037 }
3038 }
3039
3040 /* Return the concatenation of the strings associated with overlays that
3041 begin or end at POS, ignoring overlays that are specific to a window
3042 other than W. The strings are concatenated in the appropriate order:
3043 shorter overlays nest inside longer ones, and higher priority inside
3044 lower. Normally all of the after-strings come first, but zero-sized
3045 overlays have their after-strings ride along with the before-strings
3046 because it would look strange to print them inside-out.
3047
3048 Returns the string length, and stores the contents indirectly through
3049 PSTR, if that variable is non-null. The string may be overwritten by
3050 subsequent calls. */
3051
3052 int
3053 overlay_strings (pos, w, pstr)
3054 EMACS_INT pos;
3055 struct window *w;
3056 unsigned char **pstr;
3057 {
3058 Lisp_Object overlay, window, str;
3059 struct Lisp_Overlay *ov;
3060 int startpos, endpos;
3061 int multibyte = ! NILP (current_buffer->enable_multibyte_characters);
3062
3063 overlay_heads.used = overlay_heads.bytes = 0;
3064 overlay_tails.used = overlay_tails.bytes = 0;
3065 for (ov = current_buffer->overlays_before; ov; ov = ov->next)
3066 {
3067 XSETMISC (overlay, ov);
3068 eassert (OVERLAYP (overlay));
3069
3070 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3071 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3072 if (endpos < pos)
3073 break;
3074 if (endpos != pos && startpos != pos)
3075 continue;
3076 window = Foverlay_get (overlay, Qwindow);
3077 if (WINDOWP (window) && XWINDOW (window) != w)
3078 continue;
3079 if (startpos == pos
3080 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3081 record_overlay_string (&overlay_heads, str,
3082 (startpos == endpos
3083 ? Foverlay_get (overlay, Qafter_string)
3084 : Qnil),
3085 Foverlay_get (overlay, Qpriority),
3086 endpos - startpos);
3087 else if (endpos == pos
3088 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3089 record_overlay_string (&overlay_tails, str, Qnil,
3090 Foverlay_get (overlay, Qpriority),
3091 endpos - startpos);
3092 }
3093 for (ov = current_buffer->overlays_after; ov; ov = ov->next)
3094 {
3095 XSETMISC (overlay, ov);
3096 eassert (OVERLAYP (overlay));
3097
3098 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3099 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3100 if (startpos > pos)
3101 break;
3102 if (endpos != pos && startpos != pos)
3103 continue;
3104 window = Foverlay_get (overlay, Qwindow);
3105 if (WINDOWP (window) && XWINDOW (window) != w)
3106 continue;
3107 if (startpos == pos
3108 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3109 record_overlay_string (&overlay_heads, str,
3110 (startpos == endpos
3111 ? Foverlay_get (overlay, Qafter_string)
3112 : Qnil),
3113 Foverlay_get (overlay, Qpriority),
3114 endpos - startpos);
3115 else if (endpos == pos
3116 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3117 record_overlay_string (&overlay_tails, str, Qnil,
3118 Foverlay_get (overlay, Qpriority),
3119 endpos - startpos);
3120 }
3121 if (overlay_tails.used > 1)
3122 qsort (overlay_tails.buf, overlay_tails.used, sizeof (struct sortstr),
3123 cmp_for_strings);
3124 if (overlay_heads.used > 1)
3125 qsort (overlay_heads.buf, overlay_heads.used, sizeof (struct sortstr),
3126 cmp_for_strings);
3127 if (overlay_heads.bytes || overlay_tails.bytes)
3128 {
3129 Lisp_Object tem;
3130 int i;
3131 unsigned char *p;
3132 int total = overlay_heads.bytes + overlay_tails.bytes;
3133
3134 if (total > overlay_str_len)
3135 {
3136 overlay_str_len = total;
3137 overlay_str_buf = (unsigned char *)xrealloc (overlay_str_buf,
3138 total);
3139 }
3140 p = overlay_str_buf;
3141 for (i = overlay_tails.used; --i >= 0;)
3142 {
3143 int nbytes;
3144 tem = overlay_tails.buf[i].string;
3145 nbytes = copy_text (SDATA (tem), p,
3146 SBYTES (tem),
3147 STRING_MULTIBYTE (tem), multibyte);
3148 p += nbytes;
3149 }
3150 for (i = 0; i < overlay_heads.used; ++i)
3151 {
3152 int nbytes;
3153 tem = overlay_heads.buf[i].string;
3154 nbytes = copy_text (SDATA (tem), p,
3155 SBYTES (tem),
3156 STRING_MULTIBYTE (tem), multibyte);
3157 p += nbytes;
3158 tem = overlay_heads.buf[i].string2;
3159 if (STRINGP (tem))
3160 {
3161 nbytes = copy_text (SDATA (tem), p,
3162 SBYTES (tem),
3163 STRING_MULTIBYTE (tem), multibyte);
3164 p += nbytes;
3165 }
3166 }
3167 if (p != overlay_str_buf + total)
3168 abort ();
3169 if (pstr)
3170 *pstr = overlay_str_buf;
3171 return total;
3172 }
3173 return 0;
3174 }
3175 \f
3176 /* Shift overlays in BUF's overlay lists, to center the lists at POS. */
3177
3178 void
3179 recenter_overlay_lists (buf, pos)
3180 struct buffer *buf;
3181 EMACS_INT pos;
3182 {
3183 Lisp_Object overlay, beg, end;
3184 struct Lisp_Overlay *prev, *tail, *next;
3185
3186 /* See if anything in overlays_before should move to overlays_after. */
3187
3188 /* We don't strictly need prev in this loop; it should always be nil.
3189 But we use it for symmetry and in case that should cease to be true
3190 with some future change. */
3191 prev = NULL;
3192 for (tail = buf->overlays_before; tail; prev = tail, tail = next)
3193 {
3194 next = tail->next;
3195 XSETMISC (overlay, tail);
3196
3197 /* If the overlay is not valid, get rid of it. */
3198 if (!OVERLAY_VALID (overlay))
3199 #if 1
3200 abort ();
3201 #else
3202 {
3203 /* Splice the cons cell TAIL out of overlays_before. */
3204 if (!NILP (prev))
3205 XCDR (prev) = next;
3206 else
3207 buf->overlays_before = next;
3208 tail = prev;
3209 continue;
3210 }
3211 #endif
3212
3213 beg = OVERLAY_START (overlay);
3214 end = OVERLAY_END (overlay);
3215
3216 if (OVERLAY_POSITION (end) > pos)
3217 {
3218 /* OVERLAY needs to be moved. */
3219 int where = OVERLAY_POSITION (beg);
3220 struct Lisp_Overlay *other, *other_prev;
3221
3222 /* Splice the cons cell TAIL out of overlays_before. */
3223 if (prev)
3224 prev->next = next;
3225 else
3226 buf->overlays_before = next;
3227
3228 /* Search thru overlays_after for where to put it. */
3229 other_prev = NULL;
3230 for (other = buf->overlays_after; other;
3231 other_prev = other, other = other->next)
3232 {
3233 Lisp_Object otherbeg, otheroverlay;
3234
3235 XSETMISC (otheroverlay, other);
3236 eassert (OVERLAY_VALID (otheroverlay));
3237
3238 otherbeg = OVERLAY_START (otheroverlay);
3239 if (OVERLAY_POSITION (otherbeg) >= where)
3240 break;
3241 }
3242
3243 /* Add TAIL to overlays_after before OTHER. */
3244 tail->next = other;
3245 if (other_prev)
3246 other_prev->next = tail;
3247 else
3248 buf->overlays_after = tail;
3249 tail = prev;
3250 }
3251 else
3252 /* We've reached the things that should stay in overlays_before.
3253 All the rest of overlays_before must end even earlier,
3254 so stop now. */
3255 break;
3256 }
3257
3258 /* See if anything in overlays_after should be in overlays_before. */
3259 prev = NULL;
3260 for (tail = buf->overlays_after; tail; prev = tail, tail = next)
3261 {
3262 next = tail->next;
3263 XSETMISC (overlay, tail);
3264
3265 /* If the overlay is not valid, get rid of it. */
3266 if (!OVERLAY_VALID (overlay))
3267 #if 1
3268 abort ();
3269 #else
3270 {
3271 /* Splice the cons cell TAIL out of overlays_after. */
3272 if (!NILP (prev))
3273 XCDR (prev) = next;
3274 else
3275 buf->overlays_after = next;
3276 tail = prev;
3277 continue;
3278 }
3279 #endif
3280
3281 beg = OVERLAY_START (overlay);
3282 end = OVERLAY_END (overlay);
3283
3284 /* Stop looking, when we know that nothing further
3285 can possibly end before POS. */
3286 if (OVERLAY_POSITION (beg) > pos)
3287 break;
3288
3289 if (OVERLAY_POSITION (end) <= pos)
3290 {
3291 /* OVERLAY needs to be moved. */
3292 int where = OVERLAY_POSITION (end);
3293 struct Lisp_Overlay *other, *other_prev;
3294
3295 /* Splice the cons cell TAIL out of overlays_after. */
3296 if (prev)
3297 prev->next = next;
3298 else
3299 buf->overlays_after = next;
3300
3301 /* Search thru overlays_before for where to put it. */
3302 other_prev = NULL;
3303 for (other = buf->overlays_before; other;
3304 other_prev = other, other = other->next)
3305 {
3306 Lisp_Object otherend, otheroverlay;
3307
3308 XSETMISC (otheroverlay, other);
3309 eassert (OVERLAY_VALID (otheroverlay));
3310
3311 otherend = OVERLAY_END (otheroverlay);
3312 if (OVERLAY_POSITION (otherend) <= where)
3313 break;
3314 }
3315
3316 /* Add TAIL to overlays_before before OTHER. */
3317 tail->next = other;
3318 if (other_prev)
3319 other_prev->next = tail;
3320 else
3321 buf->overlays_before = tail;
3322 tail = prev;
3323 }
3324 }
3325
3326 buf->overlay_center = pos;
3327 }
3328
3329 void
3330 adjust_overlays_for_insert (pos, length)
3331 EMACS_INT pos;
3332 EMACS_INT length;
3333 {
3334 /* After an insertion, the lists are still sorted properly,
3335 but we may need to update the value of the overlay center. */
3336 if (current_buffer->overlay_center >= pos)
3337 current_buffer->overlay_center += length;
3338 }
3339
3340 void
3341 adjust_overlays_for_delete (pos, length)
3342 EMACS_INT pos;
3343 EMACS_INT length;
3344 {
3345 if (current_buffer->overlay_center < pos)
3346 /* The deletion was to our right. No change needed; the before- and
3347 after-lists are still consistent. */
3348 ;
3349 else if (current_buffer->overlay_center > pos + length)
3350 /* The deletion was to our left. We need to adjust the center value
3351 to account for the change in position, but the lists are consistent
3352 given the new value. */
3353 current_buffer->overlay_center -= length;
3354 else
3355 /* We're right in the middle. There might be things on the after-list
3356 that now belong on the before-list. Recentering will move them,
3357 and also update the center point. */
3358 recenter_overlay_lists (current_buffer, pos);
3359 }
3360
3361 /* Fix up overlays that were garbled as a result of permuting markers
3362 in the range START through END. Any overlay with at least one
3363 endpoint in this range will need to be unlinked from the overlay
3364 list and reinserted in its proper place.
3365 Such an overlay might even have negative size at this point.
3366 If so, we'll make the overlay empty. */
3367 void
3368 fix_start_end_in_overlays (start, end)
3369 register int start, end;
3370 {
3371 Lisp_Object overlay;
3372 struct Lisp_Overlay *before_list, *after_list;
3373 /* These are either nil, indicating that before_list or after_list
3374 should be assigned, or the cons cell the cdr of which should be
3375 assigned. */
3376 struct Lisp_Overlay *beforep = NULL, *afterp = NULL;
3377 /* 'Parent', likewise, indicates a cons cell or
3378 current_buffer->overlays_before or overlays_after, depending
3379 which loop we're in. */
3380 struct Lisp_Overlay *tail, *parent;
3381 int startpos, endpos;
3382
3383 /* This algorithm shifts links around instead of consing and GCing.
3384 The loop invariant is that before_list (resp. after_list) is a
3385 well-formed list except that its last element, the CDR of beforep
3386 (resp. afterp) if beforep (afterp) isn't nil or before_list
3387 (after_list) if it is, is still uninitialized. So it's not a bug
3388 that before_list isn't initialized, although it may look
3389 strange. */
3390 for (parent = NULL, tail = current_buffer->overlays_before; tail;)
3391 {
3392 XSETMISC (overlay, tail);
3393
3394 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3395 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3396
3397 /* If the overlay is backwards, make it empty. */
3398 if (endpos < startpos)
3399 {
3400 startpos = endpos;
3401 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3402 Qnil);
3403 }
3404
3405 if (endpos < start)
3406 break;
3407
3408 if (endpos < end
3409 || (startpos >= start && startpos < end))
3410 {
3411 /* Add it to the end of the wrong list. Later on,
3412 recenter_overlay_lists will move it to the right place. */
3413 if (endpos < current_buffer->overlay_center)
3414 {
3415 if (!afterp)
3416 after_list = tail;
3417 else
3418 afterp->next = tail;
3419 afterp = tail;
3420 }
3421 else
3422 {
3423 if (!beforep)
3424 before_list = tail;
3425 else
3426 beforep->next = tail;
3427 beforep = tail;
3428 }
3429 if (!parent)
3430 current_buffer->overlays_before = tail->next;
3431 else
3432 parent->next = tail->next;
3433 tail = tail->next;
3434 }
3435 else
3436 parent = tail, tail = parent->next;
3437 }
3438 for (parent = NULL, tail = current_buffer->overlays_after; tail;)
3439 {
3440 XSETMISC (overlay, tail);
3441
3442 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3443 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3444
3445 /* If the overlay is backwards, make it empty. */
3446 if (endpos < startpos)
3447 {
3448 startpos = endpos;
3449 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3450 Qnil);
3451 }
3452
3453 if (startpos >= end)
3454 break;
3455
3456 if (startpos >= start
3457 || (endpos >= start && endpos < end))
3458 {
3459 if (endpos < current_buffer->overlay_center)
3460 {
3461 if (!afterp)
3462 after_list = tail;
3463 else
3464 afterp->next = tail;
3465 afterp = tail;
3466 }
3467 else
3468 {
3469 if (!beforep)
3470 before_list = tail;
3471 else
3472 beforep->next = tail;
3473 beforep = tail;
3474 }
3475 if (!parent)
3476 current_buffer->overlays_after = tail->next;
3477 else
3478 parent->next = tail->next;
3479 tail = tail->next;
3480 }
3481 else
3482 parent = tail, tail = parent->next;
3483 }
3484
3485 /* Splice the constructed (wrong) lists into the buffer's lists,
3486 and let the recenter function make it sane again. */
3487 if (beforep)
3488 {
3489 beforep->next = current_buffer->overlays_before;
3490 current_buffer->overlays_before = before_list;
3491 }
3492 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3493
3494 if (afterp)
3495 {
3496 afterp->next = current_buffer->overlays_after;
3497 current_buffer->overlays_after = after_list;
3498 }
3499 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3500 }
3501
3502 /* We have two types of overlay: the one whose ending marker is
3503 after-insertion-marker (this is the usual case) and the one whose
3504 ending marker is before-insertion-marker. When `overlays_before'
3505 contains overlays of the latter type and the former type in this
3506 order and both overlays end at inserting position, inserting a text
3507 increases only the ending marker of the latter type, which results
3508 in incorrect ordering of `overlays_before'.
3509
3510 This function fixes ordering of overlays in the slot
3511 `overlays_before' of the buffer *BP. Before the insertion, `point'
3512 was at PREV, and now is at POS. */
3513
3514 void
3515 fix_overlays_before (bp, prev, pos)
3516 struct buffer *bp;
3517 EMACS_INT prev, pos;
3518 {
3519 /* If parent is nil, replace overlays_before; otherwise, parent->next. */
3520 struct Lisp_Overlay *tail = bp->overlays_before, *parent = NULL, *right_pair;
3521 Lisp_Object tem;
3522 EMACS_INT end;
3523
3524 /* After the insertion, the several overlays may be in incorrect
3525 order. The possibility is that, in the list `overlays_before',
3526 an overlay which ends at POS appears after an overlay which ends
3527 at PREV. Since POS is greater than PREV, we must fix the
3528 ordering of these overlays, by moving overlays ends at POS before
3529 the overlays ends at PREV. */
3530
3531 /* At first, find a place where disordered overlays should be linked
3532 in. It is where an overlay which end before POS exists. (i.e. an
3533 overlay whose ending marker is after-insertion-marker if disorder
3534 exists). */
3535 while (tail
3536 && (XSETMISC (tem, tail),
3537 (end = OVERLAY_POSITION (OVERLAY_END (tem))) >= pos))
3538 {
3539 parent = tail;
3540 tail = tail->next;
3541 }
3542
3543 /* If we don't find such an overlay,
3544 or the found one ends before PREV,
3545 or the found one is the last one in the list,
3546 we don't have to fix anything. */
3547 if (!tail || end < prev || !tail->next)
3548 return;
3549
3550 right_pair = parent;
3551 parent = tail;
3552 tail = tail->next;
3553
3554 /* Now, end position of overlays in the list TAIL should be before
3555 or equal to PREV. In the loop, an overlay which ends at POS is
3556 moved ahead to the place indicated by the CDR of RIGHT_PAIR. If
3557 we found an overlay which ends before PREV, the remaining
3558 overlays are in correct order. */
3559 while (tail)
3560 {
3561 XSETMISC (tem, tail);
3562 end = OVERLAY_POSITION (OVERLAY_END (tem));
3563
3564 if (end == pos)
3565 { /* This overlay is disordered. */
3566 struct Lisp_Overlay *found = tail;
3567
3568 /* Unlink the found overlay. */
3569 tail = found->next;
3570 parent->next = tail;
3571 /* Move an overlay at RIGHT_PLACE to the next of the found one,
3572 and link it into the right place. */
3573 if (!right_pair)
3574 {
3575 found->next = bp->overlays_before;
3576 bp->overlays_before = found;
3577 }
3578 else
3579 {
3580 found->next = right_pair->next;
3581 right_pair->next = found;
3582 }
3583 }
3584 else if (end == prev)
3585 {
3586 parent = tail;
3587 tail = tail->next;
3588 }
3589 else /* No more disordered overlay. */
3590 break;
3591 }
3592 }
3593 \f
3594 DEFUN ("overlayp", Foverlayp, Soverlayp, 1, 1, 0,
3595 doc: /* Return t if OBJECT is an overlay. */)
3596 (object)
3597 Lisp_Object object;
3598 {
3599 return (OVERLAYP (object) ? Qt : Qnil);
3600 }
3601
3602 DEFUN ("make-overlay", Fmake_overlay, Smake_overlay, 2, 5, 0,
3603 doc: /* Create a new overlay with range BEG to END in BUFFER.
3604 If omitted, BUFFER defaults to the current buffer.
3605 BEG and END may be integers or markers.
3606 The fourth arg FRONT-ADVANCE, if non-nil, makes the marker
3607 for the front of the overlay advance when text is inserted there
3608 \(which means the text *is not* included in the overlay).
3609 The fifth arg REAR-ADVANCE, if non-nil, makes the marker
3610 for the rear of the overlay advance when text is inserted there
3611 \(which means the text *is* included in the overlay). */)
3612 (beg, end, buffer, front_advance, rear_advance)
3613 Lisp_Object beg, end, buffer;
3614 Lisp_Object front_advance, rear_advance;
3615 {
3616 Lisp_Object overlay;
3617 struct buffer *b;
3618
3619 if (NILP (buffer))
3620 XSETBUFFER (buffer, current_buffer);
3621 else
3622 CHECK_BUFFER (buffer);
3623 if (MARKERP (beg)
3624 && ! EQ (Fmarker_buffer (beg), buffer))
3625 error ("Marker points into wrong buffer");
3626 if (MARKERP (end)
3627 && ! EQ (Fmarker_buffer (end), buffer))
3628 error ("Marker points into wrong buffer");
3629
3630 CHECK_NUMBER_COERCE_MARKER (beg);
3631 CHECK_NUMBER_COERCE_MARKER (end);
3632
3633 if (XINT (beg) > XINT (end))
3634 {
3635 Lisp_Object temp;
3636 temp = beg; beg = end; end = temp;
3637 }
3638
3639 b = XBUFFER (buffer);
3640
3641 beg = Fset_marker (Fmake_marker (), beg, buffer);
3642 end = Fset_marker (Fmake_marker (), end, buffer);
3643
3644 if (!NILP (front_advance))
3645 XMARKER (beg)->insertion_type = 1;
3646 if (!NILP (rear_advance))
3647 XMARKER (end)->insertion_type = 1;
3648
3649 overlay = allocate_misc ();
3650 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
3651 XOVERLAY (overlay)->start = beg;
3652 XOVERLAY (overlay)->end = end;
3653 XOVERLAY (overlay)->plist = Qnil;
3654 XOVERLAY (overlay)->next = NULL;
3655
3656 /* Put the new overlay on the wrong list. */
3657 end = OVERLAY_END (overlay);
3658 if (OVERLAY_POSITION (end) < b->overlay_center)
3659 {
3660 if (b->overlays_after)
3661 XOVERLAY (overlay)->next = b->overlays_after;
3662 b->overlays_after = XOVERLAY (overlay);
3663 }
3664 else
3665 {
3666 if (b->overlays_before)
3667 XOVERLAY (overlay)->next = b->overlays_before;
3668 b->overlays_before = XOVERLAY (overlay);
3669 }
3670
3671 /* This puts it in the right list, and in the right order. */
3672 recenter_overlay_lists (b, b->overlay_center);
3673
3674 /* We don't need to redisplay the region covered by the overlay, because
3675 the overlay has no properties at the moment. */
3676
3677 return overlay;
3678 }
3679 \f
3680 /* Mark a section of BUF as needing redisplay because of overlays changes. */
3681
3682 static void
3683 modify_overlay (buf, start, end)
3684 struct buffer *buf;
3685 EMACS_INT start, end;
3686 {
3687 if (start > end)
3688 {
3689 int temp = start;
3690 start = end;
3691 end = temp;
3692 }
3693
3694 BUF_COMPUTE_UNCHANGED (buf, start, end);
3695
3696 /* If this is a buffer not in the selected window,
3697 we must do other windows. */
3698 if (buf != XBUFFER (XWINDOW (selected_window)->buffer))
3699 windows_or_buffers_changed = 1;
3700 /* If multiple windows show this buffer, we must do other windows. */
3701 else if (buffer_shared > 1)
3702 windows_or_buffers_changed = 1;
3703 /* If we modify an overlay at the end of the buffer, we cannot
3704 be sure that window end is still valid. */
3705 else if (end >= ZV && start <= ZV)
3706 windows_or_buffers_changed = 1;
3707
3708 ++BUF_OVERLAY_MODIFF (buf);
3709 }
3710
3711 \f
3712 Lisp_Object Fdelete_overlay ();
3713
3714 static struct Lisp_Overlay *
3715 unchain_overlay (list, overlay)
3716 struct Lisp_Overlay *list, *overlay;
3717 {
3718 struct Lisp_Overlay *tmp, *prev;
3719 for (tmp = list, prev = NULL; tmp; prev = tmp, tmp = tmp->next)
3720 if (tmp == overlay)
3721 {
3722 if (prev)
3723 prev->next = tmp->next;
3724 else
3725 list = tmp->next;
3726 overlay->next = NULL;
3727 break;
3728 }
3729 return list;
3730 }
3731
3732 DEFUN ("move-overlay", Fmove_overlay, Smove_overlay, 3, 4, 0,
3733 doc: /* Set the endpoints of OVERLAY to BEG and END in BUFFER.
3734 If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.
3735 If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current
3736 buffer. */)
3737 (overlay, beg, end, buffer)
3738 Lisp_Object overlay, beg, end, buffer;
3739 {
3740 struct buffer *b, *ob;
3741 Lisp_Object obuffer;
3742 int count = SPECPDL_INDEX ();
3743
3744 CHECK_OVERLAY (overlay);
3745 if (NILP (buffer))
3746 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3747 if (NILP (buffer))
3748 XSETBUFFER (buffer, current_buffer);
3749 CHECK_BUFFER (buffer);
3750
3751 if (MARKERP (beg)
3752 && ! EQ (Fmarker_buffer (beg), buffer))
3753 error ("Marker points into wrong buffer");
3754 if (MARKERP (end)
3755 && ! EQ (Fmarker_buffer (end), buffer))
3756 error ("Marker points into wrong buffer");
3757
3758 CHECK_NUMBER_COERCE_MARKER (beg);
3759 CHECK_NUMBER_COERCE_MARKER (end);
3760
3761 if (XINT (beg) == XINT (end) && ! NILP (Foverlay_get (overlay, Qevaporate)))
3762 return Fdelete_overlay (overlay);
3763
3764 if (XINT (beg) > XINT (end))
3765 {
3766 Lisp_Object temp;
3767 temp = beg; beg = end; end = temp;
3768 }
3769
3770 specbind (Qinhibit_quit, Qt);
3771
3772 obuffer = Fmarker_buffer (OVERLAY_START (overlay));
3773 b = XBUFFER (buffer);
3774 ob = BUFFERP (obuffer) ? XBUFFER (obuffer) : (struct buffer *) 0;
3775
3776 /* If the overlay has changed buffers, do a thorough redisplay. */
3777 if (!EQ (buffer, obuffer))
3778 {
3779 /* Redisplay where the overlay was. */
3780 if (!NILP (obuffer))
3781 {
3782 int o_beg;
3783 int o_end;
3784
3785 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3786 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3787
3788 modify_overlay (ob, o_beg, o_end);
3789 }
3790
3791 /* Redisplay where the overlay is going to be. */
3792 modify_overlay (b, XINT (beg), XINT (end));
3793 }
3794 else
3795 /* Redisplay the area the overlay has just left, or just enclosed. */
3796 {
3797 int o_beg, o_end;
3798
3799 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3800 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3801
3802 if (o_beg == XINT (beg))
3803 modify_overlay (b, o_end, XINT (end));
3804 else if (o_end == XINT (end))
3805 modify_overlay (b, o_beg, XINT (beg));
3806 else
3807 {
3808 if (XINT (beg) < o_beg) o_beg = XINT (beg);
3809 if (XINT (end) > o_end) o_end = XINT (end);
3810 modify_overlay (b, o_beg, o_end);
3811 }
3812 }
3813
3814 if (!NILP (obuffer))
3815 {
3816 ob->overlays_before
3817 = unchain_overlay (ob->overlays_before, XOVERLAY (overlay));
3818 ob->overlays_after
3819 = unchain_overlay (ob->overlays_after, XOVERLAY (overlay));
3820 eassert (XOVERLAY (overlay)->next == NULL);
3821 }
3822
3823 Fset_marker (OVERLAY_START (overlay), beg, buffer);
3824 Fset_marker (OVERLAY_END (overlay), end, buffer);
3825
3826 /* Put the overlay on the wrong list. */
3827 end = OVERLAY_END (overlay);
3828 if (OVERLAY_POSITION (end) < b->overlay_center)
3829 {
3830 XOVERLAY (overlay)->next = b->overlays_after;
3831 b->overlays_after = XOVERLAY (overlay);
3832 }
3833 else
3834 {
3835 XOVERLAY (overlay)->next = b->overlays_before;
3836 b->overlays_before = XOVERLAY (overlay);
3837 }
3838
3839 /* This puts it in the right list, and in the right order. */
3840 recenter_overlay_lists (b, b->overlay_center);
3841
3842 return unbind_to (count, overlay);
3843 }
3844
3845 DEFUN ("delete-overlay", Fdelete_overlay, Sdelete_overlay, 1, 1, 0,
3846 doc: /* Delete the overlay OVERLAY from its buffer. */)
3847 (overlay)
3848 Lisp_Object overlay;
3849 {
3850 Lisp_Object buffer;
3851 struct buffer *b;
3852 int count = SPECPDL_INDEX ();
3853
3854 CHECK_OVERLAY (overlay);
3855
3856 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3857 if (NILP (buffer))
3858 return Qnil;
3859
3860 b = XBUFFER (buffer);
3861 specbind (Qinhibit_quit, Qt);
3862
3863 b->overlays_before = unchain_overlay (b->overlays_before,XOVERLAY (overlay));
3864 b->overlays_after = unchain_overlay (b->overlays_after, XOVERLAY (overlay));
3865 eassert (XOVERLAY (overlay)->next == NULL);
3866 modify_overlay (b,
3867 marker_position (OVERLAY_START (overlay)),
3868 marker_position (OVERLAY_END (overlay)));
3869 Fset_marker (OVERLAY_START (overlay), Qnil, Qnil);
3870 Fset_marker (OVERLAY_END (overlay), Qnil, Qnil);
3871
3872 /* When deleting an overlay with before or after strings, turn off
3873 display optimizations for the affected buffer, on the basis that
3874 these strings may contain newlines. This is easier to do than to
3875 check for that situation during redisplay. */
3876 if (!windows_or_buffers_changed
3877 && (!NILP (Foverlay_get (overlay, Qbefore_string))
3878 || !NILP (Foverlay_get (overlay, Qafter_string))))
3879 b->prevent_redisplay_optimizations_p = 1;
3880
3881 return unbind_to (count, Qnil);
3882 }
3883 \f
3884 /* Overlay dissection functions. */
3885
3886 DEFUN ("overlay-start", Foverlay_start, Soverlay_start, 1, 1, 0,
3887 doc: /* Return the position at which OVERLAY starts. */)
3888 (overlay)
3889 Lisp_Object overlay;
3890 {
3891 CHECK_OVERLAY (overlay);
3892
3893 return (Fmarker_position (OVERLAY_START (overlay)));
3894 }
3895
3896 DEFUN ("overlay-end", Foverlay_end, Soverlay_end, 1, 1, 0,
3897 doc: /* Return the position at which OVERLAY ends. */)
3898 (overlay)
3899 Lisp_Object overlay;
3900 {
3901 CHECK_OVERLAY (overlay);
3902
3903 return (Fmarker_position (OVERLAY_END (overlay)));
3904 }
3905
3906 DEFUN ("overlay-buffer", Foverlay_buffer, Soverlay_buffer, 1, 1, 0,
3907 doc: /* Return the buffer OVERLAY belongs to.
3908 Return nil if OVERLAY has been deleted. */)
3909 (overlay)
3910 Lisp_Object overlay;
3911 {
3912 CHECK_OVERLAY (overlay);
3913
3914 return Fmarker_buffer (OVERLAY_START (overlay));
3915 }
3916
3917 DEFUN ("overlay-properties", Foverlay_properties, Soverlay_properties, 1, 1, 0,
3918 doc: /* Return a list of the properties on OVERLAY.
3919 This is a copy of OVERLAY's plist; modifying its conses has no effect on
3920 OVERLAY. */)
3921 (overlay)
3922 Lisp_Object overlay;
3923 {
3924 CHECK_OVERLAY (overlay);
3925
3926 return Fcopy_sequence (XOVERLAY (overlay)->plist);
3927 }
3928
3929 \f
3930 DEFUN ("overlays-at", Foverlays_at, Soverlays_at, 1, 1, 0,
3931 doc: /* Return a list of the overlays that contain position POS. */)
3932 (pos)
3933 Lisp_Object pos;
3934 {
3935 int noverlays;
3936 Lisp_Object *overlay_vec;
3937 int len;
3938 Lisp_Object result;
3939
3940 CHECK_NUMBER_COERCE_MARKER (pos);
3941
3942 len = 10;
3943 /* We can't use alloca here because overlays_at can call xrealloc. */
3944 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3945
3946 /* Put all the overlays we want in a vector in overlay_vec.
3947 Store the length in len. */
3948 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3949 (int *) 0, (int *) 0, 0);
3950
3951 /* Make a list of them all. */
3952 result = Flist (noverlays, overlay_vec);
3953
3954 xfree (overlay_vec);
3955 return result;
3956 }
3957
3958 DEFUN ("overlays-in", Foverlays_in, Soverlays_in, 2, 2, 0,
3959 doc: /* Return a list of the overlays that overlap the region BEG ... END.
3960 Overlap means that at least one character is contained within the overlay
3961 and also contained within the specified region.
3962 Empty overlays are included in the result if they are located at BEG
3963 or between BEG and END. */)
3964 (beg, end)
3965 Lisp_Object beg, end;
3966 {
3967 int noverlays;
3968 Lisp_Object *overlay_vec;
3969 int len;
3970 Lisp_Object result;
3971
3972 CHECK_NUMBER_COERCE_MARKER (beg);
3973 CHECK_NUMBER_COERCE_MARKER (end);
3974
3975 len = 10;
3976 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3977
3978 /* Put all the overlays we want in a vector in overlay_vec.
3979 Store the length in len. */
3980 noverlays = overlays_in (XINT (beg), XINT (end), 1, &overlay_vec, &len,
3981 (int *) 0, (int *) 0);
3982
3983 /* Make a list of them all. */
3984 result = Flist (noverlays, overlay_vec);
3985
3986 xfree (overlay_vec);
3987 return result;
3988 }
3989
3990 DEFUN ("next-overlay-change", Fnext_overlay_change, Snext_overlay_change,
3991 1, 1, 0,
3992 doc: /* Return the next position after POS where an overlay starts or ends.
3993 If there are no overlay boundaries from POS to (point-max),
3994 the value is (point-max). */)
3995 (pos)
3996 Lisp_Object pos;
3997 {
3998 int noverlays;
3999 int endpos;
4000 Lisp_Object *overlay_vec;
4001 int len;
4002 int i;
4003
4004 CHECK_NUMBER_COERCE_MARKER (pos);
4005
4006 len = 10;
4007 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
4008
4009 /* Put all the overlays we want in a vector in overlay_vec.
4010 Store the length in len.
4011 endpos gets the position where the next overlay starts. */
4012 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
4013 &endpos, (int *) 0, 1);
4014
4015 /* If any of these overlays ends before endpos,
4016 use its ending point instead. */
4017 for (i = 0; i < noverlays; i++)
4018 {
4019 Lisp_Object oend;
4020 int oendpos;
4021
4022 oend = OVERLAY_END (overlay_vec[i]);
4023 oendpos = OVERLAY_POSITION (oend);
4024 if (oendpos < endpos)
4025 endpos = oendpos;
4026 }
4027
4028 xfree (overlay_vec);
4029 return make_number (endpos);
4030 }
4031
4032 DEFUN ("previous-overlay-change", Fprevious_overlay_change,
4033 Sprevious_overlay_change, 1, 1, 0,
4034 doc: /* Return the previous position before POS where an overlay starts or ends.
4035 If there are no overlay boundaries from (point-min) to POS,
4036 the value is (point-min). */)
4037 (pos)
4038 Lisp_Object pos;
4039 {
4040 int noverlays;
4041 int prevpos;
4042 Lisp_Object *overlay_vec;
4043 int len;
4044
4045 CHECK_NUMBER_COERCE_MARKER (pos);
4046
4047 /* At beginning of buffer, we know the answer;
4048 avoid bug subtracting 1 below. */
4049 if (XINT (pos) == BEGV)
4050 return pos;
4051
4052 len = 10;
4053 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
4054
4055 /* Put all the overlays we want in a vector in overlay_vec.
4056 Store the length in len.
4057 prevpos gets the position of the previous change. */
4058 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
4059 (int *) 0, &prevpos, 1);
4060
4061 xfree (overlay_vec);
4062 return make_number (prevpos);
4063 }
4064 \f
4065 /* These functions are for debugging overlays. */
4066
4067 DEFUN ("overlay-lists", Foverlay_lists, Soverlay_lists, 0, 0, 0,
4068 doc: /* Return a pair of lists giving all the overlays of the current buffer.
4069 The car has all the overlays before the overlay center;
4070 the cdr has all the overlays after the overlay center.
4071 Recentering overlays moves overlays between these lists.
4072 The lists you get are copies, so that changing them has no effect.
4073 However, the overlays you get are the real objects that the buffer uses. */)
4074 ()
4075 {
4076 struct Lisp_Overlay *ol;
4077 Lisp_Object before = Qnil, after = Qnil, tmp;
4078 for (ol = current_buffer->overlays_before; ol; ol = ol->next)
4079 {
4080 XSETMISC (tmp, ol);
4081 before = Fcons (tmp, before);
4082 }
4083 for (ol = current_buffer->overlays_after; ol; ol = ol->next)
4084 {
4085 XSETMISC (tmp, ol);
4086 after = Fcons (tmp, after);
4087 }
4088 return Fcons (Fnreverse (before), Fnreverse (after));
4089 }
4090
4091 DEFUN ("overlay-recenter", Foverlay_recenter, Soverlay_recenter, 1, 1, 0,
4092 doc: /* Recenter the overlays of the current buffer around position POS.
4093 That makes overlay lookup faster for positions near POS (but perhaps slower
4094 for positions far away from POS). */)
4095 (pos)
4096 Lisp_Object pos;
4097 {
4098 CHECK_NUMBER_COERCE_MARKER (pos);
4099
4100 recenter_overlay_lists (current_buffer, XINT (pos));
4101 return Qnil;
4102 }
4103 \f
4104 DEFUN ("overlay-get", Foverlay_get, Soverlay_get, 2, 2, 0,
4105 doc: /* Get the property of overlay OVERLAY with property name PROP. */)
4106 (overlay, prop)
4107 Lisp_Object overlay, prop;
4108 {
4109 CHECK_OVERLAY (overlay);
4110 return lookup_char_property (XOVERLAY (overlay)->plist, prop, 0);
4111 }
4112
4113 DEFUN ("overlay-put", Foverlay_put, Soverlay_put, 3, 3, 0,
4114 doc: /* Set one property of overlay OVERLAY: give property PROP value VALUE. */)
4115 (overlay, prop, value)
4116 Lisp_Object overlay, prop, value;
4117 {
4118 Lisp_Object tail, buffer;
4119 int changed;
4120
4121 CHECK_OVERLAY (overlay);
4122
4123 buffer = Fmarker_buffer (OVERLAY_START (overlay));
4124
4125 for (tail = XOVERLAY (overlay)->plist;
4126 CONSP (tail) && CONSP (XCDR (tail));
4127 tail = XCDR (XCDR (tail)))
4128 if (EQ (XCAR (tail), prop))
4129 {
4130 changed = !EQ (XCAR (XCDR (tail)), value);
4131 XSETCAR (XCDR (tail), value);
4132 goto found;
4133 }
4134 /* It wasn't in the list, so add it to the front. */
4135 changed = !NILP (value);
4136 XOVERLAY (overlay)->plist
4137 = Fcons (prop, Fcons (value, XOVERLAY (overlay)->plist));
4138 found:
4139 if (! NILP (buffer))
4140 {
4141 if (changed)
4142 modify_overlay (XBUFFER (buffer),
4143 marker_position (OVERLAY_START (overlay)),
4144 marker_position (OVERLAY_END (overlay)));
4145 if (EQ (prop, Qevaporate) && ! NILP (value)
4146 && (OVERLAY_POSITION (OVERLAY_START (overlay))
4147 == OVERLAY_POSITION (OVERLAY_END (overlay))))
4148 Fdelete_overlay (overlay);
4149 }
4150
4151 return value;
4152 }
4153 \f
4154 /* Subroutine of report_overlay_modification. */
4155
4156 /* Lisp vector holding overlay hook functions to call.
4157 Vector elements come in pairs.
4158 Each even-index element is a list of hook functions.
4159 The following odd-index element is the overlay they came from.
4160
4161 Before the buffer change, we fill in this vector
4162 as we call overlay hook functions.
4163 After the buffer change, we get the functions to call from this vector.
4164 This way we always call the same functions before and after the change. */
4165 static Lisp_Object last_overlay_modification_hooks;
4166
4167 /* Number of elements actually used in last_overlay_modification_hooks. */
4168 static int last_overlay_modification_hooks_used;
4169
4170 /* Add one functionlist/overlay pair
4171 to the end of last_overlay_modification_hooks. */
4172
4173 static void
4174 add_overlay_mod_hooklist (functionlist, overlay)
4175 Lisp_Object functionlist, overlay;
4176 {
4177 int oldsize = XVECTOR (last_overlay_modification_hooks)->size;
4178
4179 if (last_overlay_modification_hooks_used == oldsize)
4180 {
4181 Lisp_Object old;
4182 old = last_overlay_modification_hooks;
4183 last_overlay_modification_hooks
4184 = Fmake_vector (make_number (oldsize * 2), Qnil);
4185 bcopy (XVECTOR (old)->contents,
4186 XVECTOR (last_overlay_modification_hooks)->contents,
4187 sizeof (Lisp_Object) * oldsize);
4188 }
4189 AREF (last_overlay_modification_hooks, last_overlay_modification_hooks_used++) = functionlist;
4190 AREF (last_overlay_modification_hooks, last_overlay_modification_hooks_used++) = overlay;
4191 }
4192 \f
4193 /* Run the modification-hooks of overlays that include
4194 any part of the text in START to END.
4195 If this change is an insertion, also
4196 run the insert-before-hooks of overlay starting at END,
4197 and the insert-after-hooks of overlay ending at START.
4198
4199 This is called both before and after the modification.
4200 AFTER is nonzero when we call after the modification.
4201
4202 ARG1, ARG2, ARG3 are arguments to pass to the hook functions.
4203 When AFTER is nonzero, they are the start position,
4204 the position after the inserted new text,
4205 and the length of deleted or replaced old text. */
4206
4207 void
4208 report_overlay_modification (start, end, after, arg1, arg2, arg3)
4209 Lisp_Object start, end;
4210 int after;
4211 Lisp_Object arg1, arg2, arg3;
4212 {
4213 Lisp_Object prop, overlay;
4214 struct Lisp_Overlay *tail;
4215 /* 1 if this change is an insertion. */
4216 int insertion = (after ? XFASTINT (arg3) == 0 : EQ (start, end));
4217 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4218
4219 overlay = Qnil;
4220 tail = NULL;
4221
4222 /* We used to run the functions as soon as we found them and only register
4223 them in last_overlay_modification_hooks for the purpose of the `after'
4224 case. But running elisp code as we traverse the list of overlays is
4225 painful because the list can be modified by the elisp code so we had to
4226 copy at several places. We now simply do a read-only traversal that
4227 only collects the functions to run and we run them afterwards. It's
4228 simpler, especially since all the code was already there. -stef */
4229
4230 if (!after)
4231 {
4232 /* We are being called before a change.
4233 Scan the overlays to find the functions to call. */
4234 last_overlay_modification_hooks_used = 0;
4235 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4236 {
4237 int startpos, endpos;
4238 Lisp_Object ostart, oend;
4239
4240 XSETMISC (overlay, tail);
4241
4242 ostart = OVERLAY_START (overlay);
4243 oend = OVERLAY_END (overlay);
4244 endpos = OVERLAY_POSITION (oend);
4245 if (XFASTINT (start) > endpos)
4246 break;
4247 startpos = OVERLAY_POSITION (ostart);
4248 if (insertion && (XFASTINT (start) == startpos
4249 || XFASTINT (end) == startpos))
4250 {
4251 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4252 if (!NILP (prop))
4253 add_overlay_mod_hooklist (prop, overlay);
4254 }
4255 if (insertion && (XFASTINT (start) == endpos
4256 || XFASTINT (end) == endpos))
4257 {
4258 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4259 if (!NILP (prop))
4260 add_overlay_mod_hooklist (prop, overlay);
4261 }
4262 /* Test for intersecting intervals. This does the right thing
4263 for both insertion and deletion. */
4264 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4265 {
4266 prop = Foverlay_get (overlay, Qmodification_hooks);
4267 if (!NILP (prop))
4268 add_overlay_mod_hooklist (prop, overlay);
4269 }
4270 }
4271
4272 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4273 {
4274 int startpos, endpos;
4275 Lisp_Object ostart, oend;
4276
4277 XSETMISC (overlay, tail);
4278
4279 ostart = OVERLAY_START (overlay);
4280 oend = OVERLAY_END (overlay);
4281 startpos = OVERLAY_POSITION (ostart);
4282 endpos = OVERLAY_POSITION (oend);
4283 if (XFASTINT (end) < startpos)
4284 break;
4285 if (insertion && (XFASTINT (start) == startpos
4286 || XFASTINT (end) == startpos))
4287 {
4288 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4289 if (!NILP (prop))
4290 add_overlay_mod_hooklist (prop, overlay);
4291 }
4292 if (insertion && (XFASTINT (start) == endpos
4293 || XFASTINT (end) == endpos))
4294 {
4295 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4296 if (!NILP (prop))
4297 add_overlay_mod_hooklist (prop, overlay);
4298 }
4299 /* Test for intersecting intervals. This does the right thing
4300 for both insertion and deletion. */
4301 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4302 {
4303 prop = Foverlay_get (overlay, Qmodification_hooks);
4304 if (!NILP (prop))
4305 add_overlay_mod_hooklist (prop, overlay);
4306 }
4307 }
4308 }
4309
4310 GCPRO4 (overlay, arg1, arg2, arg3);
4311 {
4312 /* Call the functions recorded in last_overlay_modification_hooks.
4313 First copy the vector contents, in case some of these hooks
4314 do subsequent modification of the buffer. */
4315 int size = last_overlay_modification_hooks_used;
4316 Lisp_Object *copy = (Lisp_Object *) alloca (size * sizeof (Lisp_Object));
4317 int i;
4318
4319 bcopy (XVECTOR (last_overlay_modification_hooks)->contents,
4320 copy, size * sizeof (Lisp_Object));
4321 gcpro1.var = copy;
4322 gcpro1.nvars = size;
4323
4324 for (i = 0; i < size;)
4325 {
4326 Lisp_Object prop, overlay;
4327 prop = copy[i++];
4328 overlay = copy[i++];
4329 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
4330 }
4331 }
4332 UNGCPRO;
4333 }
4334
4335 static void
4336 call_overlay_mod_hooks (list, overlay, after, arg1, arg2, arg3)
4337 Lisp_Object list, overlay;
4338 int after;
4339 Lisp_Object arg1, arg2, arg3;
4340 {
4341 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4342
4343 GCPRO4 (list, arg1, arg2, arg3);
4344
4345 while (CONSP (list))
4346 {
4347 if (NILP (arg3))
4348 call4 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2);
4349 else
4350 call5 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2, arg3);
4351 list = XCDR (list);
4352 }
4353 UNGCPRO;
4354 }
4355
4356 /* Delete any zero-sized overlays at position POS, if the `evaporate'
4357 property is set. */
4358 void
4359 evaporate_overlays (pos)
4360 EMACS_INT pos;
4361 {
4362 Lisp_Object overlay, hit_list;
4363 struct Lisp_Overlay *tail;
4364
4365 hit_list = Qnil;
4366 if (pos <= current_buffer->overlay_center)
4367 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4368 {
4369 int endpos;
4370 XSETMISC (overlay, tail);
4371 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
4372 if (endpos < pos)
4373 break;
4374 if (endpos == pos && OVERLAY_POSITION (OVERLAY_START (overlay)) == pos
4375 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4376 hit_list = Fcons (overlay, hit_list);
4377 }
4378 else
4379 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4380 {
4381 int startpos;
4382 XSETMISC (overlay, tail);
4383 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
4384 if (startpos > pos)
4385 break;
4386 if (startpos == pos && OVERLAY_POSITION (OVERLAY_END (overlay)) == pos
4387 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4388 hit_list = Fcons (overlay, hit_list);
4389 }
4390 for (; CONSP (hit_list); hit_list = XCDR (hit_list))
4391 Fdelete_overlay (XCAR (hit_list));
4392 }
4393 \f
4394 /* Somebody has tried to store a value with an unacceptable type
4395 in the slot with offset OFFSET. */
4396
4397 void
4398 buffer_slot_type_mismatch (offset)
4399 int offset;
4400 {
4401 Lisp_Object sym;
4402 char *type_name;
4403
4404 switch (XINT (PER_BUFFER_TYPE (offset)))
4405 {
4406 case Lisp_Int:
4407 type_name = "integers";
4408 break;
4409
4410 case Lisp_String:
4411 type_name = "strings";
4412 break;
4413
4414 case Lisp_Symbol:
4415 type_name = "symbols";
4416 break;
4417
4418 default:
4419 abort ();
4420 }
4421
4422 sym = PER_BUFFER_SYMBOL (offset);
4423 error ("Only %s should be stored in the buffer-local variable %s",
4424 type_name, SDATA (SYMBOL_NAME (sym)));
4425 }
4426
4427 \f
4428 /***********************************************************************
4429 Allocation with mmap
4430 ***********************************************************************/
4431
4432 #ifdef USE_MMAP_FOR_BUFFERS
4433
4434 #include <sys/types.h>
4435 #include <sys/mman.h>
4436
4437 #ifndef MAP_ANON
4438 #ifdef MAP_ANONYMOUS
4439 #define MAP_ANON MAP_ANONYMOUS
4440 #else
4441 #define MAP_ANON 0
4442 #endif
4443 #endif
4444
4445 #ifndef MAP_FAILED
4446 #define MAP_FAILED ((void *) -1)
4447 #endif
4448
4449 #include <stdio.h>
4450 #include <errno.h>
4451
4452 #if MAP_ANON == 0
4453 #include <fcntl.h>
4454 #endif
4455
4456 #include "coding.h"
4457
4458
4459 /* Memory is allocated in regions which are mapped using mmap(2).
4460 The current implementation lets the system select mapped
4461 addresses; we're not using MAP_FIXED in general, except when
4462 trying to enlarge regions.
4463
4464 Each mapped region starts with a mmap_region structure, the user
4465 area starts after that structure, aligned to MEM_ALIGN.
4466
4467 +-----------------------+
4468 | struct mmap_info + |
4469 | padding |
4470 +-----------------------+
4471 | user data |
4472 | |
4473 | |
4474 +-----------------------+ */
4475
4476 struct mmap_region
4477 {
4478 /* User-specified size. */
4479 size_t nbytes_specified;
4480
4481 /* Number of bytes mapped */
4482 size_t nbytes_mapped;
4483
4484 /* Pointer to the location holding the address of the memory
4485 allocated with the mmap'd block. The variable actually points
4486 after this structure. */
4487 POINTER_TYPE **var;
4488
4489 /* Next and previous in list of all mmap'd regions. */
4490 struct mmap_region *next, *prev;
4491 };
4492
4493 /* Doubly-linked list of mmap'd regions. */
4494
4495 static struct mmap_region *mmap_regions;
4496
4497 /* File descriptor for mmap. If we don't have anonymous mapping,
4498 /dev/zero will be opened on it. */
4499
4500 static int mmap_fd;
4501
4502 /* Temporary storage for mmap_set_vars, see there. */
4503
4504 static struct mmap_region *mmap_regions_1;
4505 static int mmap_fd_1;
4506
4507 /* Page size on this system. */
4508
4509 static int mmap_page_size;
4510
4511 /* 1 means mmap has been intialized. */
4512
4513 static int mmap_initialized_p;
4514
4515 /* Value is X rounded up to the next multiple of N. */
4516
4517 #define ROUND(X, N) (((X) + (N) - 1) / (N) * (N))
4518
4519 /* Size of mmap_region structure plus padding. */
4520
4521 #define MMAP_REGION_STRUCT_SIZE \
4522 ROUND (sizeof (struct mmap_region), MEM_ALIGN)
4523
4524 /* Given a pointer P to the start of the user-visible part of a mapped
4525 region, return a pointer to the start of the region. */
4526
4527 #define MMAP_REGION(P) \
4528 ((struct mmap_region *) ((char *) (P) - MMAP_REGION_STRUCT_SIZE))
4529
4530 /* Given a pointer P to the start of a mapped region, return a pointer
4531 to the start of the user-visible part of the region. */
4532
4533 #define MMAP_USER_AREA(P) \
4534 ((POINTER_TYPE *) ((char *) (P) + MMAP_REGION_STRUCT_SIZE))
4535
4536 #define MEM_ALIGN sizeof (double)
4537
4538 /* Predicate returning true if part of the address range [START .. END]
4539 is currently mapped. Used to prevent overwriting an existing
4540 memory mapping.
4541
4542 Default is to conservativly assume the address range is occupied by
4543 something else. This can be overridden by system configuration
4544 files if system-specific means to determine this exists. */
4545
4546 #ifndef MMAP_ALLOCATED_P
4547 #define MMAP_ALLOCATED_P(start, end) 1
4548 #endif
4549
4550 /* Function prototypes. */
4551
4552 static int mmap_free_1 P_ ((struct mmap_region *));
4553 static int mmap_enlarge P_ ((struct mmap_region *, int));
4554 static struct mmap_region *mmap_find P_ ((POINTER_TYPE *, POINTER_TYPE *));
4555 static POINTER_TYPE *mmap_alloc P_ ((POINTER_TYPE **, size_t));
4556 static POINTER_TYPE *mmap_realloc P_ ((POINTER_TYPE **, size_t));
4557 static void mmap_free P_ ((POINTER_TYPE **ptr));
4558 static void mmap_init P_ ((void));
4559
4560
4561 /* Return a region overlapping address range START...END, or null if
4562 none. END is not including, i.e. the last byte in the range
4563 is at END - 1. */
4564
4565 static struct mmap_region *
4566 mmap_find (start, end)
4567 POINTER_TYPE *start, *end;
4568 {
4569 struct mmap_region *r;
4570 char *s = (char *) start, *e = (char *) end;
4571
4572 for (r = mmap_regions; r; r = r->next)
4573 {
4574 char *rstart = (char *) r;
4575 char *rend = rstart + r->nbytes_mapped;
4576
4577 if (/* First byte of range, i.e. START, in this region? */
4578 (s >= rstart && s < rend)
4579 /* Last byte of range, i.e. END - 1, in this region? */
4580 || (e > rstart && e <= rend)
4581 /* First byte of this region in the range? */
4582 || (rstart >= s && rstart < e)
4583 /* Last byte of this region in the range? */
4584 || (rend > s && rend <= e))
4585 break;
4586 }
4587
4588 return r;
4589 }
4590
4591
4592 /* Unmap a region. P is a pointer to the start of the user-araa of
4593 the region. Value is non-zero if successful. */
4594
4595 static int
4596 mmap_free_1 (r)
4597 struct mmap_region *r;
4598 {
4599 if (r->next)
4600 r->next->prev = r->prev;
4601 if (r->prev)
4602 r->prev->next = r->next;
4603 else
4604 mmap_regions = r->next;
4605
4606 if (munmap ((POINTER_TYPE *) r, r->nbytes_mapped) == -1)
4607 {
4608 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4609 return 0;
4610 }
4611
4612 return 1;
4613 }
4614
4615
4616 /* Enlarge region R by NPAGES pages. NPAGES < 0 means shrink R.
4617 Value is non-zero if successful. */
4618
4619 static int
4620 mmap_enlarge (r, npages)
4621 struct mmap_region *r;
4622 int npages;
4623 {
4624 char *region_end = (char *) r + r->nbytes_mapped;
4625 size_t nbytes;
4626 int success = 0;
4627
4628 if (npages < 0)
4629 {
4630 /* Unmap pages at the end of the region. */
4631 nbytes = - npages * mmap_page_size;
4632 if (munmap (region_end - nbytes, nbytes) == -1)
4633 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4634 else
4635 {
4636 r->nbytes_mapped -= nbytes;
4637 success = 1;
4638 }
4639 }
4640 else if (npages > 0)
4641 {
4642 nbytes = npages * mmap_page_size;
4643
4644 /* Try to map additional pages at the end of the region. We
4645 cannot do this if the address range is already occupied by
4646 something else because mmap deletes any previous mapping.
4647 I'm not sure this is worth doing, let's see. */
4648 if (!MMAP_ALLOCATED_P (region_end, region_end + nbytes))
4649 {
4650 POINTER_TYPE *p;
4651
4652 p = mmap (region_end, nbytes, PROT_READ | PROT_WRITE,
4653 MAP_ANON | MAP_PRIVATE | MAP_FIXED, mmap_fd, 0);
4654 if (p == MAP_FAILED)
4655 ; /* fprintf (stderr, "mmap: %s\n", emacs_strerror (errno)); */
4656 else if (p != (POINTER_TYPE *) region_end)
4657 {
4658 /* Kernels are free to choose a different address. In
4659 that case, unmap what we've mapped above; we have
4660 no use for it. */
4661 if (munmap (p, nbytes) == -1)
4662 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4663 }
4664 else
4665 {
4666 r->nbytes_mapped += nbytes;
4667 success = 1;
4668 }
4669 }
4670 }
4671
4672 return success;
4673 }
4674
4675
4676 /* Set or reset variables holding references to mapped regions. If
4677 RESTORE_P is zero, set all variables to null. If RESTORE_P is
4678 non-zero, set all variables to the start of the user-areas
4679 of mapped regions.
4680
4681 This function is called from Fdump_emacs to ensure that the dumped
4682 Emacs doesn't contain references to memory that won't be mapped
4683 when Emacs starts. */
4684
4685 void
4686 mmap_set_vars (restore_p)
4687 int restore_p;
4688 {
4689 struct mmap_region *r;
4690
4691 if (restore_p)
4692 {
4693 mmap_regions = mmap_regions_1;
4694 mmap_fd = mmap_fd_1;
4695 for (r = mmap_regions; r; r = r->next)
4696 *r->var = MMAP_USER_AREA (r);
4697 }
4698 else
4699 {
4700 for (r = mmap_regions; r; r = r->next)
4701 *r->var = NULL;
4702 mmap_regions_1 = mmap_regions;
4703 mmap_regions = NULL;
4704 mmap_fd_1 = mmap_fd;
4705 mmap_fd = -1;
4706 }
4707 }
4708
4709
4710 /* Allocate a block of storage large enough to hold NBYTES bytes of
4711 data. A pointer to the data is returned in *VAR. VAR is thus the
4712 address of some variable which will use the data area.
4713
4714 The allocation of 0 bytes is valid.
4715
4716 If we can't allocate the necessary memory, set *VAR to null, and
4717 return null. */
4718
4719 static POINTER_TYPE *
4720 mmap_alloc (var, nbytes)
4721 POINTER_TYPE **var;
4722 size_t nbytes;
4723 {
4724 void *p;
4725 size_t map;
4726
4727 mmap_init ();
4728
4729 map = ROUND (nbytes + MMAP_REGION_STRUCT_SIZE, mmap_page_size);
4730 p = mmap (NULL, map, PROT_READ | PROT_WRITE, MAP_ANON | MAP_PRIVATE,
4731 mmap_fd, 0);
4732
4733 if (p == MAP_FAILED)
4734 {
4735 if (errno != ENOMEM)
4736 fprintf (stderr, "mmap: %s\n", emacs_strerror (errno));
4737 p = NULL;
4738 }
4739 else
4740 {
4741 struct mmap_region *r = (struct mmap_region *) p;
4742
4743 r->nbytes_specified = nbytes;
4744 r->nbytes_mapped = map;
4745 r->var = var;
4746 r->prev = NULL;
4747 r->next = mmap_regions;
4748 if (r->next)
4749 r->next->prev = r;
4750 mmap_regions = r;
4751
4752 p = MMAP_USER_AREA (p);
4753 }
4754
4755 return *var = p;
4756 }
4757
4758
4759 /* Given a pointer at address VAR to data allocated with mmap_alloc,
4760 resize it to size NBYTES. Change *VAR to reflect the new block,
4761 and return this value. If more memory cannot be allocated, then
4762 leave *VAR unchanged, and return null. */
4763
4764 static POINTER_TYPE *
4765 mmap_realloc (var, nbytes)
4766 POINTER_TYPE **var;
4767 size_t nbytes;
4768 {
4769 POINTER_TYPE *result;
4770
4771 mmap_init ();
4772
4773 if (*var == NULL)
4774 result = mmap_alloc (var, nbytes);
4775 else if (nbytes == 0)
4776 {
4777 mmap_free (var);
4778 result = mmap_alloc (var, nbytes);
4779 }
4780 else
4781 {
4782 struct mmap_region *r = MMAP_REGION (*var);
4783 size_t room = r->nbytes_mapped - MMAP_REGION_STRUCT_SIZE;
4784
4785 if (room < nbytes)
4786 {
4787 /* Must enlarge. */
4788 POINTER_TYPE *old_ptr = *var;
4789
4790 /* Try to map additional pages at the end of the region.
4791 If that fails, allocate a new region, copy data
4792 from the old region, then free it. */
4793 if (mmap_enlarge (r, (ROUND (nbytes - room, mmap_page_size)
4794 / mmap_page_size)))
4795 {
4796 r->nbytes_specified = nbytes;
4797 *var = result = old_ptr;
4798 }
4799 else if (mmap_alloc (var, nbytes))
4800 {
4801 bcopy (old_ptr, *var, r->nbytes_specified);
4802 mmap_free_1 (MMAP_REGION (old_ptr));
4803 result = *var;
4804 r = MMAP_REGION (result);
4805 r->nbytes_specified = nbytes;
4806 }
4807 else
4808 {
4809 *var = old_ptr;
4810 result = NULL;
4811 }
4812 }
4813 else if (room - nbytes >= mmap_page_size)
4814 {
4815 /* Shrinking by at least a page. Let's give some
4816 memory back to the system.
4817
4818 The extra parens are to make the division happens first,
4819 on positive values, so we know it will round towards
4820 zero. */
4821 mmap_enlarge (r, - ((room - nbytes) / mmap_page_size));
4822 result = *var;
4823 r->nbytes_specified = nbytes;
4824 }
4825 else
4826 {
4827 /* Leave it alone. */
4828 result = *var;
4829 r->nbytes_specified = nbytes;
4830 }
4831 }
4832
4833 return result;
4834 }
4835
4836
4837 /* Free a block of relocatable storage whose data is pointed to by
4838 PTR. Store 0 in *PTR to show there's no block allocated. */
4839
4840 static void
4841 mmap_free (var)
4842 POINTER_TYPE **var;
4843 {
4844 mmap_init ();
4845
4846 if (*var)
4847 {
4848 mmap_free_1 (MMAP_REGION (*var));
4849 *var = NULL;
4850 }
4851 }
4852
4853
4854 /* Perform necessary intializations for the use of mmap. */
4855
4856 static void
4857 mmap_init ()
4858 {
4859 #if MAP_ANON == 0
4860 /* The value of mmap_fd is initially 0 in temacs, and -1
4861 in a dumped Emacs. */
4862 if (mmap_fd <= 0)
4863 {
4864 /* No anonymous mmap -- we need the file descriptor. */
4865 mmap_fd = open ("/dev/zero", O_RDONLY);
4866 if (mmap_fd == -1)
4867 fatal ("Cannot open /dev/zero: %s", emacs_strerror (errno));
4868 }
4869 #endif /* MAP_ANON == 0 */
4870
4871 if (mmap_initialized_p)
4872 return;
4873 mmap_initialized_p = 1;
4874
4875 #if MAP_ANON != 0
4876 mmap_fd = -1;
4877 #endif
4878
4879 mmap_page_size = getpagesize ();
4880 }
4881
4882 #endif /* USE_MMAP_FOR_BUFFERS */
4883
4884
4885 \f
4886 /***********************************************************************
4887 Buffer-text Allocation
4888 ***********************************************************************/
4889
4890 #ifdef REL_ALLOC
4891 extern POINTER_TYPE *r_alloc P_ ((POINTER_TYPE **, size_t));
4892 extern POINTER_TYPE *r_re_alloc P_ ((POINTER_TYPE **, size_t));
4893 extern void r_alloc_free P_ ((POINTER_TYPE **ptr));
4894 #endif /* REL_ALLOC */
4895
4896
4897 /* Allocate NBYTES bytes for buffer B's text buffer. */
4898
4899 static void
4900 alloc_buffer_text (b, nbytes)
4901 struct buffer *b;
4902 size_t nbytes;
4903 {
4904 POINTER_TYPE *p;
4905
4906 BLOCK_INPUT;
4907 #if defined USE_MMAP_FOR_BUFFERS
4908 p = mmap_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4909 #elif defined REL_ALLOC
4910 p = r_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4911 #else
4912 p = xmalloc (nbytes);
4913 #endif
4914
4915 if (p == NULL)
4916 {
4917 UNBLOCK_INPUT;
4918 memory_full ();
4919 }
4920
4921 b->text->beg = (unsigned char *) p;
4922 UNBLOCK_INPUT;
4923 }
4924
4925 /* Enlarge buffer B's text buffer by DELTA bytes. DELTA < 0 means
4926 shrink it. */
4927
4928 void
4929 enlarge_buffer_text (b, delta)
4930 struct buffer *b;
4931 int delta;
4932 {
4933 POINTER_TYPE *p;
4934 size_t nbytes = (BUF_Z_BYTE (b) - BUF_BEG_BYTE (b) + BUF_GAP_SIZE (b) + 1
4935 + delta);
4936 BLOCK_INPUT;
4937 #if defined USE_MMAP_FOR_BUFFERS
4938 p = mmap_realloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4939 #elif defined REL_ALLOC
4940 p = r_re_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4941 #else
4942 p = xrealloc (b->text->beg, nbytes);
4943 #endif
4944
4945 if (p == NULL)
4946 {
4947 UNBLOCK_INPUT;
4948 memory_full ();
4949 }
4950
4951 BUF_BEG_ADDR (b) = (unsigned char *) p;
4952 UNBLOCK_INPUT;
4953 }
4954
4955
4956 /* Free buffer B's text buffer. */
4957
4958 static void
4959 free_buffer_text (b)
4960 struct buffer *b;
4961 {
4962 BLOCK_INPUT;
4963
4964 #if defined USE_MMAP_FOR_BUFFERS
4965 mmap_free ((POINTER_TYPE **) &b->text->beg);
4966 #elif defined REL_ALLOC
4967 r_alloc_free ((POINTER_TYPE **) &b->text->beg);
4968 #else
4969 xfree (b->text->beg);
4970 #endif
4971
4972 BUF_BEG_ADDR (b) = NULL;
4973 UNBLOCK_INPUT;
4974 }
4975
4976
4977 \f
4978 /***********************************************************************
4979 Initialization
4980 ***********************************************************************/
4981
4982 void
4983 init_buffer_once ()
4984 {
4985 int idx;
4986
4987 bzero (buffer_permanent_local_flags, sizeof buffer_permanent_local_flags);
4988
4989 /* Make sure all markable slots in buffer_defaults
4990 are initialized reasonably, so mark_buffer won't choke. */
4991 reset_buffer (&buffer_defaults);
4992 reset_buffer_local_variables (&buffer_defaults, 1);
4993 reset_buffer (&buffer_local_symbols);
4994 reset_buffer_local_variables (&buffer_local_symbols, 1);
4995 /* Prevent GC from getting confused. */
4996 buffer_defaults.text = &buffer_defaults.own_text;
4997 buffer_local_symbols.text = &buffer_local_symbols.own_text;
4998 BUF_INTERVALS (&buffer_defaults) = 0;
4999 BUF_INTERVALS (&buffer_local_symbols) = 0;
5000 XSETBUFFER (Vbuffer_defaults, &buffer_defaults);
5001 XSETBUFFER (Vbuffer_local_symbols, &buffer_local_symbols);
5002
5003 /* Set up the default values of various buffer slots. */
5004 /* Must do these before making the first buffer! */
5005
5006 /* real setup is done in bindings.el */
5007 buffer_defaults.mode_line_format = build_string ("%-");
5008 buffer_defaults.header_line_format = Qnil;
5009 buffer_defaults.abbrev_mode = Qnil;
5010 buffer_defaults.overwrite_mode = Qnil;
5011 buffer_defaults.case_fold_search = Qt;
5012 buffer_defaults.auto_fill_function = Qnil;
5013 buffer_defaults.selective_display = Qnil;
5014 #ifndef old
5015 buffer_defaults.selective_display_ellipses = Qt;
5016 #endif
5017 buffer_defaults.abbrev_table = Qnil;
5018 buffer_defaults.display_table = Qnil;
5019 buffer_defaults.undo_list = Qnil;
5020 buffer_defaults.mark_active = Qnil;
5021 buffer_defaults.file_format = Qnil;
5022 buffer_defaults.auto_save_file_format = Qt;
5023 buffer_defaults.overlays_before = NULL;
5024 buffer_defaults.overlays_after = NULL;
5025 buffer_defaults.overlay_center = BEG;
5026
5027 XSETFASTINT (buffer_defaults.tab_width, 8);
5028 buffer_defaults.truncate_lines = Qnil;
5029 buffer_defaults.ctl_arrow = Qt;
5030 buffer_defaults.direction_reversed = Qnil;
5031 buffer_defaults.cursor_type = Qt;
5032 buffer_defaults.extra_line_spacing = Qnil;
5033 buffer_defaults.cursor_in_non_selected_windows = Qt;
5034
5035 #ifdef DOS_NT
5036 buffer_defaults.buffer_file_type = Qnil; /* TEXT */
5037 #endif
5038 buffer_defaults.enable_multibyte_characters = Qt;
5039 buffer_defaults.buffer_file_coding_system = Qnil;
5040 XSETFASTINT (buffer_defaults.fill_column, 70);
5041 XSETFASTINT (buffer_defaults.left_margin, 0);
5042 buffer_defaults.cache_long_line_scans = Qnil;
5043 buffer_defaults.file_truename = Qnil;
5044 XSETFASTINT (buffer_defaults.display_count, 0);
5045 XSETFASTINT (buffer_defaults.left_margin_cols, 0);
5046 XSETFASTINT (buffer_defaults.right_margin_cols, 0);
5047 buffer_defaults.left_fringe_width = Qnil;
5048 buffer_defaults.right_fringe_width = Qnil;
5049 buffer_defaults.fringes_outside_margins = Qnil;
5050 buffer_defaults.scroll_bar_width = Qnil;
5051 buffer_defaults.vertical_scroll_bar_type = Qt;
5052 buffer_defaults.indicate_empty_lines = Qnil;
5053 buffer_defaults.indicate_buffer_boundaries = Qnil;
5054 buffer_defaults.fringe_indicator_alist = Qnil;
5055 buffer_defaults.fringe_cursor_alist = Qnil;
5056 buffer_defaults.scroll_up_aggressively = Qnil;
5057 buffer_defaults.scroll_down_aggressively = Qnil;
5058 buffer_defaults.display_time = Qnil;
5059
5060 /* Assign the local-flags to the slots that have default values.
5061 The local flag is a bit that is used in the buffer
5062 to say that it has its own local value for the slot.
5063 The local flag bits are in the local_var_flags slot of the buffer. */
5064
5065 /* Nothing can work if this isn't true */
5066 if (sizeof (EMACS_INT) != sizeof (Lisp_Object)) abort ();
5067
5068 /* 0 means not a lisp var, -1 means always local, else mask */
5069 bzero (&buffer_local_flags, sizeof buffer_local_flags);
5070 XSETINT (buffer_local_flags.filename, -1);
5071 XSETINT (buffer_local_flags.directory, -1);
5072 XSETINT (buffer_local_flags.backed_up, -1);
5073 XSETINT (buffer_local_flags.save_length, -1);
5074 XSETINT (buffer_local_flags.auto_save_file_name, -1);
5075 XSETINT (buffer_local_flags.read_only, -1);
5076 XSETINT (buffer_local_flags.major_mode, -1);
5077 XSETINT (buffer_local_flags.mode_name, -1);
5078 XSETINT (buffer_local_flags.undo_list, -1);
5079 XSETINT (buffer_local_flags.mark_active, -1);
5080 XSETINT (buffer_local_flags.point_before_scroll, -1);
5081 XSETINT (buffer_local_flags.file_truename, -1);
5082 XSETINT (buffer_local_flags.invisibility_spec, -1);
5083 XSETINT (buffer_local_flags.file_format, -1);
5084 XSETINT (buffer_local_flags.auto_save_file_format, -1);
5085 XSETINT (buffer_local_flags.display_count, -1);
5086 XSETINT (buffer_local_flags.display_time, -1);
5087 XSETINT (buffer_local_flags.enable_multibyte_characters, -1);
5088
5089 idx = 1;
5090 XSETFASTINT (buffer_local_flags.mode_line_format, idx); ++idx;
5091 XSETFASTINT (buffer_local_flags.abbrev_mode, idx); ++idx;
5092 XSETFASTINT (buffer_local_flags.overwrite_mode, idx); ++idx;
5093 XSETFASTINT (buffer_local_flags.case_fold_search, idx); ++idx;
5094 XSETFASTINT (buffer_local_flags.auto_fill_function, idx); ++idx;
5095 XSETFASTINT (buffer_local_flags.selective_display, idx); ++idx;
5096 #ifndef old
5097 XSETFASTINT (buffer_local_flags.selective_display_ellipses, idx); ++idx;
5098 #endif
5099 XSETFASTINT (buffer_local_flags.tab_width, idx); ++idx;
5100 XSETFASTINT (buffer_local_flags.truncate_lines, idx); ++idx;
5101 XSETFASTINT (buffer_local_flags.ctl_arrow, idx); ++idx;
5102 XSETFASTINT (buffer_local_flags.fill_column, idx); ++idx;
5103 XSETFASTINT (buffer_local_flags.left_margin, idx); ++idx;
5104 XSETFASTINT (buffer_local_flags.abbrev_table, idx); ++idx;
5105 XSETFASTINT (buffer_local_flags.display_table, idx); ++idx;
5106 #ifdef DOS_NT
5107 XSETFASTINT (buffer_local_flags.buffer_file_type, idx);
5108 /* Make this one a permanent local. */
5109 buffer_permanent_local_flags[idx++] = 1;
5110 #endif
5111 XSETFASTINT (buffer_local_flags.syntax_table, idx); ++idx;
5112 XSETFASTINT (buffer_local_flags.cache_long_line_scans, idx); ++idx;
5113 XSETFASTINT (buffer_local_flags.category_table, idx); ++idx;
5114 XSETFASTINT (buffer_local_flags.direction_reversed, idx); ++idx;
5115 XSETFASTINT (buffer_local_flags.buffer_file_coding_system, idx);
5116 /* Make this one a permanent local. */
5117 buffer_permanent_local_flags[idx++] = 1;
5118 XSETFASTINT (buffer_local_flags.left_margin_cols, idx); ++idx;
5119 XSETFASTINT (buffer_local_flags.right_margin_cols, idx); ++idx;
5120 XSETFASTINT (buffer_local_flags.left_fringe_width, idx); ++idx;
5121 XSETFASTINT (buffer_local_flags.right_fringe_width, idx); ++idx;
5122 XSETFASTINT (buffer_local_flags.fringes_outside_margins, idx); ++idx;
5123 XSETFASTINT (buffer_local_flags.scroll_bar_width, idx); ++idx;
5124 XSETFASTINT (buffer_local_flags.vertical_scroll_bar_type, idx); ++idx;
5125 XSETFASTINT (buffer_local_flags.indicate_empty_lines, idx); ++idx;
5126 XSETFASTINT (buffer_local_flags.indicate_buffer_boundaries, idx); ++idx;
5127 XSETFASTINT (buffer_local_flags.fringe_indicator_alist, idx); ++idx;
5128 XSETFASTINT (buffer_local_flags.fringe_cursor_alist, idx); ++idx;
5129 XSETFASTINT (buffer_local_flags.scroll_up_aggressively, idx); ++idx;
5130 XSETFASTINT (buffer_local_flags.scroll_down_aggressively, idx); ++idx;
5131 XSETFASTINT (buffer_local_flags.header_line_format, idx); ++idx;
5132 XSETFASTINT (buffer_local_flags.cursor_type, idx); ++idx;
5133 XSETFASTINT (buffer_local_flags.extra_line_spacing, idx); ++idx;
5134 XSETFASTINT (buffer_local_flags.cursor_in_non_selected_windows, idx); ++idx;
5135
5136 /* Need more room? */
5137 if (idx >= MAX_PER_BUFFER_VARS)
5138 abort ();
5139 last_per_buffer_idx = idx;
5140
5141 Vbuffer_alist = Qnil;
5142 current_buffer = 0;
5143 all_buffers = 0;
5144
5145 QSFundamental = build_string ("Fundamental");
5146
5147 Qfundamental_mode = intern ("fundamental-mode");
5148 buffer_defaults.major_mode = Qfundamental_mode;
5149
5150 Qmode_class = intern ("mode-class");
5151
5152 Qprotected_field = intern ("protected-field");
5153
5154 Qpermanent_local = intern ("permanent-local");
5155
5156 Qkill_buffer_hook = intern ("kill-buffer-hook");
5157 Fput (Qkill_buffer_hook, Qpermanent_local, Qt);
5158
5159 Qucs_set_table_for_input = intern ("ucs-set-table-for-input");
5160
5161 Vprin1_to_string_buffer = Fget_buffer_create (build_string (" prin1"));
5162
5163 /* super-magic invisible buffer */
5164 Vbuffer_alist = Qnil;
5165
5166 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5167
5168 inhibit_modification_hooks = 0;
5169 }
5170
5171 void
5172 init_buffer ()
5173 {
5174 char *pwd;
5175 Lisp_Object temp;
5176 int len;
5177
5178 #ifdef USE_MMAP_FOR_BUFFERS
5179 {
5180 /* When using the ralloc implementation based on mmap(2), buffer
5181 text pointers will have been set to null in the dumped Emacs.
5182 Map new memory. */
5183 struct buffer *b;
5184
5185 for (b = all_buffers; b; b = b->next)
5186 if (b->text->beg == NULL)
5187 enlarge_buffer_text (b, 0);
5188 }
5189 #endif /* USE_MMAP_FOR_BUFFERS */
5190
5191 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5192 if (NILP (buffer_defaults.enable_multibyte_characters))
5193 Fset_buffer_multibyte (Qnil);
5194
5195 pwd = get_current_dir_name ();
5196
5197 if (!pwd)
5198 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno));
5199
5200 #ifndef VMS
5201 /* Maybe this should really use some standard subroutine
5202 whose definition is filename syntax dependent. */
5203 len = strlen (pwd);
5204 if (!(IS_DIRECTORY_SEP (pwd[len - 1])))
5205 {
5206 /* Grow buffer to add directory separator and '\0'. */
5207 pwd = (char *) xrealloc (pwd, len + 2);
5208 pwd[len] = DIRECTORY_SEP;
5209 pwd[len + 1] = '\0';
5210 }
5211 #endif /* not VMS */
5212
5213 current_buffer->directory = make_unibyte_string (pwd, strlen (pwd));
5214 if (! NILP (buffer_defaults.enable_multibyte_characters))
5215 /* At this moment, we still don't know how to decode the
5216 directory name. So, we keep the bytes in multibyte form so
5217 that ENCODE_FILE correctly gets the original bytes. */
5218 current_buffer->directory
5219 = string_to_multibyte (current_buffer->directory);
5220
5221 /* Add /: to the front of the name
5222 if it would otherwise be treated as magic. */
5223 temp = Ffind_file_name_handler (current_buffer->directory, Qt);
5224 if (! NILP (temp)
5225 /* If the default dir is just /, TEMP is non-nil
5226 because of the ange-ftp completion handler.
5227 However, it is not necessary to turn / into /:/.
5228 So avoid doing that. */
5229 && strcmp ("/", SDATA (current_buffer->directory)))
5230 current_buffer->directory
5231 = concat2 (build_string ("/:"), current_buffer->directory);
5232
5233 temp = get_minibuffer (0);
5234 XBUFFER (temp)->directory = current_buffer->directory;
5235
5236 free (pwd);
5237 }
5238
5239 /* initialize the buffer routines */
5240 void
5241 syms_of_buffer ()
5242 {
5243 staticpro (&last_overlay_modification_hooks);
5244 last_overlay_modification_hooks
5245 = Fmake_vector (make_number (10), Qnil);
5246
5247 staticpro (&Vbuffer_defaults);
5248 staticpro (&Vbuffer_local_symbols);
5249 staticpro (&Qfundamental_mode);
5250 staticpro (&Qmode_class);
5251 staticpro (&QSFundamental);
5252 staticpro (&Vbuffer_alist);
5253 staticpro (&Qprotected_field);
5254 staticpro (&Qpermanent_local);
5255 staticpro (&Qkill_buffer_hook);
5256 Qoverlayp = intern ("overlayp");
5257 staticpro (&Qoverlayp);
5258 Qevaporate = intern ("evaporate");
5259 staticpro (&Qevaporate);
5260 Qmodification_hooks = intern ("modification-hooks");
5261 staticpro (&Qmodification_hooks);
5262 Qinsert_in_front_hooks = intern ("insert-in-front-hooks");
5263 staticpro (&Qinsert_in_front_hooks);
5264 Qinsert_behind_hooks = intern ("insert-behind-hooks");
5265 staticpro (&Qinsert_behind_hooks);
5266 Qget_file_buffer = intern ("get-file-buffer");
5267 staticpro (&Qget_file_buffer);
5268 Qpriority = intern ("priority");
5269 staticpro (&Qpriority);
5270 Qwindow = intern ("window");
5271 staticpro (&Qwindow);
5272 Qbefore_string = intern ("before-string");
5273 staticpro (&Qbefore_string);
5274 Qafter_string = intern ("after-string");
5275 staticpro (&Qafter_string);
5276 Qfirst_change_hook = intern ("first-change-hook");
5277 staticpro (&Qfirst_change_hook);
5278 Qbefore_change_functions = intern ("before-change-functions");
5279 staticpro (&Qbefore_change_functions);
5280 Qafter_change_functions = intern ("after-change-functions");
5281 staticpro (&Qafter_change_functions);
5282 staticpro (&Qucs_set_table_for_input);
5283
5284 Qkill_buffer_query_functions = intern ("kill-buffer-query-functions");
5285 staticpro (&Qkill_buffer_query_functions);
5286
5287 Fput (Qprotected_field, Qerror_conditions,
5288 Fcons (Qprotected_field, Fcons (Qerror, Qnil)));
5289 Fput (Qprotected_field, Qerror_message,
5290 build_string ("Attempt to modify a protected field"));
5291
5292 /* All these use DEFVAR_LISP_NOPRO because the slots in
5293 buffer_defaults will all be marked via Vbuffer_defaults. */
5294
5295 DEFVAR_LISP_NOPRO ("default-mode-line-format",
5296 &buffer_defaults.mode_line_format,
5297 doc: /* Default value of `mode-line-format' for buffers that don't override it.
5298 This is the same as (default-value 'mode-line-format). */);
5299
5300 DEFVAR_LISP_NOPRO ("default-header-line-format",
5301 &buffer_defaults.header_line_format,
5302 doc: /* Default value of `header-line-format' for buffers that don't override it.
5303 This is the same as (default-value 'header-line-format). */);
5304
5305 DEFVAR_LISP_NOPRO ("default-cursor-type", &buffer_defaults.cursor_type,
5306 doc: /* Default value of `cursor-type' for buffers that don't override it.
5307 This is the same as (default-value 'cursor-type). */);
5308
5309 DEFVAR_LISP_NOPRO ("default-line-spacing",
5310 &buffer_defaults.extra_line_spacing,
5311 doc: /* Default value of `line-spacing' for buffers that don't override it.
5312 This is the same as (default-value 'line-spacing). */);
5313
5314 DEFVAR_LISP_NOPRO ("default-cursor-in-non-selected-windows",
5315 &buffer_defaults.cursor_in_non_selected_windows,
5316 doc: /* Default value of `cursor-in-non-selected-windows'.
5317 This is the same as (default-value 'cursor-in-non-selected-windows). */);
5318
5319 DEFVAR_LISP_NOPRO ("default-abbrev-mode",
5320 &buffer_defaults.abbrev_mode,
5321 doc: /* Default value of `abbrev-mode' for buffers that do not override it.
5322 This is the same as (default-value 'abbrev-mode). */);
5323
5324 DEFVAR_LISP_NOPRO ("default-ctl-arrow",
5325 &buffer_defaults.ctl_arrow,
5326 doc: /* Default value of `ctl-arrow' for buffers that do not override it.
5327 This is the same as (default-value 'ctl-arrow). */);
5328
5329 DEFVAR_LISP_NOPRO ("default-direction-reversed",
5330 &buffer_defaults.direction_reversed,
5331 doc: /* Default value of `direction-reversed' for buffers that do not override it.
5332 This is the same as (default-value 'direction-reversed). */);
5333
5334 DEFVAR_LISP_NOPRO ("default-enable-multibyte-characters",
5335 &buffer_defaults.enable_multibyte_characters,
5336 doc: /* *Default value of `enable-multibyte-characters' for buffers not overriding it.
5337 This is the same as (default-value 'enable-multibyte-characters). */);
5338
5339 DEFVAR_LISP_NOPRO ("default-buffer-file-coding-system",
5340 &buffer_defaults.buffer_file_coding_system,
5341 doc: /* Default value of `buffer-file-coding-system' for buffers not overriding it.
5342 This is the same as (default-value 'buffer-file-coding-system). */);
5343
5344 DEFVAR_LISP_NOPRO ("default-truncate-lines",
5345 &buffer_defaults.truncate_lines,
5346 doc: /* Default value of `truncate-lines' for buffers that do not override it.
5347 This is the same as (default-value 'truncate-lines). */);
5348
5349 DEFVAR_LISP_NOPRO ("default-fill-column",
5350 &buffer_defaults.fill_column,
5351 doc: /* Default value of `fill-column' for buffers that do not override it.
5352 This is the same as (default-value 'fill-column). */);
5353
5354 DEFVAR_LISP_NOPRO ("default-left-margin",
5355 &buffer_defaults.left_margin,
5356 doc: /* Default value of `left-margin' for buffers that do not override it.
5357 This is the same as (default-value 'left-margin). */);
5358
5359 DEFVAR_LISP_NOPRO ("default-tab-width",
5360 &buffer_defaults.tab_width,
5361 doc: /* Default value of `tab-width' for buffers that do not override it.
5362 This is the same as (default-value 'tab-width). */);
5363
5364 DEFVAR_LISP_NOPRO ("default-case-fold-search",
5365 &buffer_defaults.case_fold_search,
5366 doc: /* Default value of `case-fold-search' for buffers that don't override it.
5367 This is the same as (default-value 'case-fold-search). */);
5368
5369 #ifdef DOS_NT
5370 DEFVAR_LISP_NOPRO ("default-buffer-file-type",
5371 &buffer_defaults.buffer_file_type,
5372 doc: /* Default file type for buffers that do not override it.
5373 This is the same as (default-value 'buffer-file-type).
5374 The file type is nil for text, t for binary. */);
5375 #endif
5376
5377 DEFVAR_LISP_NOPRO ("default-left-margin-width",
5378 &buffer_defaults.left_margin_cols,
5379 doc: /* Default value of `left-margin-width' for buffers that don't override it.
5380 This is the same as (default-value 'left-margin-width). */);
5381
5382 DEFVAR_LISP_NOPRO ("default-right-margin-width",
5383 &buffer_defaults.right_margin_cols,
5384 doc: /* Default value of `right-margin-width' for buffers that don't override it.
5385 This is the same as (default-value 'right-margin-width). */);
5386
5387 DEFVAR_LISP_NOPRO ("default-left-fringe-width",
5388 &buffer_defaults.left_fringe_width,
5389 doc: /* Default value of `left-fringe-width' for buffers that don't override it.
5390 This is the same as (default-value 'left-fringe-width). */);
5391
5392 DEFVAR_LISP_NOPRO ("default-right-fringe-width",
5393 &buffer_defaults.right_fringe_width,
5394 doc: /* Default value of `right-fringe-width' for buffers that don't override it.
5395 This is the same as (default-value 'right-fringe-width). */);
5396
5397 DEFVAR_LISP_NOPRO ("default-fringes-outside-margins",
5398 &buffer_defaults.fringes_outside_margins,
5399 doc: /* Default value of `fringes-outside-margins' for buffers that don't override it.
5400 This is the same as (default-value 'fringes-outside-margins). */);
5401
5402 DEFVAR_LISP_NOPRO ("default-scroll-bar-width",
5403 &buffer_defaults.scroll_bar_width,
5404 doc: /* Default value of `scroll-bar-width' for buffers that don't override it.
5405 This is the same as (default-value 'scroll-bar-width). */);
5406
5407 DEFVAR_LISP_NOPRO ("default-vertical-scroll-bar",
5408 &buffer_defaults.vertical_scroll_bar_type,
5409 doc: /* Default value of `vertical-scroll-bar' for buffers that don't override it.
5410 This is the same as (default-value 'vertical-scroll-bar). */);
5411
5412 DEFVAR_LISP_NOPRO ("default-indicate-empty-lines",
5413 &buffer_defaults.indicate_empty_lines,
5414 doc: /* Default value of `indicate-empty-lines' for buffers that don't override it.
5415 This is the same as (default-value 'indicate-empty-lines). */);
5416
5417 DEFVAR_LISP_NOPRO ("default-indicate-buffer-boundaries",
5418 &buffer_defaults.indicate_buffer_boundaries,
5419 doc: /* Default value of `indicate-buffer-boundaries' for buffers that don't override it.
5420 This is the same as (default-value 'indicate-buffer-boundaries). */);
5421
5422 DEFVAR_LISP_NOPRO ("default-fringe-indicator-alist",
5423 &buffer_defaults.fringe_indicator_alist,
5424 doc: /* Default value of `fringe-indicator-alist' for buffers that don't override it.
5425 This is the same as (default-value 'fringe-indicator-alist'). */);
5426
5427 DEFVAR_LISP_NOPRO ("default-fringe-cursor-alist",
5428 &buffer_defaults.fringe_cursor_alist,
5429 doc: /* Default value of `fringe-cursor-alist' for buffers that don't override it.
5430 This is the same as (default-value 'fringe-cursor-alist'). */);
5431
5432 DEFVAR_LISP_NOPRO ("default-scroll-up-aggressively",
5433 &buffer_defaults.scroll_up_aggressively,
5434 doc: /* Default value of `scroll-up-aggressively'.
5435 This value applies in buffers that don't have their own local values.
5436 This is the same as (default-value 'scroll-up-aggressively). */);
5437
5438 DEFVAR_LISP_NOPRO ("default-scroll-down-aggressively",
5439 &buffer_defaults.scroll_down_aggressively,
5440 doc: /* Default value of `scroll-down-aggressively'.
5441 This value applies in buffers that don't have their own local values.
5442 This is the same as (default-value 'scroll-down-aggressively). */);
5443
5444 DEFVAR_PER_BUFFER ("header-line-format",
5445 &current_buffer->header_line_format,
5446 Qnil,
5447 doc: /* Analogous to `mode-line-format', but controls the header line.
5448 The header line appears, optionally, at the top of a window;
5449 the mode line appears at the bottom. */);
5450
5451 DEFVAR_PER_BUFFER ("mode-line-format", &current_buffer->mode_line_format,
5452 Qnil,
5453 doc: /* Template for displaying mode line for current buffer.
5454 Each buffer has its own value of this variable.
5455 Value may be nil, a string, a symbol or a list or cons cell.
5456 A value of nil means don't display a mode line.
5457 For a symbol, its value is used (but it is ignored if t or nil).
5458 A string appearing directly as the value of a symbol is processed verbatim
5459 in that the %-constructs below are not recognized.
5460 Note that unless the symbol is marked as a `risky-local-variable', all
5461 properties in any strings, as well as all :eval and :propertize forms
5462 in the value of that symbol will be ignored.
5463 For a list of the form `(:eval FORM)', FORM is evaluated and the result
5464 is used as a mode line element. Be careful--FORM should not load any files,
5465 because that can cause an infinite recursion.
5466 For a list of the form `(:propertize ELT PROPS...)', ELT is displayed
5467 with the specified properties PROPS applied.
5468 For a list whose car is a symbol, the symbol's value is taken,
5469 and if that is non-nil, the cadr of the list is processed recursively.
5470 Otherwise, the caddr of the list (if there is one) is processed.
5471 For a list whose car is a string or list, each element is processed
5472 recursively and the results are effectively concatenated.
5473 For a list whose car is an integer, the cdr of the list is processed
5474 and padded (if the number is positive) or truncated (if negative)
5475 to the width specified by that number.
5476 A string is printed verbatim in the mode line except for %-constructs:
5477 (%-constructs are allowed when the string is the entire mode-line-format
5478 or when it is found in a cons-cell or a list)
5479 %b -- print buffer name. %f -- print visited file name.
5480 %F -- print frame name.
5481 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.
5482 %& is like %*, but ignore read-only-ness.
5483 % means buffer is read-only and * means it is modified.
5484 For a modified read-only buffer, %* gives % and %+ gives *.
5485 %s -- print process status. %l -- print the current line number.
5486 %c -- print the current column number (this makes editing slower).
5487 To make the column number update correctly in all cases,
5488 `column-number-mode' must be non-nil.
5489 %i -- print the size of the buffer.
5490 %I -- like %i, but use k, M, G, etc., to abbreviate.
5491 %p -- print percent of buffer above top of window, or Top, Bot or All.
5492 %P -- print percent of buffer above bottom of window, perhaps plus Top,
5493 or print Bottom or All.
5494 %n -- print Narrow if appropriate.
5495 %t -- visited file is text or binary (if OS supports this distinction).
5496 %z -- print mnemonics of keyboard, terminal, and buffer coding systems.
5497 %Z -- like %z, but including the end-of-line format.
5498 %e -- print error message about full memory.
5499 %[ -- print one [ for each recursive editing level. %] similar.
5500 %% -- print %. %- -- print infinitely many dashes.
5501 Decimal digits after the % specify field width to which to pad. */);
5502
5503 DEFVAR_LISP_NOPRO ("default-major-mode", &buffer_defaults.major_mode,
5504 doc: /* *Major mode for new buffers. Defaults to `fundamental-mode'.
5505 A value of nil means use current buffer's major mode,
5506 provided it is not marked as "special".
5507
5508 When a mode is used by default, `find-file' switches to it
5509 before it reads the contents into the buffer and before
5510 it finishes setting up the buffer. Thus, the mode and
5511 its hooks should not expect certain variables such as
5512 `buffer-read-only' and `buffer-file-coding-system' to be set up. */);
5513
5514 DEFVAR_PER_BUFFER ("major-mode", &current_buffer->major_mode,
5515 make_number (Lisp_Symbol),
5516 doc: /* Symbol for current buffer's major mode. */);
5517
5518 DEFVAR_PER_BUFFER ("mode-name", &current_buffer->mode_name,
5519 Qnil,
5520 doc: /* Pretty name of current buffer's major mode (a string). */);
5521
5522 DEFVAR_PER_BUFFER ("abbrev-mode", &current_buffer->abbrev_mode, Qnil,
5523 doc: /* Non-nil turns on automatic expansion of abbrevs as they are inserted. */);
5524
5525 DEFVAR_PER_BUFFER ("case-fold-search", &current_buffer->case_fold_search,
5526 Qnil,
5527 doc: /* *Non-nil if searches and matches should ignore case. */);
5528
5529 DEFVAR_PER_BUFFER ("fill-column", &current_buffer->fill_column,
5530 make_number (Lisp_Int),
5531 doc: /* *Column beyond which automatic line-wrapping should happen.
5532 Interactively, you can set the buffer local value using \\[set-fill-column]. */);
5533
5534 DEFVAR_PER_BUFFER ("left-margin", &current_buffer->left_margin,
5535 make_number (Lisp_Int),
5536 doc: /* *Column for the default `indent-line-function' to indent to.
5537 Linefeed indents to this column in Fundamental mode. */);
5538
5539 DEFVAR_PER_BUFFER ("tab-width", &current_buffer->tab_width,
5540 make_number (Lisp_Int),
5541 doc: /* *Distance between tab stops (for display of tab characters), in columns. */);
5542
5543 DEFVAR_PER_BUFFER ("ctl-arrow", &current_buffer->ctl_arrow, Qnil,
5544 doc: /* *Non-nil means display control chars with uparrow.
5545 A value of nil means use backslash and octal digits.
5546 This variable does not apply to characters whose display is specified
5547 in the current display table (if there is one). */);
5548
5549 DEFVAR_PER_BUFFER ("enable-multibyte-characters",
5550 &current_buffer->enable_multibyte_characters,
5551 Qnil,
5552 doc: /* Non-nil means the buffer contents are regarded as multi-byte characters.
5553 Otherwise they are regarded as unibyte. This affects the display,
5554 file I/O and the behavior of various editing commands.
5555
5556 This variable is buffer-local but you cannot set it directly;
5557 use the function `set-buffer-multibyte' to change a buffer's representation.
5558 Changing its default value with `setq-default' is supported.
5559 See also variable `default-enable-multibyte-characters' and Info node
5560 `(elisp)Text Representations'. */);
5561 XSYMBOL (intern ("enable-multibyte-characters"))->constant = 1;
5562
5563 DEFVAR_PER_BUFFER ("buffer-file-coding-system",
5564 &current_buffer->buffer_file_coding_system, Qnil,
5565 doc: /* Coding system to be used for encoding the buffer contents on saving.
5566 This variable applies to saving the buffer, and also to `write-region'
5567 and other functions that use `write-region'.
5568 It does not apply to sending output to subprocesses, however.
5569
5570 If this is nil, the buffer is saved without any code conversion
5571 unless some coding system is specified in `file-coding-system-alist'
5572 for the buffer file.
5573
5574 If the text to be saved cannot be encoded as specified by this variable,
5575 an alternative encoding is selected by `select-safe-coding-system', which see.
5576
5577 The variable `coding-system-for-write', if non-nil, overrides this variable.
5578
5579 This variable is never applied to a way of decoding a file while reading it. */);
5580
5581 DEFVAR_PER_BUFFER ("direction-reversed", &current_buffer->direction_reversed,
5582 Qnil,
5583 doc: /* *Non-nil means lines in the buffer are displayed right to left. */);
5584
5585 DEFVAR_PER_BUFFER ("truncate-lines", &current_buffer->truncate_lines, Qnil,
5586 doc: /* *Non-nil means do not display continuation lines.
5587 Instead, give each line of text just one screen line.
5588
5589 Note that this is overridden by the variable
5590 `truncate-partial-width-windows' if that variable is non-nil
5591 and this buffer is not full-frame width. */);
5592
5593 #ifdef DOS_NT
5594 DEFVAR_PER_BUFFER ("buffer-file-type", &current_buffer->buffer_file_type,
5595 Qnil,
5596 doc: /* Non-nil if the visited file is a binary file.
5597 This variable is meaningful on MS-DOG and Windows NT.
5598 On those systems, it is automatically local in every buffer.
5599 On other systems, this variable is normally always nil. */);
5600 #endif
5601
5602 DEFVAR_PER_BUFFER ("default-directory", &current_buffer->directory,
5603 make_number (Lisp_String),
5604 doc: /* Name of default directory of current buffer. Should end with slash.
5605 To interactively change the default directory, use command `cd'. */);
5606
5607 DEFVAR_PER_BUFFER ("auto-fill-function", &current_buffer->auto_fill_function,
5608 Qnil,
5609 doc: /* Function called (if non-nil) to perform auto-fill.
5610 It is called after self-inserting any character specified in
5611 the `auto-fill-chars' table.
5612 NOTE: This variable is not a hook;
5613 its value may not be a list of functions. */);
5614
5615 DEFVAR_PER_BUFFER ("buffer-file-name", &current_buffer->filename,
5616 make_number (Lisp_String),
5617 doc: /* Name of file visited in current buffer, or nil if not visiting a file. */);
5618
5619 DEFVAR_PER_BUFFER ("buffer-file-truename", &current_buffer->file_truename,
5620 make_number (Lisp_String),
5621 doc: /* Abbreviated truename of file visited in current buffer, or nil if none.
5622 The truename of a file is calculated by `file-truename'
5623 and then abbreviated with `abbreviate-file-name'. */);
5624
5625 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
5626 &current_buffer->auto_save_file_name,
5627 make_number (Lisp_String),
5628 doc: /* Name of file for auto-saving current buffer.
5629 If it is nil, that means don't auto-save this buffer. */);
5630
5631 DEFVAR_PER_BUFFER ("buffer-read-only", &current_buffer->read_only, Qnil,
5632 doc: /* Non-nil if this buffer is read-only. */);
5633
5634 DEFVAR_PER_BUFFER ("buffer-backed-up", &current_buffer->backed_up, Qnil,
5635 doc: /* Non-nil if this buffer's file has been backed up.
5636 Backing up is done before the first time the file is saved. */);
5637
5638 DEFVAR_PER_BUFFER ("buffer-saved-size", &current_buffer->save_length,
5639 make_number (Lisp_Int),
5640 doc: /* Length of current buffer when last read in, saved or auto-saved.
5641 0 initially. */);
5642
5643 DEFVAR_PER_BUFFER ("selective-display", &current_buffer->selective_display,
5644 Qnil,
5645 doc: /* Non-nil enables selective display.
5646 An Integer N as value means display only lines
5647 that start with less than n columns of space.
5648 A value of t means that the character ^M makes itself and
5649 all the rest of the line invisible; also, when saving the buffer
5650 in a file, save the ^M as a newline. */);
5651
5652 #ifndef old
5653 DEFVAR_PER_BUFFER ("selective-display-ellipses",
5654 &current_buffer->selective_display_ellipses,
5655 Qnil,
5656 doc: /* Non-nil means display ... on previous line when a line is invisible. */);
5657 #endif
5658
5659 DEFVAR_PER_BUFFER ("overwrite-mode", &current_buffer->overwrite_mode, Qnil,
5660 doc: /* Non-nil if self-insertion should replace existing text.
5661 The value should be one of `overwrite-mode-textual',
5662 `overwrite-mode-binary', or nil.
5663 If it is `overwrite-mode-textual', self-insertion still
5664 inserts at the end of a line, and inserts when point is before a tab,
5665 until the tab is filled in.
5666 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too. */);
5667
5668 DEFVAR_PER_BUFFER ("buffer-display-table", &current_buffer->display_table,
5669 Qnil,
5670 doc: /* Display table that controls display of the contents of current buffer.
5671
5672 If this variable is nil, the value of `standard-display-table' is used.
5673 Each window can have its own, overriding display table, see
5674 `set-window-display-table' and `window-display-table'.
5675
5676 The display table is a char-table created with `make-display-table'.
5677 A char-table is an array indexed by character codes. Normal array
5678 primitives `aref' and `aset' can be used to access elements of a char-table.
5679
5680 Each of the char-table elements control how to display the corresponding
5681 text character: the element at index C in the table says how to display
5682 the character whose code is C. Each element should be a vector of
5683 characters or nil. The value nil means display the character in the
5684 default fashion; otherwise, the characters from the vector are delivered
5685 to the screen instead of the original character.
5686
5687 For example, (aset buffer-display-table ?X [?Y]) tells Emacs
5688 to display a capital Y instead of each X character.
5689
5690 In addition, a char-table has six extra slots to control the display of:
5691
5692 the end of a truncated screen line (extra-slot 0, a single character);
5693 the end of a continued line (extra-slot 1, a single character);
5694 the escape character used to display character codes in octal
5695 (extra-slot 2, a single character);
5696 the character used as an arrow for control characters (extra-slot 3,
5697 a single character);
5698 the decoration indicating the presence of invisible lines (extra-slot 4,
5699 a vector of characters);
5700 the character used to draw the border between side-by-side windows
5701 (extra-slot 5, a single character).
5702
5703 See also the functions `display-table-slot' and `set-display-table-slot'. */);
5704
5705 DEFVAR_PER_BUFFER ("left-margin-width", &current_buffer->left_margin_cols,
5706 Qnil,
5707 doc: /* *Width of left marginal area for display of a buffer.
5708 A value of nil means no marginal area. */);
5709
5710 DEFVAR_PER_BUFFER ("right-margin-width", &current_buffer->right_margin_cols,
5711 Qnil,
5712 doc: /* *Width of right marginal area for display of a buffer.
5713 A value of nil means no marginal area. */);
5714
5715 DEFVAR_PER_BUFFER ("left-fringe-width", &current_buffer->left_fringe_width,
5716 Qnil,
5717 doc: /* *Width of this buffer's left fringe (in pixels).
5718 A value of 0 means no left fringe is shown in this buffer's window.
5719 A value of nil means to use the left fringe width from the window's frame. */);
5720
5721 DEFVAR_PER_BUFFER ("right-fringe-width", &current_buffer->right_fringe_width,
5722 Qnil,
5723 doc: /* *Width of this buffer's right fringe (in pixels).
5724 A value of 0 means no right fringe is shown in this buffer's window.
5725 A value of nil means to use the right fringe width from the window's frame. */);
5726
5727 DEFVAR_PER_BUFFER ("fringes-outside-margins", &current_buffer->fringes_outside_margins,
5728 Qnil,
5729 doc: /* *Non-nil means to display fringes outside display margins.
5730 A value of nil means to display fringes between margins and buffer text. */);
5731
5732 DEFVAR_PER_BUFFER ("scroll-bar-width", &current_buffer->scroll_bar_width,
5733 Qnil,
5734 doc: /* *Width of this buffer's scroll bars in pixels.
5735 A value of nil means to use the scroll bar width from the window's frame. */);
5736
5737 DEFVAR_PER_BUFFER ("vertical-scroll-bar", &current_buffer->vertical_scroll_bar_type,
5738 Qnil,
5739 doc: /* *Position of this buffer's vertical scroll bar.
5740 The value takes effect whenever you tell a window to display this buffer;
5741 for instance, with `set-window-buffer' or when `display-buffer' displays it.
5742
5743 A value of `left' or `right' means put the vertical scroll bar at that side
5744 of the window; a value of nil means don't show any vertical scroll bars.
5745 A value of t (the default) means do whatever the window's frame specifies. */);
5746
5747 DEFVAR_PER_BUFFER ("indicate-empty-lines",
5748 &current_buffer->indicate_empty_lines, Qnil,
5749 doc: /* *Visually indicate empty lines after the buffer end.
5750 If non-nil, a bitmap is displayed in the left fringe of a window on
5751 window-systems. */);
5752
5753 DEFVAR_PER_BUFFER ("indicate-buffer-boundaries",
5754 &current_buffer->indicate_buffer_boundaries, Qnil,
5755 doc: /* *Visually indicate buffer boundaries and scrolling.
5756 If non-nil, the first and last line of the buffer are marked in the fringe
5757 of a window on window-systems with angle bitmaps, or if the window can be
5758 scrolled, the top and bottom line of the window are marked with up and down
5759 arrow bitmaps.
5760
5761 If value is a symbol `left' or `right', both angle and arrow bitmaps
5762 are displayed in the left or right fringe, resp. Any other value
5763 that doesn't look like an alist means display the angle bitmaps in
5764 the left fringe but no arrows.
5765
5766 You can exercise more precise control by using an alist as the
5767 value. Each alist element (INDICATOR . POSITION) specifies
5768 where to show one of the indicators. INDICATOR is one of `top',
5769 `bottom', `up', `down', or t, which specifies the default position,
5770 and POSITION is one of `left', `right', or nil, meaning do not show
5771 this indicator.
5772
5773 For example, ((top . left) (t . right)) places the top angle bitmap in
5774 left fringe, the bottom angle bitmap in right fringe, and both arrow
5775 bitmaps in right fringe. To show just the angle bitmaps in the left
5776 fringe, but no arrow bitmaps, use ((top . left) (bottom . left)). */);
5777
5778 DEFVAR_PER_BUFFER ("fringe-indicator-alist",
5779 &current_buffer->fringe_indicator_alist, Qnil,
5780 doc: /* *Mapping from logical to physical fringe indicator bitmaps.
5781 The value is an alist where each element (INDICATOR . BITMAPS)
5782 specifies the fringe bitmaps used to display a specific logical
5783 fringe indicator.
5784
5785 INDICATOR specifies the logical indicator type which is one of the
5786 following symbols: `truncation' , `continuation', `overlay-arrow',
5787 `top', `bottom', `up', `down', `one-line', `empty-line', or `unknown'.
5788
5789 BITMAPS is list of symbols (LEFT RIGHT [LEFT1 RIGHT1]) which specifies
5790 the actual bitmap shown in the left or right fringe for the logical
5791 indicator. LEFT and RIGHT are the bitmaps shown in the left and/or
5792 right fringe for the specific indicator. The LEFT1 or RIGHT1 bitmaps
5793 are used only for the `bottom' and `one-line' indicators when the last
5794 \(only) line in has no final newline. BITMAPS may also be a single
5795 symbol which is used in both left and right fringes. */);
5796
5797 DEFVAR_PER_BUFFER ("fringe-cursor-alist",
5798 &current_buffer->fringe_cursor_alist, Qnil,
5799 doc: /* *Mapping from logical to physical fringe cursor bitmaps.
5800 The value is an alist where each element (CURSOR . BITMAP)
5801 specifies the fringe bitmaps used to display a specific logical
5802 cursor type in the fringe.
5803
5804 CURSOR specifies the logical cursor type which is one of the following
5805 symbols: `box' , `hollow', `bar', `hbar', or `hollow-small'. The last
5806 one is used to show a hollow cursor on narrow lines display lines
5807 where the normal hollow cursor will not fit.
5808
5809 BITMAP is the corresponding fringe bitmap shown for the logical
5810 cursor type. */);
5811
5812 DEFVAR_PER_BUFFER ("scroll-up-aggressively",
5813 &current_buffer->scroll_up_aggressively, Qnil,
5814 doc: /* How far to scroll windows upward.
5815 If you move point off the bottom, the window scrolls automatically.
5816 This variable controls how far it scrolls. The value nil, the default,
5817 means scroll to center point. A fraction means scroll to put point
5818 that fraction of the window's height from the bottom of the window.
5819 When the value is 0.0, point goes at the bottom line, which in the simple
5820 case that you moved off with C-f means scrolling just one line. 1.0 means
5821 point goes at the top, so that in that simple case, the window
5822 scrolls by a full window height. Meaningful values are
5823 between 0.0 and 1.0, inclusive. */);
5824
5825 DEFVAR_PER_BUFFER ("scroll-down-aggressively",
5826 &current_buffer->scroll_down_aggressively, Qnil,
5827 doc: /* How far to scroll windows downward.
5828 If you move point off the top, the window scrolls automatically.
5829 This variable controls how far it scrolls. The value nil, the default,
5830 means scroll to center point. A fraction means scroll to put point
5831 that fraction of the window's height from the top of the window.
5832 When the value is 0.0, point goes at the top line, which in the simple
5833 case that you moved off with C-b means scrolling just one line. 1.0 means
5834 point goes at the bottom, so that in that simple case, the window
5835 scrolls by a full window height. Meaningful values are
5836 between 0.0 and 1.0, inclusive. */);
5837
5838 /*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
5839 "Don't ask.");
5840 */
5841
5842 DEFVAR_LISP ("before-change-functions", &Vbefore_change_functions,
5843 doc: /* List of functions to call before each text change.
5844 Two arguments are passed to each function: the positions of
5845 the beginning and end of the range of old text to be changed.
5846 \(For an insertion, the beginning and end are at the same place.)
5847 No information is given about the length of the text after the change.
5848
5849 Buffer changes made while executing the `before-change-functions'
5850 don't call any before-change or after-change functions.
5851 That's because these variables are temporarily set to nil.
5852 As a result, a hook function cannot straightforwardly alter the value of
5853 these variables. See the Emacs Lisp manual for a way of
5854 accomplishing an equivalent result by using other variables.
5855
5856 If an unhandled error happens in running these functions,
5857 the variable's value remains nil. That prevents the error
5858 from happening repeatedly and making Emacs nonfunctional. */);
5859 Vbefore_change_functions = Qnil;
5860
5861 DEFVAR_LISP ("after-change-functions", &Vafter_change_functions,
5862 doc: /* List of functions to call after each text change.
5863 Three arguments are passed to each function: the positions of
5864 the beginning and end of the range of changed text,
5865 and the length in bytes of the pre-change text replaced by that range.
5866 \(For an insertion, the pre-change length is zero;
5867 for a deletion, that length is the number of bytes deleted,
5868 and the post-change beginning and end are at the same place.)
5869
5870 Buffer changes made while executing the `after-change-functions'
5871 don't call any before-change or after-change functions.
5872 That's because these variables are temporarily set to nil.
5873 As a result, a hook function cannot straightforwardly alter the value of
5874 these variables. See the Emacs Lisp manual for a way of
5875 accomplishing an equivalent result by using other variables.
5876
5877 If an unhandled error happens in running these functions,
5878 the variable's value remains nil. That prevents the error
5879 from happening repeatedly and making Emacs nonfunctional. */);
5880 Vafter_change_functions = Qnil;
5881
5882 DEFVAR_LISP ("first-change-hook", &Vfirst_change_hook,
5883 doc: /* A list of functions to call before changing a buffer which is unmodified.
5884 The functions are run using the `run-hooks' function. */);
5885 Vfirst_change_hook = Qnil;
5886
5887 DEFVAR_PER_BUFFER ("buffer-undo-list", &current_buffer->undo_list, Qnil,
5888 doc: /* List of undo entries in current buffer.
5889 Recent changes come first; older changes follow newer.
5890
5891 An entry (BEG . END) represents an insertion which begins at
5892 position BEG and ends at position END.
5893
5894 An entry (TEXT . POSITION) represents the deletion of the string TEXT
5895 from (abs POSITION). If POSITION is positive, point was at the front
5896 of the text being deleted; if negative, point was at the end.
5897
5898 An entry (t HIGH . LOW) indicates that the buffer previously had
5899 \"unmodified\" status. HIGH and LOW are the high and low 16-bit portions
5900 of the visited file's modification time, as of that time. If the
5901 modification time of the most recent save is different, this entry is
5902 obsolete.
5903
5904 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property
5905 was modified between BEG and END. PROPERTY is the property name,
5906 and VALUE is the old value.
5907
5908 An entry (apply FUN-NAME . ARGS) means undo the change with
5909 \(apply FUN-NAME ARGS).
5910
5911 An entry (apply DELTA BEG END FUN-NAME . ARGS) supports selective undo
5912 in the active region. BEG and END is the range affected by this entry
5913 and DELTA is the number of bytes added or deleted in that range by
5914 this change.
5915
5916 An entry (MARKER . DISTANCE) indicates that the marker MARKER
5917 was adjusted in position by the offset DISTANCE (an integer).
5918
5919 An entry of the form POSITION indicates that point was at the buffer
5920 location given by the integer. Undoing an entry of this form places
5921 point at POSITION.
5922
5923 Entries with value `nil' mark undo boundaries. The undo command treats
5924 the changes between two undo boundaries as a single step to be undone.
5925
5926 If the value of the variable is t, undo information is not recorded. */);
5927
5928 DEFVAR_PER_BUFFER ("mark-active", &current_buffer->mark_active, Qnil,
5929 doc: /* Non-nil means the mark and region are currently active in this buffer. */);
5930
5931 DEFVAR_PER_BUFFER ("cache-long-line-scans", &current_buffer->cache_long_line_scans, Qnil,
5932 doc: /* Non-nil means that Emacs should use caches to handle long lines more quickly.
5933
5934 Normally, the line-motion functions work by scanning the buffer for
5935 newlines. Columnar operations (like `move-to-column' and
5936 `compute-motion') also work by scanning the buffer, summing character
5937 widths as they go. This works well for ordinary text, but if the
5938 buffer's lines are very long (say, more than 500 characters), these
5939 motion functions will take longer to execute. Emacs may also take
5940 longer to update the display.
5941
5942 If `cache-long-line-scans' is non-nil, these motion functions cache the
5943 results of their scans, and consult the cache to avoid rescanning
5944 regions of the buffer until the text is modified. The caches are most
5945 beneficial when they prevent the most searching---that is, when the
5946 buffer contains long lines and large regions of characters with the
5947 same, fixed screen width.
5948
5949 When `cache-long-line-scans' is non-nil, processing short lines will
5950 become slightly slower (because of the overhead of consulting the
5951 cache), and the caches will use memory roughly proportional to the
5952 number of newlines and characters whose screen width varies.
5953
5954 The caches require no explicit maintenance; their accuracy is
5955 maintained internally by the Emacs primitives. Enabling or disabling
5956 the cache should not affect the behavior of any of the motion
5957 functions; it should only affect their performance. */);
5958
5959 DEFVAR_PER_BUFFER ("point-before-scroll", &current_buffer->point_before_scroll, Qnil,
5960 doc: /* Value of point before the last series of scroll operations, or nil. */);
5961
5962 DEFVAR_PER_BUFFER ("buffer-file-format", &current_buffer->file_format, Qnil,
5963 doc: /* List of formats to use when saving this buffer.
5964 Formats are defined by `format-alist'. This variable is
5965 set when a file is visited. */);
5966
5967 DEFVAR_PER_BUFFER ("buffer-auto-save-file-format",
5968 &current_buffer->auto_save_file_format, Qnil,
5969 doc: /* *Format in which to write auto-save files.
5970 Should be a list of symbols naming formats that are defined in `format-alist'.
5971 If it is t, which is the default, auto-save files are written in the
5972 same format as a regular save would use. */);
5973
5974 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
5975 &current_buffer->invisibility_spec, Qnil,
5976 doc: /* Invisibility spec of this buffer.
5977 The default is t, which means that text is invisible
5978 if it has a non-nil `invisible' property.
5979 If the value is a list, a text character is invisible if its `invisible'
5980 property is an element in that list.
5981 If an element is a cons cell of the form (PROP . ELLIPSIS),
5982 then characters with property value PROP are invisible,
5983 and they have an ellipsis as well if ELLIPSIS is non-nil. */);
5984
5985 DEFVAR_PER_BUFFER ("buffer-display-count",
5986 &current_buffer->display_count, Qnil,
5987 doc: /* A number incremented each time this buffer is displayed in a window.
5988 The function `set-window-buffer' increments it. */);
5989
5990 DEFVAR_PER_BUFFER ("buffer-display-time",
5991 &current_buffer->display_time, Qnil,
5992 doc: /* Time stamp updated each time this buffer is displayed in a window.
5993 The function `set-window-buffer' updates this variable
5994 to the value obtained by calling `current-time'.
5995 If the buffer has never been shown in a window, the value is nil. */);
5996
5997 DEFVAR_LISP ("transient-mark-mode", &Vtransient_mark_mode,
5998 doc: /* *Non-nil means deactivate the mark when the buffer contents change.
5999 Non-nil also enables highlighting of the region whenever the mark is active.
6000 The variable `highlight-nonselected-windows' controls whether to highlight
6001 all windows or just the selected window.
6002
6003 If the value is `lambda', that enables Transient Mark mode temporarily
6004 until the next buffer modification. If a command sets the value to `only',
6005 that enables Transient Mark mode for the following command only.
6006 During that following command, the value of `transient-mark-mode'
6007 is `identity'. If it is still `identity' at the end of that command,
6008 it changes to nil. */);
6009 Vtransient_mark_mode = Qnil;
6010
6011 DEFVAR_LISP ("inhibit-read-only", &Vinhibit_read_only,
6012 doc: /* *Non-nil means disregard read-only status of buffers or characters.
6013 If the value is t, disregard `buffer-read-only' and all `read-only'
6014 text properties. If the value is a list, disregard `buffer-read-only'
6015 and disregard a `read-only' text property if the property value
6016 is a member of the list. */);
6017 Vinhibit_read_only = Qnil;
6018
6019 DEFVAR_PER_BUFFER ("cursor-type", &current_buffer->cursor_type, Qnil,
6020 doc: /* Cursor to use when this buffer is in the selected window.
6021 Values are interpreted as follows:
6022
6023 t use the cursor specified for the frame
6024 nil don't display a cursor
6025 box display a filled box cursor
6026 hollow display a hollow box cursor
6027 bar display a vertical bar cursor with default width
6028 (bar . WIDTH) display a vertical bar cursor with width WIDTH
6029 hbar display a horizontal bar cursor with default height
6030 (hbar . HEIGHT) display a horizontal bar cursor with height HEIGHT
6031 ANYTHING ELSE display a hollow box cursor
6032
6033 When the buffer is displayed in a nonselected window,
6034 this variable has no effect; the cursor appears as a hollow box. */);
6035
6036 DEFVAR_PER_BUFFER ("line-spacing",
6037 &current_buffer->extra_line_spacing, Qnil,
6038 doc: /* Additional space to put between lines when displaying a buffer.
6039 The space is measured in pixels, and put below lines on window systems.
6040 If value is a floating point number, it specifies the spacing relative
6041 to the default frame line height. A value of nil means add no extra space. */);
6042
6043 DEFVAR_PER_BUFFER ("cursor-in-non-selected-windows",
6044 &current_buffer->cursor_in_non_selected_windows, Qnil,
6045 doc: /* *Cursor type to display in non-selected windows.
6046 The value t means to use hollow box cursor. See `cursor-type' for other values. */);
6047
6048 DEFVAR_LISP ("kill-buffer-query-functions", &Vkill_buffer_query_functions,
6049 doc: /* List of functions called with no args to query before killing a buffer.
6050 The buffer being killed will be current while the functions are running.
6051 If any of them returns nil, the buffer is not killed. */);
6052 Vkill_buffer_query_functions = Qnil;
6053
6054 DEFVAR_LISP ("change-major-mode-hook", &Vchange_major_mode_hook,
6055 doc: /* Normal hook run before changing the major mode of a buffer.
6056 The function `kill-all-local-variables' runs this before doing anything else. */);
6057 Vchange_major_mode_hook = Qnil;
6058 Qchange_major_mode_hook = intern ("change-major-mode-hook");
6059 staticpro (&Qchange_major_mode_hook);
6060
6061 defsubr (&Sbuffer_live_p);
6062 defsubr (&Sbuffer_list);
6063 defsubr (&Sget_buffer);
6064 defsubr (&Sget_file_buffer);
6065 defsubr (&Sget_buffer_create);
6066 defsubr (&Smake_indirect_buffer);
6067 defsubr (&Sgenerate_new_buffer_name);
6068 defsubr (&Sbuffer_name);
6069 /*defsubr (&Sbuffer_number);*/
6070 defsubr (&Sbuffer_file_name);
6071 defsubr (&Sbuffer_base_buffer);
6072 defsubr (&Sbuffer_local_value);
6073 defsubr (&Sbuffer_local_variables);
6074 defsubr (&Sbuffer_modified_p);
6075 defsubr (&Sset_buffer_modified_p);
6076 defsubr (&Sbuffer_modified_tick);
6077 defsubr (&Sbuffer_chars_modified_tick);
6078 defsubr (&Srename_buffer);
6079 defsubr (&Sother_buffer);
6080 defsubr (&Sbuffer_enable_undo);
6081 defsubr (&Skill_buffer);
6082 defsubr (&Sset_buffer_major_mode);
6083 defsubr (&Sswitch_to_buffer);
6084 defsubr (&Spop_to_buffer);
6085 defsubr (&Scurrent_buffer);
6086 defsubr (&Sset_buffer);
6087 defsubr (&Sbarf_if_buffer_read_only);
6088 defsubr (&Sbury_buffer);
6089 defsubr (&Serase_buffer);
6090 defsubr (&Sset_buffer_multibyte);
6091 defsubr (&Skill_all_local_variables);
6092
6093 defsubr (&Soverlayp);
6094 defsubr (&Smake_overlay);
6095 defsubr (&Sdelete_overlay);
6096 defsubr (&Smove_overlay);
6097 defsubr (&Soverlay_start);
6098 defsubr (&Soverlay_end);
6099 defsubr (&Soverlay_buffer);
6100 defsubr (&Soverlay_properties);
6101 defsubr (&Soverlays_at);
6102 defsubr (&Soverlays_in);
6103 defsubr (&Snext_overlay_change);
6104 defsubr (&Sprevious_overlay_change);
6105 defsubr (&Soverlay_recenter);
6106 defsubr (&Soverlay_lists);
6107 defsubr (&Soverlay_get);
6108 defsubr (&Soverlay_put);
6109 defsubr (&Srestore_buffer_modified_p);
6110 }
6111
6112 void
6113 keys_of_buffer ()
6114 {
6115 initial_define_key (control_x_map, 'b', "switch-to-buffer");
6116 initial_define_key (control_x_map, 'k', "kill-buffer");
6117
6118 /* This must not be in syms_of_buffer, because Qdisabled is not
6119 initialized when that function gets called. */
6120 Fput (intern ("erase-buffer"), Qdisabled, Qt);
6121 }
6122
6123 /* arch-tag: e48569bf-69a9-4b65-a23b-8e68769436e1
6124 (do not change this comment) */