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