1 /* Interface definitions for display code.
2 Copyright (C) 1985, 1993, 1994, 1997, 1998, 1999, 2000, 2001, 2002,
3 2003, 2004, 2005, 2006, 2007, 2008
4 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>. */
23 #ifndef DISPEXTERN_H_INCLUDED
24 #define DISPEXTERN_H_INCLUDED
30 #include <X11/Intrinsic.h>
31 #endif /* USE_X_TOOLKIT */
33 #else /* !HAVE_X_WINDOWS */
35 /* X-related stuff used by non-X gui code. */
39 unsigned short red
, green
, blue
;
44 #endif /* HAVE_X_WINDOWS */
51 typedef struct x_display_info Display_Info
;
52 typedef XImage
* XImagePtr
;
53 typedef XImagePtr XImagePtr_or_DC
;
54 #define NativeRectangle XRectangle
59 typedef struct w32_display_info Display_Info
;
60 typedef XImage
*XImagePtr
;
61 typedef HDC XImagePtr_or_DC
;
66 typedef struct mac_display_info Display_Info
;
67 /* Mac equivalent of XImage. */
68 typedef Pixmap XImagePtr
;
69 typedef XImagePtr XImagePtr_or_DC
;
72 #ifndef NativeRectangle
73 #define NativeRectangle int
76 /* Structure forward declarations. Some are here because function
77 prototypes below reference structure types before their definition
78 in this file. Some are here because not every file including
79 dispextern.h also includes frame.h and windows.h. */
89 /* Values returned from coordinates_in_window. */
105 /* Number of bits allocated to store fringe bitmap numbers. */
106 #define FRINGE_ID_BITS 16
110 /***********************************************************************
112 ***********************************************************************/
114 /* If GLYPH_DEBUG is non-zero, additional checks are activated. Turn
115 it off by defining the macro GLYPH_DEBUG to zero. */
118 #define GLYPH_DEBUG 0
121 /* If XASSERTS is non-zero, additional consistency checks are activated.
122 Turn it off by defining the macro XASSERTS to zero. */
128 /* Macros to include code only if GLYPH_DEBUG != 0. */
131 #define IF_DEBUG(X) X
133 #define IF_DEBUG(X) (void) 0
137 #define xassert(X) do {if (!(X)) abort ();} while (0)
139 #define xassert(X) (void) 0
142 /* Macro for displaying traces of redisplay. If Emacs was compiled
143 with GLYPH_DEBUG != 0, the variable trace_redisplay_p can be set to
144 a non-zero value in debugging sessions to activate traces. */
148 extern int trace_redisplay_p
;
152 if (trace_redisplay_p) \
157 #else /* GLYPH_DEBUG == 0 */
159 #define TRACE(X) (void) 0
161 #endif /* GLYPH_DEBUG == 0 */
165 /***********************************************************************
167 ***********************************************************************/
169 /* Starting with Emacs 20.3, characters from strings and buffers have
170 both a character and a byte position associated with them. The
171 following structure holds such a pair of positions. */
175 /* Character position. */
178 /* Corresponding byte position. */
182 /* Access character and byte position of POS in a functional form. */
184 #define BYTEPOS(POS) (POS).bytepos
185 #define CHARPOS(POS) (POS).charpos
187 /* Set character position of POS to CHARPOS, byte position to BYTEPOS. */
189 #define SET_TEXT_POS(POS, CHARPOS, BYTEPOS) \
190 ((POS).charpos = (CHARPOS), (POS).bytepos = BYTEPOS)
192 /* Increment text position POS. */
194 #define INC_TEXT_POS(POS, MULTIBYTE_P) \
199 INC_POS ((POS).bytepos); \
205 /* Decrement text position POS. */
207 #define DEC_TEXT_POS(POS, MULTIBYTE_P) \
212 DEC_POS ((POS).bytepos); \
218 /* Set text position POS from marker MARKER. */
220 #define SET_TEXT_POS_FROM_MARKER(POS, MARKER) \
221 (CHARPOS (POS) = marker_position ((MARKER)), \
222 BYTEPOS (POS) = marker_byte_position ((MARKER)))
224 /* Set marker MARKER from text position POS. */
226 #define SET_MARKER_FROM_TEXT_POS(MARKER, POS) \
227 set_marker_both ((MARKER), Qnil, CHARPOS ((POS)), BYTEPOS ((POS)))
229 /* Value is non-zero if character and byte positions of POS1 and POS2
232 #define TEXT_POS_EQUAL_P(POS1, POS2) \
233 ((POS1).charpos == (POS2).charpos \
234 && (POS1).bytepos == (POS2).bytepos)
236 /* When rendering glyphs, redisplay scans string or buffer text,
237 overlay strings in that text, and does display table or control
238 character translations. The following structure captures a
239 position taking all this into account. */
243 /* Buffer or string position. */
246 /* If this is a position in an overlay string, overlay_string_index
247 is the index of that overlay string in the sequence of overlay
248 strings at `pos' in the order redisplay processes them. A value
249 < 0 means that this is not a position in an overlay string. */
250 int overlay_string_index
;
252 /* If this is a position in an overlay string, string_pos is the
253 position within that string. */
254 struct text_pos string_pos
;
256 /* If the character at the position above is a control character or
257 has a display table entry, dpvec_index is an index in the display
258 table or control character translation of that character. A
259 value < 0 means this is not a position in such a translation. */
265 /***********************************************************************
267 ***********************************************************************/
269 /* Enumeration of glyph types. Glyph structures contain a type field
270 containing one of the enumerators defined here. */
274 /* Glyph describes a character. */
277 /* Glyph describes a composition sequence. */
280 /* Glyph describes an image. */
283 /* Glyph is a space of fractional width and/or height. */
288 /* Structure describing how to use partial glyphs (images slicing) */
295 unsigned height
: 16;
301 Be extra careful when changing this structure! Esp. make sure that
302 functions producing glyphs, like append_glyph, fill ALL of the
303 glyph structure, and that GLYPH_EQUAL_P compares all
304 display-relevant members of glyphs (not to imply that these are the
305 only things to check when you add a member). */
309 /* Position from which this glyph was drawn. If `object' below is a
310 Lisp string, this is a position in that string. If it is a
311 buffer, this is a position in that buffer. A value of -1
312 together with a null object means glyph is a truncation glyph at
313 the start of a row. */
316 /* Lisp object source of this glyph. Currently either a buffer or
317 a string, if the glyph was produced from characters which came from
318 a buffer or a string; or 0 if the glyph was inserted by redisplay
319 for its own purposes such as padding. */
322 /* Width in pixels. */
325 /* Ascent and descent in pixels. */
326 short ascent
, descent
;
328 /* Vertical offset. If < 0, the glyph is displayed raised, if > 0
329 the glyph is displayed lowered. */
332 /* Which kind of glyph this is---character, image etc. Value
333 should be an enumerator of type enum glyph_type. */
336 /* 1 means this glyph was produced from multibyte text. Zero
337 means it was produced from unibyte text, i.e. charsets aren't
338 applicable, and encoding is not performed. */
339 unsigned multibyte_p
: 1;
341 /* Non-zero means draw a box line at the left or right side of this
342 glyph. This is part of the implementation of the face attribute
344 unsigned left_box_line_p
: 1;
345 unsigned right_box_line_p
: 1;
347 /* Non-zero means this glyph's physical ascent or descent is greater
348 than its logical ascent/descent, i.e. it may potentially overlap
349 glyphs above or below it. */
350 unsigned overlaps_vertically_p
: 1;
352 /* For terminal frames, 1 means glyph is a padding glyph. Padding
353 glyphs are used for characters whose visual shape consists of
354 more than one glyph (e.g. Asian characters). All but the first
355 glyph of such a glyph sequence have the padding_p flag set. This
356 flag is used only to minimize code changes. A better way would
357 probably be to use the width field of glyphs to express padding.
359 For graphic frames, 1 means the pixel width of the glyph in a
360 font is 0, but 1-pixel is padded on displaying for correct cursor
361 displaying. The member `pixel_width' above is set to 1. */
362 unsigned padding_p
: 1;
364 /* 1 means the actual glyph is not available, draw a box instead.
365 This can happen when a font couldn't be loaded, or a character
366 doesn't have a glyph in a font. */
367 unsigned glyph_not_available_p
: 1;
369 #define FACE_ID_BITS 21
371 /* Face of the glyph. This is a realized face ID,
372 an index in the face cache of the frame. */
373 unsigned face_id
: FACE_ID_BITS
;
375 /* Type of font used to display the character glyph. May be used to
376 determine which set of functions to use to obtain font metrics
377 for the glyph. On W32, value should be an enumerator of the type
378 w32_char_font_type. Otherwise it equals FONT_TYPE_UNKNOWN. */
379 unsigned font_type
: 3;
381 struct glyph_slice slice
;
383 /* A union of sub-structures for different glyph types. */
386 /* Character code for character glyphs (type == CHAR_GLYPH). */
389 /* Composition ID for composition glyphs (type == COMPOSITION_GLYPH) */
392 /* Image ID for image glyphs (type == IMAGE_GLYPH). */
395 /* Sub-structure for type == STRETCH_GLYPH. */
398 /* The height of the glyph. */
399 unsigned height
: 16;
401 /* The ascent of the glyph. */
402 unsigned ascent
: 16;
406 /* Used to compare all bit-fields above in one step. */
412 /* Default value of the glyph font_type field. */
414 #define FONT_TYPE_UNKNOWN 0
416 /* Is GLYPH a space? */
418 #define CHAR_GLYPH_SPACE_P(GLYPH) \
419 ((GLYPH).u.ch == SPACEGLYPH && (GLYPH).face_id == DEFAULT_FACE_ID)
421 /* Are glyph slices of glyphs *X and *Y equal */
423 #define GLYPH_SLICE_EQUAL_P(X, Y) \
424 ((X)->slice.x == (Y)->slice.x \
425 && (X)->slice.y == (Y)->slice.y \
426 && (X)->slice.width == (Y)->slice.width \
427 && (X)->slice.height == (Y)->slice.height)
429 /* Are glyphs *X and *Y displayed equal? */
431 #define GLYPH_EQUAL_P(X, Y) \
432 ((X)->type == (Y)->type \
433 && (X)->u.val == (Y)->u.val \
434 && GLYPH_SLICE_EQUAL_P (X, Y) \
435 && (X)->face_id == (Y)->face_id \
436 && (X)->padding_p == (Y)->padding_p \
437 && (X)->left_box_line_p == (Y)->left_box_line_p \
438 && (X)->right_box_line_p == (Y)->right_box_line_p \
439 && (X)->voffset == (Y)->voffset \
440 && (X)->pixel_width == (Y)->pixel_width)
442 /* Are character codes, faces, padding_ps of glyphs *X and *Y equal? */
444 #define GLYPH_CHAR_AND_FACE_EQUAL_P(X, Y) \
445 ((X)->u.ch == (Y)->u.ch \
446 && (X)->face_id == (Y)->face_id \
447 && (X)->padding_p == (Y)->padding_p)
449 /* Fill a character glyph GLYPH. CODE, FACE_ID, PADDING_P correspond
450 to the bits defined for the typedef `GLYPH' in lisp.h. */
452 #define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P) \
455 (GLYPH).u.ch = (CODE); \
456 (GLYPH).face_id = (FACE_ID); \
457 (GLYPH).padding_p = (PADDING_P); \
461 /* Fill a character type glyph GLYPH from a glyph typedef FROM as
462 defined in lisp.h. */
464 #define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM) \
465 SET_CHAR_GLYPH ((GLYPH), \
466 GLYPH_CHAR ((FROM)), \
467 GLYPH_FACE ((FROM)), \
470 /* Construct a glyph code from a character glyph GLYPH. If the
471 character is multibyte, return -1 as we can't use glyph table for a
472 multibyte character. */
474 #define SET_GLYPH_FROM_CHAR_GLYPH(G, GLYPH) \
477 if ((GLYPH).u.ch < 256) \
478 SET_GLYPH ((G), (GLYPH).u.ch, ((GLYPH).face_id)); \
480 SET_GLYPH ((G), -1, 0); \
484 #define GLYPH_INVALID_P(GLYPH) (GLYPH_CHAR (GLYPH) < 0)
486 /* Is GLYPH a padding glyph? */
488 #define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p
493 /***********************************************************************
495 ***********************************************************************/
499 Glyph memory for frame-based redisplay is allocated from the heap
500 in one vector kept in a glyph pool structure which is stored with
501 the frame. The size of the vector is made large enough to cover
502 all windows on the frame.
504 Both frame and window glyph matrices reference memory from a glyph
505 pool in frame-based redisplay.
507 In window-based redisplay, no glyphs pools exist; windows allocate
508 and free their glyph memory themselves. */
512 /* Vector of glyphs allocated from the heap. */
513 struct glyph
*glyphs
;
515 /* Allocated size of `glyphs'. */
518 /* Number of rows and columns in a matrix. */
524 /***********************************************************************
526 ***********************************************************************/
530 Three kinds of glyph matrices exist:
532 1. Frame glyph matrices. These are used for terminal frames whose
533 redisplay needs a view of the whole screen due to limited terminal
534 capabilities. Frame matrices are used only in the update phase
535 of redisplay. They are built in update_frame and not used after
536 the update has been performed.
538 2. Window glyph matrices on frames having frame glyph matrices.
539 Such matrices are sub-matrices of their corresponding frame matrix,
540 i.e. frame glyph matrices and window glyph matrices share the same
541 glyph memory which is allocated in form of a glyph_pool structure.
542 Glyph rows in such a window matrix are slices of frame matrix rows.
544 2. Free-standing window glyph matrices managing their own glyph
545 storage. This form is used in window-based redisplay which
546 includes variable width and height fonts etc.
548 The size of a window's row vector depends on the height of fonts
549 defined on its frame. It is chosen so that the vector is large
550 enough to describe all lines in a window when it is displayed in
551 the smallest possible character size. When new fonts are loaded,
552 or window sizes change, the row vector is adjusted accordingly. */
556 /* The pool from which glyph memory is allocated, if any. This is
557 null for frame matrices and for window matrices managing their
559 struct glyph_pool
*pool
;
561 /* Vector of glyph row structures. The row at nrows - 1 is reserved
562 for the mode line. */
563 struct glyph_row
*rows
;
565 /* Number of elements allocated for the vector rows above. */
568 /* The number of rows used by the window if all lines were displayed
569 with the smallest possible character height. */
572 /* Origin within the frame matrix if this is a window matrix on a
573 frame having a frame matrix. Both values are zero for
574 window-based redisplay. */
575 int matrix_x
, matrix_y
;
577 /* Width and height of the matrix in columns and rows. */
578 int matrix_w
, matrix_h
;
580 /* If this structure describes a window matrix of window W,
581 window_left_col is the value of W->left_col, window_top_line the
582 value of W->top_line, window_height and window_width are width and
583 height of W, as returned by window_box, and window_vscroll is the
584 value of W->vscroll at the time the matrix was last adjusted.
585 Only set for window-based redisplay. */
586 int window_left_col
, window_top_line
;
587 int window_height
, window_width
;
590 /* Number of glyphs reserved for left and right marginal areas when
591 the matrix was last adjusted. */
592 int left_margin_glyphs
, right_margin_glyphs
;
594 /* Flag indicating that scrolling should not be tried in
595 update_window. This flag is set by functions like try_window_id
596 which do their own scrolling. */
597 unsigned no_scrolling_p
: 1;
599 /* Non-zero means window displayed in this matrix has a top mode
601 unsigned header_line_p
: 1;
604 /* A string identifying the method used to display the matrix. */
608 /* The buffer this matrix displays. Set in
609 mark_window_display_accurate_1. */
610 struct buffer
*buffer
;
612 /* Values of BEGV and ZV as of last redisplay. Set in
613 mark_window_display_accurate_1. */
618 /* Check that glyph pointers stored in glyph rows of MATRIX are okay.
619 This aborts if any pointer is found twice. */
622 void check_matrix_pointer_lossage
P_ ((struct glyph_matrix
*));
623 #define CHECK_MATRIX(MATRIX) check_matrix_pointer_lossage ((MATRIX))
625 #define CHECK_MATRIX(MATRIX) (void) 0
630 /***********************************************************************
632 ***********************************************************************/
634 /* Area in window glyph matrix. If values are added or removed, the
635 function mark_object in alloc.c has to be changed. */
646 /* Rows of glyphs in a windows or frame glyph matrix.
648 Each row is partitioned into three areas. The start and end of
649 each area is recorded in a pointer as shown below.
651 +--------------------+-------------+---------------------+
652 | left margin area | text area | right margin area |
653 +--------------------+-------------+---------------------+
655 glyphs[LEFT_MARGIN_AREA] glyphs[RIGHT_MARGIN_AREA]
660 Rows in frame matrices reference glyph memory allocated in a frame
661 glyph pool (see the description of struct glyph_pool). Rows in
662 window matrices on frames having frame matrices reference slices of
663 the glyphs of corresponding rows in the frame matrix.
665 Rows in window matrices on frames having no frame matrices point to
666 glyphs allocated from the heap via xmalloc;
667 glyphs[LEFT_MARGIN_AREA] is the start address of the allocated
668 glyph structure array. */
672 /* Pointers to beginnings of areas. The end of an area A is found at
673 A + 1 in the vector. The last element of the vector is the end
676 Kludge alert: Even if used[TEXT_AREA] == 0, glyphs[TEXT_AREA][0]'s
677 position field is used. It is -1 if this row does not correspond
678 to any text; it is some buffer position if the row corresponds to
679 an empty display line that displays a line end. This is what old
680 redisplay used to do. (Except in code for terminal frames, this
681 kludge is no longer used, I believe. --gerd).
683 See also start, end, displays_text_p and ends_at_zv_p for cleaner
684 ways to do it. The special meaning of positions 0 and -1 will be
685 removed some day, so don't use it in new code. */
686 struct glyph
*glyphs
[1 + LAST_AREA
];
688 /* Number of glyphs actually filled in areas. */
689 short used
[LAST_AREA
];
691 /* Window-relative x and y-position of the top-left corner of this
692 row. If y < 0, this means that eabs (y) pixels of the row are
693 invisible because it is partially visible at the top of a window.
694 If x < 0, this means that eabs (x) pixels of the first glyph of
695 the text area of the row are invisible because the glyph is
696 partially visible. */
699 /* Width of the row in pixels without taking face extension at the
700 end of the row into account, and without counting truncation
701 and continuation glyphs at the end of a row on ttys. */
704 /* Logical ascent/height of this line. The value of ascent is zero
705 and height is 1 on terminal frames. */
708 /* Physical ascent/height of this line. If max_ascent > ascent,
709 this line overlaps the line above it on the display. Otherwise,
710 if max_height > height, this line overlaps the line beneath it. */
711 int phys_ascent
, phys_height
;
713 /* Portion of row that is visible. Partially visible rows may be
714 found at the top and bottom of a window. This is 1 for tty
715 frames. It may be < 0 in case of completely invisible rows. */
718 /* Extra line spacing added after this row. Do not consider this
719 in last row when checking if row is fully visible. */
720 int extra_line_spacing
;
722 /* Hash code. This hash code is available as soon as the row
723 is constructed, i.e. after a call to display_line. */
726 /* First position in this row. This is the text position, including
727 overlay position information etc, where the display of this row
728 started, and can thus be less the position of the first glyph
729 (e.g. due to invisible text or horizontal scrolling). */
730 struct display_pos start
;
732 /* Text position at the end of this row. This is the position after
733 the last glyph on this row. It can be greater than the last
734 glyph position + 1, due to truncation, invisible text etc. In an
735 up-to-date display, this should always be equal to the start
736 position of the next row. */
737 struct display_pos end
;
739 /* Non-zero means the overlay arrow bitmap is on this line.
740 -1 means use default overlay arrow bitmap, else
741 it specifies actual fringe bitmap number. */
742 int overlay_arrow_bitmap
;
744 /* Left fringe bitmap number (enum fringe_bitmap_type). */
745 unsigned left_user_fringe_bitmap
: FRINGE_ID_BITS
;
747 /* Right fringe bitmap number (enum fringe_bitmap_type). */
748 unsigned right_user_fringe_bitmap
: FRINGE_ID_BITS
;
750 /* Left fringe bitmap number (enum fringe_bitmap_type). */
751 unsigned left_fringe_bitmap
: FRINGE_ID_BITS
;
753 /* Right fringe bitmap number (enum fringe_bitmap_type). */
754 unsigned right_fringe_bitmap
: FRINGE_ID_BITS
;
756 /* Face of the left fringe glyph. */
757 unsigned left_user_fringe_face_id
: FACE_ID_BITS
;
759 /* Face of the right fringe glyph. */
760 unsigned right_user_fringe_face_id
: FACE_ID_BITS
;
762 /* Face of the left fringe glyph. */
763 unsigned left_fringe_face_id
: FACE_ID_BITS
;
765 /* Face of the right fringe glyph. */
766 unsigned right_fringe_face_id
: FACE_ID_BITS
;
768 /* 1 means that we must draw the bitmaps of this row. */
769 unsigned redraw_fringe_bitmaps_p
: 1;
771 /* In a desired matrix, 1 means that this row must be updated. In a
772 current matrix, 0 means that the row has been invalidated, i.e.
773 the row's contents do not agree with what is visible on the
775 unsigned enabled_p
: 1;
777 /* 1 means row displays a text line that is truncated on the left or
779 unsigned truncated_on_left_p
: 1;
780 unsigned truncated_on_right_p
: 1;
782 /* 1 means that this row displays a continued line, i.e. it has a
783 continuation mark at the right side. */
784 unsigned continued_p
: 1;
786 /* 0 means that this row does not contain any text, i.e. it is
787 a blank line at the window and buffer end. */
788 unsigned displays_text_p
: 1;
790 /* 1 means that this line ends at ZV. */
791 unsigned ends_at_zv_p
: 1;
793 /* 1 means the face of the last glyph in the text area is drawn to
794 the right end of the window. This flag is used in
795 update_text_area to optimize clearing to the end of the area. */
796 unsigned fill_line_p
: 1;
798 /* Non-zero means display a bitmap on X frames indicating that this
799 line contains no text and ends in ZV. */
800 unsigned indicate_empty_line_p
: 1;
802 /* 1 means this row contains glyphs that overlap each other because
803 of lbearing or rbearing. */
804 unsigned contains_overlapping_glyphs_p
: 1;
806 /* 1 means this row is as wide as the window it is displayed in, including
807 scroll bars, fringes, and internal borders. This also
808 implies that the row doesn't have marginal areas. */
809 unsigned full_width_p
: 1;
811 /* Non-zero means row is a mode or header-line. */
812 unsigned mode_line_p
: 1;
814 /* 1 in a current row means this row is overlapped by another row. */
815 unsigned overlapped_p
: 1;
817 /* 1 means this line ends in the middle of a character consisting
818 of more than one glyph. Some glyphs have been put in this row,
819 the rest are put in rows below this one. */
820 unsigned ends_in_middle_of_char_p
: 1;
822 /* 1 means this line starts in the middle of a character consisting
823 of more than one glyph. Some glyphs have been put in the
824 previous row, the rest are put in this row. */
825 unsigned starts_in_middle_of_char_p
: 1;
827 /* 1 in a current row means this row overlaps others. */
828 unsigned overlapping_p
: 1;
830 /* 1 means some glyphs in this row are displayed in mouse-face. */
831 unsigned mouse_face_p
: 1;
833 /* 1 means this row was ended by a newline from a string. */
834 unsigned ends_in_newline_from_string_p
: 1;
836 /* 1 means this row width is exactly the width of the window, and the
837 final newline character is hidden in the right fringe. */
838 unsigned exact_window_width_line_p
: 1;
840 /* 1 means this row currently shows the cursor in the right fringe. */
841 unsigned cursor_in_fringe_p
: 1;
843 /* 1 means the last glyph in the row is part of an ellipsis. */
844 unsigned ends_in_ellipsis_p
: 1;
846 /* Non-zero means display a bitmap on X frames indicating that this
847 the first line of the buffer. */
848 unsigned indicate_bob_p
: 1;
850 /* Non-zero means display a bitmap on X frames indicating that this
851 the top line of the window, but not start of the buffer. */
852 unsigned indicate_top_line_p
: 1;
854 /* Non-zero means display a bitmap on X frames indicating that this
855 the last line of the buffer. */
856 unsigned indicate_eob_p
: 1;
858 /* Non-zero means display a bitmap on X frames indicating that this
859 the bottom line of the window, but not end of the buffer. */
860 unsigned indicate_bottom_line_p
: 1;
862 /* Continuation lines width at the start of the row. */
863 int continuation_lines_width
;
865 #ifdef HAVE_WINDOW_SYSTEM
866 /* Non-NULL means the current clipping area. This is temporarily
867 set while exposing a region. Coordinates are frame-relative. */
873 /* Get a pointer to row number ROW in matrix MATRIX. If GLYPH_DEBUG
874 is defined to a non-zero value, the function matrix_row checks that
875 we don't try to access rows that are out of bounds. */
878 struct glyph_row
*matrix_row
P_ ((struct glyph_matrix
*, int));
879 #define MATRIX_ROW(MATRIX, ROW) matrix_row ((MATRIX), (ROW))
881 #define MATRIX_ROW(MATRIX, ROW) ((MATRIX)->rows + (ROW))
884 /* Return a pointer to the row reserved for the mode line in MATRIX.
885 Row MATRIX->nrows - 1 is always reserved for the mode line. */
887 #define MATRIX_MODE_LINE_ROW(MATRIX) \
888 ((MATRIX)->rows + (MATRIX)->nrows - 1)
890 /* Return a pointer to the row reserved for the header line in MATRIX.
891 This is always the first row in MATRIX because that's the only
892 way that works in frame-based redisplay. */
894 #define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows
896 /* Return a pointer to first row in MATRIX used for text display. */
898 #define MATRIX_FIRST_TEXT_ROW(MATRIX) \
899 ((MATRIX)->rows->mode_line_p ? (MATRIX)->rows + 1 : (MATRIX)->rows)
901 /* Return a pointer to the first glyph in the text area of a row.
902 MATRIX is the glyph matrix accessed, and ROW is the row index in
905 #define MATRIX_ROW_GLYPH_START(MATRIX, ROW) \
906 (MATRIX_ROW ((MATRIX), (ROW))->glyphs[TEXT_AREA])
908 /* Return the number of used glyphs in the text area of a row. */
910 #define MATRIX_ROW_USED(MATRIX, ROW) \
911 (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA])
913 /* Return the character/ byte position at which the display of ROW
916 #define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->start.pos.charpos)
917 #define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->start.pos.bytepos)
919 /* Return the character/ byte position at which ROW ends. */
921 #define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->end.pos.charpos)
922 #define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->end.pos.bytepos)
924 /* Return the vertical position of ROW in MATRIX. */
926 #define MATRIX_ROW_VPOS(ROW, MATRIX) ((ROW) - (MATRIX)->rows)
928 /* Return the last glyph row + 1 in MATRIX on window W reserved for
929 text. If W has a mode line, the last row in the matrix is reserved
932 #define MATRIX_BOTTOM_TEXT_ROW(MATRIX, W) \
935 - (WINDOW_WANTS_MODELINE_P ((W)) ? 1 : 0))
937 /* Non-zero if the face of the last glyph in ROW's text area has
938 to be drawn to the end of the text area. */
940 #define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)
942 /* Set and query the enabled_p flag of glyph row ROW in MATRIX. */
944 #define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
945 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0)
947 #define MATRIX_ROW_ENABLED_P(MATRIX, ROW) \
948 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p)
950 /* Non-zero if ROW displays text. Value is non-zero if the row is
951 blank but displays a line end. */
953 #define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)
958 #define MR_PARTIALLY_VISIBLE(ROW) \
959 ((ROW)->height != (ROW)->visible_height)
961 #define MR_PARTIALLY_VISIBLE_AT_TOP(W, ROW) \
962 ((ROW)->y < WINDOW_HEADER_LINE_HEIGHT ((W)))
964 #define MR_PARTIALLY_VISIBLE_AT_BOTTOM(W, ROW) \
965 (((ROW)->y + (ROW)->height - (ROW)->extra_line_spacing) \
966 > WINDOW_BOX_HEIGHT_NO_MODE_LINE ((W)))
968 /* Non-zero if ROW is not completely visible in window W. */
970 #define MATRIX_ROW_PARTIALLY_VISIBLE_P(W, ROW) \
971 (MR_PARTIALLY_VISIBLE ((ROW)) \
972 && (MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)) \
973 || MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW))))
977 /* Non-zero if ROW is partially visible at the top of window W. */
979 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW) \
980 (MR_PARTIALLY_VISIBLE ((ROW)) \
981 && MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)))
983 /* Non-zero if ROW is partially visible at the bottom of window W. */
985 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW) \
986 (MR_PARTIALLY_VISIBLE ((ROW)) \
987 && MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW)))
989 /* Return the bottom Y + 1 of ROW. */
991 #define MATRIX_ROW_BOTTOM_Y(ROW) ((ROW)->y + (ROW)->height)
993 /* Is ROW the last visible one in the display described by the
994 iterator structure pointed to by IT?. */
996 #define MATRIX_ROW_LAST_VISIBLE_P(ROW, IT) \
997 (MATRIX_ROW_BOTTOM_Y ((ROW)) >= (IT)->last_visible_y)
999 /* Non-zero if ROW displays a continuation line. */
1001 #define MATRIX_ROW_CONTINUATION_LINE_P(ROW) \
1002 ((ROW)->continuation_lines_width > 0)
1004 /* Non-zero if ROW ends in the middle of a character. This is the
1005 case for continued lines showing only part of a display table entry
1006 or a control char, or an overlay string. */
1008 #define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW) \
1009 ((ROW)->end.dpvec_index > 0 \
1010 || (ROW)->end.overlay_string_index >= 0 \
1011 || (ROW)->ends_in_middle_of_char_p)
1013 /* Non-zero if ROW ends in the middle of an overlay string. */
1015 #define MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P(ROW) \
1016 ((ROW)->end.overlay_string_index >= 0)
1018 /* Non-zero if ROW starts in the middle of a character. See above. */
1020 #define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW) \
1021 ((ROW)->start.dpvec_index > 0 \
1022 || (ROW)->starts_in_middle_of_char_p \
1023 || ((ROW)->start.overlay_string_index >= 0 \
1024 && (ROW)->start.string_pos.charpos > 0))
1026 /* Non-zero means ROW overlaps its predecessor. */
1028 #define MATRIX_ROW_OVERLAPS_PRED_P(ROW) \
1029 ((ROW)->phys_ascent > (ROW)->ascent)
1031 /* Non-zero means ROW overlaps its successor. */
1033 #define MATRIX_ROW_OVERLAPS_SUCC_P(ROW) \
1034 ((ROW)->phys_height - (ROW)->phys_ascent \
1035 > (ROW)->height - (ROW)->ascent)
1037 /* Non-zero means that fonts have been loaded since the last glyph
1038 matrix adjustments. The function redisplay_internal adjusts glyph
1039 matrices when this flag is non-zero. */
1041 extern int fonts_changed_p
;
1043 /* A glyph for a space. */
1045 extern struct glyph space_glyph
;
1047 /* Window being updated by update_window. This is non-null as long as
1048 update_window has not finished, and null otherwise. */
1050 extern struct window
*updated_window
;
1052 /* Glyph row and area updated by update_window_line. */
1054 extern struct glyph_row
*updated_row
;
1055 extern int updated_area
;
1057 /* Non-zero means reading single-character input with prompt so put
1058 cursor on mini-buffer after the prompt. Positive means at end of
1059 text in echo area; negative means at beginning of line. */
1061 extern int cursor_in_echo_area
;
1063 /* Non-zero means last display completed. Zero means it was
1066 extern int display_completed
;
1068 /* Non-zero means redisplay has been performed directly (see also
1069 direct_output_for_insert and direct_output_forward_char), so that
1070 no further updating has to be performed. The function
1071 redisplay_internal checks this flag, and does nothing but reset it
1072 to zero if it is non-zero. */
1074 extern int redisplay_performed_directly_p
;
1076 /* A temporary storage area, including a row of glyphs. Initialized
1077 in xdisp.c. Used for various purposes, as an example see
1078 direct_output_for_insert. */
1080 extern struct glyph_row scratch_glyph_row
;
1084 /************************************************************************
1086 ************************************************************************/
1088 /* Enumeration for overriding/changing the face to use for drawing
1089 glyphs in draw_glyphs. */
1091 enum draw_glyphs_face
1101 #ifdef HAVE_WINDOW_SYSTEM
1103 /* A sequence of glyphs to be drawn in the same face. */
1107 /* X-origin of the string. */
1110 /* Y-origin and y-position of the base line of this string. */
1113 /* The width of the string, not including a face extension. */
1116 /* The width of the string, including a face extension. */
1117 int background_width
;
1119 /* The height of this string. This is the height of the line this
1120 string is drawn in, and can be different from the height of the
1121 font the string is drawn in. */
1124 /* Number of pixels this string overwrites in front of its x-origin.
1125 This number is zero if the string has an lbearing >= 0; it is
1126 -lbearing, if the string has an lbearing < 0. */
1129 /* Number of pixels this string overwrites past its right-most
1130 nominal x-position, i.e. x + width. Zero if the string's
1131 rbearing is <= its nominal width, rbearing - width otherwise. */
1134 /* The frame on which the glyph string is drawn. */
1137 /* The window on which the glyph string is drawn. */
1140 /* X display and window for convenience. */
1144 /* The glyph row for which this string was built. It determines the
1145 y-origin and height of the string. */
1146 struct glyph_row
*row
;
1148 /* The area within row. */
1149 enum glyph_row_area area
;
1151 /* Characters to be drawn, and number of characters. */
1155 /* A face-override for drawing cursors, mouse face and similar. */
1156 enum draw_glyphs_face hl
;
1158 /* Face in which this string is to be drawn. */
1161 /* Font in which this string is to be drawn. */
1164 /* Non-null means this string describes (part of) a composition.
1165 All characters from char2b are drawn composed. */
1166 struct composition
*cmp
;
1168 /* Index of this glyph string's first character in the glyph
1169 definition of CMP. If this is zero, this glyph string describes
1170 the first character of a composition. */
1173 /* 1 means this glyph strings face has to be drawn to the right end
1174 of the window's drawing area. */
1175 unsigned extends_to_end_of_line_p
: 1;
1177 /* 1 means the background of this string has been drawn. */
1178 unsigned background_filled_p
: 1;
1180 /* 1 means glyph string must be drawn with 16-bit functions. */
1181 unsigned two_byte_p
: 1;
1183 /* 1 means that the original font determined for drawing this glyph
1184 string could not be loaded. The member `font' has been set to
1185 the frame's default font in this case. */
1186 unsigned font_not_found_p
: 1;
1188 /* 1 means that the face in which this glyph string is drawn has a
1190 unsigned stippled_p
: 1;
1192 #define OVERLAPS_PRED (1 << 0)
1193 #define OVERLAPS_SUCC (1 << 1)
1194 #define OVERLAPS_BOTH (OVERLAPS_PRED | OVERLAPS_SUCC)
1195 #define OVERLAPS_ERASED_CURSOR (1 << 2)
1196 /* Non-zero means only the foreground of this glyph string must be
1197 drawn, and we should use the physical height of the line this
1198 glyph string appears in as clip rect. If the value is
1199 OVERLAPS_ERASED_CURSOR, the clip rect is restricted to the rect
1200 of the erased cursor. OVERLAPS_PRED and OVERLAPS_SUCC mean we
1201 draw overlaps with the preceding and the succeeding rows,
1203 unsigned for_overlaps
: 3;
1205 /* 1 means that all glyphs in this glyph string has the flag
1206 padding_p set, and thus must be drawn one by one to have 1-pixel
1207 width even though the logical width in the font is zero. */
1208 unsigned padding_p
: 1;
1210 /* The GC to use for drawing this glyph string. */
1211 #if defined(HAVE_X_WINDOWS) || defined(MAC_OS)
1214 #if defined(HAVE_NTGUI)
1219 /* A pointer to the first glyph in the string. This glyph
1220 corresponds to char2b[0]. Needed to draw rectangles if
1221 font_not_found_p is 1. */
1222 struct glyph
*first_glyph
;
1224 /* Image, if any. */
1228 struct glyph_slice slice
;
1230 /* Non-null means the horizontal clipping region starts from the
1231 left edge of *clip_head, and ends with the right edge of
1232 *clip_tail, not including their overhangs. */
1233 struct glyph_string
*clip_head
, *clip_tail
;
1235 /* The current clipping areas. */
1236 NativeRectangle clip
[2];
1238 /* Number of clipping areas. */
1241 int underline_position
;
1243 int underline_thickness
;
1245 struct glyph_string
*next
, *prev
;
1248 #endif /* HAVE_WINDOW_SYSTEM */
1251 /************************************************************************
1253 ************************************************************************/
1255 /* Return the height of the mode line in glyph matrix MATRIX, or zero
1256 if not known. This macro is called under circumstances where
1257 MATRIX might not have been allocated yet. */
1259 #define MATRIX_MODE_LINE_HEIGHT(MATRIX) \
1260 ((MATRIX) && (MATRIX)->rows \
1261 ? MATRIX_MODE_LINE_ROW (MATRIX)->height \
1264 /* Return the height of the header line in glyph matrix MATRIX, or zero
1265 if not known. This macro is called under circumstances where
1266 MATRIX might not have been allocated yet. */
1268 #define MATRIX_HEADER_LINE_HEIGHT(MATRIX) \
1269 ((MATRIX) && (MATRIX)->rows \
1270 ? MATRIX_HEADER_LINE_ROW (MATRIX)->height \
1273 /* Return the desired face id for the mode line of a window, depending
1274 on whether the window is selected or not, or if the window is the
1275 scrolling window for the currently active minibuffer window.
1277 Due to the way display_mode_lines manipulates with the contents of
1278 selected_window, this macro needs three arguments: SELW which is
1279 compared against the current value of selected_window, MBW which is
1280 compared against minibuf_window (if SELW doesn't match), and SCRW
1281 which is compared against minibuf_selected_window (if MBW matches). */
1283 #define CURRENT_MODE_LINE_FACE_ID_3(SELW, MBW, SCRW) \
1284 ((!mode_line_in_non_selected_windows \
1285 || (SELW) == XWINDOW (selected_window) \
1286 || (minibuf_level > 0 \
1287 && !NILP (minibuf_selected_window) \
1288 && (MBW) == XWINDOW (minibuf_window) \
1289 && (SCRW) == XWINDOW (minibuf_selected_window))) \
1290 ? MODE_LINE_FACE_ID \
1291 : MODE_LINE_INACTIVE_FACE_ID)
1294 /* Return the desired face id for the mode line of window W. */
1296 #define CURRENT_MODE_LINE_FACE_ID(W) \
1297 (CURRENT_MODE_LINE_FACE_ID_3((W), XWINDOW (selected_window), (W)))
1299 /* Return the current height of the mode line of window W. If not
1300 known from current_mode_line_height, look at W's current glyph
1301 matrix, or return a default based on the height of the font of the
1302 face `mode-line'. */
1304 #define CURRENT_MODE_LINE_HEIGHT(W) \
1305 (current_mode_line_height >= 0 \
1306 ? current_mode_line_height \
1307 : (MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1308 ? MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1309 : estimate_mode_line_height (XFRAME ((W)->frame), \
1310 CURRENT_MODE_LINE_FACE_ID (W))))
1312 /* Return the current height of the header line of window W. If not
1313 known from current_header_line_height, look at W's current glyph
1314 matrix, or return an estimation based on the height of the font of
1315 the face `header-line'. */
1317 #define CURRENT_HEADER_LINE_HEIGHT(W) \
1318 (current_header_line_height >= 0 \
1319 ? current_header_line_height \
1320 : (MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1321 ? MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1322 : estimate_mode_line_height (XFRAME ((W)->frame), \
1323 HEADER_LINE_FACE_ID)))
1325 /* Return the height of the desired mode line of window W. */
1327 #define DESIRED_MODE_LINE_HEIGHT(W) \
1328 MATRIX_MODE_LINE_HEIGHT ((W)->desired_matrix)
1330 /* Return the height of the desired header line of window W. */
1332 #define DESIRED_HEADER_LINE_HEIGHT(W) \
1333 MATRIX_HEADER_LINE_HEIGHT ((W)->desired_matrix)
1335 /* Value is non-zero if window W wants a mode line. */
1337 #define WINDOW_WANTS_MODELINE_P(W) \
1338 (!MINI_WINDOW_P ((W)) \
1339 && !(W)->pseudo_window_p \
1340 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1341 && BUFFERP ((W)->buffer) \
1342 && !NILP (XBUFFER ((W)->buffer)->mode_line_format) \
1343 && WINDOW_TOTAL_LINES (W) > 1)
1345 /* Value is non-zero if window W wants a header line. */
1347 #define WINDOW_WANTS_HEADER_LINE_P(W) \
1348 (!MINI_WINDOW_P ((W)) \
1349 && !(W)->pseudo_window_p \
1350 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1351 && BUFFERP ((W)->buffer) \
1352 && !NILP (XBUFFER ((W)->buffer)->header_line_format) \
1353 && WINDOW_TOTAL_LINES (W) > 1 + !NILP (XBUFFER ((W)->buffer)->mode_line_format))
1356 /* Return proper value to be used as baseline offset of font that has
1357 ASCENT and DESCENT to draw characters by the font at the vertical
1358 center of the line of frame F.
1360 Here, our task is to find the value of BOFF in the following figure;
1362 -------------------------+-----------+-
1363 -+-+---------+-+ | |
1365 | | | | F_ASCENT F_HEIGHT
1368 | | |-|-+------+-----------|------- baseline
1370 | |---------|-+-+ | |
1372 -+-+---------+-+ F_DESCENT |
1373 -------------------------+-----------+-
1375 -BOFF + DESCENT + (F_HEIGHT - HEIGHT) / 2 = F_DESCENT
1376 BOFF = DESCENT + (F_HEIGHT - HEIGHT) / 2 - F_DESCENT
1377 DESCENT = FONT->descent
1378 HEIGHT = FONT_HEIGHT (FONT)
1379 F_DESCENT = (FRAME_FONT (F)->descent
1380 - F->terminal->output_data.x->baseline_offset)
1381 F_HEIGHT = FRAME_LINE_HEIGHT (F)
1384 #define VCENTER_BASELINE_OFFSET(FONT, F) \
1385 (FONT_DESCENT (FONT) \
1386 + (FRAME_LINE_HEIGHT ((F)) - FONT_HEIGHT ((FONT)) \
1387 + (FRAME_LINE_HEIGHT ((F)) > FONT_HEIGHT ((FONT)))) / 2 \
1388 - (FONT_DESCENT (FRAME_FONT (F)) - FRAME_BASELINE_OFFSET (F)))
1391 /***********************************************************************
1393 ***********************************************************************/
1395 /* Indices of face attributes in Lisp face vectors. Slot zero is the
1398 enum lface_attribute_index
1400 LFACE_FAMILY_INDEX
= 1,
1405 LFACE_UNDERLINE_INDEX
,
1406 LFACE_INVERSE_INDEX
,
1407 LFACE_FOREGROUND_INDEX
,
1408 LFACE_BACKGROUND_INDEX
,
1409 LFACE_STIPPLE_INDEX
,
1410 LFACE_OVERLINE_INDEX
,
1411 LFACE_STRIKE_THROUGH_INDEX
,
1414 LFACE_INHERIT_INDEX
,
1415 LFACE_FONTSET_INDEX
,
1420 /* Box types of faces. */
1424 /* No box around text. */
1427 /* Simple box of specified width and color. Default width is 1, and
1428 default color is the foreground color of the face. */
1431 /* Boxes with 3D shadows. Color equals the background color of the
1432 face. Width is specified. */
1438 /* Structure describing a realized face.
1440 For each Lisp face, 0..N realized faces can exist for different
1441 frames and different charsets. Realized faces are built from Lisp
1442 faces and text properties/overlays by merging faces and adding
1443 unspecified attributes from the `default' face. */
1447 /* The id of this face. The id equals the index of this face in the
1448 vector faces_by_id of its face cache. */
1451 #ifdef HAVE_WINDOW_SYSTEM
1453 /* If non-zero, this is a GC that we can use without modification for
1454 drawing the characters in this face. */
1457 /* Background stipple or bitmap used for this face. This is
1458 an id as returned from load_pixmap. */
1461 #else /* not HAVE_WINDOW_SYSTEM */
1466 #endif /* not HAVE_WINDOW_SYSTEM */
1468 /* Pixel value of foreground color for X frames. Color index
1470 unsigned long foreground
;
1472 /* Pixel value or color index of background color. */
1473 unsigned long background
;
1475 /* Pixel value or color index of underline color. */
1476 unsigned long underline_color
;
1478 /* Pixel value or color index of overlined, strike-through, or box
1480 unsigned long overline_color
;
1481 unsigned long strike_through_color
;
1482 unsigned long box_color
;
1486 /* Fontset ID if for this face's fontset. Non-ASCII faces derived
1487 from the same ASCII face have the same fontset. */
1490 /* Pixmap width and height. */
1491 unsigned int pixmap_w
, pixmap_h
;
1493 /* Non-zero means characters in this face have a box that thickness
1494 around them. If it is negative, the absolute value indicates the
1495 thickness, and the horizontal lines of box (top and bottom) are
1496 drawn inside of characters glyph area. The vertical lines of box
1497 (left and right) are drawn as the same way as the case that this
1498 value is positive. */
1501 /* Type of box drawn. A value of FACE_NO_BOX means no box is drawn
1502 around text in this face. A value of FACE_SIMPLE_BOX means a box
1503 of width box_line_width is drawn in color box_color. A value of
1504 FACE_RAISED_BOX or FACE_SUNKEN_BOX means a 3D box is drawn with
1505 shadow colors derived from the background color of the face. */
1506 enum face_box_type box
;
1508 /* If `box' above specifies a 3D type, 1 means use box_color for
1510 unsigned use_box_color_for_shadows_p
: 1;
1512 /* The Lisp face attributes this face realizes. All attributes
1513 in this vector are non-nil. */
1514 Lisp_Object lface
[LFACE_VECTOR_SIZE
];
1516 /* The hash value of this face. */
1519 /* Non-zero if text in this face should be underlined, overlined,
1520 strike-through or have a box drawn around it. */
1521 unsigned underline_p
: 1;
1522 unsigned overline_p
: 1;
1523 unsigned strike_through_p
: 1;
1525 /* 1 means that the colors specified for this face could not be
1526 loaded, and were replaced by default colors, so they shouldn't be
1528 unsigned foreground_defaulted_p
: 1;
1529 unsigned background_defaulted_p
: 1;
1531 /* 1 means that either no color is specified for underlining or that
1532 the specified color couldn't be loaded. Use the foreground
1533 color when drawing in that case. */
1534 unsigned underline_defaulted_p
: 1;
1536 /* 1 means that either no color is specified for the corresponding
1537 attribute or that the specified color couldn't be loaded.
1538 Use the foreground color when drawing in that case. */
1539 unsigned overline_color_defaulted_p
: 1;
1540 unsigned strike_through_color_defaulted_p
: 1;
1541 unsigned box_color_defaulted_p
: 1;
1543 /* TTY appearances. Blinking is not yet implemented. Colors are
1544 found in `lface' with empty color string meaning the default
1545 color of the TTY. */
1546 unsigned tty_bold_p
: 1;
1547 unsigned tty_dim_p
: 1;
1548 unsigned tty_underline_p
: 1;
1549 unsigned tty_alt_charset_p
: 1;
1550 unsigned tty_reverse_p
: 1;
1551 unsigned tty_blinking_p
: 1;
1553 /* 1 means that colors of this face may not be freed because they
1554 have been copied bitwise from a base face (see
1556 unsigned colors_copied_bitwise_p
: 1;
1558 /* If non-zero, use overstrike (to simulate bold-face). */
1559 unsigned overstrike
: 1;
1561 /* Next and previous face in hash collision list of face cache. */
1562 struct face
*next
, *prev
;
1564 /* If this face is an ASCII face, this points to this face itself.
1565 Otherwise, this points to an ASCII face that has the same
1566 attributes except the font. */
1567 struct face
*ascii_face
;
1569 /* Extra member that a font-driver uses privately. */
1574 /* Color index indicating that face uses a terminal's default color. */
1576 #define FACE_TTY_DEFAULT_COLOR ((unsigned long) -1)
1578 /* Color index indicating that face uses an unknown foreground color. */
1580 #define FACE_TTY_DEFAULT_FG_COLOR ((unsigned long) -2)
1582 /* Color index indicating that face uses an unknown background color. */
1584 #define FACE_TTY_DEFAULT_BG_COLOR ((unsigned long) -3)
1586 /* Non-zero if FACE was realized for unibyte use. */
1588 #define FACE_UNIBYTE_P(FACE) ((FACE)->charset < 0)
1591 /* IDs of important faces known by the C face code. These are the IDs
1592 of the faces for CHARSET_ASCII. */
1598 MODE_LINE_INACTIVE_FACE_ID
,
1601 HEADER_LINE_FACE_ID
,
1607 VERTICAL_BORDER_FACE_ID
,
1608 BASIC_FACE_ID_SENTINEL
1611 #define MAX_FACE_ID ((1 << FACE_ID_BITS) - 1)
1613 /* A cache of realized faces. Each frame has its own cache because
1614 Emacs allows different frame-local face definitions. */
1618 /* Hash table of cached realized faces. */
1619 struct face
**buckets
;
1621 /* Back-pointer to the frame this cache belongs to. */
1624 /* A vector of faces so that faces can be referenced by an ID. */
1625 struct face
**faces_by_id
;
1627 /* The allocated size, and number of used slots of faces_by_id. */
1630 /* Flag indicating that attributes of the `menu' face have been
1632 unsigned menu_face_changed_p
: 1;
1636 /* Prepare face FACE for use on frame F. This must be called before
1637 using X resources of FACE. */
1639 #define PREPARE_FACE_FOR_DISPLAY(F, FACE) \
1640 if ((FACE)->gc == 0) \
1641 prepare_face_for_display ((F), (FACE)); \
1645 /* Return a pointer to the face with ID on frame F, or null if such a
1646 face doesn't exist. */
1648 #define FACE_FROM_ID(F, ID) \
1649 (((unsigned) (ID) < FRAME_FACE_CACHE (F)->used) \
1650 ? FRAME_FACE_CACHE (F)->faces_by_id[ID] \
1653 #ifdef HAVE_WINDOW_SYSTEM
1655 /* Non-zero if FACE is suitable for displaying character CHAR. */
1657 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) \
1658 (ASCII_CHAR_P (CHAR) \
1659 ? (FACE) == (FACE)->ascii_face \
1660 : face_suitable_for_char_p ((FACE), (CHAR)))
1662 /* Return the id of the realized face on frame F that is like the face
1663 with id ID but is suitable for displaying character CHAR.
1664 This macro is only meaningful for multibyte character CHAR. */
1666 #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) \
1667 (ASCII_CHAR_P (CHAR) \
1668 ? (FACE)->ascii_face->id \
1669 : face_for_char ((F), (FACE), (CHAR), (POS), (OBJECT)))
1671 #else /* not HAVE_WINDOW_SYSTEM */
1673 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) 1
1674 #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) ((FACE)->id)
1676 #endif /* not HAVE_WINDOW_SYSTEM */
1678 /* Non-zero means face attributes have been changed since the last
1679 redisplay. Used in redisplay_internal. */
1681 extern int face_change_count
;
1686 /***********************************************************************
1688 ***********************************************************************/
1690 /* Structure used to describe where and how to draw a fringe bitmap.
1691 WHICH is the fringe bitmap to draw. WD and H is the (adjusted)
1692 width and height of the bitmap, DH is the height adjustment (if
1693 bitmap is periodic). X and Y are frame coordinates of the area to
1694 display the bitmap, DY is relative offset of the bitmap into that
1695 area. BX, NX, BY, NY specifies the area to clear if the bitmap
1696 does not fill the entire area. FACE is the fringe face. */
1698 struct draw_fringe_bitmap_params
1700 int which
; /* enum fringe_bitmap_type */
1701 unsigned short *bits
;
1705 unsigned cursor_p
: 1;
1706 unsigned overlay_p
: 1;
1710 #define MAX_FRINGE_BITMAPS (1<<FRINGE_ID_BITS)
1713 /***********************************************************************
1715 ***********************************************************************/
1717 /* Iteration over things to display in current_buffer or in a string.
1719 The iterator handles:
1721 1. Overlay strings (after-string, before-string).
1723 3. Invisible text properties.
1724 4. Selective display.
1725 5. Translation of characters via display tables.
1726 6. Translation of control characters to the forms `\003' or `^C'.
1727 7. `glyph' and `space-width' properties.
1729 Iterators are initialized by calling init_iterator or one of the
1730 equivalent functions below. A call to get_next_display_element
1731 loads the iterator structure with information about what next to
1732 display. A call to set_iterator_to_next increments the iterator's
1735 Characters from overlay strings, display table entries or control
1736 character translations are returned one at a time. For example, if
1737 we have a text of `a\x01' where `a' has a display table definition
1738 of `cd' and the control character is displayed with a leading
1739 arrow, then the iterator will return:
1741 Call Return Source Call next
1742 -----------------------------------------------------------------
1743 next c display table move
1744 next d display table move
1745 next ^ control char move
1746 next A control char move
1748 The same mechanism is also used to return characters for ellipses
1749 displayed at the end of invisible text.
1751 CAVEAT: Under some circumstances, move_.* functions can be called
1752 asynchronously, e.g. when computing a buffer position from an x and
1753 y pixel position. This means that these functions and functions
1754 called from them SHOULD NOT USE xmalloc and alike. See also the
1755 comment at the start of xdisp.c. */
1757 /* Enumeration describing what kind of display element an iterator is
1758 loaded with after a call to get_next_display_element. */
1760 enum display_element_type
1762 /* A normal character. */
1765 /* A composition sequence. */
1771 /* A flexible width and height space. */
1774 /* End of buffer or string. */
1777 /* Truncation glyphs. Never returned by get_next_display_element.
1778 Used to get display information about truncation glyphs via
1782 /* Continuation glyphs. See the comment for IT_TRUNCATION. */
1787 /* An enumerator for each text property that has a meaning for display
1792 AUTO_COMPOSED_PROP_IDX
,
1797 COMPOSITION_PROP_IDX
,
1799 /* Not a property. Used to indicate changes in overlays. */
1815 /* Input sources for fetching characters or data to display.
1816 The input source is found in the `method' field. */
1819 GET_FROM_BUFFER
= 0,
1820 GET_FROM_DISPLAY_VECTOR
,
1821 GET_FROM_COMPOSITION
,
1829 #define IT_STACK_SIZE 4
1833 /* The window in which we iterate over current_buffer (or a string). */
1837 /* The window's frame. */
1840 /* Method to use to load this structure with the next display element. */
1841 enum it_method method
;
1843 /* The next position at which to check for face changes, invisible
1844 text, overlay strings, end of text etc., which see. */
1847 /* Maximum string or buffer position + 1. ZV when iterating over
1851 /* C string to iterate over. Non-null means get characters from
1852 this string, otherwise characters are read from current_buffer
1856 /* Number of characters in the string (s, or it->string) we iterate
1860 /* Start and end of a visible region; -1 if the region is not
1861 visible in the window. */
1862 int region_beg_charpos
, region_end_charpos
;
1864 /* Position at which redisplay end trigger functions should be run. */
1865 int redisplay_end_trigger_charpos
;
1867 /* 1 means multibyte characters are enabled. */
1868 unsigned multibyte_p
: 1;
1870 /* 1 means window has a mode line at its top. */
1871 unsigned header_line_p
: 1;
1873 /* 1 means `string' is the value of a `display' property.
1874 Don't handle some `display' properties in these strings. */
1875 unsigned string_from_display_prop_p
: 1;
1877 /* When METHOD == next_element_from_display_vector,
1878 this is 1 if we're doing an ellipsis. Otherwise meaningless. */
1879 unsigned ellipsis_p
: 1;
1881 /* Display table in effect or null for none. */
1882 struct Lisp_Char_Table
*dp
;
1884 /* Current display table vector to return characters from and its
1885 end. dpvec null means we are not returning characters from a
1886 display table entry; current.dpvec_index gives the current index
1887 into dpvec. This same mechanism is also used to return
1888 characters from translated control characters, i.e. `\003' or
1890 Lisp_Object
*dpvec
, *dpend
;
1892 /* Length in bytes of the char that filled dpvec. A value of zero
1893 means that no such character is involved. */
1896 /* Face id to use for all characters in display vector. -1 if unused. */
1899 /* Face id of the iterator saved in case a glyph from dpvec contains
1900 a face. The face is restored when all glyphs from dpvec have
1904 /* Vector of glyphs for control character translation. The pointer
1905 dpvec is set to ctl_chars when a control character is translated.
1906 This vector is also used for incomplete multibyte character
1907 translation (e.g \222\244). Such a character is at most 4 bytes,
1908 thus we need at most 16 bytes here. */
1909 Lisp_Object ctl_chars
[16];
1911 /* Initial buffer or string position of the iterator, before skipping
1912 over display properties and invisible text. */
1913 struct display_pos start
;
1915 /* Current buffer or string position of the iterator, including
1916 position in overlay strings etc. */
1917 struct display_pos current
;
1919 /* Total number of overlay strings to process. This can be >
1920 OVERLAY_STRING_CHUNK_SIZE. */
1921 int n_overlay_strings
;
1923 /* Vector of overlays to process. Overlay strings are processed
1924 OVERLAY_STRING_CHUNK_SIZE at a time. */
1925 #define OVERLAY_STRING_CHUNK_SIZE 16
1926 Lisp_Object overlay_strings
[OVERLAY_STRING_CHUNK_SIZE
];
1928 /* For each overlay string, the overlay it came from. */
1929 Lisp_Object string_overlays
[OVERLAY_STRING_CHUNK_SIZE
];
1931 /* If non-nil, a Lisp string being processed. If
1932 current.overlay_string_index >= 0, this is an overlay string from
1936 /* If non-nil, we are processing a string that came
1937 from a `display' property given by an overlay. */
1938 Lisp_Object from_overlay
;
1940 /* Stack of saved values. New entries are pushed when we begin to
1941 process an overlay string or a string from a `glyph' property.
1942 Entries are popped when we return to deliver display elements
1943 from what we previously had. */
1944 struct iterator_stack_entry
1952 /* Save values specific to a given method. */
1954 /* method == GET_FROM_IMAGE */
1957 struct it_slice slice
;
1960 /* method == GET_FROM_COMPOSITION */
1964 int cmp_id
, cmp_len
;
1966 /* method == GET_FROM_STRETCH */
1972 /* current text and display positions. */
1973 struct text_pos position
;
1974 struct display_pos current
;
1975 Lisp_Object from_overlay
;
1976 enum glyph_row_area area
;
1977 enum it_method method
;
1978 unsigned multibyte_p
: 1;
1979 unsigned string_from_display_prop_p
: 1;
1980 unsigned display_ellipsis_p
: 1;
1982 /* properties from display property that are reset by another display property. */
1983 Lisp_Object space_width
;
1984 Lisp_Object font_height
;
1987 stack
[IT_STACK_SIZE
];
1989 /* Stack pointer. */
1992 /* -1 means selective display hides everything between a \r and the
1993 next newline; > 0 means hide lines indented more than that value. */
1996 /* An enumeration describing what the next display element is
1997 after a call to get_next_display_element. */
1998 enum display_element_type what
;
2003 /* Setting of buffer-local variable selective-display-ellipsis. */
2004 unsigned selective_display_ellipsis_p
: 1;
2006 /* 1 means control characters are translated into the form `^C'
2007 where the `^' can be replaced by a display table entry. */
2008 unsigned ctl_arrow_p
: 1;
2010 /* 1 means lines are truncated. */
2011 unsigned truncate_lines_p
: 1;
2013 /* Non-zero means that the current face has a box. */
2014 unsigned face_box_p
: 1;
2016 /* Non-null means that the current character is the first in a run
2017 of characters with box face. */
2018 unsigned start_of_box_run_p
: 1;
2020 /* Non-zero means that the current character is the last in a run
2021 of characters with box face. */
2022 unsigned end_of_box_run_p
: 1;
2024 /* 1 means overlay strings at end_charpos have been processed. */
2025 unsigned overlay_strings_at_end_processed_p
: 1;
2027 /* 1 means to ignore overlay strings at current pos, as they have
2028 already been processed. */
2029 unsigned ignore_overlay_strings_at_pos_p
: 1;
2031 /* 1 means the actual glyph is not available in the current
2033 unsigned glyph_not_available_p
: 1;
2035 /* 1 means the next line in display_line continues a character
2036 consisting of more than one glyph, and some glyphs of this
2037 character have been put on the previous line. */
2038 unsigned starts_in_middle_of_char_p
: 1;
2040 /* If 1, saved_face_id contains the id of the face in front of text
2041 skipped due to selective display. */
2042 unsigned face_before_selective_p
: 1;
2044 /* If 1, adjust current glyph so it does not increase current row
2045 descent/ascent (line-height property). Reset after this glyph. */
2046 unsigned constrain_row_ascent_descent_p
: 1;
2048 /* The ID of the default face to use. One of DEFAULT_FACE_ID,
2049 MODE_LINE_FACE_ID, etc, depending on what we are displaying. */
2052 /* If what == IT_CHARACTER, character and length in bytes. This is
2053 a character from a buffer or string. It may be different from
2054 the character displayed in case that
2055 unibyte_display_via_language_environment is set.
2057 If what == IT_COMPOSITION, the first component of a composition
2058 and length in bytes of the composition. */
2061 /* If what == IT_COMPOSITION, identification number and length in
2062 chars of a composition. */
2063 int cmp_id
, cmp_len
;
2065 /* The character to display, possibly translated to multibyte
2066 if unibyte_display_via_language_environment is set. This
2067 is set after produce_glyphs has been called. */
2068 int char_to_display
;
2070 /* If what == IT_IMAGE, the id of the image to display. */
2073 /* Values from `slice' property. */
2074 struct it_slice slice
;
2076 /* Value of the `space-width' property, if any; nil if none. */
2077 Lisp_Object space_width
;
2079 /* Computed from the value of the `raise' property. */
2082 /* Value of the `height' property, if any; nil if none. */
2083 Lisp_Object font_height
;
2085 /* Object and position where the current display element came from.
2086 Object can be a Lisp string in case the current display element
2087 comes from an overlay string, or it is buffer. It may also be nil
2088 during mode-line update. Position is a position in object. */
2090 struct text_pos position
;
2092 /* Number of columns per \t. */
2095 /* Width in pixels of truncation and continuation glyphs. */
2096 short truncation_pixel_width
, continuation_pixel_width
;
2098 /* First and last visible x-position in the display area. If window
2099 is hscrolled by n columns, first_visible_x == n * FRAME_COLUMN_WIDTH
2100 (f), and last_visible_x == pixel width of W + first_visible_x. */
2101 int first_visible_x
, last_visible_x
;
2103 /* Last visible y-position + 1 in the display area without a mode
2104 line, if the window has one. */
2107 /* Default amount of additional space in pixels between lines (for
2108 window systems only.) */
2109 int extra_line_spacing
;
2111 /* Max extra line spacing added in this row. */
2112 int max_extra_line_spacing
;
2114 /* Override font height information for this glyph.
2115 Used if override_ascent >= 0. Cleared after this glyph. */
2116 int override_ascent
, override_descent
, override_boff
;
2118 /* If non-null, glyphs are produced in glyph_row with each call to
2120 struct glyph_row
*glyph_row
;
2122 /* The area of glyph_row to which glyphs are added. */
2123 enum glyph_row_area area
;
2125 /* Number of glyphs needed for the last character requested via
2126 produce_glyphs. This is 1 except for tabs. */
2129 /* Width of the display element in pixels. Result of
2133 /* Current, maximum logical, and maximum physical line height
2134 information. Result of produce_glyphs. */
2135 int ascent
, descent
, max_ascent
, max_descent
;
2136 int phys_ascent
, phys_descent
, max_phys_ascent
, max_phys_descent
;
2138 /* Current x pixel position within the display line. This value
2139 does not include the width of continuation lines in front of the
2140 line. The value of current_x is automatically incremented by
2141 pixel_width with each call to produce_glyphs. */
2144 /* Accumulated width of continuation lines. If > 0, this means we
2145 are currently in a continuation line. This is initially zero and
2146 incremented/reset by display_line, move_it_to etc. */
2147 int continuation_lines_width
;
2149 /* Current y-position. Automatically incremented by the height of
2150 glyph_row in move_it_to and display_line. */
2153 /* Vertical matrix position of first text line in window. */
2156 /* Current vertical matrix position, or line number. Automatically
2157 incremented by move_it_to and display_line. */
2160 /* Horizontal matrix position reached in move_it_in_display_line.
2161 Only set there, not in display_line. */
2164 /* Left fringe bitmap number (enum fringe_bitmap_type). */
2165 unsigned left_user_fringe_bitmap
: FRINGE_ID_BITS
;
2167 /* Right fringe bitmap number (enum fringe_bitmap_type). */
2168 unsigned right_user_fringe_bitmap
: FRINGE_ID_BITS
;
2170 /* Face of the left fringe glyph. */
2171 unsigned left_user_fringe_face_id
: FACE_ID_BITS
;
2173 /* Face of the right fringe glyph. */
2174 unsigned right_user_fringe_face_id
: FACE_ID_BITS
;
2178 /* Access to positions of iterator IT. */
2180 #define IT_CHARPOS(IT) CHARPOS ((IT).current.pos)
2181 #define IT_BYTEPOS(IT) BYTEPOS ((IT).current.pos)
2182 #define IT_STRING_CHARPOS(IT) CHARPOS ((IT).current.string_pos)
2183 #define IT_STRING_BYTEPOS(IT) BYTEPOS ((IT).current.string_pos)
2185 /* Test if IT has reached the end of its buffer or string. This will
2186 only work after get_next_display_element has been called. */
2188 #define ITERATOR_AT_END_P(IT) ((IT)->what == IT_EOB)
2190 /* Non-zero means IT is at the end of a line. This is the case if it
2191 is either on a newline or on a carriage return and selective
2192 display hides the rest of the line. */
2194 #define ITERATOR_AT_END_OF_LINE_P(IT) \
2195 ((IT)->what == IT_CHARACTER \
2196 && ((IT)->c == '\n' \
2197 || ((IT)->c == '\r' && (IT)->selective)))
2199 /* Call produce_glyphs or produce_glyphs_hook, if set. Shortcut to
2200 avoid the function call overhead. */
2202 #define PRODUCE_GLYPHS(IT) \
2204 extern int inhibit_free_realized_faces; \
2205 if (FRAME_RIF ((IT)->f) != NULL) \
2206 FRAME_RIF ((IT)->f)->produce_glyphs ((IT)); \
2208 produce_glyphs ((IT)); \
2209 if ((IT)->glyph_row != NULL) \
2210 inhibit_free_realized_faces = 1; \
2213 /* Bit-flags indicating what operation move_it_to should perform. */
2215 enum move_operation_enum
2217 /* Stop if specified x-position is reached. */
2220 /* Stop if specified y-position is reached. */
2223 /* Stop if specified vpos is reached. */
2224 MOVE_TO_VPOS
= 0x04,
2226 /* Stop if specified buffer or string position is reached. */
2232 /***********************************************************************
2233 Window-based redisplay interface
2234 ***********************************************************************/
2236 /* Structure used to describe runs of lines that must be scrolled. */
2240 /* Source and destination y pixel position. */
2241 int desired_y
, current_y
;
2243 /* Source and destination vpos in matrix. */
2244 int desired_vpos
, current_vpos
;
2246 /* Height in pixels, number of glyph rows. */
2251 /* Handlers for setting frame parameters. */
2253 typedef void (*frame_parm_handler
) P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
2256 /* Structure holding system-dependent interface functions needed
2257 for window-based redisplay. */
2259 struct redisplay_interface
2261 /* Handlers for setting frame parameters. */
2262 frame_parm_handler
*frame_parm_handlers
;
2264 /* Produce glyphs/get display metrics for the display element IT is
2266 void (*produce_glyphs
) P_ ((struct it
*it
));
2268 /* Write or insert LEN glyphs from STRING at the nominal output
2270 void (*write_glyphs
) P_ ((struct glyph
*string
, int len
));
2271 void (*insert_glyphs
) P_ ((struct glyph
*start
, int len
));
2273 /* Clear from nominal output position to X. X < 0 means clear
2274 to right end of display. */
2275 void (*clear_end_of_line
) P_ ((int x
));
2277 /* Function to call to scroll the display as described by RUN on
2279 void (*scroll_run_hook
) P_ ((struct window
*w
, struct run
*run
));
2281 /* Function to call after a line in a display has been completely
2282 updated. Used to draw truncation marks and alike. DESIRED_ROW
2283 is the desired row which has been updated. */
2284 void (*after_update_window_line_hook
) P_ ((struct glyph_row
*desired_row
));
2286 /* Function to call before beginning to update window W in
2287 window-based redisplay. */
2288 void (*update_window_begin_hook
) P_ ((struct window
*w
));
2290 /* Function to call after window W has been updated in window-based
2291 redisplay. CURSOR_ON_P non-zero means switch cursor on.
2292 MOUSE_FACE_OVERWRITTEN_P non-zero means that some lines in W
2293 that contained glyphs in mouse-face were overwritten, so we
2294 have to update the mouse highlight. */
2295 void (*update_window_end_hook
) P_ ((struct window
*w
, int cursor_on_p
,
2296 int mouse_face_overwritten_p
));
2298 /* Move cursor to row/column position VPOS/HPOS, pixel coordinates
2299 Y/X. HPOS/VPOS are window-relative row and column numbers and X/Y
2300 are window-relative pixel positions. */
2301 void (*cursor_to
) P_ ((int vpos
, int hpos
, int y
, int x
));
2303 /* Flush the display of frame F. For X, this is XFlush. */
2304 void (*flush_display
) P_ ((struct frame
*f
));
2306 /* Flush the display of frame F if non-NULL. This is called
2307 during redisplay, and should be NULL on systems which flushes
2308 automatically before reading input. */
2309 void (*flush_display_optional
) P_ ((struct frame
*f
));
2311 /* Clear the mouse hightlight in window W, if there is any. */
2312 void (*clear_window_mouse_face
) P_ ((struct window
*w
));
2314 /* Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
2316 void (*get_glyph_overhangs
) P_ ((struct glyph
*glyph
, struct frame
*f
,
2317 int *left
, int *right
));
2319 /* Fix the display of AREA of ROW in window W for overlapping rows.
2320 This function is called from redraw_overlapping_rows after
2321 desired rows have been made current. */
2322 void (*fix_overlapping_area
) P_ ((struct window
*w
, struct glyph_row
*row
,
2323 enum glyph_row_area area
, int));
2325 #ifdef HAVE_WINDOW_SYSTEM
2327 /* Draw a fringe bitmap in window W of row ROW using parameters P. */
2328 void (*draw_fringe_bitmap
) P_ ((struct window
*w
, struct glyph_row
*row
,
2329 struct draw_fringe_bitmap_params
*p
));
2331 /* Define and destroy fringe bitmap no. WHICH. */
2332 void (*define_fringe_bitmap
) P_ ((int which
, unsigned short *bits
,
2334 void (*destroy_fringe_bitmap
) P_ ((int which
));
2336 /* Compute left and right overhang of glyph string S.
2337 A NULL pointer if platform does not support this. */
2338 void (*compute_glyph_string_overhangs
) P_ ((struct glyph_string
*s
));
2340 /* Draw a glyph string S. */
2341 void (*draw_glyph_string
) P_ ((struct glyph_string
*s
));
2343 /* Define cursor CURSOR on frame F. */
2344 void (*define_frame_cursor
) P_ ((struct frame
*f
, Cursor cursor
));
2346 /* Clear the area at (X,Y,WIDTH,HEIGHT) of frame F. */
2347 void (*clear_frame_area
) P_ ((struct frame
*f
, int x
, int y
,
2348 int width
, int height
));
2350 /* Draw specified cursor CURSOR_TYPE of width CURSOR_WIDTH
2351 at row GLYPH_ROW on window W if ON_P is 1. If ON_P is
2352 0, don't draw cursor. If ACTIVE_P is 1, system caret
2353 should track this cursor (when applicable). */
2354 void (*draw_window_cursor
) P_ ((struct window
*w
,
2355 struct glyph_row
*glyph_row
,
2357 int cursor_type
, int cursor_width
,
2358 int on_p
, int active_p
));
2360 /* Draw vertical border for window W from (X,Y0) to (X,Y1). */
2361 void (*draw_vertical_window_border
) P_ ((struct window
*w
,
2362 int x
, int y0
, int y1
));
2364 /* Shift display of frame F to make room for inserted glyphs.
2365 The area at pixel (X,Y) of width WIDTH and height HEIGHT is
2366 shifted right by SHIFT_BY pixels. */
2367 void (*shift_glyphs_for_insert
) P_ ((struct frame
*f
,
2368 int x
, int y
, int width
,
2369 int height
, int shift_by
));
2371 #endif /* HAVE_WINDOW_SYSTEM */
2375 /***********************************************************************
2377 ***********************************************************************/
2379 #ifdef HAVE_WINDOW_SYSTEM
2381 /* Structure forward declarations. */
2386 /* Each image format (JPEG, TIFF, ...) supported is described by
2387 a structure of the type below. */
2391 /* A symbol uniquely identifying the image type, .e.g `jpeg'. */
2394 /* Check that SPEC is a valid image specification for the given
2395 image type. Value is non-zero if SPEC is valid. */
2396 int (* valid_p
) P_ ((Lisp_Object spec
));
2398 /* Load IMG which is used on frame F from information contained in
2399 IMG->spec. Value is non-zero if successful. */
2400 int (* load
) P_ ((struct frame
*f
, struct image
*img
));
2402 /* Free resources of image IMG which is used on frame F. */
2403 void (* free
) P_ ((struct frame
*f
, struct image
*img
));
2405 /* Next in list of all supported image types. */
2406 struct image_type
*next
;
2410 /* Structure describing an image. Specific image formats like XBM are
2411 converted into this form, so that display only has to deal with
2412 this type of image. */
2416 /* The time in seconds at which the image was last displayed. Set
2417 in prepare_image_for_display. */
2418 unsigned long timestamp
;
2420 /* Pixmaps of the image. */
2421 Pixmap pixmap
, mask
;
2423 /* Colors allocated for this image, if any. Allocated via xmalloc. */
2424 unsigned long *colors
;
2427 /* A single `background color' for this image, for the use of anyone that
2428 cares about such a thing. Only valid if the `background_valid' field
2429 is true. This should generally be accessed by calling the accessor
2430 macro `IMAGE_BACKGROUND', which will heuristically calculate a value
2432 unsigned long background
;
2434 /* Foreground and background colors of the frame on which the image
2436 unsigned long frame_foreground
, frame_background
;
2438 /* True if this image has a `transparent' background -- that is, is
2439 uses an image mask. The accessor macro for this is
2440 `IMAGE_BACKGROUND_TRANSPARENT'. */
2441 unsigned background_transparent
: 1;
2443 /* True if the `background' and `background_transparent' fields are
2444 valid, respectively. */
2445 unsigned background_valid
: 1, background_transparent_valid
: 1;
2447 /* Width and height of the image. */
2450 /* These values are used for the rectangles displayed for images
2451 that can't be loaded. */
2452 #define DEFAULT_IMAGE_WIDTH 30
2453 #define DEFAULT_IMAGE_HEIGHT 30
2455 /* Top/left and bottom/right corner pixel of actual image data.
2456 Used by four_corners_best to consider the real image data,
2457 rather than looking at the optional image margin. */
2459 #define TOP_CORNER 0
2460 #define LEFT_CORNER 1
2461 #define BOT_CORNER 2
2462 #define RIGHT_CORNER 3
2464 /* Percent of image height used as ascent. A value of
2465 CENTERED_IMAGE_ASCENT means draw the image centered on the
2468 #define DEFAULT_IMAGE_ASCENT 50
2469 #define CENTERED_IMAGE_ASCENT -1
2471 /* Lisp specification of this image. */
2474 /* List of "references" followed to build the image.
2475 Typically will just contain the name of the image file.
2476 Used to allow fine-grained cache flushing. */
2477 Lisp_Object dependencies
;
2479 /* Relief to draw around the image. */
2482 /* Optional margins around the image. This includes the relief. */
2483 int hmargin
, vmargin
;
2485 /* Reference to the type of the image. */
2486 struct image_type
*type
;
2488 /* 1 means that loading the image failed. Don't try again. */
2489 unsigned load_failed_p
;
2491 /* A place for image types to store additional data. The member
2492 data.lisp_val is marked during GC, so it's safe to store Lisp data
2493 there. Image types should free this data when their `free'
2494 function is called. */
2499 Lisp_Object lisp_val
;
2502 /* Hash value of image specification to speed up comparisons. */
2505 /* Image id of this image. */
2508 /* Hash collision chain. */
2509 struct image
*next
, *prev
;
2513 /* Cache of images. Each frame has a cache. X frames with the same
2514 x_display_info share their caches. */
2518 /* Hash table of images. */
2519 struct image
**buckets
;
2521 /* Vector mapping image ids to images. */
2522 struct image
**images
;
2524 /* Allocated size of `images'. */
2527 /* Number of images in the cache. */
2530 /* Reference count (number of frames sharing this cache). */
2535 /* Value is a pointer to the image with id ID on frame F, or null if
2536 no image with that id exists. */
2538 #define IMAGE_FROM_ID(F, ID) \
2539 (((ID) >= 0 && (ID) < (FRAME_IMAGE_CACHE (F)->used)) \
2540 ? FRAME_IMAGE_CACHE (F)->images[ID] \
2543 /* Size of bucket vector of image caches. Should be prime. */
2545 #define IMAGE_CACHE_BUCKETS_SIZE 1001
2547 #endif /* HAVE_WINDOW_SYSTEM */
2551 /***********************************************************************
2553 ***********************************************************************/
2555 /* Enumeration defining where to find tool-bar item information in
2556 tool-bar items vectors stored with frames. Each tool-bar item
2557 occupies TOOL_BAR_ITEM_NSLOTS elements in such a vector. */
2559 enum tool_bar_item_idx
2561 /* The key of the tool-bar item. Used to remove items when a binding
2562 for `undefined' is found. */
2565 /* Non-nil if item is enabled. */
2566 TOOL_BAR_ITEM_ENABLED_P
,
2568 /* Non-nil if item is selected (pressed). */
2569 TOOL_BAR_ITEM_SELECTED_P
,
2572 TOOL_BAR_ITEM_CAPTION
,
2574 /* Image(s) to display. This is either a single image specification
2575 or a vector of specifications. */
2576 TOOL_BAR_ITEM_IMAGES
,
2579 TOOL_BAR_ITEM_BINDING
,
2581 /* Button type. One of nil, `:radio' or `:toggle'. */
2587 /* Icon file name of right to left image when an RTL locale is used. */
2588 TOOL_BAR_ITEM_RTL_IMAGE
,
2590 /* Sentinel = number of slots in tool_bar_items occupied by one
2592 TOOL_BAR_ITEM_NSLOTS
2596 /* An enumeration for the different images that can be specified
2597 for a tool-bar item. */
2599 enum tool_bar_item_image
2601 TOOL_BAR_IMAGE_ENABLED_SELECTED
,
2602 TOOL_BAR_IMAGE_ENABLED_DESELECTED
,
2603 TOOL_BAR_IMAGE_DISABLED_SELECTED
,
2604 TOOL_BAR_IMAGE_DISABLED_DESELECTED
2607 /* Margin around tool-bar buttons in pixels. */
2609 extern Lisp_Object Vtool_bar_button_margin
;
2611 /* Thickness of relief to draw around tool-bar buttons. */
2613 extern EMACS_INT tool_bar_button_relief
;
2615 /* Default values of the above variables. */
2617 #define DEFAULT_TOOL_BAR_BUTTON_MARGIN 4
2618 #define DEFAULT_TOOL_BAR_BUTTON_RELIEF 1
2620 /* The height in pixels of the default tool-bar images. */
2622 #define DEFAULT_TOOL_BAR_IMAGE_HEIGHT 24
2625 /***********************************************************************
2626 Terminal Capabilities
2627 ***********************************************************************/
2629 /* Each of these is a bit representing a terminal `capability' (bold,
2630 inverse, etc). They are or'd together to specify the set of
2631 capabilities being queried for when calling `tty_capable_p' (which
2632 returns true if the terminal supports all of them). */
2634 #define TTY_CAP_INVERSE 0x01
2635 #define TTY_CAP_UNDERLINE 0x02
2636 #define TTY_CAP_BOLD 0x04
2637 #define TTY_CAP_DIM 0x08
2638 #define TTY_CAP_BLINK 0x10
2639 #define TTY_CAP_ALT_CHARSET 0x20
2642 /***********************************************************************
2644 ***********************************************************************/
2646 /* Defined in xdisp.c */
2648 struct glyph_row
*row_containing_pos
P_ ((struct window
*, int,
2650 struct glyph_row
*, int));
2651 int string_buffer_position
P_ ((struct window
*, Lisp_Object
, int));
2652 int line_bottom_y
P_ ((struct it
*));
2653 int display_prop_intangible_p
P_ ((Lisp_Object
));
2654 void resize_echo_area_exactly
P_ ((void));
2655 int resize_mini_window
P_ ((struct window
*, int));
2656 int try_window
P_ ((Lisp_Object
, struct text_pos
, int));
2657 void window_box
P_ ((struct window
*, int, int *, int *, int *, int *));
2658 int window_box_height
P_ ((struct window
*));
2659 int window_text_bottom_y
P_ ((struct window
*));
2660 int window_box_width
P_ ((struct window
*, int));
2661 int window_box_left
P_ ((struct window
*, int));
2662 int window_box_left_offset
P_ ((struct window
*, int));
2663 int window_box_right
P_ ((struct window
*, int));
2664 int window_box_right_offset
P_ ((struct window
*, int));
2665 void window_box_edges
P_ ((struct window
*, int, int *, int *, int *, int *));
2666 int estimate_mode_line_height
P_ ((struct frame
*, enum face_id
));
2667 void pixel_to_glyph_coords
P_ ((struct frame
*, int, int, int *, int *,
2668 NativeRectangle
*, int));
2669 int glyph_to_pixel_coords
P_ ((struct window
*, int, int, int *, int *));
2670 void remember_mouse_glyph
P_ ((struct frame
*, int, int, NativeRectangle
*));
2672 void mark_window_display_accurate
P_ ((Lisp_Object
, int));
2673 void redisplay_preserve_echo_area
P_ ((int));
2674 int set_cursor_from_row
P_ ((struct window
*, struct glyph_row
*,
2675 struct glyph_matrix
*, int, int, int, int));
2676 void init_iterator
P_ ((struct it
*, struct window
*, int,
2677 int, struct glyph_row
*, enum face_id
));
2678 void init_iterator_to_row_start
P_ ((struct it
*, struct window
*,
2679 struct glyph_row
*));
2680 int get_next_display_element
P_ ((struct it
*));
2681 void set_iterator_to_next
P_ ((struct it
*, int));
2682 void start_display
P_ ((struct it
*, struct window
*, struct text_pos
));
2683 void move_it_to
P_ ((struct it
*, int, int, int, int, int));
2684 void move_it_vertically
P_ ((struct it
*, int));
2685 void move_it_vertically_backward
P_ ((struct it
*, int));
2686 void move_it_by_lines
P_ ((struct it
*, int, int));
2687 void move_it_past_eol
P_ ((struct it
*));
2688 void move_it_in_display_line (struct it
*it
,
2689 EMACS_INT to_charpos
, int to_x
,
2690 enum move_operation_enum op
);
2691 int in_display_vector_p
P_ ((struct it
*));
2692 int frame_mode_line_height
P_ ((struct frame
*));
2693 void highlight_trailing_whitespace
P_ ((struct frame
*, struct glyph_row
*));
2694 extern Lisp_Object Qtool_bar
;
2695 extern Lisp_Object Vshow_trailing_whitespace
;
2696 extern int mode_line_in_non_selected_windows
;
2697 extern int redisplaying_p
;
2698 extern void add_to_log
P_ ((char *, Lisp_Object
, Lisp_Object
));
2699 extern int help_echo_showing_p
;
2700 extern int current_mode_line_height
, current_header_line_height
;
2701 extern Lisp_Object help_echo_string
, help_echo_window
;
2702 extern Lisp_Object help_echo_object
, previous_help_echo_string
;
2703 extern int help_echo_pos
;
2704 extern struct frame
*last_mouse_frame
;
2705 extern int last_tool_bar_item
;
2706 extern Lisp_Object Vmouse_autoselect_window
;
2707 extern int unibyte_display_via_language_environment
;
2709 extern void reseat_at_previous_visible_line_start
P_ ((struct it
*));
2711 extern int calc_pixel_width_or_height
P_ ((double *, struct it
*, Lisp_Object
,
2712 struct font
*, int, int *));
2714 #ifdef HAVE_WINDOW_SYSTEM
2717 extern void dump_glyph_string
P_ ((struct glyph_string
*));
2720 extern void x_get_glyph_overhangs
P_ ((struct glyph
*, struct frame
*,
2722 extern void x_produce_glyphs
P_ ((struct it
*));
2724 extern void x_write_glyphs
P_ ((struct glyph
*, int));
2725 extern void x_insert_glyphs
P_ ((struct glyph
*, int len
));
2726 extern void x_clear_end_of_line
P_ ((int));
2728 extern int x_stretch_cursor_p
;
2729 extern struct cursor_pos output_cursor
;
2731 extern void x_fix_overlapping_area
P_ ((struct window
*, struct glyph_row
*,
2732 enum glyph_row_area
, int));
2733 extern void draw_phys_cursor_glyph
P_ ((struct window
*,
2735 enum draw_glyphs_face
));
2736 extern void get_phys_cursor_geometry
P_ ((struct window
*, struct glyph_row
*,
2737 struct glyph
*, int *, int *, int *));
2738 extern void erase_phys_cursor
P_ ((struct window
*));
2739 extern void display_and_set_cursor
P_ ((struct window
*,
2740 int, int, int, int, int));
2742 extern void set_output_cursor
P_ ((struct cursor_pos
*));
2743 extern void x_cursor_to
P_ ((int, int, int, int));
2745 extern void x_update_cursor
P_ ((struct frame
*, int));
2746 extern void x_clear_cursor
P_ ((struct window
*));
2747 extern void x_draw_vertical_border
P_ ((struct window
*w
));
2749 extern void frame_to_window_pixel_xy
P_ ((struct window
*, int *, int *));
2750 extern int get_glyph_string_clip_rects
P_ ((struct glyph_string
*,
2751 NativeRectangle
*, int));
2752 extern void get_glyph_string_clip_rect
P_ ((struct glyph_string
*,
2753 NativeRectangle
*nr
));
2754 extern Lisp_Object find_hot_spot
P_ ((Lisp_Object
, int, int));
2755 extern void note_mouse_highlight
P_ ((struct frame
*, int, int));
2756 extern void x_clear_window_mouse_face
P_ ((struct window
*));
2757 extern void cancel_mouse_face
P_ ((struct frame
*));
2759 extern void handle_tool_bar_click
P_ ((struct frame
*,
2760 int, int, int, unsigned int));
2762 /* msdos.c defines its own versions of these functions. */
2763 extern int clear_mouse_face
P_ ((Display_Info
*));
2764 extern void show_mouse_face
P_ ((Display_Info
*, enum draw_glyphs_face
));
2765 extern int cursor_in_mouse_face_p
P_ ((struct window
*w
));
2767 extern void expose_frame
P_ ((struct frame
*, int, int, int, int));
2768 extern int x_intersect_rectangles
P_ ((XRectangle
*, XRectangle
*,
2772 /* Defined in fringe.c */
2774 int lookup_fringe_bitmap (Lisp_Object
);
2775 void draw_fringe_bitmap
P_ ((struct window
*, struct glyph_row
*, int));
2776 void draw_row_fringe_bitmaps
P_ ((struct window
*, struct glyph_row
*));
2777 int draw_window_fringes
P_ ((struct window
*, int));
2778 int update_window_fringes
P_ ((struct window
*, int));
2779 void compute_fringe_widths
P_ ((struct frame
*, int));
2782 void w32_init_fringe
P_ ((struct redisplay_interface
*));
2783 void w32_reset_fringes
P_ ((void));
2786 void mac_init_fringe
P_ ((struct redisplay_interface
*));
2789 /* Defined in image.c */
2791 #ifdef HAVE_WINDOW_SYSTEM
2793 extern int x_bitmap_height
P_ ((struct frame
*, int));
2794 extern int x_bitmap_width
P_ ((struct frame
*, int));
2795 extern int x_bitmap_pixmap
P_ ((struct frame
*, int));
2796 extern void x_reference_bitmap
P_ ((struct frame
*, int));
2797 extern int x_create_bitmap_from_data
P_ ((struct frame
*, char *,
2798 unsigned int, unsigned int));
2799 extern int x_create_bitmap_from_file
P_ ((struct frame
*, Lisp_Object
));
2800 #if defined (HAVE_XPM) && defined (HAVE_X_WINDOWS)
2801 extern int x_create_bitmap_from_xpm_data
P_ ((struct frame
*f
, char **bits
));
2803 #ifndef x_destroy_bitmap
2804 extern void x_destroy_bitmap
P_ ((struct frame
*, int));
2806 extern void x_destroy_all_bitmaps
P_ ((Display_Info
*));
2807 extern int x_create_bitmap_mask
P_ ((struct frame
* , int));
2808 extern Lisp_Object x_find_image_file
P_ ((Lisp_Object
));
2810 void x_kill_gs_process
P_ ((Pixmap
, struct frame
*));
2811 struct image_cache
*make_image_cache
P_ ((void));
2812 void free_image_cache
P_ ((struct frame
*));
2813 void clear_image_caches
P_ ((Lisp_Object
));
2814 void mark_image_cache
P_ ((struct image_cache
*));
2815 int valid_image_p
P_ ((Lisp_Object
));
2816 void prepare_image_for_display
P_ ((struct frame
*, struct image
*));
2817 int lookup_image
P_ ((struct frame
*, Lisp_Object
));
2819 unsigned long image_background
P_ ((struct image
*, struct frame
*,
2820 XImagePtr_or_DC ximg
));
2821 int image_background_transparent
P_ ((struct image
*, struct frame
*,
2822 XImagePtr_or_DC mask
));
2824 int image_ascent
P_ ((struct image
*, struct face
*, struct glyph_slice
*));
2828 /* Defined in sysdep.c */
2830 void get_tty_size
P_ ((int, int *, int *));
2831 void request_sigio
P_ ((void));
2832 void unrequest_sigio
P_ ((void));
2833 int tabs_safe_p
P_ ((int));
2834 void init_baud_rate
P_ ((int));
2835 void init_sigio
P_ ((int));
2837 /* Defined in xfaces.c */
2839 #ifdef HAVE_X_WINDOWS
2840 void x_free_colors
P_ ((struct frame
*, unsigned long *, int));
2843 void update_face_from_frame_parameter
P_ ((struct frame
*, Lisp_Object
,
2845 Lisp_Object tty_color_name
P_ ((struct frame
*, int));
2846 void clear_face_cache
P_ ((int));
2847 unsigned long load_color
P_ ((struct frame
*, struct face
*, Lisp_Object
,
2848 enum lface_attribute_index
));
2849 void unload_color
P_ ((struct frame
*, unsigned long));
2850 char *choose_face_font
P_ ((struct frame
*, Lisp_Object
*, Lisp_Object
,
2852 int ascii_face_of_lisp_face
P_ ((struct frame
*, int));
2853 void prepare_face_for_display
P_ ((struct frame
*, struct face
*));
2854 int xstrcasecmp
P_ ((const unsigned char *, const unsigned char *));
2855 int lookup_face
P_ ((struct frame
*, Lisp_Object
*));
2856 int lookup_non_ascii_face
P_ ((struct frame
*, int, struct face
*));
2857 int lookup_named_face
P_ ((struct frame
*, Lisp_Object
, int));
2858 int lookup_basic_face
P_ ((struct frame
*, int));
2859 int smaller_face
P_ ((struct frame
*, int, int));
2860 int face_with_height
P_ ((struct frame
*, int, int));
2861 int lookup_derived_face
P_ ((struct frame
*, Lisp_Object
, int, int));
2862 void init_frame_faces
P_ ((struct frame
*));
2863 void free_frame_faces
P_ ((struct frame
*));
2864 void recompute_basic_faces
P_ ((struct frame
*));
2865 int face_at_buffer_position
P_ ((struct window
*w
, EMACS_INT pos
,
2866 EMACS_INT region_beg
, EMACS_INT region_end
,
2867 EMACS_INT
*endptr
, EMACS_INT limit
,
2869 int face_for_overlay_string
P_ ((struct window
*w
, EMACS_INT pos
,
2870 EMACS_INT region_beg
, EMACS_INT region_end
,
2871 EMACS_INT
*endptr
, EMACS_INT limit
,
2872 int mouse
, Lisp_Object overlay
));
2873 int face_at_string_position
P_ ((struct window
*w
, Lisp_Object string
,
2874 EMACS_INT pos
, EMACS_INT bufpos
,
2875 EMACS_INT region_beg
, EMACS_INT region_end
,
2876 EMACS_INT
*endptr
, enum face_id
, int mouse
));
2877 int merge_faces
P_ ((struct frame
*, Lisp_Object
, int, int));
2878 int compute_char_face
P_ ((struct frame
*, int, Lisp_Object
));
2879 void free_all_realized_faces
P_ ((Lisp_Object
));
2880 void free_realized_face
P_ ((struct frame
*, struct face
*));
2881 extern Lisp_Object Qforeground_color
, Qbackground_color
;
2882 extern Lisp_Object Qframe_set_background_mode
;
2883 extern char unspecified_fg
[], unspecified_bg
[];
2884 extern Lisp_Object split_font_name_into_vector
P_ ((Lisp_Object
));
2885 extern Lisp_Object build_font_name_from_vector
P_ ((Lisp_Object
));
2887 extern Lisp_Object Vface_remapping_alist
;
2889 /* Defined in xfns.c */
2891 #ifdef HAVE_X_WINDOWS
2892 void gamma_correct
P_ ((struct frame
*, XColor
*));
2895 void gamma_correct
P_ ((struct frame
*, COLORREF
*));
2898 void gamma_correct
P_ ((struct frame
*, unsigned long *));
2901 #ifdef HAVE_WINDOW_SYSTEM
2903 int x_screen_planes
P_ ((struct frame
*));
2904 void x_implicitly_set_name
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
2906 extern Lisp_Object tip_frame
;
2907 extern Window tip_window
;
2908 EXFUN (Fx_show_tip
, 6);
2909 EXFUN (Fx_hide_tip
, 0);
2910 extern void start_hourglass
P_ ((void));
2911 extern void cancel_hourglass
P_ ((void));
2912 extern int hourglass_started
P_ ((void));
2913 extern int display_hourglass_p
;
2915 /* Returns the background color of IMG, calculating one heuristically if
2916 necessary. If non-zero, XIMG is an existing XImage object to use for
2919 #define IMAGE_BACKGROUND(img, f, ximg) \
2920 ((img)->background_valid \
2921 ? (img)->background \
2922 : image_background (img, f, ximg))
2924 /* Returns true if IMG has a `transparent' background, using heuristics
2925 to decide if necessary. If non-zero, MASK is an existing XImage
2926 object to use for the heuristic. */
2928 #define IMAGE_BACKGROUND_TRANSPARENT(img, f, mask) \
2929 ((img)->background_transparent_valid \
2930 ? (img)->background_transparent \
2931 : image_background_transparent (img, f, mask))
2933 #endif /* HAVE_WINDOW_SYSTEM */
2936 /* Defined in xmenu.c */
2938 int popup_activated
P_ ((void));
2940 /* Defined in dispnew.c */
2942 extern int inverse_video
;
2943 extern int required_matrix_width
P_ ((struct window
*));
2944 extern int required_matrix_height
P_ ((struct window
*));
2945 extern Lisp_Object buffer_posn_from_coords
P_ ((struct window
*,
2947 struct display_pos
*,
2949 int *, int *, int *, int *));
2950 extern Lisp_Object mode_line_string
P_ ((struct window
*, enum window_part
,
2951 int *, int *, int *,
2953 int *, int *, int *, int *));
2954 extern Lisp_Object marginal_area_string
P_ ((struct window
*, enum window_part
,
2955 int *, int *, int *,
2957 int *, int *, int *, int *));
2958 extern void redraw_frame
P_ ((struct frame
*));
2959 extern void redraw_garbaged_frames
P_ ((void));
2960 extern void cancel_line
P_ ((int, struct frame
*));
2961 extern void init_desired_glyphs
P_ ((struct frame
*));
2962 extern int scroll_frame_lines
P_ ((struct frame
*, int, int, int, int));
2963 extern int direct_output_for_insert
P_ ((int));
2964 extern int direct_output_forward_char
P_ ((int));
2965 extern int update_frame
P_ ((struct frame
*, int, int));
2966 extern int scrolling
P_ ((struct frame
*));
2967 extern void bitch_at_user
P_ ((void));
2968 void adjust_glyphs
P_ ((struct frame
*));
2969 void free_glyphs
P_ ((struct frame
*));
2970 void free_window_matrices
P_ ((struct window
*));
2971 void check_glyph_memory
P_ ((void));
2972 void mirrored_line_dance
P_ ((struct glyph_matrix
*, int, int, int *, char *));
2973 void clear_glyph_matrix
P_ ((struct glyph_matrix
*));
2974 void clear_current_matrices
P_ ((struct frame
*f
));
2975 void clear_desired_matrices
P_ ((struct frame
*));
2976 void shift_glyph_matrix
P_ ((struct window
*, struct glyph_matrix
*,
2978 void rotate_matrix
P_ ((struct glyph_matrix
*, int, int, int));
2979 void increment_matrix_positions
P_ ((struct glyph_matrix
*,
2980 int, int, int, int));
2981 void blank_row
P_ ((struct window
*, struct glyph_row
*, int));
2982 void increment_row_positions
P_ ((struct glyph_row
*, int, int));
2983 void enable_glyph_matrix_rows
P_ ((struct glyph_matrix
*, int, int, int));
2984 void clear_glyph_row
P_ ((struct glyph_row
*));
2985 void prepare_desired_row
P_ ((struct glyph_row
*));
2986 int line_hash_code
P_ ((struct glyph_row
*));
2987 void set_window_update_flags
P_ ((struct window
*, int));
2988 void redraw_frame
P_ ((struct frame
*));
2989 void redraw_garbaged_frames
P_ ((void));
2990 int scroll_cost
P_ ((struct frame
*, int, int, int));
2991 int direct_output_for_insert
P_ ((int));
2992 int direct_output_forward_char
P_ ((int));
2993 int update_frame
P_ ((struct frame
*, int, int));
2994 void update_single_window
P_ ((struct window
*, int));
2995 int scrolling
P_ ((struct frame
*));
2996 void do_pending_window_change
P_ ((int));
2997 void change_frame_size
P_ ((struct frame
*, int, int, int, int, int));
2998 void bitch_at_user
P_ ((void));
2999 void init_display
P_ ((void));
3000 void syms_of_display
P_ ((void));
3001 extern Lisp_Object Qredisplay_dont_pause
;
3002 void spec_glyph_lookup_face
P_ ((struct window
*, GLYPH
*));
3004 /* Defined in terminal.c */
3006 extern void ring_bell
P_ ((struct frame
*));
3007 extern void update_begin
P_ ((struct frame
*));
3008 extern void update_end
P_ ((struct frame
*));
3009 extern void set_terminal_window
P_ ((struct frame
*, int));
3010 extern void cursor_to
P_ ((struct frame
*, int, int));
3011 extern void raw_cursor_to
P_ ((struct frame
*, int, int));
3012 extern void clear_to_end
P_ ((struct frame
*));
3013 extern void clear_frame
P_ ((struct frame
*));
3014 extern void clear_end_of_line
P_ ((struct frame
*, int));
3015 extern void write_glyphs
P_ ((struct frame
*, struct glyph
*, int));
3016 extern void insert_glyphs
P_ ((struct frame
*, struct glyph
*, int));
3017 extern void delete_glyphs
P_ ((struct frame
*, int));
3018 extern void ins_del_lines
P_ ((struct frame
*, int, int));
3020 extern struct terminal
*init_initial_terminal
P_ ((void));
3023 /* Defined in term.c */
3025 extern void tty_set_terminal_modes
P_ ((struct terminal
*));
3026 extern void tty_reset_terminal_modes
P_ ((struct terminal
*));
3027 extern void tty_turn_off_insert
P_ ((struct tty_display_info
*));
3028 extern void tty_turn_off_highlight
P_ ((struct tty_display_info
*));
3029 extern int string_cost
P_ ((char *));
3030 extern int per_line_cost
P_ ((char *));
3031 extern void calculate_costs
P_ ((struct frame
*));
3032 extern void produce_glyphs
P_ ((struct it
*));
3033 extern void produce_special_glyphs
P_ ((struct it
*, enum display_element_type
));
3034 extern int tty_capable_p
P_ ((struct tty_display_info
*, unsigned, unsigned long, unsigned long));
3035 extern void set_tty_color_mode (struct tty_display_info
*, struct frame
*);
3036 extern struct terminal
*get_tty_terminal
P_ ((Lisp_Object
, int));
3037 extern struct terminal
*get_named_tty
P_ ((char *));
3038 EXFUN (Ftty_type
, 1);
3039 extern void create_tty_output
P_ ((struct frame
*));
3040 extern struct terminal
*init_tty
P_ ((char *, char *, int));
3043 /* Defined in scroll.c */
3045 extern int scrolling_max_lines_saved
P_ ((int, int, int *, int *, int *));
3046 extern int scroll_cost
P_ ((struct frame
*, int, int, int));
3047 extern void do_line_insertion_deletion_costs
P_ ((struct frame
*, char *,
3048 char *, char *, char *,
3049 char *, char *, int));
3050 void scrolling_1
P_ ((struct frame
*, int, int, int, int *, int *, int *,
3053 /* Defined in frame.c */
3055 #ifdef HAVE_WINDOW_SYSTEM
3057 /* Types we might convert a resource string into. */
3067 extern Lisp_Object x_get_arg
P_ ((Display_Info
*, Lisp_Object
,
3068 Lisp_Object
, char *, char *class,
3069 enum resource_types
));
3070 extern Lisp_Object x_frame_get_arg
P_ ((struct frame
*, Lisp_Object
,
3071 Lisp_Object
, char *, char *,
3072 enum resource_types
));
3073 extern Lisp_Object x_frame_get_and_record_arg
P_ ((
3074 struct frame
*, Lisp_Object
,
3075 Lisp_Object
, char *, char *,
3076 enum resource_types
));
3077 extern Lisp_Object x_default_parameter
P_ ((struct frame
*, Lisp_Object
,
3078 Lisp_Object
, Lisp_Object
,
3080 enum resource_types
));
3082 #endif /* HAVE_WINDOW_SYSTEM */
3084 #endif /* not DISPEXTERN_H_INCLUDED */
3086 /* arch-tag: c65c475f-1c1e-4534-8795-990b8509fd65
3087 (do not change this comment) */