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