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