Commit | Line | Data |
---|---|---|
b3ec245a | 1 | /* Header file for the buffer manipulation primitives. |
e9bffc61 | 2 | |
ab422c4d PE |
3 | Copyright (C) 1985-1986, 1993-1995, 1997-2013 Free Software Foundation, |
4 | 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 | |
43aac990 PE |
21 | #include <sys/types.h> |
22 | #include <time.h> | |
b3ec245a | 23 | |
f162bcc3 | 24 | INLINE_HEADER_BEGIN |
f162bcc3 | 25 | |
69f9064e | 26 | /* Accessing the parameters of the current buffer. */ |
1b92beaf | 27 | |
69f9064e RS |
28 | /* These macros come in pairs, one for the char position |
29 | and one for the byte position. */ | |
b3ec245a | 30 | |
177c0ea7 | 31 | /* Position of beginning of buffer. */ |
b3ec245a | 32 | #define BEG (1) |
8aa91000 | 33 | #define BEG_BYTE (BEG) |
b3ec245a | 34 | |
177c0ea7 | 35 | /* Position of beginning of accessible range of buffer. */ |
c1ea566e | 36 | #define BEGV (current_buffer->begv) |
69f9064e | 37 | #define BEGV_BYTE (current_buffer->begv_byte) |
b3ec245a | 38 | |
69f9064e | 39 | /* Position of point in buffer. The "+ 0" makes this |
177c0ea7 | 40 | not an l-value, so you can't assign to it. Use SET_PT instead. */ |
c1ea566e | 41 | #define PT (current_buffer->pt + 0) |
69f9064e | 42 | #define PT_BYTE (current_buffer->pt_byte + 0) |
b3ec245a | 43 | |
177c0ea7 | 44 | /* Position of gap in buffer. */ |
c1ea566e | 45 | #define GPT (current_buffer->text->gpt) |
69f9064e | 46 | #define GPT_BYTE (current_buffer->text->gpt_byte) |
b3ec245a | 47 | |
177c0ea7 | 48 | /* Position of end of accessible range of buffer. */ |
c1ea566e | 49 | #define ZV (current_buffer->zv) |
69f9064e | 50 | #define ZV_BYTE (current_buffer->zv_byte) |
b3ec245a | 51 | |
177c0ea7 | 52 | /* Position of end of buffer. */ |
c1ea566e | 53 | #define Z (current_buffer->text->z) |
69f9064e | 54 | #define Z_BYTE (current_buffer->text->z_byte) |
b3ec245a | 55 | |
69f9064e | 56 | /* Macros for the addresses of places in the buffer. */ |
b3ec245a | 57 | |
177c0ea7 | 58 | /* Address of beginning of buffer. */ |
c1ea566e | 59 | #define BEG_ADDR (current_buffer->text->beg) |
b3ec245a | 60 | |
177c0ea7 | 61 | /* Address of beginning of accessible range of buffer. */ |
69f9064e | 62 | #define BEGV_ADDR (BYTE_POS_ADDR (current_buffer->begv_byte)) |
b3ec245a | 63 | |
177c0ea7 | 64 | /* Address of point in buffer. */ |
69f9064e | 65 | #define PT_ADDR (BYTE_POS_ADDR (current_buffer->pt_byte)) |
b3ec245a | 66 | |
177c0ea7 | 67 | /* Address of beginning of gap in buffer. */ |
d895183d | 68 | #define GPT_ADDR (current_buffer->text->beg + current_buffer->text->gpt_byte - BEG_BYTE) |
b3ec245a JB |
69 | |
70 | /* Address of end of gap in buffer. */ | |
d895183d | 71 | #define GAP_END_ADDR (current_buffer->text->beg + current_buffer->text->gpt_byte + current_buffer->text->gap_size - BEG_BYTE) |
b3ec245a | 72 | |
177c0ea7 | 73 | /* Address of end of accessible range of buffer. */ |
69f9064e | 74 | #define ZV_ADDR (BYTE_POS_ADDR (current_buffer->zv_byte)) |
96b65d4e | 75 | |
177c0ea7 | 76 | /* Address of end of buffer. */ |
d895183d | 77 | #define Z_ADDR (current_buffer->text->beg + current_buffer->text->gap_size + current_buffer->text->z_byte - BEG_BYTE) |
b3ec245a JB |
78 | |
79 | /* Size of gap. */ | |
c1ea566e | 80 | #define GAP_SIZE (current_buffer->text->gap_size) |
b3ec245a | 81 | |
69f9064e RS |
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 | ||
b3ec245a | 170 | /* Modification count. */ |
c1ea566e RS |
171 | #define BUF_MODIFF(buf) ((buf)->text->modiff) |
172 | ||
3e145152 CY |
173 | /* Character modification count. */ |
174 | #define BUF_CHARS_MODIFF(buf) ((buf)->text->chars_modiff) | |
175 | ||
c1ea566e RS |
176 | /* Modification count as of last visit or save. */ |
177 | #define BUF_SAVE_MODIFF(buf) ((buf)->text->save_modiff) | |
178 | ||
2e50b9cc RS |
179 | /* Overlay modification count. */ |
180 | #define BUF_OVERLAY_MODIFF(buf) ((buf)->text->overlay_modiff) | |
181 | ||
0b5397c2 SM |
182 | /* Modification count as of last auto-save. */ |
183 | /* FIXME: should we move this into ->text->auto_save_modiff? */ | |
184 | #define BUF_AUTOSAVE_MODIFF(buf) ((buf)->auto_save_modified) | |
185 | ||
f9e7c67e DA |
186 | /* Compaction count. */ |
187 | #define BUF_COMPACT(buf) ((buf)->text->compact) | |
188 | ||
c1ea566e RS |
189 | /* Marker chain of buffer. */ |
190 | #define BUF_MARKERS(buf) ((buf)->text->markers) | |
133a3962 GM |
191 | |
192 | #define BUF_UNCHANGED_MODIFIED(buf) \ | |
193 | ((buf)->text->unchanged_modified) | |
194 | ||
195 | #define BUF_OVERLAY_UNCHANGED_MODIFIED(buf) \ | |
196 | ((buf)->text->overlay_unchanged_modified) | |
197 | #define BUF_BEG_UNCHANGED(buf) ((buf)->text->beg_unchanged) | |
198 | #define BUF_END_UNCHANGED(buf) ((buf)->text->end_unchanged) | |
199 | ||
200 | #define UNCHANGED_MODIFIED \ | |
201 | BUF_UNCHANGED_MODIFIED (current_buffer) | |
202 | #define OVERLAY_UNCHANGED_MODIFIED \ | |
203 | BUF_OVERLAY_UNCHANGED_MODIFIED (current_buffer) | |
204 | #define BEG_UNCHANGED BUF_BEG_UNCHANGED (current_buffer) | |
205 | #define END_UNCHANGED BUF_END_UNCHANGED (current_buffer) | |
206 | ||
207 | /* Compute how many characters at the top and bottom of BUF are | |
208 | unchanged when the range START..END is modified. This computation | |
209 | must be done each time BUF is modified. */ | |
210 | ||
211 | #define BUF_COMPUTE_UNCHANGED(buf, start, end) \ | |
212 | do \ | |
213 | { \ | |
9a6bd51a GM |
214 | if (BUF_UNCHANGED_MODIFIED (buf) == BUF_MODIFF (buf) \ |
215 | && (BUF_OVERLAY_UNCHANGED_MODIFIED (buf) \ | |
216 | == BUF_OVERLAY_MODIFF (buf))) \ | |
133a3962 GM |
217 | { \ |
218 | BUF_BEG_UNCHANGED (buf) = (start) - BUF_BEG (buf); \ | |
219 | BUF_END_UNCHANGED (buf) = BUF_Z (buf) - (end); \ | |
220 | } \ | |
221 | else \ | |
222 | { \ | |
223 | if (BUF_Z (buf) - (end) < BUF_END_UNCHANGED (buf)) \ | |
224 | BUF_END_UNCHANGED (buf) = BUF_Z (buf) - (end); \ | |
225 | if ((start) - BUF_BEG (buf) < BUF_BEG_UNCHANGED (buf)) \ | |
226 | BUF_BEG_UNCHANGED (buf) = (start) - BUF_BEG (buf); \ | |
227 | } \ | |
228 | } \ | |
229 | while (0) | |
177c0ea7 | 230 | |
69f9064e | 231 | \f |
33f1148d | 232 | /* Macros to set PT in the current buffer, or another buffer. */ |
b3ec245a | 233 | |
6ba7f443 | 234 | #define SET_PT(position) (set_point (position)) |
69f9064e | 235 | #define TEMP_SET_PT(position) (temp_set_point (current_buffer, (position))) |
b3ec245a | 236 | |
6ba7f443 | 237 | #define SET_PT_BOTH(position, byte) (set_point_both (position, byte)) |
69f9064e RS |
238 | #define TEMP_SET_PT_BOTH(position, byte) \ |
239 | (temp_set_point_both (current_buffer, (position), (byte))) | |
96b65d4e | 240 | |
69f9064e RS |
241 | #define BUF_TEMP_SET_PT(buffer, position) \ |
242 | (temp_set_point ((buffer), (position))) | |
96b65d4e | 243 | |
d311d28c PE |
244 | extern void set_point (ptrdiff_t); |
245 | extern void temp_set_point (struct buffer *, ptrdiff_t); | |
246 | extern void set_point_both (ptrdiff_t, ptrdiff_t); | |
b7982059 | 247 | extern void temp_set_point_both (struct buffer *, |
d311d28c | 248 | ptrdiff_t, ptrdiff_t); |
032f7451 | 249 | extern void set_point_from_marker (Lisp_Object); |
d311d28c | 250 | extern void enlarge_buffer_text (struct buffer *, ptrdiff_t); |
b3ec245a | 251 | |
69f9064e RS |
252 | \f |
253 | /* Macros for setting the BEGV, ZV or PT of a given buffer. | |
254 | ||
69f9064e RS |
255 | The ..._BOTH macros take both a charpos and a bytepos, |
256 | which must correspond to each other. | |
257 | ||
258 | The macros without ..._BOTH take just a charpos, | |
259 | and compute the bytepos from it. */ | |
b3ec245a | 260 | |
69f9064e RS |
261 | #define SET_BUF_BEGV(buf, charpos) \ |
262 | ((buf)->begv_byte = buf_charpos_to_bytepos ((buf), (charpos)), \ | |
263 | (buf)->begv = (charpos)) | |
264 | ||
265 | #define SET_BUF_ZV(buf, charpos) \ | |
266 | ((buf)->zv_byte = buf_charpos_to_bytepos ((buf), (charpos)), \ | |
267 | (buf)->zv = (charpos)) | |
268 | ||
269 | #define SET_BUF_BEGV_BOTH(buf, charpos, byte) \ | |
270 | ((buf)->begv = (charpos), \ | |
271 | (buf)->begv_byte = (byte)) | |
272 | ||
273 | #define SET_BUF_ZV_BOTH(buf, charpos, byte) \ | |
274 | ((buf)->zv = (charpos), \ | |
275 | (buf)->zv_byte = (byte)) | |
276 | ||
277 | #define SET_BUF_PT_BOTH(buf, charpos, byte) \ | |
278 | ((buf)->pt = (charpos), \ | |
279 | (buf)->pt_byte = (byte)) | |
280 | \f | |
281 | /* Macros to access a character or byte in the current buffer, | |
282 | or convert between a byte position and an address. | |
283 | These macros do not check that the position is in range. */ | |
284 | ||
285 | /* Access a Lisp position value in POS, | |
8b4baa7b | 286 | and store the charpos in CHARPOS and the bytepos in BYTEPOS. */ |
69f9064e | 287 | |
0e70695a DA |
288 | #define DECODE_POSITION(charpos, bytepos, pos) \ |
289 | do \ | |
290 | { \ | |
291 | Lisp_Object __pos = (pos); \ | |
292 | if (NUMBERP (__pos)) \ | |
293 | { \ | |
294 | charpos = __pos; \ | |
295 | bytepos = buf_charpos_to_bytepos (current_buffer, __pos); \ | |
296 | } \ | |
297 | else if (MARKERP (__pos)) \ | |
298 | { \ | |
299 | charpos = marker_position (__pos); \ | |
300 | bytepos = marker_byte_position (__pos); \ | |
301 | } \ | |
302 | else \ | |
303 | wrong_type_argument (Qinteger_or_marker_p, __pos); \ | |
304 | } \ | |
305 | while (0) | |
69f9064e | 306 | |
d1f3d2af PE |
307 | /* Maximum number of bytes in a buffer. |
308 | A buffer cannot contain more bytes than a 1-origin fixnum can represent, | |
28177add PE |
309 | nor can it be so large that C pointer arithmetic stops working. |
310 | The ptrdiff_t cast ensures that this is signed, not unsigned. */ | |
311 | #define BUF_BYTES_MAX \ | |
312 | (ptrdiff_t) min (MOST_POSITIVE_FIXNUM - 1, min (SIZE_MAX, PTRDIFF_MAX)) | |
d1f3d2af | 313 | |
eefd7278 DA |
314 | /* Maximum gap size after compact_buffer, in bytes. Also |
315 | used in make_gap_larger to get some extra reserved space. */ | |
316 | ||
317 | #define GAP_BYTES_DFL 2000 | |
318 | ||
319 | /* Minimum gap size after compact_buffer, in bytes. Also | |
320 | used in make_gap_smaller to avoid too small gap size. */ | |
321 | ||
322 | #define GAP_BYTES_MIN 20 | |
323 | ||
69f9064e RS |
324 | /* Return the address of byte position N in current buffer. */ |
325 | ||
326 | #define BYTE_POS_ADDR(n) \ | |
d895183d | 327 | (((n) >= GPT_BYTE ? GAP_SIZE : 0) + (n) + BEG_ADDR - BEG_BYTE) |
69f9064e RS |
328 | |
329 | /* Return the address of char position N. */ | |
330 | ||
331 | #define CHAR_POS_ADDR(n) \ | |
332 | (((n) >= GPT ? GAP_SIZE : 0) \ | |
333 | + buf_charpos_to_bytepos (current_buffer, n) \ | |
d895183d | 334 | + BEG_ADDR - BEG_BYTE) |
69f9064e RS |
335 | |
336 | /* Convert a character position to a byte position. */ | |
337 | ||
338 | #define CHAR_TO_BYTE(charpos) \ | |
339 | (buf_charpos_to_bytepos (current_buffer, charpos)) | |
340 | ||
341 | /* Convert a byte position to a character position. */ | |
342 | ||
343 | #define BYTE_TO_CHAR(bytepos) \ | |
344 | (buf_bytepos_to_charpos (current_buffer, bytepos)) | |
345 | ||
346 | /* Convert PTR, the address of a byte in the buffer, into a byte position. */ | |
347 | ||
348 | #define PTR_BYTE_POS(ptr) \ | |
349 | ((ptr) - (current_buffer)->text->beg \ | |
55daad71 | 350 | - (ptr - (current_buffer)->text->beg <= GPT_BYTE - BEG_BYTE ? 0 : GAP_SIZE) \ |
d895183d | 351 | + BEG_BYTE) |
69f9064e | 352 | |
2f8e16b2 EZ |
353 | /* Return character at byte position POS. See the caveat WARNING for |
354 | FETCH_MULTIBYTE_CHAR below. */ | |
69f9064e RS |
355 | |
356 | #define FETCH_CHAR(pos) \ | |
4b4deea2 | 357 | (!NILP (BVAR (current_buffer, enable_multibyte_characters)) \ |
69f9064e RS |
358 | ? FETCH_MULTIBYTE_CHAR ((pos)) \ |
359 | : FETCH_BYTE ((pos))) | |
360 | ||
361 | /* Return the byte at byte position N. */ | |
362 | ||
363 | #define FETCH_BYTE(n) *(BYTE_POS_ADDR ((n))) | |
364 | ||
ce5b453a | 365 | /* Return character at byte position POS. If the current buffer is unibyte |
feb3066c KH |
366 | and the character is not ASCII, make the returning character |
367 | multibyte. */ | |
368 | ||
369 | #define FETCH_CHAR_AS_MULTIBYTE(pos) \ | |
4b4deea2 | 370 | (!NILP (BVAR (current_buffer, enable_multibyte_characters)) \ |
feb3066c | 371 | ? FETCH_MULTIBYTE_CHAR ((pos)) \ |
4c0354d7 | 372 | : UNIBYTE_TO_CHAR (FETCH_BYTE ((pos)))) |
feb3066c | 373 | |
69f9064e RS |
374 | \f |
375 | /* Macros for accessing a character or byte, | |
376 | or converting between byte positions and addresses, | |
377 | in a specified buffer. */ | |
378 | ||
177c0ea7 | 379 | /* Return the address of character at byte position POS in buffer BUF. |
b3ec245a | 380 | Note that both arguments can be computed more than once. */ |
69f9064e RS |
381 | |
382 | #define BUF_BYTE_ADDRESS(buf, pos) \ | |
d895183d | 383 | ((buf)->text->beg + (pos) - BEG_BYTE \ |
69f9064e RS |
384 | + ((pos) >= (buf)->text->gpt_byte ? (buf)->text->gap_size : 0)) |
385 | ||
177c0ea7 | 386 | /* Return the address of character at char position POS in buffer BUF. |
69f9064e RS |
387 | Note that both arguments can be computed more than once. */ |
388 | ||
389 | #define BUF_CHAR_ADDRESS(buf, pos) \ | |
d895183d | 390 | ((buf)->text->beg + buf_charpos_to_bytepos ((buf), (pos)) - BEG_BYTE \ |
c1ea566e | 391 | + ((pos) >= (buf)->text->gpt ? (buf)->text->gap_size : 0)) |
b3ec245a | 392 | |
69f9064e RS |
393 | /* Convert PTR, the address of a char in buffer BUF, |
394 | into a character position. */ | |
790f39e7 | 395 | |
69f9064e RS |
396 | #define BUF_PTR_BYTE_POS(buf, ptr) \ |
397 | ((ptr) - (buf)->text->beg \ | |
55daad71 | 398 | - (ptr - (buf)->text->beg <= BUF_GPT_BYTE (buf) - BEG_BYTE \ |
69f9064e | 399 | ? 0 : BUF_GAP_SIZE ((buf))) \ |
d895183d | 400 | + BEG_BYTE) |
69f9064e RS |
401 | |
402 | /* Return the character at byte position POS in buffer BUF. */ | |
403 | ||
404 | #define BUF_FETCH_CHAR(buf, pos) \ | |
405 | (!NILP (buf->enable_multibyte_characters) \ | |
406 | ? BUF_FETCH_MULTIBYTE_CHAR ((buf), (pos)) \ | |
407 | : BUF_FETCH_BYTE ((buf), (pos))) | |
408 | ||
409 | /* Return the byte at byte position N in buffer BUF. */ | |
410 | ||
411 | #define BUF_FETCH_BYTE(buf, n) \ | |
412 | *(BUF_BYTE_ADDRESS ((buf), (n))) | |
b3ec245a | 413 | \f |
69f9064e RS |
414 | /* Define the actual buffer data structures. */ |
415 | ||
416 | /* This data structure describes the actual text contents of a buffer. | |
417 | It is shared between indirect buffers and their base buffer. */ | |
418 | ||
b3ec245a JB |
419 | struct buffer_text |
420 | { | |
0afdfe38 GM |
421 | /* Actual address of buffer contents. If REL_ALLOC is defined, |
422 | this address might change when blocks are relocated which can | |
423 | e.g. happen when malloc is called. So, don't pass a pointer | |
424 | into a buffer's text to functions that malloc. */ | |
425 | unsigned char *beg; | |
177c0ea7 | 426 | |
d311d28c PE |
427 | ptrdiff_t gpt; /* Char pos of gap in buffer. */ |
428 | ptrdiff_t z; /* Char pos of end of buffer. */ | |
429 | ptrdiff_t gpt_byte; /* Byte pos of gap in buffer. */ | |
430 | ptrdiff_t z_byte; /* Byte pos of end of buffer. */ | |
431 | ptrdiff_t gap_size; /* Size of buffer's gap. */ | |
432 | EMACS_INT modiff; /* This counts buffer-modification events | |
b3ec245a JB |
433 | for this buffer. It is incremented for |
434 | each such event, and never otherwise | |
435 | changed. */ | |
d311d28c | 436 | EMACS_INT chars_modiff; /* This is modified with character change |
3e145152 CY |
437 | events for this buffer. It is set to |
438 | modiff for each such event, and never | |
439 | otherwise changed. */ | |
d311d28c | 440 | EMACS_INT save_modiff; /* Previous value of modiff, as of last |
c1ea566e RS |
441 | time buffer visited or saved a file. */ |
442 | ||
d311d28c | 443 | EMACS_INT overlay_modiff; /* Counts modifications to overlays. */ |
2e50b9cc | 444 | |
9cd47b72 DA |
445 | EMACS_INT compact; /* Set to modiff each time when compact_buffer |
446 | is called for this buffer. */ | |
447 | ||
133a3962 | 448 | /* Minimum value of GPT - BEG since last redisplay that finished. */ |
d311d28c | 449 | ptrdiff_t beg_unchanged; |
133a3962 GM |
450 | |
451 | /* Minimum value of Z - GPT since last redisplay that finished. */ | |
d311d28c | 452 | ptrdiff_t end_unchanged; |
133a3962 GM |
453 | |
454 | /* MODIFF as of last redisplay that finished; if it matches MODIFF, | |
455 | beg_unchanged and end_unchanged contain no useful information. */ | |
d311d28c | 456 | EMACS_INT unchanged_modified; |
133a3962 GM |
457 | |
458 | /* BUF_OVERLAY_MODIFF of current buffer, as of last redisplay that | |
459 | finished; if it matches BUF_OVERLAY_MODIFF, beg_unchanged and | |
460 | end_unchanged contain no useful information. */ | |
d311d28c | 461 | EMACS_INT overlay_unchanged_modified; |
133a3962 | 462 | |
bb4fee02 DL |
463 | /* Properties of this buffer's text. */ |
464 | INTERVAL intervals; | |
c1ea566e RS |
465 | |
466 | /* The markers that refer to this buffer. | |
467 | This is actually a single marker --- | |
468 | successive elements in its marker `chain' | |
ce5b453a SM |
469 | are the other markers referring to this buffer. |
470 | This is a singly linked unordered list, which means that it's | |
471 | very cheap to add a marker to the list and it's also very cheap | |
472 | to move a marker within a buffer. */ | |
568c168c | 473 | struct Lisp_Marker *markers; |
e9728cc0 KH |
474 | |
475 | /* Usually 0. Temporarily set to 1 in decode_coding_gap to | |
cf503f7c | 476 | prevent Fgarbage_collect from shrinking the gap and losing |
e9728cc0 | 477 | not-yet-decoded bytes. */ |
655ab9a3 SM |
478 | bool inhibit_shrinking : 1; |
479 | ||
480 | /* True if it needs to be redisplayed. */ | |
481 | bool redisplay : 1; | |
b3ec245a JB |
482 | }; |
483 | ||
e34f7f79 | 484 | /* Most code should use this macro to access Lisp fields in struct buffer. */ |
5d8ea120 | 485 | |
e34f7f79 | 486 | #define BVAR(buf, field) ((buf)->INTERNAL_FIELD (field)) |
5d8ea120 | 487 | |
69f9064e RS |
488 | /* This is the structure that the buffer Lisp object points to. */ |
489 | ||
b3ec245a | 490 | struct buffer |
82b911fd | 491 | { |
b102ceb1 | 492 | struct vectorlike_header header; |
82b911fd | 493 | |
82b911fd | 494 | /* The name of this buffer. */ |
e34f7f79 | 495 | Lisp_Object INTERNAL_FIELD (name); |
82b911fd GM |
496 | |
497 | /* The name of the file visited in this buffer, or nil. */ | |
e34f7f79 | 498 | Lisp_Object INTERNAL_FIELD (filename); |
36429c89 DA |
499 | |
500 | /* Directory for expanding relative file names. */ | |
e34f7f79 | 501 | Lisp_Object INTERNAL_FIELD (directory); |
36429c89 DA |
502 | |
503 | /* True if this buffer has been backed up (if you write to the visited | |
504 | file and it hasn't been backed up, then a backup will be made). */ | |
e34f7f79 | 505 | Lisp_Object INTERNAL_FIELD (backed_up); |
36429c89 | 506 | |
82b911fd | 507 | /* Length of file when last read or saved. |
4be941e3 RS |
508 | -1 means auto saving turned off because buffer shrank a lot. |
509 | -2 means don't turn off auto saving if buffer shrinks. | |
510 | (That value is used with buffer-swap-text.) | |
82b911fd GM |
511 | This is not in the struct buffer_text |
512 | because it's not used in indirect buffers at all. */ | |
e34f7f79 | 513 | Lisp_Object INTERNAL_FIELD (save_length); |
36429c89 | 514 | |
82b911fd GM |
515 | /* File name used for auto-saving this buffer. |
516 | This is not in the struct buffer_text | |
517 | because it's not used in indirect buffers at all. */ | |
e34f7f79 | 518 | Lisp_Object INTERNAL_FIELD (auto_save_file_name); |
82b911fd GM |
519 | |
520 | /* Non-nil if buffer read-only. */ | |
e34f7f79 | 521 | Lisp_Object INTERNAL_FIELD (read_only); |
36429c89 | 522 | |
82b911fd GM |
523 | /* "The mark". This is a marker which may |
524 | point into this buffer or may point nowhere. */ | |
e34f7f79 | 525 | Lisp_Object INTERNAL_FIELD (mark); |
82b911fd | 526 | |
8653cf0a CY |
527 | /* Alist of elements (SYMBOL . VALUE-IN-THIS-BUFFER) for all |
528 | per-buffer variables of this buffer. For locally unbound | |
529 | symbols, just the symbol appears as the element. */ | |
e34f7f79 | 530 | Lisp_Object INTERNAL_FIELD (local_var_alist); |
82b911fd | 531 | |
36429c89 | 532 | /* Symbol naming major mode (e.g., lisp-mode). */ |
e34f7f79 | 533 | Lisp_Object INTERNAL_FIELD (major_mode); |
36429c89 DA |
534 | |
535 | /* Pretty name of major mode (e.g., "Lisp"). */ | |
e34f7f79 | 536 | Lisp_Object INTERNAL_FIELD (mode_name); |
36429c89 | 537 | |
82b911fd | 538 | /* Mode line element that controls format of mode line. */ |
e34f7f79 | 539 | Lisp_Object INTERNAL_FIELD (mode_line_format); |
517e7945 | 540 | |
82b911fd GM |
541 | /* Analogous to mode_line_format for the line displayed at the top |
542 | of windows. Nil means don't display that line. */ | |
e34f7f79 | 543 | Lisp_Object INTERNAL_FIELD (header_line_format); |
82b911fd GM |
544 | |
545 | /* Keys that are bound local to this buffer. */ | |
e34f7f79 | 546 | Lisp_Object INTERNAL_FIELD (keymap); |
36429c89 | 547 | |
82b911fd | 548 | /* This buffer's local abbrev table. */ |
e34f7f79 | 549 | Lisp_Object INTERNAL_FIELD (abbrev_table); |
36429c89 | 550 | |
82b911fd | 551 | /* This buffer's syntax table. */ |
e34f7f79 | 552 | Lisp_Object INTERNAL_FIELD (syntax_table); |
36429c89 | 553 | |
82b911fd | 554 | /* This buffer's category table. */ |
e34f7f79 | 555 | Lisp_Object INTERNAL_FIELD (category_table); |
82b911fd | 556 | |
33f1148d | 557 | /* Values of several buffer-local variables. */ |
82b911fd | 558 | /* tab-width is buffer-local so that redisplay can find it |
33f1148d | 559 | in buffers that are not current. */ |
e34f7f79 DA |
560 | Lisp_Object INTERNAL_FIELD (case_fold_search); |
561 | Lisp_Object INTERNAL_FIELD (tab_width); | |
562 | Lisp_Object INTERNAL_FIELD (fill_column); | |
563 | Lisp_Object INTERNAL_FIELD (left_margin); | |
36429c89 | 564 | |
82b911fd | 565 | /* Function to call when insert space past fill column. */ |
e34f7f79 | 566 | Lisp_Object INTERNAL_FIELD (auto_fill_function); |
82b911fd GM |
567 | |
568 | /* Case table for case-conversion in this buffer. | |
569 | This char-table maps each char into its lower-case version. */ | |
e34f7f79 | 570 | Lisp_Object INTERNAL_FIELD (downcase_table); |
36429c89 | 571 | |
82b911fd | 572 | /* Char-table mapping each char to its upper-case version. */ |
e34f7f79 | 573 | Lisp_Object INTERNAL_FIELD (upcase_table); |
36429c89 | 574 | |
82b911fd | 575 | /* Char-table for conversion for case-folding search. */ |
e34f7f79 | 576 | Lisp_Object INTERNAL_FIELD (case_canon_table); |
36429c89 | 577 | |
82b911fd | 578 | /* Char-table of equivalences for case-folding search. */ |
e34f7f79 | 579 | Lisp_Object INTERNAL_FIELD (case_eqv_table); |
82b911fd GM |
580 | |
581 | /* Non-nil means do not display continuation lines. */ | |
e34f7f79 | 582 | Lisp_Object INTERNAL_FIELD (truncate_lines); |
36429c89 | 583 | |
b0998719 | 584 | /* Non-nil means to use word wrapping when displaying continuation lines. */ |
e34f7f79 | 585 | Lisp_Object INTERNAL_FIELD (word_wrap); |
36429c89 | 586 | |
82b911fd | 587 | /* Non-nil means display ctl chars with uparrow. */ |
e34f7f79 | 588 | Lisp_Object INTERNAL_FIELD (ctl_arrow); |
36429c89 | 589 | |
f44e260c EZ |
590 | /* Non-nil means reorder bidirectional text for display in the |
591 | visual order. */ | |
e34f7f79 | 592 | Lisp_Object INTERNAL_FIELD (bidi_display_reordering); |
36429c89 | 593 | |
c143c213 EZ |
594 | /* If non-nil, specifies which direction of text to force in all the |
595 | paragraphs of the buffer. Nil means determine paragraph | |
596 | direction dynamically for each paragraph. */ | |
e34f7f79 | 597 | Lisp_Object INTERNAL_FIELD (bidi_paragraph_direction); |
36429c89 | 598 | |
82b911fd GM |
599 | /* Non-nil means do selective display; |
600 | see doc string in syms_of_buffer (buffer.c) for details. */ | |
e34f7f79 | 601 | Lisp_Object INTERNAL_FIELD (selective_display); |
36429c89 | 602 | |
82b911fd | 603 | /* Non-nil means show ... at end of line followed by invisible lines. */ |
e34f7f79 | 604 | Lisp_Object INTERNAL_FIELD (selective_display_ellipses); |
36429c89 | 605 | |
82b911fd | 606 | /* Alist of (FUNCTION . STRING) for each minor mode enabled in buffer. */ |
e34f7f79 | 607 | Lisp_Object INTERNAL_FIELD (minor_modes); |
36429c89 | 608 | |
82b911fd GM |
609 | /* t if "self-insertion" should overwrite; `binary' if it should also |
610 | overwrite newlines and tabs - for editing executables and the like. */ | |
e34f7f79 | 611 | Lisp_Object INTERNAL_FIELD (overwrite_mode); |
36429c89 DA |
612 | |
613 | /* Non-nil means abbrev mode is on. Expand abbrevs automatically. */ | |
e34f7f79 | 614 | Lisp_Object INTERNAL_FIELD (abbrev_mode); |
36429c89 | 615 | |
82b911fd | 616 | /* Display table to use for text in this buffer. */ |
e34f7f79 | 617 | Lisp_Object INTERNAL_FIELD (display_table); |
36429c89 | 618 | |
82b911fd | 619 | /* t means the mark and region are currently active. */ |
e34f7f79 | 620 | Lisp_Object INTERNAL_FIELD (mark_active); |
82b911fd | 621 | |
82b911fd GM |
622 | /* Non-nil means the buffer contents are regarded as multi-byte |
623 | form of characters, not a binary code. */ | |
e34f7f79 | 624 | Lisp_Object INTERNAL_FIELD (enable_multibyte_characters); |
82b911fd GM |
625 | |
626 | /* Coding system to be used for encoding the buffer contents on | |
627 | saving. */ | |
e34f7f79 | 628 | Lisp_Object INTERNAL_FIELD (buffer_file_coding_system); |
82b911fd | 629 | |
33f1148d | 630 | /* List of symbols naming the file format used for visited file. */ |
e34f7f79 | 631 | Lisp_Object INTERNAL_FIELD (file_format); |
82b911fd | 632 | |
dc511a66 | 633 | /* List of symbols naming the file format used for auto-save file. */ |
e34f7f79 | 634 | Lisp_Object INTERNAL_FIELD (auto_save_file_format); |
dc511a66 | 635 | |
e30b79c1 DA |
636 | /* True if the newline position cache, width run cache and BIDI paragraph |
637 | cache are enabled. See search.c, indent.c and bidi.c for details. */ | |
638 | Lisp_Object INTERNAL_FIELD (cache_long_scans); | |
82b911fd GM |
639 | |
640 | /* If the width run cache is enabled, this table contains the | |
641 | character widths width_run_cache (see above) assumes. When we | |
642 | do a thorough redisplay, we compare this against the buffer's | |
643 | current display table to see whether the display table has | |
644 | affected the widths of any characters. If it has, we | |
645 | invalidate the width run cache, and re-initialize width_table. */ | |
e34f7f79 | 646 | Lisp_Object INTERNAL_FIELD (width_table); |
82b911fd GM |
647 | |
648 | /* In an indirect buffer, or a buffer that is the base of an | |
649 | indirect buffer, this holds a marker that records | |
650 | PT for this buffer when the buffer is not current. */ | |
e34f7f79 | 651 | Lisp_Object INTERNAL_FIELD (pt_marker); |
82b911fd GM |
652 | |
653 | /* In an indirect buffer, or a buffer that is the base of an | |
654 | indirect buffer, this holds a marker that records | |
655 | BEGV for this buffer when the buffer is not current. */ | |
e34f7f79 | 656 | Lisp_Object INTERNAL_FIELD (begv_marker); |
82b911fd GM |
657 | |
658 | /* In an indirect buffer, or a buffer that is the base of an | |
659 | indirect buffer, this holds a marker that records | |
660 | ZV for this buffer when the buffer is not current. */ | |
e34f7f79 | 661 | Lisp_Object INTERNAL_FIELD (zv_marker); |
82b911fd GM |
662 | |
663 | /* This holds the point value before the last scroll operation. | |
664 | Explicitly setting point sets this to nil. */ | |
e34f7f79 | 665 | Lisp_Object INTERNAL_FIELD (point_before_scroll); |
82b911fd GM |
666 | |
667 | /* Truename of the visited file, or nil. */ | |
e34f7f79 | 668 | Lisp_Object INTERNAL_FIELD (file_truename); |
82b911fd GM |
669 | |
670 | /* Invisibility spec of this buffer. | |
671 | t => any non-nil `invisible' property means invisible. | |
672 | A list => `invisible' property means invisible | |
673 | if it is memq in that list. */ | |
e34f7f79 | 674 | Lisp_Object INTERNAL_FIELD (invisibility_spec); |
82b911fd GM |
675 | |
676 | /* This is the last window that was selected with this buffer in it, | |
677 | or nil if that window no longer displays this buffer. */ | |
e34f7f79 | 678 | Lisp_Object INTERNAL_FIELD (last_selected_window); |
82b911fd GM |
679 | |
680 | /* Incremented each time the buffer is displayed in a window. */ | |
e34f7f79 | 681 | Lisp_Object INTERNAL_FIELD (display_count); |
177c0ea7 | 682 | |
82b911fd GM |
683 | /* Widths of left and right marginal areas for windows displaying |
684 | this buffer. */ | |
e34f7f79 DA |
685 | Lisp_Object INTERNAL_FIELD (left_margin_cols); |
686 | Lisp_Object INTERNAL_FIELD (right_margin_cols); | |
7e10f254 KS |
687 | |
688 | /* Widths of left and right fringe areas for windows displaying | |
689 | this buffer. */ | |
e34f7f79 DA |
690 | Lisp_Object INTERNAL_FIELD (left_fringe_width); |
691 | Lisp_Object INTERNAL_FIELD (right_fringe_width); | |
7e10f254 KS |
692 | |
693 | /* Non-nil means fringes are drawn outside display margins; | |
694 | othersize draw them between margin areas and text. */ | |
e34f7f79 | 695 | Lisp_Object INTERNAL_FIELD (fringes_outside_margins); |
7e10f254 KS |
696 | |
697 | /* Width and type of scroll bar areas for windows displaying | |
698 | this buffer. */ | |
e34f7f79 DA |
699 | Lisp_Object INTERNAL_FIELD (scroll_bar_width); |
700 | Lisp_Object INTERNAL_FIELD (vertical_scroll_bar_type); | |
82b911fd GM |
701 | |
702 | /* Non-nil means indicate lines not displaying text (in a style | |
703 | like vi). */ | |
e34f7f79 | 704 | Lisp_Object INTERNAL_FIELD (indicate_empty_lines); |
82b911fd | 705 | |
6b61353c | 706 | /* Non-nil means indicate buffer boundaries and scrolling. */ |
e34f7f79 | 707 | Lisp_Object INTERNAL_FIELD (indicate_buffer_boundaries); |
6b61353c | 708 | |
856c2c73 | 709 | /* Logical to physical fringe bitmap mappings. */ |
e34f7f79 | 710 | Lisp_Object INTERNAL_FIELD (fringe_indicator_alist); |
856c2c73 KS |
711 | |
712 | /* Logical to physical cursor bitmap mappings. */ | |
e34f7f79 | 713 | Lisp_Object INTERNAL_FIELD (fringe_cursor_alist); |
856c2c73 | 714 | |
82b911fd | 715 | /* Time stamp updated each time this buffer is displayed in a window. */ |
e34f7f79 | 716 | Lisp_Object INTERNAL_FIELD (display_time); |
82b911fd GM |
717 | |
718 | /* If scrolling the display because point is below the bottom of a | |
719 | window showing this buffer, try to choose a window start so | |
720 | that point ends up this number of lines from the top of the | |
721 | window. Nil means that scrolling method isn't used. */ | |
e34f7f79 | 722 | Lisp_Object INTERNAL_FIELD (scroll_up_aggressively); |
177c0ea7 | 723 | |
82b911fd GM |
724 | /* If scrolling the display because point is above the top of a |
725 | window showing this buffer, try to choose a window start so | |
726 | that point ends up this number of lines from the bottom of the | |
727 | window. Nil means that scrolling method isn't used. */ | |
e34f7f79 | 728 | Lisp_Object INTERNAL_FIELD (scroll_down_aggressively); |
2d8c80b1 | 729 | |
82b911fd GM |
730 | /* Desired cursor type in this buffer. See the doc string of |
731 | per-buffer variable `cursor-type'. */ | |
e34f7f79 | 732 | Lisp_Object INTERNAL_FIELD (cursor_type); |
82b911fd GM |
733 | |
734 | /* An integer > 0 means put that number of pixels below text lines | |
735 | in the display of this buffer. */ | |
e34f7f79 | 736 | Lisp_Object INTERNAL_FIELD (extra_line_spacing); |
55806be1 | 737 | |
36429c89 | 738 | /* Cursor type to display in non-selected windows. |
55806be1 RS |
739 | t means to use hollow box cursor. |
740 | See `cursor-type' for other values. */ | |
e34f7f79 | 741 | Lisp_Object INTERNAL_FIELD (cursor_in_non_selected_windows); |
22b4128e | 742 | |
36429c89 DA |
743 | /* No more Lisp_Object beyond this point. Except undo_list, |
744 | which is handled specially in Fgarbage_collect . */ | |
745 | ||
746 | /* This structure holds the coordinates of the buffer contents | |
747 | in ordinary buffers. In indirect buffers, this is not used. */ | |
748 | struct buffer_text own_text; | |
749 | ||
750 | /* This points to the `struct buffer_text' that used for this buffer. | |
751 | In an ordinary buffer, this is the own_text field above. | |
752 | In an indirect buffer, this is the own_text field of another buffer. */ | |
753 | struct buffer_text *text; | |
754 | ||
914adc42 DA |
755 | /* Next buffer, in chain of all buffers, including killed ones. */ |
756 | struct buffer *next; | |
757 | ||
36429c89 DA |
758 | /* Char position of point in buffer. */ |
759 | ptrdiff_t pt; | |
760 | ||
761 | /* Byte position of point in buffer. */ | |
762 | ptrdiff_t pt_byte; | |
763 | ||
764 | /* Char position of beginning of accessible range. */ | |
765 | ptrdiff_t begv; | |
766 | ||
767 | /* Byte position of beginning of accessible range. */ | |
768 | ptrdiff_t begv_byte; | |
769 | ||
770 | /* Char position of end of accessible range. */ | |
771 | ptrdiff_t zv; | |
772 | ||
773 | /* Byte position of end of accessible range. */ | |
774 | ptrdiff_t zv_byte; | |
775 | ||
776 | /* In an indirect buffer, this points to the base buffer. | |
777 | In an ordinary buffer, it is 0. */ | |
778 | struct buffer *base_buffer; | |
779 | ||
98a07056 | 780 | /* In an indirect buffer, this is -1. In an ordinary buffer, |
fb9ea40f | 781 | it's the number of indirect buffers that share our text; |
9928463d | 782 | zero means that we're the only owner of this text. */ |
cbcc7007 | 783 | int indirections; |
9928463d | 784 | |
98a07056 DA |
785 | /* Number of windows showing this buffer. Always -1 for |
786 | an indirect buffer since it counts as its base buffer. */ | |
787 | int window_count; | |
788 | ||
36429c89 DA |
789 | /* A non-zero value in slot IDX means that per-buffer variable |
790 | with index IDX has a local value in this buffer. The index IDX | |
791 | for a buffer-local variable is stored in that variable's slot | |
792 | in buffer_local_flags as a Lisp integer. If the index is -1, | |
793 | this means the variable is always local in all buffers. */ | |
794 | #define MAX_PER_BUFFER_VARS 50 | |
795 | char local_flags[MAX_PER_BUFFER_VARS]; | |
796 | ||
797 | /* Set to the modtime of the visited file when read or written. | |
43aac990 PE |
798 | modtime.tv_nsec == NONEXISTENT_MODTIME_NSECS means |
799 | visited file was nonexistent. modtime.tv_nsec == | |
36429c89 DA |
800 | UNKNOWN_MODTIME_NSECS means visited file modtime unknown; |
801 | in no case complain about any mismatch on next save attempt. */ | |
802 | #define NONEXISTENT_MODTIME_NSECS (-1) | |
803 | #define UNKNOWN_MODTIME_NSECS (-2) | |
43aac990 | 804 | struct timespec modtime; |
36429c89 DA |
805 | |
806 | /* Size of the file when modtime was set. This is used to detect the | |
807 | case where the file grew while we were reading it, so the modtime | |
808 | is still the same (since it's rounded up to seconds) but we're actually | |
809 | not up-to-date. -1 means the size is unknown. Only meaningful if | |
810 | modtime is actually set. */ | |
811 | off_t modtime_size; | |
812 | ||
813 | /* The value of text->modiff at the last auto-save. */ | |
814 | EMACS_INT auto_save_modified; | |
815 | ||
816 | /* The value of text->modiff at the last display error. | |
817 | Redisplay of this buffer is inhibited until it changes again. */ | |
818 | EMACS_INT display_error_modiff; | |
819 | ||
820 | /* The time at which we detected a failure to auto-save, | |
821 | Or 0 if we didn't have a failure. */ | |
822 | time_t auto_save_failure_time; | |
823 | ||
824 | /* Position in buffer at which display started | |
825 | the last time this buffer was displayed. */ | |
826 | ptrdiff_t last_window_start; | |
827 | ||
828 | /* If the long line scan cache is enabled (i.e. the buffer-local | |
829 | variable cache-long-line-scans is non-nil), newline_cache | |
830 | points to the newline cache, and width_run_cache points to the | |
831 | width run cache. | |
832 | ||
833 | The newline cache records which stretches of the buffer are | |
834 | known *not* to contain newlines, so that they can be skipped | |
835 | quickly when we search for newlines. | |
836 | ||
837 | The width run cache records which stretches of the buffer are | |
838 | known to contain characters whose widths are all the same. If | |
839 | the width run cache maps a character to a value > 0, that value is | |
840 | the character's width; if it maps a character to zero, we don't | |
841 | know what its width is. This allows compute_motion to process | |
842 | such regions very quickly, using algebra instead of inspecting | |
e30b79c1 DA |
843 | each character. See also width_table, below. |
844 | ||
845 | The latter cache is used to speedup bidi_find_paragraph_start. */ | |
36429c89 DA |
846 | struct region_cache *newline_cache; |
847 | struct region_cache *width_run_cache; | |
e30b79c1 | 848 | struct region_cache *bidi_paragraph_cache; |
36429c89 DA |
849 | |
850 | /* Non-zero means don't use redisplay optimizations for | |
851 | displaying this buffer. */ | |
655ab9a3 | 852 | bool prevent_redisplay_optimizations_p : 1; |
36429c89 DA |
853 | |
854 | /* Non-zero whenever the narrowing is changed in this buffer. */ | |
655ab9a3 | 855 | bool clip_changed : 1; |
36429c89 DA |
856 | |
857 | /* List of overlays that end at or before the current center, | |
858 | in order of end-position. */ | |
859 | struct Lisp_Overlay *overlays_before; | |
860 | ||
861 | /* List of overlays that end after the current center, | |
862 | in order of start-position. */ | |
863 | struct Lisp_Overlay *overlays_after; | |
864 | ||
865 | /* Position where the overlay lists are centered. */ | |
866 | ptrdiff_t overlay_center; | |
867 | ||
868 | /* Changes in the buffer are recorded here for undo, and t means | |
869 | don't record anything. This information belongs to the base | |
870 | buffer of an indirect buffer. But we can't store it in the | |
871 | struct buffer_text because local variables have to be right in | |
872 | the struct buffer. So we copy it around in set_buffer_internal. */ | |
e34f7f79 | 873 | Lisp_Object INTERNAL_FIELD (undo_list); |
82b911fd | 874 | }; |
a698b358 | 875 | |
39eb03f1 | 876 | /* Most code should use these functions to set Lisp fields in struct |
d1389828 | 877 | buffer. (Some setters that are private to a single .c file are |
080db47f | 878 | defined as static in those files.) */ |
00382e8b | 879 | INLINE void |
39eb03f1 PE |
880 | bset_bidi_paragraph_direction (struct buffer *b, Lisp_Object val) |
881 | { | |
882 | b->INTERNAL_FIELD (bidi_paragraph_direction) = val; | |
883 | } | |
00382e8b | 884 | INLINE void |
080db47f EZ |
885 | bset_cache_long_scans (struct buffer *b, Lisp_Object val) |
886 | { | |
887 | b->INTERNAL_FIELD (cache_long_scans) = val; | |
888 | } | |
889 | INLINE void | |
39eb03f1 PE |
890 | bset_case_canon_table (struct buffer *b, Lisp_Object val) |
891 | { | |
892 | b->INTERNAL_FIELD (case_canon_table) = val; | |
893 | } | |
00382e8b | 894 | INLINE void |
39eb03f1 PE |
895 | bset_case_eqv_table (struct buffer *b, Lisp_Object val) |
896 | { | |
897 | b->INTERNAL_FIELD (case_eqv_table) = val; | |
898 | } | |
00382e8b | 899 | INLINE void |
39eb03f1 PE |
900 | bset_directory (struct buffer *b, Lisp_Object val) |
901 | { | |
902 | b->INTERNAL_FIELD (directory) = val; | |
903 | } | |
00382e8b | 904 | INLINE void |
39eb03f1 PE |
905 | bset_display_count (struct buffer *b, Lisp_Object val) |
906 | { | |
907 | b->INTERNAL_FIELD (display_count) = val; | |
908 | } | |
00382e8b | 909 | INLINE void |
39eb03f1 PE |
910 | bset_display_time (struct buffer *b, Lisp_Object val) |
911 | { | |
912 | b->INTERNAL_FIELD (display_time) = val; | |
913 | } | |
00382e8b | 914 | INLINE void |
39eb03f1 PE |
915 | bset_downcase_table (struct buffer *b, Lisp_Object val) |
916 | { | |
917 | b->INTERNAL_FIELD (downcase_table) = val; | |
918 | } | |
00382e8b | 919 | INLINE void |
39eb03f1 PE |
920 | bset_enable_multibyte_characters (struct buffer *b, Lisp_Object val) |
921 | { | |
922 | b->INTERNAL_FIELD (enable_multibyte_characters) = val; | |
923 | } | |
00382e8b | 924 | INLINE void |
39eb03f1 PE |
925 | bset_filename (struct buffer *b, Lisp_Object val) |
926 | { | |
927 | b->INTERNAL_FIELD (filename) = val; | |
928 | } | |
00382e8b | 929 | INLINE void |
39eb03f1 PE |
930 | bset_keymap (struct buffer *b, Lisp_Object val) |
931 | { | |
932 | b->INTERNAL_FIELD (keymap) = val; | |
933 | } | |
00382e8b | 934 | INLINE void |
39eb03f1 PE |
935 | bset_last_selected_window (struct buffer *b, Lisp_Object val) |
936 | { | |
937 | b->INTERNAL_FIELD (last_selected_window) = val; | |
938 | } | |
00382e8b | 939 | INLINE void |
39eb03f1 PE |
940 | bset_local_var_alist (struct buffer *b, Lisp_Object val) |
941 | { | |
942 | b->INTERNAL_FIELD (local_var_alist) = val; | |
943 | } | |
00382e8b | 944 | INLINE void |
39eb03f1 PE |
945 | bset_mark_active (struct buffer *b, Lisp_Object val) |
946 | { | |
947 | b->INTERNAL_FIELD (mark_active) = val; | |
948 | } | |
00382e8b | 949 | INLINE void |
39eb03f1 PE |
950 | bset_point_before_scroll (struct buffer *b, Lisp_Object val) |
951 | { | |
952 | b->INTERNAL_FIELD (point_before_scroll) = val; | |
953 | } | |
00382e8b | 954 | INLINE void |
39eb03f1 PE |
955 | bset_read_only (struct buffer *b, Lisp_Object val) |
956 | { | |
957 | b->INTERNAL_FIELD (read_only) = val; | |
958 | } | |
00382e8b | 959 | INLINE void |
39eb03f1 PE |
960 | bset_truncate_lines (struct buffer *b, Lisp_Object val) |
961 | { | |
962 | b->INTERNAL_FIELD (truncate_lines) = val; | |
963 | } | |
00382e8b | 964 | INLINE void |
39eb03f1 PE |
965 | bset_undo_list (struct buffer *b, Lisp_Object val) |
966 | { | |
967 | b->INTERNAL_FIELD (undo_list) = val; | |
968 | } | |
00382e8b | 969 | INLINE void |
39eb03f1 PE |
970 | bset_upcase_table (struct buffer *b, Lisp_Object val) |
971 | { | |
972 | b->INTERNAL_FIELD (upcase_table) = val; | |
973 | } | |
00382e8b | 974 | INLINE void |
39eb03f1 PE |
975 | bset_width_table (struct buffer *b, Lisp_Object val) |
976 | { | |
977 | b->INTERNAL_FIELD (width_table) = val; | |
978 | } | |
979 | ||
914adc42 DA |
980 | /* Number of Lisp_Objects at the beginning of struct buffer. |
981 | If you add, remove, or reorder Lisp_Objects within buffer | |
982 | structure, make sure that this is still correct. */ | |
983 | ||
984 | #define BUFFER_LISP_SIZE \ | |
985 | ((offsetof (struct buffer, own_text) - header_size) / word_size) | |
986 | ||
987 | /* Size of the struct buffer part beyond leading Lisp_Objects, in word_size | |
988 | units. Rounding is needed for --with-wide-int configuration. */ | |
989 | ||
990 | #define BUFFER_REST_SIZE \ | |
991 | ((((sizeof (struct buffer) - offsetof (struct buffer, own_text)) \ | |
992 | + (word_size - 1)) & ~(word_size - 1)) / word_size) | |
993 | ||
994 | /* Initialize the pseudovector header of buffer object. BUFFER_LISP_SIZE | |
995 | is required for GC, but BUFFER_REST_SIZE is set up just to be consistent | |
996 | with other pseudovectors. */ | |
997 | ||
998 | #define BUFFER_PVEC_INIT(b) \ | |
999 | XSETPVECTYPESIZE (b, PVEC_BUFFER, BUFFER_LISP_SIZE, BUFFER_REST_SIZE) | |
1000 | ||
e578f381 DA |
1001 | /* Convenient check whether buffer B is live. */ |
1002 | ||
1003 | #define BUFFER_LIVE_P(b) (!NILP (BVAR (b, name))) | |
1004 | ||
ed08365b DA |
1005 | /* Convenient check whether buffer B is hidden (i.e. its name |
1006 | starts with a space). Caller must ensure that B is live. */ | |
1007 | ||
1008 | #define BUFFER_HIDDEN_P(b) (SREF (BVAR (b, name), 0) == ' ') | |
1009 | ||
f0863a54 DA |
1010 | /* Verify indirection counters. */ |
1011 | ||
1012 | #define BUFFER_CHECK_INDIRECTION(b) \ | |
1013 | do { \ | |
1014 | if (BUFFER_LIVE_P (b)) \ | |
0e70695a DA |
1015 | { \ |
1016 | if (b->base_buffer) \ | |
1017 | { \ | |
1018 | eassert (b->indirections == -1); \ | |
1019 | eassert (b->base_buffer->indirections > 0); \ | |
1020 | } \ | |
1021 | else \ | |
1022 | eassert (b->indirections >= 0); \ | |
1023 | } \ | |
f0863a54 DA |
1024 | } while (0) |
1025 | ||
d17337e5 DA |
1026 | /* Chain of all buffers, including killed ones. */ |
1027 | ||
1028 | extern struct buffer *all_buffers; | |
1029 | ||
1030 | /* Used to iterate over the chain above. */ | |
1031 | ||
52b852c7 | 1032 | #define FOR_EACH_BUFFER(b) \ |
914adc42 | 1033 | for ((b) = all_buffers; (b); (b) = (b)->next) |
d17337e5 | 1034 | |
440d350c | 1035 | /* This points to the current buffer. */ |
b3ec245a JB |
1036 | |
1037 | extern struct buffer *current_buffer; | |
1038 | ||
1039 | /* This structure holds the default values of the buffer-local variables | |
440d350c | 1040 | that have special slots in each buffer. |
b3ec245a JB |
1041 | The default value occupies the same slot in this structure |
1042 | as an individual buffer's value occupies in that buffer. | |
1043 | Setting the default value also goes through the alist of buffers | |
1044 | and stores into each buffer that does not say it has a local value. */ | |
1045 | ||
1046 | extern struct buffer buffer_defaults; | |
1047 | ||
1048 | /* This structure marks which slots in a buffer have corresponding | |
1049 | default values in buffer_defaults. | |
1050 | Each such slot has a nonzero value in this structure. | |
1051 | The value has only one nonzero bit. | |
1052 | ||
1053 | When a buffer has its own local value for a slot, | |
979332f6 GM |
1054 | the entry for that slot (found in the same slot in this structure) |
1055 | is turned on in the buffer's local_flags array. | |
b3ec245a JB |
1056 | |
1057 | If a slot in this structure is zero, then even though there may | |
440d350c | 1058 | be a Lisp-level local variable for the slot, it has no default value, |
b3ec245a JB |
1059 | and the corresponding slot in buffer_defaults is not used. */ |
1060 | ||
ce5b453a | 1061 | |
b3ec245a JB |
1062 | extern struct buffer buffer_local_flags; |
1063 | ||
1064 | /* For each buffer slot, this points to the Lisp symbol name | |
1065 | for that slot in the current buffer. It is 0 for slots | |
1066 | that don't have such names. */ | |
1067 | ||
1068 | extern struct buffer buffer_local_symbols; | |
440d350c | 1069 | \f |
383e0970 J |
1070 | extern void delete_all_overlays (struct buffer *); |
1071 | extern void reset_buffer (struct buffer *); | |
37ef52bb | 1072 | extern void compact_buffer (struct buffer *); |
d311d28c | 1073 | extern void evaporate_overlays (ptrdiff_t); |
37ef52bb PE |
1074 | extern ptrdiff_t overlays_at (EMACS_INT, bool, Lisp_Object **, |
1075 | ptrdiff_t *, ptrdiff_t *, ptrdiff_t *, bool); | |
b081724f | 1076 | extern ptrdiff_t sort_overlays (Lisp_Object *, ptrdiff_t, struct window *); |
d311d28c PE |
1077 | extern void recenter_overlay_lists (struct buffer *, ptrdiff_t); |
1078 | extern ptrdiff_t overlay_strings (ptrdiff_t, struct window *, unsigned char **); | |
383e0970 | 1079 | extern void validate_region (Lisp_Object *, Lisp_Object *); |
383e0970 J |
1080 | extern void set_buffer_internal_1 (struct buffer *); |
1081 | extern void set_buffer_temp (struct buffer *); | |
5f2c76c6 | 1082 | extern Lisp_Object buffer_local_value_1 (Lisp_Object, Lisp_Object); |
383e0970 | 1083 | extern void record_buffer (Lisp_Object); |
d311d28c | 1084 | extern void fix_overlays_before (struct buffer *, ptrdiff_t, ptrdiff_t); |
37ef52bb | 1085 | extern void mmap_set_vars (bool); |
27e498e6 PE |
1086 | extern void restore_buffer (Lisp_Object); |
1087 | extern void set_buffer_if_live (Lisp_Object); | |
4b7610a9 | 1088 | |
a3d794a1 DA |
1089 | /* Set the current buffer to B. |
1090 | ||
1091 | We previously set windows_or_buffers_changed here to invalidate | |
1092 | global unchanged information in beg_unchanged and end_unchanged. | |
1093 | This is no longer necessary because we now compute unchanged | |
1094 | information on a buffer-basis. Every action affecting other | |
1095 | windows than the selected one requires a select_window at some | |
1096 | time, and that increments windows_or_buffers_changed. */ | |
1097 | ||
00382e8b | 1098 | INLINE void |
a3d794a1 DA |
1099 | set_buffer_internal (struct buffer *b) |
1100 | { | |
1101 | if (current_buffer != b) | |
1102 | set_buffer_internal_1 (b); | |
1103 | } | |
1104 | ||
66322887 DA |
1105 | /* Arrange to go back to the original buffer after the next |
1106 | call to unbind_to if the original buffer is still alive. */ | |
1107 | ||
00382e8b | 1108 | INLINE void |
66322887 DA |
1109 | record_unwind_current_buffer (void) |
1110 | { | |
1111 | record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ()); | |
1112 | } | |
1113 | ||
002571dd KS |
1114 | /* Get overlays at POSN into array OVERLAYS with NOVERLAYS elements. |
1115 | If NEXTP is non-NULL, return next overlay there. | |
1116 | See overlay_at arg CHANGE_REQ for meaning of CHRQ arg. */ | |
1117 | ||
1118 | #define GET_OVERLAYS_AT(posn, overlays, noverlays, nextp, chrq) \ | |
1119 | do { \ | |
36429c89 | 1120 | ptrdiff_t maxlen = 40; \ |
38182d90 | 1121 | overlays = alloca (maxlen * sizeof *overlays); \ |
002571dd | 1122 | noverlays = overlays_at (posn, 0, &overlays, &maxlen, \ |
36429c89 | 1123 | nextp, NULL, chrq); \ |
002571dd KS |
1124 | if (noverlays > maxlen) \ |
1125 | { \ | |
1126 | maxlen = noverlays; \ | |
38182d90 | 1127 | overlays = alloca (maxlen * sizeof *overlays); \ |
002571dd KS |
1128 | noverlays = overlays_at (posn, 0, &overlays, &maxlen, \ |
1129 | nextp, NULL, chrq); \ | |
1130 | } \ | |
1131 | } while (0) | |
1132 | ||
8f3a2c26 | 1133 | extern Lisp_Object Vbuffer_alist; |
23f73711 RS |
1134 | extern Lisp_Object Qbefore_change_functions; |
1135 | extern Lisp_Object Qafter_change_functions; | |
dbc4e1c1 | 1136 | extern Lisp_Object Qfirst_change_hook; |
8f3a2c26 DA |
1137 | extern Lisp_Object Qpriority, Qbefore_string, Qafter_string; |
1138 | ||
1139 | /* FOR_EACH_LIVE_BUFFER (LIST_VAR, BUF_VAR) followed by a statement is | |
1140 | a `for' loop which iterates over the buffers from Vbuffer_alist. */ | |
1141 | ||
d5a1acfa DA |
1142 | #define FOR_EACH_LIVE_BUFFER(list_var, buf_var) \ |
1143 | FOR_EACH_ALIST_VALUE (Vbuffer_alist, list_var, buf_var) | |
8707c1e5 DA |
1144 | |
1145 | /* Get text properties of B. */ | |
1146 | ||
00382e8b | 1147 | INLINE INTERVAL |
0c94c8d6 | 1148 | buffer_intervals (struct buffer *b) |
8707c1e5 DA |
1149 | { |
1150 | eassert (b->text != NULL); | |
1151 | return b->text->intervals; | |
1152 | } | |
1153 | ||
1154 | /* Set text properties of B to I. */ | |
1155 | ||
00382e8b | 1156 | INLINE void |
0c94c8d6 | 1157 | set_buffer_intervals (struct buffer *b, INTERVAL i) |
8707c1e5 DA |
1158 | { |
1159 | eassert (b->text != NULL); | |
1160 | b->text->intervals = i; | |
1161 | } | |
1162 | ||
fd318b54 DA |
1163 | /* Non-zero if current buffer has overlays. */ |
1164 | ||
00382e8b | 1165 | INLINE bool |
fd318b54 DA |
1166 | buffer_has_overlays (void) |
1167 | { | |
1168 | return current_buffer->overlays_before || current_buffer->overlays_after; | |
1169 | } | |
1170 | ||
e5560ff7 AS |
1171 | /* Return character code of multi-byte form at byte position POS. If POS |
1172 | doesn't point the head of valid multi-byte form, only the byte at | |
1173 | POS is returned. No range checking. | |
b3ec245a | 1174 | |
e5560ff7 AS |
1175 | WARNING: The character returned by this macro could be "unified" |
1176 | inside STRING_CHAR, if the original character in the buffer belongs | |
1177 | to one of the Private Use Areas (PUAs) of codepoints that Emacs | |
1178 | uses to support non-unified CJK characters. If that happens, | |
1179 | CHAR_BYTES will return a value that is different from the length of | |
1180 | the original multibyte sequence stored in the buffer. Therefore, | |
1181 | do _not_ use FETCH_MULTIBYTE_CHAR if you need to advance through | |
1182 | the buffer to the next character after fetching this one. Instead, | |
1183 | use either FETCH_CHAR_ADVANCE or STRING_CHAR_AND_LENGTH. */ | |
1184 | ||
00382e8b | 1185 | INLINE int |
e5560ff7 AS |
1186 | FETCH_MULTIBYTE_CHAR (ptrdiff_t pos) |
1187 | { | |
1188 | unsigned char *p = ((pos >= GPT_BYTE ? GAP_SIZE : 0) | |
1189 | + pos + BEG_ADDR - BEG_BYTE); | |
1190 | return STRING_CHAR (p); | |
1191 | } | |
1192 | ||
1193 | /* Return character code of multi-byte form at byte position POS in BUF. | |
1194 | If POS doesn't point the head of valid multi-byte form, only the byte at | |
1195 | POS is returned. No range checking. */ | |
1196 | ||
00382e8b | 1197 | INLINE int |
e5560ff7 AS |
1198 | BUF_FETCH_MULTIBYTE_CHAR (struct buffer *buf, ptrdiff_t pos) |
1199 | { | |
1200 | unsigned char *p | |
1201 | = ((pos >= BUF_GPT_BYTE (buf) ? BUF_GAP_SIZE (buf) : 0) | |
1202 | + pos + BUF_BEG_ADDR (buf) - BEG_BYTE); | |
1203 | return STRING_CHAR (p); | |
1204 | } | |
98a07056 DA |
1205 | |
1206 | /* Return number of windows showing B. */ | |
1207 | ||
00382e8b | 1208 | INLINE int |
98a07056 DA |
1209 | buffer_window_count (struct buffer *b) |
1210 | { | |
1211 | if (b->base_buffer) | |
1212 | b = b->base_buffer; | |
1213 | eassert (b->window_count >= 0); | |
1214 | return b->window_count; | |
1215 | } | |
1216 | ||
440d350c RS |
1217 | /* Overlays */ |
1218 | ||
440d350c | 1219 | /* Return the marker that stands for where OV starts in the buffer. */ |
a7be34e5 | 1220 | |
c644523b | 1221 | #define OVERLAY_START(OV) XOVERLAY (OV)->start |
b3ec245a | 1222 | |
440d350c | 1223 | /* Return the marker that stands for where OV ends in the buffer. */ |
a7be34e5 | 1224 | |
c644523b | 1225 | #define OVERLAY_END(OV) XOVERLAY (OV)->end |
b3ec245a | 1226 | |
a7be34e5 GM |
1227 | /* Return the plist of overlay OV. */ |
1228 | ||
c644523b | 1229 | #define OVERLAY_PLIST(OV) XOVERLAY (OV)->plist |
a7be34e5 | 1230 | |
d00c875c KH |
1231 | /* Return the actual buffer position for the marker P. |
1232 | We assume you know which buffer it's pointing into. */ | |
b3ec245a | 1233 | |
915857ff | 1234 | #define OVERLAY_POSITION(P) \ |
1088b922 | 1235 | (MARKERP (P) ? marker_position (P) : (emacs_abort (), 0)) |
b3ec245a | 1236 | |
39c75ccb | 1237 | \f |
979332f6 GM |
1238 | /*********************************************************************** |
1239 | Buffer-local Variables | |
1240 | ***********************************************************************/ | |
1241 | ||
1242 | /* Number of per-buffer variables used. */ | |
1243 | ||
ddebaaa9 | 1244 | extern int last_per_buffer_idx; |
979332f6 GM |
1245 | |
1246 | /* Return the offset in bytes of member VAR of struct buffer | |
1247 | from the start of a buffer structure. */ | |
1248 | ||
ddebaaa9 | 1249 | #define PER_BUFFER_VAR_OFFSET(VAR) \ |
e34f7f79 | 1250 | offsetof (struct buffer, INTERNAL_FIELD (VAR)) |
979332f6 | 1251 | |
36429c89 DA |
1252 | /* Used to iterate over normal Lisp_Object fields of struct buffer (all |
1253 | Lisp_Objects except undo_list). If you add, remove, or reorder | |
1254 | Lisp_Objects in a struct buffer, make sure that this is still correct. */ | |
1255 | ||
52b852c7 | 1256 | #define FOR_EACH_PER_BUFFER_OBJECT_AT(offset) \ |
36429c89 DA |
1257 | for (offset = PER_BUFFER_VAR_OFFSET (name); \ |
1258 | offset <= PER_BUFFER_VAR_OFFSET (cursor_in_non_selected_windows); \ | |
663e2b3f | 1259 | offset += word_size) |
36429c89 | 1260 | |
979332f6 GM |
1261 | /* Return the index of buffer-local variable VAR. Each per-buffer |
1262 | variable has an index > 0 associated with it, except when it always | |
1263 | has buffer-local values, in which case the index is -1. If this is | |
1264 | 0, this is a bug and means that the slot of VAR in | |
53964682 | 1265 | buffer_local_flags wasn't initialized. */ |
979332f6 | 1266 | |
ddebaaa9 GM |
1267 | #define PER_BUFFER_VAR_IDX(VAR) \ |
1268 | PER_BUFFER_IDX (PER_BUFFER_VAR_OFFSET (VAR)) | |
979332f6 GM |
1269 | |
1270 | /* Value is non-zero if the variable with index IDX has a local value | |
1271 | in buffer B. */ | |
1272 | ||
ddebaaa9 GM |
1273 | #define PER_BUFFER_VALUE_P(B, IDX) \ |
1274 | (((IDX) < 0 || IDX >= last_per_buffer_idx) \ | |
1088b922 | 1275 | ? (emacs_abort (), 0) \ |
979332f6 GM |
1276 | : ((B)->local_flags[IDX] != 0)) |
1277 | ||
1278 | /* Set whether per-buffer variable with index IDX has a buffer-local | |
1279 | value in buffer B. VAL zero means it hasn't. */ | |
1280 | ||
ddebaaa9 | 1281 | #define SET_PER_BUFFER_VALUE_P(B, IDX, VAL) \ |
979332f6 | 1282 | do { \ |
ddebaaa9 | 1283 | if ((IDX) < 0 || (IDX) >= last_per_buffer_idx) \ |
1088b922 | 1284 | emacs_abort (); \ |
979332f6 GM |
1285 | (B)->local_flags[IDX] = (VAL); \ |
1286 | } while (0) | |
1287 | ||
6b61353c KH |
1288 | /* Return the index value of the per-buffer variable at offset OFFSET |
1289 | in the buffer structure. | |
1290 | ||
1291 | If the slot OFFSET has a corresponding default value in | |
1292 | buffer_defaults, the index value is positive and has only one | |
1293 | nonzero bit. When a buffer has its own local value for a slot, the | |
1294 | bit for that slot (found in the same slot in this structure) is | |
1295 | turned on in the buffer's local_flags array. | |
1296 | ||
1297 | If the index value is -1, even though there may be a | |
1298 | DEFVAR_PER_BUFFER for the slot, there is no default value for it; | |
1299 | and the corresponding slot in buffer_defaults is not used. | |
1300 | ||
1301 | If the index value is -2, then there is no DEFVAR_PER_BUFFER for | |
1302 | the slot, but there is a default value which is copied into each | |
1303 | new buffer. | |
1304 | ||
1305 | If a slot in this structure corresponding to a DEFVAR_PER_BUFFER is | |
1306 | zero, that is a bug */ | |
1307 | ||
979332f6 | 1308 | |
ddebaaa9 | 1309 | #define PER_BUFFER_IDX(OFFSET) \ |
979332f6 GM |
1310 | XINT (*(Lisp_Object *)((OFFSET) + (char *) &buffer_local_flags)) |
1311 | ||
4ce60d2e DA |
1312 | /* Functions to get and set default value of the per-buffer |
1313 | variable at offset OFFSET in the buffer structure. */ | |
979332f6 | 1314 | |
00382e8b | 1315 | INLINE Lisp_Object |
4ce60d2e DA |
1316 | per_buffer_default (int offset) |
1317 | { | |
1318 | return *(Lisp_Object *)(offset + (char *) &buffer_defaults); | |
1319 | } | |
979332f6 | 1320 | |
00382e8b | 1321 | INLINE void |
4ce60d2e DA |
1322 | set_per_buffer_default (int offset, Lisp_Object value) |
1323 | { | |
1324 | *(Lisp_Object *)(offset + (char *) &buffer_defaults) = value; | |
1325 | } | |
1326 | ||
1327 | /* Functions to get and set buffer-local value of the per-buffer | |
1328 | variable at offset OFFSET in the buffer structure. */ | |
1329 | ||
00382e8b | 1330 | INLINE Lisp_Object |
4ce60d2e DA |
1331 | per_buffer_value (struct buffer *b, int offset) |
1332 | { | |
1333 | return *(Lisp_Object *)(offset + (char *) b); | |
1334 | } | |
1335 | ||
00382e8b | 1336 | INLINE void |
4ce60d2e DA |
1337 | set_per_buffer_value (struct buffer *b, int offset, Lisp_Object value) |
1338 | { | |
1339 | *(Lisp_Object *)(offset + (char *) b) = value; | |
1340 | } | |
979332f6 | 1341 | |
5da9919f | 1342 | /* Downcase a character C, or make no change if that cannot be done. */ |
00382e8b | 1343 | INLINE int |
5da9919f | 1344 | downcase (int c) |
15206ed9 | 1345 | { |
5da9919f PE |
1346 | Lisp_Object downcase_table = BVAR (current_buffer, downcase_table); |
1347 | Lisp_Object down = CHAR_TABLE_REF (downcase_table, c); | |
1348 | return NATNUMP (down) ? XFASTINT (down) : c; | |
15206ed9 | 1349 | } |
15206ed9 | 1350 | |
5da9919f | 1351 | /* 1 if C is upper case. */ |
00382e8b | 1352 | INLINE bool uppercasep (int c) { return downcase (c) != c; } |
15206ed9 | 1353 | |
5da9919f | 1354 | /* Upcase a character C known to be not upper case. */ |
00382e8b | 1355 | INLINE int |
5da9919f | 1356 | upcase1 (int c) |
15206ed9 | 1357 | { |
5da9919f PE |
1358 | Lisp_Object upcase_table = BVAR (current_buffer, upcase_table); |
1359 | Lisp_Object up = CHAR_TABLE_REF (upcase_table, c); | |
1360 | return NATNUMP (up) ? XFASTINT (up) : c; | |
15206ed9 | 1361 | } |
5da9919f PE |
1362 | |
1363 | /* 1 if C is lower case. */ | |
00382e8b | 1364 | INLINE bool |
37ef52bb PE |
1365 | lowercasep (int c) |
1366 | { | |
1367 | return !uppercasep (c) && upcase1 (c) != c; | |
1368 | } | |
5da9919f PE |
1369 | |
1370 | /* Upcase a character C, or make no change if that cannot be done. */ | |
00382e8b | 1371 | INLINE int upcase (int c) { return uppercasep (c) ? c : upcase1 (c); } |
f162bcc3 PE |
1372 | |
1373 | INLINE_HEADER_END |