Commit | Line | Data |
---|---|---|
b3ec245a | 1 | /* Header file for the buffer manipulation primitives. |
bcd98331 | 2 | Copyright (C) 1985, 1986, 1993, 1994, 1995, 1997, 1998, 1999, 2000, 2001, |
8cabe764 GM |
3 | 2002, 2003, 2004, 2005, 2006, 2007, 2008 |
4 | Free Software Foundation, Inc. | |
b3ec245a JB |
5 | |
6 | This file is part of GNU Emacs. | |
7 | ||
8 | GNU Emacs is free software; you can redistribute it and/or modify | |
9 | it under the terms of the GNU General Public License as published by | |
684d6f5b | 10 | the Free Software Foundation; either version 3, or (at your option) |
b3ec245a JB |
11 | any later version. |
12 | ||
13 | GNU Emacs is distributed in the hope that it will be useful, | |
14 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 | GNU General Public License for more details. | |
17 | ||
18 | You should have received a copy of the GNU General Public License | |
19 | along with GNU Emacs; see the file COPYING. If not, write to | |
4fc5845f LK |
20 | the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
21 | Boston, MA 02110-1301, USA. */ | |
b3ec245a JB |
22 | |
23 | ||
69f9064e | 24 | /* Accessing the parameters of the current buffer. */ |
1b92beaf | 25 | |
69f9064e RS |
26 | /* These macros come in pairs, one for the char position |
27 | and one for the byte position. */ | |
b3ec245a | 28 | |
177c0ea7 | 29 | /* Position of beginning of buffer. */ |
b3ec245a | 30 | #define BEG (1) |
8aa91000 | 31 | #define BEG_BYTE (BEG) |
b3ec245a | 32 | |
177c0ea7 | 33 | /* Position of beginning of accessible range of buffer. */ |
c1ea566e | 34 | #define BEGV (current_buffer->begv) |
69f9064e | 35 | #define BEGV_BYTE (current_buffer->begv_byte) |
b3ec245a | 36 | |
69f9064e | 37 | /* Position of point in buffer. The "+ 0" makes this |
177c0ea7 | 38 | not an l-value, so you can't assign to it. Use SET_PT instead. */ |
c1ea566e | 39 | #define PT (current_buffer->pt + 0) |
69f9064e | 40 | #define PT_BYTE (current_buffer->pt_byte + 0) |
b3ec245a | 41 | |
177c0ea7 | 42 | /* Position of gap in buffer. */ |
c1ea566e | 43 | #define GPT (current_buffer->text->gpt) |
69f9064e | 44 | #define GPT_BYTE (current_buffer->text->gpt_byte) |
b3ec245a | 45 | |
177c0ea7 | 46 | /* Position of end of accessible range of buffer. */ |
c1ea566e | 47 | #define ZV (current_buffer->zv) |
69f9064e | 48 | #define ZV_BYTE (current_buffer->zv_byte) |
b3ec245a | 49 | |
177c0ea7 | 50 | /* Position of end of buffer. */ |
c1ea566e | 51 | #define Z (current_buffer->text->z) |
69f9064e | 52 | #define Z_BYTE (current_buffer->text->z_byte) |
b3ec245a | 53 | |
69f9064e | 54 | /* Macros for the addresses of places in the buffer. */ |
b3ec245a | 55 | |
177c0ea7 | 56 | /* Address of beginning of buffer. */ |
c1ea566e | 57 | #define BEG_ADDR (current_buffer->text->beg) |
b3ec245a | 58 | |
177c0ea7 | 59 | /* Address of beginning of accessible range of buffer. */ |
69f9064e | 60 | #define BEGV_ADDR (BYTE_POS_ADDR (current_buffer->begv_byte)) |
b3ec245a | 61 | |
177c0ea7 | 62 | /* Address of point in buffer. */ |
69f9064e | 63 | #define PT_ADDR (BYTE_POS_ADDR (current_buffer->pt_byte)) |
b3ec245a | 64 | |
177c0ea7 | 65 | /* Address of beginning of gap in buffer. */ |
d895183d | 66 | #define GPT_ADDR (current_buffer->text->beg + current_buffer->text->gpt_byte - BEG_BYTE) |
b3ec245a JB |
67 | |
68 | /* Address of end of gap in buffer. */ | |
d895183d | 69 | #define GAP_END_ADDR (current_buffer->text->beg + current_buffer->text->gpt_byte + current_buffer->text->gap_size - BEG_BYTE) |
b3ec245a | 70 | |
177c0ea7 | 71 | /* Address of end of accessible range of buffer. */ |
69f9064e | 72 | #define ZV_ADDR (BYTE_POS_ADDR (current_buffer->zv_byte)) |
96b65d4e | 73 | |
177c0ea7 | 74 | /* Address of end of buffer. */ |
d895183d | 75 | #define Z_ADDR (current_buffer->text->beg + current_buffer->text->gap_size + current_buffer->text->z_byte - BEG_BYTE) |
b3ec245a JB |
76 | |
77 | /* Size of gap. */ | |
c1ea566e | 78 | #define GAP_SIZE (current_buffer->text->gap_size) |
b3ec245a | 79 | |
69f9064e RS |
80 | /* Is the current buffer narrowed? */ |
81 | #define NARROWED ((BEGV != BEG) || (ZV != Z)) | |
82 | ||
83 | /* Modification count. */ | |
84 | #define MODIFF (current_buffer->text->modiff) | |
85 | ||
3e145152 CY |
86 | /* Character modification count. */ |
87 | #define CHARS_MODIFF (current_buffer->text->chars_modiff) | |
88 | ||
69f9064e RS |
89 | /* Overlay modification count. */ |
90 | #define OVERLAY_MODIFF (current_buffer->text->overlay_modiff) | |
91 | ||
92 | /* Modification count as of last visit or save. */ | |
93 | #define SAVE_MODIFF (current_buffer->text->save_modiff) | |
94 | ||
95 | /* BUFFER_CEILING_OF (resp. BUFFER_FLOOR_OF), when applied to n, return | |
96 | the max (resp. min) p such that | |
97 | ||
98 | BYTE_POS_ADDR (p) - BYTE_POS_ADDR (n) == p - n */ | |
99 | ||
100 | #define BUFFER_CEILING_OF(BYTEPOS) \ | |
101 | (((BYTEPOS) < GPT_BYTE && GPT < ZV ? GPT_BYTE : ZV_BYTE) - 1) | |
102 | #define BUFFER_FLOOR_OF(BYTEPOS) \ | |
103 | (BEGV <= GPT && GPT_BYTE <= (BYTEPOS) ? GPT_BYTE : BEGV_BYTE) | |
104 | \f | |
105 | /* Similar macros to operate on a specified buffer. | |
b3ec245a JB |
106 | Note that many of these evaluate the buffer argument more than once. */ |
107 | ||
177c0ea7 | 108 | /* Position of beginning of buffer. */ |
d895183d SM |
109 | #define BUF_BEG(buf) (BEG) |
110 | #define BUF_BEG_BYTE(buf) (BEG_BYTE) | |
b3ec245a | 111 | |
177c0ea7 | 112 | /* Position of beginning of accessible range of buffer. */ |
c1ea566e | 113 | #define BUF_BEGV(buf) ((buf)->begv) |
69f9064e | 114 | #define BUF_BEGV_BYTE(buf) ((buf)->begv_byte) |
b3ec245a | 115 | |
177c0ea7 | 116 | /* Position of point in buffer. */ |
c1ea566e | 117 | #define BUF_PT(buf) ((buf)->pt) |
69f9064e | 118 | #define BUF_PT_BYTE(buf) ((buf)->pt_byte) |
b3ec245a | 119 | |
177c0ea7 | 120 | /* Position of gap in buffer. */ |
c1ea566e | 121 | #define BUF_GPT(buf) ((buf)->text->gpt) |
69f9064e | 122 | #define BUF_GPT_BYTE(buf) ((buf)->text->gpt_byte) |
b3ec245a | 123 | |
177c0ea7 | 124 | /* Position of end of accessible range of buffer. */ |
c1ea566e | 125 | #define BUF_ZV(buf) ((buf)->zv) |
69f9064e | 126 | #define BUF_ZV_BYTE(buf) ((buf)->zv_byte) |
b3ec245a | 127 | |
177c0ea7 | 128 | /* Position of end of buffer. */ |
c1ea566e | 129 | #define BUF_Z(buf) ((buf)->text->z) |
69f9064e RS |
130 | #define BUF_Z_BYTE(buf) ((buf)->text->z_byte) |
131 | ||
132 | /* Address of beginning of buffer. */ | |
133 | #define BUF_BEG_ADDR(buf) ((buf)->text->beg) | |
134 | ||
135 | /* Address of beginning of gap of buffer. */ | |
d895183d | 136 | #define BUF_GPT_ADDR(buf) ((buf)->text->beg + (buf)->text->gpt_byte - BEG_BYTE) |
69f9064e RS |
137 | |
138 | /* Address of end of buffer. */ | |
d895183d | 139 | #define BUF_Z_ADDR(buf) ((buf)->text->beg + (buf)->text->gap_size + (buf)->text->z_byte - BEG_BYTE) |
69f9064e RS |
140 | |
141 | /* Address of end of gap in buffer. */ | |
d895183d | 142 | #define BUF_GAP_END_ADDR(buf) ((buf)->text->beg + (buf)->text->gpt_byte + (buf)->text->gap_size - BEG_BYTE) |
b3ec245a | 143 | |
69f9064e RS |
144 | /* Size of gap. */ |
145 | #define BUF_GAP_SIZE(buf) ((buf)->text->gap_size) | |
146 | ||
147 | /* Is this buffer narrowed? */ | |
c1ea566e RS |
148 | #define BUF_NARROWED(buf) ((BUF_BEGV (buf) != BUF_BEG (buf)) \ |
149 | || (BUF_ZV (buf) != BUF_Z (buf))) | |
e12f3519 | 150 | |
b3ec245a | 151 | /* Modification count. */ |
c1ea566e RS |
152 | #define BUF_MODIFF(buf) ((buf)->text->modiff) |
153 | ||
3e145152 CY |
154 | /* Character modification count. */ |
155 | #define BUF_CHARS_MODIFF(buf) ((buf)->text->chars_modiff) | |
156 | ||
c1ea566e RS |
157 | /* Modification count as of last visit or save. */ |
158 | #define BUF_SAVE_MODIFF(buf) ((buf)->text->save_modiff) | |
159 | ||
2e50b9cc RS |
160 | /* Overlay modification count. */ |
161 | #define BUF_OVERLAY_MODIFF(buf) ((buf)->text->overlay_modiff) | |
162 | ||
c1ea566e RS |
163 | /* Interval tree of buffer. */ |
164 | #define BUF_INTERVALS(buf) ((buf)->text->intervals) | |
165 | ||
166 | /* Marker chain of buffer. */ | |
167 | #define BUF_MARKERS(buf) ((buf)->text->markers) | |
133a3962 GM |
168 | |
169 | #define BUF_UNCHANGED_MODIFIED(buf) \ | |
170 | ((buf)->text->unchanged_modified) | |
171 | ||
172 | #define BUF_OVERLAY_UNCHANGED_MODIFIED(buf) \ | |
173 | ((buf)->text->overlay_unchanged_modified) | |
174 | #define BUF_BEG_UNCHANGED(buf) ((buf)->text->beg_unchanged) | |
175 | #define BUF_END_UNCHANGED(buf) ((buf)->text->end_unchanged) | |
176 | ||
177 | #define UNCHANGED_MODIFIED \ | |
178 | BUF_UNCHANGED_MODIFIED (current_buffer) | |
179 | #define OVERLAY_UNCHANGED_MODIFIED \ | |
180 | BUF_OVERLAY_UNCHANGED_MODIFIED (current_buffer) | |
181 | #define BEG_UNCHANGED BUF_BEG_UNCHANGED (current_buffer) | |
182 | #define END_UNCHANGED BUF_END_UNCHANGED (current_buffer) | |
183 | ||
184 | /* Compute how many characters at the top and bottom of BUF are | |
185 | unchanged when the range START..END is modified. This computation | |
186 | must be done each time BUF is modified. */ | |
187 | ||
188 | #define BUF_COMPUTE_UNCHANGED(buf, start, end) \ | |
189 | do \ | |
190 | { \ | |
9a6bd51a GM |
191 | if (BUF_UNCHANGED_MODIFIED (buf) == BUF_MODIFF (buf) \ |
192 | && (BUF_OVERLAY_UNCHANGED_MODIFIED (buf) \ | |
193 | == BUF_OVERLAY_MODIFF (buf))) \ | |
133a3962 GM |
194 | { \ |
195 | BUF_BEG_UNCHANGED (buf) = (start) - BUF_BEG (buf); \ | |
196 | BUF_END_UNCHANGED (buf) = BUF_Z (buf) - (end); \ | |
197 | } \ | |
198 | else \ | |
199 | { \ | |
200 | if (BUF_Z (buf) - (end) < BUF_END_UNCHANGED (buf)) \ | |
201 | BUF_END_UNCHANGED (buf) = BUF_Z (buf) - (end); \ | |
202 | if ((start) - BUF_BEG (buf) < BUF_BEG_UNCHANGED (buf)) \ | |
203 | BUF_BEG_UNCHANGED (buf) = (start) - BUF_BEG (buf); \ | |
204 | } \ | |
205 | } \ | |
206 | while (0) | |
177c0ea7 | 207 | |
69f9064e | 208 | \f |
33f1148d | 209 | /* Macros to set PT in the current buffer, or another buffer. */ |
b3ec245a | 210 | |
69f9064e RS |
211 | #define SET_PT(position) (set_point (current_buffer, (position))) |
212 | #define TEMP_SET_PT(position) (temp_set_point (current_buffer, (position))) | |
b3ec245a | 213 | |
69f9064e RS |
214 | #define SET_PT_BOTH(position, byte) \ |
215 | (set_point_both (current_buffer, (position), (byte))) | |
216 | #define TEMP_SET_PT_BOTH(position, byte) \ | |
217 | (temp_set_point_both (current_buffer, (position), (byte))) | |
96b65d4e | 218 | |
69f9064e RS |
219 | #define BUF_TEMP_SET_PT(buffer, position) \ |
220 | (temp_set_point ((buffer), (position))) | |
96b65d4e | 221 | |
69f9064e RS |
222 | extern void set_point P_ ((struct buffer *, int)); |
223 | extern INLINE void temp_set_point P_ ((struct buffer *, int)); | |
224 | extern void set_point_both P_ ((struct buffer *, int, int)); | |
225 | extern INLINE void temp_set_point_both P_ ((struct buffer *, int, int)); | |
39c75ccb | 226 | extern void enlarge_buffer_text P_ ((struct buffer *, int)); |
b3ec245a | 227 | |
69f9064e RS |
228 | \f |
229 | /* Macros for setting the BEGV, ZV or PT of a given buffer. | |
230 | ||
231 | SET_BUF_PT* seet to be redundant. Get rid of them? | |
232 | ||
233 | The ..._BOTH macros take both a charpos and a bytepos, | |
234 | which must correspond to each other. | |
235 | ||
236 | The macros without ..._BOTH take just a charpos, | |
237 | and compute the bytepos from it. */ | |
b3ec245a | 238 | |
69f9064e RS |
239 | #define SET_BUF_BEGV(buf, charpos) \ |
240 | ((buf)->begv_byte = buf_charpos_to_bytepos ((buf), (charpos)), \ | |
241 | (buf)->begv = (charpos)) | |
242 | ||
243 | #define SET_BUF_ZV(buf, charpos) \ | |
244 | ((buf)->zv_byte = buf_charpos_to_bytepos ((buf), (charpos)), \ | |
245 | (buf)->zv = (charpos)) | |
246 | ||
247 | #define SET_BUF_BEGV_BOTH(buf, charpos, byte) \ | |
248 | ((buf)->begv = (charpos), \ | |
249 | (buf)->begv_byte = (byte)) | |
250 | ||
251 | #define SET_BUF_ZV_BOTH(buf, charpos, byte) \ | |
252 | ((buf)->zv = (charpos), \ | |
253 | (buf)->zv_byte = (byte)) | |
254 | ||
255 | #define SET_BUF_PT_BOTH(buf, charpos, byte) \ | |
256 | ((buf)->pt = (charpos), \ | |
257 | (buf)->pt_byte = (byte)) | |
258 | \f | |
259 | /* Macros to access a character or byte in the current buffer, | |
260 | or convert between a byte position and an address. | |
261 | These macros do not check that the position is in range. */ | |
262 | ||
263 | /* Access a Lisp position value in POS, | |
8b4baa7b | 264 | and store the charpos in CHARPOS and the bytepos in BYTEPOS. */ |
69f9064e RS |
265 | |
266 | #define DECODE_POSITION(charpos, bytepos, pos) \ | |
92413ef3 | 267 | do \ |
69f9064e RS |
268 | { \ |
269 | Lisp_Object __pos = (pos); \ | |
270 | if (NUMBERP (__pos)) \ | |
271 | { \ | |
272 | charpos = __pos; \ | |
273 | bytepos = buf_charpos_to_bytepos (current_buffer, __pos); \ | |
274 | } \ | |
275 | else if (MARKERP (__pos)) \ | |
276 | { \ | |
277 | charpos = marker_position (__pos); \ | |
278 | bytepos = marker_byte_position (__pos); \ | |
279 | } \ | |
280 | else \ | |
281 | wrong_type_argument (Qinteger_or_marker_p, __pos); \ | |
282 | } \ | |
92413ef3 | 283 | while (0) |
69f9064e RS |
284 | |
285 | /* Return the address of byte position N in current buffer. */ | |
286 | ||
287 | #define BYTE_POS_ADDR(n) \ | |
d895183d | 288 | (((n) >= GPT_BYTE ? GAP_SIZE : 0) + (n) + BEG_ADDR - BEG_BYTE) |
69f9064e RS |
289 | |
290 | /* Return the address of char position N. */ | |
291 | ||
292 | #define CHAR_POS_ADDR(n) \ | |
293 | (((n) >= GPT ? GAP_SIZE : 0) \ | |
294 | + buf_charpos_to_bytepos (current_buffer, n) \ | |
d895183d | 295 | + BEG_ADDR - BEG_BYTE) |
69f9064e RS |
296 | |
297 | /* Convert a character position to a byte position. */ | |
298 | ||
299 | #define CHAR_TO_BYTE(charpos) \ | |
300 | (buf_charpos_to_bytepos (current_buffer, charpos)) | |
301 | ||
302 | /* Convert a byte position to a character position. */ | |
303 | ||
304 | #define BYTE_TO_CHAR(bytepos) \ | |
305 | (buf_bytepos_to_charpos (current_buffer, bytepos)) | |
306 | ||
307 | /* Convert PTR, the address of a byte in the buffer, into a byte position. */ | |
308 | ||
309 | #define PTR_BYTE_POS(ptr) \ | |
310 | ((ptr) - (current_buffer)->text->beg \ | |
d895183d SM |
311 | - (ptr - (current_buffer)->text->beg <= (unsigned) (GPT_BYTE - BEG_BYTE) ? 0 : GAP_SIZE) \ |
312 | + BEG_BYTE) | |
69f9064e RS |
313 | |
314 | /* Return character at position POS. */ | |
315 | ||
316 | #define FETCH_CHAR(pos) \ | |
317 | (!NILP (current_buffer->enable_multibyte_characters) \ | |
318 | ? FETCH_MULTIBYTE_CHAR ((pos)) \ | |
319 | : FETCH_BYTE ((pos))) | |
320 | ||
321 | /* Return the byte at byte position N. */ | |
322 | ||
323 | #define FETCH_BYTE(n) *(BYTE_POS_ADDR ((n))) | |
324 | ||
325 | /* Variables used locally in FETCH_MULTIBYTE_CHAR. */ | |
326 | extern unsigned char *_fetch_multibyte_char_p; | |
69f9064e RS |
327 | |
328 | /* Return character code of multi-byte form at position POS. If POS | |
329 | doesn't point the head of valid multi-byte form, only the byte at | |
330 | POS is returned. No range checking. */ | |
331 | ||
332 | #define FETCH_MULTIBYTE_CHAR(pos) \ | |
333 | (_fetch_multibyte_char_p = (((pos) >= GPT_BYTE ? GAP_SIZE : 0) \ | |
8f924df7 | 334 | + (pos) + BEG_ADDR - BEG_BYTE), \ |
feb3066c KH |
335 | STRING_CHAR (_fetch_multibyte_char_p, 0)) |
336 | ||
337 | /* Return character at position POS. If the current buffer is unibyte | |
338 | and the character is not ASCII, make the returning character | |
339 | multibyte. */ | |
340 | ||
341 | #define FETCH_CHAR_AS_MULTIBYTE(pos) \ | |
342 | (!NILP (current_buffer->enable_multibyte_characters) \ | |
343 | ? FETCH_MULTIBYTE_CHAR ((pos)) \ | |
274ec34b | 344 | : unibyte_to_multibyte_table[(FETCH_BYTE ((pos)))]) |
feb3066c | 345 | |
69f9064e RS |
346 | \f |
347 | /* Macros for accessing a character or byte, | |
348 | or converting between byte positions and addresses, | |
349 | in a specified buffer. */ | |
350 | ||
177c0ea7 | 351 | /* Return the address of character at byte position POS in buffer BUF. |
b3ec245a | 352 | Note that both arguments can be computed more than once. */ |
69f9064e RS |
353 | |
354 | #define BUF_BYTE_ADDRESS(buf, pos) \ | |
d895183d | 355 | ((buf)->text->beg + (pos) - BEG_BYTE \ |
69f9064e RS |
356 | + ((pos) >= (buf)->text->gpt_byte ? (buf)->text->gap_size : 0)) |
357 | ||
177c0ea7 | 358 | /* Return the address of character at char position POS in buffer BUF. |
69f9064e RS |
359 | Note that both arguments can be computed more than once. */ |
360 | ||
361 | #define BUF_CHAR_ADDRESS(buf, pos) \ | |
d895183d | 362 | ((buf)->text->beg + buf_charpos_to_bytepos ((buf), (pos)) - BEG_BYTE \ |
c1ea566e | 363 | + ((pos) >= (buf)->text->gpt ? (buf)->text->gap_size : 0)) |
b3ec245a | 364 | |
69f9064e RS |
365 | /* Convert PTR, the address of a char in buffer BUF, |
366 | into a character position. */ | |
790f39e7 | 367 | |
69f9064e RS |
368 | #define BUF_PTR_BYTE_POS(buf, ptr) \ |
369 | ((ptr) - (buf)->text->beg \ | |
d895183d | 370 | - (ptr - (buf)->text->beg <= (unsigned) (BUF_GPT_BYTE ((buf)) - BEG_BYTE)\ |
69f9064e | 371 | ? 0 : BUF_GAP_SIZE ((buf))) \ |
d895183d | 372 | + BEG_BYTE) |
69f9064e RS |
373 | |
374 | /* Return the character at byte position POS in buffer BUF. */ | |
375 | ||
376 | #define BUF_FETCH_CHAR(buf, pos) \ | |
377 | (!NILP (buf->enable_multibyte_characters) \ | |
378 | ? BUF_FETCH_MULTIBYTE_CHAR ((buf), (pos)) \ | |
379 | : BUF_FETCH_BYTE ((buf), (pos))) | |
380 | ||
381 | /* Return the byte at byte position N in buffer BUF. */ | |
382 | ||
383 | #define BUF_FETCH_BYTE(buf, n) \ | |
384 | *(BUF_BYTE_ADDRESS ((buf), (n))) | |
385 | ||
386 | /* Return character code of multi-byte form at byte position POS in BUF. | |
387 | If POS doesn't point the head of valid multi-byte form, only the byte at | |
388 | POS is returned. No range checking. */ | |
389 | ||
390 | #define BUF_FETCH_MULTIBYTE_CHAR(buf, pos) \ | |
391 | (_fetch_multibyte_char_p \ | |
392 | = (((pos) >= BUF_GPT_BYTE (buf) ? BUF_GAP_SIZE (buf) : 0) \ | |
d895183d | 393 | + (pos) + BUF_BEG_ADDR (buf) - BEG_BYTE), \ |
feb3066c | 394 | STRING_CHAR (_fetch_multibyte_char_p, 0)) |
b3ec245a | 395 | \f |
69f9064e RS |
396 | /* Define the actual buffer data structures. */ |
397 | ||
398 | /* This data structure describes the actual text contents of a buffer. | |
399 | It is shared between indirect buffers and their base buffer. */ | |
400 | ||
b3ec245a JB |
401 | struct buffer_text |
402 | { | |
0afdfe38 GM |
403 | /* Actual address of buffer contents. If REL_ALLOC is defined, |
404 | this address might change when blocks are relocated which can | |
405 | e.g. happen when malloc is called. So, don't pass a pointer | |
406 | into a buffer's text to functions that malloc. */ | |
407 | unsigned char *beg; | |
177c0ea7 | 408 | |
8aa91000 SM |
409 | EMACS_INT gpt; /* Char pos of gap in buffer. */ |
410 | EMACS_INT z; /* Char pos of end of buffer. */ | |
411 | EMACS_INT gpt_byte; /* Byte pos of gap in buffer. */ | |
412 | EMACS_INT z_byte; /* Byte pos of end of buffer. */ | |
413 | EMACS_INT gap_size; /* Size of buffer's gap. */ | |
b3ec245a JB |
414 | int modiff; /* This counts buffer-modification events |
415 | for this buffer. It is incremented for | |
416 | each such event, and never otherwise | |
417 | changed. */ | |
3e145152 CY |
418 | int chars_modiff; /* This is modified with character change |
419 | events for this buffer. It is set to | |
420 | modiff for each such event, and never | |
421 | otherwise changed. */ | |
c1ea566e RS |
422 | int save_modiff; /* Previous value of modiff, as of last |
423 | time buffer visited or saved a file. */ | |
424 | ||
2e50b9cc RS |
425 | int overlay_modiff; /* Counts modifications to overlays. */ |
426 | ||
133a3962 | 427 | /* Minimum value of GPT - BEG since last redisplay that finished. */ |
8aa91000 | 428 | EMACS_INT beg_unchanged; |
133a3962 GM |
429 | |
430 | /* Minimum value of Z - GPT since last redisplay that finished. */ | |
8aa91000 | 431 | EMACS_INT end_unchanged; |
133a3962 GM |
432 | |
433 | /* MODIFF as of last redisplay that finished; if it matches MODIFF, | |
434 | beg_unchanged and end_unchanged contain no useful information. */ | |
435 | int unchanged_modified; | |
436 | ||
437 | /* BUF_OVERLAY_MODIFF of current buffer, as of last redisplay that | |
438 | finished; if it matches BUF_OVERLAY_MODIFF, beg_unchanged and | |
439 | end_unchanged contain no useful information. */ | |
440 | int overlay_unchanged_modified; | |
441 | ||
bb4fee02 DL |
442 | /* Properties of this buffer's text. */ |
443 | INTERVAL intervals; | |
c1ea566e RS |
444 | |
445 | /* The markers that refer to this buffer. | |
446 | This is actually a single marker --- | |
447 | successive elements in its marker `chain' | |
448 | are the other markers referring to this buffer. */ | |
568c168c | 449 | struct Lisp_Marker *markers; |
e9728cc0 KH |
450 | |
451 | /* Usually 0. Temporarily set to 1 in decode_coding_gap to | |
452 | prevent Fgarbage_collect from shrinking the gap and loosing | |
453 | not-yet-decoded bytes. */ | |
454 | int inhibit_shrinking; | |
b3ec245a JB |
455 | }; |
456 | ||
69f9064e RS |
457 | /* This is the structure that the buffer Lisp object points to. */ |
458 | ||
b3ec245a | 459 | struct buffer |
82b911fd GM |
460 | { |
461 | /* Everything before the `name' slot must be of a non-Lisp_Object type, | |
462 | and every slot after `name' must be a Lisp_Object. | |
463 | ||
464 | Check out mark_buffer (alloc.c) to see why. */ | |
465 | ||
d0fdb6da | 466 | EMACS_UINT size; |
82b911fd GM |
467 | |
468 | /* Next buffer, in chain of all buffers including killed buffers. | |
469 | This chain is used only for garbage collection, in order to | |
470 | collect killed buffers properly. | |
471 | Note that vectors and most pseudovectors are all on one chain, | |
472 | but buffers are on a separate chain of their own. */ | |
473 | struct buffer *next; | |
474 | ||
475 | /* This structure holds the coordinates of the buffer contents | |
476 | in ordinary buffers. In indirect buffers, this is not used. */ | |
477 | struct buffer_text own_text; | |
478 | ||
479 | /* This points to the `struct buffer_text' that used for this buffer. | |
480 | In an ordinary buffer, this is the own_text field above. | |
481 | In an indirect buffer, this is the own_text field of another buffer. */ | |
482 | struct buffer_text *text; | |
483 | ||
484 | /* Char position of point in buffer. */ | |
8aa91000 | 485 | EMACS_INT pt; |
82b911fd | 486 | /* Byte position of point in buffer. */ |
8aa91000 | 487 | EMACS_INT pt_byte; |
82b911fd | 488 | /* Char position of beginning of accessible range. */ |
8aa91000 | 489 | EMACS_INT begv; |
82b911fd | 490 | /* Byte position of beginning of accessible range. */ |
8aa91000 | 491 | EMACS_INT begv_byte; |
82b911fd | 492 | /* Char position of end of accessible range. */ |
8aa91000 | 493 | EMACS_INT zv; |
82b911fd | 494 | /* Byte position of end of accessible range. */ |
8aa91000 | 495 | EMACS_INT zv_byte; |
82b911fd GM |
496 | |
497 | /* In an indirect buffer, this points to the base buffer. | |
498 | In an ordinary buffer, it is 0. */ | |
499 | struct buffer *base_buffer; | |
500 | ||
501 | /* A non-zero value in slot IDX means that per-buffer variable | |
502 | with index IDX has a local value in this buffer. The index IDX | |
503 | for a buffer-local variable is stored in that variable's slot | |
504 | in buffer_local_flags as a Lisp integer. If the index is -1, | |
505 | this means the variable is always local in all buffers. */ | |
ddebaaa9 | 506 | #define MAX_PER_BUFFER_VARS 50 |
82b911fd | 507 | char local_flags[MAX_PER_BUFFER_VARS]; |
177c0ea7 | 508 | |
82b911fd GM |
509 | /* Set to the modtime of the visited file when read or written. |
510 | -1 means visited file was nonexistent. | |
511 | 0 means visited file modtime unknown; in no case complain | |
512 | about any mismatch on next save attempt. */ | |
513 | int modtime; | |
5e309390 | 514 | /* The value of text->modiff at the last auto-save. */ |
82b911fd | 515 | int auto_save_modified; |
5e309390 RS |
516 | /* The value of text->modiff at the last display error. |
517 | Redisplay of this buffer is inhibited until it changes again. */ | |
518 | int display_error_modiff; | |
82b911fd GM |
519 | /* The time at which we detected a failure to auto-save, |
520 | Or -1 if we didn't have a failure. */ | |
521 | int auto_save_failure_time; | |
522 | /* Position in buffer at which display started | |
523 | the last time this buffer was displayed. */ | |
8aa91000 | 524 | EMACS_INT last_window_start; |
82b911fd GM |
525 | |
526 | /* Set nonzero whenever the narrowing is changed in this buffer. */ | |
527 | int clip_changed; | |
528 | ||
529 | /* If the long line scan cache is enabled (i.e. the buffer-local | |
530 | variable cache-long-line-scans is non-nil), newline_cache | |
531 | points to the newline cache, and width_run_cache points to the | |
532 | width run cache. | |
533 | ||
534 | The newline cache records which stretches of the buffer are | |
535 | known *not* to contain newlines, so that they can be skipped | |
536 | quickly when we search for newlines. | |
537 | ||
538 | The width run cache records which stretches of the buffer are | |
539 | known to contain characters whose widths are all the same. If | |
540 | the width run cache maps a character to a value > 0, that value is | |
541 | the character's width; if it maps a character to zero, we don't | |
542 | know what its width is. This allows compute_motion to process | |
543 | such regions very quickly, using algebra instead of inspecting | |
544 | each character. See also width_table, below. */ | |
545 | struct region_cache *newline_cache; | |
546 | struct region_cache *width_run_cache; | |
547 | ||
548 | /* Non-zero means don't use redisplay optimizations for | |
549 | displaying this buffer. */ | |
550 | unsigned prevent_redisplay_optimizations_p : 1; | |
551 | ||
87359a3d SM |
552 | /* List of overlays that end at or before the current center, |
553 | in order of end-position. */ | |
554 | struct Lisp_Overlay *overlays_before; | |
555 | ||
556 | /* List of overlays that end after the current center, | |
557 | in order of start-position. */ | |
558 | struct Lisp_Overlay *overlays_after; | |
559 | ||
58c8ea37 SM |
560 | /* Position where the overlay lists are centered. */ |
561 | EMACS_INT overlay_center; | |
562 | ||
ccaf15bd SM |
563 | /* Everything from here down must be a Lisp_Object. */ |
564 | /* buffer-local Lisp variables start at `undo_list', | |
565 | tho only the ones from `name' on are GC'd normally. */ | |
566 | ||
66b04bd4 SM |
567 | /* Changes in the buffer are recorded here for undo. |
568 | t means don't record anything. | |
569 | This information belongs to the base buffer of an indirect buffer, | |
570 | But we can't store it in the struct buffer_text | |
571 | because local variables have to be right in the struct buffer. | |
572 | So we copy it around in set_buffer_internal. | |
573 | This comes before `name' because it is marked in a special way. */ | |
574 | Lisp_Object undo_list; | |
575 | ||
82b911fd GM |
576 | /* The name of this buffer. */ |
577 | Lisp_Object name; | |
578 | ||
579 | /* The name of the file visited in this buffer, or nil. */ | |
580 | Lisp_Object filename; | |
581 | /* Dir for expanding relative file names. */ | |
582 | Lisp_Object directory; | |
e0f24100 | 583 | /* True if this buffer has been backed up (if you write to the |
82b911fd GM |
584 | visited file and it hasn't been backed up, then a backup will |
585 | be made). */ | |
586 | /* This isn't really used by the C code, so could be deleted. */ | |
587 | Lisp_Object backed_up; | |
588 | /* Length of file when last read or saved. | |
589 | This is not in the struct buffer_text | |
590 | because it's not used in indirect buffers at all. */ | |
591 | Lisp_Object save_length; | |
592 | /* File name used for auto-saving this buffer. | |
593 | This is not in the struct buffer_text | |
594 | because it's not used in indirect buffers at all. */ | |
595 | Lisp_Object auto_save_file_name; | |
596 | ||
597 | /* Non-nil if buffer read-only. */ | |
598 | Lisp_Object read_only; | |
599 | /* "The mark". This is a marker which may | |
600 | point into this buffer or may point nowhere. */ | |
601 | Lisp_Object mark; | |
602 | ||
603 | /* Alist of elements (SYMBOL . VALUE-IN-THIS-BUFFER) | |
604 | for all per-buffer variables of this buffer. */ | |
605 | Lisp_Object local_var_alist; | |
606 | ||
607 | /* Symbol naming major mode (eg, lisp-mode). */ | |
608 | Lisp_Object major_mode; | |
609 | /* Pretty name of major mode (eg, "Lisp"). */ | |
610 | Lisp_Object mode_name; | |
611 | /* Mode line element that controls format of mode line. */ | |
612 | Lisp_Object mode_line_format; | |
517e7945 | 613 | |
82b911fd GM |
614 | /* Analogous to mode_line_format for the line displayed at the top |
615 | of windows. Nil means don't display that line. */ | |
616 | Lisp_Object header_line_format; | |
617 | ||
618 | /* Keys that are bound local to this buffer. */ | |
619 | Lisp_Object keymap; | |
620 | /* This buffer's local abbrev table. */ | |
621 | Lisp_Object abbrev_table; | |
622 | /* This buffer's syntax table. */ | |
623 | Lisp_Object syntax_table; | |
624 | /* This buffer's category table. */ | |
625 | Lisp_Object category_table; | |
626 | ||
33f1148d | 627 | /* Values of several buffer-local variables. */ |
82b911fd | 628 | /* tab-width is buffer-local so that redisplay can find it |
33f1148d | 629 | in buffers that are not current. */ |
82b911fd GM |
630 | Lisp_Object case_fold_search; |
631 | Lisp_Object tab_width; | |
632 | Lisp_Object fill_column; | |
633 | Lisp_Object left_margin; | |
634 | /* Function to call when insert space past fill column. */ | |
635 | Lisp_Object auto_fill_function; | |
636 | /* nil: text, t: binary. | |
637 | This value is meaningful only on certain operating systems. */ | |
638 | /* Actually, we don't need this flag any more because end-of-line | |
639 | is handled correctly according to the buffer-file-coding-system | |
640 | of the buffer. Just keeping it for backward compatibility. */ | |
641 | Lisp_Object buffer_file_type; | |
642 | ||
643 | /* Case table for case-conversion in this buffer. | |
644 | This char-table maps each char into its lower-case version. */ | |
645 | Lisp_Object downcase_table; | |
646 | /* Char-table mapping each char to its upper-case version. */ | |
647 | Lisp_Object upcase_table; | |
648 | /* Char-table for conversion for case-folding search. */ | |
649 | Lisp_Object case_canon_table; | |
650 | /* Char-table of equivalences for case-folding search. */ | |
651 | Lisp_Object case_eqv_table; | |
652 | ||
653 | /* Non-nil means do not display continuation lines. */ | |
654 | Lisp_Object truncate_lines; | |
655 | /* Non-nil means display ctl chars with uparrow. */ | |
656 | Lisp_Object ctl_arrow; | |
657 | /* Non-nil means display text from right to left. */ | |
658 | Lisp_Object direction_reversed; | |
659 | /* Non-nil means do selective display; | |
660 | see doc string in syms_of_buffer (buffer.c) for details. */ | |
661 | Lisp_Object selective_display; | |
b3ec245a | 662 | #ifndef old |
82b911fd GM |
663 | /* Non-nil means show ... at end of line followed by invisible lines. */ |
664 | Lisp_Object selective_display_ellipses; | |
b3ec245a | 665 | #endif |
82b911fd GM |
666 | /* Alist of (FUNCTION . STRING) for each minor mode enabled in buffer. */ |
667 | Lisp_Object minor_modes; | |
668 | /* t if "self-insertion" should overwrite; `binary' if it should also | |
669 | overwrite newlines and tabs - for editing executables and the like. */ | |
670 | Lisp_Object overwrite_mode; | |
671 | /* non-nil means abbrev mode is on. Expand abbrevs automatically. */ | |
672 | Lisp_Object abbrev_mode; | |
673 | /* Display table to use for text in this buffer. */ | |
674 | Lisp_Object display_table; | |
675 | /* t means the mark and region are currently active. */ | |
676 | Lisp_Object mark_active; | |
677 | ||
82b911fd GM |
678 | /* Non-nil means the buffer contents are regarded as multi-byte |
679 | form of characters, not a binary code. */ | |
680 | Lisp_Object enable_multibyte_characters; | |
681 | ||
682 | /* Coding system to be used for encoding the buffer contents on | |
683 | saving. */ | |
684 | Lisp_Object buffer_file_coding_system; | |
685 | ||
33f1148d | 686 | /* List of symbols naming the file format used for visited file. */ |
82b911fd GM |
687 | Lisp_Object file_format; |
688 | ||
dc511a66 LT |
689 | /* List of symbols naming the file format used for auto-save file. */ |
690 | Lisp_Object auto_save_file_format; | |
691 | ||
82b911fd GM |
692 | /* True if the newline position cache and width run cache are |
693 | enabled. See search.c and indent.c. */ | |
694 | Lisp_Object cache_long_line_scans; | |
695 | ||
696 | /* If the width run cache is enabled, this table contains the | |
697 | character widths width_run_cache (see above) assumes. When we | |
698 | do a thorough redisplay, we compare this against the buffer's | |
699 | current display table to see whether the display table has | |
700 | affected the widths of any characters. If it has, we | |
701 | invalidate the width run cache, and re-initialize width_table. */ | |
702 | Lisp_Object width_table; | |
703 | ||
704 | /* In an indirect buffer, or a buffer that is the base of an | |
705 | indirect buffer, this holds a marker that records | |
706 | PT for this buffer when the buffer is not current. */ | |
707 | Lisp_Object pt_marker; | |
708 | ||
709 | /* In an indirect buffer, or a buffer that is the base of an | |
710 | indirect buffer, this holds a marker that records | |
711 | BEGV for this buffer when the buffer is not current. */ | |
712 | Lisp_Object begv_marker; | |
713 | ||
714 | /* In an indirect buffer, or a buffer that is the base of an | |
715 | indirect buffer, this holds a marker that records | |
716 | ZV for this buffer when the buffer is not current. */ | |
717 | Lisp_Object zv_marker; | |
718 | ||
719 | /* This holds the point value before the last scroll operation. | |
720 | Explicitly setting point sets this to nil. */ | |
721 | Lisp_Object point_before_scroll; | |
722 | ||
723 | /* Truename of the visited file, or nil. */ | |
724 | Lisp_Object file_truename; | |
725 | ||
726 | /* Invisibility spec of this buffer. | |
727 | t => any non-nil `invisible' property means invisible. | |
728 | A list => `invisible' property means invisible | |
729 | if it is memq in that list. */ | |
730 | Lisp_Object invisibility_spec; | |
731 | ||
732 | /* This is the last window that was selected with this buffer in it, | |
733 | or nil if that window no longer displays this buffer. */ | |
734 | Lisp_Object last_selected_window; | |
735 | ||
736 | /* Incremented each time the buffer is displayed in a window. */ | |
737 | Lisp_Object display_count; | |
177c0ea7 | 738 | |
82b911fd GM |
739 | /* Widths of left and right marginal areas for windows displaying |
740 | this buffer. */ | |
7e10f254 KS |
741 | Lisp_Object left_margin_cols, right_margin_cols; |
742 | ||
743 | /* Widths of left and right fringe areas for windows displaying | |
744 | this buffer. */ | |
745 | Lisp_Object left_fringe_width, right_fringe_width; | |
746 | ||
747 | /* Non-nil means fringes are drawn outside display margins; | |
748 | othersize draw them between margin areas and text. */ | |
749 | Lisp_Object fringes_outside_margins; | |
750 | ||
751 | /* Width and type of scroll bar areas for windows displaying | |
752 | this buffer. */ | |
753 | Lisp_Object scroll_bar_width, vertical_scroll_bar_type; | |
82b911fd GM |
754 | |
755 | /* Non-nil means indicate lines not displaying text (in a style | |
756 | like vi). */ | |
757 | Lisp_Object indicate_empty_lines; | |
758 | ||
6b61353c KH |
759 | /* Non-nil means indicate buffer boundaries and scrolling. */ |
760 | Lisp_Object indicate_buffer_boundaries; | |
761 | ||
856c2c73 KS |
762 | /* Logical to physical fringe bitmap mappings. */ |
763 | Lisp_Object fringe_indicator_alist; | |
764 | ||
765 | /* Logical to physical cursor bitmap mappings. */ | |
766 | Lisp_Object fringe_cursor_alist; | |
767 | ||
82b911fd GM |
768 | /* Time stamp updated each time this buffer is displayed in a window. */ |
769 | Lisp_Object display_time; | |
770 | ||
771 | /* If scrolling the display because point is below the bottom of a | |
772 | window showing this buffer, try to choose a window start so | |
773 | that point ends up this number of lines from the top of the | |
774 | window. Nil means that scrolling method isn't used. */ | |
775 | Lisp_Object scroll_up_aggressively; | |
177c0ea7 | 776 | |
82b911fd GM |
777 | /* If scrolling the display because point is above the top of a |
778 | window showing this buffer, try to choose a window start so | |
779 | that point ends up this number of lines from the bottom of the | |
780 | window. Nil means that scrolling method isn't used. */ | |
781 | Lisp_Object scroll_down_aggressively; | |
2d8c80b1 | 782 | |
82b911fd GM |
783 | /* Desired cursor type in this buffer. See the doc string of |
784 | per-buffer variable `cursor-type'. */ | |
785 | Lisp_Object cursor_type; | |
786 | ||
787 | /* An integer > 0 means put that number of pixels below text lines | |
788 | in the display of this buffer. */ | |
789 | Lisp_Object extra_line_spacing; | |
55806be1 RS |
790 | |
791 | /* *Cursor type to display in non-selected windows. | |
792 | t means to use hollow box cursor. | |
793 | See `cursor-type' for other values. */ | |
794 | Lisp_Object cursor_in_non_selected_windows; | |
82b911fd | 795 | }; |
a698b358 | 796 | |
440d350c RS |
797 | \f |
798 | /* This points to the current buffer. */ | |
b3ec245a JB |
799 | |
800 | extern struct buffer *current_buffer; | |
801 | ||
802 | /* This structure holds the default values of the buffer-local variables | |
440d350c | 803 | that have special slots in each buffer. |
b3ec245a JB |
804 | The default value occupies the same slot in this structure |
805 | as an individual buffer's value occupies in that buffer. | |
806 | Setting the default value also goes through the alist of buffers | |
807 | and stores into each buffer that does not say it has a local value. */ | |
808 | ||
809 | extern struct buffer buffer_defaults; | |
810 | ||
811 | /* This structure marks which slots in a buffer have corresponding | |
812 | default values in buffer_defaults. | |
813 | Each such slot has a nonzero value in this structure. | |
814 | The value has only one nonzero bit. | |
815 | ||
816 | When a buffer has its own local value for a slot, | |
979332f6 GM |
817 | the entry for that slot (found in the same slot in this structure) |
818 | is turned on in the buffer's local_flags array. | |
b3ec245a JB |
819 | |
820 | If a slot in this structure is zero, then even though there may | |
440d350c | 821 | be a Lisp-level local variable for the slot, it has no default value, |
b3ec245a JB |
822 | and the corresponding slot in buffer_defaults is not used. */ |
823 | ||
824 | extern struct buffer buffer_local_flags; | |
825 | ||
826 | /* For each buffer slot, this points to the Lisp symbol name | |
827 | for that slot in the current buffer. It is 0 for slots | |
828 | that don't have such names. */ | |
829 | ||
830 | extern struct buffer buffer_local_symbols; | |
440d350c | 831 | \f |
ae15c6c7 | 832 | extern void delete_all_overlays P_ ((struct buffer *)); |
4b7610a9 | 833 | extern void reset_buffer P_ ((struct buffer *)); |
58c8ea37 | 834 | extern void evaporate_overlays P_ ((EMACS_INT)); |
0f8b27ea SM |
835 | extern int overlays_at P_ ((EMACS_INT pos, int extend, Lisp_Object **vec_ptr, |
836 | int *len_ptr, EMACS_INT *next_ptr, | |
837 | EMACS_INT *prev_ptr, int change_req)); | |
4b7610a9 | 838 | extern int sort_overlays P_ ((Lisp_Object *, int, struct window *)); |
58c8ea37 SM |
839 | extern void recenter_overlay_lists P_ ((struct buffer *, EMACS_INT)); |
840 | extern int overlay_strings P_ ((EMACS_INT, struct window *, unsigned char **)); | |
4b7610a9 AS |
841 | extern void validate_region P_ ((Lisp_Object *, Lisp_Object *)); |
842 | extern void set_buffer_internal P_ ((struct buffer *)); | |
843 | extern void set_buffer_internal_1 P_ ((struct buffer *)); | |
844 | extern void set_buffer_temp P_ ((struct buffer *)); | |
845 | extern void record_buffer P_ ((Lisp_Object)); | |
64e16c3c | 846 | extern void buffer_slot_type_mismatch P_ ((Lisp_Object, int)) NO_RETURN; |
58c8ea37 | 847 | extern void fix_overlays_before P_ ((struct buffer *, EMACS_INT, EMACS_INT)); |
a465f86b | 848 | extern void mmap_set_vars P_ ((int)); |
4b7610a9 | 849 | |
002571dd KS |
850 | /* Get overlays at POSN into array OVERLAYS with NOVERLAYS elements. |
851 | If NEXTP is non-NULL, return next overlay there. | |
852 | See overlay_at arg CHANGE_REQ for meaning of CHRQ arg. */ | |
853 | ||
854 | #define GET_OVERLAYS_AT(posn, overlays, noverlays, nextp, chrq) \ | |
855 | do { \ | |
856 | int maxlen = 40; \ | |
857 | overlays = (Lisp_Object *) alloca (maxlen * sizeof (Lisp_Object)); \ | |
858 | noverlays = overlays_at (posn, 0, &overlays, &maxlen, \ | |
859 | nextp, NULL, chrq); \ | |
860 | if (noverlays > maxlen) \ | |
861 | { \ | |
862 | maxlen = noverlays; \ | |
863 | overlays = (Lisp_Object *) alloca (maxlen * sizeof (Lisp_Object)); \ | |
864 | noverlays = overlays_at (posn, 0, &overlays, &maxlen, \ | |
865 | nextp, NULL, chrq); \ | |
866 | } \ | |
867 | } while (0) | |
868 | ||
f9f3238f | 869 | EXFUN (Fbuffer_list, 1); |
d6af5f0c | 870 | EXFUN (Fbuffer_live_p, 1); |
4b7610a9 AS |
871 | EXFUN (Fbuffer_name, 1); |
872 | EXFUN (Fget_file_buffer, 1); | |
873 | EXFUN (Fnext_overlay_change, 1); | |
874 | EXFUN (Fdelete_overlay, 1); | |
7dd73b78 | 875 | EXFUN (Fbuffer_local_value, 2); |
bcd98331 | 876 | EXFUN (Fgenerate_new_buffer_name, 2); |
440d350c | 877 | |
c1ea566e | 878 | /* Functions to call before and after each text change. */ |
03c6309a RS |
879 | extern Lisp_Object Vbefore_change_functions; |
880 | extern Lisp_Object Vafter_change_functions; | |
dbc4e1c1 | 881 | extern Lisp_Object Vfirst_change_hook; |
23f73711 RS |
882 | extern Lisp_Object Qbefore_change_functions; |
883 | extern Lisp_Object Qafter_change_functions; | |
dbc4e1c1 | 884 | extern Lisp_Object Qfirst_change_hook; |
b3ec245a | 885 | |
347d3e9c KH |
886 | /* If nonzero, all modification hooks are suppressed. */ |
887 | extern int inhibit_modification_hooks; | |
888 | ||
83ec8b67 RS |
889 | extern Lisp_Object Vdeactivate_mark; |
890 | extern Lisp_Object Vtransient_mark_mode; | |
440d350c RS |
891 | \f |
892 | /* Overlays */ | |
893 | ||
d00c875c | 894 | /* 1 if the OV is an overlay object. */ |
a7be34e5 | 895 | |
6c523803 | 896 | #define OVERLAY_VALID(OV) (OVERLAYP (OV)) |
b3ec245a | 897 | |
440d350c | 898 | /* Return the marker that stands for where OV starts in the buffer. */ |
a7be34e5 | 899 | |
21f7c864 | 900 | #define OVERLAY_START(OV) (XOVERLAY (OV)->start) |
b3ec245a | 901 | |
440d350c | 902 | /* Return the marker that stands for where OV ends in the buffer. */ |
a7be34e5 | 903 | |
21f7c864 | 904 | #define OVERLAY_END(OV) (XOVERLAY (OV)->end) |
b3ec245a | 905 | |
a7be34e5 GM |
906 | /* Return the plist of overlay OV. */ |
907 | ||
908 | #define OVERLAY_PLIST(OV) XOVERLAY ((OV))->plist | |
909 | ||
d00c875c KH |
910 | /* Return the actual buffer position for the marker P. |
911 | We assume you know which buffer it's pointing into. */ | |
b3ec245a | 912 | |
915857ff | 913 | #define OVERLAY_POSITION(P) \ |
8e50cc2d | 914 | (MARKERP (P) ? marker_position (P) : (abort (), 0)) |
b3ec245a | 915 | |
39c75ccb | 916 | \f |
979332f6 GM |
917 | /*********************************************************************** |
918 | Buffer-local Variables | |
919 | ***********************************************************************/ | |
920 | ||
921 | /* Number of per-buffer variables used. */ | |
922 | ||
ddebaaa9 | 923 | extern int last_per_buffer_idx; |
979332f6 GM |
924 | |
925 | /* Return the offset in bytes of member VAR of struct buffer | |
926 | from the start of a buffer structure. */ | |
927 | ||
ddebaaa9 | 928 | #define PER_BUFFER_VAR_OFFSET(VAR) \ |
979332f6 GM |
929 | ((char *) &buffer_local_flags.VAR - (char *) &buffer_local_flags) |
930 | ||
931 | /* Return the index of buffer-local variable VAR. Each per-buffer | |
932 | variable has an index > 0 associated with it, except when it always | |
933 | has buffer-local values, in which case the index is -1. If this is | |
934 | 0, this is a bug and means that the slot of VAR in | |
935 | buffer_local_flags wasn't intiialized. */ | |
936 | ||
ddebaaa9 GM |
937 | #define PER_BUFFER_VAR_IDX(VAR) \ |
938 | PER_BUFFER_IDX (PER_BUFFER_VAR_OFFSET (VAR)) | |
979332f6 GM |
939 | |
940 | /* Value is non-zero if the variable with index IDX has a local value | |
941 | in buffer B. */ | |
942 | ||
ddebaaa9 GM |
943 | #define PER_BUFFER_VALUE_P(B, IDX) \ |
944 | (((IDX) < 0 || IDX >= last_per_buffer_idx) \ | |
979332f6 GM |
945 | ? (abort (), 0) \ |
946 | : ((B)->local_flags[IDX] != 0)) | |
947 | ||
948 | /* Set whether per-buffer variable with index IDX has a buffer-local | |
949 | value in buffer B. VAL zero means it hasn't. */ | |
950 | ||
ddebaaa9 | 951 | #define SET_PER_BUFFER_VALUE_P(B, IDX, VAL) \ |
979332f6 | 952 | do { \ |
ddebaaa9 | 953 | if ((IDX) < 0 || (IDX) >= last_per_buffer_idx) \ |
979332f6 GM |
954 | abort (); \ |
955 | (B)->local_flags[IDX] = (VAL); \ | |
956 | } while (0) | |
957 | ||
6b61353c KH |
958 | /* Return the index value of the per-buffer variable at offset OFFSET |
959 | in the buffer structure. | |
960 | ||
961 | If the slot OFFSET has a corresponding default value in | |
962 | buffer_defaults, the index value is positive and has only one | |
963 | nonzero bit. When a buffer has its own local value for a slot, the | |
964 | bit for that slot (found in the same slot in this structure) is | |
965 | turned on in the buffer's local_flags array. | |
966 | ||
967 | If the index value is -1, even though there may be a | |
968 | DEFVAR_PER_BUFFER for the slot, there is no default value for it; | |
969 | and the corresponding slot in buffer_defaults is not used. | |
970 | ||
971 | If the index value is -2, then there is no DEFVAR_PER_BUFFER for | |
972 | the slot, but there is a default value which is copied into each | |
973 | new buffer. | |
974 | ||
975 | If a slot in this structure corresponding to a DEFVAR_PER_BUFFER is | |
976 | zero, that is a bug */ | |
977 | ||
979332f6 | 978 | |
ddebaaa9 | 979 | #define PER_BUFFER_IDX(OFFSET) \ |
979332f6 GM |
980 | XINT (*(Lisp_Object *)((OFFSET) + (char *) &buffer_local_flags)) |
981 | ||
982 | /* Return the default value of the per-buffer variable at offset | |
983 | OFFSET in the buffer structure. */ | |
984 | ||
ddebaaa9 | 985 | #define PER_BUFFER_DEFAULT(OFFSET) \ |
979332f6 GM |
986 | (*(Lisp_Object *)((OFFSET) + (char *) &buffer_defaults)) |
987 | ||
988 | /* Return the buffer-local value of the per-buffer variable at offset | |
989 | OFFSET in the buffer structure. */ | |
990 | ||
ddebaaa9 | 991 | #define PER_BUFFER_VALUE(BUFFER, OFFSET) \ |
979332f6 GM |
992 | (*(Lisp_Object *)((OFFSET) + (char *) (BUFFER))) |
993 | ||
994 | /* Return the symbol of the per-buffer variable at offset OFFSET in | |
995 | the buffer structure. */ | |
996 | ||
ddebaaa9 | 997 | #define PER_BUFFER_SYMBOL(OFFSET) \ |
979332f6 GM |
998 | (*(Lisp_Object *)((OFFSET) + (char *) &buffer_local_symbols)) |
999 | ||
6b61353c KH |
1000 | /* arch-tag: 679305dd-d41c-4a50-b170-3caf5c97b2d1 |
1001 | (do not change this comment) */ |