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