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 typedef struct x_display_info Display_Info
;
51 typedef XImage
* XImagePtr
;
52 typedef XImagePtr XImagePtr_or_DC
;
53 #define NativeRectangle XRectangle
58 typedef struct w32_display_info Display_Info
;
59 typedef XImage
*XImagePtr
;
60 typedef HDC XImagePtr_or_DC
;
65 /* Following typedef needed to accommodate the MSDOS port, believe it or not. */
66 typedef struct ns_display_info Display_Info
;
67 typedef Pixmap XImagePtr
;
68 typedef XImagePtr XImagePtr_or_DC
;
71 #ifdef HAVE_WINDOW_SYSTEM
75 #ifndef HAVE_WINDOW_SYSTEM
80 #ifndef NativeRectangle
81 #define NativeRectangle int
84 /* Structure forward declarations. Some are here because function
85 prototypes below reference structure types before their definition
86 in this file. Some are here because not every file including
87 dispextern.h also includes frame.h and windows.h. */
97 /* Values returned from coordinates_in_window. */
113 /* Number of bits allocated to store fringe bitmap numbers. */
114 #define FRINGE_ID_BITS 16
116 /* Number of bits allocated to store fringe bitmap height. */
117 #define FRINGE_HEIGHT_BITS 8
120 /***********************************************************************
122 ***********************************************************************/
124 /* If GLYPH_DEBUG is non-zero, additional checks are activated. Turn
125 it off by defining the macro GLYPH_DEBUG to zero. */
128 #define GLYPH_DEBUG 0
131 /* Macros to include code only if GLYPH_DEBUG != 0. */
134 #define IF_DEBUG(X) X
136 #define IF_DEBUG(X) (void) 0
139 /* Macro for displaying traces of redisplay. If Emacs was compiled
140 with GLYPH_DEBUG != 0, the variable trace_redisplay_p can be set to
141 a non-zero value in debugging sessions to activate traces. */
145 extern int trace_redisplay_p EXTERNALLY_VISIBLE
;
149 if (trace_redisplay_p) \
154 #else /* GLYPH_DEBUG == 0 */
156 #define TRACE(X) (void) 0
158 #endif /* GLYPH_DEBUG == 0 */
162 /***********************************************************************
164 ***********************************************************************/
166 /* Starting with Emacs 20.3, characters from strings and buffers have
167 both a character and a byte position associated with them. The
168 following structure holds such a pair of positions. */
172 /* Character position. */
175 /* Corresponding byte position. */
179 /* Access character and byte position of POS in a functional form. */
181 #define BYTEPOS(POS) (POS).bytepos
182 #define CHARPOS(POS) (POS).charpos
184 /* Set character position of POS to CHARPOS, byte position to BYTEPOS. */
186 #define SET_TEXT_POS(POS, CHARPOS, BYTEPOS) \
187 ((POS).charpos = (CHARPOS), (POS).bytepos = BYTEPOS)
189 /* Increment text position POS. */
191 #define INC_TEXT_POS(POS, MULTIBYTE_P) \
196 INC_POS ((POS).bytepos); \
202 /* Decrement text position POS. */
204 #define DEC_TEXT_POS(POS, MULTIBYTE_P) \
209 DEC_POS ((POS).bytepos); \
215 /* Set text position POS from marker MARKER. */
217 #define SET_TEXT_POS_FROM_MARKER(POS, MARKER) \
218 (CHARPOS (POS) = marker_position ((MARKER)), \
219 BYTEPOS (POS) = marker_byte_position ((MARKER)))
221 /* Set marker MARKER from text position POS. */
223 #define SET_MARKER_FROM_TEXT_POS(MARKER, POS) \
224 set_marker_both ((MARKER), Qnil, CHARPOS ((POS)), BYTEPOS ((POS)))
226 /* Value is non-zero if character and byte positions of POS1 and POS2
229 #define TEXT_POS_EQUAL_P(POS1, POS2) \
230 ((POS1).charpos == (POS2).charpos \
231 && (POS1).bytepos == (POS2).bytepos)
233 /* When rendering glyphs, redisplay scans string or buffer text,
234 overlay strings in that text, and does display table or control
235 character translations. The following structure captures a
236 position taking all this into account. */
240 /* Buffer or string position. */
243 /* If this is a position in an overlay string, overlay_string_index
244 is the index of that overlay string in the sequence of overlay
245 strings at `pos' in the order redisplay processes them. A value
246 < 0 means that this is not a position in an overlay string. */
247 ptrdiff_t overlay_string_index
;
249 /* If this is a position in an overlay string, string_pos is the
250 position within that string. */
251 struct text_pos string_pos
;
253 /* If the character at the position above is a control character or
254 has a display table entry, dpvec_index is an index in the display
255 table or control character translation of that character. A
256 value < 0 means this is not a position in such a translation. */
262 /***********************************************************************
264 ***********************************************************************/
266 /* Enumeration of glyph types. Glyph structures contain a type field
267 containing one of the enumerators defined here. */
271 /* Glyph describes a character. */
274 /* Glyph describes a static composition. */
277 /* Glyph describes a glyphless character. */
280 /* Glyph describes an image. */
283 /* Glyph is a space of fractional width and/or height. */
288 /* Structure describing how to use partial glyphs (images slicing) */
295 unsigned height
: 16;
301 Be extra careful when changing this structure! Esp. make sure that
302 functions producing glyphs, like append_glyph, fill ALL of the
303 glyph structure, and that GLYPH_EQUAL_P compares all
304 display-relevant members of glyphs (not to imply that these are the
305 only things to check when you add a member). */
309 /* Position from which this glyph was drawn. If `object' below is a
310 Lisp string, this is a position in that string. If it is a
311 buffer, this is a position in that buffer. A value of -1
312 together with a null object means glyph is a truncation glyph at
313 the start of a row. */
316 /* Lisp object source of this glyph. Currently either a buffer or
317 a string, if the glyph was produced from characters which came from
318 a buffer or a string; or 0 if the glyph was inserted by redisplay
319 for its own purposes such as padding. */
322 /* Width in pixels. */
325 /* Ascent and descent in pixels. */
326 short ascent
, descent
;
328 /* Vertical offset. If < 0, the glyph is displayed raised, if > 0
329 the glyph is displayed lowered. */
332 /* Which kind of glyph this is---character, image etc. Value
333 should be an enumerator of type enum glyph_type. */
336 /* 1 means this glyph was produced from multibyte text. Zero
337 means it was produced from unibyte text, i.e. charsets aren't
338 applicable, and encoding is not performed. */
339 unsigned multibyte_p
: 1;
341 /* Non-zero means draw a box line at the left or right side of this
342 glyph. This is part of the implementation of the face attribute
344 unsigned left_box_line_p
: 1;
345 unsigned right_box_line_p
: 1;
347 /* Non-zero means this glyph's physical ascent or descent is greater
348 than its logical ascent/descent, i.e. it may potentially overlap
349 glyphs above or below it. */
350 unsigned overlaps_vertically_p
: 1;
352 /* For terminal frames, 1 means glyph is a padding glyph. Padding
353 glyphs are used for characters whose visual shape consists of
354 more than one glyph (e.g. Asian characters). All but the first
355 glyph of such a glyph sequence have the padding_p flag set. This
356 flag is used only to minimize code changes. A better way would
357 probably be to use the width field of glyphs to express padding.
359 For graphic frames, 1 means the pixel width of the glyph in a
360 font is 0, but 1-pixel is padded on displaying for correct cursor
361 displaying. The member `pixel_width' above is set to 1. */
362 unsigned padding_p
: 1;
364 /* 1 means the actual glyph is not available, draw using `struct
365 glyphless' below instead. This can happen when a font couldn't
366 be loaded, or a character doesn't have a glyph in a font. */
367 unsigned glyph_not_available_p
: 1;
369 /* Non-zero means don't display cursor here. */
370 unsigned avoid_cursor_p
: 1;
372 /* Resolved bidirectional level of this character [0..63]. */
373 unsigned resolved_level
: 5;
375 /* Resolved bidirectional type of this character, see enum
376 bidi_type_t below. Note that according to UAX#9, only some
377 values (STRONG_L, STRONG_R, WEAK_AN, WEAK_EN, WEAK_BN, and
378 NEUTRAL_B) can appear in the resolved type, so we only reserve
379 space for those that can. */
380 unsigned bidi_type
: 3;
382 #define FACE_ID_BITS 20
384 /* Face of the glyph. This is a realized face ID,
385 an index in the face cache of the frame. */
386 unsigned face_id
: FACE_ID_BITS
;
388 /* Type of font used to display the character glyph. May be used to
389 determine which set of functions to use to obtain font metrics
390 for the glyph. On W32, value should be an enumerator of the type
391 w32_char_font_type. Otherwise it equals FONT_TYPE_UNKNOWN. */
392 unsigned font_type
: 3;
394 /* A union of sub-structures for different glyph types. */
397 /* Metrics of a partial glyph of an image (type == IMAGE_GLYPH). */
398 struct glyph_slice img
;
399 /* Start and end indices of glyphs of a grapheme cluster of a
400 composition (type == COMPOSITE_GLYPH). */
401 struct { int from
, to
; } cmp
;
402 /* Pixel offsets for upper and lower part of the acronym. */
404 short upper_xoff
, upper_yoff
;
405 short lower_xoff
, lower_yoff
;
409 /* A union of sub-structures for different glyph types. */
412 /* Character code for character glyphs (type == CHAR_GLYPH). */
415 /* Sub-structures for type == COMPOSITE_GLYPH. */
418 /* Flag to tell if the composition is automatic or not. */
419 unsigned automatic
: 1;
420 /* ID of the composition. */
424 /* Image ID for image glyphs (type == IMAGE_GLYPH). */
427 /* Sub-structure for type == STRETCH_GLYPH. */
430 /* The height of the glyph. */
431 unsigned height
: 16;
433 /* The ascent of the glyph. */
434 unsigned ascent
: 16;
438 /* Sub-stretch for type == GLYPHLESS_GLYPH. */
441 /* Value is an enum of the type glyphless_display_method. */
443 /* 1 iff this glyph is for a character of no font. */
444 unsigned for_no_font
: 1;
445 /* Length of acronym or hexadecimal code string (at most 8). */
447 /* Character to display. Actually we need only 22 bits. */
451 /* Used to compare all bit-fields above in one step. */
457 /* Default value of the glyph font_type field. */
459 #define FONT_TYPE_UNKNOWN 0
461 /* Is GLYPH a space? */
463 #define CHAR_GLYPH_SPACE_P(GLYPH) \
464 ((GLYPH).u.ch == SPACEGLYPH && (GLYPH).face_id == DEFAULT_FACE_ID)
466 /* Are glyph slices of glyphs *X and *Y equal? It assumes that both
467 glyphs have the same type.
469 Note: for composition glyphs, we don't have to compare slice.cmp.to
470 because they should be the same if and only if slice.cmp.from are
473 #define GLYPH_SLICE_EQUAL_P(X, Y) \
474 ((X)->type == IMAGE_GLYPH \
475 ? ((X)->slice.img.x == (Y)->slice.img.x \
476 && (X)->slice.img.y == (Y)->slice.img.y \
477 && (X)->slice.img.width == (Y)->slice.img.width \
478 && (X)->slice.img.height == (Y)->slice.img.height) \
479 : ((X)->type != COMPOSITE_GLYPH \
480 || (X)->slice.cmp.from == (Y)->slice.cmp.from))
482 /* Are glyphs *X and *Y displayed equal? */
484 #define GLYPH_EQUAL_P(X, Y) \
485 ((X)->type == (Y)->type \
486 && (X)->u.val == (Y)->u.val \
487 && GLYPH_SLICE_EQUAL_P (X, Y) \
488 && (X)->face_id == (Y)->face_id \
489 && (X)->padding_p == (Y)->padding_p \
490 && (X)->left_box_line_p == (Y)->left_box_line_p \
491 && (X)->right_box_line_p == (Y)->right_box_line_p \
492 && (X)->voffset == (Y)->voffset \
493 && (X)->pixel_width == (Y)->pixel_width)
495 /* Are character codes, faces, padding_ps of glyphs *X and *Y equal? */
497 #define GLYPH_CHAR_AND_FACE_EQUAL_P(X, Y) \
498 ((X)->u.ch == (Y)->u.ch \
499 && (X)->face_id == (Y)->face_id \
500 && (X)->padding_p == (Y)->padding_p)
502 /* Fill a character glyph GLYPH. CODE, FACE_ID, PADDING_P correspond
503 to the bits defined for the typedef `GLYPH' in lisp.h. */
505 #define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P) \
508 (GLYPH).u.ch = (CODE); \
509 (GLYPH).face_id = (FACE_ID); \
510 (GLYPH).padding_p = (PADDING_P); \
514 /* Fill a character type glyph GLYPH from a glyph typedef FROM as
515 defined in lisp.h. */
517 #define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM) \
518 SET_CHAR_GLYPH ((GLYPH), \
519 GLYPH_CHAR ((FROM)), \
520 GLYPH_FACE ((FROM)), \
523 /* Construct a glyph code from a character glyph GLYPH. If the
524 character is multibyte, return -1 as we can't use glyph table for a
525 multibyte character. */
527 #define SET_GLYPH_FROM_CHAR_GLYPH(G, GLYPH) \
530 if ((GLYPH).u.ch < 256) \
531 SET_GLYPH ((G), (GLYPH).u.ch, ((GLYPH).face_id)); \
533 SET_GLYPH ((G), -1, 0); \
537 #define GLYPH_INVALID_P(GLYPH) (GLYPH_CHAR (GLYPH) < 0)
539 /* Is GLYPH a padding glyph? */
541 #define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p
546 /***********************************************************************
548 ***********************************************************************/
552 Glyph memory for frame-based redisplay is allocated from the heap
553 in one vector kept in a glyph pool structure which is stored with
554 the frame. The size of the vector is made large enough to cover
555 all windows on the frame.
557 Both frame and window glyph matrices reference memory from a glyph
558 pool in frame-based redisplay.
560 In window-based redisplay, no glyphs pools exist; windows allocate
561 and free their glyph memory themselves. */
565 /* Vector of glyphs allocated from the heap. */
566 struct glyph
*glyphs
;
568 /* Allocated size of `glyphs'. */
571 /* Number of rows and columns in a matrix. */
577 /***********************************************************************
579 ***********************************************************************/
583 Three kinds of glyph matrices exist:
585 1. Frame glyph matrices. These are used for terminal frames whose
586 redisplay needs a view of the whole screen due to limited terminal
587 capabilities. Frame matrices are used only in the update phase
588 of redisplay. They are built in update_frame and not used after
589 the update has been performed.
591 2. Window glyph matrices on frames having frame glyph matrices.
592 Such matrices are sub-matrices of their corresponding frame matrix,
593 i.e. frame glyph matrices and window glyph matrices share the same
594 glyph memory which is allocated in form of a glyph_pool structure.
595 Glyph rows in such a window matrix are slices of frame matrix rows.
597 2. Free-standing window glyph matrices managing their own glyph
598 storage. This form is used in window-based redisplay which
599 includes variable width and height fonts etc.
601 The size of a window's row vector depends on the height of fonts
602 defined on its frame. It is chosen so that the vector is large
603 enough to describe all lines in a window when it is displayed in
604 the smallest possible character size. When new fonts are loaded,
605 or window sizes change, the row vector is adjusted accordingly. */
609 /* The pool from which glyph memory is allocated, if any. This is
610 null for frame matrices and for window matrices managing their
612 struct glyph_pool
*pool
;
614 /* Vector of glyph row structures. The row at nrows - 1 is reserved
615 for the mode line. */
616 struct glyph_row
*rows
;
618 /* Number of elements allocated for the vector rows above. */
619 ptrdiff_t rows_allocated
;
621 /* The number of rows used by the window if all lines were displayed
622 with the smallest possible character height. */
625 /* Origin within the frame matrix if this is a window matrix on a
626 frame having a frame matrix. Both values are zero for
627 window-based redisplay. */
628 int matrix_x
, matrix_y
;
630 /* Width and height of the matrix in columns and rows. */
631 int matrix_w
, matrix_h
;
633 /* If this structure describes a window matrix of window W,
634 window_left_col is the value of W->left_col, window_top_line the
635 value of W->top_line, window_height and window_width are width and
636 height of W, as returned by window_box, and window_vscroll is the
637 value of W->vscroll at the time the matrix was last adjusted.
638 Only set for window-based redisplay. */
639 int window_left_col
, window_top_line
;
640 int window_height
, window_width
;
643 /* Number of glyphs reserved for left and right marginal areas when
644 the matrix was last adjusted. */
645 int left_margin_glyphs
, right_margin_glyphs
;
647 /* Flag indicating that scrolling should not be tried in
648 update_window. This flag is set by functions like try_window_id
649 which do their own scrolling. */
650 unsigned no_scrolling_p
: 1;
652 /* Non-zero means window displayed in this matrix has a top mode
654 unsigned header_line_p
: 1;
657 /* A string identifying the method used to display the matrix. */
661 /* The buffer this matrix displays. Set in
662 mark_window_display_accurate_1. */
663 struct buffer
*buffer
;
665 /* Values of BEGV and ZV as of last redisplay. Set in
666 mark_window_display_accurate_1. */
671 /* Check that glyph pointers stored in glyph rows of MATRIX are okay.
672 This aborts if any pointer is found twice. */
675 void check_matrix_pointer_lossage (struct glyph_matrix
*);
676 #define CHECK_MATRIX(MATRIX) check_matrix_pointer_lossage ((MATRIX))
678 #define CHECK_MATRIX(MATRIX) (void) 0
683 /***********************************************************************
685 ***********************************************************************/
687 /* Area in window glyph matrix. If values are added or removed, the
688 function mark_object in alloc.c has to be changed. */
699 /* Rows of glyphs in a windows or frame glyph matrix.
701 Each row is partitioned into three areas. The start and end of
702 each area is recorded in a pointer as shown below.
704 +--------------------+-------------+---------------------+
705 | left margin area | text area | right margin area |
706 +--------------------+-------------+---------------------+
708 glyphs[LEFT_MARGIN_AREA] glyphs[RIGHT_MARGIN_AREA]
713 Rows in frame matrices reference glyph memory allocated in a frame
714 glyph pool (see the description of struct glyph_pool). Rows in
715 window matrices on frames having frame matrices reference slices of
716 the glyphs of corresponding rows in the frame matrix.
718 Rows in window matrices on frames having no frame matrices point to
719 glyphs allocated from the heap via xmalloc;
720 glyphs[LEFT_MARGIN_AREA] is the start address of the allocated
721 glyph structure array. */
725 /* Pointers to beginnings of areas. The end of an area A is found at
726 A + 1 in the vector. The last element of the vector is the end
729 Kludge alert: Even if used[TEXT_AREA] == 0, glyphs[TEXT_AREA][0]'s
730 position field is used. It is -1 if this row does not correspond
731 to any text; it is some buffer position if the row corresponds to
732 an empty display line that displays a line end. This is what old
733 redisplay used to do. (Except in code for terminal frames, this
734 kludge is no longer used, I believe. --gerd).
736 See also start, end, displays_text_p and ends_at_zv_p for cleaner
737 ways to do it. The special meaning of positions 0 and -1 will be
738 removed some day, so don't use it in new code. */
739 struct glyph
*glyphs
[1 + LAST_AREA
];
741 /* Number of glyphs actually filled in areas. */
742 short used
[LAST_AREA
];
744 /* Window-relative x and y-position of the top-left corner of this
745 row. If y < 0, this means that eabs (y) pixels of the row are
746 invisible because it is partially visible at the top of a window.
747 If x < 0, this means that eabs (x) pixels of the first glyph of
748 the text area of the row are invisible because the glyph is
749 partially visible. */
752 /* Width of the row in pixels without taking face extension at the
753 end of the row into account, and without counting truncation
754 and continuation glyphs at the end of a row on ttys. */
757 /* Logical ascent/height of this line. The value of ascent is zero
758 and height is 1 on terminal frames. */
761 /* Physical ascent/height of this line. If max_ascent > ascent,
762 this line overlaps the line above it on the display. Otherwise,
763 if max_height > height, this line overlaps the line beneath it. */
764 int phys_ascent
, phys_height
;
766 /* Portion of row that is visible. Partially visible rows may be
767 found at the top and bottom of a window. This is 1 for tty
768 frames. It may be < 0 in case of completely invisible rows. */
771 /* Extra line spacing added after this row. Do not consider this
772 in last row when checking if row is fully visible. */
773 int extra_line_spacing
;
775 /* Hash code. This hash code is available as soon as the row
776 is constructed, i.e. after a call to display_line. */
779 /* First position in this row. This is the text position, including
780 overlay position information etc, where the display of this row
781 started, and can thus be less than the position of the first
782 glyph (e.g. due to invisible text or horizontal scrolling).
783 BIDI Note: In R2L rows, that have its reversed_p flag set, this
784 position is at or beyond the right edge of the row. */
785 struct display_pos start
;
787 /* Text position at the end of this row. This is the position after
788 the last glyph on this row. It can be greater than the last
789 glyph position + 1, due to a newline that ends the line,
790 truncation, invisible text etc. In an up-to-date display, this
791 should always be equal to the start position of the next row.
792 BIDI Note: In R2L rows, this position is at or beyond the left
794 struct display_pos end
;
796 /* The smallest and the largest buffer positions that contributed to
797 glyphs in this row. Note that due to bidi reordering, these are
798 in general different from the text positions stored in `start'
799 and `end' members above, and also different from the buffer
800 positions recorded in the glyphs displayed the leftmost and
801 rightmost on the screen. */
802 struct text_pos minpos
, maxpos
;
804 /* Non-zero means the overlay arrow bitmap is on this line.
805 -1 means use default overlay arrow bitmap, else
806 it specifies actual fringe bitmap number. */
807 int overlay_arrow_bitmap
;
809 /* Left fringe bitmap number (enum fringe_bitmap_type). */
810 unsigned left_user_fringe_bitmap
: FRINGE_ID_BITS
;
812 /* Right fringe bitmap number (enum fringe_bitmap_type). */
813 unsigned right_user_fringe_bitmap
: FRINGE_ID_BITS
;
815 /* Left fringe bitmap number (enum fringe_bitmap_type). */
816 unsigned left_fringe_bitmap
: FRINGE_ID_BITS
;
818 /* Right fringe bitmap number (enum fringe_bitmap_type). */
819 unsigned right_fringe_bitmap
: FRINGE_ID_BITS
;
821 /* Face of the left fringe glyph. */
822 unsigned left_user_fringe_face_id
: FACE_ID_BITS
;
824 /* Face of the right fringe glyph. */
825 unsigned right_user_fringe_face_id
: FACE_ID_BITS
;
827 /* Face of the left fringe glyph. */
828 unsigned left_fringe_face_id
: FACE_ID_BITS
;
830 /* Face of the right fringe glyph. */
831 unsigned right_fringe_face_id
: FACE_ID_BITS
;
833 /* Vertical offset of the left fringe bitmap. */
834 signed left_fringe_offset
: FRINGE_HEIGHT_BITS
;
836 /* Vertical offset of the right fringe bitmap. */
837 signed right_fringe_offset
: FRINGE_HEIGHT_BITS
;
839 /* 1 means that at least one of the left and right fringe bitmaps is
840 periodic and thus depends on the y-position of the row. */
841 unsigned fringe_bitmap_periodic_p
: 1;
843 /* 1 means that we must draw the bitmaps of this row. */
844 unsigned redraw_fringe_bitmaps_p
: 1;
846 /* In a desired matrix, 1 means that this row must be updated. In a
847 current matrix, 0 means that the row has been invalidated, i.e.
848 the row's contents do not agree with what is visible on the
850 unsigned enabled_p
: 1;
852 /* 1 means row displays a text line that is truncated on the left or
854 unsigned truncated_on_left_p
: 1;
855 unsigned truncated_on_right_p
: 1;
857 /* 1 means that this row displays a continued line, i.e. it has a
858 continuation mark at the right side. */
859 unsigned continued_p
: 1;
861 /* 0 means that this row does not contain any text, i.e. it is
862 a blank line at the window and buffer end. */
863 unsigned displays_text_p
: 1;
865 /* 1 means that this line ends at ZV. */
866 unsigned ends_at_zv_p
: 1;
868 /* 1 means the face of the last glyph in the text area is drawn to
869 the right end of the window. This flag is used in
870 update_text_area to optimize clearing to the end of the area. */
871 unsigned fill_line_p
: 1;
873 /* Non-zero means display a bitmap on X frames indicating that this
874 line contains no text and ends in ZV. */
875 unsigned indicate_empty_line_p
: 1;
877 /* 1 means this row contains glyphs that overlap each other because
878 of lbearing or rbearing. */
879 unsigned contains_overlapping_glyphs_p
: 1;
881 /* 1 means this row is as wide as the window it is displayed in, including
882 scroll bars, fringes, and internal borders. This also
883 implies that the row doesn't have marginal areas. */
884 unsigned full_width_p
: 1;
886 /* Non-zero means row is a mode or header-line. */
887 unsigned mode_line_p
: 1;
889 /* 1 in a current row means this row is overlapped by another row. */
890 unsigned overlapped_p
: 1;
892 /* 1 means this line ends in the middle of a character consisting
893 of more than one glyph. Some glyphs have been put in this row,
894 the rest are put in rows below this one. */
895 unsigned ends_in_middle_of_char_p
: 1;
897 /* 1 means this line starts in the middle of a character consisting
898 of more than one glyph. Some glyphs have been put in the
899 previous row, the rest are put in this row. */
900 unsigned starts_in_middle_of_char_p
: 1;
902 /* 1 in a current row means this row overlaps others. */
903 unsigned overlapping_p
: 1;
905 /* 1 means some glyphs in this row are displayed in mouse-face. */
906 unsigned mouse_face_p
: 1;
908 /* 1 means this row was ended by a newline from a string. */
909 unsigned ends_in_newline_from_string_p
: 1;
911 /* 1 means this row width is exactly the width of the window, and the
912 final newline character is hidden in the right fringe. */
913 unsigned exact_window_width_line_p
: 1;
915 /* 1 means this row currently shows the cursor in the right fringe. */
916 unsigned cursor_in_fringe_p
: 1;
918 /* 1 means the last glyph in the row is part of an ellipsis. */
919 unsigned ends_in_ellipsis_p
: 1;
921 /* Non-zero means display a bitmap on X frames indicating that this
922 the first line of the buffer. */
923 unsigned indicate_bob_p
: 1;
925 /* Non-zero means display a bitmap on X frames indicating that this
926 the top line of the window, but not start of the buffer. */
927 unsigned indicate_top_line_p
: 1;
929 /* Non-zero means display a bitmap on X frames indicating that this
930 the last line of the buffer. */
931 unsigned indicate_eob_p
: 1;
933 /* Non-zero means display a bitmap on X frames indicating that this
934 the bottom line of the window, but not end of the buffer. */
935 unsigned indicate_bottom_line_p
: 1;
937 /* Non-zero means the row was reversed to display text in a
938 right-to-left paragraph. */
939 unsigned reversed_p
: 1;
941 /* Continuation lines width at the start of the row. */
942 int continuation_lines_width
;
944 #ifdef HAVE_WINDOW_SYSTEM
945 /* Non-NULL means the current clipping area. This is temporarily
946 set while exposing a region. Coordinates are frame-relative. */
952 /* Get a pointer to row number ROW in matrix MATRIX. If GLYPH_DEBUG
953 is defined to a non-zero value, the function matrix_row checks that
954 we don't try to access rows that are out of bounds. */
957 struct glyph_row
*matrix_row (struct glyph_matrix
*, int);
958 #define MATRIX_ROW(MATRIX, ROW) matrix_row ((MATRIX), (ROW))
960 #define MATRIX_ROW(MATRIX, ROW) ((MATRIX)->rows + (ROW))
963 /* Return a pointer to the row reserved for the mode line in MATRIX.
964 Row MATRIX->nrows - 1 is always reserved for the mode line. */
966 #define MATRIX_MODE_LINE_ROW(MATRIX) \
967 ((MATRIX)->rows + (MATRIX)->nrows - 1)
969 /* Return a pointer to the row reserved for the header line in MATRIX.
970 This is always the first row in MATRIX because that's the only
971 way that works in frame-based redisplay. */
973 #define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows
975 /* Return a pointer to first row in MATRIX used for text display. */
977 #define MATRIX_FIRST_TEXT_ROW(MATRIX) \
978 ((MATRIX)->rows->mode_line_p ? (MATRIX)->rows + 1 : (MATRIX)->rows)
980 /* Return a pointer to the first glyph in the text area of a row.
981 MATRIX is the glyph matrix accessed, and ROW is the row index in
984 #define MATRIX_ROW_GLYPH_START(MATRIX, ROW) \
985 (MATRIX_ROW ((MATRIX), (ROW))->glyphs[TEXT_AREA])
987 /* Return the number of used glyphs in the text area of a row. */
989 #define MATRIX_ROW_USED(MATRIX, ROW) \
990 (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA])
992 /* Return the character/ byte position at which the display of ROW
993 starts. BIDI Note: this is the smallest character/byte position
994 among characters in ROW, i.e. the first logical-order character
995 displayed by ROW, which is not necessarily the smallest horizontal
998 #define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->minpos.charpos)
999 #define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->minpos.bytepos)
1001 /* Return the character/ byte position at which ROW ends. BIDI Note:
1002 this is the largest character/byte position among characters in
1003 ROW, i.e. the last logical-order character displayed by ROW, which
1004 is not necessarily the largest horizontal position. */
1006 #define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->maxpos.charpos)
1007 #define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->maxpos.bytepos)
1009 /* Return the vertical position of ROW in MATRIX. */
1011 #define MATRIX_ROW_VPOS(ROW, MATRIX) ((ROW) - (MATRIX)->rows)
1013 /* Return the last glyph row + 1 in MATRIX on window W reserved for
1014 text. If W has a mode line, the last row in the matrix is reserved
1017 #define MATRIX_BOTTOM_TEXT_ROW(MATRIX, W) \
1020 - (WINDOW_WANTS_MODELINE_P ((W)) ? 1 : 0))
1022 /* Non-zero if the face of the last glyph in ROW's text area has
1023 to be drawn to the end of the text area. */
1025 #define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)
1027 /* Set and query the enabled_p flag of glyph row ROW in MATRIX. */
1029 #define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
1030 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0)
1032 #define MATRIX_ROW_ENABLED_P(MATRIX, ROW) \
1033 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p)
1035 /* Non-zero if ROW displays text. Value is non-zero if the row is
1036 blank but displays a line end. */
1038 #define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)
1043 #define MR_PARTIALLY_VISIBLE(ROW) \
1044 ((ROW)->height != (ROW)->visible_height)
1046 #define MR_PARTIALLY_VISIBLE_AT_TOP(W, ROW) \
1047 ((ROW)->y < WINDOW_HEADER_LINE_HEIGHT ((W)))
1049 #define MR_PARTIALLY_VISIBLE_AT_BOTTOM(W, ROW) \
1050 (((ROW)->y + (ROW)->height - (ROW)->extra_line_spacing) \
1051 > WINDOW_BOX_HEIGHT_NO_MODE_LINE ((W)))
1053 /* Non-zero if ROW is not completely visible in window W. */
1055 #define MATRIX_ROW_PARTIALLY_VISIBLE_P(W, ROW) \
1056 (MR_PARTIALLY_VISIBLE ((ROW)) \
1057 && (MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)) \
1058 || MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW))))
1062 /* Non-zero if ROW is partially visible at the top of window W. */
1064 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW) \
1065 (MR_PARTIALLY_VISIBLE ((ROW)) \
1066 && MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)))
1068 /* Non-zero if ROW is partially visible at the bottom of window W. */
1070 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW) \
1071 (MR_PARTIALLY_VISIBLE ((ROW)) \
1072 && MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW)))
1074 /* Return the bottom Y + 1 of ROW. */
1076 #define MATRIX_ROW_BOTTOM_Y(ROW) ((ROW)->y + (ROW)->height)
1078 /* Is ROW the last visible one in the display described by the
1079 iterator structure pointed to by IT?. */
1081 #define MATRIX_ROW_LAST_VISIBLE_P(ROW, IT) \
1082 (MATRIX_ROW_BOTTOM_Y ((ROW)) >= (IT)->last_visible_y)
1084 /* Non-zero if ROW displays a continuation line. */
1086 #define MATRIX_ROW_CONTINUATION_LINE_P(ROW) \
1087 ((ROW)->continuation_lines_width > 0)
1089 /* Non-zero if ROW ends in the middle of a character. This is the
1090 case for continued lines showing only part of a display table entry
1091 or a control char, or an overlay string. */
1093 #define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW) \
1094 ((ROW)->end.dpvec_index > 0 \
1095 || (ROW)->end.overlay_string_index >= 0 \
1096 || (ROW)->ends_in_middle_of_char_p)
1098 /* Non-zero if ROW ends in the middle of an overlay string. */
1100 #define MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P(ROW) \
1101 ((ROW)->end.overlay_string_index >= 0)
1103 /* Non-zero if ROW starts in the middle of a character. See above. */
1105 #define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW) \
1106 ((ROW)->start.dpvec_index > 0 \
1107 || (ROW)->starts_in_middle_of_char_p \
1108 || ((ROW)->start.overlay_string_index >= 0 \
1109 && (ROW)->start.string_pos.charpos > 0))
1111 /* Non-zero means ROW overlaps its predecessor. */
1113 #define MATRIX_ROW_OVERLAPS_PRED_P(ROW) \
1114 ((ROW)->phys_ascent > (ROW)->ascent)
1116 /* Non-zero means ROW overlaps its successor. */
1118 #define MATRIX_ROW_OVERLAPS_SUCC_P(ROW) \
1119 ((ROW)->phys_height - (ROW)->phys_ascent \
1120 > (ROW)->height - (ROW)->ascent)
1122 /* Non-zero means that fonts have been loaded since the last glyph
1123 matrix adjustments. The function redisplay_internal adjusts glyph
1124 matrices when this flag is non-zero. */
1126 extern int fonts_changed_p
;
1128 /* A glyph for a space. */
1130 extern struct glyph space_glyph
;
1132 /* Window being updated by update_window. This is non-null as long as
1133 update_window has not finished, and null otherwise. */
1135 extern struct window
*updated_window
;
1137 /* Glyph row and area updated by update_window_line. */
1139 extern struct glyph_row
*updated_row
;
1140 extern int updated_area
;
1142 /* Non-zero means last display completed. Zero means it was
1145 extern int display_completed
;
1149 /************************************************************************
1151 ************************************************************************/
1153 /* Enumeration for overriding/changing the face to use for drawing
1154 glyphs in draw_glyphs. */
1156 enum draw_glyphs_face
1166 #ifdef HAVE_WINDOW_SYSTEM
1168 /* A sequence of glyphs to be drawn in the same face. */
1172 /* X-origin of the string. */
1175 /* Y-origin and y-position of the base line of this string. */
1178 /* The width of the string, not including a face extension. */
1181 /* The width of the string, including a face extension. */
1182 int background_width
;
1184 /* The height of this string. This is the height of the line this
1185 string is drawn in, and can be different from the height of the
1186 font the string is drawn in. */
1189 /* Number of pixels this string overwrites in front of its x-origin.
1190 This number is zero if the string has an lbearing >= 0; it is
1191 -lbearing, if the string has an lbearing < 0. */
1194 /* Number of pixels this string overwrites past its right-most
1195 nominal x-position, i.e. x + width. Zero if the string's
1196 rbearing is <= its nominal width, rbearing - width otherwise. */
1199 /* The frame on which the glyph string is drawn. */
1202 /* The window on which the glyph string is drawn. */
1205 /* X display and window for convenience. */
1209 /* The glyph row for which this string was built. It determines the
1210 y-origin and height of the string. */
1211 struct glyph_row
*row
;
1213 /* The area within row. */
1214 enum glyph_row_area area
;
1216 /* Characters to be drawn, and number of characters. */
1220 /* A face-override for drawing cursors, mouse face and similar. */
1221 enum draw_glyphs_face hl
;
1223 /* Face in which this string is to be drawn. */
1226 /* Font in which this string is to be drawn. */
1229 /* Non-null means this string describes (part of) a static
1231 struct composition
*cmp
;
1233 /* If not negative, this string describes a compos. */
1236 /* Start and end glyph indices in a glyph-string. */
1237 int cmp_from
, cmp_to
;
1239 /* 1 means this glyph strings face has to be drawn to the right end
1240 of the window's drawing area. */
1241 unsigned extends_to_end_of_line_p
: 1;
1243 /* 1 means the background of this string has been drawn. */
1244 unsigned background_filled_p
: 1;
1246 /* 1 means glyph string must be drawn with 16-bit functions. */
1247 unsigned two_byte_p
: 1;
1249 /* 1 means that the original font determined for drawing this glyph
1250 string could not be loaded. The member `font' has been set to
1251 the frame's default font in this case. */
1252 unsigned font_not_found_p
: 1;
1254 /* 1 means that the face in which this glyph string is drawn has a
1256 unsigned stippled_p
: 1;
1258 #define OVERLAPS_PRED (1 << 0)
1259 #define OVERLAPS_SUCC (1 << 1)
1260 #define OVERLAPS_BOTH (OVERLAPS_PRED | OVERLAPS_SUCC)
1261 #define OVERLAPS_ERASED_CURSOR (1 << 2)
1262 /* Non-zero means only the foreground of this glyph string must be
1263 drawn, and we should use the physical height of the line this
1264 glyph string appears in as clip rect. If the value is
1265 OVERLAPS_ERASED_CURSOR, the clip rect is restricted to the rect
1266 of the erased cursor. OVERLAPS_PRED and OVERLAPS_SUCC mean we
1267 draw overlaps with the preceding and the succeeding rows,
1269 unsigned for_overlaps
: 3;
1271 /* 1 means that all glyphs in this glyph string has the flag
1272 padding_p set, and thus must be drawn one by one to have 1-pixel
1273 width even though the logical width in the font is zero. */
1274 unsigned padding_p
: 1;
1276 /* The GC to use for drawing this glyph string. */
1277 #if defined (HAVE_X_WINDOWS)
1280 #if defined (HAVE_NTGUI)
1285 /* A pointer to the first glyph in the string. This glyph
1286 corresponds to char2b[0]. Needed to draw rectangles if
1287 font_not_found_p is 1. */
1288 struct glyph
*first_glyph
;
1290 /* Image, if any. */
1294 struct glyph_slice slice
;
1296 /* Non-null means the horizontal clipping region starts from the
1297 left edge of *clip_head, and ends with the right edge of
1298 *clip_tail, not including their overhangs. */
1299 struct glyph_string
*clip_head
, *clip_tail
;
1301 /* The current clipping areas. */
1302 NativeRectangle clip
[2];
1304 /* Number of clipping areas. */
1307 int underline_position
;
1309 int underline_thickness
;
1311 struct glyph_string
*next
, *prev
;
1314 #endif /* HAVE_WINDOW_SYSTEM */
1317 /************************************************************************
1319 ************************************************************************/
1321 /* Return the height of the mode line in glyph matrix MATRIX, or zero
1322 if not known. This macro is called under circumstances where
1323 MATRIX might not have been allocated yet. */
1325 #define MATRIX_MODE_LINE_HEIGHT(MATRIX) \
1326 ((MATRIX) && (MATRIX)->rows \
1327 ? MATRIX_MODE_LINE_ROW (MATRIX)->height \
1330 /* Return the height of the header line in glyph matrix MATRIX, or zero
1331 if not known. This macro is called under circumstances where
1332 MATRIX might not have been allocated yet. */
1334 #define MATRIX_HEADER_LINE_HEIGHT(MATRIX) \
1335 ((MATRIX) && (MATRIX)->rows \
1336 ? MATRIX_HEADER_LINE_ROW (MATRIX)->height \
1339 /* Return the desired face id for the mode line of a window, depending
1340 on whether the window is selected or not, or if the window is the
1341 scrolling window for the currently active minibuffer window.
1343 Due to the way display_mode_lines manipulates with the contents of
1344 selected_window, this macro needs three arguments: SELW which is
1345 compared against the current value of selected_window, MBW which is
1346 compared against minibuf_window (if SELW doesn't match), and SCRW
1347 which is compared against minibuf_selected_window (if MBW matches). */
1349 #define CURRENT_MODE_LINE_FACE_ID_3(SELW, MBW, SCRW) \
1350 ((!mode_line_in_non_selected_windows \
1351 || (SELW) == XWINDOW (selected_window) \
1352 || (minibuf_level > 0 \
1353 && !NILP (minibuf_selected_window) \
1354 && (MBW) == XWINDOW (minibuf_window) \
1355 && (SCRW) == XWINDOW (minibuf_selected_window))) \
1356 ? MODE_LINE_FACE_ID \
1357 : MODE_LINE_INACTIVE_FACE_ID)
1360 /* Return the desired face id for the mode line of window W. */
1362 #define CURRENT_MODE_LINE_FACE_ID(W) \
1363 (CURRENT_MODE_LINE_FACE_ID_3((W), XWINDOW (selected_window), (W)))
1365 /* Return the current height of the mode line of window W. If not
1366 known from current_mode_line_height, look at W's current glyph
1367 matrix, or return a default based on the height of the font of the
1368 face `mode-line'. */
1370 #define CURRENT_MODE_LINE_HEIGHT(W) \
1371 (current_mode_line_height >= 0 \
1372 ? current_mode_line_height \
1373 : (MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1374 ? MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1375 : estimate_mode_line_height (XFRAME ((W)->frame), \
1376 CURRENT_MODE_LINE_FACE_ID (W))))
1378 /* Return the current height of the header line of window W. If not
1379 known from current_header_line_height, look at W's current glyph
1380 matrix, or return an estimation based on the height of the font of
1381 the face `header-line'. */
1383 #define CURRENT_HEADER_LINE_HEIGHT(W) \
1384 (current_header_line_height >= 0 \
1385 ? current_header_line_height \
1386 : (MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1387 ? MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1388 : estimate_mode_line_height (XFRAME ((W)->frame), \
1389 HEADER_LINE_FACE_ID)))
1391 /* Return the height of the desired mode line of window W. */
1393 #define DESIRED_MODE_LINE_HEIGHT(W) \
1394 MATRIX_MODE_LINE_HEIGHT ((W)->desired_matrix)
1396 /* Return the height of the desired header line of window W. */
1398 #define DESIRED_HEADER_LINE_HEIGHT(W) \
1399 MATRIX_HEADER_LINE_HEIGHT ((W)->desired_matrix)
1401 /* Value is non-zero if window W wants a mode line. */
1403 #define WINDOW_WANTS_MODELINE_P(W) \
1404 (!MINI_WINDOW_P ((W)) \
1405 && !(W)->pseudo_window_p \
1406 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1407 && BUFFERP ((W)->buffer) \
1408 && !NILP (BVAR (XBUFFER ((W)->buffer), mode_line_format)) \
1409 && WINDOW_TOTAL_LINES (W) > 1)
1411 /* Value is non-zero if window W wants a header line. */
1413 #define WINDOW_WANTS_HEADER_LINE_P(W) \
1414 (!MINI_WINDOW_P ((W)) \
1415 && !(W)->pseudo_window_p \
1416 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1417 && BUFFERP ((W)->buffer) \
1418 && !NILP (BVAR (XBUFFER ((W)->buffer), header_line_format)) \
1419 && WINDOW_TOTAL_LINES (W) > 1 + !NILP (BVAR (XBUFFER ((W)->buffer), mode_line_format)))
1422 /* Return proper value to be used as baseline offset of font that has
1423 ASCENT and DESCENT to draw characters by the font at the vertical
1424 center of the line of frame F.
1426 Here, our task is to find the value of BOFF in the following figure;
1428 -------------------------+-----------+-
1429 -+-+---------+-+ | |
1431 | | | | F_ASCENT F_HEIGHT
1434 | | |-|-+------+-----------|------- baseline
1436 | |---------|-+-+ | |
1438 -+-+---------+-+ F_DESCENT |
1439 -------------------------+-----------+-
1441 -BOFF + DESCENT + (F_HEIGHT - HEIGHT) / 2 = F_DESCENT
1442 BOFF = DESCENT + (F_HEIGHT - HEIGHT) / 2 - F_DESCENT
1443 DESCENT = FONT->descent
1444 HEIGHT = FONT_HEIGHT (FONT)
1445 F_DESCENT = (FRAME_FONT (F)->descent
1446 - F->terminal->output_data.x->baseline_offset)
1447 F_HEIGHT = FRAME_LINE_HEIGHT (F)
1450 #define VCENTER_BASELINE_OFFSET(FONT, F) \
1451 (FONT_DESCENT (FONT) \
1452 + (FRAME_LINE_HEIGHT ((F)) - FONT_HEIGHT ((FONT)) \
1453 + (FRAME_LINE_HEIGHT ((F)) > FONT_HEIGHT ((FONT)))) / 2 \
1454 - (FONT_DESCENT (FRAME_FONT (F)) - FRAME_BASELINE_OFFSET (F)))
1457 /***********************************************************************
1459 ***********************************************************************/
1461 /* Indices of face attributes in Lisp face vectors. Slot zero is the
1464 enum lface_attribute_index
1466 LFACE_FAMILY_INDEX
= 1,
1467 LFACE_FOUNDRY_INDEX
,
1472 LFACE_UNDERLINE_INDEX
,
1473 LFACE_INVERSE_INDEX
,
1474 LFACE_FOREGROUND_INDEX
,
1475 LFACE_BACKGROUND_INDEX
,
1476 LFACE_STIPPLE_INDEX
,
1477 LFACE_OVERLINE_INDEX
,
1478 LFACE_STRIKE_THROUGH_INDEX
,
1481 LFACE_INHERIT_INDEX
,
1482 LFACE_FONTSET_INDEX
,
1487 /* Box types of faces. */
1491 /* No box around text. */
1494 /* Simple box of specified width and color. Default width is 1, and
1495 default color is the foreground color of the face. */
1498 /* Boxes with 3D shadows. Color equals the background color of the
1499 face. Width is specified. */
1504 /* Underline type. */
1506 enum face_underline_type
1512 /* Structure describing a realized face.
1514 For each Lisp face, 0..N realized faces can exist for different
1515 frames and different charsets. Realized faces are built from Lisp
1516 faces and text properties/overlays by merging faces and adding
1517 unspecified attributes from the `default' face. */
1521 /* The id of this face. The id equals the index of this face in the
1522 vector faces_by_id of its face cache. */
1525 #ifdef HAVE_WINDOW_SYSTEM
1527 /* If non-zero, this is a GC that we can use without modification for
1528 drawing the characters in this face. */
1531 /* Background stipple or bitmap used for this face. This is
1532 an id as returned from load_pixmap. */
1535 #else /* not HAVE_WINDOW_SYSTEM */
1540 #endif /* not HAVE_WINDOW_SYSTEM */
1542 /* Pixel value of foreground color for X frames. Color index
1544 unsigned long foreground
;
1546 /* Pixel value or color index of background color. */
1547 unsigned long background
;
1549 /* Pixel value or color index of underline color. */
1550 unsigned long underline_color
;
1552 /* Pixel value or color index of overlined, strike-through, or box
1554 unsigned long overline_color
;
1555 unsigned long strike_through_color
;
1556 unsigned long box_color
;
1560 /* Fontset ID if for this face's fontset. Non-ASCII faces derived
1561 from the same ASCII face have the same fontset. */
1564 /* Pixmap width and height. */
1565 unsigned int pixmap_w
, pixmap_h
;
1567 /* Non-zero means characters in this face have a box that thickness
1568 around them. If it is negative, the absolute value indicates the
1569 thickness, and the horizontal lines of box (top and bottom) are
1570 drawn inside of characters glyph area. The vertical lines of box
1571 (left and right) are drawn as the same way as the case that this
1572 value is positive. */
1575 /* Type of box drawn. A value of FACE_NO_BOX means no box is drawn
1576 around text in this face. A value of FACE_SIMPLE_BOX means a box
1577 of width box_line_width is drawn in color box_color. A value of
1578 FACE_RAISED_BOX or FACE_SUNKEN_BOX means a 3D box is drawn with
1579 shadow colors derived from the background color of the face. */
1580 enum face_box_type box
;
1582 /* If `box' above specifies a 3D type, 1 means use box_color for
1584 unsigned use_box_color_for_shadows_p
: 1;
1586 /* Style of underlining. */
1587 enum face_underline_type underline_type
;
1589 /* Non-zero if text in this face should be underlined, overlined,
1590 strike-through or have a box drawn around it. */
1591 unsigned underline_p
: 1;
1592 unsigned overline_p
: 1;
1593 unsigned strike_through_p
: 1;
1595 /* 1 means that the colors specified for this face could not be
1596 loaded, and were replaced by default colors, so they shouldn't be
1598 unsigned foreground_defaulted_p
: 1;
1599 unsigned background_defaulted_p
: 1;
1601 /* 1 means that either no color is specified for underlining or that
1602 the specified color couldn't be loaded. Use the foreground
1603 color when drawing in that case. */
1604 unsigned underline_defaulted_p
: 1;
1606 /* 1 means that either no color is specified for the corresponding
1607 attribute or that the specified color couldn't be loaded.
1608 Use the foreground color when drawing in that case. */
1609 unsigned overline_color_defaulted_p
: 1;
1610 unsigned strike_through_color_defaulted_p
: 1;
1611 unsigned box_color_defaulted_p
: 1;
1613 /* TTY appearances. Colors are found in `lface' with empty color
1614 string meaning the default color of the TTY. */
1615 unsigned tty_bold_p
: 1;
1616 unsigned tty_italic_p
: 1;
1617 unsigned tty_underline_p
: 1;
1618 unsigned tty_reverse_p
: 1;
1620 /* 1 means that colors of this face may not be freed because they
1621 have been copied bitwise from a base face (see
1623 unsigned colors_copied_bitwise_p
: 1;
1625 /* If non-zero, use overstrike (to simulate bold-face). */
1626 unsigned overstrike
: 1;
1628 /* NOTE: this is not used yet, but eventually this impl should be done
1629 similarly to overstrike */
1631 /* If non-zero, use geometric rotation (to simulate italic). */
1632 unsigned synth_ital
: 1;
1635 /* The Lisp face attributes this face realizes. All attributes
1636 in this vector are non-nil. */
1637 Lisp_Object lface
[LFACE_VECTOR_SIZE
];
1639 /* The hash value of this face. */
1642 /* Next and previous face in hash collision list of face cache. */
1643 struct face
*next
, *prev
;
1645 /* If this face is an ASCII face, this points to this face itself.
1646 Otherwise, this points to an ASCII face that has the same
1647 attributes except the font. */
1648 struct face
*ascii_face
;
1650 /* Extra member that a font-driver uses privately. */
1655 /* Color index indicating that face uses a terminal's default color. */
1657 #define FACE_TTY_DEFAULT_COLOR ((unsigned long) -1)
1659 /* Color index indicating that face uses an unknown foreground color. */
1661 #define FACE_TTY_DEFAULT_FG_COLOR ((unsigned long) -2)
1663 /* Color index indicating that face uses an unknown background color. */
1665 #define FACE_TTY_DEFAULT_BG_COLOR ((unsigned long) -3)
1667 /* Non-zero if FACE was realized for unibyte use. */
1669 #define FACE_UNIBYTE_P(FACE) ((FACE)->charset < 0)
1672 /* IDs of important faces known by the C face code. These are the IDs
1673 of the faces for CHARSET_ASCII. */
1679 MODE_LINE_INACTIVE_FACE_ID
,
1682 HEADER_LINE_FACE_ID
,
1688 VERTICAL_BORDER_FACE_ID
,
1689 BASIC_FACE_ID_SENTINEL
1692 #define MAX_FACE_ID ((1 << FACE_ID_BITS) - 1)
1694 /* A cache of realized faces. Each frame has its own cache because
1695 Emacs allows different frame-local face definitions. */
1699 /* Hash table of cached realized faces. */
1700 struct face
**buckets
;
1702 /* Back-pointer to the frame this cache belongs to. */
1705 /* A vector of faces so that faces can be referenced by an ID. */
1706 struct face
**faces_by_id
;
1708 /* The allocated size, and number of used slots of faces_by_id. */
1712 /* Flag indicating that attributes of the `menu' face have been
1714 unsigned menu_face_changed_p
: 1;
1718 /* Prepare face FACE for use on frame F. This must be called before
1719 using X resources of FACE. */
1721 #define PREPARE_FACE_FOR_DISPLAY(F, FACE) \
1722 if ((FACE)->gc == 0) \
1723 prepare_face_for_display ((F), (FACE)); \
1727 /* Return a pointer to the face with ID on frame F, or null if such a
1728 face doesn't exist. */
1730 #define FACE_FROM_ID(F, ID) \
1731 (UNSIGNED_CMP (ID, <, FRAME_FACE_CACHE (F)->used) \
1732 ? FRAME_FACE_CACHE (F)->faces_by_id[ID] \
1735 #ifdef HAVE_WINDOW_SYSTEM
1737 /* Non-zero if FACE is suitable for displaying character CHAR. */
1739 #define FACE_SUITABLE_FOR_ASCII_CHAR_P(FACE, CHAR) \
1740 ((FACE) == (FACE)->ascii_face)
1742 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) \
1743 (ASCII_CHAR_P (CHAR) \
1744 ? FACE_SUITABLE_FOR_ASCII_CHAR_P(FACE) \
1745 : face_suitable_for_char_p ((FACE), (CHAR)))
1747 /* Return the id of the realized face on frame F that is like the face
1748 with id ID but is suitable for displaying character CHAR.
1749 This macro is only meaningful for multibyte character CHAR. */
1751 #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) \
1752 ((ASCII_CHAR_P (CHAR) || CHAR_BYTE8_P (CHAR)) \
1753 ? (FACE)->ascii_face->id \
1754 : face_for_char ((F), (FACE), (CHAR), (POS), (OBJECT)))
1756 #else /* not HAVE_WINDOW_SYSTEM */
1758 #define FACE_SUITABLE_FOR_ASCII_CHAR_P(FACE, CHAR) 1
1759 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) 1
1760 #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) ((FACE)->id)
1762 #endif /* not HAVE_WINDOW_SYSTEM */
1764 /* Non-zero means face attributes have been changed since the last
1765 redisplay. Used in redisplay_internal. */
1767 extern int face_change_count
;
1769 /* For reordering of bidirectional text. */
1770 #define BIDI_MAXLEVEL 64
1772 /* Data type for describing the bidirectional character types. The
1773 first 7 must be at the beginning, because they are the only values
1774 valid in the `bidi_type' member of `struct glyph'; we only reserve
1775 3 bits for it, so we cannot use there values larger than 7.
1777 The order of members must be in sync with the 8th element of the
1778 member of unidata-prop-alist (in admin/unidata/unidata-gen.el) for
1779 Unicode character property `bidi-class'. */
1782 STRONG_L
, /* strong left-to-right */
1783 STRONG_R
, /* strong right-to-left */
1784 WEAK_EN
, /* european number */
1785 WEAK_AN
, /* arabic number */
1786 WEAK_BN
, /* boundary neutral */
1787 NEUTRAL_B
, /* paragraph separator */
1788 STRONG_AL
, /* arabic right-to-left letter */
1789 LRE
, /* left-to-right embedding */
1790 LRO
, /* left-to-right override */
1791 RLE
, /* right-to-left embedding */
1792 RLO
, /* right-to-left override */
1793 PDF
, /* pop directional format */
1794 WEAK_ES
, /* european number separator */
1795 WEAK_ET
, /* european number terminator */
1796 WEAK_CS
, /* common separator */
1797 WEAK_NSM
, /* non-spacing mark */
1798 NEUTRAL_S
, /* segment separator */
1799 NEUTRAL_WS
, /* whitespace */
1800 NEUTRAL_ON
/* other neutrals */
1803 /* The basic directionality data type. */
1804 typedef enum { NEUTRAL_DIR
, L2R
, R2L
} bidi_dir_t
;
1806 /* Data type for storing information about characters we need to
1808 struct bidi_saved_info
{
1809 ptrdiff_t bytepos
, charpos
; /* character's buffer position */
1810 bidi_type_t type
; /* character's resolved bidi type */
1811 bidi_type_t type_after_w1
; /* original type of the character, after W1 */
1812 bidi_type_t orig_type
; /* type as we found it in the buffer */
1815 /* Data type for keeping track of saved embedding levels and override
1816 status information. */
1819 bidi_dir_t override
;
1822 /* Data type for storing information about a string being iterated on. */
1823 struct bidi_string_data
{
1824 Lisp_Object lstring
; /* Lisp string to reorder, or nil */
1825 const unsigned char *s
; /* string data, or NULL if reordering buffer */
1826 ptrdiff_t schars
; /* the number of characters in the string,
1827 excluding the terminating null */
1828 ptrdiff_t bufpos
; /* buffer position of lstring, or 0 if N/A */
1829 unsigned from_disp_str
: 1; /* 1 means the string comes from a
1831 unsigned unibyte
: 1; /* 1 means the string is unibyte */
1834 /* Data type for reordering bidirectional text. */
1836 ptrdiff_t bytepos
; /* iterator's position in buffer/string */
1838 int ch
; /* character at that position, or u+FFFC
1839 ("object replacement character") for a run
1840 of characters covered by a display string */
1841 ptrdiff_t nchars
; /* its "length", usually 1; it's > 1 for a run
1842 of characters covered by a display string */
1843 ptrdiff_t ch_len
; /* its length in bytes */
1844 bidi_type_t type
; /* bidi type of this character, after
1845 resolving weak and neutral types */
1846 bidi_type_t type_after_w1
; /* original type, after overrides and W1 */
1847 bidi_type_t orig_type
; /* original type, as found in the buffer */
1848 int resolved_level
; /* final resolved level of this character */
1849 int invalid_levels
; /* how many PDFs to ignore */
1850 int invalid_rl_levels
; /* how many PDFs from RLE/RLO to ignore */
1851 int prev_was_pdf
; /* if non-zero, previous char was PDF */
1852 struct bidi_saved_info prev
; /* info about previous character */
1853 struct bidi_saved_info last_strong
; /* last-seen strong directional char */
1854 struct bidi_saved_info next_for_neutral
; /* surrounding characters for... */
1855 struct bidi_saved_info prev_for_neutral
; /* ...resolving neutrals */
1856 struct bidi_saved_info next_for_ws
; /* character after sequence of ws */
1857 ptrdiff_t next_en_pos
; /* pos. of next char for determining ET type */
1858 bidi_type_t next_en_type
; /* type of char at next_en_pos */
1859 ptrdiff_t ignore_bn_limit
; /* position until which to ignore BNs */
1860 bidi_dir_t sor
; /* direction of start-of-run in effect */
1861 int scan_dir
; /* direction of text scan, 1: forw, -1: back */
1862 ptrdiff_t disp_pos
; /* position of display string after ch */
1863 int disp_prop
; /* if non-zero, there really is a
1864 `display' property/string at disp_pos;
1865 if 2, the property is a `space' spec */
1866 int stack_idx
; /* index of current data on the stack */
1867 /* Note: Everything from here on is not copied/saved when the bidi
1868 iterator state is saved, pushed, or popped. So only put here
1869 stuff that is not part of the bidi iterator's state! */
1870 struct bidi_stack level_stack
[BIDI_MAXLEVEL
]; /* stack of embedding levels */
1871 struct bidi_string_data string
; /* string to reorder */
1872 bidi_dir_t paragraph_dir
; /* current paragraph direction */
1873 ptrdiff_t separator_limit
; /* where paragraph separator should end */
1874 unsigned first_elt
: 1; /* if non-zero, examine current char first */
1875 unsigned new_paragraph
: 1; /* if non-zero, we expect a new paragraph */
1876 unsigned frame_window_p
: 1; /* non-zero if displaying on a GUI frame */
1879 /* Value is non-zero when the bidi iterator is at base paragraph
1881 #define BIDI_AT_BASE_LEVEL(BIDI_IT) \
1882 ((BIDI_IT).resolved_level == (BIDI_IT).level_stack[0].level)
1885 /***********************************************************************
1887 ***********************************************************************/
1889 /* Structure used to describe where and how to draw a fringe bitmap.
1890 WHICH is the fringe bitmap to draw. WD and H is the (adjusted)
1891 width and height of the bitmap, DH is the height adjustment (if
1892 bitmap is periodic). X and Y are frame coordinates of the area to
1893 display the bitmap, DY is relative offset of the bitmap into that
1894 area. BX, NX, BY, NY specifies the area to clear if the bitmap
1895 does not fill the entire area. FACE is the fringe face. */
1897 struct draw_fringe_bitmap_params
1899 int which
; /* enum fringe_bitmap_type */
1900 unsigned short *bits
;
1904 unsigned cursor_p
: 1;
1905 unsigned overlay_p
: 1;
1909 #define MAX_FRINGE_BITMAPS (1<<FRINGE_ID_BITS)
1912 /***********************************************************************
1914 ***********************************************************************/
1916 /* Iteration over things to display in current_buffer or in a string.
1918 The iterator handles:
1920 1. Overlay strings (after-string, before-string).
1922 3. Invisible text properties.
1923 4. Selective display.
1924 5. Translation of characters via display tables.
1925 6. Translation of control characters to the forms `\003' or `^C'.
1926 7. `glyph' and `space-width' properties.
1928 Iterators are initialized by calling init_iterator or one of the
1929 equivalent functions below. A call to get_next_display_element
1930 loads the iterator structure with information about what next to
1931 display. A call to set_iterator_to_next increments the iterator's
1934 Characters from overlay strings, display table entries or control
1935 character translations are returned one at a time. For example, if
1936 we have a text of `a\x01' where `a' has a display table definition
1937 of `cd' and the control character is displayed with a leading
1938 arrow, then the iterator will return:
1940 Call Return Source Call next
1941 -----------------------------------------------------------------
1942 next c display table move
1943 next d display table move
1944 next ^ control char move
1945 next A control char move
1947 The same mechanism is also used to return characters for ellipses
1948 displayed at the end of invisible text.
1950 CAVEAT: Under some circumstances, move_.* functions can be called
1951 asynchronously, e.g. when computing a buffer position from an x and
1952 y pixel position. This means that these functions and functions
1953 called from them SHOULD NOT USE xmalloc and alike. See also the
1954 comment at the start of xdisp.c. */
1956 /* Enumeration describing what kind of display element an iterator is
1957 loaded with after a call to get_next_display_element. */
1959 enum display_element_type
1961 /* A normal character. */
1964 /* A composition (static and automatic). */
1967 /* A glyphless character (e.g. ZWNJ, LRE). */
1973 /* A flexible width and height space. */
1976 /* End of buffer or string. */
1979 /* Truncation glyphs. Never returned by get_next_display_element.
1980 Used to get display information about truncation glyphs via
1984 /* Continuation glyphs. See the comment for IT_TRUNCATION. */
1989 /* An enumerator for each text property that has a meaning for display
1998 COMPOSITION_PROP_IDX
,
2000 /* Not a property. Used to indicate changes in overlays. */
2007 /* An enumerator for the method of wrapping long lines. */
2009 enum line_wrap_method
2016 /* An enumerator for the method of displaying glyphless characters. */
2018 enum glyphless_display_method
2020 /* Display a thin (1-pixel width) space. On a TTY, display a
2021 1-character width space. */
2022 GLYPHLESS_DISPLAY_THIN_SPACE
,
2023 /* Display an empty box of proper width. */
2024 GLYPHLESS_DISPLAY_EMPTY_BOX
,
2025 /* Display an acronym string in a box. */
2026 GLYPHLESS_DISPLAY_ACRONYM
,
2027 /* Display the hexadecimal code of the character in a box. */
2028 GLYPHLESS_DISPLAY_HEX_CODE
2039 /* Input sources for fetching characters or data to display.
2040 The input source is found in the `method' field. */
2043 GET_FROM_BUFFER
= 0,
2044 GET_FROM_DISPLAY_VECTOR
,
2052 /* FIXME: What is this? Why 5? */
2053 #define IT_STACK_SIZE 5
2055 /* Iterator for composition (both for static and automatic). */
2056 struct composition_it
2058 /* Next position at which to check the composition. */
2060 /* ID number of the composition or glyph-string. If negative, we
2061 are not iterating over a composition now. */
2063 /* If non-negative, character that triggers the automatic
2064 composition at `stop_pos', and this is an automatic composition.
2065 If negative, this is a static composition. This is set to -2
2066 temporarily if searching of composition reach a limit or a
2069 /* If this is an automatic composition, index of a rule for making
2070 the automatic composition. Provided that ELT is an element of
2071 Vcomposition_function_table for CH, (nth ELT RULE_IDX) is the
2072 rule for the composition. */
2074 /* If this is an automatic composition, how many characters to look
2075 back from the position where a character triggering the
2076 composition exists. */
2078 /* If non-negative, number of glyphs of the glyph-string. */
2080 /* Nonzero iff the composition is created while buffer is scanned in
2081 reverse order, and thus the grapheme clusters must be rendered
2082 from the last to the first. */
2085 /** The following members contain information about the current
2086 grapheme cluster. */
2087 /* Position of the first character of the current grapheme cluster. */
2089 /* Number of characters and bytes of the current grapheme cluster. */
2091 /* Indices of the glyphs for the current grapheme cluster. */
2093 /* Width of the current grapheme cluster in units of pixels on a
2094 graphic display and in units of canonical characters on a
2095 terminal display. */
2101 /* The window in which we iterate over current_buffer (or a string). */
2105 /* The window's frame. */
2108 /* Method to use to load this structure with the next display element. */
2109 enum it_method method
;
2111 /* The next position at which to check for face changes, invisible
2112 text, overlay strings, end of text etc., which see. */
2113 ptrdiff_t stop_charpos
;
2115 /* Previous stop position, i.e. the last one before the current
2116 iterator position in `current'. */
2117 ptrdiff_t prev_stop
;
2119 /* Last stop position iterated across whose bidi embedding level is
2120 equal to the current paragraph's base embedding level. */
2121 ptrdiff_t base_level_stop
;
2123 /* Maximum string or buffer position + 1. ZV when iterating over
2125 ptrdiff_t end_charpos
;
2127 /* C string to iterate over. Non-null means get characters from
2128 this string, otherwise characters are read from current_buffer
2130 const unsigned char *s
;
2132 /* Number of characters in the string (s, or it->string) we iterate
2134 ptrdiff_t string_nchars
;
2136 /* Start and end of a visible region; -1 if the region is not
2137 visible in the window. */
2138 ptrdiff_t region_beg_charpos
, region_end_charpos
;
2140 /* Position at which redisplay end trigger functions should be run. */
2141 ptrdiff_t redisplay_end_trigger_charpos
;
2143 /* 1 means multibyte characters are enabled. */
2144 unsigned multibyte_p
: 1;
2146 /* 1 means window has a mode line at its top. */
2147 unsigned header_line_p
: 1;
2149 /* 1 means `string' is the value of a `display' property.
2150 Don't handle some `display' properties in these strings. */
2151 unsigned string_from_display_prop_p
: 1;
2153 /* 1 means `string' comes from a `line-prefix' or `wrap-prefix'
2155 unsigned string_from_prefix_prop_p
: 1;
2157 /* 1 means we are iterating an object that came from a value of a
2158 `display' property. */
2159 unsigned from_disp_prop_p
: 1;
2161 /* When METHOD == next_element_from_display_vector,
2162 this is 1 if we're doing an ellipsis. Otherwise meaningless. */
2163 unsigned ellipsis_p
: 1;
2165 /* True means cursor shouldn't be displayed here. */
2166 unsigned avoid_cursor_p
: 1;
2168 /* Display table in effect or null for none. */
2169 struct Lisp_Char_Table
*dp
;
2171 /* Current display table vector to return characters from and its
2172 end. dpvec null means we are not returning characters from a
2173 display table entry; current.dpvec_index gives the current index
2174 into dpvec. This same mechanism is also used to return
2175 characters from translated control characters, i.e. `\003' or
2177 Lisp_Object
*dpvec
, *dpend
;
2179 /* Length in bytes of the char that filled dpvec. A value of zero
2180 means that no such character is involved. A negative value means
2181 the rest of the line from the current iterator position onwards
2182 is hidden by selective display or ellipsis. */
2185 /* Face id to use for all characters in display vector. -1 if unused. */
2188 /* Face id of the iterator saved in case a glyph from dpvec contains
2189 a face. The face is restored when all glyphs from dpvec have
2193 /* Vector of glyphs for control character translation. The pointer
2194 dpvec is set to ctl_chars when a control character is translated.
2195 This vector is also used for incomplete multibyte character
2196 translation (e.g \222\244). Such a character is at most 4 bytes,
2197 thus we need at most 16 bytes here. */
2198 Lisp_Object ctl_chars
[16];
2200 /* Initial buffer or string position of the iterator, before skipping
2201 over display properties and invisible text. */
2202 struct display_pos start
;
2204 /* Current buffer or string position of the iterator, including
2205 position in overlay strings etc. */
2206 struct display_pos current
;
2208 /* Total number of overlay strings to process. This can be >
2209 OVERLAY_STRING_CHUNK_SIZE. Value is dependable only when
2210 current.overlay_string_index >= 0. Use the latter to determine
2211 whether an overlay string is being iterated over, because
2212 n_overlay_strings can be positive even when we are not rendering
2213 an overlay string. */
2214 ptrdiff_t n_overlay_strings
;
2216 /* The charpos where n_overlay_strings was calculated. This should
2217 be set at the same time as n_overlay_strings. It is needed
2218 because we show before-strings at the start of invisible text;
2219 see handle_invisible_prop in xdisp.c. */
2220 ptrdiff_t overlay_strings_charpos
;
2222 /* Vector of overlays to process. Overlay strings are processed
2223 OVERLAY_STRING_CHUNK_SIZE at a time. */
2224 #define OVERLAY_STRING_CHUNK_SIZE 16
2225 Lisp_Object overlay_strings
[OVERLAY_STRING_CHUNK_SIZE
];
2227 /* For each overlay string, the overlay it came from. */
2228 Lisp_Object string_overlays
[OVERLAY_STRING_CHUNK_SIZE
];
2230 /* If non-nil, a Lisp string being processed. If
2231 current.overlay_string_index >= 0, this is an overlay string from
2232 pos. Use STRINGP (it.string) to test whether we are rendering a
2233 string or something else; do NOT use BUFFERP (it.object). */
2236 /* If non-nil, we are processing a string that came
2237 from a `display' property given by an overlay. */
2238 Lisp_Object from_overlay
;
2240 /* Stack of saved values. New entries are pushed when we begin to
2241 process an overlay string or a string from a `glyph' property.
2242 Entries are popped when we return to deliver display elements
2243 from what we previously had. */
2244 struct iterator_stack_entry
2248 ptrdiff_t end_charpos
;
2249 ptrdiff_t stop_charpos
;
2250 ptrdiff_t prev_stop
;
2251 ptrdiff_t base_level_stop
;
2252 struct composition_it cmp_it
;
2255 /* Save values specific to a given method. */
2257 /* method == GET_FROM_IMAGE */
2260 struct it_slice slice
;
2263 /* method == GET_FROM_COMPOSITION */
2267 /* method == GET_FROM_STRETCH */
2273 /* current text and display positions. */
2274 struct text_pos position
;
2275 struct display_pos current
;
2276 Lisp_Object from_overlay
;
2277 enum glyph_row_area area
;
2278 enum it_method method
;
2279 bidi_dir_t paragraph_embedding
;
2280 unsigned multibyte_p
: 1;
2281 unsigned string_from_display_prop_p
: 1;
2282 unsigned string_from_prefix_prop_p
: 1;
2283 unsigned display_ellipsis_p
: 1;
2284 unsigned avoid_cursor_p
: 1;
2286 unsigned from_disp_prop_p
: 1;
2287 enum line_wrap_method line_wrap
;
2289 /* properties from display property that are reset by another display property. */
2291 Lisp_Object space_width
;
2292 Lisp_Object font_height
;
2294 stack
[IT_STACK_SIZE
];
2296 /* Stack pointer. */
2299 /* -1 means selective display hides everything between a \r and the
2300 next newline; > 0 means hide lines indented more than that value. */
2301 ptrdiff_t selective
;
2303 /* An enumeration describing what the next display element is
2304 after a call to get_next_display_element. */
2305 enum display_element_type what
;
2310 /* Setting of buffer-local variable selective-display-ellipsis. */
2311 unsigned selective_display_ellipsis_p
: 1;
2313 /* 1 means control characters are translated into the form `^C'
2314 where the `^' can be replaced by a display table entry. */
2315 unsigned ctl_arrow_p
: 1;
2317 /* Non-zero means that the current face has a box. */
2318 unsigned face_box_p
: 1;
2320 /* Non-null means that the current character is the first in a run
2321 of characters with box face. */
2322 unsigned start_of_box_run_p
: 1;
2324 /* Non-zero means that the current character is the last in a run
2325 of characters with box face. */
2326 unsigned end_of_box_run_p
: 1;
2328 /* 1 means overlay strings at end_charpos have been processed. */
2329 unsigned overlay_strings_at_end_processed_p
: 1;
2331 /* 1 means to ignore overlay strings at current pos, as they have
2332 already been processed. */
2333 unsigned ignore_overlay_strings_at_pos_p
: 1;
2335 /* 1 means the actual glyph is not available in the current
2337 unsigned glyph_not_available_p
: 1;
2339 /* 1 means the next line in display_line continues a character
2340 consisting of more than one glyph, and some glyphs of this
2341 character have been put on the previous line. */
2342 unsigned starts_in_middle_of_char_p
: 1;
2344 /* If 1, saved_face_id contains the id of the face in front of text
2345 skipped due to selective display. */
2346 unsigned face_before_selective_p
: 1;
2348 /* If 1, adjust current glyph so it does not increase current row
2349 descent/ascent (line-height property). Reset after this glyph. */
2350 unsigned constrain_row_ascent_descent_p
: 1;
2352 enum line_wrap_method line_wrap
;
2354 /* The ID of the default face to use. One of DEFAULT_FACE_ID,
2355 MODE_LINE_FACE_ID, etc, depending on what we are displaying. */
2358 /* If `what' == IT_CHARACTER, the character and the length in bytes
2359 of its multibyte sequence. The character comes from a buffer or
2360 a string. It may be different from the character displayed in
2361 case that unibyte_display_via_language_environment is set.
2363 If `what' == IT_COMPOSITION, the first component of a composition
2364 and length in bytes of the composition.
2366 If `what' is anything else, these two are undefined (will
2367 probably hold values for the last IT_CHARACTER or IT_COMPOSITION
2368 traversed by the iterator.
2370 The values are updated by get_next_display_element, so they are
2371 out of sync with the value returned by IT_CHARPOS between the
2372 time set_iterator_to_next advances the position and the time
2373 get_next_display_element loads the new values into c and len. */
2376 /* If what == IT_COMPOSITION, iterator substructure for the
2378 struct composition_it cmp_it
;
2380 /* The character to display, possibly translated to multibyte if
2381 multibyte_p is zero or unibyte_display_via_language_environment
2382 is set. This is set after get_next_display_element has been
2383 called. If we are setting it->C directly before calling
2384 PRODUCE_GLYPHS, this should be set beforehand too. */
2385 int char_to_display
;
2387 /* If what == IT_GLYPHLESS, the method to display such a
2389 enum glyphless_display_method glyphless_method
;
2391 /* If what == IT_IMAGE, the id of the image to display. */
2394 /* Values from `slice' property. */
2395 struct it_slice slice
;
2397 /* Value of the `space-width' property, if any; nil if none. */
2398 Lisp_Object space_width
;
2400 /* Computed from the value of the `raise' property. */
2403 /* Number of columns per \t. */
2406 /* Value of the `height' property, if any; nil if none. */
2407 Lisp_Object font_height
;
2409 /* Object and position where the current display element came from.
2410 Object is normally the buffer which is being rendered, but it can
2411 also be a Lisp string in case the current display element comes
2412 from an overlay string or from a display string (before- or
2413 after-string). It may also be nil when a C string is being
2414 rendered, e.g., during mode-line or header-line update. It can
2415 also be a cons cell of the form `(space ...)', when we produce a
2416 stretch glyph from a `display' specification. Finally, it can be
2417 a zero-valued Lisp integer, but only temporarily, when we are
2418 producing special glyphs for display purposes, like truncation
2419 and continuation glyphs, or blanks that extend each line to the
2420 edge of the window on a TTY.
2422 Do NOT use !BUFFERP (it.object) as a test whether we are
2423 iterating over a string; use STRINGP (it.string) instead.
2425 Position is the current iterator position in object. */
2427 struct text_pos position
;
2429 /* Width in pixels of truncation and continuation glyphs. */
2430 short truncation_pixel_width
, continuation_pixel_width
;
2432 /* First and last visible x-position in the display area. If window
2433 is hscrolled by n columns, first_visible_x == n * FRAME_COLUMN_WIDTH
2434 (f), and last_visible_x == pixel width of W + first_visible_x. */
2435 int first_visible_x
, last_visible_x
;
2437 /* Last visible y-position + 1 in the display area without a mode
2438 line, if the window has one. */
2441 /* Default amount of additional space in pixels between lines (for
2442 window systems only.) */
2443 int extra_line_spacing
;
2445 /* Max extra line spacing added in this row. */
2446 int max_extra_line_spacing
;
2448 /* Override font height information for this glyph.
2449 Used if override_ascent >= 0. Cleared after this glyph. */
2450 int override_ascent
, override_descent
, override_boff
;
2452 /* If non-null, glyphs are produced in glyph_row with each call to
2454 struct glyph_row
*glyph_row
;
2456 /* The area of glyph_row to which glyphs are added. */
2457 enum glyph_row_area area
;
2459 /* Number of glyphs needed for the last character requested via
2460 produce_glyphs. This is 1 except for tabs. */
2463 /* Width of the display element in pixels. Result of
2467 /* Current, maximum logical, and maximum physical line height
2468 information. Result of produce_glyphs. */
2469 int ascent
, descent
, max_ascent
, max_descent
;
2470 int phys_ascent
, phys_descent
, max_phys_ascent
, max_phys_descent
;
2472 /* Current x pixel position within the display line. This value
2473 does not include the width of continuation lines in front of the
2474 line. The value of current_x is automatically incremented by
2475 pixel_width with each call to produce_glyphs. */
2478 /* Accumulated width of continuation lines. If > 0, this means we
2479 are currently in a continuation line. This is initially zero and
2480 incremented/reset by display_line, move_it_to etc. */
2481 int continuation_lines_width
;
2483 /* Buffer position that ends the buffer text line being iterated.
2484 This is normally the position after the newline at EOL. If this
2485 is the last line of the buffer and it doesn't have a newline,
2486 value is ZV/ZV_BYTE. Set and used only if IT->bidi_p, for
2487 setting the end position of glyph rows produced for continuation
2488 lines, see display_line. */
2489 struct text_pos eol_pos
;
2491 /* Current y-position. Automatically incremented by the height of
2492 glyph_row in move_it_to and display_line. */
2495 /* Vertical matrix position of first text line in window. */
2498 /* Current vertical matrix position, or line number. Automatically
2499 incremented by move_it_to and display_line. */
2502 /* Horizontal matrix position reached in move_it_in_display_line.
2503 Only set there, not in display_line. */
2506 /* Left fringe bitmap number (enum fringe_bitmap_type). */
2507 unsigned left_user_fringe_bitmap
: FRINGE_ID_BITS
;
2509 /* Right fringe bitmap number (enum fringe_bitmap_type). */
2510 unsigned right_user_fringe_bitmap
: FRINGE_ID_BITS
;
2512 /* Face of the left fringe glyph. */
2513 unsigned left_user_fringe_face_id
: FACE_ID_BITS
;
2515 /* Face of the right fringe glyph. */
2516 unsigned right_user_fringe_face_id
: FACE_ID_BITS
;
2518 /* Non-zero means we need to reorder bidirectional text for display
2519 in the visual order. */
2520 unsigned bidi_p
: 1;
2522 /* For iterating over bidirectional text. */
2523 struct bidi_it bidi_it
;
2524 bidi_dir_t paragraph_embedding
;
2528 /* Access to positions of iterator IT. */
2530 #define IT_CHARPOS(IT) CHARPOS ((IT).current.pos)
2531 #define IT_BYTEPOS(IT) BYTEPOS ((IT).current.pos)
2532 #define IT_STRING_CHARPOS(IT) CHARPOS ((IT).current.string_pos)
2533 #define IT_STRING_BYTEPOS(IT) BYTEPOS ((IT).current.string_pos)
2535 /* Test if IT has reached the end of its buffer or string. This will
2536 only work after get_next_display_element has been called. */
2538 #define ITERATOR_AT_END_P(IT) ((IT)->what == IT_EOB)
2540 /* Non-zero means IT is at the end of a line. This is the case if it
2541 is either on a newline or on a carriage return and selective
2542 display hides the rest of the line. */
2544 #define ITERATOR_AT_END_OF_LINE_P(IT) \
2545 ((IT)->what == IT_CHARACTER \
2546 && ((IT)->c == '\n' \
2547 || ((IT)->c == '\r' && (IT)->selective)))
2549 /* Call produce_glyphs or FRAME_RIF->produce_glyphs, if set. Shortcut
2550 to avoid the function call overhead. */
2552 #define PRODUCE_GLYPHS(IT) \
2554 if ((IT)->glyph_row != NULL && (IT)->bidi_p) \
2556 if ((IT)->bidi_it.paragraph_dir == R2L) \
2557 (IT)->glyph_row->reversed_p = 1; \
2559 (IT)->glyph_row->reversed_p = 0; \
2561 if (FRAME_RIF ((IT)->f) != NULL) \
2562 FRAME_RIF ((IT)->f)->produce_glyphs ((IT)); \
2564 produce_glyphs ((IT)); \
2565 if ((IT)->glyph_row != NULL) \
2566 inhibit_free_realized_faces = 1; \
2569 /* Bit-flags indicating what operation move_it_to should perform. */
2571 enum move_operation_enum
2573 /* Stop if specified x-position is reached. */
2576 /* Stop if specified y-position is reached. */
2579 /* Stop if specified vpos is reached. */
2580 MOVE_TO_VPOS
= 0x04,
2582 /* Stop if specified buffer or string position is reached. */
2588 /***********************************************************************
2589 Window-based redisplay interface
2590 ***********************************************************************/
2592 /* Structure used to describe runs of lines that must be scrolled. */
2596 /* Source and destination y pixel position. */
2597 int desired_y
, current_y
;
2599 /* Source and destination vpos in matrix. */
2600 int desired_vpos
, current_vpos
;
2602 /* Height in pixels, number of glyph rows. */
2607 /* Handlers for setting frame parameters. */
2609 typedef void (*frame_parm_handler
) (struct frame
*, Lisp_Object
, Lisp_Object
);
2612 /* Structure holding system-dependent interface functions needed
2613 for window-based redisplay. */
2615 struct redisplay_interface
2617 /* Handlers for setting frame parameters. */
2618 frame_parm_handler
*frame_parm_handlers
;
2620 /* Produce glyphs/get display metrics for the display element IT is
2622 void (*produce_glyphs
) (struct it
*it
);
2624 /* Write or insert LEN glyphs from STRING at the nominal output
2626 void (*write_glyphs
) (struct glyph
*string
, int len
);
2627 void (*insert_glyphs
) (struct glyph
*start
, int len
);
2629 /* Clear from nominal output position to X. X < 0 means clear
2630 to right end of display. */
2631 void (*clear_end_of_line
) (int x
);
2633 /* Function to call to scroll the display as described by RUN on
2635 void (*scroll_run_hook
) (struct window
*w
, struct run
*run
);
2637 /* Function to call after a line in a display has been completely
2638 updated. Used to draw truncation marks and alike. DESIRED_ROW
2639 is the desired row which has been updated. */
2640 void (*after_update_window_line_hook
) (struct glyph_row
*desired_row
);
2642 /* Function to call before beginning to update window W in
2643 window-based redisplay. */
2644 void (*update_window_begin_hook
) (struct window
*w
);
2646 /* Function to call after window W has been updated in window-based
2647 redisplay. CURSOR_ON_P non-zero means switch cursor on.
2648 MOUSE_FACE_OVERWRITTEN_P non-zero means that some lines in W
2649 that contained glyphs in mouse-face were overwritten, so we
2650 have to update the mouse highlight. */
2651 void (*update_window_end_hook
) (struct window
*w
, int cursor_on_p
,
2652 int mouse_face_overwritten_p
);
2654 /* Move cursor to row/column position VPOS/HPOS, pixel coordinates
2655 Y/X. HPOS/VPOS are window-relative row and column numbers and X/Y
2656 are window-relative pixel positions. */
2657 void (*cursor_to
) (int vpos
, int hpos
, int y
, int x
);
2659 /* Flush the display of frame F. For X, this is XFlush. */
2660 void (*flush_display
) (struct frame
*f
);
2662 /* Flush the display of frame F if non-NULL. This is called
2663 during redisplay, and should be NULL on systems which flush
2664 automatically before reading input. */
2665 void (*flush_display_optional
) (struct frame
*f
);
2667 /* Clear the mouse highlight in window W, if there is any. */
2668 void (*clear_window_mouse_face
) (struct window
*w
);
2670 /* Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
2672 void (*get_glyph_overhangs
) (struct glyph
*glyph
, struct frame
*f
,
2673 int *left
, int *right
);
2675 /* Fix the display of AREA of ROW in window W for overlapping rows.
2676 This function is called from redraw_overlapping_rows after
2677 desired rows have been made current. */
2678 void (*fix_overlapping_area
) (struct window
*w
, struct glyph_row
*row
,
2679 enum glyph_row_area area
, int);
2681 #ifdef HAVE_WINDOW_SYSTEM
2683 /* Draw a fringe bitmap in window W of row ROW using parameters P. */
2684 void (*draw_fringe_bitmap
) (struct window
*w
, struct glyph_row
*row
,
2685 struct draw_fringe_bitmap_params
*p
);
2687 /* Define and destroy fringe bitmap no. WHICH. */
2688 void (*define_fringe_bitmap
) (int which
, unsigned short *bits
,
2690 void (*destroy_fringe_bitmap
) (int which
);
2692 /* Compute left and right overhang of glyph string S.
2693 A NULL pointer if platform does not support this. */
2694 void (*compute_glyph_string_overhangs
) (struct glyph_string
*s
);
2696 /* Draw a glyph string S. */
2697 void (*draw_glyph_string
) (struct glyph_string
*s
);
2699 /* Define cursor CURSOR on frame F. */
2700 void (*define_frame_cursor
) (struct frame
*f
, Cursor cursor
);
2702 /* Clear the area at (X,Y,WIDTH,HEIGHT) of frame F. */
2703 void (*clear_frame_area
) (struct frame
*f
, int x
, int y
,
2704 int width
, int height
);
2706 /* Draw specified cursor CURSOR_TYPE of width CURSOR_WIDTH
2707 at row GLYPH_ROW on window W if ON_P is 1. If ON_P is
2708 0, don't draw cursor. If ACTIVE_P is 1, system caret
2709 should track this cursor (when applicable). */
2710 void (*draw_window_cursor
) (struct window
*w
,
2711 struct glyph_row
*glyph_row
,
2713 int cursor_type
, int cursor_width
,
2714 int on_p
, int active_p
);
2716 /* Draw vertical border for window W from (X,Y_0) to (X,Y_1). */
2717 void (*draw_vertical_window_border
) (struct window
*w
,
2718 int x
, int y_0
, int y_1
);
2720 /* Shift display of frame F to make room for inserted glyphs.
2721 The area at pixel (X,Y) of width WIDTH and height HEIGHT is
2722 shifted right by SHIFT_BY pixels. */
2723 void (*shift_glyphs_for_insert
) (struct frame
*f
,
2724 int x
, int y
, int width
,
2725 int height
, int shift_by
);
2727 #endif /* HAVE_WINDOW_SYSTEM */
2731 /***********************************************************************
2733 ***********************************************************************/
2735 #ifdef HAVE_WINDOW_SYSTEM
2737 /* Structure forward declarations. */
2742 /* Each image format (JPEG, TIFF, ...) supported is described by
2743 a structure of the type below. */
2747 /* A symbol uniquely identifying the image type, .e.g `jpeg'. */
2750 /* Check that SPEC is a valid image specification for the given
2751 image type. Value is non-zero if SPEC is valid. */
2752 int (* valid_p
) (Lisp_Object spec
);
2754 /* Load IMG which is used on frame F from information contained in
2755 IMG->spec. Value is non-zero if successful. */
2756 int (* load
) (struct frame
*f
, struct image
*img
);
2758 /* Free resources of image IMG which is used on frame F. */
2759 void (* free
) (struct frame
*f
, struct image
*img
);
2761 /* Next in list of all supported image types. */
2762 struct image_type
*next
;
2766 /* Structure describing an image. Specific image formats like XBM are
2767 converted into this form, so that display only has to deal with
2768 this type of image. */
2772 /* The time in seconds at which the image was last displayed. Set
2773 in prepare_image_for_display. */
2774 EMACS_TIME timestamp
;
2776 /* Pixmaps of the image. */
2777 Pixmap pixmap
, mask
;
2779 /* Colors allocated for this image, if any. Allocated via xmalloc. */
2780 unsigned long *colors
;
2783 /* A single `background color' for this image, for the use of anyone that
2784 cares about such a thing. Only valid if the `background_valid' field
2785 is true. This should generally be accessed by calling the accessor
2786 macro `IMAGE_BACKGROUND', which will heuristically calculate a value
2788 unsigned long background
;
2790 /* Foreground and background colors of the frame on which the image
2792 unsigned long frame_foreground
, frame_background
;
2794 /* True if this image has a `transparent' background -- that is, is
2795 uses an image mask. The accessor macro for this is
2796 `IMAGE_BACKGROUND_TRANSPARENT'. */
2797 unsigned background_transparent
: 1;
2799 /* True if the `background' and `background_transparent' fields are
2800 valid, respectively. */
2801 unsigned background_valid
: 1, background_transparent_valid
: 1;
2803 /* Width and height of the image. */
2806 /* These values are used for the rectangles displayed for images
2807 that can't be loaded. */
2808 #define DEFAULT_IMAGE_WIDTH 30
2809 #define DEFAULT_IMAGE_HEIGHT 30
2811 /* Top/left and bottom/right corner pixel of actual image data.
2812 Used by four_corners_best to consider the real image data,
2813 rather than looking at the optional image margin. */
2815 #define TOP_CORNER 0
2816 #define LEFT_CORNER 1
2817 #define BOT_CORNER 2
2818 #define RIGHT_CORNER 3
2820 /* Percent of image height used as ascent. A value of
2821 CENTERED_IMAGE_ASCENT means draw the image centered on the
2824 #define DEFAULT_IMAGE_ASCENT 50
2825 #define CENTERED_IMAGE_ASCENT -1
2827 /* Lisp specification of this image. */
2830 /* List of "references" followed to build the image.
2831 Typically will just contain the name of the image file.
2832 Used to allow fine-grained cache flushing. */
2833 Lisp_Object dependencies
;
2835 /* Relief to draw around the image. */
2838 /* Optional margins around the image. This includes the relief. */
2839 int hmargin
, vmargin
;
2841 /* Reference to the type of the image. */
2842 struct image_type
*type
;
2844 /* 1 means that loading the image failed. Don't try again. */
2845 unsigned load_failed_p
;
2847 /* A place for image types to store additional data. It is marked
2849 Lisp_Object lisp_data
;
2851 /* Hash value of image specification to speed up comparisons. */
2854 /* Image id of this image. */
2857 /* Hash collision chain. */
2858 struct image
*next
, *prev
;
2862 /* Cache of images. Each frame has a cache. X frames with the same
2863 x_display_info share their caches. */
2867 /* Hash table of images. */
2868 struct image
**buckets
;
2870 /* Vector mapping image ids to images. */
2871 struct image
**images
;
2873 /* Allocated size of `images'. */
2876 /* Number of images in the cache. */
2879 /* Reference count (number of frames sharing this cache). */
2884 /* Value is a pointer to the image with id ID on frame F, or null if
2885 no image with that id exists. */
2887 #define IMAGE_FROM_ID(F, ID) \
2888 (((ID) >= 0 && (ID) < (FRAME_IMAGE_CACHE (F)->used)) \
2889 ? FRAME_IMAGE_CACHE (F)->images[ID] \
2892 /* Size of bucket vector of image caches. Should be prime. */
2894 #define IMAGE_CACHE_BUCKETS_SIZE 1001
2896 #endif /* HAVE_WINDOW_SYSTEM */
2900 /***********************************************************************
2902 ***********************************************************************/
2904 /* Enumeration defining where to find tool-bar item information in
2905 tool-bar items vectors stored with frames. Each tool-bar item
2906 occupies TOOL_BAR_ITEM_NSLOTS elements in such a vector. */
2908 enum tool_bar_item_idx
2910 /* The key of the tool-bar item. Used to remove items when a binding
2911 for `undefined' is found. */
2914 /* Non-nil if item is enabled. */
2915 TOOL_BAR_ITEM_ENABLED_P
,
2917 /* Non-nil if item is selected (pressed). */
2918 TOOL_BAR_ITEM_SELECTED_P
,
2921 TOOL_BAR_ITEM_CAPTION
,
2923 /* Image(s) to display. This is either a single image specification
2924 or a vector of specifications. */
2925 TOOL_BAR_ITEM_IMAGES
,
2928 TOOL_BAR_ITEM_BINDING
,
2930 /* Button type. One of nil (default button), t (a separator),
2931 `:radio', or `:toggle'. The latter two currently do nothing. */
2937 /* Icon file name of right to left image when an RTL locale is used. */
2938 TOOL_BAR_ITEM_RTL_IMAGE
,
2940 /* Label to show when text labels are enabled. */
2941 TOOL_BAR_ITEM_LABEL
,
2943 /* If we shall show the label only below the icon and not beside it. */
2944 TOOL_BAR_ITEM_VERT_ONLY
,
2946 /* Sentinel = number of slots in tool_bar_items occupied by one
2948 TOOL_BAR_ITEM_NSLOTS
2952 /* An enumeration for the different images that can be specified
2953 for a tool-bar item. */
2955 enum tool_bar_item_image
2957 TOOL_BAR_IMAGE_ENABLED_SELECTED
,
2958 TOOL_BAR_IMAGE_ENABLED_DESELECTED
,
2959 TOOL_BAR_IMAGE_DISABLED_SELECTED
,
2960 TOOL_BAR_IMAGE_DISABLED_DESELECTED
2963 #define DEFAULT_TOOL_BAR_LABEL_SIZE 14
2965 /* Default values of the above variables. */
2967 #define DEFAULT_TOOL_BAR_BUTTON_MARGIN 4
2968 #define DEFAULT_TOOL_BAR_BUTTON_RELIEF 1
2970 /* The height in pixels of the default tool-bar images. */
2972 #define DEFAULT_TOOL_BAR_IMAGE_HEIGHT 24
2975 /***********************************************************************
2976 Terminal Capabilities
2977 ***********************************************************************/
2979 /* Each of these is a bit representing a terminal `capability' (bold,
2980 inverse, etc). They are or'd together to specify the set of
2981 capabilities being queried for when calling `tty_capable_p' (which
2982 returns true if the terminal supports all of them). */
2984 #define TTY_CAP_INVERSE 0x01
2985 #define TTY_CAP_UNDERLINE 0x02
2986 #define TTY_CAP_BOLD 0x04
2987 #define TTY_CAP_DIM 0x08
2988 #define TTY_CAP_ITALIC 0x10
2991 /***********************************************************************
2993 ***********************************************************************/
2995 /* Defined in bidi.c */
2997 extern void bidi_init_it (ptrdiff_t, ptrdiff_t, int, struct bidi_it
*);
2998 extern void bidi_move_to_visually_next (struct bidi_it
*);
2999 extern void bidi_paragraph_init (bidi_dir_t
, struct bidi_it
*, int);
3000 extern int bidi_mirror_char (int);
3001 extern void bidi_push_it (struct bidi_it
*);
3002 extern void bidi_pop_it (struct bidi_it
*);
3003 extern void *bidi_shelve_cache (void);
3004 extern void bidi_unshelve_cache (void *, int);
3006 /* Defined in xdisp.c */
3008 struct glyph_row
*row_containing_pos (struct window
*, ptrdiff_t,
3010 struct glyph_row
*, int);
3011 int line_bottom_y (struct it
*);
3012 int display_prop_intangible_p (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3013 void resize_echo_area_exactly (void);
3014 int resize_mini_window (struct window
*, int);
3015 #if defined USE_TOOLKIT_SCROLL_BARS && !defined USE_GTK
3016 void set_vertical_scroll_bar (struct window
*);
3018 int try_window (Lisp_Object
, struct text_pos
, int);
3019 void window_box (struct window
*, int, int *, int *, int *, int *);
3020 int window_box_height (struct window
*);
3021 int window_text_bottom_y (struct window
*);
3022 int window_box_width (struct window
*, int);
3023 int window_box_left (struct window
*, int);
3024 int window_box_left_offset (struct window
*, int);
3025 int window_box_right (struct window
*, int);
3026 int window_box_right_offset (struct window
*, int);
3027 int estimate_mode_line_height (struct frame
*, enum face_id
);
3028 void pixel_to_glyph_coords (struct frame
*, int, int, int *, int *,
3029 NativeRectangle
*, int);
3030 void remember_mouse_glyph (struct frame
*, int, int, NativeRectangle
*);
3032 void mark_window_display_accurate (Lisp_Object
, int);
3033 void redisplay_preserve_echo_area (int);
3034 void init_iterator (struct it
*, struct window
*, ptrdiff_t,
3035 ptrdiff_t, struct glyph_row
*, enum face_id
);
3036 void init_iterator_to_row_start (struct it
*, struct window
*,
3037 struct glyph_row
*);
3038 void start_display (struct it
*, struct window
*, struct text_pos
);
3039 void move_it_to (struct it
*, ptrdiff_t, int, int, int, int);
3040 void move_it_vertically (struct it
*, int);
3041 void move_it_vertically_backward (struct it
*, int);
3042 void move_it_by_lines (struct it
*, ptrdiff_t);
3043 void move_it_past_eol (struct it
*);
3044 void move_it_in_display_line (struct it
*it
,
3045 ptrdiff_t to_charpos
, int to_x
,
3046 enum move_operation_enum op
);
3047 int in_display_vector_p (struct it
*);
3048 int frame_mode_line_height (struct frame
*);
3049 extern Lisp_Object Qtool_bar
;
3050 extern int redisplaying_p
;
3051 extern int help_echo_showing_p
;
3052 extern int current_mode_line_height
, current_header_line_height
;
3053 extern Lisp_Object help_echo_string
, help_echo_window
;
3054 extern Lisp_Object help_echo_object
, previous_help_echo_string
;
3055 extern ptrdiff_t help_echo_pos
;
3056 extern struct frame
*last_mouse_frame
;
3057 extern int last_tool_bar_item
;
3058 extern void reseat_at_previous_visible_line_start (struct it
*);
3059 extern Lisp_Object
lookup_glyphless_char_display (int, struct it
*);
3060 extern ptrdiff_t compute_display_string_pos (struct text_pos
*,
3061 struct bidi_string_data
*,
3063 extern ptrdiff_t compute_display_string_end (ptrdiff_t,
3064 struct bidi_string_data
*);
3065 extern void produce_stretch_glyph (struct it
*);
3068 #ifdef HAVE_WINDOW_SYSTEM
3071 extern void dump_glyph_string (struct glyph_string
*) EXTERNALLY_VISIBLE
;
3074 extern void x_get_glyph_overhangs (struct glyph
*, struct frame
*,
3076 extern void x_produce_glyphs (struct it
*);
3078 extern void x_write_glyphs (struct glyph
*, int);
3079 extern void x_insert_glyphs (struct glyph
*, int len
);
3080 extern void x_clear_end_of_line (int);
3082 extern struct cursor_pos output_cursor
;
3084 extern void x_fix_overlapping_area (struct window
*, struct glyph_row
*,
3085 enum glyph_row_area
, int);
3086 extern void draw_phys_cursor_glyph (struct window
*,
3088 enum draw_glyphs_face
);
3089 extern void get_phys_cursor_geometry (struct window
*, struct glyph_row
*,
3090 struct glyph
*, int *, int *, int *);
3091 extern void erase_phys_cursor (struct window
*);
3092 extern void display_and_set_cursor (struct window
*,
3093 int, int, int, int, int);
3095 extern void set_output_cursor (struct cursor_pos
*);
3096 extern void x_cursor_to (int, int, int, int);
3098 extern void x_update_cursor (struct frame
*, int);
3099 extern void x_clear_cursor (struct window
*);
3100 extern void x_draw_vertical_border (struct window
*w
);
3102 extern int get_glyph_string_clip_rects (struct glyph_string
*,
3103 NativeRectangle
*, int);
3104 extern void get_glyph_string_clip_rect (struct glyph_string
*,
3105 NativeRectangle
*nr
);
3106 extern Lisp_Object
find_hot_spot (Lisp_Object
, int, int);
3108 extern void handle_tool_bar_click (struct frame
*,
3109 int, int, int, int);
3111 extern void expose_frame (struct frame
*, int, int, int, int);
3112 extern int x_intersect_rectangles (XRectangle
*, XRectangle
*,
3114 #endif /* HAVE_WINDOW_SYSTEM */
3116 extern void note_mouse_highlight (struct frame
*, int, int);
3117 extern void x_clear_window_mouse_face (struct window
*);
3118 extern void cancel_mouse_face (struct frame
*);
3119 extern int clear_mouse_face (Mouse_HLInfo
*);
3120 extern int cursor_in_mouse_face_p (struct window
*w
);
3121 extern void tty_draw_row_with_mouse_face (struct window
*, struct glyph_row
*,
3122 int, int, enum draw_glyphs_face
);
3124 /* Flags passed to try_window. */
3125 #define TRY_WINDOW_CHECK_MARGINS (1 << 0)
3126 #define TRY_WINDOW_IGNORE_FONTS_CHANGE (1 << 1)
3128 int lookup_fringe_bitmap (Lisp_Object
);
3129 void draw_fringe_bitmap (struct window
*, struct glyph_row
*, int);
3130 void draw_row_fringe_bitmaps (struct window
*, struct glyph_row
*);
3131 int draw_window_fringes (struct window
*, int);
3132 int update_window_fringes (struct window
*, int);
3133 void compute_fringe_widths (struct frame
*, int);
3136 void w32_init_fringe (struct redisplay_interface
*);
3137 void w32_reset_fringes (void);
3140 extern unsigned row_hash (struct glyph_row
*);
3142 /* Defined in image.c */
3144 #ifdef HAVE_WINDOW_SYSTEM
3146 extern int x_bitmap_height (struct frame
*, ptrdiff_t);
3147 extern int x_bitmap_width (struct frame
*, ptrdiff_t);
3148 extern int x_bitmap_pixmap (struct frame
*, ptrdiff_t);
3149 extern void x_reference_bitmap (struct frame
*, ptrdiff_t);
3150 extern ptrdiff_t x_create_bitmap_from_data (struct frame
*, char *,
3151 unsigned int, unsigned int);
3152 extern ptrdiff_t x_create_bitmap_from_file (struct frame
*, Lisp_Object
);
3153 #if defined HAVE_XPM && defined HAVE_X_WINDOWS && !defined USE_GTK
3154 extern ptrdiff_t x_create_bitmap_from_xpm_data (struct frame
*, const char **);
3156 #ifndef x_destroy_bitmap
3157 extern void x_destroy_bitmap (struct frame
*, ptrdiff_t);
3159 extern void x_destroy_all_bitmaps (Display_Info
*);
3160 extern int x_create_bitmap_mask (struct frame
*, ptrdiff_t);
3161 extern Lisp_Object
x_find_image_file (Lisp_Object
);
3163 void x_kill_gs_process (Pixmap
, struct frame
*);
3164 struct image_cache
*make_image_cache (void);
3165 void free_image_cache (struct frame
*);
3166 void clear_image_caches (Lisp_Object
);
3167 void mark_image_cache (struct image_cache
*);
3168 int valid_image_p (Lisp_Object
);
3169 void prepare_image_for_display (struct frame
*, struct image
*);
3170 ptrdiff_t lookup_image (struct frame
*, Lisp_Object
);
3172 unsigned long image_background (struct image
*, struct frame
*,
3173 XImagePtr_or_DC ximg
);
3174 int image_background_transparent (struct image
*, struct frame
*,
3175 XImagePtr_or_DC mask
);
3177 int image_ascent (struct image
*, struct face
*, struct glyph_slice
*);
3181 /* Defined in sysdep.c */
3183 void get_tty_size (int, int *, int *);
3184 void request_sigio (void);
3185 void unrequest_sigio (void);
3186 int tabs_safe_p (int);
3187 void init_baud_rate (int);
3188 void init_sigio (int);
3190 /* Defined in xfaces.c */
3192 #ifdef HAVE_X_WINDOWS
3193 void x_free_colors (struct frame
*, unsigned long *, int);
3196 void update_face_from_frame_parameter (struct frame
*, Lisp_Object
,
3198 Lisp_Object
tty_color_name (struct frame
*, int);
3199 void clear_face_cache (int);
3200 unsigned long load_color (struct frame
*, struct face
*, Lisp_Object
,
3201 enum lface_attribute_index
);
3202 void unload_color (struct frame
*, unsigned long);
3203 char *choose_face_font (struct frame
*, Lisp_Object
*, Lisp_Object
,
3205 void prepare_face_for_display (struct frame
*, struct face
*);
3206 #ifdef HAVE_STRCASECMP
3207 #define xstrcasecmp(x,y) strcasecmp ((x), (y))
3209 int xstrcasecmp (const char *, const char *);
3211 int lookup_named_face (struct frame
*, Lisp_Object
, int);
3212 int lookup_basic_face (struct frame
*, int);
3213 int smaller_face (struct frame
*, int, int);
3214 int face_with_height (struct frame
*, int, int);
3215 int lookup_derived_face (struct frame
*, Lisp_Object
, int, int);
3216 void init_frame_faces (struct frame
*);
3217 void free_frame_faces (struct frame
*);
3218 void recompute_basic_faces (struct frame
*);
3219 int face_at_buffer_position (struct window
*w
, ptrdiff_t pos
,
3220 ptrdiff_t region_beg
, ptrdiff_t region_end
,
3221 ptrdiff_t *endptr
, ptrdiff_t limit
,
3222 int mouse
, int base_face_id
);
3223 int face_for_overlay_string (struct window
*w
, ptrdiff_t pos
,
3224 ptrdiff_t region_beg
, ptrdiff_t region_end
,
3225 ptrdiff_t *endptr
, ptrdiff_t limit
,
3226 int mouse
, Lisp_Object overlay
);
3227 int face_at_string_position (struct window
*w
, Lisp_Object string
,
3228 ptrdiff_t pos
, ptrdiff_t bufpos
,
3229 ptrdiff_t region_beg
, ptrdiff_t region_end
,
3230 ptrdiff_t *endptr
, enum face_id
, int mouse
);
3231 int merge_faces (struct frame
*, Lisp_Object
, int, int);
3232 int compute_char_face (struct frame
*, int, Lisp_Object
);
3233 void free_all_realized_faces (Lisp_Object
);
3234 extern Lisp_Object Qforeground_color
, Qbackground_color
;
3235 extern char unspecified_fg
[], unspecified_bg
[];
3237 /* Defined in xfns.c */
3239 #ifdef HAVE_X_WINDOWS
3240 void gamma_correct (struct frame
*, XColor
*);
3243 void gamma_correct (struct frame
*, COLORREF
*);
3246 #ifdef HAVE_WINDOW_SYSTEM
3248 void x_implicitly_set_name (struct frame
*, Lisp_Object
, Lisp_Object
);
3250 extern Lisp_Object tip_frame
;
3251 extern Window tip_window
;
3252 EXFUN (Fx_hide_tip
, 0);
3253 extern void start_hourglass (void);
3254 extern void cancel_hourglass (void);
3255 extern int hourglass_shown_p
;
3256 struct atimer
; /* Defined in atimer.h. */
3257 /* If non-null, an asynchronous timer that, when it expires, displays
3258 an hourglass cursor on all frames. */
3259 extern struct atimer
*hourglass_atimer
;
3261 /* Each GUI implements these. FIXME: move into RIF. */
3262 extern void show_hourglass (struct atimer
*);
3263 extern void hide_hourglass (void);
3265 /* Returns the background color of IMG, calculating one heuristically if
3266 necessary. If non-zero, XIMG is an existing XImage object to use for
3269 #define IMAGE_BACKGROUND(img, f, ximg) \
3270 ((img)->background_valid \
3271 ? (img)->background \
3272 : image_background (img, f, ximg))
3274 /* Returns true if IMG has a `transparent' background, using heuristics
3275 to decide if necessary. If non-zero, MASK is an existing XImage
3276 object to use for the heuristic. */
3278 #define IMAGE_BACKGROUND_TRANSPARENT(img, f, mask) \
3279 ((img)->background_transparent_valid \
3280 ? (img)->background_transparent \
3281 : image_background_transparent (img, f, mask))
3283 #endif /* HAVE_WINDOW_SYSTEM */
3286 /* Defined in xmenu.c */
3288 int popup_activated (void);
3290 extern Lisp_Object
buffer_posn_from_coords (struct window
*,
3292 struct display_pos
*,
3294 int *, int *, int *, int *);
3295 extern Lisp_Object
mode_line_string (struct window
*, enum window_part
,
3296 int *, int *, ptrdiff_t *,
3298 int *, int *, int *, int *);
3299 extern Lisp_Object
marginal_area_string (struct window
*, enum window_part
,
3300 int *, int *, ptrdiff_t *,
3302 int *, int *, int *, int *);
3303 extern void redraw_frame (struct frame
*);
3304 extern void cancel_line (int, struct frame
*);
3305 extern void init_desired_glyphs (struct frame
*);
3306 extern int update_frame (struct frame
*, int, int);
3307 extern void bitch_at_user (void);
3308 void adjust_glyphs (struct frame
*);
3309 void free_glyphs (struct frame
*);
3310 void free_window_matrices (struct window
*);
3311 void check_glyph_memory (void);
3312 void mirrored_line_dance (struct glyph_matrix
*, int, int, int *, char *);
3313 void clear_glyph_matrix (struct glyph_matrix
*);
3314 void clear_current_matrices (struct frame
*f
);
3315 void clear_desired_matrices (struct frame
*);
3316 void shift_glyph_matrix (struct window
*, struct glyph_matrix
*,
3318 void rotate_matrix (struct glyph_matrix
*, int, int, int);
3319 void increment_matrix_positions (struct glyph_matrix
*,
3320 int, int, ptrdiff_t, ptrdiff_t);
3321 void blank_row (struct window
*, struct glyph_row
*, int);
3322 void enable_glyph_matrix_rows (struct glyph_matrix
*, int, int, int);
3323 void clear_glyph_row (struct glyph_row
*);
3324 void prepare_desired_row (struct glyph_row
*);
3325 void set_window_update_flags (struct window
*, int);
3326 void update_single_window (struct window
*, int);
3327 void do_pending_window_change (int);
3328 void change_frame_size (struct frame
*, int, int, int, int, int);
3329 void init_display (void);
3330 void syms_of_display (void);
3331 extern Lisp_Object Qredisplay_dont_pause
;
3332 void spec_glyph_lookup_face (struct window
*, GLYPH
*);
3334 /* Defined in terminal.c */
3336 extern void ring_bell (struct frame
*);
3337 extern void update_begin (struct frame
*);
3338 extern void update_end (struct frame
*);
3339 extern void set_terminal_window (struct frame
*, int);
3340 extern void cursor_to (struct frame
*, int, int);
3341 extern void raw_cursor_to (struct frame
*, int, int);
3342 extern void clear_to_end (struct frame
*);
3343 extern void clear_frame (struct frame
*);
3344 extern void clear_end_of_line (struct frame
*, int);
3345 extern void write_glyphs (struct frame
*, struct glyph
*, int);
3346 extern void insert_glyphs (struct frame
*, struct glyph
*, int);
3347 extern void delete_glyphs (struct frame
*, int);
3348 extern void ins_del_lines (struct frame
*, int, int);
3350 extern struct terminal
*init_initial_terminal (void);
3353 /* Defined in term.c */
3355 extern void tty_turn_off_insert (struct tty_display_info
*);
3356 extern int string_cost (const char *);
3357 extern int per_line_cost (const char *);
3358 extern void calculate_costs (struct frame
*);
3359 extern void produce_glyphs (struct it
*);
3360 extern void produce_special_glyphs (struct it
*, enum display_element_type
);
3361 extern int tty_capable_p (struct tty_display_info
*, unsigned, unsigned long, unsigned long);
3362 extern void set_tty_color_mode (struct tty_display_info
*, struct frame
*);
3363 extern struct terminal
*get_named_tty (const char *);
3364 EXFUN (Ftty_type
, 1);
3365 EXFUN (Fcontrolling_tty_p
, 1);
3366 extern void create_tty_output (struct frame
*);
3367 extern struct terminal
*init_tty (const char *, const char *, int);
3368 extern void tty_append_glyph (struct it
*);
3371 /* Defined in scroll.c */
3373 extern int scrolling_max_lines_saved (int, int, int *, int *, int *);
3374 extern void do_line_insertion_deletion_costs (struct frame
*, const char *,
3375 const char *, const char *,
3376 const char *, const char *,
3378 void scrolling_1 (struct frame
*, int, int, int, int *, int *, int *,
3381 /* Defined in frame.c */
3383 #ifdef HAVE_WINDOW_SYSTEM
3385 /* Types we might convert a resource string into. */
3393 RES_TYPE_BOOLEAN_NUMBER
3396 extern Lisp_Object
x_get_arg (Display_Info
*, Lisp_Object
,
3397 Lisp_Object
, const char *, const char *class,
3398 enum resource_types
);
3399 extern Lisp_Object
x_frame_get_and_record_arg (struct frame
*, Lisp_Object
,
3401 const char *, const char *,
3402 enum resource_types
);
3403 extern Lisp_Object
x_default_parameter (struct frame
*, Lisp_Object
,
3404 Lisp_Object
, Lisp_Object
,
3405 const char *, const char *,
3406 enum resource_types
);
3408 #endif /* HAVE_WINDOW_SYSTEM */
3410 #endif /* not DISPEXTERN_H_INCLUDED */