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