1 /* Interface definitions for display code.
2 Copyright (C) 1985, 1993, 1994, 1997, 1998, 1999, 2000, 2001, 2002, 2003
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>. */
24 #ifndef DISPEXTERN_H_INCLUDED
25 #define DISPEXTERN_H_INCLUDED
31 #include <X11/Intrinsic.h>
32 #endif /* USE_X_TOOLKIT */
34 #else /* !HAVE_X_WINDOWS */
36 /* X-related stuff used by non-X gui code. */
40 unsigned short red
, green
, blue
;
45 #endif /* HAVE_X_WINDOWS */
52 typedef struct x_display_info Display_Info
;
53 #define NativeRectangle XRectangle
58 typedef struct w32_display_info Display_Info
;
63 typedef struct mac_display_info Display_Info
;
67 /* Structure forward declarations. Some are here because function
68 prototypes below reference structure types before their definition
69 in this file. Some are here because not every file including
70 dispextern.h also includes frame.h and windows.h. */
80 /* Values returned from coordinates_in_window. */
97 /***********************************************************************
99 ***********************************************************************/
101 /* If GLYPH_DEBUG is non-zero, additional checks are activated. Turn
102 it off by defining the macro GLYPH_DEBUG to zero. */
105 #define GLYPH_DEBUG 0
108 /* Macros to include code only if GLYPH_DEBUG != 0. */
111 #define IF_DEBUG(X) X
112 #define xassert(X) do {if (!(X)) abort ();} while (0)
114 #define IF_DEBUG(X) (void) 0
115 #define xassert(X) (void) 0
118 /* Macro for displaying traces of redisplay. If Emacs was compiled
119 with GLYPH_DEBUG != 0, the variable trace_redisplay_p can be set to
120 a non-zero value in debugging sessions to activate traces. */
124 extern int trace_redisplay_p
;
128 if (trace_redisplay_p) \
133 #else /* GLYPH_DEBUG == 0 */
135 #define TRACE(X) (void) 0
137 #endif /* GLYPH_DEBUG == 0 */
141 /***********************************************************************
143 ***********************************************************************/
145 /* Starting with Emacs 20.3, characters from strings and buffers have
146 both a character and a byte position associated with them. The
147 following structure holds such a pair of positions. */
151 /* Character position. */
154 /* Corresponding byte position. */
158 /* Access character and byte position of POS in a functional form. */
160 #define BYTEPOS(POS) (POS).bytepos
161 #define CHARPOS(POS) (POS).charpos
163 /* Set character position of POS to CHARPOS, byte position to BYTEPOS. */
165 #define SET_TEXT_POS(POS, CHARPOS, BYTEPOS) \
166 ((POS).charpos = (CHARPOS), (POS).bytepos = BYTEPOS)
168 /* Increment text position POS. */
170 #define INC_TEXT_POS(POS, MULTIBYTE_P) \
175 INC_POS ((POS).bytepos); \
181 /* Decrement text position POS. */
183 #define DEC_TEXT_POS(POS, MULTIBYTE_P) \
188 DEC_POS ((POS).bytepos); \
194 /* Set text position POS from marker MARKER. */
196 #define SET_TEXT_POS_FROM_MARKER(POS, MARKER) \
197 (CHARPOS (POS) = marker_position ((MARKER)), \
198 BYTEPOS (POS) = marker_byte_position ((MARKER)))
200 /* Set marker MARKER from text position POS. */
202 #define SET_MARKER_FROM_TEXT_POS(MARKER, POS) \
203 set_marker_both ((MARKER), Qnil, CHARPOS ((POS)), BYTEPOS ((POS)))
205 /* Value is non-zero if character and byte positions of POS1 and POS2
208 #define TEXT_POS_EQUAL_P(POS1, POS2) \
209 ((POS1).charpos == (POS2).charpos \
210 && (POS1).bytepos == (POS2).bytepos)
212 /* When rendering glyphs, redisplay scans string or buffer text,
213 overlay strings in that text, and does display table or control
214 character translations. The following structure captures a
215 position taking all this into account. */
219 /* Buffer or string position. */
222 /* If this is a position in an overlay string, overlay_string_index
223 is the index of that overlay string in the sequence of overlay
224 strings at `pos' in the order redisplay processes them. A value
225 < 0 means that this is not a position in an overlay string. */
226 int overlay_string_index
;
228 /* If this is a position in an overlay string, string_pos is the
229 position within that string. */
230 struct text_pos string_pos
;
232 /* If the character at the position above is a control character or
233 has a display table entry, dpvec_index is an index in the display
234 table or control character translation of that character. A
235 value < 0 means this is not a position in such a translation. */
241 /***********************************************************************
243 ***********************************************************************/
245 /* Enumeration of glyph types. Glyph structures contain a type field
246 containing one of the enumerators defined here. */
250 /* Glyph describes a character. */
253 /* Glyph describes a composition sequence. */
256 /* Glyph describes an image. */
259 /* Glyph is a space of fractional width and/or height. */
266 Be extra careful when changing this structure! Esp. make sure that
267 functions producing glyphs, like append_glyph, fill ALL of the
268 glyph structure, and that GLYPH_EQUAL_P compares all
269 display-relevant members of glyphs (not to imply that these are the
270 only things to check when you add a member). */
274 /* Position from which this glyph was drawn. If `object' below is a
275 Lisp string, this is a position in that string. If it is a
276 buffer, this is a position in that buffer. A value of -1
277 together with a null object means glyph is a truncation glyph at
278 the start of a row. */
281 /* Lisp object source of this glyph. Currently either a buffer or
282 a string, if the glyph was produced from characters which came from
283 a buffer or a string; or 0 if the glyph was inserted by redisplay
284 for its own purposes such as padding. */
287 /* Width in pixels. */
290 /* Vertical offset. If < 0, the glyph is displayed raised, if > 0
291 the glyph is displayed lowered. */
294 /* Which kind of glyph this is---character, image etc. Value
295 should be an enumerator of type enum glyph_type. */
298 /* 1 means this glyph was produced from multibyte text. Zero
299 means it was produced from unibyte text, i.e. charsets aren't
300 applicable, and encoding is not performed. */
301 unsigned multibyte_p
: 1;
303 /* Non-zero means draw a box line at the left or right side of this
304 glyph. This is part of the implementation of the face attribute
306 unsigned left_box_line_p
: 1;
307 unsigned right_box_line_p
: 1;
309 /* Non-zero means this glyph's physical ascent or descent is greater
310 than its logical ascent/descent, i.e. it may potentially overlap
311 glyphs above or below it. */
312 unsigned overlaps_vertically_p
: 1;
314 /* 1 means glyph is a padding glyph. Padding glyphs are used for
315 characters whose visual shape consists of more than one glyph
316 (e.g. Asian characters). All but the first glyph of such a glyph
317 sequence have the padding_p flag set. Only used for terminal
318 frames, and there only to minimize code changes. A better way
319 would probably be to use the width field of glyphs to express
321 unsigned padding_p
: 1;
323 /* 1 means the actual glyph is not available, draw a box instead.
324 This can happen when a font couldn't be loaded, or a character
325 doesn't have a glyph in a font. */
326 unsigned glyph_not_available_p
: 1;
328 /* Face of the glyph. */
329 unsigned face_id
: 21;
331 /* Type of font used to display the character glyph. May be used to
332 determine which set of functions to use to obtain font metrics
333 for the glyph. On W32, value should be an enumerator of the type
334 w32_char_font_type. Otherwise it equals FONT_TYPE_UNKNOWN. */
335 unsigned font_type
: 3;
337 /* A union of sub-structures for different glyph types. */
340 /* Character code for character glyphs (type == CHAR_GLYPH). */
343 /* Composition ID for composition glyphs (type == COMPOSITION_GLYPH) */
346 /* Image ID for image glyphs (type == IMAGE_GLYPH). */
349 /* Sub-structure for type == STRETCH_GLYPH. */
352 /* The height of the glyph. */
353 unsigned height
: 16;
355 /* The ascent of the glyph. */
356 unsigned ascent
: 16;
360 /* Used to compare all bit-fields above in one step. */
366 /* Default value of the glyph font_type field. */
368 #define FONT_TYPE_UNKNOWN 0
370 /* Is GLYPH a space? */
372 #define CHAR_GLYPH_SPACE_P(GLYPH) \
373 (GLYPH_FROM_CHAR_GLYPH ((GLYPH)) == SPACEGLYPH)
375 /* Are glyphs *X and *Y displayed equal? */
377 #define GLYPH_EQUAL_P(X, Y) \
378 ((X)->type == (Y)->type \
379 && (X)->u.val == (Y)->u.val \
380 && (X)->face_id == (Y)->face_id \
381 && (X)->padding_p == (Y)->padding_p \
382 && (X)->left_box_line_p == (Y)->left_box_line_p \
383 && (X)->right_box_line_p == (Y)->right_box_line_p \
384 && (X)->voffset == (Y)->voffset \
385 && (X)->pixel_width == (Y)->pixel_width)
387 /* Are character codes, faces, padding_ps of glyphs *X and *Y equal? */
389 #define GLYPH_CHAR_AND_FACE_EQUAL_P(X, Y) \
390 ((X)->u.ch == (Y)->u.ch \
391 && (X)->face_id == (Y)->face_id \
392 && (X)->padding_p == (Y)->padding_p)
394 /* Fill a character glyph GLYPH. CODE, FACE_ID, PADDING_P correspond
395 to the bits defined for the typedef `GLYPH' in lisp.h. */
397 #define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P) \
400 (GLYPH).u.ch = (CODE); \
401 (GLYPH).face_id = (FACE_ID); \
402 (GLYPH).padding_p = (PADDING_P); \
406 /* Fill a character type glyph GLYPH from a glyph typedef FROM as
407 defined in lisp.h. */
409 #define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM) \
410 SET_CHAR_GLYPH ((GLYPH), \
411 FAST_GLYPH_CHAR ((FROM)), \
412 FAST_GLYPH_FACE ((FROM)), \
415 /* Construct a glyph code from a character glyph GLYPH. If the
416 character is multibyte, return -1 as we can't use glyph table for a
417 multibyte character. */
419 #define GLYPH_FROM_CHAR_GLYPH(GLYPH) \
420 ((GLYPH).u.ch < 256 \
421 ? ((GLYPH).u.ch | ((GLYPH).face_id << CHARACTERBITS)) \
424 /* Is GLYPH a padding glyph? */
426 #define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p
431 /***********************************************************************
433 ***********************************************************************/
437 Glyph memory for frame-based redisplay is allocated from the heap
438 in one vector kept in a glyph pool structure which is stored with
439 the frame. The size of the vector is made large enough to cover
440 all windows on the frame.
442 Both frame and window glyph matrices reference memory from a glyph
443 pool in frame-based redisplay.
445 In window-based redisplay, no glyphs pools exist; windows allocate
446 and free their glyph memory themselves. */
450 /* Vector of glyphs allocated from the heap. */
451 struct glyph
*glyphs
;
453 /* Allocated size of `glyphs'. */
456 /* Number of rows and columns in a matrix. */
462 /***********************************************************************
464 ***********************************************************************/
468 Three kinds of glyph matrices exist:
470 1. Frame glyph matrices. These are used for terminal frames whose
471 redisplay needs a view of the whole screen due to limited terminal
472 capabilities. Frame matrices are used only in the update phase
473 of redisplay. They are built in update_frame and not used after
474 the update has been performed.
476 2. Window glyph matrices on frames having frame glyph matrices.
477 Such matrices are sub-matrices of their corresponding frame matrix,
478 i.e. frame glyph matrices and window glyph matrices share the same
479 glyph memory which is allocated in form of a glyph_pool structure.
480 Glyph rows in such a window matrix are slices of frame matrix rows.
482 2. Free-standing window glyph matrices managing their own glyph
483 storage. This form is used in window-based redisplay which
484 includes variable width and height fonts etc.
486 The size of a window's row vector depends on the height of fonts
487 defined on its frame. It is chosen so that the vector is large
488 enough to describe all lines in a window when it is displayed in
489 the smallest possible character size. When new fonts are loaded,
490 or window sizes change, the row vector is adjusted accordingly. */
494 /* The pool from which glyph memory is allocated, if any. This is
495 null for frame matrices and for window matrices managing their
497 struct glyph_pool
*pool
;
499 /* Vector of glyph row structures. The row at nrows - 1 is reserved
500 for the mode line. */
501 struct glyph_row
*rows
;
503 /* Number of elements allocated for the vector rows above. */
506 /* The number of rows used by the window if all lines were displayed
507 with the smallest possible character height. */
510 /* Origin within the frame matrix if this is a window matrix on a
511 frame having a frame matrix. Both values are zero for
512 window-based redisplay. */
513 int matrix_x
, matrix_y
;
515 /* Width and height of the matrix in columns and rows. */
516 int matrix_w
, matrix_h
;
518 /* If this structure describes a window matrix of window W,
519 window_left_x is the value of W->left, window_top_y the value of
520 W->top, window_height and window_width are width and height of W,
521 as returned by window_box, and window_vscroll is the value of
522 W->vscroll at the time the matrix was last adjusted. Only set
523 for window-based redisplay. */
524 int window_left_x
, window_top_y
, window_height
, window_width
, window_vscroll
;
526 /* Number of glyphs reserved for left and right marginal areas when
527 the matrix was last adjusted. */
528 int left_margin_glyphs
, right_margin_glyphs
;
530 /* Flag indicating that scrolling should not be tried in
531 update_window. This flag is set by functions like try_window_id
532 which do their own scrolling. */
533 unsigned no_scrolling_p
: 1;
535 /* Non-zero means window displayed in this matrix has a top mode
537 unsigned header_line_p
: 1;
540 /* A string identifying the method used to display the matrix. */
544 /* The buffer this matrix displays. Set in
545 mark_window_display_accurate_1. */
546 struct buffer
*buffer
;
548 /* Values of BEGV and ZV as of last redisplay. Set in
549 mark_window_display_accurate_1. */
554 /* Check that glyph pointers stored in glyph rows of MATRIX are okay.
555 This aborts if any pointer is found twice. */
558 void check_matrix_pointer_lossage
P_ ((struct glyph_matrix
*));
559 #define CHECK_MATRIX(MATRIX) check_matrix_pointer_lossage ((MATRIX))
561 #define CHECK_MATRIX(MATRIX) (void) 0
566 /***********************************************************************
568 ***********************************************************************/
570 /* Area in window glyph matrix. If values are added or removed, the
571 function mark_object in alloc.c has to be changed. */
582 /* Rows of glyphs in a windows or frame glyph matrix.
584 Each row is partitioned into three areas. The start and end of
585 each area is recorded in a pointer as shown below.
587 +--------------------+-------------+---------------------+
588 | left margin area | text area | right margin area |
589 +--------------------+-------------+---------------------+
591 glyphs[LEFT_MARGIN_AREA] glyphs[RIGHT_MARGIN_AREA]
596 Rows in frame matrices reference glyph memory allocated in a frame
597 glyph pool (see the description of struct glyph_pool). Rows in
598 window matrices on frames having frame matrices reference slices of
599 the glyphs of corresponding rows in the frame matrix.
601 Rows in window matrices on frames having no frame matrices point to
602 glyphs allocated from the heap via xmalloc;
603 glyphs[LEFT_MARGIN_AREA] is the start address of the allocated
604 glyph structure array. */
608 /* Pointers to beginnings of areas. The end of an area A is found at
609 A + 1 in the vector. The last element of the vector is the end
612 Kludge alert: Even if used[TEXT_AREA] == 0, glyphs[TEXT_AREA][0]'s
613 position field is used. It is -1 if this row does not correspond
614 to any text; it is some buffer position if the row corresponds to
615 an empty display line that displays a line end. This is what old
616 redisplay used to do. (Except in code for terminal frames, this
617 kludge is no longer used, I believe. --gerd).
619 See also start, end, displays_text_p and ends_at_zv_p for cleaner
620 ways to do it. The special meaning of positions 0 and -1 will be
621 removed some day, so don't use it in new code. */
622 struct glyph
*glyphs
[1 + LAST_AREA
];
624 /* Number of glyphs actually filled in areas. */
625 short used
[LAST_AREA
];
627 /* Window-relative x and y-position of the top-left corner of this
628 row. If y < 0, this means that abs (y) pixels of the row are
629 invisible because it is partially visible at the top of a window.
630 If x < 0, this means that abs (x) pixels of the first glyph of
631 the text area of the row are invisible because the glyph is
632 partially visible. */
635 /* Width of the row in pixels without taking face extension at the
636 end of the row into account, and without counting truncation
637 and continuation glyphs at the end of a row on ttys. */
640 /* Logical ascent/height of this line. The value of ascent is zero
641 and height is 1 on terminal frames. */
644 /* Physical ascent/height of this line. If max_ascent > ascent,
645 this line overlaps the line above it on the display. Otherwise,
646 if max_height > height, this line overlaps the line beneath it. */
647 int phys_ascent
, phys_height
;
649 /* Portion of row that is visible. Partially visible rows may be
650 found at the top and bottom of a window. This is 1 for tty
651 frames. It may be < 0 in case of completely invisible rows. */
654 /* Hash code. This hash code is available as soon as the row
655 is constructed, i.e. after a call to display_line. */
658 /* First position in this row. This is the text position, including
659 overlay position information etc, where the display of this row
660 started, and can thus be less the position of the first glyph
661 (e.g. due to invisible text or horizontal scrolling). */
662 struct display_pos start
;
664 /* Text position at the end of this row. This is the position after
665 the last glyph on this row. It can be greater than the last
666 glyph position + 1, due to truncation, invisible text etc. In an
667 up-to-date display, this should always be equal to the start
668 position of the next row. */
669 struct display_pos end
;
671 /* In a desired matrix, 1 means that this row must be updated. In a
672 current matrix, 0 means that the row has been invalidated, i.e.
673 the row's contents do not agree with what is visible on the
675 unsigned enabled_p
: 1;
677 /* 1 means row displays a text line that is truncated on the left or
679 unsigned truncated_on_left_p
: 1;
680 unsigned truncated_on_right_p
: 1;
682 /* 1 means the overlay arrow is on this line. */
683 unsigned overlay_arrow_p
: 1;
685 /* 1 means that this row displays a continued line, i.e. it has a
686 continuation mark at the right side. */
687 unsigned continued_p
: 1;
689 /* 0 means that this row does not contain any text, i.e. it is
690 a blank line at the window and buffer end. */
691 unsigned displays_text_p
: 1;
693 /* 1 means that this line ends at ZV. */
694 unsigned ends_at_zv_p
: 1;
696 /* 1 means the face of the last glyph in the text area is drawn to
697 the right end of the window. This flag is used in
698 update_text_area to optimize clearing to the end of the area. */
699 unsigned fill_line_p
: 1;
701 /* Non-zero means display a bitmap on X frames indicating that this
702 line contains no text and ends in ZV. */
703 unsigned indicate_empty_line_p
: 1;
705 /* 1 means this row contains glyphs that overlap each other because
706 of lbearing or rbearing. */
707 unsigned contains_overlapping_glyphs_p
: 1;
709 /* 1 means this row is as wide as the window it is displayed in, including
710 scroll bars, fringes, and internal borders. This also
711 implies that the row doesn't have marginal areas. */
712 unsigned full_width_p
: 1;
714 /* Non-zero means row is a mode or header-line. */
715 unsigned mode_line_p
: 1;
717 /* 1 in a current row means this row is overlapped by another row. */
718 unsigned overlapped_p
: 1;
720 /* 1 means this line ends in the middle of a character consisting
721 of more than one glyph. Some glyphs have been put in this row,
722 the rest are put in rows below this one. */
723 unsigned ends_in_middle_of_char_p
: 1;
725 /* 1 means this line starts in the middle of a character consisting
726 of more than one glyph. Some glyphs have been put in the
727 previous row, the rest are put in this row. */
728 unsigned starts_in_middle_of_char_p
: 1;
730 /* 1 in a current row means this row overlaps others. */
731 unsigned overlapping_p
: 1;
733 /* 1 means some glyphs in this row are displayed in mouse-face. */
734 unsigned mouse_face_p
: 1;
736 /* 1 means this row was ended by a newline from a string. */
737 unsigned ends_in_newline_from_string_p
: 1;
739 /* Continuation lines width at the start of the row. */
740 int continuation_lines_width
;
744 /* Get a pointer to row number ROW in matrix MATRIX. If GLYPH_DEBUG
745 is defined to a non-zero value, the function matrix_row checks that
746 we don't try to access rows that are out of bounds. */
749 struct glyph_row
*matrix_row
P_ ((struct glyph_matrix
*, int));
750 #define MATRIX_ROW(MATRIX, ROW) matrix_row ((MATRIX), (ROW))
752 #define MATRIX_ROW(MATRIX, ROW) ((MATRIX)->rows + (ROW))
755 /* Return a pointer to the row reserved for the mode line in MATRIX.
756 Row MATRIX->nrows - 1 is always reserved for the mode line. */
758 #define MATRIX_MODE_LINE_ROW(MATRIX) \
759 ((MATRIX)->rows + (MATRIX)->nrows - 1)
761 /* Return a pointer to the row reserved for the header line in MATRIX.
762 This is always the first row in MATRIX because that's the only
763 way that works in frame-based redisplay. */
765 #define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows
767 /* Return a pointer to first row in MATRIX used for text display. */
769 #define MATRIX_FIRST_TEXT_ROW(MATRIX) \
770 ((MATRIX)->rows->mode_line_p ? (MATRIX)->rows + 1 : (MATRIX)->rows)
772 /* Return a pointer to the first glyph in the text area of a row.
773 MATRIX is the glyph matrix accessed, and ROW is the row index in
776 #define MATRIX_ROW_GLYPH_START(MATRIX, ROW) \
777 (MATRIX_ROW ((MATRIX), (ROW))->glyphs[TEXT_AREA])
779 /* Return the number of used glyphs in the text area of a row. */
781 #define MATRIX_ROW_USED(MATRIX, ROW) \
782 (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA])
784 /* Return the character/ byte position at which the display of ROW
787 #define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->start.pos.charpos)
788 #define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->start.pos.bytepos)
790 /* Return the character/ byte position at which ROW ends. */
792 #define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->end.pos.charpos)
793 #define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->end.pos.bytepos)
795 /* Return the vertical position of ROW in MATRIX. */
797 #define MATRIX_ROW_VPOS(ROW, MATRIX) ((ROW) - (MATRIX)->rows)
799 /* Return the last glyph row + 1 in MATRIX on window W reserved for
800 text. If W has a mode line, the last row in the matrix is reserved
803 #define MATRIX_BOTTOM_TEXT_ROW(MATRIX, W) \
806 - (WINDOW_WANTS_MODELINE_P ((W)) ? 1 : 0))
808 /* Non-zero if the face of the last glyph in ROW's text area has
809 to be drawn to the end of the text area. */
811 #define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)
813 /* Set and query the enabled_p flag of glyph row ROW in MATRIX. */
815 #define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
816 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0)
818 #define MATRIX_ROW_ENABLED_P(MATRIX, ROW) \
819 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p)
821 /* Non-zero if ROW displays text. Value is non-zero if the row is
822 blank but displays a line end. */
824 #define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)
826 /* Non-zero if ROW is not completely visible in window W. */
828 #define MATRIX_ROW_PARTIALLY_VISIBLE_P(ROW) \
829 ((ROW)->height != (ROW)->visible_height)
831 /* Non-zero if ROW is partially visible at the top of window W. */
833 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW) \
834 (MATRIX_ROW_PARTIALLY_VISIBLE_P ((ROW)) \
835 && (ROW)->y < WINDOW_DISPLAY_HEADER_LINE_HEIGHT ((W)))
837 /* Non-zero if ROW is partially visible at the bottom of window W. */
839 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW) \
840 (MATRIX_ROW_PARTIALLY_VISIBLE_P ((ROW)) \
841 && (ROW)->y + (ROW)->height > WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE ((W)))
843 /* Return the bottom Y + 1 of ROW. */
845 #define MATRIX_ROW_BOTTOM_Y(ROW) ((ROW)->y + (ROW)->height)
847 /* Is ROW the last visible one in the display described by the
848 iterator structure pointed to by IT?. */
850 #define MATRIX_ROW_LAST_VISIBLE_P(ROW, IT) \
851 (MATRIX_ROW_BOTTOM_Y ((ROW)) >= (IT)->last_visible_y)
853 /* Non-zero if ROW displays a continuation line. */
855 #define MATRIX_ROW_CONTINUATION_LINE_P(ROW) \
856 ((ROW)->continuation_lines_width > 0)
858 /* Non-zero if ROW ends in the middle of a character. This is the
859 case for continued lines showing only part of a display table entry
860 or a control char, or an overlay string. */
862 #define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW) \
863 ((ROW)->end.dpvec_index >= 0 \
864 || (ROW)->end.overlay_string_index >= 0 \
865 || (ROW)->ends_in_middle_of_char_p)
867 /* Non-zero if ROW ends in the middle of an overlay string. */
869 #define MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P(ROW) \
870 ((ROW)->end.overlay_string_index >= 0)
872 /* Non-zero if ROW starts in the middle of a character. See above. */
874 #define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW) \
875 ((ROW)->start.dpvec_index >= 0 \
876 || (ROW)->starts_in_middle_of_char_p \
877 || ((ROW)->start.overlay_string_index >= 0 \
878 && (ROW)->start.string_pos.charpos > 0))
880 /* Non-zero means ROW overlaps its predecessor. */
882 #define MATRIX_ROW_OVERLAPS_PRED_P(ROW) \
883 ((ROW)->phys_ascent > (ROW)->ascent)
885 /* Non-zero means ROW overlaps its successor. */
887 #define MATRIX_ROW_OVERLAPS_SUCC_P(ROW) \
888 ((ROW)->phys_height - (ROW)->phys_ascent \
889 > (ROW)->height - (ROW)->ascent)
891 /* Non-zero means that fonts have been loaded since the last glyph
892 matrix adjustments. The function redisplay_internal adjusts glyph
893 matrices when this flag is non-zero. */
895 extern int fonts_changed_p
;
897 /* A glyph for a space. */
899 extern struct glyph space_glyph
;
901 /* Frame being updated by update_window/update_frame. */
903 extern struct frame
*updating_frame
;
905 /* Window being updated by update_window. This is non-null as long as
906 update_window has not finished, and null otherwise. It's role is
907 analogous to updating_frame. */
909 extern struct window
*updated_window
;
911 /* Glyph row and area updated by update_window_line. */
913 extern struct glyph_row
*updated_row
;
914 extern int updated_area
;
916 /* Non-zero means reading single-character input with prompt so put
917 cursor on mini-buffer after the prompt. Positive means at end of
918 text in echo area; negative means at beginning of line. */
920 extern int cursor_in_echo_area
;
922 /* Non-zero means last display completed. Zero means it was
925 extern int display_completed
;
927 /* Non-zero means redisplay has been performed directly (see also
928 direct_output_for_insert and direct_output_forward_char), so that
929 no further updating has to be performed. The function
930 redisplay_internal checks this flag, and does nothing but reset it
931 to zero if it is non-zero. */
933 extern int redisplay_performed_directly_p
;
935 /* A temporary storage area, including a row of glyphs. Initialized
936 in xdisp.c. Used for various purposes, as an example see
937 direct_output_for_insert. */
939 extern struct glyph_row scratch_glyph_row
;
943 /************************************************************************
945 ************************************************************************/
947 /* Enumeration for overriding/changing the face to use for drawing
948 glyphs in draw_glyphs. */
950 enum draw_glyphs_face
960 #ifdef HAVE_WINDOW_SYSTEM
962 /* A sequence of glyphs to be drawn in the same face. */
966 /* X-origin of the string. */
969 /* Y-origin and y-position of the base line of this string. */
972 /* The width of the string, not including a face extension. */
975 /* The width of the string, including a face extension. */
976 int background_width
;
978 /* The height of this string. This is the height of the line this
979 string is drawn in, and can be different from the height of the
980 font the string is drawn in. */
983 /* Number of pixels this string overwrites in front of its x-origin.
984 This number is zero if the string has an lbearing >= 0; it is
985 -lbearing, if the string has an lbearing < 0. */
988 /* Number of pixels this string overwrites past its right-most
989 nominal x-position, i.e. x + width. Zero if the string's
990 rbearing is <= its nominal width, rbearing - width otherwise. */
993 /* The frame on which the glyph string is drawn. */
996 /* The window on which the glyph string is drawn. */
999 /* X display and window for convenience. */
1003 /* The glyph row for which this string was built. It determines the
1004 y-origin and height of the string. */
1005 struct glyph_row
*row
;
1007 /* The area within row. */
1008 enum glyph_row_area area
;
1010 /* Characters to be drawn, and number of characters. */
1014 /* A face-override for drawing cursors, mouse face and similar. */
1015 enum draw_glyphs_face hl
;
1017 /* Face in which this string is to be drawn. */
1020 /* Font in which this string is to be drawn. */
1023 /* Font info for this string. */
1024 struct font_info
*font_info
;
1026 /* Non-null means this string describes (part of) a composition.
1027 All characters from char2b are drawn composed. */
1028 struct composition
*cmp
;
1030 /* Index of this glyph string's first character in the glyph
1031 definition of CMP. If this is zero, this glyph string describes
1032 the first character of a composition. */
1035 /* 1 means this glyph strings face has to be drawn to the right end
1036 of the window's drawing area. */
1037 unsigned extends_to_end_of_line_p
: 1;
1039 /* 1 means the background of this string has been drawn. */
1040 unsigned background_filled_p
: 1;
1042 /* 1 means glyph string must be drawn with 16-bit functions. */
1043 unsigned two_byte_p
: 1;
1045 /* 1 means that the original font determined for drawing this glyph
1046 string could not be loaded. The member `font' has been set to
1047 the frame's default font in this case. */
1048 unsigned font_not_found_p
: 1;
1050 /* 1 means that the face in which this glyph string is drawn has a
1052 unsigned stippled_p
: 1;
1054 /* 1 means only the foreground of this glyph string must be drawn,
1055 and we should use the physical height of the line this glyph
1056 string appears in as clip rect. */
1057 unsigned for_overlaps_p
: 1;
1059 /* The GC to use for drawing this glyph string. */
1060 #if defined(HAVE_X_WINDOWS) || defined(HAVE_CARBON)
1063 #if defined(HAVE_NTGUI)
1068 /* A pointer to the first glyph in the string. This glyph
1069 corresponds to char2b[0]. Needed to draw rectangles if
1070 font_not_found_p is 1. */
1071 struct glyph
*first_glyph
;
1073 /* Image, if any. */
1076 struct glyph_string
*next
, *prev
;
1079 #endif /* HAVE_WINDOW_SYSTEM */
1082 /************************************************************************
1084 ************************************************************************/
1086 /* Return the height of the mode line in glyph matrix MATRIX, or zero
1087 if not known. This macro is called under circumstances where
1088 MATRIX might not have been allocated yet. */
1090 #define MATRIX_MODE_LINE_HEIGHT(MATRIX) \
1091 ((MATRIX) && (MATRIX)->rows \
1092 ? MATRIX_MODE_LINE_ROW (MATRIX)->height \
1095 /* Return the height of the header line in glyph matrix MATRIX, or zero
1096 if not known. This macro is called under circumstances where
1097 MATRIX might not have been allocated yet. */
1099 #define MATRIX_HEADER_LINE_HEIGHT(MATRIX) \
1100 ((MATRIX) && (MATRIX)->rows \
1101 ? MATRIX_HEADER_LINE_ROW (MATRIX)->height \
1104 /* Return the desired face id for the mode line of a window, depending
1105 on whether the window is selected or not, or if the window is the
1106 scrolling window for the currently active minibuffer window.
1108 Due to the way display_mode_lines manipulates with the contents of
1109 selected_window, this macro needs three arguments: SELW which is
1110 compared against the current value of selected_window, MBW which is
1111 compared against minibuf_window (if SELW doesn't match), and SCRW
1112 which is compared against minibuf_selected_window (if MBW matches). */
1114 #define CURRENT_MODE_LINE_FACE_ID_3(SELW, MBW, SCRW) \
1115 ((!mode_line_in_non_selected_windows \
1116 || (SELW) == XWINDOW (selected_window) \
1117 || (minibuf_level > 0 \
1118 && !NILP (minibuf_selected_window) \
1119 && (MBW) == XWINDOW (minibuf_window) \
1120 && (SCRW) == XWINDOW (minibuf_selected_window))) \
1121 ? MODE_LINE_FACE_ID \
1122 : MODE_LINE_INACTIVE_FACE_ID)
1125 /* Return the desired face id for the mode line of window W. */
1127 #define CURRENT_MODE_LINE_FACE_ID(W) \
1128 (CURRENT_MODE_LINE_FACE_ID_3((W), XWINDOW (selected_window), (W)))
1130 /* Return the current height of the mode line of window W. If not
1131 known from current_mode_line_height, look at W's current glyph
1132 matrix, or return a default based on the height of the font of the
1133 face `mode-line'. */
1135 #define CURRENT_MODE_LINE_HEIGHT(W) \
1136 (current_mode_line_height >= 0 \
1137 ? current_mode_line_height \
1138 : (MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1139 ? MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1140 : estimate_mode_line_height (XFRAME ((W)->frame), \
1141 CURRENT_MODE_LINE_FACE_ID (W))))
1143 /* Return the current height of the header line of window W. If not
1144 known from current_header_line_height, look at W's current glyph
1145 matrix, or return an estimation based on the height of the font of
1146 the face `header-line'. */
1148 #define CURRENT_HEADER_LINE_HEIGHT(W) \
1149 (current_header_line_height >= 0 \
1150 ? current_header_line_height \
1151 : (MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1152 ? MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1153 : estimate_mode_line_height (XFRAME ((W)->frame), \
1154 HEADER_LINE_FACE_ID)))
1156 /* Return the height of the desired mode line of window W. */
1158 #define DESIRED_MODE_LINE_HEIGHT(W) \
1159 MATRIX_MODE_LINE_HEIGHT ((W)->desired_matrix)
1161 /* Return the height of the desired header line of window W. */
1163 #define DESIRED_HEADER_LINE_HEIGHT(W) \
1164 MATRIX_HEADER_LINE_HEIGHT ((W)->desired_matrix)
1166 /* Like FRAME_INTERNAL_BORDER_WIDTH but checks whether frame F is a
1167 window-system frame. */
1169 #define FRAME_INTERNAL_BORDER_WIDTH_SAFE(F) \
1170 (FRAME_WINDOW_P (F) ? FRAME_INTERNAL_BORDER_WIDTH (F) : 0)
1172 /* Width of display region of window W. For terminal frames, this
1173 equals the width of W since there are no vertical scroll bars. For
1174 window system frames, the value has to be corrected by the pixel
1175 width of vertical scroll bars, and fringes. */
1177 #define WINDOW_DISPLAY_PIXEL_WIDTH(W) \
1178 (((XFASTINT ((W)->width) \
1179 - FRAME_SCROLL_BAR_WIDTH (XFRAME (WINDOW_FRAME ((W)))) \
1180 - FRAME_FRINGE_COLS (XFRAME (WINDOW_FRAME ((W))))) \
1181 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))))
1183 /* Height of the display region of W, including a mode line, if any. */
1185 #define WINDOW_DISPLAY_PIXEL_HEIGHT(W) \
1186 (XFASTINT ((W)->height) \
1187 * CANON_Y_UNIT (XFRAME (WINDOW_FRAME ((W)))))
1189 /* Height in pixels of the mode line. May be zero if W doesn't have a
1192 #define WINDOW_DISPLAY_MODE_LINE_HEIGHT(W) \
1193 (WINDOW_WANTS_MODELINE_P ((W)) \
1194 ? CURRENT_MODE_LINE_HEIGHT (W) \
1197 /* Height in pixels of the header line. Zero if W doesn't have a header
1200 #define WINDOW_DISPLAY_HEADER_LINE_HEIGHT(W) \
1201 (WINDOW_WANTS_HEADER_LINE_P ((W)) \
1202 ? CURRENT_HEADER_LINE_HEIGHT (W) \
1205 /* Pixel height of window W without mode line. */
1207 #define WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE(W) \
1208 (WINDOW_DISPLAY_PIXEL_HEIGHT ((W)) \
1209 - WINDOW_DISPLAY_MODE_LINE_HEIGHT ((W)))
1211 /* Pixel height of window W without mode and header line. */
1213 #define WINDOW_DISPLAY_TEXT_HEIGHT(W) \
1214 (WINDOW_DISPLAY_PIXEL_HEIGHT ((W)) \
1215 - WINDOW_DISPLAY_MODE_LINE_HEIGHT ((W)) \
1216 - WINDOW_DISPLAY_HEADER_LINE_HEIGHT ((W)))
1218 /* Left edge of W in pixels relative to its frame. */
1220 #define WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X(W) \
1221 (FRAME_INTERNAL_BORDER_WIDTH_SAFE (XFRAME (WINDOW_FRAME ((W)))) \
1222 + (WINDOW_LEFT_MARGIN ((W)) \
1223 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))) \
1224 + FRAME_LEFT_FRINGE_WIDTH (XFRAME (WINDOW_FRAME ((W)))))
1226 /* Right edge of window W in pixels, relative to its frame. */
1228 #define WINDOW_DISPLAY_RIGHT_EDGE_PIXEL_X(W) \
1229 (WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X ((W)) \
1230 + WINDOW_DISPLAY_PIXEL_WIDTH ((W)))
1232 /* Top edge of W in pixels relative to its frame. */
1234 #define WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y(W) \
1235 (FRAME_INTERNAL_BORDER_WIDTH_SAFE (XFRAME (WINDOW_FRAME ((W)))) \
1236 + (XFASTINT ((W)->top) \
1237 * CANON_Y_UNIT (XFRAME (WINDOW_FRAME ((W))))))
1239 /* Bottom edge of window W relative to its frame. */
1241 #define WINDOW_DISPLAY_BOTTOM_EDGE_PIXEL_Y(W) \
1242 (WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y ((W)) \
1243 + WINDOW_DISPLAY_PIXEL_HEIGHT ((W)))
1245 /* Convert window W relative pixel X to frame pixel coordinates. */
1247 #define WINDOW_TO_FRAME_PIXEL_X(W, X) \
1248 ((X) + WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X ((W)))
1250 /* Convert window W relative pixel Y to frame pixel coordinates. */
1252 #define WINDOW_TO_FRAME_PIXEL_Y(W, Y) \
1253 ((Y) + WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y ((W)))
1255 /* Convert frame relative pixel X to window relative pixel X. */
1257 #define FRAME_TO_WINDOW_PIXEL_X(W, X) \
1258 ((X) - WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X ((W)))
1260 /* Convert frame relative pixel Y to window relative pixel Y. */
1262 #define FRAME_TO_WINDOW_PIXEL_Y(W, Y) \
1263 ((Y) - WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y ((W)))
1265 /* Width of left margin area in pixels. */
1267 #define WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH(W) \
1268 (NILP ((W)->left_margin_width) \
1270 : (XINT ((W)->left_margin_width) \
1271 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))))
1273 /* Width of right marginal area in pixels. */
1275 #define WINDOW_DISPLAY_RIGHT_AREA_PIXEL_WIDTH(W) \
1276 (NILP ((W)->right_margin_width) \
1278 : (XINT ((W)->right_margin_width) \
1279 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))))
1281 /* Width of text area in pixels. */
1283 #define WINDOW_DISPLAY_TEXT_AREA_PIXEL_WIDTH(W) \
1284 (WINDOW_DISPLAY_PIXEL_WIDTH ((W)) \
1285 - WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)) \
1286 - WINDOW_DISPLAY_RIGHT_AREA_PIXEL_WIDTH ((W)))
1288 /* Convert a text area relative x-position in window W to frame X
1289 pixel coordinates. */
1291 #define WINDOW_TEXT_TO_FRAME_PIXEL_X(W, X) \
1292 (WINDOW_TO_FRAME_PIXEL_X ((W), (X)) \
1293 + WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)))
1295 /* Translate an x-position relative to AREA in window W to frame pixel
1298 #define WINDOW_AREA_TO_FRAME_PIXEL_X(W, AREA, X) \
1299 (WINDOW_TO_FRAME_PIXEL_X ((W), (X)) \
1300 + (((AREA) > LEFT_MARGIN_AREA) \
1301 ? WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)) \
1303 + (((AREA) > TEXT_AREA) \
1304 ? WINDOW_DISPLAY_TEXT_AREA_PIXEL_WIDTH ((W)) \
1307 /* Return the pixel width of AREA in W. */
1309 #define WINDOW_AREA_PIXEL_WIDTH(W, AREA) \
1310 (((AREA) == TEXT_AREA) \
1311 ? WINDOW_DISPLAY_TEXT_AREA_PIXEL_WIDTH ((W)) \
1312 : (((AREA) == LEFT_MARGIN_AREA) \
1313 ? WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)) \
1314 : WINDOW_DISPLAY_RIGHT_AREA_PIXEL_WIDTH ((W))))
1316 /* Value is non-zero if window W wants a mode line. */
1318 #define WINDOW_WANTS_MODELINE_P(W) \
1319 (!MINI_WINDOW_P ((W)) \
1320 && !(W)->pseudo_window_p \
1321 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1322 && BUFFERP ((W)->buffer) \
1323 && !NILP (XBUFFER ((W)->buffer)->mode_line_format) \
1324 && XFASTINT ((W)->height) > 1)
1326 /* Value is non-zero if window W wants a header line. */
1328 #define WINDOW_WANTS_HEADER_LINE_P(W) \
1329 (!MINI_WINDOW_P ((W)) \
1330 && !(W)->pseudo_window_p \
1331 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1332 && BUFFERP ((W)->buffer) \
1333 && !NILP (XBUFFER ((W)->buffer)->header_line_format) \
1334 && XFASTINT ((W)->height) > 1 + !NILP (XBUFFER ((W)->buffer)->mode_line_format))
1337 /* Return proper value to be used as baseline offset of font that has
1338 ASCENT and DESCENT to draw characters by the font at the vertical
1339 center of the line of frame F.
1341 Here, our task is to find the value of BOFF in the following figure;
1343 -------------------------+-----------+-
1344 -+-+---------+-+ | |
1346 | | | | F_ASCENT F_HEIGHT
1349 | | |-|-+------+-----------|------- baseline
1351 | |---------|-+-+ | |
1353 -+-+---------+-+ F_DESCENT |
1354 -------------------------+-----------+-
1356 -BOFF + DESCENT + (F_HEIGHT - HEIGHT) / 2 = F_DESCENT
1357 BOFF = DESCENT + (F_HEIGHT - HEIGHT) / 2 - F_DESCENT
1358 DESCENT = FONT->descent
1359 HEIGHT = FONT_HEIGHT (FONT)
1360 F_DESCENT = (F->output_data.x->font->descent
1361 - F->output_data.x->baseline_offset)
1362 F_HEIGHT = FRAME_LINE_HEIGHT (F)
1365 #define VCENTER_BASELINE_OFFSET(FONT, F) \
1366 (FONT_DESCENT (FONT) \
1367 + (FRAME_LINE_HEIGHT ((F)) - FONT_HEIGHT ((FONT)) \
1368 + (FRAME_LINE_HEIGHT ((F)) > FONT_HEIGHT ((FONT)))) / 2 \
1369 - (FONT_DESCENT (FRAME_FONT (F)) - FRAME_BASELINE_OFFSET (F)))
1372 /***********************************************************************
1374 ***********************************************************************/
1376 /* Indices of face attributes in Lisp face vectors. Slot zero is the
1379 enum lface_attribute_index
1381 LFACE_FAMILY_INDEX
= 1,
1386 LFACE_UNDERLINE_INDEX
,
1387 LFACE_INVERSE_INDEX
,
1388 LFACE_FOREGROUND_INDEX
,
1389 LFACE_BACKGROUND_INDEX
,
1390 LFACE_STIPPLE_INDEX
,
1391 LFACE_OVERLINE_INDEX
,
1392 LFACE_STRIKE_THROUGH_INDEX
,
1395 LFACE_INHERIT_INDEX
,
1396 LFACE_AVGWIDTH_INDEX
,
1401 /* Box types of faces. */
1405 /* No box around text. */
1408 /* Simple box of specified width and color. Default width is 1, and
1409 default color is the foreground color of the face. */
1412 /* Boxes with 3D shadows. Color equals the background color of the
1413 face. Width is specified. */
1419 /* Structure describing a realized face.
1421 For each Lisp face, 0..N realized faces can exist for different
1422 frames and different charsets. Realized faces are built from Lisp
1423 faces and text properties/overlays by merging faces and adding
1424 unspecified attributes from the `default' face. */
1428 /* The id of this face. The id equals the index of this face in the
1429 vector faces_by_id of its face cache. */
1432 #ifdef HAVE_WINDOW_SYSTEM
1434 /* If non-zero, this is a GC that we can use without modification for
1435 drawing the characters in this face. */
1438 /* Font used for this face, or null if the font could not be loaded
1439 for some reason. This points to a `font' slot of a struct
1440 font_info, and we should not call XFreeFont on it because the
1441 font may still be used somewhere else. */
1444 /* Background stipple or bitmap used for this face. This is
1445 an id as returned from load_pixmap. */
1448 #else /* not HAVE_WINDOW_SYSTEM */
1453 #endif /* not HAVE_WINDOW_SYSTEM */
1455 /* Pixel value of foreground color for X frames. Color index
1457 unsigned long foreground
;
1459 /* Pixel value or color index of background color. */
1460 unsigned long background
;
1462 /* Pixel value or color index of underline color. */
1463 unsigned long underline_color
;
1465 /* Pixel value or color index of overlined, strike-through, or box
1467 unsigned long overline_color
;
1468 unsigned long strike_through_color
;
1469 unsigned long box_color
;
1471 /* The font's name. This points to a `name' of a font_info, and it
1472 must not be freed. */
1475 /* Font info ID for this face's font. An ID is stored here because
1476 pointers to font_info structures may change. The reason is that
1477 they are pointers into a font table vector that is itself
1481 /* Fontset ID if this face uses a fontset, or -1. This is only >= 0
1482 if the face was realized for a composition sequence.
1483 Otherwise, a specific font is loaded from the set of fonts
1484 specified by the fontset given by the family attribute of the face. */
1487 /* Pixmap width and height. */
1488 unsigned int pixmap_w
, pixmap_h
;
1490 /* Non-zero means characters in this face have a box that thickness
1491 around them. If it is negative, the absolute value indicates the
1492 thickness, and the horizontal lines of box (top and bottom) are
1493 drawn inside of characters glyph area. The vertical lines of box
1494 (left and right) are drawn as the same way as the case that this
1495 value is positive. */
1498 /* Type of box drawn. A value of FACE_NO_BOX means no box is drawn
1499 around text in this face. A value of FACE_SIMPLE_BOX means a box
1500 of width box_line_width is drawn in color box_color. A value of
1501 FACE_RAISED_BOX or FACE_SUNKEN_BOX means a 3D box is drawn with
1502 shadow colors derived from the background color of the face. */
1503 enum face_box_type box
;
1505 /* If `box' above specifies a 3D type, 1 means use box_color for
1507 unsigned use_box_color_for_shadows_p
: 1;
1509 /* The Lisp face attributes this face realizes. All attributes
1510 in this vector are non-nil. */
1511 Lisp_Object lface
[LFACE_VECTOR_SIZE
];
1513 /* The hash value of this face. */
1516 /* The charset for which this face was realized if it was realized
1517 for use in multibyte text. If fontset >= 0, this is the charset
1518 of the first character of the composition sequence. A value of
1519 charset < 0 means the face was realized for use in unibyte text
1520 where the idea of Emacs charsets isn't applicable. */
1523 /* Non-zero if text in this face should be underlined, overlined,
1524 strike-through or have a box drawn around it. */
1525 unsigned underline_p
: 1;
1526 unsigned overline_p
: 1;
1527 unsigned strike_through_p
: 1;
1529 /* 1 means that the colors specified for this face could not be
1530 loaded, and were replaced by default colors, so they shouldn't be
1532 unsigned foreground_defaulted_p
: 1;
1533 unsigned background_defaulted_p
: 1;
1535 /* 1 means that either no color is specified for underlining or that
1536 the specified color couldn't be loaded. Use the foreground
1537 color when drawing in that case. */
1538 unsigned underline_defaulted_p
: 1;
1540 /* 1 means that either no color is specified for the corresponding
1541 attribute or that the specified color couldn't be loaded.
1542 Use the foreground color when drawing in that case. */
1543 unsigned overline_color_defaulted_p
: 1;
1544 unsigned strike_through_color_defaulted_p
: 1;
1545 unsigned box_color_defaulted_p
: 1;
1547 /* TTY appearances. Blinking is not yet implemented. Colors are
1548 found in `lface' with empty color string meaning the default
1549 color of the TTY. */
1550 unsigned tty_bold_p
: 1;
1551 unsigned tty_dim_p
: 1;
1552 unsigned tty_underline_p
: 1;
1553 unsigned tty_alt_charset_p
: 1;
1554 unsigned tty_reverse_p
: 1;
1555 unsigned tty_blinking_p
: 1;
1557 /* 1 means that colors of this face may not be freed because they
1558 have been copied bitwise from a base face (see
1560 unsigned colors_copied_bitwise_p
: 1;
1562 /* If non-zero, use overstrike (to simulate bold-face). */
1563 unsigned overstrike
: 1;
1565 /* Next and previous face in hash collision list of face cache. */
1566 struct face
*next
, *prev
;
1568 /* If this face is for ASCII characters, this points this face
1569 itself. Otherwise, this points a face for ASCII characters. */
1570 struct face
*ascii_face
;
1574 /* Color index indicating that face uses a terminal's default color. */
1576 #define FACE_TTY_DEFAULT_COLOR ((unsigned long) -1)
1578 /* Color index indicating that face uses an unknown foreground color. */
1580 #define FACE_TTY_DEFAULT_FG_COLOR ((unsigned long) -2)
1582 /* Color index indicating that face uses an unknown background color. */
1584 #define FACE_TTY_DEFAULT_BG_COLOR ((unsigned long) -3)
1586 /* Non-zero if FACE was realized for unibyte use. */
1588 #define FACE_UNIBYTE_P(FACE) ((FACE)->charset < 0)
1591 /* IDs of important faces known by the C face code. These are the IDs
1592 of the faces for CHARSET_ASCII. */
1598 MODE_LINE_INACTIVE_FACE_ID
,
1601 HEADER_LINE_FACE_ID
,
1607 BASIC_FACE_ID_SENTINEL
1611 /* A cache of realized faces. Each frame has its own cache because
1612 Emacs allows different frame-local face definitions. */
1616 /* Hash table of cached realized faces. */
1617 struct face
**buckets
;
1619 /* Back-pointer to the frame this cache belongs to. */
1622 /* A vector of faces so that faces can be referenced by an ID. */
1623 struct face
**faces_by_id
;
1625 /* The allocated size, and number of used slots of faces_by_id. */
1628 /* Flag indicating that attributes of the `menu' face have been
1630 unsigned menu_face_changed_p
: 1;
1634 /* Prepare face FACE for use on frame F. This must be called before
1635 using X resources of FACE. */
1637 #define PREPARE_FACE_FOR_DISPLAY(F, FACE) \
1638 if ((FACE)->gc == 0) \
1639 prepare_face_for_display ((F), (FACE)); \
1643 /* Return a pointer to the face with ID on frame F, or null if such a
1644 face doesn't exist. */
1646 #define FACE_FROM_ID(F, ID) \
1647 (((unsigned) (ID) < FRAME_FACE_CACHE (F)->used) \
1648 ? FRAME_FACE_CACHE (F)->faces_by_id[ID] \
1651 #ifdef HAVE_WINDOW_SYSTEM
1653 /* Non-zero if FACE is suitable for displaying character CHAR. */
1655 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) \
1656 (SINGLE_BYTE_CHAR_P (CHAR) \
1657 ? (FACE) == (FACE)->ascii_face \
1658 : face_suitable_for_char_p ((FACE), (CHAR)))
1660 /* Return the id of the realized face on frame F that is like the face
1661 with id ID but is suitable for displaying character CHAR.
1662 This macro is only meaningful for multibyte character CHAR. */
1664 #define FACE_FOR_CHAR(F, FACE, CHAR) \
1665 (SINGLE_BYTE_CHAR_P (CHAR) \
1666 ? (FACE)->ascii_face->id \
1667 : face_for_char ((F), (FACE), (CHAR)))
1669 #else /* not HAVE_WINDOW_SYSTEM */
1671 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) 1
1672 #define FACE_FOR_CHAR(F, FACE, CHAR) ((FACE)->id)
1674 #endif /* not HAVE_WINDOW_SYSTEM */
1676 /* Non-zero means face attributes have been changed since the last
1677 redisplay. Used in redisplay_internal. */
1679 extern int face_change_count
;
1684 /***********************************************************************
1686 ***********************************************************************/
1688 enum fringe_bitmap_type
1690 NO_FRINGE_BITMAP
= 0,
1691 LEFT_TRUNCATION_BITMAP
,
1692 RIGHT_TRUNCATION_BITMAP
,
1693 CONTINUED_LINE_BITMAP
,
1694 CONTINUATION_LINE_BITMAP
,
1695 OVERLAY_ARROW_BITMAP
,
1700 struct fringe_bitmap
1705 unsigned char *bits
;
1708 /* Structure used to describe where and how to draw a fringe bitmap.
1709 WHICH is the fringe bitmap to draw. WD and H is the (adjusted)
1710 width and height of the bitmap, DH is the height adjustment (if
1711 bitmap is periodic). X and Y are frame coordinates of the area to
1712 display the bitmap, DY is relative offset of the bitmap into that
1713 area. BX, NX, BY, NY specifies the area to clear if the bitmap
1714 does not fill the entire area. FACE is the fringe face. */
1716 struct draw_fringe_bitmap_params
1718 enum fringe_bitmap_type which
;
1725 extern struct fringe_bitmap fringe_bitmaps
[MAX_FRINGE_BITMAPS
];
1728 /***********************************************************************
1730 ***********************************************************************/
1732 /* Iteration over things to display in current_buffer or in a string.
1734 The iterator handles:
1736 1. Overlay strings (after-string, before-string).
1738 3. Invisible text properties.
1739 4. Selective display.
1740 5. Translation of characters via display tables.
1741 6. Translation of control characters to the forms `\003' or `^C'.
1742 7. `glyph' and `space-width' properties.
1744 Iterators are initialized by calling init_iterator or one of the
1745 equivalent functions below. A call to get_next_display_element
1746 loads the iterator structure with information about what next to
1747 display. A call to set_iterator_to_next increments the iterator's
1750 Characters from overlay strings, display table entries or control
1751 character translations are returned one at a time. For example, if
1752 we have a text of `a\x01' where `a' has a display table definition
1753 of `cd' and the control character is displayed with a leading
1754 arrow, then the iterator will return:
1756 Call Return Source Call next
1757 -----------------------------------------------------------------
1758 next c display table move
1759 next d display table move
1760 next ^ control char move
1761 next A control char move
1763 The same mechanism is also used to return characters for ellipses
1764 displayed at the end of invisible text.
1766 CAVEAT: Under some circumstances, move_.* functions can be called
1767 asynchronously, e.g. when computing a buffer position from an x and
1768 y pixel position. This means that these functions and functions
1769 called from them SHOULD NOT USE xmalloc and alike. See also the
1770 comment at the start of xdisp.c. */
1772 /* Enumeration describing what kind of display element an iterator is
1773 loaded with after a call to get_next_display_element. */
1775 enum display_element_type
1777 /* A normal character. */
1780 /* A composition sequence. */
1786 /* A flexible width and height space. */
1789 /* End of buffer or string. */
1792 /* Truncation glyphs. Never returned by get_next_display_element.
1793 Used to get display information about truncation glyphs via
1797 /* Continuation glyphs. See the comment for IT_TRUNCATION. */
1802 /* An enumerator for each text property that has a meaning for display
1811 COMPOSITION_PROP_IDX
,
1813 /* Not a property. Used to indicate changes in overlays. */
1823 /* The window in which we iterate over current_buffer (or a string). */
1827 /* The window's frame. */
1830 /* Function to call to load this structure with the next display
1832 int (* method
) P_ ((struct it
*it
));
1834 /* The next position at which to check for face changes, invisible
1835 text, overlay strings, end of text etc., which see. */
1838 /* Maximum string or buffer position + 1. ZV when iterating over
1842 /* C string to iterate over. Non-null means get characters from
1843 this string, otherwise characters are read from current_buffer
1847 /* Number of characters in the string (s, or it->string) we iterate
1851 /* Start and end of a visible region; -1 if the region is not
1852 visible in the window. */
1853 int region_beg_charpos
, region_end_charpos
;
1855 /* Position at which redisplay end trigger functions should be run. */
1856 int redisplay_end_trigger_charpos
;
1858 /* 1 means multibyte characters are enabled. */
1859 unsigned multibyte_p
: 1;
1861 /* 1 means window has a mode line at its top. */
1862 unsigned header_line_p
: 1;
1864 /* 1 means `string' is the value of a `display' property.
1865 Don't handle some `display' properties in these strings. */
1866 unsigned string_from_display_prop_p
: 1;
1868 /* Display table in effect or null for none. */
1869 struct Lisp_Char_Table
*dp
;
1871 /* Current display table vector to return characters from and its
1872 end. dpvec null means we are not returning characters from a
1873 display table entry; current.dpvec_index gives the current index
1874 into dpvec. This same mechanism is also used to return
1875 characters from translated control characters, i.e. `\003' or
1877 Lisp_Object
*dpvec
, *dpend
;
1879 /* Length in bytes of the char that filled dpvec. A value of zero
1880 means that no such character is involved. */
1883 /* Face id of the iterator saved in case a glyph from dpvec contains
1884 a face. The face is restored when all glyphs from dpvec have
1888 /* Vector of glyphs for control character translation. The pointer
1889 dpvec is set to ctl_chars when a control character is translated.
1890 This vector is also used for incomplete multibyte character
1891 translation (e.g \222\244). Such a character is at most 4 bytes,
1892 thus we need at most 16 bytes here. */
1893 Lisp_Object ctl_chars
[16];
1895 /* Current buffer or string position of the iterator, including
1896 position in overlay strings etc. */
1897 struct display_pos current
;
1899 /* Vector of overlays to process. Overlay strings are processed
1900 OVERLAY_STRING_CHUNK_SIZE at a time. */
1901 #define OVERLAY_STRING_CHUNK_SIZE 3
1902 Lisp_Object overlay_strings
[OVERLAY_STRING_CHUNK_SIZE
];
1904 /* Total number of overlay strings to process. This can be >
1905 OVERLAY_STRING_CHUNK_SIZE. */
1906 int n_overlay_strings
;
1908 /* If non-nil, a Lisp string being processed. If
1909 current.overlay_string_index >= 0, this is an overlay string from
1913 /* Stack of saved values. New entries are pushed when we begin to
1914 process an overlay string or a string from a `glyph' property.
1915 Entries are popped when we return to deliver display elements
1916 from what we previously had. */
1917 struct iterator_stack_entry
1922 struct display_pos pos
;
1925 enum glyph_row_area area
;
1926 unsigned multibyte_p
: 1;
1927 unsigned string_from_display_prop_p
: 1;
1928 unsigned display_ellipsis_p
: 1;
1929 Lisp_Object space_width
;
1931 Lisp_Object font_height
;
1935 /* Stack pointer. */
1938 /* Setting of buffer-local variable selective-display-ellipsis. */
1939 unsigned selective_display_ellipsis_p
: 1;
1941 /* 1 means control characters are translated into the form `^C'
1942 where the `^' can be replaced by a display table entry. */
1943 unsigned ctl_arrow_p
: 1;
1945 /* -1 means selective display hides everything between a \r and the
1946 next newline; > 0 means hide lines indented more than that value. */
1949 /* An enumeration describing what the next display element is
1950 after a call to get_next_display_element. */
1951 enum display_element_type what
;
1956 /* Non-zero means that the current face has a box. */
1957 unsigned face_box_p
: 1;
1959 /* Non-null means that the current character is the first in a run
1960 of characters with box face. */
1961 unsigned start_of_box_run_p
: 1;
1963 /* Non-zero means that the current character is the last in a run
1964 of characters with box face. */
1965 unsigned end_of_box_run_p
: 1;
1967 /* 1 means overlay strings at end_charpos have been processed. */
1968 unsigned overlay_strings_at_end_processed_p
: 1;
1970 /* 1 means the actual glyph is not available in the current
1972 unsigned glyph_not_available_p
: 1;
1974 /* 1 means the next line in display_line continues a character
1975 consisting of more than one glyph, and some glyphs of this
1976 character have been put on the previous line. */
1977 unsigned starts_in_middle_of_char_p
: 1;
1979 /* If 1, saved_face_id contains the id of the face in front of text
1980 skipped due to selective display. */
1981 unsigned face_before_selective_p
: 1;
1983 /* The ID of the default face to use. One of DEFAULT_FACE_ID,
1984 MODE_LINE_FACE_ID, etc, depending on what we are displaying. */
1987 /* If what == IT_CHARACTER, character and length in bytes. This is
1988 a character from a buffer or string. It may be different from
1989 the character displayed in case that
1990 unibyte_display_via_language_environment is set.
1992 If what == IT_COMPOSITION, the first component of a composition
1993 and length in bytes of the composition. */
1996 /* If what == IT_COMPOSITION, identification number and length in
1997 chars of a composition. */
1998 int cmp_id
, cmp_len
;
2000 /* The character to display, possibly translated to multibyte
2001 if unibyte_display_via_language_environment is set. This
2002 is set after produce_glyphs has been called. */
2003 int char_to_display
;
2005 /* If what == IT_IMAGE, the id of the image to display. */
2008 /* Value of the `space-width' property, if any; nil if none. */
2009 Lisp_Object space_width
;
2011 /* Computed from the value of the `raise' property. */
2014 /* Value of the `height' property, if any; nil if none. */
2015 Lisp_Object font_height
;
2017 /* Object and position where the current display element came from.
2018 Object can be a Lisp string in case the current display element
2019 comes from an overlay string, or it is buffer. Position is
2020 a position in object. */
2022 struct text_pos position
;
2024 /* 1 means lines are truncated. */
2025 unsigned truncate_lines_p
: 1;
2027 /* Number of columns per \t. */
2030 /* Width in pixels of truncation and continuation glyphs. */
2031 short truncation_pixel_width
, continuation_pixel_width
;
2033 /* First and last visible x-position in the display area. If window
2034 is hscrolled by n columns, first_visible_x == n * CANON_X_UNIT
2035 (f), and last_visible_x == pixel width of W + first_visible_x. */
2036 int first_visible_x
, last_visible_x
;
2038 /* Last visible y-position + 1 in the display area without a mode
2039 line, if the window has one. */
2042 /* Additional space in pixels between lines (for window systems
2044 int extra_line_spacing
;
2046 /* If non-null, glyphs are produced in glyph_row with each call to
2048 struct glyph_row
*glyph_row
;
2050 /* The area of glyph_row to which glyphs are added. */
2051 enum glyph_row_area area
;
2053 /* Number of glyphs needed for the last character requested via
2054 produce_glyphs. This is 1 except for tabs. */
2057 /* Width of the display element in pixels. Result of
2061 /* Current, maximum logical, and maximum physical line height
2062 information. Result of produce_glyphs. */
2063 int ascent
, descent
, max_ascent
, max_descent
;
2064 int phys_ascent
, phys_descent
, max_phys_ascent
, max_phys_descent
;
2066 /* Current x pixel position within the display line. This value
2067 does not include the width of continuation lines in front of the
2068 line. The value of current_x is automatically incremented by
2069 pixel_width with each call to produce_glyphs. */
2072 /* Accumulated width of continuation lines. If > 0, this means we
2073 are currently in a continuation line. This is initially zero and
2074 incremented/reset by display_line, move_it_to etc. */
2075 int continuation_lines_width
;
2077 /* Current y-position. Automatically incremented by the height of
2078 glyph_row in move_it_to and display_line. */
2081 /* Current vertical matrix position, or line number. Automatically
2082 incremented by move_it_to and display_line. */
2085 /* Horizontal matrix position reached in move_it_in_display_line.
2086 Only set there, not in display_line. */
2091 /* Access to positions of iterator IT. */
2093 #define IT_CHARPOS(IT) CHARPOS ((IT).current.pos)
2094 #define IT_BYTEPOS(IT) BYTEPOS ((IT).current.pos)
2095 #define IT_STRING_CHARPOS(IT) CHARPOS ((IT).current.string_pos)
2096 #define IT_STRING_BYTEPOS(IT) BYTEPOS ((IT).current.string_pos)
2098 /* Test if IT has reached the end of its buffer or string. This will
2099 only work after get_next_display_element has been called. */
2101 #define ITERATOR_AT_END_P(IT) ((IT)->what == IT_EOB)
2103 /* Non-zero means IT is at the end of a line. This is the case if it
2104 is either on a newline or on a carriage return and selective
2105 display hides the rest of the line. */
2107 #define ITERATOR_AT_END_OF_LINE_P(IT) \
2108 ((IT)->what == IT_CHARACTER \
2109 && ((IT)->c == '\n' \
2110 || ((IT)->c == '\r' && (IT)->selective)))
2112 /* Call produce_glyphs or produce_glyphs_hook, if set. Shortcut to
2113 avoid the function call overhead. */
2115 #define PRODUCE_GLYPHS(IT) \
2117 extern int inhibit_free_realized_faces; \
2119 rif->produce_glyphs ((IT)); \
2121 produce_glyphs ((IT)); \
2122 if ((IT)->glyph_row != NULL) \
2123 inhibit_free_realized_faces = 1; \
2126 /* Bit-flags indicating what operation move_it_to should perform. */
2128 enum move_operation_enum
2130 /* Stop if specified x-position is reached. */
2133 /* Stop if specified y-position is reached. */
2136 /* Stop if specified vpos is reached. */
2137 MOVE_TO_VPOS
= 0x04,
2139 /* Stop if specified buffer or string position is reached. */
2145 /***********************************************************************
2146 Window-based redisplay interface
2147 ***********************************************************************/
2149 /* Structure used to describe runs of lines that must be scrolled. */
2153 /* Source and destination y pixel position. */
2154 int desired_y
, current_y
;
2156 /* Source and destination vpos in matrix. */
2157 int desired_vpos
, current_vpos
;
2159 /* Height in pixels, number of glyph rows. */
2164 /* Structure holding system-dependent interface functions needed
2165 for window-based redisplay. */
2167 struct redisplay_interface
2169 /* Produce glyphs/get display metrics for the display element IT is
2171 void (*produce_glyphs
) P_ ((struct it
*it
));
2173 /* Write or insert LEN glyphs from STRING at the nominal output
2175 void (*write_glyphs
) P_ ((struct glyph
*string
, int len
));
2176 void (*insert_glyphs
) P_ ((struct glyph
*start
, int len
));
2178 /* Clear from nominal output position to X. X < 0 means clear
2179 to right end of display. */
2180 void (*clear_end_of_line
) P_ ((int x
));
2182 /* Function to call to scroll the display as described by RUN on
2184 void (*scroll_run_hook
) P_ ((struct window
*w
, struct run
*run
));
2186 /* Function to call after a line in a display has been completely
2187 updated. Used to draw truncation marks and alike. DESIRED_ROW
2188 is the desired row which has been updated. */
2189 void (*after_update_window_line_hook
) P_ ((struct glyph_row
*desired_row
));
2191 /* Function to call before beginning to update window W in
2192 window-based redisplay. */
2193 void (*update_window_begin_hook
) P_ ((struct window
*w
));
2195 /* Function to call after window W has been updated in window-based
2196 redisplay. CURSOR_ON_P non-zero means switch cursor on.
2197 MOUSE_FACE_OVERWRITTEN_P non-zero means that some lines in W
2198 that contained glyphs in mouse-face were overwritten, so we
2199 have to update the mouse highlight. */
2200 void (*update_window_end_hook
) P_ ((struct window
*w
, int cursor_on_p
,
2201 int mouse_face_overwritten_p
));
2203 /* Move cursor to row/column position VPOS/HPOS, pixel coordinates
2204 Y/X. HPOS/VPOS are window-relative row and column numbers and X/Y
2205 are window-relative pixel positions. */
2206 void (*cursor_to
) P_ ((int vpos
, int hpos
, int y
, int x
));
2208 /* Flush the display of frame F. For X, this is XFlush. */
2209 void (*flush_display
) P_ ((struct frame
*f
));
2211 /* Flush the display of frame F if non-NULL. This is called
2212 during redisplay, and should be NULL on systems which flushes
2213 automatically before reading input. */
2214 void (*flush_display_optional
) P_ ((struct frame
*f
));
2216 /* Clear the mouse hightlight in window W, if there is any. */
2217 void (*clear_window_mouse_face
) P_ ((struct window
*w
));
2219 /* Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
2221 void (*get_glyph_overhangs
) P_ ((struct glyph
*glyph
, struct frame
*f
,
2222 int *left
, int *right
));
2224 /* Fix the display of AREA of ROW in window W for overlapping rows.
2225 This function is called from redraw_overlapping_rows after
2226 desired rows have been made current. */
2227 void (*fix_overlapping_area
) P_ ((struct window
*w
, struct glyph_row
*row
,
2228 enum glyph_row_area area
));
2230 #ifdef HAVE_WINDOW_SYSTEM
2232 /* Draw a fringe bitmap in window W of row ROW using parameters P. */
2233 void (*draw_fringe_bitmap
) P_ ((struct window
*w
, struct glyph_row
*row
,
2234 struct draw_fringe_bitmap_params
*p
));
2236 /* Get metrics of character CHAR2B in FONT of type FONT_TYPE.
2237 Value is null if CHAR2B is not contained in the font. */
2238 XCharStruct
* (*per_char_metric
) P_ ((XFontStruct
*font
, XChar2b
*char2b
,
2241 /* Encode CHAR2B using encoding information from FONT_INFO. CHAR2B is
2242 the two-byte form of C. Encoding is returned in *CHAR2B. If
2243 TWO_BYTE_P is non-null, return non-zero there if font is two-byte. */
2244 int (*encode_char
) P_ ((int c
, XChar2b
*char2b
,
2245 struct font_info
*font_into
, int *two_byte_p
));
2247 /* Compute left and right overhang of glyph string S.
2248 A NULL pointer if platform does not support this. */
2249 void (*compute_glyph_string_overhangs
) P_ ((struct glyph_string
*s
));
2251 /* Draw a glyph string S. */
2252 void (*draw_glyph_string
) P_ ((struct glyph_string
*s
));
2254 /* Define cursor CURSOR on frame F. */
2255 void (*define_frame_cursor
) P_ ((struct frame
*f
, Cursor cursor
));
2257 /* Clear the area at (X,Y,WIDTH,HEIGHT) of frame F. */
2258 void (*clear_frame_area
) P_ ((struct frame
*f
, int x
, int y
,
2259 int width
, int height
));
2261 /* Draw specified cursor CURSOR_TYPE of width CURSOR_WIDTH
2262 at row GLYPH_ROW on window W if ON_P is 1. If ON_P is
2263 0, don't draw cursor. If ACTIVE_P is 1, system caret
2264 should track this cursor (when applicable). */
2265 void (*draw_window_cursor
) P_ ((struct window
*w
,
2266 struct glyph_row
*glyph_row
,
2268 int cursor_type
, int cursor_width
,
2269 int on_p
, int active_p
));
2271 /* Draw vertical border for window W from (X,Y0) to (X,Y1). */
2272 void (*draw_vertical_window_border
) P_ ((struct window
*w
,
2273 int x
, int y0
, int y1
));
2275 /* Shift display of frame F to make room for inserted glyphs.
2276 The area at pixel (X,Y) of width WIDTH and height HEIGHT is
2277 shifted right by SHIFT_BY pixels. */
2278 void (*shift_glyphs_for_insert
) P_ ((struct frame
*f
,
2279 int x
, int y
, int width
,
2280 int height
, int shift_by
));
2282 #endif /* HAVE_WINDOW_SYSTEM */
2285 /* The current interface for window-based redisplay. */
2287 extern struct redisplay_interface
*rif
;
2290 /***********************************************************************
2292 ***********************************************************************/
2294 #ifdef HAVE_WINDOW_SYSTEM
2296 /* Structure forward declarations. */
2301 /* Each image format (JPEG, TIFF, ...) supported is described by
2302 a structure of the type below. */
2306 /* A symbol uniquely identifying the image type, .e.g `jpeg'. */
2309 /* Check that SPEC is a valid image specification for the given
2310 image type. Value is non-zero if SPEC is valid. */
2311 int (* valid_p
) P_ ((Lisp_Object spec
));
2313 /* Load IMG which is used on frame F from information contained in
2314 IMG->spec. Value is non-zero if successful. */
2315 int (* load
) P_ ((struct frame
*f
, struct image
*img
));
2317 /* Free resources of image IMG which is used on frame F. */
2318 void (* free
) P_ ((struct frame
*f
, struct image
*img
));
2320 /* Next in list of all supported image types. */
2321 struct image_type
*next
;
2325 /* Structure describing an image. Specific image formats like XBM are
2326 converted into this form, so that display only has to deal with
2327 this type of image. */
2331 /* The time in seconds at which the image was last displayed. Set
2332 in prepare_image_for_display. */
2333 unsigned long timestamp
;
2335 /* Pixmaps of the image. */
2336 Pixmap pixmap
, mask
;
2338 /* Colors allocated for this image, if any. Allocated via xmalloc. */
2339 unsigned long *colors
;
2342 /* A single `background color' for this image, for the use of anyone that
2343 cares about such a thing. Only valid if the `background_valid' field
2344 is true. This should generally be accessed by calling the accessor
2345 macro `IMAGE_BACKGROUND', which will heuristically calculate a value
2347 unsigned long background
;
2349 /* True if this image has a `transparent' background -- that is, is
2350 uses an image mask. The accessor macro for this is
2351 `IMAGE_BACKGROUND_TRANSPARENT'. */
2352 unsigned background_transparent
: 1;
2354 /* True if the `background' and `background_transparent' fields are
2355 valid, respectively. */
2356 unsigned background_valid
: 1, background_transparent_valid
: 1;
2358 /* Width and height of the image. */
2361 /* These values are used for the rectangles displayed for images
2362 that can't be loaded. */
2363 #define DEFAULT_IMAGE_WIDTH 30
2364 #define DEFAULT_IMAGE_HEIGHT 30
2366 /* Percent of image height used as ascent. A value of
2367 CENTERED_IMAGE_ASCENT means draw the image centered on the
2370 #define DEFAULT_IMAGE_ASCENT 50
2371 #define CENTERED_IMAGE_ASCENT -1
2373 /* Lisp specification of this image. */
2376 /* Relief to draw around the image. */
2379 /* Optional margins around the image. This includes the relief. */
2380 int hmargin
, vmargin
;
2382 /* Reference to the type of the image. */
2383 struct image_type
*type
;
2385 /* 1 means that loading the image failed. Don't try again. */
2386 unsigned load_failed_p
;
2388 /* A place for image types to store additional data. The member
2389 data.lisp_val is marked during GC, so it's safe to store Lisp data
2390 there. Image types should free this data when their `free'
2391 function is called. */
2396 Lisp_Object lisp_val
;
2399 /* Hash value of image specification to speed up comparisons. */
2402 /* Image id of this image. */
2405 /* Hash collision chain. */
2406 struct image
*next
, *prev
;
2410 /* Cache of images. Each frame has a cache. X frames with the same
2411 x_display_info share their caches. */
2415 /* Hash table of images. */
2416 struct image
**buckets
;
2418 /* Vector mapping image ids to images. */
2419 struct image
**images
;
2421 /* Allocated size of `images'. */
2424 /* Number of images in the cache. */
2427 /* Reference count (number of frames sharing this cache). */
2432 /* Value is a pointer to the image with id ID on frame F, or null if
2433 no image with that id exists. */
2435 #define IMAGE_FROM_ID(F, ID) \
2436 (((ID) >= 0 && (ID) < (FRAME_X_IMAGE_CACHE (F)->used)) \
2437 ? FRAME_X_IMAGE_CACHE (F)->images[ID] \
2440 /* Size of bucket vector of image caches. Should be prime. */
2442 #define IMAGE_CACHE_BUCKETS_SIZE 1001
2444 #endif /* HAVE_WINDOW_SYSTEM */
2448 /***********************************************************************
2450 ***********************************************************************/
2452 /* Enumeration defining where to find tool-bar item information in
2453 tool-bar items vectors stored with frames. Each tool-bar item
2454 occupies TOOL_BAR_ITEM_NSLOTS elements in such a vector. */
2456 enum tool_bar_item_idx
2458 /* The key of the tool-bar item. Used to remove items when a binding
2459 for `undefined' is found. */
2462 /* Non-nil if item is enabled. */
2463 TOOL_BAR_ITEM_ENABLED_P
,
2465 /* Non-nil if item is selected (pressed). */
2466 TOOL_BAR_ITEM_SELECTED_P
,
2469 TOOL_BAR_ITEM_CAPTION
,
2471 /* Image(s) to display. This is either a single image specification
2472 or a vector of specifications. */
2473 TOOL_BAR_ITEM_IMAGES
,
2476 TOOL_BAR_ITEM_BINDING
,
2478 /* Button type. One of nil, `:radio' or `:toggle'. */
2484 /* Sentinel = number of slots in tool_bar_items occupied by one
2486 TOOL_BAR_ITEM_NSLOTS
2490 /* An enumeration for the different images that can be specified
2491 for a tool-bar item. */
2493 enum tool_bar_item_image
2495 TOOL_BAR_IMAGE_ENABLED_SELECTED
,
2496 TOOL_BAR_IMAGE_ENABLED_DESELECTED
,
2497 TOOL_BAR_IMAGE_DISABLED_SELECTED
,
2498 TOOL_BAR_IMAGE_DISABLED_DESELECTED
2501 /* Margin around tool-bar buttons in pixels. */
2503 extern Lisp_Object Vtool_bar_button_margin
;
2505 /* Thickness of relief to draw around tool-bar buttons. */
2507 extern EMACS_INT tool_bar_button_relief
;
2509 /* Default values of the above variables. */
2511 #define DEFAULT_TOOL_BAR_BUTTON_MARGIN 4
2512 #define DEFAULT_TOOL_BAR_BUTTON_RELIEF 1
2514 /* The height in pixels of the default tool-bar images. */
2516 #define DEFAULT_TOOL_BAR_IMAGE_HEIGHT 24
2519 /***********************************************************************
2520 Terminal Capabilities
2521 ***********************************************************************/
2523 /* Each of these is a bit representing a terminal `capability' (bold,
2524 inverse, etc). They are or'd together to specify the set of
2525 capabilities being queried for when calling `tty_capable_p' (which
2526 returns true if the terminal supports all of them). */
2528 #define TTY_CAP_INVERSE 0x01
2529 #define TTY_CAP_UNDERLINE 0x02
2530 #define TTY_CAP_BOLD 0x04
2531 #define TTY_CAP_DIM 0x08
2532 #define TTY_CAP_BLINK 0x10
2533 #define TTY_CAP_ALT_CHARSET 0x20
2536 /***********************************************************************
2538 ***********************************************************************/
2540 /* Defined in xdisp.c */
2542 struct glyph_row
*row_containing_pos
P_ ((struct window
*, int,
2544 struct glyph_row
*, int));
2545 int string_buffer_position
P_ ((struct window
*, Lisp_Object
, int));
2546 int line_bottom_y
P_ ((struct it
*));
2547 int display_prop_intangible_p
P_ ((Lisp_Object
));
2548 void resize_echo_area_exactly
P_ ((void));
2549 int resize_mini_window
P_ ((struct window
*, int));
2550 int try_window
P_ ((Lisp_Object
, struct text_pos
));
2551 void window_box
P_ ((struct window
*, int, int *, int *, int *, int *));
2552 int window_box_height
P_ ((struct window
*));
2553 int window_text_bottom_y
P_ ((struct window
*));
2554 int window_box_width
P_ ((struct window
*, int));
2555 int window_box_left
P_ ((struct window
*, int));
2556 int window_box_right
P_ ((struct window
*, int));
2557 void window_box_edges
P_ ((struct window
*, int, int *, int *, int *, int *));
2558 int estimate_mode_line_height
P_ ((struct frame
*, enum face_id
));
2559 void mark_window_display_accurate
P_ ((Lisp_Object
, int));
2560 void redisplay_preserve_echo_area
P_ ((int));
2561 void set_cursor_from_row
P_ ((struct window
*, struct glyph_row
*,
2562 struct glyph_matrix
*, int, int, int, int));
2563 void init_iterator
P_ ((struct it
*, struct window
*, int,
2564 int, struct glyph_row
*, enum face_id
));
2565 void init_iterator_to_row_start
P_ ((struct it
*, struct window
*,
2566 struct glyph_row
*));
2567 int get_next_display_element
P_ ((struct it
*));
2568 void set_iterator_to_next
P_ ((struct it
*, int));
2569 void produce_glyphs
P_ ((struct it
*));
2570 void produce_special_glyphs
P_ ((struct it
*, enum display_element_type
));
2571 void start_display
P_ ((struct it
*, struct window
*, struct text_pos
));
2572 void move_it_to
P_ ((struct it
*, int, int, int, int, int));
2573 void move_it_vertically
P_ ((struct it
*, int));
2574 void move_it_vertically_backward
P_ ((struct it
*, int));
2575 void move_it_by_lines
P_ ((struct it
*, int, int));
2576 void move_it_past_eol
P_ ((struct it
*));
2577 int in_display_vector_p
P_ ((struct it
*));
2578 int frame_mode_line_height
P_ ((struct frame
*));
2579 void highlight_trailing_whitespace
P_ ((struct frame
*, struct glyph_row
*));
2580 void draw_row_fringe_bitmaps
P_ ((struct window
*, struct glyph_row
*));
2581 void compute_fringe_widths
P_ ((struct frame
*, int));
2582 extern Lisp_Object Qtool_bar
;
2583 extern Lisp_Object Vshow_trailing_whitespace
;
2584 extern int mode_line_in_non_selected_windows
;
2585 extern int redisplaying_p
;
2586 extern Lisp_Object Vimage_types
;
2587 extern void add_to_log
P_ ((char *, Lisp_Object
, Lisp_Object
));
2588 extern int help_echo_showing_p
;
2589 extern int current_mode_line_height
, current_header_line_height
;
2590 extern Lisp_Object help_echo_string
, help_echo_window
;
2591 extern Lisp_Object help_echo_object
, previous_help_echo_string
;
2592 extern int help_echo_pos
;
2593 extern struct frame
*last_mouse_frame
;
2594 extern int last_tool_bar_item
;
2595 extern int mouse_autoselect_window
;
2597 #ifdef HAVE_WINDOW_SYSTEM
2600 extern void dump_glyph_string
P_ ((struct glyph_string
*));
2603 extern void x_get_glyph_overhangs
P_ ((struct glyph
*, struct frame
*,
2605 extern void x_produce_glyphs
P_ ((struct it
*));
2607 extern void x_write_glyphs
P_ ((struct glyph
*, int));
2608 extern void x_insert_glyphs
P_ ((struct glyph
*, int len
));
2609 extern void x_clear_end_of_line
P_ ((int));
2611 extern int x_stretch_cursor_p
;
2612 extern struct cursor_pos output_cursor
;
2614 extern void x_fix_overlapping_area
P_ ((struct window
*, struct glyph_row
*,
2615 enum glyph_row_area
));
2616 extern void draw_phys_cursor_glyph
P_ ((struct window
*,
2618 enum draw_glyphs_face
));
2619 extern void erase_phys_cursor
P_ ((struct window
*));
2620 extern void display_and_set_cursor
P_ ((struct window
*,
2621 int, int, int, int, int));
2623 extern void set_output_cursor
P_ ((struct cursor_pos
*));
2624 extern void x_cursor_to
P_ ((int, int, int, int));
2626 extern void x_update_cursor
P_ ((struct frame
*, int));
2627 extern void x_clear_cursor
P_ ((struct window
*));
2628 extern void x_draw_vertical_border
P_ ((struct window
*w
));
2630 extern void frame_to_window_pixel_xy
P_ ((struct window
*, int *, int *));
2631 extern void get_glyph_string_clip_rect
P_ ((struct glyph_string
*,
2632 NativeRectangle
*nr
));
2633 extern void note_mouse_highlight
P_ ((struct frame
*, int, int));
2634 extern void x_clear_window_mouse_face
P_ ((struct window
*));
2635 extern void cancel_mouse_face
P_ ((struct frame
*));
2637 extern void handle_tool_bar_click
P_ ((struct frame
*,
2638 int, int, int, unsigned int));
2640 /* msdos.c defines its own versions of these functions. */
2641 extern int clear_mouse_face
P_ ((Display_Info
*));
2642 extern void show_mouse_face
P_ ((Display_Info
*, enum draw_glyphs_face
));
2643 extern int cursor_in_mouse_face_p
P_ ((struct window
*w
));
2645 extern void expose_frame
P_ ((struct frame
*, int, int, int, int));
2646 extern int x_intersect_rectangles
P_ ((XRectangle
*, XRectangle
*,
2650 /* Defined in sysdep.c */
2652 void get_frame_size
P_ ((int *, int *));
2653 void request_sigio
P_ ((void));
2654 void unrequest_sigio
P_ ((void));
2655 int tabs_safe_p
P_ ((void));
2656 void init_baud_rate
P_ ((void));
2657 void init_sigio
P_ ((int));
2659 /* Defined in xfaces.c */
2661 #ifdef HAVE_X_WINDOWS
2662 void x_free_colors
P_ ((struct frame
*, unsigned long *, int));
2665 void update_face_from_frame_parameter
P_ ((struct frame
*, Lisp_Object
,
2667 Lisp_Object tty_color_name
P_ ((struct frame
*, int));
2668 void clear_face_cache
P_ ((int));
2669 unsigned long load_color
P_ ((struct frame
*, struct face
*, Lisp_Object
,
2670 enum lface_attribute_index
));
2671 void unload_color
P_ ((struct frame
*, unsigned long));
2672 int frame_update_line_height
P_ ((struct frame
*));
2673 int ascii_face_of_lisp_face
P_ ((struct frame
*, int));
2674 void prepare_face_for_display
P_ ((struct frame
*, struct face
*));
2675 int xstricmp
P_ ((const unsigned char *, const unsigned char *));
2676 int lookup_face
P_ ((struct frame
*, Lisp_Object
*, int, struct face
*));
2677 int lookup_named_face
P_ ((struct frame
*, Lisp_Object
, int));
2678 int smaller_face
P_ ((struct frame
*, int, int));
2679 int face_with_height
P_ ((struct frame
*, int, int));
2680 int lookup_derived_face
P_ ((struct frame
*, Lisp_Object
, int, int));
2681 void init_frame_faces
P_ ((struct frame
*));
2682 void free_frame_faces
P_ ((struct frame
*));
2683 void recompute_basic_faces
P_ ((struct frame
*));
2684 int face_at_buffer_position
P_ ((struct window
*, int, int, int, int *,
2686 int face_at_string_position
P_ ((struct window
*, Lisp_Object
, int, int, int,
2687 int, int *, enum face_id
, int));
2688 int compute_char_face
P_ ((struct frame
*, int, Lisp_Object
));
2689 void free_all_realized_faces
P_ ((Lisp_Object
));
2690 extern Lisp_Object Qforeground_color
, Qbackground_color
;
2691 extern char unspecified_fg
[], unspecified_bg
[];
2692 void free_realized_multibyte_face
P_ ((struct frame
*, int));
2694 /* Defined in xfns.c */
2696 #ifdef HAVE_X_WINDOWS
2697 void gamma_correct
P_ ((struct frame
*, XColor
*));
2700 void gamma_correct
P_ ((struct frame
*, COLORREF
*));
2703 #ifdef HAVE_WINDOW_SYSTEM
2705 void x_kill_gs_process
P_ ((Pixmap
, struct frame
*));
2706 int x_screen_planes
P_ ((struct frame
*));
2707 void x_implicitly_set_name
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
2708 struct image_cache
*make_image_cache
P_ ((void));
2709 void free_image_cache
P_ ((struct frame
*));
2710 void clear_image_cache
P_ ((struct frame
*, int));
2711 void forall_images_in_image_cache
P_ ((struct frame
*,
2712 void (*) P_ ((struct image
*))));
2713 int valid_image_p
P_ ((Lisp_Object
));
2714 void prepare_image_for_display
P_ ((struct frame
*, struct image
*));
2715 int lookup_image
P_ ((struct frame
*, Lisp_Object
));
2717 #ifdef HAVE_X_WINDOWS
2718 unsigned long image_background
P_ ((struct image
*, struct frame
*,
2720 int image_background_transparent
P_ ((struct image
*, struct frame
*,
2722 #endif /* HAVE_X_WINDOWS */
2724 extern Lisp_Object tip_frame
;
2725 extern Window tip_window
;
2726 EXFUN (Fx_show_tip
, 6);
2727 EXFUN (Fx_hide_tip
, 0);
2728 extern void start_hourglass
P_ ((void));
2729 extern void cancel_hourglass
P_ ((void));
2730 extern int display_hourglass_p
;
2732 /* Returns the background color of IMG, calculating one heuristically if
2733 necessary. If non-zero, XIMG is an existing XImage object to use for
2736 #define IMAGE_BACKGROUND(img, f, ximg) \
2737 ((img)->background_valid \
2738 ? (img)->background \
2739 : image_background (img, f, ximg))
2741 /* Returns true if IMG has a `transparent' background, using heuristics
2742 to decide if necessary. If non-zero, MASK is an existing XImage
2743 object to use for the heuristic. */
2745 #define IMAGE_BACKGROUND_TRANSPARENT(img, f, mask) \
2746 ((img)->background_transparent_valid \
2747 ? (img)->background_transparent \
2748 : image_background_transparent (img, f, mask))
2750 #endif /* HAVE_WINDOW_SYSTEM */
2753 /* Defined in xmenu.c */
2755 int popup_activated
P_ ((void));
2757 /* Defined in dispnew.c */
2759 extern int inverse_video
;
2760 extern int required_matrix_width
P_ ((struct window
*));
2761 extern int required_matrix_height
P_ ((struct window
*));
2762 extern Lisp_Object mode_line_string
P_ ((struct window
*, int, int,
2763 enum window_part
, int *));
2764 extern Lisp_Object marginal_area_string
P_ ((struct window
*, int, int,
2765 enum window_part
, int *));
2766 extern void redraw_frame
P_ ((struct frame
*));
2767 extern void redraw_garbaged_frames
P_ ((void));
2768 extern void cancel_line
P_ ((int, struct frame
*));
2769 extern void init_desired_glyphs
P_ ((struct frame
*));
2770 extern int scroll_frame_lines
P_ ((struct frame
*, int, int, int, int));
2771 extern int direct_output_for_insert
P_ ((int));
2772 extern int direct_output_forward_char
P_ ((int));
2773 extern int update_frame
P_ ((struct frame
*, int, int));
2774 extern int scrolling
P_ ((struct frame
*));
2775 extern void bitch_at_user
P_ ((void));
2776 void adjust_glyphs
P_ ((struct frame
*));
2777 void free_glyphs
P_ ((struct frame
*));
2778 void free_window_matrices
P_ ((struct window
*));
2779 void check_glyph_memory
P_ ((void));
2780 void mirrored_line_dance
P_ ((struct glyph_matrix
*, int, int, int *, char *));
2781 void clear_glyph_matrix
P_ ((struct glyph_matrix
*));
2782 void clear_current_matrices
P_ ((struct frame
*f
));
2783 void clear_desired_matrices
P_ ((struct frame
*));
2784 void shift_glyph_matrix
P_ ((struct window
*, struct glyph_matrix
*,
2786 void rotate_matrix
P_ ((struct glyph_matrix
*, int, int, int));
2787 void increment_matrix_positions
P_ ((struct glyph_matrix
*,
2788 int, int, int, int));
2789 void blank_row
P_ ((struct window
*, struct glyph_row
*, int));
2790 void increment_row_positions
P_ ((struct glyph_row
*, int, int));
2791 void enable_glyph_matrix_rows
P_ ((struct glyph_matrix
*, int, int, int));
2792 void clear_glyph_row
P_ ((struct glyph_row
*));
2793 void prepare_desired_row
P_ ((struct glyph_row
*));
2794 int line_hash_code
P_ ((struct glyph_row
*));
2795 void set_window_update_flags
P_ ((struct window
*, int));
2796 void write_glyphs
P_ ((struct glyph
*, int));
2797 void insert_glyphs
P_ ((struct glyph
*, int));
2798 void redraw_frame
P_ ((struct frame
*));
2799 void redraw_garbaged_frames
P_ ((void));
2800 int scroll_cost
P_ ((struct frame
*, int, int, int));
2801 int direct_output_for_insert
P_ ((int));
2802 int direct_output_forward_char
P_ ((int));
2803 int update_frame
P_ ((struct frame
*, int, int));
2804 void update_single_window
P_ ((struct window
*, int));
2805 int scrolling
P_ ((struct frame
*));
2806 void buffer_posn_from_coords
P_ ((struct window
*, int *, int *,
2807 Lisp_Object
*, struct display_pos
*));
2808 void do_pending_window_change
P_ ((int));
2809 void change_frame_size
P_ ((struct frame
*, int, int, int, int, int));
2810 void bitch_at_user
P_ ((void));
2811 Lisp_Object sit_for
P_ ((int, int, int, int, int));
2812 void init_display
P_ ((void));
2813 void syms_of_display
P_ ((void));
2814 extern Lisp_Object Qredisplay_dont_pause
;
2816 /* Defined in term.c */
2818 extern void ring_bell
P_ ((void));
2819 extern void set_terminal_modes
P_ ((void));
2820 extern void reset_terminal_modes
P_ ((void));
2821 extern void update_begin
P_ ((struct frame
*));
2822 extern void update_end
P_ ((struct frame
*));
2823 extern void set_terminal_window
P_ ((int));
2824 extern void set_scroll_region
P_ ((int, int));
2825 extern void turn_off_insert
P_ ((void));
2826 extern void turn_off_highlight
P_ ((void));
2827 extern void background_highlight
P_ ((void));
2828 extern void clear_frame
P_ ((void));
2829 extern void clear_end_of_line
P_ ((int));
2830 extern void clear_end_of_line_raw
P_ ((int));
2831 extern void delete_glyphs
P_ ((int));
2832 extern void ins_del_lines
P_ ((int, int));
2833 extern int string_cost
P_ ((char *));
2834 extern int per_line_cost
P_ ((char *));
2835 extern void calculate_costs
P_ ((struct frame
*));
2836 extern void set_tty_color_mode
P_ ((struct frame
*, Lisp_Object
));
2837 extern void tty_setup_colors
P_ ((int));
2838 extern void term_init
P_ ((char *));
2839 extern void fatal
P_ ((/* char *, ... */));
2840 void cursor_to
P_ ((int, int));
2841 extern int tty_capable_p
P_ ((struct frame
*, unsigned, unsigned long, unsigned long));
2843 /* Defined in scroll.c */
2845 extern int scrolling_max_lines_saved
P_ ((int, int, int *, int *, int *));
2846 extern int scroll_cost
P_ ((struct frame
*, int, int, int));
2847 extern void do_line_insertion_deletion_costs
P_ ((struct frame
*, char *,
2848 char *, char *, char *,
2849 char *, char *, int));
2850 void scrolling_1
P_ ((struct frame
*, int, int, int, int *, int *, int *,
2853 #endif /* not DISPEXTERN_H_INCLUDED */