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.
79 #include "file-coding.h"
84 #include "process.h" /* for kill_buffer_processes */
85 #ifdef REGION_CACHE_NEEDS_WORK
86 #include "region-cache.h"
88 #include "select.h" /* for select_notify_buffer_kill */
89 #include "specifier.h"
91 #include "sysdep.h" /* for getwd */
96 struct buffer *current_buffer; /* the current buffer */
98 /* This structure holds the default values of the buffer-local variables
99 defined with DEFVAR_BUFFER_LOCAL, that have special slots in each buffer.
100 The default value occupies the same slot in this structure
101 as an individual buffer's value occupies in that buffer.
102 Setting the default value also goes through the alist of buffers
103 and stores into each buffer that does not say it has a local value. */
104 Lisp_Object Vbuffer_defaults;
105 static void *buffer_defaults_saved_slots;
107 /* This structure marks which slots in a buffer have corresponding
108 default values in Vbuffer_defaults.
109 Each such slot has a nonzero value in this structure.
110 The value has only one nonzero bit.
112 When a buffer has its own local value for a slot,
113 the bit for that slot (found in the same slot in this structure)
114 is turned on in the buffer's local_var_flags slot.
116 If a slot in this structure is 0, then there is a DEFVAR_BUFFER_LOCAL
117 for the slot, but there is no default value for it; the corresponding
118 slot in Vbuffer_defaults is not used except to initialize newly-created
121 If a slot is -1, then there is a DEFVAR_BUFFER_LOCAL for it
122 as well as a default value which is used to initialize newly-created
123 buffers and as a reset-value when local-vars are killed.
125 If a slot is -2, there is no DEFVAR_BUFFER_LOCAL for it.
126 (The slot is always local, but there's no lisp variable for it.)
127 The default value is only used to initialize newly-creation buffers.
129 If a slot is -3, then there is no DEFVAR_BUFFER_LOCAL for it but
130 there is a default which is used to initialize newly-creation
131 buffers and as a reset-value when local-vars are killed. */
132 struct buffer buffer_local_flags;
134 /* This is the initial (startup) directory, as used for the *scratch* buffer.
135 We're making this a global to make others aware of the startup directory.
136 `initial_directory' is stored in external format.
138 char initial_directory[MAXPATHLEN+1];
140 /* This structure holds the names of symbols whose values may be
141 buffer-local. It is indexed and accessed in the same way as the above. */
142 static Lisp_Object Vbuffer_local_symbols;
143 static void *buffer_local_symbols_saved_slots;
145 /* Alist of all buffer names vs the buffers. */
146 /* This used to be a variable, but is no longer,
147 to prevent lossage due to user rplac'ing this alist or its elements.
148 Note that there is a per-frame copy of this as well; the frame slot
149 and the global variable contain the same data, but possibly in different
150 orders, so that the buffer ordering can be per-frame.
152 Lisp_Object Vbuffer_alist;
154 /* Functions to call before and after each text change. */
155 Lisp_Object Qbefore_change_functions;
156 Lisp_Object Qafter_change_functions;
157 Lisp_Object Vbefore_change_functions;
158 Lisp_Object Vafter_change_functions;
160 /* #### Obsolete, for compatibility */
161 Lisp_Object Qbefore_change_function;
162 Lisp_Object Qafter_change_function;
163 Lisp_Object Vbefore_change_function;
164 Lisp_Object Vafter_change_function;
167 Lisp_Object Vtransient_mark_mode;
170 /* t means ignore all read-only text properties.
171 A list means ignore such a property if its value is a member of the list.
172 Any non-nil value means ignore buffer-read-only. */
173 Lisp_Object Vinhibit_read_only;
175 /* List of functions to call that can query about killing a buffer.
176 If any of these functions returns nil, we don't kill it. */
177 Lisp_Object Vkill_buffer_query_functions;
179 /* Non-nil means delete a buffer's auto-save file when the buffer is saved. */
180 int delete_auto_save_files;
182 Lisp_Object Qbuffer_live_p;
183 Lisp_Object Qbuffer_or_string_p;
185 /* List of functions to call before changing an unmodified buffer. */
186 Lisp_Object Vfirst_change_hook;
187 Lisp_Object Qfirst_change_hook;
189 Lisp_Object Qfundamental_mode;
190 Lisp_Object Qmode_class;
191 Lisp_Object Qpermanent_local;
193 Lisp_Object Qprotected_field;
195 Lisp_Object QSFundamental; /* A string "Fundamental" */
196 Lisp_Object QSscratch; /* "*scratch*" */
197 Lisp_Object Qdefault_directory;
199 Lisp_Object Qkill_buffer_hook;
201 Lisp_Object Qrename_auto_save_file;
203 Lisp_Object Qget_file_buffer;
204 Lisp_Object Qchange_major_mode_hook, Vchange_major_mode_hook;
206 Lisp_Object Qfind_file_compare_truenames;
208 Lisp_Object Qswitch_to_buffer;
210 /* Two thresholds controlling how much undo information to keep. */
211 Fixnum undo_threshold;
212 Fixnum undo_high_threshold;
214 int find_file_compare_truenames;
215 int find_file_use_truenames;
218 static void reset_buffer_local_variables (struct buffer *, int first_time);
219 static void nuke_all_buffer_slots (struct buffer *b, Lisp_Object zap);
222 make_buffer (struct buffer *buf)
225 XSETBUFFER (obj, buf);
230 mark_buffer (Lisp_Object obj)
232 struct buffer *buf = XBUFFER (obj);
234 /* Truncate undo information. */
235 buf->undo_list = truncate_undo_list (buf->undo_list,
237 undo_high_threshold);
239 #define MARKED_SLOT(x) mark_object (buf->x)
240 #include "bufslots.h"
243 mark_object (buf->extent_info);
245 mark_object (buf->text->line_number_cache);
247 /* Don't mark normally through the children slot.
248 (Actually, in this case, it doesn't matter.) */
249 if (! EQ (buf->indirect_children, Qnull_pointer))
250 mark_conses_in_list (buf->indirect_children);
252 return buf->base_buffer ? make_buffer (buf->base_buffer) : Qnil;
256 print_buffer (Lisp_Object obj, Lisp_Object printcharfun, int escapeflag)
258 struct buffer *b = XBUFFER (obj);
262 if (!BUFFER_LIVE_P (b))
263 error ("printing unreadable object #<killed buffer>");
265 error ("printing unreadable object #<buffer %s>",
266 XSTRING_DATA (b->name));
268 else if (!BUFFER_LIVE_P (b))
269 write_c_string ("#<killed buffer>", printcharfun);
272 write_c_string ("#<buffer ", printcharfun);
273 print_internal (b->name, printcharfun, 1);
274 write_c_string (">", printcharfun);
278 print_internal (b->name, printcharfun, 0);
282 /* We do not need a finalize method to handle a buffer's children list
283 because all buffers have `kill-buffer' applied to them before
284 they disappear, and the children removal happens then. */
285 DEFINE_LRECORD_IMPLEMENTATION ("buffer", buffer,
286 mark_buffer, print_buffer, 0, 0, 0, 0,
289 DEFUN ("bufferp", Fbufferp, 1, 1, 0, /*
290 Return t if OBJECT is an editor buffer.
294 return BUFFERP (object) ? Qt : Qnil;
297 DEFUN ("buffer-live-p", Fbuffer_live_p, 1, 1, 0, /*
298 Return t if OBJECT is an editor buffer that has not been deleted.
302 return BUFFERP (object) && BUFFER_LIVE_P (XBUFFER (object)) ? Qt : Qnil;
306 nsberror (Lisp_Object spec)
309 error ("No buffer named %s", XSTRING_DATA (spec));
310 signal_simple_error ("Invalid buffer argument", spec);
313 DEFUN ("buffer-list", Fbuffer_list, 0, 1, 0, /*
314 Return a list of all existing live buffers.
315 The order is specific to the selected frame; if the optional FRAME
316 argument is provided, the ordering for that frame is returned instead.
317 If the FRAME argument is t, then the global (non-frame) ordering is
322 return Fmapcar (Qcdr,
323 EQ (frame, Qt) ? Vbuffer_alist :
324 decode_frame (frame)->buffer_alist);
328 get_buffer (Lisp_Object name, int error_if_deleted_or_does_not_exist)
332 if (!BUFFER_LIVE_P (XBUFFER (name)))
334 if (error_if_deleted_or_does_not_exist)
346 name = LISP_GETTEXT (name); /* I18N3 */
348 buf = Fcdr (Fassoc (name, Vbuffer_alist));
350 if (NILP (buf) && error_if_deleted_or_does_not_exist)
357 decode_buffer (Lisp_Object buffer, int allow_string)
359 if (NILP (buffer) || (!POINTER_TYPE_P( XTYPE(buffer))))
360 return current_buffer;
362 if (allow_string && STRINGP (buffer))
363 return XBUFFER (get_buffer (buffer, 1));
365 CHECK_LIVE_BUFFER (buffer);
366 return XBUFFER (buffer);
369 DEFUN ("decode-buffer", Fdecode_buffer, 1, 1, 0, /*
370 Validate BUFFER or if BUFFER is nil, return the current buffer.
371 If BUFFER is a valid buffer or a string representing a valid buffer,
372 the corresponding buffer object will be returned. Otherwise an error
377 struct buffer *b = decode_buffer (buffer, 1);
378 XSETBUFFER (buffer, b);
384 /* Like Fassoc, but use Fstring_equal to compare
385 (which ignores text properties),
386 and don't ever QUIT. */
389 assoc_ignore_text_properties (REGISTER Lisp_Object key, Lisp_Object list)
391 REGISTER Lisp_Object tail;
392 for (tail = list; !NILP (tail); tail = Fcdr (tail))
394 REGISTER Lisp_Object elt, tem;
396 tem = Fstring_equal (Fcar (elt), key);
405 DEFUN ("get-buffer", Fget_buffer, 1, 1, 0, /*
406 Return the buffer named BUFFER-NAME (a string), or nil if there is none.
407 BUFFER-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. */
418 if (BUFFERP (buffer_name))
420 return get_buffer (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 and fixed 7-11-2000 ben. */
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 /* Formerly the two calls below were combined, but that is
478 not GC-safe because the first call returns unprotected
479 data and the second call can GC. --ben */
480 fn = Ffile_name_nondirectory (filename);
481 fn = Fexpand_file_name (fn, dn);
488 LIST_LOOP_2 (elt, Vbuffer_alist)
491 if (!BUFFERP (buf)) continue;
492 if (!STRINGP (XBUFFER (buf)->filename)) continue;
493 if (!NILP (Fstring_equal (filename,
494 (find_file_compare_truenames
495 ? XBUFFER (buf)->file_truename
496 : XBUFFER (buf)->filename))))
505 push_buffer_alist (Lisp_Object name, Lisp_Object buf)
507 Lisp_Object cons = Fcons (name, buf);
508 Lisp_Object frmcons, devcons, concons;
510 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (cons, Qnil));
511 FRAME_LOOP_NO_BREAK (frmcons, devcons, concons)
514 f = XFRAME (XCAR (frmcons));
515 f->buffer_alist = nconc2 (f->buffer_alist, Fcons (cons, Qnil));
520 delete_from_buffer_alist (Lisp_Object buf)
522 Lisp_Object cons = Frassq (buf, Vbuffer_alist);
523 Lisp_Object frmcons, devcons, concons;
525 return; /* ABORT() ? */
526 Vbuffer_alist = delq_no_quit (cons, Vbuffer_alist);
528 FRAME_LOOP_NO_BREAK (frmcons, devcons, concons)
531 f = XFRAME (XCAR (frmcons));
532 f->buffer_alist = delq_no_quit (cons, f->buffer_alist);
537 get_truename_buffer (REGISTER Lisp_Object filename)
539 /* This function can GC. GC correct 7-11-00 ben */
540 /* FSFmacs has its own code here and doesn't call get-file-buffer.
541 That's because their equivalent of find-file-compare-truenames
542 (find-file-existing-other-name) isn't looked at in get-file-buffer.
543 This way is more correct. */
544 int count = specpdl_depth ();
546 specbind (Qfind_file_compare_truenames, Qt);
547 return unbind_to (count, Fget_file_buffer (filename));
550 static struct buffer *
551 allocate_buffer (void)
553 struct buffer *b = alloc_lcrecord_type (struct buffer, &lrecord_buffer);
555 copy_lcrecord (b, XBUFFER (Vbuffer_defaults));
561 finish_init_buffer (struct buffer *b, Lisp_Object name)
567 name = Fcopy_sequence (name);
568 /* #### This really does not need to be called. We already
569 initialized the buffer-local variables in allocate_buffer().
570 local_var_alist is set to Qnil at the same point, in
571 nuke_all_buffer_slots(). */
572 reset_buffer_local_variables (b, 1);
573 b->directory = current_buffer ? current_buffer->directory : Qnil;
575 b->last_window_start = 1;
578 if (string_byte (XSTRING (name), 0) != ' ')
583 /* initialize the extent list */
584 init_buffer_extents (b);
586 /* Put this in the alist of all live buffers. */
587 push_buffer_alist (name, buf);
589 init_buffer_markers (b);
591 b->generated_modeline_string = Fmake_string (make_int (84), make_int (' '));
592 b->modeline_extent_table = make_lisp_hash_table (20, HASH_TABLE_KEY_WEAK,
598 DEFUN ("get-buffer-create", Fget_buffer_create, 1, 1, 0, /*
599 Return the buffer named NAME, or create such a buffer and return it.
600 A new buffer is created if there is no live buffer named NAME.
601 If NAME starts with a space, the new buffer does not keep undo information.
602 If NAME is a buffer instead of a string, then it is the value returned.
603 The value is never nil.
607 /* This function can GC */
609 REGISTER struct buffer *b;
612 /* #### Doc string should indicate that the buffer name will get
616 name = LISP_GETTEXT (name);
617 buf = Fget_buffer (name);
621 if (XSTRING_LENGTH (name) == 0)
622 error ("Empty string for buffer name is not allowed");
624 b = allocate_buffer ();
626 b->text = &b->own_text;
628 b->indirect_children = Qnil;
629 init_buffer_text (b);
631 return finish_init_buffer (b, name);
634 DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, 2, 2,
635 "bMake indirect buffer (to buffer): \nBName of indirect buffer: ", /*
636 Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
637 BASE-BUFFER should be an existing buffer (or buffer name).
638 NAME should be a string which is not the name of an existing buffer.
640 If BASE-BUFFER is itself an indirect buffer, the base buffer for that buffer
641 is made the base buffer for the newly created buffer. (Thus, there will
642 never be indirect buffers whose base buffers are themselves indirect.)
646 /* This function can GC */
648 /* #### The above interactive specification is totally bogus,
649 because it offers an existing buffer as default answer to the
650 second question. However, the second argument may not BE an
654 base_buffer = get_buffer (base_buffer, 1);
657 /* #### Doc string should indicate that the buffer name will get
661 name = LISP_GETTEXT (name);
662 if (!NILP (Fget_buffer (name)))
663 signal_simple_error ("Buffer name already in use", name);
664 if (XSTRING_LENGTH (name) == 0)
665 error ("Empty string for buffer name is not allowed");
667 b = allocate_buffer ();
669 b->base_buffer = BUFFER_BASE_BUFFER (XBUFFER (base_buffer));
671 /* Use the base buffer's text object. */
672 b->text = b->base_buffer->text;
673 b->indirect_children = Qnil;
674 b->base_buffer->indirect_children =
675 Fcons (make_buffer (b), b->base_buffer->indirect_children);
676 init_buffer_text (b);
678 return finish_init_buffer (b, name);
684 reset_buffer_local_variables (struct buffer *b, int first_time)
686 struct buffer *def = XBUFFER (Vbuffer_defaults);
688 b->local_var_flags = 0;
689 /* For each slot that has a default value,
690 copy that into the slot. */
691 #define MARKED_SLOT(slot) \
692 { int mask = XINT (buffer_local_flags.slot); \
693 if ((mask > 0 || mask == -1 || mask == -3) \
695 || NILP (Fget (XBUFFER (Vbuffer_local_symbols)->slot, \
696 Qpermanent_local, Qnil)))) \
697 b->slot = def->slot; \
699 #include "bufslots.h"
704 /* We split this away from generate-new-buffer, because rename-buffer
705 and set-visited-file-name ought to be able to use this to really
706 rename the buffer properly. */
708 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name, 1, 2, 0, /*
709 Return a string that is the name of no existing buffer based on NAME.
710 If there is no live buffer named NAME, then return NAME.
711 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
712 until an unused name is found, and then return that name.
713 Optional second argument IGNORE specifies a name that is okay to use
714 \(if it is in the sequence to be tried)
715 even if a buffer with that name exists.
719 REGISTER Lisp_Object gentemp, tem;
725 name = LISP_GETTEXT (name);
727 /* #### Doc string should indicate that the buffer name will get
731 tem = Fget_buffer (name);
738 sprintf (number, "<%d>", ++count);
739 gentemp = concat2 (name, build_string (number));
742 tem = Fstring_equal (gentemp, ignore);
746 tem = Fget_buffer (gentemp);
753 DEFUN ("buffer-name", Fbuffer_name, 0, 1, 0, /*
754 Return the name of BUFFER, as a string.
755 With no argument or nil as argument, return the name of the current buffer.
759 /* For compatibility, we allow a dead buffer here.
760 Earlier versions of Emacs didn't provide buffer-live-p. */
762 return current_buffer->name;
763 CHECK_BUFFER (buffer);
764 return XBUFFER (buffer)->name;
767 DEFUN ("buffer-file-name", Fbuffer_file_name, 0, 1, 0, /*
768 Return name of file BUFFER is visiting, or nil if none.
769 No argument or nil as argument means use the current buffer.
773 /* For compatibility, we allow a dead buffer here. Yuck! */
775 return current_buffer->filename;
776 CHECK_BUFFER (buffer);
777 return XBUFFER (buffer)->filename;
780 DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, 0, 1, 0, /*
781 Return the base buffer of indirect buffer BUFFER.
782 If BUFFER is not indirect, return nil.
786 struct buffer *buf = decode_buffer (buffer, 0);
788 return buf->base_buffer ? make_buffer (buf->base_buffer) : Qnil;
791 DEFUN ("buffer-indirect-children", Fbuffer_indirect_children, 0, 1, 0, /*
792 Return a list of all indirect buffers whose base buffer is BUFFER.
793 If BUFFER is indirect, the return value will always be nil; see
794 `make-indirect-buffer'.
798 struct buffer *buf = decode_buffer (buffer, 0);
800 return Fcopy_sequence (buf->indirect_children);
803 DEFUN ("buffer-local-variables", Fbuffer_local_variables, 0, 1, 0, /*
804 Return an alist of variables that are buffer-local in BUFFER.
805 Most elements look like (SYMBOL . VALUE), describing one variable.
806 For a symbol that is locally unbound, just the symbol appears in the value.
807 Note that storing new VALUEs in these elements doesn't change the variables.
808 No argument or nil as argument means use current buffer as BUFFER.
812 struct buffer *buf = decode_buffer (buffer, 0);
813 Lisp_Object result = Qnil;
817 for (tail = buf->local_var_alist; CONSP (tail); tail = XCDR (tail))
819 Lisp_Object elt = XCAR (tail);
820 /* Reference each variable in the alist in buf.
821 If inquiring about the current buffer, this gets the current values,
822 so store them into the alist so the alist is up to date.
823 If inquiring about some other buffer, this swaps out any values
824 for that buffer, making the alist up to date automatically. */
825 Lisp_Object val = find_symbol_value (XCAR (elt));
826 /* Use the current buffer value only if buf is the current buffer. */
827 if (buf != current_buffer)
830 /* If symbol is unbound, put just the symbol in the list. */
832 result = Fcons (XCAR (elt), result);
833 /* Otherwise, put (symbol . value) in the list. */
835 result = Fcons (Fcons (XCAR (elt), val), result);
839 /* Add on all the variables stored in special slots. */
841 struct buffer *syms = XBUFFER (Vbuffer_local_symbols);
842 #define MARKED_SLOT(slot) \
843 { int mask = XINT (buffer_local_flags.slot); \
844 if (mask == 0 || mask == -1 \
845 || ((mask > 0) && (buf->local_var_flags & mask))) \
846 result = Fcons (Fcons (syms->slot, buf->slot), result); \
848 #include "bufslots.h"
855 DEFUN ("buffer-modified-p", Fbuffer_modified_p, 0, 1, 0, /*
856 Return t if BUFFER was modified since its file was last read or saved.
857 No argument or nil as argument means use current buffer as BUFFER.
861 struct buffer *buf = decode_buffer (buffer, 0);
863 return BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf) ? Qt : Qnil;
866 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p, 1, 2, 0, /*
867 Mark BUFFER as modified or unmodified according to FLAG.
868 A non-nil FLAG means mark the buffer modified. No argument or nil
869 as BUFFER means use current buffer.
873 /* This function can GC */
874 struct buffer *buf = decode_buffer (buffer, 0);
876 #ifdef CLASH_DETECTION
877 /* If buffer becoming modified, lock the file.
878 If buffer becoming unmodified, unlock the file. */
880 Lisp_Object fn = buf->file_truename;
883 int already = BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf);
884 if (already == NILP (flag))
886 int count = specpdl_depth ();
887 /* lock_file() and unlock_file() currently use current_buffer */
888 /* #### - dmoore, what if lock_file or unlock_file kill
889 the current buffer? */
890 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
891 set_buffer_internal (buf);
892 if (!already && !NILP (flag))
894 else if (already && NILP (flag))
896 unbind_to (count, Qnil);
899 #endif /* CLASH_DETECTION */
901 /* This is often called when the buffer contents are altered but we
902 don't want to treat the changes that way (e.g. selective
903 display). We still need to make sure redisplay realizes that the
904 contents have potentially altered and it needs to do some
906 buf = decode_buffer (buffer, 0);
908 BUF_SAVE_MODIFF (buf) = NILP (flag) ? BUF_MODIFF (buf) : 0;
909 MARK_MODELINE_CHANGED;
914 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick, 0, 1, 0, /*
915 Return BUFFER's tick counter, incremented for each change in text.
916 Each buffer has a tick counter which is incremented each time the text in
917 that buffer is changed. It wraps around occasionally.
918 No argument or nil as argument means use current buffer as BUFFER.
922 struct buffer *buf = decode_buffer (buffer, 0);
924 return make_int (BUF_MODIFF (buf));
927 DEFUN ("rename-buffer", Frename_buffer, 1, 2,
928 "sRename buffer (to new name): \nP", /*
929 Change current buffer's name to NEWNAME (a string).
930 If second arg UNIQUE is nil or omitted, it is an error if a
931 buffer named NEWNAME already exists.
932 If UNIQUE is non-nil, come up with a new name using
933 `generate-new-buffer-name'.
934 Interactively, one can set UNIQUE with a prefix argument.
935 Returns the name we actually gave the buffer.
936 This does not change the name of the visited file (if any).
940 /* This function can GC */
941 Lisp_Object tem, buf;
944 /* #### Doc string should indicate that the buffer name will get
947 CHECK_STRING (newname);
948 newname = LISP_GETTEXT (newname);
950 if (XSTRING_LENGTH (newname) == 0)
951 error ("Empty string is invalid as a buffer name");
953 tem = Fget_buffer (newname);
954 /* Don't short-circuit if UNIQUE is t. That is a useful way to rename
955 the buffer automatically so you can create another with the original name.
956 It makes UNIQUE equivalent to
957 (rename-buffer (generate-new-buffer-name NEWNAME)). */
958 /* XEmacs change: added check for nil */
959 if (NILP (unique) && !NILP (tem) && XBUFFER (tem) == current_buffer)
960 return current_buffer->name;
964 newname = Fgenerate_new_buffer_name (newname, current_buffer->name);
966 error ("Buffer name \"%s\" is in use",
967 XSTRING_DATA (newname));
970 current_buffer->name = newname;
972 /* Catch redisplay's attention. Unless we do this, the modelines for
973 any windows displaying current_buffer will stay unchanged. */
974 MARK_MODELINE_CHANGED;
976 buf = Fcurrent_buffer ();
978 /* The aconses in the Vbuffer_alist are shared with frame->buffer_alist,
979 so this will change it in the per-frame ordering as well. */
980 Fsetcar (Frassq (buf, Vbuffer_alist), newname);
982 if (NILP (current_buffer->filename)
983 && !NILP (current_buffer->auto_save_file_name))
984 call0 (Qrename_auto_save_file);
985 /* refetch since that last call may have done GC */
986 /* (hypothetical relocating GC) */
987 return current_buffer->name;
990 DEFUN ("other-buffer", Fother_buffer, 0, 3, 0, /*
991 Return most recently selected buffer other than BUFFER.
992 Buffers not visible in windows are preferred to visible buffers,
993 unless optional third argument VISIBLE-OK is non-nil.
994 If no other buffer exists, the buffer `*scratch*' is returned.
995 If BUFFER is omitted or nil, some interesting buffer is returned.
997 The ordering is for this frame; If second optional argument FRAME
998 is provided, then the ordering is for that frame. If the second arg
999 is t, then the global ordering is returned.
1001 Note: In FSF Emacs, this function takes the arguments in the order of
1002 BUFFER, VISIBLE-OK and FRAME.
1004 (buffer, frame, visible_ok))
1006 /* This function can GC */
1007 Lisp_Object tail, buf, notsogood, tem;
1013 alist = Vbuffer_alist;
1016 struct frame *f = decode_frame (frame);
1018 XSETFRAME (frame, f);
1019 alist = f->buffer_alist;
1022 for (tail = alist; !NILP (tail); tail = Fcdr (tail))
1024 buf = Fcdr (Fcar (tail));
1025 if (EQ (buf, buffer))
1027 if (string_byte (XSTRING (XBUFFER (buf)->name), 0) == ' ')
1029 /* If FRAME has a buffer_predicate,
1030 disregard buffers that don't fit the predicate. */
1033 tem = XFRAME (frame)->buffer_predicate;
1036 tem = call1 (tem, buf);
1042 if (NILP (visible_ok))
1044 /* get-buffer-window will handle nil or t frame */
1045 tem = Fget_buffer_window (buf, frame, Qnil);
1051 if (NILP (notsogood))
1054 if (!NILP (notsogood))
1056 return Fget_buffer_create (QSscratch);
1059 DEFUN ("buffer-disable-undo", Fbuffer_disable_undo, 0, 1, "", /*
1060 Stop keeping undo information for BUFFER.
1061 Any undo records it already has are discarded.
1062 No argument or nil as argument means do this for the current buffer.
1066 /* Allowing nil is an RMSism */
1067 struct buffer *real_buf = decode_buffer (buffer, 1);
1068 real_buf->undo_list = Qt;
1072 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo, 0, 1, "", /*
1073 Start keeping undo information for BUFFER.
1074 No argument or nil as argument means do this for the current buffer.
1078 /* Allowing nil is an RMSism */
1079 struct buffer *real_buf = decode_buffer (buffer, 1);
1080 if (EQ (real_buf->undo_list, Qt))
1081 real_buf->undo_list = Qnil;
1086 DEFUN ("kill-buffer", Fkill_buffer, 1, 1, "bKill buffer: ", /*
1087 Kill the buffer BUFFER.
1088 The argument may be a buffer or may be the name of a buffer.
1089 An argument of nil means kill the current buffer.
1091 Value is t if the buffer is actually killed, nil if user says no.
1093 The value of `kill-buffer-hook' (which may be local to that buffer),
1094 if not void, is a list of functions to be called, with no arguments,
1095 before the buffer is actually killed. The buffer to be killed is current
1096 when the hook functions are called.
1098 Any processes that have this buffer as the `process-buffer' are killed
1099 with `delete-process'.
1103 /* This function can call lisp */
1105 REGISTER struct buffer *b;
1106 struct gcpro gcpro1, gcpro2;
1109 buf = Fcurrent_buffer ();
1110 else if (BUFFERP (buffer))
1114 buf = get_buffer (buffer, 0);
1115 if (NILP (buf)) nsberror (buffer);
1120 /* OK to delete an already-deleted buffer. */
1121 if (!BUFFER_LIVE_P (b))
1124 /* Don't kill the minibuffer now current. */
1125 if (EQ (buf, Vminibuffer_zero))
1128 /* Or the echo area. */
1129 if (EQ (buf, Vecho_area_buffer))
1132 /* Query if the buffer is still modified. */
1133 if (INTERACTIVE && !NILP (b->filename)
1134 && BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
1140 (emacs_doprnt_string_c
1141 ((const Bufbyte *) GETTEXT ("Buffer %s modified; kill anyway? "),
1142 Qnil, -1, XSTRING_DATA (b->name))));
1146 b = XBUFFER (buf); /* Hypothetical relocating GC. */
1149 /* Run hooks with the buffer to be killed temporarily selected,
1150 unless the buffer is already dead (could have been deleted
1151 in the question above).
1153 if (BUFFER_LIVE_P (b))
1155 int speccount = specpdl_depth ();
1156 Lisp_Object tail = Qnil;
1159 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1162 /* First run the query functions; if any query is answered no,
1163 don't kill the buffer. */
1164 EXTERNAL_LIST_LOOP (tail, Vkill_buffer_query_functions)
1166 if (NILP (call0 (Fcar (tail))))
1169 return unbind_to (speccount, Qnil);
1173 /* Then run the hooks. */
1174 run_hook (Qkill_buffer_hook);
1176 /* Inform the selection code that a buffer just got killed.
1177 We do this in C because (a) it's faster, and (b) it needs
1178 to access data internal to select.c that can't be seen from
1179 Lisp (so the Lisp code would just call into C anyway. */
1180 select_notify_buffer_kill (buf);
1182 unbind_to (speccount, Qnil);
1184 b = XBUFFER (buf); /* Hypothetical relocating GC. */
1187 /* We have no more questions to ask. Verify that it is valid
1188 to kill the buffer. This must be done after the questions
1189 since anything can happen within yes-or-no-p. */
1191 /* Might have been deleted during the last question above */
1192 if (!BUFFER_LIVE_P (b))
1195 /* Don't kill the minibuffer now current. */
1196 if (EQ (buf, XWINDOW (minibuf_window)->buffer))
1199 /* When we kill a base buffer, kill all its indirect buffers.
1200 We do it at this stage so nothing terrible happens if they
1201 ask questions or their hooks get errors. */
1202 if (! b->base_buffer)
1208 LIST_LOOP (rest, b->indirect_children)
1210 Fkill_buffer (XCAR (rest));
1211 /* Keep indirect_children updated in case a
1212 query-function/hook throws. */
1213 b->indirect_children = XCDR (rest);
1219 /* Make this buffer not be current.
1220 In the process, notice if this is the sole visible buffer
1221 and give up if so. */
1222 if (b == current_buffer)
1224 Fset_buffer (Fother_buffer (buf, Qnil, Qnil));
1225 if (b == current_buffer)
1229 /* Now there is no question: we can kill the buffer. */
1231 #ifdef CLASH_DETECTION
1232 /* Unlock this buffer's file, if it is locked. unlock_buffer
1233 can both GC and kill the current buffer, and wreak general
1234 havok by running lisp code. */
1240 if (!BUFFER_LIVE_P (b))
1243 if (b == current_buffer)
1245 Fset_buffer (Fother_buffer (buf, Qnil, Qnil));
1246 if (b == current_buffer)
1249 #endif /* CLASH_DETECTION */
1252 int speccount = specpdl_depth ();
1253 specbind (Qinhibit_quit, Qt);
1255 kill_buffer_processes (buf);
1257 delete_from_buffer_alist (buf);
1259 /* Undedicate any windows of this buffer, and make sure no windows
1262 undedicate_windows (buf, Qt);
1265 Freplace_buffer_in_windows (buf, Qnil, Qall);
1268 font_lock_buffer_was_killed (b);
1270 /* Delete any auto-save file, if we saved it in this session. */
1271 if (STRINGP (b->auto_save_file_name)
1272 && b->auto_save_modified != 0
1273 && BUF_SAVE_MODIFF (b) < b->auto_save_modified)
1275 if (delete_auto_save_files != 0)
1277 /* deleting the auto save file might kill b! */
1278 /* #### dmoore - fix this crap, we do this same gcpro and
1279 buffer liveness check multiple times. Let's get a
1280 macro or something for it. */
1282 internal_delete_file (b->auto_save_file_name);
1286 if (!BUFFER_LIVE_P (b))
1289 if (b == current_buffer)
1291 Fset_buffer (Fother_buffer (buf, Qnil, Qnil));
1292 if (b == current_buffer)
1298 uninit_buffer_markers (b);
1300 kill_buffer_local_variables (b);
1303 uninit_buffer_text (b);
1304 b->undo_list = Qnil;
1305 uninit_buffer_extents (b);
1308 #ifdef ERROR_CHECK_BUFPOS
1309 assert (!NILP (memq_no_quit (buf, b->base_buffer->indirect_children)));
1311 b->base_buffer->indirect_children =
1312 delq_no_quit (buf, b->base_buffer->indirect_children);
1315 /* Clear away all Lisp objects, so that they
1316 won't be protected from GC. */
1317 nuke_all_buffer_slots (b, Qnil);
1319 unbind_to (speccount, Qnil);
1324 DEFUN ("record-buffer", Frecord_buffer, 1, 1, 0, /*
1325 Place buffer BUFFER first in the buffer order.
1326 Call this function when a buffer is selected "visibly".
1328 This function changes the global buffer order and the per-frame buffer
1329 order for the selected frame. The buffer order keeps track of recency
1330 of selection so that `other-buffer' will return a recently selected
1331 buffer. See `other-buffer' for more information.
1335 REGISTER Lisp_Object lynk, prev;
1336 struct frame *f = selected_frame ();
1337 int buffer_found = 0;
1339 CHECK_BUFFER (buffer);
1340 if (!BUFFER_LIVE_P (XBUFFER (buffer)))
1343 for (lynk = Vbuffer_alist; CONSP (lynk); lynk = XCDR (lynk))
1345 if (EQ (XCDR (XCAR (lynk)), buffer))
1354 /* Effectively do Vbuffer_alist = delq_no_quit (lynk, Vbuffer_alist) */
1356 Vbuffer_alist = XCDR (Vbuffer_alist);
1358 XCDR (prev) = XCDR (XCDR (prev));
1359 XCDR (lynk) = Vbuffer_alist;
1360 Vbuffer_alist = lynk;
1363 Vbuffer_alist = Fcons (Fcons (Fbuffer_name(buffer), buffer), Vbuffer_alist);
1365 /* That was the global one. Now do the same thing for the
1366 per-frame buffer-alist. */
1369 for (lynk = f->buffer_alist; CONSP (lynk); lynk = XCDR (lynk))
1371 if (EQ (XCDR (XCAR (lynk)), buffer))
1380 /* Effectively do f->buffer_alist = delq_no_quit (lynk, f->buffer_alist) */
1382 f->buffer_alist = XCDR (f->buffer_alist);
1384 XCDR (prev) = XCDR (XCDR (prev));
1385 XCDR (lynk) = f->buffer_alist;
1386 f->buffer_alist = lynk;
1389 f->buffer_alist = Fcons (Fcons (Fbuffer_name(buffer), buffer),
1395 DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode, 1, 1, 0, /*
1396 Set an appropriate major mode for BUFFER, according to `default-major-mode'.
1397 Use this function before selecting the buffer, since it may need to inspect
1398 the current buffer's major mode.
1402 int speccount = specpdl_depth ();
1403 Lisp_Object function = XBUFFER (Vbuffer_defaults)->major_mode;
1405 if (NILP (function))
1407 Lisp_Object tem = Fget (current_buffer->major_mode, Qmode_class, Qnil);
1409 function = current_buffer->major_mode;
1412 if (NILP (function) || EQ (function, Qfundamental_mode))
1415 /* To select a nonfundamental mode,
1416 select the buffer temporarily and then call the mode function. */
1418 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
1420 Fset_buffer (buffer);
1423 return unbind_to (speccount, Qnil);
1427 switch_to_buffer (Lisp_Object bufname, Lisp_Object norecord)
1429 call2 (Qswitch_to_buffer, bufname, norecord);
1433 DEFUN ("current-buffer", Fcurrent_buffer, 0, 0, 0, /*
1434 Return the current buffer as a Lisp object.
1439 XSETBUFFER (buffer, current_buffer);
1443 /* Set the current buffer to B. */
1446 set_buffer_internal (struct buffer *b)
1448 REGISTER struct buffer *old_buf;
1449 REGISTER Lisp_Object tail;
1451 if (current_buffer == b)
1454 INVALIDATE_PIXEL_TO_GLYPH_CACHE;
1456 old_buf = current_buffer;
1458 invalidate_current_column (); /* invalidate indentation cache */
1462 /* Put the undo list back in the base buffer, so that it appears
1463 that an indirect buffer shares the undo list of its base. */
1464 if (old_buf->base_buffer)
1465 old_buf->base_buffer->undo_list = old_buf->undo_list;
1468 /* Get the undo list from the base buffer, so that it appears
1469 that an indirect buffer shares the undo list of its base. */
1471 b->undo_list = b->base_buffer->undo_list;
1473 /* Look down buffer's list of local Lisp variables
1474 to find and update any that forward into C variables. */
1476 LIST_LOOP (tail, b->local_var_alist)
1478 Lisp_Object sym = XCAR (XCAR (tail));
1479 Lisp_Object valcontents = XSYMBOL (sym)->value;
1480 if (SYMBOL_VALUE_MAGIC_P (valcontents))
1482 /* Just reference the variable
1483 to cause it to become set for this buffer. */
1484 /* Use find_symbol_value_quickly to avoid an unnecessary O(n)
1486 (void) find_symbol_value_quickly (XCAR (tail), 1);
1490 /* Do the same with any others that were local to the previous buffer */
1494 LIST_LOOP (tail, old_buf->local_var_alist)
1496 Lisp_Object sym = XCAR (XCAR (tail));
1497 Lisp_Object valcontents = XSYMBOL (sym)->value;
1499 if (SYMBOL_VALUE_MAGIC_P (valcontents))
1501 /* Just reference the variable
1502 to cause it to become set for this buffer. */
1503 /* Use find_symbol_value_quickly with find_it_p as 0 to avoid an
1504 unnecessary O(n) lookup which is guaranteed to be worst case.
1505 Any symbols which are local are guaranteed to have been
1506 handled in the previous loop, above. */
1507 (void) find_symbol_value_quickly (sym, 0);
1513 DEFUN ("set-buffer", Fset_buffer, 1, 1, 0, /*
1514 Make the buffer BUFFER current for editing operations.
1515 BUFFER may be a buffer or the name of an existing buffer.
1516 See also `save-excursion' when you want to make a buffer current temporarily.
1517 This function does not display the buffer, so its effect ends
1518 when the current command terminates.
1519 Use `switch-to-buffer' or `pop-to-buffer' to switch buffers permanently.
1523 buffer = get_buffer (buffer, 0);
1525 error ("Selecting deleted or non-existent buffer");
1526 set_buffer_internal (XBUFFER (buffer));
1531 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only, 0, 3, 0, /*
1532 Signal a `buffer-read-only' error if BUFFER is read-only.
1533 Optional argument BUFFER defaults to the current buffer.
1535 If optional argument START is non-nil, all extents in the buffer
1536 which overlap that part of the buffer are checked to ensure none has a
1537 `read-only' property. (Extents that lie completely within the range,
1538 however, are not checked.) END defaults to the value of START.
1540 If START and END are equal, the range checked is [START, END] (i.e.
1541 closed on both ends); otherwise, the range checked is (START, END)
1542 \(open on both ends), except that extents that lie completely within
1543 [START, END] are not checked. See `extent-in-region-p' for a fuller
1546 (buffer, start, end))
1548 struct buffer *b = decode_buffer (buffer, 0);
1557 get_buffer_range_char (b, start, end, &s, &e, 0);
1559 barf_if_buffer_read_only (b, s, e);
1565 bury_buffer_1 (Lisp_Object buffer, Lisp_Object before,
1566 Lisp_Object *buffer_alist)
1568 Lisp_Object aelt = rassq_no_quit (buffer, *buffer_alist);
1569 Lisp_Object lynk = memq_no_quit (aelt, *buffer_alist);
1570 Lisp_Object iter, before_before;
1572 *buffer_alist = delq_no_quit (aelt, *buffer_alist);
1573 for (before_before = Qnil, iter = *buffer_alist;
1574 !NILP (iter) && !EQ (XCDR (XCAR (iter)), before);
1575 before_before = iter, iter = XCDR (iter))
1578 if (!NILP (before_before))
1579 XCDR (before_before) = lynk;
1581 *buffer_alist = lynk;
1584 DEFUN ("bury-buffer", Fbury_buffer, 0, 2, "", /*
1585 Put BUFFER at the end of the list of all buffers.
1586 There it is the least likely candidate for `other-buffer' to return;
1587 thus, the least likely buffer for \\[switch-to-buffer] to select by default.
1588 If BUFFER is nil or omitted, bury the current buffer.
1589 Also, if BUFFER is nil or omitted, remove the current buffer from the
1590 selected window if it is displayed there.
1591 Because of this, you may need to specify (current-buffer) as
1592 BUFFER when calling from minibuffer.
1593 If BEFORE is non-nil, it specifies a buffer before which BUFFER
1594 will be placed, instead of being placed at the end.
1598 /* This function can GC */
1599 struct buffer *buf = decode_buffer (buffer, 1);
1600 /* If we're burying the current buffer, unshow it. */
1601 /* Note that the behavior of (bury-buffer nil) and
1602 (bury-buffer (current-buffer)) is not the same.
1603 This is illogical but is historical. Changing it
1604 breaks mh-e and TeX and such packages. */
1606 switch_to_buffer (Fother_buffer (Fcurrent_buffer (), Qnil, Qnil), Qnil);
1607 XSETBUFFER (buffer, buf);
1610 before = get_buffer (before, 1);
1612 if (EQ (before, buffer))
1613 error ("Cannot place a buffer before itself");
1615 bury_buffer_1 (buffer, before, &Vbuffer_alist);
1616 bury_buffer_1 (buffer, before, &selected_frame ()->buffer_alist);
1622 DEFUN ("erase-buffer", Ferase_buffer, 0, 1, "*", /*
1623 Delete the entire contents of the BUFFER.
1624 Any clipping restriction in effect (see `narrow-to-region') is removed,
1625 so the buffer is truly empty after this.
1626 BUFFER defaults to the current buffer if omitted.
1630 /* This function can GC */
1631 struct buffer *b = decode_buffer (buffer, 1);
1632 /* #### yuck yuck yuck. This is gross. The old echo-area code,
1633 however, was the only place that called erase_buffer() with a
1634 non-zero NO_CLIP argument.
1636 Someone needs to fix up the redisplay code so it is smarter
1637 about this, so that the NO_CLIP junk isn't necessary. */
1638 int no_clip = (b == XBUFFER (Vecho_area_buffer));
1640 INVALIDATE_PIXEL_TO_GLYPH_CACHE;
1642 widen_buffer (b, no_clip);
1643 buffer_delete_range (b, BUF_BEG (b), BUF_Z (b), 0);
1644 b->last_window_start = 1;
1646 /* Prevent warnings, or suspension of auto saving, that would happen
1647 if future size is less than past size. Use of erase-buffer
1648 implies that the future text is not really related to the past text. */
1649 b->saved_size = Qzero;
1656 DEFUN ("kill-all-local-variables", Fkill_all_local_variables, 0, 0, 0, /*
1657 Switch to Fundamental mode by killing current buffer's local variables.
1658 Most local variable bindings are eliminated so that the default values
1659 become effective once more. Also, the syntax table is set from
1660 `standard-syntax-table', the category table is set from
1661 `standard-category-table' (if support for Mule exists), local keymap is set
1662 to nil, the abbrev table is set from `fundamental-mode-abbrev-table',
1663 and all specifier specifications whose locale is the current buffer
1664 are removed. This function also forces redisplay of the modeline.
1666 Every function to select a new major mode starts by
1667 calling this function.
1669 As a special exception, local variables whose names have
1670 a non-nil `permanent-local' property are not eliminated by this function.
1672 The first thing this function does is run
1673 the normal hook `change-major-mode-hook'.
1677 /* This function can GC */
1678 run_hook (Qchange_major_mode_hook);
1680 reset_buffer_local_variables (current_buffer, 0);
1682 kill_buffer_local_variables (current_buffer);
1684 kill_specifier_buffer_locals (Fcurrent_buffer ());
1686 /* Force modeline redisplay. Useful here because all major mode
1687 commands call this function. */
1688 MARK_MODELINE_CHANGED;
1693 #ifdef MEMORY_USAGE_STATS
1704 compute_buffer_text_usage (struct buffer *b, struct overhead_stats *ovstats)
1706 int was_requested = b->text->z - 1;
1707 size_t gap = b->text->gap_size + b->text->end_gap_size;
1708 size_t malloc_use = malloced_storage_size (b->text->beg, was_requested + gap, 0);
1710 ovstats->gap_overhead += gap;
1711 ovstats->was_requested += was_requested;
1712 ovstats->malloc_overhead += malloc_use - (was_requested + gap);
1717 compute_buffer_usage (struct buffer *b, struct buffer_stats *stats,
1718 struct overhead_stats *ovstats)
1721 stats->other += malloced_storage_size (b, sizeof (*b), ovstats);
1722 stats->text += compute_buffer_text_usage (b, ovstats);
1723 stats->markers += compute_buffer_marker_usage (b, ovstats);
1724 stats->extents += compute_buffer_extent_usage (b, ovstats);
1727 DEFUN ("buffer-memory-usage", Fbuffer_memory_usage, 1, 1, 0, /*
1728 Return stats about the memory usage of buffer BUFFER.
1729 The values returned are in the form of an alist of usage types and byte
1730 counts. The byte counts attempt to encompass all the memory used
1731 by the buffer (separate from the memory logically associated with a
1732 buffer or frame), including internal structures and any malloc()
1733 overhead associated with them. In practice, the byte counts are
1734 underestimated because certain memory usage is very hard to determine
1735 \(e.g. the amount of memory used inside the Xt library or inside the
1736 X server) and because there is other stuff that might logically
1737 be associated with a window, buffer, or frame (e.g. window configurations,
1738 glyphs) but should not obviously be included in the usage counts.
1740 Multiple slices of the total memory usage may be returned, separated
1741 by a nil. Each slice represents a particular view of the memory, a
1742 particular way of partitioning it into groups. Within a slice, there
1743 is no overlap between the groups of memory, and each slice collectively
1744 represents all the memory concerned.
1748 struct buffer_stats stats;
1749 struct overhead_stats ovstats;
1750 Lisp_Object val = Qnil;
1752 CHECK_BUFFER (buffer); /* dead buffers should be allowed, no? */
1754 compute_buffer_usage (XBUFFER (buffer), &stats, &ovstats);
1756 val = acons (Qtext, make_int (stats.text), val);
1757 val = acons (Qmarkers, make_int (stats.markers), val);
1758 val = acons (Qextents, make_int (stats.extents), val);
1759 val = acons (Qother, make_int (stats.other), val);
1760 val = Fcons (Qnil, val);
1761 val = acons (Qactually_requested, make_int (ovstats.was_requested), val);
1762 val = acons (Qmalloc_overhead, make_int (ovstats.malloc_overhead), val);
1763 val = acons (Qgap_overhead, make_int (ovstats.gap_overhead), val);
1764 val = acons (Qdynarr_overhead, make_int (ovstats.dynarr_overhead), val);
1766 return Fnreverse (val);
1769 #endif /* MEMORY_USAGE_STATS */
1772 /************************************************************************/
1773 /* Implement TO_EXTERNAL_FORMAT, TO_INTERNAL_FORMAT */
1774 /************************************************************************/
1776 /* This implementation should probably be elsewhere, but it can't be
1777 in file-coding.c since that file is only available if FILE_CODING
1781 coding_system_is_binary (Lisp_Object coding_system)
1783 Lisp_Coding_System *cs = XCODING_SYSTEM (coding_system);
1785 (CODING_SYSTEM_TYPE (cs) == CODESYS_NO_CONVERSION &&
1786 CODING_SYSTEM_EOL_TYPE (cs) == EOL_LF &&
1787 EQ (CODING_SYSTEM_POST_READ_CONVERSION (cs), Qnil) &&
1788 EQ (CODING_SYSTEM_PRE_WRITE_CONVERSION (cs), Qnil));
1791 #define coding_system_is_binary(coding_system) 1
1796 Dynarr_declare (Bufbyte_dynarr *);
1797 } Bufbyte_dynarr_dynarr;
1801 Dynarr_declare (Extbyte_dynarr *);
1802 } Extbyte_dynarr_dynarr;
1804 static Extbyte_dynarr_dynarr *conversion_out_dynarr_list;
1805 static Bufbyte_dynarr_dynarr *conversion_in_dynarr_list;
1807 static int dfc_convert_to_external_format_in_use;
1808 static int dfc_convert_to_internal_format_in_use;
1811 dfc_convert_to_external_format_reset_in_use (Lisp_Object value)
1813 dfc_convert_to_external_format_in_use = XINT (value);
1818 dfc_convert_to_internal_format_reset_in_use (Lisp_Object value)
1820 dfc_convert_to_internal_format_in_use = XINT (value);
1825 dfc_convert_to_external_format (dfc_conversion_type source_type,
1826 dfc_conversion_data *source,
1828 Lisp_Object coding_system,
1830 dfc_conversion_type sink_type,
1831 dfc_conversion_data *sink)
1833 int count = specpdl_depth ();
1834 Extbyte_dynarr *conversion_out_dynarr;
1836 type_checking_assert
1837 (((source_type == DFC_TYPE_DATA) ||
1838 (source_type == DFC_TYPE_LISP_LSTREAM && LSTREAMP (source->lisp_object)) ||
1839 (source_type == DFC_TYPE_LISP_STRING && STRINGP (source->lisp_object)))
1841 ((sink_type == DFC_TYPE_DATA) ||
1842 (sink_type == DFC_TYPE_LISP_LSTREAM && LSTREAMP (source->lisp_object))));
1844 record_unwind_protect (dfc_convert_to_external_format_reset_in_use,
1845 make_int (dfc_convert_to_external_format_in_use));
1846 if (Dynarr_length (conversion_out_dynarr_list) <=
1847 dfc_convert_to_external_format_in_use)
1848 Dynarr_add (conversion_out_dynarr_list, Dynarr_new (Extbyte));
1849 conversion_out_dynarr = Dynarr_at (conversion_out_dynarr_list,
1850 dfc_convert_to_external_format_in_use);
1851 dfc_convert_to_external_format_in_use++;
1852 Dynarr_reset (conversion_out_dynarr);
1855 coding_system = Fget_coding_system (coding_system);
1858 /* Here we optimize in the case where the coding system does no
1859 conversion. However, we don't want to optimize in case the source
1860 or sink is an lstream, since writing to an lstream can cause a
1861 garbage collection, and this could be problematic if the source
1862 is a lisp string. */
1863 if (source_type != DFC_TYPE_LISP_LSTREAM &&
1864 sink_type != DFC_TYPE_LISP_LSTREAM &&
1865 coding_system_is_binary (coding_system))
1870 if (source_type == DFC_TYPE_LISP_STRING)
1872 ptr = XSTRING_DATA (source->lisp_object);
1873 len = XSTRING_LENGTH (source->lisp_object);
1877 ptr = (Bufbyte *) source->data.ptr;
1878 len = source->data.len;
1884 for (end = ptr + len; ptr < end;)
1887 (BYTE_ASCII_P (*ptr)) ? *ptr :
1888 (*ptr == LEADING_BYTE_CONTROL_1) ? (*(ptr+1) - 0x20) :
1889 (*ptr == LEADING_BYTE_LATIN_ISO8859_1) ? (*(ptr+1)) :
1892 Dynarr_add (conversion_out_dynarr, (Extbyte) c);
1895 bufpos_checking_assert (ptr == end);
1898 Dynarr_add_many (conversion_out_dynarr, ptr, len);
1904 Lisp_Object streams_to_delete[3];
1905 int delete_count = 0;
1906 Lisp_Object instream, outstream;
1907 Lstream *reader, *writer;
1908 struct gcpro gcpro1, gcpro2;
1910 if (source_type == DFC_TYPE_LISP_LSTREAM)
1911 instream = source->lisp_object;
1912 else if (source_type == DFC_TYPE_DATA)
1913 streams_to_delete[delete_count++] = instream =
1914 make_fixed_buffer_input_stream (source->data.ptr, source->data.len);
1917 type_checking_assert (source_type == DFC_TYPE_LISP_STRING);
1918 streams_to_delete[delete_count++] = instream =
1919 make_lisp_string_input_stream (source->lisp_object, 0, -1);
1922 if (sink_type == DFC_TYPE_LISP_LSTREAM)
1923 outstream = sink->lisp_object;
1926 type_checking_assert (sink_type == DFC_TYPE_DATA);
1927 streams_to_delete[delete_count++] = outstream =
1928 make_dynarr_output_stream
1929 ((unsigned_char_dynarr *) conversion_out_dynarr);
1933 streams_to_delete[delete_count++] = outstream =
1934 make_encoding_output_stream (XLSTREAM (outstream), coding_system);
1937 reader = XLSTREAM (instream);
1938 writer = XLSTREAM (outstream);
1939 /* decoding_stream will gc-protect outstream */
1940 GCPRO2 (instream, outstream);
1944 Lstream_data_count size_in_bytes;
1945 char tempbuf[1024]; /* some random amount */
1947 size_in_bytes = Lstream_read (reader, tempbuf, sizeof (tempbuf));
1949 if (size_in_bytes == 0)
1951 else if (size_in_bytes < 0)
1952 error ("Error converting to external format");
1954 size_in_bytes = Lstream_write (writer, tempbuf, size_in_bytes);
1956 if (size_in_bytes <= 0)
1957 error ("Error converting to external format");
1960 /* Closing writer will close any stream at the other end of writer. */
1961 Lstream_close (writer);
1962 Lstream_close (reader);
1965 /* The idea is that this function will create no garbage. */
1966 while (delete_count)
1967 Lstream_delete (XLSTREAM (streams_to_delete [--delete_count]));
1970 unbind_to (count, Qnil);
1972 if (sink_type != DFC_TYPE_LISP_LSTREAM)
1974 sink->data.len = Dynarr_length (conversion_out_dynarr);
1975 Dynarr_add (conversion_out_dynarr, '\0'); /* NUL-terminate! */
1976 sink->data.ptr = Dynarr_atp (conversion_out_dynarr, 0);
1981 dfc_convert_to_internal_format (dfc_conversion_type source_type,
1982 dfc_conversion_data *source,
1984 Lisp_Object coding_system,
1986 dfc_conversion_type sink_type,
1987 dfc_conversion_data *sink)
1989 int count = specpdl_depth ();
1990 Bufbyte_dynarr *conversion_in_dynarr;
1992 type_checking_assert
1993 ((source_type == DFC_TYPE_DATA ||
1994 source_type == DFC_TYPE_LISP_LSTREAM)
1996 (sink_type == DFC_TYPE_DATA ||
1997 sink_type == DFC_TYPE_LISP_LSTREAM));
1999 record_unwind_protect (dfc_convert_to_internal_format_reset_in_use,
2000 make_int (dfc_convert_to_internal_format_in_use));
2001 if (Dynarr_length (conversion_in_dynarr_list) <=
2002 dfc_convert_to_internal_format_in_use)
2003 Dynarr_add (conversion_in_dynarr_list, Dynarr_new (Bufbyte));
2004 conversion_in_dynarr = Dynarr_at (conversion_in_dynarr_list,
2005 dfc_convert_to_internal_format_in_use);
2006 dfc_convert_to_internal_format_in_use++;
2007 Dynarr_reset (conversion_in_dynarr);
2010 coding_system = Fget_coding_system (coding_system);
2013 if (source_type != DFC_TYPE_LISP_LSTREAM &&
2014 sink_type != DFC_TYPE_LISP_LSTREAM &&
2015 coding_system_is_binary (coding_system))
2018 const Bufbyte *ptr = (const Bufbyte *) source->data.ptr;
2019 Bytecount len = source->data.len;
2020 const Bufbyte *end = ptr + len;
2022 for (; ptr < end; ptr++)
2026 if (BYTE_ASCII_P (c))
2027 Dynarr_add (conversion_in_dynarr, c);
2028 else if (BYTE_C1_P (c))
2030 Dynarr_add (conversion_in_dynarr, LEADING_BYTE_CONTROL_1);
2031 Dynarr_add (conversion_in_dynarr, c + 0x20);
2035 Dynarr_add (conversion_in_dynarr, LEADING_BYTE_LATIN_ISO8859_1);
2036 Dynarr_add (conversion_in_dynarr, c);
2040 Dynarr_add_many (conversion_in_dynarr, source->data.ptr, source->data.len);
2045 Lisp_Object streams_to_delete[3];
2046 int delete_count = 0;
2047 Lisp_Object instream, outstream;
2048 Lstream *reader, *writer;
2049 struct gcpro gcpro1, gcpro2;
2051 if (source_type == DFC_TYPE_LISP_LSTREAM)
2052 instream = source->lisp_object;
2055 type_checking_assert (source_type == DFC_TYPE_DATA);
2056 streams_to_delete[delete_count++] = instream =
2057 make_fixed_buffer_input_stream (source->data.ptr, source->data.len);
2060 if (sink_type == DFC_TYPE_LISP_LSTREAM)
2061 outstream = sink->lisp_object;
2064 type_checking_assert (sink_type == DFC_TYPE_DATA);
2065 streams_to_delete[delete_count++] = outstream =
2066 make_dynarr_output_stream
2067 ((unsigned_char_dynarr *) conversion_in_dynarr);
2071 streams_to_delete[delete_count++] = outstream =
2072 make_decoding_output_stream (XLSTREAM (outstream), coding_system);
2075 reader = XLSTREAM (instream);
2076 writer = XLSTREAM (outstream);
2077 /* outstream will gc-protect its sink stream, if necessary */
2078 GCPRO2 (instream, outstream);
2082 Lstream_data_count size_in_bytes;
2083 char tempbuf[1024]; /* some random amount */
2085 size_in_bytes = Lstream_read (reader, tempbuf, sizeof (tempbuf));
2087 if (size_in_bytes == 0)
2089 else if (size_in_bytes < 0)
2090 error ("Error converting to internal format");
2092 size_in_bytes = Lstream_write (writer, tempbuf, size_in_bytes);
2094 if (size_in_bytes <= 0)
2095 error ("Error converting to internal format");
2098 /* Closing writer will close any stream at the other end of writer. */
2099 Lstream_close (writer);
2100 Lstream_close (reader);
2103 /* The idea is that this function will create no garbage. */
2104 while (delete_count)
2105 Lstream_delete (XLSTREAM (streams_to_delete [--delete_count]));
2108 unbind_to (count, Qnil);
2110 if (sink_type != DFC_TYPE_LISP_LSTREAM)
2112 sink->data.len = Dynarr_length (conversion_in_dynarr);
2113 Dynarr_add (conversion_in_dynarr, '\0'); /* NUL-terminate! */
2114 sink->data.ptr = Dynarr_atp (conversion_in_dynarr, 0);
2120 syms_of_buffer (void)
2122 INIT_LRECORD_IMPLEMENTATION (buffer);
2124 defsymbol (&Qbuffer_live_p, "buffer-live-p");
2125 defsymbol (&Qbuffer_or_string_p, "buffer-or-string-p");
2126 defsymbol (&Qmode_class, "mode-class");
2127 defsymbol (&Qrename_auto_save_file, "rename-auto-save-file");
2128 defsymbol (&Qkill_buffer_hook, "kill-buffer-hook");
2129 defsymbol (&Qpermanent_local, "permanent-local");
2131 defsymbol (&Qfirst_change_hook, "first-change-hook");
2132 defsymbol (&Qbefore_change_functions, "before-change-functions");
2133 defsymbol (&Qafter_change_functions, "after-change-functions");
2135 /* #### Obsolete, for compatibility */
2136 defsymbol (&Qbefore_change_function, "before-change-function");
2137 defsymbol (&Qafter_change_function, "after-change-function");
2139 defsymbol (&Qdefault_directory, "default-directory");
2141 defsymbol (&Qget_file_buffer, "get-file-buffer");
2142 defsymbol (&Qchange_major_mode_hook, "change-major-mode-hook");
2144 defsymbol (&Qfundamental_mode, "fundamental-mode");
2146 defsymbol (&Qfind_file_compare_truenames, "find-file-compare-truenames");
2148 defsymbol (&Qswitch_to_buffer, "switch-to-buffer");
2151 DEFSUBR (Fbuffer_live_p);
2152 DEFSUBR (Fbuffer_list);
2153 DEFSUBR (Fdecode_buffer);
2154 DEFSUBR (Fget_buffer);
2155 DEFSUBR (Fget_file_buffer);
2156 DEFSUBR (Fget_buffer_create);
2157 DEFSUBR (Fmake_indirect_buffer);
2159 DEFSUBR (Fgenerate_new_buffer_name);
2160 DEFSUBR (Fbuffer_name);
2161 DEFSUBR (Fbuffer_file_name);
2162 DEFSUBR (Fbuffer_base_buffer);
2163 DEFSUBR (Fbuffer_indirect_children);
2164 DEFSUBR (Fbuffer_local_variables);
2165 DEFSUBR (Fbuffer_modified_p);
2166 DEFSUBR (Fset_buffer_modified_p);
2167 DEFSUBR (Fbuffer_modified_tick);
2168 DEFSUBR (Frename_buffer);
2169 DEFSUBR (Fother_buffer);
2170 DEFSUBR (Fbuffer_disable_undo);
2171 DEFSUBR (Fbuffer_enable_undo);
2172 DEFSUBR (Fkill_buffer);
2173 DEFSUBR (Ferase_buffer);
2174 DEFSUBR (Frecord_buffer);
2175 DEFSUBR (Fset_buffer_major_mode);
2176 DEFSUBR (Fcurrent_buffer);
2177 DEFSUBR (Fset_buffer);
2178 DEFSUBR (Fbarf_if_buffer_read_only);
2179 DEFSUBR (Fbury_buffer);
2180 DEFSUBR (Fkill_all_local_variables);
2181 #ifdef MEMORY_USAGE_STATS
2182 DEFSUBR (Fbuffer_memory_usage);
2185 DEFERROR (Qprotected_field, "Attempt to modify a protected field",
2190 reinit_vars_of_buffer (void)
2192 conversion_in_dynarr_list = Dynarr_new2 (Bufbyte_dynarr_dynarr,
2194 conversion_out_dynarr_list = Dynarr_new2 (Extbyte_dynarr_dynarr,
2197 staticpro_nodump (&Vbuffer_alist);
2198 Vbuffer_alist = Qnil;
2202 /* initialize the buffer routines */
2204 vars_of_buffer (void)
2206 /* This function can GC */
2207 reinit_vars_of_buffer ();
2209 staticpro (&QSFundamental);
2210 staticpro (&QSscratch);
2212 QSFundamental = build_string ("Fundamental");
2213 QSscratch = build_string (DEFER_GETTEXT ("*scratch*"));
2215 DEFVAR_LISP ("change-major-mode-hook", &Vchange_major_mode_hook /*
2216 List of hooks to be run before killing local variables in a buffer.
2217 This should be used by any mode that temporarily alters the contents or
2218 the read-only state of the buffer. See also `kill-all-local-variables'.
2220 Vchange_major_mode_hook = Qnil;
2222 DEFVAR_BOOL ("find-file-compare-truenames", &find_file_compare_truenames /*
2223 If this is true, then the `find-file' command will check the truenames
2224 of all visited files when deciding whether a given file is already in
2225 a buffer, instead of just `buffer-file-name'. This means that if you
2226 attempt to visit another file which is a symbolic link to a file which
2227 is already in a buffer, the existing buffer will be found instead of a
2228 newly-created one. This works if any component of the pathname
2229 (including a non-terminal component) is a symbolic link as well, but
2230 doesn't work with hard links (nothing does).
2232 See also the variable `find-file-use-truenames'.
2234 #if defined(CYGWIN) || defined(WIN32_NATIVE)
2235 find_file_compare_truenames = 1;
2237 find_file_compare_truenames = 0;
2240 DEFVAR_BOOL ("find-file-use-truenames", &find_file_use_truenames /*
2241 If this is true, then a buffer's visited file-name will always be
2242 chased back to the real file; it will never be a symbolic link, and there
2243 will never be a symbolic link anywhere in its directory path.
2244 That is, the buffer-file-name and buffer-file-truename will be equal.
2245 This doesn't work with hard links.
2247 See also the variable `find-file-compare-truenames'.
2249 find_file_use_truenames = 0;
2251 DEFVAR_LISP ("before-change-functions", &Vbefore_change_functions /*
2252 List of functions to call before each text change.
2253 Two arguments are passed to each function: the positions of
2254 the beginning and end of the range of old text to be changed.
2255 \(For an insertion, the beginning and end are at the same place.)
2256 No information is given about the length of the text after the change.
2258 Buffer changes made while executing the `before-change-functions'
2259 don't call any before-change or after-change functions.
2261 Vbefore_change_functions = Qnil;
2263 /* FSF Emacs has the following additional doc at the end of
2264 before-change-functions and after-change-functions:
2266 That's because these variables are temporarily set to nil.
2267 As a result, a hook function cannot straightforwardly alter the value of
2268 these variables. See the Emacs Lisp manual for a way of
2269 accomplishing an equivalent result by using other variables.
2271 But this doesn't apply under XEmacs because things are
2274 DEFVAR_LISP ("after-change-functions", &Vafter_change_functions /*
2275 List of functions to call after each text change.
2276 Three arguments are passed to each function: the positions of
2277 the beginning and end of the range of changed text,
2278 and the length of the pre-change text replaced by that range.
2279 \(For an insertion, the pre-change length is zero;
2280 for a deletion, that length is the number of characters deleted,
2281 and the post-change beginning and end are at the same place.)
2283 Buffer changes made while executing `after-change-functions'
2284 don't call any before-change or after-change functions.
2286 Vafter_change_functions = Qnil;
2288 DEFVAR_LISP ("before-change-function", &Vbefore_change_function /*
2290 */ ); /* obsoleteness will be documented */
2291 Vbefore_change_function = Qnil;
2293 DEFVAR_LISP ("after-change-function", &Vafter_change_function /*
2295 */ ); /* obsoleteness will be documented */
2296 Vafter_change_function = Qnil;
2298 DEFVAR_LISP ("first-change-hook", &Vfirst_change_hook /*
2299 A list of functions to call before changing a buffer which is unmodified.
2300 The functions are run using the `run-hooks' function.
2302 Vfirst_change_hook = Qnil;
2305 xxDEFVAR_LISP ("transient-mark-mode", &Vtransient_mark_mode /*
2306 *Non-nil means deactivate the mark when the buffer contents change.
2308 Vtransient_mark_mode = Qnil;
2309 #endif /* FSFmacs */
2311 DEFVAR_INT ("undo-threshold", &undo_threshold /*
2312 Keep no more undo information once it exceeds this size.
2313 This threshold is applied when garbage collection happens.
2314 The size is counted as the number of bytes occupied,
2315 which includes both saved text and other data.
2317 undo_threshold = 20000;
2319 DEFVAR_INT ("undo-high-threshold", &undo_high_threshold /*
2320 Don't keep more than this much size of undo information.
2321 A command which pushes past this size is itself forgotten.
2322 This threshold is applied when garbage collection happens.
2323 The size is counted as the number of bytes occupied,
2324 which includes both saved text and other data.
2326 undo_high_threshold = 30000;
2328 DEFVAR_LISP ("inhibit-read-only", &Vinhibit_read_only /*
2329 *Non-nil means disregard read-only status of buffers or characters.
2330 If the value is t, disregard `buffer-read-only' and all `read-only'
2331 text properties. If the value is a list, disregard `buffer-read-only'
2332 and disregard a `read-only' extent property or text property if the
2333 property value is a member of the list.
2335 Vinhibit_read_only = Qnil;
2337 DEFVAR_LISP ("kill-buffer-query-functions", &Vkill_buffer_query_functions /*
2338 List of functions called with no args to query before killing a buffer.
2340 Vkill_buffer_query_functions = Qnil;
2342 DEFVAR_BOOL ("delete-auto-save-files", &delete_auto_save_files /*
2343 *Non-nil means delete auto-save file when a buffer is saved or killed.
2345 delete_auto_save_files = 1;
2348 /* The docstrings for DEFVAR_* are recorded externally by make-docfile. */
2350 /* Renamed from DEFVAR_PER_BUFFER because FSFmacs D_P_B takes
2351 a bogus extra arg, which confuses an otherwise identical make-docfile.c */
2352 #define DEFVAR_BUFFER_LOCAL_1(lname, field_name, forward_type, magicfun) do { \
2353 static const struct symbol_value_forward I_hate_C = \
2354 { /* struct symbol_value_forward */ \
2355 { /* struct symbol_value_magic */ \
2356 { /* struct lcrecord_header */ \
2357 { /* struct lrecord_header */ \
2358 lrecord_type_symbol_value_forward, /* lrecord_type_index */ \
2360 1, /* c_readonly bit */ \
2361 1 /* lisp_readonly bit */ \
2367 &(buffer_local_flags.field_name), \
2374 int offset = ((char *)symbol_value_forward_forward (&I_hate_C) - \
2375 (char *)&buffer_local_flags); \
2376 defvar_magic (lname, &I_hate_C); \
2378 *((Lisp_Object *)(offset + (char *)XBUFFER (Vbuffer_local_symbols))) \
2383 #define DEFVAR_BUFFER_LOCAL_MAGIC(lname, field_name, magicfun) \
2384 DEFVAR_BUFFER_LOCAL_1 (lname, field_name, \
2385 SYMVAL_CURRENT_BUFFER_FORWARD, magicfun)
2386 #define DEFVAR_BUFFER_LOCAL(lname, field_name) \
2387 DEFVAR_BUFFER_LOCAL_MAGIC (lname, field_name, 0)
2388 #define DEFVAR_CONST_BUFFER_LOCAL_MAGIC(lname, field_name, magicfun) \
2389 DEFVAR_BUFFER_LOCAL_1 (lname, field_name, \
2390 SYMVAL_CONST_CURRENT_BUFFER_FORWARD, magicfun)
2391 #define DEFVAR_CONST_BUFFER_LOCAL(lname, field_name) \
2392 DEFVAR_CONST_BUFFER_LOCAL_MAGIC (lname, field_name, 0)
2394 #define DEFVAR_BUFFER_DEFAULTS_MAGIC(lname, field_name, magicfun) \
2395 DEFVAR_SYMVAL_FWD (lname, &(buffer_local_flags.field_name), \
2396 SYMVAL_DEFAULT_BUFFER_FORWARD, magicfun)
2397 #define DEFVAR_BUFFER_DEFAULTS(lname, field_name) \
2398 DEFVAR_BUFFER_DEFAULTS_MAGIC (lname, field_name, 0)
2401 nuke_all_buffer_slots (struct buffer *b, Lisp_Object zap)
2405 b->extent_info = Qnil;
2406 b->indirect_children = Qnil;
2407 b->own_text.line_number_cache = Qnil;
2409 #define MARKED_SLOT(x) b->x = zap
2410 #include "bufslots.h"
2415 common_init_complex_vars_of_buffer (void)
2417 /* Make sure all markable slots in buffer_defaults
2418 are initialized reasonably, so mark_buffer won't choke. */
2419 struct buffer *defs = alloc_lcrecord_type (struct buffer, &lrecord_buffer);
2420 struct buffer *syms = alloc_lcrecord_type (struct buffer, &lrecord_buffer);
2422 staticpro_nodump (&Vbuffer_defaults);
2423 staticpro_nodump (&Vbuffer_local_symbols);
2424 XSETBUFFER (Vbuffer_defaults, defs);
2425 XSETBUFFER (Vbuffer_local_symbols, syms);
2427 nuke_all_buffer_slots (syms, Qnil);
2428 nuke_all_buffer_slots (defs, Qnil);
2429 defs->text = &defs->own_text;
2430 syms->text = &syms->own_text;
2432 /* Set up the non-nil default values of various buffer slots.
2433 Must do these before making the first buffer. */
2434 defs->major_mode = Qfundamental_mode;
2435 defs->mode_name = QSFundamental;
2436 defs->abbrev_table = Qnil; /* real default setup by Lisp code */
2438 defs->case_table = Vstandard_case_table;
2440 defs->category_table = Vstandard_category_table;
2442 defs->syntax_table = Vstandard_syntax_table;
2443 defs->mirror_syntax_table =
2444 XCHAR_TABLE (Vstandard_syntax_table)->mirror_table;
2445 defs->modeline_format = build_string ("%-"); /* reset in loaddefs.el */
2446 defs->case_fold_search = Qt;
2447 defs->selective_display_ellipses = Qt;
2448 defs->tab_width = make_int (8);
2449 defs->ctl_arrow = Qt;
2450 defs->fill_column = make_int (70);
2451 defs->left_margin = Qzero;
2452 defs->saved_size = Qzero; /* lisp code wants int-or-nil */
2454 defs->auto_save_modified = 0;
2455 defs->auto_save_failure_time = -1;
2456 defs->invisibility_spec = Qt;
2457 defs->buffer_local_face_property = 0;
2459 defs->indirect_children = Qnil;
2460 syms->indirect_children = Qnil;
2463 /* 0 means var is always local. Default used only at creation.
2464 * -1 means var is always local. Default used only at reset and
2466 * -2 means there's no lisp variable corresponding to this slot
2467 * and the default is only used at creation.
2468 * -3 means no Lisp variable. Default used only at reset and creation.
2469 * >0 is mask. Var is local if ((buffer->local_var_flags & mask) != 0)
2470 * Otherwise default is used.
2472 Lisp_Object always_local_no_default = make_int (0);
2473 Lisp_Object always_local_resettable = make_int (-1);
2474 Lisp_Object resettable = make_int (-3);
2476 /* Assign the local-flags to the slots that have default values.
2477 The local flag is a bit that is used in the buffer
2478 to say that it has its own local value for the slot.
2479 The local flag bits are in the local_var_flags slot of the
2482 nuke_all_buffer_slots (&buffer_local_flags, make_int (-2));
2483 buffer_local_flags.filename = always_local_no_default;
2484 buffer_local_flags.directory = always_local_no_default;
2485 buffer_local_flags.backed_up = always_local_no_default;
2486 buffer_local_flags.saved_size = always_local_no_default;
2487 buffer_local_flags.auto_save_file_name = always_local_no_default;
2488 buffer_local_flags.read_only = always_local_no_default;
2490 buffer_local_flags.major_mode = always_local_resettable;
2491 buffer_local_flags.mode_name = always_local_resettable;
2492 buffer_local_flags.undo_list = always_local_no_default;
2494 buffer_local_flags.mark_active = always_local_resettable;
2496 buffer_local_flags.point_before_scroll = always_local_resettable;
2497 buffer_local_flags.file_truename = always_local_no_default;
2498 buffer_local_flags.invisibility_spec = always_local_resettable;
2499 buffer_local_flags.file_format = always_local_resettable;
2500 buffer_local_flags.generated_modeline_string = always_local_no_default;
2502 buffer_local_flags.keymap = resettable;
2503 buffer_local_flags.case_table = resettable;
2504 buffer_local_flags.syntax_table = resettable;
2506 buffer_local_flags.category_table = resettable;
2509 buffer_local_flags.modeline_format = make_int (1<<0);
2510 buffer_local_flags.abbrev_mode = make_int (1<<1);
2511 buffer_local_flags.overwrite_mode = make_int (1<<2);
2512 buffer_local_flags.case_fold_search = make_int (1<<3);
2513 buffer_local_flags.auto_fill_function = make_int (1<<4);
2514 buffer_local_flags.selective_display = make_int (1<<5);
2515 buffer_local_flags.selective_display_ellipses = make_int (1<<6);
2516 buffer_local_flags.tab_width = make_int (1<<7);
2517 buffer_local_flags.truncate_lines = make_int (1<<8);
2518 buffer_local_flags.ctl_arrow = make_int (1<<9);
2519 buffer_local_flags.fill_column = make_int (1<<10);
2520 buffer_local_flags.left_margin = make_int (1<<11);
2521 buffer_local_flags.abbrev_table = make_int (1<<12);
2522 #ifdef REGION_CACHE_NEEDS_WORK
2523 buffer_local_flags.cache_long_line_scans = make_int (1<<13);
2526 buffer_local_flags.buffer_file_coding_system = make_int (1<<14);
2529 /* #### Warning: 1<<31 is the largest number currently allowable
2530 due to the XINT() handling of this value. With some
2531 rearrangement you can get 3 more bits.
2533 #### 3 more? 34 bits???? -ben */
2537 #define BUFFER_SLOTS_SIZE (offsetof (struct buffer, BUFFER_SLOTS_LAST_NAME) - offsetof (struct buffer, BUFFER_SLOTS_FIRST_NAME) + sizeof (Lisp_Object))
2538 #define BUFFER_SLOTS_COUNT (BUFFER_SLOTS_SIZE / sizeof (Lisp_Object))
2541 reinit_complex_vars_of_buffer (void)
2543 struct buffer *defs, *syms;
2545 common_init_complex_vars_of_buffer ();
2547 defs = XBUFFER (Vbuffer_defaults);
2548 syms = XBUFFER (Vbuffer_local_symbols);
2549 memcpy (&defs->BUFFER_SLOTS_FIRST_NAME,
2550 buffer_defaults_saved_slots,
2552 memcpy (&syms->BUFFER_SLOTS_FIRST_NAME,
2553 buffer_local_symbols_saved_slots,
2558 static const struct lrecord_description buffer_slots_description_1[] = {
2559 { XD_LISP_OBJECT_ARRAY, 0, BUFFER_SLOTS_COUNT },
2563 static const struct struct_description buffer_slots_description = {
2565 buffer_slots_description_1
2569 complex_vars_of_buffer (void)
2571 struct buffer *defs, *syms;
2573 common_init_complex_vars_of_buffer ();
2575 defs = XBUFFER (Vbuffer_defaults);
2576 syms = XBUFFER (Vbuffer_local_symbols);
2577 buffer_defaults_saved_slots = &defs->BUFFER_SLOTS_FIRST_NAME;
2578 buffer_local_symbols_saved_slots = &syms->BUFFER_SLOTS_FIRST_NAME;
2579 dump_add_root_struct_ptr (&buffer_defaults_saved_slots, &buffer_slots_description);
2580 dump_add_root_struct_ptr (&buffer_local_symbols_saved_slots, &buffer_slots_description);
2582 DEFVAR_BUFFER_DEFAULTS ("default-modeline-format", modeline_format /*
2583 Default value of `modeline-format' for buffers that don't override it.
2584 This is the same as (default-value 'modeline-format).
2587 DEFVAR_BUFFER_DEFAULTS ("default-abbrev-mode", abbrev_mode /*
2588 Default value of `abbrev-mode' for buffers that do not override it.
2589 This is the same as (default-value 'abbrev-mode).
2592 DEFVAR_BUFFER_DEFAULTS ("default-ctl-arrow", ctl_arrow /*
2593 Default value of `ctl-arrow' for buffers that do not override it.
2594 This is the same as (default-value 'ctl-arrow).
2597 #if 0 /* #### make this a specifier! */
2598 DEFVAR_BUFFER_DEFAULTS ("default-display-direction", display_direction /*
2599 Default display-direction for buffers that do not override it.
2600 This is the same as (default-value 'display-direction).
2601 Note: This is not yet implemented.
2605 DEFVAR_BUFFER_DEFAULTS ("default-truncate-lines", truncate_lines /*
2606 Default value of `truncate-lines' for buffers that do not override it.
2607 This is the same as (default-value 'truncate-lines).
2610 DEFVAR_BUFFER_DEFAULTS ("default-fill-column", fill_column /*
2611 Default value of `fill-column' for buffers that do not override it.
2612 This is the same as (default-value 'fill-column).
2615 DEFVAR_BUFFER_DEFAULTS ("default-left-margin", left_margin /*
2616 Default value of `left-margin' for buffers that do not override it.
2617 This is the same as (default-value 'left-margin).
2620 DEFVAR_BUFFER_DEFAULTS ("default-tab-width", tab_width /*
2621 Default value of `tab-width' for buffers that do not override it.
2622 This is the same as (default-value 'tab-width).
2625 DEFVAR_BUFFER_DEFAULTS ("default-case-fold-search", case_fold_search /*
2626 Default value of `case-fold-search' for buffers that don't override it.
2627 This is the same as (default-value 'case-fold-search).
2630 DEFVAR_BUFFER_LOCAL ("modeline-format", modeline_format /*
2631 Template for displaying modeline for current buffer.
2632 Each buffer has its own value of this variable.
2633 Value may be a string, symbol, glyph, generic specifier, list or cons cell.
2634 For a symbol, its value is processed (but it is ignored if t or nil).
2635 A string appearing directly as the value of a symbol is processed verbatim
2636 in that the %-constructs below are not recognized.
2637 For a glyph, it is inserted as is.
2638 For a generic specifier (i.e. a specifier of type `generic'), its instance
2639 is computed in the current window using the equivalent of `specifier-instance'
2640 and the value is processed.
2641 For a list whose car is a symbol, the symbol's value is taken,
2642 and if that is non-nil, the cadr of the list is processed recursively.
2643 Otherwise, the caddr of the list (if there is one) is processed.
2644 For a list whose car is a string or list, each element is processed
2645 recursively and the results are effectively concatenated.
2646 For a list whose car is an integer, the cdr of the list is processed
2647 and padded (if the number is positive) or truncated (if negative)
2648 to the width specified by that number.
2649 For a list whose car is an extent, the cdr of the list is processed
2650 normally but the results are displayed using the face of the
2651 extent, and mouse clicks over this section are processed using the
2652 keymap of the extent. (In addition, if the extent has a help-echo
2653 property, that string will be echoed when the mouse moves over this
2654 section.) If extents are nested, all keymaps are properly consulted
2655 when processing mouse clicks, but multiple faces are not correctly
2656 merged (only the first face is used), and lists of faces are not
2657 correctly handled. See `generated-modeline-string' for more information.
2658 A string is printed verbatim in the modeline except for %-constructs:
2659 (%-constructs are processed when the string is the entire modeline-format
2660 or when it is found in a cons-cell or a list)
2661 %b -- print buffer name. %c -- print the current column number.
2662 %f -- print visited file name.
2663 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.
2664 % means buffer is read-only and * means it is modified.
2665 For a modified read-only buffer, %* gives % and %+ gives *.
2666 %s -- print process status. %l -- print the current line number.
2667 %S -- print name of selected frame (only meaningful under X Windows).
2668 %p -- print percent of buffer above top of window, or Top, Bot or All.
2669 %P -- print percent of buffer above bottom of window, perhaps plus Top,
2670 or print Bottom or All.
2671 %n -- print Narrow if appropriate.
2672 %C -- under XEmacs/mule, print the mnemonic for `buffer-file-coding-system'.
2673 %[ -- print one [ for each recursive editing level. %] similar.
2674 %% -- print %. %- -- print infinitely many dashes.
2675 Decimal digits after the % specify field width to which to pad.
2678 DEFVAR_BUFFER_DEFAULTS ("default-major-mode", major_mode /*
2679 *Major mode for new buffers. Defaults to `fundamental-mode'.
2680 nil here means use current buffer's major mode.
2683 DEFVAR_BUFFER_DEFAULTS ("fundamental-mode-abbrev-table", abbrev_table /*
2684 The abbrev table of mode-specific abbrevs for Fundamental Mode.
2687 DEFVAR_BUFFER_LOCAL ("major-mode", major_mode /*
2688 Symbol for current buffer's major mode.
2691 DEFVAR_BUFFER_LOCAL ("mode-name", mode_name /*
2692 Pretty name of current buffer's major mode (a string).
2695 DEFVAR_BUFFER_LOCAL ("abbrev-mode", abbrev_mode /*
2696 Non-nil turns on automatic expansion of abbrevs as they are inserted.
2697 Automatically becomes buffer-local when set in any fashion.
2700 DEFVAR_BUFFER_LOCAL ("case-fold-search", case_fold_search /*
2701 *Non-nil if searches should ignore case.
2702 Automatically becomes buffer-local when set in any fashion.
2705 DEFVAR_BUFFER_LOCAL ("fill-column", fill_column /*
2706 *Column beyond which automatic line-wrapping should happen.
2707 Automatically becomes buffer-local when set in any fashion.
2710 DEFVAR_BUFFER_LOCAL ("left-margin", left_margin /*
2711 *Column for the default indent-line-function to indent to.
2712 Linefeed indents to this column in Fundamental mode.
2713 Automatically becomes buffer-local when set in any fashion.
2714 Do not confuse this with the specifier `left-margin-width';
2715 that controls the size of a margin that is displayed outside
2719 DEFVAR_BUFFER_LOCAL_MAGIC ("tab-width", tab_width /*
2720 *Distance between tab stops (for display of tab characters), in columns.
2721 Automatically becomes buffer-local when set in any fashion.
2722 */ , redisplay_variable_changed);
2724 DEFVAR_BUFFER_LOCAL_MAGIC ("ctl-arrow", ctl_arrow /*
2725 *Non-nil means display control chars with uparrow.
2726 Nil means use backslash and octal digits.
2727 An integer means characters >= ctl-arrow are assumed to be printable, and
2728 will be displayed as a single glyph.
2729 Any other value is the same as 160 - the code SPC with the high bit on.
2731 The interpretation of this variable is likely to change in the future.
2733 Automatically becomes buffer-local when set in any fashion.
2734 This variable does not apply to characters whose display is specified
2735 in the current display table (if there is one).
2736 */ , redisplay_variable_changed);
2738 #if 0 /* #### Make this a specifier! */
2739 xxDEFVAR_BUFFER_LOCAL ("display-direction", display_direction /*
2740 *Non-nil means lines in the buffer are displayed right to left.
2741 Nil means left to right. (Not yet implemented.)
2743 #endif /* Not yet implemented */
2745 DEFVAR_BUFFER_LOCAL_MAGIC ("truncate-lines", truncate_lines /*
2746 *Non-nil means do not display continuation lines;
2747 give each line of text one frame line.
2748 Automatically becomes buffer-local when set in any fashion.
2750 Note that this is overridden by the variable
2751 `truncate-partial-width-windows' if that variable is non-nil
2752 and this buffer is not full-frame width.
2753 */ , redisplay_variable_changed);
2755 DEFVAR_BUFFER_LOCAL ("default-directory", directory /*
2756 Name of default directory of current buffer. Should end with slash.
2757 Each buffer has its own value of this variable.
2761 DEFVAR_BUFFER_DEFAULTS ("default-buffer-file-coding-system", buffer_file_coding_system /*
2762 Default value of `buffer-file-coding-system' for buffers that do not override it.
2763 This is the same as (default-value 'buffer-file-coding-system).
2764 This value is used both for buffers without associated files and
2765 for buffers whose files do not have any apparent coding system.
2766 See `buffer-file-coding-system'.
2769 DEFVAR_BUFFER_LOCAL ("buffer-file-coding-system", buffer_file_coding_system /*
2770 *Current coding system for the current buffer.
2771 When the buffer is written out into a file, this coding system will be
2772 used for the encoding. Automatically buffer-local when set in any
2773 fashion. This is normally set automatically when a file is loaded in
2774 based on the determined coding system of the file (assuming that
2775 `buffer-file-coding-system-for-read' is set to `undecided', which
2776 calls for automatic determination of the file's coding system).
2777 Normally the modeline indicates the current file coding system using
2778 its mnemonic abbreviation.
2780 The default value for this variable (which is normally used for
2781 buffers without associated files) is also used when automatic
2782 detection of a file's encoding is called for and there was no
2783 discernible encoding in the file (i.e. it was entirely or almost
2784 entirely ASCII). The default value should generally *not* be set to
2785 nil (equivalent to `no-conversion'), because if extended characters
2786 are ever inserted into the buffer, they will be lost when the file is
2787 written out. A good choice is `iso-2022-8' (the simple ISO 2022 8-bit
2788 encoding), which will write out ASCII and Latin-1 characters in the
2789 standard (and highly portable) fashion and use standard escape
2790 sequences for other charsets. Another reasonable choice is
2791 `escape-quoted', which is equivalent to `iso-2022-8' but prefixes
2792 certain control characters with ESC to make sure they are not
2793 interpreted as escape sequences when read in. This latter coding
2794 system results in more "correct" output in the presence of control
2795 characters in the buffer, in the sense that when read in again using
2796 the same coding system, the result will virtually always match the
2797 original contents of the buffer, which is not the case with
2798 `iso-2022-8'; but the output is less portable when dealing with binary
2799 data -- there may be stray ESC characters when the file is read by
2802 `buffer-file-coding-system' does *not* control the coding system used when
2803 a file is read in. Use the variables `buffer-file-coding-system-for-read'
2804 and `buffer-file-coding-system-alist' for that. From a Lisp program, if
2805 you wish to unilaterally specify the coding system used for one
2806 particular operation, you should bind the variable
2807 `coding-system-for-read' rather than changing the other two
2808 variables just mentioned, which are intended to be used for
2809 global environment specification.
2811 #endif /* FILE_CODING */
2813 DEFVAR_BUFFER_LOCAL ("auto-fill-function", auto_fill_function /*
2814 Function called (if non-nil) to perform auto-fill.
2815 It is called after self-inserting a space at a column beyond `fill-column'.
2816 Each buffer has its own value of this variable.
2817 NOTE: This variable is not an ordinary hook;
2818 It may not be a list of functions.
2821 DEFVAR_BUFFER_LOCAL ("buffer-file-name", filename /*
2822 Name of file visited in current buffer, or nil if not visiting a file.
2823 Each buffer has its own value of this variable.
2828 Abbreviated truename of file visited in current buffer, or nil if none.
2829 The truename of a file is calculated by `file-truename'
2830 and then abbreviated with `abbreviate-file-name'.
2831 Each buffer has its own value of this variable.
2833 #endif /* FSFmacs */
2835 DEFVAR_BUFFER_LOCAL ("buffer-file-truename", file_truename /*
2836 The real name of the file visited in the current buffer,
2837 or nil if not visiting a file. This is the result of passing
2838 buffer-file-name to the `file-truename' function. Every buffer has
2839 its own value of this variable. This variable is automatically
2840 maintained by the functions that change the file name associated
2844 DEFVAR_BUFFER_LOCAL ("buffer-auto-save-file-name", auto_save_file_name /*
2845 Name of file for auto-saving current buffer,
2846 or nil if buffer should not be auto-saved.
2847 Each buffer has its own value of this variable.
2850 DEFVAR_BUFFER_LOCAL ("buffer-read-only", read_only /*
2851 Non-nil if this buffer is read-only.
2852 Each buffer has its own value of this variable.
2855 DEFVAR_BUFFER_LOCAL ("buffer-backed-up", backed_up /*
2856 Non-nil if this buffer's file has been backed up.
2857 Backing up is done before the first time the file is saved.
2858 Each buffer has its own value of this variable.
2861 DEFVAR_BUFFER_LOCAL ("buffer-saved-size", saved_size /*
2862 Length of current buffer when last read in, saved or auto-saved.
2864 Each buffer has its own value of this variable.
2867 DEFVAR_BUFFER_LOCAL_MAGIC ("selective-display", selective_display /*
2868 Non-nil enables selective display:
2869 Integer N as value means display only lines
2870 that start with less than n columns of space.
2871 A value of t means, after a ^M, all the rest of the line is invisible.
2872 Then ^M's in the file are written into files as newlines.
2874 Automatically becomes buffer-local when set in any fashion.
2875 */, redisplay_variable_changed);
2878 DEFVAR_BUFFER_LOCAL_MAGIC ("selective-display-ellipses",
2879 selective_display_ellipses /*
2880 t means display ... on previous line when a line is invisible.
2881 Automatically becomes buffer-local when set in any fashion.
2882 */, redisplay_variable_changed);
2885 DEFVAR_BUFFER_LOCAL ("local-abbrev-table", abbrev_table /*
2886 Local (mode-specific) abbrev table of current buffer.
2889 DEFVAR_BUFFER_LOCAL ("overwrite-mode", overwrite_mode /*
2890 Non-nil if self-insertion should replace existing text.
2891 The value should be one of `overwrite-mode-textual',
2892 `overwrite-mode-binary', or nil.
2893 If it is `overwrite-mode-textual', self-insertion still
2894 inserts at the end of a line, and inserts when point is before a tab,
2895 until the tab is filled in.
2896 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too.
2897 Automatically becomes buffer-local when set in any fashion.
2899 Normally, you shouldn't modify this variable by hand, but use the functions
2900 `overwrite-mode' and `binary-overwrite-mode' instead. However, you can
2901 customize the default value from the options menu.
2905 /* Adds the following to the doc string for buffer-undo-list:
2907 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property
2908 was modified between BEG and END. PROPERTY is the property name,
2909 and VALUE is the old value.
2911 #endif /* FSFmacs */
2913 DEFVAR_BUFFER_LOCAL ("buffer-undo-list", undo_list /*
2914 List of undo entries in current buffer.
2915 Recent changes come first; older changes follow newer.
2917 An entry (START . END) represents an insertion which begins at
2918 position START and ends at position END.
2920 An entry (TEXT . POSITION) represents the deletion of the string TEXT
2921 from (abs POSITION). If POSITION is positive, point was at the front
2922 of the text being deleted; if negative, point was at the end.
2924 An entry (t HIGH . LOW) indicates that the buffer previously had
2925 "unmodified" status. HIGH and LOW are the high and low 16-bit portions
2926 of the visited file's modification time, as of that time. If the
2927 modification time of the most recent save is different, this entry is
2930 An entry of the form EXTENT indicates that EXTENT was attached in
2931 the buffer. Undoing an entry of this form detaches EXTENT.
2933 An entry of the form (EXTENT START END) indicates that EXTENT was
2934 detached from the buffer. Undoing an entry of this form attaches
2935 EXTENT from START to END.
2937 An entry of the form POSITION indicates that point was at the buffer
2938 location given by the integer. Undoing an entry of this form places
2941 nil marks undo boundaries. The undo command treats the changes
2942 between two undo boundaries as a single step to be undone.
2944 If the value of the variable is t, undo information is not recorded.
2948 xxDEFVAR_BUFFER_LOCAL ("mark-active", mark_active /*
2949 Non-nil means the mark and region are currently active in this buffer.
2950 Automatically local in all buffers.
2952 #endif /* FSFmacs */
2954 #ifdef REGION_CACHE_NEEDS_WORK
2955 xxDEFVAR_BUFFER_LOCAL ("cache-long-line-scans", cache_long_line_scans /*
2956 Non-nil means that Emacs should use caches to handle long lines more quickly.
2957 This variable is buffer-local, in all buffers.
2959 Normally, the line-motion functions work by scanning the buffer for
2960 newlines. Columnar operations (like move-to-column and
2961 compute-motion) also work by scanning the buffer, summing character
2962 widths as they go. This works well for ordinary text, but if the
2963 buffer's lines are very long (say, more than 500 characters), these
2964 motion functions will take longer to execute. Emacs may also take
2965 longer to update the display.
2967 If cache-long-line-scans is non-nil, these motion functions cache the
2968 results of their scans, and consult the cache to avoid rescanning
2969 regions of the buffer until the text is modified. The caches are most
2970 beneficial when they prevent the most searching---that is, when the
2971 buffer contains long lines and large regions of characters with the
2972 same, fixed screen width.
2974 When cache-long-line-scans is non-nil, processing short lines will
2975 become slightly slower (because of the overhead of consulting the
2976 cache), and the caches will use memory roughly proportional to the
2977 number of newlines and characters whose screen width varies.
2979 The caches require no explicit maintenance; their accuracy is
2980 maintained internally by the Emacs primitives. Enabling or disabling
2981 the cache should not affect the behavior of any of the motion
2982 functions; it should only affect their performance.
2984 #endif /* REGION_CACHE_NEEDS_WORK */
2986 DEFVAR_BUFFER_LOCAL ("point-before-scroll", point_before_scroll /*
2987 Value of point before the last series of scroll operations, or nil.
2990 DEFVAR_BUFFER_LOCAL ("buffer-file-format", file_format /*
2991 List of formats to use when saving this buffer.
2992 Formats are defined by `format-alist'. This variable is
2993 set when a file is visited. Automatically local in all buffers.
2996 DEFVAR_BUFFER_LOCAL_MAGIC ("buffer-invisibility-spec", invisibility_spec /*
2997 Invisibility spec of this buffer.
2998 The default is t, which means that text is invisible
2999 if it has (or is covered by an extent with) a non-nil `invisible' property.
3000 If the value is a list, a text character is invisible if its `invisible'
3001 property is an element in that list.
3002 If an element is a cons cell of the form (PROPERTY . ELLIPSIS),
3003 then characters with property value PROPERTY are invisible,
3004 and they have an ellipsis as well if ELLIPSIS is non-nil.
3005 Note that the actual characters used for the ellipsis are controllable
3006 using `invisible-text-glyph', and default to "...".
3007 */, redisplay_variable_changed);
3009 DEFVAR_CONST_BUFFER_LOCAL ("generated-modeline-string",
3010 generated_modeline_string /*
3011 String of characters in this buffer's modeline as of the last redisplay.
3012 Each time the modeline is recomputed, the resulting characters are
3013 stored in this string, which is resized as necessary. You may not
3014 set this variable, and modifying this string will not change the
3015 modeline; you have to change `modeline-format' if you want that.
3017 For each extent in `modeline-format' that is encountered when
3018 processing the modeline, a corresponding extent is placed in
3019 `generated-modeline-string' and covers the text over which the
3020 extent in `modeline-format' applies. The extent in
3021 `generated-modeline-string' is made a child of the extent in
3022 `modeline-format', which means that it inherits all properties from
3023 that extent. Note that the extents in `generated-modeline-string'
3024 are managed automatically. You should not explicitly put any extents
3025 in `generated-modeline-string'; if you do, they will disappear the
3026 next time the modeline is processed.
3028 For extents in `modeline-format', the following properties are currently
3032 Affects the face of the modeline text. Currently, faces do
3033 not merge properly; only the most recently encountered face
3034 is used. This is a bug.
3037 Affects the disposition of button events over the modeline
3038 text. Multiple applicable keymaps *are* handled properly,
3039 and `modeline-map' still applies to any events that don't
3040 have bindings in extent-specific keymaps.
3043 If a string, causes the string to be displayed when the mouse
3044 moves over the text.
3047 /* Check for DEFVAR_BUFFER_LOCAL without initializing the corresponding
3048 slot of buffer_local_flags and vice-versa. Must be done after all
3049 DEFVAR_BUFFER_LOCAL() calls. */
3050 #define MARKED_SLOT(slot) \
3051 if ((XINT (buffer_local_flags.slot) != -2 && \
3052 XINT (buffer_local_flags.slot) != -3) \
3053 != !(NILP (XBUFFER (Vbuffer_local_symbols)->slot))) \
3055 #include "bufslots.h"
3059 Lisp_Object scratch = Fget_buffer_create (QSscratch);
3060 Fset_buffer (scratch);
3061 /* Want no undo records for *scratch* until after Emacs is dumped */
3062 Fbuffer_disable_undo (scratch);
3066 #ifndef WIN32_NATIVE
3067 /* Is PWD another name for `.' ? */
3069 directory_is_current_directory (Extbyte *pwd)
3071 Bufbyte *pwd_internal;
3072 Bytecount pwd_internal_len;
3073 struct stat dotstat, pwdstat;
3075 TO_INTERNAL_FORMAT (DATA, (pwd, strlen ((char *)pwd) + 1),
3076 ALLOCA, (pwd_internal, pwd_internal_len),
3079 return (IS_DIRECTORY_SEP (*pwd_internal)
3080 && xemacs_stat ((char *) pwd_internal, &pwdstat) == 0
3081 && xemacs_stat (".", &dotstat) == 0
3082 && dotstat.st_ino == pwdstat.st_ino
3083 && dotstat.st_dev == pwdstat.st_dev
3084 && pwd_internal_len < MAXPATHLEN);
3089 init_initial_directory (void)
3091 /* This function can GC */
3093 #ifndef WIN32_NATIVE
3097 initial_directory[0] = 0;
3099 /* If PWD is accurate, use it instead of calling getcwd. This is faster
3100 when PWD is right, and may avoid a fatal error. */
3101 #ifndef WIN32_NATIVE
3102 if ((pwd = (Extbyte *) getenv ("PWD")) != NULL
3103 && directory_is_current_directory (pwd))
3104 strcpy (initial_directory, (char *) pwd);
3107 if (getcwd (initial_directory, MAXPATHLEN) == NULL)
3108 fatal ("`getcwd' failed: %s\n", strerror (errno));
3110 /* Make sure pwd is DIRECTORY_SEP-terminated.
3111 Maybe this should really use some standard subroutine
3112 whose definition is filename syntax dependent. */
3114 int len = strlen (initial_directory);
3116 if (! IS_DIRECTORY_SEP (initial_directory[len - 1]))
3118 initial_directory[len] = DIRECTORY_SEP;
3119 initial_directory[len + 1] = '\0';
3123 #ifdef CORRECT_DIR_SEPS
3124 CORRECT_DIR_SEPS (initial_directory);
3131 /* This function can GC */
3133 Fset_buffer (Fget_buffer_create (QSscratch));
3135 current_buffer->directory =
3136 build_ext_string (initial_directory, Qfile_name);
3139 /* #### is this correct? */
3140 temp = get_minibuffer (0);
3141 XBUFFER (temp)->directory = current_buffer->directory;
3142 #endif /* FSFmacs */