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