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