1 /* Buffer manipulation primitives for GNU Emacs.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994, 1995
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
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)
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.
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. */
22 #include <sys/types.h>
24 #include <sys/param.h>
27 /* in 4.1, param.h fails to define this. */
28 #define MAXPATHLEN 1024
29 #endif /* not MAXPATHLEN */
33 #include "intervals.h"
37 #include "region-cache.h"
39 #include "blockinput.h"
41 struct buffer
*current_buffer
; /* the current buffer */
43 /* First buffer in chain of all buffers (in reverse order of creation).
44 Threaded through ->next. */
46 struct buffer
*all_buffers
;
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. */
55 struct buffer buffer_defaults
;
57 /* A Lisp_Object pointer to the above, used for staticpro */
59 static Lisp_Object Vbuffer_defaults
;
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.
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.
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.
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.
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.
81 If a slot in this structure corresponding to a DEFVAR_PER_BUFFER is
82 zero, that is a bug */
84 struct buffer buffer_local_flags
;
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. */
89 struct buffer buffer_local_symbols
;
90 /* A Lisp_Object pointer to the above, used for staticpro */
91 static Lisp_Object Vbuffer_local_symbols
;
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
;
101 Lisp_Object
Fset_buffer ();
102 void set_buffer_internal ();
103 static void call_overlay_mod_hooks ();
105 /* Alist of all buffer names vs the buffers. */
106 /* This used to be a variable, but is no longer,
107 to prevent lossage due to user rplac'ing this alist or its elements. */
108 Lisp_Object Vbuffer_alist
;
110 /* Functions to call before and after each text change. */
111 Lisp_Object Vbefore_change_function
;
112 Lisp_Object Vafter_change_function
;
113 Lisp_Object Vbefore_change_functions
;
114 Lisp_Object Vafter_change_functions
;
116 Lisp_Object Vtransient_mark_mode
;
118 /* t means ignore all read-only text properties.
119 A list means ignore such a property if its value is a member of the list.
120 Any non-nil value means ignore buffer-read-only. */
121 Lisp_Object Vinhibit_read_only
;
123 /* List of functions to call that can query about killing a buffer.
124 If any of these functions returns nil, we don't kill it. */
125 Lisp_Object Vkill_buffer_query_functions
;
127 /* List of functions to call before changing an unmodified buffer. */
128 Lisp_Object Vfirst_change_hook
;
129 Lisp_Object Qfirst_change_hook
;
131 Lisp_Object Qfundamental_mode
, Qmode_class
, Qpermanent_local
;
133 Lisp_Object Qprotected_field
;
135 Lisp_Object QSFundamental
; /* A string "Fundamental" */
137 Lisp_Object Qkill_buffer_hook
;
139 Lisp_Object Qget_file_buffer
;
141 Lisp_Object Qoverlayp
;
143 Lisp_Object Qpriority
, Qwindow
, Qevaporate
;
145 Lisp_Object Qmodification_hooks
;
146 Lisp_Object Qinsert_in_front_hooks
;
147 Lisp_Object Qinsert_behind_hooks
;
149 /* For debugging; temporary. See set_buffer_internal. */
150 /* Lisp_Object Qlisp_mode, Vcheck_symbol; */
156 error ("No buffer named %s", XSTRING (spec
)->data
);
157 error ("Invalid buffer argument");
160 DEFUN ("buffer-list", Fbuffer_list
, Sbuffer_list
, 0, 0, 0,
161 "Return a list of all existing live buffers.")
164 return Fmapcar (Qcdr
, Vbuffer_alist
);
167 /* Like Fassoc, but use Fstring_equal to compare
168 (which ignores text properties),
169 and don't ever QUIT. */
172 assoc_ignore_text_properties (key
, list
)
173 register Lisp_Object key
;
176 register Lisp_Object tail
;
177 for (tail
= list
; !NILP (tail
); tail
= Fcdr (tail
))
179 register Lisp_Object elt
, tem
;
181 tem
= Fstring_equal (Fcar (elt
), key
);
188 DEFUN ("get-buffer", Fget_buffer
, Sget_buffer
, 1, 1, 0,
189 "Return the buffer named NAME (a string).\n\
190 If there is no live buffer named NAME, return nil.\n\
191 NAME may also be a buffer; if so, the value is that buffer.")
193 register Lisp_Object name
;
197 CHECK_STRING (name
, 0);
199 return Fcdr (assoc_ignore_text_properties (name
, Vbuffer_alist
));
202 DEFUN ("get-file-buffer", Fget_file_buffer
, Sget_file_buffer
, 1, 1, 0,
203 "Return the buffer visiting file FILENAME (a string).\n\
204 The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.\n\
205 If there is no such live buffer, return nil.\n\
206 See also `find-buffer-visiting'.")
208 register Lisp_Object filename
;
210 register Lisp_Object tail
, buf
, tem
;
213 CHECK_STRING (filename
, 0);
214 filename
= Fexpand_file_name (filename
, Qnil
);
216 /* If the file name has special constructs in it,
217 call the corresponding file handler. */
218 handler
= Ffind_file_name_handler (filename
, Qget_file_buffer
);
220 return call2 (handler
, Qget_file_buffer
, filename
);
222 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
224 buf
= Fcdr (XCONS (tail
)->car
);
225 if (!BUFFERP (buf
)) continue;
226 if (!STRINGP (XBUFFER (buf
)->filename
)) continue;
227 tem
= Fstring_equal (XBUFFER (buf
)->filename
, filename
);
234 /* Incremented for each buffer created, to assign the buffer number. */
237 DEFUN ("get-buffer-create", Fget_buffer_create
, Sget_buffer_create
, 1, 1, 0,
238 "Return the buffer named NAME, or create such a buffer and return it.\n\
239 A new buffer is created if there is no live buffer named NAME.\n\
240 If NAME starts with a space, the new buffer does not keep undo information.\n\
241 If NAME is a buffer instead of a string, then it is the value returned.\n\
242 The value is never nil.")
244 register Lisp_Object name
;
246 register Lisp_Object buf
;
247 register struct buffer
*b
;
249 buf
= Fget_buffer (name
);
253 if (XSTRING (name
)->size
== 0)
254 error ("Empty string for buffer name is not allowed");
256 b
= (struct buffer
*) xmalloc (sizeof (struct buffer
));
258 b
->size
= sizeof (struct buffer
) / sizeof (EMACS_INT
);
260 /* An ordinary buffer uses its own struct buffer_text. */
261 b
->text
= &b
->own_text
;
264 BUF_GAP_SIZE (b
) = 20;
266 BUFFER_ALLOC (BUF_BEG_ADDR (b
), BUF_GAP_SIZE (b
));
268 if (! BUF_BEG_ADDR (b
))
269 buffer_memory_full ();
277 BUF_SAVE_MODIFF (b
) = 1;
278 BUF_INTERVALS (b
) = 0;
280 b
->newline_cache
= 0;
281 b
->width_run_cache
= 0;
282 b
->width_table
= Qnil
;
284 /* Put this on the chain of all buffers including killed ones. */
285 b
->next
= all_buffers
;
288 /* An ordinary buffer normally doesn't need markers
289 to handle BEGV and ZV. */
291 b
->begv_marker
= Qnil
;
294 name
= Fcopy_sequence (name
);
295 INITIALIZE_INTERVAL (XSTRING (name
), NULL_INTERVAL
);
298 if (XSTRING (name
)->data
[0] != ' ')
304 reset_buffer_local_variables (b
);
306 /* Put this in the alist of all live buffers. */
308 Vbuffer_alist
= nconc2 (Vbuffer_alist
, Fcons (Fcons (name
, buf
), Qnil
));
310 b
->mark
= Fmake_marker ();
311 BUF_MARKERS (b
) = Qnil
;
316 DEFUN ("make-indirect-buffer",
317 Fmake_indirect_buffer
, Smake_indirect_buffer
, 2, 2,
318 "BMake indirect buffer (to buffer): \nbName of indirect buffer: ",
319 "Create and return an indirect buffer for buffer BASE, named NAME.\n\
320 BASE should be an existing buffer (or buffer name).\n\
321 NAME should be a string which is not the name of an existing buffer.")
323 register Lisp_Object base_buffer
, name
;
325 register Lisp_Object buf
;
326 register struct buffer
*b
;
328 buf
= Fget_buffer (name
);
330 error ("Buffer name `%s' is in use", XSTRING (name
)->data
);
332 base_buffer
= Fget_buffer (base_buffer
);
333 if (NILP (base_buffer
))
334 error ("No such buffer: `%s'",
335 XSTRING (XBUFFER (base_buffer
)->name
)->data
);
337 if (XSTRING (name
)->size
== 0)
338 error ("Empty string for buffer name is not allowed");
340 b
= (struct buffer
*) xmalloc (sizeof (struct buffer
));
342 b
->size
= sizeof (struct buffer
) / sizeof (EMACS_INT
);
344 if (XBUFFER (base_buffer
)->base_buffer
)
345 b
->base_buffer
= XBUFFER (base_buffer
)->base_buffer
;
347 b
->base_buffer
= XBUFFER (base_buffer
);
349 /* Use the base buffer's text object. */
350 b
->text
= b
->base_buffer
->text
;
352 BUF_BEGV (b
) = BUF_BEGV (b
->base_buffer
);
353 BUF_ZV (b
) = BUF_ZV (b
->base_buffer
);
354 BUF_PT (b
) = BUF_PT (b
->base_buffer
);
356 b
->newline_cache
= 0;
357 b
->width_run_cache
= 0;
358 b
->width_table
= Qnil
;
360 /* Put this on the chain of all buffers including killed ones. */
361 b
->next
= all_buffers
;
364 name
= Fcopy_sequence (name
);
365 INITIALIZE_INTERVAL (XSTRING (name
), NULL_INTERVAL
);
369 reset_buffer_local_variables (b
);
371 /* Put this in the alist of all live buffers. */
373 Vbuffer_alist
= nconc2 (Vbuffer_alist
, Fcons (Fcons (name
, buf
), Qnil
));
375 b
->mark
= Fmake_marker ();
378 /* Make sure the base buffer has markers for its narrowing. */
379 if (NILP (b
->base_buffer
->pt_marker
))
381 b
->base_buffer
->pt_marker
= Fmake_marker ();
382 Fset_marker (b
->base_buffer
->pt_marker
,
383 make_number (BUF_PT (b
->base_buffer
)), base_buffer
);
385 if (NILP (b
->base_buffer
->begv_marker
))
387 b
->base_buffer
->begv_marker
= Fmake_marker ();
388 Fset_marker (b
->base_buffer
->begv_marker
,
389 make_number (BUF_BEGV (b
->base_buffer
)), base_buffer
);
391 if (NILP (b
->base_buffer
->zv_marker
))
393 b
->base_buffer
->zv_marker
= Fmake_marker ();
394 Fset_marker (b
->base_buffer
->zv_marker
,
395 make_number (BUF_ZV (b
->base_buffer
)), base_buffer
);
398 /* Give the indirect buffer markers for its narrowing. */
399 b
->pt_marker
= Fpoint_marker ();
400 b
->begv_marker
= Fpoint_min_marker ();
401 b
->zv_marker
= Fpoint_max_marker ();
406 /* Reinitialize everything about a buffer except its name and contents
407 and local variables. */
411 register struct buffer
*b
;
414 b
->file_truename
= Qnil
;
415 b
->directory
= (current_buffer
) ? current_buffer
->directory
: Qnil
;
417 XSETFASTINT (b
->save_length
, 0);
418 b
->last_window_start
= 1;
420 b
->auto_save_modified
= 0;
421 b
->auto_save_failure_time
= -1;
422 b
->auto_save_file_name
= Qnil
;
424 b
->overlays_before
= Qnil
;
425 b
->overlays_after
= Qnil
;
426 XSETFASTINT (b
->overlay_center
, 1);
427 b
->mark_active
= Qnil
;
428 b
->point_before_scroll
= Qnil
;
429 b
->file_format
= Qnil
;
432 /* Reset buffer B's local variables info.
433 Don't use this on a buffer that has already been in use;
434 it does not treat permanent locals consistently.
435 Instead, use Fkill_all_local_variables. */
437 reset_buffer_local_variables (b
)
438 register struct buffer
*b
;
442 /* Reset the major mode to Fundamental, together with all the
443 things that depend on the major mode.
444 default-major-mode is handled at a higher level.
445 We ignore it here. */
446 b
->major_mode
= Qfundamental_mode
;
448 b
->abbrev_table
= Vfundamental_mode_abbrev_table
;
449 b
->mode_name
= QSFundamental
;
450 b
->minor_modes
= Qnil
;
451 b
->downcase_table
= Vascii_downcase_table
;
452 b
->upcase_table
= Vascii_upcase_table
;
453 b
->case_canon_table
= Vascii_canon_table
;
454 b
->case_eqv_table
= Vascii_eqv_table
;
455 b
->buffer_file_type
= Qnil
;
456 b
->invisibility_spec
= Qt
;
459 b
->sort_table
= XSTRING (Vascii_sort_table
);
460 b
->folding_sort_table
= XSTRING (Vascii_folding_sort_table
);
463 /* Reset all per-buffer variables to their defaults. */
464 b
->local_var_alist
= Qnil
;
465 b
->local_var_flags
= 0;
467 /* For each slot that has a default value,
468 copy that into the slot. */
470 for (offset
= (char *)&buffer_local_flags
.name
- (char *)&buffer_local_flags
;
471 offset
< sizeof (struct buffer
);
472 offset
+= sizeof (Lisp_Object
)) /* sizeof EMACS_INT == sizeof Lisp_Object */
474 int flag
= XINT (*(Lisp_Object
*)(offset
+ (char *)&buffer_local_flags
));
475 if (flag
> 0 || flag
== -2)
476 *(Lisp_Object
*)(offset
+ (char *)b
) =
477 *(Lisp_Object
*)(offset
+ (char *)&buffer_defaults
);
481 /* We split this away from generate-new-buffer, because rename-buffer
482 and set-visited-file-name ought to be able to use this to really
483 rename the buffer properly. */
485 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name
, Sgenerate_new_buffer_name
,
487 "Return a string that is the name of no existing buffer based on NAME.\n\
488 If there is no live buffer named NAME, then return NAME.\n\
489 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER\n\
490 until an unused name is found, and then return that name.\n\
491 Optional second argument IGNORE specifies a name that is okay to use\n\
492 \(if it is in the sequence to be tried)\n\
493 even if a buffer with that name exists.")
495 register Lisp_Object name
, ignore
;
497 register Lisp_Object gentemp
, tem
;
501 CHECK_STRING (name
, 0);
503 tem
= Fget_buffer (name
);
510 sprintf (number
, "<%d>", ++count
);
511 gentemp
= concat2 (name
, build_string (number
));
512 tem
= Fstring_equal (gentemp
, ignore
);
515 tem
= Fget_buffer (gentemp
);
522 DEFUN ("buffer-name", Fbuffer_name
, Sbuffer_name
, 0, 1, 0,
523 "Return the name of BUFFER, as a string.\n\
524 With no argument or nil as argument, return the name of the current buffer.")
526 register Lisp_Object buffer
;
529 return current_buffer
->name
;
530 CHECK_BUFFER (buffer
, 0);
531 return XBUFFER (buffer
)->name
;
534 DEFUN ("buffer-file-name", Fbuffer_file_name
, Sbuffer_file_name
, 0, 1, 0,
535 "Return name of file BUFFER is visiting, or nil if none.\n\
536 No argument or nil as argument means use the current buffer.")
538 register Lisp_Object buffer
;
541 return current_buffer
->filename
;
542 CHECK_BUFFER (buffer
, 0);
543 return XBUFFER (buffer
)->filename
;
546 DEFUN ("buffer-base-buffer", Fbuffer_base_buffer
, Sbuffer_base_buffer
,
548 "Return the base buffer of indirect buffer BUFFER.\n\
549 If BUFFER is not indirect, return nil.")
551 register Lisp_Object buffer
;
554 Lisp_Object base_buffer
;
557 base
= current_buffer
->base_buffer
;
560 CHECK_BUFFER (buffer
, 0);
561 base
= XBUFFER (buffer
)->base_buffer
;
566 XSETBUFFER (base_buffer
, base
);
570 DEFUN ("buffer-local-variables", Fbuffer_local_variables
,
571 Sbuffer_local_variables
, 0, 1, 0,
572 "Return an alist of variables that are buffer-local in BUFFER.\n\
573 Most elements look like (SYMBOL . VALUE), describing one variable.\n\
574 For a symbol that is locally unbound, just the symbol appears in the value.\n\
575 Note that storing new VALUEs in these elements doesn't change the variables.\n\
576 No argument or nil as argument means use current buffer as BUFFER.")
578 register Lisp_Object buffer
;
580 register struct buffer
*buf
;
581 register Lisp_Object result
;
584 buf
= current_buffer
;
587 CHECK_BUFFER (buffer
, 0);
588 buf
= XBUFFER (buffer
);
594 register Lisp_Object tail
;
595 for (tail
= buf
->local_var_alist
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
597 Lisp_Object val
, elt
;
599 elt
= XCONS (tail
)->car
;
601 /* Reference each variable in the alist in buf.
602 If inquiring about the current buffer, this gets the current values,
603 so store them into the alist so the alist is up to date.
604 If inquiring about some other buffer, this swaps out any values
605 for that buffer, making the alist up to date automatically. */
606 val
= find_symbol_value (XCONS (elt
)->car
);
607 /* Use the current buffer value only if buf is the current buffer. */
608 if (buf
!= current_buffer
)
609 val
= XCONS (elt
)->cdr
;
611 /* If symbol is unbound, put just the symbol in the list. */
612 if (EQ (val
, Qunbound
))
613 result
= Fcons (XCONS (elt
)->car
, result
);
614 /* Otherwise, put (symbol . value) in the list. */
616 result
= Fcons (Fcons (XCONS (elt
)->car
, val
), result
);
620 /* Add on all the variables stored in special slots. */
622 register int offset
, mask
;
624 for (offset
= (char *)&buffer_local_symbols
.name
- (char *)&buffer_local_symbols
;
625 offset
< sizeof (struct buffer
);
626 offset
+= (sizeof (EMACS_INT
))) /* sizeof EMACS_INT == sizeof Lisp_Object */
628 mask
= XINT (*(Lisp_Object
*)(offset
+ (char *)&buffer_local_flags
));
629 if (mask
== -1 || (buf
->local_var_flags
& mask
))
630 if (SYMBOLP (*(Lisp_Object
*)(offset
631 + (char *)&buffer_local_symbols
)))
632 result
= Fcons (Fcons (*((Lisp_Object
*)
633 (offset
+ (char *)&buffer_local_symbols
)),
634 *(Lisp_Object
*)(offset
+ (char *)buf
)),
643 DEFUN ("buffer-modified-p", Fbuffer_modified_p
, Sbuffer_modified_p
,
645 "Return t if BUFFER was modified since its file was last read or saved.\n\
646 No argument or nil as argument means use current buffer as BUFFER.")
648 register Lisp_Object buffer
;
650 register struct buffer
*buf
;
652 buf
= current_buffer
;
655 CHECK_BUFFER (buffer
, 0);
656 buf
= XBUFFER (buffer
);
659 return BUF_SAVE_MODIFF (buf
) < BUF_MODIFF (buf
) ? Qt
: Qnil
;
662 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p
, Sset_buffer_modified_p
,
664 "Mark current buffer as modified or unmodified according to FLAG.\n\
665 A non-nil FLAG means mark the buffer modified.")
667 register Lisp_Object flag
;
669 register int already
;
670 register Lisp_Object fn
;
672 #ifdef CLASH_DETECTION
673 /* If buffer becoming modified, lock the file.
674 If buffer becoming unmodified, unlock the file. */
676 fn
= current_buffer
->filename
;
679 already
= SAVE_MODIFF
< MODIFF
;
680 if (!already
&& !NILP (flag
))
682 else if (already
&& NILP (flag
))
685 #endif /* CLASH_DETECTION */
687 SAVE_MODIFF
= NILP (flag
) ? MODIFF
: 0;
692 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick
, Sbuffer_modified_tick
,
694 "Return BUFFER's tick counter, incremented for each change in text.\n\
695 Each buffer has a tick counter which is incremented each time the text in\n\
696 that buffer is changed. It wraps around occasionally.\n\
697 No argument or nil as argument means use current buffer as BUFFER.")
699 register Lisp_Object buffer
;
701 register struct buffer
*buf
;
703 buf
= current_buffer
;
706 CHECK_BUFFER (buffer
, 0);
707 buf
= XBUFFER (buffer
);
710 return make_number (BUF_MODIFF (buf
));
713 DEFUN ("rename-buffer", Frename_buffer
, Srename_buffer
, 1, 2,
714 "sRename buffer (to new name): \nP",
715 "Change current buffer's name to NEWNAME (a string).\n\
716 If second arg UNIQUE is nil or omitted, it is an error if a\n\
717 buffer named NEWNAME already exists.\n\
718 If UNIQUE is non-nil, come up with a new name using\n\
719 `generate-new-buffer-name'.\n\
720 Interactively, you can set UNIQUE with a prefix argument.\n\
721 We return the name we actually gave the buffer.\n\
722 This does not change the name of the visited file (if any).")
724 register Lisp_Object newname
, unique
;
726 register Lisp_Object tem
, buf
;
728 CHECK_STRING (newname
, 0);
730 if (XSTRING (newname
)->size
== 0)
731 error ("Empty string is invalid as a buffer name");
733 tem
= Fget_buffer (newname
);
734 /* Don't short-circuit if UNIQUE is t. That is a useful way to rename
735 the buffer automatically so you can create another with the original name.
736 It makes UNIQUE equivalent to
737 (rename-buffer (generate-new-buffer-name NEWNAME)). */
738 if (NILP (unique
) && XBUFFER (tem
) == current_buffer
)
739 return current_buffer
->name
;
743 newname
= Fgenerate_new_buffer_name (newname
, current_buffer
->name
);
745 error ("Buffer name `%s' is in use", XSTRING (newname
)->data
);
748 current_buffer
->name
= newname
;
750 /* Catch redisplay's attention. Unless we do this, the mode lines for
751 any windows displaying current_buffer will stay unchanged. */
754 XSETBUFFER (buf
, current_buffer
);
755 Fsetcar (Frassq (buf
, Vbuffer_alist
), newname
);
756 if (NILP (current_buffer
->filename
)
757 && !NILP (current_buffer
->auto_save_file_name
))
758 call0 (intern ("rename-auto-save-file"));
759 /* Refetch since that last call may have done GC. */
760 return current_buffer
->name
;
763 DEFUN ("other-buffer", Fother_buffer
, Sother_buffer
, 0, 2, 0,
764 "Return most recently selected buffer other than BUFFER.\n\
765 Buffers not visible in windows are preferred to visible buffers,\n\
766 unless optional second argument VISIBLE-OK is non-nil.\n\
767 If no other buffer exists, the buffer `*scratch*' is returned.\n\
768 If BUFFER is omitted or nil, some interesting buffer is returned.")
770 register Lisp_Object buffer
, visible_ok
;
772 register Lisp_Object tail
, buf
, notsogood
, tem
;
775 for (tail
= Vbuffer_alist
; !NILP (tail
); tail
= Fcdr (tail
))
777 buf
= Fcdr (Fcar (tail
));
778 if (EQ (buf
, buffer
))
780 if (XSTRING (XBUFFER (buf
)->name
)->data
[0] == ' ')
783 /* If the selected frame has a buffer_predicate,
784 disregard buffers that don't fit the predicate. */
785 tem
= frame_buffer_predicate ();
788 tem
= call1 (tem
, buf
);
794 if (NILP (visible_ok
))
795 tem
= Fget_buffer_window (buf
, Qt
);
800 if (NILP (notsogood
))
803 if (!NILP (notsogood
))
805 return Fget_buffer_create (build_string ("*scratch*"));
808 DEFUN ("buffer-disable-undo", Fbuffer_disable_undo
, Sbuffer_disable_undo
, 0, 1,
810 "Make BUFFER stop keeping undo information.\n\
811 No argument or nil as argument means do this for the current buffer.")
813 register Lisp_Object buffer
;
815 Lisp_Object real_buffer
;
818 XSETBUFFER (real_buffer
, current_buffer
);
821 real_buffer
= Fget_buffer (buffer
);
822 if (NILP (real_buffer
))
826 XBUFFER (real_buffer
)->undo_list
= Qt
;
831 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo
, Sbuffer_enable_undo
,
833 "Start keeping undo information for buffer BUFFER.\n\
834 No argument or nil as argument means do this for the current buffer.")
836 register Lisp_Object buffer
;
838 Lisp_Object real_buffer
;
841 XSETBUFFER (real_buffer
, current_buffer
);
844 real_buffer
= Fget_buffer (buffer
);
845 if (NILP (real_buffer
))
849 if (EQ (XBUFFER (real_buffer
)->undo_list
, Qt
))
850 XBUFFER (real_buffer
)->undo_list
= Qnil
;
856 DEFVAR_LISP ("kill-buffer-hook", no_cell, "\
857 Hook to be run (by `run-hooks', which see) when a buffer is killed.\n\
858 The buffer being killed will be current while the hook is running.\n\
861 DEFUN ("kill-buffer", Fkill_buffer
, Skill_buffer
, 1, 1, "bKill buffer: ",
862 "Kill the buffer BUFFER.\n\
863 The argument may be a buffer or may be the name of a buffer.\n\
864 An argument of nil means kill the current buffer.\n\n\
865 Value is t if the buffer is actually killed, nil if user says no.\n\n\
866 The value of `kill-buffer-hook' (which may be local to that buffer),\n\
867 if not void, is a list of functions to be called, with no arguments,\n\
868 before the buffer is actually killed. The buffer to be killed is current\n\
869 when the hook functions are called.\n\n\
870 Any processes that have this buffer as the `process-buffer' are killed\n\
871 with `delete-process'.")
876 register struct buffer
*b
;
877 register Lisp_Object tem
;
878 register struct Lisp_Marker
*m
;
879 struct gcpro gcpro1
, gcpro2
;
882 buf
= Fcurrent_buffer ();
884 buf
= Fget_buffer (bufname
);
890 /* Query if the buffer is still modified. */
891 if (INTERACTIVE
&& !NILP (b
->filename
)
892 && BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
894 GCPRO2 (buf
, bufname
);
895 tem
= do_yes_or_no_p (format1 ("Buffer %s modified; kill anyway? ",
896 XSTRING (b
->name
)->data
));
902 /* Run hooks with the buffer to be killed the current buffer. */
904 register Lisp_Object val
;
905 int count
= specpdl_ptr
- specpdl
;
908 record_unwind_protect (save_excursion_restore
, save_excursion_save ());
909 set_buffer_internal (b
);
911 /* First run the query functions; if any query is answered no,
912 don't kill the buffer. */
913 for (list
= Vkill_buffer_query_functions
; !NILP (list
); list
= Fcdr (list
))
915 tem
= call0 (Fcar (list
));
917 return unbind_to (count
, Qnil
);
920 /* Then run the hooks. */
921 if (!NILP (Vrun_hooks
))
922 call1 (Vrun_hooks
, Qkill_buffer_hook
);
923 unbind_to (count
, Qnil
);
926 /* We have no more questions to ask. Verify that it is valid
927 to kill the buffer. This must be done after the questions
928 since anything can happen within do_yes_or_no_p. */
930 /* Don't kill the minibuffer now current. */
931 if (EQ (buf
, XWINDOW (minibuf_window
)->buffer
))
937 /* When we kill a base buffer, kill all its indirect buffers.
938 We do it at this stage so nothing terrible happens if they
939 ask questions or their hooks get errors. */
940 if (! b
->base_buffer
)
942 struct buffer
*other
;
946 for (other
= all_buffers
; other
; other
= other
->next
)
947 if (other
->base_buffer
== b
)
950 XSETBUFFER (buf
, other
);
957 /* Make this buffer not be current.
958 In the process, notice if this is the sole visible buffer
959 and give up if so. */
960 if (b
== current_buffer
)
962 tem
= Fother_buffer (buf
, Qnil
);
964 if (b
== current_buffer
)
968 /* Now there is no question: we can kill the buffer. */
970 #ifdef CLASH_DETECTION
971 /* Unlock this buffer's file, if it is locked. */
973 #endif /* CLASH_DETECTION */
975 kill_buffer_processes (buf
);
979 Vbuffer_alist
= Fdelq (Frassq (buf
, Vbuffer_alist
), Vbuffer_alist
);
980 Freplace_buffer_in_windows (buf
);
983 /* Delete any auto-save file, if we saved it in this session. */
984 if (STRINGP (b
->auto_save_file_name
)
985 && b
->auto_save_modified
!= 0)
988 tem
= Fsymbol_value (intern ("delete-auto-save-files"));
990 internal_delete_file (b
->auto_save_file_name
);
993 if (! b
->base_buffer
)
995 /* Unchain all markers of this buffer
996 and leave them pointing nowhere. */
997 for (tem
= BUF_MARKERS (b
); !EQ (tem
, Qnil
); )
1004 BUF_MARKERS (b
) = Qnil
;
1006 #ifdef USE_TEXT_PROPERTIES
1007 BUF_INTERVALS (b
) = NULL_INTERVAL
;
1010 /* Perhaps we should explicitly free the interval tree here... */
1016 if (! b
->base_buffer
)
1017 BUFFER_FREE (BUF_BEG_ADDR (b
));
1019 if (b
->newline_cache
)
1021 free_region_cache (b
->newline_cache
);
1022 b
->newline_cache
= 0;
1024 if (b
->width_run_cache
)
1026 free_region_cache (b
->width_run_cache
);
1027 b
->width_run_cache
= 0;
1029 b
->width_table
= Qnil
;
1031 b
->undo_list
= Qnil
;
1036 /* Move the assoc for buffer BUF to the front of buffer-alist. Since
1037 we do this each time BUF is selected visibly, the more recently
1038 selected buffers are always closer to the front of the list. This
1039 means that other_buffer is more likely to choose a relevant buffer. */
1044 register Lisp_Object link
, prev
;
1047 for (link
= Vbuffer_alist
; CONSP (link
); link
= XCONS (link
)->cdr
)
1049 if (EQ (XCONS (XCONS (link
)->car
)->cdr
, buf
))
1054 /* Effectively do Vbuffer_alist = Fdelq (link, Vbuffer_alist);
1055 we cannot use Fdelq itself here because it allows quitting. */
1058 Vbuffer_alist
= XCONS (Vbuffer_alist
)->cdr
;
1060 XCONS (prev
)->cdr
= XCONS (XCONS (prev
)->cdr
)->cdr
;
1062 XCONS(link
)->cdr
= Vbuffer_alist
;
1063 Vbuffer_alist
= link
;
1066 DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode
, Sset_buffer_major_mode
, 1, 1, 0,
1067 "Set an appropriate major mode for BUFFER, according to `default-major-mode'.\n\
1068 Use this function before selecting the buffer, since it may need to inspect\n\
1069 the current buffer's major mode.")
1074 Lisp_Object function
;
1076 function
= buffer_defaults
.major_mode
;
1077 if (NILP (function
) && NILP (Fget (current_buffer
->major_mode
, Qmode_class
)))
1078 function
= current_buffer
->major_mode
;
1080 if (NILP (function
) || EQ (function
, Qfundamental_mode
))
1083 count
= specpdl_ptr
- specpdl
;
1085 /* To select a nonfundamental mode,
1086 select the buffer temporarily and then call the mode function. */
1088 record_unwind_protect (save_excursion_restore
, save_excursion_save ());
1093 return unbind_to (count
, Qnil
);
1096 DEFUN ("switch-to-buffer", Fswitch_to_buffer
, Sswitch_to_buffer
, 1, 2, "BSwitch to buffer: ",
1097 "Select buffer BUFFER in the current window.\n\
1098 BUFFER may be a buffer or a buffer name.\n\
1099 Optional second arg NORECORD non-nil means\n\
1100 do not put this buffer at the front of the list of recently selected ones.\n\
1102 WARNING: This is NOT the way to work on another buffer temporarily\n\
1103 within a Lisp program! Use `set-buffer' instead. That avoids messing with\n\
1104 the window-buffer correspondences.")
1106 Lisp_Object bufname
, norecord
;
1108 register Lisp_Object buf
;
1111 if (EQ (minibuf_window
, selected_window
))
1112 error ("Cannot switch buffers in minibuffer window");
1113 tem
= Fwindow_dedicated_p (selected_window
);
1115 error ("Cannot switch buffers in a dedicated window");
1118 buf
= Fother_buffer (Fcurrent_buffer (), Qnil
);
1121 buf
= Fget_buffer (bufname
);
1124 buf
= Fget_buffer_create (bufname
);
1125 Fset_buffer_major_mode (buf
);
1129 if (NILP (norecord
))
1130 record_buffer (buf
);
1132 Fset_window_buffer (EQ (selected_window
, minibuf_window
)
1133 ? Fnext_window (minibuf_window
, Qnil
, Qnil
)
1140 DEFUN ("pop-to-buffer", Fpop_to_buffer
, Spop_to_buffer
, 1, 2, 0,
1141 "Select buffer BUFFER in some window, preferably a different one.\n\
1142 If BUFFER is nil, then some other buffer is chosen.\n\
1143 If `pop-up-windows' is non-nil, windows can be split to do this.\n\
1144 If optional second arg OTHER-WINDOW is non-nil, insist on finding another\n\
1145 window even if BUFFER is already visible in the selected window.")
1147 Lisp_Object bufname
, other
;
1149 register Lisp_Object buf
;
1151 buf
= Fother_buffer (Fcurrent_buffer (), Qnil
);
1154 buf
= Fget_buffer (bufname
);
1157 buf
= Fget_buffer_create (bufname
);
1158 Fset_buffer_major_mode (buf
);
1162 record_buffer (buf
);
1163 Fselect_window (Fdisplay_buffer (buf
, other
));
1167 DEFUN ("current-buffer", Fcurrent_buffer
, Scurrent_buffer
, 0, 0, 0,
1168 "Return the current buffer as a Lisp object.")
1171 register Lisp_Object buf
;
1172 XSETBUFFER (buf
, current_buffer
);
1176 /* Set the current buffer to b */
1179 set_buffer_internal (b
)
1180 register struct buffer
*b
;
1182 register struct buffer
*old_buf
;
1183 register Lisp_Object tail
, valcontents
;
1186 if (current_buffer
== b
)
1189 windows_or_buffers_changed
= 1;
1190 old_buf
= current_buffer
;
1192 last_known_column_point
= -1; /* invalidate indentation cache */
1196 /* Put the undo list back in the base buffer, so that it appears
1197 that an indirect buffer shares the undo list of its base. */
1198 if (old_buf
->base_buffer
)
1199 old_buf
->base_buffer
->undo_list
= old_buf
->undo_list
;
1201 /* If the old current buffer has markers to record PT, BEGV and ZV
1202 when it is not current, update them now. */
1203 if (! NILP (old_buf
->pt_marker
))
1206 XSETBUFFER (obuf
, old_buf
);
1207 Fset_marker (old_buf
->pt_marker
, BUF_PT (old_buf
), obuf
);
1209 if (! NILP (old_buf
->begv_marker
))
1212 XSETBUFFER (obuf
, old_buf
);
1213 Fset_marker (old_buf
->begv_marker
, BUF_BEGV (old_buf
), obuf
);
1215 if (! NILP (old_buf
->zv_marker
))
1218 XSETBUFFER (obuf
, old_buf
);
1219 Fset_marker (old_buf
->zv_marker
, BUF_ZV (old_buf
), obuf
);
1223 /* Get the undo list from the base buffer, so that it appears
1224 that an indirect buffer shares the undo list of its base. */
1226 b
->undo_list
= b
->base_buffer
->undo_list
;
1228 /* If the new current buffer has markers to record PT, BEGV and ZV
1229 when it is not current, fetch them now. */
1230 if (! NILP (b
->pt_marker
))
1231 BUF_PT (b
) = marker_position (b
->pt_marker
);
1232 if (! NILP (b
->begv_marker
))
1233 BUF_BEGV (b
) = marker_position (b
->begv_marker
);
1234 if (! NILP (b
->zv_marker
))
1235 BUF_ZV (b
) = marker_position (b
->zv_marker
);
1237 /* Look down buffer's list of local Lisp variables
1238 to find and update any that forward into C variables. */
1240 for (tail
= b
->local_var_alist
; !NILP (tail
); tail
= XCONS (tail
)->cdr
)
1242 valcontents
= XSYMBOL (XCONS (XCONS (tail
)->car
)->car
)->value
;
1243 if ((BUFFER_LOCAL_VALUEP (valcontents
)
1244 || SOME_BUFFER_LOCAL_VALUEP (valcontents
))
1245 && (tem
= XBUFFER_LOCAL_VALUE (valcontents
)->car
,
1246 (BOOLFWDP (tem
) || INTFWDP (tem
) || OBJFWDP (tem
))))
1247 /* Just reference the variable
1248 to cause it to become set for this buffer. */
1249 Fsymbol_value (XCONS (XCONS (tail
)->car
)->car
);
1252 /* Do the same with any others that were local to the previous buffer */
1255 for (tail
= old_buf
->local_var_alist
; !NILP (tail
); tail
= XCONS (tail
)->cdr
)
1257 valcontents
= XSYMBOL (XCONS (XCONS (tail
)->car
)->car
)->value
;
1258 if ((BUFFER_LOCAL_VALUEP (valcontents
)
1259 || SOME_BUFFER_LOCAL_VALUEP (valcontents
))
1260 && (tem
= XBUFFER_LOCAL_VALUE (valcontents
)->car
,
1261 (BOOLFWDP (tem
) || INTFWDP (tem
) || OBJFWDP (tem
))))
1262 /* Just reference the variable
1263 to cause it to become set for this buffer. */
1264 Fsymbol_value (XCONS (XCONS (tail
)->car
)->car
);
1268 /* Switch to buffer B temporarily for redisplay purposes.
1269 This avoids certain things thatdon't need to be done within redisplay. */
1275 register struct buffer
*old_buf
;
1277 if (current_buffer
== b
)
1280 old_buf
= current_buffer
;
1285 /* If the old current buffer has markers to record PT, BEGV and ZV
1286 when it is not current, update them now. */
1287 if (! NILP (old_buf
->pt_marker
))
1290 XSETBUFFER (obuf
, old_buf
);
1291 Fset_marker (old_buf
->pt_marker
, BUF_PT (old_buf
), obuf
);
1293 if (! NILP (old_buf
->begv_marker
))
1296 XSETBUFFER (obuf
, old_buf
);
1297 Fset_marker (old_buf
->begv_marker
, BUF_BEGV (old_buf
), obuf
);
1299 if (! NILP (old_buf
->zv_marker
))
1302 XSETBUFFER (obuf
, old_buf
);
1303 Fset_marker (old_buf
->zv_marker
, BUF_ZV (old_buf
), obuf
);
1307 /* If the new current buffer has markers to record PT, BEGV and ZV
1308 when it is not current, fetch them now. */
1309 if (! NILP (b
->pt_marker
))
1310 BUF_PT (b
) = marker_position (b
->pt_marker
);
1311 if (! NILP (b
->begv_marker
))
1312 BUF_BEGV (b
) = marker_position (b
->begv_marker
);
1313 if (! NILP (b
->zv_marker
))
1314 BUF_ZV (b
) = marker_position (b
->zv_marker
);
1317 DEFUN ("set-buffer", Fset_buffer
, Sset_buffer
, 1, 1, 0,
1318 "Make the buffer BUFFER current for editing operations.\n\
1319 BUFFER may be a buffer or the name of an existing buffer.\n\
1320 See also `save-excursion' when you want to make a buffer current temporarily.\n\
1321 This function does not display the buffer, so its effect ends\n\
1322 when the current command terminates.\n\
1323 Use `switch-to-buffer' or `pop-to-buffer' to switch buffers permanently.")
1325 register Lisp_Object bufname
;
1327 register Lisp_Object buffer
;
1328 buffer
= Fget_buffer (bufname
);
1331 if (NILP (XBUFFER (buffer
)->name
))
1332 error ("Selecting deleted buffer");
1333 set_buffer_internal (XBUFFER (buffer
));
1337 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only
,
1338 Sbarf_if_buffer_read_only
, 0, 0, 0,
1339 "Signal a `buffer-read-only' error if the current buffer is read-only.")
1342 if (!NILP (current_buffer
->read_only
)
1343 && NILP (Vinhibit_read_only
))
1344 Fsignal (Qbuffer_read_only
, (Fcons (Fcurrent_buffer (), Qnil
)));
1348 DEFUN ("bury-buffer", Fbury_buffer
, Sbury_buffer
, 0, 1, "",
1349 "Put BUFFER at the end of the list of all buffers.\n\
1350 There it is the least likely candidate for `other-buffer' to return;\n\
1351 thus, the least likely buffer for \\[switch-to-buffer] to select by default.\n\
1352 If BUFFER is nil or omitted, bury the current buffer.\n\
1353 Also, if BUFFER is nil or omitted, remove the current buffer from the\n\
1354 selected window if it is displayed there.")
1356 register Lisp_Object buf
;
1358 /* Figure out what buffer we're going to bury. */
1361 XSETBUFFER (buf
, current_buffer
);
1363 /* If we're burying the current buffer, unshow it. */
1364 Fswitch_to_buffer (Fother_buffer (buf
, Qnil
), Qnil
);
1370 buf1
= Fget_buffer (buf
);
1376 /* Move buf to the end of the buffer list. */
1378 register Lisp_Object aelt
, link
;
1380 aelt
= Frassq (buf
, Vbuffer_alist
);
1381 link
= Fmemq (aelt
, Vbuffer_alist
);
1382 Vbuffer_alist
= Fdelq (aelt
, Vbuffer_alist
);
1383 XCONS (link
)->cdr
= Qnil
;
1384 Vbuffer_alist
= nconc2 (Vbuffer_alist
, link
);
1390 DEFUN ("erase-buffer", Ferase_buffer
, Serase_buffer
, 0, 0, "*",
1391 "Delete the entire contents of the current buffer.\n\
1392 Any narrowing restriction in effect (see `narrow-to-region') is removed,\n\
1393 so the buffer is truly empty after this.")
1398 current_buffer
->last_window_start
= 1;
1399 /* Prevent warnings, or suspension of auto saving, that would happen
1400 if future size is less than past size. Use of erase-buffer
1401 implies that the future text is not really related to the past text. */
1402 XSETFASTINT (current_buffer
->save_length
, 0);
1406 validate_region (b
, e
)
1407 register Lisp_Object
*b
, *e
;
1409 CHECK_NUMBER_COERCE_MARKER (*b
, 0);
1410 CHECK_NUMBER_COERCE_MARKER (*e
, 1);
1412 if (XINT (*b
) > XINT (*e
))
1415 tem
= *b
; *b
= *e
; *e
= tem
;
1418 if (!(BEGV
<= XINT (*b
) && XINT (*b
) <= XINT (*e
)
1419 && XINT (*e
) <= ZV
))
1420 args_out_of_range (*b
, *e
);
1423 DEFUN ("kill-all-local-variables", Fkill_all_local_variables
, Skill_all_local_variables
,
1425 "Switch to Fundamental mode by killing current buffer's local variables.\n\
1426 Most local variable bindings are eliminated so that the default values\n\
1427 become effective once more. Also, the syntax table is set from\n\
1428 `standard-syntax-table', the local keymap is set to nil,\n\
1429 and the abbrev table from `fundamental-mode-abbrev-table'.\n\
1430 This function also forces redisplay of the mode line.\n\
1432 Every function to select a new major mode starts by\n\
1433 calling this function.\n\n\
1434 As a special exception, local variables whose names have\n\
1435 a non-nil `permanent-local' property are not eliminated by this function.\n\
1437 The first thing this function does is run\n\
1438 the normal hook `change-major-mode-hook'.")
1441 register Lisp_Object alist
, sym
, tem
;
1444 if (!NILP (Vrun_hooks
))
1445 call1 (Vrun_hooks
, intern ("change-major-mode-hook"));
1446 oalist
= current_buffer
->local_var_alist
;
1448 /* Make sure no local variables remain set up with this buffer
1449 for their current values. */
1451 for (alist
= oalist
; !NILP (alist
); alist
= XCONS (alist
)->cdr
)
1453 sym
= XCONS (XCONS (alist
)->car
)->car
;
1455 /* Need not do anything if some other buffer's binding is now encached. */
1456 tem
= XCONS (XBUFFER_LOCAL_VALUE (XSYMBOL (sym
)->value
)->cdr
)->car
;
1457 if (XBUFFER (tem
) == current_buffer
)
1459 /* Symbol is set up for this buffer's old local value.
1460 Set it up for the current buffer with the default value. */
1462 tem
= XCONS (XBUFFER_LOCAL_VALUE (XSYMBOL (sym
)->value
)->cdr
)->cdr
;
1463 /* Store the symbol's current value into the alist entry
1464 it is currently set up for. This is so that, if the
1465 local is marked permanent, and we make it local again below,
1466 we don't lose the value. */
1467 XCONS (XCONS (tem
)->car
)->cdr
1468 = do_symval_forwarding (XBUFFER_LOCAL_VALUE (XSYMBOL (sym
)->value
)->car
);
1469 /* Switch to the symbol's default-value alist entry. */
1470 XCONS (tem
)->car
= tem
;
1471 /* Mark it as current for the current buffer. */
1472 XCONS (XBUFFER_LOCAL_VALUE (XSYMBOL (sym
)->value
)->cdr
)->car
1473 = Fcurrent_buffer ();
1474 /* Store the current value into any forwarding in the symbol. */
1475 store_symval_forwarding (sym
, XBUFFER_LOCAL_VALUE (XSYMBOL (sym
)->value
)->car
,
1480 /* Actually eliminate all local bindings of this buffer. */
1482 reset_buffer_local_variables (current_buffer
);
1484 /* Redisplay mode lines; we are changing major mode. */
1486 update_mode_lines
++;
1488 /* Any which are supposed to be permanent,
1489 make local again, with the same values they had. */
1491 for (alist
= oalist
; !NILP (alist
); alist
= XCONS (alist
)->cdr
)
1493 sym
= XCONS (XCONS (alist
)->car
)->car
;
1494 tem
= Fget (sym
, Qpermanent_local
);
1497 Fmake_local_variable (sym
);
1498 Fset (sym
, XCONS (XCONS (alist
)->car
)->cdr
);
1502 /* Force mode-line redisplay. Useful here because all major mode
1503 commands call this function. */
1504 update_mode_lines
++;
1509 /* Find all the overlays in the current buffer that contain position POS.
1510 Return the number found, and store them in a vector in *VEC_PTR.
1511 Store in *LEN_PTR the size allocated for the vector.
1512 Store in *NEXT_PTR the next position after POS where an overlay starts,
1513 or ZV if there are no more overlays.
1514 Store in *PREV_PTR the previous position after POS where an overlay ends,
1515 or BEGV if there are no previous overlays.
1516 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
1518 *VEC_PTR and *LEN_PTR should contain a valid vector and size
1519 when this function is called.
1521 If EXTEND is non-zero, we make the vector bigger if necessary.
1522 If EXTEND is zero, we never extend the vector,
1523 and we store only as many overlays as will fit.
1524 But we still return the total number of overlays. */
1527 overlays_at (pos
, extend
, vec_ptr
, len_ptr
, next_ptr
, prev_ptr
)
1530 Lisp_Object
**vec_ptr
;
1535 Lisp_Object tail
, overlay
, start
, end
, result
;
1538 Lisp_Object
*vec
= *vec_ptr
;
1541 int inhibit_storing
= 0;
1543 for (tail
= current_buffer
->overlays_before
;
1545 tail
= XCONS (tail
)->cdr
)
1547 int startpos
, endpos
;
1549 overlay
= XCONS (tail
)->car
;
1551 start
= OVERLAY_START (overlay
);
1552 end
= OVERLAY_END (overlay
);
1553 endpos
= OVERLAY_POSITION (end
);
1562 startpos
= OVERLAY_POSITION (start
);
1563 if (startpos
<= pos
)
1567 /* The supplied vector is full.
1568 Either make it bigger, or don't store any more in it. */
1571 *len_ptr
= len
*= 2;
1572 vec
= (Lisp_Object
*) xrealloc (vec
, len
* sizeof (Lisp_Object
));
1576 inhibit_storing
= 1;
1579 if (!inhibit_storing
)
1581 /* Keep counting overlays even if we can't return them all. */
1584 else if (startpos
< next
)
1588 for (tail
= current_buffer
->overlays_after
;
1590 tail
= XCONS (tail
)->cdr
)
1592 int startpos
, endpos
;
1594 overlay
= XCONS (tail
)->car
;
1596 start
= OVERLAY_START (overlay
);
1597 end
= OVERLAY_END (overlay
);
1598 startpos
= OVERLAY_POSITION (start
);
1601 if (startpos
< next
)
1605 endpos
= OVERLAY_POSITION (end
);
1612 *len_ptr
= len
*= 2;
1613 vec
= (Lisp_Object
*) xrealloc (vec
, len
* sizeof (Lisp_Object
));
1617 inhibit_storing
= 1;
1620 if (!inhibit_storing
)
1624 else if (endpos
< pos
&& endpos
> prev
)
1637 Lisp_Object overlay
;
1643 compare_overlays (s1
, s2
)
1644 struct sortvec
*s1
, *s2
;
1646 if (s1
->priority
!= s2
->priority
)
1647 return s1
->priority
- s2
->priority
;
1648 if (s1
->beg
!= s2
->beg
)
1649 return s1
->beg
- s2
->beg
;
1650 if (s1
->end
!= s2
->end
)
1651 return s2
->end
- s1
->end
;
1655 /* Sort an array of overlays by priority. The array is modified in place.
1656 The return value is the new size; this may be smaller than the original
1657 size if some of the overlays were invalid or were window-specific. */
1659 sort_overlays (overlay_vec
, noverlays
, w
)
1660 Lisp_Object
*overlay_vec
;
1665 struct sortvec
*sortvec
;
1666 sortvec
= (struct sortvec
*) alloca (noverlays
* sizeof (struct sortvec
));
1668 /* Put the valid and relevant overlays into sortvec. */
1670 for (i
= 0, j
= 0; i
< noverlays
; i
++)
1673 Lisp_Object overlay
;
1675 overlay
= overlay_vec
[i
];
1676 if (OVERLAY_VALID (overlay
)
1677 && OVERLAY_POSITION (OVERLAY_START (overlay
)) > 0
1678 && OVERLAY_POSITION (OVERLAY_END (overlay
)) > 0)
1680 /* If we're interested in a specific window, then ignore
1681 overlays that are limited to some other window. */
1686 window
= Foverlay_get (overlay
, Qwindow
);
1687 if (WINDOWP (window
) && XWINDOW (window
) != w
)
1691 /* This overlay is good and counts: put it into sortvec. */
1692 sortvec
[j
].overlay
= overlay
;
1693 sortvec
[j
].beg
= OVERLAY_POSITION (OVERLAY_START (overlay
));
1694 sortvec
[j
].end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
1695 tem
= Foverlay_get (overlay
, Qpriority
);
1697 sortvec
[j
].priority
= XINT (tem
);
1699 sortvec
[j
].priority
= 0;
1705 /* Sort the overlays into the proper order: increasing priority. */
1708 qsort (sortvec
, noverlays
, sizeof (struct sortvec
), compare_overlays
);
1710 for (i
= 0; i
< noverlays
; i
++)
1711 overlay_vec
[i
] = sortvec
[i
].overlay
;
1715 /* Shift overlays in BUF's overlay lists, to center the lists at POS. */
1718 recenter_overlay_lists (buf
, pos
)
1722 Lisp_Object overlay
, tail
, next
, prev
, beg
, end
;
1724 /* See if anything in overlays_before should move to overlays_after. */
1726 /* We don't strictly need prev in this loop; it should always be nil.
1727 But we use it for symmetry and in case that should cease to be true
1728 with some future change. */
1730 for (tail
= buf
->overlays_before
;
1732 prev
= tail
, tail
= next
)
1734 next
= XCONS (tail
)->cdr
;
1735 overlay
= XCONS (tail
)->car
;
1737 /* If the overlay is not valid, get rid of it. */
1738 if (!OVERLAY_VALID (overlay
))
1743 /* Splice the cons cell TAIL out of overlays_before. */
1745 XCONS (prev
)->cdr
= next
;
1747 buf
->overlays_before
= next
;
1753 beg
= OVERLAY_START (overlay
);
1754 end
= OVERLAY_END (overlay
);
1756 if (OVERLAY_POSITION (end
) > pos
)
1758 /* OVERLAY needs to be moved. */
1759 int where
= OVERLAY_POSITION (beg
);
1760 Lisp_Object other
, other_prev
;
1762 /* Splice the cons cell TAIL out of overlays_before. */
1764 XCONS (prev
)->cdr
= next
;
1766 buf
->overlays_before
= next
;
1768 /* Search thru overlays_after for where to put it. */
1770 for (other
= buf
->overlays_after
;
1772 other_prev
= other
, other
= XCONS (other
)->cdr
)
1774 Lisp_Object otherbeg
, otheroverlay
, follower
;
1777 otheroverlay
= XCONS (other
)->car
;
1778 if (! OVERLAY_VALID (otheroverlay
))
1781 otherbeg
= OVERLAY_START (otheroverlay
);
1782 if (OVERLAY_POSITION (otherbeg
) >= where
)
1786 /* Add TAIL to overlays_after before OTHER. */
1787 XCONS (tail
)->cdr
= other
;
1788 if (!NILP (other_prev
))
1789 XCONS (other_prev
)->cdr
= tail
;
1791 buf
->overlays_after
= tail
;
1795 /* We've reached the things that should stay in overlays_before.
1796 All the rest of overlays_before must end even earlier,
1801 /* See if anything in overlays_after should be in overlays_before. */
1803 for (tail
= buf
->overlays_after
;
1805 prev
= tail
, tail
= next
)
1807 next
= XCONS (tail
)->cdr
;
1808 overlay
= XCONS (tail
)->car
;
1810 /* If the overlay is not valid, get rid of it. */
1811 if (!OVERLAY_VALID (overlay
))
1816 /* Splice the cons cell TAIL out of overlays_after. */
1818 XCONS (prev
)->cdr
= next
;
1820 buf
->overlays_after
= next
;
1826 beg
= OVERLAY_START (overlay
);
1827 end
= OVERLAY_END (overlay
);
1829 /* Stop looking, when we know that nothing further
1830 can possibly end before POS. */
1831 if (OVERLAY_POSITION (beg
) > pos
)
1834 if (OVERLAY_POSITION (end
) <= pos
)
1836 /* OVERLAY needs to be moved. */
1837 int where
= OVERLAY_POSITION (end
);
1838 Lisp_Object other
, other_prev
;
1840 /* Splice the cons cell TAIL out of overlays_after. */
1842 XCONS (prev
)->cdr
= next
;
1844 buf
->overlays_after
= next
;
1846 /* Search thru overlays_before for where to put it. */
1848 for (other
= buf
->overlays_before
;
1850 other_prev
= other
, other
= XCONS (other
)->cdr
)
1852 Lisp_Object otherend
, otheroverlay
;
1855 otheroverlay
= XCONS (other
)->car
;
1856 if (! OVERLAY_VALID (otheroverlay
))
1859 otherend
= OVERLAY_END (otheroverlay
);
1860 if (OVERLAY_POSITION (otherend
) <= where
)
1864 /* Add TAIL to overlays_before before OTHER. */
1865 XCONS (tail
)->cdr
= other
;
1866 if (!NILP (other_prev
))
1867 XCONS (other_prev
)->cdr
= tail
;
1869 buf
->overlays_before
= tail
;
1874 XSETFASTINT (buf
->overlay_center
, pos
);
1877 /* Fix up overlays that were garbled as a result of permuting markers
1878 in the range START through END. Any overlay with at least one
1879 endpoint in this range will need to be unlinked from the overlay
1880 list and reinserted in its proper place.
1881 Such an overlay might even have negative size at this point.
1882 If so, we'll reverse the endpoints. Can you think of anything
1883 better to do in this situation? */
1885 fix_overlays_in_range (start
, end
)
1886 register int start
, end
;
1888 Lisp_Object tem
, overlay
;
1889 Lisp_Object before_list
, after_list
;
1890 Lisp_Object
*ptail
, *pbefore
= &before_list
, *pafter
= &after_list
;
1891 int startpos
, endpos
;
1893 /* This algorithm shifts links around instead of consing and GCing.
1894 The loop invariant is that before_list (resp. after_list) is a
1895 well-formed list except that its last element, the one that
1896 *pbefore (resp. *pafter) points to, is still uninitialized.
1897 So it's not a bug that before_list isn't initialized, although
1898 it may look strange. */
1899 for (ptail
= ¤t_buffer
->overlays_before
; CONSP (*ptail
);)
1901 overlay
= XCONS (*ptail
)->car
;
1902 endpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
1905 startpos
= OVERLAY_POSITION (OVERLAY_START (overlay
));
1907 || (startpos
>= start
&& startpos
< end
))
1909 /* If the overlay is backwards, fix that now. */
1910 if (startpos
> endpos
)
1913 Fset_marker (OVERLAY_START (overlay
), endpos
, Qnil
);
1914 Fset_marker (OVERLAY_END (overlay
), startpos
, Qnil
);
1915 tem
= startpos
; startpos
= endpos
; endpos
= tem
;
1917 /* Add it to the end of the wrong list. Later on,
1918 recenter_overlay_lists will move it to the right place. */
1919 if (endpos
< XINT (current_buffer
->overlay_center
))
1922 pafter
= &XCONS (*ptail
)->cdr
;
1927 pbefore
= &XCONS (*ptail
)->cdr
;
1929 *ptail
= XCONS (*ptail
)->cdr
;
1932 ptail
= &XCONS (*ptail
)->cdr
;
1934 for (ptail
= ¤t_buffer
->overlays_after
; CONSP (*ptail
);)
1936 overlay
= XCONS (*ptail
)->car
;
1937 startpos
= OVERLAY_POSITION (OVERLAY_START (overlay
));
1938 if (startpos
>= end
)
1940 endpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
1941 if (startpos
>= start
1942 || (endpos
>= start
&& endpos
< end
))
1944 if (startpos
> endpos
)
1947 Fset_marker (OVERLAY_START (overlay
), endpos
, Qnil
);
1948 Fset_marker (OVERLAY_END (overlay
), startpos
, Qnil
);
1949 tem
= startpos
; startpos
= endpos
; endpos
= tem
;
1951 if (endpos
< XINT (current_buffer
->overlay_center
))
1954 pafter
= &XCONS (*ptail
)->cdr
;
1959 pbefore
= &XCONS (*ptail
)->cdr
;
1961 *ptail
= XCONS (*ptail
)->cdr
;
1964 ptail
= &XCONS (*ptail
)->cdr
;
1967 /* Splice the constructed (wrong) lists into the buffer's lists,
1968 and let the recenter function make it sane again. */
1969 *pbefore
= current_buffer
->overlays_before
;
1970 current_buffer
->overlays_before
= before_list
;
1971 recenter_overlay_lists (current_buffer
,
1972 XINT (current_buffer
->overlay_center
));
1974 *pafter
= current_buffer
->overlays_after
;
1975 current_buffer
->overlays_after
= after_list
;
1976 recenter_overlay_lists (current_buffer
,
1977 XINT (current_buffer
->overlay_center
));
1980 DEFUN ("overlayp", Foverlayp
, Soverlayp
, 1, 1, 0,
1981 "Return t if OBJECT is an overlay.")
1985 return (OVERLAYP (object
) ? Qt
: Qnil
);
1988 DEFUN ("make-overlay", Fmake_overlay
, Smake_overlay
, 2, 3, 0,
1989 "Create a new overlay with range BEG to END in BUFFER.\n\
1990 If omitted, BUFFER defaults to the current buffer.\n\
1991 BEG and END may be integers or markers.")
1993 Lisp_Object beg
, end
, buffer
;
1995 Lisp_Object overlay
;
1999 XSETBUFFER (buffer
, current_buffer
);
2001 CHECK_BUFFER (buffer
, 2);
2003 && ! EQ (Fmarker_buffer (beg
), buffer
))
2004 error ("Marker points into wrong buffer");
2006 && ! EQ (Fmarker_buffer (end
), buffer
))
2007 error ("Marker points into wrong buffer");
2009 CHECK_NUMBER_COERCE_MARKER (beg
, 1);
2010 CHECK_NUMBER_COERCE_MARKER (end
, 1);
2012 if (XINT (beg
) > XINT (end
))
2015 temp
= beg
; beg
= end
; end
= temp
;
2018 b
= XBUFFER (buffer
);
2020 beg
= Fset_marker (Fmake_marker (), beg
, buffer
);
2021 end
= Fset_marker (Fmake_marker (), end
, buffer
);
2023 overlay
= allocate_misc ();
2024 XMISC (overlay
)->type
= Lisp_Misc_Overlay
;
2025 XOVERLAY (overlay
)->start
= beg
;
2026 XOVERLAY (overlay
)->end
= end
;
2027 XOVERLAY (overlay
)->plist
= Qnil
;
2029 /* Put the new overlay on the wrong list. */
2030 end
= OVERLAY_END (overlay
);
2031 if (OVERLAY_POSITION (end
) < XINT (b
->overlay_center
))
2032 b
->overlays_after
= Fcons (overlay
, b
->overlays_after
);
2034 b
->overlays_before
= Fcons (overlay
, b
->overlays_before
);
2036 /* This puts it in the right list, and in the right order. */
2037 recenter_overlay_lists (b
, XINT (b
->overlay_center
));
2039 /* We don't need to redisplay the region covered by the overlay, because
2040 the overlay has no properties at the moment. */
2045 DEFUN ("move-overlay", Fmove_overlay
, Smove_overlay
, 3, 4, 0,
2046 "Set the endpoints of OVERLAY to BEG and END in BUFFER.\n\
2047 If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.\n\
2048 If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current\n\
2050 (overlay
, beg
, end
, buffer
)
2051 Lisp_Object overlay
, beg
, end
, buffer
;
2053 struct buffer
*b
, *ob
;
2054 Lisp_Object obuffer
;
2055 int count
= specpdl_ptr
- specpdl
;
2057 CHECK_OVERLAY (overlay
, 0);
2059 buffer
= Fmarker_buffer (OVERLAY_START (overlay
));
2061 XSETBUFFER (buffer
, current_buffer
);
2062 CHECK_BUFFER (buffer
, 3);
2065 && ! EQ (Fmarker_buffer (beg
), buffer
))
2066 error ("Marker points into wrong buffer");
2068 && ! EQ (Fmarker_buffer (end
), buffer
))
2069 error ("Marker points into wrong buffer");
2071 CHECK_NUMBER_COERCE_MARKER (beg
, 1);
2072 CHECK_NUMBER_COERCE_MARKER (end
, 1);
2074 if (XINT (beg
) == XINT (end
) && ! NILP (Foverlay_get (overlay
, Qevaporate
)))
2075 return Fdelete_overlay (overlay
);
2077 if (XINT (beg
) > XINT (end
))
2080 temp
= beg
; beg
= end
; end
= temp
;
2083 specbind (Qinhibit_quit
, Qt
);
2085 obuffer
= Fmarker_buffer (OVERLAY_START (overlay
));
2086 b
= XBUFFER (buffer
);
2087 ob
= XBUFFER (obuffer
);
2089 /* If the overlay has changed buffers, do a thorough redisplay. */
2090 if (!EQ (buffer
, obuffer
))
2092 /* Redisplay where the overlay was. */
2093 if (!NILP (obuffer
))
2098 o_beg
= OVERLAY_START (overlay
);
2099 o_end
= OVERLAY_END (overlay
);
2100 o_beg
= OVERLAY_POSITION (o_beg
);
2101 o_end
= OVERLAY_POSITION (o_end
);
2103 redisplay_region (ob
, XINT (o_beg
), XINT (o_end
));
2106 /* Redisplay where the overlay is going to be. */
2107 redisplay_region (b
, XINT (beg
), XINT (end
));
2109 /* Don't limit redisplay to the selected window. */
2110 windows_or_buffers_changed
= 1;
2113 /* Redisplay the area the overlay has just left, or just enclosed. */
2117 int change_beg
, change_end
;
2119 o_beg
= OVERLAY_START (overlay
);
2120 o_end
= OVERLAY_END (overlay
);
2121 o_beg
= OVERLAY_POSITION (o_beg
);
2122 o_end
= OVERLAY_POSITION (o_end
);
2124 if (XINT (o_beg
) == XINT (beg
))
2125 redisplay_region (b
, XINT (o_end
), XINT (end
));
2126 else if (XINT (o_end
) == XINT (end
))
2127 redisplay_region (b
, XINT (o_beg
), XINT (beg
));
2130 if (XINT (beg
) < XINT (o_beg
)) o_beg
= beg
;
2131 if (XINT (end
) > XINT (o_end
)) o_end
= end
;
2132 redisplay_region (b
, XINT (o_beg
), XINT (o_end
));
2136 if (!NILP (obuffer
))
2138 ob
->overlays_before
= Fdelq (overlay
, ob
->overlays_before
);
2139 ob
->overlays_after
= Fdelq (overlay
, ob
->overlays_after
);
2142 Fset_marker (OVERLAY_START (overlay
), beg
, buffer
);
2143 Fset_marker (OVERLAY_END (overlay
), end
, buffer
);
2145 /* Put the overlay on the wrong list. */
2146 end
= OVERLAY_END (overlay
);
2147 if (OVERLAY_POSITION (end
) < XINT (b
->overlay_center
))
2148 b
->overlays_after
= Fcons (overlay
, b
->overlays_after
);
2150 b
->overlays_before
= Fcons (overlay
, b
->overlays_before
);
2152 /* This puts it in the right list, and in the right order. */
2153 recenter_overlay_lists (b
, XINT (b
->overlay_center
));
2155 return unbind_to (count
, overlay
);
2158 DEFUN ("delete-overlay", Fdelete_overlay
, Sdelete_overlay
, 1, 1, 0,
2159 "Delete the overlay OVERLAY from its buffer.")
2161 Lisp_Object overlay
;
2165 int count
= specpdl_ptr
- specpdl
;
2167 CHECK_OVERLAY (overlay
, 0);
2169 buffer
= Fmarker_buffer (OVERLAY_START (overlay
));
2173 b
= XBUFFER (buffer
);
2175 specbind (Qinhibit_quit
, Qt
);
2177 b
->overlays_before
= Fdelq (overlay
, b
->overlays_before
);
2178 b
->overlays_after
= Fdelq (overlay
, b
->overlays_after
);
2180 redisplay_region (b
,
2181 marker_position (OVERLAY_START (overlay
)),
2182 marker_position (OVERLAY_END (overlay
)));
2184 Fset_marker (OVERLAY_START (overlay
), Qnil
, Qnil
);
2185 Fset_marker (OVERLAY_END (overlay
), Qnil
, Qnil
);
2187 return unbind_to (count
, Qnil
);
2190 /* Overlay dissection functions. */
2192 DEFUN ("overlay-start", Foverlay_start
, Soverlay_start
, 1, 1, 0,
2193 "Return the position at which OVERLAY starts.")
2195 Lisp_Object overlay
;
2197 CHECK_OVERLAY (overlay
, 0);
2199 return (Fmarker_position (OVERLAY_START (overlay
)));
2202 DEFUN ("overlay-end", Foverlay_end
, Soverlay_end
, 1, 1, 0,
2203 "Return the position at which OVERLAY ends.")
2205 Lisp_Object overlay
;
2207 CHECK_OVERLAY (overlay
, 0);
2209 return (Fmarker_position (OVERLAY_END (overlay
)));
2212 DEFUN ("overlay-buffer", Foverlay_buffer
, Soverlay_buffer
, 1, 1, 0,
2213 "Return the buffer OVERLAY belongs to.")
2215 Lisp_Object overlay
;
2217 CHECK_OVERLAY (overlay
, 0);
2219 return Fmarker_buffer (OVERLAY_START (overlay
));
2222 DEFUN ("overlay-properties", Foverlay_properties
, Soverlay_properties
, 1, 1, 0,
2223 "Return a list of the properties on OVERLAY.\n\
2224 This is a copy of OVERLAY's plist; modifying its conses has no effect on\n\
2227 Lisp_Object overlay
;
2229 CHECK_OVERLAY (overlay
, 0);
2231 return Fcopy_sequence (XOVERLAY (overlay
)->plist
);
2235 DEFUN ("overlays-at", Foverlays_at
, Soverlays_at
, 1, 1, 0,
2236 "Return a list of the overlays that contain position POS.")
2241 Lisp_Object
*overlay_vec
;
2245 CHECK_NUMBER_COERCE_MARKER (pos
, 0);
2248 overlay_vec
= (Lisp_Object
*) xmalloc (len
* sizeof (Lisp_Object
));
2250 /* Put all the overlays we want in a vector in overlay_vec.
2251 Store the length in len. */
2252 noverlays
= overlays_at (XINT (pos
), 1, &overlay_vec
, &len
, NULL
, NULL
);
2254 /* Make a list of them all. */
2255 result
= Flist (noverlays
, overlay_vec
);
2257 xfree (overlay_vec
);
2261 DEFUN ("next-overlay-change", Fnext_overlay_change
, Snext_overlay_change
,
2263 "Return the next position after POS where an overlay starts or ends.\n\
2264 If there are no more overlay boundaries after POS, return (point-max).")
2270 Lisp_Object
*overlay_vec
;
2274 CHECK_NUMBER_COERCE_MARKER (pos
, 0);
2277 overlay_vec
= (Lisp_Object
*) xmalloc (len
* sizeof (Lisp_Object
));
2279 /* Put all the overlays we want in a vector in overlay_vec.
2280 Store the length in len.
2281 endpos gets the position where the next overlay starts. */
2282 noverlays
= overlays_at (XINT (pos
), 1, &overlay_vec
, &len
, &endpos
, NULL
);
2284 /* If any of these overlays ends before endpos,
2285 use its ending point instead. */
2286 for (i
= 0; i
< noverlays
; i
++)
2291 oend
= OVERLAY_END (overlay_vec
[i
]);
2292 oendpos
= OVERLAY_POSITION (oend
);
2293 if (oendpos
< endpos
)
2297 xfree (overlay_vec
);
2298 return make_number (endpos
);
2301 DEFUN ("previous-overlay-change", Fprevious_overlay_change
,
2302 Sprevious_overlay_change
, 1, 1, 0,
2303 "Return the previous position before POS where an overlay starts or ends.\n\
2304 If there are no more overlay boundaries after POS, return (point-min).")
2310 Lisp_Object
*overlay_vec
;
2314 CHECK_NUMBER_COERCE_MARKER (pos
, 0);
2317 overlay_vec
= (Lisp_Object
*) xmalloc (len
* sizeof (Lisp_Object
));
2319 /* Put all the overlays we want in a vector in overlay_vec.
2320 Store the length in len.
2321 prevpos gets the position of an overlay end. */
2322 noverlays
= overlays_at (XINT (pos
), 1, &overlay_vec
, &len
, NULL
, &prevpos
);
2324 /* If any of these overlays starts before endpos,
2325 maybe use its starting point instead. */
2326 for (i
= 0; i
< noverlays
; i
++)
2331 ostart
= OVERLAY_START (overlay_vec
[i
]);
2332 ostartpos
= OVERLAY_POSITION (ostart
);
2333 if (ostartpos
> prevpos
&& ostartpos
< XINT (pos
))
2334 prevpos
= ostartpos
;
2337 xfree (overlay_vec
);
2338 return make_number (prevpos
);
2341 /* These functions are for debugging overlays. */
2343 DEFUN ("overlay-lists", Foverlay_lists
, Soverlay_lists
, 0, 0, 0,
2344 "Return a pair of lists giving all the overlays of the current buffer.\n\
2345 The car has all the overlays before the overlay center;\n\
2346 the cdr has all the overlays after the overlay center.\n\
2347 Recentering overlays moves overlays between these lists.\n\
2348 The lists you get are copies, so that changing them has no effect.\n\
2349 However, the overlays you get are the real objects that the buffer uses.")
2352 Lisp_Object before
, after
;
2353 before
= current_buffer
->overlays_before
;
2355 before
= Fcopy_sequence (before
);
2356 after
= current_buffer
->overlays_after
;
2358 after
= Fcopy_sequence (after
);
2360 return Fcons (before
, after
);
2363 DEFUN ("overlay-recenter", Foverlay_recenter
, Soverlay_recenter
, 1, 1, 0,
2364 "Recenter the overlays of the current buffer around position POS.")
2368 CHECK_NUMBER_COERCE_MARKER (pos
, 0);
2370 recenter_overlay_lists (current_buffer
, XINT (pos
));
2374 DEFUN ("overlay-get", Foverlay_get
, Soverlay_get
, 2, 2, 0,
2375 "Get the property of overlay OVERLAY with property name NAME.")
2377 Lisp_Object overlay
, prop
;
2379 Lisp_Object plist
, fallback
;
2381 CHECK_OVERLAY (overlay
, 0);
2385 for (plist
= XOVERLAY (overlay
)->plist
;
2386 CONSP (plist
) && CONSP (XCONS (plist
)->cdr
);
2387 plist
= XCONS (XCONS (plist
)->cdr
)->cdr
)
2389 if (EQ (XCONS (plist
)->car
, prop
))
2390 return XCONS (XCONS (plist
)->cdr
)->car
;
2391 else if (EQ (XCONS (plist
)->car
, Qcategory
))
2394 tem
= Fcar (Fcdr (plist
));
2396 fallback
= Fget (tem
, prop
);
2403 DEFUN ("overlay-put", Foverlay_put
, Soverlay_put
, 3, 3, 0,
2404 "Set one property of overlay OVERLAY: give property PROP value VALUE.")
2405 (overlay
, prop
, value
)
2406 Lisp_Object overlay
, prop
, value
;
2408 Lisp_Object tail
, buffer
;
2411 CHECK_OVERLAY (overlay
, 0);
2413 buffer
= Fmarker_buffer (OVERLAY_START (overlay
));
2415 for (tail
= XOVERLAY (overlay
)->plist
;
2416 CONSP (tail
) && CONSP (XCONS (tail
)->cdr
);
2417 tail
= XCONS (XCONS (tail
)->cdr
)->cdr
)
2418 if (EQ (XCONS (tail
)->car
, prop
))
2420 changed
= !EQ (XCONS (XCONS (tail
)->cdr
)->car
, value
);
2421 XCONS (XCONS (tail
)->cdr
)->car
= value
;
2424 /* It wasn't in the list, so add it to the front. */
2425 changed
= !NILP (value
);
2426 XOVERLAY (overlay
)->plist
2427 = Fcons (prop
, Fcons (value
, XOVERLAY (overlay
)->plist
));
2429 if (! NILP (buffer
))
2432 redisplay_region (XBUFFER (buffer
),
2433 marker_position (OVERLAY_START (overlay
)),
2434 marker_position (OVERLAY_END (overlay
)));
2435 if (EQ (prop
, Qevaporate
) && ! NILP (value
)
2436 && (OVERLAY_POSITION (OVERLAY_START (overlay
))
2437 == OVERLAY_POSITION (OVERLAY_END (overlay
))))
2438 Fdelete_overlay (overlay
);
2443 /* Run the modification-hooks of overlays that include
2444 any part of the text in START to END.
2445 Run the insert-before-hooks of overlay starting at END,
2446 and the insert-after-hooks of overlay ending at START.
2448 This is called both before and after the modification.
2449 AFTER is nonzero when we call after the modification.
2451 ARG1, ARG2, ARG3 are arguments to pass to the hook functions. */
2454 report_overlay_modification (start
, end
, after
, arg1
, arg2
, arg3
)
2455 Lisp_Object start
, end
;
2457 Lisp_Object arg1
, arg2
, arg3
;
2459 Lisp_Object prop
, overlay
, tail
;
2460 int insertion
= EQ (start
, end
);
2462 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2466 GCPRO5 (overlay
, tail
, arg1
, arg2
, arg3
);
2469 for (tail
= current_buffer
->overlays_before
;
2471 tail
= XCONS (tail
)->cdr
)
2473 int startpos
, endpos
;
2474 Lisp_Object ostart
, oend
;
2476 overlay
= XCONS (tail
)->car
;
2478 ostart
= OVERLAY_START (overlay
);
2479 oend
= OVERLAY_END (overlay
);
2480 endpos
= OVERLAY_POSITION (oend
);
2481 if (XFASTINT (start
) > endpos
)
2483 startpos
= OVERLAY_POSITION (ostart
);
2484 if (XFASTINT (end
) == startpos
&& insertion
)
2486 prop
= Foverlay_get (overlay
, Qinsert_in_front_hooks
);
2489 /* Copy TAIL in case the hook recenters the overlay lists. */
2491 tail
= Fcopy_sequence (tail
);
2493 call_overlay_mod_hooks (prop
, overlay
, after
, arg1
, arg2
, arg3
);
2496 if (XFASTINT (start
) == endpos
&& insertion
)
2498 prop
= Foverlay_get (overlay
, Qinsert_behind_hooks
);
2502 tail
= Fcopy_sequence (tail
);
2504 call_overlay_mod_hooks (prop
, overlay
, after
, arg1
, arg2
, arg3
);
2507 /* Test for intersecting intervals. This does the right thing
2508 for both insertion and deletion. */
2509 if (XFASTINT (end
) > startpos
&& XFASTINT (start
) < endpos
)
2511 prop
= Foverlay_get (overlay
, Qmodification_hooks
);
2515 tail
= Fcopy_sequence (tail
);
2517 call_overlay_mod_hooks (prop
, overlay
, after
, arg1
, arg2
, arg3
);
2523 for (tail
= current_buffer
->overlays_after
;
2525 tail
= XCONS (tail
)->cdr
)
2527 int startpos
, endpos
;
2528 Lisp_Object ostart
, oend
;
2530 overlay
= XCONS (tail
)->car
;
2532 ostart
= OVERLAY_START (overlay
);
2533 oend
= OVERLAY_END (overlay
);
2534 startpos
= OVERLAY_POSITION (ostart
);
2535 endpos
= OVERLAY_POSITION (oend
);
2536 if (XFASTINT (end
) < startpos
)
2538 if (XFASTINT (end
) == startpos
&& insertion
)
2540 prop
= Foverlay_get (overlay
, Qinsert_in_front_hooks
);
2544 tail
= Fcopy_sequence (tail
);
2546 call_overlay_mod_hooks (prop
, overlay
, after
, arg1
, arg2
, arg3
);
2549 if (XFASTINT (start
) == endpos
&& insertion
)
2551 prop
= Foverlay_get (overlay
, Qinsert_behind_hooks
);
2555 tail
= Fcopy_sequence (tail
);
2557 call_overlay_mod_hooks (prop
, overlay
, after
, arg1
, arg2
, arg3
);
2560 /* Test for intersecting intervals. This does the right thing
2561 for both insertion and deletion. */
2562 if (XFASTINT (end
) > startpos
&& XFASTINT (start
) < endpos
)
2564 prop
= Foverlay_get (overlay
, Qmodification_hooks
);
2568 tail
= Fcopy_sequence (tail
);
2570 call_overlay_mod_hooks (prop
, overlay
, after
, arg1
, arg2
, arg3
);
2579 call_overlay_mod_hooks (list
, overlay
, after
, arg1
, arg2
, arg3
)
2580 Lisp_Object list
, overlay
;
2582 Lisp_Object arg1
, arg2
, arg3
;
2584 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2585 GCPRO4 (list
, arg1
, arg2
, arg3
);
2586 while (!NILP (list
))
2589 call4 (Fcar (list
), overlay
, after
? Qt
: Qnil
, arg1
, arg2
);
2591 call5 (Fcar (list
), overlay
, after
? Qt
: Qnil
, arg1
, arg2
, arg3
);
2597 /* Delete any zero-sized overlays at position POS, if the `evaporate'
2600 evaporate_overlays (pos
)
2603 Lisp_Object tail
, overlay
, hit_list
;
2606 if (pos
<= XFASTINT (current_buffer
->overlay_center
))
2607 for (tail
= current_buffer
->overlays_before
; CONSP (tail
);
2608 tail
= XCONS (tail
)->cdr
)
2611 overlay
= XCONS (tail
)->car
;
2612 endpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
2615 if (endpos
== pos
&& OVERLAY_POSITION (OVERLAY_START (overlay
)) == pos
2616 && Foverlay_get (overlay
, Qevaporate
))
2617 hit_list
= Fcons (overlay
, hit_list
);
2620 for (tail
= current_buffer
->overlays_after
; CONSP (tail
);
2621 tail
= XCONS (tail
)->cdr
)
2624 overlay
= XCONS (tail
)->car
;
2625 startpos
= OVERLAY_POSITION (OVERLAY_START (overlay
));
2628 if (startpos
== pos
&& OVERLAY_POSITION (OVERLAY_END (overlay
)) == pos
2629 && Foverlay_get (overlay
, Qevaporate
))
2630 hit_list
= Fcons (overlay
, hit_list
);
2632 for (; CONSP (hit_list
); hit_list
= XCONS (hit_list
)->cdr
)
2633 Fdelete_overlay (XCONS (hit_list
)->car
);
2636 /* Somebody has tried to store a value with an unacceptable type
2637 into the buffer-local slot with offset OFFSET. */
2639 buffer_slot_type_mismatch (offset
)
2644 sym
= *(Lisp_Object
*)(offset
+ (char *)&buffer_local_symbols
);
2645 switch (XINT (*(Lisp_Object
*)(offset
+ (char *)&buffer_local_types
)))
2647 case Lisp_Int
: type_name
= "integers"; break;
2648 case Lisp_String
: type_name
= "strings"; break;
2649 case Lisp_Symbol
: type_name
= "symbols"; break;
2654 error ("only %s should be stored in the buffer-local variable %s",
2655 type_name
, XSYMBOL (sym
)->name
->data
);
2660 register Lisp_Object tem
;
2662 /* Make sure all markable slots in buffer_defaults
2663 are initialized reasonably, so mark_buffer won't choke. */
2664 reset_buffer (&buffer_defaults
);
2665 reset_buffer_local_variables (&buffer_defaults
);
2666 reset_buffer (&buffer_local_symbols
);
2667 reset_buffer_local_variables (&buffer_local_symbols
);
2668 /* Prevent GC from getting confused. */
2669 buffer_defaults
.text
= &buffer_defaults
.own_text
;
2670 buffer_local_symbols
.text
= &buffer_local_symbols
.own_text
;
2671 #ifdef USE_TEXT_PROPERTIES
2672 BUF_INTERVALS (&buffer_defaults
) = 0;
2673 BUF_INTERVALS (&buffer_local_symbols
) = 0;
2675 XSETBUFFER (Vbuffer_defaults
, &buffer_defaults
);
2676 XSETBUFFER (Vbuffer_local_symbols
, &buffer_local_symbols
);
2678 /* Set up the default values of various buffer slots. */
2679 /* Must do these before making the first buffer! */
2681 /* real setup is done in loaddefs.el */
2682 buffer_defaults
.mode_line_format
= build_string ("%-");
2683 buffer_defaults
.abbrev_mode
= Qnil
;
2684 buffer_defaults
.overwrite_mode
= Qnil
;
2685 buffer_defaults
.case_fold_search
= Qt
;
2686 buffer_defaults
.auto_fill_function
= Qnil
;
2687 buffer_defaults
.selective_display
= Qnil
;
2689 buffer_defaults
.selective_display_ellipses
= Qt
;
2691 buffer_defaults
.abbrev_table
= Qnil
;
2692 buffer_defaults
.display_table
= Qnil
;
2693 buffer_defaults
.undo_list
= Qnil
;
2694 buffer_defaults
.mark_active
= Qnil
;
2695 buffer_defaults
.file_format
= Qnil
;
2696 buffer_defaults
.overlays_before
= Qnil
;
2697 buffer_defaults
.overlays_after
= Qnil
;
2698 XSETFASTINT (buffer_defaults
.overlay_center
, 1);
2700 XSETFASTINT (buffer_defaults
.tab_width
, 8);
2701 buffer_defaults
.truncate_lines
= Qnil
;
2702 buffer_defaults
.ctl_arrow
= Qt
;
2705 buffer_defaults
.buffer_file_type
= Qnil
; /* TEXT */
2707 XSETFASTINT (buffer_defaults
.fill_column
, 70);
2708 XSETFASTINT (buffer_defaults
.left_margin
, 0);
2709 buffer_defaults
.cache_long_line_scans
= Qnil
;
2710 buffer_defaults
.file_truename
= Qnil
;
2712 /* Assign the local-flags to the slots that have default values.
2713 The local flag is a bit that is used in the buffer
2714 to say that it has its own local value for the slot.
2715 The local flag bits are in the local_var_flags slot of the buffer. */
2717 /* Nothing can work if this isn't true */
2718 if (sizeof (EMACS_INT
) != sizeof (Lisp_Object
)) abort ();
2720 /* 0 means not a lisp var, -1 means always local, else mask */
2721 bzero (&buffer_local_flags
, sizeof buffer_local_flags
);
2722 XSETINT (buffer_local_flags
.filename
, -1);
2723 XSETINT (buffer_local_flags
.directory
, -1);
2724 XSETINT (buffer_local_flags
.backed_up
, -1);
2725 XSETINT (buffer_local_flags
.save_length
, -1);
2726 XSETINT (buffer_local_flags
.auto_save_file_name
, -1);
2727 XSETINT (buffer_local_flags
.read_only
, -1);
2728 XSETINT (buffer_local_flags
.major_mode
, -1);
2729 XSETINT (buffer_local_flags
.mode_name
, -1);
2730 XSETINT (buffer_local_flags
.undo_list
, -1);
2731 XSETINT (buffer_local_flags
.mark_active
, -1);
2732 XSETINT (buffer_local_flags
.point_before_scroll
, -1);
2733 XSETINT (buffer_local_flags
.file_truename
, -1);
2734 XSETINT (buffer_local_flags
.invisibility_spec
, -1);
2736 XSETFASTINT (buffer_local_flags
.mode_line_format
, 1);
2737 XSETFASTINT (buffer_local_flags
.abbrev_mode
, 2);
2738 XSETFASTINT (buffer_local_flags
.overwrite_mode
, 4);
2739 XSETFASTINT (buffer_local_flags
.case_fold_search
, 8);
2740 XSETFASTINT (buffer_local_flags
.auto_fill_function
, 0x10);
2741 XSETFASTINT (buffer_local_flags
.selective_display
, 0x20);
2743 XSETFASTINT (buffer_local_flags
.selective_display_ellipses
, 0x40);
2745 XSETFASTINT (buffer_local_flags
.tab_width
, 0x80);
2746 XSETFASTINT (buffer_local_flags
.truncate_lines
, 0x100);
2747 XSETFASTINT (buffer_local_flags
.ctl_arrow
, 0x200);
2748 XSETFASTINT (buffer_local_flags
.fill_column
, 0x400);
2749 XSETFASTINT (buffer_local_flags
.left_margin
, 0x800);
2750 XSETFASTINT (buffer_local_flags
.abbrev_table
, 0x1000);
2751 XSETFASTINT (buffer_local_flags
.display_table
, 0x2000);
2752 XSETFASTINT (buffer_local_flags
.syntax_table
, 0x8000);
2753 XSETFASTINT (buffer_local_flags
.cache_long_line_scans
, 0x10000);
2754 XSETFASTINT (buffer_local_flags
.file_format
, 0x20000);
2756 XSETFASTINT (buffer_local_flags
.buffer_file_type
, 0x4000);
2759 Vbuffer_alist
= Qnil
;
2763 QSFundamental
= build_string ("Fundamental");
2765 Qfundamental_mode
= intern ("fundamental-mode");
2766 buffer_defaults
.major_mode
= Qfundamental_mode
;
2768 Qmode_class
= intern ("mode-class");
2770 Qprotected_field
= intern ("protected-field");
2772 Qpermanent_local
= intern ("permanent-local");
2774 Qkill_buffer_hook
= intern ("kill-buffer-hook");
2776 Vprin1_to_string_buffer
= Fget_buffer_create (build_string (" prin1"));
2777 /* super-magic invisible buffer */
2778 Vbuffer_alist
= Qnil
;
2780 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
2785 char buf
[MAXPATHLEN
+1];
2787 struct stat dotstat
, pwdstat
;
2791 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
2793 /* If PWD is accurate, use it instead of calling getwd. This is faster
2794 when PWD is right, and may avoid a fatal error. */
2795 if ((pwd
= getenv ("PWD")) != 0 && IS_DIRECTORY_SEP (*pwd
)
2796 && stat (pwd
, &pwdstat
) == 0
2797 && stat (".", &dotstat
) == 0
2798 && dotstat
.st_ino
== pwdstat
.st_ino
2799 && dotstat
.st_dev
== pwdstat
.st_dev
2800 && strlen (pwd
) < MAXPATHLEN
)
2802 else if (getwd (buf
) == 0)
2803 fatal ("`getwd' failed: %s\n", buf
);
2806 /* Maybe this should really use some standard subroutine
2807 whose definition is filename syntax dependent. */
2809 if (!(IS_DIRECTORY_SEP (buf
[rc
- 1])))
2811 buf
[rc
] = DIRECTORY_SEP
;
2814 #endif /* not VMS */
2815 current_buffer
->directory
= build_string (buf
);
2817 temp
= get_minibuffer (0);
2818 XBUFFER (temp
)->directory
= current_buffer
->directory
;
2821 /* initialize the buffer routines */
2824 extern Lisp_Object Qdisabled
;
2826 staticpro (&Vbuffer_defaults
);
2827 staticpro (&Vbuffer_local_symbols
);
2828 staticpro (&Qfundamental_mode
);
2829 staticpro (&Qmode_class
);
2830 staticpro (&QSFundamental
);
2831 staticpro (&Vbuffer_alist
);
2832 staticpro (&Qprotected_field
);
2833 staticpro (&Qpermanent_local
);
2834 staticpro (&Qkill_buffer_hook
);
2835 staticpro (&Qoverlayp
);
2836 Qevaporate
= intern ("evaporate");
2837 staticpro (&Qevaporate
);
2838 staticpro (&Qmodification_hooks
);
2839 Qmodification_hooks
= intern ("modification-hooks");
2840 staticpro (&Qinsert_in_front_hooks
);
2841 Qinsert_in_front_hooks
= intern ("insert-in-front-hooks");
2842 staticpro (&Qinsert_behind_hooks
);
2843 Qinsert_behind_hooks
= intern ("insert-behind-hooks");
2844 staticpro (&Qget_file_buffer
);
2845 Qget_file_buffer
= intern ("get-file-buffer");
2846 Qpriority
= intern ("priority");
2847 staticpro (&Qpriority
);
2848 Qwindow
= intern ("window");
2849 staticpro (&Qwindow
);
2851 Qoverlayp
= intern ("overlayp");
2853 Fput (Qprotected_field
, Qerror_conditions
,
2854 Fcons (Qprotected_field
, Fcons (Qerror
, Qnil
)));
2855 Fput (Qprotected_field
, Qerror_message
,
2856 build_string ("Attempt to modify a protected field"));
2858 /* All these use DEFVAR_LISP_NOPRO because the slots in
2859 buffer_defaults will all be marked via Vbuffer_defaults. */
2861 DEFVAR_LISP_NOPRO ("default-mode-line-format",
2862 &buffer_defaults
.mode_line_format
,
2863 "Default value of `mode-line-format' for buffers that don't override it.\n\
2864 This is the same as (default-value 'mode-line-format).");
2866 DEFVAR_LISP_NOPRO ("default-abbrev-mode",
2867 &buffer_defaults
.abbrev_mode
,
2868 "Default value of `abbrev-mode' for buffers that do not override it.\n\
2869 This is the same as (default-value 'abbrev-mode).");
2871 DEFVAR_LISP_NOPRO ("default-ctl-arrow",
2872 &buffer_defaults
.ctl_arrow
,
2873 "Default value of `ctl-arrow' for buffers that do not override it.\n\
2874 This is the same as (default-value 'ctl-arrow).");
2876 DEFVAR_LISP_NOPRO ("default-truncate-lines",
2877 &buffer_defaults
.truncate_lines
,
2878 "Default value of `truncate-lines' for buffers that do not override it.\n\
2879 This is the same as (default-value 'truncate-lines).");
2881 DEFVAR_LISP_NOPRO ("default-fill-column",
2882 &buffer_defaults
.fill_column
,
2883 "Default value of `fill-column' for buffers that do not override it.\n\
2884 This is the same as (default-value 'fill-column).");
2886 DEFVAR_LISP_NOPRO ("default-left-margin",
2887 &buffer_defaults
.left_margin
,
2888 "Default value of `left-margin' for buffers that do not override it.\n\
2889 This is the same as (default-value 'left-margin).");
2891 DEFVAR_LISP_NOPRO ("default-tab-width",
2892 &buffer_defaults
.tab_width
,
2893 "Default value of `tab-width' for buffers that do not override it.\n\
2894 This is the same as (default-value 'tab-width).");
2896 DEFVAR_LISP_NOPRO ("default-case-fold-search",
2897 &buffer_defaults
.case_fold_search
,
2898 "Default value of `case-fold-search' for buffers that don't override it.\n\
2899 This is the same as (default-value 'case-fold-search).");
2902 DEFVAR_LISP_NOPRO ("default-buffer-file-type",
2903 &buffer_defaults
.buffer_file_type
,
2904 "Default file type for buffers that do not override it.\n\
2905 This is the same as (default-value 'buffer-file-type).\n\
2906 The file type is nil for text, t for binary.");
2909 DEFVAR_PER_BUFFER ("mode-line-format", ¤t_buffer
->mode_line_format
,
2912 /* This doc string is too long for cpp; cpp dies if it isn't in a comment.
2913 But make-docfile finds it!
2914 DEFVAR_PER_BUFFER ("mode-line-format", ¤t_buffer->mode_line_format,
2916 "Template for displaying mode line for current buffer.\n\
2917 Each buffer has its own value of this variable.\n\
2918 Value may be a string, a symbol or a list or cons cell.\n\
2919 For a symbol, its value is used (but it is ignored if t or nil).\n\
2920 A string appearing directly as the value of a symbol is processed verbatim\n\
2921 in that the %-constructs below are not recognized.\n\
2922 For a list whose car is a symbol, the symbol's value is taken,\n\
2923 and if that is non-nil, the cadr of the list is processed recursively.\n\
2924 Otherwise, the caddr of the list (if there is one) is processed.\n\
2925 For a list whose car is a string or list, each element is processed\n\
2926 recursively and the results are effectively concatenated.\n\
2927 For a list whose car is an integer, the cdr of the list is processed\n\
2928 and padded (if the number is positive) or truncated (if negative)\n\
2929 to the width specified by that number.\n\
2930 A string is printed verbatim in the mode line except for %-constructs:\n\
2931 (%-constructs are allowed when the string is the entire mode-line-format\n\
2932 or when it is found in a cons-cell or a list)\n\
2933 %b -- print buffer name. %f -- print visited file name.\n\
2934 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.\n\
2935 % means buffer is read-only and * means it is modified.\n\
2936 For a modified read-only buffer, %* gives % and %+ gives *.\n\
2937 %s -- print process status. %l -- print the current line number.\n\
2938 %p -- print percent of buffer above top of window, or Top, Bot or All.\n\
2939 %P -- print percent of buffer above bottom of window, perhaps plus Top,\n\
2940 or print Bottom or All.\n\
2941 %n -- print Narrow if appropriate.\n\
2942 %t -- print T if files is text, B if binary.\n\
2943 %[ -- print one [ for each recursive editing level. %] similar.\n\
2944 %% -- print %. %- -- print infinitely many dashes.\n\
2945 Decimal digits after the % specify field width to which to pad.");
2948 DEFVAR_LISP_NOPRO ("default-major-mode", &buffer_defaults
.major_mode
,
2949 "*Major mode for new buffers. Defaults to `fundamental-mode'.\n\
2950 nil here means use current buffer's major mode.");
2952 DEFVAR_PER_BUFFER ("major-mode", ¤t_buffer
->major_mode
,
2953 make_number (Lisp_Symbol
),
2954 "Symbol for current buffer's major mode.");
2956 DEFVAR_PER_BUFFER ("mode-name", ¤t_buffer
->mode_name
,
2957 make_number (Lisp_String
),
2958 "Pretty name of current buffer's major mode (a string).");
2960 DEFVAR_PER_BUFFER ("abbrev-mode", ¤t_buffer
->abbrev_mode
, Qnil
,
2961 "Non-nil turns on automatic expansion of abbrevs as they are inserted.\n\
2962 Automatically becomes buffer-local when set in any fashion.");
2964 DEFVAR_PER_BUFFER ("case-fold-search", ¤t_buffer
->case_fold_search
,
2966 "*Non-nil if searches should ignore case.\n\
2967 Automatically becomes buffer-local when set in any fashion.");
2969 DEFVAR_PER_BUFFER ("fill-column", ¤t_buffer
->fill_column
,
2970 make_number (Lisp_Int
),
2971 "*Column beyond which automatic line-wrapping should happen.\n\
2972 Automatically becomes buffer-local when set in any fashion.");
2974 DEFVAR_PER_BUFFER ("left-margin", ¤t_buffer
->left_margin
,
2975 make_number (Lisp_Int
),
2976 "*Column for the default indent-line-function to indent to.\n\
2977 Linefeed indents to this column in Fundamental mode.\n\
2978 Automatically becomes buffer-local when set in any fashion.");
2980 DEFVAR_PER_BUFFER ("tab-width", ¤t_buffer
->tab_width
,
2981 make_number (Lisp_Int
),
2982 "*Distance between tab stops (for display of tab characters), in columns.\n\
2983 Automatically becomes buffer-local when set in any fashion.");
2985 DEFVAR_PER_BUFFER ("ctl-arrow", ¤t_buffer
->ctl_arrow
, Qnil
,
2986 "*Non-nil means display control chars with uparrow.\n\
2987 Nil means use backslash and octal digits.\n\
2988 Automatically becomes buffer-local when set in any fashion.\n\
2989 This variable does not apply to characters whose display is specified\n\
2990 in the current display table (if there is one).");
2992 DEFVAR_PER_BUFFER ("truncate-lines", ¤t_buffer
->truncate_lines
, Qnil
,
2993 "*Non-nil means do not display continuation lines;\n\
2994 give each line of text one screen line.\n\
2995 Automatically becomes buffer-local when set in any fashion.\n\
2997 Note that this is overridden by the variable\n\
2998 `truncate-partial-width-windows' if that variable is non-nil\n\
2999 and this buffer is not full-frame width.");
3002 DEFVAR_PER_BUFFER ("buffer-file-type", ¤t_buffer
->buffer_file_type
,
3004 "Non-nil if the visited file is a binary file.\n\
3005 This variable is meaningful on MS-DOG and Windows NT.\n\
3006 On those systems, it is automatically local in every buffer.\n\
3007 On other systems, this variable is normally always nil.");
3010 DEFVAR_PER_BUFFER ("default-directory", ¤t_buffer
->directory
,
3011 make_number (Lisp_String
),
3012 "Name of default directory of current buffer. Should end with slash.\n\
3013 Each buffer has its own value of this variable.");
3015 DEFVAR_PER_BUFFER ("auto-fill-function", ¤t_buffer
->auto_fill_function
,
3017 "Function called (if non-nil) to perform auto-fill.\n\
3018 It is called after self-inserting a space at a column beyond `fill-column'.\n\
3019 Each buffer has its own value of this variable.\n\
3020 NOTE: This variable is not an ordinary hook;\n\
3021 It may not be a list of functions.");
3023 DEFVAR_PER_BUFFER ("buffer-file-name", ¤t_buffer
->filename
,
3024 make_number (Lisp_String
),
3025 "Name of file visited in current buffer, or nil if not visiting a file.\n\
3026 Each buffer has its own value of this variable.");
3028 DEFVAR_PER_BUFFER ("buffer-file-truename", ¤t_buffer
->file_truename
,
3029 make_number (Lisp_String
),
3030 "Truename of file visited in current buffer, or nil if not visiting a file.\n\
3031 The truename of a file is calculated by `file-truename'.\n\
3032 Each buffer has its own value of this variable.");
3034 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
3035 ¤t_buffer
->auto_save_file_name
,
3036 make_number (Lisp_String
),
3037 "Name of file for auto-saving current buffer,\n\
3038 or nil if buffer should not be auto-saved.\n\
3039 Each buffer has its own value of this variable.");
3041 DEFVAR_PER_BUFFER ("buffer-read-only", ¤t_buffer
->read_only
, Qnil
,
3042 "Non-nil if this buffer is read-only.\n\
3043 Each buffer has its own value of this variable.");
3045 DEFVAR_PER_BUFFER ("buffer-backed-up", ¤t_buffer
->backed_up
, Qnil
,
3046 "Non-nil if this buffer's file has been backed up.\n\
3047 Backing up is done before the first time the file is saved.\n\
3048 Each buffer has its own value of this variable.");
3050 DEFVAR_PER_BUFFER ("buffer-saved-size", ¤t_buffer
->save_length
,
3051 make_number (Lisp_Int
),
3052 "Length of current buffer when last read in, saved or auto-saved.\n\
3054 Each buffer has its own value of this variable.");
3056 DEFVAR_PER_BUFFER ("selective-display", ¤t_buffer
->selective_display
,
3058 "Non-nil enables selective display:\n\
3059 Integer N as value means display only lines\n\
3060 that start with less than n columns of space.\n\
3061 A value of t means, after a ^M, all the rest of the line is invisible.\n\
3062 Then ^M's in the file are written into files as newlines.\n\n\
3063 Automatically becomes buffer-local when set in any fashion.");
3066 DEFVAR_PER_BUFFER ("selective-display-ellipses",
3067 ¤t_buffer
->selective_display_ellipses
,
3069 "t means display ... on previous line when a line is invisible.\n\
3070 Automatically becomes buffer-local when set in any fashion.");
3073 DEFVAR_PER_BUFFER ("overwrite-mode", ¤t_buffer
->overwrite_mode
, Qnil
,
3074 "Non-nil if self-insertion should replace existing text.\n\
3075 The value should be one of `overwrite-mode-textual',\n\
3076 `overwrite-mode-binary', or nil.\n\
3077 If it is `overwrite-mode-textual', self-insertion still\n\
3078 inserts at the end of a line, and inserts when point is before a tab,\n\
3079 until the tab is filled in.\n\
3080 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too.\n\
3081 Automatically becomes buffer-local when set in any fashion.");
3083 #if 0 /* The doc string is too long for some compilers,
3084 but make-docfile can find it in this comment. */
3085 DEFVAR_PER_BUFFER ("buffer-display-table", ¤t_buffer
->display_table
,
3087 "Display table that controls display of the contents of current buffer.\n\
3088 Automatically becomes buffer-local when set in any fashion.\n\
3089 The display table is a vector created with `make-display-table'.\n\
3090 The first 256 elements control how to display each possible text character.\n\
3091 Each value should be a vector of characters or nil;\n\
3092 nil means display the character in the default fashion.\n\
3093 The remaining six elements control the display of\n\
3094 the end of a truncated screen line (element 256, a single character);\n\
3095 the end of a continued line (element 257, a single character);\n\
3096 the escape character used to display character codes in octal\n\
3097 (element 258, a single character);\n\
3098 the character used as an arrow for control characters (element 259,\n\
3099 a single character);\n\
3100 the decoration indicating the presence of invisible lines (element 260,\n\
3101 a vector of characters);\n\
3102 the character used to draw the border between side-by-side windows\n\
3103 (element 261, a single character).\n\
3104 If this variable is nil, the value of `standard-display-table' is used.\n\
3105 Each window can have its own, overriding display table.");
3107 DEFVAR_PER_BUFFER ("buffer-display-table", ¤t_buffer
->display_table
,
3110 /*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
3113 DEFVAR_LISP ("before-change-function", &Vbefore_change_function
,
3114 "Function to call before each text change.\n\
3115 Two arguments are passed to the function: the positions of\n\
3116 the beginning and end of the range of old text to be changed.\n\
3117 \(For an insertion, the beginning and end are at the same place.)\n\
3118 No information is given about the length of the text after the change.\n\
3120 Buffer changes made while executing the `before-change-function'\n\
3121 don't call any before-change or after-change functions.\n\
3122 That's because these variables are temporarily set to nil.\n\
3123 As a result, a hook function cannot straightforwardly alter the value of\n\
3124 these variables. See the Emacs Lisp manual for a way of\n\
3125 accomplishing an equivalent result by using other variables.");
3126 Vbefore_change_function
= Qnil
;
3128 DEFVAR_LISP ("after-change-function", &Vafter_change_function
,
3129 "Function to call after each text change.\n\
3130 Three arguments are passed to the function: the positions of\n\
3131 the beginning and end of the range of changed text,\n\
3132 and the length of the pre-change text replaced by that range.\n\
3133 \(For an insertion, the pre-change length is zero;\n\
3134 for a deletion, that length is the number of characters deleted,\n\
3135 and the post-change beginning and end are at the same place.)\n\
3137 Buffer changes made while executing the `after-change-function'\n\
3138 don't call any before-change or after-change functions.\n\
3139 That's because these variables are temporarily set to nil.\n\
3140 As a result, a hook function cannot straightforwardly alter the value of\n\
3141 these variables. See the Emacs Lisp manual for a way of\n\
3142 accomplishing an equivalent result by using other variables.");
3143 Vafter_change_function
= Qnil
;
3145 DEFVAR_LISP ("before-change-functions", &Vbefore_change_functions
,
3146 "List of functions to call before each text change.\n\
3147 Two arguments are passed to each function: the positions of\n\
3148 the beginning and end of the range of old text to be changed.\n\
3149 \(For an insertion, the beginning and end are at the same place.)\n\
3150 No information is given about the length of the text after the change.\n\
3152 Buffer changes made while executing the `before-change-functions'\n\
3153 don't call any before-change or after-change functions.\n\
3154 That's because these variables are temporarily set to nil.\n\
3155 As a result, a hook function cannot straightforwardly alter the value of\n\
3156 these variables. See the Emacs Lisp manual for a way of\n\
3157 accomplishing an equivalent result by using other variables.");
3158 Vbefore_change_functions
= Qnil
;
3160 DEFVAR_LISP ("after-change-functions", &Vafter_change_functions
,
3161 "List of function to call after each text change.\n\
3162 Three arguments are passed to each function: the positions of\n\
3163 the beginning and end of the range of changed text,\n\
3164 and the length of the pre-change text replaced by that range.\n\
3165 \(For an insertion, the pre-change length is zero;\n\
3166 for a deletion, that length is the number of characters deleted,\n\
3167 and the post-change beginning and end are at the same place.)\n\
3169 Buffer changes made while executing the `after-change-functions'\n\
3170 don't call any before-change or after-change functions.\n\
3171 That's because these variables are temporarily set to nil.\n\
3172 As a result, a hook function cannot straightforwardly alter the value of\n\
3173 these variables. See the Emacs Lisp manual for a way of\n\
3174 accomplishing an equivalent result by using other variables.");
3176 Vafter_change_functions
= Qnil
;
3178 DEFVAR_LISP ("first-change-hook", &Vfirst_change_hook
,
3179 "A list of functions to call before changing a buffer which is unmodified.\n\
3180 The functions are run using the `run-hooks' function.");
3181 Vfirst_change_hook
= Qnil
;
3182 Qfirst_change_hook
= intern ("first-change-hook");
3183 staticpro (&Qfirst_change_hook
);
3185 #if 0 /* The doc string is too long for some compilers,
3186 but make-docfile can find it in this comment. */
3187 DEFVAR_PER_BUFFER ("buffer-undo-list", ¤t_buffer
->undo_list
, Qnil
,
3188 "List of undo entries in current buffer.\n\
3189 Recent changes come first; older changes follow newer.\n\
3191 An entry (START . END) represents an insertion which begins at\n\
3192 position START and ends at position END.\n\
3194 An entry (TEXT . POSITION) represents the deletion of the string TEXT\n\
3195 from (abs POSITION). If POSITION is positive, point was at the front\n\
3196 of the text being deleted; if negative, point was at the end.\n\
3198 An entry (t HIGH . LOW) indicates that the buffer previously had\n\
3199 \"unmodified\" status. HIGH and LOW are the high and low 16-bit portions\n\
3200 of the visited file's modification time, as of that time. If the\n\
3201 modification time of the most recent save is different, this entry is\n\
3204 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property\n\
3205 was modified between BEG and END. PROPERTY is the property name,\n\
3206 and VALUE is the old value.\n\
3208 An entry of the form POSITION indicates that point was at the buffer\n\
3209 location given by the integer. Undoing an entry of this form places\n\
3210 point at POSITION.\n\
3212 nil marks undo boundaries. The undo command treats the changes\n\
3213 between two undo boundaries as a single step to be undone.\n\
3215 If the value of the variable is t, undo information is not recorded.");
3217 DEFVAR_PER_BUFFER ("buffer-undo-list", ¤t_buffer
->undo_list
, Qnil
,
3220 DEFVAR_PER_BUFFER ("mark-active", ¤t_buffer
->mark_active
, Qnil
,
3221 "Non-nil means the mark and region are currently active in this buffer.\n\
3222 Automatically local in all buffers.");
3224 DEFVAR_PER_BUFFER ("cache-long-line-scans", ¤t_buffer
->cache_long_line_scans
, Qnil
,
3225 "Non-nil means that Emacs should use caches to handle long lines more quickly.\n\
3226 This variable is buffer-local, in all buffers.\n\
3228 Normally, the line-motion functions work by scanning the buffer for\n\
3229 newlines. Columnar operations (like move-to-column and\n\
3230 compute-motion) also work by scanning the buffer, summing character\n\
3231 widths as they go. This works well for ordinary text, but if the\n\
3232 buffer's lines are very long (say, more than 500 characters), these\n\
3233 motion functions will take longer to execute. Emacs may also take\n\
3234 longer to update the display.\n\
3236 If cache-long-line-scans is non-nil, these motion functions cache the\n\
3237 results of their scans, and consult the cache to avoid rescanning\n\
3238 regions of the buffer until the text is modified. The caches are most\n\
3239 beneficial when they prevent the most searching---that is, when the\n\
3240 buffer contains long lines and large regions of characters with the\n\
3241 same, fixed screen width.\n\
3243 When cache-long-line-scans is non-nil, processing short lines will\n\
3244 become slightly slower (because of the overhead of consulting the\n\
3245 cache), and the caches will use memory roughly proportional to the\n\
3246 number of newlines and characters whose screen width varies.\n\
3248 The caches require no explicit maintenance; their accuracy is\n\
3249 maintained internally by the Emacs primitives. Enabling or disabling\n\
3250 the cache should not affect the behavior of any of the motion\n\
3251 functions; it should only affect their performance.");
3253 DEFVAR_PER_BUFFER ("point-before-scroll", ¤t_buffer
->point_before_scroll
, Qnil
,
3254 "Value of point before the last series of scroll operations, or nil.");
3256 DEFVAR_PER_BUFFER ("buffer-file-format", ¤t_buffer
->file_format
, Qnil
,
3257 "List of formats to use when saving this buffer.\n\
3258 Formats are defined by `format-alist'. This variable is\n\
3259 set when a file is visited. Automatically local in all buffers.");
3261 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
3262 ¤t_buffer
->invisibility_spec
, Qnil
,
3263 "Invisibility spec of this buffer.\n\
3264 The default is t, which means that text is invisible\n\
3265 if it has a non-nil `invisible' property.\n\
3266 If the value is a list, a text character is invisible if its `invisible'\n\
3267 property is an element in that list.\n\
3268 If an element is a cons cell of the for (PROP . ELLIPSIS),\n\
3269 then characters with property value PROP is invisible,\n\
3270 and they have an ellipsis as well if ELLIPSIS is non-nil.");
3272 DEFVAR_LISP ("transient-mark-mode", &Vtransient_mark_mode
,
3273 "*Non-nil means deactivate the mark when the buffer contents change.");
3274 Vtransient_mark_mode
= Qnil
;
3276 DEFVAR_LISP ("inhibit-read-only", &Vinhibit_read_only
,
3277 "*Non-nil means disregard read-only status of buffers or characters.\n\
3278 If the value is t, disregard `buffer-read-only' and all `read-only'\n\
3279 text properties. If the value is a list, disregard `buffer-read-only'\n\
3280 and disregard a `read-only' text property if the property value\n\
3281 is a member of the list.");
3282 Vinhibit_read_only
= Qnil
;
3284 DEFVAR_LISP ("kill-buffer-query-functions", &Vkill_buffer_query_functions
,
3285 "List of functions called with no args to query before killing a buffer.");
3286 Vkill_buffer_query_functions
= Qnil
;
3288 defsubr (&Sbuffer_list
);
3289 defsubr (&Sget_buffer
);
3290 defsubr (&Sget_file_buffer
);
3291 defsubr (&Sget_buffer_create
);
3292 defsubr (&Smake_indirect_buffer
);
3293 defsubr (&Sgenerate_new_buffer_name
);
3294 defsubr (&Sbuffer_name
);
3295 /*defsubr (&Sbuffer_number);*/
3296 defsubr (&Sbuffer_file_name
);
3297 defsubr (&Sbuffer_base_buffer
);
3298 defsubr (&Sbuffer_local_variables
);
3299 defsubr (&Sbuffer_modified_p
);
3300 defsubr (&Sset_buffer_modified_p
);
3301 defsubr (&Sbuffer_modified_tick
);
3302 defsubr (&Srename_buffer
);
3303 defsubr (&Sother_buffer
);
3304 defsubr (&Sbuffer_disable_undo
);
3305 defsubr (&Sbuffer_enable_undo
);
3306 defsubr (&Skill_buffer
);
3307 defsubr (&Serase_buffer
);
3308 defsubr (&Sset_buffer_major_mode
);
3309 defsubr (&Sswitch_to_buffer
);
3310 defsubr (&Spop_to_buffer
);
3311 defsubr (&Scurrent_buffer
);
3312 defsubr (&Sset_buffer
);
3313 defsubr (&Sbarf_if_buffer_read_only
);
3314 defsubr (&Sbury_buffer
);
3315 defsubr (&Skill_all_local_variables
);
3317 defsubr (&Soverlayp
);
3318 defsubr (&Smake_overlay
);
3319 defsubr (&Sdelete_overlay
);
3320 defsubr (&Smove_overlay
);
3321 defsubr (&Soverlay_start
);
3322 defsubr (&Soverlay_end
);
3323 defsubr (&Soverlay_buffer
);
3324 defsubr (&Soverlay_properties
);
3325 defsubr (&Soverlays_at
);
3326 defsubr (&Snext_overlay_change
);
3327 defsubr (&Sprevious_overlay_change
);
3328 defsubr (&Soverlay_recenter
);
3329 defsubr (&Soverlay_lists
);
3330 defsubr (&Soverlay_get
);
3331 defsubr (&Soverlay_put
);
3336 initial_define_key (control_x_map
, 'b', "switch-to-buffer");
3337 initial_define_key (control_x_map
, 'k', "kill-buffer");
3339 /* This must not be in syms_of_buffer, because Qdisabled is not
3340 initialized when that function gets called. */
3341 Fput (intern ("erase-buffer"), Qdisabled
, Qt
);