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