(struct buffer): Remove prompt_end_charpos field.
[bpt/emacs.git] / src / buffer.h
1 /* Header file for the buffer manipulation primitives.
2 Copyright (C) 1985, 86, 93, 94, 95, 97, 1998, 1999 Free Software Foundation, Inc.
3
4 This file is part of GNU Emacs.
5
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
9 any later version.
10
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
20
21
22 /* Accessing the parameters of the current buffer. */
23
24 /* These macros come in pairs, one for the char position
25 and one for the byte position. */
26
27 /* Position of beginning of buffer. */
28 #define BEG (1)
29 #define BEG_BYTE (1)
30
31 /* Position of beginning of accessible range of buffer. */
32 #define BEGV (current_buffer->begv)
33 #define BEGV_BYTE (current_buffer->begv_byte)
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)
39
40 /* Position of gap in buffer. */
41 #define GPT (current_buffer->text->gpt)
42 #define GPT_BYTE (current_buffer->text->gpt_byte)
43
44 /* Position of end of accessible range of buffer. */
45 #define ZV (current_buffer->zv)
46 #define ZV_BYTE (current_buffer->zv_byte)
47
48 /* Position of end of buffer. */
49 #define Z (current_buffer->text->z)
50 #define Z_BYTE (current_buffer->text->z_byte)
51
52 /* Macros for the addresses of places in the buffer. */
53
54 /* Address of beginning of buffer. */
55 #define BEG_ADDR (current_buffer->text->beg)
56
57 /* Address of beginning of accessible range of buffer. */
58 #define BEGV_ADDR (BYTE_POS_ADDR (current_buffer->begv_byte))
59
60 /* Address of point in buffer. */
61 #define PT_ADDR (BYTE_POS_ADDR (current_buffer->pt_byte))
62
63 /* Address of beginning of gap in buffer. */
64 #define GPT_ADDR (current_buffer->text->beg + current_buffer->text->gpt_byte - 1)
65
66 /* Address of end of gap in buffer. */
67 #define GAP_END_ADDR (current_buffer->text->beg + current_buffer->text->gpt_byte + current_buffer->text->gap_size - 1)
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. */
73 #define Z_ADDR (current_buffer->text->beg + current_buffer->text->gap_size + current_buffer->text->z_byte - 1)
74
75 /* Size of gap. */
76 #define GAP_SIZE (current_buffer->text->gap_size)
77
78 /* Is the current buffer narrowed? */
79 #define NARROWED ((BEGV != BEG) || (ZV != Z))
80
81 /* Modification count. */
82 #define MODIFF (current_buffer->text->modiff)
83
84 /* Overlay modification count. */
85 #define OVERLAY_MODIFF (current_buffer->text->overlay_modiff)
86
87 /* Modification count as of last visit or save. */
88 #define SAVE_MODIFF (current_buffer->text->save_modiff)
89
90 /* BUFFER_CEILING_OF (resp. BUFFER_FLOOR_OF), when applied to n, return
91 the max (resp. min) p such that
92
93 BYTE_POS_ADDR (p) - BYTE_POS_ADDR (n) == p - n */
94
95 #define BUFFER_CEILING_OF(BYTEPOS) \
96 (((BYTEPOS) < GPT_BYTE && GPT < ZV ? GPT_BYTE : ZV_BYTE) - 1)
97 #define BUFFER_FLOOR_OF(BYTEPOS) \
98 (BEGV <= GPT && GPT_BYTE <= (BYTEPOS) ? GPT_BYTE : BEGV_BYTE)
99 \f
100 /* Similar macros to operate on a specified buffer.
101 Note that many of these evaluate the buffer argument more than once. */
102
103 /* Position of beginning of buffer. */
104 #define BUF_BEG(buf) (1)
105 #define BUF_BEG_BYTE(buf) (1)
106
107 /* Position of beginning of accessible range of buffer. */
108 #define BUF_BEGV(buf) ((buf)->begv)
109 #define BUF_BEGV_BYTE(buf) ((buf)->begv_byte)
110
111 /* Position of point in buffer. */
112 #define BUF_PT(buf) ((buf)->pt)
113 #define BUF_PT_BYTE(buf) ((buf)->pt_byte)
114
115 /* Position of gap in buffer. */
116 #define BUF_GPT(buf) ((buf)->text->gpt)
117 #define BUF_GPT_BYTE(buf) ((buf)->text->gpt_byte)
118
119 /* Position of end of accessible range of buffer. */
120 #define BUF_ZV(buf) ((buf)->zv)
121 #define BUF_ZV_BYTE(buf) ((buf)->zv_byte)
122
123 /* Position of end of buffer. */
124 #define BUF_Z(buf) ((buf)->text->z)
125 #define BUF_Z_BYTE(buf) ((buf)->text->z_byte)
126
127 /* Address of beginning of buffer. */
128 #define BUF_BEG_ADDR(buf) ((buf)->text->beg)
129
130 /* Address of beginning of gap of buffer. */
131 #define BUF_GPT_ADDR(buf) ((buf)->text->beg + (buf)->text->gpt_byte - 1)
132
133 /* Address of end of buffer. */
134 #define BUF_Z_ADDR(buf) ((buf)->text->beg + (buf)->text->gap_size + (buf)->text->z_byte - 1)
135
136 /* Address of end of gap in buffer. */
137 #define BUF_GAP_END_ADDR(buf) ((buf)->text->beg + (buf)->text->gpt_byte + (buf)->text->gap_size - 1)
138
139 /* Size of gap. */
140 #define BUF_GAP_SIZE(buf) ((buf)->text->gap_size)
141
142 /* Is this buffer narrowed? */
143 #define BUF_NARROWED(buf) ((BUF_BEGV (buf) != BUF_BEG (buf)) \
144 || (BUF_ZV (buf) != BUF_Z (buf)))
145
146 /* Modification count. */
147 #define BUF_MODIFF(buf) ((buf)->text->modiff)
148
149 /* Modification count as of last visit or save. */
150 #define BUF_SAVE_MODIFF(buf) ((buf)->text->save_modiff)
151
152 /* Overlay modification count. */
153 #define BUF_OVERLAY_MODIFF(buf) ((buf)->text->overlay_modiff)
154
155 /* Interval tree of buffer. */
156 #define BUF_INTERVALS(buf) ((buf)->text->intervals)
157
158 /* Marker chain of buffer. */
159 #define BUF_MARKERS(buf) ((buf)->text->markers)
160
161 #define BUF_UNCHANGED_MODIFIED(buf) \
162 ((buf)->text->unchanged_modified)
163
164 #define BUF_OVERLAY_UNCHANGED_MODIFIED(buf) \
165 ((buf)->text->overlay_unchanged_modified)
166 #define BUF_BEG_UNCHANGED(buf) ((buf)->text->beg_unchanged)
167 #define BUF_END_UNCHANGED(buf) ((buf)->text->end_unchanged)
168
169 #define UNCHANGED_MODIFIED \
170 BUF_UNCHANGED_MODIFIED (current_buffer)
171 #define OVERLAY_UNCHANGED_MODIFIED \
172 BUF_OVERLAY_UNCHANGED_MODIFIED (current_buffer)
173 #define BEG_UNCHANGED BUF_BEG_UNCHANGED (current_buffer)
174 #define END_UNCHANGED BUF_END_UNCHANGED (current_buffer)
175
176 /* Compute how many characters at the top and bottom of BUF are
177 unchanged when the range START..END is modified. This computation
178 must be done each time BUF is modified. */
179
180 #define BUF_COMPUTE_UNCHANGED(buf, start, end) \
181 do \
182 { \
183 if (BUF_UNCHANGED_MODIFIED (buf) == MODIFF \
184 && BUF_OVERLAY_UNCHANGED_MODIFIED (buf) == OVERLAY_MODIFF) \
185 { \
186 BUF_BEG_UNCHANGED (buf) = (start) - BUF_BEG (buf); \
187 BUF_END_UNCHANGED (buf) = BUF_Z (buf) - (end); \
188 } \
189 else \
190 { \
191 if (BUF_Z (buf) - (end) < BUF_END_UNCHANGED (buf)) \
192 BUF_END_UNCHANGED (buf) = BUF_Z (buf) - (end); \
193 if ((start) - BUF_BEG (buf) < BUF_BEG_UNCHANGED (buf)) \
194 BUF_BEG_UNCHANGED (buf) = (start) - BUF_BEG (buf); \
195 } \
196 } \
197 while (0)
198
199 \f
200 /* Macros to set PT in the current buffer, or another buffer.. */
201
202 #ifdef USE_TEXT_PROPERTIES
203 #define SET_PT(position) (set_point (current_buffer, (position)))
204 #define TEMP_SET_PT(position) (temp_set_point (current_buffer, (position)))
205
206 #define SET_PT_BOTH(position, byte) \
207 (set_point_both (current_buffer, (position), (byte)))
208 #define TEMP_SET_PT_BOTH(position, byte) \
209 (temp_set_point_both (current_buffer, (position), (byte)))
210
211 #define BUF_SET_PT(buffer, position) \
212 (set_point ((buffer), (position)))
213 #define BUF_TEMP_SET_PT(buffer, position) \
214 (temp_set_point ((buffer), (position)))
215
216 extern void set_point P_ ((struct buffer *, int));
217 extern INLINE void temp_set_point P_ ((struct buffer *, int));
218 extern void set_point_both P_ ((struct buffer *, int, int));
219 extern INLINE void temp_set_point_both P_ ((struct buffer *, int, int));
220
221 #else /* don't support text properties */
222
223 #define SET_PT(position) (current_buffer->pt = (position))
224 #define TEMP_SET_PT(position) (current_buffer->pt = (position))
225
226 #define SET_PT_BOTH(position, byte) \
227 (current_buffer->pt = (position), \
228 current_buffer->pt_byte = (byte))
229
230 #define TEMP_SET_PT_BOTH(position, byte) \
231 (current_buffer->pt = (position), \
232 current_buffer->pt_byte = (byte))
233
234 #define BUF_SET_PT(buffer, position) (buffer->pt = (position))
235 #define BUF_TEMP_SET_PT(buffer, position) (buffer->pt = (position))
236 #endif /* don't support text properties */
237 \f
238 /* Macros for setting the BEGV, ZV or PT of a given buffer.
239
240 SET_BUF_PT* seet to be redundant. Get rid of them?
241
242 The ..._BOTH macros take both a charpos and a bytepos,
243 which must correspond to each other.
244
245 The macros without ..._BOTH take just a charpos,
246 and compute the bytepos from it. */
247
248 #define SET_BUF_BEGV(buf, charpos) \
249 ((buf)->begv_byte = buf_charpos_to_bytepos ((buf), (charpos)), \
250 (buf)->begv = (charpos))
251
252 #define SET_BUF_ZV(buf, charpos) \
253 ((buf)->zv_byte = buf_charpos_to_bytepos ((buf), (charpos)), \
254 (buf)->zv = (charpos))
255
256 #define SET_BUF_BEGV_BOTH(buf, charpos, byte) \
257 ((buf)->begv = (charpos), \
258 (buf)->begv_byte = (byte))
259
260 #define SET_BUF_ZV_BOTH(buf, charpos, byte) \
261 ((buf)->zv = (charpos), \
262 (buf)->zv_byte = (byte))
263
264 #define SET_BUF_PT_BOTH(buf, charpos, byte) \
265 ((buf)->pt = (charpos), \
266 (buf)->pt_byte = (byte))
267 \f
268 /* Macros to access a character or byte in the current buffer,
269 or convert between a byte position and an address.
270 These macros do not check that the position is in range. */
271
272 /* Access a Lisp position value in POS,
273 and store the charpos in CHARPOS and the bypepos in BYPEPOS. */
274
275 #define DECODE_POSITION(charpos, bytepos, pos) \
276 if (1) \
277 { \
278 Lisp_Object __pos = (pos); \
279 if (NUMBERP (__pos)) \
280 { \
281 charpos = __pos; \
282 bytepos = buf_charpos_to_bytepos (current_buffer, __pos); \
283 } \
284 else if (MARKERP (__pos)) \
285 { \
286 charpos = marker_position (__pos); \
287 bytepos = marker_byte_position (__pos); \
288 } \
289 else \
290 wrong_type_argument (Qinteger_or_marker_p, __pos); \
291 } \
292 else
293
294 /* Return the address of byte position N in current buffer. */
295
296 #define BYTE_POS_ADDR(n) \
297 (((n) >= GPT_BYTE ? GAP_SIZE : 0) + (n) + BEG_ADDR - 1)
298
299 /* Return the address of char position N. */
300
301 #define CHAR_POS_ADDR(n) \
302 (((n) >= GPT ? GAP_SIZE : 0) \
303 + buf_charpos_to_bytepos (current_buffer, n) \
304 + BEG_ADDR - 1)
305
306 /* Convert a character position to a byte position. */
307
308 #define CHAR_TO_BYTE(charpos) \
309 (buf_charpos_to_bytepos (current_buffer, charpos))
310
311 /* Convert a byte position to a character position. */
312
313 #define BYTE_TO_CHAR(bytepos) \
314 (buf_bytepos_to_charpos (current_buffer, bytepos))
315
316 /* Convert PTR, the address of a byte in the buffer, into a byte position. */
317
318 #define PTR_BYTE_POS(ptr) \
319 ((ptr) - (current_buffer)->text->beg \
320 - (ptr - (current_buffer)->text->beg < (unsigned) GPT_BYTE ? 0 : GAP_SIZE) \
321 + 1)
322
323 /* Return character at position POS. */
324
325 #define FETCH_CHAR(pos) \
326 (!NILP (current_buffer->enable_multibyte_characters) \
327 ? FETCH_MULTIBYTE_CHAR ((pos)) \
328 : FETCH_BYTE ((pos)))
329
330 /* Return the byte at byte position N. */
331
332 #define FETCH_BYTE(n) *(BYTE_POS_ADDR ((n)))
333
334 /* Variables used locally in FETCH_MULTIBYTE_CHAR. */
335 extern unsigned char *_fetch_multibyte_char_p;
336 extern int _fetch_multibyte_char_len;
337
338 /* Return character code of multi-byte form at position POS. If POS
339 doesn't point the head of valid multi-byte form, only the byte at
340 POS is returned. No range checking. */
341
342 #define FETCH_MULTIBYTE_CHAR(pos) \
343 (_fetch_multibyte_char_p = (((pos) >= GPT_BYTE ? GAP_SIZE : 0) \
344 + (pos) + BEG_ADDR - 1), \
345 _fetch_multibyte_char_len \
346 = ((pos) >= GPT_BYTE ? ZV_BYTE : GPT_BYTE) - (pos), \
347 STRING_CHAR (_fetch_multibyte_char_p, _fetch_multibyte_char_len))
348 \f
349 /* Macros for accessing a character or byte,
350 or converting between byte positions and addresses,
351 in a specified buffer. */
352
353 /* Return the address of character at byte position POS in buffer BUF.
354 Note that both arguments can be computed more than once. */
355
356 #define BUF_BYTE_ADDRESS(buf, pos) \
357 ((buf)->text->beg + (pos) - 1 \
358 + ((pos) >= (buf)->text->gpt_byte ? (buf)->text->gap_size : 0))
359
360 /* Return the address of character at char position POS in buffer BUF.
361 Note that both arguments can be computed more than once. */
362
363 #define BUF_CHAR_ADDRESS(buf, pos) \
364 ((buf)->text->beg + buf_charpos_to_bytepos ((buf), (pos)) - 1 \
365 + ((pos) >= (buf)->text->gpt ? (buf)->text->gap_size : 0))
366
367 /* Convert PTR, the address of a char in buffer BUF,
368 into a character position. */
369
370 #define BUF_PTR_BYTE_POS(buf, ptr) \
371 ((ptr) - (buf)->text->beg \
372 - (ptr - (buf)->text->beg < (unsigned) BUF_GPT_BYTE ((buf)) \
373 ? 0 : BUF_GAP_SIZE ((buf))) \
374 + 1)
375
376 /* Return the character at byte position POS in buffer BUF. */
377
378 #define BUF_FETCH_CHAR(buf, pos) \
379 (!NILP (buf->enable_multibyte_characters) \
380 ? BUF_FETCH_MULTIBYTE_CHAR ((buf), (pos)) \
381 : BUF_FETCH_BYTE ((buf), (pos)))
382
383 /* Return the byte at byte position N in buffer BUF. */
384
385 #define BUF_FETCH_BYTE(buf, n) \
386 *(BUF_BYTE_ADDRESS ((buf), (n)))
387
388 /* Return character code of multi-byte form at byte position POS in BUF.
389 If POS doesn't point the head of valid multi-byte form, only the byte at
390 POS is returned. No range checking. */
391
392 #define BUF_FETCH_MULTIBYTE_CHAR(buf, pos) \
393 (_fetch_multibyte_char_p \
394 = (((pos) >= BUF_GPT_BYTE (buf) ? BUF_GAP_SIZE (buf) : 0) \
395 + (pos) + BUF_BEG_ADDR (buf) - 1), \
396 _fetch_multibyte_char_len \
397 = (((pos) >= BUF_GPT_BYTE (buf) ? BUF_ZV_BYTE (buf) : BUF_GPT_BYTE (buf)) \
398 - (pos)), \
399 STRING_CHAR (_fetch_multibyte_char_p, _fetch_multibyte_char_len))
400 \f
401 /* Define the actual buffer data structures. */
402
403 /* This data structure describes the actual text contents of a buffer.
404 It is shared between indirect buffers and their base buffer. */
405
406 struct buffer_text
407 {
408 unsigned char *beg; /* Actual address of buffer contents. */
409 int gpt; /* Char pos of gap in buffer. */
410 int z; /* Char pos of end of buffer. */
411 int gpt_byte; /* Byte pos of gap in buffer. */
412 int z_byte; /* Byte pos of end of buffer. */
413 int gap_size; /* Size of buffer's gap. */
414 int modiff; /* This counts buffer-modification events
415 for this buffer. It is incremented for
416 each such event, and never otherwise
417 changed. */
418 int save_modiff; /* Previous value of modiff, as of last
419 time buffer visited or saved a file. */
420
421 int overlay_modiff; /* Counts modifications to overlays. */
422
423 /* Minimum value of GPT - BEG since last redisplay that finished. */
424 int beg_unchanged;
425
426 /* Minimum value of Z - GPT since last redisplay that finished. */
427 int end_unchanged;
428
429 /* MODIFF as of last redisplay that finished; if it matches MODIFF,
430 beg_unchanged and end_unchanged contain no useful information. */
431 int unchanged_modified;
432
433 /* BUF_OVERLAY_MODIFF of current buffer, as of last redisplay that
434 finished; if it matches BUF_OVERLAY_MODIFF, beg_unchanged and
435 end_unchanged contain no useful information. */
436 int overlay_unchanged_modified;
437
438 /* Properties of this buffer's text -- conditionally compiled. */
439 DECLARE_INTERVALS
440
441 /* The markers that refer to this buffer.
442 This is actually a single marker ---
443 successive elements in its marker `chain'
444 are the other markers referring to this buffer. */
445 Lisp_Object markers;
446 };
447
448 /* This is the structure that the buffer Lisp object points to. */
449
450 struct buffer
451 {
452 /* Everything before the `name' slot must be of a non-Lisp_Object type,
453 and every slot after `name' must be a Lisp_Object.
454
455 Check out mark_buffer (alloc.c) to see why. */
456
457 EMACS_INT size;
458
459 /* Next buffer, in chain of all buffers including killed buffers.
460 This chain is used only for garbage collection, in order to
461 collect killed buffers properly.
462 Note that vectors and most pseudovectors are all on one chain,
463 but buffers are on a separate chain of their own. */
464 struct buffer *next;
465
466 /* This structure holds the coordinates of the buffer contents
467 in ordinary buffers. In indirect buffers, this is not used. */
468 struct buffer_text own_text;
469
470 /* This points to the `struct buffer_text' that used for this buffer.
471 In an ordinary buffer, this is the own_text field above.
472 In an indirect buffer, this is the own_text field of another buffer. */
473 struct buffer_text *text;
474
475 /* Char position of point in buffer. */
476 int pt;
477 /* Byte position of point in buffer. */
478 int pt_byte;
479 /* Char position of beginning of accessible range. */
480 int begv;
481 /* Byte position of beginning of accessible range. */
482 int begv_byte;
483 /* Char position of end of accessible range. */
484 int zv;
485 /* Byte position of end of accessible range. */
486 int zv_byte;
487
488 /* In an indirect buffer, this points to the base buffer.
489 In an ordinary buffer, it is 0. */
490 struct buffer *base_buffer;
491
492 /* Flags saying which DEFVAR_PER_BUFFER variables
493 are local to this buffer. */
494 int local_var_flags;
495 /* Set to the modtime of the visited file when read or written.
496 -1 means visited file was nonexistent.
497 0 means visited file modtime unknown; in no case complain
498 about any mismatch on next save attempt. */
499 int modtime;
500 /* the value of text->modiff at the last auto-save. */
501 int auto_save_modified;
502 /* The time at which we detected a failure to auto-save,
503 Or -1 if we didn't have a failure. */
504 int auto_save_failure_time;
505 /* Position in buffer at which display started
506 the last time this buffer was displayed. */
507 int last_window_start;
508
509 /* Set nonzero whenever the narrowing is changed in this buffer. */
510 int clip_changed;
511
512 /* If the long line scan cache is enabled (i.e. the buffer-local
513 variable cache-long-line-scans is non-nil), newline_cache
514 points to the newline cache, and width_run_cache points to the
515 width run cache.
516
517 The newline cache records which stretches of the buffer are
518 known *not* to contain newlines, so that they can be skipped
519 quickly when we search for newlines.
520
521 The width run cache records which stretches of the buffer are
522 known to contain characters whose widths are all the same. If
523 the width run cache maps a character to a value > 0, that value is
524 the character's width; if it maps a character to zero, we don't
525 know what its width is. This allows compute_motion to process
526 such regions very quickly, using algebra instead of inspecting
527 each character. See also width_table, below. */
528 struct region_cache *newline_cache;
529 struct region_cache *width_run_cache;
530
531 /* Non-zero means don't use redisplay optimizations for
532 displaying this buffer. */
533 unsigned prevent_redisplay_optimizations_p : 1;
534
535 /* Changes in the buffer are recorded here for undo.
536 t means don't record anything.
537 This information belongs to the base buffer of an indirect buffer,
538 But we can't store it in the struct buffer_text
539 because local variables have to be right in the struct buffer.
540 So we copy it around in set_buffer_internal.
541 This comes before `name' because it is marked in a special way. */
542 Lisp_Object undo_list;
543
544 /* Everything from here down must be a Lisp_Object */
545
546 /* The name of this buffer. */
547 Lisp_Object name;
548
549 /* The name of the file visited in this buffer, or nil. */
550 Lisp_Object filename;
551 /* Dir for expanding relative file names. */
552 Lisp_Object directory;
553 /* True iff this buffer has been backed up (if you write to the
554 visited file and it hasn't been backed up, then a backup will
555 be made). */
556 /* This isn't really used by the C code, so could be deleted. */
557 Lisp_Object backed_up;
558 /* Length of file when last read or saved.
559 This is not in the struct buffer_text
560 because it's not used in indirect buffers at all. */
561 Lisp_Object save_length;
562 /* File name used for auto-saving this buffer.
563 This is not in the struct buffer_text
564 because it's not used in indirect buffers at all. */
565 Lisp_Object auto_save_file_name;
566
567 /* Non-nil if buffer read-only. */
568 Lisp_Object read_only;
569 /* "The mark". This is a marker which may
570 point into this buffer or may point nowhere. */
571 Lisp_Object mark;
572
573 /* Alist of elements (SYMBOL . VALUE-IN-THIS-BUFFER)
574 for all per-buffer variables of this buffer. */
575 Lisp_Object local_var_alist;
576
577 /* Symbol naming major mode (eg, lisp-mode). */
578 Lisp_Object major_mode;
579 /* Pretty name of major mode (eg, "Lisp"). */
580 Lisp_Object mode_name;
581 /* Mode line element that controls format of mode line. */
582 Lisp_Object mode_line_format;
583
584 /* Analogous to mode_line_format for the line displayed at the top
585 of windows. Nil means don't display that line. */
586 Lisp_Object header_line_format;
587
588 /* Keys that are bound local to this buffer. */
589 Lisp_Object keymap;
590 /* This buffer's local abbrev table. */
591 Lisp_Object abbrev_table;
592 /* This buffer's syntax table. */
593 Lisp_Object syntax_table;
594 /* This buffer's category table. */
595 Lisp_Object category_table;
596
597 /* Values of several buffer-local variables */
598 /* tab-width is buffer-local so that redisplay can find it
599 in buffers that are not current */
600 Lisp_Object case_fold_search;
601 Lisp_Object tab_width;
602 Lisp_Object fill_column;
603 Lisp_Object left_margin;
604 /* Function to call when insert space past fill column. */
605 Lisp_Object auto_fill_function;
606 /* nil: text, t: binary.
607 This value is meaningful only on certain operating systems. */
608 /* Actually, we don't need this flag any more because end-of-line
609 is handled correctly according to the buffer-file-coding-system
610 of the buffer. Just keeping it for backward compatibility. */
611 Lisp_Object buffer_file_type;
612
613 /* Case table for case-conversion in this buffer.
614 This char-table maps each char into its lower-case version. */
615 Lisp_Object downcase_table;
616 /* Char-table mapping each char to its upper-case version. */
617 Lisp_Object upcase_table;
618 /* Char-table for conversion for case-folding search. */
619 Lisp_Object case_canon_table;
620 /* Char-table of equivalences for case-folding search. */
621 Lisp_Object case_eqv_table;
622
623 /* Non-nil means do not display continuation lines. */
624 Lisp_Object truncate_lines;
625 /* Non-nil means display ctl chars with uparrow. */
626 Lisp_Object ctl_arrow;
627 /* Non-nil means display text from right to left. */
628 Lisp_Object direction_reversed;
629 /* Non-nil means do selective display;
630 see doc string in syms_of_buffer (buffer.c) for details. */
631 Lisp_Object selective_display;
632 #ifndef old
633 /* Non-nil means show ... at end of line followed by invisible lines. */
634 Lisp_Object selective_display_ellipses;
635 #endif
636 /* Alist of (FUNCTION . STRING) for each minor mode enabled in buffer. */
637 Lisp_Object minor_modes;
638 /* t if "self-insertion" should overwrite; `binary' if it should also
639 overwrite newlines and tabs - for editing executables and the like. */
640 Lisp_Object overwrite_mode;
641 /* non-nil means abbrev mode is on. Expand abbrevs automatically. */
642 Lisp_Object abbrev_mode;
643 /* Display table to use for text in this buffer. */
644 Lisp_Object display_table;
645 /* t means the mark and region are currently active. */
646 Lisp_Object mark_active;
647
648 /* List of overlays that end at or before the current center,
649 in order of end-position. */
650 Lisp_Object overlays_before;
651
652 /* List of overlays that end after the current center,
653 in order of start-position. */
654 Lisp_Object overlays_after;
655
656 /* Position where the overlay lists are centered. */
657 Lisp_Object overlay_center;
658
659 /* Non-nil means the buffer contents are regarded as multi-byte
660 form of characters, not a binary code. */
661 Lisp_Object enable_multibyte_characters;
662
663 /* Coding system to be used for encoding the buffer contents on
664 saving. */
665 Lisp_Object buffer_file_coding_system;
666
667 /* List of symbols naming the file format used for visited file. */
668 Lisp_Object file_format;
669
670 /* True if the newline position cache and width run cache are
671 enabled. See search.c and indent.c. */
672 Lisp_Object cache_long_line_scans;
673
674 /* If the width run cache is enabled, this table contains the
675 character widths width_run_cache (see above) assumes. When we
676 do a thorough redisplay, we compare this against the buffer's
677 current display table to see whether the display table has
678 affected the widths of any characters. If it has, we
679 invalidate the width run cache, and re-initialize width_table. */
680 Lisp_Object width_table;
681
682 /* In an indirect buffer, or a buffer that is the base of an
683 indirect buffer, this holds a marker that records
684 PT for this buffer when the buffer is not current. */
685 Lisp_Object pt_marker;
686
687 /* In an indirect buffer, or a buffer that is the base of an
688 indirect buffer, this holds a marker that records
689 BEGV for this buffer when the buffer is not current. */
690 Lisp_Object begv_marker;
691
692 /* In an indirect buffer, or a buffer that is the base of an
693 indirect buffer, this holds a marker that records
694 ZV for this buffer when the buffer is not current. */
695 Lisp_Object zv_marker;
696
697 /* This holds the point value before the last scroll operation.
698 Explicitly setting point sets this to nil. */
699 Lisp_Object point_before_scroll;
700
701 /* Truename of the visited file, or nil. */
702 Lisp_Object file_truename;
703
704 /* Invisibility spec of this buffer.
705 t => any non-nil `invisible' property means invisible.
706 A list => `invisible' property means invisible
707 if it is memq in that list. */
708 Lisp_Object invisibility_spec;
709
710 /* This is the last window that was selected with this buffer in it,
711 or nil if that window no longer displays this buffer. */
712 Lisp_Object last_selected_window;
713
714 /* Incremented each time the buffer is displayed in a window. */
715 Lisp_Object display_count;
716
717 /* Widths of left and right marginal areas for windows displaying
718 this buffer. */
719 Lisp_Object left_margin_width, right_margin_width;
720
721 /* Non-nil means indicate lines not displaying text (in a style
722 like vi). */
723 Lisp_Object indicate_empty_lines;
724
725 /* Time stamp updated each time this buffer is displayed in a window. */
726 Lisp_Object display_time;
727
728 /* If scrolling the display because point is below the bottom of a
729 window showing this buffer, try to choose a window start so
730 that point ends up this number of lines from the top of the
731 window. Nil means that scrolling method isn't used. */
732 Lisp_Object scroll_up_aggressively;
733
734 /* If scrolling the display because point is above the top of a
735 window showing this buffer, try to choose a window start so
736 that point ends up this number of lines from the bottom of the
737 window. Nil means that scrolling method isn't used. */
738 Lisp_Object scroll_down_aggressively;
739
740 /* These are so we don't have to recompile everything
741 the next few times we add a new slot. */
742 Lisp_Object extra2, extra3;
743 };
744 \f
745 /* This points to the current buffer. */
746
747 extern struct buffer *current_buffer;
748
749 /* This structure holds the default values of the buffer-local variables
750 that have special slots in each buffer.
751 The default value occupies the same slot in this structure
752 as an individual buffer's value occupies in that buffer.
753 Setting the default value also goes through the alist of buffers
754 and stores into each buffer that does not say it has a local value. */
755
756 extern struct buffer buffer_defaults;
757
758 /* This structure marks which slots in a buffer have corresponding
759 default values in buffer_defaults.
760 Each such slot has a nonzero value in this structure.
761 The value has only one nonzero bit.
762
763 When a buffer has its own local value for a slot,
764 the bit for that slot (found in the same slot in this structure)
765 is turned on in the buffer's local_var_flags slot.
766
767 If a slot in this structure is zero, then even though there may
768 be a Lisp-level local variable for the slot, it has no default value,
769 and the corresponding slot in buffer_defaults is not used. */
770
771 extern struct buffer buffer_local_flags;
772
773 /* For each buffer slot, this points to the Lisp symbol name
774 for that slot in the current buffer. It is 0 for slots
775 that don't have such names. */
776
777 extern struct buffer buffer_local_symbols;
778
779 /* This structure holds the required types for the values in the
780 buffer-local slots. If a slot contains Qnil, then the
781 corresponding buffer slot may contain a value of any type. If a
782 slot contains an integer, then prospective values' tags must be
783 equal to that integer (except nil is always allowed).
784 When a tag does not match, the function
785 buffer_slot_type_mismatch will signal an error.
786
787 If a slot here contains -1, the corresponding variable is read-only. */
788
789 extern struct buffer buffer_local_types;
790 \f
791 extern void reset_buffer P_ ((struct buffer *));
792 extern void evaporate_overlays P_ ((int));
793 extern int overlays_at P_ ((int, int, Lisp_Object **, int *, int *, int *));
794 extern int sort_overlays P_ ((Lisp_Object *, int, struct window *));
795 extern void recenter_overlay_lists P_ ((struct buffer *, int));
796 extern int overlay_strings P_ ((int, struct window *, unsigned char **));
797 extern void validate_region P_ ((Lisp_Object *, Lisp_Object *));
798 extern void set_buffer_internal P_ ((struct buffer *));
799 extern void set_buffer_internal_1 P_ ((struct buffer *));
800 extern void set_buffer_temp P_ ((struct buffer *));
801 extern void record_buffer P_ ((Lisp_Object));
802 extern void buffer_slot_type_mismatch P_ ((int));
803 extern void fix_overlays_before P_ ((struct buffer *, int, int));
804
805
806 EXFUN (Fbuffer_name, 1);
807 EXFUN (Fget_file_buffer, 1);
808 EXFUN (Fnext_overlay_change, 1);
809 EXFUN (Fdelete_overlay, 1);
810
811 /* Functions to call before and after each text change. */
812 extern Lisp_Object Vbefore_change_function;
813 extern Lisp_Object Vafter_change_function;
814 extern Lisp_Object Vbefore_change_functions;
815 extern Lisp_Object Vafter_change_functions;
816 extern Lisp_Object Vfirst_change_hook;
817 extern Lisp_Object Qbefore_change_functions;
818 extern Lisp_Object Qafter_change_functions;
819 extern Lisp_Object Qfirst_change_hook;
820
821 /* If nonzero, all modification hooks are suppressed. */
822 extern int inhibit_modification_hooks;
823
824 extern Lisp_Object Vdeactivate_mark;
825 extern Lisp_Object Vtransient_mark_mode;
826 \f
827 /* Overlays */
828
829 /* 1 if the OV is an overlay object. */
830 #define OVERLAY_VALID(OV) (OVERLAYP (OV))
831
832 /* Return the marker that stands for where OV starts in the buffer. */
833 #define OVERLAY_START(OV) (XOVERLAY (OV)->start)
834
835 /* Return the marker that stands for where OV ends in the buffer. */
836 #define OVERLAY_END(OV) (XOVERLAY (OV)->end)
837
838 /* Return the actual buffer position for the marker P.
839 We assume you know which buffer it's pointing into. */
840
841 #define OVERLAY_POSITION(P) \
842 (GC_MARKERP (P) ? marker_position (P) : (abort (), 0))
843
844 /* Allocation of buffer text. */
845
846 #ifdef REL_ALLOC
847
848 extern char *r_alloc P_ ((char **, unsigned long));
849 extern void r_alloc_free P_ ((char **ptr));
850 extern char *r_re_alloc P_ ((char **, unsigned long));
851
852 #define BUFFER_ALLOC(data,size) \
853 ((unsigned char *) r_alloc ((char **)&data, (size)))
854 #define BUFFER_REALLOC(data,size) \
855 ((unsigned char *) r_re_alloc ((char **) &data, (size)))
856 #define BUFFER_FREE(data) (r_alloc_free ((char **) &data))
857 #define R_ALLOC_DECLARE(var,data) (r_alloc_declare (&var, (data)))
858 #else
859 #define BUFFER_ALLOC(data,size) (data = (unsigned char *) malloc ((size)))
860 #define BUFFER_REALLOC(data,size) ((unsigned char *) realloc ((data), (size)))
861 #define BUFFER_FREE(data) (free ((data)))
862 #define R_ALLOC_DECLARE(var,data)
863 #endif
864