buffer.h 42.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 */
22
#include "systime.h" /* for EMACS_TIME */
Jim Blandy's avatar
Jim Blandy committed
23

24 25 26 27 28
INLINE_HEADER_BEGIN
#ifndef BUFFER_INLINE
# define BUFFER_INLINE INLINE
#endif

29
/* Accessing the parameters of the current buffer.  */
30

31 32
/* These macros come in pairs, one for the char position
   and one for the byte position.  */
Jim Blandy's avatar
Jim Blandy committed
33

34
/* Position of beginning of buffer.  */
Jim Blandy's avatar
Jim Blandy committed
35
#define BEG (1)
36
#define BEG_BYTE (BEG)
Jim Blandy's avatar
Jim Blandy committed
37

38
/* Position of beginning of accessible range of buffer.  */
39
#define BEGV (current_buffer->begv)
40
#define BEGV_BYTE (current_buffer->begv_byte)
Jim Blandy's avatar
Jim Blandy committed
41

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

47
/* Position of gap in buffer.  */
48
#define GPT (current_buffer->text->gpt)
49
#define GPT_BYTE (current_buffer->text->gpt_byte)
Jim Blandy's avatar
Jim Blandy committed
50

51
/* Position of end of accessible range of buffer.  */
52
#define ZV (current_buffer->zv)
53
#define ZV_BYTE (current_buffer->zv_byte)
Jim Blandy's avatar
Jim Blandy committed
54

55
/* Position of end of buffer.  */
56
#define Z (current_buffer->text->z)
57
#define Z_BYTE (current_buffer->text->z_byte)
Jim Blandy's avatar
Jim Blandy committed
58

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

61
/* Address of beginning of buffer.  */
62
#define BEG_ADDR (current_buffer->text->beg)
Jim Blandy's avatar
Jim Blandy committed
63

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

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

70
/* Address of beginning of gap in buffer.  */
Stefan Monnier's avatar
Stefan Monnier committed
71
#define GPT_ADDR (current_buffer->text->beg + current_buffer->text->gpt_byte - BEG_BYTE)
Jim Blandy's avatar
Jim Blandy committed
72 73

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

76
/* Address of end of accessible range of buffer.  */
77
#define ZV_ADDR (BYTE_POS_ADDR (current_buffer->zv_byte))
78

79
/* Address of end of buffer.  */
Stefan Monnier's avatar
Stefan Monnier committed
80
#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
81 82

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

85 86 87 88 89 90
/* Is the current buffer narrowed?  */
#define NARROWED	((BEGV != BEG) || (ZV != Z))

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

91 92 93
/* Character modification count.  */
#define CHARS_MODIFF (current_buffer->text->chars_modiff)

94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
/* 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
111 112
   Note that many of these evaluate the buffer argument more than once.  */

113
/* Position of beginning of buffer.  */
Stefan Monnier's avatar
Stefan Monnier committed
114 115
#define BUF_BEG(buf) (BEG)
#define BUF_BEG_BYTE(buf) (BEG_BYTE)
Jim Blandy's avatar
Jim Blandy committed
116

117 118
/* The BUF_BEGV[_BYTE], BUF_ZV[_BYTE], and BUF_PT[_BYTE] macros cannot
   be used for assignment; use SET_BUF_* macros below for that.  */
119

120
/* Position of beginning of accessible range of buffer.  */
121 122 123 124 125 126 127 128 129
#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
130

131
/* Position of point in buffer.  */
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
#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
152

153
/* Position of gap in buffer.  */
154
#define BUF_GPT(buf) ((buf)->text->gpt)
155
#define BUF_GPT_BYTE(buf) ((buf)->text->gpt_byte)
Jim Blandy's avatar
Jim Blandy committed
156

157
/* Position of end of buffer.  */
158
#define BUF_Z(buf) ((buf)->text->z)
159 160 161 162 163 164
#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
165
#define BUF_GPT_ADDR(buf) ((buf)->text->beg + (buf)->text->gpt_byte - BEG_BYTE)
166 167

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

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

173 174 175 176
/* Size of gap.  */
#define BUF_GAP_SIZE(buf) ((buf)->text->gap_size)

/* Is this buffer narrowed?  */
177 178
#define BUF_NARROWED(buf) ((BUF_BEGV (buf) != BUF_BEG (buf)) \
			   || (BUF_ZV (buf) != BUF_Z (buf)))
179

Jim Blandy's avatar
Jim Blandy committed
180
/* Modification count.  */
181 182
#define BUF_MODIFF(buf) ((buf)->text->modiff)

183 184 185
/* Character modification count.  */
#define BUF_CHARS_MODIFF(buf) ((buf)->text->chars_modiff)

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

189 190 191
/* Overlay modification count.  */
#define BUF_OVERLAY_MODIFF(buf) ((buf)->text->overlay_modiff)

192 193 194 195
/* 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)

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

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

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

241
#define SET_PT(position) (set_point (position))
242
#define TEMP_SET_PT(position) (temp_set_point (current_buffer, (position)))
Jim Blandy's avatar
Jim Blandy committed
243

244
#define SET_PT_BOTH(position, byte) (set_point_both (position, byte))
245 246
#define TEMP_SET_PT_BOTH(position, byte) \
  (temp_set_point_both (current_buffer, (position), (byte)))
247

248 249
#define BUF_TEMP_SET_PT(buffer, position) \
  (temp_set_point ((buffer), (position)))
250

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

258 259 260 261 262 263 264 265

/* 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
266

267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
#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
292
   and store the charpos in CHARPOS and the bytepos in BYTEPOS.  */
293 294

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

313 314
/* Maximum number of bytes in a buffer.
   A buffer cannot contain more bytes than a 1-origin fixnum can represent,
315 316 317 318
   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))
319

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

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

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

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

349 350
/* Return character at byte position POS.  See the caveat WARNING for
   FETCH_MULTIBYTE_CHAR below.  */
351 352

#define FETCH_CHAR(pos)				      	\
Tom Tromey's avatar
Tom Tromey committed
353
  (!NILP (BVAR (current_buffer, enable_multibyte_characters))	\
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)))

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					\
394
 - (ptr - (buf)->text->beg <= 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

/* 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)))
Jim Blandy's avatar
Jim Blandy committed
409

410 411 412 413 414
/* 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
415 416
struct buffer_text
  {
417 418 419 420 421
    /* 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;
422

423 424 425 426 427 428
    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
429 430 431
				   for this buffer.  It is incremented for
				   each such event, and never otherwise
				   changed.  */
432
    EMACS_INT chars_modiff;	/* This is modified with character change
433 434 435
				   events for this buffer.  It is set to
				   modiff for each such event, and never
				   otherwise changed.  */
436
    EMACS_INT save_modiff;	/* Previous value of modiff, as of last
437 438
				   time buffer visited or saved a file.  */

439
    EMACS_INT overlay_modiff;	/* Counts modifications to overlays.  */
440

Dmitry Antipov's avatar
Dmitry Antipov committed
441 442 443
    EMACS_INT compact;		/* Set to modiff each time when compact_buffer
				   is called for this buffer.  */

Gerd Moellmann's avatar
Gerd Moellmann committed
444
    /* Minimum value of GPT - BEG since last redisplay that finished.  */
445
    ptrdiff_t beg_unchanged;
Gerd Moellmann's avatar
Gerd Moellmann committed
446 447

    /* Minimum value of Z - GPT since last redisplay that finished.  */
448
    ptrdiff_t end_unchanged;
Gerd Moellmann's avatar
Gerd Moellmann committed
449 450 451

    /* MODIFF as of last redisplay that finished; if it matches MODIFF,
       beg_unchanged and end_unchanged contain no useful information.  */
452
    EMACS_INT unchanged_modified;
Gerd Moellmann's avatar
Gerd Moellmann committed
453 454 455 456

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

Dave Love's avatar
Dave Love committed
459 460
    /* Properties of this buffer's text.  */
    INTERVAL intervals;
461 462 463 464

    /* The markers that refer to this buffer.
       This is actually a single marker ---
       successive elements in its marker `chain'
465 466 467 468
       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.  */
469
    struct Lisp_Marker *markers;
470 471

    /* Usually 0.  Temporarily set to 1 in decode_coding_gap to
472
       prevent Fgarbage_collect from shrinking the gap and losing
473 474
       not-yet-decoded bytes.  */
    int inhibit_shrinking;
Jim Blandy's avatar
Jim Blandy committed
475 476
  };

477
/* Most code should use this macro to access Lisp fields in struct buffer.  */
478

479
#define BVAR(buf, field) ((buf)->INTERNAL_FIELD (field))
480

481 482
/* This is the structure that the buffer Lisp object points to.  */

Jim Blandy's avatar
Jim Blandy committed
483
struct buffer
484
{
485 486 487 488 489
  /* HEADER.NEXT is the next buffer, in chain of all buffers, including killed
     buffers.  This chain, starting from all_buffers, is used only for garbage
     collection, in order to collect killed buffers properly.  Note that large
     vectors and large pseudo-vector objects are all on another chain starting
     from large_vectors.  */
490
  struct vectorlike_header header;
491 492

  /* The name of this buffer.  */
493
  Lisp_Object INTERNAL_FIELD (name);
494 495

  /* The name of the file visited in this buffer, or nil.  */
496
  Lisp_Object INTERNAL_FIELD (filename);
497 498

  /* Directory for expanding relative file names.  */
499
  Lisp_Object INTERNAL_FIELD (directory);
500 501 502

  /* True if 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).  */
503
  Lisp_Object INTERNAL_FIELD (backed_up);
504

505
  /* Length of file when last read or saved.
506 507 508
     -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.)
509 510
     This is not in the  struct buffer_text
     because it's not used in indirect buffers at all.  */
511
  Lisp_Object INTERNAL_FIELD (save_length);
512

513 514 515
  /* 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.  */
516
  Lisp_Object INTERNAL_FIELD (auto_save_file_name);
517 518

  /* Non-nil if buffer read-only.  */
519
  Lisp_Object INTERNAL_FIELD (read_only);
520

521 522
  /* "The mark".  This is a marker which may
     point into this buffer or may point nowhere.  */
523
  Lisp_Object INTERNAL_FIELD (mark);
524

525 526 527
  /* 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.  */
528
  Lisp_Object INTERNAL_FIELD (local_var_alist);
529

530
  /* Symbol naming major mode (e.g., lisp-mode).  */
531
  Lisp_Object INTERNAL_FIELD (major_mode);
532 533

  /* Pretty name of major mode (e.g., "Lisp"). */
534
  Lisp_Object INTERNAL_FIELD (mode_name);
535

536
  /* Mode line element that controls format of mode line.  */
537
  Lisp_Object INTERNAL_FIELD (mode_line_format);
538

539 540
  /* Analogous to mode_line_format for the line displayed at the top
     of windows.  Nil means don't display that line.  */
541
  Lisp_Object INTERNAL_FIELD (header_line_format);
542 543

  /* Keys that are bound local to this buffer.  */
544
  Lisp_Object INTERNAL_FIELD (keymap);
545

546
  /* This buffer's local abbrev table.  */
547
  Lisp_Object INTERNAL_FIELD (abbrev_table);
548

549
  /* This buffer's syntax table.  */
550
  Lisp_Object INTERNAL_FIELD (syntax_table);
551

552
  /* This buffer's category table.  */
553
  Lisp_Object INTERNAL_FIELD (category_table);
554

Pavel Janík's avatar
Pavel Janík committed
555
  /* Values of several buffer-local variables.  */
556
  /* tab-width is buffer-local so that redisplay can find it
Pavel Janík's avatar
Pavel Janík committed
557
     in buffers that are not current.  */
558 559 560 561
  Lisp_Object INTERNAL_FIELD (case_fold_search);
  Lisp_Object INTERNAL_FIELD (tab_width);
  Lisp_Object INTERNAL_FIELD (fill_column);
  Lisp_Object INTERNAL_FIELD (left_margin);
562

563
  /* Function to call when insert space past fill column.  */
564
  Lisp_Object INTERNAL_FIELD (auto_fill_function);
565 566 567

  /* Case table for case-conversion in this buffer.
     This char-table maps each char into its lower-case version.  */
568
  Lisp_Object INTERNAL_FIELD (downcase_table);
569

570
  /* Char-table mapping each char to its upper-case version.  */
571
  Lisp_Object INTERNAL_FIELD (upcase_table);
572

573
  /* Char-table for conversion for case-folding search.  */
574
  Lisp_Object INTERNAL_FIELD (case_canon_table);
575

576
  /* Char-table of equivalences for case-folding search.  */
577
  Lisp_Object INTERNAL_FIELD (case_eqv_table);
578 579

  /* Non-nil means do not display continuation lines.  */
580
  Lisp_Object INTERNAL_FIELD (truncate_lines);
581

582
  /* Non-nil means to use word wrapping when displaying continuation lines.  */
583
  Lisp_Object INTERNAL_FIELD (word_wrap);
584

585
  /* Non-nil means display ctl chars with uparrow.  */
586
  Lisp_Object INTERNAL_FIELD (ctl_arrow);
587

588 589
  /* Non-nil means reorder bidirectional text for display in the
     visual order.  */
590
  Lisp_Object INTERNAL_FIELD (bidi_display_reordering);
591

592 593 594
  /* 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.  */
595
  Lisp_Object INTERNAL_FIELD (bidi_paragraph_direction);
596

597 598
  /* Non-nil means do selective display;
     see doc string in syms_of_buffer (buffer.c) for details.  */
599
  Lisp_Object INTERNAL_FIELD (selective_display);
600

601
  /* Non-nil means show ... at end of line followed by invisible lines.  */
602
  Lisp_Object INTERNAL_FIELD (selective_display_ellipses);
603

604
  /* Alist of (FUNCTION . STRING) for each minor mode enabled in buffer.  */
605
  Lisp_Object INTERNAL_FIELD (minor_modes);
606

607 608
  /* t if "self-insertion" should overwrite; `binary' if it should also
     overwrite newlines and tabs - for editing executables and the like.  */
609
  Lisp_Object INTERNAL_FIELD (overwrite_mode);
610 611

  /* Non-nil means abbrev mode is on.  Expand abbrevs automatically.  */
612
  Lisp_Object INTERNAL_FIELD (abbrev_mode);
613

614
  /* Display table to use for text in this buffer.  */
615
  Lisp_Object INTERNAL_FIELD (display_table);
616

617
  /* t means the mark and region are currently active.  */
618
  Lisp_Object INTERNAL_FIELD (mark_active);
619 620 621

  /* Non-nil means the buffer contents are regarded as multi-byte
     form of characters, not a binary code.  */
622
  Lisp_Object INTERNAL_FIELD (enable_multibyte_characters);
623 624 625

  /* Coding system to be used for encoding the buffer contents on
     saving.  */
626
  Lisp_Object INTERNAL_FIELD (buffer_file_coding_system);
627

Pavel Janík's avatar
Pavel Janík committed
628
  /* List of symbols naming the file format used for visited file.  */
629
  Lisp_Object INTERNAL_FIELD (file_format);
630

631
  /* List of symbols naming the file format used for auto-save file.  */
632
  Lisp_Object INTERNAL_FIELD (auto_save_file_format);
633

634 635
  /* True if the newline position cache and width run cache are
     enabled.  See search.c and indent.c.  */
636
  Lisp_Object INTERNAL_FIELD (cache_long_line_scans);
637 638 639 640 641 642 643

  /* 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.  */
644
  Lisp_Object INTERNAL_FIELD (width_table);
645 646 647 648

  /* 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.  */
649
  Lisp_Object INTERNAL_FIELD (pt_marker);
650 651 652 653

  /* 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.  */
654
  Lisp_Object INTERNAL_FIELD (begv_marker);
655 656 657 658

  /* 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.  */
659
  Lisp_Object INTERNAL_FIELD (zv_marker);
660 661 662

  /* This holds the point value before the last scroll operation.
     Explicitly setting point sets this to nil.  */
663
  Lisp_Object INTERNAL_FIELD (point_before_scroll);
664 665

  /* Truename of the visited file, or nil.  */
666
  Lisp_Object INTERNAL_FIELD (file_truename);
667 668 669 670 671

  /* 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.  */
672
  Lisp_Object INTERNAL_FIELD (invisibility_spec);
673 674 675

  /* This is the last window that was selected with this buffer in it,
     or nil if that window no longer displays this buffer.  */
676
  Lisp_Object INTERNAL_FIELD (last_selected_window);
677 678

  /* Incremented each time the buffer is displayed in a window.  */
679
  Lisp_Object INTERNAL_FIELD (display_count);
680

681 682
  /* Widths of left and right marginal areas for windows displaying
     this buffer.  */
683 684
  Lisp_Object INTERNAL_FIELD (left_margin_cols);
  Lisp_Object INTERNAL_FIELD (right_margin_cols);
685 686 687

  /* Widths of left and right fringe areas for windows displaying
     this buffer.  */
688 689
  Lisp_Object INTERNAL_FIELD (left_fringe_width);
  Lisp_Object INTERNAL_FIELD (right_fringe_width);
690 691 692

  /* Non-nil means fringes are drawn outside display margins;
     othersize draw them between margin areas and text.  */
693
  Lisp_Object INTERNAL_FIELD (fringes_outside_margins);
694 695 696

  /* Width and type of scroll bar areas for windows displaying
     this buffer.  */
697 698
  Lisp_Object INTERNAL_FIELD (scroll_bar_width);
  Lisp_Object INTERNAL_FIELD (vertical_scroll_bar_type);
699 700 701

  /* Non-nil means indicate lines not displaying text (in a style
     like vi).  */
702
  Lisp_Object INTERNAL_FIELD (indicate_empty_lines);
703

Kenichi Handa's avatar
Kenichi Handa committed
704
  /* Non-nil means indicate buffer boundaries and scrolling.  */
705
  Lisp_Object INTERNAL_FIELD (indicate_buffer_boundaries);
Kenichi Handa's avatar
Kenichi Handa committed
706

707
  /* Logical to physical fringe bitmap mappings.  */
708
  Lisp_Object INTERNAL_FIELD (fringe_indicator_alist);
709 710

  /* Logical to physical cursor bitmap mappings.  */
711
  Lisp_Object INTERNAL_FIELD (fringe_cursor_alist);
712

713
  /* Time stamp updated each time this buffer is displayed in a window.  */
714
  Lisp_Object INTERNAL_FIELD (display_time);
715 716 717 718 719

  /* 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.  */
720
  Lisp_Object INTERNAL_FIELD (scroll_up_aggressively);
721

722 723 724 725
  /* 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.  */
726
  Lisp_Object INTERNAL_FIELD (scroll_down_aggressively);
Gerd Moellmann's avatar
Gerd Moellmann committed
727

728 729
  /* Desired cursor type in this buffer.  See the doc string of
     per-buffer variable `cursor-type'.  */
730
  Lisp_Object INTERNAL_FIELD (cursor_type);
731 732 733

  /* An integer > 0 means put that number of pixels below text lines
     in the display of this buffer.  */
734
  Lisp_Object INTERNAL_FIELD (extra_line_spacing);
735

736
  /* Cursor type to display in non-selected windows.
737 738
     t means to use hollow box cursor.
     See `cursor-type' for other values.  */
739
  Lisp_Object INTERNAL_FIELD (cursor_in_non_selected_windows);
740

741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774
  /* No more Lisp_Object beyond this point.  Except undo_list,
     which is handled specially in Fgarbage_collect .  */

  /* 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.  */
  ptrdiff_t pt;

  /* Byte position of point in buffer.  */
  ptrdiff_t pt_byte;

  /* Char position of beginning of accessible range.  */
  ptrdiff_t begv;

  /* Byte position of beginning of accessible range.  */
  ptrdiff_t begv_byte;

  /* Char position of end of accessible range.  */
  ptrdiff_t zv;

  /* Byte position of end of accessible range.  */
  ptrdiff_t zv_byte;

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

775
  /* In an indirect buffer, this is -1. In an ordinary buffer,
776
     it's the number of indirect buffers that share our text;
777
     zero means that we're the only owner of this text.  */
778
  int indirections;
779

780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860
  /* 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.  */
#define MAX_PER_BUFFER_VARS 50
  char local_flags[MAX_PER_BUFFER_VARS];

  /* Set to the modtime of the visited file when read or written.
     EMACS_NSECS (modtime) == NONEXISTENT_MODTIME_NSECS means
     visited file was nonexistent.  EMACS_NSECS (modtime) ==
     UNKNOWN_MODTIME_NSECS means visited file modtime unknown;
     in no case complain about any mismatch on next save attempt.  */
#define NONEXISTENT_MODTIME_NSECS (-1)
#define UNKNOWN_MODTIME_NSECS (-2)
  EMACS_TIME modtime;

  /* 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.  */
  off_t modtime_size;

  /* The value of text->modiff at the last auto-save.  */
  EMACS_INT auto_save_modified;

  /* The value of text->modiff at the last display error.
     Redisplay of this buffer is inhibited until it changes again.  */
  EMACS_INT display_error_modiff;

  /* The time at which we detected a failure to auto-save,
     Or 0 if we didn't have a failure.  */
  time_t auto_save_failure_time;

  /* Position in buffer at which display started
     the last time this buffer was displayed.  */
  ptrdiff_t last_window_start;

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

  /* Non-zero whenever the narrowing is changed in this buffer.  */
  unsigned clip_changed : 1;

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

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

  /* Changes in the buffer are recorded here for undo, and 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.  */
861
  Lisp_Object INTERNAL_FIELD (undo_list);
862
};
863

864

865 866 867 868 869 870
/* Chain of all buffers, including killed ones.  */

extern struct buffer *all_buffers;

/* Used to iterate over the chain above.  */

871
#define FOR_EACH_BUFFER(b) \
872 873
  for ((b) = all_buffers; (b); (b) = (b)->header.next.buffer)

874
/* This points to the current buffer.  */
Jim Blandy's avatar
Jim Blandy committed
875 876 877 878

extern struct buffer *current_buffer;

/* This structure holds the default values of the buffer-local variables
879
   that have special slots in each buffer.
Jim Blandy's avatar
Jim Blandy committed
880 881 882 883 884 885 886 887 888 889 890 891 892
   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,
893 894
   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
895 896

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

900

Jim Blandy's avatar
Jim Blandy committed
901 902 903 904 905 906 907
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;
908

Jan D's avatar
Jan D committed
909 910
extern void delete_all_overlays (struct buffer *);
extern void reset_buffer (struct buffer *);
Dmitry Antipov's avatar
Dmitry Antipov committed
911
extern int compact_buffer (struct buffer *);
912
extern void evaporate_overlays (ptrdiff_t);
913
extern ptrdiff_t overlays_at (EMACS_INT pos, int extend, Lisp_Object **vec_ptr,
914 915
			      ptrdiff_t *len_ptr, ptrdiff_t *next_ptr,
			      ptrdiff_t *prev_ptr, int change_req);
916
extern ptrdiff_t sort_overlays (Lisp_Object *, ptrdiff_t, struct window *);
917 918
extern void recenter_overlay_lists (struct buffer *, ptrdiff_t);
extern ptrdiff_t overlay_strings (ptrdiff_t, struct window *, unsigned char **);
Jan D's avatar
Jan D committed
919 920 921 922
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 *);
923
extern Lisp_Object buffer_local_value_1 (Lisp_Object, Lisp_Object);
Jan D's avatar
Jan D committed
924
extern void record_buffer (Lisp_Object);