Fix byte-compile of interactive closures
[emacs.git] / src / buffer.h
blob87b7cee4413276b73de7d3ea8b04083c51ff8edf
1 /* Header file for the buffer manipulation primitives.
3 Copyright (C) 1985-1986, 1993-1995, 1997-2016 Free Software Foundation,
4 Inc.
6 This file is part of GNU Emacs.
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 (at
11 your option) any later version.
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.
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/>. */
21 #ifndef EMACS_BUFFER_H
22 #define EMACS_BUFFER_H
24 #include <sys/types.h>
25 #include <time.h>
27 #include "character.h"
28 #include "lisp.h"
30 INLINE_HEADER_BEGIN
32 /* Accessing the parameters of the current buffer. */
34 /* These macros come in pairs, one for the char position
35 and one for the byte position. */
37 /* Position of beginning of buffer. */
38 #define BEG (1)
39 #define BEG_BYTE (BEG)
41 /* Position of beginning of accessible range of buffer. */
42 #define BEGV (current_buffer->begv)
43 #define BEGV_BYTE (current_buffer->begv_byte)
45 /* Position of point in buffer. The "+ 0" makes this
46 not an l-value, so you can't assign to it. Use SET_PT instead. */
47 #define PT (current_buffer->pt + 0)
48 #define PT_BYTE (current_buffer->pt_byte + 0)
50 /* Position of gap in buffer. */
51 #define GPT (current_buffer->text->gpt)
52 #define GPT_BYTE (current_buffer->text->gpt_byte)
54 /* Position of end of accessible range of buffer. */
55 #define ZV (current_buffer->zv)
56 #define ZV_BYTE (current_buffer->zv_byte)
58 /* Position of end of buffer. */
59 #define Z (current_buffer->text->z)
60 #define Z_BYTE (current_buffer->text->z_byte)
62 /* Macros for the addresses of places in the buffer. */
64 /* Address of beginning of buffer. */
65 #define BEG_ADDR (current_buffer->text->beg)
67 /* Address of beginning of accessible range of buffer. */
68 #define BEGV_ADDR (BYTE_POS_ADDR (current_buffer->begv_byte))
70 /* Address of point in buffer. */
71 #define PT_ADDR (BYTE_POS_ADDR (current_buffer->pt_byte))
73 /* Address of beginning of gap in buffer. */
74 #define GPT_ADDR (current_buffer->text->beg + current_buffer->text->gpt_byte - BEG_BYTE)
76 /* Address of end of gap in buffer. */
77 #define GAP_END_ADDR (current_buffer->text->beg + current_buffer->text->gpt_byte + current_buffer->text->gap_size - BEG_BYTE)
79 /* Address of end of accessible range of buffer. */
80 #define ZV_ADDR (BYTE_POS_ADDR (current_buffer->zv_byte))
82 /* Address of end of buffer. */
83 #define Z_ADDR (current_buffer->text->beg + current_buffer->text->gap_size + current_buffer->text->z_byte - BEG_BYTE)
85 /* Size of gap. */
86 #define GAP_SIZE (current_buffer->text->gap_size)
88 /* Modification count. */
89 #define MODIFF (current_buffer->text->modiff)
91 /* Character modification count. */
92 #define CHARS_MODIFF (current_buffer->text->chars_modiff)
94 /* Overlay modification count. */
95 #define OVERLAY_MODIFF (current_buffer->text->overlay_modiff)
97 /* Modification count as of last visit or save. */
98 #define SAVE_MODIFF (current_buffer->text->save_modiff)
100 /* BUFFER_CEILING_OF (resp. BUFFER_FLOOR_OF), when applied to n, return
101 the max (resp. min) p such that
103 BYTE_POS_ADDR (p) - BYTE_POS_ADDR (n) == p - n */
105 #define BUFFER_CEILING_OF(BYTEPOS) \
106 (((BYTEPOS) < GPT_BYTE && GPT < ZV ? GPT_BYTE : ZV_BYTE) - 1)
107 #define BUFFER_FLOOR_OF(BYTEPOS) \
108 (BEGV <= GPT && GPT_BYTE <= (BYTEPOS) ? GPT_BYTE : BEGV_BYTE)
110 /* Similar macros to operate on a specified buffer.
111 Note that many of these evaluate the buffer argument more than once. */
113 /* Position of beginning of buffer. */
114 #define BUF_BEG(buf) (BEG)
115 #define BUF_BEG_BYTE(buf) (BEG_BYTE)
117 /* The BUF_BEGV[_BYTE], BUF_ZV[_BYTE], and BUF_PT[_BYTE] macros cannot
118 be used for assignment; use SET_BUF_* macros below for that. */
120 /* Position of beginning of accessible range of buffer. */
121 #define BUF_BEGV(buf) \
122 (buf == current_buffer ? BEGV \
123 : NILP (BVAR (buf, begv_marker)) ? buf->begv \
124 : marker_position (BVAR (buf, begv_marker)))
126 #define BUF_BEGV_BYTE(buf) \
127 (buf == current_buffer ? BEGV_BYTE \
128 : NILP (BVAR (buf, begv_marker)) ? buf->begv_byte \
129 : marker_byte_position (BVAR (buf, begv_marker)))
131 /* Position of point in buffer. */
132 #define BUF_PT(buf) \
133 (buf == current_buffer ? PT \
134 : NILP (BVAR (buf, pt_marker)) ? buf->pt \
135 : marker_position (BVAR (buf, pt_marker)))
137 #define BUF_PT_BYTE(buf) \
138 (buf == current_buffer ? PT_BYTE \
139 : NILP (BVAR (buf, pt_marker)) ? buf->pt_byte \
140 : marker_byte_position (BVAR (buf, pt_marker)))
142 /* Position of end of accessible range of buffer. */
143 #define BUF_ZV(buf) \
144 (buf == current_buffer ? ZV \
145 : NILP (BVAR (buf, zv_marker)) ? buf->zv \
146 : marker_position (BVAR (buf, zv_marker)))
148 #define BUF_ZV_BYTE(buf) \
149 (buf == current_buffer ? ZV_BYTE \
150 : NILP (BVAR (buf, zv_marker)) ? buf->zv_byte \
151 : marker_byte_position (BVAR (buf, zv_marker)))
153 /* Position of gap in buffer. */
154 #define BUF_GPT(buf) ((buf)->text->gpt)
155 #define BUF_GPT_BYTE(buf) ((buf)->text->gpt_byte)
157 /* Position of end of buffer. */
158 #define BUF_Z(buf) ((buf)->text->z)
159 #define BUF_Z_BYTE(buf) ((buf)->text->z_byte)
161 /* Address of beginning of buffer. */
162 #define BUF_BEG_ADDR(buf) ((buf)->text->beg)
164 /* Address of beginning of gap of buffer. */
165 #define BUF_GPT_ADDR(buf) ((buf)->text->beg + (buf)->text->gpt_byte - BEG_BYTE)
167 /* Address of end of buffer. */
168 #define BUF_Z_ADDR(buf) ((buf)->text->beg + (buf)->text->gap_size + (buf)->text->z_byte - BEG_BYTE)
170 /* Address of end of gap in buffer. */
171 #define BUF_GAP_END_ADDR(buf) ((buf)->text->beg + (buf)->text->gpt_byte + (buf)->text->gap_size - BEG_BYTE)
173 /* Size of gap. */
174 #define BUF_GAP_SIZE(buf) ((buf)->text->gap_size)
176 /* Modification count. */
177 #define BUF_MODIFF(buf) ((buf)->text->modiff)
179 /* Character modification count. */
180 #define BUF_CHARS_MODIFF(buf) ((buf)->text->chars_modiff)
182 /* Modification count as of last visit or save. */
183 #define BUF_SAVE_MODIFF(buf) ((buf)->text->save_modiff)
185 /* Overlay modification count. */
186 #define BUF_OVERLAY_MODIFF(buf) ((buf)->text->overlay_modiff)
188 /* Modification count as of last auto-save. */
189 /* FIXME: should we move this into ->text->auto_save_modiff? */
190 #define BUF_AUTOSAVE_MODIFF(buf) ((buf)->auto_save_modified)
192 /* Compaction count. */
193 #define BUF_COMPACT(buf) ((buf)->text->compact)
195 /* Marker chain of buffer. */
196 #define BUF_MARKERS(buf) ((buf)->text->markers)
198 #define BUF_UNCHANGED_MODIFIED(buf) \
199 ((buf)->text->unchanged_modified)
201 #define BUF_OVERLAY_UNCHANGED_MODIFIED(buf) \
202 ((buf)->text->overlay_unchanged_modified)
203 #define BUF_BEG_UNCHANGED(buf) ((buf)->text->beg_unchanged)
204 #define BUF_END_UNCHANGED(buf) ((buf)->text->end_unchanged)
206 #define UNCHANGED_MODIFIED \
207 BUF_UNCHANGED_MODIFIED (current_buffer)
208 #define OVERLAY_UNCHANGED_MODIFIED \
209 BUF_OVERLAY_UNCHANGED_MODIFIED (current_buffer)
210 #define BEG_UNCHANGED BUF_BEG_UNCHANGED (current_buffer)
211 #define END_UNCHANGED BUF_END_UNCHANGED (current_buffer)
213 /* Compute how many characters at the top and bottom of BUF are
214 unchanged when the range START..END is modified. This computation
215 must be done each time BUF is modified. */
217 #define BUF_COMPUTE_UNCHANGED(buf, start, end) \
218 do \
220 if (BUF_UNCHANGED_MODIFIED (buf) == BUF_MODIFF (buf) \
221 && (BUF_OVERLAY_UNCHANGED_MODIFIED (buf) \
222 == BUF_OVERLAY_MODIFF (buf))) \
224 BUF_BEG_UNCHANGED (buf) = (start) - BUF_BEG (buf); \
225 BUF_END_UNCHANGED (buf) = BUF_Z (buf) - (end); \
227 else \
229 if (BUF_Z (buf) - (end) < BUF_END_UNCHANGED (buf)) \
230 BUF_END_UNCHANGED (buf) = BUF_Z (buf) - (end); \
231 if ((start) - BUF_BEG (buf) < BUF_BEG_UNCHANGED (buf)) \
232 BUF_BEG_UNCHANGED (buf) = (start) - BUF_BEG (buf); \
235 while (false)
238 /* Macros to set PT in the current buffer, or another buffer. */
240 #define SET_PT(position) (set_point (position))
241 #define TEMP_SET_PT(position) (temp_set_point (current_buffer, (position)))
243 #define SET_PT_BOTH(position, byte) (set_point_both (position, byte))
244 #define TEMP_SET_PT_BOTH(position, byte) \
245 (temp_set_point_both (current_buffer, (position), (byte)))
247 #define BUF_TEMP_SET_PT(buffer, position) \
248 (temp_set_point ((buffer), (position)))
250 extern void set_point (ptrdiff_t);
251 extern void temp_set_point (struct buffer *, ptrdiff_t);
252 extern void set_point_both (ptrdiff_t, ptrdiff_t);
253 extern void temp_set_point_both (struct buffer *,
254 ptrdiff_t, ptrdiff_t);
255 extern void set_point_from_marker (Lisp_Object);
256 extern void enlarge_buffer_text (struct buffer *, ptrdiff_t);
259 /* Macros for setting the BEGV, ZV or PT of a given buffer.
261 The ..._BOTH macros take both a charpos and a bytepos,
262 which must correspond to each other.
264 The macros without ..._BOTH take just a charpos,
265 and compute the bytepos from it. */
267 #define SET_BUF_BEGV(buf, charpos) \
268 ((buf)->begv_byte = buf_charpos_to_bytepos ((buf), (charpos)), \
269 (buf)->begv = (charpos))
271 #define SET_BUF_ZV(buf, charpos) \
272 ((buf)->zv_byte = buf_charpos_to_bytepos ((buf), (charpos)), \
273 (buf)->zv = (charpos))
275 #define SET_BUF_BEGV_BOTH(buf, charpos, byte) \
276 ((buf)->begv = (charpos), \
277 (buf)->begv_byte = (byte))
279 #define SET_BUF_ZV_BOTH(buf, charpos, byte) \
280 ((buf)->zv = (charpos), \
281 (buf)->zv_byte = (byte))
283 #define SET_BUF_PT_BOTH(buf, charpos, byte) \
284 ((buf)->pt = (charpos), \
285 (buf)->pt_byte = (byte))
287 /* Macros to access a character or byte in the current buffer,
288 or convert between a byte position and an address.
289 These macros do not check that the position is in range. */
291 /* Access a Lisp position value in POS,
292 and store the charpos in CHARPOS and the bytepos in BYTEPOS. */
294 #define DECODE_POSITION(charpos, bytepos, pos) \
295 do \
297 Lisp_Object __pos = (pos); \
298 if (NUMBERP (__pos)) \
300 charpos = __pos; \
301 bytepos = buf_charpos_to_bytepos (current_buffer, __pos); \
303 else if (MARKERP (__pos)) \
305 charpos = marker_position (__pos); \
306 bytepos = marker_byte_position (__pos); \
308 else \
309 wrong_type_argument (Qinteger_or_marker_p, __pos); \
311 while (false)
313 /* Maximum number of bytes in a buffer.
314 A buffer cannot contain more bytes than a 1-origin fixnum can represent,
315 nor can it be so large that C pointer arithmetic stops working.
316 The ptrdiff_t cast ensures that this is signed, not unsigned. */
317 #define BUF_BYTES_MAX \
318 (ptrdiff_t) min (MOST_POSITIVE_FIXNUM - 1, min (SIZE_MAX, PTRDIFF_MAX))
320 /* Maximum gap size after compact_buffer, in bytes. Also
321 used in make_gap_larger to get some extra reserved space. */
323 #define GAP_BYTES_DFL 2000
325 /* Minimum gap size after compact_buffer, in bytes. Also
326 used in make_gap_smaller to avoid too small gap size. */
328 #define GAP_BYTES_MIN 20
330 /* Return the address of byte position N in current buffer. */
332 #define BYTE_POS_ADDR(n) \
333 (((n) >= GPT_BYTE ? GAP_SIZE : 0) + (n) + BEG_ADDR - BEG_BYTE)
335 /* Return the address of char position N. */
337 #define CHAR_POS_ADDR(n) \
338 (((n) >= GPT ? GAP_SIZE : 0) \
339 + buf_charpos_to_bytepos (current_buffer, n) \
340 + BEG_ADDR - BEG_BYTE)
342 /* Convert a character position to a byte position. */
344 #define CHAR_TO_BYTE(charpos) \
345 (buf_charpos_to_bytepos (current_buffer, charpos))
347 /* Convert a byte position to a character position. */
349 #define BYTE_TO_CHAR(bytepos) \
350 (buf_bytepos_to_charpos (current_buffer, bytepos))
352 /* Convert PTR, the address of a byte in the buffer, into a byte position. */
354 #define PTR_BYTE_POS(ptr) \
355 ((ptr) - (current_buffer)->text->beg \
356 - (ptr - (current_buffer)->text->beg <= GPT_BYTE - BEG_BYTE ? 0 : GAP_SIZE) \
357 + BEG_BYTE)
359 /* Return character at byte position POS. See the caveat WARNING for
360 FETCH_MULTIBYTE_CHAR below. */
362 #define FETCH_CHAR(pos) \
363 (!NILP (BVAR (current_buffer, enable_multibyte_characters)) \
364 ? FETCH_MULTIBYTE_CHAR ((pos)) \
365 : FETCH_BYTE ((pos)))
367 /* Return the byte at byte position N. */
369 #define FETCH_BYTE(n) *(BYTE_POS_ADDR ((n)))
371 /* Return character at byte position POS. If the current buffer is unibyte
372 and the character is not ASCII, make the returning character
373 multibyte. */
375 #define FETCH_CHAR_AS_MULTIBYTE(pos) \
376 (!NILP (BVAR (current_buffer, enable_multibyte_characters)) \
377 ? FETCH_MULTIBYTE_CHAR ((pos)) \
378 : UNIBYTE_TO_CHAR (FETCH_BYTE ((pos))))
381 /* Macros for accessing a character or byte,
382 or converting between byte positions and addresses,
383 in a specified buffer. */
385 /* Return the address of character at byte position POS in buffer BUF.
386 Note that both arguments can be computed more than once. */
388 #define BUF_BYTE_ADDRESS(buf, pos) \
389 ((buf)->text->beg + (pos) - BEG_BYTE \
390 + ((pos) >= (buf)->text->gpt_byte ? (buf)->text->gap_size : 0))
392 /* Return the address of character at char position POS in buffer BUF.
393 Note that both arguments can be computed more than once. */
395 #define BUF_CHAR_ADDRESS(buf, pos) \
396 ((buf)->text->beg + buf_charpos_to_bytepos ((buf), (pos)) - BEG_BYTE \
397 + ((pos) >= (buf)->text->gpt ? (buf)->text->gap_size : 0))
399 /* Convert PTR, the address of a char in buffer BUF,
400 into a character position. */
402 #define BUF_PTR_BYTE_POS(buf, ptr) \
403 ((ptr) - (buf)->text->beg \
404 - (ptr - (buf)->text->beg <= BUF_GPT_BYTE (buf) - BEG_BYTE \
405 ? 0 : BUF_GAP_SIZE ((buf))) \
406 + BEG_BYTE)
408 /* Return the character at byte position POS in buffer BUF. */
410 #define BUF_FETCH_CHAR(buf, pos) \
411 (!NILP (buf->enable_multibyte_characters) \
412 ? BUF_FETCH_MULTIBYTE_CHAR ((buf), (pos)) \
413 : BUF_FETCH_BYTE ((buf), (pos)))
415 /* Return the byte at byte position N in buffer BUF. */
417 #define BUF_FETCH_BYTE(buf, n) \
418 *(BUF_BYTE_ADDRESS ((buf), (n)))
420 /* Define the actual buffer data structures. */
422 /* This data structure describes the actual text contents of a buffer.
423 It is shared between indirect buffers and their base buffer. */
425 struct buffer_text
427 /* Actual address of buffer contents. If REL_ALLOC is defined,
428 this address might change when blocks are relocated which can
429 e.g. happen when malloc is called. So, don't pass a pointer
430 into a buffer's text to functions that malloc. */
431 unsigned char *beg;
433 ptrdiff_t gpt; /* Char pos of gap in buffer. */
434 ptrdiff_t z; /* Char pos of end of buffer. */
435 ptrdiff_t gpt_byte; /* Byte pos of gap in buffer. */
436 ptrdiff_t z_byte; /* Byte pos of end of buffer. */
437 ptrdiff_t gap_size; /* Size of buffer's gap. */
438 EMACS_INT modiff; /* This counts buffer-modification events
439 for this buffer. It is incremented for
440 each such event, and never otherwise
441 changed. */
442 EMACS_INT chars_modiff; /* This is modified with character change
443 events for this buffer. It is set to
444 modiff for each such event, and never
445 otherwise changed. */
446 EMACS_INT save_modiff; /* Previous value of modiff, as of last
447 time buffer visited or saved a file. */
449 EMACS_INT overlay_modiff; /* Counts modifications to overlays. */
451 EMACS_INT compact; /* Set to modiff each time when compact_buffer
452 is called for this buffer. */
454 /* Minimum value of GPT - BEG since last redisplay that finished. */
455 ptrdiff_t beg_unchanged;
457 /* Minimum value of Z - GPT since last redisplay that finished. */
458 ptrdiff_t end_unchanged;
460 /* MODIFF as of last redisplay that finished; if it matches MODIFF,
461 beg_unchanged and end_unchanged contain no useful information. */
462 EMACS_INT unchanged_modified;
464 /* BUF_OVERLAY_MODIFF of current buffer, as of last redisplay that
465 finished; if it matches BUF_OVERLAY_MODIFF, beg_unchanged and
466 end_unchanged contain no useful information. */
467 EMACS_INT overlay_unchanged_modified;
469 /* Properties of this buffer's text. */
470 INTERVAL intervals;
472 /* The markers that refer to this buffer.
473 This is actually a single marker ---
474 successive elements in its marker `chain'
475 are the other markers referring to this buffer.
476 This is a singly linked unordered list, which means that it's
477 very cheap to add a marker to the list and it's also very cheap
478 to move a marker within a buffer. */
479 struct Lisp_Marker *markers;
481 /* Usually false. Temporarily true in decode_coding_gap to
482 prevent Fgarbage_collect from shrinking the gap and losing
483 not-yet-decoded bytes. */
484 bool_bf inhibit_shrinking : 1;
486 /* True if it needs to be redisplayed. */
487 bool_bf redisplay : 1;
490 /* Most code should use this macro to access Lisp fields in struct buffer. */
492 #define BVAR(buf, field) ((buf)->field ## _)
494 /* This is the structure that the buffer Lisp object points to. */
496 struct buffer
498 struct vectorlike_header header;
500 /* The name of this buffer. */
501 Lisp_Object name_;
503 /* The name of the file visited in this buffer, or nil. */
504 Lisp_Object filename_;
506 /* Directory for expanding relative file names. */
507 Lisp_Object directory_;
509 /* True if this buffer has been backed up (if you write to the visited
510 file and it hasn't been backed up, then a backup will be made). */
511 Lisp_Object backed_up_;
513 /* Length of file when last read or saved.
514 -1 means auto saving turned off because buffer shrank a lot.
515 -2 means don't turn off auto saving if buffer shrinks.
516 (That value is used with buffer-swap-text.)
517 This is not in the struct buffer_text
518 because it's not used in indirect buffers at all. */
519 Lisp_Object save_length_;
521 /* File name used for auto-saving this buffer.
522 This is not in the struct buffer_text
523 because it's not used in indirect buffers at all. */
524 Lisp_Object auto_save_file_name_;
526 /* Non-nil if buffer read-only. */
527 Lisp_Object read_only_;
529 /* "The mark". This is a marker which may
530 point into this buffer or may point nowhere. */
531 Lisp_Object mark_;
533 /* Alist of elements (SYMBOL . VALUE-IN-THIS-BUFFER) for all
534 per-buffer variables of this buffer. For locally unbound
535 symbols, just the symbol appears as the element. */
536 Lisp_Object local_var_alist_;
538 /* Symbol naming major mode (e.g., lisp-mode). */
539 Lisp_Object major_mode_;
541 /* Pretty name of major mode (e.g., "Lisp"). */
542 Lisp_Object mode_name_;
544 /* Mode line element that controls format of mode line. */
545 Lisp_Object mode_line_format_;
547 /* Analogous to mode_line_format for the line displayed at the top
548 of windows. Nil means don't display that line. */
549 Lisp_Object header_line_format_;
551 /* Keys that are bound local to this buffer. */
552 Lisp_Object keymap_;
554 /* This buffer's local abbrev table. */
555 Lisp_Object abbrev_table_;
557 /* This buffer's syntax table. */
558 Lisp_Object syntax_table_;
560 /* This buffer's category table. */
561 Lisp_Object category_table_;
563 /* Values of several buffer-local variables. */
564 /* tab-width is buffer-local so that redisplay can find it
565 in buffers that are not current. */
566 Lisp_Object case_fold_search_;
567 Lisp_Object tab_width_;
568 Lisp_Object fill_column_;
569 Lisp_Object left_margin_;
571 /* Function to call when insert space past fill column. */
572 Lisp_Object auto_fill_function_;
574 /* Case table for case-conversion in this buffer.
575 This char-table maps each char into its lower-case version. */
576 Lisp_Object downcase_table_;
578 /* Char-table mapping each char to its upper-case version. */
579 Lisp_Object upcase_table_;
581 /* Char-table for conversion for case-folding search. */
582 Lisp_Object case_canon_table_;
584 /* Char-table of equivalences for case-folding search. */
585 Lisp_Object case_eqv_table_;
587 /* Non-nil means do not display continuation lines. */
588 Lisp_Object truncate_lines_;
590 /* Non-nil means to use word wrapping when displaying continuation lines. */
591 Lisp_Object word_wrap_;
593 /* Non-nil means display ctl chars with uparrow. */
594 Lisp_Object ctl_arrow_;
596 /* Non-nil means reorder bidirectional text for display in the
597 visual order. */
598 Lisp_Object bidi_display_reordering_;
600 /* If non-nil, specifies which direction of text to force in all the
601 paragraphs of the buffer. Nil means determine paragraph
602 direction dynamically for each paragraph. */
603 Lisp_Object bidi_paragraph_direction_;
605 /* Non-nil means do selective display;
606 see doc string in syms_of_buffer (buffer.c) for details. */
607 Lisp_Object selective_display_;
609 /* Non-nil means show ... at end of line followed by invisible lines. */
610 Lisp_Object selective_display_ellipses_;
612 /* Alist of (FUNCTION . STRING) for each minor mode enabled in buffer. */
613 Lisp_Object minor_modes_;
615 /* t if "self-insertion" should overwrite; `binary' if it should also
616 overwrite newlines and tabs - for editing executables and the like. */
617 Lisp_Object overwrite_mode_;
619 /* Non-nil means abbrev mode is on. Expand abbrevs automatically. */
620 Lisp_Object abbrev_mode_;
622 /* Display table to use for text in this buffer. */
623 Lisp_Object display_table_;
625 /* t means the mark and region are currently active. */
626 Lisp_Object mark_active_;
628 /* Non-nil means the buffer contents are regarded as multi-byte
629 form of characters, not a binary code. */
630 Lisp_Object enable_multibyte_characters_;
632 /* Coding system to be used for encoding the buffer contents on
633 saving. */
634 Lisp_Object buffer_file_coding_system_;
636 /* List of symbols naming the file format used for visited file. */
637 Lisp_Object file_format_;
639 /* List of symbols naming the file format used for auto-save file. */
640 Lisp_Object auto_save_file_format_;
642 /* True if the newline position cache, width run cache and BIDI paragraph
643 cache are enabled. See search.c, indent.c and bidi.c for details. */
644 Lisp_Object cache_long_scans_;
646 /* If the width run cache is enabled, this table contains the
647 character widths width_run_cache (see above) assumes. When we
648 do a thorough redisplay, we compare this against the buffer's
649 current display table to see whether the display table has
650 affected the widths of any characters. If it has, we
651 invalidate the width run cache, and re-initialize width_table. */
652 Lisp_Object width_table_;
654 /* In an indirect buffer, or a buffer that is the base of an
655 indirect buffer, this holds a marker that records
656 PT for this buffer when the buffer is not current. */
657 Lisp_Object pt_marker_;
659 /* In an indirect buffer, or a buffer that is the base of an
660 indirect buffer, this holds a marker that records
661 BEGV for this buffer when the buffer is not current. */
662 Lisp_Object begv_marker_;
664 /* In an indirect buffer, or a buffer that is the base of an
665 indirect buffer, this holds a marker that records
666 ZV for this buffer when the buffer is not current. */
667 Lisp_Object zv_marker_;
669 /* This holds the point value before the last scroll operation.
670 Explicitly setting point sets this to nil. */
671 Lisp_Object point_before_scroll_;
673 /* Truename of the visited file, or nil. */
674 Lisp_Object file_truename_;
676 /* Invisibility spec of this buffer.
677 t => any non-nil `invisible' property means invisible.
678 A list => `invisible' property means invisible
679 if it is memq in that list. */
680 Lisp_Object invisibility_spec_;
682 /* This is the last window that was selected with this buffer in it,
683 or nil if that window no longer displays this buffer. */
684 Lisp_Object last_selected_window_;
686 /* Incremented each time the buffer is displayed in a window. */
687 Lisp_Object display_count_;
689 /* Widths of left and right marginal areas for windows displaying
690 this buffer. */
691 Lisp_Object left_margin_cols_;
692 Lisp_Object right_margin_cols_;
694 /* Widths of left and right fringe areas for windows displaying
695 this buffer. */
696 Lisp_Object left_fringe_width_;
697 Lisp_Object right_fringe_width_;
699 /* Non-nil means fringes are drawn outside display margins;
700 othersize draw them between margin areas and text. */
701 Lisp_Object fringes_outside_margins_;
703 /* Width, height and types of scroll bar areas for windows displaying
704 this buffer. */
705 Lisp_Object scroll_bar_width_;
706 Lisp_Object scroll_bar_height_;
707 Lisp_Object vertical_scroll_bar_type_;
708 Lisp_Object horizontal_scroll_bar_type_;
710 /* Non-nil means indicate lines not displaying text (in a style
711 like vi). */
712 Lisp_Object indicate_empty_lines_;
714 /* Non-nil means indicate buffer boundaries and scrolling. */
715 Lisp_Object indicate_buffer_boundaries_;
717 /* Logical to physical fringe bitmap mappings. */
718 Lisp_Object fringe_indicator_alist_;
720 /* Logical to physical cursor bitmap mappings. */
721 Lisp_Object fringe_cursor_alist_;
723 /* Time stamp updated each time this buffer is displayed in a window. */
724 Lisp_Object display_time_;
726 /* If scrolling the display because point is below the bottom of a
727 window showing this buffer, try to choose a window start so
728 that point ends up this number of lines from the top of the
729 window. Nil means that scrolling method isn't used. */
730 Lisp_Object scroll_up_aggressively_;
732 /* If scrolling the display because point is above the top of a
733 window showing this buffer, try to choose a window start so
734 that point ends up this number of lines from the bottom of the
735 window. Nil means that scrolling method isn't used. */
736 Lisp_Object scroll_down_aggressively_;
738 /* Desired cursor type in this buffer. See the doc string of
739 per-buffer variable `cursor-type'. */
740 Lisp_Object cursor_type_;
742 /* An integer > 0 means put that number of pixels below text lines
743 in the display of this buffer. */
744 Lisp_Object extra_line_spacing_;
746 /* Cursor type to display in non-selected windows.
747 t means to use hollow box cursor.
748 See `cursor-type' for other values. */
749 Lisp_Object cursor_in_non_selected_windows_;
751 /* No more Lisp_Object beyond this point. Except undo_list,
752 which is handled specially in Fgarbage_collect. */
754 /* This structure holds the coordinates of the buffer contents
755 in ordinary buffers. In indirect buffers, this is not used. */
756 struct buffer_text own_text;
758 /* This points to the `struct buffer_text' that used for this buffer.
759 In an ordinary buffer, this is the own_text field above.
760 In an indirect buffer, this is the own_text field of another buffer. */
761 struct buffer_text *text;
763 /* Next buffer, in chain of all buffers, including killed ones. */
764 struct buffer *next;
766 /* Char position of point in buffer. */
767 ptrdiff_t pt;
769 /* Byte position of point in buffer. */
770 ptrdiff_t pt_byte;
772 /* Char position of beginning of accessible range. */
773 ptrdiff_t begv;
775 /* Byte position of beginning of accessible range. */
776 ptrdiff_t begv_byte;
778 /* Char position of end of accessible range. */
779 ptrdiff_t zv;
781 /* Byte position of end of accessible range. */
782 ptrdiff_t zv_byte;
784 /* In an indirect buffer, this points to the base buffer.
785 In an ordinary buffer, it is 0. */
786 struct buffer *base_buffer;
788 /* In an indirect buffer, this is -1. In an ordinary buffer,
789 it's the number of indirect buffers that share our text;
790 zero means that we're the only owner of this text. */
791 int indirections;
793 /* Number of windows showing this buffer. Always -1 for
794 an indirect buffer since it counts as its base buffer. */
795 int window_count;
797 /* A non-zero value in slot IDX means that per-buffer variable
798 with index IDX has a local value in this buffer. The index IDX
799 for a buffer-local variable is stored in that variable's slot
800 in buffer_local_flags as a Lisp integer. If the index is -1,
801 this means the variable is always local in all buffers. */
802 #define MAX_PER_BUFFER_VARS 50
803 char local_flags[MAX_PER_BUFFER_VARS];
805 /* Set to the modtime of the visited file when read or written.
806 modtime.tv_nsec == NONEXISTENT_MODTIME_NSECS means
807 visited file was nonexistent. modtime.tv_nsec ==
808 UNKNOWN_MODTIME_NSECS means visited file modtime unknown;
809 in no case complain about any mismatch on next save attempt. */
810 #define NONEXISTENT_MODTIME_NSECS (-1)
811 #define UNKNOWN_MODTIME_NSECS (-2)
812 struct timespec modtime;
814 /* Size of the file when modtime was set. This is used to detect the
815 case where the file grew while we were reading it, so the modtime
816 is still the same (since it's rounded up to seconds) but we're actually
817 not up-to-date. -1 means the size is unknown. Only meaningful if
818 modtime is actually set. */
819 off_t modtime_size;
821 /* The value of text->modiff at the last auto-save. */
822 EMACS_INT auto_save_modified;
824 /* The value of text->modiff at the last display error.
825 Redisplay of this buffer is inhibited until it changes again. */
826 EMACS_INT display_error_modiff;
828 /* The time at which we detected a failure to auto-save,
829 Or 0 if we didn't have a failure. */
830 time_t auto_save_failure_time;
832 /* Position in buffer at which display started
833 the last time this buffer was displayed. */
834 ptrdiff_t last_window_start;
836 /* If the long line scan cache is enabled (i.e. the buffer-local
837 variable cache-long-line-scans is non-nil), newline_cache
838 points to the newline cache, and width_run_cache points to the
839 width run cache.
841 The newline cache records which stretches of the buffer are
842 known *not* to contain newlines, so that they can be skipped
843 quickly when we search for newlines.
845 The width run cache records which stretches of the buffer are
846 known to contain characters whose widths are all the same. If
847 the width run cache maps a character to a value > 0, that value is
848 the character's width; if it maps a character to zero, we don't
849 know what its width is. This allows compute_motion to process
850 such regions very quickly, using algebra instead of inspecting
851 each character. See also width_table, below.
853 The latter cache is used to speedup bidi_find_paragraph_start. */
854 struct region_cache *newline_cache;
855 struct region_cache *width_run_cache;
856 struct region_cache *bidi_paragraph_cache;
858 /* Non-zero means disable redisplay optimizations when rebuilding the glyph
859 matrices (but not when redrawing). */
860 bool_bf prevent_redisplay_optimizations_p : 1;
862 /* Non-zero whenever the narrowing is changed in this buffer. */
863 bool_bf clip_changed : 1;
865 /* List of overlays that end at or before the current center,
866 in order of end-position. */
867 struct Lisp_Overlay *overlays_before;
869 /* List of overlays that end after the current center,
870 in order of start-position. */
871 struct Lisp_Overlay *overlays_after;
873 /* Position where the overlay lists are centered. */
874 ptrdiff_t overlay_center;
876 /* Changes in the buffer are recorded here for undo, and t means
877 don't record anything. This information belongs to the base
878 buffer of an indirect buffer. But we can't store it in the
879 struct buffer_text because local variables have to be right in
880 the struct buffer. So we copy it around in set_buffer_internal. */
881 Lisp_Object undo_list_;
884 /* Most code should use these functions to set Lisp fields in struct
885 buffer. (Some setters that are private to a single .c file are
886 defined as static in those files.) */
887 INLINE void
888 bset_bidi_paragraph_direction (struct buffer *b, Lisp_Object val)
890 b->bidi_paragraph_direction_ = val;
892 INLINE void
893 bset_cache_long_scans (struct buffer *b, Lisp_Object val)
895 b->cache_long_scans_ = val;
897 INLINE void
898 bset_case_canon_table (struct buffer *b, Lisp_Object val)
900 b->case_canon_table_ = val;
902 INLINE void
903 bset_case_eqv_table (struct buffer *b, Lisp_Object val)
905 b->case_eqv_table_ = val;
907 INLINE void
908 bset_directory (struct buffer *b, Lisp_Object val)
910 b->directory_ = val;
912 INLINE void
913 bset_display_count (struct buffer *b, Lisp_Object val)
915 b->display_count_ = val;
917 INLINE void
918 bset_display_time (struct buffer *b, Lisp_Object val)
920 b->display_time_ = val;
922 INLINE void
923 bset_downcase_table (struct buffer *b, Lisp_Object val)
925 b->downcase_table_ = val;
927 INLINE void
928 bset_enable_multibyte_characters (struct buffer *b, Lisp_Object val)
930 b->enable_multibyte_characters_ = val;
932 INLINE void
933 bset_filename (struct buffer *b, Lisp_Object val)
935 b->filename_ = val;
937 INLINE void
938 bset_keymap (struct buffer *b, Lisp_Object val)
940 b->keymap_ = val;
942 INLINE void
943 bset_last_selected_window (struct buffer *b, Lisp_Object val)
945 b->last_selected_window_ = val;
947 INLINE void
948 bset_local_var_alist (struct buffer *b, Lisp_Object val)
950 b->local_var_alist_ = val;
952 INLINE void
953 bset_mark_active (struct buffer *b, Lisp_Object val)
955 b->mark_active_ = val;
957 INLINE void
958 bset_point_before_scroll (struct buffer *b, Lisp_Object val)
960 b->point_before_scroll_ = val;
962 INLINE void
963 bset_read_only (struct buffer *b, Lisp_Object val)
965 b->read_only_ = val;
967 INLINE void
968 bset_truncate_lines (struct buffer *b, Lisp_Object val)
970 b->truncate_lines_ = val;
972 INLINE void
973 bset_undo_list (struct buffer *b, Lisp_Object val)
975 b->undo_list_ = val;
977 INLINE void
978 bset_upcase_table (struct buffer *b, Lisp_Object val)
980 b->upcase_table_ = val;
982 INLINE void
983 bset_width_table (struct buffer *b, Lisp_Object val)
985 b->width_table_ = val;
988 /* Number of Lisp_Objects at the beginning of struct buffer.
989 If you add, remove, or reorder Lisp_Objects within buffer
990 structure, make sure that this is still correct. */
992 #define BUFFER_LISP_SIZE \
993 ((offsetof (struct buffer, own_text) - header_size) / word_size)
995 /* Size of the struct buffer part beyond leading Lisp_Objects, in word_size
996 units. Rounding is needed for --with-wide-int configuration. */
998 #define BUFFER_REST_SIZE \
999 ((((sizeof (struct buffer) - offsetof (struct buffer, own_text)) \
1000 + (word_size - 1)) & ~(word_size - 1)) / word_size)
1002 /* Initialize the pseudovector header of buffer object. BUFFER_LISP_SIZE
1003 is required for GC, but BUFFER_REST_SIZE is set up just to be consistent
1004 with other pseudovectors. */
1006 #define BUFFER_PVEC_INIT(b) \
1007 XSETPVECTYPESIZE (b, PVEC_BUFFER, BUFFER_LISP_SIZE, BUFFER_REST_SIZE)
1009 /* Convenient check whether buffer B is live. */
1011 #define BUFFER_LIVE_P(b) (!NILP (BVAR (b, name)))
1013 /* Convenient check whether buffer B is hidden (i.e. its name
1014 starts with a space). Caller must ensure that B is live. */
1016 #define BUFFER_HIDDEN_P(b) (SREF (BVAR (b, name), 0) == ' ')
1018 /* Verify indirection counters. */
1020 #define BUFFER_CHECK_INDIRECTION(b) \
1021 do { \
1022 if (BUFFER_LIVE_P (b)) \
1024 if (b->base_buffer) \
1026 eassert (b->indirections == -1); \
1027 eassert (b->base_buffer->indirections > 0); \
1029 else \
1030 eassert (b->indirections >= 0); \
1032 } while (false)
1034 /* Chain of all buffers, including killed ones. */
1036 extern struct buffer *all_buffers;
1038 /* Used to iterate over the chain above. */
1040 #define FOR_EACH_BUFFER(b) \
1041 for ((b) = all_buffers; (b); (b) = (b)->next)
1043 /* This points to the current buffer. */
1045 extern struct buffer *current_buffer;
1047 /* This structure holds the default values of the buffer-local variables
1048 that have special slots in each buffer.
1049 The default value occupies the same slot in this structure
1050 as an individual buffer's value occupies in that buffer.
1051 Setting the default value also goes through the alist of buffers
1052 and stores into each buffer that does not say it has a local value. */
1054 extern struct buffer buffer_defaults;
1056 /* This structure marks which slots in a buffer have corresponding
1057 default values in buffer_defaults.
1058 Each such slot has a nonzero value in this structure.
1059 The value has only one nonzero bit.
1061 When a buffer has its own local value for a slot,
1062 the entry for that slot (found in the same slot in this structure)
1063 is turned on in the buffer's local_flags array.
1065 If a slot in this structure is zero, then even though there may
1066 be a Lisp-level local variable for the slot, it has no default value,
1067 and the corresponding slot in buffer_defaults is not used. */
1070 extern struct buffer buffer_local_flags;
1072 /* For each buffer slot, this points to the Lisp symbol name
1073 for that slot in the current buffer. It is 0 for slots
1074 that don't have such names. */
1076 extern struct buffer buffer_local_symbols;
1078 extern void delete_all_overlays (struct buffer *);
1079 extern void reset_buffer (struct buffer *);
1080 extern void compact_buffer (struct buffer *);
1081 extern void evaporate_overlays (ptrdiff_t);
1082 extern ptrdiff_t overlays_at (EMACS_INT, bool, Lisp_Object **,
1083 ptrdiff_t *, ptrdiff_t *, ptrdiff_t *, bool);
1084 extern ptrdiff_t sort_overlays (Lisp_Object *, ptrdiff_t, struct window *);
1085 extern void recenter_overlay_lists (struct buffer *, ptrdiff_t);
1086 extern ptrdiff_t overlay_strings (ptrdiff_t, struct window *, unsigned char **);
1087 extern void validate_region (Lisp_Object *, Lisp_Object *);
1088 extern void set_buffer_internal_1 (struct buffer *);
1089 extern void set_buffer_temp (struct buffer *);
1090 extern Lisp_Object buffer_local_value (Lisp_Object, Lisp_Object);
1091 extern void record_buffer (Lisp_Object);
1092 extern void fix_overlays_before (struct buffer *, ptrdiff_t, ptrdiff_t);
1093 extern void mmap_set_vars (bool);
1094 extern void restore_buffer (Lisp_Object);
1095 extern void set_buffer_if_live (Lisp_Object);
1097 /* Return B as a struct buffer pointer, defaulting to the current buffer. */
1099 INLINE struct buffer *
1100 decode_buffer (Lisp_Object b)
1102 return NILP (b) ? current_buffer : (CHECK_BUFFER (b), XBUFFER (b));
1105 /* Set the current buffer to B.
1107 We previously set windows_or_buffers_changed here to invalidate
1108 global unchanged information in beg_unchanged and end_unchanged.
1109 This is no longer necessary because we now compute unchanged
1110 information on a buffer-basis. Every action affecting other
1111 windows than the selected one requires a select_window at some
1112 time, and that increments windows_or_buffers_changed. */
1114 INLINE void
1115 set_buffer_internal (struct buffer *b)
1117 if (current_buffer != b)
1118 set_buffer_internal_1 (b);
1121 /* Arrange to go back to the original buffer after the next
1122 call to unbind_to if the original buffer is still alive. */
1124 INLINE void
1125 record_unwind_current_buffer (void)
1127 record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
1130 /* Get overlays at POSN into array OVERLAYS with NOVERLAYS elements.
1131 If NEXTP is non-NULL, return next overlay there.
1132 See overlay_at arg CHANGE_REQ for meaning of CHRQ arg. */
1134 #define GET_OVERLAYS_AT(posn, overlays, noverlays, nextp, chrq) \
1135 do { \
1136 ptrdiff_t maxlen = 40; \
1137 SAFE_NALLOCA (overlays, 1, maxlen); \
1138 (noverlays) = overlays_at (posn, false, &(overlays), &maxlen, \
1139 nextp, NULL, chrq); \
1140 if ((noverlays) > maxlen) \
1142 maxlen = noverlays; \
1143 SAFE_NALLOCA (overlays, 1, maxlen); \
1144 (noverlays) = overlays_at (posn, false, &(overlays), &maxlen, \
1145 nextp, NULL, chrq); \
1147 } while (false)
1149 extern Lisp_Object Vbuffer_alist;
1151 /* FOR_EACH_LIVE_BUFFER (LIST_VAR, BUF_VAR) followed by a statement is
1152 a `for' loop which iterates over the buffers from Vbuffer_alist. */
1154 #define FOR_EACH_LIVE_BUFFER(list_var, buf_var) \
1155 FOR_EACH_ALIST_VALUE (Vbuffer_alist, list_var, buf_var)
1157 /* Get text properties of B. */
1159 INLINE INTERVAL
1160 buffer_intervals (struct buffer *b)
1162 eassert (b->text != NULL);
1163 return b->text->intervals;
1166 /* Set text properties of B to I. */
1168 INLINE void
1169 set_buffer_intervals (struct buffer *b, INTERVAL i)
1171 eassert (b->text != NULL);
1172 b->text->intervals = i;
1175 /* Non-zero if current buffer has overlays. */
1177 INLINE bool
1178 buffer_has_overlays (void)
1180 return current_buffer->overlays_before || current_buffer->overlays_after;
1183 /* Return character code of multi-byte form at byte position POS. If POS
1184 doesn't point the head of valid multi-byte form, only the byte at
1185 POS is returned. No range checking.
1187 WARNING: The character returned by this macro could be "unified"
1188 inside STRING_CHAR, if the original character in the buffer belongs
1189 to one of the Private Use Areas (PUAs) of codepoints that Emacs
1190 uses to support non-unified CJK characters. If that happens,
1191 CHAR_BYTES will return a value that is different from the length of
1192 the original multibyte sequence stored in the buffer. Therefore,
1193 do _not_ use FETCH_MULTIBYTE_CHAR if you need to advance through
1194 the buffer to the next character after fetching this one. Instead,
1195 use either FETCH_CHAR_ADVANCE or STRING_CHAR_AND_LENGTH. */
1197 INLINE int
1198 FETCH_MULTIBYTE_CHAR (ptrdiff_t pos)
1200 unsigned char *p = ((pos >= GPT_BYTE ? GAP_SIZE : 0)
1201 + pos + BEG_ADDR - BEG_BYTE);
1202 return STRING_CHAR (p);
1205 /* Return character code of multi-byte form at byte position POS in BUF.
1206 If POS doesn't point the head of valid multi-byte form, only the byte at
1207 POS is returned. No range checking. */
1209 INLINE int
1210 BUF_FETCH_MULTIBYTE_CHAR (struct buffer *buf, ptrdiff_t pos)
1212 unsigned char *p
1213 = ((pos >= BUF_GPT_BYTE (buf) ? BUF_GAP_SIZE (buf) : 0)
1214 + pos + BUF_BEG_ADDR (buf) - BEG_BYTE);
1215 return STRING_CHAR (p);
1218 /* Return number of windows showing B. */
1220 INLINE int
1221 buffer_window_count (struct buffer *b)
1223 if (b->base_buffer)
1224 b = b->base_buffer;
1225 eassert (b->window_count >= 0);
1226 return b->window_count;
1229 /* Overlays */
1231 /* Return the marker that stands for where OV starts in the buffer. */
1233 #define OVERLAY_START(OV) XOVERLAY (OV)->start
1235 /* Return the marker that stands for where OV ends in the buffer. */
1237 #define OVERLAY_END(OV) XOVERLAY (OV)->end
1239 /* Return the plist of overlay OV. */
1241 #define OVERLAY_PLIST(OV) XOVERLAY (OV)->plist
1243 /* Return the actual buffer position for the marker P.
1244 We assume you know which buffer it's pointing into. */
1246 #define OVERLAY_POSITION(P) \
1247 (MARKERP (P) ? marker_position (P) : (emacs_abort (), 0))
1250 /***********************************************************************
1251 Buffer-local Variables
1252 ***********************************************************************/
1254 /* Number of per-buffer variables used. */
1256 extern int last_per_buffer_idx;
1258 /* Return the offset in bytes of member VAR of struct buffer
1259 from the start of a buffer structure. */
1261 #define PER_BUFFER_VAR_OFFSET(VAR) \
1262 offsetof (struct buffer, VAR ## _)
1264 /* Used to iterate over normal Lisp_Object fields of struct buffer (all
1265 Lisp_Objects except undo_list). If you add, remove, or reorder
1266 Lisp_Objects in a struct buffer, make sure that this is still correct. */
1268 #define FOR_EACH_PER_BUFFER_OBJECT_AT(offset) \
1269 for (offset = PER_BUFFER_VAR_OFFSET (name); \
1270 offset <= PER_BUFFER_VAR_OFFSET (cursor_in_non_selected_windows); \
1271 offset += word_size)
1273 /* Return the index of buffer-local variable VAR. Each per-buffer
1274 variable has an index > 0 associated with it, except when it always
1275 has buffer-local values, in which case the index is -1. If this is
1276 0, this is a bug and means that the slot of VAR in
1277 buffer_local_flags wasn't initialized. */
1279 #define PER_BUFFER_VAR_IDX(VAR) \
1280 PER_BUFFER_IDX (PER_BUFFER_VAR_OFFSET (VAR))
1282 /* Value is true if the variable with index IDX has a local value
1283 in buffer B. */
1285 #define PER_BUFFER_VALUE_P(B, IDX) \
1286 (((IDX) < 0 || IDX >= last_per_buffer_idx) \
1287 ? (emacs_abort (), false) \
1288 : ((B)->local_flags[IDX] != 0))
1290 /* Set whether per-buffer variable with index IDX has a buffer-local
1291 value in buffer B. VAL zero means it hasn't. */
1293 #define SET_PER_BUFFER_VALUE_P(B, IDX, VAL) \
1294 do { \
1295 if ((IDX) < 0 || (IDX) >= last_per_buffer_idx) \
1296 emacs_abort (); \
1297 (B)->local_flags[IDX] = (VAL); \
1298 } while (false)
1300 /* Return the index value of the per-buffer variable at offset OFFSET
1301 in the buffer structure.
1303 If the slot OFFSET has a corresponding default value in
1304 buffer_defaults, the index value is positive and has only one
1305 nonzero bit. When a buffer has its own local value for a slot, the
1306 bit for that slot (found in the same slot in this structure) is
1307 turned on in the buffer's local_flags array.
1309 If the index value is -1, even though there may be a
1310 DEFVAR_PER_BUFFER for the slot, there is no default value for it;
1311 and the corresponding slot in buffer_defaults is not used.
1313 If the index value is -2, then there is no DEFVAR_PER_BUFFER for
1314 the slot, but there is a default value which is copied into each
1315 new buffer.
1317 If a slot in this structure corresponding to a DEFVAR_PER_BUFFER is
1318 zero, that is a bug */
1321 #define PER_BUFFER_IDX(OFFSET) \
1322 XINT (*(Lisp_Object *)((OFFSET) + (char *) &buffer_local_flags))
1324 /* Functions to get and set default value of the per-buffer
1325 variable at offset OFFSET in the buffer structure. */
1327 INLINE Lisp_Object
1328 per_buffer_default (int offset)
1330 return *(Lisp_Object *)(offset + (char *) &buffer_defaults);
1333 INLINE void
1334 set_per_buffer_default (int offset, Lisp_Object value)
1336 *(Lisp_Object *)(offset + (char *) &buffer_defaults) = value;
1339 /* Functions to get and set buffer-local value of the per-buffer
1340 variable at offset OFFSET in the buffer structure. */
1342 INLINE Lisp_Object
1343 per_buffer_value (struct buffer *b, int offset)
1345 return *(Lisp_Object *)(offset + (char *) b);
1348 INLINE void
1349 set_per_buffer_value (struct buffer *b, int offset, Lisp_Object value)
1351 *(Lisp_Object *)(offset + (char *) b) = value;
1354 /* Downcase a character C, or make no change if that cannot be done. */
1355 INLINE int
1356 downcase (int c)
1358 Lisp_Object downcase_table = BVAR (current_buffer, downcase_table);
1359 Lisp_Object down = CHAR_TABLE_REF (downcase_table, c);
1360 return NATNUMP (down) ? XFASTINT (down) : c;
1363 /* True if C is upper case. */
1364 INLINE bool uppercasep (int c) { return downcase (c) != c; }
1366 /* Upcase a character C known to be not upper case. */
1367 INLINE int
1368 upcase1 (int c)
1370 Lisp_Object upcase_table = BVAR (current_buffer, upcase_table);
1371 Lisp_Object up = CHAR_TABLE_REF (upcase_table, c);
1372 return NATNUMP (up) ? XFASTINT (up) : c;
1375 /* True if C is lower case. */
1376 INLINE bool
1377 lowercasep (int c)
1379 return !uppercasep (c) && upcase1 (c) != c;
1382 /* Upcase a character C, or make no change if that cannot be done. */
1383 INLINE int upcase (int c) { return uppercasep (c) ? c : upcase1 (c); }
1385 INLINE_HEADER_END
1387 #endif /* EMACS_BUFFER_H */