1 /* Buffer manipulation primitives for XEmacs.
2 Copyright (C) 1985-1989, 1992-1995 Free Software Foundation, Inc.
3 Copyright (C) 1995 Sun Microsystems, Inc.
4 Copyright (C) 1995, 1996 Ben Wing.
6 This file is part of XEmacs.
8 XEmacs is free software; you can redistribute it and/or modify it
9 under the terms of the GNU General Public License as published by the
10 Free Software Foundation; either version 2, or (at your option) any
13 XEmacs is distributed in the hope that it will be useful, but WITHOUT
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 You should have received a copy of the GNU General Public License
19 along with XEmacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
23 /* Synched up with: Mule 2.0, FSF 19.30. */
28 JWZ: some changes for Lemacs, long ago. (e.g. separate buffer
30 Mly: a few changes for buffer-local vars, 19.8 or 19.9.
31 Ben Wing: some changes and cleanups for Mule, 19.12.
34 /* This file contains functions that work with buffer objects.
35 Functions that manipulate a buffer's text, however, are not
38 1) The low-level functions that actually know about the
39 implementation of a buffer's text are located in insdel.c.
40 2) The higher-level (mostly Lisp) functions that manipulate a
41 buffer's text are in editfns.c.
42 3) The highest-level Lisp commands are in cmds.c.
46 -- Functions that know about syntax tables (forward-word,
47 scan-sexps, etc.) are in syntax.c, as are functions
48 that manipulate syntax tables.
49 -- Functions that know about case tables (upcase, downcase,
50 etc.) are in casefiddle.c. Functions that manipulate
51 case tables (case-table-p, set-case-table, etc.) are
53 -- Functions that do searching and replacing are in
54 search.c. The low-level functions that implement
55 regular expressions are in regex.c.
59 -- Some file and process functions (in fileio.c and process.c)
60 copy text from or insert text into a buffer; they call
61 low-level functions in insdel.c to do this.
62 -- insdel.c calls low-level functions in undo.c and extents.c
63 to record buffer modifications for undoing and to handle
64 extent adjustment and extent-data creation and insertion.
78 #include "file-coding.h"
83 #include "process.h" /* for kill_buffer_processes */
84 #ifdef REGION_CACHE_NEEDS_WORK
85 #include "region-cache.h"
87 #include "specifier.h"
89 #include "sysdep.h" /* for getwd */
94 struct buffer *current_buffer; /* the current buffer */
96 /* This structure holds the default values of the buffer-local variables
97 defined with DEFVAR_BUFFER_LOCAL, that have special slots in each buffer.
98 The default value occupies the same slot in this structure
99 as an individual buffer's value occupies in that buffer.
100 Setting the default value also goes through the alist of buffers
101 and stores into each buffer that does not say it has a local value. */
102 Lisp_Object Vbuffer_defaults;
103 static void *buffer_defaults_saved_slots;
105 /* This structure marks which slots in a buffer have corresponding
106 default values in Vbuffer_defaults.
107 Each such slot has a nonzero value in this structure.
108 The value has only one nonzero bit.
110 When a buffer has its own local value for a slot,
111 the bit for that slot (found in the same slot in this structure)
112 is turned on in the buffer's local_var_flags slot.
114 If a slot in this structure is 0, then there is a DEFVAR_BUFFER_LOCAL
115 for the slot, but there is no default value for it; the corresponding
116 slot in Vbuffer_defaults is not used except to initialize newly-created
119 If a slot is -1, then there is a DEFVAR_BUFFER_LOCAL for it
120 as well as a default value which is used to initialize newly-created
121 buffers and as a reset-value when local-vars are killed.
123 If a slot is -2, there is no DEFVAR_BUFFER_LOCAL for it.
124 (The slot is always local, but there's no lisp variable for it.)
125 The default value is only used to initialize newly-creation buffers.
127 If a slot is -3, then there is no DEFVAR_BUFFER_LOCAL for it but
128 there is a default which is used to initialize newly-creation
129 buffers and as a reset-value when local-vars are killed. */
130 struct buffer buffer_local_flags;
132 /* This is the initial (startup) directory, as used for the *scratch* buffer.
133 We're making this a global to make others aware of the startup directory.
134 `initial_directory' is stored in external format.
136 char initial_directory[MAXPATHLEN+1];
138 /* This structure holds the names of symbols whose values may be
139 buffer-local. It is indexed and accessed in the same way as the above. */
140 static Lisp_Object Vbuffer_local_symbols;
141 static void *buffer_local_symbols_saved_slots;
143 /* Alist of all buffer names vs the buffers. */
144 /* This used to be a variable, but is no longer,
145 to prevent lossage due to user rplac'ing this alist or its elements.
146 Note that there is a per-frame copy of this as well; the frame slot
147 and the global variable contain the same data, but possibly in different
148 orders, so that the buffer ordering can be per-frame.
150 Lisp_Object Vbuffer_alist;
152 /* Functions to call before and after each text change. */
153 Lisp_Object Qbefore_change_functions;
154 Lisp_Object Qafter_change_functions;
155 Lisp_Object Vbefore_change_functions;
156 Lisp_Object Vafter_change_functions;
158 /* #### Obsolete, for compatibility */
159 Lisp_Object Qbefore_change_function;
160 Lisp_Object Qafter_change_function;
161 Lisp_Object Vbefore_change_function;
162 Lisp_Object Vafter_change_function;
165 Lisp_Object Vtransient_mark_mode;
168 /* t means ignore all read-only text properties.
169 A list means ignore such a property if its value is a member of the list.
170 Any non-nil value means ignore buffer-read-only. */
171 Lisp_Object Vinhibit_read_only;
173 /* List of functions to call that can query about killing a buffer.
174 If any of these functions returns nil, we don't kill it. */
175 Lisp_Object Vkill_buffer_query_functions;
177 /* Non-nil means delete a buffer's auto-save file when the buffer is saved. */
178 int delete_auto_save_files;
180 Lisp_Object Qbuffer_live_p;
181 Lisp_Object Qbuffer_or_string_p;
183 /* List of functions to call before changing an unmodified buffer. */
184 Lisp_Object Vfirst_change_hook;
185 Lisp_Object Qfirst_change_hook;
187 Lisp_Object Qfundamental_mode;
188 Lisp_Object Qmode_class;
189 Lisp_Object Qpermanent_local;
191 Lisp_Object Qprotected_field;
193 Lisp_Object QSFundamental; /* A string "Fundamental" */
194 Lisp_Object QSscratch; /* "*scratch*" */
195 Lisp_Object Qdefault_directory;
197 Lisp_Object Qkill_buffer_hook;
198 Lisp_Object Qrecord_buffer_hook;
200 Lisp_Object Qrename_auto_save_file;
202 Lisp_Object Qget_file_buffer;
203 Lisp_Object Qchange_major_mode_hook, Vchange_major_mode_hook;
205 Lisp_Object Qfind_file_compare_truenames;
207 Lisp_Object Qswitch_to_buffer;
209 /* Two thresholds controlling how much undo information to keep. */
211 int undo_high_threshold;
213 int find_file_compare_truenames;
214 int find_file_use_truenames;
217 static void reset_buffer_local_variables (struct buffer *, int first_time);
218 static void nuke_all_buffer_slots (struct buffer *b, Lisp_Object zap);
221 make_buffer (struct buffer *buf)
224 XSETBUFFER (obj, buf);
229 mark_buffer (Lisp_Object obj)
231 struct buffer *buf = XBUFFER (obj);
233 /* Truncate undo information. */
234 buf->undo_list = truncate_undo_list (buf->undo_list,
236 undo_high_threshold);
238 #define MARKED_SLOT(x) mark_object (buf->x)
239 #include "bufslots.h"
242 mark_object (buf->extent_info);
244 mark_object (buf->text->line_number_cache);
246 /* Don't mark normally through the children slot.
247 (Actually, in this case, it doesn't matter.) */
248 if (! EQ (buf->indirect_children, Qnull_pointer))
249 mark_conses_in_list (buf->indirect_children);
251 return buf->base_buffer ? make_buffer (buf->base_buffer) : Qnil;
255 print_buffer (Lisp_Object obj, Lisp_Object printcharfun, int escapeflag)
257 struct buffer *b = XBUFFER (obj);
261 if (!BUFFER_LIVE_P (b))
262 error ("printing unreadable object #<killed buffer>");
264 error ("printing unreadable object #<buffer %s>",
265 XSTRING_DATA (b->name));
267 else if (!BUFFER_LIVE_P (b))
268 write_c_string ("#<killed buffer>", printcharfun);
271 write_c_string ("#<buffer ", printcharfun);
272 print_internal (b->name, printcharfun, 1);
273 write_c_string (">", printcharfun);
277 print_internal (b->name, printcharfun, 0);
281 /* We do not need a finalize method to handle a buffer's children list
282 because all buffers have `kill-buffer' applied to them before
283 they disappear, and the children removal happens then. */
284 DEFINE_LRECORD_IMPLEMENTATION ("buffer", buffer,
285 mark_buffer, print_buffer, 0, 0, 0, 0,
288 DEFUN ("bufferp", Fbufferp, 1, 1, 0, /*
289 Return t if OBJECT is an editor buffer.
293 return BUFFERP (object) ? Qt : Qnil;
296 DEFUN ("buffer-live-p", Fbuffer_live_p, 1, 1, 0, /*
297 Return t if OBJECT is an editor buffer that has not been deleted.
301 return BUFFERP (object) && BUFFER_LIVE_P (XBUFFER (object)) ? Qt : Qnil;
305 nsberror (Lisp_Object spec)
308 error ("No buffer named %s", XSTRING_DATA (spec));
309 signal_simple_error ("Invalid buffer argument", spec);
312 DEFUN ("buffer-list", Fbuffer_list, 0, 1, 0, /*
313 Return a list of all existing live buffers.
314 The order is specific to the selected frame; if the optional FRAME
315 argument is provided, the ordering for that frame is returned instead.
316 If the FRAME argument is t, then the global (non-frame) ordering is
321 return Fmapcar (Qcdr,
322 EQ (frame, Qt) ? Vbuffer_alist :
323 decode_frame (frame)->buffer_alist);
327 get_buffer (Lisp_Object name, int error_if_deleted_or_does_not_exist)
331 if (!BUFFER_LIVE_P (XBUFFER (name)))
333 if (error_if_deleted_or_does_not_exist)
345 name = LISP_GETTEXT (name); /* I18N3 */
347 buf = Fcdr (Fassoc (name, Vbuffer_alist));
349 if (NILP (buf) && error_if_deleted_or_does_not_exist)
356 decode_buffer (Lisp_Object buffer, int allow_string)
359 return current_buffer;
361 if (allow_string && STRINGP (buffer))
362 return XBUFFER (get_buffer (buffer, 1));
364 CHECK_LIVE_BUFFER (buffer);
365 return XBUFFER (buffer);
368 DEFUN ("decode-buffer", Fdecode_buffer, 1, 1, 0, /*
369 Validate BUFFER or if BUFFER is nil, return the current buffer.
370 If BUFFER is a valid buffer or a string representing a valid buffer,
371 the corresponding buffer object will be returned. Otherwise an error
376 struct buffer *b = decode_buffer (buffer, 1);
377 XSETBUFFER (buffer, b);
383 /* Like Fassoc, but use Fstring_equal to compare
384 (which ignores text properties),
385 and don't ever QUIT. */
388 assoc_ignore_text_properties (REGISTER Lisp_Object key, Lisp_Object list)
390 REGISTER Lisp_Object tail;
391 for (tail = list; !NILP (tail); tail = Fcdr (tail))
393 REGISTER Lisp_Object elt, tem;
395 tem = Fstring_equal (Fcar (elt), key);
404 DEFUN ("get-buffer", Fget_buffer, 1, 1, 0, /*
405 Return the buffer named NAME (a string).
406 If there is no live buffer named NAME, return nil.
407 NAME may also be a buffer; if so, the value is that buffer.
412 /* #### Doc string should indicate that the buffer name will get
416 /* #### This might return a dead buffer. This is gross. This is
417 called FSF compatibility. */
420 return get_buffer (name, 0);
421 /* FSFmacs 19.29 calls assoc_ignore_text_properties() here.
426 DEFUN ("get-file-buffer", Fget_file_buffer, 1, 1, 0, /*
427 Return the buffer visiting file FILENAME (a string).
428 The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.
429 If there is no such live buffer, return nil.
431 Normally, the comparison is done by canonicalizing FILENAME (using
432 `expand-file-name') and comparing that to the value of `buffer-file-name'
433 for each existing buffer. However, If `find-file-compare-truenames' is
434 non-nil, FILENAME will be converted to its truename and the search will be
435 done on each buffer's value of `buffer-file-truename' instead of
436 `buffer-file-name'. Otherwise, if `find-file-use-truenames' is non-nil,
437 FILENAME will be converted to its truename and used for searching, but
438 the search will still be done on `buffer-file-name'.
442 /* This function can GC. GC checked 1997.04.06. */
443 REGISTER Lisp_Object buf;
447 /* DO NOT translate the filename. */
450 CHECK_STRING (filename);
451 filename = Fexpand_file_name (filename, Qnil);
453 /* If the file name has special constructs in it,
454 call the corresponding file handler. */
455 Lisp_Object handler = Ffind_file_name_handler (filename, Qget_file_buffer);
459 return call2 (handler, Qget_file_buffer, filename);
464 if (find_file_compare_truenames || find_file_use_truenames)
466 struct gcpro ngcpro1, ngcpro2, ngcpro3;
467 Lisp_Object fn = Qnil;
468 Lisp_Object dn = Qnil;
470 NGCPRO3 (fn, dn, filename);
471 fn = Ffile_truename (filename, Qnil);
474 dn = Ffile_name_directory (filename);
475 fn = Ffile_truename (dn, Qnil);
476 if (! NILP (fn)) dn = fn;
477 fn = Fexpand_file_name (Ffile_name_nondirectory (filename),
486 LIST_LOOP_2 (elt, Vbuffer_alist)
489 if (!BUFFERP (buf)) continue;
490 if (!STRINGP (XBUFFER (buf)->filename)) continue;
491 if (!NILP (Fstring_equal (filename,
492 (find_file_compare_truenames
493 ? XBUFFER (buf)->file_truename
494 : XBUFFER (buf)->filename))))
503 push_buffer_alist (Lisp_Object name, Lisp_Object buf)
505 Lisp_Object cons = Fcons (name, buf);
506 Lisp_Object frmcons, devcons, concons;
508 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (cons, Qnil));
509 FRAME_LOOP_NO_BREAK (frmcons, devcons, concons)
512 f = XFRAME (XCAR (frmcons));
513 f->buffer_alist = nconc2 (f->buffer_alist, Fcons (cons, Qnil));
518 delete_from_buffer_alist (Lisp_Object buf)
520 Lisp_Object cons = Frassq (buf, Vbuffer_alist);
521 Lisp_Object frmcons, devcons, concons;
523 return; /* abort() ? */
524 Vbuffer_alist = delq_no_quit (cons, Vbuffer_alist);
526 FRAME_LOOP_NO_BREAK (frmcons, devcons, concons)
529 f = XFRAME (XCAR (frmcons));
530 f->buffer_alist = delq_no_quit (cons, f->buffer_alist);
535 get_truename_buffer (REGISTER Lisp_Object filename)
537 /* FSFmacs has its own code here and doesn't call get-file-buffer.
538 That's because their equivalent of find-file-compare-truenames
539 (find-file-existing-other-name) isn't looked at in get-file-buffer.
540 This way is more correct. */
541 int count = specpdl_depth ();
543 specbind (Qfind_file_compare_truenames, Qt);
544 return unbind_to (count, Fget_file_buffer (filename));
547 static struct buffer *
548 allocate_buffer (void)
550 struct buffer *b = alloc_lcrecord_type (struct buffer, &lrecord_buffer);
552 copy_lcrecord (b, XBUFFER (Vbuffer_defaults));
558 finish_init_buffer (struct buffer *b, Lisp_Object name)
564 name = Fcopy_sequence (name);
565 /* #### This really does not need to be called. We already
566 initialized the buffer-local variables in allocate_buffer().
567 local_var_alist is set to Qnil at the same point, in
568 nuke_all_buffer_slots(). */
569 reset_buffer_local_variables (b, 1);
570 b->directory = current_buffer ? current_buffer->directory : Qnil;
572 b->last_window_start = 1;
575 if (string_byte (XSTRING (name), 0) != ' ')
580 /* initialize the extent list */
581 init_buffer_extents (b);
583 /* Put this in the alist of all live buffers. */
584 push_buffer_alist (name, buf);
586 init_buffer_markers (b);
588 b->generated_modeline_string = Fmake_string (make_int (84), make_int (' '));
589 b->modeline_extent_table = make_lisp_hash_table (20, HASH_TABLE_KEY_WEAK,
595 DEFUN ("get-buffer-create", Fget_buffer_create, 1, 1, 0, /*
596 Return the buffer named NAME, or create such a buffer and return it.
597 A new buffer is created if there is no live buffer named NAME.
598 If NAME starts with a space, the new buffer does not keep undo information.
599 If NAME is a buffer instead of a string, then it is the value returned.
600 The value is never nil.
604 /* This function can GC */
606 REGISTER struct buffer *b;
609 /* #### Doc string should indicate that the buffer name will get
613 name = LISP_GETTEXT (name);
614 buf = Fget_buffer (name);
618 if (XSTRING_LENGTH (name) == 0)
619 error ("Empty string for buffer name is not allowed");
621 b = allocate_buffer ();
623 b->text = &b->own_text;
625 b->indirect_children = Qnil;
626 init_buffer_text (b);
628 return finish_init_buffer (b, name);
631 DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, 2, 2,
632 "bMake indirect buffer (to buffer): \nBName of indirect buffer: ", /*
633 Create and return an indirect buffer for buffer BASE, named NAME.
634 BASE should be an existing buffer (or buffer name).
635 NAME should be a string which is not the name of an existing buffer.
636 If BASE is an indirect buffer itself, the base buffer for that buffer
637 is made the base buffer for the newly created buffer. (Thus, there will
638 never be indirect buffers whose base buffers are themselves indirect.)
642 /* This function can GC */
644 /* #### The above interactive specification is totally bogus,
645 because it offers an existing buffer as default answer to the
646 second question. However, the second argument may not BE an
650 base_buffer = get_buffer (base_buffer, 1);
653 /* #### Doc string should indicate that the buffer name will get
657 name = LISP_GETTEXT (name);
658 if (!NILP (Fget_buffer (name)))
659 signal_simple_error ("Buffer name already in use", name);
660 if (XSTRING_LENGTH (name) == 0)
661 error ("Empty string for buffer name is not allowed");
663 b = allocate_buffer ();
665 b->base_buffer = BUFFER_BASE_BUFFER (XBUFFER (base_buffer));
667 /* Use the base buffer's text object. */
668 b->text = b->base_buffer->text;
669 b->indirect_children = Qnil;
670 b->base_buffer->indirect_children =
671 Fcons (make_buffer (b), b->base_buffer->indirect_children);
672 init_buffer_text (b);
674 return finish_init_buffer (b, name);
680 reset_buffer_local_variables (struct buffer *b, int first_time)
682 struct buffer *def = XBUFFER (Vbuffer_defaults);
684 b->local_var_flags = 0;
685 /* For each slot that has a default value,
686 copy that into the slot. */
687 #define MARKED_SLOT(slot) \
688 { int mask = XINT (buffer_local_flags.slot); \
689 if ((mask > 0 || mask == -1 || mask == -3) \
691 || NILP (Fget (XBUFFER (Vbuffer_local_symbols)->slot, \
692 Qpermanent_local, Qnil)))) \
693 b->slot = def->slot; \
695 #include "bufslots.h"
698 #define STRING256_P(obj) \
699 (STRINGP (obj) && XSTRING_CHAR_LENGTH (obj) == 256)
700 /* If the standard case table has been altered and invalidated,
701 fix up its insides first. */
702 if (!(STRING256_P(Vascii_upcase_table) &&
703 STRING256_P(Vascii_canon_table) &&
704 STRING256_P(Vascii_eqv_table)))
706 Fset_standard_case_table (Vascii_downcase_table);
708 b->downcase_table = Vascii_downcase_table;
709 b->upcase_table = Vascii_upcase_table;
710 b->case_canon_table = Vascii_canon_table;
711 b->case_eqv_table = Vascii_eqv_table;
713 b->mirror_downcase_table = Vmirror_ascii_downcase_table;
714 b->mirror_upcase_table = Vmirror_ascii_upcase_table;
715 b->mirror_case_canon_table = Vmirror_ascii_canon_table;
716 b->mirror_case_eqv_table = Vmirror_ascii_eqv_table;
722 /* We split this away from generate-new-buffer, because rename-buffer
723 and set-visited-file-name ought to be able to use this to really
724 rename the buffer properly. */
726 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name, 1, 2, 0, /*
727 Return a string that is the name of no existing buffer based on NAME.
728 If there is no live buffer named NAME, then return NAME.
729 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
730 until an unused name is found, and then return that name.
731 Optional second argument IGNORE specifies a name that is okay to use
732 \(if it is in the sequence to be tried)
733 even if a buffer with that name exists.
737 REGISTER Lisp_Object gentemp, tem;
743 name = LISP_GETTEXT (name);
745 /* #### Doc string should indicate that the buffer name will get
749 tem = Fget_buffer (name);
756 sprintf (number, "<%d>", ++count);
757 gentemp = concat2 (name, build_string (number));
760 tem = Fstring_equal (gentemp, ignore);
764 tem = Fget_buffer (gentemp);
771 DEFUN ("buffer-name", Fbuffer_name, 0, 1, 0, /*
772 Return the name of BUFFER, as a string.
773 With no argument or nil as argument, return the name of the current buffer.
777 /* For compatibility, we allow a dead buffer here.
778 Earlier versions of Emacs didn't provide buffer-live-p. */
780 return current_buffer->name;
781 CHECK_BUFFER (buffer);
782 return XBUFFER (buffer)->name;
785 DEFUN ("buffer-file-name", Fbuffer_file_name, 0, 1, 0, /*
786 Return name of file BUFFER is visiting, or nil if none.
787 No argument or nil as argument means use the current buffer.
791 /* For compatibility, we allow a dead buffer here. Yuck! */
793 return current_buffer->filename;
794 CHECK_BUFFER (buffer);
795 return XBUFFER (buffer)->filename;
798 DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, 0, 1, 0, /*
799 Return the base buffer of indirect buffer BUFFER.
800 If BUFFER is not indirect, return nil.
804 struct buffer *buf = decode_buffer (buffer, 0);
806 return buf->base_buffer ? make_buffer (buf->base_buffer) : Qnil;
809 DEFUN ("buffer-indirect-children", Fbuffer_indirect_children, 0, 1, 0, /*
810 Return a list of all indirect buffers whose base buffer is BUFFER.
811 If BUFFER is indirect, the return value will always be nil; see
812 `make-indirect-buffer'.
816 struct buffer *buf = decode_buffer (buffer, 0);
818 return Fcopy_sequence (buf->indirect_children);
821 DEFUN ("buffer-local-variables", Fbuffer_local_variables, 0, 1, 0, /*
822 Return an alist of variables that are buffer-local in BUFFER.
823 Most elements look like (SYMBOL . VALUE), describing one variable.
824 For a symbol that is locally unbound, just the symbol appears in the value.
825 Note that storing new VALUEs in these elements doesn't change the variables.
826 No argument or nil as argument means use current buffer as BUFFER.
830 struct buffer *buf = decode_buffer (buffer, 0);
831 Lisp_Object result = Qnil;
835 for (tail = buf->local_var_alist; CONSP (tail); tail = XCDR (tail))
837 Lisp_Object elt = XCAR (tail);
838 /* Reference each variable in the alist in buf.
839 If inquiring about the current buffer, this gets the current values,
840 so store them into the alist so the alist is up to date.
841 If inquiring about some other buffer, this swaps out any values
842 for that buffer, making the alist up to date automatically. */
843 Lisp_Object val = find_symbol_value (XCAR (elt));
844 /* Use the current buffer value only if buf is the current buffer. */
845 if (buf != current_buffer)
848 /* If symbol is unbound, put just the symbol in the list. */
850 result = Fcons (XCAR (elt), result);
851 /* Otherwise, put (symbol . value) in the list. */
853 result = Fcons (Fcons (XCAR (elt), val), result);
857 /* Add on all the variables stored in special slots. */
859 struct buffer *syms = XBUFFER (Vbuffer_local_symbols);
860 #define MARKED_SLOT(slot) \
861 { int mask = XINT (buffer_local_flags.slot); \
862 if (mask == 0 || mask == -1 \
863 || ((mask > 0) && (buf->local_var_flags & mask))) \
864 result = Fcons (Fcons (syms->slot, buf->slot), result); \
866 #include "bufslots.h"
872 DEFUN ("buffer-dedicated-frame", Fbuffer_dedicated_frame, 0, 1, 0, /*
873 Return the frame dedicated to this BUFFER, or nil if there is none.
874 No argument or nil as argument means use current buffer as BUFFER.
878 struct buffer *buf = decode_buffer (buffer, 0);
880 /* XEmacs addition: if the frame is dead, silently make it go away. */
881 if (!NILP (buf->dedicated_frame) &&
882 !FRAME_LIVE_P (XFRAME (buf->dedicated_frame)))
883 buf->dedicated_frame = Qnil;
885 return buf->dedicated_frame;
888 DEFUN ("set-buffer-dedicated-frame", Fset_buffer_dedicated_frame, 2, 2, 0, /*
889 For this BUFFER, set the FRAME dedicated to it.
890 FRAME must be a frame or nil.
894 struct buffer *buf = decode_buffer (buffer, 0);
897 CHECK_LIVE_FRAME (frame); /* XEmacs change */
899 return buf->dedicated_frame = frame;
904 DEFUN ("buffer-modified-p", Fbuffer_modified_p, 0, 1, 0, /*
905 Return t if BUFFER was modified since its file was last read or saved.
906 No argument or nil as argument means use current buffer as BUFFER.
910 struct buffer *buf = decode_buffer (buffer, 0);
912 return BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf) ? Qt : Qnil;
915 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p, 1, 2, 0, /*
916 Mark BUFFER as modified or unmodified according to FLAG.
917 A non-nil FLAG means mark the buffer modified. No argument or nil
918 as BUFFER means use current buffer.
922 /* This function can GC */
923 struct buffer *buf = decode_buffer (buffer, 0);
925 #ifdef CLASH_DETECTION
926 /* If buffer becoming modified, lock the file.
927 If buffer becoming unmodified, unlock the file. */
929 Lisp_Object fn = buf->file_truename;
932 int already = BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf);
933 if (already == NILP (flag))
935 int count = specpdl_depth ();
936 /* lock_file() and unlock_file() currently use current_buffer */
937 /* #### - dmoore, what if lock_file or unlock_file kill
938 the current buffer? */
939 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
940 set_buffer_internal (buf);
941 if (!already && !NILP (flag))
943 else if (already && NILP (flag))
945 unbind_to (count, Qnil);
948 #endif /* CLASH_DETECTION */
950 /* This is often called when the buffer contents are altered but we
951 don't want to treat the changes that way (e.g. selective
952 display). We still need to make sure redisplay realizes that the
953 contents have potentially altered and it needs to do some
955 buf = decode_buffer(buffer, 0);
957 BUF_SAVE_MODIFF (buf) = NILP (flag) ? BUF_MODIFF (buf) : 0;
958 MARK_MODELINE_CHANGED;
963 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick, 0, 1, 0, /*
964 Return BUFFER's tick counter, incremented for each change in text.
965 Each buffer has a tick counter which is incremented each time the text in
966 that buffer is changed. It wraps around occasionally.
967 No argument or nil as argument means use current buffer as BUFFER.
971 struct buffer *buf = decode_buffer (buffer, 0);
973 return make_int (BUF_MODIFF (buf));
976 DEFUN ("rename-buffer", Frename_buffer, 1, 2,
977 "sRename buffer (to new name): \nP", /*
978 Change current buffer's name to NEWNAME (a string).
979 If second arg UNIQUE is nil or omitted, it is an error if a
980 buffer named NEWNAME already exists.
981 If UNIQUE is non-nil, come up with a new name using
982 `generate-new-buffer-name'.
983 Interactively, one can set UNIQUE with a prefix argument.
984 Returns the name we actually gave the buffer.
985 This does not change the name of the visited file (if any).
989 /* This function can GC */
990 Lisp_Object tem, buf;
993 /* #### Doc string should indicate that the buffer name will get
996 CHECK_STRING (newname);
997 newname = LISP_GETTEXT (newname);
999 if (XSTRING_LENGTH (newname) == 0)
1000 error ("Empty string is invalid as a buffer name");
1002 tem = Fget_buffer (newname);
1003 /* Don't short-circuit if UNIQUE is t. That is a useful way to rename
1004 the buffer automatically so you can create another with the original name.
1005 It makes UNIQUE equivalent to
1006 (rename-buffer (generate-new-buffer-name NEWNAME)). */
1007 /* XEmacs change: added check for nil */
1008 if (NILP (unique) && !NILP (tem) && XBUFFER (tem) == current_buffer)
1009 return current_buffer->name;
1013 newname = Fgenerate_new_buffer_name (newname, current_buffer->name);
1015 error ("Buffer name \"%s\" is in use",
1016 XSTRING_DATA (newname));
1019 current_buffer->name = newname;
1021 /* Catch redisplay's attention. Unless we do this, the modelines for
1022 any windows displaying current_buffer will stay unchanged. */
1023 MARK_MODELINE_CHANGED;
1025 buf = Fcurrent_buffer ();
1027 /* The aconses in the Vbuffer_alist are shared with frame->buffer_alist,
1028 so this will change it in the per-frame ordering as well. */
1029 Fsetcar (Frassq (buf, Vbuffer_alist), newname);
1030 if (NILP (current_buffer->filename)
1031 && !NILP (current_buffer->auto_save_file_name))
1032 call0 (Qrename_auto_save_file);
1033 /* refetch since that last call may have done GC */
1034 /* (hypothetical relocating GC) */
1035 return current_buffer->name;
1038 DEFUN ("other-buffer", Fother_buffer, 0, 3, 0, /*
1039 Return most recently selected buffer other than BUFFER.
1040 Buffers not visible in windows are preferred to visible buffers,
1041 unless optional third argument VISIBLE-OK is non-nil.
1042 If no other buffer exists, the buffer `*scratch*' is returned.
1043 If BUFFER is omitted or nil, some interesting buffer is returned.
1045 The ordering is for this frame; If second optional argument FRAME
1046 is provided, then the ordering is for that frame. If the second arg
1047 is t, then the global ordering is returned.
1049 Note: In FSF Emacs, this function takes two arguments: BUFFER and
1052 (buffer, frame, visible_ok))
1054 /* This function can GC */
1055 Lisp_Object tail, buf, notsogood, tem;
1061 alist = Vbuffer_alist;
1064 struct frame *f = decode_frame (frame);
1066 XSETFRAME (frame, f);
1067 alist = f->buffer_alist;
1070 for (tail = alist; !NILP (tail); tail = Fcdr (tail))
1072 buf = Fcdr (Fcar (tail));
1073 if (EQ (buf, buffer))
1075 if (string_byte (XSTRING (XBUFFER (buf)->name), 0) == ' ')
1077 /* If FRAME has a buffer_predicate,
1078 disregard buffers that don't fit the predicate. */
1081 tem = XFRAME (frame)->buffer_predicate;
1084 tem = call1 (tem, buf);
1090 if (NILP (visible_ok))
1092 /* get-buffer-window will handle nil or t frame */
1093 tem = Fget_buffer_window (buf, frame, Qnil);
1099 if (NILP (notsogood))
1102 if (!NILP (notsogood))
1104 return Fget_buffer_create (QSscratch);
1107 DEFUN ("buffer-disable-undo", Fbuffer_disable_undo, 0, 1, "", /*
1108 Make BUFFER stop keeping undo information.
1109 Any undo records it already has are discarded.
1110 No argument or nil as argument means do this for the current buffer.
1114 /* Allowing nil is an RMSism */
1115 struct buffer *real_buf = decode_buffer (buffer, 1);
1116 real_buf->undo_list = Qt;
1120 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo, 0, 1, "", /*
1121 Start keeping undo information for buffer BUFFER.
1122 No argument or nil as argument means do this for the current buffer.
1126 /* Allowing nil is an RMSism */
1127 struct buffer *real_buf = decode_buffer (buffer, 1);
1128 if (EQ (real_buf->undo_list, Qt))
1129 real_buf->undo_list = Qnil;
1134 DEFUN ("kill-buffer", Fkill_buffer, 1, 1, "bKill buffer: ", /*
1135 Kill the buffer BUFFER.
1136 The argument may be a buffer or may be the name of a buffer.
1137 An argument of nil means kill the current buffer.
1139 Value is t if the buffer is actually killed, nil if user says no.
1141 The value of `kill-buffer-hook' (which may be local to that buffer),
1142 if not void, is a list of functions to be called, with no arguments,
1143 before the buffer is actually killed. The buffer to be killed is current
1144 when the hook functions are called.
1146 Any processes that have this buffer as the `process-buffer' are killed
1147 with `delete-process'.
1151 /* This function can call lisp */
1153 REGISTER struct buffer *b;
1154 struct gcpro gcpro1, gcpro2;
1157 buf = Fcurrent_buffer ();
1158 else if (BUFFERP (buffer))
1162 buf = get_buffer (buffer, 0);
1163 if (NILP (buf)) nsberror (buffer);
1168 /* OK to delete an already-deleted buffer. */
1169 if (!BUFFER_LIVE_P (b))
1172 /* Don't kill the minibuffer now current. */
1173 if (EQ (buf, Vminibuffer_zero))
1176 /* Or the echo area. */
1177 if (EQ (buf, Vecho_area_buffer))
1180 /* Query if the buffer is still modified. */
1181 if (INTERACTIVE && !NILP (b->filename)
1182 && BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
1188 (emacs_doprnt_string_c
1189 ((const Bufbyte *) GETTEXT ("Buffer %s modified; kill anyway? "),
1190 Qnil, -1, XSTRING_DATA (b->name))));
1194 b = XBUFFER (buf); /* Hypothetical relocating GC. */
1197 /* Run hooks with the buffer to be killed temporarily selected,
1198 unless the buffer is already dead (could have been deleted
1199 in the question above).
1201 if (BUFFER_LIVE_P (b))
1203 int speccount = specpdl_depth ();
1204 Lisp_Object tail = Qnil;
1207 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1210 /* First run the query functions; if any query is answered no,
1211 don't kill the buffer. */
1212 EXTERNAL_LIST_LOOP (tail, Vkill_buffer_query_functions)
1214 if (NILP (call0 (Fcar (tail))))
1217 return unbind_to (speccount, Qnil);
1221 /* Then run the hooks. */
1222 run_hook (Qkill_buffer_hook);
1223 #ifdef HAVE_X_WINDOWS
1224 /* If an X selection was in this buffer, disown it.
1225 We could have done this by simply adding this function to the
1226 kill-buffer-hook, but the user might mess that up.
1228 if (EQ (Vwindow_system, Qx))
1229 call0 (intern ("xselect-kill-buffer-hook"));
1230 /* #### generalize me! */
1231 #endif /* HAVE_X_WINDOWS */
1232 unbind_to (speccount, Qnil);
1234 b = XBUFFER (buf); /* Hypothetical relocating GC. */
1237 /* We have no more questions to ask. Verify that it is valid
1238 to kill the buffer. This must be done after the questions
1239 since anything can happen within yes-or-no-p. */
1241 /* Might have been deleted during the last question above */
1242 if (!BUFFER_LIVE_P (b))
1245 /* Don't kill the minibuffer now current. */
1246 if (EQ (buf, XWINDOW (minibuf_window)->buffer))
1249 /* When we kill a base buffer, kill all its indirect buffers.
1250 We do it at this stage so nothing terrible happens if they
1251 ask questions or their hooks get errors. */
1252 if (! b->base_buffer)
1258 LIST_LOOP (rest, b->indirect_children)
1260 Fkill_buffer (XCAR (rest));
1261 /* Keep indirect_children updated in case a
1262 query-function/hook throws. */
1263 b->indirect_children = XCDR (rest);
1269 /* Make this buffer not be current.
1270 In the process, notice if this is the sole visible buffer
1271 and give up if so. */
1272 if (b == current_buffer)
1274 Fset_buffer (Fother_buffer (buf, Qnil, Qnil));
1275 if (b == current_buffer)
1279 /* Now there is no question: we can kill the buffer. */
1281 #ifdef CLASH_DETECTION
1282 /* Unlock this buffer's file, if it is locked. unlock_buffer
1283 can both GC and kill the current buffer, and wreak general
1284 havok by running lisp code. */
1290 if (!BUFFER_LIVE_P (b))
1293 if (b == current_buffer)
1295 Fset_buffer (Fother_buffer (buf, Qnil, Qnil));
1296 if (b == current_buffer)
1299 #endif /* CLASH_DETECTION */
1302 int speccount = specpdl_depth ();
1303 specbind (Qinhibit_quit, Qt);
1305 kill_buffer_processes (buf);
1307 delete_from_buffer_alist (buf);
1309 /* #### This is a problem if this buffer is in a dedicated window.
1310 Need to undedicate any windows of this buffer first (and delete them?)
1312 Freplace_buffer_in_windows (buf);
1314 font_lock_buffer_was_killed (b);
1316 /* Delete any auto-save file, if we saved it in this session. */
1317 if (STRINGP (b->auto_save_file_name)
1318 && b->auto_save_modified != 0
1319 && BUF_SAVE_MODIFF (b) < b->auto_save_modified)
1321 if (delete_auto_save_files != 0)
1323 /* deleting the auto save file might kill b! */
1324 /* #### dmoore - fix this crap, we do this same gcpro and
1325 buffer liveness check multiple times. Let's get a
1326 macro or something for it. */
1328 internal_delete_file (b->auto_save_file_name);
1332 if (!BUFFER_LIVE_P (b))
1335 if (b == current_buffer)
1337 Fset_buffer (Fother_buffer (buf, Qnil, Qnil));
1338 if (b == current_buffer)
1344 uninit_buffer_markers (b);
1346 kill_buffer_local_variables (b);
1349 uninit_buffer_text (b);
1350 b->undo_list = Qnil;
1351 uninit_buffer_extents (b);
1354 #ifdef ERROR_CHECK_BUFPOS
1355 assert (!NILP (memq_no_quit (buf, b->base_buffer->indirect_children)));
1357 b->base_buffer->indirect_children =
1358 delq_no_quit (buf, b->base_buffer->indirect_children);
1361 /* Clear away all Lisp objects, so that they
1362 won't be protected from GC. */
1363 nuke_all_buffer_slots (b, Qnil);
1365 unbind_to (speccount, Qnil);
1370 DEFUN ("record-buffer", Frecord_buffer, 1, 1, 0, /*
1371 Place buffer BUFFER first in the buffer order.
1372 Call this function when a buffer is selected "visibly".
1374 This function changes the global buffer order and the per-frame buffer
1375 order for the selected frame. The buffer order keeps track of recency
1376 of selection so that `other-buffer' will return a recently selected
1377 buffer. See `other-buffer' for more information.
1381 REGISTER Lisp_Object lynk, prev;
1382 struct frame *f = selected_frame ();
1385 for (lynk = Vbuffer_alist; CONSP (lynk); lynk = XCDR (lynk))
1387 if (EQ (XCDR (XCAR (lynk)), buffer))
1391 /* Effectively do Vbuffer_alist = delq_no_quit (lynk, Vbuffer_alist) */
1393 Vbuffer_alist = XCDR (Vbuffer_alist);
1395 XCDR (prev) = XCDR (XCDR (prev));
1396 XCDR (lynk) = Vbuffer_alist;
1397 Vbuffer_alist = lynk;
1399 /* That was the global one. Now do the same thing for the
1400 per-frame buffer-alist. */
1402 for (lynk = f->buffer_alist; CONSP (lynk); lynk = XCDR (lynk))
1404 if (EQ (XCDR (XCAR (lynk)), buffer))
1408 /* Effectively do f->buffer_alist = delq_no_quit (lynk, f->buffer_alist) */
1410 f->buffer_alist = XCDR (f->buffer_alist);
1412 XCDR (prev) = XCDR (XCDR (prev));
1413 XCDR (lynk) = f->buffer_alist;
1414 f->buffer_alist = lynk;
1416 va_run_hook_with_args (Qrecord_buffer_hook, 1, buffer);
1421 DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode, 1, 1, 0, /*
1422 Set an appropriate major mode for BUFFER, according to `default-major-mode'.
1423 Use this function before selecting the buffer, since it may need to inspect
1424 the current buffer's major mode.
1428 int speccount = specpdl_depth ();
1429 Lisp_Object function = XBUFFER (Vbuffer_defaults)->major_mode;
1431 if (NILP (function))
1433 Lisp_Object tem = Fget (current_buffer->major_mode, Qmode_class, Qnil);
1435 function = current_buffer->major_mode;
1438 if (NILP (function) || EQ (function, Qfundamental_mode))
1441 /* To select a nonfundamental mode,
1442 select the buffer temporarily and then call the mode function. */
1444 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
1446 Fset_buffer (buffer);
1449 return unbind_to (speccount, Qnil);
1453 switch_to_buffer (Lisp_Object bufname, Lisp_Object norecord)
1455 call2 (Qswitch_to_buffer, bufname, norecord);
1459 DEFUN ("current-buffer", Fcurrent_buffer, 0, 0, 0, /*
1460 Return the current buffer as a Lisp object.
1465 XSETBUFFER (buffer, current_buffer);
1469 /* Set the current buffer to B. */
1472 set_buffer_internal (struct buffer *b)
1474 REGISTER struct buffer *old_buf;
1475 REGISTER Lisp_Object tail;
1477 if (current_buffer == b)
1480 INVALIDATE_PIXEL_TO_GLYPH_CACHE;
1482 old_buf = current_buffer;
1484 invalidate_current_column (); /* invalidate indentation cache */
1487 if (!noninteractive && initialized)
1489 extern Lisp_Object Ffep_force_on (), Ffep_force_off (), Ffep_get_mode ();
1491 old_buf->fep_mode = Ffep_get_mode ();
1493 if (!NILP (current_buffer->fep_mode))
1498 #endif /* HAVE_FEP */
1502 /* Put the undo list back in the base buffer, so that it appears
1503 that an indirect buffer shares the undo list of its base. */
1504 if (old_buf->base_buffer)
1505 old_buf->base_buffer->undo_list = old_buf->undo_list;
1508 /* Get the undo list from the base buffer, so that it appears
1509 that an indirect buffer shares the undo list of its base. */
1511 b->undo_list = b->base_buffer->undo_list;
1513 /* Look down buffer's list of local Lisp variables
1514 to find and update any that forward into C variables. */
1516 LIST_LOOP (tail, b->local_var_alist)
1518 Lisp_Object sym = XCAR (XCAR (tail));
1519 Lisp_Object valcontents = XSYMBOL (sym)->value;
1520 if (SYMBOL_VALUE_MAGIC_P (valcontents))
1522 /* Just reference the variable
1523 to cause it to become set for this buffer. */
1524 /* Use find_symbol_value_quickly to avoid an unnecessary O(n)
1526 (void) find_symbol_value_quickly (XCAR (tail), 1);
1530 /* Do the same with any others that were local to the previous buffer */
1534 LIST_LOOP (tail, old_buf->local_var_alist)
1536 Lisp_Object sym = XCAR (XCAR (tail));
1537 Lisp_Object valcontents = XSYMBOL (sym)->value;
1539 if (SYMBOL_VALUE_MAGIC_P (valcontents))
1541 /* Just reference the variable
1542 to cause it to become set for this buffer. */
1543 /* Use find_symbol_value_quickly with find_it_p as 0 to avoid an
1544 unnecessary O(n) lookup which is guaranteed to be worst case.
1545 Any symbols which are local are guaranteed to have been
1546 handled in the previous loop, above. */
1547 (void) find_symbol_value_quickly (sym, 0);
1553 DEFUN ("set-buffer", Fset_buffer, 1, 1, 0, /*
1554 Make the buffer BUFFER current for editing operations.
1555 BUFFER may be a buffer or the name of an existing buffer.
1556 See also `save-excursion' when you want to make a buffer current temporarily.
1557 This function does not display the buffer, so its effect ends
1558 when the current command terminates.
1559 Use `switch-to-buffer' or `pop-to-buffer' to switch buffers permanently.
1563 buffer = get_buffer (buffer, 0);
1565 error ("Selecting deleted or non-existent buffer");
1566 set_buffer_internal (XBUFFER (buffer));
1571 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only, 0, 3, 0, /*
1572 Signal a `buffer-read-only' error if the buffer is read-only.
1573 Optional argument BUFFER defaults to the current buffer.
1575 If optional argument START is non-nil, all extents in the buffer
1576 which overlap that part of the buffer are checked to ensure none has a
1577 `read-only' property. (Extents that lie completely within the range,
1578 however, are not checked.) END defaults to the value of START.
1580 If START and END are equal, the range checked is [START, END] (i.e.
1581 closed on both ends); otherwise, the range checked is (START, END)
1582 \(open on both ends), except that extents that lie completely within
1583 [START, END] are not checked. See `extent-in-region-p' for a fuller
1586 (buffer, start, end))
1588 struct buffer *b = decode_buffer (buffer, 0);
1597 get_buffer_range_char (b, start, end, &s, &e, 0);
1599 barf_if_buffer_read_only (b, s, e);
1605 bury_buffer_1 (Lisp_Object buffer, Lisp_Object before,
1606 Lisp_Object *buffer_alist)
1608 Lisp_Object aelt = rassq_no_quit (buffer, *buffer_alist);
1609 Lisp_Object lynk = memq_no_quit (aelt, *buffer_alist);
1610 Lisp_Object iter, before_before;
1612 *buffer_alist = delq_no_quit (aelt, *buffer_alist);
1613 for (before_before = Qnil, iter = *buffer_alist;
1614 !NILP (iter) && !EQ (XCDR (XCAR (iter)), before);
1615 before_before = iter, iter = XCDR (iter))
1618 if (!NILP (before_before))
1619 XCDR (before_before) = lynk;
1621 *buffer_alist = lynk;
1624 DEFUN ("bury-buffer", Fbury_buffer, 0, 2, "", /*
1625 Put BUFFER at the end of the list of all buffers.
1626 There it is the least likely candidate for `other-buffer' to return;
1627 thus, the least likely buffer for \\[switch-to-buffer] to select by default.
1628 If BUFFER is nil or omitted, bury the current buffer.
1629 Also, if BUFFER is nil or omitted, remove the current buffer from the
1630 selected window if it is displayed there.
1631 Because of this, you may need to specify (current-buffer) as
1632 BUFFER when calling from minibuffer.
1633 If BEFORE is non-nil, it specifies a buffer before which BUFFER
1634 will be placed, instead of being placed at the end.
1638 /* This function can GC */
1639 struct buffer *buf = decode_buffer (buffer, 1);
1640 /* If we're burying the current buffer, unshow it. */
1641 /* Note that the behavior of (bury-buffer nil) and
1642 (bury-buffer (current-buffer)) is not the same.
1643 This is illogical but is historical. Changing it
1644 breaks mh-e and TeX and such packages. */
1646 switch_to_buffer (Fother_buffer (Fcurrent_buffer (), Qnil, Qnil), Qnil);
1647 XSETBUFFER (buffer, buf);
1650 before = get_buffer (before, 1);
1652 if (EQ (before, buffer))
1653 error ("Cannot place a buffer before itself");
1655 bury_buffer_1 (buffer, before, &Vbuffer_alist);
1656 bury_buffer_1 (buffer, before, &selected_frame ()->buffer_alist);
1662 DEFUN ("erase-buffer", Ferase_buffer, 0, 1, "*", /*
1663 Delete the entire contents of the BUFFER.
1664 Any clipping restriction in effect (see `narrow-to-region') is removed,
1665 so the buffer is truly empty after this.
1666 BUFFER defaults to the current buffer if omitted.
1670 /* This function can GC */
1671 struct buffer *b = decode_buffer (buffer, 1);
1672 /* #### yuck yuck yuck. This is gross. The old echo-area code,
1673 however, was the only place that called erase_buffer() with a
1674 non-zero NO_CLIP argument.
1676 Someone needs to fix up the redisplay code so it is smarter
1677 about this, so that the NO_CLIP junk isn't necessary. */
1678 int no_clip = (b == XBUFFER (Vecho_area_buffer));
1680 INVALIDATE_PIXEL_TO_GLYPH_CACHE;
1682 widen_buffer (b, no_clip);
1683 buffer_delete_range (b, BUF_BEG (b), BUF_Z (b), 0);
1684 b->last_window_start = 1;
1686 /* Prevent warnings, or suspension of auto saving, that would happen
1687 if future size is less than past size. Use of erase-buffer
1688 implies that the future text is not really related to the past text. */
1689 b->saved_size = Qzero;
1691 zmacs_region_stays = 0;
1697 DEFUN ("kill-all-local-variables", Fkill_all_local_variables, 0, 0, 0, /*
1698 Switch to Fundamental mode by killing current buffer's local variables.
1699 Most local variable bindings are eliminated so that the default values
1700 become effective once more. Also, the syntax table is set from
1701 `standard-syntax-table', the category table is set from
1702 `standard-category-table' (if support for Mule exists), local keymap is set
1703 to nil, the abbrev table is set from `fundamental-mode-abbrev-table',
1704 and all specifier specifications whose locale is the current buffer
1705 are removed. This function also forces redisplay of the modeline.
1707 Every function to select a new major mode starts by
1708 calling this function.
1710 As a special exception, local variables whose names have
1711 a non-nil `permanent-local' property are not eliminated by this function.
1713 The first thing this function does is run
1714 the normal hook `change-major-mode-hook'.
1718 /* This function can GC */
1719 run_hook (Qchange_major_mode_hook);
1721 reset_buffer_local_variables (current_buffer, 0);
1723 kill_buffer_local_variables (current_buffer);
1725 kill_specifier_buffer_locals (Fcurrent_buffer ());
1727 /* Force modeline redisplay. Useful here because all major mode
1728 commands call this function. */
1729 MARK_MODELINE_CHANGED;
1734 #ifdef MEMORY_USAGE_STATS
1745 compute_buffer_text_usage (struct buffer *b, struct overhead_stats *ovstats)
1747 int was_requested = b->text->z - 1;
1748 size_t gap = b->text->gap_size + b->text->end_gap_size;
1749 size_t malloc_use = malloced_storage_size (b->text->beg, was_requested + gap, 0);
1751 ovstats->gap_overhead += gap;
1752 ovstats->was_requested += was_requested;
1753 ovstats->malloc_overhead += malloc_use - (was_requested + gap);
1758 compute_buffer_usage (struct buffer *b, struct buffer_stats *stats,
1759 struct overhead_stats *ovstats)
1762 stats->other += malloced_storage_size (b, sizeof (*b), ovstats);
1763 stats->text += compute_buffer_text_usage (b, ovstats);
1764 stats->markers += compute_buffer_marker_usage (b, ovstats);
1765 stats->extents += compute_buffer_extent_usage (b, ovstats);
1768 DEFUN ("buffer-memory-usage", Fbuffer_memory_usage, 1, 1, 0, /*
1769 Return stats about the memory usage of buffer BUFFER.
1770 The values returned are in the form of an alist of usage types and byte
1771 counts. The byte counts attempt to encompass all the memory used
1772 by the buffer (separate from the memory logically associated with a
1773 buffer or frame), including internal structures and any malloc()
1774 overhead associated with them. In practice, the byte counts are
1775 underestimated because certain memory usage is very hard to determine
1776 \(e.g. the amount of memory used inside the Xt library or inside the
1777 X server) and because there is other stuff that might logically
1778 be associated with a window, buffer, or frame (e.g. window configurations,
1779 glyphs) but should not obviously be included in the usage counts.
1781 Multiple slices of the total memory usage may be returned, separated
1782 by a nil. Each slice represents a particular view of the memory, a
1783 particular way of partitioning it into groups. Within a slice, there
1784 is no overlap between the groups of memory, and each slice collectively
1785 represents all the memory concerned.
1789 struct buffer_stats stats;
1790 struct overhead_stats ovstats;
1791 Lisp_Object val = Qnil;
1793 CHECK_BUFFER (buffer); /* dead buffers should be allowed, no? */
1795 compute_buffer_usage (XBUFFER (buffer), &stats, &ovstats);
1797 val = acons (Qtext, make_int (stats.text), val);
1798 val = acons (Qmarkers, make_int (stats.markers), val);
1799 val = acons (Qextents, make_int (stats.extents), val);
1800 val = acons (Qother, make_int (stats.other), val);
1801 val = Fcons (Qnil, val);
1802 val = acons (Qactually_requested, make_int (ovstats.was_requested), val);
1803 val = acons (Qmalloc_overhead, make_int (ovstats.malloc_overhead), val);
1804 val = acons (Qgap_overhead, make_int (ovstats.gap_overhead), val);
1805 val = acons (Qdynarr_overhead, make_int (ovstats.dynarr_overhead), val);
1807 return Fnreverse (val);
1810 #endif /* MEMORY_USAGE_STATS */
1813 /************************************************************************/
1814 /* Implement TO_EXTERNAL_FORMAT, TO_INTERNAL_FORMAT */
1815 /************************************************************************/
1817 /* This implementation should probably be elsewhere, but it can't be
1818 in file-coding.c since that file is only available if FILE_CODING
1822 coding_system_is_binary (Lisp_Object coding_system)
1824 Lisp_Coding_System *cs = XCODING_SYSTEM (coding_system);
1826 (CODING_SYSTEM_TYPE (cs) == CODESYS_NO_CONVERSION &&
1827 CODING_SYSTEM_EOL_TYPE (cs) == EOL_LF &&
1828 EQ (CODING_SYSTEM_POST_READ_CONVERSION (cs), Qnil) &&
1829 EQ (CODING_SYSTEM_PRE_WRITE_CONVERSION (cs), Qnil));
1832 #define coding_system_is_binary(coding_system) 1
1835 static Extbyte_dynarr *conversion_out_dynarr;
1836 static Bufbyte_dynarr *conversion_in_dynarr;
1838 static int dfc_convert_to_external_format_in_use;
1839 static int dfc_convert_to_internal_format_in_use;
1842 dfc_convert_to_external_format_reset_in_use (Lisp_Object value)
1844 dfc_convert_to_external_format_in_use = XINT (value);
1849 dfc_convert_to_internal_format_reset_in_use (Lisp_Object value)
1851 dfc_convert_to_internal_format_in_use = XINT (value);
1856 dfc_convert_to_external_format (dfc_conversion_type source_type,
1857 dfc_conversion_data *source,
1859 Lisp_Object coding_system,
1861 dfc_conversion_type sink_type,
1862 dfc_conversion_data *sink)
1864 int count = specpdl_depth ();
1866 type_checking_assert
1867 (((source_type == DFC_TYPE_DATA) ||
1868 (source_type == DFC_TYPE_LISP_LSTREAM && LSTREAMP (source->lisp_object)) ||
1869 (source_type == DFC_TYPE_LISP_STRING && STRINGP (source->lisp_object)))
1871 ((sink_type == DFC_TYPE_DATA) ||
1872 (sink_type == DFC_TYPE_LISP_LSTREAM && LSTREAMP (source->lisp_object))));
1874 if (dfc_convert_to_external_format_in_use != 0)
1875 error ("Can't call a conversion function from a conversion function");
1877 dfc_convert_to_external_format_in_use = 1;
1879 record_unwind_protect (dfc_convert_to_external_format_reset_in_use,
1883 coding_system = Fget_coding_system (coding_system);
1886 Dynarr_reset (conversion_out_dynarr);
1888 /* Here we optimize in the case where the coding system does no
1889 conversion. However, we don't want to optimize in case the source
1890 or sink is an lstream, since writing to an lstream can cause a
1891 garbage collection, and this could be problematic if the source
1892 is a lisp string. */
1893 if (source_type != DFC_TYPE_LISP_LSTREAM &&
1894 sink_type != DFC_TYPE_LISP_LSTREAM &&
1895 coding_system_is_binary (coding_system))
1900 if (source_type == DFC_TYPE_LISP_STRING)
1902 ptr = XSTRING_DATA (source->lisp_object);
1903 len = XSTRING_LENGTH (source->lisp_object);
1907 ptr = (Bufbyte *) source->data.ptr;
1908 len = source->data.len;
1914 for (end = ptr + len; ptr < end;)
1917 (BYTE_ASCII_P (*ptr)) ? *ptr :
1918 (*ptr == LEADING_BYTE_CONTROL_1) ? (*(ptr+1) - 0x20) :
1919 (*ptr == LEADING_BYTE_LATIN_ISO8859_1) ? (*(ptr+1)) :
1922 Dynarr_add (conversion_out_dynarr, (Extbyte) c);
1925 bufpos_checking_assert (ptr == end);
1928 Dynarr_add_many (conversion_out_dynarr, ptr, len);
1934 Lisp_Object streams_to_delete[3];
1935 int delete_count = 0;
1936 Lisp_Object instream, outstream;
1937 Lstream *reader, *writer;
1938 struct gcpro gcpro1, gcpro2;
1940 if (source_type == DFC_TYPE_LISP_LSTREAM)
1941 instream = source->lisp_object;
1942 else if (source_type == DFC_TYPE_DATA)
1943 streams_to_delete[delete_count++] = instream =
1944 make_fixed_buffer_input_stream (source->data.ptr, source->data.len);
1947 type_checking_assert (source_type == DFC_TYPE_LISP_STRING);
1948 streams_to_delete[delete_count++] = instream =
1949 make_lisp_string_input_stream (source->lisp_object, 0, -1);
1952 if (sink_type == DFC_TYPE_LISP_LSTREAM)
1953 outstream = sink->lisp_object;
1956 type_checking_assert (sink_type == DFC_TYPE_DATA);
1957 streams_to_delete[delete_count++] = outstream =
1958 make_dynarr_output_stream
1959 ((unsigned_char_dynarr *) conversion_out_dynarr);
1963 streams_to_delete[delete_count++] = outstream =
1964 make_encoding_output_stream (XLSTREAM (outstream), coding_system);
1967 reader = XLSTREAM (instream);
1968 writer = XLSTREAM (outstream);
1969 /* decoding_stream will gc-protect outstream */
1970 GCPRO2 (instream, outstream);
1974 ssize_t size_in_bytes;
1975 char tempbuf[1024]; /* some random amount */
1977 size_in_bytes = Lstream_read (reader, tempbuf, sizeof (tempbuf));
1979 if (size_in_bytes == 0)
1981 else if (size_in_bytes < 0)
1982 error ("Error converting to external format");
1984 size_in_bytes = Lstream_write (writer, tempbuf, size_in_bytes);
1986 if (size_in_bytes <= 0)
1987 error ("Error converting to external format");
1990 /* Closing writer will close any stream at the other end of writer. */
1991 Lstream_close (writer);
1992 Lstream_close (reader);
1995 /* The idea is that this function will create no garbage. */
1996 while (delete_count)
1997 Lstream_delete (XLSTREAM (streams_to_delete [--delete_count]));
2000 unbind_to (count, Qnil);
2002 if (sink_type != DFC_TYPE_LISP_LSTREAM)
2004 sink->data.len = Dynarr_length (conversion_out_dynarr);
2005 Dynarr_add (conversion_out_dynarr, 0);
2006 sink->data.ptr = Dynarr_atp (conversion_out_dynarr, 0);
2011 dfc_convert_to_internal_format (dfc_conversion_type source_type,
2012 dfc_conversion_data *source,
2014 Lisp_Object coding_system,
2016 dfc_conversion_type sink_type,
2017 dfc_conversion_data *sink)
2019 int count = specpdl_depth ();
2021 type_checking_assert
2022 ((source_type == DFC_TYPE_DATA ||
2023 source_type == DFC_TYPE_LISP_LSTREAM)
2025 (sink_type == DFC_TYPE_DATA ||
2026 sink_type == DFC_TYPE_LISP_LSTREAM));
2028 if (dfc_convert_to_internal_format_in_use != 0)
2029 error ("Can't call a conversion function from a conversion function");
2031 dfc_convert_to_internal_format_in_use = 1;
2033 record_unwind_protect (dfc_convert_to_internal_format_reset_in_use,
2037 coding_system = Fget_coding_system (coding_system);
2040 Dynarr_reset (conversion_in_dynarr);
2042 if (source_type != DFC_TYPE_LISP_LSTREAM &&
2043 sink_type != DFC_TYPE_LISP_LSTREAM &&
2044 coding_system_is_binary (coding_system))
2047 const Bufbyte *ptr = (const Bufbyte *) source->data.ptr;
2048 Bytecount len = source->data.len;
2049 const Bufbyte *end = ptr + len;
2051 for (; ptr < end; ptr++)
2055 if (BYTE_ASCII_P (c))
2056 Dynarr_add (conversion_in_dynarr, c);
2057 else if (BYTE_C1_P (c))
2059 Dynarr_add (conversion_in_dynarr, LEADING_BYTE_CONTROL_1);
2060 Dynarr_add (conversion_in_dynarr, c + 0x20);
2064 Dynarr_add (conversion_in_dynarr, LEADING_BYTE_LATIN_ISO8859_1);
2065 Dynarr_add (conversion_in_dynarr, c);
2069 Dynarr_add_many (conversion_in_dynarr, source->data.ptr, source->data.len);
2074 Lisp_Object streams_to_delete[3];
2075 int delete_count = 0;
2076 Lisp_Object instream, outstream;
2077 Lstream *reader, *writer;
2078 struct gcpro gcpro1, gcpro2;
2080 if (source_type == DFC_TYPE_LISP_LSTREAM)
2081 instream = source->lisp_object;
2084 type_checking_assert (source_type == DFC_TYPE_DATA);
2085 streams_to_delete[delete_count++] = instream =
2086 make_fixed_buffer_input_stream (source->data.ptr, source->data.len);
2089 if (sink_type == DFC_TYPE_LISP_LSTREAM)
2090 outstream = sink->lisp_object;
2093 type_checking_assert (sink_type == DFC_TYPE_DATA);
2094 streams_to_delete[delete_count++] = outstream =
2095 make_dynarr_output_stream
2096 ((unsigned_char_dynarr *) conversion_in_dynarr);
2100 streams_to_delete[delete_count++] = outstream =
2101 make_decoding_output_stream (XLSTREAM (outstream), coding_system);
2104 reader = XLSTREAM (instream);
2105 writer = XLSTREAM (outstream);
2106 /* outstream will gc-protect its sink stream, if necessary */
2107 GCPRO2 (instream, outstream);
2111 ssize_t size_in_bytes;
2112 char tempbuf[1024]; /* some random amount */
2114 size_in_bytes = Lstream_read (reader, tempbuf, sizeof (tempbuf));
2116 if (size_in_bytes == 0)
2118 else if (size_in_bytes < 0)
2119 error ("Error converting to internal format");
2121 size_in_bytes = Lstream_write (writer, tempbuf, size_in_bytes);
2123 if (size_in_bytes <= 0)
2124 error ("Error converting to internal format");
2127 /* Closing writer will close any stream at the other end of writer. */
2128 Lstream_close (writer);
2129 Lstream_close (reader);
2132 /* The idea is that this function will create no garbage. */
2133 while (delete_count)
2134 Lstream_delete (XLSTREAM (streams_to_delete [--delete_count]));
2137 unbind_to (count, Qnil);
2139 if (sink_type != DFC_TYPE_LISP_LSTREAM)
2141 sink->data.len = Dynarr_length (conversion_in_dynarr);
2142 Dynarr_add (conversion_in_dynarr, 0); /* remember to zero-terminate! */
2143 sink->data.ptr = Dynarr_atp (conversion_in_dynarr, 0);
2149 syms_of_buffer (void)
2151 INIT_LRECORD_IMPLEMENTATION (buffer);
2153 defsymbol (&Qbuffer_live_p, "buffer-live-p");
2154 defsymbol (&Qbuffer_or_string_p, "buffer-or-string-p");
2155 defsymbol (&Qmode_class, "mode-class");
2156 defsymbol (&Qrename_auto_save_file, "rename-auto-save-file");
2157 defsymbol (&Qkill_buffer_hook, "kill-buffer-hook");
2158 defsymbol (&Qrecord_buffer_hook, "record-buffer-hook");
2159 defsymbol (&Qpermanent_local, "permanent-local");
2161 defsymbol (&Qfirst_change_hook, "first-change-hook");
2162 defsymbol (&Qbefore_change_functions, "before-change-functions");
2163 defsymbol (&Qafter_change_functions, "after-change-functions");
2165 /* #### Obsolete, for compatibility */
2166 defsymbol (&Qbefore_change_function, "before-change-function");
2167 defsymbol (&Qafter_change_function, "after-change-function");
2169 defsymbol (&Qdefault_directory, "default-directory");
2171 defsymbol (&Qget_file_buffer, "get-file-buffer");
2172 defsymbol (&Qchange_major_mode_hook, "change-major-mode-hook");
2174 defsymbol (&Qfundamental_mode, "fundamental-mode");
2176 defsymbol (&Qfind_file_compare_truenames, "find-file-compare-truenames");
2178 defsymbol (&Qswitch_to_buffer, "switch-to-buffer");
2181 DEFSUBR (Fbuffer_live_p);
2182 DEFSUBR (Fbuffer_list);
2183 DEFSUBR (Fdecode_buffer);
2184 DEFSUBR (Fget_buffer);
2185 DEFSUBR (Fget_file_buffer);
2186 DEFSUBR (Fget_buffer_create);
2187 DEFSUBR (Fmake_indirect_buffer);
2189 DEFSUBR (Fgenerate_new_buffer_name);
2190 DEFSUBR (Fbuffer_name);
2191 DEFSUBR (Fbuffer_file_name);
2192 DEFSUBR (Fbuffer_base_buffer);
2193 DEFSUBR (Fbuffer_indirect_children);
2194 DEFSUBR (Fbuffer_local_variables);
2195 DEFSUBR (Fbuffer_dedicated_frame);
2196 DEFSUBR (Fset_buffer_dedicated_frame);
2197 DEFSUBR (Fbuffer_modified_p);
2198 DEFSUBR (Fset_buffer_modified_p);
2199 DEFSUBR (Fbuffer_modified_tick);
2200 DEFSUBR (Frename_buffer);
2201 DEFSUBR (Fother_buffer);
2202 DEFSUBR (Fbuffer_disable_undo);
2203 DEFSUBR (Fbuffer_enable_undo);
2204 DEFSUBR (Fkill_buffer);
2205 DEFSUBR (Ferase_buffer);
2206 DEFSUBR (Frecord_buffer);
2207 DEFSUBR (Fset_buffer_major_mode);
2208 DEFSUBR (Fcurrent_buffer);
2209 DEFSUBR (Fset_buffer);
2210 DEFSUBR (Fbarf_if_buffer_read_only);
2211 DEFSUBR (Fbury_buffer);
2212 DEFSUBR (Fkill_all_local_variables);
2213 #ifdef MEMORY_USAGE_STATS
2214 DEFSUBR (Fbuffer_memory_usage);
2217 deferror (&Qprotected_field, "protected-field",
2218 "Attempt to modify a protected field", Qerror);
2222 reinit_vars_of_buffer (void)
2224 conversion_in_dynarr = Dynarr_new (Bufbyte);
2225 conversion_out_dynarr = Dynarr_new (Extbyte);
2227 staticpro_nodump (&Vbuffer_alist);
2228 Vbuffer_alist = Qnil;
2232 /* initialize the buffer routines */
2234 vars_of_buffer (void)
2236 /* This function can GC */
2237 reinit_vars_of_buffer ();
2239 staticpro (&QSFundamental);
2240 staticpro (&QSscratch);
2242 QSFundamental = build_string ("Fundamental");
2243 QSscratch = build_string (DEFER_GETTEXT ("*scratch*"));
2245 DEFVAR_LISP ("change-major-mode-hook", &Vchange_major_mode_hook /*
2246 List of hooks to be run before killing local variables in a buffer.
2247 This should be used by any mode that temporarily alters the contents or
2248 the read-only state of the buffer. See also `kill-all-local-variables'.
2250 Vchange_major_mode_hook = Qnil;
2252 DEFVAR_BOOL ("find-file-compare-truenames", &find_file_compare_truenames /*
2253 If this is true, then the find-file command will check the truenames
2254 of all visited files when deciding whether a given file is already in
2255 a buffer, instead of just the buffer-file-name. This means that if you
2256 attempt to visit another file which is a symbolic-link to a file which is
2257 already in a buffer, the existing buffer will be found instead of a newly-
2258 created one. This works if any component of the pathname (including a non-
2259 terminal component) is a symbolic link as well, but doesn't work with hard
2260 links (nothing does).
2262 See also the variable find-file-use-truenames.
2264 find_file_compare_truenames = 0;
2266 DEFVAR_BOOL ("find-file-use-truenames", &find_file_use_truenames /*
2267 If this is true, then a buffer's visited file-name will always be
2268 chased back to the real file; it will never be a symbolic link, and there
2269 will never be a symbolic link anywhere in its directory path.
2270 That is, the buffer-file-name and buffer-file-truename will be equal.
2271 This doesn't work with hard links.
2273 See also the variable find-file-compare-truenames.
2275 find_file_use_truenames = 0;
2277 DEFVAR_LISP ("before-change-functions", &Vbefore_change_functions /*
2278 List of functions to call before each text change.
2279 Two arguments are passed to each function: the positions of
2280 the beginning and end of the range of old text to be changed.
2281 \(For an insertion, the beginning and end are at the same place.)
2282 No information is given about the length of the text after the change.
2284 Buffer changes made while executing the `before-change-functions'
2285 don't call any before-change or after-change functions.
2287 Vbefore_change_functions = Qnil;
2289 /* FSF Emacs has the following additional doc at the end of
2290 before-change-functions and after-change-functions:
2292 That's because these variables are temporarily set to nil.
2293 As a result, a hook function cannot straightforwardly alter the value of
2294 these variables. See the Emacs Lisp manual for a way of
2295 accomplishing an equivalent result by using other variables.
2297 But this doesn't apply under XEmacs because things are
2300 DEFVAR_LISP ("after-change-functions", &Vafter_change_functions /*
2301 List of functions to call after each text change.
2302 Three arguments are passed to each function: the positions of
2303 the beginning and end of the range of changed text,
2304 and the length of the pre-change text replaced by that range.
2305 \(For an insertion, the pre-change length is zero;
2306 for a deletion, that length is the number of characters deleted,
2307 and the post-change beginning and end are at the same place.)
2309 Buffer changes made while executing `after-change-functions'
2310 don't call any before-change or after-change functions.
2312 Vafter_change_functions = Qnil;
2314 DEFVAR_LISP ("before-change-function", &Vbefore_change_function /*
2316 */ ); /* obsoleteness will be documented */
2317 Vbefore_change_function = Qnil;
2319 DEFVAR_LISP ("after-change-function", &Vafter_change_function /*
2321 */ ); /* obsoleteness will be documented */
2322 Vafter_change_function = Qnil;
2324 DEFVAR_LISP ("first-change-hook", &Vfirst_change_hook /*
2325 A list of functions to call before changing a buffer which is unmodified.
2326 The functions are run using the `run-hooks' function.
2328 Vfirst_change_hook = Qnil;
2331 xxDEFVAR_LISP ("transient-mark-mode", &Vtransient_mark_mode /*
2332 *Non-nil means deactivate the mark when the buffer contents change.
2334 Vtransient_mark_mode = Qnil;
2335 #endif /* FSFmacs */
2337 DEFVAR_INT ("undo-threshold", &undo_threshold /*
2338 Keep no more undo information once it exceeds this size.
2339 This threshold is applied when garbage collection happens.
2340 The size is counted as the number of bytes occupied,
2341 which includes both saved text and other data.
2343 undo_threshold = 20000;
2345 DEFVAR_INT ("undo-high-threshold", &undo_high_threshold /*
2346 Don't keep more than this much size of undo information.
2347 A command which pushes past this size is itself forgotten.
2348 This threshold is applied when garbage collection happens.
2349 The size is counted as the number of bytes occupied,
2350 which includes both saved text and other data.
2352 undo_high_threshold = 30000;
2354 DEFVAR_LISP ("inhibit-read-only", &Vinhibit_read_only /*
2355 *Non-nil means disregard read-only status of buffers or characters.
2356 If the value is t, disregard `buffer-read-only' and all `read-only'
2357 text properties. If the value is a list, disregard `buffer-read-only'
2358 and disregard a `read-only' extent property or text property if the
2359 property value is a member of the list.
2361 Vinhibit_read_only = Qnil;
2363 DEFVAR_LISP ("kill-buffer-query-functions", &Vkill_buffer_query_functions /*
2364 List of functions called with no args to query before killing a buffer.
2366 Vkill_buffer_query_functions = Qnil;
2368 DEFVAR_BOOL ("delete-auto-save-files", &delete_auto_save_files /*
2369 *Non-nil means delete auto-save file when a buffer is saved or killed.
2371 delete_auto_save_files = 1;
2374 /* The docstrings for DEFVAR_* are recorded externally by make-docfile. */
2376 /* Renamed from DEFVAR_PER_BUFFER because FSFmacs D_P_B takes
2377 a bogus extra arg, which confuses an otherwise identical make-docfile.c */
2378 #define DEFVAR_BUFFER_LOCAL_1(lname, field_name, forward_type, magicfun) do { \
2379 static const struct symbol_value_forward I_hate_C = \
2380 { /* struct symbol_value_forward */ \
2381 { /* struct symbol_value_magic */ \
2382 { /* struct lcrecord_header */ \
2383 { /* struct lrecord_header */ \
2384 lrecord_type_symbol_value_forward, /* lrecord_type_index */ \
2386 1, /* c_readonly bit */ \
2387 1 /* lisp_readonly bit */ \
2393 &(buffer_local_flags.field_name), \
2400 int offset = ((char *)symbol_value_forward_forward (&I_hate_C) - \
2401 (char *)&buffer_local_flags); \
2402 defvar_magic (lname, &I_hate_C); \
2404 *((Lisp_Object *)(offset + (char *)XBUFFER (Vbuffer_local_symbols))) \
2409 #define DEFVAR_BUFFER_LOCAL_MAGIC(lname, field_name, magicfun) \
2410 DEFVAR_BUFFER_LOCAL_1 (lname, field_name, \
2411 SYMVAL_CURRENT_BUFFER_FORWARD, magicfun)
2412 #define DEFVAR_BUFFER_LOCAL(lname, field_name) \
2413 DEFVAR_BUFFER_LOCAL_MAGIC (lname, field_name, 0)
2414 #define DEFVAR_CONST_BUFFER_LOCAL_MAGIC(lname, field_name, magicfun) \
2415 DEFVAR_BUFFER_LOCAL_1 (lname, field_name, \
2416 SYMVAL_CONST_CURRENT_BUFFER_FORWARD, magicfun)
2417 #define DEFVAR_CONST_BUFFER_LOCAL(lname, field_name) \
2418 DEFVAR_CONST_BUFFER_LOCAL_MAGIC (lname, field_name, 0)
2420 #define DEFVAR_BUFFER_DEFAULTS_MAGIC(lname, field_name, magicfun) \
2421 DEFVAR_SYMVAL_FWD (lname, &(buffer_local_flags.field_name), \
2422 SYMVAL_DEFAULT_BUFFER_FORWARD, magicfun)
2423 #define DEFVAR_BUFFER_DEFAULTS(lname, field_name) \
2424 DEFVAR_BUFFER_DEFAULTS_MAGIC (lname, field_name, 0)
2427 nuke_all_buffer_slots (struct buffer *b, Lisp_Object zap)
2431 b->extent_info = Qnil;
2432 b->indirect_children = Qnil;
2433 b->own_text.line_number_cache = Qnil;
2435 #define MARKED_SLOT(x) b->x = zap
2436 #include "bufslots.h"
2441 common_init_complex_vars_of_buffer (void)
2443 /* Make sure all markable slots in buffer_defaults
2444 are initialized reasonably, so mark_buffer won't choke. */
2445 struct buffer *defs = alloc_lcrecord_type (struct buffer, &lrecord_buffer);
2446 struct buffer *syms = alloc_lcrecord_type (struct buffer, &lrecord_buffer);
2448 staticpro_nodump (&Vbuffer_defaults);
2449 staticpro_nodump (&Vbuffer_local_symbols);
2450 XSETBUFFER (Vbuffer_defaults, defs);
2451 XSETBUFFER (Vbuffer_local_symbols, syms);
2453 nuke_all_buffer_slots (syms, Qnil);
2454 nuke_all_buffer_slots (defs, Qnil);
2455 defs->text = &defs->own_text;
2456 syms->text = &syms->own_text;
2458 /* Set up the non-nil default values of various buffer slots.
2459 Must do these before making the first buffer. */
2460 defs->major_mode = Qfundamental_mode;
2461 defs->mode_name = QSFundamental;
2462 defs->abbrev_table = Qnil; /* real default setup by Lisp code */
2464 defs->downcase_table = Vascii_downcase_table;
2465 defs->upcase_table = Vascii_upcase_table;
2466 defs->case_canon_table = Vascii_canon_table;
2467 defs->case_eqv_table = Vascii_eqv_table;
2469 defs->mirror_downcase_table = Vmirror_ascii_downcase_table;
2470 defs->mirror_upcase_table = Vmirror_ascii_upcase_table;
2471 defs->mirror_case_canon_table = Vmirror_ascii_canon_table;
2472 defs->mirror_case_eqv_table = Vmirror_ascii_eqv_table;
2474 defs->category_table = Vstandard_category_table;
2476 defs->syntax_table = Vstandard_syntax_table;
2477 defs->mirror_syntax_table =
2478 XCHAR_TABLE (Vstandard_syntax_table)->mirror_table;
2479 defs->modeline_format = build_string ("%-"); /* reset in loaddefs.el */
2480 defs->case_fold_search = Qt;
2481 defs->selective_display_ellipses = Qt;
2482 defs->tab_width = make_int (8);
2483 defs->ctl_arrow = Qt;
2484 defs->fill_column = make_int (70);
2485 defs->left_margin = Qzero;
2486 defs->saved_size = Qzero; /* lisp code wants int-or-nil */
2488 defs->auto_save_modified = 0;
2489 defs->auto_save_failure_time = -1;
2490 defs->invisibility_spec = Qt;
2492 defs->indirect_children = Qnil;
2493 syms->indirect_children = Qnil;
2496 /* 0 means var is always local. Default used only at creation.
2497 * -1 means var is always local. Default used only at reset and
2499 * -2 means there's no lisp variable corresponding to this slot
2500 * and the default is only used at creation.
2501 * -3 means no Lisp variable. Default used only at reset and creation.
2502 * >0 is mask. Var is local if ((buffer->local_var_flags & mask) != 0)
2503 * Otherwise default is used.
2505 Lisp_Object always_local_no_default = make_int (0);
2506 Lisp_Object always_local_resettable = make_int (-1);
2507 Lisp_Object resettable = make_int (-3);
2509 /* Assign the local-flags to the slots that have default values.
2510 The local flag is a bit that is used in the buffer
2511 to say that it has its own local value for the slot.
2512 The local flag bits are in the local_var_flags slot of the
2515 nuke_all_buffer_slots (&buffer_local_flags, make_int (-2));
2516 buffer_local_flags.filename = always_local_no_default;
2517 buffer_local_flags.directory = always_local_no_default;
2518 buffer_local_flags.backed_up = always_local_no_default;
2519 buffer_local_flags.saved_size = always_local_no_default;
2520 buffer_local_flags.auto_save_file_name = always_local_no_default;
2521 buffer_local_flags.read_only = always_local_no_default;
2523 buffer_local_flags.major_mode = always_local_resettable;
2524 buffer_local_flags.mode_name = always_local_resettable;
2525 buffer_local_flags.undo_list = always_local_no_default;
2527 buffer_local_flags.mark_active = always_local_resettable;
2529 buffer_local_flags.point_before_scroll = always_local_resettable;
2530 buffer_local_flags.file_truename = always_local_no_default;
2531 buffer_local_flags.invisibility_spec = always_local_resettable;
2532 buffer_local_flags.file_format = always_local_resettable;
2533 buffer_local_flags.generated_modeline_string = always_local_no_default;
2535 buffer_local_flags.keymap = resettable;
2536 buffer_local_flags.downcase_table = resettable;
2537 buffer_local_flags.upcase_table = resettable;
2538 buffer_local_flags.case_canon_table = resettable;
2539 buffer_local_flags.case_eqv_table = resettable;
2540 buffer_local_flags.syntax_table = resettable;
2542 buffer_local_flags.category_table = resettable;
2545 buffer_local_flags.modeline_format = make_int (1<<0);
2546 buffer_local_flags.abbrev_mode = make_int (1<<1);
2547 buffer_local_flags.overwrite_mode = make_int (1<<2);
2548 buffer_local_flags.case_fold_search = make_int (1<<3);
2549 buffer_local_flags.auto_fill_function = make_int (1<<4);
2550 buffer_local_flags.selective_display = make_int (1<<5);
2551 buffer_local_flags.selective_display_ellipses = make_int (1<<6);
2552 buffer_local_flags.tab_width = make_int (1<<7);
2553 buffer_local_flags.truncate_lines = make_int (1<<8);
2554 buffer_local_flags.ctl_arrow = make_int (1<<9);
2555 buffer_local_flags.fill_column = make_int (1<<10);
2556 buffer_local_flags.left_margin = make_int (1<<11);
2557 buffer_local_flags.abbrev_table = make_int (1<<12);
2558 #ifdef REGION_CACHE_NEEDS_WORK
2559 buffer_local_flags.cache_long_line_scans = make_int (1<<13);
2562 buffer_local_flags.buffer_file_coding_system = make_int (1<<14);
2565 /* #### Warning: 1<<31 is the largest number currently allowable
2566 due to the XINT() handling of this value. With some
2567 rearrangement you can get 3 more bits. */
2571 #define BUFFER_SLOTS_SIZE (offsetof (struct buffer, BUFFER_SLOTS_LAST_NAME) - offsetof (struct buffer, BUFFER_SLOTS_FIRST_NAME) + sizeof (Lisp_Object))
2572 #define BUFFER_SLOTS_COUNT (BUFFER_SLOTS_SIZE / sizeof (Lisp_Object))
2575 reinit_complex_vars_of_buffer (void)
2577 struct buffer *defs, *syms;
2579 common_init_complex_vars_of_buffer ();
2581 defs = XBUFFER (Vbuffer_defaults);
2582 syms = XBUFFER (Vbuffer_local_symbols);
2583 memcpy (&defs->BUFFER_SLOTS_FIRST_NAME,
2584 buffer_defaults_saved_slots,
2586 memcpy (&syms->BUFFER_SLOTS_FIRST_NAME,
2587 buffer_local_symbols_saved_slots,
2592 static const struct lrecord_description buffer_slots_description_1[] = {
2593 { XD_LISP_OBJECT_ARRAY, 0, BUFFER_SLOTS_COUNT },
2597 static const struct struct_description buffer_slots_description = {
2599 buffer_slots_description_1
2603 complex_vars_of_buffer (void)
2605 struct buffer *defs, *syms;
2607 common_init_complex_vars_of_buffer ();
2609 defs = XBUFFER (Vbuffer_defaults);
2610 syms = XBUFFER (Vbuffer_local_symbols);
2611 buffer_defaults_saved_slots = &defs->BUFFER_SLOTS_FIRST_NAME;
2612 buffer_local_symbols_saved_slots = &syms->BUFFER_SLOTS_FIRST_NAME;
2613 dumpstruct (&buffer_defaults_saved_slots, &buffer_slots_description);
2614 dumpstruct (&buffer_local_symbols_saved_slots, &buffer_slots_description);
2616 DEFVAR_BUFFER_DEFAULTS ("default-modeline-format", modeline_format /*
2617 Default value of `modeline-format' for buffers that don't override it.
2618 This is the same as (default-value 'modeline-format).
2621 DEFVAR_BUFFER_DEFAULTS ("default-abbrev-mode", abbrev_mode /*
2622 Default value of `abbrev-mode' for buffers that do not override it.
2623 This is the same as (default-value 'abbrev-mode).
2626 DEFVAR_BUFFER_DEFAULTS ("default-ctl-arrow", ctl_arrow /*
2627 Default value of `ctl-arrow' for buffers that do not override it.
2628 This is the same as (default-value 'ctl-arrow).
2631 #if 0 /* #### make this a specifier! */
2632 DEFVAR_BUFFER_DEFAULTS ("default-display-direction", display_direction /*
2633 Default display-direction for buffers that do not override it.
2634 This is the same as (default-value 'display-direction).
2635 Note: This is not yet implemented.
2639 DEFVAR_BUFFER_DEFAULTS ("default-truncate-lines", truncate_lines /*
2640 Default value of `truncate-lines' for buffers that do not override it.
2641 This is the same as (default-value 'truncate-lines).
2644 DEFVAR_BUFFER_DEFAULTS ("default-fill-column", fill_column /*
2645 Default value of `fill-column' for buffers that do not override it.
2646 This is the same as (default-value 'fill-column).
2649 DEFVAR_BUFFER_DEFAULTS ("default-left-margin", left_margin /*
2650 Default value of `left-margin' for buffers that do not override it.
2651 This is the same as (default-value 'left-margin).
2654 DEFVAR_BUFFER_DEFAULTS ("default-tab-width", tab_width /*
2655 Default value of `tab-width' for buffers that do not override it.
2656 This is the same as (default-value 'tab-width).
2659 DEFVAR_BUFFER_DEFAULTS ("default-case-fold-search", case_fold_search /*
2660 Default value of `case-fold-search' for buffers that don't override it.
2661 This is the same as (default-value 'case-fold-search).
2664 DEFVAR_BUFFER_LOCAL ("modeline-format", modeline_format /*
2665 Template for displaying modeline for current buffer.
2666 Each buffer has its own value of this variable.
2667 Value may be a string, a symbol or a list or cons cell.
2668 For a symbol, its value is used (but it is ignored if t or nil).
2669 A string appearing directly as the value of a symbol is processed verbatim
2670 in that the %-constructs below are not recognized.
2671 For a glyph, it is inserted as is.
2672 For a list whose car is a symbol, the symbol's value is taken,
2673 and if that is non-nil, the cadr of the list is processed recursively.
2674 Otherwise, the caddr of the list (if there is one) is processed.
2675 For a list whose car is a string or list, each element is processed
2676 recursively and the results are effectively concatenated.
2677 For a list whose car is an integer, the cdr of the list is processed
2678 and padded (if the number is positive) or truncated (if negative)
2679 to the width specified by that number.
2680 For a list whose car is an extent, the cdr of the list is processed
2681 normally but the results are displayed using the face of the
2682 extent, and mouse clicks over this section are processed using the
2683 keymap of the extent. (In addition, if the extent has a help-echo
2684 property, that string will be echoed when the mouse moves over this
2685 section.) See `generated-modeline-string' for more information.
2686 For a list whose car is a face, the cdr of the list is processed
2687 normally but the results will be displayed using the face in the car.
2688 For a list whose car is a keymap, the cdr of the list is processed
2689 normally but the keymap will apply for mouse clicks over the results,
2690 in addition to `modeline-map'. Nested keymap specifications are
2692 A string is printed verbatim in the modeline except for %-constructs:
2693 (%-constructs are processed when the string is the entire modeline-format
2694 or when it is found in a cons-cell or a list)
2695 %b -- print buffer name. %c -- print the current column number.
2696 %f -- print visited file name.
2697 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.
2698 % means buffer is read-only and * means it is modified.
2699 For a modified read-only buffer, %* gives % and %+ gives *.
2700 %s -- print process status. %l -- print the current line number.
2701 %S -- print name of selected frame (only meaningful under X Windows).
2702 %p -- print percent of buffer above top of window, or Top, Bot or All.
2703 %P -- print percent of buffer above bottom of window, perhaps plus Top,
2704 or print Bottom or All.
2705 %n -- print Narrow if appropriate.
2706 %C -- under XEmacs/mule, print the mnemonic for `buffer-file-coding-system'.
2707 %[ -- print one [ for each recursive editing level. %] similar.
2708 %% -- print %. %- -- print infinitely many dashes.
2709 Decimal digits after the % specify field width to which to pad.
2712 DEFVAR_BUFFER_DEFAULTS ("default-major-mode", major_mode /*
2713 *Major mode for new buffers. Defaults to `fundamental-mode'.
2714 nil here means use current buffer's major mode.
2717 DEFVAR_BUFFER_DEFAULTS ("fundamental-mode-abbrev-table", abbrev_table /*
2718 The abbrev table of mode-specific abbrevs for Fundamental Mode.
2721 DEFVAR_BUFFER_LOCAL ("major-mode", major_mode /*
2722 Symbol for current buffer's major mode.
2725 DEFVAR_BUFFER_LOCAL ("mode-name", mode_name /*
2726 Pretty name of current buffer's major mode (a string).
2729 DEFVAR_BUFFER_LOCAL ("abbrev-mode", abbrev_mode /*
2730 Non-nil turns on automatic expansion of abbrevs as they are inserted.
2731 Automatically becomes buffer-local when set in any fashion.
2734 DEFVAR_BUFFER_LOCAL ("case-fold-search", case_fold_search /*
2735 *Non-nil if searches should ignore case.
2736 Automatically becomes buffer-local when set in any fashion.
2738 BUG: Under XEmacs/Mule, translations to or from non-ASCII characters
2739 (this includes chars in the range 128 - 255) are ignored by
2740 the string/buffer-searching routines. Thus, `case-fold-search'
2741 will not correctly conflate a-umlaut and A-umlaut even if the
2742 case tables call for this.
2745 DEFVAR_BUFFER_LOCAL ("fill-column", fill_column /*
2746 *Column beyond which automatic line-wrapping should happen.
2747 Automatically becomes buffer-local when set in any fashion.
2750 DEFVAR_BUFFER_LOCAL ("left-margin", left_margin /*
2751 *Column for the default indent-line-function to indent to.
2752 Linefeed indents to this column in Fundamental mode.
2753 Automatically becomes buffer-local when set in any fashion.
2754 Do not confuse this with the specifier `left-margin-width';
2755 that controls the size of a margin that is displayed outside
2759 DEFVAR_BUFFER_LOCAL_MAGIC ("tab-width", tab_width /*
2760 *Distance between tab stops (for display of tab characters), in columns.
2761 Automatically becomes buffer-local when set in any fashion.
2762 */ , redisplay_variable_changed);
2764 DEFVAR_BUFFER_LOCAL_MAGIC ("ctl-arrow", ctl_arrow /*
2765 *Non-nil means display control chars with uparrow.
2766 Nil means use backslash and octal digits.
2767 An integer means characters >= ctl-arrow are assumed to be printable, and
2768 will be displayed as a single glyph.
2769 Any other value is the same as 160 - the code SPC with the high bit on.
2771 The interpretation of this variable is likely to change in the future.
2773 Automatically becomes buffer-local when set in any fashion.
2774 This variable does not apply to characters whose display is specified
2775 in the current display table (if there is one).
2776 */ , redisplay_variable_changed);
2778 #if 0 /* #### Make this a specifier! */
2779 xxDEFVAR_BUFFER_LOCAL ("display-direction", display_direction /*
2780 *Non-nil means lines in the buffer are displayed right to left.
2781 Nil means left to right. (Not yet implemented.)
2783 #endif /* Not yet implemented */
2785 DEFVAR_BUFFER_LOCAL_MAGIC ("truncate-lines", truncate_lines /*
2786 *Non-nil means do not display continuation lines;
2787 give each line of text one frame line.
2788 Automatically becomes buffer-local when set in any fashion.
2790 Note that this is overridden by the variable
2791 `truncate-partial-width-windows' if that variable is non-nil
2792 and this buffer is not full-frame width.
2793 */ , redisplay_variable_changed);
2795 DEFVAR_BUFFER_LOCAL ("default-directory", directory /*
2796 Name of default directory of current buffer. Should end with slash.
2797 Each buffer has its own value of this variable.
2801 DEFVAR_BUFFER_DEFAULTS ("default-buffer-file-coding-system", buffer_file_coding_system /*
2802 Default value of `buffer-file-coding-system' for buffers that do not override it.
2803 This is the same as (default-value 'buffer-file-coding-system).
2804 This value is used both for buffers without associated files and
2805 for buffers whose files do not have any apparent coding system.
2806 See `buffer-file-coding-system'.
2809 DEFVAR_BUFFER_LOCAL ("buffer-file-coding-system", buffer_file_coding_system /*
2810 *Current coding system for the current buffer.
2811 When the buffer is written out into a file, this coding system will be
2812 used for the encoding. Automatically buffer-local when set in any
2813 fashion. This is normally set automatically when a file is loaded in
2814 based on the determined coding system of the file (assuming that
2815 `buffer-file-coding-system-for-read' is set to `undecided', which
2816 calls for automatic determination of the file's coding system).
2817 Normally the modeline indicates the current file coding system using
2818 its mnemonic abbreviation.
2820 The default value for this variable (which is normally used for
2821 buffers without associated files) is also used when automatic
2822 detection of a file's encoding is called for and there was no
2823 discernible encoding in the file (i.e. it was entirely or almost
2824 entirely ASCII). The default value should generally *not* be set to
2825 nil (equivalent to `no-conversion'), because if extended characters
2826 are ever inserted into the buffer, they will be lost when the file is
2827 written out. A good choice is `iso-2022-8' (the simple ISO 2022 8-bit
2828 encoding), which will write out ASCII and Latin-1 characters in the
2829 standard (and highly portable) fashion and use standard escape
2830 sequences for other charsets. Another reasonable choice is
2831 `escape-quoted', which is equivalent to `iso-2022-8' but prefixes
2832 certain control characters with ESC to make sure they are not
2833 interpreted as escape sequences when read in. This latter coding
2834 system results in more "correct" output in the presence of control
2835 characters in the buffer, in the sense that when read in again using
2836 the same coding system, the result will virtually always match the
2837 original contents of the buffer, which is not the case with
2838 `iso-2022-8'; but the output is less portable when dealing with binary
2839 data -- there may be stray ESC characters when the file is read by
2842 `buffer-file-coding-system' does *not* control the coding system used when
2843 a file is read in. Use the variables `buffer-file-coding-system-for-read'
2844 and `buffer-file-coding-system-alist' for that. From a Lisp program, if
2845 you wish to unilaterally specify the coding system used for one
2846 particular operation, you should bind the variable
2847 `coding-system-for-read' rather than changing the other two
2848 variables just mentioned, which are intended to be used for
2849 global environment specification.
2851 #endif /* FILE_CODING */
2853 DEFVAR_BUFFER_LOCAL ("auto-fill-function", auto_fill_function /*
2854 Function called (if non-nil) to perform auto-fill.
2855 It is called after self-inserting a space at a column beyond `fill-column'.
2856 Each buffer has its own value of this variable.
2857 NOTE: This variable is not an ordinary hook;
2858 It may not be a list of functions.
2861 DEFVAR_BUFFER_LOCAL ("buffer-file-name", filename /*
2862 Name of file visited in current buffer, or nil if not visiting a file.
2863 Each buffer has its own value of this variable.
2868 Abbreviated truename of file visited in current buffer, or nil if none.
2869 The truename of a file is calculated by `file-truename'
2870 and then abbreviated with `abbreviate-file-name'.
2871 Each buffer has its own value of this variable.
2873 #endif /* FSFmacs */
2875 DEFVAR_BUFFER_LOCAL ("buffer-file-truename", file_truename /*
2876 The real name of the file visited in the current buffer,
2877 or nil if not visiting a file. This is the result of passing
2878 buffer-file-name to the `file-truename' function. Every buffer has
2879 its own value of this variable. This variable is automatically
2880 maintained by the functions that change the file name associated
2884 DEFVAR_BUFFER_LOCAL ("buffer-auto-save-file-name", auto_save_file_name /*
2885 Name of file for auto-saving current buffer,
2886 or nil if buffer should not be auto-saved.
2887 Each buffer has its own value of this variable.
2890 DEFVAR_BUFFER_LOCAL ("buffer-read-only", read_only /*
2891 Non-nil if this buffer is read-only.
2892 Each buffer has its own value of this variable.
2895 DEFVAR_BUFFER_LOCAL ("buffer-backed-up", backed_up /*
2896 Non-nil if this buffer's file has been backed up.
2897 Backing up is done before the first time the file is saved.
2898 Each buffer has its own value of this variable.
2901 DEFVAR_BUFFER_LOCAL ("buffer-saved-size", saved_size /*
2902 Length of current buffer when last read in, saved or auto-saved.
2904 Each buffer has its own value of this variable.
2907 DEFVAR_BUFFER_LOCAL_MAGIC ("selective-display", selective_display /*
2908 Non-nil enables selective display:
2909 Integer N as value means display only lines
2910 that start with less than n columns of space.
2911 A value of t means, after a ^M, all the rest of the line is invisible.
2912 Then ^M's in the file are written into files as newlines.
2914 Automatically becomes buffer-local when set in any fashion.
2915 */, redisplay_variable_changed);
2918 DEFVAR_BUFFER_LOCAL_MAGIC ("selective-display-ellipses",
2919 selective_display_ellipses /*
2920 t means display ... on previous line when a line is invisible.
2921 Automatically becomes buffer-local when set in any fashion.
2922 */, redisplay_variable_changed);
2925 DEFVAR_BUFFER_LOCAL ("local-abbrev-table", abbrev_table /*
2926 Local (mode-specific) abbrev table of current buffer.
2929 DEFVAR_BUFFER_LOCAL ("overwrite-mode", overwrite_mode /*
2930 Non-nil if self-insertion should replace existing text.
2931 The value should be one of `overwrite-mode-textual',
2932 `overwrite-mode-binary', or nil.
2933 If it is `overwrite-mode-textual', self-insertion still
2934 inserts at the end of a line, and inserts when point is before a tab,
2935 until the tab is filled in.
2936 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too.
2937 Automatically becomes buffer-local when set in any fashion.
2939 Normally, you shouldn't modify this variable by hand, but use the functions
2940 `overwrite-mode' and `binary-overwrite-mode' instead. However, you can
2941 customize the default value from the options menu.
2945 /* Adds the following to the doc string for buffer-undo-list:
2947 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property
2948 was modified between BEG and END. PROPERTY is the property name,
2949 and VALUE is the old value.
2951 #endif /* FSFmacs */
2953 DEFVAR_BUFFER_LOCAL ("buffer-undo-list", undo_list /*
2954 List of undo entries in current buffer.
2955 Recent changes come first; older changes follow newer.
2957 An entry (BEG . END) represents an insertion which begins at
2958 position BEG and ends at position END.
2960 An entry (TEXT . POSITION) represents the deletion of the string TEXT
2961 from (abs POSITION). If POSITION is positive, point was at the front
2962 of the text being deleted; if negative, point was at the end.
2964 An entry (t HIGH . LOW) indicates that the buffer previously had
2965 "unmodified" status. HIGH and LOW are the high and low 16-bit portions
2966 of the visited file's modification time, as of that time. If the
2967 modification time of the most recent save is different, this entry is
2970 An entry of the form EXTENT indicates that EXTENT was attached in
2971 the buffer. Undoing an entry of this form detaches EXTENT.
2973 An entry of the form (EXTENT START END) indicates that EXTENT was
2974 detached from the buffer. Undoing an entry of this form attaches
2975 EXTENT from START to END.
2977 An entry of the form POSITION indicates that point was at the buffer
2978 location given by the integer. Undoing an entry of this form places
2981 nil marks undo boundaries. The undo command treats the changes
2982 between two undo boundaries as a single step to be undone.
2984 If the value of the variable is t, undo information is not recorded.
2988 xxDEFVAR_BUFFER_LOCAL ("mark-active", mark_active /*
2989 Non-nil means the mark and region are currently active in this buffer.
2990 Automatically local in all buffers.
2992 #endif /* FSFmacs */
2994 #ifdef REGION_CACHE_NEEDS_WORK
2995 xxDEFVAR_BUFFER_LOCAL ("cache-long-line-scans", cache_long_line_scans /*
2996 Non-nil means that Emacs should use caches to handle long lines more quickly.
2997 This variable is buffer-local, in all buffers.
2999 Normally, the line-motion functions work by scanning the buffer for
3000 newlines. Columnar operations (like move-to-column and
3001 compute-motion) also work by scanning the buffer, summing character
3002 widths as they go. This works well for ordinary text, but if the
3003 buffer's lines are very long (say, more than 500 characters), these
3004 motion functions will take longer to execute. Emacs may also take
3005 longer to update the display.
3007 If cache-long-line-scans is non-nil, these motion functions cache the
3008 results of their scans, and consult the cache to avoid rescanning
3009 regions of the buffer until the text is modified. The caches are most
3010 beneficial when they prevent the most searching---that is, when the
3011 buffer contains long lines and large regions of characters with the
3012 same, fixed screen width.
3014 When cache-long-line-scans is non-nil, processing short lines will
3015 become slightly slower (because of the overhead of consulting the
3016 cache), and the caches will use memory roughly proportional to the
3017 number of newlines and characters whose screen width varies.
3019 The caches require no explicit maintenance; their accuracy is
3020 maintained internally by the Emacs primitives. Enabling or disabling
3021 the cache should not affect the behavior of any of the motion
3022 functions; it should only affect their performance.
3024 #endif /* REGION_CACHE_NEEDS_WORK */
3026 DEFVAR_BUFFER_LOCAL ("point-before-scroll", point_before_scroll /*
3027 Value of point before the last series of scroll operations, or nil.
3030 DEFVAR_BUFFER_LOCAL ("buffer-file-format", file_format /*
3031 List of formats to use when saving this buffer.
3032 Formats are defined by `format-alist'. This variable is
3033 set when a file is visited. Automatically local in all buffers.
3036 DEFVAR_BUFFER_LOCAL_MAGIC ("buffer-invisibility-spec", invisibility_spec /*
3037 Invisibility spec of this buffer.
3038 The default is t, which means that text is invisible
3039 if it has (or is covered by an extent with) a non-nil `invisible' property.
3040 If the value is a list, a text character is invisible if its `invisible'
3041 property is an element in that list.
3042 If an element is a cons cell of the form (PROP . ELLIPSIS),
3043 then characters with property value PROP are invisible,
3044 and they have an ellipsis as well if ELLIPSIS is non-nil.
3045 Note that the actual characters used for the ellipsis are controllable
3046 using `invisible-text-glyph', and default to "...".
3047 */, redisplay_variable_changed);
3049 DEFVAR_CONST_BUFFER_LOCAL ("generated-modeline-string",
3050 generated_modeline_string /*
3051 String of characters in this buffer's modeline as of the last redisplay.
3052 Each time the modeline is recomputed, the resulting characters are
3053 stored in this string, which is resized as necessary. You may not
3054 set this variable, and modifying this string will not change the
3055 modeline; you have to change `modeline-format' if you want that.
3057 For each extent in `modeline-format' that is encountered when
3058 processing the modeline, a corresponding extent is placed in
3059 `generated-modeline-string' and covers the text over which the
3060 extent in `modeline-format' applies. The extent in
3061 `generated-modeline-string' is made a child of the extent in
3062 `modeline-format', which means that it inherits all properties from
3063 that extent. Note that the extents in `generated-modeline-string'
3064 are managed automatically. You should not explicitly put any extents
3065 in `generated-modeline-string'; if you do, they will disappear the
3066 next time the modeline is processed.
3068 For extents in `modeline-format', the following properties are currently
3072 Affects the face of the modeline text. Currently, faces do
3073 not merge properly; only the most recently encountered face
3074 is used. This is a bug.
3077 Affects the disposition of button events over the modeline
3078 text. Multiple applicable keymaps *are* handled properly,
3079 and `modeline-map' still applies to any events that don't
3080 have bindings in extent-specific keymaps.
3083 If a string, causes the string to be displayed when the mouse
3084 moves over the text.
3087 /* Check for DEFVAR_BUFFER_LOCAL without initializing the corresponding
3088 slot of buffer_local_flags and vice-versa. Must be done after all
3089 DEFVAR_BUFFER_LOCAL() calls. */
3090 #define MARKED_SLOT(slot) \
3091 if ((XINT (buffer_local_flags.slot) != -2 && \
3092 XINT (buffer_local_flags.slot) != -3) \
3093 != !(NILP (XBUFFER (Vbuffer_local_symbols)->slot))) \
3095 #include "bufslots.h"
3099 Lisp_Object scratch = Fget_buffer_create (QSscratch);
3100 Fset_buffer (scratch);
3101 /* Want no undo records for *scratch* until after Emacs is dumped */
3102 Fbuffer_disable_undo (scratch);
3106 /* Is PWD another name for `.' ? */
3108 directory_is_current_directory (Extbyte *pwd)
3110 Bufbyte *pwd_internal;
3111 Bytecount pwd_internal_len;
3112 struct stat dotstat, pwdstat;
3114 TO_INTERNAL_FORMAT (DATA, (pwd, strlen ((char *)pwd) + 1),
3115 ALLOCA, (pwd_internal, pwd_internal_len),
3118 return (IS_DIRECTORY_SEP (*pwd_internal)
3119 && stat ((char *) pwd_internal, &pwdstat) == 0
3120 && stat (".", &dotstat) == 0
3121 && dotstat.st_ino == pwdstat.st_ino
3122 && dotstat.st_dev == pwdstat.st_dev
3123 && pwd_internal_len < MAXPATHLEN);
3127 init_initial_directory (void)
3129 /* This function can GC */
3133 initial_directory[0] = 0;
3135 /* If PWD is accurate, use it instead of calling getcwd. This is faster
3136 when PWD is right, and may avoid a fatal error. */
3137 if ((pwd = (Extbyte *) getenv ("PWD")) != NULL
3138 && directory_is_current_directory (pwd))
3139 strcpy (initial_directory, (char *) pwd);
3140 else if (getcwd (initial_directory, MAXPATHLEN) == NULL)
3141 fatal ("`getcwd' failed: %s\n", strerror (errno));
3143 /* Make sure pwd is DIRECTORY_SEP-terminated.
3144 Maybe this should really use some standard subroutine
3145 whose definition is filename syntax dependent. */
3147 int len = strlen (initial_directory);
3149 if (! IS_DIRECTORY_SEP (initial_directory[len - 1]))
3151 initial_directory[len] = DIRECTORY_SEP;
3152 initial_directory[len + 1] = '\0';
3156 /* XEmacs change: store buffer's default directory
3157 using preferred (i.e. as defined at compile-time)
3158 directory separator. --marcpa */
3160 #define CORRECT_DIR_SEPS(s) \
3161 do { if ('/' == DIRECTORY_SEP) dostounix_filename (s); \
3162 else unixtodos_filename (s); \
3165 CORRECT_DIR_SEPS(initial_directory);
3172 /* This function can GC */
3174 Fset_buffer (Fget_buffer_create (QSscratch));
3176 current_buffer->directory =
3177 build_ext_string (initial_directory, Qfile_name);
3180 /* #### is this correct? */
3181 temp = get_minibuffer (0);
3182 XBUFFER (temp)->directory = current_buffer->directory;
3183 #endif /* FSFmacs */