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