1 /* Header file for the buffer manipulation primitives.
2 Copyright (C) 1985, 1986, 1993 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
21 #ifdef USE_TEXT_PROPERTIES
22 #define SET_PT(position) (set_point ((position), current_buffer))
23 #define TEMP_SET_PT(position) (temp_set_point ((position), current_buffer))
25 #define BUF_SET_PT(buffer, position) (set_point ((position), (buffer)))
26 #define BUF_TEMP_SET_PT(buffer, position) (temp_set_point ((position), (buffer)))
28 #else /* don't support text properties */
30 #define SET_PT(position) (current_buffer->text.pt = (position))
31 #define TEMP_SET_PT(position) (current_buffer->text.pt = (position))
33 #define BUF_SET_PT(buffer, position) (buffer->text.pt = (position))
34 #define BUF_TEMP_SET_PT(buffer, position) (buffer->text.pt = (position))
35 #endif /* don't support text properties */
37 /* Character position of beginning of buffer. */
40 /* Character position of beginning of accessible range of buffer. */
41 #define BEGV (current_buffer->text.begv)
43 /* Character position of point in buffer. The "+ 0" makes this
44 not an l-value, so you can't assign to it. Use SET_PT instead. */
45 #define PT (current_buffer->text.pt + 0)
47 /* Character position of gap in buffer. */
48 #define GPT (current_buffer->text.gpt)
50 /* Character position of end of accessible range of buffer. */
51 #define ZV (current_buffer->text.zv)
53 /* Character position of end of buffer. */
54 #define Z (current_buffer->text.z)
56 /* Is the current buffer narrowed? */
57 #define NARROWED ((BEGV != BEG) || (ZV != Z))
59 /* Modification count. */
60 #define MODIFF (current_buffer->text.modiff)
62 /* Address of beginning of buffer. */
63 #define BEG_ADDR (current_buffer->text.beg)
65 /* Address of beginning of accessible range of buffer. */
66 #define BEGV_ADDR (&FETCH_CHAR (current_buffer->text.begv))
68 /* Address of point in buffer. */
69 #define PT_ADDR (&FETCH_CHAR (current_buffer->text.pt))
71 /* Address of beginning of gap in buffer. */
72 #define GPT_ADDR (current_buffer->text.beg + current_buffer->text.gpt - 1)
74 /* Address of end of gap in buffer. */
75 #define GAP_END_ADDR (current_buffer->text.beg + current_buffer->text.gpt + current_buffer->text.gap_size - 1)
77 /* Address of end of accessible range of buffer. */
78 #define ZV_ADDR (&FETCH_CHAR (current_buffer->text.zv))
81 #define GAP_SIZE (current_buffer->text.gap_size)
83 /* Now similar macros for a specified buffer.
84 Note that many of these evaluate the buffer argument more than once. */
86 /* Character position of beginning of buffer. */
87 #define BUF_BEG(buf) (1)
89 /* Character position of beginning of accessible range of buffer. */
90 #define BUF_BEGV(buf) ((buf)->text.begv)
92 /* Character position of point in buffer. */
93 #define BUF_PT(buf) ((buf)->text.pt)
95 /* Character position of gap in buffer. */
96 #define BUF_GPT(buf) ((buf)->text.gpt)
98 /* Character position of end of accessible range of buffer. */
99 #define BUF_ZV(buf) ((buf)->text.zv)
101 /* Character position of end of buffer. */
102 #define BUF_Z(buf) ((buf)->text.z)
104 /* Is this buffer narrowed? */
105 #define BUF_NARROWED(buf) ((BUF_BEGV(buf) != BUF_BEG(buf)) \
106 || (BUF_ZV(buf) != BUF_Z(buf)))
108 /* Modification count. */
109 #define BUF_MODIFF(buf) ((buf)->text.modiff)
111 /* Address of beginning of buffer. */
112 #define BUF_BEG_ADDR(buf) ((buf)->text.beg)
114 /* Macro for setting the value of BUF_ZV (BUF) to VALUE,
115 by varying the end of the accessible region. */
116 #define SET_BUF_ZV(buf, value) ((buf)->text.zv = (value))
117 #define SET_BUF_PT(buf, value) ((buf)->text.pt = (value))
120 #define BUF_GAP_SIZE(buf) ((buf)->text.gap_size)
122 /* Return the address of character at position POS in buffer BUF.
123 Note that both arguments can be computed more than once. */
124 #define BUF_CHAR_ADDRESS(buf, pos) \
125 ((buf)->text.beg + (pos) - 1 \
126 + ((pos) >= (buf)->text.gpt ? (buf)->text.gap_size : 0))
128 /* Convert the address of a char in the buffer into a character position. */
129 #define PTR_CHAR_POS(ptr) \
130 ((ptr) - (current_buffer)->text.beg \
131 - (ptr - (current_buffer)->text.beg < (unsigned) GPT ? 0 : GAP_SIZE) \
136 unsigned char *beg
; /* Actual address of buffer contents. */
137 int begv
; /* Index of beginning of accessible range. */
138 int pt
; /* Position of point in buffer. */
139 int gpt
; /* Index of gap in buffer. */
140 int zv
; /* Index of end of accessible range. */
141 int z
; /* Index of end of buffer. */
142 int gap_size
; /* Size of buffer's gap */
143 int modiff
; /* This counts buffer-modification events
144 for this buffer. It is incremented for
145 each such event, and never otherwise
151 /* Everything before the `name' slot must be of a non-Lisp_Object type,
152 and every slot after `name' must be a Lisp_Object.
154 Check out mark_buffer (alloc.c) to see why.
157 /* This structure holds the coordinates of the buffer contents. */
158 struct buffer_text text
;
159 /* Next buffer, in chain of all buffers including killed buffers.
160 This chain is used only for garbage collection, in order to
161 collect killed buffers properly. */
163 /* Flags saying which DEFVAR_PER_BUFFER variables
164 are local to this buffer. */
166 /* Value of text.modiff as of when visited file was read or written. */
168 /* Set to the modtime of the visited file when read or written.
169 -1 means visited file was nonexistent.
170 0 means visited file modtime unknown; in no case complain
171 about any mismatch on next save attempt. */
173 /* the value of text.modiff at the last auto-save. */
174 int auto_save_modified
;
175 /* Position in buffer at which display started
176 the last time this buffer was displayed */
177 int last_window_start
;
179 /* Properties of this buffer's text -- conditionally compiled. */
182 /* This is a special exception -- as this slot should not be
183 marked by gc_sweep, and as it is not lisp-accessible as
184 a local variable -- so we regard it as not really being of type
186 /* the markers that refer to this buffer.
187 This is actually a single marker ---
188 successive elements in its marker `chain'
189 are the other markers referring to this
194 /* Everything from here down must be a Lisp_Object */
197 /* the name of this buffer */
199 /* Nuked: buffer number, assigned when buffer made Lisp_Object number;*/
200 /* the name of the file associated with this buffer */
201 Lisp_Object filename
;
202 /* Dir for expanding relative pathnames */
203 Lisp_Object directory
;
204 /* true iff this buffer has been been backed
205 up (if you write to its associated file
206 and it hasn't been backed up, then a
207 backup will be made) */
208 /* This isn't really used by the C code, so could be deleted. */
209 Lisp_Object backed_up
;
210 /* Length of file when last read or saved. */
211 Lisp_Object save_length
;
212 /* file name used for auto-saving this buffer */
213 Lisp_Object auto_save_file_name
;
214 /* Non-nil if buffer read-only */
215 Lisp_Object read_only
;
216 /* "The mark"; no longer allowed to be nil */
219 /* Alist of elements (SYMBOL . VALUE-IN-THIS-BUFFER)
220 for all per-buffer variables of this buffer. */
221 Lisp_Object local_var_alist
;
224 /* Symbol naming major mode (eg lisp-mode) */
225 Lisp_Object major_mode
;
226 /* Pretty name of major mode (eg "Lisp") */
227 Lisp_Object mode_name
;
228 /* Format string for mode line */
229 Lisp_Object mode_line_format
;
231 /* Keys that are bound local to this buffer */
233 /* This buffer's local abbrev table */
234 Lisp_Object abbrev_table
;
235 /* This buffer's syntax table. */
236 Lisp_Object syntax_table
;
238 /* Values of several buffer-local variables */
239 /* tab-width is buffer-local so that redisplay can find it
240 in buffers that are not current */
241 Lisp_Object case_fold_search
;
242 Lisp_Object tab_width
;
243 Lisp_Object fill_column
;
244 Lisp_Object left_margin
;
245 /* Function to call when insert space past fill column */
246 Lisp_Object auto_fill_function
;
248 /* nil: text, t: binary. */
249 Lisp_Object buffer_file_type
;
252 /* String of length 256 mapping each char to its lower-case version. */
253 Lisp_Object downcase_table
;
254 /* String of length 256 mapping each char to its upper-case version. */
255 Lisp_Object upcase_table
;
257 /* Non-nil means do not display continuation lines */
258 Lisp_Object truncate_lines
;
259 /* Non-nil means display ctl chars with uparrow */
260 Lisp_Object ctl_arrow
;
261 /* Non-nil means do selective display;
262 See doc string in syms_of_buffer (buffer.c) for details. */
263 Lisp_Object selective_display
;
265 /* Non-nil means show ... at end of line followed by invisible lines. */
266 Lisp_Object selective_display_ellipses
;
268 /* Alist of (FUNCTION . STRING) for each minor mode enabled in buffer. */
269 Lisp_Object minor_modes
;
270 /* t if "self-insertion" should overwrite; `binary' if it should also
271 overwrite newlines and tabs - for editing executables and the like. */
272 Lisp_Object overwrite_mode
;
273 /* non-nil means abbrev mode is on. Expand abbrevs automatically. */
274 Lisp_Object abbrev_mode
;
275 /* Display table to use for text in this buffer. */
276 Lisp_Object display_table
;
277 /* Translate table for case-folding search. */
278 Lisp_Object case_canon_table
;
279 /* Inverse translate (equivalence class) table for case-folding search. */
280 Lisp_Object case_eqv_table
;
281 /* Changes in the buffer are recorded here for undo.
282 t means don't record anything. */
283 Lisp_Object undo_list
;
284 /* t means the mark and region are currently active. */
285 Lisp_Object mark_active
;
287 /* List of overlays that end at or before the current center,
288 in order of end-position. */
289 Lisp_Object overlays_before
;
291 /* List of overlays that end after the current center,
292 in order of start-position. */
293 Lisp_Object overlays_after
;
295 /* Position where the overlay lists are centered. */
296 Lisp_Object overlay_center
;
299 /* This points to the current buffer. */
301 extern struct buffer
*current_buffer
;
303 /* This structure holds the default values of the buffer-local variables
304 that have special slots in each buffer.
305 The default value occupies the same slot in this structure
306 as an individual buffer's value occupies in that buffer.
307 Setting the default value also goes through the alist of buffers
308 and stores into each buffer that does not say it has a local value. */
310 extern struct buffer buffer_defaults
;
312 /* This structure marks which slots in a buffer have corresponding
313 default values in buffer_defaults.
314 Each such slot has a nonzero value in this structure.
315 The value has only one nonzero bit.
317 When a buffer has its own local value for a slot,
318 the bit for that slot (found in the same slot in this structure)
319 is turned on in the buffer's local_var_flags slot.
321 If a slot in this structure is zero, then even though there may
322 be a Lisp-level local variable for the slot, it has no default value,
323 and the corresponding slot in buffer_defaults is not used. */
325 extern struct buffer buffer_local_flags
;
327 /* For each buffer slot, this points to the Lisp symbol name
328 for that slot in the current buffer. It is 0 for slots
329 that don't have such names. */
331 extern struct buffer buffer_local_symbols
;
333 /* This structure holds the required types for the values in the
334 buffer-local slots. If a slot contains Qnil, then the
335 corresponding buffer slot may contain a value of any type. If a
336 slot contains an integer, then prospective values' tags must be
337 equal to that integer. When a tag does not match, the function
338 buffer_slot_type_mismatch will signal an error. The value Qnil may
339 always be safely stored in any slot. */
340 extern struct buffer buffer_local_types
;
342 /* Point in the current buffer. This is an obsolete alias
343 and should be eliminated. */
344 #define point (current_buffer->text.pt + 0)
346 /* Return character at position n. No range checking. */
347 #define FETCH_CHAR(n) *(((n)>= GPT ? GAP_SIZE : 0) + (n) + BEG_ADDR - 1)
349 /* BUFFER_CEILING_OF (resp. BUFFER_FLOOR_OF), when applied to n, return
350 the max (resp. min) p such that
352 &FETCH_CHAR (p) - &FETCH_CHAR (n) == p - n */
354 #define BUFFER_CEILING_OF(n) (((n) < GPT && GPT < ZV ? GPT : ZV) - 1)
355 #define BUFFER_FLOOR_OF(n) (BEGV <= GPT && GPT <= (n) ? GPT : BEGV)
357 extern void reset_buffer ();
359 extern Lisp_Object
Fbuffer_name ();
360 extern Lisp_Object
Fget_file_buffer ();
362 /* Functions to call before and after each text change. */
363 extern Lisp_Object Vbefore_change_function
;
364 extern Lisp_Object Vafter_change_function
;
365 extern Lisp_Object Vfirst_change_hook
;
366 extern Lisp_Object Qfirst_change_hook
;
368 extern Lisp_Object Vdeactivate_mark
;
369 extern Lisp_Object Vtransient_mark_mode
;
373 /* Overlays are ordinary Lisp objects, and users can alter their contents.
374 Therefore, we cannot assume that they remain valid--we must check. */
376 /* 1 if the OV is a cons cell whose car is a cons cell. */
377 #define OVERLAY_VALID(OV) (OVERLAYP (OV))
379 /* Return the marker that stands for where OV starts in the buffer. */
380 #define OVERLAY_START(OV) (XCONS (XCONS ((OV))->car)->car)
382 /* Return the marker that stands for where OV ends in the buffer. */
383 #define OVERLAY_END(OV) (XCONS (XCONS ((OV))->car)->cdr)
385 /* Return the actual buffer position for the marker P,
386 if it is a marker and points into the current buffer.
389 #define OVERLAY_POSITION(P) \
390 ((MARKERP ((P)) && XMARKER ((P))->buffer == current_buffer) \
391 ? marker_position ((P)) : 0)
393 /* Allocation of buffer text. */
396 #define BUFFER_ALLOC(data,size) ((unsigned char *) r_alloc (&data, (size)))
397 #define BUFFER_REALLOC(data,size) ((unsigned char *) r_re_alloc (&data, (size)))
398 #define BUFFER_FREE(data) (r_alloc_free (&data))
399 #define R_ALLOC_DECLARE(var,data) (r_alloc_declare (&var, (data)))
401 #define BUFFER_ALLOC(data,size) (data = (unsigned char *) malloc ((size)))
402 #define BUFFER_REALLOC(data,size) ((unsigned char *) realloc ((data), (size)))
403 #define BUFFER_FREE(data) (free ((data)))
404 #define R_ALLOC_DECLARE(var,data)