1 /* Interface definitions for display code.
3 Copyright (C) 1985, 1993-1994, 1997-2013 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>. */
22 #ifndef DISPEXTERN_H_INCLUDED
23 #define DISPEXTERN_H_INCLUDED
25 #include "character.h"
31 #include <X11/Intrinsic.h>
32 #endif /* USE_X_TOOLKIT */
34 #else /* !HAVE_X_WINDOWS */
36 /* X-related stuff used by non-X gui code. */
40 unsigned short red
, green
, blue
;
45 #endif /* HAVE_X_WINDOWS */
52 #ifndef DISPEXTERN_INLINE
53 # define DISPEXTERN_INLINE INLINE
56 #include <c-strcase.h>
58 xstrcasecmp (char const *a
, char const *b
)
60 return c_strcasecmp (a
, b
);
64 typedef struct x_display_info Display_Info
;
65 typedef XImage
* XImagePtr
;
66 typedef XImagePtr XImagePtr_or_DC
;
67 #define NativeRectangle XRectangle
72 typedef struct w32_display_info Display_Info
;
73 typedef XImage
*XImagePtr
;
74 typedef HDC XImagePtr_or_DC
;
79 /* Following typedef needed to accommodate the MSDOS port, believe it or not. */
80 typedef struct ns_display_info Display_Info
;
81 typedef Pixmap XImagePtr
;
82 typedef XImagePtr XImagePtr_or_DC
;
85 #ifdef HAVE_WINDOW_SYSTEM
89 #ifndef HAVE_WINDOW_SYSTEM
94 #ifndef NativeRectangle
95 #define NativeRectangle int
98 /* Text cursor types. */
100 enum text_cursor_kinds
110 /* Values returned from coordinates_in_window. */
126 /* Number of bits allocated to store fringe bitmap numbers. */
127 #define FRINGE_ID_BITS 16
129 /* Number of bits allocated to store fringe bitmap height. */
130 #define FRINGE_HEIGHT_BITS 8
133 /***********************************************************************
135 ***********************************************************************/
137 /* If GLYPH_DEBUG is defined, additional checks are activated. */
139 /* Macros to include code only if GLYPH_DEBUG is defined. */
142 #define IF_DEBUG(X) X
144 #define IF_DEBUG(X) (void) 0
147 /* Macro for displaying traces of redisplay. If Emacs was compiled
148 with GLYPH_DEBUG defined, the variable trace_redisplay_p can be set to
149 a non-zero value in debugging sessions to activate traces. */
153 extern int trace_redisplay_p EXTERNALLY_VISIBLE
;
157 if (trace_redisplay_p) \
162 #else /* not GLYPH_DEBUG */
164 #define TRACE(X) (void) 0
166 #endif /* GLYPH_DEBUG */
170 /***********************************************************************
172 ***********************************************************************/
174 /* Starting with Emacs 20.3, characters from strings and buffers have
175 both a character and a byte position associated with them. The
176 following structure holds such a pair of positions. */
180 /* Character position. */
183 /* Corresponding byte position. */
187 /* Access character and byte position of POS in a functional form. */
189 #define BYTEPOS(POS) (POS).bytepos
190 #define CHARPOS(POS) (POS).charpos
192 /* Set character position of POS to CHARPOS, byte position to BYTEPOS. */
194 #define SET_TEXT_POS(POS, CHARPOS, BYTEPOS) \
195 ((POS).charpos = (CHARPOS), (POS).bytepos = BYTEPOS)
197 /* Increment text position POS. */
199 #define INC_TEXT_POS(POS, MULTIBYTE_P) \
204 INC_POS ((POS).bytepos); \
210 /* Decrement text position POS. */
212 #define DEC_TEXT_POS(POS, MULTIBYTE_P) \
217 DEC_POS ((POS).bytepos); \
223 /* Set text position POS from marker MARKER. */
225 #define SET_TEXT_POS_FROM_MARKER(POS, MARKER) \
226 (CHARPOS (POS) = marker_position (MARKER), \
227 BYTEPOS (POS) = marker_byte_position (MARKER))
229 /* Like above, but clip POS within accessible range. */
231 #define CLIP_TEXT_POS_FROM_MARKER(POS, MARKER) \
232 (CHARPOS (POS) = clip_to_bounds \
233 (BEGV, marker_position (MARKER), ZV), \
234 BYTEPOS (POS) = clip_to_bounds \
235 (BEGV_BYTE, marker_byte_position (MARKER), ZV_BYTE))
237 /* Set marker MARKER from text position POS. */
239 #define SET_MARKER_FROM_TEXT_POS(MARKER, POS) \
240 set_marker_both ((MARKER), Qnil, CHARPOS ((POS)), BYTEPOS ((POS)))
242 /* Value is non-zero if character and byte positions of POS1 and POS2
245 #define TEXT_POS_EQUAL_P(POS1, POS2) \
246 ((POS1).charpos == (POS2).charpos \
247 && (POS1).bytepos == (POS2).bytepos)
249 /* When rendering glyphs, redisplay scans string or buffer text,
250 overlay strings in that text, and does display table or control
251 character translations. The following structure captures a
252 position taking all this into account. */
256 /* Buffer or string position. */
259 /* If this is a position in an overlay string, overlay_string_index
260 is the index of that overlay string in the sequence of overlay
261 strings at `pos' in the order redisplay processes them. A value
262 < 0 means that this is not a position in an overlay string. */
263 ptrdiff_t overlay_string_index
;
265 /* If this is a position in an overlay string, string_pos is the
266 position within that string. */
267 struct text_pos string_pos
;
269 /* If the character at the position above is a control character or
270 has a display table entry, dpvec_index is an index in the display
271 table or control character translation of that character. A
272 value < 0 means this is not a position in such a translation. */
278 /***********************************************************************
280 ***********************************************************************/
282 /* The glyph datatype, used to represent characters on the display.
283 It consists of a char code and a face id. */
290 /* Return a glyph's character code. */
291 DISPEXTERN_INLINE
int GLYPH_CHAR (GLYPH glyph
) { return glyph
.ch
; }
293 /* Return a glyph's face ID. */
294 DISPEXTERN_INLINE
int GLYPH_FACE (GLYPH glyph
) { return glyph
.face_id
; }
296 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
297 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
298 #define SET_GLYPH(glyph, char, face) \
299 ((glyph).ch = (char), (glyph).face_id = (face))
301 /* The following are valid only if GLYPH_CODE_P (gc). */
303 DISPEXTERN_INLINE
int
304 GLYPH_CODE_CHAR (Lisp_Object gc
)
308 : XINT (gc
) & MAX_CHAR
);
311 DISPEXTERN_INLINE
int
312 GLYPH_CODE_FACE (Lisp_Object gc
)
314 return CONSP (gc
) ? XINT (XCDR (gc
)) : XINT (gc
) >> CHARACTERBITS
;
317 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
321 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
323 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
324 (XINT (gc) >> CHARACTERBITS)); \
328 /* The ID of the mode line highlighting face. */
329 enum { GLYPH_MODE_LINE_FACE
= 1 };
331 /* Enumeration of glyph types. Glyph structures contain a type field
332 containing one of the enumerators defined here. */
336 /* Glyph describes a character. */
339 /* Glyph describes a static composition. */
342 /* Glyph describes a glyphless character. */
345 /* Glyph describes an image. */
348 /* Glyph is a space of fractional width and/or height. */
351 /* Glyph is an external widget drawn by the GUI toolkit. */
357 /* Structure describing how to use partial glyphs (images slicing) */
364 unsigned height
: 16;
370 Be extra careful when changing this structure! Esp. make sure that
371 functions producing glyphs, like append_glyph, fill ALL of the
372 glyph structure, and that GLYPH_EQUAL_P compares all
373 display-relevant members of glyphs (not to imply that these are the
374 only things to check when you add a member). */
378 /* Position from which this glyph was drawn. If `object' below is a
379 Lisp string, this is an index into that string. If it is a
380 buffer, this is a position in that buffer. In addition, some
381 special glyphs have special values for this:
383 glyph standing for newline at end of line 0
384 empty space after the end of the line -1
385 overlay arrow on a TTY -1
386 glyph at EOB that ends in a newline -1
387 left truncation glyphs: -1
388 right truncation/continuation glyphs next buffer position
389 glyph standing for newline of an empty line buffer position of newline
390 stretch glyph at left edge of R2L lines buffer position of newline */
393 /* Lisp object source of this glyph. Currently either a buffer or a
394 string, if the glyph was produced from characters which came from
395 a buffer or a string; or Lisp integer zero (a.k.a. "null object")
396 if the glyph was inserted by redisplay for its own purposes, such
397 as padding or truncation/continuation glyphs, or the
398 overlay-arrow glyphs on TTYs. */
401 /* Width in pixels. */
404 /* Ascent and descent in pixels. */
405 short ascent
, descent
;
407 /* Vertical offset. If < 0, the glyph is displayed raised, if > 0
408 the glyph is displayed lowered. */
411 /* Which kind of glyph this is---character, image etc. Value
412 should be an enumerator of type enum glyph_type. */
415 /* 1 means this glyph was produced from multibyte text. Zero
416 means it was produced from unibyte text, i.e. charsets aren't
417 applicable, and encoding is not performed. */
418 unsigned multibyte_p
: 1;
420 /* Non-zero means draw a box line at the left or right side of this
421 glyph. This is part of the implementation of the face attribute
423 unsigned left_box_line_p
: 1;
424 unsigned right_box_line_p
: 1;
426 /* Non-zero means this glyph's physical ascent or descent is greater
427 than its logical ascent/descent, i.e. it may potentially overlap
428 glyphs above or below it. */
429 unsigned overlaps_vertically_p
: 1;
431 /* For terminal frames, 1 means glyph is a padding glyph. Padding
432 glyphs are used for characters whose visual shape consists of
433 more than one glyph (e.g. Asian characters). All but the first
434 glyph of such a glyph sequence have the padding_p flag set. This
435 flag is used only to minimize code changes. A better way would
436 probably be to use the width field of glyphs to express padding.
438 For graphic frames, 1 means the pixel width of the glyph in a
439 font is 0, but 1-pixel is padded on displaying for correct cursor
440 displaying. The member `pixel_width' above is set to 1. */
441 unsigned padding_p
: 1;
443 /* 1 means the actual glyph is not available, draw using `struct
444 glyphless' below instead. This can happen when a font couldn't
445 be loaded, or a character doesn't have a glyph in a font. */
446 unsigned glyph_not_available_p
: 1;
448 /* Non-zero means don't display cursor here. */
449 unsigned avoid_cursor_p
: 1;
451 /* Resolved bidirectional level of this character [0..63]. */
452 unsigned resolved_level
: 5;
454 /* Resolved bidirectional type of this character, see enum
455 bidi_type_t below. Note that according to UAX#9, only some
456 values (STRONG_L, STRONG_R, WEAK_AN, WEAK_EN, WEAK_BN, and
457 NEUTRAL_B) can appear in the resolved type, so we only reserve
458 space for those that can. */
459 unsigned bidi_type
: 3;
461 #define FACE_ID_BITS 20
463 /* Face of the glyph. This is a realized face ID,
464 an index in the face cache of the frame. */
465 unsigned face_id
: FACE_ID_BITS
;
467 /* Type of font used to display the character glyph. May be used to
468 determine which set of functions to use to obtain font metrics
469 for the glyph. On W32, value should be an enumerator of the type
470 w32_char_font_type. Otherwise it equals FONT_TYPE_UNKNOWN. */
471 unsigned font_type
: 3;
473 /* A union of sub-structures for different glyph types. */
476 /* Metrics of a partial glyph of an image (type == IMAGE_GLYPH). */
477 struct glyph_slice img
;
478 /* Start and end indices of glyphs of a grapheme cluster of a
479 composition (type == COMPOSITE_GLYPH). */
480 struct { int from
, to
; } cmp
;
481 /* Pixel offsets for upper and lower part of the acronym. */
483 short upper_xoff
, upper_yoff
;
484 short lower_xoff
, lower_yoff
;
488 /* A union of sub-structures for different glyph types. */
491 /* Character code for character glyphs (type == CHAR_GLYPH). */
494 /* Sub-structures for type == COMPOSITE_GLYPH. */
497 /* Flag to tell if the composition is automatic or not. */
498 unsigned automatic
: 1;
499 /* ID of the composition. */
503 /* Image ID for image glyphs (type == IMAGE_GLYPH). */
507 struct xwidget
* xwidget
;
509 /* Sub-structure for type == STRETCH_GLYPH. */
512 /* The height of the glyph. */
513 unsigned height
: 16;
515 /* The ascent of the glyph. */
516 unsigned ascent
: 16;
520 /* Sub-stretch for type == GLYPHLESS_GLYPH. */
523 /* Value is an enum of the type glyphless_display_method. */
525 /* 1 iff this glyph is for a character of no font. */
526 unsigned for_no_font
: 1;
527 /* Length of acronym or hexadecimal code string (at most 8). */
529 /* Character to display. Actually we need only 22 bits. */
533 /* Used to compare all bit-fields above in one step. */
539 /* Default value of the glyph font_type field. */
541 #define FONT_TYPE_UNKNOWN 0
543 /* Is GLYPH a space? */
545 #define CHAR_GLYPH_SPACE_P(GLYPH) \
546 ((GLYPH).u.ch == SPACEGLYPH && (GLYPH).face_id == DEFAULT_FACE_ID)
548 /* Are glyph slices of glyphs *X and *Y equal? It assumes that both
549 glyphs have the same type.
551 Note: for composition glyphs, we don't have to compare slice.cmp.to
552 because they should be the same if and only if slice.cmp.from are
555 #define GLYPH_SLICE_EQUAL_P(X, Y) \
556 ((X)->type == IMAGE_GLYPH \
557 ? ((X)->slice.img.x == (Y)->slice.img.x \
558 && (X)->slice.img.y == (Y)->slice.img.y \
559 && (X)->slice.img.width == (Y)->slice.img.width \
560 && (X)->slice.img.height == (Y)->slice.img.height) \
561 : ((X)->type != COMPOSITE_GLYPH \
562 || (X)->slice.cmp.from == (Y)->slice.cmp.from))
564 /* Are glyphs *X and *Y displayed equal? */
566 #define GLYPH_EQUAL_P(X, Y) \
567 ((X)->type == (Y)->type \
568 && (X)->u.val == (Y)->u.val \
569 && GLYPH_SLICE_EQUAL_P (X, Y) \
570 && (X)->face_id == (Y)->face_id \
571 && (X)->padding_p == (Y)->padding_p \
572 && (X)->left_box_line_p == (Y)->left_box_line_p \
573 && (X)->right_box_line_p == (Y)->right_box_line_p \
574 && (X)->voffset == (Y)->voffset \
575 && (X)->pixel_width == (Y)->pixel_width)
577 /* Are character codes, faces, padding_ps of glyphs *X and *Y equal? */
579 #define GLYPH_CHAR_AND_FACE_EQUAL_P(X, Y) \
580 ((X)->u.ch == (Y)->u.ch \
581 && (X)->face_id == (Y)->face_id \
582 && (X)->padding_p == (Y)->padding_p)
584 /* Fill a character glyph GLYPH. CODE, FACE_ID, PADDING_P correspond
585 to the bits defined for the typedef `GLYPH' in lisp.h. */
587 #define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P) \
590 (GLYPH).u.ch = (CODE); \
591 (GLYPH).face_id = (FACE_ID); \
592 (GLYPH).padding_p = (PADDING_P); \
596 /* Fill a character type glyph GLYPH from a glyph typedef FROM as
597 defined in lisp.h. */
599 #define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM) \
600 SET_CHAR_GLYPH ((GLYPH), \
601 GLYPH_CHAR ((FROM)), \
602 GLYPH_FACE ((FROM)), \
605 /* Construct a glyph code from a character glyph GLYPH. If the
606 character is multibyte, return -1 as we can't use glyph table for a
607 multibyte character. */
609 #define SET_GLYPH_FROM_CHAR_GLYPH(G, GLYPH) \
612 if ((GLYPH).u.ch < 256) \
613 SET_GLYPH ((G), (GLYPH).u.ch, ((GLYPH).face_id)); \
615 SET_GLYPH ((G), -1, 0); \
619 #define GLYPH_INVALID_P(GLYPH) (GLYPH_CHAR (GLYPH) < 0)
621 /* Is GLYPH a padding glyph? */
623 #define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p
628 /***********************************************************************
630 ***********************************************************************/
634 Glyph memory for frame-based redisplay is allocated from the heap
635 in one vector kept in a glyph pool structure which is stored with
636 the frame. The size of the vector is made large enough to cover
637 all windows on the frame.
639 Both frame and window glyph matrices reference memory from a glyph
640 pool in frame-based redisplay.
642 In window-based redisplay, no glyphs pools exist; windows allocate
643 and free their glyph memory themselves. */
647 /* Vector of glyphs allocated from the heap. */
648 struct glyph
*glyphs
;
650 /* Allocated size of `glyphs'. */
653 /* Number of rows and columns in a matrix. */
659 /***********************************************************************
661 ***********************************************************************/
665 Three kinds of glyph matrices exist:
667 1. Frame glyph matrices. These are used for terminal frames whose
668 redisplay needs a view of the whole screen due to limited terminal
669 capabilities. Frame matrices are used only in the update phase
670 of redisplay. They are built in update_frame and not used after
671 the update has been performed.
673 2. Window glyph matrices on frames having frame glyph matrices.
674 Such matrices are sub-matrices of their corresponding frame matrix,
675 i.e., frame glyph matrices and window glyph matrices share the same
676 glyph memory, which is allocated in the form of a glyph_pool structure.
677 Glyph rows in such a window matrix are slices of frame matrix rows.
679 2. Free-standing window glyph matrices managing their own glyph
680 storage. This form is used in window-based redisplay which
681 includes variable width and height fonts etc.
683 The size of a window's row vector depends on the height of fonts
684 defined on its frame. It is chosen so that the vector is large
685 enough to describe all lines in a window when it is displayed in
686 the smallest possible character size. When new fonts are loaded,
687 or window sizes change, the row vector is adjusted accordingly. */
691 /* The pool from which glyph memory is allocated, if any. This is
692 null for frame matrices and for window matrices managing their
694 struct glyph_pool
*pool
;
696 /* Vector of glyph row structures. The row at nrows - 1 is reserved
697 for the mode line. */
698 struct glyph_row
*rows
;
700 /* Number of elements allocated for the vector rows above. */
701 ptrdiff_t rows_allocated
;
703 /* The number of rows used by the window if all lines were displayed
704 with the smallest possible character height. */
707 /* Origin within the frame matrix if this is a window matrix on a
708 frame having a frame matrix. Both values are zero for
709 window-based redisplay. */
710 int matrix_x
, matrix_y
;
712 /* Width and height of the matrix in columns and rows. */
713 int matrix_w
, matrix_h
;
715 /* If this structure describes a window matrix of window W,
716 window_left_col is the value of W->left_col, window_top_line the
717 value of W->top_line, window_height and window_width are width and
718 height of W, as returned by window_box, and window_vscroll is the
719 value of W->vscroll at the time the matrix was last adjusted.
720 Only set for window-based redisplay. */
721 int window_left_col
, window_top_line
;
722 int window_height
, window_width
;
725 /* Number of glyphs reserved for left and right marginal areas when
726 the matrix was last adjusted. */
727 int left_margin_glyphs
, right_margin_glyphs
;
729 /* Flag indicating that scrolling should not be tried in
730 update_window. This flag is set by functions like try_window_id
731 which do their own scrolling. */
732 unsigned no_scrolling_p
: 1;
734 /* Non-zero means window displayed in this matrix has a top mode
736 unsigned header_line_p
: 1;
739 /* A string identifying the method used to display the matrix. */
743 /* The buffer this matrix displays. Set in
744 mark_window_display_accurate_1. */
745 struct buffer
*buffer
;
747 /* Values of BEGV and ZV as of last redisplay. Set in
748 mark_window_display_accurate_1. */
753 /* Check that glyph pointers stored in glyph rows of MATRIX are okay.
754 This aborts if any pointer is found twice. */
757 void check_matrix_pointer_lossage (struct glyph_matrix
*);
758 #define CHECK_MATRIX(MATRIX) check_matrix_pointer_lossage ((MATRIX))
760 #define CHECK_MATRIX(MATRIX) (void) 0
765 /***********************************************************************
767 ***********************************************************************/
769 /* Area in window glyph matrix. If values are added or removed,
770 the function mark_glyph_matrix in alloc.c may need to be changed. */
782 /* Rows of glyphs in a windows or frame glyph matrix.
784 Each row is partitioned into three areas. The start and end of
785 each area is recorded in a pointer as shown below.
787 +--------------------+-------------+---------------------+
788 | left margin area | text area | right margin area |
789 +--------------------+-------------+---------------------+
791 glyphs[LEFT_MARGIN_AREA] glyphs[RIGHT_MARGIN_AREA]
796 Rows in frame matrices reference glyph memory allocated in a frame
797 glyph pool (see the description of struct glyph_pool). Rows in
798 window matrices on frames having frame matrices reference slices of
799 the glyphs of corresponding rows in the frame matrix.
801 Rows in window matrices on frames having no frame matrices point to
802 glyphs allocated from the heap via xmalloc;
803 glyphs[LEFT_MARGIN_AREA] is the start address of the allocated
804 glyph structure array. */
808 /* Pointers to beginnings of areas. The end of an area A is found at
809 A + 1 in the vector. The last element of the vector is the end
812 Kludge alert: Even if used[TEXT_AREA] == 0, glyphs[TEXT_AREA][0]'s
813 position field is used. It is -1 if this row does not correspond
814 to any text; it is some buffer position if the row corresponds to
815 an empty display line that displays a line end. This is what old
816 redisplay used to do. (Except in code for terminal frames, this
817 kludge is no longer used, I believe. --gerd).
819 See also start, end, displays_text_p and ends_at_zv_p for cleaner
820 ways to do it. The special meaning of positions 0 and -1 will be
821 removed some day, so don't use it in new code. */
822 struct glyph
*glyphs
[1 + LAST_AREA
];
824 /* Number of glyphs actually filled in areas. */
825 short used
[LAST_AREA
];
827 /* Window-relative x and y-position of the top-left corner of this
828 row. If y < 0, this means that eabs (y) pixels of the row are
829 invisible because it is partially visible at the top of a window.
830 If x < 0, this means that eabs (x) pixels of the first glyph of
831 the text area of the row are invisible because the glyph is
832 partially visible. */
835 /* Width of the row in pixels without taking face extension at the
836 end of the row into account, and without counting truncation
837 and continuation glyphs at the end of a row on ttys. */
840 /* Logical ascent/height of this line. The value of ascent is zero
841 and height is 1 on terminal frames. */
844 /* Physical ascent/height of this line. If max_ascent > ascent,
845 this line overlaps the line above it on the display. Otherwise,
846 if max_height > height, this line overlaps the line beneath it. */
847 int phys_ascent
, phys_height
;
849 /* Portion of row that is visible. Partially visible rows may be
850 found at the top and bottom of a window. This is 1 for tty
851 frames. It may be < 0 in case of completely invisible rows. */
854 /* Extra line spacing added after this row. Do not consider this
855 in last row when checking if row is fully visible. */
856 int extra_line_spacing
;
858 /* Hash code. This hash code is available as soon as the row
859 is constructed, i.e. after a call to display_line. */
862 /* First position in this row. This is the text position, including
863 overlay position information etc, where the display of this row
864 started, and can thus be less than the position of the first
865 glyph (e.g. due to invisible text or horizontal scrolling).
866 BIDI Note: In R2L rows, that have its reversed_p flag set, this
867 position is at or beyond the right edge of the row. */
868 struct display_pos start
;
870 /* Text position at the end of this row. This is the position after
871 the last glyph on this row. It can be greater than the last
872 glyph position + 1, due to a newline that ends the line,
873 truncation, invisible text etc. In an up-to-date display, this
874 should always be equal to the start position of the next row.
875 BIDI Note: In R2L rows, this position is at or beyond the left
877 struct display_pos end
;
879 /* The smallest and the largest buffer positions that contributed to
880 glyphs in this row. Note that due to bidi reordering, these are
881 in general different from the text positions stored in `start'
882 and `end' members above, and also different from the buffer
883 positions recorded in the glyphs displayed the leftmost and
884 rightmost on the screen. */
885 struct text_pos minpos
, maxpos
;
887 /* Non-zero means the overlay arrow bitmap is on this line.
888 -1 means use default overlay arrow bitmap, else
889 it specifies actual fringe bitmap number. */
890 int overlay_arrow_bitmap
;
892 /* Left fringe bitmap number (enum fringe_bitmap_type). */
893 unsigned left_user_fringe_bitmap
: FRINGE_ID_BITS
;
895 /* Right fringe bitmap number (enum fringe_bitmap_type). */
896 unsigned right_user_fringe_bitmap
: FRINGE_ID_BITS
;
898 /* Left fringe bitmap number (enum fringe_bitmap_type). */
899 unsigned left_fringe_bitmap
: FRINGE_ID_BITS
;
901 /* Right fringe bitmap number (enum fringe_bitmap_type). */
902 unsigned right_fringe_bitmap
: FRINGE_ID_BITS
;
904 /* Face of the left fringe glyph. */
905 unsigned left_user_fringe_face_id
: FACE_ID_BITS
;
907 /* Face of the right fringe glyph. */
908 unsigned right_user_fringe_face_id
: FACE_ID_BITS
;
910 /* Face of the left fringe glyph. */
911 unsigned left_fringe_face_id
: FACE_ID_BITS
;
913 /* Face of the right fringe glyph. */
914 unsigned right_fringe_face_id
: FACE_ID_BITS
;
916 /* Vertical offset of the left fringe bitmap. */
917 signed left_fringe_offset
: FRINGE_HEIGHT_BITS
;
919 /* Vertical offset of the right fringe bitmap. */
920 signed right_fringe_offset
: FRINGE_HEIGHT_BITS
;
922 /* 1 means that at least one of the left and right fringe bitmaps is
923 periodic and thus depends on the y-position of the row. */
924 unsigned fringe_bitmap_periodic_p
: 1;
926 /* 1 means that we must draw the bitmaps of this row. */
927 unsigned redraw_fringe_bitmaps_p
: 1;
929 /* In a desired matrix, 1 means that this row must be updated. In a
930 current matrix, 0 means that the row has been invalidated, i.e.
931 the row's contents do not agree with what is visible on the
933 unsigned enabled_p
: 1;
935 /* 1 means row displays a text line that is truncated on the left or
937 unsigned truncated_on_left_p
: 1;
938 unsigned truncated_on_right_p
: 1;
940 /* 1 means that this row displays a continued line, i.e. it has a
941 continuation mark at the right side. */
942 unsigned continued_p
: 1;
944 /* 0 means that this row does not contain any text, i.e. it is
945 a blank line at the window and buffer end. */
946 unsigned displays_text_p
: 1;
948 /* 1 means that this line ends at ZV. */
949 unsigned ends_at_zv_p
: 1;
951 /* 1 means the face of the last glyph in the text area is drawn to
952 the right end of the window. This flag is used in
953 update_text_area to optimize clearing to the end of the area. */
954 unsigned fill_line_p
: 1;
956 /* Non-zero means display a bitmap on X frames indicating that this
957 line contains no text and ends in ZV. */
958 unsigned indicate_empty_line_p
: 1;
960 /* 1 means this row contains glyphs that overlap each other because
961 of lbearing or rbearing. */
962 unsigned contains_overlapping_glyphs_p
: 1;
964 /* 1 means this row is as wide as the window it is displayed in, including
965 scroll bars, fringes, and internal borders. This also
966 implies that the row doesn't have marginal areas. */
967 unsigned full_width_p
: 1;
969 /* Non-zero means row is a mode or header-line. */
970 unsigned mode_line_p
: 1;
972 /* 1 in a current row means this row is overlapped by another row. */
973 unsigned overlapped_p
: 1;
975 /* 1 means this line ends in the middle of a character consisting
976 of more than one glyph. Some glyphs have been put in this row,
977 the rest are put in rows below this one. */
978 unsigned ends_in_middle_of_char_p
: 1;
980 /* 1 means this line starts in the middle of a character consisting
981 of more than one glyph. Some glyphs have been put in the
982 previous row, the rest are put in this row. */
983 unsigned starts_in_middle_of_char_p
: 1;
985 /* 1 in a current row means this row overlaps others. */
986 unsigned overlapping_p
: 1;
988 /* 1 means some glyphs in this row are displayed in mouse-face. */
989 unsigned mouse_face_p
: 1;
991 /* 1 means this row was ended by a newline from a string. */
992 unsigned ends_in_newline_from_string_p
: 1;
994 /* 1 means this row width is exactly the width of the window, and the
995 final newline character is hidden in the right fringe. */
996 unsigned exact_window_width_line_p
: 1;
998 /* 1 means this row currently shows the cursor in the right fringe. */
999 unsigned cursor_in_fringe_p
: 1;
1001 /* 1 means the last glyph in the row is part of an ellipsis. */
1002 unsigned ends_in_ellipsis_p
: 1;
1004 /* Non-zero means display a bitmap on X frames indicating that this
1005 the first line of the buffer. */
1006 unsigned indicate_bob_p
: 1;
1008 /* Non-zero means display a bitmap on X frames indicating that this
1009 the top line of the window, but not start of the buffer. */
1010 unsigned indicate_top_line_p
: 1;
1012 /* Non-zero means display a bitmap on X frames indicating that this
1013 the last line of the buffer. */
1014 unsigned indicate_eob_p
: 1;
1016 /* Non-zero means display a bitmap on X frames indicating that this
1017 the bottom line of the window, but not end of the buffer. */
1018 unsigned indicate_bottom_line_p
: 1;
1020 /* Non-zero means the row was reversed to display text in a
1021 right-to-left paragraph. */
1022 unsigned reversed_p
: 1;
1024 /* Continuation lines width at the start of the row. */
1025 int continuation_lines_width
;
1027 #ifdef HAVE_WINDOW_SYSTEM
1028 /* Non-NULL means the current clipping area. This is temporarily
1029 set while exposing a region. Coordinates are frame-relative. */
1035 /* Get a pointer to row number ROW in matrix MATRIX. If GLYPH_DEBUG
1036 is defined, the function matrix_row checks that we don't try to
1037 access rows that are out of bounds. */
1040 struct glyph_row
*matrix_row (struct glyph_matrix
*, int);
1041 #define MATRIX_ROW(MATRIX, ROW) matrix_row ((MATRIX), (ROW))
1043 #define MATRIX_ROW(MATRIX, ROW) ((MATRIX)->rows + (ROW))
1046 /* Return a pointer to the row reserved for the mode line in MATRIX.
1047 Row MATRIX->nrows - 1 is always reserved for the mode line. */
1049 #define MATRIX_MODE_LINE_ROW(MATRIX) \
1050 ((MATRIX)->rows + (MATRIX)->nrows - 1)
1052 /* Return a pointer to the row reserved for the header line in MATRIX.
1053 This is always the first row in MATRIX because that's the only
1054 way that works in frame-based redisplay. */
1056 #define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows
1058 /* Return a pointer to first row in MATRIX used for text display. */
1060 #define MATRIX_FIRST_TEXT_ROW(MATRIX) \
1061 ((MATRIX)->rows->mode_line_p ? (MATRIX)->rows + 1 : (MATRIX)->rows)
1063 /* Return a pointer to the first glyph in the text area of a row.
1064 MATRIX is the glyph matrix accessed, and ROW is the row index in
1067 #define MATRIX_ROW_GLYPH_START(MATRIX, ROW) \
1068 (MATRIX_ROW ((MATRIX), (ROW))->glyphs[TEXT_AREA])
1070 /* Return the number of used glyphs in the text area of a row. */
1072 #define MATRIX_ROW_USED(MATRIX, ROW) \
1073 (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA])
1075 /* Return the character/ byte position at which the display of ROW
1076 starts. BIDI Note: this is the smallest character/byte position
1077 among characters in ROW, i.e. the first logical-order character
1078 displayed by ROW, which is not necessarily the smallest horizontal
1081 #define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->minpos.charpos)
1082 #define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->minpos.bytepos)
1084 /* Return the character/ byte position at which ROW ends. BIDI Note:
1085 this is the largest character/byte position among characters in
1086 ROW, i.e. the last logical-order character displayed by ROW, which
1087 is not necessarily the largest horizontal position. */
1089 #define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->maxpos.charpos)
1090 #define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->maxpos.bytepos)
1092 /* Return the vertical position of ROW in MATRIX. */
1094 #define MATRIX_ROW_VPOS(ROW, MATRIX) ((ROW) - (MATRIX)->rows)
1096 /* Return the last glyph row + 1 in MATRIX on window W reserved for
1097 text. If W has a mode line, the last row in the matrix is reserved
1100 #define MATRIX_BOTTOM_TEXT_ROW(MATRIX, W) \
1103 - (WINDOW_WANTS_MODELINE_P ((W)) ? 1 : 0))
1105 /* Non-zero if the face of the last glyph in ROW's text area has
1106 to be drawn to the end of the text area. */
1108 #define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)
1110 /* Set and query the enabled_p flag of glyph row ROW in MATRIX. */
1112 #define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
1113 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0)
1115 #define MATRIX_ROW_ENABLED_P(MATRIX, ROW) \
1116 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p)
1118 /* Non-zero if ROW displays text. Value is non-zero if the row is
1119 blank but displays a line end. */
1121 #define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)
1126 #define MR_PARTIALLY_VISIBLE(ROW) \
1127 ((ROW)->height != (ROW)->visible_height)
1129 #define MR_PARTIALLY_VISIBLE_AT_TOP(W, ROW) \
1130 ((ROW)->y < WINDOW_HEADER_LINE_HEIGHT ((W)))
1132 #define MR_PARTIALLY_VISIBLE_AT_BOTTOM(W, ROW) \
1133 (((ROW)->y + (ROW)->height - (ROW)->extra_line_spacing) \
1134 > WINDOW_BOX_HEIGHT_NO_MODE_LINE ((W)))
1136 /* Non-zero if ROW is not completely visible in window W. */
1138 #define MATRIX_ROW_PARTIALLY_VISIBLE_P(W, ROW) \
1139 (MR_PARTIALLY_VISIBLE ((ROW)) \
1140 && (MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)) \
1141 || MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW))))
1145 /* Non-zero if ROW is partially visible at the top of window W. */
1147 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW) \
1148 (MR_PARTIALLY_VISIBLE ((ROW)) \
1149 && MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)))
1151 /* Non-zero if ROW is partially visible at the bottom of window W. */
1153 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW) \
1154 (MR_PARTIALLY_VISIBLE ((ROW)) \
1155 && MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW)))
1157 /* Return the bottom Y + 1 of ROW. */
1159 #define MATRIX_ROW_BOTTOM_Y(ROW) ((ROW)->y + (ROW)->height)
1161 /* Is ROW the last visible one in the display described by the
1162 iterator structure pointed to by IT?. */
1164 #define MATRIX_ROW_LAST_VISIBLE_P(ROW, IT) \
1165 (MATRIX_ROW_BOTTOM_Y ((ROW)) >= (IT)->last_visible_y)
1167 /* Non-zero if ROW displays a continuation line. */
1169 #define MATRIX_ROW_CONTINUATION_LINE_P(ROW) \
1170 ((ROW)->continuation_lines_width > 0)
1172 /* Non-zero if ROW ends in the middle of a character. This is the
1173 case for continued lines showing only part of a display table entry
1174 or a control char, or an overlay string. */
1176 #define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW) \
1177 ((ROW)->end.dpvec_index > 0 \
1178 || (ROW)->end.overlay_string_index >= 0 \
1179 || (ROW)->ends_in_middle_of_char_p)
1181 /* Non-zero if ROW ends in the middle of an overlay string. */
1183 #define MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P(ROW) \
1184 ((ROW)->end.overlay_string_index >= 0)
1186 /* Non-zero if ROW starts in the middle of a character. See above. */
1188 #define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW) \
1189 ((ROW)->start.dpvec_index > 0 \
1190 || (ROW)->starts_in_middle_of_char_p \
1191 || ((ROW)->start.overlay_string_index >= 0 \
1192 && (ROW)->start.string_pos.charpos > 0))
1194 /* Non-zero means ROW overlaps its predecessor. */
1196 #define MATRIX_ROW_OVERLAPS_PRED_P(ROW) \
1197 ((ROW)->phys_ascent > (ROW)->ascent)
1199 /* Non-zero means ROW overlaps its successor. */
1201 #define MATRIX_ROW_OVERLAPS_SUCC_P(ROW) \
1202 ((ROW)->phys_height - (ROW)->phys_ascent \
1203 > (ROW)->height - (ROW)->ascent)
1205 /* A glyph for a space. */
1207 extern struct glyph space_glyph
;
1209 /* Non-zero means last display completed. Zero means it was
1212 extern bool display_completed
;
1216 /************************************************************************
1218 ************************************************************************/
1220 /* Enumeration for overriding/changing the face to use for drawing
1221 glyphs in draw_glyphs. */
1223 enum draw_glyphs_face
1233 #ifdef HAVE_WINDOW_SYSTEM
1235 /* A sequence of glyphs to be drawn in the same face. */
1239 /* X-origin of the string. */
1242 /* Y-origin and y-position of the base line of this string. */
1245 /* The width of the string, not including a face extension. */
1248 /* The width of the string, including a face extension. */
1249 int background_width
;
1251 /* The height of this string. This is the height of the line this
1252 string is drawn in, and can be different from the height of the
1253 font the string is drawn in. */
1256 /* Number of pixels this string overwrites in front of its x-origin.
1257 This number is zero if the string has an lbearing >= 0; it is
1258 -lbearing, if the string has an lbearing < 0. */
1261 /* Number of pixels this string overwrites past its right-most
1262 nominal x-position, i.e. x + width. Zero if the string's
1263 rbearing is <= its nominal width, rbearing - width otherwise. */
1266 /* The frame on which the glyph string is drawn. */
1269 /* The window on which the glyph string is drawn. */
1272 /* X display and window for convenience. */
1276 /* The glyph row for which this string was built. It determines the
1277 y-origin and height of the string. */
1278 struct glyph_row
*row
;
1280 /* The area within row. */
1281 enum glyph_row_area area
;
1283 /* Characters to be drawn, and number of characters. */
1287 /* A face-override for drawing cursors, mouse face and similar. */
1288 enum draw_glyphs_face hl
;
1290 /* Face in which this string is to be drawn. */
1293 /* Font in which this string is to be drawn. */
1296 /* Non-null means this string describes (part of) a static
1298 struct composition
*cmp
;
1300 /* If not negative, this string describes a compos. */
1303 /* Start and end glyph indices in a glyph-string. */
1304 int cmp_from
, cmp_to
;
1306 /* 1 means this glyph strings face has to be drawn to the right end
1307 of the window's drawing area. */
1308 unsigned extends_to_end_of_line_p
: 1;
1310 /* 1 means the background of this string has been drawn. */
1311 unsigned background_filled_p
: 1;
1313 /* 1 means glyph string must be drawn with 16-bit functions. */
1314 unsigned two_byte_p
: 1;
1316 /* 1 means that the original font determined for drawing this glyph
1317 string could not be loaded. The member `font' has been set to
1318 the frame's default font in this case. */
1319 unsigned font_not_found_p
: 1;
1321 /* 1 means that the face in which this glyph string is drawn has a
1323 unsigned stippled_p
: 1;
1325 #define OVERLAPS_PRED (1 << 0)
1326 #define OVERLAPS_SUCC (1 << 1)
1327 #define OVERLAPS_BOTH (OVERLAPS_PRED | OVERLAPS_SUCC)
1328 #define OVERLAPS_ERASED_CURSOR (1 << 2)
1329 /* Non-zero means only the foreground of this glyph string must be
1330 drawn, and we should use the physical height of the line this
1331 glyph string appears in as clip rect. If the value is
1332 OVERLAPS_ERASED_CURSOR, the clip rect is restricted to the rect
1333 of the erased cursor. OVERLAPS_PRED and OVERLAPS_SUCC mean we
1334 draw overlaps with the preceding and the succeeding rows,
1336 unsigned for_overlaps
: 3;
1338 /* 1 means that all glyphs in this glyph string has the flag
1339 padding_p set, and thus must be drawn one by one to have 1-pixel
1340 width even though the logical width in the font is zero. */
1341 unsigned padding_p
: 1;
1343 /* The GC to use for drawing this glyph string. */
1344 #if defined (HAVE_X_WINDOWS)
1347 #if defined (HAVE_NTGUI)
1352 /* A pointer to the first glyph in the string. This glyph
1353 corresponds to char2b[0]. Needed to draw rectangles if
1354 font_not_found_p is 1. */
1355 struct glyph
*first_glyph
;
1357 /* Image, if any. */
1360 #ifdef HAVE_XWIDGETS
1361 struct xwidget
* xwidget
;
1364 struct glyph_slice slice
;
1366 /* Non-null means the horizontal clipping region starts from the
1367 left edge of *clip_head, and ends with the right edge of
1368 *clip_tail, not including their overhangs. */
1369 struct glyph_string
*clip_head
, *clip_tail
;
1371 /* The current clipping areas. */
1372 NativeRectangle clip
[2];
1374 /* Number of clipping areas. */
1377 int underline_position
;
1379 int underline_thickness
;
1381 struct glyph_string
*next
, *prev
;
1384 #endif /* HAVE_WINDOW_SYSTEM */
1387 /************************************************************************
1389 ************************************************************************/
1391 /* Return the height of the mode line in glyph matrix MATRIX, or zero
1392 if not known. This macro is called under circumstances where
1393 MATRIX might not have been allocated yet. */
1395 #define MATRIX_MODE_LINE_HEIGHT(MATRIX) \
1396 ((MATRIX) && (MATRIX)->rows \
1397 ? MATRIX_MODE_LINE_ROW (MATRIX)->height \
1400 /* Return the height of the header line in glyph matrix MATRIX, or zero
1401 if not known. This macro is called under circumstances where
1402 MATRIX might not have been allocated yet. */
1404 #define MATRIX_HEADER_LINE_HEIGHT(MATRIX) \
1405 ((MATRIX) && (MATRIX)->rows \
1406 ? MATRIX_HEADER_LINE_ROW (MATRIX)->height \
1409 /* Return the desired face id for the mode line of a window, depending
1410 on whether the window is selected or not, or if the window is the
1411 scrolling window for the currently active minibuffer window.
1413 Due to the way display_mode_lines manipulates with the contents of
1414 selected_window, this macro needs three arguments: SELW which is
1415 compared against the current value of selected_window, MBW which is
1416 compared against minibuf_window (if SELW doesn't match), and SCRW
1417 which is compared against minibuf_selected_window (if MBW matches). */
1419 #define CURRENT_MODE_LINE_FACE_ID_3(SELW, MBW, SCRW) \
1420 ((!mode_line_in_non_selected_windows \
1421 || (SELW) == XWINDOW (selected_window) \
1422 || (minibuf_level > 0 \
1423 && !NILP (minibuf_selected_window) \
1424 && (MBW) == XWINDOW (minibuf_window) \
1425 && (SCRW) == XWINDOW (minibuf_selected_window))) \
1426 ? MODE_LINE_FACE_ID \
1427 : MODE_LINE_INACTIVE_FACE_ID)
1430 /* Return the desired face id for the mode line of window W. */
1432 #define CURRENT_MODE_LINE_FACE_ID(W) \
1433 (CURRENT_MODE_LINE_FACE_ID_3((W), XWINDOW (selected_window), (W)))
1435 /* Return the current height of the mode line of window W. If not known
1436 from W->mode_line_height, look at W's current glyph matrix, or return
1437 a default based on the height of the font of the face `mode-line'. */
1439 #define CURRENT_MODE_LINE_HEIGHT(W) \
1440 (W->mode_line_height >= 0 \
1441 ? W->mode_line_height \
1442 : (W->mode_line_height \
1443 = (MATRIX_MODE_LINE_HEIGHT (W->current_matrix) \
1444 ? MATRIX_MODE_LINE_HEIGHT (W->current_matrix) \
1445 : estimate_mode_line_height \
1446 (XFRAME (W->frame), CURRENT_MODE_LINE_FACE_ID (W)))))
1448 /* Return the current height of the header line of window W. If not known
1449 from W->header_line_height, look at W's current glyph matrix, or return
1450 an estimation based on the height of the font of the face `header-line'. */
1452 #define CURRENT_HEADER_LINE_HEIGHT(W) \
1453 (W->header_line_height >= 0 \
1454 ? W->header_line_height \
1455 : (W->header_line_height \
1456 = (MATRIX_HEADER_LINE_HEIGHT (W->current_matrix) \
1457 ? MATRIX_HEADER_LINE_HEIGHT (W->current_matrix) \
1458 : estimate_mode_line_height \
1459 (XFRAME (W->frame), HEADER_LINE_FACE_ID))))
1461 /* Return the height of the desired mode line of window W. */
1463 #define DESIRED_MODE_LINE_HEIGHT(W) \
1464 MATRIX_MODE_LINE_HEIGHT ((W)->desired_matrix)
1466 /* Return the height of the desired header line of window W. */
1468 #define DESIRED_HEADER_LINE_HEIGHT(W) \
1469 MATRIX_HEADER_LINE_HEIGHT ((W)->desired_matrix)
1471 /* Value is non-zero if window W wants a mode line. */
1473 #define WINDOW_WANTS_MODELINE_P(W) \
1474 (!MINI_WINDOW_P ((W)) \
1475 && !(W)->pseudo_window_p \
1476 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1477 && BUFFERP ((W)->contents) \
1478 && !NILP (BVAR (XBUFFER ((W)->contents), mode_line_format)) \
1479 && WINDOW_TOTAL_LINES (W) > 1)
1481 /* Value is true if window W wants a header line. */
1483 #define WINDOW_WANTS_HEADER_LINE_P(W) \
1484 (BUFFERP ((W)->contents) \
1485 ? (!MINI_WINDOW_P ((W)) \
1486 && !(W)->pseudo_window_p \
1487 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1488 && !NILP (BVAR (XBUFFER ((W)->contents), header_line_format)) \
1489 && WINDOW_TOTAL_LINES (W) > \
1490 (1 + !NILP (BVAR (XBUFFER ((W)->contents), mode_line_format)))) \
1493 /* Return proper value to be used as baseline offset of font that has
1494 ASCENT and DESCENT to draw characters by the font at the vertical
1495 center of the line of frame F.
1497 Here, our task is to find the value of BOFF in the following figure;
1499 -------------------------+-----------+-
1500 -+-+---------+-+ | |
1502 | | | | F_ASCENT F_HEIGHT
1505 | | |-|-+------+-----------|------- baseline
1507 | |---------|-+-+ | |
1509 -+-+---------+-+ F_DESCENT |
1510 -------------------------+-----------+-
1512 -BOFF + DESCENT + (F_HEIGHT - HEIGHT) / 2 = F_DESCENT
1513 BOFF = DESCENT + (F_HEIGHT - HEIGHT) / 2 - F_DESCENT
1514 DESCENT = FONT->descent
1515 HEIGHT = FONT_HEIGHT (FONT)
1516 F_DESCENT = (FRAME_FONT (F)->descent
1517 - F->terminal->output_data.x->baseline_offset)
1518 F_HEIGHT = FRAME_LINE_HEIGHT (F)
1521 #define VCENTER_BASELINE_OFFSET(FONT, F) \
1522 (FONT_DESCENT (FONT) \
1523 + (FRAME_LINE_HEIGHT ((F)) - FONT_HEIGHT ((FONT)) \
1524 + (FRAME_LINE_HEIGHT ((F)) > FONT_HEIGHT ((FONT)))) / 2 \
1525 - (FONT_DESCENT (FRAME_FONT (F)) - FRAME_BASELINE_OFFSET (F)))
1528 /***********************************************************************
1530 ***********************************************************************/
1532 /* Indices of face attributes in Lisp face vectors. Slot zero is the
1535 enum lface_attribute_index
1537 LFACE_FAMILY_INDEX
= 1,
1538 LFACE_FOUNDRY_INDEX
,
1543 LFACE_UNDERLINE_INDEX
,
1544 LFACE_INVERSE_INDEX
,
1545 LFACE_FOREGROUND_INDEX
,
1546 LFACE_BACKGROUND_INDEX
,
1547 LFACE_STIPPLE_INDEX
,
1548 LFACE_OVERLINE_INDEX
,
1549 LFACE_STRIKE_THROUGH_INDEX
,
1552 LFACE_INHERIT_INDEX
,
1553 LFACE_FONTSET_INDEX
,
1558 /* Box types of faces. */
1562 /* No box around text. */
1565 /* Simple box of specified width and color. Default width is 1, and
1566 default color is the foreground color of the face. */
1569 /* Boxes with 3D shadows. Color equals the background color of the
1570 face. Width is specified. */
1575 /* Underline type. */
1577 enum face_underline_type
1583 /* Structure describing a realized face.
1585 For each Lisp face, 0..N realized faces can exist for different
1586 frames and different charsets. Realized faces are built from Lisp
1587 faces and text properties/overlays by merging faces and adding
1588 unspecified attributes from the `default' face. */
1592 /* The id of this face. The id equals the index of this face in the
1593 vector faces_by_id of its face cache. */
1596 #ifdef HAVE_WINDOW_SYSTEM
1598 /* If non-zero, this is a GC that we can use without modification for
1599 drawing the characters in this face. */
1602 /* Background stipple or bitmap used for this face. This is
1603 an id as returned from load_pixmap. */
1606 #else /* not HAVE_WINDOW_SYSTEM */
1611 #endif /* not HAVE_WINDOW_SYSTEM */
1613 /* Pixel value of foreground color for X frames. Color index
1615 unsigned long foreground
;
1617 /* Pixel value or color index of background color. */
1618 unsigned long background
;
1620 /* Pixel value or color index of underline color. */
1621 unsigned long underline_color
;
1623 /* Pixel value or color index of overlined, strike-through, or box
1625 unsigned long overline_color
;
1626 unsigned long strike_through_color
;
1627 unsigned long box_color
;
1631 /* Fontset ID if for this face's fontset. Non-ASCII faces derived
1632 from the same ASCII face have the same fontset. */
1635 /* Pixmap width and height. */
1636 unsigned int pixmap_w
, pixmap_h
;
1638 /* Non-zero means characters in this face have a box of that
1639 thickness around them. If this value is negative, its absolute
1640 value indicates the thickness, and the horizontal (top and
1641 bottom) borders of box are drawn inside of the character glyphs'
1642 area. The vertical (left and right) borders of the box are drawn
1643 in the same way as when this value is positive. */
1646 /* Type of box drawn. A value of FACE_NO_BOX means no box is drawn
1647 around text in this face. A value of FACE_SIMPLE_BOX means a box
1648 of width box_line_width is drawn in color box_color. A value of
1649 FACE_RAISED_BOX or FACE_SUNKEN_BOX means a 3D box is drawn with
1650 shadow colors derived from the background color of the face. */
1651 enum face_box_type box
;
1653 /* Style of underlining. */
1654 enum face_underline_type underline_type
;
1656 /* If `box' above specifies a 3D type, 1 means use box_color for
1658 unsigned use_box_color_for_shadows_p
: 1;
1660 /* Non-zero if text in this face should be underlined, overlined,
1661 strike-through or have a box drawn around it. */
1662 unsigned underline_p
: 1;
1663 unsigned overline_p
: 1;
1664 unsigned strike_through_p
: 1;
1666 /* 1 means that the colors specified for this face could not be
1667 loaded, and were replaced by default colors, so they shouldn't be
1669 unsigned foreground_defaulted_p
: 1;
1670 unsigned background_defaulted_p
: 1;
1672 /* 1 means that either no color is specified for underlining or that
1673 the specified color couldn't be loaded. Use the foreground
1674 color when drawing in that case. */
1675 unsigned underline_defaulted_p
: 1;
1677 /* 1 means that either no color is specified for the corresponding
1678 attribute or that the specified color couldn't be loaded.
1679 Use the foreground color when drawing in that case. */
1680 unsigned overline_color_defaulted_p
: 1;
1681 unsigned strike_through_color_defaulted_p
: 1;
1682 unsigned box_color_defaulted_p
: 1;
1684 /* TTY appearances. Colors are found in `lface' with empty color
1685 string meaning the default color of the TTY. */
1686 unsigned tty_bold_p
: 1;
1687 unsigned tty_italic_p
: 1;
1688 unsigned tty_underline_p
: 1;
1689 unsigned tty_reverse_p
: 1;
1691 /* 1 means that colors of this face may not be freed because they
1692 have been copied bitwise from a base face (see
1694 unsigned colors_copied_bitwise_p
: 1;
1696 /* If non-zero, use overstrike (to simulate bold-face). */
1697 unsigned overstrike
: 1;
1699 /* NOTE: this is not used yet, but eventually this impl should be done
1700 similarly to overstrike */
1702 /* If non-zero, use geometric rotation (to simulate italic). */
1703 unsigned synth_ital
: 1;
1706 /* The Lisp face attributes this face realizes. All attributes
1707 in this vector are non-nil. */
1708 Lisp_Object lface
[LFACE_VECTOR_SIZE
];
1710 /* The hash value of this face. */
1713 /* Next and previous face in hash collision list of face cache. */
1714 struct face
*next
, *prev
;
1716 /* If this face is an ASCII face, this points to this face itself.
1717 Otherwise, this points to an ASCII face that has the same
1718 attributes except the font. */
1719 struct face
*ascii_face
;
1721 /* Extra member that a font-driver uses privately. */
1726 /* Color index indicating that face uses a terminal's default color. */
1728 #define FACE_TTY_DEFAULT_COLOR ((unsigned long) -1)
1730 /* Color index indicating that face uses an unknown foreground color. */
1732 #define FACE_TTY_DEFAULT_FG_COLOR ((unsigned long) -2)
1734 /* Color index indicating that face uses an unknown background color. */
1736 #define FACE_TTY_DEFAULT_BG_COLOR ((unsigned long) -3)
1738 /* Non-zero if FACE was realized for unibyte use. */
1740 #define FACE_UNIBYTE_P(FACE) ((FACE)->charset < 0)
1743 /* IDs of important faces known by the C face code. These are the IDs
1744 of the faces for CHARSET_ASCII. */
1750 MODE_LINE_INACTIVE_FACE_ID
,
1753 HEADER_LINE_FACE_ID
,
1759 VERTICAL_BORDER_FACE_ID
,
1760 BASIC_FACE_ID_SENTINEL
1763 #define MAX_FACE_ID ((1 << FACE_ID_BITS) - 1)
1765 /* A cache of realized faces. Each frame has its own cache because
1766 Emacs allows different frame-local face definitions. */
1770 /* Hash table of cached realized faces. */
1771 struct face
**buckets
;
1773 /* Back-pointer to the frame this cache belongs to. */
1776 /* A vector of faces so that faces can be referenced by an ID. */
1777 struct face
**faces_by_id
;
1779 /* The allocated size, and number of used slots of faces_by_id. */
1783 /* Flag indicating that attributes of the `menu' face have been
1785 unsigned menu_face_changed_p
: 1;
1789 /* Prepare face FACE for use on frame F. This must be called before
1790 using X resources of FACE. */
1792 #define PREPARE_FACE_FOR_DISPLAY(F, FACE) \
1793 if ((FACE)->gc == 0) \
1794 prepare_face_for_display ((F), (FACE)); \
1798 /* Return a pointer to the face with ID on frame F, or null if such a
1799 face doesn't exist. */
1801 #define FACE_FROM_ID(F, ID) \
1802 (UNSIGNED_CMP (ID, <, FRAME_FACE_CACHE (F)->used) \
1803 ? FRAME_FACE_CACHE (F)->faces_by_id[ID] \
1806 #ifdef HAVE_WINDOW_SYSTEM
1808 /* Non-zero if FACE is suitable for displaying character CHAR. */
1810 #define FACE_SUITABLE_FOR_ASCII_CHAR_P(FACE, CHAR) \
1811 ((FACE) == (FACE)->ascii_face)
1813 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) \
1814 (ASCII_CHAR_P (CHAR) \
1815 ? FACE_SUITABLE_FOR_ASCII_CHAR_P(FACE) \
1816 : face_suitable_for_char_p ((FACE), (CHAR)))
1818 /* Return the id of the realized face on frame F that is like the face
1819 with id ID but is suitable for displaying character CHAR.
1820 This macro is only meaningful for multibyte character CHAR. */
1822 #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) \
1823 ((ASCII_CHAR_P (CHAR) || CHAR_BYTE8_P (CHAR)) \
1824 ? (FACE)->ascii_face->id \
1825 : face_for_char ((F), (FACE), (CHAR), (POS), (OBJECT)))
1827 #else /* not HAVE_WINDOW_SYSTEM */
1829 #define FACE_SUITABLE_FOR_ASCII_CHAR_P(FACE, CHAR) 1
1830 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) 1
1831 #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) ((FACE)->id)
1833 #endif /* not HAVE_WINDOW_SYSTEM */
1835 /* Return true if G contains a valid character code. */
1836 DISPEXTERN_INLINE
bool
1837 GLYPH_CHAR_VALID_P (GLYPH g
)
1839 return CHAR_VALID_P (GLYPH_CHAR (g
));
1842 /* The glyph code from a display vector may either be an integer which
1843 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1844 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1846 DISPEXTERN_INLINE
bool
1847 GLYPH_CODE_P (Lisp_Object gc
)
1850 ? (CHARACTERP (XCAR (gc
))
1851 && RANGED_INTEGERP (0, XCDR (gc
), MAX_FACE_ID
))
1854 (MAX_FACE_ID
< TYPE_MAXIMUM (EMACS_INT
) >> CHARACTERBITS
1855 ? ((EMACS_INT
) MAX_FACE_ID
<< CHARACTERBITS
) | MAX_CHAR
1856 : TYPE_MAXIMUM (EMACS_INT
)))));
1859 /* Non-zero means face attributes have been changed since the last
1860 redisplay. Used in redisplay_internal. */
1862 extern int face_change_count
;
1864 /* For reordering of bidirectional text. */
1865 #define BIDI_MAXLEVEL 64
1867 /* Data type for describing the bidirectional character types. The
1868 first 7 must be at the beginning, because they are the only values
1869 valid in the `bidi_type' member of `struct glyph'; we only reserve
1870 3 bits for it, so we cannot use there values larger than 7.
1872 The order of members must be in sync with the 8th element of the
1873 member of unidata-prop-alist (in admin/unidata/unidata-gen.el) for
1874 Unicode character property `bidi-class'. */
1877 STRONG_L
, /* strong left-to-right */
1878 STRONG_R
, /* strong right-to-left */
1879 WEAK_EN
, /* european number */
1880 WEAK_AN
, /* arabic number */
1881 WEAK_BN
, /* boundary neutral */
1882 NEUTRAL_B
, /* paragraph separator */
1883 STRONG_AL
, /* arabic right-to-left letter */
1884 LRE
, /* left-to-right embedding */
1885 LRO
, /* left-to-right override */
1886 RLE
, /* right-to-left embedding */
1887 RLO
, /* right-to-left override */
1888 PDF
, /* pop directional format */
1889 WEAK_ES
, /* european number separator */
1890 WEAK_ET
, /* european number terminator */
1891 WEAK_CS
, /* common separator */
1892 WEAK_NSM
, /* non-spacing mark */
1893 NEUTRAL_S
, /* segment separator */
1894 NEUTRAL_WS
, /* whitespace */
1895 NEUTRAL_ON
/* other neutrals */
1898 /* The basic directionality data type. */
1899 typedef enum { NEUTRAL_DIR
, L2R
, R2L
} bidi_dir_t
;
1901 /* Data type for storing information about characters we need to
1903 struct bidi_saved_info
{
1904 ptrdiff_t bytepos
, charpos
; /* character's buffer position */
1905 bidi_type_t type
; /* character's resolved bidi type */
1906 bidi_type_t type_after_w1
; /* original type of the character, after W1 */
1907 bidi_type_t orig_type
; /* type as we found it in the buffer */
1910 /* Data type for keeping track of saved embedding levels and override
1911 status information. */
1914 bidi_dir_t override
;
1917 /* Data type for storing information about a string being iterated on. */
1918 struct bidi_string_data
{
1919 Lisp_Object lstring
; /* Lisp string to reorder, or nil */
1920 const unsigned char *s
; /* string data, or NULL if reordering buffer */
1921 ptrdiff_t schars
; /* the number of characters in the string,
1922 excluding the terminating null */
1923 ptrdiff_t bufpos
; /* buffer position of lstring, or 0 if N/A */
1924 unsigned from_disp_str
: 1; /* 1 means the string comes from a
1926 unsigned unibyte
: 1; /* 1 means the string is unibyte */
1929 /* Data type for reordering bidirectional text. */
1931 ptrdiff_t bytepos
; /* iterator's position in buffer/string */
1933 int ch
; /* character at that position, or u+FFFC
1934 ("object replacement character") for a run
1935 of characters covered by a display string */
1936 ptrdiff_t nchars
; /* its "length", usually 1; it's > 1 for a run
1937 of characters covered by a display string */
1938 ptrdiff_t ch_len
; /* its length in bytes */
1939 bidi_type_t type
; /* bidi type of this character, after
1940 resolving weak and neutral types */
1941 bidi_type_t type_after_w1
; /* original type, after overrides and W1 */
1942 bidi_type_t orig_type
; /* original type, as found in the buffer */
1943 int resolved_level
; /* final resolved level of this character */
1944 int invalid_levels
; /* how many PDFs to ignore */
1945 int invalid_rl_levels
; /* how many PDFs from RLE/RLO to ignore */
1946 struct bidi_saved_info prev
; /* info about previous character */
1947 struct bidi_saved_info last_strong
; /* last-seen strong directional char */
1948 struct bidi_saved_info next_for_neutral
; /* surrounding characters for... */
1949 struct bidi_saved_info prev_for_neutral
; /* ...resolving neutrals */
1950 struct bidi_saved_info next_for_ws
; /* character after sequence of ws */
1951 ptrdiff_t next_en_pos
; /* pos. of next char for determining ET type */
1952 bidi_type_t next_en_type
; /* type of char at next_en_pos */
1953 ptrdiff_t ignore_bn_limit
; /* position until which to ignore BNs */
1954 bidi_dir_t sor
; /* direction of start-of-run in effect */
1955 int scan_dir
; /* direction of text scan, 1: forw, -1: back */
1956 ptrdiff_t disp_pos
; /* position of display string after ch */
1957 int disp_prop
; /* if non-zero, there really is a
1958 `display' property/string at disp_pos;
1959 if 2, the property is a `space' spec */
1960 int stack_idx
; /* index of current data on the stack */
1961 /* Note: Everything from here on is not copied/saved when the bidi
1962 iterator state is saved, pushed, or popped. So only put here
1963 stuff that is not part of the bidi iterator's state! */
1964 struct bidi_stack level_stack
[BIDI_MAXLEVEL
]; /* stack of embedding levels */
1965 struct bidi_string_data string
; /* string to reorder */
1966 struct window
*w
; /* the window being displayed */
1967 bidi_dir_t paragraph_dir
; /* current paragraph direction */
1968 ptrdiff_t separator_limit
; /* where paragraph separator should end */
1969 unsigned prev_was_pdf
: 1; /* if non-zero, previous char was PDF */
1970 unsigned first_elt
: 1; /* if non-zero, examine current char first */
1971 unsigned new_paragraph
: 1; /* if non-zero, we expect a new paragraph */
1972 unsigned frame_window_p
: 1; /* non-zero if displaying on a GUI frame */
1975 /* Value is non-zero when the bidi iterator is at base paragraph
1977 #define BIDI_AT_BASE_LEVEL(BIDI_IT) \
1978 ((BIDI_IT).resolved_level == (BIDI_IT).level_stack[0].level)
1981 /***********************************************************************
1983 ***********************************************************************/
1985 /* Structure used to describe where and how to draw a fringe bitmap.
1986 WHICH is the fringe bitmap to draw. WD and H is the (adjusted)
1987 width and height of the bitmap, DH is the height adjustment (if
1988 bitmap is periodic). X and Y are frame coordinates of the area to
1989 display the bitmap, DY is relative offset of the bitmap into that
1990 area. BX, NX, BY, NY specifies the area to clear if the bitmap
1991 does not fill the entire area. FACE is the fringe face. */
1993 struct draw_fringe_bitmap_params
1995 int which
; /* enum fringe_bitmap_type */
1996 unsigned short *bits
;
2000 unsigned cursor_p
: 1;
2001 unsigned overlay_p
: 1;
2005 #define MAX_FRINGE_BITMAPS (1<<FRINGE_ID_BITS)
2008 /***********************************************************************
2010 ***********************************************************************/
2012 /* Iteration over things to display in current_buffer or in a string.
2014 The iterator handles:
2016 1. Overlay strings (after-string, before-string).
2018 3. Invisible text properties.
2019 4. Selective display.
2020 5. Translation of characters via display tables.
2021 6. Translation of control characters to the forms `\003' or `^C'.
2022 7. `glyph' and `space-width' properties.
2024 Iterators are initialized by calling init_iterator or one of the
2025 equivalent functions below. A call to get_next_display_element
2026 loads the iterator structure with information about what next to
2027 display. A call to set_iterator_to_next increments the iterator's
2030 Characters from overlay strings, display table entries or control
2031 character translations are returned one at a time. For example, if
2032 we have a text of `a\x01' where `a' has a display table definition
2033 of `cd' and the control character is displayed with a leading
2034 arrow, then the iterator will return:
2036 Call Return Source Call next
2037 -----------------------------------------------------------------
2038 next c display table move
2039 next d display table move
2040 next ^ control char move
2041 next A control char move
2043 The same mechanism is also used to return characters for ellipses
2044 displayed at the end of invisible text.
2046 CAVEAT: Under some circumstances, move_.* functions can be called
2047 asynchronously, e.g. when computing a buffer position from an x and
2048 y pixel position. This means that these functions and functions
2049 called from them SHOULD NOT USE xmalloc and alike. See also the
2050 comment at the start of xdisp.c. */
2052 /* Enumeration describing what kind of display element an iterator is
2053 loaded with after a call to get_next_display_element. */
2055 enum display_element_type
2057 /* A normal character. */
2060 /* A composition (static and automatic). */
2063 /* A glyphless character (e.g. ZWNJ, LRE). */
2069 /* A flexible width and height space. */
2072 /* End of buffer or string. */
2075 /* Truncation glyphs. Never returned by get_next_display_element.
2076 Used to get display information about truncation glyphs via
2080 /* Continuation glyphs. See the comment for IT_TRUNCATION. */
2083 #ifdef HAVE_XWIDGETS
2089 /* An enumerator for each text property that has a meaning for display
2098 COMPOSITION_PROP_IDX
,
2100 /* Not a property. Used to indicate changes in overlays. */
2107 /* An enumerator for the method of wrapping long lines. */
2109 enum line_wrap_method
2116 /* An enumerator for the method of displaying glyphless characters. */
2118 enum glyphless_display_method
2120 /* Display a thin (1-pixel width) space. On a TTY, display a
2121 1-character width space. */
2122 GLYPHLESS_DISPLAY_THIN_SPACE
,
2123 /* Display an empty box of proper width. */
2124 GLYPHLESS_DISPLAY_EMPTY_BOX
,
2125 /* Display an acronym string in a box. */
2126 GLYPHLESS_DISPLAY_ACRONYM
,
2127 /* Display the hexadecimal code of the character in a box. */
2128 GLYPHLESS_DISPLAY_HEX_CODE
2139 /* Input sources for fetching characters or data to display.
2140 The input source is found in the `method' field. */
2143 GET_FROM_BUFFER
= 0,
2144 GET_FROM_DISPLAY_VECTOR
,
2149 #ifdef HAVE_XWIDGETS
2155 /* FIXME: What is this? Why 5? */
2156 #define IT_STACK_SIZE 5
2158 /* Iterator for composition (both for static and automatic). */
2159 struct composition_it
2161 /* Next position at which to check the composition. */
2163 /* ID number of the composition or glyph-string. If negative, we
2164 are not iterating over a composition now. */
2166 /* If non-negative, character that triggers the automatic
2167 composition at `stop_pos', and this is an automatic composition.
2168 If negative, this is a static composition. This is set to -2
2169 temporarily if searching of composition reach a limit or a
2172 /* If this is an automatic composition, index of a rule for making
2173 the automatic composition. Provided that ELT is an element of
2174 Vcomposition_function_table for CH, (nth ELT RULE_IDX) is the
2175 rule for the composition. */
2177 /* If this is an automatic composition, how many characters to look
2178 back from the position where a character triggering the
2179 composition exists. */
2181 /* If non-negative, number of glyphs of the glyph-string. */
2183 /* True iff the composition is created while buffer is scanned in
2184 reverse order, and thus the grapheme clusters must be rendered
2185 from the last to the first. */
2188 /** The following members contain information about the current
2189 grapheme cluster. */
2190 /* Position of the first character of the current grapheme cluster. */
2192 /* Number of characters and bytes of the current grapheme cluster. */
2194 /* Indices of the glyphs for the current grapheme cluster. */
2196 /* Width of the current grapheme cluster in units of pixels on a
2197 graphic display and in units of canonical characters on a
2198 terminal display. */
2204 /* The window in which we iterate over current_buffer (or a string). */
2208 /* The window's frame. */
2211 /* Method to use to load this structure with the next display element. */
2212 enum it_method method
;
2214 /* The next position at which to check for face changes, invisible
2215 text, overlay strings, end of text etc., which see. */
2216 ptrdiff_t stop_charpos
;
2218 /* Previous stop position, i.e. the last one before the current
2219 iterator position in `current'. */
2220 ptrdiff_t prev_stop
;
2222 /* Last stop position iterated across whose bidi embedding level is
2223 equal to the current paragraph's base embedding level. */
2224 ptrdiff_t base_level_stop
;
2226 /* Maximum string or buffer position + 1. ZV when iterating over
2228 ptrdiff_t end_charpos
;
2230 /* C string to iterate over. Non-null means get characters from
2231 this string, otherwise characters are read from current_buffer
2233 const unsigned char *s
;
2235 /* Number of characters in the string (s, or it->string) we iterate
2236 over. Used only in display_string and its subroutines; never
2237 used for overlay strings and strings from display properties. */
2238 ptrdiff_t string_nchars
;
2240 /* Start and end of a visible region; -1 if the region is not
2241 visible in the window. */
2242 ptrdiff_t region_beg_charpos
, region_end_charpos
;
2244 /* Position at which redisplay end trigger functions should be run. */
2245 ptrdiff_t redisplay_end_trigger_charpos
;
2247 /* 1 means multibyte characters are enabled. */
2248 unsigned multibyte_p
: 1;
2250 /* 1 means window has a mode line at its top. */
2251 unsigned header_line_p
: 1;
2253 /* 1 means `string' is the value of a `display' property.
2254 Don't handle some `display' properties in these strings. */
2255 unsigned string_from_display_prop_p
: 1;
2257 /* 1 means `string' comes from a `line-prefix' or `wrap-prefix'
2259 unsigned string_from_prefix_prop_p
: 1;
2261 /* 1 means we are iterating an object that came from a value of a
2262 `display' property. */
2263 unsigned from_disp_prop_p
: 1;
2265 /* When METHOD == next_element_from_display_vector,
2266 this is 1 if we're doing an ellipsis. Otherwise meaningless. */
2267 unsigned ellipsis_p
: 1;
2269 /* True means cursor shouldn't be displayed here. */
2270 unsigned avoid_cursor_p
: 1;
2272 /* Display table in effect or null for none. */
2273 struct Lisp_Char_Table
*dp
;
2275 /* Current display table vector to return characters from and its
2276 end. dpvec null means we are not returning characters from a
2277 display table entry; current.dpvec_index gives the current index
2278 into dpvec. This same mechanism is also used to return
2279 characters from translated control characters, i.e. `\003' or
2281 Lisp_Object
*dpvec
, *dpend
;
2283 /* Length in bytes of the char that filled dpvec. A value of zero
2284 means that no such character is involved. A negative value means
2285 the rest of the line from the current iterator position onwards
2286 is hidden by selective display or ellipsis. */
2289 /* Face id to use for all characters in display vector. -1 if unused. */
2292 /* Face id of the iterator saved in case a glyph from dpvec contains
2293 a face. The face is restored when all glyphs from dpvec have
2297 /* Vector of glyphs for control character translation. The pointer
2298 dpvec is set to ctl_chars when a control character is translated.
2299 This vector is also used for incomplete multibyte character
2300 translation (e.g \222\244). Such a character is at most 4 bytes,
2301 thus we need at most 16 bytes here. */
2302 Lisp_Object ctl_chars
[16];
2304 /* Initial buffer or string position of the iterator, before skipping
2305 over display properties and invisible text. */
2306 struct display_pos start
;
2308 /* Current buffer or string position of the iterator, including
2309 position in overlay strings etc. */
2310 struct display_pos current
;
2312 /* Total number of overlay strings to process. This can be >
2313 OVERLAY_STRING_CHUNK_SIZE. Value is dependable only when
2314 current.overlay_string_index >= 0. Use the latter to determine
2315 whether an overlay string is being iterated over, because
2316 n_overlay_strings can be positive even when we are not rendering
2317 an overlay string. */
2318 ptrdiff_t n_overlay_strings
;
2320 /* The charpos where n_overlay_strings was calculated. This should
2321 be set at the same time as n_overlay_strings. It is needed
2322 because we show before-strings at the start of invisible text;
2323 see handle_invisible_prop in xdisp.c. */
2324 ptrdiff_t overlay_strings_charpos
;
2326 /* Vector of overlays to process. Overlay strings are processed
2327 OVERLAY_STRING_CHUNK_SIZE at a time. */
2328 #define OVERLAY_STRING_CHUNK_SIZE 16
2329 Lisp_Object overlay_strings
[OVERLAY_STRING_CHUNK_SIZE
];
2331 /* For each overlay string, the overlay it came from. */
2332 Lisp_Object string_overlays
[OVERLAY_STRING_CHUNK_SIZE
];
2334 /* If non-nil, a Lisp string being processed. If
2335 current.overlay_string_index >= 0, this is an overlay string from
2336 pos. Use STRINGP (it.string) to test whether we are rendering a
2337 string or something else; do NOT use BUFFERP (it.object). */
2340 /* If non-nil, we are processing a string that came
2341 from a `display' property given by an overlay. */
2342 Lisp_Object from_overlay
;
2344 /* Stack of saved values. New entries are pushed when we begin to
2345 process an overlay string or a string from a `glyph' property.
2346 Entries are popped when we return to deliver display elements
2347 from what we previously had. */
2348 struct iterator_stack_entry
2352 ptrdiff_t end_charpos
;
2353 ptrdiff_t stop_charpos
;
2354 ptrdiff_t prev_stop
;
2355 ptrdiff_t base_level_stop
;
2356 struct composition_it cmp_it
;
2359 /* Save values specific to a given method. */
2361 /* method == GET_FROM_IMAGE */
2364 struct it_slice slice
;
2367 /* method == GET_FROM_COMPOSITION */
2371 /* method == GET_FROM_STRETCH */
2375 #ifdef HAVE_XWIDGETS
2376 /* method == GET_FROM_XWIDGET */
2379 struct xwidget
* xwidget
;
2384 /* current text and display positions. */
2385 struct text_pos position
;
2386 struct display_pos current
;
2387 Lisp_Object from_overlay
;
2388 enum glyph_row_area area
;
2389 enum it_method method
;
2390 bidi_dir_t paragraph_embedding
;
2391 unsigned multibyte_p
: 1;
2392 unsigned string_from_display_prop_p
: 1;
2393 unsigned string_from_prefix_prop_p
: 1;
2394 unsigned display_ellipsis_p
: 1;
2395 unsigned avoid_cursor_p
: 1;
2397 unsigned from_disp_prop_p
: 1;
2398 enum line_wrap_method line_wrap
;
2400 /* properties from display property that are reset by another display property. */
2402 Lisp_Object space_width
;
2403 Lisp_Object font_height
;
2405 stack
[IT_STACK_SIZE
];
2407 /* Stack pointer. */
2410 /* -1 means selective display hides everything between a \r and the
2411 next newline; > 0 means hide lines indented more than that value. */
2412 ptrdiff_t selective
;
2414 /* An enumeration describing what the next display element is
2415 after a call to get_next_display_element. */
2416 enum display_element_type what
;
2421 /* Setting of buffer-local variable selective-display-ellipsis. */
2422 unsigned selective_display_ellipsis_p
: 1;
2424 /* 1 means control characters are translated into the form `^C'
2425 where the `^' can be replaced by a display table entry. */
2426 unsigned ctl_arrow_p
: 1;
2428 /* Non-zero means that the current face has a box. */
2429 unsigned face_box_p
: 1;
2431 /* Non-null means that the current character is the first in a run
2432 of characters with box face. */
2433 unsigned start_of_box_run_p
: 1;
2435 /* Non-zero means that the current character is the last in a run
2436 of characters with box face. */
2437 unsigned end_of_box_run_p
: 1;
2439 /* 1 means overlay strings at end_charpos have been processed. */
2440 unsigned overlay_strings_at_end_processed_p
: 1;
2442 /* 1 means to ignore overlay strings at current pos, as they have
2443 already been processed. */
2444 unsigned ignore_overlay_strings_at_pos_p
: 1;
2446 /* 1 means the actual glyph is not available in the current
2448 unsigned glyph_not_available_p
: 1;
2450 /* 1 means the next line in display_line continues a character
2451 consisting of more than one glyph, and some glyphs of this
2452 character have been put on the previous line. */
2453 unsigned starts_in_middle_of_char_p
: 1;
2455 /* If 1, saved_face_id contains the id of the face in front of text
2456 skipped due to selective display. */
2457 unsigned face_before_selective_p
: 1;
2459 /* If 1, adjust current glyph so it does not increase current row
2460 descent/ascent (line-height property). Reset after this glyph. */
2461 unsigned constrain_row_ascent_descent_p
: 1;
2463 enum line_wrap_method line_wrap
;
2465 /* The ID of the default face to use. One of DEFAULT_FACE_ID,
2466 MODE_LINE_FACE_ID, etc, depending on what we are displaying. */
2469 /* If `what' == IT_CHARACTER, the character and the length in bytes
2470 of its multibyte sequence. The character comes from a buffer or
2471 a string. It may be different from the character displayed in
2472 case that unibyte_display_via_language_environment is set.
2474 If `what' == IT_COMPOSITION, the first component of a composition
2475 and length in bytes of the composition.
2477 If `what' is anything else, these two are undefined (will
2478 probably hold values for the last IT_CHARACTER or IT_COMPOSITION
2479 traversed by the iterator.
2481 The values are updated by get_next_display_element, so they are
2482 out of sync with the value returned by IT_CHARPOS between the
2483 time set_iterator_to_next advances the position and the time
2484 get_next_display_element loads the new values into c and len. */
2487 /* If what == IT_COMPOSITION, iterator substructure for the
2489 struct composition_it cmp_it
;
2491 /* The character to display, possibly translated to multibyte if
2492 multibyte_p is zero or unibyte_display_via_language_environment
2493 is set. This is set after get_next_display_element has been
2494 called. If we are setting it->C directly before calling
2495 PRODUCE_GLYPHS, this should be set beforehand too. */
2496 int char_to_display
;
2498 /* If what == IT_GLYPHLESS, the method to display such a
2500 enum glyphless_display_method glyphless_method
;
2502 /* If what == IT_IMAGE, the id of the image to display. */
2505 #ifdef HAVE_XWIDGETS
2506 /* If what == IT_XWIDGET*/
2507 struct xwidget
* xwidget
;
2509 /* Values from `slice' property. */
2510 struct it_slice slice
;
2512 /* Value of the `space-width' property, if any; nil if none. */
2513 Lisp_Object space_width
;
2515 /* Computed from the value of the `raise' property. */
2518 /* Number of columns per \t. */
2521 /* Value of the `height' property, if any; nil if none. */
2522 Lisp_Object font_height
;
2524 /* Object and position where the current display element came from.
2525 Object is normally the buffer which is being rendered, but it can
2526 also be a Lisp string in case the current display element comes
2527 from an overlay string or from a display string (before- or
2528 after-string). It may also be nil when a C string is being
2529 rendered, e.g., during mode-line or header-line update. It can
2530 also be a cons cell of the form `(space ...)', when we produce a
2531 stretch glyph from a `display' specification. Finally, it can be
2532 a zero-valued Lisp integer, but only temporarily, when we are
2533 producing special glyphs for display purposes, like truncation
2534 and continuation glyphs, or blanks that extend each line to the
2535 edge of the window on a TTY.
2537 Do NOT use !BUFFERP (it.object) as a test whether we are
2538 iterating over a string; use STRINGP (it.string) instead.
2540 Position is the current iterator position in object. */
2542 struct text_pos position
;
2544 /* Width in pixels of truncation and continuation glyphs. */
2545 short truncation_pixel_width
, continuation_pixel_width
;
2547 /* First and last visible x-position in the display area. If window
2548 is hscrolled by n columns, first_visible_x == n * FRAME_COLUMN_WIDTH
2549 (f), and last_visible_x == pixel width of W + first_visible_x. */
2550 int first_visible_x
, last_visible_x
;
2552 /* Last visible y-position + 1 in the display area without a mode
2553 line, if the window has one. */
2556 /* Default amount of additional space in pixels between lines (for
2557 window systems only.) */
2558 int extra_line_spacing
;
2560 /* Max extra line spacing added in this row. */
2561 int max_extra_line_spacing
;
2563 /* Override font height information for this glyph.
2564 Used if override_ascent >= 0. Cleared after this glyph. */
2565 int override_ascent
, override_descent
, override_boff
;
2567 /* If non-null, glyphs are produced in glyph_row with each call to
2569 struct glyph_row
*glyph_row
;
2571 /* The area of glyph_row to which glyphs are added. */
2572 enum glyph_row_area area
;
2574 /* Number of glyphs needed for the last character requested via
2575 produce_glyphs. This is 1 except for tabs. */
2578 /* Width of the display element in pixels. Result of
2582 /* Current, maximum logical, and maximum physical line height
2583 information. Result of produce_glyphs. */
2584 int ascent
, descent
, max_ascent
, max_descent
;
2585 int phys_ascent
, phys_descent
, max_phys_ascent
, max_phys_descent
;
2587 /* Current x pixel position within the display line. This value
2588 does not include the width of continuation lines in front of the
2589 line. The value of current_x is automatically incremented by
2590 pixel_width with each call to produce_glyphs. */
2593 /* Accumulated width of continuation lines. If > 0, this means we
2594 are currently in a continuation line. This is initially zero and
2595 incremented/reset by display_line, move_it_to etc. */
2596 int continuation_lines_width
;
2598 /* Buffer position that ends the buffer text line being iterated.
2599 This is normally the position after the newline at EOL. If this
2600 is the last line of the buffer and it doesn't have a newline,
2601 value is ZV/ZV_BYTE. Set and used only if IT->bidi_p, for
2602 setting the end position of glyph rows produced for continuation
2603 lines, see display_line. */
2604 struct text_pos eol_pos
;
2606 /* Current y-position. Automatically incremented by the height of
2607 glyph_row in move_it_to and display_line. */
2610 /* Vertical matrix position of first text line in window. */
2613 /* Current vertical matrix position, or line number. Automatically
2614 incremented by move_it_to and display_line. */
2617 /* Horizontal matrix position reached in move_it_in_display_line.
2618 Only set there, not in display_line. */
2621 /* Left fringe bitmap number (enum fringe_bitmap_type). */
2622 unsigned left_user_fringe_bitmap
: FRINGE_ID_BITS
;
2624 /* Right fringe bitmap number (enum fringe_bitmap_type). */
2625 unsigned right_user_fringe_bitmap
: FRINGE_ID_BITS
;
2627 /* Face of the left fringe glyph. */
2628 unsigned left_user_fringe_face_id
: FACE_ID_BITS
;
2630 /* Face of the right fringe glyph. */
2631 unsigned right_user_fringe_face_id
: FACE_ID_BITS
;
2633 /* Non-zero means we need to reorder bidirectional text for display
2634 in the visual order. */
2635 unsigned bidi_p
: 1;
2637 /* For iterating over bidirectional text. */
2638 struct bidi_it bidi_it
;
2639 bidi_dir_t paragraph_embedding
;
2643 /* Access to positions of iterator IT. */
2645 #define IT_CHARPOS(IT) CHARPOS ((IT).current.pos)
2646 #define IT_BYTEPOS(IT) BYTEPOS ((IT).current.pos)
2647 #define IT_STRING_CHARPOS(IT) CHARPOS ((IT).current.string_pos)
2648 #define IT_STRING_BYTEPOS(IT) BYTEPOS ((IT).current.string_pos)
2650 /* Test if IT has reached the end of its buffer or string. This will
2651 only work after get_next_display_element has been called. */
2653 #define ITERATOR_AT_END_P(IT) ((IT)->what == IT_EOB)
2655 /* Non-zero means IT is at the end of a line. This is the case if it
2656 is either on a newline or on a carriage return and selective
2657 display hides the rest of the line. */
2659 #define ITERATOR_AT_END_OF_LINE_P(IT) \
2660 ((IT)->what == IT_CHARACTER \
2661 && ((IT)->c == '\n' \
2662 || ((IT)->c == '\r' && (IT)->selective)))
2664 /* Call produce_glyphs or FRAME_RIF->produce_glyphs, if set. Shortcut
2665 to avoid the function call overhead. */
2667 #define PRODUCE_GLYPHS(IT) \
2669 if ((IT)->glyph_row != NULL && (IT)->bidi_p) \
2671 if ((IT)->bidi_it.paragraph_dir == R2L) \
2672 (IT)->glyph_row->reversed_p = 1; \
2674 (IT)->glyph_row->reversed_p = 0; \
2676 if (FRAME_RIF ((IT)->f) != NULL) \
2677 FRAME_RIF ((IT)->f)->produce_glyphs ((IT)); \
2679 produce_glyphs ((IT)); \
2680 if ((IT)->glyph_row != NULL) \
2681 inhibit_free_realized_faces = 1; \
2684 /* Bit-flags indicating what operation move_it_to should perform. */
2686 enum move_operation_enum
2688 /* Stop if specified x-position is reached. */
2691 /* Stop if specified y-position is reached. */
2694 /* Stop if specified vpos is reached. */
2695 MOVE_TO_VPOS
= 0x04,
2697 /* Stop if specified buffer or string position is reached. */
2701 /***********************************************************************
2703 ***********************************************************************/
2705 /* Structure to hold mouse highlight data. */
2708 /* These variables describe the range of text currently shown in its
2709 mouse-face, together with the window they apply to. As long as
2710 the mouse stays within this range, we need not redraw anything on
2711 its account. Rows and columns are glyph matrix positions in
2712 MOUSE_FACE_WINDOW. */
2713 int mouse_face_beg_row
, mouse_face_beg_col
, mouse_face_beg_x
;
2714 int mouse_face_end_row
, mouse_face_end_col
, mouse_face_end_x
;
2715 Lisp_Object mouse_face_window
;
2716 int mouse_face_face_id
;
2717 Lisp_Object mouse_face_overlay
;
2719 /* FRAME and X, Y position of mouse when last checked for
2720 highlighting. X and Y can be negative or out of range for the frame. */
2721 struct frame
*mouse_face_mouse_frame
;
2722 int mouse_face_mouse_x
, mouse_face_mouse_y
;
2724 /* Nonzero if part of the text currently shown in
2725 its mouse-face is beyond the window end. */
2726 unsigned mouse_face_past_end
: 1;
2728 /* Nonzero means defer mouse-motion highlighting. */
2729 unsigned mouse_face_defer
: 1;
2731 /* Nonzero means that the mouse highlight should not be shown. */
2732 unsigned mouse_face_hidden
: 1;
2735 DISPEXTERN_INLINE
void
2736 reset_mouse_highlight (Mouse_HLInfo
*hlinfo
)
2739 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
2740 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
2741 hlinfo
->mouse_face_mouse_x
= hlinfo
->mouse_face_mouse_y
= 0;
2742 hlinfo
->mouse_face_beg_x
= hlinfo
->mouse_face_end_x
= 0;
2743 hlinfo
->mouse_face_face_id
= DEFAULT_FACE_ID
;
2744 hlinfo
->mouse_face_mouse_frame
= NULL
;
2745 hlinfo
->mouse_face_window
= Qnil
;
2746 hlinfo
->mouse_face_overlay
= Qnil
;
2747 hlinfo
->mouse_face_past_end
= 0;
2748 hlinfo
->mouse_face_hidden
= 0;
2749 hlinfo
->mouse_face_defer
= 0;
2752 /***********************************************************************
2753 Window-based redisplay interface
2754 ***********************************************************************/
2756 /* Structure used to describe runs of lines that must be scrolled. */
2760 /* Source and destination y pixel position. */
2761 int desired_y
, current_y
;
2763 /* Source and destination vpos in matrix. */
2764 int desired_vpos
, current_vpos
;
2766 /* Height in pixels, number of glyph rows. */
2771 /* Handlers for setting frame parameters. */
2773 typedef void (*frame_parm_handler
) (struct frame
*, Lisp_Object
, Lisp_Object
);
2776 /* Structure holding system-dependent interface functions needed
2777 for window-based redisplay. */
2779 struct redisplay_interface
2781 /* Handlers for setting frame parameters. */
2782 frame_parm_handler
*frame_parm_handlers
;
2784 /* Produce glyphs/get display metrics for the display element IT is
2786 void (*produce_glyphs
) (struct it
*it
);
2788 /* Write or insert LEN glyphs from STRING at the nominal output
2790 void (*write_glyphs
) (struct window
*w
, struct glyph_row
*row
,
2791 struct glyph
*string
, enum glyph_row_area area
,
2793 void (*insert_glyphs
) (struct window
*w
, struct glyph_row
*row
,
2794 struct glyph
*start
, enum glyph_row_area area
,
2797 /* Clear from nominal output position to X. X < 0 means clear
2798 to right end of display. */
2799 void (*clear_end_of_line
) (struct window
*w
, struct glyph_row
*row
,
2800 enum glyph_row_area area
, int x
);
2802 /* Function to call to scroll the display as described by RUN on
2804 void (*scroll_run_hook
) (struct window
*w
, struct run
*run
);
2806 /* Function to call after a line in a display has been completely
2807 updated. Used to draw truncation marks and alike. DESIRED_ROW
2808 is the desired row which has been updated. */
2809 void (*after_update_window_line_hook
) (struct window
*w
,
2810 struct glyph_row
*desired_row
);
2812 /* Function to call before beginning to update window W in
2813 window-based redisplay. */
2814 void (*update_window_begin_hook
) (struct window
*w
);
2816 /* Function to call after window W has been updated in window-based
2817 redisplay. CURSOR_ON_P non-zero means switch cursor on.
2818 MOUSE_FACE_OVERWRITTEN_P non-zero means that some lines in W
2819 that contained glyphs in mouse-face were overwritten, so we
2820 have to update the mouse highlight. */
2821 void (*update_window_end_hook
) (struct window
*w
, bool cursor_on_p
,
2822 bool mouse_face_overwritten_p
);
2824 /* Flush the display of frame F. For X, this is XFlush. */
2825 void (*flush_display
) (struct frame
*f
);
2827 /* Clear the mouse highlight in window W, if there is any. */
2828 void (*clear_window_mouse_face
) (struct window
*w
);
2830 /* Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
2832 void (*get_glyph_overhangs
) (struct glyph
*glyph
, struct frame
*f
,
2833 int *left
, int *right
);
2835 /* Fix the display of AREA of ROW in window W for overlapping rows.
2836 This function is called from redraw_overlapping_rows after
2837 desired rows have been made current. */
2838 void (*fix_overlapping_area
) (struct window
*w
, struct glyph_row
*row
,
2839 enum glyph_row_area area
, int);
2841 #ifdef HAVE_WINDOW_SYSTEM
2843 /* Draw a fringe bitmap in window W of row ROW using parameters P. */
2844 void (*draw_fringe_bitmap
) (struct window
*w
, struct glyph_row
*row
,
2845 struct draw_fringe_bitmap_params
*p
);
2847 /* Define and destroy fringe bitmap no. WHICH. */
2848 void (*define_fringe_bitmap
) (int which
, unsigned short *bits
,
2850 void (*destroy_fringe_bitmap
) (int which
);
2852 /* Compute left and right overhang of glyph string S.
2853 A NULL pointer if platform does not support this. */
2854 void (*compute_glyph_string_overhangs
) (struct glyph_string
*s
);
2856 /* Draw a glyph string S. */
2857 void (*draw_glyph_string
) (struct glyph_string
*s
);
2859 /* Define cursor CURSOR on frame F. */
2860 void (*define_frame_cursor
) (struct frame
*f
, Cursor cursor
);
2862 /* Clear the area at (X,Y,WIDTH,HEIGHT) of frame F. */
2863 void (*clear_frame_area
) (struct frame
*f
, int x
, int y
,
2864 int width
, int height
);
2866 /* Draw specified cursor CURSOR_TYPE of width CURSOR_WIDTH
2867 at row GLYPH_ROW on window W if ON_P is 1. If ON_P is
2868 0, don't draw cursor. If ACTIVE_P is 1, system caret
2869 should track this cursor (when applicable). */
2870 void (*draw_window_cursor
) (struct window
*w
,
2871 struct glyph_row
*glyph_row
,
2873 enum text_cursor_kinds cursor_type
,
2874 int cursor_width
, bool on_p
, bool active_p
);
2876 /* Draw vertical border for window W from (X,Y_0) to (X,Y_1). */
2877 void (*draw_vertical_window_border
) (struct window
*w
,
2878 int x
, int y_0
, int y_1
);
2880 /* Shift display of frame F to make room for inserted glyphs.
2881 The area at pixel (X,Y) of width WIDTH and height HEIGHT is
2882 shifted right by SHIFT_BY pixels. */
2883 void (*shift_glyphs_for_insert
) (struct frame
*f
,
2884 int x
, int y
, int width
,
2885 int height
, int shift_by
);
2887 #endif /* HAVE_WINDOW_SYSTEM */
2891 /***********************************************************************
2893 ***********************************************************************/
2895 #ifdef HAVE_WINDOW_SYSTEM
2897 /* Each image format (JPEG, TIFF, ...) supported is described by
2898 a structure of the type below. */
2902 /* A symbol uniquely identifying the image type, .e.g `jpeg'. */
2905 /* Check that SPEC is a valid image specification for the given
2906 image type. Value is true if SPEC is valid. */
2907 bool (* valid_p
) (Lisp_Object spec
);
2909 /* Load IMG which is used on frame F from information contained in
2910 IMG->spec. Value is true if successful. */
2911 bool (* load
) (struct frame
*f
, struct image
*img
);
2913 /* Free resources of image IMG which is used on frame F. */
2914 void (* free
) (struct frame
*f
, struct image
*img
);
2916 /* Initialization function (used for dynamic loading of image
2917 libraries on Windows), or NULL if none. */
2918 bool (* init
) (void);
2920 /* Next in list of all supported image types. */
2921 struct image_type
*next
;
2925 /* Structure describing an image. Specific image formats like XBM are
2926 converted into this form, so that display only has to deal with
2927 this type of image. */
2931 /* The time in seconds at which the image was last displayed. Set
2932 in prepare_image_for_display. */
2933 struct timespec timestamp
;
2935 /* Pixmaps of the image. */
2936 Pixmap pixmap
, mask
;
2938 #ifdef HAVE_X_WINDOWS
2939 /* X images of the image, corresponding to the above Pixmaps.
2940 Non-NULL means it and its Pixmap counterpart may be out of sync
2941 and the latter is outdated. NULL means the X image has been
2942 synchronized to Pixmap. */
2943 XImagePtr ximg
, mask_img
;
2946 /* Colors allocated for this image, if any. Allocated via xmalloc. */
2947 unsigned long *colors
;
2950 /* A single `background color' for this image, for the use of anyone that
2951 cares about such a thing. Only valid if the `background_valid' field
2952 is true. This should generally be accessed by calling the accessor
2953 macro `IMAGE_BACKGROUND', which will heuristically calculate a value
2955 unsigned long background
;
2957 /* Foreground and background colors of the frame on which the image
2959 unsigned long frame_foreground
, frame_background
;
2961 /* True if this image has a `transparent' background -- that is, is
2962 uses an image mask. The accessor macro for this is
2963 `IMAGE_BACKGROUND_TRANSPARENT'. */
2964 unsigned background_transparent
: 1;
2966 /* True if the `background' and `background_transparent' fields are
2967 valid, respectively. */
2968 unsigned background_valid
: 1, background_transparent_valid
: 1;
2970 /* Width and height of the image. */
2973 /* These values are used for the rectangles displayed for images
2974 that can't be loaded. */
2975 #define DEFAULT_IMAGE_WIDTH 30
2976 #define DEFAULT_IMAGE_HEIGHT 30
2978 /* Top/left and bottom/right corner pixel of actual image data.
2979 Used by four_corners_best to consider the real image data,
2980 rather than looking at the optional image margin. */
2982 #define TOP_CORNER 0
2983 #define LEFT_CORNER 1
2984 #define BOT_CORNER 2
2985 #define RIGHT_CORNER 3
2987 /* Percent of image height used as ascent. A value of
2988 CENTERED_IMAGE_ASCENT means draw the image centered on the
2991 #define DEFAULT_IMAGE_ASCENT 50
2992 #define CENTERED_IMAGE_ASCENT -1
2994 /* Lisp specification of this image. */
2997 /* List of "references" followed to build the image.
2998 Typically will just contain the name of the image file.
2999 Used to allow fine-grained cache flushing. */
3000 Lisp_Object dependencies
;
3002 /* Relief to draw around the image. */
3005 /* Optional margins around the image. This includes the relief. */
3006 int hmargin
, vmargin
;
3008 /* Reference to the type of the image. */
3009 struct image_type
*type
;
3011 /* 1 means that loading the image failed. Don't try again. */
3012 unsigned load_failed_p
;
3014 /* A place for image types to store additional data. It is marked
3016 Lisp_Object lisp_data
;
3018 /* Hash value of image specification to speed up comparisons. */
3021 /* Image id of this image. */
3024 /* Hash collision chain. */
3025 struct image
*next
, *prev
;
3029 /* Cache of images. Each frame has a cache. X frames with the same
3030 x_display_info share their caches. */
3034 /* Hash table of images. */
3035 struct image
**buckets
;
3037 /* Vector mapping image ids to images. */
3038 struct image
**images
;
3040 /* Allocated size of `images'. */
3043 /* Number of images in the cache. */
3046 /* Reference count (number of frames sharing this cache). */
3051 /* Value is a pointer to the image with id ID on frame F, or null if
3052 no image with that id exists. */
3054 #define IMAGE_FROM_ID(F, ID) \
3055 (((ID) >= 0 && (ID) < (FRAME_IMAGE_CACHE (F)->used)) \
3056 ? FRAME_IMAGE_CACHE (F)->images[ID] \
3059 /* Size of bucket vector of image caches. Should be prime. */
3061 #define IMAGE_CACHE_BUCKETS_SIZE 1001
3063 #endif /* HAVE_WINDOW_SYSTEM */
3067 /***********************************************************************
3069 ***********************************************************************/
3071 /* Enumeration defining where to find tool-bar item information in
3072 tool-bar items vectors stored with frames. Each tool-bar item
3073 occupies TOOL_BAR_ITEM_NSLOTS elements in such a vector. */
3075 enum tool_bar_item_idx
3077 /* The key of the tool-bar item. Used to remove items when a binding
3078 for `undefined' is found. */
3081 /* Non-nil if item is enabled. */
3082 TOOL_BAR_ITEM_ENABLED_P
,
3084 /* Non-nil if item is selected (pressed). */
3085 TOOL_BAR_ITEM_SELECTED_P
,
3088 TOOL_BAR_ITEM_CAPTION
,
3090 /* Image(s) to display. This is either a single image specification
3091 or a vector of specifications. */
3092 TOOL_BAR_ITEM_IMAGES
,
3095 TOOL_BAR_ITEM_BINDING
,
3097 /* Button type. One of nil (default button), t (a separator),
3098 `:radio', or `:toggle'. The latter two currently do nothing. */
3104 /* Icon file name of right to left image when an RTL locale is used. */
3105 TOOL_BAR_ITEM_RTL_IMAGE
,
3107 /* Label to show when text labels are enabled. */
3108 TOOL_BAR_ITEM_LABEL
,
3110 /* If we shall show the label only below the icon and not beside it. */
3111 TOOL_BAR_ITEM_VERT_ONLY
,
3113 /* Sentinel = number of slots in tool_bar_items occupied by one
3115 TOOL_BAR_ITEM_NSLOTS
3119 /* An enumeration for the different images that can be specified
3120 for a tool-bar item. */
3122 enum tool_bar_item_image
3124 TOOL_BAR_IMAGE_ENABLED_SELECTED
,
3125 TOOL_BAR_IMAGE_ENABLED_DESELECTED
,
3126 TOOL_BAR_IMAGE_DISABLED_SELECTED
,
3127 TOOL_BAR_IMAGE_DISABLED_DESELECTED
3130 #define DEFAULT_TOOL_BAR_LABEL_SIZE 14
3132 /* Default values of the above variables. */
3134 #define DEFAULT_TOOL_BAR_BUTTON_MARGIN 4
3135 #define DEFAULT_TOOL_BAR_BUTTON_RELIEF 1
3137 /* The height in pixels of the default tool-bar images. */
3139 #define DEFAULT_TOOL_BAR_IMAGE_HEIGHT 24
3142 /***********************************************************************
3143 Terminal Capabilities
3144 ***********************************************************************/
3146 /* Each of these is a bit representing a terminal `capability' (bold,
3147 inverse, etc). They are or'd together to specify the set of
3148 capabilities being queried for when calling `tty_capable_p' (which
3149 returns true if the terminal supports all of them). */
3151 #define TTY_CAP_INVERSE 0x01
3152 #define TTY_CAP_UNDERLINE 0x02
3153 #define TTY_CAP_BOLD 0x04
3154 #define TTY_CAP_DIM 0x08
3155 #define TTY_CAP_ITALIC 0x10
3158 /***********************************************************************
3160 ***********************************************************************/
3162 /* Defined in bidi.c */
3164 extern void bidi_init_it (ptrdiff_t, ptrdiff_t, bool, struct bidi_it
*);
3165 extern void bidi_move_to_visually_next (struct bidi_it
*);
3166 extern void bidi_paragraph_init (bidi_dir_t
, struct bidi_it
*, bool);
3167 extern int bidi_mirror_char (int);
3168 extern void bidi_push_it (struct bidi_it
*);
3169 extern void bidi_pop_it (struct bidi_it
*);
3170 extern void *bidi_shelve_cache (void);
3171 extern void bidi_unshelve_cache (void *, bool);
3173 /* Defined in xdisp.c */
3175 struct glyph_row
*row_containing_pos (struct window
*, ptrdiff_t,
3177 struct glyph_row
*, int);
3178 int line_bottom_y (struct it
*);
3179 int default_line_pixel_height (struct window
*);
3180 int display_prop_intangible_p (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3181 void resize_echo_area_exactly (void);
3182 int resize_mini_window (struct window
*, int);
3183 #if defined USE_TOOLKIT_SCROLL_BARS && !defined USE_GTK
3184 void set_vertical_scroll_bar (struct window
*);
3186 int try_window (Lisp_Object
, struct text_pos
, int);
3187 void window_box (struct window
*, enum glyph_row_area
,
3188 int *, int *, int *, int *);
3189 int window_box_height (struct window
*);
3190 int window_text_bottom_y (struct window
*);
3191 int window_box_width (struct window
*, enum glyph_row_area
);
3192 int window_box_left (struct window
*, enum glyph_row_area
);
3193 int window_box_left_offset (struct window
*, enum glyph_row_area
);
3194 int window_box_right (struct window
*, enum glyph_row_area
);
3195 int window_box_right_offset (struct window
*, enum glyph_row_area
);
3196 int estimate_mode_line_height (struct frame
*, enum face_id
);
3197 void pixel_to_glyph_coords (struct frame
*, int, int, int *, int *,
3198 NativeRectangle
*, int);
3199 void remember_mouse_glyph (struct frame
*, int, int, NativeRectangle
*);
3201 void mark_window_display_accurate (Lisp_Object
, int);
3202 void redisplay_preserve_echo_area (int);
3203 void init_iterator (struct it
*, struct window
*, ptrdiff_t,
3204 ptrdiff_t, struct glyph_row
*, enum face_id
);
3205 void init_iterator_to_row_start (struct it
*, struct window
*,
3206 struct glyph_row
*);
3207 void start_display (struct it
*, struct window
*, struct text_pos
);
3208 void move_it_to (struct it
*, ptrdiff_t, int, int, int, int);
3209 void move_it_vertically (struct it
*, int);
3210 void move_it_vertically_backward (struct it
*, int);
3211 void move_it_by_lines (struct it
*, ptrdiff_t);
3212 void move_it_past_eol (struct it
*);
3213 void move_it_in_display_line (struct it
*it
,
3214 ptrdiff_t to_charpos
, int to_x
,
3215 enum move_operation_enum op
);
3216 int in_display_vector_p (struct it
*);
3217 int frame_mode_line_height (struct frame
*);
3218 extern Lisp_Object Qtool_bar
;
3219 extern bool redisplaying_p
;
3220 extern int help_echo_showing_p
;
3221 extern Lisp_Object help_echo_string
, help_echo_window
;
3222 extern Lisp_Object help_echo_object
, previous_help_echo_string
;
3223 extern ptrdiff_t help_echo_pos
;
3224 extern struct frame
*last_mouse_frame
;
3225 extern int last_tool_bar_item
;
3226 extern void reseat_at_previous_visible_line_start (struct it
*);
3227 extern Lisp_Object
lookup_glyphless_char_display (int, struct it
*);
3228 extern ptrdiff_t compute_display_string_pos (struct text_pos
*,
3229 struct bidi_string_data
*,
3230 struct window
*, int, int *);
3231 extern ptrdiff_t compute_display_string_end (ptrdiff_t,
3232 struct bidi_string_data
*);
3233 extern void produce_stretch_glyph (struct it
*);
3234 extern int merge_glyphless_glyph_face (struct it
*);
3236 #ifdef HAVE_WINDOW_SYSTEM
3239 extern void dump_glyph_string (struct glyph_string
*) EXTERNALLY_VISIBLE
;
3242 extern void x_get_glyph_overhangs (struct glyph
*, struct frame
*,
3244 extern void x_produce_glyphs (struct it
*);
3246 extern void x_write_glyphs (struct window
*, struct glyph_row
*,
3247 struct glyph
*, enum glyph_row_area
, int);
3248 extern void x_insert_glyphs (struct window
*, struct glyph_row
*,
3249 struct glyph
*, enum glyph_row_area
, int);
3250 extern void x_clear_end_of_line (struct window
*, struct glyph_row
*,
3251 enum glyph_row_area
, int);
3252 extern void x_fix_overlapping_area (struct window
*, struct glyph_row
*,
3253 enum glyph_row_area
, int);
3254 extern void draw_phys_cursor_glyph (struct window
*,
3256 enum draw_glyphs_face
);
3257 extern void get_phys_cursor_geometry (struct window
*, struct glyph_row
*,
3258 struct glyph
*, int *, int *, int *);
3259 extern void erase_phys_cursor (struct window
*);
3260 extern void display_and_set_cursor (struct window
*, bool, int, int, int, int);
3261 extern void x_update_cursor (struct frame
*, bool);
3262 extern void x_clear_cursor (struct window
*);
3263 extern void x_draw_vertical_border (struct window
*w
);
3265 extern int get_glyph_string_clip_rects (struct glyph_string
*,
3266 NativeRectangle
*, int);
3267 extern void get_glyph_string_clip_rect (struct glyph_string
*,
3268 NativeRectangle
*nr
);
3269 extern Lisp_Object
find_hot_spot (Lisp_Object
, int, int);
3271 extern void handle_tool_bar_click (struct frame
*,
3272 int, int, int, int);
3274 extern void expose_frame (struct frame
*, int, int, int, int);
3275 extern int x_intersect_rectangles (XRectangle
*, XRectangle
*,
3277 #endif /* HAVE_WINDOW_SYSTEM */
3279 extern void note_mouse_highlight (struct frame
*, int, int);
3280 extern void x_clear_window_mouse_face (struct window
*);
3281 extern void cancel_mouse_face (struct frame
*);
3282 extern int clear_mouse_face (Mouse_HLInfo
*);
3283 extern int cursor_in_mouse_face_p (struct window
*w
);
3284 extern void tty_draw_row_with_mouse_face (struct window
*, struct glyph_row
*,
3285 int, int, enum draw_glyphs_face
);
3287 /* Flags passed to try_window. */
3288 #define TRY_WINDOW_CHECK_MARGINS (1 << 0)
3289 #define TRY_WINDOW_IGNORE_FONTS_CHANGE (1 << 1)
3291 int lookup_fringe_bitmap (Lisp_Object
);
3292 void draw_fringe_bitmap (struct window
*, struct glyph_row
*, int);
3293 void draw_row_fringe_bitmaps (struct window
*, struct glyph_row
*);
3294 bool draw_window_fringes (struct window
*, bool);
3295 bool update_window_fringes (struct window
*, bool);
3296 void compute_fringe_widths (struct frame
*, bool);
3299 void w32_init_fringe (struct redisplay_interface
*);
3300 void w32_reset_fringes (void);
3303 extern unsigned row_hash (struct glyph_row
*);
3305 /* Defined in image.c */
3307 #ifdef HAVE_WINDOW_SYSTEM
3309 extern int x_bitmap_height (struct frame
*, ptrdiff_t);
3310 extern int x_bitmap_width (struct frame
*, ptrdiff_t);
3311 extern ptrdiff_t x_bitmap_pixmap (struct frame
*, ptrdiff_t);
3312 extern void x_reference_bitmap (struct frame
*, ptrdiff_t);
3313 extern ptrdiff_t x_create_bitmap_from_data (struct frame
*, char *,
3314 unsigned int, unsigned int);
3315 extern ptrdiff_t x_create_bitmap_from_file (struct frame
*, Lisp_Object
);
3316 #if defined HAVE_XPM && defined HAVE_X_WINDOWS && !defined USE_GTK
3317 extern ptrdiff_t x_create_bitmap_from_xpm_data (struct frame
*, const char **);
3319 #ifndef x_destroy_bitmap
3320 extern void x_destroy_bitmap (struct frame
*, ptrdiff_t);
3322 extern void x_destroy_all_bitmaps (Display_Info
*);
3323 extern void x_create_bitmap_mask (struct frame
*, ptrdiff_t);
3324 extern Lisp_Object
x_find_image_file (Lisp_Object
);
3326 void x_kill_gs_process (Pixmap
, struct frame
*);
3327 struct image_cache
*make_image_cache (void);
3328 void free_image_cache (struct frame
*);
3329 void clear_image_caches (Lisp_Object
);
3330 void mark_image_cache (struct image_cache
*);
3331 bool valid_image_p (Lisp_Object
);
3332 void prepare_image_for_display (struct frame
*, struct image
*);
3333 ptrdiff_t lookup_image (struct frame
*, Lisp_Object
);
3335 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3336 #define RGB_PIXEL_COLOR unsigned long
3340 #define RGB_PIXEL_COLOR COLORREF
3343 RGB_PIXEL_COLOR
image_background (struct image
*, struct frame
*,
3344 XImagePtr_or_DC ximg
);
3345 int image_background_transparent (struct image
*, struct frame
*,
3346 XImagePtr_or_DC mask
);
3348 int image_ascent (struct image
*, struct face
*, struct glyph_slice
*);
3352 /* Defined in sysdep.c */
3354 void get_tty_size (int, int *, int *);
3355 void request_sigio (void);
3356 void unrequest_sigio (void);
3357 bool tabs_safe_p (int);
3358 void init_baud_rate (int);
3359 void init_sigio (int);
3360 void ignore_sigio (void);
3362 /* Defined in xfaces.c */
3364 #ifdef HAVE_X_WINDOWS
3365 void x_free_colors (struct frame
*, unsigned long *, int);
3368 void update_face_from_frame_parameter (struct frame
*, Lisp_Object
,
3370 Lisp_Object
tty_color_name (struct frame
*, int);
3371 void clear_face_cache (int);
3372 unsigned long load_color (struct frame
*, struct face
*, Lisp_Object
,
3373 enum lface_attribute_index
);
3374 void unload_color (struct frame
*, unsigned long);
3375 char *choose_face_font (struct frame
*, Lisp_Object
*, Lisp_Object
,
3377 void prepare_face_for_display (struct frame
*, struct face
*);
3378 int lookup_named_face (struct frame
*, Lisp_Object
, int);
3379 int lookup_basic_face (struct frame
*, int);
3380 int smaller_face (struct frame
*, int, int);
3381 int face_with_height (struct frame
*, int, int);
3382 int lookup_derived_face (struct frame
*, Lisp_Object
, int, int);
3383 void init_frame_faces (struct frame
*);
3384 void free_frame_faces (struct frame
*);
3385 void recompute_basic_faces (struct frame
*);
3386 int face_at_buffer_position (struct window
*w
, ptrdiff_t pos
,
3387 ptrdiff_t region_beg
, ptrdiff_t region_end
,
3388 ptrdiff_t *endptr
, ptrdiff_t limit
,
3389 int mouse
, int base_face_id
);
3390 int face_for_overlay_string (struct window
*w
, ptrdiff_t pos
,
3391 ptrdiff_t region_beg
, ptrdiff_t region_end
,
3392 ptrdiff_t *endptr
, ptrdiff_t limit
,
3393 int mouse
, Lisp_Object overlay
);
3394 int face_at_string_position (struct window
*w
, Lisp_Object string
,
3395 ptrdiff_t pos
, ptrdiff_t bufpos
,
3396 ptrdiff_t region_beg
, ptrdiff_t region_end
,
3397 ptrdiff_t *endptr
, enum face_id
, int mouse
);
3398 int merge_faces (struct frame
*, Lisp_Object
, int, int);
3399 int compute_char_face (struct frame
*, int, Lisp_Object
);
3400 void free_all_realized_faces (Lisp_Object
);
3401 extern Lisp_Object Qforeground_color
, Qbackground_color
;
3402 extern char unspecified_fg
[], unspecified_bg
[];
3404 /* Defined in xfns.c */
3406 #ifdef HAVE_X_WINDOWS
3407 void gamma_correct (struct frame
*, XColor
*);
3410 void gamma_correct (struct frame
*, COLORREF
*);
3413 #ifdef HAVE_WINDOW_SYSTEM
3415 void x_implicitly_set_name (struct frame
*, Lisp_Object
, Lisp_Object
);
3417 extern Lisp_Object tip_frame
;
3418 extern Window tip_window
;
3419 extern frame_parm_handler x_frame_parm_handlers
[];
3421 extern void start_hourglass (void);
3422 extern void cancel_hourglass (void);
3423 extern int hourglass_shown_p
;
3424 /* If non-null, an asynchronous timer that, when it expires, displays
3425 an hourglass cursor on all frames. */
3426 extern struct atimer
*hourglass_atimer
;
3428 /* Each GUI implements these. FIXME: move into RIF. */
3429 extern void show_hourglass (struct atimer
*);
3430 extern void hide_hourglass (void);
3432 /* Returns the background color of IMG, calculating one heuristically if
3433 necessary. If non-zero, XIMG is an existing XImage object to use for
3436 #define IMAGE_BACKGROUND(img, f, ximg) \
3437 ((img)->background_valid \
3438 ? (img)->background \
3439 : image_background (img, f, ximg))
3441 /* Returns true if IMG has a `transparent' background, using heuristics
3442 to decide if necessary. If non-zero, MASK is an existing XImage
3443 object to use for the heuristic. */
3445 #define IMAGE_BACKGROUND_TRANSPARENT(img, f, mask) \
3446 ((img)->background_transparent_valid \
3447 ? (img)->background_transparent \
3448 : image_background_transparent (img, f, mask))
3450 #endif /* HAVE_WINDOW_SYSTEM */
3453 /* Defined in xmenu.c */
3455 int popup_activated (void);
3457 extern Lisp_Object
buffer_posn_from_coords (struct window
*,
3459 struct display_pos
*,
3461 int *, int *, int *, int *);
3462 extern Lisp_Object
mode_line_string (struct window
*, enum window_part
,
3463 int *, int *, ptrdiff_t *,
3465 int *, int *, int *, int *);
3466 extern Lisp_Object
marginal_area_string (struct window
*, enum window_part
,
3467 int *, int *, ptrdiff_t *,
3469 int *, int *, int *, int *);
3470 extern void redraw_frame (struct frame
*);
3471 extern void cancel_line (int, struct frame
*);
3472 extern void init_desired_glyphs (struct frame
*);
3473 extern bool update_frame (struct frame
*, bool, bool);
3474 extern void bitch_at_user (void);
3475 extern void adjust_frame_glyphs (struct frame
*);
3476 void free_glyphs (struct frame
*);
3477 void free_window_matrices (struct window
*);
3478 void check_glyph_memory (void);
3479 void mirrored_line_dance (struct glyph_matrix
*, int, int, int *, char *);
3480 void clear_glyph_matrix (struct glyph_matrix
*);
3481 void clear_current_matrices (struct frame
*f
);
3482 void clear_desired_matrices (struct frame
*);
3483 void shift_glyph_matrix (struct window
*, struct glyph_matrix
*,
3485 void rotate_matrix (struct glyph_matrix
*, int, int, int);
3486 void increment_matrix_positions (struct glyph_matrix
*,
3487 int, int, ptrdiff_t, ptrdiff_t);
3488 void blank_row (struct window
*, struct glyph_row
*, int);
3489 void clear_glyph_matrix_rows (struct glyph_matrix
*, int, int);
3490 void clear_glyph_row (struct glyph_row
*);
3491 void prepare_desired_row (struct glyph_row
*);
3492 void set_window_update_flags (struct window
*, bool);
3493 void update_single_window (struct window
*, bool);
3494 void do_pending_window_change (bool);
3495 void change_frame_size (struct frame
*, int, int, bool, bool, bool);
3496 void init_display (void);
3497 void syms_of_display (void);
3498 extern Lisp_Object Qredisplay_dont_pause
;
3499 void spec_glyph_lookup_face (struct window
*, GLYPH
*);
3501 /* Defined in terminal.c */
3503 extern void ring_bell (struct frame
*);
3504 extern void update_begin (struct frame
*);
3505 extern void update_end (struct frame
*);
3506 extern void set_terminal_window (struct frame
*, int);
3507 extern void cursor_to (struct frame
*, int, int);
3508 extern void raw_cursor_to (struct frame
*, int, int);
3509 extern void clear_to_end (struct frame
*);
3510 extern void clear_frame (struct frame
*);
3511 extern void clear_end_of_line (struct frame
*, int);
3512 extern void write_glyphs (struct frame
*, struct glyph
*, int);
3513 extern void insert_glyphs (struct frame
*, struct glyph
*, int);
3514 extern void delete_glyphs (struct frame
*, int);
3515 extern void ins_del_lines (struct frame
*, int, int);
3517 extern struct terminal
*init_initial_terminal (void);
3520 /* Defined in term.c */
3522 extern void tty_turn_off_insert (struct tty_display_info
*);
3523 extern int string_cost (const char *);
3524 extern int per_line_cost (const char *);
3525 extern void calculate_costs (struct frame
*);
3526 extern void produce_glyphs (struct it
*);
3527 extern bool tty_capable_p (struct tty_display_info
*, unsigned,
3528 unsigned long, unsigned long);
3529 extern void set_tty_color_mode (struct tty_display_info
*, struct frame
*);
3530 extern struct terminal
*get_named_tty (const char *);
3531 extern void create_tty_output (struct frame
*);
3532 extern struct terminal
*init_tty (const char *, const char *, bool);
3533 extern void tty_append_glyph (struct it
*);
3536 /* Defined in scroll.c */
3538 extern int scrolling_max_lines_saved (int, int, int *, int *, int *);
3539 extern void do_line_insertion_deletion_costs (struct frame
*, const char *,
3540 const char *, const char *,
3541 const char *, const char *,
3543 void scrolling_1 (struct frame
*, int, int, int, int *, int *, int *,
3546 /* Defined in frame.c */
3548 #ifdef HAVE_WINDOW_SYSTEM
3550 /* Types we might convert a resource string into. */
3558 RES_TYPE_BOOLEAN_NUMBER
3561 extern Lisp_Object
x_get_arg (Display_Info
*, Lisp_Object
,
3562 Lisp_Object
, const char *, const char *class,
3563 enum resource_types
);
3564 extern Lisp_Object
x_frame_get_and_record_arg (struct frame
*, Lisp_Object
,
3566 const char *, const char *,
3567 enum resource_types
);
3568 extern Lisp_Object
x_default_parameter (struct frame
*, Lisp_Object
,
3569 Lisp_Object
, Lisp_Object
,
3570 const char *, const char *,
3571 enum resource_types
);
3573 #endif /* HAVE_WINDOW_SYSTEM */
3577 #endif /* not DISPEXTERN_H_INCLUDED */