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