buffer.h 39.9 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Header file for the buffer manipulation primitives.
Glenn Morris's avatar
Glenn Morris committed
2

3
Copyright (C) 1985-1986, 1993-1995, 1997-2011
Glenn Morris's avatar
Glenn Morris committed
4
                 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7

This file is part of GNU Emacs.

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

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
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
20 21


22
/* Accessing the parameters of the current buffer.  */
23

24 25
/* These macros come in pairs, one for the char position
   and one for the byte position.  */
Jim Blandy's avatar
Jim Blandy committed
26

27
/* Position of beginning of buffer.  */
Jim Blandy's avatar
Jim Blandy committed
28
#define BEG (1)
29
#define BEG_BYTE (BEG)
Jim Blandy's avatar
Jim Blandy committed
30

31
/* Position of beginning of accessible range of buffer.  */
32
#define BEGV (current_buffer->begv)
33
#define BEGV_BYTE (current_buffer->begv_byte)
Jim Blandy's avatar
Jim Blandy committed
34

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)
Jim Blandy's avatar
Jim Blandy committed
39

40
/* Position of gap in buffer.  */
41
#define GPT (current_buffer->text->gpt)
42
#define GPT_BYTE (current_buffer->text->gpt_byte)
Jim Blandy's avatar
Jim Blandy committed
43

44
/* Position of end of accessible range of buffer.  */
45
#define ZV (current_buffer->zv)
46
#define ZV_BYTE (current_buffer->zv_byte)
Jim Blandy's avatar
Jim Blandy committed
47

48
/* Position of end of buffer.  */
49
#define Z (current_buffer->text->z)
50
#define Z_BYTE (current_buffer->text->z_byte)
Jim Blandy's avatar
Jim Blandy committed
51

52
/* Macros for the addresses of places in the buffer.  */
Jim Blandy's avatar
Jim Blandy committed
53

54
/* Address of beginning of buffer.  */
55
#define BEG_ADDR (current_buffer->text->beg)
Jim Blandy's avatar
Jim Blandy committed
56

57
/* Address of beginning of accessible range of buffer.  */
58
#define BEGV_ADDR (BYTE_POS_ADDR (current_buffer->begv_byte))
Jim Blandy's avatar
Jim Blandy committed
59

60
/* Address of point in buffer.  */
61
#define PT_ADDR (BYTE_POS_ADDR (current_buffer->pt_byte))
Jim Blandy's avatar
Jim Blandy committed
62

63
/* Address of beginning of gap in buffer.  */
Stefan Monnier's avatar
Stefan Monnier committed
64
#define GPT_ADDR (current_buffer->text->beg + current_buffer->text->gpt_byte - BEG_BYTE)
Jim Blandy's avatar
Jim Blandy committed
65 66

/* Address of end of gap in buffer.  */
Stefan Monnier's avatar
Stefan Monnier committed
67
#define GAP_END_ADDR (current_buffer->text->beg + current_buffer->text->gpt_byte + current_buffer->text->gap_size - BEG_BYTE)
Jim Blandy's avatar
Jim Blandy committed
68

69
/* Address of end of accessible range of buffer.  */
70
#define ZV_ADDR (BYTE_POS_ADDR (current_buffer->zv_byte))
71

72
/* Address of end of buffer.  */
Stefan Monnier's avatar
Stefan Monnier committed
73
#define Z_ADDR (current_buffer->text->beg + current_buffer->text->gap_size + current_buffer->text->z_byte - BEG_BYTE)
Jim Blandy's avatar
Jim Blandy committed
74 75

/* Size of gap.  */
76
#define GAP_SIZE (current_buffer->text->gap_size)
Jim Blandy's avatar
Jim Blandy committed
77

78 79 80 81 82 83
/* Is the current buffer narrowed?  */
#define NARROWED	((BEGV != BEG) || (ZV != Z))

/* Modification count.  */
#define MODIFF (current_buffer->text->modiff)

84 85 86
/* Character modification count.  */
#define CHARS_MODIFF (current_buffer->text->chars_modiff)

87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
/* 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       */

#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)

/* Similar macros to operate on a specified buffer.
Jim Blandy's avatar
Jim Blandy committed
104 105
   Note that many of these evaluate the buffer argument more than once.  */

106
/* Position of beginning of buffer.  */
Stefan Monnier's avatar
Stefan Monnier committed
107 108
#define BUF_BEG(buf) (BEG)
#define BUF_BEG_BYTE(buf) (BEG_BYTE)
Jim Blandy's avatar
Jim Blandy committed
109

110 111
/* The BUF_BEGV[_BYTE], BUF_ZV[_BYTE], and BUF_PT[_BYTE] macros cannot
   be used for assignment; use SET_BUF_* macros below for that.  */
112

113
/* Position of beginning of accessible range of buffer.  */
114 115 116 117 118 119 120 121 122
#define BUF_BEGV(buf)					\
   (buf == current_buffer ? BEGV			\
    : NILP (BVAR (buf, begv_marker)) ? buf->begv	\
    : marker_position (BVAR (buf, begv_marker)))

#define BUF_BEGV_BYTE(buf)				\
   (buf == current_buffer ? BEGV_BYTE			\
    : NILP (BVAR (buf, begv_marker)) ? buf->begv_byte	\
    : marker_byte_position (BVAR (buf, begv_marker)))
Jim Blandy's avatar
Jim Blandy committed
123

124
/* Position of point in buffer.  */
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
#define BUF_PT(buf)					\
   (buf == current_buffer ? PT				\
    : NILP (BVAR (buf, pt_marker)) ? buf->pt		\
    : marker_position (BVAR (buf, pt_marker)))

#define BUF_PT_BYTE(buf)				\
   (buf == current_buffer ? PT_BYTE			\
    : NILP (BVAR (buf, pt_marker)) ? buf->pt_byte	\
    : marker_byte_position (BVAR (buf, pt_marker)))

/* Position of end of accessible range of buffer.  */
#define BUF_ZV(buf)					\
   (buf == current_buffer ? ZV				\
    : NILP (BVAR (buf, zv_marker)) ? buf->zv		\
    : marker_position (BVAR (buf, zv_marker)))

#define BUF_ZV_BYTE(buf)				\
   (buf == current_buffer ? ZV_BYTE			\
    : NILP (BVAR (buf, zv_marker)) ? buf->zv_byte	\
    : marker_byte_position (BVAR (buf, zv_marker)))
Jim Blandy's avatar
Jim Blandy committed
145

146
/* Position of gap in buffer.  */
147
#define BUF_GPT(buf) ((buf)->text->gpt)
148
#define BUF_GPT_BYTE(buf) ((buf)->text->gpt_byte)
Jim Blandy's avatar
Jim Blandy committed
149

150
/* Position of end of buffer.  */
151
#define BUF_Z(buf) ((buf)->text->z)
152 153 154 155 156 157
#define BUF_Z_BYTE(buf) ((buf)->text->z_byte)

/* Address of beginning of buffer.  */
#define BUF_BEG_ADDR(buf) ((buf)->text->beg)

/* Address of beginning of gap of buffer.  */
Stefan Monnier's avatar
Stefan Monnier committed
158
#define BUF_GPT_ADDR(buf) ((buf)->text->beg + (buf)->text->gpt_byte - BEG_BYTE)
159 160

/* Address of end of buffer.  */
Stefan Monnier's avatar
Stefan Monnier committed
161
#define BUF_Z_ADDR(buf) ((buf)->text->beg + (buf)->text->gap_size + (buf)->text->z_byte - BEG_BYTE)
162 163

/* Address of end of gap in buffer.  */
Stefan Monnier's avatar
Stefan Monnier committed
164
#define BUF_GAP_END_ADDR(buf) ((buf)->text->beg + (buf)->text->gpt_byte + (buf)->text->gap_size - BEG_BYTE)
Jim Blandy's avatar
Jim Blandy committed
165

166 167 168 169
/* Size of gap.  */
#define BUF_GAP_SIZE(buf) ((buf)->text->gap_size)

/* Is this buffer narrowed?  */
170 171
#define BUF_NARROWED(buf) ((BUF_BEGV (buf) != BUF_BEG (buf)) \
			   || (BUF_ZV (buf) != BUF_Z (buf)))
172

Jim Blandy's avatar
Jim Blandy committed
173
/* Modification count.  */
174 175
#define BUF_MODIFF(buf) ((buf)->text->modiff)

176 177 178
/* Character modification count.  */
#define BUF_CHARS_MODIFF(buf) ((buf)->text->chars_modiff)

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

182 183 184
/* Overlay modification count.  */
#define BUF_OVERLAY_MODIFF(buf) ((buf)->text->overlay_modiff)

185 186 187 188
/* Modification count as of last auto-save.  */
/* FIXME: should we move this into ->text->auto_save_modiff?  */
#define BUF_AUTOSAVE_MODIFF(buf) ((buf)->auto_save_modified)

189 190 191 192 193
/* Interval tree of buffer.  */
#define BUF_INTERVALS(buf) ((buf)->text->intervals)

/* Marker chain of buffer.  */
#define BUF_MARKERS(buf) ((buf)->text->markers)
Gerd Moellmann's avatar
Gerd Moellmann committed
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216

#define BUF_UNCHANGED_MODIFIED(buf) \
  ((buf)->text->unchanged_modified)

#define BUF_OVERLAY_UNCHANGED_MODIFIED(buf) \
  ((buf)->text->overlay_unchanged_modified)
#define BUF_BEG_UNCHANGED(buf) ((buf)->text->beg_unchanged)
#define BUF_END_UNCHANGED(buf) ((buf)->text->end_unchanged)

#define UNCHANGED_MODIFIED \
  BUF_UNCHANGED_MODIFIED (current_buffer)
#define OVERLAY_UNCHANGED_MODIFIED \
  BUF_OVERLAY_UNCHANGED_MODIFIED (current_buffer)
#define BEG_UNCHANGED BUF_BEG_UNCHANGED (current_buffer)
#define END_UNCHANGED BUF_END_UNCHANGED (current_buffer)

/* Compute how many characters at the top and bottom of BUF are
   unchanged when the range START..END is modified.  This computation
   must be done each time BUF is modified.  */

#define BUF_COMPUTE_UNCHANGED(buf, start, end)				\
  do									\
    {									\
217 218 219
      if (BUF_UNCHANGED_MODIFIED (buf) == BUF_MODIFF (buf)		\
	  && (BUF_OVERLAY_UNCHANGED_MODIFIED (buf)			\
	      == BUF_OVERLAY_MODIFF (buf)))				\
Gerd Moellmann's avatar
Gerd Moellmann committed
220 221 222 223 224 225 226 227 228 229 230 231 232
	{								\
	  BUF_BEG_UNCHANGED (buf) = (start) - BUF_BEG (buf);		\
	  BUF_END_UNCHANGED (buf) = BUF_Z (buf) - (end);		\
	}								\
      else								\
	{								\
	  if (BUF_Z (buf) - (end) < BUF_END_UNCHANGED (buf))		\
	    BUF_END_UNCHANGED (buf) = BUF_Z (buf) - (end);		\
	  if ((start) - BUF_BEG (buf) < BUF_BEG_UNCHANGED (buf))	\
	    BUF_BEG_UNCHANGED (buf) = (start) - BUF_BEG (buf);		\
	}								\
    }									\
  while (0)
233

234

Pavel Janík's avatar
Pavel Janík committed
235
/* Macros to set PT in the current buffer, or another buffer.  */
Jim Blandy's avatar
Jim Blandy committed
236

237
#define SET_PT(position) (set_point (position))
238
#define TEMP_SET_PT(position) (temp_set_point (current_buffer, (position)))
Jim Blandy's avatar
Jim Blandy committed
239

240
#define SET_PT_BOTH(position, byte) (set_point_both (position, byte))
241 242
#define TEMP_SET_PT_BOTH(position, byte) \
  (temp_set_point_both (current_buffer, (position), (byte)))
243

244 245
#define BUF_TEMP_SET_PT(buffer, position) \
  (temp_set_point ((buffer), (position)))
246

Jan D's avatar
Jan D committed
247
extern void set_point (EMACS_INT);
248
extern void temp_set_point (struct buffer *, EMACS_INT);
Jan D's avatar
Jan D committed
249
extern void set_point_both (EMACS_INT, EMACS_INT);
250 251
extern void temp_set_point_both (struct buffer *,
				 EMACS_INT, EMACS_INT);
Jan D's avatar
Jan D committed
252
extern void enlarge_buffer_text (struct buffer *, EMACS_INT);
Jim Blandy's avatar
Jim Blandy committed
253

254 255 256 257 258 259 260 261

/* Macros for setting the BEGV, ZV or PT of a given buffer.

   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.  */
Jim Blandy's avatar
Jim Blandy committed
262

263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
#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))

/* 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,
Eli Zaretskii's avatar
Eli Zaretskii committed
288
   and store the charpos in CHARPOS and the bytepos in BYTEPOS.  */
289 290

#define DECODE_POSITION(charpos, bytepos, pos)			\
291
do								\
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
  {								\
    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);	\
  }								\
307
while (0)
308 309 310 311

/* Return the address of byte position N in current buffer.  */

#define BYTE_POS_ADDR(n) \
Stefan Monnier's avatar
Stefan Monnier committed
312
  (((n) >= GPT_BYTE ? GAP_SIZE : 0) + (n) + BEG_ADDR - BEG_BYTE)
313 314 315 316 317 318

/* Return the address of char position N.  */

#define CHAR_POS_ADDR(n)			\
  (((n) >= GPT ? GAP_SIZE : 0)			\
   + buf_charpos_to_bytepos (current_buffer, n)	\
Stefan Monnier's avatar
Stefan Monnier committed
319
   + BEG_ADDR - BEG_BYTE)
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334

/* 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					    \
Stefan Monnier's avatar
Stefan Monnier committed
335 336
 - (ptr - (current_buffer)->text->beg <= (unsigned) (GPT_BYTE - BEG_BYTE) ? 0 : GAP_SIZE) \
 + BEG_BYTE)
337

338
/* Return character at byte position POS.  */
339 340

#define FETCH_CHAR(pos)				      	\
Tom Tromey's avatar
Tom Tromey committed
341
  (!NILP (BVAR (current_buffer, enable_multibyte_characters))	\
342 343 344 345 346 347 348 349 350 351
   ? 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;

352
/* Return character code of multi-byte form at byte position POS.  If POS
353 354 355 356 357
   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_BYTE ? GAP_SIZE : 0) 	\
Kenichi Handa's avatar
Kenichi Handa committed
358
			       + (pos) + BEG_ADDR - BEG_BYTE),	 	\
359
   STRING_CHAR (_fetch_multibyte_char_p))
360

361
/* Return character at byte position POS.  If the current buffer is unibyte
362 363 364 365
   and the character is not ASCII, make the returning character
   multibyte.  */

#define FETCH_CHAR_AS_MULTIBYTE(pos)			\
Tom Tromey's avatar
Tom Tromey committed
366
  (!NILP (BVAR (current_buffer, enable_multibyte_characters))	\
367
   ? FETCH_MULTIBYTE_CHAR ((pos))			\
368
   : UNIBYTE_TO_CHAR (FETCH_BYTE ((pos))))
369

370 371 372 373 374

/* Macros for accessing a character or byte,
   or converting between byte positions and addresses,
   in a specified buffer.  */

375
/* Return the address of character at byte position POS in buffer BUF.
Jim Blandy's avatar
Jim Blandy committed
376
   Note that both arguments can be computed more than once.  */
377 378

#define BUF_BYTE_ADDRESS(buf, pos) \
Stefan Monnier's avatar
Stefan Monnier committed
379
((buf)->text->beg + (pos) - BEG_BYTE		\
380 381
 + ((pos) >= (buf)->text->gpt_byte ? (buf)->text->gap_size : 0))

382
/* Return the address of character at char position POS in buffer BUF.
383 384 385
   Note that both arguments can be computed more than once.  */

#define BUF_CHAR_ADDRESS(buf, pos) \
Stefan Monnier's avatar
Stefan Monnier committed
386
((buf)->text->beg + buf_charpos_to_bytepos ((buf), (pos)) - BEG_BYTE	\
387
 + ((pos) >= (buf)->text->gpt ? (buf)->text->gap_size : 0))
Jim Blandy's avatar
Jim Blandy committed
388

389 390
/* Convert PTR, the address of a char in buffer BUF,
   into a character position.  */
391

392 393
#define BUF_PTR_BYTE_POS(buf, ptr)				\
((ptr) - (buf)->text->beg					\
Stefan Monnier's avatar
Stefan Monnier committed
394
 - (ptr - (buf)->text->beg <= (unsigned) (BUF_GPT_BYTE ((buf)) - BEG_BYTE)\
395
    ? 0 : BUF_GAP_SIZE ((buf)))					\
Stefan Monnier's avatar
Stefan Monnier committed
396
 + BEG_BYTE)
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416

/* 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)		\
Stefan Monnier's avatar
Stefan Monnier committed
417
        + (pos) + BUF_BEG_ADDR (buf) - BEG_BYTE),			\
418
   STRING_CHAR (_fetch_multibyte_char_p))
Jim Blandy's avatar
Jim Blandy committed
419

420 421 422 423 424
/* 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.  */

Jim Blandy's avatar
Jim Blandy committed
425 426
struct buffer_text
  {
427 428 429 430 431
    /* Actual address of buffer contents.  If REL_ALLOC is defined,
       this address might change when blocks are relocated which can
       e.g. happen when malloc is called.  So, don't pass a pointer
       into a buffer's text to functions that malloc.  */
    unsigned char *beg;
432

433 434 435 436 437
    EMACS_INT gpt;		/* Char pos of gap in buffer.  */
    EMACS_INT z;		/* Char pos of end of buffer.  */
    EMACS_INT gpt_byte;		/* Byte pos of gap in buffer.  */
    EMACS_INT z_byte;		/* Byte pos of end of buffer.  */
    EMACS_INT gap_size;		/* Size of buffer's gap.  */
Jim Blandy's avatar
Jim Blandy committed
438 439 440 441
    int modiff;			/* This counts buffer-modification events
				   for this buffer.  It is incremented for
				   each such event, and never otherwise
				   changed.  */
442 443 444 445
    int chars_modiff;           /* This is modified with character change
				   events for this buffer.  It is set to
				   modiff for each such event, and never
				   otherwise changed.  */
446 447 448
    int save_modiff;		/* Previous value of modiff, as of last
				   time buffer visited or saved a file.  */

449 450
    int overlay_modiff;		/* Counts modifications to overlays.  */

Gerd Moellmann's avatar
Gerd Moellmann committed
451
    /* Minimum value of GPT - BEG since last redisplay that finished.  */
452
    EMACS_INT beg_unchanged;
Gerd Moellmann's avatar
Gerd Moellmann committed
453 454

    /* Minimum value of Z - GPT since last redisplay that finished.  */
455
    EMACS_INT end_unchanged;
Gerd Moellmann's avatar
Gerd Moellmann committed
456 457 458 459 460 461 462 463 464 465

    /* MODIFF as of last redisplay that finished; if it matches MODIFF,
       beg_unchanged and end_unchanged contain no useful information.  */
    int unchanged_modified;

    /* BUF_OVERLAY_MODIFF of current buffer, as of last redisplay that
       finished; if it matches BUF_OVERLAY_MODIFF, beg_unchanged and
       end_unchanged contain no useful information.  */
    int overlay_unchanged_modified;

Dave Love's avatar
Dave Love committed
466 467
    /* Properties of this buffer's text.  */
    INTERVAL intervals;
468 469 470 471

    /* The markers that refer to this buffer.
       This is actually a single marker ---
       successive elements in its marker `chain'
472 473 474 475
       are the other markers referring to this buffer.
       This is a singly linked unordered list, which means that it's
       very cheap to add a marker to the list and it's also very cheap
       to move a marker within a buffer.  */
476
    struct Lisp_Marker *markers;
477 478

    /* Usually 0.  Temporarily set to 1 in decode_coding_gap to
479
       prevent Fgarbage_collect from shrinking the gap and losing
480 481
       not-yet-decoded bytes.  */
    int inhibit_shrinking;
Jim Blandy's avatar
Jim Blandy committed
482 483
  };

484
/* Lisp fields in struct buffer are hidden from most code and accessed
Tom Tromey's avatar
Tom Tromey committed
485
   via the BVAR macro, below.  Only select pieces of code, like the GC,
486 487 488 489 490
   are allowed to use BUFFER_INTERNAL_FIELD.  */
#define BUFFER_INTERNAL_FIELD(field) field ## _

/* Most code should use this macro to access Lisp fields in struct
   buffer.  */
Tom Tromey's avatar
Tom Tromey committed
491
#define BVAR(buf, field) ((buf)->BUFFER_INTERNAL_FIELD (field))
492

493 494
/* This is the structure that the buffer Lisp object points to.  */

Jim Blandy's avatar
Jim Blandy committed
495
struct buffer
496 497 498 499 500 501
{
  /* 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.  */

502 503
  /* HEADER.NEXT is the next buffer, in chain of all buffers,
     including killed buffers.
504 505 506 507
     This chain is used only for garbage collection, in order to
     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.  */
508
  struct vectorlike_header header;
509 510 511 512 513 514 515 516 517 518 519

  /* 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.  */
520
  EMACS_INT pt;
521
  /* Byte position of point in buffer.  */
522
  EMACS_INT pt_byte;
523
  /* Char position of beginning of accessible range.  */
524
  EMACS_INT begv;
525
  /* Byte position of beginning of accessible range.  */
526
  EMACS_INT begv_byte;
527
  /* Char position of end of accessible range.  */
528
  EMACS_INT zv;
529
  /* Byte position of end of accessible range.  */
530
  EMACS_INT zv_byte;
531 532 533 534 535 536 537 538 539 540

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

  /* A non-zero value in slot IDX means that per-buffer variable
     with index IDX has a local value in this buffer.  The index IDX
     for a buffer-local variable is stored in that variable's slot
     in buffer_local_flags as a Lisp integer.  If the index is -1,
     this means the variable is always local in all buffers.  */
541
#define MAX_PER_BUFFER_VARS 50
542
  char local_flags[MAX_PER_BUFFER_VARS];
543

544 545 546 547
  /* 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.  */
548
  time_t modtime;
549 550 551 552 553 554
  /* Size of the file when modtime was set.  This is used to detect the
     case where the file grew while we were reading it, so the modtime
     is still the same (since it's rounded up to seconds) but we're actually
     not up-to-date.  -1 means the size is unknown.  Only meaningful if
     modtime is actually set.  */
  EMACS_INT modtime_size;
555
  /* The value of text->modiff at the last auto-save.  */
556
  int auto_save_modified;
557 558 559
  /* The value of text->modiff at the last display error.
     Redisplay of this buffer is inhibited until it changes again.  */
  int display_error_modiff;
560 561 562 563 564
  /* 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.  */
565
  EMACS_INT last_window_start;
566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592

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

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

  /* Non-zero means don't use redisplay optimizations for
     displaying this buffer.  */
  unsigned prevent_redisplay_optimizations_p : 1;

593 594 595 596 597 598 599 600
  /* List of overlays that end at or before the current center,
     in order of end-position.  */
  struct Lisp_Overlay *overlays_before;

  /* List of overlays that end after  the current center,
     in order of start-position.  */
  struct Lisp_Overlay *overlays_after;

601 602 603
  /* Position where the overlay lists are centered.  */
  EMACS_INT overlay_center;

604 605 606 607
  /* Everything from here down must be a Lisp_Object.  */
  /* buffer-local Lisp variables start at `undo_list',
     tho only the ones from `name' on are GC'd normally.  */

608 609 610 611 612 613 614
  /* 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.
     This comes before `name' because it is marked in a special way.  */
615
  Lisp_Object BUFFER_INTERNAL_FIELD (undo_list);
616

617
  /* The name of this buffer.  */
618
  Lisp_Object BUFFER_INTERNAL_FIELD (name);
619 620

  /* The name of the file visited in this buffer, or nil.  */
621
  Lisp_Object BUFFER_INTERNAL_FIELD (filename);
622
  /* Dir for expanding relative file names.  */
623
  Lisp_Object BUFFER_INTERNAL_FIELD (directory);
Glenn Morris's avatar
Glenn Morris committed
624
  /* True if this buffer has been backed up (if you write to the
625 626 627
     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.  */
628
  Lisp_Object BUFFER_INTERNAL_FIELD (backed_up);
629
  /* Length of file when last read or saved.
630 631 632
     -1 means auto saving turned off because buffer shrank a lot.
     -2 means don't turn off auto saving if buffer shrinks.
       (That value is used with buffer-swap-text.)
633 634
     This is not in the  struct buffer_text
     because it's not used in indirect buffers at all.  */
635
  Lisp_Object BUFFER_INTERNAL_FIELD (save_length);
636 637 638
  /* 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.  */
639
  Lisp_Object BUFFER_INTERNAL_FIELD (auto_save_file_name);
640 641

  /* Non-nil if buffer read-only.  */
642
  Lisp_Object BUFFER_INTERNAL_FIELD (read_only);
643 644
  /* "The mark".  This is a marker which may
     point into this buffer or may point nowhere.  */
645
  Lisp_Object BUFFER_INTERNAL_FIELD (mark);
646

647 648 649
  /* Alist of elements (SYMBOL . VALUE-IN-THIS-BUFFER) for all
     per-buffer variables of this buffer.  For locally unbound
     symbols, just the symbol appears as the element.  */
650
  Lisp_Object BUFFER_INTERNAL_FIELD (local_var_alist);
651 652

  /* Symbol naming major mode (eg, lisp-mode).  */
653
  Lisp_Object BUFFER_INTERNAL_FIELD (major_mode);
654
  /* Pretty name of major mode (eg, "Lisp"). */
655
  Lisp_Object BUFFER_INTERNAL_FIELD (mode_name);
656
  /* Mode line element that controls format of mode line.  */
657
  Lisp_Object BUFFER_INTERNAL_FIELD (mode_line_format);
658

659 660
  /* Analogous to mode_line_format for the line displayed at the top
     of windows.  Nil means don't display that line.  */
661
  Lisp_Object BUFFER_INTERNAL_FIELD (header_line_format);
662 663

  /* Keys that are bound local to this buffer.  */
664
  Lisp_Object BUFFER_INTERNAL_FIELD (keymap);
665
  /* This buffer's local abbrev table.  */
666
  Lisp_Object BUFFER_INTERNAL_FIELD (abbrev_table);
667
  /* This buffer's syntax table.  */
668
  Lisp_Object BUFFER_INTERNAL_FIELD (syntax_table);
669
  /* This buffer's category table.  */
670
  Lisp_Object BUFFER_INTERNAL_FIELD (category_table);
671

Pavel Janík's avatar
Pavel Janík committed
672
  /* Values of several buffer-local variables.  */
673
  /* tab-width is buffer-local so that redisplay can find it
Pavel Janík's avatar
Pavel Janík committed
674
     in buffers that are not current.  */
675 676 677 678
  Lisp_Object BUFFER_INTERNAL_FIELD (case_fold_search);
  Lisp_Object BUFFER_INTERNAL_FIELD (tab_width);
  Lisp_Object BUFFER_INTERNAL_FIELD (fill_column);
  Lisp_Object BUFFER_INTERNAL_FIELD (left_margin);
679
  /* Function to call when insert space past fill column.  */
680
  Lisp_Object BUFFER_INTERNAL_FIELD (auto_fill_function);
681 682 683

  /* Case table for case-conversion in this buffer.
     This char-table maps each char into its lower-case version.  */
684
  Lisp_Object BUFFER_INTERNAL_FIELD (downcase_table);
685
  /* Char-table mapping each char to its upper-case version.  */
686
  Lisp_Object BUFFER_INTERNAL_FIELD (upcase_table);
687
  /* Char-table for conversion for case-folding search.  */
688
  Lisp_Object BUFFER_INTERNAL_FIELD (case_canon_table);
689
  /* Char-table of equivalences for case-folding search.  */
690
  Lisp_Object BUFFER_INTERNAL_FIELD (case_eqv_table);
691 692

  /* Non-nil means do not display continuation lines.  */
693
  Lisp_Object BUFFER_INTERNAL_FIELD (truncate_lines);
694
  /* Non-nil means to use word wrapping when displaying continuation lines.  */
695
  Lisp_Object BUFFER_INTERNAL_FIELD (word_wrap);
696
  /* Non-nil means display ctl chars with uparrow.  */
697
  Lisp_Object BUFFER_INTERNAL_FIELD (ctl_arrow);
698 699
  /* Non-nil means reorder bidirectional text for display in the
     visual order.  */
700
  Lisp_Object BUFFER_INTERNAL_FIELD (bidi_display_reordering);
701 702 703
  /* If non-nil, specifies which direction of text to force in all the
     paragraphs of the buffer.  Nil means determine paragraph
     direction dynamically for each paragraph.  */
704
  Lisp_Object BUFFER_INTERNAL_FIELD (bidi_paragraph_direction);
705 706
  /* Non-nil means do selective display;
     see doc string in syms_of_buffer (buffer.c) for details.  */
707
  Lisp_Object BUFFER_INTERNAL_FIELD (selective_display);
Jim Blandy's avatar
Jim Blandy committed
708
#ifndef old
709
  /* Non-nil means show ... at end of line followed by invisible lines.  */
710
  Lisp_Object BUFFER_INTERNAL_FIELD (selective_display_ellipses);
Jim Blandy's avatar
Jim Blandy committed
711
#endif
712
  /* Alist of (FUNCTION . STRING) for each minor mode enabled in buffer.  */
713
  Lisp_Object BUFFER_INTERNAL_FIELD (minor_modes);
714 715
  /* t if "self-insertion" should overwrite; `binary' if it should also
     overwrite newlines and tabs - for editing executables and the like.  */
716
  Lisp_Object BUFFER_INTERNAL_FIELD (overwrite_mode);
717
  /* non-nil means abbrev mode is on.  Expand abbrevs automatically.  */
718
  Lisp_Object BUFFER_INTERNAL_FIELD (abbrev_mode);
719
  /* Display table to use for text in this buffer.  */
720
  Lisp_Object BUFFER_INTERNAL_FIELD (display_table);
721
  /* t means the mark and region are currently active.  */
722
  Lisp_Object BUFFER_INTERNAL_FIELD (mark_active);
723 724 725

  /* Non-nil means the buffer contents are regarded as multi-byte
     form of characters, not a binary code.  */
726
  Lisp_Object BUFFER_INTERNAL_FIELD (enable_multibyte_characters);
727 728 729

  /* Coding system to be used for encoding the buffer contents on
     saving.  */
730
  Lisp_Object BUFFER_INTERNAL_FIELD (buffer_file_coding_system);
731

Pavel Janík's avatar
Pavel Janík committed
732
  /* List of symbols naming the file format used for visited file.  */
733
  Lisp_Object BUFFER_INTERNAL_FIELD (file_format);
734

735
  /* List of symbols naming the file format used for auto-save file.  */
736
  Lisp_Object BUFFER_INTERNAL_FIELD (auto_save_file_format);
737

738 739
  /* True if the newline position cache and width run cache are
     enabled.  See search.c and indent.c.  */
740
  Lisp_Object BUFFER_INTERNAL_FIELD (cache_long_line_scans);
741 742 743 744 745 746 747

  /* 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.  */
748
  Lisp_Object BUFFER_INTERNAL_FIELD (width_table);
749 750 751 752

  /* 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.  */
753
  Lisp_Object BUFFER_INTERNAL_FIELD (pt_marker);
754 755 756 757

  /* 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.  */
758
  Lisp_Object BUFFER_INTERNAL_FIELD (begv_marker);
759 760 761 762

  /* 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.  */
763
  Lisp_Object BUFFER_INTERNAL_FIELD (zv_marker);
764 765 766

  /* This holds the point value before the last scroll operation.
     Explicitly setting point sets this to nil.  */
767
  Lisp_Object BUFFER_INTERNAL_FIELD (point_before_scroll);
768 769

  /* Truename of the visited file, or nil.  */
770
  Lisp_Object BUFFER_INTERNAL_FIELD (file_truename);
771 772 773 774 775

  /* 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.  */
776
  Lisp_Object BUFFER_INTERNAL_FIELD (invisibility_spec);
777 778 779

  /* This is the last window that was selected with this buffer in it,
     or nil if that window no longer displays this buffer.  */
780
  Lisp_Object BUFFER_INTERNAL_FIELD (last_selected_window);
781 782

  /* Incremented each time the buffer is displayed in a window.  */
783
  Lisp_Object BUFFER_INTERNAL_FIELD (display_count);
784

785 786
  /* Widths of left and right marginal areas for windows displaying
     this buffer.  */
787
  Lisp_Object BUFFER_INTERNAL_FIELD (left_margin_cols), BUFFER_INTERNAL_FIELD (right_margin_cols);
788 789 790

  /* Widths of left and right fringe areas for windows displaying
     this buffer.  */
791
  Lisp_Object BUFFER_INTERNAL_FIELD (left_fringe_width), BUFFER_INTERNAL_FIELD (right_fringe_width);
792 793 794

  /* Non-nil means fringes are drawn outside display margins;
     othersize draw them between margin areas and text.  */
795
  Lisp_Object BUFFER_INTERNAL_FIELD (fringes_outside_margins);
796 797 798

  /* Width and type of scroll bar areas for windows displaying
     this buffer.  */
799
  Lisp_Object BUFFER_INTERNAL_FIELD (scroll_bar_width), BUFFER_INTERNAL_FIELD (vertical_scroll_bar_type);
800 801 802

  /* Non-nil means indicate lines not displaying text (in a style
     like vi).  */
803
  Lisp_Object BUFFER_INTERNAL_FIELD (indicate_empty_lines);
804

Kenichi Handa's avatar
Kenichi Handa committed
805
  /* Non-nil means indicate buffer boundaries and scrolling.  */
806
  Lisp_Object BUFFER_INTERNAL_FIELD (indicate_buffer_boundaries);
Kenichi Handa's avatar
Kenichi Handa committed
807

808
  /* Logical to physical fringe bitmap mappings.  */
809
  Lisp_Object BUFFER_INTERNAL_FIELD (fringe_indicator_alist);
810 811

  /* Logical to physical cursor bitmap mappings.  */
812
  Lisp_Object BUFFER_INTERNAL_FIELD (fringe_cursor_alist);
813

814
  /* Time stamp updated each time this buffer is displayed in a window.  */
815
  Lisp_Object BUFFER_INTERNAL_FIELD (display_time);
816 817 818 819 820

  /* If scrolling the display because point is below the bottom of a
     window showing this buffer, try to choose a window start so
     that point ends up this number of lines from the top of the
     window.  Nil means that scrolling method isn't used.  */
821
  Lisp_Object BUFFER_INTERNAL_FIELD (scroll_up_aggressively);
822

823 824 825 826
  /* If scrolling the display because point is above the top of a
     window showing this buffer, try to choose a window start so
     that point ends up this number of lines from the bottom of the
     window.  Nil means that scrolling method isn't used.  */
827
  Lisp_Object BUFFER_INTERNAL_FIELD (scroll_down_aggressively);
Gerd Moellmann's avatar
Gerd Moellmann committed
828

829 830
  /* Desired cursor type in this buffer.  See the doc string of
     per-buffer variable `cursor-type'.  */
831
  Lisp_Object BUFFER_INTERNAL_FIELD (cursor_type);
832 833 834

  /* An integer > 0 means put that number of pixels below text lines
     in the display of this buffer.  */
835
  Lisp_Object BUFFER_INTERNAL_FIELD (extra_line_spacing);
836 837 838 839

  /* *Cursor type to display in non-selected windows.
     t means to use hollow box cursor.
     See `cursor-type' for other values.  */
840
  Lisp_Object BUFFER_INTERNAL_FIELD (cursor_in_non_selected_windows);
841
};
842

843 844

/* This points to the current buffer.  */
Jim Blandy's avatar
Jim Blandy committed
845 846 847 848

extern struct buffer *current_buffer;

/* This structure holds the default values of the buffer-local variables
849
   that have special slots in each buffer.
Jim Blandy's avatar
Jim Blandy committed
850 851 852 853 854 855 856 857 858 859 860 861 862
   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,
863 864
   the entry for that slot (found in the same slot in this structure)
   is turned on in the buffer's local_flags array.
Jim Blandy's avatar
Jim Blandy committed
865 866

   If a slot in this structure is zero, then even though there may
867
   be a Lisp-level local variable for the slot, it has no default value,
Jim Blandy's avatar
Jim Blandy committed
868 869
   and the corresponding slot in buffer_defaults is not used.  */

870

Jim Blandy's avatar
Jim Blandy committed
871 872 873 874 875 876 877
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;
878

Jan D's avatar
Jan D committed
879 880 881 882 883 884 885 886
extern void delete_all_overlays (struct buffer *);
extern void reset_buffer (struct buffer *);
extern void evaporate_overlays (EMACS_INT);
extern int overlays_at (EMACS_INT pos, int extend, Lisp_Object **vec_ptr,
                        int *len_ptr, EMACS_INT *next_ptr,
                        EMACS_INT *prev_ptr, int change_req);
extern int sort_overlays (Lisp_Object *, int, struct window *);
extern void recenter_overlay_lists (struct buffer *, EMACS_INT);
887
extern EMACS_INT overlay_strings (EMACS_INT, struct window *, unsigned char **);
Jan D's avatar
Jan D committed
888 889 890 891 892 893 894 895
extern void validate_region (Lisp_Object *, Lisp_Object *);
extern void set_buffer_internal (struct buffer *);
extern void set_buffer_internal_1 (struct buffer *);
extern void set_buffer_temp (struct buffer *);
extern void record_buffer (Lisp_Object);
extern void buffer_slot_type_mismatch (Lisp_Object, int) NO_RETURN;
extern void fix_overlays_before (struct buffer *, EMACS_INT, EMACS_INT);
extern void mmap_set_vars (int);
896

Kim F. Storm's avatar
Kim F. Storm committed
897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915
/* Get overlays at POSN into array OVERLAYS with NOVERLAYS elements.
   If NEXTP is non-NULL, return next overlay there.
   See overlay_at arg CHANGE_REQ for meaning of CHRQ arg.  */

#define GET_OVERLAYS_AT(posn, overlays, noverlays, nextp, chrq)		\
  do {									\
    int maxlen = 40;							\
    overlays = (Lisp_Object *) alloca (maxlen * sizeof (Lisp_Object));	\
    noverlays = overlays_at (posn, 0, &overlays, &maxlen,		\
			     nextp, NULL, chrq);				\
    if (noverlays > maxlen)						\
      {									\
	maxlen = noverlays;						\
	overlays = (Lisp_Object *) alloca (maxlen * sizeof (Lisp_Object)); \
	noverlays = overlays_at (posn, 0, &overlays, &maxlen,		\
				 nextp, NULL, chrq);			\
      }									\
  } while (0)

Kenichi Handa's avatar
Kenichi Handa committed
916
EXFUN (Fbuffer_live_p, 1);
917 918
EXFUN (Fbuffer_name, 1);
EXFUN (Fnext_overlay_change, 1);
919
EXFUN (Fbuffer_local_value, 2);
920

921 922
extern Lisp_Object Qbefore_change_functions;
extern Lisp_Object Qafter_change_functions;
Jim Blandy's avatar
Jim Blandy committed
923
extern Lisp_Object Qfirst_change_hook;
Jim Blandy's avatar
Jim Blandy committed
924

925 926 927

/* Overlays */

928
/* 1 if the OV is an overlay object.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
929

Jim Blandy's avatar
Jim Blandy committed
930
#define OVERLAY_VALID(OV) (OVERLAYP (OV))
Jim Blandy's avatar
Jim Blandy committed
931