1 /* Interface definitions for display code.
2 Copyright (C) 1985,93,94,97,98,99, 2000,01,02,03, 2004
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 /* Macros to include code only if GLYPH_DEBUG != 0. */
125 #define IF_DEBUG(X) X
126 #define xassert(X) do {if (!(X)) abort ();} while (0)
128 #define IF_DEBUG(X) (void) 0
129 #define xassert(X) (void) 0
132 /* Macro for displaying traces of redisplay. If Emacs was compiled
133 with GLYPH_DEBUG != 0, the variable trace_redisplay_p can be set to
134 a non-zero value in debugging sessions to activate traces. */
138 extern int trace_redisplay_p
;
142 if (trace_redisplay_p) \
147 #else /* GLYPH_DEBUG == 0 */
149 #define TRACE(X) (void) 0
151 #endif /* GLYPH_DEBUG == 0 */
155 /***********************************************************************
157 ***********************************************************************/
159 /* Starting with Emacs 20.3, characters from strings and buffers have
160 both a character and a byte position associated with them. The
161 following structure holds such a pair of positions. */
165 /* Character position. */
168 /* Corresponding byte position. */
172 /* Access character and byte position of POS in a functional form. */
174 #define BYTEPOS(POS) (POS).bytepos
175 #define CHARPOS(POS) (POS).charpos
177 /* Set character position of POS to CHARPOS, byte position to BYTEPOS. */
179 #define SET_TEXT_POS(POS, CHARPOS, BYTEPOS) \
180 ((POS).charpos = (CHARPOS), (POS).bytepos = BYTEPOS)
182 /* Increment text position POS. */
184 #define INC_TEXT_POS(POS, MULTIBYTE_P) \
189 INC_POS ((POS).bytepos); \
195 /* Decrement text position POS. */
197 #define DEC_TEXT_POS(POS, MULTIBYTE_P) \
202 DEC_POS ((POS).bytepos); \
208 /* Set text position POS from marker MARKER. */
210 #define SET_TEXT_POS_FROM_MARKER(POS, MARKER) \
211 (CHARPOS (POS) = marker_position ((MARKER)), \
212 BYTEPOS (POS) = marker_byte_position ((MARKER)))
214 /* Set marker MARKER from text position POS. */
216 #define SET_MARKER_FROM_TEXT_POS(MARKER, POS) \
217 set_marker_both ((MARKER), Qnil, CHARPOS ((POS)), BYTEPOS ((POS)))
219 /* Value is non-zero if character and byte positions of POS1 and POS2
222 #define TEXT_POS_EQUAL_P(POS1, POS2) \
223 ((POS1).charpos == (POS2).charpos \
224 && (POS1).bytepos == (POS2).bytepos)
226 /* When rendering glyphs, redisplay scans string or buffer text,
227 overlay strings in that text, and does display table or control
228 character translations. The following structure captures a
229 position taking all this into account. */
233 /* Buffer or string position. */
236 /* If this is a position in an overlay string, overlay_string_index
237 is the index of that overlay string in the sequence of overlay
238 strings at `pos' in the order redisplay processes them. A value
239 < 0 means that this is not a position in an overlay string. */
240 int overlay_string_index
;
242 /* If this is a position in an overlay string, string_pos is the
243 position within that string. */
244 struct text_pos string_pos
;
246 /* If the character at the position above is a control character or
247 has a display table entry, dpvec_index is an index in the display
248 table or control character translation of that character. A
249 value < 0 means this is not a position in such a translation. */
255 /***********************************************************************
257 ***********************************************************************/
259 /* Enumeration of glyph types. Glyph structures contain a type field
260 containing one of the enumerators defined here. */
264 /* Glyph describes a character. */
267 /* Glyph describes a composition sequence. */
270 /* Glyph describes an image. */
273 /* Glyph is a space of fractional width and/or height. */
278 /* Structure describing how to use partial glyphs (images slicing) */
285 unsigned height
: 16;
291 Be extra careful when changing this structure! Esp. make sure that
292 functions producing glyphs, like append_glyph, fill ALL of the
293 glyph structure, and that GLYPH_EQUAL_P compares all
294 display-relevant members of glyphs (not to imply that these are the
295 only things to check when you add a member). */
299 /* Position from which this glyph was drawn. If `object' below is a
300 Lisp string, this is a position in that string. If it is a
301 buffer, this is a position in that buffer. A value of -1
302 together with a null object means glyph is a truncation glyph at
303 the start of a row. */
306 /* Lisp object source of this glyph. Currently either a buffer or
307 a string, if the glyph was produced from characters which came from
308 a buffer or a string; or 0 if the glyph was inserted by redisplay
309 for its own purposes such as padding. */
312 /* Width in pixels. */
315 /* Ascent and descent in pixels. */
316 short ascent
, descent
;
318 /* Vertical offset. If < 0, the glyph is displayed raised, if > 0
319 the glyph is displayed lowered. */
322 /* Which kind of glyph this is---character, image etc. Value
323 should be an enumerator of type enum glyph_type. */
326 /* 1 means this glyph was produced from multibyte text. Zero
327 means it was produced from unibyte text, i.e. charsets aren't
328 applicable, and encoding is not performed. */
329 unsigned multibyte_p
: 1;
331 /* Non-zero means draw a box line at the left or right side of this
332 glyph. This is part of the implementation of the face attribute
334 unsigned left_box_line_p
: 1;
335 unsigned right_box_line_p
: 1;
337 /* Non-zero means this glyph's physical ascent or descent is greater
338 than its logical ascent/descent, i.e. it may potentially overlap
339 glyphs above or below it. */
340 unsigned overlaps_vertically_p
: 1;
342 /* 1 means glyph is a padding glyph. Padding glyphs are used for
343 characters whose visual shape consists of more than one glyph
344 (e.g. Asian characters). All but the first glyph of such a glyph
345 sequence have the padding_p flag set. Only used for terminal
346 frames, and there only to minimize code changes. A better way
347 would probably be to use the width field of glyphs to express
349 unsigned padding_p
: 1;
351 /* 1 means the actual glyph is not available, draw a box instead.
352 This can happen when a font couldn't be loaded, or a character
353 doesn't have a glyph in a font. */
354 unsigned glyph_not_available_p
: 1;
356 #define FACE_ID_BITS 21
358 /* Face of the glyph. */
359 unsigned face_id
: FACE_ID_BITS
;
361 /* Type of font used to display the character glyph. May be used to
362 determine which set of functions to use to obtain font metrics
363 for the glyph. On W32, value should be an enumerator of the type
364 w32_char_font_type. Otherwise it equals FONT_TYPE_UNKNOWN. */
365 unsigned font_type
: 3;
367 struct glyph_slice slice
;
369 /* A union of sub-structures for different glyph types. */
372 /* Character code for character glyphs (type == CHAR_GLYPH). */
375 /* Composition ID for composition glyphs (type == COMPOSITION_GLYPH) */
378 /* Image ID for image glyphs (type == IMAGE_GLYPH). */
381 /* Sub-structure for type == STRETCH_GLYPH. */
384 /* The height of the glyph. */
385 unsigned height
: 16;
387 /* The ascent of the glyph. */
388 unsigned ascent
: 16;
392 /* Used to compare all bit-fields above in one step. */
398 /* Default value of the glyph font_type field. */
400 #define FONT_TYPE_UNKNOWN 0
402 /* Is GLYPH a space? */
404 #define CHAR_GLYPH_SPACE_P(GLYPH) \
405 (GLYPH_FROM_CHAR_GLYPH ((GLYPH)) == SPACEGLYPH)
407 /* Are glyph slices of glyphs *X and *Y equal */
409 #define GLYPH_SLICE_EQUAL_P(X, Y) \
410 ((X)->slice.x == (Y)->slice.x \
411 && (X)->slice.y == (Y)->slice.y \
412 && (X)->slice.width == (Y)->slice.width \
413 && (X)->slice.height == (Y)->slice.height)
415 /* Are glyphs *X and *Y displayed equal? */
417 #define GLYPH_EQUAL_P(X, Y) \
418 ((X)->type == (Y)->type \
419 && (X)->u.val == (Y)->u.val \
420 && GLYPH_SLICE_EQUAL_P (X, Y) \
421 && (X)->face_id == (Y)->face_id \
422 && (X)->padding_p == (Y)->padding_p \
423 && (X)->left_box_line_p == (Y)->left_box_line_p \
424 && (X)->right_box_line_p == (Y)->right_box_line_p \
425 && (X)->voffset == (Y)->voffset \
426 && (X)->pixel_width == (Y)->pixel_width)
428 /* Are character codes, faces, padding_ps of glyphs *X and *Y equal? */
430 #define GLYPH_CHAR_AND_FACE_EQUAL_P(X, Y) \
431 ((X)->u.ch == (Y)->u.ch \
432 && (X)->face_id == (Y)->face_id \
433 && (X)->padding_p == (Y)->padding_p)
435 /* Fill a character glyph GLYPH. CODE, FACE_ID, PADDING_P correspond
436 to the bits defined for the typedef `GLYPH' in lisp.h. */
438 #define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P) \
441 (GLYPH).u.ch = (CODE); \
442 (GLYPH).face_id = (FACE_ID); \
443 (GLYPH).padding_p = (PADDING_P); \
447 /* Fill a character type glyph GLYPH from a glyph typedef FROM as
448 defined in lisp.h. */
450 #define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM) \
451 SET_CHAR_GLYPH ((GLYPH), \
452 FAST_GLYPH_CHAR ((FROM)), \
453 FAST_GLYPH_FACE ((FROM)), \
456 /* Construct a glyph code from a character glyph GLYPH. If the
457 character is multibyte, return -1 as we can't use glyph table for a
458 multibyte character. */
460 #define GLYPH_FROM_CHAR_GLYPH(GLYPH) \
461 ((GLYPH).u.ch < 256 \
462 ? ((GLYPH).u.ch | ((GLYPH).face_id << CHARACTERBITS)) \
465 /* Is GLYPH a padding glyph? */
467 #define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p
472 /***********************************************************************
474 ***********************************************************************/
478 Glyph memory for frame-based redisplay is allocated from the heap
479 in one vector kept in a glyph pool structure which is stored with
480 the frame. The size of the vector is made large enough to cover
481 all windows on the frame.
483 Both frame and window glyph matrices reference memory from a glyph
484 pool in frame-based redisplay.
486 In window-based redisplay, no glyphs pools exist; windows allocate
487 and free their glyph memory themselves. */
491 /* Vector of glyphs allocated from the heap. */
492 struct glyph
*glyphs
;
494 /* Allocated size of `glyphs'. */
497 /* Number of rows and columns in a matrix. */
503 /***********************************************************************
505 ***********************************************************************/
509 Three kinds of glyph matrices exist:
511 1. Frame glyph matrices. These are used for terminal frames whose
512 redisplay needs a view of the whole screen due to limited terminal
513 capabilities. Frame matrices are used only in the update phase
514 of redisplay. They are built in update_frame and not used after
515 the update has been performed.
517 2. Window glyph matrices on frames having frame glyph matrices.
518 Such matrices are sub-matrices of their corresponding frame matrix,
519 i.e. frame glyph matrices and window glyph matrices share the same
520 glyph memory which is allocated in form of a glyph_pool structure.
521 Glyph rows in such a window matrix are slices of frame matrix rows.
523 2. Free-standing window glyph matrices managing their own glyph
524 storage. This form is used in window-based redisplay which
525 includes variable width and height fonts etc.
527 The size of a window's row vector depends on the height of fonts
528 defined on its frame. It is chosen so that the vector is large
529 enough to describe all lines in a window when it is displayed in
530 the smallest possible character size. When new fonts are loaded,
531 or window sizes change, the row vector is adjusted accordingly. */
535 /* The pool from which glyph memory is allocated, if any. This is
536 null for frame matrices and for window matrices managing their
538 struct glyph_pool
*pool
;
540 /* Vector of glyph row structures. The row at nrows - 1 is reserved
541 for the mode line. */
542 struct glyph_row
*rows
;
544 /* Number of elements allocated for the vector rows above. */
547 /* The number of rows used by the window if all lines were displayed
548 with the smallest possible character height. */
551 /* Origin within the frame matrix if this is a window matrix on a
552 frame having a frame matrix. Both values are zero for
553 window-based redisplay. */
554 int matrix_x
, matrix_y
;
556 /* Width and height of the matrix in columns and rows. */
557 int matrix_w
, matrix_h
;
559 /* If this structure describes a window matrix of window W,
560 window_left_col is the value of W->left_col, window_top_line the
561 value of W->top_line, window_height and window_width are width and
562 height of W, as returned by window_box, and window_vscroll is the
563 value of W->vscroll at the time the matrix was last adjusted.
564 Only set for window-based redisplay. */
565 int window_left_col
, window_top_line
;
566 int window_height
, window_width
;
569 /* Number of glyphs reserved for left and right marginal areas when
570 the matrix was last adjusted. */
571 int left_margin_glyphs
, right_margin_glyphs
;
573 /* Flag indicating that scrolling should not be tried in
574 update_window. This flag is set by functions like try_window_id
575 which do their own scrolling. */
576 unsigned no_scrolling_p
: 1;
578 /* Non-zero means window displayed in this matrix has a top mode
580 unsigned header_line_p
: 1;
583 /* A string identifying the method used to display the matrix. */
587 /* The buffer this matrix displays. Set in
588 mark_window_display_accurate_1. */
589 struct buffer
*buffer
;
591 /* Values of BEGV and ZV as of last redisplay. Set in
592 mark_window_display_accurate_1. */
597 /* Check that glyph pointers stored in glyph rows of MATRIX are okay.
598 This aborts if any pointer is found twice. */
601 void check_matrix_pointer_lossage
P_ ((struct glyph_matrix
*));
602 #define CHECK_MATRIX(MATRIX) check_matrix_pointer_lossage ((MATRIX))
604 #define CHECK_MATRIX(MATRIX) (void) 0
609 /***********************************************************************
611 ***********************************************************************/
613 /* Area in window glyph matrix. If values are added or removed, the
614 function mark_object in alloc.c has to be changed. */
625 /* Rows of glyphs in a windows or frame glyph matrix.
627 Each row is partitioned into three areas. The start and end of
628 each area is recorded in a pointer as shown below.
630 +--------------------+-------------+---------------------+
631 | left margin area | text area | right margin area |
632 +--------------------+-------------+---------------------+
634 glyphs[LEFT_MARGIN_AREA] glyphs[RIGHT_MARGIN_AREA]
639 Rows in frame matrices reference glyph memory allocated in a frame
640 glyph pool (see the description of struct glyph_pool). Rows in
641 window matrices on frames having frame matrices reference slices of
642 the glyphs of corresponding rows in the frame matrix.
644 Rows in window matrices on frames having no frame matrices point to
645 glyphs allocated from the heap via xmalloc;
646 glyphs[LEFT_MARGIN_AREA] is the start address of the allocated
647 glyph structure array. */
651 /* Pointers to beginnings of areas. The end of an area A is found at
652 A + 1 in the vector. The last element of the vector is the end
655 Kludge alert: Even if used[TEXT_AREA] == 0, glyphs[TEXT_AREA][0]'s
656 position field is used. It is -1 if this row does not correspond
657 to any text; it is some buffer position if the row corresponds to
658 an empty display line that displays a line end. This is what old
659 redisplay used to do. (Except in code for terminal frames, this
660 kludge is no longer used, I believe. --gerd).
662 See also start, end, displays_text_p and ends_at_zv_p for cleaner
663 ways to do it. The special meaning of positions 0 and -1 will be
664 removed some day, so don't use it in new code. */
665 struct glyph
*glyphs
[1 + LAST_AREA
];
667 /* Number of glyphs actually filled in areas. */
668 short used
[LAST_AREA
];
670 /* Window-relative x and y-position of the top-left corner of this
671 row. If y < 0, this means that abs (y) pixels of the row are
672 invisible because it is partially visible at the top of a window.
673 If x < 0, this means that abs (x) pixels of the first glyph of
674 the text area of the row are invisible because the glyph is
675 partially visible. */
678 /* Width of the row in pixels without taking face extension at the
679 end of the row into account, and without counting truncation
680 and continuation glyphs at the end of a row on ttys. */
683 /* Logical ascent/height of this line. The value of ascent is zero
684 and height is 1 on terminal frames. */
687 /* Physical ascent/height of this line. If max_ascent > ascent,
688 this line overlaps the line above it on the display. Otherwise,
689 if max_height > height, this line overlaps the line beneath it. */
690 int phys_ascent
, phys_height
;
692 /* Portion of row that is visible. Partially visible rows may be
693 found at the top and bottom of a window. This is 1 for tty
694 frames. It may be < 0 in case of completely invisible rows. */
697 /* Extra line spacing added after this row. Do not consider this
698 in last row when checking if row is fully visible. */
699 int extra_line_spacing
;
701 /* Hash code. This hash code is available as soon as the row
702 is constructed, i.e. after a call to display_line. */
705 /* First position in this row. This is the text position, including
706 overlay position information etc, where the display of this row
707 started, and can thus be less the position of the first glyph
708 (e.g. due to invisible text or horizontal scrolling). */
709 struct display_pos start
;
711 /* Text position at the end of this row. This is the position after
712 the last glyph on this row. It can be greater than the last
713 glyph position + 1, due to truncation, invisible text etc. In an
714 up-to-date display, this should always be equal to the start
715 position of the next row. */
716 struct display_pos end
;
718 /* Left fringe bitmap number (enum fringe_bitmap_type). */
719 unsigned left_user_fringe_bitmap
: FRINGE_ID_BITS
;
721 /* Right fringe bitmap number (enum fringe_bitmap_type). */
722 unsigned right_user_fringe_bitmap
: FRINGE_ID_BITS
;
724 /* Left fringe bitmap number (enum fringe_bitmap_type). */
725 unsigned left_fringe_bitmap
: FRINGE_ID_BITS
;
727 /* Right fringe bitmap number (enum fringe_bitmap_type). */
728 unsigned right_fringe_bitmap
: FRINGE_ID_BITS
;
730 /* Face of the left fringe glyph. */
731 unsigned left_user_fringe_face_id
: FACE_ID_BITS
;
733 /* Face of the right fringe glyph. */
734 unsigned right_user_fringe_face_id
: FACE_ID_BITS
;
736 /* Face of the left fringe glyph. */
737 unsigned left_fringe_face_id
: FACE_ID_BITS
;
739 /* Face of the right fringe glyph. */
740 unsigned right_fringe_face_id
: FACE_ID_BITS
;
742 /* 1 means that we must draw the bitmaps of this row. */
743 unsigned redraw_fringe_bitmaps_p
: 1;
745 /* In a desired matrix, 1 means that this row must be updated. In a
746 current matrix, 0 means that the row has been invalidated, i.e.
747 the row's contents do not agree with what is visible on the
749 unsigned enabled_p
: 1;
751 /* 1 means row displays a text line that is truncated on the left or
753 unsigned truncated_on_left_p
: 1;
754 unsigned truncated_on_right_p
: 1;
756 /* 1 means the overlay arrow is on this line. */
757 unsigned overlay_arrow_p
: 1;
759 /* 1 means that this row displays a continued line, i.e. it has a
760 continuation mark at the right side. */
761 unsigned continued_p
: 1;
763 /* 0 means that this row does not contain any text, i.e. it is
764 a blank line at the window and buffer end. */
765 unsigned displays_text_p
: 1;
767 /* 1 means that this line ends at ZV. */
768 unsigned ends_at_zv_p
: 1;
770 /* 1 means the face of the last glyph in the text area is drawn to
771 the right end of the window. This flag is used in
772 update_text_area to optimize clearing to the end of the area. */
773 unsigned fill_line_p
: 1;
775 /* Non-zero means display a bitmap on X frames indicating that this
776 line contains no text and ends in ZV. */
777 unsigned indicate_empty_line_p
: 1;
779 /* 1 means this row contains glyphs that overlap each other because
780 of lbearing or rbearing. */
781 unsigned contains_overlapping_glyphs_p
: 1;
783 /* 1 means this row is as wide as the window it is displayed in, including
784 scroll bars, fringes, and internal borders. This also
785 implies that the row doesn't have marginal areas. */
786 unsigned full_width_p
: 1;
788 /* Non-zero means row is a mode or header-line. */
789 unsigned mode_line_p
: 1;
791 /* 1 in a current row means this row is overlapped by another row. */
792 unsigned overlapped_p
: 1;
794 /* 1 means this line ends in the middle of a character consisting
795 of more than one glyph. Some glyphs have been put in this row,
796 the rest are put in rows below this one. */
797 unsigned ends_in_middle_of_char_p
: 1;
799 /* 1 means this line starts in the middle of a character consisting
800 of more than one glyph. Some glyphs have been put in the
801 previous row, the rest are put in this row. */
802 unsigned starts_in_middle_of_char_p
: 1;
804 /* 1 in a current row means this row overlaps others. */
805 unsigned overlapping_p
: 1;
807 /* 1 means some glyphs in this row are displayed in mouse-face. */
808 unsigned mouse_face_p
: 1;
810 /* 1 means this row was ended by a newline from a string. */
811 unsigned ends_in_newline_from_string_p
: 1;
813 /* 1 means this row width is exactly the width of the window, and the
814 final newline character is hidden in the right fringe. */
815 unsigned exact_window_width_line_p
: 1;
817 /* 1 means this row currently shows the cursor in the right fringe. */
818 unsigned cursor_in_fringe_p
: 1;
820 /* Non-zero means display a bitmap on X frames indicating that this
821 the first line of the buffer. */
822 unsigned indicate_bob_p
: 1;
824 /* Non-zero means display a bitmap on X frames indicating that this
825 the top line of the window, but not start of the buffer. */
826 unsigned indicate_top_line_p
: 1;
828 /* Non-zero means display a bitmap on X frames indicating that this
829 the last line of the buffer. */
830 unsigned indicate_eob_p
: 1;
832 /* Non-zero means display a bitmap on X frames indicating that this
833 the bottom line of the window, but not end of the buffer. */
834 unsigned indicate_bottom_line_p
: 1;
836 /* Continuation lines width at the start of the row. */
837 int continuation_lines_width
;
841 /* Get a pointer to row number ROW in matrix MATRIX. If GLYPH_DEBUG
842 is defined to a non-zero value, the function matrix_row checks that
843 we don't try to access rows that are out of bounds. */
846 struct glyph_row
*matrix_row
P_ ((struct glyph_matrix
*, int));
847 #define MATRIX_ROW(MATRIX, ROW) matrix_row ((MATRIX), (ROW))
849 #define MATRIX_ROW(MATRIX, ROW) ((MATRIX)->rows + (ROW))
852 /* Return a pointer to the row reserved for the mode line in MATRIX.
853 Row MATRIX->nrows - 1 is always reserved for the mode line. */
855 #define MATRIX_MODE_LINE_ROW(MATRIX) \
856 ((MATRIX)->rows + (MATRIX)->nrows - 1)
858 /* Return a pointer to the row reserved for the header line in MATRIX.
859 This is always the first row in MATRIX because that's the only
860 way that works in frame-based redisplay. */
862 #define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows
864 /* Return a pointer to first row in MATRIX used for text display. */
866 #define MATRIX_FIRST_TEXT_ROW(MATRIX) \
867 ((MATRIX)->rows->mode_line_p ? (MATRIX)->rows + 1 : (MATRIX)->rows)
869 /* Return a pointer to the first glyph in the text area of a row.
870 MATRIX is the glyph matrix accessed, and ROW is the row index in
873 #define MATRIX_ROW_GLYPH_START(MATRIX, ROW) \
874 (MATRIX_ROW ((MATRIX), (ROW))->glyphs[TEXT_AREA])
876 /* Return the number of used glyphs in the text area of a row. */
878 #define MATRIX_ROW_USED(MATRIX, ROW) \
879 (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA])
881 /* Return the character/ byte position at which the display of ROW
884 #define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->start.pos.charpos)
885 #define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->start.pos.bytepos)
887 /* Return the character/ byte position at which ROW ends. */
889 #define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->end.pos.charpos)
890 #define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->end.pos.bytepos)
892 /* Return the vertical position of ROW in MATRIX. */
894 #define MATRIX_ROW_VPOS(ROW, MATRIX) ((ROW) - (MATRIX)->rows)
896 /* Return the last glyph row + 1 in MATRIX on window W reserved for
897 text. If W has a mode line, the last row in the matrix is reserved
900 #define MATRIX_BOTTOM_TEXT_ROW(MATRIX, W) \
903 - (WINDOW_WANTS_MODELINE_P ((W)) ? 1 : 0))
905 /* Non-zero if the face of the last glyph in ROW's text area has
906 to be drawn to the end of the text area. */
908 #define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)
910 /* Set and query the enabled_p flag of glyph row ROW in MATRIX. */
912 #define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
913 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0)
915 #define MATRIX_ROW_ENABLED_P(MATRIX, ROW) \
916 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p)
918 /* Non-zero if ROW displays text. Value is non-zero if the row is
919 blank but displays a line end. */
921 #define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)
926 #define MR_PARTIALLY_VISIBLE(ROW) \
927 ((ROW)->height != (ROW)->visible_height)
929 #define MR_PARTIALLY_VISIBLE_AT_TOP(W, ROW) \
930 ((ROW)->y < WINDOW_HEADER_LINE_HEIGHT ((W)))
932 #define MR_PARTIALLY_VISIBLE_AT_BOTTOM(W, ROW) \
933 (((ROW)->y + (ROW)->height - (ROW)->extra_line_spacing) \
934 > WINDOW_BOX_HEIGHT_NO_MODE_LINE ((W)))
936 /* Non-zero if ROW is not completely visible in window W. */
938 #define MATRIX_ROW_PARTIALLY_VISIBLE_P(W, ROW) \
939 (MR_PARTIALLY_VISIBLE ((ROW)) \
940 && (MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)) \
941 || MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW))))
945 /* Non-zero if ROW is partially visible at the top of window W. */
947 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW) \
948 (MR_PARTIALLY_VISIBLE ((ROW)) \
949 && MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)))
951 /* Non-zero if ROW is partially visible at the bottom of window W. */
953 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW) \
954 (MR_PARTIALLY_VISIBLE ((ROW)) \
955 && MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW)))
957 /* Return the bottom Y + 1 of ROW. */
959 #define MATRIX_ROW_BOTTOM_Y(ROW) ((ROW)->y + (ROW)->height)
961 /* Is ROW the last visible one in the display described by the
962 iterator structure pointed to by IT?. */
964 #define MATRIX_ROW_LAST_VISIBLE_P(ROW, IT) \
965 (MATRIX_ROW_BOTTOM_Y ((ROW)) >= (IT)->last_visible_y)
967 /* Non-zero if ROW displays a continuation line. */
969 #define MATRIX_ROW_CONTINUATION_LINE_P(ROW) \
970 ((ROW)->continuation_lines_width > 0)
972 /* Non-zero if ROW ends in the middle of a character. This is the
973 case for continued lines showing only part of a display table entry
974 or a control char, or an overlay string. */
976 #define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW) \
977 ((ROW)->end.dpvec_index >= 0 \
978 || (ROW)->end.overlay_string_index >= 0 \
979 || (ROW)->ends_in_middle_of_char_p)
981 /* Non-zero if ROW ends in the middle of an overlay string. */
983 #define MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P(ROW) \
984 ((ROW)->end.overlay_string_index >= 0)
986 /* Non-zero if ROW starts in the middle of a character. See above. */
988 #define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW) \
989 ((ROW)->start.dpvec_index >= 0 \
990 || (ROW)->starts_in_middle_of_char_p \
991 || ((ROW)->start.overlay_string_index >= 0 \
992 && (ROW)->start.string_pos.charpos > 0))
994 /* Non-zero means ROW overlaps its predecessor. */
996 #define MATRIX_ROW_OVERLAPS_PRED_P(ROW) \
997 ((ROW)->phys_ascent > (ROW)->ascent)
999 /* Non-zero means ROW overlaps its successor. */
1001 #define MATRIX_ROW_OVERLAPS_SUCC_P(ROW) \
1002 ((ROW)->phys_height - (ROW)->phys_ascent \
1003 > (ROW)->height - (ROW)->ascent)
1005 /* Non-zero means that fonts have been loaded since the last glyph
1006 matrix adjustments. The function redisplay_internal adjusts glyph
1007 matrices when this flag is non-zero. */
1009 extern int fonts_changed_p
;
1011 /* A glyph for a space. */
1013 extern struct glyph space_glyph
;
1015 /* Frame being updated by update_window/update_frame. */
1017 extern struct frame
*updating_frame
;
1019 /* Window being updated by update_window. This is non-null as long as
1020 update_window has not finished, and null otherwise. It's role is
1021 analogous to updating_frame. */
1023 extern struct window
*updated_window
;
1025 /* Glyph row and area updated by update_window_line. */
1027 extern struct glyph_row
*updated_row
;
1028 extern int updated_area
;
1030 /* Non-zero means reading single-character input with prompt so put
1031 cursor on mini-buffer after the prompt. Positive means at end of
1032 text in echo area; negative means at beginning of line. */
1034 extern int cursor_in_echo_area
;
1036 /* Non-zero means last display completed. Zero means it was
1039 extern int display_completed
;
1041 /* Non-zero means redisplay has been performed directly (see also
1042 direct_output_for_insert and direct_output_forward_char), so that
1043 no further updating has to be performed. The function
1044 redisplay_internal checks this flag, and does nothing but reset it
1045 to zero if it is non-zero. */
1047 extern int redisplay_performed_directly_p
;
1049 /* A temporary storage area, including a row of glyphs. Initialized
1050 in xdisp.c. Used for various purposes, as an example see
1051 direct_output_for_insert. */
1053 extern struct glyph_row scratch_glyph_row
;
1057 /************************************************************************
1059 ************************************************************************/
1061 /* Enumeration for overriding/changing the face to use for drawing
1062 glyphs in draw_glyphs. */
1064 enum draw_glyphs_face
1074 #ifdef HAVE_WINDOW_SYSTEM
1076 /* A sequence of glyphs to be drawn in the same face. */
1080 /* X-origin of the string. */
1083 /* Y-origin and y-position of the base line of this string. */
1086 /* The width of the string, not including a face extension. */
1089 /* The width of the string, including a face extension. */
1090 int background_width
;
1092 /* The height of this string. This is the height of the line this
1093 string is drawn in, and can be different from the height of the
1094 font the string is drawn in. */
1097 /* Number of pixels this string overwrites in front of its x-origin.
1098 This number is zero if the string has an lbearing >= 0; it is
1099 -lbearing, if the string has an lbearing < 0. */
1102 /* Number of pixels this string overwrites past its right-most
1103 nominal x-position, i.e. x + width. Zero if the string's
1104 rbearing is <= its nominal width, rbearing - width otherwise. */
1107 /* The frame on which the glyph string is drawn. */
1110 /* The window on which the glyph string is drawn. */
1113 /* X display and window for convenience. */
1117 /* The glyph row for which this string was built. It determines the
1118 y-origin and height of the string. */
1119 struct glyph_row
*row
;
1121 /* The area within row. */
1122 enum glyph_row_area area
;
1124 /* Characters to be drawn, and number of characters. */
1128 /* A face-override for drawing cursors, mouse face and similar. */
1129 enum draw_glyphs_face hl
;
1131 /* Face in which this string is to be drawn. */
1134 /* Font in which this string is to be drawn. */
1137 /* Font info for this string. */
1138 struct font_info
*font_info
;
1140 /* Non-null means this string describes (part of) a composition.
1141 All characters from char2b are drawn composed. */
1142 struct composition
*cmp
;
1144 /* Index of this glyph string's first character in the glyph
1145 definition of CMP. If this is zero, this glyph string describes
1146 the first character of a composition. */
1149 /* 1 means this glyph strings face has to be drawn to the right end
1150 of the window's drawing area. */
1151 unsigned extends_to_end_of_line_p
: 1;
1153 /* 1 means the background of this string has been drawn. */
1154 unsigned background_filled_p
: 1;
1156 /* 1 means glyph string must be drawn with 16-bit functions. */
1157 unsigned two_byte_p
: 1;
1159 /* 1 means that the original font determined for drawing this glyph
1160 string could not be loaded. The member `font' has been set to
1161 the frame's default font in this case. */
1162 unsigned font_not_found_p
: 1;
1164 /* 1 means that the face in which this glyph string is drawn has a
1166 unsigned stippled_p
: 1;
1168 /* 1 means only the foreground of this glyph string must be drawn,
1169 and we should use the physical height of the line this glyph
1170 string appears in as clip rect. */
1171 unsigned for_overlaps_p
: 1;
1173 /* The GC to use for drawing this glyph string. */
1174 #if defined(HAVE_X_WINDOWS) || defined(HAVE_CARBON)
1177 #if defined(HAVE_NTGUI)
1182 /* A pointer to the first glyph in the string. This glyph
1183 corresponds to char2b[0]. Needed to draw rectangles if
1184 font_not_found_p is 1. */
1185 struct glyph
*first_glyph
;
1187 /* Image, if any. */
1191 struct glyph_slice slice
;
1193 struct glyph_string
*next
, *prev
;
1196 #endif /* HAVE_WINDOW_SYSTEM */
1199 /************************************************************************
1201 ************************************************************************/
1203 /* Return the height of the mode line in glyph matrix MATRIX, or zero
1204 if not known. This macro is called under circumstances where
1205 MATRIX might not have been allocated yet. */
1207 #define MATRIX_MODE_LINE_HEIGHT(MATRIX) \
1208 ((MATRIX) && (MATRIX)->rows \
1209 ? MATRIX_MODE_LINE_ROW (MATRIX)->height \
1212 /* Return the height of the header line in glyph matrix MATRIX, or zero
1213 if not known. This macro is called under circumstances where
1214 MATRIX might not have been allocated yet. */
1216 #define MATRIX_HEADER_LINE_HEIGHT(MATRIX) \
1217 ((MATRIX) && (MATRIX)->rows \
1218 ? MATRIX_HEADER_LINE_ROW (MATRIX)->height \
1221 /* Return the desired face id for the mode line of a window, depending
1222 on whether the window is selected or not, or if the window is the
1223 scrolling window for the currently active minibuffer window.
1225 Due to the way display_mode_lines manipulates with the contents of
1226 selected_window, this macro needs three arguments: SELW which is
1227 compared against the current value of selected_window, MBW which is
1228 compared against minibuf_window (if SELW doesn't match), and SCRW
1229 which is compared against minibuf_selected_window (if MBW matches). */
1231 #define CURRENT_MODE_LINE_FACE_ID_3(SELW, MBW, SCRW) \
1232 ((!mode_line_in_non_selected_windows \
1233 || (SELW) == XWINDOW (selected_window) \
1234 || (minibuf_level > 0 \
1235 && !NILP (minibuf_selected_window) \
1236 && (MBW) == XWINDOW (minibuf_window) \
1237 && (SCRW) == XWINDOW (minibuf_selected_window))) \
1238 ? MODE_LINE_FACE_ID \
1239 : MODE_LINE_INACTIVE_FACE_ID)
1242 /* Return the desired face id for the mode line of window W. */
1244 #define CURRENT_MODE_LINE_FACE_ID(W) \
1245 (CURRENT_MODE_LINE_FACE_ID_3((W), XWINDOW (selected_window), (W)))
1247 /* Return the current height of the mode line of window W. If not
1248 known from current_mode_line_height, look at W's current glyph
1249 matrix, or return a default based on the height of the font of the
1250 face `mode-line'. */
1252 #define CURRENT_MODE_LINE_HEIGHT(W) \
1253 (current_mode_line_height >= 0 \
1254 ? current_mode_line_height \
1255 : (MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1256 ? MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1257 : estimate_mode_line_height (XFRAME ((W)->frame), \
1258 CURRENT_MODE_LINE_FACE_ID (W))))
1260 /* Return the current height of the header line of window W. If not
1261 known from current_header_line_height, look at W's current glyph
1262 matrix, or return an estimation based on the height of the font of
1263 the face `header-line'. */
1265 #define CURRENT_HEADER_LINE_HEIGHT(W) \
1266 (current_header_line_height >= 0 \
1267 ? current_header_line_height \
1268 : (MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1269 ? MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1270 : estimate_mode_line_height (XFRAME ((W)->frame), \
1271 HEADER_LINE_FACE_ID)))
1273 /* Return the height of the desired mode line of window W. */
1275 #define DESIRED_MODE_LINE_HEIGHT(W) \
1276 MATRIX_MODE_LINE_HEIGHT ((W)->desired_matrix)
1278 /* Return the height of the desired header line of window W. */
1280 #define DESIRED_HEADER_LINE_HEIGHT(W) \
1281 MATRIX_HEADER_LINE_HEIGHT ((W)->desired_matrix)
1283 /* Value is non-zero if window W wants a mode line. */
1285 #define WINDOW_WANTS_MODELINE_P(W) \
1286 (!MINI_WINDOW_P ((W)) \
1287 && !(W)->pseudo_window_p \
1288 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1289 && BUFFERP ((W)->buffer) \
1290 && !NILP (XBUFFER ((W)->buffer)->mode_line_format) \
1291 && WINDOW_TOTAL_LINES (W) > 1)
1293 /* Value is non-zero if window W wants a header line. */
1295 #define WINDOW_WANTS_HEADER_LINE_P(W) \
1296 (!MINI_WINDOW_P ((W)) \
1297 && !(W)->pseudo_window_p \
1298 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1299 && BUFFERP ((W)->buffer) \
1300 && !NILP (XBUFFER ((W)->buffer)->header_line_format) \
1301 && WINDOW_TOTAL_LINES (W) > 1 + !NILP (XBUFFER ((W)->buffer)->mode_line_format))
1304 /* Return proper value to be used as baseline offset of font that has
1305 ASCENT and DESCENT to draw characters by the font at the vertical
1306 center of the line of frame F.
1308 Here, our task is to find the value of BOFF in the following figure;
1310 -------------------------+-----------+-
1311 -+-+---------+-+ | |
1313 | | | | F_ASCENT F_HEIGHT
1316 | | |-|-+------+-----------|------- baseline
1318 | |---------|-+-+ | |
1320 -+-+---------+-+ F_DESCENT |
1321 -------------------------+-----------+-
1323 -BOFF + DESCENT + (F_HEIGHT - HEIGHT) / 2 = F_DESCENT
1324 BOFF = DESCENT + (F_HEIGHT - HEIGHT) / 2 - F_DESCENT
1325 DESCENT = FONT->descent
1326 HEIGHT = FONT_HEIGHT (FONT)
1327 F_DESCENT = (FRAME_FONT (F)->descent
1328 - F->output_data.x->baseline_offset)
1329 F_HEIGHT = FRAME_LINE_HEIGHT (F)
1332 #define VCENTER_BASELINE_OFFSET(FONT, F) \
1333 (FONT_DESCENT (FONT) \
1334 + (FRAME_LINE_HEIGHT ((F)) - FONT_HEIGHT ((FONT)) \
1335 + (FRAME_LINE_HEIGHT ((F)) > FONT_HEIGHT ((FONT)))) / 2 \
1336 - (FONT_DESCENT (FRAME_FONT (F)) - FRAME_BASELINE_OFFSET (F)))
1339 /***********************************************************************
1341 ***********************************************************************/
1343 /* Indices of face attributes in Lisp face vectors. Slot zero is the
1346 enum lface_attribute_index
1348 LFACE_FAMILY_INDEX
= 1,
1353 LFACE_UNDERLINE_INDEX
,
1354 LFACE_INVERSE_INDEX
,
1355 LFACE_FOREGROUND_INDEX
,
1356 LFACE_BACKGROUND_INDEX
,
1357 LFACE_STIPPLE_INDEX
,
1358 LFACE_OVERLINE_INDEX
,
1359 LFACE_STRIKE_THROUGH_INDEX
,
1362 LFACE_INHERIT_INDEX
,
1363 LFACE_AVGWIDTH_INDEX
,
1364 LFACE_FONTSET_INDEX
,
1369 /* Box types of faces. */
1373 /* No box around text. */
1376 /* Simple box of specified width and color. Default width is 1, and
1377 default color is the foreground color of the face. */
1380 /* Boxes with 3D shadows. Color equals the background color of the
1381 face. Width is specified. */
1387 /* Structure describing a realized face.
1389 For each Lisp face, 0..N realized faces can exist for different
1390 frames and different charsets. Realized faces are built from Lisp
1391 faces and text properties/overlays by merging faces and adding
1392 unspecified attributes from the `default' face. */
1396 /* The id of this face. The id equals the index of this face in the
1397 vector faces_by_id of its face cache. */
1400 #ifdef HAVE_WINDOW_SYSTEM
1402 /* If non-zero, this is a GC that we can use without modification for
1403 drawing the characters in this face. */
1406 /* Font used for this face, or null if the font could not be loaded
1407 for some reason. This points to a `font' slot of a struct
1408 font_info, and we should not call XFreeFont on it because the
1409 font may still be used somewhere else. */
1412 /* Background stipple or bitmap used for this face. This is
1413 an id as returned from load_pixmap. */
1416 #else /* not HAVE_WINDOW_SYSTEM */
1421 #endif /* not HAVE_WINDOW_SYSTEM */
1423 /* Pixel value of foreground color for X frames. Color index
1425 unsigned long foreground
;
1427 /* Pixel value or color index of background color. */
1428 unsigned long background
;
1430 /* Pixel value or color index of underline color. */
1431 unsigned long underline_color
;
1433 /* Pixel value or color index of overlined, strike-through, or box
1435 unsigned long overline_color
;
1436 unsigned long strike_through_color
;
1437 unsigned long box_color
;
1439 /* The font's name. This points to a `name' of a font_info, and it
1440 must not be freed. */
1443 /* Font info ID for this face's font. An ID is stored here because
1444 pointers to font_info structures may change. The reason is that
1445 they are pointers into a font table vector that is itself
1449 /* Fontset ID if for this face's fontset. Non-ASCII faces derived
1450 from the same ASCII face have the same fontset. */
1453 /* Pixmap width and height. */
1454 unsigned int pixmap_w
, pixmap_h
;
1456 /* Non-zero means characters in this face have a box that thickness
1457 around them. If it is negative, the absolute value indicates the
1458 thickness, and the horizontal lines of box (top and bottom) are
1459 drawn inside of characters glyph area. The vertical lines of box
1460 (left and right) are drawn as the same way as the case that this
1461 value is positive. */
1464 /* Type of box drawn. A value of FACE_NO_BOX means no box is drawn
1465 around text in this face. A value of FACE_SIMPLE_BOX means a box
1466 of width box_line_width is drawn in color box_color. A value of
1467 FACE_RAISED_BOX or FACE_SUNKEN_BOX means a 3D box is drawn with
1468 shadow colors derived from the background color of the face. */
1469 enum face_box_type box
;
1471 /* If `box' above specifies a 3D type, 1 means use box_color for
1473 unsigned use_box_color_for_shadows_p
: 1;
1475 /* The Lisp face attributes this face realizes. All attributes
1476 in this vector are non-nil. */
1477 Lisp_Object lface
[LFACE_VECTOR_SIZE
];
1479 /* The hash value of this face. */
1482 /* Non-zero if text in this face should be underlined, overlined,
1483 strike-through or have a box drawn around it. */
1484 unsigned underline_p
: 1;
1485 unsigned overline_p
: 1;
1486 unsigned strike_through_p
: 1;
1488 /* 1 means that the colors specified for this face could not be
1489 loaded, and were replaced by default colors, so they shouldn't be
1491 unsigned foreground_defaulted_p
: 1;
1492 unsigned background_defaulted_p
: 1;
1494 /* 1 means that either no color is specified for underlining or that
1495 the specified color couldn't be loaded. Use the foreground
1496 color when drawing in that case. */
1497 unsigned underline_defaulted_p
: 1;
1499 /* 1 means that either no color is specified for the corresponding
1500 attribute or that the specified color couldn't be loaded.
1501 Use the foreground color when drawing in that case. */
1502 unsigned overline_color_defaulted_p
: 1;
1503 unsigned strike_through_color_defaulted_p
: 1;
1504 unsigned box_color_defaulted_p
: 1;
1506 /* TTY appearances. Blinking is not yet implemented. Colors are
1507 found in `lface' with empty color string meaning the default
1508 color of the TTY. */
1509 unsigned tty_bold_p
: 1;
1510 unsigned tty_dim_p
: 1;
1511 unsigned tty_underline_p
: 1;
1512 unsigned tty_alt_charset_p
: 1;
1513 unsigned tty_reverse_p
: 1;
1514 unsigned tty_blinking_p
: 1;
1516 /* 1 means that colors of this face may not be freed because they
1517 have been copied bitwise from a base face (see
1519 unsigned colors_copied_bitwise_p
: 1;
1521 /* If non-zero, use overstrike (to simulate bold-face). */
1522 unsigned overstrike
: 1;
1524 /* Next and previous face in hash collision list of face cache. */
1525 struct face
*next
, *prev
;
1527 /* If this face is an ASCII face, this points to this face itself.
1528 Otherwise, this points to an ASCII face that has the same
1529 attributes except the font. */
1530 struct face
*ascii_face
;
1534 /* Color index indicating that face uses a terminal's default color. */
1536 #define FACE_TTY_DEFAULT_COLOR ((unsigned long) -1)
1538 /* Color index indicating that face uses an unknown foreground color. */
1540 #define FACE_TTY_DEFAULT_FG_COLOR ((unsigned long) -2)
1542 /* Color index indicating that face uses an unknown background color. */
1544 #define FACE_TTY_DEFAULT_BG_COLOR ((unsigned long) -3)
1546 /* Non-zero if FACE was realized for unibyte use. */
1548 #define FACE_UNIBYTE_P(FACE) ((FACE)->charset < 0)
1551 /* IDs of important faces known by the C face code. These are the IDs
1552 of the faces for CHARSET_ASCII. */
1558 MODE_LINE_INACTIVE_FACE_ID
,
1561 HEADER_LINE_FACE_ID
,
1567 BASIC_FACE_ID_SENTINEL
1570 #define MAX_FACE_ID ((1 << FACE_ID_BITS) - 1)
1572 /* A cache of realized faces. Each frame has its own cache because
1573 Emacs allows different frame-local face definitions. */
1577 /* Hash table of cached realized faces. */
1578 struct face
**buckets
;
1580 /* Back-pointer to the frame this cache belongs to. */
1583 /* A vector of faces so that faces can be referenced by an ID. */
1584 struct face
**faces_by_id
;
1586 /* The allocated size, and number of used slots of faces_by_id. */
1589 /* Flag indicating that attributes of the `menu' face have been
1591 unsigned menu_face_changed_p
: 1;
1595 /* Prepare face FACE for use on frame F. This must be called before
1596 using X resources of FACE. */
1598 #define PREPARE_FACE_FOR_DISPLAY(F, FACE) \
1599 if ((FACE)->gc == 0) \
1600 prepare_face_for_display ((F), (FACE)); \
1604 /* Return a pointer to the face with ID on frame F, or null if such a
1605 face doesn't exist. */
1607 #define FACE_FROM_ID(F, ID) \
1608 (((unsigned) (ID) < FRAME_FACE_CACHE (F)->used) \
1609 ? FRAME_FACE_CACHE (F)->faces_by_id[ID] \
1612 #ifdef HAVE_WINDOW_SYSTEM
1614 /* Non-zero if FACE is suitable for displaying character CHAR. */
1616 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) \
1617 (ASCII_CHAR_P (CHAR) \
1618 ? (FACE) == (FACE)->ascii_face \
1619 : face_suitable_for_char_p ((FACE), (CHAR)))
1621 /* Return the id of the realized face on frame F that is like the face
1622 with id ID but is suitable for displaying character CHAR.
1623 This macro is only meaningful for multibyte character CHAR. */
1625 #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) \
1626 (ASCII_CHAR_P (CHAR) \
1627 ? (FACE)->ascii_face->id \
1628 : face_for_char ((F), (FACE), (CHAR), (POS), (OBJECT)))
1630 #else /* not HAVE_WINDOW_SYSTEM */
1632 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) 1
1633 #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) ((FACE)->id)
1635 #endif /* not HAVE_WINDOW_SYSTEM */
1637 /* Non-zero means face attributes have been changed since the last
1638 redisplay. Used in redisplay_internal. */
1640 extern int face_change_count
;
1645 /***********************************************************************
1647 ***********************************************************************/
1649 /* Structure used to describe where and how to draw a fringe bitmap.
1650 WHICH is the fringe bitmap to draw. WD and H is the (adjusted)
1651 width and height of the bitmap, DH is the height adjustment (if
1652 bitmap is periodic). X and Y are frame coordinates of the area to
1653 display the bitmap, DY is relative offset of the bitmap into that
1654 area. BX, NX, BY, NY specifies the area to clear if the bitmap
1655 does not fill the entire area. FACE is the fringe face. */
1657 struct draw_fringe_bitmap_params
1659 int which
; /* enum fringe_bitmap_type */
1660 unsigned short *bits
;
1664 unsigned cursor_p
: 1;
1665 unsigned overlay_p
: 1;
1669 #define MAX_FRINGE_BITMAPS (1<<FRINGE_ID_BITS)
1672 /***********************************************************************
1674 ***********************************************************************/
1676 /* Iteration over things to display in current_buffer or in a string.
1678 The iterator handles:
1680 1. Overlay strings (after-string, before-string).
1682 3. Invisible text properties.
1683 4. Selective display.
1684 5. Translation of characters via display tables.
1685 6. Translation of control characters to the forms `\003' or `^C'.
1686 7. `glyph' and `space-width' properties.
1688 Iterators are initialized by calling init_iterator or one of the
1689 equivalent functions below. A call to get_next_display_element
1690 loads the iterator structure with information about what next to
1691 display. A call to set_iterator_to_next increments the iterator's
1694 Characters from overlay strings, display table entries or control
1695 character translations are returned one at a time. For example, if
1696 we have a text of `a\x01' where `a' has a display table definition
1697 of `cd' and the control character is displayed with a leading
1698 arrow, then the iterator will return:
1700 Call Return Source Call next
1701 -----------------------------------------------------------------
1702 next c display table move
1703 next d display table move
1704 next ^ control char move
1705 next A control char move
1707 The same mechanism is also used to return characters for ellipses
1708 displayed at the end of invisible text.
1710 CAVEAT: Under some circumstances, move_.* functions can be called
1711 asynchronously, e.g. when computing a buffer position from an x and
1712 y pixel position. This means that these functions and functions
1713 called from them SHOULD NOT USE xmalloc and alike. See also the
1714 comment at the start of xdisp.c. */
1716 /* Enumeration describing what kind of display element an iterator is
1717 loaded with after a call to get_next_display_element. */
1719 enum display_element_type
1721 /* A normal character. */
1724 /* A composition sequence. */
1730 /* A flexible width and height space. */
1733 /* End of buffer or string. */
1736 /* Truncation glyphs. Never returned by get_next_display_element.
1737 Used to get display information about truncation glyphs via
1741 /* Continuation glyphs. See the comment for IT_TRUNCATION. */
1746 /* An enumerator for each text property that has a meaning for display
1751 AUTO_COMPOSED_PROP_IDX
,
1756 COMPOSITION_PROP_IDX
,
1758 /* Not a property. Used to indicate changes in overlays. */
1777 /* The window in which we iterate over current_buffer (or a string). */
1781 /* The window's frame. */
1784 /* Function to call to load this structure with the next display
1786 int (* method
) P_ ((struct it
*it
));
1788 /* The next position at which to check for face changes, invisible
1789 text, overlay strings, end of text etc., which see. */
1792 /* Maximum string or buffer position + 1. ZV when iterating over
1796 /* C string to iterate over. Non-null means get characters from
1797 this string, otherwise characters are read from current_buffer
1801 /* Number of characters in the string (s, or it->string) we iterate
1805 /* Start and end of a visible region; -1 if the region is not
1806 visible in the window. */
1807 int region_beg_charpos
, region_end_charpos
;
1809 /* Position at which redisplay end trigger functions should be run. */
1810 int redisplay_end_trigger_charpos
;
1812 /* 1 means multibyte characters are enabled. */
1813 unsigned multibyte_p
: 1;
1815 /* 1 means window has a mode line at its top. */
1816 unsigned header_line_p
: 1;
1818 /* 1 means `string' is the value of a `display' property.
1819 Don't handle some `display' properties in these strings. */
1820 unsigned string_from_display_prop_p
: 1;
1822 /* Display table in effect or null for none. */
1823 struct Lisp_Char_Table
*dp
;
1825 /* Current display table vector to return characters from and its
1826 end. dpvec null means we are not returning characters from a
1827 display table entry; current.dpvec_index gives the current index
1828 into dpvec. This same mechanism is also used to return
1829 characters from translated control characters, i.e. `\003' or
1831 Lisp_Object
*dpvec
, *dpend
;
1833 /* Length in bytes of the char that filled dpvec. A value of zero
1834 means that no such character is involved. */
1837 /* Face id of the iterator saved in case a glyph from dpvec contains
1838 a face. The face is restored when all glyphs from dpvec have
1842 /* Vector of glyphs for control character translation. The pointer
1843 dpvec is set to ctl_chars when a control character is translated.
1844 This vector is also used for incomplete multibyte character
1845 translation (e.g \222\244). Such a character is at most 4 bytes,
1846 thus we need at most 16 bytes here. */
1847 Lisp_Object ctl_chars
[16];
1849 /* Initial buffer or string position of the iterator, before skipping
1850 over display properties and invisible text. */
1851 struct display_pos start
;
1853 /* Current buffer or string position of the iterator, including
1854 position in overlay strings etc. */
1855 struct display_pos current
;
1857 /* Vector of overlays to process. Overlay strings are processed
1858 OVERLAY_STRING_CHUNK_SIZE at a time. */
1859 #define OVERLAY_STRING_CHUNK_SIZE 3
1860 Lisp_Object overlay_strings
[OVERLAY_STRING_CHUNK_SIZE
];
1862 /* Total number of overlay strings to process. This can be >
1863 OVERLAY_STRING_CHUNK_SIZE. */
1864 int n_overlay_strings
;
1866 /* If non-nil, a Lisp string being processed. If
1867 current.overlay_string_index >= 0, this is an overlay string from
1871 /* Stack of saved values. New entries are pushed when we begin to
1872 process an overlay string or a string from a `glyph' property.
1873 Entries are popped when we return to deliver display elements
1874 from what we previously had. */
1875 struct iterator_stack_entry
1880 struct display_pos pos
;
1883 enum glyph_row_area area
;
1884 unsigned multibyte_p
: 1;
1885 unsigned string_from_display_prop_p
: 1;
1886 unsigned display_ellipsis_p
: 1;
1887 struct it_slice slice
;
1888 Lisp_Object space_width
;
1890 Lisp_Object font_height
;
1894 /* Stack pointer. */
1897 /* Setting of buffer-local variable selective-display-ellipsis. */
1898 unsigned selective_display_ellipsis_p
: 1;
1900 /* 1 means control characters are translated into the form `^C'
1901 where the `^' can be replaced by a display table entry. */
1902 unsigned ctl_arrow_p
: 1;
1904 /* -1 means selective display hides everything between a \r and the
1905 next newline; > 0 means hide lines indented more than that value. */
1908 /* An enumeration describing what the next display element is
1909 after a call to get_next_display_element. */
1910 enum display_element_type what
;
1915 /* Non-zero means that the current face has a box. */
1916 unsigned face_box_p
: 1;
1918 /* Non-null means that the current character is the first in a run
1919 of characters with box face. */
1920 unsigned start_of_box_run_p
: 1;
1922 /* Non-zero means that the current character is the last in a run
1923 of characters with box face. */
1924 unsigned end_of_box_run_p
: 1;
1926 /* 1 means overlay strings at end_charpos have been processed. */
1927 unsigned overlay_strings_at_end_processed_p
: 1;
1929 /* 1 means the actual glyph is not available in the current
1931 unsigned glyph_not_available_p
: 1;
1933 /* 1 means the next line in display_line continues a character
1934 consisting of more than one glyph, and some glyphs of this
1935 character have been put on the previous line. */
1936 unsigned starts_in_middle_of_char_p
: 1;
1938 /* If 1, saved_face_id contains the id of the face in front of text
1939 skipped due to selective display. */
1940 unsigned face_before_selective_p
: 1;
1942 /* If 1, adjust current glyph so it does not increase current row
1943 descent/ascent (line-height property). Reset after this glyph. */
1944 unsigned constrain_row_ascent_descent_p
: 1;
1946 /* The ID of the default face to use. One of DEFAULT_FACE_ID,
1947 MODE_LINE_FACE_ID, etc, depending on what we are displaying. */
1950 /* If what == IT_CHARACTER, character and length in bytes. This is
1951 a character from a buffer or string. It may be different from
1952 the character displayed in case that
1953 unibyte_display_via_language_environment is set.
1955 If what == IT_COMPOSITION, the first component of a composition
1956 and length in bytes of the composition. */
1959 /* If what == IT_COMPOSITION, identification number and length in
1960 chars of a composition. */
1961 int cmp_id
, cmp_len
;
1963 /* The character to display, possibly translated to multibyte
1964 if unibyte_display_via_language_environment is set. This
1965 is set after produce_glyphs has been called. */
1966 int char_to_display
;
1968 /* If what == IT_IMAGE, the id of the image to display. */
1971 /* Values from `slice' property. */
1972 struct it_slice slice
;
1974 /* Value of the `space-width' property, if any; nil if none. */
1975 Lisp_Object space_width
;
1977 /* Computed from the value of the `raise' property. */
1980 /* Value of the `height' property, if any; nil if none. */
1981 Lisp_Object font_height
;
1983 /* Object and position where the current display element came from.
1984 Object can be a Lisp string in case the current display element
1985 comes from an overlay string, or it is buffer. It may also be nil
1986 during mode-line update. Position is a position in object. */
1988 struct text_pos position
;
1990 /* 1 means lines are truncated. */
1991 unsigned truncate_lines_p
: 1;
1993 /* Number of columns per \t. */
1996 /* Width in pixels of truncation and continuation glyphs. */
1997 short truncation_pixel_width
, continuation_pixel_width
;
1999 /* First and last visible x-position in the display area. If window
2000 is hscrolled by n columns, first_visible_x == n * FRAME_COLUMN_WIDTH
2001 (f), and last_visible_x == pixel width of W + first_visible_x. */
2002 int first_visible_x
, last_visible_x
;
2004 /* Last visible y-position + 1 in the display area without a mode
2005 line, if the window has one. */
2008 /* Default amount of additional space in pixels between lines (for
2009 window systems only.) */
2010 int extra_line_spacing
;
2012 /* Max extra line spacing added in this row. */
2013 int max_extra_line_spacing
;
2015 /* Override font height information for this glyph.
2016 Used if override_ascent >= 0. Cleared after this glyph. */
2017 int override_ascent
, override_descent
, override_boff
;
2019 /* If non-null, glyphs are produced in glyph_row with each call to
2021 struct glyph_row
*glyph_row
;
2023 /* The area of glyph_row to which glyphs are added. */
2024 enum glyph_row_area area
;
2026 /* Number of glyphs needed for the last character requested via
2027 produce_glyphs. This is 1 except for tabs. */
2030 /* Width of the display element in pixels. Result of
2034 /* Current, maximum logical, and maximum physical line height
2035 information. Result of produce_glyphs. */
2036 int ascent
, descent
, max_ascent
, max_descent
;
2037 int phys_ascent
, phys_descent
, max_phys_ascent
, max_phys_descent
;
2039 /* Current x pixel position within the display line. This value
2040 does not include the width of continuation lines in front of the
2041 line. The value of current_x is automatically incremented by
2042 pixel_width with each call to produce_glyphs. */
2045 /* Accumulated width of continuation lines. If > 0, this means we
2046 are currently in a continuation line. This is initially zero and
2047 incremented/reset by display_line, move_it_to etc. */
2048 int continuation_lines_width
;
2050 /* Current y-position. Automatically incremented by the height of
2051 glyph_row in move_it_to and display_line. */
2054 /* Vertical matrix position of first text line in window. */
2057 /* Current vertical matrix position, or line number. Automatically
2058 incremented by move_it_to and display_line. */
2061 /* Horizontal matrix position reached in move_it_in_display_line.
2062 Only set there, not in display_line. */
2065 /* Left fringe bitmap number (enum fringe_bitmap_type). */
2066 unsigned left_user_fringe_bitmap
: FRINGE_ID_BITS
;
2068 /* Right fringe bitmap number (enum fringe_bitmap_type). */
2069 unsigned right_user_fringe_bitmap
: FRINGE_ID_BITS
;
2071 /* Face of the left fringe glyph. */
2072 unsigned left_user_fringe_face_id
: FACE_ID_BITS
;
2074 /* Face of the right fringe glyph. */
2075 unsigned right_user_fringe_face_id
: FACE_ID_BITS
;
2079 /* Access to positions of iterator IT. */
2081 #define IT_CHARPOS(IT) CHARPOS ((IT).current.pos)
2082 #define IT_BYTEPOS(IT) BYTEPOS ((IT).current.pos)
2083 #define IT_STRING_CHARPOS(IT) CHARPOS ((IT).current.string_pos)
2084 #define IT_STRING_BYTEPOS(IT) BYTEPOS ((IT).current.string_pos)
2086 /* Test if IT has reached the end of its buffer or string. This will
2087 only work after get_next_display_element has been called. */
2089 #define ITERATOR_AT_END_P(IT) ((IT)->what == IT_EOB)
2091 /* Non-zero means IT is at the end of a line. This is the case if it
2092 is either on a newline or on a carriage return and selective
2093 display hides the rest of the line. */
2095 #define ITERATOR_AT_END_OF_LINE_P(IT) \
2096 ((IT)->what == IT_CHARACTER \
2097 && ((IT)->c == '\n' \
2098 || ((IT)->c == '\r' && (IT)->selective)))
2100 /* Call produce_glyphs or produce_glyphs_hook, if set. Shortcut to
2101 avoid the function call overhead. */
2103 #define PRODUCE_GLYPHS(IT) \
2105 extern int inhibit_free_realized_faces; \
2107 rif->produce_glyphs ((IT)); \
2109 produce_glyphs ((IT)); \
2110 if ((IT)->glyph_row != NULL) \
2111 inhibit_free_realized_faces = 1; \
2114 /* Bit-flags indicating what operation move_it_to should perform. */
2116 enum move_operation_enum
2118 /* Stop if specified x-position is reached. */
2121 /* Stop if specified y-position is reached. */
2124 /* Stop if specified vpos is reached. */
2125 MOVE_TO_VPOS
= 0x04,
2127 /* Stop if specified buffer or string position is reached. */
2133 /***********************************************************************
2134 Window-based redisplay interface
2135 ***********************************************************************/
2137 /* Structure used to describe runs of lines that must be scrolled. */
2141 /* Source and destination y pixel position. */
2142 int desired_y
, current_y
;
2144 /* Source and destination vpos in matrix. */
2145 int desired_vpos
, current_vpos
;
2147 /* Height in pixels, number of glyph rows. */
2152 /* Handlers for setting frame parameters. */
2154 typedef void (*frame_parm_handler
) P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
2157 /* Structure holding system-dependent interface functions needed
2158 for window-based redisplay. */
2160 struct redisplay_interface
2162 /* Handlers for setting frame parameters. */
2163 frame_parm_handler
*frame_parm_handlers
;
2165 /* Produce glyphs/get display metrics for the display element IT is
2167 void (*produce_glyphs
) P_ ((struct it
*it
));
2169 /* Write or insert LEN glyphs from STRING at the nominal output
2171 void (*write_glyphs
) P_ ((struct glyph
*string
, int len
));
2172 void (*insert_glyphs
) P_ ((struct glyph
*start
, int len
));
2174 /* Clear from nominal output position to X. X < 0 means clear
2175 to right end of display. */
2176 void (*clear_end_of_line
) P_ ((int x
));
2178 /* Function to call to scroll the display as described by RUN on
2180 void (*scroll_run_hook
) P_ ((struct window
*w
, struct run
*run
));
2182 /* Function to call after a line in a display has been completely
2183 updated. Used to draw truncation marks and alike. DESIRED_ROW
2184 is the desired row which has been updated. */
2185 void (*after_update_window_line_hook
) P_ ((struct glyph_row
*desired_row
));
2187 /* Function to call before beginning to update window W in
2188 window-based redisplay. */
2189 void (*update_window_begin_hook
) P_ ((struct window
*w
));
2191 /* Function to call after window W has been updated in window-based
2192 redisplay. CURSOR_ON_P non-zero means switch cursor on.
2193 MOUSE_FACE_OVERWRITTEN_P non-zero means that some lines in W
2194 that contained glyphs in mouse-face were overwritten, so we
2195 have to update the mouse highlight. */
2196 void (*update_window_end_hook
) P_ ((struct window
*w
, int cursor_on_p
,
2197 int mouse_face_overwritten_p
));
2199 /* Move cursor to row/column position VPOS/HPOS, pixel coordinates
2200 Y/X. HPOS/VPOS are window-relative row and column numbers and X/Y
2201 are window-relative pixel positions. */
2202 void (*cursor_to
) P_ ((int vpos
, int hpos
, int y
, int x
));
2204 /* Flush the display of frame F. For X, this is XFlush. */
2205 void (*flush_display
) P_ ((struct frame
*f
));
2207 /* Flush the display of frame F if non-NULL. This is called
2208 during redisplay, and should be NULL on systems which flushes
2209 automatically before reading input. */
2210 void (*flush_display_optional
) P_ ((struct frame
*f
));
2212 /* Clear the mouse hightlight in window W, if there is any. */
2213 void (*clear_window_mouse_face
) P_ ((struct window
*w
));
2215 /* Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
2217 void (*get_glyph_overhangs
) P_ ((struct glyph
*glyph
, struct frame
*f
,
2218 int *left
, int *right
));
2220 /* Fix the display of AREA of ROW in window W for overlapping rows.
2221 This function is called from redraw_overlapping_rows after
2222 desired rows have been made current. */
2223 void (*fix_overlapping_area
) P_ ((struct window
*w
, struct glyph_row
*row
,
2224 enum glyph_row_area area
));
2226 #ifdef HAVE_WINDOW_SYSTEM
2228 /* Draw a fringe bitmap in window W of row ROW using parameters P. */
2229 void (*draw_fringe_bitmap
) P_ ((struct window
*w
, struct glyph_row
*row
,
2230 struct draw_fringe_bitmap_params
*p
));
2232 /* Define and destroy fringe bitmap no. WHICH. */
2233 void (*define_fringe_bitmap
) P_ ((int which
, unsigned short *bits
,
2235 void (*destroy_fringe_bitmap
) P_ ((int which
));
2237 /* Get metrics of character CHAR2B in FONT of type FONT_TYPE.
2238 Value is null if CHAR2B is not contained in the font. */
2239 XCharStruct
* (*per_char_metric
) P_ ((XFontStruct
*font
, XChar2b
*char2b
,
2242 /* Encode CHAR2B using encoding information from FONT_INFO. CHAR2B is
2243 the two-byte form of C. Encoding is returned in *CHAR2B. If
2244 TWO_BYTE_P is non-null, return non-zero there if font is two-byte. */
2245 int (*encode_char
) P_ ((int c
, XChar2b
*char2b
,
2246 struct font_info
*font_into
,
2247 struct charset
*charset
,
2250 /* Compute left and right overhang of glyph string S.
2251 A NULL pointer if platform does not support this. */
2252 void (*compute_glyph_string_overhangs
) P_ ((struct glyph_string
*s
));
2254 /* Draw a glyph string S. */
2255 void (*draw_glyph_string
) P_ ((struct glyph_string
*s
));
2257 /* Define cursor CURSOR on frame F. */
2258 void (*define_frame_cursor
) P_ ((struct frame
*f
, Cursor cursor
));
2260 /* Clear the area at (X,Y,WIDTH,HEIGHT) of frame F. */
2261 void (*clear_frame_area
) P_ ((struct frame
*f
, int x
, int y
,
2262 int width
, int height
));
2264 /* Draw specified cursor CURSOR_TYPE of width CURSOR_WIDTH
2265 at row GLYPH_ROW on window W if ON_P is 1. If ON_P is
2266 0, don't draw cursor. If ACTIVE_P is 1, system caret
2267 should track this cursor (when applicable). */
2268 void (*draw_window_cursor
) P_ ((struct window
*w
,
2269 struct glyph_row
*glyph_row
,
2271 int cursor_type
, int cursor_width
,
2272 int on_p
, int active_p
));
2274 /* Draw vertical border for window W from (X,Y0) to (X,Y1). */
2275 void (*draw_vertical_window_border
) P_ ((struct window
*w
,
2276 int x
, int y0
, int y1
));
2278 /* Shift display of frame F to make room for inserted glyphs.
2279 The area at pixel (X,Y) of width WIDTH and height HEIGHT is
2280 shifted right by SHIFT_BY pixels. */
2281 void (*shift_glyphs_for_insert
) P_ ((struct frame
*f
,
2282 int x
, int y
, int width
,
2283 int height
, int shift_by
));
2285 #endif /* HAVE_WINDOW_SYSTEM */
2288 /* The current interface for window-based redisplay. */
2290 extern struct redisplay_interface
*rif
;
2293 /***********************************************************************
2295 ***********************************************************************/
2297 #ifdef HAVE_WINDOW_SYSTEM
2299 /* Structure forward declarations. */
2304 /* Each image format (JPEG, TIFF, ...) supported is described by
2305 a structure of the type below. */
2309 /* A symbol uniquely identifying the image type, .e.g `jpeg'. */
2312 /* Check that SPEC is a valid image specification for the given
2313 image type. Value is non-zero if SPEC is valid. */
2314 int (* valid_p
) P_ ((Lisp_Object spec
));
2316 /* Load IMG which is used on frame F from information contained in
2317 IMG->spec. Value is non-zero if successful. */
2318 int (* load
) P_ ((struct frame
*f
, struct image
*img
));
2320 /* Free resources of image IMG which is used on frame F. */
2321 void (* free
) P_ ((struct frame
*f
, struct image
*img
));
2323 /* Next in list of all supported image types. */
2324 struct image_type
*next
;
2328 /* Structure describing an image. Specific image formats like XBM are
2329 converted into this form, so that display only has to deal with
2330 this type of image. */
2334 /* The time in seconds at which the image was last displayed. Set
2335 in prepare_image_for_display. */
2336 unsigned long timestamp
;
2338 /* Pixmaps of the image. */
2339 Pixmap pixmap
, mask
;
2341 /* Colors allocated for this image, if any. Allocated via xmalloc. */
2342 unsigned long *colors
;
2345 /* A single `background color' for this image, for the use of anyone that
2346 cares about such a thing. Only valid if the `background_valid' field
2347 is true. This should generally be accessed by calling the accessor
2348 macro `IMAGE_BACKGROUND', which will heuristically calculate a value
2350 unsigned long background
;
2352 /* True if this image has a `transparent' background -- that is, is
2353 uses an image mask. The accessor macro for this is
2354 `IMAGE_BACKGROUND_TRANSPARENT'. */
2355 unsigned background_transparent
: 1;
2357 /* True if the `background' and `background_transparent' fields are
2358 valid, respectively. */
2359 unsigned background_valid
: 1, background_transparent_valid
: 1;
2361 /* Width and height of the image. */
2364 /* These values are used for the rectangles displayed for images
2365 that can't be loaded. */
2366 #define DEFAULT_IMAGE_WIDTH 30
2367 #define DEFAULT_IMAGE_HEIGHT 30
2369 /* Percent of image height used as ascent. A value of
2370 CENTERED_IMAGE_ASCENT means draw the image centered on the
2373 #define DEFAULT_IMAGE_ASCENT 50
2374 #define CENTERED_IMAGE_ASCENT -1
2376 /* Lisp specification of this image. */
2379 /* Relief to draw around the image. */
2382 /* Optional margins around the image. This includes the relief. */
2383 int hmargin
, vmargin
;
2385 /* Reference to the type of the image. */
2386 struct image_type
*type
;
2388 /* 1 means that loading the image failed. Don't try again. */
2389 unsigned load_failed_p
;
2391 /* A place for image types to store additional data. The member
2392 data.lisp_val is marked during GC, so it's safe to store Lisp data
2393 there. Image types should free this data when their `free'
2394 function is called. */
2399 Lisp_Object lisp_val
;
2402 /* Hash value of image specification to speed up comparisons. */
2405 /* Image id of this image. */
2408 /* Hash collision chain. */
2409 struct image
*next
, *prev
;
2413 /* Cache of images. Each frame has a cache. X frames with the same
2414 x_display_info share their caches. */
2418 /* Hash table of images. */
2419 struct image
**buckets
;
2421 /* Vector mapping image ids to images. */
2422 struct image
**images
;
2424 /* Allocated size of `images'. */
2427 /* Number of images in the cache. */
2430 /* Reference count (number of frames sharing this cache). */
2435 /* Value is a pointer to the image with id ID on frame F, or null if
2436 no image with that id exists. */
2438 #define IMAGE_FROM_ID(F, ID) \
2439 (((ID) >= 0 && (ID) < (FRAME_X_IMAGE_CACHE (F)->used)) \
2440 ? FRAME_X_IMAGE_CACHE (F)->images[ID] \
2443 /* Size of bucket vector of image caches. Should be prime. */
2445 #define IMAGE_CACHE_BUCKETS_SIZE 1001
2447 #endif /* HAVE_WINDOW_SYSTEM */
2451 /***********************************************************************
2453 ***********************************************************************/
2455 /* Enumeration defining where to find tool-bar item information in
2456 tool-bar items vectors stored with frames. Each tool-bar item
2457 occupies TOOL_BAR_ITEM_NSLOTS elements in such a vector. */
2459 enum tool_bar_item_idx
2461 /* The key of the tool-bar item. Used to remove items when a binding
2462 for `undefined' is found. */
2465 /* Non-nil if item is enabled. */
2466 TOOL_BAR_ITEM_ENABLED_P
,
2468 /* Non-nil if item is selected (pressed). */
2469 TOOL_BAR_ITEM_SELECTED_P
,
2472 TOOL_BAR_ITEM_CAPTION
,
2474 /* Image(s) to display. This is either a single image specification
2475 or a vector of specifications. */
2476 TOOL_BAR_ITEM_IMAGES
,
2479 TOOL_BAR_ITEM_BINDING
,
2481 /* Button type. One of nil, `:radio' or `:toggle'. */
2487 /* Sentinel = number of slots in tool_bar_items occupied by one
2489 TOOL_BAR_ITEM_NSLOTS
2493 /* An enumeration for the different images that can be specified
2494 for a tool-bar item. */
2496 enum tool_bar_item_image
2498 TOOL_BAR_IMAGE_ENABLED_SELECTED
,
2499 TOOL_BAR_IMAGE_ENABLED_DESELECTED
,
2500 TOOL_BAR_IMAGE_DISABLED_SELECTED
,
2501 TOOL_BAR_IMAGE_DISABLED_DESELECTED
2504 /* Margin around tool-bar buttons in pixels. */
2506 extern Lisp_Object Vtool_bar_button_margin
;
2508 /* Thickness of relief to draw around tool-bar buttons. */
2510 extern EMACS_INT tool_bar_button_relief
;
2512 /* Default values of the above variables. */
2514 #define DEFAULT_TOOL_BAR_BUTTON_MARGIN 4
2515 #define DEFAULT_TOOL_BAR_BUTTON_RELIEF 1
2517 /* The height in pixels of the default tool-bar images. */
2519 #define DEFAULT_TOOL_BAR_IMAGE_HEIGHT 24
2522 /***********************************************************************
2523 Terminal Capabilities
2524 ***********************************************************************/
2526 /* Each of these is a bit representing a terminal `capability' (bold,
2527 inverse, etc). They are or'd together to specify the set of
2528 capabilities being queried for when calling `tty_capable_p' (which
2529 returns true if the terminal supports all of them). */
2531 #define TTY_CAP_INVERSE 0x01
2532 #define TTY_CAP_UNDERLINE 0x02
2533 #define TTY_CAP_BOLD 0x04
2534 #define TTY_CAP_DIM 0x08
2535 #define TTY_CAP_BLINK 0x10
2536 #define TTY_CAP_ALT_CHARSET 0x20
2539 /***********************************************************************
2541 ***********************************************************************/
2543 /* Defined in xdisp.c */
2545 struct glyph_row
*row_containing_pos
P_ ((struct window
*, int,
2547 struct glyph_row
*, int));
2548 int string_buffer_position
P_ ((struct window
*, Lisp_Object
, int));
2549 int line_bottom_y
P_ ((struct it
*));
2550 int display_prop_intangible_p
P_ ((Lisp_Object
));
2551 void resize_echo_area_exactly
P_ ((void));
2552 int resize_mini_window
P_ ((struct window
*, int));
2553 int try_window
P_ ((Lisp_Object
, struct text_pos
));
2554 void window_box
P_ ((struct window
*, int, int *, int *, int *, int *));
2555 int window_box_height
P_ ((struct window
*));
2556 int window_text_bottom_y
P_ ((struct window
*));
2557 int window_box_width
P_ ((struct window
*, int));
2558 int window_box_left
P_ ((struct window
*, int));
2559 int window_box_left_offset
P_ ((struct window
*, int));
2560 int window_box_right
P_ ((struct window
*, int));
2561 int window_box_right_offset
P_ ((struct window
*, int));
2562 void window_box_edges
P_ ((struct window
*, int, int *, int *, int *, int *));
2563 int estimate_mode_line_height
P_ ((struct frame
*, enum face_id
));
2564 void pixel_to_glyph_coords
P_ ((struct frame
*, int, int, int *, int *,
2565 NativeRectangle
*, int));
2566 int glyph_to_pixel_coords
P_ ((struct window
*, int, int, int *, int *));
2567 void mark_window_display_accurate
P_ ((Lisp_Object
, int));
2568 void redisplay_preserve_echo_area
P_ ((int));
2569 void set_cursor_from_row
P_ ((struct window
*, struct glyph_row
*,
2570 struct glyph_matrix
*, int, int, int, int));
2571 void init_iterator
P_ ((struct it
*, struct window
*, int,
2572 int, struct glyph_row
*, enum face_id
));
2573 void init_iterator_to_row_start
P_ ((struct it
*, struct window
*,
2574 struct glyph_row
*));
2575 int get_next_display_element
P_ ((struct it
*));
2576 void set_iterator_to_next
P_ ((struct it
*, int));
2577 void produce_glyphs
P_ ((struct it
*));
2578 void produce_special_glyphs
P_ ((struct it
*, enum display_element_type
));
2579 void start_display
P_ ((struct it
*, struct window
*, struct text_pos
));
2580 void move_it_to
P_ ((struct it
*, int, int, int, int, int));
2581 void move_it_vertically
P_ ((struct it
*, int));
2582 void move_it_vertically_backward
P_ ((struct it
*, int));
2583 void move_it_by_lines
P_ ((struct it
*, int, int));
2584 void move_it_past_eol
P_ ((struct it
*));
2585 int in_display_vector_p
P_ ((struct it
*));
2586 int frame_mode_line_height
P_ ((struct frame
*));
2587 void highlight_trailing_whitespace
P_ ((struct frame
*, struct glyph_row
*));
2588 extern Lisp_Object Qtool_bar
;
2589 extern Lisp_Object Vshow_trailing_whitespace
;
2590 extern int mode_line_in_non_selected_windows
;
2591 extern int redisplaying_p
;
2592 extern void add_to_log
P_ ((char *, Lisp_Object
, Lisp_Object
));
2593 extern int help_echo_showing_p
;
2594 extern int current_mode_line_height
, current_header_line_height
;
2595 extern Lisp_Object help_echo_string
, help_echo_window
;
2596 extern Lisp_Object help_echo_object
, previous_help_echo_string
;
2597 extern int help_echo_pos
;
2598 extern struct frame
*last_mouse_frame
;
2599 extern int last_tool_bar_item
;
2600 extern int mouse_autoselect_window
;
2601 extern void reseat_at_previous_visible_line_start
P_ ((struct it
*));
2603 extern int calc_pixel_width_or_height
P_ ((double *, struct it
*, Lisp_Object
,
2604 /* XFontStruct */ void *, int, int *));
2606 #ifdef HAVE_WINDOW_SYSTEM
2609 extern void dump_glyph_string
P_ ((struct glyph_string
*));
2612 extern void x_get_glyph_overhangs
P_ ((struct glyph
*, struct frame
*,
2614 extern void x_produce_glyphs
P_ ((struct it
*));
2616 extern void x_write_glyphs
P_ ((struct glyph
*, int));
2617 extern void x_insert_glyphs
P_ ((struct glyph
*, int len
));
2618 extern void x_clear_end_of_line
P_ ((int));
2620 extern int x_stretch_cursor_p
;
2621 extern struct cursor_pos output_cursor
;
2623 extern void x_fix_overlapping_area
P_ ((struct window
*, struct glyph_row
*,
2624 enum glyph_row_area
));
2625 extern void draw_phys_cursor_glyph
P_ ((struct window
*,
2627 enum draw_glyphs_face
));
2628 extern void erase_phys_cursor
P_ ((struct window
*));
2629 extern void display_and_set_cursor
P_ ((struct window
*,
2630 int, int, int, int, int));
2632 extern void set_output_cursor
P_ ((struct cursor_pos
*));
2633 extern void x_cursor_to
P_ ((int, int, int, int));
2635 extern void x_update_cursor
P_ ((struct frame
*, int));
2636 extern void x_clear_cursor
P_ ((struct window
*));
2637 extern void x_draw_vertical_border
P_ ((struct window
*w
));
2639 extern void frame_to_window_pixel_xy
P_ ((struct window
*, int *, int *));
2640 extern void get_glyph_string_clip_rect
P_ ((struct glyph_string
*,
2641 NativeRectangle
*nr
));
2642 extern Lisp_Object find_hot_spot
P_ ((Lisp_Object
, int, int));
2643 extern void note_mouse_highlight
P_ ((struct frame
*, int, int));
2644 extern void x_clear_window_mouse_face
P_ ((struct window
*));
2645 extern void cancel_mouse_face
P_ ((struct frame
*));
2647 extern void handle_tool_bar_click
P_ ((struct frame
*,
2648 int, int, int, unsigned int));
2650 /* msdos.c defines its own versions of these functions. */
2651 extern int clear_mouse_face
P_ ((Display_Info
*));
2652 extern void show_mouse_face
P_ ((Display_Info
*, enum draw_glyphs_face
));
2653 extern int cursor_in_mouse_face_p
P_ ((struct window
*w
));
2655 extern void expose_frame
P_ ((struct frame
*, int, int, int, int));
2656 extern int x_intersect_rectangles
P_ ((XRectangle
*, XRectangle
*,
2660 /* Defined in fringe.c */
2662 int lookup_fringe_bitmap (Lisp_Object
);
2663 void draw_fringe_bitmap
P_ ((struct window
*, struct glyph_row
*, int));
2664 void draw_row_fringe_bitmaps
P_ ((struct window
*, struct glyph_row
*));
2665 int draw_window_fringes
P_ ((struct window
*, int));
2666 int update_window_fringes
P_ ((struct window
*, int));
2667 void compute_fringe_widths
P_ ((struct frame
*, int));
2670 void w32_init_fringe
P_ ((void));
2671 void w32_reset_fringes
P_ ((void));
2674 /* Defined in image.c */
2676 #ifdef HAVE_WINDOW_SYSTEM
2678 extern int x_bitmap_height
P_ ((struct frame
*, int));
2679 extern int x_bitmap_width
P_ ((struct frame
*, int));
2680 extern int x_bitmap_pixmap
P_ ((struct frame
*, int));
2681 extern void x_reference_bitmap
P_ ((struct frame
*, int));
2682 extern int x_create_bitmap_from_data
P_ ((struct frame
*, char *,
2683 unsigned int, unsigned int));
2684 extern int x_create_bitmap_from_file
P_ ((struct frame
*, Lisp_Object
));
2685 #ifndef x_destroy_bitmap
2686 extern void x_destroy_bitmap
P_ ((struct frame
*, int));
2688 extern void x_destroy_all_bitmaps
P_ ((Display_Info
*));
2689 extern int x_create_bitmap_mask
P_ ((struct frame
* , int));
2690 extern Lisp_Object x_find_image_file
P_ ((Lisp_Object
));
2692 void x_kill_gs_process
P_ ((Pixmap
, struct frame
*));
2693 struct image_cache
*make_image_cache
P_ ((void));
2694 void free_image_cache
P_ ((struct frame
*));
2695 void clear_image_cache
P_ ((struct frame
*, int));
2696 void forall_images_in_image_cache
P_ ((struct frame
*,
2697 void (*) P_ ((struct image
*))));
2698 int valid_image_p
P_ ((Lisp_Object
));
2699 void prepare_image_for_display
P_ ((struct frame
*, struct image
*));
2700 int lookup_image
P_ ((struct frame
*, Lisp_Object
));
2702 unsigned long image_background
P_ ((struct image
*, struct frame
*,
2703 XImagePtr_or_DC ximg
));
2704 int image_background_transparent
P_ ((struct image
*, struct frame
*,
2705 XImagePtr_or_DC mask
));
2707 int image_ascent
P_ ((struct image
*, struct face
*, struct glyph_slice
*));
2711 /* Defined in sysdep.c */
2713 void get_frame_size
P_ ((int *, int *));
2714 void request_sigio
P_ ((void));
2715 void unrequest_sigio
P_ ((void));
2716 int tabs_safe_p
P_ ((void));
2717 void init_baud_rate
P_ ((void));
2718 void init_sigio
P_ ((int));
2720 /* Defined in xfaces.c */
2722 #ifdef HAVE_X_WINDOWS
2723 void x_free_colors
P_ ((struct frame
*, unsigned long *, int));
2726 void update_face_from_frame_parameter
P_ ((struct frame
*, Lisp_Object
,
2728 Lisp_Object tty_color_name
P_ ((struct frame
*, int));
2729 void clear_face_cache
P_ ((int));
2730 unsigned long load_color
P_ ((struct frame
*, struct face
*, Lisp_Object
,
2731 enum lface_attribute_index
));
2732 void unload_color
P_ ((struct frame
*, unsigned long));
2733 char *choose_face_font
P_ ((struct frame
*, Lisp_Object
*, Lisp_Object
,
2735 int ascii_face_of_lisp_face
P_ ((struct frame
*, int));
2736 void prepare_face_for_display
P_ ((struct frame
*, struct face
*));
2737 int xstricmp
P_ ((const unsigned char *, const unsigned char *));
2738 int lookup_face
P_ ((struct frame
*, Lisp_Object
*));
2739 int lookup_non_ascii_face
P_ ((struct frame
*, int, struct face
*));
2740 int lookup_named_face
P_ ((struct frame
*, Lisp_Object
));
2741 int smaller_face
P_ ((struct frame
*, int, int));
2742 int face_with_height
P_ ((struct frame
*, int, int));
2743 int lookup_derived_face
P_ ((struct frame
*, Lisp_Object
, int));
2744 void init_frame_faces
P_ ((struct frame
*));
2745 void free_frame_faces
P_ ((struct frame
*));
2746 void recompute_basic_faces
P_ ((struct frame
*));
2747 int face_at_buffer_position
P_ ((struct window
*, int, int, int, int *,
2749 int face_at_string_position
P_ ((struct window
*, Lisp_Object
, int, int, int,
2750 int, int *, enum face_id
, int));
2751 int compute_char_face
P_ ((struct frame
*, int, Lisp_Object
));
2752 void free_all_realized_faces
P_ ((Lisp_Object
));
2753 void free_realized_face
P_ ((struct frame
*, struct face
*));
2754 extern Lisp_Object Qforeground_color
, Qbackground_color
;
2755 extern char unspecified_fg
[], unspecified_bg
[];
2756 extern Lisp_Object split_font_name_into_vector
P_ ((Lisp_Object
));
2757 extern Lisp_Object build_font_name_from_vector
P_ ((Lisp_Object
));
2759 /* Defined in xfns.c */
2761 #ifdef HAVE_X_WINDOWS
2762 void gamma_correct
P_ ((struct frame
*, XColor
*));
2765 void gamma_correct
P_ ((struct frame
*, COLORREF
*));
2768 void gamma_correct
P_ ((struct frame
*, unsigned long *));
2771 #ifdef HAVE_WINDOW_SYSTEM
2773 int x_screen_planes
P_ ((struct frame
*));
2774 void x_implicitly_set_name
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
2776 extern Lisp_Object tip_frame
;
2777 extern Window tip_window
;
2778 EXFUN (Fx_show_tip
, 6);
2779 EXFUN (Fx_hide_tip
, 0);
2780 extern void start_hourglass
P_ ((void));
2781 extern void cancel_hourglass
P_ ((void));
2782 extern int display_hourglass_p
;
2784 /* Returns the background color of IMG, calculating one heuristically if
2785 necessary. If non-zero, XIMG is an existing XImage object to use for
2788 #define IMAGE_BACKGROUND(img, f, ximg) \
2789 ((img)->background_valid \
2790 ? (img)->background \
2791 : image_background (img, f, ximg))
2793 /* Returns true if IMG has a `transparent' background, using heuristics
2794 to decide if necessary. If non-zero, MASK is an existing XImage
2795 object to use for the heuristic. */
2797 #define IMAGE_BACKGROUND_TRANSPARENT(img, f, mask) \
2798 ((img)->background_transparent_valid \
2799 ? (img)->background_transparent \
2800 : image_background_transparent (img, f, mask))
2802 #endif /* HAVE_WINDOW_SYSTEM */
2805 /* Defined in xmenu.c */
2807 int popup_activated
P_ ((void));
2809 /* Defined in dispnew.c */
2811 extern int inverse_video
;
2812 extern int required_matrix_width
P_ ((struct window
*));
2813 extern int required_matrix_height
P_ ((struct window
*));
2814 extern Lisp_Object buffer_posn_from_coords
P_ ((struct window
*,
2816 struct display_pos
*,
2818 int *, int *, int *, int *));
2819 extern Lisp_Object mode_line_string
P_ ((struct window
*, enum window_part
,
2820 int *, int *, int *,
2822 int *, int *, int *, int *));
2823 extern Lisp_Object marginal_area_string
P_ ((struct window
*, enum window_part
,
2824 int *, int *, int *,
2826 int *, int *, int *, int *));
2827 extern void redraw_frame
P_ ((struct frame
*));
2828 extern void redraw_garbaged_frames
P_ ((void));
2829 extern void cancel_line
P_ ((int, struct frame
*));
2830 extern void init_desired_glyphs
P_ ((struct frame
*));
2831 extern int scroll_frame_lines
P_ ((struct frame
*, int, int, int, int));
2832 extern int direct_output_for_insert
P_ ((int));
2833 extern int direct_output_forward_char
P_ ((int));
2834 extern int update_frame
P_ ((struct frame
*, int, int));
2835 extern int scrolling
P_ ((struct frame
*));
2836 extern void bitch_at_user
P_ ((void));
2837 void adjust_glyphs
P_ ((struct frame
*));
2838 void free_glyphs
P_ ((struct frame
*));
2839 void free_window_matrices
P_ ((struct window
*));
2840 void check_glyph_memory
P_ ((void));
2841 void mirrored_line_dance
P_ ((struct glyph_matrix
*, int, int, int *, char *));
2842 void clear_glyph_matrix
P_ ((struct glyph_matrix
*));
2843 void clear_current_matrices
P_ ((struct frame
*f
));
2844 void clear_desired_matrices
P_ ((struct frame
*));
2845 void shift_glyph_matrix
P_ ((struct window
*, struct glyph_matrix
*,
2847 void rotate_matrix
P_ ((struct glyph_matrix
*, int, int, int));
2848 void increment_matrix_positions
P_ ((struct glyph_matrix
*,
2849 int, int, int, int));
2850 void blank_row
P_ ((struct window
*, struct glyph_row
*, int));
2851 void increment_row_positions
P_ ((struct glyph_row
*, int, int));
2852 void enable_glyph_matrix_rows
P_ ((struct glyph_matrix
*, int, int, int));
2853 void clear_glyph_row
P_ ((struct glyph_row
*));
2854 void prepare_desired_row
P_ ((struct glyph_row
*));
2855 int line_hash_code
P_ ((struct glyph_row
*));
2856 void set_window_update_flags
P_ ((struct window
*, int));
2857 void write_glyphs
P_ ((struct glyph
*, int));
2858 void insert_glyphs
P_ ((struct glyph
*, int));
2859 void redraw_frame
P_ ((struct frame
*));
2860 void redraw_garbaged_frames
P_ ((void));
2861 int scroll_cost
P_ ((struct frame
*, int, int, int));
2862 int direct_output_for_insert
P_ ((int));
2863 int direct_output_forward_char
P_ ((int));
2864 int update_frame
P_ ((struct frame
*, int, int));
2865 void update_single_window
P_ ((struct window
*, int));
2866 int scrolling
P_ ((struct frame
*));
2867 void do_pending_window_change
P_ ((int));
2868 void change_frame_size
P_ ((struct frame
*, int, int, int, int, int));
2869 void bitch_at_user
P_ ((void));
2870 Lisp_Object sit_for
P_ ((int, int, int, int, int));
2871 void init_display
P_ ((void));
2872 void syms_of_display
P_ ((void));
2873 extern Lisp_Object Qredisplay_dont_pause
;
2875 /* Defined in term.c */
2877 extern void ring_bell
P_ ((void));
2878 extern void set_terminal_modes
P_ ((void));
2879 extern void reset_terminal_modes
P_ ((void));
2880 extern void update_begin
P_ ((struct frame
*));
2881 extern void update_end
P_ ((struct frame
*));
2882 extern void set_terminal_window
P_ ((int));
2883 extern void set_scroll_region
P_ ((int, int));
2884 extern void turn_off_insert
P_ ((void));
2885 extern void turn_off_highlight
P_ ((void));
2886 extern void background_highlight
P_ ((void));
2887 extern void clear_frame
P_ ((void));
2888 extern void clear_end_of_line
P_ ((int));
2889 extern void clear_end_of_line_raw
P_ ((int));
2890 extern void delete_glyphs
P_ ((int));
2891 extern void ins_del_lines
P_ ((int, int));
2892 extern int string_cost
P_ ((char *));
2893 extern int per_line_cost
P_ ((char *));
2894 extern void calculate_costs
P_ ((struct frame
*));
2895 extern void set_tty_color_mode
P_ ((struct frame
*, Lisp_Object
));
2896 extern void tty_setup_colors
P_ ((int));
2897 extern void term_init
P_ ((char *));
2898 extern void fatal
P_ ((/* char *, ... */));
2899 void cursor_to
P_ ((int, int));
2900 extern int tty_capable_p
P_ ((struct frame
*, unsigned, unsigned long, unsigned long));
2902 /* Defined in scroll.c */
2904 extern int scrolling_max_lines_saved
P_ ((int, int, int *, int *, int *));
2905 extern int scroll_cost
P_ ((struct frame
*, int, int, int));
2906 extern void do_line_insertion_deletion_costs
P_ ((struct frame
*, char *,
2907 char *, char *, char *,
2908 char *, char *, int));
2909 void scrolling_1
P_ ((struct frame
*, int, int, int, int *, int *, int *,
2912 /* Defined in frame.c */
2914 #ifdef HAVE_WINDOW_SYSTEM
2916 /* Types we might convert a resource string into. */
2926 extern Lisp_Object x_get_arg
P_ ((Display_Info
*, Lisp_Object
,
2927 Lisp_Object
, char *, char *class,
2928 enum resource_types
));
2929 extern Lisp_Object x_frame_get_arg
P_ ((struct frame
*, Lisp_Object
,
2930 Lisp_Object
, char *, char *,
2931 enum resource_types
));
2932 extern Lisp_Object x_frame_get_and_record_arg
P_ ((
2933 struct frame
*, Lisp_Object
,
2934 Lisp_Object
, char *, char *,
2935 enum resource_types
));
2936 extern Lisp_Object x_default_parameter
P_ ((struct frame
*, Lisp_Object
,
2937 Lisp_Object
, Lisp_Object
,
2939 enum resource_types
));
2941 #endif /* HAVE_WINDOW_SYSTEM */
2943 #endif /* not DISPEXTERN_H_INCLUDED */
2945 /* arch-tag: c65c475f-1c1e-4534-8795-990b8509fd65
2946 (do not change this comment) */