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