Commit | Line | Data |
---|---|---|
b3ec245a | 1 | /* Header file for the buffer manipulation primitives. |
4a2f9c6a | 2 | Copyright (C) 1985, 86, 93, 94, 95, 97, 1998 Free Software Foundation, Inc. |
b3ec245a JB |
3 | |
4 | This file is part of GNU Emacs. | |
5 | ||
6 | GNU Emacs is free software; you can redistribute it and/or modify | |
7 | it under the terms of the GNU General Public License as published by | |
fbfed6f0 | 8 | the Free Software Foundation; either version 2, or (at your option) |
b3ec245a JB |
9 | any later version. |
10 | ||
11 | GNU Emacs is distributed in the hope that it will be useful, | |
12 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | GNU General Public License for more details. | |
15 | ||
16 | You should have received a copy of the GNU General Public License | |
17 | along with GNU Emacs; see the file COPYING. If not, write to | |
3b7ad313 EN |
18 | the Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
19 | Boston, MA 02111-1307, USA. */ | |
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 | |
69f9064e | 27 | /* Position of beginning of buffer. */ |
b3ec245a | 28 | #define BEG (1) |
69f9064e | 29 | #define BEG_BYTE (1) |
b3ec245a | 30 | |
69f9064e | 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 |
b3ec245a | 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 | |
69f9064e | 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 | |
69f9064e | 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 | |
69f9064e | 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 JB |
53 | |
54 | /* Address of beginning of buffer. */ | |
c1ea566e | 55 | #define BEG_ADDR (current_buffer->text->beg) |
b3ec245a JB |
56 | |
57 | /* Address of beginning of accessible range of buffer. */ | |
69f9064e | 58 | #define BEGV_ADDR (BYTE_POS_ADDR (current_buffer->begv_byte)) |
b3ec245a JB |
59 | |
60 | /* Address of point in buffer. */ | |
69f9064e | 61 | #define PT_ADDR (BYTE_POS_ADDR (current_buffer->pt_byte)) |
b3ec245a JB |
62 | |
63 | /* Address of beginning of gap in buffer. */ | |
69f9064e | 64 | #define GPT_ADDR (current_buffer->text->beg + current_buffer->text->gpt_byte - 1) |
b3ec245a JB |
65 | |
66 | /* Address of end of gap in buffer. */ | |
69f9064e | 67 | #define GAP_END_ADDR (current_buffer->text->beg + current_buffer->text->gpt_byte + current_buffer->text->gap_size - 1) |
b3ec245a JB |
68 | |
69 | /* Address of end of accessible range of buffer. */ | |
69f9064e | 70 | #define ZV_ADDR (BYTE_POS_ADDR (current_buffer->zv_byte)) |
96b65d4e KH |
71 | |
72 | /* Address of end of buffer. */ | |
69f9064e | 73 | #define Z_ADDR (current_buffer->text->beg + current_buffer->text->gap_size + current_buffer->text->z_byte - 1) |
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 | ||
84 | /* Overlay modification count. */ | |
85 | #define OVERLAY_MODIFF (current_buffer->text->overlay_modiff) | |
86 | ||
87 | /* Modification count as of last visit or save. */ | |
88 | #define SAVE_MODIFF (current_buffer->text->save_modiff) | |
89 | ||
90 | /* BUFFER_CEILING_OF (resp. BUFFER_FLOOR_OF), when applied to n, return | |
91 | the max (resp. min) p such that | |
92 | ||
93 | BYTE_POS_ADDR (p) - BYTE_POS_ADDR (n) == p - n */ | |
94 | ||
95 | #define BUFFER_CEILING_OF(BYTEPOS) \ | |
96 | (((BYTEPOS) < GPT_BYTE && GPT < ZV ? GPT_BYTE : ZV_BYTE) - 1) | |
97 | #define BUFFER_FLOOR_OF(BYTEPOS) \ | |
98 | (BEGV <= GPT && GPT_BYTE <= (BYTEPOS) ? GPT_BYTE : BEGV_BYTE) | |
99 | \f | |
100 | /* Similar macros to operate on a specified buffer. | |
b3ec245a JB |
101 | Note that many of these evaluate the buffer argument more than once. */ |
102 | ||
69f9064e | 103 | /* Position of beginning of buffer. */ |
b3ec245a | 104 | #define BUF_BEG(buf) (1) |
69f9064e | 105 | #define BUF_BEG_BYTE(buf) (1) |
b3ec245a | 106 | |
69f9064e | 107 | /* Position of beginning of accessible range of buffer. */ |
c1ea566e | 108 | #define BUF_BEGV(buf) ((buf)->begv) |
69f9064e | 109 | #define BUF_BEGV_BYTE(buf) ((buf)->begv_byte) |
b3ec245a | 110 | |
69f9064e | 111 | /* Position of point in buffer. */ |
c1ea566e | 112 | #define BUF_PT(buf) ((buf)->pt) |
69f9064e | 113 | #define BUF_PT_BYTE(buf) ((buf)->pt_byte) |
b3ec245a | 114 | |
69f9064e | 115 | /* Position of gap in buffer. */ |
c1ea566e | 116 | #define BUF_GPT(buf) ((buf)->text->gpt) |
69f9064e | 117 | #define BUF_GPT_BYTE(buf) ((buf)->text->gpt_byte) |
b3ec245a | 118 | |
69f9064e | 119 | /* Position of end of accessible range of buffer. */ |
c1ea566e | 120 | #define BUF_ZV(buf) ((buf)->zv) |
69f9064e | 121 | #define BUF_ZV_BYTE(buf) ((buf)->zv_byte) |
b3ec245a | 122 | |
69f9064e | 123 | /* Position of end of buffer. */ |
c1ea566e | 124 | #define BUF_Z(buf) ((buf)->text->z) |
69f9064e RS |
125 | #define BUF_Z_BYTE(buf) ((buf)->text->z_byte) |
126 | ||
127 | /* Address of beginning of buffer. */ | |
128 | #define BUF_BEG_ADDR(buf) ((buf)->text->beg) | |
129 | ||
130 | /* Address of beginning of gap of buffer. */ | |
131 | #define BUF_GPT_ADDR(buf) ((buf)->text->beg + (buf)->text->gpt_byte - 1) | |
132 | ||
133 | /* Address of end of buffer. */ | |
134 | #define BUF_Z_ADDR(buf) ((buf)->text->beg + (buf)->text->gap_size + (buf)->text->z_byte - 1) | |
135 | ||
136 | /* Address of end of gap in buffer. */ | |
137 | #define BUF_GAP_END_ADDR(buf) ((buf)->text->beg + (buf)->text->gpt_byte + (buf)->text->gap_size - 1) | |
b3ec245a | 138 | |
69f9064e RS |
139 | /* Size of gap. */ |
140 | #define BUF_GAP_SIZE(buf) ((buf)->text->gap_size) | |
141 | ||
142 | /* Is this buffer narrowed? */ | |
c1ea566e RS |
143 | #define BUF_NARROWED(buf) ((BUF_BEGV (buf) != BUF_BEG (buf)) \ |
144 | || (BUF_ZV (buf) != BUF_Z (buf))) | |
e12f3519 | 145 | |
b3ec245a | 146 | /* Modification count. */ |
c1ea566e RS |
147 | #define BUF_MODIFF(buf) ((buf)->text->modiff) |
148 | ||
149 | /* Modification count as of last visit or save. */ | |
150 | #define BUF_SAVE_MODIFF(buf) ((buf)->text->save_modiff) | |
151 | ||
2e50b9cc RS |
152 | /* Overlay modification count. */ |
153 | #define BUF_OVERLAY_MODIFF(buf) ((buf)->text->overlay_modiff) | |
154 | ||
c1ea566e RS |
155 | /* Interval tree of buffer. */ |
156 | #define BUF_INTERVALS(buf) ((buf)->text->intervals) | |
157 | ||
158 | /* Marker chain of buffer. */ | |
159 | #define BUF_MARKERS(buf) ((buf)->text->markers) | |
133a3962 GM |
160 | |
161 | #define BUF_UNCHANGED_MODIFIED(buf) \ | |
162 | ((buf)->text->unchanged_modified) | |
163 | ||
164 | #define BUF_OVERLAY_UNCHANGED_MODIFIED(buf) \ | |
165 | ((buf)->text->overlay_unchanged_modified) | |
166 | #define BUF_BEG_UNCHANGED(buf) ((buf)->text->beg_unchanged) | |
167 | #define BUF_END_UNCHANGED(buf) ((buf)->text->end_unchanged) | |
168 | ||
169 | #define UNCHANGED_MODIFIED \ | |
170 | BUF_UNCHANGED_MODIFIED (current_buffer) | |
171 | #define OVERLAY_UNCHANGED_MODIFIED \ | |
172 | BUF_OVERLAY_UNCHANGED_MODIFIED (current_buffer) | |
173 | #define BEG_UNCHANGED BUF_BEG_UNCHANGED (current_buffer) | |
174 | #define END_UNCHANGED BUF_END_UNCHANGED (current_buffer) | |
175 | ||
176 | /* Compute how many characters at the top and bottom of BUF are | |
177 | unchanged when the range START..END is modified. This computation | |
178 | must be done each time BUF is modified. */ | |
179 | ||
180 | #define BUF_COMPUTE_UNCHANGED(buf, start, end) \ | |
181 | do \ | |
182 | { \ | |
183 | if (BUF_UNCHANGED_MODIFIED (buf) == MODIFF \ | |
184 | && BUF_OVERLAY_UNCHANGED_MODIFIED (buf) == OVERLAY_MODIFF) \ | |
185 | { \ | |
186 | BUF_BEG_UNCHANGED (buf) = (start) - BUF_BEG (buf); \ | |
187 | BUF_END_UNCHANGED (buf) = BUF_Z (buf) - (end); \ | |
188 | } \ | |
189 | else \ | |
190 | { \ | |
191 | if (BUF_Z (buf) - (end) < BUF_END_UNCHANGED (buf)) \ | |
192 | BUF_END_UNCHANGED (buf) = BUF_Z (buf) - (end); \ | |
193 | if ((start) - BUF_BEG (buf) < BUF_BEG_UNCHANGED (buf)) \ | |
194 | BUF_BEG_UNCHANGED (buf) = (start) - BUF_BEG (buf); \ | |
195 | } \ | |
196 | } \ | |
197 | while (0) | |
198 | ||
69f9064e RS |
199 | \f |
200 | /* Macros to set PT in the current buffer, or another buffer.. */ | |
b3ec245a | 201 | |
69f9064e RS |
202 | #ifdef USE_TEXT_PROPERTIES |
203 | #define SET_PT(position) (set_point (current_buffer, (position))) | |
204 | #define TEMP_SET_PT(position) (temp_set_point (current_buffer, (position))) | |
b3ec245a | 205 | |
69f9064e RS |
206 | #define SET_PT_BOTH(position, byte) \ |
207 | (set_point_both (current_buffer, (position), (byte))) | |
208 | #define TEMP_SET_PT_BOTH(position, byte) \ | |
209 | (temp_set_point_both (current_buffer, (position), (byte))) | |
96b65d4e | 210 | |
69f9064e RS |
211 | #define BUF_SET_PT(buffer, position) \ |
212 | (set_point ((buffer), (position))) | |
213 | #define BUF_TEMP_SET_PT(buffer, position) \ | |
214 | (temp_set_point ((buffer), (position))) | |
96b65d4e | 215 | |
69f9064e RS |
216 | extern void set_point P_ ((struct buffer *, int)); |
217 | extern INLINE void temp_set_point P_ ((struct buffer *, int)); | |
218 | extern void set_point_both P_ ((struct buffer *, int, int)); | |
219 | extern INLINE void temp_set_point_both P_ ((struct buffer *, int, int)); | |
b3ec245a | 220 | |
69f9064e RS |
221 | #else /* don't support text properties */ |
222 | ||
223 | #define SET_PT(position) (current_buffer->pt = (position)) | |
224 | #define TEMP_SET_PT(position) (current_buffer->pt = (position)) | |
225 | ||
226 | #define SET_PT_BOTH(position, byte) \ | |
227 | (current_buffer->pt = (position), \ | |
228 | current_buffer->pt_byte = (byte)) | |
229 | ||
230 | #define TEMP_SET_PT_BOTH(position, byte) \ | |
231 | (current_buffer->pt = (position), \ | |
232 | current_buffer->pt_byte = (byte)) | |
233 | ||
234 | #define BUF_SET_PT(buffer, position) (buffer->pt = (position)) | |
235 | #define BUF_TEMP_SET_PT(buffer, position) (buffer->pt = (position)) | |
236 | #endif /* don't support text properties */ | |
237 | \f | |
238 | /* Macros for setting the BEGV, ZV or PT of a given buffer. | |
239 | ||
240 | SET_BUF_PT* seet to be redundant. Get rid of them? | |
241 | ||
242 | The ..._BOTH macros take both a charpos and a bytepos, | |
243 | which must correspond to each other. | |
244 | ||
245 | The macros without ..._BOTH take just a charpos, | |
246 | and compute the bytepos from it. */ | |
b3ec245a | 247 | |
69f9064e RS |
248 | #define SET_BUF_BEGV(buf, charpos) \ |
249 | ((buf)->begv_byte = buf_charpos_to_bytepos ((buf), (charpos)), \ | |
250 | (buf)->begv = (charpos)) | |
251 | ||
252 | #define SET_BUF_ZV(buf, charpos) \ | |
253 | ((buf)->zv_byte = buf_charpos_to_bytepos ((buf), (charpos)), \ | |
254 | (buf)->zv = (charpos)) | |
255 | ||
256 | #define SET_BUF_BEGV_BOTH(buf, charpos, byte) \ | |
257 | ((buf)->begv = (charpos), \ | |
258 | (buf)->begv_byte = (byte)) | |
259 | ||
260 | #define SET_BUF_ZV_BOTH(buf, charpos, byte) \ | |
261 | ((buf)->zv = (charpos), \ | |
262 | (buf)->zv_byte = (byte)) | |
263 | ||
264 | #define SET_BUF_PT_BOTH(buf, charpos, byte) \ | |
265 | ((buf)->pt = (charpos), \ | |
266 | (buf)->pt_byte = (byte)) | |
267 | \f | |
268 | /* Macros to access a character or byte in the current buffer, | |
269 | or convert between a byte position and an address. | |
270 | These macros do not check that the position is in range. */ | |
271 | ||
272 | /* Access a Lisp position value in POS, | |
273 | and store the charpos in CHARPOS and the bypepos in BYPEPOS. */ | |
274 | ||
275 | #define DECODE_POSITION(charpos, bytepos, pos) \ | |
276 | if (1) \ | |
277 | { \ | |
278 | Lisp_Object __pos = (pos); \ | |
279 | if (NUMBERP (__pos)) \ | |
280 | { \ | |
281 | charpos = __pos; \ | |
282 | bytepos = buf_charpos_to_bytepos (current_buffer, __pos); \ | |
283 | } \ | |
284 | else if (MARKERP (__pos)) \ | |
285 | { \ | |
286 | charpos = marker_position (__pos); \ | |
287 | bytepos = marker_byte_position (__pos); \ | |
288 | } \ | |
289 | else \ | |
290 | wrong_type_argument (Qinteger_or_marker_p, __pos); \ | |
291 | } \ | |
292 | else | |
293 | ||
294 | /* Return the address of byte position N in current buffer. */ | |
295 | ||
296 | #define BYTE_POS_ADDR(n) \ | |
297 | (((n) >= GPT_BYTE ? GAP_SIZE : 0) + (n) + BEG_ADDR - 1) | |
298 | ||
299 | /* Return the address of char position N. */ | |
300 | ||
301 | #define CHAR_POS_ADDR(n) \ | |
302 | (((n) >= GPT ? GAP_SIZE : 0) \ | |
303 | + buf_charpos_to_bytepos (current_buffer, n) \ | |
304 | + BEG_ADDR - 1) | |
305 | ||
306 | /* Convert a character position to a byte position. */ | |
307 | ||
308 | #define CHAR_TO_BYTE(charpos) \ | |
309 | (buf_charpos_to_bytepos (current_buffer, charpos)) | |
310 | ||
311 | /* Convert a byte position to a character position. */ | |
312 | ||
313 | #define BYTE_TO_CHAR(bytepos) \ | |
314 | (buf_bytepos_to_charpos (current_buffer, bytepos)) | |
315 | ||
316 | /* Convert PTR, the address of a byte in the buffer, into a byte position. */ | |
317 | ||
318 | #define PTR_BYTE_POS(ptr) \ | |
319 | ((ptr) - (current_buffer)->text->beg \ | |
320 | - (ptr - (current_buffer)->text->beg < (unsigned) GPT_BYTE ? 0 : GAP_SIZE) \ | |
321 | + 1) | |
322 | ||
323 | /* Return character at position POS. */ | |
324 | ||
325 | #define FETCH_CHAR(pos) \ | |
326 | (!NILP (current_buffer->enable_multibyte_characters) \ | |
327 | ? FETCH_MULTIBYTE_CHAR ((pos)) \ | |
328 | : FETCH_BYTE ((pos))) | |
329 | ||
330 | /* Return the byte at byte position N. */ | |
331 | ||
332 | #define FETCH_BYTE(n) *(BYTE_POS_ADDR ((n))) | |
333 | ||
334 | /* Variables used locally in FETCH_MULTIBYTE_CHAR. */ | |
335 | extern unsigned char *_fetch_multibyte_char_p; | |
336 | extern int _fetch_multibyte_char_len; | |
337 | ||
338 | /* Return character code of multi-byte form at position POS. If POS | |
339 | doesn't point the head of valid multi-byte form, only the byte at | |
340 | POS is returned. No range checking. */ | |
341 | ||
342 | #define FETCH_MULTIBYTE_CHAR(pos) \ | |
343 | (_fetch_multibyte_char_p = (((pos) >= GPT_BYTE ? GAP_SIZE : 0) \ | |
344 | + (pos) + BEG_ADDR - 1), \ | |
345 | _fetch_multibyte_char_len \ | |
346 | = ((pos) >= GPT_BYTE ? ZV_BYTE : GPT_BYTE) - (pos), \ | |
347 | STRING_CHAR (_fetch_multibyte_char_p, _fetch_multibyte_char_len)) | |
348 | \f | |
349 | /* Macros for accessing a character or byte, | |
350 | or converting between byte positions and addresses, | |
351 | in a specified buffer. */ | |
352 | ||
353 | /* Return the address of character at byte position POS in buffer BUF. | |
b3ec245a | 354 | Note that both arguments can be computed more than once. */ |
69f9064e RS |
355 | |
356 | #define BUF_BYTE_ADDRESS(buf, pos) \ | |
c1ea566e | 357 | ((buf)->text->beg + (pos) - 1 \ |
69f9064e RS |
358 | + ((pos) >= (buf)->text->gpt_byte ? (buf)->text->gap_size : 0)) |
359 | ||
360 | /* Return the address of character at char position POS in buffer BUF. | |
361 | Note that both arguments can be computed more than once. */ | |
362 | ||
363 | #define BUF_CHAR_ADDRESS(buf, pos) \ | |
364 | ((buf)->text->beg + buf_charpos_to_bytepos ((buf), (pos)) - 1 \ | |
c1ea566e | 365 | + ((pos) >= (buf)->text->gpt ? (buf)->text->gap_size : 0)) |
b3ec245a | 366 | |
69f9064e RS |
367 | /* Convert PTR, the address of a char in buffer BUF, |
368 | into a character position. */ | |
790f39e7 | 369 | |
69f9064e RS |
370 | #define BUF_PTR_BYTE_POS(buf, ptr) \ |
371 | ((ptr) - (buf)->text->beg \ | |
372 | - (ptr - (buf)->text->beg < (unsigned) BUF_GPT_BYTE ((buf)) \ | |
373 | ? 0 : BUF_GAP_SIZE ((buf))) \ | |
790f39e7 | 374 | + 1) |
69f9064e RS |
375 | |
376 | /* Return the character at byte position POS in buffer BUF. */ | |
377 | ||
378 | #define BUF_FETCH_CHAR(buf, pos) \ | |
379 | (!NILP (buf->enable_multibyte_characters) \ | |
380 | ? BUF_FETCH_MULTIBYTE_CHAR ((buf), (pos)) \ | |
381 | : BUF_FETCH_BYTE ((buf), (pos))) | |
382 | ||
383 | /* Return the byte at byte position N in buffer BUF. */ | |
384 | ||
385 | #define BUF_FETCH_BYTE(buf, n) \ | |
386 | *(BUF_BYTE_ADDRESS ((buf), (n))) | |
387 | ||
388 | /* Return character code of multi-byte form at byte position POS in BUF. | |
389 | If POS doesn't point the head of valid multi-byte form, only the byte at | |
390 | POS is returned. No range checking. */ | |
391 | ||
392 | #define BUF_FETCH_MULTIBYTE_CHAR(buf, pos) \ | |
393 | (_fetch_multibyte_char_p \ | |
394 | = (((pos) >= BUF_GPT_BYTE (buf) ? BUF_GAP_SIZE (buf) : 0) \ | |
395 | + (pos) + BUF_BEG_ADDR (buf) - 1), \ | |
396 | _fetch_multibyte_char_len \ | |
397 | = (((pos) >= BUF_GPT_BYTE (buf) ? BUF_ZV_BYTE (buf) : BUF_GPT_BYTE (buf)) \ | |
398 | - (pos)), \ | |
399 | STRING_CHAR (_fetch_multibyte_char_p, _fetch_multibyte_char_len)) | |
b3ec245a | 400 | \f |
69f9064e RS |
401 | /* Define the actual buffer data structures. */ |
402 | ||
403 | /* This data structure describes the actual text contents of a buffer. | |
404 | It is shared between indirect buffers and their base buffer. */ | |
405 | ||
b3ec245a JB |
406 | struct buffer_text |
407 | { | |
c1ea566e | 408 | unsigned char *beg; /* Actual address of buffer contents. */ |
69f9064e RS |
409 | int gpt; /* Char pos of gap in buffer. */ |
410 | int z; /* Char pos of end of buffer. */ | |
411 | int gpt_byte; /* Byte pos of gap in buffer. */ | |
412 | int z_byte; /* Byte pos of end of buffer. */ | |
c1ea566e | 413 | int gap_size; /* Size of buffer's gap. */ |
b3ec245a JB |
414 | int modiff; /* This counts buffer-modification events |
415 | for this buffer. It is incremented for | |
416 | each such event, and never otherwise | |
417 | changed. */ | |
c1ea566e RS |
418 | int save_modiff; /* Previous value of modiff, as of last |
419 | time buffer visited or saved a file. */ | |
420 | ||
2e50b9cc RS |
421 | int overlay_modiff; /* Counts modifications to overlays. */ |
422 | ||
133a3962 GM |
423 | /* Minimum value of GPT - BEG since last redisplay that finished. */ |
424 | int beg_unchanged; | |
425 | ||
426 | /* Minimum value of Z - GPT since last redisplay that finished. */ | |
427 | int end_unchanged; | |
428 | ||
429 | /* MODIFF as of last redisplay that finished; if it matches MODIFF, | |
430 | beg_unchanged and end_unchanged contain no useful information. */ | |
431 | int unchanged_modified; | |
432 | ||
433 | /* BUF_OVERLAY_MODIFF of current buffer, as of last redisplay that | |
434 | finished; if it matches BUF_OVERLAY_MODIFF, beg_unchanged and | |
435 | end_unchanged contain no useful information. */ | |
436 | int overlay_unchanged_modified; | |
437 | ||
c1ea566e RS |
438 | /* Properties of this buffer's text -- conditionally compiled. */ |
439 | DECLARE_INTERVALS | |
440 | ||
441 | /* The markers that refer to this buffer. | |
442 | This is actually a single marker --- | |
443 | successive elements in its marker `chain' | |
444 | are the other markers referring to this buffer. */ | |
445 | Lisp_Object markers; | |
b3ec245a JB |
446 | }; |
447 | ||
69f9064e RS |
448 | /* This is the structure that the buffer Lisp object points to. */ |
449 | ||
b3ec245a JB |
450 | struct buffer |
451 | { | |
452 | /* Everything before the `name' slot must be of a non-Lisp_Object type, | |
453 | and every slot after `name' must be a Lisp_Object. | |
454 | ||
c1ea566e RS |
455 | Check out mark_buffer (alloc.c) to see why. */ |
456 | ||
457 | EMACS_INT size; | |
b3ec245a | 458 | |
b3ec245a JB |
459 | /* Next buffer, in chain of all buffers including killed buffers. |
460 | This chain is used only for garbage collection, in order to | |
c1ea566e RS |
461 | collect killed buffers properly. |
462 | Note that vectors and most pseudovectors are all on one chain, | |
463 | but buffers are on a separate chain of their own. */ | |
b3ec245a | 464 | struct buffer *next; |
c1ea566e RS |
465 | |
466 | /* This structure holds the coordinates of the buffer contents | |
467 | in ordinary buffers. In indirect buffers, this is not used. */ | |
468 | struct buffer_text own_text; | |
469 | ||
470 | /* This points to the `struct buffer_text' that used for this buffer. | |
471 | In an ordinary buffer, this is the own_text field above. | |
472 | In an indirect buffer, this is the own_text field of another buffer. */ | |
473 | struct buffer_text *text; | |
474 | ||
69f9064e | 475 | /* Char position of point in buffer. */ |
c1ea566e | 476 | int pt; |
69f9064e RS |
477 | /* Byte position of point in buffer. */ |
478 | int pt_byte; | |
479 | /* Char position of beginning of accessible range. */ | |
c1ea566e | 480 | int begv; |
69f9064e RS |
481 | /* Byte position of beginning of accessible range. */ |
482 | int begv_byte; | |
483 | /* Char position of end of accessible range. */ | |
c1ea566e | 484 | int zv; |
69f9064e RS |
485 | /* Byte position of end of accessible range. */ |
486 | int zv_byte; | |
c1ea566e RS |
487 | |
488 | /* In an indirect buffer, this points to the base buffer. | |
489 | In an ordinary buffer, it is 0. */ | |
490 | struct buffer *base_buffer; | |
491 | ||
b3ec245a JB |
492 | /* Flags saying which DEFVAR_PER_BUFFER variables |
493 | are local to this buffer. */ | |
494 | int local_var_flags; | |
b3ec245a JB |
495 | /* Set to the modtime of the visited file when read or written. |
496 | -1 means visited file was nonexistent. | |
497 | 0 means visited file modtime unknown; in no case complain | |
498 | about any mismatch on next save attempt. */ | |
499 | int modtime; | |
c1ea566e | 500 | /* the value of text->modiff at the last auto-save. */ |
b3ec245a | 501 | int auto_save_modified; |
4c0dc722 RS |
502 | /* The time at which we detected a failure to auto-save, |
503 | Or -1 if we didn't have a failure. */ | |
504 | int auto_save_failure_time; | |
b3ec245a | 505 | /* Position in buffer at which display started |
c1ea566e | 506 | the last time this buffer was displayed. */ |
b3ec245a JB |
507 | int last_window_start; |
508 | ||
715bde06 RS |
509 | /* Set nonzero whenever the narrowing is changed in this buffer. */ |
510 | int clip_changed; | |
511 | ||
18e93755 JB |
512 | /* If the long line scan cache is enabled (i.e. the buffer-local |
513 | variable cache-long-line-scans is non-nil), newline_cache | |
514 | points to the newline cache, and width_run_cache points to the | |
515 | width run cache. | |
516 | ||
517 | The newline cache records which stretches of the buffer are | |
518 | known *not* to contain newlines, so that they can be skipped | |
519 | quickly when we search for newlines. | |
520 | ||
521 | The width run cache records which stretches of the buffer are | |
522 | known to contain characters whose widths are all the same. If | |
523 | the width run cache maps a character to a value > 0, that value is | |
524 | the character's width; if it maps a character to zero, we don't | |
525 | know what its width is. This allows compute_motion to process | |
526 | such regions very quickly, using algebra instead of inspecting | |
527 | each character. See also width_table, below. */ | |
528 | struct region_cache *newline_cache; | |
529 | struct region_cache *width_run_cache; | |
b3ec245a | 530 | |
133a3962 GM |
531 | /* Non-zero means don't use redisplay optimizations for |
532 | displaying this buffer. */ | |
533 | unsigned prevent_redisplay_optimizations_p : 1; | |
534 | ||
b50f6283 RS |
535 | /* Changes in the buffer are recorded here for undo. |
536 | t means don't record anything. | |
537 | This information belongs to the base buffer of an indirect buffer, | |
538 | But we can't store it in the struct buffer_text | |
539 | because local variables have to be right in the struct buffer. | |
540 | So we copy it around in set_buffer_internal. | |
541 | This comes before `name' because it is marked in a special way. */ | |
542 | Lisp_Object undo_list; | |
543 | ||
b3ec245a JB |
544 | /* Everything from here down must be a Lisp_Object */ |
545 | ||
c1ea566e | 546 | /* The name of this buffer. */ |
b3ec245a | 547 | Lisp_Object name; |
2d8c80b1 | 548 | |
4f13cc99 GM |
549 | /* Length in characters of the prompt in a mini-buffer, or nil if |
550 | this buffer is not a mini-buffer. */ | |
2d8c80b1 | 551 | Lisp_Object minibuffer_prompt_length; |
2d8c80b1 | 552 | |
c1ea566e | 553 | /* The name of the file visited in this buffer, or nil. */ |
b3ec245a | 554 | Lisp_Object filename; |
c1ea566e | 555 | /* Dir for expanding relative file names. */ |
b3ec245a | 556 | Lisp_Object directory; |
c1ea566e RS |
557 | /* True iff this buffer has been backed up (if you write to the |
558 | visited file and it hasn't been backed up, then a backup will | |
559 | be made). */ | |
b3ec245a JB |
560 | /* This isn't really used by the C code, so could be deleted. */ |
561 | Lisp_Object backed_up; | |
c1ea566e RS |
562 | /* Length of file when last read or saved. |
563 | This is not in the struct buffer_text | |
564 | because it's not used in indirect buffers at all. */ | |
b3ec245a | 565 | Lisp_Object save_length; |
c1ea566e RS |
566 | /* File name used for auto-saving this buffer. |
567 | This is not in the struct buffer_text | |
568 | because it's not used in indirect buffers at all. */ | |
b3ec245a | 569 | Lisp_Object auto_save_file_name; |
c1ea566e RS |
570 | |
571 | /* Non-nil if buffer read-only. */ | |
b3ec245a | 572 | Lisp_Object read_only; |
c1ea566e RS |
573 | /* "The mark". This is a marker which may |
574 | point into this buffer or may point nowhere. */ | |
b3ec245a JB |
575 | Lisp_Object mark; |
576 | ||
577 | /* Alist of elements (SYMBOL . VALUE-IN-THIS-BUFFER) | |
578 | for all per-buffer variables of this buffer. */ | |
579 | Lisp_Object local_var_alist; | |
580 | ||
c1ea566e | 581 | /* Symbol naming major mode (eg, lisp-mode). */ |
b3ec245a | 582 | Lisp_Object major_mode; |
c1ea566e | 583 | /* Pretty name of major mode (eg, "Lisp"). */ |
b3ec245a | 584 | Lisp_Object mode_name; |
c1ea566e | 585 | /* Mode line element that controls format of mode line. */ |
b3ec245a | 586 | Lisp_Object mode_line_format; |
2d8c80b1 GM |
587 | |
588 | /* Analogous to mode_line_format for the line displayed at the top | |
589 | of windows. Nil means don't display that line. */ | |
045dee35 | 590 | Lisp_Object header_line_format; |
b3ec245a | 591 | |
c1ea566e | 592 | /* Keys that are bound local to this buffer. */ |
b3ec245a | 593 | Lisp_Object keymap; |
c1ea566e | 594 | /* This buffer's local abbrev table. */ |
b3ec245a | 595 | Lisp_Object abbrev_table; |
c1ea566e | 596 | /* This buffer's syntax table. */ |
b3ec245a | 597 | Lisp_Object syntax_table; |
96b65d4e KH |
598 | /* This buffer's category table. */ |
599 | Lisp_Object category_table; | |
b3ec245a JB |
600 | |
601 | /* Values of several buffer-local variables */ | |
602 | /* tab-width is buffer-local so that redisplay can find it | |
603 | in buffers that are not current */ | |
604 | Lisp_Object case_fold_search; | |
605 | Lisp_Object tab_width; | |
606 | Lisp_Object fill_column; | |
607 | Lisp_Object left_margin; | |
c1ea566e | 608 | /* Function to call when insert space past fill column. */ |
b3ec245a | 609 | Lisp_Object auto_fill_function; |
c1ea566e RS |
610 | /* nil: text, t: binary. |
611 | This value is meaningful only on certain operating systems. */ | |
96b65d4e KH |
612 | /* Actually, we don't need this flag any more because end-of-line |
613 | is handled correctly according to the buffer-file-coding-system | |
614 | of the buffer. Just keeping it for backward compatibility. */ | |
54ad07d3 | 615 | Lisp_Object buffer_file_type; |
b3ec245a | 616 | |
f392937f RS |
617 | /* Case table for case-conversion in this buffer. |
618 | This char-table maps each char into its lower-case version. */ | |
b3ec245a | 619 | Lisp_Object downcase_table; |
f392937f | 620 | /* Char-table mapping each char to its upper-case version. */ |
b3ec245a | 621 | Lisp_Object upcase_table; |
f392937f | 622 | /* Char-table for conversion for case-folding search. */ |
c1ea566e | 623 | Lisp_Object case_canon_table; |
f392937f | 624 | /* Char-table of equivalences for case-folding search. */ |
c1ea566e | 625 | Lisp_Object case_eqv_table; |
b3ec245a | 626 | |
c1ea566e | 627 | /* Non-nil means do not display continuation lines. */ |
b3ec245a | 628 | Lisp_Object truncate_lines; |
c1ea566e | 629 | /* Non-nil means display ctl chars with uparrow. */ |
b3ec245a | 630 | Lisp_Object ctl_arrow; |
96b65d4e KH |
631 | /* Non-nil means display text from right to left. */ |
632 | Lisp_Object direction_reversed; | |
b3ec245a | 633 | /* Non-nil means do selective display; |
c1ea566e | 634 | see doc string in syms_of_buffer (buffer.c) for details. */ |
b3ec245a JB |
635 | Lisp_Object selective_display; |
636 | #ifndef old | |
637 | /* Non-nil means show ... at end of line followed by invisible lines. */ | |
638 | Lisp_Object selective_display_ellipses; | |
639 | #endif | |
c1ea566e | 640 | /* Alist of (FUNCTION . STRING) for each minor mode enabled in buffer. */ |
b3ec245a | 641 | Lisp_Object minor_modes; |
6bbb0d4a JB |
642 | /* t if "self-insertion" should overwrite; `binary' if it should also |
643 | overwrite newlines and tabs - for editing executables and the like. */ | |
b3ec245a | 644 | Lisp_Object overwrite_mode; |
c1ea566e | 645 | /* non-nil means abbrev mode is on. Expand abbrevs automatically. */ |
b3ec245a | 646 | Lisp_Object abbrev_mode; |
c1ea566e | 647 | /* Display table to use for text in this buffer. */ |
b3ec245a | 648 | Lisp_Object display_table; |
83ec8b67 RS |
649 | /* t means the mark and region are currently active. */ |
650 | Lisp_Object mark_active; | |
b3ec245a | 651 | |
440d350c RS |
652 | /* List of overlays that end at or before the current center, |
653 | in order of end-position. */ | |
654 | Lisp_Object overlays_before; | |
655 | ||
656 | /* List of overlays that end after the current center, | |
657 | in order of start-position. */ | |
658 | Lisp_Object overlays_after; | |
659 | ||
660 | /* Position where the overlay lists are centered. */ | |
661 | Lisp_Object overlay_center; | |
18e93755 | 662 | |
96b65d4e KH |
663 | /* Non-nil means the buffer contents are regarded as multi-byte |
664 | form of characters, not a binary code. */ | |
665 | Lisp_Object enable_multibyte_characters; | |
666 | ||
c204d14f KH |
667 | /* Coding system to be used for encoding the buffer contents on |
668 | saving. */ | |
669 | Lisp_Object buffer_file_coding_system; | |
670 | ||
2d2972d8 | 671 | /* List of symbols naming the file format used for visited file. */ |
585b0a89 BG |
672 | Lisp_Object file_format; |
673 | ||
18e93755 JB |
674 | /* True if the newline position cache and width run cache are |
675 | enabled. See search.c and indent.c. */ | |
676 | Lisp_Object cache_long_line_scans; | |
677 | ||
678 | /* If the width run cache is enabled, this table contains the | |
679 | character widths width_run_cache (see above) assumes. When we | |
680 | do a thorough redisplay, we compare this against the buffer's | |
681 | current display table to see whether the display table has | |
682 | affected the widths of any characters. If it has, we | |
c1ea566e | 683 | invalidate the width run cache, and re-initialize width_table. */ |
18e93755 | 684 | Lisp_Object width_table; |
c1ea566e RS |
685 | |
686 | /* In an indirect buffer, or a buffer that is the base of an | |
687 | indirect buffer, this holds a marker that records | |
688 | PT for this buffer when the buffer is not current. */ | |
689 | Lisp_Object pt_marker; | |
690 | ||
691 | /* In an indirect buffer, or a buffer that is the base of an | |
692 | indirect buffer, this holds a marker that records | |
693 | BEGV for this buffer when the buffer is not current. */ | |
694 | Lisp_Object begv_marker; | |
695 | ||
696 | /* In an indirect buffer, or a buffer that is the base of an | |
697 | indirect buffer, this holds a marker that records | |
698 | ZV for this buffer when the buffer is not current. */ | |
699 | Lisp_Object zv_marker; | |
2e4a1e1f RS |
700 | |
701 | /* This holds the point value before the last scroll operation. | |
702 | Explicitly setting point sets this to nil. */ | |
703 | Lisp_Object point_before_scroll; | |
8eb34fb9 RS |
704 | |
705 | /* Truename of the visited file, or nil. */ | |
706 | Lisp_Object file_truename; | |
4abe97d9 RS |
707 | |
708 | /* Invisibility spec of this buffer. | |
709 | t => any non-nil `invisible' property means invisible. | |
710 | A list => `invisible' property means invisible | |
711 | if it is memq in that list. */ | |
712 | Lisp_Object invisibility_spec; | |
637df16f | 713 | |
519052f3 RS |
714 | /* This is the last window that was selected with this buffer in it, |
715 | or nil if that window no longer displays this buffer. */ | |
716 | Lisp_Object last_selected_window; | |
717 | ||
f809d162 RS |
718 | /* Incremented each time the buffer is displayed in a window. */ |
719 | Lisp_Object display_count; | |
720 | ||
2d8c80b1 GM |
721 | /* Widths of left and right marginal areas for windows displaying |
722 | this buffer. */ | |
723 | Lisp_Object left_margin_width, right_margin_width; | |
724 | ||
725 | /* Non-nil means indicate lines not displaying text (in a style | |
726 | like vi). */ | |
727 | Lisp_Object indicate_empty_lines; | |
728 | ||
e042d829 RS |
729 | /* Time stamp updated each time this buffer is displayed in a window. */ |
730 | Lisp_Object display_time; | |
731 | ||
2d8c80b1 GM |
732 | /* If scrolling the display because point is below the bottom of a |
733 | window showing this buffer, try to choose a window start so | |
734 | that point ends up this number of lines from the top of the | |
735 | window. Nil means that scrolling method isn't used. */ | |
736 | Lisp_Object scroll_up_aggressively; | |
737 | ||
738 | /* If scrolling the display because point is above the top of a | |
739 | window showing this buffer, try to choose a window start so | |
740 | that point ends up this number of lines from the bottom of the | |
741 | window. Nil means that scrolling method isn't used. */ | |
742 | Lisp_Object scroll_down_aggressively; | |
743 | ||
637df16f RS |
744 | /* These are so we don't have to recompile everything |
745 | the next few times we add a new slot. */ | |
519052f3 | 746 | Lisp_Object extra2, extra3; |
c1ea566e | 747 | }; |
440d350c RS |
748 | \f |
749 | /* This points to the current buffer. */ | |
b3ec245a JB |
750 | |
751 | extern struct buffer *current_buffer; | |
752 | ||
753 | /* This structure holds the default values of the buffer-local variables | |
440d350c | 754 | that have special slots in each buffer. |
b3ec245a JB |
755 | The default value occupies the same slot in this structure |
756 | as an individual buffer's value occupies in that buffer. | |
757 | Setting the default value also goes through the alist of buffers | |
758 | and stores into each buffer that does not say it has a local value. */ | |
759 | ||
760 | extern struct buffer buffer_defaults; | |
761 | ||
762 | /* This structure marks which slots in a buffer have corresponding | |
763 | default values in buffer_defaults. | |
764 | Each such slot has a nonzero value in this structure. | |
765 | The value has only one nonzero bit. | |
766 | ||
767 | When a buffer has its own local value for a slot, | |
768 | the bit for that slot (found in the same slot in this structure) | |
769 | is turned on in the buffer's local_var_flags slot. | |
770 | ||
771 | If a slot in this structure is zero, then even though there may | |
440d350c | 772 | be a Lisp-level local variable for the slot, it has no default value, |
b3ec245a JB |
773 | and the corresponding slot in buffer_defaults is not used. */ |
774 | ||
775 | extern struct buffer buffer_local_flags; | |
776 | ||
777 | /* For each buffer slot, this points to the Lisp symbol name | |
778 | for that slot in the current buffer. It is 0 for slots | |
779 | that don't have such names. */ | |
780 | ||
781 | extern struct buffer buffer_local_symbols; | |
782 | ||
fbfed6f0 JB |
783 | /* This structure holds the required types for the values in the |
784 | buffer-local slots. If a slot contains Qnil, then the | |
785 | corresponding buffer slot may contain a value of any type. If a | |
786 | slot contains an integer, then prospective values' tags must be | |
f00008bc KH |
787 | equal to that integer (except nil is always allowed). |
788 | When a tag does not match, the function | |
789 | buffer_slot_type_mismatch will signal an error. | |
790 | ||
791 | If a slot here contains -1, the corresponding variable is read-only. */ | |
792 | ||
ea47125f | 793 | extern struct buffer buffer_local_types; |
440d350c | 794 | \f |
4b7610a9 AS |
795 | extern void reset_buffer P_ ((struct buffer *)); |
796 | extern void evaporate_overlays P_ ((int)); | |
797 | extern int overlays_at P_ ((int, int, Lisp_Object **, int *, int *, int *)); | |
798 | extern int sort_overlays P_ ((Lisp_Object *, int, struct window *)); | |
799 | extern void recenter_overlay_lists P_ ((struct buffer *, int)); | |
800 | extern int overlay_strings P_ ((int, struct window *, unsigned char **)); | |
801 | extern void validate_region P_ ((Lisp_Object *, Lisp_Object *)); | |
802 | extern void set_buffer_internal P_ ((struct buffer *)); | |
803 | extern void set_buffer_internal_1 P_ ((struct buffer *)); | |
804 | extern void set_buffer_temp P_ ((struct buffer *)); | |
805 | extern void record_buffer P_ ((Lisp_Object)); | |
806 | extern void buffer_slot_type_mismatch P_ ((int)); | |
807 | extern void fix_overlays_before P_ ((struct buffer *, int, int)); | |
808 | ||
809 | ||
810 | EXFUN (Fbuffer_name, 1); | |
811 | EXFUN (Fget_file_buffer, 1); | |
812 | EXFUN (Fnext_overlay_change, 1); | |
813 | EXFUN (Fdelete_overlay, 1); | |
440d350c | 814 | |
c1ea566e | 815 | /* Functions to call before and after each text change. */ |
b3ec245a JB |
816 | extern Lisp_Object Vbefore_change_function; |
817 | extern Lisp_Object Vafter_change_function; | |
03c6309a RS |
818 | extern Lisp_Object Vbefore_change_functions; |
819 | extern Lisp_Object Vafter_change_functions; | |
dbc4e1c1 | 820 | extern Lisp_Object Vfirst_change_hook; |
23f73711 RS |
821 | extern Lisp_Object Qbefore_change_functions; |
822 | extern Lisp_Object Qafter_change_functions; | |
dbc4e1c1 | 823 | extern Lisp_Object Qfirst_change_hook; |
b3ec245a | 824 | |
347d3e9c KH |
825 | /* If nonzero, all modification hooks are suppressed. */ |
826 | extern int inhibit_modification_hooks; | |
827 | ||
83ec8b67 RS |
828 | extern Lisp_Object Vdeactivate_mark; |
829 | extern Lisp_Object Vtransient_mark_mode; | |
440d350c RS |
830 | \f |
831 | /* Overlays */ | |
832 | ||
d00c875c | 833 | /* 1 if the OV is an overlay object. */ |
6c523803 | 834 | #define OVERLAY_VALID(OV) (OVERLAYP (OV)) |
b3ec245a | 835 | |
440d350c | 836 | /* Return the marker that stands for where OV starts in the buffer. */ |
21f7c864 | 837 | #define OVERLAY_START(OV) (XOVERLAY (OV)->start) |
b3ec245a | 838 | |
440d350c | 839 | /* Return the marker that stands for where OV ends in the buffer. */ |
21f7c864 | 840 | #define OVERLAY_END(OV) (XOVERLAY (OV)->end) |
b3ec245a | 841 | |
d00c875c KH |
842 | /* Return the actual buffer position for the marker P. |
843 | We assume you know which buffer it's pointing into. */ | |
b3ec245a | 844 | |
915857ff KH |
845 | #define OVERLAY_POSITION(P) \ |
846 | (GC_MARKERP (P) ? marker_position (P) : (abort (), 0)) | |
b3ec245a | 847 | |
440d350c RS |
848 | /* Allocation of buffer text. */ |
849 | ||
b3ec245a JB |
850 | #ifdef REL_ALLOC |
851 | #define BUFFER_ALLOC(data,size) ((unsigned char *) r_alloc (&data, (size))) | |
852 | #define BUFFER_REALLOC(data,size) ((unsigned char *) r_re_alloc (&data, (size))) | |
853 | #define BUFFER_FREE(data) (r_alloc_free (&data)) | |
854 | #define R_ALLOC_DECLARE(var,data) (r_alloc_declare (&var, (data))) | |
855 | #else | |
856 | #define BUFFER_ALLOC(data,size) (data = (unsigned char *) malloc ((size))) | |
857 | #define BUFFER_REALLOC(data,size) ((unsigned char *) realloc ((data), (size))) | |
858 | #define BUFFER_FREE(data) (free ((data))) | |
859 | #define R_ALLOC_DECLARE(var,data) | |
860 | #endif | |
2d8c80b1 | 861 |