1 /* Interface definitions for display code.
3 Copyright (C) 1985, 1993-1994, 1997-2016 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 3 of the License, or (at
10 your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>. */
20 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>. */
22 #ifndef DISPEXTERN_H_INCLUDED
23 #define DISPEXTERN_H_INCLUDED
25 #include "character.h"
31 #include <X11/Intrinsic.h>
32 #endif /* USE_X_TOOLKIT */
34 #else /* !HAVE_X_WINDOWS */
36 /* X-related stuff used by non-X gui code. */
40 unsigned short red
, green
, blue
;
45 #endif /* HAVE_X_WINDOWS */
53 #include <c-strcase.h>
55 xstrcasecmp (char const *a
, char const *b
)
57 return c_strcasecmp (a
, b
);
61 #include <X11/Xresource.h> /* for XrmDatabase */
62 typedef struct x_display_info Display_Info
;
63 typedef XImage
* XImagePtr
;
64 typedef XImagePtr XImagePtr_or_DC
;
65 #define NativeRectangle XRectangle
70 typedef struct w32_display_info Display_Info
;
71 typedef XImage
*XImagePtr
;
72 typedef HDC XImagePtr_or_DC
;
77 /* Following typedef needed to accommodate the MSDOS port, believe it or not. */
78 typedef struct ns_display_info Display_Info
;
79 typedef Pixmap XImagePtr
;
80 typedef XImagePtr XImagePtr_or_DC
;
83 #ifdef HAVE_WINDOW_SYSTEM
87 #ifndef HAVE_WINDOW_SYSTEM
92 #ifndef NativeRectangle
93 #define NativeRectangle int
96 /* Text cursor types. */
98 enum text_cursor_kinds
108 /* Values returned from coordinates_in_window. */
121 ON_VERTICAL_SCROLL_BAR
,
122 ON_HORIZONTAL_SCROLL_BAR
,
127 /* Number of bits allocated to store fringe bitmap numbers. */
128 #define FRINGE_ID_BITS 16
130 /* Number of bits allocated to store fringe bitmap height. */
131 #define FRINGE_HEIGHT_BITS 8
134 /***********************************************************************
136 ***********************************************************************/
138 /* If GLYPH_DEBUG is defined, additional checks are activated. */
140 /* Macros to include code only if GLYPH_DEBUG is defined. */
143 #define IF_DEBUG(X) ((void) (X))
145 #define IF_DEBUG(X) ((void) 0)
148 /* Macro for displaying traces of redisplay. If Emacs was compiled
149 with GLYPH_DEBUG defined, the variable trace_redisplay_p can be set to
150 a non-zero value in debugging sessions to activate traces. */
154 extern bool trace_redisplay_p EXTERNALLY_VISIBLE
;
159 if (trace_redisplay_p) \
163 #else /* not GLYPH_DEBUG */
165 #define TRACE(X) ((void) 0)
167 #endif /* GLYPH_DEBUG */
171 /***********************************************************************
173 ***********************************************************************/
175 /* Starting with Emacs 20.3, characters from strings and buffers have
176 both a character and a byte position associated with them. The
177 following structure holds such a pair of positions. */
181 /* Character position. */
184 /* Corresponding byte position. */
188 /* Access character and byte position of POS in a functional form. */
190 #define BYTEPOS(POS) (POS).bytepos
191 #define CHARPOS(POS) (POS).charpos
193 /* Set character position of POS to CHARPOS, byte position to BYTEPOS. */
195 #define SET_TEXT_POS(POS, CHARPOS, BYTEPOS) \
196 ((POS).charpos = (CHARPOS), (POS).bytepos = BYTEPOS)
198 /* Increment text position POS. */
200 #define INC_TEXT_POS(POS, MULTIBYTE_P) \
205 INC_POS ((POS).bytepos); \
211 /* Decrement text position POS. */
213 #define DEC_TEXT_POS(POS, MULTIBYTE_P) \
218 DEC_POS ((POS).bytepos); \
224 /* Set text position POS from marker MARKER. */
226 #define SET_TEXT_POS_FROM_MARKER(POS, MARKER) \
227 (CHARPOS (POS) = marker_position (MARKER), \
228 BYTEPOS (POS) = marker_byte_position (MARKER))
230 /* Like above, but clip POS within accessible range. */
232 #define CLIP_TEXT_POS_FROM_MARKER(POS, MARKER) \
233 (CHARPOS (POS) = clip_to_bounds \
234 (BEGV, marker_position (MARKER), ZV), \
235 BYTEPOS (POS) = clip_to_bounds \
236 (BEGV_BYTE, marker_byte_position (MARKER), ZV_BYTE))
238 /* Set marker MARKER from text position POS. */
240 #define SET_MARKER_FROM_TEXT_POS(MARKER, POS) \
241 set_marker_both ((MARKER), Qnil, CHARPOS ((POS)), BYTEPOS ((POS)))
243 /* Value is non-zero if character and byte positions of POS1 and POS2
246 #define TEXT_POS_EQUAL_P(POS1, POS2) \
247 ((POS1).charpos == (POS2).charpos \
248 && (POS1).bytepos == (POS2).bytepos)
250 /* When rendering glyphs, redisplay scans string or buffer text,
251 overlay strings in that text, and does display table or control
252 character translations. The following structure captures a
253 position taking all this into account. */
257 /* Buffer or string position. */
260 /* If this is a position in an overlay string, overlay_string_index
261 is the index of that overlay string in the sequence of overlay
262 strings at `pos' in the order redisplay processes them. A value
263 < 0 means that this is not a position in an overlay string. */
264 ptrdiff_t overlay_string_index
;
266 /* If this is a position in an overlay string, string_pos is the
267 position within that string. */
268 struct text_pos string_pos
;
270 /* If the character at the position above is a control character or
271 has a display table entry, dpvec_index is an index in the display
272 table or control character translation of that character. A
273 value < 0 means this is not a position in such a translation. */
279 /***********************************************************************
281 ***********************************************************************/
283 /* The glyph datatype, used to represent characters on the display.
284 It consists of a char code and a face id. */
291 /* Return a glyph's character code. */
292 INLINE
int GLYPH_CHAR (GLYPH glyph
) { return glyph
.ch
; }
294 /* Return a glyph's face ID. */
295 INLINE
int GLYPH_FACE (GLYPH glyph
) { return glyph
.face_id
; }
297 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
298 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
299 #define SET_GLYPH(glyph, char, face) \
300 ((glyph).ch = (char), (glyph).face_id = (face))
302 /* The following are valid only if GLYPH_CODE_P (gc). */
305 GLYPH_CODE_CHAR (Lisp_Object gc
)
309 : XINT (gc
) & MAX_CHAR
);
313 GLYPH_CODE_FACE (Lisp_Object gc
)
315 return CONSP (gc
) ? XINT (XCDR (gc
)) : XINT (gc
) >> CHARACTERBITS
;
318 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
322 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
324 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
325 (XINT (gc) >> CHARACTERBITS)); \
329 /* The ID of the mode line highlighting face. */
330 enum { GLYPH_MODE_LINE_FACE
= 1 };
332 /* Enumeration of glyph types. Glyph structures contain a type field
333 containing one of the enumerators defined here. */
337 /* Glyph describes a character. */
340 /* Glyph describes a static composition. */
343 /* Glyph describes a glyphless character. */
346 /* Glyph describes an image. */
349 /* Glyph is a space of fractional width and/or height. */
352 /* Glyph is an external widget drawn by the GUI toolkit. */
357 /* Structure describing how to use partial glyphs (images slicing) */
364 unsigned height
: 16;
370 Be extra careful when changing this structure! Esp. make sure that
371 functions producing glyphs, like append_glyph, fill ALL of the
372 glyph structure, and that GLYPH_EQUAL_P compares all
373 display-relevant members of glyphs (not to imply that these are the
374 only things to check when you add a member). */
378 /* Position from which this glyph was drawn. If `object' below is a
379 Lisp string, this is an index into that string. If it is a
380 buffer, this is a position in that buffer. In addition, some
381 special glyphs have special values for this:
383 glyph standing for newline at end of line 0
384 empty space after the end of the line -1
385 overlay arrow on a TTY -1
386 glyph at EOB that ends in a newline -1
387 left truncation glyphs: -1
388 right truncation/continuation glyphs next buffer position
389 glyph standing for newline of an empty line buffer position of newline
390 stretch glyph at left edge of R2L lines buffer position of newline */
393 /* Lisp object source of this glyph. Currently either a buffer or a
394 string, if the glyph was produced from characters which came from
395 a buffer or a string; or nil if the glyph was inserted by
396 redisplay for its own purposes, such as padding, truncation, or
397 continuation glyphs, or the overlay-arrow glyphs on TTYs. */
400 /* Width in pixels. */
403 /* Ascent and descent in pixels. */
404 short ascent
, descent
;
406 /* Vertical offset. If < 0, the glyph is displayed raised, if > 0
407 the glyph is displayed lowered. */
410 /* Which kind of glyph this is---character, image etc. Value
411 should be an enumerator of type enum glyph_type. */
414 /* True means this glyph was produced from multibyte text. False
415 means it was produced from unibyte text, i.e. charsets aren't
416 applicable, and encoding is not performed. */
417 bool_bf multibyte_p
: 1;
419 /* True means draw a box line at the left or right side of this
420 glyph. This is part of the implementation of the face attribute
422 bool_bf left_box_line_p
: 1;
423 bool_bf right_box_line_p
: 1;
425 /* True means this glyph's physical ascent or descent is greater
426 than its logical ascent/descent, i.e. it may potentially overlap
427 glyphs above or below it. */
428 bool_bf overlaps_vertically_p
: 1;
430 /* For terminal frames, true means glyph is a padding glyph. Padding
431 glyphs are used for characters whose visual shape consists of
432 more than one glyph (e.g. Asian characters). All but the first
433 glyph of such a glyph sequence have the padding_p flag set. This
434 flag is used only to minimize code changes. A better way would
435 probably be to use the width field of glyphs to express padding.
437 For graphic frames, true means the pixel width of the glyph in a
438 font is 0, but 1-pixel is padded on displaying for correct cursor
439 displaying. The member `pixel_width' above is set to 1. */
440 bool_bf padding_p
: 1;
442 /* True means the actual glyph is not available, draw using `struct
443 glyphless' below instead. This can happen when a font couldn't
444 be loaded, or a character doesn't have a glyph in a font. */
445 bool_bf glyph_not_available_p
: 1;
447 /* True means don't display cursor here. */
448 bool_bf avoid_cursor_p
: 1;
450 /* Resolved bidirectional level of this character [0..127]. */
451 unsigned resolved_level
: 7;
453 /* Resolved bidirectional type of this character, see enum
454 bidi_type_t below. Note that according to UAX#9, only some
455 values (STRONG_L, STRONG_R, WEAK_AN, WEAK_EN, WEAK_BN, and
456 NEUTRAL_B) can appear in the resolved type, so we only reserve
457 space for those that can. */
458 unsigned bidi_type
: 3;
460 #define FACE_ID_BITS 20
462 /* Face of the glyph. This is a realized face ID,
463 an index in the face cache of the frame. */
464 unsigned face_id
: FACE_ID_BITS
;
466 /* Type of font used to display the character glyph. May be used to
467 determine which set of functions to use to obtain font metrics
468 for the glyph. On W32, value should be an enumerator of the type
469 w32_char_font_type. Otherwise it equals FONT_TYPE_UNKNOWN. */
470 unsigned font_type
: 3;
472 /* A union of sub-structures for different glyph types. */
475 /* Metrics of a partial glyph of an image (type == IMAGE_GLYPH). */
476 struct glyph_slice img
;
477 /* Start and end indices of glyphs of a grapheme cluster of a
478 composition (type == COMPOSITE_GLYPH). */
479 struct { int from
, to
; } cmp
;
480 /* Pixel offsets for upper and lower part of the acronym. */
482 short upper_xoff
, upper_yoff
;
483 short lower_xoff
, lower_yoff
;
487 /* A union of sub-structures for different glyph types. */
490 /* Character code for character glyphs (type == CHAR_GLYPH). */
493 /* Sub-structures for type == COMPOSITE_GLYPH. */
496 /* Flag to tell if the composition is automatic or not. */
497 bool_bf automatic
: 1;
498 /* ID of the composition. */
502 /* Image ID for image glyphs (type == IMAGE_GLYPH). */
506 /* Xwidget reference (type == XWIDGET_GLYPH). */
507 struct xwidget
*xwidget
;
510 /* Sub-structure for type == STRETCH_GLYPH. */
513 /* The height of the glyph. */
514 unsigned height
: 16;
516 /* The ascent of the glyph. */
517 unsigned ascent
: 16;
521 /* Sub-stretch for type == GLYPHLESS_GLYPH. */
524 /* Value is an enum of the type glyphless_display_method. */
526 /* True iff this glyph is for a character of no font. */
527 bool_bf for_no_font
: 1;
528 /* Length of acronym or hexadecimal code string (at most 8). */
530 /* Character to display. Actually we need only 22 bits. */
534 /* Used to compare all bit-fields above in one step. */
540 /* Default value of the glyph font_type field. */
542 #define FONT_TYPE_UNKNOWN 0
544 /* Is GLYPH a space? */
546 #define CHAR_GLYPH_SPACE_P(GLYPH) \
547 ((GLYPH).u.ch == SPACEGLYPH && (GLYPH).face_id == DEFAULT_FACE_ID)
549 /* Are glyph slices of glyphs *X and *Y equal? It assumes that both
550 glyphs have the same type.
552 Note: for composition glyphs, we don't have to compare slice.cmp.to
553 because they should be the same if and only if slice.cmp.from are
556 #define GLYPH_SLICE_EQUAL_P(X, Y) \
557 ((X)->type == IMAGE_GLYPH \
558 ? ((X)->slice.img.x == (Y)->slice.img.x \
559 && (X)->slice.img.y == (Y)->slice.img.y \
560 && (X)->slice.img.width == (Y)->slice.img.width \
561 && (X)->slice.img.height == (Y)->slice.img.height) \
562 : ((X)->type != COMPOSITE_GLYPH \
563 || (X)->slice.cmp.from == (Y)->slice.cmp.from))
565 /* Are glyphs *X and *Y displayed equal? */
567 #define GLYPH_EQUAL_P(X, Y) \
568 ((X)->type == (Y)->type \
569 && (X)->u.val == (Y)->u.val \
570 && GLYPH_SLICE_EQUAL_P (X, Y) \
571 && (X)->face_id == (Y)->face_id \
572 && (X)->padding_p == (Y)->padding_p \
573 && (X)->left_box_line_p == (Y)->left_box_line_p \
574 && (X)->right_box_line_p == (Y)->right_box_line_p \
575 && (X)->voffset == (Y)->voffset \
576 && (X)->pixel_width == (Y)->pixel_width)
578 /* Are character codes, faces, padding_ps of glyphs *X and *Y equal? */
580 #define GLYPH_CHAR_AND_FACE_EQUAL_P(X, Y) \
581 ((X)->u.ch == (Y)->u.ch \
582 && (X)->face_id == (Y)->face_id \
583 && (X)->padding_p == (Y)->padding_p)
585 /* Fill a character glyph GLYPH. CODE, FACE_ID, PADDING_P correspond
586 to the bits defined for the typedef `GLYPH' in lisp.h. */
588 #define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P) \
591 (GLYPH).u.ch = (CODE); \
592 (GLYPH).face_id = (FACE_ID); \
593 (GLYPH).padding_p = (PADDING_P); \
597 /* Fill a character type glyph GLYPH from a glyph typedef FROM as
598 defined in lisp.h. */
600 #define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM) \
601 SET_CHAR_GLYPH ((GLYPH), \
602 GLYPH_CHAR ((FROM)), \
603 GLYPH_FACE ((FROM)), \
606 /* Construct a glyph code from a character glyph GLYPH. If the
607 character is multibyte, return -1 as we can't use glyph table for a
608 multibyte character. */
610 #define SET_GLYPH_FROM_CHAR_GLYPH(G, GLYPH) \
613 if ((GLYPH).u.ch < 256) \
614 SET_GLYPH ((G), (GLYPH).u.ch, ((GLYPH).face_id)); \
616 SET_GLYPH ((G), -1, 0); \
620 #define GLYPH_INVALID_P(GLYPH) (GLYPH_CHAR (GLYPH) < 0)
622 /* Is GLYPH a padding glyph? */
624 #define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p
629 /***********************************************************************
631 ***********************************************************************/
635 Glyph memory for frame-based redisplay is allocated from the heap
636 in one vector kept in a glyph pool structure which is stored with
637 the frame. The size of the vector is made large enough to cover
638 all windows on the frame.
640 Both frame and window glyph matrices reference memory from a glyph
641 pool in frame-based redisplay.
643 In window-based redisplay, no glyphs pools exist; windows allocate
644 and free their glyph memory themselves. */
648 /* Vector of glyphs allocated from the heap. */
649 struct glyph
*glyphs
;
651 /* Allocated size of `glyphs'. */
654 /* Number of rows and columns in a matrix. */
660 /***********************************************************************
662 ***********************************************************************/
666 Three kinds of glyph matrices exist:
668 1. Frame glyph matrices. These are used for terminal frames whose
669 redisplay needs a view of the whole screen due to limited terminal
670 capabilities. Frame matrices are used only in the update phase
671 of redisplay. They are built in update_frame and not used after
672 the update has been performed.
674 2. Window glyph matrices on frames having frame glyph matrices.
675 Such matrices are sub-matrices of their corresponding frame matrix,
676 i.e., frame glyph matrices and window glyph matrices share the same
677 glyph memory, which is allocated in the form of a glyph_pool structure.
678 Glyph rows in such a window matrix are slices of frame matrix rows.
680 3. Free-standing window glyph matrices managing their own glyph
681 storage. This form is used in window-based redisplay which
682 includes variable width and height fonts etc.
684 The size of a window's row vector depends on the height of fonts
685 defined on its frame. It is chosen so that the vector is large
686 enough to describe all lines in a window when it is displayed in
687 the smallest possible character size. When new fonts are loaded,
688 or window sizes change, the row vector is adjusted accordingly. */
692 /* The pool from which glyph memory is allocated, if any. This is
693 null for frame matrices and for window matrices managing their
695 struct glyph_pool
*pool
;
697 /* Vector of glyph row structures. The row at nrows - 1 is reserved
698 for the mode line. */
699 struct glyph_row
*rows
;
701 /* Number of elements allocated for the vector rows above. */
702 ptrdiff_t rows_allocated
;
704 /* The number of rows used by the window if all lines were displayed
705 with the smallest possible character height. */
708 /* Origin within the frame matrix if this is a window matrix on a
709 frame having a frame matrix. Both values are zero for
710 window-based redisplay. */
711 int matrix_x
, matrix_y
;
713 /* Width and height of the matrix in columns and rows. */
714 int matrix_w
, matrix_h
;
716 /* If this structure describes a window matrix of window W,
717 window_pixel_left is the value of W->pixel_left, window_pixel_top
718 the value of W->pixel_top, window_height and window_width are width
719 and height of W, as returned by window_box, and window_vscroll is
720 the value of W->vscroll at the time the matrix was last adjusted.
721 Only set for window-based redisplay. */
722 int window_pixel_left
, window_pixel_top
;
723 int window_height
, window_width
;
726 /* Number of glyphs reserved for left and right marginal areas when
727 the matrix was last adjusted. */
728 int left_margin_glyphs
, right_margin_glyphs
;
730 /* Flag indicating that scrolling should not be tried in
731 update_window. This flag is set by functions like try_window_id
732 which do their own scrolling. */
733 bool_bf no_scrolling_p
: 1;
735 /* True means window displayed in this matrix has a header
737 bool_bf header_line_p
: 1;
740 /* A string identifying the method used to display the matrix. */
744 /* The buffer this matrix displays. Set in
745 mark_window_display_accurate_1. */
746 struct buffer
*buffer
;
748 /* Values of BEGV and ZV as of last redisplay. Set in
749 mark_window_display_accurate_1. */
754 /* Check that glyph pointers stored in glyph rows of MATRIX are okay.
755 This aborts if any pointer is found twice. */
758 void check_matrix_pointer_lossage (struct glyph_matrix
*);
759 #define CHECK_MATRIX(MATRIX) check_matrix_pointer_lossage ((MATRIX))
761 #define CHECK_MATRIX(MATRIX) ((void) 0)
766 /***********************************************************************
768 ***********************************************************************/
770 /* Area in window glyph matrix. If values are added or removed,
771 the function mark_glyph_matrix in alloc.c may need to be changed. */
783 /* Rows of glyphs in a windows or frame glyph matrix.
785 Each row is partitioned into three areas. The start and end of
786 each area is recorded in a pointer as shown below.
788 +--------------------+-------------+---------------------+
789 | left margin area | text area | right margin area |
790 +--------------------+-------------+---------------------+
792 glyphs[LEFT_MARGIN_AREA] glyphs[RIGHT_MARGIN_AREA]
797 Rows in frame matrices reference glyph memory allocated in a frame
798 glyph pool (see the description of struct glyph_pool). Rows in
799 window matrices on frames having frame matrices reference slices of
800 the glyphs of corresponding rows in the frame matrix.
802 Rows in window matrices on frames having no frame matrices point to
803 glyphs allocated from the heap via xmalloc;
804 glyphs[LEFT_MARGIN_AREA] is the start address of the allocated
805 glyph structure array.
807 NOTE: layout of first four members of this structure is important,
808 see clear_glyph_row and copy_row_except_pointers to check why. */
812 /* Pointers to beginnings of areas. The end of an area A is found at
813 A + 1 in the vector. The last element of the vector is the end
816 Kludge alert: Even if used[TEXT_AREA] == 0, glyphs[TEXT_AREA][0]'s
817 position field is used. It is -1 if this row does not correspond
818 to any text; it is some buffer position if the row corresponds to
819 an empty display line that displays a line end. This is what old
820 redisplay used to do. (Except in code for terminal frames, this
821 kludge is no longer used, I believe. --gerd).
823 See also start, end, displays_text_p and ends_at_zv_p for cleaner
824 ways to do it. The special meaning of positions 0 and -1 will be
825 removed some day, so don't use it in new code. */
826 struct glyph
*glyphs
[1 + LAST_AREA
];
828 /* Number of glyphs actually filled in areas. This could have size
829 LAST_AREA, but it's 1 + LAST_AREA to simplify offset calculations. */
830 short used
[1 + LAST_AREA
];
832 /* Hash code. This hash code is available as soon as the row
833 is constructed, i.e. after a call to display_line. */
836 /* Window-relative x and y-position of the top-left corner of this
837 row. If y < 0, this means that eabs (y) pixels of the row are
838 invisible because it is partially visible at the top of a window.
839 If x < 0, this means that eabs (x) pixels of the first glyph of
840 the text area of the row are invisible because the glyph is
841 partially visible. */
844 /* Width of the row in pixels without taking face extension at the
845 end of the row into account, and without counting truncation
846 and continuation glyphs at the end of a row on ttys. */
849 /* Logical ascent/height of this line. The value of ascent is zero
850 and height is 1 on terminal frames. */
853 /* Physical ascent/height of this line. If max_ascent > ascent,
854 this line overlaps the line above it on the display. Otherwise,
855 if max_height > height, this line overlaps the line beneath it. */
856 int phys_ascent
, phys_height
;
858 /* Portion of row that is visible. Partially visible rows may be
859 found at the top and bottom of a window. This is 1 for tty
860 frames. It may be < 0 in case of completely invisible rows. */
863 /* Extra line spacing added after this row. Do not consider this
864 in last row when checking if row is fully visible. */
865 int extra_line_spacing
;
867 /* First position in this row. This is the text position, including
868 overlay position information etc, where the display of this row
869 started, and can thus be less than the position of the first
870 glyph (e.g. due to invisible text or horizontal scrolling).
871 BIDI Note: In R2L rows, that have its reversed_p flag set, this
872 position is at or beyond the right edge of the row. */
873 struct display_pos start
;
875 /* Text position at the end of this row. This is the position after
876 the last glyph on this row. It can be greater than the last
877 glyph position + 1, due to a newline that ends the line,
878 truncation, invisible text etc. In an up-to-date display, this
879 should always be equal to the start position of the next row.
880 BIDI Note: In R2L rows, this position is at or beyond the left
882 struct display_pos end
;
884 /* The smallest and the largest buffer positions that contributed to
885 glyphs in this row. Note that due to bidi reordering, these are
886 in general different from the text positions stored in `start'
887 and `end' members above, and also different from the buffer
888 positions recorded in the glyphs displayed the leftmost and
889 rightmost on the screen. */
890 struct text_pos minpos
, maxpos
;
892 /* Non-zero means the overlay arrow bitmap is on this line.
893 -1 means use default overlay arrow bitmap, else
894 it specifies actual fringe bitmap number. */
895 int overlay_arrow_bitmap
;
897 /* Left fringe bitmap number (enum fringe_bitmap_type). */
898 unsigned left_user_fringe_bitmap
: FRINGE_ID_BITS
;
900 /* Right fringe bitmap number (enum fringe_bitmap_type). */
901 unsigned right_user_fringe_bitmap
: FRINGE_ID_BITS
;
903 /* Left fringe bitmap number (enum fringe_bitmap_type). */
904 unsigned left_fringe_bitmap
: FRINGE_ID_BITS
;
906 /* Right fringe bitmap number (enum fringe_bitmap_type). */
907 unsigned right_fringe_bitmap
: FRINGE_ID_BITS
;
909 /* Face of the left fringe glyph. */
910 unsigned left_user_fringe_face_id
: FACE_ID_BITS
;
912 /* Face of the right fringe glyph. */
913 unsigned right_user_fringe_face_id
: FACE_ID_BITS
;
915 /* Face of the left fringe glyph. */
916 unsigned left_fringe_face_id
: FACE_ID_BITS
;
918 /* Face of the right fringe glyph. */
919 unsigned right_fringe_face_id
: FACE_ID_BITS
;
921 /* Vertical offset of the left fringe bitmap. */
922 signed left_fringe_offset
: FRINGE_HEIGHT_BITS
;
924 /* Vertical offset of the right fringe bitmap. */
925 signed right_fringe_offset
: FRINGE_HEIGHT_BITS
;
927 /* True means that at least one of the left and right fringe bitmaps is
928 periodic and thus depends on the y-position of the row. */
929 bool_bf fringe_bitmap_periodic_p
: 1;
931 /* True means that we must draw the bitmaps of this row. */
932 bool_bf redraw_fringe_bitmaps_p
: 1;
934 /* In a desired matrix, true means that this row must be updated. In a
935 current matrix, false means that the row has been invalidated, i.e.
936 the row's contents do not agree with what is visible on the
938 bool_bf enabled_p
: 1;
940 /* True means row displays a text line that is truncated on the left or
942 bool_bf truncated_on_left_p
: 1;
943 bool_bf truncated_on_right_p
: 1;
945 /* True means that this row displays a continued line, i.e. it has a
946 continuation mark at the right side. */
947 bool_bf continued_p
: 1;
949 /* False means that this row does not contain any text, i.e., it is
950 a blank line at the window and buffer end. */
951 bool_bf displays_text_p
: 1;
953 /* True means that this line ends at ZV. */
954 bool_bf ends_at_zv_p
: 1;
956 /* True means the face of the last glyph in the text area is drawn to
957 the right end of the window. This flag is used in
958 update_text_area to optimize clearing to the end of the area. */
959 bool_bf fill_line_p
: 1;
961 /* True means display a bitmap on X frames indicating that this
962 line contains no text and ends in ZV. */
963 bool_bf indicate_empty_line_p
: 1;
965 /* True means this row contains glyphs that overlap each other because
966 of lbearing or rbearing. */
967 bool_bf contains_overlapping_glyphs_p
: 1;
969 /* True means this row is as wide as the window it is displayed in, including
970 scroll bars, fringes, and internal borders. This also
971 implies that the row doesn't have marginal areas. */
972 bool_bf full_width_p
: 1;
974 /* True means row is a mode or header-line. */
975 bool_bf mode_line_p
: 1;
977 /* True in a current row means this row is overlapped by another row. */
978 bool_bf overlapped_p
: 1;
980 /* True means this line ends in the middle of a character consisting
981 of more than one glyph. Some glyphs have been put in this row,
982 the rest are put in rows below this one. */
983 bool_bf ends_in_middle_of_char_p
: 1;
985 /* True means this line starts in the middle of a character consisting
986 of more than one glyph. Some glyphs have been put in the
987 previous row, the rest are put in this row. */
988 bool_bf starts_in_middle_of_char_p
: 1;
990 /* True in a current row means this row overlaps others. */
991 bool_bf overlapping_p
: 1;
993 /* True means some glyphs in this row are displayed in mouse-face. */
994 bool_bf mouse_face_p
: 1;
996 /* True means this row was ended by a newline from a string. */
997 bool_bf ends_in_newline_from_string_p
: 1;
999 /* True means this row width is exactly the width of the window, and the
1000 final newline character is hidden in the right fringe. */
1001 bool_bf exact_window_width_line_p
: 1;
1003 /* True means this row currently shows the cursor in the right fringe. */
1004 bool_bf cursor_in_fringe_p
: 1;
1006 /* True means the last glyph in the row is part of an ellipsis. */
1007 bool_bf ends_in_ellipsis_p
: 1;
1009 /* True means display a bitmap on X frames indicating that this
1010 the first line of the buffer. */
1011 bool_bf indicate_bob_p
: 1;
1013 /* True means display a bitmap on X frames indicating that this
1014 the top line of the window, but not start of the buffer. */
1015 bool_bf indicate_top_line_p
: 1;
1017 /* True means display a bitmap on X frames indicating that this
1018 the last line of the buffer. */
1019 bool_bf indicate_eob_p
: 1;
1021 /* True means display a bitmap on X frames indicating that this
1022 the bottom line of the window, but not end of the buffer. */
1023 bool_bf indicate_bottom_line_p
: 1;
1025 /* True means the row was reversed to display text in a
1026 right-to-left paragraph. */
1027 bool_bf reversed_p
: 1;
1029 /* Continuation lines width at the start of the row. */
1030 int continuation_lines_width
;
1032 #ifdef HAVE_WINDOW_SYSTEM
1033 /* Non-NULL means the current clipping area. This is temporarily
1034 set while exposing a region. Coordinates are frame-relative. */
1040 /* Get a pointer to row number ROW in matrix MATRIX. If GLYPH_DEBUG
1041 is defined, the function matrix_row checks that we don't try to
1042 access rows that are out of bounds. */
1045 struct glyph_row
*matrix_row (struct glyph_matrix
*, int);
1046 #define MATRIX_ROW(MATRIX, ROW) matrix_row ((MATRIX), (ROW))
1048 #define MATRIX_ROW(MATRIX, ROW) ((MATRIX)->rows + (ROW))
1051 /* Return a pointer to the row reserved for the mode line in MATRIX.
1052 Row MATRIX->nrows - 1 is always reserved for the mode line. */
1054 #define MATRIX_MODE_LINE_ROW(MATRIX) \
1055 ((MATRIX)->rows + (MATRIX)->nrows - 1)
1057 /* Return a pointer to the row reserved for the header line in MATRIX.
1058 This is always the first row in MATRIX because that's the only
1059 way that works in frame-based redisplay. */
1061 #define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows
1063 /* Return a pointer to first row in MATRIX used for text display. */
1065 #define MATRIX_FIRST_TEXT_ROW(MATRIX) \
1066 ((MATRIX)->rows->mode_line_p ? (MATRIX)->rows + 1 : (MATRIX)->rows)
1068 /* Return a pointer to the first glyph in the text area of a row.
1069 MATRIX is the glyph matrix accessed, and ROW is the row index in
1072 #define MATRIX_ROW_GLYPH_START(MATRIX, ROW) \
1073 (MATRIX_ROW ((MATRIX), (ROW))->glyphs[TEXT_AREA])
1075 /* Return the number of used glyphs in the text area of a row. */
1077 #define MATRIX_ROW_USED(MATRIX, ROW) \
1078 (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA])
1080 /* Return the character/ byte position at which the display of ROW
1081 starts. BIDI Note: this is the smallest character/byte position
1082 among characters in ROW, i.e. the first logical-order character
1083 displayed by ROW, which is not necessarily the smallest horizontal
1086 #define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->minpos.charpos)
1087 #define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->minpos.bytepos)
1089 /* Return the character/ byte position at which ROW ends. BIDI Note:
1090 this is the largest character/byte position among characters in
1091 ROW, i.e. the last logical-order character displayed by ROW, which
1092 is not necessarily the largest horizontal position. */
1094 #define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->maxpos.charpos)
1095 #define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->maxpos.bytepos)
1097 /* Return the vertical position of ROW in MATRIX. */
1099 #define MATRIX_ROW_VPOS(ROW, MATRIX) ((ROW) - (MATRIX)->rows)
1101 /* Return the last glyph row + 1 in MATRIX on window W reserved for
1102 text. If W has a mode line, the last row in the matrix is reserved
1105 #define MATRIX_BOTTOM_TEXT_ROW(MATRIX, W) \
1108 - (WINDOW_WANTS_MODELINE_P ((W)) ? 1 : 0))
1110 /* Non-zero if the face of the last glyph in ROW's text area has
1111 to be drawn to the end of the text area. */
1113 #define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)
1115 /* Set and query the enabled_p flag of glyph row ROW in MATRIX. */
1117 #define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
1118 (MATRIX_ROW (MATRIX, ROW)->enabled_p = (VALUE))
1120 #define MATRIX_ROW_ENABLED_P(MATRIX, ROW) \
1121 (MATRIX_ROW (MATRIX, ROW)->enabled_p)
1123 /* Non-zero if ROW displays text. Value is non-zero if the row is
1124 blank but displays a line end. */
1126 #define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)
1131 #define MR_PARTIALLY_VISIBLE(ROW) \
1132 ((ROW)->height != (ROW)->visible_height)
1134 #define MR_PARTIALLY_VISIBLE_AT_TOP(W, ROW) \
1135 ((ROW)->y < WINDOW_HEADER_LINE_HEIGHT ((W)))
1137 #define MR_PARTIALLY_VISIBLE_AT_BOTTOM(W, ROW) \
1138 (((ROW)->y + (ROW)->height - (ROW)->extra_line_spacing) \
1139 > WINDOW_BOX_HEIGHT_NO_MODE_LINE ((W)))
1141 /* Non-zero if ROW is not completely visible in window W. */
1143 #define MATRIX_ROW_PARTIALLY_VISIBLE_P(W, ROW) \
1144 (MR_PARTIALLY_VISIBLE ((ROW)) \
1145 && (MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)) \
1146 || MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW))))
1150 /* Non-zero if ROW is partially visible at the top of window W. */
1152 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW) \
1153 (MR_PARTIALLY_VISIBLE ((ROW)) \
1154 && MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)))
1156 /* Non-zero if ROW is partially visible at the bottom of window W. */
1158 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW) \
1159 (MR_PARTIALLY_VISIBLE ((ROW)) \
1160 && MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW)))
1162 /* Return the bottom Y + 1 of ROW. */
1164 #define MATRIX_ROW_BOTTOM_Y(ROW) ((ROW)->y + (ROW)->height)
1166 /* Is ROW the last visible one in the display described by the
1167 iterator structure pointed to by IT?. */
1169 #define MATRIX_ROW_LAST_VISIBLE_P(ROW, IT) \
1170 (MATRIX_ROW_BOTTOM_Y ((ROW)) >= (IT)->last_visible_y)
1172 /* Non-zero if ROW displays a continuation line. */
1174 #define MATRIX_ROW_CONTINUATION_LINE_P(ROW) \
1175 ((ROW)->continuation_lines_width > 0)
1177 /* Non-zero if ROW ends in the middle of a character. This is the
1178 case for continued lines showing only part of a display table entry
1179 or a control char, or an overlay string. */
1181 #define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW) \
1182 ((ROW)->end.dpvec_index > 0 \
1183 || (ROW)->end.overlay_string_index >= 0 \
1184 || (ROW)->ends_in_middle_of_char_p)
1186 /* Non-zero if ROW ends in the middle of an overlay string. */
1188 #define MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P(ROW) \
1189 ((ROW)->end.overlay_string_index >= 0)
1191 /* Non-zero if ROW starts in the middle of a character. See above. */
1193 #define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW) \
1194 ((ROW)->start.dpvec_index > 0 \
1195 || (ROW)->starts_in_middle_of_char_p \
1196 || ((ROW)->start.overlay_string_index >= 0 \
1197 && (ROW)->start.string_pos.charpos > 0))
1199 /* True means ROW overlaps its predecessor. */
1201 #define MATRIX_ROW_OVERLAPS_PRED_P(ROW) \
1202 ((ROW)->phys_ascent > (ROW)->ascent)
1204 /* True means ROW overlaps its successor. */
1206 #define MATRIX_ROW_OVERLAPS_SUCC_P(ROW) \
1207 ((ROW)->phys_height - (ROW)->phys_ascent \
1208 > (ROW)->height - (ROW)->ascent)
1210 /* A glyph for a space. */
1212 extern struct glyph space_glyph
;
1214 /* True means last display completed. False means it was preempted. */
1216 extern bool display_completed
;
1220 /************************************************************************
1222 ************************************************************************/
1224 /* Enumeration for overriding/changing the face to use for drawing
1225 glyphs in draw_glyphs. */
1227 enum draw_glyphs_face
1237 #ifdef HAVE_WINDOW_SYSTEM
1239 /* A sequence of glyphs to be drawn in the same face. */
1243 /* X-origin of the string. */
1246 /* Y-origin and y-position of the base line of this string. */
1249 /* The width of the string, not including a face extension. */
1252 /* The width of the string, including a face extension. */
1253 int background_width
;
1255 /* The height of this string. This is the height of the line this
1256 string is drawn in, and can be different from the height of the
1257 font the string is drawn in. */
1260 /* Number of pixels this string overwrites in front of its x-origin.
1261 This number is zero if the string has an lbearing >= 0; it is
1262 -lbearing, if the string has an lbearing < 0. */
1265 /* Number of pixels this string overwrites past its right-most
1266 nominal x-position, i.e. x + width. Zero if the string's
1267 rbearing is <= its nominal width, rbearing - width otherwise. */
1270 /* The frame on which the glyph string is drawn. */
1273 /* The window on which the glyph string is drawn. */
1276 /* X display and window for convenience. */
1280 /* The glyph row for which this string was built. It determines the
1281 y-origin and height of the string. */
1282 struct glyph_row
*row
;
1284 /* The area within row. */
1285 enum glyph_row_area area
;
1287 /* Characters to be drawn, and number of characters. */
1291 /* A face-override for drawing cursors, mouse face and similar. */
1292 enum draw_glyphs_face hl
;
1294 /* Face in which this string is to be drawn. */
1297 /* Font in which this string is to be drawn. */
1300 /* Non-null means this string describes (part of) a static
1302 struct composition
*cmp
;
1304 /* If not negative, this string describes a compos. */
1307 /* Start and end glyph indices in a glyph-string. */
1308 int cmp_from
, cmp_to
;
1310 /* True means this glyph strings face has to be drawn to the right end
1311 of the window's drawing area. */
1312 bool_bf extends_to_end_of_line_p
: 1;
1314 /* True means the background of this string has been drawn. */
1315 bool_bf background_filled_p
: 1;
1317 /* True means that the original font determined for drawing this glyph
1318 string could not be loaded. The member `font' has been set to
1319 the frame's default font in this case. */
1320 bool_bf font_not_found_p
: 1;
1322 /* True means that the face in which this glyph string is drawn has a
1324 bool_bf stippled_p
: 1;
1326 #define OVERLAPS_PRED (1 << 0)
1327 #define OVERLAPS_SUCC (1 << 1)
1328 #define OVERLAPS_BOTH (OVERLAPS_PRED | OVERLAPS_SUCC)
1329 #define OVERLAPS_ERASED_CURSOR (1 << 2)
1330 /* Non-zero means only the foreground of this glyph string must be
1331 drawn, and we should use the physical height of the line this
1332 glyph string appears in as clip rect. If the value is
1333 OVERLAPS_ERASED_CURSOR, the clip rect is restricted to the rect
1334 of the erased cursor. OVERLAPS_PRED and OVERLAPS_SUCC mean we
1335 draw overlaps with the preceding and the succeeding rows,
1337 unsigned for_overlaps
: 3;
1339 /* True means that all glyphs in this glyph string has the flag
1340 padding_p set, and thus must be drawn one by one to have 1-pixel
1341 width even though the logical width in the font is zero. */
1342 bool_bf padding_p
: 1;
1344 /* The GC to use for drawing this glyph string. */
1345 #if defined (HAVE_X_WINDOWS)
1348 #if defined (HAVE_NTGUI)
1353 /* A pointer to the first glyph in the string. This glyph
1354 corresponds to char2b[0]. Needed to draw rectangles if
1355 font_not_found_p is true. */
1356 struct glyph
*first_glyph
;
1358 /* Image, if any. */
1362 struct xwidget
*xwidget
;
1365 struct glyph_slice slice
;
1367 /* Non-null means the horizontal clipping region starts from the
1368 left edge of *clip_head, and ends with the right edge of
1369 *clip_tail, not including their overhangs. */
1370 struct glyph_string
*clip_head
, *clip_tail
;
1372 /* The current clipping areas. */
1373 NativeRectangle clip
[2];
1375 /* Number of clipping areas. */
1378 int underline_position
;
1380 int underline_thickness
;
1382 struct glyph_string
*next
, *prev
;
1385 #endif /* HAVE_WINDOW_SYSTEM */
1388 /************************************************************************
1390 ************************************************************************/
1392 /* Return the height of the mode line in glyph matrix MATRIX, or zero
1393 if not known. This macro is called under circumstances where
1394 MATRIX might not have been allocated yet. */
1396 #define MATRIX_MODE_LINE_HEIGHT(MATRIX) \
1397 ((MATRIX) && (MATRIX)->rows \
1398 ? MATRIX_MODE_LINE_ROW (MATRIX)->height \
1401 /* Return the height of the header line in glyph matrix MATRIX, or zero
1402 if not known. This macro is called under circumstances where
1403 MATRIX might not have been allocated yet. */
1405 #define MATRIX_HEADER_LINE_HEIGHT(MATRIX) \
1406 ((MATRIX) && (MATRIX)->rows \
1407 ? MATRIX_HEADER_LINE_ROW (MATRIX)->height \
1410 /* Return the desired face id for the mode line of a window, depending
1411 on whether the window is selected or not, or if the window is the
1412 scrolling window for the currently active minibuffer window.
1414 Due to the way display_mode_lines manipulates with the contents of
1415 selected_window, this macro needs three arguments: SELW which is
1416 compared against the current value of selected_window, MBW which is
1417 compared against minibuf_window (if SELW doesn't match), and SCRW
1418 which is compared against minibuf_selected_window (if MBW matches). */
1420 #define CURRENT_MODE_LINE_FACE_ID_3(SELW, MBW, SCRW) \
1421 ((!mode_line_in_non_selected_windows \
1422 || (SELW) == XWINDOW (selected_window) \
1423 || (minibuf_level > 0 \
1424 && !NILP (minibuf_selected_window) \
1425 && (MBW) == XWINDOW (minibuf_window) \
1426 && (SCRW) == XWINDOW (minibuf_selected_window))) \
1427 ? MODE_LINE_FACE_ID \
1428 : MODE_LINE_INACTIVE_FACE_ID)
1431 /* Return the desired face id for the mode line of window W. */
1433 #define CURRENT_MODE_LINE_FACE_ID(W) \
1434 (CURRENT_MODE_LINE_FACE_ID_3((W), XWINDOW (selected_window), (W)))
1436 /* Return the current height of the mode line of window W. If not known
1437 from W->mode_line_height, look at W's current glyph matrix, or return
1438 a default based on the height of the font of the face `mode-line'. */
1440 #define CURRENT_MODE_LINE_HEIGHT(W) \
1441 (W->mode_line_height >= 0 \
1442 ? W->mode_line_height \
1443 : (W->mode_line_height \
1444 = (MATRIX_MODE_LINE_HEIGHT (W->current_matrix) \
1445 ? MATRIX_MODE_LINE_HEIGHT (W->current_matrix) \
1446 : estimate_mode_line_height \
1447 (XFRAME (W->frame), CURRENT_MODE_LINE_FACE_ID (W)))))
1449 /* Return the current height of the header line of window W. If not known
1450 from W->header_line_height, look at W's current glyph matrix, or return
1451 an estimation based on the height of the font of the face `header-line'. */
1453 #define CURRENT_HEADER_LINE_HEIGHT(W) \
1454 (W->header_line_height >= 0 \
1455 ? W->header_line_height \
1456 : (W->header_line_height \
1457 = (MATRIX_HEADER_LINE_HEIGHT (W->current_matrix) \
1458 ? MATRIX_HEADER_LINE_HEIGHT (W->current_matrix) \
1459 : estimate_mode_line_height \
1460 (XFRAME (W->frame), HEADER_LINE_FACE_ID))))
1462 /* Return the height of the desired mode line of window W. */
1464 #define DESIRED_MODE_LINE_HEIGHT(W) \
1465 MATRIX_MODE_LINE_HEIGHT ((W)->desired_matrix)
1467 /* Return the height of the desired header line of window W. */
1469 #define DESIRED_HEADER_LINE_HEIGHT(W) \
1470 MATRIX_HEADER_LINE_HEIGHT ((W)->desired_matrix)
1472 /* PXW: The height checks below serve to show at least one text line
1473 instead of a mode- and/or header line when a window gets very small.
1474 But (1) the check fails when the mode- or header-line is taller than
1475 the associated frame's line height and (2) we don't care much about
1476 text visibility anyway when shrinking a frame containing a toolbar.
1478 So maybe these checks should be removed and any clipping left to the
1481 /* Value is true if window W wants a mode line and is large enough
1482 to accommodate it. */
1483 #define WINDOW_WANTS_MODELINE_P(W) \
1484 (BUFFERP ((W)->contents) \
1485 ? (!MINI_WINDOW_P (W) \
1486 && !(W)->pseudo_window_p \
1487 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME (W))) \
1488 && !NILP (BVAR (XBUFFER ((W)->contents), mode_line_format)) \
1489 && WINDOW_PIXEL_HEIGHT (W) > WINDOW_FRAME_LINE_HEIGHT (W)) \
1492 /* Value is true if window W wants a header line and is large enough
1493 to accommodate it. */
1494 #define WINDOW_WANTS_HEADER_LINE_P(W) \
1495 (BUFFERP ((W)->contents) \
1496 ? (!MINI_WINDOW_P (W) \
1497 && !(W)->pseudo_window_p \
1498 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME (W))) \
1499 && !NILP (BVAR (XBUFFER ((W)->contents), header_line_format)) \
1500 && (WINDOW_PIXEL_HEIGHT (W) \
1501 > (WINDOW_WANTS_MODELINE_P (W) \
1502 ? (2 * WINDOW_FRAME_LINE_HEIGHT (W)) \
1503 : WINDOW_FRAME_LINE_HEIGHT (W)))) \
1506 /* Return proper value to be used as baseline offset of font that has
1507 ASCENT and DESCENT to draw characters by the font at the vertical
1508 center of the line of frame F.
1510 Here, our task is to find the value of BOFF in the following figure;
1512 -------------------------+-----------+-
1513 -+-+---------+-+ | |
1515 | | | | F_ASCENT F_HEIGHT
1518 | | |-|-+------+-----------|------- baseline
1520 | |---------|-+-+ | |
1522 -+-+---------+-+ F_DESCENT |
1523 -------------------------+-----------+-
1525 -BOFF + DESCENT + (F_HEIGHT - HEIGHT) / 2 = F_DESCENT
1526 BOFF = DESCENT + (F_HEIGHT - HEIGHT) / 2 - F_DESCENT
1527 DESCENT = FONT->descent
1528 HEIGHT = FONT_HEIGHT (FONT)
1529 F_DESCENT = (FRAME_FONT (F)->descent
1530 - F->terminal->output_data.x->baseline_offset)
1531 F_HEIGHT = FRAME_LINE_HEIGHT (F)
1534 #define VCENTER_BASELINE_OFFSET(FONT, F) \
1535 (FONT_DESCENT (FONT) \
1536 + (FRAME_LINE_HEIGHT ((F)) - FONT_HEIGHT ((FONT)) \
1537 + (FRAME_LINE_HEIGHT ((F)) > FONT_HEIGHT ((FONT)))) / 2 \
1538 - (FONT_DESCENT (FRAME_FONT (F)) - FRAME_BASELINE_OFFSET (F)))
1540 /* A heuristic test for fonts that claim they need a preposterously
1541 large vertical space. The heuristics is in the factor of 3. We
1542 ignore the ascent and descent values reported by such fonts, and
1543 instead go by the values reported for individual glyphs. */
1544 #define FONT_TOO_HIGH(ft) ((ft)->ascent + (ft)->descent > 3*(ft)->pixel_size)
1547 /***********************************************************************
1549 ***********************************************************************/
1551 /* Indices of face attributes in Lisp face vectors. Slot zero is the
1554 enum lface_attribute_index
1556 LFACE_FAMILY_INDEX
= 1,
1557 LFACE_FOUNDRY_INDEX
,
1562 LFACE_UNDERLINE_INDEX
,
1563 LFACE_INVERSE_INDEX
,
1564 LFACE_FOREGROUND_INDEX
,
1565 LFACE_BACKGROUND_INDEX
,
1566 LFACE_STIPPLE_INDEX
,
1567 LFACE_OVERLINE_INDEX
,
1568 LFACE_STRIKE_THROUGH_INDEX
,
1571 LFACE_INHERIT_INDEX
,
1572 LFACE_FONTSET_INDEX
,
1573 LFACE_DISTANT_FOREGROUND_INDEX
,
1578 /* Box types of faces. */
1582 /* No box around text. */
1585 /* Simple box of specified width and color. Default width is 1, and
1586 default color is the foreground color of the face. */
1589 /* Boxes with 3D shadows. Color equals the background color of the
1590 face. Width is specified. */
1595 /* Underline type. */
1597 enum face_underline_type
1603 /* Structure describing a realized face.
1605 For each Lisp face, 0..N realized faces can exist for different
1606 frames and different charsets. Realized faces are built from Lisp
1607 faces and text properties/overlays by merging faces and adding
1608 unspecified attributes from the `default' face. */
1612 /* The Lisp face attributes this face realizes. All attributes
1613 in this vector are non-nil. */
1614 Lisp_Object lface
[LFACE_VECTOR_SIZE
];
1616 /* The id of this face. The id equals the index of this face in the
1617 vector faces_by_id of its face cache. */
1620 #ifdef HAVE_WINDOW_SYSTEM
1622 /* If non-zero, this is a GC that we can use without modification for
1623 drawing the characters in this face. */
1626 /* Background stipple or bitmap used for this face. This is
1627 an id as returned from load_pixmap. */
1630 #endif /* not HAVE_WINDOW_SYSTEM */
1632 /* Pixel value of foreground color for X frames. Color index
1634 unsigned long foreground
;
1636 /* Pixel value or color index of background color. */
1637 unsigned long background
;
1639 /* Pixel value or color index of underline color. */
1640 unsigned long underline_color
;
1642 /* Pixel value or color index of overlined, strike-through, or box
1644 unsigned long overline_color
;
1645 unsigned long strike_through_color
;
1646 unsigned long box_color
;
1650 /* Fontset ID if for this face's fontset. Non-ASCII faces derived
1651 from the same ASCII face have the same fontset. */
1654 /* Non-zero means characters in this face have a box of that
1655 thickness around them. If this value is negative, its absolute
1656 value indicates the thickness, and the horizontal (top and
1657 bottom) borders of box are drawn inside of the character glyphs'
1658 area. The vertical (left and right) borders of the box are drawn
1659 in the same way as when this value is positive. */
1662 /* Type of box drawn. A value of FACE_NO_BOX means no box is drawn
1663 around text in this face. A value of FACE_SIMPLE_BOX means a box
1664 of width box_line_width is drawn in color box_color. A value of
1665 FACE_RAISED_BOX or FACE_SUNKEN_BOX means a 3D box is drawn with
1666 shadow colors derived from the background color of the face. */
1667 ENUM_BF (face_box_type
) box
: 2;
1669 /* Style of underlining. */
1670 ENUM_BF (face_underline_type
) underline_type
: 1;
1672 /* If `box' above specifies a 3D type, true means use box_color for
1674 bool_bf use_box_color_for_shadows_p
: 1;
1676 /* Non-zero if text in this face should be underlined, overlined,
1677 strike-through or have a box drawn around it. */
1678 bool_bf underline_p
: 1;
1679 bool_bf overline_p
: 1;
1680 bool_bf strike_through_p
: 1;
1682 /* True means that the colors specified for this face could not be
1683 loaded, and were replaced by default colors, so they shouldn't be
1685 bool_bf foreground_defaulted_p
: 1;
1686 bool_bf background_defaulted_p
: 1;
1688 /* True means that either no color is specified for underlining or that
1689 the specified color couldn't be loaded. Use the foreground
1690 color when drawing in that case. */
1691 bool_bf underline_defaulted_p
: 1;
1693 /* True means that either no color is specified for the corresponding
1694 attribute or that the specified color couldn't be loaded.
1695 Use the foreground color when drawing in that case. */
1696 bool_bf overline_color_defaulted_p
: 1;
1697 bool_bf strike_through_color_defaulted_p
: 1;
1698 bool_bf box_color_defaulted_p
: 1;
1700 /* TTY appearances. Colors are found in `lface' with empty color
1701 string meaning the default color of the TTY. */
1702 bool_bf tty_bold_p
: 1;
1703 bool_bf tty_italic_p
: 1;
1704 bool_bf tty_underline_p
: 1;
1705 bool_bf tty_reverse_p
: 1;
1707 /* True means that colors of this face may not be freed because they
1708 have been copied bitwise from a base face (see
1710 bool_bf colors_copied_bitwise_p
: 1;
1712 /* If non-zero, use overstrike (to simulate bold-face). */
1713 bool_bf overstrike
: 1;
1715 /* NOTE: this is not used yet, but eventually this impl should be done
1716 similarly to overstrike */
1718 /* If non-zero, use geometric rotation (to simulate italic). */
1719 bool_bf synth_ital
: 1;
1722 /* The hash value of this face. */
1725 /* Next and previous face in hash collision list of face cache. */
1726 struct face
*next
, *prev
;
1728 /* If this face is an ASCII face, this points to this face itself.
1729 Otherwise, this points to an ASCII face that has the same
1730 attributes except the font. */
1731 struct face
*ascii_face
;
1733 #if defined HAVE_XFT || defined HAVE_FREETYPE
1734 /* Extra member that a font-driver uses privately. */
1740 /* Color index indicating that face uses a terminal's default color. */
1742 #define FACE_TTY_DEFAULT_COLOR ((unsigned long) -1)
1744 /* Color index indicating that face uses an unknown foreground color. */
1746 #define FACE_TTY_DEFAULT_FG_COLOR ((unsigned long) -2)
1748 /* Color index indicating that face uses an unknown background color. */
1750 #define FACE_TTY_DEFAULT_BG_COLOR ((unsigned long) -3)
1752 /* True if COLOR is a specified (i.e., nondefault) foreground or
1753 background color for a tty face. */
1756 face_tty_specified_color (unsigned long color
)
1758 return color
< FACE_TTY_DEFAULT_BG_COLOR
;
1761 /* Non-zero if FACE was realized for unibyte use. */
1763 #define FACE_UNIBYTE_P(FACE) ((FACE)->charset < 0)
1766 /* IDs of important faces known by the C face code. These are the IDs
1767 of the faces for CHARSET_ASCII. */
1773 MODE_LINE_INACTIVE_FACE_ID
,
1776 HEADER_LINE_FACE_ID
,
1782 VERTICAL_BORDER_FACE_ID
,
1783 WINDOW_DIVIDER_FACE_ID
,
1784 WINDOW_DIVIDER_FIRST_PIXEL_FACE_ID
,
1785 WINDOW_DIVIDER_LAST_PIXEL_FACE_ID
,
1786 BASIC_FACE_ID_SENTINEL
1789 #define MAX_FACE_ID ((1 << FACE_ID_BITS) - 1)
1791 /* A cache of realized faces. Each frame has its own cache because
1792 Emacs allows different frame-local face definitions. */
1796 /* Hash table of cached realized faces. */
1797 struct face
**buckets
;
1799 /* Back-pointer to the frame this cache belongs to. */
1802 /* A vector of faces so that faces can be referenced by an ID. */
1803 struct face
**faces_by_id
;
1805 /* The allocated size, and number of used slots of faces_by_id. */
1809 /* Flag indicating that attributes of the `menu' face have been
1811 bool_bf menu_face_changed_p
: 1;
1814 /* Return a pointer to the cached face with ID on frame F. */
1816 #define FACE_FROM_ID(F, ID) \
1817 (eassert (UNSIGNED_CMP (ID, <, FRAME_FACE_CACHE (F)->used)), \
1818 FRAME_FACE_CACHE (F)->faces_by_id[ID])
1820 /* Return a pointer to the face with ID on frame F, or null if such a
1821 face doesn't exist. */
1823 #define FACE_OPT_FROM_ID(F, ID) \
1824 (UNSIGNED_CMP (ID, <, FRAME_FACE_CACHE (F)->used) \
1825 ? FACE_FROM_ID (F, ID) \
1828 #ifdef HAVE_WINDOW_SYSTEM
1830 /* Non-zero if FACE is suitable for displaying character CHAR. */
1832 #define FACE_SUITABLE_FOR_ASCII_CHAR_P(FACE, CHAR) \
1833 ((FACE) == (FACE)->ascii_face)
1835 /* Return the id of the realized face on frame F that is like the face
1836 FACE, but is suitable for displaying character CHAR at buffer or
1837 string position POS. OBJECT is the string object, or nil for
1838 buffer. This macro is only meaningful for multibyte character
1841 #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) \
1842 face_for_char ((F), (FACE), (CHAR), (POS), (OBJECT))
1844 #else /* not HAVE_WINDOW_SYSTEM */
1846 #define FACE_SUITABLE_FOR_ASCII_CHAR_P(FACE, CHAR) \
1847 ((void) (FACE), (void) (CHAR), true)
1848 #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) \
1849 ((void) (F), (void) (FACE), (void) (CHAR), (void) (POS), \
1850 (void) (OBJECT), (FACE)->id)
1852 #endif /* not HAVE_WINDOW_SYSTEM */
1854 /* Return true if G contains a valid character code. */
1856 GLYPH_CHAR_VALID_P (GLYPH g
)
1858 return CHAR_VALID_P (GLYPH_CHAR (g
));
1861 /* The glyph code from a display vector may either be an integer which
1862 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1863 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1866 GLYPH_CODE_P (Lisp_Object gc
)
1869 ? (CHARACTERP (XCAR (gc
))
1870 && RANGED_INTEGERP (0, XCDR (gc
), MAX_FACE_ID
))
1873 (MAX_FACE_ID
< TYPE_MAXIMUM (EMACS_INT
) >> CHARACTERBITS
1874 ? ((EMACS_INT
) MAX_FACE_ID
<< CHARACTERBITS
) | MAX_CHAR
1875 : TYPE_MAXIMUM (EMACS_INT
)))));
1878 /* True means face attributes have been changed since the last
1879 redisplay. Used in redisplay_internal. */
1881 extern bool face_change
;
1883 /* For reordering of bidirectional text. */
1885 /* UAX#9's max_depth value. */
1886 #define BIDI_MAXDEPTH 125
1888 /* Data type for describing the bidirectional character types. The
1889 first 7 must be at the beginning, because they are the only values
1890 valid in the `bidi_type' member of `struct glyph'; we only reserve
1891 3 bits for it, so we cannot use there values larger than 7.
1893 The order of members must be in sync with the 8th element of the
1894 member of unidata-prop-alist (in admin/unidata/unidata-gen.el) for
1895 Unicode character property `bidi-class'. */
1898 STRONG_L
, /* strong left-to-right */
1899 STRONG_R
, /* strong right-to-left */
1900 WEAK_EN
, /* european number */
1901 WEAK_AN
, /* arabic number */
1902 WEAK_BN
, /* boundary neutral */
1903 NEUTRAL_B
, /* paragraph separator */
1904 STRONG_AL
, /* arabic right-to-left letter */
1905 LRE
, /* left-to-right embedding */
1906 LRO
, /* left-to-right override */
1907 RLE
, /* right-to-left embedding */
1908 RLO
, /* right-to-left override */
1909 PDF
, /* pop directional format */
1910 LRI
, /* left-to-right isolate */
1911 RLI
, /* right-to-left isolate */
1912 FSI
, /* first strong isolate */
1913 PDI
, /* pop directional isolate */
1914 WEAK_ES
, /* european number separator */
1915 WEAK_ET
, /* european number terminator */
1916 WEAK_CS
, /* common separator */
1917 WEAK_NSM
, /* non-spacing mark */
1918 NEUTRAL_S
, /* segment separator */
1919 NEUTRAL_WS
, /* whitespace */
1920 NEUTRAL_ON
/* other neutrals */
1923 /* Data type for describing the Bidi Paired Bracket Type of a character.
1925 The order of members must be in sync with the 8th element of the
1926 member of unidata-prop-alist (in admin/unidata/unidata-gen.el) for
1927 Unicode character property `bracket-type'. */
1929 BIDI_BRACKET_NONE
= 1,
1932 } bidi_bracket_type_t
;
1934 /* The basic directionality data type. */
1935 typedef enum { NEUTRAL_DIR
= 0, L2R
, R2L
} bidi_dir_t
;
1937 /* Data type for storing information about characters we need to
1939 struct bidi_saved_info
{
1940 ptrdiff_t charpos
; /* character's buffer position */
1941 bidi_type_t type
; /* character's resolved bidi type */
1942 bidi_type_t orig_type
; /* bidi type as we found it in the buffer */
1945 /* Data type for keeping track of information about saved embedding
1946 levels, override status, isolate status, and isolating sequence
1947 runs. This should be as tightly packed as possible, because there
1948 are 127 such entries in each iterator state, and so the size of
1949 cache is directly affected by the size of this struct. */
1951 ptrdiff_t next_for_neutral_pos
;
1952 unsigned next_for_neutral_type
: 3;
1953 unsigned last_strong_type
: 3;
1954 unsigned prev_for_neutral_type
: 3;
1955 unsigned char level
;
1956 unsigned char flags
; /* sos, override, isolate_status */
1959 /* Data type for storing information about a string being iterated on. */
1960 struct bidi_string_data
{
1961 Lisp_Object lstring
; /* Lisp string to reorder, or nil */
1962 const unsigned char *s
; /* string data, or NULL if reordering buffer */
1963 ptrdiff_t schars
; /* the number of characters in the string,
1964 excluding the terminating null */
1965 ptrdiff_t bufpos
; /* buffer position of lstring, or 0 if N/A */
1966 bool_bf from_disp_str
: 1; /* True means the string comes from a
1968 bool_bf unibyte
: 1; /* True means the string is unibyte */
1971 /* Data type for reordering bidirectional text. */
1973 ptrdiff_t bytepos
; /* iterator's position in buffer/string */
1975 int ch
; /* character at that position, or u+FFFC
1976 ("object replacement character") for a run
1977 of characters covered by a display string */
1978 ptrdiff_t nchars
; /* its "length", usually 1; it's > 1 for a run
1979 of characters covered by a display string */
1980 ptrdiff_t ch_len
; /* its length in bytes */
1981 bidi_type_t type
; /* final bidi type of this character, after
1982 resolving weak and neutral types */
1983 bidi_type_t type_after_wn
; /* bidi type after overrides and Wn */
1984 bidi_type_t orig_type
; /* original bidi type, as found in the buffer */
1985 signed char resolved_level
; /* final resolved level of this character */
1986 signed char isolate_level
; /* count of isolate initiators unmatched by PDI */
1987 ptrdiff_t invalid_levels
; /* how many PDFs to ignore */
1988 ptrdiff_t invalid_isolates
; /* how many PDIs to ignore */
1989 struct bidi_saved_info prev
; /* info about previous character */
1990 struct bidi_saved_info last_strong
; /* last-seen strong directional char */
1991 struct bidi_saved_info next_for_neutral
; /* surrounding characters for... */
1992 struct bidi_saved_info prev_for_neutral
; /* ...resolving neutrals */
1993 struct bidi_saved_info next_for_ws
; /* character after sequence of ws */
1994 ptrdiff_t bracket_pairing_pos
; /* position of pairing bracket */
1995 bidi_type_t bracket_enclosed_type
; /* type for bracket resolution */
1996 ptrdiff_t next_en_pos
; /* pos. of next char for determining ET type */
1997 bidi_type_t next_en_type
; /* type of char at next_en_pos */
1998 bidi_dir_t sos
; /* direction of start-of-sequence in effect */
1999 int scan_dir
; /* direction of text scan, 1: forw, -1: back */
2000 ptrdiff_t disp_pos
; /* position of display string after ch */
2001 int disp_prop
; /* if non-zero, there really is a
2002 `display' property/string at disp_pos;
2003 if 2, the property is a `space' spec */
2004 int stack_idx
; /* index of current data on the stack */
2005 /* Note: Everything from here on is not copied/saved when the bidi
2006 iterator state is saved, pushed, or popped. So only put here
2007 stuff that is not part of the bidi iterator's state! */
2008 struct bidi_stack level_stack
[BIDI_MAXDEPTH
+2+1]; /* directional status stack */
2009 struct bidi_string_data string
; /* string to reorder */
2010 struct window
*w
; /* the window being displayed */
2011 bidi_dir_t paragraph_dir
; /* current paragraph direction */
2012 ptrdiff_t separator_limit
; /* where paragraph separator should end */
2013 bool_bf first_elt
: 1; /* if true, examine current char first */
2014 bool_bf new_paragraph
: 1; /* if true, we expect a new paragraph */
2015 bool_bf frame_window_p
: 1; /* true if displaying on a GUI frame */
2018 /* Value is non-zero when the bidi iterator is at base paragraph
2020 #define BIDI_AT_BASE_LEVEL(BIDI_IT) \
2021 ((BIDI_IT).resolved_level == (BIDI_IT).level_stack[0].level)
2024 /***********************************************************************
2026 ***********************************************************************/
2028 /* Structure used to describe where and how to draw a fringe bitmap.
2029 WHICH is the fringe bitmap to draw. WD and H is the (adjusted)
2030 width and height of the bitmap, DH is the height adjustment (if
2031 bitmap is periodic). X and Y are frame coordinates of the area to
2032 display the bitmap, DY is relative offset of the bitmap into that
2033 area. BX, NX, BY, NY specifies the area to clear if the bitmap
2034 does not fill the entire area. FACE is the fringe face. */
2036 struct draw_fringe_bitmap_params
2038 int which
; /* enum fringe_bitmap_type */
2039 unsigned short *bits
;
2043 bool_bf cursor_p
: 1;
2044 bool_bf overlay_p
: 1;
2048 #define MAX_FRINGE_BITMAPS (1<<FRINGE_ID_BITS)
2051 /***********************************************************************
2053 ***********************************************************************/
2055 /* Iteration over things to display in current_buffer or in a string.
2057 The iterator handles:
2059 1. Overlay strings (after-string, before-string).
2061 3. Invisible text properties.
2062 4. Selective display.
2063 5. Translation of characters via display tables.
2064 6. Translation of control characters to the forms `\003' or `^C'.
2065 7. `glyph' and `space-width' properties.
2067 Iterators are initialized by calling init_iterator or one of the
2068 equivalent functions below. A call to get_next_display_element
2069 loads the iterator structure with information about what next to
2070 display. A call to set_iterator_to_next increments the iterator's
2073 Characters from overlay strings, display table entries or control
2074 character translations are returned one at a time. For example, if
2075 we have a text of `a\x01' where `a' has a display table definition
2076 of `cd' and the control character is displayed with a leading
2077 arrow, then the iterator will return:
2079 Call Return Source Call next
2080 -----------------------------------------------------------------
2081 next c display table move
2082 next d display table move
2083 next ^ control char move
2084 next A control char move
2086 The same mechanism is also used to return characters for ellipses
2087 displayed at the end of invisible text.
2089 CAVEAT: Under some circumstances, move_.* functions can be called
2090 asynchronously, e.g. when computing a buffer position from an x and
2091 y pixel position. This means that these functions and functions
2092 called from them SHOULD NOT USE xmalloc and alike. See also the
2093 comment at the start of xdisp.c. */
2095 /* Enumeration describing what kind of display element an iterator is
2096 loaded with after a call to get_next_display_element. */
2098 enum display_element_type
2100 /* A normal character. */
2103 /* A composition (static and automatic). */
2106 /* A glyphless character (e.g. ZWNJ, LRE). */
2112 /* A flexible width and height space. */
2115 /* End of buffer or string. */
2118 /* Truncation glyphs. Never returned by get_next_display_element.
2119 Used to get display information about truncation glyphs via
2123 /* Continuation glyphs. See the comment for IT_TRUNCATION. */
2131 /* An enumerator for each text property that has a meaning for display
2140 COMPOSITION_PROP_IDX
,
2142 /* Not a property. Used to indicate changes in overlays. */
2149 /* An enumerator for the method of wrapping long lines. */
2151 enum line_wrap_method
2158 /* An enumerator for the method of displaying glyphless characters. */
2160 enum glyphless_display_method
2162 /* Display a thin (1-pixel width) space. On a TTY, display a
2163 1-character width space. */
2164 GLYPHLESS_DISPLAY_THIN_SPACE
,
2165 /* Display an empty box of proper width. */
2166 GLYPHLESS_DISPLAY_EMPTY_BOX
,
2167 /* Display an acronym string in a box. */
2168 GLYPHLESS_DISPLAY_ACRONYM
,
2169 /* Display the hexadecimal code of the character in a box. */
2170 GLYPHLESS_DISPLAY_HEX_CODE
2181 /* Input sources for fetching characters or data to display.
2182 The input source is found in the `method' field. */
2185 GET_FROM_BUFFER
= 0,
2186 GET_FROM_DISPLAY_VECTOR
,
2195 /* FIXME: What is this? Why 5? */
2196 #define IT_STACK_SIZE 5
2198 /* Iterator for composition (both for static and automatic). */
2199 struct composition_it
2201 /* Next position at which to check the composition. */
2203 /* ID number of the composition or glyph-string. If negative, we
2204 are not iterating over a composition now. */
2206 /* If non-negative, character that triggers the automatic
2207 composition at `stop_pos', and this is an automatic composition.
2208 If negative, this is a static composition. This is set to -2
2209 temporarily if searching of composition reach a limit or a
2212 /* If this is an automatic composition, index of a rule for making
2213 the automatic composition. Provided that ELT is an element of
2214 Vcomposition_function_table for CH, (nth ELT RULE_IDX) is the
2215 rule for the composition. */
2217 /* If this is an automatic composition, how many characters to look
2218 back from the position where a character triggering the
2219 composition exists. */
2221 /* If non-negative, number of glyphs of the glyph-string. */
2223 /* True iff the composition is created while buffer is scanned in
2224 reverse order, and thus the grapheme clusters must be rendered
2225 from the last to the first. */
2228 /** The following members contain information about the current
2229 grapheme cluster. */
2230 /* Position of the first character of the current grapheme cluster. */
2232 /* Number of characters and bytes of the current grapheme cluster. */
2234 /* Indices of the glyphs for the current grapheme cluster. */
2236 /* Width of the current grapheme cluster in units of columns it will
2237 occupy on display; see CHAR_WIDTH. */
2243 /* The window in which we iterate over current_buffer (or a string). */
2247 /* The window's frame. */
2250 /* Method to use to load this structure with the next display element. */
2251 enum it_method method
;
2253 /* The next position at which to check for face changes, invisible
2254 text, overlay strings, end of text etc., which see. */
2255 ptrdiff_t stop_charpos
;
2257 /* Previous stop position, i.e. the last one before the current
2258 iterator position in `current'. */
2259 ptrdiff_t prev_stop
;
2261 /* Last stop position iterated across whose bidi embedding level is
2262 equal to the current paragraph's base embedding level. */
2263 ptrdiff_t base_level_stop
;
2265 /* Maximum string or buffer position + 1. ZV when iterating over
2266 current_buffer. When iterating over a string in display_string,
2267 this can be smaller or greater than the number of string
2268 characters, depending on the values of PRECISION and FIELD_WIDTH
2269 with which display_string was called. */
2270 ptrdiff_t end_charpos
;
2272 /* C string to iterate over. Non-null means get characters from
2273 this string, otherwise characters are read from current_buffer
2275 const unsigned char *s
;
2277 /* Number of characters in the string (s, or it->string) we iterate
2278 over. Used only in display_string and its subroutines; never
2279 used for overlay strings and strings from display properties. */
2280 ptrdiff_t string_nchars
;
2282 /* Position at which redisplay end trigger functions should be run. */
2283 ptrdiff_t redisplay_end_trigger_charpos
;
2285 /* True means multibyte characters are enabled. */
2286 bool_bf multibyte_p
: 1;
2288 /* True means window has a mode line at its top. */
2289 bool_bf header_line_p
: 1;
2291 /* True means `string' is the value of a `display' property.
2292 Don't handle some `display' properties in these strings. */
2293 bool_bf string_from_display_prop_p
: 1;
2295 /* True means `string' comes from a `line-prefix' or `wrap-prefix'
2297 bool_bf string_from_prefix_prop_p
: 1;
2299 /* True means we are iterating an object that came from a value of a
2300 `display' property. */
2301 bool_bf from_disp_prop_p
: 1;
2303 /* When METHOD == next_element_from_display_vector,
2304 this is true if we're doing an ellipsis. Otherwise meaningless. */
2305 bool_bf ellipsis_p
: 1;
2307 /* True means cursor shouldn't be displayed here. */
2308 bool_bf avoid_cursor_p
: 1;
2310 /* Display table in effect or null for none. */
2311 struct Lisp_Char_Table
*dp
;
2313 /* Current display table vector to return characters from and its
2314 end. dpvec null means we are not returning characters from a
2315 display table entry; current.dpvec_index gives the current index
2316 into dpvec. This same mechanism is also used to return
2317 characters from translated control characters, i.e. `\003' or
2319 Lisp_Object
*dpvec
, *dpend
;
2321 /* Length in bytes of the char that filled dpvec. A value of zero
2322 means that no such character is involved. A negative value means
2323 the rest of the line from the current iterator position onwards
2324 is hidden by selective display or ellipsis. */
2327 /* Face id to use for all characters in display vector. -1 if unused. */
2330 /* Face id of the iterator saved in case a glyph from dpvec contains
2331 a face. The face is restored when all glyphs from dpvec have
2335 /* Vector of glyphs for control character translation. The pointer
2336 dpvec is set to ctl_chars when a control character is translated.
2337 This vector is also used for incomplete multibyte character
2338 translation (e.g \222\244). Such a character is at most 4 bytes,
2339 thus we need at most 16 bytes here. */
2340 Lisp_Object ctl_chars
[16];
2342 /* Initial buffer or string position of the iterator, before skipping
2343 over display properties and invisible text. */
2344 struct display_pos start
;
2346 /* Current buffer or string position of the iterator, including
2347 position in overlay strings etc. */
2348 struct display_pos current
;
2350 /* Total number of overlay strings to process. This can be >
2351 OVERLAY_STRING_CHUNK_SIZE. Value is dependable only when
2352 current.overlay_string_index >= 0. Use the latter to determine
2353 whether an overlay string is being iterated over, because
2354 n_overlay_strings can be positive even when we are not rendering
2355 an overlay string. */
2356 ptrdiff_t n_overlay_strings
;
2358 /* The charpos where n_overlay_strings was calculated. This should
2359 be set at the same time as n_overlay_strings. It is needed
2360 because we show before-strings at the start of invisible text;
2361 see handle_invisible_prop in xdisp.c. */
2362 ptrdiff_t overlay_strings_charpos
;
2364 /* Vector of overlays to process. Overlay strings are processed
2365 OVERLAY_STRING_CHUNK_SIZE at a time. */
2366 #define OVERLAY_STRING_CHUNK_SIZE 16
2367 Lisp_Object overlay_strings
[OVERLAY_STRING_CHUNK_SIZE
];
2369 /* For each overlay string, the overlay it came from. */
2370 Lisp_Object string_overlays
[OVERLAY_STRING_CHUNK_SIZE
];
2372 /* If non-nil, a Lisp string being processed. If
2373 current.overlay_string_index >= 0, this is an overlay string from
2374 pos. Use STRINGP (it.string) to test whether we are rendering a
2375 string or something else; do NOT use BUFFERP (it.object). */
2378 /* If non-nil, we are processing a string that came
2379 from a `display' property given by an overlay. */
2380 Lisp_Object from_overlay
;
2382 /* Stack of saved values. New entries are pushed when we begin to
2383 process an overlay string or a string from a `glyph' property.
2384 Entries are popped when we return to deliver display elements
2385 from what we previously had. */
2386 struct iterator_stack_entry
2390 ptrdiff_t end_charpos
;
2391 ptrdiff_t stop_charpos
;
2392 ptrdiff_t prev_stop
;
2393 ptrdiff_t base_level_stop
;
2394 struct composition_it cmp_it
;
2397 /* Save values specific to a given method. */
2399 /* method == GET_FROM_IMAGE */
2402 struct it_slice slice
;
2405 /* method == GET_FROM_STRETCH */
2409 /* method == GET_FROM_XWIDGET */
2415 /* Current text and display positions. */
2416 struct text_pos position
;
2417 struct display_pos current
;
2418 Lisp_Object from_overlay
;
2419 enum glyph_row_area area
;
2420 enum it_method method
;
2421 bidi_dir_t paragraph_embedding
;
2422 bool_bf multibyte_p
: 1;
2423 bool_bf string_from_display_prop_p
: 1;
2424 bool_bf string_from_prefix_prop_p
: 1;
2425 bool_bf display_ellipsis_p
: 1;
2426 bool_bf avoid_cursor_p
: 1;
2428 bool_bf from_disp_prop_p
: 1;
2429 enum line_wrap_method line_wrap
;
2431 /* Properties from display property that are reset by another display
2434 Lisp_Object space_width
;
2435 Lisp_Object font_height
;
2437 stack
[IT_STACK_SIZE
];
2439 /* Stack pointer. */
2442 /* -1 means selective display hides everything between a \r and the
2443 next newline; > 0 means hide lines indented more than that value. */
2444 ptrdiff_t selective
;
2446 /* An enumeration describing what the next display element is
2447 after a call to get_next_display_element. */
2448 enum display_element_type what
;
2453 /* Setting of buffer-local variable selective-display-ellipsis. */
2454 bool_bf selective_display_ellipsis_p
: 1;
2456 /* True means control characters are translated into the form `^C'
2457 where the `^' can be replaced by a display table entry. */
2458 bool_bf ctl_arrow_p
: 1;
2460 /* True means that the current face has a box. */
2461 bool_bf face_box_p
: 1;
2463 /* Non-null means that the current character is the first in a run
2464 of characters with box face. */
2465 bool_bf start_of_box_run_p
: 1;
2467 /* True means that the current character is the last in a run
2468 of characters with box face. */
2469 bool_bf end_of_box_run_p
: 1;
2471 /* True means overlay strings at end_charpos have been processed. */
2472 bool_bf overlay_strings_at_end_processed_p
: 1;
2474 /* True means to ignore overlay strings at current pos, as they have
2475 already been processed. */
2476 bool_bf ignore_overlay_strings_at_pos_p
: 1;
2478 /* True means the actual glyph is not available in the current
2480 bool_bf glyph_not_available_p
: 1;
2482 /* True means the next line in display_line continues a character
2483 consisting of more than one glyph, and some glyphs of this
2484 character have been put on the previous line. */
2485 bool_bf starts_in_middle_of_char_p
: 1;
2487 /* If true, saved_face_id contains the id of the face in front of text
2488 skipped due to selective display. */
2489 bool_bf face_before_selective_p
: 1;
2491 /* If true, adjust current glyph so it does not increase current row
2492 descent/ascent (line-height property). Reset after this glyph. */
2493 bool_bf constrain_row_ascent_descent_p
: 1;
2495 enum line_wrap_method line_wrap
;
2497 /* The ID of the default face to use. One of DEFAULT_FACE_ID,
2498 MODE_LINE_FACE_ID, etc, depending on what we are displaying. */
2501 /* If `what' == IT_CHARACTER, the character and the length in bytes
2502 of its multibyte sequence. The character comes from a buffer or
2503 a string. It may be different from the character displayed in
2504 case that unibyte_display_via_language_environment is set.
2506 If `what' == IT_COMPOSITION, the first component of a composition
2507 and length in bytes of the composition.
2509 If `what' is anything else, these two are undefined (will
2510 probably hold values for the last IT_CHARACTER or IT_COMPOSITION
2511 traversed by the iterator.
2513 The values are updated by get_next_display_element, so they are
2514 out of sync with the value returned by IT_CHARPOS between the
2515 time set_iterator_to_next advances the position and the time
2516 get_next_display_element loads the new values into c and len. */
2519 /* If what == IT_COMPOSITION, iterator substructure for the
2521 struct composition_it cmp_it
;
2523 /* The character to display, possibly translated to multibyte if
2524 multibyte_p is zero or unibyte_display_via_language_environment
2525 is set. This is set after get_next_display_element has been
2526 called. If we are setting it->C directly before calling
2527 PRODUCE_GLYPHS, this should be set beforehand too. */
2528 int char_to_display
;
2530 /* If what == IT_GLYPHLESS, the method to display such a
2532 enum glyphless_display_method glyphless_method
;
2534 /* If what == IT_IMAGE, the id of the image to display. */
2537 /* If what == IT_XWIDGET. */
2538 struct xwidget
*xwidget
;
2540 /* Values from `slice' property. */
2541 struct it_slice slice
;
2543 /* Value of the `space-width' property, if any; nil if none. */
2544 Lisp_Object space_width
;
2546 /* Computed from the value of the `raise' property. */
2549 /* Number of columns per \t. */
2552 /* Value of the `height' property, if any; nil if none. */
2553 Lisp_Object font_height
;
2555 /* Object and position where the current display element came from.
2556 Object is normally the buffer which is being rendered, but it can
2557 also be a Lisp string in case the current display element comes
2558 from an overlay string or from a display string (before- or
2559 after-string). It may also be a zero-valued Lisp integer when a
2560 C string is being rendered, e.g., during mode-line or header-line
2561 update. It can also be a cons cell of the form `(space ...)',
2562 when we produce a stretch glyph from a `display' specification.
2563 Finally, it can be nil, but only temporarily, when we are
2564 producing special glyphs for display purposes, like truncation
2565 and continuation glyphs, or blanks that extend each line to the
2566 edge of the window on a TTY.
2568 Do NOT use !BUFFERP (it.object) as a test whether we are
2569 iterating over a string; use STRINGP (it.string) instead.
2571 Position is the current iterator position in object. */
2573 struct text_pos position
;
2575 /* Width in pixels of truncation and continuation glyphs. */
2576 short truncation_pixel_width
, continuation_pixel_width
;
2578 /* First and last visible x-position in the display area. If window
2579 is hscrolled by n columns, first_visible_x == n * FRAME_COLUMN_WIDTH
2580 (f), and last_visible_x == pixel width of W + first_visible_x.
2581 When truncation or continuation glyphs are produced due to lack of
2582 fringes, last_visible_x excludes the space required for these glyphs. */
2583 int first_visible_x
, last_visible_x
;
2585 /* Last visible y-position + 1 in the display area without a mode
2586 line, if the window has one. */
2589 /* Default amount of additional space in pixels between lines (for
2590 window systems only.) */
2591 int extra_line_spacing
;
2593 /* Max extra line spacing added in this row. */
2594 int max_extra_line_spacing
;
2596 /* Override font height information for this glyph.
2597 Used if override_ascent >= 0. Cleared after this glyph. */
2598 int override_ascent
, override_descent
, override_boff
;
2600 /* If non-null, glyphs are produced in glyph_row with each call to
2602 struct glyph_row
*glyph_row
;
2604 /* The area of glyph_row to which glyphs are added. */
2605 enum glyph_row_area area
;
2607 /* Number of glyphs needed for the last character requested via
2608 produce_glyphs. This is 1 except for tabs. */
2611 /* Width of the display element in pixels. Result of
2615 /* Current, maximum logical, and maximum physical line height
2616 information. Result of produce_glyphs. */
2617 int ascent
, descent
, max_ascent
, max_descent
;
2618 int phys_ascent
, phys_descent
, max_phys_ascent
, max_phys_descent
;
2620 /* Current x pixel position within the display line. This value
2621 does not include the width of continuation lines in front of the
2622 line. The value of current_x is automatically incremented by
2623 pixel_width with each call to produce_glyphs. */
2626 /* Accumulated width of continuation lines. If > 0, this means we
2627 are currently in a continuation line. This is initially zero and
2628 incremented/reset by display_line, move_it_to etc. */
2629 int continuation_lines_width
;
2631 /* Buffer position that ends the buffer text line being iterated.
2632 This is normally the position after the newline at EOL. If this
2633 is the last line of the buffer and it doesn't have a newline,
2634 value is ZV/ZV_BYTE. Set and used only if IT->bidi_p, for
2635 setting the end position of glyph rows produced for continuation
2636 lines, see display_line. */
2637 struct text_pos eol_pos
;
2639 /* Current y-position. Automatically incremented by the height of
2640 glyph_row in move_it_to and display_line. */
2643 /* Vertical matrix position of first text line in window. */
2646 /* Current vertical matrix position, or line number. Automatically
2647 incremented by move_it_to and display_line. */
2650 /* Horizontal matrix position reached in move_it_in_display_line.
2651 Only set there, not in display_line, and only when the X
2652 coordinate is past first_visible_x. */
2655 /* Left fringe bitmap number (enum fringe_bitmap_type). */
2656 unsigned left_user_fringe_bitmap
: FRINGE_ID_BITS
;
2658 /* Right fringe bitmap number (enum fringe_bitmap_type). */
2659 unsigned right_user_fringe_bitmap
: FRINGE_ID_BITS
;
2661 /* Face of the left fringe glyph. */
2662 unsigned left_user_fringe_face_id
: FACE_ID_BITS
;
2664 /* Face of the right fringe glyph. */
2665 unsigned right_user_fringe_face_id
: FACE_ID_BITS
;
2667 /* True means we need to reorder bidirectional text for display
2668 in the visual order. */
2671 /* For iterating over bidirectional text. */
2672 struct bidi_it bidi_it
;
2673 bidi_dir_t paragraph_embedding
;
2677 /* Access to positions of iterator IT. */
2679 #define IT_CHARPOS(IT) CHARPOS ((IT).current.pos)
2680 #define IT_BYTEPOS(IT) BYTEPOS ((IT).current.pos)
2681 #define IT_STRING_CHARPOS(IT) CHARPOS ((IT).current.string_pos)
2682 #define IT_STRING_BYTEPOS(IT) BYTEPOS ((IT).current.string_pos)
2684 /* Test if IT has reached the end of its buffer or string. This will
2685 only work after get_next_display_element has been called. */
2687 #define ITERATOR_AT_END_P(IT) ((IT)->what == IT_EOB)
2689 /* True means IT is at the end of a line. This is the case if it
2690 is either on a newline or on a carriage return and selective
2691 display hides the rest of the line. */
2693 #define ITERATOR_AT_END_OF_LINE_P(IT) \
2694 ((IT)->what == IT_CHARACTER \
2695 && ((IT)->c == '\n' \
2696 || ((IT)->c == '\r' && (IT)->selective)))
2698 /* Call produce_glyphs or FRAME_RIF->produce_glyphs, if set. Shortcut
2699 to avoid the function call overhead. */
2701 #define PRODUCE_GLYPHS(IT) \
2703 if ((IT)->glyph_row != NULL && (IT)->bidi_p) \
2704 (IT)->glyph_row->reversed_p = (IT)->bidi_it.paragraph_dir == R2L; \
2705 if (FRAME_RIF ((IT)->f) != NULL) \
2706 FRAME_RIF ((IT)->f)->produce_glyphs ((IT)); \
2708 produce_glyphs ((IT)); \
2709 if ((IT)->glyph_row != NULL) \
2710 inhibit_free_realized_faces = true; \
2713 /* Bit-flags indicating what operation move_it_to should perform. */
2715 enum move_operation_enum
2717 /* Stop if specified x-position is reached. */
2720 /* Stop if specified y-position is reached. */
2723 /* Stop if specified vpos is reached. */
2724 MOVE_TO_VPOS
= 0x04,
2726 /* Stop if specified buffer or string position is reached. */
2730 /***********************************************************************
2732 ***********************************************************************/
2734 /* Structure to hold mouse highlight data. */
2737 /* These variables describe the range of text currently shown in its
2738 mouse-face, together with the window they apply to. As long as
2739 the mouse stays within this range, we need not redraw anything on
2740 its account. Rows and columns are glyph matrix positions in
2741 MOUSE_FACE_WINDOW. */
2742 int mouse_face_beg_row
, mouse_face_beg_col
, mouse_face_beg_x
;
2743 int mouse_face_end_row
, mouse_face_end_col
, mouse_face_end_x
;
2744 Lisp_Object mouse_face_window
;
2745 int mouse_face_face_id
;
2746 Lisp_Object mouse_face_overlay
;
2748 /* FRAME and X, Y position of mouse when last checked for
2749 highlighting. X and Y can be negative or out of range for the frame. */
2750 struct frame
*mouse_face_mouse_frame
;
2751 int mouse_face_mouse_x
, mouse_face_mouse_y
;
2753 /* Nonzero if part of the text currently shown in
2754 its mouse-face is beyond the window end. */
2755 bool_bf mouse_face_past_end
: 1;
2757 /* True means defer mouse-motion highlighting. */
2758 bool_bf mouse_face_defer
: 1;
2760 /* True means that the mouse highlight should not be shown. */
2761 bool_bf mouse_face_hidden
: 1;
2765 reset_mouse_highlight (Mouse_HLInfo
*hlinfo
)
2768 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
2769 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
2770 hlinfo
->mouse_face_mouse_x
= hlinfo
->mouse_face_mouse_y
= 0;
2771 hlinfo
->mouse_face_beg_x
= hlinfo
->mouse_face_end_x
= 0;
2772 hlinfo
->mouse_face_face_id
= DEFAULT_FACE_ID
;
2773 hlinfo
->mouse_face_mouse_frame
= NULL
;
2774 hlinfo
->mouse_face_window
= Qnil
;
2775 hlinfo
->mouse_face_overlay
= Qnil
;
2776 hlinfo
->mouse_face_past_end
= false;
2777 hlinfo
->mouse_face_hidden
= false;
2778 hlinfo
->mouse_face_defer
= false;
2781 /***********************************************************************
2782 Window-based redisplay interface
2783 ***********************************************************************/
2785 /* Structure used to describe runs of lines that must be scrolled. */
2789 /* Source and destination y pixel position. */
2790 int desired_y
, current_y
;
2792 /* Source and destination vpos in matrix. */
2793 int desired_vpos
, current_vpos
;
2795 /* Height in pixels, number of glyph rows. */
2800 /* Handlers for setting frame parameters. */
2802 typedef void (*frame_parm_handler
) (struct frame
*, Lisp_Object
, Lisp_Object
);
2805 /* Structure holding system-dependent interface functions needed
2806 for window-based redisplay. */
2808 struct redisplay_interface
2810 /* Handlers for setting frame parameters. */
2811 frame_parm_handler
*frame_parm_handlers
;
2813 /* Produce glyphs/get display metrics for the display element IT is
2815 void (*produce_glyphs
) (struct it
*it
);
2817 /* Write or insert LEN glyphs from STRING at the nominal output
2819 void (*write_glyphs
) (struct window
*w
, struct glyph_row
*row
,
2820 struct glyph
*string
, enum glyph_row_area area
,
2822 void (*insert_glyphs
) (struct window
*w
, struct glyph_row
*row
,
2823 struct glyph
*start
, enum glyph_row_area area
,
2826 /* Clear from nominal output position to X. X < 0 means clear
2827 to right end of display. */
2828 void (*clear_end_of_line
) (struct window
*w
, struct glyph_row
*row
,
2829 enum glyph_row_area area
, int x
);
2831 /* Function to call to scroll the display as described by RUN on
2833 void (*scroll_run_hook
) (struct window
*w
, struct run
*run
);
2835 /* Function to call after a line in a display has been completely
2836 updated. Used to draw truncation marks and alike. DESIRED_ROW
2837 is the desired row which has been updated. */
2838 void (*after_update_window_line_hook
) (struct window
*w
,
2839 struct glyph_row
*desired_row
);
2841 /* Function to call before beginning to update window W in
2842 window-based redisplay. */
2843 void (*update_window_begin_hook
) (struct window
*w
);
2845 /* Function to call after window W has been updated in window-based
2846 redisplay. CURSOR_ON_P true means switch cursor on.
2847 MOUSE_FACE_OVERWRITTEN_P true means that some lines in W
2848 that contained glyphs in mouse-face were overwritten, so we
2849 have to update the mouse highlight. */
2850 void (*update_window_end_hook
) (struct window
*w
, bool cursor_on_p
,
2851 bool mouse_face_overwritten_p
);
2853 /* Flush the display of frame F. For X, this is XFlush. */
2854 void (*flush_display
) (struct frame
*f
);
2856 /* Clear the mouse highlight in window W, if there is any. */
2857 void (*clear_window_mouse_face
) (struct window
*w
);
2859 /* Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
2861 void (*get_glyph_overhangs
) (struct glyph
*glyph
, struct frame
*f
,
2862 int *left
, int *right
);
2864 /* Fix the display of AREA of ROW in window W for overlapping rows.
2865 This function is called from redraw_overlapping_rows after
2866 desired rows have been made current. */
2867 void (*fix_overlapping_area
) (struct window
*w
, struct glyph_row
*row
,
2868 enum glyph_row_area area
, int);
2870 #ifdef HAVE_WINDOW_SYSTEM
2872 /* Draw a fringe bitmap in window W of row ROW using parameters P. */
2873 void (*draw_fringe_bitmap
) (struct window
*w
, struct glyph_row
*row
,
2874 struct draw_fringe_bitmap_params
*p
);
2876 /* Define and destroy fringe bitmap no. WHICH. */
2877 void (*define_fringe_bitmap
) (int which
, unsigned short *bits
,
2879 void (*destroy_fringe_bitmap
) (int which
);
2881 /* Compute left and right overhang of glyph string S.
2882 A NULL pointer if platform does not support this. */
2883 void (*compute_glyph_string_overhangs
) (struct glyph_string
*s
);
2885 /* Draw a glyph string S. */
2886 void (*draw_glyph_string
) (struct glyph_string
*s
);
2888 /* Define cursor CURSOR on frame F. */
2889 void (*define_frame_cursor
) (struct frame
*f
, Cursor cursor
);
2891 /* Clear the area at (X,Y,WIDTH,HEIGHT) of frame F. */
2892 void (*clear_frame_area
) (struct frame
*f
, int x
, int y
,
2893 int width
, int height
);
2895 /* Draw specified cursor CURSOR_TYPE of width CURSOR_WIDTH
2896 at row GLYPH_ROW on window W if ON_P is true. If ON_P is
2897 false, don't draw cursor. If ACTIVE_P is true, system caret
2898 should track this cursor (when applicable). */
2899 void (*draw_window_cursor
) (struct window
*w
,
2900 struct glyph_row
*glyph_row
,
2902 enum text_cursor_kinds cursor_type
,
2903 int cursor_width
, bool on_p
, bool active_p
);
2905 /* Draw vertical border for window W from (X,Y_0) to (X,Y_1). */
2906 void (*draw_vertical_window_border
) (struct window
*w
,
2907 int x
, int y_0
, int y_1
);
2909 /* Draw window divider for window W from (X_0, Y_0) to (X_1, ,Y_1). */
2910 void (*draw_window_divider
) (struct window
*w
,
2911 int x_0
, int x_1
, int y_0
, int y_1
);
2913 /* Shift display of frame F to make room for inserted glyphs.
2914 The area at pixel (X,Y) of width WIDTH and height HEIGHT is
2915 shifted right by SHIFT_BY pixels. */
2916 void (*shift_glyphs_for_insert
) (struct frame
*f
,
2917 int x
, int y
, int width
,
2918 int height
, int shift_by
);
2920 /* Start display hourglass cursor on frame F. */
2921 void (*show_hourglass
) (struct frame
*f
);
2923 /* Cancel hourglass cursor on frame F. */
2924 void (*hide_hourglass
) (struct frame
*f
);
2926 #endif /* HAVE_WINDOW_SYSTEM */
2930 /***********************************************************************
2932 ***********************************************************************/
2934 #ifdef HAVE_WINDOW_SYSTEM
2936 /* Each image format (JPEG, TIFF, ...) supported is described by
2937 a structure of the type below. */
2941 /* Index of a symbol uniquely identifying the image type, e.g., 'jpeg'. */
2944 /* Check that SPEC is a valid image specification for the given
2945 image type. Value is true if SPEC is valid. */
2946 bool (* valid_p
) (Lisp_Object spec
);
2948 /* Load IMG which is used on frame F from information contained in
2949 IMG->spec. Value is true if successful. */
2950 bool (* load
) (struct frame
*f
, struct image
*img
);
2952 /* Free resources of image IMG which is used on frame F. */
2953 void (* free
) (struct frame
*f
, struct image
*img
);
2955 /* Initialization function (used for dynamic loading of image
2956 libraries on Windows), or NULL if none. */
2957 bool (* init
) (void);
2959 /* Next in list of all supported image types. */
2960 struct image_type
*next
;
2964 /* Structure describing an image. Specific image formats like XBM are
2965 converted into this form, so that display only has to deal with
2966 this type of image. */
2970 /* The time in seconds at which the image was last displayed. Set
2971 in prepare_image_for_display. */
2972 struct timespec timestamp
;
2974 /* Pixmaps of the image. */
2975 Pixmap pixmap
, mask
;
2981 #ifdef HAVE_X_WINDOWS
2982 /* X images of the image, corresponding to the above Pixmaps.
2983 Non-NULL means it and its Pixmap counterpart may be out of sync
2984 and the latter is outdated. NULL means the X image has been
2985 synchronized to Pixmap. */
2986 XImagePtr ximg
, mask_img
;
2989 /* Colors allocated for this image, if any. Allocated via xmalloc. */
2990 unsigned long *colors
;
2993 /* A single `background color' for this image, for the use of anyone that
2994 cares about such a thing. Only valid if the `background_valid' field
2995 is true. This should generally be accessed by calling the accessor
2996 macro `IMAGE_BACKGROUND', which will heuristically calculate a value
2998 unsigned long background
;
3000 /* Foreground and background colors of the frame on which the image
3002 unsigned long frame_foreground
, frame_background
;
3004 /* True if this image has a `transparent' background -- that is, is
3005 uses an image mask. The accessor macro for this is
3006 `IMAGE_BACKGROUND_TRANSPARENT'. */
3007 bool_bf background_transparent
: 1;
3009 /* True if the `background' and `background_transparent' fields are
3010 valid, respectively. */
3011 bool_bf background_valid
: 1, background_transparent_valid
: 1;
3013 /* Width and height of the image. */
3016 /* These values are used for the rectangles displayed for images
3017 that can't be loaded. */
3018 #define DEFAULT_IMAGE_WIDTH 30
3019 #define DEFAULT_IMAGE_HEIGHT 30
3021 /* Top/left and bottom/right corner pixel of actual image data.
3022 Used by four_corners_best to consider the real image data,
3023 rather than looking at the optional image margin. */
3025 #define TOP_CORNER 0
3026 #define LEFT_CORNER 1
3027 #define BOT_CORNER 2
3028 #define RIGHT_CORNER 3
3030 /* Percent of image height used as ascent. A value of
3031 CENTERED_IMAGE_ASCENT means draw the image centered on the
3034 #define DEFAULT_IMAGE_ASCENT 50
3035 #define CENTERED_IMAGE_ASCENT -1
3037 /* Lisp specification of this image. */
3040 /* List of "references" followed to build the image.
3041 Typically will just contain the name of the image file.
3042 Used to allow fine-grained cache flushing. */
3043 Lisp_Object dependencies
;
3045 /* Relief to draw around the image. */
3048 /* Optional margins around the image. This includes the relief. */
3049 int hmargin
, vmargin
;
3051 /* Reference to the type of the image. */
3052 struct image_type
*type
;
3054 /* True means that loading the image failed. Don't try again. */
3057 /* A place for image types to store additional data. It is marked
3059 Lisp_Object lisp_data
;
3061 /* Hash value of image specification to speed up comparisons. */
3064 /* Image id of this image. */
3067 /* Hash collision chain. */
3068 struct image
*next
, *prev
;
3072 /* Cache of images. Each frame has a cache. X frames with the same
3073 x_display_info share their caches. */
3077 /* Hash table of images. */
3078 struct image
**buckets
;
3080 /* Vector mapping image ids to images. */
3081 struct image
**images
;
3083 /* Allocated size of `images'. */
3086 /* Number of images in the cache. */
3089 /* Reference count (number of frames sharing this cache). */
3094 /* A pointer to the image with id ID on frame F. */
3096 #define IMAGE_FROM_ID(F, ID) \
3097 (eassert (UNSIGNED_CMP (ID, <, FRAME_IMAGE_CACHE (F)->used)), \
3098 FRAME_IMAGE_CACHE (F)->images[ID])
3100 /* Value is a pointer to the image with id ID on frame F, or null if
3101 no image with that id exists. */
3103 #define IMAGE_OPT_FROM_ID(F, ID) \
3104 (UNSIGNED_CMP (ID, <, FRAME_IMAGE_CACHE (F)->used) \
3105 ? IMAGE_FROM_ID (F, ID) \
3108 /* Size of bucket vector of image caches. Should be prime. */
3110 #define IMAGE_CACHE_BUCKETS_SIZE 1001
3112 #endif /* HAVE_WINDOW_SYSTEM */
3116 /***********************************************************************
3118 ***********************************************************************/
3120 /* Enumeration defining where to find tool-bar item information in
3121 tool-bar items vectors stored with frames. Each tool-bar item
3122 occupies TOOL_BAR_ITEM_NSLOTS elements in such a vector. */
3124 enum tool_bar_item_idx
3126 /* The key of the tool-bar item. Used to remove items when a binding
3127 for `undefined' is found. */
3130 /* Non-nil if item is enabled. */
3131 TOOL_BAR_ITEM_ENABLED_P
,
3133 /* Non-nil if item is selected (pressed). */
3134 TOOL_BAR_ITEM_SELECTED_P
,
3137 TOOL_BAR_ITEM_CAPTION
,
3139 /* Image(s) to display. This is either a single image specification
3140 or a vector of specifications. */
3141 TOOL_BAR_ITEM_IMAGES
,
3144 TOOL_BAR_ITEM_BINDING
,
3146 /* Button type. One of nil (default button), t (a separator),
3147 `:radio', or `:toggle'. The latter two currently do nothing. */
3153 /* Icon file name of right to left image when an RTL locale is used. */
3154 TOOL_BAR_ITEM_RTL_IMAGE
,
3156 /* Label to show when text labels are enabled. */
3157 TOOL_BAR_ITEM_LABEL
,
3159 /* If we shall show the label only below the icon and not beside it. */
3160 TOOL_BAR_ITEM_VERT_ONLY
,
3162 /* Sentinel = number of slots in tool_bar_items occupied by one
3164 TOOL_BAR_ITEM_NSLOTS
3168 /* An enumeration for the different images that can be specified
3169 for a tool-bar item. */
3171 enum tool_bar_item_image
3173 TOOL_BAR_IMAGE_ENABLED_SELECTED
,
3174 TOOL_BAR_IMAGE_ENABLED_DESELECTED
,
3175 TOOL_BAR_IMAGE_DISABLED_SELECTED
,
3176 TOOL_BAR_IMAGE_DISABLED_DESELECTED
3179 #define DEFAULT_TOOL_BAR_LABEL_SIZE 14
3181 /* Default values of the above variables. */
3183 #define DEFAULT_TOOL_BAR_BUTTON_MARGIN 4
3184 #define DEFAULT_TOOL_BAR_BUTTON_RELIEF 1
3186 /* The height in pixels of the default tool-bar images. */
3188 #define DEFAULT_TOOL_BAR_IMAGE_HEIGHT 24
3191 /***********************************************************************
3192 Terminal Capabilities
3193 ***********************************************************************/
3195 /* Each of these is a bit representing a terminal `capability' (bold,
3196 inverse, etc). They are or'd together to specify the set of
3197 capabilities being queried for when calling `tty_capable_p' (which
3198 returns true if the terminal supports all of them). */
3200 #define TTY_CAP_INVERSE 0x01
3201 #define TTY_CAP_UNDERLINE 0x02
3202 #define TTY_CAP_BOLD 0x04
3203 #define TTY_CAP_DIM 0x08
3204 #define TTY_CAP_ITALIC 0x10
3207 /***********************************************************************
3209 ***********************************************************************/
3211 /* Defined in bidi.c */
3213 extern void bidi_init_it (ptrdiff_t, ptrdiff_t, bool, struct bidi_it
*);
3214 extern void bidi_move_to_visually_next (struct bidi_it
*);
3215 extern void bidi_paragraph_init (bidi_dir_t
, struct bidi_it
*, bool);
3216 extern int bidi_mirror_char (int);
3217 extern void bidi_push_it (struct bidi_it
*);
3218 extern void bidi_pop_it (struct bidi_it
*);
3219 extern void *bidi_shelve_cache (void);
3220 extern void bidi_unshelve_cache (void *, bool);
3221 extern ptrdiff_t bidi_find_first_overridden (struct bidi_it
*);
3223 /* Defined in xdisp.c */
3225 struct glyph_row
*row_containing_pos (struct window
*, ptrdiff_t,
3227 struct glyph_row
*, int);
3228 int line_bottom_y (struct it
*);
3229 int default_line_pixel_height (struct window
*);
3230 bool display_prop_intangible_p (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3231 void resize_echo_area_exactly (void);
3232 bool resize_mini_window (struct window
*, bool);
3233 void set_vertical_scroll_bar (struct window
*);
3234 void set_horizontal_scroll_bar (struct window
*);
3235 int try_window (Lisp_Object
, struct text_pos
, int);
3236 void window_box (struct window
*, enum glyph_row_area
,
3237 int *, int *, int *, int *);
3238 int window_box_height (struct window
*);
3239 int window_text_bottom_y (struct window
*);
3240 int window_box_width (struct window
*, enum glyph_row_area
);
3241 int window_box_left (struct window
*, enum glyph_row_area
);
3242 int window_box_left_offset (struct window
*, enum glyph_row_area
);
3243 int window_box_right (struct window
*, enum glyph_row_area
);
3244 int estimate_mode_line_height (struct frame
*, enum face_id
);
3245 int move_it_to (struct it
*, ptrdiff_t, int, int, int, int);
3246 void pixel_to_glyph_coords (struct frame
*, int, int, int *, int *,
3247 NativeRectangle
*, bool);
3248 void remember_mouse_glyph (struct frame
*, int, int, NativeRectangle
*);
3250 void mark_window_display_accurate (Lisp_Object
, bool);
3251 void redisplay_preserve_echo_area (int);
3252 void init_iterator (struct it
*, struct window
*, ptrdiff_t,
3253 ptrdiff_t, struct glyph_row
*, enum face_id
);
3254 void init_iterator_to_row_start (struct it
*, struct window
*,
3255 struct glyph_row
*);
3256 void start_display (struct it
*, struct window
*, struct text_pos
);
3257 void move_it_vertically (struct it
*, int);
3258 void move_it_vertically_backward (struct it
*, int);
3259 void move_it_by_lines (struct it
*, ptrdiff_t);
3260 void move_it_past_eol (struct it
*);
3261 void move_it_in_display_line (struct it
*it
,
3262 ptrdiff_t to_charpos
, int to_x
,
3263 enum move_operation_enum op
);
3264 bool in_display_vector_p (struct it
*);
3265 int frame_mode_line_height (struct frame
*);
3266 extern bool redisplaying_p
;
3267 extern bool help_echo_showing_p
;
3268 extern Lisp_Object help_echo_string
, help_echo_window
;
3269 extern Lisp_Object help_echo_object
, previous_help_echo_string
;
3270 extern ptrdiff_t help_echo_pos
;
3271 extern int last_tool_bar_item
;
3272 extern void reseat_at_previous_visible_line_start (struct it
*);
3273 extern Lisp_Object
lookup_glyphless_char_display (int, struct it
*);
3274 extern ptrdiff_t compute_display_string_pos (struct text_pos
*,
3275 struct bidi_string_data
*,
3276 struct window
*, bool, int *);
3277 extern ptrdiff_t compute_display_string_end (ptrdiff_t,
3278 struct bidi_string_data
*);
3279 extern void produce_stretch_glyph (struct it
*);
3280 extern int merge_glyphless_glyph_face (struct it
*);
3281 extern void forget_escape_and_glyphless_faces (void);
3283 extern void get_font_ascent_descent (struct font
*, int *, int *);
3285 #ifdef HAVE_WINDOW_SYSTEM
3288 extern void dump_glyph_string (struct glyph_string
*) EXTERNALLY_VISIBLE
;
3291 extern void x_get_glyph_overhangs (struct glyph
*, struct frame
*,
3293 extern void x_produce_glyphs (struct it
*);
3295 extern void x_write_glyphs (struct window
*, struct glyph_row
*,
3296 struct glyph
*, enum glyph_row_area
, int);
3297 extern void x_insert_glyphs (struct window
*, struct glyph_row
*,
3298 struct glyph
*, enum glyph_row_area
, int);
3299 extern void x_clear_end_of_line (struct window
*, struct glyph_row
*,
3300 enum glyph_row_area
, int);
3301 extern void x_fix_overlapping_area (struct window
*, struct glyph_row
*,
3302 enum glyph_row_area
, int);
3303 extern void draw_phys_cursor_glyph (struct window
*,
3305 enum draw_glyphs_face
);
3306 extern void get_phys_cursor_geometry (struct window
*, struct glyph_row
*,
3307 struct glyph
*, int *, int *, int *);
3308 extern void erase_phys_cursor (struct window
*);
3309 extern void display_and_set_cursor (struct window
*, bool, int, int, int, int);
3310 extern void x_update_cursor (struct frame
*, bool);
3311 extern void x_clear_cursor (struct window
*);
3312 extern void x_draw_vertical_border (struct window
*w
);
3313 extern void x_draw_right_divider (struct window
*w
);
3315 extern int get_glyph_string_clip_rects (struct glyph_string
*,
3316 NativeRectangle
*, int);
3317 extern void get_glyph_string_clip_rect (struct glyph_string
*,
3318 NativeRectangle
*nr
);
3319 extern Lisp_Object
find_hot_spot (Lisp_Object
, int, int);
3321 extern void handle_tool_bar_click (struct frame
*,
3322 int, int, bool, int);
3324 extern void expose_frame (struct frame
*, int, int, int, int);
3325 extern bool x_intersect_rectangles (XRectangle
*, XRectangle
*, XRectangle
*);
3326 #endif /* HAVE_WINDOW_SYSTEM */
3328 extern void note_mouse_highlight (struct frame
*, int, int);
3329 extern void x_clear_window_mouse_face (struct window
*);
3330 extern void cancel_mouse_face (struct frame
*);
3331 extern bool clear_mouse_face (Mouse_HLInfo
*);
3332 extern bool cursor_in_mouse_face_p (struct window
*w
);
3333 extern void tty_draw_row_with_mouse_face (struct window
*, struct glyph_row
*,
3334 int, int, enum draw_glyphs_face
);
3335 extern void display_tty_menu_item (const char *, int, int, int, int, bool);
3337 /* Flags passed to try_window. */
3338 #define TRY_WINDOW_CHECK_MARGINS (1 << 0)
3339 #define TRY_WINDOW_IGNORE_FONTS_CHANGE (1 << 1)
3341 int lookup_fringe_bitmap (Lisp_Object
);
3342 void draw_fringe_bitmap (struct window
*, struct glyph_row
*, int);
3343 void draw_row_fringe_bitmaps (struct window
*, struct glyph_row
*);
3344 bool draw_window_fringes (struct window
*, bool);
3345 bool update_window_fringes (struct window
*, bool);
3348 void w32_init_fringe (struct redisplay_interface
*);
3349 void w32_reset_fringes (void);
3352 void x_cr_init_fringe (struct redisplay_interface
*);
3355 extern unsigned row_hash (struct glyph_row
*);
3357 /* Defined in image.c */
3359 #ifdef HAVE_WINDOW_SYSTEM
3361 extern ptrdiff_t x_bitmap_pixmap (struct frame
*, ptrdiff_t);
3362 extern void x_reference_bitmap (struct frame
*, ptrdiff_t);
3363 extern ptrdiff_t x_create_bitmap_from_data (struct frame
*, char *,
3364 unsigned int, unsigned int);
3365 extern ptrdiff_t x_create_bitmap_from_file (struct frame
*, Lisp_Object
);
3366 #if defined HAVE_XPM && defined HAVE_X_WINDOWS && !defined USE_GTK
3367 extern ptrdiff_t x_create_bitmap_from_xpm_data (struct frame
*, const char **);
3369 #ifndef x_destroy_bitmap
3370 extern void x_destroy_bitmap (struct frame
*, ptrdiff_t);
3372 extern void x_destroy_all_bitmaps (Display_Info
*);
3373 extern void x_create_bitmap_mask (struct frame
*, ptrdiff_t);
3374 extern Lisp_Object
x_find_image_file (Lisp_Object
);
3376 void x_kill_gs_process (Pixmap
, struct frame
*);
3377 struct image_cache
*make_image_cache (void);
3378 void free_image_cache (struct frame
*);
3379 void clear_image_caches (Lisp_Object
);
3380 void mark_image_cache (struct image_cache
*);
3381 bool valid_image_p (Lisp_Object
);
3382 void prepare_image_for_display (struct frame
*, struct image
*);
3383 ptrdiff_t lookup_image (struct frame
*, Lisp_Object
);
3385 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3386 #define RGB_PIXEL_COLOR unsigned long
3390 #define RGB_PIXEL_COLOR COLORREF
3393 RGB_PIXEL_COLOR
image_background (struct image
*, struct frame
*,
3394 XImagePtr_or_DC ximg
);
3395 int image_background_transparent (struct image
*, struct frame
*,
3396 XImagePtr_or_DC mask
);
3398 int image_ascent (struct image
*, struct face
*, struct glyph_slice
*);
3402 /* Defined in sysdep.c */
3404 void get_tty_size (int, int *, int *);
3405 void request_sigio (void);
3406 void unrequest_sigio (void);
3407 bool tabs_safe_p (int);
3408 void init_baud_rate (int);
3409 void init_sigio (int);
3411 /* Defined in xfaces.c. */
3413 #ifdef HAVE_X_WINDOWS
3414 void unload_color (struct frame
*, unsigned long);
3415 void x_free_colors (struct frame
*, unsigned long *, int);
3418 void update_face_from_frame_parameter (struct frame
*, Lisp_Object
,
3420 Lisp_Object
tty_color_name (struct frame
*, int);
3421 void clear_face_cache (bool);
3422 unsigned long load_color (struct frame
*, struct face
*, Lisp_Object
,
3423 enum lface_attribute_index
);
3424 char *choose_face_font (struct frame
*, Lisp_Object
*, Lisp_Object
,
3426 #ifdef HAVE_WINDOW_SYSTEM
3427 void prepare_face_for_display (struct frame
*, struct face
*);
3429 int lookup_named_face (struct frame
*, Lisp_Object
, bool);
3430 int lookup_basic_face (struct frame
*, int);
3431 int smaller_face (struct frame
*, int, int);
3432 int face_with_height (struct frame
*, int, int);
3433 int lookup_derived_face (struct frame
*, Lisp_Object
, int, bool);
3434 void init_frame_faces (struct frame
*);
3435 void free_frame_faces (struct frame
*);
3436 void recompute_basic_faces (struct frame
*);
3437 int face_at_buffer_position (struct window
*, ptrdiff_t, ptrdiff_t *, ptrdiff_t,
3439 int face_for_overlay_string (struct window
*, ptrdiff_t, ptrdiff_t *, ptrdiff_t,
3441 int face_at_string_position (struct window
*, Lisp_Object
, ptrdiff_t, ptrdiff_t,
3442 ptrdiff_t *, enum face_id
, bool);
3443 int merge_faces (struct frame
*, Lisp_Object
, int, int);
3444 int compute_char_face (struct frame
*, int, Lisp_Object
);
3445 void free_all_realized_faces (Lisp_Object
);
3446 extern char unspecified_fg
[], unspecified_bg
[];
3448 /* Defined in xfns.c. */
3450 #ifdef HAVE_X_WINDOWS
3451 void gamma_correct (struct frame
*, XColor
*);
3454 void gamma_correct (struct frame
*, COLORREF
*);
3457 #ifdef HAVE_WINDOW_SYSTEM
3459 void x_implicitly_set_name (struct frame
*, Lisp_Object
, Lisp_Object
);
3460 void x_change_tool_bar_height (struct frame
*f
, int);
3462 extern Lisp_Object tip_frame
;
3463 extern Window tip_window
;
3464 extern frame_parm_handler x_frame_parm_handlers
[];
3466 extern void start_hourglass (void);
3467 extern void cancel_hourglass (void);
3469 /* Returns the background color of IMG, calculating one heuristically if
3470 necessary. If non-zero, XIMG is an existing XImage object to use for
3473 #define IMAGE_BACKGROUND(img, f, ximg) \
3474 ((img)->background_valid \
3475 ? (img)->background \
3476 : image_background (img, f, ximg))
3478 /* Returns true if IMG has a `transparent' background, using heuristics
3479 to decide if necessary. If non-zero, MASK is an existing XImage
3480 object to use for the heuristic. */
3482 #define IMAGE_BACKGROUND_TRANSPARENT(img, f, mask) \
3483 ((img)->background_transparent_valid \
3484 ? (img)->background_transparent \
3485 : image_background_transparent (img, f, mask))
3487 #endif /* HAVE_WINDOW_SYSTEM */
3490 /* Defined in xmenu.c. */
3492 int popup_activated (void);
3494 /* Defined in dispnew.c. */
3496 extern Lisp_Object
buffer_posn_from_coords (struct window
*,
3498 struct display_pos
*,
3500 int *, int *, int *, int *);
3501 extern Lisp_Object
mode_line_string (struct window
*, enum window_part
,
3502 int *, int *, ptrdiff_t *,
3504 int *, int *, int *, int *);
3505 extern Lisp_Object
marginal_area_string (struct window
*, enum window_part
,
3506 int *, int *, ptrdiff_t *,
3508 int *, int *, int *, int *);
3509 extern void redraw_frame (struct frame
*);
3510 extern bool update_frame (struct frame
*, bool, bool);
3511 extern void update_frame_with_menu (struct frame
*, int, int);
3512 extern void bitch_at_user (void);
3513 extern void adjust_frame_glyphs (struct frame
*);
3514 void free_glyphs (struct frame
*);
3515 void free_window_matrices (struct window
*);
3516 void check_glyph_memory (void);
3517 void mirrored_line_dance (struct glyph_matrix
*, int, int, int *, char *);
3518 void clear_glyph_matrix (struct glyph_matrix
*);
3519 void clear_current_matrices (struct frame
*f
);
3520 void clear_desired_matrices (struct frame
*);
3521 void shift_glyph_matrix (struct window
*, struct glyph_matrix
*,
3523 void rotate_matrix (struct glyph_matrix
*, int, int, int);
3524 void increment_matrix_positions (struct glyph_matrix
*,
3525 int, int, ptrdiff_t, ptrdiff_t);
3526 void blank_row (struct window
*, struct glyph_row
*, int);
3527 void clear_glyph_matrix_rows (struct glyph_matrix
*, int, int);
3528 void clear_glyph_row (struct glyph_row
*);
3529 void prepare_desired_row (struct window
*, struct glyph_row
*, bool);
3530 void update_single_window (struct window
*);
3531 void do_pending_window_change (bool);
3532 void change_frame_size (struct frame
*, int, int, bool, bool, bool, bool);
3533 void init_display (void);
3534 void syms_of_display (void);
3535 extern void spec_glyph_lookup_face (struct window
*, GLYPH
*);
3536 extern void fill_up_frame_row_with_spaces (struct glyph_row
*, int);
3538 /* Defined in terminal.c. */
3540 extern void ring_bell (struct frame
*);
3541 extern void update_begin (struct frame
*);
3542 extern void update_end (struct frame
*);
3543 extern void set_terminal_window (struct frame
*, int);
3544 extern void cursor_to (struct frame
*, int, int);
3545 extern void raw_cursor_to (struct frame
*, int, int);
3546 extern void clear_to_end (struct frame
*);
3547 extern void clear_frame (struct frame
*);
3548 extern void clear_end_of_line (struct frame
*, int);
3549 extern void write_glyphs (struct frame
*, struct glyph
*, int);
3550 extern void insert_glyphs (struct frame
*, struct glyph
*, int);
3551 extern void delete_glyphs (struct frame
*, int);
3552 extern void ins_del_lines (struct frame
*, int, int);
3554 extern struct terminal
*init_initial_terminal (void);
3557 /* Defined in term.c */
3559 extern void tty_turn_off_insert (struct tty_display_info
*);
3560 extern int string_cost (const char *);
3561 extern int per_line_cost (const char *);
3562 extern void calculate_costs (struct frame
*);
3563 extern void produce_glyphs (struct it
*);
3564 extern bool tty_capable_p (struct tty_display_info
*, unsigned);
3565 extern void set_tty_color_mode (struct tty_display_info
*, struct frame
*);
3566 extern void create_tty_output (struct frame
*);
3567 extern struct terminal
*init_tty (const char *, const char *, bool);
3568 extern void tty_append_glyph (struct it
*);
3571 /* Defined in scroll.c */
3573 extern int scrolling_max_lines_saved (int, int, unsigned *, unsigned *, int *);
3574 extern void do_line_insertion_deletion_costs (struct frame
*, const char *,
3575 const char *, const char *,
3576 const char *, const char *,
3578 void scrolling_1 (struct frame
*, int, int, int, int *, int *, unsigned *,
3581 /* Defined in frame.c */
3583 #ifdef HAVE_WINDOW_SYSTEM
3585 /* Types we might convert a resource string into. */
3593 RES_TYPE_BOOLEAN_NUMBER
3596 extern Display_Info
*check_x_display_info (Lisp_Object
);
3597 extern Lisp_Object
x_get_arg (Display_Info
*, Lisp_Object
,
3598 Lisp_Object
, const char *, const char *class,
3599 enum resource_types
);
3600 extern Lisp_Object
x_frame_get_and_record_arg (struct frame
*, Lisp_Object
,
3602 const char *, const char *,
3603 enum resource_types
);
3604 extern Lisp_Object
x_default_parameter (struct frame
*, Lisp_Object
,
3605 Lisp_Object
, Lisp_Object
,
3606 const char *, const char *,
3607 enum resource_types
);
3608 extern char *x_get_string_resource (XrmDatabase
, const char *,
3611 #ifndef HAVE_NS /* These both used on W32 and X only. */
3612 extern bool x_mouse_grabbed (Display_Info
*);
3613 extern void x_redo_mouse_highlight (Display_Info
*);
3614 #endif /* HAVE_NS */
3616 #endif /* HAVE_WINDOW_SYSTEM */
3620 #endif /* not DISPEXTERN_H_INCLUDED */