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 */
53 #include <c-strcase.h>
55 xstrcasecmp (char const *a
, char const *b
)
57 return c_strcasecmp (a
, b
);
61 #include <X11/Xresource.h> /* for XrmDatabase */
62 typedef struct x_display_info Display_Info
;
63 typedef XImage
* XImagePtr
;
64 typedef XImagePtr XImagePtr_or_DC
;
65 #define NativeRectangle XRectangle
70 typedef struct w32_display_info Display_Info
;
71 typedef XImage
*XImagePtr
;
72 typedef HDC XImagePtr_or_DC
;
77 /* Following typedef needed to accommodate the MSDOS port, believe it or not. */
78 typedef struct ns_display_info Display_Info
;
79 typedef Pixmap XImagePtr
;
80 typedef XImagePtr XImagePtr_or_DC
;
83 #ifdef HAVE_WINDOW_SYSTEM
87 #ifndef HAVE_WINDOW_SYSTEM
92 #ifndef NativeRectangle
93 #define NativeRectangle int
96 /* Text cursor types. */
98 enum text_cursor_kinds
108 /* Values returned from coordinates_in_window. */
124 /* Number of bits allocated to store fringe bitmap numbers. */
125 #define FRINGE_ID_BITS 16
127 /* Number of bits allocated to store fringe bitmap height. */
128 #define FRINGE_HEIGHT_BITS 8
131 /***********************************************************************
133 ***********************************************************************/
135 /* If GLYPH_DEBUG is defined, additional checks are activated. */
137 /* Macros to include code only if GLYPH_DEBUG is defined. */
140 #define IF_DEBUG(X) X
142 #define IF_DEBUG(X) (void) 0
145 /* Macro for displaying traces of redisplay. If Emacs was compiled
146 with GLYPH_DEBUG defined, the variable trace_redisplay_p can be set to
147 a non-zero value in debugging sessions to activate traces. */
151 extern int trace_redisplay_p EXTERNALLY_VISIBLE
;
155 if (trace_redisplay_p) \
160 #else /* not GLYPH_DEBUG */
162 #define TRACE(X) (void) 0
164 #endif /* GLYPH_DEBUG */
168 /***********************************************************************
170 ***********************************************************************/
172 /* Starting with Emacs 20.3, characters from strings and buffers have
173 both a character and a byte position associated with them. The
174 following structure holds such a pair of positions. */
178 /* Character position. */
181 /* Corresponding byte position. */
185 /* Access character and byte position of POS in a functional form. */
187 #define BYTEPOS(POS) (POS).bytepos
188 #define CHARPOS(POS) (POS).charpos
190 /* Set character position of POS to CHARPOS, byte position to BYTEPOS. */
192 #define SET_TEXT_POS(POS, CHARPOS, BYTEPOS) \
193 ((POS).charpos = (CHARPOS), (POS).bytepos = BYTEPOS)
195 /* Increment text position POS. */
197 #define INC_TEXT_POS(POS, MULTIBYTE_P) \
202 INC_POS ((POS).bytepos); \
208 /* Decrement text position POS. */
210 #define DEC_TEXT_POS(POS, MULTIBYTE_P) \
215 DEC_POS ((POS).bytepos); \
221 /* Set text position POS from marker MARKER. */
223 #define SET_TEXT_POS_FROM_MARKER(POS, MARKER) \
224 (CHARPOS (POS) = marker_position (MARKER), \
225 BYTEPOS (POS) = marker_byte_position (MARKER))
227 /* Like above, but clip POS within accessible range. */
229 #define CLIP_TEXT_POS_FROM_MARKER(POS, MARKER) \
230 (CHARPOS (POS) = clip_to_bounds \
231 (BEGV, marker_position (MARKER), ZV), \
232 BYTEPOS (POS) = clip_to_bounds \
233 (BEGV_BYTE, marker_byte_position (MARKER), ZV_BYTE))
235 /* Set marker MARKER from text position POS. */
237 #define SET_MARKER_FROM_TEXT_POS(MARKER, POS) \
238 set_marker_both ((MARKER), Qnil, CHARPOS ((POS)), BYTEPOS ((POS)))
240 /* Value is non-zero if character and byte positions of POS1 and POS2
243 #define TEXT_POS_EQUAL_P(POS1, POS2) \
244 ((POS1).charpos == (POS2).charpos \
245 && (POS1).bytepos == (POS2).bytepos)
247 /* When rendering glyphs, redisplay scans string or buffer text,
248 overlay strings in that text, and does display table or control
249 character translations. The following structure captures a
250 position taking all this into account. */
254 /* Buffer or string position. */
257 /* If this is a position in an overlay string, overlay_string_index
258 is the index of that overlay string in the sequence of overlay
259 strings at `pos' in the order redisplay processes them. A value
260 < 0 means that this is not a position in an overlay string. */
261 ptrdiff_t overlay_string_index
;
263 /* If this is a position in an overlay string, string_pos is the
264 position within that string. */
265 struct text_pos string_pos
;
267 /* If the character at the position above is a control character or
268 has a display table entry, dpvec_index is an index in the display
269 table or control character translation of that character. A
270 value < 0 means this is not a position in such a translation. */
276 /***********************************************************************
278 ***********************************************************************/
280 /* The glyph datatype, used to represent characters on the display.
281 It consists of a char code and a face id. */
288 /* Return a glyph's character code. */
289 INLINE
int GLYPH_CHAR (GLYPH glyph
) { return glyph
.ch
; }
291 /* Return a glyph's face ID. */
292 INLINE
int GLYPH_FACE (GLYPH glyph
) { return glyph
.face_id
; }
294 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
295 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
296 #define SET_GLYPH(glyph, char, face) \
297 ((glyph).ch = (char), (glyph).face_id = (face))
299 /* The following are valid only if GLYPH_CODE_P (gc). */
302 GLYPH_CODE_CHAR (Lisp_Object gc
)
306 : XINT (gc
) & MAX_CHAR
);
310 GLYPH_CODE_FACE (Lisp_Object gc
)
312 return CONSP (gc
) ? XINT (XCDR (gc
)) : XINT (gc
) >> CHARACTERBITS
;
315 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
319 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
321 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
322 (XINT (gc) >> CHARACTERBITS)); \
326 /* The ID of the mode line highlighting face. */
327 enum { GLYPH_MODE_LINE_FACE
= 1 };
329 /* Enumeration of glyph types. Glyph structures contain a type field
330 containing one of the enumerators defined here. */
334 /* Glyph describes a character. */
337 /* Glyph describes a static composition. */
340 /* Glyph describes a glyphless character. */
343 /* Glyph describes an image. */
346 /* Glyph is a space of fractional width and/or height. */
351 /* Structure describing how to use partial glyphs (images slicing) */
358 unsigned height
: 16;
364 Be extra careful when changing this structure! Esp. make sure that
365 functions producing glyphs, like append_glyph, fill ALL of the
366 glyph structure, and that GLYPH_EQUAL_P compares all
367 display-relevant members of glyphs (not to imply that these are the
368 only things to check when you add a member). */
372 /* Position from which this glyph was drawn. If `object' below is a
373 Lisp string, this is an index into that string. If it is a
374 buffer, this is a position in that buffer. In addition, some
375 special glyphs have special values for this:
377 glyph standing for newline at end of line 0
378 empty space after the end of the line -1
379 overlay arrow on a TTY -1
380 glyph at EOB that ends in a newline -1
381 left truncation glyphs: -1
382 right truncation/continuation glyphs next buffer position
383 glyph standing for newline of an empty line buffer position of newline
384 stretch glyph at left edge of R2L lines buffer position of newline */
387 /* Lisp object source of this glyph. Currently either a buffer or a
388 string, if the glyph was produced from characters which came from
389 a buffer or a string; or Lisp integer zero (a.k.a. "null object")
390 if the glyph was inserted by redisplay for its own purposes, such
391 as padding or truncation/continuation glyphs, or the
392 overlay-arrow glyphs on TTYs. */
395 /* Width in pixels. */
398 /* Ascent and descent in pixels. */
399 short ascent
, descent
;
401 /* Vertical offset. If < 0, the glyph is displayed raised, if > 0
402 the glyph is displayed lowered. */
405 /* Which kind of glyph this is---character, image etc. Value
406 should be an enumerator of type enum glyph_type. */
409 /* 1 means this glyph was produced from multibyte text. Zero
410 means it was produced from unibyte text, i.e. charsets aren't
411 applicable, and encoding is not performed. */
412 unsigned multibyte_p
: 1;
414 /* Non-zero means draw a box line at the left or right side of this
415 glyph. This is part of the implementation of the face attribute
417 unsigned left_box_line_p
: 1;
418 unsigned right_box_line_p
: 1;
420 /* Non-zero means this glyph's physical ascent or descent is greater
421 than its logical ascent/descent, i.e. it may potentially overlap
422 glyphs above or below it. */
423 unsigned overlaps_vertically_p
: 1;
425 /* For terminal frames, 1 means glyph is a padding glyph. Padding
426 glyphs are used for characters whose visual shape consists of
427 more than one glyph (e.g. Asian characters). All but the first
428 glyph of such a glyph sequence have the padding_p flag set. This
429 flag is used only to minimize code changes. A better way would
430 probably be to use the width field of glyphs to express padding.
432 For graphic frames, 1 means the pixel width of the glyph in a
433 font is 0, but 1-pixel is padded on displaying for correct cursor
434 displaying. The member `pixel_width' above is set to 1. */
435 unsigned padding_p
: 1;
437 /* 1 means the actual glyph is not available, draw using `struct
438 glyphless' below instead. This can happen when a font couldn't
439 be loaded, or a character doesn't have a glyph in a font. */
440 unsigned glyph_not_available_p
: 1;
442 /* Non-zero means don't display cursor here. */
443 unsigned avoid_cursor_p
: 1;
445 /* Resolved bidirectional level of this character [0..63]. */
446 unsigned resolved_level
: 5;
448 /* Resolved bidirectional type of this character, see enum
449 bidi_type_t below. Note that according to UAX#9, only some
450 values (STRONG_L, STRONG_R, WEAK_AN, WEAK_EN, WEAK_BN, and
451 NEUTRAL_B) can appear in the resolved type, so we only reserve
452 space for those that can. */
453 unsigned bidi_type
: 3;
455 #define FACE_ID_BITS 20
457 /* Face of the glyph. This is a realized face ID,
458 an index in the face cache of the frame. */
459 unsigned face_id
: FACE_ID_BITS
;
461 /* Type of font used to display the character glyph. May be used to
462 determine which set of functions to use to obtain font metrics
463 for the glyph. On W32, value should be an enumerator of the type
464 w32_char_font_type. Otherwise it equals FONT_TYPE_UNKNOWN. */
465 unsigned font_type
: 3;
467 /* A union of sub-structures for different glyph types. */
470 /* Metrics of a partial glyph of an image (type == IMAGE_GLYPH). */
471 struct glyph_slice img
;
472 /* Start and end indices of glyphs of a grapheme cluster of a
473 composition (type == COMPOSITE_GLYPH). */
474 struct { int from
, to
; } cmp
;
475 /* Pixel offsets for upper and lower part of the acronym. */
477 short upper_xoff
, upper_yoff
;
478 short lower_xoff
, lower_yoff
;
482 /* A union of sub-structures for different glyph types. */
485 /* Character code for character glyphs (type == CHAR_GLYPH). */
488 /* Sub-structures for type == COMPOSITE_GLYPH. */
491 /* Flag to tell if the composition is automatic or not. */
492 unsigned automatic
: 1;
493 /* ID of the composition. */
497 /* Image ID for image glyphs (type == IMAGE_GLYPH). */
500 /* Sub-structure for type == STRETCH_GLYPH. */
503 /* The height of the glyph. */
504 unsigned height
: 16;
506 /* The ascent of the glyph. */
507 unsigned ascent
: 16;
511 /* Sub-stretch for type == GLYPHLESS_GLYPH. */
514 /* Value is an enum of the type glyphless_display_method. */
516 /* 1 iff this glyph is for a character of no font. */
517 unsigned for_no_font
: 1;
518 /* Length of acronym or hexadecimal code string (at most 8). */
520 /* Character to display. Actually we need only 22 bits. */
524 /* Used to compare all bit-fields above in one step. */
530 /* Default value of the glyph font_type field. */
532 #define FONT_TYPE_UNKNOWN 0
534 /* Is GLYPH a space? */
536 #define CHAR_GLYPH_SPACE_P(GLYPH) \
537 ((GLYPH).u.ch == SPACEGLYPH && (GLYPH).face_id == DEFAULT_FACE_ID)
539 /* Are glyph slices of glyphs *X and *Y equal? It assumes that both
540 glyphs have the same type.
542 Note: for composition glyphs, we don't have to compare slice.cmp.to
543 because they should be the same if and only if slice.cmp.from are
546 #define GLYPH_SLICE_EQUAL_P(X, Y) \
547 ((X)->type == IMAGE_GLYPH \
548 ? ((X)->slice.img.x == (Y)->slice.img.x \
549 && (X)->slice.img.y == (Y)->slice.img.y \
550 && (X)->slice.img.width == (Y)->slice.img.width \
551 && (X)->slice.img.height == (Y)->slice.img.height) \
552 : ((X)->type != COMPOSITE_GLYPH \
553 || (X)->slice.cmp.from == (Y)->slice.cmp.from))
555 /* Are glyphs *X and *Y displayed equal? */
557 #define GLYPH_EQUAL_P(X, Y) \
558 ((X)->type == (Y)->type \
559 && (X)->u.val == (Y)->u.val \
560 && GLYPH_SLICE_EQUAL_P (X, Y) \
561 && (X)->face_id == (Y)->face_id \
562 && (X)->padding_p == (Y)->padding_p \
563 && (X)->left_box_line_p == (Y)->left_box_line_p \
564 && (X)->right_box_line_p == (Y)->right_box_line_p \
565 && (X)->voffset == (Y)->voffset \
566 && (X)->pixel_width == (Y)->pixel_width)
568 /* Are character codes, faces, padding_ps of glyphs *X and *Y equal? */
570 #define GLYPH_CHAR_AND_FACE_EQUAL_P(X, Y) \
571 ((X)->u.ch == (Y)->u.ch \
572 && (X)->face_id == (Y)->face_id \
573 && (X)->padding_p == (Y)->padding_p)
575 /* Fill a character glyph GLYPH. CODE, FACE_ID, PADDING_P correspond
576 to the bits defined for the typedef `GLYPH' in lisp.h. */
578 #define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P) \
581 (GLYPH).u.ch = (CODE); \
582 (GLYPH).face_id = (FACE_ID); \
583 (GLYPH).padding_p = (PADDING_P); \
587 /* Fill a character type glyph GLYPH from a glyph typedef FROM as
588 defined in lisp.h. */
590 #define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM) \
591 SET_CHAR_GLYPH ((GLYPH), \
592 GLYPH_CHAR ((FROM)), \
593 GLYPH_FACE ((FROM)), \
596 /* Construct a glyph code from a character glyph GLYPH. If the
597 character is multibyte, return -1 as we can't use glyph table for a
598 multibyte character. */
600 #define SET_GLYPH_FROM_CHAR_GLYPH(G, GLYPH) \
603 if ((GLYPH).u.ch < 256) \
604 SET_GLYPH ((G), (GLYPH).u.ch, ((GLYPH).face_id)); \
606 SET_GLYPH ((G), -1, 0); \
610 #define GLYPH_INVALID_P(GLYPH) (GLYPH_CHAR (GLYPH) < 0)
612 /* Is GLYPH a padding glyph? */
614 #define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p
619 /***********************************************************************
621 ***********************************************************************/
625 Glyph memory for frame-based redisplay is allocated from the heap
626 in one vector kept in a glyph pool structure which is stored with
627 the frame. The size of the vector is made large enough to cover
628 all windows on the frame.
630 Both frame and window glyph matrices reference memory from a glyph
631 pool in frame-based redisplay.
633 In window-based redisplay, no glyphs pools exist; windows allocate
634 and free their glyph memory themselves. */
638 /* Vector of glyphs allocated from the heap. */
639 struct glyph
*glyphs
;
641 /* Allocated size of `glyphs'. */
644 /* Number of rows and columns in a matrix. */
650 /***********************************************************************
652 ***********************************************************************/
656 Three kinds of glyph matrices exist:
658 1. Frame glyph matrices. These are used for terminal frames whose
659 redisplay needs a view of the whole screen due to limited terminal
660 capabilities. Frame matrices are used only in the update phase
661 of redisplay. They are built in update_frame and not used after
662 the update has been performed.
664 2. Window glyph matrices on frames having frame glyph matrices.
665 Such matrices are sub-matrices of their corresponding frame matrix,
666 i.e., frame glyph matrices and window glyph matrices share the same
667 glyph memory, which is allocated in the form of a glyph_pool structure.
668 Glyph rows in such a window matrix are slices of frame matrix rows.
670 2. Free-standing window glyph matrices managing their own glyph
671 storage. This form is used in window-based redisplay which
672 includes variable width and height fonts etc.
674 The size of a window's row vector depends on the height of fonts
675 defined on its frame. It is chosen so that the vector is large
676 enough to describe all lines in a window when it is displayed in
677 the smallest possible character size. When new fonts are loaded,
678 or window sizes change, the row vector is adjusted accordingly. */
682 /* The pool from which glyph memory is allocated, if any. This is
683 null for frame matrices and for window matrices managing their
685 struct glyph_pool
*pool
;
687 /* Vector of glyph row structures. The row at nrows - 1 is reserved
688 for the mode line. */
689 struct glyph_row
*rows
;
691 /* Number of elements allocated for the vector rows above. */
692 ptrdiff_t rows_allocated
;
694 /* The number of rows used by the window if all lines were displayed
695 with the smallest possible character height. */
698 /* Origin within the frame matrix if this is a window matrix on a
699 frame having a frame matrix. Both values are zero for
700 window-based redisplay. */
701 int matrix_x
, matrix_y
;
703 /* Width and height of the matrix in columns and rows. */
704 int matrix_w
, matrix_h
;
706 /* If this structure describes a window matrix of window W,
707 window_left_col is the value of W->left_col, window_top_line the
708 value of W->top_line, window_height and window_width are width and
709 height of W, as returned by window_box, and window_vscroll is the
710 value of W->vscroll at the time the matrix was last adjusted.
711 Only set for window-based redisplay. */
712 int window_left_col
, window_top_line
;
713 int window_height
, window_width
;
716 /* Number of glyphs reserved for left and right marginal areas when
717 the matrix was last adjusted. */
718 int left_margin_glyphs
, right_margin_glyphs
;
720 /* Flag indicating that scrolling should not be tried in
721 update_window. This flag is set by functions like try_window_id
722 which do their own scrolling. */
723 unsigned no_scrolling_p
: 1;
725 /* Non-zero means window displayed in this matrix has a top mode
727 unsigned header_line_p
: 1;
730 /* A string identifying the method used to display the matrix. */
734 /* The buffer this matrix displays. Set in
735 mark_window_display_accurate_1. */
736 struct buffer
*buffer
;
738 /* Values of BEGV and ZV as of last redisplay. Set in
739 mark_window_display_accurate_1. */
744 /* Check that glyph pointers stored in glyph rows of MATRIX are okay.
745 This aborts if any pointer is found twice. */
748 void check_matrix_pointer_lossage (struct glyph_matrix
*);
749 #define CHECK_MATRIX(MATRIX) check_matrix_pointer_lossage ((MATRIX))
751 #define CHECK_MATRIX(MATRIX) (void) 0
756 /***********************************************************************
758 ***********************************************************************/
760 /* Area in window glyph matrix. If values are added or removed,
761 the function mark_glyph_matrix in alloc.c may need to be changed. */
773 /* Rows of glyphs in a windows or frame glyph matrix.
775 Each row is partitioned into three areas. The start and end of
776 each area is recorded in a pointer as shown below.
778 +--------------------+-------------+---------------------+
779 | left margin area | text area | right margin area |
780 +--------------------+-------------+---------------------+
782 glyphs[LEFT_MARGIN_AREA] glyphs[RIGHT_MARGIN_AREA]
787 Rows in frame matrices reference glyph memory allocated in a frame
788 glyph pool (see the description of struct glyph_pool). Rows in
789 window matrices on frames having frame matrices reference slices of
790 the glyphs of corresponding rows in the frame matrix.
792 Rows in window matrices on frames having no frame matrices point to
793 glyphs allocated from the heap via xmalloc;
794 glyphs[LEFT_MARGIN_AREA] is the start address of the allocated
795 glyph structure array. */
799 /* Pointers to beginnings of areas. The end of an area A is found at
800 A + 1 in the vector. The last element of the vector is the end
803 Kludge alert: Even if used[TEXT_AREA] == 0, glyphs[TEXT_AREA][0]'s
804 position field is used. It is -1 if this row does not correspond
805 to any text; it is some buffer position if the row corresponds to
806 an empty display line that displays a line end. This is what old
807 redisplay used to do. (Except in code for terminal frames, this
808 kludge is no longer used, I believe. --gerd).
810 See also start, end, displays_text_p and ends_at_zv_p for cleaner
811 ways to do it. The special meaning of positions 0 and -1 will be
812 removed some day, so don't use it in new code. */
813 struct glyph
*glyphs
[1 + LAST_AREA
];
815 /* Number of glyphs actually filled in areas. */
816 short used
[LAST_AREA
];
818 /* Window-relative x and y-position of the top-left corner of this
819 row. If y < 0, this means that eabs (y) pixels of the row are
820 invisible because it is partially visible at the top of a window.
821 If x < 0, this means that eabs (x) pixels of the first glyph of
822 the text area of the row are invisible because the glyph is
823 partially visible. */
826 /* Width of the row in pixels without taking face extension at the
827 end of the row into account, and without counting truncation
828 and continuation glyphs at the end of a row on ttys. */
831 /* Logical ascent/height of this line. The value of ascent is zero
832 and height is 1 on terminal frames. */
835 /* Physical ascent/height of this line. If max_ascent > ascent,
836 this line overlaps the line above it on the display. Otherwise,
837 if max_height > height, this line overlaps the line beneath it. */
838 int phys_ascent
, phys_height
;
840 /* Portion of row that is visible. Partially visible rows may be
841 found at the top and bottom of a window. This is 1 for tty
842 frames. It may be < 0 in case of completely invisible rows. */
845 /* Extra line spacing added after this row. Do not consider this
846 in last row when checking if row is fully visible. */
847 int extra_line_spacing
;
849 /* Hash code. This hash code is available as soon as the row
850 is constructed, i.e. after a call to display_line. */
853 /* First position in this row. This is the text position, including
854 overlay position information etc, where the display of this row
855 started, and can thus be less than the position of the first
856 glyph (e.g. due to invisible text or horizontal scrolling).
857 BIDI Note: In R2L rows, that have its reversed_p flag set, this
858 position is at or beyond the right edge of the row. */
859 struct display_pos start
;
861 /* Text position at the end of this row. This is the position after
862 the last glyph on this row. It can be greater than the last
863 glyph position + 1, due to a newline that ends the line,
864 truncation, invisible text etc. In an up-to-date display, this
865 should always be equal to the start position of the next row.
866 BIDI Note: In R2L rows, this position is at or beyond the left
868 struct display_pos end
;
870 /* The smallest and the largest buffer positions that contributed to
871 glyphs in this row. Note that due to bidi reordering, these are
872 in general different from the text positions stored in `start'
873 and `end' members above, and also different from the buffer
874 positions recorded in the glyphs displayed the leftmost and
875 rightmost on the screen. */
876 struct text_pos minpos
, maxpos
;
878 /* Non-zero means the overlay arrow bitmap is on this line.
879 -1 means use default overlay arrow bitmap, else
880 it specifies actual fringe bitmap number. */
881 int overlay_arrow_bitmap
;
883 /* Left fringe bitmap number (enum fringe_bitmap_type). */
884 unsigned left_user_fringe_bitmap
: FRINGE_ID_BITS
;
886 /* Right fringe bitmap number (enum fringe_bitmap_type). */
887 unsigned right_user_fringe_bitmap
: FRINGE_ID_BITS
;
889 /* Left fringe bitmap number (enum fringe_bitmap_type). */
890 unsigned left_fringe_bitmap
: FRINGE_ID_BITS
;
892 /* Right fringe bitmap number (enum fringe_bitmap_type). */
893 unsigned right_fringe_bitmap
: FRINGE_ID_BITS
;
895 /* Face of the left fringe glyph. */
896 unsigned left_user_fringe_face_id
: FACE_ID_BITS
;
898 /* Face of the right fringe glyph. */
899 unsigned right_user_fringe_face_id
: FACE_ID_BITS
;
901 /* Face of the left fringe glyph. */
902 unsigned left_fringe_face_id
: FACE_ID_BITS
;
904 /* Face of the right fringe glyph. */
905 unsigned right_fringe_face_id
: FACE_ID_BITS
;
907 /* Vertical offset of the left fringe bitmap. */
908 signed left_fringe_offset
: FRINGE_HEIGHT_BITS
;
910 /* Vertical offset of the right fringe bitmap. */
911 signed right_fringe_offset
: FRINGE_HEIGHT_BITS
;
913 /* 1 means that at least one of the left and right fringe bitmaps is
914 periodic and thus depends on the y-position of the row. */
915 unsigned fringe_bitmap_periodic_p
: 1;
917 /* 1 means that we must draw the bitmaps of this row. */
918 unsigned redraw_fringe_bitmaps_p
: 1;
920 /* In a desired matrix, 1 means that this row must be updated. In a
921 current matrix, 0 means that the row has been invalidated, i.e.
922 the row's contents do not agree with what is visible on the
924 unsigned enabled_p
: 1;
926 /* 1 means row displays a text line that is truncated on the left or
928 unsigned truncated_on_left_p
: 1;
929 unsigned truncated_on_right_p
: 1;
931 /* 1 means that this row displays a continued line, i.e. it has a
932 continuation mark at the right side. */
933 unsigned continued_p
: 1;
935 /* 0 means that this row does not contain any text, i.e. it is
936 a blank line at the window and buffer end. */
937 unsigned displays_text_p
: 1;
939 /* 1 means that this line ends at ZV. */
940 unsigned ends_at_zv_p
: 1;
942 /* 1 means the face of the last glyph in the text area is drawn to
943 the right end of the window. This flag is used in
944 update_text_area to optimize clearing to the end of the area. */
945 unsigned fill_line_p
: 1;
947 /* Non-zero means display a bitmap on X frames indicating that this
948 line contains no text and ends in ZV. */
949 unsigned indicate_empty_line_p
: 1;
951 /* 1 means this row contains glyphs that overlap each other because
952 of lbearing or rbearing. */
953 unsigned contains_overlapping_glyphs_p
: 1;
955 /* 1 means this row is as wide as the window it is displayed in, including
956 scroll bars, fringes, and internal borders. This also
957 implies that the row doesn't have marginal areas. */
958 unsigned full_width_p
: 1;
960 /* Non-zero means row is a mode or header-line. */
961 unsigned mode_line_p
: 1;
963 /* 1 in a current row means this row is overlapped by another row. */
964 unsigned overlapped_p
: 1;
966 /* 1 means this line ends in the middle of a character consisting
967 of more than one glyph. Some glyphs have been put in this row,
968 the rest are put in rows below this one. */
969 unsigned ends_in_middle_of_char_p
: 1;
971 /* 1 means this line starts in the middle of a character consisting
972 of more than one glyph. Some glyphs have been put in the
973 previous row, the rest are put in this row. */
974 unsigned starts_in_middle_of_char_p
: 1;
976 /* 1 in a current row means this row overlaps others. */
977 unsigned overlapping_p
: 1;
979 /* 1 means some glyphs in this row are displayed in mouse-face. */
980 unsigned mouse_face_p
: 1;
982 /* 1 means this row was ended by a newline from a string. */
983 unsigned ends_in_newline_from_string_p
: 1;
985 /* 1 means this row width is exactly the width of the window, and the
986 final newline character is hidden in the right fringe. */
987 unsigned exact_window_width_line_p
: 1;
989 /* 1 means this row currently shows the cursor in the right fringe. */
990 unsigned cursor_in_fringe_p
: 1;
992 /* 1 means the last glyph in the row is part of an ellipsis. */
993 unsigned ends_in_ellipsis_p
: 1;
995 /* Non-zero means display a bitmap on X frames indicating that this
996 the first line of the buffer. */
997 unsigned indicate_bob_p
: 1;
999 /* Non-zero means display a bitmap on X frames indicating that this
1000 the top line of the window, but not start of the buffer. */
1001 unsigned indicate_top_line_p
: 1;
1003 /* Non-zero means display a bitmap on X frames indicating that this
1004 the last line of the buffer. */
1005 unsigned indicate_eob_p
: 1;
1007 /* Non-zero means display a bitmap on X frames indicating that this
1008 the bottom line of the window, but not end of the buffer. */
1009 unsigned indicate_bottom_line_p
: 1;
1011 /* Non-zero means the row was reversed to display text in a
1012 right-to-left paragraph. */
1013 unsigned reversed_p
: 1;
1015 /* Continuation lines width at the start of the row. */
1016 int continuation_lines_width
;
1018 #ifdef HAVE_WINDOW_SYSTEM
1019 /* Non-NULL means the current clipping area. This is temporarily
1020 set while exposing a region. Coordinates are frame-relative. */
1026 /* Get a pointer to row number ROW in matrix MATRIX. If GLYPH_DEBUG
1027 is defined, the function matrix_row checks that we don't try to
1028 access rows that are out of bounds. */
1031 struct glyph_row
*matrix_row (struct glyph_matrix
*, int);
1032 #define MATRIX_ROW(MATRIX, ROW) matrix_row ((MATRIX), (ROW))
1034 #define MATRIX_ROW(MATRIX, ROW) ((MATRIX)->rows + (ROW))
1037 /* Return a pointer to the row reserved for the mode line in MATRIX.
1038 Row MATRIX->nrows - 1 is always reserved for the mode line. */
1040 #define MATRIX_MODE_LINE_ROW(MATRIX) \
1041 ((MATRIX)->rows + (MATRIX)->nrows - 1)
1043 /* Return a pointer to the row reserved for the header line in MATRIX.
1044 This is always the first row in MATRIX because that's the only
1045 way that works in frame-based redisplay. */
1047 #define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows
1049 /* Return a pointer to first row in MATRIX used for text display. */
1051 #define MATRIX_FIRST_TEXT_ROW(MATRIX) \
1052 ((MATRIX)->rows->mode_line_p ? (MATRIX)->rows + 1 : (MATRIX)->rows)
1054 /* Return a pointer to the first glyph in the text area of a row.
1055 MATRIX is the glyph matrix accessed, and ROW is the row index in
1058 #define MATRIX_ROW_GLYPH_START(MATRIX, ROW) \
1059 (MATRIX_ROW ((MATRIX), (ROW))->glyphs[TEXT_AREA])
1061 /* Return the number of used glyphs in the text area of a row. */
1063 #define MATRIX_ROW_USED(MATRIX, ROW) \
1064 (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA])
1066 /* Return the character/ byte position at which the display of ROW
1067 starts. BIDI Note: this is the smallest character/byte position
1068 among characters in ROW, i.e. the first logical-order character
1069 displayed by ROW, which is not necessarily the smallest horizontal
1072 #define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->minpos.charpos)
1073 #define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->minpos.bytepos)
1075 /* Return the character/ byte position at which ROW ends. BIDI Note:
1076 this is the largest character/byte position among characters in
1077 ROW, i.e. the last logical-order character displayed by ROW, which
1078 is not necessarily the largest horizontal position. */
1080 #define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->maxpos.charpos)
1081 #define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->maxpos.bytepos)
1083 /* Return the vertical position of ROW in MATRIX. */
1085 #define MATRIX_ROW_VPOS(ROW, MATRIX) ((ROW) - (MATRIX)->rows)
1087 /* Return the last glyph row + 1 in MATRIX on window W reserved for
1088 text. If W has a mode line, the last row in the matrix is reserved
1091 #define MATRIX_BOTTOM_TEXT_ROW(MATRIX, W) \
1094 - (WINDOW_WANTS_MODELINE_P ((W)) ? 1 : 0))
1096 /* Non-zero if the face of the last glyph in ROW's text area has
1097 to be drawn to the end of the text area. */
1099 #define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)
1101 /* Set and query the enabled_p flag of glyph row ROW in MATRIX. */
1103 #define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
1104 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0)
1106 #define MATRIX_ROW_ENABLED_P(MATRIX, ROW) \
1107 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p)
1109 /* Non-zero if ROW displays text. Value is non-zero if the row is
1110 blank but displays a line end. */
1112 #define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)
1117 #define MR_PARTIALLY_VISIBLE(ROW) \
1118 ((ROW)->height != (ROW)->visible_height)
1120 #define MR_PARTIALLY_VISIBLE_AT_TOP(W, ROW) \
1121 ((ROW)->y < WINDOW_HEADER_LINE_HEIGHT ((W)))
1123 #define MR_PARTIALLY_VISIBLE_AT_BOTTOM(W, ROW) \
1124 (((ROW)->y + (ROW)->height - (ROW)->extra_line_spacing) \
1125 > WINDOW_BOX_HEIGHT_NO_MODE_LINE ((W)))
1127 /* Non-zero if ROW is not completely visible in window W. */
1129 #define MATRIX_ROW_PARTIALLY_VISIBLE_P(W, ROW) \
1130 (MR_PARTIALLY_VISIBLE ((ROW)) \
1131 && (MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)) \
1132 || MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW))))
1136 /* Non-zero if ROW is partially visible at the top of window W. */
1138 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW) \
1139 (MR_PARTIALLY_VISIBLE ((ROW)) \
1140 && MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)))
1142 /* Non-zero if ROW is partially visible at the bottom of window W. */
1144 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW) \
1145 (MR_PARTIALLY_VISIBLE ((ROW)) \
1146 && MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW)))
1148 /* Return the bottom Y + 1 of ROW. */
1150 #define MATRIX_ROW_BOTTOM_Y(ROW) ((ROW)->y + (ROW)->height)
1152 /* Is ROW the last visible one in the display described by the
1153 iterator structure pointed to by IT?. */
1155 #define MATRIX_ROW_LAST_VISIBLE_P(ROW, IT) \
1156 (MATRIX_ROW_BOTTOM_Y ((ROW)) >= (IT)->last_visible_y)
1158 /* Non-zero if ROW displays a continuation line. */
1160 #define MATRIX_ROW_CONTINUATION_LINE_P(ROW) \
1161 ((ROW)->continuation_lines_width > 0)
1163 /* Non-zero if ROW ends in the middle of a character. This is the
1164 case for continued lines showing only part of a display table entry
1165 or a control char, or an overlay string. */
1167 #define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW) \
1168 ((ROW)->end.dpvec_index > 0 \
1169 || (ROW)->end.overlay_string_index >= 0 \
1170 || (ROW)->ends_in_middle_of_char_p)
1172 /* Non-zero if ROW ends in the middle of an overlay string. */
1174 #define MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P(ROW) \
1175 ((ROW)->end.overlay_string_index >= 0)
1177 /* Non-zero if ROW starts in the middle of a character. See above. */
1179 #define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW) \
1180 ((ROW)->start.dpvec_index > 0 \
1181 || (ROW)->starts_in_middle_of_char_p \
1182 || ((ROW)->start.overlay_string_index >= 0 \
1183 && (ROW)->start.string_pos.charpos > 0))
1185 /* Non-zero means ROW overlaps its predecessor. */
1187 #define MATRIX_ROW_OVERLAPS_PRED_P(ROW) \
1188 ((ROW)->phys_ascent > (ROW)->ascent)
1190 /* Non-zero means ROW overlaps its successor. */
1192 #define MATRIX_ROW_OVERLAPS_SUCC_P(ROW) \
1193 ((ROW)->phys_height - (ROW)->phys_ascent \
1194 > (ROW)->height - (ROW)->ascent)
1196 /* A glyph for a space. */
1198 extern struct glyph space_glyph
;
1200 /* Non-zero means last display completed. Zero means it was
1203 extern bool display_completed
;
1207 /************************************************************************
1209 ************************************************************************/
1211 /* Enumeration for overriding/changing the face to use for drawing
1212 glyphs in draw_glyphs. */
1214 enum draw_glyphs_face
1224 #ifdef HAVE_WINDOW_SYSTEM
1226 /* A sequence of glyphs to be drawn in the same face. */
1230 /* X-origin of the string. */
1233 /* Y-origin and y-position of the base line of this string. */
1236 /* The width of the string, not including a face extension. */
1239 /* The width of the string, including a face extension. */
1240 int background_width
;
1242 /* The height of this string. This is the height of the line this
1243 string is drawn in, and can be different from the height of the
1244 font the string is drawn in. */
1247 /* Number of pixels this string overwrites in front of its x-origin.
1248 This number is zero if the string has an lbearing >= 0; it is
1249 -lbearing, if the string has an lbearing < 0. */
1252 /* Number of pixels this string overwrites past its right-most
1253 nominal x-position, i.e. x + width. Zero if the string's
1254 rbearing is <= its nominal width, rbearing - width otherwise. */
1257 /* The frame on which the glyph string is drawn. */
1260 /* The window on which the glyph string is drawn. */
1263 /* X display and window for convenience. */
1267 /* The glyph row for which this string was built. It determines the
1268 y-origin and height of the string. */
1269 struct glyph_row
*row
;
1271 /* The area within row. */
1272 enum glyph_row_area area
;
1274 /* Characters to be drawn, and number of characters. */
1278 /* A face-override for drawing cursors, mouse face and similar. */
1279 enum draw_glyphs_face hl
;
1281 /* Face in which this string is to be drawn. */
1284 /* Font in which this string is to be drawn. */
1287 /* Non-null means this string describes (part of) a static
1289 struct composition
*cmp
;
1291 /* If not negative, this string describes a compos. */
1294 /* Start and end glyph indices in a glyph-string. */
1295 int cmp_from
, cmp_to
;
1297 /* 1 means this glyph strings face has to be drawn to the right end
1298 of the window's drawing area. */
1299 unsigned extends_to_end_of_line_p
: 1;
1301 /* 1 means the background of this string has been drawn. */
1302 unsigned background_filled_p
: 1;
1304 /* 1 means glyph string must be drawn with 16-bit functions. */
1305 unsigned two_byte_p
: 1;
1307 /* 1 means that the original font determined for drawing this glyph
1308 string could not be loaded. The member `font' has been set to
1309 the frame's default font in this case. */
1310 unsigned font_not_found_p
: 1;
1312 /* 1 means that the face in which this glyph string is drawn has a
1314 unsigned stippled_p
: 1;
1316 #define OVERLAPS_PRED (1 << 0)
1317 #define OVERLAPS_SUCC (1 << 1)
1318 #define OVERLAPS_BOTH (OVERLAPS_PRED | OVERLAPS_SUCC)
1319 #define OVERLAPS_ERASED_CURSOR (1 << 2)
1320 /* Non-zero means only the foreground of this glyph string must be
1321 drawn, and we should use the physical height of the line this
1322 glyph string appears in as clip rect. If the value is
1323 OVERLAPS_ERASED_CURSOR, the clip rect is restricted to the rect
1324 of the erased cursor. OVERLAPS_PRED and OVERLAPS_SUCC mean we
1325 draw overlaps with the preceding and the succeeding rows,
1327 unsigned for_overlaps
: 3;
1329 /* 1 means that all glyphs in this glyph string has the flag
1330 padding_p set, and thus must be drawn one by one to have 1-pixel
1331 width even though the logical width in the font is zero. */
1332 unsigned padding_p
: 1;
1334 /* The GC to use for drawing this glyph string. */
1335 #if defined (HAVE_X_WINDOWS)
1338 #if defined (HAVE_NTGUI)
1343 /* A pointer to the first glyph in the string. This glyph
1344 corresponds to char2b[0]. Needed to draw rectangles if
1345 font_not_found_p is 1. */
1346 struct glyph
*first_glyph
;
1348 /* Image, if any. */
1352 struct glyph_slice slice
;
1354 /* Non-null means the horizontal clipping region starts from the
1355 left edge of *clip_head, and ends with the right edge of
1356 *clip_tail, not including their overhangs. */
1357 struct glyph_string
*clip_head
, *clip_tail
;
1359 /* The current clipping areas. */
1360 NativeRectangle clip
[2];
1362 /* Number of clipping areas. */
1365 int underline_position
;
1367 int underline_thickness
;
1369 struct glyph_string
*next
, *prev
;
1372 #endif /* HAVE_WINDOW_SYSTEM */
1375 /************************************************************************
1377 ************************************************************************/
1379 /* Return the height of the mode line in glyph matrix MATRIX, or zero
1380 if not known. This macro is called under circumstances where
1381 MATRIX might not have been allocated yet. */
1383 #define MATRIX_MODE_LINE_HEIGHT(MATRIX) \
1384 ((MATRIX) && (MATRIX)->rows \
1385 ? MATRIX_MODE_LINE_ROW (MATRIX)->height \
1388 /* Return the height of the header line in glyph matrix MATRIX, or zero
1389 if not known. This macro is called under circumstances where
1390 MATRIX might not have been allocated yet. */
1392 #define MATRIX_HEADER_LINE_HEIGHT(MATRIX) \
1393 ((MATRIX) && (MATRIX)->rows \
1394 ? MATRIX_HEADER_LINE_ROW (MATRIX)->height \
1397 /* Return the desired face id for the mode line of a window, depending
1398 on whether the window is selected or not, or if the window is the
1399 scrolling window for the currently active minibuffer window.
1401 Due to the way display_mode_lines manipulates with the contents of
1402 selected_window, this macro needs three arguments: SELW which is
1403 compared against the current value of selected_window, MBW which is
1404 compared against minibuf_window (if SELW doesn't match), and SCRW
1405 which is compared against minibuf_selected_window (if MBW matches). */
1407 #define CURRENT_MODE_LINE_FACE_ID_3(SELW, MBW, SCRW) \
1408 ((!mode_line_in_non_selected_windows \
1409 || (SELW) == XWINDOW (selected_window) \
1410 || (minibuf_level > 0 \
1411 && !NILP (minibuf_selected_window) \
1412 && (MBW) == XWINDOW (minibuf_window) \
1413 && (SCRW) == XWINDOW (minibuf_selected_window))) \
1414 ? MODE_LINE_FACE_ID \
1415 : MODE_LINE_INACTIVE_FACE_ID)
1418 /* Return the desired face id for the mode line of window W. */
1420 #define CURRENT_MODE_LINE_FACE_ID(W) \
1421 (CURRENT_MODE_LINE_FACE_ID_3((W), XWINDOW (selected_window), (W)))
1423 /* Return the current height of the mode line of window W. If not known
1424 from W->mode_line_height, look at W's current glyph matrix, or return
1425 a default based on the height of the font of the face `mode-line'. */
1427 #define CURRENT_MODE_LINE_HEIGHT(W) \
1428 (W->mode_line_height >= 0 \
1429 ? W->mode_line_height \
1430 : (W->mode_line_height \
1431 = (MATRIX_MODE_LINE_HEIGHT (W->current_matrix) \
1432 ? MATRIX_MODE_LINE_HEIGHT (W->current_matrix) \
1433 : estimate_mode_line_height \
1434 (XFRAME (W->frame), CURRENT_MODE_LINE_FACE_ID (W)))))
1436 /* Return the current height of the header line of window W. If not known
1437 from W->header_line_height, look at W's current glyph matrix, or return
1438 an estimation based on the height of the font of the face `header-line'. */
1440 #define CURRENT_HEADER_LINE_HEIGHT(W) \
1441 (W->header_line_height >= 0 \
1442 ? W->header_line_height \
1443 : (W->header_line_height \
1444 = (MATRIX_HEADER_LINE_HEIGHT (W->current_matrix) \
1445 ? MATRIX_HEADER_LINE_HEIGHT (W->current_matrix) \
1446 : estimate_mode_line_height \
1447 (XFRAME (W->frame), HEADER_LINE_FACE_ID))))
1449 /* Return the height of the desired mode line of window W. */
1451 #define DESIRED_MODE_LINE_HEIGHT(W) \
1452 MATRIX_MODE_LINE_HEIGHT ((W)->desired_matrix)
1454 /* Return the height of the desired header line of window W. */
1456 #define DESIRED_HEADER_LINE_HEIGHT(W) \
1457 MATRIX_HEADER_LINE_HEIGHT ((W)->desired_matrix)
1459 /* Value is non-zero if window W wants a mode line. */
1461 #define WINDOW_WANTS_MODELINE_P(W) \
1462 (!MINI_WINDOW_P ((W)) \
1463 && !(W)->pseudo_window_p \
1464 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1465 && BUFFERP ((W)->contents) \
1466 && !NILP (BVAR (XBUFFER ((W)->contents), mode_line_format)) \
1467 && WINDOW_TOTAL_LINES (W) > 1)
1469 /* Value is true if window W wants a header line. */
1471 #define WINDOW_WANTS_HEADER_LINE_P(W) \
1472 (BUFFERP ((W)->contents) \
1473 ? (!MINI_WINDOW_P ((W)) \
1474 && !(W)->pseudo_window_p \
1475 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1476 && !NILP (BVAR (XBUFFER ((W)->contents), header_line_format)) \
1477 && WINDOW_TOTAL_LINES (W) > \
1478 (1 + !NILP (BVAR (XBUFFER ((W)->contents), mode_line_format)))) \
1481 /* Return proper value to be used as baseline offset of font that has
1482 ASCENT and DESCENT to draw characters by the font at the vertical
1483 center of the line of frame F.
1485 Here, our task is to find the value of BOFF in the following figure;
1487 -------------------------+-----------+-
1488 -+-+---------+-+ | |
1490 | | | | F_ASCENT F_HEIGHT
1493 | | |-|-+------+-----------|------- baseline
1495 | |---------|-+-+ | |
1497 -+-+---------+-+ F_DESCENT |
1498 -------------------------+-----------+-
1500 -BOFF + DESCENT + (F_HEIGHT - HEIGHT) / 2 = F_DESCENT
1501 BOFF = DESCENT + (F_HEIGHT - HEIGHT) / 2 - F_DESCENT
1502 DESCENT = FONT->descent
1503 HEIGHT = FONT_HEIGHT (FONT)
1504 F_DESCENT = (FRAME_FONT (F)->descent
1505 - F->terminal->output_data.x->baseline_offset)
1506 F_HEIGHT = FRAME_LINE_HEIGHT (F)
1509 #define VCENTER_BASELINE_OFFSET(FONT, F) \
1510 (FONT_DESCENT (FONT) \
1511 + (FRAME_LINE_HEIGHT ((F)) - FONT_HEIGHT ((FONT)) \
1512 + (FRAME_LINE_HEIGHT ((F)) > FONT_HEIGHT ((FONT)))) / 2 \
1513 - (FONT_DESCENT (FRAME_FONT (F)) - FRAME_BASELINE_OFFSET (F)))
1516 /***********************************************************************
1518 ***********************************************************************/
1520 /* Indices of face attributes in Lisp face vectors. Slot zero is the
1523 enum lface_attribute_index
1525 LFACE_FAMILY_INDEX
= 1,
1526 LFACE_FOUNDRY_INDEX
,
1531 LFACE_UNDERLINE_INDEX
,
1532 LFACE_INVERSE_INDEX
,
1533 LFACE_FOREGROUND_INDEX
,
1534 LFACE_BACKGROUND_INDEX
,
1535 LFACE_STIPPLE_INDEX
,
1536 LFACE_OVERLINE_INDEX
,
1537 LFACE_STRIKE_THROUGH_INDEX
,
1540 LFACE_INHERIT_INDEX
,
1541 LFACE_FONTSET_INDEX
,
1546 /* Box types of faces. */
1550 /* No box around text. */
1553 /* Simple box of specified width and color. Default width is 1, and
1554 default color is the foreground color of the face. */
1557 /* Boxes with 3D shadows. Color equals the background color of the
1558 face. Width is specified. */
1563 /* Underline type. */
1565 enum face_underline_type
1571 /* Structure describing a realized face.
1573 For each Lisp face, 0..N realized faces can exist for different
1574 frames and different charsets. Realized faces are built from Lisp
1575 faces and text properties/overlays by merging faces and adding
1576 unspecified attributes from the `default' face. */
1580 /* The id of this face. The id equals the index of this face in the
1581 vector faces_by_id of its face cache. */
1584 #ifdef HAVE_WINDOW_SYSTEM
1586 /* If non-zero, this is a GC that we can use without modification for
1587 drawing the characters in this face. */
1590 /* Background stipple or bitmap used for this face. This is
1591 an id as returned from load_pixmap. */
1594 #else /* not HAVE_WINDOW_SYSTEM */
1599 #endif /* not HAVE_WINDOW_SYSTEM */
1601 /* Pixel value of foreground color for X frames. Color index
1603 unsigned long foreground
;
1605 /* Pixel value or color index of background color. */
1606 unsigned long background
;
1608 /* Pixel value or color index of underline color. */
1609 unsigned long underline_color
;
1611 /* Pixel value or color index of overlined, strike-through, or box
1613 unsigned long overline_color
;
1614 unsigned long strike_through_color
;
1615 unsigned long box_color
;
1619 /* Fontset ID if for this face's fontset. Non-ASCII faces derived
1620 from the same ASCII face have the same fontset. */
1623 /* Pixmap width and height. */
1624 unsigned int pixmap_w
, pixmap_h
;
1626 /* Non-zero means characters in this face have a box of that
1627 thickness around them. If this value is negative, its absolute
1628 value indicates the thickness, and the horizontal (top and
1629 bottom) borders of box are drawn inside of the character glyphs'
1630 area. The vertical (left and right) borders of the box are drawn
1631 in the same way as when this value is positive. */
1634 /* Type of box drawn. A value of FACE_NO_BOX means no box is drawn
1635 around text in this face. A value of FACE_SIMPLE_BOX means a box
1636 of width box_line_width is drawn in color box_color. A value of
1637 FACE_RAISED_BOX or FACE_SUNKEN_BOX means a 3D box is drawn with
1638 shadow colors derived from the background color of the face. */
1639 enum face_box_type box
;
1641 /* Style of underlining. */
1642 enum face_underline_type underline_type
;
1644 /* If `box' above specifies a 3D type, 1 means use box_color for
1646 unsigned use_box_color_for_shadows_p
: 1;
1648 /* Non-zero if text in this face should be underlined, overlined,
1649 strike-through or have a box drawn around it. */
1650 unsigned underline_p
: 1;
1651 unsigned overline_p
: 1;
1652 unsigned strike_through_p
: 1;
1654 /* 1 means that the colors specified for this face could not be
1655 loaded, and were replaced by default colors, so they shouldn't be
1657 unsigned foreground_defaulted_p
: 1;
1658 unsigned background_defaulted_p
: 1;
1660 /* 1 means that either no color is specified for underlining or that
1661 the specified color couldn't be loaded. Use the foreground
1662 color when drawing in that case. */
1663 unsigned underline_defaulted_p
: 1;
1665 /* 1 means that either no color is specified for the corresponding
1666 attribute or that the specified color couldn't be loaded.
1667 Use the foreground color when drawing in that case. */
1668 unsigned overline_color_defaulted_p
: 1;
1669 unsigned strike_through_color_defaulted_p
: 1;
1670 unsigned box_color_defaulted_p
: 1;
1672 /* TTY appearances. Colors are found in `lface' with empty color
1673 string meaning the default color of the TTY. */
1674 unsigned tty_bold_p
: 1;
1675 unsigned tty_italic_p
: 1;
1676 unsigned tty_underline_p
: 1;
1677 unsigned tty_reverse_p
: 1;
1679 /* 1 means that colors of this face may not be freed because they
1680 have been copied bitwise from a base face (see
1682 unsigned colors_copied_bitwise_p
: 1;
1684 /* If non-zero, use overstrike (to simulate bold-face). */
1685 unsigned overstrike
: 1;
1687 /* NOTE: this is not used yet, but eventually this impl should be done
1688 similarly to overstrike */
1690 /* If non-zero, use geometric rotation (to simulate italic). */
1691 unsigned synth_ital
: 1;
1694 /* The Lisp face attributes this face realizes. All attributes
1695 in this vector are non-nil. */
1696 Lisp_Object lface
[LFACE_VECTOR_SIZE
];
1698 /* The hash value of this face. */
1701 /* Next and previous face in hash collision list of face cache. */
1702 struct face
*next
, *prev
;
1704 /* If this face is an ASCII face, this points to this face itself.
1705 Otherwise, this points to an ASCII face that has the same
1706 attributes except the font. */
1707 struct face
*ascii_face
;
1709 /* Extra member that a font-driver uses privately. */
1714 /* Color index indicating that face uses a terminal's default color. */
1716 #define FACE_TTY_DEFAULT_COLOR ((unsigned long) -1)
1718 /* Color index indicating that face uses an unknown foreground color. */
1720 #define FACE_TTY_DEFAULT_FG_COLOR ((unsigned long) -2)
1722 /* Color index indicating that face uses an unknown background color. */
1724 #define FACE_TTY_DEFAULT_BG_COLOR ((unsigned long) -3)
1726 /* Non-zero if FACE was realized for unibyte use. */
1728 #define FACE_UNIBYTE_P(FACE) ((FACE)->charset < 0)
1731 /* IDs of important faces known by the C face code. These are the IDs
1732 of the faces for CHARSET_ASCII. */
1738 MODE_LINE_INACTIVE_FACE_ID
,
1741 HEADER_LINE_FACE_ID
,
1747 VERTICAL_BORDER_FACE_ID
,
1748 BASIC_FACE_ID_SENTINEL
1751 #define MAX_FACE_ID ((1 << FACE_ID_BITS) - 1)
1753 /* A cache of realized faces. Each frame has its own cache because
1754 Emacs allows different frame-local face definitions. */
1758 /* Hash table of cached realized faces. */
1759 struct face
**buckets
;
1761 /* Back-pointer to the frame this cache belongs to. */
1764 /* A vector of faces so that faces can be referenced by an ID. */
1765 struct face
**faces_by_id
;
1767 /* The allocated size, and number of used slots of faces_by_id. */
1771 /* Flag indicating that attributes of the `menu' face have been
1773 unsigned menu_face_changed_p
: 1;
1777 /* Prepare face FACE for use on frame F. This must be called before
1778 using X resources of FACE. */
1780 #define PREPARE_FACE_FOR_DISPLAY(F, FACE) \
1781 if ((FACE)->gc == 0) \
1782 prepare_face_for_display ((F), (FACE)); \
1786 /* Return a pointer to the face with ID on frame F, or null if such a
1787 face doesn't exist. */
1789 #define FACE_FROM_ID(F, ID) \
1790 (UNSIGNED_CMP (ID, <, FRAME_FACE_CACHE (F)->used) \
1791 ? FRAME_FACE_CACHE (F)->faces_by_id[ID] \
1794 #ifdef HAVE_WINDOW_SYSTEM
1796 /* Non-zero if FACE is suitable for displaying character CHAR. */
1798 #define FACE_SUITABLE_FOR_ASCII_CHAR_P(FACE, CHAR) \
1799 ((FACE) == (FACE)->ascii_face)
1801 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) \
1802 (ASCII_CHAR_P (CHAR) \
1803 ? FACE_SUITABLE_FOR_ASCII_CHAR_P(FACE) \
1804 : face_suitable_for_char_p ((FACE), (CHAR)))
1806 /* Return the id of the realized face on frame F that is like the face
1807 with id ID but is suitable for displaying character CHAR.
1808 This macro is only meaningful for multibyte character CHAR. */
1810 #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) \
1811 ((ASCII_CHAR_P (CHAR) || CHAR_BYTE8_P (CHAR)) \
1812 ? (FACE)->ascii_face->id \
1813 : face_for_char ((F), (FACE), (CHAR), (POS), (OBJECT)))
1815 #else /* not HAVE_WINDOW_SYSTEM */
1817 #define FACE_SUITABLE_FOR_ASCII_CHAR_P(FACE, CHAR) 1
1818 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) 1
1819 #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) ((FACE)->id)
1821 #endif /* not HAVE_WINDOW_SYSTEM */
1823 /* Return true if G contains a valid character code. */
1825 GLYPH_CHAR_VALID_P (GLYPH g
)
1827 return CHAR_VALID_P (GLYPH_CHAR (g
));
1830 /* The glyph code from a display vector may either be an integer which
1831 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1832 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1835 GLYPH_CODE_P (Lisp_Object gc
)
1838 ? (CHARACTERP (XCAR (gc
))
1839 && RANGED_INTEGERP (0, XCDR (gc
), MAX_FACE_ID
))
1842 (MAX_FACE_ID
< TYPE_MAXIMUM (EMACS_INT
) >> CHARACTERBITS
1843 ? ((EMACS_INT
) MAX_FACE_ID
<< CHARACTERBITS
) | MAX_CHAR
1844 : TYPE_MAXIMUM (EMACS_INT
)))));
1847 /* Non-zero means face attributes have been changed since the last
1848 redisplay. Used in redisplay_internal. */
1850 extern int face_change_count
;
1852 /* For reordering of bidirectional text. */
1853 #define BIDI_MAXLEVEL 64
1855 /* Data type for describing the bidirectional character types. The
1856 first 7 must be at the beginning, because they are the only values
1857 valid in the `bidi_type' member of `struct glyph'; we only reserve
1858 3 bits for it, so we cannot use there values larger than 7.
1860 The order of members must be in sync with the 8th element of the
1861 member of unidata-prop-alist (in admin/unidata/unidata-gen.el) for
1862 Unicode character property `bidi-class'. */
1865 STRONG_L
, /* strong left-to-right */
1866 STRONG_R
, /* strong right-to-left */
1867 WEAK_EN
, /* european number */
1868 WEAK_AN
, /* arabic number */
1869 WEAK_BN
, /* boundary neutral */
1870 NEUTRAL_B
, /* paragraph separator */
1871 STRONG_AL
, /* arabic right-to-left letter */
1872 LRE
, /* left-to-right embedding */
1873 LRO
, /* left-to-right override */
1874 RLE
, /* right-to-left embedding */
1875 RLO
, /* right-to-left override */
1876 PDF
, /* pop directional format */
1877 WEAK_ES
, /* european number separator */
1878 WEAK_ET
, /* european number terminator */
1879 WEAK_CS
, /* common separator */
1880 WEAK_NSM
, /* non-spacing mark */
1881 NEUTRAL_S
, /* segment separator */
1882 NEUTRAL_WS
, /* whitespace */
1883 NEUTRAL_ON
/* other neutrals */
1886 /* The basic directionality data type. */
1887 typedef enum { NEUTRAL_DIR
, L2R
, R2L
} bidi_dir_t
;
1889 /* Data type for storing information about characters we need to
1891 struct bidi_saved_info
{
1892 ptrdiff_t bytepos
, charpos
; /* character's buffer position */
1893 bidi_type_t type
; /* character's resolved bidi type */
1894 bidi_type_t type_after_w1
; /* original type of the character, after W1 */
1895 bidi_type_t orig_type
; /* type as we found it in the buffer */
1898 /* Data type for keeping track of saved embedding levels and override
1899 status information. */
1902 bidi_dir_t override
;
1905 /* Data type for storing information about a string being iterated on. */
1906 struct bidi_string_data
{
1907 Lisp_Object lstring
; /* Lisp string to reorder, or nil */
1908 const unsigned char *s
; /* string data, or NULL if reordering buffer */
1909 ptrdiff_t schars
; /* the number of characters in the string,
1910 excluding the terminating null */
1911 ptrdiff_t bufpos
; /* buffer position of lstring, or 0 if N/A */
1912 unsigned from_disp_str
: 1; /* 1 means the string comes from a
1914 unsigned unibyte
: 1; /* 1 means the string is unibyte */
1917 /* Data type for reordering bidirectional text. */
1919 ptrdiff_t bytepos
; /* iterator's position in buffer/string */
1921 int ch
; /* character at that position, or u+FFFC
1922 ("object replacement character") for a run
1923 of characters covered by a display string */
1924 ptrdiff_t nchars
; /* its "length", usually 1; it's > 1 for a run
1925 of characters covered by a display string */
1926 ptrdiff_t ch_len
; /* its length in bytes */
1927 bidi_type_t type
; /* bidi type of this character, after
1928 resolving weak and neutral types */
1929 bidi_type_t type_after_w1
; /* original type, after overrides and W1 */
1930 bidi_type_t orig_type
; /* original type, as found in the buffer */
1931 int resolved_level
; /* final resolved level of this character */
1932 int invalid_levels
; /* how many PDFs to ignore */
1933 int invalid_rl_levels
; /* how many PDFs from RLE/RLO to ignore */
1934 struct bidi_saved_info prev
; /* info about previous character */
1935 struct bidi_saved_info last_strong
; /* last-seen strong directional char */
1936 struct bidi_saved_info next_for_neutral
; /* surrounding characters for... */
1937 struct bidi_saved_info prev_for_neutral
; /* ...resolving neutrals */
1938 struct bidi_saved_info next_for_ws
; /* character after sequence of ws */
1939 ptrdiff_t next_en_pos
; /* pos. of next char for determining ET type */
1940 bidi_type_t next_en_type
; /* type of char at next_en_pos */
1941 ptrdiff_t ignore_bn_limit
; /* position until which to ignore BNs */
1942 bidi_dir_t sor
; /* direction of start-of-run in effect */
1943 int scan_dir
; /* direction of text scan, 1: forw, -1: back */
1944 ptrdiff_t disp_pos
; /* position of display string after ch */
1945 int disp_prop
; /* if non-zero, there really is a
1946 `display' property/string at disp_pos;
1947 if 2, the property is a `space' spec */
1948 int stack_idx
; /* index of current data on the stack */
1949 /* Note: Everything from here on is not copied/saved when the bidi
1950 iterator state is saved, pushed, or popped. So only put here
1951 stuff that is not part of the bidi iterator's state! */
1952 struct bidi_stack level_stack
[BIDI_MAXLEVEL
]; /* stack of embedding levels */
1953 struct bidi_string_data string
; /* string to reorder */
1954 struct window
*w
; /* the window being displayed */
1955 bidi_dir_t paragraph_dir
; /* current paragraph direction */
1956 ptrdiff_t separator_limit
; /* where paragraph separator should end */
1957 unsigned prev_was_pdf
: 1; /* if non-zero, previous char was PDF */
1958 unsigned first_elt
: 1; /* if non-zero, examine current char first */
1959 unsigned new_paragraph
: 1; /* if non-zero, we expect a new paragraph */
1960 unsigned frame_window_p
: 1; /* non-zero if displaying on a GUI frame */
1963 /* Value is non-zero when the bidi iterator is at base paragraph
1965 #define BIDI_AT_BASE_LEVEL(BIDI_IT) \
1966 ((BIDI_IT).resolved_level == (BIDI_IT).level_stack[0].level)
1969 /***********************************************************************
1971 ***********************************************************************/
1973 /* Structure used to describe where and how to draw a fringe bitmap.
1974 WHICH is the fringe bitmap to draw. WD and H is the (adjusted)
1975 width and height of the bitmap, DH is the height adjustment (if
1976 bitmap is periodic). X and Y are frame coordinates of the area to
1977 display the bitmap, DY is relative offset of the bitmap into that
1978 area. BX, NX, BY, NY specifies the area to clear if the bitmap
1979 does not fill the entire area. FACE is the fringe face. */
1981 struct draw_fringe_bitmap_params
1983 int which
; /* enum fringe_bitmap_type */
1984 unsigned short *bits
;
1988 unsigned cursor_p
: 1;
1989 unsigned overlay_p
: 1;
1993 #define MAX_FRINGE_BITMAPS (1<<FRINGE_ID_BITS)
1996 /***********************************************************************
1998 ***********************************************************************/
2000 /* Iteration over things to display in current_buffer or in a string.
2002 The iterator handles:
2004 1. Overlay strings (after-string, before-string).
2006 3. Invisible text properties.
2007 4. Selective display.
2008 5. Translation of characters via display tables.
2009 6. Translation of control characters to the forms `\003' or `^C'.
2010 7. `glyph' and `space-width' properties.
2012 Iterators are initialized by calling init_iterator or one of the
2013 equivalent functions below. A call to get_next_display_element
2014 loads the iterator structure with information about what next to
2015 display. A call to set_iterator_to_next increments the iterator's
2018 Characters from overlay strings, display table entries or control
2019 character translations are returned one at a time. For example, if
2020 we have a text of `a\x01' where `a' has a display table definition
2021 of `cd' and the control character is displayed with a leading
2022 arrow, then the iterator will return:
2024 Call Return Source Call next
2025 -----------------------------------------------------------------
2026 next c display table move
2027 next d display table move
2028 next ^ control char move
2029 next A control char move
2031 The same mechanism is also used to return characters for ellipses
2032 displayed at the end of invisible text.
2034 CAVEAT: Under some circumstances, move_.* functions can be called
2035 asynchronously, e.g. when computing a buffer position from an x and
2036 y pixel position. This means that these functions and functions
2037 called from them SHOULD NOT USE xmalloc and alike. See also the
2038 comment at the start of xdisp.c. */
2040 /* Enumeration describing what kind of display element an iterator is
2041 loaded with after a call to get_next_display_element. */
2043 enum display_element_type
2045 /* A normal character. */
2048 /* A composition (static and automatic). */
2051 /* A glyphless character (e.g. ZWNJ, LRE). */
2057 /* A flexible width and height space. */
2060 /* End of buffer or string. */
2063 /* Truncation glyphs. Never returned by get_next_display_element.
2064 Used to get display information about truncation glyphs via
2068 /* Continuation glyphs. See the comment for IT_TRUNCATION. */
2073 /* An enumerator for each text property that has a meaning for display
2082 COMPOSITION_PROP_IDX
,
2084 /* Not a property. Used to indicate changes in overlays. */
2091 /* An enumerator for the method of wrapping long lines. */
2093 enum line_wrap_method
2100 /* An enumerator for the method of displaying glyphless characters. */
2102 enum glyphless_display_method
2104 /* Display a thin (1-pixel width) space. On a TTY, display a
2105 1-character width space. */
2106 GLYPHLESS_DISPLAY_THIN_SPACE
,
2107 /* Display an empty box of proper width. */
2108 GLYPHLESS_DISPLAY_EMPTY_BOX
,
2109 /* Display an acronym string in a box. */
2110 GLYPHLESS_DISPLAY_ACRONYM
,
2111 /* Display the hexadecimal code of the character in a box. */
2112 GLYPHLESS_DISPLAY_HEX_CODE
2123 /* Input sources for fetching characters or data to display.
2124 The input source is found in the `method' field. */
2127 GET_FROM_BUFFER
= 0,
2128 GET_FROM_DISPLAY_VECTOR
,
2136 /* FIXME: What is this? Why 5? */
2137 #define IT_STACK_SIZE 5
2139 /* Iterator for composition (both for static and automatic). */
2140 struct composition_it
2142 /* Next position at which to check the composition. */
2144 /* ID number of the composition or glyph-string. If negative, we
2145 are not iterating over a composition now. */
2147 /* If non-negative, character that triggers the automatic
2148 composition at `stop_pos', and this is an automatic composition.
2149 If negative, this is a static composition. This is set to -2
2150 temporarily if searching of composition reach a limit or a
2153 /* If this is an automatic composition, index of a rule for making
2154 the automatic composition. Provided that ELT is an element of
2155 Vcomposition_function_table for CH, (nth ELT RULE_IDX) is the
2156 rule for the composition. */
2158 /* If this is an automatic composition, how many characters to look
2159 back from the position where a character triggering the
2160 composition exists. */
2162 /* If non-negative, number of glyphs of the glyph-string. */
2164 /* True iff the composition is created while buffer is scanned in
2165 reverse order, and thus the grapheme clusters must be rendered
2166 from the last to the first. */
2169 /** The following members contain information about the current
2170 grapheme cluster. */
2171 /* Position of the first character of the current grapheme cluster. */
2173 /* Number of characters and bytes of the current grapheme cluster. */
2175 /* Indices of the glyphs for the current grapheme cluster. */
2177 /* Width of the current grapheme cluster in units of pixels on a
2178 graphic display and in units of canonical characters on a
2179 terminal display. */
2185 /* The window in which we iterate over current_buffer (or a string). */
2189 /* The window's frame. */
2192 /* Method to use to load this structure with the next display element. */
2193 enum it_method method
;
2195 /* The next position at which to check for face changes, invisible
2196 text, overlay strings, end of text etc., which see. */
2197 ptrdiff_t stop_charpos
;
2199 /* Previous stop position, i.e. the last one before the current
2200 iterator position in `current'. */
2201 ptrdiff_t prev_stop
;
2203 /* Last stop position iterated across whose bidi embedding level is
2204 equal to the current paragraph's base embedding level. */
2205 ptrdiff_t base_level_stop
;
2207 /* Maximum string or buffer position + 1. ZV when iterating over
2209 ptrdiff_t end_charpos
;
2211 /* C string to iterate over. Non-null means get characters from
2212 this string, otherwise characters are read from current_buffer
2214 const unsigned char *s
;
2216 /* Number of characters in the string (s, or it->string) we iterate
2217 over. Used only in display_string and its subroutines; never
2218 used for overlay strings and strings from display properties. */
2219 ptrdiff_t string_nchars
;
2221 /* Start and end of a visible region; -1 if the region is not
2222 visible in the window. */
2223 ptrdiff_t region_beg_charpos
, region_end_charpos
;
2225 /* Position at which redisplay end trigger functions should be run. */
2226 ptrdiff_t redisplay_end_trigger_charpos
;
2228 /* 1 means multibyte characters are enabled. */
2229 unsigned multibyte_p
: 1;
2231 /* 1 means window has a mode line at its top. */
2232 unsigned header_line_p
: 1;
2234 /* 1 means `string' is the value of a `display' property.
2235 Don't handle some `display' properties in these strings. */
2236 unsigned string_from_display_prop_p
: 1;
2238 /* 1 means `string' comes from a `line-prefix' or `wrap-prefix'
2240 unsigned string_from_prefix_prop_p
: 1;
2242 /* 1 means we are iterating an object that came from a value of a
2243 `display' property. */
2244 unsigned from_disp_prop_p
: 1;
2246 /* When METHOD == next_element_from_display_vector,
2247 this is 1 if we're doing an ellipsis. Otherwise meaningless. */
2248 unsigned ellipsis_p
: 1;
2250 /* True means cursor shouldn't be displayed here. */
2251 unsigned avoid_cursor_p
: 1;
2253 /* Display table in effect or null for none. */
2254 struct Lisp_Char_Table
*dp
;
2256 /* Current display table vector to return characters from and its
2257 end. dpvec null means we are not returning characters from a
2258 display table entry; current.dpvec_index gives the current index
2259 into dpvec. This same mechanism is also used to return
2260 characters from translated control characters, i.e. `\003' or
2262 Lisp_Object
*dpvec
, *dpend
;
2264 /* Length in bytes of the char that filled dpvec. A value of zero
2265 means that no such character is involved. A negative value means
2266 the rest of the line from the current iterator position onwards
2267 is hidden by selective display or ellipsis. */
2270 /* Face id to use for all characters in display vector. -1 if unused. */
2273 /* Face id of the iterator saved in case a glyph from dpvec contains
2274 a face. The face is restored when all glyphs from dpvec have
2278 /* Vector of glyphs for control character translation. The pointer
2279 dpvec is set to ctl_chars when a control character is translated.
2280 This vector is also used for incomplete multibyte character
2281 translation (e.g \222\244). Such a character is at most 4 bytes,
2282 thus we need at most 16 bytes here. */
2283 Lisp_Object ctl_chars
[16];
2285 /* Initial buffer or string position of the iterator, before skipping
2286 over display properties and invisible text. */
2287 struct display_pos start
;
2289 /* Current buffer or string position of the iterator, including
2290 position in overlay strings etc. */
2291 struct display_pos current
;
2293 /* Total number of overlay strings to process. This can be >
2294 OVERLAY_STRING_CHUNK_SIZE. Value is dependable only when
2295 current.overlay_string_index >= 0. Use the latter to determine
2296 whether an overlay string is being iterated over, because
2297 n_overlay_strings can be positive even when we are not rendering
2298 an overlay string. */
2299 ptrdiff_t n_overlay_strings
;
2301 /* The charpos where n_overlay_strings was calculated. This should
2302 be set at the same time as n_overlay_strings. It is needed
2303 because we show before-strings at the start of invisible text;
2304 see handle_invisible_prop in xdisp.c. */
2305 ptrdiff_t overlay_strings_charpos
;
2307 /* Vector of overlays to process. Overlay strings are processed
2308 OVERLAY_STRING_CHUNK_SIZE at a time. */
2309 #define OVERLAY_STRING_CHUNK_SIZE 16
2310 Lisp_Object overlay_strings
[OVERLAY_STRING_CHUNK_SIZE
];
2312 /* For each overlay string, the overlay it came from. */
2313 Lisp_Object string_overlays
[OVERLAY_STRING_CHUNK_SIZE
];
2315 /* If non-nil, a Lisp string being processed. If
2316 current.overlay_string_index >= 0, this is an overlay string from
2317 pos. Use STRINGP (it.string) to test whether we are rendering a
2318 string or something else; do NOT use BUFFERP (it.object). */
2321 /* If non-nil, we are processing a string that came
2322 from a `display' property given by an overlay. */
2323 Lisp_Object from_overlay
;
2325 /* Stack of saved values. New entries are pushed when we begin to
2326 process an overlay string or a string from a `glyph' property.
2327 Entries are popped when we return to deliver display elements
2328 from what we previously had. */
2329 struct iterator_stack_entry
2333 ptrdiff_t end_charpos
;
2334 ptrdiff_t stop_charpos
;
2335 ptrdiff_t prev_stop
;
2336 ptrdiff_t base_level_stop
;
2337 struct composition_it cmp_it
;
2340 /* Save values specific to a given method. */
2342 /* method == GET_FROM_IMAGE */
2345 struct it_slice slice
;
2348 /* method == GET_FROM_COMPOSITION */
2352 /* method == GET_FROM_STRETCH */
2358 /* current text and display positions. */
2359 struct text_pos position
;
2360 struct display_pos current
;
2361 Lisp_Object from_overlay
;
2362 enum glyph_row_area area
;
2363 enum it_method method
;
2364 bidi_dir_t paragraph_embedding
;
2365 unsigned multibyte_p
: 1;
2366 unsigned string_from_display_prop_p
: 1;
2367 unsigned string_from_prefix_prop_p
: 1;
2368 unsigned display_ellipsis_p
: 1;
2369 unsigned avoid_cursor_p
: 1;
2371 unsigned from_disp_prop_p
: 1;
2372 enum line_wrap_method line_wrap
;
2374 /* properties from display property that are reset by another display property. */
2376 Lisp_Object space_width
;
2377 Lisp_Object font_height
;
2379 stack
[IT_STACK_SIZE
];
2381 /* Stack pointer. */
2384 /* -1 means selective display hides everything between a \r and the
2385 next newline; > 0 means hide lines indented more than that value. */
2386 ptrdiff_t selective
;
2388 /* An enumeration describing what the next display element is
2389 after a call to get_next_display_element. */
2390 enum display_element_type what
;
2395 /* Setting of buffer-local variable selective-display-ellipsis. */
2396 unsigned selective_display_ellipsis_p
: 1;
2398 /* 1 means control characters are translated into the form `^C'
2399 where the `^' can be replaced by a display table entry. */
2400 unsigned ctl_arrow_p
: 1;
2402 /* Non-zero means that the current face has a box. */
2403 unsigned face_box_p
: 1;
2405 /* Non-null means that the current character is the first in a run
2406 of characters with box face. */
2407 unsigned start_of_box_run_p
: 1;
2409 /* Non-zero means that the current character is the last in a run
2410 of characters with box face. */
2411 unsigned end_of_box_run_p
: 1;
2413 /* 1 means overlay strings at end_charpos have been processed. */
2414 unsigned overlay_strings_at_end_processed_p
: 1;
2416 /* 1 means to ignore overlay strings at current pos, as they have
2417 already been processed. */
2418 unsigned ignore_overlay_strings_at_pos_p
: 1;
2420 /* 1 means the actual glyph is not available in the current
2422 unsigned glyph_not_available_p
: 1;
2424 /* 1 means the next line in display_line continues a character
2425 consisting of more than one glyph, and some glyphs of this
2426 character have been put on the previous line. */
2427 unsigned starts_in_middle_of_char_p
: 1;
2429 /* If 1, saved_face_id contains the id of the face in front of text
2430 skipped due to selective display. */
2431 unsigned face_before_selective_p
: 1;
2433 /* If 1, adjust current glyph so it does not increase current row
2434 descent/ascent (line-height property). Reset after this glyph. */
2435 unsigned constrain_row_ascent_descent_p
: 1;
2437 enum line_wrap_method line_wrap
;
2439 /* The ID of the default face to use. One of DEFAULT_FACE_ID,
2440 MODE_LINE_FACE_ID, etc, depending on what we are displaying. */
2443 /* If `what' == IT_CHARACTER, the character and the length in bytes
2444 of its multibyte sequence. The character comes from a buffer or
2445 a string. It may be different from the character displayed in
2446 case that unibyte_display_via_language_environment is set.
2448 If `what' == IT_COMPOSITION, the first component of a composition
2449 and length in bytes of the composition.
2451 If `what' is anything else, these two are undefined (will
2452 probably hold values for the last IT_CHARACTER or IT_COMPOSITION
2453 traversed by the iterator.
2455 The values are updated by get_next_display_element, so they are
2456 out of sync with the value returned by IT_CHARPOS between the
2457 time set_iterator_to_next advances the position and the time
2458 get_next_display_element loads the new values into c and len. */
2461 /* If what == IT_COMPOSITION, iterator substructure for the
2463 struct composition_it cmp_it
;
2465 /* The character to display, possibly translated to multibyte if
2466 multibyte_p is zero or unibyte_display_via_language_environment
2467 is set. This is set after get_next_display_element has been
2468 called. If we are setting it->C directly before calling
2469 PRODUCE_GLYPHS, this should be set beforehand too. */
2470 int char_to_display
;
2472 /* If what == IT_GLYPHLESS, the method to display such a
2474 enum glyphless_display_method glyphless_method
;
2476 /* If what == IT_IMAGE, the id of the image to display. */
2479 /* Values from `slice' property. */
2480 struct it_slice slice
;
2482 /* Value of the `space-width' property, if any; nil if none. */
2483 Lisp_Object space_width
;
2485 /* Computed from the value of the `raise' property. */
2488 /* Number of columns per \t. */
2491 /* Value of the `height' property, if any; nil if none. */
2492 Lisp_Object font_height
;
2494 /* Object and position where the current display element came from.
2495 Object is normally the buffer which is being rendered, but it can
2496 also be a Lisp string in case the current display element comes
2497 from an overlay string or from a display string (before- or
2498 after-string). It may also be nil when a C string is being
2499 rendered, e.g., during mode-line or header-line update. It can
2500 also be a cons cell of the form `(space ...)', when we produce a
2501 stretch glyph from a `display' specification. Finally, it can be
2502 a zero-valued Lisp integer, but only temporarily, when we are
2503 producing special glyphs for display purposes, like truncation
2504 and continuation glyphs, or blanks that extend each line to the
2505 edge of the window on a TTY.
2507 Do NOT use !BUFFERP (it.object) as a test whether we are
2508 iterating over a string; use STRINGP (it.string) instead.
2510 Position is the current iterator position in object. */
2512 struct text_pos position
;
2514 /* Width in pixels of truncation and continuation glyphs. */
2515 short truncation_pixel_width
, continuation_pixel_width
;
2517 /* First and last visible x-position in the display area. If window
2518 is hscrolled by n columns, first_visible_x == n * FRAME_COLUMN_WIDTH
2519 (f), and last_visible_x == pixel width of W + first_visible_x. */
2520 int first_visible_x
, last_visible_x
;
2522 /* Last visible y-position + 1 in the display area without a mode
2523 line, if the window has one. */
2526 /* Default amount of additional space in pixels between lines (for
2527 window systems only.) */
2528 int extra_line_spacing
;
2530 /* Max extra line spacing added in this row. */
2531 int max_extra_line_spacing
;
2533 /* Override font height information for this glyph.
2534 Used if override_ascent >= 0. Cleared after this glyph. */
2535 int override_ascent
, override_descent
, override_boff
;
2537 /* If non-null, glyphs are produced in glyph_row with each call to
2539 struct glyph_row
*glyph_row
;
2541 /* The area of glyph_row to which glyphs are added. */
2542 enum glyph_row_area area
;
2544 /* Number of glyphs needed for the last character requested via
2545 produce_glyphs. This is 1 except for tabs. */
2548 /* Width of the display element in pixels. Result of
2552 /* Current, maximum logical, and maximum physical line height
2553 information. Result of produce_glyphs. */
2554 int ascent
, descent
, max_ascent
, max_descent
;
2555 int phys_ascent
, phys_descent
, max_phys_ascent
, max_phys_descent
;
2557 /* Current x pixel position within the display line. This value
2558 does not include the width of continuation lines in front of the
2559 line. The value of current_x is automatically incremented by
2560 pixel_width with each call to produce_glyphs. */
2563 /* Accumulated width of continuation lines. If > 0, this means we
2564 are currently in a continuation line. This is initially zero and
2565 incremented/reset by display_line, move_it_to etc. */
2566 int continuation_lines_width
;
2568 /* Buffer position that ends the buffer text line being iterated.
2569 This is normally the position after the newline at EOL. If this
2570 is the last line of the buffer and it doesn't have a newline,
2571 value is ZV/ZV_BYTE. Set and used only if IT->bidi_p, for
2572 setting the end position of glyph rows produced for continuation
2573 lines, see display_line. */
2574 struct text_pos eol_pos
;
2576 /* Current y-position. Automatically incremented by the height of
2577 glyph_row in move_it_to and display_line. */
2580 /* Vertical matrix position of first text line in window. */
2583 /* Current vertical matrix position, or line number. Automatically
2584 incremented by move_it_to and display_line. */
2587 /* Horizontal matrix position reached in move_it_in_display_line.
2588 Only set there, not in display_line. */
2591 /* Left fringe bitmap number (enum fringe_bitmap_type). */
2592 unsigned left_user_fringe_bitmap
: FRINGE_ID_BITS
;
2594 /* Right fringe bitmap number (enum fringe_bitmap_type). */
2595 unsigned right_user_fringe_bitmap
: FRINGE_ID_BITS
;
2597 /* Face of the left fringe glyph. */
2598 unsigned left_user_fringe_face_id
: FACE_ID_BITS
;
2600 /* Face of the right fringe glyph. */
2601 unsigned right_user_fringe_face_id
: FACE_ID_BITS
;
2603 /* Non-zero means we need to reorder bidirectional text for display
2604 in the visual order. */
2605 unsigned bidi_p
: 1;
2607 /* For iterating over bidirectional text. */
2608 struct bidi_it bidi_it
;
2609 bidi_dir_t paragraph_embedding
;
2613 /* Access to positions of iterator IT. */
2615 #define IT_CHARPOS(IT) CHARPOS ((IT).current.pos)
2616 #define IT_BYTEPOS(IT) BYTEPOS ((IT).current.pos)
2617 #define IT_STRING_CHARPOS(IT) CHARPOS ((IT).current.string_pos)
2618 #define IT_STRING_BYTEPOS(IT) BYTEPOS ((IT).current.string_pos)
2620 /* Test if IT has reached the end of its buffer or string. This will
2621 only work after get_next_display_element has been called. */
2623 #define ITERATOR_AT_END_P(IT) ((IT)->what == IT_EOB)
2625 /* Non-zero means IT is at the end of a line. This is the case if it
2626 is either on a newline or on a carriage return and selective
2627 display hides the rest of the line. */
2629 #define ITERATOR_AT_END_OF_LINE_P(IT) \
2630 ((IT)->what == IT_CHARACTER \
2631 && ((IT)->c == '\n' \
2632 || ((IT)->c == '\r' && (IT)->selective)))
2634 /* Call produce_glyphs or FRAME_RIF->produce_glyphs, if set. Shortcut
2635 to avoid the function call overhead. */
2637 #define PRODUCE_GLYPHS(IT) \
2639 if ((IT)->glyph_row != NULL && (IT)->bidi_p) \
2641 if ((IT)->bidi_it.paragraph_dir == R2L) \
2642 (IT)->glyph_row->reversed_p = 1; \
2644 (IT)->glyph_row->reversed_p = 0; \
2646 if (FRAME_RIF ((IT)->f) != NULL) \
2647 FRAME_RIF ((IT)->f)->produce_glyphs ((IT)); \
2649 produce_glyphs ((IT)); \
2650 if ((IT)->glyph_row != NULL) \
2651 inhibit_free_realized_faces = 1; \
2654 /* Bit-flags indicating what operation move_it_to should perform. */
2656 enum move_operation_enum
2658 /* Stop if specified x-position is reached. */
2661 /* Stop if specified y-position is reached. */
2664 /* Stop if specified vpos is reached. */
2665 MOVE_TO_VPOS
= 0x04,
2667 /* Stop if specified buffer or string position is reached. */
2671 /***********************************************************************
2673 ***********************************************************************/
2675 /* Structure to hold mouse highlight data. */
2678 /* These variables describe the range of text currently shown in its
2679 mouse-face, together with the window they apply to. As long as
2680 the mouse stays within this range, we need not redraw anything on
2681 its account. Rows and columns are glyph matrix positions in
2682 MOUSE_FACE_WINDOW. */
2683 int mouse_face_beg_row
, mouse_face_beg_col
, mouse_face_beg_x
;
2684 int mouse_face_end_row
, mouse_face_end_col
, mouse_face_end_x
;
2685 Lisp_Object mouse_face_window
;
2686 int mouse_face_face_id
;
2687 Lisp_Object mouse_face_overlay
;
2689 /* FRAME and X, Y position of mouse when last checked for
2690 highlighting. X and Y can be negative or out of range for the frame. */
2691 struct frame
*mouse_face_mouse_frame
;
2692 int mouse_face_mouse_x
, mouse_face_mouse_y
;
2694 /* Nonzero if part of the text currently shown in
2695 its mouse-face is beyond the window end. */
2696 unsigned mouse_face_past_end
: 1;
2698 /* Nonzero means defer mouse-motion highlighting. */
2699 unsigned mouse_face_defer
: 1;
2701 /* Nonzero means that the mouse highlight should not be shown. */
2702 unsigned mouse_face_hidden
: 1;
2706 reset_mouse_highlight (Mouse_HLInfo
*hlinfo
)
2709 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
2710 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
2711 hlinfo
->mouse_face_mouse_x
= hlinfo
->mouse_face_mouse_y
= 0;
2712 hlinfo
->mouse_face_beg_x
= hlinfo
->mouse_face_end_x
= 0;
2713 hlinfo
->mouse_face_face_id
= DEFAULT_FACE_ID
;
2714 hlinfo
->mouse_face_mouse_frame
= NULL
;
2715 hlinfo
->mouse_face_window
= Qnil
;
2716 hlinfo
->mouse_face_overlay
= Qnil
;
2717 hlinfo
->mouse_face_past_end
= 0;
2718 hlinfo
->mouse_face_hidden
= 0;
2719 hlinfo
->mouse_face_defer
= 0;
2722 /***********************************************************************
2723 Window-based redisplay interface
2724 ***********************************************************************/
2726 /* Structure used to describe runs of lines that must be scrolled. */
2730 /* Source and destination y pixel position. */
2731 int desired_y
, current_y
;
2733 /* Source and destination vpos in matrix. */
2734 int desired_vpos
, current_vpos
;
2736 /* Height in pixels, number of glyph rows. */
2741 /* Handlers for setting frame parameters. */
2743 typedef void (*frame_parm_handler
) (struct frame
*, Lisp_Object
, Lisp_Object
);
2746 /* Structure holding system-dependent interface functions needed
2747 for window-based redisplay. */
2749 struct redisplay_interface
2751 /* Handlers for setting frame parameters. */
2752 frame_parm_handler
*frame_parm_handlers
;
2754 /* Produce glyphs/get display metrics for the display element IT is
2756 void (*produce_glyphs
) (struct it
*it
);
2758 /* Write or insert LEN glyphs from STRING at the nominal output
2760 void (*write_glyphs
) (struct window
*w
, struct glyph_row
*row
,
2761 struct glyph
*string
, enum glyph_row_area area
,
2763 void (*insert_glyphs
) (struct window
*w
, struct glyph_row
*row
,
2764 struct glyph
*start
, enum glyph_row_area area
,
2767 /* Clear from nominal output position to X. X < 0 means clear
2768 to right end of display. */
2769 void (*clear_end_of_line
) (struct window
*w
, struct glyph_row
*row
,
2770 enum glyph_row_area area
, int x
);
2772 /* Function to call to scroll the display as described by RUN on
2774 void (*scroll_run_hook
) (struct window
*w
, struct run
*run
);
2776 /* Function to call after a line in a display has been completely
2777 updated. Used to draw truncation marks and alike. DESIRED_ROW
2778 is the desired row which has been updated. */
2779 void (*after_update_window_line_hook
) (struct window
*w
,
2780 struct glyph_row
*desired_row
);
2782 /* Function to call before beginning to update window W in
2783 window-based redisplay. */
2784 void (*update_window_begin_hook
) (struct window
*w
);
2786 /* Function to call after window W has been updated in window-based
2787 redisplay. CURSOR_ON_P non-zero means switch cursor on.
2788 MOUSE_FACE_OVERWRITTEN_P non-zero means that some lines in W
2789 that contained glyphs in mouse-face were overwritten, so we
2790 have to update the mouse highlight. */
2791 void (*update_window_end_hook
) (struct window
*w
, bool cursor_on_p
,
2792 bool mouse_face_overwritten_p
);
2794 /* Flush the display of frame F. For X, this is XFlush. */
2795 void (*flush_display
) (struct frame
*f
);
2797 /* Clear the mouse highlight in window W, if there is any. */
2798 void (*clear_window_mouse_face
) (struct window
*w
);
2800 /* Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
2802 void (*get_glyph_overhangs
) (struct glyph
*glyph
, struct frame
*f
,
2803 int *left
, int *right
);
2805 /* Fix the display of AREA of ROW in window W for overlapping rows.
2806 This function is called from redraw_overlapping_rows after
2807 desired rows have been made current. */
2808 void (*fix_overlapping_area
) (struct window
*w
, struct glyph_row
*row
,
2809 enum glyph_row_area area
, int);
2811 #ifdef HAVE_WINDOW_SYSTEM
2813 /* Draw a fringe bitmap in window W of row ROW using parameters P. */
2814 void (*draw_fringe_bitmap
) (struct window
*w
, struct glyph_row
*row
,
2815 struct draw_fringe_bitmap_params
*p
);
2817 /* Define and destroy fringe bitmap no. WHICH. */
2818 void (*define_fringe_bitmap
) (int which
, unsigned short *bits
,
2820 void (*destroy_fringe_bitmap
) (int which
);
2822 /* Compute left and right overhang of glyph string S.
2823 A NULL pointer if platform does not support this. */
2824 void (*compute_glyph_string_overhangs
) (struct glyph_string
*s
);
2826 /* Draw a glyph string S. */
2827 void (*draw_glyph_string
) (struct glyph_string
*s
);
2829 /* Define cursor CURSOR on frame F. */
2830 void (*define_frame_cursor
) (struct frame
*f
, Cursor cursor
);
2832 /* Clear the area at (X,Y,WIDTH,HEIGHT) of frame F. */
2833 void (*clear_frame_area
) (struct frame
*f
, int x
, int y
,
2834 int width
, int height
);
2836 /* Draw specified cursor CURSOR_TYPE of width CURSOR_WIDTH
2837 at row GLYPH_ROW on window W if ON_P is 1. If ON_P is
2838 0, don't draw cursor. If ACTIVE_P is 1, system caret
2839 should track this cursor (when applicable). */
2840 void (*draw_window_cursor
) (struct window
*w
,
2841 struct glyph_row
*glyph_row
,
2843 enum text_cursor_kinds cursor_type
,
2844 int cursor_width
, bool on_p
, bool active_p
);
2846 /* Draw vertical border for window W from (X,Y_0) to (X,Y_1). */
2847 void (*draw_vertical_window_border
) (struct window
*w
,
2848 int x
, int y_0
, int y_1
);
2850 /* Shift display of frame F to make room for inserted glyphs.
2851 The area at pixel (X,Y) of width WIDTH and height HEIGHT is
2852 shifted right by SHIFT_BY pixels. */
2853 void (*shift_glyphs_for_insert
) (struct frame
*f
,
2854 int x
, int y
, int width
,
2855 int height
, int shift_by
);
2857 #endif /* HAVE_WINDOW_SYSTEM */
2861 /***********************************************************************
2863 ***********************************************************************/
2865 #ifdef HAVE_WINDOW_SYSTEM
2867 /* Each image format (JPEG, TIFF, ...) supported is described by
2868 a structure of the type below. */
2872 /* A symbol uniquely identifying the image type, .e.g `jpeg'. */
2875 /* Check that SPEC is a valid image specification for the given
2876 image type. Value is true if SPEC is valid. */
2877 bool (* valid_p
) (Lisp_Object spec
);
2879 /* Load IMG which is used on frame F from information contained in
2880 IMG->spec. Value is true if successful. */
2881 bool (* load
) (struct frame
*f
, struct image
*img
);
2883 /* Free resources of image IMG which is used on frame F. */
2884 void (* free
) (struct frame
*f
, struct image
*img
);
2886 /* Initialization function (used for dynamic loading of image
2887 libraries on Windows), or NULL if none. */
2888 bool (* init
) (void);
2890 /* Next in list of all supported image types. */
2891 struct image_type
*next
;
2895 /* Structure describing an image. Specific image formats like XBM are
2896 converted into this form, so that display only has to deal with
2897 this type of image. */
2901 /* The time in seconds at which the image was last displayed. Set
2902 in prepare_image_for_display. */
2903 struct timespec timestamp
;
2905 /* Pixmaps of the image. */
2906 Pixmap pixmap
, mask
;
2908 #ifdef HAVE_X_WINDOWS
2909 /* X images of the image, corresponding to the above Pixmaps.
2910 Non-NULL means it and its Pixmap counterpart may be out of sync
2911 and the latter is outdated. NULL means the X image has been
2912 synchronized to Pixmap. */
2913 XImagePtr ximg
, mask_img
;
2916 /* Colors allocated for this image, if any. Allocated via xmalloc. */
2917 unsigned long *colors
;
2920 /* A single `background color' for this image, for the use of anyone that
2921 cares about such a thing. Only valid if the `background_valid' field
2922 is true. This should generally be accessed by calling the accessor
2923 macro `IMAGE_BACKGROUND', which will heuristically calculate a value
2925 unsigned long background
;
2927 /* Foreground and background colors of the frame on which the image
2929 unsigned long frame_foreground
, frame_background
;
2931 /* True if this image has a `transparent' background -- that is, is
2932 uses an image mask. The accessor macro for this is
2933 `IMAGE_BACKGROUND_TRANSPARENT'. */
2934 unsigned background_transparent
: 1;
2936 /* True if the `background' and `background_transparent' fields are
2937 valid, respectively. */
2938 unsigned background_valid
: 1, background_transparent_valid
: 1;
2940 /* Width and height of the image. */
2943 /* These values are used for the rectangles displayed for images
2944 that can't be loaded. */
2945 #define DEFAULT_IMAGE_WIDTH 30
2946 #define DEFAULT_IMAGE_HEIGHT 30
2948 /* Top/left and bottom/right corner pixel of actual image data.
2949 Used by four_corners_best to consider the real image data,
2950 rather than looking at the optional image margin. */
2952 #define TOP_CORNER 0
2953 #define LEFT_CORNER 1
2954 #define BOT_CORNER 2
2955 #define RIGHT_CORNER 3
2957 /* Percent of image height used as ascent. A value of
2958 CENTERED_IMAGE_ASCENT means draw the image centered on the
2961 #define DEFAULT_IMAGE_ASCENT 50
2962 #define CENTERED_IMAGE_ASCENT -1
2964 /* Lisp specification of this image. */
2967 /* List of "references" followed to build the image.
2968 Typically will just contain the name of the image file.
2969 Used to allow fine-grained cache flushing. */
2970 Lisp_Object dependencies
;
2972 /* Relief to draw around the image. */
2975 /* Optional margins around the image. This includes the relief. */
2976 int hmargin
, vmargin
;
2978 /* Reference to the type of the image. */
2979 struct image_type
*type
;
2981 /* 1 means that loading the image failed. Don't try again. */
2982 unsigned load_failed_p
;
2984 /* A place for image types to store additional data. It is marked
2986 Lisp_Object lisp_data
;
2988 /* Hash value of image specification to speed up comparisons. */
2991 /* Image id of this image. */
2994 /* Hash collision chain. */
2995 struct image
*next
, *prev
;
2999 /* Cache of images. Each frame has a cache. X frames with the same
3000 x_display_info share their caches. */
3004 /* Hash table of images. */
3005 struct image
**buckets
;
3007 /* Vector mapping image ids to images. */
3008 struct image
**images
;
3010 /* Allocated size of `images'. */
3013 /* Number of images in the cache. */
3016 /* Reference count (number of frames sharing this cache). */
3021 /* Value is a pointer to the image with id ID on frame F, or null if
3022 no image with that id exists. */
3024 #define IMAGE_FROM_ID(F, ID) \
3025 (((ID) >= 0 && (ID) < (FRAME_IMAGE_CACHE (F)->used)) \
3026 ? FRAME_IMAGE_CACHE (F)->images[ID] \
3029 /* Size of bucket vector of image caches. Should be prime. */
3031 #define IMAGE_CACHE_BUCKETS_SIZE 1001
3033 #endif /* HAVE_WINDOW_SYSTEM */
3037 /***********************************************************************
3039 ***********************************************************************/
3041 /* Enumeration defining where to find tool-bar item information in
3042 tool-bar items vectors stored with frames. Each tool-bar item
3043 occupies TOOL_BAR_ITEM_NSLOTS elements in such a vector. */
3045 enum tool_bar_item_idx
3047 /* The key of the tool-bar item. Used to remove items when a binding
3048 for `undefined' is found. */
3051 /* Non-nil if item is enabled. */
3052 TOOL_BAR_ITEM_ENABLED_P
,
3054 /* Non-nil if item is selected (pressed). */
3055 TOOL_BAR_ITEM_SELECTED_P
,
3058 TOOL_BAR_ITEM_CAPTION
,
3060 /* Image(s) to display. This is either a single image specification
3061 or a vector of specifications. */
3062 TOOL_BAR_ITEM_IMAGES
,
3065 TOOL_BAR_ITEM_BINDING
,
3067 /* Button type. One of nil (default button), t (a separator),
3068 `:radio', or `:toggle'. The latter two currently do nothing. */
3074 /* Icon file name of right to left image when an RTL locale is used. */
3075 TOOL_BAR_ITEM_RTL_IMAGE
,
3077 /* Label to show when text labels are enabled. */
3078 TOOL_BAR_ITEM_LABEL
,
3080 /* If we shall show the label only below the icon and not beside it. */
3081 TOOL_BAR_ITEM_VERT_ONLY
,
3083 /* Sentinel = number of slots in tool_bar_items occupied by one
3085 TOOL_BAR_ITEM_NSLOTS
3089 /* An enumeration for the different images that can be specified
3090 for a tool-bar item. */
3092 enum tool_bar_item_image
3094 TOOL_BAR_IMAGE_ENABLED_SELECTED
,
3095 TOOL_BAR_IMAGE_ENABLED_DESELECTED
,
3096 TOOL_BAR_IMAGE_DISABLED_SELECTED
,
3097 TOOL_BAR_IMAGE_DISABLED_DESELECTED
3100 #define DEFAULT_TOOL_BAR_LABEL_SIZE 14
3102 /* Default values of the above variables. */
3104 #define DEFAULT_TOOL_BAR_BUTTON_MARGIN 4
3105 #define DEFAULT_TOOL_BAR_BUTTON_RELIEF 1
3107 /* The height in pixels of the default tool-bar images. */
3109 #define DEFAULT_TOOL_BAR_IMAGE_HEIGHT 24
3112 /***********************************************************************
3113 Terminal Capabilities
3114 ***********************************************************************/
3116 /* Each of these is a bit representing a terminal `capability' (bold,
3117 inverse, etc). They are or'd together to specify the set of
3118 capabilities being queried for when calling `tty_capable_p' (which
3119 returns true if the terminal supports all of them). */
3121 #define TTY_CAP_INVERSE 0x01
3122 #define TTY_CAP_UNDERLINE 0x02
3123 #define TTY_CAP_BOLD 0x04
3124 #define TTY_CAP_DIM 0x08
3125 #define TTY_CAP_ITALIC 0x10
3128 /***********************************************************************
3130 ***********************************************************************/
3132 /* Defined in bidi.c */
3134 extern void bidi_init_it (ptrdiff_t, ptrdiff_t, bool, struct bidi_it
*);
3135 extern void bidi_move_to_visually_next (struct bidi_it
*);
3136 extern void bidi_paragraph_init (bidi_dir_t
, struct bidi_it
*, bool);
3137 extern int bidi_mirror_char (int);
3138 extern void bidi_push_it (struct bidi_it
*);
3139 extern void bidi_pop_it (struct bidi_it
*);
3140 extern void *bidi_shelve_cache (void);
3141 extern void bidi_unshelve_cache (void *, bool);
3143 /* Defined in xdisp.c */
3145 struct glyph_row
*row_containing_pos (struct window
*, ptrdiff_t,
3147 struct glyph_row
*, int);
3148 int line_bottom_y (struct it
*);
3149 int default_line_pixel_height (struct window
*);
3150 int display_prop_intangible_p (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3151 void resize_echo_area_exactly (void);
3152 int resize_mini_window (struct window
*, int);
3153 #if defined USE_TOOLKIT_SCROLL_BARS && !defined USE_GTK
3154 void set_vertical_scroll_bar (struct window
*);
3156 int try_window (Lisp_Object
, struct text_pos
, int);
3157 void window_box (struct window
*, enum glyph_row_area
,
3158 int *, int *, int *, int *);
3159 int window_box_height (struct window
*);
3160 int window_text_bottom_y (struct window
*);
3161 int window_box_width (struct window
*, enum glyph_row_area
);
3162 int window_box_left (struct window
*, enum glyph_row_area
);
3163 int window_box_left_offset (struct window
*, enum glyph_row_area
);
3164 int window_box_right (struct window
*, enum glyph_row_area
);
3165 int window_box_right_offset (struct window
*, enum glyph_row_area
);
3166 int estimate_mode_line_height (struct frame
*, enum face_id
);
3167 void pixel_to_glyph_coords (struct frame
*, int, int, int *, int *,
3168 NativeRectangle
*, int);
3169 void remember_mouse_glyph (struct frame
*, int, int, NativeRectangle
*);
3171 void mark_window_display_accurate (Lisp_Object
, int);
3172 void redisplay_preserve_echo_area (int);
3173 void init_iterator (struct it
*, struct window
*, ptrdiff_t,
3174 ptrdiff_t, struct glyph_row
*, enum face_id
);
3175 void init_iterator_to_row_start (struct it
*, struct window
*,
3176 struct glyph_row
*);
3177 void start_display (struct it
*, struct window
*, struct text_pos
);
3178 void move_it_to (struct it
*, ptrdiff_t, int, int, int, int);
3179 void move_it_vertically (struct it
*, int);
3180 void move_it_vertically_backward (struct it
*, int);
3181 void move_it_by_lines (struct it
*, ptrdiff_t);
3182 void move_it_past_eol (struct it
*);
3183 void move_it_in_display_line (struct it
*it
,
3184 ptrdiff_t to_charpos
, int to_x
,
3185 enum move_operation_enum op
);
3186 int in_display_vector_p (struct it
*);
3187 int frame_mode_line_height (struct frame
*);
3188 extern Lisp_Object Qtool_bar
;
3189 extern bool redisplaying_p
;
3190 extern int help_echo_showing_p
;
3191 extern Lisp_Object help_echo_string
, help_echo_window
;
3192 extern Lisp_Object help_echo_object
, previous_help_echo_string
;
3193 extern ptrdiff_t help_echo_pos
;
3194 extern int last_tool_bar_item
;
3195 extern void reseat_at_previous_visible_line_start (struct it
*);
3196 extern Lisp_Object
lookup_glyphless_char_display (int, struct it
*);
3197 extern ptrdiff_t compute_display_string_pos (struct text_pos
*,
3198 struct bidi_string_data
*,
3199 struct window
*, int, int *);
3200 extern ptrdiff_t compute_display_string_end (ptrdiff_t,
3201 struct bidi_string_data
*);
3202 extern void produce_stretch_glyph (struct it
*);
3203 extern int merge_glyphless_glyph_face (struct it
*);
3205 #ifdef HAVE_WINDOW_SYSTEM
3208 extern void dump_glyph_string (struct glyph_string
*) EXTERNALLY_VISIBLE
;
3211 extern void x_get_glyph_overhangs (struct glyph
*, struct frame
*,
3213 extern void x_produce_glyphs (struct it
*);
3215 extern void x_write_glyphs (struct window
*, struct glyph_row
*,
3216 struct glyph
*, enum glyph_row_area
, int);
3217 extern void x_insert_glyphs (struct window
*, struct glyph_row
*,
3218 struct glyph
*, enum glyph_row_area
, int);
3219 extern void x_clear_end_of_line (struct window
*, struct glyph_row
*,
3220 enum glyph_row_area
, int);
3221 extern void x_fix_overlapping_area (struct window
*, struct glyph_row
*,
3222 enum glyph_row_area
, int);
3223 extern void draw_phys_cursor_glyph (struct window
*,
3225 enum draw_glyphs_face
);
3226 extern void get_phys_cursor_geometry (struct window
*, struct glyph_row
*,
3227 struct glyph
*, int *, int *, int *);
3228 extern void erase_phys_cursor (struct window
*);
3229 extern void display_and_set_cursor (struct window
*, bool, int, int, int, int);
3230 extern void x_update_cursor (struct frame
*, bool);
3231 extern void x_clear_cursor (struct window
*);
3232 extern void x_draw_vertical_border (struct window
*w
);
3234 extern int get_glyph_string_clip_rects (struct glyph_string
*,
3235 NativeRectangle
*, int);
3236 extern void get_glyph_string_clip_rect (struct glyph_string
*,
3237 NativeRectangle
*nr
);
3238 extern Lisp_Object
find_hot_spot (Lisp_Object
, int, int);
3240 extern void handle_tool_bar_click (struct frame
*,
3241 int, int, int, int);
3243 extern void expose_frame (struct frame
*, int, int, int, int);
3244 extern int x_intersect_rectangles (XRectangle
*, XRectangle
*,
3246 #endif /* HAVE_WINDOW_SYSTEM */
3248 extern void note_mouse_highlight (struct frame
*, int, int);
3249 extern void x_clear_window_mouse_face (struct window
*);
3250 extern void cancel_mouse_face (struct frame
*);
3251 extern int clear_mouse_face (Mouse_HLInfo
*);
3252 extern int cursor_in_mouse_face_p (struct window
*w
);
3253 extern void tty_draw_row_with_mouse_face (struct window
*, struct glyph_row
*,
3254 int, int, enum draw_glyphs_face
);
3256 /* Flags passed to try_window. */
3257 #define TRY_WINDOW_CHECK_MARGINS (1 << 0)
3258 #define TRY_WINDOW_IGNORE_FONTS_CHANGE (1 << 1)
3260 int lookup_fringe_bitmap (Lisp_Object
);
3261 void draw_fringe_bitmap (struct window
*, struct glyph_row
*, int);
3262 void draw_row_fringe_bitmaps (struct window
*, struct glyph_row
*);
3263 bool draw_window_fringes (struct window
*, bool);
3264 bool update_window_fringes (struct window
*, bool);
3265 void compute_fringe_widths (struct frame
*, bool);
3268 void w32_init_fringe (struct redisplay_interface
*);
3269 void w32_reset_fringes (void);
3272 extern unsigned row_hash (struct glyph_row
*);
3274 /* Defined in image.c */
3276 #ifdef HAVE_WINDOW_SYSTEM
3278 extern int x_bitmap_height (struct frame
*, ptrdiff_t);
3279 extern int x_bitmap_width (struct frame
*, ptrdiff_t);
3280 extern ptrdiff_t x_bitmap_pixmap (struct frame
*, ptrdiff_t);
3281 extern void x_reference_bitmap (struct frame
*, ptrdiff_t);
3282 extern ptrdiff_t x_create_bitmap_from_data (struct frame
*, char *,
3283 unsigned int, unsigned int);
3284 extern ptrdiff_t x_create_bitmap_from_file (struct frame
*, Lisp_Object
);
3285 #if defined HAVE_XPM && defined HAVE_X_WINDOWS && !defined USE_GTK
3286 extern ptrdiff_t x_create_bitmap_from_xpm_data (struct frame
*, const char **);
3288 #ifndef x_destroy_bitmap
3289 extern void x_destroy_bitmap (struct frame
*, ptrdiff_t);
3291 extern void x_destroy_all_bitmaps (Display_Info
*);
3292 extern void x_create_bitmap_mask (struct frame
*, ptrdiff_t);
3293 extern Lisp_Object
x_find_image_file (Lisp_Object
);
3295 void x_kill_gs_process (Pixmap
, struct frame
*);
3296 struct image_cache
*make_image_cache (void);
3297 void free_image_cache (struct frame
*);
3298 void clear_image_caches (Lisp_Object
);
3299 void mark_image_cache (struct image_cache
*);
3300 bool valid_image_p (Lisp_Object
);
3301 void prepare_image_for_display (struct frame
*, struct image
*);
3302 ptrdiff_t lookup_image (struct frame
*, Lisp_Object
);
3304 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3305 #define RGB_PIXEL_COLOR unsigned long
3309 #define RGB_PIXEL_COLOR COLORREF
3312 RGB_PIXEL_COLOR
image_background (struct image
*, struct frame
*,
3313 XImagePtr_or_DC ximg
);
3314 int image_background_transparent (struct image
*, struct frame
*,
3315 XImagePtr_or_DC mask
);
3317 int image_ascent (struct image
*, struct face
*, struct glyph_slice
*);
3321 /* Defined in sysdep.c */
3323 void get_tty_size (int, int *, int *);
3324 void request_sigio (void);
3325 void unrequest_sigio (void);
3326 bool tabs_safe_p (int);
3327 void init_baud_rate (int);
3328 void init_sigio (int);
3329 void ignore_sigio (void);
3331 /* Defined in xfaces.c */
3333 #ifdef HAVE_X_WINDOWS
3334 void x_free_colors (struct frame
*, unsigned long *, int);
3337 void update_face_from_frame_parameter (struct frame
*, Lisp_Object
,
3339 Lisp_Object
tty_color_name (struct frame
*, int);
3340 void clear_face_cache (int);
3341 unsigned long load_color (struct frame
*, struct face
*, Lisp_Object
,
3342 enum lface_attribute_index
);
3343 void unload_color (struct frame
*, unsigned long);
3344 char *choose_face_font (struct frame
*, Lisp_Object
*, Lisp_Object
,
3346 void prepare_face_for_display (struct frame
*, struct face
*);
3347 int lookup_named_face (struct frame
*, Lisp_Object
, int);
3348 int lookup_basic_face (struct frame
*, int);
3349 int smaller_face (struct frame
*, int, int);
3350 int face_with_height (struct frame
*, int, int);
3351 int lookup_derived_face (struct frame
*, Lisp_Object
, int, int);
3352 void init_frame_faces (struct frame
*);
3353 void free_frame_faces (struct frame
*);
3354 void recompute_basic_faces (struct frame
*);
3355 int face_at_buffer_position (struct window
*w
, ptrdiff_t pos
,
3356 ptrdiff_t region_beg
, ptrdiff_t region_end
,
3357 ptrdiff_t *endptr
, ptrdiff_t limit
,
3358 int mouse
, int base_face_id
);
3359 int face_for_overlay_string (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
, Lisp_Object overlay
);
3363 int face_at_string_position (struct window
*w
, Lisp_Object string
,
3364 ptrdiff_t pos
, ptrdiff_t bufpos
,
3365 ptrdiff_t region_beg
, ptrdiff_t region_end
,
3366 ptrdiff_t *endptr
, enum face_id
, int mouse
);
3367 int merge_faces (struct frame
*, Lisp_Object
, int, int);
3368 int compute_char_face (struct frame
*, int, Lisp_Object
);
3369 void free_all_realized_faces (Lisp_Object
);
3370 extern Lisp_Object Qforeground_color
, Qbackground_color
;
3371 extern char unspecified_fg
[], unspecified_bg
[];
3373 /* Defined in xfns.c */
3375 #ifdef HAVE_X_WINDOWS
3376 void gamma_correct (struct frame
*, XColor
*);
3379 void gamma_correct (struct frame
*, COLORREF
*);
3382 #ifdef HAVE_WINDOW_SYSTEM
3384 void x_implicitly_set_name (struct frame
*, Lisp_Object
, Lisp_Object
);
3386 extern Lisp_Object tip_frame
;
3387 extern Window tip_window
;
3388 extern frame_parm_handler x_frame_parm_handlers
[];
3390 extern void start_hourglass (void);
3391 extern void cancel_hourglass (void);
3392 extern int hourglass_shown_p
;
3393 /* If non-null, an asynchronous timer that, when it expires, displays
3394 an hourglass cursor on all frames. */
3395 extern struct atimer
*hourglass_atimer
;
3397 /* Each GUI implements these. FIXME: move into RIF. */
3398 extern void show_hourglass (struct atimer
*);
3399 extern void hide_hourglass (void);
3401 /* Returns the background color of IMG, calculating one heuristically if
3402 necessary. If non-zero, XIMG is an existing XImage object to use for
3405 #define IMAGE_BACKGROUND(img, f, ximg) \
3406 ((img)->background_valid \
3407 ? (img)->background \
3408 : image_background (img, f, ximg))
3410 /* Returns true if IMG has a `transparent' background, using heuristics
3411 to decide if necessary. If non-zero, MASK is an existing XImage
3412 object to use for the heuristic. */
3414 #define IMAGE_BACKGROUND_TRANSPARENT(img, f, mask) \
3415 ((img)->background_transparent_valid \
3416 ? (img)->background_transparent \
3417 : image_background_transparent (img, f, mask))
3419 #endif /* HAVE_WINDOW_SYSTEM */
3422 /* Defined in xmenu.c */
3424 int popup_activated (void);
3426 extern Lisp_Object
buffer_posn_from_coords (struct window
*,
3428 struct display_pos
*,
3430 int *, int *, int *, int *);
3431 extern Lisp_Object
mode_line_string (struct window
*, enum window_part
,
3432 int *, int *, ptrdiff_t *,
3434 int *, int *, int *, int *);
3435 extern Lisp_Object
marginal_area_string (struct window
*, enum window_part
,
3436 int *, int *, ptrdiff_t *,
3438 int *, int *, int *, int *);
3439 extern void redraw_frame (struct frame
*);
3440 extern void cancel_line (int, struct frame
*);
3441 extern void init_desired_glyphs (struct frame
*);
3442 extern bool update_frame (struct frame
*, bool, bool);
3443 extern void bitch_at_user (void);
3444 extern void adjust_frame_glyphs (struct frame
*);
3445 void free_glyphs (struct frame
*);
3446 void free_window_matrices (struct window
*);
3447 void check_glyph_memory (void);
3448 void mirrored_line_dance (struct glyph_matrix
*, int, int, int *, char *);
3449 void clear_glyph_matrix (struct glyph_matrix
*);
3450 void clear_current_matrices (struct frame
*f
);
3451 void clear_desired_matrices (struct frame
*);
3452 void shift_glyph_matrix (struct window
*, struct glyph_matrix
*,
3454 void rotate_matrix (struct glyph_matrix
*, int, int, int);
3455 void increment_matrix_positions (struct glyph_matrix
*,
3456 int, int, ptrdiff_t, ptrdiff_t);
3457 void blank_row (struct window
*, struct glyph_row
*, int);
3458 void clear_glyph_matrix_rows (struct glyph_matrix
*, int, int);
3459 void clear_glyph_row (struct glyph_row
*);
3460 void prepare_desired_row (struct glyph_row
*);
3461 void set_window_update_flags (struct window
*, bool);
3462 void update_single_window (struct window
*, bool);
3463 void do_pending_window_change (bool);
3464 void change_frame_size (struct frame
*, int, int, bool, bool, bool);
3465 void init_display (void);
3466 void syms_of_display (void);
3467 extern Lisp_Object Qredisplay_dont_pause
;
3468 void spec_glyph_lookup_face (struct window
*, GLYPH
*);
3470 /* Defined in terminal.c */
3472 extern void ring_bell (struct frame
*);
3473 extern void update_begin (struct frame
*);
3474 extern void update_end (struct frame
*);
3475 extern void set_terminal_window (struct frame
*, int);
3476 extern void cursor_to (struct frame
*, int, int);
3477 extern void raw_cursor_to (struct frame
*, int, int);
3478 extern void clear_to_end (struct frame
*);
3479 extern void clear_frame (struct frame
*);
3480 extern void clear_end_of_line (struct frame
*, int);
3481 extern void write_glyphs (struct frame
*, struct glyph
*, int);
3482 extern void insert_glyphs (struct frame
*, struct glyph
*, int);
3483 extern void delete_glyphs (struct frame
*, int);
3484 extern void ins_del_lines (struct frame
*, int, int);
3486 extern struct terminal
*init_initial_terminal (void);
3489 /* Defined in term.c */
3491 extern void tty_turn_off_insert (struct tty_display_info
*);
3492 extern int string_cost (const char *);
3493 extern int per_line_cost (const char *);
3494 extern void calculate_costs (struct frame
*);
3495 extern void produce_glyphs (struct it
*);
3496 extern bool tty_capable_p (struct tty_display_info
*, unsigned,
3497 unsigned long, unsigned long);
3498 extern void set_tty_color_mode (struct tty_display_info
*, struct frame
*);
3499 extern struct terminal
*get_named_tty (const char *);
3500 extern void create_tty_output (struct frame
*);
3501 extern struct terminal
*init_tty (const char *, const char *, bool);
3502 extern void tty_append_glyph (struct it
*);
3505 /* Defined in scroll.c */
3507 extern int scrolling_max_lines_saved (int, int, int *, int *, int *);
3508 extern void do_line_insertion_deletion_costs (struct frame
*, const char *,
3509 const char *, const char *,
3510 const char *, const char *,
3512 void scrolling_1 (struct frame
*, int, int, int, int *, int *, int *,
3515 /* Defined in frame.c */
3517 #ifdef HAVE_WINDOW_SYSTEM
3519 /* Types we might convert a resource string into. */
3527 RES_TYPE_BOOLEAN_NUMBER
3530 extern Display_Info
*check_x_display_info (Lisp_Object
);
3531 extern Lisp_Object
x_get_arg (Display_Info
*, Lisp_Object
,
3532 Lisp_Object
, const char *, const char *class,
3533 enum resource_types
);
3534 extern Lisp_Object
x_frame_get_and_record_arg (struct frame
*, Lisp_Object
,
3536 const char *, const char *,
3537 enum resource_types
);
3538 extern Lisp_Object
x_default_parameter (struct frame
*, Lisp_Object
,
3539 Lisp_Object
, Lisp_Object
,
3540 const char *, const char *,
3541 enum resource_types
);
3542 extern char *x_get_string_resource (XrmDatabase
, const char *,
3545 #ifndef HAVE_NS /* These both used on W32 and X only. */
3546 extern bool x_mouse_grabbed (Display_Info
*);
3547 extern void x_redo_mouse_highlight (Display_Info
*);
3548 #endif /* HAVE_NS */
3550 #endif /* HAVE_WINDOW_SYSTEM */
3554 #endif /* not DISPEXTERN_H_INCLUDED */