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
248 /* Width in pixels. */
251 /* Vertical offset. If < 0, the glyph is displayed raised, if > 0
252 the glyph is displayed lowered. */
255 /* Which kind of glyph this is---character, image etc. Value
256 should be an enumerator of type enum glyph_type. */
259 /* 1 means this glyph was produced from multibyte text. Zero
260 means it was produced from unibyte text, i.e. charsets aren't
261 applicable, and encoding is not performed. */
262 unsigned multibyte_p
: 1;
264 /* Non-zero means draw a box line at the left or right side of this
265 glyph. This is part of the implementation of the face attribute
267 unsigned left_box_line_p
: 1;
268 unsigned right_box_line_p
: 1;
270 /* Non-zero means this glyph's physical ascent or descent is greater
271 than its logical ascent/descent, i.e. it may potentially overlap
272 glyphs above or below it. */
273 unsigned overlaps_vertically_p
: 1;
275 /* 1 means glyph is a padding glyph. Padding glyphs are used for
276 characters whose visual shape consists of more than one glyph
277 (e.g. Asian characters). All but the first glyph of such a glyph
278 sequence have the padding_p flag set. Only used for terminal
279 frames, and there only to minimize code changes. A better way
280 would probably be to use the width field of glyphs to express
282 unsigned padding_p
: 1;
284 /* 1 means the actual glyph is not available in the current
286 unsigned glyph_not_available_p
: 1;
288 /* Face of the glyph. */
289 unsigned face_id
: 22;
292 /* Type of font used to display the character glyph. Used to
293 determine which set of functions to use to obtain font metrics
294 for the glyph. Value should be an enumerator of the type
295 w32_char_font_type. */
296 unsigned w32_font_type
: 2;
299 /* A union of sub-structures for different glyph types. */
302 /* Character code for character glyphs (type == CHAR_GLYPH). */
305 /* Composition ID for composition glyphs (type == COMPOSITION_GLYPH) */
308 /* Image ID for image glyphs (type == IMAGE_GLYPH). */
311 /* Sub-structure for type == STRETCH_GLYPH. */
314 /* The height of the glyph. */
315 unsigned height
: 16;
317 /* The ascent of the glyph. */
318 unsigned ascent
: 16;
322 /* Used to compare all bit-fields above in one step. */
328 /* Is GLYPH a space? */
330 #define CHAR_GLYPH_SPACE_P(GLYPH) \
331 (GLYPH_FROM_CHAR_GLYPH ((GLYPH)) == SPACEGLYPH)
333 /* Are glyphs *X and *Y displayed equal? */
335 #define GLYPH_EQUAL_P(X, Y) \
336 ((X)->type == (Y)->type \
337 && (X)->u.val == (Y)->u.val \
338 && (X)->face_id == (Y)->face_id \
339 && (X)->padding_p == (Y)->padding_p \
340 && (X)->left_box_line_p == (Y)->left_box_line_p \
341 && (X)->right_box_line_p == (Y)->right_box_line_p \
342 && (X)->voffset == (Y)->voffset \
343 && (X)->pixel_width == (Y)->pixel_width)
345 /* Are character codes, faces, padding_ps of glyphs *X and *Y equal? */
347 #define GLYPH_CHAR_AND_FACE_EQUAL_P(X, Y) \
348 ((X)->u.ch == (Y)->u.ch \
349 && (X)->face_id == (Y)->face_id \
350 && (X)->padding_p == (Y)->padding_p)
352 /* Fill a character glyph GLYPH. CODE, FACE_ID, PADDING_P correspond
353 to the bits defined for the typedef `GLYPH' in lisp.h. */
355 #define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P) \
358 (GLYPH).u.ch = (CODE); \
359 (GLYPH).face_id = (FACE_ID); \
360 (GLYPH).padding_p = (PADDING_P); \
364 /* Fill a character type glyph GLYPH from a glyph typedef FROM as
365 defined in lisp.h. */
367 #define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM) \
368 SET_CHAR_GLYPH ((GLYPH), \
369 FAST_GLYPH_CHAR ((FROM)), \
370 FAST_GLYPH_FACE ((FROM)), \
373 /* Construct a glyph code from a character glyph GLYPH. If the
374 character is multibyte, return -1 as we can't use glyph table for a
375 multibyte character. */
377 #define GLYPH_FROM_CHAR_GLYPH(GLYPH) \
378 ((GLYPH).u.ch < 256 \
379 ? ((GLYPH).u.ch | ((GLYPH).face_id << CHARACTERBITS)) \
382 /* Is GLYPH a padding glyph? */
384 #define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p
389 /***********************************************************************
391 ***********************************************************************/
395 Glyph memory for frame-based redisplay is allocated from the heap
396 in one vector kept in a glyph pool structure which is stored with
397 the frame. The size of the vector is made large enough to cover
398 all windows on the frame.
400 Both frame and window glyph matrices reference memory from a glyph
401 pool in frame-based redisplay.
403 In window-based redisplay, no glyphs pools exist; windows allocate
404 and free their glyph memory themselves. */
408 /* Vector of glyphs allocated from the heap. */
409 struct glyph
*glyphs
;
411 /* Allocated size of `glyphs'. */
414 /* Number of rows and columns in a matrix. */
420 /***********************************************************************
422 ***********************************************************************/
426 Three kinds of glyph matrices exist:
428 1. Frame glyph matrices. These are used for terminal frames whose
429 redisplay needs a view of the whole screen due to limited terminal
430 capabilities. Frame matrices are used only in the update phase
431 of redisplay. They are built in update_frame and not used after
432 the update has been performed.
434 2. Window glyph matrices on frames having frame glyph matrices.
435 Such matrices are sub-matrices of their corresponding frame matrix,
436 i.e. frame glyph matrices and window glyph matrices share the same
437 glyph memory which is allocated in form of a glyph_pool structure.
438 Glyph rows in such a window matrix are slices of frame matrix rows.
440 2. Free-standing window glyph matrices managing their own glyph
441 storage. This form is used in window-based redisplay which
442 includes variable width and height fonts etc.
444 The size of a window's row vector depends on the height of fonts
445 defined on its frame. It is chosen so that the vector is large
446 enough to describe all lines in a window when it is displayed in
447 the smallest possible character size. When new fonts are loaded,
448 or window sizes change, the row vector is adjusted accordingly. */
452 /* The pool from which glyph memory is allocated, if any. This is
453 null for frame matrices and for window matrices managing their
455 struct glyph_pool
*pool
;
457 /* Vector of glyph row structures. The row at nrows - 1 is reserved
458 for the mode line. */
459 struct glyph_row
*rows
;
461 /* Number of elements allocated for the vector rows above. */
464 /* The number of rows used by the window if all lines were displayed
465 with the smallest possible character height. */
468 /* Origin within the frame matrix if this is a window matrix on a
469 frame having a frame matrix. Both values are zero for
470 window-based redisplay. */
471 int matrix_x
, matrix_y
;
473 /* Width and height of the matrix in columns and rows. */
474 int matrix_w
, matrix_h
;
476 /* If this structure describes a window matrix of window W,
477 window_left_x is the value of W->left, window_top_y the value of
478 W->top, window_height and window_width are width and height of W,
479 as returned by window_box, and window_vscroll is the value of
480 W->vscroll at the time the matrix was last adjusted. Only set
481 for window-based redisplay. */
482 int window_left_x
, window_top_y
, window_height
, window_width
, window_vscroll
;
484 /* Number of glyphs reserved for left and right marginal areas when
485 the matrix was last adjusted. */
486 int left_margin_glyphs
, right_margin_glyphs
;
488 /* Flag indicating that scrolling should not be tried in
489 update_window. This flag is set by functions like try_window_id
490 which do their own scrolling. */
491 unsigned no_scrolling_p
: 1;
493 /* Non-zero means window displayed in this matrix has a top mode
495 unsigned header_line_p
: 1;
498 /* A string identifying the method used to display the matrix. */
502 /* The buffer this matrix displays. Set in redisplay_internal. */
503 struct buffer
*buffer
;
505 /* Values of BEGV and ZV as of last redisplay. */
510 /* Check that glyph pointers stored in glyph rows of MATRIX are okay.
511 This aborts if any pointer is found twice. */
514 void check_matrix_pointer_lossage
P_ ((struct glyph_matrix
*));
515 #define CHECK_MATRIX(MATRIX) check_matrix_pointer_lossage ((MATRIX))
517 #define CHECK_MATRIX(MATRIX) (void) 0
522 /***********************************************************************
524 ***********************************************************************/
526 /* Area in window glyph matrix. If values are added or removed, the
527 function mark_object in alloc.c has to be changed. */
538 /* Rows of glyphs in a windows or frame glyph matrix.
540 Each row is partitioned into three areas. The start and end of
541 each area is recorded in a pointer as shown below.
543 +--------------------+-------------+---------------------+
544 | left margin area | text area | right margin area |
545 +--------------------+-------------+---------------------+
547 glyphs[LEFT_MARGIN_AREA] glyphs[RIGHT_MARGIN_AREA]
552 Rows in frame matrices reference glyph memory allocated in a frame
553 glyph pool (see the description of struct glyph_pool). Rows in
554 window matrices on frames having frame matrices reference slices of
555 the glyphs of corresponding rows in the frame matrix.
557 Rows in window matrices on frames having no frame matrices point to
558 glyphs allocated from the heap via xmalloc;
559 glyphs[LEFT_MARGIN_AREA] is the start address of the allocated
560 glyph structure array. */
564 /* Pointers to beginnings of areas. The end of an area A is found at
565 A + 1 in the vector. The last element of the vector is the end
568 Kludge alert: Even if used[TEXT_AREA] == 0, glyphs[TEXT_AREA][0]'s
569 position field is used. It is -1 if this row does not correspond
570 to any text; it is some buffer position if the row corresponds to
571 an empty display line that displays a line end. This is what old
572 redisplay used to do. (Except in code for terminal frames, this
573 kludge is no longer use, I believe. --gerd).
575 See also start, end, displays_text_p and ends_at_zv_p for cleaner
576 ways to do it. The special meaning of positions 0 and -1 will be
577 removed some day, so don't use it in new code. */
578 struct glyph
*glyphs
[1 + LAST_AREA
];
580 /* Number of glyphs actually filled in areas. */
581 short used
[LAST_AREA
];
583 /* Window-relative x and y-position of the top-left corner of this
584 row. If y < 0, this means that abs (y) pixels of the row are
585 invisible because it is partially visible at the top of a window.
586 If x < 0, this means that abs (x) pixels of the first glyph of
587 the text area of the row are invisible because the glyph is
588 partially visible. */
591 /* Width of the row in pixels without taking face extension at the
592 end of the row into account. */
595 /* Logical ascent/height of this line. The value of ascent is zero
596 and height is 1 on terminal frames. */
599 /* Physical ascent/height of this line. If max_ascent > ascent,
600 this line overlaps the line above it on the display. Otherwise,
601 if max_height > height, this line overlaps the line beneath it. */
602 int phys_ascent
, phys_height
;
604 /* Portion of row that is visible. Partially visible rows may be
605 found at the top and bottom of a window. This is 1 for tty
606 frames. It may be < 0 in case of completely invisible rows. */
609 /* Hash code. This hash code is available as soon as the row
610 is constructed, i.e. after a call to display_line. */
613 /* First position in this row. This is the text position, including
614 overlay position information etc, where the display of this row
615 started, and can thus be less the position of the first glyph
616 (e.g. due to invisible text or horizontal scrolling). */
617 struct display_pos start
;
619 /* Text position at the end of this row. This is the position after
620 the last glyph on this row. It can be greater than the last
621 glyph position + 1, due to truncation, invisible text etc. In an
622 up-to-date display, this should always be equal to the start
623 position of the next row. */
624 struct display_pos end
;
626 /* In a desired matrix, 1 means that this row must be updated. In a
627 current matrix, 0 means that the row has been invalidated, i.e.
628 the row's contents do not agree with what is visible on the
630 unsigned enabled_p
: 1;
632 /* Display this line in inverse video? Used for the mode line and
634 unsigned inverse_p
: 1;
636 /* 1 means row displays a text line that is truncated on the left or
638 unsigned truncated_on_left_p
: 1;
639 unsigned truncated_on_right_p
: 1;
641 /* 1 means the overlay arrow is on this line. */
642 unsigned overlay_arrow_p
: 1;
644 /* 1 means that this row displays a continued line, i.e. it has a
645 continuation mark at the right side. */
646 unsigned continued_p
: 1;
648 /* 0 means that this row does not contain any text, i.e. it is
649 a blank line at the window and buffer end. */
650 unsigned displays_text_p
: 1;
652 /* 1 means that this line ends at ZV. */
653 unsigned ends_at_zv_p
: 1;
655 /* 1 means the face of the last glyph in the text area is drawn to
656 the right end of the window. This flag is used in
657 update_text_area to optimize clearing to the end of the area. */
658 unsigned fill_line_p
: 1;
660 /* Non-zero means display a bitmap on X frames indicating that this
661 line contains no text and ends in ZV. */
662 unsigned indicate_empty_line_p
: 1;
664 /* 1 means this row contains glyphs that overlap each other because
665 of lbearing or rbearing. */
666 unsigned contains_overlapping_glyphs_p
: 1;
668 /* 1 means this row is a wide as the window it is displayed in, including
669 scroll bars, bitmap areas, and internal borders. This also
670 implies that the row doesn't have marginal areas. */
671 unsigned full_width_p
: 1;
673 /* Non-zero means row is a mode or top-line. */
674 unsigned mode_line_p
: 1;
676 /* 1 in a current row means this row is overlapped by another row. */
677 unsigned overlapped_p
: 1;
679 /* 1 means this line ends in the middle of a character consisting
680 of more than one glyph. Some glyphs have been put in this row,
681 the rest are put in rows below this one. */
682 unsigned ends_in_middle_of_char_p
: 1;
684 /* 1 means this line starts in the middle of a character consisting
685 of more than one glyph. Some glyphs have been put in the
686 previoius row, the rest are put in this row. */
687 unsigned starts_in_middle_of_char_p
: 1;
689 /* 1 in a current row means this row overlaps others. */
690 unsigned overlapping_p
: 1;
692 /* 1 means some glyphs in this row are displayed in mouse-face. */
693 unsigned mouse_face_p
: 1;
695 /* Continuation lines width at the start of the row. */
696 int continuation_lines_width
;
700 /* Get a pointer to row number ROW in matrix MATRIX. If GLYPH_DEBUG
701 is defined to a non-zero value, the function matrix_row checks that
702 we don't try to access rows that are out of bounds. */
705 struct glyph_row
*matrix_row
P_ ((struct glyph_matrix
*, int));
706 #define MATRIX_ROW(MATRIX, ROW) matrix_row ((MATRIX), (ROW))
708 #define MATRIX_ROW(MATRIX, ROW) ((MATRIX)->rows + (ROW))
711 /* Return a pointer to the row reserved for the mode line in MATRIX.
712 Row MATRIX->nrows - 1 is always reserved for the mode line. */
714 #define MATRIX_MODE_LINE_ROW(MATRIX) \
715 ((MATRIX)->rows + (MATRIX)->nrows - 1)
717 /* Return a pointer to the row reserved for the top line in MATRIX.
718 This is always the first row in MATRIX because that's the only
719 way that works in frame-based redisplay. */
721 #define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows
723 /* Return a pointer to first row in MATRIX used for text display. */
725 #define MATRIX_FIRST_TEXT_ROW(MATRIX) \
726 ((MATRIX)->rows->mode_line_p ? (MATRIX)->rows + 1 : (MATRIX)->rows)
728 /* Return a pointer to the first glyph in the text area of a row.
729 MATRIX is the glyph matrix accessed, and ROW is the row index in
732 #define MATRIX_ROW_GLYPH_START(MATRIX, ROW) \
733 (MATRIX_ROW ((MATRIX), (ROW))->glyphs[TEXT_AREA])
735 /* Return the number of used glyphs in the text area of a row. */
737 #define MATRIX_ROW_USED(MATRIX, ROW) \
738 (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA])
740 /* Return the character/ byte position at which the display of ROW
743 #define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->start.pos.charpos)
744 #define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->start.pos.bytepos)
746 /* Return character/ byte position at which ROW ends. */
748 #define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->end.pos.charpos)
749 #define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->end.pos.bytepos)
751 /* Return the vertical position of ROW in MATRIX. */
753 #define MATRIX_ROW_VPOS(ROW, MATRIX) ((ROW) - (MATRIX)->rows)
755 /* Return the last glyph row + 1 in MATRIX on window W reserved for
756 text. If W has a mode line, the last row in the matrix is reserved
759 #define MATRIX_BOTTOM_TEXT_ROW(MATRIX, W) \
762 - (WINDOW_WANTS_MODELINE_P ((W)) ? 1 : 0))
764 /* Non-zero if the face of the last glyph in ROW's text area has
765 to be drawn to the end of the text area. */
767 #define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)
769 /* Set and query the enabled_p flag of glyph row ROW in MATRIX. */
771 #define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
772 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0)
774 #define MATRIX_ROW_ENABLED_P(MATRIX, ROW) \
775 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p)
777 /* Non-zero if ROW displays text. Value is non-zero if the row is
778 blank but displays a line end. */
780 #define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)
782 /* Non-zero if ROW is not completely visible in window W. */
784 #define MATRIX_ROW_PARTIALLY_VISIBLE_P(ROW) \
785 ((ROW)->height != (ROW)->visible_height)
787 /* Non-zero if ROW is partially visible at the top of window W. */
789 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW) \
790 (MATRIX_ROW_PARTIALLY_VISIBLE_P ((ROW)) \
791 && (ROW)->y < WINDOW_DISPLAY_HEADER_LINE_HEIGHT ((W)))
793 /* Non-zero if ROW is partially visible at the bottom of window W. */
795 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW) \
796 (MATRIX_ROW_PARTIALLY_VISIBLE_P ((ROW)) \
797 && (ROW)->y + (ROW)->height > WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE ((W)))
799 /* Return the bottom Y + 1 of ROW. */
801 #define MATRIX_ROW_BOTTOM_Y(ROW) ((ROW)->y + (ROW)->height)
803 /* Is ROW the last visible one in the display described by the
804 iterator structure pointed to by IT?. */
806 #define MATRIX_ROW_LAST_VISIBLE_P(ROW, IT) \
807 (MATRIX_ROW_BOTTOM_Y ((ROW)) >= (IT)->last_visible_y)
809 /* Non-zero if ROW displays a continuation line. */
811 #define MATRIX_ROW_CONTINUATION_LINE_P(ROW) \
812 ((ROW)->continuation_lines_width > 0)
814 /* Non-zero if ROW ends in the middle of a character. This is the
815 case for continued lines showing only part of a display table entry
816 or a control char, or an overlay string. */
818 #define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW) \
819 ((ROW)->end.dpvec_index >= 0 \
820 || (ROW)->end.overlay_string_index >= 0 \
821 || (ROW)->ends_in_middle_of_char_p)
823 /* Non-zero if ROW ends in the middle of an overlay string. */
825 #define MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P(ROW) \
826 ((ROW)->end.overlay_string_index >= 0)
828 /* Non-zero if ROW starts in the middle of a character. See above. */
830 #define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW) \
831 ((ROW)->start.dpvec_index >= 0 \
832 || (ROW)->starts_in_middle_of_char_p \
833 || ((ROW)->start.overlay_string_index >= 0 \
834 && (ROW)->start.string_pos.charpos > 0))
836 /* Non-zero means ROW overlaps its predecessor. */
838 #define MATRIX_ROW_OVERLAPS_PRED_P(ROW) \
839 ((ROW)->phys_ascent > (ROW)->ascent)
841 /* Non-zero means ROW overlaps its successor. */
843 #define MATRIX_ROW_OVERLAPS_SUCC_P(ROW) \
844 ((ROW)->phys_height - (ROW)->phys_ascent \
845 > (ROW)->height - (ROW)->ascent)
847 /* Non-zero means that fonts have been loaded since the last glyph
848 matrix adjustments. The function redisplay_internal adjusts glyph
849 matrices when this flag is non-zero. */
851 extern int fonts_changed_p
;
853 /* A glyph for a space. */
855 extern struct glyph space_glyph
;
857 /* Frame being updated by update_window/update_frame. */
859 extern struct frame
*updating_frame
;
861 /* Window being updated by update_window. This is non-null as long as
862 update_window has not finished, and null otherwise. It's role is
863 analogous to updating_frame. */
865 extern struct window
*updated_window
;
867 /* Glyph row and area updated by update_window_line. */
869 extern struct glyph_row
*updated_row
;
870 extern int updated_area
;
872 /* Non-zero means reading single-character input with prompt so put
873 cursor on mini-buffer after the prompt. Positive means at end of
874 text in echo area; negative means at beginning of line. */
876 extern int cursor_in_echo_area
;
878 /* Non-zero means last display completed. Zero means it was
881 extern int display_completed
;
883 /* Non-zero means redisplay has been performed directly (see also
884 direct_output_for_insert and direct_output_forward_char), so that
885 no further updating has to be performed. The function
886 redisplay_internal checks this flag, and does nothing but reset it
887 to zero if it is non-zero. */
889 extern int redisplay_performed_directly_p
;
891 /* A temporary storage area, including a row of glyphs. Initialized
892 in xdisp.c. Used for various purposes, as an example see
893 direct_output_for_insert. */
895 extern struct glyph_row scratch_glyph_row
;
899 /************************************************************************
901 ************************************************************************/
903 /* Return the height of the mode line in glyph matrix MATRIX, or zero
904 if not known. This macro is called under circumstances where
905 MATRIX might not have been allocated yet. */
907 #define MATRIX_MODE_LINE_HEIGHT(MATRIX) \
908 ((MATRIX) && (MATRIX)->rows \
909 ? MATRIX_MODE_LINE_ROW (MATRIX)->height \
912 /* Return the height of the top line in glyph matrix MATRIX, or zero
913 if not known. This macro is called under circumstances where
914 MATRIX might not have been allocated yet. */
916 #define MATRIX_HEADER_LINE_HEIGHT(MATRIX) \
917 ((MATRIX) && (MATRIX)->rows \
918 ? MATRIX_HEADER_LINE_ROW (MATRIX)->height \
921 /* Return the current height of the mode line of window W. If not
922 known from current_mode_line_height, look at W's current glyph
923 matrix, or return a default based on the height of the font of the
926 #define CURRENT_MODE_LINE_HEIGHT(W) \
927 (current_mode_line_height >= 0 \
928 ? current_mode_line_height \
929 : (MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
930 ? MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
931 : estimate_mode_line_height (XFRAME ((W)->frame), \
934 /* Return the current height of the top line of window W. If not
935 known from current_header_line_height, look at W's current glyph
936 matrix, or return an estimation based on the height of the font of
937 the face `header-line'. */
939 #define CURRENT_HEADER_LINE_HEIGHT(W) \
940 (current_header_line_height >= 0 \
941 ? current_header_line_height \
942 : (MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
943 ? MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
944 : estimate_mode_line_height (XFRAME ((W)->frame), \
945 HEADER_LINE_FACE_ID)))
947 /* Return the height of the desired mode line of window W. */
949 #define DESIRED_MODE_LINE_HEIGHT(W) \
950 MATRIX_MODE_LINE_HEIGHT ((W)->desired_matrix)
952 /* Return the height of the desired top line of window W. */
954 #define DESIRED_HEADER_LINE_HEIGHT(W) \
955 MATRIX_HEADER_LINE_HEIGHT ((W)->desired_matrix)
957 /* Like FRAME_INTERNAL_BORDER_WIDTH but checks whether frame F is a
958 window-system frame. */
960 #define FRAME_INTERNAL_BORDER_WIDTH_SAFE(F) \
961 (FRAME_WINDOW_P (F) ? FRAME_INTERNAL_BORDER_WIDTH (F) : 0)
963 /* Width of display region of window W. For terminal frames, this
964 equals the width of W since there are no vertical scroll bars. For
965 window system frames, the value has to be corrected by the pixel
966 width of vertical scroll bars, and bitmap areas. */
968 #define WINDOW_DISPLAY_PIXEL_WIDTH(W) \
969 (((XFASTINT ((W)->width) \
970 - FRAME_SCROLL_BAR_WIDTH (XFRAME (WINDOW_FRAME ((W)))) \
971 - FRAME_FLAGS_AREA_COLS (XFRAME (WINDOW_FRAME ((W))))) \
972 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))))
974 /* Height of the display region of W, including a mode line, if any. */
976 #define WINDOW_DISPLAY_PIXEL_HEIGHT(W) \
977 (XFASTINT ((W)->height) \
978 * CANON_Y_UNIT (XFRAME (WINDOW_FRAME ((W)))))
980 /* Height in pixels of the mode line. May be zero if W doesn't have a
983 #define WINDOW_DISPLAY_MODE_LINE_HEIGHT(W) \
984 (WINDOW_WANTS_MODELINE_P ((W)) \
985 ? CURRENT_MODE_LINE_HEIGHT (W) \
988 /* Height in pixels of the top line. Zero if W doesn't have a top
991 #define WINDOW_DISPLAY_HEADER_LINE_HEIGHT(W) \
992 (WINDOW_WANTS_HEADER_LINE_P ((W)) \
993 ? CURRENT_HEADER_LINE_HEIGHT (W) \
996 /* Pixel height of window W without mode line. */
998 #define WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE(W) \
999 (WINDOW_DISPLAY_PIXEL_HEIGHT ((W)) \
1000 - WINDOW_DISPLAY_MODE_LINE_HEIGHT ((W)))
1002 /* Pixel height of window W without mode and top line. */
1004 #define WINDOW_DISPLAY_TEXT_HEIGHT(W) \
1005 (WINDOW_DISPLAY_PIXEL_HEIGHT ((W)) \
1006 - WINDOW_DISPLAY_MODE_LINE_HEIGHT ((W)) \
1007 - WINDOW_DISPLAY_HEADER_LINE_HEIGHT ((W)))
1009 /* Left edge of W in pixels relative to its frame. */
1011 #define WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X(W) \
1012 (FRAME_INTERNAL_BORDER_WIDTH_SAFE (XFRAME (WINDOW_FRAME ((W)))) \
1013 + (WINDOW_LEFT_MARGIN ((W)) \
1014 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))) \
1015 + FRAME_LEFT_FLAGS_AREA_WIDTH (XFRAME (WINDOW_FRAME ((W)))))
1017 /* Right edge of window W in pixels, relative to its frame. */
1019 #define WINDOW_DISPLAY_RIGHT_EDGE_PIXEL_X(W) \
1020 (WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X ((W)) \
1021 + WINDOW_DISPLAY_PIXEL_WIDTH ((W)))
1023 /* Top edge of W in pixels relative to its frame. */
1025 #define WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y(W) \
1026 (FRAME_INTERNAL_BORDER_WIDTH_SAFE (XFRAME (WINDOW_FRAME ((W)))) \
1027 + (XFASTINT ((W)->top) \
1028 * CANON_Y_UNIT (XFRAME (WINDOW_FRAME ((W))))))
1030 /* Bottom edge of window W relative to its frame. */
1032 #define WINDOW_DISPLAY_BOTTOM_EDGE_PIXEL_Y(W) \
1033 (WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y ((W)) \
1034 + WINDOW_DISPLAY_PIXEL_HEIGHT ((W)))
1036 /* Convert window W relative pixel X to frame pixel coordinates. */
1038 #define WINDOW_TO_FRAME_PIXEL_X(W, X) \
1039 ((X) + WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X ((W)))
1041 /* Convert window W relative pixel Y to frame pixel coordinates. */
1043 #define WINDOW_TO_FRAME_PIXEL_Y(W, Y) \
1044 ((Y) + WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y ((W)))
1046 /* Convert frame relative pixel X to window relative pixel X. */
1048 #define FRAME_TO_WINDOW_PIXEL_X(W, X) \
1049 ((X) - WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X ((W)))
1051 /* Convert frame relative pixel X to window relative pixel Y. */
1053 #define FRAME_TO_WINDOW_PIXEL_Y(W, Y) \
1054 ((Y) - WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y ((W)))
1056 /* Width of left margin area in pixels. */
1058 #define WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH(W) \
1059 (NILP ((W)->left_margin_width) \
1061 : (XINT ((W)->left_margin_width) \
1062 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))))
1064 /* Width of right marginal area in pixels. */
1066 #define WINDOW_DISPLAY_RIGHT_AREA_PIXEL_WIDTH(W) \
1067 (NILP ((W)->right_margin_width) \
1069 : (XINT ((W)->right_margin_width) \
1070 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))))
1072 /* Width of text area in pixels. */
1074 #define WINDOW_DISPLAY_TEXT_AREA_PIXEL_WIDTH(W) \
1075 (WINDOW_DISPLAY_PIXEL_WIDTH ((W)) \
1076 - WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)) \
1077 - WINDOW_DISPLAY_RIGHT_AREA_PIXEL_WIDTH ((W)))
1079 /* Convert a text area relative x-position in window W to frame X
1080 pixel coordinates. */
1082 #define WINDOW_TEXT_TO_FRAME_PIXEL_X(W, X) \
1083 (WINDOW_TO_FRAME_PIXEL_X ((W), (X)) \
1084 + WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)))
1086 /* Translate an x-position relative to AREA in window W to frame pixel
1089 #define WINDOW_AREA_TO_FRAME_PIXEL_X(W, AREA, X) \
1090 (WINDOW_TO_FRAME_PIXEL_X ((W), (X)) \
1091 + (((AREA) > LEFT_MARGIN_AREA) \
1092 ? WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)) \
1094 + (((AREA) > TEXT_AREA) \
1095 ? WINDOW_DISPLAY_TEXT_AREA_PIXEL_WIDTH ((W)) \
1098 /* Return the pixel width of AREA in W. */
1100 #define WINDOW_AREA_PIXEL_WIDTH(W, AREA) \
1101 (((AREA) == TEXT_AREA) \
1102 ? WINDOW_DISPLAY_TEXT_AREA_PIXEL_WIDTH ((W)) \
1103 : (((AREA) == LEFT_MARGIN_AREA) \
1104 ? WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)) \
1105 : WINDOW_DISPLAY_RIGHT_AREA_PIXEL_WIDTH ((W))))
1107 /* Value is non-zero if window W has a mode line. */
1109 #define WINDOW_WANTS_MODELINE_P(W) \
1110 (!MINI_WINDOW_P (W) \
1111 && !(W)->pseudo_window_p \
1112 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME (W))) \
1113 && BUFFERP ((W)->buffer) \
1114 && !NILP (XBUFFER ((W)->buffer)->mode_line_format))
1116 /* Value is non-zero if window W wants a top line. */
1118 #define WINDOW_WANTS_HEADER_LINE_P(W) \
1119 (!MINI_WINDOW_P (W) \
1120 && !(W)->pseudo_window_p \
1121 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME (W))) \
1122 && BUFFERP ((W)->buffer) \
1123 && !NILP (XBUFFER ((W)->buffer)->header_line_format))
1126 /***********************************************************************
1128 ***********************************************************************/
1130 /* Indices of face attributes in Lisp face vectors. Slot zero is the
1133 enum lface_attribute_index
1135 LFACE_FAMILY_INDEX
= 1,
1140 LFACE_UNDERLINE_INDEX
,
1141 LFACE_INVERSE_INDEX
,
1142 LFACE_FOREGROUND_INDEX
,
1143 LFACE_BACKGROUND_INDEX
,
1144 LFACE_STIPPLE_INDEX
,
1145 LFACE_OVERLINE_INDEX
,
1146 LFACE_STRIKE_THROUGH_INDEX
,
1149 LFACE_INHERIT_INDEX
,
1150 LFACE_AVGWIDTH_INDEX
,
1155 /* Box types of faces. */
1159 /* No box around text. */
1162 /* Simple box of specified width and color. Default width is 1, and
1163 default color is the foreground color of the face. */
1166 /* Boxes with 3D shadows. Color equals the background color of the
1167 face. Width is specified. */
1173 /* Structure describing a realized face.
1175 For each Lisp face, 0..N realized faces can exist for different
1176 frames and different charsets. Realized faces are built from Lisp
1177 faces and text properties/overlays by merging faces and adding
1178 unspecified attributes from the `default' face. */
1182 /* The id of this face. The id equals the index of this face in the
1183 vector faces_by_id of its face cache. */
1186 #ifdef HAVE_WINDOW_SYSTEM
1188 /* If non-zero, a GC we can use without modification to draw
1189 characters in this face. */
1192 /* Font used for this face, or null if the font could not be loaded
1193 for some reason. This points to a `font' slot of a struct
1194 font_info, and we should not call XFreeFont on it because the
1195 font may still be used somewhere else. */
1198 /* Background stipple or bitmap used for this face. */
1201 #else /* not HAVE_WINDOW_SYSTEM */
1206 #endif /* not HAVE_WINDOW_SYSTEM */
1208 /* Pixel value of foreground color for X frames. Color index
1210 unsigned long foreground
;
1212 /* Pixel value or color index of background color. */
1213 unsigned long background
;
1215 /* Pixel value or color index of underline color. */
1216 unsigned long underline_color
;
1218 /* Pixel value or color index of overlined, strike-through, or box
1220 unsigned long overline_color
;
1221 unsigned long strike_through_color
;
1222 unsigned long box_color
;
1224 /* The font's name. This points to a `name' of a font_info, and it
1225 must not be freed. */
1228 /* Font info ID for this face's font. An ID is stored here because
1229 pointers to font_info structures may change. The reason is that
1230 they are pointers into a font table vector that is itself
1234 /* Fontset ID if this face uses a fontset, or -1. This is only >= 0
1235 if the face was realized for a composition sequence.
1236 Otherwise, a specific font is loaded from the set of fonts
1237 specified by the fontset given by the family attribute of the face. */
1240 /* Pixmap width and height. */
1241 unsigned int pixmap_w
, pixmap_h
;
1243 /* Non-zero means characters in this face have a box that thickness
1247 /* Type of box drawn. A value of FACE_NO_BOX means no box is drawn
1248 around text in this face. A value of FACE_SIMPLE_BOX means a box
1249 of width box_line_width is drawn in color box_color. A value of
1250 FACE_RAISED_BOX or FACE_SUNKEN_BOX means a 3D box is drawn with
1251 shadow colors derived from the background color of the face. */
1252 enum face_box_type box
;
1254 /* If `box' above specifies a 3D type, 1 means use box_color for
1256 unsigned use_box_color_for_shadows_p
: 1;
1258 /* The Lisp face attributes this face realizes. All attributes
1259 in this vector are non-nil. */
1260 Lisp_Object lface
[LFACE_VECTOR_SIZE
];
1262 /* The hash value of this face. */
1265 /* The charset for which this face was realized if it was realized
1266 for use in multibyte text. If fontset >= 0, this is the charset
1267 of the first character of the composition sequence. A value of
1268 charset < 0 means the face was realized for use in unibyte text
1269 where the idea of Emacs charsets isn't applicable. */
1272 /* Non-zero if text in this face should be underlined, overlined,
1273 strike-through or have a box drawn around it. */
1274 unsigned underline_p
: 1;
1275 unsigned overline_p
: 1;
1276 unsigned strike_through_p
: 1;
1278 /* 1 means that the colors specified for this face could not be
1279 loaded, and were replaced by default colors, so they shouldn't be
1281 unsigned foreground_defaulted_p
: 1;
1282 unsigned background_defaulted_p
: 1;
1284 /* 1 means that either no color is specified for underlining or that
1285 the the specified color couldn't be loaded. Use the foreground
1286 color when drawing in that case. */
1287 unsigned underline_defaulted_p
: 1;
1289 /* 1 means that either no color is specified for the corresponding
1290 attribute or that the the specified color couldn't be loaded.
1291 Use the foreground color when drawing in that case. */
1292 unsigned overline_color_defaulted_p
: 1;
1293 unsigned strike_through_color_defaulted_p
: 1;
1294 unsigned box_color_defaulted_p
: 1;
1296 /* TTY appearances. Blinking is not yet implemented. Colors are
1297 found in `lface' with empty color string meaning the default
1298 color of the TTY. */
1299 unsigned tty_bold_p
: 1;
1300 unsigned tty_dim_p
: 1;
1301 unsigned tty_underline_p
: 1;
1302 unsigned tty_alt_charset_p
: 1;
1303 unsigned tty_reverse_p
: 1;
1304 unsigned tty_blinking_p
: 1;
1306 /* Next and previous face in hash collision list of face cache. */
1307 struct face
*next
, *prev
;
1309 /* If this face is for ASCII characters, this points this face
1310 itself. Otherwise, this points a face for ASCII characters. */
1311 struct face
*ascii_face
;
1315 /* Color index indicating that face uses a terminal's default color. */
1317 #define FACE_TTY_DEFAULT_COLOR ((unsigned long) -1)
1319 /* Color index indicating that face uses an unknown foreground color. */
1321 #define FACE_TTY_DEFAULT_FG_COLOR ((unsigned long) -2)
1323 /* Color index indicating that face uses an unsigned background color. */
1325 #define FACE_TTY_DEFAULT_BG_COLOR ((unsigned long) -3)
1327 /* Non-zero if FACE was realized for unibyte use. */
1329 #define FACE_UNIBYTE_P(FACE) ((FACE)->charset < 0)
1332 /* IDs of important faces known by the C face code. These are the IDs
1333 of the faces for CHARSET_ASCII. */
1340 BITMAP_AREA_FACE_ID
,
1341 HEADER_LINE_FACE_ID
,
1347 BASIC_FACE_ID_SENTINEL
1351 /* A cache of realized faces. Each frame has its own cache because
1352 Emacs allows different frame-local face definitions. */
1356 /* Hash table of cached realized faces. */
1357 struct face
**buckets
;
1359 /* Back-pointer to the frame this cache belongs to. */
1362 /* A vector of faces so that faces can be referenced by an ID. */
1363 struct face
**faces_by_id
;
1365 /* The allocated size, and number of used slots of faces_by_id. */
1370 /* Prepare face FACE for use on frame F. This must be called before
1371 using X resources of FACE. */
1373 #define PREPARE_FACE_FOR_DISPLAY(F, FACE) \
1374 if ((FACE)->gc == 0) \
1375 prepare_face_for_display ((F), (FACE)); \
1379 /* Return a pointer to the face with ID on frame F, or null if such a
1380 face doesn't exist. */
1382 #define FACE_FROM_ID(F, ID) \
1383 (((unsigned) (ID) < FRAME_FACE_CACHE (F)->used) \
1384 ? FRAME_FACE_CACHE (F)->faces_by_id[ID] \
1387 #ifdef HAVE_WINDOW_SYSTEM
1389 /* Non-zero if FACE is suitable for displaying character CHAR. */
1391 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) \
1392 (SINGLE_BYTE_CHAR_P (CHAR) \
1393 ? (FACE) == (FACE)->ascii_face \
1394 : face_suitable_for_char_p ((FACE), (CHAR)))
1396 /* Return the id of the realized face on frame F that is like the face
1397 with id ID but is suitable for displaying character CHAR.
1398 This macro is only meaningful for multibyte character CHAR. */
1400 #define FACE_FOR_CHAR(F, FACE, CHAR) \
1401 (SINGLE_BYTE_CHAR_P (CHAR) \
1402 ? (FACE)->ascii_face->id \
1403 : face_for_char ((F), (FACE), (CHAR)))
1405 #else /* not HAVE_WINDOW_SYSTEM */
1407 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) 1
1408 #define FACE_FOR_CHAR(F, FACE, CHAR) ((FACE)->id)
1410 #endif /* not HAVE_WINDOW_SYSTEM */
1412 /* Non-zero means face attributes have been changed since the last
1413 redisplay. Used in redisplay_internal. */
1415 extern int face_change_count
;
1420 /***********************************************************************
1422 ***********************************************************************/
1424 /* Iteration over things to display in current_buffer or in a string.
1426 The iterator handles:
1428 1. Overlay strings (after-string, before-string).
1430 3. Invisible text properties.
1431 4. Selective display.
1432 5. Translation of characters via display tables.
1433 6. Translation of control characters to the forms `\003' or `^C'.
1434 7. `glyph' and `space-width' properties.
1436 Iterators are initialized by calling init_iterator or one of the
1437 equivalent functions below. A call to get_next_display_element
1438 loads the iterator structure with information about what next to
1439 display. A call to set_iterator_to_next increments the iterator's
1442 Characters from overlay strings, display table entries or control
1443 character translations are returned one at a time. For example, if
1444 we have a text of `a\x01' where `a' has a display table definition
1445 of `cd' and the control character is displayed with a leading
1446 arrow, then the iterator will return:
1448 Call Return Source Call next
1449 -----------------------------------------------------------------
1450 next c display table move
1451 next d display table move
1452 next ^ control char move
1453 next A control char move
1455 The same mechanism is also used to return characters for ellipses
1456 displayed at the end of invisible text.
1458 CAVEAT: Under some circumstances, move_.* functions can be called
1459 asynchronously, e.g. when computing a buffer position from an x and
1460 y pixel position. This means that these functions and functions
1461 called from them SHOULD NOT USE xmalloc and alike. See also the
1462 comment at the start of xdisp.c. */
1464 /* Enumeration describing what kind of display element an iterator is
1465 loaded with after a call to get_next_display_element. */
1467 enum display_element_type
1469 /* A normal character. */
1472 /* A composition sequence. */
1478 /* A flexible width and height space. */
1481 /* End of buffer or string. */
1484 /* Truncation glyphs. Never returned by get_next_display_element.
1485 Used to get display information about truncation glyphs via
1489 /* Continuation glyphs. See the comment for IT_TRUNCATION. */
1494 /* An enumerator for each text property that has a meaning for display
1503 COMPOSITION_PROP_IDX
,
1505 /* Not a property. Used to indicate changes in overlays. */
1515 /* The window in which we iterate over current_buffer (or a string). */
1519 /* The window's frame. */
1522 /* Function to call to load this structure with the next display
1524 int (* method
) P_ ((struct it
*it
));
1526 /* The next position at which to check for face changes, invisible
1527 text, overlay strings, end of text etc., which see. */
1530 /* Maximum string or buffer position + 1. ZV when iterating over
1534 /* C string to iterate over. Non-null means get characters from
1535 this string, otherwise characters are read from current_buffer
1539 /* Number of characters in the string (s, or it->string) we iterate
1543 /* Start and end of a visible region; -1 if the region is not
1544 visible in the window. */
1545 int region_beg_charpos
, region_end_charpos
;
1547 /* Position at which redisplay end trigger functions should be run. */
1548 int redisplay_end_trigger_charpos
;
1550 /* 1 means multibyte characters are enabled. */
1551 unsigned multibyte_p
: 1;
1553 /* 1 means window has a mode line at its top. */
1554 unsigned header_line_p
: 1;
1556 /* 1 means `string' is the value of a `display' property.
1557 Don't handle some `display' properties in these strings. */
1558 unsigned string_from_display_prop_p
: 1;
1560 /* Display table in effect or null for none. */
1561 struct Lisp_Char_Table
*dp
;
1563 /* Current display table vector to return characters from and its
1564 end. dpvec null means we are not returning characters from a
1565 display table entry; current.dpvec_index gives the current index
1566 into dpvec. This same mechanism is also used to return
1567 characters from translated control characters, i.e. `\003' or
1569 Lisp_Object
*dpvec
, *dpend
;
1571 /* Length in bytes of the char that filled dpvec. A value of zero
1572 means that no character such character is involved. */
1575 /* Face id of the iterator saved in case a glyph from dpvec contains
1576 a face. The face is restored when all glyphs from dpvec have
1580 /* Vector of glyphs for control character translation. The pointer
1581 dpvec is set to ctl_chars when a control character is translated.
1582 This vector is also used for incomplete multibyte character
1583 translation (e.g \222\244). Such a character is at most 3 bytes,
1584 thus we need at most 12 bytes here. */
1585 Lisp_Object ctl_chars
[12];
1587 /* Current buffer or string position of the iterator, including
1588 position in overlay strings etc. */
1589 struct display_pos current
;
1591 /* Vector of overlays to process. Overlay strings are processed
1592 OVERLAY_STRING_CHUNK_SIZE at a time. */
1593 #define OVERLAY_STRING_CHUNK_SIZE 3
1594 Lisp_Object overlay_strings
[OVERLAY_STRING_CHUNK_SIZE
];
1596 /* Total number of overlay strings to process. This can be >
1597 OVERLAY_STRING_CHUNK_SIZE. */
1598 int n_overlay_strings
;
1600 /* If non-nil, a Lisp string being processed. If
1601 current.overlay_string_index >= 0, this is an overlay string from
1605 /* Stack of saved values. New entries are pushed when we begin to
1606 process an overlay string or a string from a `glyph' property.
1607 Entries are popped when we return to deliver display elements
1608 from what we previously had. */
1609 struct iterator_stack_entry
1614 struct display_pos pos
;
1617 enum glyph_row_area area
;
1618 unsigned multibyte_p
: 1;
1619 unsigned string_from_display_prop_p
: 1;
1620 Lisp_Object space_width
;
1622 Lisp_Object font_height
;
1626 /* Stack pointer. */
1629 /* Setting of buffer-local variable selective-display-ellipsis. */
1630 unsigned selective_display_ellipsis_p
: 1;
1632 /* 1 means control characters are translated into the form `^C'
1633 where the `^' can be replaced by a display table entry. */
1634 unsigned ctl_arrow_p
: 1;
1636 /* -1 means selective display hides everything between a \r and the
1637 next newline; > 0 means hide lines indented more than that value. */
1640 /* An enumeration describing what the next display element is
1641 after a call to get_next_display_element. */
1642 enum display_element_type what
;
1647 /* Non-zero means that the current face has a box. */
1648 unsigned face_box_p
: 1;
1650 /* Non-null means that the current character is the first in a run
1651 of characters with box face. */
1652 unsigned start_of_box_run_p
: 1;
1654 /* Non-zero means that the current character is the last in a run
1655 of characters with box face. */
1656 unsigned end_of_box_run_p
: 1;
1658 /* 1 means overlay strings at end_charpos have been processed. */
1659 unsigned overlay_strings_at_end_processed_p
: 1;
1661 /* 1 means the actual glyph is not available in the current
1663 unsigned glyph_not_available_p
: 1;
1665 /* 1 means the next line in display_line continues a character
1666 consisting of more than one glyph, and some glyphs of this
1667 character have been put on the previous line. */
1668 unsigned starts_in_middle_of_char_p
: 1;
1670 /* If 1, saved_face_id contains the id of the face in front of text
1671 skipped due to selective display. */
1672 unsigned face_before_selective_p
: 1;
1674 /* The ID of the default face to use. One of DEFAULT_FACE_ID,
1675 MODE_LINE_FACE_ID, etc, depending on what we are displaying. */
1678 /* If what == IT_CHARACTER, character and length in bytes. This is
1679 a character from a buffer or string. It may be different from
1680 the character displayed in case that
1681 unibyte_display_via_language_environment is set.
1683 If what == IT_COMPOSITION, the first component of a composition
1684 and length in bytes of the composition. */
1687 /* If what == IT_COMPOSITION, identification number and length in
1688 chars of a composition. */
1689 int cmp_id
, cmp_len
;
1691 /* The character to display, possibly translated to multibyte
1692 if unibyte_display_via_language_environment is set. This
1693 is set after x_produce_glyphs has been called. */
1694 int char_to_display
;
1696 /* If what == IT_IMAGE, the id of the image to display. */
1699 /* Value of the `space-width' property, if any; nil if none. */
1700 Lisp_Object space_width
;
1702 /* Computed from the value of the `raise' property. */
1705 /* Value of the `height' property, if any; nil if none. */
1706 Lisp_Object font_height
;
1708 /* Object and position where the current display element came from.
1709 Object can be a Lisp string in case the current display element
1710 comes from an overlay string, or it is buffer. Position is
1711 a position in object. */
1713 struct text_pos position
;
1715 /* 1 means lines are truncated. */
1716 unsigned truncate_lines_p
: 1;
1718 /* Number of columns per \t. */
1721 /* Width in pixels of truncation and continuation glyphs. */
1722 short truncation_pixel_width
, continuation_pixel_width
;
1724 /* First and last visible x-position in the display area. If window
1725 is hscrolled by n columns, first_visible_x == n * CANON_X_UNIT
1726 (f), and last_visible_x == pixel width of W + first_visible_x. */
1727 int first_visible_x
, last_visible_x
;
1729 /* Last visible y-position + 1 in the display area without a mode
1730 line, if the window has one. */
1733 /* Additional space in pixels between lines (for window systems
1735 int extra_line_spacing
;
1737 /* If non-null, glyphs are produced in glyph_row with each call to
1739 struct glyph_row
*glyph_row
;
1741 /* The area of glyph_row to which glyphs are added. */
1742 enum glyph_row_area area
;
1744 /* Number of glyphs needed for the last character requested via
1745 produce_glyphs. This is 1 except for tabs. */
1748 /* Width of the display element in pixels. Result of
1752 /* Current, maximum logical, and maximum physical line height
1753 information. Result of produce_glyphs. */
1754 int ascent
, descent
, max_ascent
, max_descent
;
1755 int phys_ascent
, phys_descent
, max_phys_ascent
, max_phys_descent
;
1757 /* Current x pixel position within the display line. This value
1758 does not include the width of continuation lines in front of the
1759 line. The value of current_x is automatically incremented by
1760 pixel_width with each call to produce_glyphs. */
1763 /* Accumulated width of continuation lines. If > 0, this means we
1764 are currently in a continuation line. This is initially zero and
1765 incremented/reset by display_line, move_it_to etc. */
1766 int continuation_lines_width
;
1768 /* Current y-position. Automatically incremented by the height of
1769 glyph_row in move_it_to and display_line. */
1772 /* Current vertical matrix position, or line number. Automatically
1773 incremented by move_it_to and display_line. */
1776 /* Horizontal matrix position reached in move_it_in_display_line.
1777 Only set there, not in display_line. */
1782 /* Access to positions of iterator IT. */
1784 #define IT_CHARPOS(IT) CHARPOS ((IT).current.pos)
1785 #define IT_BYTEPOS(IT) BYTEPOS ((IT).current.pos)
1786 #define IT_STRING_CHARPOS(IT) CHARPOS ((IT).current.string_pos)
1787 #define IT_STRING_BYTEPOS(IT) BYTEPOS ((IT).current.string_pos)
1789 /* Test if IT has reached the end of its buffer or string. This will
1790 only work after get_next_display_element has been called. */
1792 #define ITERATOR_AT_END_P(IT) ((IT)->what == IT_EOB)
1794 /* Non-zero means IT is at the end of a line. This is the case if it
1795 is either on a newline or on a carriage return and selective
1796 display hides the rest of the line. */
1798 #define ITERATOR_AT_END_OF_LINE_P(IT) \
1799 ((IT)->what == IT_CHARACTER \
1800 && ((IT)->c == '\n' \
1801 || ((IT)->c == '\r' && (IT)->selective)))
1803 /* Call produce_glyphs or produce_glyphs_hook, if set. Shortcut to
1804 avoid the function call overhead. */
1806 #define PRODUCE_GLYPHS(IT) \
1808 ? rif->produce_glyphs ((IT)) \
1809 : produce_glyphs ((IT)))
1811 /* Bit-flags indicating what operation move_it_to should perform. */
1813 enum move_operation_enum
1815 /* Stop if specified x-position is reached. */
1818 /* Stop if specified y-position is reached. */
1821 /* Stop if specified vpos is reached. */
1822 MOVE_TO_VPOS
= 0x04,
1824 /* Stop if specified buffer or string position is reached. */
1830 /***********************************************************************
1831 Window-based redisplay interface
1832 ***********************************************************************/
1834 /* Structure used to describe runs of lines that must be scrolled. */
1838 /* Source and destination y pixel position. */
1839 int desired_y
, current_y
;
1841 /* Source and destination vpos in matrix. */
1842 int desired_vpos
, current_vpos
;
1844 /* Height in pixels, number of glyph rows. */
1849 /* Structure holding system-dependent interface functions needed
1850 for window-based redisplay. */
1852 struct redisplay_interface
1854 /* Produce glyphs/get display metrics for the display element IT is
1856 void (*produce_glyphs
) P_ ((struct it
*it
));
1858 /* Write or insert LEN glyphs from STRING at the nominal output
1860 void (*write_glyphs
) P_ ((struct glyph
*string
, int len
));
1861 void (*insert_glyphs
) P_ ((struct glyph
*start
, int len
));
1863 /* Clear from nominal output position to X. X < 0 means clear
1864 to right end of display. */
1865 void (*clear_end_of_line
) P_ ((int x
));
1867 /* Function to call to scroll the display as described by RUN on
1869 void (*scroll_run_hook
) P_ ((struct window
*w
, struct run
*run
));
1871 /* Function to call after a line in a display has been completely
1872 updated. Used to draw truncation marks and alike. DESIRED_ROW
1873 is the desired row which has been updated. */
1874 void (*after_update_window_line_hook
) P_ ((struct glyph_row
*desired_row
));
1876 /* Function to call before beginning to update window W in
1877 window-based redisplay. */
1878 void (*update_window_begin_hook
) P_ ((struct window
*w
));
1880 /* Function to call after window W has been updated in window-based
1881 redisplay. CURSOR_ON_P non-zero means switch cursor on.
1882 MOUSE_FACE_OVERWRITTEN_P non-zero means that some lines in W
1883 that contained glyphs in mouse-face were overwritten, so we
1884 have to update the mouse hightlight. */
1885 void (*update_window_end_hook
) P_ ((struct window
*w
, int cursor_on_p
,
1886 int mouse_face_overwritten_p
));
1888 /* Move cursor to row/column position VPOS/HPOS, pixel coordinates
1889 Y/X. HPOS/VPOS are window-relative row and column numbers and X/Y
1890 are window-relative pixel positions. */
1891 void (*cursor_to
) P_ ((int vpos
, int hpos
, int y
, int x
));
1893 /* Flush the display of frame F. For X, this is XFlush. */
1894 void (*flush_display
) P_ ((struct frame
*f
));
1896 /* Clear the mouse hightlight in window W, if there is any. */
1897 void (*clear_mouse_face
) P_ ((struct window
*w
));
1899 /* Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
1901 void (*get_glyph_overhangs
) P_ ((struct glyph
*glyph
, struct frame
*f
,
1902 int *left
, int *right
));
1904 /* Fix the display of AREA of ROW in window W for overlapping rows.
1905 This function is called from redraw_overlapping_rows after
1906 desired rows have been made current. */
1907 void (*fix_overlapping_area
) P_ ((struct window
*w
, struct glyph_row
*row
,
1908 enum glyph_row_area area
));
1911 /* The current interface for window-based redisplay. */
1913 extern struct redisplay_interface
*rif
;
1915 /* Hook to call in estimate_mode_line_height. */
1917 extern int (* estimate_mode_line_height_hook
) P_ ((struct frame
*,
1921 /***********************************************************************
1923 ***********************************************************************/
1925 #ifdef HAVE_WINDOW_SYSTEM
1927 /* Structure forward declarations. */
1932 /* Each image format (JPEG, IIFF, ...) supported is described by
1933 a structure of the type below. */
1937 /* A symbol uniquely identifying the image type, .e.g `jpeg'. */
1940 /* Check that SPEC is a valid image specification for the given
1941 image type. Value is non-zero if SPEC is valid. */
1942 int (* valid_p
) P_ ((Lisp_Object spec
));
1944 /* Load IMG which is used on frame F from information contained in
1945 IMG->spec. Value is non-zero if successful. */
1946 int (* load
) P_ ((struct frame
*f
, struct image
*img
));
1948 /* Free resources of image IMG which is used on frame F. */
1949 void (* free
) P_ ((struct frame
*f
, struct image
*img
));
1951 /* Next in list of all supported image types. */
1952 struct image_type
*next
;
1956 /* Structure describing an image. Specific image formats like XBM are
1957 converted into this form, so that display only has to deal with
1958 this type of image. */
1962 /* The time in seconds at which the image was last displayed. Set
1963 in prepare_image_for_display. */
1964 unsigned long timestamp
;
1966 /* Pixmaps of the image. */
1967 Pixmap pixmap
, mask
;
1969 /* Colors allocated for this image, if any. Allocated via xmalloc. */
1970 unsigned long *colors
;
1973 /* Width and height of the image. */
1976 /* These values are used for the rectangles displayed for images
1977 that can't be loaded. */
1978 #define DEFAULT_IMAGE_WIDTH 30
1979 #define DEFAULT_IMAGE_HEIGHT 30
1981 /* Percent of image height used as ascent. A value of
1982 CENTERED_IMAGE_ASCENT means draw center the image centered on the
1985 #define DEFAULT_IMAGE_ASCENT 50
1986 #define CENTERED_IMAGE_ASCENT -1
1988 /* Lisp specification of this image. */
1991 /* Relief to draw around the image. */
1994 /* Optional margins around the image. This includes the relief. */
1995 int hmargin
, vmargin
;
1997 /* Reference to the type of the image. */
1998 struct image_type
*type
;
2000 /* 1 means that loading the image failed. Don't try again. */
2001 unsigned load_failed_p
;
2003 /* A place for image types to store additional data. The member
2004 data.lisp_val is marked during GC, so it's safe to store Lisp data
2005 there. Image types should free this data when their `free'
2006 function is called. */
2011 Lisp_Object lisp_val
;
2014 /* Hash value of image specification to speed up comparisons. */
2017 /* Image id of this image. */
2020 /* Hash collision chain. */
2021 struct image
*next
, *prev
;
2025 /* Cache of images. Each frame has a cache. X frames with the same
2026 x_display_info share their caches. */
2030 /* Hash table of images. */
2031 struct image
**buckets
;
2033 /* Vector mapping image ids to images. */
2034 struct image
**images
;
2036 /* Allocated size of `images'. */
2039 /* Number of images in the cache. */
2042 /* Reference count (number of frames sharing this cache). */
2047 /* Value is a pointer to the image with id ID on frame F, or null if
2048 no image with that id exists. */
2050 #define IMAGE_FROM_ID(F, ID) \
2051 (((ID) >= 0 && (ID) < (FRAME_X_IMAGE_CACHE (F)->used)) \
2052 ? FRAME_X_IMAGE_CACHE (F)->images[ID] \
2055 /* Size of bucket vector of image caches. Should be prime. */
2057 #define IMAGE_CACHE_BUCKETS_SIZE 1001
2059 #endif /* HAVE_WINDOW_SYSTEM */
2063 /***********************************************************************
2065 ***********************************************************************/
2067 /* Enumeration defining where to find tool-bar item information in
2068 tool-bar items vectors stored with frames. Each tool-bar item
2069 occupies TOOL_BAR_ITEM_NSLOTS elements in such a vector. */
2071 enum tool_bar_item_idx
2073 /* The key of the tool-bar item. Used to remove items when a binding
2074 for `undefined' is found. */
2077 /* Non-nil if item is enabled. */
2078 TOOL_BAR_ITEM_ENABLED_P
,
2080 /* Non-nil if item is selected (pressed). */
2081 TOOL_BAR_ITEM_SELECTED_P
,
2084 TOOL_BAR_ITEM_CAPTION
,
2086 /* Image(s) to display. This is either a single image specification
2087 or a vector of specifications. */
2088 TOOL_BAR_ITEM_IMAGES
,
2091 TOOL_BAR_ITEM_BINDING
,
2093 /* Button type. One of nil, `:radio' or `:toggle'. */
2099 /* Sentinel = number of slots in tool_bar_items occupied by one
2101 TOOL_BAR_ITEM_NSLOTS
2105 /* An enumeration for the different images that can be specified
2106 for a tool-bar item. */
2108 enum tool_bar_item_image
2110 TOOL_BAR_IMAGE_ENABLED_SELECTED
,
2111 TOOL_BAR_IMAGE_ENABLED_DESELECTED
,
2112 TOOL_BAR_IMAGE_DISABLED_SELECTED
,
2113 TOOL_BAR_IMAGE_DISABLED_DESELECTED
2116 /* Non-zero means raise tool-bar buttons when the mouse moves over them. */
2118 extern int auto_raise_tool_bar_buttons_p
;
2120 /* Margin around tool-bar buttons in pixels. */
2122 extern Lisp_Object Vtool_bar_button_margin
;
2124 /* Thickness of relief to draw around tool-bar buttons. */
2126 extern int tool_bar_button_relief
;
2128 /* Default values of the above variables. */
2130 #define DEFAULT_TOOL_BAR_BUTTON_MARGIN 1
2131 #define DEFAULT_TOOL_BAR_BUTTON_RELIEF 3
2133 /* The height in pixels of the default tool-bar images. */
2135 #define DEFAULT_TOOL_BAR_IMAGE_HEIGHT 24
2138 /***********************************************************************
2140 ***********************************************************************/
2142 /* Defined in xdisp.c */
2144 int display_prop_intangible_p
P_ ((Lisp_Object
));
2145 void resize_echo_area_axactly
P_ ((void));
2146 int resize_mini_window
P_ ((struct window
*, int));
2147 int try_window
P_ ((Lisp_Object
, struct text_pos
));
2148 void window_box
P_ ((struct window
*, int, int *, int *, int *, int *));
2149 int window_box_height
P_ ((struct window
*));
2150 int window_text_bottom_y
P_ ((struct window
*));
2151 int window_box_width
P_ ((struct window
*, int));
2152 int window_box_left
P_ ((struct window
*, int));
2153 int window_box_right
P_ ((struct window
*, int));
2154 void window_box_edges
P_ ((struct window
*, int, int *, int *, int *, int *));
2155 void mark_window_display_accurate
P_ ((Lisp_Object
, int));
2156 void redisplay_preserve_echo_area
P_ ((int));
2157 void set_cursor_from_row
P_ ((struct window
*, struct glyph_row
*,
2158 struct glyph_matrix
*, int, int, int, int));
2159 void init_iterator
P_ ((struct it
*, struct window
*, int,
2160 int, struct glyph_row
*, enum face_id
));
2161 void init_iterator_to_row_start
P_ ((struct it
*, struct window
*,
2162 struct glyph_row
*));
2163 int get_next_display_element
P_ ((struct it
*));
2164 void set_iterator_to_next
P_ ((struct it
*, int));
2165 void produce_glyphs
P_ ((struct it
*));
2166 void produce_special_glyphs
P_ ((struct it
*, enum display_element_type
));
2167 void start_display
P_ ((struct it
*, struct window
*, struct text_pos
));
2168 void move_it_to
P_ ((struct it
*, int, int, int, int, int));
2169 void move_it_vertically
P_ ((struct it
*, int));
2170 void move_it_vertically_backward
P_ ((struct it
*, int));
2171 void move_it_by_lines
P_ ((struct it
*, int, int));
2172 void move_it_past_eol
P_ ((struct it
*));
2173 int frame_mode_line_height
P_ ((struct frame
*));
2174 void highlight_trailing_whitespace
P_ ((struct frame
*, struct glyph_row
*));
2175 int tool_bar_item_info
P_ ((struct frame
*, struct glyph
*, int *));
2176 extern Lisp_Object Qtool_bar
;
2177 extern Lisp_Object Vshow_trailing_whitespace
;
2178 extern int redisplaying_p
;
2179 extern Lisp_Object Vimage_types
;
2180 extern void add_to_log
P_ ((char *, Lisp_Object
, Lisp_Object
));
2181 extern int help_echo_showing_p
;
2182 extern int current_mode_line_height
, current_header_line_height
;
2183 extern int cursor_in_non_selected_windows
;
2185 /* Defined in sysdep.c */
2187 void get_frame_size
P_ ((int *, int *));
2188 void request_sigio
P_ ((void));
2189 void unrequest_sigio
P_ ((void));
2190 int tabs_safe_p
P_ ((void));
2191 void init_baud_rate
P_ ((void));
2192 void init_sigio
P_ ((int));
2194 /* Defined in xfaces.c */
2196 #ifdef USE_X_TOOLKIT
2197 void x_set_menu_resources_from_menu_face
P_ ((struct frame
*, Widget
));
2199 #ifdef HAVE_X_WINDOWS
2200 void x_free_colors
P_ ((struct frame
*, unsigned long *, int));
2203 void update_face_from_frame_parameter
P_ ((struct frame
*, Lisp_Object
,
2205 Lisp_Object tty_color_name
P_ ((struct frame
*, int));
2206 void clear_face_cache
P_ ((int));
2207 unsigned long load_color
P_ ((struct frame
*, struct face
*, Lisp_Object
,
2208 enum lface_attribute_index
));
2209 void unload_color
P_ ((struct frame
*, unsigned long));
2210 int frame_update_line_height
P_ ((struct frame
*));
2211 int ascii_face_of_lisp_face
P_ ((struct frame
*, int));
2212 void prepare_face_for_display
P_ ((struct frame
*, struct face
*));
2213 int xstricmp
P_ ((unsigned char *, unsigned char *));
2214 int lookup_face
P_ ((struct frame
*, Lisp_Object
*, int, struct face
*));
2215 int lookup_named_face
P_ ((struct frame
*, Lisp_Object
, int));
2216 int smaller_face
P_ ((struct frame
*, int, int));
2217 int face_with_height
P_ ((struct frame
*, int, int));
2218 int lookup_derived_face
P_ ((struct frame
*, Lisp_Object
, int, int));
2219 void init_frame_faces
P_ ((struct frame
*));
2220 void free_frame_faces
P_ ((struct frame
*));
2221 void recompute_basic_faces
P_ ((struct frame
*));
2222 int face_at_buffer_position
P_ ((struct window
*, int, int, int, int *,
2224 int face_at_string_position
P_ ((struct window
*, Lisp_Object
,
2225 int, int, int, int, int *, enum face_id
));
2226 int compute_char_face
P_ ((struct frame
*, int, Lisp_Object
));
2227 void free_all_realized_faces
P_ ((Lisp_Object
));
2228 extern Lisp_Object Qforeground_color
, Qbackground_color
;
2229 extern char unspecified_fg
[], unspecified_bg
[];
2230 void free_realized_multibyte_face
P_ ((struct frame
*, int));
2232 /* Defined in xfns.c */
2234 #ifdef HAVE_X_WINDOWS
2235 void gamma_correct
P_ ((struct frame
*, XColor
*));
2238 void gamma_correct
P_ ((struct frame
*, COLORREF
*));
2241 #ifdef HAVE_WINDOW_SYSTEM
2243 void x_kill_gs_process
P_ ((Pixmap
, struct frame
*));
2244 int x_screen_planes
P_ ((struct frame
*));
2245 void x_implicitly_set_name
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
2246 struct image_cache
*make_image_cache
P_ ((void));
2247 void free_image_cache
P_ ((struct frame
*));
2248 void clear_image_cache
P_ ((struct frame
*, int));
2249 void forall_images_in_image_cache
P_ ((struct frame
*,
2250 void (*) P_ ((struct image
*))));
2251 int valid_image_p
P_ ((Lisp_Object
));
2252 void prepare_image_for_display
P_ ((struct frame
*, struct image
*));
2253 int lookup_image
P_ ((struct frame
*, Lisp_Object
));
2254 extern Lisp_Object tip_frame
;
2255 extern Window tip_window
;
2256 EXFUN (Fx_show_tip
, 6);
2257 EXFUN (Fx_hide_tip
, 0);
2258 extern void start_busy_cursor
P_ ((void));
2259 extern void cancel_busy_cursor
P_ ((void));
2260 extern int display_busy_cursor_p
;
2262 #endif /* HAVE_WINDOW_SYSTEM */
2265 /* Defined in xmenu.c */
2267 int popup_activated
P_ ((void));
2269 /* Defined in dispnew.c */
2271 int estimate_mode_line_height
P_ ((struct frame
*, enum face_id
));
2272 Lisp_Object mode_line_string
P_ ((struct window
*, int, int, int, int *));
2273 extern void redraw_frame
P_ ((struct frame
*));
2274 extern void redraw_garbaged_frames
P_ ((void));
2275 extern void cancel_line
P_ ((int, struct frame
*));
2276 extern void init_desired_glyphs
P_ ((struct frame
*));
2277 extern int scroll_frame_lines
P_ ((struct frame
*, int, int, int, int));
2278 extern int direct_output_for_insert
P_ ((int));
2279 extern int direct_output_forward_char
P_ ((int));
2280 extern int update_frame
P_ ((struct frame
*, int, int));
2281 extern int scrolling
P_ ((struct frame
*));
2282 extern void bitch_at_user
P_ ((void));
2283 void adjust_glyphs
P_ ((struct frame
*));
2284 void free_glyphs
P_ ((struct frame
*));
2285 void free_window_matrices
P_ ((struct window
*));
2286 void check_glyph_memory
P_ ((void));
2287 void mirrored_line_dance
P_ ((struct glyph_matrix
*, int, int, int *, char *));
2288 void clear_glyph_matrix
P_ ((struct glyph_matrix
*));
2289 void clear_current_matrices
P_ ((struct frame
*f
));
2290 void clear_desired_matrices
P_ ((struct frame
*));
2291 void shift_glyph_matrix
P_ ((struct window
*, struct glyph_matrix
*,
2293 void rotate_matrix
P_ ((struct glyph_matrix
*, int, int, int));
2294 void increment_matrix_positions
P_ ((struct glyph_matrix
*,
2295 int, int, int, int));
2296 void blank_row
P_ ((struct window
*, struct glyph_row
*, int));
2297 void increment_row_positions
P_ ((struct glyph_row
*, int, int));
2298 void enable_glyph_matrix_rows
P_ ((struct glyph_matrix
*, int, int, int));
2299 void clear_glyph_row
P_ ((struct glyph_row
*));
2300 void prepare_desired_row
P_ ((struct glyph_row
*));
2301 int line_hash_code
P_ ((struct glyph_row
*));
2302 void set_window_update_flags
P_ ((struct window
*, int));
2303 void write_glyphs
P_ ((struct glyph
*, int));
2304 void insert_glyphs
P_ ((struct glyph
*, int));
2305 void redraw_frame
P_ ((struct frame
*));
2306 void redraw_garbaged_frames
P_ ((void));
2307 int scroll_cost
P_ ((struct frame
*, int, int, int));
2308 int direct_output_for_insert
P_ ((int));
2309 int direct_output_forward_char
P_ ((int));
2310 int update_frame
P_ ((struct frame
*, int, int));
2311 void update_single_window
P_ ((struct window
*, int));
2312 int scrolling
P_ ((struct frame
*));
2313 int buffer_posn_from_coords
P_ ((struct window
*, int *, int *));
2314 void do_pending_window_change
P_ ((int));
2315 void change_frame_size
P_ ((struct frame
*, int, int, int, int, int));
2316 void bitch_at_user
P_ ((void));
2317 Lisp_Object sit_for
P_ ((int, int, int, int, int));
2318 void init_display
P_ ((void));
2319 void syms_of_display
P_ ((void));
2320 extern Lisp_Object Qredisplay_dont_pause
;
2322 /* Defined in term.c */
2324 extern void ring_bell
P_ ((void));
2325 extern void set_terminal_modes
P_ ((void));
2326 extern void reset_terminal_modes
P_ ((void));
2327 extern void update_begin
P_ ((struct frame
*));
2328 extern void update_end
P_ ((struct frame
*));
2329 extern void set_terminal_window
P_ ((int));
2330 extern void set_scroll_region
P_ ((int, int));
2331 extern void turn_off_insert
P_ ((void));
2332 extern void turn_off_highlight
P_ ((void));
2333 extern void background_highlight
P_ ((void));
2334 extern void reassert_line_highlight
P_ ((int, int));
2335 extern void clear_frame
P_ ((void));
2336 extern void clear_end_of_line
P_ ((int));
2337 extern void clear_end_of_line_raw
P_ ((int));
2338 extern void delete_glyphs
P_ ((int));
2339 extern void ins_del_lines
P_ ((int, int));
2340 extern int string_cost
P_ ((char *));
2341 extern int per_line_cost
P_ ((char *));
2342 extern void calculate_costs
P_ ((struct frame
*));
2343 extern void term_init
P_ ((char *));
2344 extern void fatal
P_ ((/* char *, ... */));
2345 void cursor_to
P_ ((int, int));
2346 void change_line_highlight
P_ ((int, int, int, int));
2348 /* Defined in scroll.c */
2350 extern int scrolling_max_lines_saved
P_ ((int, int, int *, int *, int *));
2351 extern int scroll_cost
P_ ((struct frame
*, int, int, int));
2352 extern void do_line_insertion_deletion_costs
P_ ((struct frame
*, char *,
2353 char *, char *, char *,
2354 char *, char *, int));
2355 void scrolling_1
P_ ((struct frame
*, int, int, int, int *, int *, int *,
2358 #endif /* not DISPEXTERN_H_INCLUDED */