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