1 /* Definitions of marked slots in buffers
2 Copyright (C) 1990, 1992, 1993 Free Software Foundation, Inc.
3 Copyright (C) 2001 MORIOKA Tomohiko
5 This file is part of XEmacs.
7 XEmacs is free software; you can redistribute it and/or modify it
8 under the terms of the GNU General Public License as published by the
9 Free Software Foundation; either version 2, or (at your option) any
12 XEmacs is distributed in the hope that it will be useful, but WITHOUT
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
17 You should have received a copy of the GNU General Public License
18 along with XEmacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 /* Synched up with: Mule 2.0, FSF 19.30. Split out of buffer.h. */
26 FSF: long ago (part of buffer.h).
27 JWZ: separated out from buffer.h, early in Lemacs.
28 XEmacs: a few other changes.
31 /* In the declaration of the buffer structure, this file is included
32 after defining MARKED_SLOT(x) to be Lisp_Object x; i.e. just a slot
33 definition. In the garbage collector this file is included after
34 defining MARKED_SLOT(x) to be mark_object(buffer->x). */
36 #ifndef BUFFER_SLOTS_FIRST_NAME
37 #define BUFFER_SLOTS_FIRST_NAME name
40 /* The name of this buffer. */
43 /* The name of the file visited in this buffer, or nil. */
44 MARKED_SLOT (filename);
46 /* Dir for expanding relative file names. */
47 MARKED_SLOT (directory);
49 /* True iff this buffer has been backed up (if you write to the
50 visited file and it hasn't been backed up, then a backup will
52 /* #### This isn't really used by the C code, so could be deleted. */
53 MARKED_SLOT (backed_up);
55 /* Length of file when last read or saved.
56 This is not in the struct buffer_text
57 because it's not used in indirect buffers at all. */
58 MARKED_SLOT (saved_size);
60 /* File name used for auto-saving this buffer.
61 This is not in the struct buffer_text
62 because it's not used in indirect buffers at all. */
63 MARKED_SLOT (auto_save_file_name);
65 /* Non-nil if buffer read-only. */
66 MARKED_SLOT (read_only);
68 /* "The mark". This is a marker which may
69 point into this buffer or may point nowhere. */
72 /* Alist of elements (SYMBOL . VALUE-IN-THIS-BUFFER)
73 for all per-buffer variables of this buffer.
74 Specifically, this lists those variables that have
75 a buffer-local value in this buffer: i.e. those
76 whose value does not shadow the default value.
77 (Remember that for any particular variable created
78 with `make-local-variable' or `make-variable-buffer-local',
79 it will have a per-buffer value in some buffers and a
80 default value in others.)
82 Variables declared in C with DEFVAR_BUFFER_LOCAL() (i.e.
83 those stored in the struct buffer) are not listed here. */
84 MARKED_SLOT (local_var_alist);
86 /* Symbol naming major mode (eg, lisp-mode). */
87 MARKED_SLOT (major_mode);
89 /* Pretty name of major mode (eg, "Lisp"). */
90 MARKED_SLOT (mode_name);
92 /* Modeline element that controls format of modeline. */
93 MARKED_SLOT (modeline_format);
95 /* Keys that are bound local to this buffer. */
98 /* This buffer's local abbrev table. */
99 MARKED_SLOT (abbrev_table);
100 /* This buffer's syntax table. */
101 MARKED_SLOT (syntax_table);
103 /* Massaged values from the syntax table, for faster lookup. */
104 MARKED_SLOT (mirror_syntax_table);
108 /* This buffer's category table. */
109 MARKED_SLOT (category_table);
112 /* This buffer's coding system. */
113 MARKED_SLOT (buffer_file_coding_system);
115 /* Values of several buffer-local variables.
117 tab-width is buffer-local so that redisplay can find it
118 in buffers that are not current */
119 MARKED_SLOT (case_fold_search);
120 MARKED_SLOT (tab_width);
121 MARKED_SLOT (fill_column);
122 MARKED_SLOT (left_margin);
124 /* Function to call when insert space past fill column. */
125 MARKED_SLOT (auto_fill_function);
127 /* Case table for case-conversion in this buffer. */
128 MARKED_SLOT (case_table);
129 /* It contais following char-tables: */
130 /* Char-table maps each char into its lower-case version. */
131 /* Char-table mapping each char to its upper-case version. */
132 /* Char-table for conversion for case-folding search. */
133 /* Char-table of equivalences for case-folding search. */
135 /* #### This ought to be a specifier: */
136 /* Non-nil means do not display continuation lines. */
137 MARKED_SLOT (truncate_lines);
138 /* #### This ought to be a specifier: */
139 /* #### Better yet, it ought to be junked. It really sucks. */
140 /* Non-nil means display ctl chars with uparrow. */
141 MARKED_SLOT (ctl_arrow);
142 /* #### This ought to be a specifier: */
143 /* #### Better yet, it ought to be junked. It really sucks. */
144 /* Non-nil means do selective display;
145 see doc string in syms_of_buffer (buffer.c) for details. */
146 MARKED_SLOT (selective_display);
147 /* #### This ought to be a specifier: */
148 /* #### Better yet, it ought to be junked. It really sucks. */
149 /* Non-nil means show ... at end of line followed by invisible lines. */
150 MARKED_SLOT (selective_display_ellipses);
151 /* Alist of (FUNCTION . STRING) for each minor mode enabled in buffer. */
152 /* Unused: MARKED_SLOT (minor_modes); */
153 /* t if "self-insertion" should overwrite */
154 MARKED_SLOT (overwrite_mode);
155 /* non-nil means abbrev mode is on. Expand abbrevs automatically. */
156 MARKED_SLOT (abbrev_mode);
158 /* No display table here. It's a specifier. */
160 /* t means the mark and region are currently active. */
161 MARKED_SLOT (mark_active);
164 /* Changes in the buffer are recorded here for undo.
165 t means don't record anything.
166 This information belongs to the base buffer of an indirect buffer,
167 But we can't store it in the struct buffer_text
168 because local variables have to be right in the struct buffer.
169 So we copy it around in set_buffer_internal. */
170 MARKED_SLOT (undo_list);
172 /* FSFmacs has overlay stuff here. We have extent info elsewhere in the
175 /* dedicated_frame in lisp */
177 /* Lisp of symbols naming the file format used for visited file. */
178 MARKED_SLOT (file_format);
180 #ifdef REGION_CACHE_NEEDS_WORK
181 /* True if the newline position cache and width run cache are
182 enabled. See search.c and indent.c. */
183 MARKED_SLOT (cache_long_line_scans);
185 /* If the width run cache is enabled, this table contains the
186 character widths width_run_cache (see above) assumes. When we
187 do a thorough redisplay, we compare this against the buffer's
188 current display table to see whether the display table has
189 affected the widths of any characters. If it has, we
190 invalidate the width run cache, and re-initialize width_table. */
191 MARKED_SLOT (width_table);
192 #endif /* REGION_CACHE_NEEDS_WORK */
194 /* A redundant copy of text.pt, in the form of a marker. Every time one
195 is updated, so is the other.
197 MARKED_SLOT (point_marker);
199 /* FSFmacs has pt_marker, begv_marker, zv_marker here, used for
200 indirect buffers. We don't need them because we handle these
201 values directly instead of playing games with markers. */
203 /* This holds the point value before the last scroll operation.
204 Explicitly setting point sets this to nil. */
205 MARKED_SLOT (point_before_scroll);
207 /* Truename of the visited file (via the realpath() system call),
209 MARKED_SLOT (file_truename);
211 /* Invisibility spec of this buffer.
212 t => any non-nil `invisible' property means invisible.
213 A list => `invisible' property means invisible
214 if it is memq in that list. */
215 MARKED_SLOT (invisibility_spec);
217 /* The string generated by formatting the modeline in this buffer. */
218 MARKED_SLOT (generated_modeline_string);
220 /* A hash table that maps from a "generic extent" (an extent in
221 `modeline-format') into a buffer-specific extent. */
222 MARKED_SLOT (modeline_extent_table);
224 #ifndef BUFFER_SLOTS_LAST_NAME
225 #define BUFFER_SLOTS_LAST_NAME modeline_extent_table
229 /* This is silly and stupid */
230 /* These are so we don't have to recompile everything
231 the next few times we add a new slot. */
232 MARKED_SLOT (extra1, extra2, extra3);