1 /* Interface definitions for display code.
2 Copyright (C) 1985, 1993, 1994, 1997, 1998, 1999, 2000, 2001, 2002, 2003
3 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 2, or (at your option)
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; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>. */
24 #ifndef DISPEXTERN_H_INCLUDED
25 #define DISPEXTERN_H_INCLUDED
31 #include <X11/Intrinsic.h>
32 #endif /* USE_X_TOOLKIT */
34 #else /* !HAVE_X_WINDOWS */
36 /* X-related stuff used by non-X gui code. */
40 unsigned short red
, green
, blue
;
45 #endif /* HAVE_X_WINDOWS */
52 typedef struct x_display_info Display_Info
;
53 typedef XImage
* XImagePtr
;
54 typedef XImagePtr XImagePtr_or_DC
;
55 #define NativeRectangle XRectangle
60 typedef struct w32_display_info Display_Info
;
61 typedef XImage
*XImagePtr
;
62 typedef HDC XImagePtr_or_DC
;
67 typedef struct mac_display_info Display_Info
;
68 /* Mac equivalent of XImage. */
69 typedef Pixmap XImagePtr
;
70 typedef XImagePtr XImagePtr_or_DC
;
73 #ifndef NativeRectangle
74 #define NativeRectangle int
77 /* Structure forward declarations. Some are here because function
78 prototypes below reference structure types before their definition
79 in this file. Some are here because not every file including
80 dispextern.h also includes frame.h and windows.h. */
90 /* Values returned from coordinates_in_window. */
105 /* Number of bits allocated to store fringe bitmap numbers. */
106 #define FRINGE_ID_BITS 8
110 /***********************************************************************
112 ***********************************************************************/
114 /* If GLYPH_DEBUG is non-zero, additional checks are activated. Turn
115 it off by defining the macro GLYPH_DEBUG to zero. */
118 #define GLYPH_DEBUG 0
121 /* Macros to include code only if GLYPH_DEBUG != 0. */
124 #define IF_DEBUG(X) X
125 #define xassert(X) do {if (!(X)) abort ();} while (0)
127 #define IF_DEBUG(X) (void) 0
128 #define xassert(X) (void) 0
131 /* Macro for displaying traces of redisplay. If Emacs was compiled
132 with GLYPH_DEBUG != 0, the variable trace_redisplay_p can be set to
133 a non-zero value in debugging sessions to activate traces. */
137 extern int trace_redisplay_p
;
141 if (trace_redisplay_p) \
146 #else /* GLYPH_DEBUG == 0 */
148 #define TRACE(X) (void) 0
150 #endif /* GLYPH_DEBUG == 0 */
154 /***********************************************************************
156 ***********************************************************************/
158 /* Starting with Emacs 20.3, characters from strings and buffers have
159 both a character and a byte position associated with them. The
160 following structure holds such a pair of positions. */
164 /* Character position. */
167 /* Corresponding byte position. */
171 /* Access character and byte position of POS in a functional form. */
173 #define BYTEPOS(POS) (POS).bytepos
174 #define CHARPOS(POS) (POS).charpos
176 /* Set character position of POS to CHARPOS, byte position to BYTEPOS. */
178 #define SET_TEXT_POS(POS, CHARPOS, BYTEPOS) \
179 ((POS).charpos = (CHARPOS), (POS).bytepos = BYTEPOS)
181 /* Increment text position POS. */
183 #define INC_TEXT_POS(POS, MULTIBYTE_P) \
188 INC_POS ((POS).bytepos); \
194 /* Decrement text position POS. */
196 #define DEC_TEXT_POS(POS, MULTIBYTE_P) \
201 DEC_POS ((POS).bytepos); \
207 /* Set text position POS from marker MARKER. */
209 #define SET_TEXT_POS_FROM_MARKER(POS, MARKER) \
210 (CHARPOS (POS) = marker_position ((MARKER)), \
211 BYTEPOS (POS) = marker_byte_position ((MARKER)))
213 /* Set marker MARKER from text position POS. */
215 #define SET_MARKER_FROM_TEXT_POS(MARKER, POS) \
216 set_marker_both ((MARKER), Qnil, CHARPOS ((POS)), BYTEPOS ((POS)))
218 /* Value is non-zero if character and byte positions of POS1 and POS2
221 #define TEXT_POS_EQUAL_P(POS1, POS2) \
222 ((POS1).charpos == (POS2).charpos \
223 && (POS1).bytepos == (POS2).bytepos)
225 /* When rendering glyphs, redisplay scans string or buffer text,
226 overlay strings in that text, and does display table or control
227 character translations. The following structure captures a
228 position taking all this into account. */
232 /* Buffer or string position. */
235 /* If this is a position in an overlay string, overlay_string_index
236 is the index of that overlay string in the sequence of overlay
237 strings at `pos' in the order redisplay processes them. A value
238 < 0 means that this is not a position in an overlay string. */
239 int overlay_string_index
;
241 /* If this is a position in an overlay string, string_pos is the
242 position within that string. */
243 struct text_pos string_pos
;
245 /* If the character at the position above is a control character or
246 has a display table entry, dpvec_index is an index in the display
247 table or control character translation of that character. A
248 value < 0 means this is not a position in such a translation. */
254 /***********************************************************************
256 ***********************************************************************/
258 /* Enumeration of glyph types. Glyph structures contain a type field
259 containing one of the enumerators defined here. */
263 /* Glyph describes a character. */
266 /* Glyph describes a composition sequence. */
269 /* Glyph describes an image. */
272 /* Glyph is a space of fractional width and/or height. */
279 Be extra careful when changing this structure! Esp. make sure that
280 functions producing glyphs, like append_glyph, fill ALL of the
281 glyph structure, and that GLYPH_EQUAL_P compares all
282 display-relevant members of glyphs (not to imply that these are the
283 only things to check when you add a member). */
287 /* Position from which this glyph was drawn. If `object' below is a
288 Lisp string, this is a position in that string. If it is a
289 buffer, this is a position in that buffer. A value of -1
290 together with a null object means glyph is a truncation glyph at
291 the start of a row. */
294 /* Lisp object source of this glyph. Currently either a buffer or
295 a string, if the glyph was produced from characters which came from
296 a buffer or a string; or 0 if the glyph was inserted by redisplay
297 for its own purposes such as padding. */
300 /* Width in pixels. */
303 /* Ascent and descent in pixels. */
304 short ascent
, descent
;
306 /* Vertical offset. If < 0, the glyph is displayed raised, if > 0
307 the glyph is displayed lowered. */
310 /* Which kind of glyph this is---character, image etc. Value
311 should be an enumerator of type enum glyph_type. */
314 /* 1 means this glyph was produced from multibyte text. Zero
315 means it was produced from unibyte text, i.e. charsets aren't
316 applicable, and encoding is not performed. */
317 unsigned multibyte_p
: 1;
319 /* Non-zero means draw a box line at the left or right side of this
320 glyph. This is part of the implementation of the face attribute
322 unsigned left_box_line_p
: 1;
323 unsigned right_box_line_p
: 1;
325 /* Non-zero means this glyph's physical ascent or descent is greater
326 than its logical ascent/descent, i.e. it may potentially overlap
327 glyphs above or below it. */
328 unsigned overlaps_vertically_p
: 1;
330 /* 1 means glyph is a padding glyph. Padding glyphs are used for
331 characters whose visual shape consists of more than one glyph
332 (e.g. Asian characters). All but the first glyph of such a glyph
333 sequence have the padding_p flag set. Only used for terminal
334 frames, and there only to minimize code changes. A better way
335 would probably be to use the width field of glyphs to express
337 unsigned padding_p
: 1;
339 /* 1 means the actual glyph is not available, draw a box instead.
340 This can happen when a font couldn't be loaded, or a character
341 doesn't have a glyph in a font. */
342 unsigned glyph_not_available_p
: 1;
344 #define FACE_ID_BITS 21
346 /* Face of the glyph. */
347 unsigned face_id
: FACE_ID_BITS
;
349 /* Type of font used to display the character glyph. May be used to
350 determine which set of functions to use to obtain font metrics
351 for the glyph. On W32, value should be an enumerator of the type
352 w32_char_font_type. Otherwise it equals FONT_TYPE_UNKNOWN. */
353 unsigned font_type
: 3;
355 /* A union of sub-structures for different glyph types. */
358 /* Character code for character glyphs (type == CHAR_GLYPH). */
361 /* Composition ID for composition glyphs (type == COMPOSITION_GLYPH) */
364 /* Image ID for image glyphs (type == IMAGE_GLYPH). */
367 /* Sub-structure for type == STRETCH_GLYPH. */
370 /* The height of the glyph. */
371 unsigned height
: 16;
373 /* The ascent of the glyph. */
374 unsigned ascent
: 16;
378 /* Used to compare all bit-fields above in one step. */
384 /* Default value of the glyph font_type field. */
386 #define FONT_TYPE_UNKNOWN 0
388 /* Is GLYPH a space? */
390 #define CHAR_GLYPH_SPACE_P(GLYPH) \
391 (GLYPH_FROM_CHAR_GLYPH ((GLYPH)) == SPACEGLYPH)
393 /* Are glyphs *X and *Y displayed equal? */
395 #define GLYPH_EQUAL_P(X, Y) \
396 ((X)->type == (Y)->type \
397 && (X)->u.val == (Y)->u.val \
398 && (X)->face_id == (Y)->face_id \
399 && (X)->padding_p == (Y)->padding_p \
400 && (X)->left_box_line_p == (Y)->left_box_line_p \
401 && (X)->right_box_line_p == (Y)->right_box_line_p \
402 && (X)->voffset == (Y)->voffset \
403 && (X)->pixel_width == (Y)->pixel_width)
405 /* Are character codes, faces, padding_ps of glyphs *X and *Y equal? */
407 #define GLYPH_CHAR_AND_FACE_EQUAL_P(X, Y) \
408 ((X)->u.ch == (Y)->u.ch \
409 && (X)->face_id == (Y)->face_id \
410 && (X)->padding_p == (Y)->padding_p)
412 /* Fill a character glyph GLYPH. CODE, FACE_ID, PADDING_P correspond
413 to the bits defined for the typedef `GLYPH' in lisp.h. */
415 #define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P) \
418 (GLYPH).u.ch = (CODE); \
419 (GLYPH).face_id = (FACE_ID); \
420 (GLYPH).padding_p = (PADDING_P); \
424 /* Fill a character type glyph GLYPH from a glyph typedef FROM as
425 defined in lisp.h. */
427 #define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM) \
428 SET_CHAR_GLYPH ((GLYPH), \
429 FAST_GLYPH_CHAR ((FROM)), \
430 FAST_GLYPH_FACE ((FROM)), \
433 /* Construct a glyph code from a character glyph GLYPH. If the
434 character is multibyte, return -1 as we can't use glyph table for a
435 multibyte character. */
437 #define GLYPH_FROM_CHAR_GLYPH(GLYPH) \
438 ((GLYPH).u.ch < 256 \
439 ? ((GLYPH).u.ch | ((GLYPH).face_id << CHARACTERBITS)) \
442 /* Is GLYPH a padding glyph? */
444 #define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p
449 /***********************************************************************
451 ***********************************************************************/
455 Glyph memory for frame-based redisplay is allocated from the heap
456 in one vector kept in a glyph pool structure which is stored with
457 the frame. The size of the vector is made large enough to cover
458 all windows on the frame.
460 Both frame and window glyph matrices reference memory from a glyph
461 pool in frame-based redisplay.
463 In window-based redisplay, no glyphs pools exist; windows allocate
464 and free their glyph memory themselves. */
468 /* Vector of glyphs allocated from the heap. */
469 struct glyph
*glyphs
;
471 /* Allocated size of `glyphs'. */
474 /* Number of rows and columns in a matrix. */
480 /***********************************************************************
482 ***********************************************************************/
486 Three kinds of glyph matrices exist:
488 1. Frame glyph matrices. These are used for terminal frames whose
489 redisplay needs a view of the whole screen due to limited terminal
490 capabilities. Frame matrices are used only in the update phase
491 of redisplay. They are built in update_frame and not used after
492 the update has been performed.
494 2. Window glyph matrices on frames having frame glyph matrices.
495 Such matrices are sub-matrices of their corresponding frame matrix,
496 i.e. frame glyph matrices and window glyph matrices share the same
497 glyph memory which is allocated in form of a glyph_pool structure.
498 Glyph rows in such a window matrix are slices of frame matrix rows.
500 2. Free-standing window glyph matrices managing their own glyph
501 storage. This form is used in window-based redisplay which
502 includes variable width and height fonts etc.
504 The size of a window's row vector depends on the height of fonts
505 defined on its frame. It is chosen so that the vector is large
506 enough to describe all lines in a window when it is displayed in
507 the smallest possible character size. When new fonts are loaded,
508 or window sizes change, the row vector is adjusted accordingly. */
512 /* The pool from which glyph memory is allocated, if any. This is
513 null for frame matrices and for window matrices managing their
515 struct glyph_pool
*pool
;
517 /* Vector of glyph row structures. The row at nrows - 1 is reserved
518 for the mode line. */
519 struct glyph_row
*rows
;
521 /* Number of elements allocated for the vector rows above. */
524 /* The number of rows used by the window if all lines were displayed
525 with the smallest possible character height. */
528 /* Origin within the frame matrix if this is a window matrix on a
529 frame having a frame matrix. Both values are zero for
530 window-based redisplay. */
531 int matrix_x
, matrix_y
;
533 /* Width and height of the matrix in columns and rows. */
534 int matrix_w
, matrix_h
;
536 /* If this structure describes a window matrix of window W,
537 window_left_col is the value of W->left_col, window_top_line the
538 value of W->top_line, window_height and window_width are width and
539 height of W, as returned by window_box, and window_vscroll is the
540 value of W->vscroll at the time the matrix was last adjusted.
541 Only set for window-based redisplay. */
542 int window_left_col
, window_top_line
;
543 int window_height
, window_width
;
546 /* Number of glyphs reserved for left and right marginal areas when
547 the matrix was last adjusted. */
548 int left_margin_glyphs
, right_margin_glyphs
;
550 /* Flag indicating that scrolling should not be tried in
551 update_window. This flag is set by functions like try_window_id
552 which do their own scrolling. */
553 unsigned no_scrolling_p
: 1;
555 /* Non-zero means window displayed in this matrix has a top mode
557 unsigned header_line_p
: 1;
560 /* A string identifying the method used to display the matrix. */
564 /* The buffer this matrix displays. Set in
565 mark_window_display_accurate_1. */
566 struct buffer
*buffer
;
568 /* Values of BEGV and ZV as of last redisplay. Set in
569 mark_window_display_accurate_1. */
574 /* Check that glyph pointers stored in glyph rows of MATRIX are okay.
575 This aborts if any pointer is found twice. */
578 void check_matrix_pointer_lossage
P_ ((struct glyph_matrix
*));
579 #define CHECK_MATRIX(MATRIX) check_matrix_pointer_lossage ((MATRIX))
581 #define CHECK_MATRIX(MATRIX) (void) 0
586 /***********************************************************************
588 ***********************************************************************/
590 /* Area in window glyph matrix. If values are added or removed, the
591 function mark_object in alloc.c has to be changed. */
602 /* Rows of glyphs in a windows or frame glyph matrix.
604 Each row is partitioned into three areas. The start and end of
605 each area is recorded in a pointer as shown below.
607 +--------------------+-------------+---------------------+
608 | left margin area | text area | right margin area |
609 +--------------------+-------------+---------------------+
611 glyphs[LEFT_MARGIN_AREA] glyphs[RIGHT_MARGIN_AREA]
616 Rows in frame matrices reference glyph memory allocated in a frame
617 glyph pool (see the description of struct glyph_pool). Rows in
618 window matrices on frames having frame matrices reference slices of
619 the glyphs of corresponding rows in the frame matrix.
621 Rows in window matrices on frames having no frame matrices point to
622 glyphs allocated from the heap via xmalloc;
623 glyphs[LEFT_MARGIN_AREA] is the start address of the allocated
624 glyph structure array. */
628 /* Pointers to beginnings of areas. The end of an area A is found at
629 A + 1 in the vector. The last element of the vector is the end
632 Kludge alert: Even if used[TEXT_AREA] == 0, glyphs[TEXT_AREA][0]'s
633 position field is used. It is -1 if this row does not correspond
634 to any text; it is some buffer position if the row corresponds to
635 an empty display line that displays a line end. This is what old
636 redisplay used to do. (Except in code for terminal frames, this
637 kludge is no longer used, I believe. --gerd).
639 See also start, end, displays_text_p and ends_at_zv_p for cleaner
640 ways to do it. The special meaning of positions 0 and -1 will be
641 removed some day, so don't use it in new code. */
642 struct glyph
*glyphs
[1 + LAST_AREA
];
644 /* Number of glyphs actually filled in areas. */
645 short used
[LAST_AREA
];
647 /* Window-relative x and y-position of the top-left corner of this
648 row. If y < 0, this means that abs (y) pixels of the row are
649 invisible because it is partially visible at the top of a window.
650 If x < 0, this means that abs (x) pixels of the first glyph of
651 the text area of the row are invisible because the glyph is
652 partially visible. */
655 /* Width of the row in pixels without taking face extension at the
656 end of the row into account, and without counting truncation
657 and continuation glyphs at the end of a row on ttys. */
660 /* Logical ascent/height of this line. The value of ascent is zero
661 and height is 1 on terminal frames. */
664 /* Physical ascent/height of this line. If max_ascent > ascent,
665 this line overlaps the line above it on the display. Otherwise,
666 if max_height > height, this line overlaps the line beneath it. */
667 int phys_ascent
, phys_height
;
669 /* Portion of row that is visible. Partially visible rows may be
670 found at the top and bottom of a window. This is 1 for tty
671 frames. It may be < 0 in case of completely invisible rows. */
674 /* Hash code. This hash code is available as soon as the row
675 is constructed, i.e. after a call to display_line. */
678 /* First position in this row. This is the text position, including
679 overlay position information etc, where the display of this row
680 started, and can thus be less the position of the first glyph
681 (e.g. due to invisible text or horizontal scrolling). */
682 struct display_pos start
;
684 /* Text position at the end of this row. This is the position after
685 the last glyph on this row. It can be greater than the last
686 glyph position + 1, due to truncation, invisible text etc. In an
687 up-to-date display, this should always be equal to the start
688 position of the next row. */
689 struct display_pos end
;
691 /* Left fringe bitmap number (enum fringe_bitmap_type). */
692 unsigned left_user_fringe_bitmap
: FRINGE_ID_BITS
;
694 /* Face of the left fringe glyph. */
695 unsigned left_user_fringe_face_id
: FACE_ID_BITS
;
697 /* Right fringe bitmap number (enum fringe_bitmap_type). */
698 unsigned right_user_fringe_bitmap
: FRINGE_ID_BITS
;
700 /* Face of the right fringe glyph. */
701 unsigned right_user_fringe_face_id
: FACE_ID_BITS
;
703 /* Left fringe bitmap number (enum fringe_bitmap_type). */
704 unsigned left_fringe_bitmap
: FRINGE_ID_BITS
;
706 /* Face of the left fringe glyph. */
707 unsigned left_fringe_face_id
: FACE_ID_BITS
;
709 /* Right fringe bitmap number (enum fringe_bitmap_type). */
710 unsigned right_fringe_bitmap
: FRINGE_ID_BITS
;
712 /* Face of the right fringe glyph. */
713 unsigned right_fringe_face_id
: FACE_ID_BITS
;
715 /* 1 means that we must draw the bitmaps of this row. */
716 unsigned redraw_fringe_bitmaps_p
: 1;
718 /* In a desired matrix, 1 means that this row must be updated. In a
719 current matrix, 0 means that the row has been invalidated, i.e.
720 the row's contents do not agree with what is visible on the
722 unsigned enabled_p
: 1;
724 /* 1 means row displays a text line that is truncated on the left or
726 unsigned truncated_on_left_p
: 1;
727 unsigned truncated_on_right_p
: 1;
729 /* 1 means the overlay arrow is on this line. */
730 unsigned overlay_arrow_p
: 1;
732 /* 1 means that this row displays a continued line, i.e. it has a
733 continuation mark at the right side. */
734 unsigned continued_p
: 1;
736 /* 0 means that this row does not contain any text, i.e. it is
737 a blank line at the window and buffer end. */
738 unsigned displays_text_p
: 1;
740 /* 1 means that this line ends at ZV. */
741 unsigned ends_at_zv_p
: 1;
743 /* 1 means the face of the last glyph in the text area is drawn to
744 the right end of the window. This flag is used in
745 update_text_area to optimize clearing to the end of the area. */
746 unsigned fill_line_p
: 1;
748 /* Non-zero means display a bitmap on X frames indicating that this
749 line contains no text and ends in ZV. */
750 unsigned indicate_empty_line_p
: 1;
752 /* 1 means this row contains glyphs that overlap each other because
753 of lbearing or rbearing. */
754 unsigned contains_overlapping_glyphs_p
: 1;
756 /* 1 means this row is as wide as the window it is displayed in, including
757 scroll bars, fringes, and internal borders. This also
758 implies that the row doesn't have marginal areas. */
759 unsigned full_width_p
: 1;
761 /* Non-zero means row is a mode or header-line. */
762 unsigned mode_line_p
: 1;
764 /* 1 in a current row means this row is overlapped by another row. */
765 unsigned overlapped_p
: 1;
767 /* 1 means this line ends in the middle of a character consisting
768 of more than one glyph. Some glyphs have been put in this row,
769 the rest are put in rows below this one. */
770 unsigned ends_in_middle_of_char_p
: 1;
772 /* 1 means this line starts in the middle of a character consisting
773 of more than one glyph. Some glyphs have been put in the
774 previous row, the rest are put in this row. */
775 unsigned starts_in_middle_of_char_p
: 1;
777 /* 1 in a current row means this row overlaps others. */
778 unsigned overlapping_p
: 1;
780 /* 1 means some glyphs in this row are displayed in mouse-face. */
781 unsigned mouse_face_p
: 1;
783 /* 1 means this row was ended by a newline from a string. */
784 unsigned ends_in_newline_from_string_p
: 1;
786 /* 1 means this row width is exactly the width of the window, and the
787 final newline character is hidden in the right fringe. */
788 unsigned exact_window_width_line_p
: 1;
790 /* 1 means this row currently shows the cursor in the right fringe. */
791 unsigned cursor_in_fringe_p
: 1;
793 /* Non-zero means display a bitmap on X frames indicating that this
794 the first line of the buffer. */
795 unsigned indicate_bob_p
: 1;
797 /* Non-zero means display a bitmap on X frames indicating that this
798 the top line of the window, but not start of the buffer. */
799 unsigned indicate_top_line_p
: 1;
801 /* Non-zero means display a bitmap on X frames indicating that this
802 the last line of the buffer. */
803 unsigned indicate_eob_p
: 1;
805 /* Non-zero means display a bitmap on X frames indicating that this
806 the bottom line of the window, but not end of the buffer. */
807 unsigned indicate_bottom_line_p
: 1;
809 /* Continuation lines width at the start of the row. */
810 int continuation_lines_width
;
814 /* Get a pointer to row number ROW in matrix MATRIX. If GLYPH_DEBUG
815 is defined to a non-zero value, the function matrix_row checks that
816 we don't try to access rows that are out of bounds. */
819 struct glyph_row
*matrix_row
P_ ((struct glyph_matrix
*, int));
820 #define MATRIX_ROW(MATRIX, ROW) matrix_row ((MATRIX), (ROW))
822 #define MATRIX_ROW(MATRIX, ROW) ((MATRIX)->rows + (ROW))
825 /* Return a pointer to the row reserved for the mode line in MATRIX.
826 Row MATRIX->nrows - 1 is always reserved for the mode line. */
828 #define MATRIX_MODE_LINE_ROW(MATRIX) \
829 ((MATRIX)->rows + (MATRIX)->nrows - 1)
831 /* Return a pointer to the row reserved for the header line in MATRIX.
832 This is always the first row in MATRIX because that's the only
833 way that works in frame-based redisplay. */
835 #define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows
837 /* Return a pointer to first row in MATRIX used for text display. */
839 #define MATRIX_FIRST_TEXT_ROW(MATRIX) \
840 ((MATRIX)->rows->mode_line_p ? (MATRIX)->rows + 1 : (MATRIX)->rows)
842 /* Return a pointer to the first glyph in the text area of a row.
843 MATRIX is the glyph matrix accessed, and ROW is the row index in
846 #define MATRIX_ROW_GLYPH_START(MATRIX, ROW) \
847 (MATRIX_ROW ((MATRIX), (ROW))->glyphs[TEXT_AREA])
849 /* Return the number of used glyphs in the text area of a row. */
851 #define MATRIX_ROW_USED(MATRIX, ROW) \
852 (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA])
854 /* Return the character/ byte position at which the display of ROW
857 #define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->start.pos.charpos)
858 #define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->start.pos.bytepos)
860 /* Return the character/ byte position at which ROW ends. */
862 #define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->end.pos.charpos)
863 #define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->end.pos.bytepos)
865 /* Return the vertical position of ROW in MATRIX. */
867 #define MATRIX_ROW_VPOS(ROW, MATRIX) ((ROW) - (MATRIX)->rows)
869 /* Return the last glyph row + 1 in MATRIX on window W reserved for
870 text. If W has a mode line, the last row in the matrix is reserved
873 #define MATRIX_BOTTOM_TEXT_ROW(MATRIX, W) \
876 - (WINDOW_WANTS_MODELINE_P ((W)) ? 1 : 0))
878 /* Non-zero if the face of the last glyph in ROW's text area has
879 to be drawn to the end of the text area. */
881 #define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)
883 /* Set and query the enabled_p flag of glyph row ROW in MATRIX. */
885 #define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
886 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0)
888 #define MATRIX_ROW_ENABLED_P(MATRIX, ROW) \
889 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p)
891 /* Non-zero if ROW displays text. Value is non-zero if the row is
892 blank but displays a line end. */
894 #define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)
896 /* Non-zero if ROW is not completely visible in window W. */
898 #define MATRIX_ROW_PARTIALLY_VISIBLE_P(ROW) \
899 ((ROW)->height != (ROW)->visible_height)
901 /* Non-zero if ROW is partially visible at the top of window W. */
903 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW) \
904 (MATRIX_ROW_PARTIALLY_VISIBLE_P ((ROW)) \
905 && (ROW)->y < WINDOW_HEADER_LINE_HEIGHT ((W)))
907 /* Non-zero if ROW is partially visible at the bottom of window W. */
909 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW) \
910 (MATRIX_ROW_PARTIALLY_VISIBLE_P ((ROW)) \
911 && (ROW)->y + (ROW)->height > WINDOW_BOX_HEIGHT_NO_MODE_LINE ((W)))
913 /* Return the bottom Y + 1 of ROW. */
915 #define MATRIX_ROW_BOTTOM_Y(ROW) ((ROW)->y + (ROW)->height)
917 /* Is ROW the last visible one in the display described by the
918 iterator structure pointed to by IT?. */
920 #define MATRIX_ROW_LAST_VISIBLE_P(ROW, IT) \
921 (MATRIX_ROW_BOTTOM_Y ((ROW)) >= (IT)->last_visible_y)
923 /* Non-zero if ROW displays a continuation line. */
925 #define MATRIX_ROW_CONTINUATION_LINE_P(ROW) \
926 ((ROW)->continuation_lines_width > 0)
928 /* Non-zero if ROW ends in the middle of a character. This is the
929 case for continued lines showing only part of a display table entry
930 or a control char, or an overlay string. */
932 #define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW) \
933 ((ROW)->end.dpvec_index >= 0 \
934 || (ROW)->end.overlay_string_index >= 0 \
935 || (ROW)->ends_in_middle_of_char_p)
937 /* Non-zero if ROW ends in the middle of an overlay string. */
939 #define MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P(ROW) \
940 ((ROW)->end.overlay_string_index >= 0)
942 /* Non-zero if ROW starts in the middle of a character. See above. */
944 #define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW) \
945 ((ROW)->start.dpvec_index >= 0 \
946 || (ROW)->starts_in_middle_of_char_p \
947 || ((ROW)->start.overlay_string_index >= 0 \
948 && (ROW)->start.string_pos.charpos > 0))
950 /* Non-zero means ROW overlaps its predecessor. */
952 #define MATRIX_ROW_OVERLAPS_PRED_P(ROW) \
953 ((ROW)->phys_ascent > (ROW)->ascent)
955 /* Non-zero means ROW overlaps its successor. */
957 #define MATRIX_ROW_OVERLAPS_SUCC_P(ROW) \
958 ((ROW)->phys_height - (ROW)->phys_ascent \
959 > (ROW)->height - (ROW)->ascent)
961 /* Non-zero means that fonts have been loaded since the last glyph
962 matrix adjustments. The function redisplay_internal adjusts glyph
963 matrices when this flag is non-zero. */
965 extern int fonts_changed_p
;
967 /* A glyph for a space. */
969 extern struct glyph space_glyph
;
971 /* Frame being updated by update_window/update_frame. */
973 extern struct frame
*updating_frame
;
975 /* Window being updated by update_window. This is non-null as long as
976 update_window has not finished, and null otherwise. It's role is
977 analogous to updating_frame. */
979 extern struct window
*updated_window
;
981 /* Glyph row and area updated by update_window_line. */
983 extern struct glyph_row
*updated_row
;
984 extern int updated_area
;
986 /* Non-zero means reading single-character input with prompt so put
987 cursor on mini-buffer after the prompt. Positive means at end of
988 text in echo area; negative means at beginning of line. */
990 extern int cursor_in_echo_area
;
992 /* Non-zero means last display completed. Zero means it was
995 extern int display_completed
;
997 /* Non-zero means redisplay has been performed directly (see also
998 direct_output_for_insert and direct_output_forward_char), so that
999 no further updating has to be performed. The function
1000 redisplay_internal checks this flag, and does nothing but reset it
1001 to zero if it is non-zero. */
1003 extern int redisplay_performed_directly_p
;
1005 /* A temporary storage area, including a row of glyphs. Initialized
1006 in xdisp.c. Used for various purposes, as an example see
1007 direct_output_for_insert. */
1009 extern struct glyph_row scratch_glyph_row
;
1013 /************************************************************************
1015 ************************************************************************/
1017 /* Enumeration for overriding/changing the face to use for drawing
1018 glyphs in draw_glyphs. */
1020 enum draw_glyphs_face
1030 #ifdef HAVE_WINDOW_SYSTEM
1032 /* A sequence of glyphs to be drawn in the same face. */
1036 /* X-origin of the string. */
1039 /* Y-origin and y-position of the base line of this string. */
1042 /* The width of the string, not including a face extension. */
1045 /* The width of the string, including a face extension. */
1046 int background_width
;
1048 /* The height of this string. This is the height of the line this
1049 string is drawn in, and can be different from the height of the
1050 font the string is drawn in. */
1053 /* Number of pixels this string overwrites in front of its x-origin.
1054 This number is zero if the string has an lbearing >= 0; it is
1055 -lbearing, if the string has an lbearing < 0. */
1058 /* Number of pixels this string overwrites past its right-most
1059 nominal x-position, i.e. x + width. Zero if the string's
1060 rbearing is <= its nominal width, rbearing - width otherwise. */
1063 /* The frame on which the glyph string is drawn. */
1066 /* The window on which the glyph string is drawn. */
1069 /* X display and window for convenience. */
1073 /* The glyph row for which this string was built. It determines the
1074 y-origin and height of the string. */
1075 struct glyph_row
*row
;
1077 /* The area within row. */
1078 enum glyph_row_area area
;
1080 /* Characters to be drawn, and number of characters. */
1084 /* A face-override for drawing cursors, mouse face and similar. */
1085 enum draw_glyphs_face hl
;
1087 /* Face in which this string is to be drawn. */
1090 /* Font in which this string is to be drawn. */
1093 /* Font info for this string. */
1094 struct font_info
*font_info
;
1096 /* Non-null means this string describes (part of) a composition.
1097 All characters from char2b are drawn composed. */
1098 struct composition
*cmp
;
1100 /* Index of this glyph string's first character in the glyph
1101 definition of CMP. If this is zero, this glyph string describes
1102 the first character of a composition. */
1105 /* 1 means this glyph strings face has to be drawn to the right end
1106 of the window's drawing area. */
1107 unsigned extends_to_end_of_line_p
: 1;
1109 /* 1 means the background of this string has been drawn. */
1110 unsigned background_filled_p
: 1;
1112 /* 1 means glyph string must be drawn with 16-bit functions. */
1113 unsigned two_byte_p
: 1;
1115 /* 1 means that the original font determined for drawing this glyph
1116 string could not be loaded. The member `font' has been set to
1117 the frame's default font in this case. */
1118 unsigned font_not_found_p
: 1;
1120 /* 1 means that the face in which this glyph string is drawn has a
1122 unsigned stippled_p
: 1;
1124 /* 1 means only the foreground of this glyph string must be drawn,
1125 and we should use the physical height of the line this glyph
1126 string appears in as clip rect. */
1127 unsigned for_overlaps_p
: 1;
1129 /* The GC to use for drawing this glyph string. */
1130 #if defined(HAVE_X_WINDOWS) || defined(HAVE_CARBON)
1133 #if defined(HAVE_NTGUI)
1138 /* A pointer to the first glyph in the string. This glyph
1139 corresponds to char2b[0]. Needed to draw rectangles if
1140 font_not_found_p is 1. */
1141 struct glyph
*first_glyph
;
1143 /* Image, if any. */
1146 struct glyph_string
*next
, *prev
;
1149 #endif /* HAVE_WINDOW_SYSTEM */
1152 /************************************************************************
1154 ************************************************************************/
1156 /* Return the height of the mode line in glyph matrix MATRIX, or zero
1157 if not known. This macro is called under circumstances where
1158 MATRIX might not have been allocated yet. */
1160 #define MATRIX_MODE_LINE_HEIGHT(MATRIX) \
1161 ((MATRIX) && (MATRIX)->rows \
1162 ? MATRIX_MODE_LINE_ROW (MATRIX)->height \
1165 /* Return the height of the header line in glyph matrix MATRIX, or zero
1166 if not known. This macro is called under circumstances where
1167 MATRIX might not have been allocated yet. */
1169 #define MATRIX_HEADER_LINE_HEIGHT(MATRIX) \
1170 ((MATRIX) && (MATRIX)->rows \
1171 ? MATRIX_HEADER_LINE_ROW (MATRIX)->height \
1174 /* Return the desired face id for the mode line of a window, depending
1175 on whether the window is selected or not, or if the window is the
1176 scrolling window for the currently active minibuffer window.
1178 Due to the way display_mode_lines manipulates with the contents of
1179 selected_window, this macro needs three arguments: SELW which is
1180 compared against the current value of selected_window, MBW which is
1181 compared against minibuf_window (if SELW doesn't match), and SCRW
1182 which is compared against minibuf_selected_window (if MBW matches). */
1184 #define CURRENT_MODE_LINE_FACE_ID_3(SELW, MBW, SCRW) \
1185 ((!mode_line_in_non_selected_windows \
1186 || (SELW) == XWINDOW (selected_window) \
1187 || (minibuf_level > 0 \
1188 && !NILP (minibuf_selected_window) \
1189 && (MBW) == XWINDOW (minibuf_window) \
1190 && (SCRW) == XWINDOW (minibuf_selected_window))) \
1191 ? MODE_LINE_FACE_ID \
1192 : MODE_LINE_INACTIVE_FACE_ID)
1195 /* Return the desired face id for the mode line of window W. */
1197 #define CURRENT_MODE_LINE_FACE_ID(W) \
1198 (CURRENT_MODE_LINE_FACE_ID_3((W), XWINDOW (selected_window), (W)))
1200 /* Return the current height of the mode line of window W. If not
1201 known from current_mode_line_height, look at W's current glyph
1202 matrix, or return a default based on the height of the font of the
1203 face `mode-line'. */
1205 #define CURRENT_MODE_LINE_HEIGHT(W) \
1206 (current_mode_line_height >= 0 \
1207 ? current_mode_line_height \
1208 : (MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1209 ? MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1210 : estimate_mode_line_height (XFRAME ((W)->frame), \
1211 CURRENT_MODE_LINE_FACE_ID (W))))
1213 /* Return the current height of the header line of window W. If not
1214 known from current_header_line_height, look at W's current glyph
1215 matrix, or return an estimation based on the height of the font of
1216 the face `header-line'. */
1218 #define CURRENT_HEADER_LINE_HEIGHT(W) \
1219 (current_header_line_height >= 0 \
1220 ? current_header_line_height \
1221 : (MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1222 ? MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1223 : estimate_mode_line_height (XFRAME ((W)->frame), \
1224 HEADER_LINE_FACE_ID)))
1226 /* Return the height of the desired mode line of window W. */
1228 #define DESIRED_MODE_LINE_HEIGHT(W) \
1229 MATRIX_MODE_LINE_HEIGHT ((W)->desired_matrix)
1231 /* Return the height of the desired header line of window W. */
1233 #define DESIRED_HEADER_LINE_HEIGHT(W) \
1234 MATRIX_HEADER_LINE_HEIGHT ((W)->desired_matrix)
1236 /* Value is non-zero if window W wants a mode line. */
1238 #define WINDOW_WANTS_MODELINE_P(W) \
1239 (!MINI_WINDOW_P ((W)) \
1240 && !(W)->pseudo_window_p \
1241 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1242 && BUFFERP ((W)->buffer) \
1243 && !NILP (XBUFFER ((W)->buffer)->mode_line_format) \
1244 && WINDOW_TOTAL_LINES (W) > 1)
1246 /* Value is non-zero if window W wants a header line. */
1248 #define WINDOW_WANTS_HEADER_LINE_P(W) \
1249 (!MINI_WINDOW_P ((W)) \
1250 && !(W)->pseudo_window_p \
1251 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1252 && BUFFERP ((W)->buffer) \
1253 && !NILP (XBUFFER ((W)->buffer)->header_line_format) \
1254 && WINDOW_TOTAL_LINES (W) > 1 + !NILP (XBUFFER ((W)->buffer)->mode_line_format))
1257 /* Return proper value to be used as baseline offset of font that has
1258 ASCENT and DESCENT to draw characters by the font at the vertical
1259 center of the line of frame F.
1261 Here, our task is to find the value of BOFF in the following figure;
1263 -------------------------+-----------+-
1264 -+-+---------+-+ | |
1266 | | | | F_ASCENT F_HEIGHT
1269 | | |-|-+------+-----------|------- baseline
1271 | |---------|-+-+ | |
1273 -+-+---------+-+ F_DESCENT |
1274 -------------------------+-----------+-
1276 -BOFF + DESCENT + (F_HEIGHT - HEIGHT) / 2 = F_DESCENT
1277 BOFF = DESCENT + (F_HEIGHT - HEIGHT) / 2 - F_DESCENT
1278 DESCENT = FONT->descent
1279 HEIGHT = FONT_HEIGHT (FONT)
1280 F_DESCENT = (FRAME_FONT (F)->descent
1281 - F->output_data.x->baseline_offset)
1282 F_HEIGHT = FRAME_LINE_HEIGHT (F)
1285 #define VCENTER_BASELINE_OFFSET(FONT, F) \
1286 (FONT_DESCENT (FONT) \
1287 + (FRAME_LINE_HEIGHT ((F)) - FONT_HEIGHT ((FONT)) \
1288 + (FRAME_LINE_HEIGHT ((F)) > FONT_HEIGHT ((FONT)))) / 2 \
1289 - (FONT_DESCENT (FRAME_FONT (F)) - FRAME_BASELINE_OFFSET (F)))
1292 /***********************************************************************
1294 ***********************************************************************/
1296 /* Indices of face attributes in Lisp face vectors. Slot zero is the
1299 enum lface_attribute_index
1301 LFACE_FAMILY_INDEX
= 1,
1306 LFACE_UNDERLINE_INDEX
,
1307 LFACE_INVERSE_INDEX
,
1308 LFACE_FOREGROUND_INDEX
,
1309 LFACE_BACKGROUND_INDEX
,
1310 LFACE_STIPPLE_INDEX
,
1311 LFACE_OVERLINE_INDEX
,
1312 LFACE_STRIKE_THROUGH_INDEX
,
1315 LFACE_INHERIT_INDEX
,
1316 LFACE_AVGWIDTH_INDEX
,
1317 LFACE_FONTSET_INDEX
,
1322 /* Box types of faces. */
1326 /* No box around text. */
1329 /* Simple box of specified width and color. Default width is 1, and
1330 default color is the foreground color of the face. */
1333 /* Boxes with 3D shadows. Color equals the background color of the
1334 face. Width is specified. */
1340 /* Structure describing a realized face.
1342 For each Lisp face, 0..N realized faces can exist for different
1343 frames and different charsets. Realized faces are built from Lisp
1344 faces and text properties/overlays by merging faces and adding
1345 unspecified attributes from the `default' face. */
1349 /* The id of this face. The id equals the index of this face in the
1350 vector faces_by_id of its face cache. */
1353 #ifdef HAVE_WINDOW_SYSTEM
1355 /* If non-zero, this is a GC that we can use without modification for
1356 drawing the characters in this face. */
1359 /* Font used for this face, or null if the font could not be loaded
1360 for some reason. This points to a `font' slot of a struct
1361 font_info, and we should not call XFreeFont on it because the
1362 font may still be used somewhere else. */
1365 /* Background stipple or bitmap used for this face. This is
1366 an id as returned from load_pixmap. */
1369 #else /* not HAVE_WINDOW_SYSTEM */
1374 #endif /* not HAVE_WINDOW_SYSTEM */
1376 /* Pixel value of foreground color for X frames. Color index
1378 unsigned long foreground
;
1380 /* Pixel value or color index of background color. */
1381 unsigned long background
;
1383 /* Pixel value or color index of underline color. */
1384 unsigned long underline_color
;
1386 /* Pixel value or color index of overlined, strike-through, or box
1388 unsigned long overline_color
;
1389 unsigned long strike_through_color
;
1390 unsigned long box_color
;
1392 /* The font's name. This points to a `name' of a font_info, and it
1393 must not be freed. */
1396 /* Font info ID for this face's font. An ID is stored here because
1397 pointers to font_info structures may change. The reason is that
1398 they are pointers into a font table vector that is itself
1402 /* Fontset ID if for this face's fontset. Non-ASCII faces derived
1403 from the same ASCII face have the same fontset. */
1406 /* Pixmap width and height. */
1407 unsigned int pixmap_w
, pixmap_h
;
1409 /* Non-zero means characters in this face have a box that thickness
1410 around them. If it is negative, the absolute value indicates the
1411 thickness, and the horizontal lines of box (top and bottom) are
1412 drawn inside of characters glyph area. The vertical lines of box
1413 (left and right) are drawn as the same way as the case that this
1414 value is positive. */
1417 /* Type of box drawn. A value of FACE_NO_BOX means no box is drawn
1418 around text in this face. A value of FACE_SIMPLE_BOX means a box
1419 of width box_line_width is drawn in color box_color. A value of
1420 FACE_RAISED_BOX or FACE_SUNKEN_BOX means a 3D box is drawn with
1421 shadow colors derived from the background color of the face. */
1422 enum face_box_type box
;
1424 /* If `box' above specifies a 3D type, 1 means use box_color for
1426 unsigned use_box_color_for_shadows_p
: 1;
1428 /* The Lisp face attributes this face realizes. All attributes
1429 in this vector are non-nil. */
1430 Lisp_Object lface
[LFACE_VECTOR_SIZE
];
1432 /* The hash value of this face. */
1435 /* Non-zero if text in this face should be underlined, overlined,
1436 strike-through or have a box drawn around it. */
1437 unsigned underline_p
: 1;
1438 unsigned overline_p
: 1;
1439 unsigned strike_through_p
: 1;
1441 /* 1 means that the colors specified for this face could not be
1442 loaded, and were replaced by default colors, so they shouldn't be
1444 unsigned foreground_defaulted_p
: 1;
1445 unsigned background_defaulted_p
: 1;
1447 /* 1 means that either no color is specified for underlining or that
1448 the specified color couldn't be loaded. Use the foreground
1449 color when drawing in that case. */
1450 unsigned underline_defaulted_p
: 1;
1452 /* 1 means that either no color is specified for the corresponding
1453 attribute or that the specified color couldn't be loaded.
1454 Use the foreground color when drawing in that case. */
1455 unsigned overline_color_defaulted_p
: 1;
1456 unsigned strike_through_color_defaulted_p
: 1;
1457 unsigned box_color_defaulted_p
: 1;
1459 /* TTY appearances. Blinking is not yet implemented. Colors are
1460 found in `lface' with empty color string meaning the default
1461 color of the TTY. */
1462 unsigned tty_bold_p
: 1;
1463 unsigned tty_dim_p
: 1;
1464 unsigned tty_underline_p
: 1;
1465 unsigned tty_alt_charset_p
: 1;
1466 unsigned tty_reverse_p
: 1;
1467 unsigned tty_blinking_p
: 1;
1469 /* 1 means that colors of this face may not be freed because they
1470 have been copied bitwise from a base face (see
1472 unsigned colors_copied_bitwise_p
: 1;
1474 /* If non-zero, use overstrike (to simulate bold-face). */
1475 unsigned overstrike
: 1;
1477 /* Next and previous face in hash collision list of face cache. */
1478 struct face
*next
, *prev
;
1480 /* If this face is an ASCII face, this points to this face itself.
1481 Otherwise, this points to an ASCII face that has the same
1482 attributes except the font. */
1483 struct face
*ascii_face
;
1487 /* Color index indicating that face uses a terminal's default color. */
1489 #define FACE_TTY_DEFAULT_COLOR ((unsigned long) -1)
1491 /* Color index indicating that face uses an unknown foreground color. */
1493 #define FACE_TTY_DEFAULT_FG_COLOR ((unsigned long) -2)
1495 /* Color index indicating that face uses an unknown background color. */
1497 #define FACE_TTY_DEFAULT_BG_COLOR ((unsigned long) -3)
1499 /* Non-zero if FACE was realized for unibyte use. */
1501 #define FACE_UNIBYTE_P(FACE) ((FACE)->charset < 0)
1504 /* IDs of important faces known by the C face code. These are the IDs
1505 of the faces for CHARSET_ASCII. */
1511 MODE_LINE_INACTIVE_FACE_ID
,
1514 HEADER_LINE_FACE_ID
,
1520 BASIC_FACE_ID_SENTINEL
1523 #define MAX_FACE_ID ((1 << FACE_ID_BITS) - 1)
1525 /* A cache of realized faces. Each frame has its own cache because
1526 Emacs allows different frame-local face definitions. */
1530 /* Hash table of cached realized faces. */
1531 struct face
**buckets
;
1533 /* Back-pointer to the frame this cache belongs to. */
1536 /* A vector of faces so that faces can be referenced by an ID. */
1537 struct face
**faces_by_id
;
1539 /* The allocated size, and number of used slots of faces_by_id. */
1542 /* Flag indicating that attributes of the `menu' face have been
1544 unsigned menu_face_changed_p
: 1;
1548 /* Prepare face FACE for use on frame F. This must be called before
1549 using X resources of FACE. */
1551 #define PREPARE_FACE_FOR_DISPLAY(F, FACE) \
1552 if ((FACE)->gc == 0) \
1553 prepare_face_for_display ((F), (FACE)); \
1557 /* Return a pointer to the face with ID on frame F, or null if such a
1558 face doesn't exist. */
1560 #define FACE_FROM_ID(F, ID) \
1561 (((unsigned) (ID) < FRAME_FACE_CACHE (F)->used) \
1562 ? FRAME_FACE_CACHE (F)->faces_by_id[ID] \
1565 #ifdef HAVE_WINDOW_SYSTEM
1567 /* Non-zero if FACE is suitable for displaying character CHAR. */
1569 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) \
1570 (ASCII_CHAR_P (CHAR) \
1571 ? (FACE) == (FACE)->ascii_face \
1572 : face_suitable_for_char_p ((FACE), (CHAR)))
1574 /* Return the id of the realized face on frame F that is like the face
1575 with id ID but is suitable for displaying character CHAR.
1576 This macro is only meaningful for multibyte character CHAR. */
1578 #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) \
1579 (ASCII_CHAR_P (CHAR) \
1580 ? (FACE)->ascii_face->id \
1581 : face_for_char ((F), (FACE), (CHAR), (POS), (OBJECT)))
1583 #else /* not HAVE_WINDOW_SYSTEM */
1585 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) 1
1586 #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) ((FACE)->id)
1588 #endif /* not HAVE_WINDOW_SYSTEM */
1590 /* Non-zero means face attributes have been changed since the last
1591 redisplay. Used in redisplay_internal. */
1593 extern int face_change_count
;
1598 /***********************************************************************
1600 ***********************************************************************/
1602 /* Structure used to describe where and how to draw a fringe bitmap.
1603 WHICH is the fringe bitmap to draw. WD and H is the (adjusted)
1604 width and height of the bitmap, DH is the height adjustment (if
1605 bitmap is periodic). X and Y are frame coordinates of the area to
1606 display the bitmap, DY is relative offset of the bitmap into that
1607 area. BX, NX, BY, NY specifies the area to clear if the bitmap
1608 does not fill the entire area. FACE is the fringe face. */
1610 struct draw_fringe_bitmap_params
1612 int which
; /* enum fringe_bitmap_type */
1613 unsigned short *bits
;
1617 unsigned cursor_p
: 1;
1618 unsigned overlay_p
: 1;
1622 #define MAX_FRINGE_BITMAPS (1<<FRINGE_ID_BITS)
1625 /***********************************************************************
1627 ***********************************************************************/
1629 /* Iteration over things to display in current_buffer or in a string.
1631 The iterator handles:
1633 1. Overlay strings (after-string, before-string).
1635 3. Invisible text properties.
1636 4. Selective display.
1637 5. Translation of characters via display tables.
1638 6. Translation of control characters to the forms `\003' or `^C'.
1639 7. `glyph' and `space-width' properties.
1641 Iterators are initialized by calling init_iterator or one of the
1642 equivalent functions below. A call to get_next_display_element
1643 loads the iterator structure with information about what next to
1644 display. A call to set_iterator_to_next increments the iterator's
1647 Characters from overlay strings, display table entries or control
1648 character translations are returned one at a time. For example, if
1649 we have a text of `a\x01' where `a' has a display table definition
1650 of `cd' and the control character is displayed with a leading
1651 arrow, then the iterator will return:
1653 Call Return Source Call next
1654 -----------------------------------------------------------------
1655 next c display table move
1656 next d display table move
1657 next ^ control char move
1658 next A control char move
1660 The same mechanism is also used to return characters for ellipses
1661 displayed at the end of invisible text.
1663 CAVEAT: Under some circumstances, move_.* functions can be called
1664 asynchronously, e.g. when computing a buffer position from an x and
1665 y pixel position. This means that these functions and functions
1666 called from them SHOULD NOT USE xmalloc and alike. See also the
1667 comment at the start of xdisp.c. */
1669 /* Enumeration describing what kind of display element an iterator is
1670 loaded with after a call to get_next_display_element. */
1672 enum display_element_type
1674 /* A normal character. */
1677 /* A composition sequence. */
1683 /* A flexible width and height space. */
1686 /* End of buffer or string. */
1689 /* Truncation glyphs. Never returned by get_next_display_element.
1690 Used to get display information about truncation glyphs via
1694 /* Continuation glyphs. See the comment for IT_TRUNCATION. */
1699 /* An enumerator for each text property that has a meaning for display
1704 AUTO_COMPOSED_PROP_IDX
,
1709 COMPOSITION_PROP_IDX
,
1711 /* Not a property. Used to indicate changes in overlays. */
1721 /* The window in which we iterate over current_buffer (or a string). */
1725 /* The window's frame. */
1728 /* Function to call to load this structure with the next display
1730 int (* method
) P_ ((struct it
*it
));
1732 /* The next position at which to check for face changes, invisible
1733 text, overlay strings, end of text etc., which see. */
1736 /* Maximum string or buffer position + 1. ZV when iterating over
1740 /* C string to iterate over. Non-null means get characters from
1741 this string, otherwise characters are read from current_buffer
1745 /* Number of characters in the string (s, or it->string) we iterate
1749 /* Start and end of a visible region; -1 if the region is not
1750 visible in the window. */
1751 int region_beg_charpos
, region_end_charpos
;
1753 /* Position at which redisplay end trigger functions should be run. */
1754 int redisplay_end_trigger_charpos
;
1756 /* 1 means multibyte characters are enabled. */
1757 unsigned multibyte_p
: 1;
1759 /* 1 means window has a mode line at its top. */
1760 unsigned header_line_p
: 1;
1762 /* 1 means `string' is the value of a `display' property.
1763 Don't handle some `display' properties in these strings. */
1764 unsigned string_from_display_prop_p
: 1;
1766 /* Display table in effect or null for none. */
1767 struct Lisp_Char_Table
*dp
;
1769 /* Current display table vector to return characters from and its
1770 end. dpvec null means we are not returning characters from a
1771 display table entry; current.dpvec_index gives the current index
1772 into dpvec. This same mechanism is also used to return
1773 characters from translated control characters, i.e. `\003' or
1775 Lisp_Object
*dpvec
, *dpend
;
1777 /* Length in bytes of the char that filled dpvec. A value of zero
1778 means that no such character is involved. */
1781 /* Face id of the iterator saved in case a glyph from dpvec contains
1782 a face. The face is restored when all glyphs from dpvec have
1786 /* Vector of glyphs for control character translation. The pointer
1787 dpvec is set to ctl_chars when a control character is translated.
1788 This vector is also used for incomplete multibyte character
1789 translation (e.g \222\244). Such a character is at most 4 bytes,
1790 thus we need at most 16 bytes here. */
1791 Lisp_Object ctl_chars
[16];
1793 /* Initial buffer or string position of the iterator, before skipping
1794 over display properties and invisible text. */
1795 struct display_pos start
;
1797 /* Current buffer or string position of the iterator, including
1798 position in overlay strings etc. */
1799 struct display_pos current
;
1801 /* Vector of overlays to process. Overlay strings are processed
1802 OVERLAY_STRING_CHUNK_SIZE at a time. */
1803 #define OVERLAY_STRING_CHUNK_SIZE 3
1804 Lisp_Object overlay_strings
[OVERLAY_STRING_CHUNK_SIZE
];
1806 /* Total number of overlay strings to process. This can be >
1807 OVERLAY_STRING_CHUNK_SIZE. */
1808 int n_overlay_strings
;
1810 /* If non-nil, a Lisp string being processed. If
1811 current.overlay_string_index >= 0, this is an overlay string from
1815 /* Stack of saved values. New entries are pushed when we begin to
1816 process an overlay string or a string from a `glyph' property.
1817 Entries are popped when we return to deliver display elements
1818 from what we previously had. */
1819 struct iterator_stack_entry
1824 struct display_pos pos
;
1827 enum glyph_row_area area
;
1828 unsigned multibyte_p
: 1;
1829 unsigned string_from_display_prop_p
: 1;
1830 unsigned display_ellipsis_p
: 1;
1831 Lisp_Object space_width
;
1833 Lisp_Object font_height
;
1837 /* Stack pointer. */
1840 /* Setting of buffer-local variable selective-display-ellipsis. */
1841 unsigned selective_display_ellipsis_p
: 1;
1843 /* 1 means control characters are translated into the form `^C'
1844 where the `^' can be replaced by a display table entry. */
1845 unsigned ctl_arrow_p
: 1;
1847 /* -1 means selective display hides everything between a \r and the
1848 next newline; > 0 means hide lines indented more than that value. */
1851 /* An enumeration describing what the next display element is
1852 after a call to get_next_display_element. */
1853 enum display_element_type what
;
1858 /* Non-zero means that the current face has a box. */
1859 unsigned face_box_p
: 1;
1861 /* Non-null means that the current character is the first in a run
1862 of characters with box face. */
1863 unsigned start_of_box_run_p
: 1;
1865 /* Non-zero means that the current character is the last in a run
1866 of characters with box face. */
1867 unsigned end_of_box_run_p
: 1;
1869 /* 1 means overlay strings at end_charpos have been processed. */
1870 unsigned overlay_strings_at_end_processed_p
: 1;
1872 /* 1 means the actual glyph is not available in the current
1874 unsigned glyph_not_available_p
: 1;
1876 /* 1 means the next line in display_line continues a character
1877 consisting of more than one glyph, and some glyphs of this
1878 character have been put on the previous line. */
1879 unsigned starts_in_middle_of_char_p
: 1;
1881 /* If 1, saved_face_id contains the id of the face in front of text
1882 skipped due to selective display. */
1883 unsigned face_before_selective_p
: 1;
1885 /* The ID of the default face to use. One of DEFAULT_FACE_ID,
1886 MODE_LINE_FACE_ID, etc, depending on what we are displaying. */
1889 /* If what == IT_CHARACTER, character and length in bytes. This is
1890 a character from a buffer or string. It may be different from
1891 the character displayed in case that
1892 unibyte_display_via_language_environment is set.
1894 If what == IT_COMPOSITION, the first component of a composition
1895 and length in bytes of the composition. */
1898 /* If what == IT_COMPOSITION, identification number and length in
1899 chars of a composition. */
1900 int cmp_id
, cmp_len
;
1902 /* The character to display, possibly translated to multibyte
1903 if unibyte_display_via_language_environment is set. This
1904 is set after produce_glyphs has been called. */
1905 int char_to_display
;
1907 /* If what == IT_IMAGE, the id of the image to display. */
1910 /* Value of the `space-width' property, if any; nil if none. */
1911 Lisp_Object space_width
;
1913 /* Computed from the value of the `raise' property. */
1916 /* Value of the `height' property, if any; nil if none. */
1917 Lisp_Object font_height
;
1919 /* Object and position where the current display element came from.
1920 Object can be a Lisp string in case the current display element
1921 comes from an overlay string, or it is buffer. Position is
1922 a position in object. */
1924 struct text_pos position
;
1926 /* 1 means lines are truncated. */
1927 unsigned truncate_lines_p
: 1;
1929 /* Number of columns per \t. */
1932 /* Width in pixels of truncation and continuation glyphs. */
1933 short truncation_pixel_width
, continuation_pixel_width
;
1935 /* First and last visible x-position in the display area. If window
1936 is hscrolled by n columns, first_visible_x == n * FRAME_COLUMN_WIDTH
1937 (f), and last_visible_x == pixel width of W + first_visible_x. */
1938 int first_visible_x
, last_visible_x
;
1940 /* Last visible y-position + 1 in the display area without a mode
1941 line, if the window has one. */
1944 /* Additional space in pixels between lines (for window systems
1946 int extra_line_spacing
;
1948 /* If non-null, glyphs are produced in glyph_row with each call to
1950 struct glyph_row
*glyph_row
;
1952 /* The area of glyph_row to which glyphs are added. */
1953 enum glyph_row_area area
;
1955 /* Number of glyphs needed for the last character requested via
1956 produce_glyphs. This is 1 except for tabs. */
1959 /* Width of the display element in pixels. Result of
1963 /* Current, maximum logical, and maximum physical line height
1964 information. Result of produce_glyphs. */
1965 int ascent
, descent
, max_ascent
, max_descent
;
1966 int phys_ascent
, phys_descent
, max_phys_ascent
, max_phys_descent
;
1968 /* Current x pixel position within the display line. This value
1969 does not include the width of continuation lines in front of the
1970 line. The value of current_x is automatically incremented by
1971 pixel_width with each call to produce_glyphs. */
1974 /* Accumulated width of continuation lines. If > 0, this means we
1975 are currently in a continuation line. This is initially zero and
1976 incremented/reset by display_line, move_it_to etc. */
1977 int continuation_lines_width
;
1979 /* Current y-position. Automatically incremented by the height of
1980 glyph_row in move_it_to and display_line. */
1983 /* Vertical matrix position of first text line in window. */
1986 /* Current vertical matrix position, or line number. Automatically
1987 incremented by move_it_to and display_line. */
1990 /* Horizontal matrix position reached in move_it_in_display_line.
1991 Only set there, not in display_line. */
1994 /* Left fringe bitmap number (enum fringe_bitmap_type). */
1995 unsigned left_user_fringe_bitmap
: FRINGE_ID_BITS
;
1997 /* Face of the left fringe glyph. */
1998 unsigned left_user_fringe_face_id
: FACE_ID_BITS
;
2000 /* Right fringe bitmap number (enum fringe_bitmap_type). */
2001 unsigned right_user_fringe_bitmap
: FRINGE_ID_BITS
;
2003 /* Face of the right fringe glyph. */
2004 unsigned right_user_fringe_face_id
: FACE_ID_BITS
;
2008 /* Access to positions of iterator IT. */
2010 #define IT_CHARPOS(IT) CHARPOS ((IT).current.pos)
2011 #define IT_BYTEPOS(IT) BYTEPOS ((IT).current.pos)
2012 #define IT_STRING_CHARPOS(IT) CHARPOS ((IT).current.string_pos)
2013 #define IT_STRING_BYTEPOS(IT) BYTEPOS ((IT).current.string_pos)
2015 /* Test if IT has reached the end of its buffer or string. This will
2016 only work after get_next_display_element has been called. */
2018 #define ITERATOR_AT_END_P(IT) ((IT)->what == IT_EOB)
2020 /* Non-zero means IT is at the end of a line. This is the case if it
2021 is either on a newline or on a carriage return and selective
2022 display hides the rest of the line. */
2024 #define ITERATOR_AT_END_OF_LINE_P(IT) \
2025 ((IT)->what == IT_CHARACTER \
2026 && ((IT)->c == '\n' \
2027 || ((IT)->c == '\r' && (IT)->selective)))
2029 /* Call produce_glyphs or produce_glyphs_hook, if set. Shortcut to
2030 avoid the function call overhead. */
2032 #define PRODUCE_GLYPHS(IT) \
2034 extern int inhibit_free_realized_faces; \
2036 rif->produce_glyphs ((IT)); \
2038 produce_glyphs ((IT)); \
2039 if ((IT)->glyph_row != NULL) \
2040 inhibit_free_realized_faces = 1; \
2043 /* Bit-flags indicating what operation move_it_to should perform. */
2045 enum move_operation_enum
2047 /* Stop if specified x-position is reached. */
2050 /* Stop if specified y-position is reached. */
2053 /* Stop if specified vpos is reached. */
2054 MOVE_TO_VPOS
= 0x04,
2056 /* Stop if specified buffer or string position is reached. */
2062 /***********************************************************************
2063 Window-based redisplay interface
2064 ***********************************************************************/
2066 /* Structure used to describe runs of lines that must be scrolled. */
2070 /* Source and destination y pixel position. */
2071 int desired_y
, current_y
;
2073 /* Source and destination vpos in matrix. */
2074 int desired_vpos
, current_vpos
;
2076 /* Height in pixels, number of glyph rows. */
2081 /* Handlers for setting frame parameters. */
2083 typedef void (*frame_parm_handler
) P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
2086 /* Structure holding system-dependent interface functions needed
2087 for window-based redisplay. */
2089 struct redisplay_interface
2091 /* Handlers for setting frame parameters. */
2092 frame_parm_handler
*frame_parm_handlers
;
2094 /* Produce glyphs/get display metrics for the display element IT is
2096 void (*produce_glyphs
) P_ ((struct it
*it
));
2098 /* Write or insert LEN glyphs from STRING at the nominal output
2100 void (*write_glyphs
) P_ ((struct glyph
*string
, int len
));
2101 void (*insert_glyphs
) P_ ((struct glyph
*start
, int len
));
2103 /* Clear from nominal output position to X. X < 0 means clear
2104 to right end of display. */
2105 void (*clear_end_of_line
) P_ ((int x
));
2107 /* Function to call to scroll the display as described by RUN on
2109 void (*scroll_run_hook
) P_ ((struct window
*w
, struct run
*run
));
2111 /* Function to call after a line in a display has been completely
2112 updated. Used to draw truncation marks and alike. DESIRED_ROW
2113 is the desired row which has been updated. */
2114 void (*after_update_window_line_hook
) P_ ((struct glyph_row
*desired_row
));
2116 /* Function to call before beginning to update window W in
2117 window-based redisplay. */
2118 void (*update_window_begin_hook
) P_ ((struct window
*w
));
2120 /* Function to call after window W has been updated in window-based
2121 redisplay. CURSOR_ON_P non-zero means switch cursor on.
2122 MOUSE_FACE_OVERWRITTEN_P non-zero means that some lines in W
2123 that contained glyphs in mouse-face were overwritten, so we
2124 have to update the mouse highlight. */
2125 void (*update_window_end_hook
) P_ ((struct window
*w
, int cursor_on_p
,
2126 int mouse_face_overwritten_p
));
2128 /* Move cursor to row/column position VPOS/HPOS, pixel coordinates
2129 Y/X. HPOS/VPOS are window-relative row and column numbers and X/Y
2130 are window-relative pixel positions. */
2131 void (*cursor_to
) P_ ((int vpos
, int hpos
, int y
, int x
));
2133 /* Flush the display of frame F. For X, this is XFlush. */
2134 void (*flush_display
) P_ ((struct frame
*f
));
2136 /* Flush the display of frame F if non-NULL. This is called
2137 during redisplay, and should be NULL on systems which flushes
2138 automatically before reading input. */
2139 void (*flush_display_optional
) P_ ((struct frame
*f
));
2141 /* Clear the mouse hightlight in window W, if there is any. */
2142 void (*clear_window_mouse_face
) P_ ((struct window
*w
));
2144 /* Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
2146 void (*get_glyph_overhangs
) P_ ((struct glyph
*glyph
, struct frame
*f
,
2147 int *left
, int *right
));
2149 /* Fix the display of AREA of ROW in window W for overlapping rows.
2150 This function is called from redraw_overlapping_rows after
2151 desired rows have been made current. */
2152 void (*fix_overlapping_area
) P_ ((struct window
*w
, struct glyph_row
*row
,
2153 enum glyph_row_area area
));
2155 #ifdef HAVE_WINDOW_SYSTEM
2157 /* Draw a fringe bitmap in window W of row ROW using parameters P. */
2158 void (*draw_fringe_bitmap
) P_ ((struct window
*w
, struct glyph_row
*row
,
2159 struct draw_fringe_bitmap_params
*p
));
2161 /* Define and destroy fringe bitmap no. WHICH. */
2162 void (*define_fringe_bitmap
) P_ ((int which
, unsigned short *bits
,
2164 void (*destroy_fringe_bitmap
) P_ ((int which
));
2166 /* Get metrics of character CHAR2B in FONT of type FONT_TYPE.
2167 Value is null if CHAR2B is not contained in the font. */
2168 XCharStruct
* (*per_char_metric
) P_ ((XFontStruct
*font
, XChar2b
*char2b
,
2171 /* Encode CHAR2B using encoding information from FONT_INFO. CHAR2B is
2172 the two-byte form of C. Encoding is returned in *CHAR2B. If
2173 TWO_BYTE_P is non-null, return non-zero there if font is two-byte. */
2174 int (*encode_char
) P_ ((int c
, XChar2b
*char2b
,
2175 struct font_info
*font_into
,
2176 struct charset
*charset
,
2179 /* Compute left and right overhang of glyph string S.
2180 A NULL pointer if platform does not support this. */
2181 void (*compute_glyph_string_overhangs
) P_ ((struct glyph_string
*s
));
2183 /* Draw a glyph string S. */
2184 void (*draw_glyph_string
) P_ ((struct glyph_string
*s
));
2186 /* Define cursor CURSOR on frame F. */
2187 void (*define_frame_cursor
) P_ ((struct frame
*f
, Cursor cursor
));
2189 /* Clear the area at (X,Y,WIDTH,HEIGHT) of frame F. */
2190 void (*clear_frame_area
) P_ ((struct frame
*f
, int x
, int y
,
2191 int width
, int height
));
2193 /* Draw specified cursor CURSOR_TYPE of width CURSOR_WIDTH
2194 at row GLYPH_ROW on window W if ON_P is 1. If ON_P is
2195 0, don't draw cursor. If ACTIVE_P is 1, system caret
2196 should track this cursor (when applicable). */
2197 void (*draw_window_cursor
) P_ ((struct window
*w
,
2198 struct glyph_row
*glyph_row
,
2200 int cursor_type
, int cursor_width
,
2201 int on_p
, int active_p
));
2203 /* Draw vertical border for window W from (X,Y0) to (X,Y1). */
2204 void (*draw_vertical_window_border
) P_ ((struct window
*w
,
2205 int x
, int y0
, int y1
));
2207 /* Shift display of frame F to make room for inserted glyphs.
2208 The area at pixel (X,Y) of width WIDTH and height HEIGHT is
2209 shifted right by SHIFT_BY pixels. */
2210 void (*shift_glyphs_for_insert
) P_ ((struct frame
*f
,
2211 int x
, int y
, int width
,
2212 int height
, int shift_by
));
2214 #endif /* HAVE_WINDOW_SYSTEM */
2217 /* The current interface for window-based redisplay. */
2219 extern struct redisplay_interface
*rif
;
2222 /***********************************************************************
2224 ***********************************************************************/
2226 #ifdef HAVE_WINDOW_SYSTEM
2228 /* Structure forward declarations. */
2233 /* Each image format (JPEG, TIFF, ...) supported is described by
2234 a structure of the type below. */
2238 /* A symbol uniquely identifying the image type, .e.g `jpeg'. */
2241 /* Check that SPEC is a valid image specification for the given
2242 image type. Value is non-zero if SPEC is valid. */
2243 int (* valid_p
) P_ ((Lisp_Object spec
));
2245 /* Load IMG which is used on frame F from information contained in
2246 IMG->spec. Value is non-zero if successful. */
2247 int (* load
) P_ ((struct frame
*f
, struct image
*img
));
2249 /* Free resources of image IMG which is used on frame F. */
2250 void (* free
) P_ ((struct frame
*f
, struct image
*img
));
2252 /* Next in list of all supported image types. */
2253 struct image_type
*next
;
2257 /* Structure describing an image. Specific image formats like XBM are
2258 converted into this form, so that display only has to deal with
2259 this type of image. */
2263 /* The time in seconds at which the image was last displayed. Set
2264 in prepare_image_for_display. */
2265 unsigned long timestamp
;
2267 /* Pixmaps of the image. */
2268 Pixmap pixmap
, mask
;
2270 /* Colors allocated for this image, if any. Allocated via xmalloc. */
2271 unsigned long *colors
;
2274 /* A single `background color' for this image, for the use of anyone that
2275 cares about such a thing. Only valid if the `background_valid' field
2276 is true. This should generally be accessed by calling the accessor
2277 macro `IMAGE_BACKGROUND', which will heuristically calculate a value
2279 unsigned long background
;
2281 /* True if this image has a `transparent' background -- that is, is
2282 uses an image mask. The accessor macro for this is
2283 `IMAGE_BACKGROUND_TRANSPARENT'. */
2284 unsigned background_transparent
: 1;
2286 /* True if the `background' and `background_transparent' fields are
2287 valid, respectively. */
2288 unsigned background_valid
: 1, background_transparent_valid
: 1;
2290 /* Width and height of the image. */
2293 /* These values are used for the rectangles displayed for images
2294 that can't be loaded. */
2295 #define DEFAULT_IMAGE_WIDTH 30
2296 #define DEFAULT_IMAGE_HEIGHT 30
2298 /* Percent of image height used as ascent. A value of
2299 CENTERED_IMAGE_ASCENT means draw the image centered on the
2302 #define DEFAULT_IMAGE_ASCENT 50
2303 #define CENTERED_IMAGE_ASCENT -1
2305 /* Lisp specification of this image. */
2308 /* Relief to draw around the image. */
2311 /* Optional margins around the image. This includes the relief. */
2312 int hmargin
, vmargin
;
2314 /* Reference to the type of the image. */
2315 struct image_type
*type
;
2317 /* 1 means that loading the image failed. Don't try again. */
2318 unsigned load_failed_p
;
2320 /* A place for image types to store additional data. The member
2321 data.lisp_val is marked during GC, so it's safe to store Lisp data
2322 there. Image types should free this data when their `free'
2323 function is called. */
2328 Lisp_Object lisp_val
;
2331 /* Hash value of image specification to speed up comparisons. */
2334 /* Image id of this image. */
2337 /* Hash collision chain. */
2338 struct image
*next
, *prev
;
2342 /* Cache of images. Each frame has a cache. X frames with the same
2343 x_display_info share their caches. */
2347 /* Hash table of images. */
2348 struct image
**buckets
;
2350 /* Vector mapping image ids to images. */
2351 struct image
**images
;
2353 /* Allocated size of `images'. */
2356 /* Number of images in the cache. */
2359 /* Reference count (number of frames sharing this cache). */
2364 /* Value is a pointer to the image with id ID on frame F, or null if
2365 no image with that id exists. */
2367 #define IMAGE_FROM_ID(F, ID) \
2368 (((ID) >= 0 && (ID) < (FRAME_X_IMAGE_CACHE (F)->used)) \
2369 ? FRAME_X_IMAGE_CACHE (F)->images[ID] \
2372 /* Size of bucket vector of image caches. Should be prime. */
2374 #define IMAGE_CACHE_BUCKETS_SIZE 1001
2376 #endif /* HAVE_WINDOW_SYSTEM */
2380 /***********************************************************************
2382 ***********************************************************************/
2384 /* Enumeration defining where to find tool-bar item information in
2385 tool-bar items vectors stored with frames. Each tool-bar item
2386 occupies TOOL_BAR_ITEM_NSLOTS elements in such a vector. */
2388 enum tool_bar_item_idx
2390 /* The key of the tool-bar item. Used to remove items when a binding
2391 for `undefined' is found. */
2394 /* Non-nil if item is enabled. */
2395 TOOL_BAR_ITEM_ENABLED_P
,
2397 /* Non-nil if item is selected (pressed). */
2398 TOOL_BAR_ITEM_SELECTED_P
,
2401 TOOL_BAR_ITEM_CAPTION
,
2403 /* Image(s) to display. This is either a single image specification
2404 or a vector of specifications. */
2405 TOOL_BAR_ITEM_IMAGES
,
2408 TOOL_BAR_ITEM_BINDING
,
2410 /* Button type. One of nil, `:radio' or `:toggle'. */
2416 /* Sentinel = number of slots in tool_bar_items occupied by one
2418 TOOL_BAR_ITEM_NSLOTS
2422 /* An enumeration for the different images that can be specified
2423 for a tool-bar item. */
2425 enum tool_bar_item_image
2427 TOOL_BAR_IMAGE_ENABLED_SELECTED
,
2428 TOOL_BAR_IMAGE_ENABLED_DESELECTED
,
2429 TOOL_BAR_IMAGE_DISABLED_SELECTED
,
2430 TOOL_BAR_IMAGE_DISABLED_DESELECTED
2433 /* Margin around tool-bar buttons in pixels. */
2435 extern Lisp_Object Vtool_bar_button_margin
;
2437 /* Thickness of relief to draw around tool-bar buttons. */
2439 extern EMACS_INT tool_bar_button_relief
;
2441 /* Default values of the above variables. */
2443 #define DEFAULT_TOOL_BAR_BUTTON_MARGIN 4
2444 #define DEFAULT_TOOL_BAR_BUTTON_RELIEF 1
2446 /* The height in pixels of the default tool-bar images. */
2448 #define DEFAULT_TOOL_BAR_IMAGE_HEIGHT 24
2451 /***********************************************************************
2452 Terminal Capabilities
2453 ***********************************************************************/
2455 /* Each of these is a bit representing a terminal `capability' (bold,
2456 inverse, etc). They are or'd together to specify the set of
2457 capabilities being queried for when calling `tty_capable_p' (which
2458 returns true if the terminal supports all of them). */
2460 #define TTY_CAP_INVERSE 0x01
2461 #define TTY_CAP_UNDERLINE 0x02
2462 #define TTY_CAP_BOLD 0x04
2463 #define TTY_CAP_DIM 0x08
2464 #define TTY_CAP_BLINK 0x10
2465 #define TTY_CAP_ALT_CHARSET 0x20
2468 /***********************************************************************
2470 ***********************************************************************/
2472 /* Defined in xdisp.c */
2474 struct glyph_row
*row_containing_pos
P_ ((struct window
*, int,
2476 struct glyph_row
*, int));
2477 int string_buffer_position
P_ ((struct window
*, Lisp_Object
, int));
2478 int line_bottom_y
P_ ((struct it
*));
2479 int display_prop_intangible_p
P_ ((Lisp_Object
));
2480 void resize_echo_area_exactly
P_ ((void));
2481 int resize_mini_window
P_ ((struct window
*, int));
2482 int try_window
P_ ((Lisp_Object
, struct text_pos
));
2483 void window_box
P_ ((struct window
*, int, int *, int *, int *, int *));
2484 int window_box_height
P_ ((struct window
*));
2485 int window_text_bottom_y
P_ ((struct window
*));
2486 int window_box_width
P_ ((struct window
*, int));
2487 int window_box_left
P_ ((struct window
*, int));
2488 int window_box_left_offset
P_ ((struct window
*, int));
2489 int window_box_right
P_ ((struct window
*, int));
2490 int window_box_right_offset
P_ ((struct window
*, int));
2491 void window_box_edges
P_ ((struct window
*, int, int *, int *, int *, int *));
2492 int estimate_mode_line_height
P_ ((struct frame
*, enum face_id
));
2493 void pixel_to_glyph_coords
P_ ((struct frame
*, int, int, int *, int *,
2494 NativeRectangle
*, int));
2495 int glyph_to_pixel_coords
P_ ((struct window
*, int, int, int *, int *));
2496 void mark_window_display_accurate
P_ ((Lisp_Object
, int));
2497 void redisplay_preserve_echo_area
P_ ((int));
2498 void set_cursor_from_row
P_ ((struct window
*, struct glyph_row
*,
2499 struct glyph_matrix
*, int, int, int, int));
2500 void init_iterator
P_ ((struct it
*, struct window
*, int,
2501 int, struct glyph_row
*, enum face_id
));
2502 void init_iterator_to_row_start
P_ ((struct it
*, struct window
*,
2503 struct glyph_row
*));
2504 int get_next_display_element
P_ ((struct it
*));
2505 void set_iterator_to_next
P_ ((struct it
*, int));
2506 void produce_glyphs
P_ ((struct it
*));
2507 void produce_special_glyphs
P_ ((struct it
*, enum display_element_type
));
2508 void start_display
P_ ((struct it
*, struct window
*, struct text_pos
));
2509 void move_it_to
P_ ((struct it
*, int, int, int, int, int));
2510 void move_it_vertically
P_ ((struct it
*, int));
2511 void move_it_vertically_backward
P_ ((struct it
*, int));
2512 void move_it_by_lines
P_ ((struct it
*, int, int));
2513 void move_it_past_eol
P_ ((struct it
*));
2514 int in_display_vector_p
P_ ((struct it
*));
2515 int frame_mode_line_height
P_ ((struct frame
*));
2516 void highlight_trailing_whitespace
P_ ((struct frame
*, struct glyph_row
*));
2517 extern Lisp_Object Qtool_bar
;
2518 extern Lisp_Object Vshow_trailing_whitespace
;
2519 extern int mode_line_in_non_selected_windows
;
2520 extern int redisplaying_p
;
2521 extern Lisp_Object Vimage_types
;
2522 extern void add_to_log
P_ ((char *, Lisp_Object
, Lisp_Object
));
2523 extern int help_echo_showing_p
;
2524 extern int current_mode_line_height
, current_header_line_height
;
2525 extern Lisp_Object help_echo_string
, help_echo_window
;
2526 extern Lisp_Object help_echo_object
, previous_help_echo_string
;
2527 extern int help_echo_pos
;
2528 extern struct frame
*last_mouse_frame
;
2529 extern int last_tool_bar_item
;
2530 extern int mouse_autoselect_window
;
2532 extern int calc_pixel_width_or_height
P_ ((double *, struct it
*, Lisp_Object
,
2533 /* XFontStruct */ void *, int, int *));
2535 #ifdef HAVE_WINDOW_SYSTEM
2538 extern void dump_glyph_string
P_ ((struct glyph_string
*));
2541 extern void x_get_glyph_overhangs
P_ ((struct glyph
*, struct frame
*,
2543 extern void x_produce_glyphs
P_ ((struct it
*));
2545 extern void x_write_glyphs
P_ ((struct glyph
*, int));
2546 extern void x_insert_glyphs
P_ ((struct glyph
*, int len
));
2547 extern void x_clear_end_of_line
P_ ((int));
2549 extern int x_stretch_cursor_p
;
2550 extern struct cursor_pos output_cursor
;
2552 extern void x_fix_overlapping_area
P_ ((struct window
*, struct glyph_row
*,
2553 enum glyph_row_area
));
2554 extern void draw_phys_cursor_glyph
P_ ((struct window
*,
2556 enum draw_glyphs_face
));
2557 extern void erase_phys_cursor
P_ ((struct window
*));
2558 extern void display_and_set_cursor
P_ ((struct window
*,
2559 int, int, int, int, int));
2561 extern void set_output_cursor
P_ ((struct cursor_pos
*));
2562 extern void x_cursor_to
P_ ((int, int, int, int));
2564 extern void x_update_cursor
P_ ((struct frame
*, int));
2565 extern void x_clear_cursor
P_ ((struct window
*));
2566 extern void x_draw_vertical_border
P_ ((struct window
*w
));
2568 extern void frame_to_window_pixel_xy
P_ ((struct window
*, int *, int *));
2569 extern void get_glyph_string_clip_rect
P_ ((struct glyph_string
*,
2570 NativeRectangle
*nr
));
2571 extern Lisp_Object find_hot_spot
P_ ((Lisp_Object
, int, int));
2572 extern void note_mouse_highlight
P_ ((struct frame
*, int, int));
2573 extern void x_clear_window_mouse_face
P_ ((struct window
*));
2574 extern void cancel_mouse_face
P_ ((struct frame
*));
2576 extern void handle_tool_bar_click
P_ ((struct frame
*,
2577 int, int, int, unsigned int));
2579 /* msdos.c defines its own versions of these functions. */
2580 extern int clear_mouse_face
P_ ((Display_Info
*));
2581 extern void show_mouse_face
P_ ((Display_Info
*, enum draw_glyphs_face
));
2582 extern int cursor_in_mouse_face_p
P_ ((struct window
*w
));
2584 extern void expose_frame
P_ ((struct frame
*, int, int, int, int));
2585 extern int x_intersect_rectangles
P_ ((XRectangle
*, XRectangle
*,
2589 /* Defined in fringe.c */
2591 int valid_fringe_bitmap_id_p (int);
2592 void draw_fringe_bitmap
P_ ((struct window
*, struct glyph_row
*, int));
2593 void draw_row_fringe_bitmaps
P_ ((struct window
*, struct glyph_row
*));
2594 void draw_window_fringes
P_ ((struct window
*));
2595 int update_window_fringes
P_ ((struct window
*, int));
2596 void compute_fringe_widths
P_ ((struct frame
*, int));
2599 void w32_init_fringe
P_ ((void));
2600 void w32_reset_fringes
P_ ((void));
2603 /* Defined in image.c */
2605 #ifdef HAVE_WINDOW_SYSTEM
2607 extern int x_bitmap_height
P_ ((struct frame
*, int));
2608 extern int x_bitmap_width
P_ ((struct frame
*, int));
2609 extern int x_bitmap_pixmap
P_ ((struct frame
*, int));
2610 extern void x_reference_bitmap
P_ ((struct frame
*, int));
2611 extern int x_create_bitmap_from_data
P_ ((struct frame
*, char *,
2612 unsigned int, unsigned int));
2613 extern int x_create_bitmap_from_file
P_ ((struct frame
*, Lisp_Object
));
2614 #ifndef x_destroy_bitmap
2615 extern void x_destroy_bitmap
P_ ((struct frame
*, int));
2617 extern void x_destroy_all_bitmaps
P_ ((Display_Info
*));
2618 extern int x_create_bitmap_mask
P_ ((struct frame
* , int));
2619 extern Lisp_Object x_find_image_file
P_ ((Lisp_Object
));
2621 void x_kill_gs_process
P_ ((Pixmap
, struct frame
*));
2622 struct image_cache
*make_image_cache
P_ ((void));
2623 void free_image_cache
P_ ((struct frame
*));
2624 void clear_image_cache
P_ ((struct frame
*, int));
2625 void forall_images_in_image_cache
P_ ((struct frame
*,
2626 void (*) P_ ((struct image
*))));
2627 int valid_image_p
P_ ((Lisp_Object
));
2628 void prepare_image_for_display
P_ ((struct frame
*, struct image
*));
2629 int lookup_image
P_ ((struct frame
*, Lisp_Object
));
2631 unsigned long image_background
P_ ((struct image
*, struct frame
*,
2632 XImagePtr_or_DC ximg
));
2633 int image_background_transparent
P_ ((struct image
*, struct frame
*,
2634 XImagePtr_or_DC mask
));
2638 /* Defined in sysdep.c */
2640 void get_frame_size
P_ ((int *, int *));
2641 void request_sigio
P_ ((void));
2642 void unrequest_sigio
P_ ((void));
2643 int tabs_safe_p
P_ ((void));
2644 void init_baud_rate
P_ ((void));
2645 void init_sigio
P_ ((int));
2647 /* Defined in xfaces.c */
2649 #ifdef HAVE_X_WINDOWS
2650 void x_free_colors
P_ ((struct frame
*, unsigned long *, int));
2653 void update_face_from_frame_parameter
P_ ((struct frame
*, Lisp_Object
,
2655 Lisp_Object tty_color_name
P_ ((struct frame
*, int));
2656 void clear_face_cache
P_ ((int));
2657 unsigned long load_color
P_ ((struct frame
*, struct face
*, Lisp_Object
,
2658 enum lface_attribute_index
));
2659 void unload_color
P_ ((struct frame
*, unsigned long));
2660 char *choose_face_font
P_ ((struct frame
*, Lisp_Object
*, Lisp_Object
,
2662 int ascii_face_of_lisp_face
P_ ((struct frame
*, int));
2663 void prepare_face_for_display
P_ ((struct frame
*, struct face
*));
2664 int xstricmp
P_ ((const unsigned char *, const unsigned char *));
2665 int lookup_face
P_ ((struct frame
*, Lisp_Object
*));
2666 int lookup_non_ascii_face
P_ ((struct frame
*, int, struct face
*));
2667 int lookup_named_face
P_ ((struct frame
*, Lisp_Object
));
2668 int smaller_face
P_ ((struct frame
*, int, int));
2669 int face_with_height
P_ ((struct frame
*, int, int));
2670 int lookup_derived_face
P_ ((struct frame
*, Lisp_Object
, int));
2671 void init_frame_faces
P_ ((struct frame
*));
2672 void free_frame_faces
P_ ((struct frame
*));
2673 void recompute_basic_faces
P_ ((struct frame
*));
2674 int face_at_buffer_position
P_ ((struct window
*, int, int, int, int *,
2676 int face_at_string_position
P_ ((struct window
*, Lisp_Object
, int, int, int,
2677 int, int *, enum face_id
, int));
2678 int compute_char_face
P_ ((struct frame
*, int, Lisp_Object
));
2679 void free_all_realized_faces
P_ ((Lisp_Object
));
2680 void free_realized_face
P_ ((struct frame
*, struct face
*));
2681 extern Lisp_Object Qforeground_color
, Qbackground_color
;
2682 extern char unspecified_fg
[], unspecified_bg
[];
2683 extern Lisp_Object split_font_name_into_vector
P_ ((Lisp_Object
));
2684 extern Lisp_Object build_font_name_from_vector
P_ ((Lisp_Object
));
2686 /* Defined in xfns.c */
2688 #ifdef HAVE_X_WINDOWS
2689 void gamma_correct
P_ ((struct frame
*, XColor
*));
2692 void gamma_correct
P_ ((struct frame
*, COLORREF
*));
2695 void gamma_correct
P_ ((struct frame
*, unsigned long *));
2698 #ifdef HAVE_WINDOW_SYSTEM
2700 int x_screen_planes
P_ ((struct frame
*));
2701 void x_implicitly_set_name
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
2703 extern Lisp_Object tip_frame
;
2704 extern Window tip_window
;
2705 EXFUN (Fx_show_tip
, 6);
2706 EXFUN (Fx_hide_tip
, 0);
2707 extern void start_hourglass
P_ ((void));
2708 extern void cancel_hourglass
P_ ((void));
2709 extern int display_hourglass_p
;
2711 /* Returns the background color of IMG, calculating one heuristically if
2712 necessary. If non-zero, XIMG is an existing XImage object to use for
2715 #define IMAGE_BACKGROUND(img, f, ximg) \
2716 ((img)->background_valid \
2717 ? (img)->background \
2718 : image_background (img, f, ximg))
2720 /* Returns true if IMG has a `transparent' background, using heuristics
2721 to decide if necessary. If non-zero, MASK is an existing XImage
2722 object to use for the heuristic. */
2724 #define IMAGE_BACKGROUND_TRANSPARENT(img, f, mask) \
2725 ((img)->background_transparent_valid \
2726 ? (img)->background_transparent \
2727 : image_background_transparent (img, f, mask))
2729 #endif /* HAVE_WINDOW_SYSTEM */
2732 /* Defined in xmenu.c */
2734 int popup_activated
P_ ((void));
2736 /* Defined in dispnew.c */
2738 extern int inverse_video
;
2739 extern int required_matrix_width
P_ ((struct window
*));
2740 extern int required_matrix_height
P_ ((struct window
*));
2741 extern Lisp_Object buffer_posn_from_coords
P_ ((struct window
*,
2743 struct display_pos
*,
2745 int *, int *, int *, int *));
2746 extern Lisp_Object mode_line_string
P_ ((struct window
*, enum window_part
,
2747 int *, int *, int *,
2749 int *, int *, int *, int *));
2750 extern Lisp_Object marginal_area_string
P_ ((struct window
*, enum window_part
,
2751 int *, int *, int *,
2753 int *, int *, int *, int *));
2754 extern void redraw_frame
P_ ((struct frame
*));
2755 extern void redraw_garbaged_frames
P_ ((void));
2756 extern void cancel_line
P_ ((int, struct frame
*));
2757 extern void init_desired_glyphs
P_ ((struct frame
*));
2758 extern int scroll_frame_lines
P_ ((struct frame
*, int, int, int, int));
2759 extern int direct_output_for_insert
P_ ((int));
2760 extern int direct_output_forward_char
P_ ((int));
2761 extern int update_frame
P_ ((struct frame
*, int, int));
2762 extern int scrolling
P_ ((struct frame
*));
2763 extern void bitch_at_user
P_ ((void));
2764 void adjust_glyphs
P_ ((struct frame
*));
2765 void free_glyphs
P_ ((struct frame
*));
2766 void free_window_matrices
P_ ((struct window
*));
2767 void check_glyph_memory
P_ ((void));
2768 void mirrored_line_dance
P_ ((struct glyph_matrix
*, int, int, int *, char *));
2769 void clear_glyph_matrix
P_ ((struct glyph_matrix
*));
2770 void clear_current_matrices
P_ ((struct frame
*f
));
2771 void clear_desired_matrices
P_ ((struct frame
*));
2772 void shift_glyph_matrix
P_ ((struct window
*, struct glyph_matrix
*,
2774 void rotate_matrix
P_ ((struct glyph_matrix
*, int, int, int));
2775 void increment_matrix_positions
P_ ((struct glyph_matrix
*,
2776 int, int, int, int));
2777 void blank_row
P_ ((struct window
*, struct glyph_row
*, int));
2778 void increment_row_positions
P_ ((struct glyph_row
*, int, int));
2779 void enable_glyph_matrix_rows
P_ ((struct glyph_matrix
*, int, int, int));
2780 void clear_glyph_row
P_ ((struct glyph_row
*));
2781 void prepare_desired_row
P_ ((struct glyph_row
*));
2782 int line_hash_code
P_ ((struct glyph_row
*));
2783 void set_window_update_flags
P_ ((struct window
*, int));
2784 void write_glyphs
P_ ((struct glyph
*, int));
2785 void insert_glyphs
P_ ((struct glyph
*, int));
2786 void redraw_frame
P_ ((struct frame
*));
2787 void redraw_garbaged_frames
P_ ((void));
2788 int scroll_cost
P_ ((struct frame
*, int, int, int));
2789 int direct_output_for_insert
P_ ((int));
2790 int direct_output_forward_char
P_ ((int));
2791 int update_frame
P_ ((struct frame
*, int, int));
2792 void update_single_window
P_ ((struct window
*, int));
2793 int scrolling
P_ ((struct frame
*));
2794 void do_pending_window_change
P_ ((int));
2795 void change_frame_size
P_ ((struct frame
*, int, int, int, int, int));
2796 void bitch_at_user
P_ ((void));
2797 Lisp_Object sit_for
P_ ((int, int, int, int, int));
2798 void init_display
P_ ((void));
2799 void syms_of_display
P_ ((void));
2800 extern Lisp_Object Qredisplay_dont_pause
;
2802 /* Defined in term.c */
2804 extern void ring_bell
P_ ((void));
2805 extern void set_terminal_modes
P_ ((void));
2806 extern void reset_terminal_modes
P_ ((void));
2807 extern void update_begin
P_ ((struct frame
*));
2808 extern void update_end
P_ ((struct frame
*));
2809 extern void set_terminal_window
P_ ((int));
2810 extern void set_scroll_region
P_ ((int, int));
2811 extern void turn_off_insert
P_ ((void));
2812 extern void turn_off_highlight
P_ ((void));
2813 extern void background_highlight
P_ ((void));
2814 extern void clear_frame
P_ ((void));
2815 extern void clear_end_of_line
P_ ((int));
2816 extern void clear_end_of_line_raw
P_ ((int));
2817 extern void delete_glyphs
P_ ((int));
2818 extern void ins_del_lines
P_ ((int, int));
2819 extern int string_cost
P_ ((char *));
2820 extern int per_line_cost
P_ ((char *));
2821 extern void calculate_costs
P_ ((struct frame
*));
2822 extern void set_tty_color_mode
P_ ((struct frame
*, Lisp_Object
));
2823 extern void tty_setup_colors
P_ ((int));
2824 extern void term_init
P_ ((char *));
2825 extern void fatal
P_ ((/* char *, ... */));
2826 void cursor_to
P_ ((int, int));
2827 extern int tty_capable_p
P_ ((struct frame
*, unsigned, unsigned long, unsigned long));
2829 /* Defined in scroll.c */
2831 extern int scrolling_max_lines_saved
P_ ((int, int, int *, int *, int *));
2832 extern int scroll_cost
P_ ((struct frame
*, int, int, int));
2833 extern void do_line_insertion_deletion_costs
P_ ((struct frame
*, char *,
2834 char *, char *, char *,
2835 char *, char *, int));
2836 void scrolling_1
P_ ((struct frame
*, int, int, int, int *, int *, int *,
2839 /* Defined in frame.c */
2841 #ifdef HAVE_WINDOW_SYSTEM
2843 /* Types we might convert a resource string into. */
2853 extern Lisp_Object x_get_arg
P_ ((Display_Info
*, Lisp_Object
,
2854 Lisp_Object
, char *, char *class,
2855 enum resource_types
));
2856 extern Lisp_Object x_frame_get_arg
P_ ((struct frame
*, Lisp_Object
,
2857 Lisp_Object
, char *, char *,
2858 enum resource_types
));
2859 extern Lisp_Object x_frame_get_and_record_arg
P_ ((
2860 struct frame
*, Lisp_Object
,
2861 Lisp_Object
, char *, char *,
2862 enum resource_types
));
2863 extern Lisp_Object x_default_parameter
P_ ((struct frame
*, Lisp_Object
,
2864 Lisp_Object
, Lisp_Object
,
2866 enum resource_types
));
2868 #endif /* HAVE_WINDOW_SYSTEM */
2870 #endif /* not DISPEXTERN_H_INCLUDED */
2872 /* arch-tag: c65c475f-1c1e-4534-8795-990b8509fd65
2873 (do not change this comment) */