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