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