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