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 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
23 /* Accessing the parameters of the current buffer. */
25 /* These macros come in pairs, one for the char position
26 and one for the byte position. */
28 /* Position of beginning of buffer. */
30 #define BEG_BYTE (BEG)
32 /* Position of beginning of accessible range of buffer. */
33 #define BEGV (current_buffer->begv)
34 #define BEGV_BYTE (current_buffer->begv_byte)
36 /* Position of point in buffer. The "+ 0" makes this
37 not an l-value, so you can't assign to it. Use SET_PT instead. */
38 #define PT (current_buffer->pt + 0)
39 #define PT_BYTE (current_buffer->pt_byte + 0)
41 /* Position of gap in buffer. */
42 #define GPT (current_buffer->text->gpt)
43 #define GPT_BYTE (current_buffer->text->gpt_byte)
45 /* Position of end of accessible range of buffer. */
46 #define ZV (current_buffer->zv)
47 #define ZV_BYTE (current_buffer->zv_byte)
49 /* Position of end of buffer. */
50 #define Z (current_buffer->text->z)
51 #define Z_BYTE (current_buffer->text->z_byte)
53 /* Macros for the addresses of places in the buffer. */
55 /* Address of beginning of buffer. */
56 #define BEG_ADDR (current_buffer->text->beg)
58 /* Address of beginning of accessible range of buffer. */
59 #define BEGV_ADDR (BYTE_POS_ADDR (current_buffer->begv_byte))
61 /* Address of point in buffer. */
62 #define PT_ADDR (BYTE_POS_ADDR (current_buffer->pt_byte))
64 /* Address of beginning of gap in buffer. */
65 #define GPT_ADDR (current_buffer->text->beg + current_buffer->text->gpt_byte - BEG_BYTE)
67 /* Address of end of gap in buffer. */
68 #define GAP_END_ADDR (current_buffer->text->beg + current_buffer->text->gpt_byte + current_buffer->text->gap_size - BEG_BYTE)
70 /* Address of end of accessible range of buffer. */
71 #define ZV_ADDR (BYTE_POS_ADDR (current_buffer->zv_byte))
73 /* Address of end of buffer. */
74 #define Z_ADDR (current_buffer->text->beg + current_buffer->text->gap_size + current_buffer->text->z_byte - BEG_BYTE)
77 #define GAP_SIZE (current_buffer->text->gap_size)
79 /* Is the current buffer narrowed? */
80 #define NARROWED ((BEGV != BEG) || (ZV != Z))
82 /* Modification count. */
83 #define MODIFF (current_buffer->text->modiff)
85 /* Character modification count. */
86 #define CHARS_MODIFF (current_buffer->text->chars_modiff)
88 /* Overlay modification count. */
89 #define OVERLAY_MODIFF (current_buffer->text->overlay_modiff)
91 /* Modification count as of last visit or save. */
92 #define SAVE_MODIFF (current_buffer->text->save_modiff)
94 /* BUFFER_CEILING_OF (resp. BUFFER_FLOOR_OF), when applied to n, return
95 the max (resp. min) p such that
97 BYTE_POS_ADDR (p) - BYTE_POS_ADDR (n) == p - n */
99 #define BUFFER_CEILING_OF(BYTEPOS) \
100 (((BYTEPOS) < GPT_BYTE && GPT < ZV ? GPT_BYTE : ZV_BYTE) - 1)
101 #define BUFFER_FLOOR_OF(BYTEPOS) \
102 (BEGV <= GPT && GPT_BYTE <= (BYTEPOS) ? GPT_BYTE : BEGV_BYTE)
104 /* Similar macros to operate on a specified buffer.
105 Note that many of these evaluate the buffer argument more than once. */
107 /* Position of beginning of buffer. */
108 #define BUF_BEG(buf) (BEG)
109 #define BUF_BEG_BYTE(buf) (BEG_BYTE)
111 /* Position of beginning of accessible range of buffer. */
112 #define BUF_BEGV(buf) ((buf)->begv)
113 #define BUF_BEGV_BYTE(buf) ((buf)->begv_byte)
115 /* Position of point in buffer. */
116 #define BUF_PT(buf) ((buf)->pt)
117 #define BUF_PT_BYTE(buf) ((buf)->pt_byte)
119 /* Position of gap in buffer. */
120 #define BUF_GPT(buf) ((buf)->text->gpt)
121 #define BUF_GPT_BYTE(buf) ((buf)->text->gpt_byte)
123 /* Position of end of accessible range of buffer. */
124 #define BUF_ZV(buf) ((buf)->zv)
125 #define BUF_ZV_BYTE(buf) ((buf)->zv_byte)
127 /* Position of end of buffer. */
128 #define BUF_Z(buf) ((buf)->text->z)
129 #define BUF_Z_BYTE(buf) ((buf)->text->z_byte)
131 /* Address of beginning of buffer. */
132 #define BUF_BEG_ADDR(buf) ((buf)->text->beg)
134 /* Address of beginning of gap of buffer. */
135 #define BUF_GPT_ADDR(buf) ((buf)->text->beg + (buf)->text->gpt_byte - BEG_BYTE)
137 /* Address of end of buffer. */
138 #define BUF_Z_ADDR(buf) ((buf)->text->beg + (buf)->text->gap_size + (buf)->text->z_byte - BEG_BYTE)
140 /* Address of end of gap in buffer. */
141 #define BUF_GAP_END_ADDR(buf) ((buf)->text->beg + (buf)->text->gpt_byte + (buf)->text->gap_size - BEG_BYTE)
144 #define BUF_GAP_SIZE(buf) ((buf)->text->gap_size)
146 /* Is this buffer narrowed? */
147 #define BUF_NARROWED(buf) ((BUF_BEGV (buf) != BUF_BEG (buf)) \
148 || (BUF_ZV (buf) != BUF_Z (buf)))
150 /* Modification count. */
151 #define BUF_MODIFF(buf) ((buf)->text->modiff)
153 /* Character modification count. */
154 #define BUF_CHARS_MODIFF(buf) ((buf)->text->chars_modiff)
156 /* Modification count as of last visit or save. */
157 #define BUF_SAVE_MODIFF(buf) ((buf)->text->save_modiff)
159 /* Overlay modification count. */
160 #define BUF_OVERLAY_MODIFF(buf) ((buf)->text->overlay_modiff)
162 /* Interval tree of buffer. */
163 #define BUF_INTERVALS(buf) ((buf)->text->intervals)
165 /* Marker chain of buffer. */
166 #define BUF_MARKERS(buf) ((buf)->text->markers)
168 #define BUF_UNCHANGED_MODIFIED(buf) \
169 ((buf)->text->unchanged_modified)
171 #define BUF_OVERLAY_UNCHANGED_MODIFIED(buf) \
172 ((buf)->text->overlay_unchanged_modified)
173 #define BUF_BEG_UNCHANGED(buf) ((buf)->text->beg_unchanged)
174 #define BUF_END_UNCHANGED(buf) ((buf)->text->end_unchanged)
176 #define UNCHANGED_MODIFIED \
177 BUF_UNCHANGED_MODIFIED (current_buffer)
178 #define OVERLAY_UNCHANGED_MODIFIED \
179 BUF_OVERLAY_UNCHANGED_MODIFIED (current_buffer)
180 #define BEG_UNCHANGED BUF_BEG_UNCHANGED (current_buffer)
181 #define END_UNCHANGED BUF_END_UNCHANGED (current_buffer)
183 /* Compute how many characters at the top and bottom of BUF are
184 unchanged when the range START..END is modified. This computation
185 must be done each time BUF is modified. */
187 #define BUF_COMPUTE_UNCHANGED(buf, start, end) \
190 if (BUF_UNCHANGED_MODIFIED (buf) == BUF_MODIFF (buf) \
191 && (BUF_OVERLAY_UNCHANGED_MODIFIED (buf) \
192 == BUF_OVERLAY_MODIFF (buf))) \
194 BUF_BEG_UNCHANGED (buf) = (start) - BUF_BEG (buf); \
195 BUF_END_UNCHANGED (buf) = BUF_Z (buf) - (end); \
199 if (BUF_Z (buf) - (end) < BUF_END_UNCHANGED (buf)) \
200 BUF_END_UNCHANGED (buf) = BUF_Z (buf) - (end); \
201 if ((start) - BUF_BEG (buf) < BUF_BEG_UNCHANGED (buf)) \
202 BUF_BEG_UNCHANGED (buf) = (start) - BUF_BEG (buf); \
208 /* Macros to set PT in the current buffer, or another buffer. */
210 #define SET_PT(position) (set_point (current_buffer, (position)))
211 #define TEMP_SET_PT(position) (temp_set_point (current_buffer, (position)))
213 #define SET_PT_BOTH(position, byte) \
214 (set_point_both (current_buffer, (position), (byte)))
215 #define TEMP_SET_PT_BOTH(position, byte) \
216 (temp_set_point_both (current_buffer, (position), (byte)))
218 #define BUF_SET_PT(buffer, position) \
219 (set_point ((buffer), (position)))
220 #define BUF_TEMP_SET_PT(buffer, position) \
221 (temp_set_point ((buffer), (position)))
223 extern void set_point
P_ ((struct buffer
*, int));
224 extern INLINE
void temp_set_point
P_ ((struct buffer
*, int));
225 extern void set_point_both
P_ ((struct buffer
*, int, int));
226 extern INLINE
void temp_set_point_both
P_ ((struct buffer
*, int, int));
227 extern void enlarge_buffer_text
P_ ((struct buffer
*, int));
230 /* Macros for setting the BEGV, ZV or PT of a given buffer.
232 SET_BUF_PT* seet to be redundant. Get rid of them?
234 The ..._BOTH macros take both a charpos and a bytepos,
235 which must correspond to each other.
237 The macros without ..._BOTH take just a charpos,
238 and compute the bytepos from it. */
240 #define SET_BUF_BEGV(buf, charpos) \
241 ((buf)->begv_byte = buf_charpos_to_bytepos ((buf), (charpos)), \
242 (buf)->begv = (charpos))
244 #define SET_BUF_ZV(buf, charpos) \
245 ((buf)->zv_byte = buf_charpos_to_bytepos ((buf), (charpos)), \
246 (buf)->zv = (charpos))
248 #define SET_BUF_BEGV_BOTH(buf, charpos, byte) \
249 ((buf)->begv = (charpos), \
250 (buf)->begv_byte = (byte))
252 #define SET_BUF_ZV_BOTH(buf, charpos, byte) \
253 ((buf)->zv = (charpos), \
254 (buf)->zv_byte = (byte))
256 #define SET_BUF_PT_BOTH(buf, charpos, byte) \
257 ((buf)->pt = (charpos), \
258 (buf)->pt_byte = (byte))
260 /* Macros to access a character or byte in the current buffer,
261 or convert between a byte position and an address.
262 These macros do not check that the position is in range. */
264 /* Access a Lisp position value in POS,
265 and store the charpos in CHARPOS and the bytepos in BYTEPOS. */
267 #define DECODE_POSITION(charpos, bytepos, pos) \
270 Lisp_Object __pos = (pos); \
271 if (NUMBERP (__pos)) \
274 bytepos = buf_charpos_to_bytepos (current_buffer, __pos); \
276 else if (MARKERP (__pos)) \
278 charpos = marker_position (__pos); \
279 bytepos = marker_byte_position (__pos); \
282 wrong_type_argument (Qinteger_or_marker_p, __pos); \
286 /* Return the address of byte position N in current buffer. */
288 #define BYTE_POS_ADDR(n) \
289 (((n) >= GPT_BYTE ? GAP_SIZE : 0) + (n) + BEG_ADDR - BEG_BYTE)
291 /* Return the address of char position N. */
293 #define CHAR_POS_ADDR(n) \
294 (((n) >= GPT ? GAP_SIZE : 0) \
295 + buf_charpos_to_bytepos (current_buffer, n) \
296 + BEG_ADDR - BEG_BYTE)
298 /* Convert a character position to a byte position. */
300 #define CHAR_TO_BYTE(charpos) \
301 (buf_charpos_to_bytepos (current_buffer, charpos))
303 /* Convert a byte position to a character position. */
305 #define BYTE_TO_CHAR(bytepos) \
306 (buf_bytepos_to_charpos (current_buffer, bytepos))
308 /* Convert PTR, the address of a byte in the buffer, into a byte position. */
310 #define PTR_BYTE_POS(ptr) \
311 ((ptr) - (current_buffer)->text->beg \
312 - (ptr - (current_buffer)->text->beg <= (unsigned) (GPT_BYTE - BEG_BYTE) ? 0 : GAP_SIZE) \
315 /* Return character at position POS. */
317 #define FETCH_CHAR(pos) \
318 (!NILP (current_buffer->enable_multibyte_characters) \
319 ? FETCH_MULTIBYTE_CHAR ((pos)) \
320 : FETCH_BYTE ((pos)))
322 /* Return the byte at byte position N. */
324 #define FETCH_BYTE(n) *(BYTE_POS_ADDR ((n)))
326 /* Variables used locally in FETCH_MULTIBYTE_CHAR. */
327 extern unsigned char *_fetch_multibyte_char_p
;
329 /* Return character code of multi-byte form at position POS. If POS
330 doesn't point the head of valid multi-byte form, only the byte at
331 POS is returned. No range checking. */
333 #define FETCH_MULTIBYTE_CHAR(pos) \
334 (_fetch_multibyte_char_p = (((pos) >= GPT_BYTE ? GAP_SIZE : 0) \
335 + (pos) + BEG_ADDR - BEG_BYTE), \
336 STRING_CHAR (_fetch_multibyte_char_p, 0))
338 /* Return character at position POS. If the current buffer is unibyte
339 and the character is not ASCII, make the returning character
342 #define FETCH_CHAR_AS_MULTIBYTE(pos) \
343 (!NILP (current_buffer->enable_multibyte_characters) \
344 ? FETCH_MULTIBYTE_CHAR ((pos)) \
345 : unibyte_char_to_multibyte (FETCH_BYTE ((pos))))
348 /* Macros for accessing a character or byte,
349 or converting between byte positions and addresses,
350 in a specified buffer. */
352 /* Return the address of character at byte position POS in buffer BUF.
353 Note that both arguments can be computed more than once. */
355 #define BUF_BYTE_ADDRESS(buf, pos) \
356 ((buf)->text->beg + (pos) - BEG_BYTE \
357 + ((pos) >= (buf)->text->gpt_byte ? (buf)->text->gap_size : 0))
359 /* Return the address of character at char position POS in buffer BUF.
360 Note that both arguments can be computed more than once. */
362 #define BUF_CHAR_ADDRESS(buf, pos) \
363 ((buf)->text->beg + buf_charpos_to_bytepos ((buf), (pos)) - BEG_BYTE \
364 + ((pos) >= (buf)->text->gpt ? (buf)->text->gap_size : 0))
366 /* Convert PTR, the address of a char in buffer BUF,
367 into a character position. */
369 #define BUF_PTR_BYTE_POS(buf, ptr) \
370 ((ptr) - (buf)->text->beg \
371 - (ptr - (buf)->text->beg <= (unsigned) (BUF_GPT_BYTE ((buf)) - BEG_BYTE)\
372 ? 0 : BUF_GAP_SIZE ((buf))) \
375 /* Return the character at byte position POS in buffer BUF. */
377 #define BUF_FETCH_CHAR(buf, pos) \
378 (!NILP (buf->enable_multibyte_characters) \
379 ? BUF_FETCH_MULTIBYTE_CHAR ((buf), (pos)) \
380 : BUF_FETCH_BYTE ((buf), (pos)))
382 /* Return the byte at byte position N in buffer BUF. */
384 #define BUF_FETCH_BYTE(buf, n) \
385 *(BUF_BYTE_ADDRESS ((buf), (n)))
387 /* Return character code of multi-byte form at byte position POS in BUF.
388 If POS doesn't point the head of valid multi-byte form, only the byte at
389 POS is returned. No range checking. */
391 #define BUF_FETCH_MULTIBYTE_CHAR(buf, pos) \
392 (_fetch_multibyte_char_p \
393 = (((pos) >= BUF_GPT_BYTE (buf) ? BUF_GAP_SIZE (buf) : 0) \
394 + (pos) + BUF_BEG_ADDR (buf) - BEG_BYTE), \
395 STRING_CHAR (_fetch_multibyte_char_p, 0))
397 /* Define the actual buffer data structures. */
399 /* This data structure describes the actual text contents of a buffer.
400 It is shared between indirect buffers and their base buffer. */
404 /* Actual address of buffer contents. If REL_ALLOC is defined,
405 this address might change when blocks are relocated which can
406 e.g. happen when malloc is called. So, don't pass a pointer
407 into a buffer's text to functions that malloc. */
410 EMACS_INT gpt
; /* Char pos of gap in buffer. */
411 EMACS_INT z
; /* Char pos of end of buffer. */
412 EMACS_INT gpt_byte
; /* Byte pos of gap in buffer. */
413 EMACS_INT z_byte
; /* Byte pos of end of buffer. */
414 EMACS_INT gap_size
; /* Size of buffer's gap. */
415 int modiff
; /* This counts buffer-modification events
416 for this buffer. It is incremented for
417 each such event, and never otherwise
419 int chars_modiff
; /* This is modified with character change
420 events for this buffer. It is set to
421 modiff for each such event, and never
422 otherwise changed. */
423 int save_modiff
; /* Previous value of modiff, as of last
424 time buffer visited or saved a file. */
426 int overlay_modiff
; /* Counts modifications to overlays. */
428 /* Minimum value of GPT - BEG since last redisplay that finished. */
429 EMACS_INT beg_unchanged
;
431 /* Minimum value of Z - GPT since last redisplay that finished. */
432 EMACS_INT end_unchanged
;
434 /* MODIFF as of last redisplay that finished; if it matches MODIFF,
435 beg_unchanged and end_unchanged contain no useful information. */
436 int unchanged_modified
;
438 /* BUF_OVERLAY_MODIFF of current buffer, as of last redisplay that
439 finished; if it matches BUF_OVERLAY_MODIFF, beg_unchanged and
440 end_unchanged contain no useful information. */
441 int overlay_unchanged_modified
;
443 /* Properties of this buffer's text. */
446 /* The markers that refer to this buffer.
447 This is actually a single marker ---
448 successive elements in its marker `chain'
449 are the other markers referring to this buffer. */
450 struct Lisp_Marker
*markers
;
452 /* Usually 0. Temporarily set to 1 in decode_coding_gap to
453 prevent Fgarbage_collect from shrinking the gap and loosing
454 not-yet-decoded bytes. */
455 int inhibit_shrinking
;
458 /* This is the structure that the buffer Lisp object points to. */
462 /* Everything before the `name' slot must be of a non-Lisp_Object type,
463 and every slot after `name' must be a Lisp_Object.
465 Check out mark_buffer (alloc.c) to see why. */
469 /* Next buffer, in chain of all buffers including killed buffers.
470 This chain is used only for garbage collection, in order to
471 collect killed buffers properly.
472 Note that vectors and most pseudovectors are all on one chain,
473 but buffers are on a separate chain of their own. */
476 /* This structure holds the coordinates of the buffer contents
477 in ordinary buffers. In indirect buffers, this is not used. */
478 struct buffer_text own_text
;
480 /* This points to the `struct buffer_text' that used for this buffer.
481 In an ordinary buffer, this is the own_text field above.
482 In an indirect buffer, this is the own_text field of another buffer. */
483 struct buffer_text
*text
;
485 /* Char position of point in buffer. */
487 /* Byte position of point in buffer. */
489 /* Char position of beginning of accessible range. */
491 /* Byte position of beginning of accessible range. */
493 /* Char position of end of accessible range. */
495 /* Byte position of end of accessible range. */
498 /* In an indirect buffer, this points to the base buffer.
499 In an ordinary buffer, it is 0. */
500 struct buffer
*base_buffer
;
502 /* A non-zero value in slot IDX means that per-buffer variable
503 with index IDX has a local value in this buffer. The index IDX
504 for a buffer-local variable is stored in that variable's slot
505 in buffer_local_flags as a Lisp integer. If the index is -1,
506 this means the variable is always local in all buffers. */
507 #define MAX_PER_BUFFER_VARS 50
508 char local_flags
[MAX_PER_BUFFER_VARS
];
510 /* Set to the modtime of the visited file when read or written.
511 -1 means visited file was nonexistent.
512 0 means visited file modtime unknown; in no case complain
513 about any mismatch on next save attempt. */
515 /* The value of text->modiff at the last auto-save. */
516 int auto_save_modified
;
517 /* The value of text->modiff at the last display error.
518 Redisplay of this buffer is inhibited until it changes again. */
519 int display_error_modiff
;
520 /* The time at which we detected a failure to auto-save,
521 Or -1 if we didn't have a failure. */
522 int auto_save_failure_time
;
523 /* Position in buffer at which display started
524 the last time this buffer was displayed. */
525 EMACS_INT last_window_start
;
527 /* Set nonzero whenever the narrowing is changed in this buffer. */
530 /* If the long line scan cache is enabled (i.e. the buffer-local
531 variable cache-long-line-scans is non-nil), newline_cache
532 points to the newline cache, and width_run_cache points to the
535 The newline cache records which stretches of the buffer are
536 known *not* to contain newlines, so that they can be skipped
537 quickly when we search for newlines.
539 The width run cache records which stretches of the buffer are
540 known to contain characters whose widths are all the same. If
541 the width run cache maps a character to a value > 0, that value is
542 the character's width; if it maps a character to zero, we don't
543 know what its width is. This allows compute_motion to process
544 such regions very quickly, using algebra instead of inspecting
545 each character. See also width_table, below. */
546 struct region_cache
*newline_cache
;
547 struct region_cache
*width_run_cache
;
549 /* Non-zero means don't use redisplay optimizations for
550 displaying this buffer. */
551 unsigned prevent_redisplay_optimizations_p
: 1;
553 /* List of overlays that end at or before the current center,
554 in order of end-position. */
555 struct Lisp_Overlay
*overlays_before
;
557 /* List of overlays that end after the current center,
558 in order of start-position. */
559 struct Lisp_Overlay
*overlays_after
;
561 /* Position where the overlay lists are centered. */
562 EMACS_INT overlay_center
;
564 /* Everything from here down must be a Lisp_Object. */
566 /* The name of this buffer. */
569 /* The name of the file visited in this buffer, or nil. */
570 Lisp_Object filename
;
571 /* Dir for expanding relative file names. */
572 Lisp_Object directory
;
573 /* True if this buffer has been backed up (if you write to the
574 visited file and it hasn't been backed up, then a backup will
576 /* This isn't really used by the C code, so could be deleted. */
577 Lisp_Object backed_up
;
578 /* Length of file when last read or saved.
579 This is not in the struct buffer_text
580 because it's not used in indirect buffers at all. */
581 Lisp_Object save_length
;
582 /* File name used for auto-saving this buffer.
583 This is not in the struct buffer_text
584 because it's not used in indirect buffers at all. */
585 Lisp_Object auto_save_file_name
;
587 /* Non-nil if buffer read-only. */
588 Lisp_Object read_only
;
589 /* "The mark". This is a marker which may
590 point into this buffer or may point nowhere. */
593 /* Alist of elements (SYMBOL . VALUE-IN-THIS-BUFFER)
594 for all per-buffer variables of this buffer. */
595 Lisp_Object local_var_alist
;
597 /* Symbol naming major mode (eg, lisp-mode). */
598 Lisp_Object major_mode
;
599 /* Pretty name of major mode (eg, "Lisp"). */
600 Lisp_Object mode_name
;
601 /* Mode line element that controls format of mode line. */
602 Lisp_Object mode_line_format
;
604 /* Changes in the buffer are recorded here for undo.
605 t means don't record anything.
606 This information belongs to the base buffer of an indirect buffer,
607 But we can't store it in the struct buffer_text
608 because local variables have to be right in the struct buffer.
609 So we copy it around in set_buffer_internal.
610 This comes before `name' because it is marked in a special way. */
611 Lisp_Object undo_list
;
613 /* Analogous to mode_line_format for the line displayed at the top
614 of windows. Nil means don't display that line. */
615 Lisp_Object header_line_format
;
617 /* Keys that are bound local to this buffer. */
619 /* This buffer's local abbrev table. */
620 Lisp_Object abbrev_table
;
621 /* This buffer's syntax table. */
622 Lisp_Object syntax_table
;
623 /* This buffer's category table. */
624 Lisp_Object category_table
;
626 /* Values of several buffer-local variables. */
627 /* tab-width is buffer-local so that redisplay can find it
628 in buffers that are not current. */
629 Lisp_Object case_fold_search
;
630 Lisp_Object tab_width
;
631 Lisp_Object fill_column
;
632 Lisp_Object left_margin
;
633 /* Function to call when insert space past fill column. */
634 Lisp_Object auto_fill_function
;
635 /* nil: text, t: binary.
636 This value is meaningful only on certain operating systems. */
637 /* Actually, we don't need this flag any more because end-of-line
638 is handled correctly according to the buffer-file-coding-system
639 of the buffer. Just keeping it for backward compatibility. */
640 Lisp_Object buffer_file_type
;
642 /* Case table for case-conversion in this buffer.
643 This char-table maps each char into its lower-case version. */
644 Lisp_Object downcase_table
;
645 /* Char-table mapping each char to its upper-case version. */
646 Lisp_Object upcase_table
;
647 /* Char-table for conversion for case-folding search. */
648 Lisp_Object case_canon_table
;
649 /* Char-table of equivalences for case-folding search. */
650 Lisp_Object case_eqv_table
;
652 /* Non-nil means do not display continuation lines. */
653 Lisp_Object truncate_lines
;
654 /* Non-nil means display ctl chars with uparrow. */
655 Lisp_Object ctl_arrow
;
656 /* Non-nil means display text from right to left. */
657 Lisp_Object direction_reversed
;
658 /* Non-nil means do selective display;
659 see doc string in syms_of_buffer (buffer.c) for details. */
660 Lisp_Object selective_display
;
662 /* Non-nil means show ... at end of line followed by invisible lines. */
663 Lisp_Object selective_display_ellipses
;
665 /* Alist of (FUNCTION . STRING) for each minor mode enabled in buffer. */
666 Lisp_Object minor_modes
;
667 /* t if "self-insertion" should overwrite; `binary' if it should also
668 overwrite newlines and tabs - for editing executables and the like. */
669 Lisp_Object overwrite_mode
;
670 /* non-nil means abbrev mode is on. Expand abbrevs automatically. */
671 Lisp_Object abbrev_mode
;
672 /* Display table to use for text in this buffer. */
673 Lisp_Object display_table
;
674 /* t means the mark and region are currently active. */
675 Lisp_Object mark_active
;
677 /* Non-nil means the buffer contents are regarded as multi-byte
678 form of characters, not a binary code. */
679 Lisp_Object enable_multibyte_characters
;
681 /* Coding system to be used for encoding the buffer contents on
683 Lisp_Object buffer_file_coding_system
;
685 /* List of symbols naming the file format used for visited file. */
686 Lisp_Object file_format
;
688 /* List of symbols naming the file format used for auto-save file. */
689 Lisp_Object auto_save_file_format
;
691 /* True if the newline position cache and width run cache are
692 enabled. See search.c and indent.c. */
693 Lisp_Object cache_long_line_scans
;
695 /* If the width run cache is enabled, this table contains the
696 character widths width_run_cache (see above) assumes. When we
697 do a thorough redisplay, we compare this against the buffer's
698 current display table to see whether the display table has
699 affected the widths of any characters. If it has, we
700 invalidate the width run cache, and re-initialize width_table. */
701 Lisp_Object width_table
;
703 /* In an indirect buffer, or a buffer that is the base of an
704 indirect buffer, this holds a marker that records
705 PT for this buffer when the buffer is not current. */
706 Lisp_Object pt_marker
;
708 /* In an indirect buffer, or a buffer that is the base of an
709 indirect buffer, this holds a marker that records
710 BEGV for this buffer when the buffer is not current. */
711 Lisp_Object begv_marker
;
713 /* In an indirect buffer, or a buffer that is the base of an
714 indirect buffer, this holds a marker that records
715 ZV for this buffer when the buffer is not current. */
716 Lisp_Object zv_marker
;
718 /* This holds the point value before the last scroll operation.
719 Explicitly setting point sets this to nil. */
720 Lisp_Object point_before_scroll
;
722 /* Truename of the visited file, or nil. */
723 Lisp_Object file_truename
;
725 /* Invisibility spec of this buffer.
726 t => any non-nil `invisible' property means invisible.
727 A list => `invisible' property means invisible
728 if it is memq in that list. */
729 Lisp_Object invisibility_spec
;
731 /* This is the last window that was selected with this buffer in it,
732 or nil if that window no longer displays this buffer. */
733 Lisp_Object last_selected_window
;
735 /* Incremented each time the buffer is displayed in a window. */
736 Lisp_Object display_count
;
738 /* Widths of left and right marginal areas for windows displaying
740 Lisp_Object left_margin_cols
, right_margin_cols
;
742 /* Widths of left and right fringe areas for windows displaying
744 Lisp_Object left_fringe_width
, right_fringe_width
;
746 /* Non-nil means fringes are drawn outside display margins;
747 othersize draw them between margin areas and text. */
748 Lisp_Object fringes_outside_margins
;
750 /* Width and type of scroll bar areas for windows displaying
752 Lisp_Object scroll_bar_width
, vertical_scroll_bar_type
;
754 /* Non-nil means indicate lines not displaying text (in a style
756 Lisp_Object indicate_empty_lines
;
758 /* Non-nil means indicate buffer boundaries and scrolling. */
759 Lisp_Object indicate_buffer_boundaries
;
761 /* Logical to physical fringe bitmap mappings. */
762 Lisp_Object fringe_indicator_alist
;
764 /* Logical to physical cursor bitmap mappings. */
765 Lisp_Object fringe_cursor_alist
;
767 /* Time stamp updated each time this buffer is displayed in a window. */
768 Lisp_Object display_time
;
770 /* If scrolling the display because point is below the bottom of a
771 window showing this buffer, try to choose a window start so
772 that point ends up this number of lines from the top of the
773 window. Nil means that scrolling method isn't used. */
774 Lisp_Object scroll_up_aggressively
;
776 /* If scrolling the display because point is above the top of a
777 window showing this buffer, try to choose a window start so
778 that point ends up this number of lines from the bottom of the
779 window. Nil means that scrolling method isn't used. */
780 Lisp_Object scroll_down_aggressively
;
782 /* Desired cursor type in this buffer. See the doc string of
783 per-buffer variable `cursor-type'. */
784 Lisp_Object cursor_type
;
786 /* An integer > 0 means put that number of pixels below text lines
787 in the display of this buffer. */
788 Lisp_Object extra_line_spacing
;
790 /* *Cursor type to display in non-selected windows.
791 t means to use hollow box cursor.
792 See `cursor-type' for other values. */
793 Lisp_Object cursor_in_non_selected_windows
;
797 /* This points to the current buffer. */
799 extern struct buffer
*current_buffer
;
801 /* This structure holds the default values of the buffer-local variables
802 that have special slots in each buffer.
803 The default value occupies the same slot in this structure
804 as an individual buffer's value occupies in that buffer.
805 Setting the default value also goes through the alist of buffers
806 and stores into each buffer that does not say it has a local value. */
808 extern struct buffer buffer_defaults
;
810 /* This structure marks which slots in a buffer have corresponding
811 default values in buffer_defaults.
812 Each such slot has a nonzero value in this structure.
813 The value has only one nonzero bit.
815 When a buffer has its own local value for a slot,
816 the entry for that slot (found in the same slot in this structure)
817 is turned on in the buffer's local_flags array.
819 If a slot in this structure is zero, then even though there may
820 be a Lisp-level local variable for the slot, it has no default value,
821 and the corresponding slot in buffer_defaults is not used. */
823 extern struct buffer buffer_local_flags
;
825 /* For each buffer slot, this points to the Lisp symbol name
826 for that slot in the current buffer. It is 0 for slots
827 that don't have such names. */
829 extern struct buffer buffer_local_symbols
;
831 /* This structure holds the required types for the values in the
832 buffer-local slots. If a slot contains Qnil, then the
833 corresponding buffer slot may contain a value of any type. If a
834 slot contains an integer, then prospective values' tags must be
835 equal to that integer (except nil is always allowed).
836 When a tag does not match, the function
837 buffer_slot_type_mismatch will signal an error.
839 If a slot here contains -1, the corresponding variable is read-only. */
841 extern struct buffer buffer_local_types
;
843 extern void delete_all_overlays
P_ ((struct buffer
*));
844 extern void reset_buffer
P_ ((struct buffer
*));
845 extern void evaporate_overlays
P_ ((EMACS_INT
));
846 extern int overlays_at
P_ ((EMACS_INT
, int, Lisp_Object
**, int *, int *, int *, int));
847 extern int sort_overlays
P_ ((Lisp_Object
*, int, struct window
*));
848 extern void recenter_overlay_lists
P_ ((struct buffer
*, EMACS_INT
));
849 extern int overlay_strings
P_ ((EMACS_INT
, struct window
*, unsigned char **));
850 extern void validate_region
P_ ((Lisp_Object
*, Lisp_Object
*));
851 extern void set_buffer_internal
P_ ((struct buffer
*));
852 extern void set_buffer_internal_1
P_ ((struct buffer
*));
853 extern void set_buffer_temp
P_ ((struct buffer
*));
854 extern void record_buffer
P_ ((Lisp_Object
));
855 extern void buffer_slot_type_mismatch
P_ ((int)) NO_RETURN
;
856 extern void fix_overlays_before
P_ ((struct buffer
*, EMACS_INT
, EMACS_INT
));
857 extern void mmap_set_vars
P_ ((int));
859 /* Get overlays at POSN into array OVERLAYS with NOVERLAYS elements.
860 If NEXTP is non-NULL, return next overlay there.
861 See overlay_at arg CHANGE_REQ for meaning of CHRQ arg. */
863 #define GET_OVERLAYS_AT(posn, overlays, noverlays, nextp, chrq) \
866 overlays = (Lisp_Object *) alloca (maxlen * sizeof (Lisp_Object)); \
867 noverlays = overlays_at (posn, 0, &overlays, &maxlen, \
868 nextp, NULL, chrq); \
869 if (noverlays > maxlen) \
871 maxlen = noverlays; \
872 overlays = (Lisp_Object *) alloca (maxlen * sizeof (Lisp_Object)); \
873 noverlays = overlays_at (posn, 0, &overlays, &maxlen, \
874 nextp, NULL, chrq); \
878 EXFUN (Fbuffer_live_p
, 1);
879 EXFUN (Fbuffer_name
, 1);
880 EXFUN (Fget_file_buffer
, 1);
881 EXFUN (Fnext_overlay_change
, 1);
882 EXFUN (Fdelete_overlay
, 1);
883 EXFUN (Fbuffer_local_value
, 2);
884 EXFUN (Fgenerate_new_buffer_name
, 2);
886 /* Functions to call before and after each text change. */
887 extern Lisp_Object Vbefore_change_functions
;
888 extern Lisp_Object Vafter_change_functions
;
889 extern Lisp_Object Vfirst_change_hook
;
890 extern Lisp_Object Qbefore_change_functions
;
891 extern Lisp_Object Qafter_change_functions
;
892 extern Lisp_Object Qfirst_change_hook
;
894 /* If nonzero, all modification hooks are suppressed. */
895 extern int inhibit_modification_hooks
;
897 extern Lisp_Object Vdeactivate_mark
;
898 extern Lisp_Object Vtransient_mark_mode
;
902 /* 1 if the OV is an overlay object. */
904 #define OVERLAY_VALID(OV) (OVERLAYP (OV))
906 /* Return the marker that stands for where OV starts in the buffer. */
908 #define OVERLAY_START(OV) (XOVERLAY (OV)->start)
910 /* Return the marker that stands for where OV ends in the buffer. */
912 #define OVERLAY_END(OV) (XOVERLAY (OV)->end)
914 /* Return the plist of overlay OV. */
916 #define OVERLAY_PLIST(OV) XOVERLAY ((OV))->plist
918 /* Return the actual buffer position for the marker P.
919 We assume you know which buffer it's pointing into. */
921 #define OVERLAY_POSITION(P) \
922 (MARKERP (P) ? marker_position (P) : (abort (), 0))
925 /***********************************************************************
926 Buffer-local Variables
927 ***********************************************************************/
929 /* Number of per-buffer variables used. */
931 extern int last_per_buffer_idx
;
933 /* Return the offset in bytes of member VAR of struct buffer
934 from the start of a buffer structure. */
936 #define PER_BUFFER_VAR_OFFSET(VAR) \
937 ((char *) &buffer_local_flags.VAR - (char *) &buffer_local_flags)
939 /* Return the index of buffer-local variable VAR. Each per-buffer
940 variable has an index > 0 associated with it, except when it always
941 has buffer-local values, in which case the index is -1. If this is
942 0, this is a bug and means that the slot of VAR in
943 buffer_local_flags wasn't intiialized. */
945 #define PER_BUFFER_VAR_IDX(VAR) \
946 PER_BUFFER_IDX (PER_BUFFER_VAR_OFFSET (VAR))
948 /* Value is non-zero if the variable with index IDX has a local value
951 #define PER_BUFFER_VALUE_P(B, IDX) \
952 (((IDX) < 0 || IDX >= last_per_buffer_idx) \
954 : ((B)->local_flags[IDX] != 0))
956 /* Set whether per-buffer variable with index IDX has a buffer-local
957 value in buffer B. VAL zero means it hasn't. */
959 #define SET_PER_BUFFER_VALUE_P(B, IDX, VAL) \
961 if ((IDX) < 0 || (IDX) >= last_per_buffer_idx) \
963 (B)->local_flags[IDX] = (VAL); \
966 /* Return the index value of the per-buffer variable at offset OFFSET
967 in the buffer structure.
969 If the slot OFFSET has a corresponding default value in
970 buffer_defaults, the index value is positive and has only one
971 nonzero bit. When a buffer has its own local value for a slot, the
972 bit for that slot (found in the same slot in this structure) is
973 turned on in the buffer's local_flags array.
975 If the index value is -1, even though there may be a
976 DEFVAR_PER_BUFFER for the slot, there is no default value for it;
977 and the corresponding slot in buffer_defaults is not used.
979 If the index value is -2, then there is no DEFVAR_PER_BUFFER for
980 the slot, but there is a default value which is copied into each
983 If a slot in this structure corresponding to a DEFVAR_PER_BUFFER is
984 zero, that is a bug */
987 #define PER_BUFFER_IDX(OFFSET) \
988 XINT (*(Lisp_Object *)((OFFSET) + (char *) &buffer_local_flags))
990 /* Return the default value of the per-buffer variable at offset
991 OFFSET in the buffer structure. */
993 #define PER_BUFFER_DEFAULT(OFFSET) \
994 (*(Lisp_Object *)((OFFSET) + (char *) &buffer_defaults))
996 /* Return the buffer-local value of the per-buffer variable at offset
997 OFFSET in the buffer structure. */
999 #define PER_BUFFER_VALUE(BUFFER, OFFSET) \
1000 (*(Lisp_Object *)((OFFSET) + (char *) (BUFFER)))
1002 /* Return the symbol of the per-buffer variable at offset OFFSET in
1003 the buffer structure. */
1005 #define PER_BUFFER_SYMBOL(OFFSET) \
1006 (*(Lisp_Object *)((OFFSET) + (char *) &buffer_local_symbols))
1008 /* Return the type of the per-buffer variable at offset OFFSET in the
1009 buffer structure. */
1011 #define PER_BUFFER_TYPE(OFFSET) \
1012 (*(Lisp_Object *)((OFFSET) + (char *) &buffer_local_types))
1014 /* arch-tag: 679305dd-d41c-4a50-b170-3caf5c97b2d1
1015 (do not change this comment) */