buffer.h 22.6 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Header file for the buffer manipulation primitives.
Karl Heuer's avatar
Karl Heuer committed
2
   Copyright (C) 1985, 1986, 1993, 1994, 1995 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
3 4 5 6 7

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Jim Blandy's avatar
Jim Blandy committed
8
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
9 10 11 12 13 14 15 16 17
any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
18 19
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
20 21


22 23 24 25 26 27 28
#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)))

29 30 31
extern void set_point P_ ((int, struct buffer *));
extern INLINE void temp_set_point P_ ((int, struct buffer *));

32 33
#else  /* don't support text properties */

34 35
#define SET_PT(position) (current_buffer->pt = (position))
#define TEMP_SET_PT(position) (current_buffer->pt = (position))
36

37 38
#define BUF_SET_PT(buffer, position) (buffer->pt = (position))
#define BUF_TEMP_SET_PT(buffer, position) (buffer->pt = (position))
39
#endif /* don't support text properties */
Jim Blandy's avatar
Jim Blandy committed
40 41 42 43 44

/* Character position of beginning of buffer.  */ 
#define BEG (1)

/* Character position of beginning of accessible range of buffer.  */ 
45
#define BEGV (current_buffer->begv)
Jim Blandy's avatar
Jim Blandy committed
46 47 48

/* Character position of point in buffer.  The "+ 0" makes this
   not an l-value, so you can't assign to it.  Use SET_PT instead.  */ 
49
#define PT (current_buffer->pt + 0)
Jim Blandy's avatar
Jim Blandy committed
50 51

/* Character position of gap in buffer.  */ 
52
#define GPT (current_buffer->text->gpt)
Jim Blandy's avatar
Jim Blandy committed
53 54

/* Character position of end of accessible range of buffer.  */ 
55
#define ZV (current_buffer->zv)
Jim Blandy's avatar
Jim Blandy committed
56 57

/* Character position of end of buffer.  */ 
58
#define Z (current_buffer->text->z)
Jim Blandy's avatar
Jim Blandy committed
59

60 61 62
/* Is the current buffer narrowed? */
#define NARROWED	((BEGV != BEG) || (ZV != Z))

Jim Blandy's avatar
Jim Blandy committed
63
/* Modification count.  */
64 65
#define MODIFF (current_buffer->text->modiff)

66
/* Overlay modification count.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
67
#define OVERLAY_MODIFF (current_buffer->text->overlay_modiff)
68

69 70
/* Modification count as of last visit or save.  */
#define SAVE_MODIFF (current_buffer->text->save_modiff)
Jim Blandy's avatar
Jim Blandy committed
71 72

/* Address of beginning of buffer.  */ 
73
#define BEG_ADDR (current_buffer->text->beg)
Jim Blandy's avatar
Jim Blandy committed
74 75

/* Address of beginning of accessible range of buffer.  */ 
76
#define BEGV_ADDR (POS_ADDR (current_buffer->begv))
Jim Blandy's avatar
Jim Blandy committed
77 78

/* Address of point in buffer.  */ 
79
#define PT_ADDR (POS_ADDR (current_buffer->pt))
Jim Blandy's avatar
Jim Blandy committed
80 81

/* Address of beginning of gap in buffer.  */ 
82
#define GPT_ADDR (current_buffer->text->beg + current_buffer->text->gpt - 1)
Jim Blandy's avatar
Jim Blandy committed
83 84

/* Address of end of gap in buffer.  */
85
#define GAP_END_ADDR (current_buffer->text->beg + current_buffer->text->gpt + current_buffer->text->gap_size - 1)
Jim Blandy's avatar
Jim Blandy committed
86 87

/* Address of end of accessible range of buffer.  */ 
88 89 90 91
#define ZV_ADDR (POS_ADDR (current_buffer->zv))

/* Address of end of buffer.  */ 
#define Z_ADDR (current_buffer->text->beg + current_buffer->text->gap_size + current_buffer->text->z - 1)
Jim Blandy's avatar
Jim Blandy committed
92 93

/* Size of gap.  */
94
#define GAP_SIZE (current_buffer->text->gap_size)
Jim Blandy's avatar
Jim Blandy committed
95 96 97 98 99 100 101 102

/* Now similar macros for a specified buffer.
   Note that many of these evaluate the buffer argument more than once.  */

/* Character position of beginning of buffer.  */ 
#define BUF_BEG(buf) (1)

/* Character position of beginning of accessible range of buffer.  */ 
103
#define BUF_BEGV(buf) ((buf)->begv)
Jim Blandy's avatar
Jim Blandy committed
104 105

/* Character position of point in buffer.  */ 
106
#define BUF_PT(buf) ((buf)->pt)
Jim Blandy's avatar
Jim Blandy committed
107 108

/* Character position of gap in buffer.  */ 
109
#define BUF_GPT(buf) ((buf)->text->gpt)
Jim Blandy's avatar
Jim Blandy committed
110 111

/* Character position of end of accessible range of buffer.  */ 
112
#define BUF_ZV(buf) ((buf)->zv)
Jim Blandy's avatar
Jim Blandy committed
113 114

/* Character position of end of buffer.  */ 
115
#define BUF_Z(buf) ((buf)->text->z)
Jim Blandy's avatar
Jim Blandy committed
116

117
/* Is this buffer narrowed? */
118 119
#define BUF_NARROWED(buf) ((BUF_BEGV (buf) != BUF_BEG (buf)) \
			   || (BUF_ZV (buf) != BUF_Z (buf)))
120

Jim Blandy's avatar
Jim Blandy committed
121
/* Modification count.  */
122 123 124 125 126
#define BUF_MODIFF(buf) ((buf)->text->modiff)

/* Modification count as of last visit or save.  */
#define BUF_SAVE_MODIFF(buf) ((buf)->text->save_modiff)

127 128 129
/* Overlay modification count.  */
#define BUF_OVERLAY_MODIFF(buf) ((buf)->text->overlay_modiff)

130 131 132 133 134
/* Interval tree of buffer.  */
#define BUF_INTERVALS(buf) ((buf)->text->intervals)

/* Marker chain of buffer.  */
#define BUF_MARKERS(buf) ((buf)->text->markers)
Jim Blandy's avatar
Jim Blandy committed
135 136

/* Address of beginning of buffer.  */
137
#define BUF_BEG_ADDR(buf) ((buf)->text->beg)
Jim Blandy's avatar
Jim Blandy committed
138

139 140 141 142 143 144
/* Address of beginning of gap of buffer.  */
#define BUF_GPT_ADDR(buf) ((buf)->text->beg + (buf)->text->gpt - 1)

/* Address of end of buffer.  */
#define BUF_Z_ADDR(buf) ((buf)->text->beg + (buf)->text->gap_size + (buf)->text->z - 1)

Jim Blandy's avatar
Jim Blandy committed
145 146
/* Macro for setting the value of BUF_ZV (BUF) to VALUE,
   by varying the end of the accessible region.  */
147 148
#define SET_BUF_ZV(buf, value) ((buf)->zv = (value))
#define SET_BUF_PT(buf, value) ((buf)->pt = (value))
Jim Blandy's avatar
Jim Blandy committed
149 150

/* Size of gap.  */
151
#define BUF_GAP_SIZE(buf) ((buf)->text->gap_size)
Jim Blandy's avatar
Jim Blandy committed
152 153 154 155

/* Return the address of character at position POS in buffer BUF. 
   Note that both arguments can be computed more than once.  */
#define BUF_CHAR_ADDRESS(buf, pos) \
156 157
((buf)->text->beg + (pos) - 1		\
 + ((pos) >= (buf)->text->gpt ? (buf)->text->gap_size : 0))
Jim Blandy's avatar
Jim Blandy committed
158 159 160

/* Convert the address of a char in the buffer into a character position.  */
#define PTR_CHAR_POS(ptr) \
161 162
((ptr) - (current_buffer)->text->beg					\
 - (ptr - (current_buffer)->text->beg < (unsigned) GPT ? 0 : GAP_SIZE)	\
Jim Blandy's avatar
Jim Blandy committed
163
 + 1)
164 165 166

/* Convert the address of a char in the buffer into a character position.  */
#define BUF_PTR_CHAR_POS(buf, ptr)			\
167 168
((ptr) - (buf)->text->beg				\
 - (ptr - (buf)->text->beg < (unsigned) BUF_GPT ((buf))	\
169 170
    ? 0 : BUF_GAP_SIZE ((buf)))				\
 + 1)
Jim Blandy's avatar
Jim Blandy committed
171 172 173

struct buffer_text
  {
174 175 176 177
    unsigned char *beg;		/* Actual address of buffer contents.  */
    int gpt;			/* Index of gap in buffer.  */
    int z;			/* Index of end of buffer.  */
    int gap_size;		/* Size of buffer's gap.  */
Jim Blandy's avatar
Jim Blandy committed
178 179 180 181
    int modiff;			/* This counts buffer-modification events
				   for this buffer.  It is incremented for
				   each such event, and never otherwise
				   changed.  */
182 183 184
    int save_modiff;		/* Previous value of modiff, as of last
				   time buffer visited or saved a file.  */

185 186
    int overlay_modiff;		/* Counts modifications to overlays.  */

187 188 189 190 191 192 193 194
    /* 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;
Jim Blandy's avatar
Jim Blandy committed
195 196 197 198 199 200 201
  };

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.

202 203 204
       Check out mark_buffer (alloc.c) to see why.  */

    EMACS_INT size;
Jim Blandy's avatar
Jim Blandy committed
205 206 207

    /* Next buffer, in chain of all buffers including killed buffers.
       This chain is used only for garbage collection, in order to
208 209 210
       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.  */
Jim Blandy's avatar
Jim Blandy committed
211
    struct buffer *next;
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232

    /* 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;

    /* Position of point in buffer.  */
    int pt;
    /* Index of beginning of accessible range.  */
    int begv;
    /* Index of end of accessible range.  */
    int zv;

    /* In an indirect buffer, this points to the base buffer.
       In an ordinary buffer, it is 0.  */
    struct buffer *base_buffer;

Jim Blandy's avatar
Jim Blandy committed
233 234 235 236 237 238 239 240
    /* Flags saying which DEFVAR_PER_BUFFER variables
       are local to this buffer.  */
    int local_var_flags;
    /* 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;
241
    /* the value of text->modiff at the last auto-save.  */
Jim Blandy's avatar
Jim Blandy committed
242
    int auto_save_modified;
243 244 245
    /* 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;
Jim Blandy's avatar
Jim Blandy committed
246
    /* Position in buffer at which display started
247
       the last time this buffer was displayed.  */
Jim Blandy's avatar
Jim Blandy committed
248 249
    int last_window_start;

250 251 252
    /* Set nonzero whenever the narrowing is changed in this buffer.  */
    int clip_changed;

253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
    /* 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;
Jim Blandy's avatar
Jim Blandy committed
271 272 273 274

    /* Everything from here down must be a Lisp_Object */


275
    /* The name of this buffer.  */
Jim Blandy's avatar
Jim Blandy committed
276
    Lisp_Object name;
277
    /* The name of the file visited in this buffer, or nil.  */
Jim Blandy's avatar
Jim Blandy committed
278
    Lisp_Object filename;
279
    /* Dir for expanding relative file names.  */
Jim Blandy's avatar
Jim Blandy committed
280
    Lisp_Object directory;
281 282 283
    /* 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).  */
Jim Blandy's avatar
Jim Blandy committed
284 285
    /* This isn't really used by the C code, so could be deleted.  */
    Lisp_Object backed_up;
286 287 288
    /* 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.  */
Jim Blandy's avatar
Jim Blandy committed
289
    Lisp_Object save_length;
290 291 292
    /* 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.  */
Jim Blandy's avatar
Jim Blandy committed
293
    Lisp_Object auto_save_file_name;
294 295

    /* Non-nil if buffer read-only.  */
Jim Blandy's avatar
Jim Blandy committed
296
    Lisp_Object read_only;
297 298
    /* "The mark".  This is a marker which may
       point into this buffer or may point nowhere.  */
Jim Blandy's avatar
Jim Blandy committed
299 300 301 302 303 304
    Lisp_Object mark;

    /* Alist of elements (SYMBOL . VALUE-IN-THIS-BUFFER)
       for all per-buffer variables of this buffer.  */
    Lisp_Object local_var_alist;

305
    /* Symbol naming major mode (eg, lisp-mode).  */
Jim Blandy's avatar
Jim Blandy committed
306
    Lisp_Object major_mode;
307
    /* Pretty name of major mode (eg, "Lisp"). */
Jim Blandy's avatar
Jim Blandy committed
308
    Lisp_Object mode_name;
309
    /* Mode line element that controls format of mode line.  */
Jim Blandy's avatar
Jim Blandy committed
310 311
    Lisp_Object mode_line_format;

312
    /* Keys that are bound local to this buffer.  */
Jim Blandy's avatar
Jim Blandy committed
313
    Lisp_Object keymap;
314
    /* This buffer's local abbrev table.  */
Jim Blandy's avatar
Jim Blandy committed
315
    Lisp_Object abbrev_table;
316
    /* This buffer's syntax table.  */
Jim Blandy's avatar
Jim Blandy committed
317
    Lisp_Object syntax_table;
318 319
    /* This buffer's category table.  */
    Lisp_Object category_table;
Jim Blandy's avatar
Jim Blandy committed
320 321 322 323 324 325 326 327

    /* Values of several buffer-local variables */
    /* tab-width is buffer-local so that redisplay can find it
       in buffers that are not current */
    Lisp_Object case_fold_search;
    Lisp_Object tab_width;
    Lisp_Object fill_column;
    Lisp_Object left_margin;
328
    /* Function to call when insert space past fill column.  */
Jim Blandy's avatar
Jim Blandy committed
329
    Lisp_Object auto_fill_function;
330 331
    /* nil: text, t: binary.
       This value is meaningful only on certain operating systems.  */
332 333 334
    /* 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.  */
335
    Lisp_Object buffer_file_type;
Jim Blandy's avatar
Jim Blandy committed
336

Richard M. Stallman's avatar
Richard M. Stallman committed
337 338
    /* Case table for case-conversion in this buffer.
       This char-table maps each char into its lower-case version.  */
Jim Blandy's avatar
Jim Blandy committed
339
    Lisp_Object downcase_table;
Richard M. Stallman's avatar
Richard M. Stallman committed
340
    /* Char-table mapping each char to its upper-case version.  */
Jim Blandy's avatar
Jim Blandy committed
341
    Lisp_Object upcase_table;
Richard M. Stallman's avatar
Richard M. Stallman committed
342
    /* Char-table for conversion for case-folding search.  */
343
    Lisp_Object case_canon_table;
Richard M. Stallman's avatar
Richard M. Stallman committed
344
    /* Char-table of equivalences for case-folding search.  */
345
    Lisp_Object case_eqv_table;
Jim Blandy's avatar
Jim Blandy committed
346

347
    /* Non-nil means do not display continuation lines.  */
Jim Blandy's avatar
Jim Blandy committed
348
    Lisp_Object truncate_lines;
349
    /* Non-nil means display ctl chars with uparrow.  */
Jim Blandy's avatar
Jim Blandy committed
350
    Lisp_Object ctl_arrow;
351 352
    /* Non-nil means display text from right to left.  */
    Lisp_Object direction_reversed;
Jim Blandy's avatar
Jim Blandy committed
353
    /* Non-nil means do selective display;
354
       see doc string in syms_of_buffer (buffer.c) for details.  */
Jim Blandy's avatar
Jim Blandy committed
355 356 357 358 359
    Lisp_Object selective_display;
#ifndef old
    /* Non-nil means show ... at end of line followed by invisible lines.  */
    Lisp_Object selective_display_ellipses;
#endif
360
    /* Alist of (FUNCTION . STRING) for each minor mode enabled in buffer.  */
Jim Blandy's avatar
Jim Blandy committed
361
    Lisp_Object minor_modes;
362 363
    /* t if "self-insertion" should overwrite; `binary' if it should also
       overwrite newlines and tabs - for editing executables and the like.  */
Jim Blandy's avatar
Jim Blandy committed
364
    Lisp_Object overwrite_mode;
365
    /* non-nil means abbrev mode is on.  Expand abbrevs automatically.  */
Jim Blandy's avatar
Jim Blandy committed
366
    Lisp_Object abbrev_mode;
367
    /* Display table to use for text in this buffer.  */
Jim Blandy's avatar
Jim Blandy committed
368
    Lisp_Object display_table;
369 370
    /* t means the mark and region are currently active.  */
    Lisp_Object mark_active;
Jim Blandy's avatar
Jim Blandy committed
371

372 373 374 375 376 377 378 379
    /* 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;

380 381 382 383 384 385 386 387 388 389
    /* 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;
390

391 392 393 394
    /* Non-nil means the buffer contents are regarded as multi-byte
       form of characters, not a binary code.  */
    Lisp_Object enable_multibyte_characters;

395 396 397 398
    /* Coding system to be used for encoding the buffer contents on
       saving.  */
    Lisp_Object buffer_file_coding_system;

Karl Heuer's avatar
Karl Heuer committed
399
    /* List of symbols naming the file format used for visited file. */
400 401
    Lisp_Object file_format;

402 403 404 405 406 407 408 409 410
    /* 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
411
       invalidate the width run cache, and re-initialize width_table.  */
412
    Lisp_Object width_table;
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427

    /* 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;
428 429 430 431

    /* This holds the point value before the last scroll operation.
       Explicitly setting point sets this to nil.  */
    Lisp_Object point_before_scroll;
432 433 434

    /* Truename of the visited file, or nil.  */
    Lisp_Object file_truename;
435 436 437 438 439 440

    /* 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;
441

442 443 444 445
    /* 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;

446 447 448
    /* Incremented each time the buffer is displayed in a window.  */
    Lisp_Object display_count;
 
449 450
    /* These are so we don't have to recompile everything
       the next few times we add a new slot.  */
451
    Lisp_Object extra2, extra3;
452
  };
453 454

/* This points to the current buffer.  */
Jim Blandy's avatar
Jim Blandy committed
455 456 457 458

extern struct buffer *current_buffer;

/* This structure holds the default values of the buffer-local variables
459
   that have special slots in each buffer.
Jim Blandy's avatar
Jim Blandy committed
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476
   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
   and stores into each buffer that does not say it has a local value.  */

extern struct buffer buffer_defaults;

/* This structure marks which slots in a buffer have corresponding
   default values in buffer_defaults.
   Each such slot has a nonzero value in this structure.
   The value has only one nonzero bit.

   When a buffer has its own local value for a slot,
   the bit for that slot (found in the same slot in this structure)
   is turned on in the buffer's local_var_flags slot.

   If a slot in this structure is zero, then even though there may
477
   be a Lisp-level local variable for the slot, it has no default value,
Jim Blandy's avatar
Jim Blandy committed
478 479 480 481 482 483 484 485 486 487
   and the corresponding slot in buffer_defaults is not used.  */

extern struct buffer buffer_local_flags;

/* For each buffer slot, this points to the Lisp symbol name
   for that slot in the current buffer.  It is 0 for slots
   that don't have such names.  */

extern struct buffer buffer_local_symbols;

Jim Blandy's avatar
Jim Blandy committed
488 489 490 491 492 493 494
/* This structure holds the required types for the values in the
   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.  */
495
extern struct buffer buffer_local_types;
496

497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
/* Return the address of position N.  No range checking.  */
#define POS_ADDR(n) (((n)>= GPT ? GAP_SIZE : 0) + (n) + BEG_ADDR - 1)

/* Return the byte at position N.  No range checking.  */
#define FETCH_BYTE(n) *(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.  */

#define FETCH_MULTIBYTE_CHAR(pos)				 	\
  (_fetch_multibyte_char_p = (((pos) >= GPT ? GAP_SIZE : 0)	 	\
			       + (pos) + BEG_ADDR - 1),		 	\
   _fetch_multibyte_char_len = ((pos) >= GPT ? ZV : GPT) - (pos),	\
   STRING_CHAR (_fetch_multibyte_char_p, _fetch_multibyte_char_len))

/* Return character at position POS.  No range checking.  */
#define FETCH_CHAR(pos)				      	\
  (!NILP (current_buffer->enable_multibyte_characters)	\
   ? FETCH_MULTIBYTE_CHAR ((pos))		      	\
   : FETCH_BYTE ((pos)))
Jim Blandy's avatar
Jim Blandy committed
522 523 524 525

/* BUFFER_CEILING_OF (resp. BUFFER_FLOOR_OF), when applied to n, return
   the max (resp. min) p such that

526
   POS_ADDR (p) - POS_ADDR (n) == p - n       */
Jim Blandy's avatar
Jim Blandy committed
527 528 529 530

#define BUFFER_CEILING_OF(n) (((n) < GPT && GPT < ZV ? GPT : ZV) - 1)
#define BUFFER_FLOOR_OF(n) (BEGV <= GPT && GPT <= (n) ? GPT : BEGV)

531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549
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);
550

551
/* Functions to call before and after each text change.  */
Jim Blandy's avatar
Jim Blandy committed
552 553
extern Lisp_Object Vbefore_change_function;
extern Lisp_Object Vafter_change_function;
554 555
extern Lisp_Object Vbefore_change_functions;
extern Lisp_Object Vafter_change_functions;
Jim Blandy's avatar
Jim Blandy committed
556
extern Lisp_Object Vfirst_change_hook;
557 558
extern Lisp_Object Qbefore_change_functions;
extern Lisp_Object Qafter_change_functions;
Jim Blandy's avatar
Jim Blandy committed
559
extern Lisp_Object Qfirst_change_hook;
Jim Blandy's avatar
Jim Blandy committed
560

561 562
extern Lisp_Object Vdeactivate_mark;
extern Lisp_Object Vtransient_mark_mode;
563 564 565

/* Overlays */

566
/* 1 if the OV is an overlay object.  */
Jim Blandy's avatar
Jim Blandy committed
567
#define OVERLAY_VALID(OV) (OVERLAYP (OV))
Jim Blandy's avatar
Jim Blandy committed
568

569
/* Return the marker that stands for where OV starts in the buffer.  */
570
#define OVERLAY_START(OV) (XOVERLAY (OV)->start)
Jim Blandy's avatar
Jim Blandy committed
571

572
/* Return the marker that stands for where OV ends in the buffer.  */
573
#define OVERLAY_END(OV) (XOVERLAY (OV)->end)
Jim Blandy's avatar
Jim Blandy committed
574

575 576
/* Return the actual buffer position for the marker P.
   We assume you know which buffer it's pointing into.  */
Jim Blandy's avatar
Jim Blandy committed
577

578 579
#define OVERLAY_POSITION(P) \
 (GC_MARKERP (P) ? marker_position (P) : (abort (), 0))
Jim Blandy's avatar
Jim Blandy committed
580

581 582
/* Allocation of buffer text.  */

Jim Blandy's avatar
Jim Blandy committed
583 584 585 586 587 588 589 590 591 592 593
#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) (r_alloc_free (&data))
#define R_ALLOC_DECLARE(var,data) (r_alloc_declare (&var, (data)))
#else
#define BUFFER_ALLOC(data,size) (data = (unsigned char *) malloc ((size)))
#define BUFFER_REALLOC(data,size) ((unsigned char *) realloc ((data), (size)))
#define BUFFER_FREE(data) (free ((data)))
#define R_ALLOC_DECLARE(var,data)
#endif