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