1 /* Header file for the buffer manipulation primitives.
2 Copyright (C) 1985, 1986, 1993, 1994 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) \
134 /* Convert the address of a char in the buffer into a character position. */
135 #define BUF_PTR_CHAR_POS(buf, ptr) \
136 ((ptr) - (buf)->text.beg \
137 - (ptr - (buf)->text.beg < (unsigned) BUF_GPT ((buf)) \
138 ? 0 : BUF_GAP_SIZE ((buf))) \
143 unsigned char *beg
; /* Actual address of buffer contents. */
144 int begv
; /* Index of beginning of accessible range. */
145 int pt
; /* Position of point in buffer. */
146 int gpt
; /* Index of gap in buffer. */
147 int zv
; /* Index of end of accessible range. */
148 int z
; /* Index of end of buffer. */
149 int gap_size
; /* Size of buffer's gap */
150 int modiff
; /* This counts buffer-modification events
151 for this buffer. It is incremented for
152 each such event, and never otherwise
158 /* Everything before the `name' slot must be of a non-Lisp_Object type,
159 and every slot after `name' must be a Lisp_Object.
161 Check out mark_buffer (alloc.c) to see why.
164 /* This structure holds the coordinates of the buffer contents. */
165 struct buffer_text text
;
166 /* Next buffer, in chain of all buffers including killed buffers.
167 This chain is used only for garbage collection, in order to
168 collect killed buffers properly. */
170 /* Flags saying which DEFVAR_PER_BUFFER variables
171 are local to this buffer. */
173 /* Value of text.modiff as of when visited file was read or written. */
175 /* Set to the modtime of the visited file when read or written.
176 -1 means visited file was nonexistent.
177 0 means visited file modtime unknown; in no case complain
178 about any mismatch on next save attempt. */
180 /* the value of text.modiff at the last auto-save. */
181 int auto_save_modified
;
182 /* The time at which we detected a failure to auto-save,
183 Or -1 if we didn't have a failure. */
184 int auto_save_failure_time
;
185 /* Position in buffer at which display started
186 the last time this buffer was displayed */
187 int last_window_start
;
189 /* Properties of this buffer's text -- conditionally compiled. */
192 /* This is a special exception -- as this slot should not be
193 marked by gc_sweep, and as it is not lisp-accessible as
194 a local variable -- so we regard it as not really being of type
196 /* the markers that refer to this buffer.
197 This is actually a single marker ---
198 successive elements in its marker `chain'
199 are the other markers referring to this
204 /* Everything from here down must be a Lisp_Object */
207 /* the name of this buffer */
209 /* Nuked: buffer number, assigned when buffer made Lisp_Object number;*/
210 /* the name of the file associated with this buffer */
211 Lisp_Object filename
;
212 /* Dir for expanding relative pathnames */
213 Lisp_Object directory
;
214 /* true iff this buffer has been backed
215 up (if you write to its associated file
216 and it hasn't been backed up, then a
217 backup will be made) */
218 /* This isn't really used by the C code, so could be deleted. */
219 Lisp_Object backed_up
;
220 /* Length of file when last read or saved. */
221 Lisp_Object save_length
;
222 /* file name used for auto-saving this buffer */
223 Lisp_Object auto_save_file_name
;
224 /* Non-nil if buffer read-only */
225 Lisp_Object read_only
;
226 /* "The mark"; no longer allowed to be nil */
229 /* Alist of elements (SYMBOL . VALUE-IN-THIS-BUFFER)
230 for all per-buffer variables of this buffer. */
231 Lisp_Object local_var_alist
;
234 /* Symbol naming major mode (eg lisp-mode) */
235 Lisp_Object major_mode
;
236 /* Pretty name of major mode (eg "Lisp") */
237 Lisp_Object mode_name
;
238 /* Format string for mode line */
239 Lisp_Object mode_line_format
;
241 /* Keys that are bound local to this buffer */
243 /* This buffer's local abbrev table */
244 Lisp_Object abbrev_table
;
245 /* This buffer's syntax table. */
246 Lisp_Object syntax_table
;
248 /* Values of several buffer-local variables */
249 /* tab-width is buffer-local so that redisplay can find it
250 in buffers that are not current */
251 Lisp_Object case_fold_search
;
252 Lisp_Object tab_width
;
253 Lisp_Object fill_column
;
254 Lisp_Object left_margin
;
255 /* Function to call when insert space past fill column */
256 Lisp_Object auto_fill_function
;
258 /* nil: text, t: binary. */
259 Lisp_Object buffer_file_type
;
262 /* String of length 256 mapping each char to its lower-case version. */
263 Lisp_Object downcase_table
;
264 /* String of length 256 mapping each char to its upper-case version. */
265 Lisp_Object upcase_table
;
267 /* Non-nil means do not display continuation lines */
268 Lisp_Object truncate_lines
;
269 /* Non-nil means display ctl chars with uparrow */
270 Lisp_Object ctl_arrow
;
271 /* Non-nil means do selective display;
272 See doc string in syms_of_buffer (buffer.c) for details. */
273 Lisp_Object selective_display
;
275 /* Non-nil means show ... at end of line followed by invisible lines. */
276 Lisp_Object selective_display_ellipses
;
278 /* Alist of (FUNCTION . STRING) for each minor mode enabled in buffer. */
279 Lisp_Object minor_modes
;
280 /* t if "self-insertion" should overwrite; `binary' if it should also
281 overwrite newlines and tabs - for editing executables and the like. */
282 Lisp_Object overwrite_mode
;
283 /* non-nil means abbrev mode is on. Expand abbrevs automatically. */
284 Lisp_Object abbrev_mode
;
285 /* Display table to use for text in this buffer. */
286 Lisp_Object display_table
;
287 /* Translate table for case-folding search. */
288 Lisp_Object case_canon_table
;
289 /* Inverse translate (equivalence class) table for case-folding search. */
290 Lisp_Object case_eqv_table
;
291 /* Changes in the buffer are recorded here for undo.
292 t means don't record anything. */
293 Lisp_Object undo_list
;
294 /* t means the mark and region are currently active. */
295 Lisp_Object mark_active
;
297 /* List of overlays that end at or before the current center,
298 in order of end-position. */
299 Lisp_Object overlays_before
;
301 /* List of overlays that end after the current center,
302 in order of start-position. */
303 Lisp_Object overlays_after
;
305 /* Position where the overlay lists are centered. */
306 Lisp_Object overlay_center
;
309 /* This points to the current buffer. */
311 extern struct buffer
*current_buffer
;
313 /* This structure holds the default values of the buffer-local variables
314 that have special slots in each buffer.
315 The default value occupies the same slot in this structure
316 as an individual buffer's value occupies in that buffer.
317 Setting the default value also goes through the alist of buffers
318 and stores into each buffer that does not say it has a local value. */
320 extern struct buffer buffer_defaults
;
322 /* This structure marks which slots in a buffer have corresponding
323 default values in buffer_defaults.
324 Each such slot has a nonzero value in this structure.
325 The value has only one nonzero bit.
327 When a buffer has its own local value for a slot,
328 the bit for that slot (found in the same slot in this structure)
329 is turned on in the buffer's local_var_flags slot.
331 If a slot in this structure is zero, then even though there may
332 be a Lisp-level local variable for the slot, it has no default value,
333 and the corresponding slot in buffer_defaults is not used. */
335 extern struct buffer buffer_local_flags
;
337 /* For each buffer slot, this points to the Lisp symbol name
338 for that slot in the current buffer. It is 0 for slots
339 that don't have such names. */
341 extern struct buffer buffer_local_symbols
;
343 /* This structure holds the required types for the values in the
344 buffer-local slots. If a slot contains Qnil, then the
345 corresponding buffer slot may contain a value of any type. If a
346 slot contains an integer, then prospective values' tags must be
347 equal to that integer. When a tag does not match, the function
348 buffer_slot_type_mismatch will signal an error. The value Qnil may
349 always be safely stored in any slot. */
350 extern struct buffer buffer_local_types
;
352 /* Point in the current buffer. This is an obsolete alias
353 and should be eliminated. */
354 #define point (current_buffer->text.pt + 0)
356 /* Return character at position n. No range checking. */
357 #define FETCH_CHAR(n) *(((n)>= GPT ? GAP_SIZE : 0) + (n) + BEG_ADDR - 1)
359 /* BUFFER_CEILING_OF (resp. BUFFER_FLOOR_OF), when applied to n, return
360 the max (resp. min) p such that
362 &FETCH_CHAR (p) - &FETCH_CHAR (n) == p - n */
364 #define BUFFER_CEILING_OF(n) (((n) < GPT && GPT < ZV ? GPT : ZV) - 1)
365 #define BUFFER_FLOOR_OF(n) (BEGV <= GPT && GPT <= (n) ? GPT : BEGV)
367 extern void reset_buffer ();
369 extern Lisp_Object
Fbuffer_name ();
370 extern Lisp_Object
Fget_file_buffer ();
372 /* Functions to call before and after each text change. */
373 extern Lisp_Object Vbefore_change_function
;
374 extern Lisp_Object Vafter_change_function
;
375 extern Lisp_Object Vbefore_change_functions
;
376 extern Lisp_Object Vafter_change_functions
;
377 extern Lisp_Object Vfirst_change_hook
;
378 extern Lisp_Object Qfirst_change_hook
;
380 extern Lisp_Object Vdeactivate_mark
;
381 extern Lisp_Object Vtransient_mark_mode
;
385 /* 1 if the OV is an overlay object. */
386 #define OVERLAY_VALID(OV) (OVERLAYP (OV))
388 /* Return the marker that stands for where OV starts in the buffer. */
389 #define OVERLAY_START(OV) (XCONS (XCONS ((OV))->car)->car)
391 /* Return the marker that stands for where OV ends in the buffer. */
392 #define OVERLAY_END(OV) (XCONS (XCONS ((OV))->car)->cdr)
394 /* Return the actual buffer position for the marker P.
395 We assume you know which buffer it's pointing into. */
397 #define OVERLAY_POSITION(P) \
398 (XGCTYPE ((P)) == Lisp_Marker ? marker_position ((P)) : (abort (), 0))
400 /* Allocation of buffer text. */
403 #define BUFFER_ALLOC(data,size) ((unsigned char *) r_alloc (&data, (size)))
404 #define BUFFER_REALLOC(data,size) ((unsigned char *) r_re_alloc (&data, (size)))
405 #define BUFFER_FREE(data) (r_alloc_free (&data))
406 #define R_ALLOC_DECLARE(var,data) (r_alloc_declare (&var, (data)))
408 #define BUFFER_ALLOC(data,size) (data = (unsigned char *) malloc ((size)))
409 #define BUFFER_REALLOC(data,size) ((unsigned char *) realloc ((data), (size)))
410 #define BUFFER_FREE(data) (free ((data)))
411 #define R_ALLOC_DECLARE(var,data)