1 /* Interface definitions for display code.
3 Copyright (C) 1985, 1993-1994, 1997-2013 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
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>. */
22 #ifndef DISPEXTERN_H_INCLUDED
23 #define DISPEXTERN_H_INCLUDED
25 #include "character.h"
31 #include <X11/Intrinsic.h>
32 #endif /* USE_X_TOOLKIT */
34 #else /* !HAVE_X_WINDOWS */
36 /* X-related stuff used by non-X gui code. */
40 unsigned short red
, green
, blue
;
45 #endif /* HAVE_X_WINDOWS */
52 #ifndef DISPEXTERN_INLINE
53 # define DISPEXTERN_INLINE INLINE
56 #include <c-strcase.h>
58 xstrcasecmp (char const *a
, char const *b
)
60 return c_strcasecmp (a
, b
);
64 #include <X11/Xresource.h> /* for XrmDatabase */
65 typedef struct x_display_info Display_Info
;
66 typedef XImage
* XImagePtr
;
67 typedef XImagePtr XImagePtr_or_DC
;
68 #define NativeRectangle XRectangle
73 typedef struct w32_display_info Display_Info
;
74 typedef XImage
*XImagePtr
;
75 typedef HDC XImagePtr_or_DC
;
80 /* Following typedef needed to accommodate the MSDOS port, believe it or not. */
81 typedef struct ns_display_info Display_Info
;
82 typedef Pixmap XImagePtr
;
83 typedef XImagePtr XImagePtr_or_DC
;
86 #ifdef HAVE_WINDOW_SYSTEM
90 #ifndef HAVE_WINDOW_SYSTEM
95 #ifndef NativeRectangle
96 #define NativeRectangle int
99 /* Text cursor types. */
101 enum text_cursor_kinds
111 /* Values returned from coordinates_in_window. */
127 /* Number of bits allocated to store fringe bitmap numbers. */
128 #define FRINGE_ID_BITS 16
130 /* Number of bits allocated to store fringe bitmap height. */
131 #define FRINGE_HEIGHT_BITS 8
134 /***********************************************************************
136 ***********************************************************************/
138 /* If GLYPH_DEBUG is defined, additional checks are activated. */
140 /* Macros to include code only if GLYPH_DEBUG is defined. */
143 #define IF_DEBUG(X) X
145 #define IF_DEBUG(X) (void) 0
148 /* Macro for displaying traces of redisplay. If Emacs was compiled
149 with GLYPH_DEBUG defined, the variable trace_redisplay_p can be set to
150 a non-zero value in debugging sessions to activate traces. */
154 extern int trace_redisplay_p EXTERNALLY_VISIBLE
;
158 if (trace_redisplay_p) \
163 #else /* not GLYPH_DEBUG */
165 #define TRACE(X) (void) 0
167 #endif /* GLYPH_DEBUG */
171 /***********************************************************************
173 ***********************************************************************/
175 /* Starting with Emacs 20.3, characters from strings and buffers have
176 both a character and a byte position associated with them. The
177 following structure holds such a pair of positions. */
181 /* Character position. */
184 /* Corresponding byte position. */
188 /* Access character and byte position of POS in a functional form. */
190 #define BYTEPOS(POS) (POS).bytepos
191 #define CHARPOS(POS) (POS).charpos
193 /* Set character position of POS to CHARPOS, byte position to BYTEPOS. */
195 #define SET_TEXT_POS(POS, CHARPOS, BYTEPOS) \
196 ((POS).charpos = (CHARPOS), (POS).bytepos = BYTEPOS)
198 /* Increment text position POS. */
200 #define INC_TEXT_POS(POS, MULTIBYTE_P) \
205 INC_POS ((POS).bytepos); \
211 /* Decrement text position POS. */
213 #define DEC_TEXT_POS(POS, MULTIBYTE_P) \
218 DEC_POS ((POS).bytepos); \
224 /* Set text position POS from marker MARKER. */
226 #define SET_TEXT_POS_FROM_MARKER(POS, MARKER) \
227 (CHARPOS (POS) = marker_position (MARKER), \
228 BYTEPOS (POS) = marker_byte_position (MARKER))
230 /* Like above, but clip POS within accessible range. */
232 #define CLIP_TEXT_POS_FROM_MARKER(POS, MARKER) \
233 (CHARPOS (POS) = clip_to_bounds \
234 (BEGV, marker_position (MARKER), ZV), \
235 BYTEPOS (POS) = clip_to_bounds \
236 (BEGV_BYTE, marker_byte_position (MARKER), ZV_BYTE))
238 /* Set marker MARKER from text position POS. */
240 #define SET_MARKER_FROM_TEXT_POS(MARKER, POS) \
241 set_marker_both ((MARKER), Qnil, CHARPOS ((POS)), BYTEPOS ((POS)))
243 /* Value is non-zero if character and byte positions of POS1 and POS2
246 #define TEXT_POS_EQUAL_P(POS1, POS2) \
247 ((POS1).charpos == (POS2).charpos \
248 && (POS1).bytepos == (POS2).bytepos)
250 /* When rendering glyphs, redisplay scans string or buffer text,
251 overlay strings in that text, and does display table or control
252 character translations. The following structure captures a
253 position taking all this into account. */
257 /* Buffer or string position. */
260 /* If this is a position in an overlay string, overlay_string_index
261 is the index of that overlay string in the sequence of overlay
262 strings at `pos' in the order redisplay processes them. A value
263 < 0 means that this is not a position in an overlay string. */
264 ptrdiff_t overlay_string_index
;
266 /* If this is a position in an overlay string, string_pos is the
267 position within that string. */
268 struct text_pos string_pos
;
270 /* If the character at the position above is a control character or
271 has a display table entry, dpvec_index is an index in the display
272 table or control character translation of that character. A
273 value < 0 means this is not a position in such a translation. */
279 /***********************************************************************
281 ***********************************************************************/
283 /* The glyph datatype, used to represent characters on the display.
284 It consists of a char code and a face id. */
291 /* Return a glyph's character code. */
292 DISPEXTERN_INLINE
int GLYPH_CHAR (GLYPH glyph
) { return glyph
.ch
; }
294 /* Return a glyph's face ID. */
295 DISPEXTERN_INLINE
int GLYPH_FACE (GLYPH glyph
) { return glyph
.face_id
; }
297 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
298 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
299 #define SET_GLYPH(glyph, char, face) \
300 ((glyph).ch = (char), (glyph).face_id = (face))
302 /* The following are valid only if GLYPH_CODE_P (gc). */
304 DISPEXTERN_INLINE
int
305 GLYPH_CODE_CHAR (Lisp_Object gc
)
309 : XINT (gc
) & MAX_CHAR
);
312 DISPEXTERN_INLINE
int
313 GLYPH_CODE_FACE (Lisp_Object gc
)
315 return CONSP (gc
) ? XINT (XCDR (gc
)) : XINT (gc
) >> CHARACTERBITS
;
318 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
322 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
324 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
325 (XINT (gc) >> CHARACTERBITS)); \
329 /* The ID of the mode line highlighting face. */
330 enum { GLYPH_MODE_LINE_FACE
= 1 };
332 /* Enumeration of glyph types. Glyph structures contain a type field
333 containing one of the enumerators defined here. */
337 /* Glyph describes a character. */
340 /* Glyph describes a static composition. */
343 /* Glyph describes a glyphless character. */
346 /* Glyph describes an image. */
349 /* Glyph is a space of fractional width and/or height. */
354 /* Structure describing how to use partial glyphs (images slicing) */
361 unsigned height
: 16;
367 Be extra careful when changing this structure! Esp. make sure that
368 functions producing glyphs, like append_glyph, fill ALL of the
369 glyph structure, and that GLYPH_EQUAL_P compares all
370 display-relevant members of glyphs (not to imply that these are the
371 only things to check when you add a member). */
375 /* Position from which this glyph was drawn. If `object' below is a
376 Lisp string, this is an index into that string. If it is a
377 buffer, this is a position in that buffer. In addition, some
378 special glyphs have special values for this:
380 glyph standing for newline at end of line 0
381 empty space after the end of the line -1
382 overlay arrow on a TTY -1
383 glyph at EOB that ends in a newline -1
384 left truncation glyphs: -1
385 right truncation/continuation glyphs next buffer position
386 glyph standing for newline of an empty line buffer position of newline
387 stretch glyph at left edge of R2L lines buffer position of newline */
390 /* Lisp object source of this glyph. Currently either a buffer or a
391 string, if the glyph was produced from characters which came from
392 a buffer or a string; or Lisp integer zero (a.k.a. "null object")
393 if the glyph was inserted by redisplay for its own purposes, such
394 as padding or truncation/continuation glyphs, or the
395 overlay-arrow glyphs on TTYs. */
398 /* Width in pixels. */
401 /* Ascent and descent in pixels. */
402 short ascent
, descent
;
404 /* Vertical offset. If < 0, the glyph is displayed raised, if > 0
405 the glyph is displayed lowered. */
408 /* Which kind of glyph this is---character, image etc. Value
409 should be an enumerator of type enum glyph_type. */
412 /* 1 means this glyph was produced from multibyte text. Zero
413 means it was produced from unibyte text, i.e. charsets aren't
414 applicable, and encoding is not performed. */
415 unsigned multibyte_p
: 1;
417 /* Non-zero means draw a box line at the left or right side of this
418 glyph. This is part of the implementation of the face attribute
420 unsigned left_box_line_p
: 1;
421 unsigned right_box_line_p
: 1;
423 /* Non-zero means this glyph's physical ascent or descent is greater
424 than its logical ascent/descent, i.e. it may potentially overlap
425 glyphs above or below it. */
426 unsigned overlaps_vertically_p
: 1;
428 /* For terminal frames, 1 means glyph is a padding glyph. Padding
429 glyphs are used for characters whose visual shape consists of
430 more than one glyph (e.g. Asian characters). All but the first
431 glyph of such a glyph sequence have the padding_p flag set. This
432 flag is used only to minimize code changes. A better way would
433 probably be to use the width field of glyphs to express padding.
435 For graphic frames, 1 means the pixel width of the glyph in a
436 font is 0, but 1-pixel is padded on displaying for correct cursor
437 displaying. The member `pixel_width' above is set to 1. */
438 unsigned padding_p
: 1;
440 /* 1 means the actual glyph is not available, draw using `struct
441 glyphless' below instead. This can happen when a font couldn't
442 be loaded, or a character doesn't have a glyph in a font. */
443 unsigned glyph_not_available_p
: 1;
445 /* Non-zero means don't display cursor here. */
446 unsigned avoid_cursor_p
: 1;
448 /* Resolved bidirectional level of this character [0..63]. */
449 unsigned resolved_level
: 5;
451 /* Resolved bidirectional type of this character, see enum
452 bidi_type_t below. Note that according to UAX#9, only some
453 values (STRONG_L, STRONG_R, WEAK_AN, WEAK_EN, WEAK_BN, and
454 NEUTRAL_B) can appear in the resolved type, so we only reserve
455 space for those that can. */
456 unsigned bidi_type
: 3;
458 #define FACE_ID_BITS 20
460 /* Face of the glyph. This is a realized face ID,
461 an index in the face cache of the frame. */
462 unsigned face_id
: FACE_ID_BITS
;
464 /* Type of font used to display the character glyph. May be used to
465 determine which set of functions to use to obtain font metrics
466 for the glyph. On W32, value should be an enumerator of the type
467 w32_char_font_type. Otherwise it equals FONT_TYPE_UNKNOWN. */
468 unsigned font_type
: 3;
470 /* A union of sub-structures for different glyph types. */
473 /* Metrics of a partial glyph of an image (type == IMAGE_GLYPH). */
474 struct glyph_slice img
;
475 /* Start and end indices of glyphs of a grapheme cluster of a
476 composition (type == COMPOSITE_GLYPH). */
477 struct { int from
, to
; } cmp
;
478 /* Pixel offsets for upper and lower part of the acronym. */
480 short upper_xoff
, upper_yoff
;
481 short lower_xoff
, lower_yoff
;
485 /* A union of sub-structures for different glyph types. */
488 /* Character code for character glyphs (type == CHAR_GLYPH). */
491 /* Sub-structures for type == COMPOSITE_GLYPH. */
494 /* Flag to tell if the composition is automatic or not. */
495 unsigned automatic
: 1;
496 /* ID of the composition. */
500 /* Image ID for image glyphs (type == IMAGE_GLYPH). */
503 /* Sub-structure for type == STRETCH_GLYPH. */
506 /* The height of the glyph. */
507 unsigned height
: 16;
509 /* The ascent of the glyph. */
510 unsigned ascent
: 16;
514 /* Sub-stretch for type == GLYPHLESS_GLYPH. */
517 /* Value is an enum of the type glyphless_display_method. */
519 /* 1 iff this glyph is for a character of no font. */
520 unsigned for_no_font
: 1;
521 /* Length of acronym or hexadecimal code string (at most 8). */
523 /* Character to display. Actually we need only 22 bits. */
527 /* Used to compare all bit-fields above in one step. */
533 /* Default value of the glyph font_type field. */
535 #define FONT_TYPE_UNKNOWN 0
537 /* Is GLYPH a space? */
539 #define CHAR_GLYPH_SPACE_P(GLYPH) \
540 ((GLYPH).u.ch == SPACEGLYPH && (GLYPH).face_id == DEFAULT_FACE_ID)
542 /* Are glyph slices of glyphs *X and *Y equal? It assumes that both
543 glyphs have the same type.
545 Note: for composition glyphs, we don't have to compare slice.cmp.to
546 because they should be the same if and only if slice.cmp.from are
549 #define GLYPH_SLICE_EQUAL_P(X, Y) \
550 ((X)->type == IMAGE_GLYPH \
551 ? ((X)->slice.img.x == (Y)->slice.img.x \
552 && (X)->slice.img.y == (Y)->slice.img.y \
553 && (X)->slice.img.width == (Y)->slice.img.width \
554 && (X)->slice.img.height == (Y)->slice.img.height) \
555 : ((X)->type != COMPOSITE_GLYPH \
556 || (X)->slice.cmp.from == (Y)->slice.cmp.from))
558 /* Are glyphs *X and *Y displayed equal? */
560 #define GLYPH_EQUAL_P(X, Y) \
561 ((X)->type == (Y)->type \
562 && (X)->u.val == (Y)->u.val \
563 && GLYPH_SLICE_EQUAL_P (X, Y) \
564 && (X)->face_id == (Y)->face_id \
565 && (X)->padding_p == (Y)->padding_p \
566 && (X)->left_box_line_p == (Y)->left_box_line_p \
567 && (X)->right_box_line_p == (Y)->right_box_line_p \
568 && (X)->voffset == (Y)->voffset \
569 && (X)->pixel_width == (Y)->pixel_width)
571 /* Are character codes, faces, padding_ps of glyphs *X and *Y equal? */
573 #define GLYPH_CHAR_AND_FACE_EQUAL_P(X, Y) \
574 ((X)->u.ch == (Y)->u.ch \
575 && (X)->face_id == (Y)->face_id \
576 && (X)->padding_p == (Y)->padding_p)
578 /* Fill a character glyph GLYPH. CODE, FACE_ID, PADDING_P correspond
579 to the bits defined for the typedef `GLYPH' in lisp.h. */
581 #define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P) \
584 (GLYPH).u.ch = (CODE); \
585 (GLYPH).face_id = (FACE_ID); \
586 (GLYPH).padding_p = (PADDING_P); \
590 /* Fill a character type glyph GLYPH from a glyph typedef FROM as
591 defined in lisp.h. */
593 #define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM) \
594 SET_CHAR_GLYPH ((GLYPH), \
595 GLYPH_CHAR ((FROM)), \
596 GLYPH_FACE ((FROM)), \
599 /* Construct a glyph code from a character glyph GLYPH. If the
600 character is multibyte, return -1 as we can't use glyph table for a
601 multibyte character. */
603 #define SET_GLYPH_FROM_CHAR_GLYPH(G, GLYPH) \
606 if ((GLYPH).u.ch < 256) \
607 SET_GLYPH ((G), (GLYPH).u.ch, ((GLYPH).face_id)); \
609 SET_GLYPH ((G), -1, 0); \
613 #define GLYPH_INVALID_P(GLYPH) (GLYPH_CHAR (GLYPH) < 0)
615 /* Is GLYPH a padding glyph? */
617 #define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p
622 /***********************************************************************
624 ***********************************************************************/
628 Glyph memory for frame-based redisplay is allocated from the heap
629 in one vector kept in a glyph pool structure which is stored with
630 the frame. The size of the vector is made large enough to cover
631 all windows on the frame.
633 Both frame and window glyph matrices reference memory from a glyph
634 pool in frame-based redisplay.
636 In window-based redisplay, no glyphs pools exist; windows allocate
637 and free their glyph memory themselves. */
641 /* Vector of glyphs allocated from the heap. */
642 struct glyph
*glyphs
;
644 /* Allocated size of `glyphs'. */
647 /* Number of rows and columns in a matrix. */
653 /***********************************************************************
655 ***********************************************************************/
659 Three kinds of glyph matrices exist:
661 1. Frame glyph matrices. These are used for terminal frames whose
662 redisplay needs a view of the whole screen due to limited terminal
663 capabilities. Frame matrices are used only in the update phase
664 of redisplay. They are built in update_frame and not used after
665 the update has been performed.
667 2. Window glyph matrices on frames having frame glyph matrices.
668 Such matrices are sub-matrices of their corresponding frame matrix,
669 i.e., frame glyph matrices and window glyph matrices share the same
670 glyph memory, which is allocated in the form of a glyph_pool structure.
671 Glyph rows in such a window matrix are slices of frame matrix rows.
673 2. Free-standing window glyph matrices managing their own glyph
674 storage. This form is used in window-based redisplay which
675 includes variable width and height fonts etc.
677 The size of a window's row vector depends on the height of fonts
678 defined on its frame. It is chosen so that the vector is large
679 enough to describe all lines in a window when it is displayed in
680 the smallest possible character size. When new fonts are loaded,
681 or window sizes change, the row vector is adjusted accordingly. */
685 /* The pool from which glyph memory is allocated, if any. This is
686 null for frame matrices and for window matrices managing their
688 struct glyph_pool
*pool
;
690 /* Vector of glyph row structures. The row at nrows - 1 is reserved
691 for the mode line. */
692 struct glyph_row
*rows
;
694 /* Number of elements allocated for the vector rows above. */
695 ptrdiff_t rows_allocated
;
697 /* The number of rows used by the window if all lines were displayed
698 with the smallest possible character height. */
701 /* Origin within the frame matrix if this is a window matrix on a
702 frame having a frame matrix. Both values are zero for
703 window-based redisplay. */
704 int matrix_x
, matrix_y
;
706 /* Width and height of the matrix in columns and rows. */
707 int matrix_w
, matrix_h
;
709 /* If this structure describes a window matrix of window W,
710 window_left_col is the value of W->left_col, window_top_line the
711 value of W->top_line, window_height and window_width are width and
712 height of W, as returned by window_box, and window_vscroll is the
713 value of W->vscroll at the time the matrix was last adjusted.
714 Only set for window-based redisplay. */
715 int window_left_col
, window_top_line
;
716 int window_height
, window_width
;
719 /* Number of glyphs reserved for left and right marginal areas when
720 the matrix was last adjusted. */
721 int left_margin_glyphs
, right_margin_glyphs
;
723 /* Flag indicating that scrolling should not be tried in
724 update_window. This flag is set by functions like try_window_id
725 which do their own scrolling. */
726 unsigned no_scrolling_p
: 1;
728 /* Non-zero means window displayed in this matrix has a top mode
730 unsigned header_line_p
: 1;
733 /* A string identifying the method used to display the matrix. */
737 /* The buffer this matrix displays. Set in
738 mark_window_display_accurate_1. */
739 struct buffer
*buffer
;
741 /* Values of BEGV and ZV as of last redisplay. Set in
742 mark_window_display_accurate_1. */
747 /* Check that glyph pointers stored in glyph rows of MATRIX are okay.
748 This aborts if any pointer is found twice. */
751 void check_matrix_pointer_lossage (struct glyph_matrix
*);
752 #define CHECK_MATRIX(MATRIX) check_matrix_pointer_lossage ((MATRIX))
754 #define CHECK_MATRIX(MATRIX) (void) 0
759 /***********************************************************************
761 ***********************************************************************/
763 /* Area in window glyph matrix. If values are added or removed,
764 the function mark_glyph_matrix in alloc.c may need to be changed. */
776 /* Rows of glyphs in a windows or frame glyph matrix.
778 Each row is partitioned into three areas. The start and end of
779 each area is recorded in a pointer as shown below.
781 +--------------------+-------------+---------------------+
782 | left margin area | text area | right margin area |
783 +--------------------+-------------+---------------------+
785 glyphs[LEFT_MARGIN_AREA] glyphs[RIGHT_MARGIN_AREA]
790 Rows in frame matrices reference glyph memory allocated in a frame
791 glyph pool (see the description of struct glyph_pool). Rows in
792 window matrices on frames having frame matrices reference slices of
793 the glyphs of corresponding rows in the frame matrix.
795 Rows in window matrices on frames having no frame matrices point to
796 glyphs allocated from the heap via xmalloc;
797 glyphs[LEFT_MARGIN_AREA] is the start address of the allocated
798 glyph structure array. */
802 /* Pointers to beginnings of areas. The end of an area A is found at
803 A + 1 in the vector. The last element of the vector is the end
806 Kludge alert: Even if used[TEXT_AREA] == 0, glyphs[TEXT_AREA][0]'s
807 position field is used. It is -1 if this row does not correspond
808 to any text; it is some buffer position if the row corresponds to
809 an empty display line that displays a line end. This is what old
810 redisplay used to do. (Except in code for terminal frames, this
811 kludge is no longer used, I believe. --gerd).
813 See also start, end, displays_text_p and ends_at_zv_p for cleaner
814 ways to do it. The special meaning of positions 0 and -1 will be
815 removed some day, so don't use it in new code. */
816 struct glyph
*glyphs
[1 + LAST_AREA
];
818 /* Number of glyphs actually filled in areas. */
819 short used
[LAST_AREA
];
821 /* Window-relative x and y-position of the top-left corner of this
822 row. If y < 0, this means that eabs (y) pixels of the row are
823 invisible because it is partially visible at the top of a window.
824 If x < 0, this means that eabs (x) pixels of the first glyph of
825 the text area of the row are invisible because the glyph is
826 partially visible. */
829 /* Width of the row in pixels without taking face extension at the
830 end of the row into account, and without counting truncation
831 and continuation glyphs at the end of a row on ttys. */
834 /* Logical ascent/height of this line. The value of ascent is zero
835 and height is 1 on terminal frames. */
838 /* Physical ascent/height of this line. If max_ascent > ascent,
839 this line overlaps the line above it on the display. Otherwise,
840 if max_height > height, this line overlaps the line beneath it. */
841 int phys_ascent
, phys_height
;
843 /* Portion of row that is visible. Partially visible rows may be
844 found at the top and bottom of a window. This is 1 for tty
845 frames. It may be < 0 in case of completely invisible rows. */
848 /* Extra line spacing added after this row. Do not consider this
849 in last row when checking if row is fully visible. */
850 int extra_line_spacing
;
852 /* Hash code. This hash code is available as soon as the row
853 is constructed, i.e. after a call to display_line. */
856 /* First position in this row. This is the text position, including
857 overlay position information etc, where the display of this row
858 started, and can thus be less than the position of the first
859 glyph (e.g. due to invisible text or horizontal scrolling).
860 BIDI Note: In R2L rows, that have its reversed_p flag set, this
861 position is at or beyond the right edge of the row. */
862 struct display_pos start
;
864 /* Text position at the end of this row. This is the position after
865 the last glyph on this row. It can be greater than the last
866 glyph position + 1, due to a newline that ends the line,
867 truncation, invisible text etc. In an up-to-date display, this
868 should always be equal to the start position of the next row.
869 BIDI Note: In R2L rows, this position is at or beyond the left
871 struct display_pos end
;
873 /* The smallest and the largest buffer positions that contributed to
874 glyphs in this row. Note that due to bidi reordering, these are
875 in general different from the text positions stored in `start'
876 and `end' members above, and also different from the buffer
877 positions recorded in the glyphs displayed the leftmost and
878 rightmost on the screen. */
879 struct text_pos minpos
, maxpos
;
881 /* Non-zero means the overlay arrow bitmap is on this line.
882 -1 means use default overlay arrow bitmap, else
883 it specifies actual fringe bitmap number. */
884 int overlay_arrow_bitmap
;
886 /* Left fringe bitmap number (enum fringe_bitmap_type). */
887 unsigned left_user_fringe_bitmap
: FRINGE_ID_BITS
;
889 /* Right fringe bitmap number (enum fringe_bitmap_type). */
890 unsigned right_user_fringe_bitmap
: FRINGE_ID_BITS
;
892 /* Left fringe bitmap number (enum fringe_bitmap_type). */
893 unsigned left_fringe_bitmap
: FRINGE_ID_BITS
;
895 /* Right fringe bitmap number (enum fringe_bitmap_type). */
896 unsigned right_fringe_bitmap
: FRINGE_ID_BITS
;
898 /* Face of the left fringe glyph. */
899 unsigned left_user_fringe_face_id
: FACE_ID_BITS
;
901 /* Face of the right fringe glyph. */
902 unsigned right_user_fringe_face_id
: FACE_ID_BITS
;
904 /* Face of the left fringe glyph. */
905 unsigned left_fringe_face_id
: FACE_ID_BITS
;
907 /* Face of the right fringe glyph. */
908 unsigned right_fringe_face_id
: FACE_ID_BITS
;
910 /* Vertical offset of the left fringe bitmap. */
911 signed left_fringe_offset
: FRINGE_HEIGHT_BITS
;
913 /* Vertical offset of the right fringe bitmap. */
914 signed right_fringe_offset
: FRINGE_HEIGHT_BITS
;
916 /* 1 means that at least one of the left and right fringe bitmaps is
917 periodic and thus depends on the y-position of the row. */
918 unsigned fringe_bitmap_periodic_p
: 1;
920 /* 1 means that we must draw the bitmaps of this row. */
921 unsigned redraw_fringe_bitmaps_p
: 1;
923 /* In a desired matrix, 1 means that this row must be updated. In a
924 current matrix, 0 means that the row has been invalidated, i.e.
925 the row's contents do not agree with what is visible on the
927 unsigned enabled_p
: 1;
929 /* 1 means row displays a text line that is truncated on the left or
931 unsigned truncated_on_left_p
: 1;
932 unsigned truncated_on_right_p
: 1;
934 /* 1 means that this row displays a continued line, i.e. it has a
935 continuation mark at the right side. */
936 unsigned continued_p
: 1;
938 /* 0 means that this row does not contain any text, i.e. it is
939 a blank line at the window and buffer end. */
940 unsigned displays_text_p
: 1;
942 /* 1 means that this line ends at ZV. */
943 unsigned ends_at_zv_p
: 1;
945 /* 1 means the face of the last glyph in the text area is drawn to
946 the right end of the window. This flag is used in
947 update_text_area to optimize clearing to the end of the area. */
948 unsigned fill_line_p
: 1;
950 /* Non-zero means display a bitmap on X frames indicating that this
951 line contains no text and ends in ZV. */
952 unsigned indicate_empty_line_p
: 1;
954 /* 1 means this row contains glyphs that overlap each other because
955 of lbearing or rbearing. */
956 unsigned contains_overlapping_glyphs_p
: 1;
958 /* 1 means this row is as wide as the window it is displayed in, including
959 scroll bars, fringes, and internal borders. This also
960 implies that the row doesn't have marginal areas. */
961 unsigned full_width_p
: 1;
963 /* Non-zero means row is a mode or header-line. */
964 unsigned mode_line_p
: 1;
966 /* 1 in a current row means this row is overlapped by another row. */
967 unsigned overlapped_p
: 1;
969 /* 1 means this line ends in the middle of a character consisting
970 of more than one glyph. Some glyphs have been put in this row,
971 the rest are put in rows below this one. */
972 unsigned ends_in_middle_of_char_p
: 1;
974 /* 1 means this line starts in the middle of a character consisting
975 of more than one glyph. Some glyphs have been put in the
976 previous row, the rest are put in this row. */
977 unsigned starts_in_middle_of_char_p
: 1;
979 /* 1 in a current row means this row overlaps others. */
980 unsigned overlapping_p
: 1;
982 /* 1 means some glyphs in this row are displayed in mouse-face. */
983 unsigned mouse_face_p
: 1;
985 /* 1 means this row was ended by a newline from a string. */
986 unsigned ends_in_newline_from_string_p
: 1;
988 /* 1 means this row width is exactly the width of the window, and the
989 final newline character is hidden in the right fringe. */
990 unsigned exact_window_width_line_p
: 1;
992 /* 1 means this row currently shows the cursor in the right fringe. */
993 unsigned cursor_in_fringe_p
: 1;
995 /* 1 means the last glyph in the row is part of an ellipsis. */
996 unsigned ends_in_ellipsis_p
: 1;
998 /* Non-zero means display a bitmap on X frames indicating that this
999 the first line of the buffer. */
1000 unsigned indicate_bob_p
: 1;
1002 /* Non-zero means display a bitmap on X frames indicating that this
1003 the top line of the window, but not start of the buffer. */
1004 unsigned indicate_top_line_p
: 1;
1006 /* Non-zero means display a bitmap on X frames indicating that this
1007 the last line of the buffer. */
1008 unsigned indicate_eob_p
: 1;
1010 /* Non-zero means display a bitmap on X frames indicating that this
1011 the bottom line of the window, but not end of the buffer. */
1012 unsigned indicate_bottom_line_p
: 1;
1014 /* Non-zero means the row was reversed to display text in a
1015 right-to-left paragraph. */
1016 unsigned reversed_p
: 1;
1018 /* Continuation lines width at the start of the row. */
1019 int continuation_lines_width
;
1021 #ifdef HAVE_WINDOW_SYSTEM
1022 /* Non-NULL means the current clipping area. This is temporarily
1023 set while exposing a region. Coordinates are frame-relative. */
1029 /* Get a pointer to row number ROW in matrix MATRIX. If GLYPH_DEBUG
1030 is defined, the function matrix_row checks that we don't try to
1031 access rows that are out of bounds. */
1034 struct glyph_row
*matrix_row (struct glyph_matrix
*, int);
1035 #define MATRIX_ROW(MATRIX, ROW) matrix_row ((MATRIX), (ROW))
1037 #define MATRIX_ROW(MATRIX, ROW) ((MATRIX)->rows + (ROW))
1040 /* Return a pointer to the row reserved for the mode line in MATRIX.
1041 Row MATRIX->nrows - 1 is always reserved for the mode line. */
1043 #define MATRIX_MODE_LINE_ROW(MATRIX) \
1044 ((MATRIX)->rows + (MATRIX)->nrows - 1)
1046 /* Return a pointer to the row reserved for the header line in MATRIX.
1047 This is always the first row in MATRIX because that's the only
1048 way that works in frame-based redisplay. */
1050 #define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows
1052 /* Return a pointer to first row in MATRIX used for text display. */
1054 #define MATRIX_FIRST_TEXT_ROW(MATRIX) \
1055 ((MATRIX)->rows->mode_line_p ? (MATRIX)->rows + 1 : (MATRIX)->rows)
1057 /* Return a pointer to the first glyph in the text area of a row.
1058 MATRIX is the glyph matrix accessed, and ROW is the row index in
1061 #define MATRIX_ROW_GLYPH_START(MATRIX, ROW) \
1062 (MATRIX_ROW ((MATRIX), (ROW))->glyphs[TEXT_AREA])
1064 /* Return the number of used glyphs in the text area of a row. */
1066 #define MATRIX_ROW_USED(MATRIX, ROW) \
1067 (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA])
1069 /* Return the character/ byte position at which the display of ROW
1070 starts. BIDI Note: this is the smallest character/byte position
1071 among characters in ROW, i.e. the first logical-order character
1072 displayed by ROW, which is not necessarily the smallest horizontal
1075 #define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->minpos.charpos)
1076 #define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->minpos.bytepos)
1078 /* Return the character/ byte position at which ROW ends. BIDI Note:
1079 this is the largest character/byte position among characters in
1080 ROW, i.e. the last logical-order character displayed by ROW, which
1081 is not necessarily the largest horizontal position. */
1083 #define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->maxpos.charpos)
1084 #define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->maxpos.bytepos)
1086 /* Return the vertical position of ROW in MATRIX. */
1088 #define MATRIX_ROW_VPOS(ROW, MATRIX) ((ROW) - (MATRIX)->rows)
1090 /* Return the last glyph row + 1 in MATRIX on window W reserved for
1091 text. If W has a mode line, the last row in the matrix is reserved
1094 #define MATRIX_BOTTOM_TEXT_ROW(MATRIX, W) \
1097 - (WINDOW_WANTS_MODELINE_P ((W)) ? 1 : 0))
1099 /* Non-zero if the face of the last glyph in ROW's text area has
1100 to be drawn to the end of the text area. */
1102 #define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)
1104 /* Set and query the enabled_p flag of glyph row ROW in MATRIX. */
1106 #define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
1107 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0)
1109 #define MATRIX_ROW_ENABLED_P(MATRIX, ROW) \
1110 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p)
1112 /* Non-zero if ROW displays text. Value is non-zero if the row is
1113 blank but displays a line end. */
1115 #define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)
1120 #define MR_PARTIALLY_VISIBLE(ROW) \
1121 ((ROW)->height != (ROW)->visible_height)
1123 #define MR_PARTIALLY_VISIBLE_AT_TOP(W, ROW) \
1124 ((ROW)->y < WINDOW_HEADER_LINE_HEIGHT ((W)))
1126 #define MR_PARTIALLY_VISIBLE_AT_BOTTOM(W, ROW) \
1127 (((ROW)->y + (ROW)->height - (ROW)->extra_line_spacing) \
1128 > WINDOW_BOX_HEIGHT_NO_MODE_LINE ((W)))
1130 /* Non-zero if ROW is not completely visible in window W. */
1132 #define MATRIX_ROW_PARTIALLY_VISIBLE_P(W, ROW) \
1133 (MR_PARTIALLY_VISIBLE ((ROW)) \
1134 && (MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)) \
1135 || MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW))))
1139 /* Non-zero if ROW is partially visible at the top of window W. */
1141 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW) \
1142 (MR_PARTIALLY_VISIBLE ((ROW)) \
1143 && MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)))
1145 /* Non-zero if ROW is partially visible at the bottom of window W. */
1147 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW) \
1148 (MR_PARTIALLY_VISIBLE ((ROW)) \
1149 && MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW)))
1151 /* Return the bottom Y + 1 of ROW. */
1153 #define MATRIX_ROW_BOTTOM_Y(ROW) ((ROW)->y + (ROW)->height)
1155 /* Is ROW the last visible one in the display described by the
1156 iterator structure pointed to by IT?. */
1158 #define MATRIX_ROW_LAST_VISIBLE_P(ROW, IT) \
1159 (MATRIX_ROW_BOTTOM_Y ((ROW)) >= (IT)->last_visible_y)
1161 /* Non-zero if ROW displays a continuation line. */
1163 #define MATRIX_ROW_CONTINUATION_LINE_P(ROW) \
1164 ((ROW)->continuation_lines_width > 0)
1166 /* Non-zero if ROW ends in the middle of a character. This is the
1167 case for continued lines showing only part of a display table entry
1168 or a control char, or an overlay string. */
1170 #define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW) \
1171 ((ROW)->end.dpvec_index > 0 \
1172 || (ROW)->end.overlay_string_index >= 0 \
1173 || (ROW)->ends_in_middle_of_char_p)
1175 /* Non-zero if ROW ends in the middle of an overlay string. */
1177 #define MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P(ROW) \
1178 ((ROW)->end.overlay_string_index >= 0)
1180 /* Non-zero if ROW starts in the middle of a character. See above. */
1182 #define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW) \
1183 ((ROW)->start.dpvec_index > 0 \
1184 || (ROW)->starts_in_middle_of_char_p \
1185 || ((ROW)->start.overlay_string_index >= 0 \
1186 && (ROW)->start.string_pos.charpos > 0))
1188 /* Non-zero means ROW overlaps its predecessor. */
1190 #define MATRIX_ROW_OVERLAPS_PRED_P(ROW) \
1191 ((ROW)->phys_ascent > (ROW)->ascent)
1193 /* Non-zero means ROW overlaps its successor. */
1195 #define MATRIX_ROW_OVERLAPS_SUCC_P(ROW) \
1196 ((ROW)->phys_height - (ROW)->phys_ascent \
1197 > (ROW)->height - (ROW)->ascent)
1199 /* A glyph for a space. */
1201 extern struct glyph space_glyph
;
1203 /* Non-zero means last display completed. Zero means it was
1206 extern bool display_completed
;
1210 /************************************************************************
1212 ************************************************************************/
1214 /* Enumeration for overriding/changing the face to use for drawing
1215 glyphs in draw_glyphs. */
1217 enum draw_glyphs_face
1227 #ifdef HAVE_WINDOW_SYSTEM
1229 /* A sequence of glyphs to be drawn in the same face. */
1233 /* X-origin of the string. */
1236 /* Y-origin and y-position of the base line of this string. */
1239 /* The width of the string, not including a face extension. */
1242 /* The width of the string, including a face extension. */
1243 int background_width
;
1245 /* The height of this string. This is the height of the line this
1246 string is drawn in, and can be different from the height of the
1247 font the string is drawn in. */
1250 /* Number of pixels this string overwrites in front of its x-origin.
1251 This number is zero if the string has an lbearing >= 0; it is
1252 -lbearing, if the string has an lbearing < 0. */
1255 /* Number of pixels this string overwrites past its right-most
1256 nominal x-position, i.e. x + width. Zero if the string's
1257 rbearing is <= its nominal width, rbearing - width otherwise. */
1260 /* The frame on which the glyph string is drawn. */
1263 /* The window on which the glyph string is drawn. */
1266 /* X display and window for convenience. */
1270 /* The glyph row for which this string was built. It determines the
1271 y-origin and height of the string. */
1272 struct glyph_row
*row
;
1274 /* The area within row. */
1275 enum glyph_row_area area
;
1277 /* Characters to be drawn, and number of characters. */
1281 /* A face-override for drawing cursors, mouse face and similar. */
1282 enum draw_glyphs_face hl
;
1284 /* Face in which this string is to be drawn. */
1287 /* Font in which this string is to be drawn. */
1290 /* Non-null means this string describes (part of) a static
1292 struct composition
*cmp
;
1294 /* If not negative, this string describes a compos. */
1297 /* Start and end glyph indices in a glyph-string. */
1298 int cmp_from
, cmp_to
;
1300 /* 1 means this glyph strings face has to be drawn to the right end
1301 of the window's drawing area. */
1302 unsigned extends_to_end_of_line_p
: 1;
1304 /* 1 means the background of this string has been drawn. */
1305 unsigned background_filled_p
: 1;
1307 /* 1 means glyph string must be drawn with 16-bit functions. */
1308 unsigned two_byte_p
: 1;
1310 /* 1 means that the original font determined for drawing this glyph
1311 string could not be loaded. The member `font' has been set to
1312 the frame's default font in this case. */
1313 unsigned font_not_found_p
: 1;
1315 /* 1 means that the face in which this glyph string is drawn has a
1317 unsigned stippled_p
: 1;
1319 #define OVERLAPS_PRED (1 << 0)
1320 #define OVERLAPS_SUCC (1 << 1)
1321 #define OVERLAPS_BOTH (OVERLAPS_PRED | OVERLAPS_SUCC)
1322 #define OVERLAPS_ERASED_CURSOR (1 << 2)
1323 /* Non-zero means only the foreground of this glyph string must be
1324 drawn, and we should use the physical height of the line this
1325 glyph string appears in as clip rect. If the value is
1326 OVERLAPS_ERASED_CURSOR, the clip rect is restricted to the rect
1327 of the erased cursor. OVERLAPS_PRED and OVERLAPS_SUCC mean we
1328 draw overlaps with the preceding and the succeeding rows,
1330 unsigned for_overlaps
: 3;
1332 /* 1 means that all glyphs in this glyph string has the flag
1333 padding_p set, and thus must be drawn one by one to have 1-pixel
1334 width even though the logical width in the font is zero. */
1335 unsigned padding_p
: 1;
1337 /* The GC to use for drawing this glyph string. */
1338 #if defined (HAVE_X_WINDOWS)
1341 #if defined (HAVE_NTGUI)
1346 /* A pointer to the first glyph in the string. This glyph
1347 corresponds to char2b[0]. Needed to draw rectangles if
1348 font_not_found_p is 1. */
1349 struct glyph
*first_glyph
;
1351 /* Image, if any. */
1355 struct glyph_slice slice
;
1357 /* Non-null means the horizontal clipping region starts from the
1358 left edge of *clip_head, and ends with the right edge of
1359 *clip_tail, not including their overhangs. */
1360 struct glyph_string
*clip_head
, *clip_tail
;
1362 /* The current clipping areas. */
1363 NativeRectangle clip
[2];
1365 /* Number of clipping areas. */
1368 int underline_position
;
1370 int underline_thickness
;
1372 struct glyph_string
*next
, *prev
;
1375 #endif /* HAVE_WINDOW_SYSTEM */
1378 /************************************************************************
1380 ************************************************************************/
1382 /* Return the height of the mode line in glyph matrix MATRIX, or zero
1383 if not known. This macro is called under circumstances where
1384 MATRIX might not have been allocated yet. */
1386 #define MATRIX_MODE_LINE_HEIGHT(MATRIX) \
1387 ((MATRIX) && (MATRIX)->rows \
1388 ? MATRIX_MODE_LINE_ROW (MATRIX)->height \
1391 /* Return the height of the header line in glyph matrix MATRIX, or zero
1392 if not known. This macro is called under circumstances where
1393 MATRIX might not have been allocated yet. */
1395 #define MATRIX_HEADER_LINE_HEIGHT(MATRIX) \
1396 ((MATRIX) && (MATRIX)->rows \
1397 ? MATRIX_HEADER_LINE_ROW (MATRIX)->height \
1400 /* Return the desired face id for the mode line of a window, depending
1401 on whether the window is selected or not, or if the window is the
1402 scrolling window for the currently active minibuffer window.
1404 Due to the way display_mode_lines manipulates with the contents of
1405 selected_window, this macro needs three arguments: SELW which is
1406 compared against the current value of selected_window, MBW which is
1407 compared against minibuf_window (if SELW doesn't match), and SCRW
1408 which is compared against minibuf_selected_window (if MBW matches). */
1410 #define CURRENT_MODE_LINE_FACE_ID_3(SELW, MBW, SCRW) \
1411 ((!mode_line_in_non_selected_windows \
1412 || (SELW) == XWINDOW (selected_window) \
1413 || (minibuf_level > 0 \
1414 && !NILP (minibuf_selected_window) \
1415 && (MBW) == XWINDOW (minibuf_window) \
1416 && (SCRW) == XWINDOW (minibuf_selected_window))) \
1417 ? MODE_LINE_FACE_ID \
1418 : MODE_LINE_INACTIVE_FACE_ID)
1421 /* Return the desired face id for the mode line of window W. */
1423 #define CURRENT_MODE_LINE_FACE_ID(W) \
1424 (CURRENT_MODE_LINE_FACE_ID_3((W), XWINDOW (selected_window), (W)))
1426 /* Return the current height of the mode line of window W. If not known
1427 from W->mode_line_height, look at W's current glyph matrix, or return
1428 a default based on the height of the font of the face `mode-line'. */
1430 #define CURRENT_MODE_LINE_HEIGHT(W) \
1431 (W->mode_line_height >= 0 \
1432 ? W->mode_line_height \
1433 : (W->mode_line_height \
1434 = (MATRIX_MODE_LINE_HEIGHT (W->current_matrix) \
1435 ? MATRIX_MODE_LINE_HEIGHT (W->current_matrix) \
1436 : estimate_mode_line_height \
1437 (XFRAME (W->frame), CURRENT_MODE_LINE_FACE_ID (W)))))
1439 /* Return the current height of the header line of window W. If not known
1440 from W->header_line_height, look at W's current glyph matrix, or return
1441 an estimation based on the height of the font of the face `header-line'. */
1443 #define CURRENT_HEADER_LINE_HEIGHT(W) \
1444 (W->header_line_height >= 0 \
1445 ? W->header_line_height \
1446 : (W->header_line_height \
1447 = (MATRIX_HEADER_LINE_HEIGHT (W->current_matrix) \
1448 ? MATRIX_HEADER_LINE_HEIGHT (W->current_matrix) \
1449 : estimate_mode_line_height \
1450 (XFRAME (W->frame), HEADER_LINE_FACE_ID))))
1452 /* Return the height of the desired mode line of window W. */
1454 #define DESIRED_MODE_LINE_HEIGHT(W) \
1455 MATRIX_MODE_LINE_HEIGHT ((W)->desired_matrix)
1457 /* Return the height of the desired header line of window W. */
1459 #define DESIRED_HEADER_LINE_HEIGHT(W) \
1460 MATRIX_HEADER_LINE_HEIGHT ((W)->desired_matrix)
1462 /* Value is non-zero if window W wants a mode line. */
1464 #define WINDOW_WANTS_MODELINE_P(W) \
1465 (!MINI_WINDOW_P ((W)) \
1466 && !(W)->pseudo_window_p \
1467 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1468 && BUFFERP ((W)->contents) \
1469 && !NILP (BVAR (XBUFFER ((W)->contents), mode_line_format)) \
1470 && WINDOW_TOTAL_LINES (W) > 1)
1472 /* Value is true if window W wants a header line. */
1474 #define WINDOW_WANTS_HEADER_LINE_P(W) \
1475 (BUFFERP ((W)->contents) \
1476 ? (!MINI_WINDOW_P ((W)) \
1477 && !(W)->pseudo_window_p \
1478 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1479 && !NILP (BVAR (XBUFFER ((W)->contents), header_line_format)) \
1480 && WINDOW_TOTAL_LINES (W) > \
1481 (1 + !NILP (BVAR (XBUFFER ((W)->contents), mode_line_format)))) \
1484 /* Return proper value to be used as baseline offset of font that has
1485 ASCENT and DESCENT to draw characters by the font at the vertical
1486 center of the line of frame F.
1488 Here, our task is to find the value of BOFF in the following figure;
1490 -------------------------+-----------+-
1491 -+-+---------+-+ | |
1493 | | | | F_ASCENT F_HEIGHT
1496 | | |-|-+------+-----------|------- baseline
1498 | |---------|-+-+ | |
1500 -+-+---------+-+ F_DESCENT |
1501 -------------------------+-----------+-
1503 -BOFF + DESCENT + (F_HEIGHT - HEIGHT) / 2 = F_DESCENT
1504 BOFF = DESCENT + (F_HEIGHT - HEIGHT) / 2 - F_DESCENT
1505 DESCENT = FONT->descent
1506 HEIGHT = FONT_HEIGHT (FONT)
1507 F_DESCENT = (FRAME_FONT (F)->descent
1508 - F->terminal->output_data.x->baseline_offset)
1509 F_HEIGHT = FRAME_LINE_HEIGHT (F)
1512 #define VCENTER_BASELINE_OFFSET(FONT, F) \
1513 (FONT_DESCENT (FONT) \
1514 + (FRAME_LINE_HEIGHT ((F)) - FONT_HEIGHT ((FONT)) \
1515 + (FRAME_LINE_HEIGHT ((F)) > FONT_HEIGHT ((FONT)))) / 2 \
1516 - (FONT_DESCENT (FRAME_FONT (F)) - FRAME_BASELINE_OFFSET (F)))
1519 /***********************************************************************
1521 ***********************************************************************/
1523 /* Indices of face attributes in Lisp face vectors. Slot zero is the
1526 enum lface_attribute_index
1528 LFACE_FAMILY_INDEX
= 1,
1529 LFACE_FOUNDRY_INDEX
,
1534 LFACE_UNDERLINE_INDEX
,
1535 LFACE_INVERSE_INDEX
,
1536 LFACE_FOREGROUND_INDEX
,
1537 LFACE_BACKGROUND_INDEX
,
1538 LFACE_STIPPLE_INDEX
,
1539 LFACE_OVERLINE_INDEX
,
1540 LFACE_STRIKE_THROUGH_INDEX
,
1543 LFACE_INHERIT_INDEX
,
1544 LFACE_FONTSET_INDEX
,
1549 /* Box types of faces. */
1553 /* No box around text. */
1556 /* Simple box of specified width and color. Default width is 1, and
1557 default color is the foreground color of the face. */
1560 /* Boxes with 3D shadows. Color equals the background color of the
1561 face. Width is specified. */
1566 /* Underline type. */
1568 enum face_underline_type
1574 /* Structure describing a realized face.
1576 For each Lisp face, 0..N realized faces can exist for different
1577 frames and different charsets. Realized faces are built from Lisp
1578 faces and text properties/overlays by merging faces and adding
1579 unspecified attributes from the `default' face. */
1583 /* The id of this face. The id equals the index of this face in the
1584 vector faces_by_id of its face cache. */
1587 #ifdef HAVE_WINDOW_SYSTEM
1589 /* If non-zero, this is a GC that we can use without modification for
1590 drawing the characters in this face. */
1593 /* Background stipple or bitmap used for this face. This is
1594 an id as returned from load_pixmap. */
1597 #else /* not HAVE_WINDOW_SYSTEM */
1602 #endif /* not HAVE_WINDOW_SYSTEM */
1604 /* Pixel value of foreground color for X frames. Color index
1606 unsigned long foreground
;
1608 /* Pixel value or color index of background color. */
1609 unsigned long background
;
1611 /* Pixel value or color index of underline color. */
1612 unsigned long underline_color
;
1614 /* Pixel value or color index of overlined, strike-through, or box
1616 unsigned long overline_color
;
1617 unsigned long strike_through_color
;
1618 unsigned long box_color
;
1622 /* Fontset ID if for this face's fontset. Non-ASCII faces derived
1623 from the same ASCII face have the same fontset. */
1626 /* Pixmap width and height. */
1627 unsigned int pixmap_w
, pixmap_h
;
1629 /* Non-zero means characters in this face have a box of that
1630 thickness around them. If this value is negative, its absolute
1631 value indicates the thickness, and the horizontal (top and
1632 bottom) borders of box are drawn inside of the character glyphs'
1633 area. The vertical (left and right) borders of the box are drawn
1634 in the same way as when this value is positive. */
1637 /* Type of box drawn. A value of FACE_NO_BOX means no box is drawn
1638 around text in this face. A value of FACE_SIMPLE_BOX means a box
1639 of width box_line_width is drawn in color box_color. A value of
1640 FACE_RAISED_BOX or FACE_SUNKEN_BOX means a 3D box is drawn with
1641 shadow colors derived from the background color of the face. */
1642 enum face_box_type box
;
1644 /* Style of underlining. */
1645 enum face_underline_type underline_type
;
1647 /* If `box' above specifies a 3D type, 1 means use box_color for
1649 unsigned use_box_color_for_shadows_p
: 1;
1651 /* Non-zero if text in this face should be underlined, overlined,
1652 strike-through or have a box drawn around it. */
1653 unsigned underline_p
: 1;
1654 unsigned overline_p
: 1;
1655 unsigned strike_through_p
: 1;
1657 /* 1 means that the colors specified for this face could not be
1658 loaded, and were replaced by default colors, so they shouldn't be
1660 unsigned foreground_defaulted_p
: 1;
1661 unsigned background_defaulted_p
: 1;
1663 /* 1 means that either no color is specified for underlining or that
1664 the specified color couldn't be loaded. Use the foreground
1665 color when drawing in that case. */
1666 unsigned underline_defaulted_p
: 1;
1668 /* 1 means that either no color is specified for the corresponding
1669 attribute or that the specified color couldn't be loaded.
1670 Use the foreground color when drawing in that case. */
1671 unsigned overline_color_defaulted_p
: 1;
1672 unsigned strike_through_color_defaulted_p
: 1;
1673 unsigned box_color_defaulted_p
: 1;
1675 /* TTY appearances. Colors are found in `lface' with empty color
1676 string meaning the default color of the TTY. */
1677 unsigned tty_bold_p
: 1;
1678 unsigned tty_italic_p
: 1;
1679 unsigned tty_underline_p
: 1;
1680 unsigned tty_reverse_p
: 1;
1682 /* 1 means that colors of this face may not be freed because they
1683 have been copied bitwise from a base face (see
1685 unsigned colors_copied_bitwise_p
: 1;
1687 /* If non-zero, use overstrike (to simulate bold-face). */
1688 unsigned overstrike
: 1;
1690 /* NOTE: this is not used yet, but eventually this impl should be done
1691 similarly to overstrike */
1693 /* If non-zero, use geometric rotation (to simulate italic). */
1694 unsigned synth_ital
: 1;
1697 /* The Lisp face attributes this face realizes. All attributes
1698 in this vector are non-nil. */
1699 Lisp_Object lface
[LFACE_VECTOR_SIZE
];
1701 /* The hash value of this face. */
1704 /* Next and previous face in hash collision list of face cache. */
1705 struct face
*next
, *prev
;
1707 /* If this face is an ASCII face, this points to this face itself.
1708 Otherwise, this points to an ASCII face that has the same
1709 attributes except the font. */
1710 struct face
*ascii_face
;
1712 /* Extra member that a font-driver uses privately. */
1717 /* Color index indicating that face uses a terminal's default color. */
1719 #define FACE_TTY_DEFAULT_COLOR ((unsigned long) -1)
1721 /* Color index indicating that face uses an unknown foreground color. */
1723 #define FACE_TTY_DEFAULT_FG_COLOR ((unsigned long) -2)
1725 /* Color index indicating that face uses an unknown background color. */
1727 #define FACE_TTY_DEFAULT_BG_COLOR ((unsigned long) -3)
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 BASIC_FACE_ID_SENTINEL
1754 #define MAX_FACE_ID ((1 << FACE_ID_BITS) - 1)
1756 /* A cache of realized faces. Each frame has its own cache because
1757 Emacs allows different frame-local face definitions. */
1761 /* Hash table of cached realized faces. */
1762 struct face
**buckets
;
1764 /* Back-pointer to the frame this cache belongs to. */
1767 /* A vector of faces so that faces can be referenced by an ID. */
1768 struct face
**faces_by_id
;
1770 /* The allocated size, and number of used slots of faces_by_id. */
1774 /* Flag indicating that attributes of the `menu' face have been
1776 unsigned menu_face_changed_p
: 1;
1780 /* Prepare face FACE for use on frame F. This must be called before
1781 using X resources of FACE. */
1783 #define PREPARE_FACE_FOR_DISPLAY(F, FACE) \
1784 if ((FACE)->gc == 0) \
1785 prepare_face_for_display ((F), (FACE)); \
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(F, ID) \
1793 (UNSIGNED_CMP (ID, <, FRAME_FACE_CACHE (F)->used) \
1794 ? FRAME_FACE_CACHE (F)->faces_by_id[ID] \
1797 #ifdef HAVE_WINDOW_SYSTEM
1799 /* Non-zero if FACE is suitable for displaying character CHAR. */
1801 #define FACE_SUITABLE_FOR_ASCII_CHAR_P(FACE, CHAR) \
1802 ((FACE) == (FACE)->ascii_face)
1804 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) \
1805 (ASCII_CHAR_P (CHAR) \
1806 ? FACE_SUITABLE_FOR_ASCII_CHAR_P(FACE) \
1807 : face_suitable_for_char_p ((FACE), (CHAR)))
1809 /* Return the id of the realized face on frame F that is like the face
1810 with id ID but is suitable for displaying character CHAR.
1811 This macro is only meaningful for multibyte character CHAR. */
1813 #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) \
1814 ((ASCII_CHAR_P (CHAR) || CHAR_BYTE8_P (CHAR)) \
1815 ? (FACE)->ascii_face->id \
1816 : face_for_char ((F), (FACE), (CHAR), (POS), (OBJECT)))
1818 #else /* not HAVE_WINDOW_SYSTEM */
1820 #define FACE_SUITABLE_FOR_ASCII_CHAR_P(FACE, CHAR) 1
1821 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) 1
1822 #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) ((FACE)->id)
1824 #endif /* not HAVE_WINDOW_SYSTEM */
1826 /* Return true if G contains a valid character code. */
1827 DISPEXTERN_INLINE
bool
1828 GLYPH_CHAR_VALID_P (GLYPH g
)
1830 return CHAR_VALID_P (GLYPH_CHAR (g
));
1833 /* The glyph code from a display vector may either be an integer which
1834 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1835 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1837 DISPEXTERN_INLINE
bool
1838 GLYPH_CODE_P (Lisp_Object gc
)
1841 ? (CHARACTERP (XCAR (gc
))
1842 && RANGED_INTEGERP (0, XCDR (gc
), MAX_FACE_ID
))
1845 (MAX_FACE_ID
< TYPE_MAXIMUM (EMACS_INT
) >> CHARACTERBITS
1846 ? ((EMACS_INT
) MAX_FACE_ID
<< CHARACTERBITS
) | MAX_CHAR
1847 : TYPE_MAXIMUM (EMACS_INT
)))));
1850 /* Non-zero means face attributes have been changed since the last
1851 redisplay. Used in redisplay_internal. */
1853 extern int face_change_count
;
1855 /* For reordering of bidirectional text. */
1856 #define BIDI_MAXLEVEL 64
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 WEAK_ES
, /* european number separator */
1881 WEAK_ET
, /* european number terminator */
1882 WEAK_CS
, /* common separator */
1883 WEAK_NSM
, /* non-spacing mark */
1884 NEUTRAL_S
, /* segment separator */
1885 NEUTRAL_WS
, /* whitespace */
1886 NEUTRAL_ON
/* other neutrals */
1889 /* The basic directionality data type. */
1890 typedef enum { NEUTRAL_DIR
, L2R
, R2L
} bidi_dir_t
;
1892 /* Data type for storing information about characters we need to
1894 struct bidi_saved_info
{
1895 ptrdiff_t bytepos
, charpos
; /* character's buffer position */
1896 bidi_type_t type
; /* character's resolved bidi type */
1897 bidi_type_t type_after_w1
; /* original type of the character, after W1 */
1898 bidi_type_t orig_type
; /* type as we found it in the buffer */
1901 /* Data type for keeping track of saved embedding levels and override
1902 status information. */
1905 bidi_dir_t override
;
1908 /* Data type for storing information about a string being iterated on. */
1909 struct bidi_string_data
{
1910 Lisp_Object lstring
; /* Lisp string to reorder, or nil */
1911 const unsigned char *s
; /* string data, or NULL if reordering buffer */
1912 ptrdiff_t schars
; /* the number of characters in the string,
1913 excluding the terminating null */
1914 ptrdiff_t bufpos
; /* buffer position of lstring, or 0 if N/A */
1915 unsigned from_disp_str
: 1; /* 1 means the string comes from a
1917 unsigned unibyte
: 1; /* 1 means the string is unibyte */
1920 /* Data type for reordering bidirectional text. */
1922 ptrdiff_t bytepos
; /* iterator's position in buffer/string */
1924 int ch
; /* character at that position, or u+FFFC
1925 ("object replacement character") for a run
1926 of characters covered by a display string */
1927 ptrdiff_t nchars
; /* its "length", usually 1; it's > 1 for a run
1928 of characters covered by a display string */
1929 ptrdiff_t ch_len
; /* its length in bytes */
1930 bidi_type_t type
; /* bidi type of this character, after
1931 resolving weak and neutral types */
1932 bidi_type_t type_after_w1
; /* original type, after overrides and W1 */
1933 bidi_type_t orig_type
; /* original type, as found in the buffer */
1934 int resolved_level
; /* final resolved level of this character */
1935 int invalid_levels
; /* how many PDFs to ignore */
1936 int invalid_rl_levels
; /* how many PDFs from RLE/RLO to ignore */
1937 struct bidi_saved_info prev
; /* info about previous character */
1938 struct bidi_saved_info last_strong
; /* last-seen strong directional char */
1939 struct bidi_saved_info next_for_neutral
; /* surrounding characters for... */
1940 struct bidi_saved_info prev_for_neutral
; /* ...resolving neutrals */
1941 struct bidi_saved_info next_for_ws
; /* character after sequence of ws */
1942 ptrdiff_t next_en_pos
; /* pos. of next char for determining ET type */
1943 bidi_type_t next_en_type
; /* type of char at next_en_pos */
1944 ptrdiff_t ignore_bn_limit
; /* position until which to ignore BNs */
1945 bidi_dir_t sor
; /* direction of start-of-run in effect */
1946 int scan_dir
; /* direction of text scan, 1: forw, -1: back */
1947 ptrdiff_t disp_pos
; /* position of display string after ch */
1948 int disp_prop
; /* if non-zero, there really is a
1949 `display' property/string at disp_pos;
1950 if 2, the property is a `space' spec */
1951 int stack_idx
; /* index of current data on the stack */
1952 /* Note: Everything from here on is not copied/saved when the bidi
1953 iterator state is saved, pushed, or popped. So only put here
1954 stuff that is not part of the bidi iterator's state! */
1955 struct bidi_stack level_stack
[BIDI_MAXLEVEL
]; /* stack of embedding levels */
1956 struct bidi_string_data string
; /* string to reorder */
1957 struct window
*w
; /* the window being displayed */
1958 bidi_dir_t paragraph_dir
; /* current paragraph direction */
1959 ptrdiff_t separator_limit
; /* where paragraph separator should end */
1960 unsigned prev_was_pdf
: 1; /* if non-zero, previous char was PDF */
1961 unsigned first_elt
: 1; /* if non-zero, examine current char first */
1962 unsigned new_paragraph
: 1; /* if non-zero, we expect a new paragraph */
1963 unsigned frame_window_p
: 1; /* non-zero if displaying on a GUI frame */
1966 /* Value is non-zero when the bidi iterator is at base paragraph
1968 #define BIDI_AT_BASE_LEVEL(BIDI_IT) \
1969 ((BIDI_IT).resolved_level == (BIDI_IT).level_stack[0].level)
1972 /***********************************************************************
1974 ***********************************************************************/
1976 /* Structure used to describe where and how to draw a fringe bitmap.
1977 WHICH is the fringe bitmap to draw. WD and H is the (adjusted)
1978 width and height of the bitmap, DH is the height adjustment (if
1979 bitmap is periodic). X and Y are frame coordinates of the area to
1980 display the bitmap, DY is relative offset of the bitmap into that
1981 area. BX, NX, BY, NY specifies the area to clear if the bitmap
1982 does not fill the entire area. FACE is the fringe face. */
1984 struct draw_fringe_bitmap_params
1986 int which
; /* enum fringe_bitmap_type */
1987 unsigned short *bits
;
1991 unsigned cursor_p
: 1;
1992 unsigned overlay_p
: 1;
1996 #define MAX_FRINGE_BITMAPS (1<<FRINGE_ID_BITS)
1999 /***********************************************************************
2001 ***********************************************************************/
2003 /* Iteration over things to display in current_buffer or in a string.
2005 The iterator handles:
2007 1. Overlay strings (after-string, before-string).
2009 3. Invisible text properties.
2010 4. Selective display.
2011 5. Translation of characters via display tables.
2012 6. Translation of control characters to the forms `\003' or `^C'.
2013 7. `glyph' and `space-width' properties.
2015 Iterators are initialized by calling init_iterator or one of the
2016 equivalent functions below. A call to get_next_display_element
2017 loads the iterator structure with information about what next to
2018 display. A call to set_iterator_to_next increments the iterator's
2021 Characters from overlay strings, display table entries or control
2022 character translations are returned one at a time. For example, if
2023 we have a text of `a\x01' where `a' has a display table definition
2024 of `cd' and the control character is displayed with a leading
2025 arrow, then the iterator will return:
2027 Call Return Source Call next
2028 -----------------------------------------------------------------
2029 next c display table move
2030 next d display table move
2031 next ^ control char move
2032 next A control char move
2034 The same mechanism is also used to return characters for ellipses
2035 displayed at the end of invisible text.
2037 CAVEAT: Under some circumstances, move_.* functions can be called
2038 asynchronously, e.g. when computing a buffer position from an x and
2039 y pixel position. This means that these functions and functions
2040 called from them SHOULD NOT USE xmalloc and alike. See also the
2041 comment at the start of xdisp.c. */
2043 /* Enumeration describing what kind of display element an iterator is
2044 loaded with after a call to get_next_display_element. */
2046 enum display_element_type
2048 /* A normal character. */
2051 /* A composition (static and automatic). */
2054 /* A glyphless character (e.g. ZWNJ, LRE). */
2060 /* A flexible width and height space. */
2063 /* End of buffer or string. */
2066 /* Truncation glyphs. Never returned by get_next_display_element.
2067 Used to get display information about truncation glyphs via
2071 /* Continuation glyphs. See the comment for IT_TRUNCATION. */
2076 /* An enumerator for each text property that has a meaning for display
2085 COMPOSITION_PROP_IDX
,
2087 /* Not a property. Used to indicate changes in overlays. */
2094 /* An enumerator for the method of wrapping long lines. */
2096 enum line_wrap_method
2103 /* An enumerator for the method of displaying glyphless characters. */
2105 enum glyphless_display_method
2107 /* Display a thin (1-pixel width) space. On a TTY, display a
2108 1-character width space. */
2109 GLYPHLESS_DISPLAY_THIN_SPACE
,
2110 /* Display an empty box of proper width. */
2111 GLYPHLESS_DISPLAY_EMPTY_BOX
,
2112 /* Display an acronym string in a box. */
2113 GLYPHLESS_DISPLAY_ACRONYM
,
2114 /* Display the hexadecimal code of the character in a box. */
2115 GLYPHLESS_DISPLAY_HEX_CODE
2126 /* Input sources for fetching characters or data to display.
2127 The input source is found in the `method' field. */
2130 GET_FROM_BUFFER
= 0,
2131 GET_FROM_DISPLAY_VECTOR
,
2139 /* FIXME: What is this? Why 5? */
2140 #define IT_STACK_SIZE 5
2142 /* Iterator for composition (both for static and automatic). */
2143 struct composition_it
2145 /* Next position at which to check the composition. */
2147 /* ID number of the composition or glyph-string. If negative, we
2148 are not iterating over a composition now. */
2150 /* If non-negative, character that triggers the automatic
2151 composition at `stop_pos', and this is an automatic composition.
2152 If negative, this is a static composition. This is set to -2
2153 temporarily if searching of composition reach a limit or a
2156 /* If this is an automatic composition, index of a rule for making
2157 the automatic composition. Provided that ELT is an element of
2158 Vcomposition_function_table for CH, (nth ELT RULE_IDX) is the
2159 rule for the composition. */
2161 /* If this is an automatic composition, how many characters to look
2162 back from the position where a character triggering the
2163 composition exists. */
2165 /* If non-negative, number of glyphs of the glyph-string. */
2167 /* True iff the composition is created while buffer is scanned in
2168 reverse order, and thus the grapheme clusters must be rendered
2169 from the last to the first. */
2172 /** The following members contain information about the current
2173 grapheme cluster. */
2174 /* Position of the first character of the current grapheme cluster. */
2176 /* Number of characters and bytes of the current grapheme cluster. */
2178 /* Indices of the glyphs for the current grapheme cluster. */
2180 /* Width of the current grapheme cluster in units of pixels on a
2181 graphic display and in units of canonical characters on a
2182 terminal display. */
2188 /* The window in which we iterate over current_buffer (or a string). */
2192 /* The window's frame. */
2195 /* Method to use to load this structure with the next display element. */
2196 enum it_method method
;
2198 /* The next position at which to check for face changes, invisible
2199 text, overlay strings, end of text etc., which see. */
2200 ptrdiff_t stop_charpos
;
2202 /* Previous stop position, i.e. the last one before the current
2203 iterator position in `current'. */
2204 ptrdiff_t prev_stop
;
2206 /* Last stop position iterated across whose bidi embedding level is
2207 equal to the current paragraph's base embedding level. */
2208 ptrdiff_t base_level_stop
;
2210 /* Maximum string or buffer position + 1. ZV when iterating over
2212 ptrdiff_t end_charpos
;
2214 /* C string to iterate over. Non-null means get characters from
2215 this string, otherwise characters are read from current_buffer
2217 const unsigned char *s
;
2219 /* Number of characters in the string (s, or it->string) we iterate
2220 over. Used only in display_string and its subroutines; never
2221 used for overlay strings and strings from display properties. */
2222 ptrdiff_t string_nchars
;
2224 /* Start and end of a visible region; -1 if the region is not
2225 visible in the window. */
2226 ptrdiff_t region_beg_charpos
, region_end_charpos
;
2228 /* Position at which redisplay end trigger functions should be run. */
2229 ptrdiff_t redisplay_end_trigger_charpos
;
2231 /* 1 means multibyte characters are enabled. */
2232 unsigned multibyte_p
: 1;
2234 /* 1 means window has a mode line at its top. */
2235 unsigned header_line_p
: 1;
2237 /* 1 means `string' is the value of a `display' property.
2238 Don't handle some `display' properties in these strings. */
2239 unsigned string_from_display_prop_p
: 1;
2241 /* 1 means `string' comes from a `line-prefix' or `wrap-prefix'
2243 unsigned string_from_prefix_prop_p
: 1;
2245 /* 1 means we are iterating an object that came from a value of a
2246 `display' property. */
2247 unsigned from_disp_prop_p
: 1;
2249 /* When METHOD == next_element_from_display_vector,
2250 this is 1 if we're doing an ellipsis. Otherwise meaningless. */
2251 unsigned ellipsis_p
: 1;
2253 /* True means cursor shouldn't be displayed here. */
2254 unsigned avoid_cursor_p
: 1;
2256 /* Display table in effect or null for none. */
2257 struct Lisp_Char_Table
*dp
;
2259 /* Current display table vector to return characters from and its
2260 end. dpvec null means we are not returning characters from a
2261 display table entry; current.dpvec_index gives the current index
2262 into dpvec. This same mechanism is also used to return
2263 characters from translated control characters, i.e. `\003' or
2265 Lisp_Object
*dpvec
, *dpend
;
2267 /* Length in bytes of the char that filled dpvec. A value of zero
2268 means that no such character is involved. A negative value means
2269 the rest of the line from the current iterator position onwards
2270 is hidden by selective display or ellipsis. */
2273 /* Face id to use for all characters in display vector. -1 if unused. */
2276 /* Face id of the iterator saved in case a glyph from dpvec contains
2277 a face. The face is restored when all glyphs from dpvec have
2281 /* Vector of glyphs for control character translation. The pointer
2282 dpvec is set to ctl_chars when a control character is translated.
2283 This vector is also used for incomplete multibyte character
2284 translation (e.g \222\244). Such a character is at most 4 bytes,
2285 thus we need at most 16 bytes here. */
2286 Lisp_Object ctl_chars
[16];
2288 /* Initial buffer or string position of the iterator, before skipping
2289 over display properties and invisible text. */
2290 struct display_pos start
;
2292 /* Current buffer or string position of the iterator, including
2293 position in overlay strings etc. */
2294 struct display_pos current
;
2296 /* Total number of overlay strings to process. This can be >
2297 OVERLAY_STRING_CHUNK_SIZE. Value is dependable only when
2298 current.overlay_string_index >= 0. Use the latter to determine
2299 whether an overlay string is being iterated over, because
2300 n_overlay_strings can be positive even when we are not rendering
2301 an overlay string. */
2302 ptrdiff_t n_overlay_strings
;
2304 /* The charpos where n_overlay_strings was calculated. This should
2305 be set at the same time as n_overlay_strings. It is needed
2306 because we show before-strings at the start of invisible text;
2307 see handle_invisible_prop in xdisp.c. */
2308 ptrdiff_t overlay_strings_charpos
;
2310 /* Vector of overlays to process. Overlay strings are processed
2311 OVERLAY_STRING_CHUNK_SIZE at a time. */
2312 #define OVERLAY_STRING_CHUNK_SIZE 16
2313 Lisp_Object overlay_strings
[OVERLAY_STRING_CHUNK_SIZE
];
2315 /* For each overlay string, the overlay it came from. */
2316 Lisp_Object string_overlays
[OVERLAY_STRING_CHUNK_SIZE
];
2318 /* If non-nil, a Lisp string being processed. If
2319 current.overlay_string_index >= 0, this is an overlay string from
2320 pos. Use STRINGP (it.string) to test whether we are rendering a
2321 string or something else; do NOT use BUFFERP (it.object). */
2324 /* If non-nil, we are processing a string that came
2325 from a `display' property given by an overlay. */
2326 Lisp_Object from_overlay
;
2328 /* Stack of saved values. New entries are pushed when we begin to
2329 process an overlay string or a string from a `glyph' property.
2330 Entries are popped when we return to deliver display elements
2331 from what we previously had. */
2332 struct iterator_stack_entry
2336 ptrdiff_t end_charpos
;
2337 ptrdiff_t stop_charpos
;
2338 ptrdiff_t prev_stop
;
2339 ptrdiff_t base_level_stop
;
2340 struct composition_it cmp_it
;
2343 /* Save values specific to a given method. */
2345 /* method == GET_FROM_IMAGE */
2348 struct it_slice slice
;
2351 /* method == GET_FROM_COMPOSITION */
2355 /* method == GET_FROM_STRETCH */
2361 /* current text and display positions. */
2362 struct text_pos position
;
2363 struct display_pos current
;
2364 Lisp_Object from_overlay
;
2365 enum glyph_row_area area
;
2366 enum it_method method
;
2367 bidi_dir_t paragraph_embedding
;
2368 unsigned multibyte_p
: 1;
2369 unsigned string_from_display_prop_p
: 1;
2370 unsigned string_from_prefix_prop_p
: 1;
2371 unsigned display_ellipsis_p
: 1;
2372 unsigned avoid_cursor_p
: 1;
2374 unsigned from_disp_prop_p
: 1;
2375 enum line_wrap_method line_wrap
;
2377 /* properties from display property that are reset by another display property. */
2379 Lisp_Object space_width
;
2380 Lisp_Object font_height
;
2382 stack
[IT_STACK_SIZE
];
2384 /* Stack pointer. */
2387 /* -1 means selective display hides everything between a \r and the
2388 next newline; > 0 means hide lines indented more than that value. */
2389 ptrdiff_t selective
;
2391 /* An enumeration describing what the next display element is
2392 after a call to get_next_display_element. */
2393 enum display_element_type what
;
2398 /* Setting of buffer-local variable selective-display-ellipsis. */
2399 unsigned selective_display_ellipsis_p
: 1;
2401 /* 1 means control characters are translated into the form `^C'
2402 where the `^' can be replaced by a display table entry. */
2403 unsigned ctl_arrow_p
: 1;
2405 /* Non-zero means that the current face has a box. */
2406 unsigned face_box_p
: 1;
2408 /* Non-null means that the current character is the first in a run
2409 of characters with box face. */
2410 unsigned start_of_box_run_p
: 1;
2412 /* Non-zero means that the current character is the last in a run
2413 of characters with box face. */
2414 unsigned end_of_box_run_p
: 1;
2416 /* 1 means overlay strings at end_charpos have been processed. */
2417 unsigned overlay_strings_at_end_processed_p
: 1;
2419 /* 1 means to ignore overlay strings at current pos, as they have
2420 already been processed. */
2421 unsigned ignore_overlay_strings_at_pos_p
: 1;
2423 /* 1 means the actual glyph is not available in the current
2425 unsigned glyph_not_available_p
: 1;
2427 /* 1 means the next line in display_line continues a character
2428 consisting of more than one glyph, and some glyphs of this
2429 character have been put on the previous line. */
2430 unsigned starts_in_middle_of_char_p
: 1;
2432 /* If 1, saved_face_id contains the id of the face in front of text
2433 skipped due to selective display. */
2434 unsigned face_before_selective_p
: 1;
2436 /* If 1, adjust current glyph so it does not increase current row
2437 descent/ascent (line-height property). Reset after this glyph. */
2438 unsigned constrain_row_ascent_descent_p
: 1;
2440 enum line_wrap_method line_wrap
;
2442 /* The ID of the default face to use. One of DEFAULT_FACE_ID,
2443 MODE_LINE_FACE_ID, etc, depending on what we are displaying. */
2446 /* If `what' == IT_CHARACTER, the character and the length in bytes
2447 of its multibyte sequence. The character comes from a buffer or
2448 a string. It may be different from the character displayed in
2449 case that unibyte_display_via_language_environment is set.
2451 If `what' == IT_COMPOSITION, the first component of a composition
2452 and length in bytes of the composition.
2454 If `what' is anything else, these two are undefined (will
2455 probably hold values for the last IT_CHARACTER or IT_COMPOSITION
2456 traversed by the iterator.
2458 The values are updated by get_next_display_element, so they are
2459 out of sync with the value returned by IT_CHARPOS between the
2460 time set_iterator_to_next advances the position and the time
2461 get_next_display_element loads the new values into c and len. */
2464 /* If what == IT_COMPOSITION, iterator substructure for the
2466 struct composition_it cmp_it
;
2468 /* The character to display, possibly translated to multibyte if
2469 multibyte_p is zero or unibyte_display_via_language_environment
2470 is set. This is set after get_next_display_element has been
2471 called. If we are setting it->C directly before calling
2472 PRODUCE_GLYPHS, this should be set beforehand too. */
2473 int char_to_display
;
2475 /* If what == IT_GLYPHLESS, the method to display such a
2477 enum glyphless_display_method glyphless_method
;
2479 /* If what == IT_IMAGE, the id of the image to display. */
2482 /* Values from `slice' property. */
2483 struct it_slice slice
;
2485 /* Value of the `space-width' property, if any; nil if none. */
2486 Lisp_Object space_width
;
2488 /* Computed from the value of the `raise' property. */
2491 /* Number of columns per \t. */
2494 /* Value of the `height' property, if any; nil if none. */
2495 Lisp_Object font_height
;
2497 /* Object and position where the current display element came from.
2498 Object is normally the buffer which is being rendered, but it can
2499 also be a Lisp string in case the current display element comes
2500 from an overlay string or from a display string (before- or
2501 after-string). It may also be nil when a C string is being
2502 rendered, e.g., during mode-line or header-line update. It can
2503 also be a cons cell of the form `(space ...)', when we produce a
2504 stretch glyph from a `display' specification. Finally, it can be
2505 a zero-valued Lisp integer, but only temporarily, when we are
2506 producing special glyphs for display purposes, like truncation
2507 and continuation glyphs, or blanks that extend each line to the
2508 edge of the window on a TTY.
2510 Do NOT use !BUFFERP (it.object) as a test whether we are
2511 iterating over a string; use STRINGP (it.string) instead.
2513 Position is the current iterator position in object. */
2515 struct text_pos position
;
2517 /* Width in pixels of truncation and continuation glyphs. */
2518 short truncation_pixel_width
, continuation_pixel_width
;
2520 /* First and last visible x-position in the display area. If window
2521 is hscrolled by n columns, first_visible_x == n * FRAME_COLUMN_WIDTH
2522 (f), and last_visible_x == pixel width of W + first_visible_x. */
2523 int first_visible_x
, last_visible_x
;
2525 /* Last visible y-position + 1 in the display area without a mode
2526 line, if the window has one. */
2529 /* Default amount of additional space in pixels between lines (for
2530 window systems only.) */
2531 int extra_line_spacing
;
2533 /* Max extra line spacing added in this row. */
2534 int max_extra_line_spacing
;
2536 /* Override font height information for this glyph.
2537 Used if override_ascent >= 0. Cleared after this glyph. */
2538 int override_ascent
, override_descent
, override_boff
;
2540 /* If non-null, glyphs are produced in glyph_row with each call to
2542 struct glyph_row
*glyph_row
;
2544 /* The area of glyph_row to which glyphs are added. */
2545 enum glyph_row_area area
;
2547 /* Number of glyphs needed for the last character requested via
2548 produce_glyphs. This is 1 except for tabs. */
2551 /* Width of the display element in pixels. Result of
2555 /* Current, maximum logical, and maximum physical line height
2556 information. Result of produce_glyphs. */
2557 int ascent
, descent
, max_ascent
, max_descent
;
2558 int phys_ascent
, phys_descent
, max_phys_ascent
, max_phys_descent
;
2560 /* Current x pixel position within the display line. This value
2561 does not include the width of continuation lines in front of the
2562 line. The value of current_x is automatically incremented by
2563 pixel_width with each call to produce_glyphs. */
2566 /* Accumulated width of continuation lines. If > 0, this means we
2567 are currently in a continuation line. This is initially zero and
2568 incremented/reset by display_line, move_it_to etc. */
2569 int continuation_lines_width
;
2571 /* Buffer position that ends the buffer text line being iterated.
2572 This is normally the position after the newline at EOL. If this
2573 is the last line of the buffer and it doesn't have a newline,
2574 value is ZV/ZV_BYTE. Set and used only if IT->bidi_p, for
2575 setting the end position of glyph rows produced for continuation
2576 lines, see display_line. */
2577 struct text_pos eol_pos
;
2579 /* Current y-position. Automatically incremented by the height of
2580 glyph_row in move_it_to and display_line. */
2583 /* Vertical matrix position of first text line in window. */
2586 /* Current vertical matrix position, or line number. Automatically
2587 incremented by move_it_to and display_line. */
2590 /* Horizontal matrix position reached in move_it_in_display_line.
2591 Only set there, not in display_line. */
2594 /* Left fringe bitmap number (enum fringe_bitmap_type). */
2595 unsigned left_user_fringe_bitmap
: FRINGE_ID_BITS
;
2597 /* Right fringe bitmap number (enum fringe_bitmap_type). */
2598 unsigned right_user_fringe_bitmap
: FRINGE_ID_BITS
;
2600 /* Face of the left fringe glyph. */
2601 unsigned left_user_fringe_face_id
: FACE_ID_BITS
;
2603 /* Face of the right fringe glyph. */
2604 unsigned right_user_fringe_face_id
: FACE_ID_BITS
;
2606 /* Non-zero means we need to reorder bidirectional text for display
2607 in the visual order. */
2608 unsigned bidi_p
: 1;
2610 /* For iterating over bidirectional text. */
2611 struct bidi_it bidi_it
;
2612 bidi_dir_t paragraph_embedding
;
2616 /* Access to positions of iterator IT. */
2618 #define IT_CHARPOS(IT) CHARPOS ((IT).current.pos)
2619 #define IT_BYTEPOS(IT) BYTEPOS ((IT).current.pos)
2620 #define IT_STRING_CHARPOS(IT) CHARPOS ((IT).current.string_pos)
2621 #define IT_STRING_BYTEPOS(IT) BYTEPOS ((IT).current.string_pos)
2623 /* Test if IT has reached the end of its buffer or string. This will
2624 only work after get_next_display_element has been called. */
2626 #define ITERATOR_AT_END_P(IT) ((IT)->what == IT_EOB)
2628 /* Non-zero means IT is at the end of a line. This is the case if it
2629 is either on a newline or on a carriage return and selective
2630 display hides the rest of the line. */
2632 #define ITERATOR_AT_END_OF_LINE_P(IT) \
2633 ((IT)->what == IT_CHARACTER \
2634 && ((IT)->c == '\n' \
2635 || ((IT)->c == '\r' && (IT)->selective)))
2637 /* Call produce_glyphs or FRAME_RIF->produce_glyphs, if set. Shortcut
2638 to avoid the function call overhead. */
2640 #define PRODUCE_GLYPHS(IT) \
2642 if ((IT)->glyph_row != NULL && (IT)->bidi_p) \
2644 if ((IT)->bidi_it.paragraph_dir == R2L) \
2645 (IT)->glyph_row->reversed_p = 1; \
2647 (IT)->glyph_row->reversed_p = 0; \
2649 if (FRAME_RIF ((IT)->f) != NULL) \
2650 FRAME_RIF ((IT)->f)->produce_glyphs ((IT)); \
2652 produce_glyphs ((IT)); \
2653 if ((IT)->glyph_row != NULL) \
2654 inhibit_free_realized_faces = 1; \
2657 /* Bit-flags indicating what operation move_it_to should perform. */
2659 enum move_operation_enum
2661 /* Stop if specified x-position is reached. */
2664 /* Stop if specified y-position is reached. */
2667 /* Stop if specified vpos is reached. */
2668 MOVE_TO_VPOS
= 0x04,
2670 /* Stop if specified buffer or string position is reached. */
2674 /***********************************************************************
2676 ***********************************************************************/
2678 /* Structure to hold mouse highlight data. */
2681 /* These variables describe the range of text currently shown in its
2682 mouse-face, together with the window they apply to. As long as
2683 the mouse stays within this range, we need not redraw anything on
2684 its account. Rows and columns are glyph matrix positions in
2685 MOUSE_FACE_WINDOW. */
2686 int mouse_face_beg_row
, mouse_face_beg_col
, mouse_face_beg_x
;
2687 int mouse_face_end_row
, mouse_face_end_col
, mouse_face_end_x
;
2688 Lisp_Object mouse_face_window
;
2689 int mouse_face_face_id
;
2690 Lisp_Object mouse_face_overlay
;
2692 /* FRAME and X, Y position of mouse when last checked for
2693 highlighting. X and Y can be negative or out of range for the frame. */
2694 struct frame
*mouse_face_mouse_frame
;
2695 int mouse_face_mouse_x
, mouse_face_mouse_y
;
2697 /* Nonzero if part of the text currently shown in
2698 its mouse-face is beyond the window end. */
2699 unsigned mouse_face_past_end
: 1;
2701 /* Nonzero means defer mouse-motion highlighting. */
2702 unsigned mouse_face_defer
: 1;
2704 /* Nonzero means that the mouse highlight should not be shown. */
2705 unsigned mouse_face_hidden
: 1;
2708 DISPEXTERN_INLINE
void
2709 reset_mouse_highlight (Mouse_HLInfo
*hlinfo
)
2712 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
2713 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
2714 hlinfo
->mouse_face_mouse_x
= hlinfo
->mouse_face_mouse_y
= 0;
2715 hlinfo
->mouse_face_beg_x
= hlinfo
->mouse_face_end_x
= 0;
2716 hlinfo
->mouse_face_face_id
= DEFAULT_FACE_ID
;
2717 hlinfo
->mouse_face_mouse_frame
= NULL
;
2718 hlinfo
->mouse_face_window
= Qnil
;
2719 hlinfo
->mouse_face_overlay
= Qnil
;
2720 hlinfo
->mouse_face_past_end
= 0;
2721 hlinfo
->mouse_face_hidden
= 0;
2722 hlinfo
->mouse_face_defer
= 0;
2725 /***********************************************************************
2726 Window-based redisplay interface
2727 ***********************************************************************/
2729 /* Structure used to describe runs of lines that must be scrolled. */
2733 /* Source and destination y pixel position. */
2734 int desired_y
, current_y
;
2736 /* Source and destination vpos in matrix. */
2737 int desired_vpos
, current_vpos
;
2739 /* Height in pixels, number of glyph rows. */
2744 /* Handlers for setting frame parameters. */
2746 typedef void (*frame_parm_handler
) (struct frame
*, Lisp_Object
, Lisp_Object
);
2749 /* Structure holding system-dependent interface functions needed
2750 for window-based redisplay. */
2752 struct redisplay_interface
2754 /* Handlers for setting frame parameters. */
2755 frame_parm_handler
*frame_parm_handlers
;
2757 /* Produce glyphs/get display metrics for the display element IT is
2759 void (*produce_glyphs
) (struct it
*it
);
2761 /* Write or insert LEN glyphs from STRING at the nominal output
2763 void (*write_glyphs
) (struct window
*w
, struct glyph_row
*row
,
2764 struct glyph
*string
, enum glyph_row_area area
,
2766 void (*insert_glyphs
) (struct window
*w
, struct glyph_row
*row
,
2767 struct glyph
*start
, enum glyph_row_area area
,
2770 /* Clear from nominal output position to X. X < 0 means clear
2771 to right end of display. */
2772 void (*clear_end_of_line
) (struct window
*w
, struct glyph_row
*row
,
2773 enum glyph_row_area area
, int x
);
2775 /* Function to call to scroll the display as described by RUN on
2777 void (*scroll_run_hook
) (struct window
*w
, struct run
*run
);
2779 /* Function to call after a line in a display has been completely
2780 updated. Used to draw truncation marks and alike. DESIRED_ROW
2781 is the desired row which has been updated. */
2782 void (*after_update_window_line_hook
) (struct window
*w
,
2783 struct glyph_row
*desired_row
);
2785 /* Function to call before beginning to update window W in
2786 window-based redisplay. */
2787 void (*update_window_begin_hook
) (struct window
*w
);
2789 /* Function to call after window W has been updated in window-based
2790 redisplay. CURSOR_ON_P non-zero means switch cursor on.
2791 MOUSE_FACE_OVERWRITTEN_P non-zero means that some lines in W
2792 that contained glyphs in mouse-face were overwritten, so we
2793 have to update the mouse highlight. */
2794 void (*update_window_end_hook
) (struct window
*w
, bool cursor_on_p
,
2795 bool mouse_face_overwritten_p
);
2797 /* Flush the display of frame F. For X, this is XFlush. */
2798 void (*flush_display
) (struct frame
*f
);
2800 /* Clear the mouse highlight in window W, if there is any. */
2801 void (*clear_window_mouse_face
) (struct window
*w
);
2803 /* Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
2805 void (*get_glyph_overhangs
) (struct glyph
*glyph
, struct frame
*f
,
2806 int *left
, int *right
);
2808 /* Fix the display of AREA of ROW in window W for overlapping rows.
2809 This function is called from redraw_overlapping_rows after
2810 desired rows have been made current. */
2811 void (*fix_overlapping_area
) (struct window
*w
, struct glyph_row
*row
,
2812 enum glyph_row_area area
, int);
2814 #ifdef HAVE_WINDOW_SYSTEM
2816 /* Draw a fringe bitmap in window W of row ROW using parameters P. */
2817 void (*draw_fringe_bitmap
) (struct window
*w
, struct glyph_row
*row
,
2818 struct draw_fringe_bitmap_params
*p
);
2820 /* Define and destroy fringe bitmap no. WHICH. */
2821 void (*define_fringe_bitmap
) (int which
, unsigned short *bits
,
2823 void (*destroy_fringe_bitmap
) (int which
);
2825 /* Compute left and right overhang of glyph string S.
2826 A NULL pointer if platform does not support this. */
2827 void (*compute_glyph_string_overhangs
) (struct glyph_string
*s
);
2829 /* Draw a glyph string S. */
2830 void (*draw_glyph_string
) (struct glyph_string
*s
);
2832 /* Define cursor CURSOR on frame F. */
2833 void (*define_frame_cursor
) (struct frame
*f
, Cursor cursor
);
2835 /* Clear the area at (X,Y,WIDTH,HEIGHT) of frame F. */
2836 void (*clear_frame_area
) (struct frame
*f
, int x
, int y
,
2837 int width
, int height
);
2839 /* Draw specified cursor CURSOR_TYPE of width CURSOR_WIDTH
2840 at row GLYPH_ROW on window W if ON_P is 1. If ON_P is
2841 0, don't draw cursor. If ACTIVE_P is 1, system caret
2842 should track this cursor (when applicable). */
2843 void (*draw_window_cursor
) (struct window
*w
,
2844 struct glyph_row
*glyph_row
,
2846 enum text_cursor_kinds cursor_type
,
2847 int cursor_width
, bool on_p
, bool active_p
);
2849 /* Draw vertical border for window W from (X,Y_0) to (X,Y_1). */
2850 void (*draw_vertical_window_border
) (struct window
*w
,
2851 int x
, int y_0
, int y_1
);
2853 /* Shift display of frame F to make room for inserted glyphs.
2854 The area at pixel (X,Y) of width WIDTH and height HEIGHT is
2855 shifted right by SHIFT_BY pixels. */
2856 void (*shift_glyphs_for_insert
) (struct frame
*f
,
2857 int x
, int y
, int width
,
2858 int height
, int shift_by
);
2860 #endif /* HAVE_WINDOW_SYSTEM */
2864 /***********************************************************************
2866 ***********************************************************************/
2868 #ifdef HAVE_WINDOW_SYSTEM
2870 /* Each image format (JPEG, TIFF, ...) supported is described by
2871 a structure of the type below. */
2875 /* A symbol uniquely identifying the image type, .e.g `jpeg'. */
2878 /* Check that SPEC is a valid image specification for the given
2879 image type. Value is true if SPEC is valid. */
2880 bool (* valid_p
) (Lisp_Object spec
);
2882 /* Load IMG which is used on frame F from information contained in
2883 IMG->spec. Value is true if successful. */
2884 bool (* load
) (struct frame
*f
, struct image
*img
);
2886 /* Free resources of image IMG which is used on frame F. */
2887 void (* free
) (struct frame
*f
, struct image
*img
);
2889 /* Initialization function (used for dynamic loading of image
2890 libraries on Windows), or NULL if none. */
2891 bool (* init
) (void);
2893 /* Next in list of all supported image types. */
2894 struct image_type
*next
;
2898 /* Structure describing an image. Specific image formats like XBM are
2899 converted into this form, so that display only has to deal with
2900 this type of image. */
2904 /* The time in seconds at which the image was last displayed. Set
2905 in prepare_image_for_display. */
2906 struct timespec timestamp
;
2908 /* Pixmaps of the image. */
2909 Pixmap pixmap
, mask
;
2911 #ifdef HAVE_X_WINDOWS
2912 /* X images of the image, corresponding to the above Pixmaps.
2913 Non-NULL means it and its Pixmap counterpart may be out of sync
2914 and the latter is outdated. NULL means the X image has been
2915 synchronized to Pixmap. */
2916 XImagePtr ximg
, mask_img
;
2919 /* Colors allocated for this image, if any. Allocated via xmalloc. */
2920 unsigned long *colors
;
2923 /* A single `background color' for this image, for the use of anyone that
2924 cares about such a thing. Only valid if the `background_valid' field
2925 is true. This should generally be accessed by calling the accessor
2926 macro `IMAGE_BACKGROUND', which will heuristically calculate a value
2928 unsigned long background
;
2930 /* Foreground and background colors of the frame on which the image
2932 unsigned long frame_foreground
, frame_background
;
2934 /* True if this image has a `transparent' background -- that is, is
2935 uses an image mask. The accessor macro for this is
2936 `IMAGE_BACKGROUND_TRANSPARENT'. */
2937 unsigned background_transparent
: 1;
2939 /* True if the `background' and `background_transparent' fields are
2940 valid, respectively. */
2941 unsigned background_valid
: 1, background_transparent_valid
: 1;
2943 /* Width and height of the image. */
2946 /* These values are used for the rectangles displayed for images
2947 that can't be loaded. */
2948 #define DEFAULT_IMAGE_WIDTH 30
2949 #define DEFAULT_IMAGE_HEIGHT 30
2951 /* Top/left and bottom/right corner pixel of actual image data.
2952 Used by four_corners_best to consider the real image data,
2953 rather than looking at the optional image margin. */
2955 #define TOP_CORNER 0
2956 #define LEFT_CORNER 1
2957 #define BOT_CORNER 2
2958 #define RIGHT_CORNER 3
2960 /* Percent of image height used as ascent. A value of
2961 CENTERED_IMAGE_ASCENT means draw the image centered on the
2964 #define DEFAULT_IMAGE_ASCENT 50
2965 #define CENTERED_IMAGE_ASCENT -1
2967 /* Lisp specification of this image. */
2970 /* List of "references" followed to build the image.
2971 Typically will just contain the name of the image file.
2972 Used to allow fine-grained cache flushing. */
2973 Lisp_Object dependencies
;
2975 /* Relief to draw around the image. */
2978 /* Optional margins around the image. This includes the relief. */
2979 int hmargin
, vmargin
;
2981 /* Reference to the type of the image. */
2982 struct image_type
*type
;
2984 /* 1 means that loading the image failed. Don't try again. */
2985 unsigned load_failed_p
;
2987 /* A place for image types to store additional data. It is marked
2989 Lisp_Object lisp_data
;
2991 /* Hash value of image specification to speed up comparisons. */
2994 /* Image id of this image. */
2997 /* Hash collision chain. */
2998 struct image
*next
, *prev
;
3002 /* Cache of images. Each frame has a cache. X frames with the same
3003 x_display_info share their caches. */
3007 /* Hash table of images. */
3008 struct image
**buckets
;
3010 /* Vector mapping image ids to images. */
3011 struct image
**images
;
3013 /* Allocated size of `images'. */
3016 /* Number of images in the cache. */
3019 /* Reference count (number of frames sharing this cache). */
3024 /* Value is a pointer to the image with id ID on frame F, or null if
3025 no image with that id exists. */
3027 #define IMAGE_FROM_ID(F, ID) \
3028 (((ID) >= 0 && (ID) < (FRAME_IMAGE_CACHE (F)->used)) \
3029 ? FRAME_IMAGE_CACHE (F)->images[ID] \
3032 /* Size of bucket vector of image caches. Should be prime. */
3034 #define IMAGE_CACHE_BUCKETS_SIZE 1001
3036 #endif /* HAVE_WINDOW_SYSTEM */
3040 /***********************************************************************
3042 ***********************************************************************/
3044 /* Enumeration defining where to find tool-bar item information in
3045 tool-bar items vectors stored with frames. Each tool-bar item
3046 occupies TOOL_BAR_ITEM_NSLOTS elements in such a vector. */
3048 enum tool_bar_item_idx
3050 /* The key of the tool-bar item. Used to remove items when a binding
3051 for `undefined' is found. */
3054 /* Non-nil if item is enabled. */
3055 TOOL_BAR_ITEM_ENABLED_P
,
3057 /* Non-nil if item is selected (pressed). */
3058 TOOL_BAR_ITEM_SELECTED_P
,
3061 TOOL_BAR_ITEM_CAPTION
,
3063 /* Image(s) to display. This is either a single image specification
3064 or a vector of specifications. */
3065 TOOL_BAR_ITEM_IMAGES
,
3068 TOOL_BAR_ITEM_BINDING
,
3070 /* Button type. One of nil (default button), t (a separator),
3071 `:radio', or `:toggle'. The latter two currently do nothing. */
3077 /* Icon file name of right to left image when an RTL locale is used. */
3078 TOOL_BAR_ITEM_RTL_IMAGE
,
3080 /* Label to show when text labels are enabled. */
3081 TOOL_BAR_ITEM_LABEL
,
3083 /* If we shall show the label only below the icon and not beside it. */
3084 TOOL_BAR_ITEM_VERT_ONLY
,
3086 /* Sentinel = number of slots in tool_bar_items occupied by one
3088 TOOL_BAR_ITEM_NSLOTS
3092 /* An enumeration for the different images that can be specified
3093 for a tool-bar item. */
3095 enum tool_bar_item_image
3097 TOOL_BAR_IMAGE_ENABLED_SELECTED
,
3098 TOOL_BAR_IMAGE_ENABLED_DESELECTED
,
3099 TOOL_BAR_IMAGE_DISABLED_SELECTED
,
3100 TOOL_BAR_IMAGE_DISABLED_DESELECTED
3103 #define DEFAULT_TOOL_BAR_LABEL_SIZE 14
3105 /* Default values of the above variables. */
3107 #define DEFAULT_TOOL_BAR_BUTTON_MARGIN 4
3108 #define DEFAULT_TOOL_BAR_BUTTON_RELIEF 1
3110 /* The height in pixels of the default tool-bar images. */
3112 #define DEFAULT_TOOL_BAR_IMAGE_HEIGHT 24
3115 /***********************************************************************
3116 Terminal Capabilities
3117 ***********************************************************************/
3119 /* Each of these is a bit representing a terminal `capability' (bold,
3120 inverse, etc). They are or'd together to specify the set of
3121 capabilities being queried for when calling `tty_capable_p' (which
3122 returns true if the terminal supports all of them). */
3124 #define TTY_CAP_INVERSE 0x01
3125 #define TTY_CAP_UNDERLINE 0x02
3126 #define TTY_CAP_BOLD 0x04
3127 #define TTY_CAP_DIM 0x08
3128 #define TTY_CAP_ITALIC 0x10
3131 /***********************************************************************
3133 ***********************************************************************/
3135 /* Defined in bidi.c */
3137 extern void bidi_init_it (ptrdiff_t, ptrdiff_t, bool, struct bidi_it
*);
3138 extern void bidi_move_to_visually_next (struct bidi_it
*);
3139 extern void bidi_paragraph_init (bidi_dir_t
, struct bidi_it
*, bool);
3140 extern int bidi_mirror_char (int);
3141 extern void bidi_push_it (struct bidi_it
*);
3142 extern void bidi_pop_it (struct bidi_it
*);
3143 extern void *bidi_shelve_cache (void);
3144 extern void bidi_unshelve_cache (void *, bool);
3146 /* Defined in xdisp.c */
3148 struct glyph_row
*row_containing_pos (struct window
*, ptrdiff_t,
3150 struct glyph_row
*, int);
3151 int line_bottom_y (struct it
*);
3152 int default_line_pixel_height (struct window
*);
3153 int display_prop_intangible_p (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3154 void resize_echo_area_exactly (void);
3155 int resize_mini_window (struct window
*, int);
3156 #if defined USE_TOOLKIT_SCROLL_BARS && !defined USE_GTK
3157 void set_vertical_scroll_bar (struct window
*);
3159 int try_window (Lisp_Object
, struct text_pos
, int);
3160 void window_box (struct window
*, enum glyph_row_area
,
3161 int *, int *, int *, int *);
3162 int window_box_height (struct window
*);
3163 int window_text_bottom_y (struct window
*);
3164 int window_box_width (struct window
*, enum glyph_row_area
);
3165 int window_box_left (struct window
*, enum glyph_row_area
);
3166 int window_box_left_offset (struct window
*, enum glyph_row_area
);
3167 int window_box_right (struct window
*, enum glyph_row_area
);
3168 int window_box_right_offset (struct window
*, enum glyph_row_area
);
3169 int estimate_mode_line_height (struct frame
*, enum face_id
);
3170 void pixel_to_glyph_coords (struct frame
*, int, int, int *, int *,
3171 NativeRectangle
*, int);
3172 void remember_mouse_glyph (struct frame
*, int, int, NativeRectangle
*);
3174 void mark_window_display_accurate (Lisp_Object
, int);
3175 void redisplay_preserve_echo_area (int);
3176 void init_iterator (struct it
*, struct window
*, ptrdiff_t,
3177 ptrdiff_t, struct glyph_row
*, enum face_id
);
3178 void init_iterator_to_row_start (struct it
*, struct window
*,
3179 struct glyph_row
*);
3180 void start_display (struct it
*, struct window
*, struct text_pos
);
3181 void move_it_to (struct it
*, ptrdiff_t, int, int, int, int);
3182 void move_it_vertically (struct it
*, int);
3183 void move_it_vertically_backward (struct it
*, int);
3184 void move_it_by_lines (struct it
*, ptrdiff_t);
3185 void move_it_past_eol (struct it
*);
3186 void move_it_in_display_line (struct it
*it
,
3187 ptrdiff_t to_charpos
, int to_x
,
3188 enum move_operation_enum op
);
3189 int in_display_vector_p (struct it
*);
3190 int frame_mode_line_height (struct frame
*);
3191 extern Lisp_Object Qtool_bar
;
3192 extern bool redisplaying_p
;
3193 extern int help_echo_showing_p
;
3194 extern Lisp_Object help_echo_string
, help_echo_window
;
3195 extern Lisp_Object help_echo_object
, previous_help_echo_string
;
3196 extern ptrdiff_t help_echo_pos
;
3197 extern struct frame
*last_mouse_frame
;
3198 extern int last_tool_bar_item
;
3199 extern void reseat_at_previous_visible_line_start (struct it
*);
3200 extern Lisp_Object
lookup_glyphless_char_display (int, struct it
*);
3201 extern ptrdiff_t compute_display_string_pos (struct text_pos
*,
3202 struct bidi_string_data
*,
3203 struct window
*, int, int *);
3204 extern ptrdiff_t compute_display_string_end (ptrdiff_t,
3205 struct bidi_string_data
*);
3206 extern void produce_stretch_glyph (struct it
*);
3207 extern int merge_glyphless_glyph_face (struct it
*);
3209 #ifdef HAVE_WINDOW_SYSTEM
3212 extern void dump_glyph_string (struct glyph_string
*) EXTERNALLY_VISIBLE
;
3215 extern void x_get_glyph_overhangs (struct glyph
*, struct frame
*,
3217 extern void x_produce_glyphs (struct it
*);
3219 extern void x_write_glyphs (struct window
*, struct glyph_row
*,
3220 struct glyph
*, enum glyph_row_area
, int);
3221 extern void x_insert_glyphs (struct window
*, struct glyph_row
*,
3222 struct glyph
*, enum glyph_row_area
, int);
3223 extern void x_clear_end_of_line (struct window
*, struct glyph_row
*,
3224 enum glyph_row_area
, int);
3225 extern void x_fix_overlapping_area (struct window
*, struct glyph_row
*,
3226 enum glyph_row_area
, int);
3227 extern void draw_phys_cursor_glyph (struct window
*,
3229 enum draw_glyphs_face
);
3230 extern void get_phys_cursor_geometry (struct window
*, struct glyph_row
*,
3231 struct glyph
*, int *, int *, int *);
3232 extern void erase_phys_cursor (struct window
*);
3233 extern void display_and_set_cursor (struct window
*, bool, int, int, int, int);
3234 extern void x_update_cursor (struct frame
*, bool);
3235 extern void x_clear_cursor (struct window
*);
3236 extern void x_draw_vertical_border (struct window
*w
);
3238 extern int get_glyph_string_clip_rects (struct glyph_string
*,
3239 NativeRectangle
*, int);
3240 extern void get_glyph_string_clip_rect (struct glyph_string
*,
3241 NativeRectangle
*nr
);
3242 extern Lisp_Object
find_hot_spot (Lisp_Object
, int, int);
3244 extern void handle_tool_bar_click (struct frame
*,
3245 int, int, int, int);
3247 extern void expose_frame (struct frame
*, int, int, int, int);
3248 extern int x_intersect_rectangles (XRectangle
*, XRectangle
*,
3250 #endif /* HAVE_WINDOW_SYSTEM */
3252 extern void note_mouse_highlight (struct frame
*, int, int);
3253 extern void x_clear_window_mouse_face (struct window
*);
3254 extern void cancel_mouse_face (struct frame
*);
3255 extern int clear_mouse_face (Mouse_HLInfo
*);
3256 extern int cursor_in_mouse_face_p (struct window
*w
);
3257 extern void tty_draw_row_with_mouse_face (struct window
*, struct glyph_row
*,
3258 int, int, enum draw_glyphs_face
);
3260 /* Flags passed to try_window. */
3261 #define TRY_WINDOW_CHECK_MARGINS (1 << 0)
3262 #define TRY_WINDOW_IGNORE_FONTS_CHANGE (1 << 1)
3264 int lookup_fringe_bitmap (Lisp_Object
);
3265 void draw_fringe_bitmap (struct window
*, struct glyph_row
*, int);
3266 void draw_row_fringe_bitmaps (struct window
*, struct glyph_row
*);
3267 bool draw_window_fringes (struct window
*, bool);
3268 bool update_window_fringes (struct window
*, bool);
3269 void compute_fringe_widths (struct frame
*, bool);
3272 void w32_init_fringe (struct redisplay_interface
*);
3273 void w32_reset_fringes (void);
3276 extern unsigned row_hash (struct glyph_row
*);
3278 /* Defined in image.c */
3280 #ifdef HAVE_WINDOW_SYSTEM
3282 extern int x_bitmap_height (struct frame
*, ptrdiff_t);
3283 extern int x_bitmap_width (struct frame
*, ptrdiff_t);
3284 extern ptrdiff_t x_bitmap_pixmap (struct frame
*, ptrdiff_t);
3285 extern void x_reference_bitmap (struct frame
*, ptrdiff_t);
3286 extern ptrdiff_t x_create_bitmap_from_data (struct frame
*, char *,
3287 unsigned int, unsigned int);
3288 extern ptrdiff_t x_create_bitmap_from_file (struct frame
*, Lisp_Object
);
3289 #if defined HAVE_XPM && defined HAVE_X_WINDOWS && !defined USE_GTK
3290 extern ptrdiff_t x_create_bitmap_from_xpm_data (struct frame
*, const char **);
3292 #ifndef x_destroy_bitmap
3293 extern void x_destroy_bitmap (struct frame
*, ptrdiff_t);
3295 extern void x_destroy_all_bitmaps (Display_Info
*);
3296 extern void x_create_bitmap_mask (struct frame
*, ptrdiff_t);
3297 extern Lisp_Object
x_find_image_file (Lisp_Object
);
3299 void x_kill_gs_process (Pixmap
, struct frame
*);
3300 struct image_cache
*make_image_cache (void);
3301 void free_image_cache (struct frame
*);
3302 void clear_image_caches (Lisp_Object
);
3303 void mark_image_cache (struct image_cache
*);
3304 bool valid_image_p (Lisp_Object
);
3305 void prepare_image_for_display (struct frame
*, struct image
*);
3306 ptrdiff_t lookup_image (struct frame
*, Lisp_Object
);
3308 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3309 #define RGB_PIXEL_COLOR unsigned long
3313 #define RGB_PIXEL_COLOR COLORREF
3316 RGB_PIXEL_COLOR
image_background (struct image
*, struct frame
*,
3317 XImagePtr_or_DC ximg
);
3318 int image_background_transparent (struct image
*, struct frame
*,
3319 XImagePtr_or_DC mask
);
3321 int image_ascent (struct image
*, struct face
*, struct glyph_slice
*);
3325 /* Defined in sysdep.c */
3327 void get_tty_size (int, int *, int *);
3328 void request_sigio (void);
3329 void unrequest_sigio (void);
3330 bool tabs_safe_p (int);
3331 void init_baud_rate (int);
3332 void init_sigio (int);
3333 void ignore_sigio (void);
3335 /* Defined in xfaces.c */
3337 #ifdef HAVE_X_WINDOWS
3338 void x_free_colors (struct frame
*, unsigned long *, int);
3341 void update_face_from_frame_parameter (struct frame
*, Lisp_Object
,
3343 Lisp_Object
tty_color_name (struct frame
*, int);
3344 void clear_face_cache (int);
3345 unsigned long load_color (struct frame
*, struct face
*, Lisp_Object
,
3346 enum lface_attribute_index
);
3347 void unload_color (struct frame
*, unsigned long);
3348 char *choose_face_font (struct frame
*, Lisp_Object
*, Lisp_Object
,
3350 void prepare_face_for_display (struct frame
*, struct face
*);
3351 int lookup_named_face (struct frame
*, Lisp_Object
, int);
3352 int lookup_basic_face (struct frame
*, int);
3353 int smaller_face (struct frame
*, int, int);
3354 int face_with_height (struct frame
*, int, int);
3355 int lookup_derived_face (struct frame
*, Lisp_Object
, int, int);
3356 void init_frame_faces (struct frame
*);
3357 void free_frame_faces (struct frame
*);
3358 void recompute_basic_faces (struct frame
*);
3359 int face_at_buffer_position (struct window
*w
, ptrdiff_t pos
,
3360 ptrdiff_t region_beg
, ptrdiff_t region_end
,
3361 ptrdiff_t *endptr
, ptrdiff_t limit
,
3362 int mouse
, int base_face_id
);
3363 int face_for_overlay_string (struct window
*w
, ptrdiff_t pos
,
3364 ptrdiff_t region_beg
, ptrdiff_t region_end
,
3365 ptrdiff_t *endptr
, ptrdiff_t limit
,
3366 int mouse
, Lisp_Object overlay
);
3367 int face_at_string_position (struct window
*w
, Lisp_Object string
,
3368 ptrdiff_t pos
, ptrdiff_t bufpos
,
3369 ptrdiff_t region_beg
, ptrdiff_t region_end
,
3370 ptrdiff_t *endptr
, enum face_id
, int mouse
);
3371 int merge_faces (struct frame
*, Lisp_Object
, int, int);
3372 int compute_char_face (struct frame
*, int, Lisp_Object
);
3373 void free_all_realized_faces (Lisp_Object
);
3374 extern Lisp_Object Qforeground_color
, Qbackground_color
;
3375 extern char unspecified_fg
[], unspecified_bg
[];
3377 /* Defined in xfns.c */
3379 #ifdef HAVE_X_WINDOWS
3380 void gamma_correct (struct frame
*, XColor
*);
3383 void gamma_correct (struct frame
*, COLORREF
*);
3386 #ifdef HAVE_WINDOW_SYSTEM
3388 void x_implicitly_set_name (struct frame
*, Lisp_Object
, Lisp_Object
);
3390 extern Lisp_Object tip_frame
;
3391 extern Window tip_window
;
3392 extern frame_parm_handler x_frame_parm_handlers
[];
3394 extern void start_hourglass (void);
3395 extern void cancel_hourglass (void);
3396 extern int hourglass_shown_p
;
3397 /* If non-null, an asynchronous timer that, when it expires, displays
3398 an hourglass cursor on all frames. */
3399 extern struct atimer
*hourglass_atimer
;
3401 /* Each GUI implements these. FIXME: move into RIF. */
3402 extern void show_hourglass (struct atimer
*);
3403 extern void hide_hourglass (void);
3405 /* Returns the background color of IMG, calculating one heuristically if
3406 necessary. If non-zero, XIMG is an existing XImage object to use for
3409 #define IMAGE_BACKGROUND(img, f, ximg) \
3410 ((img)->background_valid \
3411 ? (img)->background \
3412 : image_background (img, f, ximg))
3414 /* Returns true if IMG has a `transparent' background, using heuristics
3415 to decide if necessary. If non-zero, MASK is an existing XImage
3416 object to use for the heuristic. */
3418 #define IMAGE_BACKGROUND_TRANSPARENT(img, f, mask) \
3419 ((img)->background_transparent_valid \
3420 ? (img)->background_transparent \
3421 : image_background_transparent (img, f, mask))
3423 #endif /* HAVE_WINDOW_SYSTEM */
3426 /* Defined in xmenu.c */
3428 int popup_activated (void);
3430 extern Lisp_Object
buffer_posn_from_coords (struct window
*,
3432 struct display_pos
*,
3434 int *, int *, int *, int *);
3435 extern Lisp_Object
mode_line_string (struct window
*, enum window_part
,
3436 int *, int *, ptrdiff_t *,
3438 int *, int *, int *, int *);
3439 extern Lisp_Object
marginal_area_string (struct window
*, enum window_part
,
3440 int *, int *, ptrdiff_t *,
3442 int *, int *, int *, int *);
3443 extern void redraw_frame (struct frame
*);
3444 extern void cancel_line (int, struct frame
*);
3445 extern void init_desired_glyphs (struct frame
*);
3446 extern bool update_frame (struct frame
*, bool, bool);
3447 extern void bitch_at_user (void);
3448 extern void adjust_frame_glyphs (struct frame
*);
3449 void free_glyphs (struct frame
*);
3450 void free_window_matrices (struct window
*);
3451 void check_glyph_memory (void);
3452 void mirrored_line_dance (struct glyph_matrix
*, int, int, int *, char *);
3453 void clear_glyph_matrix (struct glyph_matrix
*);
3454 void clear_current_matrices (struct frame
*f
);
3455 void clear_desired_matrices (struct frame
*);
3456 void shift_glyph_matrix (struct window
*, struct glyph_matrix
*,
3458 void rotate_matrix (struct glyph_matrix
*, int, int, int);
3459 void increment_matrix_positions (struct glyph_matrix
*,
3460 int, int, ptrdiff_t, ptrdiff_t);
3461 void blank_row (struct window
*, struct glyph_row
*, int);
3462 void clear_glyph_matrix_rows (struct glyph_matrix
*, int, int);
3463 void clear_glyph_row (struct glyph_row
*);
3464 void prepare_desired_row (struct glyph_row
*);
3465 void set_window_update_flags (struct window
*, bool);
3466 void update_single_window (struct window
*, bool);
3467 void do_pending_window_change (bool);
3468 void change_frame_size (struct frame
*, int, int, bool, bool, bool);
3469 void init_display (void);
3470 void syms_of_display (void);
3471 extern Lisp_Object Qredisplay_dont_pause
;
3472 void spec_glyph_lookup_face (struct window
*, GLYPH
*);
3474 /* Defined in terminal.c */
3476 extern void ring_bell (struct frame
*);
3477 extern void update_begin (struct frame
*);
3478 extern void update_end (struct frame
*);
3479 extern void set_terminal_window (struct frame
*, int);
3480 extern void cursor_to (struct frame
*, int, int);
3481 extern void raw_cursor_to (struct frame
*, int, int);
3482 extern void clear_to_end (struct frame
*);
3483 extern void clear_frame (struct frame
*);
3484 extern void clear_end_of_line (struct frame
*, int);
3485 extern void write_glyphs (struct frame
*, struct glyph
*, int);
3486 extern void insert_glyphs (struct frame
*, struct glyph
*, int);
3487 extern void delete_glyphs (struct frame
*, int);
3488 extern void ins_del_lines (struct frame
*, int, int);
3490 extern struct terminal
*init_initial_terminal (void);
3493 /* Defined in term.c */
3495 extern void tty_turn_off_insert (struct tty_display_info
*);
3496 extern int string_cost (const char *);
3497 extern int per_line_cost (const char *);
3498 extern void calculate_costs (struct frame
*);
3499 extern void produce_glyphs (struct it
*);
3500 extern bool tty_capable_p (struct tty_display_info
*, unsigned,
3501 unsigned long, unsigned long);
3502 extern void set_tty_color_mode (struct tty_display_info
*, struct frame
*);
3503 extern struct terminal
*get_named_tty (const char *);
3504 extern void create_tty_output (struct frame
*);
3505 extern struct terminal
*init_tty (const char *, const char *, bool);
3506 extern void tty_append_glyph (struct it
*);
3509 /* Defined in scroll.c */
3511 extern int scrolling_max_lines_saved (int, int, int *, int *, int *);
3512 extern void do_line_insertion_deletion_costs (struct frame
*, const char *,
3513 const char *, const char *,
3514 const char *, const char *,
3516 void scrolling_1 (struct frame
*, int, int, int, int *, int *, int *,
3519 /* Defined in frame.c */
3521 #ifdef HAVE_WINDOW_SYSTEM
3523 /* Types we might convert a resource string into. */
3531 RES_TYPE_BOOLEAN_NUMBER
3534 extern Display_Info
*check_x_display_info (Lisp_Object
);
3535 extern Lisp_Object
x_get_arg (Display_Info
*, Lisp_Object
,
3536 Lisp_Object
, const char *, const char *class,
3537 enum resource_types
);
3538 extern Lisp_Object
x_frame_get_and_record_arg (struct frame
*, Lisp_Object
,
3540 const char *, const char *,
3541 enum resource_types
);
3542 extern Lisp_Object
x_default_parameter (struct frame
*, Lisp_Object
,
3543 Lisp_Object
, Lisp_Object
,
3544 const char *, const char *,
3545 enum resource_types
);
3546 extern char *x_get_string_resource (XrmDatabase
, const char *,
3549 #endif /* HAVE_WINDOW_SYSTEM */
3553 #endif /* not DISPEXTERN_H_INCLUDED */