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