1 /* Interface definitions for display code.
2 Copyright (C) 1985, 1993, 1994, 1997, 1998, 1999, 2000, 2001, 2002, 2003
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>. */
24 #ifndef DISPEXTERN_H_INCLUDED
25 #define DISPEXTERN_H_INCLUDED
31 #include <X11/Intrinsic.h>
32 #endif /* USE_X_TOOLKIT */
34 #else /* !HAVE_X_WINDOWS */
36 /* X-related stuff used by non-X gui code. */
40 unsigned short red
, green
, blue
;
45 #endif /* HAVE_X_WINDOWS */
59 /* Structure forward declarations. Some are here because function
60 prototypes below reference structure types before their definition
61 in this file. Some are here because not every file including
62 dispextern.h also includes frame.h and windows.h. */
73 /***********************************************************************
75 ***********************************************************************/
77 /* If GLYPH_DEBUG is non-zero, additional checks are activated. Turn
78 it off by defining the macro GLYPH_DEBUG to zero. */
84 /* Macros to include code only if GLYPH_DEBUG != 0. */
88 #define xassert(X) do {if (!(X)) abort ();} while (0)
90 #define IF_DEBUG(X) (void) 0
91 #define xassert(X) (void) 0
94 /* Macro for displaying traces of redisplay. If Emacs was compiled
95 with GLYPH_DEBUG != 0, the variable trace_redisplay_p can be set to
96 a non-zero value in debugging sessions to activate traces. */
100 extern int trace_redisplay_p
;
104 if (trace_redisplay_p) \
109 #else /* GLYPH_DEBUG == 0 */
111 #define TRACE(X) (void) 0
113 #endif /* GLYPH_DEBUG == 0 */
117 /***********************************************************************
119 ***********************************************************************/
121 /* Starting with Emacs 20.3, characters from strings and buffers have
122 both a character and a byte position associated with them. The
123 following structure holds such a pair of positions. */
127 /* Character position. */
130 /* Corresponding byte position. */
134 /* Access character and byte position of POS in a functional form. */
136 #define BYTEPOS(POS) (POS).bytepos
137 #define CHARPOS(POS) (POS).charpos
139 /* Set character position of POS to CHARPOS, byte position to BYTEPOS. */
141 #define SET_TEXT_POS(POS, CHARPOS, BYTEPOS) \
142 ((POS).charpos = (CHARPOS), (POS).bytepos = BYTEPOS)
144 /* Increment text position POS. */
146 #define INC_TEXT_POS(POS, MULTIBYTE_P) \
151 INC_POS ((POS).bytepos); \
157 /* Decrement text position POS. */
159 #define DEC_TEXT_POS(POS, MULTIBYTE_P) \
164 DEC_POS ((POS).bytepos); \
170 /* Set text position POS from marker MARKER. */
172 #define SET_TEXT_POS_FROM_MARKER(POS, MARKER) \
173 (CHARPOS (POS) = marker_position ((MARKER)), \
174 BYTEPOS (POS) = marker_byte_position ((MARKER)))
176 /* Set marker MARKER from text position POS. */
178 #define SET_MARKER_FROM_TEXT_POS(MARKER, POS) \
179 set_marker_both ((MARKER), Qnil, CHARPOS ((POS)), BYTEPOS ((POS)))
181 /* Value is non-zero if character and byte positions of POS1 and POS2
184 #define TEXT_POS_EQUAL_P(POS1, POS2) \
185 ((POS1).charpos == (POS2).charpos \
186 && (POS1).bytepos == (POS2).bytepos)
188 /* When rendering glyphs, redisplay scans string or buffer text,
189 overlay strings in that text, and does display table or control
190 character translations. The following structure captures a
191 position taking all this into account. */
195 /* Buffer or string position. */
198 /* If this is a position in an overlay string, overlay_string_index
199 is the index of that overlay string in the sequence of overlay
200 strings at `pos' in the order redisplay processes them. A value
201 < 0 means that this is not a position in an overlay string. */
202 int overlay_string_index
;
204 /* If this is a position in an overlay string, string_pos is the
205 position within that string. */
206 struct text_pos string_pos
;
208 /* If the character at the position above is a control character or
209 has a display table entry, dpvec_index is an index in the display
210 table or control character translation of that character. A
211 value < 0 means this is not a position in such a translation. */
217 /***********************************************************************
219 ***********************************************************************/
221 /* Enumeration of glyph types. Glyph structures contain a type field
222 containing one of the enumerators defined here. */
226 /* Glyph describes a character. */
229 /* Glyph describes a composition sequence. */
232 /* Glyph describes an image. */
235 /* Glyph is a space of fractional width and/or height. */
242 Be extra careful when changing this structure! Esp. make sure that
243 functions producing glyphs, like x_append_glyph, fill ALL of the
244 glyph structure, and that GLYPH_EQUAL_P compares all
245 display-relevant members of glyphs (not to imply that these are the
246 only things to check when you add a member). */
250 /* Position from which this glyph was drawn. If `object' below is a
251 Lisp string, this is a position in that string. If it is a
252 buffer, this is a position in that buffer. A value of -1
253 together with a null object means glyph is a truncation glyph at
254 the start of a row. */
257 /* Lisp object source of this glyph. Currently either a buffer or
258 a string, if the glyph was produced from characters which came from
259 a buffer or a string; or 0 if the glyph was inserted by redisplay
260 for its own purposes such as padding. */
263 /* Width in pixels. */
266 /* Vertical offset. If < 0, the glyph is displayed raised, if > 0
267 the glyph is displayed lowered. */
270 /* Which kind of glyph this is---character, image etc. Value
271 should be an enumerator of type enum glyph_type. */
274 /* 1 means this glyph was produced from multibyte text. Zero
275 means it was produced from unibyte text, i.e. charsets aren't
276 applicable, and encoding is not performed. */
277 unsigned multibyte_p
: 1;
279 /* Non-zero means draw a box line at the left or right side of this
280 glyph. This is part of the implementation of the face attribute
282 unsigned left_box_line_p
: 1;
283 unsigned right_box_line_p
: 1;
285 /* Non-zero means this glyph's physical ascent or descent is greater
286 than its logical ascent/descent, i.e. it may potentially overlap
287 glyphs above or below it. */
288 unsigned overlaps_vertically_p
: 1;
290 /* 1 means glyph is a padding glyph. Padding glyphs are used for
291 characters whose visual shape consists of more than one glyph
292 (e.g. Asian characters). All but the first glyph of such a glyph
293 sequence have the padding_p flag set. Only used for terminal
294 frames, and there only to minimize code changes. A better way
295 would probably be to use the width field of glyphs to express
297 unsigned padding_p
: 1;
299 /* 1 means the actual glyph is not available, draw a box instead.
300 This can happen when a font couldn't be loaded, or a character
301 doesn't have a glyph in a font. */
302 unsigned glyph_not_available_p
: 1;
304 /* Face of the glyph. */
305 unsigned face_id
: 22;
308 /* Type of font used to display the character glyph. Used to
309 determine which set of functions to use to obtain font metrics
310 for the glyph. Value should be an enumerator of the type
311 w32_char_font_type. */
312 unsigned w32_font_type
: 2;
315 /* A union of sub-structures for different glyph types. */
318 /* Character code for character glyphs (type == CHAR_GLYPH). */
321 /* Composition ID for composition glyphs (type == COMPOSITION_GLYPH) */
324 /* Image ID for image glyphs (type == IMAGE_GLYPH). */
327 /* Sub-structure for type == STRETCH_GLYPH. */
330 /* The height of the glyph. */
331 unsigned height
: 16;
333 /* The ascent of the glyph. */
334 unsigned ascent
: 16;
338 /* Used to compare all bit-fields above in one step. */
344 /* Is GLYPH a space? */
346 #define CHAR_GLYPH_SPACE_P(GLYPH) \
347 (GLYPH_FROM_CHAR_GLYPH ((GLYPH)) == SPACEGLYPH)
349 /* Are glyphs *X and *Y displayed equal? */
351 #define GLYPH_EQUAL_P(X, Y) \
352 ((X)->type == (Y)->type \
353 && (X)->u.val == (Y)->u.val \
354 && (X)->face_id == (Y)->face_id \
355 && (X)->padding_p == (Y)->padding_p \
356 && (X)->left_box_line_p == (Y)->left_box_line_p \
357 && (X)->right_box_line_p == (Y)->right_box_line_p \
358 && (X)->voffset == (Y)->voffset \
359 && (X)->pixel_width == (Y)->pixel_width)
361 /* Are character codes, faces, padding_ps of glyphs *X and *Y equal? */
363 #define GLYPH_CHAR_AND_FACE_EQUAL_P(X, Y) \
364 ((X)->u.ch == (Y)->u.ch \
365 && (X)->face_id == (Y)->face_id \
366 && (X)->padding_p == (Y)->padding_p)
368 /* Fill a character glyph GLYPH. CODE, FACE_ID, PADDING_P correspond
369 to the bits defined for the typedef `GLYPH' in lisp.h. */
371 #define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P) \
374 (GLYPH).u.ch = (CODE); \
375 (GLYPH).face_id = (FACE_ID); \
376 (GLYPH).padding_p = (PADDING_P); \
380 /* Fill a character type glyph GLYPH from a glyph typedef FROM as
381 defined in lisp.h. */
383 #define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM) \
384 SET_CHAR_GLYPH ((GLYPH), \
385 FAST_GLYPH_CHAR ((FROM)), \
386 FAST_GLYPH_FACE ((FROM)), \
389 /* Construct a glyph code from a character glyph GLYPH. If the
390 character is multibyte, return -1 as we can't use glyph table for a
391 multibyte character. */
393 #define GLYPH_FROM_CHAR_GLYPH(GLYPH) \
394 ((GLYPH).u.ch < 256 \
395 ? ((GLYPH).u.ch | ((GLYPH).face_id << CHARACTERBITS)) \
398 /* Is GLYPH a padding glyph? */
400 #define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p
405 /***********************************************************************
407 ***********************************************************************/
411 Glyph memory for frame-based redisplay is allocated from the heap
412 in one vector kept in a glyph pool structure which is stored with
413 the frame. The size of the vector is made large enough to cover
414 all windows on the frame.
416 Both frame and window glyph matrices reference memory from a glyph
417 pool in frame-based redisplay.
419 In window-based redisplay, no glyphs pools exist; windows allocate
420 and free their glyph memory themselves. */
424 /* Vector of glyphs allocated from the heap. */
425 struct glyph
*glyphs
;
427 /* Allocated size of `glyphs'. */
430 /* Number of rows and columns in a matrix. */
436 /***********************************************************************
438 ***********************************************************************/
442 Three kinds of glyph matrices exist:
444 1. Frame glyph matrices. These are used for terminal frames whose
445 redisplay needs a view of the whole screen due to limited terminal
446 capabilities. Frame matrices are used only in the update phase
447 of redisplay. They are built in update_frame and not used after
448 the update has been performed.
450 2. Window glyph matrices on frames having frame glyph matrices.
451 Such matrices are sub-matrices of their corresponding frame matrix,
452 i.e. frame glyph matrices and window glyph matrices share the same
453 glyph memory which is allocated in form of a glyph_pool structure.
454 Glyph rows in such a window matrix are slices of frame matrix rows.
456 2. Free-standing window glyph matrices managing their own glyph
457 storage. This form is used in window-based redisplay which
458 includes variable width and height fonts etc.
460 The size of a window's row vector depends on the height of fonts
461 defined on its frame. It is chosen so that the vector is large
462 enough to describe all lines in a window when it is displayed in
463 the smallest possible character size. When new fonts are loaded,
464 or window sizes change, the row vector is adjusted accordingly. */
468 /* The pool from which glyph memory is allocated, if any. This is
469 null for frame matrices and for window matrices managing their
471 struct glyph_pool
*pool
;
473 /* Vector of glyph row structures. The row at nrows - 1 is reserved
474 for the mode line. */
475 struct glyph_row
*rows
;
477 /* Number of elements allocated for the vector rows above. */
480 /* The number of rows used by the window if all lines were displayed
481 with the smallest possible character height. */
484 /* Origin within the frame matrix if this is a window matrix on a
485 frame having a frame matrix. Both values are zero for
486 window-based redisplay. */
487 int matrix_x
, matrix_y
;
489 /* Width and height of the matrix in columns and rows. */
490 int matrix_w
, matrix_h
;
492 /* If this structure describes a window matrix of window W,
493 window_left_x is the value of W->left, window_top_y the value of
494 W->top, window_height and window_width are width and height of W,
495 as returned by window_box, and window_vscroll is the value of
496 W->vscroll at the time the matrix was last adjusted. Only set
497 for window-based redisplay. */
498 int window_left_x
, window_top_y
, window_height
, window_width
, window_vscroll
;
500 /* Number of glyphs reserved for left and right marginal areas when
501 the matrix was last adjusted. */
502 int left_margin_glyphs
, right_margin_glyphs
;
504 /* Flag indicating that scrolling should not be tried in
505 update_window. This flag is set by functions like try_window_id
506 which do their own scrolling. */
507 unsigned no_scrolling_p
: 1;
509 /* Non-zero means window displayed in this matrix has a top mode
511 unsigned header_line_p
: 1;
514 /* A string identifying the method used to display the matrix. */
518 /* The buffer this matrix displays. Set in
519 mark_window_display_accurate_1. */
520 struct buffer
*buffer
;
522 /* Values of BEGV and ZV as of last redisplay. Set in
523 mark_window_display_accurate_1. */
528 /* Check that glyph pointers stored in glyph rows of MATRIX are okay.
529 This aborts if any pointer is found twice. */
532 void check_matrix_pointer_lossage
P_ ((struct glyph_matrix
*));
533 #define CHECK_MATRIX(MATRIX) check_matrix_pointer_lossage ((MATRIX))
535 #define CHECK_MATRIX(MATRIX) (void) 0
540 /***********************************************************************
542 ***********************************************************************/
544 /* Area in window glyph matrix. If values are added or removed, the
545 function mark_object in alloc.c has to be changed. */
556 /* Rows of glyphs in a windows or frame glyph matrix.
558 Each row is partitioned into three areas. The start and end of
559 each area is recorded in a pointer as shown below.
561 +--------------------+-------------+---------------------+
562 | left margin area | text area | right margin area |
563 +--------------------+-------------+---------------------+
565 glyphs[LEFT_MARGIN_AREA] glyphs[RIGHT_MARGIN_AREA]
570 Rows in frame matrices reference glyph memory allocated in a frame
571 glyph pool (see the description of struct glyph_pool). Rows in
572 window matrices on frames having frame matrices reference slices of
573 the glyphs of corresponding rows in the frame matrix.
575 Rows in window matrices on frames having no frame matrices point to
576 glyphs allocated from the heap via xmalloc;
577 glyphs[LEFT_MARGIN_AREA] is the start address of the allocated
578 glyph structure array. */
582 /* Pointers to beginnings of areas. The end of an area A is found at
583 A + 1 in the vector. The last element of the vector is the end
586 Kludge alert: Even if used[TEXT_AREA] == 0, glyphs[TEXT_AREA][0]'s
587 position field is used. It is -1 if this row does not correspond
588 to any text; it is some buffer position if the row corresponds to
589 an empty display line that displays a line end. This is what old
590 redisplay used to do. (Except in code for terminal frames, this
591 kludge is no longer used, I believe. --gerd).
593 See also start, end, displays_text_p and ends_at_zv_p for cleaner
594 ways to do it. The special meaning of positions 0 and -1 will be
595 removed some day, so don't use it in new code. */
596 struct glyph
*glyphs
[1 + LAST_AREA
];
598 /* Number of glyphs actually filled in areas. */
599 short used
[LAST_AREA
];
601 /* Window-relative x and y-position of the top-left corner of this
602 row. If y < 0, this means that abs (y) pixels of the row are
603 invisible because it is partially visible at the top of a window.
604 If x < 0, this means that abs (x) pixels of the first glyph of
605 the text area of the row are invisible because the glyph is
606 partially visible. */
609 /* Width of the row in pixels without taking face extension at the
610 end of the row into account, and without counting truncation
611 and continuation glyphs at the end of a row on ttys. */
614 /* Logical ascent/height of this line. The value of ascent is zero
615 and height is 1 on terminal frames. */
618 /* Physical ascent/height of this line. If max_ascent > ascent,
619 this line overlaps the line above it on the display. Otherwise,
620 if max_height > height, this line overlaps the line beneath it. */
621 int phys_ascent
, phys_height
;
623 /* Portion of row that is visible. Partially visible rows may be
624 found at the top and bottom of a window. This is 1 for tty
625 frames. It may be < 0 in case of completely invisible rows. */
628 /* Hash code. This hash code is available as soon as the row
629 is constructed, i.e. after a call to display_line. */
632 /* First position in this row. This is the text position, including
633 overlay position information etc, where the display of this row
634 started, and can thus be less the position of the first glyph
635 (e.g. due to invisible text or horizontal scrolling). */
636 struct display_pos start
;
638 /* Text position at the end of this row. This is the position after
639 the last glyph on this row. It can be greater than the last
640 glyph position + 1, due to truncation, invisible text etc. In an
641 up-to-date display, this should always be equal to the start
642 position of the next row. */
643 struct display_pos end
;
645 /* In a desired matrix, 1 means that this row must be updated. In a
646 current matrix, 0 means that the row has been invalidated, i.e.
647 the row's contents do not agree with what is visible on the
649 unsigned enabled_p
: 1;
651 /* 1 means row displays a text line that is truncated on the left or
653 unsigned truncated_on_left_p
: 1;
654 unsigned truncated_on_right_p
: 1;
656 /* 1 means the overlay arrow is on this line. */
657 unsigned overlay_arrow_p
: 1;
659 /* 1 means that this row displays a continued line, i.e. it has a
660 continuation mark at the right side. */
661 unsigned continued_p
: 1;
663 /* 0 means that this row does not contain any text, i.e. it is
664 a blank line at the window and buffer end. */
665 unsigned displays_text_p
: 1;
667 /* 1 means that this line ends at ZV. */
668 unsigned ends_at_zv_p
: 1;
670 /* 1 means the face of the last glyph in the text area is drawn to
671 the right end of the window. This flag is used in
672 update_text_area to optimize clearing to the end of the area. */
673 unsigned fill_line_p
: 1;
675 /* Non-zero means display a bitmap on X frames indicating that this
676 line contains no text and ends in ZV. */
677 unsigned indicate_empty_line_p
: 1;
679 /* 1 means this row contains glyphs that overlap each other because
680 of lbearing or rbearing. */
681 unsigned contains_overlapping_glyphs_p
: 1;
683 /* 1 means this row is as wide as the window it is displayed in, including
684 scroll bars, fringes, and internal borders. This also
685 implies that the row doesn't have marginal areas. */
686 unsigned full_width_p
: 1;
688 /* Non-zero means row is a mode or header-line. */
689 unsigned mode_line_p
: 1;
691 /* 1 in a current row means this row is overlapped by another row. */
692 unsigned overlapped_p
: 1;
694 /* 1 means this line ends in the middle of a character consisting
695 of more than one glyph. Some glyphs have been put in this row,
696 the rest are put in rows below this one. */
697 unsigned ends_in_middle_of_char_p
: 1;
699 /* 1 means this line starts in the middle of a character consisting
700 of more than one glyph. Some glyphs have been put in the
701 previous row, the rest are put in this row. */
702 unsigned starts_in_middle_of_char_p
: 1;
704 /* 1 in a current row means this row overlaps others. */
705 unsigned overlapping_p
: 1;
707 /* 1 means some glyphs in this row are displayed in mouse-face. */
708 unsigned mouse_face_p
: 1;
710 /* 1 means this row was ended by a newline from a string. */
711 unsigned ends_in_newline_from_string_p
: 1;
713 /* Continuation lines width at the start of the row. */
714 int continuation_lines_width
;
718 /* Get a pointer to row number ROW in matrix MATRIX. If GLYPH_DEBUG
719 is defined to a non-zero value, the function matrix_row checks that
720 we don't try to access rows that are out of bounds. */
723 struct glyph_row
*matrix_row
P_ ((struct glyph_matrix
*, int));
724 #define MATRIX_ROW(MATRIX, ROW) matrix_row ((MATRIX), (ROW))
726 #define MATRIX_ROW(MATRIX, ROW) ((MATRIX)->rows + (ROW))
729 /* Return a pointer to the row reserved for the mode line in MATRIX.
730 Row MATRIX->nrows - 1 is always reserved for the mode line. */
732 #define MATRIX_MODE_LINE_ROW(MATRIX) \
733 ((MATRIX)->rows + (MATRIX)->nrows - 1)
735 /* Return a pointer to the row reserved for the header line in MATRIX.
736 This is always the first row in MATRIX because that's the only
737 way that works in frame-based redisplay. */
739 #define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows
741 /* Return a pointer to first row in MATRIX used for text display. */
743 #define MATRIX_FIRST_TEXT_ROW(MATRIX) \
744 ((MATRIX)->rows->mode_line_p ? (MATRIX)->rows + 1 : (MATRIX)->rows)
746 /* Return a pointer to the first glyph in the text area of a row.
747 MATRIX is the glyph matrix accessed, and ROW is the row index in
750 #define MATRIX_ROW_GLYPH_START(MATRIX, ROW) \
751 (MATRIX_ROW ((MATRIX), (ROW))->glyphs[TEXT_AREA])
753 /* Return the number of used glyphs in the text area of a row. */
755 #define MATRIX_ROW_USED(MATRIX, ROW) \
756 (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA])
758 /* Return the character/ byte position at which the display of ROW
761 #define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->start.pos.charpos)
762 #define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->start.pos.bytepos)
764 /* Return the character/ byte position at which ROW ends. */
766 #define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->end.pos.charpos)
767 #define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->end.pos.bytepos)
769 /* Return the vertical position of ROW in MATRIX. */
771 #define MATRIX_ROW_VPOS(ROW, MATRIX) ((ROW) - (MATRIX)->rows)
773 /* Return the last glyph row + 1 in MATRIX on window W reserved for
774 text. If W has a mode line, the last row in the matrix is reserved
777 #define MATRIX_BOTTOM_TEXT_ROW(MATRIX, W) \
780 - (WINDOW_WANTS_MODELINE_P ((W)) ? 1 : 0))
782 /* Non-zero if the face of the last glyph in ROW's text area has
783 to be drawn to the end of the text area. */
785 #define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)
787 /* Set and query the enabled_p flag of glyph row ROW in MATRIX. */
789 #define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
790 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0)
792 #define MATRIX_ROW_ENABLED_P(MATRIX, ROW) \
793 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p)
795 /* Non-zero if ROW displays text. Value is non-zero if the row is
796 blank but displays a line end. */
798 #define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)
800 /* Non-zero if ROW is not completely visible in window W. */
802 #define MATRIX_ROW_PARTIALLY_VISIBLE_P(ROW) \
803 ((ROW)->height != (ROW)->visible_height)
805 /* Non-zero if ROW is partially visible at the top of window W. */
807 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW) \
808 (MATRIX_ROW_PARTIALLY_VISIBLE_P ((ROW)) \
809 && (ROW)->y < WINDOW_DISPLAY_HEADER_LINE_HEIGHT ((W)))
811 /* Non-zero if ROW is partially visible at the bottom of window W. */
813 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW) \
814 (MATRIX_ROW_PARTIALLY_VISIBLE_P ((ROW)) \
815 && (ROW)->y + (ROW)->height > WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE ((W)))
817 /* Return the bottom Y + 1 of ROW. */
819 #define MATRIX_ROW_BOTTOM_Y(ROW) ((ROW)->y + (ROW)->height)
821 /* Is ROW the last visible one in the display described by the
822 iterator structure pointed to by IT?. */
824 #define MATRIX_ROW_LAST_VISIBLE_P(ROW, IT) \
825 (MATRIX_ROW_BOTTOM_Y ((ROW)) >= (IT)->last_visible_y)
827 /* Non-zero if ROW displays a continuation line. */
829 #define MATRIX_ROW_CONTINUATION_LINE_P(ROW) \
830 ((ROW)->continuation_lines_width > 0)
832 /* Non-zero if ROW ends in the middle of a character. This is the
833 case for continued lines showing only part of a display table entry
834 or a control char, or an overlay string. */
836 #define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW) \
837 ((ROW)->end.dpvec_index >= 0 \
838 || (ROW)->end.overlay_string_index >= 0 \
839 || (ROW)->ends_in_middle_of_char_p)
841 /* Non-zero if ROW ends in the middle of an overlay string. */
843 #define MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P(ROW) \
844 ((ROW)->end.overlay_string_index >= 0)
846 /* Non-zero if ROW starts in the middle of a character. See above. */
848 #define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW) \
849 ((ROW)->start.dpvec_index >= 0 \
850 || (ROW)->starts_in_middle_of_char_p \
851 || ((ROW)->start.overlay_string_index >= 0 \
852 && (ROW)->start.string_pos.charpos > 0))
854 /* Non-zero means ROW overlaps its predecessor. */
856 #define MATRIX_ROW_OVERLAPS_PRED_P(ROW) \
857 ((ROW)->phys_ascent > (ROW)->ascent)
859 /* Non-zero means ROW overlaps its successor. */
861 #define MATRIX_ROW_OVERLAPS_SUCC_P(ROW) \
862 ((ROW)->phys_height - (ROW)->phys_ascent \
863 > (ROW)->height - (ROW)->ascent)
865 /* Non-zero means that fonts have been loaded since the last glyph
866 matrix adjustments. The function redisplay_internal adjusts glyph
867 matrices when this flag is non-zero. */
869 extern int fonts_changed_p
;
871 /* A glyph for a space. */
873 extern struct glyph space_glyph
;
875 /* Frame being updated by update_window/update_frame. */
877 extern struct frame
*updating_frame
;
879 /* Window being updated by update_window. This is non-null as long as
880 update_window has not finished, and null otherwise. It's role is
881 analogous to updating_frame. */
883 extern struct window
*updated_window
;
885 /* Glyph row and area updated by update_window_line. */
887 extern struct glyph_row
*updated_row
;
888 extern int updated_area
;
890 /* Non-zero means reading single-character input with prompt so put
891 cursor on mini-buffer after the prompt. Positive means at end of
892 text in echo area; negative means at beginning of line. */
894 extern int cursor_in_echo_area
;
896 /* Non-zero means last display completed. Zero means it was
899 extern int display_completed
;
901 /* Non-zero means redisplay has been performed directly (see also
902 direct_output_for_insert and direct_output_forward_char), so that
903 no further updating has to be performed. The function
904 redisplay_internal checks this flag, and does nothing but reset it
905 to zero if it is non-zero. */
907 extern int redisplay_performed_directly_p
;
909 /* A temporary storage area, including a row of glyphs. Initialized
910 in xdisp.c. Used for various purposes, as an example see
911 direct_output_for_insert. */
913 extern struct glyph_row scratch_glyph_row
;
917 /************************************************************************
919 ************************************************************************/
921 /* Return the height of the mode line in glyph matrix MATRIX, or zero
922 if not known. This macro is called under circumstances where
923 MATRIX might not have been allocated yet. */
925 #define MATRIX_MODE_LINE_HEIGHT(MATRIX) \
926 ((MATRIX) && (MATRIX)->rows \
927 ? MATRIX_MODE_LINE_ROW (MATRIX)->height \
930 /* Return the height of the header line in glyph matrix MATRIX, or zero
931 if not known. This macro is called under circumstances where
932 MATRIX might not have been allocated yet. */
934 #define MATRIX_HEADER_LINE_HEIGHT(MATRIX) \
935 ((MATRIX) && (MATRIX)->rows \
936 ? MATRIX_HEADER_LINE_ROW (MATRIX)->height \
939 /* Return the desired face id for the mode line of a window, depending
940 on whether the window is selected or not, or if the window is the
941 scrolling window for the currently active minibuffer window.
943 Due to the way display_mode_lines manipulates with the contents of
944 selected_window, this macro needs three arguments: SELW which is
945 compared against the current value of selected_window, MBW which is
946 compared against minibuf_window (if SELW doesn't match), and SCRW
947 which is compared against minibuf_selected_window (if MBW matches). */
949 #define CURRENT_MODE_LINE_FACE_ID_3(SELW, MBW, SCRW) \
950 ((!mode_line_in_non_selected_windows \
951 || (SELW) == XWINDOW (selected_window) \
952 || (minibuf_level > 0 \
953 && !NILP (minibuf_selected_window) \
954 && (MBW) == XWINDOW (minibuf_window) \
955 && (SCRW) == XWINDOW (minibuf_selected_window))) \
956 ? MODE_LINE_FACE_ID \
957 : MODE_LINE_INACTIVE_FACE_ID)
960 /* Return the desired face id for the mode line of window W. */
962 #define CURRENT_MODE_LINE_FACE_ID(W) \
963 (CURRENT_MODE_LINE_FACE_ID_3((W), XWINDOW (selected_window), (W)))
965 /* Return the current height of the mode line of window W. If not
966 known from current_mode_line_height, look at W's current glyph
967 matrix, or return a default based on the height of the font of the
970 #define CURRENT_MODE_LINE_HEIGHT(W) \
971 (current_mode_line_height >= 0 \
972 ? current_mode_line_height \
973 : (MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
974 ? MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
975 : estimate_mode_line_height (XFRAME ((W)->frame), \
976 CURRENT_MODE_LINE_FACE_ID (W))))
978 /* Return the current height of the header line of window W. If not
979 known from current_header_line_height, look at W's current glyph
980 matrix, or return an estimation based on the height of the font of
981 the face `header-line'. */
983 #define CURRENT_HEADER_LINE_HEIGHT(W) \
984 (current_header_line_height >= 0 \
985 ? current_header_line_height \
986 : (MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
987 ? MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
988 : estimate_mode_line_height (XFRAME ((W)->frame), \
989 HEADER_LINE_FACE_ID)))
991 /* Return the height of the desired mode line of window W. */
993 #define DESIRED_MODE_LINE_HEIGHT(W) \
994 MATRIX_MODE_LINE_HEIGHT ((W)->desired_matrix)
996 /* Return the height of the desired header line of window W. */
998 #define DESIRED_HEADER_LINE_HEIGHT(W) \
999 MATRIX_HEADER_LINE_HEIGHT ((W)->desired_matrix)
1001 /* Like FRAME_INTERNAL_BORDER_WIDTH but checks whether frame F is a
1002 window-system frame. */
1004 #define FRAME_INTERNAL_BORDER_WIDTH_SAFE(F) \
1005 (FRAME_WINDOW_P (F) ? FRAME_INTERNAL_BORDER_WIDTH (F) : 0)
1007 /* Width of display region of window W. For terminal frames, this
1008 equals the width of W since there are no vertical scroll bars. For
1009 window system frames, the value has to be corrected by the pixel
1010 width of vertical scroll bars, and fringes. */
1012 #define WINDOW_DISPLAY_PIXEL_WIDTH(W) \
1013 (((XFASTINT ((W)->width) \
1014 - FRAME_SCROLL_BAR_WIDTH (XFRAME (WINDOW_FRAME ((W)))) \
1015 - FRAME_FRINGE_COLS (XFRAME (WINDOW_FRAME ((W))))) \
1016 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))))
1018 /* Height of the display region of W, including a mode line, if any. */
1020 #define WINDOW_DISPLAY_PIXEL_HEIGHT(W) \
1021 (XFASTINT ((W)->height) \
1022 * CANON_Y_UNIT (XFRAME (WINDOW_FRAME ((W)))))
1024 /* Height in pixels of the mode line. May be zero if W doesn't have a
1027 #define WINDOW_DISPLAY_MODE_LINE_HEIGHT(W) \
1028 (WINDOW_WANTS_MODELINE_P ((W)) \
1029 ? CURRENT_MODE_LINE_HEIGHT (W) \
1032 /* Height in pixels of the header line. Zero if W doesn't have a header
1035 #define WINDOW_DISPLAY_HEADER_LINE_HEIGHT(W) \
1036 (WINDOW_WANTS_HEADER_LINE_P ((W)) \
1037 ? CURRENT_HEADER_LINE_HEIGHT (W) \
1040 /* Pixel height of window W without mode line. */
1042 #define WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE(W) \
1043 (WINDOW_DISPLAY_PIXEL_HEIGHT ((W)) \
1044 - WINDOW_DISPLAY_MODE_LINE_HEIGHT ((W)))
1046 /* Pixel height of window W without mode and header line. */
1048 #define WINDOW_DISPLAY_TEXT_HEIGHT(W) \
1049 (WINDOW_DISPLAY_PIXEL_HEIGHT ((W)) \
1050 - WINDOW_DISPLAY_MODE_LINE_HEIGHT ((W)) \
1051 - WINDOW_DISPLAY_HEADER_LINE_HEIGHT ((W)))
1053 /* Left edge of W in pixels relative to its frame. */
1055 #define WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X(W) \
1056 (FRAME_INTERNAL_BORDER_WIDTH_SAFE (XFRAME (WINDOW_FRAME ((W)))) \
1057 + (WINDOW_LEFT_MARGIN ((W)) \
1058 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))) \
1059 + FRAME_LEFT_FRINGE_WIDTH (XFRAME (WINDOW_FRAME ((W)))))
1061 /* Right edge of window W in pixels, relative to its frame. */
1063 #define WINDOW_DISPLAY_RIGHT_EDGE_PIXEL_X(W) \
1064 (WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X ((W)) \
1065 + WINDOW_DISPLAY_PIXEL_WIDTH ((W)))
1067 /* Top edge of W in pixels relative to its frame. */
1069 #define WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y(W) \
1070 (FRAME_INTERNAL_BORDER_WIDTH_SAFE (XFRAME (WINDOW_FRAME ((W)))) \
1071 + (XFASTINT ((W)->top) \
1072 * CANON_Y_UNIT (XFRAME (WINDOW_FRAME ((W))))))
1074 /* Bottom edge of window W relative to its frame. */
1076 #define WINDOW_DISPLAY_BOTTOM_EDGE_PIXEL_Y(W) \
1077 (WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y ((W)) \
1078 + WINDOW_DISPLAY_PIXEL_HEIGHT ((W)))
1080 /* Convert window W relative pixel X to frame pixel coordinates. */
1082 #define WINDOW_TO_FRAME_PIXEL_X(W, X) \
1083 ((X) + WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X ((W)))
1085 /* Convert window W relative pixel Y to frame pixel coordinates. */
1087 #define WINDOW_TO_FRAME_PIXEL_Y(W, Y) \
1088 ((Y) + WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y ((W)))
1090 /* Convert frame relative pixel X to window relative pixel X. */
1092 #define FRAME_TO_WINDOW_PIXEL_X(W, X) \
1093 ((X) - WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X ((W)))
1095 /* Convert frame relative pixel Y to window relative pixel Y. */
1097 #define FRAME_TO_WINDOW_PIXEL_Y(W, Y) \
1098 ((Y) - WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y ((W)))
1100 /* Width of left margin area in pixels. */
1102 #define WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH(W) \
1103 (NILP ((W)->left_margin_width) \
1105 : (XINT ((W)->left_margin_width) \
1106 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))))
1108 /* Width of right marginal area in pixels. */
1110 #define WINDOW_DISPLAY_RIGHT_AREA_PIXEL_WIDTH(W) \
1111 (NILP ((W)->right_margin_width) \
1113 : (XINT ((W)->right_margin_width) \
1114 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))))
1116 /* Width of text area in pixels. */
1118 #define WINDOW_DISPLAY_TEXT_AREA_PIXEL_WIDTH(W) \
1119 (WINDOW_DISPLAY_PIXEL_WIDTH ((W)) \
1120 - WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)) \
1121 - WINDOW_DISPLAY_RIGHT_AREA_PIXEL_WIDTH ((W)))
1123 /* Convert a text area relative x-position in window W to frame X
1124 pixel coordinates. */
1126 #define WINDOW_TEXT_TO_FRAME_PIXEL_X(W, X) \
1127 (WINDOW_TO_FRAME_PIXEL_X ((W), (X)) \
1128 + WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)))
1130 /* Translate an x-position relative to AREA in window W to frame pixel
1133 #define WINDOW_AREA_TO_FRAME_PIXEL_X(W, AREA, X) \
1134 (WINDOW_TO_FRAME_PIXEL_X ((W), (X)) \
1135 + (((AREA) > LEFT_MARGIN_AREA) \
1136 ? WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)) \
1138 + (((AREA) > TEXT_AREA) \
1139 ? WINDOW_DISPLAY_TEXT_AREA_PIXEL_WIDTH ((W)) \
1142 /* Return the pixel width of AREA in W. */
1144 #define WINDOW_AREA_PIXEL_WIDTH(W, AREA) \
1145 (((AREA) == TEXT_AREA) \
1146 ? WINDOW_DISPLAY_TEXT_AREA_PIXEL_WIDTH ((W)) \
1147 : (((AREA) == LEFT_MARGIN_AREA) \
1148 ? WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)) \
1149 : WINDOW_DISPLAY_RIGHT_AREA_PIXEL_WIDTH ((W))))
1151 /* Value is non-zero if window W wants a mode line. */
1153 #define WINDOW_WANTS_MODELINE_P(W) \
1154 (!MINI_WINDOW_P ((W)) \
1155 && !(W)->pseudo_window_p \
1156 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1157 && BUFFERP ((W)->buffer) \
1158 && !NILP (XBUFFER ((W)->buffer)->mode_line_format) \
1159 && XFASTINT ((W)->height) > 1)
1161 /* Value is non-zero if window W wants a header line. */
1163 #define WINDOW_WANTS_HEADER_LINE_P(W) \
1164 (!MINI_WINDOW_P ((W)) \
1165 && !(W)->pseudo_window_p \
1166 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1167 && BUFFERP ((W)->buffer) \
1168 && !NILP (XBUFFER ((W)->buffer)->header_line_format) \
1169 && XFASTINT ((W)->height) > 1 + !NILP (XBUFFER ((W)->buffer)->mode_line_format))
1172 /***********************************************************************
1174 ***********************************************************************/
1176 /* Indices of face attributes in Lisp face vectors. Slot zero is the
1179 enum lface_attribute_index
1181 LFACE_FAMILY_INDEX
= 1,
1186 LFACE_UNDERLINE_INDEX
,
1187 LFACE_INVERSE_INDEX
,
1188 LFACE_FOREGROUND_INDEX
,
1189 LFACE_BACKGROUND_INDEX
,
1190 LFACE_STIPPLE_INDEX
,
1191 LFACE_OVERLINE_INDEX
,
1192 LFACE_STRIKE_THROUGH_INDEX
,
1195 LFACE_INHERIT_INDEX
,
1196 LFACE_AVGWIDTH_INDEX
,
1201 /* Box types of faces. */
1205 /* No box around text. */
1208 /* Simple box of specified width and color. Default width is 1, and
1209 default color is the foreground color of the face. */
1212 /* Boxes with 3D shadows. Color equals the background color of the
1213 face. Width is specified. */
1219 /* Structure describing a realized face.
1221 For each Lisp face, 0..N realized faces can exist for different
1222 frames and different charsets. Realized faces are built from Lisp
1223 faces and text properties/overlays by merging faces and adding
1224 unspecified attributes from the `default' face. */
1228 /* The id of this face. The id equals the index of this face in the
1229 vector faces_by_id of its face cache. */
1232 #ifdef HAVE_WINDOW_SYSTEM
1234 /* If non-zero, this is a GC that we can use without modification for
1235 drawing the characters in this face. */
1238 /* Font used for this face, or null if the font could not be loaded
1239 for some reason. This points to a `font' slot of a struct
1240 font_info, and we should not call XFreeFont on it because the
1241 font may still be used somewhere else. */
1244 /* Background stipple or bitmap used for this face. This is
1245 an id as returned from load_pixmap. */
1248 #else /* not HAVE_WINDOW_SYSTEM */
1253 #endif /* not HAVE_WINDOW_SYSTEM */
1255 /* Pixel value of foreground color for X frames. Color index
1257 unsigned long foreground
;
1259 /* Pixel value or color index of background color. */
1260 unsigned long background
;
1262 /* Pixel value or color index of underline color. */
1263 unsigned long underline_color
;
1265 /* Pixel value or color index of overlined, strike-through, or box
1267 unsigned long overline_color
;
1268 unsigned long strike_through_color
;
1269 unsigned long box_color
;
1271 /* The font's name. This points to a `name' of a font_info, and it
1272 must not be freed. */
1275 /* Font info ID for this face's font. An ID is stored here because
1276 pointers to font_info structures may change. The reason is that
1277 they are pointers into a font table vector that is itself
1281 /* Fontset ID if this face uses a fontset, or -1. This is only >= 0
1282 if the face was realized for a composition sequence.
1283 Otherwise, a specific font is loaded from the set of fonts
1284 specified by the fontset given by the family attribute of the face. */
1287 /* Pixmap width and height. */
1288 unsigned int pixmap_w
, pixmap_h
;
1290 /* Non-zero means characters in this face have a box that thickness
1291 around them. If it is negative, the absolute value indicates the
1292 thickness, and the horizontal lines of box (top and bottom) are
1293 drawn inside of characters glyph area. The vertical lines of box
1294 (left and right) are drawn as the same way as the case that this
1295 value is positive. */
1298 /* Type of box drawn. A value of FACE_NO_BOX means no box is drawn
1299 around text in this face. A value of FACE_SIMPLE_BOX means a box
1300 of width box_line_width is drawn in color box_color. A value of
1301 FACE_RAISED_BOX or FACE_SUNKEN_BOX means a 3D box is drawn with
1302 shadow colors derived from the background color of the face. */
1303 enum face_box_type box
;
1305 /* If `box' above specifies a 3D type, 1 means use box_color for
1307 unsigned use_box_color_for_shadows_p
: 1;
1309 /* The Lisp face attributes this face realizes. All attributes
1310 in this vector are non-nil. */
1311 Lisp_Object lface
[LFACE_VECTOR_SIZE
];
1313 /* The hash value of this face. */
1316 /* The charset for which this face was realized if it was realized
1317 for use in multibyte text. If fontset >= 0, this is the charset
1318 of the first character of the composition sequence. A value of
1319 charset < 0 means the face was realized for use in unibyte text
1320 where the idea of Emacs charsets isn't applicable. */
1323 /* Non-zero if text in this face should be underlined, overlined,
1324 strike-through or have a box drawn around it. */
1325 unsigned underline_p
: 1;
1326 unsigned overline_p
: 1;
1327 unsigned strike_through_p
: 1;
1329 /* 1 means that the colors specified for this face could not be
1330 loaded, and were replaced by default colors, so they shouldn't be
1332 unsigned foreground_defaulted_p
: 1;
1333 unsigned background_defaulted_p
: 1;
1335 /* 1 means that either no color is specified for underlining or that
1336 the specified color couldn't be loaded. Use the foreground
1337 color when drawing in that case. */
1338 unsigned underline_defaulted_p
: 1;
1340 /* 1 means that either no color is specified for the corresponding
1341 attribute or that the specified color couldn't be loaded.
1342 Use the foreground color when drawing in that case. */
1343 unsigned overline_color_defaulted_p
: 1;
1344 unsigned strike_through_color_defaulted_p
: 1;
1345 unsigned box_color_defaulted_p
: 1;
1347 /* TTY appearances. Blinking is not yet implemented. Colors are
1348 found in `lface' with empty color string meaning the default
1349 color of the TTY. */
1350 unsigned tty_bold_p
: 1;
1351 unsigned tty_dim_p
: 1;
1352 unsigned tty_underline_p
: 1;
1353 unsigned tty_alt_charset_p
: 1;
1354 unsigned tty_reverse_p
: 1;
1355 unsigned tty_blinking_p
: 1;
1357 /* 1 means that colors of this face may not be freed because they
1358 have been copied bitwise from a base face (see
1360 unsigned colors_copied_bitwise_p
: 1;
1362 /* If non-zero, use overstrike (to simulate bold-face). */
1363 unsigned overstrike
: 1;
1365 /* Next and previous face in hash collision list of face cache. */
1366 struct face
*next
, *prev
;
1368 /* If this face is for ASCII characters, this points this face
1369 itself. Otherwise, this points a face for ASCII characters. */
1370 struct face
*ascii_face
;
1374 /* Color index indicating that face uses a terminal's default color. */
1376 #define FACE_TTY_DEFAULT_COLOR ((unsigned long) -1)
1378 /* Color index indicating that face uses an unknown foreground color. */
1380 #define FACE_TTY_DEFAULT_FG_COLOR ((unsigned long) -2)
1382 /* Color index indicating that face uses an unknown background color. */
1384 #define FACE_TTY_DEFAULT_BG_COLOR ((unsigned long) -3)
1386 /* Non-zero if FACE was realized for unibyte use. */
1388 #define FACE_UNIBYTE_P(FACE) ((FACE)->charset < 0)
1391 /* IDs of important faces known by the C face code. These are the IDs
1392 of the faces for CHARSET_ASCII. */
1398 MODE_LINE_INACTIVE_FACE_ID
,
1401 HEADER_LINE_FACE_ID
,
1407 BASIC_FACE_ID_SENTINEL
1411 /* A cache of realized faces. Each frame has its own cache because
1412 Emacs allows different frame-local face definitions. */
1416 /* Hash table of cached realized faces. */
1417 struct face
**buckets
;
1419 /* Back-pointer to the frame this cache belongs to. */
1422 /* A vector of faces so that faces can be referenced by an ID. */
1423 struct face
**faces_by_id
;
1425 /* The allocated size, and number of used slots of faces_by_id. */
1428 /* Flag indicating that attributes of the `menu' face have been
1430 unsigned menu_face_changed_p
: 1;
1434 /* Prepare face FACE for use on frame F. This must be called before
1435 using X resources of FACE. */
1437 #define PREPARE_FACE_FOR_DISPLAY(F, FACE) \
1438 if ((FACE)->gc == 0) \
1439 prepare_face_for_display ((F), (FACE)); \
1443 /* Return a pointer to the face with ID on frame F, or null if such a
1444 face doesn't exist. */
1446 #define FACE_FROM_ID(F, ID) \
1447 (((unsigned) (ID) < FRAME_FACE_CACHE (F)->used) \
1448 ? FRAME_FACE_CACHE (F)->faces_by_id[ID] \
1451 #ifdef HAVE_WINDOW_SYSTEM
1453 /* Non-zero if FACE is suitable for displaying character CHAR. */
1455 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) \
1456 (SINGLE_BYTE_CHAR_P (CHAR) \
1457 ? (FACE) == (FACE)->ascii_face \
1458 : face_suitable_for_char_p ((FACE), (CHAR)))
1460 /* Return the id of the realized face on frame F that is like the face
1461 with id ID but is suitable for displaying character CHAR.
1462 This macro is only meaningful for multibyte character CHAR. */
1464 #define FACE_FOR_CHAR(F, FACE, CHAR) \
1465 (SINGLE_BYTE_CHAR_P (CHAR) \
1466 ? (FACE)->ascii_face->id \
1467 : face_for_char ((F), (FACE), (CHAR)))
1469 #else /* not HAVE_WINDOW_SYSTEM */
1471 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) 1
1472 #define FACE_FOR_CHAR(F, FACE, CHAR) ((FACE)->id)
1474 #endif /* not HAVE_WINDOW_SYSTEM */
1476 /* Non-zero means face attributes have been changed since the last
1477 redisplay. Used in redisplay_internal. */
1479 extern int face_change_count
;
1484 /***********************************************************************
1486 ***********************************************************************/
1488 enum fringe_bitmap_type
1490 NO_FRINGE_BITMAP
= 0,
1491 LEFT_TRUNCATION_BITMAP
,
1492 RIGHT_TRUNCATION_BITMAP
,
1493 CONTINUED_LINE_BITMAP
,
1494 CONTINUATION_LINE_BITMAP
,
1495 OVERLAY_ARROW_BITMAP
,
1500 struct fringe_bitmap
1505 unsigned char *bits
;
1508 /* Structure used to describe where and how to draw a fringe bitmap.
1509 WHICH is the fringe bitmap to draw. WD and H is the (adjusted)
1510 width and height of the bitmap, DH is the height adjustment (if
1511 bitmap is periodic). X and Y are frame coordinates of the area to
1512 display the bitmap, DY is relative offset of the bitmap into that
1513 area. BX, NX, BY, NY specifies the area to clear if the bitmap
1514 does not fill the entire area. FACE is the fringe face. */
1516 struct draw_fringe_bitmap_params
1518 enum fringe_bitmap_type which
;
1525 extern struct fringe_bitmap fringe_bitmaps
[MAX_FRINGE_BITMAPS
];
1528 /***********************************************************************
1530 ***********************************************************************/
1532 /* Iteration over things to display in current_buffer or in a string.
1534 The iterator handles:
1536 1. Overlay strings (after-string, before-string).
1538 3. Invisible text properties.
1539 4. Selective display.
1540 5. Translation of characters via display tables.
1541 6. Translation of control characters to the forms `\003' or `^C'.
1542 7. `glyph' and `space-width' properties.
1544 Iterators are initialized by calling init_iterator or one of the
1545 equivalent functions below. A call to get_next_display_element
1546 loads the iterator structure with information about what next to
1547 display. A call to set_iterator_to_next increments the iterator's
1550 Characters from overlay strings, display table entries or control
1551 character translations are returned one at a time. For example, if
1552 we have a text of `a\x01' where `a' has a display table definition
1553 of `cd' and the control character is displayed with a leading
1554 arrow, then the iterator will return:
1556 Call Return Source Call next
1557 -----------------------------------------------------------------
1558 next c display table move
1559 next d display table move
1560 next ^ control char move
1561 next A control char move
1563 The same mechanism is also used to return characters for ellipses
1564 displayed at the end of invisible text.
1566 CAVEAT: Under some circumstances, move_.* functions can be called
1567 asynchronously, e.g. when computing a buffer position from an x and
1568 y pixel position. This means that these functions and functions
1569 called from them SHOULD NOT USE xmalloc and alike. See also the
1570 comment at the start of xdisp.c. */
1572 /* Enumeration describing what kind of display element an iterator is
1573 loaded with after a call to get_next_display_element. */
1575 enum display_element_type
1577 /* A normal character. */
1580 /* A composition sequence. */
1586 /* A flexible width and height space. */
1589 /* End of buffer or string. */
1592 /* Truncation glyphs. Never returned by get_next_display_element.
1593 Used to get display information about truncation glyphs via
1597 /* Continuation glyphs. See the comment for IT_TRUNCATION. */
1602 /* An enumerator for each text property that has a meaning for display
1611 COMPOSITION_PROP_IDX
,
1613 /* Not a property. Used to indicate changes in overlays. */
1623 /* The window in which we iterate over current_buffer (or a string). */
1627 /* The window's frame. */
1630 /* Function to call to load this structure with the next display
1632 int (* method
) P_ ((struct it
*it
));
1634 /* The next position at which to check for face changes, invisible
1635 text, overlay strings, end of text etc., which see. */
1638 /* Maximum string or buffer position + 1. ZV when iterating over
1642 /* C string to iterate over. Non-null means get characters from
1643 this string, otherwise characters are read from current_buffer
1647 /* Number of characters in the string (s, or it->string) we iterate
1651 /* Start and end of a visible region; -1 if the region is not
1652 visible in the window. */
1653 int region_beg_charpos
, region_end_charpos
;
1655 /* Position at which redisplay end trigger functions should be run. */
1656 int redisplay_end_trigger_charpos
;
1658 /* 1 means multibyte characters are enabled. */
1659 unsigned multibyte_p
: 1;
1661 /* 1 means window has a mode line at its top. */
1662 unsigned header_line_p
: 1;
1664 /* 1 means `string' is the value of a `display' property.
1665 Don't handle some `display' properties in these strings. */
1666 unsigned string_from_display_prop_p
: 1;
1668 /* Display table in effect or null for none. */
1669 struct Lisp_Char_Table
*dp
;
1671 /* Current display table vector to return characters from and its
1672 end. dpvec null means we are not returning characters from a
1673 display table entry; current.dpvec_index gives the current index
1674 into dpvec. This same mechanism is also used to return
1675 characters from translated control characters, i.e. `\003' or
1677 Lisp_Object
*dpvec
, *dpend
;
1679 /* Length in bytes of the char that filled dpvec. A value of zero
1680 means that no such character is involved. */
1683 /* Face id of the iterator saved in case a glyph from dpvec contains
1684 a face. The face is restored when all glyphs from dpvec have
1688 /* Vector of glyphs for control character translation. The pointer
1689 dpvec is set to ctl_chars when a control character is translated.
1690 This vector is also used for incomplete multibyte character
1691 translation (e.g \222\244). Such a character is at most 4 bytes,
1692 thus we need at most 16 bytes here. */
1693 Lisp_Object ctl_chars
[16];
1695 /* Current buffer or string position of the iterator, including
1696 position in overlay strings etc. */
1697 struct display_pos current
;
1699 /* Vector of overlays to process. Overlay strings are processed
1700 OVERLAY_STRING_CHUNK_SIZE at a time. */
1701 #define OVERLAY_STRING_CHUNK_SIZE 3
1702 Lisp_Object overlay_strings
[OVERLAY_STRING_CHUNK_SIZE
];
1704 /* Total number of overlay strings to process. This can be >
1705 OVERLAY_STRING_CHUNK_SIZE. */
1706 int n_overlay_strings
;
1708 /* If non-nil, a Lisp string being processed. If
1709 current.overlay_string_index >= 0, this is an overlay string from
1713 /* Stack of saved values. New entries are pushed when we begin to
1714 process an overlay string or a string from a `glyph' property.
1715 Entries are popped when we return to deliver display elements
1716 from what we previously had. */
1717 struct iterator_stack_entry
1722 struct display_pos pos
;
1725 enum glyph_row_area area
;
1726 unsigned multibyte_p
: 1;
1727 unsigned string_from_display_prop_p
: 1;
1728 unsigned display_ellipsis_p
: 1;
1729 Lisp_Object space_width
;
1731 Lisp_Object font_height
;
1735 /* Stack pointer. */
1738 /* Setting of buffer-local variable selective-display-ellipsis. */
1739 unsigned selective_display_ellipsis_p
: 1;
1741 /* 1 means control characters are translated into the form `^C'
1742 where the `^' can be replaced by a display table entry. */
1743 unsigned ctl_arrow_p
: 1;
1745 /* -1 means selective display hides everything between a \r and the
1746 next newline; > 0 means hide lines indented more than that value. */
1749 /* An enumeration describing what the next display element is
1750 after a call to get_next_display_element. */
1751 enum display_element_type what
;
1756 /* Non-zero means that the current face has a box. */
1757 unsigned face_box_p
: 1;
1759 /* Non-null means that the current character is the first in a run
1760 of characters with box face. */
1761 unsigned start_of_box_run_p
: 1;
1763 /* Non-zero means that the current character is the last in a run
1764 of characters with box face. */
1765 unsigned end_of_box_run_p
: 1;
1767 /* 1 means overlay strings at end_charpos have been processed. */
1768 unsigned overlay_strings_at_end_processed_p
: 1;
1770 /* 1 means the actual glyph is not available in the current
1772 unsigned glyph_not_available_p
: 1;
1774 /* 1 means the next line in display_line continues a character
1775 consisting of more than one glyph, and some glyphs of this
1776 character have been put on the previous line. */
1777 unsigned starts_in_middle_of_char_p
: 1;
1779 /* If 1, saved_face_id contains the id of the face in front of text
1780 skipped due to selective display. */
1781 unsigned face_before_selective_p
: 1;
1783 /* The ID of the default face to use. One of DEFAULT_FACE_ID,
1784 MODE_LINE_FACE_ID, etc, depending on what we are displaying. */
1787 /* If what == IT_CHARACTER, character and length in bytes. This is
1788 a character from a buffer or string. It may be different from
1789 the character displayed in case that
1790 unibyte_display_via_language_environment is set.
1792 If what == IT_COMPOSITION, the first component of a composition
1793 and length in bytes of the composition. */
1796 /* If what == IT_COMPOSITION, identification number and length in
1797 chars of a composition. */
1798 int cmp_id
, cmp_len
;
1800 /* The character to display, possibly translated to multibyte
1801 if unibyte_display_via_language_environment is set. This
1802 is set after x_produce_glyphs has been called. */
1803 int char_to_display
;
1805 /* If what == IT_IMAGE, the id of the image to display. */
1808 /* Value of the `space-width' property, if any; nil if none. */
1809 Lisp_Object space_width
;
1811 /* Computed from the value of the `raise' property. */
1814 /* Value of the `height' property, if any; nil if none. */
1815 Lisp_Object font_height
;
1817 /* Object and position where the current display element came from.
1818 Object can be a Lisp string in case the current display element
1819 comes from an overlay string, or it is buffer. Position is
1820 a position in object. */
1822 struct text_pos position
;
1824 /* 1 means lines are truncated. */
1825 unsigned truncate_lines_p
: 1;
1827 /* Number of columns per \t. */
1830 /* Width in pixels of truncation and continuation glyphs. */
1831 short truncation_pixel_width
, continuation_pixel_width
;
1833 /* First and last visible x-position in the display area. If window
1834 is hscrolled by n columns, first_visible_x == n * CANON_X_UNIT
1835 (f), and last_visible_x == pixel width of W + first_visible_x. */
1836 int first_visible_x
, last_visible_x
;
1838 /* Last visible y-position + 1 in the display area without a mode
1839 line, if the window has one. */
1842 /* Additional space in pixels between lines (for window systems
1844 int extra_line_spacing
;
1846 /* If non-null, glyphs are produced in glyph_row with each call to
1848 struct glyph_row
*glyph_row
;
1850 /* The area of glyph_row to which glyphs are added. */
1851 enum glyph_row_area area
;
1853 /* Number of glyphs needed for the last character requested via
1854 produce_glyphs. This is 1 except for tabs. */
1857 /* Width of the display element in pixels. Result of
1861 /* Current, maximum logical, and maximum physical line height
1862 information. Result of produce_glyphs. */
1863 int ascent
, descent
, max_ascent
, max_descent
;
1864 int phys_ascent
, phys_descent
, max_phys_ascent
, max_phys_descent
;
1866 /* Current x pixel position within the display line. This value
1867 does not include the width of continuation lines in front of the
1868 line. The value of current_x is automatically incremented by
1869 pixel_width with each call to produce_glyphs. */
1872 /* Accumulated width of continuation lines. If > 0, this means we
1873 are currently in a continuation line. This is initially zero and
1874 incremented/reset by display_line, move_it_to etc. */
1875 int continuation_lines_width
;
1877 /* Current y-position. Automatically incremented by the height of
1878 glyph_row in move_it_to and display_line. */
1881 /* Current vertical matrix position, or line number. Automatically
1882 incremented by move_it_to and display_line. */
1885 /* Horizontal matrix position reached in move_it_in_display_line.
1886 Only set there, not in display_line. */
1891 /* Access to positions of iterator IT. */
1893 #define IT_CHARPOS(IT) CHARPOS ((IT).current.pos)
1894 #define IT_BYTEPOS(IT) BYTEPOS ((IT).current.pos)
1895 #define IT_STRING_CHARPOS(IT) CHARPOS ((IT).current.string_pos)
1896 #define IT_STRING_BYTEPOS(IT) BYTEPOS ((IT).current.string_pos)
1898 /* Test if IT has reached the end of its buffer or string. This will
1899 only work after get_next_display_element has been called. */
1901 #define ITERATOR_AT_END_P(IT) ((IT)->what == IT_EOB)
1903 /* Non-zero means IT is at the end of a line. This is the case if it
1904 is either on a newline or on a carriage return and selective
1905 display hides the rest of the line. */
1907 #define ITERATOR_AT_END_OF_LINE_P(IT) \
1908 ((IT)->what == IT_CHARACTER \
1909 && ((IT)->c == '\n' \
1910 || ((IT)->c == '\r' && (IT)->selective)))
1912 /* Call produce_glyphs or produce_glyphs_hook, if set. Shortcut to
1913 avoid the function call overhead. */
1915 #define PRODUCE_GLYPHS(IT) \
1917 extern int inhibit_free_realized_faces; \
1919 rif->produce_glyphs ((IT)); \
1921 produce_glyphs ((IT)); \
1922 if ((IT)->glyph_row != NULL) \
1923 inhibit_free_realized_faces = 1; \
1926 /* Bit-flags indicating what operation move_it_to should perform. */
1928 enum move_operation_enum
1930 /* Stop if specified x-position is reached. */
1933 /* Stop if specified y-position is reached. */
1936 /* Stop if specified vpos is reached. */
1937 MOVE_TO_VPOS
= 0x04,
1939 /* Stop if specified buffer or string position is reached. */
1945 /***********************************************************************
1946 Window-based redisplay interface
1947 ***********************************************************************/
1949 /* Structure used to describe runs of lines that must be scrolled. */
1953 /* Source and destination y pixel position. */
1954 int desired_y
, current_y
;
1956 /* Source and destination vpos in matrix. */
1957 int desired_vpos
, current_vpos
;
1959 /* Height in pixels, number of glyph rows. */
1964 /* Structure holding system-dependent interface functions needed
1965 for window-based redisplay. */
1967 struct redisplay_interface
1969 /* Produce glyphs/get display metrics for the display element IT is
1971 void (*produce_glyphs
) P_ ((struct it
*it
));
1973 /* Write or insert LEN glyphs from STRING at the nominal output
1975 void (*write_glyphs
) P_ ((struct glyph
*string
, int len
));
1976 void (*insert_glyphs
) P_ ((struct glyph
*start
, int len
));
1978 /* Clear from nominal output position to X. X < 0 means clear
1979 to right end of display. */
1980 void (*clear_end_of_line
) P_ ((int x
));
1982 /* Function to call to scroll the display as described by RUN on
1984 void (*scroll_run_hook
) P_ ((struct window
*w
, struct run
*run
));
1986 /* Function to call after a line in a display has been completely
1987 updated. Used to draw truncation marks and alike. DESIRED_ROW
1988 is the desired row which has been updated. */
1989 void (*after_update_window_line_hook
) P_ ((struct glyph_row
*desired_row
));
1991 /* Function to call before beginning to update window W in
1992 window-based redisplay. */
1993 void (*update_window_begin_hook
) P_ ((struct window
*w
));
1995 /* Function to call after window W has been updated in window-based
1996 redisplay. CURSOR_ON_P non-zero means switch cursor on.
1997 MOUSE_FACE_OVERWRITTEN_P non-zero means that some lines in W
1998 that contained glyphs in mouse-face were overwritten, so we
1999 have to update the mouse highlight. */
2000 void (*update_window_end_hook
) P_ ((struct window
*w
, int cursor_on_p
,
2001 int mouse_face_overwritten_p
));
2003 /* Move cursor to row/column position VPOS/HPOS, pixel coordinates
2004 Y/X. HPOS/VPOS are window-relative row and column numbers and X/Y
2005 are window-relative pixel positions. */
2006 void (*cursor_to
) P_ ((int vpos
, int hpos
, int y
, int x
));
2008 /* Flush the display of frame F. For X, this is XFlush. */
2009 void (*flush_display
) P_ ((struct frame
*f
));
2011 /* Clear the mouse hightlight in window W, if there is any. */
2012 void (*clear_mouse_face
) P_ ((struct window
*w
));
2014 /* Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
2016 void (*get_glyph_overhangs
) P_ ((struct glyph
*glyph
, struct frame
*f
,
2017 int *left
, int *right
));
2019 /* Fix the display of AREA of ROW in window W for overlapping rows.
2020 This function is called from redraw_overlapping_rows after
2021 desired rows have been made current. */
2022 void (*fix_overlapping_area
) P_ ((struct window
*w
, struct glyph_row
*row
,
2023 enum glyph_row_area area
));
2025 /* Draw a fringe bitmap in window W of row ROW using parameters P. */
2026 void (*draw_fringe_bitmap
) P_ ((struct window
*w
, struct glyph_row
*row
,
2027 struct draw_fringe_bitmap_params
*p
));
2031 /* The current interface for window-based redisplay. */
2033 extern struct redisplay_interface
*rif
;
2035 /* Hook to call in estimate_mode_line_height. */
2037 extern int (* estimate_mode_line_height_hook
) P_ ((struct frame
*,
2041 /***********************************************************************
2043 ***********************************************************************/
2045 #ifdef HAVE_WINDOW_SYSTEM
2047 /* Structure forward declarations. */
2052 /* Each image format (JPEG, TIFF, ...) supported is described by
2053 a structure of the type below. */
2057 /* A symbol uniquely identifying the image type, .e.g `jpeg'. */
2060 /* Check that SPEC is a valid image specification for the given
2061 image type. Value is non-zero if SPEC is valid. */
2062 int (* valid_p
) P_ ((Lisp_Object spec
));
2064 /* Load IMG which is used on frame F from information contained in
2065 IMG->spec. Value is non-zero if successful. */
2066 int (* load
) P_ ((struct frame
*f
, struct image
*img
));
2068 /* Free resources of image IMG which is used on frame F. */
2069 void (* free
) P_ ((struct frame
*f
, struct image
*img
));
2071 /* Next in list of all supported image types. */
2072 struct image_type
*next
;
2076 /* Structure describing an image. Specific image formats like XBM are
2077 converted into this form, so that display only has to deal with
2078 this type of image. */
2082 /* The time in seconds at which the image was last displayed. Set
2083 in prepare_image_for_display. */
2084 unsigned long timestamp
;
2086 /* Pixmaps of the image. */
2087 Pixmap pixmap
, mask
;
2089 /* Colors allocated for this image, if any. Allocated via xmalloc. */
2090 unsigned long *colors
;
2093 /* A single `background color' for this image, for the use of anyone that
2094 cares about such a thing. Only valid if the `background_valid' field
2095 is true. This should generally be accessed by calling the accessor
2096 macro `IMAGE_BACKGROUND', which will heuristically calculate a value
2098 unsigned long background
;
2100 /* True if this image has a `transparent' background -- that is, is
2101 uses an image mask. The accessor macro for this is
2102 `IMAGE_BACKGROUND_TRANSPARENT'. */
2103 unsigned background_transparent
: 1;
2105 /* True if the `background' and `background_transparent' fields are
2106 valid, respectively. */
2107 unsigned background_valid
: 1, background_transparent_valid
: 1;
2109 /* Width and height of the image. */
2112 /* These values are used for the rectangles displayed for images
2113 that can't be loaded. */
2114 #define DEFAULT_IMAGE_WIDTH 30
2115 #define DEFAULT_IMAGE_HEIGHT 30
2117 /* Percent of image height used as ascent. A value of
2118 CENTERED_IMAGE_ASCENT means draw the image centered on the
2121 #define DEFAULT_IMAGE_ASCENT 50
2122 #define CENTERED_IMAGE_ASCENT -1
2124 /* Lisp specification of this image. */
2127 /* Relief to draw around the image. */
2130 /* Optional margins around the image. This includes the relief. */
2131 int hmargin
, vmargin
;
2133 /* Reference to the type of the image. */
2134 struct image_type
*type
;
2136 /* 1 means that loading the image failed. Don't try again. */
2137 unsigned load_failed_p
;
2139 /* A place for image types to store additional data. The member
2140 data.lisp_val is marked during GC, so it's safe to store Lisp data
2141 there. Image types should free this data when their `free'
2142 function is called. */
2147 Lisp_Object lisp_val
;
2150 /* Hash value of image specification to speed up comparisons. */
2153 /* Image id of this image. */
2156 /* Hash collision chain. */
2157 struct image
*next
, *prev
;
2161 /* Cache of images. Each frame has a cache. X frames with the same
2162 x_display_info share their caches. */
2166 /* Hash table of images. */
2167 struct image
**buckets
;
2169 /* Vector mapping image ids to images. */
2170 struct image
**images
;
2172 /* Allocated size of `images'. */
2175 /* Number of images in the cache. */
2178 /* Reference count (number of frames sharing this cache). */
2183 /* Value is a pointer to the image with id ID on frame F, or null if
2184 no image with that id exists. */
2186 #define IMAGE_FROM_ID(F, ID) \
2187 (((ID) >= 0 && (ID) < (FRAME_X_IMAGE_CACHE (F)->used)) \
2188 ? FRAME_X_IMAGE_CACHE (F)->images[ID] \
2191 /* Size of bucket vector of image caches. Should be prime. */
2193 #define IMAGE_CACHE_BUCKETS_SIZE 1001
2195 #endif /* HAVE_WINDOW_SYSTEM */
2199 /***********************************************************************
2201 ***********************************************************************/
2203 /* Enumeration defining where to find tool-bar item information in
2204 tool-bar items vectors stored with frames. Each tool-bar item
2205 occupies TOOL_BAR_ITEM_NSLOTS elements in such a vector. */
2207 enum tool_bar_item_idx
2209 /* The key of the tool-bar item. Used to remove items when a binding
2210 for `undefined' is found. */
2213 /* Non-nil if item is enabled. */
2214 TOOL_BAR_ITEM_ENABLED_P
,
2216 /* Non-nil if item is selected (pressed). */
2217 TOOL_BAR_ITEM_SELECTED_P
,
2220 TOOL_BAR_ITEM_CAPTION
,
2222 /* Image(s) to display. This is either a single image specification
2223 or a vector of specifications. */
2224 TOOL_BAR_ITEM_IMAGES
,
2227 TOOL_BAR_ITEM_BINDING
,
2229 /* Button type. One of nil, `:radio' or `:toggle'. */
2235 /* Sentinel = number of slots in tool_bar_items occupied by one
2237 TOOL_BAR_ITEM_NSLOTS
2241 /* An enumeration for the different images that can be specified
2242 for a tool-bar item. */
2244 enum tool_bar_item_image
2246 TOOL_BAR_IMAGE_ENABLED_SELECTED
,
2247 TOOL_BAR_IMAGE_ENABLED_DESELECTED
,
2248 TOOL_BAR_IMAGE_DISABLED_SELECTED
,
2249 TOOL_BAR_IMAGE_DISABLED_DESELECTED
2252 /* Non-zero means raise tool-bar buttons when the mouse moves over them. */
2254 extern int auto_raise_tool_bar_buttons_p
;
2256 /* Margin around tool-bar buttons in pixels. */
2258 extern Lisp_Object Vtool_bar_button_margin
;
2260 /* Thickness of relief to draw around tool-bar buttons. */
2262 extern EMACS_INT tool_bar_button_relief
;
2264 /* Default values of the above variables. */
2266 #define DEFAULT_TOOL_BAR_BUTTON_MARGIN 4
2267 #define DEFAULT_TOOL_BAR_BUTTON_RELIEF 1
2269 /* The height in pixels of the default tool-bar images. */
2271 #define DEFAULT_TOOL_BAR_IMAGE_HEIGHT 24
2274 /***********************************************************************
2275 Terminal Capabilities
2276 ***********************************************************************/
2278 /* Each of these is a bit representing a terminal `capability' (bold,
2279 inverse, etc). They are or'd together to specify the set of
2280 capabilities being queried for when calling `tty_capable_p' (which
2281 returns true if the terminal supports all of them). */
2283 #define TTY_CAP_INVERSE 0x01
2284 #define TTY_CAP_UNDERLINE 0x02
2285 #define TTY_CAP_BOLD 0x04
2286 #define TTY_CAP_DIM 0x08
2287 #define TTY_CAP_BLINK 0x10
2288 #define TTY_CAP_ALT_CHARSET 0x20
2291 /***********************************************************************
2293 ***********************************************************************/
2295 /* Defined in xdisp.c */
2297 struct glyph_row
*row_containing_pos
P_ ((struct window
*, int,
2299 struct glyph_row
*, int));
2300 int string_buffer_position
P_ ((struct window
*, Lisp_Object
, int));
2301 int line_bottom_y
P_ ((struct it
*));
2302 int display_prop_intangible_p
P_ ((Lisp_Object
));
2303 void resize_echo_area_exactly
P_ ((void));
2304 int resize_mini_window
P_ ((struct window
*, int));
2305 int try_window
P_ ((Lisp_Object
, struct text_pos
));
2306 void window_box
P_ ((struct window
*, int, int *, int *, int *, int *));
2307 int window_box_height
P_ ((struct window
*));
2308 int window_text_bottom_y
P_ ((struct window
*));
2309 int window_box_width
P_ ((struct window
*, int));
2310 int window_box_left
P_ ((struct window
*, int));
2311 int window_box_right
P_ ((struct window
*, int));
2312 void window_box_edges
P_ ((struct window
*, int, int *, int *, int *, int *));
2313 void mark_window_display_accurate
P_ ((Lisp_Object
, int));
2314 void redisplay_preserve_echo_area
P_ ((int));
2315 void set_cursor_from_row
P_ ((struct window
*, struct glyph_row
*,
2316 struct glyph_matrix
*, int, int, int, int));
2317 void init_iterator
P_ ((struct it
*, struct window
*, int,
2318 int, struct glyph_row
*, enum face_id
));
2319 void init_iterator_to_row_start
P_ ((struct it
*, struct window
*,
2320 struct glyph_row
*));
2321 int get_next_display_element
P_ ((struct it
*));
2322 void set_iterator_to_next
P_ ((struct it
*, int));
2323 void produce_glyphs
P_ ((struct it
*));
2324 void produce_special_glyphs
P_ ((struct it
*, enum display_element_type
));
2325 void start_display
P_ ((struct it
*, struct window
*, struct text_pos
));
2326 void move_it_to
P_ ((struct it
*, int, int, int, int, int));
2327 void move_it_vertically
P_ ((struct it
*, int));
2328 void move_it_vertically_backward
P_ ((struct it
*, int));
2329 void move_it_by_lines
P_ ((struct it
*, int, int));
2330 void move_it_past_eol
P_ ((struct it
*));
2331 int in_display_vector_p
P_ ((struct it
*));
2332 int frame_mode_line_height
P_ ((struct frame
*));
2333 void highlight_trailing_whitespace
P_ ((struct frame
*, struct glyph_row
*));
2334 int tool_bar_item_info
P_ ((struct frame
*, struct glyph
*, int *));
2335 void draw_row_fringe_bitmaps
P_ ((struct window
*, struct glyph_row
*));
2336 void compute_fringe_widths
P_ ((struct frame
*, int));
2337 extern Lisp_Object Qtool_bar
;
2338 extern Lisp_Object Vshow_trailing_whitespace
;
2339 extern int mode_line_in_non_selected_windows
;
2340 extern int redisplaying_p
;
2341 extern Lisp_Object Vimage_types
;
2342 extern void add_to_log
P_ ((char *, Lisp_Object
, Lisp_Object
));
2343 extern int help_echo_showing_p
;
2344 extern int current_mode_line_height
, current_header_line_height
;
2346 /* Defined in sysdep.c */
2348 void get_frame_size
P_ ((int *, int *));
2349 void request_sigio
P_ ((void));
2350 void unrequest_sigio
P_ ((void));
2351 int tabs_safe_p
P_ ((void));
2352 void init_baud_rate
P_ ((void));
2353 void init_sigio
P_ ((int));
2355 /* Defined in xfaces.c */
2357 #ifdef HAVE_X_WINDOWS
2358 void x_free_colors
P_ ((struct frame
*, unsigned long *, int));
2361 void update_face_from_frame_parameter
P_ ((struct frame
*, Lisp_Object
,
2363 Lisp_Object tty_color_name
P_ ((struct frame
*, int));
2364 void clear_face_cache
P_ ((int));
2365 unsigned long load_color
P_ ((struct frame
*, struct face
*, Lisp_Object
,
2366 enum lface_attribute_index
));
2367 void unload_color
P_ ((struct frame
*, unsigned long));
2368 int frame_update_line_height
P_ ((struct frame
*));
2369 int ascii_face_of_lisp_face
P_ ((struct frame
*, int));
2370 void prepare_face_for_display
P_ ((struct frame
*, struct face
*));
2371 int xstricmp
P_ ((const unsigned char *, const unsigned char *));
2372 int lookup_face
P_ ((struct frame
*, Lisp_Object
*, int, struct face
*));
2373 int lookup_named_face
P_ ((struct frame
*, Lisp_Object
, int));
2374 int smaller_face
P_ ((struct frame
*, int, int));
2375 int face_with_height
P_ ((struct frame
*, int, int));
2376 int lookup_derived_face
P_ ((struct frame
*, Lisp_Object
, int, int));
2377 void init_frame_faces
P_ ((struct frame
*));
2378 void free_frame_faces
P_ ((struct frame
*));
2379 void recompute_basic_faces
P_ ((struct frame
*));
2380 int face_at_buffer_position
P_ ((struct window
*, int, int, int, int *,
2382 int face_at_string_position
P_ ((struct window
*, Lisp_Object
, int, int, int,
2383 int, int *, enum face_id
, int));
2384 int compute_char_face
P_ ((struct frame
*, int, Lisp_Object
));
2385 void free_all_realized_faces
P_ ((Lisp_Object
));
2386 extern Lisp_Object Qforeground_color
, Qbackground_color
;
2387 extern char unspecified_fg
[], unspecified_bg
[];
2388 void free_realized_multibyte_face
P_ ((struct frame
*, int));
2390 /* Defined in xfns.c */
2392 #ifdef HAVE_X_WINDOWS
2393 void gamma_correct
P_ ((struct frame
*, XColor
*));
2396 void gamma_correct
P_ ((struct frame
*, COLORREF
*));
2399 #ifdef HAVE_WINDOW_SYSTEM
2401 void x_kill_gs_process
P_ ((Pixmap
, struct frame
*));
2402 int x_screen_planes
P_ ((struct frame
*));
2403 void x_implicitly_set_name
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
2404 struct image_cache
*make_image_cache
P_ ((void));
2405 void free_image_cache
P_ ((struct frame
*));
2406 void clear_image_cache
P_ ((struct frame
*, int));
2407 void forall_images_in_image_cache
P_ ((struct frame
*,
2408 void (*) P_ ((struct image
*))));
2409 int valid_image_p
P_ ((Lisp_Object
));
2410 void prepare_image_for_display
P_ ((struct frame
*, struct image
*));
2411 int lookup_image
P_ ((struct frame
*, Lisp_Object
));
2413 #ifdef HAVE_X_WINDOWS
2414 unsigned long image_background
P_ ((struct image
*, struct frame
*,
2416 int image_background_transparent
P_ ((struct image
*, struct frame
*,
2418 #endif /* HAVE_X_WINDOWS */
2420 extern Lisp_Object tip_frame
;
2421 extern Window tip_window
;
2422 EXFUN (Fx_show_tip
, 6);
2423 EXFUN (Fx_hide_tip
, 0);
2424 extern void start_hourglass
P_ ((void));
2425 extern void cancel_hourglass
P_ ((void));
2426 extern int display_hourglass_p
;
2428 /* Returns the background color of IMG, calculating one heuristically if
2429 necessary. If non-zero, XIMG is an existing XImage object to use for
2432 #define IMAGE_BACKGROUND(img, f, ximg) \
2433 ((img)->background_valid \
2434 ? (img)->background \
2435 : image_background (img, f, ximg))
2437 /* Returns true if IMG has a `transparent' background, using heuristics
2438 to decide if necessary. If non-zero, MASK is an existing XImage
2439 object to use for the heuristic. */
2441 #define IMAGE_BACKGROUND_TRANSPARENT(img, f, mask) \
2442 ((img)->background_transparent_valid \
2443 ? (img)->background_transparent \
2444 : image_background_transparent (img, f, mask))
2446 #endif /* HAVE_WINDOW_SYSTEM */
2449 /* Defined in xmenu.c */
2451 int popup_activated
P_ ((void));
2453 /* Defined in dispnew.c */
2455 extern int inverse_video
;
2456 extern int required_matrix_width
P_ ((struct window
*));
2457 extern int required_matrix_height
P_ ((struct window
*));
2458 extern int estimate_mode_line_height
P_ ((struct frame
*, enum face_id
));
2459 extern Lisp_Object mode_line_string
P_ ((struct window
*, int, int, int, int *));
2460 extern Lisp_Object marginal_area_string
P_ ((struct window
*, int, int, int, int *));
2461 extern void redraw_frame
P_ ((struct frame
*));
2462 extern void redraw_garbaged_frames
P_ ((void));
2463 extern void cancel_line
P_ ((int, struct frame
*));
2464 extern void init_desired_glyphs
P_ ((struct frame
*));
2465 extern int scroll_frame_lines
P_ ((struct frame
*, int, int, int, int));
2466 extern int direct_output_for_insert
P_ ((int));
2467 extern int direct_output_forward_char
P_ ((int));
2468 extern int update_frame
P_ ((struct frame
*, int, int));
2469 extern int scrolling
P_ ((struct frame
*));
2470 extern void bitch_at_user
P_ ((void));
2471 void adjust_glyphs
P_ ((struct frame
*));
2472 void free_glyphs
P_ ((struct frame
*));
2473 void free_window_matrices
P_ ((struct window
*));
2474 void check_glyph_memory
P_ ((void));
2475 void mirrored_line_dance
P_ ((struct glyph_matrix
*, int, int, int *, char *));
2476 void clear_glyph_matrix
P_ ((struct glyph_matrix
*));
2477 void clear_current_matrices
P_ ((struct frame
*f
));
2478 void clear_desired_matrices
P_ ((struct frame
*));
2479 void shift_glyph_matrix
P_ ((struct window
*, struct glyph_matrix
*,
2481 void rotate_matrix
P_ ((struct glyph_matrix
*, int, int, int));
2482 void increment_matrix_positions
P_ ((struct glyph_matrix
*,
2483 int, int, int, int));
2484 void blank_row
P_ ((struct window
*, struct glyph_row
*, int));
2485 void increment_row_positions
P_ ((struct glyph_row
*, int, int));
2486 void enable_glyph_matrix_rows
P_ ((struct glyph_matrix
*, int, int, int));
2487 void clear_glyph_row
P_ ((struct glyph_row
*));
2488 void prepare_desired_row
P_ ((struct glyph_row
*));
2489 int line_hash_code
P_ ((struct glyph_row
*));
2490 void set_window_update_flags
P_ ((struct window
*, int));
2491 void write_glyphs
P_ ((struct glyph
*, int));
2492 void insert_glyphs
P_ ((struct glyph
*, int));
2493 void redraw_frame
P_ ((struct frame
*));
2494 void redraw_garbaged_frames
P_ ((void));
2495 int scroll_cost
P_ ((struct frame
*, int, int, int));
2496 int direct_output_for_insert
P_ ((int));
2497 int direct_output_forward_char
P_ ((int));
2498 int update_frame
P_ ((struct frame
*, int, int));
2499 void update_single_window
P_ ((struct window
*, int));
2500 int scrolling
P_ ((struct frame
*));
2501 void buffer_posn_from_coords
P_ ((struct window
*, int *, int *,
2502 Lisp_Object
*, struct display_pos
*));
2503 void do_pending_window_change
P_ ((int));
2504 void change_frame_size
P_ ((struct frame
*, int, int, int, int, int));
2505 void bitch_at_user
P_ ((void));
2506 Lisp_Object sit_for
P_ ((int, int, int, int, int));
2507 void init_display
P_ ((void));
2508 void syms_of_display
P_ ((void));
2509 extern Lisp_Object Qredisplay_dont_pause
;
2511 /* Defined in term.c */
2513 extern void ring_bell
P_ ((void));
2514 extern void set_terminal_modes
P_ ((void));
2515 extern void reset_terminal_modes
P_ ((void));
2516 extern void update_begin
P_ ((struct frame
*));
2517 extern void update_end
P_ ((struct frame
*));
2518 extern void set_terminal_window
P_ ((int));
2519 extern void set_scroll_region
P_ ((int, int));
2520 extern void turn_off_insert
P_ ((void));
2521 extern void turn_off_highlight
P_ ((void));
2522 extern void background_highlight
P_ ((void));
2523 extern void clear_frame
P_ ((void));
2524 extern void clear_end_of_line
P_ ((int));
2525 extern void clear_end_of_line_raw
P_ ((int));
2526 extern void delete_glyphs
P_ ((int));
2527 extern void ins_del_lines
P_ ((int, int));
2528 extern int string_cost
P_ ((char *));
2529 extern int per_line_cost
P_ ((char *));
2530 extern void calculate_costs
P_ ((struct frame
*));
2531 extern void set_tty_color_mode
P_ ((struct frame
*, Lisp_Object
));
2532 extern void tty_setup_colors
P_ ((int));
2533 extern void term_init
P_ ((char *));
2534 extern void fatal
P_ ((/* char *, ... */));
2535 void cursor_to
P_ ((int, int));
2536 extern int tty_capable_p
P_ ((struct frame
*, unsigned, unsigned long, unsigned long));
2538 /* Defined in scroll.c */
2540 extern int scrolling_max_lines_saved
P_ ((int, int, int *, int *, int *));
2541 extern int scroll_cost
P_ ((struct frame
*, int, int, int));
2542 extern void do_line_insertion_deletion_costs
P_ ((struct frame
*, char *,
2543 char *, char *, char *,
2544 char *, char *, int));
2545 void scrolling_1
P_ ((struct frame
*, int, int, int, int *, int *, int *,
2548 #endif /* not DISPEXTERN_H_INCLUDED */