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 #ifndef NativeRectangle
68 #define NativeRectangle int
72 /* Structure forward declarations. Some are here because function
73 prototypes below reference structure types before their definition
74 in this file. Some are here because not every file including
75 dispextern.h also includes frame.h and windows.h. */
85 /* Values returned from coordinates_in_window. */
102 /***********************************************************************
104 ***********************************************************************/
106 /* If GLYPH_DEBUG is non-zero, additional checks are activated. Turn
107 it off by defining the macro GLYPH_DEBUG to zero. */
110 #define GLYPH_DEBUG 0
113 /* Macros to include code only if GLYPH_DEBUG != 0. */
116 #define IF_DEBUG(X) X
117 #define xassert(X) do {if (!(X)) abort ();} while (0)
119 #define IF_DEBUG(X) (void) 0
120 #define xassert(X) (void) 0
123 /* Macro for displaying traces of redisplay. If Emacs was compiled
124 with GLYPH_DEBUG != 0, the variable trace_redisplay_p can be set to
125 a non-zero value in debugging sessions to activate traces. */
129 extern int trace_redisplay_p
;
133 if (trace_redisplay_p) \
138 #else /* GLYPH_DEBUG == 0 */
140 #define TRACE(X) (void) 0
142 #endif /* GLYPH_DEBUG == 0 */
146 /***********************************************************************
148 ***********************************************************************/
150 /* Starting with Emacs 20.3, characters from strings and buffers have
151 both a character and a byte position associated with them. The
152 following structure holds such a pair of positions. */
156 /* Character position. */
159 /* Corresponding byte position. */
163 /* Access character and byte position of POS in a functional form. */
165 #define BYTEPOS(POS) (POS).bytepos
166 #define CHARPOS(POS) (POS).charpos
168 /* Set character position of POS to CHARPOS, byte position to BYTEPOS. */
170 #define SET_TEXT_POS(POS, CHARPOS, BYTEPOS) \
171 ((POS).charpos = (CHARPOS), (POS).bytepos = BYTEPOS)
173 /* Increment text position POS. */
175 #define INC_TEXT_POS(POS, MULTIBYTE_P) \
180 INC_POS ((POS).bytepos); \
186 /* Decrement text position POS. */
188 #define DEC_TEXT_POS(POS, MULTIBYTE_P) \
193 DEC_POS ((POS).bytepos); \
199 /* Set text position POS from marker MARKER. */
201 #define SET_TEXT_POS_FROM_MARKER(POS, MARKER) \
202 (CHARPOS (POS) = marker_position ((MARKER)), \
203 BYTEPOS (POS) = marker_byte_position ((MARKER)))
205 /* Set marker MARKER from text position POS. */
207 #define SET_MARKER_FROM_TEXT_POS(MARKER, POS) \
208 set_marker_both ((MARKER), Qnil, CHARPOS ((POS)), BYTEPOS ((POS)))
210 /* Value is non-zero if character and byte positions of POS1 and POS2
213 #define TEXT_POS_EQUAL_P(POS1, POS2) \
214 ((POS1).charpos == (POS2).charpos \
215 && (POS1).bytepos == (POS2).bytepos)
217 /* When rendering glyphs, redisplay scans string or buffer text,
218 overlay strings in that text, and does display table or control
219 character translations. The following structure captures a
220 position taking all this into account. */
224 /* Buffer or string position. */
227 /* If this is a position in an overlay string, overlay_string_index
228 is the index of that overlay string in the sequence of overlay
229 strings at `pos' in the order redisplay processes them. A value
230 < 0 means that this is not a position in an overlay string. */
231 int overlay_string_index
;
233 /* If this is a position in an overlay string, string_pos is the
234 position within that string. */
235 struct text_pos string_pos
;
237 /* If the character at the position above is a control character or
238 has a display table entry, dpvec_index is an index in the display
239 table or control character translation of that character. A
240 value < 0 means this is not a position in such a translation. */
246 /***********************************************************************
248 ***********************************************************************/
250 /* Enumeration of glyph types. Glyph structures contain a type field
251 containing one of the enumerators defined here. */
255 /* Glyph describes a character. */
258 /* Glyph describes a composition sequence. */
261 /* Glyph describes an image. */
264 /* Glyph is a space of fractional width and/or height. */
271 Be extra careful when changing this structure! Esp. make sure that
272 functions producing glyphs, like append_glyph, fill ALL of the
273 glyph structure, and that GLYPH_EQUAL_P compares all
274 display-relevant members of glyphs (not to imply that these are the
275 only things to check when you add a member). */
279 /* Position from which this glyph was drawn. If `object' below is a
280 Lisp string, this is a position in that string. If it is a
281 buffer, this is a position in that buffer. A value of -1
282 together with a null object means glyph is a truncation glyph at
283 the start of a row. */
286 /* Lisp object source of this glyph. Currently either a buffer or
287 a string, if the glyph was produced from characters which came from
288 a buffer or a string; or 0 if the glyph was inserted by redisplay
289 for its own purposes such as padding. */
292 /* Width in pixels. */
295 /* Vertical offset. If < 0, the glyph is displayed raised, if > 0
296 the glyph is displayed lowered. */
299 /* Which kind of glyph this is---character, image etc. Value
300 should be an enumerator of type enum glyph_type. */
303 /* 1 means this glyph was produced from multibyte text. Zero
304 means it was produced from unibyte text, i.e. charsets aren't
305 applicable, and encoding is not performed. */
306 unsigned multibyte_p
: 1;
308 /* Non-zero means draw a box line at the left or right side of this
309 glyph. This is part of the implementation of the face attribute
311 unsigned left_box_line_p
: 1;
312 unsigned right_box_line_p
: 1;
314 /* Non-zero means this glyph's physical ascent or descent is greater
315 than its logical ascent/descent, i.e. it may potentially overlap
316 glyphs above or below it. */
317 unsigned overlaps_vertically_p
: 1;
319 /* 1 means glyph is a padding glyph. Padding glyphs are used for
320 characters whose visual shape consists of more than one glyph
321 (e.g. Asian characters). All but the first glyph of such a glyph
322 sequence have the padding_p flag set. Only used for terminal
323 frames, and there only to minimize code changes. A better way
324 would probably be to use the width field of glyphs to express
326 unsigned padding_p
: 1;
328 /* 1 means the actual glyph is not available, draw a box instead.
329 This can happen when a font couldn't be loaded, or a character
330 doesn't have a glyph in a font. */
331 unsigned glyph_not_available_p
: 1;
333 /* Face of the glyph. */
334 unsigned face_id
: 21;
336 /* Type of font used to display the character glyph. May be used to
337 determine which set of functions to use to obtain font metrics
338 for the glyph. On W32, value should be an enumerator of the type
339 w32_char_font_type. Otherwise it equals FONT_TYPE_UNKNOWN. */
340 unsigned font_type
: 3;
342 /* A union of sub-structures for different glyph types. */
345 /* Character code for character glyphs (type == CHAR_GLYPH). */
348 /* Composition ID for composition glyphs (type == COMPOSITION_GLYPH) */
351 /* Image ID for image glyphs (type == IMAGE_GLYPH). */
354 /* Sub-structure for type == STRETCH_GLYPH. */
357 /* The height of the glyph. */
358 unsigned height
: 16;
360 /* The ascent of the glyph. */
361 unsigned ascent
: 16;
365 /* Used to compare all bit-fields above in one step. */
371 /* Default value of the glyph font_type field. */
373 #define FONT_TYPE_UNKNOWN 0
375 /* Is GLYPH a space? */
377 #define CHAR_GLYPH_SPACE_P(GLYPH) \
378 (GLYPH_FROM_CHAR_GLYPH ((GLYPH)) == SPACEGLYPH)
380 /* Are glyphs *X and *Y displayed equal? */
382 #define GLYPH_EQUAL_P(X, Y) \
383 ((X)->type == (Y)->type \
384 && (X)->u.val == (Y)->u.val \
385 && (X)->face_id == (Y)->face_id \
386 && (X)->padding_p == (Y)->padding_p \
387 && (X)->left_box_line_p == (Y)->left_box_line_p \
388 && (X)->right_box_line_p == (Y)->right_box_line_p \
389 && (X)->voffset == (Y)->voffset \
390 && (X)->pixel_width == (Y)->pixel_width)
392 /* Are character codes, faces, padding_ps of glyphs *X and *Y equal? */
394 #define GLYPH_CHAR_AND_FACE_EQUAL_P(X, Y) \
395 ((X)->u.ch == (Y)->u.ch \
396 && (X)->face_id == (Y)->face_id \
397 && (X)->padding_p == (Y)->padding_p)
399 /* Fill a character glyph GLYPH. CODE, FACE_ID, PADDING_P correspond
400 to the bits defined for the typedef `GLYPH' in lisp.h. */
402 #define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P) \
405 (GLYPH).u.ch = (CODE); \
406 (GLYPH).face_id = (FACE_ID); \
407 (GLYPH).padding_p = (PADDING_P); \
411 /* Fill a character type glyph GLYPH from a glyph typedef FROM as
412 defined in lisp.h. */
414 #define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM) \
415 SET_CHAR_GLYPH ((GLYPH), \
416 FAST_GLYPH_CHAR ((FROM)), \
417 FAST_GLYPH_FACE ((FROM)), \
420 /* Construct a glyph code from a character glyph GLYPH. If the
421 character is multibyte, return -1 as we can't use glyph table for a
422 multibyte character. */
424 #define GLYPH_FROM_CHAR_GLYPH(GLYPH) \
425 ((GLYPH).u.ch < 256 \
426 ? ((GLYPH).u.ch | ((GLYPH).face_id << CHARACTERBITS)) \
429 /* Is GLYPH a padding glyph? */
431 #define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p
436 /***********************************************************************
438 ***********************************************************************/
442 Glyph memory for frame-based redisplay is allocated from the heap
443 in one vector kept in a glyph pool structure which is stored with
444 the frame. The size of the vector is made large enough to cover
445 all windows on the frame.
447 Both frame and window glyph matrices reference memory from a glyph
448 pool in frame-based redisplay.
450 In window-based redisplay, no glyphs pools exist; windows allocate
451 and free their glyph memory themselves. */
455 /* Vector of glyphs allocated from the heap. */
456 struct glyph
*glyphs
;
458 /* Allocated size of `glyphs'. */
461 /* Number of rows and columns in a matrix. */
467 /***********************************************************************
469 ***********************************************************************/
473 Three kinds of glyph matrices exist:
475 1. Frame glyph matrices. These are used for terminal frames whose
476 redisplay needs a view of the whole screen due to limited terminal
477 capabilities. Frame matrices are used only in the update phase
478 of redisplay. They are built in update_frame and not used after
479 the update has been performed.
481 2. Window glyph matrices on frames having frame glyph matrices.
482 Such matrices are sub-matrices of their corresponding frame matrix,
483 i.e. frame glyph matrices and window glyph matrices share the same
484 glyph memory which is allocated in form of a glyph_pool structure.
485 Glyph rows in such a window matrix are slices of frame matrix rows.
487 2. Free-standing window glyph matrices managing their own glyph
488 storage. This form is used in window-based redisplay which
489 includes variable width and height fonts etc.
491 The size of a window's row vector depends on the height of fonts
492 defined on its frame. It is chosen so that the vector is large
493 enough to describe all lines in a window when it is displayed in
494 the smallest possible character size. When new fonts are loaded,
495 or window sizes change, the row vector is adjusted accordingly. */
499 /* The pool from which glyph memory is allocated, if any. This is
500 null for frame matrices and for window matrices managing their
502 struct glyph_pool
*pool
;
504 /* Vector of glyph row structures. The row at nrows - 1 is reserved
505 for the mode line. */
506 struct glyph_row
*rows
;
508 /* Number of elements allocated for the vector rows above. */
511 /* The number of rows used by the window if all lines were displayed
512 with the smallest possible character height. */
515 /* Origin within the frame matrix if this is a window matrix on a
516 frame having a frame matrix. Both values are zero for
517 window-based redisplay. */
518 int matrix_x
, matrix_y
;
520 /* Width and height of the matrix in columns and rows. */
521 int matrix_w
, matrix_h
;
523 /* If this structure describes a window matrix of window W,
524 window_left_x is the value of W->left, window_top_y the value of
525 W->top, window_height and window_width are width and height of W,
526 as returned by window_box, and window_vscroll is the value of
527 W->vscroll at the time the matrix was last adjusted. Only set
528 for window-based redisplay. */
529 int window_left_x
, window_top_y
, window_height
, window_width
, window_vscroll
;
531 /* Number of glyphs reserved for left and right marginal areas when
532 the matrix was last adjusted. */
533 int left_margin_glyphs
, right_margin_glyphs
;
535 /* Flag indicating that scrolling should not be tried in
536 update_window. This flag is set by functions like try_window_id
537 which do their own scrolling. */
538 unsigned no_scrolling_p
: 1;
540 /* Non-zero means window displayed in this matrix has a top mode
542 unsigned header_line_p
: 1;
545 /* A string identifying the method used to display the matrix. */
549 /* The buffer this matrix displays. Set in
550 mark_window_display_accurate_1. */
551 struct buffer
*buffer
;
553 /* Values of BEGV and ZV as of last redisplay. Set in
554 mark_window_display_accurate_1. */
559 /* Check that glyph pointers stored in glyph rows of MATRIX are okay.
560 This aborts if any pointer is found twice. */
563 void check_matrix_pointer_lossage
P_ ((struct glyph_matrix
*));
564 #define CHECK_MATRIX(MATRIX) check_matrix_pointer_lossage ((MATRIX))
566 #define CHECK_MATRIX(MATRIX) (void) 0
571 /***********************************************************************
573 ***********************************************************************/
575 /* Area in window glyph matrix. If values are added or removed, the
576 function mark_object in alloc.c has to be changed. */
587 /* Rows of glyphs in a windows or frame glyph matrix.
589 Each row is partitioned into three areas. The start and end of
590 each area is recorded in a pointer as shown below.
592 +--------------------+-------------+---------------------+
593 | left margin area | text area | right margin area |
594 +--------------------+-------------+---------------------+
596 glyphs[LEFT_MARGIN_AREA] glyphs[RIGHT_MARGIN_AREA]
601 Rows in frame matrices reference glyph memory allocated in a frame
602 glyph pool (see the description of struct glyph_pool). Rows in
603 window matrices on frames having frame matrices reference slices of
604 the glyphs of corresponding rows in the frame matrix.
606 Rows in window matrices on frames having no frame matrices point to
607 glyphs allocated from the heap via xmalloc;
608 glyphs[LEFT_MARGIN_AREA] is the start address of the allocated
609 glyph structure array. */
613 /* Pointers to beginnings of areas. The end of an area A is found at
614 A + 1 in the vector. The last element of the vector is the end
617 Kludge alert: Even if used[TEXT_AREA] == 0, glyphs[TEXT_AREA][0]'s
618 position field is used. It is -1 if this row does not correspond
619 to any text; it is some buffer position if the row corresponds to
620 an empty display line that displays a line end. This is what old
621 redisplay used to do. (Except in code for terminal frames, this
622 kludge is no longer used, I believe. --gerd).
624 See also start, end, displays_text_p and ends_at_zv_p for cleaner
625 ways to do it. The special meaning of positions 0 and -1 will be
626 removed some day, so don't use it in new code. */
627 struct glyph
*glyphs
[1 + LAST_AREA
];
629 /* Number of glyphs actually filled in areas. */
630 short used
[LAST_AREA
];
632 /* Window-relative x and y-position of the top-left corner of this
633 row. If y < 0, this means that abs (y) pixels of the row are
634 invisible because it is partially visible at the top of a window.
635 If x < 0, this means that abs (x) pixels of the first glyph of
636 the text area of the row are invisible because the glyph is
637 partially visible. */
640 /* Width of the row in pixels without taking face extension at the
641 end of the row into account, and without counting truncation
642 and continuation glyphs at the end of a row on ttys. */
645 /* Logical ascent/height of this line. The value of ascent is zero
646 and height is 1 on terminal frames. */
649 /* Physical ascent/height of this line. If max_ascent > ascent,
650 this line overlaps the line above it on the display. Otherwise,
651 if max_height > height, this line overlaps the line beneath it. */
652 int phys_ascent
, phys_height
;
654 /* Portion of row that is visible. Partially visible rows may be
655 found at the top and bottom of a window. This is 1 for tty
656 frames. It may be < 0 in case of completely invisible rows. */
659 /* Hash code. This hash code is available as soon as the row
660 is constructed, i.e. after a call to display_line. */
663 /* First position in this row. This is the text position, including
664 overlay position information etc, where the display of this row
665 started, and can thus be less the position of the first glyph
666 (e.g. due to invisible text or horizontal scrolling). */
667 struct display_pos start
;
669 /* Text position at the end of this row. This is the position after
670 the last glyph on this row. It can be greater than the last
671 glyph position + 1, due to truncation, invisible text etc. In an
672 up-to-date display, this should always be equal to the start
673 position of the next row. */
674 struct display_pos end
;
676 /* In a desired matrix, 1 means that this row must be updated. In a
677 current matrix, 0 means that the row has been invalidated, i.e.
678 the row's contents do not agree with what is visible on the
680 unsigned enabled_p
: 1;
682 /* 1 means row displays a text line that is truncated on the left or
684 unsigned truncated_on_left_p
: 1;
685 unsigned truncated_on_right_p
: 1;
687 /* 1 means the overlay arrow is on this line. */
688 unsigned overlay_arrow_p
: 1;
690 /* 1 means that this row displays a continued line, i.e. it has a
691 continuation mark at the right side. */
692 unsigned continued_p
: 1;
694 /* 0 means that this row does not contain any text, i.e. it is
695 a blank line at the window and buffer end. */
696 unsigned displays_text_p
: 1;
698 /* 1 means that this line ends at ZV. */
699 unsigned ends_at_zv_p
: 1;
701 /* 1 means the face of the last glyph in the text area is drawn to
702 the right end of the window. This flag is used in
703 update_text_area to optimize clearing to the end of the area. */
704 unsigned fill_line_p
: 1;
706 /* Non-zero means display a bitmap on X frames indicating that this
707 line contains no text and ends in ZV. */
708 unsigned indicate_empty_line_p
: 1;
710 /* 1 means this row contains glyphs that overlap each other because
711 of lbearing or rbearing. */
712 unsigned contains_overlapping_glyphs_p
: 1;
714 /* 1 means this row is as wide as the window it is displayed in, including
715 scroll bars, fringes, and internal borders. This also
716 implies that the row doesn't have marginal areas. */
717 unsigned full_width_p
: 1;
719 /* Non-zero means row is a mode or header-line. */
720 unsigned mode_line_p
: 1;
722 /* 1 in a current row means this row is overlapped by another row. */
723 unsigned overlapped_p
: 1;
725 /* 1 means this line ends in the middle of a character consisting
726 of more than one glyph. Some glyphs have been put in this row,
727 the rest are put in rows below this one. */
728 unsigned ends_in_middle_of_char_p
: 1;
730 /* 1 means this line starts in the middle of a character consisting
731 of more than one glyph. Some glyphs have been put in the
732 previous row, the rest are put in this row. */
733 unsigned starts_in_middle_of_char_p
: 1;
735 /* 1 in a current row means this row overlaps others. */
736 unsigned overlapping_p
: 1;
738 /* 1 means some glyphs in this row are displayed in mouse-face. */
739 unsigned mouse_face_p
: 1;
741 /* 1 means this row was ended by a newline from a string. */
742 unsigned ends_in_newline_from_string_p
: 1;
744 /* Continuation lines width at the start of the row. */
745 int continuation_lines_width
;
749 /* Get a pointer to row number ROW in matrix MATRIX. If GLYPH_DEBUG
750 is defined to a non-zero value, the function matrix_row checks that
751 we don't try to access rows that are out of bounds. */
754 struct glyph_row
*matrix_row
P_ ((struct glyph_matrix
*, int));
755 #define MATRIX_ROW(MATRIX, ROW) matrix_row ((MATRIX), (ROW))
757 #define MATRIX_ROW(MATRIX, ROW) ((MATRIX)->rows + (ROW))
760 /* Return a pointer to the row reserved for the mode line in MATRIX.
761 Row MATRIX->nrows - 1 is always reserved for the mode line. */
763 #define MATRIX_MODE_LINE_ROW(MATRIX) \
764 ((MATRIX)->rows + (MATRIX)->nrows - 1)
766 /* Return a pointer to the row reserved for the header line in MATRIX.
767 This is always the first row in MATRIX because that's the only
768 way that works in frame-based redisplay. */
770 #define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows
772 /* Return a pointer to first row in MATRIX used for text display. */
774 #define MATRIX_FIRST_TEXT_ROW(MATRIX) \
775 ((MATRIX)->rows->mode_line_p ? (MATRIX)->rows + 1 : (MATRIX)->rows)
777 /* Return a pointer to the first glyph in the text area of a row.
778 MATRIX is the glyph matrix accessed, and ROW is the row index in
781 #define MATRIX_ROW_GLYPH_START(MATRIX, ROW) \
782 (MATRIX_ROW ((MATRIX), (ROW))->glyphs[TEXT_AREA])
784 /* Return the number of used glyphs in the text area of a row. */
786 #define MATRIX_ROW_USED(MATRIX, ROW) \
787 (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA])
789 /* Return the character/ byte position at which the display of ROW
792 #define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->start.pos.charpos)
793 #define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->start.pos.bytepos)
795 /* Return the character/ byte position at which ROW ends. */
797 #define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->end.pos.charpos)
798 #define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->end.pos.bytepos)
800 /* Return the vertical position of ROW in MATRIX. */
802 #define MATRIX_ROW_VPOS(ROW, MATRIX) ((ROW) - (MATRIX)->rows)
804 /* Return the last glyph row + 1 in MATRIX on window W reserved for
805 text. If W has a mode line, the last row in the matrix is reserved
808 #define MATRIX_BOTTOM_TEXT_ROW(MATRIX, W) \
811 - (WINDOW_WANTS_MODELINE_P ((W)) ? 1 : 0))
813 /* Non-zero if the face of the last glyph in ROW's text area has
814 to be drawn to the end of the text area. */
816 #define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)
818 /* Set and query the enabled_p flag of glyph row ROW in MATRIX. */
820 #define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
821 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0)
823 #define MATRIX_ROW_ENABLED_P(MATRIX, ROW) \
824 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p)
826 /* Non-zero if ROW displays text. Value is non-zero if the row is
827 blank but displays a line end. */
829 #define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)
831 /* Non-zero if ROW is not completely visible in window W. */
833 #define MATRIX_ROW_PARTIALLY_VISIBLE_P(ROW) \
834 ((ROW)->height != (ROW)->visible_height)
836 /* Non-zero if ROW is partially visible at the top of window W. */
838 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW) \
839 (MATRIX_ROW_PARTIALLY_VISIBLE_P ((ROW)) \
840 && (ROW)->y < WINDOW_DISPLAY_HEADER_LINE_HEIGHT ((W)))
842 /* Non-zero if ROW is partially visible at the bottom of window W. */
844 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW) \
845 (MATRIX_ROW_PARTIALLY_VISIBLE_P ((ROW)) \
846 && (ROW)->y + (ROW)->height > WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE ((W)))
848 /* Return the bottom Y + 1 of ROW. */
850 #define MATRIX_ROW_BOTTOM_Y(ROW) ((ROW)->y + (ROW)->height)
852 /* Is ROW the last visible one in the display described by the
853 iterator structure pointed to by IT?. */
855 #define MATRIX_ROW_LAST_VISIBLE_P(ROW, IT) \
856 (MATRIX_ROW_BOTTOM_Y ((ROW)) >= (IT)->last_visible_y)
858 /* Non-zero if ROW displays a continuation line. */
860 #define MATRIX_ROW_CONTINUATION_LINE_P(ROW) \
861 ((ROW)->continuation_lines_width > 0)
863 /* Non-zero if ROW ends in the middle of a character. This is the
864 case for continued lines showing only part of a display table entry
865 or a control char, or an overlay string. */
867 #define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW) \
868 ((ROW)->end.dpvec_index >= 0 \
869 || (ROW)->end.overlay_string_index >= 0 \
870 || (ROW)->ends_in_middle_of_char_p)
872 /* Non-zero if ROW ends in the middle of an overlay string. */
874 #define MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P(ROW) \
875 ((ROW)->end.overlay_string_index >= 0)
877 /* Non-zero if ROW starts in the middle of a character. See above. */
879 #define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW) \
880 ((ROW)->start.dpvec_index >= 0 \
881 || (ROW)->starts_in_middle_of_char_p \
882 || ((ROW)->start.overlay_string_index >= 0 \
883 && (ROW)->start.string_pos.charpos > 0))
885 /* Non-zero means ROW overlaps its predecessor. */
887 #define MATRIX_ROW_OVERLAPS_PRED_P(ROW) \
888 ((ROW)->phys_ascent > (ROW)->ascent)
890 /* Non-zero means ROW overlaps its successor. */
892 #define MATRIX_ROW_OVERLAPS_SUCC_P(ROW) \
893 ((ROW)->phys_height - (ROW)->phys_ascent \
894 > (ROW)->height - (ROW)->ascent)
896 /* Non-zero means that fonts have been loaded since the last glyph
897 matrix adjustments. The function redisplay_internal adjusts glyph
898 matrices when this flag is non-zero. */
900 extern int fonts_changed_p
;
902 /* A glyph for a space. */
904 extern struct glyph space_glyph
;
906 /* Frame being updated by update_window/update_frame. */
908 extern struct frame
*updating_frame
;
910 /* Window being updated by update_window. This is non-null as long as
911 update_window has not finished, and null otherwise. It's role is
912 analogous to updating_frame. */
914 extern struct window
*updated_window
;
916 /* Glyph row and area updated by update_window_line. */
918 extern struct glyph_row
*updated_row
;
919 extern int updated_area
;
921 /* Non-zero means reading single-character input with prompt so put
922 cursor on mini-buffer after the prompt. Positive means at end of
923 text in echo area; negative means at beginning of line. */
925 extern int cursor_in_echo_area
;
927 /* Non-zero means last display completed. Zero means it was
930 extern int display_completed
;
932 /* Non-zero means redisplay has been performed directly (see also
933 direct_output_for_insert and direct_output_forward_char), so that
934 no further updating has to be performed. The function
935 redisplay_internal checks this flag, and does nothing but reset it
936 to zero if it is non-zero. */
938 extern int redisplay_performed_directly_p
;
940 /* A temporary storage area, including a row of glyphs. Initialized
941 in xdisp.c. Used for various purposes, as an example see
942 direct_output_for_insert. */
944 extern struct glyph_row scratch_glyph_row
;
948 /************************************************************************
950 ************************************************************************/
952 /* Enumeration for overriding/changing the face to use for drawing
953 glyphs in draw_glyphs. */
955 enum draw_glyphs_face
965 #ifdef HAVE_WINDOW_SYSTEM
967 /* A sequence of glyphs to be drawn in the same face. */
971 /* X-origin of the string. */
974 /* Y-origin and y-position of the base line of this string. */
977 /* The width of the string, not including a face extension. */
980 /* The width of the string, including a face extension. */
981 int background_width
;
983 /* The height of this string. This is the height of the line this
984 string is drawn in, and can be different from the height of the
985 font the string is drawn in. */
988 /* Number of pixels this string overwrites in front of its x-origin.
989 This number is zero if the string has an lbearing >= 0; it is
990 -lbearing, if the string has an lbearing < 0. */
993 /* Number of pixels this string overwrites past its right-most
994 nominal x-position, i.e. x + width. Zero if the string's
995 rbearing is <= its nominal width, rbearing - width otherwise. */
998 /* The frame on which the glyph string is drawn. */
1001 /* The window on which the glyph string is drawn. */
1004 /* X display and window for convenience. */
1008 /* The glyph row for which this string was built. It determines the
1009 y-origin and height of the string. */
1010 struct glyph_row
*row
;
1012 /* The area within row. */
1013 enum glyph_row_area area
;
1015 /* Characters to be drawn, and number of characters. */
1019 /* A face-override for drawing cursors, mouse face and similar. */
1020 enum draw_glyphs_face hl
;
1022 /* Face in which this string is to be drawn. */
1025 /* Font in which this string is to be drawn. */
1028 /* Font info for this string. */
1029 struct font_info
*font_info
;
1031 /* Non-null means this string describes (part of) a composition.
1032 All characters from char2b are drawn composed. */
1033 struct composition
*cmp
;
1035 /* Index of this glyph string's first character in the glyph
1036 definition of CMP. If this is zero, this glyph string describes
1037 the first character of a composition. */
1040 /* 1 means this glyph strings face has to be drawn to the right end
1041 of the window's drawing area. */
1042 unsigned extends_to_end_of_line_p
: 1;
1044 /* 1 means the background of this string has been drawn. */
1045 unsigned background_filled_p
: 1;
1047 /* 1 means glyph string must be drawn with 16-bit functions. */
1048 unsigned two_byte_p
: 1;
1050 /* 1 means that the original font determined for drawing this glyph
1051 string could not be loaded. The member `font' has been set to
1052 the frame's default font in this case. */
1053 unsigned font_not_found_p
: 1;
1055 /* 1 means that the face in which this glyph string is drawn has a
1057 unsigned stippled_p
: 1;
1059 /* 1 means only the foreground of this glyph string must be drawn,
1060 and we should use the physical height of the line this glyph
1061 string appears in as clip rect. */
1062 unsigned for_overlaps_p
: 1;
1064 /* The GC to use for drawing this glyph string. */
1065 #if defined(HAVE_X_WINDOWS) || defined(HAVE_CARBON)
1068 #if defined(HAVE_NTGUI)
1073 /* A pointer to the first glyph in the string. This glyph
1074 corresponds to char2b[0]. Needed to draw rectangles if
1075 font_not_found_p is 1. */
1076 struct glyph
*first_glyph
;
1078 /* Image, if any. */
1081 struct glyph_string
*next
, *prev
;
1084 #endif /* HAVE_WINDOW_SYSTEM */
1087 /************************************************************************
1089 ************************************************************************/
1091 /* Return the height of the mode line in glyph matrix MATRIX, or zero
1092 if not known. This macro is called under circumstances where
1093 MATRIX might not have been allocated yet. */
1095 #define MATRIX_MODE_LINE_HEIGHT(MATRIX) \
1096 ((MATRIX) && (MATRIX)->rows \
1097 ? MATRIX_MODE_LINE_ROW (MATRIX)->height \
1100 /* Return the height of the header line in glyph matrix MATRIX, or zero
1101 if not known. This macro is called under circumstances where
1102 MATRIX might not have been allocated yet. */
1104 #define MATRIX_HEADER_LINE_HEIGHT(MATRIX) \
1105 ((MATRIX) && (MATRIX)->rows \
1106 ? MATRIX_HEADER_LINE_ROW (MATRIX)->height \
1109 /* Return the desired face id for the mode line of a window, depending
1110 on whether the window is selected or not, or if the window is the
1111 scrolling window for the currently active minibuffer window.
1113 Due to the way display_mode_lines manipulates with the contents of
1114 selected_window, this macro needs three arguments: SELW which is
1115 compared against the current value of selected_window, MBW which is
1116 compared against minibuf_window (if SELW doesn't match), and SCRW
1117 which is compared against minibuf_selected_window (if MBW matches). */
1119 #define CURRENT_MODE_LINE_FACE_ID_3(SELW, MBW, SCRW) \
1120 ((!mode_line_in_non_selected_windows \
1121 || (SELW) == XWINDOW (selected_window) \
1122 || (minibuf_level > 0 \
1123 && !NILP (minibuf_selected_window) \
1124 && (MBW) == XWINDOW (minibuf_window) \
1125 && (SCRW) == XWINDOW (minibuf_selected_window))) \
1126 ? MODE_LINE_FACE_ID \
1127 : MODE_LINE_INACTIVE_FACE_ID)
1130 /* Return the desired face id for the mode line of window W. */
1132 #define CURRENT_MODE_LINE_FACE_ID(W) \
1133 (CURRENT_MODE_LINE_FACE_ID_3((W), XWINDOW (selected_window), (W)))
1135 /* Return the current height of the mode line of window W. If not
1136 known from current_mode_line_height, look at W's current glyph
1137 matrix, or return a default based on the height of the font of the
1138 face `mode-line'. */
1140 #define CURRENT_MODE_LINE_HEIGHT(W) \
1141 (current_mode_line_height >= 0 \
1142 ? current_mode_line_height \
1143 : (MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1144 ? MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1145 : estimate_mode_line_height (XFRAME ((W)->frame), \
1146 CURRENT_MODE_LINE_FACE_ID (W))))
1148 /* Return the current height of the header line of window W. If not
1149 known from current_header_line_height, look at W's current glyph
1150 matrix, or return an estimation based on the height of the font of
1151 the face `header-line'. */
1153 #define CURRENT_HEADER_LINE_HEIGHT(W) \
1154 (current_header_line_height >= 0 \
1155 ? current_header_line_height \
1156 : (MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1157 ? MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1158 : estimate_mode_line_height (XFRAME ((W)->frame), \
1159 HEADER_LINE_FACE_ID)))
1161 /* Return the height of the desired mode line of window W. */
1163 #define DESIRED_MODE_LINE_HEIGHT(W) \
1164 MATRIX_MODE_LINE_HEIGHT ((W)->desired_matrix)
1166 /* Return the height of the desired header line of window W. */
1168 #define DESIRED_HEADER_LINE_HEIGHT(W) \
1169 MATRIX_HEADER_LINE_HEIGHT ((W)->desired_matrix)
1171 /* Like FRAME_INTERNAL_BORDER_WIDTH but checks whether frame F is a
1172 window-system frame. */
1174 #define FRAME_INTERNAL_BORDER_WIDTH_SAFE(F) \
1175 (FRAME_WINDOW_P (F) ? FRAME_INTERNAL_BORDER_WIDTH (F) : 0)
1177 /* Width of display region of window W. For terminal frames, this
1178 equals the width of W since there are no vertical scroll bars. For
1179 window system frames, the value has to be corrected by the pixel
1180 width of vertical scroll bars, and fringes. */
1182 #define WINDOW_DISPLAY_PIXEL_WIDTH(W) \
1183 (((XFASTINT ((W)->width) \
1184 - FRAME_SCROLL_BAR_WIDTH (XFRAME (WINDOW_FRAME ((W)))) \
1185 - FRAME_FRINGE_COLS (XFRAME (WINDOW_FRAME ((W))))) \
1186 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))))
1188 /* Height of the display region of W, including a mode line, if any. */
1190 #define WINDOW_DISPLAY_PIXEL_HEIGHT(W) \
1191 (XFASTINT ((W)->height) \
1192 * CANON_Y_UNIT (XFRAME (WINDOW_FRAME ((W)))))
1194 /* Height in pixels of the mode line. May be zero if W doesn't have a
1197 #define WINDOW_DISPLAY_MODE_LINE_HEIGHT(W) \
1198 (WINDOW_WANTS_MODELINE_P ((W)) \
1199 ? CURRENT_MODE_LINE_HEIGHT (W) \
1202 /* Height in pixels of the header line. Zero if W doesn't have a header
1205 #define WINDOW_DISPLAY_HEADER_LINE_HEIGHT(W) \
1206 (WINDOW_WANTS_HEADER_LINE_P ((W)) \
1207 ? CURRENT_HEADER_LINE_HEIGHT (W) \
1210 /* Pixel height of window W without mode line. */
1212 #define WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE(W) \
1213 (WINDOW_DISPLAY_PIXEL_HEIGHT ((W)) \
1214 - WINDOW_DISPLAY_MODE_LINE_HEIGHT ((W)))
1216 /* Pixel height of window W without mode and header line. */
1218 #define WINDOW_DISPLAY_TEXT_HEIGHT(W) \
1219 (WINDOW_DISPLAY_PIXEL_HEIGHT ((W)) \
1220 - WINDOW_DISPLAY_MODE_LINE_HEIGHT ((W)) \
1221 - WINDOW_DISPLAY_HEADER_LINE_HEIGHT ((W)))
1223 /* Left edge of W in pixels relative to its frame. */
1225 #define WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X(W) \
1226 (FRAME_INTERNAL_BORDER_WIDTH_SAFE (XFRAME (WINDOW_FRAME ((W)))) \
1227 + (WINDOW_LEFT_MARGIN ((W)) \
1228 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))) \
1229 + FRAME_LEFT_FRINGE_WIDTH (XFRAME (WINDOW_FRAME ((W)))))
1231 /* Right edge of window W in pixels, relative to its frame. */
1233 #define WINDOW_DISPLAY_RIGHT_EDGE_PIXEL_X(W) \
1234 (WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X ((W)) \
1235 + WINDOW_DISPLAY_PIXEL_WIDTH ((W)))
1237 /* Top edge of W in pixels relative to its frame. */
1239 #define WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y(W) \
1240 (FRAME_INTERNAL_BORDER_WIDTH_SAFE (XFRAME (WINDOW_FRAME ((W)))) \
1241 + (XFASTINT ((W)->top) \
1242 * CANON_Y_UNIT (XFRAME (WINDOW_FRAME ((W))))))
1244 /* Bottom edge of window W relative to its frame. */
1246 #define WINDOW_DISPLAY_BOTTOM_EDGE_PIXEL_Y(W) \
1247 (WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y ((W)) \
1248 + WINDOW_DISPLAY_PIXEL_HEIGHT ((W)))
1250 /* Convert window W relative pixel X to frame pixel coordinates. */
1252 #define WINDOW_TO_FRAME_PIXEL_X(W, X) \
1253 ((X) + WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X ((W)))
1255 /* Convert window W relative pixel Y to frame pixel coordinates. */
1257 #define WINDOW_TO_FRAME_PIXEL_Y(W, Y) \
1258 ((Y) + WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y ((W)))
1260 /* Convert frame relative pixel X to window relative pixel X. */
1262 #define FRAME_TO_WINDOW_PIXEL_X(W, X) \
1263 ((X) - WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X ((W)))
1265 /* Convert frame relative pixel Y to window relative pixel Y. */
1267 #define FRAME_TO_WINDOW_PIXEL_Y(W, Y) \
1268 ((Y) - WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y ((W)))
1270 /* Width of left margin area in pixels. */
1272 #define WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH(W) \
1273 (NILP ((W)->left_margin_width) \
1275 : (XINT ((W)->left_margin_width) \
1276 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))))
1278 /* Width of right marginal area in pixels. */
1280 #define WINDOW_DISPLAY_RIGHT_AREA_PIXEL_WIDTH(W) \
1281 (NILP ((W)->right_margin_width) \
1283 : (XINT ((W)->right_margin_width) \
1284 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))))
1286 /* Width of text area in pixels. */
1288 #define WINDOW_DISPLAY_TEXT_AREA_PIXEL_WIDTH(W) \
1289 (WINDOW_DISPLAY_PIXEL_WIDTH ((W)) \
1290 - WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)) \
1291 - WINDOW_DISPLAY_RIGHT_AREA_PIXEL_WIDTH ((W)))
1293 /* Convert a text area relative x-position in window W to frame X
1294 pixel coordinates. */
1296 #define WINDOW_TEXT_TO_FRAME_PIXEL_X(W, X) \
1297 (WINDOW_TO_FRAME_PIXEL_X ((W), (X)) \
1298 + WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)))
1300 /* Translate an x-position relative to AREA in window W to frame pixel
1303 #define WINDOW_AREA_TO_FRAME_PIXEL_X(W, AREA, X) \
1304 (WINDOW_TO_FRAME_PIXEL_X ((W), (X)) \
1305 + (((AREA) > LEFT_MARGIN_AREA) \
1306 ? WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)) \
1308 + (((AREA) > TEXT_AREA) \
1309 ? WINDOW_DISPLAY_TEXT_AREA_PIXEL_WIDTH ((W)) \
1312 /* Return the pixel width of AREA in W. */
1314 #define WINDOW_AREA_PIXEL_WIDTH(W, AREA) \
1315 (((AREA) == TEXT_AREA) \
1316 ? WINDOW_DISPLAY_TEXT_AREA_PIXEL_WIDTH ((W)) \
1317 : (((AREA) == LEFT_MARGIN_AREA) \
1318 ? WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)) \
1319 : WINDOW_DISPLAY_RIGHT_AREA_PIXEL_WIDTH ((W))))
1321 /* Value is non-zero if window W wants a mode line. */
1323 #define WINDOW_WANTS_MODELINE_P(W) \
1324 (!MINI_WINDOW_P ((W)) \
1325 && !(W)->pseudo_window_p \
1326 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1327 && BUFFERP ((W)->buffer) \
1328 && !NILP (XBUFFER ((W)->buffer)->mode_line_format) \
1329 && XFASTINT ((W)->height) > 1)
1331 /* Value is non-zero if window W wants a header line. */
1333 #define WINDOW_WANTS_HEADER_LINE_P(W) \
1334 (!MINI_WINDOW_P ((W)) \
1335 && !(W)->pseudo_window_p \
1336 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1337 && BUFFERP ((W)->buffer) \
1338 && !NILP (XBUFFER ((W)->buffer)->header_line_format) \
1339 && XFASTINT ((W)->height) > 1 + !NILP (XBUFFER ((W)->buffer)->mode_line_format))
1342 /* Return proper value to be used as baseline offset of font that has
1343 ASCENT and DESCENT to draw characters by the font at the vertical
1344 center of the line of frame F.
1346 Here, our task is to find the value of BOFF in the following figure;
1348 -------------------------+-----------+-
1349 -+-+---------+-+ | |
1351 | | | | F_ASCENT F_HEIGHT
1354 | | |-|-+------+-----------|------- baseline
1356 | |---------|-+-+ | |
1358 -+-+---------+-+ F_DESCENT |
1359 -------------------------+-----------+-
1361 -BOFF + DESCENT + (F_HEIGHT - HEIGHT) / 2 = F_DESCENT
1362 BOFF = DESCENT + (F_HEIGHT - HEIGHT) / 2 - F_DESCENT
1363 DESCENT = FONT->descent
1364 HEIGHT = FONT_HEIGHT (FONT)
1365 F_DESCENT = (F->output_data.x->font->descent
1366 - F->output_data.x->baseline_offset)
1367 F_HEIGHT = FRAME_LINE_HEIGHT (F)
1370 #define VCENTER_BASELINE_OFFSET(FONT, F) \
1371 (FONT_DESCENT (FONT) \
1372 + (FRAME_LINE_HEIGHT ((F)) - FONT_HEIGHT ((FONT)) \
1373 + (FRAME_LINE_HEIGHT ((F)) > FONT_HEIGHT ((FONT)))) / 2 \
1374 - (FONT_DESCENT (FRAME_FONT (F)) - FRAME_BASELINE_OFFSET (F)))
1377 /***********************************************************************
1379 ***********************************************************************/
1381 /* Indices of face attributes in Lisp face vectors. Slot zero is the
1384 enum lface_attribute_index
1386 LFACE_FAMILY_INDEX
= 1,
1391 LFACE_UNDERLINE_INDEX
,
1392 LFACE_INVERSE_INDEX
,
1393 LFACE_FOREGROUND_INDEX
,
1394 LFACE_BACKGROUND_INDEX
,
1395 LFACE_STIPPLE_INDEX
,
1396 LFACE_OVERLINE_INDEX
,
1397 LFACE_STRIKE_THROUGH_INDEX
,
1400 LFACE_INHERIT_INDEX
,
1401 LFACE_AVGWIDTH_INDEX
,
1406 /* Box types of faces. */
1410 /* No box around text. */
1413 /* Simple box of specified width and color. Default width is 1, and
1414 default color is the foreground color of the face. */
1417 /* Boxes with 3D shadows. Color equals the background color of the
1418 face. Width is specified. */
1424 /* Structure describing a realized face.
1426 For each Lisp face, 0..N realized faces can exist for different
1427 frames and different charsets. Realized faces are built from Lisp
1428 faces and text properties/overlays by merging faces and adding
1429 unspecified attributes from the `default' face. */
1433 /* The id of this face. The id equals the index of this face in the
1434 vector faces_by_id of its face cache. */
1437 #ifdef HAVE_WINDOW_SYSTEM
1439 /* If non-zero, this is a GC that we can use without modification for
1440 drawing the characters in this face. */
1443 /* Font used for this face, or null if the font could not be loaded
1444 for some reason. This points to a `font' slot of a struct
1445 font_info, and we should not call XFreeFont on it because the
1446 font may still be used somewhere else. */
1449 /* Background stipple or bitmap used for this face. This is
1450 an id as returned from load_pixmap. */
1453 #else /* not HAVE_WINDOW_SYSTEM */
1458 #endif /* not HAVE_WINDOW_SYSTEM */
1460 /* Pixel value of foreground color for X frames. Color index
1462 unsigned long foreground
;
1464 /* Pixel value or color index of background color. */
1465 unsigned long background
;
1467 /* Pixel value or color index of underline color. */
1468 unsigned long underline_color
;
1470 /* Pixel value or color index of overlined, strike-through, or box
1472 unsigned long overline_color
;
1473 unsigned long strike_through_color
;
1474 unsigned long box_color
;
1476 /* The font's name. This points to a `name' of a font_info, and it
1477 must not be freed. */
1480 /* Font info ID for this face's font. An ID is stored here because
1481 pointers to font_info structures may change. The reason is that
1482 they are pointers into a font table vector that is itself
1486 /* Fontset ID if this face uses a fontset, or -1. This is only >= 0
1487 if the face was realized for a composition sequence.
1488 Otherwise, a specific font is loaded from the set of fonts
1489 specified by the fontset given by the family attribute of the face. */
1492 /* Pixmap width and height. */
1493 unsigned int pixmap_w
, pixmap_h
;
1495 /* Non-zero means characters in this face have a box that thickness
1496 around them. If it is negative, the absolute value indicates the
1497 thickness, and the horizontal lines of box (top and bottom) are
1498 drawn inside of characters glyph area. The vertical lines of box
1499 (left and right) are drawn as the same way as the case that this
1500 value is positive. */
1503 /* Type of box drawn. A value of FACE_NO_BOX means no box is drawn
1504 around text in this face. A value of FACE_SIMPLE_BOX means a box
1505 of width box_line_width is drawn in color box_color. A value of
1506 FACE_RAISED_BOX or FACE_SUNKEN_BOX means a 3D box is drawn with
1507 shadow colors derived from the background color of the face. */
1508 enum face_box_type box
;
1510 /* If `box' above specifies a 3D type, 1 means use box_color for
1512 unsigned use_box_color_for_shadows_p
: 1;
1514 /* The Lisp face attributes this face realizes. All attributes
1515 in this vector are non-nil. */
1516 Lisp_Object lface
[LFACE_VECTOR_SIZE
];
1518 /* The hash value of this face. */
1521 /* The charset for which this face was realized if it was realized
1522 for use in multibyte text. If fontset >= 0, this is the charset
1523 of the first character of the composition sequence. A value of
1524 charset < 0 means the face was realized for use in unibyte text
1525 where the idea of Emacs charsets isn't applicable. */
1528 /* Non-zero if text in this face should be underlined, overlined,
1529 strike-through or have a box drawn around it. */
1530 unsigned underline_p
: 1;
1531 unsigned overline_p
: 1;
1532 unsigned strike_through_p
: 1;
1534 /* 1 means that the colors specified for this face could not be
1535 loaded, and were replaced by default colors, so they shouldn't be
1537 unsigned foreground_defaulted_p
: 1;
1538 unsigned background_defaulted_p
: 1;
1540 /* 1 means that either no color is specified for underlining or that
1541 the specified color couldn't be loaded. Use the foreground
1542 color when drawing in that case. */
1543 unsigned underline_defaulted_p
: 1;
1545 /* 1 means that either no color is specified for the corresponding
1546 attribute or that the specified color couldn't be loaded.
1547 Use the foreground color when drawing in that case. */
1548 unsigned overline_color_defaulted_p
: 1;
1549 unsigned strike_through_color_defaulted_p
: 1;
1550 unsigned box_color_defaulted_p
: 1;
1552 /* TTY appearances. Blinking is not yet implemented. Colors are
1553 found in `lface' with empty color string meaning the default
1554 color of the TTY. */
1555 unsigned tty_bold_p
: 1;
1556 unsigned tty_dim_p
: 1;
1557 unsigned tty_underline_p
: 1;
1558 unsigned tty_alt_charset_p
: 1;
1559 unsigned tty_reverse_p
: 1;
1560 unsigned tty_blinking_p
: 1;
1562 /* 1 means that colors of this face may not be freed because they
1563 have been copied bitwise from a base face (see
1565 unsigned colors_copied_bitwise_p
: 1;
1567 /* If non-zero, use overstrike (to simulate bold-face). */
1568 unsigned overstrike
: 1;
1570 /* Next and previous face in hash collision list of face cache. */
1571 struct face
*next
, *prev
;
1573 /* If this face is for ASCII characters, this points this face
1574 itself. Otherwise, this points a face for ASCII characters. */
1575 struct face
*ascii_face
;
1579 /* Color index indicating that face uses a terminal's default color. */
1581 #define FACE_TTY_DEFAULT_COLOR ((unsigned long) -1)
1583 /* Color index indicating that face uses an unknown foreground color. */
1585 #define FACE_TTY_DEFAULT_FG_COLOR ((unsigned long) -2)
1587 /* Color index indicating that face uses an unknown background color. */
1589 #define FACE_TTY_DEFAULT_BG_COLOR ((unsigned long) -3)
1591 /* Non-zero if FACE was realized for unibyte use. */
1593 #define FACE_UNIBYTE_P(FACE) ((FACE)->charset < 0)
1596 /* IDs of important faces known by the C face code. These are the IDs
1597 of the faces for CHARSET_ASCII. */
1603 MODE_LINE_INACTIVE_FACE_ID
,
1606 HEADER_LINE_FACE_ID
,
1612 BASIC_FACE_ID_SENTINEL
1616 /* A cache of realized faces. Each frame has its own cache because
1617 Emacs allows different frame-local face definitions. */
1621 /* Hash table of cached realized faces. */
1622 struct face
**buckets
;
1624 /* Back-pointer to the frame this cache belongs to. */
1627 /* A vector of faces so that faces can be referenced by an ID. */
1628 struct face
**faces_by_id
;
1630 /* The allocated size, and number of used slots of faces_by_id. */
1633 /* Flag indicating that attributes of the `menu' face have been
1635 unsigned menu_face_changed_p
: 1;
1639 /* Prepare face FACE for use on frame F. This must be called before
1640 using X resources of FACE. */
1642 #define PREPARE_FACE_FOR_DISPLAY(F, FACE) \
1643 if ((FACE)->gc == 0) \
1644 prepare_face_for_display ((F), (FACE)); \
1648 /* Return a pointer to the face with ID on frame F, or null if such a
1649 face doesn't exist. */
1651 #define FACE_FROM_ID(F, ID) \
1652 (((unsigned) (ID) < FRAME_FACE_CACHE (F)->used) \
1653 ? FRAME_FACE_CACHE (F)->faces_by_id[ID] \
1656 #ifdef HAVE_WINDOW_SYSTEM
1658 /* Non-zero if FACE is suitable for displaying character CHAR. */
1660 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) \
1661 (SINGLE_BYTE_CHAR_P (CHAR) \
1662 ? (FACE) == (FACE)->ascii_face \
1663 : face_suitable_for_char_p ((FACE), (CHAR)))
1665 /* Return the id of the realized face on frame F that is like the face
1666 with id ID but is suitable for displaying character CHAR.
1667 This macro is only meaningful for multibyte character CHAR. */
1669 #define FACE_FOR_CHAR(F, FACE, CHAR) \
1670 (SINGLE_BYTE_CHAR_P (CHAR) \
1671 ? (FACE)->ascii_face->id \
1672 : face_for_char ((F), (FACE), (CHAR)))
1674 #else /* not HAVE_WINDOW_SYSTEM */
1676 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) 1
1677 #define FACE_FOR_CHAR(F, FACE, CHAR) ((FACE)->id)
1679 #endif /* not HAVE_WINDOW_SYSTEM */
1681 /* Non-zero means face attributes have been changed since the last
1682 redisplay. Used in redisplay_internal. */
1684 extern int face_change_count
;
1689 /***********************************************************************
1691 ***********************************************************************/
1693 enum fringe_bitmap_type
1695 NO_FRINGE_BITMAP
= 0,
1696 LEFT_TRUNCATION_BITMAP
,
1697 RIGHT_TRUNCATION_BITMAP
,
1698 CONTINUED_LINE_BITMAP
,
1699 CONTINUATION_LINE_BITMAP
,
1700 OVERLAY_ARROW_BITMAP
,
1705 struct fringe_bitmap
1710 unsigned char *bits
;
1713 /* Structure used to describe where and how to draw a fringe bitmap.
1714 WHICH is the fringe bitmap to draw. WD and H is the (adjusted)
1715 width and height of the bitmap, DH is the height adjustment (if
1716 bitmap is periodic). X and Y are frame coordinates of the area to
1717 display the bitmap, DY is relative offset of the bitmap into that
1718 area. BX, NX, BY, NY specifies the area to clear if the bitmap
1719 does not fill the entire area. FACE is the fringe face. */
1721 struct draw_fringe_bitmap_params
1723 enum fringe_bitmap_type which
;
1730 extern struct fringe_bitmap fringe_bitmaps
[MAX_FRINGE_BITMAPS
];
1733 /***********************************************************************
1735 ***********************************************************************/
1737 /* Iteration over things to display in current_buffer or in a string.
1739 The iterator handles:
1741 1. Overlay strings (after-string, before-string).
1743 3. Invisible text properties.
1744 4. Selective display.
1745 5. Translation of characters via display tables.
1746 6. Translation of control characters to the forms `\003' or `^C'.
1747 7. `glyph' and `space-width' properties.
1749 Iterators are initialized by calling init_iterator or one of the
1750 equivalent functions below. A call to get_next_display_element
1751 loads the iterator structure with information about what next to
1752 display. A call to set_iterator_to_next increments the iterator's
1755 Characters from overlay strings, display table entries or control
1756 character translations are returned one at a time. For example, if
1757 we have a text of `a\x01' where `a' has a display table definition
1758 of `cd' and the control character is displayed with a leading
1759 arrow, then the iterator will return:
1761 Call Return Source Call next
1762 -----------------------------------------------------------------
1763 next c display table move
1764 next d display table move
1765 next ^ control char move
1766 next A control char move
1768 The same mechanism is also used to return characters for ellipses
1769 displayed at the end of invisible text.
1771 CAVEAT: Under some circumstances, move_.* functions can be called
1772 asynchronously, e.g. when computing a buffer position from an x and
1773 y pixel position. This means that these functions and functions
1774 called from them SHOULD NOT USE xmalloc and alike. See also the
1775 comment at the start of xdisp.c. */
1777 /* Enumeration describing what kind of display element an iterator is
1778 loaded with after a call to get_next_display_element. */
1780 enum display_element_type
1782 /* A normal character. */
1785 /* A composition sequence. */
1791 /* A flexible width and height space. */
1794 /* End of buffer or string. */
1797 /* Truncation glyphs. Never returned by get_next_display_element.
1798 Used to get display information about truncation glyphs via
1802 /* Continuation glyphs. See the comment for IT_TRUNCATION. */
1807 /* An enumerator for each text property that has a meaning for display
1816 COMPOSITION_PROP_IDX
,
1818 /* Not a property. Used to indicate changes in overlays. */
1828 /* The window in which we iterate over current_buffer (or a string). */
1832 /* The window's frame. */
1835 /* Function to call to load this structure with the next display
1837 int (* method
) P_ ((struct it
*it
));
1839 /* The next position at which to check for face changes, invisible
1840 text, overlay strings, end of text etc., which see. */
1843 /* Maximum string or buffer position + 1. ZV when iterating over
1847 /* C string to iterate over. Non-null means get characters from
1848 this string, otherwise characters are read from current_buffer
1852 /* Number of characters in the string (s, or it->string) we iterate
1856 /* Start and end of a visible region; -1 if the region is not
1857 visible in the window. */
1858 int region_beg_charpos
, region_end_charpos
;
1860 /* Position at which redisplay end trigger functions should be run. */
1861 int redisplay_end_trigger_charpos
;
1863 /* 1 means multibyte characters are enabled. */
1864 unsigned multibyte_p
: 1;
1866 /* 1 means window has a mode line at its top. */
1867 unsigned header_line_p
: 1;
1869 /* 1 means `string' is the value of a `display' property.
1870 Don't handle some `display' properties in these strings. */
1871 unsigned string_from_display_prop_p
: 1;
1873 /* Display table in effect or null for none. */
1874 struct Lisp_Char_Table
*dp
;
1876 /* Current display table vector to return characters from and its
1877 end. dpvec null means we are not returning characters from a
1878 display table entry; current.dpvec_index gives the current index
1879 into dpvec. This same mechanism is also used to return
1880 characters from translated control characters, i.e. `\003' or
1882 Lisp_Object
*dpvec
, *dpend
;
1884 /* Length in bytes of the char that filled dpvec. A value of zero
1885 means that no such character is involved. */
1888 /* Face id of the iterator saved in case a glyph from dpvec contains
1889 a face. The face is restored when all glyphs from dpvec have
1893 /* Vector of glyphs for control character translation. The pointer
1894 dpvec is set to ctl_chars when a control character is translated.
1895 This vector is also used for incomplete multibyte character
1896 translation (e.g \222\244). Such a character is at most 4 bytes,
1897 thus we need at most 16 bytes here. */
1898 Lisp_Object ctl_chars
[16];
1900 /* Current buffer or string position of the iterator, including
1901 position in overlay strings etc. */
1902 struct display_pos current
;
1904 /* Vector of overlays to process. Overlay strings are processed
1905 OVERLAY_STRING_CHUNK_SIZE at a time. */
1906 #define OVERLAY_STRING_CHUNK_SIZE 3
1907 Lisp_Object overlay_strings
[OVERLAY_STRING_CHUNK_SIZE
];
1909 /* Total number of overlay strings to process. This can be >
1910 OVERLAY_STRING_CHUNK_SIZE. */
1911 int n_overlay_strings
;
1913 /* If non-nil, a Lisp string being processed. If
1914 current.overlay_string_index >= 0, this is an overlay string from
1918 /* Stack of saved values. New entries are pushed when we begin to
1919 process an overlay string or a string from a `glyph' property.
1920 Entries are popped when we return to deliver display elements
1921 from what we previously had. */
1922 struct iterator_stack_entry
1927 struct display_pos pos
;
1930 enum glyph_row_area area
;
1931 unsigned multibyte_p
: 1;
1932 unsigned string_from_display_prop_p
: 1;
1933 unsigned display_ellipsis_p
: 1;
1934 Lisp_Object space_width
;
1936 Lisp_Object font_height
;
1940 /* Stack pointer. */
1943 /* Setting of buffer-local variable selective-display-ellipsis. */
1944 unsigned selective_display_ellipsis_p
: 1;
1946 /* 1 means control characters are translated into the form `^C'
1947 where the `^' can be replaced by a display table entry. */
1948 unsigned ctl_arrow_p
: 1;
1950 /* -1 means selective display hides everything between a \r and the
1951 next newline; > 0 means hide lines indented more than that value. */
1954 /* An enumeration describing what the next display element is
1955 after a call to get_next_display_element. */
1956 enum display_element_type what
;
1961 /* Non-zero means that the current face has a box. */
1962 unsigned face_box_p
: 1;
1964 /* Non-null means that the current character is the first in a run
1965 of characters with box face. */
1966 unsigned start_of_box_run_p
: 1;
1968 /* Non-zero means that the current character is the last in a run
1969 of characters with box face. */
1970 unsigned end_of_box_run_p
: 1;
1972 /* 1 means overlay strings at end_charpos have been processed. */
1973 unsigned overlay_strings_at_end_processed_p
: 1;
1975 /* 1 means the actual glyph is not available in the current
1977 unsigned glyph_not_available_p
: 1;
1979 /* 1 means the next line in display_line continues a character
1980 consisting of more than one glyph, and some glyphs of this
1981 character have been put on the previous line. */
1982 unsigned starts_in_middle_of_char_p
: 1;
1984 /* If 1, saved_face_id contains the id of the face in front of text
1985 skipped due to selective display. */
1986 unsigned face_before_selective_p
: 1;
1988 /* The ID of the default face to use. One of DEFAULT_FACE_ID,
1989 MODE_LINE_FACE_ID, etc, depending on what we are displaying. */
1992 /* If what == IT_CHARACTER, character and length in bytes. This is
1993 a character from a buffer or string. It may be different from
1994 the character displayed in case that
1995 unibyte_display_via_language_environment is set.
1997 If what == IT_COMPOSITION, the first component of a composition
1998 and length in bytes of the composition. */
2001 /* If what == IT_COMPOSITION, identification number and length in
2002 chars of a composition. */
2003 int cmp_id
, cmp_len
;
2005 /* The character to display, possibly translated to multibyte
2006 if unibyte_display_via_language_environment is set. This
2007 is set after produce_glyphs has been called. */
2008 int char_to_display
;
2010 /* If what == IT_IMAGE, the id of the image to display. */
2013 /* Value of the `space-width' property, if any; nil if none. */
2014 Lisp_Object space_width
;
2016 /* Computed from the value of the `raise' property. */
2019 /* Value of the `height' property, if any; nil if none. */
2020 Lisp_Object font_height
;
2022 /* Object and position where the current display element came from.
2023 Object can be a Lisp string in case the current display element
2024 comes from an overlay string, or it is buffer. Position is
2025 a position in object. */
2027 struct text_pos position
;
2029 /* 1 means lines are truncated. */
2030 unsigned truncate_lines_p
: 1;
2032 /* Number of columns per \t. */
2035 /* Width in pixels of truncation and continuation glyphs. */
2036 short truncation_pixel_width
, continuation_pixel_width
;
2038 /* First and last visible x-position in the display area. If window
2039 is hscrolled by n columns, first_visible_x == n * CANON_X_UNIT
2040 (f), and last_visible_x == pixel width of W + first_visible_x. */
2041 int first_visible_x
, last_visible_x
;
2043 /* Last visible y-position + 1 in the display area without a mode
2044 line, if the window has one. */
2047 /* Additional space in pixels between lines (for window systems
2049 int extra_line_spacing
;
2051 /* If non-null, glyphs are produced in glyph_row with each call to
2053 struct glyph_row
*glyph_row
;
2055 /* The area of glyph_row to which glyphs are added. */
2056 enum glyph_row_area area
;
2058 /* Number of glyphs needed for the last character requested via
2059 produce_glyphs. This is 1 except for tabs. */
2062 /* Width of the display element in pixels. Result of
2066 /* Current, maximum logical, and maximum physical line height
2067 information. Result of produce_glyphs. */
2068 int ascent
, descent
, max_ascent
, max_descent
;
2069 int phys_ascent
, phys_descent
, max_phys_ascent
, max_phys_descent
;
2071 /* Current x pixel position within the display line. This value
2072 does not include the width of continuation lines in front of the
2073 line. The value of current_x is automatically incremented by
2074 pixel_width with each call to produce_glyphs. */
2077 /* Accumulated width of continuation lines. If > 0, this means we
2078 are currently in a continuation line. This is initially zero and
2079 incremented/reset by display_line, move_it_to etc. */
2080 int continuation_lines_width
;
2082 /* Current y-position. Automatically incremented by the height of
2083 glyph_row in move_it_to and display_line. */
2086 /* Current vertical matrix position, or line number. Automatically
2087 incremented by move_it_to and display_line. */
2090 /* Horizontal matrix position reached in move_it_in_display_line.
2091 Only set there, not in display_line. */
2096 /* Access to positions of iterator IT. */
2098 #define IT_CHARPOS(IT) CHARPOS ((IT).current.pos)
2099 #define IT_BYTEPOS(IT) BYTEPOS ((IT).current.pos)
2100 #define IT_STRING_CHARPOS(IT) CHARPOS ((IT).current.string_pos)
2101 #define IT_STRING_BYTEPOS(IT) BYTEPOS ((IT).current.string_pos)
2103 /* Test if IT has reached the end of its buffer or string. This will
2104 only work after get_next_display_element has been called. */
2106 #define ITERATOR_AT_END_P(IT) ((IT)->what == IT_EOB)
2108 /* Non-zero means IT is at the end of a line. This is the case if it
2109 is either on a newline or on a carriage return and selective
2110 display hides the rest of the line. */
2112 #define ITERATOR_AT_END_OF_LINE_P(IT) \
2113 ((IT)->what == IT_CHARACTER \
2114 && ((IT)->c == '\n' \
2115 || ((IT)->c == '\r' && (IT)->selective)))
2117 /* Call produce_glyphs or produce_glyphs_hook, if set. Shortcut to
2118 avoid the function call overhead. */
2120 #define PRODUCE_GLYPHS(IT) \
2122 extern int inhibit_free_realized_faces; \
2124 rif->produce_glyphs ((IT)); \
2126 produce_glyphs ((IT)); \
2127 if ((IT)->glyph_row != NULL) \
2128 inhibit_free_realized_faces = 1; \
2131 /* Bit-flags indicating what operation move_it_to should perform. */
2133 enum move_operation_enum
2135 /* Stop if specified x-position is reached. */
2138 /* Stop if specified y-position is reached. */
2141 /* Stop if specified vpos is reached. */
2142 MOVE_TO_VPOS
= 0x04,
2144 /* Stop if specified buffer or string position is reached. */
2150 /***********************************************************************
2151 Window-based redisplay interface
2152 ***********************************************************************/
2154 /* Structure used to describe runs of lines that must be scrolled. */
2158 /* Source and destination y pixel position. */
2159 int desired_y
, current_y
;
2161 /* Source and destination vpos in matrix. */
2162 int desired_vpos
, current_vpos
;
2164 /* Height in pixels, number of glyph rows. */
2169 /* Structure holding system-dependent interface functions needed
2170 for window-based redisplay. */
2172 struct redisplay_interface
2174 /* Produce glyphs/get display metrics for the display element IT is
2176 void (*produce_glyphs
) P_ ((struct it
*it
));
2178 /* Write or insert LEN glyphs from STRING at the nominal output
2180 void (*write_glyphs
) P_ ((struct glyph
*string
, int len
));
2181 void (*insert_glyphs
) P_ ((struct glyph
*start
, int len
));
2183 /* Clear from nominal output position to X. X < 0 means clear
2184 to right end of display. */
2185 void (*clear_end_of_line
) P_ ((int x
));
2187 /* Function to call to scroll the display as described by RUN on
2189 void (*scroll_run_hook
) P_ ((struct window
*w
, struct run
*run
));
2191 /* Function to call after a line in a display has been completely
2192 updated. Used to draw truncation marks and alike. DESIRED_ROW
2193 is the desired row which has been updated. */
2194 void (*after_update_window_line_hook
) P_ ((struct glyph_row
*desired_row
));
2196 /* Function to call before beginning to update window W in
2197 window-based redisplay. */
2198 void (*update_window_begin_hook
) P_ ((struct window
*w
));
2200 /* Function to call after window W has been updated in window-based
2201 redisplay. CURSOR_ON_P non-zero means switch cursor on.
2202 MOUSE_FACE_OVERWRITTEN_P non-zero means that some lines in W
2203 that contained glyphs in mouse-face were overwritten, so we
2204 have to update the mouse highlight. */
2205 void (*update_window_end_hook
) P_ ((struct window
*w
, int cursor_on_p
,
2206 int mouse_face_overwritten_p
));
2208 /* Move cursor to row/column position VPOS/HPOS, pixel coordinates
2209 Y/X. HPOS/VPOS are window-relative row and column numbers and X/Y
2210 are window-relative pixel positions. */
2211 void (*cursor_to
) P_ ((int vpos
, int hpos
, int y
, int x
));
2213 /* Flush the display of frame F. For X, this is XFlush. */
2214 void (*flush_display
) P_ ((struct frame
*f
));
2216 /* Flush the display of frame F if non-NULL. This is called
2217 during redisplay, and should be NULL on systems which flushes
2218 automatically before reading input. */
2219 void (*flush_display_optional
) P_ ((struct frame
*f
));
2221 /* Clear the mouse hightlight in window W, if there is any. */
2222 void (*clear_window_mouse_face
) P_ ((struct window
*w
));
2224 /* Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
2226 void (*get_glyph_overhangs
) P_ ((struct glyph
*glyph
, struct frame
*f
,
2227 int *left
, int *right
));
2229 /* Fix the display of AREA of ROW in window W for overlapping rows.
2230 This function is called from redraw_overlapping_rows after
2231 desired rows have been made current. */
2232 void (*fix_overlapping_area
) P_ ((struct window
*w
, struct glyph_row
*row
,
2233 enum glyph_row_area area
));
2235 #ifdef HAVE_WINDOW_SYSTEM
2237 /* Draw a fringe bitmap in window W of row ROW using parameters P. */
2238 void (*draw_fringe_bitmap
) P_ ((struct window
*w
, struct glyph_row
*row
,
2239 struct draw_fringe_bitmap_params
*p
));
2241 /* Get metrics of character CHAR2B in FONT of type FONT_TYPE.
2242 Value is null if CHAR2B is not contained in the font. */
2243 XCharStruct
* (*per_char_metric
) P_ ((XFontStruct
*font
, XChar2b
*char2b
,
2246 /* Encode CHAR2B using encoding information from FONT_INFO. CHAR2B is
2247 the two-byte form of C. Encoding is returned in *CHAR2B. If
2248 TWO_BYTE_P is non-null, return non-zero there if font is two-byte. */
2249 int (*encode_char
) P_ ((int c
, XChar2b
*char2b
,
2250 struct font_info
*font_into
, int *two_byte_p
));
2252 /* Compute left and right overhang of glyph string S.
2253 A NULL pointer if platform does not support this. */
2254 void (*compute_glyph_string_overhangs
) P_ ((struct glyph_string
*s
));
2256 /* Draw a glyph string S. */
2257 void (*draw_glyph_string
) P_ ((struct glyph_string
*s
));
2259 /* Define cursor CURSOR on frame F. */
2260 void (*define_frame_cursor
) P_ ((struct frame
*f
, Cursor cursor
));
2262 /* Clear the area at (X,Y,WIDTH,HEIGHT) of frame F. */
2263 void (*clear_frame_area
) P_ ((struct frame
*f
, int x
, int y
,
2264 int width
, int height
));
2266 /* Draw specified cursor CURSOR_TYPE of width CURSOR_WIDTH
2267 at row GLYPH_ROW on window W if ON_P is 1. If ON_P is
2268 0, don't draw cursor. If ACTIVE_P is 1, system caret
2269 should track this cursor (when applicable). */
2270 void (*draw_window_cursor
) P_ ((struct window
*w
,
2271 struct glyph_row
*glyph_row
,
2273 int cursor_type
, int cursor_width
,
2274 int on_p
, int active_p
));
2276 /* Draw vertical border for window W from (X,Y0) to (X,Y1). */
2277 void (*draw_vertical_window_border
) P_ ((struct window
*w
,
2278 int x
, int y0
, int y1
));
2280 /* Shift display of frame F to make room for inserted glyphs.
2281 The area at pixel (X,Y) of width WIDTH and height HEIGHT is
2282 shifted right by SHIFT_BY pixels. */
2283 void (*shift_glyphs_for_insert
) P_ ((struct frame
*f
,
2284 int x
, int y
, int width
,
2285 int height
, int shift_by
));
2287 #endif /* HAVE_WINDOW_SYSTEM */
2290 /* The current interface for window-based redisplay. */
2292 extern struct redisplay_interface
*rif
;
2295 /***********************************************************************
2297 ***********************************************************************/
2299 #ifdef HAVE_WINDOW_SYSTEM
2301 /* Structure forward declarations. */
2306 /* Each image format (JPEG, TIFF, ...) supported is described by
2307 a structure of the type below. */
2311 /* A symbol uniquely identifying the image type, .e.g `jpeg'. */
2314 /* Check that SPEC is a valid image specification for the given
2315 image type. Value is non-zero if SPEC is valid. */
2316 int (* valid_p
) P_ ((Lisp_Object spec
));
2318 /* Load IMG which is used on frame F from information contained in
2319 IMG->spec. Value is non-zero if successful. */
2320 int (* load
) P_ ((struct frame
*f
, struct image
*img
));
2322 /* Free resources of image IMG which is used on frame F. */
2323 void (* free
) P_ ((struct frame
*f
, struct image
*img
));
2325 /* Next in list of all supported image types. */
2326 struct image_type
*next
;
2330 /* Structure describing an image. Specific image formats like XBM are
2331 converted into this form, so that display only has to deal with
2332 this type of image. */
2336 /* The time in seconds at which the image was last displayed. Set
2337 in prepare_image_for_display. */
2338 unsigned long timestamp
;
2340 /* Pixmaps of the image. */
2341 Pixmap pixmap
, mask
;
2343 /* Colors allocated for this image, if any. Allocated via xmalloc. */
2344 unsigned long *colors
;
2347 /* A single `background color' for this image, for the use of anyone that
2348 cares about such a thing. Only valid if the `background_valid' field
2349 is true. This should generally be accessed by calling the accessor
2350 macro `IMAGE_BACKGROUND', which will heuristically calculate a value
2352 unsigned long background
;
2354 /* True if this image has a `transparent' background -- that is, is
2355 uses an image mask. The accessor macro for this is
2356 `IMAGE_BACKGROUND_TRANSPARENT'. */
2357 unsigned background_transparent
: 1;
2359 /* True if the `background' and `background_transparent' fields are
2360 valid, respectively. */
2361 unsigned background_valid
: 1, background_transparent_valid
: 1;
2363 /* Width and height of the image. */
2366 /* These values are used for the rectangles displayed for images
2367 that can't be loaded. */
2368 #define DEFAULT_IMAGE_WIDTH 30
2369 #define DEFAULT_IMAGE_HEIGHT 30
2371 /* Percent of image height used as ascent. A value of
2372 CENTERED_IMAGE_ASCENT means draw the image centered on the
2375 #define DEFAULT_IMAGE_ASCENT 50
2376 #define CENTERED_IMAGE_ASCENT -1
2378 /* Lisp specification of this image. */
2381 /* Relief to draw around the image. */
2384 /* Optional margins around the image. This includes the relief. */
2385 int hmargin
, vmargin
;
2387 /* Reference to the type of the image. */
2388 struct image_type
*type
;
2390 /* 1 means that loading the image failed. Don't try again. */
2391 unsigned load_failed_p
;
2393 /* A place for image types to store additional data. The member
2394 data.lisp_val is marked during GC, so it's safe to store Lisp data
2395 there. Image types should free this data when their `free'
2396 function is called. */
2401 Lisp_Object lisp_val
;
2404 /* Hash value of image specification to speed up comparisons. */
2407 /* Image id of this image. */
2410 /* Hash collision chain. */
2411 struct image
*next
, *prev
;
2415 /* Cache of images. Each frame has a cache. X frames with the same
2416 x_display_info share their caches. */
2420 /* Hash table of images. */
2421 struct image
**buckets
;
2423 /* Vector mapping image ids to images. */
2424 struct image
**images
;
2426 /* Allocated size of `images'. */
2429 /* Number of images in the cache. */
2432 /* Reference count (number of frames sharing this cache). */
2437 /* Value is a pointer to the image with id ID on frame F, or null if
2438 no image with that id exists. */
2440 #define IMAGE_FROM_ID(F, ID) \
2441 (((ID) >= 0 && (ID) < (FRAME_X_IMAGE_CACHE (F)->used)) \
2442 ? FRAME_X_IMAGE_CACHE (F)->images[ID] \
2445 /* Size of bucket vector of image caches. Should be prime. */
2447 #define IMAGE_CACHE_BUCKETS_SIZE 1001
2449 #endif /* HAVE_WINDOW_SYSTEM */
2453 /***********************************************************************
2455 ***********************************************************************/
2457 /* Enumeration defining where to find tool-bar item information in
2458 tool-bar items vectors stored with frames. Each tool-bar item
2459 occupies TOOL_BAR_ITEM_NSLOTS elements in such a vector. */
2461 enum tool_bar_item_idx
2463 /* The key of the tool-bar item. Used to remove items when a binding
2464 for `undefined' is found. */
2467 /* Non-nil if item is enabled. */
2468 TOOL_BAR_ITEM_ENABLED_P
,
2470 /* Non-nil if item is selected (pressed). */
2471 TOOL_BAR_ITEM_SELECTED_P
,
2474 TOOL_BAR_ITEM_CAPTION
,
2476 /* Image(s) to display. This is either a single image specification
2477 or a vector of specifications. */
2478 TOOL_BAR_ITEM_IMAGES
,
2481 TOOL_BAR_ITEM_BINDING
,
2483 /* Button type. One of nil, `:radio' or `:toggle'. */
2489 /* Sentinel = number of slots in tool_bar_items occupied by one
2491 TOOL_BAR_ITEM_NSLOTS
2495 /* An enumeration for the different images that can be specified
2496 for a tool-bar item. */
2498 enum tool_bar_item_image
2500 TOOL_BAR_IMAGE_ENABLED_SELECTED
,
2501 TOOL_BAR_IMAGE_ENABLED_DESELECTED
,
2502 TOOL_BAR_IMAGE_DISABLED_SELECTED
,
2503 TOOL_BAR_IMAGE_DISABLED_DESELECTED
2506 /* Margin around tool-bar buttons in pixels. */
2508 extern Lisp_Object Vtool_bar_button_margin
;
2510 /* Thickness of relief to draw around tool-bar buttons. */
2512 extern EMACS_INT tool_bar_button_relief
;
2514 /* Default values of the above variables. */
2516 #define DEFAULT_TOOL_BAR_BUTTON_MARGIN 4
2517 #define DEFAULT_TOOL_BAR_BUTTON_RELIEF 1
2519 /* The height in pixels of the default tool-bar images. */
2521 #define DEFAULT_TOOL_BAR_IMAGE_HEIGHT 24
2524 /***********************************************************************
2525 Terminal Capabilities
2526 ***********************************************************************/
2528 /* Each of these is a bit representing a terminal `capability' (bold,
2529 inverse, etc). They are or'd together to specify the set of
2530 capabilities being queried for when calling `tty_capable_p' (which
2531 returns true if the terminal supports all of them). */
2533 #define TTY_CAP_INVERSE 0x01
2534 #define TTY_CAP_UNDERLINE 0x02
2535 #define TTY_CAP_BOLD 0x04
2536 #define TTY_CAP_DIM 0x08
2537 #define TTY_CAP_BLINK 0x10
2538 #define TTY_CAP_ALT_CHARSET 0x20
2541 /***********************************************************************
2543 ***********************************************************************/
2545 /* Defined in xdisp.c */
2547 struct glyph_row
*row_containing_pos
P_ ((struct window
*, int,
2549 struct glyph_row
*, int));
2550 int string_buffer_position
P_ ((struct window
*, Lisp_Object
, int));
2551 int line_bottom_y
P_ ((struct it
*));
2552 int display_prop_intangible_p
P_ ((Lisp_Object
));
2553 void resize_echo_area_exactly
P_ ((void));
2554 int resize_mini_window
P_ ((struct window
*, int));
2555 int try_window
P_ ((Lisp_Object
, struct text_pos
));
2556 void window_box
P_ ((struct window
*, int, int *, int *, int *, int *));
2557 int window_box_height
P_ ((struct window
*));
2558 int window_text_bottom_y
P_ ((struct window
*));
2559 int window_box_width
P_ ((struct window
*, int));
2560 int window_box_left
P_ ((struct window
*, int));
2561 int window_box_right
P_ ((struct window
*, int));
2562 void window_box_edges
P_ ((struct window
*, int, int *, int *, int *, int *));
2563 int estimate_mode_line_height
P_ ((struct frame
*, enum face_id
));
2564 void pixel_to_glyph_coords
P_ ((struct frame
*, int, int, int *, int *,
2565 NativeRectangle
*, int));
2566 int glyph_to_pixel_coords
P_ ((struct window
*, int, int, int *, int *));
2567 void mark_window_display_accurate
P_ ((Lisp_Object
, int));
2568 void redisplay_preserve_echo_area
P_ ((int));
2569 void set_cursor_from_row
P_ ((struct window
*, struct glyph_row
*,
2570 struct glyph_matrix
*, int, int, int, int));
2571 void init_iterator
P_ ((struct it
*, struct window
*, int,
2572 int, struct glyph_row
*, enum face_id
));
2573 void init_iterator_to_row_start
P_ ((struct it
*, struct window
*,
2574 struct glyph_row
*));
2575 int get_next_display_element
P_ ((struct it
*));
2576 void set_iterator_to_next
P_ ((struct it
*, int));
2577 void produce_glyphs
P_ ((struct it
*));
2578 void produce_special_glyphs
P_ ((struct it
*, enum display_element_type
));
2579 void start_display
P_ ((struct it
*, struct window
*, struct text_pos
));
2580 void move_it_to
P_ ((struct it
*, int, int, int, int, int));
2581 void move_it_vertically
P_ ((struct it
*, int));
2582 void move_it_vertically_backward
P_ ((struct it
*, int));
2583 void move_it_by_lines
P_ ((struct it
*, int, int));
2584 void move_it_past_eol
P_ ((struct it
*));
2585 int in_display_vector_p
P_ ((struct it
*));
2586 int frame_mode_line_height
P_ ((struct frame
*));
2587 void highlight_trailing_whitespace
P_ ((struct frame
*, struct glyph_row
*));
2588 void draw_row_fringe_bitmaps
P_ ((struct window
*, struct glyph_row
*));
2589 void compute_fringe_widths
P_ ((struct frame
*, int));
2590 extern Lisp_Object Qtool_bar
;
2591 extern Lisp_Object Vshow_trailing_whitespace
;
2592 extern int mode_line_in_non_selected_windows
;
2593 extern int redisplaying_p
;
2594 extern Lisp_Object Vimage_types
;
2595 extern void add_to_log
P_ ((char *, Lisp_Object
, Lisp_Object
));
2596 extern int help_echo_showing_p
;
2597 extern int current_mode_line_height
, current_header_line_height
;
2598 extern Lisp_Object help_echo_string
, help_echo_window
;
2599 extern Lisp_Object help_echo_object
, previous_help_echo_string
;
2600 extern int help_echo_pos
;
2601 extern struct frame
*last_mouse_frame
;
2602 extern int last_tool_bar_item
;
2603 extern int mouse_autoselect_window
;
2605 #ifdef HAVE_WINDOW_SYSTEM
2608 extern void dump_glyph_string
P_ ((struct glyph_string
*));
2611 extern void x_get_glyph_overhangs
P_ ((struct glyph
*, struct frame
*,
2613 extern void x_produce_glyphs
P_ ((struct it
*));
2615 extern void x_write_glyphs
P_ ((struct glyph
*, int));
2616 extern void x_insert_glyphs
P_ ((struct glyph
*, int len
));
2617 extern void x_clear_end_of_line
P_ ((int));
2619 extern int x_stretch_cursor_p
;
2620 extern struct cursor_pos output_cursor
;
2622 extern void x_fix_overlapping_area
P_ ((struct window
*, struct glyph_row
*,
2623 enum glyph_row_area
));
2624 extern void draw_phys_cursor_glyph
P_ ((struct window
*,
2626 enum draw_glyphs_face
));
2627 extern void erase_phys_cursor
P_ ((struct window
*));
2628 extern void display_and_set_cursor
P_ ((struct window
*,
2629 int, int, int, int, int));
2631 extern void set_output_cursor
P_ ((struct cursor_pos
*));
2632 extern void x_cursor_to
P_ ((int, int, int, int));
2634 extern void x_update_cursor
P_ ((struct frame
*, int));
2635 extern void x_clear_cursor
P_ ((struct window
*));
2636 extern void x_draw_vertical_border
P_ ((struct window
*w
));
2638 extern void frame_to_window_pixel_xy
P_ ((struct window
*, int *, int *));
2639 extern void get_glyph_string_clip_rect
P_ ((struct glyph_string
*,
2640 NativeRectangle
*nr
));
2641 extern void note_mouse_highlight
P_ ((struct frame
*, int, int));
2642 extern void x_clear_window_mouse_face
P_ ((struct window
*));
2643 extern void cancel_mouse_face
P_ ((struct frame
*));
2645 extern void handle_tool_bar_click
P_ ((struct frame
*,
2646 int, int, int, unsigned int));
2648 /* msdos.c defines its own versions of these functions. */
2649 extern int clear_mouse_face
P_ ((Display_Info
*));
2650 extern void show_mouse_face
P_ ((Display_Info
*, enum draw_glyphs_face
));
2651 extern int cursor_in_mouse_face_p
P_ ((struct window
*w
));
2653 extern void expose_frame
P_ ((struct frame
*, int, int, int, int));
2654 extern int x_intersect_rectangles
P_ ((XRectangle
*, XRectangle
*,
2658 /* Defined in sysdep.c */
2660 void get_frame_size
P_ ((int *, int *));
2661 void request_sigio
P_ ((void));
2662 void unrequest_sigio
P_ ((void));
2663 int tabs_safe_p
P_ ((void));
2664 void init_baud_rate
P_ ((void));
2665 void init_sigio
P_ ((int));
2667 /* Defined in xfaces.c */
2669 #ifdef HAVE_X_WINDOWS
2670 void x_free_colors
P_ ((struct frame
*, unsigned long *, int));
2673 void update_face_from_frame_parameter
P_ ((struct frame
*, Lisp_Object
,
2675 Lisp_Object tty_color_name
P_ ((struct frame
*, int));
2676 void clear_face_cache
P_ ((int));
2677 unsigned long load_color
P_ ((struct frame
*, struct face
*, Lisp_Object
,
2678 enum lface_attribute_index
));
2679 void unload_color
P_ ((struct frame
*, unsigned long));
2680 int frame_update_line_height
P_ ((struct frame
*));
2681 int ascii_face_of_lisp_face
P_ ((struct frame
*, int));
2682 void prepare_face_for_display
P_ ((struct frame
*, struct face
*));
2683 int xstricmp
P_ ((const unsigned char *, const unsigned char *));
2684 int lookup_face
P_ ((struct frame
*, Lisp_Object
*, int, struct face
*));
2685 int lookup_named_face
P_ ((struct frame
*, Lisp_Object
, int));
2686 int smaller_face
P_ ((struct frame
*, int, int));
2687 int face_with_height
P_ ((struct frame
*, int, int));
2688 int lookup_derived_face
P_ ((struct frame
*, Lisp_Object
, int, int));
2689 void init_frame_faces
P_ ((struct frame
*));
2690 void free_frame_faces
P_ ((struct frame
*));
2691 void recompute_basic_faces
P_ ((struct frame
*));
2692 int face_at_buffer_position
P_ ((struct window
*, int, int, int, int *,
2694 int face_at_string_position
P_ ((struct window
*, Lisp_Object
, int, int, int,
2695 int, int *, enum face_id
, int));
2696 int compute_char_face
P_ ((struct frame
*, int, Lisp_Object
));
2697 void free_all_realized_faces
P_ ((Lisp_Object
));
2698 extern Lisp_Object Qforeground_color
, Qbackground_color
;
2699 extern char unspecified_fg
[], unspecified_bg
[];
2700 void free_realized_multibyte_face
P_ ((struct frame
*, int));
2702 /* Defined in xfns.c */
2704 #ifdef HAVE_X_WINDOWS
2705 void gamma_correct
P_ ((struct frame
*, XColor
*));
2708 void gamma_correct
P_ ((struct frame
*, COLORREF
*));
2711 #ifdef HAVE_WINDOW_SYSTEM
2713 void x_kill_gs_process
P_ ((Pixmap
, struct frame
*));
2714 int x_screen_planes
P_ ((struct frame
*));
2715 void x_implicitly_set_name
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
2716 struct image_cache
*make_image_cache
P_ ((void));
2717 void free_image_cache
P_ ((struct frame
*));
2718 void clear_image_cache
P_ ((struct frame
*, int));
2719 void forall_images_in_image_cache
P_ ((struct frame
*,
2720 void (*) P_ ((struct image
*))));
2721 int valid_image_p
P_ ((Lisp_Object
));
2722 void prepare_image_for_display
P_ ((struct frame
*, struct image
*));
2723 int lookup_image
P_ ((struct frame
*, Lisp_Object
));
2725 #ifdef HAVE_X_WINDOWS
2726 unsigned long image_background
P_ ((struct image
*, struct frame
*,
2728 int image_background_transparent
P_ ((struct image
*, struct frame
*,
2730 #endif /* HAVE_X_WINDOWS */
2732 extern Lisp_Object tip_frame
;
2733 extern Window tip_window
;
2734 EXFUN (Fx_show_tip
, 6);
2735 EXFUN (Fx_hide_tip
, 0);
2736 extern void start_hourglass
P_ ((void));
2737 extern void cancel_hourglass
P_ ((void));
2738 extern int display_hourglass_p
;
2740 /* Returns the background color of IMG, calculating one heuristically if
2741 necessary. If non-zero, XIMG is an existing XImage object to use for
2744 #define IMAGE_BACKGROUND(img, f, ximg) \
2745 ((img)->background_valid \
2746 ? (img)->background \
2747 : image_background (img, f, ximg))
2749 /* Returns true if IMG has a `transparent' background, using heuristics
2750 to decide if necessary. If non-zero, MASK is an existing XImage
2751 object to use for the heuristic. */
2753 #define IMAGE_BACKGROUND_TRANSPARENT(img, f, mask) \
2754 ((img)->background_transparent_valid \
2755 ? (img)->background_transparent \
2756 : image_background_transparent (img, f, mask))
2758 #endif /* HAVE_WINDOW_SYSTEM */
2761 /* Defined in xmenu.c */
2763 int popup_activated
P_ ((void));
2765 /* Defined in dispnew.c */
2767 extern int inverse_video
;
2768 extern int required_matrix_width
P_ ((struct window
*));
2769 extern int required_matrix_height
P_ ((struct window
*));
2770 extern Lisp_Object mode_line_string
P_ ((struct window
*, int, int,
2771 enum window_part
, int *));
2772 extern Lisp_Object marginal_area_string
P_ ((struct window
*, int, int,
2773 enum window_part
, int *));
2774 extern void redraw_frame
P_ ((struct frame
*));
2775 extern void redraw_garbaged_frames
P_ ((void));
2776 extern void cancel_line
P_ ((int, struct frame
*));
2777 extern void init_desired_glyphs
P_ ((struct frame
*));
2778 extern int scroll_frame_lines
P_ ((struct frame
*, int, int, int, int));
2779 extern int direct_output_for_insert
P_ ((int));
2780 extern int direct_output_forward_char
P_ ((int));
2781 extern int update_frame
P_ ((struct frame
*, int, int));
2782 extern int scrolling
P_ ((struct frame
*));
2783 extern void bitch_at_user
P_ ((void));
2784 void adjust_glyphs
P_ ((struct frame
*));
2785 void free_glyphs
P_ ((struct frame
*));
2786 void free_window_matrices
P_ ((struct window
*));
2787 void check_glyph_memory
P_ ((void));
2788 void mirrored_line_dance
P_ ((struct glyph_matrix
*, int, int, int *, char *));
2789 void clear_glyph_matrix
P_ ((struct glyph_matrix
*));
2790 void clear_current_matrices
P_ ((struct frame
*f
));
2791 void clear_desired_matrices
P_ ((struct frame
*));
2792 void shift_glyph_matrix
P_ ((struct window
*, struct glyph_matrix
*,
2794 void rotate_matrix
P_ ((struct glyph_matrix
*, int, int, int));
2795 void increment_matrix_positions
P_ ((struct glyph_matrix
*,
2796 int, int, int, int));
2797 void blank_row
P_ ((struct window
*, struct glyph_row
*, int));
2798 void increment_row_positions
P_ ((struct glyph_row
*, int, int));
2799 void enable_glyph_matrix_rows
P_ ((struct glyph_matrix
*, int, int, int));
2800 void clear_glyph_row
P_ ((struct glyph_row
*));
2801 void prepare_desired_row
P_ ((struct glyph_row
*));
2802 int line_hash_code
P_ ((struct glyph_row
*));
2803 void set_window_update_flags
P_ ((struct window
*, int));
2804 void write_glyphs
P_ ((struct glyph
*, int));
2805 void insert_glyphs
P_ ((struct glyph
*, int));
2806 void redraw_frame
P_ ((struct frame
*));
2807 void redraw_garbaged_frames
P_ ((void));
2808 int scroll_cost
P_ ((struct frame
*, int, int, int));
2809 int direct_output_for_insert
P_ ((int));
2810 int direct_output_forward_char
P_ ((int));
2811 int update_frame
P_ ((struct frame
*, int, int));
2812 void update_single_window
P_ ((struct window
*, int));
2813 int scrolling
P_ ((struct frame
*));
2814 void buffer_posn_from_coords
P_ ((struct window
*, int *, int *,
2815 Lisp_Object
*, struct display_pos
*));
2816 void do_pending_window_change
P_ ((int));
2817 void change_frame_size
P_ ((struct frame
*, int, int, int, int, int));
2818 void bitch_at_user
P_ ((void));
2819 Lisp_Object sit_for
P_ ((int, int, int, int, int));
2820 void init_display
P_ ((void));
2821 void syms_of_display
P_ ((void));
2822 extern Lisp_Object Qredisplay_dont_pause
;
2824 /* Defined in term.c */
2826 extern void ring_bell
P_ ((void));
2827 extern void set_terminal_modes
P_ ((void));
2828 extern void reset_terminal_modes
P_ ((void));
2829 extern void update_begin
P_ ((struct frame
*));
2830 extern void update_end
P_ ((struct frame
*));
2831 extern void set_terminal_window
P_ ((int));
2832 extern void set_scroll_region
P_ ((int, int));
2833 extern void turn_off_insert
P_ ((void));
2834 extern void turn_off_highlight
P_ ((void));
2835 extern void background_highlight
P_ ((void));
2836 extern void clear_frame
P_ ((void));
2837 extern void clear_end_of_line
P_ ((int));
2838 extern void clear_end_of_line_raw
P_ ((int));
2839 extern void delete_glyphs
P_ ((int));
2840 extern void ins_del_lines
P_ ((int, int));
2841 extern int string_cost
P_ ((char *));
2842 extern int per_line_cost
P_ ((char *));
2843 extern void calculate_costs
P_ ((struct frame
*));
2844 extern void set_tty_color_mode
P_ ((struct frame
*, Lisp_Object
));
2845 extern void tty_setup_colors
P_ ((int));
2846 extern void term_init
P_ ((char *));
2847 extern void fatal
P_ ((/* char *, ... */));
2848 void cursor_to
P_ ((int, int));
2849 extern int tty_capable_p
P_ ((struct frame
*, unsigned, unsigned long, unsigned long));
2851 /* Defined in scroll.c */
2853 extern int scrolling_max_lines_saved
P_ ((int, int, int *, int *, int *));
2854 extern int scroll_cost
P_ ((struct frame
*, int, int, int));
2855 extern void do_line_insertion_deletion_costs
P_ ((struct frame
*, char *,
2856 char *, char *, char *,
2857 char *, char *, int));
2858 void scrolling_1
P_ ((struct frame
*, int, int, int, int *, int *, int *,
2861 #endif /* not DISPEXTERN_H_INCLUDED */