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