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