1 /* Interface definitions for display code.
3 Copyright (C) 1985, 1993-1994, 1997-2012 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
29 #include <X11/Intrinsic.h>
30 #endif /* USE_X_TOOLKIT */
32 #else /* !HAVE_X_WINDOWS */
34 /* X-related stuff used by non-X gui code. */
38 unsigned short red
, green
, blue
;
43 #endif /* HAVE_X_WINDOWS */
50 #ifndef DISPEXTERN_INLINE
51 # define DISPEXTERN_INLINE INLINE
54 #include <c-strcase.h>
56 xstrcasecmp (char const *a
, char const *b
)
58 return c_strcasecmp (a
, b
);
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 /* Structure forward declarations. Some are here because function
97 prototypes below reference structure types before their definition
98 in this file. Some are here because not every file including
99 dispextern.h also includes frame.h and windows.h. */
109 /* Values returned from coordinates_in_window. */
125 /* Number of bits allocated to store fringe bitmap numbers. */
126 #define FRINGE_ID_BITS 16
128 /* Number of bits allocated to store fringe bitmap height. */
129 #define FRINGE_HEIGHT_BITS 8
132 /***********************************************************************
134 ***********************************************************************/
136 /* If GLYPH_DEBUG is defined, additional checks are activated. */
138 /* Macros to include code only if GLYPH_DEBUG is defined. */
141 #define IF_DEBUG(X) X
143 #define IF_DEBUG(X) (void) 0
146 /* Macro for displaying traces of redisplay. If Emacs was compiled
147 with GLYPH_DEBUG defined, the variable trace_redisplay_p can be set to
148 a non-zero value in debugging sessions to activate traces. */
152 extern int trace_redisplay_p EXTERNALLY_VISIBLE
;
156 if (trace_redisplay_p) \
161 #else /* not GLYPH_DEBUG */
163 #define TRACE(X) (void) 0
165 #endif /* GLYPH_DEBUG */
169 /***********************************************************************
171 ***********************************************************************/
173 /* Starting with Emacs 20.3, characters from strings and buffers have
174 both a character and a byte position associated with them. The
175 following structure holds such a pair of positions. */
179 /* Character position. */
182 /* Corresponding byte position. */
186 /* Access character and byte position of POS in a functional form. */
188 #define BYTEPOS(POS) (POS).bytepos
189 #define CHARPOS(POS) (POS).charpos
191 /* Set character position of POS to CHARPOS, byte position to BYTEPOS. */
193 #define SET_TEXT_POS(POS, CHARPOS, BYTEPOS) \
194 ((POS).charpos = (CHARPOS), (POS).bytepos = BYTEPOS)
196 /* Increment text position POS. */
198 #define INC_TEXT_POS(POS, MULTIBYTE_P) \
203 INC_POS ((POS).bytepos); \
209 /* Decrement text position POS. */
211 #define DEC_TEXT_POS(POS, MULTIBYTE_P) \
216 DEC_POS ((POS).bytepos); \
222 /* Set text position POS from marker MARKER. */
224 #define SET_TEXT_POS_FROM_MARKER(POS, MARKER) \
225 (CHARPOS (POS) = marker_position ((MARKER)), \
226 BYTEPOS (POS) = marker_byte_position ((MARKER)))
228 /* Set marker MARKER from text position POS. */
230 #define SET_MARKER_FROM_TEXT_POS(MARKER, POS) \
231 set_marker_both ((MARKER), Qnil, CHARPOS ((POS)), BYTEPOS ((POS)))
233 /* Value is non-zero if character and byte positions of POS1 and POS2
236 #define TEXT_POS_EQUAL_P(POS1, POS2) \
237 ((POS1).charpos == (POS2).charpos \
238 && (POS1).bytepos == (POS2).bytepos)
240 /* When rendering glyphs, redisplay scans string or buffer text,
241 overlay strings in that text, and does display table or control
242 character translations. The following structure captures a
243 position taking all this into account. */
247 /* Buffer or string position. */
250 /* If this is a position in an overlay string, overlay_string_index
251 is the index of that overlay string in the sequence of overlay
252 strings at `pos' in the order redisplay processes them. A value
253 < 0 means that this is not a position in an overlay string. */
254 ptrdiff_t overlay_string_index
;
256 /* If this is a position in an overlay string, string_pos is the
257 position within that string. */
258 struct text_pos string_pos
;
260 /* If the character at the position above is a control character or
261 has a display table entry, dpvec_index is an index in the display
262 table or control character translation of that character. A
263 value < 0 means this is not a position in such a translation. */
269 /***********************************************************************
271 ***********************************************************************/
273 /* Enumeration of glyph types. Glyph structures contain a type field
274 containing one of the enumerators defined here. */
278 /* Glyph describes a character. */
281 /* Glyph describes a static composition. */
284 /* Glyph describes a glyphless character. */
287 /* Glyph describes an image. */
290 /* Glyph is a space of fractional width and/or height. */
293 /* Glyph is an external widget drawn by the GUI toolkit. */
299 /* Structure describing how to use partial glyphs (images slicing) */
306 unsigned height
: 16;
312 Be extra careful when changing this structure! Esp. make sure that
313 functions producing glyphs, like append_glyph, fill ALL of the
314 glyph structure, and that GLYPH_EQUAL_P compares all
315 display-relevant members of glyphs (not to imply that these are the
316 only things to check when you add a member). */
320 /* Position from which this glyph was drawn. If `object' below is a
321 Lisp string, this is a position in that string. If it is a
322 buffer, this is a position in that buffer. A value of -1
323 together with a null object means glyph is a truncation glyph at
324 the start of a row. */
327 /* Lisp object source of this glyph. Currently either a buffer or
328 a string, if the glyph was produced from characters which came from
329 a buffer or a string; or 0 if the glyph was inserted by redisplay
330 for its own purposes such as padding. */
333 /* Width in pixels. */
336 /* Ascent and descent in pixels. */
337 short ascent
, descent
;
339 /* Vertical offset. If < 0, the glyph is displayed raised, if > 0
340 the glyph is displayed lowered. */
343 /* Which kind of glyph this is---character, image etc. Value
344 should be an enumerator of type enum glyph_type. */
347 /* 1 means this glyph was produced from multibyte text. Zero
348 means it was produced from unibyte text, i.e. charsets aren't
349 applicable, and encoding is not performed. */
350 unsigned multibyte_p
: 1;
352 /* Non-zero means draw a box line at the left or right side of this
353 glyph. This is part of the implementation of the face attribute
355 unsigned left_box_line_p
: 1;
356 unsigned right_box_line_p
: 1;
358 /* Non-zero means this glyph's physical ascent or descent is greater
359 than its logical ascent/descent, i.e. it may potentially overlap
360 glyphs above or below it. */
361 unsigned overlaps_vertically_p
: 1;
363 /* For terminal frames, 1 means glyph is a padding glyph. Padding
364 glyphs are used for characters whose visual shape consists of
365 more than one glyph (e.g. Asian characters). All but the first
366 glyph of such a glyph sequence have the padding_p flag set. This
367 flag is used only to minimize code changes. A better way would
368 probably be to use the width field of glyphs to express padding.
370 For graphic frames, 1 means the pixel width of the glyph in a
371 font is 0, but 1-pixel is padded on displaying for correct cursor
372 displaying. The member `pixel_width' above is set to 1. */
373 unsigned padding_p
: 1;
375 /* 1 means the actual glyph is not available, draw using `struct
376 glyphless' below instead. This can happen when a font couldn't
377 be loaded, or a character doesn't have a glyph in a font. */
378 unsigned glyph_not_available_p
: 1;
380 /* Non-zero means don't display cursor here. */
381 unsigned avoid_cursor_p
: 1;
383 /* Resolved bidirectional level of this character [0..63]. */
384 unsigned resolved_level
: 5;
386 /* Resolved bidirectional type of this character, see enum
387 bidi_type_t below. Note that according to UAX#9, only some
388 values (STRONG_L, STRONG_R, WEAK_AN, WEAK_EN, WEAK_BN, and
389 NEUTRAL_B) can appear in the resolved type, so we only reserve
390 space for those that can. */
391 unsigned bidi_type
: 3;
393 #define FACE_ID_BITS 20
395 /* Face of the glyph. This is a realized face ID,
396 an index in the face cache of the frame. */
397 unsigned face_id
: FACE_ID_BITS
;
399 /* Type of font used to display the character glyph. May be used to
400 determine which set of functions to use to obtain font metrics
401 for the glyph. On W32, value should be an enumerator of the type
402 w32_char_font_type. Otherwise it equals FONT_TYPE_UNKNOWN. */
403 unsigned font_type
: 3;
405 /* A union of sub-structures for different glyph types. */
408 /* Metrics of a partial glyph of an image (type == IMAGE_GLYPH). */
409 struct glyph_slice img
;
410 /* Start and end indices of glyphs of a grapheme cluster of a
411 composition (type == COMPOSITE_GLYPH). */
412 struct { int from
, to
; } cmp
;
413 /* Pixel offsets for upper and lower part of the acronym. */
415 short upper_xoff
, upper_yoff
;
416 short lower_xoff
, lower_yoff
;
420 /* A union of sub-structures for different glyph types. */
423 /* Character code for character glyphs (type == CHAR_GLYPH). */
426 /* Sub-structures for type == COMPOSITE_GLYPH. */
429 /* Flag to tell if the composition is automatic or not. */
430 unsigned automatic
: 1;
431 /* ID of the composition. */
435 /* Image ID for image glyphs (type == IMAGE_GLYPH). */
439 struct xwidget
* xwidget
;
441 /* Sub-structure for type == STRETCH_GLYPH. */
444 /* The height of the glyph. */
445 unsigned height
: 16;
447 /* The ascent of the glyph. */
448 unsigned ascent
: 16;
452 /* Sub-stretch for type == GLYPHLESS_GLYPH. */
455 /* Value is an enum of the type glyphless_display_method. */
457 /* 1 iff this glyph is for a character of no font. */
458 unsigned for_no_font
: 1;
459 /* Length of acronym or hexadecimal code string (at most 8). */
461 /* Character to display. Actually we need only 22 bits. */
465 /* Used to compare all bit-fields above in one step. */
471 /* Default value of the glyph font_type field. */
473 #define FONT_TYPE_UNKNOWN 0
475 /* Is GLYPH a space? */
477 #define CHAR_GLYPH_SPACE_P(GLYPH) \
478 ((GLYPH).u.ch == SPACEGLYPH && (GLYPH).face_id == DEFAULT_FACE_ID)
480 /* Are glyph slices of glyphs *X and *Y equal? It assumes that both
481 glyphs have the same type.
483 Note: for composition glyphs, we don't have to compare slice.cmp.to
484 because they should be the same if and only if slice.cmp.from are
487 #define GLYPH_SLICE_EQUAL_P(X, Y) \
488 ((X)->type == IMAGE_GLYPH \
489 ? ((X)->slice.img.x == (Y)->slice.img.x \
490 && (X)->slice.img.y == (Y)->slice.img.y \
491 && (X)->slice.img.width == (Y)->slice.img.width \
492 && (X)->slice.img.height == (Y)->slice.img.height) \
493 : ((X)->type != COMPOSITE_GLYPH \
494 || (X)->slice.cmp.from == (Y)->slice.cmp.from))
496 /* Are glyphs *X and *Y displayed equal? */
498 #define GLYPH_EQUAL_P(X, Y) \
499 ((X)->type == (Y)->type \
500 && (X)->u.val == (Y)->u.val \
501 && GLYPH_SLICE_EQUAL_P (X, Y) \
502 && (X)->face_id == (Y)->face_id \
503 && (X)->padding_p == (Y)->padding_p \
504 && (X)->left_box_line_p == (Y)->left_box_line_p \
505 && (X)->right_box_line_p == (Y)->right_box_line_p \
506 && (X)->voffset == (Y)->voffset \
507 && (X)->pixel_width == (Y)->pixel_width)
509 /* Are character codes, faces, padding_ps of glyphs *X and *Y equal? */
511 #define GLYPH_CHAR_AND_FACE_EQUAL_P(X, Y) \
512 ((X)->u.ch == (Y)->u.ch \
513 && (X)->face_id == (Y)->face_id \
514 && (X)->padding_p == (Y)->padding_p)
516 /* Fill a character glyph GLYPH. CODE, FACE_ID, PADDING_P correspond
517 to the bits defined for the typedef `GLYPH' in lisp.h. */
519 #define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P) \
522 (GLYPH).u.ch = (CODE); \
523 (GLYPH).face_id = (FACE_ID); \
524 (GLYPH).padding_p = (PADDING_P); \
528 /* Fill a character type glyph GLYPH from a glyph typedef FROM as
529 defined in lisp.h. */
531 #define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM) \
532 SET_CHAR_GLYPH ((GLYPH), \
533 GLYPH_CHAR ((FROM)), \
534 GLYPH_FACE ((FROM)), \
537 /* Construct a glyph code from a character glyph GLYPH. If the
538 character is multibyte, return -1 as we can't use glyph table for a
539 multibyte character. */
541 #define SET_GLYPH_FROM_CHAR_GLYPH(G, GLYPH) \
544 if ((GLYPH).u.ch < 256) \
545 SET_GLYPH ((G), (GLYPH).u.ch, ((GLYPH).face_id)); \
547 SET_GLYPH ((G), -1, 0); \
551 #define GLYPH_INVALID_P(GLYPH) (GLYPH_CHAR (GLYPH) < 0)
553 /* Is GLYPH a padding glyph? */
555 #define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p
560 /***********************************************************************
562 ***********************************************************************/
566 Glyph memory for frame-based redisplay is allocated from the heap
567 in one vector kept in a glyph pool structure which is stored with
568 the frame. The size of the vector is made large enough to cover
569 all windows on the frame.
571 Both frame and window glyph matrices reference memory from a glyph
572 pool in frame-based redisplay.
574 In window-based redisplay, no glyphs pools exist; windows allocate
575 and free their glyph memory themselves. */
579 /* Vector of glyphs allocated from the heap. */
580 struct glyph
*glyphs
;
582 /* Allocated size of `glyphs'. */
585 /* Number of rows and columns in a matrix. */
591 /***********************************************************************
593 ***********************************************************************/
597 Three kinds of glyph matrices exist:
599 1. Frame glyph matrices. These are used for terminal frames whose
600 redisplay needs a view of the whole screen due to limited terminal
601 capabilities. Frame matrices are used only in the update phase
602 of redisplay. They are built in update_frame and not used after
603 the update has been performed.
605 2. Window glyph matrices on frames having frame glyph matrices.
606 Such matrices are sub-matrices of their corresponding frame matrix,
607 i.e. frame glyph matrices and window glyph matrices share the same
608 glyph memory which is allocated in form of a glyph_pool structure.
609 Glyph rows in such a window matrix are slices of frame matrix rows.
611 2. Free-standing window glyph matrices managing their own glyph
612 storage. This form is used in window-based redisplay which
613 includes variable width and height fonts etc.
615 The size of a window's row vector depends on the height of fonts
616 defined on its frame. It is chosen so that the vector is large
617 enough to describe all lines in a window when it is displayed in
618 the smallest possible character size. When new fonts are loaded,
619 or window sizes change, the row vector is adjusted accordingly. */
623 /* The pool from which glyph memory is allocated, if any. This is
624 null for frame matrices and for window matrices managing their
626 struct glyph_pool
*pool
;
628 /* Vector of glyph row structures. The row at nrows - 1 is reserved
629 for the mode line. */
630 struct glyph_row
*rows
;
632 /* Number of elements allocated for the vector rows above. */
633 ptrdiff_t rows_allocated
;
635 /* The number of rows used by the window if all lines were displayed
636 with the smallest possible character height. */
639 /* Origin within the frame matrix if this is a window matrix on a
640 frame having a frame matrix. Both values are zero for
641 window-based redisplay. */
642 int matrix_x
, matrix_y
;
644 /* Width and height of the matrix in columns and rows. */
645 int matrix_w
, matrix_h
;
647 /* If this structure describes a window matrix of window W,
648 window_left_col is the value of W->left_col, window_top_line the
649 value of W->top_line, window_height and window_width are width and
650 height of W, as returned by window_box, and window_vscroll is the
651 value of W->vscroll at the time the matrix was last adjusted.
652 Only set for window-based redisplay. */
653 int window_left_col
, window_top_line
;
654 int window_height
, window_width
;
657 /* Number of glyphs reserved for left and right marginal areas when
658 the matrix was last adjusted. */
659 int left_margin_glyphs
, right_margin_glyphs
;
661 /* Flag indicating that scrolling should not be tried in
662 update_window. This flag is set by functions like try_window_id
663 which do their own scrolling. */
664 unsigned no_scrolling_p
: 1;
666 /* Non-zero means window displayed in this matrix has a top mode
668 unsigned header_line_p
: 1;
671 /* A string identifying the method used to display the matrix. */
675 /* The buffer this matrix displays. Set in
676 mark_window_display_accurate_1. */
677 struct buffer
*buffer
;
679 /* Values of BEGV and ZV as of last redisplay. Set in
680 mark_window_display_accurate_1. */
685 /* Check that glyph pointers stored in glyph rows of MATRIX are okay.
686 This aborts if any pointer is found twice. */
689 void check_matrix_pointer_lossage (struct glyph_matrix
*);
690 #define CHECK_MATRIX(MATRIX) check_matrix_pointer_lossage ((MATRIX))
692 #define CHECK_MATRIX(MATRIX) (void) 0
697 /***********************************************************************
699 ***********************************************************************/
701 /* Area in window glyph matrix. If values are added or removed, the
702 function mark_object in alloc.c has to be changed. */
713 /* Rows of glyphs in a windows or frame glyph matrix.
715 Each row is partitioned into three areas. The start and end of
716 each area is recorded in a pointer as shown below.
718 +--------------------+-------------+---------------------+
719 | left margin area | text area | right margin area |
720 +--------------------+-------------+---------------------+
722 glyphs[LEFT_MARGIN_AREA] glyphs[RIGHT_MARGIN_AREA]
727 Rows in frame matrices reference glyph memory allocated in a frame
728 glyph pool (see the description of struct glyph_pool). Rows in
729 window matrices on frames having frame matrices reference slices of
730 the glyphs of corresponding rows in the frame matrix.
732 Rows in window matrices on frames having no frame matrices point to
733 glyphs allocated from the heap via xmalloc;
734 glyphs[LEFT_MARGIN_AREA] is the start address of the allocated
735 glyph structure array. */
739 /* Pointers to beginnings of areas. The end of an area A is found at
740 A + 1 in the vector. The last element of the vector is the end
743 Kludge alert: Even if used[TEXT_AREA] == 0, glyphs[TEXT_AREA][0]'s
744 position field is used. It is -1 if this row does not correspond
745 to any text; it is some buffer position if the row corresponds to
746 an empty display line that displays a line end. This is what old
747 redisplay used to do. (Except in code for terminal frames, this
748 kludge is no longer used, I believe. --gerd).
750 See also start, end, displays_text_p and ends_at_zv_p for cleaner
751 ways to do it. The special meaning of positions 0 and -1 will be
752 removed some day, so don't use it in new code. */
753 struct glyph
*glyphs
[1 + LAST_AREA
];
755 /* Number of glyphs actually filled in areas. */
756 short used
[LAST_AREA
];
758 /* Window-relative x and y-position of the top-left corner of this
759 row. If y < 0, this means that eabs (y) pixels of the row are
760 invisible because it is partially visible at the top of a window.
761 If x < 0, this means that eabs (x) pixels of the first glyph of
762 the text area of the row are invisible because the glyph is
763 partially visible. */
766 /* Width of the row in pixels without taking face extension at the
767 end of the row into account, and without counting truncation
768 and continuation glyphs at the end of a row on ttys. */
771 /* Logical ascent/height of this line. The value of ascent is zero
772 and height is 1 on terminal frames. */
775 /* Physical ascent/height of this line. If max_ascent > ascent,
776 this line overlaps the line above it on the display. Otherwise,
777 if max_height > height, this line overlaps the line beneath it. */
778 int phys_ascent
, phys_height
;
780 /* Portion of row that is visible. Partially visible rows may be
781 found at the top and bottom of a window. This is 1 for tty
782 frames. It may be < 0 in case of completely invisible rows. */
785 /* Extra line spacing added after this row. Do not consider this
786 in last row when checking if row is fully visible. */
787 int extra_line_spacing
;
789 /* Hash code. This hash code is available as soon as the row
790 is constructed, i.e. after a call to display_line. */
793 /* First position in this row. This is the text position, including
794 overlay position information etc, where the display of this row
795 started, and can thus be less than the position of the first
796 glyph (e.g. due to invisible text or horizontal scrolling).
797 BIDI Note: In R2L rows, that have its reversed_p flag set, this
798 position is at or beyond the right edge of the row. */
799 struct display_pos start
;
801 /* Text position at the end of this row. This is the position after
802 the last glyph on this row. It can be greater than the last
803 glyph position + 1, due to a newline that ends the line,
804 truncation, invisible text etc. In an up-to-date display, this
805 should always be equal to the start position of the next row.
806 BIDI Note: In R2L rows, this position is at or beyond the left
808 struct display_pos end
;
810 /* The smallest and the largest buffer positions that contributed to
811 glyphs in this row. Note that due to bidi reordering, these are
812 in general different from the text positions stored in `start'
813 and `end' members above, and also different from the buffer
814 positions recorded in the glyphs displayed the leftmost and
815 rightmost on the screen. */
816 struct text_pos minpos
, maxpos
;
818 /* Non-zero means the overlay arrow bitmap is on this line.
819 -1 means use default overlay arrow bitmap, else
820 it specifies actual fringe bitmap number. */
821 int overlay_arrow_bitmap
;
823 /* Left fringe bitmap number (enum fringe_bitmap_type). */
824 unsigned left_user_fringe_bitmap
: FRINGE_ID_BITS
;
826 /* Right fringe bitmap number (enum fringe_bitmap_type). */
827 unsigned right_user_fringe_bitmap
: FRINGE_ID_BITS
;
829 /* Left fringe bitmap number (enum fringe_bitmap_type). */
830 unsigned left_fringe_bitmap
: FRINGE_ID_BITS
;
832 /* Right fringe bitmap number (enum fringe_bitmap_type). */
833 unsigned right_fringe_bitmap
: FRINGE_ID_BITS
;
835 /* Face of the left fringe glyph. */
836 unsigned left_user_fringe_face_id
: FACE_ID_BITS
;
838 /* Face of the right fringe glyph. */
839 unsigned right_user_fringe_face_id
: FACE_ID_BITS
;
841 /* Face of the left fringe glyph. */
842 unsigned left_fringe_face_id
: FACE_ID_BITS
;
844 /* Face of the right fringe glyph. */
845 unsigned right_fringe_face_id
: FACE_ID_BITS
;
847 /* Vertical offset of the left fringe bitmap. */
848 signed left_fringe_offset
: FRINGE_HEIGHT_BITS
;
850 /* Vertical offset of the right fringe bitmap. */
851 signed right_fringe_offset
: FRINGE_HEIGHT_BITS
;
853 /* 1 means that at least one of the left and right fringe bitmaps is
854 periodic and thus depends on the y-position of the row. */
855 unsigned fringe_bitmap_periodic_p
: 1;
857 /* 1 means that we must draw the bitmaps of this row. */
858 unsigned redraw_fringe_bitmaps_p
: 1;
860 /* In a desired matrix, 1 means that this row must be updated. In a
861 current matrix, 0 means that the row has been invalidated, i.e.
862 the row's contents do not agree with what is visible on the
864 unsigned enabled_p
: 1;
866 /* 1 means row displays a text line that is truncated on the left or
868 unsigned truncated_on_left_p
: 1;
869 unsigned truncated_on_right_p
: 1;
871 /* 1 means that this row displays a continued line, i.e. it has a
872 continuation mark at the right side. */
873 unsigned continued_p
: 1;
875 /* 0 means that this row does not contain any text, i.e. it is
876 a blank line at the window and buffer end. */
877 unsigned displays_text_p
: 1;
879 /* 1 means that this line ends at ZV. */
880 unsigned ends_at_zv_p
: 1;
882 /* 1 means the face of the last glyph in the text area is drawn to
883 the right end of the window. This flag is used in
884 update_text_area to optimize clearing to the end of the area. */
885 unsigned fill_line_p
: 1;
887 /* Non-zero means display a bitmap on X frames indicating that this
888 line contains no text and ends in ZV. */
889 unsigned indicate_empty_line_p
: 1;
891 /* 1 means this row contains glyphs that overlap each other because
892 of lbearing or rbearing. */
893 unsigned contains_overlapping_glyphs_p
: 1;
895 /* 1 means this row is as wide as the window it is displayed in, including
896 scroll bars, fringes, and internal borders. This also
897 implies that the row doesn't have marginal areas. */
898 unsigned full_width_p
: 1;
900 /* Non-zero means row is a mode or header-line. */
901 unsigned mode_line_p
: 1;
903 /* 1 in a current row means this row is overlapped by another row. */
904 unsigned overlapped_p
: 1;
906 /* 1 means this line ends in the middle of a character consisting
907 of more than one glyph. Some glyphs have been put in this row,
908 the rest are put in rows below this one. */
909 unsigned ends_in_middle_of_char_p
: 1;
911 /* 1 means this line starts in the middle of a character consisting
912 of more than one glyph. Some glyphs have been put in the
913 previous row, the rest are put in this row. */
914 unsigned starts_in_middle_of_char_p
: 1;
916 /* 1 in a current row means this row overlaps others. */
917 unsigned overlapping_p
: 1;
919 /* 1 means some glyphs in this row are displayed in mouse-face. */
920 unsigned mouse_face_p
: 1;
922 /* 1 means this row was ended by a newline from a string. */
923 unsigned ends_in_newline_from_string_p
: 1;
925 /* 1 means this row width is exactly the width of the window, and the
926 final newline character is hidden in the right fringe. */
927 unsigned exact_window_width_line_p
: 1;
929 /* 1 means this row currently shows the cursor in the right fringe. */
930 unsigned cursor_in_fringe_p
: 1;
932 /* 1 means the last glyph in the row is part of an ellipsis. */
933 unsigned ends_in_ellipsis_p
: 1;
935 /* Non-zero means display a bitmap on X frames indicating that this
936 the first line of the buffer. */
937 unsigned indicate_bob_p
: 1;
939 /* Non-zero means display a bitmap on X frames indicating that this
940 the top line of the window, but not start of the buffer. */
941 unsigned indicate_top_line_p
: 1;
943 /* Non-zero means display a bitmap on X frames indicating that this
944 the last line of the buffer. */
945 unsigned indicate_eob_p
: 1;
947 /* Non-zero means display a bitmap on X frames indicating that this
948 the bottom line of the window, but not end of the buffer. */
949 unsigned indicate_bottom_line_p
: 1;
951 /* Non-zero means the row was reversed to display text in a
952 right-to-left paragraph. */
953 unsigned reversed_p
: 1;
955 /* Continuation lines width at the start of the row. */
956 int continuation_lines_width
;
958 #ifdef HAVE_WINDOW_SYSTEM
959 /* Non-NULL means the current clipping area. This is temporarily
960 set while exposing a region. Coordinates are frame-relative. */
966 /* Get a pointer to row number ROW in matrix MATRIX. If GLYPH_DEBUG
967 is defined, the function matrix_row checks that we don't try to
968 access rows that are out of bounds. */
971 struct glyph_row
*matrix_row (struct glyph_matrix
*, int);
972 #define MATRIX_ROW(MATRIX, ROW) matrix_row ((MATRIX), (ROW))
974 #define MATRIX_ROW(MATRIX, ROW) ((MATRIX)->rows + (ROW))
977 /* Return a pointer to the row reserved for the mode line in MATRIX.
978 Row MATRIX->nrows - 1 is always reserved for the mode line. */
980 #define MATRIX_MODE_LINE_ROW(MATRIX) \
981 ((MATRIX)->rows + (MATRIX)->nrows - 1)
983 /* Return a pointer to the row reserved for the header line in MATRIX.
984 This is always the first row in MATRIX because that's the only
985 way that works in frame-based redisplay. */
987 #define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows
989 /* Return a pointer to first row in MATRIX used for text display. */
991 #define MATRIX_FIRST_TEXT_ROW(MATRIX) \
992 ((MATRIX)->rows->mode_line_p ? (MATRIX)->rows + 1 : (MATRIX)->rows)
994 /* Return a pointer to the first glyph in the text area of a row.
995 MATRIX is the glyph matrix accessed, and ROW is the row index in
998 #define MATRIX_ROW_GLYPH_START(MATRIX, ROW) \
999 (MATRIX_ROW ((MATRIX), (ROW))->glyphs[TEXT_AREA])
1001 /* Return the number of used glyphs in the text area of a row. */
1003 #define MATRIX_ROW_USED(MATRIX, ROW) \
1004 (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA])
1006 /* Return the character/ byte position at which the display of ROW
1007 starts. BIDI Note: this is the smallest character/byte position
1008 among characters in ROW, i.e. the first logical-order character
1009 displayed by ROW, which is not necessarily the smallest horizontal
1012 #define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->minpos.charpos)
1013 #define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->minpos.bytepos)
1015 /* Return the character/ byte position at which ROW ends. BIDI Note:
1016 this is the largest character/byte position among characters in
1017 ROW, i.e. the last logical-order character displayed by ROW, which
1018 is not necessarily the largest horizontal position. */
1020 #define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->maxpos.charpos)
1021 #define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->maxpos.bytepos)
1023 /* Return the vertical position of ROW in MATRIX. */
1025 #define MATRIX_ROW_VPOS(ROW, MATRIX) ((ROW) - (MATRIX)->rows)
1027 /* Return the last glyph row + 1 in MATRIX on window W reserved for
1028 text. If W has a mode line, the last row in the matrix is reserved
1031 #define MATRIX_BOTTOM_TEXT_ROW(MATRIX, W) \
1034 - (WINDOW_WANTS_MODELINE_P ((W)) ? 1 : 0))
1036 /* Non-zero if the face of the last glyph in ROW's text area has
1037 to be drawn to the end of the text area. */
1039 #define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)
1041 /* Set and query the enabled_p flag of glyph row ROW in MATRIX. */
1043 #define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
1044 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0)
1046 #define MATRIX_ROW_ENABLED_P(MATRIX, ROW) \
1047 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p)
1049 /* Non-zero if ROW displays text. Value is non-zero if the row is
1050 blank but displays a line end. */
1052 #define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)
1057 #define MR_PARTIALLY_VISIBLE(ROW) \
1058 ((ROW)->height != (ROW)->visible_height)
1060 #define MR_PARTIALLY_VISIBLE_AT_TOP(W, ROW) \
1061 ((ROW)->y < WINDOW_HEADER_LINE_HEIGHT ((W)))
1063 #define MR_PARTIALLY_VISIBLE_AT_BOTTOM(W, ROW) \
1064 (((ROW)->y + (ROW)->height - (ROW)->extra_line_spacing) \
1065 > WINDOW_BOX_HEIGHT_NO_MODE_LINE ((W)))
1067 /* Non-zero if ROW is not completely visible in window W. */
1069 #define MATRIX_ROW_PARTIALLY_VISIBLE_P(W, ROW) \
1070 (MR_PARTIALLY_VISIBLE ((ROW)) \
1071 && (MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)) \
1072 || MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW))))
1076 /* Non-zero if ROW is partially visible at the top of window W. */
1078 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW) \
1079 (MR_PARTIALLY_VISIBLE ((ROW)) \
1080 && MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)))
1082 /* Non-zero if ROW is partially visible at the bottom of window W. */
1084 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW) \
1085 (MR_PARTIALLY_VISIBLE ((ROW)) \
1086 && MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW)))
1088 /* Return the bottom Y + 1 of ROW. */
1090 #define MATRIX_ROW_BOTTOM_Y(ROW) ((ROW)->y + (ROW)->height)
1092 /* Is ROW the last visible one in the display described by the
1093 iterator structure pointed to by IT?. */
1095 #define MATRIX_ROW_LAST_VISIBLE_P(ROW, IT) \
1096 (MATRIX_ROW_BOTTOM_Y ((ROW)) >= (IT)->last_visible_y)
1098 /* Non-zero if ROW displays a continuation line. */
1100 #define MATRIX_ROW_CONTINUATION_LINE_P(ROW) \
1101 ((ROW)->continuation_lines_width > 0)
1103 /* Non-zero if ROW ends in the middle of a character. This is the
1104 case for continued lines showing only part of a display table entry
1105 or a control char, or an overlay string. */
1107 #define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW) \
1108 ((ROW)->end.dpvec_index > 0 \
1109 || (ROW)->end.overlay_string_index >= 0 \
1110 || (ROW)->ends_in_middle_of_char_p)
1112 /* Non-zero if ROW ends in the middle of an overlay string. */
1114 #define MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P(ROW) \
1115 ((ROW)->end.overlay_string_index >= 0)
1117 /* Non-zero if ROW starts in the middle of a character. See above. */
1119 #define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW) \
1120 ((ROW)->start.dpvec_index > 0 \
1121 || (ROW)->starts_in_middle_of_char_p \
1122 || ((ROW)->start.overlay_string_index >= 0 \
1123 && (ROW)->start.string_pos.charpos > 0))
1125 /* Non-zero means ROW overlaps its predecessor. */
1127 #define MATRIX_ROW_OVERLAPS_PRED_P(ROW) \
1128 ((ROW)->phys_ascent > (ROW)->ascent)
1130 /* Non-zero means ROW overlaps its successor. */
1132 #define MATRIX_ROW_OVERLAPS_SUCC_P(ROW) \
1133 ((ROW)->phys_height - (ROW)->phys_ascent \
1134 > (ROW)->height - (ROW)->ascent)
1136 /* True means that fonts have been loaded since the last glyph
1137 matrix adjustments. The function redisplay_internal adjusts glyph
1138 matrices when this flag is true. */
1140 extern bool fonts_changed_p
;
1142 /* A glyph for a space. */
1144 extern struct glyph space_glyph
;
1146 /* Window being updated by update_window. This is non-null as long as
1147 update_window has not finished, and null otherwise. */
1149 extern struct window
*updated_window
;
1151 /* Glyph row and area updated by update_window_line. */
1153 extern struct glyph_row
*updated_row
;
1154 extern int updated_area
;
1156 /* Non-zero means last display completed. Zero means it was
1159 extern bool display_completed
;
1163 /************************************************************************
1165 ************************************************************************/
1167 /* Enumeration for overriding/changing the face to use for drawing
1168 glyphs in draw_glyphs. */
1170 enum draw_glyphs_face
1180 #ifdef HAVE_WINDOW_SYSTEM
1182 /* A sequence of glyphs to be drawn in the same face. */
1186 /* X-origin of the string. */
1189 /* Y-origin and y-position of the base line of this string. */
1192 /* The width of the string, not including a face extension. */
1195 /* The width of the string, including a face extension. */
1196 int background_width
;
1198 /* The height of this string. This is the height of the line this
1199 string is drawn in, and can be different from the height of the
1200 font the string is drawn in. */
1203 /* Number of pixels this string overwrites in front of its x-origin.
1204 This number is zero if the string has an lbearing >= 0; it is
1205 -lbearing, if the string has an lbearing < 0. */
1208 /* Number of pixels this string overwrites past its right-most
1209 nominal x-position, i.e. x + width. Zero if the string's
1210 rbearing is <= its nominal width, rbearing - width otherwise. */
1213 /* The frame on which the glyph string is drawn. */
1216 /* The window on which the glyph string is drawn. */
1219 /* X display and window for convenience. */
1223 /* The glyph row for which this string was built. It determines the
1224 y-origin and height of the string. */
1225 struct glyph_row
*row
;
1227 /* The area within row. */
1228 enum glyph_row_area area
;
1230 /* Characters to be drawn, and number of characters. */
1234 /* A face-override for drawing cursors, mouse face and similar. */
1235 enum draw_glyphs_face hl
;
1237 /* Face in which this string is to be drawn. */
1240 /* Font in which this string is to be drawn. */
1243 /* Non-null means this string describes (part of) a static
1245 struct composition
*cmp
;
1247 /* If not negative, this string describes a compos. */
1250 /* Start and end glyph indices in a glyph-string. */
1251 int cmp_from
, cmp_to
;
1253 /* 1 means this glyph strings face has to be drawn to the right end
1254 of the window's drawing area. */
1255 unsigned extends_to_end_of_line_p
: 1;
1257 /* 1 means the background of this string has been drawn. */
1258 unsigned background_filled_p
: 1;
1260 /* 1 means glyph string must be drawn with 16-bit functions. */
1261 unsigned two_byte_p
: 1;
1263 /* 1 means that the original font determined for drawing this glyph
1264 string could not be loaded. The member `font' has been set to
1265 the frame's default font in this case. */
1266 unsigned font_not_found_p
: 1;
1268 /* 1 means that the face in which this glyph string is drawn has a
1270 unsigned stippled_p
: 1;
1272 #define OVERLAPS_PRED (1 << 0)
1273 #define OVERLAPS_SUCC (1 << 1)
1274 #define OVERLAPS_BOTH (OVERLAPS_PRED | OVERLAPS_SUCC)
1275 #define OVERLAPS_ERASED_CURSOR (1 << 2)
1276 /* Non-zero means only the foreground of this glyph string must be
1277 drawn, and we should use the physical height of the line this
1278 glyph string appears in as clip rect. If the value is
1279 OVERLAPS_ERASED_CURSOR, the clip rect is restricted to the rect
1280 of the erased cursor. OVERLAPS_PRED and OVERLAPS_SUCC mean we
1281 draw overlaps with the preceding and the succeeding rows,
1283 unsigned for_overlaps
: 3;
1285 /* 1 means that all glyphs in this glyph string has the flag
1286 padding_p set, and thus must be drawn one by one to have 1-pixel
1287 width even though the logical width in the font is zero. */
1288 unsigned padding_p
: 1;
1290 /* The GC to use for drawing this glyph string. */
1291 #if defined (HAVE_X_WINDOWS)
1294 #if defined (HAVE_NTGUI)
1299 /* A pointer to the first glyph in the string. This glyph
1300 corresponds to char2b[0]. Needed to draw rectangles if
1301 font_not_found_p is 1. */
1302 struct glyph
*first_glyph
;
1304 /* Image, if any. */
1307 #ifdef HAVE_XWIDGETS
1308 struct xwidget
* xwidget
;
1311 struct glyph_slice slice
;
1313 /* Non-null means the horizontal clipping region starts from the
1314 left edge of *clip_head, and ends with the right edge of
1315 *clip_tail, not including their overhangs. */
1316 struct glyph_string
*clip_head
, *clip_tail
;
1318 /* The current clipping areas. */
1319 NativeRectangle clip
[2];
1321 /* Number of clipping areas. */
1324 int underline_position
;
1326 int underline_thickness
;
1328 struct glyph_string
*next
, *prev
;
1331 #endif /* HAVE_WINDOW_SYSTEM */
1334 /************************************************************************
1336 ************************************************************************/
1338 /* Return the height of the mode line in glyph matrix MATRIX, or zero
1339 if not known. This macro is called under circumstances where
1340 MATRIX might not have been allocated yet. */
1342 #define MATRIX_MODE_LINE_HEIGHT(MATRIX) \
1343 ((MATRIX) && (MATRIX)->rows \
1344 ? MATRIX_MODE_LINE_ROW (MATRIX)->height \
1347 /* Return the height of the header line in glyph matrix MATRIX, or zero
1348 if not known. This macro is called under circumstances where
1349 MATRIX might not have been allocated yet. */
1351 #define MATRIX_HEADER_LINE_HEIGHT(MATRIX) \
1352 ((MATRIX) && (MATRIX)->rows \
1353 ? MATRIX_HEADER_LINE_ROW (MATRIX)->height \
1356 /* Return the desired face id for the mode line of a window, depending
1357 on whether the window is selected or not, or if the window is the
1358 scrolling window for the currently active minibuffer window.
1360 Due to the way display_mode_lines manipulates with the contents of
1361 selected_window, this macro needs three arguments: SELW which is
1362 compared against the current value of selected_window, MBW which is
1363 compared against minibuf_window (if SELW doesn't match), and SCRW
1364 which is compared against minibuf_selected_window (if MBW matches). */
1366 #define CURRENT_MODE_LINE_FACE_ID_3(SELW, MBW, SCRW) \
1367 ((!mode_line_in_non_selected_windows \
1368 || (SELW) == XWINDOW (selected_window) \
1369 || (minibuf_level > 0 \
1370 && !NILP (minibuf_selected_window) \
1371 && (MBW) == XWINDOW (minibuf_window) \
1372 && (SCRW) == XWINDOW (minibuf_selected_window))) \
1373 ? MODE_LINE_FACE_ID \
1374 : MODE_LINE_INACTIVE_FACE_ID)
1377 /* Return the desired face id for the mode line of window W. */
1379 #define CURRENT_MODE_LINE_FACE_ID(W) \
1380 (CURRENT_MODE_LINE_FACE_ID_3((W), XWINDOW (selected_window), (W)))
1382 /* Return the current height of the mode line of window W. If not
1383 known from current_mode_line_height, look at W's current glyph
1384 matrix, or return a default based on the height of the font of the
1385 face `mode-line'. */
1387 #define CURRENT_MODE_LINE_HEIGHT(W) \
1388 (current_mode_line_height >= 0 \
1389 ? current_mode_line_height \
1390 : (MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1391 ? MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1392 : estimate_mode_line_height (XFRAME (W->frame), \
1393 CURRENT_MODE_LINE_FACE_ID (W))))
1395 /* Return the current height of the header line of window W. If not
1396 known from current_header_line_height, look at W's current glyph
1397 matrix, or return an estimation based on the height of the font of
1398 the face `header-line'. */
1400 #define CURRENT_HEADER_LINE_HEIGHT(W) \
1401 (current_header_line_height >= 0 \
1402 ? current_header_line_height \
1403 : (MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1404 ? MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1405 : estimate_mode_line_height (XFRAME (W->frame),\
1406 HEADER_LINE_FACE_ID)))
1408 /* Return the height of the desired mode line of window W. */
1410 #define DESIRED_MODE_LINE_HEIGHT(W) \
1411 MATRIX_MODE_LINE_HEIGHT ((W)->desired_matrix)
1413 /* Return the height of the desired header line of window W. */
1415 #define DESIRED_HEADER_LINE_HEIGHT(W) \
1416 MATRIX_HEADER_LINE_HEIGHT ((W)->desired_matrix)
1418 /* Value is non-zero if window W wants a mode line. */
1420 #define WINDOW_WANTS_MODELINE_P(W) \
1421 (!MINI_WINDOW_P ((W)) \
1422 && !(W)->pseudo_window_p \
1423 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1424 && BUFFERP (W->buffer) \
1425 && !NILP (BVAR (XBUFFER (W->buffer), mode_line_format)) \
1426 && WINDOW_TOTAL_LINES (W) > 1)
1428 /* Value is true if window W wants a header line. */
1430 #define WINDOW_WANTS_HEADER_LINE_P(W) \
1431 (!MINI_WINDOW_P ((W)) \
1432 && !(W)->pseudo_window_p \
1433 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1434 && BUFFERP (W->buffer) \
1435 && !NILP (BVAR (XBUFFER (W->buffer), header_line_format)) \
1436 && WINDOW_TOTAL_LINES (W) > 1 \
1437 + !NILP (BVAR (XBUFFER (W->buffer), mode_line_format)))
1440 /* Return proper value to be used as baseline offset of font that has
1441 ASCENT and DESCENT to draw characters by the font at the vertical
1442 center of the line of frame F.
1444 Here, our task is to find the value of BOFF in the following figure;
1446 -------------------------+-----------+-
1447 -+-+---------+-+ | |
1449 | | | | F_ASCENT F_HEIGHT
1452 | | |-|-+------+-----------|------- baseline
1454 | |---------|-+-+ | |
1456 -+-+---------+-+ F_DESCENT |
1457 -------------------------+-----------+-
1459 -BOFF + DESCENT + (F_HEIGHT - HEIGHT) / 2 = F_DESCENT
1460 BOFF = DESCENT + (F_HEIGHT - HEIGHT) / 2 - F_DESCENT
1461 DESCENT = FONT->descent
1462 HEIGHT = FONT_HEIGHT (FONT)
1463 F_DESCENT = (FRAME_FONT (F)->descent
1464 - F->terminal->output_data.x->baseline_offset)
1465 F_HEIGHT = FRAME_LINE_HEIGHT (F)
1468 #define VCENTER_BASELINE_OFFSET(FONT, F) \
1469 (FONT_DESCENT (FONT) \
1470 + (FRAME_LINE_HEIGHT ((F)) - FONT_HEIGHT ((FONT)) \
1471 + (FRAME_LINE_HEIGHT ((F)) > FONT_HEIGHT ((FONT)))) / 2 \
1472 - (FONT_DESCENT (FRAME_FONT (F)) - FRAME_BASELINE_OFFSET (F)))
1475 /***********************************************************************
1477 ***********************************************************************/
1479 /* Indices of face attributes in Lisp face vectors. Slot zero is the
1482 enum lface_attribute_index
1484 LFACE_FAMILY_INDEX
= 1,
1485 LFACE_FOUNDRY_INDEX
,
1490 LFACE_UNDERLINE_INDEX
,
1491 LFACE_INVERSE_INDEX
,
1492 LFACE_FOREGROUND_INDEX
,
1493 LFACE_BACKGROUND_INDEX
,
1494 LFACE_STIPPLE_INDEX
,
1495 LFACE_OVERLINE_INDEX
,
1496 LFACE_STRIKE_THROUGH_INDEX
,
1499 LFACE_INHERIT_INDEX
,
1500 LFACE_FONTSET_INDEX
,
1505 /* Box types of faces. */
1509 /* No box around text. */
1512 /* Simple box of specified width and color. Default width is 1, and
1513 default color is the foreground color of the face. */
1516 /* Boxes with 3D shadows. Color equals the background color of the
1517 face. Width is specified. */
1522 /* Underline type. */
1524 enum face_underline_type
1530 /* Structure describing a realized face.
1532 For each Lisp face, 0..N realized faces can exist for different
1533 frames and different charsets. Realized faces are built from Lisp
1534 faces and text properties/overlays by merging faces and adding
1535 unspecified attributes from the `default' face. */
1539 /* The id of this face. The id equals the index of this face in the
1540 vector faces_by_id of its face cache. */
1543 #ifdef HAVE_WINDOW_SYSTEM
1545 /* If non-zero, this is a GC that we can use without modification for
1546 drawing the characters in this face. */
1549 /* Background stipple or bitmap used for this face. This is
1550 an id as returned from load_pixmap. */
1553 #else /* not HAVE_WINDOW_SYSTEM */
1558 #endif /* not HAVE_WINDOW_SYSTEM */
1560 /* Pixel value of foreground color for X frames. Color index
1562 unsigned long foreground
;
1564 /* Pixel value or color index of background color. */
1565 unsigned long background
;
1567 /* Pixel value or color index of underline color. */
1568 unsigned long underline_color
;
1570 /* Pixel value or color index of overlined, strike-through, or box
1572 unsigned long overline_color
;
1573 unsigned long strike_through_color
;
1574 unsigned long box_color
;
1578 /* Fontset ID if for this face's fontset. Non-ASCII faces derived
1579 from the same ASCII face have the same fontset. */
1582 /* Pixmap width and height. */
1583 unsigned int pixmap_w
, pixmap_h
;
1585 /* Non-zero means characters in this face have a box that thickness
1586 around them. If it is negative, the absolute value indicates the
1587 thickness, and the horizontal lines of box (top and bottom) are
1588 drawn inside of characters glyph area. The vertical lines of box
1589 (left and right) are drawn as the same way as the case that this
1590 value is positive. */
1593 /* Type of box drawn. A value of FACE_NO_BOX means no box is drawn
1594 around text in this face. A value of FACE_SIMPLE_BOX means a box
1595 of width box_line_width is drawn in color box_color. A value of
1596 FACE_RAISED_BOX or FACE_SUNKEN_BOX means a 3D box is drawn with
1597 shadow colors derived from the background color of the face. */
1598 enum face_box_type box
;
1600 /* If `box' above specifies a 3D type, 1 means use box_color for
1602 unsigned use_box_color_for_shadows_p
: 1;
1604 /* Style of underlining. */
1605 enum face_underline_type underline_type
;
1607 /* Non-zero if text in this face should be underlined, overlined,
1608 strike-through or have a box drawn around it. */
1609 unsigned underline_p
: 1;
1610 unsigned overline_p
: 1;
1611 unsigned strike_through_p
: 1;
1613 /* 1 means that the colors specified for this face could not be
1614 loaded, and were replaced by default colors, so they shouldn't be
1616 unsigned foreground_defaulted_p
: 1;
1617 unsigned background_defaulted_p
: 1;
1619 /* 1 means that either no color is specified for underlining or that
1620 the specified color couldn't be loaded. Use the foreground
1621 color when drawing in that case. */
1622 unsigned underline_defaulted_p
: 1;
1624 /* 1 means that either no color is specified for the corresponding
1625 attribute or that the specified color couldn't be loaded.
1626 Use the foreground color when drawing in that case. */
1627 unsigned overline_color_defaulted_p
: 1;
1628 unsigned strike_through_color_defaulted_p
: 1;
1629 unsigned box_color_defaulted_p
: 1;
1631 /* TTY appearances. Colors are found in `lface' with empty color
1632 string meaning the default color of the TTY. */
1633 unsigned tty_bold_p
: 1;
1634 unsigned tty_italic_p
: 1;
1635 unsigned tty_underline_p
: 1;
1636 unsigned tty_reverse_p
: 1;
1638 /* 1 means that colors of this face may not be freed because they
1639 have been copied bitwise from a base face (see
1641 unsigned colors_copied_bitwise_p
: 1;
1643 /* If non-zero, use overstrike (to simulate bold-face). */
1644 unsigned overstrike
: 1;
1646 /* NOTE: this is not used yet, but eventually this impl should be done
1647 similarly to overstrike */
1649 /* If non-zero, use geometric rotation (to simulate italic). */
1650 unsigned synth_ital
: 1;
1653 /* The Lisp face attributes this face realizes. All attributes
1654 in this vector are non-nil. */
1655 Lisp_Object lface
[LFACE_VECTOR_SIZE
];
1657 /* The hash value of this face. */
1660 /* Next and previous face in hash collision list of face cache. */
1661 struct face
*next
, *prev
;
1663 /* If this face is an ASCII face, this points to this face itself.
1664 Otherwise, this points to an ASCII face that has the same
1665 attributes except the font. */
1666 struct face
*ascii_face
;
1668 /* Extra member that a font-driver uses privately. */
1673 /* Color index indicating that face uses a terminal's default color. */
1675 #define FACE_TTY_DEFAULT_COLOR ((unsigned long) -1)
1677 /* Color index indicating that face uses an unknown foreground color. */
1679 #define FACE_TTY_DEFAULT_FG_COLOR ((unsigned long) -2)
1681 /* Color index indicating that face uses an unknown background color. */
1683 #define FACE_TTY_DEFAULT_BG_COLOR ((unsigned long) -3)
1685 /* Non-zero if FACE was realized for unibyte use. */
1687 #define FACE_UNIBYTE_P(FACE) ((FACE)->charset < 0)
1690 /* IDs of important faces known by the C face code. These are the IDs
1691 of the faces for CHARSET_ASCII. */
1697 MODE_LINE_INACTIVE_FACE_ID
,
1700 HEADER_LINE_FACE_ID
,
1706 VERTICAL_BORDER_FACE_ID
,
1707 BASIC_FACE_ID_SENTINEL
1710 #define MAX_FACE_ID ((1 << FACE_ID_BITS) - 1)
1712 /* A cache of realized faces. Each frame has its own cache because
1713 Emacs allows different frame-local face definitions. */
1717 /* Hash table of cached realized faces. */
1718 struct face
**buckets
;
1720 /* Back-pointer to the frame this cache belongs to. */
1723 /* A vector of faces so that faces can be referenced by an ID. */
1724 struct face
**faces_by_id
;
1726 /* The allocated size, and number of used slots of faces_by_id. */
1730 /* Flag indicating that attributes of the `menu' face have been
1732 unsigned menu_face_changed_p
: 1;
1736 /* Prepare face FACE for use on frame F. This must be called before
1737 using X resources of FACE. */
1739 #define PREPARE_FACE_FOR_DISPLAY(F, FACE) \
1740 if ((FACE)->gc == 0) \
1741 prepare_face_for_display ((F), (FACE)); \
1745 /* Return a pointer to the face with ID on frame F, or null if such a
1746 face doesn't exist. */
1748 #define FACE_FROM_ID(F, ID) \
1749 (UNSIGNED_CMP (ID, <, FRAME_FACE_CACHE (F)->used) \
1750 ? FRAME_FACE_CACHE (F)->faces_by_id[ID] \
1753 #ifdef HAVE_WINDOW_SYSTEM
1755 /* Non-zero if FACE is suitable for displaying character CHAR. */
1757 #define FACE_SUITABLE_FOR_ASCII_CHAR_P(FACE, CHAR) \
1758 ((FACE) == (FACE)->ascii_face)
1760 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) \
1761 (ASCII_CHAR_P (CHAR) \
1762 ? FACE_SUITABLE_FOR_ASCII_CHAR_P(FACE) \
1763 : face_suitable_for_char_p ((FACE), (CHAR)))
1765 /* Return the id of the realized face on frame F that is like the face
1766 with id ID but is suitable for displaying character CHAR.
1767 This macro is only meaningful for multibyte character CHAR. */
1769 #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) \
1770 ((ASCII_CHAR_P (CHAR) || CHAR_BYTE8_P (CHAR)) \
1771 ? (FACE)->ascii_face->id \
1772 : face_for_char ((F), (FACE), (CHAR), (POS), (OBJECT)))
1774 #else /* not HAVE_WINDOW_SYSTEM */
1776 #define FACE_SUITABLE_FOR_ASCII_CHAR_P(FACE, CHAR) 1
1777 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) 1
1778 #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) ((FACE)->id)
1780 #endif /* not HAVE_WINDOW_SYSTEM */
1782 /* Non-zero means face attributes have been changed since the last
1783 redisplay. Used in redisplay_internal. */
1785 extern int face_change_count
;
1787 /* For reordering of bidirectional text. */
1788 #define BIDI_MAXLEVEL 64
1790 /* Data type for describing the bidirectional character types. The
1791 first 7 must be at the beginning, because they are the only values
1792 valid in the `bidi_type' member of `struct glyph'; we only reserve
1793 3 bits for it, so we cannot use there values larger than 7.
1795 The order of members must be in sync with the 8th element of the
1796 member of unidata-prop-alist (in admin/unidata/unidata-gen.el) for
1797 Unicode character property `bidi-class'. */
1800 STRONG_L
, /* strong left-to-right */
1801 STRONG_R
, /* strong right-to-left */
1802 WEAK_EN
, /* european number */
1803 WEAK_AN
, /* arabic number */
1804 WEAK_BN
, /* boundary neutral */
1805 NEUTRAL_B
, /* paragraph separator */
1806 STRONG_AL
, /* arabic right-to-left letter */
1807 LRE
, /* left-to-right embedding */
1808 LRO
, /* left-to-right override */
1809 RLE
, /* right-to-left embedding */
1810 RLO
, /* right-to-left override */
1811 PDF
, /* pop directional format */
1812 WEAK_ES
, /* european number separator */
1813 WEAK_ET
, /* european number terminator */
1814 WEAK_CS
, /* common separator */
1815 WEAK_NSM
, /* non-spacing mark */
1816 NEUTRAL_S
, /* segment separator */
1817 NEUTRAL_WS
, /* whitespace */
1818 NEUTRAL_ON
/* other neutrals */
1821 /* The basic directionality data type. */
1822 typedef enum { NEUTRAL_DIR
, L2R
, R2L
} bidi_dir_t
;
1824 /* Data type for storing information about characters we need to
1826 struct bidi_saved_info
{
1827 ptrdiff_t bytepos
, charpos
; /* character's buffer position */
1828 bidi_type_t type
; /* character's resolved bidi type */
1829 bidi_type_t type_after_w1
; /* original type of the character, after W1 */
1830 bidi_type_t orig_type
; /* type as we found it in the buffer */
1833 /* Data type for keeping track of saved embedding levels and override
1834 status information. */
1837 bidi_dir_t override
;
1840 /* Data type for storing information about a string being iterated on. */
1841 struct bidi_string_data
{
1842 Lisp_Object lstring
; /* Lisp string to reorder, or nil */
1843 const unsigned char *s
; /* string data, or NULL if reordering buffer */
1844 ptrdiff_t schars
; /* the number of characters in the string,
1845 excluding the terminating null */
1846 ptrdiff_t bufpos
; /* buffer position of lstring, or 0 if N/A */
1847 unsigned from_disp_str
: 1; /* 1 means the string comes from a
1849 unsigned unibyte
: 1; /* 1 means the string is unibyte */
1852 /* Data type for reordering bidirectional text. */
1854 ptrdiff_t bytepos
; /* iterator's position in buffer/string */
1856 int ch
; /* character at that position, or u+FFFC
1857 ("object replacement character") for a run
1858 of characters covered by a display string */
1859 ptrdiff_t nchars
; /* its "length", usually 1; it's > 1 for a run
1860 of characters covered by a display string */
1861 ptrdiff_t ch_len
; /* its length in bytes */
1862 bidi_type_t type
; /* bidi type of this character, after
1863 resolving weak and neutral types */
1864 bidi_type_t type_after_w1
; /* original type, after overrides and W1 */
1865 bidi_type_t orig_type
; /* original type, as found in the buffer */
1866 int resolved_level
; /* final resolved level of this character */
1867 int invalid_levels
; /* how many PDFs to ignore */
1868 int invalid_rl_levels
; /* how many PDFs from RLE/RLO to ignore */
1869 struct bidi_saved_info prev
; /* info about previous character */
1870 struct bidi_saved_info last_strong
; /* last-seen strong directional char */
1871 struct bidi_saved_info next_for_neutral
; /* surrounding characters for... */
1872 struct bidi_saved_info prev_for_neutral
; /* ...resolving neutrals */
1873 struct bidi_saved_info next_for_ws
; /* character after sequence of ws */
1874 ptrdiff_t next_en_pos
; /* pos. of next char for determining ET type */
1875 bidi_type_t next_en_type
; /* type of char at next_en_pos */
1876 ptrdiff_t ignore_bn_limit
; /* position until which to ignore BNs */
1877 bidi_dir_t sor
; /* direction of start-of-run in effect */
1878 int scan_dir
; /* direction of text scan, 1: forw, -1: back */
1879 ptrdiff_t disp_pos
; /* position of display string after ch */
1880 int disp_prop
; /* if non-zero, there really is a
1881 `display' property/string at disp_pos;
1882 if 2, the property is a `space' spec */
1883 int stack_idx
; /* index of current data on the stack */
1884 /* Note: Everything from here on is not copied/saved when the bidi
1885 iterator state is saved, pushed, or popped. So only put here
1886 stuff that is not part of the bidi iterator's state! */
1887 struct bidi_stack level_stack
[BIDI_MAXLEVEL
]; /* stack of embedding levels */
1888 struct bidi_string_data string
; /* string to reorder */
1889 bidi_dir_t paragraph_dir
; /* current paragraph direction */
1890 ptrdiff_t separator_limit
; /* where paragraph separator should end */
1891 unsigned prev_was_pdf
: 1; /* if non-zero, previous char was PDF */
1892 unsigned first_elt
: 1; /* if non-zero, examine current char first */
1893 unsigned new_paragraph
: 1; /* if non-zero, we expect a new paragraph */
1894 unsigned frame_window_p
: 1; /* non-zero if displaying on a GUI frame */
1897 /* Value is non-zero when the bidi iterator is at base paragraph
1899 #define BIDI_AT_BASE_LEVEL(BIDI_IT) \
1900 ((BIDI_IT).resolved_level == (BIDI_IT).level_stack[0].level)
1903 /***********************************************************************
1905 ***********************************************************************/
1907 /* Structure used to describe where and how to draw a fringe bitmap.
1908 WHICH is the fringe bitmap to draw. WD and H is the (adjusted)
1909 width and height of the bitmap, DH is the height adjustment (if
1910 bitmap is periodic). X and Y are frame coordinates of the area to
1911 display the bitmap, DY is relative offset of the bitmap into that
1912 area. BX, NX, BY, NY specifies the area to clear if the bitmap
1913 does not fill the entire area. FACE is the fringe face. */
1915 struct draw_fringe_bitmap_params
1917 int which
; /* enum fringe_bitmap_type */
1918 unsigned short *bits
;
1922 unsigned cursor_p
: 1;
1923 unsigned overlay_p
: 1;
1927 #define MAX_FRINGE_BITMAPS (1<<FRINGE_ID_BITS)
1930 /***********************************************************************
1932 ***********************************************************************/
1934 /* Iteration over things to display in current_buffer or in a string.
1936 The iterator handles:
1938 1. Overlay strings (after-string, before-string).
1940 3. Invisible text properties.
1941 4. Selective display.
1942 5. Translation of characters via display tables.
1943 6. Translation of control characters to the forms `\003' or `^C'.
1944 7. `glyph' and `space-width' properties.
1946 Iterators are initialized by calling init_iterator or one of the
1947 equivalent functions below. A call to get_next_display_element
1948 loads the iterator structure with information about what next to
1949 display. A call to set_iterator_to_next increments the iterator's
1952 Characters from overlay strings, display table entries or control
1953 character translations are returned one at a time. For example, if
1954 we have a text of `a\x01' where `a' has a display table definition
1955 of `cd' and the control character is displayed with a leading
1956 arrow, then the iterator will return:
1958 Call Return Source Call next
1959 -----------------------------------------------------------------
1960 next c display table move
1961 next d display table move
1962 next ^ control char move
1963 next A control char move
1965 The same mechanism is also used to return characters for ellipses
1966 displayed at the end of invisible text.
1968 CAVEAT: Under some circumstances, move_.* functions can be called
1969 asynchronously, e.g. when computing a buffer position from an x and
1970 y pixel position. This means that these functions and functions
1971 called from them SHOULD NOT USE xmalloc and alike. See also the
1972 comment at the start of xdisp.c. */
1974 /* Enumeration describing what kind of display element an iterator is
1975 loaded with after a call to get_next_display_element. */
1977 enum display_element_type
1979 /* A normal character. */
1982 /* A composition (static and automatic). */
1985 /* A glyphless character (e.g. ZWNJ, LRE). */
1991 /* A flexible width and height space. */
1994 /* End of buffer or string. */
1997 /* Truncation glyphs. Never returned by get_next_display_element.
1998 Used to get display information about truncation glyphs via
2002 /* Continuation glyphs. See the comment for IT_TRUNCATION. */
2005 #ifdef HAVE_XWIDGETS
2011 /* An enumerator for each text property that has a meaning for display
2020 COMPOSITION_PROP_IDX
,
2022 /* Not a property. Used to indicate changes in overlays. */
2029 /* An enumerator for the method of wrapping long lines. */
2031 enum line_wrap_method
2038 /* An enumerator for the method of displaying glyphless characters. */
2040 enum glyphless_display_method
2042 /* Display a thin (1-pixel width) space. On a TTY, display a
2043 1-character width space. */
2044 GLYPHLESS_DISPLAY_THIN_SPACE
,
2045 /* Display an empty box of proper width. */
2046 GLYPHLESS_DISPLAY_EMPTY_BOX
,
2047 /* Display an acronym string in a box. */
2048 GLYPHLESS_DISPLAY_ACRONYM
,
2049 /* Display the hexadecimal code of the character in a box. */
2050 GLYPHLESS_DISPLAY_HEX_CODE
2061 /* Input sources for fetching characters or data to display.
2062 The input source is found in the `method' field. */
2065 GET_FROM_BUFFER
= 0,
2066 GET_FROM_DISPLAY_VECTOR
,
2071 #ifdef HAVE_XWIDGETS
2077 /* FIXME: What is this? Why 5? */
2078 #define IT_STACK_SIZE 5
2080 /* Iterator for composition (both for static and automatic). */
2081 struct composition_it
2083 /* Next position at which to check the composition. */
2085 /* ID number of the composition or glyph-string. If negative, we
2086 are not iterating over a composition now. */
2088 /* If non-negative, character that triggers the automatic
2089 composition at `stop_pos', and this is an automatic composition.
2090 If negative, this is a static composition. This is set to -2
2091 temporarily if searching of composition reach a limit or a
2094 /* If this is an automatic composition, index of a rule for making
2095 the automatic composition. Provided that ELT is an element of
2096 Vcomposition_function_table for CH, (nth ELT RULE_IDX) is the
2097 rule for the composition. */
2099 /* If this is an automatic composition, how many characters to look
2100 back from the position where a character triggering the
2101 composition exists. */
2103 /* If non-negative, number of glyphs of the glyph-string. */
2105 /* True iff the composition is created while buffer is scanned in
2106 reverse order, and thus the grapheme clusters must be rendered
2107 from the last to the first. */
2110 /** The following members contain information about the current
2111 grapheme cluster. */
2112 /* Position of the first character of the current grapheme cluster. */
2114 /* Number of characters and bytes of the current grapheme cluster. */
2116 /* Indices of the glyphs for the current grapheme cluster. */
2118 /* Width of the current grapheme cluster in units of pixels on a
2119 graphic display and in units of canonical characters on a
2120 terminal display. */
2126 /* The window in which we iterate over current_buffer (or a string). */
2130 /* The window's frame. */
2133 /* Method to use to load this structure with the next display element. */
2134 enum it_method method
;
2136 /* The next position at which to check for face changes, invisible
2137 text, overlay strings, end of text etc., which see. */
2138 ptrdiff_t stop_charpos
;
2140 /* Previous stop position, i.e. the last one before the current
2141 iterator position in `current'. */
2142 ptrdiff_t prev_stop
;
2144 /* Last stop position iterated across whose bidi embedding level is
2145 equal to the current paragraph's base embedding level. */
2146 ptrdiff_t base_level_stop
;
2148 /* Maximum string or buffer position + 1. ZV when iterating over
2150 ptrdiff_t end_charpos
;
2152 /* C string to iterate over. Non-null means get characters from
2153 this string, otherwise characters are read from current_buffer
2155 const unsigned char *s
;
2157 /* Number of characters in the string (s, or it->string) we iterate
2158 over. Used only in display_string and its subroutines; never
2159 used for overlay strings and strings from display properties. */
2160 ptrdiff_t string_nchars
;
2162 /* Start and end of a visible region; -1 if the region is not
2163 visible in the window. */
2164 ptrdiff_t region_beg_charpos
, region_end_charpos
;
2166 /* Position at which redisplay end trigger functions should be run. */
2167 ptrdiff_t redisplay_end_trigger_charpos
;
2169 /* 1 means multibyte characters are enabled. */
2170 unsigned multibyte_p
: 1;
2172 /* 1 means window has a mode line at its top. */
2173 unsigned header_line_p
: 1;
2175 /* 1 means `string' is the value of a `display' property.
2176 Don't handle some `display' properties in these strings. */
2177 unsigned string_from_display_prop_p
: 1;
2179 /* 1 means `string' comes from a `line-prefix' or `wrap-prefix'
2181 unsigned string_from_prefix_prop_p
: 1;
2183 /* 1 means we are iterating an object that came from a value of a
2184 `display' property. */
2185 unsigned from_disp_prop_p
: 1;
2187 /* When METHOD == next_element_from_display_vector,
2188 this is 1 if we're doing an ellipsis. Otherwise meaningless. */
2189 unsigned ellipsis_p
: 1;
2191 /* True means cursor shouldn't be displayed here. */
2192 unsigned avoid_cursor_p
: 1;
2194 /* Display table in effect or null for none. */
2195 struct Lisp_Char_Table
*dp
;
2197 /* Current display table vector to return characters from and its
2198 end. dpvec null means we are not returning characters from a
2199 display table entry; current.dpvec_index gives the current index
2200 into dpvec. This same mechanism is also used to return
2201 characters from translated control characters, i.e. `\003' or
2203 Lisp_Object
*dpvec
, *dpend
;
2205 /* Length in bytes of the char that filled dpvec. A value of zero
2206 means that no such character is involved. A negative value means
2207 the rest of the line from the current iterator position onwards
2208 is hidden by selective display or ellipsis. */
2211 /* Face id to use for all characters in display vector. -1 if unused. */
2214 /* Face id of the iterator saved in case a glyph from dpvec contains
2215 a face. The face is restored when all glyphs from dpvec have
2219 /* Vector of glyphs for control character translation. The pointer
2220 dpvec is set to ctl_chars when a control character is translated.
2221 This vector is also used for incomplete multibyte character
2222 translation (e.g \222\244). Such a character is at most 4 bytes,
2223 thus we need at most 16 bytes here. */
2224 Lisp_Object ctl_chars
[16];
2226 /* Initial buffer or string position of the iterator, before skipping
2227 over display properties and invisible text. */
2228 struct display_pos start
;
2230 /* Current buffer or string position of the iterator, including
2231 position in overlay strings etc. */
2232 struct display_pos current
;
2234 /* Total number of overlay strings to process. This can be >
2235 OVERLAY_STRING_CHUNK_SIZE. Value is dependable only when
2236 current.overlay_string_index >= 0. Use the latter to determine
2237 whether an overlay string is being iterated over, because
2238 n_overlay_strings can be positive even when we are not rendering
2239 an overlay string. */
2240 ptrdiff_t n_overlay_strings
;
2242 /* The charpos where n_overlay_strings was calculated. This should
2243 be set at the same time as n_overlay_strings. It is needed
2244 because we show before-strings at the start of invisible text;
2245 see handle_invisible_prop in xdisp.c. */
2246 ptrdiff_t overlay_strings_charpos
;
2248 /* Vector of overlays to process. Overlay strings are processed
2249 OVERLAY_STRING_CHUNK_SIZE at a time. */
2250 #define OVERLAY_STRING_CHUNK_SIZE 16
2251 Lisp_Object overlay_strings
[OVERLAY_STRING_CHUNK_SIZE
];
2253 /* For each overlay string, the overlay it came from. */
2254 Lisp_Object string_overlays
[OVERLAY_STRING_CHUNK_SIZE
];
2256 /* If non-nil, a Lisp string being processed. If
2257 current.overlay_string_index >= 0, this is an overlay string from
2258 pos. Use STRINGP (it.string) to test whether we are rendering a
2259 string or something else; do NOT use BUFFERP (it.object). */
2262 /* If non-nil, we are processing a string that came
2263 from a `display' property given by an overlay. */
2264 Lisp_Object from_overlay
;
2266 /* Stack of saved values. New entries are pushed when we begin to
2267 process an overlay string or a string from a `glyph' property.
2268 Entries are popped when we return to deliver display elements
2269 from what we previously had. */
2270 struct iterator_stack_entry
2274 ptrdiff_t end_charpos
;
2275 ptrdiff_t stop_charpos
;
2276 ptrdiff_t prev_stop
;
2277 ptrdiff_t base_level_stop
;
2278 struct composition_it cmp_it
;
2281 /* Save values specific to a given method. */
2283 /* method == GET_FROM_IMAGE */
2286 struct it_slice slice
;
2289 /* method == GET_FROM_COMPOSITION */
2293 /* method == GET_FROM_STRETCH */
2297 #ifdef HAVE_XWIDGETS
2298 /* method == GET_FROM_XWIDGET */
2301 struct xwidget
* xwidget
;
2306 /* current text and display positions. */
2307 struct text_pos position
;
2308 struct display_pos current
;
2309 Lisp_Object from_overlay
;
2310 enum glyph_row_area area
;
2311 enum it_method method
;
2312 bidi_dir_t paragraph_embedding
;
2313 unsigned multibyte_p
: 1;
2314 unsigned string_from_display_prop_p
: 1;
2315 unsigned string_from_prefix_prop_p
: 1;
2316 unsigned display_ellipsis_p
: 1;
2317 unsigned avoid_cursor_p
: 1;
2319 unsigned from_disp_prop_p
: 1;
2320 enum line_wrap_method line_wrap
;
2322 /* properties from display property that are reset by another display property. */
2324 Lisp_Object space_width
;
2325 Lisp_Object font_height
;
2327 stack
[IT_STACK_SIZE
];
2329 /* Stack pointer. */
2332 /* -1 means selective display hides everything between a \r and the
2333 next newline; > 0 means hide lines indented more than that value. */
2334 ptrdiff_t selective
;
2336 /* An enumeration describing what the next display element is
2337 after a call to get_next_display_element. */
2338 enum display_element_type what
;
2343 /* Setting of buffer-local variable selective-display-ellipsis. */
2344 unsigned selective_display_ellipsis_p
: 1;
2346 /* 1 means control characters are translated into the form `^C'
2347 where the `^' can be replaced by a display table entry. */
2348 unsigned ctl_arrow_p
: 1;
2350 /* Non-zero means that the current face has a box. */
2351 unsigned face_box_p
: 1;
2353 /* Non-null means that the current character is the first in a run
2354 of characters with box face. */
2355 unsigned start_of_box_run_p
: 1;
2357 /* Non-zero means that the current character is the last in a run
2358 of characters with box face. */
2359 unsigned end_of_box_run_p
: 1;
2361 /* 1 means overlay strings at end_charpos have been processed. */
2362 unsigned overlay_strings_at_end_processed_p
: 1;
2364 /* 1 means to ignore overlay strings at current pos, as they have
2365 already been processed. */
2366 unsigned ignore_overlay_strings_at_pos_p
: 1;
2368 /* 1 means the actual glyph is not available in the current
2370 unsigned glyph_not_available_p
: 1;
2372 /* 1 means the next line in display_line continues a character
2373 consisting of more than one glyph, and some glyphs of this
2374 character have been put on the previous line. */
2375 unsigned starts_in_middle_of_char_p
: 1;
2377 /* If 1, saved_face_id contains the id of the face in front of text
2378 skipped due to selective display. */
2379 unsigned face_before_selective_p
: 1;
2381 /* If 1, adjust current glyph so it does not increase current row
2382 descent/ascent (line-height property). Reset after this glyph. */
2383 unsigned constrain_row_ascent_descent_p
: 1;
2385 enum line_wrap_method line_wrap
;
2387 /* The ID of the default face to use. One of DEFAULT_FACE_ID,
2388 MODE_LINE_FACE_ID, etc, depending on what we are displaying. */
2391 /* If `what' == IT_CHARACTER, the character and the length in bytes
2392 of its multibyte sequence. The character comes from a buffer or
2393 a string. It may be different from the character displayed in
2394 case that unibyte_display_via_language_environment is set.
2396 If `what' == IT_COMPOSITION, the first component of a composition
2397 and length in bytes of the composition.
2399 If `what' is anything else, these two are undefined (will
2400 probably hold values for the last IT_CHARACTER or IT_COMPOSITION
2401 traversed by the iterator.
2403 The values are updated by get_next_display_element, so they are
2404 out of sync with the value returned by IT_CHARPOS between the
2405 time set_iterator_to_next advances the position and the time
2406 get_next_display_element loads the new values into c and len. */
2409 /* If what == IT_COMPOSITION, iterator substructure for the
2411 struct composition_it cmp_it
;
2413 /* The character to display, possibly translated to multibyte if
2414 multibyte_p is zero or unibyte_display_via_language_environment
2415 is set. This is set after get_next_display_element has been
2416 called. If we are setting it->C directly before calling
2417 PRODUCE_GLYPHS, this should be set beforehand too. */
2418 int char_to_display
;
2420 /* If what == IT_GLYPHLESS, the method to display such a
2422 enum glyphless_display_method glyphless_method
;
2424 /* If what == IT_IMAGE, the id of the image to display. */
2427 #ifdef HAVE_XWIDGETS
2428 /* If what == IT_XWIDGET*/
2429 struct xwidget
* xwidget
;
2431 /* Values from `slice' property. */
2432 struct it_slice slice
;
2434 /* Value of the `space-width' property, if any; nil if none. */
2435 Lisp_Object space_width
;
2437 /* Computed from the value of the `raise' property. */
2440 /* Number of columns per \t. */
2443 /* Value of the `height' property, if any; nil if none. */
2444 Lisp_Object font_height
;
2446 /* Object and position where the current display element came from.
2447 Object is normally the buffer which is being rendered, but it can
2448 also be a Lisp string in case the current display element comes
2449 from an overlay string or from a display string (before- or
2450 after-string). It may also be nil when a C string is being
2451 rendered, e.g., during mode-line or header-line update. It can
2452 also be a cons cell of the form `(space ...)', when we produce a
2453 stretch glyph from a `display' specification. Finally, it can be
2454 a zero-valued Lisp integer, but only temporarily, when we are
2455 producing special glyphs for display purposes, like truncation
2456 and continuation glyphs, or blanks that extend each line to the
2457 edge of the window on a TTY.
2459 Do NOT use !BUFFERP (it.object) as a test whether we are
2460 iterating over a string; use STRINGP (it.string) instead.
2462 Position is the current iterator position in object. */
2464 struct text_pos position
;
2466 /* Width in pixels of truncation and continuation glyphs. */
2467 short truncation_pixel_width
, continuation_pixel_width
;
2469 /* First and last visible x-position in the display area. If window
2470 is hscrolled by n columns, first_visible_x == n * FRAME_COLUMN_WIDTH
2471 (f), and last_visible_x == pixel width of W + first_visible_x. */
2472 int first_visible_x
, last_visible_x
;
2474 /* Last visible y-position + 1 in the display area without a mode
2475 line, if the window has one. */
2478 /* Default amount of additional space in pixels between lines (for
2479 window systems only.) */
2480 int extra_line_spacing
;
2482 /* Max extra line spacing added in this row. */
2483 int max_extra_line_spacing
;
2485 /* Override font height information for this glyph.
2486 Used if override_ascent >= 0. Cleared after this glyph. */
2487 int override_ascent
, override_descent
, override_boff
;
2489 /* If non-null, glyphs are produced in glyph_row with each call to
2491 struct glyph_row
*glyph_row
;
2493 /* The area of glyph_row to which glyphs are added. */
2494 enum glyph_row_area area
;
2496 /* Number of glyphs needed for the last character requested via
2497 produce_glyphs. This is 1 except for tabs. */
2500 /* Width of the display element in pixels. Result of
2504 /* Current, maximum logical, and maximum physical line height
2505 information. Result of produce_glyphs. */
2506 int ascent
, descent
, max_ascent
, max_descent
;
2507 int phys_ascent
, phys_descent
, max_phys_ascent
, max_phys_descent
;
2509 /* Current x pixel position within the display line. This value
2510 does not include the width of continuation lines in front of the
2511 line. The value of current_x is automatically incremented by
2512 pixel_width with each call to produce_glyphs. */
2515 /* Accumulated width of continuation lines. If > 0, this means we
2516 are currently in a continuation line. This is initially zero and
2517 incremented/reset by display_line, move_it_to etc. */
2518 int continuation_lines_width
;
2520 /* Buffer position that ends the buffer text line being iterated.
2521 This is normally the position after the newline at EOL. If this
2522 is the last line of the buffer and it doesn't have a newline,
2523 value is ZV/ZV_BYTE. Set and used only if IT->bidi_p, for
2524 setting the end position of glyph rows produced for continuation
2525 lines, see display_line. */
2526 struct text_pos eol_pos
;
2528 /* Current y-position. Automatically incremented by the height of
2529 glyph_row in move_it_to and display_line. */
2532 /* Vertical matrix position of first text line in window. */
2535 /* Current vertical matrix position, or line number. Automatically
2536 incremented by move_it_to and display_line. */
2539 /* Horizontal matrix position reached in move_it_in_display_line.
2540 Only set there, not in display_line. */
2543 /* Left fringe bitmap number (enum fringe_bitmap_type). */
2544 unsigned left_user_fringe_bitmap
: FRINGE_ID_BITS
;
2546 /* Right fringe bitmap number (enum fringe_bitmap_type). */
2547 unsigned right_user_fringe_bitmap
: FRINGE_ID_BITS
;
2549 /* Face of the left fringe glyph. */
2550 unsigned left_user_fringe_face_id
: FACE_ID_BITS
;
2552 /* Face of the right fringe glyph. */
2553 unsigned right_user_fringe_face_id
: FACE_ID_BITS
;
2555 /* Non-zero means we need to reorder bidirectional text for display
2556 in the visual order. */
2557 unsigned bidi_p
: 1;
2559 /* For iterating over bidirectional text. */
2560 struct bidi_it bidi_it
;
2561 bidi_dir_t paragraph_embedding
;
2565 /* Access to positions of iterator IT. */
2567 #define IT_CHARPOS(IT) CHARPOS ((IT).current.pos)
2568 #define IT_BYTEPOS(IT) BYTEPOS ((IT).current.pos)
2569 #define IT_STRING_CHARPOS(IT) CHARPOS ((IT).current.string_pos)
2570 #define IT_STRING_BYTEPOS(IT) BYTEPOS ((IT).current.string_pos)
2572 /* Test if IT has reached the end of its buffer or string. This will
2573 only work after get_next_display_element has been called. */
2575 #define ITERATOR_AT_END_P(IT) ((IT)->what == IT_EOB)
2577 /* Non-zero means IT is at the end of a line. This is the case if it
2578 is either on a newline or on a carriage return and selective
2579 display hides the rest of the line. */
2581 #define ITERATOR_AT_END_OF_LINE_P(IT) \
2582 ((IT)->what == IT_CHARACTER \
2583 && ((IT)->c == '\n' \
2584 || ((IT)->c == '\r' && (IT)->selective)))
2586 /* Call produce_glyphs or FRAME_RIF->produce_glyphs, if set. Shortcut
2587 to avoid the function call overhead. */
2589 #define PRODUCE_GLYPHS(IT) \
2591 if ((IT)->glyph_row != NULL && (IT)->bidi_p) \
2593 if ((IT)->bidi_it.paragraph_dir == R2L) \
2594 (IT)->glyph_row->reversed_p = 1; \
2596 (IT)->glyph_row->reversed_p = 0; \
2598 if (FRAME_RIF ((IT)->f) != NULL) \
2599 FRAME_RIF ((IT)->f)->produce_glyphs ((IT)); \
2601 produce_glyphs ((IT)); \
2602 if ((IT)->glyph_row != NULL) \
2603 inhibit_free_realized_faces = 1; \
2606 /* Bit-flags indicating what operation move_it_to should perform. */
2608 enum move_operation_enum
2610 /* Stop if specified x-position is reached. */
2613 /* Stop if specified y-position is reached. */
2616 /* Stop if specified vpos is reached. */
2617 MOVE_TO_VPOS
= 0x04,
2619 /* Stop if specified buffer or string position is reached. */
2625 /***********************************************************************
2626 Window-based redisplay interface
2627 ***********************************************************************/
2629 /* Structure used to describe runs of lines that must be scrolled. */
2633 /* Source and destination y pixel position. */
2634 int desired_y
, current_y
;
2636 /* Source and destination vpos in matrix. */
2637 int desired_vpos
, current_vpos
;
2639 /* Height in pixels, number of glyph rows. */
2644 /* Handlers for setting frame parameters. */
2646 typedef void (*frame_parm_handler
) (struct frame
*, Lisp_Object
, Lisp_Object
);
2649 /* Structure holding system-dependent interface functions needed
2650 for window-based redisplay. */
2652 struct redisplay_interface
2654 /* Handlers for setting frame parameters. */
2655 frame_parm_handler
*frame_parm_handlers
;
2657 /* Produce glyphs/get display metrics for the display element IT is
2659 void (*produce_glyphs
) (struct it
*it
);
2661 /* Write or insert LEN glyphs from STRING at the nominal output
2663 void (*write_glyphs
) (struct glyph
*string
, int len
);
2664 void (*insert_glyphs
) (struct glyph
*start
, int len
);
2666 /* Clear from nominal output position to X. X < 0 means clear
2667 to right end of display. */
2668 void (*clear_end_of_line
) (int x
);
2670 /* Function to call to scroll the display as described by RUN on
2672 void (*scroll_run_hook
) (struct window
*w
, struct run
*run
);
2674 /* Function to call after a line in a display has been completely
2675 updated. Used to draw truncation marks and alike. DESIRED_ROW
2676 is the desired row which has been updated. */
2677 void (*after_update_window_line_hook
) (struct glyph_row
*desired_row
);
2679 /* Function to call before beginning to update window W in
2680 window-based redisplay. */
2681 void (*update_window_begin_hook
) (struct window
*w
);
2683 /* Function to call after window W has been updated in window-based
2684 redisplay. CURSOR_ON_P non-zero means switch cursor on.
2685 MOUSE_FACE_OVERWRITTEN_P non-zero means that some lines in W
2686 that contained glyphs in mouse-face were overwritten, so we
2687 have to update the mouse highlight. */
2688 void (*update_window_end_hook
) (struct window
*w
, int cursor_on_p
,
2689 int mouse_face_overwritten_p
);
2691 /* Move cursor to row/column position VPOS/HPOS, pixel coordinates
2692 Y/X. HPOS/VPOS are window-relative row and column numbers and X/Y
2693 are window-relative pixel positions. */
2694 void (*cursor_to
) (int vpos
, int hpos
, int y
, int x
);
2696 /* Flush the display of frame F. For X, this is XFlush. */
2697 void (*flush_display
) (struct frame
*f
);
2699 /* Flush the display of frame F if non-NULL. This is called
2700 during redisplay, and should be NULL on systems which flush
2701 automatically before reading input. */
2702 void (*flush_display_optional
) (struct frame
*f
);
2704 /* Clear the mouse highlight in window W, if there is any. */
2705 void (*clear_window_mouse_face
) (struct window
*w
);
2707 /* Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
2709 void (*get_glyph_overhangs
) (struct glyph
*glyph
, struct frame
*f
,
2710 int *left
, int *right
);
2712 /* Fix the display of AREA of ROW in window W for overlapping rows.
2713 This function is called from redraw_overlapping_rows after
2714 desired rows have been made current. */
2715 void (*fix_overlapping_area
) (struct window
*w
, struct glyph_row
*row
,
2716 enum glyph_row_area area
, int);
2718 #ifdef HAVE_WINDOW_SYSTEM
2720 /* Draw a fringe bitmap in window W of row ROW using parameters P. */
2721 void (*draw_fringe_bitmap
) (struct window
*w
, struct glyph_row
*row
,
2722 struct draw_fringe_bitmap_params
*p
);
2724 /* Define and destroy fringe bitmap no. WHICH. */
2725 void (*define_fringe_bitmap
) (int which
, unsigned short *bits
,
2727 void (*destroy_fringe_bitmap
) (int which
);
2729 /* Compute left and right overhang of glyph string S.
2730 A NULL pointer if platform does not support this. */
2731 void (*compute_glyph_string_overhangs
) (struct glyph_string
*s
);
2733 /* Draw a glyph string S. */
2734 void (*draw_glyph_string
) (struct glyph_string
*s
);
2736 /* Define cursor CURSOR on frame F. */
2737 void (*define_frame_cursor
) (struct frame
*f
, Cursor cursor
);
2739 /* Clear the area at (X,Y,WIDTH,HEIGHT) of frame F. */
2740 void (*clear_frame_area
) (struct frame
*f
, int x
, int y
,
2741 int width
, int height
);
2743 /* Draw specified cursor CURSOR_TYPE of width CURSOR_WIDTH
2744 at row GLYPH_ROW on window W if ON_P is 1. If ON_P is
2745 0, don't draw cursor. If ACTIVE_P is 1, system caret
2746 should track this cursor (when applicable). */
2747 void (*draw_window_cursor
) (struct window
*w
,
2748 struct glyph_row
*glyph_row
,
2750 int cursor_type
, int cursor_width
,
2751 int on_p
, int active_p
);
2753 /* Draw vertical border for window W from (X,Y_0) to (X,Y_1). */
2754 void (*draw_vertical_window_border
) (struct window
*w
,
2755 int x
, int y_0
, int y_1
);
2757 /* Shift display of frame F to make room for inserted glyphs.
2758 The area at pixel (X,Y) of width WIDTH and height HEIGHT is
2759 shifted right by SHIFT_BY pixels. */
2760 void (*shift_glyphs_for_insert
) (struct frame
*f
,
2761 int x
, int y
, int width
,
2762 int height
, int shift_by
);
2764 #endif /* HAVE_WINDOW_SYSTEM */
2768 /***********************************************************************
2770 ***********************************************************************/
2772 #ifdef HAVE_WINDOW_SYSTEM
2774 /* Structure forward declarations. */
2779 /* Each image format (JPEG, TIFF, ...) supported is described by
2780 a structure of the type below. */
2784 /* A symbol uniquely identifying the image type, .e.g `jpeg'. */
2787 /* Check that SPEC is a valid image specification for the given
2788 image type. Value is true if SPEC is valid. */
2789 bool (* valid_p
) (Lisp_Object spec
);
2791 /* Load IMG which is used on frame F from information contained in
2792 IMG->spec. Value is true if successful. */
2793 bool (* load
) (struct frame
*f
, struct image
*img
);
2795 /* Free resources of image IMG which is used on frame F. */
2796 void (* free
) (struct frame
*f
, struct image
*img
);
2798 /* Initialization function (used for dynamic loading of image
2799 libraries on Windows), or NULL if none. */
2800 bool (* init
) (void);
2802 /* Next in list of all supported image types. */
2803 struct image_type
*next
;
2807 /* Structure describing an image. Specific image formats like XBM are
2808 converted into this form, so that display only has to deal with
2809 this type of image. */
2813 /* The time in seconds at which the image was last displayed. Set
2814 in prepare_image_for_display. */
2815 EMACS_TIME timestamp
;
2817 /* Pixmaps of the image. */
2818 Pixmap pixmap
, mask
;
2820 /* Colors allocated for this image, if any. Allocated via xmalloc. */
2821 unsigned long *colors
;
2824 /* A single `background color' for this image, for the use of anyone that
2825 cares about such a thing. Only valid if the `background_valid' field
2826 is true. This should generally be accessed by calling the accessor
2827 macro `IMAGE_BACKGROUND', which will heuristically calculate a value
2829 unsigned long background
;
2831 /* Foreground and background colors of the frame on which the image
2833 unsigned long frame_foreground
, frame_background
;
2835 /* True if this image has a `transparent' background -- that is, is
2836 uses an image mask. The accessor macro for this is
2837 `IMAGE_BACKGROUND_TRANSPARENT'. */
2838 unsigned background_transparent
: 1;
2840 /* True if the `background' and `background_transparent' fields are
2841 valid, respectively. */
2842 unsigned background_valid
: 1, background_transparent_valid
: 1;
2844 /* Width and height of the image. */
2847 /* These values are used for the rectangles displayed for images
2848 that can't be loaded. */
2849 #define DEFAULT_IMAGE_WIDTH 30
2850 #define DEFAULT_IMAGE_HEIGHT 30
2852 /* Top/left and bottom/right corner pixel of actual image data.
2853 Used by four_corners_best to consider the real image data,
2854 rather than looking at the optional image margin. */
2856 #define TOP_CORNER 0
2857 #define LEFT_CORNER 1
2858 #define BOT_CORNER 2
2859 #define RIGHT_CORNER 3
2861 /* Percent of image height used as ascent. A value of
2862 CENTERED_IMAGE_ASCENT means draw the image centered on the
2865 #define DEFAULT_IMAGE_ASCENT 50
2866 #define CENTERED_IMAGE_ASCENT -1
2868 /* Lisp specification of this image. */
2871 /* List of "references" followed to build the image.
2872 Typically will just contain the name of the image file.
2873 Used to allow fine-grained cache flushing. */
2874 Lisp_Object dependencies
;
2876 /* Relief to draw around the image. */
2879 /* Optional margins around the image. This includes the relief. */
2880 int hmargin
, vmargin
;
2882 /* Reference to the type of the image. */
2883 struct image_type
*type
;
2885 /* 1 means that loading the image failed. Don't try again. */
2886 unsigned load_failed_p
;
2888 /* A place for image types to store additional data. It is marked
2890 Lisp_Object lisp_data
;
2892 /* Hash value of image specification to speed up comparisons. */
2895 /* Image id of this image. */
2898 /* Hash collision chain. */
2899 struct image
*next
, *prev
;
2903 /* Cache of images. Each frame has a cache. X frames with the same
2904 x_display_info share their caches. */
2908 /* Hash table of images. */
2909 struct image
**buckets
;
2911 /* Vector mapping image ids to images. */
2912 struct image
**images
;
2914 /* Allocated size of `images'. */
2917 /* Number of images in the cache. */
2920 /* Reference count (number of frames sharing this cache). */
2925 /* Value is a pointer to the image with id ID on frame F, or null if
2926 no image with that id exists. */
2928 #define IMAGE_FROM_ID(F, ID) \
2929 (((ID) >= 0 && (ID) < (FRAME_IMAGE_CACHE (F)->used)) \
2930 ? FRAME_IMAGE_CACHE (F)->images[ID] \
2933 /* Size of bucket vector of image caches. Should be prime. */
2935 #define IMAGE_CACHE_BUCKETS_SIZE 1001
2937 #endif /* HAVE_WINDOW_SYSTEM */
2941 /***********************************************************************
2943 ***********************************************************************/
2945 /* Enumeration defining where to find tool-bar item information in
2946 tool-bar items vectors stored with frames. Each tool-bar item
2947 occupies TOOL_BAR_ITEM_NSLOTS elements in such a vector. */
2949 enum tool_bar_item_idx
2951 /* The key of the tool-bar item. Used to remove items when a binding
2952 for `undefined' is found. */
2955 /* Non-nil if item is enabled. */
2956 TOOL_BAR_ITEM_ENABLED_P
,
2958 /* Non-nil if item is selected (pressed). */
2959 TOOL_BAR_ITEM_SELECTED_P
,
2962 TOOL_BAR_ITEM_CAPTION
,
2964 /* Image(s) to display. This is either a single image specification
2965 or a vector of specifications. */
2966 TOOL_BAR_ITEM_IMAGES
,
2969 TOOL_BAR_ITEM_BINDING
,
2971 /* Button type. One of nil (default button), t (a separator),
2972 `:radio', or `:toggle'. The latter two currently do nothing. */
2978 /* Icon file name of right to left image when an RTL locale is used. */
2979 TOOL_BAR_ITEM_RTL_IMAGE
,
2981 /* Label to show when text labels are enabled. */
2982 TOOL_BAR_ITEM_LABEL
,
2984 /* If we shall show the label only below the icon and not beside it. */
2985 TOOL_BAR_ITEM_VERT_ONLY
,
2987 /* Sentinel = number of slots in tool_bar_items occupied by one
2989 TOOL_BAR_ITEM_NSLOTS
2993 /* An enumeration for the different images that can be specified
2994 for a tool-bar item. */
2996 enum tool_bar_item_image
2998 TOOL_BAR_IMAGE_ENABLED_SELECTED
,
2999 TOOL_BAR_IMAGE_ENABLED_DESELECTED
,
3000 TOOL_BAR_IMAGE_DISABLED_SELECTED
,
3001 TOOL_BAR_IMAGE_DISABLED_DESELECTED
3004 #define DEFAULT_TOOL_BAR_LABEL_SIZE 14
3006 /* Default values of the above variables. */
3008 #define DEFAULT_TOOL_BAR_BUTTON_MARGIN 4
3009 #define DEFAULT_TOOL_BAR_BUTTON_RELIEF 1
3011 /* The height in pixels of the default tool-bar images. */
3013 #define DEFAULT_TOOL_BAR_IMAGE_HEIGHT 24
3016 /***********************************************************************
3017 Terminal Capabilities
3018 ***********************************************************************/
3020 /* Each of these is a bit representing a terminal `capability' (bold,
3021 inverse, etc). They are or'd together to specify the set of
3022 capabilities being queried for when calling `tty_capable_p' (which
3023 returns true if the terminal supports all of them). */
3025 #define TTY_CAP_INVERSE 0x01
3026 #define TTY_CAP_UNDERLINE 0x02
3027 #define TTY_CAP_BOLD 0x04
3028 #define TTY_CAP_DIM 0x08
3029 #define TTY_CAP_ITALIC 0x10
3032 /***********************************************************************
3034 ***********************************************************************/
3036 /* Defined in bidi.c */
3038 extern void bidi_init_it (ptrdiff_t, ptrdiff_t, bool, struct bidi_it
*);
3039 extern void bidi_move_to_visually_next (struct bidi_it
*);
3040 extern void bidi_paragraph_init (bidi_dir_t
, struct bidi_it
*, bool);
3041 extern int bidi_mirror_char (int);
3042 extern void bidi_push_it (struct bidi_it
*);
3043 extern void bidi_pop_it (struct bidi_it
*);
3044 extern void *bidi_shelve_cache (void);
3045 extern void bidi_unshelve_cache (void *, bool);
3047 /* Defined in xdisp.c */
3049 struct glyph_row
*row_containing_pos (struct window
*, ptrdiff_t,
3051 struct glyph_row
*, int);
3052 int line_bottom_y (struct it
*);
3053 int display_prop_intangible_p (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3054 void resize_echo_area_exactly (void);
3055 int resize_mini_window (struct window
*, int);
3056 #if defined USE_TOOLKIT_SCROLL_BARS && !defined USE_GTK
3057 void set_vertical_scroll_bar (struct window
*);
3059 int try_window (Lisp_Object
, struct text_pos
, int);
3060 void window_box (struct window
*, int, int *, int *, int *, int *);
3061 int window_box_height (struct window
*);
3062 int window_text_bottom_y (struct window
*);
3063 int window_box_width (struct window
*, int);
3064 int window_box_left (struct window
*, int);
3065 int window_box_left_offset (struct window
*, int);
3066 int window_box_right (struct window
*, int);
3067 int window_box_right_offset (struct window
*, int);
3068 int estimate_mode_line_height (struct frame
*, enum face_id
);
3069 void pixel_to_glyph_coords (struct frame
*, int, int, int *, int *,
3070 NativeRectangle
*, int);
3071 void remember_mouse_glyph (struct frame
*, int, int, NativeRectangle
*);
3073 void mark_window_display_accurate (Lisp_Object
, int);
3074 void redisplay_preserve_echo_area (int);
3075 void init_iterator (struct it
*, struct window
*, ptrdiff_t,
3076 ptrdiff_t, struct glyph_row
*, enum face_id
);
3077 void init_iterator_to_row_start (struct it
*, struct window
*,
3078 struct glyph_row
*);
3079 void start_display (struct it
*, struct window
*, struct text_pos
);
3080 void move_it_to (struct it
*, ptrdiff_t, int, int, int, int);
3081 void move_it_vertically (struct it
*, int);
3082 void move_it_vertically_backward (struct it
*, int);
3083 void move_it_by_lines (struct it
*, ptrdiff_t);
3084 void move_it_past_eol (struct it
*);
3085 void move_it_in_display_line (struct it
*it
,
3086 ptrdiff_t to_charpos
, int to_x
,
3087 enum move_operation_enum op
);
3088 int in_display_vector_p (struct it
*);
3089 int frame_mode_line_height (struct frame
*);
3090 extern Lisp_Object Qtool_bar
;
3091 extern bool redisplaying_p
;
3092 extern int help_echo_showing_p
;
3093 extern int current_mode_line_height
, current_header_line_height
;
3094 extern Lisp_Object help_echo_string
, help_echo_window
;
3095 extern Lisp_Object help_echo_object
, previous_help_echo_string
;
3096 extern ptrdiff_t help_echo_pos
;
3097 extern struct frame
*last_mouse_frame
;
3098 extern int last_tool_bar_item
;
3099 extern void reseat_at_previous_visible_line_start (struct it
*);
3100 extern Lisp_Object
lookup_glyphless_char_display (int, struct it
*);
3101 extern ptrdiff_t compute_display_string_pos (struct text_pos
*,
3102 struct bidi_string_data
*,
3104 extern ptrdiff_t compute_display_string_end (ptrdiff_t,
3105 struct bidi_string_data
*);
3106 extern void produce_stretch_glyph (struct it
*);
3108 #ifdef HAVE_WINDOW_SYSTEM
3111 extern void dump_glyph_string (struct glyph_string
*) EXTERNALLY_VISIBLE
;
3114 extern void x_get_glyph_overhangs (struct glyph
*, struct frame
*,
3116 extern void x_produce_glyphs (struct it
*);
3118 extern void x_write_glyphs (struct glyph
*, int);
3119 extern void x_insert_glyphs (struct glyph
*, int len
);
3120 extern void x_clear_end_of_line (int);
3122 extern struct cursor_pos output_cursor
;
3124 extern void x_fix_overlapping_area (struct window
*, struct glyph_row
*,
3125 enum glyph_row_area
, int);
3126 extern void draw_phys_cursor_glyph (struct window
*,
3128 enum draw_glyphs_face
);
3129 extern void get_phys_cursor_geometry (struct window
*, struct glyph_row
*,
3130 struct glyph
*, int *, int *, int *);
3131 extern void erase_phys_cursor (struct window
*);
3132 extern void display_and_set_cursor (struct window
*,
3133 int, int, int, int, int);
3135 extern void set_output_cursor (struct cursor_pos
*);
3136 extern void x_cursor_to (int, int, int, int);
3138 extern void x_update_cursor (struct frame
*, int);
3139 extern void x_clear_cursor (struct window
*);
3140 extern void x_draw_vertical_border (struct window
*w
);
3142 extern int get_glyph_string_clip_rects (struct glyph_string
*,
3143 NativeRectangle
*, int);
3144 extern void get_glyph_string_clip_rect (struct glyph_string
*,
3145 NativeRectangle
*nr
);
3146 extern Lisp_Object
find_hot_spot (Lisp_Object
, int, int);
3148 extern void handle_tool_bar_click (struct frame
*,
3149 int, int, int, int);
3151 extern void expose_frame (struct frame
*, int, int, int, int);
3152 extern int x_intersect_rectangles (XRectangle
*, XRectangle
*,
3154 #endif /* HAVE_WINDOW_SYSTEM */
3156 extern void note_mouse_highlight (struct frame
*, int, int);
3157 extern void x_clear_window_mouse_face (struct window
*);
3158 extern void cancel_mouse_face (struct frame
*);
3159 extern int clear_mouse_face (Mouse_HLInfo
*);
3160 extern int cursor_in_mouse_face_p (struct window
*w
);
3161 extern void tty_draw_row_with_mouse_face (struct window
*, struct glyph_row
*,
3162 int, int, enum draw_glyphs_face
);
3164 /* Flags passed to try_window. */
3165 #define TRY_WINDOW_CHECK_MARGINS (1 << 0)
3166 #define TRY_WINDOW_IGNORE_FONTS_CHANGE (1 << 1)
3168 int lookup_fringe_bitmap (Lisp_Object
);
3169 void draw_fringe_bitmap (struct window
*, struct glyph_row
*, int);
3170 void draw_row_fringe_bitmaps (struct window
*, struct glyph_row
*);
3171 int draw_window_fringes (struct window
*, int);
3172 int update_window_fringes (struct window
*, int);
3173 void compute_fringe_widths (struct frame
*, int);
3176 void w32_init_fringe (struct redisplay_interface
*);
3177 void w32_reset_fringes (void);
3180 extern unsigned row_hash (struct glyph_row
*);
3182 /* Defined in image.c */
3184 #ifdef HAVE_WINDOW_SYSTEM
3186 extern int x_bitmap_height (struct frame
*, ptrdiff_t);
3187 extern int x_bitmap_width (struct frame
*, ptrdiff_t);
3188 extern ptrdiff_t x_bitmap_pixmap (struct frame
*, ptrdiff_t);
3189 extern void x_reference_bitmap (struct frame
*, ptrdiff_t);
3190 extern ptrdiff_t x_create_bitmap_from_data (struct frame
*, char *,
3191 unsigned int, unsigned int);
3192 extern ptrdiff_t x_create_bitmap_from_file (struct frame
*, Lisp_Object
);
3193 #if defined HAVE_XPM && defined HAVE_X_WINDOWS && !defined USE_GTK
3194 extern ptrdiff_t x_create_bitmap_from_xpm_data (struct frame
*, const char **);
3196 #ifndef x_destroy_bitmap
3197 extern void x_destroy_bitmap (struct frame
*, ptrdiff_t);
3199 extern void x_destroy_all_bitmaps (Display_Info
*);
3200 extern void x_create_bitmap_mask (struct frame
*, ptrdiff_t);
3201 extern Lisp_Object
x_find_image_file (Lisp_Object
);
3203 void x_kill_gs_process (Pixmap
, struct frame
*);
3204 struct image_cache
*make_image_cache (void);
3205 void free_image_cache (struct frame
*);
3206 void clear_image_caches (Lisp_Object
);
3207 void mark_image_cache (struct image_cache
*);
3208 bool valid_image_p (Lisp_Object
);
3209 void prepare_image_for_display (struct frame
*, struct image
*);
3210 ptrdiff_t lookup_image (struct frame
*, Lisp_Object
);
3212 unsigned long image_background (struct image
*, struct frame
*,
3213 XImagePtr_or_DC ximg
);
3214 int image_background_transparent (struct image
*, struct frame
*,
3215 XImagePtr_or_DC mask
);
3217 int image_ascent (struct image
*, struct face
*, struct glyph_slice
*);
3221 /* Defined in sysdep.c */
3223 void get_tty_size (int, int *, int *);
3224 void request_sigio (void);
3225 void unrequest_sigio (void);
3226 int tabs_safe_p (int);
3227 void init_baud_rate (int);
3228 void init_sigio (int);
3229 void ignore_sigio (void);
3231 /* Defined in xfaces.c */
3233 #ifdef HAVE_X_WINDOWS
3234 void x_free_colors (struct frame
*, unsigned long *, int);
3237 void update_face_from_frame_parameter (struct frame
*, Lisp_Object
,
3239 Lisp_Object
tty_color_name (struct frame
*, int);
3240 void clear_face_cache (int);
3241 unsigned long load_color (struct frame
*, struct face
*, Lisp_Object
,
3242 enum lface_attribute_index
);
3243 void unload_color (struct frame
*, unsigned long);
3244 char *choose_face_font (struct frame
*, Lisp_Object
*, Lisp_Object
,
3246 void prepare_face_for_display (struct frame
*, struct face
*);
3247 int lookup_named_face (struct frame
*, Lisp_Object
, int);
3248 int lookup_basic_face (struct frame
*, int);
3249 int smaller_face (struct frame
*, int, int);
3250 int face_with_height (struct frame
*, int, int);
3251 int lookup_derived_face (struct frame
*, Lisp_Object
, int, int);
3252 void init_frame_faces (struct frame
*);
3253 void free_frame_faces (struct frame
*);
3254 void recompute_basic_faces (struct frame
*);
3255 int face_at_buffer_position (struct window
*w
, ptrdiff_t pos
,
3256 ptrdiff_t region_beg
, ptrdiff_t region_end
,
3257 ptrdiff_t *endptr
, ptrdiff_t limit
,
3258 int mouse
, int base_face_id
);
3259 int face_for_overlay_string (struct window
*w
, ptrdiff_t pos
,
3260 ptrdiff_t region_beg
, ptrdiff_t region_end
,
3261 ptrdiff_t *endptr
, ptrdiff_t limit
,
3262 int mouse
, Lisp_Object overlay
);
3263 int face_at_string_position (struct window
*w
, Lisp_Object string
,
3264 ptrdiff_t pos
, ptrdiff_t bufpos
,
3265 ptrdiff_t region_beg
, ptrdiff_t region_end
,
3266 ptrdiff_t *endptr
, enum face_id
, int mouse
);
3267 int merge_faces (struct frame
*, Lisp_Object
, int, int);
3268 int compute_char_face (struct frame
*, int, Lisp_Object
);
3269 void free_all_realized_faces (Lisp_Object
);
3270 extern Lisp_Object Qforeground_color
, Qbackground_color
;
3271 extern char unspecified_fg
[], unspecified_bg
[];
3273 /* Defined in xfns.c */
3275 #ifdef HAVE_X_WINDOWS
3276 void gamma_correct (struct frame
*, XColor
*);
3279 void gamma_correct (struct frame
*, COLORREF
*);
3282 #ifdef HAVE_WINDOW_SYSTEM
3284 void x_implicitly_set_name (struct frame
*, Lisp_Object
, Lisp_Object
);
3286 extern Lisp_Object tip_frame
;
3287 extern Window tip_window
;
3288 extern frame_parm_handler x_frame_parm_handlers
[];
3290 extern void start_hourglass (void);
3291 extern void cancel_hourglass (void);
3292 extern int hourglass_shown_p
;
3294 struct atimer
; /* Defined in atimer.h. */
3295 /* If non-null, an asynchronous timer that, when it expires, displays
3296 an hourglass cursor on all frames. */
3297 extern struct atimer
*hourglass_atimer
;
3299 /* Each GUI implements these. FIXME: move into RIF. */
3300 extern void show_hourglass (struct atimer
*);
3301 extern void hide_hourglass (void);
3303 /* Returns the background color of IMG, calculating one heuristically if
3304 necessary. If non-zero, XIMG is an existing XImage object to use for
3307 #define IMAGE_BACKGROUND(img, f, ximg) \
3308 ((img)->background_valid \
3309 ? (img)->background \
3310 : image_background (img, f, ximg))
3312 /* Returns true if IMG has a `transparent' background, using heuristics
3313 to decide if necessary. If non-zero, MASK is an existing XImage
3314 object to use for the heuristic. */
3316 #define IMAGE_BACKGROUND_TRANSPARENT(img, f, mask) \
3317 ((img)->background_transparent_valid \
3318 ? (img)->background_transparent \
3319 : image_background_transparent (img, f, mask))
3321 #endif /* HAVE_WINDOW_SYSTEM */
3324 /* Defined in xmenu.c */
3326 int popup_activated (void);
3328 extern Lisp_Object
buffer_posn_from_coords (struct window
*,
3330 struct display_pos
*,
3332 int *, int *, int *, int *);
3333 extern Lisp_Object
mode_line_string (struct window
*, enum window_part
,
3334 int *, int *, ptrdiff_t *,
3336 int *, int *, int *, int *);
3337 extern Lisp_Object
marginal_area_string (struct window
*, enum window_part
,
3338 int *, int *, ptrdiff_t *,
3340 int *, int *, int *, int *);
3341 extern void redraw_frame (struct frame
*);
3342 extern void cancel_line (int, struct frame
*);
3343 extern void init_desired_glyphs (struct frame
*);
3344 extern bool update_frame (struct frame
*, bool, bool);
3345 extern void bitch_at_user (void);
3346 void adjust_glyphs (struct frame
*);
3347 void free_glyphs (struct frame
*);
3348 void free_window_matrices (struct window
*);
3349 void check_glyph_memory (void);
3350 void mirrored_line_dance (struct glyph_matrix
*, int, int, int *, char *);
3351 void clear_glyph_matrix (struct glyph_matrix
*);
3352 void clear_current_matrices (struct frame
*f
);
3353 void clear_desired_matrices (struct frame
*);
3354 void shift_glyph_matrix (struct window
*, struct glyph_matrix
*,
3356 void rotate_matrix (struct glyph_matrix
*, int, int, int);
3357 void increment_matrix_positions (struct glyph_matrix
*,
3358 int, int, ptrdiff_t, ptrdiff_t);
3359 void blank_row (struct window
*, struct glyph_row
*, int);
3360 void clear_glyph_matrix_rows (struct glyph_matrix
*, int, int);
3361 void clear_glyph_row (struct glyph_row
*);
3362 void prepare_desired_row (struct glyph_row
*);
3363 void set_window_update_flags (struct window
*, bool);
3364 void update_single_window (struct window
*, bool);
3365 void do_pending_window_change (bool);
3366 void change_frame_size (struct frame
*, int, int, bool, bool, bool);
3367 void init_display (void);
3368 void syms_of_display (void);
3369 extern Lisp_Object Qredisplay_dont_pause
;
3370 void spec_glyph_lookup_face (struct window
*, GLYPH
*);
3372 /* Defined in terminal.c */
3374 extern void ring_bell (struct frame
*);
3375 extern void update_begin (struct frame
*);
3376 extern void update_end (struct frame
*);
3377 extern void set_terminal_window (struct frame
*, int);
3378 extern void cursor_to (struct frame
*, int, int);
3379 extern void raw_cursor_to (struct frame
*, int, int);
3380 extern void clear_to_end (struct frame
*);
3381 extern void clear_frame (struct frame
*);
3382 extern void clear_end_of_line (struct frame
*, int);
3383 extern void write_glyphs (struct frame
*, struct glyph
*, int);
3384 extern void insert_glyphs (struct frame
*, struct glyph
*, int);
3385 extern void delete_glyphs (struct frame
*, int);
3386 extern void ins_del_lines (struct frame
*, int, int);
3388 extern struct terminal
*init_initial_terminal (void);
3391 /* Defined in term.c */
3393 extern void tty_turn_off_insert (struct tty_display_info
*);
3394 extern int string_cost (const char *);
3395 extern int per_line_cost (const char *);
3396 extern void calculate_costs (struct frame
*);
3397 extern void produce_glyphs (struct it
*);
3398 extern int tty_capable_p (struct tty_display_info
*, unsigned, unsigned long, unsigned long);
3399 extern void set_tty_color_mode (struct tty_display_info
*, struct frame
*);
3400 extern struct terminal
*get_named_tty (const char *);
3401 extern void create_tty_output (struct frame
*);
3402 extern struct terminal
*init_tty (const char *, const char *, int);
3403 extern void tty_append_glyph (struct it
*);
3406 /* Defined in scroll.c */
3408 extern int scrolling_max_lines_saved (int, int, int *, int *, int *);
3409 extern void do_line_insertion_deletion_costs (struct frame
*, const char *,
3410 const char *, const char *,
3411 const char *, const char *,
3413 void scrolling_1 (struct frame
*, int, int, int, int *, int *, int *,
3416 /* Defined in frame.c */
3418 #ifdef HAVE_WINDOW_SYSTEM
3420 /* Types we might convert a resource string into. */
3428 RES_TYPE_BOOLEAN_NUMBER
3431 extern Lisp_Object
x_get_arg (Display_Info
*, Lisp_Object
,
3432 Lisp_Object
, const char *, const char *class,
3433 enum resource_types
);
3434 extern Lisp_Object
x_frame_get_and_record_arg (struct frame
*, Lisp_Object
,
3436 const char *, const char *,
3437 enum resource_types
);
3438 extern Lisp_Object
x_default_parameter (struct frame
*, Lisp_Object
,
3439 Lisp_Object
, Lisp_Object
,
3440 const char *, const char *,
3441 enum resource_types
);
3443 #endif /* HAVE_WINDOW_SYSTEM */
3447 #endif /* not DISPEXTERN_H_INCLUDED */