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