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 #ifndef HAVE_WINDOW_SYSTEM
76 #ifndef NativeRectangle
77 #define NativeRectangle int
80 /* Structure forward declarations. Some are here because function
81 prototypes below reference structure types before their definition
82 in this file. Some are here because not every file including
83 dispextern.h also includes frame.h and windows.h. */
93 /* Values returned from coordinates_in_window. */
109 /* Number of bits allocated to store fringe bitmap numbers. */
110 #define FRINGE_ID_BITS 16
112 /* Number of bits allocated to store fringe bitmap height. */
113 #define FRINGE_HEIGHT_BITS 8
116 /***********************************************************************
118 ***********************************************************************/
120 /* If GLYPH_DEBUG is non-zero, additional checks are activated. Turn
121 it off by defining the macro GLYPH_DEBUG to zero. */
124 #define GLYPH_DEBUG 0
127 /* If XASSERTS is non-zero, additional consistency checks are activated.
128 Turn it off by defining the macro XASSERTS to zero. */
134 /* Macros to include code only if GLYPH_DEBUG != 0. */
137 #define IF_DEBUG(X) X
139 #define IF_DEBUG(X) (void) 0
143 #define xassert(X) do {if (!(X)) abort ();} while (0)
145 #define xassert(X) (void) 0
148 /* Macro for displaying traces of redisplay. If Emacs was compiled
149 with GLYPH_DEBUG != 0, the variable trace_redisplay_p can be set to
150 a non-zero value in debugging sessions to activate traces. */
154 extern int trace_redisplay_p EXTERNALLY_VISIBLE
;
158 if (trace_redisplay_p) \
163 #else /* GLYPH_DEBUG == 0 */
165 #define TRACE(X) (void) 0
167 #endif /* GLYPH_DEBUG == 0 */
171 /***********************************************************************
173 ***********************************************************************/
175 /* Starting with Emacs 20.3, characters from strings and buffers have
176 both a character and a byte position associated with them. The
177 following structure holds such a pair of positions. */
181 /* Character position. */
184 /* Corresponding byte position. */
188 /* Access character and byte position of POS in a functional form. */
190 #define BYTEPOS(POS) (POS).bytepos
191 #define CHARPOS(POS) (POS).charpos
193 /* Set character position of POS to CHARPOS, byte position to BYTEPOS. */
195 #define SET_TEXT_POS(POS, CHARPOS, BYTEPOS) \
196 ((POS).charpos = (CHARPOS), (POS).bytepos = BYTEPOS)
198 /* Increment text position POS. */
200 #define INC_TEXT_POS(POS, MULTIBYTE_P) \
205 INC_POS ((POS).bytepos); \
211 /* Decrement text position POS. */
213 #define DEC_TEXT_POS(POS, MULTIBYTE_P) \
218 DEC_POS ((POS).bytepos); \
224 /* Set text position POS from marker MARKER. */
226 #define SET_TEXT_POS_FROM_MARKER(POS, MARKER) \
227 (CHARPOS (POS) = marker_position ((MARKER)), \
228 BYTEPOS (POS) = marker_byte_position ((MARKER)))
230 /* Set marker MARKER from text position POS. */
232 #define SET_MARKER_FROM_TEXT_POS(MARKER, POS) \
233 set_marker_both ((MARKER), Qnil, CHARPOS ((POS)), BYTEPOS ((POS)))
235 /* Value is non-zero if character and byte positions of POS1 and POS2
238 #define TEXT_POS_EQUAL_P(POS1, POS2) \
239 ((POS1).charpos == (POS2).charpos \
240 && (POS1).bytepos == (POS2).bytepos)
242 /* When rendering glyphs, redisplay scans string or buffer text,
243 overlay strings in that text, and does display table or control
244 character translations. The following structure captures a
245 position taking all this into account. */
249 /* Buffer or string position. */
252 /* If this is a position in an overlay string, overlay_string_index
253 is the index of that overlay string in the sequence of overlay
254 strings at `pos' in the order redisplay processes them. A value
255 < 0 means that this is not a position in an overlay string. */
256 int overlay_string_index
;
258 /* If this is a position in an overlay string, string_pos is the
259 position within that string. */
260 struct text_pos string_pos
;
262 /* If the character at the position above is a control character or
263 has a display table entry, dpvec_index is an index in the display
264 table or control character translation of that character. A
265 value < 0 means this is not a position in such a translation. */
271 /***********************************************************************
273 ***********************************************************************/
275 /* Enumeration of glyph types. Glyph structures contain a type field
276 containing one of the enumerators defined here. */
280 /* Glyph describes a character. */
283 /* Glyph describes a static composition. */
286 /* Glyph describes a glyphless character. */
289 /* Glyph describes an image. */
292 /* Glyph is a space of fractional width and/or height. */
295 /* Glyph is an external widget drawn by the GUI toolkit. */
301 /* Structure describing how to use partial glyphs (images slicing) */
308 unsigned height
: 16;
314 Be extra careful when changing this structure! Esp. make sure that
315 functions producing glyphs, like append_glyph, fill ALL of the
316 glyph structure, and that GLYPH_EQUAL_P compares all
317 display-relevant members of glyphs (not to imply that these are the
318 only things to check when you add a member). */
322 /* Position from which this glyph was drawn. If `object' below is a
323 Lisp string, this is a position in that string. If it is a
324 buffer, this is a position in that buffer. A value of -1
325 together with a null object means glyph is a truncation glyph at
326 the start of a row. */
329 /* Lisp object source of this glyph. Currently either a buffer or
330 a string, if the glyph was produced from characters which came from
331 a buffer or a string; or 0 if the glyph was inserted by redisplay
332 for its own purposes such as padding. */
335 /* Width in pixels. */
338 /* Ascent and descent in pixels. */
339 short ascent
, descent
;
341 /* Vertical offset. If < 0, the glyph is displayed raised, if > 0
342 the glyph is displayed lowered. */
345 /* Which kind of glyph this is---character, image etc. Value
346 should be an enumerator of type enum glyph_type. */
349 /* 1 means this glyph was produced from multibyte text. Zero
350 means it was produced from unibyte text, i.e. charsets aren't
351 applicable, and encoding is not performed. */
352 unsigned multibyte_p
: 1;
354 /* Non-zero means draw a box line at the left or right side of this
355 glyph. This is part of the implementation of the face attribute
357 unsigned left_box_line_p
: 1;
358 unsigned right_box_line_p
: 1;
360 /* Non-zero means this glyph's physical ascent or descent is greater
361 than its logical ascent/descent, i.e. it may potentially overlap
362 glyphs above or below it. */
363 unsigned overlaps_vertically_p
: 1;
365 /* For terminal frames, 1 means glyph is a padding glyph. Padding
366 glyphs are used for characters whose visual shape consists of
367 more than one glyph (e.g. Asian characters). All but the first
368 glyph of such a glyph sequence have the padding_p flag set. This
369 flag is used only to minimize code changes. A better way would
370 probably be to use the width field of glyphs to express padding.
372 For graphic frames, 1 means the pixel width of the glyph in a
373 font is 0, but 1-pixel is padded on displaying for correct cursor
374 displaying. The member `pixel_width' above is set to 1. */
375 unsigned padding_p
: 1;
377 /* 1 means the actual glyph is not available, draw using `struct
378 glyphless' below instead. This can happen when a font couldn't
379 be loaded, or a character doesn't have a glyph in a font. */
380 unsigned glyph_not_available_p
: 1;
382 /* Non-zero means don't display cursor here. */
383 unsigned avoid_cursor_p
: 1;
385 /* Resolved bidirectional level of this character [0..63]. */
386 unsigned resolved_level
: 5;
388 /* Resolved bidirectional type of this character, see enum
389 bidi_type_t below. Note that according to UAX#9, only some
390 values (STRONG_L, STRONG_R, WEAK_AN, WEAK_EN, WEAK_BN, and
391 NEUTRAL_B) can appear in the resolved type, so we only reserve
392 space for those that can. */
393 unsigned bidi_type
: 3;
395 #define FACE_ID_BITS 20
397 /* Face of the glyph. This is a realized face ID,
398 an index in the face cache of the frame. */
399 unsigned face_id
: FACE_ID_BITS
;
401 /* Type of font used to display the character glyph. May be used to
402 determine which set of functions to use to obtain font metrics
403 for the glyph. On W32, value should be an enumerator of the type
404 w32_char_font_type. Otherwise it equals FONT_TYPE_UNKNOWN. */
405 unsigned font_type
: 3;
407 /* A union of sub-structures for different glyph types. */
410 /* Metrics of a partial glyph of an image (type == IMAGE_GLYPH). */
411 struct glyph_slice img
;
412 /* Start and end indices of glyphs of a grapheme cluster of a
413 composition (type == COMPOSITE_GLYPH). */
414 struct { int from
, to
; } cmp
;
415 /* Pixel offsets for upper and lower part of the acronym. */
417 short upper_xoff
, upper_yoff
;
418 short lower_xoff
, lower_yoff
;
422 /* A union of sub-structures for different glyph types. */
425 /* Character code for character glyphs (type == CHAR_GLYPH). */
428 /* Sub-structures for type == COMPOSITE_GLYPH. */
431 /* Flag to tell if the composition is automatic or not. */
432 unsigned automatic
: 1;
433 /* ID of the composition. */
437 /* Image ID for image glyphs (type == IMAGE_GLYPH). */
441 struct xwidget
* xwidget
;
443 /* Sub-structure for type == STRETCH_GLYPH. */
446 /* The height of the glyph. */
447 unsigned height
: 16;
449 /* The ascent of the glyph. */
450 unsigned ascent
: 16;
454 /* Sub-stretch for type == GLYPHLESS_GLYPH. */
457 /* Value is an enum of the type glyphless_display_method. */
459 /* 1 iff this glyph is for a character of no font. */
460 unsigned for_no_font
: 1;
461 /* Length of acronym or hexadecimal code string (at most 8). */
463 /* Character to display. Actually we need only 22 bits. */
467 /* Used to compare all bit-fields above in one step. */
473 /* Default value of the glyph font_type field. */
475 #define FONT_TYPE_UNKNOWN 0
477 /* Is GLYPH a space? */
479 #define CHAR_GLYPH_SPACE_P(GLYPH) \
480 ((GLYPH).u.ch == SPACEGLYPH && (GLYPH).face_id == DEFAULT_FACE_ID)
482 /* Are glyph slices of glyphs *X and *Y equal? It assumes that both
483 glyphs have the same type.
485 Note: for composition glyphs, we don't have to compare slice.cmp.to
486 because they should be the same if and only if slice.cmp.from are
489 #define GLYPH_SLICE_EQUAL_P(X, Y) \
490 ((X)->type == IMAGE_GLYPH \
491 ? ((X)->slice.img.x == (Y)->slice.img.x \
492 && (X)->slice.img.y == (Y)->slice.img.y \
493 && (X)->slice.img.width == (Y)->slice.img.width \
494 && (X)->slice.img.height == (Y)->slice.img.height) \
495 : ((X)->type != COMPOSITE_GLYPH \
496 || (X)->slice.cmp.from == (Y)->slice.cmp.from))
498 /* Are glyphs *X and *Y displayed equal? */
500 #define GLYPH_EQUAL_P(X, Y) \
501 ((X)->type == (Y)->type \
502 && (X)->u.val == (Y)->u.val \
503 && GLYPH_SLICE_EQUAL_P (X, Y) \
504 && (X)->face_id == (Y)->face_id \
505 && (X)->padding_p == (Y)->padding_p \
506 && (X)->left_box_line_p == (Y)->left_box_line_p \
507 && (X)->right_box_line_p == (Y)->right_box_line_p \
508 && (X)->voffset == (Y)->voffset \
509 && (X)->pixel_width == (Y)->pixel_width)
511 /* Are character codes, faces, padding_ps of glyphs *X and *Y equal? */
513 #define GLYPH_CHAR_AND_FACE_EQUAL_P(X, Y) \
514 ((X)->u.ch == (Y)->u.ch \
515 && (X)->face_id == (Y)->face_id \
516 && (X)->padding_p == (Y)->padding_p)
518 /* Fill a character glyph GLYPH. CODE, FACE_ID, PADDING_P correspond
519 to the bits defined for the typedef `GLYPH' in lisp.h. */
521 #define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P) \
524 (GLYPH).u.ch = (CODE); \
525 (GLYPH).face_id = (FACE_ID); \
526 (GLYPH).padding_p = (PADDING_P); \
530 /* Fill a character type glyph GLYPH from a glyph typedef FROM as
531 defined in lisp.h. */
533 #define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM) \
534 SET_CHAR_GLYPH ((GLYPH), \
535 GLYPH_CHAR ((FROM)), \
536 GLYPH_FACE ((FROM)), \
539 /* Construct a glyph code from a character glyph GLYPH. If the
540 character is multibyte, return -1 as we can't use glyph table for a
541 multibyte character. */
543 #define SET_GLYPH_FROM_CHAR_GLYPH(G, GLYPH) \
546 if ((GLYPH).u.ch < 256) \
547 SET_GLYPH ((G), (GLYPH).u.ch, ((GLYPH).face_id)); \
549 SET_GLYPH ((G), -1, 0); \
553 #define GLYPH_INVALID_P(GLYPH) (GLYPH_CHAR (GLYPH) < 0)
555 /* Is GLYPH a padding glyph? */
557 #define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p
562 /***********************************************************************
564 ***********************************************************************/
568 Glyph memory for frame-based redisplay is allocated from the heap
569 in one vector kept in a glyph pool structure which is stored with
570 the frame. The size of the vector is made large enough to cover
571 all windows on the frame.
573 Both frame and window glyph matrices reference memory from a glyph
574 pool in frame-based redisplay.
576 In window-based redisplay, no glyphs pools exist; windows allocate
577 and free their glyph memory themselves. */
581 /* Vector of glyphs allocated from the heap. */
582 struct glyph
*glyphs
;
584 /* Allocated size of `glyphs'. */
587 /* Number of rows and columns in a matrix. */
593 /***********************************************************************
595 ***********************************************************************/
599 Three kinds of glyph matrices exist:
601 1. Frame glyph matrices. These are used for terminal frames whose
602 redisplay needs a view of the whole screen due to limited terminal
603 capabilities. Frame matrices are used only in the update phase
604 of redisplay. They are built in update_frame and not used after
605 the update has been performed.
607 2. Window glyph matrices on frames having frame glyph matrices.
608 Such matrices are sub-matrices of their corresponding frame matrix,
609 i.e. frame glyph matrices and window glyph matrices share the same
610 glyph memory which is allocated in form of a glyph_pool structure.
611 Glyph rows in such a window matrix are slices of frame matrix rows.
613 2. Free-standing window glyph matrices managing their own glyph
614 storage. This form is used in window-based redisplay which
615 includes variable width and height fonts etc.
617 The size of a window's row vector depends on the height of fonts
618 defined on its frame. It is chosen so that the vector is large
619 enough to describe all lines in a window when it is displayed in
620 the smallest possible character size. When new fonts are loaded,
621 or window sizes change, the row vector is adjusted accordingly. */
625 /* The pool from which glyph memory is allocated, if any. This is
626 null for frame matrices and for window matrices managing their
628 struct glyph_pool
*pool
;
630 /* Vector of glyph row structures. The row at nrows - 1 is reserved
631 for the mode line. */
632 struct glyph_row
*rows
;
634 /* Number of elements allocated for the vector rows above. */
635 ptrdiff_t rows_allocated
;
637 /* The number of rows used by the window if all lines were displayed
638 with the smallest possible character height. */
641 /* Origin within the frame matrix if this is a window matrix on a
642 frame having a frame matrix. Both values are zero for
643 window-based redisplay. */
644 int matrix_x
, matrix_y
;
646 /* Width and height of the matrix in columns and rows. */
647 int matrix_w
, matrix_h
;
649 /* If this structure describes a window matrix of window W,
650 window_left_col is the value of W->left_col, window_top_line the
651 value of W->top_line, window_height and window_width are width and
652 height of W, as returned by window_box, and window_vscroll is the
653 value of W->vscroll at the time the matrix was last adjusted.
654 Only set for window-based redisplay. */
655 int window_left_col
, window_top_line
;
656 int window_height
, window_width
;
659 /* Number of glyphs reserved for left and right marginal areas when
660 the matrix was last adjusted. */
661 int left_margin_glyphs
, right_margin_glyphs
;
663 /* Flag indicating that scrolling should not be tried in
664 update_window. This flag is set by functions like try_window_id
665 which do their own scrolling. */
666 unsigned no_scrolling_p
: 1;
668 /* Non-zero means window displayed in this matrix has a top mode
670 unsigned header_line_p
: 1;
673 /* A string identifying the method used to display the matrix. */
677 /* The buffer this matrix displays. Set in
678 mark_window_display_accurate_1. */
679 struct buffer
*buffer
;
681 /* Values of BEGV and ZV as of last redisplay. Set in
682 mark_window_display_accurate_1. */
687 /* Check that glyph pointers stored in glyph rows of MATRIX are okay.
688 This aborts if any pointer is found twice. */
691 void check_matrix_pointer_lossage (struct glyph_matrix
*);
692 #define CHECK_MATRIX(MATRIX) check_matrix_pointer_lossage ((MATRIX))
694 #define CHECK_MATRIX(MATRIX) (void) 0
699 /***********************************************************************
701 ***********************************************************************/
703 /* Area in window glyph matrix. If values are added or removed, the
704 function mark_object in alloc.c has to be changed. */
715 /* Rows of glyphs in a windows or frame glyph matrix.
717 Each row is partitioned into three areas. The start and end of
718 each area is recorded in a pointer as shown below.
720 +--------------------+-------------+---------------------+
721 | left margin area | text area | right margin area |
722 +--------------------+-------------+---------------------+
724 glyphs[LEFT_MARGIN_AREA] glyphs[RIGHT_MARGIN_AREA]
729 Rows in frame matrices reference glyph memory allocated in a frame
730 glyph pool (see the description of struct glyph_pool). Rows in
731 window matrices on frames having frame matrices reference slices of
732 the glyphs of corresponding rows in the frame matrix.
734 Rows in window matrices on frames having no frame matrices point to
735 glyphs allocated from the heap via xmalloc;
736 glyphs[LEFT_MARGIN_AREA] is the start address of the allocated
737 glyph structure array. */
741 /* Pointers to beginnings of areas. The end of an area A is found at
742 A + 1 in the vector. The last element of the vector is the end
745 Kludge alert: Even if used[TEXT_AREA] == 0, glyphs[TEXT_AREA][0]'s
746 position field is used. It is -1 if this row does not correspond
747 to any text; it is some buffer position if the row corresponds to
748 an empty display line that displays a line end. This is what old
749 redisplay used to do. (Except in code for terminal frames, this
750 kludge is no longer used, I believe. --gerd).
752 See also start, end, displays_text_p and ends_at_zv_p for cleaner
753 ways to do it. The special meaning of positions 0 and -1 will be
754 removed some day, so don't use it in new code. */
755 struct glyph
*glyphs
[1 + LAST_AREA
];
757 /* Number of glyphs actually filled in areas. */
758 short used
[LAST_AREA
];
760 /* Window-relative x and y-position of the top-left corner of this
761 row. If y < 0, this means that eabs (y) pixels of the row are
762 invisible because it is partially visible at the top of a window.
763 If x < 0, this means that eabs (x) pixels of the first glyph of
764 the text area of the row are invisible because the glyph is
765 partially visible. */
768 /* Width of the row in pixels without taking face extension at the
769 end of the row into account, and without counting truncation
770 and continuation glyphs at the end of a row on ttys. */
773 /* Logical ascent/height of this line. The value of ascent is zero
774 and height is 1 on terminal frames. */
777 /* Physical ascent/height of this line. If max_ascent > ascent,
778 this line overlaps the line above it on the display. Otherwise,
779 if max_height > height, this line overlaps the line beneath it. */
780 int phys_ascent
, phys_height
;
782 /* Portion of row that is visible. Partially visible rows may be
783 found at the top and bottom of a window. This is 1 for tty
784 frames. It may be < 0 in case of completely invisible rows. */
787 /* Extra line spacing added after this row. Do not consider this
788 in last row when checking if row is fully visible. */
789 int extra_line_spacing
;
791 /* Hash code. This hash code is available as soon as the row
792 is constructed, i.e. after a call to display_line. */
795 /* First position in this row. This is the text position, including
796 overlay position information etc, where the display of this row
797 started, and can thus be less than the position of the first
798 glyph (e.g. due to invisible text or horizontal scrolling).
799 BIDI Note: In R2L rows, that have its reversed_p flag set, this
800 position is at or beyond the right edge of the row. */
801 struct display_pos start
;
803 /* Text position at the end of this row. This is the position after
804 the last glyph on this row. It can be greater than the last
805 glyph position + 1, due to a newline that ends the line,
806 truncation, invisible text etc. In an up-to-date display, this
807 should always be equal to the start position of the next row.
808 BIDI Note: In R2L rows, this position is at or beyond the left
810 struct display_pos end
;
812 /* The smallest and the largest buffer positions that contributed to
813 glyphs in this row. Note that due to bidi reordering, these are
814 in general different from the text positions stored in `start'
815 and `end' members above, and also different from the buffer
816 positions recorded in the glyphs displayed the leftmost and
817 rightmost on the screen. */
818 struct text_pos minpos
, maxpos
;
820 /* Non-zero means the overlay arrow bitmap is on this line.
821 -1 means use default overlay arrow bitmap, else
822 it specifies actual fringe bitmap number. */
823 int overlay_arrow_bitmap
;
825 /* Left fringe bitmap number (enum fringe_bitmap_type). */
826 unsigned left_user_fringe_bitmap
: FRINGE_ID_BITS
;
828 /* Right fringe bitmap number (enum fringe_bitmap_type). */
829 unsigned right_user_fringe_bitmap
: FRINGE_ID_BITS
;
831 /* Left fringe bitmap number (enum fringe_bitmap_type). */
832 unsigned left_fringe_bitmap
: FRINGE_ID_BITS
;
834 /* Right fringe bitmap number (enum fringe_bitmap_type). */
835 unsigned right_fringe_bitmap
: FRINGE_ID_BITS
;
837 /* Face of the left fringe glyph. */
838 unsigned left_user_fringe_face_id
: FACE_ID_BITS
;
840 /* Face of the right fringe glyph. */
841 unsigned right_user_fringe_face_id
: FACE_ID_BITS
;
843 /* Face of the left fringe glyph. */
844 unsigned left_fringe_face_id
: FACE_ID_BITS
;
846 /* Face of the right fringe glyph. */
847 unsigned right_fringe_face_id
: FACE_ID_BITS
;
849 /* Vertical offset of the left fringe bitmap. */
850 signed left_fringe_offset
: FRINGE_HEIGHT_BITS
;
852 /* Vertical offset of the right fringe bitmap. */
853 signed right_fringe_offset
: FRINGE_HEIGHT_BITS
;
855 /* 1 means that at least one of the left and right fringe bitmaps is
856 periodic and thus depends on the y-position of the row. */
857 unsigned fringe_bitmap_periodic_p
: 1;
859 /* 1 means that we must draw the bitmaps of this row. */
860 unsigned redraw_fringe_bitmaps_p
: 1;
862 /* In a desired matrix, 1 means that this row must be updated. In a
863 current matrix, 0 means that the row has been invalidated, i.e.
864 the row's contents do not agree with what is visible on the
866 unsigned enabled_p
: 1;
868 /* 1 means row displays a text line that is truncated on the left or
870 unsigned truncated_on_left_p
: 1;
871 unsigned truncated_on_right_p
: 1;
873 /* 1 means that this row displays a continued line, i.e. it has a
874 continuation mark at the right side. */
875 unsigned continued_p
: 1;
877 /* 0 means that this row does not contain any text, i.e. it is
878 a blank line at the window and buffer end. */
879 unsigned displays_text_p
: 1;
881 /* 1 means that this line ends at ZV. */
882 unsigned ends_at_zv_p
: 1;
884 /* 1 means the face of the last glyph in the text area is drawn to
885 the right end of the window. This flag is used in
886 update_text_area to optimize clearing to the end of the area. */
887 unsigned fill_line_p
: 1;
889 /* Non-zero means display a bitmap on X frames indicating that this
890 line contains no text and ends in ZV. */
891 unsigned indicate_empty_line_p
: 1;
893 /* 1 means this row contains glyphs that overlap each other because
894 of lbearing or rbearing. */
895 unsigned contains_overlapping_glyphs_p
: 1;
897 /* 1 means this row is as wide as the window it is displayed in, including
898 scroll bars, fringes, and internal borders. This also
899 implies that the row doesn't have marginal areas. */
900 unsigned full_width_p
: 1;
902 /* Non-zero means row is a mode or header-line. */
903 unsigned mode_line_p
: 1;
905 /* 1 in a current row means this row is overlapped by another row. */
906 unsigned overlapped_p
: 1;
908 /* 1 means this line ends in the middle of a character consisting
909 of more than one glyph. Some glyphs have been put in this row,
910 the rest are put in rows below this one. */
911 unsigned ends_in_middle_of_char_p
: 1;
913 /* 1 means this line starts in the middle of a character consisting
914 of more than one glyph. Some glyphs have been put in the
915 previous row, the rest are put in this row. */
916 unsigned starts_in_middle_of_char_p
: 1;
918 /* 1 in a current row means this row overlaps others. */
919 unsigned overlapping_p
: 1;
921 /* 1 means some glyphs in this row are displayed in mouse-face. */
922 unsigned mouse_face_p
: 1;
924 /* 1 means this row was ended by a newline from a string. */
925 unsigned ends_in_newline_from_string_p
: 1;
927 /* 1 means this row width is exactly the width of the window, and the
928 final newline character is hidden in the right fringe. */
929 unsigned exact_window_width_line_p
: 1;
931 /* 1 means this row currently shows the cursor in the right fringe. */
932 unsigned cursor_in_fringe_p
: 1;
934 /* 1 means the last glyph in the row is part of an ellipsis. */
935 unsigned ends_in_ellipsis_p
: 1;
937 /* Non-zero means display a bitmap on X frames indicating that this
938 the first line of the buffer. */
939 unsigned indicate_bob_p
: 1;
941 /* Non-zero means display a bitmap on X frames indicating that this
942 the top line of the window, but not start of the buffer. */
943 unsigned indicate_top_line_p
: 1;
945 /* Non-zero means display a bitmap on X frames indicating that this
946 the last line of the buffer. */
947 unsigned indicate_eob_p
: 1;
949 /* Non-zero means display a bitmap on X frames indicating that this
950 the bottom line of the window, but not end of the buffer. */
951 unsigned indicate_bottom_line_p
: 1;
953 /* Non-zero means the row was reversed to display text in a
954 right-to-left paragraph. */
955 unsigned reversed_p
: 1;
957 /* Continuation lines width at the start of the row. */
958 int continuation_lines_width
;
960 #ifdef HAVE_WINDOW_SYSTEM
961 /* Non-NULL means the current clipping area. This is temporarily
962 set while exposing a region. Coordinates are frame-relative. */
968 /* Get a pointer to row number ROW in matrix MATRIX. If GLYPH_DEBUG
969 is defined to a non-zero value, the function matrix_row checks that
970 we don't try to access rows that are out of bounds. */
973 struct glyph_row
*matrix_row (struct glyph_matrix
*, int);
974 #define MATRIX_ROW(MATRIX, ROW) matrix_row ((MATRIX), (ROW))
976 #define MATRIX_ROW(MATRIX, ROW) ((MATRIX)->rows + (ROW))
979 /* Return a pointer to the row reserved for the mode line in MATRIX.
980 Row MATRIX->nrows - 1 is always reserved for the mode line. */
982 #define MATRIX_MODE_LINE_ROW(MATRIX) \
983 ((MATRIX)->rows + (MATRIX)->nrows - 1)
985 /* Return a pointer to the row reserved for the header line in MATRIX.
986 This is always the first row in MATRIX because that's the only
987 way that works in frame-based redisplay. */
989 #define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows
991 /* Return a pointer to first row in MATRIX used for text display. */
993 #define MATRIX_FIRST_TEXT_ROW(MATRIX) \
994 ((MATRIX)->rows->mode_line_p ? (MATRIX)->rows + 1 : (MATRIX)->rows)
996 /* Return a pointer to the first glyph in the text area of a row.
997 MATRIX is the glyph matrix accessed, and ROW is the row index in
1000 #define MATRIX_ROW_GLYPH_START(MATRIX, ROW) \
1001 (MATRIX_ROW ((MATRIX), (ROW))->glyphs[TEXT_AREA])
1003 /* Return the number of used glyphs in the text area of a row. */
1005 #define MATRIX_ROW_USED(MATRIX, ROW) \
1006 (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA])
1008 /* Return the character/ byte position at which the display of ROW
1009 starts. BIDI Note: this is the smallest character/byte position
1010 among characters in ROW, i.e. the first logical-order character
1011 displayed by ROW, which is not necessarily the smallest horizontal
1014 #define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->minpos.charpos)
1015 #define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->minpos.bytepos)
1017 /* Return the character/ byte position at which ROW ends. BIDI Note:
1018 this is the largest character/byte position among characters in
1019 ROW, i.e. the last logical-order character displayed by ROW, which
1020 is not necessarily the largest horizontal position. */
1022 #define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->maxpos.charpos)
1023 #define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->maxpos.bytepos)
1025 /* Return the vertical position of ROW in MATRIX. */
1027 #define MATRIX_ROW_VPOS(ROW, MATRIX) ((ROW) - (MATRIX)->rows)
1029 /* Return the last glyph row + 1 in MATRIX on window W reserved for
1030 text. If W has a mode line, the last row in the matrix is reserved
1033 #define MATRIX_BOTTOM_TEXT_ROW(MATRIX, W) \
1036 - (WINDOW_WANTS_MODELINE_P ((W)) ? 1 : 0))
1038 /* Non-zero if the face of the last glyph in ROW's text area has
1039 to be drawn to the end of the text area. */
1041 #define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)
1043 /* Set and query the enabled_p flag of glyph row ROW in MATRIX. */
1045 #define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
1046 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0)
1048 #define MATRIX_ROW_ENABLED_P(MATRIX, ROW) \
1049 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p)
1051 /* Non-zero if ROW displays text. Value is non-zero if the row is
1052 blank but displays a line end. */
1054 #define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)
1059 #define MR_PARTIALLY_VISIBLE(ROW) \
1060 ((ROW)->height != (ROW)->visible_height)
1062 #define MR_PARTIALLY_VISIBLE_AT_TOP(W, ROW) \
1063 ((ROW)->y < WINDOW_HEADER_LINE_HEIGHT ((W)))
1065 #define MR_PARTIALLY_VISIBLE_AT_BOTTOM(W, ROW) \
1066 (((ROW)->y + (ROW)->height - (ROW)->extra_line_spacing) \
1067 > WINDOW_BOX_HEIGHT_NO_MODE_LINE ((W)))
1069 /* Non-zero if ROW is not completely visible in window W. */
1071 #define MATRIX_ROW_PARTIALLY_VISIBLE_P(W, ROW) \
1072 (MR_PARTIALLY_VISIBLE ((ROW)) \
1073 && (MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)) \
1074 || MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW))))
1078 /* Non-zero if ROW is partially visible at the top of window W. */
1080 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW) \
1081 (MR_PARTIALLY_VISIBLE ((ROW)) \
1082 && MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)))
1084 /* Non-zero if ROW is partially visible at the bottom of window W. */
1086 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW) \
1087 (MR_PARTIALLY_VISIBLE ((ROW)) \
1088 && MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW)))
1090 /* Return the bottom Y + 1 of ROW. */
1092 #define MATRIX_ROW_BOTTOM_Y(ROW) ((ROW)->y + (ROW)->height)
1094 /* Is ROW the last visible one in the display described by the
1095 iterator structure pointed to by IT?. */
1097 #define MATRIX_ROW_LAST_VISIBLE_P(ROW, IT) \
1098 (MATRIX_ROW_BOTTOM_Y ((ROW)) >= (IT)->last_visible_y)
1100 /* Non-zero if ROW displays a continuation line. */
1102 #define MATRIX_ROW_CONTINUATION_LINE_P(ROW) \
1103 ((ROW)->continuation_lines_width > 0)
1105 /* Non-zero if ROW ends in the middle of a character. This is the
1106 case for continued lines showing only part of a display table entry
1107 or a control char, or an overlay string. */
1109 #define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW) \
1110 ((ROW)->end.dpvec_index > 0 \
1111 || (ROW)->end.overlay_string_index >= 0 \
1112 || (ROW)->ends_in_middle_of_char_p)
1114 /* Non-zero if ROW ends in the middle of an overlay string. */
1116 #define MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P(ROW) \
1117 ((ROW)->end.overlay_string_index >= 0)
1119 /* Non-zero if ROW starts in the middle of a character. See above. */
1121 #define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW) \
1122 ((ROW)->start.dpvec_index > 0 \
1123 || (ROW)->starts_in_middle_of_char_p \
1124 || ((ROW)->start.overlay_string_index >= 0 \
1125 && (ROW)->start.string_pos.charpos > 0))
1127 /* Non-zero means ROW overlaps its predecessor. */
1129 #define MATRIX_ROW_OVERLAPS_PRED_P(ROW) \
1130 ((ROW)->phys_ascent > (ROW)->ascent)
1132 /* Non-zero means ROW overlaps its successor. */
1134 #define MATRIX_ROW_OVERLAPS_SUCC_P(ROW) \
1135 ((ROW)->phys_height - (ROW)->phys_ascent \
1136 > (ROW)->height - (ROW)->ascent)
1138 /* Non-zero means that fonts have been loaded since the last glyph
1139 matrix adjustments. The function redisplay_internal adjusts glyph
1140 matrices when this flag is non-zero. */
1142 extern int fonts_changed_p
;
1144 /* A glyph for a space. */
1146 extern struct glyph space_glyph
;
1148 /* Window being updated by update_window. This is non-null as long as
1149 update_window has not finished, and null otherwise. */
1151 extern struct window
*updated_window
;
1153 /* Glyph row and area updated by update_window_line. */
1155 extern struct glyph_row
*updated_row
;
1156 extern int updated_area
;
1158 /* Non-zero means last display completed. Zero means it was
1161 extern int display_completed
;
1165 /************************************************************************
1167 ************************************************************************/
1169 /* Enumeration for overriding/changing the face to use for drawing
1170 glyphs in draw_glyphs. */
1172 enum draw_glyphs_face
1182 #ifdef HAVE_WINDOW_SYSTEM
1184 /* A sequence of glyphs to be drawn in the same face. */
1188 /* X-origin of the string. */
1191 /* Y-origin and y-position of the base line of this string. */
1194 /* The width of the string, not including a face extension. */
1197 /* The width of the string, including a face extension. */
1198 int background_width
;
1200 /* The height of this string. This is the height of the line this
1201 string is drawn in, and can be different from the height of the
1202 font the string is drawn in. */
1205 /* Number of pixels this string overwrites in front of its x-origin.
1206 This number is zero if the string has an lbearing >= 0; it is
1207 -lbearing, if the string has an lbearing < 0. */
1210 /* Number of pixels this string overwrites past its right-most
1211 nominal x-position, i.e. x + width. Zero if the string's
1212 rbearing is <= its nominal width, rbearing - width otherwise. */
1215 /* The frame on which the glyph string is drawn. */
1218 /* The window on which the glyph string is drawn. */
1221 /* X display and window for convenience. */
1225 /* The glyph row for which this string was built. It determines the
1226 y-origin and height of the string. */
1227 struct glyph_row
*row
;
1229 /* The area within row. */
1230 enum glyph_row_area area
;
1232 /* Characters to be drawn, and number of characters. */
1236 /* A face-override for drawing cursors, mouse face and similar. */
1237 enum draw_glyphs_face hl
;
1239 /* Face in which this string is to be drawn. */
1242 /* Font in which this string is to be drawn. */
1245 /* Non-null means this string describes (part of) a static
1247 struct composition
*cmp
;
1249 /* If not negative, this string describes a compos. */
1252 /* Start and end glyph indices in a glyph-string. */
1253 int cmp_from
, cmp_to
;
1255 /* 1 means this glyph strings face has to be drawn to the right end
1256 of the window's drawing area. */
1257 unsigned extends_to_end_of_line_p
: 1;
1259 /* 1 means the background of this string has been drawn. */
1260 unsigned background_filled_p
: 1;
1262 /* 1 means glyph string must be drawn with 16-bit functions. */
1263 unsigned two_byte_p
: 1;
1265 /* 1 means that the original font determined for drawing this glyph
1266 string could not be loaded. The member `font' has been set to
1267 the frame's default font in this case. */
1268 unsigned font_not_found_p
: 1;
1270 /* 1 means that the face in which this glyph string is drawn has a
1272 unsigned stippled_p
: 1;
1274 #define OVERLAPS_PRED (1 << 0)
1275 #define OVERLAPS_SUCC (1 << 1)
1276 #define OVERLAPS_BOTH (OVERLAPS_PRED | OVERLAPS_SUCC)
1277 #define OVERLAPS_ERASED_CURSOR (1 << 2)
1278 /* Non-zero means only the foreground of this glyph string must be
1279 drawn, and we should use the physical height of the line this
1280 glyph string appears in as clip rect. If the value is
1281 OVERLAPS_ERASED_CURSOR, the clip rect is restricted to the rect
1282 of the erased cursor. OVERLAPS_PRED and OVERLAPS_SUCC mean we
1283 draw overlaps with the preceding and the succeeding rows,
1285 unsigned for_overlaps
: 3;
1287 /* 1 means that all glyphs in this glyph string has the flag
1288 padding_p set, and thus must be drawn one by one to have 1-pixel
1289 width even though the logical width in the font is zero. */
1290 unsigned padding_p
: 1;
1292 /* The GC to use for drawing this glyph string. */
1293 #if defined (HAVE_X_WINDOWS)
1296 #if defined (HAVE_NTGUI)
1301 /* A pointer to the first glyph in the string. This glyph
1302 corresponds to char2b[0]. Needed to draw rectangles if
1303 font_not_found_p is 1. */
1304 struct glyph
*first_glyph
;
1306 /* Image, if any. */
1309 #ifdef HAVE_XWIDGETS
1310 struct xwidget
* xwidget
;
1313 struct glyph_slice slice
;
1315 /* Non-null means the horizontal clipping region starts from the
1316 left edge of *clip_head, and ends with the right edge of
1317 *clip_tail, not including their overhangs. */
1318 struct glyph_string
*clip_head
, *clip_tail
;
1320 /* The current clipping areas. */
1321 NativeRectangle clip
[2];
1323 /* Number of clipping areas. */
1326 int underline_position
;
1328 int underline_thickness
;
1330 struct glyph_string
*next
, *prev
;
1333 #endif /* HAVE_WINDOW_SYSTEM */
1336 /************************************************************************
1338 ************************************************************************/
1340 /* Return the height of the mode line in glyph matrix MATRIX, or zero
1341 if not known. This macro is called under circumstances where
1342 MATRIX might not have been allocated yet. */
1344 #define MATRIX_MODE_LINE_HEIGHT(MATRIX) \
1345 ((MATRIX) && (MATRIX)->rows \
1346 ? MATRIX_MODE_LINE_ROW (MATRIX)->height \
1349 /* Return the height of the header line in glyph matrix MATRIX, or zero
1350 if not known. This macro is called under circumstances where
1351 MATRIX might not have been allocated yet. */
1353 #define MATRIX_HEADER_LINE_HEIGHT(MATRIX) \
1354 ((MATRIX) && (MATRIX)->rows \
1355 ? MATRIX_HEADER_LINE_ROW (MATRIX)->height \
1358 /* Return the desired face id for the mode line of a window, depending
1359 on whether the window is selected or not, or if the window is the
1360 scrolling window for the currently active minibuffer window.
1362 Due to the way display_mode_lines manipulates with the contents of
1363 selected_window, this macro needs three arguments: SELW which is
1364 compared against the current value of selected_window, MBW which is
1365 compared against minibuf_window (if SELW doesn't match), and SCRW
1366 which is compared against minibuf_selected_window (if MBW matches). */
1368 #define CURRENT_MODE_LINE_FACE_ID_3(SELW, MBW, SCRW) \
1369 ((!mode_line_in_non_selected_windows \
1370 || (SELW) == XWINDOW (selected_window) \
1371 || (minibuf_level > 0 \
1372 && !NILP (minibuf_selected_window) \
1373 && (MBW) == XWINDOW (minibuf_window) \
1374 && (SCRW) == XWINDOW (minibuf_selected_window))) \
1375 ? MODE_LINE_FACE_ID \
1376 : MODE_LINE_INACTIVE_FACE_ID)
1379 /* Return the desired face id for the mode line of window W. */
1381 #define CURRENT_MODE_LINE_FACE_ID(W) \
1382 (CURRENT_MODE_LINE_FACE_ID_3((W), XWINDOW (selected_window), (W)))
1384 /* Return the current height of the mode line of window W. If not
1385 known from current_mode_line_height, look at W's current glyph
1386 matrix, or return a default based on the height of the font of the
1387 face `mode-line'. */
1389 #define CURRENT_MODE_LINE_HEIGHT(W) \
1390 (current_mode_line_height >= 0 \
1391 ? current_mode_line_height \
1392 : (MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1393 ? MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1394 : estimate_mode_line_height (XFRAME ((W)->frame), \
1395 CURRENT_MODE_LINE_FACE_ID (W))))
1397 /* Return the current height of the header line of window W. If not
1398 known from current_header_line_height, look at W's current glyph
1399 matrix, or return an estimation based on the height of the font of
1400 the face `header-line'. */
1402 #define CURRENT_HEADER_LINE_HEIGHT(W) \
1403 (current_header_line_height >= 0 \
1404 ? current_header_line_height \
1405 : (MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1406 ? MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1407 : estimate_mode_line_height (XFRAME ((W)->frame), \
1408 HEADER_LINE_FACE_ID)))
1410 /* Return the height of the desired mode line of window W. */
1412 #define DESIRED_MODE_LINE_HEIGHT(W) \
1413 MATRIX_MODE_LINE_HEIGHT ((W)->desired_matrix)
1415 /* Return the height of the desired header line of window W. */
1417 #define DESIRED_HEADER_LINE_HEIGHT(W) \
1418 MATRIX_HEADER_LINE_HEIGHT ((W)->desired_matrix)
1420 /* Value is non-zero if window W wants a mode line. */
1422 #define WINDOW_WANTS_MODELINE_P(W) \
1423 (!MINI_WINDOW_P ((W)) \
1424 && !(W)->pseudo_window_p \
1425 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1426 && BUFFERP ((W)->buffer) \
1427 && !NILP (BVAR (XBUFFER ((W)->buffer), mode_line_format)) \
1428 && WINDOW_TOTAL_LINES (W) > 1)
1430 /* Value is non-zero if window W wants a header line. */
1432 #define WINDOW_WANTS_HEADER_LINE_P(W) \
1433 (!MINI_WINDOW_P ((W)) \
1434 && !(W)->pseudo_window_p \
1435 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1436 && BUFFERP ((W)->buffer) \
1437 && !NILP (BVAR (XBUFFER ((W)->buffer), header_line_format)) \
1438 && WINDOW_TOTAL_LINES (W) > 1 + !NILP (BVAR (XBUFFER ((W)->buffer), mode_line_format)))
1441 /* Return proper value to be used as baseline offset of font that has
1442 ASCENT and DESCENT to draw characters by the font at the vertical
1443 center of the line of frame F.
1445 Here, our task is to find the value of BOFF in the following figure;
1447 -------------------------+-----------+-
1448 -+-+---------+-+ | |
1450 | | | | F_ASCENT F_HEIGHT
1453 | | |-|-+------+-----------|------- baseline
1455 | |---------|-+-+ | |
1457 -+-+---------+-+ F_DESCENT |
1458 -------------------------+-----------+-
1460 -BOFF + DESCENT + (F_HEIGHT - HEIGHT) / 2 = F_DESCENT
1461 BOFF = DESCENT + (F_HEIGHT - HEIGHT) / 2 - F_DESCENT
1462 DESCENT = FONT->descent
1463 HEIGHT = FONT_HEIGHT (FONT)
1464 F_DESCENT = (FRAME_FONT (F)->descent
1465 - F->terminal->output_data.x->baseline_offset)
1466 F_HEIGHT = FRAME_LINE_HEIGHT (F)
1469 #define VCENTER_BASELINE_OFFSET(FONT, F) \
1470 (FONT_DESCENT (FONT) \
1471 + (FRAME_LINE_HEIGHT ((F)) - FONT_HEIGHT ((FONT)) \
1472 + (FRAME_LINE_HEIGHT ((F)) > FONT_HEIGHT ((FONT)))) / 2 \
1473 - (FONT_DESCENT (FRAME_FONT (F)) - FRAME_BASELINE_OFFSET (F)))
1476 /***********************************************************************
1478 ***********************************************************************/
1480 /* Indices of face attributes in Lisp face vectors. Slot zero is the
1483 enum lface_attribute_index
1485 LFACE_FAMILY_INDEX
= 1,
1486 LFACE_FOUNDRY_INDEX
,
1491 LFACE_UNDERLINE_INDEX
,
1492 LFACE_INVERSE_INDEX
,
1493 LFACE_FOREGROUND_INDEX
,
1494 LFACE_BACKGROUND_INDEX
,
1495 LFACE_STIPPLE_INDEX
,
1496 LFACE_OVERLINE_INDEX
,
1497 LFACE_STRIKE_THROUGH_INDEX
,
1500 LFACE_INHERIT_INDEX
,
1501 LFACE_FONTSET_INDEX
,
1506 /* Box types of faces. */
1510 /* No box around text. */
1513 /* Simple box of specified width and color. Default width is 1, and
1514 default color is the foreground color of the face. */
1517 /* Boxes with 3D shadows. Color equals the background color of the
1518 face. Width is specified. */
1524 /* Structure describing a realized face.
1526 For each Lisp face, 0..N realized faces can exist for different
1527 frames and different charsets. Realized faces are built from Lisp
1528 faces and text properties/overlays by merging faces and adding
1529 unspecified attributes from the `default' face. */
1533 /* The id of this face. The id equals the index of this face in the
1534 vector faces_by_id of its face cache. */
1537 #ifdef HAVE_WINDOW_SYSTEM
1539 /* If non-zero, this is a GC that we can use without modification for
1540 drawing the characters in this face. */
1543 /* Background stipple or bitmap used for this face. This is
1544 an id as returned from load_pixmap. */
1547 #else /* not HAVE_WINDOW_SYSTEM */
1552 #endif /* not HAVE_WINDOW_SYSTEM */
1554 /* Pixel value of foreground color for X frames. Color index
1556 unsigned long foreground
;
1558 /* Pixel value or color index of background color. */
1559 unsigned long background
;
1561 /* Pixel value or color index of underline color. */
1562 unsigned long underline_color
;
1564 /* Pixel value or color index of overlined, strike-through, or box
1566 unsigned long overline_color
;
1567 unsigned long strike_through_color
;
1568 unsigned long box_color
;
1572 /* Fontset ID if for this face's fontset. Non-ASCII faces derived
1573 from the same ASCII face have the same fontset. */
1576 /* Pixmap width and height. */
1577 unsigned int pixmap_w
, pixmap_h
;
1579 /* Non-zero means characters in this face have a box that thickness
1580 around them. If it is negative, the absolute value indicates the
1581 thickness, and the horizontal lines of box (top and bottom) are
1582 drawn inside of characters glyph area. The vertical lines of box
1583 (left and right) are drawn as the same way as the case that this
1584 value is positive. */
1587 /* Type of box drawn. A value of FACE_NO_BOX means no box is drawn
1588 around text in this face. A value of FACE_SIMPLE_BOX means a box
1589 of width box_line_width is drawn in color box_color. A value of
1590 FACE_RAISED_BOX or FACE_SUNKEN_BOX means a 3D box is drawn with
1591 shadow colors derived from the background color of the face. */
1592 enum face_box_type box
;
1594 /* If `box' above specifies a 3D type, 1 means use box_color for
1596 unsigned use_box_color_for_shadows_p
: 1;
1598 /* Non-zero if text in this face should be underlined, overlined,
1599 strike-through or have a box drawn around it. */
1600 unsigned underline_p
: 1;
1601 unsigned overline_p
: 1;
1602 unsigned strike_through_p
: 1;
1604 /* 1 means that the colors specified for this face could not be
1605 loaded, and were replaced by default colors, so they shouldn't be
1607 unsigned foreground_defaulted_p
: 1;
1608 unsigned background_defaulted_p
: 1;
1610 /* 1 means that either no color is specified for underlining or that
1611 the specified color couldn't be loaded. Use the foreground
1612 color when drawing in that case. */
1613 unsigned underline_defaulted_p
: 1;
1615 /* 1 means that either no color is specified for the corresponding
1616 attribute or that the specified color couldn't be loaded.
1617 Use the foreground color when drawing in that case. */
1618 unsigned overline_color_defaulted_p
: 1;
1619 unsigned strike_through_color_defaulted_p
: 1;
1620 unsigned box_color_defaulted_p
: 1;
1622 /* TTY appearances. Blinking is not yet implemented. Colors are
1623 found in `lface' with empty color string meaning the default
1624 color of the TTY. */
1625 unsigned tty_bold_p
: 1;
1626 unsigned tty_dim_p
: 1;
1627 unsigned tty_underline_p
: 1;
1628 unsigned tty_alt_charset_p
: 1;
1629 unsigned tty_reverse_p
: 1;
1630 unsigned tty_blinking_p
: 1;
1632 /* 1 means that colors of this face may not be freed because they
1633 have been copied bitwise from a base face (see
1635 unsigned colors_copied_bitwise_p
: 1;
1637 /* If non-zero, use overstrike (to simulate bold-face). */
1638 unsigned overstrike
: 1;
1640 /* NOTE: this is not used yet, but eventually this impl should be done
1641 similarly to overstrike */
1643 /* If non-zero, use geometric rotation (to simulate italic). */
1644 unsigned synth_ital
: 1;
1647 /* The Lisp face attributes this face realizes. All attributes
1648 in this vector are non-nil. */
1649 Lisp_Object lface
[LFACE_VECTOR_SIZE
];
1651 /* The hash value of this face. */
1654 /* Next and previous face in hash collision list of face cache. */
1655 struct face
*next
, *prev
;
1657 /* If this face is an ASCII face, this points to this face itself.
1658 Otherwise, this points to an ASCII face that has the same
1659 attributes except the font. */
1660 struct face
*ascii_face
;
1662 /* Extra member that a font-driver uses privately. */
1667 /* Color index indicating that face uses a terminal's default color. */
1669 #define FACE_TTY_DEFAULT_COLOR ((unsigned long) -1)
1671 /* Color index indicating that face uses an unknown foreground color. */
1673 #define FACE_TTY_DEFAULT_FG_COLOR ((unsigned long) -2)
1675 /* Color index indicating that face uses an unknown background color. */
1677 #define FACE_TTY_DEFAULT_BG_COLOR ((unsigned long) -3)
1679 /* Non-zero if FACE was realized for unibyte use. */
1681 #define FACE_UNIBYTE_P(FACE) ((FACE)->charset < 0)
1684 /* IDs of important faces known by the C face code. These are the IDs
1685 of the faces for CHARSET_ASCII. */
1691 MODE_LINE_INACTIVE_FACE_ID
,
1694 HEADER_LINE_FACE_ID
,
1700 VERTICAL_BORDER_FACE_ID
,
1701 BASIC_FACE_ID_SENTINEL
1704 #define MAX_FACE_ID ((1 << FACE_ID_BITS) - 1)
1706 /* A cache of realized faces. Each frame has its own cache because
1707 Emacs allows different frame-local face definitions. */
1711 /* Hash table of cached realized faces. */
1712 struct face
**buckets
;
1714 /* Back-pointer to the frame this cache belongs to. */
1717 /* A vector of faces so that faces can be referenced by an ID. */
1718 struct face
**faces_by_id
;
1720 /* The allocated size, and number of used slots of faces_by_id. */
1724 /* Flag indicating that attributes of the `menu' face have been
1726 unsigned menu_face_changed_p
: 1;
1730 /* Prepare face FACE for use on frame F. This must be called before
1731 using X resources of FACE. */
1733 #define PREPARE_FACE_FOR_DISPLAY(F, FACE) \
1734 if ((FACE)->gc == 0) \
1735 prepare_face_for_display ((F), (FACE)); \
1739 /* Return a pointer to the face with ID on frame F, or null if such a
1740 face doesn't exist. */
1742 #define FACE_FROM_ID(F, ID) \
1743 (UNSIGNED_CMP (ID, <, FRAME_FACE_CACHE (F)->used) \
1744 ? FRAME_FACE_CACHE (F)->faces_by_id[ID] \
1747 #ifdef HAVE_WINDOW_SYSTEM
1749 /* Non-zero if FACE is suitable for displaying character CHAR. */
1751 #define FACE_SUITABLE_FOR_ASCII_CHAR_P(FACE, CHAR) \
1752 ((FACE) == (FACE)->ascii_face)
1754 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) \
1755 (ASCII_CHAR_P (CHAR) \
1756 ? FACE_SUITABLE_FOR_ASCII_CHAR_P(FACE) \
1757 : face_suitable_for_char_p ((FACE), (CHAR)))
1759 /* Return the id of the realized face on frame F that is like the face
1760 with id ID but is suitable for displaying character CHAR.
1761 This macro is only meaningful for multibyte character CHAR. */
1763 #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) \
1764 ((ASCII_CHAR_P (CHAR) || CHAR_BYTE8_P (CHAR)) \
1765 ? (FACE)->ascii_face->id \
1766 : face_for_char ((F), (FACE), (CHAR), (POS), (OBJECT)))
1768 #else /* not HAVE_WINDOW_SYSTEM */
1770 #define FACE_SUITABLE_FOR_ASCII_CHAR_P(FACE, CHAR) 1
1771 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) 1
1772 #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) ((FACE)->id)
1774 #endif /* not HAVE_WINDOW_SYSTEM */
1776 /* Non-zero means face attributes have been changed since the last
1777 redisplay. Used in redisplay_internal. */
1779 extern int face_change_count
;
1781 /* For reordering of bidirectional text. */
1782 #define BIDI_MAXLEVEL 64
1784 /* Data type for describing the bidirectional character types. The
1785 first 7 must be at the beginning, because they are the only values
1786 valid in the `bidi_type' member of `struct glyph'; we only reserve
1787 3 bits for it, so we cannot use there values larger than 7.
1789 The order of members must be in sync with the 8th element of the
1790 member of unidata-prop-alist (in admin/unidata/unidata-gen.el) for
1791 Unicode character property `bidi-class'. */
1794 STRONG_L
, /* strong left-to-right */
1795 STRONG_R
, /* strong right-to-left */
1796 WEAK_EN
, /* european number */
1797 WEAK_AN
, /* arabic number */
1798 WEAK_BN
, /* boundary neutral */
1799 NEUTRAL_B
, /* paragraph separator */
1800 STRONG_AL
, /* arabic right-to-left letter */
1801 LRE
, /* left-to-right embedding */
1802 LRO
, /* left-to-right override */
1803 RLE
, /* right-to-left embedding */
1804 RLO
, /* right-to-left override */
1805 PDF
, /* pop directional format */
1806 WEAK_ES
, /* european number separator */
1807 WEAK_ET
, /* european number terminator */
1808 WEAK_CS
, /* common separator */
1809 WEAK_NSM
, /* non-spacing mark */
1810 NEUTRAL_S
, /* segment separator */
1811 NEUTRAL_WS
, /* whitespace */
1812 NEUTRAL_ON
/* other neutrals */
1815 /* The basic directionality data type. */
1816 typedef enum { NEUTRAL_DIR
, L2R
, R2L
} bidi_dir_t
;
1818 /* Data type for storing information about characters we need to
1820 struct bidi_saved_info
{
1821 EMACS_INT bytepos
, charpos
; /* character's buffer position */
1822 bidi_type_t type
; /* character's resolved bidi type */
1823 bidi_type_t type_after_w1
; /* original type of the character, after W1 */
1824 bidi_type_t orig_type
; /* type as we found it in the buffer */
1827 /* Data type for keeping track of saved embedding levels and override
1828 status information. */
1831 bidi_dir_t override
;
1834 /* Data type for storing information about a string being iterated on. */
1835 struct bidi_string_data
{
1836 Lisp_Object lstring
; /* Lisp string to reorder, or nil */
1837 const unsigned char *s
; /* string data, or NULL if reordering buffer */
1838 EMACS_INT schars
; /* the number of characters in the string,
1839 excluding the terminating null */
1840 EMACS_INT bufpos
; /* buffer position of lstring, or 0 if N/A */
1841 unsigned from_disp_str
: 1; /* 1 means the string comes from a
1843 unsigned unibyte
: 1; /* 1 means the string is unibyte */
1846 /* Data type for reordering bidirectional text. */
1848 EMACS_INT bytepos
; /* iterator's position in buffer/string */
1850 int ch
; /* character at that position, or u+FFFC
1851 ("object replacement character") for a run
1852 of characters covered by a display string */
1853 EMACS_INT nchars
; /* its "length", usually 1; it's > 1 for a run
1854 of characters covered by a display string */
1855 EMACS_INT ch_len
; /* its length in bytes */
1856 bidi_type_t type
; /* bidi type of this character, after
1857 resolving weak and neutral types */
1858 bidi_type_t type_after_w1
; /* original type, after overrides and W1 */
1859 bidi_type_t orig_type
; /* original type, as found in the buffer */
1860 int resolved_level
; /* final resolved level of this character */
1861 int invalid_levels
; /* how many PDFs to ignore */
1862 int invalid_rl_levels
; /* how many PDFs from RLE/RLO to ignore */
1863 int prev_was_pdf
; /* if non-zero, previous char was PDF */
1864 struct bidi_saved_info prev
; /* info about previous character */
1865 struct bidi_saved_info last_strong
; /* last-seen strong directional char */
1866 struct bidi_saved_info next_for_neutral
; /* surrounding characters for... */
1867 struct bidi_saved_info prev_for_neutral
; /* ...resolving neutrals */
1868 struct bidi_saved_info next_for_ws
; /* character after sequence of ws */
1869 EMACS_INT next_en_pos
; /* pos. of next char for determining ET type */
1870 bidi_type_t next_en_type
; /* type of char at next_en_pos */
1871 EMACS_INT ignore_bn_limit
; /* position until which to ignore BNs */
1872 bidi_dir_t sor
; /* direction of start-of-run in effect */
1873 int scan_dir
; /* direction of text scan, 1: forw, -1: back */
1874 EMACS_INT disp_pos
; /* position of display string after ch */
1875 int disp_prop
; /* if non-zero, there really is a
1876 `display' property/string at disp_pos;
1877 if 2, the property is a `space' spec */
1878 int stack_idx
; /* index of current data on the stack */
1879 /* Note: Everything from here on is not copied/saved when the bidi
1880 iterator state is saved, pushed, or popped. So only put here
1881 stuff that is not part of the bidi iterator's state! */
1882 struct bidi_stack level_stack
[BIDI_MAXLEVEL
]; /* stack of embedding levels */
1883 struct bidi_string_data string
; /* string to reorder */
1884 bidi_dir_t paragraph_dir
; /* current paragraph direction */
1885 EMACS_INT separator_limit
; /* where paragraph separator should end */
1886 unsigned first_elt
: 1; /* if non-zero, examine current char first */
1887 unsigned new_paragraph
: 1; /* if non-zero, we expect a new paragraph */
1888 unsigned frame_window_p
: 1; /* non-zero if displaying on a GUI frame */
1891 /* Value is non-zero when the bidi iterator is at base paragraph
1893 #define BIDI_AT_BASE_LEVEL(BIDI_IT) \
1894 ((BIDI_IT).resolved_level == (BIDI_IT).level_stack[0].level)
1897 /***********************************************************************
1899 ***********************************************************************/
1901 /* Structure used to describe where and how to draw a fringe bitmap.
1902 WHICH is the fringe bitmap to draw. WD and H is the (adjusted)
1903 width and height of the bitmap, DH is the height adjustment (if
1904 bitmap is periodic). X and Y are frame coordinates of the area to
1905 display the bitmap, DY is relative offset of the bitmap into that
1906 area. BX, NX, BY, NY specifies the area to clear if the bitmap
1907 does not fill the entire area. FACE is the fringe face. */
1909 struct draw_fringe_bitmap_params
1911 int which
; /* enum fringe_bitmap_type */
1912 unsigned short *bits
;
1916 unsigned cursor_p
: 1;
1917 unsigned overlay_p
: 1;
1921 #define MAX_FRINGE_BITMAPS (1<<FRINGE_ID_BITS)
1924 /***********************************************************************
1926 ***********************************************************************/
1928 /* Iteration over things to display in current_buffer or in a string.
1930 The iterator handles:
1932 1. Overlay strings (after-string, before-string).
1934 3. Invisible text properties.
1935 4. Selective display.
1936 5. Translation of characters via display tables.
1937 6. Translation of control characters to the forms `\003' or `^C'.
1938 7. `glyph' and `space-width' properties.
1940 Iterators are initialized by calling init_iterator or one of the
1941 equivalent functions below. A call to get_next_display_element
1942 loads the iterator structure with information about what next to
1943 display. A call to set_iterator_to_next increments the iterator's
1946 Characters from overlay strings, display table entries or control
1947 character translations are returned one at a time. For example, if
1948 we have a text of `a\x01' where `a' has a display table definition
1949 of `cd' and the control character is displayed with a leading
1950 arrow, then the iterator will return:
1952 Call Return Source Call next
1953 -----------------------------------------------------------------
1954 next c display table move
1955 next d display table move
1956 next ^ control char move
1957 next A control char move
1959 The same mechanism is also used to return characters for ellipses
1960 displayed at the end of invisible text.
1962 CAVEAT: Under some circumstances, move_.* functions can be called
1963 asynchronously, e.g. when computing a buffer position from an x and
1964 y pixel position. This means that these functions and functions
1965 called from them SHOULD NOT USE xmalloc and alike. See also the
1966 comment at the start of xdisp.c. */
1968 /* Enumeration describing what kind of display element an iterator is
1969 loaded with after a call to get_next_display_element. */
1971 enum display_element_type
1973 /* A normal character. */
1976 /* A composition (static and automatic). */
1979 /* A glyphless character (e.g. ZWNJ, LRE). */
1985 /* A flexible width and height space. */
1988 /* End of buffer or string. */
1991 /* Truncation glyphs. Never returned by get_next_display_element.
1992 Used to get display information about truncation glyphs via
1996 /* Continuation glyphs. See the comment for IT_TRUNCATION. */
1999 #ifdef HAVE_XWIDGETS
2005 /* An enumerator for each text property that has a meaning for display
2014 COMPOSITION_PROP_IDX
,
2016 /* Not a property. Used to indicate changes in overlays. */
2023 /* An enumerator for the method of wrapping long lines. */
2025 enum line_wrap_method
2032 /* An enumerator for the method of displaying glyphless characters. */
2034 enum glyphless_display_method
2036 /* Display a thin (1-pixel width) space. On a TTY, display a
2037 1-character width space. */
2038 GLYPHLESS_DISPLAY_THIN_SPACE
,
2039 /* Display an empty box of proper width. */
2040 GLYPHLESS_DISPLAY_EMPTY_BOX
,
2041 /* Display an acronym string in a box. */
2042 GLYPHLESS_DISPLAY_ACRONYM
,
2043 /* Display the hexadecimal code of the character in a box. */
2044 GLYPHLESS_DISPLAY_HEX_CODE
2055 /* Input sources for fetching characters or data to display.
2056 The input source is found in the `method' field. */
2059 GET_FROM_BUFFER
= 0,
2060 GET_FROM_DISPLAY_VECTOR
,
2065 #ifdef HAVE_XWIDGETS
2071 /* FIXME: What is this? Why 5? */
2072 #define IT_STACK_SIZE 5
2074 /* Iterator for composition (both for static and automatic). */
2075 struct composition_it
2077 /* Next position at which to check the composition. */
2079 /* ID number of the composition or glyph-string. If negative, we
2080 are not iterating over a composition now. */
2082 /* If non-negative, character that triggers the automatic
2083 composition at `stop_pos', and this is an automatic composition.
2084 If negative, this is a static composition. This is set to -2
2085 temporarily if searching of composition reach a limit or a
2088 /* If this is an automatic composition, index of a rule for making
2089 the automatic composition. Provided that ELT is an element of
2090 Vcomposition_function_table for CH, (nth ELT RULE_IDX) is the
2091 rule for the composition. */
2093 /* If this is an automatic composition, how many characters to look
2094 back from the position where a character triggering the
2095 composition exists. */
2097 /* If non-negative, number of glyphs of the glyph-string. */
2099 /* Nonzero iff the composition is created while buffer is scanned in
2100 reverse order, and thus the grapheme clusters must be rendered
2101 from the last to the first. */
2104 /** The following members contain information about the current
2105 grapheme cluster. */
2106 /* Position of the first character of the current grapheme cluster. */
2108 /* Number of characters and bytes of the current grapheme cluster. */
2110 /* Indices of the glyphs for the current grapheme cluster. */
2112 /* Width of the current grapheme cluster in units of pixels on a
2113 graphic display and in units of canonical characters on a
2114 terminal display. */
2120 /* The window in which we iterate over current_buffer (or a string). */
2124 /* The window's frame. */
2127 /* Method to use to load this structure with the next display element. */
2128 enum it_method method
;
2130 /* The next position at which to check for face changes, invisible
2131 text, overlay strings, end of text etc., which see. */
2132 EMACS_INT stop_charpos
;
2134 /* Previous stop position, i.e. the last one before the current
2135 iterator position in `current'. */
2136 EMACS_INT prev_stop
;
2138 /* Last stop position iterated across whose bidi embedding level is
2139 equal to the current paragraph's base embedding level. */
2140 EMACS_INT base_level_stop
;
2142 /* Maximum string or buffer position + 1. ZV when iterating over
2144 EMACS_INT end_charpos
;
2146 /* C string to iterate over. Non-null means get characters from
2147 this string, otherwise characters are read from current_buffer
2149 const unsigned char *s
;
2151 /* Number of characters in the string (s, or it->string) we iterate
2153 EMACS_INT string_nchars
;
2155 /* Start and end of a visible region; -1 if the region is not
2156 visible in the window. */
2157 EMACS_INT region_beg_charpos
, region_end_charpos
;
2159 /* Position at which redisplay end trigger functions should be run. */
2160 EMACS_INT redisplay_end_trigger_charpos
;
2162 /* 1 means multibyte characters are enabled. */
2163 unsigned multibyte_p
: 1;
2165 /* 1 means window has a mode line at its top. */
2166 unsigned header_line_p
: 1;
2168 /* 1 means `string' is the value of a `display' property.
2169 Don't handle some `display' properties in these strings. */
2170 unsigned string_from_display_prop_p
: 1;
2172 /* 1 means `string' comes from a `line-prefix' or `wrap-prefix'
2174 unsigned string_from_prefix_prop_p
: 1;
2176 /* 1 means we are iterating an object that came from a value of a
2177 `display' property. */
2178 unsigned from_disp_prop_p
: 1;
2180 /* When METHOD == next_element_from_display_vector,
2181 this is 1 if we're doing an ellipsis. Otherwise meaningless. */
2182 unsigned ellipsis_p
: 1;
2184 /* True means cursor shouldn't be displayed here. */
2185 unsigned avoid_cursor_p
: 1;
2187 /* Display table in effect or null for none. */
2188 struct Lisp_Char_Table
*dp
;
2190 /* Current display table vector to return characters from and its
2191 end. dpvec null means we are not returning characters from a
2192 display table entry; current.dpvec_index gives the current index
2193 into dpvec. This same mechanism is also used to return
2194 characters from translated control characters, i.e. `\003' or
2196 Lisp_Object
*dpvec
, *dpend
;
2198 /* Length in bytes of the char that filled dpvec. A value of zero
2199 means that no such character is involved. A negative value means
2200 the rest of the line from the current iterator position onwards
2201 is hidden by selective display or ellipsis. */
2204 /* Face id to use for all characters in display vector. -1 if unused. */
2207 /* Face id of the iterator saved in case a glyph from dpvec contains
2208 a face. The face is restored when all glyphs from dpvec have
2212 /* Vector of glyphs for control character translation. The pointer
2213 dpvec is set to ctl_chars when a control character is translated.
2214 This vector is also used for incomplete multibyte character
2215 translation (e.g \222\244). Such a character is at most 4 bytes,
2216 thus we need at most 16 bytes here. */
2217 Lisp_Object ctl_chars
[16];
2219 /* Initial buffer or string position of the iterator, before skipping
2220 over display properties and invisible text. */
2221 struct display_pos start
;
2223 /* Current buffer or string position of the iterator, including
2224 position in overlay strings etc. */
2225 struct display_pos current
;
2227 /* Total number of overlay strings to process. This can be >
2228 OVERLAY_STRING_CHUNK_SIZE. */
2229 int n_overlay_strings
;
2231 /* The charpos where n_overlay_strings was calculated. This should
2232 be set at the same time as n_overlay_strings. It is needed
2233 because we show before-strings at the start of invisible text;
2234 see handle_invisible_prop in xdisp.c. */
2235 EMACS_INT overlay_strings_charpos
;
2237 /* Vector of overlays to process. Overlay strings are processed
2238 OVERLAY_STRING_CHUNK_SIZE at a time. */
2239 #define OVERLAY_STRING_CHUNK_SIZE 16
2240 Lisp_Object overlay_strings
[OVERLAY_STRING_CHUNK_SIZE
];
2242 /* For each overlay string, the overlay it came from. */
2243 Lisp_Object string_overlays
[OVERLAY_STRING_CHUNK_SIZE
];
2245 /* If non-nil, a Lisp string being processed. If
2246 current.overlay_string_index >= 0, this is an overlay string from
2250 /* If non-nil, we are processing a string that came
2251 from a `display' property given by an overlay. */
2252 Lisp_Object from_overlay
;
2254 /* Stack of saved values. New entries are pushed when we begin to
2255 process an overlay string or a string from a `glyph' property.
2256 Entries are popped when we return to deliver display elements
2257 from what we previously had. */
2258 struct iterator_stack_entry
2262 EMACS_INT end_charpos
;
2263 EMACS_INT stop_charpos
;
2264 EMACS_INT prev_stop
;
2265 EMACS_INT base_level_stop
;
2266 struct composition_it cmp_it
;
2269 /* Save values specific to a given method. */
2271 /* method == GET_FROM_IMAGE */
2274 struct it_slice slice
;
2277 /* method == GET_FROM_COMPOSITION */
2281 /* method == GET_FROM_STRETCH */
2285 #ifdef HAVE_XWIDGETS
2286 /* method == GET_FROM_XWIDGET */
2289 struct xwidget
* xwidget
;
2294 /* current text and display positions. */
2295 struct text_pos position
;
2296 struct display_pos current
;
2297 Lisp_Object from_overlay
;
2298 enum glyph_row_area area
;
2299 enum it_method method
;
2300 bidi_dir_t paragraph_embedding
;
2301 unsigned multibyte_p
: 1;
2302 unsigned string_from_display_prop_p
: 1;
2303 unsigned string_from_prefix_prop_p
: 1;
2304 unsigned display_ellipsis_p
: 1;
2305 unsigned avoid_cursor_p
: 1;
2307 unsigned from_disp_prop_p
: 1;
2308 enum line_wrap_method line_wrap
;
2310 /* properties from display property that are reset by another display property. */
2312 Lisp_Object space_width
;
2313 Lisp_Object font_height
;
2315 stack
[IT_STACK_SIZE
];
2317 /* Stack pointer. */
2320 /* -1 means selective display hides everything between a \r and the
2321 next newline; > 0 means hide lines indented more than that value. */
2322 EMACS_INT selective
;
2324 /* An enumeration describing what the next display element is
2325 after a call to get_next_display_element. */
2326 enum display_element_type what
;
2331 /* Setting of buffer-local variable selective-display-ellipsis. */
2332 unsigned selective_display_ellipsis_p
: 1;
2334 /* 1 means control characters are translated into the form `^C'
2335 where the `^' can be replaced by a display table entry. */
2336 unsigned ctl_arrow_p
: 1;
2338 /* Non-zero means that the current face has a box. */
2339 unsigned face_box_p
: 1;
2341 /* Non-null means that the current character is the first in a run
2342 of characters with box face. */
2343 unsigned start_of_box_run_p
: 1;
2345 /* Non-zero means that the current character is the last in a run
2346 of characters with box face. */
2347 unsigned end_of_box_run_p
: 1;
2349 /* 1 means overlay strings at end_charpos have been processed. */
2350 unsigned overlay_strings_at_end_processed_p
: 1;
2352 /* 1 means to ignore overlay strings at current pos, as they have
2353 already been processed. */
2354 unsigned ignore_overlay_strings_at_pos_p
: 1;
2356 /* 1 means the actual glyph is not available in the current
2358 unsigned glyph_not_available_p
: 1;
2360 /* 1 means the next line in display_line continues a character
2361 consisting of more than one glyph, and some glyphs of this
2362 character have been put on the previous line. */
2363 unsigned starts_in_middle_of_char_p
: 1;
2365 /* If 1, saved_face_id contains the id of the face in front of text
2366 skipped due to selective display. */
2367 unsigned face_before_selective_p
: 1;
2369 /* If 1, adjust current glyph so it does not increase current row
2370 descent/ascent (line-height property). Reset after this glyph. */
2371 unsigned constrain_row_ascent_descent_p
: 1;
2373 enum line_wrap_method line_wrap
;
2375 /* The ID of the default face to use. One of DEFAULT_FACE_ID,
2376 MODE_LINE_FACE_ID, etc, depending on what we are displaying. */
2379 /* If `what' == IT_CHARACTER, the character and the length in bytes
2380 of its multibyte sequence. The character comes from a buffer or
2381 a string. It may be different from the character displayed in
2382 case that unibyte_display_via_language_environment is set.
2384 If `what' == IT_COMPOSITION, the first component of a composition
2385 and length in bytes of the composition.
2387 If `what' is anything else, these two are undefined (will
2388 probably hold values for the last IT_CHARACTER or IT_COMPOSITION
2389 traversed by the iterator.
2391 The values are updated by get_next_display_element, so they are
2392 out of sync with the value returned by IT_CHARPOS between the
2393 time set_iterator_to_next advances the position and the time
2394 get_next_display_element loads the new values into c and len. */
2397 /* If what == IT_COMPOSITION, iterator substructure for the
2399 struct composition_it cmp_it
;
2401 /* The character to display, possibly translated to multibyte if
2402 multibyte_p is zero or unibyte_display_via_language_environment
2403 is set. This is set after get_next_display_element has been
2404 called. If we are setting it->C directly before calling
2405 PRODUCE_GLYPHS, this should be set beforehand too. */
2406 int char_to_display
;
2408 /* If what == IT_GLYPHLESS, the method to display such a
2410 enum glyphless_display_method glyphless_method
;
2412 /* If what == IT_IMAGE, the id of the image to display. */
2415 #ifdef HAVE_XWIDGETS
2416 /* If what == IT_XWIDGET*/
2417 struct xwidget
* xwidget
;
2419 /* Values from `slice' property. */
2420 struct it_slice slice
;
2422 /* Value of the `space-width' property, if any; nil if none. */
2423 Lisp_Object space_width
;
2425 /* Computed from the value of the `raise' property. */
2428 /* Number of columns per \t. */
2431 /* Value of the `height' property, if any; nil if none. */
2432 Lisp_Object font_height
;
2434 /* Object and position where the current display element came from.
2435 Object is normally the buffer which is being rendered, but it can
2436 also be a Lisp string in case the current display element comes
2437 from an overlay string or from a display string (before- or
2438 after-string). It may also be nil when a C string is being
2439 rendered, e.g., during mode-line or header-line update. It can
2440 also be a cons cell of the form `(space ...)', when we produce a
2441 stretch glyph from a `display' specification. Finally, it can be
2442 a zero-valued Lisp integer, but only temporarily, when we are
2443 producing special glyphs for display purposes, like truncation
2444 and continuation glyphs, or blanks that extend each line to the
2445 edge of the window on a TTY.
2447 Position is the current iterator position in object. */
2449 struct text_pos position
;
2451 /* Width in pixels of truncation and continuation glyphs. */
2452 short truncation_pixel_width
, continuation_pixel_width
;
2454 /* First and last visible x-position in the display area. If window
2455 is hscrolled by n columns, first_visible_x == n * FRAME_COLUMN_WIDTH
2456 (f), and last_visible_x == pixel width of W + first_visible_x. */
2457 int first_visible_x
, last_visible_x
;
2459 /* Last visible y-position + 1 in the display area without a mode
2460 line, if the window has one. */
2463 /* Default amount of additional space in pixels between lines (for
2464 window systems only.) */
2465 int extra_line_spacing
;
2467 /* Max extra line spacing added in this row. */
2468 int max_extra_line_spacing
;
2470 /* Override font height information for this glyph.
2471 Used if override_ascent >= 0. Cleared after this glyph. */
2472 int override_ascent
, override_descent
, override_boff
;
2474 /* If non-null, glyphs are produced in glyph_row with each call to
2476 struct glyph_row
*glyph_row
;
2478 /* The area of glyph_row to which glyphs are added. */
2479 enum glyph_row_area area
;
2481 /* Number of glyphs needed for the last character requested via
2482 produce_glyphs. This is 1 except for tabs. */
2485 /* Width of the display element in pixels. Result of
2489 /* Current, maximum logical, and maximum physical line height
2490 information. Result of produce_glyphs. */
2491 int ascent
, descent
, max_ascent
, max_descent
;
2492 int phys_ascent
, phys_descent
, max_phys_ascent
, max_phys_descent
;
2494 /* Current x pixel position within the display line. This value
2495 does not include the width of continuation lines in front of the
2496 line. The value of current_x is automatically incremented by
2497 pixel_width with each call to produce_glyphs. */
2500 /* Accumulated width of continuation lines. If > 0, this means we
2501 are currently in a continuation line. This is initially zero and
2502 incremented/reset by display_line, move_it_to etc. */
2503 int continuation_lines_width
;
2505 /* Buffer position that ends the buffer text line being iterated.
2506 This is normally the position after the newline at EOL. If this
2507 is the last line of the buffer and it doesn't have a newline,
2508 value is ZV/ZV_BYTE. Set and used only if IT->bidi_p, for
2509 setting the end position of glyph rows produced for continuation
2510 lines, see display_line. */
2511 struct text_pos eol_pos
;
2513 /* Current y-position. Automatically incremented by the height of
2514 glyph_row in move_it_to and display_line. */
2517 /* Vertical matrix position of first text line in window. */
2520 /* Current vertical matrix position, or line number. Automatically
2521 incremented by move_it_to and display_line. */
2524 /* Horizontal matrix position reached in move_it_in_display_line.
2525 Only set there, not in display_line. */
2528 /* Left fringe bitmap number (enum fringe_bitmap_type). */
2529 unsigned left_user_fringe_bitmap
: FRINGE_ID_BITS
;
2531 /* Right fringe bitmap number (enum fringe_bitmap_type). */
2532 unsigned right_user_fringe_bitmap
: FRINGE_ID_BITS
;
2534 /* Face of the left fringe glyph. */
2535 unsigned left_user_fringe_face_id
: FACE_ID_BITS
;
2537 /* Face of the right fringe glyph. */
2538 unsigned right_user_fringe_face_id
: FACE_ID_BITS
;
2540 /* Non-zero means we need to reorder bidirectional text for display
2541 in the visual order. */
2542 unsigned bidi_p
: 1;
2544 /* For iterating over bidirectional text. */
2545 struct bidi_it bidi_it
;
2546 bidi_dir_t paragraph_embedding
;
2550 /* Access to positions of iterator IT. */
2552 #define IT_CHARPOS(IT) CHARPOS ((IT).current.pos)
2553 #define IT_BYTEPOS(IT) BYTEPOS ((IT).current.pos)
2554 #define IT_STRING_CHARPOS(IT) CHARPOS ((IT).current.string_pos)
2555 #define IT_STRING_BYTEPOS(IT) BYTEPOS ((IT).current.string_pos)
2557 /* Test if IT has reached the end of its buffer or string. This will
2558 only work after get_next_display_element has been called. */
2560 #define ITERATOR_AT_END_P(IT) ((IT)->what == IT_EOB)
2562 /* Non-zero means IT is at the end of a line. This is the case if it
2563 is either on a newline or on a carriage return and selective
2564 display hides the rest of the line. */
2566 #define ITERATOR_AT_END_OF_LINE_P(IT) \
2567 ((IT)->what == IT_CHARACTER \
2568 && ((IT)->c == '\n' \
2569 || ((IT)->c == '\r' && (IT)->selective)))
2571 /* Call produce_glyphs or FRAME_RIF->produce_glyphs, if set. Shortcut
2572 to avoid the function call overhead. */
2574 #define PRODUCE_GLYPHS(IT) \
2576 if ((IT)->glyph_row != NULL && (IT)->bidi_p) \
2578 if ((IT)->bidi_it.paragraph_dir == R2L) \
2579 (IT)->glyph_row->reversed_p = 1; \
2581 (IT)->glyph_row->reversed_p = 0; \
2583 if (FRAME_RIF ((IT)->f) != NULL) \
2584 FRAME_RIF ((IT)->f)->produce_glyphs ((IT)); \
2586 produce_glyphs ((IT)); \
2587 if ((IT)->glyph_row != NULL) \
2588 inhibit_free_realized_faces = 1; \
2591 /* Bit-flags indicating what operation move_it_to should perform. */
2593 enum move_operation_enum
2595 /* Stop if specified x-position is reached. */
2598 /* Stop if specified y-position is reached. */
2601 /* Stop if specified vpos is reached. */
2602 MOVE_TO_VPOS
= 0x04,
2604 /* Stop if specified buffer or string position is reached. */
2610 /***********************************************************************
2611 Window-based redisplay interface
2612 ***********************************************************************/
2614 /* Structure used to describe runs of lines that must be scrolled. */
2618 /* Source and destination y pixel position. */
2619 int desired_y
, current_y
;
2621 /* Source and destination vpos in matrix. */
2622 int desired_vpos
, current_vpos
;
2624 /* Height in pixels, number of glyph rows. */
2629 /* Handlers for setting frame parameters. */
2631 typedef void (*frame_parm_handler
) (struct frame
*, Lisp_Object
, Lisp_Object
);
2634 /* Structure holding system-dependent interface functions needed
2635 for window-based redisplay. */
2637 struct redisplay_interface
2639 /* Handlers for setting frame parameters. */
2640 frame_parm_handler
*frame_parm_handlers
;
2642 /* Produce glyphs/get display metrics for the display element IT is
2644 void (*produce_glyphs
) (struct it
*it
);
2646 /* Write or insert LEN glyphs from STRING at the nominal output
2648 void (*write_glyphs
) (struct glyph
*string
, int len
);
2649 void (*insert_glyphs
) (struct glyph
*start
, int len
);
2651 /* Clear from nominal output position to X. X < 0 means clear
2652 to right end of display. */
2653 void (*clear_end_of_line
) (int x
);
2655 /* Function to call to scroll the display as described by RUN on
2657 void (*scroll_run_hook
) (struct window
*w
, struct run
*run
);
2659 /* Function to call after a line in a display has been completely
2660 updated. Used to draw truncation marks and alike. DESIRED_ROW
2661 is the desired row which has been updated. */
2662 void (*after_update_window_line_hook
) (struct glyph_row
*desired_row
);
2664 /* Function to call before beginning to update window W in
2665 window-based redisplay. */
2666 void (*update_window_begin_hook
) (struct window
*w
);
2668 /* Function to call after window W has been updated in window-based
2669 redisplay. CURSOR_ON_P non-zero means switch cursor on.
2670 MOUSE_FACE_OVERWRITTEN_P non-zero means that some lines in W
2671 that contained glyphs in mouse-face were overwritten, so we
2672 have to update the mouse highlight. */
2673 void (*update_window_end_hook
) (struct window
*w
, int cursor_on_p
,
2674 int mouse_face_overwritten_p
);
2676 /* Move cursor to row/column position VPOS/HPOS, pixel coordinates
2677 Y/X. HPOS/VPOS are window-relative row and column numbers and X/Y
2678 are window-relative pixel positions. */
2679 void (*cursor_to
) (int vpos
, int hpos
, int y
, int x
);
2681 /* Flush the display of frame F. For X, this is XFlush. */
2682 void (*flush_display
) (struct frame
*f
);
2684 /* Flush the display of frame F if non-NULL. This is called
2685 during redisplay, and should be NULL on systems which flush
2686 automatically before reading input. */
2687 void (*flush_display_optional
) (struct frame
*f
);
2689 /* Clear the mouse highlight in window W, if there is any. */
2690 void (*clear_window_mouse_face
) (struct window
*w
);
2692 /* Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
2694 void (*get_glyph_overhangs
) (struct glyph
*glyph
, struct frame
*f
,
2695 int *left
, int *right
);
2697 /* Fix the display of AREA of ROW in window W for overlapping rows.
2698 This function is called from redraw_overlapping_rows after
2699 desired rows have been made current. */
2700 void (*fix_overlapping_area
) (struct window
*w
, struct glyph_row
*row
,
2701 enum glyph_row_area area
, int);
2703 #ifdef HAVE_WINDOW_SYSTEM
2705 /* Draw a fringe bitmap in window W of row ROW using parameters P. */
2706 void (*draw_fringe_bitmap
) (struct window
*w
, struct glyph_row
*row
,
2707 struct draw_fringe_bitmap_params
*p
);
2709 /* Define and destroy fringe bitmap no. WHICH. */
2710 void (*define_fringe_bitmap
) (int which
, unsigned short *bits
,
2712 void (*destroy_fringe_bitmap
) (int which
);
2714 /* Compute left and right overhang of glyph string S.
2715 A NULL pointer if platform does not support this. */
2716 void (*compute_glyph_string_overhangs
) (struct glyph_string
*s
);
2718 /* Draw a glyph string S. */
2719 void (*draw_glyph_string
) (struct glyph_string
*s
);
2721 /* Define cursor CURSOR on frame F. */
2722 void (*define_frame_cursor
) (struct frame
*f
, Cursor cursor
);
2724 /* Clear the area at (X,Y,WIDTH,HEIGHT) of frame F. */
2725 void (*clear_frame_area
) (struct frame
*f
, int x
, int y
,
2726 int width
, int height
);
2728 /* Draw specified cursor CURSOR_TYPE of width CURSOR_WIDTH
2729 at row GLYPH_ROW on window W if ON_P is 1. If ON_P is
2730 0, don't draw cursor. If ACTIVE_P is 1, system caret
2731 should track this cursor (when applicable). */
2732 void (*draw_window_cursor
) (struct window
*w
,
2733 struct glyph_row
*glyph_row
,
2735 int cursor_type
, int cursor_width
,
2736 int on_p
, int active_p
);
2738 /* Draw vertical border for window W from (X,Y_0) to (X,Y_1). */
2739 void (*draw_vertical_window_border
) (struct window
*w
,
2740 int x
, int y_0
, int y_1
);
2742 /* Shift display of frame F to make room for inserted glyphs.
2743 The area at pixel (X,Y) of width WIDTH and height HEIGHT is
2744 shifted right by SHIFT_BY pixels. */
2745 void (*shift_glyphs_for_insert
) (struct frame
*f
,
2746 int x
, int y
, int width
,
2747 int height
, int shift_by
);
2749 #endif /* HAVE_WINDOW_SYSTEM */
2753 /***********************************************************************
2755 ***********************************************************************/
2757 #ifdef HAVE_WINDOW_SYSTEM
2759 /* Structure forward declarations. */
2764 /* Each image format (JPEG, TIFF, ...) supported is described by
2765 a structure of the type below. */
2769 /* A symbol uniquely identifying the image type, .e.g `jpeg'. */
2772 /* Check that SPEC is a valid image specification for the given
2773 image type. Value is non-zero if SPEC is valid. */
2774 int (* valid_p
) (Lisp_Object spec
);
2776 /* Load IMG which is used on frame F from information contained in
2777 IMG->spec. Value is non-zero if successful. */
2778 int (* load
) (struct frame
*f
, struct image
*img
);
2780 /* Free resources of image IMG which is used on frame F. */
2781 void (* free
) (struct frame
*f
, struct image
*img
);
2783 /* Next in list of all supported image types. */
2784 struct image_type
*next
;
2788 /* Structure describing an image. Specific image formats like XBM are
2789 converted into this form, so that display only has to deal with
2790 this type of image. */
2794 /* The time in seconds at which the image was last displayed. Set
2795 in prepare_image_for_display. */
2798 /* Pixmaps of the image. */
2799 Pixmap pixmap
, mask
;
2801 /* Colors allocated for this image, if any. Allocated via xmalloc. */
2802 unsigned long *colors
;
2805 /* A single `background color' for this image, for the use of anyone that
2806 cares about such a thing. Only valid if the `background_valid' field
2807 is true. This should generally be accessed by calling the accessor
2808 macro `IMAGE_BACKGROUND', which will heuristically calculate a value
2810 unsigned long background
;
2812 /* Foreground and background colors of the frame on which the image
2814 unsigned long frame_foreground
, frame_background
;
2816 /* True if this image has a `transparent' background -- that is, is
2817 uses an image mask. The accessor macro for this is
2818 `IMAGE_BACKGROUND_TRANSPARENT'. */
2819 unsigned background_transparent
: 1;
2821 /* True if the `background' and `background_transparent' fields are
2822 valid, respectively. */
2823 unsigned background_valid
: 1, background_transparent_valid
: 1;
2825 /* Width and height of the image. */
2828 /* These values are used for the rectangles displayed for images
2829 that can't be loaded. */
2830 #define DEFAULT_IMAGE_WIDTH 30
2831 #define DEFAULT_IMAGE_HEIGHT 30
2833 /* Top/left and bottom/right corner pixel of actual image data.
2834 Used by four_corners_best to consider the real image data,
2835 rather than looking at the optional image margin. */
2837 #define TOP_CORNER 0
2838 #define LEFT_CORNER 1
2839 #define BOT_CORNER 2
2840 #define RIGHT_CORNER 3
2842 /* Percent of image height used as ascent. A value of
2843 CENTERED_IMAGE_ASCENT means draw the image centered on the
2846 #define DEFAULT_IMAGE_ASCENT 50
2847 #define CENTERED_IMAGE_ASCENT -1
2849 /* Lisp specification of this image. */
2852 /* List of "references" followed to build the image.
2853 Typically will just contain the name of the image file.
2854 Used to allow fine-grained cache flushing. */
2855 Lisp_Object dependencies
;
2857 /* Relief to draw around the image. */
2860 /* Optional margins around the image. This includes the relief. */
2861 int hmargin
, vmargin
;
2863 /* Reference to the type of the image. */
2864 struct image_type
*type
;
2866 /* 1 means that loading the image failed. Don't try again. */
2867 unsigned load_failed_p
;
2869 /* A place for image types to store additional data. It is marked
2871 Lisp_Object lisp_data
;
2873 /* Hash value of image specification to speed up comparisons. */
2876 /* Image id of this image. */
2879 /* Hash collision chain. */
2880 struct image
*next
, *prev
;
2884 /* Cache of images. Each frame has a cache. X frames with the same
2885 x_display_info share their caches. */
2889 /* Hash table of images. */
2890 struct image
**buckets
;
2892 /* Vector mapping image ids to images. */
2893 struct image
**images
;
2895 /* Allocated size of `images'. */
2898 /* Number of images in the cache. */
2901 /* Reference count (number of frames sharing this cache). */
2906 /* Value is a pointer to the image with id ID on frame F, or null if
2907 no image with that id exists. */
2909 #define IMAGE_FROM_ID(F, ID) \
2910 (((ID) >= 0 && (ID) < (FRAME_IMAGE_CACHE (F)->used)) \
2911 ? FRAME_IMAGE_CACHE (F)->images[ID] \
2914 /* Size of bucket vector of image caches. Should be prime. */
2916 #define IMAGE_CACHE_BUCKETS_SIZE 1001
2918 #endif /* HAVE_WINDOW_SYSTEM */
2922 /***********************************************************************
2924 ***********************************************************************/
2926 /* Enumeration defining where to find tool-bar item information in
2927 tool-bar items vectors stored with frames. Each tool-bar item
2928 occupies TOOL_BAR_ITEM_NSLOTS elements in such a vector. */
2930 enum tool_bar_item_idx
2932 /* The key of the tool-bar item. Used to remove items when a binding
2933 for `undefined' is found. */
2936 /* Non-nil if item is enabled. */
2937 TOOL_BAR_ITEM_ENABLED_P
,
2939 /* Non-nil if item is selected (pressed). */
2940 TOOL_BAR_ITEM_SELECTED_P
,
2943 TOOL_BAR_ITEM_CAPTION
,
2945 /* Image(s) to display. This is either a single image specification
2946 or a vector of specifications. */
2947 TOOL_BAR_ITEM_IMAGES
,
2950 TOOL_BAR_ITEM_BINDING
,
2952 /* Button type. One of nil (default button), t (a separator),
2953 `:radio', or `:toggle'. The latter two currently do nothing. */
2959 /* Icon file name of right to left image when an RTL locale is used. */
2960 TOOL_BAR_ITEM_RTL_IMAGE
,
2962 /* Label to show when text labels are enabled. */
2963 TOOL_BAR_ITEM_LABEL
,
2965 /* If we shall show the label only below the icon and not beside it. */
2966 TOOL_BAR_ITEM_VERT_ONLY
,
2968 /* Sentinel = number of slots in tool_bar_items occupied by one
2970 TOOL_BAR_ITEM_NSLOTS
2974 /* An enumeration for the different images that can be specified
2975 for a tool-bar item. */
2977 enum tool_bar_item_image
2979 TOOL_BAR_IMAGE_ENABLED_SELECTED
,
2980 TOOL_BAR_IMAGE_ENABLED_DESELECTED
,
2981 TOOL_BAR_IMAGE_DISABLED_SELECTED
,
2982 TOOL_BAR_IMAGE_DISABLED_DESELECTED
2985 #define DEFAULT_TOOL_BAR_LABEL_SIZE 14
2987 /* Default values of the above variables. */
2989 #define DEFAULT_TOOL_BAR_BUTTON_MARGIN 4
2990 #define DEFAULT_TOOL_BAR_BUTTON_RELIEF 1
2992 /* The height in pixels of the default tool-bar images. */
2994 #define DEFAULT_TOOL_BAR_IMAGE_HEIGHT 24
2997 /***********************************************************************
2998 Terminal Capabilities
2999 ***********************************************************************/
3001 /* Each of these is a bit representing a terminal `capability' (bold,
3002 inverse, etc). They are or'd together to specify the set of
3003 capabilities being queried for when calling `tty_capable_p' (which
3004 returns true if the terminal supports all of them). */
3006 #define TTY_CAP_INVERSE 0x01
3007 #define TTY_CAP_UNDERLINE 0x02
3008 #define TTY_CAP_BOLD 0x04
3009 #define TTY_CAP_DIM 0x08
3010 #define TTY_CAP_BLINK 0x10
3011 #define TTY_CAP_ALT_CHARSET 0x20
3014 /***********************************************************************
3016 ***********************************************************************/
3018 /* Defined in bidi.c */
3020 extern void bidi_init_it (EMACS_INT
, EMACS_INT
, int, struct bidi_it
*);
3021 extern void bidi_move_to_visually_next (struct bidi_it
*);
3022 extern void bidi_paragraph_init (bidi_dir_t
, struct bidi_it
*, int);
3023 extern int bidi_mirror_char (int);
3024 extern void bidi_push_it (struct bidi_it
*);
3025 extern void bidi_pop_it (struct bidi_it
*);
3026 extern void *bidi_shelve_cache (void);
3027 extern void bidi_unshelve_cache (void *, int);
3029 /* Defined in xdisp.c */
3031 struct glyph_row
*row_containing_pos (struct window
*, EMACS_INT
,
3033 struct glyph_row
*, int);
3034 int line_bottom_y (struct it
*);
3035 int display_prop_intangible_p (Lisp_Object
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
3036 void resize_echo_area_exactly (void);
3037 int resize_mini_window (struct window
*, int);
3038 #if defined USE_TOOLKIT_SCROLL_BARS && !defined USE_GTK
3039 void set_vertical_scroll_bar (struct window
*);
3041 int try_window (Lisp_Object
, struct text_pos
, int);
3042 void window_box (struct window
*, int, int *, int *, int *, int *);
3043 int window_box_height (struct window
*);
3044 int window_text_bottom_y (struct window
*);
3045 int window_box_width (struct window
*, int);
3046 int window_box_left (struct window
*, int);
3047 int window_box_left_offset (struct window
*, int);
3048 int window_box_right (struct window
*, int);
3049 int window_box_right_offset (struct window
*, int);
3050 int estimate_mode_line_height (struct frame
*, enum face_id
);
3051 void pixel_to_glyph_coords (struct frame
*, int, int, int *, int *,
3052 NativeRectangle
*, int);
3053 void remember_mouse_glyph (struct frame
*, int, int, NativeRectangle
*);
3055 void mark_window_display_accurate (Lisp_Object
, int);
3056 void redisplay_preserve_echo_area (int);
3057 void init_iterator (struct it
*, struct window
*, EMACS_INT
,
3058 EMACS_INT
, struct glyph_row
*, enum face_id
);
3059 void init_iterator_to_row_start (struct it
*, struct window
*,
3060 struct glyph_row
*);
3061 void start_display (struct it
*, struct window
*, struct text_pos
);
3062 void move_it_to (struct it
*, EMACS_INT
, int, int, int, int);
3063 void move_it_vertically (struct it
*, int);
3064 void move_it_vertically_backward (struct it
*, int);
3065 void move_it_by_lines (struct it
*, int);
3066 void move_it_past_eol (struct it
*);
3067 void move_it_in_display_line (struct it
*it
,
3068 EMACS_INT to_charpos
, int to_x
,
3069 enum move_operation_enum op
);
3070 int in_display_vector_p (struct it
*);
3071 int frame_mode_line_height (struct frame
*);
3072 extern Lisp_Object Qtool_bar
;
3073 extern int redisplaying_p
;
3074 extern int help_echo_showing_p
;
3075 extern int current_mode_line_height
, current_header_line_height
;
3076 extern Lisp_Object help_echo_string
, help_echo_window
;
3077 extern Lisp_Object help_echo_object
, previous_help_echo_string
;
3078 extern EMACS_INT help_echo_pos
;
3079 extern struct frame
*last_mouse_frame
;
3080 extern int last_tool_bar_item
;
3081 extern void reseat_at_previous_visible_line_start (struct it
*);
3082 extern Lisp_Object
lookup_glyphless_char_display (int, struct it
*);
3083 extern EMACS_INT
compute_display_string_pos (struct text_pos
*,
3084 struct bidi_string_data
*,
3086 extern EMACS_INT
compute_display_string_end (EMACS_INT
,
3087 struct bidi_string_data
*);
3088 extern void produce_stretch_glyph (struct it
*);
3091 #ifdef HAVE_WINDOW_SYSTEM
3094 extern void dump_glyph_string (struct glyph_string
*) EXTERNALLY_VISIBLE
;
3097 extern void x_get_glyph_overhangs (struct glyph
*, struct frame
*,
3099 extern void x_produce_glyphs (struct it
*);
3101 extern void x_write_glyphs (struct glyph
*, int);
3102 extern void x_insert_glyphs (struct glyph
*, int len
);
3103 extern void x_clear_end_of_line (int);
3105 extern struct cursor_pos output_cursor
;
3107 extern void x_fix_overlapping_area (struct window
*, struct glyph_row
*,
3108 enum glyph_row_area
, int);
3109 extern void draw_phys_cursor_glyph (struct window
*,
3111 enum draw_glyphs_face
);
3112 extern void get_phys_cursor_geometry (struct window
*, struct glyph_row
*,
3113 struct glyph
*, int *, int *, int *);
3114 extern void erase_phys_cursor (struct window
*);
3115 extern void display_and_set_cursor (struct window
*,
3116 int, int, int, int, int);
3118 extern void set_output_cursor (struct cursor_pos
*);
3119 extern void x_cursor_to (int, int, int, int);
3121 extern void x_update_cursor (struct frame
*, int);
3122 extern void x_clear_cursor (struct window
*);
3123 extern void x_draw_vertical_border (struct window
*w
);
3125 extern int get_glyph_string_clip_rects (struct glyph_string
*,
3126 NativeRectangle
*, int);
3127 extern void get_glyph_string_clip_rect (struct glyph_string
*,
3128 NativeRectangle
*nr
);
3129 extern Lisp_Object
find_hot_spot (Lisp_Object
, int, int);
3131 extern void handle_tool_bar_click (struct frame
*,
3132 int, int, int, unsigned int);
3134 extern void expose_frame (struct frame
*, int, int, int, int);
3135 extern int x_intersect_rectangles (XRectangle
*, XRectangle
*,
3137 #endif /* HAVE_WINDOW_SYSTEM */
3139 extern void note_mouse_highlight (struct frame
*, int, int);
3140 extern void x_clear_window_mouse_face (struct window
*);
3141 extern void cancel_mouse_face (struct frame
*);
3142 extern int clear_mouse_face (Mouse_HLInfo
*);
3143 extern int cursor_in_mouse_face_p (struct window
*w
);
3144 extern void tty_draw_row_with_mouse_face (struct window
*, struct glyph_row
*,
3145 int, int, enum draw_glyphs_face
);
3147 /* Flags passed to try_window. */
3148 #define TRY_WINDOW_CHECK_MARGINS (1 << 0)
3149 #define TRY_WINDOW_IGNORE_FONTS_CHANGE (1 << 1)
3151 int lookup_fringe_bitmap (Lisp_Object
);
3152 void draw_fringe_bitmap (struct window
*, struct glyph_row
*, int);
3153 void draw_row_fringe_bitmaps (struct window
*, struct glyph_row
*);
3154 int draw_window_fringes (struct window
*, int);
3155 int update_window_fringes (struct window
*, int);
3156 void compute_fringe_widths (struct frame
*, int);
3159 void w32_init_fringe (struct redisplay_interface
*);
3160 void w32_reset_fringes (void);
3163 extern unsigned row_hash (struct glyph_row
*);
3165 /* Defined in image.c */
3167 #ifdef HAVE_WINDOW_SYSTEM
3169 extern int x_bitmap_height (struct frame
*, ptrdiff_t);
3170 extern int x_bitmap_width (struct frame
*, ptrdiff_t);
3171 extern int x_bitmap_pixmap (struct frame
*, ptrdiff_t);
3172 extern void x_reference_bitmap (struct frame
*, ptrdiff_t);
3173 extern ptrdiff_t x_create_bitmap_from_data (struct frame
*, char *,
3174 unsigned int, unsigned int);
3175 extern ptrdiff_t x_create_bitmap_from_file (struct frame
*, Lisp_Object
);
3176 #if defined HAVE_XPM && defined HAVE_X_WINDOWS && !defined USE_GTK
3177 extern ptrdiff_t x_create_bitmap_from_xpm_data (struct frame
*, const char **);
3179 #ifndef x_destroy_bitmap
3180 extern void x_destroy_bitmap (struct frame
*, ptrdiff_t);
3182 extern void x_destroy_all_bitmaps (Display_Info
*);
3183 extern int x_create_bitmap_mask (struct frame
*, ptrdiff_t);
3184 extern Lisp_Object
x_find_image_file (Lisp_Object
);
3186 void x_kill_gs_process (Pixmap
, struct frame
*);
3187 struct image_cache
*make_image_cache (void);
3188 void free_image_cache (struct frame
*);
3189 void clear_image_caches (Lisp_Object
);
3190 void mark_image_cache (struct image_cache
*);
3191 int valid_image_p (Lisp_Object
);
3192 void prepare_image_for_display (struct frame
*, struct image
*);
3193 ptrdiff_t lookup_image (struct frame
*, Lisp_Object
);
3195 unsigned long image_background (struct image
*, struct frame
*,
3196 XImagePtr_or_DC ximg
);
3197 int image_background_transparent (struct image
*, struct frame
*,
3198 XImagePtr_or_DC mask
);
3200 int image_ascent (struct image
*, struct face
*, struct glyph_slice
*);
3204 /* Defined in sysdep.c */
3206 void get_tty_size (int, int *, int *);
3207 void request_sigio (void);
3208 void unrequest_sigio (void);
3209 int tabs_safe_p (int);
3210 void init_baud_rate (int);
3211 void init_sigio (int);
3213 /* Defined in xfaces.c */
3215 #ifdef HAVE_X_WINDOWS
3216 void x_free_colors (struct frame
*, unsigned long *, int);
3219 void update_face_from_frame_parameter (struct frame
*, Lisp_Object
,
3221 Lisp_Object
tty_color_name (struct frame
*, int);
3222 void clear_face_cache (int);
3223 unsigned long load_color (struct frame
*, struct face
*, Lisp_Object
,
3224 enum lface_attribute_index
);
3225 void unload_color (struct frame
*, unsigned long);
3226 char *choose_face_font (struct frame
*, Lisp_Object
*, Lisp_Object
,
3228 void prepare_face_for_display (struct frame
*, struct face
*);
3229 int xstrcasecmp (const char *, const char *);
3230 int lookup_named_face (struct frame
*, Lisp_Object
, int);
3231 int lookup_basic_face (struct frame
*, int);
3232 int smaller_face (struct frame
*, int, int);
3233 int face_with_height (struct frame
*, int, int);
3234 int lookup_derived_face (struct frame
*, Lisp_Object
, int, int);
3235 void init_frame_faces (struct frame
*);
3236 void free_frame_faces (struct frame
*);
3237 void recompute_basic_faces (struct frame
*);
3238 int face_at_buffer_position (struct window
*w
, EMACS_INT pos
,
3239 EMACS_INT region_beg
, EMACS_INT region_end
,
3240 EMACS_INT
*endptr
, EMACS_INT limit
,
3241 int mouse
, int base_face_id
);
3242 int face_for_overlay_string (struct window
*w
, EMACS_INT pos
,
3243 EMACS_INT region_beg
, EMACS_INT region_end
,
3244 EMACS_INT
*endptr
, EMACS_INT limit
,
3245 int mouse
, Lisp_Object overlay
);
3246 int face_at_string_position (struct window
*w
, Lisp_Object string
,
3247 EMACS_INT pos
, EMACS_INT bufpos
,
3248 EMACS_INT region_beg
, EMACS_INT region_end
,
3249 EMACS_INT
*endptr
, enum face_id
, int mouse
);
3250 int merge_faces (struct frame
*, Lisp_Object
, EMACS_INT
, int);
3251 int compute_char_face (struct frame
*, int, Lisp_Object
);
3252 void free_all_realized_faces (Lisp_Object
);
3253 extern Lisp_Object Qforeground_color
, Qbackground_color
;
3254 extern char unspecified_fg
[], unspecified_bg
[];
3256 /* Defined in xfns.c */
3258 #ifdef HAVE_X_WINDOWS
3259 void gamma_correct (struct frame
*, XColor
*);
3262 void gamma_correct (struct frame
*, COLORREF
*);
3265 #ifdef HAVE_WINDOW_SYSTEM
3267 void x_implicitly_set_name (struct frame
*, Lisp_Object
, Lisp_Object
);
3269 extern Lisp_Object tip_frame
;
3270 extern Window tip_window
;
3271 EXFUN (Fx_hide_tip
, 0);
3272 extern void start_hourglass (void);
3273 extern void cancel_hourglass (void);
3274 extern int hourglass_started (void);
3275 extern int hourglass_shown_p
;
3276 struct atimer
; /* Defined in atimer.h. */
3277 /* If non-null, an asynchronous timer that, when it expires, displays
3278 an hourglass cursor on all frames. */
3279 extern struct atimer
*hourglass_atimer
;
3281 /* Each GUI implements these. FIXME: move into RIF. */
3282 extern void show_hourglass (struct atimer
*);
3283 extern void hide_hourglass (void);
3285 /* Returns the background color of IMG, calculating one heuristically if
3286 necessary. If non-zero, XIMG is an existing XImage object to use for
3289 #define IMAGE_BACKGROUND(img, f, ximg) \
3290 ((img)->background_valid \
3291 ? (img)->background \
3292 : image_background (img, f, ximg))
3294 /* Returns true if IMG has a `transparent' background, using heuristics
3295 to decide if necessary. If non-zero, MASK is an existing XImage
3296 object to use for the heuristic. */
3298 #define IMAGE_BACKGROUND_TRANSPARENT(img, f, mask) \
3299 ((img)->background_transparent_valid \
3300 ? (img)->background_transparent \
3301 : image_background_transparent (img, f, mask))
3303 #endif /* HAVE_WINDOW_SYSTEM */
3306 /* Defined in xmenu.c */
3308 int popup_activated (void);
3310 extern Lisp_Object
buffer_posn_from_coords (struct window
*,
3312 struct display_pos
*,
3314 int *, int *, int *, int *);
3315 extern Lisp_Object
mode_line_string (struct window
*, enum window_part
,
3316 int *, int *, EMACS_INT
*,
3318 int *, int *, int *, int *);
3319 extern Lisp_Object
marginal_area_string (struct window
*, enum window_part
,
3320 int *, int *, EMACS_INT
*,
3322 int *, int *, int *, int *);
3323 extern void redraw_frame (struct frame
*);
3324 extern void cancel_line (int, struct frame
*);
3325 extern void init_desired_glyphs (struct frame
*);
3326 extern int update_frame (struct frame
*, int, int);
3327 extern void bitch_at_user (void);
3328 void adjust_glyphs (struct frame
*);
3329 void free_glyphs (struct frame
*);
3330 void free_window_matrices (struct window
*);
3331 void check_glyph_memory (void);
3332 void mirrored_line_dance (struct glyph_matrix
*, int, int, int *, char *);
3333 void clear_glyph_matrix (struct glyph_matrix
*);
3334 void clear_current_matrices (struct frame
*f
);
3335 void clear_desired_matrices (struct frame
*);
3336 void shift_glyph_matrix (struct window
*, struct glyph_matrix
*,
3338 void rotate_matrix (struct glyph_matrix
*, int, int, int);
3339 void increment_matrix_positions (struct glyph_matrix
*,
3340 int, int, EMACS_INT
, EMACS_INT
);
3341 void blank_row (struct window
*, struct glyph_row
*, int);
3342 void enable_glyph_matrix_rows (struct glyph_matrix
*, int, int, int);
3343 void clear_glyph_row (struct glyph_row
*);
3344 void prepare_desired_row (struct glyph_row
*);
3345 void set_window_update_flags (struct window
*, int);
3346 void update_single_window (struct window
*, int);
3347 void do_pending_window_change (int);
3348 void change_frame_size (struct frame
*, int, int, int, int, int);
3349 void init_display (void);
3350 void syms_of_display (void);
3351 extern Lisp_Object Qredisplay_dont_pause
;
3352 void spec_glyph_lookup_face (struct window
*, GLYPH
*);
3354 /* Defined in terminal.c */
3356 extern void ring_bell (struct frame
*);
3357 extern void update_begin (struct frame
*);
3358 extern void update_end (struct frame
*);
3359 extern void set_terminal_window (struct frame
*, int);
3360 extern void cursor_to (struct frame
*, int, int);
3361 extern void raw_cursor_to (struct frame
*, int, int);
3362 extern void clear_to_end (struct frame
*);
3363 extern void clear_frame (struct frame
*);
3364 extern void clear_end_of_line (struct frame
*, int);
3365 extern void write_glyphs (struct frame
*, struct glyph
*, int);
3366 extern void insert_glyphs (struct frame
*, struct glyph
*, int);
3367 extern void delete_glyphs (struct frame
*, int);
3368 extern void ins_del_lines (struct frame
*, int, int);
3370 extern struct terminal
*init_initial_terminal (void);
3373 /* Defined in term.c */
3375 extern void tty_turn_off_insert (struct tty_display_info
*);
3376 extern int string_cost (const char *);
3377 extern int per_line_cost (const char *);
3378 extern void calculate_costs (struct frame
*);
3379 extern void produce_glyphs (struct it
*);
3380 extern void produce_special_glyphs (struct it
*, enum display_element_type
);
3381 extern int tty_capable_p (struct tty_display_info
*, unsigned, unsigned long, unsigned long);
3382 extern void set_tty_color_mode (struct tty_display_info
*, struct frame
*);
3383 extern struct terminal
*get_named_tty (const char *);
3384 EXFUN (Ftty_type
, 1);
3385 EXFUN (Fcontrolling_tty_p
, 1);
3386 extern void create_tty_output (struct frame
*);
3387 extern struct terminal
*init_tty (const char *, const char *, int);
3388 extern void tty_append_glyph (struct it
*);
3391 /* Defined in scroll.c */
3393 extern int scrolling_max_lines_saved (int, int, int *, int *, int *);
3394 extern void do_line_insertion_deletion_costs (struct frame
*, const char *,
3395 const char *, const char *,
3396 const char *, const char *,
3398 void scrolling_1 (struct frame
*, int, int, int, int *, int *, int *,
3401 /* Defined in frame.c */
3403 #ifdef HAVE_WINDOW_SYSTEM
3405 /* Types we might convert a resource string into. */
3413 RES_TYPE_BOOLEAN_NUMBER
3416 extern Lisp_Object
x_get_arg (Display_Info
*, Lisp_Object
,
3417 Lisp_Object
, const char *, const char *class,
3418 enum resource_types
);
3419 extern Lisp_Object
x_frame_get_and_record_arg (struct frame
*, Lisp_Object
,
3421 const char *, const char *,
3422 enum resource_types
);
3423 extern Lisp_Object
x_default_parameter (struct frame
*, Lisp_Object
,
3424 Lisp_Object
, Lisp_Object
,
3425 const char *, const char *,
3426 enum resource_types
);
3428 #endif /* HAVE_WINDOW_SYSTEM */
3430 #endif /* not DISPEXTERN_H_INCLUDED */