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