/* Header file for the buffer manipulation primitives.
- Copyright (C) 1985, 1986, 1990, 1993 Free Software Foundation, Inc.
+ Copyright (C) 1985, 86, 93, 94, 95, 97, 1998 Free Software Foundation, Inc.
This file is part of GNU Emacs.
You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING. If not, write to
-the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
+the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+Boston, MA 02111-1307, USA. */
-#ifdef USE_TEXT_PROPERTIES
-#define SET_PT(position) (set_point ((position), current_buffer))
-#define TEMP_SET_PT(position) (temp_set_point ((position), current_buffer))
-
-#define BUF_SET_PT(buffer, position) (set_point ((position), (buffer)))
-#define BUF_TEMP_SET_PT(buffer, position) (temp_set_point ((position), (buffer)))
-
-#else /* don't support text properties */
+/* Accessing the parameters of the current buffer. */
-#define SET_PT(position) (current_buffer->text.pt = (position))
-#define TEMP_SET_PT(position) (current_buffer->text.pt = (position))
+/* These macros come in pairs, one for the char position
+ and one for the byte position. */
-#define BUF_SET_PT(buffer, position) (buffer->text.pt = (position))
-#define BUF_TEMP_SET_PT(buffer, position) (buffer->text.pt = (position))
-#endif /* don't support text properties */
-
-/* Character position of beginning of buffer. */
+/* Position of beginning of buffer. */
#define BEG (1)
+#define BEG_BYTE (1)
-/* Character position of beginning of accessible range of buffer. */
-#define BEGV (current_buffer->text.begv)
+/* Position of beginning of accessible range of buffer. */
+#define BEGV (current_buffer->begv)
+#define BEGV_BYTE (current_buffer->begv_byte)
-/* Character position of point in buffer. The "+ 0" makes this
+/* Position of point in buffer. The "+ 0" makes this
not an l-value, so you can't assign to it. Use SET_PT instead. */
-#define PT (current_buffer->text.pt + 0)
+#define PT (current_buffer->pt + 0)
+#define PT_BYTE (current_buffer->pt_byte + 0)
-/* Character position of gap in buffer. */
-#define GPT (current_buffer->text.gpt)
+/* Position of gap in buffer. */
+#define GPT (current_buffer->text->gpt)
+#define GPT_BYTE (current_buffer->text->gpt_byte)
-/* Character position of end of accessible range of buffer. */
-#define ZV (current_buffer->text.zv)
+/* Position of end of accessible range of buffer. */
+#define ZV (current_buffer->zv)
+#define ZV_BYTE (current_buffer->zv_byte)
-/* Character position of end of buffer. */
-#define Z (current_buffer->text.z)
+/* Position of end of buffer. */
+#define Z (current_buffer->text->z)
+#define Z_BYTE (current_buffer->text->z_byte)
-/* Modification count. */
-#define MODIFF (current_buffer->text.modiff)
+/* Macros for the addresses of places in the buffer. */
/* Address of beginning of buffer. */
-#define BEG_ADDR (current_buffer->text.beg)
+#define BEG_ADDR (current_buffer->text->beg)
/* Address of beginning of accessible range of buffer. */
-#define BEGV_ADDR (&FETCH_CHAR (current_buffer->text.begv))
+#define BEGV_ADDR (BYTE_POS_ADDR (current_buffer->begv_byte))
/* Address of point in buffer. */
-#define PT_ADDR (&FETCH_CHAR (current_buffer->text.pt))
+#define PT_ADDR (BYTE_POS_ADDR (current_buffer->pt_byte))
/* Address of beginning of gap in buffer. */
-#define GPT_ADDR (current_buffer->text.beg + current_buffer->text.gpt - 1)
+#define GPT_ADDR (current_buffer->text->beg + current_buffer->text->gpt_byte - 1)
/* Address of end of gap in buffer. */
-#define GAP_END_ADDR (current_buffer->text.beg + current_buffer->text.gpt + current_buffer->text.gap_size - 1)
+#define GAP_END_ADDR (current_buffer->text->beg + current_buffer->text->gpt_byte + current_buffer->text->gap_size - 1)
/* Address of end of accessible range of buffer. */
-#define ZV_ADDR (&FETCH_CHAR (current_buffer->text.zv))
+#define ZV_ADDR (BYTE_POS_ADDR (current_buffer->zv_byte))
+
+/* Address of end of buffer. */
+#define Z_ADDR (current_buffer->text->beg + current_buffer->text->gap_size + current_buffer->text->z_byte - 1)
/* Size of gap. */
-#define GAP_SIZE (current_buffer->text.gap_size)
+#define GAP_SIZE (current_buffer->text->gap_size)
+
+/* Is the current buffer narrowed? */
+#define NARROWED ((BEGV != BEG) || (ZV != Z))
+
+/* Modification count. */
+#define MODIFF (current_buffer->text->modiff)
+
+/* Overlay modification count. */
+#define OVERLAY_MODIFF (current_buffer->text->overlay_modiff)
+
+/* Modification count as of last visit or save. */
+#define SAVE_MODIFF (current_buffer->text->save_modiff)
+
+/* BUFFER_CEILING_OF (resp. BUFFER_FLOOR_OF), when applied to n, return
+ the max (resp. min) p such that
+
+ BYTE_POS_ADDR (p) - BYTE_POS_ADDR (n) == p - n */
-/* Now similar macros for a specified buffer.
+#define BUFFER_CEILING_OF(BYTEPOS) \
+ (((BYTEPOS) < GPT_BYTE && GPT < ZV ? GPT_BYTE : ZV_BYTE) - 1)
+#define BUFFER_FLOOR_OF(BYTEPOS) \
+ (BEGV <= GPT && GPT_BYTE <= (BYTEPOS) ? GPT_BYTE : BEGV_BYTE)
+\f
+/* Similar macros to operate on a specified buffer.
Note that many of these evaluate the buffer argument more than once. */
-/* Character position of beginning of buffer. */
+/* Position of beginning of buffer. */
#define BUF_BEG(buf) (1)
+#define BUF_BEG_BYTE(buf) (1)
-/* Character position of beginning of accessible range of buffer. */
-#define BUF_BEGV(buf) ((buf)->text.begv)
-
-/* Character position of point in buffer. */
-#define BUF_PT(buf) ((buf)->text.pt)
+/* Position of beginning of accessible range of buffer. */
+#define BUF_BEGV(buf) ((buf)->begv)
+#define BUF_BEGV_BYTE(buf) ((buf)->begv_byte)
-/* Character position of gap in buffer. */
-#define BUF_GPT(buf) ((buf)->text.gpt)
+/* Position of point in buffer. */
+#define BUF_PT(buf) ((buf)->pt)
+#define BUF_PT_BYTE(buf) ((buf)->pt_byte)
-/* Character position of end of accessible range of buffer. */
-#define BUF_ZV(buf) ((buf)->text.zv)
+/* Position of gap in buffer. */
+#define BUF_GPT(buf) ((buf)->text->gpt)
+#define BUF_GPT_BYTE(buf) ((buf)->text->gpt_byte)
-/* Character position of end of buffer. */
-#define BUF_Z(buf) ((buf)->text.z)
+/* Position of end of accessible range of buffer. */
+#define BUF_ZV(buf) ((buf)->zv)
+#define BUF_ZV_BYTE(buf) ((buf)->zv_byte)
-/* Modification count. */
-#define BUF_MODIFF(buf) ((buf)->text.modiff)
+/* Position of end of buffer. */
+#define BUF_Z(buf) ((buf)->text->z)
+#define BUF_Z_BYTE(buf) ((buf)->text->z_byte)
/* Address of beginning of buffer. */
-#define BUF_BEG_ADDR(buf) ((buf)->text.beg)
+#define BUF_BEG_ADDR(buf) ((buf)->text->beg)
+
+/* Address of beginning of gap of buffer. */
+#define BUF_GPT_ADDR(buf) ((buf)->text->beg + (buf)->text->gpt_byte - 1)
-/* Macro for setting the value of BUF_ZV (BUF) to VALUE,
- by varying the end of the accessible region. */
-#define SET_BUF_ZV(buf, value) ((buf)->text.zv = (value))
-#define SET_BUF_PT(buf, value) ((buf)->text.pt = (value))
+/* Address of end of buffer. */
+#define BUF_Z_ADDR(buf) ((buf)->text->beg + (buf)->text->gap_size + (buf)->text->z_byte - 1)
+
+/* Address of end of gap in buffer. */
+#define BUF_GAP_END_ADDR(buf) ((buf)->text->beg + (buf)->text->gpt_byte + (buf)->text->gap_size - 1)
/* Size of gap. */
-#define BUF_GAP_SIZE(buf) ((buf)->text.gap_size)
+#define BUF_GAP_SIZE(buf) ((buf)->text->gap_size)
+
+/* Is this buffer narrowed? */
+#define BUF_NARROWED(buf) ((BUF_BEGV (buf) != BUF_BEG (buf)) \
+ || (BUF_ZV (buf) != BUF_Z (buf)))
+
+/* Modification count. */
+#define BUF_MODIFF(buf) ((buf)->text->modiff)
+
+/* Modification count as of last visit or save. */
+#define BUF_SAVE_MODIFF(buf) ((buf)->text->save_modiff)
+
+/* Overlay modification count. */
+#define BUF_OVERLAY_MODIFF(buf) ((buf)->text->overlay_modiff)
+
+/* Interval tree of buffer. */
+#define BUF_INTERVALS(buf) ((buf)->text->intervals)
+
+/* Marker chain of buffer. */
+#define BUF_MARKERS(buf) ((buf)->text->markers)
+\f
+/* Macros to set PT in the current buffer, or another buffer.. */
+
+#ifdef USE_TEXT_PROPERTIES
+#define SET_PT(position) (set_point (current_buffer, (position)))
+#define TEMP_SET_PT(position) (temp_set_point (current_buffer, (position)))
+
+#define SET_PT_BOTH(position, byte) \
+ (set_point_both (current_buffer, (position), (byte)))
+#define TEMP_SET_PT_BOTH(position, byte) \
+ (temp_set_point_both (current_buffer, (position), (byte)))
+
+#define BUF_SET_PT(buffer, position) \
+ (set_point ((buffer), (position)))
+#define BUF_TEMP_SET_PT(buffer, position) \
+ (temp_set_point ((buffer), (position)))
+
+extern void set_point P_ ((struct buffer *, int));
+extern INLINE void temp_set_point P_ ((struct buffer *, int));
+extern void set_point_both P_ ((struct buffer *, int, int));
+extern INLINE void temp_set_point_both P_ ((struct buffer *, int, int));
+
+#else /* don't support text properties */
+
+#define SET_PT(position) (current_buffer->pt = (position))
+#define TEMP_SET_PT(position) (current_buffer->pt = (position))
+
+#define SET_PT_BOTH(position, byte) \
+ (current_buffer->pt = (position), \
+ current_buffer->pt_byte = (byte))
+
+#define TEMP_SET_PT_BOTH(position, byte) \
+ (current_buffer->pt = (position), \
+ current_buffer->pt_byte = (byte))
+
+#define BUF_SET_PT(buffer, position) (buffer->pt = (position))
+#define BUF_TEMP_SET_PT(buffer, position) (buffer->pt = (position))
+#endif /* don't support text properties */
+\f
+/* Macros for setting the BEGV, ZV or PT of a given buffer.
+
+ SET_BUF_PT* seet to be redundant. Get rid of them?
+
+ The ..._BOTH macros take both a charpos and a bytepos,
+ which must correspond to each other.
+
+ The macros without ..._BOTH take just a charpos,
+ and compute the bytepos from it. */
+
+#define SET_BUF_BEGV(buf, charpos) \
+ ((buf)->begv_byte = buf_charpos_to_bytepos ((buf), (charpos)), \
+ (buf)->begv = (charpos))
+
+#define SET_BUF_ZV(buf, charpos) \
+ ((buf)->zv_byte = buf_charpos_to_bytepos ((buf), (charpos)), \
+ (buf)->zv = (charpos))
+
+#define SET_BUF_BEGV_BOTH(buf, charpos, byte) \
+ ((buf)->begv = (charpos), \
+ (buf)->begv_byte = (byte))
+
+#define SET_BUF_ZV_BOTH(buf, charpos, byte) \
+ ((buf)->zv = (charpos), \
+ (buf)->zv_byte = (byte))
+
+#define SET_BUF_PT_BOTH(buf, charpos, byte) \
+ ((buf)->pt = (charpos), \
+ (buf)->pt_byte = (byte))
+\f
+/* Macros to access a character or byte in the current buffer,
+ or convert between a byte position and an address.
+ These macros do not check that the position is in range. */
+
+/* Access a Lisp position value in POS,
+ and store the charpos in CHARPOS and the bypepos in BYPEPOS. */
+
+#define DECODE_POSITION(charpos, bytepos, pos) \
+if (1) \
+ { \
+ Lisp_Object __pos = (pos); \
+ if (NUMBERP (__pos)) \
+ { \
+ charpos = __pos; \
+ bytepos = buf_charpos_to_bytepos (current_buffer, __pos); \
+ } \
+ else if (MARKERP (__pos)) \
+ { \
+ charpos = marker_position (__pos); \
+ bytepos = marker_byte_position (__pos); \
+ } \
+ else \
+ wrong_type_argument (Qinteger_or_marker_p, __pos); \
+ } \
+else
+
+/* Return the address of byte position N in current buffer. */
+
+#define BYTE_POS_ADDR(n) \
+ (((n) >= GPT_BYTE ? GAP_SIZE : 0) + (n) + BEG_ADDR - 1)
+
+/* Return the address of char position N. */
+
+#define CHAR_POS_ADDR(n) \
+ (((n) >= GPT ? GAP_SIZE : 0) \
+ + buf_charpos_to_bytepos (current_buffer, n) \
+ + BEG_ADDR - 1)
+
+/* Convert a character position to a byte position. */
+
+#define CHAR_TO_BYTE(charpos) \
+ (buf_charpos_to_bytepos (current_buffer, charpos))
+
+/* Convert a byte position to a character position. */
+
+#define BYTE_TO_CHAR(bytepos) \
+ (buf_bytepos_to_charpos (current_buffer, bytepos))
+
+/* Convert PTR, the address of a byte in the buffer, into a byte position. */
+
+#define PTR_BYTE_POS(ptr) \
+((ptr) - (current_buffer)->text->beg \
+ - (ptr - (current_buffer)->text->beg < (unsigned) GPT_BYTE ? 0 : GAP_SIZE) \
+ + 1)
+
+/* Return character at position POS. */
+
+#define FETCH_CHAR(pos) \
+ (!NILP (current_buffer->enable_multibyte_characters) \
+ ? FETCH_MULTIBYTE_CHAR ((pos)) \
+ : FETCH_BYTE ((pos)))
+
+/* Return the byte at byte position N. */
+
+#define FETCH_BYTE(n) *(BYTE_POS_ADDR ((n)))
+
+/* Variables used locally in FETCH_MULTIBYTE_CHAR. */
+extern unsigned char *_fetch_multibyte_char_p;
+extern int _fetch_multibyte_char_len;
+
+/* Return character code of multi-byte form at position POS. If POS
+ doesn't point the head of valid multi-byte form, only the byte at
+ POS is returned. No range checking. */
-/* Return the address of character at position POS in buffer BUF.
+#define FETCH_MULTIBYTE_CHAR(pos) \
+ (_fetch_multibyte_char_p = (((pos) >= GPT_BYTE ? GAP_SIZE : 0) \
+ + (pos) + BEG_ADDR - 1), \
+ _fetch_multibyte_char_len \
+ = ((pos) >= GPT_BYTE ? ZV_BYTE : GPT_BYTE) - (pos), \
+ STRING_CHAR (_fetch_multibyte_char_p, _fetch_multibyte_char_len))
+\f
+/* Macros for accessing a character or byte,
+ or converting between byte positions and addresses,
+ in a specified buffer. */
+
+/* Return the address of character at byte position POS in buffer BUF.
+ Note that both arguments can be computed more than once. */
+
+#define BUF_BYTE_ADDRESS(buf, pos) \
+((buf)->text->beg + (pos) - 1 \
+ + ((pos) >= (buf)->text->gpt_byte ? (buf)->text->gap_size : 0))
+
+/* Return the address of character at char position POS in buffer BUF.
Note that both arguments can be computed more than once. */
+
#define BUF_CHAR_ADDRESS(buf, pos) \
-((buf)->text.beg + (pos) - 1 \
- + ((pos) >= (buf)->text.gpt ? (buf)->text.gap_size : 0))
+((buf)->text->beg + buf_charpos_to_bytepos ((buf), (pos)) - 1 \
+ + ((pos) >= (buf)->text->gpt ? (buf)->text->gap_size : 0))
-/* Convert the address of a char in the buffer into a character position. */
-#define PTR_CHAR_POS(ptr) \
-((ptr) - (current_buffer)->text.beg \
- - (ptr - (current_buffer)->text.beg < (unsigned) GPT ? 0 : GAP_SIZE) \
+/* Convert PTR, the address of a char in buffer BUF,
+ into a character position. */
+
+#define BUF_PTR_BYTE_POS(buf, ptr) \
+((ptr) - (buf)->text->beg \
+ - (ptr - (buf)->text->beg < (unsigned) BUF_GPT_BYTE ((buf)) \
+ ? 0 : BUF_GAP_SIZE ((buf))) \
+ 1)
+
+/* Return the character at byte position POS in buffer BUF. */
+
+#define BUF_FETCH_CHAR(buf, pos) \
+ (!NILP (buf->enable_multibyte_characters) \
+ ? BUF_FETCH_MULTIBYTE_CHAR ((buf), (pos)) \
+ : BUF_FETCH_BYTE ((buf), (pos)))
+
+/* Return the byte at byte position N in buffer BUF. */
+
+#define BUF_FETCH_BYTE(buf, n) \
+ *(BUF_BYTE_ADDRESS ((buf), (n)))
+
+/* Return character code of multi-byte form at byte position POS in BUF.
+ If POS doesn't point the head of valid multi-byte form, only the byte at
+ POS is returned. No range checking. */
+
+#define BUF_FETCH_MULTIBYTE_CHAR(buf, pos) \
+ (_fetch_multibyte_char_p \
+ = (((pos) >= BUF_GPT_BYTE (buf) ? BUF_GAP_SIZE (buf) : 0) \
+ + (pos) + BUF_BEG_ADDR (buf) - 1), \
+ _fetch_multibyte_char_len \
+ = (((pos) >= BUF_GPT_BYTE (buf) ? BUF_ZV_BYTE (buf) : BUF_GPT_BYTE (buf)) \
+ - (pos)), \
+ STRING_CHAR (_fetch_multibyte_char_p, _fetch_multibyte_char_len))
\f
+/* Define the actual buffer data structures. */
+
+/* This data structure describes the actual text contents of a buffer.
+ It is shared between indirect buffers and their base buffer. */
+
struct buffer_text
{
- unsigned char *beg; /* Actual address of buffer contents. */
- int begv; /* Index of beginning of accessible range. */
- int pt; /* Position of point in buffer. */
- int gpt; /* Index of gap in buffer. */
- int zv; /* Index of end of accessible range. */
- int z; /* Index of end of buffer. */
- int gap_size; /* Size of buffer's gap */
+ unsigned char *beg; /* Actual address of buffer contents. */
+ int gpt; /* Char pos of gap in buffer. */
+ int z; /* Char pos of end of buffer. */
+ int gpt_byte; /* Byte pos of gap in buffer. */
+ int z_byte; /* Byte pos of end of buffer. */
+ int gap_size; /* Size of buffer's gap. */
int modiff; /* This counts buffer-modification events
for this buffer. It is incremented for
each such event, and never otherwise
changed. */
+ int save_modiff; /* Previous value of modiff, as of last
+ time buffer visited or saved a file. */
+
+ int overlay_modiff; /* Counts modifications to overlays. */
+
+ /* Properties of this buffer's text -- conditionally compiled. */
+ DECLARE_INTERVALS
+
+ /* The markers that refer to this buffer.
+ This is actually a single marker ---
+ successive elements in its marker `chain'
+ are the other markers referring to this buffer. */
+ Lisp_Object markers;
};
+/* This is the structure that the buffer Lisp object points to. */
+
struct buffer
{
/* Everything before the `name' slot must be of a non-Lisp_Object type,
and every slot after `name' must be a Lisp_Object.
- Check out mark_buffer (alloc.c) to see why.
- */
+ Check out mark_buffer (alloc.c) to see why. */
+
+ EMACS_INT size;
- /* This structure holds the coordinates of the buffer contents. */
- struct buffer_text text;
/* Next buffer, in chain of all buffers including killed buffers.
This chain is used only for garbage collection, in order to
- collect killed buffers properly. */
+ collect killed buffers properly.
+ Note that vectors and most pseudovectors are all on one chain,
+ but buffers are on a separate chain of their own. */
struct buffer *next;
+
+ /* This structure holds the coordinates of the buffer contents
+ in ordinary buffers. In indirect buffers, this is not used. */
+ struct buffer_text own_text;
+
+ /* This points to the `struct buffer_text' that used for this buffer.
+ In an ordinary buffer, this is the own_text field above.
+ In an indirect buffer, this is the own_text field of another buffer. */
+ struct buffer_text *text;
+
+ /* Char position of point in buffer. */
+ int pt;
+ /* Byte position of point in buffer. */
+ int pt_byte;
+ /* Char position of beginning of accessible range. */
+ int begv;
+ /* Byte position of beginning of accessible range. */
+ int begv_byte;
+ /* Char position of end of accessible range. */
+ int zv;
+ /* Byte position of end of accessible range. */
+ int zv_byte;
+
+ /* In an indirect buffer, this points to the base buffer.
+ In an ordinary buffer, it is 0. */
+ struct buffer *base_buffer;
+
/* Flags saying which DEFVAR_PER_BUFFER variables
are local to this buffer. */
int local_var_flags;
- /* Value of text.modiff as of when visited file was read or written. */
- int save_modified;
/* Set to the modtime of the visited file when read or written.
-1 means visited file was nonexistent.
0 means visited file modtime unknown; in no case complain
about any mismatch on next save attempt. */
int modtime;
- /* the value of text.modiff at the last auto-save. */
+ /* the value of text->modiff at the last auto-save. */
int auto_save_modified;
+ /* The time at which we detected a failure to auto-save,
+ Or -1 if we didn't have a failure. */
+ int auto_save_failure_time;
/* Position in buffer at which display started
- the last time this buffer was displayed */
+ the last time this buffer was displayed. */
int last_window_start;
- /* Properties of this buffer's text -- conditionally compiled. */
- DECLARE_INTERVALS
+ /* Set nonzero whenever the narrowing is changed in this buffer. */
+ int clip_changed;
- /* This is a special exception -- as this slot should not be
- marked by gc_sweep, and as it is not lisp-accessible as
- a local variable -- so we regard it as not really being of type
- Lisp_Object */
- /* the markers that refer to this buffer.
- This is actually a single marker ---
- successive elements in its marker `chain'
- are the other markers referring to this
- buffer */
- Lisp_Object markers;
+ /* If the long line scan cache is enabled (i.e. the buffer-local
+ variable cache-long-line-scans is non-nil), newline_cache
+ points to the newline cache, and width_run_cache points to the
+ width run cache.
+ The newline cache records which stretches of the buffer are
+ known *not* to contain newlines, so that they can be skipped
+ quickly when we search for newlines.
+
+ The width run cache records which stretches of the buffer are
+ known to contain characters whose widths are all the same. If
+ the width run cache maps a character to a value > 0, that value is
+ the character's width; if it maps a character to zero, we don't
+ know what its width is. This allows compute_motion to process
+ such regions very quickly, using algebra instead of inspecting
+ each character. See also width_table, below. */
+ struct region_cache *newline_cache;
+ struct region_cache *width_run_cache;
/* Everything from here down must be a Lisp_Object */
- /* the name of this buffer */
+ /* The name of this buffer. */
Lisp_Object name;
- /* Nuked: buffer number, assigned when buffer made Lisp_Object number;*/
- /* the name of the file associated with this buffer */
+ /* The name of the file visited in this buffer, or nil. */
Lisp_Object filename;
- /* Dir for expanding relative pathnames */
+ /* Dir for expanding relative file names. */
Lisp_Object directory;
- /* true iff this buffer has been been backed
- up (if you write to its associated file
- and it hasn't been backed up, then a
- backup will be made) */
+ /* True iff this buffer has been backed up (if you write to the
+ visited file and it hasn't been backed up, then a backup will
+ be made). */
/* This isn't really used by the C code, so could be deleted. */
Lisp_Object backed_up;
- /* Length of file when last read or saved. */
+ /* Length of file when last read or saved.
+ This is not in the struct buffer_text
+ because it's not used in indirect buffers at all. */
Lisp_Object save_length;
- /* file name used for auto-saving this buffer */
+ /* File name used for auto-saving this buffer.
+ This is not in the struct buffer_text
+ because it's not used in indirect buffers at all. */
Lisp_Object auto_save_file_name;
- /* Non-nil if buffer read-only */
+
+ /* Non-nil if buffer read-only. */
Lisp_Object read_only;
- /* "The mark"; no longer allowed to be nil */
+ /* "The mark". This is a marker which may
+ point into this buffer or may point nowhere. */
Lisp_Object mark;
/* Alist of elements (SYMBOL . VALUE-IN-THIS-BUFFER)
for all per-buffer variables of this buffer. */
Lisp_Object local_var_alist;
-
- /* Symbol naming major mode (eg lisp-mode) */
+ /* Symbol naming major mode (eg, lisp-mode). */
Lisp_Object major_mode;
- /* Pretty name of major mode (eg "Lisp") */
+ /* Pretty name of major mode (eg, "Lisp"). */
Lisp_Object mode_name;
- /* Format string for mode line */
+ /* Mode line element that controls format of mode line. */
Lisp_Object mode_line_format;
- /* Keys that are bound local to this buffer */
+ /* Keys that are bound local to this buffer. */
Lisp_Object keymap;
- /* This buffer's local abbrev table */
+ /* This buffer's local abbrev table. */
Lisp_Object abbrev_table;
- /* This buffer's syntax table. */
+ /* This buffer's syntax table. */
Lisp_Object syntax_table;
+ /* This buffer's category table. */
+ Lisp_Object category_table;
/* Values of several buffer-local variables */
/* tab-width is buffer-local so that redisplay can find it
Lisp_Object tab_width;
Lisp_Object fill_column;
Lisp_Object left_margin;
- /* Function to call when insert space past fill column */
+ /* Function to call when insert space past fill column. */
Lisp_Object auto_fill_function;
-
- /* String of length 256 mapping each char to its lower-case version. */
+ /* nil: text, t: binary.
+ This value is meaningful only on certain operating systems. */
+ /* Actually, we don't need this flag any more because end-of-line
+ is handled correctly according to the buffer-file-coding-system
+ of the buffer. Just keeping it for backward compatibility. */
+ Lisp_Object buffer_file_type;
+
+ /* Case table for case-conversion in this buffer.
+ This char-table maps each char into its lower-case version. */
Lisp_Object downcase_table;
- /* String of length 256 mapping each char to its upper-case version. */
+ /* Char-table mapping each char to its upper-case version. */
Lisp_Object upcase_table;
+ /* Char-table for conversion for case-folding search. */
+ Lisp_Object case_canon_table;
+ /* Char-table of equivalences for case-folding search. */
+ Lisp_Object case_eqv_table;
- /* Non-nil means do not display continuation lines */
+ /* Non-nil means do not display continuation lines. */
Lisp_Object truncate_lines;
- /* Non-nil means display ctl chars with uparrow */
+ /* Non-nil means display ctl chars with uparrow. */
Lisp_Object ctl_arrow;
+ /* Non-nil means display text from right to left. */
+ Lisp_Object direction_reversed;
/* Non-nil means do selective display;
- See doc string in syms_of_buffer (buffer.c) for details. */
+ see doc string in syms_of_buffer (buffer.c) for details. */
Lisp_Object selective_display;
#ifndef old
/* Non-nil means show ... at end of line followed by invisible lines. */
Lisp_Object selective_display_ellipses;
#endif
- /* Alist of (FUNCTION . STRING) for each minor mode enabled in buffer. */
+ /* Alist of (FUNCTION . STRING) for each minor mode enabled in buffer. */
Lisp_Object minor_modes;
- /* t if "self-insertion" should overwrite */
+ /* t if "self-insertion" should overwrite; `binary' if it should also
+ overwrite newlines and tabs - for editing executables and the like. */
Lisp_Object overwrite_mode;
- /* non-nil means abbrev mode is on. Expand abbrevs automatically. */
+ /* non-nil means abbrev mode is on. Expand abbrevs automatically. */
Lisp_Object abbrev_mode;
- /* Display table to use for text in this buffer. */
+ /* Display table to use for text in this buffer. */
Lisp_Object display_table;
- /* Translate table for case-folding search. */
- Lisp_Object case_canon_table;
- /* Inverse translate (equivalence class) table for case-folding search. */
- Lisp_Object case_eqv_table;
- /* Changes in the buffer are recorded here for undo.
- t means don't record anything. */
- Lisp_Object undo_list;
/* t means the mark and region are currently active. */
Lisp_Object mark_active;
- /* List of fields in this buffer. */
- Lisp_Object fieldlist;
-};
+ /* Changes in the buffer are recorded here for undo.
+ t means don't record anything.
+ This information belongs to the base buffer of an indirect buffer,
+ But we can't store it in the struct buffer_text
+ because local variables have to be right in the struct buffer.
+ So we copy it around in set_buffer_internal. */
+ Lisp_Object undo_list;
+
+ /* List of overlays that end at or before the current center,
+ in order of end-position. */
+ Lisp_Object overlays_before;
+
+ /* List of overlays that end after the current center,
+ in order of start-position. */
+ Lisp_Object overlays_after;
+
+ /* Position where the overlay lists are centered. */
+ Lisp_Object overlay_center;
+
+ /* Non-nil means the buffer contents are regarded as multi-byte
+ form of characters, not a binary code. */
+ Lisp_Object enable_multibyte_characters;
+
+ /* Coding system to be used for encoding the buffer contents on
+ saving. */
+ Lisp_Object buffer_file_coding_system;
+
+ /* List of symbols naming the file format used for visited file. */
+ Lisp_Object file_format;
+
+ /* True if the newline position cache and width run cache are
+ enabled. See search.c and indent.c. */
+ Lisp_Object cache_long_line_scans;
+
+ /* If the width run cache is enabled, this table contains the
+ character widths width_run_cache (see above) assumes. When we
+ do a thorough redisplay, we compare this against the buffer's
+ current display table to see whether the display table has
+ affected the widths of any characters. If it has, we
+ invalidate the width run cache, and re-initialize width_table. */
+ Lisp_Object width_table;
+
+ /* In an indirect buffer, or a buffer that is the base of an
+ indirect buffer, this holds a marker that records
+ PT for this buffer when the buffer is not current. */
+ Lisp_Object pt_marker;
+
+ /* In an indirect buffer, or a buffer that is the base of an
+ indirect buffer, this holds a marker that records
+ BEGV for this buffer when the buffer is not current. */
+ Lisp_Object begv_marker;
+
+ /* In an indirect buffer, or a buffer that is the base of an
+ indirect buffer, this holds a marker that records
+ ZV for this buffer when the buffer is not current. */
+ Lisp_Object zv_marker;
+
+ /* This holds the point value before the last scroll operation.
+ Explicitly setting point sets this to nil. */
+ Lisp_Object point_before_scroll;
+
+ /* Truename of the visited file, or nil. */
+ Lisp_Object file_truename;
+
+ /* Invisibility spec of this buffer.
+ t => any non-nil `invisible' property means invisible.
+ A list => `invisible' property means invisible
+ if it is memq in that list. */
+ Lisp_Object invisibility_spec;
+
+ /* This is the last window that was selected with this buffer in it,
+ or nil if that window no longer displays this buffer. */
+ Lisp_Object last_selected_window;
+
+ /* Incremented each time the buffer is displayed in a window. */
+ Lisp_Object display_count;
+
+ /* These are so we don't have to recompile everything
+ the next few times we add a new slot. */
+ Lisp_Object extra2, extra3;
+ };
+\f
+/* This points to the current buffer. */
extern struct buffer *current_buffer;
/* This structure holds the default values of the buffer-local variables
- defined with DefBufferLispVar, that have special slots in each buffer.
+ that have special slots in each buffer.
The default value occupies the same slot in this structure
as an individual buffer's value occupies in that buffer.
Setting the default value also goes through the alist of buffers
is turned on in the buffer's local_var_flags slot.
If a slot in this structure is zero, then even though there may
- be a DefBufferLispVar for the slot, there is no default valuefeor it;
+ be a Lisp-level local variable for the slot, it has no default value,
and the corresponding slot in buffer_defaults is not used. */
extern struct buffer buffer_local_flags;
buffer-local slots. If a slot contains Qnil, then the
corresponding buffer slot may contain a value of any type. If a
slot contains an integer, then prospective values' tags must be
- equal to that integer. When a tag does not match, the function
- buffer_slot_type_mismatch will signal an error. The value Qnil may
- always be safely stored in any slot. */
-extern struct buffer buffer_local_types;
-
-/* Point in the current buffer. */
-
-#define point (current_buffer->text.pt + 0)
-
-/* Return character at position n. No range checking */
-#define FETCH_CHAR(n) *(((n)>= GPT ? GAP_SIZE : 0) + (n) + BEG_ADDR - 1)
-
-/* BUFFER_CEILING_OF (resp. BUFFER_FLOOR_OF), when applied to n, return
- the max (resp. min) p such that
-
- &FETCH_CHAR (p) - &FETCH_CHAR (n) == p - n */
+ equal to that integer (except nil is always allowed).
+ When a tag does not match, the function
+ buffer_slot_type_mismatch will signal an error.
-#define BUFFER_CEILING_OF(n) (((n) < GPT && GPT < ZV ? GPT : ZV) - 1)
-#define BUFFER_FLOOR_OF(n) (BEGV <= GPT && GPT <= (n) ? GPT : BEGV)
+ If a slot here contains -1, the corresponding variable is read-only. */
-extern void reset_buffer ();
-
-/* Functions to call before and after each text change. */
+extern struct buffer buffer_local_types;
+\f
+extern void reset_buffer P_ ((struct buffer *));
+extern void evaporate_overlays P_ ((int));
+extern int overlays_at P_ ((int, int, Lisp_Object **, int *, int *, int *));
+extern int sort_overlays P_ ((Lisp_Object *, int, struct window *));
+extern void recenter_overlay_lists P_ ((struct buffer *, int));
+extern int overlay_strings P_ ((int, struct window *, unsigned char **));
+extern void validate_region P_ ((Lisp_Object *, Lisp_Object *));
+extern void set_buffer_internal P_ ((struct buffer *));
+extern void set_buffer_internal_1 P_ ((struct buffer *));
+extern void set_buffer_temp P_ ((struct buffer *));
+extern void record_buffer P_ ((Lisp_Object));
+extern void buffer_slot_type_mismatch P_ ((int));
+extern void fix_overlays_before P_ ((struct buffer *, int, int));
+
+
+EXFUN (Fbuffer_name, 1);
+EXFUN (Fget_file_buffer, 1);
+EXFUN (Fnext_overlay_change, 1);
+EXFUN (Fdelete_overlay, 1);
+
+/* Functions to call before and after each text change. */
extern Lisp_Object Vbefore_change_function;
extern Lisp_Object Vafter_change_function;
+extern Lisp_Object Vbefore_change_functions;
+extern Lisp_Object Vafter_change_functions;
extern Lisp_Object Vfirst_change_hook;
+extern Lisp_Object Qbefore_change_functions;
+extern Lisp_Object Qafter_change_functions;
extern Lisp_Object Qfirst_change_hook;
extern Lisp_Object Vdeactivate_mark;
extern Lisp_Object Vtransient_mark_mode;
+\f
+/* Overlays */
-/* Fields.
+/* 1 if the OV is an overlay object. */
+#define OVERLAY_VALID(OV) (OVERLAYP (OV))
-A field is like a marker but it defines a region rather than a
-point. Like a marker, a field is asocated with a buffer.
-The field mechanism uses the marker mechanism in the
-sense that its start and end points are maintained as markers
-updated in the usual way as the buffer changes.
+/* Return the marker that stands for where OV starts in the buffer. */
+#define OVERLAY_START(OV) (XOVERLAY (OV)->start)
-A field can be protected or unprotected. If it is protected,
-no modifications can be made that affect the field in its buffer,
-when protected field checking is enabled.
+/* Return the marker that stands for where OV ends in the buffer. */
+#define OVERLAY_END(OV) (XOVERLAY (OV)->end)
-Each field also contains an alist, in which you can store
-whatever you like. */
+/* Return the actual buffer position for the marker P.
+ We assume you know which buffer it's pointing into. */
-/* Slots in a field: */
+#define OVERLAY_POSITION(P) \
+ (GC_MARKERP (P) ? marker_position (P) : (abort (), 0))
-#define FIELD_BUFFER(f) (XVECTOR(f)->contents[1])
-#define FIELD_START_MARKER(f) (XVECTOR(f)->contents[2])
-#define FIELD_END_MARKER(f) (XVECTOR(f)->contents[3])
-#define FIELD_PROTECTED_FLAG(f) (XVECTOR(f)->contents[4])
-#define FIELD_ALIST(f) (XVECTOR(f)->contents[5])
+/* Allocation of buffer text. */
-/* Allocation of buffer data. */
#ifdef REL_ALLOC
#define BUFFER_ALLOC(data,size) ((unsigned char *) r_alloc (&data, (size)))
#define BUFFER_REALLOC(data,size) ((unsigned char *) r_re_alloc (&data, (size)))
#define BUFFER_FREE(data) (free ((data)))
#define R_ALLOC_DECLARE(var,data)
#endif
-
-/* VAX C is non-ANSI wrt extern declarations and requires the struct
- re_pattern_buffer to completely defined for searchbuf's declaration. */
-#ifdef VMS
-#include "regex.h"
-#endif /* VMS */
-
-/* A search buffer, with a fastmap allocated and ready to go. */
-extern struct re_pattern_buffer searchbuf;
-
-extern Lisp_Object Fbuffer_name ();
-extern Lisp_Object Fget_file_buffer ();
HCoop / bpt / emacs.git / blobdiff