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