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 */
59 /* Structure forward declarations. Some are here because function
60 prototypes below reference structure types before their definition
61 in this file. Some are here because not every file including
62 dispextern.h also includes frame.h and windows.h. */
73 /***********************************************************************
75 ***********************************************************************/
77 /* If GLYPH_DEBUG is non-zero, additional checks are activated. Turn
78 it off by defining the macro GLYPH_DEBUG to zero. */
84 /* Macros to include code only if GLYPH_DEBUG != 0. */
88 #define xassert(X) do {if (!(X)) abort ();} while (0)
90 #define IF_DEBUG(X) (void) 0
91 #define xassert(X) (void) 0
94 /* Macro for displaying traces of redisplay. If Emacs was compiled
95 with GLYPH_DEBUG != 0, the variable trace_redisplay_p can be set to
96 a non-zero value in debugging sessions to activate traces. */
100 extern int trace_redisplay_p
;
104 if (trace_redisplay_p) \
109 #else /* GLYPH_DEBUG == 0 */
111 #define TRACE(X) (void) 0
113 #endif /* GLYPH_DEBUG == 0 */
117 /***********************************************************************
119 ***********************************************************************/
121 /* Starting with Emacs 20.3, characters from strings and buffers have
122 both a character and a byte position associated with them. The
123 following structure holds such a pair of positions. */
127 /* Character position. */
130 /* Corresponding byte position. */
134 /* Access character and byte position of POS in a functional form. */
136 #define BYTEPOS(POS) (POS).bytepos
137 #define CHARPOS(POS) (POS).charpos
139 /* Set character position of POS to CHARPOS, byte position to BYTEPOS. */
141 #define SET_TEXT_POS(POS, CHARPOS, BYTEPOS) \
142 ((POS).charpos = (CHARPOS), (POS).bytepos = BYTEPOS)
144 /* Increment text position POS. */
146 #define INC_TEXT_POS(POS, MULTIBYTE_P) \
151 INC_POS ((POS).bytepos); \
157 /* Decrement text position POS. */
159 #define DEC_TEXT_POS(POS, MULTIBYTE_P) \
164 DEC_POS ((POS).bytepos); \
170 /* Set text position POS from marker MARKER. */
172 #define SET_TEXT_POS_FROM_MARKER(POS, MARKER) \
173 (CHARPOS (POS) = marker_position ((MARKER)), \
174 BYTEPOS (POS) = marker_byte_position ((MARKER)))
176 /* Set marker MARKER from text position POS. */
178 #define SET_MARKER_FROM_TEXT_POS(MARKER, POS) \
179 set_marker_both ((MARKER), Qnil, CHARPOS ((POS)), BYTEPOS ((POS)))
181 /* Value is non-zero if character and byte positions of POS1 and POS2
184 #define TEXT_POS_EQUAL_P(POS1, POS2) \
185 ((POS1).charpos == (POS2).charpos \
186 && (POS1).bytepos == (POS2).bytepos)
188 /* When rendering glyphs, redisplay scans string or buffer text,
189 overlay strings in that text, and does display table or control
190 character translations. The following structure captures a
191 position taking all this into account. */
195 /* Buffer or string position. */
198 /* If this is a position in an overlay string, overlay_string_index
199 is the index of that overlay string in the sequence of overlay
200 strings at `pos' in the order redisplay processes them. A value
201 < 0 means that this is not a position in an overlay string. */
202 int overlay_string_index
;
204 /* If this is a position in an overlay string, string_pos is the
205 position within that string. */
206 struct text_pos string_pos
;
208 /* If the character at the position above is a control character or
209 has a display table entry, dpvec_index is an index in the display
210 table or control character translation of that character. A
211 value < 0 means this is not a position in such a translation. */
217 /***********************************************************************
219 ***********************************************************************/
221 /* Enumeration of glyph types. Glyph structures contain a type field
222 containing one of the enumerators defined here. */
226 /* Glyph describes a character. */
229 /* Glyph describes a composition sequence. */
232 /* Glyph describes an image. */
235 /* Glyph is a space of fractional width and/or height. */
242 Be extra careful when changing this structure! Esp. make sure that
243 functions producing glyphs, like append_glyph, fill ALL of the
244 glyph structure, and that GLYPH_EQUAL_P compares all
245 display-relevant members of glyphs (not to imply that these are the
246 only things to check when you add a member). */
250 /* Position from which this glyph was drawn. If `object' below is a
251 Lisp string, this is a position in that string. If it is a
252 buffer, this is a position in that buffer. A value of -1
253 together with a null object means glyph is a truncation glyph at
254 the start of a row. */
257 /* Lisp object source of this glyph. Currently either a buffer or
258 a string, if the glyph was produced from characters which came from
259 a buffer or a string; or 0 if the glyph was inserted by redisplay
260 for its own purposes such as padding. */
263 /* Width in pixels. */
266 /* Vertical offset. If < 0, the glyph is displayed raised, if > 0
267 the glyph is displayed lowered. */
270 /* Which kind of glyph this is---character, image etc. Value
271 should be an enumerator of type enum glyph_type. */
274 /* 1 means this glyph was produced from multibyte text. Zero
275 means it was produced from unibyte text, i.e. charsets aren't
276 applicable, and encoding is not performed. */
277 unsigned multibyte_p
: 1;
279 /* Non-zero means draw a box line at the left or right side of this
280 glyph. This is part of the implementation of the face attribute
282 unsigned left_box_line_p
: 1;
283 unsigned right_box_line_p
: 1;
285 /* Non-zero means this glyph's physical ascent or descent is greater
286 than its logical ascent/descent, i.e. it may potentially overlap
287 glyphs above or below it. */
288 unsigned overlaps_vertically_p
: 1;
290 /* 1 means glyph is a padding glyph. Padding glyphs are used for
291 characters whose visual shape consists of more than one glyph
292 (e.g. Asian characters). All but the first glyph of such a glyph
293 sequence have the padding_p flag set. Only used for terminal
294 frames, and there only to minimize code changes. A better way
295 would probably be to use the width field of glyphs to express
297 unsigned padding_p
: 1;
299 /* 1 means the actual glyph is not available, draw a box instead.
300 This can happen when a font couldn't be loaded, or a character
301 doesn't have a glyph in a font. */
302 unsigned glyph_not_available_p
: 1;
304 /* Face of the glyph. */
305 unsigned face_id
: 21;
307 /* Type of font used to display the character glyph. May be used to
308 determine which set of functions to use to obtain font metrics
309 for the glyph. On W32, value should be an enumerator of the type
310 w32_char_font_type. Otherwise it equals FONT_TYPE_UNKNOWN. */
311 unsigned font_type
: 3;
313 /* A union of sub-structures for different glyph types. */
316 /* Character code for character glyphs (type == CHAR_GLYPH). */
319 /* Composition ID for composition glyphs (type == COMPOSITION_GLYPH) */
322 /* Image ID for image glyphs (type == IMAGE_GLYPH). */
325 /* Sub-structure for type == STRETCH_GLYPH. */
328 /* The height of the glyph. */
329 unsigned height
: 16;
331 /* The ascent of the glyph. */
332 unsigned ascent
: 16;
336 /* Used to compare all bit-fields above in one step. */
342 /* Default value of the glyph font_type field. */
344 #define FONT_TYPE_UNKNOWN 0
346 /* Is GLYPH a space? */
348 #define CHAR_GLYPH_SPACE_P(GLYPH) \
349 (GLYPH_FROM_CHAR_GLYPH ((GLYPH)) == SPACEGLYPH)
351 /* Are glyphs *X and *Y displayed equal? */
353 #define GLYPH_EQUAL_P(X, Y) \
354 ((X)->type == (Y)->type \
355 && (X)->u.val == (Y)->u.val \
356 && (X)->face_id == (Y)->face_id \
357 && (X)->padding_p == (Y)->padding_p \
358 && (X)->left_box_line_p == (Y)->left_box_line_p \
359 && (X)->right_box_line_p == (Y)->right_box_line_p \
360 && (X)->voffset == (Y)->voffset \
361 && (X)->pixel_width == (Y)->pixel_width)
363 /* Are character codes, faces, padding_ps of glyphs *X and *Y equal? */
365 #define GLYPH_CHAR_AND_FACE_EQUAL_P(X, Y) \
366 ((X)->u.ch == (Y)->u.ch \
367 && (X)->face_id == (Y)->face_id \
368 && (X)->padding_p == (Y)->padding_p)
370 /* Fill a character glyph GLYPH. CODE, FACE_ID, PADDING_P correspond
371 to the bits defined for the typedef `GLYPH' in lisp.h. */
373 #define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P) \
376 (GLYPH).u.ch = (CODE); \
377 (GLYPH).face_id = (FACE_ID); \
378 (GLYPH).padding_p = (PADDING_P); \
382 /* Fill a character type glyph GLYPH from a glyph typedef FROM as
383 defined in lisp.h. */
385 #define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM) \
386 SET_CHAR_GLYPH ((GLYPH), \
387 FAST_GLYPH_CHAR ((FROM)), \
388 FAST_GLYPH_FACE ((FROM)), \
391 /* Construct a glyph code from a character glyph GLYPH. If the
392 character is multibyte, return -1 as we can't use glyph table for a
393 multibyte character. */
395 #define GLYPH_FROM_CHAR_GLYPH(GLYPH) \
396 ((GLYPH).u.ch < 256 \
397 ? ((GLYPH).u.ch | ((GLYPH).face_id << CHARACTERBITS)) \
400 /* Is GLYPH a padding glyph? */
402 #define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p
407 /***********************************************************************
409 ***********************************************************************/
413 Glyph memory for frame-based redisplay is allocated from the heap
414 in one vector kept in a glyph pool structure which is stored with
415 the frame. The size of the vector is made large enough to cover
416 all windows on the frame.
418 Both frame and window glyph matrices reference memory from a glyph
419 pool in frame-based redisplay.
421 In window-based redisplay, no glyphs pools exist; windows allocate
422 and free their glyph memory themselves. */
426 /* Vector of glyphs allocated from the heap. */
427 struct glyph
*glyphs
;
429 /* Allocated size of `glyphs'. */
432 /* Number of rows and columns in a matrix. */
438 /***********************************************************************
440 ***********************************************************************/
444 Three kinds of glyph matrices exist:
446 1. Frame glyph matrices. These are used for terminal frames whose
447 redisplay needs a view of the whole screen due to limited terminal
448 capabilities. Frame matrices are used only in the update phase
449 of redisplay. They are built in update_frame and not used after
450 the update has been performed.
452 2. Window glyph matrices on frames having frame glyph matrices.
453 Such matrices are sub-matrices of their corresponding frame matrix,
454 i.e. frame glyph matrices and window glyph matrices share the same
455 glyph memory which is allocated in form of a glyph_pool structure.
456 Glyph rows in such a window matrix are slices of frame matrix rows.
458 2. Free-standing window glyph matrices managing their own glyph
459 storage. This form is used in window-based redisplay which
460 includes variable width and height fonts etc.
462 The size of a window's row vector depends on the height of fonts
463 defined on its frame. It is chosen so that the vector is large
464 enough to describe all lines in a window when it is displayed in
465 the smallest possible character size. When new fonts are loaded,
466 or window sizes change, the row vector is adjusted accordingly. */
470 /* The pool from which glyph memory is allocated, if any. This is
471 null for frame matrices and for window matrices managing their
473 struct glyph_pool
*pool
;
475 /* Vector of glyph row structures. The row at nrows - 1 is reserved
476 for the mode line. */
477 struct glyph_row
*rows
;
479 /* Number of elements allocated for the vector rows above. */
482 /* The number of rows used by the window if all lines were displayed
483 with the smallest possible character height. */
486 /* Origin within the frame matrix if this is a window matrix on a
487 frame having a frame matrix. Both values are zero for
488 window-based redisplay. */
489 int matrix_x
, matrix_y
;
491 /* Width and height of the matrix in columns and rows. */
492 int matrix_w
, matrix_h
;
494 /* If this structure describes a window matrix of window W,
495 window_left_x is the value of W->left, window_top_y the value of
496 W->top, window_height and window_width are width and height of W,
497 as returned by window_box, and window_vscroll is the value of
498 W->vscroll at the time the matrix was last adjusted. Only set
499 for window-based redisplay. */
500 int window_left_x
, window_top_y
, window_height
, window_width
, window_vscroll
;
502 /* Number of glyphs reserved for left and right marginal areas when
503 the matrix was last adjusted. */
504 int left_margin_glyphs
, right_margin_glyphs
;
506 /* Flag indicating that scrolling should not be tried in
507 update_window. This flag is set by functions like try_window_id
508 which do their own scrolling. */
509 unsigned no_scrolling_p
: 1;
511 /* Non-zero means window displayed in this matrix has a top mode
513 unsigned header_line_p
: 1;
516 /* A string identifying the method used to display the matrix. */
520 /* The buffer this matrix displays. Set in
521 mark_window_display_accurate_1. */
522 struct buffer
*buffer
;
524 /* Values of BEGV and ZV as of last redisplay. Set in
525 mark_window_display_accurate_1. */
530 /* Check that glyph pointers stored in glyph rows of MATRIX are okay.
531 This aborts if any pointer is found twice. */
534 void check_matrix_pointer_lossage
P_ ((struct glyph_matrix
*));
535 #define CHECK_MATRIX(MATRIX) check_matrix_pointer_lossage ((MATRIX))
537 #define CHECK_MATRIX(MATRIX) (void) 0
542 /***********************************************************************
544 ***********************************************************************/
546 /* Area in window glyph matrix. If values are added or removed, the
547 function mark_object in alloc.c has to be changed. */
558 /* Rows of glyphs in a windows or frame glyph matrix.
560 Each row is partitioned into three areas. The start and end of
561 each area is recorded in a pointer as shown below.
563 +--------------------+-------------+---------------------+
564 | left margin area | text area | right margin area |
565 +--------------------+-------------+---------------------+
567 glyphs[LEFT_MARGIN_AREA] glyphs[RIGHT_MARGIN_AREA]
572 Rows in frame matrices reference glyph memory allocated in a frame
573 glyph pool (see the description of struct glyph_pool). Rows in
574 window matrices on frames having frame matrices reference slices of
575 the glyphs of corresponding rows in the frame matrix.
577 Rows in window matrices on frames having no frame matrices point to
578 glyphs allocated from the heap via xmalloc;
579 glyphs[LEFT_MARGIN_AREA] is the start address of the allocated
580 glyph structure array. */
584 /* Pointers to beginnings of areas. The end of an area A is found at
585 A + 1 in the vector. The last element of the vector is the end
588 Kludge alert: Even if used[TEXT_AREA] == 0, glyphs[TEXT_AREA][0]'s
589 position field is used. It is -1 if this row does not correspond
590 to any text; it is some buffer position if the row corresponds to
591 an empty display line that displays a line end. This is what old
592 redisplay used to do. (Except in code for terminal frames, this
593 kludge is no longer used, I believe. --gerd).
595 See also start, end, displays_text_p and ends_at_zv_p for cleaner
596 ways to do it. The special meaning of positions 0 and -1 will be
597 removed some day, so don't use it in new code. */
598 struct glyph
*glyphs
[1 + LAST_AREA
];
600 /* Number of glyphs actually filled in areas. */
601 short used
[LAST_AREA
];
603 /* Window-relative x and y-position of the top-left corner of this
604 row. If y < 0, this means that abs (y) pixels of the row are
605 invisible because it is partially visible at the top of a window.
606 If x < 0, this means that abs (x) pixels of the first glyph of
607 the text area of the row are invisible because the glyph is
608 partially visible. */
611 /* Width of the row in pixels without taking face extension at the
612 end of the row into account, and without counting truncation
613 and continuation glyphs at the end of a row on ttys. */
616 /* Logical ascent/height of this line. The value of ascent is zero
617 and height is 1 on terminal frames. */
620 /* Physical ascent/height of this line. If max_ascent > ascent,
621 this line overlaps the line above it on the display. Otherwise,
622 if max_height > height, this line overlaps the line beneath it. */
623 int phys_ascent
, phys_height
;
625 /* Portion of row that is visible. Partially visible rows may be
626 found at the top and bottom of a window. This is 1 for tty
627 frames. It may be < 0 in case of completely invisible rows. */
630 /* Hash code. This hash code is available as soon as the row
631 is constructed, i.e. after a call to display_line. */
634 /* First position in this row. This is the text position, including
635 overlay position information etc, where the display of this row
636 started, and can thus be less the position of the first glyph
637 (e.g. due to invisible text or horizontal scrolling). */
638 struct display_pos start
;
640 /* Text position at the end of this row. This is the position after
641 the last glyph on this row. It can be greater than the last
642 glyph position + 1, due to truncation, invisible text etc. In an
643 up-to-date display, this should always be equal to the start
644 position of the next row. */
645 struct display_pos end
;
647 /* In a desired matrix, 1 means that this row must be updated. In a
648 current matrix, 0 means that the row has been invalidated, i.e.
649 the row's contents do not agree with what is visible on the
651 unsigned enabled_p
: 1;
653 /* 1 means row displays a text line that is truncated on the left or
655 unsigned truncated_on_left_p
: 1;
656 unsigned truncated_on_right_p
: 1;
658 /* 1 means the overlay arrow is on this line. */
659 unsigned overlay_arrow_p
: 1;
661 /* 1 means that this row displays a continued line, i.e. it has a
662 continuation mark at the right side. */
663 unsigned continued_p
: 1;
665 /* 0 means that this row does not contain any text, i.e. it is
666 a blank line at the window and buffer end. */
667 unsigned displays_text_p
: 1;
669 /* 1 means that this line ends at ZV. */
670 unsigned ends_at_zv_p
: 1;
672 /* 1 means the face of the last glyph in the text area is drawn to
673 the right end of the window. This flag is used in
674 update_text_area to optimize clearing to the end of the area. */
675 unsigned fill_line_p
: 1;
677 /* Non-zero means display a bitmap on X frames indicating that this
678 line contains no text and ends in ZV. */
679 unsigned indicate_empty_line_p
: 1;
681 /* 1 means this row contains glyphs that overlap each other because
682 of lbearing or rbearing. */
683 unsigned contains_overlapping_glyphs_p
: 1;
685 /* 1 means this row is as wide as the window it is displayed in, including
686 scroll bars, fringes, and internal borders. This also
687 implies that the row doesn't have marginal areas. */
688 unsigned full_width_p
: 1;
690 /* Non-zero means row is a mode or header-line. */
691 unsigned mode_line_p
: 1;
693 /* 1 in a current row means this row is overlapped by another row. */
694 unsigned overlapped_p
: 1;
696 /* 1 means this line ends in the middle of a character consisting
697 of more than one glyph. Some glyphs have been put in this row,
698 the rest are put in rows below this one. */
699 unsigned ends_in_middle_of_char_p
: 1;
701 /* 1 means this line starts in the middle of a character consisting
702 of more than one glyph. Some glyphs have been put in the
703 previous row, the rest are put in this row. */
704 unsigned starts_in_middle_of_char_p
: 1;
706 /* 1 in a current row means this row overlaps others. */
707 unsigned overlapping_p
: 1;
709 /* 1 means some glyphs in this row are displayed in mouse-face. */
710 unsigned mouse_face_p
: 1;
712 /* 1 means this row was ended by a newline from a string. */
713 unsigned ends_in_newline_from_string_p
: 1;
715 /* Continuation lines width at the start of the row. */
716 int continuation_lines_width
;
720 /* Get a pointer to row number ROW in matrix MATRIX. If GLYPH_DEBUG
721 is defined to a non-zero value, the function matrix_row checks that
722 we don't try to access rows that are out of bounds. */
725 struct glyph_row
*matrix_row
P_ ((struct glyph_matrix
*, int));
726 #define MATRIX_ROW(MATRIX, ROW) matrix_row ((MATRIX), (ROW))
728 #define MATRIX_ROW(MATRIX, ROW) ((MATRIX)->rows + (ROW))
731 /* Return a pointer to the row reserved for the mode line in MATRIX.
732 Row MATRIX->nrows - 1 is always reserved for the mode line. */
734 #define MATRIX_MODE_LINE_ROW(MATRIX) \
735 ((MATRIX)->rows + (MATRIX)->nrows - 1)
737 /* Return a pointer to the row reserved for the header line in MATRIX.
738 This is always the first row in MATRIX because that's the only
739 way that works in frame-based redisplay. */
741 #define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows
743 /* Return a pointer to first row in MATRIX used for text display. */
745 #define MATRIX_FIRST_TEXT_ROW(MATRIX) \
746 ((MATRIX)->rows->mode_line_p ? (MATRIX)->rows + 1 : (MATRIX)->rows)
748 /* Return a pointer to the first glyph in the text area of a row.
749 MATRIX is the glyph matrix accessed, and ROW is the row index in
752 #define MATRIX_ROW_GLYPH_START(MATRIX, ROW) \
753 (MATRIX_ROW ((MATRIX), (ROW))->glyphs[TEXT_AREA])
755 /* Return the number of used glyphs in the text area of a row. */
757 #define MATRIX_ROW_USED(MATRIX, ROW) \
758 (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA])
760 /* Return the character/ byte position at which the display of ROW
763 #define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->start.pos.charpos)
764 #define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->start.pos.bytepos)
766 /* Return the character/ byte position at which ROW ends. */
768 #define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->end.pos.charpos)
769 #define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->end.pos.bytepos)
771 /* Return the vertical position of ROW in MATRIX. */
773 #define MATRIX_ROW_VPOS(ROW, MATRIX) ((ROW) - (MATRIX)->rows)
775 /* Return the last glyph row + 1 in MATRIX on window W reserved for
776 text. If W has a mode line, the last row in the matrix is reserved
779 #define MATRIX_BOTTOM_TEXT_ROW(MATRIX, W) \
782 - (WINDOW_WANTS_MODELINE_P ((W)) ? 1 : 0))
784 /* Non-zero if the face of the last glyph in ROW's text area has
785 to be drawn to the end of the text area. */
787 #define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)
789 /* Set and query the enabled_p flag of glyph row ROW in MATRIX. */
791 #define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
792 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0)
794 #define MATRIX_ROW_ENABLED_P(MATRIX, ROW) \
795 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p)
797 /* Non-zero if ROW displays text. Value is non-zero if the row is
798 blank but displays a line end. */
800 #define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)
802 /* Non-zero if ROW is not completely visible in window W. */
804 #define MATRIX_ROW_PARTIALLY_VISIBLE_P(ROW) \
805 ((ROW)->height != (ROW)->visible_height)
807 /* Non-zero if ROW is partially visible at the top of window W. */
809 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW) \
810 (MATRIX_ROW_PARTIALLY_VISIBLE_P ((ROW)) \
811 && (ROW)->y < WINDOW_DISPLAY_HEADER_LINE_HEIGHT ((W)))
813 /* Non-zero if ROW is partially visible at the bottom of window W. */
815 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW) \
816 (MATRIX_ROW_PARTIALLY_VISIBLE_P ((ROW)) \
817 && (ROW)->y + (ROW)->height > WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE ((W)))
819 /* Return the bottom Y + 1 of ROW. */
821 #define MATRIX_ROW_BOTTOM_Y(ROW) ((ROW)->y + (ROW)->height)
823 /* Is ROW the last visible one in the display described by the
824 iterator structure pointed to by IT?. */
826 #define MATRIX_ROW_LAST_VISIBLE_P(ROW, IT) \
827 (MATRIX_ROW_BOTTOM_Y ((ROW)) >= (IT)->last_visible_y)
829 /* Non-zero if ROW displays a continuation line. */
831 #define MATRIX_ROW_CONTINUATION_LINE_P(ROW) \
832 ((ROW)->continuation_lines_width > 0)
834 /* Non-zero if ROW ends in the middle of a character. This is the
835 case for continued lines showing only part of a display table entry
836 or a control char, or an overlay string. */
838 #define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW) \
839 ((ROW)->end.dpvec_index >= 0 \
840 || (ROW)->end.overlay_string_index >= 0 \
841 || (ROW)->ends_in_middle_of_char_p)
843 /* Non-zero if ROW ends in the middle of an overlay string. */
845 #define MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P(ROW) \
846 ((ROW)->end.overlay_string_index >= 0)
848 /* Non-zero if ROW starts in the middle of a character. See above. */
850 #define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW) \
851 ((ROW)->start.dpvec_index >= 0 \
852 || (ROW)->starts_in_middle_of_char_p \
853 || ((ROW)->start.overlay_string_index >= 0 \
854 && (ROW)->start.string_pos.charpos > 0))
856 /* Non-zero means ROW overlaps its predecessor. */
858 #define MATRIX_ROW_OVERLAPS_PRED_P(ROW) \
859 ((ROW)->phys_ascent > (ROW)->ascent)
861 /* Non-zero means ROW overlaps its successor. */
863 #define MATRIX_ROW_OVERLAPS_SUCC_P(ROW) \
864 ((ROW)->phys_height - (ROW)->phys_ascent \
865 > (ROW)->height - (ROW)->ascent)
867 /* Non-zero means that fonts have been loaded since the last glyph
868 matrix adjustments. The function redisplay_internal adjusts glyph
869 matrices when this flag is non-zero. */
871 extern int fonts_changed_p
;
873 /* A glyph for a space. */
875 extern struct glyph space_glyph
;
877 /* Frame being updated by update_window/update_frame. */
879 extern struct frame
*updating_frame
;
881 /* Window being updated by update_window. This is non-null as long as
882 update_window has not finished, and null otherwise. It's role is
883 analogous to updating_frame. */
885 extern struct window
*updated_window
;
887 /* Glyph row and area updated by update_window_line. */
889 extern struct glyph_row
*updated_row
;
890 extern int updated_area
;
892 /* Non-zero means reading single-character input with prompt so put
893 cursor on mini-buffer after the prompt. Positive means at end of
894 text in echo area; negative means at beginning of line. */
896 extern int cursor_in_echo_area
;
898 /* Non-zero means last display completed. Zero means it was
901 extern int display_completed
;
903 /* Non-zero means redisplay has been performed directly (see also
904 direct_output_for_insert and direct_output_forward_char), so that
905 no further updating has to be performed. The function
906 redisplay_internal checks this flag, and does nothing but reset it
907 to zero if it is non-zero. */
909 extern int redisplay_performed_directly_p
;
911 /* A temporary storage area, including a row of glyphs. Initialized
912 in xdisp.c. Used for various purposes, as an example see
913 direct_output_for_insert. */
915 extern struct glyph_row scratch_glyph_row
;
919 /************************************************************************
921 ************************************************************************/
923 /* Enumeration for overriding/changing the face to use for drawing
924 glyphs in x_draw_glyphs. */
926 enum draw_glyphs_face
936 /* A sequence of glyphs to be drawn in the same face. */
940 /* X-origin of the string. */
943 /* Y-origin and y-position of the base line of this string. */
946 /* The width of the string, not including a face extension. */
949 /* The width of the string, including a face extension. */
950 int background_width
;
952 /* The height of this string. This is the height of the line this
953 string is drawn in, and can be different from the height of the
954 font the string is drawn in. */
957 /* Number of pixels this string overwrites in front of its x-origin.
958 This number is zero if the string has an lbearing >= 0; it is
959 -lbearing, if the string has an lbearing < 0. */
962 /* Number of pixels this string overwrites past its right-most
963 nominal x-position, i.e. x + width. Zero if the string's
964 rbearing is <= its nominal width, rbearing - width otherwise. */
967 /* The frame on which the glyph string is drawn. */
970 /* The window on which the glyph string is drawn. */
973 /* X display and window for convenience. */
977 /* The glyph row for which this string was built. It determines the
978 y-origin and height of the string. */
979 struct glyph_row
*row
;
981 /* The area within row. */
982 enum glyph_row_area area
;
984 /* Characters to be drawn, and number of characters. */
988 /* A face-override for drawing cursors, mouse face and similar. */
989 enum draw_glyphs_face hl
;
991 /* Face in which this string is to be drawn. */
994 /* Font in which this string is to be drawn. */
997 /* Font info for this string. */
998 struct font_info
*font_info
;
1000 /* Non-null means this string describes (part of) a composition.
1001 All characters from char2b are drawn composed. */
1002 struct composition
*cmp
;
1004 /* Index of this glyph string's first character in the glyph
1005 definition of CMP. If this is zero, this glyph string describes
1006 the first character of a composition. */
1009 /* 1 means this glyph strings face has to be drawn to the right end
1010 of the window's drawing area. */
1011 unsigned extends_to_end_of_line_p
: 1;
1013 /* 1 means the background of this string has been drawn. */
1014 unsigned background_filled_p
: 1;
1016 /* 1 means glyph string must be drawn with 16-bit functions. */
1017 unsigned two_byte_p
: 1;
1019 /* 1 means that the original font determined for drawing this glyph
1020 string could not be loaded. The member `font' has been set to
1021 the frame's default font in this case. */
1022 unsigned font_not_found_p
: 1;
1024 /* 1 means that the face in which this glyph string is drawn has a
1026 unsigned stippled_p
: 1;
1028 /* 1 means only the foreground of this glyph string must be drawn,
1029 and we should use the physical height of the line this glyph
1030 string appears in as clip rect. */
1031 unsigned for_overlaps_p
: 1;
1033 /* The GC to use for drawing this glyph string. */
1034 #if defined(HAVE_X_WINDOWS) || defined(HAVE_CARBON)
1037 #if defined(HAVE_NTGUI)
1042 /* A pointer to the first glyph in the string. This glyph
1043 corresponds to char2b[0]. Needed to draw rectangles if
1044 font_not_found_p is 1. */
1045 struct glyph
*first_glyph
;
1047 /* Image, if any. */
1050 struct glyph_string
*next
, *prev
;
1055 /************************************************************************
1057 ************************************************************************/
1059 /* Return the height of the mode line in glyph matrix MATRIX, or zero
1060 if not known. This macro is called under circumstances where
1061 MATRIX might not have been allocated yet. */
1063 #define MATRIX_MODE_LINE_HEIGHT(MATRIX) \
1064 ((MATRIX) && (MATRIX)->rows \
1065 ? MATRIX_MODE_LINE_ROW (MATRIX)->height \
1068 /* Return the height of the header line in glyph matrix MATRIX, or zero
1069 if not known. This macro is called under circumstances where
1070 MATRIX might not have been allocated yet. */
1072 #define MATRIX_HEADER_LINE_HEIGHT(MATRIX) \
1073 ((MATRIX) && (MATRIX)->rows \
1074 ? MATRIX_HEADER_LINE_ROW (MATRIX)->height \
1077 /* Return the desired face id for the mode line of a window, depending
1078 on whether the window is selected or not, or if the window is the
1079 scrolling window for the currently active minibuffer window.
1081 Due to the way display_mode_lines manipulates with the contents of
1082 selected_window, this macro needs three arguments: SELW which is
1083 compared against the current value of selected_window, MBW which is
1084 compared against minibuf_window (if SELW doesn't match), and SCRW
1085 which is compared against minibuf_selected_window (if MBW matches). */
1087 #define CURRENT_MODE_LINE_FACE_ID_3(SELW, MBW, SCRW) \
1088 ((!mode_line_in_non_selected_windows \
1089 || (SELW) == XWINDOW (selected_window) \
1090 || (minibuf_level > 0 \
1091 && !NILP (minibuf_selected_window) \
1092 && (MBW) == XWINDOW (minibuf_window) \
1093 && (SCRW) == XWINDOW (minibuf_selected_window))) \
1094 ? MODE_LINE_FACE_ID \
1095 : MODE_LINE_INACTIVE_FACE_ID)
1098 /* Return the desired face id for the mode line of window W. */
1100 #define CURRENT_MODE_LINE_FACE_ID(W) \
1101 (CURRENT_MODE_LINE_FACE_ID_3((W), XWINDOW (selected_window), (W)))
1103 /* Return the current height of the mode line of window W. If not
1104 known from current_mode_line_height, look at W's current glyph
1105 matrix, or return a default based on the height of the font of the
1106 face `mode-line'. */
1108 #define CURRENT_MODE_LINE_HEIGHT(W) \
1109 (current_mode_line_height >= 0 \
1110 ? current_mode_line_height \
1111 : (MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1112 ? MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1113 : estimate_mode_line_height (XFRAME ((W)->frame), \
1114 CURRENT_MODE_LINE_FACE_ID (W))))
1116 /* Return the current height of the header line of window W. If not
1117 known from current_header_line_height, look at W's current glyph
1118 matrix, or return an estimation based on the height of the font of
1119 the face `header-line'. */
1121 #define CURRENT_HEADER_LINE_HEIGHT(W) \
1122 (current_header_line_height >= 0 \
1123 ? current_header_line_height \
1124 : (MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1125 ? MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1126 : estimate_mode_line_height (XFRAME ((W)->frame), \
1127 HEADER_LINE_FACE_ID)))
1129 /* Return the height of the desired mode line of window W. */
1131 #define DESIRED_MODE_LINE_HEIGHT(W) \
1132 MATRIX_MODE_LINE_HEIGHT ((W)->desired_matrix)
1134 /* Return the height of the desired header line of window W. */
1136 #define DESIRED_HEADER_LINE_HEIGHT(W) \
1137 MATRIX_HEADER_LINE_HEIGHT ((W)->desired_matrix)
1139 /* Like FRAME_INTERNAL_BORDER_WIDTH but checks whether frame F is a
1140 window-system frame. */
1142 #define FRAME_INTERNAL_BORDER_WIDTH_SAFE(F) \
1143 (FRAME_WINDOW_P (F) ? FRAME_INTERNAL_BORDER_WIDTH (F) : 0)
1145 /* Width of display region of window W. For terminal frames, this
1146 equals the width of W since there are no vertical scroll bars. For
1147 window system frames, the value has to be corrected by the pixel
1148 width of vertical scroll bars, and fringes. */
1150 #define WINDOW_DISPLAY_PIXEL_WIDTH(W) \
1151 (((XFASTINT ((W)->width) \
1152 - FRAME_SCROLL_BAR_WIDTH (XFRAME (WINDOW_FRAME ((W)))) \
1153 - FRAME_FRINGE_COLS (XFRAME (WINDOW_FRAME ((W))))) \
1154 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))))
1156 /* Height of the display region of W, including a mode line, if any. */
1158 #define WINDOW_DISPLAY_PIXEL_HEIGHT(W) \
1159 (XFASTINT ((W)->height) \
1160 * CANON_Y_UNIT (XFRAME (WINDOW_FRAME ((W)))))
1162 /* Height in pixels of the mode line. May be zero if W doesn't have a
1165 #define WINDOW_DISPLAY_MODE_LINE_HEIGHT(W) \
1166 (WINDOW_WANTS_MODELINE_P ((W)) \
1167 ? CURRENT_MODE_LINE_HEIGHT (W) \
1170 /* Height in pixels of the header line. Zero if W doesn't have a header
1173 #define WINDOW_DISPLAY_HEADER_LINE_HEIGHT(W) \
1174 (WINDOW_WANTS_HEADER_LINE_P ((W)) \
1175 ? CURRENT_HEADER_LINE_HEIGHT (W) \
1178 /* Pixel height of window W without mode line. */
1180 #define WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE(W) \
1181 (WINDOW_DISPLAY_PIXEL_HEIGHT ((W)) \
1182 - WINDOW_DISPLAY_MODE_LINE_HEIGHT ((W)))
1184 /* Pixel height of window W without mode and header line. */
1186 #define WINDOW_DISPLAY_TEXT_HEIGHT(W) \
1187 (WINDOW_DISPLAY_PIXEL_HEIGHT ((W)) \
1188 - WINDOW_DISPLAY_MODE_LINE_HEIGHT ((W)) \
1189 - WINDOW_DISPLAY_HEADER_LINE_HEIGHT ((W)))
1191 /* Left edge of W in pixels relative to its frame. */
1193 #define WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X(W) \
1194 (FRAME_INTERNAL_BORDER_WIDTH_SAFE (XFRAME (WINDOW_FRAME ((W)))) \
1195 + (WINDOW_LEFT_MARGIN ((W)) \
1196 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))) \
1197 + FRAME_LEFT_FRINGE_WIDTH (XFRAME (WINDOW_FRAME ((W)))))
1199 /* Right edge of window W in pixels, relative to its frame. */
1201 #define WINDOW_DISPLAY_RIGHT_EDGE_PIXEL_X(W) \
1202 (WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X ((W)) \
1203 + WINDOW_DISPLAY_PIXEL_WIDTH ((W)))
1205 /* Top edge of W in pixels relative to its frame. */
1207 #define WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y(W) \
1208 (FRAME_INTERNAL_BORDER_WIDTH_SAFE (XFRAME (WINDOW_FRAME ((W)))) \
1209 + (XFASTINT ((W)->top) \
1210 * CANON_Y_UNIT (XFRAME (WINDOW_FRAME ((W))))))
1212 /* Bottom edge of window W relative to its frame. */
1214 #define WINDOW_DISPLAY_BOTTOM_EDGE_PIXEL_Y(W) \
1215 (WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y ((W)) \
1216 + WINDOW_DISPLAY_PIXEL_HEIGHT ((W)))
1218 /* Convert window W relative pixel X to frame pixel coordinates. */
1220 #define WINDOW_TO_FRAME_PIXEL_X(W, X) \
1221 ((X) + WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X ((W)))
1223 /* Convert window W relative pixel Y to frame pixel coordinates. */
1225 #define WINDOW_TO_FRAME_PIXEL_Y(W, Y) \
1226 ((Y) + WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y ((W)))
1228 /* Convert frame relative pixel X to window relative pixel X. */
1230 #define FRAME_TO_WINDOW_PIXEL_X(W, X) \
1231 ((X) - WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X ((W)))
1233 /* Convert frame relative pixel Y to window relative pixel Y. */
1235 #define FRAME_TO_WINDOW_PIXEL_Y(W, Y) \
1236 ((Y) - WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y ((W)))
1238 /* Width of left margin area in pixels. */
1240 #define WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH(W) \
1241 (NILP ((W)->left_margin_width) \
1243 : (XINT ((W)->left_margin_width) \
1244 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))))
1246 /* Width of right marginal area in pixels. */
1248 #define WINDOW_DISPLAY_RIGHT_AREA_PIXEL_WIDTH(W) \
1249 (NILP ((W)->right_margin_width) \
1251 : (XINT ((W)->right_margin_width) \
1252 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))))
1254 /* Width of text area in pixels. */
1256 #define WINDOW_DISPLAY_TEXT_AREA_PIXEL_WIDTH(W) \
1257 (WINDOW_DISPLAY_PIXEL_WIDTH ((W)) \
1258 - WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)) \
1259 - WINDOW_DISPLAY_RIGHT_AREA_PIXEL_WIDTH ((W)))
1261 /* Convert a text area relative x-position in window W to frame X
1262 pixel coordinates. */
1264 #define WINDOW_TEXT_TO_FRAME_PIXEL_X(W, X) \
1265 (WINDOW_TO_FRAME_PIXEL_X ((W), (X)) \
1266 + WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)))
1268 /* Translate an x-position relative to AREA in window W to frame pixel
1271 #define WINDOW_AREA_TO_FRAME_PIXEL_X(W, AREA, X) \
1272 (WINDOW_TO_FRAME_PIXEL_X ((W), (X)) \
1273 + (((AREA) > LEFT_MARGIN_AREA) \
1274 ? WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)) \
1276 + (((AREA) > TEXT_AREA) \
1277 ? WINDOW_DISPLAY_TEXT_AREA_PIXEL_WIDTH ((W)) \
1280 /* Return the pixel width of AREA in W. */
1282 #define WINDOW_AREA_PIXEL_WIDTH(W, AREA) \
1283 (((AREA) == TEXT_AREA) \
1284 ? WINDOW_DISPLAY_TEXT_AREA_PIXEL_WIDTH ((W)) \
1285 : (((AREA) == LEFT_MARGIN_AREA) \
1286 ? WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)) \
1287 : WINDOW_DISPLAY_RIGHT_AREA_PIXEL_WIDTH ((W))))
1289 /* Value is non-zero if window W wants a mode line. */
1291 #define WINDOW_WANTS_MODELINE_P(W) \
1292 (!MINI_WINDOW_P ((W)) \
1293 && !(W)->pseudo_window_p \
1294 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1295 && BUFFERP ((W)->buffer) \
1296 && !NILP (XBUFFER ((W)->buffer)->mode_line_format) \
1297 && XFASTINT ((W)->height) > 1)
1299 /* Value is non-zero if window W wants a header line. */
1301 #define WINDOW_WANTS_HEADER_LINE_P(W) \
1302 (!MINI_WINDOW_P ((W)) \
1303 && !(W)->pseudo_window_p \
1304 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1305 && BUFFERP ((W)->buffer) \
1306 && !NILP (XBUFFER ((W)->buffer)->header_line_format) \
1307 && XFASTINT ((W)->height) > 1 + !NILP (XBUFFER ((W)->buffer)->mode_line_format))
1310 /***********************************************************************
1312 ***********************************************************************/
1314 /* Indices of face attributes in Lisp face vectors. Slot zero is the
1317 enum lface_attribute_index
1319 LFACE_FAMILY_INDEX
= 1,
1324 LFACE_UNDERLINE_INDEX
,
1325 LFACE_INVERSE_INDEX
,
1326 LFACE_FOREGROUND_INDEX
,
1327 LFACE_BACKGROUND_INDEX
,
1328 LFACE_STIPPLE_INDEX
,
1329 LFACE_OVERLINE_INDEX
,
1330 LFACE_STRIKE_THROUGH_INDEX
,
1333 LFACE_INHERIT_INDEX
,
1334 LFACE_AVGWIDTH_INDEX
,
1339 /* Box types of faces. */
1343 /* No box around text. */
1346 /* Simple box of specified width and color. Default width is 1, and
1347 default color is the foreground color of the face. */
1350 /* Boxes with 3D shadows. Color equals the background color of the
1351 face. Width is specified. */
1357 /* Structure describing a realized face.
1359 For each Lisp face, 0..N realized faces can exist for different
1360 frames and different charsets. Realized faces are built from Lisp
1361 faces and text properties/overlays by merging faces and adding
1362 unspecified attributes from the `default' face. */
1366 /* The id of this face. The id equals the index of this face in the
1367 vector faces_by_id of its face cache. */
1370 #ifdef HAVE_WINDOW_SYSTEM
1372 /* If non-zero, this is a GC that we can use without modification for
1373 drawing the characters in this face. */
1376 /* Font used for this face, or null if the font could not be loaded
1377 for some reason. This points to a `font' slot of a struct
1378 font_info, and we should not call XFreeFont on it because the
1379 font may still be used somewhere else. */
1382 /* Background stipple or bitmap used for this face. This is
1383 an id as returned from load_pixmap. */
1386 #else /* not HAVE_WINDOW_SYSTEM */
1391 #endif /* not HAVE_WINDOW_SYSTEM */
1393 /* Pixel value of foreground color for X frames. Color index
1395 unsigned long foreground
;
1397 /* Pixel value or color index of background color. */
1398 unsigned long background
;
1400 /* Pixel value or color index of underline color. */
1401 unsigned long underline_color
;
1403 /* Pixel value or color index of overlined, strike-through, or box
1405 unsigned long overline_color
;
1406 unsigned long strike_through_color
;
1407 unsigned long box_color
;
1409 /* The font's name. This points to a `name' of a font_info, and it
1410 must not be freed. */
1413 /* Font info ID for this face's font. An ID is stored here because
1414 pointers to font_info structures may change. The reason is that
1415 they are pointers into a font table vector that is itself
1419 /* Fontset ID if this face uses a fontset, or -1. This is only >= 0
1420 if the face was realized for a composition sequence.
1421 Otherwise, a specific font is loaded from the set of fonts
1422 specified by the fontset given by the family attribute of the face. */
1425 /* Pixmap width and height. */
1426 unsigned int pixmap_w
, pixmap_h
;
1428 /* Non-zero means characters in this face have a box that thickness
1429 around them. If it is negative, the absolute value indicates the
1430 thickness, and the horizontal lines of box (top and bottom) are
1431 drawn inside of characters glyph area. The vertical lines of box
1432 (left and right) are drawn as the same way as the case that this
1433 value is positive. */
1436 /* Type of box drawn. A value of FACE_NO_BOX means no box is drawn
1437 around text in this face. A value of FACE_SIMPLE_BOX means a box
1438 of width box_line_width is drawn in color box_color. A value of
1439 FACE_RAISED_BOX or FACE_SUNKEN_BOX means a 3D box is drawn with
1440 shadow colors derived from the background color of the face. */
1441 enum face_box_type box
;
1443 /* If `box' above specifies a 3D type, 1 means use box_color for
1445 unsigned use_box_color_for_shadows_p
: 1;
1447 /* The Lisp face attributes this face realizes. All attributes
1448 in this vector are non-nil. */
1449 Lisp_Object lface
[LFACE_VECTOR_SIZE
];
1451 /* The hash value of this face. */
1454 /* The charset for which this face was realized if it was realized
1455 for use in multibyte text. If fontset >= 0, this is the charset
1456 of the first character of the composition sequence. A value of
1457 charset < 0 means the face was realized for use in unibyte text
1458 where the idea of Emacs charsets isn't applicable. */
1461 /* Non-zero if text in this face should be underlined, overlined,
1462 strike-through or have a box drawn around it. */
1463 unsigned underline_p
: 1;
1464 unsigned overline_p
: 1;
1465 unsigned strike_through_p
: 1;
1467 /* 1 means that the colors specified for this face could not be
1468 loaded, and were replaced by default colors, so they shouldn't be
1470 unsigned foreground_defaulted_p
: 1;
1471 unsigned background_defaulted_p
: 1;
1473 /* 1 means that either no color is specified for underlining or that
1474 the specified color couldn't be loaded. Use the foreground
1475 color when drawing in that case. */
1476 unsigned underline_defaulted_p
: 1;
1478 /* 1 means that either no color is specified for the corresponding
1479 attribute or that the specified color couldn't be loaded.
1480 Use the foreground color when drawing in that case. */
1481 unsigned overline_color_defaulted_p
: 1;
1482 unsigned strike_through_color_defaulted_p
: 1;
1483 unsigned box_color_defaulted_p
: 1;
1485 /* TTY appearances. Blinking is not yet implemented. Colors are
1486 found in `lface' with empty color string meaning the default
1487 color of the TTY. */
1488 unsigned tty_bold_p
: 1;
1489 unsigned tty_dim_p
: 1;
1490 unsigned tty_underline_p
: 1;
1491 unsigned tty_alt_charset_p
: 1;
1492 unsigned tty_reverse_p
: 1;
1493 unsigned tty_blinking_p
: 1;
1495 /* 1 means that colors of this face may not be freed because they
1496 have been copied bitwise from a base face (see
1498 unsigned colors_copied_bitwise_p
: 1;
1500 /* If non-zero, use overstrike (to simulate bold-face). */
1501 unsigned overstrike
: 1;
1503 /* Next and previous face in hash collision list of face cache. */
1504 struct face
*next
, *prev
;
1506 /* If this face is for ASCII characters, this points this face
1507 itself. Otherwise, this points a face for ASCII characters. */
1508 struct face
*ascii_face
;
1512 /* Color index indicating that face uses a terminal's default color. */
1514 #define FACE_TTY_DEFAULT_COLOR ((unsigned long) -1)
1516 /* Color index indicating that face uses an unknown foreground color. */
1518 #define FACE_TTY_DEFAULT_FG_COLOR ((unsigned long) -2)
1520 /* Color index indicating that face uses an unknown background color. */
1522 #define FACE_TTY_DEFAULT_BG_COLOR ((unsigned long) -3)
1524 /* Non-zero if FACE was realized for unibyte use. */
1526 #define FACE_UNIBYTE_P(FACE) ((FACE)->charset < 0)
1529 /* IDs of important faces known by the C face code. These are the IDs
1530 of the faces for CHARSET_ASCII. */
1536 MODE_LINE_INACTIVE_FACE_ID
,
1539 HEADER_LINE_FACE_ID
,
1545 BASIC_FACE_ID_SENTINEL
1549 /* A cache of realized faces. Each frame has its own cache because
1550 Emacs allows different frame-local face definitions. */
1554 /* Hash table of cached realized faces. */
1555 struct face
**buckets
;
1557 /* Back-pointer to the frame this cache belongs to. */
1560 /* A vector of faces so that faces can be referenced by an ID. */
1561 struct face
**faces_by_id
;
1563 /* The allocated size, and number of used slots of faces_by_id. */
1566 /* Flag indicating that attributes of the `menu' face have been
1568 unsigned menu_face_changed_p
: 1;
1572 /* Prepare face FACE for use on frame F. This must be called before
1573 using X resources of FACE. */
1575 #define PREPARE_FACE_FOR_DISPLAY(F, FACE) \
1576 if ((FACE)->gc == 0) \
1577 prepare_face_for_display ((F), (FACE)); \
1581 /* Return a pointer to the face with ID on frame F, or null if such a
1582 face doesn't exist. */
1584 #define FACE_FROM_ID(F, ID) \
1585 (((unsigned) (ID) < FRAME_FACE_CACHE (F)->used) \
1586 ? FRAME_FACE_CACHE (F)->faces_by_id[ID] \
1589 #ifdef HAVE_WINDOW_SYSTEM
1591 /* Non-zero if FACE is suitable for displaying character CHAR. */
1593 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) \
1594 (SINGLE_BYTE_CHAR_P (CHAR) \
1595 ? (FACE) == (FACE)->ascii_face \
1596 : face_suitable_for_char_p ((FACE), (CHAR)))
1598 /* Return the id of the realized face on frame F that is like the face
1599 with id ID but is suitable for displaying character CHAR.
1600 This macro is only meaningful for multibyte character CHAR. */
1602 #define FACE_FOR_CHAR(F, FACE, CHAR) \
1603 (SINGLE_BYTE_CHAR_P (CHAR) \
1604 ? (FACE)->ascii_face->id \
1605 : face_for_char ((F), (FACE), (CHAR)))
1607 #else /* not HAVE_WINDOW_SYSTEM */
1609 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) 1
1610 #define FACE_FOR_CHAR(F, FACE, CHAR) ((FACE)->id)
1612 #endif /* not HAVE_WINDOW_SYSTEM */
1614 /* Non-zero means face attributes have been changed since the last
1615 redisplay. Used in redisplay_internal. */
1617 extern int face_change_count
;
1622 /***********************************************************************
1624 ***********************************************************************/
1626 enum fringe_bitmap_type
1628 NO_FRINGE_BITMAP
= 0,
1629 LEFT_TRUNCATION_BITMAP
,
1630 RIGHT_TRUNCATION_BITMAP
,
1631 CONTINUED_LINE_BITMAP
,
1632 CONTINUATION_LINE_BITMAP
,
1633 OVERLAY_ARROW_BITMAP
,
1638 struct fringe_bitmap
1643 unsigned char *bits
;
1646 /* Structure used to describe where and how to draw a fringe bitmap.
1647 WHICH is the fringe bitmap to draw. WD and H is the (adjusted)
1648 width and height of the bitmap, DH is the height adjustment (if
1649 bitmap is periodic). X and Y are frame coordinates of the area to
1650 display the bitmap, DY is relative offset of the bitmap into that
1651 area. BX, NX, BY, NY specifies the area to clear if the bitmap
1652 does not fill the entire area. FACE is the fringe face. */
1654 struct draw_fringe_bitmap_params
1656 enum fringe_bitmap_type which
;
1663 extern struct fringe_bitmap fringe_bitmaps
[MAX_FRINGE_BITMAPS
];
1666 /***********************************************************************
1668 ***********************************************************************/
1670 /* Iteration over things to display in current_buffer or in a string.
1672 The iterator handles:
1674 1. Overlay strings (after-string, before-string).
1676 3. Invisible text properties.
1677 4. Selective display.
1678 5. Translation of characters via display tables.
1679 6. Translation of control characters to the forms `\003' or `^C'.
1680 7. `glyph' and `space-width' properties.
1682 Iterators are initialized by calling init_iterator or one of the
1683 equivalent functions below. A call to get_next_display_element
1684 loads the iterator structure with information about what next to
1685 display. A call to set_iterator_to_next increments the iterator's
1688 Characters from overlay strings, display table entries or control
1689 character translations are returned one at a time. For example, if
1690 we have a text of `a\x01' where `a' has a display table definition
1691 of `cd' and the control character is displayed with a leading
1692 arrow, then the iterator will return:
1694 Call Return Source Call next
1695 -----------------------------------------------------------------
1696 next c display table move
1697 next d display table move
1698 next ^ control char move
1699 next A control char move
1701 The same mechanism is also used to return characters for ellipses
1702 displayed at the end of invisible text.
1704 CAVEAT: Under some circumstances, move_.* functions can be called
1705 asynchronously, e.g. when computing a buffer position from an x and
1706 y pixel position. This means that these functions and functions
1707 called from them SHOULD NOT USE xmalloc and alike. See also the
1708 comment at the start of xdisp.c. */
1710 /* Enumeration describing what kind of display element an iterator is
1711 loaded with after a call to get_next_display_element. */
1713 enum display_element_type
1715 /* A normal character. */
1718 /* A composition sequence. */
1724 /* A flexible width and height space. */
1727 /* End of buffer or string. */
1730 /* Truncation glyphs. Never returned by get_next_display_element.
1731 Used to get display information about truncation glyphs via
1735 /* Continuation glyphs. See the comment for IT_TRUNCATION. */
1740 /* An enumerator for each text property that has a meaning for display
1749 COMPOSITION_PROP_IDX
,
1751 /* Not a property. Used to indicate changes in overlays. */
1761 /* The window in which we iterate over current_buffer (or a string). */
1765 /* The window's frame. */
1768 /* Function to call to load this structure with the next display
1770 int (* method
) P_ ((struct it
*it
));
1772 /* The next position at which to check for face changes, invisible
1773 text, overlay strings, end of text etc., which see. */
1776 /* Maximum string or buffer position + 1. ZV when iterating over
1780 /* C string to iterate over. Non-null means get characters from
1781 this string, otherwise characters are read from current_buffer
1785 /* Number of characters in the string (s, or it->string) we iterate
1789 /* Start and end of a visible region; -1 if the region is not
1790 visible in the window. */
1791 int region_beg_charpos
, region_end_charpos
;
1793 /* Position at which redisplay end trigger functions should be run. */
1794 int redisplay_end_trigger_charpos
;
1796 /* 1 means multibyte characters are enabled. */
1797 unsigned multibyte_p
: 1;
1799 /* 1 means window has a mode line at its top. */
1800 unsigned header_line_p
: 1;
1802 /* 1 means `string' is the value of a `display' property.
1803 Don't handle some `display' properties in these strings. */
1804 unsigned string_from_display_prop_p
: 1;
1806 /* Display table in effect or null for none. */
1807 struct Lisp_Char_Table
*dp
;
1809 /* Current display table vector to return characters from and its
1810 end. dpvec null means we are not returning characters from a
1811 display table entry; current.dpvec_index gives the current index
1812 into dpvec. This same mechanism is also used to return
1813 characters from translated control characters, i.e. `\003' or
1815 Lisp_Object
*dpvec
, *dpend
;
1817 /* Length in bytes of the char that filled dpvec. A value of zero
1818 means that no such character is involved. */
1821 /* Face id of the iterator saved in case a glyph from dpvec contains
1822 a face. The face is restored when all glyphs from dpvec have
1826 /* Vector of glyphs for control character translation. The pointer
1827 dpvec is set to ctl_chars when a control character is translated.
1828 This vector is also used for incomplete multibyte character
1829 translation (e.g \222\244). Such a character is at most 4 bytes,
1830 thus we need at most 16 bytes here. */
1831 Lisp_Object ctl_chars
[16];
1833 /* Current buffer or string position of the iterator, including
1834 position in overlay strings etc. */
1835 struct display_pos current
;
1837 /* Vector of overlays to process. Overlay strings are processed
1838 OVERLAY_STRING_CHUNK_SIZE at a time. */
1839 #define OVERLAY_STRING_CHUNK_SIZE 3
1840 Lisp_Object overlay_strings
[OVERLAY_STRING_CHUNK_SIZE
];
1842 /* Total number of overlay strings to process. This can be >
1843 OVERLAY_STRING_CHUNK_SIZE. */
1844 int n_overlay_strings
;
1846 /* If non-nil, a Lisp string being processed. If
1847 current.overlay_string_index >= 0, this is an overlay string from
1851 /* Stack of saved values. New entries are pushed when we begin to
1852 process an overlay string or a string from a `glyph' property.
1853 Entries are popped when we return to deliver display elements
1854 from what we previously had. */
1855 struct iterator_stack_entry
1860 struct display_pos pos
;
1863 enum glyph_row_area area
;
1864 unsigned multibyte_p
: 1;
1865 unsigned string_from_display_prop_p
: 1;
1866 unsigned display_ellipsis_p
: 1;
1867 Lisp_Object space_width
;
1869 Lisp_Object font_height
;
1873 /* Stack pointer. */
1876 /* Setting of buffer-local variable selective-display-ellipsis. */
1877 unsigned selective_display_ellipsis_p
: 1;
1879 /* 1 means control characters are translated into the form `^C'
1880 where the `^' can be replaced by a display table entry. */
1881 unsigned ctl_arrow_p
: 1;
1883 /* -1 means selective display hides everything between a \r and the
1884 next newline; > 0 means hide lines indented more than that value. */
1887 /* An enumeration describing what the next display element is
1888 after a call to get_next_display_element. */
1889 enum display_element_type what
;
1894 /* Non-zero means that the current face has a box. */
1895 unsigned face_box_p
: 1;
1897 /* Non-null means that the current character is the first in a run
1898 of characters with box face. */
1899 unsigned start_of_box_run_p
: 1;
1901 /* Non-zero means that the current character is the last in a run
1902 of characters with box face. */
1903 unsigned end_of_box_run_p
: 1;
1905 /* 1 means overlay strings at end_charpos have been processed. */
1906 unsigned overlay_strings_at_end_processed_p
: 1;
1908 /* 1 means the actual glyph is not available in the current
1910 unsigned glyph_not_available_p
: 1;
1912 /* 1 means the next line in display_line continues a character
1913 consisting of more than one glyph, and some glyphs of this
1914 character have been put on the previous line. */
1915 unsigned starts_in_middle_of_char_p
: 1;
1917 /* If 1, saved_face_id contains the id of the face in front of text
1918 skipped due to selective display. */
1919 unsigned face_before_selective_p
: 1;
1921 /* The ID of the default face to use. One of DEFAULT_FACE_ID,
1922 MODE_LINE_FACE_ID, etc, depending on what we are displaying. */
1925 /* If what == IT_CHARACTER, character and length in bytes. This is
1926 a character from a buffer or string. It may be different from
1927 the character displayed in case that
1928 unibyte_display_via_language_environment is set.
1930 If what == IT_COMPOSITION, the first component of a composition
1931 and length in bytes of the composition. */
1934 /* If what == IT_COMPOSITION, identification number and length in
1935 chars of a composition. */
1936 int cmp_id
, cmp_len
;
1938 /* The character to display, possibly translated to multibyte
1939 if unibyte_display_via_language_environment is set. This
1940 is set after produce_glyphs has been called. */
1941 int char_to_display
;
1943 /* If what == IT_IMAGE, the id of the image to display. */
1946 /* Value of the `space-width' property, if any; nil if none. */
1947 Lisp_Object space_width
;
1949 /* Computed from the value of the `raise' property. */
1952 /* Value of the `height' property, if any; nil if none. */
1953 Lisp_Object font_height
;
1955 /* Object and position where the current display element came from.
1956 Object can be a Lisp string in case the current display element
1957 comes from an overlay string, or it is buffer. Position is
1958 a position in object. */
1960 struct text_pos position
;
1962 /* 1 means lines are truncated. */
1963 unsigned truncate_lines_p
: 1;
1965 /* Number of columns per \t. */
1968 /* Width in pixels of truncation and continuation glyphs. */
1969 short truncation_pixel_width
, continuation_pixel_width
;
1971 /* First and last visible x-position in the display area. If window
1972 is hscrolled by n columns, first_visible_x == n * CANON_X_UNIT
1973 (f), and last_visible_x == pixel width of W + first_visible_x. */
1974 int first_visible_x
, last_visible_x
;
1976 /* Last visible y-position + 1 in the display area without a mode
1977 line, if the window has one. */
1980 /* Additional space in pixels between lines (for window systems
1982 int extra_line_spacing
;
1984 /* If non-null, glyphs are produced in glyph_row with each call to
1986 struct glyph_row
*glyph_row
;
1988 /* The area of glyph_row to which glyphs are added. */
1989 enum glyph_row_area area
;
1991 /* Number of glyphs needed for the last character requested via
1992 produce_glyphs. This is 1 except for tabs. */
1995 /* Width of the display element in pixels. Result of
1999 /* Current, maximum logical, and maximum physical line height
2000 information. Result of produce_glyphs. */
2001 int ascent
, descent
, max_ascent
, max_descent
;
2002 int phys_ascent
, phys_descent
, max_phys_ascent
, max_phys_descent
;
2004 /* Current x pixel position within the display line. This value
2005 does not include the width of continuation lines in front of the
2006 line. The value of current_x is automatically incremented by
2007 pixel_width with each call to produce_glyphs. */
2010 /* Accumulated width of continuation lines. If > 0, this means we
2011 are currently in a continuation line. This is initially zero and
2012 incremented/reset by display_line, move_it_to etc. */
2013 int continuation_lines_width
;
2015 /* Current y-position. Automatically incremented by the height of
2016 glyph_row in move_it_to and display_line. */
2019 /* Current vertical matrix position, or line number. Automatically
2020 incremented by move_it_to and display_line. */
2023 /* Horizontal matrix position reached in move_it_in_display_line.
2024 Only set there, not in display_line. */
2029 /* Access to positions of iterator IT. */
2031 #define IT_CHARPOS(IT) CHARPOS ((IT).current.pos)
2032 #define IT_BYTEPOS(IT) BYTEPOS ((IT).current.pos)
2033 #define IT_STRING_CHARPOS(IT) CHARPOS ((IT).current.string_pos)
2034 #define IT_STRING_BYTEPOS(IT) BYTEPOS ((IT).current.string_pos)
2036 /* Test if IT has reached the end of its buffer or string. This will
2037 only work after get_next_display_element has been called. */
2039 #define ITERATOR_AT_END_P(IT) ((IT)->what == IT_EOB)
2041 /* Non-zero means IT is at the end of a line. This is the case if it
2042 is either on a newline or on a carriage return and selective
2043 display hides the rest of the line. */
2045 #define ITERATOR_AT_END_OF_LINE_P(IT) \
2046 ((IT)->what == IT_CHARACTER \
2047 && ((IT)->c == '\n' \
2048 || ((IT)->c == '\r' && (IT)->selective)))
2050 /* Call produce_glyphs or produce_glyphs_hook, if set. Shortcut to
2051 avoid the function call overhead. */
2053 #define PRODUCE_GLYPHS(IT) \
2055 extern int inhibit_free_realized_faces; \
2057 rif->produce_glyphs ((IT)); \
2059 produce_glyphs ((IT)); \
2060 if ((IT)->glyph_row != NULL) \
2061 inhibit_free_realized_faces = 1; \
2064 /* Bit-flags indicating what operation move_it_to should perform. */
2066 enum move_operation_enum
2068 /* Stop if specified x-position is reached. */
2071 /* Stop if specified y-position is reached. */
2074 /* Stop if specified vpos is reached. */
2075 MOVE_TO_VPOS
= 0x04,
2077 /* Stop if specified buffer or string position is reached. */
2083 /***********************************************************************
2084 Window-based redisplay interface
2085 ***********************************************************************/
2087 /* Structure used to describe runs of lines that must be scrolled. */
2091 /* Source and destination y pixel position. */
2092 int desired_y
, current_y
;
2094 /* Source and destination vpos in matrix. */
2095 int desired_vpos
, current_vpos
;
2097 /* Height in pixels, number of glyph rows. */
2102 /* Structure holding system-dependent interface functions needed
2103 for window-based redisplay. */
2105 struct redisplay_interface
2107 /* Produce glyphs/get display metrics for the display element IT is
2109 void (*produce_glyphs
) P_ ((struct it
*it
));
2111 /* Write or insert LEN glyphs from STRING at the nominal output
2113 void (*write_glyphs
) P_ ((struct glyph
*string
, int len
));
2114 void (*insert_glyphs
) P_ ((struct glyph
*start
, int len
));
2116 /* Clear from nominal output position to X. X < 0 means clear
2117 to right end of display. */
2118 void (*clear_end_of_line
) P_ ((int x
));
2120 /* Function to call to scroll the display as described by RUN on
2122 void (*scroll_run_hook
) P_ ((struct window
*w
, struct run
*run
));
2124 /* Function to call after a line in a display has been completely
2125 updated. Used to draw truncation marks and alike. DESIRED_ROW
2126 is the desired row which has been updated. */
2127 void (*after_update_window_line_hook
) P_ ((struct glyph_row
*desired_row
));
2129 /* Function to call before beginning to update window W in
2130 window-based redisplay. */
2131 void (*update_window_begin_hook
) P_ ((struct window
*w
));
2133 /* Function to call after window W has been updated in window-based
2134 redisplay. CURSOR_ON_P non-zero means switch cursor on.
2135 MOUSE_FACE_OVERWRITTEN_P non-zero means that some lines in W
2136 that contained glyphs in mouse-face were overwritten, so we
2137 have to update the mouse highlight. */
2138 void (*update_window_end_hook
) P_ ((struct window
*w
, int cursor_on_p
,
2139 int mouse_face_overwritten_p
));
2141 /* Move cursor to row/column position VPOS/HPOS, pixel coordinates
2142 Y/X. HPOS/VPOS are window-relative row and column numbers and X/Y
2143 are window-relative pixel positions. */
2144 void (*cursor_to
) P_ ((int vpos
, int hpos
, int y
, int x
));
2146 /* Flush the display of frame F. For X, this is XFlush. */
2147 void (*flush_display
) P_ ((struct frame
*f
));
2149 /* Clear the mouse hightlight in window W, if there is any. */
2150 void (*clear_mouse_face
) P_ ((struct window
*w
));
2152 /* Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
2154 void (*get_glyph_overhangs
) P_ ((struct glyph
*glyph
, struct frame
*f
,
2155 int *left
, int *right
));
2157 /* Fix the display of AREA of ROW in window W for overlapping rows.
2158 This function is called from redraw_overlapping_rows after
2159 desired rows have been made current. */
2160 void (*fix_overlapping_area
) P_ ((struct window
*w
, struct glyph_row
*row
,
2161 enum glyph_row_area area
));
2163 /* Draw a fringe bitmap in window W of row ROW using parameters P. */
2164 void (*draw_fringe_bitmap
) P_ ((struct window
*w
, struct glyph_row
*row
,
2165 struct draw_fringe_bitmap_params
*p
));
2167 /* Get metrics of character CHAR2B in FONT of type FONT_TYPE.
2168 Value is null if CHAR2B is not contained in the font. */
2169 XCharStruct
* (*per_char_metric
) P_ ((XFontStruct
*font
, XChar2b
*char2b
,
2172 /* Encode CHAR2B using encoding information from FONT_INFO. CHAR2B is
2173 the two-byte form of C. Encoding is returned in *CHAR2B. If
2174 TWO_BYTE_P is non-null, return non-zero there if font is two-byte. */
2175 int (*encode_char
) P_ ((int c
, XChar2b
*char2b
,
2176 struct font_info
*font_into
, int *two_byte_p
));
2178 /* Compute left and right overhang of glyph string S.
2179 A NULL pointer if platform does not support this. */
2180 void (*compute_glyph_string_overhangs
) P_ ((struct glyph_string
*s
));
2182 /* Draw a glyph string S. */
2183 void (*draw_glyph_string
) P_ ((struct glyph_string
*s
));
2187 /* The current interface for window-based redisplay. */
2189 extern struct redisplay_interface
*rif
;
2191 /* Hook to call in estimate_mode_line_height. */
2193 extern int (* estimate_mode_line_height_hook
) P_ ((struct frame
*,
2197 /* Return proper value to be used as baseline offset of font that has
2198 ASCENT and DESCENT to draw characters by the font at the vertical
2199 center of the line of frame F.
2201 Here, out task is to find the value of BOFF in the following figure;
2203 -------------------------+-----------+-
2204 -+-+---------+-+ | |
2206 | | | | F_ASCENT F_HEIGHT
2209 | | |-|-+------+-----------|------- baseline
2211 | |---------|-+-+ | |
2213 -+-+---------+-+ F_DESCENT |
2214 -------------------------+-----------+-
2216 -BOFF + DESCENT + (F_HEIGHT - HEIGHT) / 2 = F_DESCENT
2217 BOFF = DESCENT + (F_HEIGHT - HEIGHT) / 2 - F_DESCENT
2218 DESCENT = FONT->descent
2219 HEIGHT = FONT_HEIGHT (FONT)
2220 F_DESCENT = (F->output_data.x->font->descent
2221 - F->output_data.x->baseline_offset)
2222 F_HEIGHT = FRAME_LINE_HEIGHT (F)
2225 #define VCENTER_BASELINE_OFFSET(FONT, F) \
2226 (FONT_DESCENT (FONT) \
2227 + (FRAME_LINE_HEIGHT ((F)) - FONT_HEIGHT ((FONT)) \
2228 + (FRAME_LINE_HEIGHT ((F)) > FONT_HEIGHT ((FONT)))) / 2 \
2229 - (FONT_DESCENT (FRAME_FONT (F)) - FRAME_BASELINE_OFFSET (F)))
2232 /***********************************************************************
2234 ***********************************************************************/
2236 #ifdef HAVE_WINDOW_SYSTEM
2238 /* Structure forward declarations. */
2243 /* Each image format (JPEG, TIFF, ...) supported is described by
2244 a structure of the type below. */
2248 /* A symbol uniquely identifying the image type, .e.g `jpeg'. */
2251 /* Check that SPEC is a valid image specification for the given
2252 image type. Value is non-zero if SPEC is valid. */
2253 int (* valid_p
) P_ ((Lisp_Object spec
));
2255 /* Load IMG which is used on frame F from information contained in
2256 IMG->spec. Value is non-zero if successful. */
2257 int (* load
) P_ ((struct frame
*f
, struct image
*img
));
2259 /* Free resources of image IMG which is used on frame F. */
2260 void (* free
) P_ ((struct frame
*f
, struct image
*img
));
2262 /* Next in list of all supported image types. */
2263 struct image_type
*next
;
2267 /* Structure describing an image. Specific image formats like XBM are
2268 converted into this form, so that display only has to deal with
2269 this type of image. */
2273 /* The time in seconds at which the image was last displayed. Set
2274 in prepare_image_for_display. */
2275 unsigned long timestamp
;
2277 /* Pixmaps of the image. */
2278 Pixmap pixmap
, mask
;
2280 /* Colors allocated for this image, if any. Allocated via xmalloc. */
2281 unsigned long *colors
;
2284 /* A single `background color' for this image, for the use of anyone that
2285 cares about such a thing. Only valid if the `background_valid' field
2286 is true. This should generally be accessed by calling the accessor
2287 macro `IMAGE_BACKGROUND', which will heuristically calculate a value
2289 unsigned long background
;
2291 /* True if this image has a `transparent' background -- that is, is
2292 uses an image mask. The accessor macro for this is
2293 `IMAGE_BACKGROUND_TRANSPARENT'. */
2294 unsigned background_transparent
: 1;
2296 /* True if the `background' and `background_transparent' fields are
2297 valid, respectively. */
2298 unsigned background_valid
: 1, background_transparent_valid
: 1;
2300 /* Width and height of the image. */
2303 /* These values are used for the rectangles displayed for images
2304 that can't be loaded. */
2305 #define DEFAULT_IMAGE_WIDTH 30
2306 #define DEFAULT_IMAGE_HEIGHT 30
2308 /* Percent of image height used as ascent. A value of
2309 CENTERED_IMAGE_ASCENT means draw the image centered on the
2312 #define DEFAULT_IMAGE_ASCENT 50
2313 #define CENTERED_IMAGE_ASCENT -1
2315 /* Lisp specification of this image. */
2318 /* Relief to draw around the image. */
2321 /* Optional margins around the image. This includes the relief. */
2322 int hmargin
, vmargin
;
2324 /* Reference to the type of the image. */
2325 struct image_type
*type
;
2327 /* 1 means that loading the image failed. Don't try again. */
2328 unsigned load_failed_p
;
2330 /* A place for image types to store additional data. The member
2331 data.lisp_val is marked during GC, so it's safe to store Lisp data
2332 there. Image types should free this data when their `free'
2333 function is called. */
2338 Lisp_Object lisp_val
;
2341 /* Hash value of image specification to speed up comparisons. */
2344 /* Image id of this image. */
2347 /* Hash collision chain. */
2348 struct image
*next
, *prev
;
2352 /* Cache of images. Each frame has a cache. X frames with the same
2353 x_display_info share their caches. */
2357 /* Hash table of images. */
2358 struct image
**buckets
;
2360 /* Vector mapping image ids to images. */
2361 struct image
**images
;
2363 /* Allocated size of `images'. */
2366 /* Number of images in the cache. */
2369 /* Reference count (number of frames sharing this cache). */
2374 /* Value is a pointer to the image with id ID on frame F, or null if
2375 no image with that id exists. */
2377 #define IMAGE_FROM_ID(F, ID) \
2378 (((ID) >= 0 && (ID) < (FRAME_X_IMAGE_CACHE (F)->used)) \
2379 ? FRAME_X_IMAGE_CACHE (F)->images[ID] \
2382 /* Size of bucket vector of image caches. Should be prime. */
2384 #define IMAGE_CACHE_BUCKETS_SIZE 1001
2386 #endif /* HAVE_WINDOW_SYSTEM */
2390 /***********************************************************************
2392 ***********************************************************************/
2394 /* Enumeration defining where to find tool-bar item information in
2395 tool-bar items vectors stored with frames. Each tool-bar item
2396 occupies TOOL_BAR_ITEM_NSLOTS elements in such a vector. */
2398 enum tool_bar_item_idx
2400 /* The key of the tool-bar item. Used to remove items when a binding
2401 for `undefined' is found. */
2404 /* Non-nil if item is enabled. */
2405 TOOL_BAR_ITEM_ENABLED_P
,
2407 /* Non-nil if item is selected (pressed). */
2408 TOOL_BAR_ITEM_SELECTED_P
,
2411 TOOL_BAR_ITEM_CAPTION
,
2413 /* Image(s) to display. This is either a single image specification
2414 or a vector of specifications. */
2415 TOOL_BAR_ITEM_IMAGES
,
2418 TOOL_BAR_ITEM_BINDING
,
2420 /* Button type. One of nil, `:radio' or `:toggle'. */
2426 /* Sentinel = number of slots in tool_bar_items occupied by one
2428 TOOL_BAR_ITEM_NSLOTS
2432 /* An enumeration for the different images that can be specified
2433 for a tool-bar item. */
2435 enum tool_bar_item_image
2437 TOOL_BAR_IMAGE_ENABLED_SELECTED
,
2438 TOOL_BAR_IMAGE_ENABLED_DESELECTED
,
2439 TOOL_BAR_IMAGE_DISABLED_SELECTED
,
2440 TOOL_BAR_IMAGE_DISABLED_DESELECTED
2443 /* Non-zero means raise tool-bar buttons when the mouse moves over them. */
2445 extern int auto_raise_tool_bar_buttons_p
;
2447 /* Margin around tool-bar buttons in pixels. */
2449 extern Lisp_Object Vtool_bar_button_margin
;
2451 /* Thickness of relief to draw around tool-bar buttons. */
2453 extern EMACS_INT tool_bar_button_relief
;
2455 /* Default values of the above variables. */
2457 #define DEFAULT_TOOL_BAR_BUTTON_MARGIN 4
2458 #define DEFAULT_TOOL_BAR_BUTTON_RELIEF 1
2460 /* The height in pixels of the default tool-bar images. */
2462 #define DEFAULT_TOOL_BAR_IMAGE_HEIGHT 24
2465 /***********************************************************************
2466 Terminal Capabilities
2467 ***********************************************************************/
2469 /* Each of these is a bit representing a terminal `capability' (bold,
2470 inverse, etc). They are or'd together to specify the set of
2471 capabilities being queried for when calling `tty_capable_p' (which
2472 returns true if the terminal supports all of them). */
2474 #define TTY_CAP_INVERSE 0x01
2475 #define TTY_CAP_UNDERLINE 0x02
2476 #define TTY_CAP_BOLD 0x04
2477 #define TTY_CAP_DIM 0x08
2478 #define TTY_CAP_BLINK 0x10
2479 #define TTY_CAP_ALT_CHARSET 0x20
2482 /***********************************************************************
2484 ***********************************************************************/
2486 /* Defined in xdisp.c */
2488 struct glyph_row
*row_containing_pos
P_ ((struct window
*, int,
2490 struct glyph_row
*, int));
2491 int string_buffer_position
P_ ((struct window
*, Lisp_Object
, int));
2492 int line_bottom_y
P_ ((struct it
*));
2493 int display_prop_intangible_p
P_ ((Lisp_Object
));
2494 void resize_echo_area_exactly
P_ ((void));
2495 int resize_mini_window
P_ ((struct window
*, int));
2496 int try_window
P_ ((Lisp_Object
, struct text_pos
));
2497 void window_box
P_ ((struct window
*, int, int *, int *, int *, int *));
2498 int window_box_height
P_ ((struct window
*));
2499 int window_text_bottom_y
P_ ((struct window
*));
2500 int window_box_width
P_ ((struct window
*, int));
2501 int window_box_left
P_ ((struct window
*, int));
2502 int window_box_right
P_ ((struct window
*, int));
2503 void window_box_edges
P_ ((struct window
*, int, int *, int *, int *, int *));
2504 void mark_window_display_accurate
P_ ((Lisp_Object
, int));
2505 void redisplay_preserve_echo_area
P_ ((int));
2506 void set_cursor_from_row
P_ ((struct window
*, struct glyph_row
*,
2507 struct glyph_matrix
*, int, int, int, int));
2508 void init_iterator
P_ ((struct it
*, struct window
*, int,
2509 int, struct glyph_row
*, enum face_id
));
2510 void init_iterator_to_row_start
P_ ((struct it
*, struct window
*,
2511 struct glyph_row
*));
2512 int get_next_display_element
P_ ((struct it
*));
2513 void set_iterator_to_next
P_ ((struct it
*, int));
2514 void produce_glyphs
P_ ((struct it
*));
2515 void produce_special_glyphs
P_ ((struct it
*, enum display_element_type
));
2516 void start_display
P_ ((struct it
*, struct window
*, struct text_pos
));
2517 void move_it_to
P_ ((struct it
*, int, int, int, int, int));
2518 void move_it_vertically
P_ ((struct it
*, int));
2519 void move_it_vertically_backward
P_ ((struct it
*, int));
2520 void move_it_by_lines
P_ ((struct it
*, int, int));
2521 void move_it_past_eol
P_ ((struct it
*));
2522 int in_display_vector_p
P_ ((struct it
*));
2523 int frame_mode_line_height
P_ ((struct frame
*));
2524 void highlight_trailing_whitespace
P_ ((struct frame
*, struct glyph_row
*));
2525 int tool_bar_item_info
P_ ((struct frame
*, struct glyph
*, int *));
2526 void draw_row_fringe_bitmaps
P_ ((struct window
*, struct glyph_row
*));
2527 void compute_fringe_widths
P_ ((struct frame
*, int));
2528 extern Lisp_Object Qtool_bar
;
2529 extern Lisp_Object Vshow_trailing_whitespace
;
2530 extern int mode_line_in_non_selected_windows
;
2531 extern int redisplaying_p
;
2532 extern Lisp_Object Vimage_types
;
2533 extern void add_to_log
P_ ((char *, Lisp_Object
, Lisp_Object
));
2534 extern int help_echo_showing_p
;
2535 extern int current_mode_line_height
, current_header_line_height
;
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
*));
2544 extern int x_draw_glyphs
P_ ((struct window
*, int , struct glyph_row
*,
2545 enum glyph_row_area
, int, int,
2546 enum draw_glyphs_face
, int));
2548 extern void notice_overwritten_cursor
P_ ((struct window
*,
2549 enum glyph_row_area
,
2550 int, int, int, int));
2552 /* Defined in sysdep.c */
2554 void get_frame_size
P_ ((int *, int *));
2555 void request_sigio
P_ ((void));
2556 void unrequest_sigio
P_ ((void));
2557 int tabs_safe_p
P_ ((void));
2558 void init_baud_rate
P_ ((void));
2559 void init_sigio
P_ ((int));
2561 /* Defined in xfaces.c */
2563 #ifdef HAVE_X_WINDOWS
2564 void x_free_colors
P_ ((struct frame
*, unsigned long *, int));
2567 void update_face_from_frame_parameter
P_ ((struct frame
*, Lisp_Object
,
2569 Lisp_Object tty_color_name
P_ ((struct frame
*, int));
2570 void clear_face_cache
P_ ((int));
2571 unsigned long load_color
P_ ((struct frame
*, struct face
*, Lisp_Object
,
2572 enum lface_attribute_index
));
2573 void unload_color
P_ ((struct frame
*, unsigned long));
2574 int frame_update_line_height
P_ ((struct frame
*));
2575 int ascii_face_of_lisp_face
P_ ((struct frame
*, int));
2576 void prepare_face_for_display
P_ ((struct frame
*, struct face
*));
2577 int xstricmp
P_ ((const unsigned char *, const unsigned char *));
2578 int lookup_face
P_ ((struct frame
*, Lisp_Object
*, int, struct face
*));
2579 int lookup_named_face
P_ ((struct frame
*, Lisp_Object
, int));
2580 int smaller_face
P_ ((struct frame
*, int, int));
2581 int face_with_height
P_ ((struct frame
*, int, int));
2582 int lookup_derived_face
P_ ((struct frame
*, Lisp_Object
, int, int));
2583 void init_frame_faces
P_ ((struct frame
*));
2584 void free_frame_faces
P_ ((struct frame
*));
2585 void recompute_basic_faces
P_ ((struct frame
*));
2586 int face_at_buffer_position
P_ ((struct window
*, int, int, int, int *,
2588 int face_at_string_position
P_ ((struct window
*, Lisp_Object
, int, int, int,
2589 int, int *, enum face_id
, int));
2590 int compute_char_face
P_ ((struct frame
*, int, Lisp_Object
));
2591 void free_all_realized_faces
P_ ((Lisp_Object
));
2592 extern Lisp_Object Qforeground_color
, Qbackground_color
;
2593 extern char unspecified_fg
[], unspecified_bg
[];
2594 void free_realized_multibyte_face
P_ ((struct frame
*, int));
2596 /* Defined in xfns.c */
2598 #ifdef HAVE_X_WINDOWS
2599 void gamma_correct
P_ ((struct frame
*, XColor
*));
2602 void gamma_correct
P_ ((struct frame
*, COLORREF
*));
2605 #ifdef HAVE_WINDOW_SYSTEM
2607 void x_kill_gs_process
P_ ((Pixmap
, struct frame
*));
2608 int x_screen_planes
P_ ((struct frame
*));
2609 void x_implicitly_set_name
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
2610 struct image_cache
*make_image_cache
P_ ((void));
2611 void free_image_cache
P_ ((struct frame
*));
2612 void clear_image_cache
P_ ((struct frame
*, int));
2613 void forall_images_in_image_cache
P_ ((struct frame
*,
2614 void (*) P_ ((struct image
*))));
2615 int valid_image_p
P_ ((Lisp_Object
));
2616 void prepare_image_for_display
P_ ((struct frame
*, struct image
*));
2617 int lookup_image
P_ ((struct frame
*, Lisp_Object
));
2619 #ifdef HAVE_X_WINDOWS
2620 unsigned long image_background
P_ ((struct image
*, struct frame
*,
2622 int image_background_transparent
P_ ((struct image
*, struct frame
*,
2624 #endif /* HAVE_X_WINDOWS */
2626 extern Lisp_Object tip_frame
;
2627 extern Window tip_window
;
2628 EXFUN (Fx_show_tip
, 6);
2629 EXFUN (Fx_hide_tip
, 0);
2630 extern void start_hourglass
P_ ((void));
2631 extern void cancel_hourglass
P_ ((void));
2632 extern int display_hourglass_p
;
2634 /* Returns the background color of IMG, calculating one heuristically if
2635 necessary. If non-zero, XIMG is an existing XImage object to use for
2638 #define IMAGE_BACKGROUND(img, f, ximg) \
2639 ((img)->background_valid \
2640 ? (img)->background \
2641 : image_background (img, f, ximg))
2643 /* Returns true if IMG has a `transparent' background, using heuristics
2644 to decide if necessary. If non-zero, MASK is an existing XImage
2645 object to use for the heuristic. */
2647 #define IMAGE_BACKGROUND_TRANSPARENT(img, f, mask) \
2648 ((img)->background_transparent_valid \
2649 ? (img)->background_transparent \
2650 : image_background_transparent (img, f, mask))
2652 #endif /* HAVE_WINDOW_SYSTEM */
2655 /* Defined in xmenu.c */
2657 int popup_activated
P_ ((void));
2659 /* Defined in dispnew.c */
2661 extern int inverse_video
;
2662 extern int required_matrix_width
P_ ((struct window
*));
2663 extern int required_matrix_height
P_ ((struct window
*));
2664 extern int estimate_mode_line_height
P_ ((struct frame
*, enum face_id
));
2665 extern Lisp_Object mode_line_string
P_ ((struct window
*, int, int, int, int *));
2666 extern Lisp_Object marginal_area_string
P_ ((struct window
*, int, int, int, int *));
2667 extern void redraw_frame
P_ ((struct frame
*));
2668 extern void redraw_garbaged_frames
P_ ((void));
2669 extern void cancel_line
P_ ((int, struct frame
*));
2670 extern void init_desired_glyphs
P_ ((struct frame
*));
2671 extern int scroll_frame_lines
P_ ((struct frame
*, int, int, int, int));
2672 extern int direct_output_for_insert
P_ ((int));
2673 extern int direct_output_forward_char
P_ ((int));
2674 extern int update_frame
P_ ((struct frame
*, int, int));
2675 extern int scrolling
P_ ((struct frame
*));
2676 extern void bitch_at_user
P_ ((void));
2677 void adjust_glyphs
P_ ((struct frame
*));
2678 void free_glyphs
P_ ((struct frame
*));
2679 void free_window_matrices
P_ ((struct window
*));
2680 void check_glyph_memory
P_ ((void));
2681 void mirrored_line_dance
P_ ((struct glyph_matrix
*, int, int, int *, char *));
2682 void clear_glyph_matrix
P_ ((struct glyph_matrix
*));
2683 void clear_current_matrices
P_ ((struct frame
*f
));
2684 void clear_desired_matrices
P_ ((struct frame
*));
2685 void shift_glyph_matrix
P_ ((struct window
*, struct glyph_matrix
*,
2687 void rotate_matrix
P_ ((struct glyph_matrix
*, int, int, int));
2688 void increment_matrix_positions
P_ ((struct glyph_matrix
*,
2689 int, int, int, int));
2690 void blank_row
P_ ((struct window
*, struct glyph_row
*, int));
2691 void increment_row_positions
P_ ((struct glyph_row
*, int, int));
2692 void enable_glyph_matrix_rows
P_ ((struct glyph_matrix
*, int, int, int));
2693 void clear_glyph_row
P_ ((struct glyph_row
*));
2694 void prepare_desired_row
P_ ((struct glyph_row
*));
2695 int line_hash_code
P_ ((struct glyph_row
*));
2696 void set_window_update_flags
P_ ((struct window
*, int));
2697 void write_glyphs
P_ ((struct glyph
*, int));
2698 void insert_glyphs
P_ ((struct glyph
*, int));
2699 void redraw_frame
P_ ((struct frame
*));
2700 void redraw_garbaged_frames
P_ ((void));
2701 int scroll_cost
P_ ((struct frame
*, int, int, int));
2702 int direct_output_for_insert
P_ ((int));
2703 int direct_output_forward_char
P_ ((int));
2704 int update_frame
P_ ((struct frame
*, int, int));
2705 void update_single_window
P_ ((struct window
*, int));
2706 int scrolling
P_ ((struct frame
*));
2707 void buffer_posn_from_coords
P_ ((struct window
*, int *, int *,
2708 Lisp_Object
*, struct display_pos
*));
2709 void do_pending_window_change
P_ ((int));
2710 void change_frame_size
P_ ((struct frame
*, int, int, int, int, int));
2711 void bitch_at_user
P_ ((void));
2712 Lisp_Object sit_for
P_ ((int, int, int, int, int));
2713 void init_display
P_ ((void));
2714 void syms_of_display
P_ ((void));
2715 extern Lisp_Object Qredisplay_dont_pause
;
2717 /* Defined in term.c */
2719 extern void ring_bell
P_ ((void));
2720 extern void set_terminal_modes
P_ ((void));
2721 extern void reset_terminal_modes
P_ ((void));
2722 extern void update_begin
P_ ((struct frame
*));
2723 extern void update_end
P_ ((struct frame
*));
2724 extern void set_terminal_window
P_ ((int));
2725 extern void set_scroll_region
P_ ((int, int));
2726 extern void turn_off_insert
P_ ((void));
2727 extern void turn_off_highlight
P_ ((void));
2728 extern void background_highlight
P_ ((void));
2729 extern void clear_frame
P_ ((void));
2730 extern void clear_end_of_line
P_ ((int));
2731 extern void clear_end_of_line_raw
P_ ((int));
2732 extern void delete_glyphs
P_ ((int));
2733 extern void ins_del_lines
P_ ((int, int));
2734 extern int string_cost
P_ ((char *));
2735 extern int per_line_cost
P_ ((char *));
2736 extern void calculate_costs
P_ ((struct frame
*));
2737 extern void set_tty_color_mode
P_ ((struct frame
*, Lisp_Object
));
2738 extern void tty_setup_colors
P_ ((int));
2739 extern void term_init
P_ ((char *));
2740 extern void fatal
P_ ((/* char *, ... */));
2741 void cursor_to
P_ ((int, int));
2742 extern int tty_capable_p
P_ ((struct frame
*, unsigned, unsigned long, unsigned long));
2744 /* Defined in scroll.c */
2746 extern int scrolling_max_lines_saved
P_ ((int, int, int *, int *, int *));
2747 extern int scroll_cost
P_ ((struct frame
*, int, int, int));
2748 extern void do_line_insertion_deletion_costs
P_ ((struct frame
*, char *,
2749 char *, char *, char *,
2750 char *, char *, int));
2751 void scrolling_1
P_ ((struct frame
*, int, int, int, int *, int *, int *,
2754 #endif /* not DISPEXTERN_H_INCLUDED */