1 /* Buffer manipulation primitives for XEmacs.
2 Copyright (C) 1985-1989, 1992-1995 Free Software Foundation, Inc.
3 Copyright (C) 1995 Sun Microsystems, Inc.
4 Copyright (C) 1995, 1996 Ben Wing.
6 This file is part of XEmacs.
8 XEmacs is free software; you can redistribute it and/or modify it
9 under the terms of the GNU General Public License as published by the
10 Free Software Foundation; either version 2, or (at your option) any
13 XEmacs is distributed in the hope that it will be useful, but WITHOUT
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 You should have received a copy of the GNU General Public License
19 along with XEmacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
23 /* Synched up with: Mule 2.0, FSF 19.30. */
28 JWZ: some changes for Lemacs, long ago. (e.g. separate buffer
30 Mly: a few changes for buffer-local vars, 19.8 or 19.9.
31 Ben Wing: some changes and cleanups for Mule, 19.12.
34 /* This file contains functions that work with buffer objects.
35 Functions that manipulate a buffer's text, however, are not
38 1) The low-level functions that actually know about the
39 implementation of a buffer's text are located in insdel.c.
40 2) The higher-level (mostly Lisp) functions that manipulate a
41 buffer's text are in editfns.c.
42 3) The highest-level Lisp commands are in cmds.c.
46 -- Functions that know about syntax tables (forward-word,
47 scan-sexps, etc.) are in syntax.c, as are functions
48 that manipulate syntax tables.
49 -- Functions that know about case tables (upcase, downcase,
50 etc.) are in casefiddle.c. Functions that manipulate
51 case tables (case-table-p, set-case-table, etc.) are
53 -- Functions that do searching and replacing are in
54 search.c. The low-level functions that implement
55 regular expressions are in regex.c.
59 -- Some file and process functions (in fileio.c and process.c)
60 copy text from or insert text into a buffer; they call
61 low-level functions in insdel.c to do this.
62 -- insdel.c calls low-level functions in undo.c and extents.c
63 to record buffer modifications for undoing and to handle
64 extent adjustment and extent-data creation and insertion.
78 #include "file-coding.h"
83 #include "process.h" /* for kill_buffer_processes */
84 #ifdef REGION_CACHE_NEEDS_WORK
85 #include "region-cache.h"
87 #include "specifier.h"
89 #include "sysdep.h" /* for getwd */
94 struct buffer *current_buffer; /* the current buffer */
96 /* This structure holds the default values of the buffer-local variables
97 defined with DEFVAR_BUFFER_LOCAL, that have special slots in each buffer.
98 The default value occupies the same slot in this structure
99 as an individual buffer's value occupies in that buffer.
100 Setting the default value also goes through the alist of buffers
101 and stores into each buffer that does not say it has a local value. */
102 Lisp_Object Vbuffer_defaults;
103 static void *buffer_defaults_saved_slots;
105 /* This structure marks which slots in a buffer have corresponding
106 default values in Vbuffer_defaults.
107 Each such slot has a nonzero value in this structure.
108 The value has only one nonzero bit.
110 When a buffer has its own local value for a slot,
111 the bit for that slot (found in the same slot in this structure)
112 is turned on in the buffer's local_var_flags slot.
114 If a slot in this structure is 0, then there is a DEFVAR_BUFFER_LOCAL
115 for the slot, but there is no default value for it; the corresponding
116 slot in Vbuffer_defaults is not used except to initialize newly-created
119 If a slot is -1, then there is a DEFVAR_BUFFER_LOCAL for it
120 as well as a default value which is used to initialize newly-created
121 buffers and as a reset-value when local-vars are killed.
123 If a slot is -2, there is no DEFVAR_BUFFER_LOCAL for it.
124 (The slot is always local, but there's no lisp variable for it.)
125 The default value is only used to initialize newly-creation buffers.
127 If a slot is -3, then there is no DEFVAR_BUFFER_LOCAL for it but
128 there is a default which is used to initialize newly-creation
129 buffers and as a reset-value when local-vars are killed. */
130 struct buffer buffer_local_flags;
132 /* This is the initial (startup) directory, as used for the *scratch* buffer.
133 We're making this a global to make others aware of the startup directory.
134 `initial_directory' is stored in external format.
136 char initial_directory[MAXPATHLEN+1];
138 /* This structure holds the names of symbols whose values may be
139 buffer-local. It is indexed and accessed in the same way as the above. */
140 static Lisp_Object Vbuffer_local_symbols;
141 static void *buffer_local_symbols_saved_slots;
143 /* Alist of all buffer names vs the buffers. */
144 /* This used to be a variable, but is no longer,
145 to prevent lossage due to user rplac'ing this alist or its elements.
146 Note that there is a per-frame copy of this as well; the frame slot
147 and the global variable contain the same data, but possibly in different
148 orders, so that the buffer ordering can be per-frame.
150 Lisp_Object Vbuffer_alist;
152 /* Functions to call before and after each text change. */
153 Lisp_Object Qbefore_change_functions;
154 Lisp_Object Qafter_change_functions;
155 Lisp_Object Vbefore_change_functions;
156 Lisp_Object Vafter_change_functions;
158 /* #### Obsolete, for compatibility */
159 Lisp_Object Qbefore_change_function;
160 Lisp_Object Qafter_change_function;
161 Lisp_Object Vbefore_change_function;
162 Lisp_Object Vafter_change_function;
165 Lisp_Object Vtransient_mark_mode;
168 /* t means ignore all read-only text properties.
169 A list means ignore such a property if its value is a member of the list.
170 Any non-nil value means ignore buffer-read-only. */
171 Lisp_Object Vinhibit_read_only;
173 /* List of functions to call that can query about killing a buffer.
174 If any of these functions returns nil, we don't kill it. */
175 Lisp_Object Vkill_buffer_query_functions;
177 /* Non-nil means delete a buffer's auto-save file when the buffer is saved. */
178 int delete_auto_save_files;
180 Lisp_Object Qbuffer_live_p;
181 Lisp_Object Qbuffer_or_string_p;
183 /* List of functions to call before changing an unmodified buffer. */
184 Lisp_Object Vfirst_change_hook;
185 Lisp_Object Qfirst_change_hook;
187 Lisp_Object Qfundamental_mode;
188 Lisp_Object Qmode_class;
189 Lisp_Object Qpermanent_local;
191 Lisp_Object Qprotected_field;
193 Lisp_Object QSFundamental; /* A string "Fundamental" */
194 Lisp_Object QSscratch; /* "*scratch*" */
195 Lisp_Object Qdefault_directory;
197 Lisp_Object Qkill_buffer_hook;
199 Lisp_Object Qrename_auto_save_file;
201 Lisp_Object Qget_file_buffer;
202 Lisp_Object Qchange_major_mode_hook, Vchange_major_mode_hook;
204 Lisp_Object Qfind_file_compare_truenames;
206 Lisp_Object Qswitch_to_buffer;
208 /* Two thresholds controlling how much undo information to keep. */
210 int undo_high_threshold;
212 int find_file_compare_truenames;
213 int find_file_use_truenames;
216 static void reset_buffer_local_variables (struct buffer *, int first_time);
217 static void nuke_all_buffer_slots (struct buffer *b, Lisp_Object zap);
220 make_buffer (struct buffer *buf)
223 XSETBUFFER (obj, buf);
228 mark_buffer (Lisp_Object obj)
230 struct buffer *buf = XBUFFER (obj);
232 /* Truncate undo information. */
233 buf->undo_list = truncate_undo_list (buf->undo_list,
235 undo_high_threshold);
237 #define MARKED_SLOT(x) mark_object (buf->x)
238 #include "bufslots.h"
241 mark_object (buf->extent_info);
243 mark_object (buf->text->line_number_cache);
245 /* Don't mark normally through the children slot.
246 (Actually, in this case, it doesn't matter.) */
247 if (! EQ (buf->indirect_children, Qnull_pointer))
248 mark_conses_in_list (buf->indirect_children);
250 return buf->base_buffer ? make_buffer (buf->base_buffer) : Qnil;
254 print_buffer (Lisp_Object obj, Lisp_Object printcharfun, int escapeflag)
256 struct buffer *b = XBUFFER (obj);
260 if (!BUFFER_LIVE_P (b))
261 error ("printing unreadable object #<killed buffer>");
263 error ("printing unreadable object #<buffer %s>",
264 XSTRING_DATA (b->name));
266 else if (!BUFFER_LIVE_P (b))
267 write_c_string ("#<killed buffer>", printcharfun);
270 write_c_string ("#<buffer ", printcharfun);
271 print_internal (b->name, printcharfun, 1);
272 write_c_string (">", printcharfun);
276 print_internal (b->name, printcharfun, 0);
280 /* We do not need a finalize method to handle a buffer's children list
281 because all buffers have `kill-buffer' applied to them before
282 they disappear, and the children removal happens then. */
283 DEFINE_LRECORD_IMPLEMENTATION ("buffer", buffer,
284 mark_buffer, print_buffer, 0, 0, 0, 0,
287 DEFUN ("bufferp", Fbufferp, 1, 1, 0, /*
288 Return t if OBJECT is an editor buffer.
292 return BUFFERP (object) ? Qt : Qnil;
295 DEFUN ("buffer-live-p", Fbuffer_live_p, 1, 1, 0, /*
296 Return t if OBJECT is an editor buffer that has not been deleted.
300 return BUFFERP (object) && BUFFER_LIVE_P (XBUFFER (object)) ? Qt : Qnil;
304 nsberror (Lisp_Object spec)
307 error ("No buffer named %s", XSTRING_DATA (spec));
308 signal_simple_error ("Invalid buffer argument", spec);
311 DEFUN ("buffer-list", Fbuffer_list, 0, 1, 0, /*
312 Return a list of all existing live buffers.
313 The order is specific to the selected frame; if the optional FRAME
314 argument is provided, the ordering for that frame is returned instead.
315 If the FRAME argument is t, then the global (non-frame) ordering is
320 return Fmapcar (Qcdr,
321 EQ (frame, Qt) ? Vbuffer_alist :
322 decode_frame (frame)->buffer_alist);
326 get_buffer (Lisp_Object name, int error_if_deleted_or_does_not_exist)
330 if (!BUFFER_LIVE_P (XBUFFER (name)))
332 if (error_if_deleted_or_does_not_exist)
344 name = LISP_GETTEXT (name); /* I18N3 */
346 buf = Fcdr (Fassoc (name, Vbuffer_alist));
348 if (NILP (buf) && error_if_deleted_or_does_not_exist)
355 decode_buffer (Lisp_Object buffer, int allow_string)
358 return current_buffer;
360 if (allow_string && STRINGP (buffer))
361 return XBUFFER (get_buffer (buffer, 1));
363 CHECK_LIVE_BUFFER (buffer);
364 return XBUFFER (buffer);
367 DEFUN ("decode-buffer", Fdecode_buffer, 1, 1, 0, /*
368 Validate BUFFER or if BUFFER is nil, return the current buffer.
369 If BUFFER is a valid buffer or a string representing a valid buffer,
370 the corresponding buffer object will be returned. Otherwise an error
375 struct buffer *b = decode_buffer (buffer, 1);
376 XSETBUFFER (buffer, b);
382 /* Like Fassoc, but use Fstring_equal to compare
383 (which ignores text properties),
384 and don't ever QUIT. */
387 assoc_ignore_text_properties (REGISTER Lisp_Object key, Lisp_Object list)
389 REGISTER Lisp_Object tail;
390 for (tail = list; !NILP (tail); tail = Fcdr (tail))
392 REGISTER Lisp_Object elt, tem;
394 tem = Fstring_equal (Fcar (elt), key);
403 DEFUN ("get-buffer", Fget_buffer, 1, 1, 0, /*
404 Return the buffer named NAME (a string).
405 If there is no live buffer named NAME, return nil.
406 NAME may also be a buffer; if so, the value is that buffer.
411 /* #### Doc string should indicate that the buffer name will get
415 /* #### This might return a dead buffer. This is gross. This is
416 called FSF compatibility. */
419 return get_buffer (name, 0);
420 /* FSFmacs 19.29 calls assoc_ignore_text_properties() here.
425 DEFUN ("get-file-buffer", Fget_file_buffer, 1, 1, 0, /*
426 Return the buffer visiting file FILENAME (a string).
427 The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.
428 If there is no such live buffer, return nil.
430 Normally, the comparison is done by canonicalizing FILENAME (using
431 `expand-file-name') and comparing that to the value of `buffer-file-name'
432 for each existing buffer. However, If `find-file-compare-truenames' is
433 non-nil, FILENAME will be converted to its truename and the search will be
434 done on each buffer's value of `buffer-file-truename' instead of
435 `buffer-file-name'. Otherwise, if `find-file-use-truenames' is non-nil,
436 FILENAME will be converted to its truename and used for searching, but
437 the search will still be done on `buffer-file-name'.
441 /* This function can GC. GC checked 1997.04.06. */
442 REGISTER Lisp_Object buf;
446 /* DO NOT translate the filename. */
449 CHECK_STRING (filename);
450 filename = Fexpand_file_name (filename, Qnil);
452 /* If the file name has special constructs in it,
453 call the corresponding file handler. */
454 Lisp_Object handler = Ffind_file_name_handler (filename, Qget_file_buffer);
458 return call2 (handler, Qget_file_buffer, filename);
463 if (find_file_compare_truenames || find_file_use_truenames)
465 struct gcpro ngcpro1, ngcpro2, ngcpro3;
466 Lisp_Object fn = Qnil;
467 Lisp_Object dn = Qnil;
469 NGCPRO3 (fn, dn, filename);
470 fn = Ffile_truename (filename, Qnil);
473 dn = Ffile_name_directory (filename);
474 fn = Ffile_truename (dn, Qnil);
475 if (! NILP (fn)) dn = fn;
476 fn = Fexpand_file_name (Ffile_name_nondirectory (filename),
485 LIST_LOOP_2 (elt, Vbuffer_alist)
488 if (!BUFFERP (buf)) continue;
489 if (!STRINGP (XBUFFER (buf)->filename)) continue;
490 if (!NILP (Fstring_equal (filename,
491 (find_file_compare_truenames
492 ? XBUFFER (buf)->file_truename
493 : XBUFFER (buf)->filename))))
502 push_buffer_alist (Lisp_Object name, Lisp_Object buf)
504 Lisp_Object cons = Fcons (name, buf);
505 Lisp_Object frmcons, devcons, concons;
507 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (cons, Qnil));
508 FRAME_LOOP_NO_BREAK (frmcons, devcons, concons)
511 f = XFRAME (XCAR (frmcons));
512 f->buffer_alist = nconc2 (f->buffer_alist, Fcons (cons, Qnil));
517 delete_from_buffer_alist (Lisp_Object buf)
519 Lisp_Object cons = Frassq (buf, Vbuffer_alist);
520 Lisp_Object frmcons, devcons, concons;
522 return; /* abort() ? */
523 Vbuffer_alist = delq_no_quit (cons, Vbuffer_alist);
525 FRAME_LOOP_NO_BREAK (frmcons, devcons, concons)
528 f = XFRAME (XCAR (frmcons));
529 f->buffer_alist = delq_no_quit (cons, f->buffer_alist);
534 get_truename_buffer (REGISTER Lisp_Object filename)
536 /* FSFmacs has its own code here and doesn't call get-file-buffer.
537 That's because their equivalent of find-file-compare-truenames
538 (find-file-existing-other-name) isn't looked at in get-file-buffer.
539 This way is more correct. */
540 int count = specpdl_depth ();
542 specbind (Qfind_file_compare_truenames, Qt);
543 return unbind_to (count, Fget_file_buffer (filename));
546 static struct buffer *
547 allocate_buffer (void)
549 struct buffer *b = alloc_lcrecord_type (struct buffer, &lrecord_buffer);
551 copy_lcrecord (b, XBUFFER (Vbuffer_defaults));
557 finish_init_buffer (struct buffer *b, Lisp_Object name)
563 name = Fcopy_sequence (name);
564 /* #### This really does not need to be called. We already
565 initialized the buffer-local variables in allocate_buffer().
566 local_var_alist is set to Qnil at the same point, in
567 nuke_all_buffer_slots(). */
568 reset_buffer_local_variables (b, 1);
569 b->directory = current_buffer ? current_buffer->directory : Qnil;
571 b->last_window_start = 1;
574 if (string_byte (XSTRING (name), 0) != ' ')
579 /* initialize the extent list */
580 init_buffer_extents (b);
582 /* Put this in the alist of all live buffers. */
583 push_buffer_alist (name, buf);
585 init_buffer_markers (b);
587 b->generated_modeline_string = Fmake_string (make_int (84), make_int (' '));
588 b->modeline_extent_table = make_lisp_hash_table (20, HASH_TABLE_KEY_WEAK,
594 DEFUN ("get-buffer-create", Fget_buffer_create, 1, 1, 0, /*
595 Return the buffer named NAME, or create such a buffer and return it.
596 A new buffer is created if there is no live buffer named NAME.
597 If NAME starts with a space, the new buffer does not keep undo information.
598 If NAME is a buffer instead of a string, then it is the value returned.
599 The value is never nil.
603 /* This function can GC */
605 REGISTER struct buffer *b;
608 /* #### Doc string should indicate that the buffer name will get
612 name = LISP_GETTEXT (name);
613 buf = Fget_buffer (name);
617 if (XSTRING_LENGTH (name) == 0)
618 error ("Empty string for buffer name is not allowed");
620 b = allocate_buffer ();
622 b->text = &b->own_text;
624 b->indirect_children = Qnil;
625 init_buffer_text (b);
627 return finish_init_buffer (b, name);
630 DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, 2, 2,
631 "bMake indirect buffer (to buffer): \nBName of indirect buffer: ", /*
632 Create and return an indirect buffer for buffer BASE, named NAME.
633 BASE should be an existing buffer (or buffer name).
634 NAME should be a string which is not the name of an existing buffer.
635 If BASE is an indirect buffer itself, the base buffer for that buffer
636 is made the base buffer for the newly created buffer. (Thus, there will
637 never be indirect buffers whose base buffers are themselves indirect.)
641 /* This function can GC */
643 /* #### The above interactive specification is totally bogus,
644 because it offers an existing buffer as default answer to the
645 second question. However, the second argument may not BE an
649 base_buffer = get_buffer (base_buffer, 1);
652 /* #### Doc string should indicate that the buffer name will get
656 name = LISP_GETTEXT (name);
657 if (!NILP (Fget_buffer (name)))
658 signal_simple_error ("Buffer name already in use", name);
659 if (XSTRING_LENGTH (name) == 0)
660 error ("Empty string for buffer name is not allowed");
662 b = allocate_buffer ();
664 b->base_buffer = BUFFER_BASE_BUFFER (XBUFFER (base_buffer));
666 /* Use the base buffer's text object. */
667 b->text = b->base_buffer->text;
668 b->indirect_children = Qnil;
669 b->base_buffer->indirect_children =
670 Fcons (make_buffer (b), b->base_buffer->indirect_children);
671 init_buffer_text (b);
673 return finish_init_buffer (b, name);
679 reset_buffer_local_variables (struct buffer *b, int first_time)
681 struct buffer *def = XBUFFER (Vbuffer_defaults);
683 b->local_var_flags = 0;
684 /* For each slot that has a default value,
685 copy that into the slot. */
686 #define MARKED_SLOT(slot) \
687 { int mask = XINT (buffer_local_flags.slot); \
688 if ((mask > 0 || mask == -1 || mask == -3) \
690 || NILP (Fget (XBUFFER (Vbuffer_local_symbols)->slot, \
691 Qpermanent_local, Qnil)))) \
692 b->slot = def->slot; \
694 #include "bufslots.h"
697 #define STRING256_P(obj) \
698 (STRINGP (obj) && XSTRING_CHAR_LENGTH (obj) == 256)
699 /* If the standard case table has been altered and invalidated,
700 fix up its insides first. */
701 if (!(STRING256_P(Vascii_upcase_table) &&
702 STRING256_P(Vascii_canon_table) &&
703 STRING256_P(Vascii_eqv_table)))
705 Fset_standard_case_table (Vascii_downcase_table);
707 b->downcase_table = Vascii_downcase_table;
708 b->upcase_table = Vascii_upcase_table;
709 b->case_canon_table = Vascii_canon_table;
710 b->case_eqv_table = Vascii_eqv_table;
712 b->mirror_downcase_table = Vmirror_ascii_downcase_table;
713 b->mirror_upcase_table = Vmirror_ascii_upcase_table;
714 b->mirror_case_canon_table = Vmirror_ascii_canon_table;
715 b->mirror_case_eqv_table = Vmirror_ascii_eqv_table;
721 /* We split this away from generate-new-buffer, because rename-buffer
722 and set-visited-file-name ought to be able to use this to really
723 rename the buffer properly. */
725 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name, 1, 2, 0, /*
726 Return a string that is the name of no existing buffer based on NAME.
727 If there is no live buffer named NAME, then return NAME.
728 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
729 until an unused name is found, and then return that name.
730 Optional second argument IGNORE specifies a name that is okay to use
731 \(if it is in the sequence to be tried)
732 even if a buffer with that name exists.
736 REGISTER Lisp_Object gentemp, tem;
742 name = LISP_GETTEXT (name);
744 /* #### Doc string should indicate that the buffer name will get
748 tem = Fget_buffer (name);
755 sprintf (number, "<%d>", ++count);
756 gentemp = concat2 (name, build_string (number));
759 tem = Fstring_equal (gentemp, ignore);
763 tem = Fget_buffer (gentemp);
770 DEFUN ("buffer-name", Fbuffer_name, 0, 1, 0, /*
771 Return the name of BUFFER, as a string.
772 With no argument or nil as argument, return the name of the current buffer.
776 /* For compatibility, we allow a dead buffer here.
777 Earlier versions of Emacs didn't provide buffer-live-p. */
779 return current_buffer->name;
780 CHECK_BUFFER (buffer);
781 return XBUFFER (buffer)->name;
784 DEFUN ("buffer-file-name", Fbuffer_file_name, 0, 1, 0, /*
785 Return name of file BUFFER is visiting, or nil if none.
786 No argument or nil as argument means use the current buffer.
790 /* For compatibility, we allow a dead buffer here. Yuck! */
792 return current_buffer->filename;
793 CHECK_BUFFER (buffer);
794 return XBUFFER (buffer)->filename;
797 DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, 0, 1, 0, /*
798 Return the base buffer of indirect buffer BUFFER.
799 If BUFFER is not indirect, return nil.
803 struct buffer *buf = decode_buffer (buffer, 0);
805 return buf->base_buffer ? make_buffer (buf->base_buffer) : Qnil;
808 DEFUN ("buffer-indirect-children", Fbuffer_indirect_children, 0, 1, 0, /*
809 Return a list of all indirect buffers whose base buffer is BUFFER.
810 If BUFFER is indirect, the return value will always be nil; see
811 `make-indirect-buffer'.
815 struct buffer *buf = decode_buffer (buffer, 0);
817 return Fcopy_sequence (buf->indirect_children);
820 DEFUN ("buffer-local-variables", Fbuffer_local_variables, 0, 1, 0, /*
821 Return an alist of variables that are buffer-local in BUFFER.
822 Most elements look like (SYMBOL . VALUE), describing one variable.
823 For a symbol that is locally unbound, just the symbol appears in the value.
824 Note that storing new VALUEs in these elements doesn't change the variables.
825 No argument or nil as argument means use current buffer as BUFFER.
829 struct buffer *buf = decode_buffer (buffer, 0);
830 Lisp_Object result = Qnil;
834 for (tail = buf->local_var_alist; CONSP (tail); tail = XCDR (tail))
836 Lisp_Object elt = XCAR (tail);
837 /* Reference each variable in the alist in buf.
838 If inquiring about the current buffer, this gets the current values,
839 so store them into the alist so the alist is up to date.
840 If inquiring about some other buffer, this swaps out any values
841 for that buffer, making the alist up to date automatically. */
842 Lisp_Object val = find_symbol_value (XCAR (elt));
843 /* Use the current buffer value only if buf is the current buffer. */
844 if (buf != current_buffer)
847 /* If symbol is unbound, put just the symbol in the list. */
849 result = Fcons (XCAR (elt), result);
850 /* Otherwise, put (symbol . value) in the list. */
852 result = Fcons (Fcons (XCAR (elt), val), result);
856 /* Add on all the variables stored in special slots. */
858 struct buffer *syms = XBUFFER (Vbuffer_local_symbols);
859 #define MARKED_SLOT(slot) \
860 { int mask = XINT (buffer_local_flags.slot); \
861 if (mask == 0 || mask == -1 \
862 || ((mask > 0) && (buf->local_var_flags & mask))) \
863 result = Fcons (Fcons (syms->slot, buf->slot), result); \
865 #include "bufslots.h"
871 DEFUN ("buffer-dedicated-frame", Fbuffer_dedicated_frame, 0, 1, 0, /*
872 Return the frame dedicated to this BUFFER, or nil if there is none.
873 No argument or nil as argument means use current buffer as BUFFER.
877 struct buffer *buf = decode_buffer (buffer, 0);
879 /* XEmacs addition: if the frame is dead, silently make it go away. */
880 if (!NILP (buf->dedicated_frame) &&
881 !FRAME_LIVE_P (XFRAME (buf->dedicated_frame)))
882 buf->dedicated_frame = Qnil;
884 return buf->dedicated_frame;
887 DEFUN ("set-buffer-dedicated-frame", Fset_buffer_dedicated_frame, 2, 2, 0, /*
888 For this BUFFER, set the FRAME dedicated to it.
889 FRAME must be a frame or nil.
893 struct buffer *buf = decode_buffer (buffer, 0);
896 CHECK_LIVE_FRAME (frame); /* XEmacs change */
898 return buf->dedicated_frame = frame;
903 DEFUN ("buffer-modified-p", Fbuffer_modified_p, 0, 1, 0, /*
904 Return t if BUFFER was modified since its file was last read or saved.
905 No argument or nil as argument means use current buffer as BUFFER.
909 struct buffer *buf = decode_buffer (buffer, 0);
911 return BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf) ? Qt : Qnil;
914 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p, 1, 2, 0, /*
915 Mark BUFFER as modified or unmodified according to FLAG.
916 A non-nil FLAG means mark the buffer modified. No argument or nil
917 as BUFFER means use current buffer.
921 /* This function can GC */
922 struct buffer *buf = decode_buffer (buffer, 0);
924 #ifdef CLASH_DETECTION
925 /* If buffer becoming modified, lock the file.
926 If buffer becoming unmodified, unlock the file. */
928 Lisp_Object fn = buf->file_truename;
931 int already = BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf);
932 if (already == NILP (flag))
934 int count = specpdl_depth ();
935 /* lock_file() and unlock_file() currently use current_buffer */
936 /* #### - dmoore, what if lock_file or unlock_file kill
937 the current buffer? */
938 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
939 set_buffer_internal (buf);
940 if (!already && !NILP (flag))
942 else if (already && NILP (flag))
944 unbind_to (count, Qnil);
947 #endif /* CLASH_DETECTION */
949 /* This is often called when the buffer contents are altered but we
950 don't want to treat the changes that way (e.g. selective
951 display). We still need to make sure redisplay realizes that the
952 contents have potentially altered and it needs to do some
954 buf = decode_buffer(buffer, 0);
956 BUF_SAVE_MODIFF (buf) = NILP (flag) ? BUF_MODIFF (buf) : 0;
957 MARK_MODELINE_CHANGED;
962 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick, 0, 1, 0, /*
963 Return BUFFER's tick counter, incremented for each change in text.
964 Each buffer has a tick counter which is incremented each time the text in
965 that buffer is changed. It wraps around occasionally.
966 No argument or nil as argument means use current buffer as BUFFER.
970 struct buffer *buf = decode_buffer (buffer, 0);
972 return make_int (BUF_MODIFF (buf));
975 DEFUN ("rename-buffer", Frename_buffer, 1, 2,
976 "sRename buffer (to new name): \nP", /*
977 Change current buffer's name to NEWNAME (a string).
978 If second arg UNIQUE is nil or omitted, it is an error if a
979 buffer named NEWNAME already exists.
980 If UNIQUE is non-nil, come up with a new name using
981 `generate-new-buffer-name'.
982 Interactively, one can set UNIQUE with a prefix argument.
983 Returns the name we actually gave the buffer.
984 This does not change the name of the visited file (if any).
988 /* This function can GC */
989 Lisp_Object tem, buf;
992 /* #### Doc string should indicate that the buffer name will get
995 CHECK_STRING (newname);
996 newname = LISP_GETTEXT (newname);
998 if (XSTRING_LENGTH (newname) == 0)
999 error ("Empty string is invalid as a buffer name");
1001 tem = Fget_buffer (newname);
1002 /* Don't short-circuit if UNIQUE is t. That is a useful way to rename
1003 the buffer automatically so you can create another with the original name.
1004 It makes UNIQUE equivalent to
1005 (rename-buffer (generate-new-buffer-name NEWNAME)). */
1006 /* XEmacs change: added check for nil */
1007 if (NILP (unique) && !NILP (tem) && XBUFFER (tem) == current_buffer)
1008 return current_buffer->name;
1012 newname = Fgenerate_new_buffer_name (newname, current_buffer->name);
1014 error ("Buffer name \"%s\" is in use",
1015 XSTRING_DATA (newname));
1018 current_buffer->name = newname;
1020 /* Catch redisplay's attention. Unless we do this, the modelines for
1021 any windows displaying current_buffer will stay unchanged. */
1022 MARK_MODELINE_CHANGED;
1024 buf = Fcurrent_buffer ();
1026 /* The aconses in the Vbuffer_alist are shared with frame->buffer_alist,
1027 so this will change it in the per-frame ordering as well. */
1028 Fsetcar (Frassq (buf, Vbuffer_alist), newname);
1030 if (NILP (current_buffer->filename)
1031 && !NILP (current_buffer->auto_save_file_name))
1032 call0 (Qrename_auto_save_file);
1033 /* refetch since that last call may have done GC */
1034 /* (hypothetical relocating GC) */
1035 return current_buffer->name;
1038 DEFUN ("other-buffer", Fother_buffer, 0, 3, 0, /*
1039 Return most recently selected buffer other than BUFFER.
1040 Buffers not visible in windows are preferred to visible buffers,
1041 unless optional third argument VISIBLE-OK is non-nil.
1042 If no other buffer exists, the buffer `*scratch*' is returned.
1043 If BUFFER is omitted or nil, some interesting buffer is returned.
1045 The ordering is for this frame; If second optional argument FRAME
1046 is provided, then the ordering is for that frame. If the second arg
1047 is t, then the global ordering is returned.
1049 Note: In FSF Emacs, this function takes two arguments: BUFFER and
1052 (buffer, frame, visible_ok))
1054 /* This function can GC */
1055 Lisp_Object tail, buf, notsogood, tem;
1061 alist = Vbuffer_alist;
1064 struct frame *f = decode_frame (frame);
1066 XSETFRAME (frame, f);
1067 alist = f->buffer_alist;
1070 for (tail = alist; !NILP (tail); tail = Fcdr (tail))
1072 buf = Fcdr (Fcar (tail));
1073 if (EQ (buf, buffer))
1075 if (string_byte (XSTRING (XBUFFER (buf)->name), 0) == ' ')
1077 /* If FRAME has a buffer_predicate,
1078 disregard buffers that don't fit the predicate. */
1081 tem = XFRAME (frame)->buffer_predicate;
1084 tem = call1 (tem, buf);
1090 if (NILP (visible_ok))
1092 /* get-buffer-window will handle nil or t frame */
1093 tem = Fget_buffer_window (buf, frame, Qnil);
1099 if (NILP (notsogood))
1102 if (!NILP (notsogood))
1104 return Fget_buffer_create (QSscratch);
1107 DEFUN ("buffer-disable-undo", Fbuffer_disable_undo, 0, 1, "", /*
1108 Make BUFFER stop keeping undo information.
1109 Any undo records it already has are discarded.
1110 No argument or nil as argument means do this for the current buffer.
1114 /* Allowing nil is an RMSism */
1115 struct buffer *real_buf = decode_buffer (buffer, 1);
1116 real_buf->undo_list = Qt;
1120 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo, 0, 1, "", /*
1121 Start keeping undo information for buffer BUFFER.
1122 No argument or nil as argument means do this for the current buffer.
1126 /* Allowing nil is an RMSism */
1127 struct buffer *real_buf = decode_buffer (buffer, 1);
1128 if (EQ (real_buf->undo_list, Qt))
1129 real_buf->undo_list = Qnil;
1134 DEFUN ("kill-buffer", Fkill_buffer, 1, 1, "bKill buffer: ", /*
1135 Kill the buffer BUFFER.
1136 The argument may be a buffer or may be the name of a buffer.
1137 An argument of nil means kill the current buffer.
1139 Value is t if the buffer is actually killed, nil if user says no.
1141 The value of `kill-buffer-hook' (which may be local to that buffer),
1142 if not void, is a list of functions to be called, with no arguments,
1143 before the buffer is actually killed. The buffer to be killed is current
1144 when the hook functions are called.
1146 Any processes that have this buffer as the `process-buffer' are killed
1147 with `delete-process'.
1151 /* This function can call lisp */
1153 REGISTER struct buffer *b;
1154 struct gcpro gcpro1, gcpro2;
1157 buf = Fcurrent_buffer ();
1158 else if (BUFFERP (buffer))
1162 buf = get_buffer (buffer, 0);
1163 if (NILP (buf)) nsberror (buffer);
1168 /* OK to delete an already-deleted buffer. */
1169 if (!BUFFER_LIVE_P (b))
1172 /* Don't kill the minibuffer now current. */
1173 if (EQ (buf, Vminibuffer_zero))
1176 /* Or the echo area. */
1177 if (EQ (buf, Vecho_area_buffer))
1180 /* Query if the buffer is still modified. */
1181 if (INTERACTIVE && !NILP (b->filename)
1182 && BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
1188 (emacs_doprnt_string_c
1189 ((const Bufbyte *) GETTEXT ("Buffer %s modified; kill anyway? "),
1190 Qnil, -1, XSTRING_DATA (b->name))));
1194 b = XBUFFER (buf); /* Hypothetical relocating GC. */
1197 /* Run hooks with the buffer to be killed temporarily selected,
1198 unless the buffer is already dead (could have been deleted
1199 in the question above).
1201 if (BUFFER_LIVE_P (b))
1203 int speccount = specpdl_depth ();
1204 Lisp_Object tail = Qnil;
1207 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1210 /* First run the query functions; if any query is answered no,
1211 don't kill the buffer. */
1212 EXTERNAL_LIST_LOOP (tail, Vkill_buffer_query_functions)
1214 if (NILP (call0 (Fcar (tail))))
1217 return unbind_to (speccount, Qnil);
1221 /* Then run the hooks. */
1222 run_hook (Qkill_buffer_hook);
1223 #ifdef HAVE_X_WINDOWS
1224 /* If an X selection was in this buffer, disown it.
1225 We could have done this by simply adding this function to the
1226 kill-buffer-hook, but the user might mess that up.
1228 if (EQ (Vwindow_system, Qx))
1229 call0 (intern ("xselect-kill-buffer-hook"));
1230 /* #### generalize me! */
1231 #endif /* HAVE_X_WINDOWS */
1232 unbind_to (speccount, Qnil);
1234 b = XBUFFER (buf); /* Hypothetical relocating GC. */
1237 /* We have no more questions to ask. Verify that it is valid
1238 to kill the buffer. This must be done after the questions
1239 since anything can happen within yes-or-no-p. */
1241 /* Might have been deleted during the last question above */
1242 if (!BUFFER_LIVE_P (b))
1245 /* Don't kill the minibuffer now current. */
1246 if (EQ (buf, XWINDOW (minibuf_window)->buffer))
1249 /* When we kill a base buffer, kill all its indirect buffers.
1250 We do it at this stage so nothing terrible happens if they
1251 ask questions or their hooks get errors. */
1252 if (! b->base_buffer)
1258 LIST_LOOP (rest, b->indirect_children)
1260 Fkill_buffer (XCAR (rest));
1261 /* Keep indirect_children updated in case a
1262 query-function/hook throws. */
1263 b->indirect_children = XCDR (rest);
1269 /* Make this buffer not be current.
1270 In the process, notice if this is the sole visible buffer
1271 and give up if so. */
1272 if (b == current_buffer)
1274 Fset_buffer (Fother_buffer (buf, Qnil, Qnil));
1275 if (b == current_buffer)
1279 /* Now there is no question: we can kill the buffer. */
1281 #ifdef CLASH_DETECTION
1282 /* Unlock this buffer's file, if it is locked. unlock_buffer
1283 can both GC and kill the current buffer, and wreak general
1284 havok by running lisp code. */
1290 if (!BUFFER_LIVE_P (b))
1293 if (b == current_buffer)
1295 Fset_buffer (Fother_buffer (buf, Qnil, Qnil));
1296 if (b == current_buffer)
1299 #endif /* CLASH_DETECTION */
1302 int speccount = specpdl_depth ();
1303 specbind (Qinhibit_quit, Qt);
1305 kill_buffer_processes (buf);
1307 delete_from_buffer_alist (buf);
1309 /* #### This is a problem if this buffer is in a dedicated window.
1310 Need to undedicate any windows of this buffer first (and delete them?)
1312 Freplace_buffer_in_windows (buf);
1314 font_lock_buffer_was_killed (b);
1316 /* Delete any auto-save file, if we saved it in this session. */
1317 if (STRINGP (b->auto_save_file_name)
1318 && b->auto_save_modified != 0
1319 && BUF_SAVE_MODIFF (b) < b->auto_save_modified)
1321 if (delete_auto_save_files != 0)
1323 /* deleting the auto save file might kill b! */
1324 /* #### dmoore - fix this crap, we do this same gcpro and
1325 buffer liveness check multiple times. Let's get a
1326 macro or something for it. */
1328 internal_delete_file (b->auto_save_file_name);
1332 if (!BUFFER_LIVE_P (b))
1335 if (b == current_buffer)
1337 Fset_buffer (Fother_buffer (buf, Qnil, Qnil));
1338 if (b == current_buffer)
1344 uninit_buffer_markers (b);
1346 kill_buffer_local_variables (b);
1349 uninit_buffer_text (b);
1350 b->undo_list = Qnil;
1351 uninit_buffer_extents (b);
1354 #ifdef ERROR_CHECK_BUFPOS
1355 assert (!NILP (memq_no_quit (buf, b->base_buffer->indirect_children)));
1357 b->base_buffer->indirect_children =
1358 delq_no_quit (buf, b->base_buffer->indirect_children);
1361 /* Clear away all Lisp objects, so that they
1362 won't be protected from GC. */
1363 nuke_all_buffer_slots (b, Qnil);
1365 unbind_to (speccount, Qnil);
1370 DEFUN ("record-buffer", Frecord_buffer, 1, 1, 0, /*
1371 Place buffer BUFFER first in the buffer order.
1372 Call this function when a buffer is selected "visibly".
1374 This function changes the global buffer order and the per-frame buffer
1375 order for the selected frame. The buffer order keeps track of recency
1376 of selection so that `other-buffer' will return a recently selected
1377 buffer. See `other-buffer' for more information.
1381 REGISTER Lisp_Object lynk, prev;
1382 struct frame *f = selected_frame ();
1385 for (lynk = Vbuffer_alist; CONSP (lynk); lynk = XCDR (lynk))
1387 if (EQ (XCDR (XCAR (lynk)), buffer))
1391 /* Effectively do Vbuffer_alist = delq_no_quit (lynk, Vbuffer_alist) */
1393 Vbuffer_alist = XCDR (Vbuffer_alist);
1395 XCDR (prev) = XCDR (XCDR (prev));
1396 XCDR (lynk) = Vbuffer_alist;
1397 Vbuffer_alist = lynk;
1399 /* That was the global one. Now do the same thing for the
1400 per-frame buffer-alist. */
1402 for (lynk = f->buffer_alist; CONSP (lynk); lynk = XCDR (lynk))
1404 if (EQ (XCDR (XCAR (lynk)), buffer))
1408 /* Effectively do f->buffer_alist = delq_no_quit (lynk, f->buffer_alist) */
1410 f->buffer_alist = XCDR (f->buffer_alist);
1412 XCDR (prev) = XCDR (XCDR (prev));
1413 XCDR (lynk) = f->buffer_alist;
1414 f->buffer_alist = lynk;
1419 DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode, 1, 1, 0, /*
1420 Set an appropriate major mode for BUFFER, according to `default-major-mode'.
1421 Use this function before selecting the buffer, since it may need to inspect
1422 the current buffer's major mode.
1426 int speccount = specpdl_depth ();
1427 Lisp_Object function = XBUFFER (Vbuffer_defaults)->major_mode;
1429 if (NILP (function))
1431 Lisp_Object tem = Fget (current_buffer->major_mode, Qmode_class, Qnil);
1433 function = current_buffer->major_mode;
1436 if (NILP (function) || EQ (function, Qfundamental_mode))
1439 /* To select a nonfundamental mode,
1440 select the buffer temporarily and then call the mode function. */
1442 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
1444 Fset_buffer (buffer);
1447 return unbind_to (speccount, Qnil);
1451 switch_to_buffer (Lisp_Object bufname, Lisp_Object norecord)
1453 call2 (Qswitch_to_buffer, bufname, norecord);
1457 DEFUN ("current-buffer", Fcurrent_buffer, 0, 0, 0, /*
1458 Return the current buffer as a Lisp object.
1463 XSETBUFFER (buffer, current_buffer);
1467 /* Set the current buffer to B. */
1470 set_buffer_internal (struct buffer *b)
1472 REGISTER struct buffer *old_buf;
1473 REGISTER Lisp_Object tail;
1475 if (current_buffer == b)
1478 INVALIDATE_PIXEL_TO_GLYPH_CACHE;
1480 old_buf = current_buffer;
1482 invalidate_current_column (); /* invalidate indentation cache */
1485 if (!noninteractive && initialized)
1487 extern Lisp_Object Ffep_force_on (), Ffep_force_off (), Ffep_get_mode ();
1489 old_buf->fep_mode = Ffep_get_mode ();
1491 if (!NILP (current_buffer->fep_mode))
1496 #endif /* HAVE_FEP */
1500 /* Put the undo list back in the base buffer, so that it appears
1501 that an indirect buffer shares the undo list of its base. */
1502 if (old_buf->base_buffer)
1503 old_buf->base_buffer->undo_list = old_buf->undo_list;
1506 /* Get the undo list from the base buffer, so that it appears
1507 that an indirect buffer shares the undo list of its base. */
1509 b->undo_list = b->base_buffer->undo_list;
1511 /* Look down buffer's list of local Lisp variables
1512 to find and update any that forward into C variables. */
1514 LIST_LOOP (tail, b->local_var_alist)
1516 Lisp_Object sym = XCAR (XCAR (tail));
1517 Lisp_Object valcontents = XSYMBOL (sym)->value;
1518 if (SYMBOL_VALUE_MAGIC_P (valcontents))
1520 /* Just reference the variable
1521 to cause it to become set for this buffer. */
1522 /* Use find_symbol_value_quickly to avoid an unnecessary O(n)
1524 (void) find_symbol_value_quickly (XCAR (tail), 1);
1528 /* Do the same with any others that were local to the previous buffer */
1532 LIST_LOOP (tail, old_buf->local_var_alist)
1534 Lisp_Object sym = XCAR (XCAR (tail));
1535 Lisp_Object valcontents = XSYMBOL (sym)->value;
1537 if (SYMBOL_VALUE_MAGIC_P (valcontents))
1539 /* Just reference the variable
1540 to cause it to become set for this buffer. */
1541 /* Use find_symbol_value_quickly with find_it_p as 0 to avoid an
1542 unnecessary O(n) lookup which is guaranteed to be worst case.
1543 Any symbols which are local are guaranteed to have been
1544 handled in the previous loop, above. */
1545 (void) find_symbol_value_quickly (sym, 0);
1551 DEFUN ("set-buffer", Fset_buffer, 1, 1, 0, /*
1552 Make the buffer BUFFER current for editing operations.
1553 BUFFER may be a buffer or the name of an existing buffer.
1554 See also `save-excursion' when you want to make a buffer current temporarily.
1555 This function does not display the buffer, so its effect ends
1556 when the current command terminates.
1557 Use `switch-to-buffer' or `pop-to-buffer' to switch buffers permanently.
1561 buffer = get_buffer (buffer, 0);
1563 error ("Selecting deleted or non-existent buffer");
1564 set_buffer_internal (XBUFFER (buffer));
1569 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only, 0, 3, 0, /*
1570 Signal a `buffer-read-only' error if the buffer is read-only.
1571 Optional argument BUFFER defaults to the current buffer.
1573 If optional argument START is non-nil, all extents in the buffer
1574 which overlap that part of the buffer are checked to ensure none has a
1575 `read-only' property. (Extents that lie completely within the range,
1576 however, are not checked.) END defaults to the value of START.
1578 If START and END are equal, the range checked is [START, END] (i.e.
1579 closed on both ends); otherwise, the range checked is (START, END)
1580 \(open on both ends), except that extents that lie completely within
1581 [START, END] are not checked. See `extent-in-region-p' for a fuller
1584 (buffer, start, end))
1586 struct buffer *b = decode_buffer (buffer, 0);
1595 get_buffer_range_char (b, start, end, &s, &e, 0);
1597 barf_if_buffer_read_only (b, s, e);
1603 bury_buffer_1 (Lisp_Object buffer, Lisp_Object before,
1604 Lisp_Object *buffer_alist)
1606 Lisp_Object aelt = rassq_no_quit (buffer, *buffer_alist);
1607 Lisp_Object lynk = memq_no_quit (aelt, *buffer_alist);
1608 Lisp_Object iter, before_before;
1610 *buffer_alist = delq_no_quit (aelt, *buffer_alist);
1611 for (before_before = Qnil, iter = *buffer_alist;
1612 !NILP (iter) && !EQ (XCDR (XCAR (iter)), before);
1613 before_before = iter, iter = XCDR (iter))
1616 if (!NILP (before_before))
1617 XCDR (before_before) = lynk;
1619 *buffer_alist = lynk;
1622 DEFUN ("bury-buffer", Fbury_buffer, 0, 2, "", /*
1623 Put BUFFER at the end of the list of all buffers.
1624 There it is the least likely candidate for `other-buffer' to return;
1625 thus, the least likely buffer for \\[switch-to-buffer] to select by default.
1626 If BUFFER is nil or omitted, bury the current buffer.
1627 Also, if BUFFER is nil or omitted, remove the current buffer from the
1628 selected window if it is displayed there.
1629 Because of this, you may need to specify (current-buffer) as
1630 BUFFER when calling from minibuffer.
1631 If BEFORE is non-nil, it specifies a buffer before which BUFFER
1632 will be placed, instead of being placed at the end.
1636 /* This function can GC */
1637 struct buffer *buf = decode_buffer (buffer, 1);
1638 /* If we're burying the current buffer, unshow it. */
1639 /* Note that the behavior of (bury-buffer nil) and
1640 (bury-buffer (current-buffer)) is not the same.
1641 This is illogical but is historical. Changing it
1642 breaks mh-e and TeX and such packages. */
1644 switch_to_buffer (Fother_buffer (Fcurrent_buffer (), Qnil, Qnil), Qnil);
1645 XSETBUFFER (buffer, buf);
1648 before = get_buffer (before, 1);
1650 if (EQ (before, buffer))
1651 error ("Cannot place a buffer before itself");
1653 bury_buffer_1 (buffer, before, &Vbuffer_alist);
1654 bury_buffer_1 (buffer, before, &selected_frame ()->buffer_alist);
1660 DEFUN ("erase-buffer", Ferase_buffer, 0, 1, "*", /*
1661 Delete the entire contents of the BUFFER.
1662 Any clipping restriction in effect (see `narrow-to-region') is removed,
1663 so the buffer is truly empty after this.
1664 BUFFER defaults to the current buffer if omitted.
1668 /* This function can GC */
1669 struct buffer *b = decode_buffer (buffer, 1);
1670 /* #### yuck yuck yuck. This is gross. The old echo-area code,
1671 however, was the only place that called erase_buffer() with a
1672 non-zero NO_CLIP argument.
1674 Someone needs to fix up the redisplay code so it is smarter
1675 about this, so that the NO_CLIP junk isn't necessary. */
1676 int no_clip = (b == XBUFFER (Vecho_area_buffer));
1678 INVALIDATE_PIXEL_TO_GLYPH_CACHE;
1680 widen_buffer (b, no_clip);
1681 buffer_delete_range (b, BUF_BEG (b), BUF_Z (b), 0);
1682 b->last_window_start = 1;
1684 /* Prevent warnings, or suspension of auto saving, that would happen
1685 if future size is less than past size. Use of erase-buffer
1686 implies that the future text is not really related to the past text. */
1687 b->saved_size = Qzero;
1689 zmacs_region_stays = 0;
1695 DEFUN ("kill-all-local-variables", Fkill_all_local_variables, 0, 0, 0, /*
1696 Switch to Fundamental mode by killing current buffer's local variables.
1697 Most local variable bindings are eliminated so that the default values
1698 become effective once more. Also, the syntax table is set from
1699 `standard-syntax-table', the category table is set from
1700 `standard-category-table' (if support for Mule exists), local keymap is set
1701 to nil, the abbrev table is set from `fundamental-mode-abbrev-table',
1702 and all specifier specifications whose locale is the current buffer
1703 are removed. This function also forces redisplay of the modeline.
1705 Every function to select a new major mode starts by
1706 calling this function.
1708 As a special exception, local variables whose names have
1709 a non-nil `permanent-local' property are not eliminated by this function.
1711 The first thing this function does is run
1712 the normal hook `change-major-mode-hook'.
1716 /* This function can GC */
1717 run_hook (Qchange_major_mode_hook);
1719 reset_buffer_local_variables (current_buffer, 0);
1721 kill_buffer_local_variables (current_buffer);
1723 kill_specifier_buffer_locals (Fcurrent_buffer ());
1725 /* Force modeline redisplay. Useful here because all major mode
1726 commands call this function. */
1727 MARK_MODELINE_CHANGED;
1732 #ifdef MEMORY_USAGE_STATS
1743 compute_buffer_text_usage (struct buffer *b, struct overhead_stats *ovstats)
1745 int was_requested = b->text->z - 1;
1746 size_t gap = b->text->gap_size + b->text->end_gap_size;
1747 size_t malloc_use = malloced_storage_size (b->text->beg, was_requested + gap, 0);
1749 ovstats->gap_overhead += gap;
1750 ovstats->was_requested += was_requested;
1751 ovstats->malloc_overhead += malloc_use - (was_requested + gap);
1756 compute_buffer_usage (struct buffer *b, struct buffer_stats *stats,
1757 struct overhead_stats *ovstats)
1760 stats->other += malloced_storage_size (b, sizeof (*b), ovstats);
1761 stats->text += compute_buffer_text_usage (b, ovstats);
1762 stats->markers += compute_buffer_marker_usage (b, ovstats);
1763 stats->extents += compute_buffer_extent_usage (b, ovstats);
1766 DEFUN ("buffer-memory-usage", Fbuffer_memory_usage, 1, 1, 0, /*
1767 Return stats about the memory usage of buffer BUFFER.
1768 The values returned are in the form of an alist of usage types and byte
1769 counts. The byte counts attempt to encompass all the memory used
1770 by the buffer (separate from the memory logically associated with a
1771 buffer or frame), including internal structures and any malloc()
1772 overhead associated with them. In practice, the byte counts are
1773 underestimated because certain memory usage is very hard to determine
1774 \(e.g. the amount of memory used inside the Xt library or inside the
1775 X server) and because there is other stuff that might logically
1776 be associated with a window, buffer, or frame (e.g. window configurations,
1777 glyphs) but should not obviously be included in the usage counts.
1779 Multiple slices of the total memory usage may be returned, separated
1780 by a nil. Each slice represents a particular view of the memory, a
1781 particular way of partitioning it into groups. Within a slice, there
1782 is no overlap between the groups of memory, and each slice collectively
1783 represents all the memory concerned.
1787 struct buffer_stats stats;
1788 struct overhead_stats ovstats;
1789 Lisp_Object val = Qnil;
1791 CHECK_BUFFER (buffer); /* dead buffers should be allowed, no? */
1793 compute_buffer_usage (XBUFFER (buffer), &stats, &ovstats);
1795 val = acons (Qtext, make_int (stats.text), val);
1796 val = acons (Qmarkers, make_int (stats.markers), val);
1797 val = acons (Qextents, make_int (stats.extents), val);
1798 val = acons (Qother, make_int (stats.other), val);
1799 val = Fcons (Qnil, val);
1800 val = acons (Qactually_requested, make_int (ovstats.was_requested), val);
1801 val = acons (Qmalloc_overhead, make_int (ovstats.malloc_overhead), val);
1802 val = acons (Qgap_overhead, make_int (ovstats.gap_overhead), val);
1803 val = acons (Qdynarr_overhead, make_int (ovstats.dynarr_overhead), val);
1805 return Fnreverse (val);
1808 #endif /* MEMORY_USAGE_STATS */
1811 /************************************************************************/
1812 /* Implement TO_EXTERNAL_FORMAT, TO_INTERNAL_FORMAT */
1813 /************************************************************************/
1815 /* This implementation should probably be elsewhere, but it can't be
1816 in file-coding.c since that file is only available if FILE_CODING
1820 coding_system_is_binary (Lisp_Object coding_system)
1822 Lisp_Coding_System *cs = XCODING_SYSTEM (coding_system);
1824 (CODING_SYSTEM_TYPE (cs) == CODESYS_NO_CONVERSION &&
1825 CODING_SYSTEM_EOL_TYPE (cs) == EOL_LF &&
1826 EQ (CODING_SYSTEM_POST_READ_CONVERSION (cs), Qnil) &&
1827 EQ (CODING_SYSTEM_PRE_WRITE_CONVERSION (cs), Qnil));
1830 #define coding_system_is_binary(coding_system) 1
1833 static Extbyte_dynarr *conversion_out_dynarr;
1834 static Bufbyte_dynarr *conversion_in_dynarr;
1836 static int dfc_convert_to_external_format_in_use;
1837 static int dfc_convert_to_internal_format_in_use;
1840 dfc_convert_to_external_format_reset_in_use (Lisp_Object value)
1842 dfc_convert_to_external_format_in_use = XINT (value);
1847 dfc_convert_to_internal_format_reset_in_use (Lisp_Object value)
1849 dfc_convert_to_internal_format_in_use = XINT (value);
1854 dfc_convert_to_external_format (dfc_conversion_type source_type,
1855 dfc_conversion_data *source,
1857 Lisp_Object coding_system,
1859 dfc_conversion_type sink_type,
1860 dfc_conversion_data *sink)
1862 int count = specpdl_depth ();
1864 type_checking_assert
1865 (((source_type == DFC_TYPE_DATA) ||
1866 (source_type == DFC_TYPE_LISP_LSTREAM && LSTREAMP (source->lisp_object)) ||
1867 (source_type == DFC_TYPE_LISP_STRING && STRINGP (source->lisp_object)))
1869 ((sink_type == DFC_TYPE_DATA) ||
1870 (sink_type == DFC_TYPE_LISP_LSTREAM && LSTREAMP (source->lisp_object))));
1872 if (dfc_convert_to_external_format_in_use != 0)
1873 error ("Can't call a conversion function from a conversion function");
1875 dfc_convert_to_external_format_in_use = 1;
1877 record_unwind_protect (dfc_convert_to_external_format_reset_in_use,
1881 coding_system = Fget_coding_system (coding_system);
1884 Dynarr_reset (conversion_out_dynarr);
1886 /* Here we optimize in the case where the coding system does no
1887 conversion. However, we don't want to optimize in case the source
1888 or sink is an lstream, since writing to an lstream can cause a
1889 garbage collection, and this could be problematic if the source
1890 is a lisp string. */
1891 if (source_type != DFC_TYPE_LISP_LSTREAM &&
1892 sink_type != DFC_TYPE_LISP_LSTREAM &&
1893 coding_system_is_binary (coding_system))
1898 if (source_type == DFC_TYPE_LISP_STRING)
1900 ptr = XSTRING_DATA (source->lisp_object);
1901 len = XSTRING_LENGTH (source->lisp_object);
1905 ptr = (Bufbyte *) source->data.ptr;
1906 len = source->data.len;
1912 for (end = ptr + len; ptr < end;)
1915 (BYTE_ASCII_P (*ptr)) ? *ptr :
1916 (*ptr == LEADING_BYTE_CONTROL_1) ? (*(ptr+1) - 0x20) :
1917 (*ptr == LEADING_BYTE_LATIN_ISO8859_1) ? (*(ptr+1)) :
1920 Dynarr_add (conversion_out_dynarr, (Extbyte) c);
1923 bufpos_checking_assert (ptr == end);
1926 Dynarr_add_many (conversion_out_dynarr, ptr, len);
1932 Lisp_Object streams_to_delete[3];
1933 int delete_count = 0;
1934 Lisp_Object instream, outstream;
1935 Lstream *reader, *writer;
1936 struct gcpro gcpro1, gcpro2;
1938 if (source_type == DFC_TYPE_LISP_LSTREAM)
1939 instream = source->lisp_object;
1940 else if (source_type == DFC_TYPE_DATA)
1941 streams_to_delete[delete_count++] = instream =
1942 make_fixed_buffer_input_stream (source->data.ptr, source->data.len);
1945 type_checking_assert (source_type == DFC_TYPE_LISP_STRING);
1946 streams_to_delete[delete_count++] = instream =
1947 make_lisp_string_input_stream (source->lisp_object, 0, -1);
1950 if (sink_type == DFC_TYPE_LISP_LSTREAM)
1951 outstream = sink->lisp_object;
1954 type_checking_assert (sink_type == DFC_TYPE_DATA);
1955 streams_to_delete[delete_count++] = outstream =
1956 make_dynarr_output_stream
1957 ((unsigned_char_dynarr *) conversion_out_dynarr);
1961 streams_to_delete[delete_count++] = outstream =
1962 make_encoding_output_stream (XLSTREAM (outstream), coding_system);
1965 reader = XLSTREAM (instream);
1966 writer = XLSTREAM (outstream);
1967 /* decoding_stream will gc-protect outstream */
1968 GCPRO2 (instream, outstream);
1972 ssize_t size_in_bytes;
1973 char tempbuf[1024]; /* some random amount */
1975 size_in_bytes = Lstream_read (reader, tempbuf, sizeof (tempbuf));
1977 if (size_in_bytes == 0)
1979 else if (size_in_bytes < 0)
1980 error ("Error converting to external format");
1982 size_in_bytes = Lstream_write (writer, tempbuf, size_in_bytes);
1984 if (size_in_bytes <= 0)
1985 error ("Error converting to external format");
1988 /* Closing writer will close any stream at the other end of writer. */
1989 Lstream_close (writer);
1990 Lstream_close (reader);
1993 /* The idea is that this function will create no garbage. */
1994 while (delete_count)
1995 Lstream_delete (XLSTREAM (streams_to_delete [--delete_count]));
1998 unbind_to (count, Qnil);
2000 if (sink_type != DFC_TYPE_LISP_LSTREAM)
2002 sink->data.len = Dynarr_length (conversion_out_dynarr);
2003 Dynarr_add (conversion_out_dynarr, 0);
2004 sink->data.ptr = Dynarr_atp (conversion_out_dynarr, 0);
2009 dfc_convert_to_internal_format (dfc_conversion_type source_type,
2010 dfc_conversion_data *source,
2012 Lisp_Object coding_system,
2014 dfc_conversion_type sink_type,
2015 dfc_conversion_data *sink)
2017 int count = specpdl_depth ();
2019 type_checking_assert
2020 ((source_type == DFC_TYPE_DATA ||
2021 source_type == DFC_TYPE_LISP_LSTREAM)
2023 (sink_type == DFC_TYPE_DATA ||
2024 sink_type == DFC_TYPE_LISP_LSTREAM));
2026 if (dfc_convert_to_internal_format_in_use != 0)
2027 error ("Can't call a conversion function from a conversion function");
2029 dfc_convert_to_internal_format_in_use = 1;
2031 record_unwind_protect (dfc_convert_to_internal_format_reset_in_use,
2035 coding_system = Fget_coding_system (coding_system);
2038 Dynarr_reset (conversion_in_dynarr);
2040 if (source_type != DFC_TYPE_LISP_LSTREAM &&
2041 sink_type != DFC_TYPE_LISP_LSTREAM &&
2042 coding_system_is_binary (coding_system))
2045 const Bufbyte *ptr = (const Bufbyte *) source->data.ptr;
2046 Bytecount len = source->data.len;
2047 const Bufbyte *end = ptr + len;
2049 for (; ptr < end; ptr++)
2053 if (BYTE_ASCII_P (c))
2054 Dynarr_add (conversion_in_dynarr, c);
2055 else if (BYTE_C1_P (c))
2057 Dynarr_add (conversion_in_dynarr, LEADING_BYTE_CONTROL_1);
2058 Dynarr_add (conversion_in_dynarr, c + 0x20);
2062 Dynarr_add (conversion_in_dynarr, LEADING_BYTE_LATIN_ISO8859_1);
2063 Dynarr_add (conversion_in_dynarr, c);
2067 Dynarr_add_many (conversion_in_dynarr, source->data.ptr, source->data.len);
2072 Lisp_Object streams_to_delete[3];
2073 int delete_count = 0;
2074 Lisp_Object instream, outstream;
2075 Lstream *reader, *writer;
2076 struct gcpro gcpro1, gcpro2;
2078 if (source_type == DFC_TYPE_LISP_LSTREAM)
2079 instream = source->lisp_object;
2082 type_checking_assert (source_type == DFC_TYPE_DATA);
2083 streams_to_delete[delete_count++] = instream =
2084 make_fixed_buffer_input_stream (source->data.ptr, source->data.len);
2087 if (sink_type == DFC_TYPE_LISP_LSTREAM)
2088 outstream = sink->lisp_object;
2091 type_checking_assert (sink_type == DFC_TYPE_DATA);
2092 streams_to_delete[delete_count++] = outstream =
2093 make_dynarr_output_stream
2094 ((unsigned_char_dynarr *) conversion_in_dynarr);
2098 streams_to_delete[delete_count++] = outstream =
2099 make_decoding_output_stream (XLSTREAM (outstream), coding_system);
2102 reader = XLSTREAM (instream);
2103 writer = XLSTREAM (outstream);
2104 /* outstream will gc-protect its sink stream, if necessary */
2105 GCPRO2 (instream, outstream);
2109 ssize_t size_in_bytes;
2110 char tempbuf[1024]; /* some random amount */
2112 size_in_bytes = Lstream_read (reader, tempbuf, sizeof (tempbuf));
2114 if (size_in_bytes == 0)
2116 else if (size_in_bytes < 0)
2117 error ("Error converting to internal format");
2119 size_in_bytes = Lstream_write (writer, tempbuf, size_in_bytes);
2121 if (size_in_bytes <= 0)
2122 error ("Error converting to internal format");
2125 /* Closing writer will close any stream at the other end of writer. */
2126 Lstream_close (writer);
2127 Lstream_close (reader);
2130 /* The idea is that this function will create no garbage. */
2131 while (delete_count)
2132 Lstream_delete (XLSTREAM (streams_to_delete [--delete_count]));
2135 unbind_to (count, Qnil);
2137 if (sink_type != DFC_TYPE_LISP_LSTREAM)
2139 sink->data.len = Dynarr_length (conversion_in_dynarr);
2140 Dynarr_add (conversion_in_dynarr, 0); /* remember to zero-terminate! */
2141 sink->data.ptr = Dynarr_atp (conversion_in_dynarr, 0);
2147 syms_of_buffer (void)
2149 INIT_LRECORD_IMPLEMENTATION (buffer);
2151 defsymbol (&Qbuffer_live_p, "buffer-live-p");
2152 defsymbol (&Qbuffer_or_string_p, "buffer-or-string-p");
2153 defsymbol (&Qmode_class, "mode-class");
2154 defsymbol (&Qrename_auto_save_file, "rename-auto-save-file");
2155 defsymbol (&Qkill_buffer_hook, "kill-buffer-hook");
2156 defsymbol (&Qpermanent_local, "permanent-local");
2158 defsymbol (&Qfirst_change_hook, "first-change-hook");
2159 defsymbol (&Qbefore_change_functions, "before-change-functions");
2160 defsymbol (&Qafter_change_functions, "after-change-functions");
2162 /* #### Obsolete, for compatibility */
2163 defsymbol (&Qbefore_change_function, "before-change-function");
2164 defsymbol (&Qafter_change_function, "after-change-function");
2166 defsymbol (&Qdefault_directory, "default-directory");
2168 defsymbol (&Qget_file_buffer, "get-file-buffer");
2169 defsymbol (&Qchange_major_mode_hook, "change-major-mode-hook");
2171 defsymbol (&Qfundamental_mode, "fundamental-mode");
2173 defsymbol (&Qfind_file_compare_truenames, "find-file-compare-truenames");
2175 defsymbol (&Qswitch_to_buffer, "switch-to-buffer");
2178 DEFSUBR (Fbuffer_live_p);
2179 DEFSUBR (Fbuffer_list);
2180 DEFSUBR (Fdecode_buffer);
2181 DEFSUBR (Fget_buffer);
2182 DEFSUBR (Fget_file_buffer);
2183 DEFSUBR (Fget_buffer_create);
2184 DEFSUBR (Fmake_indirect_buffer);
2186 DEFSUBR (Fgenerate_new_buffer_name);
2187 DEFSUBR (Fbuffer_name);
2188 DEFSUBR (Fbuffer_file_name);
2189 DEFSUBR (Fbuffer_base_buffer);
2190 DEFSUBR (Fbuffer_indirect_children);
2191 DEFSUBR (Fbuffer_local_variables);
2192 DEFSUBR (Fbuffer_dedicated_frame);
2193 DEFSUBR (Fset_buffer_dedicated_frame);
2194 DEFSUBR (Fbuffer_modified_p);
2195 DEFSUBR (Fset_buffer_modified_p);
2196 DEFSUBR (Fbuffer_modified_tick);
2197 DEFSUBR (Frename_buffer);
2198 DEFSUBR (Fother_buffer);
2199 DEFSUBR (Fbuffer_disable_undo);
2200 DEFSUBR (Fbuffer_enable_undo);
2201 DEFSUBR (Fkill_buffer);
2202 DEFSUBR (Ferase_buffer);
2203 DEFSUBR (Frecord_buffer);
2204 DEFSUBR (Fset_buffer_major_mode);
2205 DEFSUBR (Fcurrent_buffer);
2206 DEFSUBR (Fset_buffer);
2207 DEFSUBR (Fbarf_if_buffer_read_only);
2208 DEFSUBR (Fbury_buffer);
2209 DEFSUBR (Fkill_all_local_variables);
2210 #ifdef MEMORY_USAGE_STATS
2211 DEFSUBR (Fbuffer_memory_usage);
2214 deferror (&Qprotected_field, "protected-field",
2215 "Attempt to modify a protected field", Qerror);
2219 reinit_vars_of_buffer (void)
2221 conversion_in_dynarr = Dynarr_new (Bufbyte);
2222 conversion_out_dynarr = Dynarr_new (Extbyte);
2224 staticpro_nodump (&Vbuffer_alist);
2225 Vbuffer_alist = Qnil;
2229 /* initialize the buffer routines */
2231 vars_of_buffer (void)
2233 /* This function can GC */
2234 reinit_vars_of_buffer ();
2236 staticpro (&QSFundamental);
2237 staticpro (&QSscratch);
2239 QSFundamental = build_string ("Fundamental");
2240 QSscratch = build_string (DEFER_GETTEXT ("*scratch*"));
2242 DEFVAR_LISP ("change-major-mode-hook", &Vchange_major_mode_hook /*
2243 List of hooks to be run before killing local variables in a buffer.
2244 This should be used by any mode that temporarily alters the contents or
2245 the read-only state of the buffer. See also `kill-all-local-variables'.
2247 Vchange_major_mode_hook = Qnil;
2249 DEFVAR_BOOL ("find-file-compare-truenames", &find_file_compare_truenames /*
2250 If this is true, then the find-file command will check the truenames
2251 of all visited files when deciding whether a given file is already in
2252 a buffer, instead of just the buffer-file-name. This means that if you
2253 attempt to visit another file which is a symbolic-link to a file which is
2254 already in a buffer, the existing buffer will be found instead of a newly-
2255 created one. This works if any component of the pathname (including a non-
2256 terminal component) is a symbolic link as well, but doesn't work with hard
2257 links (nothing does).
2259 See also the variable find-file-use-truenames.
2261 find_file_compare_truenames = 0;
2263 DEFVAR_BOOL ("find-file-use-truenames", &find_file_use_truenames /*
2264 If this is true, then a buffer's visited file-name will always be
2265 chased back to the real file; it will never be a symbolic link, and there
2266 will never be a symbolic link anywhere in its directory path.
2267 That is, the buffer-file-name and buffer-file-truename will be equal.
2268 This doesn't work with hard links.
2270 See also the variable find-file-compare-truenames.
2272 find_file_use_truenames = 0;
2274 DEFVAR_LISP ("before-change-functions", &Vbefore_change_functions /*
2275 List of functions to call before each text change.
2276 Two arguments are passed to each function: the positions of
2277 the beginning and end of the range of old text to be changed.
2278 \(For an insertion, the beginning and end are at the same place.)
2279 No information is given about the length of the text after the change.
2281 Buffer changes made while executing the `before-change-functions'
2282 don't call any before-change or after-change functions.
2284 Vbefore_change_functions = Qnil;
2286 /* FSF Emacs has the following additional doc at the end of
2287 before-change-functions and after-change-functions:
2289 That's because these variables are temporarily set to nil.
2290 As a result, a hook function cannot straightforwardly alter the value of
2291 these variables. See the Emacs Lisp manual for a way of
2292 accomplishing an equivalent result by using other variables.
2294 But this doesn't apply under XEmacs because things are
2297 DEFVAR_LISP ("after-change-functions", &Vafter_change_functions /*
2298 List of functions to call after each text change.
2299 Three arguments are passed to each function: the positions of
2300 the beginning and end of the range of changed text,
2301 and the length of the pre-change text replaced by that range.
2302 \(For an insertion, the pre-change length is zero;
2303 for a deletion, that length is the number of characters deleted,
2304 and the post-change beginning and end are at the same place.)
2306 Buffer changes made while executing `after-change-functions'
2307 don't call any before-change or after-change functions.
2309 Vafter_change_functions = Qnil;
2311 DEFVAR_LISP ("before-change-function", &Vbefore_change_function /*
2313 */ ); /* obsoleteness will be documented */
2314 Vbefore_change_function = Qnil;
2316 DEFVAR_LISP ("after-change-function", &Vafter_change_function /*
2318 */ ); /* obsoleteness will be documented */
2319 Vafter_change_function = Qnil;
2321 DEFVAR_LISP ("first-change-hook", &Vfirst_change_hook /*
2322 A list of functions to call before changing a buffer which is unmodified.
2323 The functions are run using the `run-hooks' function.
2325 Vfirst_change_hook = Qnil;
2328 xxDEFVAR_LISP ("transient-mark-mode", &Vtransient_mark_mode /*
2329 *Non-nil means deactivate the mark when the buffer contents change.
2331 Vtransient_mark_mode = Qnil;
2332 #endif /* FSFmacs */
2334 DEFVAR_INT ("undo-threshold", &undo_threshold /*
2335 Keep no more undo information once it exceeds this size.
2336 This threshold is applied when garbage collection happens.
2337 The size is counted as the number of bytes occupied,
2338 which includes both saved text and other data.
2340 undo_threshold = 20000;
2342 DEFVAR_INT ("undo-high-threshold", &undo_high_threshold /*
2343 Don't keep more than this much size of undo information.
2344 A command which pushes past this size is itself forgotten.
2345 This threshold is applied when garbage collection happens.
2346 The size is counted as the number of bytes occupied,
2347 which includes both saved text and other data.
2349 undo_high_threshold = 30000;
2351 DEFVAR_LISP ("inhibit-read-only", &Vinhibit_read_only /*
2352 *Non-nil means disregard read-only status of buffers or characters.
2353 If the value is t, disregard `buffer-read-only' and all `read-only'
2354 text properties. If the value is a list, disregard `buffer-read-only'
2355 and disregard a `read-only' extent property or text property if the
2356 property value is a member of the list.
2358 Vinhibit_read_only = Qnil;
2360 DEFVAR_LISP ("kill-buffer-query-functions", &Vkill_buffer_query_functions /*
2361 List of functions called with no args to query before killing a buffer.
2363 Vkill_buffer_query_functions = Qnil;
2365 DEFVAR_BOOL ("delete-auto-save-files", &delete_auto_save_files /*
2366 *Non-nil means delete auto-save file when a buffer is saved or killed.
2368 delete_auto_save_files = 1;
2371 /* The docstrings for DEFVAR_* are recorded externally by make-docfile. */
2373 /* Renamed from DEFVAR_PER_BUFFER because FSFmacs D_P_B takes
2374 a bogus extra arg, which confuses an otherwise identical make-docfile.c */
2375 #define DEFVAR_BUFFER_LOCAL_1(lname, field_name, forward_type, magicfun) do { \
2376 static const struct symbol_value_forward I_hate_C = \
2377 { /* struct symbol_value_forward */ \
2378 { /* struct symbol_value_magic */ \
2379 { /* struct lcrecord_header */ \
2380 { /* struct lrecord_header */ \
2381 lrecord_type_symbol_value_forward, /* lrecord_type_index */ \
2383 1, /* c_readonly bit */ \
2384 1 /* lisp_readonly bit */ \
2390 &(buffer_local_flags.field_name), \
2397 int offset = ((char *)symbol_value_forward_forward (&I_hate_C) - \
2398 (char *)&buffer_local_flags); \
2399 defvar_magic (lname, &I_hate_C); \
2401 *((Lisp_Object *)(offset + (char *)XBUFFER (Vbuffer_local_symbols))) \
2406 #define DEFVAR_BUFFER_LOCAL_MAGIC(lname, field_name, magicfun) \
2407 DEFVAR_BUFFER_LOCAL_1 (lname, field_name, \
2408 SYMVAL_CURRENT_BUFFER_FORWARD, magicfun)
2409 #define DEFVAR_BUFFER_LOCAL(lname, field_name) \
2410 DEFVAR_BUFFER_LOCAL_MAGIC (lname, field_name, 0)
2411 #define DEFVAR_CONST_BUFFER_LOCAL_MAGIC(lname, field_name, magicfun) \
2412 DEFVAR_BUFFER_LOCAL_1 (lname, field_name, \
2413 SYMVAL_CONST_CURRENT_BUFFER_FORWARD, magicfun)
2414 #define DEFVAR_CONST_BUFFER_LOCAL(lname, field_name) \
2415 DEFVAR_CONST_BUFFER_LOCAL_MAGIC (lname, field_name, 0)
2417 #define DEFVAR_BUFFER_DEFAULTS_MAGIC(lname, field_name, magicfun) \
2418 DEFVAR_SYMVAL_FWD (lname, &(buffer_local_flags.field_name), \
2419 SYMVAL_DEFAULT_BUFFER_FORWARD, magicfun)
2420 #define DEFVAR_BUFFER_DEFAULTS(lname, field_name) \
2421 DEFVAR_BUFFER_DEFAULTS_MAGIC (lname, field_name, 0)
2424 nuke_all_buffer_slots (struct buffer *b, Lisp_Object zap)
2428 b->extent_info = Qnil;
2429 b->indirect_children = Qnil;
2430 b->own_text.line_number_cache = Qnil;
2432 #define MARKED_SLOT(x) b->x = zap
2433 #include "bufslots.h"
2438 common_init_complex_vars_of_buffer (void)
2440 /* Make sure all markable slots in buffer_defaults
2441 are initialized reasonably, so mark_buffer won't choke. */
2442 struct buffer *defs = alloc_lcrecord_type (struct buffer, &lrecord_buffer);
2443 struct buffer *syms = alloc_lcrecord_type (struct buffer, &lrecord_buffer);
2445 staticpro_nodump (&Vbuffer_defaults);
2446 staticpro_nodump (&Vbuffer_local_symbols);
2447 XSETBUFFER (Vbuffer_defaults, defs);
2448 XSETBUFFER (Vbuffer_local_symbols, syms);
2450 nuke_all_buffer_slots (syms, Qnil);
2451 nuke_all_buffer_slots (defs, Qnil);
2452 defs->text = &defs->own_text;
2453 syms->text = &syms->own_text;
2455 /* Set up the non-nil default values of various buffer slots.
2456 Must do these before making the first buffer. */
2457 defs->major_mode = Qfundamental_mode;
2458 defs->mode_name = QSFundamental;
2459 defs->abbrev_table = Qnil; /* real default setup by Lisp code */
2461 defs->downcase_table = Vascii_downcase_table;
2462 defs->upcase_table = Vascii_upcase_table;
2463 defs->case_canon_table = Vascii_canon_table;
2464 defs->case_eqv_table = Vascii_eqv_table;
2466 defs->mirror_downcase_table = Vmirror_ascii_downcase_table;
2467 defs->mirror_upcase_table = Vmirror_ascii_upcase_table;
2468 defs->mirror_case_canon_table = Vmirror_ascii_canon_table;
2469 defs->mirror_case_eqv_table = Vmirror_ascii_eqv_table;
2471 defs->category_table = Vstandard_category_table;
2473 defs->syntax_table = Vstandard_syntax_table;
2474 defs->mirror_syntax_table =
2475 XCHAR_TABLE (Vstandard_syntax_table)->mirror_table;
2476 defs->modeline_format = build_string ("%-"); /* reset in loaddefs.el */
2477 defs->case_fold_search = Qt;
2478 defs->selective_display_ellipses = Qt;
2479 defs->tab_width = make_int (8);
2480 defs->ctl_arrow = Qt;
2481 defs->fill_column = make_int (70);
2482 defs->left_margin = Qzero;
2483 defs->saved_size = Qzero; /* lisp code wants int-or-nil */
2485 defs->auto_save_modified = 0;
2486 defs->auto_save_failure_time = -1;
2487 defs->invisibility_spec = Qt;
2489 defs->indirect_children = Qnil;
2490 syms->indirect_children = Qnil;
2493 /* 0 means var is always local. Default used only at creation.
2494 * -1 means var is always local. Default used only at reset and
2496 * -2 means there's no lisp variable corresponding to this slot
2497 * and the default is only used at creation.
2498 * -3 means no Lisp variable. Default used only at reset and creation.
2499 * >0 is mask. Var is local if ((buffer->local_var_flags & mask) != 0)
2500 * Otherwise default is used.
2502 Lisp_Object always_local_no_default = make_int (0);
2503 Lisp_Object always_local_resettable = make_int (-1);
2504 Lisp_Object resettable = make_int (-3);
2506 /* Assign the local-flags to the slots that have default values.
2507 The local flag is a bit that is used in the buffer
2508 to say that it has its own local value for the slot.
2509 The local flag bits are in the local_var_flags slot of the
2512 nuke_all_buffer_slots (&buffer_local_flags, make_int (-2));
2513 buffer_local_flags.filename = always_local_no_default;
2514 buffer_local_flags.directory = always_local_no_default;
2515 buffer_local_flags.backed_up = always_local_no_default;
2516 buffer_local_flags.saved_size = always_local_no_default;
2517 buffer_local_flags.auto_save_file_name = always_local_no_default;
2518 buffer_local_flags.read_only = always_local_no_default;
2520 buffer_local_flags.major_mode = always_local_resettable;
2521 buffer_local_flags.mode_name = always_local_resettable;
2522 buffer_local_flags.undo_list = always_local_no_default;
2524 buffer_local_flags.mark_active = always_local_resettable;
2526 buffer_local_flags.point_before_scroll = always_local_resettable;
2527 buffer_local_flags.file_truename = always_local_no_default;
2528 buffer_local_flags.invisibility_spec = always_local_resettable;
2529 buffer_local_flags.file_format = always_local_resettable;
2530 buffer_local_flags.generated_modeline_string = always_local_no_default;
2532 buffer_local_flags.keymap = resettable;
2533 buffer_local_flags.downcase_table = resettable;
2534 buffer_local_flags.upcase_table = resettable;
2535 buffer_local_flags.case_canon_table = resettable;
2536 buffer_local_flags.case_eqv_table = resettable;
2537 buffer_local_flags.syntax_table = resettable;
2539 buffer_local_flags.category_table = resettable;
2542 buffer_local_flags.modeline_format = make_int (1<<0);
2543 buffer_local_flags.abbrev_mode = make_int (1<<1);
2544 buffer_local_flags.overwrite_mode = make_int (1<<2);
2545 buffer_local_flags.case_fold_search = make_int (1<<3);
2546 buffer_local_flags.auto_fill_function = make_int (1<<4);
2547 buffer_local_flags.selective_display = make_int (1<<5);
2548 buffer_local_flags.selective_display_ellipses = make_int (1<<6);
2549 buffer_local_flags.tab_width = make_int (1<<7);
2550 buffer_local_flags.truncate_lines = make_int (1<<8);
2551 buffer_local_flags.ctl_arrow = make_int (1<<9);
2552 buffer_local_flags.fill_column = make_int (1<<10);
2553 buffer_local_flags.left_margin = make_int (1<<11);
2554 buffer_local_flags.abbrev_table = make_int (1<<12);
2555 #ifdef REGION_CACHE_NEEDS_WORK
2556 buffer_local_flags.cache_long_line_scans = make_int (1<<13);
2559 buffer_local_flags.buffer_file_coding_system = make_int (1<<14);
2562 /* #### Warning: 1<<31 is the largest number currently allowable
2563 due to the XINT() handling of this value. With some
2564 rearrangement you can get 3 more bits. */
2568 #define BUFFER_SLOTS_SIZE (offsetof (struct buffer, BUFFER_SLOTS_LAST_NAME) - offsetof (struct buffer, BUFFER_SLOTS_FIRST_NAME) + sizeof (Lisp_Object))
2569 #define BUFFER_SLOTS_COUNT (BUFFER_SLOTS_SIZE / sizeof (Lisp_Object))
2572 reinit_complex_vars_of_buffer (void)
2574 struct buffer *defs, *syms;
2576 common_init_complex_vars_of_buffer ();
2578 defs = XBUFFER (Vbuffer_defaults);
2579 syms = XBUFFER (Vbuffer_local_symbols);
2580 memcpy (&defs->BUFFER_SLOTS_FIRST_NAME,
2581 buffer_defaults_saved_slots,
2583 memcpy (&syms->BUFFER_SLOTS_FIRST_NAME,
2584 buffer_local_symbols_saved_slots,
2589 static const struct lrecord_description buffer_slots_description_1[] = {
2590 { XD_LISP_OBJECT_ARRAY, 0, BUFFER_SLOTS_COUNT },
2594 static const struct struct_description buffer_slots_description = {
2596 buffer_slots_description_1
2600 complex_vars_of_buffer (void)
2602 struct buffer *defs, *syms;
2604 common_init_complex_vars_of_buffer ();
2606 defs = XBUFFER (Vbuffer_defaults);
2607 syms = XBUFFER (Vbuffer_local_symbols);
2608 buffer_defaults_saved_slots = &defs->BUFFER_SLOTS_FIRST_NAME;
2609 buffer_local_symbols_saved_slots = &syms->BUFFER_SLOTS_FIRST_NAME;
2610 dumpstruct (&buffer_defaults_saved_slots, &buffer_slots_description);
2611 dumpstruct (&buffer_local_symbols_saved_slots, &buffer_slots_description);
2613 DEFVAR_BUFFER_DEFAULTS ("default-modeline-format", modeline_format /*
2614 Default value of `modeline-format' for buffers that don't override it.
2615 This is the same as (default-value 'modeline-format).
2618 DEFVAR_BUFFER_DEFAULTS ("default-abbrev-mode", abbrev_mode /*
2619 Default value of `abbrev-mode' for buffers that do not override it.
2620 This is the same as (default-value 'abbrev-mode).
2623 DEFVAR_BUFFER_DEFAULTS ("default-ctl-arrow", ctl_arrow /*
2624 Default value of `ctl-arrow' for buffers that do not override it.
2625 This is the same as (default-value 'ctl-arrow).
2628 #if 0 /* #### make this a specifier! */
2629 DEFVAR_BUFFER_DEFAULTS ("default-display-direction", display_direction /*
2630 Default display-direction for buffers that do not override it.
2631 This is the same as (default-value 'display-direction).
2632 Note: This is not yet implemented.
2636 DEFVAR_BUFFER_DEFAULTS ("default-truncate-lines", truncate_lines /*
2637 Default value of `truncate-lines' for buffers that do not override it.
2638 This is the same as (default-value 'truncate-lines).
2641 DEFVAR_BUFFER_DEFAULTS ("default-fill-column", fill_column /*
2642 Default value of `fill-column' for buffers that do not override it.
2643 This is the same as (default-value 'fill-column).
2646 DEFVAR_BUFFER_DEFAULTS ("default-left-margin", left_margin /*
2647 Default value of `left-margin' for buffers that do not override it.
2648 This is the same as (default-value 'left-margin).
2651 DEFVAR_BUFFER_DEFAULTS ("default-tab-width", tab_width /*
2652 Default value of `tab-width' for buffers that do not override it.
2653 This is the same as (default-value 'tab-width).
2656 DEFVAR_BUFFER_DEFAULTS ("default-case-fold-search", case_fold_search /*
2657 Default value of `case-fold-search' for buffers that don't override it.
2658 This is the same as (default-value 'case-fold-search).
2661 DEFVAR_BUFFER_LOCAL ("modeline-format", modeline_format /*
2662 Template for displaying modeline for current buffer.
2663 Each buffer has its own value of this variable.
2664 Value may be a string, a symbol or a list or cons cell.
2665 For a symbol, its value is used (but it is ignored if t or nil).
2666 A string appearing directly as the value of a symbol is processed verbatim
2667 in that the %-constructs below are not recognized.
2668 For a glyph, it is inserted as is.
2669 For a list whose car is a symbol, the symbol's value is taken,
2670 and if that is non-nil, the cadr of the list is processed recursively.
2671 Otherwise, the caddr of the list (if there is one) is processed.
2672 For a list whose car is a string or list, each element is processed
2673 recursively and the results are effectively concatenated.
2674 For a list whose car is an integer, the cdr of the list is processed
2675 and padded (if the number is positive) or truncated (if negative)
2676 to the width specified by that number.
2677 For a list whose car is an extent, the cdr of the list is processed
2678 normally but the results are displayed using the face of the
2679 extent, and mouse clicks over this section are processed using the
2680 keymap of the extent. (In addition, if the extent has a help-echo
2681 property, that string will be echoed when the mouse moves over this
2682 section.) See `generated-modeline-string' for more information.
2683 For a list whose car is a face, the cdr of the list is processed
2684 normally but the results will be displayed using the face in the car.
2685 For a list whose car is a keymap, the cdr of the list is processed
2686 normally but the keymap will apply for mouse clicks over the results,
2687 in addition to `modeline-map'. Nested keymap specifications are
2689 A string is printed verbatim in the modeline except for %-constructs:
2690 (%-constructs are processed when the string is the entire modeline-format
2691 or when it is found in a cons-cell or a list)
2692 %b -- print buffer name. %c -- print the current column number.
2693 %f -- print visited file name.
2694 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.
2695 % means buffer is read-only and * means it is modified.
2696 For a modified read-only buffer, %* gives % and %+ gives *.
2697 %s -- print process status. %l -- print the current line number.
2698 %S -- print name of selected frame (only meaningful under X Windows).
2699 %p -- print percent of buffer above top of window, or Top, Bot or All.
2700 %P -- print percent of buffer above bottom of window, perhaps plus Top,
2701 or print Bottom or All.
2702 %n -- print Narrow if appropriate.
2703 %C -- under XEmacs/mule, print the mnemonic for `buffer-file-coding-system'.
2704 %[ -- print one [ for each recursive editing level. %] similar.
2705 %% -- print %. %- -- print infinitely many dashes.
2706 Decimal digits after the % specify field width to which to pad.
2709 DEFVAR_BUFFER_DEFAULTS ("default-major-mode", major_mode /*
2710 *Major mode for new buffers. Defaults to `fundamental-mode'.
2711 nil here means use current buffer's major mode.
2714 DEFVAR_BUFFER_DEFAULTS ("fundamental-mode-abbrev-table", abbrev_table /*
2715 The abbrev table of mode-specific abbrevs for Fundamental Mode.
2718 DEFVAR_BUFFER_LOCAL ("major-mode", major_mode /*
2719 Symbol for current buffer's major mode.
2722 DEFVAR_BUFFER_LOCAL ("mode-name", mode_name /*
2723 Pretty name of current buffer's major mode (a string).
2726 DEFVAR_BUFFER_LOCAL ("abbrev-mode", abbrev_mode /*
2727 Non-nil turns on automatic expansion of abbrevs as they are inserted.
2728 Automatically becomes buffer-local when set in any fashion.
2731 DEFVAR_BUFFER_LOCAL ("case-fold-search", case_fold_search /*
2732 *Non-nil if searches should ignore case.
2733 Automatically becomes buffer-local when set in any fashion.
2735 BUG: Under XEmacs/Mule, translations to or from non-ASCII characters
2736 (this includes chars in the range 128 - 255) are ignored by
2737 the string/buffer-searching routines. Thus, `case-fold-search'
2738 will not correctly conflate a-umlaut and A-umlaut even if the
2739 case tables call for this.
2742 DEFVAR_BUFFER_LOCAL ("fill-column", fill_column /*
2743 *Column beyond which automatic line-wrapping should happen.
2744 Automatically becomes buffer-local when set in any fashion.
2747 DEFVAR_BUFFER_LOCAL ("left-margin", left_margin /*
2748 *Column for the default indent-line-function to indent to.
2749 Linefeed indents to this column in Fundamental mode.
2750 Automatically becomes buffer-local when set in any fashion.
2751 Do not confuse this with the specifier `left-margin-width';
2752 that controls the size of a margin that is displayed outside
2756 DEFVAR_BUFFER_LOCAL_MAGIC ("tab-width", tab_width /*
2757 *Distance between tab stops (for display of tab characters), in columns.
2758 Automatically becomes buffer-local when set in any fashion.
2759 */ , redisplay_variable_changed);
2761 DEFVAR_BUFFER_LOCAL_MAGIC ("ctl-arrow", ctl_arrow /*
2762 *Non-nil means display control chars with uparrow.
2763 Nil means use backslash and octal digits.
2764 An integer means characters >= ctl-arrow are assumed to be printable, and
2765 will be displayed as a single glyph.
2766 Any other value is the same as 160 - the code SPC with the high bit on.
2768 The interpretation of this variable is likely to change in the future.
2770 Automatically becomes buffer-local when set in any fashion.
2771 This variable does not apply to characters whose display is specified
2772 in the current display table (if there is one).
2773 */ , redisplay_variable_changed);
2775 #if 0 /* #### Make this a specifier! */
2776 xxDEFVAR_BUFFER_LOCAL ("display-direction", display_direction /*
2777 *Non-nil means lines in the buffer are displayed right to left.
2778 Nil means left to right. (Not yet implemented.)
2780 #endif /* Not yet implemented */
2782 DEFVAR_BUFFER_LOCAL_MAGIC ("truncate-lines", truncate_lines /*
2783 *Non-nil means do not display continuation lines;
2784 give each line of text one frame line.
2785 Automatically becomes buffer-local when set in any fashion.
2787 Note that this is overridden by the variable
2788 `truncate-partial-width-windows' if that variable is non-nil
2789 and this buffer is not full-frame width.
2790 */ , redisplay_variable_changed);
2792 DEFVAR_BUFFER_LOCAL ("default-directory", directory /*
2793 Name of default directory of current buffer. Should end with slash.
2794 Each buffer has its own value of this variable.
2798 DEFVAR_BUFFER_DEFAULTS ("default-buffer-file-coding-system", buffer_file_coding_system /*
2799 Default value of `buffer-file-coding-system' for buffers that do not override it.
2800 This is the same as (default-value 'buffer-file-coding-system).
2801 This value is used both for buffers without associated files and
2802 for buffers whose files do not have any apparent coding system.
2803 See `buffer-file-coding-system'.
2806 DEFVAR_BUFFER_LOCAL ("buffer-file-coding-system", buffer_file_coding_system /*
2807 *Current coding system for the current buffer.
2808 When the buffer is written out into a file, this coding system will be
2809 used for the encoding. Automatically buffer-local when set in any
2810 fashion. This is normally set automatically when a file is loaded in
2811 based on the determined coding system of the file (assuming that
2812 `buffer-file-coding-system-for-read' is set to `undecided', which
2813 calls for automatic determination of the file's coding system).
2814 Normally the modeline indicates the current file coding system using
2815 its mnemonic abbreviation.
2817 The default value for this variable (which is normally used for
2818 buffers without associated files) is also used when automatic
2819 detection of a file's encoding is called for and there was no
2820 discernible encoding in the file (i.e. it was entirely or almost
2821 entirely ASCII). The default value should generally *not* be set to
2822 nil (equivalent to `no-conversion'), because if extended characters
2823 are ever inserted into the buffer, they will be lost when the file is
2824 written out. A good choice is `iso-2022-8' (the simple ISO 2022 8-bit
2825 encoding), which will write out ASCII and Latin-1 characters in the
2826 standard (and highly portable) fashion and use standard escape
2827 sequences for other charsets. Another reasonable choice is
2828 `escape-quoted', which is equivalent to `iso-2022-8' but prefixes
2829 certain control characters with ESC to make sure they are not
2830 interpreted as escape sequences when read in. This latter coding
2831 system results in more "correct" output in the presence of control
2832 characters in the buffer, in the sense that when read in again using
2833 the same coding system, the result will virtually always match the
2834 original contents of the buffer, which is not the case with
2835 `iso-2022-8'; but the output is less portable when dealing with binary
2836 data -- there may be stray ESC characters when the file is read by
2839 `buffer-file-coding-system' does *not* control the coding system used when
2840 a file is read in. Use the variables `buffer-file-coding-system-for-read'
2841 and `buffer-file-coding-system-alist' for that. From a Lisp program, if
2842 you wish to unilaterally specify the coding system used for one
2843 particular operation, you should bind the variable
2844 `coding-system-for-read' rather than changing the other two
2845 variables just mentioned, which are intended to be used for
2846 global environment specification.
2848 #endif /* FILE_CODING */
2850 DEFVAR_BUFFER_LOCAL ("auto-fill-function", auto_fill_function /*
2851 Function called (if non-nil) to perform auto-fill.
2852 It is called after self-inserting a space at a column beyond `fill-column'.
2853 Each buffer has its own value of this variable.
2854 NOTE: This variable is not an ordinary hook;
2855 It may not be a list of functions.
2858 DEFVAR_BUFFER_LOCAL ("buffer-file-name", filename /*
2859 Name of file visited in current buffer, or nil if not visiting a file.
2860 Each buffer has its own value of this variable.
2865 Abbreviated truename of file visited in current buffer, or nil if none.
2866 The truename of a file is calculated by `file-truename'
2867 and then abbreviated with `abbreviate-file-name'.
2868 Each buffer has its own value of this variable.
2870 #endif /* FSFmacs */
2872 DEFVAR_BUFFER_LOCAL ("buffer-file-truename", file_truename /*
2873 The real name of the file visited in the current buffer,
2874 or nil if not visiting a file. This is the result of passing
2875 buffer-file-name to the `file-truename' function. Every buffer has
2876 its own value of this variable. This variable is automatically
2877 maintained by the functions that change the file name associated
2881 DEFVAR_BUFFER_LOCAL ("buffer-auto-save-file-name", auto_save_file_name /*
2882 Name of file for auto-saving current buffer,
2883 or nil if buffer should not be auto-saved.
2884 Each buffer has its own value of this variable.
2887 DEFVAR_BUFFER_LOCAL ("buffer-read-only", read_only /*
2888 Non-nil if this buffer is read-only.
2889 Each buffer has its own value of this variable.
2892 DEFVAR_BUFFER_LOCAL ("buffer-backed-up", backed_up /*
2893 Non-nil if this buffer's file has been backed up.
2894 Backing up is done before the first time the file is saved.
2895 Each buffer has its own value of this variable.
2898 DEFVAR_BUFFER_LOCAL ("buffer-saved-size", saved_size /*
2899 Length of current buffer when last read in, saved or auto-saved.
2901 Each buffer has its own value of this variable.
2904 DEFVAR_BUFFER_LOCAL_MAGIC ("selective-display", selective_display /*
2905 Non-nil enables selective display:
2906 Integer N as value means display only lines
2907 that start with less than n columns of space.
2908 A value of t means, after a ^M, all the rest of the line is invisible.
2909 Then ^M's in the file are written into files as newlines.
2911 Automatically becomes buffer-local when set in any fashion.
2912 */, redisplay_variable_changed);
2915 DEFVAR_BUFFER_LOCAL_MAGIC ("selective-display-ellipses",
2916 selective_display_ellipses /*
2917 t means display ... on previous line when a line is invisible.
2918 Automatically becomes buffer-local when set in any fashion.
2919 */, redisplay_variable_changed);
2922 DEFVAR_BUFFER_LOCAL ("local-abbrev-table", abbrev_table /*
2923 Local (mode-specific) abbrev table of current buffer.
2926 DEFVAR_BUFFER_LOCAL ("overwrite-mode", overwrite_mode /*
2927 Non-nil if self-insertion should replace existing text.
2928 The value should be one of `overwrite-mode-textual',
2929 `overwrite-mode-binary', or nil.
2930 If it is `overwrite-mode-textual', self-insertion still
2931 inserts at the end of a line, and inserts when point is before a tab,
2932 until the tab is filled in.
2933 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too.
2934 Automatically becomes buffer-local when set in any fashion.
2936 Normally, you shouldn't modify this variable by hand, but use the functions
2937 `overwrite-mode' and `binary-overwrite-mode' instead. However, you can
2938 customize the default value from the options menu.
2942 /* Adds the following to the doc string for buffer-undo-list:
2944 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property
2945 was modified between BEG and END. PROPERTY is the property name,
2946 and VALUE is the old value.
2948 #endif /* FSFmacs */
2950 DEFVAR_BUFFER_LOCAL ("buffer-undo-list", undo_list /*
2951 List of undo entries in current buffer.
2952 Recent changes come first; older changes follow newer.
2954 An entry (BEG . END) represents an insertion which begins at
2955 position BEG and ends at position END.
2957 An entry (TEXT . POSITION) represents the deletion of the string TEXT
2958 from (abs POSITION). If POSITION is positive, point was at the front
2959 of the text being deleted; if negative, point was at the end.
2961 An entry (t HIGH . LOW) indicates that the buffer previously had
2962 "unmodified" status. HIGH and LOW are the high and low 16-bit portions
2963 of the visited file's modification time, as of that time. If the
2964 modification time of the most recent save is different, this entry is
2967 An entry of the form EXTENT indicates that EXTENT was attached in
2968 the buffer. Undoing an entry of this form detaches EXTENT.
2970 An entry of the form (EXTENT START END) indicates that EXTENT was
2971 detached from the buffer. Undoing an entry of this form attaches
2972 EXTENT from START to END.
2974 An entry of the form POSITION indicates that point was at the buffer
2975 location given by the integer. Undoing an entry of this form places
2978 nil marks undo boundaries. The undo command treats the changes
2979 between two undo boundaries as a single step to be undone.
2981 If the value of the variable is t, undo information is not recorded.
2985 xxDEFVAR_BUFFER_LOCAL ("mark-active", mark_active /*
2986 Non-nil means the mark and region are currently active in this buffer.
2987 Automatically local in all buffers.
2989 #endif /* FSFmacs */
2991 #ifdef REGION_CACHE_NEEDS_WORK
2992 xxDEFVAR_BUFFER_LOCAL ("cache-long-line-scans", cache_long_line_scans /*
2993 Non-nil means that Emacs should use caches to handle long lines more quickly.
2994 This variable is buffer-local, in all buffers.
2996 Normally, the line-motion functions work by scanning the buffer for
2997 newlines. Columnar operations (like move-to-column and
2998 compute-motion) also work by scanning the buffer, summing character
2999 widths as they go. This works well for ordinary text, but if the
3000 buffer's lines are very long (say, more than 500 characters), these
3001 motion functions will take longer to execute. Emacs may also take
3002 longer to update the display.
3004 If cache-long-line-scans is non-nil, these motion functions cache the
3005 results of their scans, and consult the cache to avoid rescanning
3006 regions of the buffer until the text is modified. The caches are most
3007 beneficial when they prevent the most searching---that is, when the
3008 buffer contains long lines and large regions of characters with the
3009 same, fixed screen width.
3011 When cache-long-line-scans is non-nil, processing short lines will
3012 become slightly slower (because of the overhead of consulting the
3013 cache), and the caches will use memory roughly proportional to the
3014 number of newlines and characters whose screen width varies.
3016 The caches require no explicit maintenance; their accuracy is
3017 maintained internally by the Emacs primitives. Enabling or disabling
3018 the cache should not affect the behavior of any of the motion
3019 functions; it should only affect their performance.
3021 #endif /* REGION_CACHE_NEEDS_WORK */
3023 DEFVAR_BUFFER_LOCAL ("point-before-scroll", point_before_scroll /*
3024 Value of point before the last series of scroll operations, or nil.
3027 DEFVAR_BUFFER_LOCAL ("buffer-file-format", file_format /*
3028 List of formats to use when saving this buffer.
3029 Formats are defined by `format-alist'. This variable is
3030 set when a file is visited. Automatically local in all buffers.
3033 DEFVAR_BUFFER_LOCAL_MAGIC ("buffer-invisibility-spec", invisibility_spec /*
3034 Invisibility spec of this buffer.
3035 The default is t, which means that text is invisible
3036 if it has (or is covered by an extent with) a non-nil `invisible' property.
3037 If the value is a list, a text character is invisible if its `invisible'
3038 property is an element in that list.
3039 If an element is a cons cell of the form (PROP . ELLIPSIS),
3040 then characters with property value PROP are invisible,
3041 and they have an ellipsis as well if ELLIPSIS is non-nil.
3042 Note that the actual characters used for the ellipsis are controllable
3043 using `invisible-text-glyph', and default to "...".
3044 */, redisplay_variable_changed);
3046 DEFVAR_CONST_BUFFER_LOCAL ("generated-modeline-string",
3047 generated_modeline_string /*
3048 String of characters in this buffer's modeline as of the last redisplay.
3049 Each time the modeline is recomputed, the resulting characters are
3050 stored in this string, which is resized as necessary. You may not
3051 set this variable, and modifying this string will not change the
3052 modeline; you have to change `modeline-format' if you want that.
3054 For each extent in `modeline-format' that is encountered when
3055 processing the modeline, a corresponding extent is placed in
3056 `generated-modeline-string' and covers the text over which the
3057 extent in `modeline-format' applies. The extent in
3058 `generated-modeline-string' is made a child of the extent in
3059 `modeline-format', which means that it inherits all properties from
3060 that extent. Note that the extents in `generated-modeline-string'
3061 are managed automatically. You should not explicitly put any extents
3062 in `generated-modeline-string'; if you do, they will disappear the
3063 next time the modeline is processed.
3065 For extents in `modeline-format', the following properties are currently
3069 Affects the face of the modeline text. Currently, faces do
3070 not merge properly; only the most recently encountered face
3071 is used. This is a bug.
3074 Affects the disposition of button events over the modeline
3075 text. Multiple applicable keymaps *are* handled properly,
3076 and `modeline-map' still applies to any events that don't
3077 have bindings in extent-specific keymaps.
3080 If a string, causes the string to be displayed when the mouse
3081 moves over the text.
3084 /* Check for DEFVAR_BUFFER_LOCAL without initializing the corresponding
3085 slot of buffer_local_flags and vice-versa. Must be done after all
3086 DEFVAR_BUFFER_LOCAL() calls. */
3087 #define MARKED_SLOT(slot) \
3088 if ((XINT (buffer_local_flags.slot) != -2 && \
3089 XINT (buffer_local_flags.slot) != -3) \
3090 != !(NILP (XBUFFER (Vbuffer_local_symbols)->slot))) \
3092 #include "bufslots.h"
3096 Lisp_Object scratch = Fget_buffer_create (QSscratch);
3097 Fset_buffer (scratch);
3098 /* Want no undo records for *scratch* until after Emacs is dumped */
3099 Fbuffer_disable_undo (scratch);
3103 /* Is PWD another name for `.' ? */
3105 directory_is_current_directory (Extbyte *pwd)
3107 Bufbyte *pwd_internal;
3108 Bytecount pwd_internal_len;
3109 struct stat dotstat, pwdstat;
3111 TO_INTERNAL_FORMAT (DATA, (pwd, strlen ((char *)pwd) + 1),
3112 ALLOCA, (pwd_internal, pwd_internal_len),
3115 return (IS_DIRECTORY_SEP (*pwd_internal)
3116 && stat ((char *) pwd_internal, &pwdstat) == 0
3117 && stat (".", &dotstat) == 0
3118 && dotstat.st_ino == pwdstat.st_ino
3119 && dotstat.st_dev == pwdstat.st_dev
3120 && pwd_internal_len < MAXPATHLEN);
3124 init_initial_directory (void)
3126 /* This function can GC */
3130 initial_directory[0] = 0;
3132 /* If PWD is accurate, use it instead of calling getcwd. This is faster
3133 when PWD is right, and may avoid a fatal error. */
3134 if ((pwd = (Extbyte *) getenv ("PWD")) != NULL
3135 && directory_is_current_directory (pwd))
3136 strcpy (initial_directory, (char *) pwd);
3137 else if (getcwd (initial_directory, MAXPATHLEN) == NULL)
3138 fatal ("`getcwd' failed: %s\n", strerror (errno));
3140 /* Make sure pwd is DIRECTORY_SEP-terminated.
3141 Maybe this should really use some standard subroutine
3142 whose definition is filename syntax dependent. */
3144 int len = strlen (initial_directory);
3146 if (! IS_DIRECTORY_SEP (initial_directory[len - 1]))
3148 initial_directory[len] = DIRECTORY_SEP;
3149 initial_directory[len + 1] = '\0';
3153 /* XEmacs change: store buffer's default directory
3154 using preferred (i.e. as defined at compile-time)
3155 directory separator. --marcpa */
3157 #define CORRECT_DIR_SEPS(s) \
3158 do { if ('/' == DIRECTORY_SEP) dostounix_filename (s); \
3159 else unixtodos_filename (s); \
3162 CORRECT_DIR_SEPS(initial_directory);
3169 /* This function can GC */
3171 Fset_buffer (Fget_buffer_create (QSscratch));
3173 current_buffer->directory =
3174 build_ext_string (initial_directory, Qfile_name);
3177 /* #### is this correct? */
3178 temp = get_minibuffer (0);
3179 XBUFFER (temp)->directory = current_buffer->directory;
3180 #endif /* FSFmacs */