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