buffer.h 41.1 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-2012
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
#include <sys/types.h> /* for off_t, time_t */
Jim Blandy's avatar
Jim Blandy committed
22

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

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

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

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

36
/* Position of point in buffer.  The "+ 0" makes this
37
   not an l-value, so you can't assign to it.  Use SET_PT instead.  */
38
#define PT (current_buffer->pt + 0)
39
#define PT_BYTE (current_buffer->pt_byte + 0)
Jim Blandy's avatar
Jim Blandy committed
40

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

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

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

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

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

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

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

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

/* Address of end of gap in buffer.  */
Stefan Monnier's avatar
Stefan Monnier committed
68
#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
69

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

73
/* Address of end of buffer.  */
Stefan Monnier's avatar
Stefan Monnier committed
74
#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
75 76

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

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

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

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

88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
/* 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
105 106
   Note that many of these evaluate the buffer argument more than once.  */

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

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

114
/* Position of beginning of accessible range of buffer.  */
115 116 117 118 119 120 121 122 123
#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
124

125
/* Position of point in buffer.  */
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
#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
146

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

151
/* Position of end of buffer.  */
152
#define BUF_Z(buf) ((buf)->text->z)
153 154 155 156 157 158
#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
159
#define BUF_GPT_ADDR(buf) ((buf)->text->beg + (buf)->text->gpt_byte - BEG_BYTE)
160 161

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

/* Address of end of gap in buffer.  */
Stefan Monnier's avatar
Stefan Monnier committed
165
#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
166

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

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

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

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

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

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

186 187 188 189
/* 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)

190 191 192 193 194
/* 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
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217

#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									\
    {									\
218 219 220
      if (BUF_UNCHANGED_MODIFIED (buf) == BUF_MODIFF (buf)		\
	  && (BUF_OVERLAY_UNCHANGED_MODIFIED (buf)			\
	      == BUF_OVERLAY_MODIFF (buf)))				\
Gerd Moellmann's avatar
Gerd Moellmann committed
221 222 223 224 225 226 227 228 229 230 231 232 233
	{								\
	  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)
234

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

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

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

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

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

255 256 257 258 259 260 261 262

/* 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
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 288
#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
289
   and store the charpos in CHARPOS and the bytepos in BYTEPOS.  */
290 291

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

310 311
/* Maximum number of bytes in a buffer.
   A buffer cannot contain more bytes than a 1-origin fixnum can represent,
312 313 314 315
   nor can it be so large that C pointer arithmetic stops working.
   The ptrdiff_t cast ensures that this is signed, not unsigned.  */
#define BUF_BYTES_MAX \
  (ptrdiff_t) min (MOST_POSITIVE_FIXNUM - 1, min (SIZE_MAX, PTRDIFF_MAX))
316

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

#define BYTE_POS_ADDR(n) \
Stefan Monnier's avatar
Stefan Monnier committed
320
  (((n) >= GPT_BYTE ? GAP_SIZE : 0) + (n) + BEG_ADDR - BEG_BYTE)
321 322 323 324 325 326

/* 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
327
   + BEG_ADDR - BEG_BYTE)
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342

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

346 347
/* Return character at byte position POS.  See the caveat WARNING for
   FETCH_MULTIBYTE_CHAR below.  */
348 349

#define FETCH_CHAR(pos)				      	\
Tom Tromey's avatar
Tom Tromey committed
350
  (!NILP (BVAR (current_buffer, enable_multibyte_characters))	\
351 352 353 354 355 356 357 358 359 360
   ? 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;

361
/* Return character code of multi-byte form at byte position POS.  If POS
362
   doesn't point the head of valid multi-byte form, only the byte at
363 364 365 366 367 368 369 370 371 372 373
   POS is returned.  No range checking.

   WARNING: The character returned by this macro could be "unified"
   inside STRING_CHAR, if the original character in the buffer belongs
   to one of the Private Use Areas (PUAs) of codepoints that Emacs
   uses to support non-unified CJK characters.  If that happens,
   CHAR_BYTES will return a value that is different from the length of
   the original multibyte sequence stored in the buffer.  Therefore,
   do _not_ use FETCH_MULTIBYTE_CHAR if you need to advance through
   the buffer to the next character after fetching this one.  Instead,
   use either FETCH_CHAR_ADVANCE or STRING_CHAR_AND_LENGTH.  */
374 375 376

#define FETCH_MULTIBYTE_CHAR(pos)				 	\
  (_fetch_multibyte_char_p = (((pos) >= GPT_BYTE ? GAP_SIZE : 0) 	\
Kenichi Handa's avatar
Kenichi Handa committed
377
			       + (pos) + BEG_ADDR - BEG_BYTE),	 	\
378
   STRING_CHAR (_fetch_multibyte_char_p))
379

380
/* Return character at byte position POS.  If the current buffer is unibyte
381 382 383 384
   and the character is not ASCII, make the returning character
   multibyte.  */

#define FETCH_CHAR_AS_MULTIBYTE(pos)			\
Tom Tromey's avatar
Tom Tromey committed
385
  (!NILP (BVAR (current_buffer, enable_multibyte_characters))	\
386
   ? FETCH_MULTIBYTE_CHAR ((pos))			\
387
   : UNIBYTE_TO_CHAR (FETCH_BYTE ((pos))))
388

389 390 391 392 393

/* Macros for accessing a character or byte,
   or converting between byte positions and addresses,
   in a specified buffer.  */

394
/* Return the address of character at byte position POS in buffer BUF.
Jim Blandy's avatar
Jim Blandy committed
395
   Note that both arguments can be computed more than once.  */
396 397

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

401
/* Return the address of character at char position POS in buffer BUF.
402 403 404
   Note that both arguments can be computed more than once.  */

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

408 409
/* Convert PTR, the address of a char in buffer BUF,
   into a character position.  */
410

411 412
#define BUF_PTR_BYTE_POS(buf, ptr)				\
((ptr) - (buf)->text->beg					\
413
 - (ptr - (buf)->text->beg <= BUF_GPT_BYTE (buf) - BEG_BYTE	\
414
    ? 0 : BUF_GAP_SIZE ((buf)))					\
Stefan Monnier's avatar
Stefan Monnier committed
415
 + BEG_BYTE)
416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435

/* 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
436
        + (pos) + BUF_BEG_ADDR (buf) - BEG_BYTE),			\
437
   STRING_CHAR (_fetch_multibyte_char_p))
Jim Blandy's avatar
Jim Blandy committed
438

439 440 441 442 443
/* 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
444 445
struct buffer_text
  {
446 447 448 449 450
    /* 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;
451

452 453 454 455 456 457
    ptrdiff_t gpt;		/* Char pos of gap in buffer.  */
    ptrdiff_t z;		/* Char pos of end of buffer.  */
    ptrdiff_t gpt_byte;		/* Byte pos of gap in buffer.  */
    ptrdiff_t z_byte;		/* Byte pos of end of buffer.  */
    ptrdiff_t gap_size;		/* Size of buffer's gap.  */
    EMACS_INT modiff;		/* This counts buffer-modification events
Jim Blandy's avatar
Jim Blandy committed
458 459 460
				   for this buffer.  It is incremented for
				   each such event, and never otherwise
				   changed.  */
461
    EMACS_INT chars_modiff;	/* This is modified with character change
462 463 464
				   events for this buffer.  It is set to
				   modiff for each such event, and never
				   otherwise changed.  */
465
    EMACS_INT save_modiff;	/* Previous value of modiff, as of last
466 467
				   time buffer visited or saved a file.  */

468
    EMACS_INT overlay_modiff;	/* Counts modifications to overlays.  */
469

Gerd Moellmann's avatar
Gerd Moellmann committed
470
    /* Minimum value of GPT - BEG since last redisplay that finished.  */
471
    ptrdiff_t beg_unchanged;
Gerd Moellmann's avatar
Gerd Moellmann committed
472 473

    /* Minimum value of Z - GPT since last redisplay that finished.  */
474
    ptrdiff_t end_unchanged;
Gerd Moellmann's avatar
Gerd Moellmann committed
475 476 477

    /* MODIFF as of last redisplay that finished; if it matches MODIFF,
       beg_unchanged and end_unchanged contain no useful information.  */
478
    EMACS_INT unchanged_modified;
Gerd Moellmann's avatar
Gerd Moellmann committed
479 480 481 482

    /* 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.  */
483
    EMACS_INT overlay_unchanged_modified;
Gerd Moellmann's avatar
Gerd Moellmann committed
484

Dave Love's avatar
Dave Love committed
485 486
    /* Properties of this buffer's text.  */
    INTERVAL intervals;
487 488 489 490

    /* The markers that refer to this buffer.
       This is actually a single marker ---
       successive elements in its marker `chain'
491 492 493 494
       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.  */
495
    struct Lisp_Marker *markers;
496 497

    /* Usually 0.  Temporarily set to 1 in decode_coding_gap to
498
       prevent Fgarbage_collect from shrinking the gap and losing
499 500
       not-yet-decoded bytes.  */
    int inhibit_shrinking;
Jim Blandy's avatar
Jim Blandy committed
501 502
  };

503
/* Lisp fields in struct buffer are hidden from most code and accessed
Tom Tromey's avatar
Tom Tromey committed
504
   via the BVAR macro, below.  Only select pieces of code, like the GC,
505 506 507 508 509
   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
510
#define BVAR(buf, field) ((buf)->BUFFER_INTERNAL_FIELD (field))
511

512 513
/* This is the structure that the buffer Lisp object points to.  */

Jim Blandy's avatar
Jim Blandy committed
514
struct buffer
515 516 517 518 519 520
{
  /* 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.  */

521 522
  /* HEADER.NEXT is the next buffer, in chain of all buffers,
     including killed buffers.
523 524 525 526
     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.  */
527
  struct vectorlike_header header;
528 529 530 531 532 533 534 535 536 537 538

  /* 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.  */
539
  ptrdiff_t pt;
540
  /* Byte position of point in buffer.  */
541
  ptrdiff_t pt_byte;
542
  /* Char position of beginning of accessible range.  */
543
  ptrdiff_t begv;
544
  /* Byte position of beginning of accessible range.  */
545
  ptrdiff_t begv_byte;
546
  /* Char position of end of accessible range.  */
547
  ptrdiff_t zv;
548
  /* Byte position of end of accessible range.  */
549
  ptrdiff_t zv_byte;
550 551 552 553 554 555 556 557 558 559

  /* 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.  */
560
#define MAX_PER_BUFFER_VARS 50
561
  char local_flags[MAX_PER_BUFFER_VARS];
562

563 564 565 566
  /* 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.  */
567
  time_t modtime;
568 569 570 571 572
  /* 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.  */
573
  off_t modtime_size;
574
  /* The value of text->modiff at the last auto-save.  */
575
  EMACS_INT auto_save_modified;
576 577
  /* The value of text->modiff at the last display error.
     Redisplay of this buffer is inhibited until it changes again.  */
578
  EMACS_INT display_error_modiff;
579
  /* The time at which we detected a failure to auto-save,
580 581
     Or 0 if we didn't have a failure.  */
  time_t auto_save_failure_time;
582 583
  /* Position in buffer at which display started
     the last time this buffer was displayed.  */
584
  ptrdiff_t last_window_start;
585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611

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

612 613 614 615 616 617 618 619
  /* 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;

620
  /* Position where the overlay lists are centered.  */
621
  ptrdiff_t overlay_center;
622

623 624 625
  /* 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.  */
626
  #define FIRST_FIELD_PER_BUFFER undo_list
627

628 629 630 631 632 633 634
  /* 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.  */
635
  Lisp_Object BUFFER_INTERNAL_FIELD (undo_list);
636

637
  /* The name of this buffer.  */
638
  Lisp_Object BUFFER_INTERNAL_FIELD (name);
639 640

  /* The name of the file visited in this buffer, or nil.  */
641
  Lisp_Object BUFFER_INTERNAL_FIELD (filename);
642
  /* Dir for expanding relative file names.  */
643
  Lisp_Object BUFFER_INTERNAL_FIELD (directory);
Glenn Morris's avatar
Glenn Morris committed
644
  /* True if this buffer has been backed up (if you write to the
645 646 647
     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.  */
648
  Lisp_Object BUFFER_INTERNAL_FIELD (backed_up);
649
  /* Length of file when last read or saved.
650 651 652
     -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.)
653 654
     This is not in the  struct buffer_text
     because it's not used in indirect buffers at all.  */
655
  Lisp_Object BUFFER_INTERNAL_FIELD (save_length);
656 657 658
  /* 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.  */
659
  Lisp_Object BUFFER_INTERNAL_FIELD (auto_save_file_name);
660 661

  /* Non-nil if buffer read-only.  */
662
  Lisp_Object BUFFER_INTERNAL_FIELD (read_only);
663 664
  /* "The mark".  This is a marker which may
     point into this buffer or may point nowhere.  */
665
  Lisp_Object BUFFER_INTERNAL_FIELD (mark);
666

667 668 669
  /* 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.  */
670
  Lisp_Object BUFFER_INTERNAL_FIELD (local_var_alist);
671 672

  /* Symbol naming major mode (eg, lisp-mode).  */
673
  Lisp_Object BUFFER_INTERNAL_FIELD (major_mode);
674
  /* Pretty name of major mode (eg, "Lisp"). */
675
  Lisp_Object BUFFER_INTERNAL_FIELD (mode_name);
676
  /* Mode line element that controls format of mode line.  */
677
  Lisp_Object BUFFER_INTERNAL_FIELD (mode_line_format);
678

679 680
  /* Analogous to mode_line_format for the line displayed at the top
     of windows.  Nil means don't display that line.  */
681
  Lisp_Object BUFFER_INTERNAL_FIELD (header_line_format);
682 683

  /* Keys that are bound local to this buffer.  */
684
  Lisp_Object BUFFER_INTERNAL_FIELD (keymap);
685
  /* This buffer's local abbrev table.  */
686
  Lisp_Object BUFFER_INTERNAL_FIELD (abbrev_table);
687
  /* This buffer's syntax table.  */
688
  Lisp_Object BUFFER_INTERNAL_FIELD (syntax_table);
689
  /* This buffer's category table.  */
690
  Lisp_Object BUFFER_INTERNAL_FIELD (category_table);
691

Pavel Janík's avatar
Pavel Janík committed
692
  /* Values of several buffer-local variables.  */
693
  /* tab-width is buffer-local so that redisplay can find it
Pavel Janík's avatar
Pavel Janík committed
694
     in buffers that are not current.  */
695 696 697 698
  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);
699
  /* Function to call when insert space past fill column.  */
700
  Lisp_Object BUFFER_INTERNAL_FIELD (auto_fill_function);
701 702 703

  /* Case table for case-conversion in this buffer.
     This char-table maps each char into its lower-case version.  */
704
  Lisp_Object BUFFER_INTERNAL_FIELD (downcase_table);
705
  /* Char-table mapping each char to its upper-case version.  */
706
  Lisp_Object BUFFER_INTERNAL_FIELD (upcase_table);
707
  /* Char-table for conversion for case-folding search.  */
708
  Lisp_Object BUFFER_INTERNAL_FIELD (case_canon_table);
709
  /* Char-table of equivalences for case-folding search.  */
710
  Lisp_Object BUFFER_INTERNAL_FIELD (case_eqv_table);
711 712

  /* Non-nil means do not display continuation lines.  */
713
  Lisp_Object BUFFER_INTERNAL_FIELD (truncate_lines);
714
  /* Non-nil means to use word wrapping when displaying continuation lines.  */
715
  Lisp_Object BUFFER_INTERNAL_FIELD (word_wrap);
716
  /* Non-nil means display ctl chars with uparrow.  */
717
  Lisp_Object BUFFER_INTERNAL_FIELD (ctl_arrow);
718 719
  /* Non-nil means reorder bidirectional text for display in the
     visual order.  */
720
  Lisp_Object BUFFER_INTERNAL_FIELD (bidi_display_reordering);
721 722 723
  /* 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.  */
724
  Lisp_Object BUFFER_INTERNAL_FIELD (bidi_paragraph_direction);
725 726
  /* Non-nil means do selective display;
     see doc string in syms_of_buffer (buffer.c) for details.  */
727
  Lisp_Object BUFFER_INTERNAL_FIELD (selective_display);
Jim Blandy's avatar
Jim Blandy committed
728
#ifndef old
729
  /* Non-nil means show ... at end of line followed by invisible lines.  */
730
  Lisp_Object BUFFER_INTERNAL_FIELD (selective_display_ellipses);
Jim Blandy's avatar
Jim Blandy committed
731
#endif
732
  /* Alist of (FUNCTION . STRING) for each minor mode enabled in buffer.  */
733
  Lisp_Object BUFFER_INTERNAL_FIELD (minor_modes);
734 735
  /* t if "self-insertion" should overwrite; `binary' if it should also
     overwrite newlines and tabs - for editing executables and the like.  */
736
  Lisp_Object BUFFER_INTERNAL_FIELD (overwrite_mode);
737
  /* non-nil means abbrev mode is on.  Expand abbrevs automatically.  */
738
  Lisp_Object BUFFER_INTERNAL_FIELD (abbrev_mode);
739
  /* Display table to use for text in this buffer.  */
740
  Lisp_Object BUFFER_INTERNAL_FIELD (display_table);
741
  /* t means the mark and region are currently active.  */
742
  Lisp_Object BUFFER_INTERNAL_FIELD (mark_active);
743 744 745

  /* Non-nil means the buffer contents are regarded as multi-byte
     form of characters, not a binary code.  */
746
  Lisp_Object BUFFER_INTERNAL_FIELD (enable_multibyte_characters);
747 748 749

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

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

755
  /* List of symbols naming the file format used for auto-save file.  */
756
  Lisp_Object BUFFER_INTERNAL_FIELD (auto_save_file_format);
757

758 759
  /* True if the newline position cache and width run cache are
     enabled.  See search.c and indent.c.  */
760
  Lisp_Object BUFFER_INTERNAL_FIELD (cache_long_line_scans);
761 762 763 764 765 766 767

  /* 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.  */
768
  Lisp_Object BUFFER_INTERNAL_FIELD (width_table);
769 770 771 772

  /* 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.  */
773
  Lisp_Object BUFFER_INTERNAL_FIELD (pt_marker);
774 775 776 777

  /* 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.  */
778
  Lisp_Object BUFFER_INTERNAL_FIELD (begv_marker);
779 780 781 782

  /* 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.  */
783
  Lisp_Object BUFFER_INTERNAL_FIELD (zv_marker);
784 785 786

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

  /* Truename of the visited file, or nil.  */
790
  Lisp_Object BUFFER_INTERNAL_FIELD (file_truename);
791 792 793 794 795

  /* 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.  */
796
  Lisp_Object BUFFER_INTERNAL_FIELD (invisibility_spec);
797 798 799

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

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

805 806
  /* Widths of left and right marginal areas for windows displaying
     this buffer.  */
807
  Lisp_Object BUFFER_INTERNAL_FIELD (left_margin_cols), BUFFER_INTERNAL_FIELD (right_margin_cols);
808 809 810

  /* Widths of left and right fringe areas for windows displaying
     this buffer.  */
811
  Lisp_Object BUFFER_INTERNAL_FIELD (left_fringe_width), BUFFER_INTERNAL_FIELD (right_fringe_width);
812 813 814

  /* Non-nil means fringes are drawn outside display margins;
     othersize draw them between margin areas and text.  */
815
  Lisp_Object BUFFER_INTERNAL_FIELD (fringes_outside_margins);
816 817 818

  /* Width and type of scroll bar areas for windows displaying
     this buffer.  */
819
  Lisp_Object BUFFER_INTERNAL_FIELD (scroll_bar_width), BUFFER_INTERNAL_FIELD (vertical_scroll_bar_type);
820 821 822

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

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

828
  /* Logical to physical fringe bitmap mappings.  */
829
  Lisp_Object BUFFER_INTERNAL_FIELD (fringe_indicator_alist);
830 831

  /* Logical to physical cursor bitmap mappings.  */
832
  Lisp_Object BUFFER_INTERNAL_FIELD (fringe_cursor_alist);
833

834
  /* Time stamp updated each time this buffer is displayed in a window.  */
835
  Lisp_Object BUFFER_INTERNAL_FIELD (display_time);
836 837 838 839 840

  /* 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.  */
841
  Lisp_Object BUFFER_INTERNAL_FIELD (scroll_up_aggressively);
842

843 844 845 846
  /* 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.  */
847
  Lisp_Object BUFFER_INTERNAL_FIELD (scroll_down_aggressively);
Gerd Moellmann's avatar
Gerd Moellmann committed
848

849 850
  /* Desired cursor type in this buffer.  See the doc string of
     per-buffer variable `cursor-type'.  */
851
  Lisp_Object BUFFER_INTERNAL_FIELD (cursor_type);
852 853 854

  /* An integer > 0 means put that number of pixels below text lines
     in the display of this buffer.  */
855
  Lisp_Object BUFFER_INTERNAL_FIELD (extra_line_spacing);
856 857 858 859

  /* *Cursor type to display in non-selected windows.
     t means to use hollow box cursor.
     See `cursor-type' for other values.  */
860
  Lisp_Object BUFFER_INTERNAL_FIELD (cursor_in_non_selected_windows);
861 862 863

  /* This must be the last field in the above list.  */
  #define LAST_FIELD_PER_BUFFER cursor_in_non_selected_windows
864
};
865

866 867

/* This points to the current buffer.  */
Jim Blandy's avatar
Jim Blandy committed
868 869 870 871

extern struct buffer *current_buffer;

/* This structure holds the default values of the buffer-local variables
872
   that have special slots in each buffer.
Jim Blandy's avatar
Jim Blandy committed
873 874 875 876 877 878 879 880 881 882 883 884 885
   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,
886 887
   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
888 889

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

893

Jim Blandy's avatar
Jim Blandy committed
894 895 896 897 898 899 900
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;
901

Jan D's avatar
Jan D committed
902 903
extern void delete_all_overlays (struct buffer *);
extern void reset_buffer (struct buffer *);
904
extern void evaporate_overlays (ptrdiff_t);