1 /* Interface definitions for display code.
2 Copyright (C) 1985, 1993, 1994, 1997, 1998, 1999, 2000, 2001, 2002,
3 2003, 2004, 2005, 2006, 2007, 2008
4 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>. */
23 #ifndef DISPEXTERN_H_INCLUDED
24 #define DISPEXTERN_H_INCLUDED
30 #include <X11/Intrinsic.h>
31 #endif /* USE_X_TOOLKIT */
33 #else /* !HAVE_X_WINDOWS */
35 /* X-related stuff used by non-X gui code. */
39 unsigned short red
, green
, blue
;
44 #endif /* HAVE_X_WINDOWS */
51 typedef struct x_display_info Display_Info
;
52 typedef XImage
* XImagePtr
;
53 typedef XImagePtr XImagePtr_or_DC
;
54 #define NativeRectangle XRectangle
59 typedef struct w32_display_info Display_Info
;
60 typedef XImage
*XImagePtr
;
61 typedef HDC XImagePtr_or_DC
;
66 /* following typedef needed to accomodate the MSDOS port, believe it or not */
67 typedef struct ns_display_info Display_Info
;
68 typedef Pixmap XImagePtr
;
69 typedef XImagePtr XImagePtr_or_DC
;
72 #ifndef NativeRectangle
73 #define NativeRectangle int
76 /* Structure forward declarations. Some are here because function
77 prototypes below reference structure types before their definition
78 in this file. Some are here because not every file including
79 dispextern.h also includes frame.h and windows.h. */
89 /* Values returned from coordinates_in_window. */
105 /* Number of bits allocated to store fringe bitmap numbers. */
106 #define FRINGE_ID_BITS 16
110 /***********************************************************************
112 ***********************************************************************/
114 /* If GLYPH_DEBUG is non-zero, additional checks are activated. Turn
115 it off by defining the macro GLYPH_DEBUG to zero. */
118 #define GLYPH_DEBUG 0
121 /* If XASSERTS is non-zero, additional consistency checks are activated.
122 Turn it off by defining the macro XASSERTS to zero. */
128 /* Macros to include code only if GLYPH_DEBUG != 0. */
131 #define IF_DEBUG(X) X
133 #define IF_DEBUG(X) (void) 0
137 #define xassert(X) do {if (!(X)) abort ();} while (0)
139 #define xassert(X) (void) 0
142 /* Macro for displaying traces of redisplay. If Emacs was compiled
143 with GLYPH_DEBUG != 0, the variable trace_redisplay_p can be set to
144 a non-zero value in debugging sessions to activate traces. */
148 extern int trace_redisplay_p
;
152 if (trace_redisplay_p) \
157 #else /* GLYPH_DEBUG == 0 */
159 #define TRACE(X) (void) 0
161 #endif /* GLYPH_DEBUG == 0 */
165 /***********************************************************************
167 ***********************************************************************/
169 /* Starting with Emacs 20.3, characters from strings and buffers have
170 both a character and a byte position associated with them. The
171 following structure holds such a pair of positions. */
175 /* Character position. */
178 /* Corresponding byte position. */
182 /* Access character and byte position of POS in a functional form. */
184 #define BYTEPOS(POS) (POS).bytepos
185 #define CHARPOS(POS) (POS).charpos
187 /* Set character position of POS to CHARPOS, byte position to BYTEPOS. */
189 #define SET_TEXT_POS(POS, CHARPOS, BYTEPOS) \
190 ((POS).charpos = (CHARPOS), (POS).bytepos = BYTEPOS)
192 /* Increment text position POS. */
194 #define INC_TEXT_POS(POS, MULTIBYTE_P) \
199 INC_POS ((POS).bytepos); \
205 /* Decrement text position POS. */
207 #define DEC_TEXT_POS(POS, MULTIBYTE_P) \
212 DEC_POS ((POS).bytepos); \
218 /* Set text position POS from marker MARKER. */
220 #define SET_TEXT_POS_FROM_MARKER(POS, MARKER) \
221 (CHARPOS (POS) = marker_position ((MARKER)), \
222 BYTEPOS (POS) = marker_byte_position ((MARKER)))
224 /* Set marker MARKER from text position POS. */
226 #define SET_MARKER_FROM_TEXT_POS(MARKER, POS) \
227 set_marker_both ((MARKER), Qnil, CHARPOS ((POS)), BYTEPOS ((POS)))
229 /* Value is non-zero if character and byte positions of POS1 and POS2
232 #define TEXT_POS_EQUAL_P(POS1, POS2) \
233 ((POS1).charpos == (POS2).charpos \
234 && (POS1).bytepos == (POS2).bytepos)
236 /* When rendering glyphs, redisplay scans string or buffer text,
237 overlay strings in that text, and does display table or control
238 character translations. The following structure captures a
239 position taking all this into account. */
243 /* Buffer or string position. */
246 /* If this is a position in an overlay string, overlay_string_index
247 is the index of that overlay string in the sequence of overlay
248 strings at `pos' in the order redisplay processes them. A value
249 < 0 means that this is not a position in an overlay string. */
250 int overlay_string_index
;
252 /* If this is a position in an overlay string, string_pos is the
253 position within that string. */
254 struct text_pos string_pos
;
256 /* If the character at the position above is a control character or
257 has a display table entry, dpvec_index is an index in the display
258 table or control character translation of that character. A
259 value < 0 means this is not a position in such a translation. */
265 /***********************************************************************
267 ***********************************************************************/
269 /* Enumeration of glyph types. Glyph structures contain a type field
270 containing one of the enumerators defined here. */
274 /* Glyph describes a character. */
277 /* Glyph describes a composition sequence. */
280 /* Glyph describes an image. */
283 /* Glyph is a space of fractional width and/or height. */
288 /* Structure describing how to use partial glyphs (images slicing) */
295 unsigned height
: 16;
301 Be extra careful when changing this structure! Esp. make sure that
302 functions producing glyphs, like append_glyph, fill ALL of the
303 glyph structure, and that GLYPH_EQUAL_P compares all
304 display-relevant members of glyphs (not to imply that these are the
305 only things to check when you add a member). */
309 /* Position from which this glyph was drawn. If `object' below is a
310 Lisp string, this is a position in that string. If it is a
311 buffer, this is a position in that buffer. A value of -1
312 together with a null object means glyph is a truncation glyph at
313 the start of a row. */
316 /* Lisp object source of this glyph. Currently either a buffer or
317 a string, if the glyph was produced from characters which came from
318 a buffer or a string; or 0 if the glyph was inserted by redisplay
319 for its own purposes such as padding. */
322 /* Width in pixels. */
325 /* Ascent and descent in pixels. */
326 short ascent
, descent
;
328 /* Vertical offset. If < 0, the glyph is displayed raised, if > 0
329 the glyph is displayed lowered. */
332 /* Which kind of glyph this is---character, image etc. Value
333 should be an enumerator of type enum glyph_type. */
336 /* 1 means this glyph was produced from multibyte text. Zero
337 means it was produced from unibyte text, i.e. charsets aren't
338 applicable, and encoding is not performed. */
339 unsigned multibyte_p
: 1;
341 /* Non-zero means draw a box line at the left or right side of this
342 glyph. This is part of the implementation of the face attribute
344 unsigned left_box_line_p
: 1;
345 unsigned right_box_line_p
: 1;
347 /* Non-zero means this glyph's physical ascent or descent is greater
348 than its logical ascent/descent, i.e. it may potentially overlap
349 glyphs above or below it. */
350 unsigned overlaps_vertically_p
: 1;
352 /* For terminal frames, 1 means glyph is a padding glyph. Padding
353 glyphs are used for characters whose visual shape consists of
354 more than one glyph (e.g. Asian characters). All but the first
355 glyph of such a glyph sequence have the padding_p flag set. This
356 flag is used only to minimize code changes. A better way would
357 probably be to use the width field of glyphs to express padding.
359 For graphic frames, 1 means the pixel width of the glyph in a
360 font is 0, but 1-pixel is padded on displaying for correct cursor
361 displaying. The member `pixel_width' above is set to 1. */
362 unsigned padding_p
: 1;
364 /* 1 means the actual glyph is not available, draw a box instead.
365 This can happen when a font couldn't be loaded, or a character
366 doesn't have a glyph in a font. */
367 unsigned glyph_not_available_p
: 1;
370 /* Non-zero means don't display cursor here. */
371 unsigned avoid_cursor_p
: 1;
373 #define FACE_ID_BITS 20
375 /* Face of the glyph. This is a realized face ID,
376 an index in the face cache of the frame. */
377 unsigned face_id
: FACE_ID_BITS
;
379 /* Type of font used to display the character glyph. May be used to
380 determine which set of functions to use to obtain font metrics
381 for the glyph. On W32, value should be an enumerator of the type
382 w32_char_font_type. Otherwise it equals FONT_TYPE_UNKNOWN. */
383 unsigned font_type
: 3;
385 struct glyph_slice slice
;
387 /* A union of sub-structures for different glyph types. */
390 /* Character code for character glyphs (type == CHAR_GLYPH). */
393 /* Composition ID for composition glyphs (type == COMPOSITION_GLYPH) */
396 /* Image ID for image glyphs (type == IMAGE_GLYPH). */
399 /* Sub-structure for type == STRETCH_GLYPH. */
402 /* The height of the glyph. */
403 unsigned height
: 16;
405 /* The ascent of the glyph. */
406 unsigned ascent
: 16;
410 /* Used to compare all bit-fields above in one step. */
416 /* Default value of the glyph font_type field. */
418 #define FONT_TYPE_UNKNOWN 0
420 /* Is GLYPH a space? */
422 #define CHAR_GLYPH_SPACE_P(GLYPH) \
423 ((GLYPH).u.ch == SPACEGLYPH && (GLYPH).face_id == DEFAULT_FACE_ID)
425 /* Are glyph slices of glyphs *X and *Y equal */
427 #define GLYPH_SLICE_EQUAL_P(X, Y) \
428 ((X)->slice.x == (Y)->slice.x \
429 && (X)->slice.y == (Y)->slice.y \
430 && (X)->slice.width == (Y)->slice.width \
431 && (X)->slice.height == (Y)->slice.height)
433 /* Are glyphs *X and *Y displayed equal? */
435 #define GLYPH_EQUAL_P(X, Y) \
436 ((X)->type == (Y)->type \
437 && (X)->u.val == (Y)->u.val \
438 && GLYPH_SLICE_EQUAL_P (X, Y) \
439 && (X)->face_id == (Y)->face_id \
440 && (X)->padding_p == (Y)->padding_p \
441 && (X)->left_box_line_p == (Y)->left_box_line_p \
442 && (X)->right_box_line_p == (Y)->right_box_line_p \
443 && (X)->voffset == (Y)->voffset \
444 && (X)->pixel_width == (Y)->pixel_width)
446 /* Are character codes, faces, padding_ps of glyphs *X and *Y equal? */
448 #define GLYPH_CHAR_AND_FACE_EQUAL_P(X, Y) \
449 ((X)->u.ch == (Y)->u.ch \
450 && (X)->face_id == (Y)->face_id \
451 && (X)->padding_p == (Y)->padding_p)
453 /* Fill a character glyph GLYPH. CODE, FACE_ID, PADDING_P correspond
454 to the bits defined for the typedef `GLYPH' in lisp.h. */
456 #define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P) \
459 (GLYPH).u.ch = (CODE); \
460 (GLYPH).face_id = (FACE_ID); \
461 (GLYPH).padding_p = (PADDING_P); \
465 /* Fill a character type glyph GLYPH from a glyph typedef FROM as
466 defined in lisp.h. */
468 #define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM) \
469 SET_CHAR_GLYPH ((GLYPH), \
470 GLYPH_CHAR ((FROM)), \
471 GLYPH_FACE ((FROM)), \
474 /* Construct a glyph code from a character glyph GLYPH. If the
475 character is multibyte, return -1 as we can't use glyph table for a
476 multibyte character. */
478 #define SET_GLYPH_FROM_CHAR_GLYPH(G, GLYPH) \
481 if ((GLYPH).u.ch < 256) \
482 SET_GLYPH ((G), (GLYPH).u.ch, ((GLYPH).face_id)); \
484 SET_GLYPH ((G), -1, 0); \
488 #define GLYPH_INVALID_P(GLYPH) (GLYPH_CHAR (GLYPH) < 0)
490 /* Is GLYPH a padding glyph? */
492 #define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p
497 /***********************************************************************
499 ***********************************************************************/
503 Glyph memory for frame-based redisplay is allocated from the heap
504 in one vector kept in a glyph pool structure which is stored with
505 the frame. The size of the vector is made large enough to cover
506 all windows on the frame.
508 Both frame and window glyph matrices reference memory from a glyph
509 pool in frame-based redisplay.
511 In window-based redisplay, no glyphs pools exist; windows allocate
512 and free their glyph memory themselves. */
516 /* Vector of glyphs allocated from the heap. */
517 struct glyph
*glyphs
;
519 /* Allocated size of `glyphs'. */
522 /* Number of rows and columns in a matrix. */
528 /***********************************************************************
530 ***********************************************************************/
534 Three kinds of glyph matrices exist:
536 1. Frame glyph matrices. These are used for terminal frames whose
537 redisplay needs a view of the whole screen due to limited terminal
538 capabilities. Frame matrices are used only in the update phase
539 of redisplay. They are built in update_frame and not used after
540 the update has been performed.
542 2. Window glyph matrices on frames having frame glyph matrices.
543 Such matrices are sub-matrices of their corresponding frame matrix,
544 i.e. frame glyph matrices and window glyph matrices share the same
545 glyph memory which is allocated in form of a glyph_pool structure.
546 Glyph rows in such a window matrix are slices of frame matrix rows.
548 2. Free-standing window glyph matrices managing their own glyph
549 storage. This form is used in window-based redisplay which
550 includes variable width and height fonts etc.
552 The size of a window's row vector depends on the height of fonts
553 defined on its frame. It is chosen so that the vector is large
554 enough to describe all lines in a window when it is displayed in
555 the smallest possible character size. When new fonts are loaded,
556 or window sizes change, the row vector is adjusted accordingly. */
560 /* The pool from which glyph memory is allocated, if any. This is
561 null for frame matrices and for window matrices managing their
563 struct glyph_pool
*pool
;
565 /* Vector of glyph row structures. The row at nrows - 1 is reserved
566 for the mode line. */
567 struct glyph_row
*rows
;
569 /* Number of elements allocated for the vector rows above. */
572 /* The number of rows used by the window if all lines were displayed
573 with the smallest possible character height. */
576 /* Origin within the frame matrix if this is a window matrix on a
577 frame having a frame matrix. Both values are zero for
578 window-based redisplay. */
579 int matrix_x
, matrix_y
;
581 /* Width and height of the matrix in columns and rows. */
582 int matrix_w
, matrix_h
;
584 /* If this structure describes a window matrix of window W,
585 window_left_col is the value of W->left_col, window_top_line the
586 value of W->top_line, window_height and window_width are width and
587 height of W, as returned by window_box, and window_vscroll is the
588 value of W->vscroll at the time the matrix was last adjusted.
589 Only set for window-based redisplay. */
590 int window_left_col
, window_top_line
;
591 int window_height
, window_width
;
594 /* Number of glyphs reserved for left and right marginal areas when
595 the matrix was last adjusted. */
596 int left_margin_glyphs
, right_margin_glyphs
;
598 /* Flag indicating that scrolling should not be tried in
599 update_window. This flag is set by functions like try_window_id
600 which do their own scrolling. */
601 unsigned no_scrolling_p
: 1;
603 /* Non-zero means window displayed in this matrix has a top mode
605 unsigned header_line_p
: 1;
608 /* A string identifying the method used to display the matrix. */
612 /* The buffer this matrix displays. Set in
613 mark_window_display_accurate_1. */
614 struct buffer
*buffer
;
616 /* Values of BEGV and ZV as of last redisplay. Set in
617 mark_window_display_accurate_1. */
622 /* Check that glyph pointers stored in glyph rows of MATRIX are okay.
623 This aborts if any pointer is found twice. */
626 void check_matrix_pointer_lossage
P_ ((struct glyph_matrix
*));
627 #define CHECK_MATRIX(MATRIX) check_matrix_pointer_lossage ((MATRIX))
629 #define CHECK_MATRIX(MATRIX) (void) 0
634 /***********************************************************************
636 ***********************************************************************/
638 /* Area in window glyph matrix. If values are added or removed, the
639 function mark_object in alloc.c has to be changed. */
650 /* Rows of glyphs in a windows or frame glyph matrix.
652 Each row is partitioned into three areas. The start and end of
653 each area is recorded in a pointer as shown below.
655 +--------------------+-------------+---------------------+
656 | left margin area | text area | right margin area |
657 +--------------------+-------------+---------------------+
659 glyphs[LEFT_MARGIN_AREA] glyphs[RIGHT_MARGIN_AREA]
664 Rows in frame matrices reference glyph memory allocated in a frame
665 glyph pool (see the description of struct glyph_pool). Rows in
666 window matrices on frames having frame matrices reference slices of
667 the glyphs of corresponding rows in the frame matrix.
669 Rows in window matrices on frames having no frame matrices point to
670 glyphs allocated from the heap via xmalloc;
671 glyphs[LEFT_MARGIN_AREA] is the start address of the allocated
672 glyph structure array. */
676 /* Pointers to beginnings of areas. The end of an area A is found at
677 A + 1 in the vector. The last element of the vector is the end
680 Kludge alert: Even if used[TEXT_AREA] == 0, glyphs[TEXT_AREA][0]'s
681 position field is used. It is -1 if this row does not correspond
682 to any text; it is some buffer position if the row corresponds to
683 an empty display line that displays a line end. This is what old
684 redisplay used to do. (Except in code for terminal frames, this
685 kludge is no longer used, I believe. --gerd).
687 See also start, end, displays_text_p and ends_at_zv_p for cleaner
688 ways to do it. The special meaning of positions 0 and -1 will be
689 removed some day, so don't use it in new code. */
690 struct glyph
*glyphs
[1 + LAST_AREA
];
692 /* Number of glyphs actually filled in areas. */
693 short used
[LAST_AREA
];
695 /* Window-relative x and y-position of the top-left corner of this
696 row. If y < 0, this means that eabs (y) pixels of the row are
697 invisible because it is partially visible at the top of a window.
698 If x < 0, this means that eabs (x) pixels of the first glyph of
699 the text area of the row are invisible because the glyph is
700 partially visible. */
703 /* Width of the row in pixels without taking face extension at the
704 end of the row into account, and without counting truncation
705 and continuation glyphs at the end of a row on ttys. */
708 /* Logical ascent/height of this line. The value of ascent is zero
709 and height is 1 on terminal frames. */
712 /* Physical ascent/height of this line. If max_ascent > ascent,
713 this line overlaps the line above it on the display. Otherwise,
714 if max_height > height, this line overlaps the line beneath it. */
715 int phys_ascent
, phys_height
;
717 /* Portion of row that is visible. Partially visible rows may be
718 found at the top and bottom of a window. This is 1 for tty
719 frames. It may be < 0 in case of completely invisible rows. */
722 /* Extra line spacing added after this row. Do not consider this
723 in last row when checking if row is fully visible. */
724 int extra_line_spacing
;
726 /* Hash code. This hash code is available as soon as the row
727 is constructed, i.e. after a call to display_line. */
730 /* First position in this row. This is the text position, including
731 overlay position information etc, where the display of this row
732 started, and can thus be less the position of the first glyph
733 (e.g. due to invisible text or horizontal scrolling). */
734 struct display_pos start
;
736 /* Text position at the end of this row. This is the position after
737 the last glyph on this row. It can be greater than the last
738 glyph position + 1, due to truncation, invisible text etc. In an
739 up-to-date display, this should always be equal to the start
740 position of the next row. */
741 struct display_pos end
;
743 /* Non-zero means the overlay arrow bitmap is on this line.
744 -1 means use default overlay arrow bitmap, else
745 it specifies actual fringe bitmap number. */
746 int overlay_arrow_bitmap
;
748 /* Left fringe bitmap number (enum fringe_bitmap_type). */
749 unsigned left_user_fringe_bitmap
: FRINGE_ID_BITS
;
751 /* Right fringe bitmap number (enum fringe_bitmap_type). */
752 unsigned right_user_fringe_bitmap
: FRINGE_ID_BITS
;
754 /* Left fringe bitmap number (enum fringe_bitmap_type). */
755 unsigned left_fringe_bitmap
: FRINGE_ID_BITS
;
757 /* Right fringe bitmap number (enum fringe_bitmap_type). */
758 unsigned right_fringe_bitmap
: FRINGE_ID_BITS
;
760 /* Face of the left fringe glyph. */
761 unsigned left_user_fringe_face_id
: FACE_ID_BITS
;
763 /* Face of the right fringe glyph. */
764 unsigned right_user_fringe_face_id
: FACE_ID_BITS
;
766 /* Face of the left fringe glyph. */
767 unsigned left_fringe_face_id
: FACE_ID_BITS
;
769 /* Face of the right fringe glyph. */
770 unsigned right_fringe_face_id
: FACE_ID_BITS
;
772 /* 1 means that we must draw the bitmaps of this row. */
773 unsigned redraw_fringe_bitmaps_p
: 1;
775 /* In a desired matrix, 1 means that this row must be updated. In a
776 current matrix, 0 means that the row has been invalidated, i.e.
777 the row's contents do not agree with what is visible on the
779 unsigned enabled_p
: 1;
781 /* 1 means row displays a text line that is truncated on the left or
783 unsigned truncated_on_left_p
: 1;
784 unsigned truncated_on_right_p
: 1;
786 /* 1 means that this row displays a continued line, i.e. it has a
787 continuation mark at the right side. */
788 unsigned continued_p
: 1;
790 /* 0 means that this row does not contain any text, i.e. it is
791 a blank line at the window and buffer end. */
792 unsigned displays_text_p
: 1;
794 /* 1 means that this line ends at ZV. */
795 unsigned ends_at_zv_p
: 1;
797 /* 1 means the face of the last glyph in the text area is drawn to
798 the right end of the window. This flag is used in
799 update_text_area to optimize clearing to the end of the area. */
800 unsigned fill_line_p
: 1;
802 /* Non-zero means display a bitmap on X frames indicating that this
803 line contains no text and ends in ZV. */
804 unsigned indicate_empty_line_p
: 1;
806 /* 1 means this row contains glyphs that overlap each other because
807 of lbearing or rbearing. */
808 unsigned contains_overlapping_glyphs_p
: 1;
810 /* 1 means this row is as wide as the window it is displayed in, including
811 scroll bars, fringes, and internal borders. This also
812 implies that the row doesn't have marginal areas. */
813 unsigned full_width_p
: 1;
815 /* Non-zero means row is a mode or header-line. */
816 unsigned mode_line_p
: 1;
818 /* 1 in a current row means this row is overlapped by another row. */
819 unsigned overlapped_p
: 1;
821 /* 1 means this line ends in the middle of a character consisting
822 of more than one glyph. Some glyphs have been put in this row,
823 the rest are put in rows below this one. */
824 unsigned ends_in_middle_of_char_p
: 1;
826 /* 1 means this line starts in the middle of a character consisting
827 of more than one glyph. Some glyphs have been put in the
828 previous row, the rest are put in this row. */
829 unsigned starts_in_middle_of_char_p
: 1;
831 /* 1 in a current row means this row overlaps others. */
832 unsigned overlapping_p
: 1;
834 /* 1 means some glyphs in this row are displayed in mouse-face. */
835 unsigned mouse_face_p
: 1;
837 /* 1 means this row was ended by a newline from a string. */
838 unsigned ends_in_newline_from_string_p
: 1;
840 /* 1 means this row width is exactly the width of the window, and the
841 final newline character is hidden in the right fringe. */
842 unsigned exact_window_width_line_p
: 1;
844 /* 1 means this row currently shows the cursor in the right fringe. */
845 unsigned cursor_in_fringe_p
: 1;
847 /* 1 means the last glyph in the row is part of an ellipsis. */
848 unsigned ends_in_ellipsis_p
: 1;
850 /* Non-zero means display a bitmap on X frames indicating that this
851 the first line of the buffer. */
852 unsigned indicate_bob_p
: 1;
854 /* Non-zero means display a bitmap on X frames indicating that this
855 the top line of the window, but not start of the buffer. */
856 unsigned indicate_top_line_p
: 1;
858 /* Non-zero means display a bitmap on X frames indicating that this
859 the last line of the buffer. */
860 unsigned indicate_eob_p
: 1;
862 /* Non-zero means display a bitmap on X frames indicating that this
863 the bottom line of the window, but not end of the buffer. */
864 unsigned indicate_bottom_line_p
: 1;
866 /* Continuation lines width at the start of the row. */
867 int continuation_lines_width
;
869 #ifdef HAVE_WINDOW_SYSTEM
870 /* Non-NULL means the current clipping area. This is temporarily
871 set while exposing a region. Coordinates are frame-relative. */
877 /* Get a pointer to row number ROW in matrix MATRIX. If GLYPH_DEBUG
878 is defined to a non-zero value, the function matrix_row checks that
879 we don't try to access rows that are out of bounds. */
882 struct glyph_row
*matrix_row
P_ ((struct glyph_matrix
*, int));
883 #define MATRIX_ROW(MATRIX, ROW) matrix_row ((MATRIX), (ROW))
885 #define MATRIX_ROW(MATRIX, ROW) ((MATRIX)->rows + (ROW))
888 /* Return a pointer to the row reserved for the mode line in MATRIX.
889 Row MATRIX->nrows - 1 is always reserved for the mode line. */
891 #define MATRIX_MODE_LINE_ROW(MATRIX) \
892 ((MATRIX)->rows + (MATRIX)->nrows - 1)
894 /* Return a pointer to the row reserved for the header line in MATRIX.
895 This is always the first row in MATRIX because that's the only
896 way that works in frame-based redisplay. */
898 #define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows
900 /* Return a pointer to first row in MATRIX used for text display. */
902 #define MATRIX_FIRST_TEXT_ROW(MATRIX) \
903 ((MATRIX)->rows->mode_line_p ? (MATRIX)->rows + 1 : (MATRIX)->rows)
905 /* Return a pointer to the first glyph in the text area of a row.
906 MATRIX is the glyph matrix accessed, and ROW is the row index in
909 #define MATRIX_ROW_GLYPH_START(MATRIX, ROW) \
910 (MATRIX_ROW ((MATRIX), (ROW))->glyphs[TEXT_AREA])
912 /* Return the number of used glyphs in the text area of a row. */
914 #define MATRIX_ROW_USED(MATRIX, ROW) \
915 (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA])
917 /* Return the character/ byte position at which the display of ROW
920 #define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->start.pos.charpos)
921 #define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->start.pos.bytepos)
923 /* Return the character/ byte position at which ROW ends. */
925 #define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->end.pos.charpos)
926 #define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->end.pos.bytepos)
928 /* Return the vertical position of ROW in MATRIX. */
930 #define MATRIX_ROW_VPOS(ROW, MATRIX) ((ROW) - (MATRIX)->rows)
932 /* Return the last glyph row + 1 in MATRIX on window W reserved for
933 text. If W has a mode line, the last row in the matrix is reserved
936 #define MATRIX_BOTTOM_TEXT_ROW(MATRIX, W) \
939 - (WINDOW_WANTS_MODELINE_P ((W)) ? 1 : 0))
941 /* Non-zero if the face of the last glyph in ROW's text area has
942 to be drawn to the end of the text area. */
944 #define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)
946 /* Set and query the enabled_p flag of glyph row ROW in MATRIX. */
948 #define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
949 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0)
951 #define MATRIX_ROW_ENABLED_P(MATRIX, ROW) \
952 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p)
954 /* Non-zero if ROW displays text. Value is non-zero if the row is
955 blank but displays a line end. */
957 #define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)
962 #define MR_PARTIALLY_VISIBLE(ROW) \
963 ((ROW)->height != (ROW)->visible_height)
965 #define MR_PARTIALLY_VISIBLE_AT_TOP(W, ROW) \
966 ((ROW)->y < WINDOW_HEADER_LINE_HEIGHT ((W)))
968 #define MR_PARTIALLY_VISIBLE_AT_BOTTOM(W, ROW) \
969 (((ROW)->y + (ROW)->height - (ROW)->extra_line_spacing) \
970 > WINDOW_BOX_HEIGHT_NO_MODE_LINE ((W)))
972 /* Non-zero if ROW is not completely visible in window W. */
974 #define MATRIX_ROW_PARTIALLY_VISIBLE_P(W, ROW) \
975 (MR_PARTIALLY_VISIBLE ((ROW)) \
976 && (MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)) \
977 || MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW))))
981 /* Non-zero if ROW is partially visible at the top of window W. */
983 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW) \
984 (MR_PARTIALLY_VISIBLE ((ROW)) \
985 && MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)))
987 /* Non-zero if ROW is partially visible at the bottom of window W. */
989 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW) \
990 (MR_PARTIALLY_VISIBLE ((ROW)) \
991 && MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW)))
993 /* Return the bottom Y + 1 of ROW. */
995 #define MATRIX_ROW_BOTTOM_Y(ROW) ((ROW)->y + (ROW)->height)
997 /* Is ROW the last visible one in the display described by the
998 iterator structure pointed to by IT?. */
1000 #define MATRIX_ROW_LAST_VISIBLE_P(ROW, IT) \
1001 (MATRIX_ROW_BOTTOM_Y ((ROW)) >= (IT)->last_visible_y)
1003 /* Non-zero if ROW displays a continuation line. */
1005 #define MATRIX_ROW_CONTINUATION_LINE_P(ROW) \
1006 ((ROW)->continuation_lines_width > 0)
1008 /* Non-zero if ROW ends in the middle of a character. This is the
1009 case for continued lines showing only part of a display table entry
1010 or a control char, or an overlay string. */
1012 #define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW) \
1013 ((ROW)->end.dpvec_index > 0 \
1014 || (ROW)->end.overlay_string_index >= 0 \
1015 || (ROW)->ends_in_middle_of_char_p)
1017 /* Non-zero if ROW ends in the middle of an overlay string. */
1019 #define MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P(ROW) \
1020 ((ROW)->end.overlay_string_index >= 0)
1022 /* Non-zero if ROW starts in the middle of a character. See above. */
1024 #define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW) \
1025 ((ROW)->start.dpvec_index > 0 \
1026 || (ROW)->starts_in_middle_of_char_p \
1027 || ((ROW)->start.overlay_string_index >= 0 \
1028 && (ROW)->start.string_pos.charpos > 0))
1030 /* Non-zero means ROW overlaps its predecessor. */
1032 #define MATRIX_ROW_OVERLAPS_PRED_P(ROW) \
1033 ((ROW)->phys_ascent > (ROW)->ascent)
1035 /* Non-zero means ROW overlaps its successor. */
1037 #define MATRIX_ROW_OVERLAPS_SUCC_P(ROW) \
1038 ((ROW)->phys_height - (ROW)->phys_ascent \
1039 > (ROW)->height - (ROW)->ascent)
1041 /* Non-zero means that fonts have been loaded since the last glyph
1042 matrix adjustments. The function redisplay_internal adjusts glyph
1043 matrices when this flag is non-zero. */
1045 extern int fonts_changed_p
;
1047 /* A glyph for a space. */
1049 extern struct glyph space_glyph
;
1051 /* Window being updated by update_window. This is non-null as long as
1052 update_window has not finished, and null otherwise. */
1054 extern struct window
*updated_window
;
1056 /* Glyph row and area updated by update_window_line. */
1058 extern struct glyph_row
*updated_row
;
1059 extern int updated_area
;
1061 /* Non-zero means reading single-character input with prompt so put
1062 cursor on mini-buffer after the prompt. Positive means at end of
1063 text in echo area; negative means at beginning of line. */
1065 extern int cursor_in_echo_area
;
1067 /* Non-zero means last display completed. Zero means it was
1070 extern int display_completed
;
1072 /* Non-zero means redisplay has been performed directly (see also
1073 direct_output_for_insert and direct_output_forward_char), so that
1074 no further updating has to be performed. The function
1075 redisplay_internal checks this flag, and does nothing but reset it
1076 to zero if it is non-zero. */
1078 extern int redisplay_performed_directly_p
;
1080 /* A temporary storage area, including a row of glyphs. Initialized
1081 in xdisp.c. Used for various purposes, as an example see
1082 direct_output_for_insert. */
1084 extern struct glyph_row scratch_glyph_row
;
1088 /************************************************************************
1090 ************************************************************************/
1092 /* Enumeration for overriding/changing the face to use for drawing
1093 glyphs in draw_glyphs. */
1095 enum draw_glyphs_face
1105 #ifdef HAVE_WINDOW_SYSTEM
1107 /* A sequence of glyphs to be drawn in the same face. */
1111 /* X-origin of the string. */
1114 /* Y-origin and y-position of the base line of this string. */
1117 /* The width of the string, not including a face extension. */
1120 /* The width of the string, including a face extension. */
1121 int background_width
;
1123 /* The height of this string. This is the height of the line this
1124 string is drawn in, and can be different from the height of the
1125 font the string is drawn in. */
1128 /* Number of pixels this string overwrites in front of its x-origin.
1129 This number is zero if the string has an lbearing >= 0; it is
1130 -lbearing, if the string has an lbearing < 0. */
1133 /* Number of pixels this string overwrites past its right-most
1134 nominal x-position, i.e. x + width. Zero if the string's
1135 rbearing is <= its nominal width, rbearing - width otherwise. */
1138 /* The frame on which the glyph string is drawn. */
1141 /* The window on which the glyph string is drawn. */
1144 /* X display and window for convenience. */
1148 /* The glyph row for which this string was built. It determines the
1149 y-origin and height of the string. */
1150 struct glyph_row
*row
;
1152 /* The area within row. */
1153 enum glyph_row_area area
;
1155 /* Characters to be drawn, and number of characters. */
1159 /* A face-override for drawing cursors, mouse face and similar. */
1160 enum draw_glyphs_face hl
;
1162 /* Face in which this string is to be drawn. */
1165 /* Font in which this string is to be drawn. */
1168 /* Non-null means this string describes (part of) a composition.
1169 All characters from char2b are drawn composed. */
1170 struct composition
*cmp
;
1172 /* Index of this glyph string's first character in the glyph
1173 definition of CMP. If this is zero, this glyph string describes
1174 the first character of a composition. */
1177 /* 1 means this glyph strings face has to be drawn to the right end
1178 of the window's drawing area. */
1179 unsigned extends_to_end_of_line_p
: 1;
1181 /* 1 means the background of this string has been drawn. */
1182 unsigned background_filled_p
: 1;
1184 /* 1 means glyph string must be drawn with 16-bit functions. */
1185 unsigned two_byte_p
: 1;
1187 /* 1 means that the original font determined for drawing this glyph
1188 string could not be loaded. The member `font' has been set to
1189 the frame's default font in this case. */
1190 unsigned font_not_found_p
: 1;
1192 /* 1 means that the face in which this glyph string is drawn has a
1194 unsigned stippled_p
: 1;
1196 #define OVERLAPS_PRED (1 << 0)
1197 #define OVERLAPS_SUCC (1 << 1)
1198 #define OVERLAPS_BOTH (OVERLAPS_PRED | OVERLAPS_SUCC)
1199 #define OVERLAPS_ERASED_CURSOR (1 << 2)
1200 /* Non-zero means only the foreground of this glyph string must be
1201 drawn, and we should use the physical height of the line this
1202 glyph string appears in as clip rect. If the value is
1203 OVERLAPS_ERASED_CURSOR, the clip rect is restricted to the rect
1204 of the erased cursor. OVERLAPS_PRED and OVERLAPS_SUCC mean we
1205 draw overlaps with the preceding and the succeeding rows,
1207 unsigned for_overlaps
: 3;
1209 /* 1 means that all glyphs in this glyph string has the flag
1210 padding_p set, and thus must be drawn one by one to have 1-pixel
1211 width even though the logical width in the font is zero. */
1212 unsigned padding_p
: 1;
1214 /* The GC to use for drawing this glyph string. */
1215 #if defined(HAVE_X_WINDOWS)
1218 #if defined(HAVE_NTGUI)
1223 /* A pointer to the first glyph in the string. This glyph
1224 corresponds to char2b[0]. Needed to draw rectangles if
1225 font_not_found_p is 1. */
1226 struct glyph
*first_glyph
;
1228 /* Image, if any. */
1232 struct glyph_slice slice
;
1234 /* Non-null means the horizontal clipping region starts from the
1235 left edge of *clip_head, and ends with the right edge of
1236 *clip_tail, not including their overhangs. */
1237 struct glyph_string
*clip_head
, *clip_tail
;
1239 /* The current clipping areas. */
1240 NativeRectangle clip
[2];
1242 /* Number of clipping areas. */
1245 int underline_position
;
1247 int underline_thickness
;
1249 struct glyph_string
*next
, *prev
;
1252 #endif /* HAVE_WINDOW_SYSTEM */
1255 /************************************************************************
1257 ************************************************************************/
1259 /* Return the height of the mode line in glyph matrix MATRIX, or zero
1260 if not known. This macro is called under circumstances where
1261 MATRIX might not have been allocated yet. */
1263 #define MATRIX_MODE_LINE_HEIGHT(MATRIX) \
1264 ((MATRIX) && (MATRIX)->rows \
1265 ? MATRIX_MODE_LINE_ROW (MATRIX)->height \
1268 /* Return the height of the header line in glyph matrix MATRIX, or zero
1269 if not known. This macro is called under circumstances where
1270 MATRIX might not have been allocated yet. */
1272 #define MATRIX_HEADER_LINE_HEIGHT(MATRIX) \
1273 ((MATRIX) && (MATRIX)->rows \
1274 ? MATRIX_HEADER_LINE_ROW (MATRIX)->height \
1277 /* Return the desired face id for the mode line of a window, depending
1278 on whether the window is selected or not, or if the window is the
1279 scrolling window for the currently active minibuffer window.
1281 Due to the way display_mode_lines manipulates with the contents of
1282 selected_window, this macro needs three arguments: SELW which is
1283 compared against the current value of selected_window, MBW which is
1284 compared against minibuf_window (if SELW doesn't match), and SCRW
1285 which is compared against minibuf_selected_window (if MBW matches). */
1287 #define CURRENT_MODE_LINE_FACE_ID_3(SELW, MBW, SCRW) \
1288 ((!mode_line_in_non_selected_windows \
1289 || (SELW) == XWINDOW (selected_window) \
1290 || (minibuf_level > 0 \
1291 && !NILP (minibuf_selected_window) \
1292 && (MBW) == XWINDOW (minibuf_window) \
1293 && (SCRW) == XWINDOW (minibuf_selected_window))) \
1294 ? MODE_LINE_FACE_ID \
1295 : MODE_LINE_INACTIVE_FACE_ID)
1298 /* Return the desired face id for the mode line of window W. */
1300 #define CURRENT_MODE_LINE_FACE_ID(W) \
1301 (CURRENT_MODE_LINE_FACE_ID_3((W), XWINDOW (selected_window), (W)))
1303 /* Return the current height of the mode line of window W. If not
1304 known from current_mode_line_height, look at W's current glyph
1305 matrix, or return a default based on the height of the font of the
1306 face `mode-line'. */
1308 #define CURRENT_MODE_LINE_HEIGHT(W) \
1309 (current_mode_line_height >= 0 \
1310 ? current_mode_line_height \
1311 : (MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1312 ? MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1313 : estimate_mode_line_height (XFRAME ((W)->frame), \
1314 CURRENT_MODE_LINE_FACE_ID (W))))
1316 /* Return the current height of the header line of window W. If not
1317 known from current_header_line_height, look at W's current glyph
1318 matrix, or return an estimation based on the height of the font of
1319 the face `header-line'. */
1321 #define CURRENT_HEADER_LINE_HEIGHT(W) \
1322 (current_header_line_height >= 0 \
1323 ? current_header_line_height \
1324 : (MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1325 ? MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1326 : estimate_mode_line_height (XFRAME ((W)->frame), \
1327 HEADER_LINE_FACE_ID)))
1329 /* Return the height of the desired mode line of window W. */
1331 #define DESIRED_MODE_LINE_HEIGHT(W) \
1332 MATRIX_MODE_LINE_HEIGHT ((W)->desired_matrix)
1334 /* Return the height of the desired header line of window W. */
1336 #define DESIRED_HEADER_LINE_HEIGHT(W) \
1337 MATRIX_HEADER_LINE_HEIGHT ((W)->desired_matrix)
1339 /* Value is non-zero if window W wants a mode line. */
1341 #define WINDOW_WANTS_MODELINE_P(W) \
1342 (!MINI_WINDOW_P ((W)) \
1343 && !(W)->pseudo_window_p \
1344 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1345 && BUFFERP ((W)->buffer) \
1346 && !NILP (XBUFFER ((W)->buffer)->mode_line_format) \
1347 && WINDOW_TOTAL_LINES (W) > 1)
1349 /* Value is non-zero if window W wants a header line. */
1351 #define WINDOW_WANTS_HEADER_LINE_P(W) \
1352 (!MINI_WINDOW_P ((W)) \
1353 && !(W)->pseudo_window_p \
1354 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1355 && BUFFERP ((W)->buffer) \
1356 && !NILP (XBUFFER ((W)->buffer)->header_line_format) \
1357 && WINDOW_TOTAL_LINES (W) > 1 + !NILP (XBUFFER ((W)->buffer)->mode_line_format))
1360 /* Return proper value to be used as baseline offset of font that has
1361 ASCENT and DESCENT to draw characters by the font at the vertical
1362 center of the line of frame F.
1364 Here, our task is to find the value of BOFF in the following figure;
1366 -------------------------+-----------+-
1367 -+-+---------+-+ | |
1369 | | | | F_ASCENT F_HEIGHT
1372 | | |-|-+------+-----------|------- baseline
1374 | |---------|-+-+ | |
1376 -+-+---------+-+ F_DESCENT |
1377 -------------------------+-----------+-
1379 -BOFF + DESCENT + (F_HEIGHT - HEIGHT) / 2 = F_DESCENT
1380 BOFF = DESCENT + (F_HEIGHT - HEIGHT) / 2 - F_DESCENT
1381 DESCENT = FONT->descent
1382 HEIGHT = FONT_HEIGHT (FONT)
1383 F_DESCENT = (FRAME_FONT (F)->descent
1384 - F->terminal->output_data.x->baseline_offset)
1385 F_HEIGHT = FRAME_LINE_HEIGHT (F)
1388 #define VCENTER_BASELINE_OFFSET(FONT, F) \
1389 (FONT_DESCENT (FONT) \
1390 + (FRAME_LINE_HEIGHT ((F)) - FONT_HEIGHT ((FONT)) \
1391 + (FRAME_LINE_HEIGHT ((F)) > FONT_HEIGHT ((FONT)))) / 2 \
1392 - (FONT_DESCENT (FRAME_FONT (F)) - FRAME_BASELINE_OFFSET (F)))
1395 /***********************************************************************
1397 ***********************************************************************/
1399 /* Indices of face attributes in Lisp face vectors. Slot zero is the
1402 enum lface_attribute_index
1404 LFACE_FAMILY_INDEX
= 1,
1405 LFACE_FOUNDRY_INDEX
,
1410 LFACE_UNDERLINE_INDEX
,
1411 LFACE_INVERSE_INDEX
,
1412 LFACE_FOREGROUND_INDEX
,
1413 LFACE_BACKGROUND_INDEX
,
1414 LFACE_STIPPLE_INDEX
,
1415 LFACE_OVERLINE_INDEX
,
1416 LFACE_STRIKE_THROUGH_INDEX
,
1419 LFACE_INHERIT_INDEX
,
1420 LFACE_FONTSET_INDEX
,
1425 /* Box types of faces. */
1429 /* No box around text. */
1432 /* Simple box of specified width and color. Default width is 1, and
1433 default color is the foreground color of the face. */
1436 /* Boxes with 3D shadows. Color equals the background color of the
1437 face. Width is specified. */
1443 /* Structure describing a realized face.
1445 For each Lisp face, 0..N realized faces can exist for different
1446 frames and different charsets. Realized faces are built from Lisp
1447 faces and text properties/overlays by merging faces and adding
1448 unspecified attributes from the `default' face. */
1452 /* The id of this face. The id equals the index of this face in the
1453 vector faces_by_id of its face cache. */
1456 #ifdef HAVE_WINDOW_SYSTEM
1458 /* If non-zero, this is a GC that we can use without modification for
1459 drawing the characters in this face. */
1462 /* Background stipple or bitmap used for this face. This is
1463 an id as returned from load_pixmap. */
1466 #else /* not HAVE_WINDOW_SYSTEM */
1471 #endif /* not HAVE_WINDOW_SYSTEM */
1473 /* Pixel value of foreground color for X frames. Color index
1475 unsigned long foreground
;
1477 /* Pixel value or color index of background color. */
1478 unsigned long background
;
1480 /* Pixel value or color index of underline color. */
1481 unsigned long underline_color
;
1483 /* Pixel value or color index of overlined, strike-through, or box
1485 unsigned long overline_color
;
1486 unsigned long strike_through_color
;
1487 unsigned long box_color
;
1491 /* Fontset ID if for this face's fontset. Non-ASCII faces derived
1492 from the same ASCII face have the same fontset. */
1495 /* Pixmap width and height. */
1496 unsigned int pixmap_w
, pixmap_h
;
1498 /* Non-zero means characters in this face have a box that thickness
1499 around them. If it is negative, the absolute value indicates the
1500 thickness, and the horizontal lines of box (top and bottom) are
1501 drawn inside of characters glyph area. The vertical lines of box
1502 (left and right) are drawn as the same way as the case that this
1503 value is positive. */
1506 /* Type of box drawn. A value of FACE_NO_BOX means no box is drawn
1507 around text in this face. A value of FACE_SIMPLE_BOX means a box
1508 of width box_line_width is drawn in color box_color. A value of
1509 FACE_RAISED_BOX or FACE_SUNKEN_BOX means a 3D box is drawn with
1510 shadow colors derived from the background color of the face. */
1511 enum face_box_type box
;
1513 /* If `box' above specifies a 3D type, 1 means use box_color for
1515 unsigned use_box_color_for_shadows_p
: 1;
1517 /* The Lisp face attributes this face realizes. All attributes
1518 in this vector are non-nil. */
1519 Lisp_Object lface
[LFACE_VECTOR_SIZE
];
1521 /* The hash value of this face. */
1524 /* Non-zero if text in this face should be underlined, overlined,
1525 strike-through or have a box drawn around it. */
1526 unsigned underline_p
: 1;
1527 unsigned overline_p
: 1;
1528 unsigned strike_through_p
: 1;
1530 /* 1 means that the colors specified for this face could not be
1531 loaded, and were replaced by default colors, so they shouldn't be
1533 unsigned foreground_defaulted_p
: 1;
1534 unsigned background_defaulted_p
: 1;
1536 /* 1 means that either no color is specified for underlining or that
1537 the specified color couldn't be loaded. Use the foreground
1538 color when drawing in that case. */
1539 unsigned underline_defaulted_p
: 1;
1541 /* 1 means that either no color is specified for the corresponding
1542 attribute or that the specified color couldn't be loaded.
1543 Use the foreground color when drawing in that case. */
1544 unsigned overline_color_defaulted_p
: 1;
1545 unsigned strike_through_color_defaulted_p
: 1;
1546 unsigned box_color_defaulted_p
: 1;
1548 /* TTY appearances. Blinking is not yet implemented. Colors are
1549 found in `lface' with empty color string meaning the default
1550 color of the TTY. */
1551 unsigned tty_bold_p
: 1;
1552 unsigned tty_dim_p
: 1;
1553 unsigned tty_underline_p
: 1;
1554 unsigned tty_alt_charset_p
: 1;
1555 unsigned tty_reverse_p
: 1;
1556 unsigned tty_blinking_p
: 1;
1558 /* 1 means that colors of this face may not be freed because they
1559 have been copied bitwise from a base face (see
1561 unsigned colors_copied_bitwise_p
: 1;
1563 /* If non-zero, use overstrike (to simulate bold-face). */
1564 unsigned overstrike
: 1;
1566 /* NOTE: this is not used yet, but eventually this impl should be done
1567 similarly to overstrike */
1569 /* If non-zero, use geometric rotation (to simulate italic). */
1570 unsigned synth_ital
: 1;
1573 /* Next and previous face in hash collision list of face cache. */
1574 struct face
*next
, *prev
;
1576 /* If this face is an ASCII face, this points to this face itself.
1577 Otherwise, this points to an ASCII face that has the same
1578 attributes except the font. */
1579 struct face
*ascii_face
;
1581 /* Extra member that a font-driver uses privately. */
1586 /* Color index indicating that face uses a terminal's default color. */
1588 #define FACE_TTY_DEFAULT_COLOR ((unsigned long) -1)
1590 /* Color index indicating that face uses an unknown foreground color. */
1592 #define FACE_TTY_DEFAULT_FG_COLOR ((unsigned long) -2)
1594 /* Color index indicating that face uses an unknown background color. */
1596 #define FACE_TTY_DEFAULT_BG_COLOR ((unsigned long) -3)
1598 /* Non-zero if FACE was realized for unibyte use. */
1600 #define FACE_UNIBYTE_P(FACE) ((FACE)->charset < 0)
1603 /* IDs of important faces known by the C face code. These are the IDs
1604 of the faces for CHARSET_ASCII. */
1610 MODE_LINE_INACTIVE_FACE_ID
,
1613 HEADER_LINE_FACE_ID
,
1619 VERTICAL_BORDER_FACE_ID
,
1620 BASIC_FACE_ID_SENTINEL
1623 #define MAX_FACE_ID ((1 << FACE_ID_BITS) - 1)
1625 /* A cache of realized faces. Each frame has its own cache because
1626 Emacs allows different frame-local face definitions. */
1630 /* Hash table of cached realized faces. */
1631 struct face
**buckets
;
1633 /* Back-pointer to the frame this cache belongs to. */
1636 /* A vector of faces so that faces can be referenced by an ID. */
1637 struct face
**faces_by_id
;
1639 /* The allocated size, and number of used slots of faces_by_id. */
1642 /* Flag indicating that attributes of the `menu' face have been
1644 unsigned menu_face_changed_p
: 1;
1648 /* Prepare face FACE for use on frame F. This must be called before
1649 using X resources of FACE. */
1651 #define PREPARE_FACE_FOR_DISPLAY(F, FACE) \
1652 if ((FACE)->gc == 0) \
1653 prepare_face_for_display ((F), (FACE)); \
1657 /* Return a pointer to the face with ID on frame F, or null if such a
1658 face doesn't exist. */
1660 #define FACE_FROM_ID(F, ID) \
1661 (((unsigned) (ID) < FRAME_FACE_CACHE (F)->used) \
1662 ? FRAME_FACE_CACHE (F)->faces_by_id[ID] \
1665 #ifdef HAVE_WINDOW_SYSTEM
1667 /* Non-zero if FACE is suitable for displaying character CHAR. */
1669 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) \
1670 (ASCII_CHAR_P (CHAR) \
1671 ? (FACE) == (FACE)->ascii_face \
1672 : face_suitable_for_char_p ((FACE), (CHAR)))
1674 /* Return the id of the realized face on frame F that is like the face
1675 with id ID but is suitable for displaying character CHAR.
1676 This macro is only meaningful for multibyte character CHAR. */
1678 #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) \
1679 (ASCII_CHAR_P (CHAR) \
1680 ? (FACE)->ascii_face->id \
1681 : face_for_char ((F), (FACE), (CHAR), (POS), (OBJECT)))
1683 #else /* not HAVE_WINDOW_SYSTEM */
1685 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) 1
1686 #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) ((FACE)->id)
1688 #endif /* not HAVE_WINDOW_SYSTEM */
1690 /* Non-zero means face attributes have been changed since the last
1691 redisplay. Used in redisplay_internal. */
1693 extern int face_change_count
;
1698 /***********************************************************************
1700 ***********************************************************************/
1702 /* Structure used to describe where and how to draw a fringe bitmap.
1703 WHICH is the fringe bitmap to draw. WD and H is the (adjusted)
1704 width and height of the bitmap, DH is the height adjustment (if
1705 bitmap is periodic). X and Y are frame coordinates of the area to
1706 display the bitmap, DY is relative offset of the bitmap into that
1707 area. BX, NX, BY, NY specifies the area to clear if the bitmap
1708 does not fill the entire area. FACE is the fringe face. */
1710 struct draw_fringe_bitmap_params
1712 int which
; /* enum fringe_bitmap_type */
1713 unsigned short *bits
;
1717 unsigned cursor_p
: 1;
1718 unsigned overlay_p
: 1;
1722 #define MAX_FRINGE_BITMAPS (1<<FRINGE_ID_BITS)
1725 /***********************************************************************
1727 ***********************************************************************/
1729 /* Iteration over things to display in current_buffer or in a string.
1731 The iterator handles:
1733 1. Overlay strings (after-string, before-string).
1735 3. Invisible text properties.
1736 4. Selective display.
1737 5. Translation of characters via display tables.
1738 6. Translation of control characters to the forms `\003' or `^C'.
1739 7. `glyph' and `space-width' properties.
1741 Iterators are initialized by calling init_iterator or one of the
1742 equivalent functions below. A call to get_next_display_element
1743 loads the iterator structure with information about what next to
1744 display. A call to set_iterator_to_next increments the iterator's
1747 Characters from overlay strings, display table entries or control
1748 character translations are returned one at a time. For example, if
1749 we have a text of `a\x01' where `a' has a display table definition
1750 of `cd' and the control character is displayed with a leading
1751 arrow, then the iterator will return:
1753 Call Return Source Call next
1754 -----------------------------------------------------------------
1755 next c display table move
1756 next d display table move
1757 next ^ control char move
1758 next A control char move
1760 The same mechanism is also used to return characters for ellipses
1761 displayed at the end of invisible text.
1763 CAVEAT: Under some circumstances, move_.* functions can be called
1764 asynchronously, e.g. when computing a buffer position from an x and
1765 y pixel position. This means that these functions and functions
1766 called from them SHOULD NOT USE xmalloc and alike. See also the
1767 comment at the start of xdisp.c. */
1769 /* Enumeration describing what kind of display element an iterator is
1770 loaded with after a call to get_next_display_element. */
1772 enum display_element_type
1774 /* A normal character. */
1777 /* A composition sequence. */
1783 /* A flexible width and height space. */
1786 /* End of buffer or string. */
1789 /* Truncation glyphs. Never returned by get_next_display_element.
1790 Used to get display information about truncation glyphs via
1794 /* Continuation glyphs. See the comment for IT_TRUNCATION. */
1799 /* An enumerator for each text property that has a meaning for display
1804 AUTO_COMPOSED_PROP_IDX
,
1809 COMPOSITION_PROP_IDX
,
1811 /* Not a property. Used to indicate changes in overlays. */
1818 /* An enumerator for the method of wrapping long lines. */
1820 enum line_wrap_method
1835 /* Input sources for fetching characters or data to display.
1836 The input source is found in the `method' field. */
1839 GET_FROM_BUFFER
= 0,
1840 GET_FROM_DISPLAY_VECTOR
,
1841 GET_FROM_COMPOSITION
,
1849 #define IT_STACK_SIZE 4
1853 /* The window in which we iterate over current_buffer (or a string). */
1857 /* The window's frame. */
1860 /* Method to use to load this structure with the next display element. */
1861 enum it_method method
;
1863 /* The next position at which to check for face changes, invisible
1864 text, overlay strings, end of text etc., which see. */
1867 /* Maximum string or buffer position + 1. ZV when iterating over
1871 /* C string to iterate over. Non-null means get characters from
1872 this string, otherwise characters are read from current_buffer
1876 /* Number of characters in the string (s, or it->string) we iterate
1880 /* Start and end of a visible region; -1 if the region is not
1881 visible in the window. */
1882 int region_beg_charpos
, region_end_charpos
;
1884 /* Position at which redisplay end trigger functions should be run. */
1885 int redisplay_end_trigger_charpos
;
1887 /* 1 means multibyte characters are enabled. */
1888 unsigned multibyte_p
: 1;
1890 /* 1 means window has a mode line at its top. */
1891 unsigned header_line_p
: 1;
1893 /* 1 means `string' is the value of a `display' property.
1894 Don't handle some `display' properties in these strings. */
1895 unsigned string_from_display_prop_p
: 1;
1897 /* When METHOD == next_element_from_display_vector,
1898 this is 1 if we're doing an ellipsis. Otherwise meaningless. */
1899 unsigned ellipsis_p
: 1;
1901 /* True means cursor shouldn't be displayed here. */
1902 unsigned avoid_cursor_p
: 1;
1904 /* Display table in effect or null for none. */
1905 struct Lisp_Char_Table
*dp
;
1907 /* Current display table vector to return characters from and its
1908 end. dpvec null means we are not returning characters from a
1909 display table entry; current.dpvec_index gives the current index
1910 into dpvec. This same mechanism is also used to return
1911 characters from translated control characters, i.e. `\003' or
1913 Lisp_Object
*dpvec
, *dpend
;
1915 /* Length in bytes of the char that filled dpvec. A value of zero
1916 means that no such character is involved. */
1919 /* Face id to use for all characters in display vector. -1 if unused. */
1922 /* Face id of the iterator saved in case a glyph from dpvec contains
1923 a face. The face is restored when all glyphs from dpvec have
1927 /* Vector of glyphs for control character translation. The pointer
1928 dpvec is set to ctl_chars when a control character is translated.
1929 This vector is also used for incomplete multibyte character
1930 translation (e.g \222\244). Such a character is at most 4 bytes,
1931 thus we need at most 16 bytes here. */
1932 Lisp_Object ctl_chars
[16];
1934 /* Initial buffer or string position of the iterator, before skipping
1935 over display properties and invisible text. */
1936 struct display_pos start
;
1938 /* Current buffer or string position of the iterator, including
1939 position in overlay strings etc. */
1940 struct display_pos current
;
1942 /* Total number of overlay strings to process. This can be >
1943 OVERLAY_STRING_CHUNK_SIZE. */
1944 int n_overlay_strings
;
1946 /* Vector of overlays to process. Overlay strings are processed
1947 OVERLAY_STRING_CHUNK_SIZE at a time. */
1948 #define OVERLAY_STRING_CHUNK_SIZE 16
1949 Lisp_Object overlay_strings
[OVERLAY_STRING_CHUNK_SIZE
];
1951 /* For each overlay string, the overlay it came from. */
1952 Lisp_Object string_overlays
[OVERLAY_STRING_CHUNK_SIZE
];
1954 /* If non-nil, a Lisp string being processed. If
1955 current.overlay_string_index >= 0, this is an overlay string from
1959 /* If non-nil, we are processing a string that came
1960 from a `display' property given by an overlay. */
1961 Lisp_Object from_overlay
;
1963 /* Stack of saved values. New entries are pushed when we begin to
1964 process an overlay string or a string from a `glyph' property.
1965 Entries are popped when we return to deliver display elements
1966 from what we previously had. */
1967 struct iterator_stack_entry
1975 /* Save values specific to a given method. */
1977 /* method == GET_FROM_IMAGE */
1980 struct it_slice slice
;
1983 /* method == GET_FROM_COMPOSITION */
1987 int cmp_id
, cmp_len
;
1989 /* method == GET_FROM_STRETCH */
1995 /* current text and display positions. */
1996 struct text_pos position
;
1997 struct display_pos current
;
1998 Lisp_Object from_overlay
;
1999 enum glyph_row_area area
;
2000 enum it_method method
;
2001 unsigned multibyte_p
: 1;
2002 unsigned string_from_display_prop_p
: 1;
2003 unsigned display_ellipsis_p
: 1;
2004 unsigned avoid_cursor_p
: 1;
2006 /* properties from display property that are reset by another display property. */
2007 Lisp_Object space_width
;
2008 Lisp_Object font_height
;
2011 stack
[IT_STACK_SIZE
];
2013 /* Stack pointer. */
2016 /* -1 means selective display hides everything between a \r and the
2017 next newline; > 0 means hide lines indented more than that value. */
2020 /* An enumeration describing what the next display element is
2021 after a call to get_next_display_element. */
2022 enum display_element_type what
;
2027 /* Setting of buffer-local variable selective-display-ellipsis. */
2028 unsigned selective_display_ellipsis_p
: 1;
2030 /* 1 means control characters are translated into the form `^C'
2031 where the `^' can be replaced by a display table entry. */
2032 unsigned ctl_arrow_p
: 1;
2034 enum line_wrap_method line_wrap
;
2036 /* Non-zero means that the current face has a box. */
2037 unsigned face_box_p
: 1;
2039 /* Non-null means that the current character is the first in a run
2040 of characters with box face. */
2041 unsigned start_of_box_run_p
: 1;
2043 /* Non-zero means that the current character is the last in a run
2044 of characters with box face. */
2045 unsigned end_of_box_run_p
: 1;
2047 /* 1 means overlay strings at end_charpos have been processed. */
2048 unsigned overlay_strings_at_end_processed_p
: 1;
2050 /* 1 means to ignore overlay strings at current pos, as they have
2051 already been processed. */
2052 unsigned ignore_overlay_strings_at_pos_p
: 1;
2054 /* 1 means the actual glyph is not available in the current
2056 unsigned glyph_not_available_p
: 1;
2058 /* 1 means the next line in display_line continues a character
2059 consisting of more than one glyph, and some glyphs of this
2060 character have been put on the previous line. */
2061 unsigned starts_in_middle_of_char_p
: 1;
2063 /* If 1, saved_face_id contains the id of the face in front of text
2064 skipped due to selective display. */
2065 unsigned face_before_selective_p
: 1;
2067 /* If 1, adjust current glyph so it does not increase current row
2068 descent/ascent (line-height property). Reset after this glyph. */
2069 unsigned constrain_row_ascent_descent_p
: 1;
2071 /* The ID of the default face to use. One of DEFAULT_FACE_ID,
2072 MODE_LINE_FACE_ID, etc, depending on what we are displaying. */
2075 /* If what == IT_CHARACTER, character and length in bytes. This is
2076 a character from a buffer or string. It may be different from
2077 the character displayed in case that
2078 unibyte_display_via_language_environment is set.
2080 If what == IT_COMPOSITION, the first component of a composition
2081 and length in bytes of the composition. */
2084 /* If what == IT_COMPOSITION, identification number and length in
2085 chars of a composition. */
2086 int cmp_id
, cmp_len
;
2088 /* The character to display, possibly translated to multibyte
2089 if unibyte_display_via_language_environment is set. This
2090 is set after produce_glyphs has been called. */
2091 int char_to_display
;
2093 /* If what == IT_IMAGE, the id of the image to display. */
2096 /* Values from `slice' property. */
2097 struct it_slice slice
;
2099 /* Value of the `space-width' property, if any; nil if none. */
2100 Lisp_Object space_width
;
2102 /* Computed from the value of the `raise' property. */
2105 /* Value of the `height' property, if any; nil if none. */
2106 Lisp_Object font_height
;
2108 /* Object and position where the current display element came from.
2109 Object can be a Lisp string in case the current display element
2110 comes from an overlay string, or it is buffer. It may also be nil
2111 during mode-line update. Position is a position in object. */
2113 struct text_pos position
;
2115 /* Number of columns per \t. */
2118 /* Width in pixels of truncation and continuation glyphs. */
2119 short truncation_pixel_width
, continuation_pixel_width
;
2121 /* First and last visible x-position in the display area. If window
2122 is hscrolled by n columns, first_visible_x == n * FRAME_COLUMN_WIDTH
2123 (f), and last_visible_x == pixel width of W + first_visible_x. */
2124 int first_visible_x
, last_visible_x
;
2126 /* Last visible y-position + 1 in the display area without a mode
2127 line, if the window has one. */
2130 /* Default amount of additional space in pixels between lines (for
2131 window systems only.) */
2132 int extra_line_spacing
;
2134 /* Max extra line spacing added in this row. */
2135 int max_extra_line_spacing
;
2137 /* Override font height information for this glyph.
2138 Used if override_ascent >= 0. Cleared after this glyph. */
2139 int override_ascent
, override_descent
, override_boff
;
2141 /* If non-null, glyphs are produced in glyph_row with each call to
2143 struct glyph_row
*glyph_row
;
2145 /* The area of glyph_row to which glyphs are added. */
2146 enum glyph_row_area area
;
2148 /* Number of glyphs needed for the last character requested via
2149 produce_glyphs. This is 1 except for tabs. */
2152 /* Width of the display element in pixels. Result of
2156 /* Current, maximum logical, and maximum physical line height
2157 information. Result of produce_glyphs. */
2158 int ascent
, descent
, max_ascent
, max_descent
;
2159 int phys_ascent
, phys_descent
, max_phys_ascent
, max_phys_descent
;
2161 /* Current x pixel position within the display line. This value
2162 does not include the width of continuation lines in front of the
2163 line. The value of current_x is automatically incremented by
2164 pixel_width with each call to produce_glyphs. */
2167 /* Accumulated width of continuation lines. If > 0, this means we
2168 are currently in a continuation line. This is initially zero and
2169 incremented/reset by display_line, move_it_to etc. */
2170 int continuation_lines_width
;
2172 /* Current y-position. Automatically incremented by the height of
2173 glyph_row in move_it_to and display_line. */
2176 /* Vertical matrix position of first text line in window. */
2179 /* Current vertical matrix position, or line number. Automatically
2180 incremented by move_it_to and display_line. */
2183 /* Horizontal matrix position reached in move_it_in_display_line.
2184 Only set there, not in display_line. */
2187 /* Left fringe bitmap number (enum fringe_bitmap_type). */
2188 unsigned left_user_fringe_bitmap
: FRINGE_ID_BITS
;
2190 /* Right fringe bitmap number (enum fringe_bitmap_type). */
2191 unsigned right_user_fringe_bitmap
: FRINGE_ID_BITS
;
2193 /* Face of the left fringe glyph. */
2194 unsigned left_user_fringe_face_id
: FACE_ID_BITS
;
2196 /* Face of the right fringe glyph. */
2197 unsigned right_user_fringe_face_id
: FACE_ID_BITS
;
2201 /* Access to positions of iterator IT. */
2203 #define IT_CHARPOS(IT) CHARPOS ((IT).current.pos)
2204 #define IT_BYTEPOS(IT) BYTEPOS ((IT).current.pos)
2205 #define IT_STRING_CHARPOS(IT) CHARPOS ((IT).current.string_pos)
2206 #define IT_STRING_BYTEPOS(IT) BYTEPOS ((IT).current.string_pos)
2208 /* Test if IT has reached the end of its buffer or string. This will
2209 only work after get_next_display_element has been called. */
2211 #define ITERATOR_AT_END_P(IT) ((IT)->what == IT_EOB)
2213 /* Non-zero means IT is at the end of a line. This is the case if it
2214 is either on a newline or on a carriage return and selective
2215 display hides the rest of the line. */
2217 #define ITERATOR_AT_END_OF_LINE_P(IT) \
2218 ((IT)->what == IT_CHARACTER \
2219 && ((IT)->c == '\n' \
2220 || ((IT)->c == '\r' && (IT)->selective)))
2222 /* Call produce_glyphs or produce_glyphs_hook, if set. Shortcut to
2223 avoid the function call overhead. */
2225 #define PRODUCE_GLYPHS(IT) \
2227 extern int inhibit_free_realized_faces; \
2228 if (FRAME_RIF ((IT)->f) != NULL) \
2229 FRAME_RIF ((IT)->f)->produce_glyphs ((IT)); \
2231 produce_glyphs ((IT)); \
2232 if ((IT)->glyph_row != NULL) \
2233 inhibit_free_realized_faces = 1; \
2236 /* Bit-flags indicating what operation move_it_to should perform. */
2238 enum move_operation_enum
2240 /* Stop if specified x-position is reached. */
2243 /* Stop if specified y-position is reached. */
2246 /* Stop if specified vpos is reached. */
2247 MOVE_TO_VPOS
= 0x04,
2249 /* Stop if specified buffer or string position is reached. */
2255 /***********************************************************************
2256 Window-based redisplay interface
2257 ***********************************************************************/
2259 /* Structure used to describe runs of lines that must be scrolled. */
2263 /* Source and destination y pixel position. */
2264 int desired_y
, current_y
;
2266 /* Source and destination vpos in matrix. */
2267 int desired_vpos
, current_vpos
;
2269 /* Height in pixels, number of glyph rows. */
2274 /* Handlers for setting frame parameters. */
2276 typedef void (*frame_parm_handler
) P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
2279 /* Structure holding system-dependent interface functions needed
2280 for window-based redisplay. */
2282 struct redisplay_interface
2284 /* Handlers for setting frame parameters. */
2285 frame_parm_handler
*frame_parm_handlers
;
2287 /* Produce glyphs/get display metrics for the display element IT is
2289 void (*produce_glyphs
) P_ ((struct it
*it
));
2291 /* Write or insert LEN glyphs from STRING at the nominal output
2293 void (*write_glyphs
) P_ ((struct glyph
*string
, int len
));
2294 void (*insert_glyphs
) P_ ((struct glyph
*start
, int len
));
2296 /* Clear from nominal output position to X. X < 0 means clear
2297 to right end of display. */
2298 void (*clear_end_of_line
) P_ ((int x
));
2300 /* Function to call to scroll the display as described by RUN on
2302 void (*scroll_run_hook
) P_ ((struct window
*w
, struct run
*run
));
2304 /* Function to call after a line in a display has been completely
2305 updated. Used to draw truncation marks and alike. DESIRED_ROW
2306 is the desired row which has been updated. */
2307 void (*after_update_window_line_hook
) P_ ((struct glyph_row
*desired_row
));
2309 /* Function to call before beginning to update window W in
2310 window-based redisplay. */
2311 void (*update_window_begin_hook
) P_ ((struct window
*w
));
2313 /* Function to call after window W has been updated in window-based
2314 redisplay. CURSOR_ON_P non-zero means switch cursor on.
2315 MOUSE_FACE_OVERWRITTEN_P non-zero means that some lines in W
2316 that contained glyphs in mouse-face were overwritten, so we
2317 have to update the mouse highlight. */
2318 void (*update_window_end_hook
) P_ ((struct window
*w
, int cursor_on_p
,
2319 int mouse_face_overwritten_p
));
2321 /* Move cursor to row/column position VPOS/HPOS, pixel coordinates
2322 Y/X. HPOS/VPOS are window-relative row and column numbers and X/Y
2323 are window-relative pixel positions. */
2324 void (*cursor_to
) P_ ((int vpos
, int hpos
, int y
, int x
));
2326 /* Flush the display of frame F. For X, this is XFlush. */
2327 void (*flush_display
) P_ ((struct frame
*f
));
2329 /* Flush the display of frame F if non-NULL. This is called
2330 during redisplay, and should be NULL on systems which flushes
2331 automatically before reading input. */
2332 void (*flush_display_optional
) P_ ((struct frame
*f
));
2334 /* Clear the mouse hightlight in window W, if there is any. */
2335 void (*clear_window_mouse_face
) P_ ((struct window
*w
));
2337 /* Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
2339 void (*get_glyph_overhangs
) P_ ((struct glyph
*glyph
, struct frame
*f
,
2340 int *left
, int *right
));
2342 /* Fix the display of AREA of ROW in window W for overlapping rows.
2343 This function is called from redraw_overlapping_rows after
2344 desired rows have been made current. */
2345 void (*fix_overlapping_area
) P_ ((struct window
*w
, struct glyph_row
*row
,
2346 enum glyph_row_area area
, int));
2348 #ifdef HAVE_WINDOW_SYSTEM
2350 /* Draw a fringe bitmap in window W of row ROW using parameters P. */
2351 void (*draw_fringe_bitmap
) P_ ((struct window
*w
, struct glyph_row
*row
,
2352 struct draw_fringe_bitmap_params
*p
));
2354 /* Define and destroy fringe bitmap no. WHICH. */
2355 void (*define_fringe_bitmap
) P_ ((int which
, unsigned short *bits
,
2357 void (*destroy_fringe_bitmap
) P_ ((int which
));
2359 /* Compute left and right overhang of glyph string S.
2360 A NULL pointer if platform does not support this. */
2361 void (*compute_glyph_string_overhangs
) P_ ((struct glyph_string
*s
));
2363 /* Draw a glyph string S. */
2364 void (*draw_glyph_string
) P_ ((struct glyph_string
*s
));
2366 /* Define cursor CURSOR on frame F. */
2367 void (*define_frame_cursor
) P_ ((struct frame
*f
, Cursor cursor
));
2369 /* Clear the area at (X,Y,WIDTH,HEIGHT) of frame F. */
2370 void (*clear_frame_area
) P_ ((struct frame
*f
, int x
, int y
,
2371 int width
, int height
));
2373 /* Draw specified cursor CURSOR_TYPE of width CURSOR_WIDTH
2374 at row GLYPH_ROW on window W if ON_P is 1. If ON_P is
2375 0, don't draw cursor. If ACTIVE_P is 1, system caret
2376 should track this cursor (when applicable). */
2377 void (*draw_window_cursor
) P_ ((struct window
*w
,
2378 struct glyph_row
*glyph_row
,
2380 int cursor_type
, int cursor_width
,
2381 int on_p
, int active_p
));
2383 /* Draw vertical border for window W from (X,Y0) to (X,Y1). */
2384 void (*draw_vertical_window_border
) P_ ((struct window
*w
,
2385 int x
, int y0
, int y1
));
2387 /* Shift display of frame F to make room for inserted glyphs.
2388 The area at pixel (X,Y) of width WIDTH and height HEIGHT is
2389 shifted right by SHIFT_BY pixels. */
2390 void (*shift_glyphs_for_insert
) P_ ((struct frame
*f
,
2391 int x
, int y
, int width
,
2392 int height
, int shift_by
));
2394 #endif /* HAVE_WINDOW_SYSTEM */
2398 /***********************************************************************
2400 ***********************************************************************/
2402 #ifdef HAVE_WINDOW_SYSTEM
2404 /* Structure forward declarations. */
2409 /* Each image format (JPEG, TIFF, ...) supported is described by
2410 a structure of the type below. */
2414 /* A symbol uniquely identifying the image type, .e.g `jpeg'. */
2417 /* Check that SPEC is a valid image specification for the given
2418 image type. Value is non-zero if SPEC is valid. */
2419 int (* valid_p
) P_ ((Lisp_Object spec
));
2421 /* Load IMG which is used on frame F from information contained in
2422 IMG->spec. Value is non-zero if successful. */
2423 int (* load
) P_ ((struct frame
*f
, struct image
*img
));
2425 /* Free resources of image IMG which is used on frame F. */
2426 void (* free
) P_ ((struct frame
*f
, struct image
*img
));
2428 /* Next in list of all supported image types. */
2429 struct image_type
*next
;
2433 /* Structure describing an image. Specific image formats like XBM are
2434 converted into this form, so that display only has to deal with
2435 this type of image. */
2439 /* The time in seconds at which the image was last displayed. Set
2440 in prepare_image_for_display. */
2441 unsigned long timestamp
;
2443 /* Pixmaps of the image. */
2444 Pixmap pixmap
, mask
;
2446 /* Colors allocated for this image, if any. Allocated via xmalloc. */
2447 unsigned long *colors
;
2450 /* A single `background color' for this image, for the use of anyone that
2451 cares about such a thing. Only valid if the `background_valid' field
2452 is true. This should generally be accessed by calling the accessor
2453 macro `IMAGE_BACKGROUND', which will heuristically calculate a value
2455 unsigned long background
;
2457 /* Foreground and background colors of the frame on which the image
2459 unsigned long frame_foreground
, frame_background
;
2461 /* True if this image has a `transparent' background -- that is, is
2462 uses an image mask. The accessor macro for this is
2463 `IMAGE_BACKGROUND_TRANSPARENT'. */
2464 unsigned background_transparent
: 1;
2466 /* True if the `background' and `background_transparent' fields are
2467 valid, respectively. */
2468 unsigned background_valid
: 1, background_transparent_valid
: 1;
2470 /* Width and height of the image. */
2473 /* These values are used for the rectangles displayed for images
2474 that can't be loaded. */
2475 #define DEFAULT_IMAGE_WIDTH 30
2476 #define DEFAULT_IMAGE_HEIGHT 30
2478 /* Top/left and bottom/right corner pixel of actual image data.
2479 Used by four_corners_best to consider the real image data,
2480 rather than looking at the optional image margin. */
2482 #define TOP_CORNER 0
2483 #define LEFT_CORNER 1
2484 #define BOT_CORNER 2
2485 #define RIGHT_CORNER 3
2487 /* Percent of image height used as ascent. A value of
2488 CENTERED_IMAGE_ASCENT means draw the image centered on the
2491 #define DEFAULT_IMAGE_ASCENT 50
2492 #define CENTERED_IMAGE_ASCENT -1
2494 /* Lisp specification of this image. */
2497 /* List of "references" followed to build the image.
2498 Typically will just contain the name of the image file.
2499 Used to allow fine-grained cache flushing. */
2500 Lisp_Object dependencies
;
2502 /* Relief to draw around the image. */
2505 /* Optional margins around the image. This includes the relief. */
2506 int hmargin
, vmargin
;
2508 /* Reference to the type of the image. */
2509 struct image_type
*type
;
2511 /* 1 means that loading the image failed. Don't try again. */
2512 unsigned load_failed_p
;
2514 /* A place for image types to store additional data. The member
2515 data.lisp_val is marked during GC, so it's safe to store Lisp data
2516 there. Image types should free this data when their `free'
2517 function is called. */
2522 Lisp_Object lisp_val
;
2525 /* Hash value of image specification to speed up comparisons. */
2528 /* Image id of this image. */
2531 /* Hash collision chain. */
2532 struct image
*next
, *prev
;
2536 /* Cache of images. Each frame has a cache. X frames with the same
2537 x_display_info share their caches. */
2541 /* Hash table of images. */
2542 struct image
**buckets
;
2544 /* Vector mapping image ids to images. */
2545 struct image
**images
;
2547 /* Allocated size of `images'. */
2550 /* Number of images in the cache. */
2553 /* Reference count (number of frames sharing this cache). */
2558 /* Value is a pointer to the image with id ID on frame F, or null if
2559 no image with that id exists. */
2561 #define IMAGE_FROM_ID(F, ID) \
2562 (((ID) >= 0 && (ID) < (FRAME_IMAGE_CACHE (F)->used)) \
2563 ? FRAME_IMAGE_CACHE (F)->images[ID] \
2566 /* Size of bucket vector of image caches. Should be prime. */
2568 #define IMAGE_CACHE_BUCKETS_SIZE 1001
2570 #endif /* HAVE_WINDOW_SYSTEM */
2574 /***********************************************************************
2576 ***********************************************************************/
2578 /* Enumeration defining where to find tool-bar item information in
2579 tool-bar items vectors stored with frames. Each tool-bar item
2580 occupies TOOL_BAR_ITEM_NSLOTS elements in such a vector. */
2582 enum tool_bar_item_idx
2584 /* The key of the tool-bar item. Used to remove items when a binding
2585 for `undefined' is found. */
2588 /* Non-nil if item is enabled. */
2589 TOOL_BAR_ITEM_ENABLED_P
,
2591 /* Non-nil if item is selected (pressed). */
2592 TOOL_BAR_ITEM_SELECTED_P
,
2595 TOOL_BAR_ITEM_CAPTION
,
2597 /* Image(s) to display. This is either a single image specification
2598 or a vector of specifications. */
2599 TOOL_BAR_ITEM_IMAGES
,
2602 TOOL_BAR_ITEM_BINDING
,
2604 /* Button type. One of nil, `:radio' or `:toggle'. */
2610 /* Icon file name of right to left image when an RTL locale is used. */
2611 TOOL_BAR_ITEM_RTL_IMAGE
,
2613 /* Sentinel = number of slots in tool_bar_items occupied by one
2615 TOOL_BAR_ITEM_NSLOTS
2619 /* An enumeration for the different images that can be specified
2620 for a tool-bar item. */
2622 enum tool_bar_item_image
2624 TOOL_BAR_IMAGE_ENABLED_SELECTED
,
2625 TOOL_BAR_IMAGE_ENABLED_DESELECTED
,
2626 TOOL_BAR_IMAGE_DISABLED_SELECTED
,
2627 TOOL_BAR_IMAGE_DISABLED_DESELECTED
2630 /* Margin around tool-bar buttons in pixels. */
2632 extern Lisp_Object Vtool_bar_button_margin
;
2634 /* Thickness of relief to draw around tool-bar buttons. */
2636 extern EMACS_INT tool_bar_button_relief
;
2638 /* Default values of the above variables. */
2640 #define DEFAULT_TOOL_BAR_BUTTON_MARGIN 4
2641 #define DEFAULT_TOOL_BAR_BUTTON_RELIEF 1
2643 /* The height in pixels of the default tool-bar images. */
2645 #define DEFAULT_TOOL_BAR_IMAGE_HEIGHT 24
2648 /***********************************************************************
2649 Terminal Capabilities
2650 ***********************************************************************/
2652 /* Each of these is a bit representing a terminal `capability' (bold,
2653 inverse, etc). They are or'd together to specify the set of
2654 capabilities being queried for when calling `tty_capable_p' (which
2655 returns true if the terminal supports all of them). */
2657 #define TTY_CAP_INVERSE 0x01
2658 #define TTY_CAP_UNDERLINE 0x02
2659 #define TTY_CAP_BOLD 0x04
2660 #define TTY_CAP_DIM 0x08
2661 #define TTY_CAP_BLINK 0x10
2662 #define TTY_CAP_ALT_CHARSET 0x20
2665 /***********************************************************************
2667 ***********************************************************************/
2669 /* Defined in xdisp.c */
2671 struct glyph_row
*row_containing_pos
P_ ((struct window
*, int,
2673 struct glyph_row
*, int));
2674 int string_buffer_position
P_ ((struct window
*, Lisp_Object
, int));
2675 int line_bottom_y
P_ ((struct it
*));
2676 int display_prop_intangible_p
P_ ((Lisp_Object
));
2677 void resize_echo_area_exactly
P_ ((void));
2678 int resize_mini_window
P_ ((struct window
*, int));
2679 int try_window
P_ ((Lisp_Object
, struct text_pos
, int));
2680 void window_box
P_ ((struct window
*, int, int *, int *, int *, int *));
2681 int window_box_height
P_ ((struct window
*));
2682 int window_text_bottom_y
P_ ((struct window
*));
2683 int window_box_width
P_ ((struct window
*, int));
2684 int window_box_left
P_ ((struct window
*, int));
2685 int window_box_left_offset
P_ ((struct window
*, int));
2686 int window_box_right
P_ ((struct window
*, int));
2687 int window_box_right_offset
P_ ((struct window
*, int));
2688 void window_box_edges
P_ ((struct window
*, int, int *, int *, int *, int *));
2689 int estimate_mode_line_height
P_ ((struct frame
*, enum face_id
));
2690 void pixel_to_glyph_coords
P_ ((struct frame
*, int, int, int *, int *,
2691 NativeRectangle
*, int));
2692 int glyph_to_pixel_coords
P_ ((struct window
*, int, int, int *, int *));
2693 void remember_mouse_glyph
P_ ((struct frame
*, int, int, NativeRectangle
*));
2695 void mark_window_display_accurate
P_ ((Lisp_Object
, int));
2696 void redisplay_preserve_echo_area
P_ ((int));
2697 int set_cursor_from_row
P_ ((struct window
*, struct glyph_row
*,
2698 struct glyph_matrix
*, int, int, int, int));
2699 void init_iterator
P_ ((struct it
*, struct window
*, int,
2700 int, struct glyph_row
*, enum face_id
));
2701 void init_iterator_to_row_start
P_ ((struct it
*, struct window
*,
2702 struct glyph_row
*));
2703 int get_next_display_element
P_ ((struct it
*));
2704 void set_iterator_to_next
P_ ((struct it
*, int));
2705 void start_display
P_ ((struct it
*, struct window
*, struct text_pos
));
2706 void move_it_to
P_ ((struct it
*, int, int, int, int, int));
2707 void move_it_vertically
P_ ((struct it
*, int));
2708 void move_it_vertically_backward
P_ ((struct it
*, int));
2709 void move_it_by_lines
P_ ((struct it
*, int, int));
2710 void move_it_past_eol
P_ ((struct it
*));
2711 void move_it_in_display_line (struct it
*it
,
2712 EMACS_INT to_charpos
, int to_x
,
2713 enum move_operation_enum op
);
2714 int in_display_vector_p
P_ ((struct it
*));
2715 int frame_mode_line_height
P_ ((struct frame
*));
2716 void highlight_trailing_whitespace
P_ ((struct frame
*, struct glyph_row
*));
2717 extern Lisp_Object Qtool_bar
;
2718 extern Lisp_Object Vshow_trailing_whitespace
;
2719 extern int mode_line_in_non_selected_windows
;
2720 extern int redisplaying_p
;
2721 extern void add_to_log
P_ ((char *, Lisp_Object
, Lisp_Object
));
2722 extern int help_echo_showing_p
;
2723 extern int current_mode_line_height
, current_header_line_height
;
2724 extern Lisp_Object help_echo_string
, help_echo_window
;
2725 extern Lisp_Object help_echo_object
, previous_help_echo_string
;
2726 extern int help_echo_pos
;
2727 extern struct frame
*last_mouse_frame
;
2728 extern int last_tool_bar_item
;
2729 extern Lisp_Object Vmouse_autoselect_window
;
2730 extern int unibyte_display_via_language_environment
;
2731 extern EMACS_INT underline_minimum_offset
;
2733 extern void reseat_at_previous_visible_line_start
P_ ((struct it
*));
2735 extern int calc_pixel_width_or_height
P_ ((double *, struct it
*, Lisp_Object
,
2736 struct font
*, int, int *));
2738 #ifdef HAVE_WINDOW_SYSTEM
2741 extern void dump_glyph_string
P_ ((struct glyph_string
*));
2744 extern void x_get_glyph_overhangs
P_ ((struct glyph
*, struct frame
*,
2746 extern void x_produce_glyphs
P_ ((struct it
*));
2748 extern void x_write_glyphs
P_ ((struct glyph
*, int));
2749 extern void x_insert_glyphs
P_ ((struct glyph
*, int len
));
2750 extern void x_clear_end_of_line
P_ ((int));
2752 extern int x_stretch_cursor_p
;
2753 extern struct cursor_pos output_cursor
;
2755 extern void x_fix_overlapping_area
P_ ((struct window
*, struct glyph_row
*,
2756 enum glyph_row_area
, int));
2757 extern void draw_phys_cursor_glyph
P_ ((struct window
*,
2759 enum draw_glyphs_face
));
2760 extern void get_phys_cursor_geometry
P_ ((struct window
*, struct glyph_row
*,
2761 struct glyph
*, int *, int *, int *));
2762 extern void erase_phys_cursor
P_ ((struct window
*));
2763 extern void display_and_set_cursor
P_ ((struct window
*,
2764 int, int, int, int, int));
2766 extern void set_output_cursor
P_ ((struct cursor_pos
*));
2767 extern void x_cursor_to
P_ ((int, int, int, int));
2769 extern void x_update_cursor
P_ ((struct frame
*, int));
2770 extern void x_clear_cursor
P_ ((struct window
*));
2771 extern void x_draw_vertical_border
P_ ((struct window
*w
));
2773 extern void frame_to_window_pixel_xy
P_ ((struct window
*, int *, int *));
2774 extern int get_glyph_string_clip_rects
P_ ((struct glyph_string
*,
2775 NativeRectangle
*, int));
2776 extern void get_glyph_string_clip_rect
P_ ((struct glyph_string
*,
2777 NativeRectangle
*nr
));
2778 extern Lisp_Object find_hot_spot
P_ ((Lisp_Object
, int, int));
2779 extern void note_mouse_highlight
P_ ((struct frame
*, int, int));
2780 extern void x_clear_window_mouse_face
P_ ((struct window
*));
2781 extern void cancel_mouse_face
P_ ((struct frame
*));
2783 extern void handle_tool_bar_click
P_ ((struct frame
*,
2784 int, int, int, unsigned int));
2786 /* msdos.c defines its own versions of these functions. */
2787 extern int clear_mouse_face
P_ ((Display_Info
*));
2788 extern void show_mouse_face
P_ ((Display_Info
*, enum draw_glyphs_face
));
2789 extern int cursor_in_mouse_face_p
P_ ((struct window
*w
));
2791 extern void expose_frame
P_ ((struct frame
*, int, int, int, int));
2792 extern int x_intersect_rectangles
P_ ((XRectangle
*, XRectangle
*,
2796 /* Defined in fringe.c */
2798 int lookup_fringe_bitmap (Lisp_Object
);
2799 void draw_fringe_bitmap
P_ ((struct window
*, struct glyph_row
*, int));
2800 void draw_row_fringe_bitmaps
P_ ((struct window
*, struct glyph_row
*));
2801 int draw_window_fringes
P_ ((struct window
*, int));
2802 int update_window_fringes
P_ ((struct window
*, int));
2803 void compute_fringe_widths
P_ ((struct frame
*, int));
2806 void w32_init_fringe
P_ ((struct redisplay_interface
*));
2807 void w32_reset_fringes
P_ ((void));
2809 /* Defined in image.c */
2811 #ifdef HAVE_WINDOW_SYSTEM
2813 extern int x_bitmap_height
P_ ((struct frame
*, int));
2814 extern int x_bitmap_width
P_ ((struct frame
*, int));
2815 extern int x_bitmap_pixmap
P_ ((struct frame
*, int));
2816 extern void x_reference_bitmap
P_ ((struct frame
*, int));
2817 extern int x_create_bitmap_from_data
P_ ((struct frame
*, char *,
2818 unsigned int, unsigned int));
2819 extern int x_create_bitmap_from_file
P_ ((struct frame
*, Lisp_Object
));
2820 #if defined (HAVE_XPM) && defined (HAVE_X_WINDOWS)
2821 extern int x_create_bitmap_from_xpm_data
P_ ((struct frame
*f
, char **bits
));
2823 #ifndef x_destroy_bitmap
2824 extern void x_destroy_bitmap
P_ ((struct frame
*, int));
2826 extern void x_destroy_all_bitmaps
P_ ((Display_Info
*));
2827 extern int x_create_bitmap_mask
P_ ((struct frame
* , int));
2828 extern Lisp_Object x_find_image_file
P_ ((Lisp_Object
));
2830 void x_kill_gs_process
P_ ((Pixmap
, struct frame
*));
2831 struct image_cache
*make_image_cache
P_ ((void));
2832 void free_image_cache
P_ ((struct frame
*));
2833 void clear_image_caches
P_ ((Lisp_Object
));
2834 void mark_image_cache
P_ ((struct image_cache
*));
2835 int valid_image_p
P_ ((Lisp_Object
));
2836 void prepare_image_for_display
P_ ((struct frame
*, struct image
*));
2837 int lookup_image
P_ ((struct frame
*, Lisp_Object
));
2839 unsigned long image_background
P_ ((struct image
*, struct frame
*,
2840 XImagePtr_or_DC ximg
));
2841 int image_background_transparent
P_ ((struct image
*, struct frame
*,
2842 XImagePtr_or_DC mask
));
2844 int image_ascent
P_ ((struct image
*, struct face
*, struct glyph_slice
*));
2848 /* Defined in sysdep.c */
2850 void get_tty_size
P_ ((int, int *, int *));
2851 void request_sigio
P_ ((void));
2852 void unrequest_sigio
P_ ((void));
2853 int tabs_safe_p
P_ ((int));
2854 void init_baud_rate
P_ ((int));
2855 void init_sigio
P_ ((int));
2857 /* Defined in xfaces.c */
2859 #ifdef HAVE_X_WINDOWS
2860 void x_free_colors
P_ ((struct frame
*, unsigned long *, int));
2863 void update_face_from_frame_parameter
P_ ((struct frame
*, Lisp_Object
,
2865 Lisp_Object tty_color_name
P_ ((struct frame
*, int));
2866 void clear_face_cache
P_ ((int));
2867 unsigned long load_color
P_ ((struct frame
*, struct face
*, Lisp_Object
,
2868 enum lface_attribute_index
));
2869 void unload_color
P_ ((struct frame
*, unsigned long));
2870 char *choose_face_font
P_ ((struct frame
*, Lisp_Object
*, Lisp_Object
,
2872 int ascii_face_of_lisp_face
P_ ((struct frame
*, int));
2873 void prepare_face_for_display
P_ ((struct frame
*, struct face
*));
2874 int xstrcasecmp
P_ ((const unsigned char *, const unsigned char *));
2875 int lookup_face
P_ ((struct frame
*, Lisp_Object
*));
2876 int lookup_named_face
P_ ((struct frame
*, Lisp_Object
, int));
2877 int lookup_basic_face
P_ ((struct frame
*, int));
2878 int smaller_face
P_ ((struct frame
*, int, int));
2879 int face_with_height
P_ ((struct frame
*, int, int));
2880 int lookup_derived_face
P_ ((struct frame
*, Lisp_Object
, int, int));
2881 void init_frame_faces
P_ ((struct frame
*));
2882 void free_frame_faces
P_ ((struct frame
*));
2883 void recompute_basic_faces
P_ ((struct frame
*));
2884 int face_at_buffer_position
P_ ((struct window
*w
, EMACS_INT pos
,
2885 EMACS_INT region_beg
, EMACS_INT region_end
,
2886 EMACS_INT
*endptr
, EMACS_INT limit
,
2888 int face_for_overlay_string
P_ ((struct window
*w
, EMACS_INT pos
,
2889 EMACS_INT region_beg
, EMACS_INT region_end
,
2890 EMACS_INT
*endptr
, EMACS_INT limit
,
2891 int mouse
, Lisp_Object overlay
));
2892 int face_at_string_position
P_ ((struct window
*w
, Lisp_Object string
,
2893 EMACS_INT pos
, EMACS_INT bufpos
,
2894 EMACS_INT region_beg
, EMACS_INT region_end
,
2895 EMACS_INT
*endptr
, enum face_id
, int mouse
));
2896 int merge_faces
P_ ((struct frame
*, Lisp_Object
, int, int));
2897 int compute_char_face
P_ ((struct frame
*, int, Lisp_Object
));
2898 void free_all_realized_faces
P_ ((Lisp_Object
));
2899 void free_realized_face
P_ ((struct frame
*, struct face
*));
2900 extern Lisp_Object Qforeground_color
, Qbackground_color
;
2901 extern Lisp_Object Qframe_set_background_mode
;
2902 extern char unspecified_fg
[], unspecified_bg
[];
2904 extern Lisp_Object Vface_remapping_alist
;
2906 /* Defined in xfns.c */
2908 #ifdef HAVE_X_WINDOWS
2909 void gamma_correct
P_ ((struct frame
*, XColor
*));
2912 void gamma_correct
P_ ((struct frame
*, COLORREF
*));
2915 #ifdef HAVE_WINDOW_SYSTEM
2917 int x_screen_planes
P_ ((struct frame
*));
2918 void x_implicitly_set_name
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
2920 extern Lisp_Object tip_frame
;
2921 extern Window tip_window
;
2922 EXFUN (Fx_show_tip
, 6);
2923 EXFUN (Fx_hide_tip
, 0);
2924 extern void start_hourglass
P_ ((void));
2925 extern void cancel_hourglass
P_ ((void));
2926 extern int hourglass_started
P_ ((void));
2927 extern int display_hourglass_p
;
2928 extern int hourglass_shown_p
;
2929 struct atimer
; /* Defined in atimer.h. */
2930 /* If non-null, an asynchronous timer that, when it expires, displays
2931 an hourglass cursor on all frames. */
2932 extern struct atimer
*hourglass_atimer
;
2934 /* Each GUI implements these. FIXME: move into RIF. */
2935 extern void show_hourglass
P_ ((struct atimer
*));
2936 extern void hide_hourglass
P_ ((void));
2938 /* Returns the background color of IMG, calculating one heuristically if
2939 necessary. If non-zero, XIMG is an existing XImage object to use for
2942 #define IMAGE_BACKGROUND(img, f, ximg) \
2943 ((img)->background_valid \
2944 ? (img)->background \
2945 : image_background (img, f, ximg))
2947 /* Returns true if IMG has a `transparent' background, using heuristics
2948 to decide if necessary. If non-zero, MASK is an existing XImage
2949 object to use for the heuristic. */
2951 #define IMAGE_BACKGROUND_TRANSPARENT(img, f, mask) \
2952 ((img)->background_transparent_valid \
2953 ? (img)->background_transparent \
2954 : image_background_transparent (img, f, mask))
2956 #endif /* HAVE_WINDOW_SYSTEM */
2959 /* Defined in xmenu.c */
2961 int popup_activated
P_ ((void));
2963 /* Defined in dispnew.c */
2965 extern int inverse_video
;
2966 extern int required_matrix_width
P_ ((struct window
*));
2967 extern int required_matrix_height
P_ ((struct window
*));
2968 extern Lisp_Object buffer_posn_from_coords
P_ ((struct window
*,
2970 struct display_pos
*,
2972 int *, int *, int *, int *));
2973 extern Lisp_Object mode_line_string
P_ ((struct window
*, enum window_part
,
2974 int *, int *, int *,
2976 int *, int *, int *, int *));
2977 extern Lisp_Object marginal_area_string
P_ ((struct window
*, enum window_part
,
2978 int *, int *, int *,
2980 int *, int *, int *, int *));
2981 extern void redraw_frame
P_ ((struct frame
*));
2982 extern void redraw_garbaged_frames
P_ ((void));
2983 extern void cancel_line
P_ ((int, struct frame
*));
2984 extern void init_desired_glyphs
P_ ((struct frame
*));
2985 extern int scroll_frame_lines
P_ ((struct frame
*, int, int, int, int));
2986 extern int direct_output_for_insert
P_ ((int));
2987 extern int direct_output_forward_char
P_ ((int));
2988 extern int update_frame
P_ ((struct frame
*, int, int));
2989 extern int scrolling
P_ ((struct frame
*));
2990 extern void bitch_at_user
P_ ((void));
2991 void adjust_glyphs
P_ ((struct frame
*));
2992 void free_glyphs
P_ ((struct frame
*));
2993 void free_window_matrices
P_ ((struct window
*));
2994 void check_glyph_memory
P_ ((void));
2995 void mirrored_line_dance
P_ ((struct glyph_matrix
*, int, int, int *, char *));
2996 void clear_glyph_matrix
P_ ((struct glyph_matrix
*));
2997 void clear_current_matrices
P_ ((struct frame
*f
));
2998 void clear_desired_matrices
P_ ((struct frame
*));
2999 void shift_glyph_matrix
P_ ((struct window
*, struct glyph_matrix
*,
3001 void rotate_matrix
P_ ((struct glyph_matrix
*, int, int, int));
3002 void increment_matrix_positions
P_ ((struct glyph_matrix
*,
3003 int, int, int, int));
3004 void blank_row
P_ ((struct window
*, struct glyph_row
*, int));
3005 void increment_row_positions
P_ ((struct glyph_row
*, int, int));
3006 void enable_glyph_matrix_rows
P_ ((struct glyph_matrix
*, int, int, int));
3007 void clear_glyph_row
P_ ((struct glyph_row
*));
3008 void prepare_desired_row
P_ ((struct glyph_row
*));
3009 int line_hash_code
P_ ((struct glyph_row
*));
3010 void set_window_update_flags
P_ ((struct window
*, int));
3011 void redraw_frame
P_ ((struct frame
*));
3012 void redraw_garbaged_frames
P_ ((void));
3013 int scroll_cost
P_ ((struct frame
*, int, int, int));
3014 int direct_output_for_insert
P_ ((int));
3015 int direct_output_forward_char
P_ ((int));
3016 int update_frame
P_ ((struct frame
*, int, int));
3017 void update_single_window
P_ ((struct window
*, int));
3018 int scrolling
P_ ((struct frame
*));
3019 void do_pending_window_change
P_ ((int));
3020 void change_frame_size
P_ ((struct frame
*, int, int, int, int, int));
3021 void bitch_at_user
P_ ((void));
3022 void init_display
P_ ((void));
3023 void syms_of_display
P_ ((void));
3024 extern Lisp_Object Qredisplay_dont_pause
;
3025 void spec_glyph_lookup_face
P_ ((struct window
*, GLYPH
*));
3027 /* Defined in terminal.c */
3029 extern void ring_bell
P_ ((struct frame
*));
3030 extern void update_begin
P_ ((struct frame
*));
3031 extern void update_end
P_ ((struct frame
*));
3032 extern void set_terminal_window
P_ ((struct frame
*, int));
3033 extern void cursor_to
P_ ((struct frame
*, int, int));
3034 extern void raw_cursor_to
P_ ((struct frame
*, int, int));
3035 extern void clear_to_end
P_ ((struct frame
*));
3036 extern void clear_frame
P_ ((struct frame
*));
3037 extern void clear_end_of_line
P_ ((struct frame
*, int));
3038 extern void write_glyphs
P_ ((struct frame
*, struct glyph
*, int));
3039 extern void insert_glyphs
P_ ((struct frame
*, struct glyph
*, int));
3040 extern void delete_glyphs
P_ ((struct frame
*, int));
3041 extern void ins_del_lines
P_ ((struct frame
*, int, int));
3043 extern struct terminal
*init_initial_terminal
P_ ((void));
3046 /* Defined in term.c */
3048 extern void tty_set_terminal_modes
P_ ((struct terminal
*));
3049 extern void tty_reset_terminal_modes
P_ ((struct terminal
*));
3050 extern void tty_turn_off_insert
P_ ((struct tty_display_info
*));
3051 extern void tty_turn_off_highlight
P_ ((struct tty_display_info
*));
3052 extern int string_cost
P_ ((char *));
3053 extern int per_line_cost
P_ ((char *));
3054 extern void calculate_costs
P_ ((struct frame
*));
3055 extern void produce_glyphs
P_ ((struct it
*));
3056 extern void produce_special_glyphs
P_ ((struct it
*, enum display_element_type
));
3057 extern int tty_capable_p
P_ ((struct tty_display_info
*, unsigned, unsigned long, unsigned long));
3058 extern void set_tty_color_mode (struct tty_display_info
*, struct frame
*);
3059 extern struct terminal
*get_tty_terminal
P_ ((Lisp_Object
, int));
3060 extern struct terminal
*get_named_tty
P_ ((char *));
3061 EXFUN (Ftty_type
, 1);
3062 extern void create_tty_output
P_ ((struct frame
*));
3063 extern struct terminal
*init_tty
P_ ((char *, char *, int));
3066 /* Defined in scroll.c */
3068 extern int scrolling_max_lines_saved
P_ ((int, int, int *, int *, int *));
3069 extern int scroll_cost
P_ ((struct frame
*, int, int, int));
3070 extern void do_line_insertion_deletion_costs
P_ ((struct frame
*, char *,
3071 char *, char *, char *,
3072 char *, char *, int));
3073 void scrolling_1
P_ ((struct frame
*, int, int, int, int *, int *, int *,
3076 /* Defined in frame.c */
3078 #ifdef HAVE_WINDOW_SYSTEM
3080 /* Types we might convert a resource string into. */
3090 extern Lisp_Object x_get_arg
P_ ((Display_Info
*, Lisp_Object
,
3091 Lisp_Object
, char *, char *class,
3092 enum resource_types
));
3093 extern Lisp_Object x_frame_get_arg
P_ ((struct frame
*, Lisp_Object
,
3094 Lisp_Object
, char *, char *,
3095 enum resource_types
));
3096 extern Lisp_Object x_frame_get_and_record_arg
P_ ((
3097 struct frame
*, Lisp_Object
,
3098 Lisp_Object
, char *, char *,
3099 enum resource_types
));
3100 extern Lisp_Object x_default_parameter
P_ ((struct frame
*, Lisp_Object
,
3101 Lisp_Object
, Lisp_Object
,
3103 enum resource_types
));
3105 #endif /* HAVE_WINDOW_SYSTEM */
3107 #endif /* not DISPEXTERN_H_INCLUDED */
3109 /* arch-tag: c65c475f-1c1e-4534-8795-990b8509fd65
3110 (do not change this comment) */