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