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 #define NativeRectangle XRectangle
58 typedef struct w32_display_info Display_Info
;
63 typedef struct mac_display_info Display_Info
;
65 /* Include Carbon.h to define Cursor and Rect. */
72 /* Macros max and min defined in lisp.h conflict with those in
73 precompiled header Carbon.h. */
77 #include <Carbon/Carbon.h>
79 #define Z (current_buffer->text->z)
81 #define free unexec_free
83 #define malloc unexec_malloc
85 #define realloc unexec_realloc
87 #define min(a, b) ((a) < (b) ? (a) : (b))
89 #define max(a, b) ((a) > (b) ? (a) : (b))
91 #define init_process emacs_init_process
96 #ifndef NativeRectangle
97 #define NativeRectangle int
101 /* Structure forward declarations. Some are here because function
102 prototypes below reference structure types before their definition
103 in this file. Some are here because not every file including
104 dispextern.h also includes frame.h and windows.h. */
114 /* Values returned from coordinates_in_window. */
131 /***********************************************************************
133 ***********************************************************************/
135 /* If GLYPH_DEBUG is non-zero, additional checks are activated. Turn
136 it off by defining the macro GLYPH_DEBUG to zero. */
139 #define GLYPH_DEBUG 0
142 /* Macros to include code only if GLYPH_DEBUG != 0. */
145 #define IF_DEBUG(X) X
146 #define xassert(X) do {if (!(X)) abort ();} while (0)
148 #define IF_DEBUG(X) (void) 0
149 #define xassert(X) (void) 0
152 /* Macro for displaying traces of redisplay. If Emacs was compiled
153 with GLYPH_DEBUG != 0, the variable trace_redisplay_p can be set to
154 a non-zero value in debugging sessions to activate traces. */
158 extern int trace_redisplay_p
;
162 if (trace_redisplay_p) \
167 #else /* GLYPH_DEBUG == 0 */
169 #define TRACE(X) (void) 0
171 #endif /* GLYPH_DEBUG == 0 */
175 /***********************************************************************
177 ***********************************************************************/
179 /* Starting with Emacs 20.3, characters from strings and buffers have
180 both a character and a byte position associated with them. The
181 following structure holds such a pair of positions. */
185 /* Character position. */
188 /* Corresponding byte position. */
192 /* Access character and byte position of POS in a functional form. */
194 #define BYTEPOS(POS) (POS).bytepos
195 #define CHARPOS(POS) (POS).charpos
197 /* Set character position of POS to CHARPOS, byte position to BYTEPOS. */
199 #define SET_TEXT_POS(POS, CHARPOS, BYTEPOS) \
200 ((POS).charpos = (CHARPOS), (POS).bytepos = BYTEPOS)
202 /* Increment text position POS. */
204 #define INC_TEXT_POS(POS, MULTIBYTE_P) \
209 INC_POS ((POS).bytepos); \
215 /* Decrement text position POS. */
217 #define DEC_TEXT_POS(POS, MULTIBYTE_P) \
222 DEC_POS ((POS).bytepos); \
228 /* Set text position POS from marker MARKER. */
230 #define SET_TEXT_POS_FROM_MARKER(POS, MARKER) \
231 (CHARPOS (POS) = marker_position ((MARKER)), \
232 BYTEPOS (POS) = marker_byte_position ((MARKER)))
234 /* Set marker MARKER from text position POS. */
236 #define SET_MARKER_FROM_TEXT_POS(MARKER, POS) \
237 set_marker_both ((MARKER), Qnil, CHARPOS ((POS)), BYTEPOS ((POS)))
239 /* Value is non-zero if character and byte positions of POS1 and POS2
242 #define TEXT_POS_EQUAL_P(POS1, POS2) \
243 ((POS1).charpos == (POS2).charpos \
244 && (POS1).bytepos == (POS2).bytepos)
246 /* When rendering glyphs, redisplay scans string or buffer text,
247 overlay strings in that text, and does display table or control
248 character translations. The following structure captures a
249 position taking all this into account. */
253 /* Buffer or string position. */
256 /* If this is a position in an overlay string, overlay_string_index
257 is the index of that overlay string in the sequence of overlay
258 strings at `pos' in the order redisplay processes them. A value
259 < 0 means that this is not a position in an overlay string. */
260 int overlay_string_index
;
262 /* If this is a position in an overlay string, string_pos is the
263 position within that string. */
264 struct text_pos string_pos
;
266 /* If the character at the position above is a control character or
267 has a display table entry, dpvec_index is an index in the display
268 table or control character translation of that character. A
269 value < 0 means this is not a position in such a translation. */
275 /***********************************************************************
277 ***********************************************************************/
279 /* Enumeration of glyph types. Glyph structures contain a type field
280 containing one of the enumerators defined here. */
284 /* Glyph describes a character. */
287 /* Glyph describes a composition sequence. */
290 /* Glyph describes an image. */
293 /* Glyph is a space of fractional width and/or height. */
300 Be extra careful when changing this structure! Esp. make sure that
301 functions producing glyphs, like append_glyph, fill ALL of the
302 glyph structure, and that GLYPH_EQUAL_P compares all
303 display-relevant members of glyphs (not to imply that these are the
304 only things to check when you add a member). */
308 /* Position from which this glyph was drawn. If `object' below is a
309 Lisp string, this is a position in that string. If it is a
310 buffer, this is a position in that buffer. A value of -1
311 together with a null object means glyph is a truncation glyph at
312 the start of a row. */
315 /* Lisp object source of this glyph. Currently either a buffer or
316 a string, if the glyph was produced from characters which came from
317 a buffer or a string; or 0 if the glyph was inserted by redisplay
318 for its own purposes such as padding. */
321 /* Width in pixels. */
324 /* Vertical offset. If < 0, the glyph is displayed raised, if > 0
325 the glyph is displayed lowered. */
328 /* Which kind of glyph this is---character, image etc. Value
329 should be an enumerator of type enum glyph_type. */
332 /* 1 means this glyph was produced from multibyte text. Zero
333 means it was produced from unibyte text, i.e. charsets aren't
334 applicable, and encoding is not performed. */
335 unsigned multibyte_p
: 1;
337 /* Non-zero means draw a box line at the left or right side of this
338 glyph. This is part of the implementation of the face attribute
340 unsigned left_box_line_p
: 1;
341 unsigned right_box_line_p
: 1;
343 /* Non-zero means this glyph's physical ascent or descent is greater
344 than its logical ascent/descent, i.e. it may potentially overlap
345 glyphs above or below it. */
346 unsigned overlaps_vertically_p
: 1;
348 /* 1 means glyph is a padding glyph. Padding glyphs are used for
349 characters whose visual shape consists of more than one glyph
350 (e.g. Asian characters). All but the first glyph of such a glyph
351 sequence have the padding_p flag set. Only used for terminal
352 frames, and there only to minimize code changes. A better way
353 would probably be to use the width field of glyphs to express
355 unsigned padding_p
: 1;
357 /* 1 means the actual glyph is not available, draw a box instead.
358 This can happen when a font couldn't be loaded, or a character
359 doesn't have a glyph in a font. */
360 unsigned glyph_not_available_p
: 1;
362 /* Face of the glyph. */
363 unsigned face_id
: 21;
365 /* Type of font used to display the character glyph. May be used to
366 determine which set of functions to use to obtain font metrics
367 for the glyph. On W32, value should be an enumerator of the type
368 w32_char_font_type. Otherwise it equals FONT_TYPE_UNKNOWN. */
369 unsigned font_type
: 3;
371 /* A union of sub-structures for different glyph types. */
374 /* Character code for character glyphs (type == CHAR_GLYPH). */
377 /* Composition ID for composition glyphs (type == COMPOSITION_GLYPH) */
380 /* Image ID for image glyphs (type == IMAGE_GLYPH). */
383 /* Sub-structure for type == STRETCH_GLYPH. */
386 /* The height of the glyph. */
387 unsigned height
: 16;
389 /* The ascent of the glyph. */
390 unsigned ascent
: 16;
394 /* Used to compare all bit-fields above in one step. */
400 /* Default value of the glyph font_type field. */
402 #define FONT_TYPE_UNKNOWN 0
404 /* Is GLYPH a space? */
406 #define CHAR_GLYPH_SPACE_P(GLYPH) \
407 (GLYPH_FROM_CHAR_GLYPH ((GLYPH)) == SPACEGLYPH)
409 /* Are glyphs *X and *Y displayed equal? */
411 #define GLYPH_EQUAL_P(X, Y) \
412 ((X)->type == (Y)->type \
413 && (X)->u.val == (Y)->u.val \
414 && (X)->face_id == (Y)->face_id \
415 && (X)->padding_p == (Y)->padding_p \
416 && (X)->left_box_line_p == (Y)->left_box_line_p \
417 && (X)->right_box_line_p == (Y)->right_box_line_p \
418 && (X)->voffset == (Y)->voffset \
419 && (X)->pixel_width == (Y)->pixel_width)
421 /* Are character codes, faces, padding_ps of glyphs *X and *Y equal? */
423 #define GLYPH_CHAR_AND_FACE_EQUAL_P(X, Y) \
424 ((X)->u.ch == (Y)->u.ch \
425 && (X)->face_id == (Y)->face_id \
426 && (X)->padding_p == (Y)->padding_p)
428 /* Fill a character glyph GLYPH. CODE, FACE_ID, PADDING_P correspond
429 to the bits defined for the typedef `GLYPH' in lisp.h. */
431 #define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P) \
434 (GLYPH).u.ch = (CODE); \
435 (GLYPH).face_id = (FACE_ID); \
436 (GLYPH).padding_p = (PADDING_P); \
440 /* Fill a character type glyph GLYPH from a glyph typedef FROM as
441 defined in lisp.h. */
443 #define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM) \
444 SET_CHAR_GLYPH ((GLYPH), \
445 FAST_GLYPH_CHAR ((FROM)), \
446 FAST_GLYPH_FACE ((FROM)), \
449 /* Construct a glyph code from a character glyph GLYPH. If the
450 character is multibyte, return -1 as we can't use glyph table for a
451 multibyte character. */
453 #define GLYPH_FROM_CHAR_GLYPH(GLYPH) \
454 ((GLYPH).u.ch < 256 \
455 ? ((GLYPH).u.ch | ((GLYPH).face_id << CHARACTERBITS)) \
458 /* Is GLYPH a padding glyph? */
460 #define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p
465 /***********************************************************************
467 ***********************************************************************/
471 Glyph memory for frame-based redisplay is allocated from the heap
472 in one vector kept in a glyph pool structure which is stored with
473 the frame. The size of the vector is made large enough to cover
474 all windows on the frame.
476 Both frame and window glyph matrices reference memory from a glyph
477 pool in frame-based redisplay.
479 In window-based redisplay, no glyphs pools exist; windows allocate
480 and free their glyph memory themselves. */
484 /* Vector of glyphs allocated from the heap. */
485 struct glyph
*glyphs
;
487 /* Allocated size of `glyphs'. */
490 /* Number of rows and columns in a matrix. */
496 /***********************************************************************
498 ***********************************************************************/
502 Three kinds of glyph matrices exist:
504 1. Frame glyph matrices. These are used for terminal frames whose
505 redisplay needs a view of the whole screen due to limited terminal
506 capabilities. Frame matrices are used only in the update phase
507 of redisplay. They are built in update_frame and not used after
508 the update has been performed.
510 2. Window glyph matrices on frames having frame glyph matrices.
511 Such matrices are sub-matrices of their corresponding frame matrix,
512 i.e. frame glyph matrices and window glyph matrices share the same
513 glyph memory which is allocated in form of a glyph_pool structure.
514 Glyph rows in such a window matrix are slices of frame matrix rows.
516 2. Free-standing window glyph matrices managing their own glyph
517 storage. This form is used in window-based redisplay which
518 includes variable width and height fonts etc.
520 The size of a window's row vector depends on the height of fonts
521 defined on its frame. It is chosen so that the vector is large
522 enough to describe all lines in a window when it is displayed in
523 the smallest possible character size. When new fonts are loaded,
524 or window sizes change, the row vector is adjusted accordingly. */
528 /* The pool from which glyph memory is allocated, if any. This is
529 null for frame matrices and for window matrices managing their
531 struct glyph_pool
*pool
;
533 /* Vector of glyph row structures. The row at nrows - 1 is reserved
534 for the mode line. */
535 struct glyph_row
*rows
;
537 /* Number of elements allocated for the vector rows above. */
540 /* The number of rows used by the window if all lines were displayed
541 with the smallest possible character height. */
544 /* Origin within the frame matrix if this is a window matrix on a
545 frame having a frame matrix. Both values are zero for
546 window-based redisplay. */
547 int matrix_x
, matrix_y
;
549 /* Width and height of the matrix in columns and rows. */
550 int matrix_w
, matrix_h
;
552 /* If this structure describes a window matrix of window W,
553 window_left_col is the value of W->left_col, window_top_line the
554 value of W->top_line, window_height and window_width are width and
555 height of W, as returned by window_box, and window_vscroll is the
556 value of W->vscroll at the time the matrix was last adjusted.
557 Only set for window-based redisplay. */
558 int window_left_col
, window_top_line
;
559 int window_height
, window_width
;
562 /* Number of glyphs reserved for left and right marginal areas when
563 the matrix was last adjusted. */
564 int left_margin_glyphs
, right_margin_glyphs
;
566 /* Flag indicating that scrolling should not be tried in
567 update_window. This flag is set by functions like try_window_id
568 which do their own scrolling. */
569 unsigned no_scrolling_p
: 1;
571 /* Non-zero means window displayed in this matrix has a top mode
573 unsigned header_line_p
: 1;
576 /* A string identifying the method used to display the matrix. */
580 /* The buffer this matrix displays. Set in
581 mark_window_display_accurate_1. */
582 struct buffer
*buffer
;
584 /* Values of BEGV and ZV as of last redisplay. Set in
585 mark_window_display_accurate_1. */
590 /* Check that glyph pointers stored in glyph rows of MATRIX are okay.
591 This aborts if any pointer is found twice. */
594 void check_matrix_pointer_lossage
P_ ((struct glyph_matrix
*));
595 #define CHECK_MATRIX(MATRIX) check_matrix_pointer_lossage ((MATRIX))
597 #define CHECK_MATRIX(MATRIX) (void) 0
602 /***********************************************************************
604 ***********************************************************************/
606 /* Area in window glyph matrix. If values are added or removed, the
607 function mark_object in alloc.c has to be changed. */
618 /* Rows of glyphs in a windows or frame glyph matrix.
620 Each row is partitioned into three areas. The start and end of
621 each area is recorded in a pointer as shown below.
623 +--------------------+-------------+---------------------+
624 | left margin area | text area | right margin area |
625 +--------------------+-------------+---------------------+
627 glyphs[LEFT_MARGIN_AREA] glyphs[RIGHT_MARGIN_AREA]
632 Rows in frame matrices reference glyph memory allocated in a frame
633 glyph pool (see the description of struct glyph_pool). Rows in
634 window matrices on frames having frame matrices reference slices of
635 the glyphs of corresponding rows in the frame matrix.
637 Rows in window matrices on frames having no frame matrices point to
638 glyphs allocated from the heap via xmalloc;
639 glyphs[LEFT_MARGIN_AREA] is the start address of the allocated
640 glyph structure array. */
644 /* Pointers to beginnings of areas. The end of an area A is found at
645 A + 1 in the vector. The last element of the vector is the end
648 Kludge alert: Even if used[TEXT_AREA] == 0, glyphs[TEXT_AREA][0]'s
649 position field is used. It is -1 if this row does not correspond
650 to any text; it is some buffer position if the row corresponds to
651 an empty display line that displays a line end. This is what old
652 redisplay used to do. (Except in code for terminal frames, this
653 kludge is no longer used, I believe. --gerd).
655 See also start, end, displays_text_p and ends_at_zv_p for cleaner
656 ways to do it. The special meaning of positions 0 and -1 will be
657 removed some day, so don't use it in new code. */
658 struct glyph
*glyphs
[1 + LAST_AREA
];
660 /* Number of glyphs actually filled in areas. */
661 short used
[LAST_AREA
];
663 /* Window-relative x and y-position of the top-left corner of this
664 row. If y < 0, this means that abs (y) pixels of the row are
665 invisible because it is partially visible at the top of a window.
666 If x < 0, this means that abs (x) pixels of the first glyph of
667 the text area of the row are invisible because the glyph is
668 partially visible. */
671 /* Width of the row in pixels without taking face extension at the
672 end of the row into account, and without counting truncation
673 and continuation glyphs at the end of a row on ttys. */
676 /* Logical ascent/height of this line. The value of ascent is zero
677 and height is 1 on terminal frames. */
680 /* Physical ascent/height of this line. If max_ascent > ascent,
681 this line overlaps the line above it on the display. Otherwise,
682 if max_height > height, this line overlaps the line beneath it. */
683 int phys_ascent
, phys_height
;
685 /* Portion of row that is visible. Partially visible rows may be
686 found at the top and bottom of a window. This is 1 for tty
687 frames. It may be < 0 in case of completely invisible rows. */
690 /* Hash code. This hash code is available as soon as the row
691 is constructed, i.e. after a call to display_line. */
694 /* First position in this row. This is the text position, including
695 overlay position information etc, where the display of this row
696 started, and can thus be less the position of the first glyph
697 (e.g. due to invisible text or horizontal scrolling). */
698 struct display_pos start
;
700 /* Text position at the end of this row. This is the position after
701 the last glyph on this row. It can be greater than the last
702 glyph position + 1, due to truncation, invisible text etc. In an
703 up-to-date display, this should always be equal to the start
704 position of the next row. */
705 struct display_pos end
;
707 /* In a desired matrix, 1 means that this row must be updated. In a
708 current matrix, 0 means that the row has been invalidated, i.e.
709 the row's contents do not agree with what is visible on the
711 unsigned enabled_p
: 1;
713 /* 1 means row displays a text line that is truncated on the left or
715 unsigned truncated_on_left_p
: 1;
716 unsigned truncated_on_right_p
: 1;
718 /* 1 means the overlay arrow is on this line. */
719 unsigned overlay_arrow_p
: 1;
721 /* 1 means that this row displays a continued line, i.e. it has a
722 continuation mark at the right side. */
723 unsigned continued_p
: 1;
725 /* 0 means that this row does not contain any text, i.e. it is
726 a blank line at the window and buffer end. */
727 unsigned displays_text_p
: 1;
729 /* 1 means that this line ends at ZV. */
730 unsigned ends_at_zv_p
: 1;
732 /* 1 means the face of the last glyph in the text area is drawn to
733 the right end of the window. This flag is used in
734 update_text_area to optimize clearing to the end of the area. */
735 unsigned fill_line_p
: 1;
737 /* Non-zero means display a bitmap on X frames indicating that this
738 line contains no text and ends in ZV. */
739 unsigned indicate_empty_line_p
: 1;
741 /* 1 means this row contains glyphs that overlap each other because
742 of lbearing or rbearing. */
743 unsigned contains_overlapping_glyphs_p
: 1;
745 /* 1 means this row is as wide as the window it is displayed in, including
746 scroll bars, fringes, and internal borders. This also
747 implies that the row doesn't have marginal areas. */
748 unsigned full_width_p
: 1;
750 /* Non-zero means row is a mode or header-line. */
751 unsigned mode_line_p
: 1;
753 /* 1 in a current row means this row is overlapped by another row. */
754 unsigned overlapped_p
: 1;
756 /* 1 means this line ends in the middle of a character consisting
757 of more than one glyph. Some glyphs have been put in this row,
758 the rest are put in rows below this one. */
759 unsigned ends_in_middle_of_char_p
: 1;
761 /* 1 means this line starts in the middle of a character consisting
762 of more than one glyph. Some glyphs have been put in the
763 previous row, the rest are put in this row. */
764 unsigned starts_in_middle_of_char_p
: 1;
766 /* 1 in a current row means this row overlaps others. */
767 unsigned overlapping_p
: 1;
769 /* 1 means some glyphs in this row are displayed in mouse-face. */
770 unsigned mouse_face_p
: 1;
772 /* 1 means this row was ended by a newline from a string. */
773 unsigned ends_in_newline_from_string_p
: 1;
775 /* Continuation lines width at the start of the row. */
776 int continuation_lines_width
;
780 /* Get a pointer to row number ROW in matrix MATRIX. If GLYPH_DEBUG
781 is defined to a non-zero value, the function matrix_row checks that
782 we don't try to access rows that are out of bounds. */
785 struct glyph_row
*matrix_row
P_ ((struct glyph_matrix
*, int));
786 #define MATRIX_ROW(MATRIX, ROW) matrix_row ((MATRIX), (ROW))
788 #define MATRIX_ROW(MATRIX, ROW) ((MATRIX)->rows + (ROW))
791 /* Return a pointer to the row reserved for the mode line in MATRIX.
792 Row MATRIX->nrows - 1 is always reserved for the mode line. */
794 #define MATRIX_MODE_LINE_ROW(MATRIX) \
795 ((MATRIX)->rows + (MATRIX)->nrows - 1)
797 /* Return a pointer to the row reserved for the header line in MATRIX.
798 This is always the first row in MATRIX because that's the only
799 way that works in frame-based redisplay. */
801 #define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows
803 /* Return a pointer to first row in MATRIX used for text display. */
805 #define MATRIX_FIRST_TEXT_ROW(MATRIX) \
806 ((MATRIX)->rows->mode_line_p ? (MATRIX)->rows + 1 : (MATRIX)->rows)
808 /* Return a pointer to the first glyph in the text area of a row.
809 MATRIX is the glyph matrix accessed, and ROW is the row index in
812 #define MATRIX_ROW_GLYPH_START(MATRIX, ROW) \
813 (MATRIX_ROW ((MATRIX), (ROW))->glyphs[TEXT_AREA])
815 /* Return the number of used glyphs in the text area of a row. */
817 #define MATRIX_ROW_USED(MATRIX, ROW) \
818 (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA])
820 /* Return the character/ byte position at which the display of ROW
823 #define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->start.pos.charpos)
824 #define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->start.pos.bytepos)
826 /* Return the character/ byte position at which ROW ends. */
828 #define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->end.pos.charpos)
829 #define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->end.pos.bytepos)
831 /* Return the vertical position of ROW in MATRIX. */
833 #define MATRIX_ROW_VPOS(ROW, MATRIX) ((ROW) - (MATRIX)->rows)
835 /* Return the last glyph row + 1 in MATRIX on window W reserved for
836 text. If W has a mode line, the last row in the matrix is reserved
839 #define MATRIX_BOTTOM_TEXT_ROW(MATRIX, W) \
842 - (WINDOW_WANTS_MODELINE_P ((W)) ? 1 : 0))
844 /* Non-zero if the face of the last glyph in ROW's text area has
845 to be drawn to the end of the text area. */
847 #define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)
849 /* Set and query the enabled_p flag of glyph row ROW in MATRIX. */
851 #define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
852 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0)
854 #define MATRIX_ROW_ENABLED_P(MATRIX, ROW) \
855 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p)
857 /* Non-zero if ROW displays text. Value is non-zero if the row is
858 blank but displays a line end. */
860 #define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)
862 /* Non-zero if ROW is not completely visible in window W. */
864 #define MATRIX_ROW_PARTIALLY_VISIBLE_P(ROW) \
865 ((ROW)->height != (ROW)->visible_height)
867 /* Non-zero if ROW is partially visible at the top of window W. */
869 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW) \
870 (MATRIX_ROW_PARTIALLY_VISIBLE_P ((ROW)) \
871 && (ROW)->y < WINDOW_HEADER_LINE_HEIGHT ((W)))
873 /* Non-zero if ROW is partially visible at the bottom of window W. */
875 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW) \
876 (MATRIX_ROW_PARTIALLY_VISIBLE_P ((ROW)) \
877 && (ROW)->y + (ROW)->height > WINDOW_BOX_HEIGHT_NO_MODE_LINE ((W)))
879 /* Return the bottom Y + 1 of ROW. */
881 #define MATRIX_ROW_BOTTOM_Y(ROW) ((ROW)->y + (ROW)->height)
883 /* Is ROW the last visible one in the display described by the
884 iterator structure pointed to by IT?. */
886 #define MATRIX_ROW_LAST_VISIBLE_P(ROW, IT) \
887 (MATRIX_ROW_BOTTOM_Y ((ROW)) >= (IT)->last_visible_y)
889 /* Non-zero if ROW displays a continuation line. */
891 #define MATRIX_ROW_CONTINUATION_LINE_P(ROW) \
892 ((ROW)->continuation_lines_width > 0)
894 /* Non-zero if ROW ends in the middle of a character. This is the
895 case for continued lines showing only part of a display table entry
896 or a control char, or an overlay string. */
898 #define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW) \
899 ((ROW)->end.dpvec_index >= 0 \
900 || (ROW)->end.overlay_string_index >= 0 \
901 || (ROW)->ends_in_middle_of_char_p)
903 /* Non-zero if ROW ends in the middle of an overlay string. */
905 #define MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P(ROW) \
906 ((ROW)->end.overlay_string_index >= 0)
908 /* Non-zero if ROW starts in the middle of a character. See above. */
910 #define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW) \
911 ((ROW)->start.dpvec_index >= 0 \
912 || (ROW)->starts_in_middle_of_char_p \
913 || ((ROW)->start.overlay_string_index >= 0 \
914 && (ROW)->start.string_pos.charpos > 0))
916 /* Non-zero means ROW overlaps its predecessor. */
918 #define MATRIX_ROW_OVERLAPS_PRED_P(ROW) \
919 ((ROW)->phys_ascent > (ROW)->ascent)
921 /* Non-zero means ROW overlaps its successor. */
923 #define MATRIX_ROW_OVERLAPS_SUCC_P(ROW) \
924 ((ROW)->phys_height - (ROW)->phys_ascent \
925 > (ROW)->height - (ROW)->ascent)
927 /* Non-zero means that fonts have been loaded since the last glyph
928 matrix adjustments. The function redisplay_internal adjusts glyph
929 matrices when this flag is non-zero. */
931 extern int fonts_changed_p
;
933 /* A glyph for a space. */
935 extern struct glyph space_glyph
;
937 /* Frame being updated by update_window/update_frame. */
939 extern struct frame
*updating_frame
;
941 /* Window being updated by update_window. This is non-null as long as
942 update_window has not finished, and null otherwise. It's role is
943 analogous to updating_frame. */
945 extern struct window
*updated_window
;
947 /* Glyph row and area updated by update_window_line. */
949 extern struct glyph_row
*updated_row
;
950 extern int updated_area
;
952 /* Non-zero means reading single-character input with prompt so put
953 cursor on mini-buffer after the prompt. Positive means at end of
954 text in echo area; negative means at beginning of line. */
956 extern int cursor_in_echo_area
;
958 /* Non-zero means last display completed. Zero means it was
961 extern int display_completed
;
963 /* Non-zero means redisplay has been performed directly (see also
964 direct_output_for_insert and direct_output_forward_char), so that
965 no further updating has to be performed. The function
966 redisplay_internal checks this flag, and does nothing but reset it
967 to zero if it is non-zero. */
969 extern int redisplay_performed_directly_p
;
971 /* A temporary storage area, including a row of glyphs. Initialized
972 in xdisp.c. Used for various purposes, as an example see
973 direct_output_for_insert. */
975 extern struct glyph_row scratch_glyph_row
;
979 /************************************************************************
981 ************************************************************************/
983 /* Enumeration for overriding/changing the face to use for drawing
984 glyphs in draw_glyphs. */
986 enum draw_glyphs_face
996 #ifdef HAVE_WINDOW_SYSTEM
998 /* A sequence of glyphs to be drawn in the same face. */
1002 /* X-origin of the string. */
1005 /* Y-origin and y-position of the base line of this string. */
1008 /* The width of the string, not including a face extension. */
1011 /* The width of the string, including a face extension. */
1012 int background_width
;
1014 /* The height of this string. This is the height of the line this
1015 string is drawn in, and can be different from the height of the
1016 font the string is drawn in. */
1019 /* Number of pixels this string overwrites in front of its x-origin.
1020 This number is zero if the string has an lbearing >= 0; it is
1021 -lbearing, if the string has an lbearing < 0. */
1024 /* Number of pixels this string overwrites past its right-most
1025 nominal x-position, i.e. x + width. Zero if the string's
1026 rbearing is <= its nominal width, rbearing - width otherwise. */
1029 /* The frame on which the glyph string is drawn. */
1032 /* The window on which the glyph string is drawn. */
1035 /* X display and window for convenience. */
1039 /* The glyph row for which this string was built. It determines the
1040 y-origin and height of the string. */
1041 struct glyph_row
*row
;
1043 /* The area within row. */
1044 enum glyph_row_area area
;
1046 /* Characters to be drawn, and number of characters. */
1050 /* A face-override for drawing cursors, mouse face and similar. */
1051 enum draw_glyphs_face hl
;
1053 /* Face in which this string is to be drawn. */
1056 /* Font in which this string is to be drawn. */
1059 /* Font info for this string. */
1060 struct font_info
*font_info
;
1062 /* Non-null means this string describes (part of) a composition.
1063 All characters from char2b are drawn composed. */
1064 struct composition
*cmp
;
1066 /* Index of this glyph string's first character in the glyph
1067 definition of CMP. If this is zero, this glyph string describes
1068 the first character of a composition. */
1071 /* 1 means this glyph strings face has to be drawn to the right end
1072 of the window's drawing area. */
1073 unsigned extends_to_end_of_line_p
: 1;
1075 /* 1 means the background of this string has been drawn. */
1076 unsigned background_filled_p
: 1;
1078 /* 1 means glyph string must be drawn with 16-bit functions. */
1079 unsigned two_byte_p
: 1;
1081 /* 1 means that the original font determined for drawing this glyph
1082 string could not be loaded. The member `font' has been set to
1083 the frame's default font in this case. */
1084 unsigned font_not_found_p
: 1;
1086 /* 1 means that the face in which this glyph string is drawn has a
1088 unsigned stippled_p
: 1;
1090 /* 1 means only the foreground of this glyph string must be drawn,
1091 and we should use the physical height of the line this glyph
1092 string appears in as clip rect. */
1093 unsigned for_overlaps_p
: 1;
1095 /* The GC to use for drawing this glyph string. */
1096 #if defined(HAVE_X_WINDOWS) || defined(HAVE_CARBON)
1099 #if defined(HAVE_NTGUI)
1104 /* A pointer to the first glyph in the string. This glyph
1105 corresponds to char2b[0]. Needed to draw rectangles if
1106 font_not_found_p is 1. */
1107 struct glyph
*first_glyph
;
1109 /* Image, if any. */
1112 struct glyph_string
*next
, *prev
;
1115 #endif /* HAVE_WINDOW_SYSTEM */
1118 /************************************************************************
1120 ************************************************************************/
1122 /* Return the height of the mode line in glyph matrix MATRIX, or zero
1123 if not known. This macro is called under circumstances where
1124 MATRIX might not have been allocated yet. */
1126 #define MATRIX_MODE_LINE_HEIGHT(MATRIX) \
1127 ((MATRIX) && (MATRIX)->rows \
1128 ? MATRIX_MODE_LINE_ROW (MATRIX)->height \
1131 /* Return the height of the header line in glyph matrix MATRIX, or zero
1132 if not known. This macro is called under circumstances where
1133 MATRIX might not have been allocated yet. */
1135 #define MATRIX_HEADER_LINE_HEIGHT(MATRIX) \
1136 ((MATRIX) && (MATRIX)->rows \
1137 ? MATRIX_HEADER_LINE_ROW (MATRIX)->height \
1140 /* Return the desired face id for the mode line of a window, depending
1141 on whether the window is selected or not, or if the window is the
1142 scrolling window for the currently active minibuffer window.
1144 Due to the way display_mode_lines manipulates with the contents of
1145 selected_window, this macro needs three arguments: SELW which is
1146 compared against the current value of selected_window, MBW which is
1147 compared against minibuf_window (if SELW doesn't match), and SCRW
1148 which is compared against minibuf_selected_window (if MBW matches). */
1150 #define CURRENT_MODE_LINE_FACE_ID_3(SELW, MBW, SCRW) \
1151 ((!mode_line_in_non_selected_windows \
1152 || (SELW) == XWINDOW (selected_window) \
1153 || (minibuf_level > 0 \
1154 && !NILP (minibuf_selected_window) \
1155 && (MBW) == XWINDOW (minibuf_window) \
1156 && (SCRW) == XWINDOW (minibuf_selected_window))) \
1157 ? MODE_LINE_FACE_ID \
1158 : MODE_LINE_INACTIVE_FACE_ID)
1161 /* Return the desired face id for the mode line of window W. */
1163 #define CURRENT_MODE_LINE_FACE_ID(W) \
1164 (CURRENT_MODE_LINE_FACE_ID_3((W), XWINDOW (selected_window), (W)))
1166 /* Return the current height of the mode line of window W. If not
1167 known from current_mode_line_height, look at W's current glyph
1168 matrix, or return a default based on the height of the font of the
1169 face `mode-line'. */
1171 #define CURRENT_MODE_LINE_HEIGHT(W) \
1172 (current_mode_line_height >= 0 \
1173 ? current_mode_line_height \
1174 : (MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1175 ? MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1176 : estimate_mode_line_height (XFRAME ((W)->frame), \
1177 CURRENT_MODE_LINE_FACE_ID (W))))
1179 /* Return the current height of the header line of window W. If not
1180 known from current_header_line_height, look at W's current glyph
1181 matrix, or return an estimation based on the height of the font of
1182 the face `header-line'. */
1184 #define CURRENT_HEADER_LINE_HEIGHT(W) \
1185 (current_header_line_height >= 0 \
1186 ? current_header_line_height \
1187 : (MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1188 ? MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1189 : estimate_mode_line_height (XFRAME ((W)->frame), \
1190 HEADER_LINE_FACE_ID)))
1192 /* Return the height of the desired mode line of window W. */
1194 #define DESIRED_MODE_LINE_HEIGHT(W) \
1195 MATRIX_MODE_LINE_HEIGHT ((W)->desired_matrix)
1197 /* Return the height of the desired header line of window W. */
1199 #define DESIRED_HEADER_LINE_HEIGHT(W) \
1200 MATRIX_HEADER_LINE_HEIGHT ((W)->desired_matrix)
1202 /* Value is non-zero if window W wants a mode line. */
1204 #define WINDOW_WANTS_MODELINE_P(W) \
1205 (!MINI_WINDOW_P ((W)) \
1206 && !(W)->pseudo_window_p \
1207 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1208 && BUFFERP ((W)->buffer) \
1209 && !NILP (XBUFFER ((W)->buffer)->mode_line_format) \
1210 && WINDOW_TOTAL_LINES (W) > 1)
1212 /* Value is non-zero if window W wants a header line. */
1214 #define WINDOW_WANTS_HEADER_LINE_P(W) \
1215 (!MINI_WINDOW_P ((W)) \
1216 && !(W)->pseudo_window_p \
1217 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1218 && BUFFERP ((W)->buffer) \
1219 && !NILP (XBUFFER ((W)->buffer)->header_line_format) \
1220 && WINDOW_TOTAL_LINES (W) > 1 + !NILP (XBUFFER ((W)->buffer)->mode_line_format))
1223 /* Return proper value to be used as baseline offset of font that has
1224 ASCENT and DESCENT to draw characters by the font at the vertical
1225 center of the line of frame F.
1227 Here, our task is to find the value of BOFF in the following figure;
1229 -------------------------+-----------+-
1230 -+-+---------+-+ | |
1232 | | | | F_ASCENT F_HEIGHT
1235 | | |-|-+------+-----------|------- baseline
1237 | |---------|-+-+ | |
1239 -+-+---------+-+ F_DESCENT |
1240 -------------------------+-----------+-
1242 -BOFF + DESCENT + (F_HEIGHT - HEIGHT) / 2 = F_DESCENT
1243 BOFF = DESCENT + (F_HEIGHT - HEIGHT) / 2 - F_DESCENT
1244 DESCENT = FONT->descent
1245 HEIGHT = FONT_HEIGHT (FONT)
1246 F_DESCENT = (FRAME_FONT (F)->descent
1247 - F->output_data.x->baseline_offset)
1248 F_HEIGHT = FRAME_LINE_HEIGHT (F)
1251 #define VCENTER_BASELINE_OFFSET(FONT, F) \
1252 (FONT_DESCENT (FONT) \
1253 + (FRAME_LINE_HEIGHT ((F)) - FONT_HEIGHT ((FONT)) \
1254 + (FRAME_LINE_HEIGHT ((F)) > FONT_HEIGHT ((FONT)))) / 2 \
1255 - (FONT_DESCENT (FRAME_FONT (F)) - FRAME_BASELINE_OFFSET (F)))
1258 /***********************************************************************
1260 ***********************************************************************/
1262 /* Indices of face attributes in Lisp face vectors. Slot zero is the
1265 enum lface_attribute_index
1267 LFACE_FAMILY_INDEX
= 1,
1272 LFACE_UNDERLINE_INDEX
,
1273 LFACE_INVERSE_INDEX
,
1274 LFACE_FOREGROUND_INDEX
,
1275 LFACE_BACKGROUND_INDEX
,
1276 LFACE_STIPPLE_INDEX
,
1277 LFACE_OVERLINE_INDEX
,
1278 LFACE_STRIKE_THROUGH_INDEX
,
1281 LFACE_INHERIT_INDEX
,
1282 LFACE_AVGWIDTH_INDEX
,
1287 /* Box types of faces. */
1291 /* No box around text. */
1294 /* Simple box of specified width and color. Default width is 1, and
1295 default color is the foreground color of the face. */
1298 /* Boxes with 3D shadows. Color equals the background color of the
1299 face. Width is specified. */
1305 /* Structure describing a realized face.
1307 For each Lisp face, 0..N realized faces can exist for different
1308 frames and different charsets. Realized faces are built from Lisp
1309 faces and text properties/overlays by merging faces and adding
1310 unspecified attributes from the `default' face. */
1314 /* The id of this face. The id equals the index of this face in the
1315 vector faces_by_id of its face cache. */
1318 #ifdef HAVE_WINDOW_SYSTEM
1320 /* If non-zero, this is a GC that we can use without modification for
1321 drawing the characters in this face. */
1324 /* Font used for this face, or null if the font could not be loaded
1325 for some reason. This points to a `font' slot of a struct
1326 font_info, and we should not call XFreeFont on it because the
1327 font may still be used somewhere else. */
1330 /* Background stipple or bitmap used for this face. This is
1331 an id as returned from load_pixmap. */
1334 #else /* not HAVE_WINDOW_SYSTEM */
1339 #endif /* not HAVE_WINDOW_SYSTEM */
1341 /* Pixel value of foreground color for X frames. Color index
1343 unsigned long foreground
;
1345 /* Pixel value or color index of background color. */
1346 unsigned long background
;
1348 /* Pixel value or color index of underline color. */
1349 unsigned long underline_color
;
1351 /* Pixel value or color index of overlined, strike-through, or box
1353 unsigned long overline_color
;
1354 unsigned long strike_through_color
;
1355 unsigned long box_color
;
1357 /* The font's name. This points to a `name' of a font_info, and it
1358 must not be freed. */
1361 /* Font info ID for this face's font. An ID is stored here because
1362 pointers to font_info structures may change. The reason is that
1363 they are pointers into a font table vector that is itself
1367 /* Fontset ID if this face uses a fontset, or -1. This is only >= 0
1368 if the face was realized for a composition sequence.
1369 Otherwise, a specific font is loaded from the set of fonts
1370 specified by the fontset given by the family attribute of the face. */
1373 /* Pixmap width and height. */
1374 unsigned int pixmap_w
, pixmap_h
;
1376 /* Non-zero means characters in this face have a box that thickness
1377 around them. If it is negative, the absolute value indicates the
1378 thickness, and the horizontal lines of box (top and bottom) are
1379 drawn inside of characters glyph area. The vertical lines of box
1380 (left and right) are drawn as the same way as the case that this
1381 value is positive. */
1384 /* Type of box drawn. A value of FACE_NO_BOX means no box is drawn
1385 around text in this face. A value of FACE_SIMPLE_BOX means a box
1386 of width box_line_width is drawn in color box_color. A value of
1387 FACE_RAISED_BOX or FACE_SUNKEN_BOX means a 3D box is drawn with
1388 shadow colors derived from the background color of the face. */
1389 enum face_box_type box
;
1391 /* If `box' above specifies a 3D type, 1 means use box_color for
1393 unsigned use_box_color_for_shadows_p
: 1;
1395 /* The Lisp face attributes this face realizes. All attributes
1396 in this vector are non-nil. */
1397 Lisp_Object lface
[LFACE_VECTOR_SIZE
];
1399 /* The hash value of this face. */
1402 /* The charset for which this face was realized if it was realized
1403 for use in multibyte text. If fontset >= 0, this is the charset
1404 of the first character of the composition sequence. A value of
1405 charset < 0 means the face was realized for use in unibyte text
1406 where the idea of Emacs charsets isn't applicable. */
1409 /* Non-zero if text in this face should be underlined, overlined,
1410 strike-through or have a box drawn around it. */
1411 unsigned underline_p
: 1;
1412 unsigned overline_p
: 1;
1413 unsigned strike_through_p
: 1;
1415 /* 1 means that the colors specified for this face could not be
1416 loaded, and were replaced by default colors, so they shouldn't be
1418 unsigned foreground_defaulted_p
: 1;
1419 unsigned background_defaulted_p
: 1;
1421 /* 1 means that either no color is specified for underlining or that
1422 the specified color couldn't be loaded. Use the foreground
1423 color when drawing in that case. */
1424 unsigned underline_defaulted_p
: 1;
1426 /* 1 means that either no color is specified for the corresponding
1427 attribute or that the specified color couldn't be loaded.
1428 Use the foreground color when drawing in that case. */
1429 unsigned overline_color_defaulted_p
: 1;
1430 unsigned strike_through_color_defaulted_p
: 1;
1431 unsigned box_color_defaulted_p
: 1;
1433 /* TTY appearances. Blinking is not yet implemented. Colors are
1434 found in `lface' with empty color string meaning the default
1435 color of the TTY. */
1436 unsigned tty_bold_p
: 1;
1437 unsigned tty_dim_p
: 1;
1438 unsigned tty_underline_p
: 1;
1439 unsigned tty_alt_charset_p
: 1;
1440 unsigned tty_reverse_p
: 1;
1441 unsigned tty_blinking_p
: 1;
1443 /* 1 means that colors of this face may not be freed because they
1444 have been copied bitwise from a base face (see
1446 unsigned colors_copied_bitwise_p
: 1;
1448 /* If non-zero, use overstrike (to simulate bold-face). */
1449 unsigned overstrike
: 1;
1451 /* Next and previous face in hash collision list of face cache. */
1452 struct face
*next
, *prev
;
1454 /* If this face is for ASCII characters, this points this face
1455 itself. Otherwise, this points a face for ASCII characters. */
1456 struct face
*ascii_face
;
1460 /* Color index indicating that face uses a terminal's default color. */
1462 #define FACE_TTY_DEFAULT_COLOR ((unsigned long) -1)
1464 /* Color index indicating that face uses an unknown foreground color. */
1466 #define FACE_TTY_DEFAULT_FG_COLOR ((unsigned long) -2)
1468 /* Color index indicating that face uses an unknown background color. */
1470 #define FACE_TTY_DEFAULT_BG_COLOR ((unsigned long) -3)
1472 /* Non-zero if FACE was realized for unibyte use. */
1474 #define FACE_UNIBYTE_P(FACE) ((FACE)->charset < 0)
1477 /* IDs of important faces known by the C face code. These are the IDs
1478 of the faces for CHARSET_ASCII. */
1484 MODE_LINE_INACTIVE_FACE_ID
,
1487 HEADER_LINE_FACE_ID
,
1493 BASIC_FACE_ID_SENTINEL
1497 /* A cache of realized faces. Each frame has its own cache because
1498 Emacs allows different frame-local face definitions. */
1502 /* Hash table of cached realized faces. */
1503 struct face
**buckets
;
1505 /* Back-pointer to the frame this cache belongs to. */
1508 /* A vector of faces so that faces can be referenced by an ID. */
1509 struct face
**faces_by_id
;
1511 /* The allocated size, and number of used slots of faces_by_id. */
1514 /* Flag indicating that attributes of the `menu' face have been
1516 unsigned menu_face_changed_p
: 1;
1520 /* Prepare face FACE for use on frame F. This must be called before
1521 using X resources of FACE. */
1523 #define PREPARE_FACE_FOR_DISPLAY(F, FACE) \
1524 if ((FACE)->gc == 0) \
1525 prepare_face_for_display ((F), (FACE)); \
1529 /* Return a pointer to the face with ID on frame F, or null if such a
1530 face doesn't exist. */
1532 #define FACE_FROM_ID(F, ID) \
1533 (((unsigned) (ID) < FRAME_FACE_CACHE (F)->used) \
1534 ? FRAME_FACE_CACHE (F)->faces_by_id[ID] \
1537 #ifdef HAVE_WINDOW_SYSTEM
1539 /* Non-zero if FACE is suitable for displaying character CHAR. */
1541 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) \
1542 (SINGLE_BYTE_CHAR_P (CHAR) \
1543 ? (FACE) == (FACE)->ascii_face \
1544 : face_suitable_for_char_p ((FACE), (CHAR)))
1546 /* Return the id of the realized face on frame F that is like the face
1547 with id ID but is suitable for displaying character CHAR.
1548 This macro is only meaningful for multibyte character CHAR. */
1550 #define FACE_FOR_CHAR(F, FACE, CHAR) \
1551 (SINGLE_BYTE_CHAR_P (CHAR) \
1552 ? (FACE)->ascii_face->id \
1553 : face_for_char ((F), (FACE), (CHAR)))
1555 #else /* not HAVE_WINDOW_SYSTEM */
1557 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) 1
1558 #define FACE_FOR_CHAR(F, FACE, CHAR) ((FACE)->id)
1560 #endif /* not HAVE_WINDOW_SYSTEM */
1562 /* Non-zero means face attributes have been changed since the last
1563 redisplay. Used in redisplay_internal. */
1565 extern int face_change_count
;
1570 /***********************************************************************
1572 ***********************************************************************/
1574 enum fringe_bitmap_type
1576 NO_FRINGE_BITMAP
= 0,
1577 LEFT_TRUNCATION_BITMAP
,
1578 RIGHT_TRUNCATION_BITMAP
,
1579 CONTINUED_LINE_BITMAP
,
1580 CONTINUATION_LINE_BITMAP
,
1581 OVERLAY_ARROW_BITMAP
,
1586 struct fringe_bitmap
1591 unsigned char *bits
;
1594 /* Structure used to describe where and how to draw a fringe bitmap.
1595 WHICH is the fringe bitmap to draw. WD and H is the (adjusted)
1596 width and height of the bitmap, DH is the height adjustment (if
1597 bitmap is periodic). X and Y are frame coordinates of the area to
1598 display the bitmap, DY is relative offset of the bitmap into that
1599 area. BX, NX, BY, NY specifies the area to clear if the bitmap
1600 does not fill the entire area. FACE is the fringe face. */
1602 struct draw_fringe_bitmap_params
1604 enum fringe_bitmap_type which
;
1611 extern struct fringe_bitmap fringe_bitmaps
[MAX_FRINGE_BITMAPS
];
1614 /***********************************************************************
1616 ***********************************************************************/
1618 /* Iteration over things to display in current_buffer or in a string.
1620 The iterator handles:
1622 1. Overlay strings (after-string, before-string).
1624 3. Invisible text properties.
1625 4. Selective display.
1626 5. Translation of characters via display tables.
1627 6. Translation of control characters to the forms `\003' or `^C'.
1628 7. `glyph' and `space-width' properties.
1630 Iterators are initialized by calling init_iterator or one of the
1631 equivalent functions below. A call to get_next_display_element
1632 loads the iterator structure with information about what next to
1633 display. A call to set_iterator_to_next increments the iterator's
1636 Characters from overlay strings, display table entries or control
1637 character translations are returned one at a time. For example, if
1638 we have a text of `a\x01' where `a' has a display table definition
1639 of `cd' and the control character is displayed with a leading
1640 arrow, then the iterator will return:
1642 Call Return Source Call next
1643 -----------------------------------------------------------------
1644 next c display table move
1645 next d display table move
1646 next ^ control char move
1647 next A control char move
1649 The same mechanism is also used to return characters for ellipses
1650 displayed at the end of invisible text.
1652 CAVEAT: Under some circumstances, move_.* functions can be called
1653 asynchronously, e.g. when computing a buffer position from an x and
1654 y pixel position. This means that these functions and functions
1655 called from them SHOULD NOT USE xmalloc and alike. See also the
1656 comment at the start of xdisp.c. */
1658 /* Enumeration describing what kind of display element an iterator is
1659 loaded with after a call to get_next_display_element. */
1661 enum display_element_type
1663 /* A normal character. */
1666 /* A composition sequence. */
1672 /* A flexible width and height space. */
1675 /* End of buffer or string. */
1678 /* Truncation glyphs. Never returned by get_next_display_element.
1679 Used to get display information about truncation glyphs via
1683 /* Continuation glyphs. See the comment for IT_TRUNCATION. */
1688 /* An enumerator for each text property that has a meaning for display
1697 COMPOSITION_PROP_IDX
,
1699 /* Not a property. Used to indicate changes in overlays. */
1709 /* The window in which we iterate over current_buffer (or a string). */
1713 /* The window's frame. */
1716 /* Function to call to load this structure with the next display
1718 int (* method
) P_ ((struct it
*it
));
1720 /* The next position at which to check for face changes, invisible
1721 text, overlay strings, end of text etc., which see. */
1724 /* Maximum string or buffer position + 1. ZV when iterating over
1728 /* C string to iterate over. Non-null means get characters from
1729 this string, otherwise characters are read from current_buffer
1733 /* Number of characters in the string (s, or it->string) we iterate
1737 /* Start and end of a visible region; -1 if the region is not
1738 visible in the window. */
1739 int region_beg_charpos
, region_end_charpos
;
1741 /* Position at which redisplay end trigger functions should be run. */
1742 int redisplay_end_trigger_charpos
;
1744 /* 1 means multibyte characters are enabled. */
1745 unsigned multibyte_p
: 1;
1747 /* 1 means window has a mode line at its top. */
1748 unsigned header_line_p
: 1;
1750 /* 1 means `string' is the value of a `display' property.
1751 Don't handle some `display' properties in these strings. */
1752 unsigned string_from_display_prop_p
: 1;
1754 /* Display table in effect or null for none. */
1755 struct Lisp_Char_Table
*dp
;
1757 /* Current display table vector to return characters from and its
1758 end. dpvec null means we are not returning characters from a
1759 display table entry; current.dpvec_index gives the current index
1760 into dpvec. This same mechanism is also used to return
1761 characters from translated control characters, i.e. `\003' or
1763 Lisp_Object
*dpvec
, *dpend
;
1765 /* Length in bytes of the char that filled dpvec. A value of zero
1766 means that no such character is involved. */
1769 /* Face id of the iterator saved in case a glyph from dpvec contains
1770 a face. The face is restored when all glyphs from dpvec have
1774 /* Vector of glyphs for control character translation. The pointer
1775 dpvec is set to ctl_chars when a control character is translated.
1776 This vector is also used for incomplete multibyte character
1777 translation (e.g \222\244). Such a character is at most 4 bytes,
1778 thus we need at most 16 bytes here. */
1779 Lisp_Object ctl_chars
[16];
1781 /* Initial buffer or string position of the iterator, before skipping
1782 over display properties and invisible text. */
1783 struct display_pos start
;
1785 /* Current buffer or string position of the iterator, including
1786 position in overlay strings etc. */
1787 struct display_pos current
;
1789 /* Vector of overlays to process. Overlay strings are processed
1790 OVERLAY_STRING_CHUNK_SIZE at a time. */
1791 #define OVERLAY_STRING_CHUNK_SIZE 3
1792 Lisp_Object overlay_strings
[OVERLAY_STRING_CHUNK_SIZE
];
1794 /* Total number of overlay strings to process. This can be >
1795 OVERLAY_STRING_CHUNK_SIZE. */
1796 int n_overlay_strings
;
1798 /* If non-nil, a Lisp string being processed. If
1799 current.overlay_string_index >= 0, this is an overlay string from
1803 /* Stack of saved values. New entries are pushed when we begin to
1804 process an overlay string or a string from a `glyph' property.
1805 Entries are popped when we return to deliver display elements
1806 from what we previously had. */
1807 struct iterator_stack_entry
1812 struct display_pos pos
;
1815 enum glyph_row_area area
;
1816 unsigned multibyte_p
: 1;
1817 unsigned string_from_display_prop_p
: 1;
1818 unsigned display_ellipsis_p
: 1;
1819 Lisp_Object space_width
;
1821 Lisp_Object font_height
;
1825 /* Stack pointer. */
1828 /* Setting of buffer-local variable selective-display-ellipsis. */
1829 unsigned selective_display_ellipsis_p
: 1;
1831 /* 1 means control characters are translated into the form `^C'
1832 where the `^' can be replaced by a display table entry. */
1833 unsigned ctl_arrow_p
: 1;
1835 /* -1 means selective display hides everything between a \r and the
1836 next newline; > 0 means hide lines indented more than that value. */
1839 /* An enumeration describing what the next display element is
1840 after a call to get_next_display_element. */
1841 enum display_element_type what
;
1846 /* Non-zero means that the current face has a box. */
1847 unsigned face_box_p
: 1;
1849 /* Non-null means that the current character is the first in a run
1850 of characters with box face. */
1851 unsigned start_of_box_run_p
: 1;
1853 /* Non-zero means that the current character is the last in a run
1854 of characters with box face. */
1855 unsigned end_of_box_run_p
: 1;
1857 /* 1 means overlay strings at end_charpos have been processed. */
1858 unsigned overlay_strings_at_end_processed_p
: 1;
1860 /* 1 means the actual glyph is not available in the current
1862 unsigned glyph_not_available_p
: 1;
1864 /* 1 means the next line in display_line continues a character
1865 consisting of more than one glyph, and some glyphs of this
1866 character have been put on the previous line. */
1867 unsigned starts_in_middle_of_char_p
: 1;
1869 /* If 1, saved_face_id contains the id of the face in front of text
1870 skipped due to selective display. */
1871 unsigned face_before_selective_p
: 1;
1873 /* The ID of the default face to use. One of DEFAULT_FACE_ID,
1874 MODE_LINE_FACE_ID, etc, depending on what we are displaying. */
1877 /* If what == IT_CHARACTER, character and length in bytes. This is
1878 a character from a buffer or string. It may be different from
1879 the character displayed in case that
1880 unibyte_display_via_language_environment is set.
1882 If what == IT_COMPOSITION, the first component of a composition
1883 and length in bytes of the composition. */
1886 /* If what == IT_COMPOSITION, identification number and length in
1887 chars of a composition. */
1888 int cmp_id
, cmp_len
;
1890 /* The character to display, possibly translated to multibyte
1891 if unibyte_display_via_language_environment is set. This
1892 is set after produce_glyphs has been called. */
1893 int char_to_display
;
1895 /* If what == IT_IMAGE, the id of the image to display. */
1898 /* Value of the `space-width' property, if any; nil if none. */
1899 Lisp_Object space_width
;
1901 /* Computed from the value of the `raise' property. */
1904 /* Value of the `height' property, if any; nil if none. */
1905 Lisp_Object font_height
;
1907 /* Object and position where the current display element came from.
1908 Object can be a Lisp string in case the current display element
1909 comes from an overlay string, or it is buffer. Position is
1910 a position in object. */
1912 struct text_pos position
;
1914 /* 1 means lines are truncated. */
1915 unsigned truncate_lines_p
: 1;
1917 /* Number of columns per \t. */
1920 /* Width in pixels of truncation and continuation glyphs. */
1921 short truncation_pixel_width
, continuation_pixel_width
;
1923 /* First and last visible x-position in the display area. If window
1924 is hscrolled by n columns, first_visible_x == n * FRAME_COLUMN_WIDTH
1925 (f), and last_visible_x == pixel width of W + first_visible_x. */
1926 int first_visible_x
, last_visible_x
;
1928 /* Last visible y-position + 1 in the display area without a mode
1929 line, if the window has one. */
1932 /* Additional space in pixels between lines (for window systems
1934 int extra_line_spacing
;
1936 /* If non-null, glyphs are produced in glyph_row with each call to
1938 struct glyph_row
*glyph_row
;
1940 /* The area of glyph_row to which glyphs are added. */
1941 enum glyph_row_area area
;
1943 /* Number of glyphs needed for the last character requested via
1944 produce_glyphs. This is 1 except for tabs. */
1947 /* Width of the display element in pixels. Result of
1951 /* Current, maximum logical, and maximum physical line height
1952 information. Result of produce_glyphs. */
1953 int ascent
, descent
, max_ascent
, max_descent
;
1954 int phys_ascent
, phys_descent
, max_phys_ascent
, max_phys_descent
;
1956 /* Current x pixel position within the display line. This value
1957 does not include the width of continuation lines in front of the
1958 line. The value of current_x is automatically incremented by
1959 pixel_width with each call to produce_glyphs. */
1962 /* Accumulated width of continuation lines. If > 0, this means we
1963 are currently in a continuation line. This is initially zero and
1964 incremented/reset by display_line, move_it_to etc. */
1965 int continuation_lines_width
;
1967 /* Current y-position. Automatically incremented by the height of
1968 glyph_row in move_it_to and display_line. */
1971 /* Vertical matrix position of first text line in window. */
1974 /* Current vertical matrix position, or line number. Automatically
1975 incremented by move_it_to and display_line. */
1978 /* Horizontal matrix position reached in move_it_in_display_line.
1979 Only set there, not in display_line. */
1984 /* Access to positions of iterator IT. */
1986 #define IT_CHARPOS(IT) CHARPOS ((IT).current.pos)
1987 #define IT_BYTEPOS(IT) BYTEPOS ((IT).current.pos)
1988 #define IT_STRING_CHARPOS(IT) CHARPOS ((IT).current.string_pos)
1989 #define IT_STRING_BYTEPOS(IT) BYTEPOS ((IT).current.string_pos)
1991 /* Test if IT has reached the end of its buffer or string. This will
1992 only work after get_next_display_element has been called. */
1994 #define ITERATOR_AT_END_P(IT) ((IT)->what == IT_EOB)
1996 /* Non-zero means IT is at the end of a line. This is the case if it
1997 is either on a newline or on a carriage return and selective
1998 display hides the rest of the line. */
2000 #define ITERATOR_AT_END_OF_LINE_P(IT) \
2001 ((IT)->what == IT_CHARACTER \
2002 && ((IT)->c == '\n' \
2003 || ((IT)->c == '\r' && (IT)->selective)))
2005 /* Call produce_glyphs or produce_glyphs_hook, if set. Shortcut to
2006 avoid the function call overhead. */
2008 #define PRODUCE_GLYPHS(IT) \
2010 extern int inhibit_free_realized_faces; \
2012 rif->produce_glyphs ((IT)); \
2014 produce_glyphs ((IT)); \
2015 if ((IT)->glyph_row != NULL) \
2016 inhibit_free_realized_faces = 1; \
2019 /* Bit-flags indicating what operation move_it_to should perform. */
2021 enum move_operation_enum
2023 /* Stop if specified x-position is reached. */
2026 /* Stop if specified y-position is reached. */
2029 /* Stop if specified vpos is reached. */
2030 MOVE_TO_VPOS
= 0x04,
2032 /* Stop if specified buffer or string position is reached. */
2038 /***********************************************************************
2039 Window-based redisplay interface
2040 ***********************************************************************/
2042 /* Structure used to describe runs of lines that must be scrolled. */
2046 /* Source and destination y pixel position. */
2047 int desired_y
, current_y
;
2049 /* Source and destination vpos in matrix. */
2050 int desired_vpos
, current_vpos
;
2052 /* Height in pixels, number of glyph rows. */
2057 /* Handlers for setting frame parameters. */
2059 typedef void (*frame_parm_handler
) P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
2062 /* Structure holding system-dependent interface functions needed
2063 for window-based redisplay. */
2065 struct redisplay_interface
2067 /* Handlers for setting frame parameters. */
2068 frame_parm_handler
*frame_parm_handlers
;
2070 /* Produce glyphs/get display metrics for the display element IT is
2072 void (*produce_glyphs
) P_ ((struct it
*it
));
2074 /* Write or insert LEN glyphs from STRING at the nominal output
2076 void (*write_glyphs
) P_ ((struct glyph
*string
, int len
));
2077 void (*insert_glyphs
) P_ ((struct glyph
*start
, int len
));
2079 /* Clear from nominal output position to X. X < 0 means clear
2080 to right end of display. */
2081 void (*clear_end_of_line
) P_ ((int x
));
2083 /* Function to call to scroll the display as described by RUN on
2085 void (*scroll_run_hook
) P_ ((struct window
*w
, struct run
*run
));
2087 /* Function to call after a line in a display has been completely
2088 updated. Used to draw truncation marks and alike. DESIRED_ROW
2089 is the desired row which has been updated. */
2090 void (*after_update_window_line_hook
) P_ ((struct glyph_row
*desired_row
));
2092 /* Function to call before beginning to update window W in
2093 window-based redisplay. */
2094 void (*update_window_begin_hook
) P_ ((struct window
*w
));
2096 /* Function to call after window W has been updated in window-based
2097 redisplay. CURSOR_ON_P non-zero means switch cursor on.
2098 MOUSE_FACE_OVERWRITTEN_P non-zero means that some lines in W
2099 that contained glyphs in mouse-face were overwritten, so we
2100 have to update the mouse highlight. */
2101 void (*update_window_end_hook
) P_ ((struct window
*w
, int cursor_on_p
,
2102 int mouse_face_overwritten_p
));
2104 /* Move cursor to row/column position VPOS/HPOS, pixel coordinates
2105 Y/X. HPOS/VPOS are window-relative row and column numbers and X/Y
2106 are window-relative pixel positions. */
2107 void (*cursor_to
) P_ ((int vpos
, int hpos
, int y
, int x
));
2109 /* Flush the display of frame F. For X, this is XFlush. */
2110 void (*flush_display
) P_ ((struct frame
*f
));
2112 /* Flush the display of frame F if non-NULL. This is called
2113 during redisplay, and should be NULL on systems which flushes
2114 automatically before reading input. */
2115 void (*flush_display_optional
) P_ ((struct frame
*f
));
2117 /* Clear the mouse hightlight in window W, if there is any. */
2118 void (*clear_window_mouse_face
) P_ ((struct window
*w
));
2120 /* Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
2122 void (*get_glyph_overhangs
) P_ ((struct glyph
*glyph
, struct frame
*f
,
2123 int *left
, int *right
));
2125 /* Fix the display of AREA of ROW in window W for overlapping rows.
2126 This function is called from redraw_overlapping_rows after
2127 desired rows have been made current. */
2128 void (*fix_overlapping_area
) P_ ((struct window
*w
, struct glyph_row
*row
,
2129 enum glyph_row_area area
));
2131 #ifdef HAVE_WINDOW_SYSTEM
2133 /* Draw a fringe bitmap in window W of row ROW using parameters P. */
2134 void (*draw_fringe_bitmap
) P_ ((struct window
*w
, struct glyph_row
*row
,
2135 struct draw_fringe_bitmap_params
*p
));
2137 /* Get metrics of character CHAR2B in FONT of type FONT_TYPE.
2138 Value is null if CHAR2B is not contained in the font. */
2139 XCharStruct
* (*per_char_metric
) P_ ((XFontStruct
*font
, XChar2b
*char2b
,
2142 /* Encode CHAR2B using encoding information from FONT_INFO. CHAR2B is
2143 the two-byte form of C. Encoding is returned in *CHAR2B. If
2144 TWO_BYTE_P is non-null, return non-zero there if font is two-byte. */
2145 int (*encode_char
) P_ ((int c
, XChar2b
*char2b
,
2146 struct font_info
*font_into
, int *two_byte_p
));
2148 /* Compute left and right overhang of glyph string S.
2149 A NULL pointer if platform does not support this. */
2150 void (*compute_glyph_string_overhangs
) P_ ((struct glyph_string
*s
));
2152 /* Draw a glyph string S. */
2153 void (*draw_glyph_string
) P_ ((struct glyph_string
*s
));
2155 /* Define cursor CURSOR on frame F. */
2156 void (*define_frame_cursor
) P_ ((struct frame
*f
, Cursor cursor
));
2158 /* Clear the area at (X,Y,WIDTH,HEIGHT) of frame F. */
2159 void (*clear_frame_area
) P_ ((struct frame
*f
, int x
, int y
,
2160 int width
, int height
));
2162 /* Draw specified cursor CURSOR_TYPE of width CURSOR_WIDTH
2163 at row GLYPH_ROW on window W if ON_P is 1. If ON_P is
2164 0, don't draw cursor. If ACTIVE_P is 1, system caret
2165 should track this cursor (when applicable). */
2166 void (*draw_window_cursor
) P_ ((struct window
*w
,
2167 struct glyph_row
*glyph_row
,
2169 int cursor_type
, int cursor_width
,
2170 int on_p
, int active_p
));
2172 /* Draw vertical border for window W from (X,Y0) to (X,Y1). */
2173 void (*draw_vertical_window_border
) P_ ((struct window
*w
,
2174 int x
, int y0
, int y1
));
2176 /* Shift display of frame F to make room for inserted glyphs.
2177 The area at pixel (X,Y) of width WIDTH and height HEIGHT is
2178 shifted right by SHIFT_BY pixels. */
2179 void (*shift_glyphs_for_insert
) P_ ((struct frame
*f
,
2180 int x
, int y
, int width
,
2181 int height
, int shift_by
));
2183 #endif /* HAVE_WINDOW_SYSTEM */
2186 /* The current interface for window-based redisplay. */
2188 extern struct redisplay_interface
*rif
;
2191 /***********************************************************************
2193 ***********************************************************************/
2195 #ifdef HAVE_WINDOW_SYSTEM
2197 /* Structure forward declarations. */
2202 /* Each image format (JPEG, TIFF, ...) supported is described by
2203 a structure of the type below. */
2207 /* A symbol uniquely identifying the image type, .e.g `jpeg'. */
2210 /* Check that SPEC is a valid image specification for the given
2211 image type. Value is non-zero if SPEC is valid. */
2212 int (* valid_p
) P_ ((Lisp_Object spec
));
2214 /* Load IMG which is used on frame F from information contained in
2215 IMG->spec. Value is non-zero if successful. */
2216 int (* load
) P_ ((struct frame
*f
, struct image
*img
));
2218 /* Free resources of image IMG which is used on frame F. */
2219 void (* free
) P_ ((struct frame
*f
, struct image
*img
));
2221 /* Next in list of all supported image types. */
2222 struct image_type
*next
;
2226 /* Structure describing an image. Specific image formats like XBM are
2227 converted into this form, so that display only has to deal with
2228 this type of image. */
2232 /* The time in seconds at which the image was last displayed. Set
2233 in prepare_image_for_display. */
2234 unsigned long timestamp
;
2236 /* Pixmaps of the image. */
2237 Pixmap pixmap
, mask
;
2239 /* Colors allocated for this image, if any. Allocated via xmalloc. */
2240 unsigned long *colors
;
2243 /* A single `background color' for this image, for the use of anyone that
2244 cares about such a thing. Only valid if the `background_valid' field
2245 is true. This should generally be accessed by calling the accessor
2246 macro `IMAGE_BACKGROUND', which will heuristically calculate a value
2248 unsigned long background
;
2250 /* True if this image has a `transparent' background -- that is, is
2251 uses an image mask. The accessor macro for this is
2252 `IMAGE_BACKGROUND_TRANSPARENT'. */
2253 unsigned background_transparent
: 1;
2255 /* True if the `background' and `background_transparent' fields are
2256 valid, respectively. */
2257 unsigned background_valid
: 1, background_transparent_valid
: 1;
2259 /* Width and height of the image. */
2262 /* These values are used for the rectangles displayed for images
2263 that can't be loaded. */
2264 #define DEFAULT_IMAGE_WIDTH 30
2265 #define DEFAULT_IMAGE_HEIGHT 30
2267 /* Percent of image height used as ascent. A value of
2268 CENTERED_IMAGE_ASCENT means draw the image centered on the
2271 #define DEFAULT_IMAGE_ASCENT 50
2272 #define CENTERED_IMAGE_ASCENT -1
2274 /* Lisp specification of this image. */
2277 /* Relief to draw around the image. */
2280 /* Optional margins around the image. This includes the relief. */
2281 int hmargin
, vmargin
;
2283 /* Reference to the type of the image. */
2284 struct image_type
*type
;
2286 /* 1 means that loading the image failed. Don't try again. */
2287 unsigned load_failed_p
;
2289 /* A place for image types to store additional data. The member
2290 data.lisp_val is marked during GC, so it's safe to store Lisp data
2291 there. Image types should free this data when their `free'
2292 function is called. */
2297 Lisp_Object lisp_val
;
2300 /* Hash value of image specification to speed up comparisons. */
2303 /* Image id of this image. */
2306 /* Hash collision chain. */
2307 struct image
*next
, *prev
;
2311 /* Cache of images. Each frame has a cache. X frames with the same
2312 x_display_info share their caches. */
2316 /* Hash table of images. */
2317 struct image
**buckets
;
2319 /* Vector mapping image ids to images. */
2320 struct image
**images
;
2322 /* Allocated size of `images'. */
2325 /* Number of images in the cache. */
2328 /* Reference count (number of frames sharing this cache). */
2333 /* Value is a pointer to the image with id ID on frame F, or null if
2334 no image with that id exists. */
2336 #define IMAGE_FROM_ID(F, ID) \
2337 (((ID) >= 0 && (ID) < (FRAME_X_IMAGE_CACHE (F)->used)) \
2338 ? FRAME_X_IMAGE_CACHE (F)->images[ID] \
2341 /* Size of bucket vector of image caches. Should be prime. */
2343 #define IMAGE_CACHE_BUCKETS_SIZE 1001
2345 #endif /* HAVE_WINDOW_SYSTEM */
2349 /***********************************************************************
2351 ***********************************************************************/
2353 /* Enumeration defining where to find tool-bar item information in
2354 tool-bar items vectors stored with frames. Each tool-bar item
2355 occupies TOOL_BAR_ITEM_NSLOTS elements in such a vector. */
2357 enum tool_bar_item_idx
2359 /* The key of the tool-bar item. Used to remove items when a binding
2360 for `undefined' is found. */
2363 /* Non-nil if item is enabled. */
2364 TOOL_BAR_ITEM_ENABLED_P
,
2366 /* Non-nil if item is selected (pressed). */
2367 TOOL_BAR_ITEM_SELECTED_P
,
2370 TOOL_BAR_ITEM_CAPTION
,
2372 /* Image(s) to display. This is either a single image specification
2373 or a vector of specifications. */
2374 TOOL_BAR_ITEM_IMAGES
,
2377 TOOL_BAR_ITEM_BINDING
,
2379 /* Button type. One of nil, `:radio' or `:toggle'. */
2385 /* Sentinel = number of slots in tool_bar_items occupied by one
2387 TOOL_BAR_ITEM_NSLOTS
2391 /* An enumeration for the different images that can be specified
2392 for a tool-bar item. */
2394 enum tool_bar_item_image
2396 TOOL_BAR_IMAGE_ENABLED_SELECTED
,
2397 TOOL_BAR_IMAGE_ENABLED_DESELECTED
,
2398 TOOL_BAR_IMAGE_DISABLED_SELECTED
,
2399 TOOL_BAR_IMAGE_DISABLED_DESELECTED
2402 /* Margin around tool-bar buttons in pixels. */
2404 extern Lisp_Object Vtool_bar_button_margin
;
2406 /* Thickness of relief to draw around tool-bar buttons. */
2408 extern EMACS_INT tool_bar_button_relief
;
2410 /* Default values of the above variables. */
2412 #define DEFAULT_TOOL_BAR_BUTTON_MARGIN 4
2413 #define DEFAULT_TOOL_BAR_BUTTON_RELIEF 1
2415 /* The height in pixels of the default tool-bar images. */
2417 #define DEFAULT_TOOL_BAR_IMAGE_HEIGHT 24
2420 /***********************************************************************
2421 Terminal Capabilities
2422 ***********************************************************************/
2424 /* Each of these is a bit representing a terminal `capability' (bold,
2425 inverse, etc). They are or'd together to specify the set of
2426 capabilities being queried for when calling `tty_capable_p' (which
2427 returns true if the terminal supports all of them). */
2429 #define TTY_CAP_INVERSE 0x01
2430 #define TTY_CAP_UNDERLINE 0x02
2431 #define TTY_CAP_BOLD 0x04
2432 #define TTY_CAP_DIM 0x08
2433 #define TTY_CAP_BLINK 0x10
2434 #define TTY_CAP_ALT_CHARSET 0x20
2437 /***********************************************************************
2439 ***********************************************************************/
2441 /* Defined in xdisp.c */
2443 struct glyph_row
*row_containing_pos
P_ ((struct window
*, int,
2445 struct glyph_row
*, int));
2446 int string_buffer_position
P_ ((struct window
*, Lisp_Object
, int));
2447 int line_bottom_y
P_ ((struct it
*));
2448 int display_prop_intangible_p
P_ ((Lisp_Object
));
2449 void resize_echo_area_exactly
P_ ((void));
2450 int resize_mini_window
P_ ((struct window
*, int));
2451 int try_window
P_ ((Lisp_Object
, struct text_pos
));
2452 void window_box
P_ ((struct window
*, int, int *, int *, int *, int *));
2453 int window_box_height
P_ ((struct window
*));
2454 int window_text_bottom_y
P_ ((struct window
*));
2455 int window_box_width
P_ ((struct window
*, int));
2456 int window_box_left
P_ ((struct window
*, int));
2457 int window_box_left_offset
P_ ((struct window
*, int));
2458 int window_box_right
P_ ((struct window
*, int));
2459 int window_box_right_offset
P_ ((struct window
*, int));
2460 void window_box_edges
P_ ((struct window
*, int, int *, int *, int *, int *));
2461 int estimate_mode_line_height
P_ ((struct frame
*, enum face_id
));
2462 void pixel_to_glyph_coords
P_ ((struct frame
*, int, int, int *, int *,
2463 NativeRectangle
*, int));
2464 int glyph_to_pixel_coords
P_ ((struct window
*, int, int, int *, int *));
2465 void mark_window_display_accurate
P_ ((Lisp_Object
, int));
2466 void redisplay_preserve_echo_area
P_ ((int));
2467 void set_cursor_from_row
P_ ((struct window
*, struct glyph_row
*,
2468 struct glyph_matrix
*, int, int, int, int));
2469 void init_iterator
P_ ((struct it
*, struct window
*, int,
2470 int, struct glyph_row
*, enum face_id
));
2471 void init_iterator_to_row_start
P_ ((struct it
*, struct window
*,
2472 struct glyph_row
*));
2473 int get_next_display_element
P_ ((struct it
*));
2474 void set_iterator_to_next
P_ ((struct it
*, int));
2475 void produce_glyphs
P_ ((struct it
*));
2476 void produce_special_glyphs
P_ ((struct it
*, enum display_element_type
));
2477 void start_display
P_ ((struct it
*, struct window
*, struct text_pos
));
2478 void move_it_to
P_ ((struct it
*, int, int, int, int, int));
2479 void move_it_vertically
P_ ((struct it
*, int));
2480 void move_it_vertically_backward
P_ ((struct it
*, int));
2481 void move_it_by_lines
P_ ((struct it
*, int, int));
2482 void move_it_past_eol
P_ ((struct it
*));
2483 int in_display_vector_p
P_ ((struct it
*));
2484 int frame_mode_line_height
P_ ((struct frame
*));
2485 void highlight_trailing_whitespace
P_ ((struct frame
*, struct glyph_row
*));
2486 void draw_row_fringe_bitmaps
P_ ((struct window
*, struct glyph_row
*));
2487 void compute_fringe_widths
P_ ((struct frame
*, int));
2488 extern Lisp_Object Qtool_bar
;
2489 extern Lisp_Object Vshow_trailing_whitespace
;
2490 extern int mode_line_in_non_selected_windows
;
2491 extern int redisplaying_p
;
2492 extern Lisp_Object Vimage_types
;
2493 extern void add_to_log
P_ ((char *, Lisp_Object
, Lisp_Object
));
2494 extern int help_echo_showing_p
;
2495 extern int current_mode_line_height
, current_header_line_height
;
2496 extern Lisp_Object help_echo_string
, help_echo_window
;
2497 extern Lisp_Object help_echo_object
, previous_help_echo_string
;
2498 extern int help_echo_pos
;
2499 extern struct frame
*last_mouse_frame
;
2500 extern int last_tool_bar_item
;
2501 extern int mouse_autoselect_window
;
2503 #ifdef HAVE_WINDOW_SYSTEM
2506 extern void dump_glyph_string
P_ ((struct glyph_string
*));
2509 extern void x_get_glyph_overhangs
P_ ((struct glyph
*, struct frame
*,
2511 extern void x_produce_glyphs
P_ ((struct it
*));
2513 extern void x_write_glyphs
P_ ((struct glyph
*, int));
2514 extern void x_insert_glyphs
P_ ((struct glyph
*, int len
));
2515 extern void x_clear_end_of_line
P_ ((int));
2517 extern int x_stretch_cursor_p
;
2518 extern struct cursor_pos output_cursor
;
2520 extern void x_fix_overlapping_area
P_ ((struct window
*, struct glyph_row
*,
2521 enum glyph_row_area
));
2522 extern void draw_phys_cursor_glyph
P_ ((struct window
*,
2524 enum draw_glyphs_face
));
2525 extern void erase_phys_cursor
P_ ((struct window
*));
2526 extern void display_and_set_cursor
P_ ((struct window
*,
2527 int, int, int, int, int));
2529 extern void set_output_cursor
P_ ((struct cursor_pos
*));
2530 extern void x_cursor_to
P_ ((int, int, int, int));
2532 extern void x_update_cursor
P_ ((struct frame
*, int));
2533 extern void x_clear_cursor
P_ ((struct window
*));
2534 extern void x_draw_vertical_border
P_ ((struct window
*w
));
2536 extern void frame_to_window_pixel_xy
P_ ((struct window
*, int *, int *));
2537 extern void get_glyph_string_clip_rect
P_ ((struct glyph_string
*,
2538 NativeRectangle
*nr
));
2539 extern void note_mouse_highlight
P_ ((struct frame
*, int, int));
2540 extern void x_clear_window_mouse_face
P_ ((struct window
*));
2541 extern void cancel_mouse_face
P_ ((struct frame
*));
2543 extern void handle_tool_bar_click
P_ ((struct frame
*,
2544 int, int, int, unsigned int));
2546 /* msdos.c defines its own versions of these functions. */
2547 extern int clear_mouse_face
P_ ((Display_Info
*));
2548 extern void show_mouse_face
P_ ((Display_Info
*, enum draw_glyphs_face
));
2549 extern int cursor_in_mouse_face_p
P_ ((struct window
*w
));
2551 extern void expose_frame
P_ ((struct frame
*, int, int, int, int));
2552 extern int x_intersect_rectangles
P_ ((XRectangle
*, XRectangle
*,
2556 /* Defined in sysdep.c */
2558 void get_frame_size
P_ ((int *, int *));
2559 void request_sigio
P_ ((void));
2560 void unrequest_sigio
P_ ((void));
2561 int tabs_safe_p
P_ ((void));
2562 void init_baud_rate
P_ ((void));
2563 void init_sigio
P_ ((int));
2565 /* Defined in xfaces.c */
2567 #ifdef HAVE_X_WINDOWS
2568 void x_free_colors
P_ ((struct frame
*, unsigned long *, int));
2571 void update_face_from_frame_parameter
P_ ((struct frame
*, Lisp_Object
,
2573 Lisp_Object tty_color_name
P_ ((struct frame
*, int));
2574 void clear_face_cache
P_ ((int));
2575 unsigned long load_color
P_ ((struct frame
*, struct face
*, Lisp_Object
,
2576 enum lface_attribute_index
));
2577 void unload_color
P_ ((struct frame
*, unsigned long));
2578 int ascii_face_of_lisp_face
P_ ((struct frame
*, int));
2579 void prepare_face_for_display
P_ ((struct frame
*, struct face
*));
2580 int xstricmp
P_ ((const unsigned char *, const unsigned char *));
2581 int lookup_face
P_ ((struct frame
*, Lisp_Object
*, int, struct face
*));
2582 int lookup_named_face
P_ ((struct frame
*, Lisp_Object
, int));
2583 int smaller_face
P_ ((struct frame
*, int, int));
2584 int face_with_height
P_ ((struct frame
*, int, int));
2585 int lookup_derived_face
P_ ((struct frame
*, Lisp_Object
, int, int));
2586 void init_frame_faces
P_ ((struct frame
*));
2587 void free_frame_faces
P_ ((struct frame
*));
2588 void recompute_basic_faces
P_ ((struct frame
*));
2589 int face_at_buffer_position
P_ ((struct window
*, int, int, int, int *,
2591 int face_at_string_position
P_ ((struct window
*, Lisp_Object
, int, int, int,
2592 int, int *, enum face_id
, int));
2593 int compute_char_face
P_ ((struct frame
*, int, Lisp_Object
));
2594 void free_all_realized_faces
P_ ((Lisp_Object
));
2595 extern Lisp_Object Qforeground_color
, Qbackground_color
;
2596 extern char unspecified_fg
[], unspecified_bg
[];
2597 void free_realized_multibyte_face
P_ ((struct frame
*, int));
2599 /* Defined in xfns.c */
2601 #ifdef HAVE_X_WINDOWS
2602 void gamma_correct
P_ ((struct frame
*, XColor
*));
2605 void gamma_correct
P_ ((struct frame
*, COLORREF
*));
2608 #ifdef HAVE_WINDOW_SYSTEM
2610 void x_kill_gs_process
P_ ((Pixmap
, struct frame
*));
2611 int x_screen_planes
P_ ((struct frame
*));
2612 void x_implicitly_set_name
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
2613 struct image_cache
*make_image_cache
P_ ((void));
2614 void free_image_cache
P_ ((struct frame
*));
2615 void clear_image_cache
P_ ((struct frame
*, int));
2616 void forall_images_in_image_cache
P_ ((struct frame
*,
2617 void (*) P_ ((struct image
*))));
2618 int valid_image_p
P_ ((Lisp_Object
));
2619 void prepare_image_for_display
P_ ((struct frame
*, struct image
*));
2620 int lookup_image
P_ ((struct frame
*, Lisp_Object
));
2622 #ifdef HAVE_X_WINDOWS
2623 unsigned long image_background
P_ ((struct image
*, struct frame
*,
2625 int image_background_transparent
P_ ((struct image
*, struct frame
*,
2627 #endif /* HAVE_X_WINDOWS */
2629 extern Lisp_Object tip_frame
;
2630 extern Window tip_window
;
2631 EXFUN (Fx_show_tip
, 6);
2632 EXFUN (Fx_hide_tip
, 0);
2633 extern void start_hourglass
P_ ((void));
2634 extern void cancel_hourglass
P_ ((void));
2635 extern int display_hourglass_p
;
2637 /* Returns the background color of IMG, calculating one heuristically if
2638 necessary. If non-zero, XIMG is an existing XImage object to use for
2641 #define IMAGE_BACKGROUND(img, f, ximg) \
2642 ((img)->background_valid \
2643 ? (img)->background \
2644 : image_background (img, f, ximg))
2646 /* Returns true if IMG has a `transparent' background, using heuristics
2647 to decide if necessary. If non-zero, MASK is an existing XImage
2648 object to use for the heuristic. */
2650 #define IMAGE_BACKGROUND_TRANSPARENT(img, f, mask) \
2651 ((img)->background_transparent_valid \
2652 ? (img)->background_transparent \
2653 : image_background_transparent (img, f, mask))
2655 #endif /* HAVE_WINDOW_SYSTEM */
2658 /* Defined in xmenu.c */
2660 int popup_activated
P_ ((void));
2662 /* Defined in dispnew.c */
2664 extern int inverse_video
;
2665 extern int required_matrix_width
P_ ((struct window
*));
2666 extern int required_matrix_height
P_ ((struct window
*));
2667 extern Lisp_Object mode_line_string
P_ ((struct window
*, int *, int *,
2669 enum window_part
, int *));
2670 extern Lisp_Object marginal_area_string
P_ ((struct window
*, int *, int *,
2672 enum window_part
, int *));
2673 extern void redraw_frame
P_ ((struct frame
*));
2674 extern void redraw_garbaged_frames
P_ ((void));
2675 extern void cancel_line
P_ ((int, struct frame
*));
2676 extern void init_desired_glyphs
P_ ((struct frame
*));
2677 extern int scroll_frame_lines
P_ ((struct frame
*, int, int, int, int));
2678 extern int direct_output_for_insert
P_ ((int));
2679 extern int direct_output_forward_char
P_ ((int));
2680 extern int update_frame
P_ ((struct frame
*, int, int));
2681 extern int scrolling
P_ ((struct frame
*));
2682 extern void bitch_at_user
P_ ((void));
2683 void adjust_glyphs
P_ ((struct frame
*));
2684 void free_glyphs
P_ ((struct frame
*));
2685 void free_window_matrices
P_ ((struct window
*));
2686 void check_glyph_memory
P_ ((void));
2687 void mirrored_line_dance
P_ ((struct glyph_matrix
*, int, int, int *, char *));
2688 void clear_glyph_matrix
P_ ((struct glyph_matrix
*));
2689 void clear_current_matrices
P_ ((struct frame
*f
));
2690 void clear_desired_matrices
P_ ((struct frame
*));
2691 void shift_glyph_matrix
P_ ((struct window
*, struct glyph_matrix
*,
2693 void rotate_matrix
P_ ((struct glyph_matrix
*, int, int, int));
2694 void increment_matrix_positions
P_ ((struct glyph_matrix
*,
2695 int, int, int, int));
2696 void blank_row
P_ ((struct window
*, struct glyph_row
*, int));
2697 void increment_row_positions
P_ ((struct glyph_row
*, int, int));
2698 void enable_glyph_matrix_rows
P_ ((struct glyph_matrix
*, int, int, int));
2699 void clear_glyph_row
P_ ((struct glyph_row
*));
2700 void prepare_desired_row
P_ ((struct glyph_row
*));
2701 int line_hash_code
P_ ((struct glyph_row
*));
2702 void set_window_update_flags
P_ ((struct window
*, int));
2703 void write_glyphs
P_ ((struct glyph
*, int));
2704 void insert_glyphs
P_ ((struct glyph
*, int));
2705 void redraw_frame
P_ ((struct frame
*));
2706 void redraw_garbaged_frames
P_ ((void));
2707 int scroll_cost
P_ ((struct frame
*, int, int, int));
2708 int direct_output_for_insert
P_ ((int));
2709 int direct_output_forward_char
P_ ((int));
2710 int update_frame
P_ ((struct frame
*, int, int));
2711 void update_single_window
P_ ((struct window
*, int));
2712 int scrolling
P_ ((struct frame
*));
2713 void buffer_posn_from_coords
P_ ((struct window
*, int *, int *,
2715 Lisp_Object
*, struct display_pos
*));
2716 void do_pending_window_change
P_ ((int));
2717 void change_frame_size
P_ ((struct frame
*, int, int, int, int, int));
2718 void bitch_at_user
P_ ((void));
2719 Lisp_Object sit_for
P_ ((int, int, int, int, int));
2720 void init_display
P_ ((void));
2721 void syms_of_display
P_ ((void));
2722 extern Lisp_Object Qredisplay_dont_pause
;
2724 /* Defined in term.c */
2726 extern void ring_bell
P_ ((void));
2727 extern void set_terminal_modes
P_ ((void));
2728 extern void reset_terminal_modes
P_ ((void));
2729 extern void update_begin
P_ ((struct frame
*));
2730 extern void update_end
P_ ((struct frame
*));
2731 extern void set_terminal_window
P_ ((int));
2732 extern void set_scroll_region
P_ ((int, int));
2733 extern void turn_off_insert
P_ ((void));
2734 extern void turn_off_highlight
P_ ((void));
2735 extern void background_highlight
P_ ((void));
2736 extern void clear_frame
P_ ((void));
2737 extern void clear_end_of_line
P_ ((int));
2738 extern void clear_end_of_line_raw
P_ ((int));
2739 extern void delete_glyphs
P_ ((int));
2740 extern void ins_del_lines
P_ ((int, int));
2741 extern int string_cost
P_ ((char *));
2742 extern int per_line_cost
P_ ((char *));
2743 extern void calculate_costs
P_ ((struct frame
*));
2744 extern void set_tty_color_mode
P_ ((struct frame
*, Lisp_Object
));
2745 extern void tty_setup_colors
P_ ((int));
2746 extern void term_init
P_ ((char *));
2747 extern void fatal
P_ ((/* char *, ... */));
2748 void cursor_to
P_ ((int, int));
2749 extern int tty_capable_p
P_ ((struct frame
*, unsigned, unsigned long, unsigned long));
2751 /* Defined in scroll.c */
2753 extern int scrolling_max_lines_saved
P_ ((int, int, int *, int *, int *));
2754 extern int scroll_cost
P_ ((struct frame
*, int, int, int));
2755 extern void do_line_insertion_deletion_costs
P_ ((struct frame
*, char *,
2756 char *, char *, char *,
2757 char *, char *, int));
2758 void scrolling_1
P_ ((struct frame
*, int, int, int, int *, int *, int *,
2761 /* Defined in frame.c */
2763 #ifdef HAVE_WINDOW_SYSTEM
2765 /* Types we might convert a resource string into. */
2775 extern Lisp_Object x_get_arg
P_ ((Display_Info
*, Lisp_Object
,
2776 Lisp_Object
, char *, char *class,
2777 enum resource_types
));
2778 extern Lisp_Object x_frame_get_arg
P_ ((struct frame
*, Lisp_Object
,
2779 Lisp_Object
, char *, char *,
2780 enum resource_types
));
2781 extern Lisp_Object x_frame_get_and_record_arg
P_ ((
2782 struct frame
*, Lisp_Object
,
2783 Lisp_Object
, char *, char *,
2784 enum resource_types
));
2785 extern Lisp_Object x_default_parameter
P_ ((struct frame
*, Lisp_Object
,
2786 Lisp_Object
, Lisp_Object
,
2788 enum resource_types
));
2790 #endif /* HAVE_WINDOW_SYSTEM */
2792 #endif /* not DISPEXTERN_H_INCLUDED */
2794 /* arch-tag: c65c475f-1c1e-4534-8795-990b8509fd65
2795 (do not change this comment) */