1 /* Header file for the buffer manipulation primitives.
2 Copyright (C) 1985, 86, 93, 94, 95, 97, 1998 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 /* Macros to set PT in the current buffer, or another buffer.. */
163 #ifdef USE_TEXT_PROPERTIES
164 #define SET_PT(position) (set_point (current_buffer, (position)))
165 #define TEMP_SET_PT(position) (temp_set_point (current_buffer, (position)))
167 #define SET_PT_BOTH(position, byte) \
168 (set_point_both (current_buffer, (position), (byte)))
169 #define TEMP_SET_PT_BOTH(position, byte) \
170 (temp_set_point_both (current_buffer, (position), (byte)))
172 #define BUF_SET_PT(buffer, position) \
173 (set_point ((buffer), (position)))
174 #define BUF_TEMP_SET_PT(buffer, position) \
175 (temp_set_point ((buffer), (position)))
177 extern void set_point
P_ ((struct buffer
*, int));
178 extern INLINE
void temp_set_point
P_ ((struct buffer
*, int));
179 extern void set_point_both
P_ ((struct buffer
*, int, int));
180 extern INLINE
void temp_set_point_both
P_ ((struct buffer
*, int, int));
182 #else /* don't support text properties */
184 #define SET_PT(position) (current_buffer->pt = (position))
185 #define TEMP_SET_PT(position) (current_buffer->pt = (position))
187 #define SET_PT_BOTH(position, byte) \
188 (current_buffer->pt = (position), \
189 current_buffer->pt_byte = (byte))
191 #define TEMP_SET_PT_BOTH(position, byte) \
192 (current_buffer->pt = (position), \
193 current_buffer->pt_byte = (byte))
195 #define BUF_SET_PT(buffer, position) (buffer->pt = (position))
196 #define BUF_TEMP_SET_PT(buffer, position) (buffer->pt = (position))
197 #endif /* don't support text properties */
199 /* Macros for setting the BEGV, ZV or PT of a given buffer.
201 SET_BUF_PT* seet to be redundant. Get rid of them?
203 The ..._BOTH macros take both a charpos and a bytepos,
204 which must correspond to each other.
206 The macros without ..._BOTH take just a charpos,
207 and compute the bytepos from it. */
209 #define SET_BUF_BEGV(buf, charpos) \
210 ((buf)->begv_byte = buf_charpos_to_bytepos ((buf), (charpos)), \
211 (buf)->begv = (charpos))
213 #define SET_BUF_ZV(buf, charpos) \
214 ((buf)->zv_byte = buf_charpos_to_bytepos ((buf), (charpos)), \
215 (buf)->zv = (charpos))
217 #define SET_BUF_BEGV_BOTH(buf, charpos, byte) \
218 ((buf)->begv = (charpos), \
219 (buf)->begv_byte = (byte))
221 #define SET_BUF_ZV_BOTH(buf, charpos, byte) \
222 ((buf)->zv = (charpos), \
223 (buf)->zv_byte = (byte))
225 #define SET_BUF_PT_BOTH(buf, charpos, byte) \
226 ((buf)->pt = (charpos), \
227 (buf)->pt_byte = (byte))
229 /* Macros to access a character or byte in the current buffer,
230 or convert between a byte position and an address.
231 These macros do not check that the position is in range. */
233 /* Access a Lisp position value in POS,
234 and store the charpos in CHARPOS and the bypepos in BYPEPOS. */
236 #define DECODE_POSITION(charpos, bytepos, pos) \
239 Lisp_Object __pos = (pos); \
240 if (NUMBERP (__pos)) \
243 bytepos = buf_charpos_to_bytepos (current_buffer, __pos); \
245 else if (MARKERP (__pos)) \
247 charpos = marker_position (__pos); \
248 bytepos = marker_byte_position (__pos); \
251 wrong_type_argument (Qinteger_or_marker_p, __pos); \
255 /* Return the address of byte position N in current buffer. */
257 #define BYTE_POS_ADDR(n) \
258 (((n) >= GPT_BYTE ? GAP_SIZE : 0) + (n) + BEG_ADDR - 1)
260 /* Return the address of char position N. */
262 #define CHAR_POS_ADDR(n) \
263 (((n) >= GPT ? GAP_SIZE : 0) \
264 + buf_charpos_to_bytepos (current_buffer, n) \
267 /* Convert a character position to a byte position. */
269 #define CHAR_TO_BYTE(charpos) \
270 (buf_charpos_to_bytepos (current_buffer, charpos))
272 /* Convert a byte position to a character position. */
274 #define BYTE_TO_CHAR(bytepos) \
275 (buf_bytepos_to_charpos (current_buffer, bytepos))
277 /* Convert PTR, the address of a byte in the buffer, into a byte position. */
279 #define PTR_BYTE_POS(ptr) \
280 ((ptr) - (current_buffer)->text->beg \
281 - (ptr - (current_buffer)->text->beg < (unsigned) GPT_BYTE ? 0 : GAP_SIZE) \
284 /* Return character at position POS. */
286 #define FETCH_CHAR(pos) \
287 (!NILP (current_buffer->enable_multibyte_characters) \
288 ? FETCH_MULTIBYTE_CHAR ((pos)) \
289 : FETCH_BYTE ((pos)))
291 /* Return the byte at byte position N. */
293 #define FETCH_BYTE(n) *(BYTE_POS_ADDR ((n)))
295 /* Variables used locally in FETCH_MULTIBYTE_CHAR. */
296 extern unsigned char *_fetch_multibyte_char_p
;
297 extern int _fetch_multibyte_char_len
;
299 /* Return character code of multi-byte form at position POS. If POS
300 doesn't point the head of valid multi-byte form, only the byte at
301 POS is returned. No range checking. */
303 #define FETCH_MULTIBYTE_CHAR(pos) \
304 (_fetch_multibyte_char_p = (((pos) >= GPT_BYTE ? GAP_SIZE : 0) \
305 + (pos) + BEG_ADDR - 1), \
306 _fetch_multibyte_char_len \
307 = ((pos) >= GPT_BYTE ? ZV_BYTE : GPT_BYTE) - (pos), \
308 STRING_CHAR (_fetch_multibyte_char_p, _fetch_multibyte_char_len))
310 /* Macros for accessing a character or byte,
311 or converting between byte positions and addresses,
312 in a specified buffer. */
314 /* Return the address of character at byte position POS in buffer BUF.
315 Note that both arguments can be computed more than once. */
317 #define BUF_BYTE_ADDRESS(buf, pos) \
318 ((buf)->text->beg + (pos) - 1 \
319 + ((pos) >= (buf)->text->gpt_byte ? (buf)->text->gap_size : 0))
321 /* Return the address of character at char position POS in buffer BUF.
322 Note that both arguments can be computed more than once. */
324 #define BUF_CHAR_ADDRESS(buf, pos) \
325 ((buf)->text->beg + buf_charpos_to_bytepos ((buf), (pos)) - 1 \
326 + ((pos) >= (buf)->text->gpt ? (buf)->text->gap_size : 0))
328 /* Convert PTR, the address of a char in buffer BUF,
329 into a character position. */
331 #define BUF_PTR_BYTE_POS(buf, ptr) \
332 ((ptr) - (buf)->text->beg \
333 - (ptr - (buf)->text->beg < (unsigned) BUF_GPT_BYTE ((buf)) \
334 ? 0 : BUF_GAP_SIZE ((buf))) \
337 /* Return the character at byte position POS in buffer BUF. */
339 #define BUF_FETCH_CHAR(buf, pos) \
340 (!NILP (buf->enable_multibyte_characters) \
341 ? BUF_FETCH_MULTIBYTE_CHAR ((buf), (pos)) \
342 : BUF_FETCH_BYTE ((buf), (pos)))
344 /* Return the byte at byte position N in buffer BUF. */
346 #define BUF_FETCH_BYTE(buf, n) \
347 *(BUF_BYTE_ADDRESS ((buf), (n)))
349 /* Return character code of multi-byte form at byte position POS in BUF.
350 If POS doesn't point the head of valid multi-byte form, only the byte at
351 POS is returned. No range checking. */
353 #define BUF_FETCH_MULTIBYTE_CHAR(buf, pos) \
354 (_fetch_multibyte_char_p \
355 = (((pos) >= BUF_GPT_BYTE (buf) ? BUF_GAP_SIZE (buf) : 0) \
356 + (pos) + BUF_BEG_ADDR (buf) - 1), \
357 _fetch_multibyte_char_len \
358 = (((pos) >= BUF_GPT_BYTE (buf) ? BUF_ZV_BYTE (buf) : BUF_GPT_BYTE (buf)) \
360 STRING_CHAR (_fetch_multibyte_char_p, _fetch_multibyte_char_len))
362 /* Define the actual buffer data structures. */
364 /* This data structure describes the actual text contents of a buffer.
365 It is shared between indirect buffers and their base buffer. */
369 unsigned char *beg
; /* Actual address of buffer contents. */
370 int gpt
; /* Char pos of gap in buffer. */
371 int z
; /* Char pos of end of buffer. */
372 int gpt_byte
; /* Byte pos of gap in buffer. */
373 int z_byte
; /* Byte pos of end of buffer. */
374 int gap_size
; /* Size of buffer's gap. */
375 int modiff
; /* This counts buffer-modification events
376 for this buffer. It is incremented for
377 each such event, and never otherwise
379 int save_modiff
; /* Previous value of modiff, as of last
380 time buffer visited or saved a file. */
382 int overlay_modiff
; /* Counts modifications to overlays. */
384 /* Properties of this buffer's text -- conditionally compiled. */
387 /* The markers that refer to this buffer.
388 This is actually a single marker ---
389 successive elements in its marker `chain'
390 are the other markers referring to this buffer. */
394 /* This is the structure that the buffer Lisp object points to. */
398 /* Everything before the `name' slot must be of a non-Lisp_Object type,
399 and every slot after `name' must be a Lisp_Object.
401 Check out mark_buffer (alloc.c) to see why. */
405 /* Next buffer, in chain of all buffers including killed buffers.
406 This chain is used only for garbage collection, in order to
407 collect killed buffers properly.
408 Note that vectors and most pseudovectors are all on one chain,
409 but buffers are on a separate chain of their own. */
412 /* This structure holds the coordinates of the buffer contents
413 in ordinary buffers. In indirect buffers, this is not used. */
414 struct buffer_text own_text
;
416 /* This points to the `struct buffer_text' that used for this buffer.
417 In an ordinary buffer, this is the own_text field above.
418 In an indirect buffer, this is the own_text field of another buffer. */
419 struct buffer_text
*text
;
421 /* Char position of point in buffer. */
423 /* Byte position of point in buffer. */
425 /* Char position of beginning of accessible range. */
427 /* Byte position of beginning of accessible range. */
429 /* Char position of end of accessible range. */
431 /* Byte position of end of accessible range. */
434 /* In an indirect buffer, this points to the base buffer.
435 In an ordinary buffer, it is 0. */
436 struct buffer
*base_buffer
;
438 /* Flags saying which DEFVAR_PER_BUFFER variables
439 are local to this buffer. */
441 /* Set to the modtime of the visited file when read or written.
442 -1 means visited file was nonexistent.
443 0 means visited file modtime unknown; in no case complain
444 about any mismatch on next save attempt. */
446 /* the value of text->modiff at the last auto-save. */
447 int auto_save_modified
;
448 /* The time at which we detected a failure to auto-save,
449 Or -1 if we didn't have a failure. */
450 int auto_save_failure_time
;
451 /* Position in buffer at which display started
452 the last time this buffer was displayed. */
453 int last_window_start
;
455 /* Set nonzero whenever the narrowing is changed in this buffer. */
458 /* If the long line scan cache is enabled (i.e. the buffer-local
459 variable cache-long-line-scans is non-nil), newline_cache
460 points to the newline cache, and width_run_cache points to the
463 The newline cache records which stretches of the buffer are
464 known *not* to contain newlines, so that they can be skipped
465 quickly when we search for newlines.
467 The width run cache records which stretches of the buffer are
468 known to contain characters whose widths are all the same. If
469 the width run cache maps a character to a value > 0, that value is
470 the character's width; if it maps a character to zero, we don't
471 know what its width is. This allows compute_motion to process
472 such regions very quickly, using algebra instead of inspecting
473 each character. See also width_table, below. */
474 struct region_cache
*newline_cache
;
475 struct region_cache
*width_run_cache
;
477 /* Changes in the buffer are recorded here for undo.
478 t means don't record anything.
479 This information belongs to the base buffer of an indirect buffer,
480 But we can't store it in the struct buffer_text
481 because local variables have to be right in the struct buffer.
482 So we copy it around in set_buffer_internal.
483 This comes before `name' because it is marked in a special way. */
484 Lisp_Object undo_list
;
486 /* Everything from here down must be a Lisp_Object */
488 /* The name of this buffer. */
491 #if !NO_PROMPT_IN_BUFFER
492 /* Amount at the start of the buffer used by a minibuffer prompt,
493 or nil if this buffer is not a mini-buffer. */
494 Lisp_Object minibuffer_prompt_length
;
497 /* The name of the file visited in this buffer, or nil. */
498 Lisp_Object filename
;
499 /* Dir for expanding relative file names. */
500 Lisp_Object directory
;
501 /* True iff this buffer has been backed up (if you write to the
502 visited file and it hasn't been backed up, then a backup will
504 /* This isn't really used by the C code, so could be deleted. */
505 Lisp_Object backed_up
;
506 /* Length of file when last read or saved.
507 This is not in the struct buffer_text
508 because it's not used in indirect buffers at all. */
509 Lisp_Object save_length
;
510 /* File name used for auto-saving this buffer.
511 This is not in the struct buffer_text
512 because it's not used in indirect buffers at all. */
513 Lisp_Object auto_save_file_name
;
515 /* Non-nil if buffer read-only. */
516 Lisp_Object read_only
;
517 /* "The mark". This is a marker which may
518 point into this buffer or may point nowhere. */
521 /* Alist of elements (SYMBOL . VALUE-IN-THIS-BUFFER)
522 for all per-buffer variables of this buffer. */
523 Lisp_Object local_var_alist
;
525 /* Symbol naming major mode (eg, lisp-mode). */
526 Lisp_Object major_mode
;
527 /* Pretty name of major mode (eg, "Lisp"). */
528 Lisp_Object mode_name
;
529 /* Mode line element that controls format of mode line. */
530 Lisp_Object mode_line_format
;
532 /* Analogous to mode_line_format for the line displayed at the top
533 of windows. Nil means don't display that line. */
534 Lisp_Object top_line_format
;
536 /* Keys that are bound local to this buffer. */
538 /* This buffer's local abbrev table. */
539 Lisp_Object abbrev_table
;
540 /* This buffer's syntax table. */
541 Lisp_Object syntax_table
;
542 /* This buffer's category table. */
543 Lisp_Object category_table
;
545 /* Values of several buffer-local variables */
546 /* tab-width is buffer-local so that redisplay can find it
547 in buffers that are not current */
548 Lisp_Object case_fold_search
;
549 Lisp_Object tab_width
;
550 Lisp_Object fill_column
;
551 Lisp_Object left_margin
;
552 /* Function to call when insert space past fill column. */
553 Lisp_Object auto_fill_function
;
554 /* nil: text, t: binary.
555 This value is meaningful only on certain operating systems. */
556 /* Actually, we don't need this flag any more because end-of-line
557 is handled correctly according to the buffer-file-coding-system
558 of the buffer. Just keeping it for backward compatibility. */
559 Lisp_Object buffer_file_type
;
561 /* Case table for case-conversion in this buffer.
562 This char-table maps each char into its lower-case version. */
563 Lisp_Object downcase_table
;
564 /* Char-table mapping each char to its upper-case version. */
565 Lisp_Object upcase_table
;
566 /* Char-table for conversion for case-folding search. */
567 Lisp_Object case_canon_table
;
568 /* Char-table of equivalences for case-folding search. */
569 Lisp_Object case_eqv_table
;
571 /* Non-nil means do not display continuation lines. */
572 Lisp_Object truncate_lines
;
573 /* Non-nil means display ctl chars with uparrow. */
574 Lisp_Object ctl_arrow
;
575 /* Non-nil means display text from right to left. */
576 Lisp_Object direction_reversed
;
577 /* Non-nil means do selective display;
578 see doc string in syms_of_buffer (buffer.c) for details. */
579 Lisp_Object selective_display
;
581 /* Non-nil means show ... at end of line followed by invisible lines. */
582 Lisp_Object selective_display_ellipses
;
584 /* Alist of (FUNCTION . STRING) for each minor mode enabled in buffer. */
585 Lisp_Object minor_modes
;
586 /* t if "self-insertion" should overwrite; `binary' if it should also
587 overwrite newlines and tabs - for editing executables and the like. */
588 Lisp_Object overwrite_mode
;
589 /* non-nil means abbrev mode is on. Expand abbrevs automatically. */
590 Lisp_Object abbrev_mode
;
591 /* Display table to use for text in this buffer. */
592 Lisp_Object display_table
;
593 /* t means the mark and region are currently active. */
594 Lisp_Object mark_active
;
596 /* List of overlays that end at or before the current center,
597 in order of end-position. */
598 Lisp_Object overlays_before
;
600 /* List of overlays that end after the current center,
601 in order of start-position. */
602 Lisp_Object overlays_after
;
604 /* Position where the overlay lists are centered. */
605 Lisp_Object overlay_center
;
607 /* Non-nil means the buffer contents are regarded as multi-byte
608 form of characters, not a binary code. */
609 Lisp_Object enable_multibyte_characters
;
611 /* Coding system to be used for encoding the buffer contents on
613 Lisp_Object buffer_file_coding_system
;
615 /* List of symbols naming the file format used for visited file. */
616 Lisp_Object file_format
;
618 /* True if the newline position cache and width run cache are
619 enabled. See search.c and indent.c. */
620 Lisp_Object cache_long_line_scans
;
622 /* If the width run cache is enabled, this table contains the
623 character widths width_run_cache (see above) assumes. When we
624 do a thorough redisplay, we compare this against the buffer's
625 current display table to see whether the display table has
626 affected the widths of any characters. If it has, we
627 invalidate the width run cache, and re-initialize width_table. */
628 Lisp_Object width_table
;
630 /* In an indirect buffer, or a buffer that is the base of an
631 indirect buffer, this holds a marker that records
632 PT for this buffer when the buffer is not current. */
633 Lisp_Object pt_marker
;
635 /* In an indirect buffer, or a buffer that is the base of an
636 indirect buffer, this holds a marker that records
637 BEGV for this buffer when the buffer is not current. */
638 Lisp_Object begv_marker
;
640 /* In an indirect buffer, or a buffer that is the base of an
641 indirect buffer, this holds a marker that records
642 ZV for this buffer when the buffer is not current. */
643 Lisp_Object zv_marker
;
645 /* This holds the point value before the last scroll operation.
646 Explicitly setting point sets this to nil. */
647 Lisp_Object point_before_scroll
;
649 /* Truename of the visited file, or nil. */
650 Lisp_Object file_truename
;
652 /* Invisibility spec of this buffer.
653 t => any non-nil `invisible' property means invisible.
654 A list => `invisible' property means invisible
655 if it is memq in that list. */
656 Lisp_Object invisibility_spec
;
658 /* This is the last window that was selected with this buffer in it,
659 or nil if that window no longer displays this buffer. */
660 Lisp_Object last_selected_window
;
662 /* Incremented each time the buffer is displayed in a window. */
663 Lisp_Object display_count
;
665 /* Widths of left and right marginal areas for windows displaying
667 Lisp_Object left_margin_width
, right_margin_width
;
669 /* Non-nil means indicate lines not displaying text (in a style
671 Lisp_Object indicate_empty_lines
;
673 /* Time stamp updated each time this buffer is displayed in a window. */
674 Lisp_Object display_time
;
676 /* If scrolling the display because point is below the bottom of a
677 window showing this buffer, try to choose a window start so
678 that point ends up this number of lines from the top of the
679 window. Nil means that scrolling method isn't used. */
680 Lisp_Object scroll_up_aggressively
;
682 /* If scrolling the display because point is above the top of a
683 window showing this buffer, try to choose a window start so
684 that point ends up this number of lines from the bottom of the
685 window. Nil means that scrolling method isn't used. */
686 Lisp_Object scroll_down_aggressively
;
688 /* These are so we don't have to recompile everything
689 the next few times we add a new slot. */
690 Lisp_Object extra2
, extra3
;
693 /* This points to the current buffer. */
695 extern struct buffer
*current_buffer
;
697 /* This structure holds the default values of the buffer-local variables
698 that have special slots in each buffer.
699 The default value occupies the same slot in this structure
700 as an individual buffer's value occupies in that buffer.
701 Setting the default value also goes through the alist of buffers
702 and stores into each buffer that does not say it has a local value. */
704 extern struct buffer buffer_defaults
;
706 /* This structure marks which slots in a buffer have corresponding
707 default values in buffer_defaults.
708 Each such slot has a nonzero value in this structure.
709 The value has only one nonzero bit.
711 When a buffer has its own local value for a slot,
712 the bit for that slot (found in the same slot in this structure)
713 is turned on in the buffer's local_var_flags slot.
715 If a slot in this structure is zero, then even though there may
716 be a Lisp-level local variable for the slot, it has no default value,
717 and the corresponding slot in buffer_defaults is not used. */
719 extern struct buffer buffer_local_flags
;
721 /* For each buffer slot, this points to the Lisp symbol name
722 for that slot in the current buffer. It is 0 for slots
723 that don't have such names. */
725 extern struct buffer buffer_local_symbols
;
727 /* This structure holds the required types for the values in the
728 buffer-local slots. If a slot contains Qnil, then the
729 corresponding buffer slot may contain a value of any type. If a
730 slot contains an integer, then prospective values' tags must be
731 equal to that integer (except nil is always allowed).
732 When a tag does not match, the function
733 buffer_slot_type_mismatch will signal an error.
735 If a slot here contains -1, the corresponding variable is read-only. */
737 extern struct buffer buffer_local_types
;
739 extern void reset_buffer
P_ ((struct buffer
*));
740 extern void evaporate_overlays
P_ ((int));
741 extern int overlays_at
P_ ((int, int, Lisp_Object
**, int *, int *, int *));
742 extern int sort_overlays
P_ ((Lisp_Object
*, int, struct window
*));
743 extern void recenter_overlay_lists
P_ ((struct buffer
*, int));
744 extern int overlay_strings
P_ ((int, struct window
*, unsigned char **));
745 extern void validate_region
P_ ((Lisp_Object
*, Lisp_Object
*));
746 extern void set_buffer_internal
P_ ((struct buffer
*));
747 extern void set_buffer_internal_1
P_ ((struct buffer
*));
748 extern void set_buffer_temp
P_ ((struct buffer
*));
749 extern void record_buffer
P_ ((Lisp_Object
));
750 extern void buffer_slot_type_mismatch
P_ ((int));
751 extern void fix_overlays_before
P_ ((struct buffer
*, int, int));
754 EXFUN (Fbuffer_name
, 1);
755 EXFUN (Fget_file_buffer
, 1);
756 EXFUN (Fnext_overlay_change
, 1);
757 EXFUN (Fdelete_overlay
, 1);
759 /* Functions to call before and after each text change. */
760 extern Lisp_Object Vbefore_change_function
;
761 extern Lisp_Object Vafter_change_function
;
762 extern Lisp_Object Vbefore_change_functions
;
763 extern Lisp_Object Vafter_change_functions
;
764 extern Lisp_Object Vfirst_change_hook
;
765 extern Lisp_Object Qbefore_change_functions
;
766 extern Lisp_Object Qafter_change_functions
;
767 extern Lisp_Object Qfirst_change_hook
;
769 /* If nonzero, all modification hooks are suppressed. */
770 extern int inhibit_modification_hooks
;
772 extern Lisp_Object Vdeactivate_mark
;
773 extern Lisp_Object Vtransient_mark_mode
;
777 /* 1 if the OV is an overlay object. */
778 #define OVERLAY_VALID(OV) (OVERLAYP (OV))
780 /* Return the marker that stands for where OV starts in the buffer. */
781 #define OVERLAY_START(OV) (XOVERLAY (OV)->start)
783 /* Return the marker that stands for where OV ends in the buffer. */
784 #define OVERLAY_END(OV) (XOVERLAY (OV)->end)
786 /* Return the actual buffer position for the marker P.
787 We assume you know which buffer it's pointing into. */
789 #define OVERLAY_POSITION(P) \
790 (GC_MARKERP (P) ? marker_position (P) : (abort (), 0))
792 /* Allocation of buffer text. */
795 #define BUFFER_ALLOC(data,size) ((unsigned char *) r_alloc (&data, (size)))
796 #define BUFFER_REALLOC(data,size) ((unsigned char *) r_re_alloc (&data, (size)))
797 #define BUFFER_FREE(data) (r_alloc_free (&data))
798 #define R_ALLOC_DECLARE(var,data) (r_alloc_declare (&var, (data)))
800 #define BUFFER_ALLOC(data,size) (data = (unsigned char *) malloc ((size)))
801 #define BUFFER_REALLOC(data,size) ((unsigned char *) realloc ((data), (size)))
802 #define BUFFER_FREE(data) (free ((data)))
803 #define R_ALLOC_DECLARE(var,data)