(adjust_overlays_for_insert): New function.
[bpt/emacs.git] / src / buffer.c
1 /* Buffer manipulation primitives for GNU Emacs.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994, 1995
3 Free Software Foundation, Inc.
4
5 This file is part of GNU Emacs.
6
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
11
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
20
21
22 #include <sys/types.h>
23 #include <sys/stat.h>
24 #include <sys/param.h>
25
26 #ifndef MAXPATHLEN
27 /* in 4.1, param.h fails to define this. */
28 #define MAXPATHLEN 1024
29 #endif /* not MAXPATHLEN */
30
31 #include <config.h>
32 #include "lisp.h"
33 #include "intervals.h"
34 #include "window.h"
35 #include "commands.h"
36 #include "buffer.h"
37 #include "region-cache.h"
38 #include "indent.h"
39 #include "blockinput.h"
40
41 struct buffer *current_buffer; /* the current buffer */
42
43 /* First buffer in chain of all buffers (in reverse order of creation).
44 Threaded through ->next. */
45
46 struct buffer *all_buffers;
47
48 /* This structure holds the default values of the buffer-local variables
49 defined with DEFVAR_PER_BUFFER, that have special slots in each buffer.
50 The default value occupies the same slot in this structure
51 as an individual buffer's value occupies in that buffer.
52 Setting the default value also goes through the alist of buffers
53 and stores into each buffer that does not say it has a local value. */
54
55 struct buffer buffer_defaults;
56
57 /* A Lisp_Object pointer to the above, used for staticpro */
58
59 static Lisp_Object Vbuffer_defaults;
60
61 /* This structure marks which slots in a buffer have corresponding
62 default values in buffer_defaults.
63 Each such slot has a nonzero value in this structure.
64 The value has only one nonzero bit.
65
66 When a buffer has its own local value for a slot,
67 the bit for that slot (found in the same slot in this structure)
68 is turned on in the buffer's local_var_flags slot.
69
70 If a slot in this structure is -1, then even though there may
71 be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
72 and the corresponding slot in buffer_defaults is not used.
73
74 If a slot is -2, then there is no DEFVAR_PER_BUFFER for it,
75 but there is a default value which is copied into each buffer.
76
77 If a slot in this structure is negative, then even though there may
78 be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
79 and the corresponding slot in buffer_defaults is not used.
80
81 If a slot in this structure corresponding to a DEFVAR_PER_BUFFER is
82 zero, that is a bug */
83
84 struct buffer buffer_local_flags;
85
86 /* This structure holds the names of symbols whose values may be
87 buffer-local. It is indexed and accessed in the same way as the above. */
88
89 struct buffer buffer_local_symbols;
90 /* A Lisp_Object pointer to the above, used for staticpro */
91 static Lisp_Object Vbuffer_local_symbols;
92
93 /* This structure holds the required types for the values in the
94 buffer-local slots. If a slot contains Qnil, then the
95 corresponding buffer slot may contain a value of any type. If a
96 slot contains an integer, then prospective values' tags must be
97 equal to that integer. When a tag does not match, the function
98 buffer_slot_type_mismatch will signal an error. */
99 struct buffer buffer_local_types;
100
101 Lisp_Object Fset_buffer ();
102 void set_buffer_internal ();
103 static void call_overlay_mod_hooks ();
104 static void swap_out_buffer_local_variables ();
105
106 /* Alist of all buffer names vs the buffers. */
107 /* This used to be a variable, but is no longer,
108 to prevent lossage due to user rplac'ing this alist or its elements. */
109 Lisp_Object Vbuffer_alist;
110
111 /* Functions to call before and after each text change. */
112 Lisp_Object Vbefore_change_function;
113 Lisp_Object Vafter_change_function;
114 Lisp_Object Vbefore_change_functions;
115 Lisp_Object Vafter_change_functions;
116
117 Lisp_Object Vtransient_mark_mode;
118
119 /* t means ignore all read-only text properties.
120 A list means ignore such a property if its value is a member of the list.
121 Any non-nil value means ignore buffer-read-only. */
122 Lisp_Object Vinhibit_read_only;
123
124 /* List of functions to call that can query about killing a buffer.
125 If any of these functions returns nil, we don't kill it. */
126 Lisp_Object Vkill_buffer_query_functions;
127
128 /* List of functions to call before changing an unmodified buffer. */
129 Lisp_Object Vfirst_change_hook;
130 Lisp_Object Qfirst_change_hook;
131
132 Lisp_Object Qfundamental_mode, Qmode_class, Qpermanent_local;
133
134 Lisp_Object Qprotected_field;
135
136 Lisp_Object QSFundamental; /* A string "Fundamental" */
137
138 Lisp_Object Qkill_buffer_hook;
139
140 Lisp_Object Qget_file_buffer;
141
142 Lisp_Object Qoverlayp;
143
144 Lisp_Object Qpriority, Qwindow, Qevaporate;
145
146 Lisp_Object Qmodification_hooks;
147 Lisp_Object Qinsert_in_front_hooks;
148 Lisp_Object Qinsert_behind_hooks;
149
150 /* For debugging; temporary. See set_buffer_internal. */
151 /* Lisp_Object Qlisp_mode, Vcheck_symbol; */
152
153 nsberror (spec)
154 Lisp_Object spec;
155 {
156 if (STRINGP (spec))
157 error ("No buffer named %s", XSTRING (spec)->data);
158 error ("Invalid buffer argument");
159 }
160 \f
161 DEFUN ("buffer-list", Fbuffer_list, Sbuffer_list, 0, 0, 0,
162 "Return a list of all existing live buffers.")
163 ()
164 {
165 return Fmapcar (Qcdr, Vbuffer_alist);
166 }
167
168 /* Like Fassoc, but use Fstring_equal to compare
169 (which ignores text properties),
170 and don't ever QUIT. */
171
172 static Lisp_Object
173 assoc_ignore_text_properties (key, list)
174 register Lisp_Object key;
175 Lisp_Object list;
176 {
177 register Lisp_Object tail;
178 for (tail = list; !NILP (tail); tail = Fcdr (tail))
179 {
180 register Lisp_Object elt, tem;
181 elt = Fcar (tail);
182 tem = Fstring_equal (Fcar (elt), key);
183 if (!NILP (tem))
184 return elt;
185 }
186 return Qnil;
187 }
188
189 DEFUN ("get-buffer", Fget_buffer, Sget_buffer, 1, 1, 0,
190 "Return the buffer named NAME (a string).\n\
191 If there is no live buffer named NAME, return nil.\n\
192 NAME may also be a buffer; if so, the value is that buffer.")
193 (name)
194 register Lisp_Object name;
195 {
196 if (BUFFERP (name))
197 return name;
198 CHECK_STRING (name, 0);
199
200 return Fcdr (assoc_ignore_text_properties (name, Vbuffer_alist));
201 }
202
203 DEFUN ("get-file-buffer", Fget_file_buffer, Sget_file_buffer, 1, 1, 0,
204 "Return the buffer visiting file FILENAME (a string).\n\
205 The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.\n\
206 If there is no such live buffer, return nil.\n\
207 See also `find-buffer-visiting'.")
208 (filename)
209 register Lisp_Object filename;
210 {
211 register Lisp_Object tail, buf, tem;
212 Lisp_Object handler;
213
214 CHECK_STRING (filename, 0);
215 filename = Fexpand_file_name (filename, Qnil);
216
217 /* If the file name has special constructs in it,
218 call the corresponding file handler. */
219 handler = Ffind_file_name_handler (filename, Qget_file_buffer);
220 if (!NILP (handler))
221 return call2 (handler, Qget_file_buffer, filename);
222
223 for (tail = Vbuffer_alist; CONSP (tail); tail = XCONS (tail)->cdr)
224 {
225 buf = Fcdr (XCONS (tail)->car);
226 if (!BUFFERP (buf)) continue;
227 if (!STRINGP (XBUFFER (buf)->filename)) continue;
228 tem = Fstring_equal (XBUFFER (buf)->filename, filename);
229 if (!NILP (tem))
230 return buf;
231 }
232 return Qnil;
233 }
234
235 /* Incremented for each buffer created, to assign the buffer number. */
236 int buffer_count;
237
238 DEFUN ("get-buffer-create", Fget_buffer_create, Sget_buffer_create, 1, 1, 0,
239 "Return the buffer named NAME, or create such a buffer and return it.\n\
240 A new buffer is created if there is no live buffer named NAME.\n\
241 If NAME starts with a space, the new buffer does not keep undo information.\n\
242 If NAME is a buffer instead of a string, then it is the value returned.\n\
243 The value is never nil.")
244 (name)
245 register Lisp_Object name;
246 {
247 register Lisp_Object buf;
248 register struct buffer *b;
249
250 buf = Fget_buffer (name);
251 if (!NILP (buf))
252 return buf;
253
254 if (XSTRING (name)->size == 0)
255 error ("Empty string for buffer name is not allowed");
256
257 b = (struct buffer *) xmalloc (sizeof (struct buffer));
258
259 b->size = sizeof (struct buffer) / sizeof (EMACS_INT);
260
261 /* An ordinary buffer uses its own struct buffer_text. */
262 b->text = &b->own_text;
263 b->base_buffer = 0;
264
265 BUF_GAP_SIZE (b) = 20;
266 BLOCK_INPUT;
267 BUFFER_ALLOC (BUF_BEG_ADDR (b), BUF_GAP_SIZE (b));
268 UNBLOCK_INPUT;
269 if (! BUF_BEG_ADDR (b))
270 buffer_memory_full ();
271
272 BUF_PT (b) = 1;
273 BUF_GPT (b) = 1;
274 BUF_BEGV (b) = 1;
275 BUF_ZV (b) = 1;
276 BUF_Z (b) = 1;
277 BUF_MODIFF (b) = 1;
278 BUF_SAVE_MODIFF (b) = 1;
279 BUF_INTERVALS (b) = 0;
280
281 b->newline_cache = 0;
282 b->width_run_cache = 0;
283 b->width_table = Qnil;
284
285 /* Put this on the chain of all buffers including killed ones. */
286 b->next = all_buffers;
287 all_buffers = b;
288
289 /* An ordinary buffer normally doesn't need markers
290 to handle BEGV and ZV. */
291 b->pt_marker = Qnil;
292 b->begv_marker = Qnil;
293 b->zv_marker = Qnil;
294
295 name = Fcopy_sequence (name);
296 INITIALIZE_INTERVAL (XSTRING (name), NULL_INTERVAL);
297 b->name = name;
298
299 if (XSTRING (name)->data[0] != ' ')
300 b->undo_list = Qnil;
301 else
302 b->undo_list = Qt;
303
304 reset_buffer (b);
305 reset_buffer_local_variables (b);
306
307 /* Put this in the alist of all live buffers. */
308 XSETBUFFER (buf, b);
309 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
310
311 b->mark = Fmake_marker ();
312 BUF_MARKERS (b) = Qnil;
313 b->name = name;
314 return buf;
315 }
316
317 DEFUN ("make-indirect-buffer",
318 Fmake_indirect_buffer, Smake_indirect_buffer, 2, 2,
319 "BMake indirect buffer (to buffer): \nbName of indirect buffer: ",
320 "Create and return an indirect buffer for buffer BASE, named NAME.\n\
321 BASE should be an existing buffer (or buffer name).\n\
322 NAME should be a string which is not the name of an existing buffer.")
323 (base_buffer, name)
324 register Lisp_Object base_buffer, name;
325 {
326 register Lisp_Object buf;
327 register struct buffer *b;
328
329 buf = Fget_buffer (name);
330 if (!NILP (buf))
331 error ("Buffer name `%s' is in use", XSTRING (name)->data);
332
333 base_buffer = Fget_buffer (base_buffer);
334 if (NILP (base_buffer))
335 error ("No such buffer: `%s'",
336 XSTRING (XBUFFER (base_buffer)->name)->data);
337
338 if (XSTRING (name)->size == 0)
339 error ("Empty string for buffer name is not allowed");
340
341 b = (struct buffer *) xmalloc (sizeof (struct buffer));
342
343 b->size = sizeof (struct buffer) / sizeof (EMACS_INT);
344
345 if (XBUFFER (base_buffer)->base_buffer)
346 b->base_buffer = XBUFFER (base_buffer)->base_buffer;
347 else
348 b->base_buffer = XBUFFER (base_buffer);
349
350 /* Use the base buffer's text object. */
351 b->text = b->base_buffer->text;
352
353 BUF_BEGV (b) = BUF_BEGV (b->base_buffer);
354 BUF_ZV (b) = BUF_ZV (b->base_buffer);
355 BUF_PT (b) = BUF_PT (b->base_buffer);
356
357 b->newline_cache = 0;
358 b->width_run_cache = 0;
359 b->width_table = Qnil;
360
361 /* Put this on the chain of all buffers including killed ones. */
362 b->next = all_buffers;
363 all_buffers = b;
364
365 name = Fcopy_sequence (name);
366 INITIALIZE_INTERVAL (XSTRING (name), NULL_INTERVAL);
367 b->name = name;
368
369 reset_buffer (b);
370 reset_buffer_local_variables (b);
371
372 /* Put this in the alist of all live buffers. */
373 XSETBUFFER (buf, b);
374 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
375
376 b->mark = Fmake_marker ();
377 b->name = name;
378
379 /* Make sure the base buffer has markers for its narrowing. */
380 if (NILP (b->base_buffer->pt_marker))
381 {
382 b->base_buffer->pt_marker = Fmake_marker ();
383 Fset_marker (b->base_buffer->pt_marker,
384 make_number (BUF_PT (b->base_buffer)), base_buffer);
385 }
386 if (NILP (b->base_buffer->begv_marker))
387 {
388 b->base_buffer->begv_marker = Fmake_marker ();
389 Fset_marker (b->base_buffer->begv_marker,
390 make_number (BUF_BEGV (b->base_buffer)), base_buffer);
391 }
392 if (NILP (b->base_buffer->zv_marker))
393 {
394 b->base_buffer->zv_marker = Fmake_marker ();
395 Fset_marker (b->base_buffer->zv_marker,
396 make_number (BUF_ZV (b->base_buffer)), base_buffer);
397 }
398
399 /* Give the indirect buffer markers for its narrowing. */
400 b->pt_marker = Fpoint_marker ();
401 b->begv_marker = Fpoint_min_marker ();
402 b->zv_marker = Fpoint_max_marker ();
403
404 return buf;
405 }
406
407 /* Reinitialize everything about a buffer except its name and contents
408 and local variables. */
409
410 void
411 reset_buffer (b)
412 register struct buffer *b;
413 {
414 b->filename = Qnil;
415 b->file_truename = Qnil;
416 b->directory = (current_buffer) ? current_buffer->directory : Qnil;
417 b->modtime = 0;
418 XSETFASTINT (b->save_length, 0);
419 b->last_window_start = 1;
420 b->backed_up = Qnil;
421 b->auto_save_modified = 0;
422 b->auto_save_failure_time = -1;
423 b->auto_save_file_name = Qnil;
424 b->read_only = Qnil;
425 b->overlays_before = Qnil;
426 b->overlays_after = Qnil;
427 XSETFASTINT (b->overlay_center, 1);
428 b->mark_active = Qnil;
429 b->point_before_scroll = Qnil;
430 b->file_format = Qnil;
431 }
432
433 /* Reset buffer B's local variables info.
434 Don't use this on a buffer that has already been in use;
435 it does not treat permanent locals consistently.
436 Instead, use Fkill_all_local_variables. */
437
438 reset_buffer_local_variables (b)
439 register struct buffer *b;
440 {
441 register int offset;
442
443 /* Reset the major mode to Fundamental, together with all the
444 things that depend on the major mode.
445 default-major-mode is handled at a higher level.
446 We ignore it here. */
447 b->major_mode = Qfundamental_mode;
448 b->keymap = Qnil;
449 b->abbrev_table = Vfundamental_mode_abbrev_table;
450 b->mode_name = QSFundamental;
451 b->minor_modes = Qnil;
452 b->downcase_table = Vascii_downcase_table;
453 b->upcase_table = Vascii_upcase_table;
454 b->case_canon_table = Vascii_canon_table;
455 b->case_eqv_table = Vascii_eqv_table;
456 b->buffer_file_type = Qnil;
457 b->invisibility_spec = Qt;
458
459 #if 0
460 b->sort_table = XSTRING (Vascii_sort_table);
461 b->folding_sort_table = XSTRING (Vascii_folding_sort_table);
462 #endif /* 0 */
463
464 /* Reset all per-buffer variables to their defaults. */
465 b->local_var_alist = Qnil;
466 b->local_var_flags = 0;
467
468 /* For each slot that has a default value,
469 copy that into the slot. */
470
471 for (offset = (char *)&buffer_local_flags.name - (char *)&buffer_local_flags;
472 offset < sizeof (struct buffer);
473 offset += sizeof (Lisp_Object)) /* sizeof EMACS_INT == sizeof Lisp_Object */
474 {
475 int flag = XINT (*(Lisp_Object *)(offset + (char *)&buffer_local_flags));
476 if (flag > 0 || flag == -2)
477 *(Lisp_Object *)(offset + (char *)b) =
478 *(Lisp_Object *)(offset + (char *)&buffer_defaults);
479 }
480 }
481
482 /* We split this away from generate-new-buffer, because rename-buffer
483 and set-visited-file-name ought to be able to use this to really
484 rename the buffer properly. */
485
486 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name, Sgenerate_new_buffer_name,
487 1, 2, 0,
488 "Return a string that is the name of no existing buffer based on NAME.\n\
489 If there is no live buffer named NAME, then return NAME.\n\
490 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER\n\
491 until an unused name is found, and then return that name.\n\
492 Optional second argument IGNORE specifies a name that is okay to use\n\
493 \(if it is in the sequence to be tried)\n\
494 even if a buffer with that name exists.")
495 (name, ignore)
496 register Lisp_Object name, ignore;
497 {
498 register Lisp_Object gentemp, tem;
499 int count;
500 char number[10];
501
502 CHECK_STRING (name, 0);
503
504 tem = Fget_buffer (name);
505 if (NILP (tem))
506 return name;
507
508 count = 1;
509 while (1)
510 {
511 sprintf (number, "<%d>", ++count);
512 gentemp = concat2 (name, build_string (number));
513 tem = Fstring_equal (gentemp, ignore);
514 if (!NILP (tem))
515 return gentemp;
516 tem = Fget_buffer (gentemp);
517 if (NILP (tem))
518 return gentemp;
519 }
520 }
521
522 \f
523 DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
524 "Return the name of BUFFER, as a string.\n\
525 With no argument or nil as argument, return the name of the current buffer.")
526 (buffer)
527 register Lisp_Object buffer;
528 {
529 if (NILP (buffer))
530 return current_buffer->name;
531 CHECK_BUFFER (buffer, 0);
532 return XBUFFER (buffer)->name;
533 }
534
535 DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
536 "Return name of file BUFFER is visiting, or nil if none.\n\
537 No argument or nil as argument means use the current buffer.")
538 (buffer)
539 register Lisp_Object buffer;
540 {
541 if (NILP (buffer))
542 return current_buffer->filename;
543 CHECK_BUFFER (buffer, 0);
544 return XBUFFER (buffer)->filename;
545 }
546
547 DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
548 0, 1, 0,
549 "Return the base buffer of indirect buffer BUFFER.\n\
550 If BUFFER is not indirect, return nil.")
551 (buffer)
552 register Lisp_Object buffer;
553 {
554 struct buffer *base;
555 Lisp_Object base_buffer;
556
557 if (NILP (buffer))
558 base = current_buffer->base_buffer;
559 else
560 {
561 CHECK_BUFFER (buffer, 0);
562 base = XBUFFER (buffer)->base_buffer;
563 }
564
565 if (! base)
566 return Qnil;
567 XSETBUFFER (base_buffer, base);
568 return base_buffer;
569 }
570
571 DEFUN ("buffer-local-variables", Fbuffer_local_variables,
572 Sbuffer_local_variables, 0, 1, 0,
573 "Return an alist of variables that are buffer-local in BUFFER.\n\
574 Most elements look like (SYMBOL . VALUE), describing one variable.\n\
575 For a symbol that is locally unbound, just the symbol appears in the value.\n\
576 Note that storing new VALUEs in these elements doesn't change the variables.\n\
577 No argument or nil as argument means use current buffer as BUFFER.")
578 (buffer)
579 register Lisp_Object buffer;
580 {
581 register struct buffer *buf;
582 register Lisp_Object result;
583
584 if (NILP (buffer))
585 buf = current_buffer;
586 else
587 {
588 CHECK_BUFFER (buffer, 0);
589 buf = XBUFFER (buffer);
590 }
591
592 result = Qnil;
593
594 {
595 register Lisp_Object tail;
596 for (tail = buf->local_var_alist; CONSP (tail); tail = XCONS (tail)->cdr)
597 {
598 Lisp_Object val, elt;
599
600 elt = XCONS (tail)->car;
601
602 /* Reference each variable in the alist in buf.
603 If inquiring about the current buffer, this gets the current values,
604 so store them into the alist so the alist is up to date.
605 If inquiring about some other buffer, this swaps out any values
606 for that buffer, making the alist up to date automatically. */
607 val = find_symbol_value (XCONS (elt)->car);
608 /* Use the current buffer value only if buf is the current buffer. */
609 if (buf != current_buffer)
610 val = XCONS (elt)->cdr;
611
612 /* If symbol is unbound, put just the symbol in the list. */
613 if (EQ (val, Qunbound))
614 result = Fcons (XCONS (elt)->car, result);
615 /* Otherwise, put (symbol . value) in the list. */
616 else
617 result = Fcons (Fcons (XCONS (elt)->car, val), result);
618 }
619 }
620
621 /* Add on all the variables stored in special slots. */
622 {
623 register int offset, mask;
624
625 for (offset = (char *)&buffer_local_symbols.name - (char *)&buffer_local_symbols;
626 offset < sizeof (struct buffer);
627 offset += (sizeof (EMACS_INT))) /* sizeof EMACS_INT == sizeof Lisp_Object */
628 {
629 mask = XINT (*(Lisp_Object *)(offset + (char *)&buffer_local_flags));
630 if (mask == -1 || (buf->local_var_flags & mask))
631 if (SYMBOLP (*(Lisp_Object *)(offset
632 + (char *)&buffer_local_symbols)))
633 result = Fcons (Fcons (*((Lisp_Object *)
634 (offset + (char *)&buffer_local_symbols)),
635 *(Lisp_Object *)(offset + (char *)buf)),
636 result);
637 }
638 }
639
640 return result;
641 }
642
643 \f
644 DEFUN ("buffer-modified-p", Fbuffer_modified_p, Sbuffer_modified_p,
645 0, 1, 0,
646 "Return t if BUFFER was modified since its file was last read or saved.\n\
647 No argument or nil as argument means use current buffer as BUFFER.")
648 (buffer)
649 register Lisp_Object buffer;
650 {
651 register struct buffer *buf;
652 if (NILP (buffer))
653 buf = current_buffer;
654 else
655 {
656 CHECK_BUFFER (buffer, 0);
657 buf = XBUFFER (buffer);
658 }
659
660 return BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf) ? Qt : Qnil;
661 }
662
663 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p, Sset_buffer_modified_p,
664 1, 1, 0,
665 "Mark current buffer as modified or unmodified according to FLAG.\n\
666 A non-nil FLAG means mark the buffer modified.")
667 (flag)
668 register Lisp_Object flag;
669 {
670 register int already;
671 register Lisp_Object fn;
672
673 #ifdef CLASH_DETECTION
674 /* If buffer becoming modified, lock the file.
675 If buffer becoming unmodified, unlock the file. */
676
677 fn = current_buffer->filename;
678 if (!NILP (fn))
679 {
680 already = SAVE_MODIFF < MODIFF;
681 if (!already && !NILP (flag))
682 lock_file (fn);
683 else if (already && NILP (flag))
684 unlock_file (fn);
685 }
686 #endif /* CLASH_DETECTION */
687
688 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
689 update_mode_lines++;
690 return flag;
691 }
692
693 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick, Sbuffer_modified_tick,
694 0, 1, 0,
695 "Return BUFFER's tick counter, incremented for each change in text.\n\
696 Each buffer has a tick counter which is incremented each time the text in\n\
697 that buffer is changed. It wraps around occasionally.\n\
698 No argument or nil as argument means use current buffer as BUFFER.")
699 (buffer)
700 register Lisp_Object buffer;
701 {
702 register struct buffer *buf;
703 if (NILP (buffer))
704 buf = current_buffer;
705 else
706 {
707 CHECK_BUFFER (buffer, 0);
708 buf = XBUFFER (buffer);
709 }
710
711 return make_number (BUF_MODIFF (buf));
712 }
713 \f
714 DEFUN ("rename-buffer", Frename_buffer, Srename_buffer, 1, 2,
715 "sRename buffer (to new name): \nP",
716 "Change current buffer's name to NEWNAME (a string).\n\
717 If second arg UNIQUE is nil or omitted, it is an error if a\n\
718 buffer named NEWNAME already exists.\n\
719 If UNIQUE is non-nil, come up with a new name using\n\
720 `generate-new-buffer-name'.\n\
721 Interactively, you can set UNIQUE with a prefix argument.\n\
722 We return the name we actually gave the buffer.\n\
723 This does not change the name of the visited file (if any).")
724 (newname, unique)
725 register Lisp_Object newname, unique;
726 {
727 register Lisp_Object tem, buf;
728
729 CHECK_STRING (newname, 0);
730
731 if (XSTRING (newname)->size == 0)
732 error ("Empty string is invalid as a buffer name");
733
734 tem = Fget_buffer (newname);
735 /* Don't short-circuit if UNIQUE is t. That is a useful way to rename
736 the buffer automatically so you can create another with the original name.
737 It makes UNIQUE equivalent to
738 (rename-buffer (generate-new-buffer-name NEWNAME)). */
739 if (NILP (unique) && XBUFFER (tem) == current_buffer)
740 return current_buffer->name;
741 if (!NILP (tem))
742 {
743 if (!NILP (unique))
744 newname = Fgenerate_new_buffer_name (newname, current_buffer->name);
745 else
746 error ("Buffer name `%s' is in use", XSTRING (newname)->data);
747 }
748
749 current_buffer->name = newname;
750
751 /* Catch redisplay's attention. Unless we do this, the mode lines for
752 any windows displaying current_buffer will stay unchanged. */
753 update_mode_lines++;
754
755 XSETBUFFER (buf, current_buffer);
756 Fsetcar (Frassq (buf, Vbuffer_alist), newname);
757 if (NILP (current_buffer->filename)
758 && !NILP (current_buffer->auto_save_file_name))
759 call0 (intern ("rename-auto-save-file"));
760 /* Refetch since that last call may have done GC. */
761 return current_buffer->name;
762 }
763
764 DEFUN ("other-buffer", Fother_buffer, Sother_buffer, 0, 2, 0,
765 "Return most recently selected buffer other than BUFFER.\n\
766 Buffers not visible in windows are preferred to visible buffers,\n\
767 unless optional second argument VISIBLE-OK is non-nil.\n\
768 If no other buffer exists, the buffer `*scratch*' is returned.\n\
769 If BUFFER is omitted or nil, some interesting buffer is returned.")
770 (buffer, visible_ok)
771 register Lisp_Object buffer, visible_ok;
772 {
773 register Lisp_Object tail, buf, notsogood, tem;
774 notsogood = Qnil;
775
776 for (tail = Vbuffer_alist; !NILP (tail); tail = Fcdr (tail))
777 {
778 buf = Fcdr (Fcar (tail));
779 if (EQ (buf, buffer))
780 continue;
781 if (XSTRING (XBUFFER (buf)->name)->data[0] == ' ')
782 continue;
783 #ifdef MULTI_FRAME
784 /* If the selected frame has a buffer_predicate,
785 disregard buffers that don't fit the predicate. */
786 tem = frame_buffer_predicate ();
787 if (!NILP (tem))
788 {
789 tem = call1 (tem, buf);
790 if (NILP (tem))
791 continue;
792 }
793 #endif
794
795 if (NILP (visible_ok))
796 tem = Fget_buffer_window (buf, Qt);
797 else
798 tem = Qnil;
799 if (NILP (tem))
800 return buf;
801 if (NILP (notsogood))
802 notsogood = buf;
803 }
804 if (!NILP (notsogood))
805 return notsogood;
806 return Fget_buffer_create (build_string ("*scratch*"));
807 }
808 \f
809 DEFUN ("buffer-disable-undo", Fbuffer_disable_undo, Sbuffer_disable_undo, 0, 1,
810 0,
811 "Make BUFFER stop keeping undo information.\n\
812 No argument or nil as argument means do this for the current buffer.")
813 (buffer)
814 register Lisp_Object buffer;
815 {
816 Lisp_Object real_buffer;
817
818 if (NILP (buffer))
819 XSETBUFFER (real_buffer, current_buffer);
820 else
821 {
822 real_buffer = Fget_buffer (buffer);
823 if (NILP (real_buffer))
824 nsberror (buffer);
825 }
826
827 XBUFFER (real_buffer)->undo_list = Qt;
828
829 return Qnil;
830 }
831
832 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo, Sbuffer_enable_undo,
833 0, 1, "",
834 "Start keeping undo information for buffer BUFFER.\n\
835 No argument or nil as argument means do this for the current buffer.")
836 (buffer)
837 register Lisp_Object buffer;
838 {
839 Lisp_Object real_buffer;
840
841 if (NILP (buffer))
842 XSETBUFFER (real_buffer, current_buffer);
843 else
844 {
845 real_buffer = Fget_buffer (buffer);
846 if (NILP (real_buffer))
847 nsberror (buffer);
848 }
849
850 if (EQ (XBUFFER (real_buffer)->undo_list, Qt))
851 XBUFFER (real_buffer)->undo_list = Qnil;
852
853 return Qnil;
854 }
855
856 /*
857 DEFVAR_LISP ("kill-buffer-hook", no_cell, "\
858 Hook to be run (by `run-hooks', which see) when a buffer is killed.\n\
859 The buffer being killed will be current while the hook is running.\n\
860 See `kill-buffer'."
861 */
862 DEFUN ("kill-buffer", Fkill_buffer, Skill_buffer, 1, 1, "bKill buffer: ",
863 "Kill the buffer BUFFER.\n\
864 The argument may be a buffer or may be the name of a buffer.\n\
865 An argument of nil means kill the current buffer.\n\n\
866 Value is t if the buffer is actually killed, nil if user says no.\n\n\
867 The value of `kill-buffer-hook' (which may be local to that buffer),\n\
868 if not void, is a list of functions to be called, with no arguments,\n\
869 before the buffer is actually killed. The buffer to be killed is current\n\
870 when the hook functions are called.\n\n\
871 Any processes that have this buffer as the `process-buffer' are killed\n\
872 with `delete-process'.")
873 (bufname)
874 Lisp_Object bufname;
875 {
876 Lisp_Object buf;
877 register struct buffer *b;
878 register Lisp_Object tem;
879 register struct Lisp_Marker *m;
880 struct gcpro gcpro1, gcpro2;
881
882 if (NILP (bufname))
883 buf = Fcurrent_buffer ();
884 else
885 buf = Fget_buffer (bufname);
886 if (NILP (buf))
887 nsberror (bufname);
888
889 b = XBUFFER (buf);
890
891 /* Query if the buffer is still modified. */
892 if (INTERACTIVE && !NILP (b->filename)
893 && BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
894 {
895 GCPRO2 (buf, bufname);
896 tem = do_yes_or_no_p (format1 ("Buffer %s modified; kill anyway? ",
897 XSTRING (b->name)->data));
898 UNGCPRO;
899 if (NILP (tem))
900 return Qnil;
901 }
902
903 /* Run hooks with the buffer to be killed the current buffer. */
904 {
905 register Lisp_Object val;
906 int count = specpdl_ptr - specpdl;
907 Lisp_Object list;
908
909 record_unwind_protect (save_excursion_restore, save_excursion_save ());
910 set_buffer_internal (b);
911
912 /* First run the query functions; if any query is answered no,
913 don't kill the buffer. */
914 for (list = Vkill_buffer_query_functions; !NILP (list); list = Fcdr (list))
915 {
916 tem = call0 (Fcar (list));
917 if (NILP (tem))
918 return unbind_to (count, Qnil);
919 }
920
921 /* Then run the hooks. */
922 if (!NILP (Vrun_hooks))
923 call1 (Vrun_hooks, Qkill_buffer_hook);
924 unbind_to (count, Qnil);
925 }
926
927 /* We have no more questions to ask. Verify that it is valid
928 to kill the buffer. This must be done after the questions
929 since anything can happen within do_yes_or_no_p. */
930
931 /* Don't kill the minibuffer now current. */
932 if (EQ (buf, XWINDOW (minibuf_window)->buffer))
933 return Qnil;
934
935 if (NILP (b->name))
936 return Qnil;
937
938 /* When we kill a base buffer, kill all its indirect buffers.
939 We do it at this stage so nothing terrible happens if they
940 ask questions or their hooks get errors. */
941 if (! b->base_buffer)
942 {
943 struct buffer *other;
944
945 GCPRO1 (buf);
946
947 for (other = all_buffers; other; other = other->next)
948 if (other->base_buffer == b)
949 {
950 Lisp_Object buf;
951 XSETBUFFER (buf, other);
952 Fkill_buffer (buf);
953 }
954
955 UNGCPRO;
956 }
957
958 /* Make this buffer not be current.
959 In the process, notice if this is the sole visible buffer
960 and give up if so. */
961 if (b == current_buffer)
962 {
963 tem = Fother_buffer (buf, Qnil);
964 Fset_buffer (tem);
965 if (b == current_buffer)
966 return Qnil;
967 }
968
969 /* Now there is no question: we can kill the buffer. */
970
971 #ifdef CLASH_DETECTION
972 /* Unlock this buffer's file, if it is locked. */
973 unlock_buffer (b);
974 #endif /* CLASH_DETECTION */
975
976 kill_buffer_processes (buf);
977
978 tem = Vinhibit_quit;
979 Vinhibit_quit = Qt;
980 Vbuffer_alist = Fdelq (Frassq (buf, Vbuffer_alist), Vbuffer_alist);
981 Freplace_buffer_in_windows (buf);
982 Vinhibit_quit = tem;
983
984 /* Delete any auto-save file, if we saved it in this session. */
985 if (STRINGP (b->auto_save_file_name)
986 && b->auto_save_modified != 0)
987 {
988 Lisp_Object tem;
989 tem = Fsymbol_value (intern ("delete-auto-save-files"));
990 if (! NILP (tem))
991 internal_delete_file (b->auto_save_file_name);
992 }
993
994 if (! b->base_buffer)
995 {
996 /* Unchain all markers of this buffer
997 and leave them pointing nowhere. */
998 for (tem = BUF_MARKERS (b); !EQ (tem, Qnil); )
999 {
1000 m = XMARKER (tem);
1001 m->buffer = 0;
1002 tem = m->chain;
1003 m->chain = Qnil;
1004 }
1005 BUF_MARKERS (b) = Qnil;
1006
1007 #ifdef USE_TEXT_PROPERTIES
1008 BUF_INTERVALS (b) = NULL_INTERVAL;
1009 #endif
1010
1011 /* Perhaps we should explicitly free the interval tree here... */
1012 }
1013
1014 /* Reset the local variables, so that this buffer's local values
1015 won't be protected from GC. They would be protected
1016 if they happened to remain encached in their symbols.
1017 This gets rid of them for certain. */
1018 swap_out_buffer_local_variables (b);
1019 reset_buffer_local_variables (b);
1020
1021 b->name = Qnil;
1022
1023 BLOCK_INPUT;
1024 if (! b->base_buffer)
1025 BUFFER_FREE (BUF_BEG_ADDR (b));
1026
1027 if (b->newline_cache)
1028 {
1029 free_region_cache (b->newline_cache);
1030 b->newline_cache = 0;
1031 }
1032 if (b->width_run_cache)
1033 {
1034 free_region_cache (b->width_run_cache);
1035 b->width_run_cache = 0;
1036 }
1037 b->width_table = Qnil;
1038 UNBLOCK_INPUT;
1039 b->undo_list = Qnil;
1040
1041 return Qt;
1042 }
1043 \f
1044 /* Move the assoc for buffer BUF to the front of buffer-alist. Since
1045 we do this each time BUF is selected visibly, the more recently
1046 selected buffers are always closer to the front of the list. This
1047 means that other_buffer is more likely to choose a relevant buffer. */
1048
1049 record_buffer (buf)
1050 Lisp_Object buf;
1051 {
1052 register Lisp_Object link, prev;
1053
1054 prev = Qnil;
1055 for (link = Vbuffer_alist; CONSP (link); link = XCONS (link)->cdr)
1056 {
1057 if (EQ (XCONS (XCONS (link)->car)->cdr, buf))
1058 break;
1059 prev = link;
1060 }
1061
1062 /* Effectively do Vbuffer_alist = Fdelq (link, Vbuffer_alist);
1063 we cannot use Fdelq itself here because it allows quitting. */
1064
1065 if (NILP (prev))
1066 Vbuffer_alist = XCONS (Vbuffer_alist)->cdr;
1067 else
1068 XCONS (prev)->cdr = XCONS (XCONS (prev)->cdr)->cdr;
1069
1070 XCONS(link)->cdr = Vbuffer_alist;
1071 Vbuffer_alist = link;
1072 }
1073
1074 DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode, Sset_buffer_major_mode, 1, 1, 0,
1075 "Set an appropriate major mode for BUFFER, according to `default-major-mode'.\n\
1076 Use this function before selecting the buffer, since it may need to inspect\n\
1077 the current buffer's major mode.")
1078 (buf)
1079 Lisp_Object buf;
1080 {
1081 int count;
1082 Lisp_Object function;
1083
1084 function = buffer_defaults.major_mode;
1085 if (NILP (function) && NILP (Fget (current_buffer->major_mode, Qmode_class)))
1086 function = current_buffer->major_mode;
1087
1088 if (NILP (function) || EQ (function, Qfundamental_mode))
1089 return Qnil;
1090
1091 count = specpdl_ptr - specpdl;
1092
1093 /* To select a nonfundamental mode,
1094 select the buffer temporarily and then call the mode function. */
1095
1096 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1097
1098 Fset_buffer (buf);
1099 call0 (function);
1100
1101 return unbind_to (count, Qnil);
1102 }
1103
1104 DEFUN ("switch-to-buffer", Fswitch_to_buffer, Sswitch_to_buffer, 1, 2, "BSwitch to buffer: ",
1105 "Select buffer BUFFER in the current window.\n\
1106 BUFFER may be a buffer or a buffer name.\n\
1107 Optional second arg NORECORD non-nil means\n\
1108 do not put this buffer at the front of the list of recently selected ones.\n\
1109 \n\
1110 WARNING: This is NOT the way to work on another buffer temporarily\n\
1111 within a Lisp program! Use `set-buffer' instead. That avoids messing with\n\
1112 the window-buffer correspondences.")
1113 (bufname, norecord)
1114 Lisp_Object bufname, norecord;
1115 {
1116 register Lisp_Object buf;
1117 Lisp_Object tem;
1118
1119 if (EQ (minibuf_window, selected_window))
1120 error ("Cannot switch buffers in minibuffer window");
1121 tem = Fwindow_dedicated_p (selected_window);
1122 if (!NILP (tem))
1123 error ("Cannot switch buffers in a dedicated window");
1124
1125 if (NILP (bufname))
1126 buf = Fother_buffer (Fcurrent_buffer (), Qnil);
1127 else
1128 {
1129 buf = Fget_buffer (bufname);
1130 if (NILP (buf))
1131 {
1132 buf = Fget_buffer_create (bufname);
1133 Fset_buffer_major_mode (buf);
1134 }
1135 }
1136 Fset_buffer (buf);
1137 if (NILP (norecord))
1138 record_buffer (buf);
1139
1140 Fset_window_buffer (EQ (selected_window, minibuf_window)
1141 ? Fnext_window (minibuf_window, Qnil, Qnil)
1142 : selected_window,
1143 buf);
1144
1145 return buf;
1146 }
1147
1148 DEFUN ("pop-to-buffer", Fpop_to_buffer, Spop_to_buffer, 1, 2, 0,
1149 "Select buffer BUFFER in some window, preferably a different one.\n\
1150 If BUFFER is nil, then some other buffer is chosen.\n\
1151 If `pop-up-windows' is non-nil, windows can be split to do this.\n\
1152 If optional second arg OTHER-WINDOW is non-nil, insist on finding another\n\
1153 window even if BUFFER is already visible in the selected window.")
1154 (bufname, other)
1155 Lisp_Object bufname, other;
1156 {
1157 register Lisp_Object buf;
1158 if (NILP (bufname))
1159 buf = Fother_buffer (Fcurrent_buffer (), Qnil);
1160 else
1161 {
1162 buf = Fget_buffer (bufname);
1163 if (NILP (buf))
1164 {
1165 buf = Fget_buffer_create (bufname);
1166 Fset_buffer_major_mode (buf);
1167 }
1168 }
1169 Fset_buffer (buf);
1170 record_buffer (buf);
1171 Fselect_window (Fdisplay_buffer (buf, other));
1172 return buf;
1173 }
1174
1175 DEFUN ("current-buffer", Fcurrent_buffer, Scurrent_buffer, 0, 0, 0,
1176 "Return the current buffer as a Lisp object.")
1177 ()
1178 {
1179 register Lisp_Object buf;
1180 XSETBUFFER (buf, current_buffer);
1181 return buf;
1182 }
1183 \f
1184 /* Set the current buffer to b */
1185
1186 void
1187 set_buffer_internal (b)
1188 register struct buffer *b;
1189 {
1190 register struct buffer *old_buf;
1191 register Lisp_Object tail, valcontents;
1192 Lisp_Object tem;
1193
1194 if (current_buffer == b)
1195 return;
1196
1197 windows_or_buffers_changed = 1;
1198 old_buf = current_buffer;
1199 current_buffer = b;
1200 last_known_column_point = -1; /* invalidate indentation cache */
1201
1202 if (old_buf)
1203 {
1204 /* Put the undo list back in the base buffer, so that it appears
1205 that an indirect buffer shares the undo list of its base. */
1206 if (old_buf->base_buffer)
1207 old_buf->base_buffer->undo_list = old_buf->undo_list;
1208
1209 /* If the old current buffer has markers to record PT, BEGV and ZV
1210 when it is not current, update them now. */
1211 if (! NILP (old_buf->pt_marker))
1212 {
1213 Lisp_Object obuf;
1214 XSETBUFFER (obuf, old_buf);
1215 Fset_marker (old_buf->pt_marker, BUF_PT (old_buf), obuf);
1216 }
1217 if (! NILP (old_buf->begv_marker))
1218 {
1219 Lisp_Object obuf;
1220 XSETBUFFER (obuf, old_buf);
1221 Fset_marker (old_buf->begv_marker, BUF_BEGV (old_buf), obuf);
1222 }
1223 if (! NILP (old_buf->zv_marker))
1224 {
1225 Lisp_Object obuf;
1226 XSETBUFFER (obuf, old_buf);
1227 Fset_marker (old_buf->zv_marker, BUF_ZV (old_buf), obuf);
1228 }
1229 }
1230
1231 /* Get the undo list from the base buffer, so that it appears
1232 that an indirect buffer shares the undo list of its base. */
1233 if (b->base_buffer)
1234 b->undo_list = b->base_buffer->undo_list;
1235
1236 /* If the new current buffer has markers to record PT, BEGV and ZV
1237 when it is not current, fetch them now. */
1238 if (! NILP (b->pt_marker))
1239 BUF_PT (b) = marker_position (b->pt_marker);
1240 if (! NILP (b->begv_marker))
1241 BUF_BEGV (b) = marker_position (b->begv_marker);
1242 if (! NILP (b->zv_marker))
1243 BUF_ZV (b) = marker_position (b->zv_marker);
1244
1245 /* Look down buffer's list of local Lisp variables
1246 to find and update any that forward into C variables. */
1247
1248 for (tail = b->local_var_alist; !NILP (tail); tail = XCONS (tail)->cdr)
1249 {
1250 valcontents = XSYMBOL (XCONS (XCONS (tail)->car)->car)->value;
1251 if ((BUFFER_LOCAL_VALUEP (valcontents)
1252 || SOME_BUFFER_LOCAL_VALUEP (valcontents))
1253 && (tem = XBUFFER_LOCAL_VALUE (valcontents)->car,
1254 (BOOLFWDP (tem) || INTFWDP (tem) || OBJFWDP (tem))))
1255 /* Just reference the variable
1256 to cause it to become set for this buffer. */
1257 Fsymbol_value (XCONS (XCONS (tail)->car)->car);
1258 }
1259
1260 /* Do the same with any others that were local to the previous buffer */
1261
1262 if (old_buf)
1263 for (tail = old_buf->local_var_alist; !NILP (tail); tail = XCONS (tail)->cdr)
1264 {
1265 valcontents = XSYMBOL (XCONS (XCONS (tail)->car)->car)->value;
1266 if ((BUFFER_LOCAL_VALUEP (valcontents)
1267 || SOME_BUFFER_LOCAL_VALUEP (valcontents))
1268 && (tem = XBUFFER_LOCAL_VALUE (valcontents)->car,
1269 (BOOLFWDP (tem) || INTFWDP (tem) || OBJFWDP (tem))))
1270 /* Just reference the variable
1271 to cause it to become set for this buffer. */
1272 Fsymbol_value (XCONS (XCONS (tail)->car)->car);
1273 }
1274 }
1275
1276 /* Switch to buffer B temporarily for redisplay purposes.
1277 This avoids certain things thatdon't need to be done within redisplay. */
1278
1279 void
1280 set_buffer_temp (b)
1281 struct buffer *b;
1282 {
1283 register struct buffer *old_buf;
1284
1285 if (current_buffer == b)
1286 return;
1287
1288 old_buf = current_buffer;
1289 current_buffer = b;
1290
1291 if (old_buf)
1292 {
1293 /* If the old current buffer has markers to record PT, BEGV and ZV
1294 when it is not current, update them now. */
1295 if (! NILP (old_buf->pt_marker))
1296 {
1297 Lisp_Object obuf;
1298 XSETBUFFER (obuf, old_buf);
1299 Fset_marker (old_buf->pt_marker, BUF_PT (old_buf), obuf);
1300 }
1301 if (! NILP (old_buf->begv_marker))
1302 {
1303 Lisp_Object obuf;
1304 XSETBUFFER (obuf, old_buf);
1305 Fset_marker (old_buf->begv_marker, BUF_BEGV (old_buf), obuf);
1306 }
1307 if (! NILP (old_buf->zv_marker))
1308 {
1309 Lisp_Object obuf;
1310 XSETBUFFER (obuf, old_buf);
1311 Fset_marker (old_buf->zv_marker, BUF_ZV (old_buf), obuf);
1312 }
1313 }
1314
1315 /* If the new current buffer has markers to record PT, BEGV and ZV
1316 when it is not current, fetch them now. */
1317 if (! NILP (b->pt_marker))
1318 BUF_PT (b) = marker_position (b->pt_marker);
1319 if (! NILP (b->begv_marker))
1320 BUF_BEGV (b) = marker_position (b->begv_marker);
1321 if (! NILP (b->zv_marker))
1322 BUF_ZV (b) = marker_position (b->zv_marker);
1323 }
1324
1325 DEFUN ("set-buffer", Fset_buffer, Sset_buffer, 1, 1, 0,
1326 "Make the buffer BUFFER current for editing operations.\n\
1327 BUFFER may be a buffer or the name of an existing buffer.\n\
1328 See also `save-excursion' when you want to make a buffer current temporarily.\n\
1329 This function does not display the buffer, so its effect ends\n\
1330 when the current command terminates.\n\
1331 Use `switch-to-buffer' or `pop-to-buffer' to switch buffers permanently.")
1332 (bufname)
1333 register Lisp_Object bufname;
1334 {
1335 register Lisp_Object buffer;
1336 buffer = Fget_buffer (bufname);
1337 if (NILP (buffer))
1338 nsberror (bufname);
1339 if (NILP (XBUFFER (buffer)->name))
1340 error ("Selecting deleted buffer");
1341 set_buffer_internal (XBUFFER (buffer));
1342 return buffer;
1343 }
1344 \f
1345 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only,
1346 Sbarf_if_buffer_read_only, 0, 0, 0,
1347 "Signal a `buffer-read-only' error if the current buffer is read-only.")
1348 ()
1349 {
1350 if (!NILP (current_buffer->read_only)
1351 && NILP (Vinhibit_read_only))
1352 Fsignal (Qbuffer_read_only, (Fcons (Fcurrent_buffer (), Qnil)));
1353 return Qnil;
1354 }
1355
1356 DEFUN ("bury-buffer", Fbury_buffer, Sbury_buffer, 0, 1, "",
1357 "Put BUFFER at the end of the list of all buffers.\n\
1358 There it is the least likely candidate for `other-buffer' to return;\n\
1359 thus, the least likely buffer for \\[switch-to-buffer] to select by default.\n\
1360 If BUFFER is nil or omitted, bury the current buffer.\n\
1361 Also, if BUFFER is nil or omitted, remove the current buffer from the\n\
1362 selected window if it is displayed there.")
1363 (buf)
1364 register Lisp_Object buf;
1365 {
1366 /* Figure out what buffer we're going to bury. */
1367 if (NILP (buf))
1368 {
1369 XSETBUFFER (buf, current_buffer);
1370
1371 /* If we're burying the current buffer, unshow it. */
1372 Fswitch_to_buffer (Fother_buffer (buf, Qnil), Qnil);
1373 }
1374 else
1375 {
1376 Lisp_Object buf1;
1377
1378 buf1 = Fget_buffer (buf);
1379 if (NILP (buf1))
1380 nsberror (buf);
1381 buf = buf1;
1382 }
1383
1384 /* Move buf to the end of the buffer list. */
1385 {
1386 register Lisp_Object aelt, link;
1387
1388 aelt = Frassq (buf, Vbuffer_alist);
1389 link = Fmemq (aelt, Vbuffer_alist);
1390 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
1391 XCONS (link)->cdr = Qnil;
1392 Vbuffer_alist = nconc2 (Vbuffer_alist, link);
1393 }
1394
1395 return Qnil;
1396 }
1397 \f
1398 DEFUN ("erase-buffer", Ferase_buffer, Serase_buffer, 0, 0, "*",
1399 "Delete the entire contents of the current buffer.\n\
1400 Any narrowing restriction in effect (see `narrow-to-region') is removed,\n\
1401 so the buffer is truly empty after this.")
1402 ()
1403 {
1404 Fwiden ();
1405 del_range (BEG, Z);
1406 current_buffer->last_window_start = 1;
1407 /* Prevent warnings, or suspension of auto saving, that would happen
1408 if future size is less than past size. Use of erase-buffer
1409 implies that the future text is not really related to the past text. */
1410 XSETFASTINT (current_buffer->save_length, 0);
1411 return Qnil;
1412 }
1413
1414 validate_region (b, e)
1415 register Lisp_Object *b, *e;
1416 {
1417 CHECK_NUMBER_COERCE_MARKER (*b, 0);
1418 CHECK_NUMBER_COERCE_MARKER (*e, 1);
1419
1420 if (XINT (*b) > XINT (*e))
1421 {
1422 Lisp_Object tem;
1423 tem = *b; *b = *e; *e = tem;
1424 }
1425
1426 if (!(BEGV <= XINT (*b) && XINT (*b) <= XINT (*e)
1427 && XINT (*e) <= ZV))
1428 args_out_of_range (*b, *e);
1429 }
1430 \f
1431 DEFUN ("kill-all-local-variables", Fkill_all_local_variables, Skill_all_local_variables,
1432 0, 0, 0,
1433 "Switch to Fundamental mode by killing current buffer's local variables.\n\
1434 Most local variable bindings are eliminated so that the default values\n\
1435 become effective once more. Also, the syntax table is set from\n\
1436 `standard-syntax-table', the local keymap is set to nil,\n\
1437 and the abbrev table from `fundamental-mode-abbrev-table'.\n\
1438 This function also forces redisplay of the mode line.\n\
1439 \n\
1440 Every function to select a new major mode starts by\n\
1441 calling this function.\n\n\
1442 As a special exception, local variables whose names have\n\
1443 a non-nil `permanent-local' property are not eliminated by this function.\n\
1444 \n\
1445 The first thing this function does is run\n\
1446 the normal hook `change-major-mode-hook'.")
1447 ()
1448 {
1449 register Lisp_Object alist, sym, tem;
1450 Lisp_Object oalist;
1451
1452 if (!NILP (Vrun_hooks))
1453 call1 (Vrun_hooks, intern ("change-major-mode-hook"));
1454 oalist = current_buffer->local_var_alist;
1455
1456 /* Make sure none of the bindings in oalist
1457 remain swapped in, in their symbols. */
1458
1459 swap_out_buffer_local_variables (current_buffer);
1460
1461 /* Actually eliminate all local bindings of this buffer. */
1462
1463 reset_buffer_local_variables (current_buffer);
1464
1465 /* Redisplay mode lines; we are changing major mode. */
1466
1467 update_mode_lines++;
1468
1469 /* Any which are supposed to be permanent,
1470 make local again, with the same values they had. */
1471
1472 for (alist = oalist; !NILP (alist); alist = XCONS (alist)->cdr)
1473 {
1474 sym = XCONS (XCONS (alist)->car)->car;
1475 tem = Fget (sym, Qpermanent_local);
1476 if (! NILP (tem))
1477 {
1478 Fmake_local_variable (sym);
1479 Fset (sym, XCONS (XCONS (alist)->car)->cdr);
1480 }
1481 }
1482
1483 /* Force mode-line redisplay. Useful here because all major mode
1484 commands call this function. */
1485 update_mode_lines++;
1486
1487 return Qnil;
1488 }
1489
1490 /* Make sure no local variables remain set up with buffer B
1491 for their current values. */
1492
1493 static void
1494 swap_out_buffer_local_variables (b)
1495 struct buffer *b;
1496 {
1497 Lisp_Object oalist, alist, sym, tem, buffer;
1498
1499 XSETBUFFER (buffer, b);
1500 oalist = b->local_var_alist;
1501
1502 for (alist = oalist; !NILP (alist); alist = XCONS (alist)->cdr)
1503 {
1504 sym = XCONS (XCONS (alist)->car)->car;
1505
1506 /* Need not do anything if some other buffer's binding is now encached. */
1507 tem = XCONS (XBUFFER_LOCAL_VALUE (XSYMBOL (sym)->value)->cdr)->car;
1508 if (XBUFFER (tem) == current_buffer)
1509 {
1510 /* Symbol is set up for this buffer's old local value.
1511 Set it up for the current buffer with the default value. */
1512
1513 tem = XCONS (XBUFFER_LOCAL_VALUE (XSYMBOL (sym)->value)->cdr)->cdr;
1514 /* Store the symbol's current value into the alist entry
1515 it is currently set up for. This is so that, if the
1516 local is marked permanent, and we make it local again
1517 later in Fkill_all_local_variables, we don't lose the value. */
1518 XCONS (XCONS (tem)->car)->cdr
1519 = do_symval_forwarding (XBUFFER_LOCAL_VALUE (XSYMBOL (sym)->value)->car);
1520 /* Switch to the symbol's default-value alist entry. */
1521 XCONS (tem)->car = tem;
1522 /* Mark it as current for buffer B. */
1523 XCONS (XBUFFER_LOCAL_VALUE (XSYMBOL (sym)->value)->cdr)->car
1524 = buffer;
1525 /* Store the current value into any forwarding in the symbol. */
1526 store_symval_forwarding (sym, XBUFFER_LOCAL_VALUE (XSYMBOL (sym)->value)->car,
1527 XCONS (tem)->cdr);
1528 }
1529 }
1530 }
1531 \f
1532 /* Find all the overlays in the current buffer that contain position POS.
1533 Return the number found, and store them in a vector in *VEC_PTR.
1534 Store in *LEN_PTR the size allocated for the vector.
1535 Store in *NEXT_PTR the next position after POS where an overlay starts,
1536 or ZV if there are no more overlays.
1537 Store in *PREV_PTR the previous position after POS where an overlay ends,
1538 or BEGV if there are no previous overlays.
1539 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
1540
1541 *VEC_PTR and *LEN_PTR should contain a valid vector and size
1542 when this function is called.
1543
1544 If EXTEND is non-zero, we make the vector bigger if necessary.
1545 If EXTEND is zero, we never extend the vector,
1546 and we store only as many overlays as will fit.
1547 But we still return the total number of overlays. */
1548
1549 int
1550 overlays_at (pos, extend, vec_ptr, len_ptr, next_ptr, prev_ptr)
1551 int pos;
1552 int extend;
1553 Lisp_Object **vec_ptr;
1554 int *len_ptr;
1555 int *next_ptr;
1556 int *prev_ptr;
1557 {
1558 Lisp_Object tail, overlay, start, end, result;
1559 int idx = 0;
1560 int len = *len_ptr;
1561 Lisp_Object *vec = *vec_ptr;
1562 int next = ZV;
1563 int prev = BEGV;
1564 int inhibit_storing = 0;
1565
1566 for (tail = current_buffer->overlays_before;
1567 GC_CONSP (tail);
1568 tail = XCONS (tail)->cdr)
1569 {
1570 int startpos, endpos;
1571
1572 overlay = XCONS (tail)->car;
1573
1574 start = OVERLAY_START (overlay);
1575 end = OVERLAY_END (overlay);
1576 endpos = OVERLAY_POSITION (end);
1577 if (endpos < pos)
1578 {
1579 if (prev < endpos)
1580 prev = endpos;
1581 break;
1582 }
1583 if (endpos == pos)
1584 continue;
1585 startpos = OVERLAY_POSITION (start);
1586 if (startpos <= pos)
1587 {
1588 if (idx == len)
1589 {
1590 /* The supplied vector is full.
1591 Either make it bigger, or don't store any more in it. */
1592 if (extend)
1593 {
1594 *len_ptr = len *= 2;
1595 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
1596 *vec_ptr = vec;
1597 }
1598 else
1599 inhibit_storing = 1;
1600 }
1601
1602 if (!inhibit_storing)
1603 vec[idx] = overlay;
1604 /* Keep counting overlays even if we can't return them all. */
1605 idx++;
1606 }
1607 else if (startpos < next)
1608 next = startpos;
1609 }
1610
1611 for (tail = current_buffer->overlays_after;
1612 GC_CONSP (tail);
1613 tail = XCONS (tail)->cdr)
1614 {
1615 int startpos, endpos;
1616
1617 overlay = XCONS (tail)->car;
1618
1619 start = OVERLAY_START (overlay);
1620 end = OVERLAY_END (overlay);
1621 startpos = OVERLAY_POSITION (start);
1622 if (pos < startpos)
1623 {
1624 if (startpos < next)
1625 next = startpos;
1626 break;
1627 }
1628 endpos = OVERLAY_POSITION (end);
1629 if (pos < endpos)
1630 {
1631 if (idx == len)
1632 {
1633 if (extend)
1634 {
1635 *len_ptr = len *= 2;
1636 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
1637 *vec_ptr = vec;
1638 }
1639 else
1640 inhibit_storing = 1;
1641 }
1642
1643 if (!inhibit_storing)
1644 vec[idx] = overlay;
1645 idx++;
1646 }
1647 else if (endpos < pos && endpos > prev)
1648 prev = endpos;
1649 }
1650
1651 if (next_ptr)
1652 *next_ptr = next;
1653 if (prev_ptr)
1654 *prev_ptr = prev;
1655 return idx;
1656 }
1657
1658 /* Fast function to just test if we're at an overlay boundary. */
1659 int
1660 overlay_touches_p (pos)
1661 int pos;
1662 {
1663 Lisp_Object tail, overlay;
1664
1665 for (tail = current_buffer->overlays_before; GC_CONSP (tail);
1666 tail = XCONS (tail)->cdr)
1667 {
1668 int endpos;
1669
1670 overlay = XCONS (tail)->car;
1671 if (!GC_OVERLAYP (overlay))
1672 abort ();
1673
1674 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
1675 if (endpos < pos)
1676 break;
1677 if (endpos == pos || OVERLAY_POSITION (OVERLAY_START (overlay)) == pos)
1678 return 1;
1679 }
1680
1681 for (tail = current_buffer->overlays_after; GC_CONSP (tail);
1682 tail = XCONS (tail)->cdr)
1683 {
1684 int startpos;
1685
1686 overlay = XCONS (tail)->car;
1687 if (!GC_OVERLAYP (overlay))
1688 abort ();
1689
1690 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
1691 if (pos < startpos)
1692 break;
1693 if (startpos == pos || OVERLAY_POSITION (OVERLAY_END (overlay)) == pos)
1694 return 1;
1695 }
1696 return 0;
1697 }
1698 \f
1699 struct sortvec
1700 {
1701 Lisp_Object overlay;
1702 int beg, end;
1703 int priority;
1704 };
1705
1706 static int
1707 compare_overlays (s1, s2)
1708 struct sortvec *s1, *s2;
1709 {
1710 if (s1->priority != s2->priority)
1711 return s1->priority - s2->priority;
1712 if (s1->beg != s2->beg)
1713 return s1->beg - s2->beg;
1714 if (s1->end != s2->end)
1715 return s2->end - s1->end;
1716 return 0;
1717 }
1718
1719 /* Sort an array of overlays by priority. The array is modified in place.
1720 The return value is the new size; this may be smaller than the original
1721 size if some of the overlays were invalid or were window-specific. */
1722 int
1723 sort_overlays (overlay_vec, noverlays, w)
1724 Lisp_Object *overlay_vec;
1725 int noverlays;
1726 struct window *w;
1727 {
1728 int i, j;
1729 struct sortvec *sortvec;
1730 sortvec = (struct sortvec *) alloca (noverlays * sizeof (struct sortvec));
1731
1732 /* Put the valid and relevant overlays into sortvec. */
1733
1734 for (i = 0, j = 0; i < noverlays; i++)
1735 {
1736 Lisp_Object tem;
1737 Lisp_Object overlay;
1738
1739 overlay = overlay_vec[i];
1740 if (OVERLAY_VALID (overlay)
1741 && OVERLAY_POSITION (OVERLAY_START (overlay)) > 0
1742 && OVERLAY_POSITION (OVERLAY_END (overlay)) > 0)
1743 {
1744 /* If we're interested in a specific window, then ignore
1745 overlays that are limited to some other window. */
1746 if (w)
1747 {
1748 Lisp_Object window;
1749
1750 window = Foverlay_get (overlay, Qwindow);
1751 if (WINDOWP (window) && XWINDOW (window) != w)
1752 continue;
1753 }
1754
1755 /* This overlay is good and counts: put it into sortvec. */
1756 sortvec[j].overlay = overlay;
1757 sortvec[j].beg = OVERLAY_POSITION (OVERLAY_START (overlay));
1758 sortvec[j].end = OVERLAY_POSITION (OVERLAY_END (overlay));
1759 tem = Foverlay_get (overlay, Qpriority);
1760 if (INTEGERP (tem))
1761 sortvec[j].priority = XINT (tem);
1762 else
1763 sortvec[j].priority = 0;
1764 j++;
1765 }
1766 }
1767 noverlays = j;
1768
1769 /* Sort the overlays into the proper order: increasing priority. */
1770
1771 if (noverlays > 1)
1772 qsort (sortvec, noverlays, sizeof (struct sortvec), compare_overlays);
1773
1774 for (i = 0; i < noverlays; i++)
1775 overlay_vec[i] = sortvec[i].overlay;
1776 return (noverlays);
1777 }
1778 \f
1779 /* Shift overlays in BUF's overlay lists, to center the lists at POS. */
1780
1781 void
1782 recenter_overlay_lists (buf, pos)
1783 struct buffer *buf;
1784 int pos;
1785 {
1786 Lisp_Object overlay, tail, next, prev, beg, end;
1787
1788 /* See if anything in overlays_before should move to overlays_after. */
1789
1790 /* We don't strictly need prev in this loop; it should always be nil.
1791 But we use it for symmetry and in case that should cease to be true
1792 with some future change. */
1793 prev = Qnil;
1794 for (tail = buf->overlays_before;
1795 CONSP (tail);
1796 prev = tail, tail = next)
1797 {
1798 next = XCONS (tail)->cdr;
1799 overlay = XCONS (tail)->car;
1800
1801 /* If the overlay is not valid, get rid of it. */
1802 if (!OVERLAY_VALID (overlay))
1803 #if 1
1804 abort ();
1805 #else
1806 {
1807 /* Splice the cons cell TAIL out of overlays_before. */
1808 if (!NILP (prev))
1809 XCONS (prev)->cdr = next;
1810 else
1811 buf->overlays_before = next;
1812 tail = prev;
1813 continue;
1814 }
1815 #endif
1816
1817 beg = OVERLAY_START (overlay);
1818 end = OVERLAY_END (overlay);
1819
1820 if (OVERLAY_POSITION (end) > pos)
1821 {
1822 /* OVERLAY needs to be moved. */
1823 int where = OVERLAY_POSITION (beg);
1824 Lisp_Object other, other_prev;
1825
1826 /* Splice the cons cell TAIL out of overlays_before. */
1827 if (!NILP (prev))
1828 XCONS (prev)->cdr = next;
1829 else
1830 buf->overlays_before = next;
1831
1832 /* Search thru overlays_after for where to put it. */
1833 other_prev = Qnil;
1834 for (other = buf->overlays_after;
1835 CONSP (other);
1836 other_prev = other, other = XCONS (other)->cdr)
1837 {
1838 Lisp_Object otherbeg, otheroverlay, follower;
1839 int win;
1840
1841 otheroverlay = XCONS (other)->car;
1842 if (! OVERLAY_VALID (otheroverlay))
1843 abort ();
1844
1845 otherbeg = OVERLAY_START (otheroverlay);
1846 if (OVERLAY_POSITION (otherbeg) >= where)
1847 break;
1848 }
1849
1850 /* Add TAIL to overlays_after before OTHER. */
1851 XCONS (tail)->cdr = other;
1852 if (!NILP (other_prev))
1853 XCONS (other_prev)->cdr = tail;
1854 else
1855 buf->overlays_after = tail;
1856 tail = prev;
1857 }
1858 else
1859 /* We've reached the things that should stay in overlays_before.
1860 All the rest of overlays_before must end even earlier,
1861 so stop now. */
1862 break;
1863 }
1864
1865 /* See if anything in overlays_after should be in overlays_before. */
1866 prev = Qnil;
1867 for (tail = buf->overlays_after;
1868 CONSP (tail);
1869 prev = tail, tail = next)
1870 {
1871 next = XCONS (tail)->cdr;
1872 overlay = XCONS (tail)->car;
1873
1874 /* If the overlay is not valid, get rid of it. */
1875 if (!OVERLAY_VALID (overlay))
1876 #if 1
1877 abort ();
1878 #else
1879 {
1880 /* Splice the cons cell TAIL out of overlays_after. */
1881 if (!NILP (prev))
1882 XCONS (prev)->cdr = next;
1883 else
1884 buf->overlays_after = next;
1885 tail = prev;
1886 continue;
1887 }
1888 #endif
1889
1890 beg = OVERLAY_START (overlay);
1891 end = OVERLAY_END (overlay);
1892
1893 /* Stop looking, when we know that nothing further
1894 can possibly end before POS. */
1895 if (OVERLAY_POSITION (beg) > pos)
1896 break;
1897
1898 if (OVERLAY_POSITION (end) <= pos)
1899 {
1900 /* OVERLAY needs to be moved. */
1901 int where = OVERLAY_POSITION (end);
1902 Lisp_Object other, other_prev;
1903
1904 /* Splice the cons cell TAIL out of overlays_after. */
1905 if (!NILP (prev))
1906 XCONS (prev)->cdr = next;
1907 else
1908 buf->overlays_after = next;
1909
1910 /* Search thru overlays_before for where to put it. */
1911 other_prev = Qnil;
1912 for (other = buf->overlays_before;
1913 CONSP (other);
1914 other_prev = other, other = XCONS (other)->cdr)
1915 {
1916 Lisp_Object otherend, otheroverlay;
1917 int win;
1918
1919 otheroverlay = XCONS (other)->car;
1920 if (! OVERLAY_VALID (otheroverlay))
1921 abort ();
1922
1923 otherend = OVERLAY_END (otheroverlay);
1924 if (OVERLAY_POSITION (otherend) <= where)
1925 break;
1926 }
1927
1928 /* Add TAIL to overlays_before before OTHER. */
1929 XCONS (tail)->cdr = other;
1930 if (!NILP (other_prev))
1931 XCONS (other_prev)->cdr = tail;
1932 else
1933 buf->overlays_before = tail;
1934 tail = prev;
1935 }
1936 }
1937
1938 XSETFASTINT (buf->overlay_center, pos);
1939 }
1940
1941 void
1942 adjust_overlays_for_insert (pos, length)
1943 int pos;
1944 int length;
1945 {
1946 /* After an insertion, the lists are still sorted properly,
1947 but we may need to update the value of the overlay center. */
1948 if (XFASTINT (current_buffer->overlay_center) >= pos)
1949 XSETFASTINT (current_buffer->overlay_center,
1950 XFASTINT (current_buffer->overlay_center) + length);
1951 }
1952
1953 void
1954 adjust_overlays_for_delete (pos, length)
1955 int pos;
1956 int length;
1957 {
1958 if (XFASTINT (current_buffer->overlay_center) < pos)
1959 /* The deletion was to our right. No change needed; the before- and
1960 after-lists are still consistent. */
1961 ;
1962 else if (XFASTINT (current_buffer->overlay_center) > pos + length)
1963 /* The deletion was to our left. We need to adjust the center value
1964 to account for the change in position, but the lists are consistent
1965 given the new value. */
1966 XSETFASTINT (current_buffer->overlay_center,
1967 XFASTINT (current_buffer->overlay_center) - length);
1968 else
1969 /* We're right in the middle. There might be things on the after-list
1970 that now belong on the before-list. Recentering will move them,
1971 and also update the center point. */
1972 recenter_overlay_lists (current_buffer, pos);
1973 }
1974
1975 /* Fix up overlays that were garbled as a result of permuting markers
1976 in the range START through END. Any overlay with at least one
1977 endpoint in this range will need to be unlinked from the overlay
1978 list and reinserted in its proper place.
1979 Such an overlay might even have negative size at this point.
1980 If so, we'll reverse the endpoints. Can you think of anything
1981 better to do in this situation? */
1982 void
1983 fix_overlays_in_range (start, end)
1984 register int start, end;
1985 {
1986 Lisp_Object tem, overlay;
1987 Lisp_Object before_list, after_list;
1988 Lisp_Object *ptail, *pbefore = &before_list, *pafter = &after_list;
1989 int startpos, endpos;
1990
1991 /* This algorithm shifts links around instead of consing and GCing.
1992 The loop invariant is that before_list (resp. after_list) is a
1993 well-formed list except that its last element, the one that
1994 *pbefore (resp. *pafter) points to, is still uninitialized.
1995 So it's not a bug that before_list isn't initialized, although
1996 it may look strange. */
1997 for (ptail = &current_buffer->overlays_before; CONSP (*ptail);)
1998 {
1999 overlay = XCONS (*ptail)->car;
2000 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2001 if (endpos < start)
2002 break;
2003 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2004 if (endpos < end
2005 || (startpos >= start && startpos < end))
2006 {
2007 /* If the overlay is backwards, fix that now. */
2008 if (startpos > endpos)
2009 {
2010 int tem;
2011 Fset_marker (OVERLAY_START (overlay), endpos, Qnil);
2012 Fset_marker (OVERLAY_END (overlay), startpos, Qnil);
2013 tem = startpos; startpos = endpos; endpos = tem;
2014 }
2015 /* Add it to the end of the wrong list. Later on,
2016 recenter_overlay_lists will move it to the right place. */
2017 if (endpos < XINT (current_buffer->overlay_center))
2018 {
2019 *pafter = *ptail;
2020 pafter = &XCONS (*ptail)->cdr;
2021 }
2022 else
2023 {
2024 *pbefore = *ptail;
2025 pbefore = &XCONS (*ptail)->cdr;
2026 }
2027 *ptail = XCONS (*ptail)->cdr;
2028 }
2029 else
2030 ptail = &XCONS (*ptail)->cdr;
2031 }
2032 for (ptail = &current_buffer->overlays_after; CONSP (*ptail);)
2033 {
2034 overlay = XCONS (*ptail)->car;
2035 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2036 if (startpos >= end)
2037 break;
2038 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2039 if (startpos >= start
2040 || (endpos >= start && endpos < end))
2041 {
2042 if (startpos > endpos)
2043 {
2044 int tem;
2045 Fset_marker (OVERLAY_START (overlay), endpos, Qnil);
2046 Fset_marker (OVERLAY_END (overlay), startpos, Qnil);
2047 tem = startpos; startpos = endpos; endpos = tem;
2048 }
2049 if (endpos < XINT (current_buffer->overlay_center))
2050 {
2051 *pafter = *ptail;
2052 pafter = &XCONS (*ptail)->cdr;
2053 }
2054 else
2055 {
2056 *pbefore = *ptail;
2057 pbefore = &XCONS (*ptail)->cdr;
2058 }
2059 *ptail = XCONS (*ptail)->cdr;
2060 }
2061 else
2062 ptail = &XCONS (*ptail)->cdr;
2063 }
2064
2065 /* Splice the constructed (wrong) lists into the buffer's lists,
2066 and let the recenter function make it sane again. */
2067 *pbefore = current_buffer->overlays_before;
2068 current_buffer->overlays_before = before_list;
2069 recenter_overlay_lists (current_buffer,
2070 XINT (current_buffer->overlay_center));
2071
2072 *pafter = current_buffer->overlays_after;
2073 current_buffer->overlays_after = after_list;
2074 recenter_overlay_lists (current_buffer,
2075 XINT (current_buffer->overlay_center));
2076 }
2077 \f
2078 DEFUN ("overlayp", Foverlayp, Soverlayp, 1, 1, 0,
2079 "Return t if OBJECT is an overlay.")
2080 (object)
2081 Lisp_Object object;
2082 {
2083 return (OVERLAYP (object) ? Qt : Qnil);
2084 }
2085
2086 DEFUN ("make-overlay", Fmake_overlay, Smake_overlay, 2, 3, 0,
2087 "Create a new overlay with range BEG to END in BUFFER.\n\
2088 If omitted, BUFFER defaults to the current buffer.\n\
2089 BEG and END may be integers or markers.")
2090 (beg, end, buffer)
2091 Lisp_Object beg, end, buffer;
2092 {
2093 Lisp_Object overlay;
2094 struct buffer *b;
2095
2096 if (NILP (buffer))
2097 XSETBUFFER (buffer, current_buffer);
2098 else
2099 CHECK_BUFFER (buffer, 2);
2100 if (MARKERP (beg)
2101 && ! EQ (Fmarker_buffer (beg), buffer))
2102 error ("Marker points into wrong buffer");
2103 if (MARKERP (end)
2104 && ! EQ (Fmarker_buffer (end), buffer))
2105 error ("Marker points into wrong buffer");
2106
2107 CHECK_NUMBER_COERCE_MARKER (beg, 1);
2108 CHECK_NUMBER_COERCE_MARKER (end, 1);
2109
2110 if (XINT (beg) > XINT (end))
2111 {
2112 Lisp_Object temp;
2113 temp = beg; beg = end; end = temp;
2114 }
2115
2116 b = XBUFFER (buffer);
2117
2118 beg = Fset_marker (Fmake_marker (), beg, buffer);
2119 end = Fset_marker (Fmake_marker (), end, buffer);
2120
2121 overlay = allocate_misc ();
2122 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
2123 XOVERLAY (overlay)->start = beg;
2124 XOVERLAY (overlay)->end = end;
2125 XOVERLAY (overlay)->plist = Qnil;
2126
2127 /* Put the new overlay on the wrong list. */
2128 end = OVERLAY_END (overlay);
2129 if (OVERLAY_POSITION (end) < XINT (b->overlay_center))
2130 b->overlays_after = Fcons (overlay, b->overlays_after);
2131 else
2132 b->overlays_before = Fcons (overlay, b->overlays_before);
2133
2134 /* This puts it in the right list, and in the right order. */
2135 recenter_overlay_lists (b, XINT (b->overlay_center));
2136
2137 /* We don't need to redisplay the region covered by the overlay, because
2138 the overlay has no properties at the moment. */
2139
2140 return overlay;
2141 }
2142
2143 DEFUN ("move-overlay", Fmove_overlay, Smove_overlay, 3, 4, 0,
2144 "Set the endpoints of OVERLAY to BEG and END in BUFFER.\n\
2145 If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.\n\
2146 If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current\n\
2147 buffer.")
2148 (overlay, beg, end, buffer)
2149 Lisp_Object overlay, beg, end, buffer;
2150 {
2151 struct buffer *b, *ob;
2152 Lisp_Object obuffer;
2153 int count = specpdl_ptr - specpdl;
2154
2155 CHECK_OVERLAY (overlay, 0);
2156 if (NILP (buffer))
2157 buffer = Fmarker_buffer (OVERLAY_START (overlay));
2158 if (NILP (buffer))
2159 XSETBUFFER (buffer, current_buffer);
2160 CHECK_BUFFER (buffer, 3);
2161
2162 if (MARKERP (beg)
2163 && ! EQ (Fmarker_buffer (beg), buffer))
2164 error ("Marker points into wrong buffer");
2165 if (MARKERP (end)
2166 && ! EQ (Fmarker_buffer (end), buffer))
2167 error ("Marker points into wrong buffer");
2168
2169 CHECK_NUMBER_COERCE_MARKER (beg, 1);
2170 CHECK_NUMBER_COERCE_MARKER (end, 1);
2171
2172 if (XINT (beg) == XINT (end) && ! NILP (Foverlay_get (overlay, Qevaporate)))
2173 return Fdelete_overlay (overlay);
2174
2175 if (XINT (beg) > XINT (end))
2176 {
2177 Lisp_Object temp;
2178 temp = beg; beg = end; end = temp;
2179 }
2180
2181 specbind (Qinhibit_quit, Qt);
2182
2183 obuffer = Fmarker_buffer (OVERLAY_START (overlay));
2184 b = XBUFFER (buffer);
2185 ob = XBUFFER (obuffer);
2186
2187 /* If the overlay has changed buffers, do a thorough redisplay. */
2188 if (!EQ (buffer, obuffer))
2189 {
2190 /* Redisplay where the overlay was. */
2191 if (!NILP (obuffer))
2192 {
2193 Lisp_Object o_beg;
2194 Lisp_Object o_end;
2195
2196 o_beg = OVERLAY_START (overlay);
2197 o_end = OVERLAY_END (overlay);
2198 o_beg = OVERLAY_POSITION (o_beg);
2199 o_end = OVERLAY_POSITION (o_end);
2200
2201 redisplay_region (ob, XINT (o_beg), XINT (o_end));
2202 }
2203
2204 /* Redisplay where the overlay is going to be. */
2205 redisplay_region (b, XINT (beg), XINT (end));
2206
2207 /* Don't limit redisplay to the selected window. */
2208 windows_or_buffers_changed = 1;
2209 }
2210 else
2211 /* Redisplay the area the overlay has just left, or just enclosed. */
2212 {
2213 Lisp_Object o_beg;
2214 Lisp_Object o_end;
2215 int change_beg, change_end;
2216
2217 o_beg = OVERLAY_START (overlay);
2218 o_end = OVERLAY_END (overlay);
2219 o_beg = OVERLAY_POSITION (o_beg);
2220 o_end = OVERLAY_POSITION (o_end);
2221
2222 if (XINT (o_beg) == XINT (beg))
2223 redisplay_region (b, XINT (o_end), XINT (end));
2224 else if (XINT (o_end) == XINT (end))
2225 redisplay_region (b, XINT (o_beg), XINT (beg));
2226 else
2227 {
2228 if (XINT (beg) < XINT (o_beg)) o_beg = beg;
2229 if (XINT (end) > XINT (o_end)) o_end = end;
2230 redisplay_region (b, XINT (o_beg), XINT (o_end));
2231 }
2232 }
2233
2234 if (!NILP (obuffer))
2235 {
2236 ob->overlays_before = Fdelq (overlay, ob->overlays_before);
2237 ob->overlays_after = Fdelq (overlay, ob->overlays_after);
2238 }
2239
2240 Fset_marker (OVERLAY_START (overlay), beg, buffer);
2241 Fset_marker (OVERLAY_END (overlay), end, buffer);
2242
2243 /* Put the overlay on the wrong list. */
2244 end = OVERLAY_END (overlay);
2245 if (OVERLAY_POSITION (end) < XINT (b->overlay_center))
2246 b->overlays_after = Fcons (overlay, b->overlays_after);
2247 else
2248 b->overlays_before = Fcons (overlay, b->overlays_before);
2249
2250 /* This puts it in the right list, and in the right order. */
2251 recenter_overlay_lists (b, XINT (b->overlay_center));
2252
2253 return unbind_to (count, overlay);
2254 }
2255
2256 DEFUN ("delete-overlay", Fdelete_overlay, Sdelete_overlay, 1, 1, 0,
2257 "Delete the overlay OVERLAY from its buffer.")
2258 (overlay)
2259 Lisp_Object overlay;
2260 {
2261 Lisp_Object buffer;
2262 struct buffer *b;
2263 int count = specpdl_ptr - specpdl;
2264
2265 CHECK_OVERLAY (overlay, 0);
2266
2267 buffer = Fmarker_buffer (OVERLAY_START (overlay));
2268 if (NILP (buffer))
2269 return Qnil;
2270
2271 b = XBUFFER (buffer);
2272
2273 specbind (Qinhibit_quit, Qt);
2274
2275 b->overlays_before = Fdelq (overlay, b->overlays_before);
2276 b->overlays_after = Fdelq (overlay, b->overlays_after);
2277
2278 redisplay_region (b,
2279 marker_position (OVERLAY_START (overlay)),
2280 marker_position (OVERLAY_END (overlay)));
2281
2282 Fset_marker (OVERLAY_START (overlay), Qnil, Qnil);
2283 Fset_marker (OVERLAY_END (overlay), Qnil, Qnil);
2284
2285 return unbind_to (count, Qnil);
2286 }
2287 \f
2288 /* Overlay dissection functions. */
2289
2290 DEFUN ("overlay-start", Foverlay_start, Soverlay_start, 1, 1, 0,
2291 "Return the position at which OVERLAY starts.")
2292 (overlay)
2293 Lisp_Object overlay;
2294 {
2295 CHECK_OVERLAY (overlay, 0);
2296
2297 return (Fmarker_position (OVERLAY_START (overlay)));
2298 }
2299
2300 DEFUN ("overlay-end", Foverlay_end, Soverlay_end, 1, 1, 0,
2301 "Return the position at which OVERLAY ends.")
2302 (overlay)
2303 Lisp_Object overlay;
2304 {
2305 CHECK_OVERLAY (overlay, 0);
2306
2307 return (Fmarker_position (OVERLAY_END (overlay)));
2308 }
2309
2310 DEFUN ("overlay-buffer", Foverlay_buffer, Soverlay_buffer, 1, 1, 0,
2311 "Return the buffer OVERLAY belongs to.")
2312 (overlay)
2313 Lisp_Object overlay;
2314 {
2315 CHECK_OVERLAY (overlay, 0);
2316
2317 return Fmarker_buffer (OVERLAY_START (overlay));
2318 }
2319
2320 DEFUN ("overlay-properties", Foverlay_properties, Soverlay_properties, 1, 1, 0,
2321 "Return a list of the properties on OVERLAY.\n\
2322 This is a copy of OVERLAY's plist; modifying its conses has no effect on\n\
2323 OVERLAY.")
2324 (overlay)
2325 Lisp_Object overlay;
2326 {
2327 CHECK_OVERLAY (overlay, 0);
2328
2329 return Fcopy_sequence (XOVERLAY (overlay)->plist);
2330 }
2331
2332 \f
2333 DEFUN ("overlays-at", Foverlays_at, Soverlays_at, 1, 1, 0,
2334 "Return a list of the overlays that contain position POS.")
2335 (pos)
2336 Lisp_Object pos;
2337 {
2338 int noverlays;
2339 Lisp_Object *overlay_vec;
2340 int len;
2341 Lisp_Object result;
2342
2343 CHECK_NUMBER_COERCE_MARKER (pos, 0);
2344
2345 len = 10;
2346 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
2347
2348 /* Put all the overlays we want in a vector in overlay_vec.
2349 Store the length in len. */
2350 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
2351 (int *) 0, (int *) 0);
2352
2353 /* Make a list of them all. */
2354 result = Flist (noverlays, overlay_vec);
2355
2356 xfree (overlay_vec);
2357 return result;
2358 }
2359
2360 DEFUN ("next-overlay-change", Fnext_overlay_change, Snext_overlay_change,
2361 1, 1, 0,
2362 "Return the next position after POS where an overlay starts or ends.\n\
2363 If there are no more overlay boundaries after POS, return (point-max).")
2364 (pos)
2365 Lisp_Object pos;
2366 {
2367 int noverlays;
2368 int endpos;
2369 Lisp_Object *overlay_vec;
2370 int len;
2371 int i;
2372
2373 CHECK_NUMBER_COERCE_MARKER (pos, 0);
2374
2375 len = 10;
2376 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
2377
2378 /* Put all the overlays we want in a vector in overlay_vec.
2379 Store the length in len.
2380 endpos gets the position where the next overlay starts. */
2381 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
2382 &endpos, (int *) 0);
2383
2384 /* If any of these overlays ends before endpos,
2385 use its ending point instead. */
2386 for (i = 0; i < noverlays; i++)
2387 {
2388 Lisp_Object oend;
2389 int oendpos;
2390
2391 oend = OVERLAY_END (overlay_vec[i]);
2392 oendpos = OVERLAY_POSITION (oend);
2393 if (oendpos < endpos)
2394 endpos = oendpos;
2395 }
2396
2397 xfree (overlay_vec);
2398 return make_number (endpos);
2399 }
2400
2401 DEFUN ("previous-overlay-change", Fprevious_overlay_change,
2402 Sprevious_overlay_change, 1, 1, 0,
2403 "Return the previous position before POS where an overlay starts or ends.\n\
2404 If there are no more overlay boundaries after POS, return (point-min).")
2405 (pos)
2406 Lisp_Object pos;
2407 {
2408 int noverlays;
2409 int prevpos;
2410 Lisp_Object *overlay_vec;
2411 int len;
2412 int i;
2413
2414 CHECK_NUMBER_COERCE_MARKER (pos, 0);
2415
2416 len = 10;
2417 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
2418
2419 /* Put all the overlays we want in a vector in overlay_vec.
2420 Store the length in len.
2421 prevpos gets the position of an overlay end. */
2422 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
2423 (int *) 0, &prevpos);
2424
2425 /* If any of these overlays starts before endpos,
2426 maybe use its starting point instead. */
2427 for (i = 0; i < noverlays; i++)
2428 {
2429 Lisp_Object ostart;
2430 int ostartpos;
2431
2432 ostart = OVERLAY_START (overlay_vec[i]);
2433 ostartpos = OVERLAY_POSITION (ostart);
2434 if (ostartpos > prevpos && ostartpos < XINT (pos))
2435 prevpos = ostartpos;
2436 }
2437
2438 xfree (overlay_vec);
2439 return make_number (prevpos);
2440 }
2441 \f
2442 /* These functions are for debugging overlays. */
2443
2444 DEFUN ("overlay-lists", Foverlay_lists, Soverlay_lists, 0, 0, 0,
2445 "Return a pair of lists giving all the overlays of the current buffer.\n\
2446 The car has all the overlays before the overlay center;\n\
2447 the cdr has all the overlays after the overlay center.\n\
2448 Recentering overlays moves overlays between these lists.\n\
2449 The lists you get are copies, so that changing them has no effect.\n\
2450 However, the overlays you get are the real objects that the buffer uses.")
2451 ()
2452 {
2453 Lisp_Object before, after;
2454 before = current_buffer->overlays_before;
2455 if (CONSP (before))
2456 before = Fcopy_sequence (before);
2457 after = current_buffer->overlays_after;
2458 if (CONSP (after))
2459 after = Fcopy_sequence (after);
2460
2461 return Fcons (before, after);
2462 }
2463
2464 DEFUN ("overlay-recenter", Foverlay_recenter, Soverlay_recenter, 1, 1, 0,
2465 "Recenter the overlays of the current buffer around position POS.")
2466 (pos)
2467 Lisp_Object pos;
2468 {
2469 CHECK_NUMBER_COERCE_MARKER (pos, 0);
2470
2471 recenter_overlay_lists (current_buffer, XINT (pos));
2472 return Qnil;
2473 }
2474 \f
2475 DEFUN ("overlay-get", Foverlay_get, Soverlay_get, 2, 2, 0,
2476 "Get the property of overlay OVERLAY with property name NAME.")
2477 (overlay, prop)
2478 Lisp_Object overlay, prop;
2479 {
2480 Lisp_Object plist, fallback;
2481
2482 CHECK_OVERLAY (overlay, 0);
2483
2484 fallback = Qnil;
2485
2486 for (plist = XOVERLAY (overlay)->plist;
2487 CONSP (plist) && CONSP (XCONS (plist)->cdr);
2488 plist = XCONS (XCONS (plist)->cdr)->cdr)
2489 {
2490 if (EQ (XCONS (plist)->car, prop))
2491 return XCONS (XCONS (plist)->cdr)->car;
2492 else if (EQ (XCONS (plist)->car, Qcategory))
2493 {
2494 Lisp_Object tem;
2495 tem = Fcar (Fcdr (plist));
2496 if (SYMBOLP (tem))
2497 fallback = Fget (tem, prop);
2498 }
2499 }
2500
2501 return fallback;
2502 }
2503
2504 DEFUN ("overlay-put", Foverlay_put, Soverlay_put, 3, 3, 0,
2505 "Set one property of overlay OVERLAY: give property PROP value VALUE.")
2506 (overlay, prop, value)
2507 Lisp_Object overlay, prop, value;
2508 {
2509 Lisp_Object tail, buffer;
2510 int changed;
2511
2512 CHECK_OVERLAY (overlay, 0);
2513
2514 buffer = Fmarker_buffer (OVERLAY_START (overlay));
2515
2516 for (tail = XOVERLAY (overlay)->plist;
2517 CONSP (tail) && CONSP (XCONS (tail)->cdr);
2518 tail = XCONS (XCONS (tail)->cdr)->cdr)
2519 if (EQ (XCONS (tail)->car, prop))
2520 {
2521 changed = !EQ (XCONS (XCONS (tail)->cdr)->car, value);
2522 XCONS (XCONS (tail)->cdr)->car = value;
2523 goto found;
2524 }
2525 /* It wasn't in the list, so add it to the front. */
2526 changed = !NILP (value);
2527 XOVERLAY (overlay)->plist
2528 = Fcons (prop, Fcons (value, XOVERLAY (overlay)->plist));
2529 found:
2530 if (! NILP (buffer))
2531 {
2532 if (changed)
2533 redisplay_region (XBUFFER (buffer),
2534 marker_position (OVERLAY_START (overlay)),
2535 marker_position (OVERLAY_END (overlay)));
2536 if (EQ (prop, Qevaporate) && ! NILP (value)
2537 && (OVERLAY_POSITION (OVERLAY_START (overlay))
2538 == OVERLAY_POSITION (OVERLAY_END (overlay))))
2539 Fdelete_overlay (overlay);
2540 }
2541 return value;
2542 }
2543 \f
2544 /* Run the modification-hooks of overlays that include
2545 any part of the text in START to END.
2546 Run the insert-before-hooks of overlay starting at END,
2547 and the insert-after-hooks of overlay ending at START.
2548
2549 This is called both before and after the modification.
2550 AFTER is nonzero when we call after the modification.
2551
2552 ARG1, ARG2, ARG3 are arguments to pass to the hook functions. */
2553
2554 void
2555 report_overlay_modification (start, end, after, arg1, arg2, arg3)
2556 Lisp_Object start, end;
2557 int after;
2558 Lisp_Object arg1, arg2, arg3;
2559 {
2560 Lisp_Object prop, overlay, tail;
2561 int insertion = EQ (start, end);
2562 int tail_copied;
2563 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
2564
2565 overlay = Qnil;
2566 tail = Qnil;
2567 GCPRO5 (overlay, tail, arg1, arg2, arg3);
2568
2569 tail_copied = 0;
2570 for (tail = current_buffer->overlays_before;
2571 CONSP (tail);
2572 tail = XCONS (tail)->cdr)
2573 {
2574 int startpos, endpos;
2575 Lisp_Object ostart, oend;
2576
2577 overlay = XCONS (tail)->car;
2578
2579 ostart = OVERLAY_START (overlay);
2580 oend = OVERLAY_END (overlay);
2581 endpos = OVERLAY_POSITION (oend);
2582 if (XFASTINT (start) > endpos)
2583 break;
2584 startpos = OVERLAY_POSITION (ostart);
2585 if (XFASTINT (end) == startpos && insertion)
2586 {
2587 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
2588 if (!NILP (prop))
2589 {
2590 /* Copy TAIL in case the hook recenters the overlay lists. */
2591 if (!tail_copied)
2592 tail = Fcopy_sequence (tail);
2593 tail_copied = 1;
2594 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
2595 }
2596 }
2597 if (XFASTINT (start) == endpos && insertion)
2598 {
2599 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
2600 if (!NILP (prop))
2601 {
2602 if (!tail_copied)
2603 tail = Fcopy_sequence (tail);
2604 tail_copied = 1;
2605 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
2606 }
2607 }
2608 /* Test for intersecting intervals. This does the right thing
2609 for both insertion and deletion. */
2610 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
2611 {
2612 prop = Foverlay_get (overlay, Qmodification_hooks);
2613 if (!NILP (prop))
2614 {
2615 if (!tail_copied)
2616 tail = Fcopy_sequence (tail);
2617 tail_copied = 1;
2618 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
2619 }
2620 }
2621 }
2622
2623 tail_copied = 0;
2624 for (tail = current_buffer->overlays_after;
2625 CONSP (tail);
2626 tail = XCONS (tail)->cdr)
2627 {
2628 int startpos, endpos;
2629 Lisp_Object ostart, oend;
2630
2631 overlay = XCONS (tail)->car;
2632
2633 ostart = OVERLAY_START (overlay);
2634 oend = OVERLAY_END (overlay);
2635 startpos = OVERLAY_POSITION (ostart);
2636 endpos = OVERLAY_POSITION (oend);
2637 if (XFASTINT (end) < startpos)
2638 break;
2639 if (XFASTINT (end) == startpos && insertion)
2640 {
2641 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
2642 if (!NILP (prop))
2643 {
2644 if (!tail_copied)
2645 tail = Fcopy_sequence (tail);
2646 tail_copied = 1;
2647 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
2648 }
2649 }
2650 if (XFASTINT (start) == endpos && insertion)
2651 {
2652 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
2653 if (!NILP (prop))
2654 {
2655 if (!tail_copied)
2656 tail = Fcopy_sequence (tail);
2657 tail_copied = 1;
2658 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
2659 }
2660 }
2661 /* Test for intersecting intervals. This does the right thing
2662 for both insertion and deletion. */
2663 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
2664 {
2665 prop = Foverlay_get (overlay, Qmodification_hooks);
2666 if (!NILP (prop))
2667 {
2668 if (!tail_copied)
2669 tail = Fcopy_sequence (tail);
2670 tail_copied = 1;
2671 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
2672 }
2673 }
2674 }
2675
2676 UNGCPRO;
2677 }
2678
2679 static void
2680 call_overlay_mod_hooks (list, overlay, after, arg1, arg2, arg3)
2681 Lisp_Object list, overlay;
2682 int after;
2683 Lisp_Object arg1, arg2, arg3;
2684 {
2685 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2686 GCPRO4 (list, arg1, arg2, arg3);
2687 while (!NILP (list))
2688 {
2689 if (NILP (arg3))
2690 call4 (Fcar (list), overlay, after ? Qt : Qnil, arg1, arg2);
2691 else
2692 call5 (Fcar (list), overlay, after ? Qt : Qnil, arg1, arg2, arg3);
2693 list = Fcdr (list);
2694 }
2695 UNGCPRO;
2696 }
2697
2698 /* Delete any zero-sized overlays at position POS, if the `evaporate'
2699 property is set. */
2700 void
2701 evaporate_overlays (pos)
2702 int pos;
2703 {
2704 Lisp_Object tail, overlay, hit_list;
2705
2706 hit_list = Qnil;
2707 if (pos <= XFASTINT (current_buffer->overlay_center))
2708 for (tail = current_buffer->overlays_before; CONSP (tail);
2709 tail = XCONS (tail)->cdr)
2710 {
2711 int endpos;
2712 overlay = XCONS (tail)->car;
2713 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2714 if (endpos < pos)
2715 break;
2716 if (endpos == pos && OVERLAY_POSITION (OVERLAY_START (overlay)) == pos
2717 && ! NILP (Foverlay_get (overlay, Qevaporate)))
2718 hit_list = Fcons (overlay, hit_list);
2719 }
2720 else
2721 for (tail = current_buffer->overlays_after; CONSP (tail);
2722 tail = XCONS (tail)->cdr)
2723 {
2724 int startpos;
2725 overlay = XCONS (tail)->car;
2726 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2727 if (startpos > pos)
2728 break;
2729 if (startpos == pos && OVERLAY_POSITION (OVERLAY_END (overlay)) == pos
2730 && ! NILP (Foverlay_get (overlay, Qevaporate)))
2731 hit_list = Fcons (overlay, hit_list);
2732 }
2733 for (; CONSP (hit_list); hit_list = XCONS (hit_list)->cdr)
2734 Fdelete_overlay (XCONS (hit_list)->car);
2735 }
2736 \f
2737 /* Somebody has tried to store a value with an unacceptable type
2738 into the buffer-local slot with offset OFFSET. */
2739 void
2740 buffer_slot_type_mismatch (offset)
2741 int offset;
2742 {
2743 Lisp_Object sym;
2744 char *type_name;
2745 sym = *(Lisp_Object *)(offset + (char *)&buffer_local_symbols);
2746 switch (XINT (*(Lisp_Object *)(offset + (char *)&buffer_local_types)))
2747 {
2748 case Lisp_Int: type_name = "integers"; break;
2749 case Lisp_String: type_name = "strings"; break;
2750 case Lisp_Symbol: type_name = "symbols"; break;
2751 default:
2752 abort ();
2753 }
2754
2755 error ("only %s should be stored in the buffer-local variable %s",
2756 type_name, XSYMBOL (sym)->name->data);
2757 }
2758 \f
2759 init_buffer_once ()
2760 {
2761 register Lisp_Object tem;
2762
2763 /* Make sure all markable slots in buffer_defaults
2764 are initialized reasonably, so mark_buffer won't choke. */
2765 reset_buffer (&buffer_defaults);
2766 reset_buffer_local_variables (&buffer_defaults);
2767 reset_buffer (&buffer_local_symbols);
2768 reset_buffer_local_variables (&buffer_local_symbols);
2769 /* Prevent GC from getting confused. */
2770 buffer_defaults.text = &buffer_defaults.own_text;
2771 buffer_local_symbols.text = &buffer_local_symbols.own_text;
2772 #ifdef USE_TEXT_PROPERTIES
2773 BUF_INTERVALS (&buffer_defaults) = 0;
2774 BUF_INTERVALS (&buffer_local_symbols) = 0;
2775 #endif
2776 XSETBUFFER (Vbuffer_defaults, &buffer_defaults);
2777 XSETBUFFER (Vbuffer_local_symbols, &buffer_local_symbols);
2778
2779 /* Set up the default values of various buffer slots. */
2780 /* Must do these before making the first buffer! */
2781
2782 /* real setup is done in loaddefs.el */
2783 buffer_defaults.mode_line_format = build_string ("%-");
2784 buffer_defaults.abbrev_mode = Qnil;
2785 buffer_defaults.overwrite_mode = Qnil;
2786 buffer_defaults.case_fold_search = Qt;
2787 buffer_defaults.auto_fill_function = Qnil;
2788 buffer_defaults.selective_display = Qnil;
2789 #ifndef old
2790 buffer_defaults.selective_display_ellipses = Qt;
2791 #endif
2792 buffer_defaults.abbrev_table = Qnil;
2793 buffer_defaults.display_table = Qnil;
2794 buffer_defaults.undo_list = Qnil;
2795 buffer_defaults.mark_active = Qnil;
2796 buffer_defaults.file_format = Qnil;
2797 buffer_defaults.overlays_before = Qnil;
2798 buffer_defaults.overlays_after = Qnil;
2799 XSETFASTINT (buffer_defaults.overlay_center, 1);
2800
2801 XSETFASTINT (buffer_defaults.tab_width, 8);
2802 buffer_defaults.truncate_lines = Qnil;
2803 buffer_defaults.ctl_arrow = Qt;
2804
2805 #ifdef DOS_NT
2806 buffer_defaults.buffer_file_type = Qnil; /* TEXT */
2807 #endif
2808 XSETFASTINT (buffer_defaults.fill_column, 70);
2809 XSETFASTINT (buffer_defaults.left_margin, 0);
2810 buffer_defaults.cache_long_line_scans = Qnil;
2811 buffer_defaults.file_truename = Qnil;
2812
2813 /* Assign the local-flags to the slots that have default values.
2814 The local flag is a bit that is used in the buffer
2815 to say that it has its own local value for the slot.
2816 The local flag bits are in the local_var_flags slot of the buffer. */
2817
2818 /* Nothing can work if this isn't true */
2819 if (sizeof (EMACS_INT) != sizeof (Lisp_Object)) abort ();
2820
2821 /* 0 means not a lisp var, -1 means always local, else mask */
2822 bzero (&buffer_local_flags, sizeof buffer_local_flags);
2823 XSETINT (buffer_local_flags.filename, -1);
2824 XSETINT (buffer_local_flags.directory, -1);
2825 XSETINT (buffer_local_flags.backed_up, -1);
2826 XSETINT (buffer_local_flags.save_length, -1);
2827 XSETINT (buffer_local_flags.auto_save_file_name, -1);
2828 XSETINT (buffer_local_flags.read_only, -1);
2829 XSETINT (buffer_local_flags.major_mode, -1);
2830 XSETINT (buffer_local_flags.mode_name, -1);
2831 XSETINT (buffer_local_flags.undo_list, -1);
2832 XSETINT (buffer_local_flags.mark_active, -1);
2833 XSETINT (buffer_local_flags.point_before_scroll, -1);
2834 XSETINT (buffer_local_flags.file_truename, -1);
2835 XSETINT (buffer_local_flags.invisibility_spec, -1);
2836
2837 XSETFASTINT (buffer_local_flags.mode_line_format, 1);
2838 XSETFASTINT (buffer_local_flags.abbrev_mode, 2);
2839 XSETFASTINT (buffer_local_flags.overwrite_mode, 4);
2840 XSETFASTINT (buffer_local_flags.case_fold_search, 8);
2841 XSETFASTINT (buffer_local_flags.auto_fill_function, 0x10);
2842 XSETFASTINT (buffer_local_flags.selective_display, 0x20);
2843 #ifndef old
2844 XSETFASTINT (buffer_local_flags.selective_display_ellipses, 0x40);
2845 #endif
2846 XSETFASTINT (buffer_local_flags.tab_width, 0x80);
2847 XSETFASTINT (buffer_local_flags.truncate_lines, 0x100);
2848 XSETFASTINT (buffer_local_flags.ctl_arrow, 0x200);
2849 XSETFASTINT (buffer_local_flags.fill_column, 0x400);
2850 XSETFASTINT (buffer_local_flags.left_margin, 0x800);
2851 XSETFASTINT (buffer_local_flags.abbrev_table, 0x1000);
2852 XSETFASTINT (buffer_local_flags.display_table, 0x2000);
2853 XSETFASTINT (buffer_local_flags.syntax_table, 0x8000);
2854 XSETFASTINT (buffer_local_flags.cache_long_line_scans, 0x10000);
2855 XSETFASTINT (buffer_local_flags.file_format, 0x20000);
2856 #ifdef DOS_NT
2857 XSETFASTINT (buffer_local_flags.buffer_file_type, 0x4000);
2858 #endif
2859
2860 Vbuffer_alist = Qnil;
2861 current_buffer = 0;
2862 all_buffers = 0;
2863
2864 QSFundamental = build_string ("Fundamental");
2865
2866 Qfundamental_mode = intern ("fundamental-mode");
2867 buffer_defaults.major_mode = Qfundamental_mode;
2868
2869 Qmode_class = intern ("mode-class");
2870
2871 Qprotected_field = intern ("protected-field");
2872
2873 Qpermanent_local = intern ("permanent-local");
2874
2875 Qkill_buffer_hook = intern ("kill-buffer-hook");
2876
2877 Vprin1_to_string_buffer = Fget_buffer_create (build_string (" prin1"));
2878 /* super-magic invisible buffer */
2879 Vbuffer_alist = Qnil;
2880
2881 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
2882 }
2883
2884 init_buffer ()
2885 {
2886 char buf[MAXPATHLEN+1];
2887 char *pwd;
2888 struct stat dotstat, pwdstat;
2889 Lisp_Object temp;
2890 int rc;
2891
2892 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
2893
2894 /* If PWD is accurate, use it instead of calling getwd. This is faster
2895 when PWD is right, and may avoid a fatal error. */
2896 if ((pwd = getenv ("PWD")) != 0 && IS_DIRECTORY_SEP (*pwd)
2897 && stat (pwd, &pwdstat) == 0
2898 && stat (".", &dotstat) == 0
2899 && dotstat.st_ino == pwdstat.st_ino
2900 && dotstat.st_dev == pwdstat.st_dev
2901 && strlen (pwd) < MAXPATHLEN)
2902 strcpy (buf, pwd);
2903 else if (getwd (buf) == 0)
2904 fatal ("`getwd' failed: %s\n", buf);
2905
2906 #ifndef VMS
2907 /* Maybe this should really use some standard subroutine
2908 whose definition is filename syntax dependent. */
2909 rc = strlen (buf);
2910 if (!(IS_DIRECTORY_SEP (buf[rc - 1])))
2911 {
2912 buf[rc] = DIRECTORY_SEP;
2913 buf[rc + 1] = '\0';
2914 }
2915 #endif /* not VMS */
2916 current_buffer->directory = build_string (buf);
2917
2918 temp = get_minibuffer (0);
2919 XBUFFER (temp)->directory = current_buffer->directory;
2920 }
2921
2922 /* initialize the buffer routines */
2923 syms_of_buffer ()
2924 {
2925 extern Lisp_Object Qdisabled;
2926
2927 staticpro (&Vbuffer_defaults);
2928 staticpro (&Vbuffer_local_symbols);
2929 staticpro (&Qfundamental_mode);
2930 staticpro (&Qmode_class);
2931 staticpro (&QSFundamental);
2932 staticpro (&Vbuffer_alist);
2933 staticpro (&Qprotected_field);
2934 staticpro (&Qpermanent_local);
2935 staticpro (&Qkill_buffer_hook);
2936 staticpro (&Qoverlayp);
2937 Qevaporate = intern ("evaporate");
2938 staticpro (&Qevaporate);
2939 staticpro (&Qmodification_hooks);
2940 Qmodification_hooks = intern ("modification-hooks");
2941 staticpro (&Qinsert_in_front_hooks);
2942 Qinsert_in_front_hooks = intern ("insert-in-front-hooks");
2943 staticpro (&Qinsert_behind_hooks);
2944 Qinsert_behind_hooks = intern ("insert-behind-hooks");
2945 staticpro (&Qget_file_buffer);
2946 Qget_file_buffer = intern ("get-file-buffer");
2947 Qpriority = intern ("priority");
2948 staticpro (&Qpriority);
2949 Qwindow = intern ("window");
2950 staticpro (&Qwindow);
2951
2952 Qoverlayp = intern ("overlayp");
2953
2954 Fput (Qprotected_field, Qerror_conditions,
2955 Fcons (Qprotected_field, Fcons (Qerror, Qnil)));
2956 Fput (Qprotected_field, Qerror_message,
2957 build_string ("Attempt to modify a protected field"));
2958
2959 /* All these use DEFVAR_LISP_NOPRO because the slots in
2960 buffer_defaults will all be marked via Vbuffer_defaults. */
2961
2962 DEFVAR_LISP_NOPRO ("default-mode-line-format",
2963 &buffer_defaults.mode_line_format,
2964 "Default value of `mode-line-format' for buffers that don't override it.\n\
2965 This is the same as (default-value 'mode-line-format).");
2966
2967 DEFVAR_LISP_NOPRO ("default-abbrev-mode",
2968 &buffer_defaults.abbrev_mode,
2969 "Default value of `abbrev-mode' for buffers that do not override it.\n\
2970 This is the same as (default-value 'abbrev-mode).");
2971
2972 DEFVAR_LISP_NOPRO ("default-ctl-arrow",
2973 &buffer_defaults.ctl_arrow,
2974 "Default value of `ctl-arrow' for buffers that do not override it.\n\
2975 This is the same as (default-value 'ctl-arrow).");
2976
2977 DEFVAR_LISP_NOPRO ("default-truncate-lines",
2978 &buffer_defaults.truncate_lines,
2979 "Default value of `truncate-lines' for buffers that do not override it.\n\
2980 This is the same as (default-value 'truncate-lines).");
2981
2982 DEFVAR_LISP_NOPRO ("default-fill-column",
2983 &buffer_defaults.fill_column,
2984 "Default value of `fill-column' for buffers that do not override it.\n\
2985 This is the same as (default-value 'fill-column).");
2986
2987 DEFVAR_LISP_NOPRO ("default-left-margin",
2988 &buffer_defaults.left_margin,
2989 "Default value of `left-margin' for buffers that do not override it.\n\
2990 This is the same as (default-value 'left-margin).");
2991
2992 DEFVAR_LISP_NOPRO ("default-tab-width",
2993 &buffer_defaults.tab_width,
2994 "Default value of `tab-width' for buffers that do not override it.\n\
2995 This is the same as (default-value 'tab-width).");
2996
2997 DEFVAR_LISP_NOPRO ("default-case-fold-search",
2998 &buffer_defaults.case_fold_search,
2999 "Default value of `case-fold-search' for buffers that don't override it.\n\
3000 This is the same as (default-value 'case-fold-search).");
3001
3002 #ifdef DOS_NT
3003 DEFVAR_LISP_NOPRO ("default-buffer-file-type",
3004 &buffer_defaults.buffer_file_type,
3005 "Default file type for buffers that do not override it.\n\
3006 This is the same as (default-value 'buffer-file-type).\n\
3007 The file type is nil for text, t for binary.");
3008 #endif
3009
3010 DEFVAR_PER_BUFFER ("mode-line-format", &current_buffer->mode_line_format,
3011 Qnil, 0);
3012
3013 /* This doc string is too long for cpp; cpp dies if it isn't in a comment.
3014 But make-docfile finds it!
3015 DEFVAR_PER_BUFFER ("mode-line-format", &current_buffer->mode_line_format,
3016 Qnil,
3017 "Template for displaying mode line for current buffer.\n\
3018 Each buffer has its own value of this variable.\n\
3019 Value may be a string, a symbol or a list or cons cell.\n\
3020 For a symbol, its value is used (but it is ignored if t or nil).\n\
3021 A string appearing directly as the value of a symbol is processed verbatim\n\
3022 in that the %-constructs below are not recognized.\n\
3023 For a list whose car is a symbol, the symbol's value is taken,\n\
3024 and if that is non-nil, the cadr of the list is processed recursively.\n\
3025 Otherwise, the caddr of the list (if there is one) is processed.\n\
3026 For a list whose car is a string or list, each element is processed\n\
3027 recursively and the results are effectively concatenated.\n\
3028 For a list whose car is an integer, the cdr of the list is processed\n\
3029 and padded (if the number is positive) or truncated (if negative)\n\
3030 to the width specified by that number.\n\
3031 A string is printed verbatim in the mode line except for %-constructs:\n\
3032 (%-constructs are allowed when the string is the entire mode-line-format\n\
3033 or when it is found in a cons-cell or a list)\n\
3034 %b -- print buffer name. %f -- print visited file name.\n\
3035 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.\n\
3036 % means buffer is read-only and * means it is modified.\n\
3037 For a modified read-only buffer, %* gives % and %+ gives *.\n\
3038 %s -- print process status. %l -- print the current line number.\n\
3039 %p -- print percent of buffer above top of window, or Top, Bot or All.\n\
3040 %P -- print percent of buffer above bottom of window, perhaps plus Top,\n\
3041 or print Bottom or All.\n\
3042 %n -- print Narrow if appropriate.\n\
3043 %t -- print T if files is text, B if binary.\n\
3044 %[ -- print one [ for each recursive editing level. %] similar.\n\
3045 %% -- print %. %- -- print infinitely many dashes.\n\
3046 Decimal digits after the % specify field width to which to pad.");
3047 */
3048
3049 DEFVAR_LISP_NOPRO ("default-major-mode", &buffer_defaults.major_mode,
3050 "*Major mode for new buffers. Defaults to `fundamental-mode'.\n\
3051 nil here means use current buffer's major mode.");
3052
3053 DEFVAR_PER_BUFFER ("major-mode", &current_buffer->major_mode,
3054 make_number (Lisp_Symbol),
3055 "Symbol for current buffer's major mode.");
3056
3057 DEFVAR_PER_BUFFER ("mode-name", &current_buffer->mode_name,
3058 make_number (Lisp_String),
3059 "Pretty name of current buffer's major mode (a string).");
3060
3061 DEFVAR_PER_BUFFER ("abbrev-mode", &current_buffer->abbrev_mode, Qnil,
3062 "Non-nil turns on automatic expansion of abbrevs as they are inserted.\n\
3063 Automatically becomes buffer-local when set in any fashion.");
3064
3065 DEFVAR_PER_BUFFER ("case-fold-search", &current_buffer->case_fold_search,
3066 Qnil,
3067 "*Non-nil if searches should ignore case.\n\
3068 Automatically becomes buffer-local when set in any fashion.");
3069
3070 DEFVAR_PER_BUFFER ("fill-column", &current_buffer->fill_column,
3071 make_number (Lisp_Int),
3072 "*Column beyond which automatic line-wrapping should happen.\n\
3073 Automatically becomes buffer-local when set in any fashion.");
3074
3075 DEFVAR_PER_BUFFER ("left-margin", &current_buffer->left_margin,
3076 make_number (Lisp_Int),
3077 "*Column for the default indent-line-function to indent to.\n\
3078 Linefeed indents to this column in Fundamental mode.\n\
3079 Automatically becomes buffer-local when set in any fashion.");
3080
3081 DEFVAR_PER_BUFFER ("tab-width", &current_buffer->tab_width,
3082 make_number (Lisp_Int),
3083 "*Distance between tab stops (for display of tab characters), in columns.\n\
3084 Automatically becomes buffer-local when set in any fashion.");
3085
3086 DEFVAR_PER_BUFFER ("ctl-arrow", &current_buffer->ctl_arrow, Qnil,
3087 "*Non-nil means display control chars with uparrow.\n\
3088 Nil means use backslash and octal digits.\n\
3089 Automatically becomes buffer-local when set in any fashion.\n\
3090 This variable does not apply to characters whose display is specified\n\
3091 in the current display table (if there is one).");
3092
3093 DEFVAR_PER_BUFFER ("truncate-lines", &current_buffer->truncate_lines, Qnil,
3094 "*Non-nil means do not display continuation lines;\n\
3095 give each line of text one screen line.\n\
3096 Automatically becomes buffer-local when set in any fashion.\n\
3097 \n\
3098 Note that this is overridden by the variable\n\
3099 `truncate-partial-width-windows' if that variable is non-nil\n\
3100 and this buffer is not full-frame width.");
3101
3102 #ifdef DOS_NT
3103 DEFVAR_PER_BUFFER ("buffer-file-type", &current_buffer->buffer_file_type,
3104 Qnil,
3105 "Non-nil if the visited file is a binary file.\n\
3106 This variable is meaningful on MS-DOG and Windows NT.\n\
3107 On those systems, it is automatically local in every buffer.\n\
3108 On other systems, this variable is normally always nil.");
3109 #endif
3110
3111 DEFVAR_PER_BUFFER ("default-directory", &current_buffer->directory,
3112 make_number (Lisp_String),
3113 "Name of default directory of current buffer. Should end with slash.\n\
3114 Each buffer has its own value of this variable.");
3115
3116 DEFVAR_PER_BUFFER ("auto-fill-function", &current_buffer->auto_fill_function,
3117 Qnil,
3118 "Function called (if non-nil) to perform auto-fill.\n\
3119 It is called after self-inserting a space at a column beyond `fill-column'.\n\
3120 Each buffer has its own value of this variable.\n\
3121 NOTE: This variable is not an ordinary hook;\n\
3122 It may not be a list of functions.");
3123
3124 DEFVAR_PER_BUFFER ("buffer-file-name", &current_buffer->filename,
3125 make_number (Lisp_String),
3126 "Name of file visited in current buffer, or nil if not visiting a file.\n\
3127 Each buffer has its own value of this variable.");
3128
3129 DEFVAR_PER_BUFFER ("buffer-file-truename", &current_buffer->file_truename,
3130 make_number (Lisp_String),
3131 "Truename of file visited in current buffer, or nil if not visiting a file.\n\
3132 The truename of a file is calculated by `file-truename'.\n\
3133 Each buffer has its own value of this variable.");
3134
3135 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
3136 &current_buffer->auto_save_file_name,
3137 make_number (Lisp_String),
3138 "Name of file for auto-saving current buffer,\n\
3139 or nil if buffer should not be auto-saved.\n\
3140 Each buffer has its own value of this variable.");
3141
3142 DEFVAR_PER_BUFFER ("buffer-read-only", &current_buffer->read_only, Qnil,
3143 "Non-nil if this buffer is read-only.\n\
3144 Each buffer has its own value of this variable.");
3145
3146 DEFVAR_PER_BUFFER ("buffer-backed-up", &current_buffer->backed_up, Qnil,
3147 "Non-nil if this buffer's file has been backed up.\n\
3148 Backing up is done before the first time the file is saved.\n\
3149 Each buffer has its own value of this variable.");
3150
3151 DEFVAR_PER_BUFFER ("buffer-saved-size", &current_buffer->save_length,
3152 make_number (Lisp_Int),
3153 "Length of current buffer when last read in, saved or auto-saved.\n\
3154 0 initially.\n\
3155 Each buffer has its own value of this variable.");
3156
3157 DEFVAR_PER_BUFFER ("selective-display", &current_buffer->selective_display,
3158 Qnil,
3159 "Non-nil enables selective display:\n\
3160 Integer N as value means display only lines\n\
3161 that start with less than n columns of space.\n\
3162 A value of t means, after a ^M, all the rest of the line is invisible.\n\
3163 Then ^M's in the file are written into files as newlines.\n\n\
3164 Automatically becomes buffer-local when set in any fashion.");
3165
3166 #ifndef old
3167 DEFVAR_PER_BUFFER ("selective-display-ellipses",
3168 &current_buffer->selective_display_ellipses,
3169 Qnil,
3170 "t means display ... on previous line when a line is invisible.\n\
3171 Automatically becomes buffer-local when set in any fashion.");
3172 #endif
3173
3174 DEFVAR_PER_BUFFER ("overwrite-mode", &current_buffer->overwrite_mode, Qnil,
3175 "Non-nil if self-insertion should replace existing text.\n\
3176 The value should be one of `overwrite-mode-textual',\n\
3177 `overwrite-mode-binary', or nil.\n\
3178 If it is `overwrite-mode-textual', self-insertion still\n\
3179 inserts at the end of a line, and inserts when point is before a tab,\n\
3180 until the tab is filled in.\n\
3181 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too.\n\
3182 Automatically becomes buffer-local when set in any fashion.");
3183
3184 #if 0 /* The doc string is too long for some compilers,
3185 but make-docfile can find it in this comment. */
3186 DEFVAR_PER_BUFFER ("buffer-display-table", &current_buffer->display_table,
3187 Qnil,
3188 "Display table that controls display of the contents of current buffer.\n\
3189 Automatically becomes buffer-local when set in any fashion.\n\
3190 The display table is a vector created with `make-display-table'.\n\
3191 The first 256 elements control how to display each possible text character.\n\
3192 Each value should be a vector of characters or nil;\n\
3193 nil means display the character in the default fashion.\n\
3194 The remaining six elements control the display of\n\
3195 the end of a truncated screen line (element 256, a single character);\n\
3196 the end of a continued line (element 257, a single character);\n\
3197 the escape character used to display character codes in octal\n\
3198 (element 258, a single character);\n\
3199 the character used as an arrow for control characters (element 259,\n\
3200 a single character);\n\
3201 the decoration indicating the presence of invisible lines (element 260,\n\
3202 a vector of characters);\n\
3203 the character used to draw the border between side-by-side windows\n\
3204 (element 261, a single character).\n\
3205 If this variable is nil, the value of `standard-display-table' is used.\n\
3206 Each window can have its own, overriding display table.");
3207 #endif
3208 DEFVAR_PER_BUFFER ("buffer-display-table", &current_buffer->display_table,
3209 Qnil, 0);
3210
3211 /*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
3212 "Don't ask.");
3213 */
3214 DEFVAR_LISP ("before-change-function", &Vbefore_change_function,
3215 "Function to call before each text change.\n\
3216 Two arguments are passed to the function: the positions of\n\
3217 the beginning and end of the range of old text to be changed.\n\
3218 \(For an insertion, the beginning and end are at the same place.)\n\
3219 No information is given about the length of the text after the change.\n\
3220 \n\
3221 Buffer changes made while executing the `before-change-function'\n\
3222 don't call any before-change or after-change functions.\n\
3223 That's because these variables are temporarily set to nil.\n\
3224 As a result, a hook function cannot straightforwardly alter the value of\n\
3225 these variables. See the Emacs Lisp manual for a way of\n\
3226 accomplishing an equivalent result by using other variables.");
3227 Vbefore_change_function = Qnil;
3228
3229 DEFVAR_LISP ("after-change-function", &Vafter_change_function,
3230 "Function to call after each text change.\n\
3231 Three arguments are passed to the function: the positions of\n\
3232 the beginning and end of the range of changed text,\n\
3233 and the length of the pre-change text replaced by that range.\n\
3234 \(For an insertion, the pre-change length is zero;\n\
3235 for a deletion, that length is the number of characters deleted,\n\
3236 and the post-change beginning and end are at the same place.)\n\
3237 \n\
3238 Buffer changes made while executing the `after-change-function'\n\
3239 don't call any before-change or after-change functions.\n\
3240 That's because these variables are temporarily set to nil.\n\
3241 As a result, a hook function cannot straightforwardly alter the value of\n\
3242 these variables. See the Emacs Lisp manual for a way of\n\
3243 accomplishing an equivalent result by using other variables.");
3244 Vafter_change_function = Qnil;
3245
3246 DEFVAR_LISP ("before-change-functions", &Vbefore_change_functions,
3247 "List of functions to call before each text change.\n\
3248 Two arguments are passed to each function: the positions of\n\
3249 the beginning and end of the range of old text to be changed.\n\
3250 \(For an insertion, the beginning and end are at the same place.)\n\
3251 No information is given about the length of the text after the change.\n\
3252 \n\
3253 Buffer changes made while executing the `before-change-functions'\n\
3254 don't call any before-change or after-change functions.\n\
3255 That's because these variables are temporarily set to nil.\n\
3256 As a result, a hook function cannot straightforwardly alter the value of\n\
3257 these variables. See the Emacs Lisp manual for a way of\n\
3258 accomplishing an equivalent result by using other variables.");
3259 Vbefore_change_functions = Qnil;
3260
3261 DEFVAR_LISP ("after-change-functions", &Vafter_change_functions,
3262 "List of function to call after each text change.\n\
3263 Three arguments are passed to each function: the positions of\n\
3264 the beginning and end of the range of changed text,\n\
3265 and the length of the pre-change text replaced by that range.\n\
3266 \(For an insertion, the pre-change length is zero;\n\
3267 for a deletion, that length is the number of characters deleted,\n\
3268 and the post-change beginning and end are at the same place.)\n\
3269 \n\
3270 Buffer changes made while executing the `after-change-functions'\n\
3271 don't call any before-change or after-change functions.\n\
3272 That's because these variables are temporarily set to nil.\n\
3273 As a result, a hook function cannot straightforwardly alter the value of\n\
3274 these variables. See the Emacs Lisp manual for a way of\n\
3275 accomplishing an equivalent result by using other variables.");
3276
3277 Vafter_change_functions = Qnil;
3278
3279 DEFVAR_LISP ("first-change-hook", &Vfirst_change_hook,
3280 "A list of functions to call before changing a buffer which is unmodified.\n\
3281 The functions are run using the `run-hooks' function.");
3282 Vfirst_change_hook = Qnil;
3283 Qfirst_change_hook = intern ("first-change-hook");
3284 staticpro (&Qfirst_change_hook);
3285
3286 #if 0 /* The doc string is too long for some compilers,
3287 but make-docfile can find it in this comment. */
3288 DEFVAR_PER_BUFFER ("buffer-undo-list", &current_buffer->undo_list, Qnil,
3289 "List of undo entries in current buffer.\n\
3290 Recent changes come first; older changes follow newer.\n\
3291 \n\
3292 An entry (START . END) represents an insertion which begins at\n\
3293 position START and ends at position END.\n\
3294 \n\
3295 An entry (TEXT . POSITION) represents the deletion of the string TEXT\n\
3296 from (abs POSITION). If POSITION is positive, point was at the front\n\
3297 of the text being deleted; if negative, point was at the end.\n\
3298 \n\
3299 An entry (t HIGH . LOW) indicates that the buffer previously had\n\
3300 \"unmodified\" status. HIGH and LOW are the high and low 16-bit portions\n\
3301 of the visited file's modification time, as of that time. If the\n\
3302 modification time of the most recent save is different, this entry is\n\
3303 obsolete.\n\
3304 \n\
3305 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property\n\
3306 was modified between BEG and END. PROPERTY is the property name,\n\
3307 and VALUE is the old value.\n\
3308 \n\
3309 An entry of the form POSITION indicates that point was at the buffer\n\
3310 location given by the integer. Undoing an entry of this form places\n\
3311 point at POSITION.\n\
3312 \n\
3313 nil marks undo boundaries. The undo command treats the changes\n\
3314 between two undo boundaries as a single step to be undone.\n\
3315 \n\
3316 If the value of the variable is t, undo information is not recorded.");
3317 #endif
3318 DEFVAR_PER_BUFFER ("buffer-undo-list", &current_buffer->undo_list, Qnil,
3319 0);
3320
3321 DEFVAR_PER_BUFFER ("mark-active", &current_buffer->mark_active, Qnil,
3322 "Non-nil means the mark and region are currently active in this buffer.\n\
3323 Automatically local in all buffers.");
3324
3325 DEFVAR_PER_BUFFER ("cache-long-line-scans", &current_buffer->cache_long_line_scans, Qnil,
3326 "Non-nil means that Emacs should use caches to handle long lines more quickly.\n\
3327 This variable is buffer-local, in all buffers.\n\
3328 \n\
3329 Normally, the line-motion functions work by scanning the buffer for\n\
3330 newlines. Columnar operations (like move-to-column and\n\
3331 compute-motion) also work by scanning the buffer, summing character\n\
3332 widths as they go. This works well for ordinary text, but if the\n\
3333 buffer's lines are very long (say, more than 500 characters), these\n\
3334 motion functions will take longer to execute. Emacs may also take\n\
3335 longer to update the display.\n\
3336 \n\
3337 If cache-long-line-scans is non-nil, these motion functions cache the\n\
3338 results of their scans, and consult the cache to avoid rescanning\n\
3339 regions of the buffer until the text is modified. The caches are most\n\
3340 beneficial when they prevent the most searching---that is, when the\n\
3341 buffer contains long lines and large regions of characters with the\n\
3342 same, fixed screen width.\n\
3343 \n\
3344 When cache-long-line-scans is non-nil, processing short lines will\n\
3345 become slightly slower (because of the overhead of consulting the\n\
3346 cache), and the caches will use memory roughly proportional to the\n\
3347 number of newlines and characters whose screen width varies.\n\
3348 \n\
3349 The caches require no explicit maintenance; their accuracy is\n\
3350 maintained internally by the Emacs primitives. Enabling or disabling\n\
3351 the cache should not affect the behavior of any of the motion\n\
3352 functions; it should only affect their performance.");
3353
3354 DEFVAR_PER_BUFFER ("point-before-scroll", &current_buffer->point_before_scroll, Qnil,
3355 "Value of point before the last series of scroll operations, or nil.");
3356
3357 DEFVAR_PER_BUFFER ("buffer-file-format", &current_buffer->file_format, Qnil,
3358 "List of formats to use when saving this buffer.\n\
3359 Formats are defined by `format-alist'. This variable is\n\
3360 set when a file is visited. Automatically local in all buffers.");
3361
3362 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
3363 &current_buffer->invisibility_spec, Qnil,
3364 "Invisibility spec of this buffer.\n\
3365 The default is t, which means that text is invisible\n\
3366 if it has a non-nil `invisible' property.\n\
3367 If the value is a list, a text character is invisible if its `invisible'\n\
3368 property is an element in that list.\n\
3369 If an element is a cons cell of the form (PROP . ELLIPSIS),\n\
3370 then characters with property value PROP are invisible,\n\
3371 and they have an ellipsis as well if ELLIPSIS is non-nil.");
3372
3373 DEFVAR_LISP ("transient-mark-mode", &Vtransient_mark_mode,
3374 "*Non-nil means deactivate the mark when the buffer contents change.");
3375 Vtransient_mark_mode = Qnil;
3376
3377 DEFVAR_LISP ("inhibit-read-only", &Vinhibit_read_only,
3378 "*Non-nil means disregard read-only status of buffers or characters.\n\
3379 If the value is t, disregard `buffer-read-only' and all `read-only'\n\
3380 text properties. If the value is a list, disregard `buffer-read-only'\n\
3381 and disregard a `read-only' text property if the property value\n\
3382 is a member of the list.");
3383 Vinhibit_read_only = Qnil;
3384
3385 DEFVAR_LISP ("kill-buffer-query-functions", &Vkill_buffer_query_functions,
3386 "List of functions called with no args to query before killing a buffer.");
3387 Vkill_buffer_query_functions = Qnil;
3388
3389 defsubr (&Sbuffer_list);
3390 defsubr (&Sget_buffer);
3391 defsubr (&Sget_file_buffer);
3392 defsubr (&Sget_buffer_create);
3393 defsubr (&Smake_indirect_buffer);
3394 defsubr (&Sgenerate_new_buffer_name);
3395 defsubr (&Sbuffer_name);
3396 /*defsubr (&Sbuffer_number);*/
3397 defsubr (&Sbuffer_file_name);
3398 defsubr (&Sbuffer_base_buffer);
3399 defsubr (&Sbuffer_local_variables);
3400 defsubr (&Sbuffer_modified_p);
3401 defsubr (&Sset_buffer_modified_p);
3402 defsubr (&Sbuffer_modified_tick);
3403 defsubr (&Srename_buffer);
3404 defsubr (&Sother_buffer);
3405 defsubr (&Sbuffer_disable_undo);
3406 defsubr (&Sbuffer_enable_undo);
3407 defsubr (&Skill_buffer);
3408 defsubr (&Serase_buffer);
3409 defsubr (&Sset_buffer_major_mode);
3410 defsubr (&Sswitch_to_buffer);
3411 defsubr (&Spop_to_buffer);
3412 defsubr (&Scurrent_buffer);
3413 defsubr (&Sset_buffer);
3414 defsubr (&Sbarf_if_buffer_read_only);
3415 defsubr (&Sbury_buffer);
3416 defsubr (&Skill_all_local_variables);
3417
3418 defsubr (&Soverlayp);
3419 defsubr (&Smake_overlay);
3420 defsubr (&Sdelete_overlay);
3421 defsubr (&Smove_overlay);
3422 defsubr (&Soverlay_start);
3423 defsubr (&Soverlay_end);
3424 defsubr (&Soverlay_buffer);
3425 defsubr (&Soverlay_properties);
3426 defsubr (&Soverlays_at);
3427 defsubr (&Snext_overlay_change);
3428 defsubr (&Sprevious_overlay_change);
3429 defsubr (&Soverlay_recenter);
3430 defsubr (&Soverlay_lists);
3431 defsubr (&Soverlay_get);
3432 defsubr (&Soverlay_put);
3433 }
3434
3435 keys_of_buffer ()
3436 {
3437 initial_define_key (control_x_map, 'b', "switch-to-buffer");
3438 initial_define_key (control_x_map, 'k', "kill-buffer");
3439
3440 /* This must not be in syms_of_buffer, because Qdisabled is not
3441 initialized when that function gets called. */
3442 Fput (intern ("erase-buffer"), Qdisabled, Qt);
3443 }