1 /* Header file for the buffer manipulation primitives.
2 Copyright (C) 1985, 86, 93, 94, 95, 97, 1998, 1999 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
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. */
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 - 1)
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 - 1)
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 - 1)
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 /* Overlay modification count. */
85 #define OVERLAY_MODIFF (current_buffer->text->overlay_modiff)
87 /* Modification count as of last visit or save. */
88 #define SAVE_MODIFF (current_buffer->text->save_modiff)
90 /* BUFFER_CEILING_OF (resp. BUFFER_FLOOR_OF), when applied to n, return
91 the max (resp. min) p such that
93 BYTE_POS_ADDR (p) - BYTE_POS_ADDR (n) == p - n */
95 #define BUFFER_CEILING_OF(BYTEPOS) \
96 (((BYTEPOS) < GPT_BYTE && GPT < ZV ? GPT_BYTE : ZV_BYTE) - 1)
97 #define BUFFER_FLOOR_OF(BYTEPOS) \
98 (BEGV <= GPT && GPT_BYTE <= (BYTEPOS) ? GPT_BYTE : BEGV_BYTE)
100 /* Similar macros to operate on a specified buffer.
101 Note that many of these evaluate the buffer argument more than once. */
103 /* Position of beginning of buffer. */
104 #define BUF_BEG(buf) (1)
105 #define BUF_BEG_BYTE(buf) (1)
107 /* Position of beginning of accessible range of buffer. */
108 #define BUF_BEGV(buf) ((buf)->begv)
109 #define BUF_BEGV_BYTE(buf) ((buf)->begv_byte)
111 /* Position of point in buffer. */
112 #define BUF_PT(buf) ((buf)->pt)
113 #define BUF_PT_BYTE(buf) ((buf)->pt_byte)
115 /* Position of gap in buffer. */
116 #define BUF_GPT(buf) ((buf)->text->gpt)
117 #define BUF_GPT_BYTE(buf) ((buf)->text->gpt_byte)
119 /* Position of end of accessible range of buffer. */
120 #define BUF_ZV(buf) ((buf)->zv)
121 #define BUF_ZV_BYTE(buf) ((buf)->zv_byte)
123 /* Position of end of buffer. */
124 #define BUF_Z(buf) ((buf)->text->z)
125 #define BUF_Z_BYTE(buf) ((buf)->text->z_byte)
127 /* Address of beginning of buffer. */
128 #define BUF_BEG_ADDR(buf) ((buf)->text->beg)
130 /* Address of beginning of gap of buffer. */
131 #define BUF_GPT_ADDR(buf) ((buf)->text->beg + (buf)->text->gpt_byte - 1)
133 /* Address of end of buffer. */
134 #define BUF_Z_ADDR(buf) ((buf)->text->beg + (buf)->text->gap_size + (buf)->text->z_byte - 1)
136 /* Address of end of gap in buffer. */
137 #define BUF_GAP_END_ADDR(buf) ((buf)->text->beg + (buf)->text->gpt_byte + (buf)->text->gap_size - 1)
140 #define BUF_GAP_SIZE(buf) ((buf)->text->gap_size)
142 /* Is this buffer narrowed? */
143 #define BUF_NARROWED(buf) ((BUF_BEGV (buf) != BUF_BEG (buf)) \
144 || (BUF_ZV (buf) != BUF_Z (buf)))
146 /* Modification count. */
147 #define BUF_MODIFF(buf) ((buf)->text->modiff)
149 /* Modification count as of last visit or save. */
150 #define BUF_SAVE_MODIFF(buf) ((buf)->text->save_modiff)
152 /* Overlay modification count. */
153 #define BUF_OVERLAY_MODIFF(buf) ((buf)->text->overlay_modiff)
155 /* Interval tree of buffer. */
156 #define BUF_INTERVALS(buf) ((buf)->text->intervals)
158 /* Marker chain of buffer. */
159 #define BUF_MARKERS(buf) ((buf)->text->markers)
161 #define BUF_UNCHANGED_MODIFIED(buf) \
162 ((buf)->text->unchanged_modified)
164 #define BUF_OVERLAY_UNCHANGED_MODIFIED(buf) \
165 ((buf)->text->overlay_unchanged_modified)
166 #define BUF_BEG_UNCHANGED(buf) ((buf)->text->beg_unchanged)
167 #define BUF_END_UNCHANGED(buf) ((buf)->text->end_unchanged)
169 #define UNCHANGED_MODIFIED \
170 BUF_UNCHANGED_MODIFIED (current_buffer)
171 #define OVERLAY_UNCHANGED_MODIFIED \
172 BUF_OVERLAY_UNCHANGED_MODIFIED (current_buffer)
173 #define BEG_UNCHANGED BUF_BEG_UNCHANGED (current_buffer)
174 #define END_UNCHANGED BUF_END_UNCHANGED (current_buffer)
176 /* Compute how many characters at the top and bottom of BUF are
177 unchanged when the range START..END is modified. This computation
178 must be done each time BUF is modified. */
180 #define BUF_COMPUTE_UNCHANGED(buf, start, end) \
183 if (BUF_UNCHANGED_MODIFIED (buf) == MODIFF \
184 && BUF_OVERLAY_UNCHANGED_MODIFIED (buf) == OVERLAY_MODIFF) \
186 BUF_BEG_UNCHANGED (buf) = (start) - BUF_BEG (buf); \
187 BUF_END_UNCHANGED (buf) = BUF_Z (buf) - (end); \
191 if (BUF_Z (buf) - (end) < BUF_END_UNCHANGED (buf)) \
192 BUF_END_UNCHANGED (buf) = BUF_Z (buf) - (end); \
193 if ((start) - BUF_BEG (buf) < BUF_BEG_UNCHANGED (buf)) \
194 BUF_BEG_UNCHANGED (buf) = (start) - BUF_BEG (buf); \
200 /* Macros to set PT in the current buffer, or another buffer.. */
202 #define SET_PT(position) (set_point (current_buffer, (position)))
203 #define TEMP_SET_PT(position) (temp_set_point (current_buffer, (position)))
205 #define SET_PT_BOTH(position, byte) \
206 (set_point_both (current_buffer, (position), (byte)))
207 #define TEMP_SET_PT_BOTH(position, byte) \
208 (temp_set_point_both (current_buffer, (position), (byte)))
210 #define BUF_SET_PT(buffer, position) \
211 (set_point ((buffer), (position)))
212 #define BUF_TEMP_SET_PT(buffer, position) \
213 (temp_set_point ((buffer), (position)))
215 extern void set_point
P_ ((struct buffer
*, int));
216 extern INLINE
void temp_set_point
P_ ((struct buffer
*, int));
217 extern void set_point_both
P_ ((struct buffer
*, int, int));
218 extern INLINE
void temp_set_point_both
P_ ((struct buffer
*, int, int));
221 /* Macros for setting the BEGV, ZV or PT of a given buffer.
223 SET_BUF_PT* seet to be redundant. Get rid of them?
225 The ..._BOTH macros take both a charpos and a bytepos,
226 which must correspond to each other.
228 The macros without ..._BOTH take just a charpos,
229 and compute the bytepos from it. */
231 #define SET_BUF_BEGV(buf, charpos) \
232 ((buf)->begv_byte = buf_charpos_to_bytepos ((buf), (charpos)), \
233 (buf)->begv = (charpos))
235 #define SET_BUF_ZV(buf, charpos) \
236 ((buf)->zv_byte = buf_charpos_to_bytepos ((buf), (charpos)), \
237 (buf)->zv = (charpos))
239 #define SET_BUF_BEGV_BOTH(buf, charpos, byte) \
240 ((buf)->begv = (charpos), \
241 (buf)->begv_byte = (byte))
243 #define SET_BUF_ZV_BOTH(buf, charpos, byte) \
244 ((buf)->zv = (charpos), \
245 (buf)->zv_byte = (byte))
247 #define SET_BUF_PT_BOTH(buf, charpos, byte) \
248 ((buf)->pt = (charpos), \
249 (buf)->pt_byte = (byte))
251 /* Macros to access a character or byte in the current buffer,
252 or convert between a byte position and an address.
253 These macros do not check that the position is in range. */
255 /* Access a Lisp position value in POS,
256 and store the charpos in CHARPOS and the bypepos in BYPEPOS. */
258 #define DECODE_POSITION(charpos, bytepos, pos) \
261 Lisp_Object __pos = (pos); \
262 if (NUMBERP (__pos)) \
265 bytepos = buf_charpos_to_bytepos (current_buffer, __pos); \
267 else if (MARKERP (__pos)) \
269 charpos = marker_position (__pos); \
270 bytepos = marker_byte_position (__pos); \
273 wrong_type_argument (Qinteger_or_marker_p, __pos); \
277 /* Return the address of byte position N in current buffer. */
279 #define BYTE_POS_ADDR(n) \
280 (((n) >= GPT_BYTE ? GAP_SIZE : 0) + (n) + BEG_ADDR - 1)
282 /* Return the address of char position N. */
284 #define CHAR_POS_ADDR(n) \
285 (((n) >= GPT ? GAP_SIZE : 0) \
286 + buf_charpos_to_bytepos (current_buffer, n) \
289 /* Convert a character position to a byte position. */
291 #define CHAR_TO_BYTE(charpos) \
292 (buf_charpos_to_bytepos (current_buffer, charpos))
294 /* Convert a byte position to a character position. */
296 #define BYTE_TO_CHAR(bytepos) \
297 (buf_bytepos_to_charpos (current_buffer, bytepos))
299 /* Convert PTR, the address of a byte in the buffer, into a byte position. */
301 #define PTR_BYTE_POS(ptr) \
302 ((ptr) - (current_buffer)->text->beg \
303 - (ptr - (current_buffer)->text->beg < (unsigned) GPT_BYTE ? 0 : GAP_SIZE) \
306 /* Return character at position POS. */
308 #define FETCH_CHAR(pos) \
309 (!NILP (current_buffer->enable_multibyte_characters) \
310 ? FETCH_MULTIBYTE_CHAR ((pos)) \
311 : FETCH_BYTE ((pos)))
313 /* Return the byte at byte position N. */
315 #define FETCH_BYTE(n) *(BYTE_POS_ADDR ((n)))
317 /* Variables used locally in FETCH_MULTIBYTE_CHAR. */
318 extern unsigned char *_fetch_multibyte_char_p
;
319 extern int _fetch_multibyte_char_len
;
321 /* Return character code of multi-byte form at position POS. If POS
322 doesn't point the head of valid multi-byte form, only the byte at
323 POS is returned. No range checking. */
325 #define FETCH_MULTIBYTE_CHAR(pos) \
326 (_fetch_multibyte_char_p = (((pos) >= GPT_BYTE ? GAP_SIZE : 0) \
327 + (pos) + BEG_ADDR - 1), \
328 _fetch_multibyte_char_len \
329 = ((pos) >= GPT_BYTE ? ZV_BYTE : GPT_BYTE) - (pos), \
330 STRING_CHAR (_fetch_multibyte_char_p, _fetch_multibyte_char_len))
332 /* Macros for accessing a character or byte,
333 or converting between byte positions and addresses,
334 in a specified buffer. */
336 /* Return the address of character at byte position POS in buffer BUF.
337 Note that both arguments can be computed more than once. */
339 #define BUF_BYTE_ADDRESS(buf, pos) \
340 ((buf)->text->beg + (pos) - 1 \
341 + ((pos) >= (buf)->text->gpt_byte ? (buf)->text->gap_size : 0))
343 /* Return the address of character at char position POS in buffer BUF.
344 Note that both arguments can be computed more than once. */
346 #define BUF_CHAR_ADDRESS(buf, pos) \
347 ((buf)->text->beg + buf_charpos_to_bytepos ((buf), (pos)) - 1 \
348 + ((pos) >= (buf)->text->gpt ? (buf)->text->gap_size : 0))
350 /* Convert PTR, the address of a char in buffer BUF,
351 into a character position. */
353 #define BUF_PTR_BYTE_POS(buf, ptr) \
354 ((ptr) - (buf)->text->beg \
355 - (ptr - (buf)->text->beg < (unsigned) BUF_GPT_BYTE ((buf)) \
356 ? 0 : BUF_GAP_SIZE ((buf))) \
359 /* Return the character at byte position POS in buffer BUF. */
361 #define BUF_FETCH_CHAR(buf, pos) \
362 (!NILP (buf->enable_multibyte_characters) \
363 ? BUF_FETCH_MULTIBYTE_CHAR ((buf), (pos)) \
364 : BUF_FETCH_BYTE ((buf), (pos)))
366 /* Return the byte at byte position N in buffer BUF. */
368 #define BUF_FETCH_BYTE(buf, n) \
369 *(BUF_BYTE_ADDRESS ((buf), (n)))
371 /* Return character code of multi-byte form at byte position POS in BUF.
372 If POS doesn't point the head of valid multi-byte form, only the byte at
373 POS is returned. No range checking. */
375 #define BUF_FETCH_MULTIBYTE_CHAR(buf, pos) \
376 (_fetch_multibyte_char_p \
377 = (((pos) >= BUF_GPT_BYTE (buf) ? BUF_GAP_SIZE (buf) : 0) \
378 + (pos) + BUF_BEG_ADDR (buf) - 1), \
379 _fetch_multibyte_char_len \
380 = (((pos) >= BUF_GPT_BYTE (buf) ? BUF_ZV_BYTE (buf) : BUF_GPT_BYTE (buf)) \
382 STRING_CHAR (_fetch_multibyte_char_p, _fetch_multibyte_char_len))
384 /* Define the actual buffer data structures. */
386 /* This data structure describes the actual text contents of a buffer.
387 It is shared between indirect buffers and their base buffer. */
391 unsigned char *beg
; /* Actual address of buffer contents. */
392 int gpt
; /* Char pos of gap in buffer. */
393 int z
; /* Char pos of end of buffer. */
394 int gpt_byte
; /* Byte pos of gap in buffer. */
395 int z_byte
; /* Byte pos of end of buffer. */
396 int gap_size
; /* Size of buffer's gap. */
397 int modiff
; /* This counts buffer-modification events
398 for this buffer. It is incremented for
399 each such event, and never otherwise
401 int save_modiff
; /* Previous value of modiff, as of last
402 time buffer visited or saved a file. */
404 int overlay_modiff
; /* Counts modifications to overlays. */
406 /* Minimum value of GPT - BEG since last redisplay that finished. */
409 /* Minimum value of Z - GPT since last redisplay that finished. */
412 /* MODIFF as of last redisplay that finished; if it matches MODIFF,
413 beg_unchanged and end_unchanged contain no useful information. */
414 int unchanged_modified
;
416 /* BUF_OVERLAY_MODIFF of current buffer, as of last redisplay that
417 finished; if it matches BUF_OVERLAY_MODIFF, beg_unchanged and
418 end_unchanged contain no useful information. */
419 int overlay_unchanged_modified
;
421 /* Properties of this buffer's text -- conditionally compiled. */
424 /* The markers that refer to this buffer.
425 This is actually a single marker ---
426 successive elements in its marker `chain'
427 are the other markers referring to this buffer. */
431 /* This is the structure that the buffer Lisp object points to. */
435 /* Everything before the `name' slot must be of a non-Lisp_Object type,
436 and every slot after `name' must be a Lisp_Object.
438 Check out mark_buffer (alloc.c) to see why. */
442 /* Next buffer, in chain of all buffers including killed buffers.
443 This chain is used only for garbage collection, in order to
444 collect killed buffers properly.
445 Note that vectors and most pseudovectors are all on one chain,
446 but buffers are on a separate chain of their own. */
449 /* This structure holds the coordinates of the buffer contents
450 in ordinary buffers. In indirect buffers, this is not used. */
451 struct buffer_text own_text
;
453 /* This points to the `struct buffer_text' that used for this buffer.
454 In an ordinary buffer, this is the own_text field above.
455 In an indirect buffer, this is the own_text field of another buffer. */
456 struct buffer_text
*text
;
458 /* Char position of point in buffer. */
460 /* Byte position of point in buffer. */
462 /* Char position of beginning of accessible range. */
464 /* Byte position of beginning of accessible range. */
466 /* Char position of end of accessible range. */
468 /* Byte position of end of accessible range. */
471 /* In an indirect buffer, this points to the base buffer.
472 In an ordinary buffer, it is 0. */
473 struct buffer
*base_buffer
;
475 /* Flags saying which DEFVAR_PER_BUFFER variables
476 are local to this buffer. */
478 /* Set to the modtime of the visited file when read or written.
479 -1 means visited file was nonexistent.
480 0 means visited file modtime unknown; in no case complain
481 about any mismatch on next save attempt. */
483 /* the value of text->modiff at the last auto-save. */
484 int auto_save_modified
;
485 /* The time at which we detected a failure to auto-save,
486 Or -1 if we didn't have a failure. */
487 int auto_save_failure_time
;
488 /* Position in buffer at which display started
489 the last time this buffer was displayed. */
490 int last_window_start
;
492 /* Set nonzero whenever the narrowing is changed in this buffer. */
495 /* If the long line scan cache is enabled (i.e. the buffer-local
496 variable cache-long-line-scans is non-nil), newline_cache
497 points to the newline cache, and width_run_cache points to the
500 The newline cache records which stretches of the buffer are
501 known *not* to contain newlines, so that they can be skipped
502 quickly when we search for newlines.
504 The width run cache records which stretches of the buffer are
505 known to contain characters whose widths are all the same. If
506 the width run cache maps a character to a value > 0, that value is
507 the character's width; if it maps a character to zero, we don't
508 know what its width is. This allows compute_motion to process
509 such regions very quickly, using algebra instead of inspecting
510 each character. See also width_table, below. */
511 struct region_cache
*newline_cache
;
512 struct region_cache
*width_run_cache
;
514 /* Non-zero means don't use redisplay optimizations for
515 displaying this buffer. */
516 unsigned prevent_redisplay_optimizations_p
: 1;
518 /* Changes in the buffer are recorded here for undo.
519 t means don't record anything.
520 This information belongs to the base buffer of an indirect buffer,
521 But we can't store it in the struct buffer_text
522 because local variables have to be right in the struct buffer.
523 So we copy it around in set_buffer_internal.
524 This comes before `name' because it is marked in a special way. */
525 Lisp_Object undo_list
;
527 /* Everything from here down must be a Lisp_Object */
529 /* The name of this buffer. */
532 /* The name of the file visited in this buffer, or nil. */
533 Lisp_Object filename
;
534 /* Dir for expanding relative file names. */
535 Lisp_Object directory
;
536 /* True iff this buffer has been backed up (if you write to the
537 visited file and it hasn't been backed up, then a backup will
539 /* This isn't really used by the C code, so could be deleted. */
540 Lisp_Object backed_up
;
541 /* Length of file when last read or saved.
542 This is not in the struct buffer_text
543 because it's not used in indirect buffers at all. */
544 Lisp_Object save_length
;
545 /* File name used for auto-saving this buffer.
546 This is not in the struct buffer_text
547 because it's not used in indirect buffers at all. */
548 Lisp_Object auto_save_file_name
;
550 /* Non-nil if buffer read-only. */
551 Lisp_Object read_only
;
552 /* "The mark". This is a marker which may
553 point into this buffer or may point nowhere. */
556 /* Alist of elements (SYMBOL . VALUE-IN-THIS-BUFFER)
557 for all per-buffer variables of this buffer. */
558 Lisp_Object local_var_alist
;
560 /* Symbol naming major mode (eg, lisp-mode). */
561 Lisp_Object major_mode
;
562 /* Pretty name of major mode (eg, "Lisp"). */
563 Lisp_Object mode_name
;
564 /* Mode line element that controls format of mode line. */
565 Lisp_Object mode_line_format
;
567 /* Analogous to mode_line_format for the line displayed at the top
568 of windows. Nil means don't display that line. */
569 Lisp_Object header_line_format
;
571 /* Keys that are bound local to this buffer. */
573 /* This buffer's local abbrev table. */
574 Lisp_Object abbrev_table
;
575 /* This buffer's syntax table. */
576 Lisp_Object syntax_table
;
577 /* This buffer's category table. */
578 Lisp_Object category_table
;
580 /* Values of several buffer-local variables */
581 /* tab-width is buffer-local so that redisplay can find it
582 in buffers that are not current */
583 Lisp_Object case_fold_search
;
584 Lisp_Object tab_width
;
585 Lisp_Object fill_column
;
586 Lisp_Object left_margin
;
587 /* Function to call when insert space past fill column. */
588 Lisp_Object auto_fill_function
;
589 /* nil: text, t: binary.
590 This value is meaningful only on certain operating systems. */
591 /* Actually, we don't need this flag any more because end-of-line
592 is handled correctly according to the buffer-file-coding-system
593 of the buffer. Just keeping it for backward compatibility. */
594 Lisp_Object buffer_file_type
;
596 /* Case table for case-conversion in this buffer.
597 This char-table maps each char into its lower-case version. */
598 Lisp_Object downcase_table
;
599 /* Char-table mapping each char to its upper-case version. */
600 Lisp_Object upcase_table
;
601 /* Char-table for conversion for case-folding search. */
602 Lisp_Object case_canon_table
;
603 /* Char-table of equivalences for case-folding search. */
604 Lisp_Object case_eqv_table
;
606 /* Non-nil means do not display continuation lines. */
607 Lisp_Object truncate_lines
;
608 /* Non-nil means display ctl chars with uparrow. */
609 Lisp_Object ctl_arrow
;
610 /* Non-nil means display text from right to left. */
611 Lisp_Object direction_reversed
;
612 /* Non-nil means do selective display;
613 see doc string in syms_of_buffer (buffer.c) for details. */
614 Lisp_Object selective_display
;
616 /* Non-nil means show ... at end of line followed by invisible lines. */
617 Lisp_Object selective_display_ellipses
;
619 /* Alist of (FUNCTION . STRING) for each minor mode enabled in buffer. */
620 Lisp_Object minor_modes
;
621 /* t if "self-insertion" should overwrite; `binary' if it should also
622 overwrite newlines and tabs - for editing executables and the like. */
623 Lisp_Object overwrite_mode
;
624 /* non-nil means abbrev mode is on. Expand abbrevs automatically. */
625 Lisp_Object abbrev_mode
;
626 /* Display table to use for text in this buffer. */
627 Lisp_Object display_table
;
628 /* t means the mark and region are currently active. */
629 Lisp_Object mark_active
;
631 /* List of overlays that end at or before the current center,
632 in order of end-position. */
633 Lisp_Object overlays_before
;
635 /* List of overlays that end after the current center,
636 in order of start-position. */
637 Lisp_Object overlays_after
;
639 /* Position where the overlay lists are centered. */
640 Lisp_Object overlay_center
;
642 /* Non-nil means the buffer contents are regarded as multi-byte
643 form of characters, not a binary code. */
644 Lisp_Object enable_multibyte_characters
;
646 /* Coding system to be used for encoding the buffer contents on
648 Lisp_Object buffer_file_coding_system
;
650 /* List of symbols naming the file format used for visited file. */
651 Lisp_Object file_format
;
653 /* True if the newline position cache and width run cache are
654 enabled. See search.c and indent.c. */
655 Lisp_Object cache_long_line_scans
;
657 /* If the width run cache is enabled, this table contains the
658 character widths width_run_cache (see above) assumes. When we
659 do a thorough redisplay, we compare this against the buffer's
660 current display table to see whether the display table has
661 affected the widths of any characters. If it has, we
662 invalidate the width run cache, and re-initialize width_table. */
663 Lisp_Object width_table
;
665 /* In an indirect buffer, or a buffer that is the base of an
666 indirect buffer, this holds a marker that records
667 PT for this buffer when the buffer is not current. */
668 Lisp_Object pt_marker
;
670 /* In an indirect buffer, or a buffer that is the base of an
671 indirect buffer, this holds a marker that records
672 BEGV for this buffer when the buffer is not current. */
673 Lisp_Object begv_marker
;
675 /* In an indirect buffer, or a buffer that is the base of an
676 indirect buffer, this holds a marker that records
677 ZV for this buffer when the buffer is not current. */
678 Lisp_Object zv_marker
;
680 /* This holds the point value before the last scroll operation.
681 Explicitly setting point sets this to nil. */
682 Lisp_Object point_before_scroll
;
684 /* Truename of the visited file, or nil. */
685 Lisp_Object file_truename
;
687 /* Invisibility spec of this buffer.
688 t => any non-nil `invisible' property means invisible.
689 A list => `invisible' property means invisible
690 if it is memq in that list. */
691 Lisp_Object invisibility_spec
;
693 /* This is the last window that was selected with this buffer in it,
694 or nil if that window no longer displays this buffer. */
695 Lisp_Object last_selected_window
;
697 /* Incremented each time the buffer is displayed in a window. */
698 Lisp_Object display_count
;
700 /* Widths of left and right marginal areas for windows displaying
702 Lisp_Object left_margin_width
, right_margin_width
;
704 /* Non-nil means indicate lines not displaying text (in a style
706 Lisp_Object indicate_empty_lines
;
708 /* Time stamp updated each time this buffer is displayed in a window. */
709 Lisp_Object display_time
;
711 /* If scrolling the display because point is below the bottom of a
712 window showing this buffer, try to choose a window start so
713 that point ends up this number of lines from the top of the
714 window. Nil means that scrolling method isn't used. */
715 Lisp_Object scroll_up_aggressively
;
717 /* If scrolling the display because point is above the top of a
718 window showing this buffer, try to choose a window start so
719 that point ends up this number of lines from the bottom of the
720 window. Nil means that scrolling method isn't used. */
721 Lisp_Object scroll_down_aggressively
;
723 /* These are so we don't have to recompile everything
724 the next few times we add a new slot. */
725 Lisp_Object extra2
, extra3
;
728 /* This points to the current buffer. */
730 extern struct buffer
*current_buffer
;
732 /* This structure holds the default values of the buffer-local variables
733 that have special slots in each buffer.
734 The default value occupies the same slot in this structure
735 as an individual buffer's value occupies in that buffer.
736 Setting the default value also goes through the alist of buffers
737 and stores into each buffer that does not say it has a local value. */
739 extern struct buffer buffer_defaults
;
741 /* This structure marks which slots in a buffer have corresponding
742 default values in buffer_defaults.
743 Each such slot has a nonzero value in this structure.
744 The value has only one nonzero bit.
746 When a buffer has its own local value for a slot,
747 the bit for that slot (found in the same slot in this structure)
748 is turned on in the buffer's local_var_flags slot.
750 If a slot in this structure is zero, then even though there may
751 be a Lisp-level local variable for the slot, it has no default value,
752 and the corresponding slot in buffer_defaults is not used. */
754 extern struct buffer buffer_local_flags
;
756 /* For each buffer slot, this points to the Lisp symbol name
757 for that slot in the current buffer. It is 0 for slots
758 that don't have such names. */
760 extern struct buffer buffer_local_symbols
;
762 /* This structure holds the required types for the values in the
763 buffer-local slots. If a slot contains Qnil, then the
764 corresponding buffer slot may contain a value of any type. If a
765 slot contains an integer, then prospective values' tags must be
766 equal to that integer (except nil is always allowed).
767 When a tag does not match, the function
768 buffer_slot_type_mismatch will signal an error.
770 If a slot here contains -1, the corresponding variable is read-only. */
772 extern struct buffer buffer_local_types
;
774 extern void reset_buffer
P_ ((struct buffer
*));
775 extern void evaporate_overlays
P_ ((int));
776 extern int overlays_at
P_ ((int, int, Lisp_Object
**, int *, int *, int *));
777 extern int sort_overlays
P_ ((Lisp_Object
*, int, struct window
*));
778 extern void recenter_overlay_lists
P_ ((struct buffer
*, int));
779 extern int overlay_strings
P_ ((int, struct window
*, unsigned char **));
780 extern void validate_region
P_ ((Lisp_Object
*, Lisp_Object
*));
781 extern void set_buffer_internal
P_ ((struct buffer
*));
782 extern void set_buffer_internal_1
P_ ((struct buffer
*));
783 extern void set_buffer_temp
P_ ((struct buffer
*));
784 extern void record_buffer
P_ ((Lisp_Object
));
785 extern void buffer_slot_type_mismatch
P_ ((int));
786 extern void fix_overlays_before
P_ ((struct buffer
*, int, int));
789 EXFUN (Fbuffer_name
, 1);
790 EXFUN (Fget_file_buffer
, 1);
791 EXFUN (Fnext_overlay_change
, 1);
792 EXFUN (Fdelete_overlay
, 1);
794 /* Functions to call before and after each text change. */
795 extern Lisp_Object Vbefore_change_function
;
796 extern Lisp_Object Vafter_change_function
;
797 extern Lisp_Object Vbefore_change_functions
;
798 extern Lisp_Object Vafter_change_functions
;
799 extern Lisp_Object Vfirst_change_hook
;
800 extern Lisp_Object Qbefore_change_functions
;
801 extern Lisp_Object Qafter_change_functions
;
802 extern Lisp_Object Qfirst_change_hook
;
804 /* If nonzero, all modification hooks are suppressed. */
805 extern int inhibit_modification_hooks
;
807 extern Lisp_Object Vdeactivate_mark
;
808 extern Lisp_Object Vtransient_mark_mode
;
812 /* 1 if the OV is an overlay object. */
813 #define OVERLAY_VALID(OV) (OVERLAYP (OV))
815 /* Return the marker that stands for where OV starts in the buffer. */
816 #define OVERLAY_START(OV) (XOVERLAY (OV)->start)
818 /* Return the marker that stands for where OV ends in the buffer. */
819 #define OVERLAY_END(OV) (XOVERLAY (OV)->end)
821 /* Return the actual buffer position for the marker P.
822 We assume you know which buffer it's pointing into. */
824 #define OVERLAY_POSITION(P) \
825 (GC_MARKERP (P) ? marker_position (P) : (abort (), 0))
827 /* Allocation of buffer text. */
831 extern char *r_alloc
P_ ((char **, unsigned long));
832 extern void r_alloc_free
P_ ((char **ptr
));
833 extern char *r_re_alloc
P_ ((char **, unsigned long));
835 #define BUFFER_ALLOC(data,size) \
836 ((unsigned char *) r_alloc ((char **)&data, (size)))
837 #define BUFFER_REALLOC(data,size) \
838 ((unsigned char *) r_re_alloc ((char **) &data, (size)))
839 #define BUFFER_FREE(data) (r_alloc_free ((char **) &data))
840 #define R_ALLOC_DECLARE(var,data) (r_alloc_declare (&var, (data)))
842 #define BUFFER_ALLOC(data,size) (data = (unsigned char *) malloc ((size)))
843 #define BUFFER_REALLOC(data,size) ((unsigned char *) realloc ((data), (size)))
844 #define BUFFER_FREE(data) (free ((data)))
845 #define R_ALLOC_DECLARE(var,data)