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