1 /* Interface definitions for display code.
2 Copyright (C) 1985,93,94,97,98,99, 2000,01,02,03, 2004, 2005
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 typedef XImage
* XImagePtr
;
54 typedef XImagePtr XImagePtr_or_DC
;
55 #define NativeRectangle XRectangle
60 typedef struct w32_display_info Display_Info
;
61 typedef XImage
*XImagePtr
;
62 typedef HDC XImagePtr_or_DC
;
67 typedef struct mac_display_info Display_Info
;
68 /* Mac equivalent of XImage. */
69 typedef Pixmap XImagePtr
;
70 typedef XImagePtr XImagePtr_or_DC
;
73 #ifndef NativeRectangle
74 #define NativeRectangle int
77 /* Structure forward declarations. Some are here because function
78 prototypes below reference structure types before their definition
79 in this file. Some are here because not every file including
80 dispextern.h also includes frame.h and windows.h. */
90 /* Values returned from coordinates_in_window. */
106 /* Number of bits allocated to store fringe bitmap numbers. */
107 #define FRINGE_ID_BITS 16
111 /***********************************************************************
113 ***********************************************************************/
115 /* If GLYPH_DEBUG is non-zero, additional checks are activated. Turn
116 it off by defining the macro GLYPH_DEBUG to zero. */
119 #define GLYPH_DEBUG 0
122 /* If XASSERTS is non-zero, additional consistency checks are activated.
123 Turn it off by defining the macro XASSERTS to zero. */
129 /* Macros to include code only if GLYPH_DEBUG != 0. */
132 #define IF_DEBUG(X) X
134 #define IF_DEBUG(X) (void) 0
138 #define xassert(X) do {if (!(X)) abort ();} while (0)
140 #define xassert(X) (void) 0
143 /* Macro for displaying traces of redisplay. If Emacs was compiled
144 with GLYPH_DEBUG != 0, the variable trace_redisplay_p can be set to
145 a non-zero value in debugging sessions to activate traces. */
149 extern int trace_redisplay_p
;
153 if (trace_redisplay_p) \
158 #else /* GLYPH_DEBUG == 0 */
160 #define TRACE(X) (void) 0
162 #endif /* GLYPH_DEBUG == 0 */
166 /***********************************************************************
168 ***********************************************************************/
170 /* Starting with Emacs 20.3, characters from strings and buffers have
171 both a character and a byte position associated with them. The
172 following structure holds such a pair of positions. */
176 /* Character position. */
179 /* Corresponding byte position. */
183 /* Access character and byte position of POS in a functional form. */
185 #define BYTEPOS(POS) (POS).bytepos
186 #define CHARPOS(POS) (POS).charpos
188 /* Set character position of POS to CHARPOS, byte position to BYTEPOS. */
190 #define SET_TEXT_POS(POS, CHARPOS, BYTEPOS) \
191 ((POS).charpos = (CHARPOS), (POS).bytepos = BYTEPOS)
193 /* Increment text position POS. */
195 #define INC_TEXT_POS(POS, MULTIBYTE_P) \
200 INC_POS ((POS).bytepos); \
206 /* Decrement text position POS. */
208 #define DEC_TEXT_POS(POS, MULTIBYTE_P) \
213 DEC_POS ((POS).bytepos); \
219 /* Set text position POS from marker MARKER. */
221 #define SET_TEXT_POS_FROM_MARKER(POS, MARKER) \
222 (CHARPOS (POS) = marker_position ((MARKER)), \
223 BYTEPOS (POS) = marker_byte_position ((MARKER)))
225 /* Set marker MARKER from text position POS. */
227 #define SET_MARKER_FROM_TEXT_POS(MARKER, POS) \
228 set_marker_both ((MARKER), Qnil, CHARPOS ((POS)), BYTEPOS ((POS)))
230 /* Value is non-zero if character and byte positions of POS1 and POS2
233 #define TEXT_POS_EQUAL_P(POS1, POS2) \
234 ((POS1).charpos == (POS2).charpos \
235 && (POS1).bytepos == (POS2).bytepos)
237 /* When rendering glyphs, redisplay scans string or buffer text,
238 overlay strings in that text, and does display table or control
239 character translations. The following structure captures a
240 position taking all this into account. */
244 /* Buffer or string position. */
247 /* If this is a position in an overlay string, overlay_string_index
248 is the index of that overlay string in the sequence of overlay
249 strings at `pos' in the order redisplay processes them. A value
250 < 0 means that this is not a position in an overlay string. */
251 int overlay_string_index
;
253 /* If this is a position in an overlay string, string_pos is the
254 position within that string. */
255 struct text_pos string_pos
;
257 /* If the character at the position above is a control character or
258 has a display table entry, dpvec_index is an index in the display
259 table or control character translation of that character. A
260 value < 0 means this is not a position in such a translation. */
266 /***********************************************************************
268 ***********************************************************************/
270 /* Enumeration of glyph types. Glyph structures contain a type field
271 containing one of the enumerators defined here. */
275 /* Glyph describes a character. */
278 /* Glyph describes a composition sequence. */
281 /* Glyph describes an image. */
284 /* Glyph is a space of fractional width and/or height. */
289 /* Structure describing how to use partial glyphs (images slicing) */
296 unsigned height
: 16;
302 Be extra careful when changing this structure! Esp. make sure that
303 functions producing glyphs, like append_glyph, fill ALL of the
304 glyph structure, and that GLYPH_EQUAL_P compares all
305 display-relevant members of glyphs (not to imply that these are the
306 only things to check when you add a member). */
310 /* Position from which this glyph was drawn. If `object' below is a
311 Lisp string, this is a position in that string. If it is a
312 buffer, this is a position in that buffer. A value of -1
313 together with a null object means glyph is a truncation glyph at
314 the start of a row. */
317 /* Lisp object source of this glyph. Currently either a buffer or
318 a string, if the glyph was produced from characters which came from
319 a buffer or a string; or 0 if the glyph was inserted by redisplay
320 for its own purposes such as padding. */
323 /* Width in pixels. */
326 /* Ascent and descent in pixels. */
327 short ascent
, descent
;
329 /* Vertical offset. If < 0, the glyph is displayed raised, if > 0
330 the glyph is displayed lowered. */
333 /* Which kind of glyph this is---character, image etc. Value
334 should be an enumerator of type enum glyph_type. */
337 /* 1 means this glyph was produced from multibyte text. Zero
338 means it was produced from unibyte text, i.e. charsets aren't
339 applicable, and encoding is not performed. */
340 unsigned multibyte_p
: 1;
342 /* Non-zero means draw a box line at the left or right side of this
343 glyph. This is part of the implementation of the face attribute
345 unsigned left_box_line_p
: 1;
346 unsigned right_box_line_p
: 1;
348 /* Non-zero means this glyph's physical ascent or descent is greater
349 than its logical ascent/descent, i.e. it may potentially overlap
350 glyphs above or below it. */
351 unsigned overlaps_vertically_p
: 1;
353 /* 1 means glyph is a padding glyph. Padding glyphs are used for
354 characters whose visual shape consists of more than one glyph
355 (e.g. Asian characters). All but the first glyph of such a glyph
356 sequence have the padding_p flag set. Only used for terminal
357 frames, and there only to minimize code changes. A better way
358 would probably be to use the width field of glyphs to express
360 unsigned padding_p
: 1;
362 /* 1 means the actual glyph is not available, draw a box instead.
363 This can happen when a font couldn't be loaded, or a character
364 doesn't have a glyph in a font. */
365 unsigned glyph_not_available_p
: 1;
367 #define FACE_ID_BITS 21
369 /* Face of the glyph. */
370 unsigned face_id
: FACE_ID_BITS
;
372 /* Type of font used to display the character glyph. May be used to
373 determine which set of functions to use to obtain font metrics
374 for the glyph. On W32, value should be an enumerator of the type
375 w32_char_font_type. Otherwise it equals FONT_TYPE_UNKNOWN. */
376 unsigned font_type
: 3;
378 struct glyph_slice slice
;
380 /* A union of sub-structures for different glyph types. */
383 /* Character code for character glyphs (type == CHAR_GLYPH). */
386 /* Composition ID for composition glyphs (type == COMPOSITION_GLYPH) */
389 /* Image ID for image glyphs (type == IMAGE_GLYPH). */
392 /* Sub-structure for type == STRETCH_GLYPH. */
395 /* The height of the glyph. */
396 unsigned height
: 16;
398 /* The ascent of the glyph. */
399 unsigned ascent
: 16;
403 /* Used to compare all bit-fields above in one step. */
409 /* Default value of the glyph font_type field. */
411 #define FONT_TYPE_UNKNOWN 0
413 /* Is GLYPH a space? */
415 #define CHAR_GLYPH_SPACE_P(GLYPH) \
416 (GLYPH_FROM_CHAR_GLYPH ((GLYPH)) == SPACEGLYPH)
418 /* Are glyph slices of glyphs *X and *Y equal */
420 #define GLYPH_SLICE_EQUAL_P(X, Y) \
421 ((X)->slice.x == (Y)->slice.x \
422 && (X)->slice.y == (Y)->slice.y \
423 && (X)->slice.width == (Y)->slice.width \
424 && (X)->slice.height == (Y)->slice.height)
426 /* Are glyphs *X and *Y displayed equal? */
428 #define GLYPH_EQUAL_P(X, Y) \
429 ((X)->type == (Y)->type \
430 && (X)->u.val == (Y)->u.val \
431 && GLYPH_SLICE_EQUAL_P (X, Y) \
432 && (X)->face_id == (Y)->face_id \
433 && (X)->padding_p == (Y)->padding_p \
434 && (X)->left_box_line_p == (Y)->left_box_line_p \
435 && (X)->right_box_line_p == (Y)->right_box_line_p \
436 && (X)->voffset == (Y)->voffset \
437 && (X)->pixel_width == (Y)->pixel_width)
439 /* Are character codes, faces, padding_ps of glyphs *X and *Y equal? */
441 #define GLYPH_CHAR_AND_FACE_EQUAL_P(X, Y) \
442 ((X)->u.ch == (Y)->u.ch \
443 && (X)->face_id == (Y)->face_id \
444 && (X)->padding_p == (Y)->padding_p)
446 /* Fill a character glyph GLYPH. CODE, FACE_ID, PADDING_P correspond
447 to the bits defined for the typedef `GLYPH' in lisp.h. */
449 #define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P) \
452 (GLYPH).u.ch = (CODE); \
453 (GLYPH).face_id = (FACE_ID); \
454 (GLYPH).padding_p = (PADDING_P); \
458 /* Fill a character type glyph GLYPH from a glyph typedef FROM as
459 defined in lisp.h. */
461 #define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM) \
462 SET_CHAR_GLYPH ((GLYPH), \
463 FAST_GLYPH_CHAR ((FROM)), \
464 FAST_GLYPH_FACE ((FROM)), \
467 /* Construct a glyph code from a character glyph GLYPH. If the
468 character is multibyte, return -1 as we can't use glyph table for a
469 multibyte character. */
471 #define GLYPH_FROM_CHAR_GLYPH(GLYPH) \
472 ((GLYPH).u.ch < 256 \
473 ? ((GLYPH).u.ch | ((GLYPH).face_id << CHARACTERBITS)) \
476 /* Is GLYPH a padding glyph? */
478 #define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p
483 /***********************************************************************
485 ***********************************************************************/
489 Glyph memory for frame-based redisplay is allocated from the heap
490 in one vector kept in a glyph pool structure which is stored with
491 the frame. The size of the vector is made large enough to cover
492 all windows on the frame.
494 Both frame and window glyph matrices reference memory from a glyph
495 pool in frame-based redisplay.
497 In window-based redisplay, no glyphs pools exist; windows allocate
498 and free their glyph memory themselves. */
502 /* Vector of glyphs allocated from the heap. */
503 struct glyph
*glyphs
;
505 /* Allocated size of `glyphs'. */
508 /* Number of rows and columns in a matrix. */
514 /***********************************************************************
516 ***********************************************************************/
520 Three kinds of glyph matrices exist:
522 1. Frame glyph matrices. These are used for terminal frames whose
523 redisplay needs a view of the whole screen due to limited terminal
524 capabilities. Frame matrices are used only in the update phase
525 of redisplay. They are built in update_frame and not used after
526 the update has been performed.
528 2. Window glyph matrices on frames having frame glyph matrices.
529 Such matrices are sub-matrices of their corresponding frame matrix,
530 i.e. frame glyph matrices and window glyph matrices share the same
531 glyph memory which is allocated in form of a glyph_pool structure.
532 Glyph rows in such a window matrix are slices of frame matrix rows.
534 2. Free-standing window glyph matrices managing their own glyph
535 storage. This form is used in window-based redisplay which
536 includes variable width and height fonts etc.
538 The size of a window's row vector depends on the height of fonts
539 defined on its frame. It is chosen so that the vector is large
540 enough to describe all lines in a window when it is displayed in
541 the smallest possible character size. When new fonts are loaded,
542 or window sizes change, the row vector is adjusted accordingly. */
546 /* The pool from which glyph memory is allocated, if any. This is
547 null for frame matrices and for window matrices managing their
549 struct glyph_pool
*pool
;
551 /* Vector of glyph row structures. The row at nrows - 1 is reserved
552 for the mode line. */
553 struct glyph_row
*rows
;
555 /* Number of elements allocated for the vector rows above. */
558 /* The number of rows used by the window if all lines were displayed
559 with the smallest possible character height. */
562 /* Origin within the frame matrix if this is a window matrix on a
563 frame having a frame matrix. Both values are zero for
564 window-based redisplay. */
565 int matrix_x
, matrix_y
;
567 /* Width and height of the matrix in columns and rows. */
568 int matrix_w
, matrix_h
;
570 /* If this structure describes a window matrix of window W,
571 window_left_col is the value of W->left_col, window_top_line the
572 value of W->top_line, window_height and window_width are width and
573 height of W, as returned by window_box, and window_vscroll is the
574 value of W->vscroll at the time the matrix was last adjusted.
575 Only set for window-based redisplay. */
576 int window_left_col
, window_top_line
;
577 int window_height
, window_width
;
580 /* Number of glyphs reserved for left and right marginal areas when
581 the matrix was last adjusted. */
582 int left_margin_glyphs
, right_margin_glyphs
;
584 /* Flag indicating that scrolling should not be tried in
585 update_window. This flag is set by functions like try_window_id
586 which do their own scrolling. */
587 unsigned no_scrolling_p
: 1;
589 /* Non-zero means window displayed in this matrix has a top mode
591 unsigned header_line_p
: 1;
594 /* A string identifying the method used to display the matrix. */
598 /* The buffer this matrix displays. Set in
599 mark_window_display_accurate_1. */
600 struct buffer
*buffer
;
602 /* Values of BEGV and ZV as of last redisplay. Set in
603 mark_window_display_accurate_1. */
608 /* Check that glyph pointers stored in glyph rows of MATRIX are okay.
609 This aborts if any pointer is found twice. */
612 void check_matrix_pointer_lossage
P_ ((struct glyph_matrix
*));
613 #define CHECK_MATRIX(MATRIX) check_matrix_pointer_lossage ((MATRIX))
615 #define CHECK_MATRIX(MATRIX) (void) 0
620 /***********************************************************************
622 ***********************************************************************/
624 /* Area in window glyph matrix. If values are added or removed, the
625 function mark_object in alloc.c has to be changed. */
636 /* Rows of glyphs in a windows or frame glyph matrix.
638 Each row is partitioned into three areas. The start and end of
639 each area is recorded in a pointer as shown below.
641 +--------------------+-------------+---------------------+
642 | left margin area | text area | right margin area |
643 +--------------------+-------------+---------------------+
645 glyphs[LEFT_MARGIN_AREA] glyphs[RIGHT_MARGIN_AREA]
650 Rows in frame matrices reference glyph memory allocated in a frame
651 glyph pool (see the description of struct glyph_pool). Rows in
652 window matrices on frames having frame matrices reference slices of
653 the glyphs of corresponding rows in the frame matrix.
655 Rows in window matrices on frames having no frame matrices point to
656 glyphs allocated from the heap via xmalloc;
657 glyphs[LEFT_MARGIN_AREA] is the start address of the allocated
658 glyph structure array. */
662 /* Pointers to beginnings of areas. The end of an area A is found at
663 A + 1 in the vector. The last element of the vector is the end
666 Kludge alert: Even if used[TEXT_AREA] == 0, glyphs[TEXT_AREA][0]'s
667 position field is used. It is -1 if this row does not correspond
668 to any text; it is some buffer position if the row corresponds to
669 an empty display line that displays a line end. This is what old
670 redisplay used to do. (Except in code for terminal frames, this
671 kludge is no longer used, I believe. --gerd).
673 See also start, end, displays_text_p and ends_at_zv_p for cleaner
674 ways to do it. The special meaning of positions 0 and -1 will be
675 removed some day, so don't use it in new code. */
676 struct glyph
*glyphs
[1 + LAST_AREA
];
678 /* Number of glyphs actually filled in areas. */
679 short used
[LAST_AREA
];
681 /* Window-relative x and y-position of the top-left corner of this
682 row. If y < 0, this means that abs (y) pixels of the row are
683 invisible because it is partially visible at the top of a window.
684 If x < 0, this means that abs (x) pixels of the first glyph of
685 the text area of the row are invisible because the glyph is
686 partially visible. */
689 /* Width of the row in pixels without taking face extension at the
690 end of the row into account, and without counting truncation
691 and continuation glyphs at the end of a row on ttys. */
694 /* Logical ascent/height of this line. The value of ascent is zero
695 and height is 1 on terminal frames. */
698 /* Physical ascent/height of this line. If max_ascent > ascent,
699 this line overlaps the line above it on the display. Otherwise,
700 if max_height > height, this line overlaps the line beneath it. */
701 int phys_ascent
, phys_height
;
703 /* Portion of row that is visible. Partially visible rows may be
704 found at the top and bottom of a window. This is 1 for tty
705 frames. It may be < 0 in case of completely invisible rows. */
708 /* Extra line spacing added after this row. Do not consider this
709 in last row when checking if row is fully visible. */
710 int extra_line_spacing
;
712 /* Hash code. This hash code is available as soon as the row
713 is constructed, i.e. after a call to display_line. */
716 /* First position in this row. This is the text position, including
717 overlay position information etc, where the display of this row
718 started, and can thus be less the position of the first glyph
719 (e.g. due to invisible text or horizontal scrolling). */
720 struct display_pos start
;
722 /* Text position at the end of this row. This is the position after
723 the last glyph on this row. It can be greater than the last
724 glyph position + 1, due to truncation, invisible text etc. In an
725 up-to-date display, this should always be equal to the start
726 position of the next row. */
727 struct display_pos end
;
729 /* Non-zero means the overlay arrow bitmap is on this line.
730 -1 means use default overlay arrow bitmap, else
731 it specifies actual fringe bitmap number. */
732 int overlay_arrow_bitmap
;
734 /* Left fringe bitmap number (enum fringe_bitmap_type). */
735 unsigned left_user_fringe_bitmap
: FRINGE_ID_BITS
;
737 /* Right fringe bitmap number (enum fringe_bitmap_type). */
738 unsigned right_user_fringe_bitmap
: FRINGE_ID_BITS
;
740 /* Left fringe bitmap number (enum fringe_bitmap_type). */
741 unsigned left_fringe_bitmap
: FRINGE_ID_BITS
;
743 /* Right fringe bitmap number (enum fringe_bitmap_type). */
744 unsigned right_fringe_bitmap
: FRINGE_ID_BITS
;
746 /* Face of the left fringe glyph. */
747 unsigned left_user_fringe_face_id
: FACE_ID_BITS
;
749 /* Face of the right fringe glyph. */
750 unsigned right_user_fringe_face_id
: FACE_ID_BITS
;
752 /* Face of the left fringe glyph. */
753 unsigned left_fringe_face_id
: FACE_ID_BITS
;
755 /* Face of the right fringe glyph. */
756 unsigned right_fringe_face_id
: FACE_ID_BITS
;
758 /* 1 means that we must draw the bitmaps of this row. */
759 unsigned redraw_fringe_bitmaps_p
: 1;
761 /* In a desired matrix, 1 means that this row must be updated. In a
762 current matrix, 0 means that the row has been invalidated, i.e.
763 the row's contents do not agree with what is visible on the
765 unsigned enabled_p
: 1;
767 /* 1 means row displays a text line that is truncated on the left or
769 unsigned truncated_on_left_p
: 1;
770 unsigned truncated_on_right_p
: 1;
772 /* 1 means that this row displays a continued line, i.e. it has a
773 continuation mark at the right side. */
774 unsigned continued_p
: 1;
776 /* 0 means that this row does not contain any text, i.e. it is
777 a blank line at the window and buffer end. */
778 unsigned displays_text_p
: 1;
780 /* 1 means that this line ends at ZV. */
781 unsigned ends_at_zv_p
: 1;
783 /* 1 means the face of the last glyph in the text area is drawn to
784 the right end of the window. This flag is used in
785 update_text_area to optimize clearing to the end of the area. */
786 unsigned fill_line_p
: 1;
788 /* Non-zero means display a bitmap on X frames indicating that this
789 line contains no text and ends in ZV. */
790 unsigned indicate_empty_line_p
: 1;
792 /* 1 means this row contains glyphs that overlap each other because
793 of lbearing or rbearing. */
794 unsigned contains_overlapping_glyphs_p
: 1;
796 /* 1 means this row is as wide as the window it is displayed in, including
797 scroll bars, fringes, and internal borders. This also
798 implies that the row doesn't have marginal areas. */
799 unsigned full_width_p
: 1;
801 /* Non-zero means row is a mode or header-line. */
802 unsigned mode_line_p
: 1;
804 /* 1 in a current row means this row is overlapped by another row. */
805 unsigned overlapped_p
: 1;
807 /* 1 means this line ends in the middle of a character consisting
808 of more than one glyph. Some glyphs have been put in this row,
809 the rest are put in rows below this one. */
810 unsigned ends_in_middle_of_char_p
: 1;
812 /* 1 means this line starts in the middle of a character consisting
813 of more than one glyph. Some glyphs have been put in the
814 previous row, the rest are put in this row. */
815 unsigned starts_in_middle_of_char_p
: 1;
817 /* 1 in a current row means this row overlaps others. */
818 unsigned overlapping_p
: 1;
820 /* 1 means some glyphs in this row are displayed in mouse-face. */
821 unsigned mouse_face_p
: 1;
823 /* 1 means this row was ended by a newline from a string. */
824 unsigned ends_in_newline_from_string_p
: 1;
826 /* 1 means this row width is exactly the width of the window, and the
827 final newline character is hidden in the right fringe. */
828 unsigned exact_window_width_line_p
: 1;
830 /* 1 means this row currently shows the cursor in the right fringe. */
831 unsigned cursor_in_fringe_p
: 1;
833 /* 1 means the last glyph in the row is part of an ellipsis. */
834 unsigned ends_in_ellipsis_p
: 1;
836 /* Non-zero means display a bitmap on X frames indicating that this
837 the first line of the buffer. */
838 unsigned indicate_bob_p
: 1;
840 /* Non-zero means display a bitmap on X frames indicating that this
841 the top line of the window, but not start of the buffer. */
842 unsigned indicate_top_line_p
: 1;
844 /* Non-zero means display a bitmap on X frames indicating that this
845 the last line of the buffer. */
846 unsigned indicate_eob_p
: 1;
848 /* Non-zero means display a bitmap on X frames indicating that this
849 the bottom line of the window, but not end of the buffer. */
850 unsigned indicate_bottom_line_p
: 1;
852 /* Continuation lines width at the start of the row. */
853 int continuation_lines_width
;
857 /* Get a pointer to row number ROW in matrix MATRIX. If GLYPH_DEBUG
858 is defined to a non-zero value, the function matrix_row checks that
859 we don't try to access rows that are out of bounds. */
862 struct glyph_row
*matrix_row
P_ ((struct glyph_matrix
*, int));
863 #define MATRIX_ROW(MATRIX, ROW) matrix_row ((MATRIX), (ROW))
865 #define MATRIX_ROW(MATRIX, ROW) ((MATRIX)->rows + (ROW))
868 /* Return a pointer to the row reserved for the mode line in MATRIX.
869 Row MATRIX->nrows - 1 is always reserved for the mode line. */
871 #define MATRIX_MODE_LINE_ROW(MATRIX) \
872 ((MATRIX)->rows + (MATRIX)->nrows - 1)
874 /* Return a pointer to the row reserved for the header line in MATRIX.
875 This is always the first row in MATRIX because that's the only
876 way that works in frame-based redisplay. */
878 #define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows
880 /* Return a pointer to first row in MATRIX used for text display. */
882 #define MATRIX_FIRST_TEXT_ROW(MATRIX) \
883 ((MATRIX)->rows->mode_line_p ? (MATRIX)->rows + 1 : (MATRIX)->rows)
885 /* Return a pointer to the first glyph in the text area of a row.
886 MATRIX is the glyph matrix accessed, and ROW is the row index in
889 #define MATRIX_ROW_GLYPH_START(MATRIX, ROW) \
890 (MATRIX_ROW ((MATRIX), (ROW))->glyphs[TEXT_AREA])
892 /* Return the number of used glyphs in the text area of a row. */
894 #define MATRIX_ROW_USED(MATRIX, ROW) \
895 (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA])
897 /* Return the character/ byte position at which the display of ROW
900 #define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->start.pos.charpos)
901 #define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->start.pos.bytepos)
903 /* Return the character/ byte position at which ROW ends. */
905 #define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->end.pos.charpos)
906 #define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->end.pos.bytepos)
908 /* Return the vertical position of ROW in MATRIX. */
910 #define MATRIX_ROW_VPOS(ROW, MATRIX) ((ROW) - (MATRIX)->rows)
912 /* Return the last glyph row + 1 in MATRIX on window W reserved for
913 text. If W has a mode line, the last row in the matrix is reserved
916 #define MATRIX_BOTTOM_TEXT_ROW(MATRIX, W) \
919 - (WINDOW_WANTS_MODELINE_P ((W)) ? 1 : 0))
921 /* Non-zero if the face of the last glyph in ROW's text area has
922 to be drawn to the end of the text area. */
924 #define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)
926 /* Set and query the enabled_p flag of glyph row ROW in MATRIX. */
928 #define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
929 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0)
931 #define MATRIX_ROW_ENABLED_P(MATRIX, ROW) \
932 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p)
934 /* Non-zero if ROW displays text. Value is non-zero if the row is
935 blank but displays a line end. */
937 #define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)
942 #define MR_PARTIALLY_VISIBLE(ROW) \
943 ((ROW)->height != (ROW)->visible_height)
945 #define MR_PARTIALLY_VISIBLE_AT_TOP(W, ROW) \
946 ((ROW)->y < WINDOW_HEADER_LINE_HEIGHT ((W)))
948 #define MR_PARTIALLY_VISIBLE_AT_BOTTOM(W, ROW) \
949 (((ROW)->y + (ROW)->height - (ROW)->extra_line_spacing) \
950 > WINDOW_BOX_HEIGHT_NO_MODE_LINE ((W)))
952 /* Non-zero if ROW is not completely visible in window W. */
954 #define MATRIX_ROW_PARTIALLY_VISIBLE_P(W, ROW) \
955 (MR_PARTIALLY_VISIBLE ((ROW)) \
956 && (MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)) \
957 || MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW))))
961 /* Non-zero if ROW is partially visible at the top of window W. */
963 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW) \
964 (MR_PARTIALLY_VISIBLE ((ROW)) \
965 && MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)))
967 /* Non-zero if ROW is partially visible at the bottom of window W. */
969 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW) \
970 (MR_PARTIALLY_VISIBLE ((ROW)) \
971 && MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW)))
973 /* Return the bottom Y + 1 of ROW. */
975 #define MATRIX_ROW_BOTTOM_Y(ROW) ((ROW)->y + (ROW)->height)
977 /* Is ROW the last visible one in the display described by the
978 iterator structure pointed to by IT?. */
980 #define MATRIX_ROW_LAST_VISIBLE_P(ROW, IT) \
981 (MATRIX_ROW_BOTTOM_Y ((ROW)) >= (IT)->last_visible_y)
983 /* Non-zero if ROW displays a continuation line. */
985 #define MATRIX_ROW_CONTINUATION_LINE_P(ROW) \
986 ((ROW)->continuation_lines_width > 0)
988 /* Non-zero if ROW ends in the middle of a character. This is the
989 case for continued lines showing only part of a display table entry
990 or a control char, or an overlay string. */
992 #define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW) \
993 ((ROW)->end.dpvec_index > 0 \
994 || (ROW)->end.overlay_string_index >= 0 \
995 || (ROW)->ends_in_middle_of_char_p)
997 /* Non-zero if ROW ends in the middle of an overlay string. */
999 #define MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P(ROW) \
1000 ((ROW)->end.overlay_string_index >= 0)
1002 /* Non-zero if ROW starts in the middle of a character. See above. */
1004 #define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW) \
1005 ((ROW)->start.dpvec_index > 0 \
1006 || (ROW)->starts_in_middle_of_char_p \
1007 || ((ROW)->start.overlay_string_index >= 0 \
1008 && (ROW)->start.string_pos.charpos > 0))
1010 /* Non-zero means ROW overlaps its predecessor. */
1012 #define MATRIX_ROW_OVERLAPS_PRED_P(ROW) \
1013 ((ROW)->phys_ascent > (ROW)->ascent)
1015 /* Non-zero means ROW overlaps its successor. */
1017 #define MATRIX_ROW_OVERLAPS_SUCC_P(ROW) \
1018 ((ROW)->phys_height - (ROW)->phys_ascent \
1019 > (ROW)->height - (ROW)->ascent)
1021 /* Non-zero means that fonts have been loaded since the last glyph
1022 matrix adjustments. The function redisplay_internal adjusts glyph
1023 matrices when this flag is non-zero. */
1025 extern int fonts_changed_p
;
1027 /* A glyph for a space. */
1029 extern struct glyph space_glyph
;
1031 /* Frame being updated by update_window/update_frame. */
1033 extern struct frame
*updating_frame
;
1035 /* Window being updated by update_window. This is non-null as long as
1036 update_window has not finished, and null otherwise. It's role is
1037 analogous to updating_frame. */
1039 extern struct window
*updated_window
;
1041 /* Glyph row and area updated by update_window_line. */
1043 extern struct glyph_row
*updated_row
;
1044 extern int updated_area
;
1046 /* Non-zero means reading single-character input with prompt so put
1047 cursor on mini-buffer after the prompt. Positive means at end of
1048 text in echo area; negative means at beginning of line. */
1050 extern int cursor_in_echo_area
;
1052 /* Non-zero means last display completed. Zero means it was
1055 extern int display_completed
;
1057 /* Non-zero means redisplay has been performed directly (see also
1058 direct_output_for_insert and direct_output_forward_char), so that
1059 no further updating has to be performed. The function
1060 redisplay_internal checks this flag, and does nothing but reset it
1061 to zero if it is non-zero. */
1063 extern int redisplay_performed_directly_p
;
1065 /* A temporary storage area, including a row of glyphs. Initialized
1066 in xdisp.c. Used for various purposes, as an example see
1067 direct_output_for_insert. */
1069 extern struct glyph_row scratch_glyph_row
;
1073 /************************************************************************
1075 ************************************************************************/
1077 /* Enumeration for overriding/changing the face to use for drawing
1078 glyphs in draw_glyphs. */
1080 enum draw_glyphs_face
1090 #ifdef HAVE_WINDOW_SYSTEM
1092 /* A sequence of glyphs to be drawn in the same face. */
1096 /* X-origin of the string. */
1099 /* Y-origin and y-position of the base line of this string. */
1102 /* The width of the string, not including a face extension. */
1105 /* The width of the string, including a face extension. */
1106 int background_width
;
1108 /* The height of this string. This is the height of the line this
1109 string is drawn in, and can be different from the height of the
1110 font the string is drawn in. */
1113 /* Number of pixels this string overwrites in front of its x-origin.
1114 This number is zero if the string has an lbearing >= 0; it is
1115 -lbearing, if the string has an lbearing < 0. */
1118 /* Number of pixels this string overwrites past its right-most
1119 nominal x-position, i.e. x + width. Zero if the string's
1120 rbearing is <= its nominal width, rbearing - width otherwise. */
1123 /* The frame on which the glyph string is drawn. */
1126 /* The window on which the glyph string is drawn. */
1129 /* X display and window for convenience. */
1133 /* The glyph row for which this string was built. It determines the
1134 y-origin and height of the string. */
1135 struct glyph_row
*row
;
1137 /* The area within row. */
1138 enum glyph_row_area area
;
1140 /* Characters to be drawn, and number of characters. */
1144 /* A face-override for drawing cursors, mouse face and similar. */
1145 enum draw_glyphs_face hl
;
1147 /* Face in which this string is to be drawn. */
1150 /* Font in which this string is to be drawn. */
1153 /* Font info for this string. */
1154 struct font_info
*font_info
;
1156 /* Non-null means this string describes (part of) a composition.
1157 All characters from char2b are drawn composed. */
1158 struct composition
*cmp
;
1160 /* Index of this glyph string's first character in the glyph
1161 definition of CMP. If this is zero, this glyph string describes
1162 the first character of a composition. */
1165 /* 1 means this glyph strings face has to be drawn to the right end
1166 of the window's drawing area. */
1167 unsigned extends_to_end_of_line_p
: 1;
1169 /* 1 means the background of this string has been drawn. */
1170 unsigned background_filled_p
: 1;
1172 /* 1 means glyph string must be drawn with 16-bit functions. */
1173 unsigned two_byte_p
: 1;
1175 /* 1 means that the original font determined for drawing this glyph
1176 string could not be loaded. The member `font' has been set to
1177 the frame's default font in this case. */
1178 unsigned font_not_found_p
: 1;
1180 /* 1 means that the face in which this glyph string is drawn has a
1182 unsigned stippled_p
: 1;
1184 /* 1 means only the foreground of this glyph string must be drawn,
1185 and we should use the physical height of the line this glyph
1186 string appears in as clip rect. */
1187 unsigned for_overlaps_p
: 1;
1189 /* The GC to use for drawing this glyph string. */
1190 #if defined(HAVE_X_WINDOWS) || defined(MAC_OS)
1193 #if defined(HAVE_NTGUI)
1198 /* A pointer to the first glyph in the string. This glyph
1199 corresponds to char2b[0]. Needed to draw rectangles if
1200 font_not_found_p is 1. */
1201 struct glyph
*first_glyph
;
1203 /* Image, if any. */
1207 struct glyph_slice slice
;
1209 /* Non-null means the horizontal clipping region starts from the
1210 left edge of *clip_head, and ends with the right edge of
1211 *clip_tail, not including their overhangs. */
1212 struct glyph_string
*clip_head
, *clip_tail
;
1214 struct glyph_string
*next
, *prev
;
1217 #endif /* HAVE_WINDOW_SYSTEM */
1220 /************************************************************************
1222 ************************************************************************/
1224 /* Return the height of the mode line in glyph matrix MATRIX, or zero
1225 if not known. This macro is called under circumstances where
1226 MATRIX might not have been allocated yet. */
1228 #define MATRIX_MODE_LINE_HEIGHT(MATRIX) \
1229 ((MATRIX) && (MATRIX)->rows \
1230 ? MATRIX_MODE_LINE_ROW (MATRIX)->height \
1233 /* Return the height of the header line in glyph matrix MATRIX, or zero
1234 if not known. This macro is called under circumstances where
1235 MATRIX might not have been allocated yet. */
1237 #define MATRIX_HEADER_LINE_HEIGHT(MATRIX) \
1238 ((MATRIX) && (MATRIX)->rows \
1239 ? MATRIX_HEADER_LINE_ROW (MATRIX)->height \
1242 /* Return the desired face id for the mode line of a window, depending
1243 on whether the window is selected or not, or if the window is the
1244 scrolling window for the currently active minibuffer window.
1246 Due to the way display_mode_lines manipulates with the contents of
1247 selected_window, this macro needs three arguments: SELW which is
1248 compared against the current value of selected_window, MBW which is
1249 compared against minibuf_window (if SELW doesn't match), and SCRW
1250 which is compared against minibuf_selected_window (if MBW matches). */
1252 #define CURRENT_MODE_LINE_FACE_ID_3(SELW, MBW, SCRW) \
1253 ((!mode_line_in_non_selected_windows \
1254 || (SELW) == XWINDOW (selected_window) \
1255 || (minibuf_level > 0 \
1256 && !NILP (minibuf_selected_window) \
1257 && (MBW) == XWINDOW (minibuf_window) \
1258 && (SCRW) == XWINDOW (minibuf_selected_window))) \
1259 ? MODE_LINE_FACE_ID \
1260 : MODE_LINE_INACTIVE_FACE_ID)
1263 /* Return the desired face id for the mode line of window W. */
1265 #define CURRENT_MODE_LINE_FACE_ID(W) \
1266 (CURRENT_MODE_LINE_FACE_ID_3((W), XWINDOW (selected_window), (W)))
1268 /* Return the current height of the mode line of window W. If not
1269 known from current_mode_line_height, look at W's current glyph
1270 matrix, or return a default based on the height of the font of the
1271 face `mode-line'. */
1273 #define CURRENT_MODE_LINE_HEIGHT(W) \
1274 (current_mode_line_height >= 0 \
1275 ? current_mode_line_height \
1276 : (MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1277 ? MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1278 : estimate_mode_line_height (XFRAME ((W)->frame), \
1279 CURRENT_MODE_LINE_FACE_ID (W))))
1281 /* Return the current height of the header line of window W. If not
1282 known from current_header_line_height, look at W's current glyph
1283 matrix, or return an estimation based on the height of the font of
1284 the face `header-line'. */
1286 #define CURRENT_HEADER_LINE_HEIGHT(W) \
1287 (current_header_line_height >= 0 \
1288 ? current_header_line_height \
1289 : (MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1290 ? MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1291 : estimate_mode_line_height (XFRAME ((W)->frame), \
1292 HEADER_LINE_FACE_ID)))
1294 /* Return the height of the desired mode line of window W. */
1296 #define DESIRED_MODE_LINE_HEIGHT(W) \
1297 MATRIX_MODE_LINE_HEIGHT ((W)->desired_matrix)
1299 /* Return the height of the desired header line of window W. */
1301 #define DESIRED_HEADER_LINE_HEIGHT(W) \
1302 MATRIX_HEADER_LINE_HEIGHT ((W)->desired_matrix)
1304 /* Value is non-zero if window W wants a mode line. */
1306 #define WINDOW_WANTS_MODELINE_P(W) \
1307 (!MINI_WINDOW_P ((W)) \
1308 && !(W)->pseudo_window_p \
1309 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1310 && BUFFERP ((W)->buffer) \
1311 && !NILP (XBUFFER ((W)->buffer)->mode_line_format) \
1312 && WINDOW_TOTAL_LINES (W) > 1)
1314 /* Value is non-zero if window W wants a header line. */
1316 #define WINDOW_WANTS_HEADER_LINE_P(W) \
1317 (!MINI_WINDOW_P ((W)) \
1318 && !(W)->pseudo_window_p \
1319 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1320 && BUFFERP ((W)->buffer) \
1321 && !NILP (XBUFFER ((W)->buffer)->header_line_format) \
1322 && WINDOW_TOTAL_LINES (W) > 1 + !NILP (XBUFFER ((W)->buffer)->mode_line_format))
1325 /* Return proper value to be used as baseline offset of font that has
1326 ASCENT and DESCENT to draw characters by the font at the vertical
1327 center of the line of frame F.
1329 Here, our task is to find the value of BOFF in the following figure;
1331 -------------------------+-----------+-
1332 -+-+---------+-+ | |
1334 | | | | F_ASCENT F_HEIGHT
1337 | | |-|-+------+-----------|------- baseline
1339 | |---------|-+-+ | |
1341 -+-+---------+-+ F_DESCENT |
1342 -------------------------+-----------+-
1344 -BOFF + DESCENT + (F_HEIGHT - HEIGHT) / 2 = F_DESCENT
1345 BOFF = DESCENT + (F_HEIGHT - HEIGHT) / 2 - F_DESCENT
1346 DESCENT = FONT->descent
1347 HEIGHT = FONT_HEIGHT (FONT)
1348 F_DESCENT = (FRAME_FONT (F)->descent
1349 - F->output_data.x->baseline_offset)
1350 F_HEIGHT = FRAME_LINE_HEIGHT (F)
1353 #define VCENTER_BASELINE_OFFSET(FONT, F) \
1354 (FONT_DESCENT (FONT) \
1355 + (FRAME_LINE_HEIGHT ((F)) - FONT_HEIGHT ((FONT)) \
1356 + (FRAME_LINE_HEIGHT ((F)) > FONT_HEIGHT ((FONT)))) / 2 \
1357 - (FONT_DESCENT (FRAME_FONT (F)) - FRAME_BASELINE_OFFSET (F)))
1360 /***********************************************************************
1362 ***********************************************************************/
1364 /* Indices of face attributes in Lisp face vectors. Slot zero is the
1367 enum lface_attribute_index
1369 LFACE_FAMILY_INDEX
= 1,
1374 LFACE_UNDERLINE_INDEX
,
1375 LFACE_INVERSE_INDEX
,
1376 LFACE_FOREGROUND_INDEX
,
1377 LFACE_BACKGROUND_INDEX
,
1378 LFACE_STIPPLE_INDEX
,
1379 LFACE_OVERLINE_INDEX
,
1380 LFACE_STRIKE_THROUGH_INDEX
,
1383 LFACE_INHERIT_INDEX
,
1384 LFACE_AVGWIDTH_INDEX
,
1385 LFACE_FONTSET_INDEX
,
1390 /* Box types of faces. */
1394 /* No box around text. */
1397 /* Simple box of specified width and color. Default width is 1, and
1398 default color is the foreground color of the face. */
1401 /* Boxes with 3D shadows. Color equals the background color of the
1402 face. Width is specified. */
1408 /* Structure describing a realized face.
1410 For each Lisp face, 0..N realized faces can exist for different
1411 frames and different charsets. Realized faces are built from Lisp
1412 faces and text properties/overlays by merging faces and adding
1413 unspecified attributes from the `default' face. */
1417 /* The id of this face. The id equals the index of this face in the
1418 vector faces_by_id of its face cache. */
1421 #ifdef HAVE_WINDOW_SYSTEM
1423 /* If non-zero, this is a GC that we can use without modification for
1424 drawing the characters in this face. */
1427 /* Font used for this face, or null if the font could not be loaded
1428 for some reason. This points to a `font' slot of a struct
1429 font_info, and we should not call XFreeFont on it because the
1430 font may still be used somewhere else. */
1433 /* Background stipple or bitmap used for this face. This is
1434 an id as returned from load_pixmap. */
1437 #else /* not HAVE_WINDOW_SYSTEM */
1442 #endif /* not HAVE_WINDOW_SYSTEM */
1444 /* Pixel value of foreground color for X frames. Color index
1446 unsigned long foreground
;
1448 /* Pixel value or color index of background color. */
1449 unsigned long background
;
1451 /* Pixel value or color index of underline color. */
1452 unsigned long underline_color
;
1454 /* Pixel value or color index of overlined, strike-through, or box
1456 unsigned long overline_color
;
1457 unsigned long strike_through_color
;
1458 unsigned long box_color
;
1460 /* The font's name. This points to a `name' of a font_info, and it
1461 must not be freed. */
1464 /* Font info ID for this face's font. An ID is stored here because
1465 pointers to font_info structures may change. The reason is that
1466 they are pointers into a font table vector that is itself
1470 /* Fontset ID if for this face's fontset. Non-ASCII faces derived
1471 from the same ASCII face have the same fontset. */
1474 /* Pixmap width and height. */
1475 unsigned int pixmap_w
, pixmap_h
;
1477 /* Non-zero means characters in this face have a box that thickness
1478 around them. If it is negative, the absolute value indicates the
1479 thickness, and the horizontal lines of box (top and bottom) are
1480 drawn inside of characters glyph area. The vertical lines of box
1481 (left and right) are drawn as the same way as the case that this
1482 value is positive. */
1485 /* Type of box drawn. A value of FACE_NO_BOX means no box is drawn
1486 around text in this face. A value of FACE_SIMPLE_BOX means a box
1487 of width box_line_width is drawn in color box_color. A value of
1488 FACE_RAISED_BOX or FACE_SUNKEN_BOX means a 3D box is drawn with
1489 shadow colors derived from the background color of the face. */
1490 enum face_box_type box
;
1492 /* If `box' above specifies a 3D type, 1 means use box_color for
1494 unsigned use_box_color_for_shadows_p
: 1;
1496 /* The Lisp face attributes this face realizes. All attributes
1497 in this vector are non-nil. */
1498 Lisp_Object lface
[LFACE_VECTOR_SIZE
];
1500 /* The hash value of this face. */
1503 /* Non-zero if text in this face should be underlined, overlined,
1504 strike-through or have a box drawn around it. */
1505 unsigned underline_p
: 1;
1506 unsigned overline_p
: 1;
1507 unsigned strike_through_p
: 1;
1509 /* 1 means that the colors specified for this face could not be
1510 loaded, and were replaced by default colors, so they shouldn't be
1512 unsigned foreground_defaulted_p
: 1;
1513 unsigned background_defaulted_p
: 1;
1515 /* 1 means that either no color is specified for underlining or that
1516 the specified color couldn't be loaded. Use the foreground
1517 color when drawing in that case. */
1518 unsigned underline_defaulted_p
: 1;
1520 /* 1 means that either no color is specified for the corresponding
1521 attribute or that the specified color couldn't be loaded.
1522 Use the foreground color when drawing in that case. */
1523 unsigned overline_color_defaulted_p
: 1;
1524 unsigned strike_through_color_defaulted_p
: 1;
1525 unsigned box_color_defaulted_p
: 1;
1527 /* TTY appearances. Blinking is not yet implemented. Colors are
1528 found in `lface' with empty color string meaning the default
1529 color of the TTY. */
1530 unsigned tty_bold_p
: 1;
1531 unsigned tty_dim_p
: 1;
1532 unsigned tty_underline_p
: 1;
1533 unsigned tty_alt_charset_p
: 1;
1534 unsigned tty_reverse_p
: 1;
1535 unsigned tty_blinking_p
: 1;
1537 /* 1 means that colors of this face may not be freed because they
1538 have been copied bitwise from a base face (see
1540 unsigned colors_copied_bitwise_p
: 1;
1542 /* If non-zero, use overstrike (to simulate bold-face). */
1543 unsigned overstrike
: 1;
1545 /* Next and previous face in hash collision list of face cache. */
1546 struct face
*next
, *prev
;
1548 /* If this face is an ASCII face, this points to this face itself.
1549 Otherwise, this points to an ASCII face that has the same
1550 attributes except the font. */
1551 struct face
*ascii_face
;
1555 /* Color index indicating that face uses a terminal's default color. */
1557 #define FACE_TTY_DEFAULT_COLOR ((unsigned long) -1)
1559 /* Color index indicating that face uses an unknown foreground color. */
1561 #define FACE_TTY_DEFAULT_FG_COLOR ((unsigned long) -2)
1563 /* Color index indicating that face uses an unknown background color. */
1565 #define FACE_TTY_DEFAULT_BG_COLOR ((unsigned long) -3)
1567 /* Non-zero if FACE was realized for unibyte use. */
1569 #define FACE_UNIBYTE_P(FACE) ((FACE)->charset < 0)
1572 /* IDs of important faces known by the C face code. These are the IDs
1573 of the faces for CHARSET_ASCII. */
1579 MODE_LINE_INACTIVE_FACE_ID
,
1582 HEADER_LINE_FACE_ID
,
1588 BASIC_FACE_ID_SENTINEL
1591 #define MAX_FACE_ID ((1 << FACE_ID_BITS) - 1)
1593 /* A cache of realized faces. Each frame has its own cache because
1594 Emacs allows different frame-local face definitions. */
1598 /* Hash table of cached realized faces. */
1599 struct face
**buckets
;
1601 /* Back-pointer to the frame this cache belongs to. */
1604 /* A vector of faces so that faces can be referenced by an ID. */
1605 struct face
**faces_by_id
;
1607 /* The allocated size, and number of used slots of faces_by_id. */
1610 /* Flag indicating that attributes of the `menu' face have been
1612 unsigned menu_face_changed_p
: 1;
1616 /* Prepare face FACE for use on frame F. This must be called before
1617 using X resources of FACE. */
1619 #define PREPARE_FACE_FOR_DISPLAY(F, FACE) \
1620 if ((FACE)->gc == 0) \
1621 prepare_face_for_display ((F), (FACE)); \
1625 /* Return a pointer to the face with ID on frame F, or null if such a
1626 face doesn't exist. */
1628 #define FACE_FROM_ID(F, ID) \
1629 (((unsigned) (ID) < FRAME_FACE_CACHE (F)->used) \
1630 ? FRAME_FACE_CACHE (F)->faces_by_id[ID] \
1633 #ifdef HAVE_WINDOW_SYSTEM
1635 /* Non-zero if FACE is suitable for displaying character CHAR. */
1637 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) \
1638 (ASCII_CHAR_P (CHAR) \
1639 ? (FACE) == (FACE)->ascii_face \
1640 : face_suitable_for_char_p ((FACE), (CHAR)))
1642 /* Return the id of the realized face on frame F that is like the face
1643 with id ID but is suitable for displaying character CHAR.
1644 This macro is only meaningful for multibyte character CHAR. */
1646 #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) \
1647 (ASCII_CHAR_P (CHAR) \
1648 ? (FACE)->ascii_face->id \
1649 : face_for_char ((F), (FACE), (CHAR), (POS), (OBJECT)))
1651 #else /* not HAVE_WINDOW_SYSTEM */
1653 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) 1
1654 #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) ((FACE)->id)
1656 #endif /* not HAVE_WINDOW_SYSTEM */
1658 /* Non-zero means face attributes have been changed since the last
1659 redisplay. Used in redisplay_internal. */
1661 extern int face_change_count
;
1666 /***********************************************************************
1668 ***********************************************************************/
1670 /* Structure used to describe where and how to draw a fringe bitmap.
1671 WHICH is the fringe bitmap to draw. WD and H is the (adjusted)
1672 width and height of the bitmap, DH is the height adjustment (if
1673 bitmap is periodic). X and Y are frame coordinates of the area to
1674 display the bitmap, DY is relative offset of the bitmap into that
1675 area. BX, NX, BY, NY specifies the area to clear if the bitmap
1676 does not fill the entire area. FACE is the fringe face. */
1678 struct draw_fringe_bitmap_params
1680 int which
; /* enum fringe_bitmap_type */
1681 unsigned short *bits
;
1685 unsigned cursor_p
: 1;
1686 unsigned overlay_p
: 1;
1690 #define MAX_FRINGE_BITMAPS (1<<FRINGE_ID_BITS)
1693 /***********************************************************************
1695 ***********************************************************************/
1697 /* Iteration over things to display in current_buffer or in a string.
1699 The iterator handles:
1701 1. Overlay strings (after-string, before-string).
1703 3. Invisible text properties.
1704 4. Selective display.
1705 5. Translation of characters via display tables.
1706 6. Translation of control characters to the forms `\003' or `^C'.
1707 7. `glyph' and `space-width' properties.
1709 Iterators are initialized by calling init_iterator or one of the
1710 equivalent functions below. A call to get_next_display_element
1711 loads the iterator structure with information about what next to
1712 display. A call to set_iterator_to_next increments the iterator's
1715 Characters from overlay strings, display table entries or control
1716 character translations are returned one at a time. For example, if
1717 we have a text of `a\x01' where `a' has a display table definition
1718 of `cd' and the control character is displayed with a leading
1719 arrow, then the iterator will return:
1721 Call Return Source Call next
1722 -----------------------------------------------------------------
1723 next c display table move
1724 next d display table move
1725 next ^ control char move
1726 next A control char move
1728 The same mechanism is also used to return characters for ellipses
1729 displayed at the end of invisible text.
1731 CAVEAT: Under some circumstances, move_.* functions can be called
1732 asynchronously, e.g. when computing a buffer position from an x and
1733 y pixel position. This means that these functions and functions
1734 called from them SHOULD NOT USE xmalloc and alike. See also the
1735 comment at the start of xdisp.c. */
1737 /* Enumeration describing what kind of display element an iterator is
1738 loaded with after a call to get_next_display_element. */
1740 enum display_element_type
1742 /* A normal character. */
1745 /* A composition sequence. */
1751 /* A flexible width and height space. */
1754 /* End of buffer or string. */
1757 /* Truncation glyphs. Never returned by get_next_display_element.
1758 Used to get display information about truncation glyphs via
1762 /* Continuation glyphs. See the comment for IT_TRUNCATION. */
1767 /* An enumerator for each text property that has a meaning for display
1772 AUTO_COMPOSED_PROP_IDX
,
1777 COMPOSITION_PROP_IDX
,
1779 /* Not a property. Used to indicate changes in overlays. */
1796 GET_FROM_BUFFER
= 0,
1797 GET_FROM_DISPLAY_VECTOR
,
1798 GET_FROM_COMPOSITION
,
1808 /* The window in which we iterate over current_buffer (or a string). */
1812 /* The window's frame. */
1815 /* Method to use to load this structure with the next display element. */
1816 enum it_method method
;
1818 /* The next position at which to check for face changes, invisible
1819 text, overlay strings, end of text etc., which see. */
1822 /* Maximum string or buffer position + 1. ZV when iterating over
1826 /* C string to iterate over. Non-null means get characters from
1827 this string, otherwise characters are read from current_buffer
1831 /* Number of characters in the string (s, or it->string) we iterate
1835 /* Start and end of a visible region; -1 if the region is not
1836 visible in the window. */
1837 int region_beg_charpos
, region_end_charpos
;
1839 /* Position at which redisplay end trigger functions should be run. */
1840 int redisplay_end_trigger_charpos
;
1842 /* 1 means multibyte characters are enabled. */
1843 unsigned multibyte_p
: 1;
1845 /* 1 means window has a mode line at its top. */
1846 unsigned header_line_p
: 1;
1848 /* 1 means `string' is the value of a `display' property.
1849 Don't handle some `display' properties in these strings. */
1850 unsigned string_from_display_prop_p
: 1;
1852 /* When METHOD == next_element_from_display_vector,
1853 this is 1 if we're doing an ellipsis. Otherwise meaningless. */
1854 unsigned ellipsis_p
: 1;
1856 /* Display table in effect or null for none. */
1857 struct Lisp_Char_Table
*dp
;
1859 /* Current display table vector to return characters from and its
1860 end. dpvec null means we are not returning characters from a
1861 display table entry; current.dpvec_index gives the current index
1862 into dpvec. This same mechanism is also used to return
1863 characters from translated control characters, i.e. `\003' or
1865 Lisp_Object
*dpvec
, *dpend
;
1867 /* Length in bytes of the char that filled dpvec. A value of zero
1868 means that no such character is involved. */
1871 /* Face id to use for all characters in display vector. -1 if unused. */
1874 /* Face id of the iterator saved in case a glyph from dpvec contains
1875 a face. The face is restored when all glyphs from dpvec have
1879 /* Vector of glyphs for control character translation. The pointer
1880 dpvec is set to ctl_chars when a control character is translated.
1881 This vector is also used for incomplete multibyte character
1882 translation (e.g \222\244). Such a character is at most 4 bytes,
1883 thus we need at most 16 bytes here. */
1884 Lisp_Object ctl_chars
[16];
1886 /* Initial buffer or string position of the iterator, before skipping
1887 over display properties and invisible text. */
1888 struct display_pos start
;
1890 /* Current buffer or string position of the iterator, including
1891 position in overlay strings etc. */
1892 struct display_pos current
;
1894 /* Vector of overlays to process. Overlay strings are processed
1895 OVERLAY_STRING_CHUNK_SIZE at a time. */
1896 #define OVERLAY_STRING_CHUNK_SIZE 16
1897 Lisp_Object overlay_strings
[OVERLAY_STRING_CHUNK_SIZE
];
1899 /* Total number of overlay strings to process. This can be >
1900 OVERLAY_STRING_CHUNK_SIZE. */
1901 int n_overlay_strings
;
1903 /* If non-nil, a Lisp string being processed. If
1904 current.overlay_string_index >= 0, this is an overlay string from
1908 /* Stack of saved values. New entries are pushed when we begin to
1909 process an overlay string or a string from a `glyph' property.
1910 Entries are popped when we return to deliver display elements
1911 from what we previously had. */
1912 struct iterator_stack_entry
1917 struct display_pos pos
;
1920 enum glyph_row_area area
;
1921 unsigned multibyte_p
: 1;
1922 unsigned string_from_display_prop_p
: 1;
1923 unsigned display_ellipsis_p
: 1;
1924 struct it_slice slice
;
1925 Lisp_Object space_width
;
1927 Lisp_Object font_height
;
1931 /* Stack pointer. */
1934 /* Setting of buffer-local variable selective-display-ellipsis. */
1935 unsigned selective_display_ellipsis_p
: 1;
1937 /* 1 means control characters are translated into the form `^C'
1938 where the `^' can be replaced by a display table entry. */
1939 unsigned ctl_arrow_p
: 1;
1941 /* -1 means selective display hides everything between a \r and the
1942 next newline; > 0 means hide lines indented more than that value. */
1945 /* An enumeration describing what the next display element is
1946 after a call to get_next_display_element. */
1947 enum display_element_type what
;
1952 /* Non-zero means that the current face has a box. */
1953 unsigned face_box_p
: 1;
1955 /* Non-null means that the current character is the first in a run
1956 of characters with box face. */
1957 unsigned start_of_box_run_p
: 1;
1959 /* Non-zero means that the current character is the last in a run
1960 of characters with box face. */
1961 unsigned end_of_box_run_p
: 1;
1963 /* 1 means overlay strings at end_charpos have been processed. */
1964 unsigned overlay_strings_at_end_processed_p
: 1;
1966 /* 1 means the actual glyph is not available in the current
1968 unsigned glyph_not_available_p
: 1;
1970 /* 1 means the next line in display_line continues a character
1971 consisting of more than one glyph, and some glyphs of this
1972 character have been put on the previous line. */
1973 unsigned starts_in_middle_of_char_p
: 1;
1975 /* If 1, saved_face_id contains the id of the face in front of text
1976 skipped due to selective display. */
1977 unsigned face_before_selective_p
: 1;
1979 /* If 1, adjust current glyph so it does not increase current row
1980 descent/ascent (line-height property). Reset after this glyph. */
1981 unsigned constrain_row_ascent_descent_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 /* Values from `slice' property. */
2009 struct it_slice slice
;
2011 /* Value of the `space-width' property, if any; nil if none. */
2012 Lisp_Object space_width
;
2014 /* Computed from the value of the `raise' property. */
2017 /* Value of the `height' property, if any; nil if none. */
2018 Lisp_Object font_height
;
2020 /* Object and position where the current display element came from.
2021 Object can be a Lisp string in case the current display element
2022 comes from an overlay string, or it is buffer. It may also be nil
2023 during mode-line update. Position is a position in object. */
2025 struct text_pos position
;
2027 /* 1 means lines are truncated. */
2028 unsigned truncate_lines_p
: 1;
2030 /* Number of columns per \t. */
2033 /* Width in pixels of truncation and continuation glyphs. */
2034 short truncation_pixel_width
, continuation_pixel_width
;
2036 /* First and last visible x-position in the display area. If window
2037 is hscrolled by n columns, first_visible_x == n * FRAME_COLUMN_WIDTH
2038 (f), and last_visible_x == pixel width of W + first_visible_x. */
2039 int first_visible_x
, last_visible_x
;
2041 /* Last visible y-position + 1 in the display area without a mode
2042 line, if the window has one. */
2045 /* Default amount of additional space in pixels between lines (for
2046 window systems only.) */
2047 int extra_line_spacing
;
2049 /* Max extra line spacing added in this row. */
2050 int max_extra_line_spacing
;
2052 /* Override font height information for this glyph.
2053 Used if override_ascent >= 0. Cleared after this glyph. */
2054 int override_ascent
, override_descent
, override_boff
;
2056 /* If non-null, glyphs are produced in glyph_row with each call to
2058 struct glyph_row
*glyph_row
;
2060 /* The area of glyph_row to which glyphs are added. */
2061 enum glyph_row_area area
;
2063 /* Number of glyphs needed for the last character requested via
2064 produce_glyphs. This is 1 except for tabs. */
2067 /* Width of the display element in pixels. Result of
2071 /* Current, maximum logical, and maximum physical line height
2072 information. Result of produce_glyphs. */
2073 int ascent
, descent
, max_ascent
, max_descent
;
2074 int phys_ascent
, phys_descent
, max_phys_ascent
, max_phys_descent
;
2076 /* Current x pixel position within the display line. This value
2077 does not include the width of continuation lines in front of the
2078 line. The value of current_x is automatically incremented by
2079 pixel_width with each call to produce_glyphs. */
2082 /* Accumulated width of continuation lines. If > 0, this means we
2083 are currently in a continuation line. This is initially zero and
2084 incremented/reset by display_line, move_it_to etc. */
2085 int continuation_lines_width
;
2087 /* Current y-position. Automatically incremented by the height of
2088 glyph_row in move_it_to and display_line. */
2091 /* Vertical matrix position of first text line in window. */
2094 /* Current vertical matrix position, or line number. Automatically
2095 incremented by move_it_to and display_line. */
2098 /* Horizontal matrix position reached in move_it_in_display_line.
2099 Only set there, not in display_line. */
2102 /* Left fringe bitmap number (enum fringe_bitmap_type). */
2103 unsigned left_user_fringe_bitmap
: FRINGE_ID_BITS
;
2105 /* Right fringe bitmap number (enum fringe_bitmap_type). */
2106 unsigned right_user_fringe_bitmap
: FRINGE_ID_BITS
;
2108 /* Face of the left fringe glyph. */
2109 unsigned left_user_fringe_face_id
: FACE_ID_BITS
;
2111 /* Face of the right fringe glyph. */
2112 unsigned right_user_fringe_face_id
: FACE_ID_BITS
;
2116 /* Access to positions of iterator IT. */
2118 #define IT_CHARPOS(IT) CHARPOS ((IT).current.pos)
2119 #define IT_BYTEPOS(IT) BYTEPOS ((IT).current.pos)
2120 #define IT_STRING_CHARPOS(IT) CHARPOS ((IT).current.string_pos)
2121 #define IT_STRING_BYTEPOS(IT) BYTEPOS ((IT).current.string_pos)
2123 /* Test if IT has reached the end of its buffer or string. This will
2124 only work after get_next_display_element has been called. */
2126 #define ITERATOR_AT_END_P(IT) ((IT)->what == IT_EOB)
2128 /* Non-zero means IT is at the end of a line. This is the case if it
2129 is either on a newline or on a carriage return and selective
2130 display hides the rest of the line. */
2132 #define ITERATOR_AT_END_OF_LINE_P(IT) \
2133 ((IT)->what == IT_CHARACTER \
2134 && ((IT)->c == '\n' \
2135 || ((IT)->c == '\r' && (IT)->selective)))
2137 /* Call produce_glyphs or produce_glyphs_hook, if set. Shortcut to
2138 avoid the function call overhead. */
2140 #define PRODUCE_GLYPHS(IT) \
2142 extern int inhibit_free_realized_faces; \
2144 rif->produce_glyphs ((IT)); \
2146 produce_glyphs ((IT)); \
2147 if ((IT)->glyph_row != NULL) \
2148 inhibit_free_realized_faces = 1; \
2151 /* Bit-flags indicating what operation move_it_to should perform. */
2153 enum move_operation_enum
2155 /* Stop if specified x-position is reached. */
2158 /* Stop if specified y-position is reached. */
2161 /* Stop if specified vpos is reached. */
2162 MOVE_TO_VPOS
= 0x04,
2164 /* Stop if specified buffer or string position is reached. */
2170 /***********************************************************************
2171 Window-based redisplay interface
2172 ***********************************************************************/
2174 /* Structure used to describe runs of lines that must be scrolled. */
2178 /* Source and destination y pixel position. */
2179 int desired_y
, current_y
;
2181 /* Source and destination vpos in matrix. */
2182 int desired_vpos
, current_vpos
;
2184 /* Height in pixels, number of glyph rows. */
2189 /* Handlers for setting frame parameters. */
2191 typedef void (*frame_parm_handler
) P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
2194 /* Structure holding system-dependent interface functions needed
2195 for window-based redisplay. */
2197 struct redisplay_interface
2199 /* Handlers for setting frame parameters. */
2200 frame_parm_handler
*frame_parm_handlers
;
2202 /* Produce glyphs/get display metrics for the display element IT is
2204 void (*produce_glyphs
) P_ ((struct it
*it
));
2206 /* Write or insert LEN glyphs from STRING at the nominal output
2208 void (*write_glyphs
) P_ ((struct glyph
*string
, int len
));
2209 void (*insert_glyphs
) P_ ((struct glyph
*start
, int len
));
2211 /* Clear from nominal output position to X. X < 0 means clear
2212 to right end of display. */
2213 void (*clear_end_of_line
) P_ ((int x
));
2215 /* Function to call to scroll the display as described by RUN on
2217 void (*scroll_run_hook
) P_ ((struct window
*w
, struct run
*run
));
2219 /* Function to call after a line in a display has been completely
2220 updated. Used to draw truncation marks and alike. DESIRED_ROW
2221 is the desired row which has been updated. */
2222 void (*after_update_window_line_hook
) P_ ((struct glyph_row
*desired_row
));
2224 /* Function to call before beginning to update window W in
2225 window-based redisplay. */
2226 void (*update_window_begin_hook
) P_ ((struct window
*w
));
2228 /* Function to call after window W has been updated in window-based
2229 redisplay. CURSOR_ON_P non-zero means switch cursor on.
2230 MOUSE_FACE_OVERWRITTEN_P non-zero means that some lines in W
2231 that contained glyphs in mouse-face were overwritten, so we
2232 have to update the mouse highlight. */
2233 void (*update_window_end_hook
) P_ ((struct window
*w
, int cursor_on_p
,
2234 int mouse_face_overwritten_p
));
2236 /* Move cursor to row/column position VPOS/HPOS, pixel coordinates
2237 Y/X. HPOS/VPOS are window-relative row and column numbers and X/Y
2238 are window-relative pixel positions. */
2239 void (*cursor_to
) P_ ((int vpos
, int hpos
, int y
, int x
));
2241 /* Flush the display of frame F. For X, this is XFlush. */
2242 void (*flush_display
) P_ ((struct frame
*f
));
2244 /* Flush the display of frame F if non-NULL. This is called
2245 during redisplay, and should be NULL on systems which flushes
2246 automatically before reading input. */
2247 void (*flush_display_optional
) P_ ((struct frame
*f
));
2249 /* Clear the mouse hightlight in window W, if there is any. */
2250 void (*clear_window_mouse_face
) P_ ((struct window
*w
));
2252 /* Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
2254 void (*get_glyph_overhangs
) P_ ((struct glyph
*glyph
, struct frame
*f
,
2255 int *left
, int *right
));
2257 /* Fix the display of AREA of ROW in window W for overlapping rows.
2258 This function is called from redraw_overlapping_rows after
2259 desired rows have been made current. */
2260 void (*fix_overlapping_area
) P_ ((struct window
*w
, struct glyph_row
*row
,
2261 enum glyph_row_area area
));
2263 #ifdef HAVE_WINDOW_SYSTEM
2265 /* Draw a fringe bitmap in window W of row ROW using parameters P. */
2266 void (*draw_fringe_bitmap
) P_ ((struct window
*w
, struct glyph_row
*row
,
2267 struct draw_fringe_bitmap_params
*p
));
2269 /* Define and destroy fringe bitmap no. WHICH. */
2270 void (*define_fringe_bitmap
) P_ ((int which
, unsigned short *bits
,
2272 void (*destroy_fringe_bitmap
) P_ ((int which
));
2274 /* Get metrics of character CHAR2B in FONT of type FONT_TYPE.
2275 Value is null if CHAR2B is not contained in the font. */
2276 XCharStruct
* (*per_char_metric
) P_ ((XFontStruct
*font
, XChar2b
*char2b
,
2279 /* Encode CHAR2B using encoding information from FONT_INFO. CHAR2B is
2280 the two-byte form of C. Encoding is returned in *CHAR2B. If
2281 TWO_BYTE_P is non-null, return non-zero there if font is two-byte. */
2282 int (*encode_char
) P_ ((int c
, XChar2b
*char2b
,
2283 struct font_info
*font_into
,
2284 struct charset
*charset
,
2287 /* Compute left and right overhang of glyph string S.
2288 A NULL pointer if platform does not support this. */
2289 void (*compute_glyph_string_overhangs
) P_ ((struct glyph_string
*s
));
2291 /* Draw a glyph string S. */
2292 void (*draw_glyph_string
) P_ ((struct glyph_string
*s
));
2294 /* Define cursor CURSOR on frame F. */
2295 void (*define_frame_cursor
) P_ ((struct frame
*f
, Cursor cursor
));
2297 /* Clear the area at (X,Y,WIDTH,HEIGHT) of frame F. */
2298 void (*clear_frame_area
) P_ ((struct frame
*f
, int x
, int y
,
2299 int width
, int height
));
2301 /* Draw specified cursor CURSOR_TYPE of width CURSOR_WIDTH
2302 at row GLYPH_ROW on window W if ON_P is 1. If ON_P is
2303 0, don't draw cursor. If ACTIVE_P is 1, system caret
2304 should track this cursor (when applicable). */
2305 void (*draw_window_cursor
) P_ ((struct window
*w
,
2306 struct glyph_row
*glyph_row
,
2308 int cursor_type
, int cursor_width
,
2309 int on_p
, int active_p
));
2311 /* Draw vertical border for window W from (X,Y0) to (X,Y1). */
2312 void (*draw_vertical_window_border
) P_ ((struct window
*w
,
2313 int x
, int y0
, int y1
));
2315 /* Shift display of frame F to make room for inserted glyphs.
2316 The area at pixel (X,Y) of width WIDTH and height HEIGHT is
2317 shifted right by SHIFT_BY pixels. */
2318 void (*shift_glyphs_for_insert
) P_ ((struct frame
*f
,
2319 int x
, int y
, int width
,
2320 int height
, int shift_by
));
2322 #endif /* HAVE_WINDOW_SYSTEM */
2325 /* The current interface for window-based redisplay. */
2327 extern struct redisplay_interface
*rif
;
2330 /***********************************************************************
2332 ***********************************************************************/
2334 #ifdef HAVE_WINDOW_SYSTEM
2336 /* Structure forward declarations. */
2341 /* Each image format (JPEG, TIFF, ...) supported is described by
2342 a structure of the type below. */
2346 /* A symbol uniquely identifying the image type, .e.g `jpeg'. */
2349 /* Check that SPEC is a valid image specification for the given
2350 image type. Value is non-zero if SPEC is valid. */
2351 int (* valid_p
) P_ ((Lisp_Object spec
));
2353 /* Load IMG which is used on frame F from information contained in
2354 IMG->spec. Value is non-zero if successful. */
2355 int (* load
) P_ ((struct frame
*f
, struct image
*img
));
2357 /* Free resources of image IMG which is used on frame F. */
2358 void (* free
) P_ ((struct frame
*f
, struct image
*img
));
2360 /* Next in list of all supported image types. */
2361 struct image_type
*next
;
2365 /* Structure describing an image. Specific image formats like XBM are
2366 converted into this form, so that display only has to deal with
2367 this type of image. */
2371 /* The time in seconds at which the image was last displayed. Set
2372 in prepare_image_for_display. */
2373 unsigned long timestamp
;
2375 /* Pixmaps of the image. */
2376 Pixmap pixmap
, mask
;
2378 /* Colors allocated for this image, if any. Allocated via xmalloc. */
2379 unsigned long *colors
;
2382 /* A single `background color' for this image, for the use of anyone that
2383 cares about such a thing. Only valid if the `background_valid' field
2384 is true. This should generally be accessed by calling the accessor
2385 macro `IMAGE_BACKGROUND', which will heuristically calculate a value
2387 unsigned long background
;
2389 /* True if this image has a `transparent' background -- that is, is
2390 uses an image mask. The accessor macro for this is
2391 `IMAGE_BACKGROUND_TRANSPARENT'. */
2392 unsigned background_transparent
: 1;
2394 /* True if the `background' and `background_transparent' fields are
2395 valid, respectively. */
2396 unsigned background_valid
: 1, background_transparent_valid
: 1;
2398 /* Width and height of the image. */
2401 /* These values are used for the rectangles displayed for images
2402 that can't be loaded. */
2403 #define DEFAULT_IMAGE_WIDTH 30
2404 #define DEFAULT_IMAGE_HEIGHT 30
2406 /* Percent of image height used as ascent. A value of
2407 CENTERED_IMAGE_ASCENT means draw the image centered on the
2410 #define DEFAULT_IMAGE_ASCENT 50
2411 #define CENTERED_IMAGE_ASCENT -1
2413 /* Lisp specification of this image. */
2416 /* Relief to draw around the image. */
2419 /* Optional margins around the image. This includes the relief. */
2420 int hmargin
, vmargin
;
2422 /* Reference to the type of the image. */
2423 struct image_type
*type
;
2425 /* 1 means that loading the image failed. Don't try again. */
2426 unsigned load_failed_p
;
2428 /* A place for image types to store additional data. The member
2429 data.lisp_val is marked during GC, so it's safe to store Lisp data
2430 there. Image types should free this data when their `free'
2431 function is called. */
2436 Lisp_Object lisp_val
;
2439 /* Hash value of image specification to speed up comparisons. */
2442 /* Image id of this image. */
2445 /* Hash collision chain. */
2446 struct image
*next
, *prev
;
2450 /* Cache of images. Each frame has a cache. X frames with the same
2451 x_display_info share their caches. */
2455 /* Hash table of images. */
2456 struct image
**buckets
;
2458 /* Vector mapping image ids to images. */
2459 struct image
**images
;
2461 /* Allocated size of `images'. */
2464 /* Number of images in the cache. */
2467 /* Reference count (number of frames sharing this cache). */
2472 /* Value is a pointer to the image with id ID on frame F, or null if
2473 no image with that id exists. */
2475 #define IMAGE_FROM_ID(F, ID) \
2476 (((ID) >= 0 && (ID) < (FRAME_X_IMAGE_CACHE (F)->used)) \
2477 ? FRAME_X_IMAGE_CACHE (F)->images[ID] \
2480 /* Size of bucket vector of image caches. Should be prime. */
2482 #define IMAGE_CACHE_BUCKETS_SIZE 1001
2484 #endif /* HAVE_WINDOW_SYSTEM */
2488 /***********************************************************************
2490 ***********************************************************************/
2492 /* Enumeration defining where to find tool-bar item information in
2493 tool-bar items vectors stored with frames. Each tool-bar item
2494 occupies TOOL_BAR_ITEM_NSLOTS elements in such a vector. */
2496 enum tool_bar_item_idx
2498 /* The key of the tool-bar item. Used to remove items when a binding
2499 for `undefined' is found. */
2502 /* Non-nil if item is enabled. */
2503 TOOL_BAR_ITEM_ENABLED_P
,
2505 /* Non-nil if item is selected (pressed). */
2506 TOOL_BAR_ITEM_SELECTED_P
,
2509 TOOL_BAR_ITEM_CAPTION
,
2511 /* Image(s) to display. This is either a single image specification
2512 or a vector of specifications. */
2513 TOOL_BAR_ITEM_IMAGES
,
2516 TOOL_BAR_ITEM_BINDING
,
2518 /* Button type. One of nil, `:radio' or `:toggle'. */
2524 /* Sentinel = number of slots in tool_bar_items occupied by one
2526 TOOL_BAR_ITEM_NSLOTS
2530 /* An enumeration for the different images that can be specified
2531 for a tool-bar item. */
2533 enum tool_bar_item_image
2535 TOOL_BAR_IMAGE_ENABLED_SELECTED
,
2536 TOOL_BAR_IMAGE_ENABLED_DESELECTED
,
2537 TOOL_BAR_IMAGE_DISABLED_SELECTED
,
2538 TOOL_BAR_IMAGE_DISABLED_DESELECTED
2541 /* Margin around tool-bar buttons in pixels. */
2543 extern Lisp_Object Vtool_bar_button_margin
;
2545 /* Thickness of relief to draw around tool-bar buttons. */
2547 extern EMACS_INT tool_bar_button_relief
;
2549 /* Default values of the above variables. */
2551 #define DEFAULT_TOOL_BAR_BUTTON_MARGIN 4
2552 #define DEFAULT_TOOL_BAR_BUTTON_RELIEF 1
2554 /* The height in pixels of the default tool-bar images. */
2556 #define DEFAULT_TOOL_BAR_IMAGE_HEIGHT 24
2559 /***********************************************************************
2560 Terminal Capabilities
2561 ***********************************************************************/
2563 /* Each of these is a bit representing a terminal `capability' (bold,
2564 inverse, etc). They are or'd together to specify the set of
2565 capabilities being queried for when calling `tty_capable_p' (which
2566 returns true if the terminal supports all of them). */
2568 #define TTY_CAP_INVERSE 0x01
2569 #define TTY_CAP_UNDERLINE 0x02
2570 #define TTY_CAP_BOLD 0x04
2571 #define TTY_CAP_DIM 0x08
2572 #define TTY_CAP_BLINK 0x10
2573 #define TTY_CAP_ALT_CHARSET 0x20
2576 /***********************************************************************
2578 ***********************************************************************/
2580 /* Defined in xdisp.c */
2582 struct glyph_row
*row_containing_pos
P_ ((struct window
*, int,
2584 struct glyph_row
*, int));
2585 int string_buffer_position
P_ ((struct window
*, Lisp_Object
, int));
2586 int line_bottom_y
P_ ((struct it
*));
2587 int display_prop_intangible_p
P_ ((Lisp_Object
));
2588 void resize_echo_area_exactly
P_ ((void));
2589 int resize_mini_window
P_ ((struct window
*, int));
2590 int try_window
P_ ((Lisp_Object
, struct text_pos
));
2591 void window_box
P_ ((struct window
*, int, int *, int *, int *, int *));
2592 int window_box_height
P_ ((struct window
*));
2593 int window_text_bottom_y
P_ ((struct window
*));
2594 int window_box_width
P_ ((struct window
*, int));
2595 int window_box_left
P_ ((struct window
*, int));
2596 int window_box_left_offset
P_ ((struct window
*, int));
2597 int window_box_right
P_ ((struct window
*, int));
2598 int window_box_right_offset
P_ ((struct window
*, int));
2599 void window_box_edges
P_ ((struct window
*, int, int *, int *, int *, int *));
2600 int estimate_mode_line_height
P_ ((struct frame
*, enum face_id
));
2601 void pixel_to_glyph_coords
P_ ((struct frame
*, int, int, int *, int *,
2602 NativeRectangle
*, int));
2603 int glyph_to_pixel_coords
P_ ((struct window
*, int, int, int *, int *));
2604 void mark_window_display_accurate
P_ ((Lisp_Object
, int));
2605 void redisplay_preserve_echo_area
P_ ((int));
2606 void set_cursor_from_row
P_ ((struct window
*, struct glyph_row
*,
2607 struct glyph_matrix
*, int, int, int, int));
2608 void init_iterator
P_ ((struct it
*, struct window
*, int,
2609 int, struct glyph_row
*, enum face_id
));
2610 void init_iterator_to_row_start
P_ ((struct it
*, struct window
*,
2611 struct glyph_row
*));
2612 int get_next_display_element
P_ ((struct it
*));
2613 void set_iterator_to_next
P_ ((struct it
*, int));
2614 void produce_glyphs
P_ ((struct it
*));
2615 void produce_special_glyphs
P_ ((struct it
*, enum display_element_type
));
2616 void start_display
P_ ((struct it
*, struct window
*, struct text_pos
));
2617 void move_it_to
P_ ((struct it
*, int, int, int, int, int));
2618 void move_it_vertically
P_ ((struct it
*, int));
2619 void move_it_vertically_backward
P_ ((struct it
*, int));
2620 void move_it_by_lines
P_ ((struct it
*, int, int));
2621 void move_it_past_eol
P_ ((struct it
*));
2622 int in_display_vector_p
P_ ((struct it
*));
2623 int frame_mode_line_height
P_ ((struct frame
*));
2624 void highlight_trailing_whitespace
P_ ((struct frame
*, struct glyph_row
*));
2625 extern Lisp_Object Qtool_bar
;
2626 extern Lisp_Object Vshow_trailing_whitespace
;
2627 extern int mode_line_in_non_selected_windows
;
2628 extern int redisplaying_p
;
2629 extern void add_to_log
P_ ((char *, Lisp_Object
, Lisp_Object
));
2630 extern int help_echo_showing_p
;
2631 extern int current_mode_line_height
, current_header_line_height
;
2632 extern Lisp_Object help_echo_string
, help_echo_window
;
2633 extern Lisp_Object help_echo_object
, previous_help_echo_string
;
2634 extern int help_echo_pos
;
2635 extern struct frame
*last_mouse_frame
;
2636 extern int last_tool_bar_item
;
2637 extern int mouse_autoselect_window
;
2638 extern void reseat_at_previous_visible_line_start
P_ ((struct it
*));
2640 extern int calc_pixel_width_or_height
P_ ((double *, struct it
*, Lisp_Object
,
2641 /* XFontStruct */ void *, int, int *));
2643 #ifdef HAVE_WINDOW_SYSTEM
2646 extern void dump_glyph_string
P_ ((struct glyph_string
*));
2649 extern void x_get_glyph_overhangs
P_ ((struct glyph
*, struct frame
*,
2651 extern void x_produce_glyphs
P_ ((struct it
*));
2653 extern void x_write_glyphs
P_ ((struct glyph
*, int));
2654 extern void x_insert_glyphs
P_ ((struct glyph
*, int len
));
2655 extern void x_clear_end_of_line
P_ ((int));
2657 extern int x_stretch_cursor_p
;
2658 extern struct cursor_pos output_cursor
;
2660 extern void x_fix_overlapping_area
P_ ((struct window
*, struct glyph_row
*,
2661 enum glyph_row_area
));
2662 extern void draw_phys_cursor_glyph
P_ ((struct window
*,
2664 enum draw_glyphs_face
));
2665 extern int get_phys_cursor_geometry
P_ ((struct window
*, struct glyph_row
*,
2666 struct glyph
*, int *));
2667 extern void erase_phys_cursor
P_ ((struct window
*));
2668 extern void display_and_set_cursor
P_ ((struct window
*,
2669 int, int, int, int, int));
2671 extern void set_output_cursor
P_ ((struct cursor_pos
*));
2672 extern void x_cursor_to
P_ ((int, int, int, int));
2674 extern void x_update_cursor
P_ ((struct frame
*, int));
2675 extern void x_clear_cursor
P_ ((struct window
*));
2676 extern void x_draw_vertical_border
P_ ((struct window
*w
));
2678 extern void frame_to_window_pixel_xy
P_ ((struct window
*, int *, int *));
2679 extern void get_glyph_string_clip_rect
P_ ((struct glyph_string
*,
2680 NativeRectangle
*nr
));
2681 extern Lisp_Object find_hot_spot
P_ ((Lisp_Object
, int, int));
2682 extern void note_mouse_highlight
P_ ((struct frame
*, int, int));
2683 extern void x_clear_window_mouse_face
P_ ((struct window
*));
2684 extern void cancel_mouse_face
P_ ((struct frame
*));
2686 extern void handle_tool_bar_click
P_ ((struct frame
*,
2687 int, int, int, unsigned int));
2689 /* msdos.c defines its own versions of these functions. */
2690 extern int clear_mouse_face
P_ ((Display_Info
*));
2691 extern void show_mouse_face
P_ ((Display_Info
*, enum draw_glyphs_face
));
2692 extern int cursor_in_mouse_face_p
P_ ((struct window
*w
));
2694 extern void expose_frame
P_ ((struct frame
*, int, int, int, int));
2695 extern int x_intersect_rectangles
P_ ((XRectangle
*, XRectangle
*,
2699 /* Defined in fringe.c */
2701 int lookup_fringe_bitmap (Lisp_Object
);
2702 void draw_fringe_bitmap
P_ ((struct window
*, struct glyph_row
*, int));
2703 void draw_row_fringe_bitmaps
P_ ((struct window
*, struct glyph_row
*));
2704 int draw_window_fringes
P_ ((struct window
*, int));
2705 int update_window_fringes
P_ ((struct window
*, int));
2706 void compute_fringe_widths
P_ ((struct frame
*, int));
2709 void w32_init_fringe
P_ ((void));
2710 void w32_reset_fringes
P_ ((void));
2713 /* Defined in image.c */
2715 #ifdef HAVE_WINDOW_SYSTEM
2717 extern int x_bitmap_height
P_ ((struct frame
*, int));
2718 extern int x_bitmap_width
P_ ((struct frame
*, int));
2719 extern int x_bitmap_pixmap
P_ ((struct frame
*, int));
2720 extern void x_reference_bitmap
P_ ((struct frame
*, int));
2721 extern int x_create_bitmap_from_data
P_ ((struct frame
*, char *,
2722 unsigned int, unsigned int));
2723 extern int x_create_bitmap_from_file
P_ ((struct frame
*, Lisp_Object
));
2724 #ifndef x_destroy_bitmap
2725 extern void x_destroy_bitmap
P_ ((struct frame
*, int));
2727 extern void x_destroy_all_bitmaps
P_ ((Display_Info
*));
2728 extern int x_create_bitmap_mask
P_ ((struct frame
* , int));
2729 extern Lisp_Object x_find_image_file
P_ ((Lisp_Object
));
2731 void x_kill_gs_process
P_ ((Pixmap
, struct frame
*));
2732 struct image_cache
*make_image_cache
P_ ((void));
2733 void free_image_cache
P_ ((struct frame
*));
2734 void clear_image_cache
P_ ((struct frame
*, int));
2735 void forall_images_in_image_cache
P_ ((struct frame
*,
2736 void (*) P_ ((struct image
*))));
2737 int valid_image_p
P_ ((Lisp_Object
));
2738 void prepare_image_for_display
P_ ((struct frame
*, struct image
*));
2739 int lookup_image
P_ ((struct frame
*, Lisp_Object
));
2741 unsigned long image_background
P_ ((struct image
*, struct frame
*,
2742 XImagePtr_or_DC ximg
));
2743 int image_background_transparent
P_ ((struct image
*, struct frame
*,
2744 XImagePtr_or_DC mask
));
2746 int image_ascent
P_ ((struct image
*, struct face
*, struct glyph_slice
*));
2750 /* Defined in sysdep.c */
2752 void get_frame_size
P_ ((int *, int *));
2753 void request_sigio
P_ ((void));
2754 void unrequest_sigio
P_ ((void));
2755 int tabs_safe_p
P_ ((void));
2756 void init_baud_rate
P_ ((void));
2757 void init_sigio
P_ ((int));
2759 /* Defined in xfaces.c */
2761 #ifdef HAVE_X_WINDOWS
2762 void x_free_colors
P_ ((struct frame
*, unsigned long *, int));
2765 void update_face_from_frame_parameter
P_ ((struct frame
*, Lisp_Object
,
2767 Lisp_Object tty_color_name
P_ ((struct frame
*, int));
2768 void clear_face_cache
P_ ((int));
2769 unsigned long load_color
P_ ((struct frame
*, struct face
*, Lisp_Object
,
2770 enum lface_attribute_index
));
2771 void unload_color
P_ ((struct frame
*, unsigned long));
2772 char *choose_face_font
P_ ((struct frame
*, Lisp_Object
*, Lisp_Object
,
2774 int ascii_face_of_lisp_face
P_ ((struct frame
*, int));
2775 void prepare_face_for_display
P_ ((struct frame
*, struct face
*));
2776 int xstricmp
P_ ((const unsigned char *, const unsigned char *));
2777 int lookup_face
P_ ((struct frame
*, Lisp_Object
*));
2778 int lookup_non_ascii_face
P_ ((struct frame
*, int, struct face
*));
2779 int lookup_named_face
P_ ((struct frame
*, Lisp_Object
, int));
2780 int smaller_face
P_ ((struct frame
*, int, int));
2781 int face_with_height
P_ ((struct frame
*, int, int));
2782 int lookup_derived_face
P_ ((struct frame
*, Lisp_Object
, int, int));
2783 void init_frame_faces
P_ ((struct frame
*));
2784 void free_frame_faces
P_ ((struct frame
*));
2785 void recompute_basic_faces
P_ ((struct frame
*));
2786 int face_at_buffer_position
P_ ((struct window
*, int, int, int, int *,
2788 int face_at_string_position
P_ ((struct window
*, Lisp_Object
, int, int, int,
2789 int, int *, enum face_id
, int));
2790 int merge_faces
P_ ((struct frame
*, Lisp_Object
, int, int));
2791 int compute_char_face
P_ ((struct frame
*, int, Lisp_Object
));
2792 void free_all_realized_faces
P_ ((Lisp_Object
));
2793 void free_realized_face
P_ ((struct frame
*, struct face
*));
2794 extern Lisp_Object Qforeground_color
, Qbackground_color
;
2795 extern char unspecified_fg
[], unspecified_bg
[];
2796 extern Lisp_Object split_font_name_into_vector
P_ ((Lisp_Object
));
2797 extern Lisp_Object build_font_name_from_vector
P_ ((Lisp_Object
));
2799 /* Defined in xfns.c */
2801 #ifdef HAVE_X_WINDOWS
2802 void gamma_correct
P_ ((struct frame
*, XColor
*));
2805 void gamma_correct
P_ ((struct frame
*, COLORREF
*));
2808 void gamma_correct
P_ ((struct frame
*, unsigned long *));
2811 #ifdef HAVE_WINDOW_SYSTEM
2813 int x_screen_planes
P_ ((struct frame
*));
2814 void x_implicitly_set_name
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
2816 extern Lisp_Object tip_frame
;
2817 extern Window tip_window
;
2818 EXFUN (Fx_show_tip
, 6);
2819 EXFUN (Fx_hide_tip
, 0);
2820 extern void start_hourglass
P_ ((void));
2821 extern void cancel_hourglass
P_ ((void));
2822 extern int hourglass_started
P_ ((void));
2823 extern int display_hourglass_p
;
2825 /* Returns the background color of IMG, calculating one heuristically if
2826 necessary. If non-zero, XIMG is an existing XImage object to use for
2829 #define IMAGE_BACKGROUND(img, f, ximg) \
2830 ((img)->background_valid \
2831 ? (img)->background \
2832 : image_background (img, f, ximg))
2834 /* Returns true if IMG has a `transparent' background, using heuristics
2835 to decide if necessary. If non-zero, MASK is an existing XImage
2836 object to use for the heuristic. */
2838 #define IMAGE_BACKGROUND_TRANSPARENT(img, f, mask) \
2839 ((img)->background_transparent_valid \
2840 ? (img)->background_transparent \
2841 : image_background_transparent (img, f, mask))
2843 #endif /* HAVE_WINDOW_SYSTEM */
2846 /* Defined in xmenu.c */
2848 int popup_activated
P_ ((void));
2850 /* Defined in dispnew.c */
2852 extern int inverse_video
;
2853 extern int required_matrix_width
P_ ((struct window
*));
2854 extern int required_matrix_height
P_ ((struct window
*));
2855 extern Lisp_Object buffer_posn_from_coords
P_ ((struct window
*,
2857 struct display_pos
*,
2859 int *, int *, int *, int *));
2860 extern Lisp_Object mode_line_string
P_ ((struct window
*, enum window_part
,
2861 int *, int *, int *,
2863 int *, int *, int *, int *));
2864 extern Lisp_Object marginal_area_string
P_ ((struct window
*, enum window_part
,
2865 int *, int *, int *,
2867 int *, int *, int *, int *));
2868 extern void redraw_frame
P_ ((struct frame
*));
2869 extern void redraw_garbaged_frames
P_ ((void));
2870 extern void cancel_line
P_ ((int, struct frame
*));
2871 extern void init_desired_glyphs
P_ ((struct frame
*));
2872 extern int scroll_frame_lines
P_ ((struct frame
*, int, int, int, int));
2873 extern int direct_output_for_insert
P_ ((int));
2874 extern int direct_output_forward_char
P_ ((int));
2875 extern int update_frame
P_ ((struct frame
*, int, int));
2876 extern int scrolling
P_ ((struct frame
*));
2877 extern void bitch_at_user
P_ ((void));
2878 void adjust_glyphs
P_ ((struct frame
*));
2879 void free_glyphs
P_ ((struct frame
*));
2880 void free_window_matrices
P_ ((struct window
*));
2881 void check_glyph_memory
P_ ((void));
2882 void mirrored_line_dance
P_ ((struct glyph_matrix
*, int, int, int *, char *));
2883 void clear_glyph_matrix
P_ ((struct glyph_matrix
*));
2884 void clear_current_matrices
P_ ((struct frame
*f
));
2885 void clear_desired_matrices
P_ ((struct frame
*));
2886 void shift_glyph_matrix
P_ ((struct window
*, struct glyph_matrix
*,
2888 void rotate_matrix
P_ ((struct glyph_matrix
*, int, int, int));
2889 void increment_matrix_positions
P_ ((struct glyph_matrix
*,
2890 int, int, int, int));
2891 void blank_row
P_ ((struct window
*, struct glyph_row
*, int));
2892 void increment_row_positions
P_ ((struct glyph_row
*, int, int));
2893 void enable_glyph_matrix_rows
P_ ((struct glyph_matrix
*, int, int, int));
2894 void clear_glyph_row
P_ ((struct glyph_row
*));
2895 void prepare_desired_row
P_ ((struct glyph_row
*));
2896 int line_hash_code
P_ ((struct glyph_row
*));
2897 void set_window_update_flags
P_ ((struct window
*, int));
2898 void write_glyphs
P_ ((struct glyph
*, int));
2899 void insert_glyphs
P_ ((struct glyph
*, int));
2900 void redraw_frame
P_ ((struct frame
*));
2901 void redraw_garbaged_frames
P_ ((void));
2902 int scroll_cost
P_ ((struct frame
*, int, int, int));
2903 int direct_output_for_insert
P_ ((int));
2904 int direct_output_forward_char
P_ ((int));
2905 int update_frame
P_ ((struct frame
*, int, int));
2906 void update_single_window
P_ ((struct window
*, int));
2907 int scrolling
P_ ((struct frame
*));
2908 void do_pending_window_change
P_ ((int));
2909 void change_frame_size
P_ ((struct frame
*, int, int, int, int, int));
2910 void bitch_at_user
P_ ((void));
2911 Lisp_Object sit_for
P_ ((int, int, int, int, int));
2912 void init_display
P_ ((void));
2913 void syms_of_display
P_ ((void));
2914 extern Lisp_Object Qredisplay_dont_pause
;
2916 /* Defined in term.c */
2918 extern void ring_bell
P_ ((void));
2919 extern void set_terminal_modes
P_ ((void));
2920 extern void reset_terminal_modes
P_ ((void));
2921 extern void update_begin
P_ ((struct frame
*));
2922 extern void update_end
P_ ((struct frame
*));
2923 extern void set_terminal_window
P_ ((int));
2924 extern void set_scroll_region
P_ ((int, int));
2925 extern void turn_off_insert
P_ ((void));
2926 extern void turn_off_highlight
P_ ((void));
2927 extern void background_highlight
P_ ((void));
2928 extern void clear_frame
P_ ((void));
2929 extern void clear_end_of_line
P_ ((int));
2930 extern void clear_end_of_line_raw
P_ ((int));
2931 extern void delete_glyphs
P_ ((int));
2932 extern void ins_del_lines
P_ ((int, int));
2933 extern int string_cost
P_ ((char *));
2934 extern int per_line_cost
P_ ((char *));
2935 extern void calculate_costs
P_ ((struct frame
*));
2936 extern void set_tty_color_mode
P_ ((struct frame
*, Lisp_Object
));
2937 extern void tty_setup_colors
P_ ((int));
2938 extern void term_init
P_ ((char *));
2939 extern void fatal
P_ ((/* char *, ... */));
2940 void cursor_to
P_ ((int, int));
2941 extern int tty_capable_p
P_ ((struct frame
*, unsigned, unsigned long, unsigned long));
2943 /* Defined in scroll.c */
2945 extern int scrolling_max_lines_saved
P_ ((int, int, int *, int *, int *));
2946 extern int scroll_cost
P_ ((struct frame
*, int, int, int));
2947 extern void do_line_insertion_deletion_costs
P_ ((struct frame
*, char *,
2948 char *, char *, char *,
2949 char *, char *, int));
2950 void scrolling_1
P_ ((struct frame
*, int, int, int, int *, int *, int *,
2953 /* Defined in frame.c */
2955 #ifdef HAVE_WINDOW_SYSTEM
2957 /* Types we might convert a resource string into. */
2967 extern Lisp_Object x_get_arg
P_ ((Display_Info
*, Lisp_Object
,
2968 Lisp_Object
, char *, char *class,
2969 enum resource_types
));
2970 extern Lisp_Object x_frame_get_arg
P_ ((struct frame
*, Lisp_Object
,
2971 Lisp_Object
, char *, char *,
2972 enum resource_types
));
2973 extern Lisp_Object x_frame_get_and_record_arg
P_ ((
2974 struct frame
*, Lisp_Object
,
2975 Lisp_Object
, char *, char *,
2976 enum resource_types
));
2977 extern Lisp_Object x_default_parameter
P_ ((struct frame
*, Lisp_Object
,
2978 Lisp_Object
, Lisp_Object
,
2980 enum resource_types
));
2982 #endif /* HAVE_WINDOW_SYSTEM */
2984 #endif /* not DISPEXTERN_H_INCLUDED */
2986 /* arch-tag: c65c475f-1c1e-4534-8795-990b8509fd65
2987 (do not change this comment) */