1 /* Interface definitions for display code.
3 Copyright (C) 1985, 1993-1994, 1997-2013 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>. */
22 #ifndef DISPEXTERN_H_INCLUDED
23 #define DISPEXTERN_H_INCLUDED
25 #include "character.h"
31 #include <X11/Intrinsic.h>
32 #endif /* USE_X_TOOLKIT */
34 #else /* !HAVE_X_WINDOWS */
36 /* X-related stuff used by non-X gui code. */
40 unsigned short red
, green
, blue
;
45 #endif /* HAVE_X_WINDOWS */
53 #include <c-strcase.h>
55 xstrcasecmp (char const *a
, char const *b
)
57 return c_strcasecmp (a
, b
);
61 #include <X11/Xresource.h> /* for XrmDatabase */
62 typedef struct x_display_info Display_Info
;
63 typedef XImage
* XImagePtr
;
64 typedef XImagePtr XImagePtr_or_DC
;
65 #define NativeRectangle XRectangle
70 typedef struct w32_display_info Display_Info
;
71 typedef XImage
*XImagePtr
;
72 typedef HDC XImagePtr_or_DC
;
77 /* Following typedef needed to accommodate the MSDOS port, believe it or not. */
78 typedef struct ns_display_info Display_Info
;
79 typedef Pixmap XImagePtr
;
80 typedef XImagePtr XImagePtr_or_DC
;
83 #ifdef HAVE_WINDOW_SYSTEM
87 #ifndef HAVE_WINDOW_SYSTEM
92 #ifndef NativeRectangle
93 #define NativeRectangle int
96 /* Text cursor types. */
98 enum text_cursor_kinds
108 /* Values returned from coordinates_in_window. */
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 INLINE
int GLYPH_CHAR (GLYPH glyph
) { return glyph
.ch
; }
293 /* Return a glyph's face ID. */
294 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). */
304 GLYPH_CODE_CHAR (Lisp_Object gc
)
308 : XINT (gc
) & MAX_CHAR
);
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. */
353 /* Structure describing how to use partial glyphs (images slicing) */
360 unsigned height
: 16;
366 Be extra careful when changing this structure! Esp. make sure that
367 functions producing glyphs, like append_glyph, fill ALL of the
368 glyph structure, and that GLYPH_EQUAL_P compares all
369 display-relevant members of glyphs (not to imply that these are the
370 only things to check when you add a member). */
374 /* Position from which this glyph was drawn. If `object' below is a
375 Lisp string, this is an index into that string. If it is a
376 buffer, this is a position in that buffer. In addition, some
377 special glyphs have special values for this:
379 glyph standing for newline at end of line 0
380 empty space after the end of the line -1
381 overlay arrow on a TTY -1
382 glyph at EOB that ends in a newline -1
383 left truncation glyphs: -1
384 right truncation/continuation glyphs next buffer position
385 glyph standing for newline of an empty line buffer position of newline
386 stretch glyph at left edge of R2L lines buffer position of newline */
389 /* Lisp object source of this glyph. Currently either a buffer or a
390 string, if the glyph was produced from characters which came from
391 a buffer or a string; or Lisp integer zero (a.k.a. "null object")
392 if the glyph was inserted by redisplay for its own purposes, such
393 as padding or truncation/continuation glyphs, or the
394 overlay-arrow glyphs on TTYs. */
397 /* Width in pixels. */
400 /* Ascent and descent in pixels. */
401 short ascent
, descent
;
403 /* Vertical offset. If < 0, the glyph is displayed raised, if > 0
404 the glyph is displayed lowered. */
407 /* Which kind of glyph this is---character, image etc. Value
408 should be an enumerator of type enum glyph_type. */
411 /* 1 means this glyph was produced from multibyte text. Zero
412 means it was produced from unibyte text, i.e. charsets aren't
413 applicable, and encoding is not performed. */
414 unsigned multibyte_p
: 1;
416 /* Non-zero means draw a box line at the left or right side of this
417 glyph. This is part of the implementation of the face attribute
419 unsigned left_box_line_p
: 1;
420 unsigned right_box_line_p
: 1;
422 /* Non-zero means this glyph's physical ascent or descent is greater
423 than its logical ascent/descent, i.e. it may potentially overlap
424 glyphs above or below it. */
425 unsigned overlaps_vertically_p
: 1;
427 /* For terminal frames, 1 means glyph is a padding glyph. Padding
428 glyphs are used for characters whose visual shape consists of
429 more than one glyph (e.g. Asian characters). All but the first
430 glyph of such a glyph sequence have the padding_p flag set. This
431 flag is used only to minimize code changes. A better way would
432 probably be to use the width field of glyphs to express padding.
434 For graphic frames, 1 means the pixel width of the glyph in a
435 font is 0, but 1-pixel is padded on displaying for correct cursor
436 displaying. The member `pixel_width' above is set to 1. */
437 unsigned padding_p
: 1;
439 /* 1 means the actual glyph is not available, draw using `struct
440 glyphless' below instead. This can happen when a font couldn't
441 be loaded, or a character doesn't have a glyph in a font. */
442 unsigned glyph_not_available_p
: 1;
444 /* Non-zero means don't display cursor here. */
445 unsigned avoid_cursor_p
: 1;
447 /* Resolved bidirectional level of this character [0..63]. */
448 unsigned resolved_level
: 5;
450 /* Resolved bidirectional type of this character, see enum
451 bidi_type_t below. Note that according to UAX#9, only some
452 values (STRONG_L, STRONG_R, WEAK_AN, WEAK_EN, WEAK_BN, and
453 NEUTRAL_B) can appear in the resolved type, so we only reserve
454 space for those that can. */
455 unsigned bidi_type
: 3;
457 #define FACE_ID_BITS 20
459 /* Face of the glyph. This is a realized face ID,
460 an index in the face cache of the frame. */
461 unsigned face_id
: FACE_ID_BITS
;
463 /* Type of font used to display the character glyph. May be used to
464 determine which set of functions to use to obtain font metrics
465 for the glyph. On W32, value should be an enumerator of the type
466 w32_char_font_type. Otherwise it equals FONT_TYPE_UNKNOWN. */
467 unsigned font_type
: 3;
469 /* A union of sub-structures for different glyph types. */
472 /* Metrics of a partial glyph of an image (type == IMAGE_GLYPH). */
473 struct glyph_slice img
;
474 /* Start and end indices of glyphs of a grapheme cluster of a
475 composition (type == COMPOSITE_GLYPH). */
476 struct { int from
, to
; } cmp
;
477 /* Pixel offsets for upper and lower part of the acronym. */
479 short upper_xoff
, upper_yoff
;
480 short lower_xoff
, lower_yoff
;
484 /* A union of sub-structures for different glyph types. */
487 /* Character code for character glyphs (type == CHAR_GLYPH). */
490 /* Sub-structures for type == COMPOSITE_GLYPH. */
493 /* Flag to tell if the composition is automatic or not. */
494 unsigned automatic
: 1;
495 /* ID of the composition. */
499 /* Image ID for image glyphs (type == IMAGE_GLYPH). */
502 /* Sub-structure for type == STRETCH_GLYPH. */
505 /* The height of the glyph. */
506 unsigned height
: 16;
508 /* The ascent of the glyph. */
509 unsigned ascent
: 16;
513 /* Sub-stretch for type == GLYPHLESS_GLYPH. */
516 /* Value is an enum of the type glyphless_display_method. */
518 /* 1 iff this glyph is for a character of no font. */
519 unsigned for_no_font
: 1;
520 /* Length of acronym or hexadecimal code string (at most 8). */
522 /* Character to display. Actually we need only 22 bits. */
526 /* Used to compare all bit-fields above in one step. */
532 /* Default value of the glyph font_type field. */
534 #define FONT_TYPE_UNKNOWN 0
536 /* Is GLYPH a space? */
538 #define CHAR_GLYPH_SPACE_P(GLYPH) \
539 ((GLYPH).u.ch == SPACEGLYPH && (GLYPH).face_id == DEFAULT_FACE_ID)
541 /* Are glyph slices of glyphs *X and *Y equal? It assumes that both
542 glyphs have the same type.
544 Note: for composition glyphs, we don't have to compare slice.cmp.to
545 because they should be the same if and only if slice.cmp.from are
548 #define GLYPH_SLICE_EQUAL_P(X, Y) \
549 ((X)->type == IMAGE_GLYPH \
550 ? ((X)->slice.img.x == (Y)->slice.img.x \
551 && (X)->slice.img.y == (Y)->slice.img.y \
552 && (X)->slice.img.width == (Y)->slice.img.width \
553 && (X)->slice.img.height == (Y)->slice.img.height) \
554 : ((X)->type != COMPOSITE_GLYPH \
555 || (X)->slice.cmp.from == (Y)->slice.cmp.from))
557 /* Are glyphs *X and *Y displayed equal? */
559 #define GLYPH_EQUAL_P(X, Y) \
560 ((X)->type == (Y)->type \
561 && (X)->u.val == (Y)->u.val \
562 && GLYPH_SLICE_EQUAL_P (X, Y) \
563 && (X)->face_id == (Y)->face_id \
564 && (X)->padding_p == (Y)->padding_p \
565 && (X)->left_box_line_p == (Y)->left_box_line_p \
566 && (X)->right_box_line_p == (Y)->right_box_line_p \
567 && (X)->voffset == (Y)->voffset \
568 && (X)->pixel_width == (Y)->pixel_width)
570 /* Are character codes, faces, padding_ps of glyphs *X and *Y equal? */
572 #define GLYPH_CHAR_AND_FACE_EQUAL_P(X, Y) \
573 ((X)->u.ch == (Y)->u.ch \
574 && (X)->face_id == (Y)->face_id \
575 && (X)->padding_p == (Y)->padding_p)
577 /* Fill a character glyph GLYPH. CODE, FACE_ID, PADDING_P correspond
578 to the bits defined for the typedef `GLYPH' in lisp.h. */
580 #define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P) \
583 (GLYPH).u.ch = (CODE); \
584 (GLYPH).face_id = (FACE_ID); \
585 (GLYPH).padding_p = (PADDING_P); \
589 /* Fill a character type glyph GLYPH from a glyph typedef FROM as
590 defined in lisp.h. */
592 #define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM) \
593 SET_CHAR_GLYPH ((GLYPH), \
594 GLYPH_CHAR ((FROM)), \
595 GLYPH_FACE ((FROM)), \
598 /* Construct a glyph code from a character glyph GLYPH. If the
599 character is multibyte, return -1 as we can't use glyph table for a
600 multibyte character. */
602 #define SET_GLYPH_FROM_CHAR_GLYPH(G, GLYPH) \
605 if ((GLYPH).u.ch < 256) \
606 SET_GLYPH ((G), (GLYPH).u.ch, ((GLYPH).face_id)); \
608 SET_GLYPH ((G), -1, 0); \
612 #define GLYPH_INVALID_P(GLYPH) (GLYPH_CHAR (GLYPH) < 0)
614 /* Is GLYPH a padding glyph? */
616 #define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p
621 /***********************************************************************
623 ***********************************************************************/
627 Glyph memory for frame-based redisplay is allocated from the heap
628 in one vector kept in a glyph pool structure which is stored with
629 the frame. The size of the vector is made large enough to cover
630 all windows on the frame.
632 Both frame and window glyph matrices reference memory from a glyph
633 pool in frame-based redisplay.
635 In window-based redisplay, no glyphs pools exist; windows allocate
636 and free their glyph memory themselves. */
640 /* Vector of glyphs allocated from the heap. */
641 struct glyph
*glyphs
;
643 /* Allocated size of `glyphs'. */
646 /* Number of rows and columns in a matrix. */
652 /***********************************************************************
654 ***********************************************************************/
658 Three kinds of glyph matrices exist:
660 1. Frame glyph matrices. These are used for terminal frames whose
661 redisplay needs a view of the whole screen due to limited terminal
662 capabilities. Frame matrices are used only in the update phase
663 of redisplay. They are built in update_frame and not used after
664 the update has been performed.
666 2. Window glyph matrices on frames having frame glyph matrices.
667 Such matrices are sub-matrices of their corresponding frame matrix,
668 i.e., frame glyph matrices and window glyph matrices share the same
669 glyph memory, which is allocated in the form of a glyph_pool structure.
670 Glyph rows in such a window matrix are slices of frame matrix rows.
672 3. Free-standing window glyph matrices managing their own glyph
673 storage. This form is used in window-based redisplay which
674 includes variable width and height fonts etc.
676 The size of a window's row vector depends on the height of fonts
677 defined on its frame. It is chosen so that the vector is large
678 enough to describe all lines in a window when it is displayed in
679 the smallest possible character size. When new fonts are loaded,
680 or window sizes change, the row vector is adjusted accordingly. */
684 /* The pool from which glyph memory is allocated, if any. This is
685 null for frame matrices and for window matrices managing their
687 struct glyph_pool
*pool
;
689 /* Vector of glyph row structures. The row at nrows - 1 is reserved
690 for the mode line. */
691 struct glyph_row
*rows
;
693 /* Number of elements allocated for the vector rows above. */
694 ptrdiff_t rows_allocated
;
696 /* The number of rows used by the window if all lines were displayed
697 with the smallest possible character height. */
700 /* Origin within the frame matrix if this is a window matrix on a
701 frame having a frame matrix. Both values are zero for
702 window-based redisplay. */
703 int matrix_x
, matrix_y
;
705 /* Width and height of the matrix in columns and rows. */
706 int matrix_w
, matrix_h
;
708 /* If this structure describes a window matrix of window W,
709 window_pixel_left is the value of W->pixel_left, window_pixel_top
710 the value of W->pixel_top, window_height and window_width are width
711 and height of W, as returned by window_box, and window_vscroll is
712 the value of W->vscroll at the time the matrix was last adjusted.
713 Only set for window-based redisplay. */
714 int window_pixel_left
, window_pixel_top
;
715 int window_height
, window_width
;
718 /* Number of glyphs reserved for left and right marginal areas when
719 the matrix was last adjusted. */
720 int left_margin_glyphs
, right_margin_glyphs
;
722 /* Flag indicating that scrolling should not be tried in
723 update_window. This flag is set by functions like try_window_id
724 which do their own scrolling. */
725 unsigned no_scrolling_p
: 1;
727 /* Non-zero means window displayed in this matrix has a header
729 unsigned header_line_p
: 1;
732 /* A string identifying the method used to display the matrix. */
736 /* The buffer this matrix displays. Set in
737 mark_window_display_accurate_1. */
738 struct buffer
*buffer
;
740 /* Values of BEGV and ZV as of last redisplay. Set in
741 mark_window_display_accurate_1. */
746 /* Check that glyph pointers stored in glyph rows of MATRIX are okay.
747 This aborts if any pointer is found twice. */
750 void check_matrix_pointer_lossage (struct glyph_matrix
*);
751 #define CHECK_MATRIX(MATRIX) check_matrix_pointer_lossage ((MATRIX))
753 #define CHECK_MATRIX(MATRIX) (void) 0
758 /***********************************************************************
760 ***********************************************************************/
762 /* Area in window glyph matrix. If values are added or removed,
763 the function mark_glyph_matrix in alloc.c may need to be changed. */
775 /* Rows of glyphs in a windows or frame glyph matrix.
777 Each row is partitioned into three areas. The start and end of
778 each area is recorded in a pointer as shown below.
780 +--------------------+-------------+---------------------+
781 | left margin area | text area | right margin area |
782 +--------------------+-------------+---------------------+
784 glyphs[LEFT_MARGIN_AREA] glyphs[RIGHT_MARGIN_AREA]
789 Rows in frame matrices reference glyph memory allocated in a frame
790 glyph pool (see the description of struct glyph_pool). Rows in
791 window matrices on frames having frame matrices reference slices of
792 the glyphs of corresponding rows in the frame matrix.
794 Rows in window matrices on frames having no frame matrices point to
795 glyphs allocated from the heap via xmalloc;
796 glyphs[LEFT_MARGIN_AREA] is the start address of the allocated
797 glyph structure array.
799 NOTE: layout of first four members of this structure is important,
800 see clear_glyph_row and copy_row_except_pointers to check why. */
804 /* Pointers to beginnings of areas. The end of an area A is found at
805 A + 1 in the vector. The last element of the vector is the end
808 Kludge alert: Even if used[TEXT_AREA] == 0, glyphs[TEXT_AREA][0]'s
809 position field is used. It is -1 if this row does not correspond
810 to any text; it is some buffer position if the row corresponds to
811 an empty display line that displays a line end. This is what old
812 redisplay used to do. (Except in code for terminal frames, this
813 kludge is no longer used, I believe. --gerd).
815 See also start, end, displays_text_p and ends_at_zv_p for cleaner
816 ways to do it. The special meaning of positions 0 and -1 will be
817 removed some day, so don't use it in new code. */
818 struct glyph
*glyphs
[1 + LAST_AREA
];
820 /* Number of glyphs actually filled in areas. This could have size
821 LAST_AREA, but it's 1 + LAST_AREA to simplify offset calculations. */
822 short used
[1 + LAST_AREA
];
824 /* Hash code. This hash code is available as soon as the row
825 is constructed, i.e. after a call to display_line. */
828 /* Window-relative x and y-position of the top-left corner of this
829 row. If y < 0, this means that eabs (y) pixels of the row are
830 invisible because it is partially visible at the top of a window.
831 If x < 0, this means that eabs (x) pixels of the first glyph of
832 the text area of the row are invisible because the glyph is
833 partially visible. */
836 /* Width of the row in pixels without taking face extension at the
837 end of the row into account, and without counting truncation
838 and continuation glyphs at the end of a row on ttys. */
841 /* Logical ascent/height of this line. The value of ascent is zero
842 and height is 1 on terminal frames. */
845 /* Physical ascent/height of this line. If max_ascent > ascent,
846 this line overlaps the line above it on the display. Otherwise,
847 if max_height > height, this line overlaps the line beneath it. */
848 int phys_ascent
, phys_height
;
850 /* Portion of row that is visible. Partially visible rows may be
851 found at the top and bottom of a window. This is 1 for tty
852 frames. It may be < 0 in case of completely invisible rows. */
855 /* Extra line spacing added after this row. Do not consider this
856 in last row when checking if row is fully visible. */
857 int extra_line_spacing
;
859 /* First position in this row. This is the text position, including
860 overlay position information etc, where the display of this row
861 started, and can thus be less than the position of the first
862 glyph (e.g. due to invisible text or horizontal scrolling).
863 BIDI Note: In R2L rows, that have its reversed_p flag set, this
864 position is at or beyond the right edge of the row. */
865 struct display_pos start
;
867 /* Text position at the end of this row. This is the position after
868 the last glyph on this row. It can be greater than the last
869 glyph position + 1, due to a newline that ends the line,
870 truncation, invisible text etc. In an up-to-date display, this
871 should always be equal to the start position of the next row.
872 BIDI Note: In R2L rows, this position is at or beyond the left
874 struct display_pos end
;
876 /* The smallest and the largest buffer positions that contributed to
877 glyphs in this row. Note that due to bidi reordering, these are
878 in general different from the text positions stored in `start'
879 and `end' members above, and also different from the buffer
880 positions recorded in the glyphs displayed the leftmost and
881 rightmost on the screen. */
882 struct text_pos minpos
, maxpos
;
884 /* Non-zero means the overlay arrow bitmap is on this line.
885 -1 means use default overlay arrow bitmap, else
886 it specifies actual fringe bitmap number. */
887 int overlay_arrow_bitmap
;
889 /* Left fringe bitmap number (enum fringe_bitmap_type). */
890 unsigned left_user_fringe_bitmap
: FRINGE_ID_BITS
;
892 /* Right fringe bitmap number (enum fringe_bitmap_type). */
893 unsigned right_user_fringe_bitmap
: FRINGE_ID_BITS
;
895 /* Left fringe bitmap number (enum fringe_bitmap_type). */
896 unsigned left_fringe_bitmap
: FRINGE_ID_BITS
;
898 /* Right fringe bitmap number (enum fringe_bitmap_type). */
899 unsigned right_fringe_bitmap
: FRINGE_ID_BITS
;
901 /* Face of the left fringe glyph. */
902 unsigned left_user_fringe_face_id
: FACE_ID_BITS
;
904 /* Face of the right fringe glyph. */
905 unsigned right_user_fringe_face_id
: FACE_ID_BITS
;
907 /* Face of the left fringe glyph. */
908 unsigned left_fringe_face_id
: FACE_ID_BITS
;
910 /* Face of the right fringe glyph. */
911 unsigned right_fringe_face_id
: FACE_ID_BITS
;
913 /* Vertical offset of the left fringe bitmap. */
914 signed left_fringe_offset
: FRINGE_HEIGHT_BITS
;
916 /* Vertical offset of the right fringe bitmap. */
917 signed right_fringe_offset
: FRINGE_HEIGHT_BITS
;
919 /* 1 means that at least one of the left and right fringe bitmaps is
920 periodic and thus depends on the y-position of the row. */
921 unsigned fringe_bitmap_periodic_p
: 1;
923 /* 1 means that we must draw the bitmaps of this row. */
924 unsigned redraw_fringe_bitmaps_p
: 1;
926 /* In a desired matrix, 1 means that this row must be updated. In a
927 current matrix, 0 means that the row has been invalidated, i.e.
928 the row's contents do not agree with what is visible on the
930 unsigned enabled_p
: 1;
932 /* 1 means row displays a text line that is truncated on the left or
934 unsigned truncated_on_left_p
: 1;
935 unsigned truncated_on_right_p
: 1;
937 /* 1 means that this row displays a continued line, i.e. it has a
938 continuation mark at the right side. */
939 unsigned continued_p
: 1;
941 /* 0 means that this row does not contain any text, i.e. it is
942 a blank line at the window and buffer end. */
943 unsigned displays_text_p
: 1;
945 /* 1 means that this line ends at ZV. */
946 unsigned ends_at_zv_p
: 1;
948 /* 1 means the face of the last glyph in the text area is drawn to
949 the right end of the window. This flag is used in
950 update_text_area to optimize clearing to the end of the area. */
951 unsigned fill_line_p
: 1;
953 /* Non-zero means display a bitmap on X frames indicating that this
954 line contains no text and ends in ZV. */
955 unsigned indicate_empty_line_p
: 1;
957 /* 1 means this row contains glyphs that overlap each other because
958 of lbearing or rbearing. */
959 unsigned contains_overlapping_glyphs_p
: 1;
961 /* 1 means this row is as wide as the window it is displayed in, including
962 scroll bars, fringes, and internal borders. This also
963 implies that the row doesn't have marginal areas. */
964 unsigned full_width_p
: 1;
966 /* Non-zero means row is a mode or header-line. */
967 unsigned mode_line_p
: 1;
969 /* 1 in a current row means this row is overlapped by another row. */
970 unsigned overlapped_p
: 1;
972 /* 1 means this line ends in the middle of a character consisting
973 of more than one glyph. Some glyphs have been put in this row,
974 the rest are put in rows below this one. */
975 unsigned ends_in_middle_of_char_p
: 1;
977 /* 1 means this line starts in the middle of a character consisting
978 of more than one glyph. Some glyphs have been put in the
979 previous row, the rest are put in this row. */
980 unsigned starts_in_middle_of_char_p
: 1;
982 /* 1 in a current row means this row overlaps others. */
983 unsigned overlapping_p
: 1;
985 /* 1 means some glyphs in this row are displayed in mouse-face. */
986 unsigned mouse_face_p
: 1;
988 /* 1 means this row was ended by a newline from a string. */
989 unsigned ends_in_newline_from_string_p
: 1;
991 /* 1 means this row width is exactly the width of the window, and the
992 final newline character is hidden in the right fringe. */
993 unsigned exact_window_width_line_p
: 1;
995 /* 1 means this row currently shows the cursor in the right fringe. */
996 unsigned cursor_in_fringe_p
: 1;
998 /* 1 means the last glyph in the row is part of an ellipsis. */
999 unsigned ends_in_ellipsis_p
: 1;
1001 /* Non-zero means display a bitmap on X frames indicating that this
1002 the first line of the buffer. */
1003 unsigned indicate_bob_p
: 1;
1005 /* Non-zero means display a bitmap on X frames indicating that this
1006 the top line of the window, but not start of the buffer. */
1007 unsigned indicate_top_line_p
: 1;
1009 /* Non-zero means display a bitmap on X frames indicating that this
1010 the last line of the buffer. */
1011 unsigned indicate_eob_p
: 1;
1013 /* Non-zero means display a bitmap on X frames indicating that this
1014 the bottom line of the window, but not end of the buffer. */
1015 unsigned indicate_bottom_line_p
: 1;
1017 /* Non-zero means the row was reversed to display text in a
1018 right-to-left paragraph. */
1019 unsigned reversed_p
: 1;
1021 /* Continuation lines width at the start of the row. */
1022 int continuation_lines_width
;
1024 #ifdef HAVE_WINDOW_SYSTEM
1025 /* Non-NULL means the current clipping area. This is temporarily
1026 set while exposing a region. Coordinates are frame-relative. */
1032 /* Get a pointer to row number ROW in matrix MATRIX. If GLYPH_DEBUG
1033 is defined, the function matrix_row checks that we don't try to
1034 access rows that are out of bounds. */
1037 struct glyph_row
*matrix_row (struct glyph_matrix
*, int);
1038 #define MATRIX_ROW(MATRIX, ROW) matrix_row ((MATRIX), (ROW))
1040 #define MATRIX_ROW(MATRIX, ROW) ((MATRIX)->rows + (ROW))
1043 /* Return a pointer to the row reserved for the mode line in MATRIX.
1044 Row MATRIX->nrows - 1 is always reserved for the mode line. */
1046 #define MATRIX_MODE_LINE_ROW(MATRIX) \
1047 ((MATRIX)->rows + (MATRIX)->nrows - 1)
1049 /* Return a pointer to the row reserved for the header line in MATRIX.
1050 This is always the first row in MATRIX because that's the only
1051 way that works in frame-based redisplay. */
1053 #define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows
1055 /* Return a pointer to first row in MATRIX used for text display. */
1057 #define MATRIX_FIRST_TEXT_ROW(MATRIX) \
1058 ((MATRIX)->rows->mode_line_p ? (MATRIX)->rows + 1 : (MATRIX)->rows)
1060 /* Return a pointer to the first glyph in the text area of a row.
1061 MATRIX is the glyph matrix accessed, and ROW is the row index in
1064 #define MATRIX_ROW_GLYPH_START(MATRIX, ROW) \
1065 (MATRIX_ROW ((MATRIX), (ROW))->glyphs[TEXT_AREA])
1067 /* Return the number of used glyphs in the text area of a row. */
1069 #define MATRIX_ROW_USED(MATRIX, ROW) \
1070 (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA])
1072 /* Return the character/ byte position at which the display of ROW
1073 starts. BIDI Note: this is the smallest character/byte position
1074 among characters in ROW, i.e. the first logical-order character
1075 displayed by ROW, which is not necessarily the smallest horizontal
1078 #define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->minpos.charpos)
1079 #define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->minpos.bytepos)
1081 /* Return the character/ byte position at which ROW ends. BIDI Note:
1082 this is the largest character/byte position among characters in
1083 ROW, i.e. the last logical-order character displayed by ROW, which
1084 is not necessarily the largest horizontal position. */
1086 #define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->maxpos.charpos)
1087 #define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->maxpos.bytepos)
1089 /* Return the vertical position of ROW in MATRIX. */
1091 #define MATRIX_ROW_VPOS(ROW, MATRIX) ((ROW) - (MATRIX)->rows)
1093 /* Return the last glyph row + 1 in MATRIX on window W reserved for
1094 text. If W has a mode line, the last row in the matrix is reserved
1097 #define MATRIX_BOTTOM_TEXT_ROW(MATRIX, W) \
1100 - (WINDOW_WANTS_MODELINE_P ((W)) ? 1 : 0))
1102 /* Non-zero if the face of the last glyph in ROW's text area has
1103 to be drawn to the end of the text area. */
1105 #define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)
1107 /* Set and query the enabled_p flag of glyph row ROW in MATRIX. */
1109 #define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
1110 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0)
1112 #define MATRIX_ROW_ENABLED_P(MATRIX, ROW) \
1113 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p)
1115 /* Non-zero if ROW displays text. Value is non-zero if the row is
1116 blank but displays a line end. */
1118 #define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)
1123 #define MR_PARTIALLY_VISIBLE(ROW) \
1124 ((ROW)->height != (ROW)->visible_height)
1126 #define MR_PARTIALLY_VISIBLE_AT_TOP(W, ROW) \
1127 ((ROW)->y < WINDOW_HEADER_LINE_HEIGHT ((W)))
1129 #define MR_PARTIALLY_VISIBLE_AT_BOTTOM(W, ROW) \
1130 (((ROW)->y + (ROW)->height - (ROW)->extra_line_spacing) \
1131 > WINDOW_BOX_HEIGHT_NO_MODE_LINE ((W)))
1133 /* Non-zero if ROW is not completely visible in window W. */
1135 #define MATRIX_ROW_PARTIALLY_VISIBLE_P(W, ROW) \
1136 (MR_PARTIALLY_VISIBLE ((ROW)) \
1137 && (MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)) \
1138 || MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW))))
1142 /* Non-zero if ROW is partially visible at the top of window W. */
1144 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW) \
1145 (MR_PARTIALLY_VISIBLE ((ROW)) \
1146 && MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)))
1148 /* Non-zero if ROW is partially visible at the bottom of window W. */
1150 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW) \
1151 (MR_PARTIALLY_VISIBLE ((ROW)) \
1152 && MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW)))
1154 /* Return the bottom Y + 1 of ROW. */
1156 #define MATRIX_ROW_BOTTOM_Y(ROW) ((ROW)->y + (ROW)->height)
1158 /* Is ROW the last visible one in the display described by the
1159 iterator structure pointed to by IT?. */
1161 #define MATRIX_ROW_LAST_VISIBLE_P(ROW, IT) \
1162 (MATRIX_ROW_BOTTOM_Y ((ROW)) >= (IT)->last_visible_y)
1164 /* Non-zero if ROW displays a continuation line. */
1166 #define MATRIX_ROW_CONTINUATION_LINE_P(ROW) \
1167 ((ROW)->continuation_lines_width > 0)
1169 /* Non-zero if ROW ends in the middle of a character. This is the
1170 case for continued lines showing only part of a display table entry
1171 or a control char, or an overlay string. */
1173 #define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW) \
1174 ((ROW)->end.dpvec_index > 0 \
1175 || (ROW)->end.overlay_string_index >= 0 \
1176 || (ROW)->ends_in_middle_of_char_p)
1178 /* Non-zero if ROW ends in the middle of an overlay string. */
1180 #define MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P(ROW) \
1181 ((ROW)->end.overlay_string_index >= 0)
1183 /* Non-zero if ROW starts in the middle of a character. See above. */
1185 #define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW) \
1186 ((ROW)->start.dpvec_index > 0 \
1187 || (ROW)->starts_in_middle_of_char_p \
1188 || ((ROW)->start.overlay_string_index >= 0 \
1189 && (ROW)->start.string_pos.charpos > 0))
1191 /* Non-zero means ROW overlaps its predecessor. */
1193 #define MATRIX_ROW_OVERLAPS_PRED_P(ROW) \
1194 ((ROW)->phys_ascent > (ROW)->ascent)
1196 /* Non-zero means ROW overlaps its successor. */
1198 #define MATRIX_ROW_OVERLAPS_SUCC_P(ROW) \
1199 ((ROW)->phys_height - (ROW)->phys_ascent \
1200 > (ROW)->height - (ROW)->ascent)
1202 /* A glyph for a space. */
1204 extern struct glyph space_glyph
;
1206 /* Non-zero means last display completed. Zero means it was
1209 extern bool display_completed
;
1213 /************************************************************************
1215 ************************************************************************/
1217 /* Enumeration for overriding/changing the face to use for drawing
1218 glyphs in draw_glyphs. */
1220 enum draw_glyphs_face
1230 #ifdef HAVE_WINDOW_SYSTEM
1232 /* A sequence of glyphs to be drawn in the same face. */
1236 /* X-origin of the string. */
1239 /* Y-origin and y-position of the base line of this string. */
1242 /* The width of the string, not including a face extension. */
1245 /* The width of the string, including a face extension. */
1246 int background_width
;
1248 /* The height of this string. This is the height of the line this
1249 string is drawn in, and can be different from the height of the
1250 font the string is drawn in. */
1253 /* Number of pixels this string overwrites in front of its x-origin.
1254 This number is zero if the string has an lbearing >= 0; it is
1255 -lbearing, if the string has an lbearing < 0. */
1258 /* Number of pixels this string overwrites past its right-most
1259 nominal x-position, i.e. x + width. Zero if the string's
1260 rbearing is <= its nominal width, rbearing - width otherwise. */
1263 /* The frame on which the glyph string is drawn. */
1266 /* The window on which the glyph string is drawn. */
1269 /* X display and window for convenience. */
1273 /* The glyph row for which this string was built. It determines the
1274 y-origin and height of the string. */
1275 struct glyph_row
*row
;
1277 /* The area within row. */
1278 enum glyph_row_area area
;
1280 /* Characters to be drawn, and number of characters. */
1284 /* A face-override for drawing cursors, mouse face and similar. */
1285 enum draw_glyphs_face hl
;
1287 /* Face in which this string is to be drawn. */
1290 /* Font in which this string is to be drawn. */
1293 /* Non-null means this string describes (part of) a static
1295 struct composition
*cmp
;
1297 /* If not negative, this string describes a compos. */
1300 /* Start and end glyph indices in a glyph-string. */
1301 int cmp_from
, cmp_to
;
1303 /* 1 means this glyph strings face has to be drawn to the right end
1304 of the window's drawing area. */
1305 unsigned extends_to_end_of_line_p
: 1;
1307 /* 1 means the background of this string has been drawn. */
1308 unsigned background_filled_p
: 1;
1310 /* 1 means glyph string must be drawn with 16-bit functions. */
1311 unsigned two_byte_p
: 1;
1313 /* 1 means that the original font determined for drawing this glyph
1314 string could not be loaded. The member `font' has been set to
1315 the frame's default font in this case. */
1316 unsigned font_not_found_p
: 1;
1318 /* 1 means that the face in which this glyph string is drawn has a
1320 unsigned stippled_p
: 1;
1322 #define OVERLAPS_PRED (1 << 0)
1323 #define OVERLAPS_SUCC (1 << 1)
1324 #define OVERLAPS_BOTH (OVERLAPS_PRED | OVERLAPS_SUCC)
1325 #define OVERLAPS_ERASED_CURSOR (1 << 2)
1326 /* Non-zero means only the foreground of this glyph string must be
1327 drawn, and we should use the physical height of the line this
1328 glyph string appears in as clip rect. If the value is
1329 OVERLAPS_ERASED_CURSOR, the clip rect is restricted to the rect
1330 of the erased cursor. OVERLAPS_PRED and OVERLAPS_SUCC mean we
1331 draw overlaps with the preceding and the succeeding rows,
1333 unsigned for_overlaps
: 3;
1335 /* 1 means that all glyphs in this glyph string has the flag
1336 padding_p set, and thus must be drawn one by one to have 1-pixel
1337 width even though the logical width in the font is zero. */
1338 unsigned padding_p
: 1;
1340 /* The GC to use for drawing this glyph string. */
1341 #if defined (HAVE_X_WINDOWS)
1344 #if defined (HAVE_NTGUI)
1349 /* A pointer to the first glyph in the string. This glyph
1350 corresponds to char2b[0]. Needed to draw rectangles if
1351 font_not_found_p is 1. */
1352 struct glyph
*first_glyph
;
1354 /* Image, if any. */
1358 struct glyph_slice slice
;
1360 /* Non-null means the horizontal clipping region starts from the
1361 left edge of *clip_head, and ends with the right edge of
1362 *clip_tail, not including their overhangs. */
1363 struct glyph_string
*clip_head
, *clip_tail
;
1365 /* The current clipping areas. */
1366 NativeRectangle clip
[2];
1368 /* Number of clipping areas. */
1371 int underline_position
;
1373 int underline_thickness
;
1375 struct glyph_string
*next
, *prev
;
1378 #endif /* HAVE_WINDOW_SYSTEM */
1381 /************************************************************************
1383 ************************************************************************/
1385 /* Return the height of the mode line in glyph matrix MATRIX, or zero
1386 if not known. This macro is called under circumstances where
1387 MATRIX might not have been allocated yet. */
1389 #define MATRIX_MODE_LINE_HEIGHT(MATRIX) \
1390 ((MATRIX) && (MATRIX)->rows \
1391 ? MATRIX_MODE_LINE_ROW (MATRIX)->height \
1394 /* Return the height of the header line in glyph matrix MATRIX, or zero
1395 if not known. This macro is called under circumstances where
1396 MATRIX might not have been allocated yet. */
1398 #define MATRIX_HEADER_LINE_HEIGHT(MATRIX) \
1399 ((MATRIX) && (MATRIX)->rows \
1400 ? MATRIX_HEADER_LINE_ROW (MATRIX)->height \
1403 /* Return the desired face id for the mode line of a window, depending
1404 on whether the window is selected or not, or if the window is the
1405 scrolling window for the currently active minibuffer window.
1407 Due to the way display_mode_lines manipulates with the contents of
1408 selected_window, this macro needs three arguments: SELW which is
1409 compared against the current value of selected_window, MBW which is
1410 compared against minibuf_window (if SELW doesn't match), and SCRW
1411 which is compared against minibuf_selected_window (if MBW matches). */
1413 #define CURRENT_MODE_LINE_FACE_ID_3(SELW, MBW, SCRW) \
1414 ((!mode_line_in_non_selected_windows \
1415 || (SELW) == XWINDOW (selected_window) \
1416 || (minibuf_level > 0 \
1417 && !NILP (minibuf_selected_window) \
1418 && (MBW) == XWINDOW (minibuf_window) \
1419 && (SCRW) == XWINDOW (minibuf_selected_window))) \
1420 ? MODE_LINE_FACE_ID \
1421 : MODE_LINE_INACTIVE_FACE_ID)
1424 /* Return the desired face id for the mode line of window W. */
1426 #define CURRENT_MODE_LINE_FACE_ID(W) \
1427 (CURRENT_MODE_LINE_FACE_ID_3((W), XWINDOW (selected_window), (W)))
1429 /* Return the current height of the mode line of window W. If not known
1430 from W->mode_line_height, look at W's current glyph matrix, or return
1431 a default based on the height of the font of the face `mode-line'. */
1433 #define CURRENT_MODE_LINE_HEIGHT(W) \
1434 (W->mode_line_height >= 0 \
1435 ? W->mode_line_height \
1436 : (W->mode_line_height \
1437 = (MATRIX_MODE_LINE_HEIGHT (W->current_matrix) \
1438 ? MATRIX_MODE_LINE_HEIGHT (W->current_matrix) \
1439 : estimate_mode_line_height \
1440 (XFRAME (W->frame), CURRENT_MODE_LINE_FACE_ID (W)))))
1442 /* Return the current height of the header line of window W. If not known
1443 from W->header_line_height, look at W's current glyph matrix, or return
1444 an estimation based on the height of the font of the face `header-line'. */
1446 #define CURRENT_HEADER_LINE_HEIGHT(W) \
1447 (W->header_line_height >= 0 \
1448 ? W->header_line_height \
1449 : (W->header_line_height \
1450 = (MATRIX_HEADER_LINE_HEIGHT (W->current_matrix) \
1451 ? MATRIX_HEADER_LINE_HEIGHT (W->current_matrix) \
1452 : estimate_mode_line_height \
1453 (XFRAME (W->frame), HEADER_LINE_FACE_ID))))
1455 /* Return the height of the desired mode line of window W. */
1457 #define DESIRED_MODE_LINE_HEIGHT(W) \
1458 MATRIX_MODE_LINE_HEIGHT ((W)->desired_matrix)
1460 /* Return the height of the desired header line of window W. */
1462 #define DESIRED_HEADER_LINE_HEIGHT(W) \
1463 MATRIX_HEADER_LINE_HEIGHT ((W)->desired_matrix)
1465 /* PXW: The height checks below serve to show at least one text line
1466 instead of a mode- and/or header line when a window gets very small.
1467 But (1) the check fails when the mode- or header-line is taller than
1468 the associated frame's line height and (2) we don't care much about
1469 text visibility anyway when shrinking a frame containing a toolbar.
1471 So maybe these checks should be removed and any clipping left to the
1474 /* Value is true if window W wants a mode line and is large enough
1475 to accommodate it. */
1476 #define WINDOW_WANTS_MODELINE_P(W) \
1477 (BUFFERP ((W)->contents) \
1478 ? (!MINI_WINDOW_P (W) \
1479 && !(W)->pseudo_window_p \
1480 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME (W))) \
1481 && !NILP (BVAR (XBUFFER ((W)->contents), mode_line_format)) \
1482 && WINDOW_PIXEL_HEIGHT (W) > WINDOW_FRAME_LINE_HEIGHT (W)) \
1485 /* Value is true if window W wants a header line and is large enough
1486 to accommodate it. */
1487 #define WINDOW_WANTS_HEADER_LINE_P(W) \
1488 (BUFFERP ((W)->contents) \
1489 ? (!MINI_WINDOW_P (W) \
1490 && !(W)->pseudo_window_p \
1491 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME (W))) \
1492 && !NILP (BVAR (XBUFFER ((W)->contents), header_line_format)) \
1493 && (WINDOW_PIXEL_HEIGHT (W) \
1494 > (WINDOW_WANTS_MODELINE_P (W) \
1495 ? (2 * WINDOW_FRAME_LINE_HEIGHT (W)) \
1496 : WINDOW_FRAME_LINE_HEIGHT (W)))) \
1499 /* Return proper value to be used as baseline offset of font that has
1500 ASCENT and DESCENT to draw characters by the font at the vertical
1501 center of the line of frame F.
1503 Here, our task is to find the value of BOFF in the following figure;
1505 -------------------------+-----------+-
1506 -+-+---------+-+ | |
1508 | | | | F_ASCENT F_HEIGHT
1511 | | |-|-+------+-----------|------- baseline
1513 | |---------|-+-+ | |
1515 -+-+---------+-+ F_DESCENT |
1516 -------------------------+-----------+-
1518 -BOFF + DESCENT + (F_HEIGHT - HEIGHT) / 2 = F_DESCENT
1519 BOFF = DESCENT + (F_HEIGHT - HEIGHT) / 2 - F_DESCENT
1520 DESCENT = FONT->descent
1521 HEIGHT = FONT_HEIGHT (FONT)
1522 F_DESCENT = (FRAME_FONT (F)->descent
1523 - F->terminal->output_data.x->baseline_offset)
1524 F_HEIGHT = FRAME_LINE_HEIGHT (F)
1527 #define VCENTER_BASELINE_OFFSET(FONT, F) \
1528 (FONT_DESCENT (FONT) \
1529 + (FRAME_LINE_HEIGHT ((F)) - FONT_HEIGHT ((FONT)) \
1530 + (FRAME_LINE_HEIGHT ((F)) > FONT_HEIGHT ((FONT)))) / 2 \
1531 - (FONT_DESCENT (FRAME_FONT (F)) - FRAME_BASELINE_OFFSET (F)))
1534 /***********************************************************************
1536 ***********************************************************************/
1538 /* Indices of face attributes in Lisp face vectors. Slot zero is the
1541 enum lface_attribute_index
1543 LFACE_FAMILY_INDEX
= 1,
1544 LFACE_FOUNDRY_INDEX
,
1549 LFACE_UNDERLINE_INDEX
,
1550 LFACE_INVERSE_INDEX
,
1551 LFACE_FOREGROUND_INDEX
,
1552 LFACE_BACKGROUND_INDEX
,
1553 LFACE_STIPPLE_INDEX
,
1554 LFACE_OVERLINE_INDEX
,
1555 LFACE_STRIKE_THROUGH_INDEX
,
1558 LFACE_INHERIT_INDEX
,
1559 LFACE_FONTSET_INDEX
,
1560 LFACE_DISTANT_FOREGROUND_INDEX
,
1565 /* Box types of faces. */
1569 /* No box around text. */
1572 /* Simple box of specified width and color. Default width is 1, and
1573 default color is the foreground color of the face. */
1576 /* Boxes with 3D shadows. Color equals the background color of the
1577 face. Width is specified. */
1582 /* Underline type. */
1584 enum face_underline_type
1590 /* Structure describing a realized face.
1592 For each Lisp face, 0..N realized faces can exist for different
1593 frames and different charsets. Realized faces are built from Lisp
1594 faces and text properties/overlays by merging faces and adding
1595 unspecified attributes from the `default' face. */
1599 /* The Lisp face attributes this face realizes. All attributes
1600 in this vector are non-nil. */
1601 Lisp_Object lface
[LFACE_VECTOR_SIZE
];
1603 /* The id of this face. The id equals the index of this face in the
1604 vector faces_by_id of its face cache. */
1607 #ifdef HAVE_WINDOW_SYSTEM
1609 /* If non-zero, this is a GC that we can use without modification for
1610 drawing the characters in this face. */
1613 /* Background stipple or bitmap used for this face. This is
1614 an id as returned from load_pixmap. */
1617 #endif /* not HAVE_WINDOW_SYSTEM */
1619 /* Pixel value of foreground color for X frames. Color index
1621 unsigned long foreground
;
1623 /* Pixel value or color index of background color. */
1624 unsigned long background
;
1626 /* Pixel value or color index of underline color. */
1627 unsigned long underline_color
;
1629 /* Pixel value or color index of overlined, strike-through, or box
1631 unsigned long overline_color
;
1632 unsigned long strike_through_color
;
1633 unsigned long box_color
;
1637 /* Fontset ID if for this face's fontset. Non-ASCII faces derived
1638 from the same ASCII face have the same fontset. */
1641 /* Non-zero means characters in this face have a box of that
1642 thickness around them. If this value is negative, its absolute
1643 value indicates the thickness, and the horizontal (top and
1644 bottom) borders of box are drawn inside of the character glyphs'
1645 area. The vertical (left and right) borders of the box are drawn
1646 in the same way as when this value is positive. */
1649 /* Type of box drawn. A value of FACE_NO_BOX means no box is drawn
1650 around text in this face. A value of FACE_SIMPLE_BOX means a box
1651 of width box_line_width is drawn in color box_color. A value of
1652 FACE_RAISED_BOX or FACE_SUNKEN_BOX means a 3D box is drawn with
1653 shadow colors derived from the background color of the face. */
1654 ENUM_BF (face_box_type
) box
: 2;
1656 /* Style of underlining. */
1657 ENUM_BF (face_underline_type
) underline_type
: 1;
1659 /* If `box' above specifies a 3D type, 1 means use box_color for
1661 unsigned use_box_color_for_shadows_p
: 1;
1663 /* Non-zero if text in this face should be underlined, overlined,
1664 strike-through or have a box drawn around it. */
1665 unsigned underline_p
: 1;
1666 unsigned overline_p
: 1;
1667 unsigned strike_through_p
: 1;
1669 /* 1 means that the colors specified for this face could not be
1670 loaded, and were replaced by default colors, so they shouldn't be
1672 unsigned foreground_defaulted_p
: 1;
1673 unsigned background_defaulted_p
: 1;
1675 /* 1 means that either no color is specified for underlining or that
1676 the specified color couldn't be loaded. Use the foreground
1677 color when drawing in that case. */
1678 unsigned underline_defaulted_p
: 1;
1680 /* 1 means that either no color is specified for the corresponding
1681 attribute or that the specified color couldn't be loaded.
1682 Use the foreground color when drawing in that case. */
1683 unsigned overline_color_defaulted_p
: 1;
1684 unsigned strike_through_color_defaulted_p
: 1;
1685 unsigned box_color_defaulted_p
: 1;
1687 /* TTY appearances. Colors are found in `lface' with empty color
1688 string meaning the default color of the TTY. */
1689 unsigned tty_bold_p
: 1;
1690 unsigned tty_italic_p
: 1;
1691 unsigned tty_underline_p
: 1;
1692 unsigned tty_reverse_p
: 1;
1694 /* 1 means that colors of this face may not be freed because they
1695 have been copied bitwise from a base face (see
1697 unsigned colors_copied_bitwise_p
: 1;
1699 /* If non-zero, use overstrike (to simulate bold-face). */
1700 unsigned overstrike
: 1;
1702 /* NOTE: this is not used yet, but eventually this impl should be done
1703 similarly to overstrike */
1705 /* If non-zero, use geometric rotation (to simulate italic). */
1706 unsigned synth_ital
: 1;
1709 /* The hash value of this face. */
1712 /* Next and previous face in hash collision list of face cache. */
1713 struct face
*next
, *prev
;
1715 /* If this face is an ASCII face, this points to this face itself.
1716 Otherwise, this points to an ASCII face that has the same
1717 attributes except the font. */
1718 struct face
*ascii_face
;
1720 /* Extra member that a font-driver uses privately. */
1725 /* Color index indicating that face uses a terminal's default color. */
1727 #define FACE_TTY_DEFAULT_COLOR ((unsigned long) -1)
1729 /* Color index indicating that face uses an unknown foreground color. */
1731 #define FACE_TTY_DEFAULT_FG_COLOR ((unsigned long) -2)
1733 /* Color index indicating that face uses an unknown background color. */
1735 #define FACE_TTY_DEFAULT_BG_COLOR ((unsigned long) -3)
1737 /* True if COLOR is a specified (i.e., nondefault) foreground or
1738 background color for a tty face. */
1741 face_tty_specified_color (unsigned long color
)
1743 return color
< FACE_TTY_DEFAULT_BG_COLOR
;
1746 /* Non-zero if FACE was realized for unibyte use. */
1748 #define FACE_UNIBYTE_P(FACE) ((FACE)->charset < 0)
1751 /* IDs of important faces known by the C face code. These are the IDs
1752 of the faces for CHARSET_ASCII. */
1758 MODE_LINE_INACTIVE_FACE_ID
,
1761 HEADER_LINE_FACE_ID
,
1767 VERTICAL_BORDER_FACE_ID
,
1768 WINDOW_DIVIDER_FACE_ID
,
1769 BASIC_FACE_ID_SENTINEL
1772 #define MAX_FACE_ID ((1 << FACE_ID_BITS) - 1)
1774 /* A cache of realized faces. Each frame has its own cache because
1775 Emacs allows different frame-local face definitions. */
1779 /* Hash table of cached realized faces. */
1780 struct face
**buckets
;
1782 /* Back-pointer to the frame this cache belongs to. */
1785 /* A vector of faces so that faces can be referenced by an ID. */
1786 struct face
**faces_by_id
;
1788 /* The allocated size, and number of used slots of faces_by_id. */
1792 /* Flag indicating that attributes of the `menu' face have been
1794 unsigned menu_face_changed_p
: 1;
1798 /* Prepare face FACE for use on frame F. This must be called before
1799 using X resources of FACE. */
1801 #define PREPARE_FACE_FOR_DISPLAY(F, FACE) \
1802 if ((FACE)->gc == 0) \
1803 prepare_face_for_display ((F), (FACE)); \
1807 /* Return a pointer to the face with ID on frame F, or null if such a
1808 face doesn't exist. */
1810 #define FACE_FROM_ID(F, ID) \
1811 (UNSIGNED_CMP (ID, <, FRAME_FACE_CACHE (F)->used) \
1812 ? FRAME_FACE_CACHE (F)->faces_by_id[ID] \
1815 #ifdef HAVE_WINDOW_SYSTEM
1817 /* Non-zero if FACE is suitable for displaying character CHAR. */
1819 #define FACE_SUITABLE_FOR_ASCII_CHAR_P(FACE, CHAR) \
1820 ((FACE) == (FACE)->ascii_face)
1822 /* Return the id of the realized face on frame F that is like the face
1823 with id ID but is suitable for displaying character CHAR.
1824 This macro is only meaningful for multibyte character CHAR. */
1826 #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) \
1827 face_for_char ((F), (FACE), (CHAR), (POS), (OBJECT))
1829 #else /* not HAVE_WINDOW_SYSTEM */
1831 #define FACE_SUITABLE_FOR_ASCII_CHAR_P(FACE, CHAR) 1
1832 #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) ((FACE)->id)
1834 #endif /* not HAVE_WINDOW_SYSTEM */
1836 /* Return true if G contains a valid character code. */
1838 GLYPH_CHAR_VALID_P (GLYPH g
)
1840 return CHAR_VALID_P (GLYPH_CHAR (g
));
1843 /* The glyph code from a display vector may either be an integer which
1844 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1845 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1848 GLYPH_CODE_P (Lisp_Object gc
)
1851 ? (CHARACTERP (XCAR (gc
))
1852 && RANGED_INTEGERP (0, XCDR (gc
), MAX_FACE_ID
))
1855 (MAX_FACE_ID
< TYPE_MAXIMUM (EMACS_INT
) >> CHARACTERBITS
1856 ? ((EMACS_INT
) MAX_FACE_ID
<< CHARACTERBITS
) | MAX_CHAR
1857 : TYPE_MAXIMUM (EMACS_INT
)))));
1860 /* Non-zero means face attributes have been changed since the last
1861 redisplay. Used in redisplay_internal. */
1863 extern int face_change_count
;
1865 /* For reordering of bidirectional text. */
1866 #define BIDI_MAXLEVEL 64
1868 /* Data type for describing the bidirectional character types. The
1869 first 7 must be at the beginning, because they are the only values
1870 valid in the `bidi_type' member of `struct glyph'; we only reserve
1871 3 bits for it, so we cannot use there values larger than 7.
1873 The order of members must be in sync with the 8th element of the
1874 member of unidata-prop-alist (in admin/unidata/unidata-gen.el) for
1875 Unicode character property `bidi-class'. */
1878 STRONG_L
, /* strong left-to-right */
1879 STRONG_R
, /* strong right-to-left */
1880 WEAK_EN
, /* european number */
1881 WEAK_AN
, /* arabic number */
1882 WEAK_BN
, /* boundary neutral */
1883 NEUTRAL_B
, /* paragraph separator */
1884 STRONG_AL
, /* arabic right-to-left letter */
1885 LRE
, /* left-to-right embedding */
1886 LRO
, /* left-to-right override */
1887 RLE
, /* right-to-left embedding */
1888 RLO
, /* right-to-left override */
1889 PDF
, /* pop directional format */
1890 LRI
, /* left-to-right isolate */
1891 RLI
, /* right-to-left isolate */
1892 FSI
, /* first strong isolate */
1893 PDI
, /* pop directional isolate */
1894 WEAK_ES
, /* european number separator */
1895 WEAK_ET
, /* european number terminator */
1896 WEAK_CS
, /* common separator */
1897 WEAK_NSM
, /* non-spacing mark */
1898 NEUTRAL_S
, /* segment separator */
1899 NEUTRAL_WS
, /* whitespace */
1900 NEUTRAL_ON
/* other neutrals */
1903 /* The basic directionality data type. */
1904 typedef enum { NEUTRAL_DIR
, L2R
, R2L
} bidi_dir_t
;
1906 /* Data type for storing information about characters we need to
1908 struct bidi_saved_info
{
1909 ptrdiff_t bytepos
, charpos
; /* character's buffer position */
1910 bidi_type_t type
; /* character's resolved bidi type */
1911 bidi_type_t type_after_w1
; /* original type of the character, after W1 */
1912 bidi_type_t orig_type
; /* type as we found it in the buffer */
1915 /* Data type for keeping track of saved embedding levels and override
1916 status information. */
1919 bidi_dir_t override
;
1922 /* Data type for storing information about a string being iterated on. */
1923 struct bidi_string_data
{
1924 Lisp_Object lstring
; /* Lisp string to reorder, or nil */
1925 const unsigned char *s
; /* string data, or NULL if reordering buffer */
1926 ptrdiff_t schars
; /* the number of characters in the string,
1927 excluding the terminating null */
1928 ptrdiff_t bufpos
; /* buffer position of lstring, or 0 if N/A */
1929 unsigned from_disp_str
: 1; /* 1 means the string comes from a
1931 unsigned unibyte
: 1; /* 1 means the string is unibyte */
1934 /* Data type for reordering bidirectional text. */
1936 ptrdiff_t bytepos
; /* iterator's position in buffer/string */
1938 int ch
; /* character at that position, or u+FFFC
1939 ("object replacement character") for a run
1940 of characters covered by a display string */
1941 ptrdiff_t nchars
; /* its "length", usually 1; it's > 1 for a run
1942 of characters covered by a display string */
1943 ptrdiff_t ch_len
; /* its length in bytes */
1944 bidi_type_t type
; /* bidi type of this character, after
1945 resolving weak and neutral types */
1946 bidi_type_t type_after_w1
; /* original type, after overrides and W1 */
1947 bidi_type_t orig_type
; /* original type, as found in the buffer */
1948 int resolved_level
; /* final resolved level of this character */
1949 int invalid_levels
; /* how many PDFs to ignore */
1950 int invalid_rl_levels
; /* how many PDFs from RLE/RLO to ignore */
1951 struct bidi_saved_info prev
; /* info about previous character */
1952 struct bidi_saved_info last_strong
; /* last-seen strong directional char */
1953 struct bidi_saved_info next_for_neutral
; /* surrounding characters for... */
1954 struct bidi_saved_info prev_for_neutral
; /* ...resolving neutrals */
1955 struct bidi_saved_info next_for_ws
; /* character after sequence of ws */
1956 ptrdiff_t next_en_pos
; /* pos. of next char for determining ET type */
1957 bidi_type_t next_en_type
; /* type of char at next_en_pos */
1958 ptrdiff_t ignore_bn_limit
; /* position until which to ignore BNs */
1959 bidi_dir_t sor
; /* direction of start-of-run in effect */
1960 int scan_dir
; /* direction of text scan, 1: forw, -1: back */
1961 ptrdiff_t disp_pos
; /* position of display string after ch */
1962 int disp_prop
; /* if non-zero, there really is a
1963 `display' property/string at disp_pos;
1964 if 2, the property is a `space' spec */
1965 int stack_idx
; /* index of current data on the stack */
1966 /* Note: Everything from here on is not copied/saved when the bidi
1967 iterator state is saved, pushed, or popped. So only put here
1968 stuff that is not part of the bidi iterator's state! */
1969 struct bidi_stack level_stack
[BIDI_MAXLEVEL
]; /* stack of embedding levels */
1970 struct bidi_string_data string
; /* string to reorder */
1971 struct window
*w
; /* the window being displayed */
1972 bidi_dir_t paragraph_dir
; /* current paragraph direction */
1973 ptrdiff_t separator_limit
; /* where paragraph separator should end */
1974 unsigned prev_was_pdf
: 1; /* if non-zero, previous char was PDF */
1975 unsigned first_elt
: 1; /* if non-zero, examine current char first */
1976 unsigned new_paragraph
: 1; /* if non-zero, we expect a new paragraph */
1977 unsigned frame_window_p
: 1; /* non-zero if displaying on a GUI frame */
1980 /* Value is non-zero when the bidi iterator is at base paragraph
1982 #define BIDI_AT_BASE_LEVEL(BIDI_IT) \
1983 ((BIDI_IT).resolved_level == (BIDI_IT).level_stack[0].level)
1986 /***********************************************************************
1988 ***********************************************************************/
1990 /* Structure used to describe where and how to draw a fringe bitmap.
1991 WHICH is the fringe bitmap to draw. WD and H is the (adjusted)
1992 width and height of the bitmap, DH is the height adjustment (if
1993 bitmap is periodic). X and Y are frame coordinates of the area to
1994 display the bitmap, DY is relative offset of the bitmap into that
1995 area. BX, NX, BY, NY specifies the area to clear if the bitmap
1996 does not fill the entire area. FACE is the fringe face. */
1998 struct draw_fringe_bitmap_params
2000 int which
; /* enum fringe_bitmap_type */
2001 unsigned short *bits
;
2005 unsigned cursor_p
: 1;
2006 unsigned overlay_p
: 1;
2010 #define MAX_FRINGE_BITMAPS (1<<FRINGE_ID_BITS)
2013 /***********************************************************************
2015 ***********************************************************************/
2017 /* Iteration over things to display in current_buffer or in a string.
2019 The iterator handles:
2021 1. Overlay strings (after-string, before-string).
2023 3. Invisible text properties.
2024 4. Selective display.
2025 5. Translation of characters via display tables.
2026 6. Translation of control characters to the forms `\003' or `^C'.
2027 7. `glyph' and `space-width' properties.
2029 Iterators are initialized by calling init_iterator or one of the
2030 equivalent functions below. A call to get_next_display_element
2031 loads the iterator structure with information about what next to
2032 display. A call to set_iterator_to_next increments the iterator's
2035 Characters from overlay strings, display table entries or control
2036 character translations are returned one at a time. For example, if
2037 we have a text of `a\x01' where `a' has a display table definition
2038 of `cd' and the control character is displayed with a leading
2039 arrow, then the iterator will return:
2041 Call Return Source Call next
2042 -----------------------------------------------------------------
2043 next c display table move
2044 next d display table move
2045 next ^ control char move
2046 next A control char move
2048 The same mechanism is also used to return characters for ellipses
2049 displayed at the end of invisible text.
2051 CAVEAT: Under some circumstances, move_.* functions can be called
2052 asynchronously, e.g. when computing a buffer position from an x and
2053 y pixel position. This means that these functions and functions
2054 called from them SHOULD NOT USE xmalloc and alike. See also the
2055 comment at the start of xdisp.c. */
2057 /* Enumeration describing what kind of display element an iterator is
2058 loaded with after a call to get_next_display_element. */
2060 enum display_element_type
2062 /* A normal character. */
2065 /* A composition (static and automatic). */
2068 /* A glyphless character (e.g. ZWNJ, LRE). */
2074 /* A flexible width and height space. */
2077 /* End of buffer or string. */
2080 /* Truncation glyphs. Never returned by get_next_display_element.
2081 Used to get display information about truncation glyphs via
2085 /* Continuation glyphs. See the comment for IT_TRUNCATION. */
2090 /* An enumerator for each text property that has a meaning for display
2099 COMPOSITION_PROP_IDX
,
2101 /* Not a property. Used to indicate changes in overlays. */
2108 /* An enumerator for the method of wrapping long lines. */
2110 enum line_wrap_method
2117 /* An enumerator for the method of displaying glyphless characters. */
2119 enum glyphless_display_method
2121 /* Display a thin (1-pixel width) space. On a TTY, display a
2122 1-character width space. */
2123 GLYPHLESS_DISPLAY_THIN_SPACE
,
2124 /* Display an empty box of proper width. */
2125 GLYPHLESS_DISPLAY_EMPTY_BOX
,
2126 /* Display an acronym string in a box. */
2127 GLYPHLESS_DISPLAY_ACRONYM
,
2128 /* Display the hexadecimal code of the character in a box. */
2129 GLYPHLESS_DISPLAY_HEX_CODE
2140 /* Input sources for fetching characters or data to display.
2141 The input source is found in the `method' field. */
2144 GET_FROM_BUFFER
= 0,
2145 GET_FROM_DISPLAY_VECTOR
,
2153 /* FIXME: What is this? Why 5? */
2154 #define IT_STACK_SIZE 5
2156 /* Iterator for composition (both for static and automatic). */
2157 struct composition_it
2159 /* Next position at which to check the composition. */
2161 /* ID number of the composition or glyph-string. If negative, we
2162 are not iterating over a composition now. */
2164 /* If non-negative, character that triggers the automatic
2165 composition at `stop_pos', and this is an automatic composition.
2166 If negative, this is a static composition. This is set to -2
2167 temporarily if searching of composition reach a limit or a
2170 /* If this is an automatic composition, index of a rule for making
2171 the automatic composition. Provided that ELT is an element of
2172 Vcomposition_function_table for CH, (nth ELT RULE_IDX) is the
2173 rule for the composition. */
2175 /* If this is an automatic composition, how many characters to look
2176 back from the position where a character triggering the
2177 composition exists. */
2179 /* If non-negative, number of glyphs of the glyph-string. */
2181 /* True iff the composition is created while buffer is scanned in
2182 reverse order, and thus the grapheme clusters must be rendered
2183 from the last to the first. */
2186 /** The following members contain information about the current
2187 grapheme cluster. */
2188 /* Position of the first character of the current grapheme cluster. */
2190 /* Number of characters and bytes of the current grapheme cluster. */
2192 /* Indices of the glyphs for the current grapheme cluster. */
2194 /* Width of the current grapheme cluster in units of pixels on a
2195 graphic display and in units of canonical characters on a
2196 terminal display. */
2202 /* The window in which we iterate over current_buffer (or a string). */
2206 /* The window's frame. */
2209 /* Method to use to load this structure with the next display element. */
2210 enum it_method method
;
2212 /* The next position at which to check for face changes, invisible
2213 text, overlay strings, end of text etc., which see. */
2214 ptrdiff_t stop_charpos
;
2216 /* Previous stop position, i.e. the last one before the current
2217 iterator position in `current'. */
2218 ptrdiff_t prev_stop
;
2220 /* Last stop position iterated across whose bidi embedding level is
2221 equal to the current paragraph's base embedding level. */
2222 ptrdiff_t base_level_stop
;
2224 /* Maximum string or buffer position + 1. ZV when iterating over
2226 ptrdiff_t end_charpos
;
2228 /* C string to iterate over. Non-null means get characters from
2229 this string, otherwise characters are read from current_buffer
2231 const unsigned char *s
;
2233 /* Number of characters in the string (s, or it->string) we iterate
2234 over. Used only in display_string and its subroutines; never
2235 used for overlay strings and strings from display properties. */
2236 ptrdiff_t string_nchars
;
2238 /* Position at which redisplay end trigger functions should be run. */
2239 ptrdiff_t redisplay_end_trigger_charpos
;
2241 /* 1 means multibyte characters are enabled. */
2242 unsigned multibyte_p
: 1;
2244 /* 1 means window has a mode line at its top. */
2245 unsigned header_line_p
: 1;
2247 /* 1 means `string' is the value of a `display' property.
2248 Don't handle some `display' properties in these strings. */
2249 unsigned string_from_display_prop_p
: 1;
2251 /* 1 means `string' comes from a `line-prefix' or `wrap-prefix'
2253 unsigned string_from_prefix_prop_p
: 1;
2255 /* 1 means we are iterating an object that came from a value of a
2256 `display' property. */
2257 unsigned from_disp_prop_p
: 1;
2259 /* When METHOD == next_element_from_display_vector,
2260 this is 1 if we're doing an ellipsis. Otherwise meaningless. */
2261 unsigned ellipsis_p
: 1;
2263 /* True means cursor shouldn't be displayed here. */
2264 unsigned avoid_cursor_p
: 1;
2266 /* Display table in effect or null for none. */
2267 struct Lisp_Char_Table
*dp
;
2269 /* Current display table vector to return characters from and its
2270 end. dpvec null means we are not returning characters from a
2271 display table entry; current.dpvec_index gives the current index
2272 into dpvec. This same mechanism is also used to return
2273 characters from translated control characters, i.e. `\003' or
2275 Lisp_Object
*dpvec
, *dpend
;
2277 /* Length in bytes of the char that filled dpvec. A value of zero
2278 means that no such character is involved. A negative value means
2279 the rest of the line from the current iterator position onwards
2280 is hidden by selective display or ellipsis. */
2283 /* Face id to use for all characters in display vector. -1 if unused. */
2286 /* Face id of the iterator saved in case a glyph from dpvec contains
2287 a face. The face is restored when all glyphs from dpvec have
2291 /* Vector of glyphs for control character translation. The pointer
2292 dpvec is set to ctl_chars when a control character is translated.
2293 This vector is also used for incomplete multibyte character
2294 translation (e.g \222\244). Such a character is at most 4 bytes,
2295 thus we need at most 16 bytes here. */
2296 Lisp_Object ctl_chars
[16];
2298 /* Initial buffer or string position of the iterator, before skipping
2299 over display properties and invisible text. */
2300 struct display_pos start
;
2302 /* Current buffer or string position of the iterator, including
2303 position in overlay strings etc. */
2304 struct display_pos current
;
2306 /* Total number of overlay strings to process. This can be >
2307 OVERLAY_STRING_CHUNK_SIZE. Value is dependable only when
2308 current.overlay_string_index >= 0. Use the latter to determine
2309 whether an overlay string is being iterated over, because
2310 n_overlay_strings can be positive even when we are not rendering
2311 an overlay string. */
2312 ptrdiff_t n_overlay_strings
;
2314 /* The charpos where n_overlay_strings was calculated. This should
2315 be set at the same time as n_overlay_strings. It is needed
2316 because we show before-strings at the start of invisible text;
2317 see handle_invisible_prop in xdisp.c. */
2318 ptrdiff_t overlay_strings_charpos
;
2320 /* Vector of overlays to process. Overlay strings are processed
2321 OVERLAY_STRING_CHUNK_SIZE at a time. */
2322 #define OVERLAY_STRING_CHUNK_SIZE 16
2323 Lisp_Object overlay_strings
[OVERLAY_STRING_CHUNK_SIZE
];
2325 /* For each overlay string, the overlay it came from. */
2326 Lisp_Object string_overlays
[OVERLAY_STRING_CHUNK_SIZE
];
2328 /* If non-nil, a Lisp string being processed. If
2329 current.overlay_string_index >= 0, this is an overlay string from
2330 pos. Use STRINGP (it.string) to test whether we are rendering a
2331 string or something else; do NOT use BUFFERP (it.object). */
2334 /* If non-nil, we are processing a string that came
2335 from a `display' property given by an overlay. */
2336 Lisp_Object from_overlay
;
2338 /* Stack of saved values. New entries are pushed when we begin to
2339 process an overlay string or a string from a `glyph' property.
2340 Entries are popped when we return to deliver display elements
2341 from what we previously had. */
2342 struct iterator_stack_entry
2346 ptrdiff_t end_charpos
;
2347 ptrdiff_t stop_charpos
;
2348 ptrdiff_t prev_stop
;
2349 ptrdiff_t base_level_stop
;
2350 struct composition_it cmp_it
;
2353 /* Save values specific to a given method. */
2355 /* method == GET_FROM_IMAGE */
2358 struct it_slice slice
;
2361 /* method == GET_FROM_COMPOSITION */
2365 /* method == GET_FROM_STRETCH */
2371 /* Current text and display positions. */
2372 struct text_pos position
;
2373 struct display_pos current
;
2374 Lisp_Object from_overlay
;
2375 enum glyph_row_area area
;
2376 enum it_method method
;
2377 bidi_dir_t paragraph_embedding
;
2378 unsigned multibyte_p
: 1;
2379 unsigned string_from_display_prop_p
: 1;
2380 unsigned string_from_prefix_prop_p
: 1;
2381 unsigned display_ellipsis_p
: 1;
2382 unsigned avoid_cursor_p
: 1;
2383 unsigned bidi_p
: 1;
2384 unsigned from_disp_prop_p
: 1;
2385 enum line_wrap_method line_wrap
;
2387 /* Properties from display property that are reset by another display
2390 Lisp_Object space_width
;
2391 Lisp_Object font_height
;
2393 stack
[IT_STACK_SIZE
];
2395 /* Stack pointer. */
2398 /* -1 means selective display hides everything between a \r and the
2399 next newline; > 0 means hide lines indented more than that value. */
2400 ptrdiff_t selective
;
2402 /* An enumeration describing what the next display element is
2403 after a call to get_next_display_element. */
2404 enum display_element_type what
;
2409 /* Setting of buffer-local variable selective-display-ellipsis. */
2410 unsigned selective_display_ellipsis_p
: 1;
2412 /* 1 means control characters are translated into the form `^C'
2413 where the `^' can be replaced by a display table entry. */
2414 unsigned ctl_arrow_p
: 1;
2416 /* Non-zero means that the current face has a box. */
2417 unsigned face_box_p
: 1;
2419 /* Non-null means that the current character is the first in a run
2420 of characters with box face. */
2421 unsigned start_of_box_run_p
: 1;
2423 /* Non-zero means that the current character is the last in a run
2424 of characters with box face. */
2425 unsigned end_of_box_run_p
: 1;
2427 /* 1 means overlay strings at end_charpos have been processed. */
2428 unsigned overlay_strings_at_end_processed_p
: 1;
2430 /* 1 means to ignore overlay strings at current pos, as they have
2431 already been processed. */
2432 unsigned ignore_overlay_strings_at_pos_p
: 1;
2434 /* 1 means the actual glyph is not available in the current
2436 unsigned glyph_not_available_p
: 1;
2438 /* 1 means the next line in display_line continues a character
2439 consisting of more than one glyph, and some glyphs of this
2440 character have been put on the previous line. */
2441 unsigned starts_in_middle_of_char_p
: 1;
2443 /* If 1, saved_face_id contains the id of the face in front of text
2444 skipped due to selective display. */
2445 unsigned face_before_selective_p
: 1;
2447 /* If 1, adjust current glyph so it does not increase current row
2448 descent/ascent (line-height property). Reset after this glyph. */
2449 unsigned constrain_row_ascent_descent_p
: 1;
2451 enum line_wrap_method line_wrap
;
2453 /* The ID of the default face to use. One of DEFAULT_FACE_ID,
2454 MODE_LINE_FACE_ID, etc, depending on what we are displaying. */
2457 /* If `what' == IT_CHARACTER, the character and the length in bytes
2458 of its multibyte sequence. The character comes from a buffer or
2459 a string. It may be different from the character displayed in
2460 case that unibyte_display_via_language_environment is set.
2462 If `what' == IT_COMPOSITION, the first component of a composition
2463 and length in bytes of the composition.
2465 If `what' is anything else, these two are undefined (will
2466 probably hold values for the last IT_CHARACTER or IT_COMPOSITION
2467 traversed by the iterator.
2469 The values are updated by get_next_display_element, so they are
2470 out of sync with the value returned by IT_CHARPOS between the
2471 time set_iterator_to_next advances the position and the time
2472 get_next_display_element loads the new values into c and len. */
2475 /* If what == IT_COMPOSITION, iterator substructure for the
2477 struct composition_it cmp_it
;
2479 /* The character to display, possibly translated to multibyte if
2480 multibyte_p is zero or unibyte_display_via_language_environment
2481 is set. This is set after get_next_display_element has been
2482 called. If we are setting it->C directly before calling
2483 PRODUCE_GLYPHS, this should be set beforehand too. */
2484 int char_to_display
;
2486 /* If what == IT_GLYPHLESS, the method to display such a
2488 enum glyphless_display_method glyphless_method
;
2490 /* If what == IT_IMAGE, the id of the image to display. */
2493 /* Values from `slice' property. */
2494 struct it_slice slice
;
2496 /* Value of the `space-width' property, if any; nil if none. */
2497 Lisp_Object space_width
;
2499 /* Computed from the value of the `raise' property. */
2502 /* Number of columns per \t. */
2505 /* Value of the `height' property, if any; nil if none. */
2506 Lisp_Object font_height
;
2508 /* Object and position where the current display element came from.
2509 Object is normally the buffer which is being rendered, but it can
2510 also be a Lisp string in case the current display element comes
2511 from an overlay string or from a display string (before- or
2512 after-string). It may also be nil when a C string is being
2513 rendered, e.g., during mode-line or header-line update. It can
2514 also be a cons cell of the form `(space ...)', when we produce a
2515 stretch glyph from a `display' specification. Finally, it can be
2516 a zero-valued Lisp integer, but only temporarily, when we are
2517 producing special glyphs for display purposes, like truncation
2518 and continuation glyphs, or blanks that extend each line to the
2519 edge of the window on a TTY.
2521 Do NOT use !BUFFERP (it.object) as a test whether we are
2522 iterating over a string; use STRINGP (it.string) instead.
2524 Position is the current iterator position in object. */
2526 struct text_pos position
;
2528 /* Width in pixels of truncation and continuation glyphs. */
2529 short truncation_pixel_width
, continuation_pixel_width
;
2531 /* First and last visible x-position in the display area. If window
2532 is hscrolled by n columns, first_visible_x == n * FRAME_COLUMN_WIDTH
2533 (f), and last_visible_x == pixel width of W + first_visible_x. */
2534 int first_visible_x
, last_visible_x
;
2536 /* Last visible y-position + 1 in the display area without a mode
2537 line, if the window has one. */
2540 /* Default amount of additional space in pixels between lines (for
2541 window systems only.) */
2542 int extra_line_spacing
;
2544 /* Max extra line spacing added in this row. */
2545 int max_extra_line_spacing
;
2547 /* Override font height information for this glyph.
2548 Used if override_ascent >= 0. Cleared after this glyph. */
2549 int override_ascent
, override_descent
, override_boff
;
2551 /* If non-null, glyphs are produced in glyph_row with each call to
2553 struct glyph_row
*glyph_row
;
2555 /* The area of glyph_row to which glyphs are added. */
2556 enum glyph_row_area area
;
2558 /* Number of glyphs needed for the last character requested via
2559 produce_glyphs. This is 1 except for tabs. */
2562 /* Width of the display element in pixels. Result of
2566 /* Current, maximum logical, and maximum physical line height
2567 information. Result of produce_glyphs. */
2568 int ascent
, descent
, max_ascent
, max_descent
;
2569 int phys_ascent
, phys_descent
, max_phys_ascent
, max_phys_descent
;
2571 /* Current x pixel position within the display line. This value
2572 does not include the width of continuation lines in front of the
2573 line. The value of current_x is automatically incremented by
2574 pixel_width with each call to produce_glyphs. */
2577 /* Accumulated width of continuation lines. If > 0, this means we
2578 are currently in a continuation line. This is initially zero and
2579 incremented/reset by display_line, move_it_to etc. */
2580 int continuation_lines_width
;
2582 /* Buffer position that ends the buffer text line being iterated.
2583 This is normally the position after the newline at EOL. If this
2584 is the last line of the buffer and it doesn't have a newline,
2585 value is ZV/ZV_BYTE. Set and used only if IT->bidi_p, for
2586 setting the end position of glyph rows produced for continuation
2587 lines, see display_line. */
2588 struct text_pos eol_pos
;
2590 /* Current y-position. Automatically incremented by the height of
2591 glyph_row in move_it_to and display_line. */
2594 /* Vertical matrix position of first text line in window. */
2597 /* Current vertical matrix position, or line number. Automatically
2598 incremented by move_it_to and display_line. */
2601 /* Horizontal matrix position reached in move_it_in_display_line.
2602 Only set there, not in display_line. */
2605 /* Left fringe bitmap number (enum fringe_bitmap_type). */
2606 unsigned left_user_fringe_bitmap
: FRINGE_ID_BITS
;
2608 /* Right fringe bitmap number (enum fringe_bitmap_type). */
2609 unsigned right_user_fringe_bitmap
: FRINGE_ID_BITS
;
2611 /* Face of the left fringe glyph. */
2612 unsigned left_user_fringe_face_id
: FACE_ID_BITS
;
2614 /* Face of the right fringe glyph. */
2615 unsigned right_user_fringe_face_id
: FACE_ID_BITS
;
2617 /* Non-zero means we need to reorder bidirectional text for display
2618 in the visual order. */
2619 unsigned bidi_p
: 1;
2621 /* For iterating over bidirectional text. */
2622 struct bidi_it bidi_it
;
2623 bidi_dir_t paragraph_embedding
;
2627 /* Access to positions of iterator IT. */
2629 #define IT_CHARPOS(IT) CHARPOS ((IT).current.pos)
2630 #define IT_BYTEPOS(IT) BYTEPOS ((IT).current.pos)
2631 #define IT_STRING_CHARPOS(IT) CHARPOS ((IT).current.string_pos)
2632 #define IT_STRING_BYTEPOS(IT) BYTEPOS ((IT).current.string_pos)
2634 /* Test if IT has reached the end of its buffer or string. This will
2635 only work after get_next_display_element has been called. */
2637 #define ITERATOR_AT_END_P(IT) ((IT)->what == IT_EOB)
2639 /* Non-zero means IT is at the end of a line. This is the case if it
2640 is either on a newline or on a carriage return and selective
2641 display hides the rest of the line. */
2643 #define ITERATOR_AT_END_OF_LINE_P(IT) \
2644 ((IT)->what == IT_CHARACTER \
2645 && ((IT)->c == '\n' \
2646 || ((IT)->c == '\r' && (IT)->selective)))
2648 /* Call produce_glyphs or FRAME_RIF->produce_glyphs, if set. Shortcut
2649 to avoid the function call overhead. */
2651 #define PRODUCE_GLYPHS(IT) \
2653 if ((IT)->glyph_row != NULL && (IT)->bidi_p) \
2655 if ((IT)->bidi_it.paragraph_dir == R2L) \
2656 (IT)->glyph_row->reversed_p = 1; \
2658 (IT)->glyph_row->reversed_p = 0; \
2660 if (FRAME_RIF ((IT)->f) != NULL) \
2661 FRAME_RIF ((IT)->f)->produce_glyphs ((IT)); \
2663 produce_glyphs ((IT)); \
2664 if ((IT)->glyph_row != NULL) \
2665 inhibit_free_realized_faces = 1; \
2668 /* Bit-flags indicating what operation move_it_to should perform. */
2670 enum move_operation_enum
2672 /* Stop if specified x-position is reached. */
2675 /* Stop if specified y-position is reached. */
2678 /* Stop if specified vpos is reached. */
2679 MOVE_TO_VPOS
= 0x04,
2681 /* Stop if specified buffer or string position is reached. */
2685 /***********************************************************************
2687 ***********************************************************************/
2689 /* Structure to hold mouse highlight data. */
2692 /* These variables describe the range of text currently shown in its
2693 mouse-face, together with the window they apply to. As long as
2694 the mouse stays within this range, we need not redraw anything on
2695 its account. Rows and columns are glyph matrix positions in
2696 MOUSE_FACE_WINDOW. */
2697 int mouse_face_beg_row
, mouse_face_beg_col
, mouse_face_beg_x
;
2698 int mouse_face_end_row
, mouse_face_end_col
, mouse_face_end_x
;
2699 Lisp_Object mouse_face_window
;
2700 int mouse_face_face_id
;
2701 Lisp_Object mouse_face_overlay
;
2703 /* FRAME and X, Y position of mouse when last checked for
2704 highlighting. X and Y can be negative or out of range for the frame. */
2705 struct frame
*mouse_face_mouse_frame
;
2706 int mouse_face_mouse_x
, mouse_face_mouse_y
;
2708 /* Nonzero if part of the text currently shown in
2709 its mouse-face is beyond the window end. */
2710 unsigned mouse_face_past_end
: 1;
2712 /* Nonzero means defer mouse-motion highlighting. */
2713 unsigned mouse_face_defer
: 1;
2715 /* Nonzero means that the mouse highlight should not be shown. */
2716 unsigned mouse_face_hidden
: 1;
2720 reset_mouse_highlight (Mouse_HLInfo
*hlinfo
)
2723 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
2724 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
2725 hlinfo
->mouse_face_mouse_x
= hlinfo
->mouse_face_mouse_y
= 0;
2726 hlinfo
->mouse_face_beg_x
= hlinfo
->mouse_face_end_x
= 0;
2727 hlinfo
->mouse_face_face_id
= DEFAULT_FACE_ID
;
2728 hlinfo
->mouse_face_mouse_frame
= NULL
;
2729 hlinfo
->mouse_face_window
= Qnil
;
2730 hlinfo
->mouse_face_overlay
= Qnil
;
2731 hlinfo
->mouse_face_past_end
= 0;
2732 hlinfo
->mouse_face_hidden
= 0;
2733 hlinfo
->mouse_face_defer
= 0;
2736 /***********************************************************************
2737 Window-based redisplay interface
2738 ***********************************************************************/
2740 /* Structure used to describe runs of lines that must be scrolled. */
2744 /* Source and destination y pixel position. */
2745 int desired_y
, current_y
;
2747 /* Source and destination vpos in matrix. */
2748 int desired_vpos
, current_vpos
;
2750 /* Height in pixels, number of glyph rows. */
2755 /* Handlers for setting frame parameters. */
2757 typedef void (*frame_parm_handler
) (struct frame
*, Lisp_Object
, Lisp_Object
);
2760 /* Structure holding system-dependent interface functions needed
2761 for window-based redisplay. */
2763 struct redisplay_interface
2765 /* Handlers for setting frame parameters. */
2766 frame_parm_handler
*frame_parm_handlers
;
2768 /* Produce glyphs/get display metrics for the display element IT is
2770 void (*produce_glyphs
) (struct it
*it
);
2772 /* Write or insert LEN glyphs from STRING at the nominal output
2774 void (*write_glyphs
) (struct window
*w
, struct glyph_row
*row
,
2775 struct glyph
*string
, enum glyph_row_area area
,
2777 void (*insert_glyphs
) (struct window
*w
, struct glyph_row
*row
,
2778 struct glyph
*start
, enum glyph_row_area area
,
2781 /* Clear from nominal output position to X. X < 0 means clear
2782 to right end of display. */
2783 void (*clear_end_of_line
) (struct window
*w
, struct glyph_row
*row
,
2784 enum glyph_row_area area
, int x
);
2786 /* Function to call to scroll the display as described by RUN on
2788 void (*scroll_run_hook
) (struct window
*w
, struct run
*run
);
2790 /* Function to call after a line in a display has been completely
2791 updated. Used to draw truncation marks and alike. DESIRED_ROW
2792 is the desired row which has been updated. */
2793 void (*after_update_window_line_hook
) (struct window
*w
,
2794 struct glyph_row
*desired_row
);
2796 /* Function to call before beginning to update window W in
2797 window-based redisplay. */
2798 void (*update_window_begin_hook
) (struct window
*w
);
2800 /* Function to call after window W has been updated in window-based
2801 redisplay. CURSOR_ON_P non-zero means switch cursor on.
2802 MOUSE_FACE_OVERWRITTEN_P non-zero means that some lines in W
2803 that contained glyphs in mouse-face were overwritten, so we
2804 have to update the mouse highlight. */
2805 void (*update_window_end_hook
) (struct window
*w
, bool cursor_on_p
,
2806 bool mouse_face_overwritten_p
);
2808 /* Flush the display of frame F. For X, this is XFlush. */
2809 void (*flush_display
) (struct frame
*f
);
2811 /* Clear the mouse highlight in window W, if there is any. */
2812 void (*clear_window_mouse_face
) (struct window
*w
);
2814 /* Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
2816 void (*get_glyph_overhangs
) (struct glyph
*glyph
, struct frame
*f
,
2817 int *left
, int *right
);
2819 /* Fix the display of AREA of ROW in window W for overlapping rows.
2820 This function is called from redraw_overlapping_rows after
2821 desired rows have been made current. */
2822 void (*fix_overlapping_area
) (struct window
*w
, struct glyph_row
*row
,
2823 enum glyph_row_area area
, int);
2825 #ifdef HAVE_WINDOW_SYSTEM
2827 /* Draw a fringe bitmap in window W of row ROW using parameters P. */
2828 void (*draw_fringe_bitmap
) (struct window
*w
, struct glyph_row
*row
,
2829 struct draw_fringe_bitmap_params
*p
);
2831 /* Define and destroy fringe bitmap no. WHICH. */
2832 void (*define_fringe_bitmap
) (int which
, unsigned short *bits
,
2834 void (*destroy_fringe_bitmap
) (int which
);
2836 /* Compute left and right overhang of glyph string S.
2837 A NULL pointer if platform does not support this. */
2838 void (*compute_glyph_string_overhangs
) (struct glyph_string
*s
);
2840 /* Draw a glyph string S. */
2841 void (*draw_glyph_string
) (struct glyph_string
*s
);
2843 /* Define cursor CURSOR on frame F. */
2844 void (*define_frame_cursor
) (struct frame
*f
, Cursor cursor
);
2846 /* Clear the area at (X,Y,WIDTH,HEIGHT) of frame F. */
2847 void (*clear_frame_area
) (struct frame
*f
, int x
, int y
,
2848 int width
, int height
);
2850 /* Draw specified cursor CURSOR_TYPE of width CURSOR_WIDTH
2851 at row GLYPH_ROW on window W if ON_P is 1. If ON_P is
2852 0, don't draw cursor. If ACTIVE_P is 1, system caret
2853 should track this cursor (when applicable). */
2854 void (*draw_window_cursor
) (struct window
*w
,
2855 struct glyph_row
*glyph_row
,
2857 enum text_cursor_kinds cursor_type
,
2858 int cursor_width
, bool on_p
, bool active_p
);
2860 /* Draw vertical border for window W from (X,Y_0) to (X,Y_1). */
2861 void (*draw_vertical_window_border
) (struct window
*w
,
2862 int x
, int y_0
, int y_1
);
2864 /* Draw window divider for window W from (X_0, Y_0) to (X_1, ,Y_1). */
2865 void (*draw_window_divider
) (struct window
*w
,
2866 int x_0
, int x_1
, int y_0
, int y_1
);
2868 /* Shift display of frame F to make room for inserted glyphs.
2869 The area at pixel (X,Y) of width WIDTH and height HEIGHT is
2870 shifted right by SHIFT_BY pixels. */
2871 void (*shift_glyphs_for_insert
) (struct frame
*f
,
2872 int x
, int y
, int width
,
2873 int height
, int shift_by
);
2875 #endif /* HAVE_WINDOW_SYSTEM */
2879 /***********************************************************************
2881 ***********************************************************************/
2883 #ifdef HAVE_WINDOW_SYSTEM
2885 /* Each image format (JPEG, TIFF, ...) supported is described by
2886 a structure of the type below. */
2890 /* A symbol uniquely identifying the image type, .e.g `jpeg'. */
2893 /* Check that SPEC is a valid image specification for the given
2894 image type. Value is true if SPEC is valid. */
2895 bool (* valid_p
) (Lisp_Object spec
);
2897 /* Load IMG which is used on frame F from information contained in
2898 IMG->spec. Value is true if successful. */
2899 bool (* load
) (struct frame
*f
, struct image
*img
);
2901 /* Free resources of image IMG which is used on frame F. */
2902 void (* free
) (struct frame
*f
, struct image
*img
);
2904 /* Initialization function (used for dynamic loading of image
2905 libraries on Windows), or NULL if none. */
2906 bool (* init
) (void);
2908 /* Next in list of all supported image types. */
2909 struct image_type
*next
;
2913 /* Structure describing an image. Specific image formats like XBM are
2914 converted into this form, so that display only has to deal with
2915 this type of image. */
2919 /* The time in seconds at which the image was last displayed. Set
2920 in prepare_image_for_display. */
2921 struct timespec timestamp
;
2923 /* Pixmaps of the image. */
2924 Pixmap pixmap
, mask
;
2926 #ifdef HAVE_X_WINDOWS
2927 /* X images of the image, corresponding to the above Pixmaps.
2928 Non-NULL means it and its Pixmap counterpart may be out of sync
2929 and the latter is outdated. NULL means the X image has been
2930 synchronized to Pixmap. */
2931 XImagePtr ximg
, mask_img
;
2934 /* Colors allocated for this image, if any. Allocated via xmalloc. */
2935 unsigned long *colors
;
2938 /* A single `background color' for this image, for the use of anyone that
2939 cares about such a thing. Only valid if the `background_valid' field
2940 is true. This should generally be accessed by calling the accessor
2941 macro `IMAGE_BACKGROUND', which will heuristically calculate a value
2943 unsigned long background
;
2945 /* Foreground and background colors of the frame on which the image
2947 unsigned long frame_foreground
, frame_background
;
2949 /* True if this image has a `transparent' background -- that is, is
2950 uses an image mask. The accessor macro for this is
2951 `IMAGE_BACKGROUND_TRANSPARENT'. */
2952 unsigned background_transparent
: 1;
2954 /* True if the `background' and `background_transparent' fields are
2955 valid, respectively. */
2956 unsigned background_valid
: 1, background_transparent_valid
: 1;
2958 /* Width and height of the image. */
2961 /* These values are used for the rectangles displayed for images
2962 that can't be loaded. */
2963 #define DEFAULT_IMAGE_WIDTH 30
2964 #define DEFAULT_IMAGE_HEIGHT 30
2966 /* Top/left and bottom/right corner pixel of actual image data.
2967 Used by four_corners_best to consider the real image data,
2968 rather than looking at the optional image margin. */
2970 #define TOP_CORNER 0
2971 #define LEFT_CORNER 1
2972 #define BOT_CORNER 2
2973 #define RIGHT_CORNER 3
2975 /* Percent of image height used as ascent. A value of
2976 CENTERED_IMAGE_ASCENT means draw the image centered on the
2979 #define DEFAULT_IMAGE_ASCENT 50
2980 #define CENTERED_IMAGE_ASCENT -1
2982 /* Lisp specification of this image. */
2985 /* List of "references" followed to build the image.
2986 Typically will just contain the name of the image file.
2987 Used to allow fine-grained cache flushing. */
2988 Lisp_Object dependencies
;
2990 /* Relief to draw around the image. */
2993 /* Optional margins around the image. This includes the relief. */
2994 int hmargin
, vmargin
;
2996 /* Reference to the type of the image. */
2997 struct image_type
*type
;
2999 /* 1 means that loading the image failed. Don't try again. */
3000 unsigned load_failed_p
;
3002 /* A place for image types to store additional data. It is marked
3004 Lisp_Object lisp_data
;
3006 /* Hash value of image specification to speed up comparisons. */
3009 /* Image id of this image. */
3012 /* Hash collision chain. */
3013 struct image
*next
, *prev
;
3017 /* Cache of images. Each frame has a cache. X frames with the same
3018 x_display_info share their caches. */
3022 /* Hash table of images. */
3023 struct image
**buckets
;
3025 /* Vector mapping image ids to images. */
3026 struct image
**images
;
3028 /* Allocated size of `images'. */
3031 /* Number of images in the cache. */
3034 /* Reference count (number of frames sharing this cache). */
3039 /* Value is a pointer to the image with id ID on frame F, or null if
3040 no image with that id exists. */
3042 #define IMAGE_FROM_ID(F, ID) \
3043 (((ID) >= 0 && (ID) < (FRAME_IMAGE_CACHE (F)->used)) \
3044 ? FRAME_IMAGE_CACHE (F)->images[ID] \
3047 /* Size of bucket vector of image caches. Should be prime. */
3049 #define IMAGE_CACHE_BUCKETS_SIZE 1001
3051 #endif /* HAVE_WINDOW_SYSTEM */
3055 /***********************************************************************
3057 ***********************************************************************/
3059 /* Enumeration defining where to find tool-bar item information in
3060 tool-bar items vectors stored with frames. Each tool-bar item
3061 occupies TOOL_BAR_ITEM_NSLOTS elements in such a vector. */
3063 enum tool_bar_item_idx
3065 /* The key of the tool-bar item. Used to remove items when a binding
3066 for `undefined' is found. */
3069 /* Non-nil if item is enabled. */
3070 TOOL_BAR_ITEM_ENABLED_P
,
3072 /* Non-nil if item is selected (pressed). */
3073 TOOL_BAR_ITEM_SELECTED_P
,
3076 TOOL_BAR_ITEM_CAPTION
,
3078 /* Image(s) to display. This is either a single image specification
3079 or a vector of specifications. */
3080 TOOL_BAR_ITEM_IMAGES
,
3083 TOOL_BAR_ITEM_BINDING
,
3085 /* Button type. One of nil (default button), t (a separator),
3086 `:radio', or `:toggle'. The latter two currently do nothing. */
3092 /* Icon file name of right to left image when an RTL locale is used. */
3093 TOOL_BAR_ITEM_RTL_IMAGE
,
3095 /* Label to show when text labels are enabled. */
3096 TOOL_BAR_ITEM_LABEL
,
3098 /* If we shall show the label only below the icon and not beside it. */
3099 TOOL_BAR_ITEM_VERT_ONLY
,
3101 /* Sentinel = number of slots in tool_bar_items occupied by one
3103 TOOL_BAR_ITEM_NSLOTS
3107 /* An enumeration for the different images that can be specified
3108 for a tool-bar item. */
3110 enum tool_bar_item_image
3112 TOOL_BAR_IMAGE_ENABLED_SELECTED
,
3113 TOOL_BAR_IMAGE_ENABLED_DESELECTED
,
3114 TOOL_BAR_IMAGE_DISABLED_SELECTED
,
3115 TOOL_BAR_IMAGE_DISABLED_DESELECTED
3118 #define DEFAULT_TOOL_BAR_LABEL_SIZE 14
3120 /* Default values of the above variables. */
3122 #define DEFAULT_TOOL_BAR_BUTTON_MARGIN 4
3123 #define DEFAULT_TOOL_BAR_BUTTON_RELIEF 1
3125 /* The height in pixels of the default tool-bar images. */
3127 #define DEFAULT_TOOL_BAR_IMAGE_HEIGHT 24
3130 /***********************************************************************
3131 Terminal Capabilities
3132 ***********************************************************************/
3134 /* Each of these is a bit representing a terminal `capability' (bold,
3135 inverse, etc). They are or'd together to specify the set of
3136 capabilities being queried for when calling `tty_capable_p' (which
3137 returns true if the terminal supports all of them). */
3139 #define TTY_CAP_INVERSE 0x01
3140 #define TTY_CAP_UNDERLINE 0x02
3141 #define TTY_CAP_BOLD 0x04
3142 #define TTY_CAP_DIM 0x08
3143 #define TTY_CAP_ITALIC 0x10
3146 /***********************************************************************
3148 ***********************************************************************/
3150 /* Defined in bidi.c */
3152 extern void bidi_init_it (ptrdiff_t, ptrdiff_t, bool, struct bidi_it
*);
3153 extern void bidi_move_to_visually_next (struct bidi_it
*);
3154 extern void bidi_paragraph_init (bidi_dir_t
, struct bidi_it
*, bool);
3155 extern int bidi_mirror_char (int);
3156 extern void bidi_push_it (struct bidi_it
*);
3157 extern void bidi_pop_it (struct bidi_it
*);
3158 extern void *bidi_shelve_cache (void);
3159 extern void bidi_unshelve_cache (void *, bool);
3161 /* Defined in xdisp.c */
3163 struct glyph_row
*row_containing_pos (struct window
*, ptrdiff_t,
3165 struct glyph_row
*, int);
3166 int line_bottom_y (struct it
*);
3167 int default_line_pixel_height (struct window
*);
3168 int display_prop_intangible_p (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3169 void resize_echo_area_exactly (void);
3170 int resize_mini_window (struct window
*, int);
3171 #if defined USE_TOOLKIT_SCROLL_BARS && !defined USE_GTK
3172 void set_vertical_scroll_bar (struct window
*);
3174 int try_window (Lisp_Object
, struct text_pos
, int);
3175 void window_box (struct window
*, enum glyph_row_area
,
3176 int *, int *, int *, int *);
3177 int window_box_height (struct window
*);
3178 int window_text_bottom_y (struct window
*);
3179 int window_box_width (struct window
*, enum glyph_row_area
);
3180 int window_box_left (struct window
*, enum glyph_row_area
);
3181 int window_box_left_offset (struct window
*, enum glyph_row_area
);
3182 int window_box_right (struct window
*, enum glyph_row_area
);
3183 int window_box_right_offset (struct window
*, enum glyph_row_area
);
3184 int estimate_mode_line_height (struct frame
*, enum face_id
);
3185 int move_it_to (struct it
*, ptrdiff_t, int, int, int, int);
3186 void pixel_to_glyph_coords (struct frame
*, int, int, int *, int *,
3187 NativeRectangle
*, int);
3188 void remember_mouse_glyph (struct frame
*, int, int, NativeRectangle
*);
3190 void mark_window_display_accurate (Lisp_Object
, int);
3191 void redisplay_preserve_echo_area (int);
3192 void init_iterator (struct it
*, struct window
*, ptrdiff_t,
3193 ptrdiff_t, struct glyph_row
*, enum face_id
);
3194 void init_iterator_to_row_start (struct it
*, struct window
*,
3195 struct glyph_row
*);
3196 void start_display (struct it
*, struct window
*, struct text_pos
);
3197 void move_it_vertically (struct it
*, int);
3198 void move_it_vertically_backward (struct it
*, int);
3199 void move_it_by_lines (struct it
*, ptrdiff_t);
3200 void move_it_past_eol (struct it
*);
3201 void move_it_in_display_line (struct it
*it
,
3202 ptrdiff_t to_charpos
, int to_x
,
3203 enum move_operation_enum op
);
3204 int in_display_vector_p (struct it
*);
3205 int frame_mode_line_height (struct frame
*);
3206 extern Lisp_Object Qtool_bar
;
3207 extern bool redisplaying_p
;
3208 extern bool help_echo_showing_p
;
3209 extern Lisp_Object help_echo_string
, help_echo_window
;
3210 extern Lisp_Object help_echo_object
, previous_help_echo_string
;
3211 extern ptrdiff_t help_echo_pos
;
3212 extern int last_tool_bar_item
;
3213 extern void reseat_at_previous_visible_line_start (struct it
*);
3214 extern Lisp_Object
lookup_glyphless_char_display (int, struct it
*);
3215 extern ptrdiff_t compute_display_string_pos (struct text_pos
*,
3216 struct bidi_string_data
*,
3217 struct window
*, int, int *);
3218 extern ptrdiff_t compute_display_string_end (ptrdiff_t,
3219 struct bidi_string_data
*);
3220 extern void produce_stretch_glyph (struct it
*);
3221 extern int merge_glyphless_glyph_face (struct it
*);
3223 #ifdef HAVE_WINDOW_SYSTEM
3226 extern void dump_glyph_string (struct glyph_string
*) EXTERNALLY_VISIBLE
;
3229 extern void x_get_glyph_overhangs (struct glyph
*, struct frame
*,
3231 extern void x_produce_glyphs (struct it
*);
3233 extern void x_write_glyphs (struct window
*, struct glyph_row
*,
3234 struct glyph
*, enum glyph_row_area
, int);
3235 extern void x_insert_glyphs (struct window
*, struct glyph_row
*,
3236 struct glyph
*, enum glyph_row_area
, int);
3237 extern void x_clear_end_of_line (struct window
*, struct glyph_row
*,
3238 enum glyph_row_area
, int);
3239 extern void x_fix_overlapping_area (struct window
*, struct glyph_row
*,
3240 enum glyph_row_area
, int);
3241 extern void draw_phys_cursor_glyph (struct window
*,
3243 enum draw_glyphs_face
);
3244 extern void get_phys_cursor_geometry (struct window
*, struct glyph_row
*,
3245 struct glyph
*, int *, int *, int *);
3247 extern void erase_phys_cursor (struct window
*);
3249 extern void display_and_set_cursor (struct window
*, bool, int, int, int, int);
3250 extern void x_update_cursor (struct frame
*, bool);
3251 extern void x_clear_cursor (struct window
*);
3252 extern void x_draw_vertical_border (struct window
*w
);
3253 extern void x_draw_right_divider (struct window
*w
);
3255 extern int get_glyph_string_clip_rects (struct glyph_string
*,
3256 NativeRectangle
*, int);
3257 extern void get_glyph_string_clip_rect (struct glyph_string
*,
3258 NativeRectangle
*nr
);
3259 extern Lisp_Object
find_hot_spot (Lisp_Object
, int, int);
3261 extern void handle_tool_bar_click (struct frame
*,
3262 int, int, int, int);
3264 extern void expose_frame (struct frame
*, int, int, int, int);
3265 extern int x_intersect_rectangles (XRectangle
*, XRectangle
*,
3267 #endif /* HAVE_WINDOW_SYSTEM */
3269 extern void note_mouse_highlight (struct frame
*, int, int);
3270 extern void x_clear_window_mouse_face (struct window
*);
3271 extern void cancel_mouse_face (struct frame
*);
3272 extern int clear_mouse_face (Mouse_HLInfo
*);
3273 extern int cursor_in_mouse_face_p (struct window
*w
);
3274 extern void tty_draw_row_with_mouse_face (struct window
*, struct glyph_row
*,
3275 int, int, enum draw_glyphs_face
);
3276 extern void display_tty_menu_item (const char *, int, int, int, int, int);
3278 /* Flags passed to try_window. */
3279 #define TRY_WINDOW_CHECK_MARGINS (1 << 0)
3280 #define TRY_WINDOW_IGNORE_FONTS_CHANGE (1 << 1)
3282 int lookup_fringe_bitmap (Lisp_Object
);
3283 void draw_fringe_bitmap (struct window
*, struct glyph_row
*, int);
3284 void draw_row_fringe_bitmaps (struct window
*, struct glyph_row
*);
3285 bool draw_window_fringes (struct window
*, bool);
3286 bool update_window_fringes (struct window
*, bool);
3287 void compute_fringe_widths (struct frame
*, bool);
3290 void w32_init_fringe (struct redisplay_interface
*);
3291 void w32_reset_fringes (void);
3294 extern unsigned row_hash (struct glyph_row
*);
3296 /* Defined in image.c */
3298 #ifdef HAVE_WINDOW_SYSTEM
3300 extern ptrdiff_t x_bitmap_pixmap (struct frame
*, ptrdiff_t);
3301 extern void x_reference_bitmap (struct frame
*, ptrdiff_t);
3302 extern ptrdiff_t x_create_bitmap_from_data (struct frame
*, char *,
3303 unsigned int, unsigned int);
3304 extern ptrdiff_t x_create_bitmap_from_file (struct frame
*, Lisp_Object
);
3305 #if defined HAVE_XPM && defined HAVE_X_WINDOWS && !defined USE_GTK
3306 extern ptrdiff_t x_create_bitmap_from_xpm_data (struct frame
*, const char **);
3308 #ifndef x_destroy_bitmap
3309 extern void x_destroy_bitmap (struct frame
*, ptrdiff_t);
3311 extern void x_destroy_all_bitmaps (Display_Info
*);
3312 extern void x_create_bitmap_mask (struct frame
*, ptrdiff_t);
3313 extern Lisp_Object
x_find_image_file (Lisp_Object
);
3315 void x_kill_gs_process (Pixmap
, struct frame
*);
3316 struct image_cache
*make_image_cache (void);
3317 void free_image_cache (struct frame
*);
3318 void clear_image_caches (Lisp_Object
);
3319 void mark_image_cache (struct image_cache
*);
3320 bool valid_image_p (Lisp_Object
);
3321 void prepare_image_for_display (struct frame
*, struct image
*);
3322 ptrdiff_t lookup_image (struct frame
*, Lisp_Object
);
3324 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3325 #define RGB_PIXEL_COLOR unsigned long
3329 #define RGB_PIXEL_COLOR COLORREF
3332 RGB_PIXEL_COLOR
image_background (struct image
*, struct frame
*,
3333 XImagePtr_or_DC ximg
);
3334 int image_background_transparent (struct image
*, struct frame
*,
3335 XImagePtr_or_DC mask
);
3337 int image_ascent (struct image
*, struct face
*, struct glyph_slice
*);
3341 /* Defined in sysdep.c */
3343 void get_tty_size (int, int *, int *);
3344 void request_sigio (void);
3345 void unrequest_sigio (void);
3346 bool tabs_safe_p (int);
3347 void init_baud_rate (int);
3348 void init_sigio (int);
3349 void ignore_sigio (void);
3351 /* Defined in xfaces.c. */
3353 #ifdef HAVE_X_WINDOWS
3354 void unload_color (struct frame
*, unsigned long);
3355 void x_free_colors (struct frame
*, unsigned long *, int);
3358 void update_face_from_frame_parameter (struct frame
*, Lisp_Object
,
3360 Lisp_Object
tty_color_name (struct frame
*, int);
3361 void clear_face_cache (int);
3363 unsigned long load_color (struct frame
*, struct face
*, Lisp_Object
,
3364 enum lface_attribute_index
);
3366 char *choose_face_font (struct frame
*, Lisp_Object
*, Lisp_Object
,
3368 void prepare_face_for_display (struct frame
*, struct face
*);
3369 int lookup_named_face (struct frame
*, Lisp_Object
, int);
3370 int lookup_basic_face (struct frame
*, int);
3371 int smaller_face (struct frame
*, int, int);
3372 int face_with_height (struct frame
*, int, int);
3373 int lookup_derived_face (struct frame
*, Lisp_Object
, int, int);
3374 void init_frame_faces (struct frame
*);
3375 void free_frame_faces (struct frame
*);
3376 void recompute_basic_faces (struct frame
*);
3377 int face_at_buffer_position (struct window
*w
, ptrdiff_t pos
,
3378 ptrdiff_t *endptr
, ptrdiff_t limit
,
3379 int mouse
, int base_face_id
);
3380 int face_for_overlay_string (struct window
*w
, ptrdiff_t pos
,
3381 ptrdiff_t *endptr
, ptrdiff_t limit
,
3382 int mouse
, Lisp_Object overlay
);
3383 int face_at_string_position (struct window
*w
, Lisp_Object string
,
3384 ptrdiff_t pos
, ptrdiff_t bufpos
,
3385 ptrdiff_t *endptr
, enum face_id
, int mouse
);
3386 int merge_faces (struct frame
*, Lisp_Object
, int, int);
3387 int compute_char_face (struct frame
*, int, Lisp_Object
);
3388 void free_all_realized_faces (Lisp_Object
);
3389 extern Lisp_Object Qforeground_color
, Qbackground_color
;
3390 extern char unspecified_fg
[], unspecified_bg
[];
3392 /* Defined in xfns.c. */
3394 #ifdef HAVE_X_WINDOWS
3395 void gamma_correct (struct frame
*, XColor
*);
3398 void gamma_correct (struct frame
*, COLORREF
*);
3401 #ifdef HAVE_WINDOW_SYSTEM
3403 void x_implicitly_set_name (struct frame
*, Lisp_Object
, Lisp_Object
);
3405 extern Lisp_Object tip_frame
;
3406 extern Window tip_window
;
3407 extern frame_parm_handler x_frame_parm_handlers
[];
3409 extern void start_hourglass (void);
3410 extern void cancel_hourglass (void);
3411 extern bool hourglass_shown_p
;
3412 /* If non-null, an asynchronous timer that, when it expires, displays
3413 an hourglass cursor on all frames. */
3414 extern struct atimer
*hourglass_atimer
;
3416 /* Each GUI implements these. FIXME: move into RIF. */
3417 extern void show_hourglass (struct atimer
*);
3418 extern void hide_hourglass (void);
3420 /* Returns the background color of IMG, calculating one heuristically if
3421 necessary. If non-zero, XIMG is an existing XImage object to use for
3424 #define IMAGE_BACKGROUND(img, f, ximg) \
3425 ((img)->background_valid \
3426 ? (img)->background \
3427 : image_background (img, f, ximg))
3429 /* Returns true if IMG has a `transparent' background, using heuristics
3430 to decide if necessary. If non-zero, MASK is an existing XImage
3431 object to use for the heuristic. */
3433 #define IMAGE_BACKGROUND_TRANSPARENT(img, f, mask) \
3434 ((img)->background_transparent_valid \
3435 ? (img)->background_transparent \
3436 : image_background_transparent (img, f, mask))
3438 #endif /* HAVE_WINDOW_SYSTEM */
3441 /* Defined in xmenu.c */
3443 int popup_activated (void);
3445 /* Defined in dispnew.c */
3447 extern Lisp_Object
buffer_posn_from_coords (struct window
*,
3449 struct display_pos
*,
3451 int *, int *, int *, int *);
3452 extern Lisp_Object
mode_line_string (struct window
*, enum window_part
,
3453 int *, int *, ptrdiff_t *,
3455 int *, int *, int *, int *);
3456 extern Lisp_Object
marginal_area_string (struct window
*, enum window_part
,
3457 int *, int *, ptrdiff_t *,
3459 int *, int *, int *, int *);
3460 extern void redraw_frame (struct frame
*);
3461 extern bool update_frame (struct frame
*, bool, bool);
3462 extern void update_frame_with_menu (struct frame
*);
3463 extern void bitch_at_user (void);
3464 extern void adjust_frame_glyphs (struct frame
*);
3465 void free_glyphs (struct frame
*);
3466 void free_window_matrices (struct window
*);
3467 void check_glyph_memory (void);
3468 void mirrored_line_dance (struct glyph_matrix
*, int, int, int *, char *);
3469 void clear_glyph_matrix (struct glyph_matrix
*);
3470 void clear_current_matrices (struct frame
*f
);
3471 void clear_desired_matrices (struct frame
*);
3472 void shift_glyph_matrix (struct window
*, struct glyph_matrix
*,
3474 void rotate_matrix (struct glyph_matrix
*, int, int, int);
3475 void increment_matrix_positions (struct glyph_matrix
*,
3476 int, int, ptrdiff_t, ptrdiff_t);
3477 void blank_row (struct window
*, struct glyph_row
*, int);
3478 void clear_glyph_matrix_rows (struct glyph_matrix
*, int, int);
3479 void clear_glyph_row (struct glyph_row
*);
3480 void prepare_desired_row (struct glyph_row
*);
3481 void update_single_window (struct window
*, bool);
3482 void do_pending_window_change (bool);
3483 void change_frame_size (struct frame
*, int, int, bool, bool, bool, bool);
3484 void init_display (void);
3485 void syms_of_display (void);
3486 extern Lisp_Object Qredisplay_dont_pause
;
3487 extern void spec_glyph_lookup_face (struct window
*, GLYPH
*);
3488 extern void fill_up_frame_row_with_spaces (struct glyph_row
*, int);
3490 /* Defined in terminal.c */
3492 extern void ring_bell (struct frame
*);
3493 extern void update_begin (struct frame
*);
3494 extern void update_end (struct frame
*);
3495 extern void set_terminal_window (struct frame
*, int);
3496 extern void cursor_to (struct frame
*, int, int);
3497 extern void raw_cursor_to (struct frame
*, int, int);
3498 extern void clear_to_end (struct frame
*);
3499 extern void clear_frame (struct frame
*);
3500 extern void clear_end_of_line (struct frame
*, int);
3501 extern void write_glyphs (struct frame
*, struct glyph
*, int);
3502 extern void insert_glyphs (struct frame
*, struct glyph
*, int);
3503 extern void delete_glyphs (struct frame
*, int);
3504 extern void ins_del_lines (struct frame
*, int, int);
3506 extern struct terminal
*init_initial_terminal (void);
3509 /* Defined in term.c */
3511 extern void tty_turn_off_insert (struct tty_display_info
*);
3512 extern int string_cost (const char *);
3513 extern int per_line_cost (const char *);
3514 extern void calculate_costs (struct frame
*);
3515 extern void produce_glyphs (struct it
*);
3516 extern bool tty_capable_p (struct tty_display_info
*, unsigned);
3517 extern void set_tty_color_mode (struct tty_display_info
*, struct frame
*);
3518 extern struct terminal
*get_named_tty (const char *);
3519 extern void create_tty_output (struct frame
*);
3520 extern struct terminal
*init_tty (const char *, const char *, bool);
3521 extern void tty_append_glyph (struct it
*);
3524 /* Defined in scroll.c */
3526 extern int scrolling_max_lines_saved (int, int, int *, int *, int *);
3527 extern void do_line_insertion_deletion_costs (struct frame
*, const char *,
3528 const char *, const char *,
3529 const char *, const char *,
3531 void scrolling_1 (struct frame
*, int, int, int, int *, int *, int *,
3534 /* Defined in frame.c */
3536 #ifdef HAVE_WINDOW_SYSTEM
3538 /* Types we might convert a resource string into. */
3546 RES_TYPE_BOOLEAN_NUMBER
3549 extern Display_Info
*check_x_display_info (Lisp_Object
);
3550 extern Lisp_Object
x_get_arg (Display_Info
*, Lisp_Object
,
3551 Lisp_Object
, const char *, const char *class,
3552 enum resource_types
);
3553 extern Lisp_Object
x_frame_get_and_record_arg (struct frame
*, Lisp_Object
,
3555 const char *, const char *,
3556 enum resource_types
);
3557 extern Lisp_Object
x_default_parameter (struct frame
*, Lisp_Object
,
3558 Lisp_Object
, Lisp_Object
,
3559 const char *, const char *,
3560 enum resource_types
);
3561 extern char *x_get_string_resource (XrmDatabase
, const char *,
3564 #ifndef HAVE_NS /* These both used on W32 and X only. */
3565 extern bool x_mouse_grabbed (Display_Info
*);
3566 extern void x_redo_mouse_highlight (Display_Info
*);
3567 #endif /* HAVE_NS */
3569 #endif /* HAVE_WINDOW_SYSTEM */
3573 #endif /* not DISPEXTERN_H_INCLUDED */