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