1 /* Interface definitions for display code.
2 Copyright (C) 1985, 1993, 1994, 1997, 1998, 1999, 2000, 2001
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
30 #include <X11/Intrinsic.h>
31 #endif /* USE_X_TOOLKIT */
32 #endif /* HAVE_X_WINDOWS */
46 /* Structure forward declarations. Some are here because function
47 prototypes below reference structure types before their definition
48 in this file. Some are here because not every file including
49 dispextern.h also includes frame.h and windows.h. */
60 /***********************************************************************
62 ***********************************************************************/
64 /* If GLYPH_DEBUG is non-zero, additional checks are activated. Turn
65 it off by defining the macro GLYPH_DEBUG to zero. */
71 /* Macros to include code only if GLYPH_DEBUG != 0. */
75 #define xassert(X) do {if (!(X)) abort ();} while (0)
77 #define IF_DEBUG(X) (void) 0
78 #define xassert(X) (void) 0
81 /* Macro for displaying traces of redisplay. If Emacs was compiled
82 with GLYPH_DEBUG != 0, the variable trace_redisplay_p can be set to
83 a non-zero value in debugging sessions to activate traces. */
87 extern int trace_redisplay_p
;
91 if (trace_redisplay_p) \
96 #else /* GLYPH_DEBUG == 0 */
98 #define TRACE(X) (void) 0
100 #endif /* GLYPH_DEBUG == 0 */
104 /***********************************************************************
106 ***********************************************************************/
108 /* Starting with Emacs 20.3, characters from strings and buffers have
109 both a character and a byte position associated with them. The
110 following structure holds such a pair of positions. */
114 /* Character position. */
117 /* Corresponding byte position. */
121 /* Access character and byte position of POS in a functional form. */
123 #define BYTEPOS(POS) (POS).bytepos
124 #define CHARPOS(POS) (POS).charpos
126 /* Set character position of POS to CHARPOS, byte position to BYTEPOS. */
128 #define SET_TEXT_POS(POS, CHARPOS, BYTEPOS) \
129 ((POS).charpos = (CHARPOS), (POS).bytepos = BYTEPOS)
131 /* Increment text position POS. */
133 #define INC_TEXT_POS(POS, MULTIBYTE_P) \
138 INC_POS ((POS).bytepos); \
144 /* Decrement text position POS. */
146 #define DEC_TEXT_POS(POS, MULTIBYTE_P) \
151 DEC_POS ((POS).bytepos); \
157 /* Set text position POS from marker MARKER. */
159 #define SET_TEXT_POS_FROM_MARKER(POS, MARKER) \
160 (CHARPOS (POS) = marker_position ((MARKER)), \
161 BYTEPOS (POS) = marker_byte_position ((MARKER)))
163 /* Set marker MARKER from text position POS. */
165 #define SET_MARKER_FROM_TEXT_POS(MARKER, POS) \
166 set_marker_both ((MARKER), Qnil, CHARPOS ((POS)), BYTEPOS ((POS)))
168 /* Value is non-zero if character and byte positions of POS1 and POS2
171 #define TEXT_POS_EQUAL_P(POS1, POS2) \
172 ((POS1).charpos == (POS2).charpos \
173 && (POS1).bytepos == (POS2).bytepos)
175 /* When rendering glyphs, redisplay scans string or buffer text,
176 overlay strings in that text, and does display table or control
177 character translations. The following structure captures a
178 position taking all this into account. */
182 /* Buffer or string position. */
185 /* If this is a position in an overlay string, overlay_string_index
186 is the index of that overlay string in the sequence of overlay
187 strings at `pos' in the order redisplay processes them. A value
188 < 0 means that this is not a position in an overlay string. */
189 int overlay_string_index
;
191 /* If this is a position in an overlay string, string_pos is the
192 position within that string. */
193 struct text_pos string_pos
;
195 /* If the character at the position above is a control character or
196 has a display table entry, dpvec_index is an index in the display
197 table or control character translation of that character. A
198 value < 0 means this is not a position in such a translation. */
204 /***********************************************************************
206 ***********************************************************************/
208 /* Enumeration of glyph types. Glyph structures contain a type field
209 containing one of the enumerators defined here. */
213 /* Glyph describes a character. */
216 /* Glyph describes a composition sequence. */
219 /* Glyph describes an image. */
222 /* Glyph is a space of fractional width and/or height. */
229 Be extra careful when changing this structure! Esp. make sure that
230 functions producing glyphs, like x_append_glyph, fill ALL of the
231 glyph structure, and that GLYPH_EQUAL_P compares all
232 display-relevant members of glyphs (not to imply that these are the
233 only things to check when you add a member). */
237 /* Position from which this glyph was drawn. If `object' below is a
238 Lisp string, this is a position in that string. If it is a
239 buffer, this is a position in that buffer. A value of -1
240 together with a null object means glyph is a truncation glyph at
241 the start of a row. */
244 /* Lisp object source of this glyph. Currently either a buffer or
245 a string, if the glyph was produced from characters which came from
246 a buffer or a string; or 0 if the glyph was inserted by redisplay
247 for its own purposes such as padding. */
250 /* Width in pixels. */
253 /* Vertical offset. If < 0, the glyph is displayed raised, if > 0
254 the glyph is displayed lowered. */
257 /* Which kind of glyph this is---character, image etc. Value
258 should be an enumerator of type enum glyph_type. */
261 /* 1 means this glyph was produced from multibyte text. Zero
262 means it was produced from unibyte text, i.e. charsets aren't
263 applicable, and encoding is not performed. */
264 unsigned multibyte_p
: 1;
266 /* Non-zero means draw a box line at the left or right side of this
267 glyph. This is part of the implementation of the face attribute
269 unsigned left_box_line_p
: 1;
270 unsigned right_box_line_p
: 1;
272 /* Non-zero means this glyph's physical ascent or descent is greater
273 than its logical ascent/descent, i.e. it may potentially overlap
274 glyphs above or below it. */
275 unsigned overlaps_vertically_p
: 1;
277 /* 1 means glyph is a padding glyph. Padding glyphs are used for
278 characters whose visual shape consists of more than one glyph
279 (e.g. Asian characters). All but the first glyph of such a glyph
280 sequence have the padding_p flag set. Only used for terminal
281 frames, and there only to minimize code changes. A better way
282 would probably be to use the width field of glyphs to express
284 unsigned padding_p
: 1;
286 /* 1 means the actual glyph is not available, draw a box instead.
287 This can happen when a font couldn't be loaded, or a character
288 doesn't have a glyph in a font. */
289 unsigned glyph_not_available_p
: 1;
291 /* Face of the glyph. */
292 unsigned face_id
: 22;
295 /* Type of font used to display the character glyph. Used to
296 determine which set of functions to use to obtain font metrics
297 for the glyph. Value should be an enumerator of the type
298 w32_char_font_type. */
299 unsigned w32_font_type
: 2;
302 /* A union of sub-structures for different glyph types. */
305 /* Character code for character glyphs (type == CHAR_GLYPH). */
308 /* Composition ID for composition glyphs (type == COMPOSITION_GLYPH) */
311 /* Image ID for image glyphs (type == IMAGE_GLYPH). */
314 /* Sub-structure for type == STRETCH_GLYPH. */
317 /* The height of the glyph. */
318 unsigned height
: 16;
320 /* The ascent of the glyph. */
321 unsigned ascent
: 16;
325 /* Used to compare all bit-fields above in one step. */
331 /* Is GLYPH a space? */
333 #define CHAR_GLYPH_SPACE_P(GLYPH) \
334 (GLYPH_FROM_CHAR_GLYPH ((GLYPH)) == SPACEGLYPH)
336 /* Are glyphs *X and *Y displayed equal? */
338 #define GLYPH_EQUAL_P(X, Y) \
339 ((X)->type == (Y)->type \
340 && (X)->u.val == (Y)->u.val \
341 && (X)->face_id == (Y)->face_id \
342 && (X)->padding_p == (Y)->padding_p \
343 && (X)->left_box_line_p == (Y)->left_box_line_p \
344 && (X)->right_box_line_p == (Y)->right_box_line_p \
345 && (X)->voffset == (Y)->voffset \
346 && (X)->pixel_width == (Y)->pixel_width)
348 /* Are character codes, faces, padding_ps of glyphs *X and *Y equal? */
350 #define GLYPH_CHAR_AND_FACE_EQUAL_P(X, Y) \
351 ((X)->u.ch == (Y)->u.ch \
352 && (X)->face_id == (Y)->face_id \
353 && (X)->padding_p == (Y)->padding_p)
355 /* Fill a character glyph GLYPH. CODE, FACE_ID, PADDING_P correspond
356 to the bits defined for the typedef `GLYPH' in lisp.h. */
358 #define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P) \
361 (GLYPH).u.ch = (CODE); \
362 (GLYPH).face_id = (FACE_ID); \
363 (GLYPH).padding_p = (PADDING_P); \
367 /* Fill a character type glyph GLYPH from a glyph typedef FROM as
368 defined in lisp.h. */
370 #define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM) \
371 SET_CHAR_GLYPH ((GLYPH), \
372 FAST_GLYPH_CHAR ((FROM)), \
373 FAST_GLYPH_FACE ((FROM)), \
376 /* Construct a glyph code from a character glyph GLYPH. If the
377 character is multibyte, return -1 as we can't use glyph table for a
378 multibyte character. */
380 #define GLYPH_FROM_CHAR_GLYPH(GLYPH) \
381 ((GLYPH).u.ch < 256 \
382 ? ((GLYPH).u.ch | ((GLYPH).face_id << CHARACTERBITS)) \
385 /* Is GLYPH a padding glyph? */
387 #define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p
392 /***********************************************************************
394 ***********************************************************************/
398 Glyph memory for frame-based redisplay is allocated from the heap
399 in one vector kept in a glyph pool structure which is stored with
400 the frame. The size of the vector is made large enough to cover
401 all windows on the frame.
403 Both frame and window glyph matrices reference memory from a glyph
404 pool in frame-based redisplay.
406 In window-based redisplay, no glyphs pools exist; windows allocate
407 and free their glyph memory themselves. */
411 /* Vector of glyphs allocated from the heap. */
412 struct glyph
*glyphs
;
414 /* Allocated size of `glyphs'. */
417 /* Number of rows and columns in a matrix. */
423 /***********************************************************************
425 ***********************************************************************/
429 Three kinds of glyph matrices exist:
431 1. Frame glyph matrices. These are used for terminal frames whose
432 redisplay needs a view of the whole screen due to limited terminal
433 capabilities. Frame matrices are used only in the update phase
434 of redisplay. They are built in update_frame and not used after
435 the update has been performed.
437 2. Window glyph matrices on frames having frame glyph matrices.
438 Such matrices are sub-matrices of their corresponding frame matrix,
439 i.e. frame glyph matrices and window glyph matrices share the same
440 glyph memory which is allocated in form of a glyph_pool structure.
441 Glyph rows in such a window matrix are slices of frame matrix rows.
443 2. Free-standing window glyph matrices managing their own glyph
444 storage. This form is used in window-based redisplay which
445 includes variable width and height fonts etc.
447 The size of a window's row vector depends on the height of fonts
448 defined on its frame. It is chosen so that the vector is large
449 enough to describe all lines in a window when it is displayed in
450 the smallest possible character size. When new fonts are loaded,
451 or window sizes change, the row vector is adjusted accordingly. */
455 /* The pool from which glyph memory is allocated, if any. This is
456 null for frame matrices and for window matrices managing their
458 struct glyph_pool
*pool
;
460 /* Vector of glyph row structures. The row at nrows - 1 is reserved
461 for the mode line. */
462 struct glyph_row
*rows
;
464 /* Number of elements allocated for the vector rows above. */
467 /* The number of rows used by the window if all lines were displayed
468 with the smallest possible character height. */
471 /* Origin within the frame matrix if this is a window matrix on a
472 frame having a frame matrix. Both values are zero for
473 window-based redisplay. */
474 int matrix_x
, matrix_y
;
476 /* Width and height of the matrix in columns and rows. */
477 int matrix_w
, matrix_h
;
479 /* If this structure describes a window matrix of window W,
480 window_left_x is the value of W->left, window_top_y the value of
481 W->top, window_height and window_width are width and height of W,
482 as returned by window_box, and window_vscroll is the value of
483 W->vscroll at the time the matrix was last adjusted. Only set
484 for window-based redisplay. */
485 int window_left_x
, window_top_y
, window_height
, window_width
, window_vscroll
;
487 /* Number of glyphs reserved for left and right marginal areas when
488 the matrix was last adjusted. */
489 int left_margin_glyphs
, right_margin_glyphs
;
491 /* Flag indicating that scrolling should not be tried in
492 update_window. This flag is set by functions like try_window_id
493 which do their own scrolling. */
494 unsigned no_scrolling_p
: 1;
496 /* Non-zero means window displayed in this matrix has a top mode
498 unsigned header_line_p
: 1;
501 /* A string identifying the method used to display the matrix. */
505 /* The buffer this matrix displays. Set in
506 mark_window_display_accurate_1. */
507 struct buffer
*buffer
;
509 /* Values of BEGV and ZV as of last redisplay. Set in
510 mark_window_display_accurate_1. */
515 /* Check that glyph pointers stored in glyph rows of MATRIX are okay.
516 This aborts if any pointer is found twice. */
519 void check_matrix_pointer_lossage
P_ ((struct glyph_matrix
*));
520 #define CHECK_MATRIX(MATRIX) check_matrix_pointer_lossage ((MATRIX))
522 #define CHECK_MATRIX(MATRIX) (void) 0
527 /***********************************************************************
529 ***********************************************************************/
531 /* Area in window glyph matrix. If values are added or removed, the
532 function mark_object in alloc.c has to be changed. */
543 /* Rows of glyphs in a windows or frame glyph matrix.
545 Each row is partitioned into three areas. The start and end of
546 each area is recorded in a pointer as shown below.
548 +--------------------+-------------+---------------------+
549 | left margin area | text area | right margin area |
550 +--------------------+-------------+---------------------+
552 glyphs[LEFT_MARGIN_AREA] glyphs[RIGHT_MARGIN_AREA]
557 Rows in frame matrices reference glyph memory allocated in a frame
558 glyph pool (see the description of struct glyph_pool). Rows in
559 window matrices on frames having frame matrices reference slices of
560 the glyphs of corresponding rows in the frame matrix.
562 Rows in window matrices on frames having no frame matrices point to
563 glyphs allocated from the heap via xmalloc;
564 glyphs[LEFT_MARGIN_AREA] is the start address of the allocated
565 glyph structure array. */
569 /* Pointers to beginnings of areas. The end of an area A is found at
570 A + 1 in the vector. The last element of the vector is the end
573 Kludge alert: Even if used[TEXT_AREA] == 0, glyphs[TEXT_AREA][0]'s
574 position field is used. It is -1 if this row does not correspond
575 to any text; it is some buffer position if the row corresponds to
576 an empty display line that displays a line end. This is what old
577 redisplay used to do. (Except in code for terminal frames, this
578 kludge is no longer used, I believe. --gerd).
580 See also start, end, displays_text_p and ends_at_zv_p for cleaner
581 ways to do it. The special meaning of positions 0 and -1 will be
582 removed some day, so don't use it in new code. */
583 struct glyph
*glyphs
[1 + LAST_AREA
];
585 /* Number of glyphs actually filled in areas. */
586 short used
[LAST_AREA
];
588 /* Window-relative x and y-position of the top-left corner of this
589 row. If y < 0, this means that abs (y) pixels of the row are
590 invisible because it is partially visible at the top of a window.
591 If x < 0, this means that abs (x) pixels of the first glyph of
592 the text area of the row are invisible because the glyph is
593 partially visible. */
596 /* Width of the row in pixels without taking face extension at the
597 end of the row into account, and without counting truncation
598 and continuation glyphs at the end of a row on ttys. */
601 /* Logical ascent/height of this line. The value of ascent is zero
602 and height is 1 on terminal frames. */
605 /* Physical ascent/height of this line. If max_ascent > ascent,
606 this line overlaps the line above it on the display. Otherwise,
607 if max_height > height, this line overlaps the line beneath it. */
608 int phys_ascent
, phys_height
;
610 /* Portion of row that is visible. Partially visible rows may be
611 found at the top and bottom of a window. This is 1 for tty
612 frames. It may be < 0 in case of completely invisible rows. */
615 /* Hash code. This hash code is available as soon as the row
616 is constructed, i.e. after a call to display_line. */
619 /* First position in this row. This is the text position, including
620 overlay position information etc, where the display of this row
621 started, and can thus be less the position of the first glyph
622 (e.g. due to invisible text or horizontal scrolling). */
623 struct display_pos start
;
625 /* Text position at the end of this row. This is the position after
626 the last glyph on this row. It can be greater than the last
627 glyph position + 1, due to truncation, invisible text etc. In an
628 up-to-date display, this should always be equal to the start
629 position of the next row. */
630 struct display_pos end
;
632 /* In a desired matrix, 1 means that this row must be updated. In a
633 current matrix, 0 means that the row has been invalidated, i.e.
634 the row's contents do not agree with what is visible on the
636 unsigned enabled_p
: 1;
638 /* 1 means row displays a text line that is truncated on the left or
640 unsigned truncated_on_left_p
: 1;
641 unsigned truncated_on_right_p
: 1;
643 /* 1 means the overlay arrow is on this line. */
644 unsigned overlay_arrow_p
: 1;
646 /* 1 means that this row displays a continued line, i.e. it has a
647 continuation mark at the right side. */
648 unsigned continued_p
: 1;
650 /* 0 means that this row does not contain any text, i.e. it is
651 a blank line at the window and buffer end. */
652 unsigned displays_text_p
: 1;
654 /* 1 means that this line ends at ZV. */
655 unsigned ends_at_zv_p
: 1;
657 /* 1 means the face of the last glyph in the text area is drawn to
658 the right end of the window. This flag is used in
659 update_text_area to optimize clearing to the end of the area. */
660 unsigned fill_line_p
: 1;
662 /* Non-zero means display a bitmap on X frames indicating that this
663 line contains no text and ends in ZV. */
664 unsigned indicate_empty_line_p
: 1;
666 /* 1 means this row contains glyphs that overlap each other because
667 of lbearing or rbearing. */
668 unsigned contains_overlapping_glyphs_p
: 1;
670 /* 1 means this row is as wide as the window it is displayed in, including
671 scroll bars, fringes, and internal borders. This also
672 implies that the row doesn't have marginal areas. */
673 unsigned full_width_p
: 1;
675 /* Non-zero means row is a mode or header-line. */
676 unsigned mode_line_p
: 1;
678 /* 1 in a current row means this row is overlapped by another row. */
679 unsigned overlapped_p
: 1;
681 /* 1 means this line ends in the middle of a character consisting
682 of more than one glyph. Some glyphs have been put in this row,
683 the rest are put in rows below this one. */
684 unsigned ends_in_middle_of_char_p
: 1;
686 /* 1 means this line starts in the middle of a character consisting
687 of more than one glyph. Some glyphs have been put in the
688 previous row, the rest are put in this row. */
689 unsigned starts_in_middle_of_char_p
: 1;
691 /* 1 in a current row means this row overlaps others. */
692 unsigned overlapping_p
: 1;
694 /* 1 means some glyphs in this row are displayed in mouse-face. */
695 unsigned mouse_face_p
: 1;
697 /* 1 means this row was ended by a newline from a string. */
698 unsigned ends_in_newline_from_string_p
: 1;
700 /* Continuation lines width at the start of the row. */
701 int continuation_lines_width
;
705 /* Get a pointer to row number ROW in matrix MATRIX. If GLYPH_DEBUG
706 is defined to a non-zero value, the function matrix_row checks that
707 we don't try to access rows that are out of bounds. */
710 struct glyph_row
*matrix_row
P_ ((struct glyph_matrix
*, int));
711 #define MATRIX_ROW(MATRIX, ROW) matrix_row ((MATRIX), (ROW))
713 #define MATRIX_ROW(MATRIX, ROW) ((MATRIX)->rows + (ROW))
716 /* Return a pointer to the row reserved for the mode line in MATRIX.
717 Row MATRIX->nrows - 1 is always reserved for the mode line. */
719 #define MATRIX_MODE_LINE_ROW(MATRIX) \
720 ((MATRIX)->rows + (MATRIX)->nrows - 1)
722 /* Return a pointer to the row reserved for the header line in MATRIX.
723 This is always the first row in MATRIX because that's the only
724 way that works in frame-based redisplay. */
726 #define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows
728 /* Return a pointer to first row in MATRIX used for text display. */
730 #define MATRIX_FIRST_TEXT_ROW(MATRIX) \
731 ((MATRIX)->rows->mode_line_p ? (MATRIX)->rows + 1 : (MATRIX)->rows)
733 /* Return a pointer to the first glyph in the text area of a row.
734 MATRIX is the glyph matrix accessed, and ROW is the row index in
737 #define MATRIX_ROW_GLYPH_START(MATRIX, ROW) \
738 (MATRIX_ROW ((MATRIX), (ROW))->glyphs[TEXT_AREA])
740 /* Return the number of used glyphs in the text area of a row. */
742 #define MATRIX_ROW_USED(MATRIX, ROW) \
743 (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA])
745 /* Return the character/ byte position at which the display of ROW
748 #define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->start.pos.charpos)
749 #define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->start.pos.bytepos)
751 /* Return the character/ byte position at which ROW ends. */
753 #define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->end.pos.charpos)
754 #define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->end.pos.bytepos)
756 /* Return the vertical position of ROW in MATRIX. */
758 #define MATRIX_ROW_VPOS(ROW, MATRIX) ((ROW) - (MATRIX)->rows)
760 /* Return the last glyph row + 1 in MATRIX on window W reserved for
761 text. If W has a mode line, the last row in the matrix is reserved
764 #define MATRIX_BOTTOM_TEXT_ROW(MATRIX, W) \
767 - (WINDOW_WANTS_MODELINE_P ((W)) ? 1 : 0))
769 /* Non-zero if the face of the last glyph in ROW's text area has
770 to be drawn to the end of the text area. */
772 #define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)
774 /* Set and query the enabled_p flag of glyph row ROW in MATRIX. */
776 #define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
777 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0)
779 #define MATRIX_ROW_ENABLED_P(MATRIX, ROW) \
780 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p)
782 /* Non-zero if ROW displays text. Value is non-zero if the row is
783 blank but displays a line end. */
785 #define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)
787 /* Non-zero if ROW is not completely visible in window W. */
789 #define MATRIX_ROW_PARTIALLY_VISIBLE_P(ROW) \
790 ((ROW)->height != (ROW)->visible_height)
792 /* Non-zero if ROW is partially visible at the top of window W. */
794 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW) \
795 (MATRIX_ROW_PARTIALLY_VISIBLE_P ((ROW)) \
796 && (ROW)->y < WINDOW_DISPLAY_HEADER_LINE_HEIGHT ((W)))
798 /* Non-zero if ROW is partially visible at the bottom of window W. */
800 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW) \
801 (MATRIX_ROW_PARTIALLY_VISIBLE_P ((ROW)) \
802 && (ROW)->y + (ROW)->height > WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE ((W)))
804 /* Return the bottom Y + 1 of ROW. */
806 #define MATRIX_ROW_BOTTOM_Y(ROW) ((ROW)->y + (ROW)->height)
808 /* Is ROW the last visible one in the display described by the
809 iterator structure pointed to by IT?. */
811 #define MATRIX_ROW_LAST_VISIBLE_P(ROW, IT) \
812 (MATRIX_ROW_BOTTOM_Y ((ROW)) >= (IT)->last_visible_y)
814 /* Non-zero if ROW displays a continuation line. */
816 #define MATRIX_ROW_CONTINUATION_LINE_P(ROW) \
817 ((ROW)->continuation_lines_width > 0)
819 /* Non-zero if ROW ends in the middle of a character. This is the
820 case for continued lines showing only part of a display table entry
821 or a control char, or an overlay string. */
823 #define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW) \
824 ((ROW)->end.dpvec_index >= 0 \
825 || (ROW)->end.overlay_string_index >= 0 \
826 || (ROW)->ends_in_middle_of_char_p)
828 /* Non-zero if ROW ends in the middle of an overlay string. */
830 #define MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P(ROW) \
831 ((ROW)->end.overlay_string_index >= 0)
833 /* Non-zero if ROW starts in the middle of a character. See above. */
835 #define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW) \
836 ((ROW)->start.dpvec_index >= 0 \
837 || (ROW)->starts_in_middle_of_char_p \
838 || ((ROW)->start.overlay_string_index >= 0 \
839 && (ROW)->start.string_pos.charpos > 0))
841 /* Non-zero means ROW overlaps its predecessor. */
843 #define MATRIX_ROW_OVERLAPS_PRED_P(ROW) \
844 ((ROW)->phys_ascent > (ROW)->ascent)
846 /* Non-zero means ROW overlaps its successor. */
848 #define MATRIX_ROW_OVERLAPS_SUCC_P(ROW) \
849 ((ROW)->phys_height - (ROW)->phys_ascent \
850 > (ROW)->height - (ROW)->ascent)
852 /* Non-zero means that fonts have been loaded since the last glyph
853 matrix adjustments. The function redisplay_internal adjusts glyph
854 matrices when this flag is non-zero. */
856 extern int fonts_changed_p
;
858 /* A glyph for a space. */
860 extern struct glyph space_glyph
;
862 /* Frame being updated by update_window/update_frame. */
864 extern struct frame
*updating_frame
;
866 /* Window being updated by update_window. This is non-null as long as
867 update_window has not finished, and null otherwise. It's role is
868 analogous to updating_frame. */
870 extern struct window
*updated_window
;
872 /* Glyph row and area updated by update_window_line. */
874 extern struct glyph_row
*updated_row
;
875 extern int updated_area
;
877 /* Non-zero means reading single-character input with prompt so put
878 cursor on mini-buffer after the prompt. Positive means at end of
879 text in echo area; negative means at beginning of line. */
881 extern int cursor_in_echo_area
;
883 /* Non-zero means last display completed. Zero means it was
886 extern int display_completed
;
888 /* Non-zero means redisplay has been performed directly (see also
889 direct_output_for_insert and direct_output_forward_char), so that
890 no further updating has to be performed. The function
891 redisplay_internal checks this flag, and does nothing but reset it
892 to zero if it is non-zero. */
894 extern int redisplay_performed_directly_p
;
896 /* A temporary storage area, including a row of glyphs. Initialized
897 in xdisp.c. Used for various purposes, as an example see
898 direct_output_for_insert. */
900 extern struct glyph_row scratch_glyph_row
;
904 /************************************************************************
906 ************************************************************************/
908 /* Return the height of the mode line in glyph matrix MATRIX, or zero
909 if not known. This macro is called under circumstances where
910 MATRIX might not have been allocated yet. */
912 #define MATRIX_MODE_LINE_HEIGHT(MATRIX) \
913 ((MATRIX) && (MATRIX)->rows \
914 ? MATRIX_MODE_LINE_ROW (MATRIX)->height \
917 /* Return the height of the header line in glyph matrix MATRIX, or zero
918 if not known. This macro is called under circumstances where
919 MATRIX might not have been allocated yet. */
921 #define MATRIX_HEADER_LINE_HEIGHT(MATRIX) \
922 ((MATRIX) && (MATRIX)->rows \
923 ? MATRIX_HEADER_LINE_ROW (MATRIX)->height \
926 /* Return the desired face id for the mode line of window W.
927 This depends on whether the window is selected or not. */
929 #define CURRENT_MODE_LINE_FACE_ID(W) \
930 ((W) == XWINDOW (selected_window) \
931 ? MODE_LINE_FACE_ID \
932 : MODE_LINE_INACTIVE_FACE_ID)
934 /* Return the current height of the mode line of window W. If not
935 known from current_mode_line_height, look at W's current glyph
936 matrix, or return a default based on the height of the font of the
939 #define CURRENT_MODE_LINE_HEIGHT(W) \
940 (current_mode_line_height >= 0 \
941 ? current_mode_line_height \
942 : (MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
943 ? MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
944 : estimate_mode_line_height (XFRAME ((W)->frame), \
945 CURRENT_MODE_LINE_FACE_ID (W))))
947 /* Return the current height of the header line of window W. If not
948 known from current_header_line_height, look at W's current glyph
949 matrix, or return an estimation based on the height of the font of
950 the face `header-line'. */
952 #define CURRENT_HEADER_LINE_HEIGHT(W) \
953 (current_header_line_height >= 0 \
954 ? current_header_line_height \
955 : (MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
956 ? MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
957 : estimate_mode_line_height (XFRAME ((W)->frame), \
958 HEADER_LINE_FACE_ID)))
960 /* Return the height of the desired mode line of window W. */
962 #define DESIRED_MODE_LINE_HEIGHT(W) \
963 MATRIX_MODE_LINE_HEIGHT ((W)->desired_matrix)
965 /* Return the height of the desired header line of window W. */
967 #define DESIRED_HEADER_LINE_HEIGHT(W) \
968 MATRIX_HEADER_LINE_HEIGHT ((W)->desired_matrix)
970 /* Like FRAME_INTERNAL_BORDER_WIDTH but checks whether frame F is a
971 window-system frame. */
973 #define FRAME_INTERNAL_BORDER_WIDTH_SAFE(F) \
974 (FRAME_WINDOW_P (F) ? FRAME_INTERNAL_BORDER_WIDTH (F) : 0)
976 /* Width of display region of window W. For terminal frames, this
977 equals the width of W since there are no vertical scroll bars. For
978 window system frames, the value has to be corrected by the pixel
979 width of vertical scroll bars, and fringes. */
981 #define WINDOW_DISPLAY_PIXEL_WIDTH(W) \
982 (((XFASTINT ((W)->width) \
983 - FRAME_SCROLL_BAR_WIDTH (XFRAME (WINDOW_FRAME ((W)))) \
984 - FRAME_FRINGE_COLS (XFRAME (WINDOW_FRAME ((W))))) \
985 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))))
987 /* Height of the display region of W, including a mode line, if any. */
989 #define WINDOW_DISPLAY_PIXEL_HEIGHT(W) \
990 (XFASTINT ((W)->height) \
991 * CANON_Y_UNIT (XFRAME (WINDOW_FRAME ((W)))))
993 /* Height in pixels of the mode line. May be zero if W doesn't have a
996 #define WINDOW_DISPLAY_MODE_LINE_HEIGHT(W) \
997 (WINDOW_WANTS_MODELINE_P ((W)) \
998 ? CURRENT_MODE_LINE_HEIGHT (W) \
1001 /* Height in pixels of the header line. Zero if W doesn't have a header
1004 #define WINDOW_DISPLAY_HEADER_LINE_HEIGHT(W) \
1005 (WINDOW_WANTS_HEADER_LINE_P ((W)) \
1006 ? CURRENT_HEADER_LINE_HEIGHT (W) \
1009 /* Pixel height of window W without mode line. */
1011 #define WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE(W) \
1012 (WINDOW_DISPLAY_PIXEL_HEIGHT ((W)) \
1013 - WINDOW_DISPLAY_MODE_LINE_HEIGHT ((W)))
1015 /* Pixel height of window W without mode and header line. */
1017 #define WINDOW_DISPLAY_TEXT_HEIGHT(W) \
1018 (WINDOW_DISPLAY_PIXEL_HEIGHT ((W)) \
1019 - WINDOW_DISPLAY_MODE_LINE_HEIGHT ((W)) \
1020 - WINDOW_DISPLAY_HEADER_LINE_HEIGHT ((W)))
1022 /* Left edge of W in pixels relative to its frame. */
1024 #define WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X(W) \
1025 (FRAME_INTERNAL_BORDER_WIDTH_SAFE (XFRAME (WINDOW_FRAME ((W)))) \
1026 + (WINDOW_LEFT_MARGIN ((W)) \
1027 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))) \
1028 + FRAME_LEFT_FRINGE_WIDTH (XFRAME (WINDOW_FRAME ((W)))))
1030 /* Right edge of window W in pixels, relative to its frame. */
1032 #define WINDOW_DISPLAY_RIGHT_EDGE_PIXEL_X(W) \
1033 (WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X ((W)) \
1034 + WINDOW_DISPLAY_PIXEL_WIDTH ((W)))
1036 /* Top edge of W in pixels relative to its frame. */
1038 #define WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y(W) \
1039 (FRAME_INTERNAL_BORDER_WIDTH_SAFE (XFRAME (WINDOW_FRAME ((W)))) \
1040 + (XFASTINT ((W)->top) \
1041 * CANON_Y_UNIT (XFRAME (WINDOW_FRAME ((W))))))
1043 /* Bottom edge of window W relative to its frame. */
1045 #define WINDOW_DISPLAY_BOTTOM_EDGE_PIXEL_Y(W) \
1046 (WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y ((W)) \
1047 + WINDOW_DISPLAY_PIXEL_HEIGHT ((W)))
1049 /* Convert window W relative pixel X to frame pixel coordinates. */
1051 #define WINDOW_TO_FRAME_PIXEL_X(W, X) \
1052 ((X) + WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X ((W)))
1054 /* Convert window W relative pixel Y to frame pixel coordinates. */
1056 #define WINDOW_TO_FRAME_PIXEL_Y(W, Y) \
1057 ((Y) + WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y ((W)))
1059 /* Convert frame relative pixel X to window relative pixel X. */
1061 #define FRAME_TO_WINDOW_PIXEL_X(W, X) \
1062 ((X) - WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X ((W)))
1064 /* Convert frame relative pixel Y to window relative pixel Y. */
1066 #define FRAME_TO_WINDOW_PIXEL_Y(W, Y) \
1067 ((Y) - WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y ((W)))
1069 /* Width of left margin area in pixels. */
1071 #define WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH(W) \
1072 (NILP ((W)->left_margin_width) \
1074 : (XINT ((W)->left_margin_width) \
1075 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))))
1077 /* Width of right marginal area in pixels. */
1079 #define WINDOW_DISPLAY_RIGHT_AREA_PIXEL_WIDTH(W) \
1080 (NILP ((W)->right_margin_width) \
1082 : (XINT ((W)->right_margin_width) \
1083 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))))
1085 /* Width of text area in pixels. */
1087 #define WINDOW_DISPLAY_TEXT_AREA_PIXEL_WIDTH(W) \
1088 (WINDOW_DISPLAY_PIXEL_WIDTH ((W)) \
1089 - WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)) \
1090 - WINDOW_DISPLAY_RIGHT_AREA_PIXEL_WIDTH ((W)))
1092 /* Convert a text area relative x-position in window W to frame X
1093 pixel coordinates. */
1095 #define WINDOW_TEXT_TO_FRAME_PIXEL_X(W, X) \
1096 (WINDOW_TO_FRAME_PIXEL_X ((W), (X)) \
1097 + WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)))
1099 /* Translate an x-position relative to AREA in window W to frame pixel
1102 #define WINDOW_AREA_TO_FRAME_PIXEL_X(W, AREA, X) \
1103 (WINDOW_TO_FRAME_PIXEL_X ((W), (X)) \
1104 + (((AREA) > LEFT_MARGIN_AREA) \
1105 ? WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)) \
1107 + (((AREA) > TEXT_AREA) \
1108 ? WINDOW_DISPLAY_TEXT_AREA_PIXEL_WIDTH ((W)) \
1111 /* Return the pixel width of AREA in W. */
1113 #define WINDOW_AREA_PIXEL_WIDTH(W, AREA) \
1114 (((AREA) == TEXT_AREA) \
1115 ? WINDOW_DISPLAY_TEXT_AREA_PIXEL_WIDTH ((W)) \
1116 : (((AREA) == LEFT_MARGIN_AREA) \
1117 ? WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)) \
1118 : WINDOW_DISPLAY_RIGHT_AREA_PIXEL_WIDTH ((W))))
1120 /* Value is non-zero if window W wants a mode line. */
1122 #define WINDOW_WANTS_MODELINE_P(W) \
1123 (!MINI_WINDOW_P ((W)) \
1124 && !(W)->pseudo_window_p \
1125 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1126 && BUFFERP ((W)->buffer) \
1127 && !NILP (XBUFFER ((W)->buffer)->mode_line_format) \
1128 && XFASTINT ((W)->height) > 1)
1130 /* Value is non-zero if window W wants a header line. */
1132 #define WINDOW_WANTS_HEADER_LINE_P(W) \
1133 (!MINI_WINDOW_P ((W)) \
1134 && !(W)->pseudo_window_p \
1135 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1136 && BUFFERP ((W)->buffer) \
1137 && !NILP (XBUFFER ((W)->buffer)->header_line_format) \
1138 && XFASTINT ((W)->height) > 1 + !NILP (XBUFFER ((W)->buffer)->mode_line_format))
1141 /***********************************************************************
1143 ***********************************************************************/
1145 /* Indices of face attributes in Lisp face vectors. Slot zero is the
1148 enum lface_attribute_index
1150 LFACE_FAMILY_INDEX
= 1,
1155 LFACE_UNDERLINE_INDEX
,
1156 LFACE_INVERSE_INDEX
,
1157 LFACE_FOREGROUND_INDEX
,
1158 LFACE_BACKGROUND_INDEX
,
1159 LFACE_STIPPLE_INDEX
,
1160 LFACE_OVERLINE_INDEX
,
1161 LFACE_STRIKE_THROUGH_INDEX
,
1164 LFACE_INHERIT_INDEX
,
1165 LFACE_AVGWIDTH_INDEX
,
1170 /* Box types of faces. */
1174 /* No box around text. */
1177 /* Simple box of specified width and color. Default width is 1, and
1178 default color is the foreground color of the face. */
1181 /* Boxes with 3D shadows. Color equals the background color of the
1182 face. Width is specified. */
1188 /* Structure describing a realized face.
1190 For each Lisp face, 0..N realized faces can exist for different
1191 frames and different charsets. Realized faces are built from Lisp
1192 faces and text properties/overlays by merging faces and adding
1193 unspecified attributes from the `default' face. */
1197 /* The id of this face. The id equals the index of this face in the
1198 vector faces_by_id of its face cache. */
1201 #ifdef HAVE_WINDOW_SYSTEM
1203 /* If non-zero, this is a GC that we can use without modification for
1204 drawing the characters in this face. */
1207 /* Font used for this face, or null if the font could not be loaded
1208 for some reason. This points to a `font' slot of a struct
1209 font_info, and we should not call XFreeFont on it because the
1210 font may still be used somewhere else. */
1213 /* Background stipple or bitmap used for this face. This is
1214 an id as returned from load_pixmap. */
1217 #else /* not HAVE_WINDOW_SYSTEM */
1222 #endif /* not HAVE_WINDOW_SYSTEM */
1224 /* Pixel value of foreground color for X frames. Color index
1226 unsigned long foreground
;
1228 /* Pixel value or color index of background color. */
1229 unsigned long background
;
1231 /* Pixel value or color index of underline color. */
1232 unsigned long underline_color
;
1234 /* Pixel value or color index of overlined, strike-through, or box
1236 unsigned long overline_color
;
1237 unsigned long strike_through_color
;
1238 unsigned long box_color
;
1240 /* The font's name. This points to a `name' of a font_info, and it
1241 must not be freed. */
1244 /* Font info ID for this face's font. An ID is stored here because
1245 pointers to font_info structures may change. The reason is that
1246 they are pointers into a font table vector that is itself
1250 /* Fontset ID if this face uses a fontset, or -1. This is only >= 0
1251 if the face was realized for a composition sequence.
1252 Otherwise, a specific font is loaded from the set of fonts
1253 specified by the fontset given by the family attribute of the face. */
1256 /* Pixmap width and height. */
1257 unsigned int pixmap_w
, pixmap_h
;
1259 /* Non-zero means characters in this face have a box that thickness
1260 around them. If it is negative, the absolute value indicates the
1261 thickness, and the horizontal lines of box (top and bottom) are
1262 drawn inside of characters glyph area. The vertical lines of box
1263 (left and right) are drawn as the same way as the case that this
1264 value is positive. */
1267 /* Type of box drawn. A value of FACE_NO_BOX means no box is drawn
1268 around text in this face. A value of FACE_SIMPLE_BOX means a box
1269 of width box_line_width is drawn in color box_color. A value of
1270 FACE_RAISED_BOX or FACE_SUNKEN_BOX means a 3D box is drawn with
1271 shadow colors derived from the background color of the face. */
1272 enum face_box_type box
;
1274 /* If `box' above specifies a 3D type, 1 means use box_color for
1276 unsigned use_box_color_for_shadows_p
: 1;
1278 /* The Lisp face attributes this face realizes. All attributes
1279 in this vector are non-nil. */
1280 Lisp_Object lface
[LFACE_VECTOR_SIZE
];
1282 /* The hash value of this face. */
1285 /* The charset for which this face was realized if it was realized
1286 for use in multibyte text. If fontset >= 0, this is the charset
1287 of the first character of the composition sequence. A value of
1288 charset < 0 means the face was realized for use in unibyte text
1289 where the idea of Emacs charsets isn't applicable. */
1292 /* Non-zero if text in this face should be underlined, overlined,
1293 strike-through or have a box drawn around it. */
1294 unsigned underline_p
: 1;
1295 unsigned overline_p
: 1;
1296 unsigned strike_through_p
: 1;
1298 /* 1 means that the colors specified for this face could not be
1299 loaded, and were replaced by default colors, so they shouldn't be
1301 unsigned foreground_defaulted_p
: 1;
1302 unsigned background_defaulted_p
: 1;
1304 /* 1 means that either no color is specified for underlining or that
1305 the specified color couldn't be loaded. Use the foreground
1306 color when drawing in that case. */
1307 unsigned underline_defaulted_p
: 1;
1309 /* 1 means that either no color is specified for the corresponding
1310 attribute or that the specified color couldn't be loaded.
1311 Use the foreground color when drawing in that case. */
1312 unsigned overline_color_defaulted_p
: 1;
1313 unsigned strike_through_color_defaulted_p
: 1;
1314 unsigned box_color_defaulted_p
: 1;
1316 /* TTY appearances. Blinking is not yet implemented. Colors are
1317 found in `lface' with empty color string meaning the default
1318 color of the TTY. */
1319 unsigned tty_bold_p
: 1;
1320 unsigned tty_dim_p
: 1;
1321 unsigned tty_underline_p
: 1;
1322 unsigned tty_alt_charset_p
: 1;
1323 unsigned tty_reverse_p
: 1;
1324 unsigned tty_blinking_p
: 1;
1326 /* 1 means that colors of this face may not be freed because they
1327 have been copied bitwise from a base face (see
1329 unsigned colors_copied_bitwise_p
: 1;
1331 /* Next and previous face in hash collision list of face cache. */
1332 struct face
*next
, *prev
;
1334 /* If this face is for ASCII characters, this points this face
1335 itself. Otherwise, this points a face for ASCII characters. */
1336 struct face
*ascii_face
;
1340 /* Color index indicating that face uses a terminal's default color. */
1342 #define FACE_TTY_DEFAULT_COLOR ((unsigned long) -1)
1344 /* Color index indicating that face uses an unknown foreground color. */
1346 #define FACE_TTY_DEFAULT_FG_COLOR ((unsigned long) -2)
1348 /* Color index indicating that face uses an unknown background color. */
1350 #define FACE_TTY_DEFAULT_BG_COLOR ((unsigned long) -3)
1352 /* Non-zero if FACE was realized for unibyte use. */
1354 #define FACE_UNIBYTE_P(FACE) ((FACE)->charset < 0)
1357 /* IDs of important faces known by the C face code. These are the IDs
1358 of the faces for CHARSET_ASCII. */
1364 MODE_LINE_INACTIVE_FACE_ID
,
1367 HEADER_LINE_FACE_ID
,
1373 BASIC_FACE_ID_SENTINEL
1377 /* A cache of realized faces. Each frame has its own cache because
1378 Emacs allows different frame-local face definitions. */
1382 /* Hash table of cached realized faces. */
1383 struct face
**buckets
;
1385 /* Back-pointer to the frame this cache belongs to. */
1388 /* A vector of faces so that faces can be referenced by an ID. */
1389 struct face
**faces_by_id
;
1391 /* The allocated size, and number of used slots of faces_by_id. */
1394 /* Flag indicating that attributes of the `menu' face have been
1396 unsigned menu_face_changed_p
: 1;
1400 /* Prepare face FACE for use on frame F. This must be called before
1401 using X resources of FACE. */
1403 #define PREPARE_FACE_FOR_DISPLAY(F, FACE) \
1404 if ((FACE)->gc == 0) \
1405 prepare_face_for_display ((F), (FACE)); \
1409 /* Return a pointer to the face with ID on frame F, or null if such a
1410 face doesn't exist. */
1412 #define FACE_FROM_ID(F, ID) \
1413 (((unsigned) (ID) < FRAME_FACE_CACHE (F)->used) \
1414 ? FRAME_FACE_CACHE (F)->faces_by_id[ID] \
1417 #ifdef HAVE_WINDOW_SYSTEM
1419 /* Non-zero if FACE is suitable for displaying character CHAR. */
1421 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) \
1422 (SINGLE_BYTE_CHAR_P (CHAR) \
1423 ? (FACE) == (FACE)->ascii_face \
1424 : face_suitable_for_char_p ((FACE), (CHAR)))
1426 /* Return the id of the realized face on frame F that is like the face
1427 with id ID but is suitable for displaying character CHAR.
1428 This macro is only meaningful for multibyte character CHAR. */
1430 #define FACE_FOR_CHAR(F, FACE, CHAR) \
1431 (SINGLE_BYTE_CHAR_P (CHAR) \
1432 ? (FACE)->ascii_face->id \
1433 : face_for_char ((F), (FACE), (CHAR)))
1435 #else /* not HAVE_WINDOW_SYSTEM */
1437 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) 1
1438 #define FACE_FOR_CHAR(F, FACE, CHAR) ((FACE)->id)
1440 #endif /* not HAVE_WINDOW_SYSTEM */
1442 /* Non-zero means face attributes have been changed since the last
1443 redisplay. Used in redisplay_internal. */
1445 extern int face_change_count
;
1450 /***********************************************************************
1452 ***********************************************************************/
1454 /* Iteration over things to display in current_buffer or in a string.
1456 The iterator handles:
1458 1. Overlay strings (after-string, before-string).
1460 3. Invisible text properties.
1461 4. Selective display.
1462 5. Translation of characters via display tables.
1463 6. Translation of control characters to the forms `\003' or `^C'.
1464 7. `glyph' and `space-width' properties.
1466 Iterators are initialized by calling init_iterator or one of the
1467 equivalent functions below. A call to get_next_display_element
1468 loads the iterator structure with information about what next to
1469 display. A call to set_iterator_to_next increments the iterator's
1472 Characters from overlay strings, display table entries or control
1473 character translations are returned one at a time. For example, if
1474 we have a text of `a\x01' where `a' has a display table definition
1475 of `cd' and the control character is displayed with a leading
1476 arrow, then the iterator will return:
1478 Call Return Source Call next
1479 -----------------------------------------------------------------
1480 next c display table move
1481 next d display table move
1482 next ^ control char move
1483 next A control char move
1485 The same mechanism is also used to return characters for ellipses
1486 displayed at the end of invisible text.
1488 CAVEAT: Under some circumstances, move_.* functions can be called
1489 asynchronously, e.g. when computing a buffer position from an x and
1490 y pixel position. This means that these functions and functions
1491 called from them SHOULD NOT USE xmalloc and alike. See also the
1492 comment at the start of xdisp.c. */
1494 /* Enumeration describing what kind of display element an iterator is
1495 loaded with after a call to get_next_display_element. */
1497 enum display_element_type
1499 /* A normal character. */
1502 /* A composition sequence. */
1508 /* A flexible width and height space. */
1511 /* End of buffer or string. */
1514 /* Truncation glyphs. Never returned by get_next_display_element.
1515 Used to get display information about truncation glyphs via
1519 /* Continuation glyphs. See the comment for IT_TRUNCATION. */
1524 /* An enumerator for each text property that has a meaning for display
1533 COMPOSITION_PROP_IDX
,
1535 /* Not a property. Used to indicate changes in overlays. */
1545 /* The window in which we iterate over current_buffer (or a string). */
1549 /* The window's frame. */
1552 /* Function to call to load this structure with the next display
1554 int (* method
) P_ ((struct it
*it
));
1556 /* The next position at which to check for face changes, invisible
1557 text, overlay strings, end of text etc., which see. */
1560 /* Maximum string or buffer position + 1. ZV when iterating over
1564 /* C string to iterate over. Non-null means get characters from
1565 this string, otherwise characters are read from current_buffer
1569 /* Number of characters in the string (s, or it->string) we iterate
1573 /* Start and end of a visible region; -1 if the region is not
1574 visible in the window. */
1575 int region_beg_charpos
, region_end_charpos
;
1577 /* Position at which redisplay end trigger functions should be run. */
1578 int redisplay_end_trigger_charpos
;
1580 /* 1 means multibyte characters are enabled. */
1581 unsigned multibyte_p
: 1;
1583 /* 1 means window has a mode line at its top. */
1584 unsigned header_line_p
: 1;
1586 /* 1 means `string' is the value of a `display' property.
1587 Don't handle some `display' properties in these strings. */
1588 unsigned string_from_display_prop_p
: 1;
1590 /* Display table in effect or null for none. */
1591 struct Lisp_Char_Table
*dp
;
1593 /* Current display table vector to return characters from and its
1594 end. dpvec null means we are not returning characters from a
1595 display table entry; current.dpvec_index gives the current index
1596 into dpvec. This same mechanism is also used to return
1597 characters from translated control characters, i.e. `\003' or
1599 Lisp_Object
*dpvec
, *dpend
;
1601 /* Length in bytes of the char that filled dpvec. A value of zero
1602 means that no such character is involved. */
1605 /* Face id of the iterator saved in case a glyph from dpvec contains
1606 a face. The face is restored when all glyphs from dpvec have
1610 /* Vector of glyphs for control character translation. The pointer
1611 dpvec is set to ctl_chars when a control character is translated.
1612 This vector is also used for incomplete multibyte character
1613 translation (e.g \222\244). Such a character is at most 4 bytes,
1614 thus we need at most 16 bytes here. */
1615 Lisp_Object ctl_chars
[16];
1617 /* Current buffer or string position of the iterator, including
1618 position in overlay strings etc. */
1619 struct display_pos current
;
1621 /* Vector of overlays to process. Overlay strings are processed
1622 OVERLAY_STRING_CHUNK_SIZE at a time. */
1623 #define OVERLAY_STRING_CHUNK_SIZE 3
1624 Lisp_Object overlay_strings
[OVERLAY_STRING_CHUNK_SIZE
];
1626 /* Total number of overlay strings to process. This can be >
1627 OVERLAY_STRING_CHUNK_SIZE. */
1628 int n_overlay_strings
;
1630 /* If non-nil, a Lisp string being processed. If
1631 current.overlay_string_index >= 0, this is an overlay string from
1635 /* Stack of saved values. New entries are pushed when we begin to
1636 process an overlay string or a string from a `glyph' property.
1637 Entries are popped when we return to deliver display elements
1638 from what we previously had. */
1639 struct iterator_stack_entry
1644 struct display_pos pos
;
1647 enum glyph_row_area area
;
1648 unsigned multibyte_p
: 1;
1649 unsigned string_from_display_prop_p
: 1;
1650 unsigned display_ellipsis_p
: 1;
1651 Lisp_Object space_width
;
1653 Lisp_Object font_height
;
1657 /* Stack pointer. */
1660 /* Setting of buffer-local variable selective-display-ellipsis. */
1661 unsigned selective_display_ellipsis_p
: 1;
1663 /* 1 means control characters are translated into the form `^C'
1664 where the `^' can be replaced by a display table entry. */
1665 unsigned ctl_arrow_p
: 1;
1667 /* -1 means selective display hides everything between a \r and the
1668 next newline; > 0 means hide lines indented more than that value. */
1671 /* An enumeration describing what the next display element is
1672 after a call to get_next_display_element. */
1673 enum display_element_type what
;
1678 /* Non-zero means that the current face has a box. */
1679 unsigned face_box_p
: 1;
1681 /* Non-null means that the current character is the first in a run
1682 of characters with box face. */
1683 unsigned start_of_box_run_p
: 1;
1685 /* Non-zero means that the current character is the last in a run
1686 of characters with box face. */
1687 unsigned end_of_box_run_p
: 1;
1689 /* 1 means overlay strings at end_charpos have been processed. */
1690 unsigned overlay_strings_at_end_processed_p
: 1;
1692 /* 1 means the actual glyph is not available in the current
1694 unsigned glyph_not_available_p
: 1;
1696 /* 1 means the next line in display_line continues a character
1697 consisting of more than one glyph, and some glyphs of this
1698 character have been put on the previous line. */
1699 unsigned starts_in_middle_of_char_p
: 1;
1701 /* If 1, saved_face_id contains the id of the face in front of text
1702 skipped due to selective display. */
1703 unsigned face_before_selective_p
: 1;
1705 /* The ID of the default face to use. One of DEFAULT_FACE_ID,
1706 MODE_LINE_FACE_ID, etc, depending on what we are displaying. */
1709 /* If what == IT_CHARACTER, character and length in bytes. This is
1710 a character from a buffer or string. It may be different from
1711 the character displayed in case that
1712 unibyte_display_via_language_environment is set.
1714 If what == IT_COMPOSITION, the first component of a composition
1715 and length in bytes of the composition. */
1718 /* If what == IT_COMPOSITION, identification number and length in
1719 chars of a composition. */
1720 int cmp_id
, cmp_len
;
1722 /* The character to display, possibly translated to multibyte
1723 if unibyte_display_via_language_environment is set. This
1724 is set after x_produce_glyphs has been called. */
1725 int char_to_display
;
1727 /* If what == IT_IMAGE, the id of the image to display. */
1730 /* Value of the `space-width' property, if any; nil if none. */
1731 Lisp_Object space_width
;
1733 /* Computed from the value of the `raise' property. */
1736 /* Value of the `height' property, if any; nil if none. */
1737 Lisp_Object font_height
;
1739 /* Object and position where the current display element came from.
1740 Object can be a Lisp string in case the current display element
1741 comes from an overlay string, or it is buffer. Position is
1742 a position in object. */
1744 struct text_pos position
;
1746 /* 1 means lines are truncated. */
1747 unsigned truncate_lines_p
: 1;
1749 /* Number of columns per \t. */
1752 /* Width in pixels of truncation and continuation glyphs. */
1753 short truncation_pixel_width
, continuation_pixel_width
;
1755 /* First and last visible x-position in the display area. If window
1756 is hscrolled by n columns, first_visible_x == n * CANON_X_UNIT
1757 (f), and last_visible_x == pixel width of W + first_visible_x. */
1758 int first_visible_x
, last_visible_x
;
1760 /* Last visible y-position + 1 in the display area without a mode
1761 line, if the window has one. */
1764 /* Additional space in pixels between lines (for window systems
1766 int extra_line_spacing
;
1768 /* If non-null, glyphs are produced in glyph_row with each call to
1770 struct glyph_row
*glyph_row
;
1772 /* The area of glyph_row to which glyphs are added. */
1773 enum glyph_row_area area
;
1775 /* Number of glyphs needed for the last character requested via
1776 produce_glyphs. This is 1 except for tabs. */
1779 /* Width of the display element in pixels. Result of
1783 /* Current, maximum logical, and maximum physical line height
1784 information. Result of produce_glyphs. */
1785 int ascent
, descent
, max_ascent
, max_descent
;
1786 int phys_ascent
, phys_descent
, max_phys_ascent
, max_phys_descent
;
1788 /* Current x pixel position within the display line. This value
1789 does not include the width of continuation lines in front of the
1790 line. The value of current_x is automatically incremented by
1791 pixel_width with each call to produce_glyphs. */
1794 /* Accumulated width of continuation lines. If > 0, this means we
1795 are currently in a continuation line. This is initially zero and
1796 incremented/reset by display_line, move_it_to etc. */
1797 int continuation_lines_width
;
1799 /* Current y-position. Automatically incremented by the height of
1800 glyph_row in move_it_to and display_line. */
1803 /* Current vertical matrix position, or line number. Automatically
1804 incremented by move_it_to and display_line. */
1807 /* Horizontal matrix position reached in move_it_in_display_line.
1808 Only set there, not in display_line. */
1813 /* Access to positions of iterator IT. */
1815 #define IT_CHARPOS(IT) CHARPOS ((IT).current.pos)
1816 #define IT_BYTEPOS(IT) BYTEPOS ((IT).current.pos)
1817 #define IT_STRING_CHARPOS(IT) CHARPOS ((IT).current.string_pos)
1818 #define IT_STRING_BYTEPOS(IT) BYTEPOS ((IT).current.string_pos)
1820 /* Test if IT has reached the end of its buffer or string. This will
1821 only work after get_next_display_element has been called. */
1823 #define ITERATOR_AT_END_P(IT) ((IT)->what == IT_EOB)
1825 /* Non-zero means IT is at the end of a line. This is the case if it
1826 is either on a newline or on a carriage return and selective
1827 display hides the rest of the line. */
1829 #define ITERATOR_AT_END_OF_LINE_P(IT) \
1830 ((IT)->what == IT_CHARACTER \
1831 && ((IT)->c == '\n' \
1832 || ((IT)->c == '\r' && (IT)->selective)))
1834 /* Call produce_glyphs or produce_glyphs_hook, if set. Shortcut to
1835 avoid the function call overhead. */
1837 #define PRODUCE_GLYPHS(IT) \
1839 ? rif->produce_glyphs ((IT)) \
1840 : produce_glyphs ((IT)))
1842 /* Bit-flags indicating what operation move_it_to should perform. */
1844 enum move_operation_enum
1846 /* Stop if specified x-position is reached. */
1849 /* Stop if specified y-position is reached. */
1852 /* Stop if specified vpos is reached. */
1853 MOVE_TO_VPOS
= 0x04,
1855 /* Stop if specified buffer or string position is reached. */
1861 /***********************************************************************
1862 Window-based redisplay interface
1863 ***********************************************************************/
1865 /* Structure used to describe runs of lines that must be scrolled. */
1869 /* Source and destination y pixel position. */
1870 int desired_y
, current_y
;
1872 /* Source and destination vpos in matrix. */
1873 int desired_vpos
, current_vpos
;
1875 /* Height in pixels, number of glyph rows. */
1880 /* Structure holding system-dependent interface functions needed
1881 for window-based redisplay. */
1883 struct redisplay_interface
1885 /* Produce glyphs/get display metrics for the display element IT is
1887 void (*produce_glyphs
) P_ ((struct it
*it
));
1889 /* Write or insert LEN glyphs from STRING at the nominal output
1891 void (*write_glyphs
) P_ ((struct glyph
*string
, int len
));
1892 void (*insert_glyphs
) P_ ((struct glyph
*start
, int len
));
1894 /* Clear from nominal output position to X. X < 0 means clear
1895 to right end of display. */
1896 void (*clear_end_of_line
) P_ ((int x
));
1898 /* Function to call to scroll the display as described by RUN on
1900 void (*scroll_run_hook
) P_ ((struct window
*w
, struct run
*run
));
1902 /* Function to call after a line in a display has been completely
1903 updated. Used to draw truncation marks and alike. DESIRED_ROW
1904 is the desired row which has been updated. */
1905 void (*after_update_window_line_hook
) P_ ((struct glyph_row
*desired_row
));
1907 /* Function to call before beginning to update window W in
1908 window-based redisplay. */
1909 void (*update_window_begin_hook
) P_ ((struct window
*w
));
1911 /* Function to call after window W has been updated in window-based
1912 redisplay. CURSOR_ON_P non-zero means switch cursor on.
1913 MOUSE_FACE_OVERWRITTEN_P non-zero means that some lines in W
1914 that contained glyphs in mouse-face were overwritten, so we
1915 have to update the mouse highlight. */
1916 void (*update_window_end_hook
) P_ ((struct window
*w
, int cursor_on_p
,
1917 int mouse_face_overwritten_p
));
1919 /* Move cursor to row/column position VPOS/HPOS, pixel coordinates
1920 Y/X. HPOS/VPOS are window-relative row and column numbers and X/Y
1921 are window-relative pixel positions. */
1922 void (*cursor_to
) P_ ((int vpos
, int hpos
, int y
, int x
));
1924 /* Flush the display of frame F. For X, this is XFlush. */
1925 void (*flush_display
) P_ ((struct frame
*f
));
1927 /* Clear the mouse hightlight in window W, if there is any. */
1928 void (*clear_mouse_face
) P_ ((struct window
*w
));
1930 /* Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
1932 void (*get_glyph_overhangs
) P_ ((struct glyph
*glyph
, struct frame
*f
,
1933 int *left
, int *right
));
1935 /* Fix the display of AREA of ROW in window W for overlapping rows.
1936 This function is called from redraw_overlapping_rows after
1937 desired rows have been made current. */
1938 void (*fix_overlapping_area
) P_ ((struct window
*w
, struct glyph_row
*row
,
1939 enum glyph_row_area area
));
1942 /* The current interface for window-based redisplay. */
1944 extern struct redisplay_interface
*rif
;
1946 /* Hook to call in estimate_mode_line_height. */
1948 extern int (* estimate_mode_line_height_hook
) P_ ((struct frame
*,
1952 /***********************************************************************
1954 ***********************************************************************/
1956 #ifdef HAVE_WINDOW_SYSTEM
1958 /* Structure forward declarations. */
1963 /* Each image format (JPEG, TIFF, ...) supported is described by
1964 a structure of the type below. */
1968 /* A symbol uniquely identifying the image type, .e.g `jpeg'. */
1971 /* Check that SPEC is a valid image specification for the given
1972 image type. Value is non-zero if SPEC is valid. */
1973 int (* valid_p
) P_ ((Lisp_Object spec
));
1975 /* Load IMG which is used on frame F from information contained in
1976 IMG->spec. Value is non-zero if successful. */
1977 int (* load
) P_ ((struct frame
*f
, struct image
*img
));
1979 /* Free resources of image IMG which is used on frame F. */
1980 void (* free
) P_ ((struct frame
*f
, struct image
*img
));
1982 /* Next in list of all supported image types. */
1983 struct image_type
*next
;
1987 /* Structure describing an image. Specific image formats like XBM are
1988 converted into this form, so that display only has to deal with
1989 this type of image. */
1993 /* The time in seconds at which the image was last displayed. Set
1994 in prepare_image_for_display. */
1995 unsigned long timestamp
;
1997 /* Pixmaps of the image. */
1998 Pixmap pixmap
, mask
;
2000 /* Colors allocated for this image, if any. Allocated via xmalloc. */
2001 unsigned long *colors
;
2004 /* A single `background color' for this image, for the use of anyone that
2005 cares about such a thing. Only valid if the `background_valid' field
2006 is true. This should generally be accessed by calling the accessor
2007 macro `IMAGE_BACKGROUND', which will heuristically calculate a value
2009 unsigned long background
;
2011 /* True if this image has a `transparent' background -- that is, is
2012 uses an image mask. The accessor macro for this is
2013 `IMAGE_BACKGROUND_TRANSPARENT'. */
2014 unsigned background_transparent
: 1;
2016 /* True if the `background' and `background_transparent' fields are
2017 valid, respectively. */
2018 unsigned background_valid
: 1, background_transparent_valid
: 1;
2020 /* Width and height of the image. */
2023 /* These values are used for the rectangles displayed for images
2024 that can't be loaded. */
2025 #define DEFAULT_IMAGE_WIDTH 30
2026 #define DEFAULT_IMAGE_HEIGHT 30
2028 /* Percent of image height used as ascent. A value of
2029 CENTERED_IMAGE_ASCENT means draw the image centered on the
2032 #define DEFAULT_IMAGE_ASCENT 50
2033 #define CENTERED_IMAGE_ASCENT -1
2035 /* Lisp specification of this image. */
2038 /* Relief to draw around the image. */
2041 /* Optional margins around the image. This includes the relief. */
2042 int hmargin
, vmargin
;
2044 /* Reference to the type of the image. */
2045 struct image_type
*type
;
2047 /* 1 means that loading the image failed. Don't try again. */
2048 unsigned load_failed_p
;
2050 /* A place for image types to store additional data. The member
2051 data.lisp_val is marked during GC, so it's safe to store Lisp data
2052 there. Image types should free this data when their `free'
2053 function is called. */
2058 Lisp_Object lisp_val
;
2061 /* Hash value of image specification to speed up comparisons. */
2064 /* Image id of this image. */
2067 /* Hash collision chain. */
2068 struct image
*next
, *prev
;
2072 /* Cache of images. Each frame has a cache. X frames with the same
2073 x_display_info share their caches. */
2077 /* Hash table of images. */
2078 struct image
**buckets
;
2080 /* Vector mapping image ids to images. */
2081 struct image
**images
;
2083 /* Allocated size of `images'. */
2086 /* Number of images in the cache. */
2089 /* Reference count (number of frames sharing this cache). */
2094 /* Value is a pointer to the image with id ID on frame F, or null if
2095 no image with that id exists. */
2097 #define IMAGE_FROM_ID(F, ID) \
2098 (((ID) >= 0 && (ID) < (FRAME_X_IMAGE_CACHE (F)->used)) \
2099 ? FRAME_X_IMAGE_CACHE (F)->images[ID] \
2102 /* Size of bucket vector of image caches. Should be prime. */
2104 #define IMAGE_CACHE_BUCKETS_SIZE 1001
2106 #endif /* HAVE_WINDOW_SYSTEM */
2110 /***********************************************************************
2112 ***********************************************************************/
2114 /* Enumeration defining where to find tool-bar item information in
2115 tool-bar items vectors stored with frames. Each tool-bar item
2116 occupies TOOL_BAR_ITEM_NSLOTS elements in such a vector. */
2118 enum tool_bar_item_idx
2120 /* The key of the tool-bar item. Used to remove items when a binding
2121 for `undefined' is found. */
2124 /* Non-nil if item is enabled. */
2125 TOOL_BAR_ITEM_ENABLED_P
,
2127 /* Non-nil if item is selected (pressed). */
2128 TOOL_BAR_ITEM_SELECTED_P
,
2131 TOOL_BAR_ITEM_CAPTION
,
2133 /* Image(s) to display. This is either a single image specification
2134 or a vector of specifications. */
2135 TOOL_BAR_ITEM_IMAGES
,
2138 TOOL_BAR_ITEM_BINDING
,
2140 /* Button type. One of nil, `:radio' or `:toggle'. */
2146 /* Sentinel = number of slots in tool_bar_items occupied by one
2148 TOOL_BAR_ITEM_NSLOTS
2152 /* An enumeration for the different images that can be specified
2153 for a tool-bar item. */
2155 enum tool_bar_item_image
2157 TOOL_BAR_IMAGE_ENABLED_SELECTED
,
2158 TOOL_BAR_IMAGE_ENABLED_DESELECTED
,
2159 TOOL_BAR_IMAGE_DISABLED_SELECTED
,
2160 TOOL_BAR_IMAGE_DISABLED_DESELECTED
2163 /* Non-zero means raise tool-bar buttons when the mouse moves over them. */
2165 extern int auto_raise_tool_bar_buttons_p
;
2167 /* Margin around tool-bar buttons in pixels. */
2169 extern Lisp_Object Vtool_bar_button_margin
;
2171 /* Thickness of relief to draw around tool-bar buttons. */
2173 extern int tool_bar_button_relief
;
2175 /* Default values of the above variables. */
2177 #define DEFAULT_TOOL_BAR_BUTTON_MARGIN 1
2178 #define DEFAULT_TOOL_BAR_BUTTON_RELIEF 3
2180 /* The height in pixels of the default tool-bar images. */
2182 #define DEFAULT_TOOL_BAR_IMAGE_HEIGHT 24
2185 /***********************************************************************
2187 ***********************************************************************/
2189 /* Defined in xdisp.c */
2191 struct glyph_row
*row_containing_pos
P_ ((struct window
*, int,
2193 struct glyph_row
*, int));
2194 int string_buffer_position
P_ ((struct window
*, Lisp_Object
, int));
2195 int line_bottom_y
P_ ((struct it
*));
2196 int display_prop_intangible_p
P_ ((Lisp_Object
));
2197 void resize_echo_area_exactly
P_ ((void));
2198 int resize_mini_window
P_ ((struct window
*, int));
2199 int try_window
P_ ((Lisp_Object
, struct text_pos
));
2200 void window_box
P_ ((struct window
*, int, int *, int *, int *, int *));
2201 int window_box_height
P_ ((struct window
*));
2202 int window_text_bottom_y
P_ ((struct window
*));
2203 int window_box_width
P_ ((struct window
*, int));
2204 int window_box_left
P_ ((struct window
*, int));
2205 int window_box_right
P_ ((struct window
*, int));
2206 void window_box_edges
P_ ((struct window
*, int, int *, int *, int *, int *));
2207 void mark_window_display_accurate
P_ ((Lisp_Object
, int));
2208 void redisplay_preserve_echo_area
P_ ((int));
2209 void set_cursor_from_row
P_ ((struct window
*, struct glyph_row
*,
2210 struct glyph_matrix
*, int, int, int, int));
2211 void init_iterator
P_ ((struct it
*, struct window
*, int,
2212 int, struct glyph_row
*, enum face_id
));
2213 void init_iterator_to_row_start
P_ ((struct it
*, struct window
*,
2214 struct glyph_row
*));
2215 int get_next_display_element
P_ ((struct it
*));
2216 void set_iterator_to_next
P_ ((struct it
*, int));
2217 void produce_glyphs
P_ ((struct it
*));
2218 void produce_special_glyphs
P_ ((struct it
*, enum display_element_type
));
2219 void start_display
P_ ((struct it
*, struct window
*, struct text_pos
));
2220 void move_it_to
P_ ((struct it
*, int, int, int, int, int));
2221 void move_it_vertically
P_ ((struct it
*, int));
2222 void move_it_vertically_backward
P_ ((struct it
*, int));
2223 void move_it_by_lines
P_ ((struct it
*, int, int));
2224 void move_it_past_eol
P_ ((struct it
*));
2225 int frame_mode_line_height
P_ ((struct frame
*));
2226 void highlight_trailing_whitespace
P_ ((struct frame
*, struct glyph_row
*));
2227 int tool_bar_item_info
P_ ((struct frame
*, struct glyph
*, int *));
2228 extern Lisp_Object Qtool_bar
;
2229 extern Lisp_Object Vshow_trailing_whitespace
;
2230 extern int redisplaying_p
;
2231 extern Lisp_Object Vimage_types
;
2232 extern void add_to_log
P_ ((char *, Lisp_Object
, Lisp_Object
));
2233 extern int help_echo_showing_p
;
2234 extern int current_mode_line_height
, current_header_line_height
;
2235 extern int cursor_in_non_selected_windows
;
2237 /* Defined in sysdep.c */
2239 void get_frame_size
P_ ((int *, int *));
2240 void request_sigio
P_ ((void));
2241 void unrequest_sigio
P_ ((void));
2242 int tabs_safe_p
P_ ((void));
2243 void init_baud_rate
P_ ((void));
2244 void init_sigio
P_ ((int));
2246 /* Defined in xfaces.c */
2248 #ifdef HAVE_X_WINDOWS
2249 void x_free_colors
P_ ((struct frame
*, unsigned long *, int));
2252 void update_face_from_frame_parameter
P_ ((struct frame
*, Lisp_Object
,
2254 Lisp_Object tty_color_name
P_ ((struct frame
*, int));
2255 void clear_face_cache
P_ ((int));
2256 unsigned long load_color
P_ ((struct frame
*, struct face
*, Lisp_Object
,
2257 enum lface_attribute_index
));
2258 void unload_color
P_ ((struct frame
*, unsigned long));
2259 int frame_update_line_height
P_ ((struct frame
*));
2260 int ascii_face_of_lisp_face
P_ ((struct frame
*, int));
2261 void prepare_face_for_display
P_ ((struct frame
*, struct face
*));
2262 int xstricmp
P_ ((unsigned char *, unsigned char *));
2263 int lookup_face
P_ ((struct frame
*, Lisp_Object
*, int, struct face
*));
2264 int lookup_named_face
P_ ((struct frame
*, Lisp_Object
, int));
2265 int smaller_face
P_ ((struct frame
*, int, int));
2266 int face_with_height
P_ ((struct frame
*, int, int));
2267 int lookup_derived_face
P_ ((struct frame
*, Lisp_Object
, int, int));
2268 void init_frame_faces
P_ ((struct frame
*));
2269 void free_frame_faces
P_ ((struct frame
*));
2270 void recompute_basic_faces
P_ ((struct frame
*));
2271 int face_at_buffer_position
P_ ((struct window
*, int, int, int, int *,
2273 int face_at_string_position
P_ ((struct window
*, Lisp_Object
, int, int, int,
2274 int, int *, enum face_id
, int));
2275 int compute_char_face
P_ ((struct frame
*, int, Lisp_Object
));
2276 void free_all_realized_faces
P_ ((Lisp_Object
));
2277 extern Lisp_Object Qforeground_color
, Qbackground_color
;
2278 extern char unspecified_fg
[], unspecified_bg
[];
2279 void free_realized_multibyte_face
P_ ((struct frame
*, int));
2281 /* Defined in xfns.c */
2283 #ifdef HAVE_X_WINDOWS
2284 void gamma_correct
P_ ((struct frame
*, XColor
*));
2287 void gamma_correct
P_ ((struct frame
*, COLORREF
*));
2290 #ifdef HAVE_WINDOW_SYSTEM
2292 void x_kill_gs_process
P_ ((Pixmap
, struct frame
*));
2293 int x_screen_planes
P_ ((struct frame
*));
2294 void x_implicitly_set_name
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
2295 struct image_cache
*make_image_cache
P_ ((void));
2296 void free_image_cache
P_ ((struct frame
*));
2297 void clear_image_cache
P_ ((struct frame
*, int));
2298 void forall_images_in_image_cache
P_ ((struct frame
*,
2299 void (*) P_ ((struct image
*))));
2300 int valid_image_p
P_ ((Lisp_Object
));
2301 void prepare_image_for_display
P_ ((struct frame
*, struct image
*));
2302 int lookup_image
P_ ((struct frame
*, Lisp_Object
));
2304 #ifdef HAVE_X_WINDOWS
2305 unsigned long image_background
P_ ((struct image
*, struct frame
*,
2307 int image_background_transparent
P_ ((struct image
*, struct frame
*,
2309 #endif /* HAVE_X_WINDOWS */
2311 extern Lisp_Object tip_frame
;
2312 extern Window tip_window
;
2313 EXFUN (Fx_show_tip
, 6);
2314 EXFUN (Fx_hide_tip
, 0);
2315 extern void start_hourglass
P_ ((void));
2316 extern void cancel_hourglass
P_ ((void));
2317 extern int display_hourglass_p
;
2319 /* Returns the background color of IMG, calculating one heuristically if
2320 necessary. If non-zero, XIMG is an existing XImage object to use for
2323 #define IMAGE_BACKGROUND(img, f, ximg) \
2324 ((img)->background_valid \
2325 ? (img)->background \
2326 : image_background (img, f, ximg))
2328 /* Returns true if IMG has a `transparent' background, using heuristics
2329 to decide if necessary. If non-zero, MASK is an existing XImage
2330 object to use for the heuristic. */
2332 #define IMAGE_BACKGROUND_TRANSPARENT(img, f, mask) \
2333 ((img)->background_transparent_valid \
2334 ? (img)->background_transparent \
2335 : image_background_transparent (img, f, mask))
2337 #endif /* HAVE_WINDOW_SYSTEM */
2340 /* Defined in xmenu.c */
2342 int popup_activated
P_ ((void));
2344 /* Defined in dispnew.c */
2346 extern int inverse_video
;
2347 extern int required_matrix_width
P_ ((struct window
*));
2348 extern int required_matrix_height
P_ ((struct window
*));
2349 extern int estimate_mode_line_height
P_ ((struct frame
*, enum face_id
));
2350 extern Lisp_Object mode_line_string
P_ ((struct window
*, int, int, int, int *));
2351 extern void redraw_frame
P_ ((struct frame
*));
2352 extern void redraw_garbaged_frames
P_ ((void));
2353 extern void cancel_line
P_ ((int, struct frame
*));
2354 extern void init_desired_glyphs
P_ ((struct frame
*));
2355 extern int scroll_frame_lines
P_ ((struct frame
*, int, int, int, int));
2356 extern int direct_output_for_insert
P_ ((int));
2357 extern int direct_output_forward_char
P_ ((int));
2358 extern int update_frame
P_ ((struct frame
*, int, int));
2359 extern int scrolling
P_ ((struct frame
*));
2360 extern void bitch_at_user
P_ ((void));
2361 void adjust_glyphs
P_ ((struct frame
*));
2362 void free_glyphs
P_ ((struct frame
*));
2363 void free_window_matrices
P_ ((struct window
*));
2364 void check_glyph_memory
P_ ((void));
2365 void mirrored_line_dance
P_ ((struct glyph_matrix
*, int, int, int *, char *));
2366 void clear_glyph_matrix
P_ ((struct glyph_matrix
*));
2367 void clear_current_matrices
P_ ((struct frame
*f
));
2368 void clear_desired_matrices
P_ ((struct frame
*));
2369 void shift_glyph_matrix
P_ ((struct window
*, struct glyph_matrix
*,
2371 void rotate_matrix
P_ ((struct glyph_matrix
*, int, int, int));
2372 void increment_matrix_positions
P_ ((struct glyph_matrix
*,
2373 int, int, int, int));
2374 void blank_row
P_ ((struct window
*, struct glyph_row
*, int));
2375 void increment_row_positions
P_ ((struct glyph_row
*, int, int));
2376 void enable_glyph_matrix_rows
P_ ((struct glyph_matrix
*, int, int, int));
2377 void clear_glyph_row
P_ ((struct glyph_row
*));
2378 void prepare_desired_row
P_ ((struct glyph_row
*));
2379 int line_hash_code
P_ ((struct glyph_row
*));
2380 void set_window_update_flags
P_ ((struct window
*, int));
2381 void write_glyphs
P_ ((struct glyph
*, int));
2382 void insert_glyphs
P_ ((struct glyph
*, int));
2383 void redraw_frame
P_ ((struct frame
*));
2384 void redraw_garbaged_frames
P_ ((void));
2385 int scroll_cost
P_ ((struct frame
*, int, int, int));
2386 int direct_output_for_insert
P_ ((int));
2387 int direct_output_forward_char
P_ ((int));
2388 int update_frame
P_ ((struct frame
*, int, int));
2389 void update_single_window
P_ ((struct window
*, int));
2390 int scrolling
P_ ((struct frame
*));
2391 void buffer_posn_from_coords
P_ ((struct window
*, int *, int *,
2392 Lisp_Object
*, struct display_pos
*));
2393 void do_pending_window_change
P_ ((int));
2394 void change_frame_size
P_ ((struct frame
*, int, int, int, int, int));
2395 void bitch_at_user
P_ ((void));
2396 Lisp_Object sit_for
P_ ((int, int, int, int, int));
2397 void init_display
P_ ((void));
2398 void syms_of_display
P_ ((void));
2399 extern Lisp_Object Qredisplay_dont_pause
;
2401 /* Defined in term.c */
2403 extern void ring_bell
P_ ((void));
2404 extern void set_terminal_modes
P_ ((void));
2405 extern void reset_terminal_modes
P_ ((void));
2406 extern void update_begin
P_ ((struct frame
*));
2407 extern void update_end
P_ ((struct frame
*));
2408 extern void set_terminal_window
P_ ((int));
2409 extern void set_scroll_region
P_ ((int, int));
2410 extern void turn_off_insert
P_ ((void));
2411 extern void turn_off_highlight
P_ ((void));
2412 extern void background_highlight
P_ ((void));
2413 extern void clear_frame
P_ ((void));
2414 extern void clear_end_of_line
P_ ((int));
2415 extern void clear_end_of_line_raw
P_ ((int));
2416 extern void delete_glyphs
P_ ((int));
2417 extern void ins_del_lines
P_ ((int, int));
2418 extern int string_cost
P_ ((char *));
2419 extern int per_line_cost
P_ ((char *));
2420 extern void calculate_costs
P_ ((struct frame
*));
2421 extern void set_tty_color_mode
P_ ((struct frame
*, Lisp_Object
));
2422 extern void tty_setup_colors
P_ ((int));
2423 extern void term_init
P_ ((char *));
2424 extern void fatal
P_ ((/* char *, ... */));
2425 void cursor_to
P_ ((int, int));
2427 /* Defined in scroll.c */
2429 extern int scrolling_max_lines_saved
P_ ((int, int, int *, int *, int *));
2430 extern int scroll_cost
P_ ((struct frame
*, int, int, int));
2431 extern void do_line_insertion_deletion_costs
P_ ((struct frame
*, char *,
2432 char *, char *, char *,
2433 char *, char *, int));
2434 void scrolling_1
P_ ((struct frame
*, int, int, int, int *, int *, int *,
2437 #endif /* not DISPEXTERN_H_INCLUDED */