1 /* Header file for the buffer manipulation primitives.
2 Copyright (C) 1985, 86, 93, 94, 95, 97, 1998, 1999, 2000, 01, 2003
3 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 2, 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., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, 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 /* Overlay modification count. */
86 #define OVERLAY_MODIFF (current_buffer->text->overlay_modiff)
88 /* Modification count as of last visit or save. */
89 #define SAVE_MODIFF (current_buffer->text->save_modiff)
91 /* BUFFER_CEILING_OF (resp. BUFFER_FLOOR_OF), when applied to n, return
92 the max (resp. min) p such that
94 BYTE_POS_ADDR (p) - BYTE_POS_ADDR (n) == p - n */
96 #define BUFFER_CEILING_OF(BYTEPOS) \
97 (((BYTEPOS) < GPT_BYTE && GPT < ZV ? GPT_BYTE : ZV_BYTE) - 1)
98 #define BUFFER_FLOOR_OF(BYTEPOS) \
99 (BEGV <= GPT && GPT_BYTE <= (BYTEPOS) ? GPT_BYTE : BEGV_BYTE)
101 /* Similar macros to operate on a specified buffer.
102 Note that many of these evaluate the buffer argument more than once. */
104 /* Position of beginning of buffer. */
105 #define BUF_BEG(buf) (BEG)
106 #define BUF_BEG_BYTE(buf) (BEG_BYTE)
108 /* Position of beginning of accessible range of buffer. */
109 #define BUF_BEGV(buf) ((buf)->begv)
110 #define BUF_BEGV_BYTE(buf) ((buf)->begv_byte)
112 /* Position of point in buffer. */
113 #define BUF_PT(buf) ((buf)->pt)
114 #define BUF_PT_BYTE(buf) ((buf)->pt_byte)
116 /* Position of gap in buffer. */
117 #define BUF_GPT(buf) ((buf)->text->gpt)
118 #define BUF_GPT_BYTE(buf) ((buf)->text->gpt_byte)
120 /* Position of end of accessible range of buffer. */
121 #define BUF_ZV(buf) ((buf)->zv)
122 #define BUF_ZV_BYTE(buf) ((buf)->zv_byte)
124 /* Position of end of buffer. */
125 #define BUF_Z(buf) ((buf)->text->z)
126 #define BUF_Z_BYTE(buf) ((buf)->text->z_byte)
128 /* Address of beginning of buffer. */
129 #define BUF_BEG_ADDR(buf) ((buf)->text->beg)
131 /* Address of beginning of gap of buffer. */
132 #define BUF_GPT_ADDR(buf) ((buf)->text->beg + (buf)->text->gpt_byte - BEG_BYTE)
134 /* Address of end of buffer. */
135 #define BUF_Z_ADDR(buf) ((buf)->text->beg + (buf)->text->gap_size + (buf)->text->z_byte - BEG_BYTE)
137 /* Address of end of gap in buffer. */
138 #define BUF_GAP_END_ADDR(buf) ((buf)->text->beg + (buf)->text->gpt_byte + (buf)->text->gap_size - BEG_BYTE)
141 #define BUF_GAP_SIZE(buf) ((buf)->text->gap_size)
143 /* Is this buffer narrowed? */
144 #define BUF_NARROWED(buf) ((BUF_BEGV (buf) != BUF_BEG (buf)) \
145 || (BUF_ZV (buf) != BUF_Z (buf)))
147 /* Modification count. */
148 #define BUF_MODIFF(buf) ((buf)->text->modiff)
150 /* Modification count as of last visit or save. */
151 #define BUF_SAVE_MODIFF(buf) ((buf)->text->save_modiff)
153 /* Overlay modification count. */
154 #define BUF_OVERLAY_MODIFF(buf) ((buf)->text->overlay_modiff)
156 /* Interval tree of buffer. */
157 #define BUF_INTERVALS(buf) ((buf)->text->intervals)
159 /* Marker chain of buffer. */
160 #define BUF_MARKERS(buf) ((buf)->text->markers)
162 #define BUF_UNCHANGED_MODIFIED(buf) \
163 ((buf)->text->unchanged_modified)
165 #define BUF_OVERLAY_UNCHANGED_MODIFIED(buf) \
166 ((buf)->text->overlay_unchanged_modified)
167 #define BUF_BEG_UNCHANGED(buf) ((buf)->text->beg_unchanged)
168 #define BUF_END_UNCHANGED(buf) ((buf)->text->end_unchanged)
170 #define UNCHANGED_MODIFIED \
171 BUF_UNCHANGED_MODIFIED (current_buffer)
172 #define OVERLAY_UNCHANGED_MODIFIED \
173 BUF_OVERLAY_UNCHANGED_MODIFIED (current_buffer)
174 #define BEG_UNCHANGED BUF_BEG_UNCHANGED (current_buffer)
175 #define END_UNCHANGED BUF_END_UNCHANGED (current_buffer)
177 /* Compute how many characters at the top and bottom of BUF are
178 unchanged when the range START..END is modified. This computation
179 must be done each time BUF is modified. */
181 #define BUF_COMPUTE_UNCHANGED(buf, start, end) \
184 if (BUF_UNCHANGED_MODIFIED (buf) == BUF_MODIFF (buf) \
185 && (BUF_OVERLAY_UNCHANGED_MODIFIED (buf) \
186 == BUF_OVERLAY_MODIFF (buf))) \
188 BUF_BEG_UNCHANGED (buf) = (start) - BUF_BEG (buf); \
189 BUF_END_UNCHANGED (buf) = BUF_Z (buf) - (end); \
193 if (BUF_Z (buf) - (end) < BUF_END_UNCHANGED (buf)) \
194 BUF_END_UNCHANGED (buf) = BUF_Z (buf) - (end); \
195 if ((start) - BUF_BEG (buf) < BUF_BEG_UNCHANGED (buf)) \
196 BUF_BEG_UNCHANGED (buf) = (start) - BUF_BEG (buf); \
202 /* Macros to set PT in the current buffer, or another buffer. */
204 #define SET_PT(position) (set_point (current_buffer, (position)))
205 #define TEMP_SET_PT(position) (temp_set_point (current_buffer, (position)))
207 #define SET_PT_BOTH(position, byte) \
208 (set_point_both (current_buffer, (position), (byte)))
209 #define TEMP_SET_PT_BOTH(position, byte) \
210 (temp_set_point_both (current_buffer, (position), (byte)))
212 #define BUF_SET_PT(buffer, position) \
213 (set_point ((buffer), (position)))
214 #define BUF_TEMP_SET_PT(buffer, position) \
215 (temp_set_point ((buffer), (position)))
217 extern void set_point
P_ ((struct buffer
*, int));
218 extern INLINE
void temp_set_point
P_ ((struct buffer
*, int));
219 extern void set_point_both
P_ ((struct buffer
*, int, int));
220 extern INLINE
void temp_set_point_both
P_ ((struct buffer
*, int, int));
221 extern void enlarge_buffer_text
P_ ((struct buffer
*, int));
224 /* Macros for setting the BEGV, ZV or PT of a given buffer.
226 SET_BUF_PT* seet to be redundant. Get rid of them?
228 The ..._BOTH macros take both a charpos and a bytepos,
229 which must correspond to each other.
231 The macros without ..._BOTH take just a charpos,
232 and compute the bytepos from it. */
234 #define SET_BUF_BEGV(buf, charpos) \
235 ((buf)->begv_byte = buf_charpos_to_bytepos ((buf), (charpos)), \
236 (buf)->begv = (charpos))
238 #define SET_BUF_ZV(buf, charpos) \
239 ((buf)->zv_byte = buf_charpos_to_bytepos ((buf), (charpos)), \
240 (buf)->zv = (charpos))
242 #define SET_BUF_BEGV_BOTH(buf, charpos, byte) \
243 ((buf)->begv = (charpos), \
244 (buf)->begv_byte = (byte))
246 #define SET_BUF_ZV_BOTH(buf, charpos, byte) \
247 ((buf)->zv = (charpos), \
248 (buf)->zv_byte = (byte))
250 #define SET_BUF_PT_BOTH(buf, charpos, byte) \
251 ((buf)->pt = (charpos), \
252 (buf)->pt_byte = (byte))
254 /* Macros to access a character or byte in the current buffer,
255 or convert between a byte position and an address.
256 These macros do not check that the position is in range. */
258 /* Access a Lisp position value in POS,
259 and store the charpos in CHARPOS and the bytepos in BYTEPOS. */
261 #define DECODE_POSITION(charpos, bytepos, pos) \
264 Lisp_Object __pos = (pos); \
265 if (NUMBERP (__pos)) \
268 bytepos = buf_charpos_to_bytepos (current_buffer, __pos); \
270 else if (MARKERP (__pos)) \
272 charpos = marker_position (__pos); \
273 bytepos = marker_byte_position (__pos); \
276 wrong_type_argument (Qinteger_or_marker_p, __pos); \
280 /* Return the address of byte position N in current buffer. */
282 #define BYTE_POS_ADDR(n) \
283 (((n) >= GPT_BYTE ? GAP_SIZE : 0) + (n) + BEG_ADDR - BEG_BYTE)
285 /* Return the address of char position N. */
287 #define CHAR_POS_ADDR(n) \
288 (((n) >= GPT ? GAP_SIZE : 0) \
289 + buf_charpos_to_bytepos (current_buffer, n) \
290 + BEG_ADDR - BEG_BYTE)
292 /* Convert a character position to a byte position. */
294 #define CHAR_TO_BYTE(charpos) \
295 (buf_charpos_to_bytepos (current_buffer, charpos))
297 /* Convert a byte position to a character position. */
299 #define BYTE_TO_CHAR(bytepos) \
300 (buf_bytepos_to_charpos (current_buffer, bytepos))
302 /* Convert PTR, the address of a byte in the buffer, into a byte position. */
304 #define PTR_BYTE_POS(ptr) \
305 ((ptr) - (current_buffer)->text->beg \
306 - (ptr - (current_buffer)->text->beg <= (unsigned) (GPT_BYTE - BEG_BYTE) ? 0 : GAP_SIZE) \
309 /* Return character at position POS. */
311 #define FETCH_CHAR(pos) \
312 (!NILP (current_buffer->enable_multibyte_characters) \
313 ? FETCH_MULTIBYTE_CHAR ((pos)) \
314 : FETCH_BYTE ((pos)))
316 /* Return the byte at byte position N. */
318 #define FETCH_BYTE(n) *(BYTE_POS_ADDR ((n)))
320 /* Variables used locally in FETCH_MULTIBYTE_CHAR. */
321 extern unsigned char *_fetch_multibyte_char_p
;
323 /* Return character code of multi-byte form at position POS. If POS
324 doesn't point the head of valid multi-byte form, only the byte at
325 POS is returned. No range checking. */
327 #define FETCH_MULTIBYTE_CHAR(pos) \
328 (_fetch_multibyte_char_p = (((pos) >= GPT_BYTE ? GAP_SIZE : 0) \
329 + (pos) + BEG_ADDR - BEG_BYTE), \
330 STRING_CHAR (_fetch_multibyte_char_p, 0))
332 /* Return character at position POS. If the current buffer is unibyte
333 and the character is not ASCII, make the returning character
336 #define FETCH_CHAR_AS_MULTIBYTE(pos) \
337 (!NILP (current_buffer->enable_multibyte_characters) \
338 ? FETCH_MULTIBYTE_CHAR ((pos)) \
339 : unibyte_char_to_multibyte (FETCH_BYTE ((pos))))
342 /* Macros for accessing a character or byte,
343 or converting between byte positions and addresses,
344 in a specified buffer. */
346 /* Return the address of character at byte position POS in buffer BUF.
347 Note that both arguments can be computed more than once. */
349 #define BUF_BYTE_ADDRESS(buf, pos) \
350 ((buf)->text->beg + (pos) - BEG_BYTE \
351 + ((pos) >= (buf)->text->gpt_byte ? (buf)->text->gap_size : 0))
353 /* Return the address of character at char position POS in buffer BUF.
354 Note that both arguments can be computed more than once. */
356 #define BUF_CHAR_ADDRESS(buf, pos) \
357 ((buf)->text->beg + buf_charpos_to_bytepos ((buf), (pos)) - BEG_BYTE \
358 + ((pos) >= (buf)->text->gpt ? (buf)->text->gap_size : 0))
360 /* Convert PTR, the address of a char in buffer BUF,
361 into a character position. */
363 #define BUF_PTR_BYTE_POS(buf, ptr) \
364 ((ptr) - (buf)->text->beg \
365 - (ptr - (buf)->text->beg <= (unsigned) (BUF_GPT_BYTE ((buf)) - BEG_BYTE)\
366 ? 0 : BUF_GAP_SIZE ((buf))) \
369 /* Return the character at byte position POS in buffer BUF. */
371 #define BUF_FETCH_CHAR(buf, pos) \
372 (!NILP (buf->enable_multibyte_characters) \
373 ? BUF_FETCH_MULTIBYTE_CHAR ((buf), (pos)) \
374 : BUF_FETCH_BYTE ((buf), (pos)))
376 /* Return the byte at byte position N in buffer BUF. */
378 #define BUF_FETCH_BYTE(buf, n) \
379 *(BUF_BYTE_ADDRESS ((buf), (n)))
381 /* Return character code of multi-byte form at byte position POS in BUF.
382 If POS doesn't point the head of valid multi-byte form, only the byte at
383 POS is returned. No range checking. */
385 #define BUF_FETCH_MULTIBYTE_CHAR(buf, pos) \
386 (_fetch_multibyte_char_p \
387 = (((pos) >= BUF_GPT_BYTE (buf) ? BUF_GAP_SIZE (buf) : 0) \
388 + (pos) + BUF_BEG_ADDR (buf) - BEG_BYTE), \
389 STRING_CHAR (_fetch_multibyte_char_p, 0))
391 /* Define the actual buffer data structures. */
393 /* This data structure describes the actual text contents of a buffer.
394 It is shared between indirect buffers and their base buffer. */
398 /* Actual address of buffer contents. If REL_ALLOC is defined,
399 this address might change when blocks are relocated which can
400 e.g. happen when malloc is called. So, don't pass a pointer
401 into a buffer's text to functions that malloc. */
404 EMACS_INT gpt
; /* Char pos of gap in buffer. */
405 EMACS_INT z
; /* Char pos of end of buffer. */
406 EMACS_INT gpt_byte
; /* Byte pos of gap in buffer. */
407 EMACS_INT z_byte
; /* Byte pos of end of buffer. */
408 EMACS_INT gap_size
; /* Size of buffer's gap. */
409 int modiff
; /* This counts buffer-modification events
410 for this buffer. It is incremented for
411 each such event, and never otherwise
413 int save_modiff
; /* Previous value of modiff, as of last
414 time buffer visited or saved a file. */
416 int overlay_modiff
; /* Counts modifications to overlays. */
418 /* Minimum value of GPT - BEG since last redisplay that finished. */
419 EMACS_INT beg_unchanged
;
421 /* Minimum value of Z - GPT since last redisplay that finished. */
422 EMACS_INT end_unchanged
;
424 /* MODIFF as of last redisplay that finished; if it matches MODIFF,
425 beg_unchanged and end_unchanged contain no useful information. */
426 int unchanged_modified
;
428 /* BUF_OVERLAY_MODIFF of current buffer, as of last redisplay that
429 finished; if it matches BUF_OVERLAY_MODIFF, beg_unchanged and
430 end_unchanged contain no useful information. */
431 int overlay_unchanged_modified
;
433 /* Properties of this buffer's text. */
436 /* The markers that refer to this buffer.
437 This is actually a single marker ---
438 successive elements in its marker `chain'
439 are the other markers referring to this buffer. */
440 struct Lisp_Marker
*markers
;
443 /* This is the structure that the buffer Lisp object points to. */
447 /* Everything before the `name' slot must be of a non-Lisp_Object type,
448 and every slot after `name' must be a Lisp_Object.
450 Check out mark_buffer (alloc.c) to see why. */
454 /* Next buffer, in chain of all buffers including killed buffers.
455 This chain is used only for garbage collection, in order to
456 collect killed buffers properly.
457 Note that vectors and most pseudovectors are all on one chain,
458 but buffers are on a separate chain of their own. */
461 /* This structure holds the coordinates of the buffer contents
462 in ordinary buffers. In indirect buffers, this is not used. */
463 struct buffer_text own_text
;
465 /* This points to the `struct buffer_text' that used for this buffer.
466 In an ordinary buffer, this is the own_text field above.
467 In an indirect buffer, this is the own_text field of another buffer. */
468 struct buffer_text
*text
;
470 /* Char position of point in buffer. */
472 /* Byte position of point in buffer. */
474 /* Char position of beginning of accessible range. */
476 /* Byte position of beginning of accessible range. */
478 /* Char position of end of accessible range. */
480 /* Byte position of end of accessible range. */
483 /* In an indirect buffer, this points to the base buffer.
484 In an ordinary buffer, it is 0. */
485 struct buffer
*base_buffer
;
487 /* A non-zero value in slot IDX means that per-buffer variable
488 with index IDX has a local value in this buffer. The index IDX
489 for a buffer-local variable is stored in that variable's slot
490 in buffer_local_flags as a Lisp integer. If the index is -1,
491 this means the variable is always local in all buffers. */
492 #define MAX_PER_BUFFER_VARS 50
493 char local_flags
[MAX_PER_BUFFER_VARS
];
495 /* Set to the modtime of the visited file when read or written.
496 -1 means visited file was nonexistent.
497 0 means visited file modtime unknown; in no case complain
498 about any mismatch on next save attempt. */
500 /* The value of text->modiff at the last auto-save. */
501 int auto_save_modified
;
502 /* The value of text->modiff at the last display error.
503 Redisplay of this buffer is inhibited until it changes again. */
504 int display_error_modiff
;
505 /* The time at which we detected a failure to auto-save,
506 Or -1 if we didn't have a failure. */
507 int auto_save_failure_time
;
508 /* Position in buffer at which display started
509 the last time this buffer was displayed. */
510 EMACS_INT last_window_start
;
512 /* Set nonzero whenever the narrowing is changed in this buffer. */
515 /* If the long line scan cache is enabled (i.e. the buffer-local
516 variable cache-long-line-scans is non-nil), newline_cache
517 points to the newline cache, and width_run_cache points to the
520 The newline cache records which stretches of the buffer are
521 known *not* to contain newlines, so that they can be skipped
522 quickly when we search for newlines.
524 The width run cache records which stretches of the buffer are
525 known to contain characters whose widths are all the same. If
526 the width run cache maps a character to a value > 0, that value is
527 the character's width; if it maps a character to zero, we don't
528 know what its width is. This allows compute_motion to process
529 such regions very quickly, using algebra instead of inspecting
530 each character. See also width_table, below. */
531 struct region_cache
*newline_cache
;
532 struct region_cache
*width_run_cache
;
534 /* Non-zero means don't use redisplay optimizations for
535 displaying this buffer. */
536 unsigned prevent_redisplay_optimizations_p
: 1;
538 /* List of overlays that end at or before the current center,
539 in order of end-position. */
540 struct Lisp_Overlay
*overlays_before
;
542 /* List of overlays that end after the current center,
543 in order of start-position. */
544 struct Lisp_Overlay
*overlays_after
;
546 /* Position where the overlay lists are centered. */
547 EMACS_INT overlay_center
;
549 /* Everything from here down must be a Lisp_Object. */
551 /* The name of this buffer. */
554 /* The name of the file visited in this buffer, or nil. */
555 Lisp_Object filename
;
556 /* Dir for expanding relative file names. */
557 Lisp_Object directory
;
558 /* True iff this buffer has been backed up (if you write to the
559 visited file and it hasn't been backed up, then a backup will
561 /* This isn't really used by the C code, so could be deleted. */
562 Lisp_Object backed_up
;
563 /* Length of file when last read or saved.
564 This is not in the struct buffer_text
565 because it's not used in indirect buffers at all. */
566 Lisp_Object save_length
;
567 /* File name used for auto-saving this buffer.
568 This is not in the struct buffer_text
569 because it's not used in indirect buffers at all. */
570 Lisp_Object auto_save_file_name
;
572 /* Non-nil if buffer read-only. */
573 Lisp_Object read_only
;
574 /* "The mark". This is a marker which may
575 point into this buffer or may point nowhere. */
578 /* Alist of elements (SYMBOL . VALUE-IN-THIS-BUFFER)
579 for all per-buffer variables of this buffer. */
580 Lisp_Object local_var_alist
;
582 /* Symbol naming major mode (eg, lisp-mode). */
583 Lisp_Object major_mode
;
584 /* Pretty name of major mode (eg, "Lisp"). */
585 Lisp_Object mode_name
;
586 /* Mode line element that controls format of mode line. */
587 Lisp_Object mode_line_format
;
589 /* Changes in the buffer are recorded here for undo.
590 t means don't record anything.
591 This information belongs to the base buffer of an indirect buffer,
592 But we can't store it in the struct buffer_text
593 because local variables have to be right in the struct buffer.
594 So we copy it around in set_buffer_internal.
595 This comes before `name' because it is marked in a special way. */
596 Lisp_Object undo_list
;
598 /* Analogous to mode_line_format for the line displayed at the top
599 of windows. Nil means don't display that line. */
600 Lisp_Object header_line_format
;
602 /* Keys that are bound local to this buffer. */
604 /* This buffer's local abbrev table. */
605 Lisp_Object abbrev_table
;
606 /* This buffer's syntax table. */
607 Lisp_Object syntax_table
;
608 /* This buffer's category table. */
609 Lisp_Object category_table
;
611 /* Values of several buffer-local variables. */
612 /* tab-width is buffer-local so that redisplay can find it
613 in buffers that are not current. */
614 Lisp_Object case_fold_search
;
615 Lisp_Object tab_width
;
616 Lisp_Object fill_column
;
617 Lisp_Object left_margin
;
618 /* Function to call when insert space past fill column. */
619 Lisp_Object auto_fill_function
;
620 /* nil: text, t: binary.
621 This value is meaningful only on certain operating systems. */
622 /* Actually, we don't need this flag any more because end-of-line
623 is handled correctly according to the buffer-file-coding-system
624 of the buffer. Just keeping it for backward compatibility. */
625 Lisp_Object buffer_file_type
;
627 /* Case table for case-conversion in this buffer.
628 This char-table maps each char into its lower-case version. */
629 Lisp_Object downcase_table
;
630 /* Char-table mapping each char to its upper-case version. */
631 Lisp_Object upcase_table
;
632 /* Char-table for conversion for case-folding search. */
633 Lisp_Object case_canon_table
;
634 /* Char-table of equivalences for case-folding search. */
635 Lisp_Object case_eqv_table
;
637 /* Non-nil means do not display continuation lines. */
638 Lisp_Object truncate_lines
;
639 /* Non-nil means display ctl chars with uparrow. */
640 Lisp_Object ctl_arrow
;
641 /* Non-nil means display text from right to left. */
642 Lisp_Object direction_reversed
;
643 /* Non-nil means do selective display;
644 see doc string in syms_of_buffer (buffer.c) for details. */
645 Lisp_Object selective_display
;
647 /* Non-nil means show ... at end of line followed by invisible lines. */
648 Lisp_Object selective_display_ellipses
;
650 /* Alist of (FUNCTION . STRING) for each minor mode enabled in buffer. */
651 Lisp_Object minor_modes
;
652 /* t if "self-insertion" should overwrite; `binary' if it should also
653 overwrite newlines and tabs - for editing executables and the like. */
654 Lisp_Object overwrite_mode
;
655 /* non-nil means abbrev mode is on. Expand abbrevs automatically. */
656 Lisp_Object abbrev_mode
;
657 /* Display table to use for text in this buffer. */
658 Lisp_Object display_table
;
659 /* t means the mark and region are currently active. */
660 Lisp_Object mark_active
;
662 /* Non-nil means the buffer contents are regarded as multi-byte
663 form of characters, not a binary code. */
664 Lisp_Object enable_multibyte_characters
;
666 /* Coding system to be used for encoding the buffer contents on
668 Lisp_Object buffer_file_coding_system
;
670 /* List of symbols naming the file format used for visited file. */
671 Lisp_Object file_format
;
673 /* True if the newline position cache and width run cache are
674 enabled. See search.c and indent.c. */
675 Lisp_Object cache_long_line_scans
;
677 /* If the width run cache is enabled, this table contains the
678 character widths width_run_cache (see above) assumes. When we
679 do a thorough redisplay, we compare this against the buffer's
680 current display table to see whether the display table has
681 affected the widths of any characters. If it has, we
682 invalidate the width run cache, and re-initialize width_table. */
683 Lisp_Object width_table
;
685 /* In an indirect buffer, or a buffer that is the base of an
686 indirect buffer, this holds a marker that records
687 PT for this buffer when the buffer is not current. */
688 Lisp_Object pt_marker
;
690 /* In an indirect buffer, or a buffer that is the base of an
691 indirect buffer, this holds a marker that records
692 BEGV for this buffer when the buffer is not current. */
693 Lisp_Object begv_marker
;
695 /* In an indirect buffer, or a buffer that is the base of an
696 indirect buffer, this holds a marker that records
697 ZV for this buffer when the buffer is not current. */
698 Lisp_Object zv_marker
;
700 /* This holds the point value before the last scroll operation.
701 Explicitly setting point sets this to nil. */
702 Lisp_Object point_before_scroll
;
704 /* Truename of the visited file, or nil. */
705 Lisp_Object file_truename
;
707 /* Invisibility spec of this buffer.
708 t => any non-nil `invisible' property means invisible.
709 A list => `invisible' property means invisible
710 if it is memq in that list. */
711 Lisp_Object invisibility_spec
;
713 /* This is the last window that was selected with this buffer in it,
714 or nil if that window no longer displays this buffer. */
715 Lisp_Object last_selected_window
;
717 /* Incremented each time the buffer is displayed in a window. */
718 Lisp_Object display_count
;
720 /* Widths of left and right marginal areas for windows displaying
722 Lisp_Object left_margin_cols
, right_margin_cols
;
724 /* Widths of left and right fringe areas for windows displaying
726 Lisp_Object left_fringe_width
, right_fringe_width
;
728 /* Non-nil means fringes are drawn outside display margins;
729 othersize draw them between margin areas and text. */
730 Lisp_Object fringes_outside_margins
;
732 /* Width and type of scroll bar areas for windows displaying
734 Lisp_Object scroll_bar_width
, vertical_scroll_bar_type
;
736 /* Non-nil means indicate lines not displaying text (in a style
738 Lisp_Object indicate_empty_lines
;
740 /* Time stamp updated each time this buffer is displayed in a window. */
741 Lisp_Object display_time
;
743 /* If scrolling the display because point is below the bottom of a
744 window showing this buffer, try to choose a window start so
745 that point ends up this number of lines from the top of the
746 window. Nil means that scrolling method isn't used. */
747 Lisp_Object scroll_up_aggressively
;
749 /* If scrolling the display because point is above the top of a
750 window showing this buffer, try to choose a window start so
751 that point ends up this number of lines from the bottom of the
752 window. Nil means that scrolling method isn't used. */
753 Lisp_Object scroll_down_aggressively
;
755 /* Desired cursor type in this buffer. See the doc string of
756 per-buffer variable `cursor-type'. */
757 Lisp_Object cursor_type
;
759 /* An integer > 0 means put that number of pixels below text lines
760 in the display of this buffer. */
761 Lisp_Object extra_line_spacing
;
765 /* This points to the current buffer. */
767 extern struct buffer
*current_buffer
;
769 /* This structure holds the default values of the buffer-local variables
770 that have special slots in each buffer.
771 The default value occupies the same slot in this structure
772 as an individual buffer's value occupies in that buffer.
773 Setting the default value also goes through the alist of buffers
774 and stores into each buffer that does not say it has a local value. */
776 extern struct buffer buffer_defaults
;
778 /* This structure marks which slots in a buffer have corresponding
779 default values in buffer_defaults.
780 Each such slot has a nonzero value in this structure.
781 The value has only one nonzero bit.
783 When a buffer has its own local value for a slot,
784 the entry for that slot (found in the same slot in this structure)
785 is turned on in the buffer's local_flags array.
787 If a slot in this structure is zero, then even though there may
788 be a Lisp-level local variable for the slot, it has no default value,
789 and the corresponding slot in buffer_defaults is not used. */
791 extern struct buffer buffer_local_flags
;
793 /* For each buffer slot, this points to the Lisp symbol name
794 for that slot in the current buffer. It is 0 for slots
795 that don't have such names. */
797 extern struct buffer buffer_local_symbols
;
799 /* This structure holds the required types for the values in the
800 buffer-local slots. If a slot contains Qnil, then the
801 corresponding buffer slot may contain a value of any type. If a
802 slot contains an integer, then prospective values' tags must be
803 equal to that integer (except nil is always allowed).
804 When a tag does not match, the function
805 buffer_slot_type_mismatch will signal an error.
807 If a slot here contains -1, the corresponding variable is read-only. */
809 extern struct buffer buffer_local_types
;
811 extern void delete_all_overlays
P_ ((struct buffer
*));
812 extern void reset_buffer
P_ ((struct buffer
*));
813 extern void evaporate_overlays
P_ ((EMACS_INT
));
814 extern int overlays_at
P_ ((EMACS_INT
, int, Lisp_Object
**, int *, int *, int *, int));
815 extern int sort_overlays
P_ ((Lisp_Object
*, int, struct window
*));
816 extern void recenter_overlay_lists
P_ ((struct buffer
*, EMACS_INT
));
817 extern int overlay_strings
P_ ((EMACS_INT
, struct window
*, unsigned char **));
818 extern void validate_region
P_ ((Lisp_Object
*, Lisp_Object
*));
819 extern void set_buffer_internal
P_ ((struct buffer
*));
820 extern void set_buffer_internal_1
P_ ((struct buffer
*));
821 extern void set_buffer_temp
P_ ((struct buffer
*));
822 extern void record_buffer
P_ ((Lisp_Object
));
823 extern void buffer_slot_type_mismatch
P_ ((int));
824 extern void fix_overlays_before
P_ ((struct buffer
*, EMACS_INT
, EMACS_INT
));
825 extern void mmap_set_vars
P_ ((int));
827 EXFUN (Fbuffer_live_p
, 1);
828 EXFUN (Fbuffer_name
, 1);
829 EXFUN (Fget_file_buffer
, 1);
830 EXFUN (Fnext_overlay_change
, 1);
831 EXFUN (Fdelete_overlay
, 1);
832 EXFUN (Fbuffer_local_value
, 2);
834 /* Functions to call before and after each text change. */
835 extern Lisp_Object Vbefore_change_functions
;
836 extern Lisp_Object Vafter_change_functions
;
837 extern Lisp_Object Vfirst_change_hook
;
838 extern Lisp_Object Qbefore_change_functions
;
839 extern Lisp_Object Qafter_change_functions
;
840 extern Lisp_Object Qfirst_change_hook
;
842 /* If nonzero, all modification hooks are suppressed. */
843 extern int inhibit_modification_hooks
;
845 extern Lisp_Object Vdeactivate_mark
;
846 extern Lisp_Object Vtransient_mark_mode
;
850 /* 1 if the OV is an overlay object. */
852 #define OVERLAY_VALID(OV) (OVERLAYP (OV))
854 /* Return the marker that stands for where OV starts in the buffer. */
856 #define OVERLAY_START(OV) (XOVERLAY (OV)->start)
858 /* Return the marker that stands for where OV ends in the buffer. */
860 #define OVERLAY_END(OV) (XOVERLAY (OV)->end)
862 /* Return the plist of overlay OV. */
864 #define OVERLAY_PLIST(OV) XOVERLAY ((OV))->plist
866 /* Return the actual buffer position for the marker P.
867 We assume you know which buffer it's pointing into. */
869 #define OVERLAY_POSITION(P) \
870 (GC_MARKERP (P) ? marker_position (P) : (abort (), 0))
873 /***********************************************************************
874 Buffer-local Variables
875 ***********************************************************************/
877 /* Number of per-buffer variables used. */
879 extern int last_per_buffer_idx
;
881 /* Return the offset in bytes of member VAR of struct buffer
882 from the start of a buffer structure. */
884 #define PER_BUFFER_VAR_OFFSET(VAR) \
885 ((char *) &buffer_local_flags.VAR - (char *) &buffer_local_flags)
887 /* Return the index of buffer-local variable VAR. Each per-buffer
888 variable has an index > 0 associated with it, except when it always
889 has buffer-local values, in which case the index is -1. If this is
890 0, this is a bug and means that the slot of VAR in
891 buffer_local_flags wasn't intiialized. */
893 #define PER_BUFFER_VAR_IDX(VAR) \
894 PER_BUFFER_IDX (PER_BUFFER_VAR_OFFSET (VAR))
896 /* Value is non-zero if the variable with index IDX has a local value
899 #define PER_BUFFER_VALUE_P(B, IDX) \
900 (((IDX) < 0 || IDX >= last_per_buffer_idx) \
902 : ((B)->local_flags[IDX] != 0))
904 /* Set whether per-buffer variable with index IDX has a buffer-local
905 value in buffer B. VAL zero means it hasn't. */
907 #define SET_PER_BUFFER_VALUE_P(B, IDX, VAL) \
909 if ((IDX) < 0 || (IDX) >= last_per_buffer_idx) \
911 (B)->local_flags[IDX] = (VAL); \
914 /* Return the index of the per-buffer variable at offset OFFSET in the
917 #define PER_BUFFER_IDX(OFFSET) \
918 XINT (*(Lisp_Object *)((OFFSET) + (char *) &buffer_local_flags))
920 /* Return the default value of the per-buffer variable at offset
921 OFFSET in the buffer structure. */
923 #define PER_BUFFER_DEFAULT(OFFSET) \
924 (*(Lisp_Object *)((OFFSET) + (char *) &buffer_defaults))
926 /* Return the buffer-local value of the per-buffer variable at offset
927 OFFSET in the buffer structure. */
929 #define PER_BUFFER_VALUE(BUFFER, OFFSET) \
930 (*(Lisp_Object *)((OFFSET) + (char *) (BUFFER)))
932 /* Return the symbol of the per-buffer variable at offset OFFSET in
933 the buffer structure. */
935 #define PER_BUFFER_SYMBOL(OFFSET) \
936 (*(Lisp_Object *)((OFFSET) + (char *) &buffer_local_symbols))
938 /* Return the type of the per-buffer variable at offset OFFSET in the
941 #define PER_BUFFER_TYPE(OFFSET) \
942 (*(Lisp_Object *)((OFFSET) + (char *) &buffer_local_types))