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 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., 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 /* 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
;
322 extern int _fetch_multibyte_char_len
;
324 /* Return character code of multi-byte form at position POS. If POS
325 doesn't point the head of valid multi-byte form, only the byte at
326 POS is returned. No range checking. */
328 #define FETCH_MULTIBYTE_CHAR(pos) \
329 (_fetch_multibyte_char_p = (((pos) >= GPT_BYTE ? GAP_SIZE : 0) \
330 + (pos) + BEG_ADDR - BEG_BYTE), \
331 _fetch_multibyte_char_len \
332 = ((pos) >= GPT_BYTE ? ZV_BYTE : GPT_BYTE) - (pos), \
333 STRING_CHAR (_fetch_multibyte_char_p, _fetch_multibyte_char_len))
335 /* Macros for accessing a character or byte,
336 or converting between byte positions and addresses,
337 in a specified buffer. */
339 /* Return the address of character at byte position POS in buffer BUF.
340 Note that both arguments can be computed more than once. */
342 #define BUF_BYTE_ADDRESS(buf, pos) \
343 ((buf)->text->beg + (pos) - BEG_BYTE \
344 + ((pos) >= (buf)->text->gpt_byte ? (buf)->text->gap_size : 0))
346 /* Return the address of character at char position POS in buffer BUF.
347 Note that both arguments can be computed more than once. */
349 #define BUF_CHAR_ADDRESS(buf, pos) \
350 ((buf)->text->beg + buf_charpos_to_bytepos ((buf), (pos)) - BEG_BYTE \
351 + ((pos) >= (buf)->text->gpt ? (buf)->text->gap_size : 0))
353 /* Convert PTR, the address of a char in buffer BUF,
354 into a character position. */
356 #define BUF_PTR_BYTE_POS(buf, ptr) \
357 ((ptr) - (buf)->text->beg \
358 - (ptr - (buf)->text->beg <= (unsigned) (BUF_GPT_BYTE ((buf)) - BEG_BYTE)\
359 ? 0 : BUF_GAP_SIZE ((buf))) \
362 /* Return the character at byte position POS in buffer BUF. */
364 #define BUF_FETCH_CHAR(buf, pos) \
365 (!NILP (buf->enable_multibyte_characters) \
366 ? BUF_FETCH_MULTIBYTE_CHAR ((buf), (pos)) \
367 : BUF_FETCH_BYTE ((buf), (pos)))
369 /* Return the byte at byte position N in buffer BUF. */
371 #define BUF_FETCH_BYTE(buf, n) \
372 *(BUF_BYTE_ADDRESS ((buf), (n)))
374 /* Return character code of multi-byte form at byte position POS in BUF.
375 If POS doesn't point the head of valid multi-byte form, only the byte at
376 POS is returned. No range checking. */
378 #define BUF_FETCH_MULTIBYTE_CHAR(buf, pos) \
379 (_fetch_multibyte_char_p \
380 = (((pos) >= BUF_GPT_BYTE (buf) ? BUF_GAP_SIZE (buf) : 0) \
381 + (pos) + BUF_BEG_ADDR (buf) - BEG_BYTE), \
382 _fetch_multibyte_char_len \
383 = (((pos) >= BUF_GPT_BYTE (buf) ? BUF_ZV_BYTE (buf) : BUF_GPT_BYTE (buf)) \
385 STRING_CHAR (_fetch_multibyte_char_p, _fetch_multibyte_char_len))
387 /* Define the actual buffer data structures. */
389 /* This data structure describes the actual text contents of a buffer.
390 It is shared between indirect buffers and their base buffer. */
394 /* Actual address of buffer contents. If REL_ALLOC is defined,
395 this address might change when blocks are relocated which can
396 e.g. happen when malloc is called. So, don't pass a pointer
397 into a buffer's text to functions that malloc. */
400 EMACS_INT gpt
; /* Char pos of gap in buffer. */
401 EMACS_INT z
; /* Char pos of end of buffer. */
402 EMACS_INT gpt_byte
; /* Byte pos of gap in buffer. */
403 EMACS_INT z_byte
; /* Byte pos of end of buffer. */
404 EMACS_INT gap_size
; /* Size of buffer's gap. */
405 int modiff
; /* This counts buffer-modification events
406 for this buffer. It is incremented for
407 each such event, and never otherwise
409 int save_modiff
; /* Previous value of modiff, as of last
410 time buffer visited or saved a file. */
412 int overlay_modiff
; /* Counts modifications to overlays. */
414 /* Minimum value of GPT - BEG since last redisplay that finished. */
415 EMACS_INT beg_unchanged
;
417 /* Minimum value of Z - GPT since last redisplay that finished. */
418 EMACS_INT end_unchanged
;
420 /* MODIFF as of last redisplay that finished; if it matches MODIFF,
421 beg_unchanged and end_unchanged contain no useful information. */
422 int unchanged_modified
;
424 /* BUF_OVERLAY_MODIFF of current buffer, as of last redisplay that
425 finished; if it matches BUF_OVERLAY_MODIFF, beg_unchanged and
426 end_unchanged contain no useful information. */
427 int overlay_unchanged_modified
;
429 /* Properties of this buffer's text. */
432 /* The markers that refer to this buffer.
433 This is actually a single marker ---
434 successive elements in its marker `chain'
435 are the other markers referring to this buffer. */
436 struct Lisp_Marker
*markers
;
439 /* This is the structure that the buffer Lisp object points to. */
443 /* Everything before the `name' slot must be of a non-Lisp_Object type,
444 and every slot after `name' must be a Lisp_Object.
446 Check out mark_buffer (alloc.c) to see why. */
450 /* Next buffer, in chain of all buffers including killed buffers.
451 This chain is used only for garbage collection, in order to
452 collect killed buffers properly.
453 Note that vectors and most pseudovectors are all on one chain,
454 but buffers are on a separate chain of their own. */
457 /* This structure holds the coordinates of the buffer contents
458 in ordinary buffers. In indirect buffers, this is not used. */
459 struct buffer_text own_text
;
461 /* This points to the `struct buffer_text' that used for this buffer.
462 In an ordinary buffer, this is the own_text field above.
463 In an indirect buffer, this is the own_text field of another buffer. */
464 struct buffer_text
*text
;
466 /* Char position of point in buffer. */
468 /* Byte position of point in buffer. */
470 /* Char position of beginning of accessible range. */
472 /* Byte position of beginning of accessible range. */
474 /* Char position of end of accessible range. */
476 /* Byte position of end of accessible range. */
479 /* In an indirect buffer, this points to the base buffer.
480 In an ordinary buffer, it is 0. */
481 struct buffer
*base_buffer
;
483 /* A non-zero value in slot IDX means that per-buffer variable
484 with index IDX has a local value in this buffer. The index IDX
485 for a buffer-local variable is stored in that variable's slot
486 in buffer_local_flags as a Lisp integer. If the index is -1,
487 this means the variable is always local in all buffers. */
488 #define MAX_PER_BUFFER_VARS 50
489 char local_flags
[MAX_PER_BUFFER_VARS
];
491 /* Set to the modtime of the visited file when read or written.
492 -1 means visited file was nonexistent.
493 0 means visited file modtime unknown; in no case complain
494 about any mismatch on next save attempt. */
496 /* The value of text->modiff at the last auto-save. */
497 int auto_save_modified
;
498 /* The value of text->modiff at the last display error.
499 Redisplay of this buffer is inhibited until it changes again. */
500 int display_error_modiff
;
501 /* The time at which we detected a failure to auto-save,
502 Or -1 if we didn't have a failure. */
503 int auto_save_failure_time
;
504 /* Position in buffer at which display started
505 the last time this buffer was displayed. */
506 EMACS_INT last_window_start
;
508 /* Set nonzero whenever the narrowing is changed in this buffer. */
511 /* If the long line scan cache is enabled (i.e. the buffer-local
512 variable cache-long-line-scans is non-nil), newline_cache
513 points to the newline cache, and width_run_cache points to the
516 The newline cache records which stretches of the buffer are
517 known *not* to contain newlines, so that they can be skipped
518 quickly when we search for newlines.
520 The width run cache records which stretches of the buffer are
521 known to contain characters whose widths are all the same. If
522 the width run cache maps a character to a value > 0, that value is
523 the character's width; if it maps a character to zero, we don't
524 know what its width is. This allows compute_motion to process
525 such regions very quickly, using algebra instead of inspecting
526 each character. See also width_table, below. */
527 struct region_cache
*newline_cache
;
528 struct region_cache
*width_run_cache
;
530 /* Non-zero means don't use redisplay optimizations for
531 displaying this buffer. */
532 unsigned prevent_redisplay_optimizations_p
: 1;
534 /* List of overlays that end at or before the current center,
535 in order of end-position. */
536 struct Lisp_Overlay
*overlays_before
;
538 /* List of overlays that end after the current center,
539 in order of start-position. */
540 struct Lisp_Overlay
*overlays_after
;
542 /* Position where the overlay lists are centered. */
543 EMACS_INT overlay_center
;
545 /* Everything from here down must be a Lisp_Object. */
547 /* The name of this buffer. */
550 /* The name of the file visited in this buffer, or nil. */
551 Lisp_Object filename
;
552 /* Dir for expanding relative file names. */
553 Lisp_Object directory
;
554 /* True iff this buffer has been backed up (if you write to the
555 visited file and it hasn't been backed up, then a backup will
557 /* This isn't really used by the C code, so could be deleted. */
558 Lisp_Object backed_up
;
559 /* Length of file when last read or saved.
560 This is not in the struct buffer_text
561 because it's not used in indirect buffers at all. */
562 Lisp_Object save_length
;
563 /* File name used for auto-saving this buffer.
564 This is not in the struct buffer_text
565 because it's not used in indirect buffers at all. */
566 Lisp_Object auto_save_file_name
;
568 /* Non-nil if buffer read-only. */
569 Lisp_Object read_only
;
570 /* "The mark". This is a marker which may
571 point into this buffer or may point nowhere. */
574 /* Alist of elements (SYMBOL . VALUE-IN-THIS-BUFFER)
575 for all per-buffer variables of this buffer. */
576 Lisp_Object local_var_alist
;
578 /* Symbol naming major mode (eg, lisp-mode). */
579 Lisp_Object major_mode
;
580 /* Pretty name of major mode (eg, "Lisp"). */
581 Lisp_Object mode_name
;
582 /* Mode line element that controls format of mode line. */
583 Lisp_Object mode_line_format
;
585 /* Changes in the buffer are recorded here for undo.
586 t means don't record anything.
587 This information belongs to the base buffer of an indirect buffer,
588 But we can't store it in the struct buffer_text
589 because local variables have to be right in the struct buffer.
590 So we copy it around in set_buffer_internal.
591 This comes before `name' because it is marked in a special way. */
592 Lisp_Object undo_list
;
594 /* Analogous to mode_line_format for the line displayed at the top
595 of windows. Nil means don't display that line. */
596 Lisp_Object header_line_format
;
598 /* Keys that are bound local to this buffer. */
600 /* This buffer's local abbrev table. */
601 Lisp_Object abbrev_table
;
602 /* This buffer's syntax table. */
603 Lisp_Object syntax_table
;
604 /* This buffer's category table. */
605 Lisp_Object category_table
;
607 /* Values of several buffer-local variables. */
608 /* tab-width is buffer-local so that redisplay can find it
609 in buffers that are not current. */
610 Lisp_Object case_fold_search
;
611 Lisp_Object tab_width
;
612 Lisp_Object fill_column
;
613 Lisp_Object left_margin
;
614 /* Function to call when insert space past fill column. */
615 Lisp_Object auto_fill_function
;
616 /* nil: text, t: binary.
617 This value is meaningful only on certain operating systems. */
618 /* Actually, we don't need this flag any more because end-of-line
619 is handled correctly according to the buffer-file-coding-system
620 of the buffer. Just keeping it for backward compatibility. */
621 Lisp_Object buffer_file_type
;
623 /* Case table for case-conversion in this buffer.
624 This char-table maps each char into its lower-case version. */
625 Lisp_Object downcase_table
;
626 /* Char-table mapping each char to its upper-case version. */
627 Lisp_Object upcase_table
;
628 /* Char-table for conversion for case-folding search. */
629 Lisp_Object case_canon_table
;
630 /* Char-table of equivalences for case-folding search. */
631 Lisp_Object case_eqv_table
;
633 /* Non-nil means do not display continuation lines. */
634 Lisp_Object truncate_lines
;
635 /* Non-nil means display ctl chars with uparrow. */
636 Lisp_Object ctl_arrow
;
637 /* Non-nil means display text from right to left. */
638 Lisp_Object direction_reversed
;
639 /* Non-nil means do selective display;
640 see doc string in syms_of_buffer (buffer.c) for details. */
641 Lisp_Object selective_display
;
643 /* Non-nil means show ... at end of line followed by invisible lines. */
644 Lisp_Object selective_display_ellipses
;
646 /* Alist of (FUNCTION . STRING) for each minor mode enabled in buffer. */
647 Lisp_Object minor_modes
;
648 /* t if "self-insertion" should overwrite; `binary' if it should also
649 overwrite newlines and tabs - for editing executables and the like. */
650 Lisp_Object overwrite_mode
;
651 /* non-nil means abbrev mode is on. Expand abbrevs automatically. */
652 Lisp_Object abbrev_mode
;
653 /* Display table to use for text in this buffer. */
654 Lisp_Object display_table
;
655 /* t means the mark and region are currently active. */
656 Lisp_Object mark_active
;
658 /* Non-nil means the buffer contents are regarded as multi-byte
659 form of characters, not a binary code. */
660 Lisp_Object enable_multibyte_characters
;
662 /* Coding system to be used for encoding the buffer contents on
664 Lisp_Object buffer_file_coding_system
;
666 /* List of symbols naming the file format used for visited file. */
667 Lisp_Object file_format
;
669 /* List of symbols naming the file format used for auto-save file. */
670 Lisp_Object auto_save_file_format
;
672 /* True if the newline position cache and width run cache are
673 enabled. See search.c and indent.c. */
674 Lisp_Object cache_long_line_scans
;
676 /* If the width run cache is enabled, this table contains the
677 character widths width_run_cache (see above) assumes. When we
678 do a thorough redisplay, we compare this against the buffer's
679 current display table to see whether the display table has
680 affected the widths of any characters. If it has, we
681 invalidate the width run cache, and re-initialize width_table. */
682 Lisp_Object width_table
;
684 /* In an indirect buffer, or a buffer that is the base of an
685 indirect buffer, this holds a marker that records
686 PT for this buffer when the buffer is not current. */
687 Lisp_Object pt_marker
;
689 /* In an indirect buffer, or a buffer that is the base of an
690 indirect buffer, this holds a marker that records
691 BEGV for this buffer when the buffer is not current. */
692 Lisp_Object begv_marker
;
694 /* In an indirect buffer, or a buffer that is the base of an
695 indirect buffer, this holds a marker that records
696 ZV for this buffer when the buffer is not current. */
697 Lisp_Object zv_marker
;
699 /* This holds the point value before the last scroll operation.
700 Explicitly setting point sets this to nil. */
701 Lisp_Object point_before_scroll
;
703 /* Truename of the visited file, or nil. */
704 Lisp_Object file_truename
;
706 /* Invisibility spec of this buffer.
707 t => any non-nil `invisible' property means invisible.
708 A list => `invisible' property means invisible
709 if it is memq in that list. */
710 Lisp_Object invisibility_spec
;
712 /* This is the last window that was selected with this buffer in it,
713 or nil if that window no longer displays this buffer. */
714 Lisp_Object last_selected_window
;
716 /* Incremented each time the buffer is displayed in a window. */
717 Lisp_Object display_count
;
719 /* Widths of left and right marginal areas for windows displaying
721 Lisp_Object left_margin_cols
, right_margin_cols
;
723 /* Widths of left and right fringe areas for windows displaying
725 Lisp_Object left_fringe_width
, right_fringe_width
;
727 /* Non-nil means fringes are drawn outside display margins;
728 othersize draw them between margin areas and text. */
729 Lisp_Object fringes_outside_margins
;
731 /* Width and type of scroll bar areas for windows displaying
733 Lisp_Object scroll_bar_width
, vertical_scroll_bar_type
;
735 /* Non-nil means indicate lines not displaying text (in a style
737 Lisp_Object indicate_empty_lines
;
739 /* Non-nil means indicate buffer boundaries and scrolling. */
740 Lisp_Object indicate_buffer_boundaries
;
742 /* Time stamp updated each time this buffer is displayed in a window. */
743 Lisp_Object display_time
;
745 /* If scrolling the display because point is below the bottom of a
746 window showing this buffer, try to choose a window start so
747 that point ends up this number of lines from the top of the
748 window. Nil means that scrolling method isn't used. */
749 Lisp_Object scroll_up_aggressively
;
751 /* If scrolling the display because point is above the top of a
752 window showing this buffer, try to choose a window start so
753 that point ends up this number of lines from the bottom of the
754 window. Nil means that scrolling method isn't used. */
755 Lisp_Object scroll_down_aggressively
;
757 /* Desired cursor type in this buffer. See the doc string of
758 per-buffer variable `cursor-type'. */
759 Lisp_Object cursor_type
;
761 /* An integer > 0 means put that number of pixels below text lines
762 in the display of this buffer. */
763 Lisp_Object extra_line_spacing
;
765 /* *Cursor type to display in non-selected windows.
766 t means to use hollow box cursor.
767 See `cursor-type' for other values. */
768 Lisp_Object cursor_in_non_selected_windows
;
772 /* This points to the current buffer. */
774 extern struct buffer
*current_buffer
;
776 /* This structure holds the default values of the buffer-local variables
777 that have special slots in each buffer.
778 The default value occupies the same slot in this structure
779 as an individual buffer's value occupies in that buffer.
780 Setting the default value also goes through the alist of buffers
781 and stores into each buffer that does not say it has a local value. */
783 extern struct buffer buffer_defaults
;
785 /* This structure marks which slots in a buffer have corresponding
786 default values in buffer_defaults.
787 Each such slot has a nonzero value in this structure.
788 The value has only one nonzero bit.
790 When a buffer has its own local value for a slot,
791 the entry for that slot (found in the same slot in this structure)
792 is turned on in the buffer's local_flags array.
794 If a slot in this structure is zero, then even though there may
795 be a Lisp-level local variable for the slot, it has no default value,
796 and the corresponding slot in buffer_defaults is not used. */
798 extern struct buffer buffer_local_flags
;
800 /* For each buffer slot, this points to the Lisp symbol name
801 for that slot in the current buffer. It is 0 for slots
802 that don't have such names. */
804 extern struct buffer buffer_local_symbols
;
806 /* This structure holds the required types for the values in the
807 buffer-local slots. If a slot contains Qnil, then the
808 corresponding buffer slot may contain a value of any type. If a
809 slot contains an integer, then prospective values' tags must be
810 equal to that integer (except nil is always allowed).
811 When a tag does not match, the function
812 buffer_slot_type_mismatch will signal an error.
814 If a slot here contains -1, the corresponding variable is read-only. */
816 extern struct buffer buffer_local_types
;
818 extern void delete_all_overlays
P_ ((struct buffer
*));
819 extern void reset_buffer
P_ ((struct buffer
*));
820 extern void evaporate_overlays
P_ ((EMACS_INT
));
821 extern int overlays_at
P_ ((EMACS_INT
, int, Lisp_Object
**, int *, int *, int *, int));
822 extern int sort_overlays
P_ ((Lisp_Object
*, int, struct window
*));
823 extern void recenter_overlay_lists
P_ ((struct buffer
*, EMACS_INT
));
824 extern int overlay_strings
P_ ((EMACS_INT
, struct window
*, unsigned char **));
825 extern void validate_region
P_ ((Lisp_Object
*, Lisp_Object
*));
826 extern void set_buffer_internal
P_ ((struct buffer
*));
827 extern void set_buffer_internal_1
P_ ((struct buffer
*));
828 extern void set_buffer_temp
P_ ((struct buffer
*));
829 extern void record_buffer
P_ ((Lisp_Object
));
830 extern void buffer_slot_type_mismatch
P_ ((int));
831 extern void fix_overlays_before
P_ ((struct buffer
*, EMACS_INT
, EMACS_INT
));
832 extern void mmap_set_vars
P_ ((int));
834 /* Get overlays at POSN into array OVERLAYS with NOVERLAYS elements.
835 If NEXTP is non-NULL, return next overlay there.
836 See overlay_at arg CHANGE_REQ for meaning of CHRQ arg. */
838 #define GET_OVERLAYS_AT(posn, overlays, noverlays, nextp, chrq) \
841 overlays = (Lisp_Object *) alloca (maxlen * sizeof (Lisp_Object)); \
842 noverlays = overlays_at (posn, 0, &overlays, &maxlen, \
843 nextp, NULL, chrq); \
844 if (noverlays > maxlen) \
846 maxlen = noverlays; \
847 overlays = (Lisp_Object *) alloca (maxlen * sizeof (Lisp_Object)); \
848 noverlays = overlays_at (posn, 0, &overlays, &maxlen, \
849 nextp, NULL, chrq); \
853 EXFUN (Fbuffer_name
, 1);
854 EXFUN (Fget_file_buffer
, 1);
855 EXFUN (Fnext_overlay_change
, 1);
856 EXFUN (Fdelete_overlay
, 1);
857 EXFUN (Fbuffer_local_value
, 2);
858 EXFUN (Fgenerate_new_buffer_name
, 2);
860 /* Functions to call before and after each text change. */
861 extern Lisp_Object Vbefore_change_functions
;
862 extern Lisp_Object Vafter_change_functions
;
863 extern Lisp_Object Vfirst_change_hook
;
864 extern Lisp_Object Qbefore_change_functions
;
865 extern Lisp_Object Qafter_change_functions
;
866 extern Lisp_Object Qfirst_change_hook
;
868 /* If nonzero, all modification hooks are suppressed. */
869 extern int inhibit_modification_hooks
;
871 extern Lisp_Object Vdeactivate_mark
;
872 extern Lisp_Object Vtransient_mark_mode
;
876 /* 1 if the OV is an overlay object. */
878 #define OVERLAY_VALID(OV) (OVERLAYP (OV))
880 /* Return the marker that stands for where OV starts in the buffer. */
882 #define OVERLAY_START(OV) (XOVERLAY (OV)->start)
884 /* Return the marker that stands for where OV ends in the buffer. */
886 #define OVERLAY_END(OV) (XOVERLAY (OV)->end)
888 /* Return the plist of overlay OV. */
890 #define OVERLAY_PLIST(OV) XOVERLAY ((OV))->plist
892 /* Return the actual buffer position for the marker P.
893 We assume you know which buffer it's pointing into. */
895 #define OVERLAY_POSITION(P) \
896 (GC_MARKERP (P) ? marker_position (P) : (abort (), 0))
899 /***********************************************************************
900 Buffer-local Variables
901 ***********************************************************************/
903 /* Number of per-buffer variables used. */
905 extern int last_per_buffer_idx
;
907 /* Return the offset in bytes of member VAR of struct buffer
908 from the start of a buffer structure. */
910 #define PER_BUFFER_VAR_OFFSET(VAR) \
911 ((char *) &buffer_local_flags.VAR - (char *) &buffer_local_flags)
913 /* Return the index of buffer-local variable VAR. Each per-buffer
914 variable has an index > 0 associated with it, except when it always
915 has buffer-local values, in which case the index is -1. If this is
916 0, this is a bug and means that the slot of VAR in
917 buffer_local_flags wasn't intiialized. */
919 #define PER_BUFFER_VAR_IDX(VAR) \
920 PER_BUFFER_IDX (PER_BUFFER_VAR_OFFSET (VAR))
922 /* Value is non-zero if the variable with index IDX has a local value
925 #define PER_BUFFER_VALUE_P(B, IDX) \
926 (((IDX) < 0 || IDX >= last_per_buffer_idx) \
928 : ((B)->local_flags[IDX] != 0))
930 /* Set whether per-buffer variable with index IDX has a buffer-local
931 value in buffer B. VAL zero means it hasn't. */
933 #define SET_PER_BUFFER_VALUE_P(B, IDX, VAL) \
935 if ((IDX) < 0 || (IDX) >= last_per_buffer_idx) \
937 (B)->local_flags[IDX] = (VAL); \
940 /* Return the index value of the per-buffer variable at offset OFFSET
941 in the buffer structure.
943 If the slot OFFSET has a corresponding default value in
944 buffer_defaults, the index value is positive and has only one
945 nonzero bit. When a buffer has its own local value for a slot, the
946 bit for that slot (found in the same slot in this structure) is
947 turned on in the buffer's local_flags array.
949 If the index value is -1, even though there may be a
950 DEFVAR_PER_BUFFER for the slot, there is no default value for it;
951 and the corresponding slot in buffer_defaults is not used.
953 If the index value is -2, then there is no DEFVAR_PER_BUFFER for
954 the slot, but there is a default value which is copied into each
957 If a slot in this structure corresponding to a DEFVAR_PER_BUFFER is
958 zero, that is a bug */
961 #define PER_BUFFER_IDX(OFFSET) \
962 XINT (*(Lisp_Object *)((OFFSET) + (char *) &buffer_local_flags))
964 /* Return the default value of the per-buffer variable at offset
965 OFFSET in the buffer structure. */
967 #define PER_BUFFER_DEFAULT(OFFSET) \
968 (*(Lisp_Object *)((OFFSET) + (char *) &buffer_defaults))
970 /* Return the buffer-local value of the per-buffer variable at offset
971 OFFSET in the buffer structure. */
973 #define PER_BUFFER_VALUE(BUFFER, OFFSET) \
974 (*(Lisp_Object *)((OFFSET) + (char *) (BUFFER)))
976 /* Return the symbol of the per-buffer variable at offset OFFSET in
977 the buffer structure. */
979 #define PER_BUFFER_SYMBOL(OFFSET) \
980 (*(Lisp_Object *)((OFFSET) + (char *) &buffer_local_symbols))
982 /* Return the type of the per-buffer variable at offset OFFSET in the
985 #define PER_BUFFER_TYPE(OFFSET) \
986 (*(Lisp_Object *)((OFFSET) + (char *) &buffer_local_types))
988 /* arch-tag: 679305dd-d41c-4a50-b170-3caf5c97b2d1
989 (do not change this comment) */