1 /* Interface definitions for display code.
2 Copyright (C) 1985, 1993, 1994, 1997, 1998, 1999
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 /* New redisplay written by Gerd Moellmann <gerd@acm.org>. */
24 #ifndef DISPEXTERN_H_INCLUDED
25 #define DISPEXTERN_H_INCLUDED
40 /* Structure forward declarations. Some are here because function
41 prototypes below reference structure types before their definition
42 in this file. Some are here because not every file including
43 dispextern.h also includes frame.h and windows.h. */
54 /***********************************************************************
56 ***********************************************************************/
58 /* If NO_PROMPT_IN_BUFFER is zero or undefined (default), prompts are
59 inserted into minibuffers as read-only text. Otherwise, the
60 behavior of Emacs 20.2 is restored. Define this as part of CFLAGS
61 because dispextern.h is not included in every C source file
62 containing conditional code for it. */
65 #define NO_PROMPT_IN_BUFFER 1
70 /***********************************************************************
72 ***********************************************************************/
74 /* If GLYPH_DEBUG is non-zero, additional checks are activated. Turn
75 it off by defining the macro GLYPH_DEBUG to zero. */
81 /* Macros to include code only if GLYPH_DEBUG != 0. */
85 #define xassert(X) if (!(X)) abort (); else (void) 0
87 #define IF_DEBUG(X) (void) 0
88 #define xassert(X) (void) 0
91 /* Macro for displaying traces of redisplay. If Emacs was compiled
92 with GLYPH_DEBUG != 0, the variable trace_redisplay_p can be set to
93 a non-zero value in debugging sessions to activate traces. */
97 extern int trace_redisplay_p
;
101 if (trace_redisplay_p) \
106 #else /* GLYPH_DEBUG == 0 */
108 #define TRACE(X) (void) 0
110 #endif /* GLYPH_DEBUG == 0 */
114 /***********************************************************************
116 ***********************************************************************/
118 /* Starting with Emacs 20.3, characters from strings and buffers have
119 both a character and a byte position associated with them. The
120 following structure holds such a pair of positions. */
124 /* Character position. */
127 /* Corresponding byte position. */
131 /* Access character and byte position of POS in a functional form. */
133 #define BYTEPOS(POS) (POS).bytepos
134 #define CHARPOS(POS) (POS).charpos
136 /* Set character position of POS to CHARPOS, byte position to BYTEPOS. */
138 #define SET_TEXT_POS(POS, CHARPOS, BYTEPOS) \
139 ((POS).charpos = (CHARPOS), (POS).bytepos = BYTEPOS)
141 /* Increment text position POS. */
143 #define INC_TEXT_POS(POS) \
147 INC_POS ((POS).bytepos); \
151 /* Decrement text position POS. */
153 #define DEC_TEXT_POS(POS) \
157 DEC_POS ((POS).bytepos); \
161 /* Set text position POS from marker MARKER. */
163 #define SET_TEXT_POS_FROM_MARKER(POS, MARKER) \
164 (CHARPOS (POS) = marker_position ((MARKER)), \
165 BYTEPOS (POS) = marker_byte_position ((MARKER)))
167 /* Set marker MARKER from text position POS. */
169 #define SET_MARKER_FROM_TEXT_POS(MARKER, POS) \
170 set_marker_both ((MARKER), Qnil, CHARPOS ((POS)), BYTEPOS ((POS)))
172 /* Value is non-zero if character and byte positions of POS1 and POS2
175 #define TEXT_POS_EQUAL_P(POS1, POS2) \
176 ((POS1).charpos == (POS2).charpos \
177 && (POS1).bytepos == (POS2).bytepos)
179 /* When rendering glyphs, redisplay scans string or buffer text,
180 overlay strings in that text, and does display table or control
181 character translations. The following structure captures a
182 position taking all this into account. */
186 /* Buffer or string position. */
189 /* If this is a position in an overlay string, overlay_string_index
190 is the index of that overlay string in the sequence of overlay
191 strings at `pos' in the order redisplay processes them. A value
192 < 0 means that this is not a position in an overlay string. */
193 int overlay_string_index
;
195 /* If this is a position in an overlay string, string_pos is the
196 position within that string. */
197 struct text_pos string_pos
;
199 /* If the character at the position above is a control character or
200 has a display table entry, dpvec_index is an index in the display
201 table or control character translation of that character. A
202 value < 0 means this is not a position in such a translation. */
208 /***********************************************************************
210 ***********************************************************************/
212 /* Enumeration of glyph types. Glyph structures contain a type field
213 containing one of the enumerators defined here. */
217 /* Glyph describes a character. */
220 /* Glyph describes an image. */
223 /* Glyph is a space of fractional width and/or height. */
232 /* Position from which this glyph was drawn. If `object' below is a
233 Lisp string, this is a position in that string. If it is a
234 buffer, this is a position in that buffer. A value of -1
235 together with a null object means glyph is a truncation glyph at
236 the start of a row. */
239 /* Lisp object source of this glyph. Currently either a buffer or
243 /* Width in pixels. */
246 /* Vertical offset. If < 0, the glyph is displayed raised, if > 0
247 the glyph is displayed lowered. */
250 /* Which kind of glyph this is---character, image etc. Value
251 should be an enumerator of type enum glyph_type. */
254 /* 1 means this glyph was produced from multibyte text. Zero
255 means it was produced from unibyte text, i.e. charsets aren't
256 applicable, and encoding is not performed. */
257 unsigned multibyte_p
: 1;
259 /* Non-zero means draw a box line at the left or right side of this
260 glyph. This is part of the implementation of the face attribute
262 unsigned left_box_line_p
: 1;
263 unsigned right_box_line_p
: 1;
265 /* Non-zero means this glyph's physical ascent or descent is greater
266 than its logical ascent/descent, i.e. it may potentially overlap
267 glyphs above or below it. */
268 unsigned overlaps_vertically_p
: 1;
270 /* A union of sub-structures for different glyph types. */
273 /* Sub-structure for character glyphs (type == CHAR_GLYPH). */
276 /* Character code. */
279 /* Character's face. */
280 unsigned face_id
: 11;
282 /* 1 means glyph is a padding glyph. Padding glyphs are used
283 for characters whose visual shape consists of more than one
284 glyph (e.g. Asian characters). All but the first glyph of
285 such a glyph sequence have the padding_p flag set. Only used
286 for terminal frames, and there only to minimize code changes.
287 A better way would probably be to use the width field of
288 glyphs to express padding. */
289 unsigned padding_p
: 1;
293 /* Sub-structure for image glyphs (type == IMAGE_GLYPH). */
299 /* Face under the image. */
300 unsigned face_id
: 12;
304 /* Sub-structure for type == STRETCH_GLYPH. */
307 /* The height of the glyph. */
308 unsigned height
: 11;
310 /* The ascent of the glyph. */
311 unsigned ascent
: 10;
313 /* The face of the stretch glyph. */
314 unsigned face_id
: 11;
318 /* Used to compare all bit-fields above in one step. */
324 /* Is GLYPH a space? */
326 #define CHAR_GLYPH_SPACE_P(GLYPH) \
327 (GLYPH_FROM_CHAR_GLYPH ((GLYPH)) == SPACEGLYPH)
329 /* Are glyphs *X and *Y equal? */
331 #define GLYPH_EQUAL_P(X, Y) \
332 ((X)->type == (Y)->type \
333 && (X)->u.val == (Y)->u.val \
334 && (X)->left_box_line_p == (Y)->left_box_line_p \
335 && (X)->right_box_line_p == (Y)->right_box_line_p \
336 && (X)->voffset == (Y)->voffset)
338 /* Fill a character glyph GLYPH. CODE, FACE_ID, PADDING_P correspond
339 to the bits defined for the typedef `GLYPH' in lisp.h. */
341 #define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P) \
344 (GLYPH).u.ch.code = (CODE); \
345 (GLYPH).u.ch.face_id = (FACE_ID); \
346 (GLYPH).u.ch.padding_p = (PADDING_P); \
350 /* Fill a character type glyph GLYPH from a glyph typedef FROM as
351 defined in lisp.h. */
353 #define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM) \
354 SET_CHAR_GLYPH ((GLYPH), \
355 FAST_GLYPH_CHAR ((FROM)), \
356 FAST_GLYPH_FACE ((FROM)), \
357 ((FROM) & GLYPH_MASK_PADDING) != 0)
359 /* Construct a typedef'd GLYPH value from a character glyph GLYPH. */
361 #define GLYPH_FROM_CHAR_GLYPH(GLYPH) \
363 | ((GLYPH).u.ch.face_id << CHARACTERBITS) \
364 | ((GLYPH).u.ch.padding_p ? GLYPH_MASK_PADDING : 0))
366 /* Is GLYPH a padding glyph? */
368 #define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).u.ch.padding_p
373 /***********************************************************************
375 ***********************************************************************/
379 Glyph memory for frame-based redisplay is allocated from the heap
380 in one vector kept in a glyph pool structure which is stored with
381 the frame. The size of the vector is made large enough to cover
382 all windows on the frame.
384 Both frame and window glyph matrices reference memory from a glyph
385 pool in frame-based redisplay.
387 In window-based redisplay, no glyphs pools exist; windows allocate
388 and free their glyph memory themselves. */
392 /* Vector of glyphs allocated from the heap. */
393 struct glyph
*glyphs
;
395 /* Allocated size of `glyphs'. */
398 /* Number of rows and columns in a matrix. */
404 /***********************************************************************
406 ***********************************************************************/
410 Three kinds of glyph matrices exist:
412 1. Frame glyph matrices. These are used for terminal frames whose
413 redisplay needs a view of the whole screen due to limited terminal
414 capabilities. Frame matrices are used only in the update phase
415 of redisplay. They are built in update_frame and not used after
416 the update has been performed.
418 2. Window glyph matrices on frames having frame glyph matrices.
419 Such matrices are sub-matrices of their corresponding frame matrix,
420 i.e. frame glyph matrices and window glyph matrices share the same
421 glyph memory which is allocated in form of a glyph_pool structure.
422 Glyph rows in such a window matrix are slices of frame matrix rows.
424 2. Free-standing window glyph matrices managing their own glyph
425 storage. This form is used in window-based redisplay which
426 includes variable width and height fonts etc.
428 The size of a window's row vector depends on the height of fonts
429 defined on its frame. It is chosen so that the vector is large
430 enough to describe all lines in a window when it is displayed in
431 the smallest possible character size. When new fonts are loaded,
432 or window sizes change, the row vector is adjusted accordingly. */
436 /* The pool from which glyph memory is allocated, if any. This is
437 null for frame matrices and for window matrices managing their
439 struct glyph_pool
*pool
;
441 /* Vector of glyph row structures. The row at nrows - 1 is reserved
442 for the mode line. */
443 struct glyph_row
*rows
;
445 /* Number of elements allocated for the vector rows above. */
448 /* The number of rows used by the window if all lines were displayed
449 with the smallest possible character height. */
452 /* Origin within the frame matrix if this is a window matrix on a
453 frame having a frame matrix. Both values are zero for
454 window-based redisplay. */
455 int matrix_x
, matrix_y
;
457 /* Width and height of the matrix in columns and rows. */
458 int matrix_w
, matrix_h
;
460 /* If this structure describes a window matrix, window_top_y is the
461 top-most y-position and window_height is the height of the
462 window, and window_vscroll is the vscroll at the time the matrix
463 was last adjusted. Only set for window-based redisplay. */
464 int window_top_y
, window_height
, window_width
, window_vscroll
;
466 /* Number of glyphs reserved for left and right marginal areas when
467 the matrix was last adjusted. */
468 int left_margin_glyphs
, right_margin_glyphs
;
470 /* Flag indicating that scrolling should not be tried in
471 update_window. This flag is set by functions like try_window_id
472 which do their own scrolling. */
473 unsigned no_scrolling_p
: 1;
475 /* Non-zero means window displayed in this matrix has a top mode
477 unsigned top_line_p
: 1;
480 /* A string identifying the method used to display the matrix. */
486 /* Check that glyph pointers stored in glyph rows of MATRIX are okay.
487 This aborts if any pointer is found twice. */
490 void check_matrix_pointer_lossage
P_ ((struct glyph_matrix
*));
491 #define CHECK_MATRIX(MATRIX) check_matrix_pointer_lossage ((MATRIX))
493 #define CHECK_MATRIX(MATRIX) (void) 0
498 /***********************************************************************
500 ***********************************************************************/
502 /* Area in window glyph matrix. If values are added or removed, the
503 function mark_object in alloc.c has to be changed. */
514 /* Rows of glyphs in a windows or frame glyph matrix.
516 Each row is partitioned into three areas. The start and end of
517 each area is recorded in a pointer as shown below.
519 +--------------------+-------------+---------------------+
520 | left margin area | text area | right margin area |
521 +--------------------+-------------+---------------------+
523 glyphs[LEFT_MARGIN_AREA] glyphs[RIGHT_MARGIN_AREA]
528 Rows in frame matrices reference glyph memory allocated in a frame
529 glyph pool (see the description of struct glyph_pool). Rows in
530 window matrices on frames having frame matrices reference slices of
531 the glyphs of corresponding rows in the frame matrix.
533 Rows in window matrices on frames having no frame matrices point to
534 glyphs allocated from the heap via xmalloc;
535 glyphs[LEFT_MARGIN_AREA] is the start address of the allocated
536 glyph structure array. */
540 /* Pointers to beginnings of areas. The end of an area A is found at
541 A + 1 in the vector. The last element of the vector is the end
544 Kludge alert: Even if used[TEXT_AREA] == 0, glyphs[TEXT_AREA][0]'s
545 position field is used. It is -1 if this row does not correspond
546 to any text; it is some buffer position if the row corresponds to
547 an empty display line that displays a line end. This is what old
548 redisplay used to do. (Except in code for terminal frames, this
549 kludge is no longer use, I believe. --gerd).
551 See also start, end, displays_text_p and ends_at_zv_p for cleaner
552 ways to do it. The special meaning of positions 0 and -1 will be
553 removed some day, so don't use it in new code. */
554 struct glyph
*glyphs
[1 + LAST_AREA
];
556 /* Number of glyphs actually filled in areas. */
557 short used
[LAST_AREA
];
559 /* Window-relative x and y-position of the top-left corner of this
560 row. If y < 0, this means that abs (y) pixels of the row are
561 invisible because it is partially visible at the top of a window.
562 If x < 0, this means that abs (x) pixels of the first glyph of
563 the text area of the row are invisible because the glyph is
564 partially visible. */
567 /* Width of the row in pixels without taking face extension at the
568 end of the row into account. */
571 /* Logical ascent/height of this line. The value of ascent is zero
572 and height is 1 on terminal frames. */
575 /* Physical ascent/height of this line. If max_ascent > ascent,
576 this line overlaps the line above it on the display. Otherwise,
577 if max_height > height, this line overlaps the line beneath it. */
578 int phys_ascent
, phys_height
;
580 /* Portion of row that is visible. Partially visible rows may be
581 found at the top and bottom of a window. This is 1 for tty
582 frames. It may be < 0 in case of completely invisible rows. */
585 /* Hash code. This hash code is available as soon as the row
586 is constructed, i.e. after a call to display_line. */
589 /* First position in this row. This is the text position, including
590 overlay position information etc, where the display of this row
591 started, and can thus be less the position of the first glyph
592 (e.g. due to invisible text or horizontal scrolling). */
593 struct display_pos start
;
595 /* Text position at the end of this row. This is the position after
596 the last glyph on this row. It can be greater than the last
597 glyph position + 1, due to truncation, invisible text etc. In an
598 up-to-date display, this should always be equal to the start
599 position of the next row. */
600 struct display_pos end
;
602 /* In a desired matrix, 1 means that this row must be updated. In a
603 current matrix, 0 means that the row has been invalidated, i.e.
604 the row's contents do not agree with what is visible on the
606 unsigned enabled_p
: 1;
608 /* Display this line in inverse video? Used for the mode line and
610 unsigned inverse_p
: 1;
612 /* 1 means row displays a text line that is truncated on the left or
614 unsigned truncated_on_left_p
: 1;
615 unsigned truncated_on_right_p
: 1;
617 /* 1 means the overlay arrow is on this line. */
618 unsigned overlay_arrow_p
: 1;
620 /* 1 means that this row displays a continued line, i.e. it has a
621 continuation mark at the right side. */
622 unsigned continued_p
: 1;
624 /* 0 means that this row does not contain any text, i.e. it is
625 a blank line at the window and buffer end. */
626 unsigned displays_text_p
: 1;
628 /* 1 means that this line ends at ZV. */
629 unsigned ends_at_zv_p
: 1;
631 /* 1 means the face of the last glyph in the text area is drawn to
632 the right end of the window. This flag is used in
633 update_text_area to optimize clearing to the end of the area. */
634 unsigned fill_line_p
: 1;
636 /* Non-zero means display a bitmap on X frames indicating that this
637 line contains no text and ends in ZV. */
638 unsigned indicate_empty_line_p
: 1;
640 /* 1 means this row contains glyphs that overlap each other because
641 of lbearing or rbearing. */
642 unsigned contains_overlapping_glyphs_p
: 1;
644 /* 1 means this row is a wide as the window it is displayed in, including
645 scroll bars, bitmap areas, and internal borders. This also
646 implies that the row doesn't have marginal areas. */
647 unsigned full_width_p
: 1;
649 /* Non-zero means row is a mode or top-line. */
650 unsigned mode_line_p
: 1;
652 /* 1 in a current row means this row is overlapped by another row. */
653 unsigned overlapped_p
: 1;
655 /* 1 in a current row means this row overlaps others. */
656 unsigned overlapping_p
: 1;
658 /* Continuation lines width at the start of the row. */
659 int continuation_lines_width
;
663 /* Get a pointer to row number ROW in matrix MATRIX. If GLYPH_DEBUG
664 is defined to a non-zero value, the function matrix_row checks that
665 we don't try to access rows that are out of bounds. */
668 struct glyph_row
*matrix_row
P_ ((struct glyph_matrix
*, int));
669 #define MATRIX_ROW(MATRIX, ROW) matrix_row ((MATRIX), (ROW))
671 #define MATRIX_ROW(MATRIX, ROW) ((MATRIX)->rows + (ROW))
674 /* Return a pointer to the row reserved for the mode line in MATRIX.
675 Row MATRIX->nrows - 1 is always reserved for the mode line. */
677 #define MATRIX_MODE_LINE_ROW(MATRIX) \
678 ((MATRIX)->rows + (MATRIX)->nrows - 1)
680 /* Return a pointer to the row reserved for the top line in MATRIX.
681 This is always the first row in MATRIX because that's the only
682 way that works in frame-based redisplay. */
684 #define MATRIX_TOP_LINE_ROW(MATRIX) (MATRIX)->rows
686 /* Return a pointer to first row in MATRIX used for text display. */
688 #define MATRIX_FIRST_TEXT_ROW(MATRIX) \
689 ((MATRIX)->rows->mode_line_p ? (MATRIX)->rows + 1 : (MATRIX)->rows)
691 /* Return a pointer to the first glyph in the text area of a row.
692 MATRIX is the glyph matrix accessed, and ROW is the row index in
695 #define MATRIX_ROW_GLYPH_START(MATRIX, ROW) \
696 (MATRIX_ROW ((MATRIX), (ROW))->glyphs[TEXT_AREA])
698 /* Return the number of used glyphs in the text area of a row. */
700 #define MATRIX_ROW_USED(MATRIX, ROW) \
701 (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA])
703 /* Return the character/ byte position at which the display of ROW
706 #define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->start.pos.charpos)
707 #define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->start.pos.bytepos)
709 /* Return character/ byte position at which ROW ends. */
711 #define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->end.pos.charpos)
712 #define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->end.pos.bytepos)
714 /* Return the vertical position of ROW in MATRIX. */
716 #define MATRIX_ROW_VPOS(ROW, MATRIX) ((ROW) - (MATRIX)->rows)
718 /* Return the last glyph row + 1 in MATRIX on window W reserved for
719 text. If W has a mode line, the last row in the matrix is reserved
722 #define MATRIX_BOTTOM_TEXT_ROW(MATRIX, W) \
725 - (WINDOW_WANTS_MODELINE_P ((W)) ? 1 : 0))
727 /* Non-zero if the face of the last glyph in ROW's text area has
728 to be drawn to the end of the text area. */
730 #define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)
732 /* Set and query the enabled_p flag of glyph row ROW in MATRIX. */
734 #define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
735 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0)
737 #define MATRIX_ROW_ENABLED_P(MATRIX, ROW) \
738 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p)
740 /* Non-zero if ROW displays text. Value is non-zero if the row is
741 blank but displays a line end. */
743 #define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)
745 /* Non-zero if ROW is not completely visible in window W. */
747 #define MATRIX_ROW_PARTIALLY_VISIBLE_P(ROW) \
748 ((ROW)->height != (ROW)->visible_height)
750 /* Non-zero if ROW is partially visible at the top of window W. */
752 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW) \
753 (MATRIX_ROW_PARTIALLY_VISIBLE_P ((ROW)) \
754 && (ROW)->y < WINDOW_DISPLAY_TOP_LINE_HEIGHT ((W)))
756 /* Non-zero if ROW is partially visible at the bottom of window W. */
758 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW) \
759 (MATRIX_ROW_PARTIALLY_VISIBLE_P ((ROW)) \
760 && (ROW)->y + (ROW)->height > WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE ((W)))
762 /* Return the bottom Y + 1 of ROW. */
764 #define MATRIX_ROW_BOTTOM_Y(ROW) ((ROW)->y + (ROW)->height)
766 /* Is ROW the last visible one in the display described by the
767 iterator structure pointed to by IT?. */
769 #define MATRIX_ROW_LAST_VISIBLE_P(ROW, IT) \
770 (MATRIX_ROW_BOTTOM_Y ((ROW)) >= (IT)->last_visible_y)
772 /* Non-zero if ROW displays a continuation line. */
774 #define MATRIX_ROW_CONTINUATION_LINE_P(ROW) \
775 ((ROW)->continuation_lines_width > 0)
777 /* Non-zero if ROW ends in the middle of a character. This is the
778 case for continued lines showing only part of a display table entry
779 or a control char, or an overlay string. */
781 #define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW) \
782 ((ROW)->end.dpvec_index >= 0 \
783 || (ROW)->end.overlay_string_index >= 0)
785 /* Non-zero if ROW ends in the middle of an overlay string. */
787 #define MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P(ROW) \
788 ((ROW)->end.overlay_string_index >= 0)
790 /* Non-zero if ROW starts in the middle of a character. See above. */
792 #define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW) \
793 ((ROW)->start.dpvec_index >= 0 \
794 || ((ROW)->start.overlay_string_index >= 0 \
795 && (ROW)->start.string_pos.charpos > 0))
797 /* Non-zero means ROW overlaps its predecessor. */
799 #define MATRIX_ROW_OVERLAPS_PRED_P(ROW) \
800 ((ROW)->phys_ascent > (ROW)->ascent)
802 /* Non-zero means ROW overlaps its successor. */
804 #define MATRIX_ROW_OVERLAPS_SUCC_P(ROW) \
805 ((ROW)->phys_height - (ROW)->phys_ascent \
806 > (ROW)->height - (ROW)->ascent)
808 /* Non-zero means that fonts have been loaded since the last glyph
809 matrix adjustments. The function redisplay_internal adjusts glyph
810 matrices when this flag is non-zero. */
812 extern int fonts_changed_p
;
814 /* A glyph for a space. */
816 extern struct glyph space_glyph
;
818 /* Window being updated by update_window. This is non-null as long as
819 update_window has not finished, and null otherwise. It's role is
820 analogous to updating_frame. */
822 extern struct window
*updated_window
;
824 /* Glyph row and area updated by update_window_line. */
826 extern struct glyph_row
*updated_row
;
827 extern int updated_area
;
829 /* Non-zero means reading single-character input with prompt so put
830 cursor on mini-buffer after the prompt. Positive means at end of
831 text in echo area; negative means at beginning of line. */
833 extern int cursor_in_echo_area
;
835 /* Non-zero means last display completed. Zero means it was
838 extern int display_completed
;
840 /* Non-zero means redisplay has been performed directly (see also
841 direct_output_for_insert and direct_output_forward_char), so that
842 no further updating has to be performed. The function
843 redisplay_internal checks this flag, and does nothing but reset it
844 to zero if it is non-zero. */
846 extern int redisplay_performed_directly_p
;
848 /* A temporary storage area, including a row of glyphs. Initialized
849 in xdisp.c. Used for various purposes, as an example see
850 direct_output_for_insert. */
852 extern struct glyph_row scratch_glyph_row
;
856 /************************************************************************
858 ************************************************************************/
860 /* Return the height of the mode line in glyph matrix MATRIX, or zero
861 if not known. This macro is called under circumstances where
862 MATRIX might not have been allocated yet. */
864 #define MATRIX_MODE_LINE_HEIGHT(MATRIX) \
865 ((MATRIX) && (MATRIX)->rows \
866 ? MATRIX_MODE_LINE_ROW (MATRIX)->height \
869 /* Return the height of the top line in glyph matrix MATRIX, or zero
870 if not known. This macro is called under circumstances where
871 MATRIX might not have been allocated yet. */
873 #define MATRIX_TOP_LINE_HEIGHT(MATRIX) \
874 ((MATRIX) && (MATRIX)->rows \
875 ? MATRIX_TOP_LINE_ROW (MATRIX)->height \
878 /* Return the current height of the mode line of window W. If not
879 known from W's current glyph matrix, return a default based on the
880 height of the font of the face `modeline'. */
882 #define CURRENT_MODE_LINE_HEIGHT(W) \
883 (MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
884 ? MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
885 : estimate_mode_line_height (XFRAME ((W)->frame), MODE_LINE_FACE_ID))
887 /* Return the current height of the top line of window W. If not
888 known from W's current glyph matrix, return an estimation based on
889 the height of the font of the face `top-line'. */
891 #define CURRENT_TOP_LINE_HEIGHT(W) \
892 (MATRIX_TOP_LINE_HEIGHT ((W)->current_matrix) \
893 ? MATRIX_TOP_LINE_HEIGHT ((W)->current_matrix) \
894 : estimate_mode_line_height (XFRAME ((W)->frame), TOP_LINE_FACE_ID))
896 /* Return the height of the desired mode line of window W. */
898 #define DESIRED_MODE_LINE_HEIGHT(W) \
899 MATRIX_MODE_LINE_HEIGHT ((W)->desired_matrix)
901 /* Return the height of the desired top line of window W. */
903 #define DESIRED_TOP_LINE_HEIGHT(W) \
904 MATRIX_TOP_LINE_HEIGHT ((W)->desired_matrix)
906 /* Like FRAME_INTERNAL_BORDER_WIDTH but checks whether frame F is a
907 window-system frame. */
909 #define FRAME_INTERNAL_BORDER_WIDTH_SAFE(F) \
910 (FRAME_WINDOW_P (F) ? FRAME_INTERNAL_BORDER_WIDTH (F) : 0)
912 /* Width of display region of window W. For terminal frames, this
913 equals the width of W since there are no vertical scroll bars. For
914 window system frames, the value has to be corrected by the pixel
915 width of vertical scroll bars, and bitmap areas. */
917 #define WINDOW_DISPLAY_PIXEL_WIDTH(W) \
918 (((XFASTINT ((W)->width) \
919 - FRAME_SCROLL_BAR_WIDTH (XFRAME (WINDOW_FRAME ((W)))) \
920 - 2 * FRAME_FLAGS_AREA_COLS (XFRAME (WINDOW_FRAME ((W))))) \
921 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))))
923 /* Height of the display region of W, including a mode line, if any. */
925 #define WINDOW_DISPLAY_PIXEL_HEIGHT(W) \
926 (XFASTINT ((W)->height) \
927 * CANON_Y_UNIT (XFRAME (WINDOW_FRAME ((W)))))
929 /* Height in pixels of the mode line. May be zero if W doesn't have a
932 #define WINDOW_DISPLAY_MODE_LINE_HEIGHT(W) \
933 (WINDOW_WANTS_MODELINE_P ((W)) \
934 ? CURRENT_MODE_LINE_HEIGHT (W) \
937 /* Height in pixels of the top line. Zero if W doesn't have a top
940 #define WINDOW_DISPLAY_TOP_LINE_HEIGHT(W) \
941 (WINDOW_WANTS_TOP_LINE_P ((W)) \
942 ? CURRENT_TOP_LINE_HEIGHT (W) \
945 /* Pixel height of window W without mode line. */
947 #define WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE(W) \
948 (WINDOW_DISPLAY_PIXEL_HEIGHT ((W)) \
949 - WINDOW_DISPLAY_MODE_LINE_HEIGHT ((W)))
951 /* Pixel height of window W without mode and top line. */
953 #define WINDOW_DISPLAY_TEXT_HEIGHT(W) \
954 (WINDOW_DISPLAY_PIXEL_HEIGHT ((W)) \
955 - WINDOW_DISPLAY_MODE_LINE_HEIGHT ((W)) \
956 - WINDOW_DISPLAY_TOP_LINE_HEIGHT ((W)))
958 /* Left edge of W in pixels relative to its frame. */
960 #define WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X(W) \
961 (FRAME_INTERNAL_BORDER_WIDTH_SAFE (XFRAME (WINDOW_FRAME ((W)))) \
962 + (WINDOW_LEFT_MARGIN ((W)) \
963 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))) \
964 + FRAME_FLAGS_AREA_WIDTH (XFRAME (WINDOW_FRAME ((W)))))
966 /* Right edge of window W in pixels, relative to its frame. */
968 #define WINDOW_DISPLAY_RIGHT_EDGE_PIXEL_X(W) \
969 (WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X ((W)) \
970 + WINDOW_DISPLAY_PIXEL_WIDTH ((W)))
972 /* Top edge of W in pixels relative to its frame. */
974 #define WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y(W) \
975 (FRAME_INTERNAL_BORDER_WIDTH_SAFE (XFRAME (WINDOW_FRAME ((W)))) \
976 + (XFASTINT ((W)->top) \
977 * CANON_Y_UNIT (XFRAME (WINDOW_FRAME ((W))))))
979 /* Bottom edge of window W relative to its frame. */
981 #define WINDOW_DISPLAY_BOTTOM_EDGE_PIXEL_Y(W) \
982 (WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y ((W)) \
983 + WINDOW_DISPLAY_PIXEL_HEIGHT ((W)))
985 /* Convert window W relative pixel X to frame pixel coordinates. */
987 #define WINDOW_TO_FRAME_PIXEL_X(W, X) \
988 ((X) + WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X ((W)))
990 /* Convert window W relative pixel Y to frame pixel coordinates. */
992 #define WINDOW_TO_FRAME_PIXEL_Y(W, Y) \
993 ((Y) + WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y ((W)))
995 /* Convert frame relative pixel X to window relative pixel X. */
997 #define FRAME_TO_WINDOW_PIXEL_X(W, X) \
998 ((X) - WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X ((W)))
1000 /* Convert frame relative pixel X to window relative pixel Y. */
1002 #define FRAME_TO_WINDOW_PIXEL_Y(W, Y) \
1003 ((Y) - WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y ((W)))
1005 /* Width of left margin area in pixels. */
1007 #define WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH(W) \
1008 (NILP ((W)->left_margin_width) \
1010 : (XINT ((W)->left_margin_width) \
1011 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))))
1013 /* Width of right marginal area in pixels. */
1015 #define WINDOW_DISPLAY_RIGHT_AREA_PIXEL_WIDTH(W) \
1016 (NILP ((W)->right_margin_width) \
1018 : (XINT ((W)->right_margin_width) \
1019 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))))
1021 /* Width of text area in pixels. */
1023 #define WINDOW_DISPLAY_TEXT_AREA_PIXEL_WIDTH(W) \
1024 (WINDOW_DISPLAY_PIXEL_WIDTH ((W)) \
1025 - WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)) \
1026 - WINDOW_DISPLAY_RIGHT_AREA_PIXEL_WIDTH ((W)))
1028 /* Convert a text area relative x-position in window W to frame X
1029 pixel coordinates. */
1031 #define WINDOW_TEXT_TO_FRAME_PIXEL_X(W, X) \
1032 (WINDOW_TO_FRAME_PIXEL_X ((W), (X)) \
1033 + WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)))
1035 /* Translate an x-position relative to AREA in window W to frame pixel
1038 #define WINDOW_AREA_TO_FRAME_PIXEL_X(W, AREA, X) \
1039 (WINDOW_TO_FRAME_PIXEL_X ((W), (X)) \
1040 + (((AREA) > LEFT_MARGIN_AREA) \
1041 ? WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)) \
1043 + (((AREA) > TEXT_AREA) \
1044 ? WINDOW_DISPLAY_TEXT_AREA_PIXEL_WIDTH ((W)) \
1047 /* Return the pixel width of AREA in W. */
1049 #define WINDOW_AREA_PIXEL_WIDTH(W, AREA) \
1050 (((AREA) == TEXT_AREA) \
1051 ? WINDOW_DISPLAY_TEXT_AREA_PIXEL_WIDTH ((W)) \
1052 : (((AREA) == LEFT_MARGIN_AREA) \
1053 ? WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)) \
1054 : WINDOW_DISPLAY_RIGHT_AREA_PIXEL_WIDTH ((W))))
1056 /* Value is non-zero if window W has a mode line. */
1058 #define WINDOW_WANTS_MODELINE_P(W) \
1059 (!MINI_WINDOW_P (W) \
1060 && !(W)->pseudo_window_p \
1061 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME (W))) \
1062 && !NILP (XBUFFER ((W)->buffer)->mode_line_format))
1064 /* Value is non-zero if window W wants a top line. */
1066 #define WINDOW_WANTS_TOP_LINE_P(W) \
1067 (!MINI_WINDOW_P (W) \
1068 && !(W)->pseudo_window_p \
1069 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME (W))) \
1070 && !NILP (XBUFFER ((W)->buffer)->top_line_format))
1073 /***********************************************************************
1075 ***********************************************************************/
1077 /* Indices of face attributes in Lisp face vectors. Slot zero is the
1080 enum lface_attribute_index
1082 LFACE_FAMILY_INDEX
= 1,
1087 LFACE_UNDERLINE_INDEX
,
1088 LFACE_INVERSE_INDEX
,
1089 LFACE_FOREGROUND_INDEX
,
1090 LFACE_BACKGROUND_INDEX
,
1091 LFACE_STIPPLE_INDEX
,
1092 LFACE_OVERLINE_INDEX
,
1093 LFACE_STRIKE_THROUGH_INDEX
,
1099 /* Box types of faces. */
1103 /* No box around text. */
1106 /* Simple box of specified width and color. Default width is 1, and
1107 default color is the foreground color of the face. */
1110 /* Boxes with 3D shadows. Color equals the background color of the
1111 face. Width is specified. */
1117 /* Structure describing a realized face.
1119 For each Lisp face, 0..N realized faces can exist for different
1120 frames and different charsets. Realized faces are built from Lisp
1121 faces and text properties/overlays by merging faces and adding
1122 unspecified attributes from the `default' face. */
1126 /* The id of this face. The id equals the index of this face in the
1127 vector faces_by_id of its face cache. */
1130 #ifdef HAVE_WINDOW_SYSTEM
1132 /* If non-zero, a GC we can use without modification to draw
1133 characters in this face. */
1136 /* Font used for this face, or null if the font could not be loaded
1137 for some reason. This points to a `font' slot of a struct
1138 font_info, and we should not call XFreeFont on it because the
1139 font may still be used somewhere else. */
1142 /* Background stipple or bitmap used for this face. */
1145 #else /* not HAVE_WINDOW_SYSTEM */
1150 #endif /* not HAVE_WINDOW_SYSTEM */
1152 /* Pixel value of foreground color for X frames. Color index
1154 unsigned long foreground
;
1156 /* Pixel value or color index of background color. */
1157 unsigned long background
;
1159 /* Pixel value or color index of underline color. */
1160 unsigned long underline_color
;
1162 /* Pixel value or color index of overlined, strike-through, or box
1164 unsigned long overline_color
;
1165 unsigned long strike_through_color
;
1166 unsigned long box_color
;
1168 /* The font's name. This points to a `name' of a font_info, and it
1169 must not be freed. */
1172 /* The X font registry and encoding of font_name. */
1173 Lisp_Object registry
;
1175 /* Font info ID for this face's font. An ID is stored here because
1176 pointers to font_info structures may change. The reason is that
1177 they are pointers into a font table vector that is itself
1181 /* Fontset ID if this face uses a fontset, or -1. This is only >= 0
1182 if the face was realized for CHARSET_COMPOSITION. For all other
1183 charsets, a specific font is loaded from the set of fonts
1184 specified by the fontset given by the family attribute of the face. */
1187 /* Pixmap width and height. */
1188 unsigned int pixmap_w
, pixmap_h
;
1190 /* Non-zero means characters in this face have a box that thickness
1194 /* Type of box drawn. A value of FACE_NO_BOX means no box is drawn
1195 around text in this face. A value of FACE_SIMPLE_BOX means a box
1196 of width box_line_width is drawn in color box_color. A value of
1197 FACE_RAISED_BOX or FACE_SUNKEN_BOX means a 3D box is drawn with
1198 shadow colors derived from the background color of the face. */
1199 enum face_box_type box
;
1201 /* If `box' above specifies a 3D type, 1 means use box_color for
1203 unsigned use_box_color_for_shadows_p
: 1;
1205 /* The Lisp face attributes this face realizes. All attributes
1206 in this vector are non-nil. */
1207 Lisp_Object lface
[LFACE_VECTOR_SIZE
];
1209 /* The hash value of this face. */
1212 /* The charset for which this face was realized if it was realized
1213 for use in multibyte text. If fontset >= 0, this is
1214 CHARSET_COMPOSITION. A value of charset < 0 means the face was
1215 realized for use in unibyte text where the idea of Emacs
1216 charsets isn't applicable. */
1219 /* Non-zero if text in this face should be underlined, overlined,
1220 strike-through or have a box drawn around it. */
1221 unsigned underline_p
: 1;
1222 unsigned overline_p
: 1;
1223 unsigned strike_through_p
: 1;
1225 /* 1 means that the colors specified for this face could not be
1226 loaded, and were replaced by default colors, so they shouldn't be
1228 unsigned foreground_defaulted_p
: 1;
1229 unsigned background_defaulted_p
: 1;
1231 /* 1 means that either no color is specified for underlining or that
1232 the the specified color couldn't be loaded. Use the foreground
1233 color when drawing in that case. */
1234 unsigned underline_defaulted_p
: 1;
1236 /* 1 means that either no color is specified for the corresponding
1237 attribute or that the the specified color couldn't be loaded.
1238 Use the foreground color when drawing in that case. */
1239 unsigned overline_color_defaulted_p
: 1;
1240 unsigned strike_through_color_defaulted_p
: 1;
1241 unsigned box_color_defaulted_p
: 1;
1243 /* TTY appearances. Blinking is not yet implemented. Colors are
1244 found in `lface' with empty color string meaning the default
1245 color of the TTY. */
1246 unsigned tty_bold_p
: 1;
1247 unsigned tty_dim_p
: 1;
1248 unsigned tty_underline_p
: 1;
1249 unsigned tty_alt_charset_p
: 1;
1250 unsigned tty_reverse_p
: 1;
1251 unsigned tty_blinking_p
: 1;
1253 /* Next and previous face in hash collision list of face cache. */
1254 struct face
*next
, *prev
;
1258 /* Color index indicating that face uses a terminal's default color. */
1260 #define FACE_TTY_DEFAULT_COLOR ((unsigned long) -1)
1262 /* Non-zero if FACE was realized for unibyte use. */
1264 #define FACE_UNIBYTE_P(FACE) ((FACE)->charset < 0)
1267 /* IDs of important faces known by the C face code. These are the IDs
1268 of the faces for CHARSET_ASCII. */
1275 BITMAP_AREA_FACE_ID
,
1277 BASIC_FACE_ID_SENTINEL
1281 /* A cache of realized faces. Each frame has its own cache because
1282 Emacs allows different frame-local face definitions. */
1286 /* Hash table of cached realized faces. */
1287 struct face
**buckets
;
1289 /* Back-pointer to the frame this cache belongs to. */
1292 /* A vector of faces so that faces can be referenced by an ID. */
1293 struct face
**faces_by_id
;
1295 /* The allocated size, and number of used slots of faces_by_id. */
1300 /* Prepare face FACE for use on frame F. This must be called before
1301 using X resources of FACE. */
1303 #define PREPARE_FACE_FOR_DISPLAY(F, FACE) \
1304 if ((FACE)->gc == 0) \
1305 prepare_face_for_display ((F), (FACE)); \
1309 /* Return a pointer to the face with ID on frame F, or null if such a
1310 face doesn't exist. */
1312 #define FACE_FROM_ID(F, ID) \
1313 (((ID) >= 0 && (ID) < FRAME_FACE_CACHE (F)->used) \
1314 ? FRAME_FACE_CACHE (F)->faces_by_id[ID] \
1317 /* Non-zero if FACE is suitable for displaying characters of CHARSET.
1318 CHARSET < 0 means unibyte text. */
1320 #define FACE_SUITABLE_FOR_CHARSET_P(FACE, CHARSET) \
1322 ? (EQ ((FACE)->registry, Vface_default_registry) \
1323 || !NILP (Fequal ((FACE)->registry, Vface_default_registry))) \
1324 : ((FACE)->charset == (CHARSET) \
1325 || ((FACE)->charset == CHARSET_ASCII \
1326 && (CHARSET) == charset_latin_iso8859_1 \
1327 && face_suitable_for_iso8859_1_p ((FACE))) \
1328 || ((FACE)->charset == charset_latin_iso8859_1 \
1329 && (CHARSET) == CHARSET_ASCII))))
1331 /* Return the id of the realized face on frame F that is like the face
1332 with id ID but is suitable for displaying characters of CHARSET.
1333 This macro is only meaningful for CHARSET >= 0, i.e. multibyte
1336 #define FACE_FOR_CHARSET(F, ID, CHARSET) \
1337 (FACE_SUITABLE_FOR_CHARSET_P (FACE_FROM_ID ((F), (ID)), (CHARSET)) \
1339 : lookup_face ((F), FACE_FROM_ID ((F), (ID))->lface, (CHARSET)))
1341 /* The default registry and encoding to use. */
1343 extern Lisp_Object Vface_default_registry
;
1345 /* Non-zero means face attributes have been changed since the last
1346 redisplay. Used in redisplay_internal. */
1348 extern int face_change_count
;
1353 /***********************************************************************
1355 ***********************************************************************/
1357 /* Iteration over things to display in current_buffer or in a string.
1359 The iterator handles:
1361 1. Overlay strings (after-string, before-string).
1363 3. Invisible text properties.
1364 4. Selective display.
1365 5. Translation of characters via display tables.
1366 6. Translation of control characters to the forms `\003' or `^C'.
1367 7. `glyph' and `space-width' properties.
1369 Iterators are initialized by calling init_iterator or one of the
1370 equivalent functions below. A call to get_next_display_element
1371 loads the iterator structure with information about what next to
1372 display. A call to set_iterator_to_next increments the iterator's
1375 Characters from overlay strings, display table entries or control
1376 character translations are returned one at a time. For example, if
1377 we have a text of `a\x01' where `a' has a display table definition
1378 of `cd' and the control character is displayed with a leading
1379 arrow, then the iterator will return:
1381 Call Return Source Call next
1382 -----------------------------------------------------------------
1383 next c display table move
1384 next d display table move
1385 next ^ control char move
1386 next A control char move
1388 The same mechanism is also used to return characters for ellipses
1389 displayed at the end of invisible text.
1391 CAVEAT: Under some circumstances, move_.* functions can be called
1392 asynchronously, e.g. when computing a buffer position from an x and
1393 y pixel position. This means that these functions and functions
1394 called from them SHOULD NOT USE xmalloc and alike. See also the
1395 comment at the start of xdisp.c. */
1397 /* Enumeration describing what kind of display element an iterator is
1398 loaded with after a call to get_next_display_element. */
1400 enum display_element_type
1402 /* A normal character. */
1408 /* A flexible width and height space. */
1411 /* End of buffer or string. */
1414 /* Truncation glyphs. Never returned by get_next_display_element.
1415 Used to get display information about truncation glyphs via
1419 /* Continuation glyphs. See the comment for IT_TRUNCATION. */
1424 /* An enumerator for each text property that has a meaning for display
1434 /* Not a property. Used to indicate changes in overlays. */
1444 /* The window in which we iterate over current_buffer (or a string). */
1448 /* The window's frame. */
1451 /* Function to call to load this structure with the next display
1453 int (* method
) P_ ((struct it
*it
));
1455 /* The next position at which to check for face changes, invisible
1456 text, overlay strings, end of text etc., which see. */
1459 /* Maximum string or buffer position + 1. ZV when iterating over
1463 /* C string to iterate over. Non-null means get characters from
1464 this string, otherwise characters are read from current_buffer
1468 /* Number of characters in the string (s, or it->string) we iterate
1472 /* Start and end of a visible region; -1 if the region is not
1473 visible in the window. */
1474 int region_beg_charpos
, region_end_charpos
;
1476 /* Position at which redisplay end trigger functions should be run. */
1477 int redisplay_end_trigger_charpos
;
1479 /* 1 means multibyte characters are enabled. */
1480 unsigned multibyte_p
: 1;
1482 /* 1 means window has a mode line at its top. */
1483 unsigned top_line_p
: 1;
1485 /* 1 means `string' is the value of a `display' property.
1486 Don't handle some `display' properties in these strings. */
1487 unsigned string_from_display_prop_p
: 1;
1489 /* Display table in effect or null for none. */
1490 struct Lisp_Char_Table
*dp
;
1492 /* Current display table vector to return characters from and its
1493 end. dpvec null means we are not returning characters from a
1494 display table entry; current.dpvec_index gives the current index
1495 into dpvec. This same mechanism is also used to return
1496 characters from translated control characters, i.e. `\003' or
1498 Lisp_Object
*dpvec
, *dpend
;
1500 /* Length in bytes of the char that filled dpvec. A value of zero
1501 means that no character such character is involved. */
1504 /* Face id of the iterator saved in case a glyph from dpvec contains
1505 a face. The face is restored when all glyphs from dpvec have
1509 /* Vector of glyphs for control character translation. The pointer
1510 dpvec is set to ctl_chars when a control character is translated. */
1511 Lisp_Object ctl_chars
[4];
1513 /* Current buffer or string position of the iterator, including
1514 position in overlay strings etc. */
1515 struct display_pos current
;
1517 /* Vector of overlays to process. Overlay strings are processed
1518 OVERLAY_STRING_CHUNK_SIZE at a time. */
1519 #define OVERLAY_STRING_CHUNK_SIZE 3
1520 Lisp_Object overlay_strings
[OVERLAY_STRING_CHUNK_SIZE
];
1522 /* Total number of overlay strings to process. This can be >
1523 OVERLAY_STRING_CHUNK_SIZE. */
1524 int n_overlay_strings
;
1526 /* If non-nil, a Lisp string being processed. If
1527 current.overlay_string_index >= 0, this is an overlay string from
1531 /* Stack of saved values. New entries are pushed when we begin to
1532 process an overlay string or a string from a `glyph' property.
1533 Entries are popped when we return to deliver display elements
1534 from what we previously had. */
1535 struct iterator_stack_entry
1540 struct display_pos pos
;
1543 enum glyph_row_area area
;
1544 unsigned multibyte_p
: 1;
1545 unsigned string_from_display_prop_p
: 1;
1546 Lisp_Object space_width
;
1548 Lisp_Object font_height
;
1552 /* Stack pointer. */
1555 /* Setting of buffer-local variable selective-display-ellipsis. */
1556 unsigned selective_display_ellipsis_p
: 1;
1558 /* 1 means control characters are translated into the form `^C'
1559 where the `^' can be replaced by a display table entry. */
1560 unsigned ctl_arrow_p
: 1;
1562 /* -1 means selective display hides everything between a \r and the
1563 next newline; > 0 means hide lines indented more than that value. */
1566 /* An enumeration describing what the next display element is
1567 after a call to get_next_display_element. */
1568 enum display_element_type what
;
1573 /* Non-zero means that the current face has a box. */
1574 unsigned face_box_p
: 1;
1576 /* Non-null means that the current character is the first in a run
1577 of characters with box face. */
1578 unsigned start_of_box_run_p
: 1;
1580 /* Non-zero means that the current character is the last in a run
1581 of characters with box face. */
1582 unsigned end_of_box_run_p
: 1;
1584 /* 1 means overlay strings at end_charpos have been processed. */
1585 unsigned overlay_strings_at_end_processed_p
: 1;
1587 /* The ID of the default face to use. One of DEFAULT_FACE_ID,
1588 MODE_LINE_FACE_ID, or TOOLBAR_FACE_ID, depending on what we
1592 /* If what == IT_CHARACTER, character and length in bytes. This is
1593 a character from a buffer or string. It may be different from
1594 the character displayed in case that
1595 unibyte_display_via_language_environment is set. */
1598 /* The character to display, possibly translated to multibyte
1599 if unibyte_display_via_language_environment is set. This
1600 is set after x_produce_glyphs has been called. */
1601 int char_to_display
;
1603 /* Charset for which face_id was computed. This is the charset
1604 of char_to_display after x_produce_glyphs has been called. */
1607 /* If what == IT_IMAGE, the id of the image to display. */
1610 /* Value of the `space-width' property, if any; nil if none. */
1611 Lisp_Object space_width
;
1613 /* Computed from the value of the `raise' property. */
1616 /* Value of the `height' property, if any; nil if none. */
1617 Lisp_Object font_height
;
1619 /* Object and position where the current display element came from.
1620 Object can be a Lisp string in case the current display element
1621 comes from an overlay string, or it is buffer. Position is
1622 a position in object. */
1624 struct text_pos position
;
1626 /* 1 means lines are truncated. */
1627 unsigned truncate_lines_p
: 1;
1629 /* Number of columns per \t. */
1632 /* Width in pixels of truncation and continuation glyphs. */
1633 short truncation_pixel_width
, continuation_pixel_width
;
1635 /* First and last visible x-position in the display area. If window
1636 is hscrolled by n columns, first_visible_x == n * CANON_X_UNIT
1637 (f), and last_visible_x == pixel width of W + first_visible_x. */
1638 int first_visible_x
, last_visible_x
;
1640 /* Last visible y-position + 1 in the display area without a mode
1641 line, if the window has one. */
1644 /* Width of a prompt in front of the line. Used to perform tab
1645 calculations. The x on which tab calculations are based is
1646 current_x - prompt_width + continuation_lines_width. */
1649 /* If non-null, glyphs are produced in glyph_row with each call to
1651 struct glyph_row
*glyph_row
;
1653 /* The area of glyph_row to which glyphs are added. */
1654 enum glyph_row_area area
;
1656 /* Number of glyphs needed for the last character requested via
1657 produce_glyphs. This is 1 except for tabs. */
1660 /* Width of the display element in pixels. Result of
1664 /* Current, maximum logical, and maximum physical line height
1665 information. Result of produce_glyphs. */
1666 int ascent
, descent
, max_ascent
, max_descent
;
1667 int phys_ascent
, phys_descent
, max_phys_ascent
, max_phys_descent
;
1669 /* Current x pixel position within the display line. This value
1670 does not include the width of continuation lines in front of the
1671 line. The value of current_x is automatically incremented by
1672 pixel_width with each call to produce_glyphs. */
1675 /* Accumulated width of continuation lines. If > 0, this means we
1676 are currently in a continuation line. This is initially zero and
1677 incremented/reset by display_line, move_it_to etc. */
1678 int continuation_lines_width
;
1680 /* Current y-position. Automatically incremented by the height of
1681 glyph_row in move_it_to and display_line. */
1684 /* Current vertical matrix position, or line number. Automatically
1685 incremented by move_it_to and display_line. */
1688 /* Horizontal matrix position reached in move_it_in_display_line.
1689 Only set there, not in display_line. */
1694 /* Access to positions of iterator IT. */
1696 #define IT_CHARPOS(IT) CHARPOS ((IT).current.pos)
1697 #define IT_BYTEPOS(IT) BYTEPOS ((IT).current.pos)
1698 #define IT_STRING_CHARPOS(IT) CHARPOS ((IT).current.string_pos)
1699 #define IT_STRING_BYTEPOS(IT) BYTEPOS ((IT).current.string_pos)
1701 /* Test if IT has reached the end of its buffer or string. This will
1702 only work after get_next_display_element has been called. */
1704 #define ITERATOR_AT_END_P(IT) ((IT)->what == IT_EOB)
1706 /* Non-zero means IT is at the end of a line. This is the case if it
1707 is either on a newline or on a carriage return and selective
1708 display hides the rest of the line. */
1710 #define ITERATOR_AT_END_OF_LINE_P(IT) \
1711 ((IT)->what == IT_CHARACTER \
1712 && ((IT)->c == '\n' \
1713 || ((IT)->c == '\r' && (IT)->selective)))
1715 /* Call produce_glyphs or produce_glyphs_hook, if set. Shortcut to
1716 avoid the function call overhead. */
1718 #define PRODUCE_GLYPHS(IT) \
1720 ? rif->produce_glyphs ((IT)) \
1721 : produce_glyphs ((IT)))
1723 /* Bit-flags indicating what operation move_it_to should perform. */
1725 enum move_operation_enum
1727 /* Stop if specified x-position is reached. */
1730 /* Stop if specified y-position is reached. */
1733 /* Stop if specified vpos is reached. */
1734 MOVE_TO_VPOS
= 0x04,
1736 /* Stop if specified buffer or string position is reached. */
1742 /***********************************************************************
1743 Window-based redisplay interface
1744 ***********************************************************************/
1746 /* Structure used to describe runs of lines that must be scrolled. */
1750 /* Source and destination y pixel position. */
1751 int desired_y
, current_y
;
1753 /* Source and destination vpos in matrix. */
1754 int desired_vpos
, current_vpos
;
1756 /* Height in pixels, number of glyph rows. */
1761 /* Structure holding system-dependent interface functions needed
1762 for window-based redisplay. */
1764 struct redisplay_interface
1766 /* Produce glyphs/get display metrics for the display element IT is
1768 void (*produce_glyphs
) P_ ((struct it
*it
));
1770 /* Write or insert LEN glyphs from STRING at the nominal output
1772 void (*write_glyphs
) P_ ((struct glyph
*string
, int len
));
1773 void (*insert_glyphs
) P_ ((struct glyph
*start
, int len
));
1775 /* Clear from nominal output position to X. X < 0 means clear
1776 to right end of display. */
1777 void (*clear_end_of_line
) P_ ((int x
));
1779 /* Function to call to scroll the display as described by RUN on
1781 void (*scroll_run_hook
) P_ ((struct window
*w
, struct run
*run
));
1783 /* Function to call after a line in a display has been completely
1784 updated. Used to draw truncation marks and alike. DESIRED_ROW
1785 is the desired row which has been updated. */
1786 void (*after_update_window_line_hook
) P_ ((struct glyph_row
*desired_row
));
1788 /* Function to call before beginning to update window W in
1789 window-based redisplay. */
1790 void (*update_window_begin_hook
) P_ ((struct window
*w
));
1792 /* Function to call after window W has been updated in window-based
1793 redisplay. CURSOR_ON_P non-zero means switch cursor on. */
1794 void (*update_window_end_hook
) P_ ((struct window
*w
, int cursor_on_p
));
1796 /* Move cursor to row/column position VPOS/HPOS, pixel coordinates
1797 Y/X. HPOS/VPOS are window-relative row and column numbers and X/Y
1798 are window-relative pixel positions. */
1799 void (*cursor_to
) P_ ((int vpos
, int hpos
, int y
, int x
));
1801 /* Flush the display of frame F. For X, this is XFlush. */
1802 void (*flush_display
) P_ ((struct frame
*f
));
1804 /* Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
1806 void (*get_glyph_overhangs
) P_ ((struct glyph
*glyph
, struct frame
*f
,
1807 int *left
, int *right
));
1809 /* Fix the display of AREA of ROW in window W for overlapping rows.
1810 This function is called from redraw_overlapping_rows after
1811 desired rows have been made current. */
1812 void (*fix_overlapping_area
) P_ ((struct window
*w
, struct glyph_row
*row
,
1813 enum glyph_row_area area
));
1816 /* The current interface for window-based redisplay. */
1818 extern struct redisplay_interface
*rif
;
1820 /* Hook to call in estimate_mode_line_height. */
1822 extern int (* estimate_mode_line_height_hook
) P_ ((struct frame
*,
1826 /***********************************************************************
1828 ***********************************************************************/
1830 #ifdef HAVE_X_WINDOWS
1832 /* Structure forward declarations. */
1837 /* Each image format (JPEG, IIFF, ...) supported is described by
1838 a structure of the type below. */
1842 /* A symbol uniquely identifying the image type, .e.g `jpeg'. */
1845 /* Check that SPEC is a valid image specification for the given
1846 image type. Value is non-zero if SPEC is valid. */
1847 int (* valid_p
) P_ ((Lisp_Object spec
));
1849 /* Load IMG which is used on frame F from information contained in
1850 IMG->spec. Value is non-zero if successful. */
1851 int (* load
) P_ ((struct frame
*f
, struct image
*img
));
1853 /* Free resources of image IMG which is used on frame F. */
1854 void (* free
) P_ ((struct frame
*f
, struct image
*img
));
1856 /* Next in list of all supported image types. */
1857 struct image_type
*next
;
1861 /* Structure describing an image. Specific image formats like XBM are
1862 converted into this form, so that display only has to deal with
1863 this type of image. */
1867 /* The time in seconds at which the image was last displayed. Set
1868 in prepare_image_for_display. */
1869 unsigned long timestamp
;
1871 /* Pixmaps of the image. */
1872 Pixmap pixmap
, mask
;
1874 /* Colors allocated for this image, if any. Allocated via xmalloc. */
1875 unsigned long *colors
;
1878 /* Width and height of the image. */
1881 /* These values are used for the rectangles displayed for images
1882 that can't be loaded. */
1883 #define DEFAULT_IMAGE_WIDTH 30
1884 #define DEFAULT_IMAGE_HEIGHT 30
1886 /* Percent of image height used as ascent. */
1888 #define DEFAULT_IMAGE_ASCENT 50
1890 /* Lisp specification of this image. */
1893 /* Relief to draw around the image. */
1896 /* Optional margin around the image. This includes the relief. */
1899 /* Reference to the type of the image. */
1900 struct image_type
*type
;
1902 /* A place for image types to store additional data. The member
1903 data.lisp_val is marked during GC, so it's safe to store Lisp data
1904 there. Image types should free this data when their `free'
1905 function is called. */
1910 Lisp_Object lisp_val
;
1913 /* Hash value of image specification to speed up comparisons. */
1916 /* Image id of this image. */
1919 /* Hash collision chain. */
1920 struct image
*next
, *prev
;
1924 /* Cache of images. Each frame has a cache. X frames with the same
1925 x_display_info share their caches. */
1929 /* Hash table of images. */
1930 struct image
**buckets
;
1932 /* Vector mapping image ids to images. */
1933 struct image
**images
;
1935 /* Allocated size of `images'. */
1938 /* Number of images in the cache. */
1941 /* Reference count (number of frames sharing this cache). */
1946 /* Value is the ascent of image IMG. */
1948 #define IMAGE_ASCENT(IMG) \
1949 (((IMG)->height + (IMG)->margin) * (IMG)->ascent / 100.0)
1951 /* Value is a pointer to the image with id ID on frame F, or null if
1952 no image with that id exists. */
1954 #define IMAGE_FROM_ID(F, ID) \
1955 (((ID) >= 0 && (ID) < (FRAME_X_IMAGE_CACHE (F)->used)) \
1956 ? FRAME_X_IMAGE_CACHE (F)->images[ID] \
1959 /* Size of bucket vector of image caches. Should be prime. */
1961 #define IMAGE_CACHE_BUCKETS_SIZE 1001
1963 #endif /* HAVE_X_WINDOWS */
1967 /***********************************************************************
1969 ***********************************************************************/
1971 /* Enumeration defining where to find toolbar item information in
1972 toolbar items vectors stored with frames. Each toolbar item
1973 occupies TOOLBAR_ITEM_NSLOTS elements in such a vector. */
1975 enum toolbar_item_idx
1977 /* The key of the toolbar item. Used to remove items when a binding
1978 for `undefined' is found. */
1981 /* Non-nil if item is enabled. */
1982 TOOLBAR_ITEM_ENABLED_P
,
1984 /* Non-nil if item is selected (pressed). */
1985 TOOLBAR_ITEM_SELECTED_P
,
1988 TOOLBAR_ITEM_CAPTION
,
1990 /* Image(s) to display. This is either a single image specification
1991 or a vector of specifications. */
1992 TOOLBAR_ITEM_IMAGES
,
1995 TOOLBAR_ITEM_BINDING
,
1997 /* Button type. One of nil, `:radio' or `:toggle'. */
2003 /* Sentinel = number of slots in toolbar_items occupied by one
2009 /* An enumeration for the different images that can be specified
2010 for a toolbar item. */
2012 enum toolbar_item_image
2014 TOOLBAR_IMAGE_ENABLED_SELECTED
,
2015 TOOLBAR_IMAGE_ENABLED_DESELECTED
,
2016 TOOLBAR_IMAGE_DISABLED_SELECTED
,
2017 TOOLBAR_IMAGE_DISABLED_DESELECTED
2020 /* Non-zero means raise toolbar buttons when the mouse moves over them. */
2022 extern int auto_raise_toolbar_buttons_p
;
2024 /* Margin around toolbar buttons in pixels. */
2026 extern int toolbar_button_margin
;
2028 /* Thickness of relief to draw around toolbar buttons. */
2030 extern int toolbar_button_relief
;
2034 /***********************************************************************
2036 ***********************************************************************/
2038 /* Defined in xdisp.c */
2040 int try_window
P_ ((Lisp_Object
, struct text_pos
));
2041 void window_box
P_ ((struct window
*, int, int *, int *, int *, int *));
2042 int window_box_height
P_ ((struct window
*));
2043 int window_text_bottom_y
P_ ((struct window
*));
2044 int window_box_width
P_ ((struct window
*, int));
2045 int window_box_left
P_ ((struct window
*, int));
2046 int window_box_right
P_ ((struct window
*, int));
2047 void window_box_edges
P_ ((struct window
*, int, int *, int *, int *, int *));
2048 void mark_window_display_accurate
P_ ((Lisp_Object
, int));
2049 void redisplay_preserve_echo_area
P_ ((void));
2050 void set_cursor_from_row
P_ ((struct window
*, struct glyph_row
*,
2051 struct glyph_matrix
*, int, int, int, int));
2052 void init_iterator
P_ ((struct it
*, struct window
*, int,
2053 int, struct glyph_row
*, enum face_id
));
2054 void init_iterator_to_row_start
P_ ((struct it
*, struct window
*,
2055 struct glyph_row
*));
2056 int get_next_display_element
P_ ((struct it
*));
2057 void set_iterator_to_next
P_ ((struct it
*));
2058 void produce_glyphs
P_ ((struct it
*));
2059 void produce_special_glyphs
P_ ((struct it
*, enum display_element_type
));
2060 void start_display
P_ ((struct it
*, struct window
*, struct text_pos
));
2061 void move_it_to
P_ ((struct it
*, int, int, int, int, int));
2062 void move_it_vertically
P_ ((struct it
*, int));
2063 void move_it_by_lines
P_ ((struct it
*, int, int));
2064 int frame_mode_line_height
P_ ((struct frame
*));
2065 void highlight_trailing_whitespace
P_ ((struct frame
*, struct glyph_row
*));
2066 int toolbar_item_info
P_ ((struct frame
*, struct glyph
*, int *));
2067 extern Lisp_Object Qtoolbar
;
2068 extern Lisp_Object Vshow_trailing_whitespace
;
2069 extern int redisplaying_p
;
2071 /* Defined in sysdep.c */
2073 void get_frame_size
P_ ((int *, int *));
2074 void request_sigio
P_ ((void));
2075 void unrequest_sigio
P_ ((void));
2076 int tabs_safe_p
P_ ((void));
2077 void init_baud_rate
P_ ((void));
2078 void init_sigio
P_ ((int));
2080 /* Defined in xface.c */
2082 char *x_charset_registry
P_ ((int));
2083 void clear_face_cache
P_ ((int));
2084 unsigned long load_color
P_ ((struct frame
*, struct face
*, Lisp_Object
,
2085 enum lface_attribute_index
));
2086 void unload_color
P_ ((struct frame
*, unsigned long));
2087 int frame_update_line_height
P_ ((struct frame
*));
2088 int ascii_face_of_lisp_face
P_ ((struct frame
*, int));
2089 void prepare_face_for_display
P_ ((struct frame
*, struct face
*));
2090 int face_suitable_for_iso8859_1_p
P_ ((struct face
*));
2091 int xstricmp
P_ ((unsigned char *, unsigned char *));
2092 int lookup_face
P_ ((struct frame
*, Lisp_Object
*, int));
2093 int face_suitable_for_charset_p
P_ ((struct face
*, int));
2094 int lookup_named_face
P_ ((struct frame
*, Lisp_Object
, int));
2095 int smaller_face
P_ ((struct frame
*, int, int));
2096 int face_with_height
P_ ((struct frame
*, int, int));
2097 int lookup_derived_face
P_ ((struct frame
*, Lisp_Object
, int, int));
2098 void init_frame_faces
P_ ((struct frame
*));
2099 void free_frame_faces
P_ ((struct frame
*));
2100 void recompute_basic_faces
P_ ((struct frame
*));
2101 int face_at_buffer_position
P_ ((struct window
*, int, int, int, int *,
2103 int face_at_string_position
P_ ((struct window
*, Lisp_Object
,
2104 int, int, int, int, int *, enum face_id
));
2105 int compute_char_face
P_ ((struct frame
*, int, Lisp_Object
));
2106 void free_all_realized_faces
P_ ((Lisp_Object
));
2107 extern Lisp_Object Qforeground_color
, Qbackground_color
;
2109 /* Defined in xfns.c */
2111 #ifdef HAVE_X_WINDOWS
2113 int x_screen_planes
P_ ((struct frame
*));
2114 void x_implicitly_set_name
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
2115 struct image_cache
*make_image_cache
P_ ((void));
2116 void free_image_cache
P_ ((struct frame
*));
2117 void clear_image_cache
P_ ((struct frame
*, int));
2118 void forall_images_in_image_cache
P_ ((struct frame
*,
2119 void (*) P_ ((struct image
*))));
2120 int valid_image_p
P_ ((Lisp_Object
));
2121 void prepare_image_for_display
P_ ((struct frame
*, struct image
*));
2122 int lookup_image
P_ ((struct frame
*, Lisp_Object
));
2123 extern struct frame
*tip_frame
;
2124 extern Window tip_window
;
2125 EXFUN (Fx_show_tip
, 4);
2126 EXFUN (Fx_hide_tip
, 0);
2127 EXFUN (Fx_show_busy_cursor
, 0);
2128 EXFUN (Fx_hide_busy_cursor
, 1);
2129 extern int inhibit_busy_cursor
;
2130 extern int display_busy_cursor_p
;
2132 #endif /* HAVE_X_WINDOWS */
2135 /* Defined in xmenu.c */
2137 int popup_activated
P_ ((void));
2139 /* Defined in dispnw.c */
2141 Lisp_Object mode_line_string
P_ ((struct window
*, int, int, int, int *));
2142 extern void redraw_frame
P_ ((struct frame
*));
2143 extern void redraw_garbaged_frames
P_ ((void));
2144 extern void cancel_line
P_ ((int, struct frame
*));
2145 extern void init_desired_glyphs
P_ ((struct frame
*));
2146 extern int scroll_frame_lines
P_ ((struct frame
*, int, int, int, int));
2147 extern int direct_output_for_insert
P_ ((int));
2148 extern int direct_output_forward_char
P_ ((int));
2149 extern int update_frame
P_ ((struct frame
*, int, int));
2150 extern int scrolling
P_ ((struct frame
*));
2151 extern void do_pending_window_change
P_ ((void));
2152 extern void change_frame_size
P_ ((struct frame
*, int, int, int, int));
2153 extern void bitch_at_user
P_ ((void));
2154 void adjust_glyphs
P_ ((struct frame
*));
2155 void free_glyphs
P_ ((struct frame
*));
2156 void free_window_matrices
P_ ((struct window
*));
2157 void check_glyph_memory
P_ ((void));
2158 void mirrored_line_dance
P_ ((struct glyph_matrix
*, int, int, int *, char *));
2159 void clear_glyph_matrix
P_ ((struct glyph_matrix
*));
2160 void clear_current_matrices
P_ ((struct frame
*f
));
2161 void clear_desired_matrices
P_ ((struct frame
*));
2162 void shift_glyph_matrix
P_ ((struct window
*, struct glyph_matrix
*,
2164 void rotate_matrix
P_ ((struct glyph_matrix
*, int, int, int));
2165 void increment_glyph_matrix_buffer_positions
P_ ((struct glyph_matrix
*,
2166 int, int, int, int));
2167 void blank_row
P_ ((struct window
*, struct glyph_row
*, int));
2168 void increment_glyph_row_buffer_positions
P_ ((struct glyph_row
*, int, int));
2169 void enable_glyph_matrix_rows
P_ ((struct glyph_matrix
*, int, int, int));
2170 void clear_glyph_row
P_ ((struct glyph_row
*));
2171 void prepare_desired_row
P_ ((struct glyph_row
*));
2172 int line_hash_code
P_ ((struct glyph_row
*));
2173 void set_window_update_flags
P_ ((struct window
*, int));
2174 void write_glyphs
P_ ((struct glyph
*, int));
2175 void insert_glyphs
P_ ((struct glyph
*, int));
2176 void redraw_frame
P_ ((struct frame
*));
2177 void redraw_garbaged_frames
P_ ((void));
2178 int scroll_cost
P_ ((struct frame
*, int, int, int));
2179 int direct_output_for_insert
P_ ((int));
2180 int direct_output_forward_char
P_ ((int));
2181 int update_frame
P_ ((struct frame
*, int, int));
2182 void update_single_window
P_ ((struct window
*, int));
2183 int scrolling
P_ ((struct frame
*));
2184 int buffer_posn_from_coords
P_ ((struct window
*, int *, int *));
2185 void do_pending_window_change
P_ ((void));
2186 void change_frame_size
P_ ((struct frame
*, int, int, int, int));
2187 void bitch_at_user
P_ ((void));
2188 Lisp_Object sit_for
P_ ((int, int, int, int, int));
2189 void init_display
P_ ((void));
2190 void syms_of_display
P_ ((void));
2192 /* Defined in term.c */
2194 extern void ring_bell
P_ ((void));
2195 extern void set_terminal_modes
P_ ((void));
2196 extern void reset_terminal_modes
P_ ((void));
2197 extern void update_begin
P_ ((struct frame
*));
2198 extern void update_end
P_ ((struct frame
*));
2199 extern void set_terminal_window
P_ ((int));
2200 extern void set_scroll_region
P_ ((int, int));
2201 extern void turn_off_insert
P_ ((void));
2202 extern void turn_off_highlight
P_ ((void));
2203 extern void background_highlight
P_ ((void));
2204 extern void reassert_line_highlight
P_ ((int, int));
2205 extern void clear_frame
P_ ((void));
2206 extern void clear_end_of_line
P_ ((int));
2207 extern void clear_end_of_line_raw
P_ ((int));
2208 extern void delete_glyphs
P_ ((int));
2209 extern void ins_del_lines
P_ ((int, int));
2210 extern int string_cost
P_ ((char *));
2211 extern int per_line_cost
P_ ((char *));
2212 extern void calculate_costs
P_ ((struct frame
*));
2213 extern void term_init
P_ ((char *));
2214 extern void fatal
P_ ((/* char *, ... */));
2215 void cursor_to
P_ ((int, int));
2216 void change_line_highlight
P_ ((int, int, int, int));
2218 /* Defined in scroll.c */
2220 extern int scrolling_max_lines_saved
P_ ((int, int, int *, int *, int *));
2221 extern int scroll_cost
P_ ((struct frame
*, int, int, int));
2222 extern void do_line_insertion_deletion_costs
P_ ((struct frame
*, char *,
2223 char *, char *, char *,
2224 char *, char *, int));
2225 void scrolling_1
P_ ((struct frame
*, int, int, int, int *, int *, int *,
2228 #endif /* not DISPEXTERN_H_INCLUDED */