1 /* Interface definitions for display code.
2 Copyright (C) 1985, 1993, 1994, 1997, 1998, 1999, 2000, 2001, 2002,
3 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
22 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>. */
24 #ifndef DISPEXTERN_H_INCLUDED
25 #define DISPEXTERN_H_INCLUDED
31 #include <X11/Intrinsic.h>
32 #endif /* USE_X_TOOLKIT */
34 #else /* !HAVE_X_WINDOWS */
36 /* X-related stuff used by non-X gui code. */
40 unsigned short red
, green
, blue
;
45 #endif /* HAVE_X_WINDOWS */
52 typedef struct x_display_info Display_Info
;
53 typedef XImage
* XImagePtr
;
54 typedef XImagePtr XImagePtr_or_DC
;
55 #define NativeRectangle XRectangle
60 typedef struct w32_display_info Display_Info
;
61 typedef XImage
*XImagePtr
;
62 typedef HDC XImagePtr_or_DC
;
67 typedef struct mac_display_info Display_Info
;
68 /* Mac equivalent of XImage. */
69 typedef Pixmap XImagePtr
;
70 typedef XImagePtr XImagePtr_or_DC
;
73 #ifndef NativeRectangle
74 #define NativeRectangle int
77 /* Structure forward declarations. Some are here because function
78 prototypes below reference structure types before their definition
79 in this file. Some are here because not every file including
80 dispextern.h also includes frame.h and windows.h. */
90 /* Values returned from coordinates_in_window. */
106 /* Number of bits allocated to store fringe bitmap numbers. */
107 #define FRINGE_ID_BITS 16
111 /***********************************************************************
113 ***********************************************************************/
115 /* If GLYPH_DEBUG is non-zero, additional checks are activated. Turn
116 it off by defining the macro GLYPH_DEBUG to zero. */
119 #define GLYPH_DEBUG 0
122 /* If XASSERTS is non-zero, additional consistency checks are activated.
123 Turn it off by defining the macro XASSERTS to zero. */
129 /* Macros to include code only if GLYPH_DEBUG != 0. */
132 #define IF_DEBUG(X) X
134 #define IF_DEBUG(X) (void) 0
138 #define xassert(X) do {if (!(X)) abort ();} while (0)
140 #define xassert(X) (void) 0
143 /* Macro for displaying traces of redisplay. If Emacs was compiled
144 with GLYPH_DEBUG != 0, the variable trace_redisplay_p can be set to
145 a non-zero value in debugging sessions to activate traces. */
149 extern int trace_redisplay_p
;
153 if (trace_redisplay_p) \
158 #else /* GLYPH_DEBUG == 0 */
160 #define TRACE(X) (void) 0
162 #endif /* GLYPH_DEBUG == 0 */
166 /***********************************************************************
168 ***********************************************************************/
170 /* Starting with Emacs 20.3, characters from strings and buffers have
171 both a character and a byte position associated with them. The
172 following structure holds such a pair of positions. */
176 /* Character position. */
179 /* Corresponding byte position. */
183 /* Access character and byte position of POS in a functional form. */
185 #define BYTEPOS(POS) (POS).bytepos
186 #define CHARPOS(POS) (POS).charpos
188 /* Set character position of POS to CHARPOS, byte position to BYTEPOS. */
190 #define SET_TEXT_POS(POS, CHARPOS, BYTEPOS) \
191 ((POS).charpos = (CHARPOS), (POS).bytepos = BYTEPOS)
193 /* Increment text position POS. */
195 #define INC_TEXT_POS(POS, MULTIBYTE_P) \
200 INC_POS ((POS).bytepos); \
206 /* Decrement text position POS. */
208 #define DEC_TEXT_POS(POS, MULTIBYTE_P) \
213 DEC_POS ((POS).bytepos); \
219 /* Set text position POS from marker MARKER. */
221 #define SET_TEXT_POS_FROM_MARKER(POS, MARKER) \
222 (CHARPOS (POS) = marker_position ((MARKER)), \
223 BYTEPOS (POS) = marker_byte_position ((MARKER)))
225 /* Set marker MARKER from text position POS. */
227 #define SET_MARKER_FROM_TEXT_POS(MARKER, POS) \
228 set_marker_both ((MARKER), Qnil, CHARPOS ((POS)), BYTEPOS ((POS)))
230 /* Value is non-zero if character and byte positions of POS1 and POS2
233 #define TEXT_POS_EQUAL_P(POS1, POS2) \
234 ((POS1).charpos == (POS2).charpos \
235 && (POS1).bytepos == (POS2).bytepos)
237 /* When rendering glyphs, redisplay scans string or buffer text,
238 overlay strings in that text, and does display table or control
239 character translations. The following structure captures a
240 position taking all this into account. */
244 /* Buffer or string position. */
247 /* If this is a position in an overlay string, overlay_string_index
248 is the index of that overlay string in the sequence of overlay
249 strings at `pos' in the order redisplay processes them. A value
250 < 0 means that this is not a position in an overlay string. */
251 int overlay_string_index
;
253 /* If this is a position in an overlay string, string_pos is the
254 position within that string. */
255 struct text_pos string_pos
;
257 /* If the character at the position above is a control character or
258 has a display table entry, dpvec_index is an index in the display
259 table or control character translation of that character. A
260 value < 0 means this is not a position in such a translation. */
266 /***********************************************************************
268 ***********************************************************************/
270 /* Enumeration of glyph types. Glyph structures contain a type field
271 containing one of the enumerators defined here. */
275 /* Glyph describes a character. */
278 /* Glyph describes a composition sequence. */
281 /* Glyph describes an image. */
284 /* Glyph is a space of fractional width and/or height. */
289 /* Structure describing how to use partial glyphs (images slicing) */
296 unsigned height
: 16;
302 Be extra careful when changing this structure! Esp. make sure that
303 functions producing glyphs, like append_glyph, fill ALL of the
304 glyph structure, and that GLYPH_EQUAL_P compares all
305 display-relevant members of glyphs (not to imply that these are the
306 only things to check when you add a member). */
310 /* Position from which this glyph was drawn. If `object' below is a
311 Lisp string, this is a position in that string. If it is a
312 buffer, this is a position in that buffer. A value of -1
313 together with a null object means glyph is a truncation glyph at
314 the start of a row. */
317 /* Lisp object source of this glyph. Currently either a buffer or
318 a string, if the glyph was produced from characters which came from
319 a buffer or a string; or 0 if the glyph was inserted by redisplay
320 for its own purposes such as padding. */
323 /* Width in pixels. */
326 /* Ascent and descent in pixels. */
327 short ascent
, descent
;
329 /* Vertical offset. If < 0, the glyph is displayed raised, if > 0
330 the glyph is displayed lowered. */
333 /* Which kind of glyph this is---character, image etc. Value
334 should be an enumerator of type enum glyph_type. */
337 /* 1 means this glyph was produced from multibyte text. Zero
338 means it was produced from unibyte text, i.e. charsets aren't
339 applicable, and encoding is not performed. */
340 unsigned multibyte_p
: 1;
342 /* Non-zero means draw a box line at the left or right side of this
343 glyph. This is part of the implementation of the face attribute
345 unsigned left_box_line_p
: 1;
346 unsigned right_box_line_p
: 1;
348 /* Non-zero means this glyph's physical ascent or descent is greater
349 than its logical ascent/descent, i.e. it may potentially overlap
350 glyphs above or below it. */
351 unsigned overlaps_vertically_p
: 1;
353 /* 1 means glyph is a padding glyph. Padding glyphs are used for
354 characters whose visual shape consists of more than one glyph
355 (e.g. Asian characters). All but the first glyph of such a glyph
356 sequence have the padding_p flag set. Only used for terminal
357 frames, and there only to minimize code changes. A better way
358 would probably be to use the width field of glyphs to express
360 unsigned padding_p
: 1;
362 /* 1 means the actual glyph is not available, draw a box instead.
363 This can happen when a font couldn't be loaded, or a character
364 doesn't have a glyph in a font. */
365 unsigned glyph_not_available_p
: 1;
367 #define FACE_ID_BITS 21
369 /* Face of the glyph. This is a realized face ID,
370 an index in the face cache of the frame. */
371 unsigned face_id
: FACE_ID_BITS
;
373 /* Type of font used to display the character glyph. May be used to
374 determine which set of functions to use to obtain font metrics
375 for the glyph. On W32, value should be an enumerator of the type
376 w32_char_font_type. Otherwise it equals FONT_TYPE_UNKNOWN. */
377 unsigned font_type
: 3;
379 struct glyph_slice slice
;
381 /* A union of sub-structures for different glyph types. */
384 /* Character code for character glyphs (type == CHAR_GLYPH). */
387 /* Composition ID for composition glyphs (type == COMPOSITION_GLYPH) */
390 /* Image ID for image glyphs (type == IMAGE_GLYPH). */
393 /* Sub-structure for type == STRETCH_GLYPH. */
396 /* The height of the glyph. */
397 unsigned height
: 16;
399 /* The ascent of the glyph. */
400 unsigned ascent
: 16;
404 /* Used to compare all bit-fields above in one step. */
410 /* Default value of the glyph font_type field. */
412 #define FONT_TYPE_UNKNOWN 0
414 /* Is GLYPH a space? */
416 #define CHAR_GLYPH_SPACE_P(GLYPH) \
417 (GLYPH_FROM_CHAR_GLYPH ((GLYPH)) == SPACEGLYPH)
419 /* Are glyph slices of glyphs *X and *Y equal */
421 #define GLYPH_SLICE_EQUAL_P(X, Y) \
422 ((X)->slice.x == (Y)->slice.x \
423 && (X)->slice.y == (Y)->slice.y \
424 && (X)->slice.width == (Y)->slice.width \
425 && (X)->slice.height == (Y)->slice.height)
427 /* Are glyphs *X and *Y displayed equal? */
429 #define GLYPH_EQUAL_P(X, Y) \
430 ((X)->type == (Y)->type \
431 && (X)->u.val == (Y)->u.val \
432 && GLYPH_SLICE_EQUAL_P (X, Y) \
433 && (X)->face_id == (Y)->face_id \
434 && (X)->padding_p == (Y)->padding_p \
435 && (X)->left_box_line_p == (Y)->left_box_line_p \
436 && (X)->right_box_line_p == (Y)->right_box_line_p \
437 && (X)->voffset == (Y)->voffset \
438 && (X)->pixel_width == (Y)->pixel_width)
440 /* Are character codes, faces, padding_ps of glyphs *X and *Y equal? */
442 #define GLYPH_CHAR_AND_FACE_EQUAL_P(X, Y) \
443 ((X)->u.ch == (Y)->u.ch \
444 && (X)->face_id == (Y)->face_id \
445 && (X)->padding_p == (Y)->padding_p)
447 /* Fill a character glyph GLYPH. CODE, FACE_ID, PADDING_P correspond
448 to the bits defined for the typedef `GLYPH' in lisp.h. */
450 #define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P) \
453 (GLYPH).u.ch = (CODE); \
454 (GLYPH).face_id = (FACE_ID); \
455 (GLYPH).padding_p = (PADDING_P); \
459 /* Fill a character type glyph GLYPH from a glyph typedef FROM as
460 defined in lisp.h. */
462 #define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM) \
463 SET_CHAR_GLYPH ((GLYPH), \
464 FAST_GLYPH_CHAR ((FROM)), \
465 FAST_GLYPH_FACE ((FROM)), \
468 /* Construct a glyph code from a character glyph GLYPH. If the
469 character is multibyte, return -1 as we can't use glyph table for a
470 multibyte character. */
472 #define GLYPH_FROM_CHAR_GLYPH(GLYPH) \
473 ((GLYPH).u.ch < 256 \
474 ? ((GLYPH).u.ch | ((GLYPH).face_id << CHARACTERBITS)) \
477 /* Is GLYPH a padding glyph? */
479 #define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p
484 /***********************************************************************
486 ***********************************************************************/
490 Glyph memory for frame-based redisplay is allocated from the heap
491 in one vector kept in a glyph pool structure which is stored with
492 the frame. The size of the vector is made large enough to cover
493 all windows on the frame.
495 Both frame and window glyph matrices reference memory from a glyph
496 pool in frame-based redisplay.
498 In window-based redisplay, no glyphs pools exist; windows allocate
499 and free their glyph memory themselves. */
503 /* Vector of glyphs allocated from the heap. */
504 struct glyph
*glyphs
;
506 /* Allocated size of `glyphs'. */
509 /* Number of rows and columns in a matrix. */
515 /***********************************************************************
517 ***********************************************************************/
521 Three kinds of glyph matrices exist:
523 1. Frame glyph matrices. These are used for terminal frames whose
524 redisplay needs a view of the whole screen due to limited terminal
525 capabilities. Frame matrices are used only in the update phase
526 of redisplay. They are built in update_frame and not used after
527 the update has been performed.
529 2. Window glyph matrices on frames having frame glyph matrices.
530 Such matrices are sub-matrices of their corresponding frame matrix,
531 i.e. frame glyph matrices and window glyph matrices share the same
532 glyph memory which is allocated in form of a glyph_pool structure.
533 Glyph rows in such a window matrix are slices of frame matrix rows.
535 2. Free-standing window glyph matrices managing their own glyph
536 storage. This form is used in window-based redisplay which
537 includes variable width and height fonts etc.
539 The size of a window's row vector depends on the height of fonts
540 defined on its frame. It is chosen so that the vector is large
541 enough to describe all lines in a window when it is displayed in
542 the smallest possible character size. When new fonts are loaded,
543 or window sizes change, the row vector is adjusted accordingly. */
547 /* The pool from which glyph memory is allocated, if any. This is
548 null for frame matrices and for window matrices managing their
550 struct glyph_pool
*pool
;
552 /* Vector of glyph row structures. The row at nrows - 1 is reserved
553 for the mode line. */
554 struct glyph_row
*rows
;
556 /* Number of elements allocated for the vector rows above. */
559 /* The number of rows used by the window if all lines were displayed
560 with the smallest possible character height. */
563 /* Origin within the frame matrix if this is a window matrix on a
564 frame having a frame matrix. Both values are zero for
565 window-based redisplay. */
566 int matrix_x
, matrix_y
;
568 /* Width and height of the matrix in columns and rows. */
569 int matrix_w
, matrix_h
;
571 /* If this structure describes a window matrix of window W,
572 window_left_col is the value of W->left_col, window_top_line the
573 value of W->top_line, window_height and window_width are width and
574 height of W, as returned by window_box, and window_vscroll is the
575 value of W->vscroll at the time the matrix was last adjusted.
576 Only set for window-based redisplay. */
577 int window_left_col
, window_top_line
;
578 int window_height
, window_width
;
581 /* Number of glyphs reserved for left and right marginal areas when
582 the matrix was last adjusted. */
583 int left_margin_glyphs
, right_margin_glyphs
;
585 /* Flag indicating that scrolling should not be tried in
586 update_window. This flag is set by functions like try_window_id
587 which do their own scrolling. */
588 unsigned no_scrolling_p
: 1;
590 /* Non-zero means window displayed in this matrix has a top mode
592 unsigned header_line_p
: 1;
595 /* A string identifying the method used to display the matrix. */
599 /* The buffer this matrix displays. Set in
600 mark_window_display_accurate_1. */
601 struct buffer
*buffer
;
603 /* Values of BEGV and ZV as of last redisplay. Set in
604 mark_window_display_accurate_1. */
609 /* Check that glyph pointers stored in glyph rows of MATRIX are okay.
610 This aborts if any pointer is found twice. */
613 void check_matrix_pointer_lossage
P_ ((struct glyph_matrix
*));
614 #define CHECK_MATRIX(MATRIX) check_matrix_pointer_lossage ((MATRIX))
616 #define CHECK_MATRIX(MATRIX) (void) 0
621 /***********************************************************************
623 ***********************************************************************/
625 /* Area in window glyph matrix. If values are added or removed, the
626 function mark_object in alloc.c has to be changed. */
637 /* Rows of glyphs in a windows or frame glyph matrix.
639 Each row is partitioned into three areas. The start and end of
640 each area is recorded in a pointer as shown below.
642 +--------------------+-------------+---------------------+
643 | left margin area | text area | right margin area |
644 +--------------------+-------------+---------------------+
646 glyphs[LEFT_MARGIN_AREA] glyphs[RIGHT_MARGIN_AREA]
651 Rows in frame matrices reference glyph memory allocated in a frame
652 glyph pool (see the description of struct glyph_pool). Rows in
653 window matrices on frames having frame matrices reference slices of
654 the glyphs of corresponding rows in the frame matrix.
656 Rows in window matrices on frames having no frame matrices point to
657 glyphs allocated from the heap via xmalloc;
658 glyphs[LEFT_MARGIN_AREA] is the start address of the allocated
659 glyph structure array. */
663 /* Pointers to beginnings of areas. The end of an area A is found at
664 A + 1 in the vector. The last element of the vector is the end
667 Kludge alert: Even if used[TEXT_AREA] == 0, glyphs[TEXT_AREA][0]'s
668 position field is used. It is -1 if this row does not correspond
669 to any text; it is some buffer position if the row corresponds to
670 an empty display line that displays a line end. This is what old
671 redisplay used to do. (Except in code for terminal frames, this
672 kludge is no longer used, I believe. --gerd).
674 See also start, end, displays_text_p and ends_at_zv_p for cleaner
675 ways to do it. The special meaning of positions 0 and -1 will be
676 removed some day, so don't use it in new code. */
677 struct glyph
*glyphs
[1 + LAST_AREA
];
679 /* Number of glyphs actually filled in areas. */
680 short used
[LAST_AREA
];
682 /* Window-relative x and y-position of the top-left corner of this
683 row. If y < 0, this means that eabs (y) pixels of the row are
684 invisible because it is partially visible at the top of a window.
685 If x < 0, this means that eabs (x) pixels of the first glyph of
686 the text area of the row are invisible because the glyph is
687 partially visible. */
690 /* Width of the row in pixels without taking face extension at the
691 end of the row into account, and without counting truncation
692 and continuation glyphs at the end of a row on ttys. */
695 /* Logical ascent/height of this line. The value of ascent is zero
696 and height is 1 on terminal frames. */
699 /* Physical ascent/height of this line. If max_ascent > ascent,
700 this line overlaps the line above it on the display. Otherwise,
701 if max_height > height, this line overlaps the line beneath it. */
702 int phys_ascent
, phys_height
;
704 /* Portion of row that is visible. Partially visible rows may be
705 found at the top and bottom of a window. This is 1 for tty
706 frames. It may be < 0 in case of completely invisible rows. */
709 /* Extra line spacing added after this row. Do not consider this
710 in last row when checking if row is fully visible. */
711 int extra_line_spacing
;
713 /* Hash code. This hash code is available as soon as the row
714 is constructed, i.e. after a call to display_line. */
717 /* First position in this row. This is the text position, including
718 overlay position information etc, where the display of this row
719 started, and can thus be less the position of the first glyph
720 (e.g. due to invisible text or horizontal scrolling). */
721 struct display_pos start
;
723 /* Text position at the end of this row. This is the position after
724 the last glyph on this row. It can be greater than the last
725 glyph position + 1, due to truncation, invisible text etc. In an
726 up-to-date display, this should always be equal to the start
727 position of the next row. */
728 struct display_pos end
;
730 /* Non-zero means the overlay arrow bitmap is on this line.
731 -1 means use default overlay arrow bitmap, else
732 it specifies actual fringe bitmap number. */
733 int overlay_arrow_bitmap
;
735 /* Left fringe bitmap number (enum fringe_bitmap_type). */
736 unsigned left_user_fringe_bitmap
: FRINGE_ID_BITS
;
738 /* Right fringe bitmap number (enum fringe_bitmap_type). */
739 unsigned right_user_fringe_bitmap
: FRINGE_ID_BITS
;
741 /* Left fringe bitmap number (enum fringe_bitmap_type). */
742 unsigned left_fringe_bitmap
: FRINGE_ID_BITS
;
744 /* Right fringe bitmap number (enum fringe_bitmap_type). */
745 unsigned right_fringe_bitmap
: FRINGE_ID_BITS
;
747 /* Face of the left fringe glyph. */
748 unsigned left_user_fringe_face_id
: FACE_ID_BITS
;
750 /* Face of the right fringe glyph. */
751 unsigned right_user_fringe_face_id
: FACE_ID_BITS
;
753 /* Face of the left fringe glyph. */
754 unsigned left_fringe_face_id
: FACE_ID_BITS
;
756 /* Face of the right fringe glyph. */
757 unsigned right_fringe_face_id
: FACE_ID_BITS
;
759 /* 1 means that we must draw the bitmaps of this row. */
760 unsigned redraw_fringe_bitmaps_p
: 1;
762 /* In a desired matrix, 1 means that this row must be updated. In a
763 current matrix, 0 means that the row has been invalidated, i.e.
764 the row's contents do not agree with what is visible on the
766 unsigned enabled_p
: 1;
768 /* 1 means row displays a text line that is truncated on the left or
770 unsigned truncated_on_left_p
: 1;
771 unsigned truncated_on_right_p
: 1;
773 /* 1 means that this row displays a continued line, i.e. it has a
774 continuation mark at the right side. */
775 unsigned continued_p
: 1;
777 /* 0 means that this row does not contain any text, i.e. it is
778 a blank line at the window and buffer end. */
779 unsigned displays_text_p
: 1;
781 /* 1 means that this line ends at ZV. */
782 unsigned ends_at_zv_p
: 1;
784 /* 1 means the face of the last glyph in the text area is drawn to
785 the right end of the window. This flag is used in
786 update_text_area to optimize clearing to the end of the area. */
787 unsigned fill_line_p
: 1;
789 /* Non-zero means display a bitmap on X frames indicating that this
790 line contains no text and ends in ZV. */
791 unsigned indicate_empty_line_p
: 1;
793 /* 1 means this row contains glyphs that overlap each other because
794 of lbearing or rbearing. */
795 unsigned contains_overlapping_glyphs_p
: 1;
797 /* 1 means this row is as wide as the window it is displayed in, including
798 scroll bars, fringes, and internal borders. This also
799 implies that the row doesn't have marginal areas. */
800 unsigned full_width_p
: 1;
802 /* Non-zero means row is a mode or header-line. */
803 unsigned mode_line_p
: 1;
805 /* 1 in a current row means this row is overlapped by another row. */
806 unsigned overlapped_p
: 1;
808 /* 1 means this line ends in the middle of a character consisting
809 of more than one glyph. Some glyphs have been put in this row,
810 the rest are put in rows below this one. */
811 unsigned ends_in_middle_of_char_p
: 1;
813 /* 1 means this line starts in the middle of a character consisting
814 of more than one glyph. Some glyphs have been put in the
815 previous row, the rest are put in this row. */
816 unsigned starts_in_middle_of_char_p
: 1;
818 /* 1 in a current row means this row overlaps others. */
819 unsigned overlapping_p
: 1;
821 /* 1 means some glyphs in this row are displayed in mouse-face. */
822 unsigned mouse_face_p
: 1;
824 /* 1 means this row was ended by a newline from a string. */
825 unsigned ends_in_newline_from_string_p
: 1;
827 /* 1 means this row width is exactly the width of the window, and the
828 final newline character is hidden in the right fringe. */
829 unsigned exact_window_width_line_p
: 1;
831 /* 1 means this row currently shows the cursor in the right fringe. */
832 unsigned cursor_in_fringe_p
: 1;
834 /* 1 means the last glyph in the row is part of an ellipsis. */
835 unsigned ends_in_ellipsis_p
: 1;
837 /* Non-zero means display a bitmap on X frames indicating that this
838 the first line of the buffer. */
839 unsigned indicate_bob_p
: 1;
841 /* Non-zero means display a bitmap on X frames indicating that this
842 the top line of the window, but not start of the buffer. */
843 unsigned indicate_top_line_p
: 1;
845 /* Non-zero means display a bitmap on X frames indicating that this
846 the last line of the buffer. */
847 unsigned indicate_eob_p
: 1;
849 /* Non-zero means display a bitmap on X frames indicating that this
850 the bottom line of the window, but not end of the buffer. */
851 unsigned indicate_bottom_line_p
: 1;
853 /* Continuation lines width at the start of the row. */
854 int continuation_lines_width
;
856 #ifdef HAVE_WINDOW_SYSTEM
857 /* Non-NULL means the current clipping area. This is temporarily
858 set while exposing a region. Coordinates are frame-relative. */
864 /* Get a pointer to row number ROW in matrix MATRIX. If GLYPH_DEBUG
865 is defined to a non-zero value, the function matrix_row checks that
866 we don't try to access rows that are out of bounds. */
869 struct glyph_row
*matrix_row
P_ ((struct glyph_matrix
*, int));
870 #define MATRIX_ROW(MATRIX, ROW) matrix_row ((MATRIX), (ROW))
872 #define MATRIX_ROW(MATRIX, ROW) ((MATRIX)->rows + (ROW))
875 /* Return a pointer to the row reserved for the mode line in MATRIX.
876 Row MATRIX->nrows - 1 is always reserved for the mode line. */
878 #define MATRIX_MODE_LINE_ROW(MATRIX) \
879 ((MATRIX)->rows + (MATRIX)->nrows - 1)
881 /* Return a pointer to the row reserved for the header line in MATRIX.
882 This is always the first row in MATRIX because that's the only
883 way that works in frame-based redisplay. */
885 #define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows
887 /* Return a pointer to first row in MATRIX used for text display. */
889 #define MATRIX_FIRST_TEXT_ROW(MATRIX) \
890 ((MATRIX)->rows->mode_line_p ? (MATRIX)->rows + 1 : (MATRIX)->rows)
892 /* Return a pointer to the first glyph in the text area of a row.
893 MATRIX is the glyph matrix accessed, and ROW is the row index in
896 #define MATRIX_ROW_GLYPH_START(MATRIX, ROW) \
897 (MATRIX_ROW ((MATRIX), (ROW))->glyphs[TEXT_AREA])
899 /* Return the number of used glyphs in the text area of a row. */
901 #define MATRIX_ROW_USED(MATRIX, ROW) \
902 (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA])
904 /* Return the character/ byte position at which the display of ROW
907 #define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->start.pos.charpos)
908 #define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->start.pos.bytepos)
910 /* Return the character/ byte position at which ROW ends. */
912 #define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->end.pos.charpos)
913 #define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->end.pos.bytepos)
915 /* Return the vertical position of ROW in MATRIX. */
917 #define MATRIX_ROW_VPOS(ROW, MATRIX) ((ROW) - (MATRIX)->rows)
919 /* Return the last glyph row + 1 in MATRIX on window W reserved for
920 text. If W has a mode line, the last row in the matrix is reserved
923 #define MATRIX_BOTTOM_TEXT_ROW(MATRIX, W) \
926 - (WINDOW_WANTS_MODELINE_P ((W)) ? 1 : 0))
928 /* Non-zero if the face of the last glyph in ROW's text area has
929 to be drawn to the end of the text area. */
931 #define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)
933 /* Set and query the enabled_p flag of glyph row ROW in MATRIX. */
935 #define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
936 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0)
938 #define MATRIX_ROW_ENABLED_P(MATRIX, ROW) \
939 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p)
941 /* Non-zero if ROW displays text. Value is non-zero if the row is
942 blank but displays a line end. */
944 #define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)
949 #define MR_PARTIALLY_VISIBLE(ROW) \
950 ((ROW)->height != (ROW)->visible_height)
952 #define MR_PARTIALLY_VISIBLE_AT_TOP(W, ROW) \
953 ((ROW)->y < WINDOW_HEADER_LINE_HEIGHT ((W)))
955 #define MR_PARTIALLY_VISIBLE_AT_BOTTOM(W, ROW) \
956 (((ROW)->y + (ROW)->height - (ROW)->extra_line_spacing) \
957 > WINDOW_BOX_HEIGHT_NO_MODE_LINE ((W)))
959 /* Non-zero if ROW is not completely visible in window W. */
961 #define MATRIX_ROW_PARTIALLY_VISIBLE_P(W, ROW) \
962 (MR_PARTIALLY_VISIBLE ((ROW)) \
963 && (MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)) \
964 || MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW))))
968 /* Non-zero if ROW is partially visible at the top of window W. */
970 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW) \
971 (MR_PARTIALLY_VISIBLE ((ROW)) \
972 && MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)))
974 /* Non-zero if ROW is partially visible at the bottom of window W. */
976 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW) \
977 (MR_PARTIALLY_VISIBLE ((ROW)) \
978 && MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW)))
980 /* Return the bottom Y + 1 of ROW. */
982 #define MATRIX_ROW_BOTTOM_Y(ROW) ((ROW)->y + (ROW)->height)
984 /* Is ROW the last visible one in the display described by the
985 iterator structure pointed to by IT?. */
987 #define MATRIX_ROW_LAST_VISIBLE_P(ROW, IT) \
988 (MATRIX_ROW_BOTTOM_Y ((ROW)) >= (IT)->last_visible_y)
990 /* Non-zero if ROW displays a continuation line. */
992 #define MATRIX_ROW_CONTINUATION_LINE_P(ROW) \
993 ((ROW)->continuation_lines_width > 0)
995 /* Non-zero if ROW ends in the middle of a character. This is the
996 case for continued lines showing only part of a display table entry
997 or a control char, or an overlay string. */
999 #define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW) \
1000 ((ROW)->end.dpvec_index > 0 \
1001 || (ROW)->end.overlay_string_index >= 0 \
1002 || (ROW)->ends_in_middle_of_char_p)
1004 /* Non-zero if ROW ends in the middle of an overlay string. */
1006 #define MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P(ROW) \
1007 ((ROW)->end.overlay_string_index >= 0)
1009 /* Non-zero if ROW starts in the middle of a character. See above. */
1011 #define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW) \
1012 ((ROW)->start.dpvec_index > 0 \
1013 || (ROW)->starts_in_middle_of_char_p \
1014 || ((ROW)->start.overlay_string_index >= 0 \
1015 && (ROW)->start.string_pos.charpos > 0))
1017 /* Non-zero means ROW overlaps its predecessor. */
1019 #define MATRIX_ROW_OVERLAPS_PRED_P(ROW) \
1020 ((ROW)->phys_ascent > (ROW)->ascent)
1022 /* Non-zero means ROW overlaps its successor. */
1024 #define MATRIX_ROW_OVERLAPS_SUCC_P(ROW) \
1025 ((ROW)->phys_height - (ROW)->phys_ascent \
1026 > (ROW)->height - (ROW)->ascent)
1028 /* Non-zero means that fonts have been loaded since the last glyph
1029 matrix adjustments. The function redisplay_internal adjusts glyph
1030 matrices when this flag is non-zero. */
1032 extern int fonts_changed_p
;
1034 /* A glyph for a space. */
1036 extern struct glyph space_glyph
;
1038 /* Window being updated by update_window. This is non-null as long as
1039 update_window has not finished, and null otherwise. */
1041 extern struct window
*updated_window
;
1043 /* Glyph row and area updated by update_window_line. */
1045 extern struct glyph_row
*updated_row
;
1046 extern int updated_area
;
1048 /* Non-zero means reading single-character input with prompt so put
1049 cursor on mini-buffer after the prompt. Positive means at end of
1050 text in echo area; negative means at beginning of line. */
1052 extern int cursor_in_echo_area
;
1054 /* Non-zero means last display completed. Zero means it was
1057 extern int display_completed
;
1059 /* Non-zero means redisplay has been performed directly (see also
1060 direct_output_for_insert and direct_output_forward_char), so that
1061 no further updating has to be performed. The function
1062 redisplay_internal checks this flag, and does nothing but reset it
1063 to zero if it is non-zero. */
1065 extern int redisplay_performed_directly_p
;
1067 /* A temporary storage area, including a row of glyphs. Initialized
1068 in xdisp.c. Used for various purposes, as an example see
1069 direct_output_for_insert. */
1071 extern struct glyph_row scratch_glyph_row
;
1075 /************************************************************************
1077 ************************************************************************/
1079 /* Enumeration for overriding/changing the face to use for drawing
1080 glyphs in draw_glyphs. */
1082 enum draw_glyphs_face
1092 #ifdef HAVE_WINDOW_SYSTEM
1094 /* A sequence of glyphs to be drawn in the same face. */
1098 /* X-origin of the string. */
1101 /* Y-origin and y-position of the base line of this string. */
1104 /* The width of the string, not including a face extension. */
1107 /* The width of the string, including a face extension. */
1108 int background_width
;
1110 /* The height of this string. This is the height of the line this
1111 string is drawn in, and can be different from the height of the
1112 font the string is drawn in. */
1115 /* Number of pixels this string overwrites in front of its x-origin.
1116 This number is zero if the string has an lbearing >= 0; it is
1117 -lbearing, if the string has an lbearing < 0. */
1120 /* Number of pixels this string overwrites past its right-most
1121 nominal x-position, i.e. x + width. Zero if the string's
1122 rbearing is <= its nominal width, rbearing - width otherwise. */
1125 /* The frame on which the glyph string is drawn. */
1128 /* The window on which the glyph string is drawn. */
1131 /* X display and window for convenience. */
1135 /* The glyph row for which this string was built. It determines the
1136 y-origin and height of the string. */
1137 struct glyph_row
*row
;
1139 /* The area within row. */
1140 enum glyph_row_area area
;
1142 /* Characters to be drawn, and number of characters. */
1146 /* A face-override for drawing cursors, mouse face and similar. */
1147 enum draw_glyphs_face hl
;
1149 /* Face in which this string is to be drawn. */
1152 /* Font in which this string is to be drawn. */
1155 /* Font info for this string. */
1156 struct font_info
*font_info
;
1158 /* Non-null means this string describes (part of) a composition.
1159 All characters from char2b are drawn composed. */
1160 struct composition
*cmp
;
1162 /* Index of this glyph string's first character in the glyph
1163 definition of CMP. If this is zero, this glyph string describes
1164 the first character of a composition. */
1167 /* 1 means this glyph strings face has to be drawn to the right end
1168 of the window's drawing area. */
1169 unsigned extends_to_end_of_line_p
: 1;
1171 /* 1 means the background of this string has been drawn. */
1172 unsigned background_filled_p
: 1;
1174 /* 1 means glyph string must be drawn with 16-bit functions. */
1175 unsigned two_byte_p
: 1;
1177 /* 1 means that the original font determined for drawing this glyph
1178 string could not be loaded. The member `font' has been set to
1179 the frame's default font in this case. */
1180 unsigned font_not_found_p
: 1;
1182 /* 1 means that the face in which this glyph string is drawn has a
1184 unsigned stippled_p
: 1;
1186 #define OVERLAPS_PRED (1 << 0)
1187 #define OVERLAPS_SUCC (1 << 1)
1188 #define OVERLAPS_BOTH (OVERLAPS_PRED | OVERLAPS_SUCC)
1189 #define OVERLAPS_ERASED_CURSOR (1 << 2)
1190 /* Non-zero means only the foreground of this glyph string must be
1191 drawn, and we should use the physical height of the line this
1192 glyph string appears in as clip rect. If the value is
1193 OVERLAPS_ERASED_CURSOR, the clip rect is restricted to the rect
1194 of the erased cursor. OVERLAPS_PRED and OVERLAPS_SUCC mean we
1195 draw overlaps with the preceding and the succeeding rows,
1197 unsigned for_overlaps
: 3;
1199 /* The GC to use for drawing this glyph string. */
1200 #if defined(HAVE_X_WINDOWS) || defined(MAC_OS)
1203 #if defined(HAVE_NTGUI)
1208 /* A pointer to the first glyph in the string. This glyph
1209 corresponds to char2b[0]. Needed to draw rectangles if
1210 font_not_found_p is 1. */
1211 struct glyph
*first_glyph
;
1213 /* Image, if any. */
1217 struct glyph_slice slice
;
1219 /* Non-null means the horizontal clipping region starts from the
1220 left edge of *clip_head, and ends with the right edge of
1221 *clip_tail, not including their overhangs. */
1222 struct glyph_string
*clip_head
, *clip_tail
;
1224 #ifdef USE_FONT_BACKEND
1225 /* The current clipping areas. */
1226 NativeRectangle clip
[2];
1228 /* Number of clipping areas. */
1230 #endif /* USE_FONT_BACKEND */
1232 struct glyph_string
*next
, *prev
;
1235 #endif /* HAVE_WINDOW_SYSTEM */
1238 /************************************************************************
1240 ************************************************************************/
1242 /* Return the height of the mode line in glyph matrix MATRIX, or zero
1243 if not known. This macro is called under circumstances where
1244 MATRIX might not have been allocated yet. */
1246 #define MATRIX_MODE_LINE_HEIGHT(MATRIX) \
1247 ((MATRIX) && (MATRIX)->rows \
1248 ? MATRIX_MODE_LINE_ROW (MATRIX)->height \
1251 /* Return the height of the header line in glyph matrix MATRIX, or zero
1252 if not known. This macro is called under circumstances where
1253 MATRIX might not have been allocated yet. */
1255 #define MATRIX_HEADER_LINE_HEIGHT(MATRIX) \
1256 ((MATRIX) && (MATRIX)->rows \
1257 ? MATRIX_HEADER_LINE_ROW (MATRIX)->height \
1260 /* Return the desired face id for the mode line of a window, depending
1261 on whether the window is selected or not, or if the window is the
1262 scrolling window for the currently active minibuffer window.
1264 Due to the way display_mode_lines manipulates with the contents of
1265 selected_window, this macro needs three arguments: SELW which is
1266 compared against the current value of selected_window, MBW which is
1267 compared against minibuf_window (if SELW doesn't match), and SCRW
1268 which is compared against minibuf_selected_window (if MBW matches). */
1270 #define CURRENT_MODE_LINE_FACE_ID_3(SELW, MBW, SCRW) \
1271 ((!mode_line_in_non_selected_windows \
1272 || (SELW) == XWINDOW (selected_window) \
1273 || (minibuf_level > 0 \
1274 && !NILP (minibuf_selected_window) \
1275 && (MBW) == XWINDOW (minibuf_window) \
1276 && (SCRW) == XWINDOW (minibuf_selected_window))) \
1277 ? MODE_LINE_FACE_ID \
1278 : MODE_LINE_INACTIVE_FACE_ID)
1281 /* Return the desired face id for the mode line of window W. */
1283 #define CURRENT_MODE_LINE_FACE_ID(W) \
1284 (CURRENT_MODE_LINE_FACE_ID_3((W), XWINDOW (selected_window), (W)))
1286 /* Return the current height of the mode line of window W. If not
1287 known from current_mode_line_height, look at W's current glyph
1288 matrix, or return a default based on the height of the font of the
1289 face `mode-line'. */
1291 #define CURRENT_MODE_LINE_HEIGHT(W) \
1292 (current_mode_line_height >= 0 \
1293 ? current_mode_line_height \
1294 : (MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1295 ? MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1296 : estimate_mode_line_height (XFRAME ((W)->frame), \
1297 CURRENT_MODE_LINE_FACE_ID (W))))
1299 /* Return the current height of the header line of window W. If not
1300 known from current_header_line_height, look at W's current glyph
1301 matrix, or return an estimation based on the height of the font of
1302 the face `header-line'. */
1304 #define CURRENT_HEADER_LINE_HEIGHT(W) \
1305 (current_header_line_height >= 0 \
1306 ? current_header_line_height \
1307 : (MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1308 ? MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1309 : estimate_mode_line_height (XFRAME ((W)->frame), \
1310 HEADER_LINE_FACE_ID)))
1312 /* Return the height of the desired mode line of window W. */
1314 #define DESIRED_MODE_LINE_HEIGHT(W) \
1315 MATRIX_MODE_LINE_HEIGHT ((W)->desired_matrix)
1317 /* Return the height of the desired header line of window W. */
1319 #define DESIRED_HEADER_LINE_HEIGHT(W) \
1320 MATRIX_HEADER_LINE_HEIGHT ((W)->desired_matrix)
1322 /* Value is non-zero if window W wants a mode line. */
1324 #define WINDOW_WANTS_MODELINE_P(W) \
1325 (!MINI_WINDOW_P ((W)) \
1326 && !(W)->pseudo_window_p \
1327 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1328 && BUFFERP ((W)->buffer) \
1329 && !NILP (XBUFFER ((W)->buffer)->mode_line_format) \
1330 && WINDOW_TOTAL_LINES (W) > 1)
1332 /* Value is non-zero if window W wants a header line. */
1334 #define WINDOW_WANTS_HEADER_LINE_P(W) \
1335 (!MINI_WINDOW_P ((W)) \
1336 && !(W)->pseudo_window_p \
1337 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1338 && BUFFERP ((W)->buffer) \
1339 && !NILP (XBUFFER ((W)->buffer)->header_line_format) \
1340 && WINDOW_TOTAL_LINES (W) > 1 + !NILP (XBUFFER ((W)->buffer)->mode_line_format))
1343 /* Return proper value to be used as baseline offset of font that has
1344 ASCENT and DESCENT to draw characters by the font at the vertical
1345 center of the line of frame F.
1347 Here, our task is to find the value of BOFF in the following figure;
1349 -------------------------+-----------+-
1350 -+-+---------+-+ | |
1352 | | | | F_ASCENT F_HEIGHT
1355 | | |-|-+------+-----------|------- baseline
1357 | |---------|-+-+ | |
1359 -+-+---------+-+ F_DESCENT |
1360 -------------------------+-----------+-
1362 -BOFF + DESCENT + (F_HEIGHT - HEIGHT) / 2 = F_DESCENT
1363 BOFF = DESCENT + (F_HEIGHT - HEIGHT) / 2 - F_DESCENT
1364 DESCENT = FONT->descent
1365 HEIGHT = FONT_HEIGHT (FONT)
1366 F_DESCENT = (FRAME_FONT (F)->descent
1367 - F->terminal->output_data.x->baseline_offset)
1368 F_HEIGHT = FRAME_LINE_HEIGHT (F)
1371 #define VCENTER_BASELINE_OFFSET(FONT, F) \
1372 (FONT_DESCENT (FONT) \
1373 + (FRAME_LINE_HEIGHT ((F)) - FONT_HEIGHT ((FONT)) \
1374 + (FRAME_LINE_HEIGHT ((F)) > FONT_HEIGHT ((FONT)))) / 2 \
1375 - (FONT_DESCENT (FRAME_FONT (F)) - FRAME_BASELINE_OFFSET (F)))
1378 /***********************************************************************
1380 ***********************************************************************/
1382 /* Indices of face attributes in Lisp face vectors. Slot zero is the
1385 enum lface_attribute_index
1387 LFACE_FAMILY_INDEX
= 1,
1392 LFACE_UNDERLINE_INDEX
,
1393 LFACE_INVERSE_INDEX
,
1394 LFACE_FOREGROUND_INDEX
,
1395 LFACE_BACKGROUND_INDEX
,
1396 LFACE_STIPPLE_INDEX
,
1397 LFACE_OVERLINE_INDEX
,
1398 LFACE_STRIKE_THROUGH_INDEX
,
1401 LFACE_INHERIT_INDEX
,
1402 LFACE_AVGWIDTH_INDEX
,
1403 LFACE_FONTSET_INDEX
,
1408 /* Box types of faces. */
1412 /* No box around text. */
1415 /* Simple box of specified width and color. Default width is 1, and
1416 default color is the foreground color of the face. */
1419 /* Boxes with 3D shadows. Color equals the background color of the
1420 face. Width is specified. */
1426 /* Structure describing a realized face.
1428 For each Lisp face, 0..N realized faces can exist for different
1429 frames and different charsets. Realized faces are built from Lisp
1430 faces and text properties/overlays by merging faces and adding
1431 unspecified attributes from the `default' face. */
1435 /* The id of this face. The id equals the index of this face in the
1436 vector faces_by_id of its face cache. */
1439 #ifdef HAVE_WINDOW_SYSTEM
1441 /* If non-zero, this is a GC that we can use without modification for
1442 drawing the characters in this face. */
1445 /* Font used for this face, or null if the font could not be loaded
1446 for some reason. This points to a `font' slot of a struct
1447 font_info, and we should not call XFreeFont on it because the
1448 font may still be used somewhere else. */
1451 /* Background stipple or bitmap used for this face. This is
1452 an id as returned from load_pixmap. */
1455 #else /* not HAVE_WINDOW_SYSTEM */
1460 #endif /* not HAVE_WINDOW_SYSTEM */
1462 /* Pixel value of foreground color for X frames. Color index
1464 unsigned long foreground
;
1466 /* Pixel value or color index of background color. */
1467 unsigned long background
;
1469 /* Pixel value or color index of underline color. */
1470 unsigned long underline_color
;
1472 /* Pixel value or color index of overlined, strike-through, or box
1474 unsigned long overline_color
;
1475 unsigned long strike_through_color
;
1476 unsigned long box_color
;
1478 /* The font's name. This points to a `name' of a font_info, and it
1479 must not be freed. */
1482 /* Font info ID for this face's font. An ID is stored here because
1483 pointers to font_info structures may change. The reason is that
1484 they are pointers into a font table vector that is itself
1488 #ifdef USE_FONT_BACKEND
1489 struct font_info
*font_info
;
1490 #endif /* USE_FONT_BACKEND */
1492 /* Fontset ID if for this face's fontset. Non-ASCII faces derived
1493 from the same ASCII face have the same fontset. */
1496 /* Pixmap width and height. */
1497 unsigned int pixmap_w
, pixmap_h
;
1499 /* Non-zero means characters in this face have a box that thickness
1500 around them. If it is negative, the absolute value indicates the
1501 thickness, and the horizontal lines of box (top and bottom) are
1502 drawn inside of characters glyph area. The vertical lines of box
1503 (left and right) are drawn as the same way as the case that this
1504 value is positive. */
1507 /* Type of box drawn. A value of FACE_NO_BOX means no box is drawn
1508 around text in this face. A value of FACE_SIMPLE_BOX means a box
1509 of width box_line_width is drawn in color box_color. A value of
1510 FACE_RAISED_BOX or FACE_SUNKEN_BOX means a 3D box is drawn with
1511 shadow colors derived from the background color of the face. */
1512 enum face_box_type box
;
1514 /* If `box' above specifies a 3D type, 1 means use box_color for
1516 unsigned use_box_color_for_shadows_p
: 1;
1518 /* The Lisp face attributes this face realizes. All attributes
1519 in this vector are non-nil. */
1520 Lisp_Object lface
[LFACE_VECTOR_SIZE
];
1522 /* The hash value of this face. */
1525 /* Non-zero if text in this face should be underlined, overlined,
1526 strike-through or have a box drawn around it. */
1527 unsigned underline_p
: 1;
1528 unsigned overline_p
: 1;
1529 unsigned strike_through_p
: 1;
1531 /* 1 means that the colors specified for this face could not be
1532 loaded, and were replaced by default colors, so they shouldn't be
1534 unsigned foreground_defaulted_p
: 1;
1535 unsigned background_defaulted_p
: 1;
1537 /* 1 means that either no color is specified for underlining or that
1538 the specified color couldn't be loaded. Use the foreground
1539 color when drawing in that case. */
1540 unsigned underline_defaulted_p
: 1;
1542 /* 1 means that either no color is specified for the corresponding
1543 attribute or that the specified color couldn't be loaded.
1544 Use the foreground color when drawing in that case. */
1545 unsigned overline_color_defaulted_p
: 1;
1546 unsigned strike_through_color_defaulted_p
: 1;
1547 unsigned box_color_defaulted_p
: 1;
1549 /* TTY appearances. Blinking is not yet implemented. Colors are
1550 found in `lface' with empty color string meaning the default
1551 color of the TTY. */
1552 unsigned tty_bold_p
: 1;
1553 unsigned tty_dim_p
: 1;
1554 unsigned tty_underline_p
: 1;
1555 unsigned tty_alt_charset_p
: 1;
1556 unsigned tty_reverse_p
: 1;
1557 unsigned tty_blinking_p
: 1;
1559 /* 1 means that colors of this face may not be freed because they
1560 have been copied bitwise from a base face (see
1562 unsigned colors_copied_bitwise_p
: 1;
1564 /* If non-zero, use overstrike (to simulate bold-face). */
1565 unsigned overstrike
: 1;
1567 /* Next and previous face in hash collision list of face cache. */
1568 struct face
*next
, *prev
;
1570 /* If this face is an ASCII face, this points to this face itself.
1571 Otherwise, this points to an ASCII face that has the same
1572 attributes except the font. */
1573 struct face
*ascii_face
;
1575 #ifdef USE_FONT_BACKEND
1576 /* Extra member that a font-driver uses privately. */
1578 #endif /* USE_FONT_BACKEND */
1582 /* Color index indicating that face uses a terminal's default color. */
1584 #define FACE_TTY_DEFAULT_COLOR ((unsigned long) -1)
1586 /* Color index indicating that face uses an unknown foreground color. */
1588 #define FACE_TTY_DEFAULT_FG_COLOR ((unsigned long) -2)
1590 /* Color index indicating that face uses an unknown background color. */
1592 #define FACE_TTY_DEFAULT_BG_COLOR ((unsigned long) -3)
1594 /* Non-zero if FACE was realized for unibyte use. */
1596 #define FACE_UNIBYTE_P(FACE) ((FACE)->charset < 0)
1599 /* IDs of important faces known by the C face code. These are the IDs
1600 of the faces for CHARSET_ASCII. */
1606 MODE_LINE_INACTIVE_FACE_ID
,
1609 HEADER_LINE_FACE_ID
,
1615 VERTICAL_BORDER_FACE_ID
,
1616 BASIC_FACE_ID_SENTINEL
1619 #define MAX_FACE_ID ((1 << FACE_ID_BITS) - 1)
1621 /* A cache of realized faces. Each frame has its own cache because
1622 Emacs allows different frame-local face definitions. */
1626 /* Hash table of cached realized faces. */
1627 struct face
**buckets
;
1629 /* Back-pointer to the frame this cache belongs to. */
1632 /* A vector of faces so that faces can be referenced by an ID. */
1633 struct face
**faces_by_id
;
1635 /* The allocated size, and number of used slots of faces_by_id. */
1638 /* Flag indicating that attributes of the `menu' face have been
1640 unsigned menu_face_changed_p
: 1;
1644 /* Prepare face FACE for use on frame F. This must be called before
1645 using X resources of FACE. */
1647 #define PREPARE_FACE_FOR_DISPLAY(F, FACE) \
1648 if ((FACE)->gc == 0) \
1649 prepare_face_for_display ((F), (FACE)); \
1653 /* Return a pointer to the face with ID on frame F, or null if such a
1654 face doesn't exist. */
1656 #define FACE_FROM_ID(F, ID) \
1657 (((unsigned) (ID) < FRAME_FACE_CACHE (F)->used) \
1658 ? FRAME_FACE_CACHE (F)->faces_by_id[ID] \
1661 #ifdef HAVE_WINDOW_SYSTEM
1663 /* Non-zero if FACE is suitable for displaying character CHAR. */
1665 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) \
1666 (ASCII_CHAR_P (CHAR) \
1667 ? (FACE) == (FACE)->ascii_face \
1668 : face_suitable_for_char_p ((FACE), (CHAR)))
1670 /* Return the id of the realized face on frame F that is like the face
1671 with id ID but is suitable for displaying character CHAR.
1672 This macro is only meaningful for multibyte character CHAR. */
1674 #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) \
1675 (ASCII_CHAR_P (CHAR) \
1676 ? (FACE)->ascii_face->id \
1677 : face_for_char ((F), (FACE), (CHAR), (POS), (OBJECT)))
1679 #else /* not HAVE_WINDOW_SYSTEM */
1681 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) 1
1682 #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) ((FACE)->id)
1684 #endif /* not HAVE_WINDOW_SYSTEM */
1686 /* Non-zero means face attributes have been changed since the last
1687 redisplay. Used in redisplay_internal. */
1689 extern int face_change_count
;
1694 /***********************************************************************
1696 ***********************************************************************/
1698 /* Structure used to describe where and how to draw a fringe bitmap.
1699 WHICH is the fringe bitmap to draw. WD and H is the (adjusted)
1700 width and height of the bitmap, DH is the height adjustment (if
1701 bitmap is periodic). X and Y are frame coordinates of the area to
1702 display the bitmap, DY is relative offset of the bitmap into that
1703 area. BX, NX, BY, NY specifies the area to clear if the bitmap
1704 does not fill the entire area. FACE is the fringe face. */
1706 struct draw_fringe_bitmap_params
1708 int which
; /* enum fringe_bitmap_type */
1709 unsigned short *bits
;
1713 unsigned cursor_p
: 1;
1714 unsigned overlay_p
: 1;
1718 #define MAX_FRINGE_BITMAPS (1<<FRINGE_ID_BITS)
1721 /***********************************************************************
1723 ***********************************************************************/
1725 /* Iteration over things to display in current_buffer or in a string.
1727 The iterator handles:
1729 1. Overlay strings (after-string, before-string).
1731 3. Invisible text properties.
1732 4. Selective display.
1733 5. Translation of characters via display tables.
1734 6. Translation of control characters to the forms `\003' or `^C'.
1735 7. `glyph' and `space-width' properties.
1737 Iterators are initialized by calling init_iterator or one of the
1738 equivalent functions below. A call to get_next_display_element
1739 loads the iterator structure with information about what next to
1740 display. A call to set_iterator_to_next increments the iterator's
1743 Characters from overlay strings, display table entries or control
1744 character translations are returned one at a time. For example, if
1745 we have a text of `a\x01' where `a' has a display table definition
1746 of `cd' and the control character is displayed with a leading
1747 arrow, then the iterator will return:
1749 Call Return Source Call next
1750 -----------------------------------------------------------------
1751 next c display table move
1752 next d display table move
1753 next ^ control char move
1754 next A control char move
1756 The same mechanism is also used to return characters for ellipses
1757 displayed at the end of invisible text.
1759 CAVEAT: Under some circumstances, move_.* functions can be called
1760 asynchronously, e.g. when computing a buffer position from an x and
1761 y pixel position. This means that these functions and functions
1762 called from them SHOULD NOT USE xmalloc and alike. See also the
1763 comment at the start of xdisp.c. */
1765 /* Enumeration describing what kind of display element an iterator is
1766 loaded with after a call to get_next_display_element. */
1768 enum display_element_type
1770 /* A normal character. */
1773 /* A composition sequence. */
1779 /* A flexible width and height space. */
1782 /* End of buffer or string. */
1785 /* Truncation glyphs. Never returned by get_next_display_element.
1786 Used to get display information about truncation glyphs via
1790 /* Continuation glyphs. See the comment for IT_TRUNCATION. */
1795 /* An enumerator for each text property that has a meaning for display
1800 AUTO_COMPOSED_PROP_IDX
,
1805 COMPOSITION_PROP_IDX
,
1807 /* Not a property. Used to indicate changes in overlays. */
1823 /* Input sources for fetching characters or data to display.
1824 The input source is found in the `method' field. */
1827 GET_FROM_BUFFER
= 0,
1828 GET_FROM_DISPLAY_VECTOR
,
1829 GET_FROM_COMPOSITION
,
1837 #define IT_STACK_SIZE 4
1841 /* The window in which we iterate over current_buffer (or a string). */
1845 /* The window's frame. */
1848 /* Method to use to load this structure with the next display element. */
1849 enum it_method method
;
1851 /* The next position at which to check for face changes, invisible
1852 text, overlay strings, end of text etc., which see. */
1855 /* Maximum string or buffer position + 1. ZV when iterating over
1859 /* C string to iterate over. Non-null means get characters from
1860 this string, otherwise characters are read from current_buffer
1864 /* Number of characters in the string (s, or it->string) we iterate
1868 /* Start and end of a visible region; -1 if the region is not
1869 visible in the window. */
1870 int region_beg_charpos
, region_end_charpos
;
1872 /* Position at which redisplay end trigger functions should be run. */
1873 int redisplay_end_trigger_charpos
;
1875 /* 1 means multibyte characters are enabled. */
1876 unsigned multibyte_p
: 1;
1878 /* 1 means window has a mode line at its top. */
1879 unsigned header_line_p
: 1;
1881 /* 1 means `string' is the value of a `display' property.
1882 Don't handle some `display' properties in these strings. */
1883 unsigned string_from_display_prop_p
: 1;
1885 /* When METHOD == next_element_from_display_vector,
1886 this is 1 if we're doing an ellipsis. Otherwise meaningless. */
1887 unsigned ellipsis_p
: 1;
1889 /* Display table in effect or null for none. */
1890 struct Lisp_Char_Table
*dp
;
1892 /* Current display table vector to return characters from and its
1893 end. dpvec null means we are not returning characters from a
1894 display table entry; current.dpvec_index gives the current index
1895 into dpvec. This same mechanism is also used to return
1896 characters from translated control characters, i.e. `\003' or
1898 Lisp_Object
*dpvec
, *dpend
;
1900 /* Length in bytes of the char that filled dpvec. A value of zero
1901 means that no such character is involved. */
1904 /* Face id to use for all characters in display vector. -1 if unused. */
1907 /* Face id of the iterator saved in case a glyph from dpvec contains
1908 a face. The face is restored when all glyphs from dpvec have
1912 /* Vector of glyphs for control character translation. The pointer
1913 dpvec is set to ctl_chars when a control character is translated.
1914 This vector is also used for incomplete multibyte character
1915 translation (e.g \222\244). Such a character is at most 4 bytes,
1916 thus we need at most 16 bytes here. */
1917 Lisp_Object ctl_chars
[16];
1919 /* Initial buffer or string position of the iterator, before skipping
1920 over display properties and invisible text. */
1921 struct display_pos start
;
1923 /* Current buffer or string position of the iterator, including
1924 position in overlay strings etc. */
1925 struct display_pos current
;
1927 /* Total number of overlay strings to process. This can be >
1928 OVERLAY_STRING_CHUNK_SIZE. */
1929 int n_overlay_strings
;
1931 /* Vector of overlays to process. Overlay strings are processed
1932 OVERLAY_STRING_CHUNK_SIZE at a time. */
1933 #define OVERLAY_STRING_CHUNK_SIZE 16
1934 Lisp_Object overlay_strings
[OVERLAY_STRING_CHUNK_SIZE
];
1936 /* For each overlay string, the overlay it came from. */
1937 Lisp_Object string_overlays
[OVERLAY_STRING_CHUNK_SIZE
];
1939 /* If non-nil, a Lisp string being processed. If
1940 current.overlay_string_index >= 0, this is an overlay string from
1944 /* If non-nil, we are processing a string that came
1945 from a `display' property given by an overlay. */
1946 Lisp_Object from_overlay
;
1948 /* Stack of saved values. New entries are pushed when we begin to
1949 process an overlay string or a string from a `glyph' property.
1950 Entries are popped when we return to deliver display elements
1951 from what we previously had. */
1952 struct iterator_stack_entry
1960 /* Save values specific to a given method. */
1962 /* method == GET_FROM_IMAGE */
1965 struct it_slice slice
;
1968 /* method == GET_FROM_COMPOSITION */
1972 int cmp_id
, cmp_len
;
1974 /* method == GET_FROM_STRETCH */
1980 /* current text and display positions. */
1981 struct text_pos position
;
1982 struct display_pos current
;
1983 Lisp_Object from_overlay
;
1984 enum glyph_row_area area
;
1985 enum it_method method
;
1986 unsigned multibyte_p
: 1;
1987 unsigned string_from_display_prop_p
: 1;
1988 unsigned display_ellipsis_p
: 1;
1990 /* properties from display property that are reset by another display property. */
1991 Lisp_Object space_width
;
1992 Lisp_Object font_height
;
1995 stack
[IT_STACK_SIZE
];
1997 /* Stack pointer. */
2000 /* -1 means selective display hides everything between a \r and the
2001 next newline; > 0 means hide lines indented more than that value. */
2004 /* An enumeration describing what the next display element is
2005 after a call to get_next_display_element. */
2006 enum display_element_type what
;
2011 /* Setting of buffer-local variable selective-display-ellipsis. */
2012 unsigned selective_display_ellipsis_p
: 1;
2014 /* 1 means control characters are translated into the form `^C'
2015 where the `^' can be replaced by a display table entry. */
2016 unsigned ctl_arrow_p
: 1;
2018 /* 1 means lines are truncated. */
2019 unsigned truncate_lines_p
: 1;
2021 /* Non-zero means that the current face has a box. */
2022 unsigned face_box_p
: 1;
2024 /* Non-null means that the current character is the first in a run
2025 of characters with box face. */
2026 unsigned start_of_box_run_p
: 1;
2028 /* Non-zero means that the current character is the last in a run
2029 of characters with box face. */
2030 unsigned end_of_box_run_p
: 1;
2032 /* 1 means overlay strings at end_charpos have been processed. */
2033 unsigned overlay_strings_at_end_processed_p
: 1;
2035 /* 1 means to ignore overlay strings at current pos, as they have
2036 already been processed. */
2037 unsigned ignore_overlay_strings_at_pos_p
: 1;
2039 /* 1 means the actual glyph is not available in the current
2041 unsigned glyph_not_available_p
: 1;
2043 /* 1 means the next line in display_line continues a character
2044 consisting of more than one glyph, and some glyphs of this
2045 character have been put on the previous line. */
2046 unsigned starts_in_middle_of_char_p
: 1;
2048 /* If 1, saved_face_id contains the id of the face in front of text
2049 skipped due to selective display. */
2050 unsigned face_before_selective_p
: 1;
2052 /* If 1, adjust current glyph so it does not increase current row
2053 descent/ascent (line-height property). Reset after this glyph. */
2054 unsigned constrain_row_ascent_descent_p
: 1;
2056 /* The ID of the default face to use. One of DEFAULT_FACE_ID,
2057 MODE_LINE_FACE_ID, etc, depending on what we are displaying. */
2060 /* If what == IT_CHARACTER, character and length in bytes. This is
2061 a character from a buffer or string. It may be different from
2062 the character displayed in case that
2063 unibyte_display_via_language_environment is set.
2065 If what == IT_COMPOSITION, the first component of a composition
2066 and length in bytes of the composition. */
2069 /* If what == IT_COMPOSITION, identification number and length in
2070 chars of a composition. */
2071 int cmp_id
, cmp_len
;
2073 /* The character to display, possibly translated to multibyte
2074 if unibyte_display_via_language_environment is set. This
2075 is set after produce_glyphs has been called. */
2076 int char_to_display
;
2078 /* If what == IT_IMAGE, the id of the image to display. */
2081 /* Values from `slice' property. */
2082 struct it_slice slice
;
2084 /* Value of the `space-width' property, if any; nil if none. */
2085 Lisp_Object space_width
;
2087 /* Computed from the value of the `raise' property. */
2090 /* Value of the `height' property, if any; nil if none. */
2091 Lisp_Object font_height
;
2093 /* Object and position where the current display element came from.
2094 Object can be a Lisp string in case the current display element
2095 comes from an overlay string, or it is buffer. It may also be nil
2096 during mode-line update. Position is a position in object. */
2098 struct text_pos position
;
2100 /* Number of columns per \t. */
2103 /* Width in pixels of truncation and continuation glyphs. */
2104 short truncation_pixel_width
, continuation_pixel_width
;
2106 /* First and last visible x-position in the display area. If window
2107 is hscrolled by n columns, first_visible_x == n * FRAME_COLUMN_WIDTH
2108 (f), and last_visible_x == pixel width of W + first_visible_x. */
2109 int first_visible_x
, last_visible_x
;
2111 /* Last visible y-position + 1 in the display area without a mode
2112 line, if the window has one. */
2115 /* Default amount of additional space in pixels between lines (for
2116 window systems only.) */
2117 int extra_line_spacing
;
2119 /* Max extra line spacing added in this row. */
2120 int max_extra_line_spacing
;
2122 /* Override font height information for this glyph.
2123 Used if override_ascent >= 0. Cleared after this glyph. */
2124 int override_ascent
, override_descent
, override_boff
;
2126 /* If non-null, glyphs are produced in glyph_row with each call to
2128 struct glyph_row
*glyph_row
;
2130 /* The area of glyph_row to which glyphs are added. */
2131 enum glyph_row_area area
;
2133 /* Number of glyphs needed for the last character requested via
2134 produce_glyphs. This is 1 except for tabs. */
2137 /* Width of the display element in pixels. Result of
2141 /* Current, maximum logical, and maximum physical line height
2142 information. Result of produce_glyphs. */
2143 int ascent
, descent
, max_ascent
, max_descent
;
2144 int phys_ascent
, phys_descent
, max_phys_ascent
, max_phys_descent
;
2146 /* Current x pixel position within the display line. This value
2147 does not include the width of continuation lines in front of the
2148 line. The value of current_x is automatically incremented by
2149 pixel_width with each call to produce_glyphs. */
2152 /* Accumulated width of continuation lines. If > 0, this means we
2153 are currently in a continuation line. This is initially zero and
2154 incremented/reset by display_line, move_it_to etc. */
2155 int continuation_lines_width
;
2157 /* Current y-position. Automatically incremented by the height of
2158 glyph_row in move_it_to and display_line. */
2161 /* Vertical matrix position of first text line in window. */
2164 /* Current vertical matrix position, or line number. Automatically
2165 incremented by move_it_to and display_line. */
2168 /* Horizontal matrix position reached in move_it_in_display_line.
2169 Only set there, not in display_line. */
2172 /* Left fringe bitmap number (enum fringe_bitmap_type). */
2173 unsigned left_user_fringe_bitmap
: FRINGE_ID_BITS
;
2175 /* Right fringe bitmap number (enum fringe_bitmap_type). */
2176 unsigned right_user_fringe_bitmap
: FRINGE_ID_BITS
;
2178 /* Face of the left fringe glyph. */
2179 unsigned left_user_fringe_face_id
: FACE_ID_BITS
;
2181 /* Face of the right fringe glyph. */
2182 unsigned right_user_fringe_face_id
: FACE_ID_BITS
;
2186 /* Access to positions of iterator IT. */
2188 #define IT_CHARPOS(IT) CHARPOS ((IT).current.pos)
2189 #define IT_BYTEPOS(IT) BYTEPOS ((IT).current.pos)
2190 #define IT_STRING_CHARPOS(IT) CHARPOS ((IT).current.string_pos)
2191 #define IT_STRING_BYTEPOS(IT) BYTEPOS ((IT).current.string_pos)
2193 /* Test if IT has reached the end of its buffer or string. This will
2194 only work after get_next_display_element has been called. */
2196 #define ITERATOR_AT_END_P(IT) ((IT)->what == IT_EOB)
2198 /* Non-zero means IT is at the end of a line. This is the case if it
2199 is either on a newline or on a carriage return and selective
2200 display hides the rest of the line. */
2202 #define ITERATOR_AT_END_OF_LINE_P(IT) \
2203 ((IT)->what == IT_CHARACTER \
2204 && ((IT)->c == '\n' \
2205 || ((IT)->c == '\r' && (IT)->selective)))
2207 /* Call produce_glyphs or produce_glyphs_hook, if set. Shortcut to
2208 avoid the function call overhead. */
2210 #define PRODUCE_GLYPHS(IT) \
2212 extern int inhibit_free_realized_faces; \
2213 if (FRAME_RIF ((IT)->f) != NULL) \
2214 FRAME_RIF ((IT)->f)->produce_glyphs ((IT)); \
2216 produce_glyphs ((IT)); \
2217 if ((IT)->glyph_row != NULL) \
2218 inhibit_free_realized_faces = 1; \
2221 /* Bit-flags indicating what operation move_it_to should perform. */
2223 enum move_operation_enum
2225 /* Stop if specified x-position is reached. */
2228 /* Stop if specified y-position is reached. */
2231 /* Stop if specified vpos is reached. */
2232 MOVE_TO_VPOS
= 0x04,
2234 /* Stop if specified buffer or string position is reached. */
2240 /***********************************************************************
2241 Window-based redisplay interface
2242 ***********************************************************************/
2244 /* Structure used to describe runs of lines that must be scrolled. */
2248 /* Source and destination y pixel position. */
2249 int desired_y
, current_y
;
2251 /* Source and destination vpos in matrix. */
2252 int desired_vpos
, current_vpos
;
2254 /* Height in pixels, number of glyph rows. */
2259 /* Handlers for setting frame parameters. */
2261 typedef void (*frame_parm_handler
) P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
2264 /* Structure holding system-dependent interface functions needed
2265 for window-based redisplay. */
2267 struct redisplay_interface
2269 /* Handlers for setting frame parameters. */
2270 frame_parm_handler
*frame_parm_handlers
;
2272 /* Produce glyphs/get display metrics for the display element IT is
2274 void (*produce_glyphs
) P_ ((struct it
*it
));
2276 /* Write or insert LEN glyphs from STRING at the nominal output
2278 void (*write_glyphs
) P_ ((struct glyph
*string
, int len
));
2279 void (*insert_glyphs
) P_ ((struct glyph
*start
, int len
));
2281 /* Clear from nominal output position to X. X < 0 means clear
2282 to right end of display. */
2283 void (*clear_end_of_line
) P_ ((int x
));
2285 /* Function to call to scroll the display as described by RUN on
2287 void (*scroll_run_hook
) P_ ((struct window
*w
, struct run
*run
));
2289 /* Function to call after a line in a display has been completely
2290 updated. Used to draw truncation marks and alike. DESIRED_ROW
2291 is the desired row which has been updated. */
2292 void (*after_update_window_line_hook
) P_ ((struct glyph_row
*desired_row
));
2294 /* Function to call before beginning to update window W in
2295 window-based redisplay. */
2296 void (*update_window_begin_hook
) P_ ((struct window
*w
));
2298 /* Function to call after window W has been updated in window-based
2299 redisplay. CURSOR_ON_P non-zero means switch cursor on.
2300 MOUSE_FACE_OVERWRITTEN_P non-zero means that some lines in W
2301 that contained glyphs in mouse-face were overwritten, so we
2302 have to update the mouse highlight. */
2303 void (*update_window_end_hook
) P_ ((struct window
*w
, int cursor_on_p
,
2304 int mouse_face_overwritten_p
));
2306 /* Move cursor to row/column position VPOS/HPOS, pixel coordinates
2307 Y/X. HPOS/VPOS are window-relative row and column numbers and X/Y
2308 are window-relative pixel positions. */
2309 void (*cursor_to
) P_ ((int vpos
, int hpos
, int y
, int x
));
2311 /* Flush the display of frame F. For X, this is XFlush. */
2312 void (*flush_display
) P_ ((struct frame
*f
));
2314 /* Flush the display of frame F if non-NULL. This is called
2315 during redisplay, and should be NULL on systems which flushes
2316 automatically before reading input. */
2317 void (*flush_display_optional
) P_ ((struct frame
*f
));
2319 /* Clear the mouse hightlight in window W, if there is any. */
2320 void (*clear_window_mouse_face
) P_ ((struct window
*w
));
2322 /* Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
2324 void (*get_glyph_overhangs
) P_ ((struct glyph
*glyph
, struct frame
*f
,
2325 int *left
, int *right
));
2327 /* Fix the display of AREA of ROW in window W for overlapping rows.
2328 This function is called from redraw_overlapping_rows after
2329 desired rows have been made current. */
2330 void (*fix_overlapping_area
) P_ ((struct window
*w
, struct glyph_row
*row
,
2331 enum glyph_row_area area
, int));
2333 #ifdef HAVE_WINDOW_SYSTEM
2335 /* Draw a fringe bitmap in window W of row ROW using parameters P. */
2336 void (*draw_fringe_bitmap
) P_ ((struct window
*w
, struct glyph_row
*row
,
2337 struct draw_fringe_bitmap_params
*p
));
2339 /* Define and destroy fringe bitmap no. WHICH. */
2340 void (*define_fringe_bitmap
) P_ ((int which
, unsigned short *bits
,
2342 void (*destroy_fringe_bitmap
) P_ ((int which
));
2344 /* Get metrics of character CHAR2B in FONT of type FONT_TYPE.
2345 Value is null if CHAR2B is not contained in the font. */
2346 XCharStruct
* (*per_char_metric
) P_ ((XFontStruct
*font
, XChar2b
*char2b
,
2349 /* Encode CHAR2B using encoding information from FONT_INFO. CHAR2B is
2350 the two-byte form of C. Encoding is returned in *CHAR2B. If
2351 TWO_BYTE_P is non-null, return non-zero there if font is two-byte. */
2352 int (*encode_char
) P_ ((int c
, XChar2b
*char2b
,
2353 struct font_info
*font_into
,
2354 struct charset
*charset
,
2357 /* Compute left and right overhang of glyph string S.
2358 A NULL pointer if platform does not support this. */
2359 void (*compute_glyph_string_overhangs
) P_ ((struct glyph_string
*s
));
2361 /* Draw a glyph string S. */
2362 void (*draw_glyph_string
) P_ ((struct glyph_string
*s
));
2364 /* Define cursor CURSOR on frame F. */
2365 void (*define_frame_cursor
) P_ ((struct frame
*f
, Cursor cursor
));
2367 /* Clear the area at (X,Y,WIDTH,HEIGHT) of frame F. */
2368 void (*clear_frame_area
) P_ ((struct frame
*f
, int x
, int y
,
2369 int width
, int height
));
2371 /* Draw specified cursor CURSOR_TYPE of width CURSOR_WIDTH
2372 at row GLYPH_ROW on window W if ON_P is 1. If ON_P is
2373 0, don't draw cursor. If ACTIVE_P is 1, system caret
2374 should track this cursor (when applicable). */
2375 void (*draw_window_cursor
) P_ ((struct window
*w
,
2376 struct glyph_row
*glyph_row
,
2378 int cursor_type
, int cursor_width
,
2379 int on_p
, int active_p
));
2381 /* Draw vertical border for window W from (X,Y0) to (X,Y1). */
2382 void (*draw_vertical_window_border
) P_ ((struct window
*w
,
2383 int x
, int y0
, int y1
));
2385 /* Shift display of frame F to make room for inserted glyphs.
2386 The area at pixel (X,Y) of width WIDTH and height HEIGHT is
2387 shifted right by SHIFT_BY pixels. */
2388 void (*shift_glyphs_for_insert
) P_ ((struct frame
*f
,
2389 int x
, int y
, int width
,
2390 int height
, int shift_by
));
2392 #endif /* HAVE_WINDOW_SYSTEM */
2396 /***********************************************************************
2398 ***********************************************************************/
2400 #ifdef HAVE_WINDOW_SYSTEM
2402 /* Structure forward declarations. */
2407 /* Each image format (JPEG, TIFF, ...) supported is described by
2408 a structure of the type below. */
2412 /* A symbol uniquely identifying the image type, .e.g `jpeg'. */
2415 /* Check that SPEC is a valid image specification for the given
2416 image type. Value is non-zero if SPEC is valid. */
2417 int (* valid_p
) P_ ((Lisp_Object spec
));
2419 /* Load IMG which is used on frame F from information contained in
2420 IMG->spec. Value is non-zero if successful. */
2421 int (* load
) P_ ((struct frame
*f
, struct image
*img
));
2423 /* Free resources of image IMG which is used on frame F. */
2424 void (* free
) P_ ((struct frame
*f
, struct image
*img
));
2426 /* Next in list of all supported image types. */
2427 struct image_type
*next
;
2431 /* Structure describing an image. Specific image formats like XBM are
2432 converted into this form, so that display only has to deal with
2433 this type of image. */
2437 /* The time in seconds at which the image was last displayed. Set
2438 in prepare_image_for_display. */
2439 unsigned long timestamp
;
2441 /* Pixmaps of the image. */
2442 Pixmap pixmap
, mask
;
2444 /* Colors allocated for this image, if any. Allocated via xmalloc. */
2445 unsigned long *colors
;
2448 /* A single `background color' for this image, for the use of anyone that
2449 cares about such a thing. Only valid if the `background_valid' field
2450 is true. This should generally be accessed by calling the accessor
2451 macro `IMAGE_BACKGROUND', which will heuristically calculate a value
2453 unsigned long background
;
2455 /* Foreground and background colors of the frame on which the image
2457 unsigned long frame_foreground
, frame_background
;
2459 /* True if this image has a `transparent' background -- that is, is
2460 uses an image mask. The accessor macro for this is
2461 `IMAGE_BACKGROUND_TRANSPARENT'. */
2462 unsigned background_transparent
: 1;
2464 /* True if the `background' and `background_transparent' fields are
2465 valid, respectively. */
2466 unsigned background_valid
: 1, background_transparent_valid
: 1;
2468 /* Width and height of the image. */
2471 /* These values are used for the rectangles displayed for images
2472 that can't be loaded. */
2473 #define DEFAULT_IMAGE_WIDTH 30
2474 #define DEFAULT_IMAGE_HEIGHT 30
2476 /* Top/left and bottom/right corner pixel of actual image data.
2477 Used by four_corners_best to consider the real image data,
2478 rather than looking at the optional image margin. */
2480 #define TOP_CORNER 0
2481 #define LEFT_CORNER 1
2482 #define BOT_CORNER 2
2483 #define RIGHT_CORNER 3
2485 /* Percent of image height used as ascent. A value of
2486 CENTERED_IMAGE_ASCENT means draw the image centered on the
2489 #define DEFAULT_IMAGE_ASCENT 50
2490 #define CENTERED_IMAGE_ASCENT -1
2492 /* Lisp specification of this image. */
2495 /* Relief to draw around the image. */
2498 /* Optional margins around the image. This includes the relief. */
2499 int hmargin
, vmargin
;
2501 /* Reference to the type of the image. */
2502 struct image_type
*type
;
2504 /* 1 means that loading the image failed. Don't try again. */
2505 unsigned load_failed_p
;
2507 /* A place for image types to store additional data. The member
2508 data.lisp_val is marked during GC, so it's safe to store Lisp data
2509 there. Image types should free this data when their `free'
2510 function is called. */
2515 Lisp_Object lisp_val
;
2518 /* Hash value of image specification to speed up comparisons. */
2521 /* Image id of this image. */
2524 /* Hash collision chain. */
2525 struct image
*next
, *prev
;
2529 /* Cache of images. Each frame has a cache. X frames with the same
2530 x_display_info share their caches. */
2534 /* Hash table of images. */
2535 struct image
**buckets
;
2537 /* Vector mapping image ids to images. */
2538 struct image
**images
;
2540 /* Allocated size of `images'. */
2543 /* Number of images in the cache. */
2546 /* Reference count (number of frames sharing this cache). */
2551 /* Value is a pointer to the image with id ID on frame F, or null if
2552 no image with that id exists. */
2554 #define IMAGE_FROM_ID(F, ID) \
2555 (((ID) >= 0 && (ID) < (FRAME_X_IMAGE_CACHE (F)->used)) \
2556 ? FRAME_X_IMAGE_CACHE (F)->images[ID] \
2559 /* Size of bucket vector of image caches. Should be prime. */
2561 #define IMAGE_CACHE_BUCKETS_SIZE 1001
2563 #endif /* HAVE_WINDOW_SYSTEM */
2567 /***********************************************************************
2569 ***********************************************************************/
2571 /* Enumeration defining where to find tool-bar item information in
2572 tool-bar items vectors stored with frames. Each tool-bar item
2573 occupies TOOL_BAR_ITEM_NSLOTS elements in such a vector. */
2575 enum tool_bar_item_idx
2577 /* The key of the tool-bar item. Used to remove items when a binding
2578 for `undefined' is found. */
2581 /* Non-nil if item is enabled. */
2582 TOOL_BAR_ITEM_ENABLED_P
,
2584 /* Non-nil if item is selected (pressed). */
2585 TOOL_BAR_ITEM_SELECTED_P
,
2588 TOOL_BAR_ITEM_CAPTION
,
2590 /* Image(s) to display. This is either a single image specification
2591 or a vector of specifications. */
2592 TOOL_BAR_ITEM_IMAGES
,
2595 TOOL_BAR_ITEM_BINDING
,
2597 /* Button type. One of nil, `:radio' or `:toggle'. */
2603 /* Icon file name of right to left image when an RTL locale is used. */
2604 TOOL_BAR_ITEM_RTL_IMAGE
,
2606 /* Sentinel = number of slots in tool_bar_items occupied by one
2608 TOOL_BAR_ITEM_NSLOTS
2612 /* An enumeration for the different images that can be specified
2613 for a tool-bar item. */
2615 enum tool_bar_item_image
2617 TOOL_BAR_IMAGE_ENABLED_SELECTED
,
2618 TOOL_BAR_IMAGE_ENABLED_DESELECTED
,
2619 TOOL_BAR_IMAGE_DISABLED_SELECTED
,
2620 TOOL_BAR_IMAGE_DISABLED_DESELECTED
2623 /* Margin around tool-bar buttons in pixels. */
2625 extern Lisp_Object Vtool_bar_button_margin
;
2627 /* Thickness of relief to draw around tool-bar buttons. */
2629 extern EMACS_INT tool_bar_button_relief
;
2631 /* Default values of the above variables. */
2633 #define DEFAULT_TOOL_BAR_BUTTON_MARGIN 4
2634 #define DEFAULT_TOOL_BAR_BUTTON_RELIEF 1
2636 /* The height in pixels of the default tool-bar images. */
2638 #define DEFAULT_TOOL_BAR_IMAGE_HEIGHT 24
2641 /***********************************************************************
2642 Terminal Capabilities
2643 ***********************************************************************/
2645 /* Each of these is a bit representing a terminal `capability' (bold,
2646 inverse, etc). They are or'd together to specify the set of
2647 capabilities being queried for when calling `tty_capable_p' (which
2648 returns true if the terminal supports all of them). */
2650 #define TTY_CAP_INVERSE 0x01
2651 #define TTY_CAP_UNDERLINE 0x02
2652 #define TTY_CAP_BOLD 0x04
2653 #define TTY_CAP_DIM 0x08
2654 #define TTY_CAP_BLINK 0x10
2655 #define TTY_CAP_ALT_CHARSET 0x20
2658 /***********************************************************************
2660 ***********************************************************************/
2662 /* Defined in xdisp.c */
2664 struct glyph_row
*row_containing_pos
P_ ((struct window
*, int,
2666 struct glyph_row
*, int));
2667 int string_buffer_position
P_ ((struct window
*, Lisp_Object
, int));
2668 int line_bottom_y
P_ ((struct it
*));
2669 int display_prop_intangible_p
P_ ((Lisp_Object
));
2670 void resize_echo_area_exactly
P_ ((void));
2671 int resize_mini_window
P_ ((struct window
*, int));
2672 int try_window
P_ ((Lisp_Object
, struct text_pos
, int));
2673 void window_box
P_ ((struct window
*, int, int *, int *, int *, int *));
2674 int window_box_height
P_ ((struct window
*));
2675 int window_text_bottom_y
P_ ((struct window
*));
2676 int window_box_width
P_ ((struct window
*, int));
2677 int window_box_left
P_ ((struct window
*, int));
2678 int window_box_left_offset
P_ ((struct window
*, int));
2679 int window_box_right
P_ ((struct window
*, int));
2680 int window_box_right_offset
P_ ((struct window
*, int));
2681 void window_box_edges
P_ ((struct window
*, int, int *, int *, int *, int *));
2682 int estimate_mode_line_height
P_ ((struct frame
*, enum face_id
));
2683 void pixel_to_glyph_coords
P_ ((struct frame
*, int, int, int *, int *,
2684 NativeRectangle
*, int));
2685 int glyph_to_pixel_coords
P_ ((struct window
*, int, int, int *, int *));
2686 void remember_mouse_glyph
P_ ((struct frame
*, int, int, NativeRectangle
*));
2688 void mark_window_display_accurate
P_ ((Lisp_Object
, int));
2689 void redisplay_preserve_echo_area
P_ ((int));
2690 int set_cursor_from_row
P_ ((struct window
*, struct glyph_row
*,
2691 struct glyph_matrix
*, int, int, int, int));
2692 void init_iterator
P_ ((struct it
*, struct window
*, int,
2693 int, struct glyph_row
*, enum face_id
));
2694 void init_iterator_to_row_start
P_ ((struct it
*, struct window
*,
2695 struct glyph_row
*));
2696 int get_next_display_element
P_ ((struct it
*));
2697 void set_iterator_to_next
P_ ((struct it
*, int));
2698 void start_display
P_ ((struct it
*, struct window
*, struct text_pos
));
2699 void move_it_to
P_ ((struct it
*, int, int, int, int, int));
2700 void move_it_vertically
P_ ((struct it
*, int));
2701 void move_it_vertically_backward
P_ ((struct it
*, int));
2702 void move_it_by_lines
P_ ((struct it
*, int, int));
2703 void move_it_past_eol
P_ ((struct it
*));
2704 int in_display_vector_p
P_ ((struct it
*));
2705 int frame_mode_line_height
P_ ((struct frame
*));
2706 void highlight_trailing_whitespace
P_ ((struct frame
*, struct glyph_row
*));
2707 extern Lisp_Object Qtool_bar
;
2708 extern Lisp_Object Vshow_trailing_whitespace
;
2709 extern int mode_line_in_non_selected_windows
;
2710 extern int redisplaying_p
;
2711 extern void add_to_log
P_ ((char *, Lisp_Object
, Lisp_Object
));
2712 extern int help_echo_showing_p
;
2713 extern int current_mode_line_height
, current_header_line_height
;
2714 extern Lisp_Object help_echo_string
, help_echo_window
;
2715 extern Lisp_Object help_echo_object
, previous_help_echo_string
;
2716 extern int help_echo_pos
;
2717 extern struct frame
*last_mouse_frame
;
2718 extern int last_tool_bar_item
;
2719 extern Lisp_Object Vmouse_autoselect_window
;
2720 extern int unibyte_display_via_language_environment
;
2722 extern void reseat_at_previous_visible_line_start
P_ ((struct it
*));
2724 extern int calc_pixel_width_or_height
P_ ((double *, struct it
*, Lisp_Object
,
2725 /* XFontStruct */ void *, int, int *));
2727 #ifdef HAVE_WINDOW_SYSTEM
2730 extern void dump_glyph_string
P_ ((struct glyph_string
*));
2733 extern void x_get_glyph_overhangs
P_ ((struct glyph
*, struct frame
*,
2735 extern void x_produce_glyphs
P_ ((struct it
*));
2737 extern void x_write_glyphs
P_ ((struct glyph
*, int));
2738 extern void x_insert_glyphs
P_ ((struct glyph
*, int len
));
2739 extern void x_clear_end_of_line
P_ ((int));
2741 extern int x_stretch_cursor_p
;
2742 extern struct cursor_pos output_cursor
;
2744 extern void x_fix_overlapping_area
P_ ((struct window
*, struct glyph_row
*,
2745 enum glyph_row_area
, int));
2746 extern void draw_phys_cursor_glyph
P_ ((struct window
*,
2748 enum draw_glyphs_face
));
2749 extern void get_phys_cursor_geometry
P_ ((struct window
*, struct glyph_row
*,
2750 struct glyph
*, int *, int *, int *));
2751 extern void erase_phys_cursor
P_ ((struct window
*));
2752 extern void display_and_set_cursor
P_ ((struct window
*,
2753 int, int, int, int, int));
2755 extern void set_output_cursor
P_ ((struct cursor_pos
*));
2756 extern void x_cursor_to
P_ ((int, int, int, int));
2758 extern void x_update_cursor
P_ ((struct frame
*, int));
2759 extern void x_clear_cursor
P_ ((struct window
*));
2760 extern void x_draw_vertical_border
P_ ((struct window
*w
));
2762 extern void frame_to_window_pixel_xy
P_ ((struct window
*, int *, int *));
2763 extern int get_glyph_string_clip_rects
P_ ((struct glyph_string
*,
2764 NativeRectangle
*, int));
2765 extern void get_glyph_string_clip_rect
P_ ((struct glyph_string
*,
2766 NativeRectangle
*nr
));
2767 extern Lisp_Object find_hot_spot
P_ ((Lisp_Object
, int, int));
2768 extern void note_mouse_highlight
P_ ((struct frame
*, int, int));
2769 extern void x_clear_window_mouse_face
P_ ((struct window
*));
2770 extern void cancel_mouse_face
P_ ((struct frame
*));
2772 extern void handle_tool_bar_click
P_ ((struct frame
*,
2773 int, int, int, unsigned int));
2775 /* msdos.c defines its own versions of these functions. */
2776 extern int clear_mouse_face
P_ ((Display_Info
*));
2777 extern void show_mouse_face
P_ ((Display_Info
*, enum draw_glyphs_face
));
2778 extern int cursor_in_mouse_face_p
P_ ((struct window
*w
));
2780 extern void expose_frame
P_ ((struct frame
*, int, int, int, int));
2781 extern int x_intersect_rectangles
P_ ((XRectangle
*, XRectangle
*,
2785 /* Defined in fringe.c */
2787 int lookup_fringe_bitmap (Lisp_Object
);
2788 void draw_fringe_bitmap
P_ ((struct window
*, struct glyph_row
*, int));
2789 void draw_row_fringe_bitmaps
P_ ((struct window
*, struct glyph_row
*));
2790 int draw_window_fringes
P_ ((struct window
*, int));
2791 int update_window_fringes
P_ ((struct window
*, int));
2792 void compute_fringe_widths
P_ ((struct frame
*, int));
2795 void w32_init_fringe
P_ ((struct redisplay_interface
*));
2796 void w32_reset_fringes
P_ ((void));
2799 void mac_init_fringe
P_ ((struct redisplay_interface
*));
2802 /* Defined in image.c */
2804 #ifdef HAVE_WINDOW_SYSTEM
2806 extern int x_bitmap_height
P_ ((struct frame
*, int));
2807 extern int x_bitmap_width
P_ ((struct frame
*, int));
2808 extern int x_bitmap_pixmap
P_ ((struct frame
*, int));
2809 extern void x_reference_bitmap
P_ ((struct frame
*, int));
2810 extern int x_create_bitmap_from_data
P_ ((struct frame
*, char *,
2811 unsigned int, unsigned int));
2812 extern int x_create_bitmap_from_file
P_ ((struct frame
*, Lisp_Object
));
2813 #if defined (HAVE_XPM) && defined (HAVE_X_WINDOWS)
2814 extern int x_create_bitmap_from_xpm_data
P_ ((struct frame
*f
, char **bits
));
2816 #ifndef x_destroy_bitmap
2817 extern void x_destroy_bitmap
P_ ((struct frame
*, int));
2819 extern void x_destroy_all_bitmaps
P_ ((Display_Info
*));
2820 extern int x_create_bitmap_mask
P_ ((struct frame
* , int));
2821 extern Lisp_Object x_find_image_file
P_ ((Lisp_Object
));
2823 void x_kill_gs_process
P_ ((Pixmap
, struct frame
*));
2824 struct image_cache
*make_image_cache
P_ ((void));
2825 void free_image_cache
P_ ((struct frame
*));
2826 void clear_image_cache
P_ ((struct frame
*, int));
2827 void forall_images_in_image_cache
P_ ((struct frame
*,
2828 void (*) P_ ((struct image
*))));
2829 int valid_image_p
P_ ((Lisp_Object
));
2830 void prepare_image_for_display
P_ ((struct frame
*, struct image
*));
2831 int lookup_image
P_ ((struct frame
*, Lisp_Object
));
2833 unsigned long image_background
P_ ((struct image
*, struct frame
*,
2834 XImagePtr_or_DC ximg
));
2835 int image_background_transparent
P_ ((struct image
*, struct frame
*,
2836 XImagePtr_or_DC mask
));
2838 int image_ascent
P_ ((struct image
*, struct face
*, struct glyph_slice
*));
2842 /* Defined in sysdep.c */
2844 void get_tty_size
P_ ((int, int *, int *));
2845 void request_sigio
P_ ((void));
2846 void unrequest_sigio
P_ ((void));
2847 int tabs_safe_p
P_ ((int));
2848 void init_baud_rate
P_ ((int));
2849 void init_sigio
P_ ((int));
2851 /* Defined in xfaces.c */
2853 #ifdef HAVE_X_WINDOWS
2854 void x_free_colors
P_ ((struct frame
*, unsigned long *, int));
2857 void update_face_from_frame_parameter
P_ ((struct frame
*, Lisp_Object
,
2859 Lisp_Object tty_color_name
P_ ((struct frame
*, int));
2860 void clear_face_cache
P_ ((int));
2861 unsigned long load_color
P_ ((struct frame
*, struct face
*, Lisp_Object
,
2862 enum lface_attribute_index
));
2863 void unload_color
P_ ((struct frame
*, unsigned long));
2864 char *choose_face_font
P_ ((struct frame
*, Lisp_Object
*, Lisp_Object
,
2866 int ascii_face_of_lisp_face
P_ ((struct frame
*, int));
2867 void prepare_face_for_display
P_ ((struct frame
*, struct face
*));
2868 int xstricmp
P_ ((const unsigned char *, const unsigned char *));
2869 int lookup_face
P_ ((struct frame
*, Lisp_Object
*));
2870 int lookup_non_ascii_face
P_ ((struct frame
*, int, struct face
*));
2871 int lookup_named_face
P_ ((struct frame
*, Lisp_Object
, int));
2872 int smaller_face
P_ ((struct frame
*, int, int));
2873 int face_with_height
P_ ((struct frame
*, int, int));
2874 int lookup_derived_face
P_ ((struct frame
*, Lisp_Object
, int, int));
2875 void init_frame_faces
P_ ((struct frame
*));
2876 void free_frame_faces
P_ ((struct frame
*));
2877 void recompute_basic_faces
P_ ((struct frame
*));
2878 int face_at_buffer_position
P_ ((struct window
*, int, int, int, int *,
2880 int face_for_overlay_string
P_ ((struct window
*, int, int,
2882 int, int, Lisp_Object
));
2883 int face_at_string_position
P_ ((struct window
*, Lisp_Object
, int, int, int,
2884 int, int *, enum face_id
, int));
2885 int merge_faces
P_ ((struct frame
*, Lisp_Object
, int, int));
2886 int compute_char_face
P_ ((struct frame
*, int, Lisp_Object
));
2887 void free_all_realized_faces
P_ ((Lisp_Object
));
2888 void free_realized_face
P_ ((struct frame
*, struct face
*));
2889 extern Lisp_Object Qforeground_color
, Qbackground_color
;
2890 extern Lisp_Object Qframe_set_background_mode
;
2891 extern char unspecified_fg
[], unspecified_bg
[];
2892 extern Lisp_Object split_font_name_into_vector
P_ ((Lisp_Object
));
2893 extern Lisp_Object build_font_name_from_vector
P_ ((Lisp_Object
));
2895 /* Defined in xfns.c */
2897 #ifdef HAVE_X_WINDOWS
2898 void gamma_correct
P_ ((struct frame
*, XColor
*));
2901 void gamma_correct
P_ ((struct frame
*, COLORREF
*));
2904 void gamma_correct
P_ ((struct frame
*, unsigned long *));
2907 #ifdef HAVE_WINDOW_SYSTEM
2909 int x_screen_planes
P_ ((struct frame
*));
2910 void x_implicitly_set_name
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
2912 extern Lisp_Object tip_frame
;
2913 extern Window tip_window
;
2914 EXFUN (Fx_show_tip
, 6);
2915 EXFUN (Fx_hide_tip
, 0);
2916 extern void start_hourglass
P_ ((void));
2917 extern void cancel_hourglass
P_ ((void));
2918 extern int hourglass_started
P_ ((void));
2919 extern int display_hourglass_p
;
2921 /* Returns the background color of IMG, calculating one heuristically if
2922 necessary. If non-zero, XIMG is an existing XImage object to use for
2925 #define IMAGE_BACKGROUND(img, f, ximg) \
2926 ((img)->background_valid \
2927 ? (img)->background \
2928 : image_background (img, f, ximg))
2930 /* Returns true if IMG has a `transparent' background, using heuristics
2931 to decide if necessary. If non-zero, MASK is an existing XImage
2932 object to use for the heuristic. */
2934 #define IMAGE_BACKGROUND_TRANSPARENT(img, f, mask) \
2935 ((img)->background_transparent_valid \
2936 ? (img)->background_transparent \
2937 : image_background_transparent (img, f, mask))
2939 #endif /* HAVE_WINDOW_SYSTEM */
2942 /* Defined in xmenu.c */
2944 int popup_activated
P_ ((void));
2946 /* Defined in dispnew.c */
2948 extern int inverse_video
;
2949 extern int required_matrix_width
P_ ((struct window
*));
2950 extern int required_matrix_height
P_ ((struct window
*));
2951 extern Lisp_Object buffer_posn_from_coords
P_ ((struct window
*,
2953 struct display_pos
*,
2955 int *, int *, int *, int *));
2956 extern Lisp_Object mode_line_string
P_ ((struct window
*, enum window_part
,
2957 int *, int *, int *,
2959 int *, int *, int *, int *));
2960 extern Lisp_Object marginal_area_string
P_ ((struct window
*, enum window_part
,
2961 int *, int *, int *,
2963 int *, int *, int *, int *));
2964 extern void redraw_frame
P_ ((struct frame
*));
2965 extern void redraw_garbaged_frames
P_ ((void));
2966 extern void cancel_line
P_ ((int, struct frame
*));
2967 extern void init_desired_glyphs
P_ ((struct frame
*));
2968 extern int scroll_frame_lines
P_ ((struct frame
*, int, int, int, int));
2969 extern int direct_output_for_insert
P_ ((int));
2970 extern int direct_output_forward_char
P_ ((int));
2971 extern int update_frame
P_ ((struct frame
*, int, int));
2972 extern int scrolling
P_ ((struct frame
*));
2973 extern void bitch_at_user
P_ ((void));
2974 void adjust_glyphs
P_ ((struct frame
*));
2975 void free_glyphs
P_ ((struct frame
*));
2976 void free_window_matrices
P_ ((struct window
*));
2977 void check_glyph_memory
P_ ((void));
2978 void mirrored_line_dance
P_ ((struct glyph_matrix
*, int, int, int *, char *));
2979 void clear_glyph_matrix
P_ ((struct glyph_matrix
*));
2980 void clear_current_matrices
P_ ((struct frame
*f
));
2981 void clear_desired_matrices
P_ ((struct frame
*));
2982 void shift_glyph_matrix
P_ ((struct window
*, struct glyph_matrix
*,
2984 void rotate_matrix
P_ ((struct glyph_matrix
*, int, int, int));
2985 void increment_matrix_positions
P_ ((struct glyph_matrix
*,
2986 int, int, int, int));
2987 void blank_row
P_ ((struct window
*, struct glyph_row
*, int));
2988 void increment_row_positions
P_ ((struct glyph_row
*, int, int));
2989 void enable_glyph_matrix_rows
P_ ((struct glyph_matrix
*, int, int, int));
2990 void clear_glyph_row
P_ ((struct glyph_row
*));
2991 void prepare_desired_row
P_ ((struct glyph_row
*));
2992 int line_hash_code
P_ ((struct glyph_row
*));
2993 void set_window_update_flags
P_ ((struct window
*, int));
2994 void redraw_frame
P_ ((struct frame
*));
2995 void redraw_garbaged_frames
P_ ((void));
2996 int scroll_cost
P_ ((struct frame
*, int, int, int));
2997 int direct_output_for_insert
P_ ((int));
2998 int direct_output_forward_char
P_ ((int));
2999 int update_frame
P_ ((struct frame
*, int, int));
3000 void update_single_window
P_ ((struct window
*, int));
3001 int scrolling
P_ ((struct frame
*));
3002 void do_pending_window_change
P_ ((int));
3003 void change_frame_size
P_ ((struct frame
*, int, int, int, int, int));
3004 void bitch_at_user
P_ ((void));
3005 void init_display
P_ ((void));
3006 void syms_of_display
P_ ((void));
3007 extern Lisp_Object Qredisplay_dont_pause
;
3008 GLYPH spec_glyph_lookup_face
P_ ((struct window
*, GLYPH
));
3010 /* Defined in terminal.c */
3012 extern void ring_bell
P_ ((struct frame
*));
3013 extern void update_begin
P_ ((struct frame
*));
3014 extern void update_end
P_ ((struct frame
*));
3015 extern void set_terminal_window
P_ ((struct frame
*, int));
3016 extern void cursor_to
P_ ((struct frame
*, int, int));
3017 extern void raw_cursor_to
P_ ((struct frame
*, int, int));
3018 extern void clear_to_end
P_ ((struct frame
*));
3019 extern void clear_frame
P_ ((struct frame
*));
3020 extern void clear_end_of_line
P_ ((struct frame
*, int));
3021 extern void write_glyphs
P_ ((struct frame
*, struct glyph
*, int));
3022 extern void insert_glyphs
P_ ((struct frame
*, struct glyph
*, int));
3023 extern void delete_glyphs
P_ ((struct frame
*, int));
3024 extern void ins_del_lines
P_ ((struct frame
*, int, int));
3026 extern struct terminal
*init_initial_terminal
P_ ((void));
3029 /* Defined in term.c */
3031 extern void tty_set_terminal_modes
P_ ((struct terminal
*));
3032 extern void tty_reset_terminal_modes
P_ ((struct terminal
*));
3033 extern void tty_turn_off_insert
P_ ((struct tty_display_info
*));
3034 extern void tty_turn_off_highlight
P_ ((struct tty_display_info
*));
3035 extern int string_cost
P_ ((char *));
3036 extern int per_line_cost
P_ ((char *));
3037 extern void calculate_costs
P_ ((struct frame
*));
3038 extern void produce_glyphs
P_ ((struct it
*));
3039 extern void produce_special_glyphs
P_ ((struct it
*, enum display_element_type
));
3040 extern int tty_capable_p
P_ ((struct tty_display_info
*, unsigned, unsigned long, unsigned long));
3041 extern void set_tty_color_mode
P_ ((struct frame
*, Lisp_Object
));
3042 extern struct terminal
*get_tty_terminal
P_ ((Lisp_Object
, int));
3043 extern struct terminal
*get_named_tty
P_ ((char *));
3044 EXFUN (Ftty_type
, 1);
3045 extern void create_tty_output
P_ ((struct frame
*));
3046 extern struct terminal
*init_tty
P_ ((char *, char *, int));
3049 /* Defined in scroll.c */
3051 extern int scrolling_max_lines_saved
P_ ((int, int, int *, int *, int *));
3052 extern int scroll_cost
P_ ((struct frame
*, int, int, int));
3053 extern void do_line_insertion_deletion_costs
P_ ((struct frame
*, char *,
3054 char *, char *, char *,
3055 char *, char *, int));
3056 void scrolling_1
P_ ((struct frame
*, int, int, int, int *, int *, int *,
3059 /* Defined in frame.c */
3061 #ifdef HAVE_WINDOW_SYSTEM
3063 /* Types we might convert a resource string into. */
3073 extern Lisp_Object x_get_arg
P_ ((Display_Info
*, Lisp_Object
,
3074 Lisp_Object
, char *, char *class,
3075 enum resource_types
));
3076 extern Lisp_Object x_frame_get_arg
P_ ((struct frame
*, Lisp_Object
,
3077 Lisp_Object
, char *, char *,
3078 enum resource_types
));
3079 extern Lisp_Object x_frame_get_and_record_arg
P_ ((
3080 struct frame
*, Lisp_Object
,
3081 Lisp_Object
, char *, char *,
3082 enum resource_types
));
3083 extern Lisp_Object x_default_parameter
P_ ((struct frame
*, Lisp_Object
,
3084 Lisp_Object
, Lisp_Object
,
3086 enum resource_types
));
3088 #endif /* HAVE_WINDOW_SYSTEM */
3090 #endif /* not DISPEXTERN_H_INCLUDED */
3092 /* arch-tag: c65c475f-1c1e-4534-8795-990b8509fd65
3093 (do not change this comment) */