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