1 /* Interface definitions for display code.
3 Copyright (C) 1985, 1993-1994, 1997-2018 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 <https://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
88 #ifndef HAVE_WINDOW_SYSTEM
93 #ifndef NativeRectangle
94 #define NativeRectangle int
97 /* Text cursor types. */
99 enum text_cursor_kinds
109 /* Values returned from coordinates_in_window. */
122 ON_VERTICAL_SCROLL_BAR
,
123 ON_HORIZONTAL_SCROLL_BAR
,
128 /* Number of bits allocated to store fringe bitmap numbers. */
129 #define FRINGE_ID_BITS 16
131 /* Number of bits allocated to store fringe bitmap height. */
132 #define FRINGE_HEIGHT_BITS 8
135 /***********************************************************************
137 ***********************************************************************/
139 /* If GLYPH_DEBUG is defined, additional checks are activated. */
141 /* Macros to include code only if GLYPH_DEBUG is defined. */
144 #define IF_DEBUG(X) ((void) (X))
146 #define IF_DEBUG(X) ((void) 0)
149 /* Macro for displaying traces of redisplay. If Emacs was compiled
150 with GLYPH_DEBUG defined, the variable trace_redisplay_p can be set to
151 a non-zero value in debugging sessions to activate traces. */
155 extern bool trace_redisplay_p EXTERNALLY_VISIBLE
;
160 if (trace_redisplay_p) \
164 #else /* not GLYPH_DEBUG */
166 #define TRACE(X) ((void) 0)
168 #endif /* GLYPH_DEBUG */
172 /***********************************************************************
174 ***********************************************************************/
176 /* Starting with Emacs 20.3, characters from strings and buffers have
177 both a character and a byte position associated with them. The
178 following structure holds such a pair of positions. */
182 /* Character position. */
185 /* Corresponding byte position. */
189 /* Access character and byte position of POS in a functional form. */
191 #define BYTEPOS(POS) (POS).bytepos
192 #define CHARPOS(POS) (POS).charpos
194 /* Set character position of POS to CHARPOS, byte position to BYTEPOS. */
196 #define SET_TEXT_POS(POS, CHARPOS, BYTEPOS) \
197 ((POS).charpos = (CHARPOS), (POS).bytepos = BYTEPOS)
199 /* Increment text position POS. */
201 #define INC_TEXT_POS(POS, MULTIBYTE_P) \
206 INC_POS ((POS).bytepos); \
212 /* Decrement text position POS. */
214 #define DEC_TEXT_POS(POS, MULTIBYTE_P) \
219 DEC_POS ((POS).bytepos); \
225 /* Set text position POS from marker MARKER. */
227 #define SET_TEXT_POS_FROM_MARKER(POS, MARKER) \
228 (CHARPOS (POS) = marker_position (MARKER), \
229 BYTEPOS (POS) = marker_byte_position (MARKER))
231 /* Like above, but clip POS within accessible range. */
233 #define CLIP_TEXT_POS_FROM_MARKER(POS, MARKER) \
234 (CHARPOS (POS) = clip_to_bounds \
235 (BEGV, marker_position (MARKER), ZV), \
236 BYTEPOS (POS) = clip_to_bounds \
237 (BEGV_BYTE, marker_byte_position (MARKER), ZV_BYTE))
239 /* Set marker MARKER from text position POS. */
241 #define SET_MARKER_FROM_TEXT_POS(MARKER, POS) \
242 set_marker_both ((MARKER), Qnil, CHARPOS ((POS)), BYTEPOS ((POS)))
244 /* Value is non-zero if character and byte positions of POS1 and POS2
247 #define TEXT_POS_EQUAL_P(POS1, POS2) \
248 ((POS1).charpos == (POS2).charpos \
249 && (POS1).bytepos == (POS2).bytepos)
251 /* When rendering glyphs, redisplay scans string or buffer text,
252 overlay strings in that text, and does display table or control
253 character translations. The following structure captures a
254 position taking all this into account. */
258 /* Buffer or string position. */
261 /* If this is a position in an overlay string, overlay_string_index
262 is the index of that overlay string in the sequence of overlay
263 strings at `pos' in the order redisplay processes them. A value
264 < 0 means that this is not a position in an overlay string. */
265 ptrdiff_t overlay_string_index
;
267 /* If this is a position in an overlay string, string_pos is the
268 position within that string. */
269 struct text_pos string_pos
;
271 /* If the character at the position above is a control character or
272 has a display table entry, dpvec_index is an index in the display
273 table or control character translation of that character. A
274 value < 0 means this is not a position in such a translation. */
280 /***********************************************************************
282 ***********************************************************************/
284 /* The glyph datatype, used to represent characters on the display.
285 It consists of a char code and a face id. */
292 /* Return a glyph's character code. */
293 INLINE
int GLYPH_CHAR (GLYPH glyph
) { return glyph
.ch
; }
295 /* Return a glyph's face ID. */
296 INLINE
int GLYPH_FACE (GLYPH glyph
) { return glyph
.face_id
; }
298 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
299 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
300 #define SET_GLYPH(glyph, char, face) \
301 ((glyph).ch = (char), (glyph).face_id = (face))
303 /* The following are valid only if GLYPH_CODE_P (gc). */
306 GLYPH_CODE_CHAR (Lisp_Object gc
)
310 : XINT (gc
) & MAX_CHAR
);
314 GLYPH_CODE_FACE (Lisp_Object gc
)
316 return CONSP (gc
) ? XINT (XCDR (gc
)) : XINT (gc
) >> CHARACTERBITS
;
319 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
323 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
325 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
326 (XINT (gc) >> CHARACTERBITS)); \
330 /* The ID of the mode line highlighting face. */
331 enum { GLYPH_MODE_LINE_FACE
= 1 };
333 /* Enumeration of glyph types. Glyph structures contain a type field
334 containing one of the enumerators defined here. */
338 /* Glyph describes a character. */
341 /* Glyph describes a static composition. */
344 /* Glyph describes a glyphless character. */
347 /* Glyph describes an image. */
350 /* Glyph is a space of fractional width and/or height. */
353 /* Glyph is an external widget drawn by the GUI toolkit. */
358 /* Structure describing how to use partial glyphs (images slicing) */
365 unsigned height
: 16;
371 Be extra careful when changing this structure! Esp. make sure that
372 functions producing glyphs, like append_glyph, fill ALL of the
373 glyph structure, and that GLYPH_EQUAL_P compares all
374 display-relevant members of glyphs (not to imply that these are the
375 only things to check when you add a member). */
379 /* Position from which this glyph was drawn. If `object' below is a
380 Lisp string, this is an index into that string. If it is a
381 buffer, this is a position in that buffer. In addition, some
382 special glyphs have special values for this:
384 glyph standing for newline at end of line 0
385 empty space after the end of the line -1
386 overlay arrow on a TTY -1
387 glyph displaying line number -1
388 glyph at EOB that ends in a newline -1
389 left truncation glyphs: -1
390 right truncation/continuation glyphs next buffer position
391 glyph standing for newline of an empty line buffer position of newline
392 stretch glyph at left edge of R2L lines buffer position of newline */
395 /* Lisp object source of this glyph. Currently either a buffer or a
396 string, if the glyph was produced from characters which came from
397 a buffer or a string; or nil if the glyph was inserted by
398 redisplay for its own purposes, such as padding, truncation, or
399 continuation glyphs, or the overlay-arrow glyphs on TTYs. */
402 /* Width in pixels. */
405 /* Ascent and descent in pixels. */
406 short ascent
, descent
;
408 /* Vertical offset. If < 0, the glyph is displayed raised, if > 0
409 the glyph is displayed lowered. */
412 /* Which kind of glyph this is---character, image etc. Value
413 should be an enumerator of type enum glyph_type. */
416 /* True means this glyph was produced from multibyte text. False
417 means it was produced from unibyte text, i.e. charsets aren't
418 applicable, and encoding is not performed. */
419 bool_bf multibyte_p
: 1;
421 /* True means draw a box line at the left or right side of this
422 glyph. This is part of the implementation of the face attribute
424 bool_bf left_box_line_p
: 1;
425 bool_bf right_box_line_p
: 1;
427 /* True means this glyph's physical ascent or descent is greater
428 than its logical ascent/descent, i.e. it may potentially overlap
429 glyphs above or below it. */
430 bool_bf overlaps_vertically_p
: 1;
432 /* For terminal frames, true means glyph is a padding glyph. Padding
433 glyphs are used for characters whose visual shape consists of
434 more than one glyph (e.g. Asian characters). All but the first
435 glyph of such a glyph sequence have the padding_p flag set. This
436 flag is used only to minimize code changes. A better way would
437 probably be to use the width field of glyphs to express padding.
439 For graphic frames, true means the pixel width of the glyph in a
440 font is 0, but 1-pixel is padded on displaying for correct cursor
441 displaying. The member `pixel_width' above is set to 1. */
442 bool_bf padding_p
: 1;
444 /* True means the actual glyph is not available, draw using `struct
445 glyphless' below instead. This can happen when a font couldn't
446 be loaded, or a character doesn't have a glyph in a font. */
447 bool_bf glyph_not_available_p
: 1;
449 /* True means don't display cursor here. */
450 bool_bf avoid_cursor_p
: 1;
452 /* Resolved bidirectional level of this character [0..127]. */
453 unsigned resolved_level
: 7;
455 /* Resolved bidirectional type of this character, see enum
456 bidi_type_t below. Note that according to UAX#9, only some
457 values (STRONG_L, STRONG_R, WEAK_AN, WEAK_EN, WEAK_BN, and
458 NEUTRAL_B) can appear in the resolved type, so we only reserve
459 space for those that can. */
460 unsigned bidi_type
: 3;
462 #define FACE_ID_BITS 20
464 /* Face of the glyph. This is a realized face ID,
465 an index in the face cache of the frame. */
466 unsigned face_id
: FACE_ID_BITS
;
468 /* Type of font used to display the character glyph. May be used to
469 determine which set of functions to use to obtain font metrics
470 for the glyph. On W32, value should be an enumerator of the type
471 w32_char_font_type. Otherwise it equals FONT_TYPE_UNKNOWN. */
472 unsigned font_type
: 3;
474 /* A union of sub-structures for different glyph types. */
477 /* Metrics of a partial glyph of an image (type == IMAGE_GLYPH). */
478 struct glyph_slice img
;
479 /* Start and end indices of glyphs of a grapheme cluster of a
480 composition (type == COMPOSITE_GLYPH). */
481 struct { int from
, to
; } cmp
;
482 /* Pixel offsets for upper and lower part of the acronym. */
484 short upper_xoff
, upper_yoff
;
485 short lower_xoff
, lower_yoff
;
489 /* A union of sub-structures for different glyph types. */
492 /* Character code for character glyphs (type == CHAR_GLYPH). */
495 /* Sub-structures for type == COMPOSITE_GLYPH. */
498 /* Flag to tell if the composition is automatic or not. */
499 bool_bf automatic
: 1;
500 /* ID of the composition. */
504 /* Image ID for image glyphs (type == IMAGE_GLYPH). */
508 /* Xwidget reference (type == XWIDGET_GLYPH). */
509 struct xwidget
*xwidget
;
512 /* Sub-structure for type == STRETCH_GLYPH. */
515 /* The height of the glyph. */
516 unsigned height
: 16;
518 /* The ascent of the glyph. */
519 unsigned ascent
: 16;
523 /* Sub-stretch for type == GLYPHLESS_GLYPH. */
526 /* Value is an enum of the type glyphless_display_method. */
528 /* True iff this glyph is for a character of no font. */
529 bool_bf for_no_font
: 1;
530 /* Length of acronym or hexadecimal code string (at most 8). */
532 /* Character to display. Actually we need only 22 bits. */
536 /* Used to compare all bit-fields above in one step. */
542 /* Default value of the glyph font_type field. */
544 #define FONT_TYPE_UNKNOWN 0
546 /* Is GLYPH a space? */
548 #define CHAR_GLYPH_SPACE_P(GLYPH) \
549 ((GLYPH).u.ch == SPACEGLYPH && (GLYPH).face_id == DEFAULT_FACE_ID)
551 /* Are glyph slices of glyphs *X and *Y equal? It assumes that both
552 glyphs have the same type.
554 Note: for composition glyphs, we don't have to compare slice.cmp.to
555 because they should be the same if and only if slice.cmp.from are
558 #define GLYPH_SLICE_EQUAL_P(X, Y) \
559 ((X)->type == IMAGE_GLYPH \
560 ? ((X)->slice.img.x == (Y)->slice.img.x \
561 && (X)->slice.img.y == (Y)->slice.img.y \
562 && (X)->slice.img.width == (Y)->slice.img.width \
563 && (X)->slice.img.height == (Y)->slice.img.height) \
564 : ((X)->type != COMPOSITE_GLYPH \
565 || (X)->slice.cmp.from == (Y)->slice.cmp.from))
567 /* Are glyphs *X and *Y displayed equal? */
569 #define GLYPH_EQUAL_P(X, Y) \
570 ((X)->type == (Y)->type \
571 && (X)->u.val == (Y)->u.val \
572 && GLYPH_SLICE_EQUAL_P (X, Y) \
573 && (X)->face_id == (Y)->face_id \
574 && (X)->padding_p == (Y)->padding_p \
575 && (X)->left_box_line_p == (Y)->left_box_line_p \
576 && (X)->right_box_line_p == (Y)->right_box_line_p \
577 && (X)->voffset == (Y)->voffset \
578 && (X)->pixel_width == (Y)->pixel_width)
580 /* Are character codes, faces, padding_ps of glyphs *X and *Y equal? */
582 #define GLYPH_CHAR_AND_FACE_EQUAL_P(X, Y) \
583 ((X)->u.ch == (Y)->u.ch \
584 && (X)->face_id == (Y)->face_id \
585 && (X)->padding_p == (Y)->padding_p)
587 /* Fill a character glyph GLYPH. CODE, FACE_ID, PADDING_P correspond
588 to the bits defined for the typedef `GLYPH' in lisp.h. */
590 #define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P) \
593 (GLYPH).u.ch = (CODE); \
594 (GLYPH).face_id = (FACE_ID); \
595 (GLYPH).padding_p = (PADDING_P); \
599 /* Fill a character type glyph GLYPH from a glyph typedef FROM as
600 defined in lisp.h. */
602 #define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM) \
603 SET_CHAR_GLYPH ((GLYPH), \
604 GLYPH_CHAR ((FROM)), \
605 GLYPH_FACE ((FROM)), \
608 /* Construct a glyph code from a character glyph GLYPH. If the
609 character is multibyte, return -1 as we can't use glyph table for a
610 multibyte character. */
612 #define SET_GLYPH_FROM_CHAR_GLYPH(G, GLYPH) \
615 if ((GLYPH).u.ch < 256) \
616 SET_GLYPH ((G), (GLYPH).u.ch, ((GLYPH).face_id)); \
618 SET_GLYPH ((G), -1, 0); \
622 #define GLYPH_INVALID_P(GLYPH) (GLYPH_CHAR (GLYPH) < 0)
624 /* Is GLYPH a padding glyph? */
626 #define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p
631 /***********************************************************************
633 ***********************************************************************/
637 Glyph memory for frame-based redisplay is allocated from the heap
638 in one vector kept in a glyph pool structure which is stored with
639 the frame. The size of the vector is made large enough to cover
640 all windows on the frame.
642 Both frame and window glyph matrices reference memory from a glyph
643 pool in frame-based redisplay.
645 In window-based redisplay, no glyphs pools exist; windows allocate
646 and free their glyph memory themselves. */
650 /* Vector of glyphs allocated from the heap. */
651 struct glyph
*glyphs
;
653 /* Allocated size of `glyphs'. */
656 /* Number of rows and columns in a matrix. */
662 /***********************************************************************
664 ***********************************************************************/
668 Three kinds of glyph matrices exist:
670 1. Frame glyph matrices. These are used for terminal frames whose
671 redisplay needs a view of the whole screen due to limited terminal
672 capabilities. Frame matrices are used only in the update phase
673 of redisplay. They are built in update_frame and not used after
674 the update has been performed.
676 2. Window glyph matrices on frames having frame glyph matrices.
677 Such matrices are sub-matrices of their corresponding frame matrix,
678 i.e., frame glyph matrices and window glyph matrices share the same
679 glyph memory, which is allocated in the form of a glyph_pool structure.
680 Glyph rows in such a window matrix are slices of frame matrix rows.
682 3. Free-standing window glyph matrices managing their own glyph
683 storage. This form is used in window-based redisplay which
684 includes variable width and height fonts etc.
686 The size of a window's row vector depends on the height of fonts
687 defined on its frame. It is chosen so that the vector is large
688 enough to describe all lines in a window when it is displayed in
689 the smallest possible character size. When new fonts are loaded,
690 or window sizes change, the row vector is adjusted accordingly. */
694 /* The pool from which glyph memory is allocated, if any. This is
695 null for frame matrices and for window matrices managing their
697 struct glyph_pool
*pool
;
699 /* Vector of glyph row structures. The row at nrows - 1 is reserved
700 for the mode line. */
701 struct glyph_row
*rows
;
703 /* Number of elements allocated for the vector rows above. */
704 ptrdiff_t rows_allocated
;
706 /* The number of rows used by the window if all lines were displayed
707 with the smallest possible character height. */
710 /* Origin within the frame matrix if this is a window matrix on a
711 frame having a frame matrix. Both values are zero for
712 window-based redisplay. */
713 int matrix_x
, matrix_y
;
715 /* Width and height of the matrix in columns and rows. */
716 int matrix_w
, matrix_h
;
718 /* If this structure describes a window matrix of window W,
719 window_pixel_left is the value of W->pixel_left, window_pixel_top
720 the value of W->pixel_top, window_height and window_width are width
721 and height of W, as returned by window_box, and window_vscroll is
722 the value of W->vscroll at the time the matrix was last adjusted.
723 Only set for window-based redisplay. */
724 int window_pixel_left
, window_pixel_top
;
725 int window_height
, window_width
;
728 /* Number of glyphs reserved for left and right marginal areas when
729 the matrix was last adjusted. */
730 int left_margin_glyphs
, right_margin_glyphs
;
732 /* Flag indicating that scrolling should not be tried in
733 update_window. This flag is set by functions like try_window_id
734 which do their own scrolling. */
735 bool_bf no_scrolling_p
: 1;
737 /* True means window displayed in this matrix has a header
739 bool_bf header_line_p
: 1;
742 /* A string identifying the method used to display the matrix. */
746 /* The buffer this matrix displays. Set in
747 mark_window_display_accurate_1. */
748 struct buffer
*buffer
;
750 /* Values of BEGV and ZV as of last redisplay. Set in
751 mark_window_display_accurate_1. */
756 /* Check that glyph pointers stored in glyph rows of MATRIX are okay.
757 This aborts if any pointer is found twice. */
760 void check_matrix_pointer_lossage (struct glyph_matrix
*);
761 #define CHECK_MATRIX(MATRIX) check_matrix_pointer_lossage ((MATRIX))
763 #define CHECK_MATRIX(MATRIX) ((void) 0)
768 /***********************************************************************
770 ***********************************************************************/
772 /* Area in window glyph matrix. If values are added or removed,
773 the function mark_glyph_matrix in alloc.c may need to be changed. */
785 /* Rows of glyphs in a windows or frame glyph matrix.
787 Each row is partitioned into three areas. The start and end of
788 each area is recorded in a pointer as shown below.
790 +--------------------+-------------+---------------------+
791 | left margin area | text area | right margin area |
792 +--------------------+-------------+---------------------+
794 glyphs[LEFT_MARGIN_AREA] glyphs[RIGHT_MARGIN_AREA]
799 Rows in frame matrices reference glyph memory allocated in a frame
800 glyph pool (see the description of struct glyph_pool). Rows in
801 window matrices on frames having frame matrices reference slices of
802 the glyphs of corresponding rows in the frame matrix.
804 Rows in window matrices on frames having no frame matrices point to
805 glyphs allocated from the heap via xmalloc;
806 glyphs[LEFT_MARGIN_AREA] is the start address of the allocated
807 glyph structure array.
809 NOTE: layout of first four members of this structure is important,
810 see clear_glyph_row and copy_row_except_pointers to check why. */
814 /* Pointers to beginnings of areas. The end of an area A is found at
815 A + 1 in the vector. The last element of the vector is the end
818 Kludge alert: Even if used[TEXT_AREA] == 0, glyphs[TEXT_AREA][0]'s
819 position field is used. It is -1 if this row does not correspond
820 to any text; it is some buffer position if the row corresponds to
821 an empty display line that displays a line end. This is what old
822 redisplay used to do. (Except in code for terminal frames, this
823 kludge is no longer used, I believe. --gerd).
825 See also start, end, displays_text_p and ends_at_zv_p for cleaner
826 ways to do it. The special meaning of positions 0 and -1 will be
827 removed some day, so don't use it in new code. */
828 struct glyph
*glyphs
[1 + LAST_AREA
];
830 /* Number of glyphs actually filled in areas. This could have size
831 LAST_AREA, but it's 1 + LAST_AREA to simplify offset calculations. */
832 short used
[1 + LAST_AREA
];
834 /* Hash code. This hash code is available as soon as the row
835 is constructed, i.e. after a call to display_line. */
838 /* Window-relative x and y-position of the top-left corner of this
839 row. If y < 0, this means that eabs (y) pixels of the row are
840 invisible because it is partially visible at the top of a window.
841 If x < 0, this means that eabs (x) pixels of the first glyph of
842 the text area of the row are invisible because the glyph is
843 partially visible. */
846 /* Width of the row in pixels without taking face extension at the
847 end of the row into account, and without counting truncation
848 and continuation glyphs at the end of a row on ttys. */
851 /* Logical ascent/height of this line. The value of ascent is zero
852 and height is 1 on terminal frames. */
855 /* Physical ascent/height of this line. If max_ascent > ascent,
856 this line overlaps the line above it on the display. Otherwise,
857 if max_height > height, this line overlaps the line beneath it. */
858 int phys_ascent
, phys_height
;
860 /* Portion of row that is visible. Partially visible rows may be
861 found at the top and bottom of a window. This is 1 for tty
862 frames. It may be < 0 in case of completely invisible rows. */
865 /* Extra line spacing added after this row. Do not consider this
866 in last row when checking if row is fully visible. */
867 int extra_line_spacing
;
869 /* First position in this row. This is the text position, including
870 overlay position information etc, where the display of this row
871 started, and can thus be less than the position of the first
872 glyph (e.g. due to invisible text or horizontal scrolling).
873 BIDI Note: In R2L rows, that have its reversed_p flag set, this
874 position is at or beyond the right edge of the row. */
875 struct display_pos start
;
877 /* Text position at the end of this row. This is the position after
878 the last glyph on this row. It can be greater than the last
879 glyph position + 1, due to a newline that ends the line,
880 truncation, invisible text etc. In an up-to-date display, this
881 should always be equal to the start position of the next row.
882 BIDI Note: In R2L rows, this position is at or beyond the left
884 struct display_pos end
;
886 /* The smallest and the largest buffer positions that contributed to
887 glyphs in this row. Note that due to bidi reordering, these are
888 in general different from the text positions stored in `start'
889 and `end' members above, and also different from the buffer
890 positions recorded in the glyphs displayed the leftmost and
891 rightmost on the screen. */
892 struct text_pos minpos
, maxpos
;
894 /* Non-zero means the overlay arrow bitmap is on this line.
895 -1 means use default overlay arrow bitmap, else
896 it specifies actual fringe bitmap number. */
897 int overlay_arrow_bitmap
;
899 /* Left fringe bitmap number (enum fringe_bitmap_type). */
900 unsigned left_user_fringe_bitmap
: FRINGE_ID_BITS
;
902 /* Right fringe bitmap number (enum fringe_bitmap_type). */
903 unsigned right_user_fringe_bitmap
: FRINGE_ID_BITS
;
905 /* Left fringe bitmap number (enum fringe_bitmap_type). */
906 unsigned left_fringe_bitmap
: FRINGE_ID_BITS
;
908 /* Right fringe bitmap number (enum fringe_bitmap_type). */
909 unsigned right_fringe_bitmap
: FRINGE_ID_BITS
;
911 /* Face of the left fringe glyph. */
912 unsigned left_user_fringe_face_id
: FACE_ID_BITS
;
914 /* Face of the right fringe glyph. */
915 unsigned right_user_fringe_face_id
: FACE_ID_BITS
;
917 /* Face of the left fringe glyph. */
918 unsigned left_fringe_face_id
: FACE_ID_BITS
;
920 /* Face of the right fringe glyph. */
921 unsigned right_fringe_face_id
: FACE_ID_BITS
;
923 /* Vertical offset of the left fringe bitmap. */
924 signed left_fringe_offset
: FRINGE_HEIGHT_BITS
;
926 /* Vertical offset of the right fringe bitmap. */
927 signed right_fringe_offset
: FRINGE_HEIGHT_BITS
;
929 /* True means that at least one of the left and right fringe bitmaps is
930 periodic and thus depends on the y-position of the row. */
931 bool_bf fringe_bitmap_periodic_p
: 1;
933 /* True means that we must draw the bitmaps of this row. */
934 bool_bf redraw_fringe_bitmaps_p
: 1;
936 /* In a desired matrix, true means that this row must be updated. In a
937 current matrix, false means that the row has been invalidated, i.e.
938 the row's contents do not agree with what is visible on the
940 bool_bf enabled_p
: 1;
942 /* True means row displays a text line that is truncated on the left or
944 bool_bf truncated_on_left_p
: 1;
945 bool_bf truncated_on_right_p
: 1;
947 /* True means that this row displays a continued line, i.e. it has a
948 continuation mark at the right side. */
949 bool_bf continued_p
: 1;
951 /* False means that this row does not contain any text, i.e., it is
952 a blank line at the window and buffer end. */
953 bool_bf displays_text_p
: 1;
955 /* True means that this line ends at ZV. */
956 bool_bf ends_at_zv_p
: 1;
958 /* True means the face of the last glyph in the text area is drawn to
959 the right end of the window. This flag is used in
960 update_text_area to optimize clearing to the end of the area. */
961 bool_bf fill_line_p
: 1;
963 /* True means display a bitmap on X frames indicating that this
964 line contains no text and ends in ZV. */
965 bool_bf indicate_empty_line_p
: 1;
967 /* True means this row contains glyphs that overlap each other because
968 of lbearing or rbearing. */
969 bool_bf contains_overlapping_glyphs_p
: 1;
971 /* True means this row is as wide as the window it is displayed in, including
972 scroll bars, fringes, and internal borders. This also
973 implies that the row doesn't have marginal areas. */
974 bool_bf full_width_p
: 1;
976 /* True means row is a mode or header-line. */
977 bool_bf mode_line_p
: 1;
979 /* True in a current row means this row is overlapped by another row. */
980 bool_bf overlapped_p
: 1;
982 /* True means this line ends in the middle of a character consisting
983 of more than one glyph. Some glyphs have been put in this row,
984 the rest are put in rows below this one. */
985 bool_bf ends_in_middle_of_char_p
: 1;
987 /* True means this line starts in the middle of a character consisting
988 of more than one glyph. Some glyphs have been put in the
989 previous row, the rest are put in this row. */
990 bool_bf starts_in_middle_of_char_p
: 1;
992 /* True in a current row means this row overlaps others. */
993 bool_bf overlapping_p
: 1;
995 /* True means some glyphs in this row are displayed in mouse-face. */
996 bool_bf mouse_face_p
: 1;
998 /* True means this row was ended by a newline from a string. */
999 bool_bf ends_in_newline_from_string_p
: 1;
1001 /* True means this row width is exactly the width of the window, and the
1002 final newline character is hidden in the right fringe. */
1003 bool_bf exact_window_width_line_p
: 1;
1005 /* True means this row currently shows the cursor in the right fringe. */
1006 bool_bf cursor_in_fringe_p
: 1;
1008 /* True means the last glyph in the row is part of an ellipsis. */
1009 bool_bf ends_in_ellipsis_p
: 1;
1011 /* True means display a bitmap on X frames indicating that this
1012 the first line of the buffer. */
1013 bool_bf indicate_bob_p
: 1;
1015 /* True means display a bitmap on X frames indicating that this
1016 the top line of the window, but not start of the buffer. */
1017 bool_bf indicate_top_line_p
: 1;
1019 /* True means display a bitmap on X frames indicating that this
1020 the last line of the buffer. */
1021 bool_bf indicate_eob_p
: 1;
1023 /* True means display a bitmap on X frames indicating that this
1024 the bottom line of the window, but not end of the buffer. */
1025 bool_bf indicate_bottom_line_p
: 1;
1027 /* True means the row was reversed to display text in a
1028 right-to-left paragraph. */
1029 bool_bf reversed_p
: 1;
1031 /* Continuation lines width at the start of the row. */
1032 int continuation_lines_width
;
1034 #ifdef HAVE_WINDOW_SYSTEM
1035 /* Non-NULL means the current clipping area. This is temporarily
1036 set while exposing a region. Coordinates are frame-relative. */
1042 /* Get a pointer to row number ROW in matrix MATRIX. If GLYPH_DEBUG
1043 is defined, the function matrix_row checks that we don't try to
1044 access rows that are out of bounds. */
1047 struct glyph_row
*matrix_row (struct glyph_matrix
*, int);
1048 #define MATRIX_ROW(MATRIX, ROW) matrix_row ((MATRIX), (ROW))
1050 #define MATRIX_ROW(MATRIX, ROW) ((MATRIX)->rows + (ROW))
1053 /* Return a pointer to the row reserved for the mode line in MATRIX.
1054 Row MATRIX->nrows - 1 is always reserved for the mode line. */
1056 #define MATRIX_MODE_LINE_ROW(MATRIX) \
1057 ((MATRIX)->rows + (MATRIX)->nrows - 1)
1059 /* Return a pointer to the row reserved for the header line in MATRIX.
1060 This is always the first row in MATRIX because that's the only
1061 way that works in frame-based redisplay. */
1063 #define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows
1065 /* Return a pointer to first row in MATRIX used for text display. */
1067 #define MATRIX_FIRST_TEXT_ROW(MATRIX) \
1068 ((MATRIX)->rows->mode_line_p ? (MATRIX)->rows + 1 : (MATRIX)->rows)
1070 /* Return a pointer to the first glyph in the text area of a row.
1071 MATRIX is the glyph matrix accessed, and ROW is the row index in
1074 #define MATRIX_ROW_GLYPH_START(MATRIX, ROW) \
1075 (MATRIX_ROW ((MATRIX), (ROW))->glyphs[TEXT_AREA])
1077 /* Return the number of used glyphs in the text area of a row. */
1079 #define MATRIX_ROW_USED(MATRIX, ROW) \
1080 (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA])
1082 /* Return the character/ byte position at which the display of ROW
1083 starts. BIDI Note: this is the smallest character/byte position
1084 among characters in ROW, i.e. the first logical-order character
1085 displayed by ROW, which is not necessarily the smallest horizontal
1088 #define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->minpos.charpos)
1089 #define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->minpos.bytepos)
1091 /* Return the character/ byte position at which ROW ends. BIDI Note:
1092 this is the largest character/byte position among characters in
1093 ROW, i.e. the last logical-order character displayed by ROW, which
1094 is not necessarily the largest horizontal position. */
1096 #define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->maxpos.charpos)
1097 #define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->maxpos.bytepos)
1099 /* Return the vertical position of ROW in MATRIX. */
1101 #define MATRIX_ROW_VPOS(ROW, MATRIX) ((ROW) - (MATRIX)->rows)
1103 /* Return the last glyph row + 1 in MATRIX on window W reserved for
1104 text. If W has a mode line, the last row in the matrix is reserved
1107 #define MATRIX_BOTTOM_TEXT_ROW(MATRIX, W) \
1110 - (window_wants_mode_line ((W)) ? 1 : 0))
1112 /* Non-zero if the face of the last glyph in ROW's text area has
1113 to be drawn to the end of the text area. */
1115 #define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)
1117 /* Set and query the enabled_p flag of glyph row ROW in MATRIX. */
1119 #define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
1120 (MATRIX_ROW (MATRIX, ROW)->enabled_p = (VALUE))
1122 #define MATRIX_ROW_ENABLED_P(MATRIX, ROW) \
1123 (MATRIX_ROW (MATRIX, ROW)->enabled_p)
1125 /* Non-zero if ROW displays text. Value is non-zero if the row is
1126 blank but displays a line end. */
1128 #define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)
1133 #define MR_PARTIALLY_VISIBLE(ROW) \
1134 ((ROW)->height != (ROW)->visible_height)
1136 #define MR_PARTIALLY_VISIBLE_AT_TOP(W, ROW) \
1137 ((ROW)->y < WINDOW_HEADER_LINE_HEIGHT ((W)))
1139 #define MR_PARTIALLY_VISIBLE_AT_BOTTOM(W, ROW) \
1140 (((ROW)->y + (ROW)->height - (ROW)->extra_line_spacing) \
1141 > WINDOW_BOX_HEIGHT_NO_MODE_LINE ((W)))
1143 /* Non-zero if ROW is not completely visible in window W. */
1145 #define MATRIX_ROW_PARTIALLY_VISIBLE_P(W, ROW) \
1146 (MR_PARTIALLY_VISIBLE ((ROW)) \
1147 && (MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)) \
1148 || MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW))))
1152 /* Non-zero if ROW is partially visible at the top of window W. */
1154 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW) \
1155 (MR_PARTIALLY_VISIBLE ((ROW)) \
1156 && MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)))
1158 /* Non-zero if ROW is partially visible at the bottom of window W. */
1160 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW) \
1161 (MR_PARTIALLY_VISIBLE ((ROW)) \
1162 && MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW)))
1164 /* Return the bottom Y + 1 of ROW. */
1166 #define MATRIX_ROW_BOTTOM_Y(ROW) ((ROW)->y + (ROW)->height)
1168 /* Is ROW the last visible one in the display described by the
1169 iterator structure pointed to by IT?. */
1171 #define MATRIX_ROW_LAST_VISIBLE_P(ROW, IT) \
1172 (MATRIX_ROW_BOTTOM_Y ((ROW)) >= (IT)->last_visible_y)
1174 /* Non-zero if ROW displays a continuation line. */
1176 #define MATRIX_ROW_CONTINUATION_LINE_P(ROW) \
1177 ((ROW)->continuation_lines_width > 0)
1179 /* Non-zero if ROW ends in the middle of a character. This is the
1180 case for continued lines showing only part of a display table entry
1181 or a control char, or an overlay string. */
1183 #define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW) \
1184 ((ROW)->end.dpvec_index > 0 \
1185 || (ROW)->end.overlay_string_index >= 0 \
1186 || (ROW)->ends_in_middle_of_char_p)
1188 /* Non-zero if ROW ends in the middle of an overlay string. */
1190 #define MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P(ROW) \
1191 ((ROW)->end.overlay_string_index >= 0)
1193 /* Non-zero if ROW starts in the middle of a character. See above. */
1195 #define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW) \
1196 ((ROW)->start.dpvec_index > 0 \
1197 || (ROW)->starts_in_middle_of_char_p \
1198 || ((ROW)->start.overlay_string_index >= 0 \
1199 && (ROW)->start.string_pos.charpos > 0))
1201 /* True means ROW overlaps its predecessor. */
1203 #define MATRIX_ROW_OVERLAPS_PRED_P(ROW) \
1204 ((ROW)->phys_ascent > (ROW)->ascent)
1206 /* True means ROW overlaps its successor. */
1208 #define MATRIX_ROW_OVERLAPS_SUCC_P(ROW) \
1209 ((ROW)->phys_height - (ROW)->phys_ascent \
1210 > (ROW)->height - (ROW)->ascent)
1212 /* A glyph for a space. */
1214 extern struct glyph space_glyph
;
1216 /* True means last display completed. False means it was preempted. */
1218 extern bool display_completed
;
1222 /************************************************************************
1224 ************************************************************************/
1226 /* Enumeration for overriding/changing the face to use for drawing
1227 glyphs in draw_glyphs. */
1229 enum draw_glyphs_face
1239 #ifdef HAVE_WINDOW_SYSTEM
1241 /* A sequence of glyphs to be drawn in the same face. */
1245 /* X-origin of the string. */
1248 /* Y-origin and y-position of the base line of this string. */
1251 /* The width of the string, not including a face extension. */
1254 /* The width of the string, including a face extension. */
1255 int background_width
;
1257 /* The height of this string. This is the height of the line this
1258 string is drawn in, and can be different from the height of the
1259 font the string is drawn in. */
1262 /* Number of pixels this string overwrites in front of its x-origin.
1263 This number is zero if the string has an lbearing >= 0; it is
1264 -lbearing, if the string has an lbearing < 0. */
1267 /* Number of pixels this string overwrites past its right-most
1268 nominal x-position, i.e. x + width. Zero if the string's
1269 rbearing is <= its nominal width, rbearing - width otherwise. */
1272 /* The frame on which the glyph string is drawn. */
1275 /* The window on which the glyph string is drawn. */
1278 /* X display and window for convenience. */
1281 /* The glyph row for which this string was built. It determines the
1282 y-origin and height of the string. */
1283 struct glyph_row
*row
;
1285 /* The area within row. */
1286 enum glyph_row_area area
;
1288 /* Characters to be drawn, and number of characters. */
1292 /* A face-override for drawing cursors, mouse face and similar. */
1293 enum draw_glyphs_face hl
;
1295 /* Face in which this string is to be drawn. */
1298 /* Font in which this string is to be drawn. */
1301 /* Non-null means this string describes (part of) a static
1303 struct composition
*cmp
;
1305 /* If not negative, this string describes a compos. */
1308 /* Start and end glyph indices in a glyph-string. */
1309 int cmp_from
, cmp_to
;
1311 /* True means this glyph strings face has to be drawn to the right end
1312 of the window's drawing area. */
1313 bool_bf extends_to_end_of_line_p
: 1;
1315 /* True means the background of this string has been drawn. */
1316 bool_bf background_filled_p
: 1;
1318 /* True means that the original font determined for drawing this glyph
1319 string could not be loaded. The member `font' has been set to
1320 the frame's default font in this case. */
1321 bool_bf font_not_found_p
: 1;
1323 /* True means that the face in which this glyph string is drawn has a
1325 bool_bf stippled_p
: 1;
1327 #define OVERLAPS_PRED (1 << 0)
1328 #define OVERLAPS_SUCC (1 << 1)
1329 #define OVERLAPS_BOTH (OVERLAPS_PRED | OVERLAPS_SUCC)
1330 #define OVERLAPS_ERASED_CURSOR (1 << 2)
1331 /* Non-zero means only the foreground of this glyph string must be
1332 drawn, and we should use the physical height of the line this
1333 glyph string appears in as clip rect. If the value is
1334 OVERLAPS_ERASED_CURSOR, the clip rect is restricted to the rect
1335 of the erased cursor. OVERLAPS_PRED and OVERLAPS_SUCC mean we
1336 draw overlaps with the preceding and the succeeding rows,
1338 unsigned for_overlaps
: 3;
1340 /* True means that all glyphs in this glyph string has the flag
1341 padding_p set, and thus must be drawn one by one to have 1-pixel
1342 width even though the logical width in the font is zero. */
1343 bool_bf padding_p
: 1;
1345 /* The GC to use for drawing this glyph string. */
1346 #if defined (HAVE_X_WINDOWS)
1349 #if defined (HAVE_NTGUI)
1354 /* A pointer to the first glyph in the string. This glyph
1355 corresponds to char2b[0]. Needed to draw rectangles if
1356 font_not_found_p is true. */
1357 struct glyph
*first_glyph
;
1359 /* Image, if any. */
1363 struct xwidget
*xwidget
;
1366 struct glyph_slice slice
;
1368 /* Non-null means the horizontal clipping region starts from the
1369 left edge of *clip_head, and ends with the right edge of
1370 *clip_tail, not including their overhangs. */
1371 struct glyph_string
*clip_head
, *clip_tail
;
1373 /* The current clipping areas. */
1374 NativeRectangle clip
[2];
1376 /* Number of clipping areas. */
1379 int underline_position
;
1381 int underline_thickness
;
1383 struct glyph_string
*next
, *prev
;
1386 #endif /* HAVE_WINDOW_SYSTEM */
1389 /************************************************************************
1391 ************************************************************************/
1393 /* Return the height of the mode line in glyph matrix MATRIX, or zero
1394 if not known. This macro is called under circumstances where
1395 MATRIX might not have been allocated yet. */
1397 #define MATRIX_MODE_LINE_HEIGHT(MATRIX) \
1398 ((MATRIX) && (MATRIX)->rows \
1399 ? MATRIX_MODE_LINE_ROW (MATRIX)->height \
1402 /* Return the height of the header line in glyph matrix MATRIX, or zero
1403 if not known. This macro is called under circumstances where
1404 MATRIX might not have been allocated yet. */
1406 #define MATRIX_HEADER_LINE_HEIGHT(MATRIX) \
1407 ((MATRIX) && (MATRIX)->rows \
1408 ? MATRIX_HEADER_LINE_ROW (MATRIX)->height \
1411 /* Return the desired face id for the mode line of a window, depending
1412 on whether the window is selected or not, or if the window is the
1413 scrolling window for the currently active minibuffer window.
1415 Due to the way display_mode_lines manipulates with the contents of
1416 selected_window, this macro needs three arguments: SELW which is
1417 compared against the current value of selected_window, MBW which is
1418 compared against minibuf_window (if SELW doesn't match), and SCRW
1419 which is compared against minibuf_selected_window (if MBW matches). */
1421 #define CURRENT_MODE_LINE_FACE_ID_3(SELW, MBW, SCRW) \
1422 ((!mode_line_in_non_selected_windows \
1423 || (SELW) == XWINDOW (selected_window) \
1424 || (minibuf_level > 0 \
1425 && !NILP (minibuf_selected_window) \
1426 && (MBW) == XWINDOW (minibuf_window) \
1427 && (SCRW) == XWINDOW (minibuf_selected_window))) \
1428 ? MODE_LINE_FACE_ID \
1429 : MODE_LINE_INACTIVE_FACE_ID)
1432 /* Return the desired face id for the mode line of window W. */
1434 #define CURRENT_MODE_LINE_FACE_ID(W) \
1435 (CURRENT_MODE_LINE_FACE_ID_3((W), XWINDOW (selected_window), (W)))
1437 /* Return the current height of the mode line of window W. If not known
1438 from W->mode_line_height, look at W's current glyph matrix, or return
1439 a default based on the height of the font of the face `mode-line'. */
1441 #define CURRENT_MODE_LINE_HEIGHT(W) \
1442 (W->mode_line_height >= 0 \
1443 ? W->mode_line_height \
1444 : (W->mode_line_height \
1445 = (MATRIX_MODE_LINE_HEIGHT (W->current_matrix) \
1446 ? MATRIX_MODE_LINE_HEIGHT (W->current_matrix) \
1447 : estimate_mode_line_height \
1448 (XFRAME (W->frame), CURRENT_MODE_LINE_FACE_ID (W)))))
1450 /* Return the current height of the header line of window W. If not known
1451 from W->header_line_height, look at W's current glyph matrix, or return
1452 an estimation based on the height of the font of the face `header-line'. */
1454 #define CURRENT_HEADER_LINE_HEIGHT(W) \
1455 (W->header_line_height >= 0 \
1456 ? W->header_line_height \
1457 : (W->header_line_height \
1458 = (MATRIX_HEADER_LINE_HEIGHT (W->current_matrix) \
1459 ? MATRIX_HEADER_LINE_HEIGHT (W->current_matrix) \
1460 : estimate_mode_line_height \
1461 (XFRAME (W->frame), HEADER_LINE_FACE_ID))))
1463 /* Return the height of the desired mode line of window W. */
1465 #define DESIRED_MODE_LINE_HEIGHT(W) \
1466 MATRIX_MODE_LINE_HEIGHT ((W)->desired_matrix)
1468 /* Return the height of the desired header line of window W. */
1470 #define DESIRED_HEADER_LINE_HEIGHT(W) \
1471 MATRIX_HEADER_LINE_HEIGHT ((W)->desired_matrix)
1473 /* Return proper value to be used as baseline offset of font that has
1474 ASCENT and DESCENT to draw characters by the font at the vertical
1475 center of the line of frame F.
1477 Here, our task is to find the value of BOFF in the following figure;
1479 -------------------------+-----------+-
1480 -+-+---------+-+ | |
1482 | | | | F_ASCENT F_HEIGHT
1485 | | |-|-+------+-----------|------- baseline
1487 | |---------|-+-+ | |
1489 -+-+---------+-+ F_DESCENT |
1490 -------------------------+-----------+-
1492 -BOFF + DESCENT + (F_HEIGHT - HEIGHT) / 2 = F_DESCENT
1493 BOFF = DESCENT + (F_HEIGHT - HEIGHT) / 2 - F_DESCENT
1494 DESCENT = FONT->descent
1495 HEIGHT = FONT_HEIGHT (FONT)
1496 F_DESCENT = (FRAME_FONT (F)->descent
1497 - F->terminal->output_data.x->baseline_offset)
1498 F_HEIGHT = FRAME_LINE_HEIGHT (F)
1501 #define VCENTER_BASELINE_OFFSET(FONT, F) \
1502 (FONT_DESCENT (FONT) \
1503 + (FRAME_LINE_HEIGHT ((F)) - FONT_HEIGHT ((FONT)) \
1504 + (FRAME_LINE_HEIGHT ((F)) > FONT_HEIGHT ((FONT)))) / 2 \
1505 - (FONT_DESCENT (FRAME_FONT (F)) - FRAME_BASELINE_OFFSET (F)))
1507 /* A heuristic test for fonts that claim they need a preposterously
1508 large vertical space. The heuristics is in the factor of 3. We
1509 ignore the ascent and descent values reported by such fonts, and
1510 instead go by the values reported for individual glyphs. */
1511 #define FONT_TOO_HIGH(ft) \
1512 ((ft)->pixel_size > 0 && (ft)->ascent + (ft)->descent > 3*(ft)->pixel_size)
1515 /***********************************************************************
1517 ***********************************************************************/
1519 /* Indices of face attributes in Lisp face vectors. Slot zero is the
1522 enum lface_attribute_index
1524 LFACE_FAMILY_INDEX
= 1,
1525 LFACE_FOUNDRY_INDEX
,
1530 LFACE_UNDERLINE_INDEX
,
1531 LFACE_INVERSE_INDEX
,
1532 LFACE_FOREGROUND_INDEX
,
1533 LFACE_BACKGROUND_INDEX
,
1534 LFACE_STIPPLE_INDEX
,
1535 LFACE_OVERLINE_INDEX
,
1536 LFACE_STRIKE_THROUGH_INDEX
,
1539 LFACE_INHERIT_INDEX
,
1540 LFACE_FONTSET_INDEX
,
1541 LFACE_DISTANT_FOREGROUND_INDEX
,
1546 /* Box types of faces. */
1550 /* No box around text. */
1553 /* Simple box of specified width and color. Default width is 1, and
1554 default color is the foreground color of the face. */
1557 /* Boxes with 3D shadows. Color equals the background color of the
1558 face. Width is specified. */
1563 /* Underline type. */
1565 enum face_underline_type
1571 /* Structure describing a realized face.
1573 For each Lisp face, 0..N realized faces can exist for different
1574 frames and different charsets. Realized faces are built from Lisp
1575 faces and text properties/overlays by merging faces and adding
1576 unspecified attributes from the `default' face. */
1580 /* The Lisp face attributes this face realizes. All attributes
1581 in this vector are non-nil. */
1582 Lisp_Object lface
[LFACE_VECTOR_SIZE
];
1584 /* The id of this face. The id equals the index of this face in the
1585 vector faces_by_id of its face cache. */
1588 #ifdef HAVE_WINDOW_SYSTEM
1590 /* If non-zero, this is a GC that we can use without modification for
1591 drawing the characters in this face. */
1594 /* Background stipple or bitmap used for this face. This is
1595 an id as returned from load_pixmap. */
1598 #endif /* not HAVE_WINDOW_SYSTEM */
1600 /* Pixel value of foreground color for X frames. Color index
1602 unsigned long foreground
;
1604 /* Pixel value or color index of background color. */
1605 unsigned long background
;
1607 /* Pixel value or color index of underline color. */
1608 unsigned long underline_color
;
1610 /* Pixel value or color index of overlined, strike-through, or box
1612 unsigned long overline_color
;
1613 unsigned long strike_through_color
;
1614 unsigned long box_color
;
1618 /* Fontset ID if for this face's fontset. Non-ASCII faces derived
1619 from the same ASCII face have the same fontset. */
1622 /* Non-zero means characters in this face have a box of that
1623 thickness around them. If this value is negative, its absolute
1624 value indicates the thickness, and the horizontal (top and
1625 bottom) borders of box are drawn inside of the character glyphs'
1626 area. The vertical (left and right) borders of the box are drawn
1627 in the same way as when this value is positive. */
1630 /* Type of box drawn. A value of FACE_NO_BOX means no box is drawn
1631 around text in this face. A value of FACE_SIMPLE_BOX means a box
1632 of width box_line_width is drawn in color box_color. A value of
1633 FACE_RAISED_BOX or FACE_SUNKEN_BOX means a 3D box is drawn with
1634 shadow colors derived from the background color of the face. */
1635 ENUM_BF (face_box_type
) box
: 2;
1637 /* Style of underlining. */
1638 ENUM_BF (face_underline_type
) underline_type
: 1;
1640 /* If `box' above specifies a 3D type, true means use box_color for
1642 bool_bf use_box_color_for_shadows_p
: 1;
1644 /* Non-zero if text in this face should be underlined, overlined,
1645 strike-through or have a box drawn around it. */
1646 bool_bf underline_p
: 1;
1647 bool_bf overline_p
: 1;
1648 bool_bf strike_through_p
: 1;
1650 /* True means that the colors specified for this face could not be
1651 loaded, and were replaced by default colors, so they shouldn't be
1653 bool_bf foreground_defaulted_p
: 1;
1654 bool_bf background_defaulted_p
: 1;
1656 /* True means that either no color is specified for underlining or that
1657 the specified color couldn't be loaded. Use the foreground
1658 color when drawing in that case. */
1659 bool_bf underline_defaulted_p
: 1;
1661 /* True means that either no color is specified for the corresponding
1662 attribute or that the specified color couldn't be loaded.
1663 Use the foreground color when drawing in that case. */
1664 bool_bf overline_color_defaulted_p
: 1;
1665 bool_bf strike_through_color_defaulted_p
: 1;
1666 bool_bf box_color_defaulted_p
: 1;
1668 /* TTY appearances. Colors are found in `lface' with empty color
1669 string meaning the default color of the TTY. */
1670 bool_bf tty_bold_p
: 1;
1671 bool_bf tty_italic_p
: 1;
1672 bool_bf tty_underline_p
: 1;
1673 bool_bf tty_reverse_p
: 1;
1675 /* True means that colors of this face may not be freed because they
1676 have been copied bitwise from a base face (see
1678 bool_bf colors_copied_bitwise_p
: 1;
1680 /* If non-zero, use overstrike (to simulate bold-face). */
1681 bool_bf overstrike
: 1;
1683 /* NOTE: this is not used yet, but eventually this impl should be done
1684 similarly to overstrike */
1686 /* If non-zero, use geometric rotation (to simulate italic). */
1687 bool_bf synth_ital
: 1;
1690 /* The hash value of this face. */
1693 /* Next and previous face in hash collision list of face cache. */
1694 struct face
*next
, *prev
;
1696 /* If this face is an ASCII face, this points to this face itself.
1697 Otherwise, this points to an ASCII face that has the same
1698 attributes except the font. */
1699 struct face
*ascii_face
;
1701 #if defined HAVE_XFT || defined HAVE_FREETYPE
1702 /* Extra member that a font-driver uses privately. */
1708 /* Color index indicating that face uses a terminal's default color. */
1710 #define FACE_TTY_DEFAULT_COLOR ((unsigned long) -1)
1712 /* Color index indicating that face uses an unknown foreground color. */
1714 #define FACE_TTY_DEFAULT_FG_COLOR ((unsigned long) -2)
1716 /* Color index indicating that face uses an unknown background color. */
1718 #define FACE_TTY_DEFAULT_BG_COLOR ((unsigned long) -3)
1720 /* True if COLOR is a specified (i.e., nondefault) foreground or
1721 background color for a tty face. */
1724 face_tty_specified_color (unsigned long color
)
1726 return color
< FACE_TTY_DEFAULT_BG_COLOR
;
1729 /* Non-zero if FACE was realized for unibyte use. */
1731 #define FACE_UNIBYTE_P(FACE) ((FACE)->charset < 0)
1734 /* IDs of important faces known by the C face code. These are the IDs
1735 of the faces for CHARSET_ASCII. */
1741 MODE_LINE_INACTIVE_FACE_ID
,
1744 HEADER_LINE_FACE_ID
,
1750 VERTICAL_BORDER_FACE_ID
,
1751 WINDOW_DIVIDER_FACE_ID
,
1752 WINDOW_DIVIDER_FIRST_PIXEL_FACE_ID
,
1753 WINDOW_DIVIDER_LAST_PIXEL_FACE_ID
,
1754 INTERNAL_BORDER_FACE_ID
,
1755 BASIC_FACE_ID_SENTINEL
1758 #define MAX_FACE_ID ((1 << FACE_ID_BITS) - 1)
1760 /* A cache of realized faces. Each frame has its own cache because
1761 Emacs allows different frame-local face definitions. */
1765 /* Hash table of cached realized faces. */
1766 struct face
**buckets
;
1768 /* Back-pointer to the frame this cache belongs to. */
1771 /* A vector of faces so that faces can be referenced by an ID. */
1772 struct face
**faces_by_id
;
1774 /* The allocated size, and number of used slots of faces_by_id. */
1778 /* Flag indicating that attributes of the `menu' face have been
1780 bool_bf menu_face_changed_p
: 1;
1783 /* Return a non-null pointer to the cached face with ID on frame F. */
1785 #define FACE_FROM_ID(F, ID) \
1786 (eassert (UNSIGNED_CMP (ID, <, FRAME_FACE_CACHE (F)->used)), \
1787 FRAME_FACE_CACHE (F)->faces_by_id[ID])
1789 /* Return a pointer to the face with ID on frame F, or null if such a
1790 face doesn't exist. */
1792 #define FACE_FROM_ID_OR_NULL(F, ID) \
1793 (UNSIGNED_CMP (ID, <, FRAME_FACE_CACHE (F)->used) \
1794 ? FRAME_FACE_CACHE (F)->faces_by_id[ID] \
1797 /* True if FACE is suitable for displaying ASCII characters. */
1799 FACE_SUITABLE_FOR_ASCII_CHAR_P (struct face
*face
)
1801 #ifdef HAVE_WINDOW_SYSTEM
1802 return face
== face
->ascii_face
;
1808 /* Return the id of the realized face on frame F that is like the face
1809 FACE, but is suitable for displaying character CHARACTER at buffer or
1810 string position POS. OBJECT is the string object, or nil for
1811 buffer. This macro is only meaningful for multibyte character
1814 FACE_FOR_CHAR (struct frame
*f
, struct face
*face
, int character
,
1815 ptrdiff_t pos
, Lisp_Object object
)
1817 #ifdef HAVE_WINDOW_SYSTEM
1818 return face_for_char (f
, face
, character
, pos
, object
);
1824 /* Return true if G contains a valid character code. */
1826 GLYPH_CHAR_VALID_P (GLYPH g
)
1828 return CHAR_VALID_P (GLYPH_CHAR (g
));
1831 /* The glyph code from a display vector may either be an integer which
1832 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1833 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1836 GLYPH_CODE_P (Lisp_Object gc
)
1839 ? (CHARACTERP (XCAR (gc
))
1840 && RANGED_INTEGERP (0, XCDR (gc
), MAX_FACE_ID
))
1843 (MAX_FACE_ID
< TYPE_MAXIMUM (EMACS_INT
) >> CHARACTERBITS
1844 ? ((EMACS_INT
) MAX_FACE_ID
<< CHARACTERBITS
) | MAX_CHAR
1845 : TYPE_MAXIMUM (EMACS_INT
)))));
1848 /* True means face attributes have been changed since the last
1849 redisplay. Used in redisplay_internal. */
1851 extern bool face_change
;
1853 /* For reordering of bidirectional text. */
1855 /* UAX#9's max_depth value. */
1856 #define BIDI_MAXDEPTH 125
1858 /* Data type for describing the bidirectional character types. The
1859 first 7 must be at the beginning, because they are the only values
1860 valid in the `bidi_type' member of `struct glyph'; we only reserve
1861 3 bits for it, so we cannot use there values larger than 7.
1863 The order of members must be in sync with the 8th element of the
1864 member of unidata-prop-alist (in admin/unidata/unidata-gen.el) for
1865 Unicode character property `bidi-class'. */
1868 STRONG_L
, /* strong left-to-right */
1869 STRONG_R
, /* strong right-to-left */
1870 WEAK_EN
, /* european number */
1871 WEAK_AN
, /* arabic number */
1872 WEAK_BN
, /* boundary neutral */
1873 NEUTRAL_B
, /* paragraph separator */
1874 STRONG_AL
, /* arabic right-to-left letter */
1875 LRE
, /* left-to-right embedding */
1876 LRO
, /* left-to-right override */
1877 RLE
, /* right-to-left embedding */
1878 RLO
, /* right-to-left override */
1879 PDF
, /* pop directional format */
1880 LRI
, /* left-to-right isolate */
1881 RLI
, /* right-to-left isolate */
1882 FSI
, /* first strong isolate */
1883 PDI
, /* pop directional isolate */
1884 WEAK_ES
, /* european number separator */
1885 WEAK_ET
, /* european number terminator */
1886 WEAK_CS
, /* common separator */
1887 WEAK_NSM
, /* non-spacing mark */
1888 NEUTRAL_S
, /* segment separator */
1889 NEUTRAL_WS
, /* whitespace */
1890 NEUTRAL_ON
/* other neutrals */
1893 /* Data type for describing the Bidi Paired Bracket Type of a character.
1895 The order of members must be in sync with the 8th element of the
1896 member of unidata-prop-alist (in admin/unidata/unidata-gen.el) for
1897 Unicode character property `bracket-type'. */
1899 BIDI_BRACKET_NONE
= 1,
1902 } bidi_bracket_type_t
;
1904 /* The basic directionality data type. */
1905 typedef enum { NEUTRAL_DIR
= 0, L2R
, R2L
} bidi_dir_t
;
1907 /* Data type for storing information about characters we need to
1909 struct bidi_saved_info
{
1910 ptrdiff_t charpos
; /* character's buffer position */
1911 bidi_type_t type
; /* character's resolved bidi type */
1912 bidi_type_t orig_type
; /* bidi type as we found it in the buffer */
1915 /* Data type for keeping track of information about saved embedding
1916 levels, override status, isolate status, and isolating sequence
1917 runs. This should be as tightly packed as possible, because there
1918 are 127 such entries in each iterator state, and so the size of
1919 cache is directly affected by the size of this struct. */
1921 ptrdiff_t next_for_neutral_pos
;
1922 unsigned next_for_neutral_type
: 3;
1923 unsigned last_strong_type
: 3;
1924 unsigned prev_for_neutral_type
: 3;
1925 unsigned char level
;
1926 unsigned char flags
; /* sos, override, isolate_status */
1929 /* Data type for storing information about a string being iterated on. */
1930 struct bidi_string_data
{
1931 Lisp_Object lstring
; /* Lisp string to reorder, or nil */
1932 const unsigned char *s
; /* string data, or NULL if reordering buffer */
1933 ptrdiff_t schars
; /* the number of characters in the string,
1934 excluding the terminating null */
1935 ptrdiff_t bufpos
; /* buffer position of lstring, or 0 if N/A */
1936 bool_bf from_disp_str
: 1; /* True means the string comes from a
1938 bool_bf unibyte
: 1; /* True means the string is unibyte */
1941 /* Data type for reordering bidirectional text. */
1943 ptrdiff_t bytepos
; /* iterator's position in buffer/string */
1945 int ch
; /* character at that position, or u+FFFC
1946 ("object replacement character") for a run
1947 of characters covered by a display string */
1948 ptrdiff_t nchars
; /* its "length", usually 1; it's > 1 for a run
1949 of characters covered by a display string */
1950 ptrdiff_t ch_len
; /* its length in bytes */
1951 bidi_type_t type
; /* final bidi type of this character, after
1952 resolving weak and neutral types */
1953 bidi_type_t type_after_wn
; /* bidi type after overrides and Wn */
1954 bidi_type_t orig_type
; /* original bidi type, as found in the buffer */
1955 signed char resolved_level
; /* final resolved level of this character */
1956 signed char isolate_level
; /* count of isolate initiators unmatched by PDI */
1957 ptrdiff_t invalid_levels
; /* how many PDFs to ignore */
1958 ptrdiff_t invalid_isolates
; /* how many PDIs to ignore */
1959 struct bidi_saved_info prev
; /* info about previous character */
1960 struct bidi_saved_info last_strong
; /* last-seen strong directional char */
1961 struct bidi_saved_info next_for_neutral
; /* surrounding characters for... */
1962 struct bidi_saved_info prev_for_neutral
; /* ...resolving neutrals */
1963 struct bidi_saved_info next_for_ws
; /* character after sequence of ws */
1964 ptrdiff_t bracket_pairing_pos
; /* position of pairing bracket */
1965 bidi_type_t bracket_enclosed_type
; /* type for bracket resolution */
1966 ptrdiff_t next_en_pos
; /* pos. of next char for determining ET type */
1967 bidi_type_t next_en_type
; /* type of char at next_en_pos */
1968 bidi_dir_t sos
; /* direction of start-of-sequence in effect */
1969 int scan_dir
; /* direction of text scan, 1: forw, -1: back */
1970 ptrdiff_t disp_pos
; /* position of display string after ch */
1971 int disp_prop
; /* if non-zero, there really is a
1972 `display' property/string at disp_pos;
1973 if 2, the property is a `space' spec */
1974 int stack_idx
; /* index of current data on the stack */
1975 /* Note: Everything from here on is not copied/saved when the bidi
1976 iterator state is saved, pushed, or popped. So only put here
1977 stuff that is not part of the bidi iterator's state! */
1978 struct bidi_stack level_stack
[BIDI_MAXDEPTH
+2+1]; /* directional status stack */
1979 struct bidi_string_data string
; /* string to reorder */
1980 struct window
*w
; /* the window being displayed */
1981 bidi_dir_t paragraph_dir
; /* current paragraph direction */
1982 ptrdiff_t separator_limit
; /* where paragraph separator should end */
1983 bool_bf first_elt
: 1; /* if true, examine current char first */
1984 bool_bf new_paragraph
: 1; /* if true, we expect a new paragraph */
1985 bool_bf frame_window_p
: 1; /* true if displaying on a GUI frame */
1988 /* Value is non-zero when the bidi iterator is at base paragraph
1990 #define BIDI_AT_BASE_LEVEL(BIDI_IT) \
1991 ((BIDI_IT).resolved_level == (BIDI_IT).level_stack[0].level)
1994 /***********************************************************************
1996 ***********************************************************************/
1998 /* Structure used to describe where and how to draw a fringe bitmap.
1999 WHICH is the fringe bitmap to draw. WD and H is the (adjusted)
2000 width and height of the bitmap, DH is the height adjustment (if
2001 bitmap is periodic). X and Y are frame coordinates of the area to
2002 display the bitmap, DY is relative offset of the bitmap into that
2003 area. BX, NX, BY, NY specifies the area to clear if the bitmap
2004 does not fill the entire area. FACE is the fringe face. */
2006 struct draw_fringe_bitmap_params
2008 int which
; /* enum fringe_bitmap_type */
2009 unsigned short *bits
;
2013 bool_bf cursor_p
: 1;
2014 bool_bf overlay_p
: 1;
2018 #define MAX_FRINGE_BITMAPS (1<<FRINGE_ID_BITS)
2021 /***********************************************************************
2023 ***********************************************************************/
2025 /* Iteration over things to display in current_buffer or in a string.
2027 The iterator handles:
2029 1. Overlay strings (after-string, before-string).
2031 3. Invisible text properties.
2032 4. Selective display.
2033 5. Translation of characters via display tables.
2034 6. Translation of control characters to the forms `\003' or `^C'.
2035 7. `glyph' and `space-width' properties.
2037 Iterators are initialized by calling init_iterator or one of the
2038 equivalent functions below. A call to get_next_display_element
2039 loads the iterator structure with information about what next to
2040 display. A call to set_iterator_to_next increments the iterator's
2043 Characters from overlay strings, display table entries or control
2044 character translations are returned one at a time. For example, if
2045 we have a text of `a\x01' where `a' has a display table definition
2046 of `cd' and the control character is displayed with a leading
2047 arrow, then the iterator will return:
2049 Call Return Source Call next
2050 -----------------------------------------------------------------
2051 next c display table move
2052 next d display table move
2053 next ^ control char move
2054 next A control char move
2056 The same mechanism is also used to return characters for ellipses
2057 displayed at the end of invisible text.
2059 CAVEAT: Under some circumstances, move_.* functions can be called
2060 asynchronously, e.g. when computing a buffer position from an x and
2061 y pixel position. This means that these functions and functions
2062 called from them SHOULD NOT USE xmalloc and alike. See also the
2063 comment at the start of xdisp.c. */
2065 /* Enumeration describing what kind of display element an iterator is
2066 loaded with after a call to get_next_display_element. */
2068 enum display_element_type
2070 /* A normal character. */
2073 /* A composition (static and automatic). */
2076 /* A glyphless character (e.g. ZWNJ, LRE). */
2082 /* A flexible width and height space. */
2085 /* End of buffer or string. */
2088 /* Truncation glyphs. Never returned by get_next_display_element.
2089 Used to get display information about truncation glyphs via
2093 /* Continuation glyphs. See the comment for IT_TRUNCATION. */
2101 /* An enumerator for each text property that has a meaning for display
2110 COMPOSITION_PROP_IDX
,
2112 /* Not a property. Used to indicate changes in overlays. */
2119 /* An enumerator for the method of wrapping long lines. */
2121 enum line_wrap_method
2128 /* An enumerator for the method of displaying glyphless characters. */
2130 enum glyphless_display_method
2132 /* Display a thin (1-pixel width) space. On a TTY, display a
2133 1-character width space. */
2134 GLYPHLESS_DISPLAY_THIN_SPACE
,
2135 /* Display an empty box of proper width. */
2136 GLYPHLESS_DISPLAY_EMPTY_BOX
,
2137 /* Display an acronym string in a box. */
2138 GLYPHLESS_DISPLAY_ACRONYM
,
2139 /* Display the hexadecimal code of the character in a box. */
2140 GLYPHLESS_DISPLAY_HEX_CODE
2151 /* Input sources for fetching characters or data to display.
2152 The input source is found in the `method' field. */
2155 GET_FROM_BUFFER
= 0,
2156 GET_FROM_DISPLAY_VECTOR
,
2165 /* FIXME: What is this? Why 5? */
2166 #define IT_STACK_SIZE 5
2168 /* Iterator for composition (both for static and automatic). */
2169 struct composition_it
2171 /* Next position at which to check the composition. */
2173 /* ID number of the composition or glyph-string. If negative, we
2174 are not iterating over a composition now. */
2176 /* If non-negative, character that triggers the automatic
2177 composition at `stop_pos', and this is an automatic composition.
2178 If negative, this is a static composition. This is set to -2
2179 temporarily if searching of composition reach a limit or a
2182 /* If this is an automatic composition, index of a rule for making
2183 the automatic composition. Provided that ELT is an element of
2184 Vcomposition_function_table for CH, (nth ELT RULE_IDX) is the
2185 rule for the composition. */
2187 /* If this is an automatic composition, how many characters to look
2188 back from the position where a character triggering the
2189 composition exists. */
2191 /* If non-negative, number of glyphs of the glyph-string. */
2193 /* True iff the composition is created while buffer is scanned in
2194 reverse order, and thus the grapheme clusters must be rendered
2195 from the last to the first. */
2198 /** The following members contain information about the current
2199 grapheme cluster. */
2200 /* Position of the first character of the current grapheme cluster. */
2202 /* Number of characters and bytes of the current grapheme cluster. */
2204 /* Indices of the glyphs for the current grapheme cluster. */
2206 /* Width of the current grapheme cluster in units of columns it will
2207 occupy on display; see CHARACTER_WIDTH. */
2213 /* The window in which we iterate over current_buffer (or a string). */
2217 /* The window's frame. */
2220 /* Method to use to load this structure with the next display element. */
2221 enum it_method method
;
2223 /* The next position at which to check for face changes, invisible
2224 text, overlay strings, end of text etc., which see. */
2225 ptrdiff_t stop_charpos
;
2227 /* Previous stop position, i.e. the last one before the current
2228 iterator position in `current'. */
2229 ptrdiff_t prev_stop
;
2231 /* Last stop position iterated across whose bidi embedding level is
2232 equal to the current paragraph's base embedding level. */
2233 ptrdiff_t base_level_stop
;
2235 /* Maximum string or buffer position + 1. ZV when iterating over
2236 current_buffer. When iterating over a string in display_string,
2237 this can be smaller or greater than the number of string
2238 characters, depending on the values of PRECISION and FIELD_WIDTH
2239 with which display_string was called. */
2240 ptrdiff_t end_charpos
;
2242 /* C string to iterate over. Non-null means get characters from
2243 this string, otherwise characters are read from current_buffer
2245 const unsigned char *s
;
2247 /* Number of characters in the string (s, or it->string) we iterate
2248 over. Used only in display_string and its subroutines; never
2249 used for overlay strings and strings from display properties. */
2250 ptrdiff_t string_nchars
;
2252 /* Position at which redisplay end trigger functions should be run. */
2253 ptrdiff_t redisplay_end_trigger_charpos
;
2255 /* True means multibyte characters are enabled. */
2256 bool_bf multibyte_p
: 1;
2258 /* True means window has a mode line at its top. */
2259 bool_bf header_line_p
: 1;
2261 /* True means `string' is the value of a `display' property.
2262 Don't handle some `display' properties in these strings. */
2263 bool_bf string_from_display_prop_p
: 1;
2265 /* True means `string' comes from a `line-prefix' or `wrap-prefix'
2267 bool_bf string_from_prefix_prop_p
: 1;
2269 /* True means we are iterating an object that came from a value of a
2270 `display' property. */
2271 bool_bf from_disp_prop_p
: 1;
2273 /* When METHOD == next_element_from_display_vector,
2274 this is true if we're doing an ellipsis. Otherwise meaningless. */
2275 bool_bf ellipsis_p
: 1;
2277 /* True means cursor shouldn't be displayed here. */
2278 bool_bf avoid_cursor_p
: 1;
2280 /* Display table in effect or null for none. */
2281 struct Lisp_Char_Table
*dp
;
2283 /* Current display table vector to return characters from and its
2284 end. dpvec null means we are not returning characters from a
2285 display table entry; current.dpvec_index gives the current index
2286 into dpvec. This same mechanism is also used to return
2287 characters from translated control characters, i.e. `\003' or
2289 Lisp_Object
*dpvec
, *dpend
;
2291 /* Length in bytes of the char that filled dpvec. A value of zero
2292 means that no such character is involved. A negative value means
2293 the rest of the line from the current iterator position onwards
2294 is hidden by selective display or ellipsis. */
2297 /* Face id to use for all characters in display vector. -1 if unused. */
2300 /* Face id of the iterator saved in case a glyph from dpvec contains
2301 a face. The face is restored when all glyphs from dpvec have
2305 /* Vector of glyphs for control character translation. The pointer
2306 dpvec is set to ctl_chars when a control character is translated.
2307 This vector is also used for incomplete multibyte character
2308 translation (e.g \222\244). Such a character is at most 4 bytes,
2309 thus we need at most 16 bytes here. */
2310 Lisp_Object ctl_chars
[16];
2312 /* Initial buffer or string position of the iterator, before skipping
2313 over display properties and invisible text. */
2314 struct display_pos start
;
2316 /* Current buffer or string position of the iterator, including
2317 position in overlay strings etc. */
2318 struct display_pos current
;
2320 /* Total number of overlay strings to process. This can be >
2321 OVERLAY_STRING_CHUNK_SIZE. Value is dependable only when
2322 current.overlay_string_index >= 0. Use the latter to determine
2323 whether an overlay string is being iterated over, because
2324 n_overlay_strings can be positive even when we are not rendering
2325 an overlay string. */
2326 ptrdiff_t n_overlay_strings
;
2328 /* The charpos where n_overlay_strings was calculated. This should
2329 be set at the same time as n_overlay_strings. It is needed
2330 because we show before-strings at the start of invisible text;
2331 see handle_invisible_prop in xdisp.c. */
2332 ptrdiff_t overlay_strings_charpos
;
2334 /* Vector of overlays to process. Overlay strings are processed
2335 OVERLAY_STRING_CHUNK_SIZE at a time. */
2336 #define OVERLAY_STRING_CHUNK_SIZE 16
2337 Lisp_Object overlay_strings
[OVERLAY_STRING_CHUNK_SIZE
];
2339 /* For each overlay string, the overlay it came from. */
2340 Lisp_Object string_overlays
[OVERLAY_STRING_CHUNK_SIZE
];
2342 /* If non-nil, a Lisp string being processed. If
2343 current.overlay_string_index >= 0, this is an overlay string from
2344 pos. Use STRINGP (it.string) to test whether we are rendering a
2345 string or something else; do NOT use BUFFERP (it.object). */
2348 /* If non-nil, we are processing a string that came
2349 from a `display' property given by an overlay. */
2350 Lisp_Object from_overlay
;
2352 /* Stack of saved values. New entries are pushed when we begin to
2353 process an overlay string or a string from a `glyph' property.
2354 Entries are popped when we return to deliver display elements
2355 from what we previously had. */
2356 struct iterator_stack_entry
2360 ptrdiff_t end_charpos
;
2361 ptrdiff_t stop_charpos
;
2362 ptrdiff_t prev_stop
;
2363 ptrdiff_t base_level_stop
;
2364 struct composition_it cmp_it
;
2367 /* Save values specific to a given method. */
2369 /* method == GET_FROM_IMAGE */
2372 struct it_slice slice
;
2375 /* method == GET_FROM_STRETCH */
2379 /* method == GET_FROM_XWIDGET */
2385 /* Current text and display positions. */
2386 struct text_pos position
;
2387 struct display_pos current
;
2388 Lisp_Object from_overlay
;
2389 enum glyph_row_area area
;
2390 enum it_method method
;
2391 bidi_dir_t paragraph_embedding
;
2392 bool_bf multibyte_p
: 1;
2393 bool_bf string_from_display_prop_p
: 1;
2394 bool_bf string_from_prefix_prop_p
: 1;
2395 bool_bf display_ellipsis_p
: 1;
2396 bool_bf avoid_cursor_p
: 1;
2398 bool_bf from_disp_prop_p
: 1;
2399 enum line_wrap_method line_wrap
;
2401 /* Properties from display property that are reset by another display
2404 Lisp_Object space_width
;
2405 Lisp_Object font_height
;
2407 stack
[IT_STACK_SIZE
];
2409 /* Stack pointer. */
2412 /* -1 means selective display hides everything between a \r and the
2413 next newline; > 0 means hide lines indented more than that value. */
2414 ptrdiff_t selective
;
2416 /* An enumeration describing what the next display element is
2417 after a call to get_next_display_element. */
2418 enum display_element_type what
;
2423 /* Setting of buffer-local variable selective-display-ellipses. */
2424 bool_bf selective_display_ellipsis_p
: 1;
2426 /* True means control characters are translated into the form `^C'
2427 where the `^' can be replaced by a display table entry. */
2428 bool_bf ctl_arrow_p
: 1;
2430 /* True means that the current face has a box. */
2431 bool_bf face_box_p
: 1;
2433 /* Non-null means that the current character is the first in a run
2434 of characters with box face. */
2435 bool_bf start_of_box_run_p
: 1;
2437 /* True means that the current character is the last in a run
2438 of characters with box face. */
2439 bool_bf end_of_box_run_p
: 1;
2441 /* True means overlay strings at end_charpos have been processed. */
2442 bool_bf overlay_strings_at_end_processed_p
: 1;
2444 /* True means to ignore overlay strings at current pos, as they have
2445 already been processed. */
2446 bool_bf ignore_overlay_strings_at_pos_p
: 1;
2448 /* True means the actual glyph is not available in the current
2450 bool_bf glyph_not_available_p
: 1;
2452 /* True means the next line in display_line continues a character
2453 consisting of more than one glyph, and some glyphs of this
2454 character have been put on the previous line. */
2455 bool_bf starts_in_middle_of_char_p
: 1;
2457 /* If true, saved_face_id contains the id of the face in front of text
2458 skipped due to selective display. */
2459 bool_bf face_before_selective_p
: 1;
2461 /* If true, adjust current glyph so it does not increase current row
2462 descent/ascent (line-height property). Reset after this glyph. */
2463 bool_bf constrain_row_ascent_descent_p
: 1;
2465 enum line_wrap_method line_wrap
;
2467 /* The ID of the default face to use. One of DEFAULT_FACE_ID,
2468 MODE_LINE_FACE_ID, etc, depending on what we are displaying. */
2471 /* If `what' == IT_CHARACTER, the character and the length in bytes
2472 of its multibyte sequence. The character comes from a buffer or
2473 a string. It may be different from the character displayed in
2474 case that unibyte_display_via_language_environment is set.
2476 If `what' == IT_COMPOSITION, the first component of a composition
2477 and length in bytes of the composition.
2479 If `what' is anything else, these two are undefined (will
2480 probably hold values for the last IT_CHARACTER or IT_COMPOSITION
2481 traversed by the iterator.
2483 The values are updated by get_next_display_element, so they are
2484 out of sync with the value returned by IT_CHARPOS between the
2485 time set_iterator_to_next advances the position and the time
2486 get_next_display_element loads the new values into c and len. */
2489 /* If what == IT_COMPOSITION, iterator substructure for the
2491 struct composition_it cmp_it
;
2493 /* The character to display, possibly translated to multibyte if
2494 multibyte_p is zero or unibyte_display_via_language_environment
2495 is set. This is set after get_next_display_element has been
2496 called. If we are setting it->C directly before calling
2497 PRODUCE_GLYPHS, this should be set beforehand too. */
2498 int char_to_display
;
2500 /* If what == IT_GLYPHLESS, the method to display such a
2502 enum glyphless_display_method glyphless_method
;
2504 /* If what == IT_IMAGE, the id of the image to display. */
2507 /* If what == IT_XWIDGET. */
2508 struct xwidget
*xwidget
;
2510 /* Values from `slice' property. */
2511 struct it_slice slice
;
2513 /* Value of the `space-width' property, if any; nil if none. */
2514 Lisp_Object space_width
;
2516 /* Computed from the value of the `raise' property. */
2519 /* Number of columns per \t. */
2522 /* Value of the `height' property, if any; nil if none. */
2523 Lisp_Object font_height
;
2525 /* Object and position where the current display element came from.
2526 Object is normally the buffer which is being rendered, but it can
2527 also be a Lisp string in case the current display element comes
2528 from an overlay string or from a display string (before- or
2529 after-string). It may also be a zero-valued Lisp integer when a
2530 C string is being rendered, e.g., during mode-line or header-line
2531 update. It can also be a cons cell of the form `(space ...)',
2532 when we produce a stretch glyph from a `display' specification.
2533 Finally, it can be nil, but only temporarily, when we are
2534 producing special glyphs for display purposes, like truncation
2535 and continuation glyphs, or blanks that extend each line to the
2536 edge of the window on a TTY.
2538 Do NOT use !BUFFERP (it.object) as a test whether we are
2539 iterating over a string; use STRINGP (it.string) instead.
2541 Position is the current iterator position in object.
2543 The 'position's CHARPOS is copied to glyph->charpos of the glyph
2544 produced by PRODUCE_GLYPHS, so any artificial value documented
2545 under 'struct glyph's 'charpos' member can also be found in the
2546 'position' member here. */
2548 struct text_pos position
;
2550 /* Width in pixels of truncation and continuation glyphs. */
2551 short truncation_pixel_width
, continuation_pixel_width
;
2553 /* First and last visible x-position in the display area. If window
2554 is hscrolled by n columns, first_visible_x == n * FRAME_COLUMN_WIDTH
2555 (f), and last_visible_x == pixel width of W + first_visible_x.
2556 When truncation or continuation glyphs are produced due to lack of
2557 fringes, last_visible_x excludes the space required for these glyphs. */
2558 int first_visible_x
, last_visible_x
;
2560 /* Last visible y-position + 1 in the display area without a mode
2561 line, if the window has one. */
2564 /* Default amount of additional space in pixels between lines (for
2565 window systems only.) */
2566 int extra_line_spacing
;
2568 /* Max extra line spacing added in this row. */
2569 int max_extra_line_spacing
;
2571 /* Override font height information for this glyph.
2572 Used if override_ascent >= 0. Cleared after this glyph. */
2573 int override_ascent
, override_descent
, override_boff
;
2575 /* If non-null, glyphs are produced in glyph_row with each call to
2577 struct glyph_row
*glyph_row
;
2579 /* The area of glyph_row to which glyphs are added. */
2580 enum glyph_row_area area
;
2582 /* Number of glyphs needed for the last character requested via
2583 produce_glyphs. This is 1 except for tabs. */
2586 /* Width of the display element in pixels. Result of
2590 /* Current, maximum logical, and maximum physical line height
2591 information. Result of produce_glyphs. */
2592 int ascent
, descent
, max_ascent
, max_descent
;
2593 int phys_ascent
, phys_descent
, max_phys_ascent
, max_phys_descent
;
2595 /* Current x pixel position within the display line. This value
2596 does not include the width of continuation lines in front of the
2597 line. The value of current_x is automatically incremented by
2598 pixel_width with each call to produce_glyphs. */
2601 /* Accumulated width of continuation lines. If > 0, this means we
2602 are currently in a continuation line. This is initially zero and
2603 incremented/reset by display_line, move_it_to etc. */
2604 int continuation_lines_width
;
2606 /* Buffer position that ends the buffer text line being iterated.
2607 This is normally the position after the newline at EOL. If this
2608 is the last line of the buffer and it doesn't have a newline,
2609 value is ZV/ZV_BYTE. Set and used only if IT->bidi_p, for
2610 setting the end position of glyph rows produced for continuation
2611 lines, see display_line. */
2612 struct text_pos eol_pos
;
2614 /* Current y-position. Automatically incremented by the height of
2615 glyph_row in move_it_to and display_line. */
2618 /* Vertical matrix position of first text line in window. */
2621 /* Current vertical matrix position, or line number. Automatically
2622 incremented by move_it_to and display_line. */
2625 /* Horizontal matrix position reached in move_it_in_display_line.
2626 Only set there, not in display_line, and only when the X
2627 coordinate is past first_visible_x. */
2630 /* Current line number, zero-based. */
2633 /* The byte position corresponding to lnum. */
2634 ptrdiff_t lnum_bytepos
;
2636 /* The width, in columns and in pixels, needed for display of the
2637 line numbers, or zero if not computed. */
2639 int lnum_pixel_width
;
2641 /* The line number of point's line, or zero if not computed yet. */
2644 /* Left fringe bitmap number (enum fringe_bitmap_type). */
2645 unsigned left_user_fringe_bitmap
: FRINGE_ID_BITS
;
2647 /* Right fringe bitmap number (enum fringe_bitmap_type). */
2648 unsigned right_user_fringe_bitmap
: FRINGE_ID_BITS
;
2650 /* Face of the left fringe glyph. */
2651 unsigned left_user_fringe_face_id
: FACE_ID_BITS
;
2653 /* Face of the right fringe glyph. */
2654 unsigned right_user_fringe_face_id
: FACE_ID_BITS
;
2656 /* True means we need to reorder bidirectional text for display
2657 in the visual order. */
2660 /* For iterating over bidirectional text. */
2661 struct bidi_it bidi_it
;
2662 bidi_dir_t paragraph_embedding
;
2666 /* Access to positions of iterator IT. */
2668 #define IT_CHARPOS(IT) CHARPOS ((IT).current.pos)
2669 #define IT_BYTEPOS(IT) BYTEPOS ((IT).current.pos)
2670 #define IT_STRING_CHARPOS(IT) CHARPOS ((IT).current.string_pos)
2671 #define IT_STRING_BYTEPOS(IT) BYTEPOS ((IT).current.string_pos)
2673 /* Test if IT has reached the end of its buffer or string. This will
2674 only work after get_next_display_element has been called. */
2676 #define ITERATOR_AT_END_P(IT) ((IT)->what == IT_EOB)
2678 /* True means IT is at the end of a line. This is the case if it
2679 is either on a newline or on a carriage return and selective
2680 display hides the rest of the line. */
2682 #define ITERATOR_AT_END_OF_LINE_P(IT) \
2683 ((IT)->what == IT_CHARACTER \
2684 && ((IT)->c == '\n' \
2685 || ((IT)->c == '\r' && (IT)->selective)))
2687 /* Call produce_glyphs or FRAME_RIF->produce_glyphs, if set. Shortcut
2688 to avoid the function call overhead. */
2690 #define PRODUCE_GLYPHS(IT) \
2692 if ((IT)->glyph_row != NULL && (IT)->bidi_p) \
2693 (IT)->glyph_row->reversed_p = (IT)->bidi_it.paragraph_dir == R2L; \
2694 if (FRAME_RIF ((IT)->f) != NULL) \
2695 FRAME_RIF ((IT)->f)->produce_glyphs ((IT)); \
2697 produce_glyphs ((IT)); \
2698 if ((IT)->glyph_row != NULL) \
2699 inhibit_free_realized_faces = true; \
2702 /* Bit-flags indicating what operation move_it_to should perform. */
2704 enum move_operation_enum
2706 /* Stop if specified x-position is reached. */
2709 /* Stop if specified y-position is reached. */
2712 /* Stop if specified vpos is reached. */
2713 MOVE_TO_VPOS
= 0x04,
2715 /* Stop if specified buffer or string position is reached. */
2719 /***********************************************************************
2721 ***********************************************************************/
2723 /* Structure to hold mouse highlight data. */
2726 /* These variables describe the range of text currently shown in its
2727 mouse-face, together with the window they apply to. As long as
2728 the mouse stays within this range, we need not redraw anything on
2729 its account. Rows and columns are glyph matrix positions in
2730 MOUSE_FACE_WINDOW. */
2731 int mouse_face_beg_row
, mouse_face_beg_col
, mouse_face_beg_x
;
2732 int mouse_face_end_row
, mouse_face_end_col
, mouse_face_end_x
;
2733 Lisp_Object mouse_face_window
;
2734 int mouse_face_face_id
;
2735 Lisp_Object mouse_face_overlay
;
2737 /* FRAME and X, Y position of mouse when last checked for
2738 highlighting. X and Y can be negative or out of range for the frame. */
2739 struct frame
*mouse_face_mouse_frame
;
2740 int mouse_face_mouse_x
, mouse_face_mouse_y
;
2742 /* Nonzero if part of the text currently shown in
2743 its mouse-face is beyond the window end. */
2744 bool_bf mouse_face_past_end
: 1;
2746 /* True means defer mouse-motion highlighting. */
2747 bool_bf mouse_face_defer
: 1;
2749 /* True means that the mouse highlight should not be shown. */
2750 bool_bf mouse_face_hidden
: 1;
2754 reset_mouse_highlight (Mouse_HLInfo
*hlinfo
)
2757 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
2758 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
2759 hlinfo
->mouse_face_mouse_x
= hlinfo
->mouse_face_mouse_y
= 0;
2760 hlinfo
->mouse_face_beg_x
= hlinfo
->mouse_face_end_x
= 0;
2761 hlinfo
->mouse_face_face_id
= DEFAULT_FACE_ID
;
2762 hlinfo
->mouse_face_mouse_frame
= NULL
;
2763 hlinfo
->mouse_face_window
= Qnil
;
2764 hlinfo
->mouse_face_overlay
= Qnil
;
2765 hlinfo
->mouse_face_past_end
= false;
2766 hlinfo
->mouse_face_hidden
= false;
2767 hlinfo
->mouse_face_defer
= false;
2770 /***********************************************************************
2771 Window-based redisplay interface
2772 ***********************************************************************/
2774 /* Structure used to describe runs of lines that must be scrolled. */
2778 /* Source and destination y pixel position. */
2779 int desired_y
, current_y
;
2781 /* Source and destination vpos in matrix. */
2782 int desired_vpos
, current_vpos
;
2784 /* Height in pixels, number of glyph rows. */
2789 /* Handlers for setting frame parameters. */
2791 typedef void (*frame_parm_handler
) (struct frame
*, Lisp_Object
, Lisp_Object
);
2794 /* Structure holding system-dependent interface functions needed
2795 for window-based redisplay. */
2797 struct redisplay_interface
2799 /* Handlers for setting frame parameters. */
2800 frame_parm_handler
*frame_parm_handlers
;
2802 /* Produce glyphs/get display metrics for the display element IT is
2804 void (*produce_glyphs
) (struct it
*it
);
2806 /* Write or insert LEN glyphs from STRING at the nominal output
2808 void (*write_glyphs
) (struct window
*w
, struct glyph_row
*row
,
2809 struct glyph
*string
, enum glyph_row_area area
,
2811 void (*insert_glyphs
) (struct window
*w
, struct glyph_row
*row
,
2812 struct glyph
*start
, enum glyph_row_area area
,
2815 /* Clear from nominal output position to X. X < 0 means clear
2816 to right end of display. */
2817 void (*clear_end_of_line
) (struct window
*w
, struct glyph_row
*row
,
2818 enum glyph_row_area area
, int x
);
2820 /* Function to call to scroll the display as described by RUN on
2822 void (*scroll_run_hook
) (struct window
*w
, struct run
*run
);
2824 /* Function to call after a line in a display has been completely
2825 updated. Used to draw truncation marks and alike. DESIRED_ROW
2826 is the desired row which has been updated. */
2827 void (*after_update_window_line_hook
) (struct window
*w
,
2828 struct glyph_row
*desired_row
);
2830 /* Function to call before beginning to update window W in
2831 window-based redisplay. */
2832 void (*update_window_begin_hook
) (struct window
*w
);
2834 /* Function to call after window W has been updated in window-based
2835 redisplay. CURSOR_ON_P true means switch cursor on.
2836 MOUSE_FACE_OVERWRITTEN_P true means that some lines in W
2837 that contained glyphs in mouse-face were overwritten, so we
2838 have to update the mouse highlight. */
2839 void (*update_window_end_hook
) (struct window
*w
, bool cursor_on_p
,
2840 bool mouse_face_overwritten_p
);
2842 /* Flush the display of frame F. For X, this is XFlush. */
2843 void (*flush_display
) (struct frame
*f
);
2845 /* Clear the mouse highlight in window W, if there is any. */
2846 void (*clear_window_mouse_face
) (struct window
*w
);
2848 /* Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
2850 void (*get_glyph_overhangs
) (struct glyph
*glyph
, struct frame
*f
,
2851 int *left
, int *right
);
2853 /* Fix the display of AREA of ROW in window W for overlapping rows.
2854 This function is called from redraw_overlapping_rows after
2855 desired rows have been made current. */
2856 void (*fix_overlapping_area
) (struct window
*w
, struct glyph_row
*row
,
2857 enum glyph_row_area area
, int);
2859 #ifdef HAVE_WINDOW_SYSTEM
2861 /* Draw a fringe bitmap in window W of row ROW using parameters P. */
2862 void (*draw_fringe_bitmap
) (struct window
*w
, struct glyph_row
*row
,
2863 struct draw_fringe_bitmap_params
*p
);
2865 /* Define and destroy fringe bitmap no. WHICH. */
2866 void (*define_fringe_bitmap
) (int which
, unsigned short *bits
,
2868 void (*destroy_fringe_bitmap
) (int which
);
2870 /* Compute left and right overhang of glyph string S.
2871 A NULL pointer if platform does not support this. */
2872 void (*compute_glyph_string_overhangs
) (struct glyph_string
*s
);
2874 /* Draw a glyph string S. */
2875 void (*draw_glyph_string
) (struct glyph_string
*s
);
2877 /* Define cursor CURSOR on frame F. */
2878 void (*define_frame_cursor
) (struct frame
*f
, Cursor cursor
);
2880 /* Clear the area at (X,Y,WIDTH,HEIGHT) of frame F. */
2881 void (*clear_frame_area
) (struct frame
*f
, int x
, int y
,
2882 int width
, int height
);
2884 /* Draw specified cursor CURSOR_TYPE of width CURSOR_WIDTH
2885 at row GLYPH_ROW on window W if ON_P is true. If ON_P is
2886 false, don't draw cursor. If ACTIVE_P is true, system caret
2887 should track this cursor (when applicable). */
2888 void (*draw_window_cursor
) (struct window
*w
,
2889 struct glyph_row
*glyph_row
,
2891 enum text_cursor_kinds cursor_type
,
2892 int cursor_width
, bool on_p
, bool active_p
);
2894 /* Draw vertical border for window W from (X,Y_0) to (X,Y_1). */
2895 void (*draw_vertical_window_border
) (struct window
*w
,
2896 int x
, int y_0
, int y_1
);
2898 /* Draw window divider for window W from (X_0, Y_0) to (X_1, ,Y_1). */
2899 void (*draw_window_divider
) (struct window
*w
,
2900 int x_0
, int x_1
, int y_0
, int y_1
);
2902 /* Shift display of frame F to make room for inserted glyphs.
2903 The area at pixel (X,Y) of width WIDTH and height HEIGHT is
2904 shifted right by SHIFT_BY pixels. */
2905 void (*shift_glyphs_for_insert
) (struct frame
*f
,
2906 int x
, int y
, int width
,
2907 int height
, int shift_by
);
2909 /* Start display hourglass cursor on frame F. */
2910 void (*show_hourglass
) (struct frame
*f
);
2912 /* Cancel hourglass cursor on frame F. */
2913 void (*hide_hourglass
) (struct frame
*f
);
2915 #endif /* HAVE_WINDOW_SYSTEM */
2919 /***********************************************************************
2921 ***********************************************************************/
2923 #ifdef HAVE_WINDOW_SYSTEM
2925 /* Each image format (JPEG, TIFF, ...) supported is described by
2926 a structure of the type below. */
2930 /* Index of a symbol uniquely identifying the image type, e.g., 'jpeg'. */
2933 /* Check that SPEC is a valid image specification for the given
2934 image type. Value is true if SPEC is valid. */
2935 bool (* valid_p
) (Lisp_Object spec
);
2937 /* Load IMG which is used on frame F from information contained in
2938 IMG->spec. Value is true if successful. */
2939 bool (* load
) (struct frame
*f
, struct image
*img
);
2941 /* Free resources of image IMG which is used on frame F. */
2942 void (* free
) (struct frame
*f
, struct image
*img
);
2944 /* Initialization function (used for dynamic loading of image
2945 libraries on Windows), or NULL if none. */
2946 bool (* init
) (void);
2948 /* Next in list of all supported image types. */
2949 struct image_type
*next
;
2953 /* Structure describing an image. Specific image formats like XBM are
2954 converted into this form, so that display only has to deal with
2955 this type of image. */
2959 /* The time in seconds at which the image was last displayed. Set
2960 in prepare_image_for_display. */
2961 struct timespec timestamp
;
2963 /* Pixmaps of the image. */
2964 Pixmap pixmap
, mask
;
2970 #ifdef HAVE_X_WINDOWS
2971 /* X images of the image, corresponding to the above Pixmaps.
2972 Non-NULL means it and its Pixmap counterpart may be out of sync
2973 and the latter is outdated. NULL means the X image has been
2974 synchronized to Pixmap. */
2975 XImagePtr ximg
, mask_img
;
2978 /* Colors allocated for this image, if any. Allocated via xmalloc. */
2979 unsigned long *colors
;
2982 /* A single `background color' for this image, for the use of anyone that
2983 cares about such a thing. Only valid if the `background_valid' field
2984 is true. This should generally be accessed by calling the accessor
2985 macro `IMAGE_BACKGROUND', which will heuristically calculate a value
2987 unsigned long background
;
2989 /* Foreground and background colors of the frame on which the image
2991 unsigned long frame_foreground
, frame_background
;
2993 /* True if this image has a `transparent' background -- that is, is
2994 uses an image mask. The accessor macro for this is
2995 `IMAGE_BACKGROUND_TRANSPARENT'. */
2996 bool_bf background_transparent
: 1;
2998 /* True if the `background' and `background_transparent' fields are
2999 valid, respectively. */
3000 bool_bf background_valid
: 1, background_transparent_valid
: 1;
3002 /* Width and height of the image. */
3005 /* These values are used for the rectangles displayed for images
3006 that can't be loaded. */
3007 #define DEFAULT_IMAGE_WIDTH 30
3008 #define DEFAULT_IMAGE_HEIGHT 30
3010 /* Top/left and bottom/right corner pixel of actual image data.
3011 Used by four_corners_best to consider the real image data,
3012 rather than looking at the optional image margin. */
3014 #define TOP_CORNER 0
3015 #define LEFT_CORNER 1
3016 #define BOT_CORNER 2
3017 #define RIGHT_CORNER 3
3019 /* Percent of image height used as ascent. A value of
3020 CENTERED_IMAGE_ASCENT means draw the image centered on the
3023 #define DEFAULT_IMAGE_ASCENT 50
3024 #define CENTERED_IMAGE_ASCENT -1
3026 /* Lisp specification of this image. */
3029 /* List of "references" followed to build the image.
3030 Typically will just contain the name of the image file.
3031 Used to allow fine-grained cache flushing. */
3032 Lisp_Object dependencies
;
3034 /* Relief to draw around the image. */
3037 /* Optional margins around the image. This includes the relief. */
3038 int hmargin
, vmargin
;
3040 /* Reference to the type of the image. */
3041 struct image_type
*type
;
3043 /* True means that loading the image failed. Don't try again. */
3046 /* A place for image types to store additional data. It is marked
3048 Lisp_Object lisp_data
;
3050 /* Hash value of image specification to speed up comparisons. */
3053 /* Image id of this image. */
3056 /* Hash collision chain. */
3057 struct image
*next
, *prev
;
3061 /* Cache of images. Each frame has a cache. X frames with the same
3062 x_display_info share their caches. */
3066 /* Hash table of images. */
3067 struct image
**buckets
;
3069 /* Vector mapping image ids to images. */
3070 struct image
**images
;
3072 /* Allocated size of `images'. */
3075 /* Number of images in the cache. */
3078 /* Reference count (number of frames sharing this cache). */
3083 /* A non-null pointer to the image with id ID on frame F. */
3085 #define IMAGE_FROM_ID(F, ID) \
3086 (eassert (UNSIGNED_CMP (ID, <, FRAME_IMAGE_CACHE (F)->used)), \
3087 FRAME_IMAGE_CACHE (F)->images[ID])
3089 /* Value is a pointer to the image with id ID on frame F, or null if
3090 no image with that id exists. */
3092 #define IMAGE_OPT_FROM_ID(F, ID) \
3093 (UNSIGNED_CMP (ID, <, FRAME_IMAGE_CACHE (F)->used) \
3094 ? FRAME_IMAGE_CACHE (F)->images[ID] \
3097 /* Size of bucket vector of image caches. Should be prime. */
3099 #define IMAGE_CACHE_BUCKETS_SIZE 1001
3101 #endif /* HAVE_WINDOW_SYSTEM */
3105 /***********************************************************************
3107 ***********************************************************************/
3109 /* Enumeration defining where to find tool-bar item information in
3110 tool-bar items vectors stored with frames. Each tool-bar item
3111 occupies TOOL_BAR_ITEM_NSLOTS elements in such a vector. */
3113 enum tool_bar_item_idx
3115 /* The key of the tool-bar item. Used to remove items when a binding
3116 for `undefined' is found. */
3119 /* Non-nil if item is enabled. */
3120 TOOL_BAR_ITEM_ENABLED_P
,
3122 /* Non-nil if item is selected (pressed). */
3123 TOOL_BAR_ITEM_SELECTED_P
,
3126 TOOL_BAR_ITEM_CAPTION
,
3128 /* Image(s) to display. This is either a single image specification
3129 or a vector of specifications. */
3130 TOOL_BAR_ITEM_IMAGES
,
3133 TOOL_BAR_ITEM_BINDING
,
3135 /* Button type. One of nil (default button), t (a separator),
3136 `:radio', or `:toggle'. The latter two currently do nothing. */
3142 /* Icon file name of right to left image when an RTL locale is used. */
3143 TOOL_BAR_ITEM_RTL_IMAGE
,
3145 /* Label to show when text labels are enabled. */
3146 TOOL_BAR_ITEM_LABEL
,
3148 /* If we shall show the label only below the icon and not beside it. */
3149 TOOL_BAR_ITEM_VERT_ONLY
,
3151 /* Sentinel = number of slots in tool_bar_items occupied by one
3153 TOOL_BAR_ITEM_NSLOTS
3157 /* An enumeration for the different images that can be specified
3158 for a tool-bar item. */
3160 enum tool_bar_item_image
3162 TOOL_BAR_IMAGE_ENABLED_SELECTED
,
3163 TOOL_BAR_IMAGE_ENABLED_DESELECTED
,
3164 TOOL_BAR_IMAGE_DISABLED_SELECTED
,
3165 TOOL_BAR_IMAGE_DISABLED_DESELECTED
3168 #define DEFAULT_TOOL_BAR_LABEL_SIZE 14
3170 /* Default values of the above variables. */
3172 #define DEFAULT_TOOL_BAR_BUTTON_MARGIN 4
3173 #define DEFAULT_TOOL_BAR_BUTTON_RELIEF 1
3175 /* The height in pixels of the default tool-bar images. */
3177 #define DEFAULT_TOOL_BAR_IMAGE_HEIGHT 24
3180 /***********************************************************************
3181 Terminal Capabilities
3182 ***********************************************************************/
3184 /* Each of these is a bit representing a terminal `capability' (bold,
3185 inverse, etc). They are or'd together to specify the set of
3186 capabilities being queried for when calling `tty_capable_p' (which
3187 returns true if the terminal supports all of them). */
3189 #define TTY_CAP_INVERSE 0x01
3190 #define TTY_CAP_UNDERLINE 0x02
3191 #define TTY_CAP_BOLD 0x04
3192 #define TTY_CAP_DIM 0x08
3193 #define TTY_CAP_ITALIC 0x10
3196 /***********************************************************************
3198 ***********************************************************************/
3200 /* Defined in bidi.c */
3202 extern void bidi_init_it (ptrdiff_t, ptrdiff_t, bool, struct bidi_it
*);
3203 extern void bidi_move_to_visually_next (struct bidi_it
*);
3204 extern void bidi_paragraph_init (bidi_dir_t
, struct bidi_it
*, bool);
3205 extern int bidi_mirror_char (int);
3206 extern void bidi_push_it (struct bidi_it
*);
3207 extern void bidi_pop_it (struct bidi_it
*);
3208 extern void *bidi_shelve_cache (void);
3209 extern void bidi_unshelve_cache (void *, bool);
3210 extern ptrdiff_t bidi_find_first_overridden (struct bidi_it
*);
3212 /* Defined in xdisp.c */
3214 struct glyph_row
*row_containing_pos (struct window
*, ptrdiff_t,
3216 struct glyph_row
*, int);
3217 int line_bottom_y (struct it
*);
3218 int default_line_pixel_height (struct window
*);
3219 bool display_prop_intangible_p (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3220 void resize_echo_area_exactly (void);
3221 bool resize_mini_window (struct window
*, bool);
3222 void set_vertical_scroll_bar (struct window
*);
3223 void set_horizontal_scroll_bar (struct window
*);
3224 int try_window (Lisp_Object
, struct text_pos
, int);
3225 void window_box (struct window
*, enum glyph_row_area
,
3226 int *, int *, int *, int *);
3227 int window_box_height (struct window
*);
3228 int window_text_bottom_y (struct window
*);
3229 int window_box_width (struct window
*, enum glyph_row_area
);
3230 int window_box_left (struct window
*, enum glyph_row_area
);
3231 int window_box_left_offset (struct window
*, enum glyph_row_area
);
3232 int window_box_right (struct window
*, enum glyph_row_area
);
3233 int estimate_mode_line_height (struct frame
*, enum face_id
);
3234 int move_it_to (struct it
*, ptrdiff_t, int, int, int, int);
3235 void pixel_to_glyph_coords (struct frame
*, int, int, int *, int *,
3236 NativeRectangle
*, bool);
3237 void remember_mouse_glyph (struct frame
*, int, int, NativeRectangle
*);
3239 void mark_window_display_accurate (Lisp_Object
, bool);
3240 void redisplay_preserve_echo_area (int);
3241 void init_iterator (struct it
*, struct window
*, ptrdiff_t,
3242 ptrdiff_t, struct glyph_row
*, enum face_id
);
3243 void init_iterator_to_row_start (struct it
*, struct window
*,
3244 struct glyph_row
*);
3245 void start_display (struct it
*, struct window
*, struct text_pos
);
3246 void move_it_vertically (struct it
*, int);
3247 void move_it_vertically_backward (struct it
*, int);
3248 void move_it_by_lines (struct it
*, ptrdiff_t);
3249 void move_it_past_eol (struct it
*);
3250 void move_it_in_display_line (struct it
*it
,
3251 ptrdiff_t to_charpos
, int to_x
,
3252 enum move_operation_enum op
);
3253 int partial_line_height (struct it
*it_origin
);
3254 bool in_display_vector_p (struct it
*);
3255 int frame_mode_line_height (struct frame
*);
3256 extern bool redisplaying_p
;
3257 extern bool help_echo_showing_p
;
3258 extern Lisp_Object help_echo_string
, help_echo_window
;
3259 extern Lisp_Object help_echo_object
, previous_help_echo_string
;
3260 extern ptrdiff_t help_echo_pos
;
3261 extern int last_tool_bar_item
;
3262 extern void reseat_at_previous_visible_line_start (struct it
*);
3263 extern Lisp_Object
lookup_glyphless_char_display (int, struct it
*);
3264 extern ptrdiff_t compute_display_string_pos (struct text_pos
*,
3265 struct bidi_string_data
*,
3266 struct window
*, bool, int *);
3267 extern ptrdiff_t compute_display_string_end (ptrdiff_t,
3268 struct bidi_string_data
*);
3269 extern void produce_stretch_glyph (struct it
*);
3270 extern int merge_glyphless_glyph_face (struct it
*);
3271 extern void forget_escape_and_glyphless_faces (void);
3273 extern void get_font_ascent_descent (struct font
*, int *, int *);
3275 #ifdef HAVE_WINDOW_SYSTEM
3278 extern void dump_glyph_string (struct glyph_string
*) EXTERNALLY_VISIBLE
;
3281 extern void x_get_glyph_overhangs (struct glyph
*, struct frame
*,
3283 extern struct font
*font_for_underline_metrics (struct glyph_string
*);
3284 extern void x_produce_glyphs (struct it
*);
3286 extern void x_write_glyphs (struct window
*, struct glyph_row
*,
3287 struct glyph
*, enum glyph_row_area
, int);
3288 extern void x_insert_glyphs (struct window
*, struct glyph_row
*,
3289 struct glyph
*, enum glyph_row_area
, int);
3290 extern void x_clear_end_of_line (struct window
*, struct glyph_row
*,
3291 enum glyph_row_area
, int);
3292 extern void x_fix_overlapping_area (struct window
*, struct glyph_row
*,
3293 enum glyph_row_area
, int);
3294 extern void draw_phys_cursor_glyph (struct window
*,
3296 enum draw_glyphs_face
);
3297 extern void get_phys_cursor_geometry (struct window
*, struct glyph_row
*,
3298 struct glyph
*, int *, int *, int *);
3299 extern void erase_phys_cursor (struct window
*);
3300 extern void display_and_set_cursor (struct window
*, bool, int, int, int, int);
3301 extern void x_update_cursor (struct frame
*, bool);
3302 extern void x_clear_cursor (struct window
*);
3303 extern void x_draw_vertical_border (struct window
*w
);
3304 extern void x_draw_right_divider (struct window
*w
);
3306 extern int get_glyph_string_clip_rects (struct glyph_string
*,
3307 NativeRectangle
*, int);
3308 extern void get_glyph_string_clip_rect (struct glyph_string
*,
3309 NativeRectangle
*nr
);
3310 extern Lisp_Object
find_hot_spot (Lisp_Object
, int, int);
3312 extern void handle_tool_bar_click (struct frame
*,
3313 int, int, bool, int);
3315 extern void expose_frame (struct frame
*, int, int, int, int);
3316 extern bool x_intersect_rectangles (XRectangle
*, XRectangle
*, XRectangle
*);
3317 #endif /* HAVE_WINDOW_SYSTEM */
3319 extern void note_mouse_highlight (struct frame
*, int, int);
3320 extern void x_clear_window_mouse_face (struct window
*);
3321 extern void cancel_mouse_face (struct frame
*);
3322 extern bool clear_mouse_face (Mouse_HLInfo
*);
3323 extern bool cursor_in_mouse_face_p (struct window
*w
);
3324 extern void tty_draw_row_with_mouse_face (struct window
*, struct glyph_row
*,
3325 int, int, enum draw_glyphs_face
);
3326 extern void display_tty_menu_item (const char *, int, int, int, int, bool);
3328 /* Flags passed to try_window. */
3329 #define TRY_WINDOW_CHECK_MARGINS (1 << 0)
3330 #define TRY_WINDOW_IGNORE_FONTS_CHANGE (1 << 1)
3332 int lookup_fringe_bitmap (Lisp_Object
);
3333 void draw_fringe_bitmap (struct window
*, struct glyph_row
*, int);
3334 void draw_row_fringe_bitmaps (struct window
*, struct glyph_row
*);
3335 bool draw_window_fringes (struct window
*, bool);
3336 bool update_window_fringes (struct window
*, bool);
3339 void w32_init_fringe (struct redisplay_interface
*);
3340 void w32_reset_fringes (void);
3343 void x_cr_init_fringe (struct redisplay_interface
*);
3346 extern unsigned row_hash (struct glyph_row
*);
3348 extern bool buffer_flipping_blocked_p (void);
3350 /* Defined in image.c */
3352 #ifdef HAVE_WINDOW_SYSTEM
3354 extern ptrdiff_t x_bitmap_pixmap (struct frame
*, ptrdiff_t);
3355 extern void x_reference_bitmap (struct frame
*, ptrdiff_t);
3356 extern ptrdiff_t x_create_bitmap_from_data (struct frame
*, char *,
3357 unsigned int, unsigned int);
3358 extern ptrdiff_t x_create_bitmap_from_file (struct frame
*, Lisp_Object
);
3359 #if defined HAVE_XPM && defined HAVE_X_WINDOWS && !defined USE_GTK
3360 extern ptrdiff_t x_create_bitmap_from_xpm_data (struct frame
*, const char **);
3362 #ifndef x_destroy_bitmap
3363 extern void x_destroy_bitmap (struct frame
*, ptrdiff_t);
3365 extern void x_destroy_all_bitmaps (Display_Info
*);
3366 extern void x_create_bitmap_mask (struct frame
*, ptrdiff_t);
3367 extern Lisp_Object
x_find_image_file (Lisp_Object
);
3369 void x_kill_gs_process (Pixmap
, struct frame
*);
3370 struct image_cache
*make_image_cache (void);
3371 void free_image_cache (struct frame
*);
3372 void clear_image_caches (Lisp_Object
);
3373 void mark_image_cache (struct image_cache
*);
3374 bool valid_image_p (Lisp_Object
);
3375 void prepare_image_for_display (struct frame
*, struct image
*);
3376 ptrdiff_t lookup_image (struct frame
*, Lisp_Object
);
3378 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3379 #define RGB_PIXEL_COLOR unsigned long
3383 #define RGB_PIXEL_COLOR COLORREF
3386 RGB_PIXEL_COLOR
image_background (struct image
*, struct frame
*,
3387 XImagePtr_or_DC ximg
);
3388 int image_background_transparent (struct image
*, struct frame
*,
3389 XImagePtr_or_DC mask
);
3391 int image_ascent (struct image
*, struct face
*, struct glyph_slice
*);
3395 /* Defined in sysdep.c */
3397 void get_tty_size (int, int *, int *);
3398 void request_sigio (void);
3399 void unrequest_sigio (void);
3400 bool tabs_safe_p (int);
3401 void init_baud_rate (int);
3402 void init_sigio (int);
3404 /* Defined in xfaces.c. */
3406 #ifdef HAVE_X_WINDOWS
3407 void unload_color (struct frame
*, unsigned long);
3408 void x_free_colors (struct frame
*, unsigned long *, int);
3411 void update_face_from_frame_parameter (struct frame
*, Lisp_Object
,
3413 Lisp_Object
tty_color_name (struct frame
*, int);
3414 void clear_face_cache (bool);
3415 unsigned long load_color (struct frame
*, struct face
*, Lisp_Object
,
3416 enum lface_attribute_index
);
3417 char *choose_face_font (struct frame
*, Lisp_Object
*, Lisp_Object
,
3419 #ifdef HAVE_WINDOW_SYSTEM
3420 void prepare_face_for_display (struct frame
*, struct face
*);
3422 int lookup_named_face (struct frame
*, Lisp_Object
, bool);
3423 int lookup_basic_face (struct frame
*, int);
3424 int smaller_face (struct frame
*, int, int);
3425 int face_with_height (struct frame
*, int, int);
3426 int lookup_derived_face (struct frame
*, Lisp_Object
, int, bool);
3427 void init_frame_faces (struct frame
*);
3428 void free_frame_faces (struct frame
*);
3429 void recompute_basic_faces (struct frame
*);
3430 int face_at_buffer_position (struct window
*, ptrdiff_t, ptrdiff_t *, ptrdiff_t,
3432 int face_for_overlay_string (struct window
*, ptrdiff_t, ptrdiff_t *, ptrdiff_t,
3434 int face_at_string_position (struct window
*, Lisp_Object
, ptrdiff_t, ptrdiff_t,
3435 ptrdiff_t *, enum face_id
, bool);
3436 int merge_faces (struct frame
*, Lisp_Object
, int, int);
3437 int compute_char_face (struct frame
*, int, Lisp_Object
);
3438 void free_all_realized_faces (Lisp_Object
);
3439 extern char unspecified_fg
[], unspecified_bg
[];
3441 /* Defined in xfns.c. */
3443 #ifdef HAVE_X_WINDOWS
3444 void gamma_correct (struct frame
*, XColor
*);
3447 void gamma_correct (struct frame
*, COLORREF
*);
3450 #ifdef HAVE_WINDOW_SYSTEM
3452 void x_implicitly_set_name (struct frame
*, Lisp_Object
, Lisp_Object
);
3453 void x_change_tool_bar_height (struct frame
*f
, int);
3455 /* The frame used to display a tooltip.
3457 Note: In a GTK build with non-zero x_gtk_use_system_tooltips, this
3458 variable holds the frame that shows the tooltip, not the frame of
3459 the tooltip itself, so checking whether a frame is a tooltip frame
3460 cannot just compare the frame to what this variable holds. */
3461 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 */