1 /* Interface definitions for display code.
2 Copyright (C) 1985, 1993, 1994, 1997, 1998, 1999, 2000, 2001, 2002, 2003
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>. */
24 #ifndef DISPEXTERN_H_INCLUDED
25 #define DISPEXTERN_H_INCLUDED
31 #include <X11/Intrinsic.h>
32 #endif /* USE_X_TOOLKIT */
34 #else /* !HAVE_X_WINDOWS */
36 /* X-related stuff used by non-X gui code. */
40 unsigned short red
, green
, blue
;
45 #endif /* HAVE_X_WINDOWS */
52 typedef struct x_display_info Display_Info
;
53 #define NativeRectangle XRectangle
58 typedef struct w32_display_info Display_Info
;
63 typedef struct mac_display_info Display_Info
;
65 /* Include Carbon.h to define Cursor and Rect. */
72 /* Macros max and min defined in lisp.h conflict with those in
73 precompiled header Carbon.h. */
77 #include <Carbon/Carbon.h>
79 #define Z (current_buffer->text->z)
81 #define free unexec_free
83 #define malloc unexec_malloc
85 #define realloc unexec_realloc
87 #define min(a, b) ((a) < (b) ? (a) : (b))
89 #define max(a, b) ((a) > (b) ? (a) : (b))
91 #define init_process emacs_init_process
96 #ifndef NativeRectangle
97 #define NativeRectangle int
101 /* Structure forward declarations. Some are here because function
102 prototypes below reference structure types before their definition
103 in this file. Some are here because not every file including
104 dispextern.h also includes frame.h and windows.h. */
114 /* Values returned from coordinates_in_window. */
129 /* Number of bits allocated to store fringe bitmap numbers. */
130 #define FRINGE_ID_BITS 8
134 /***********************************************************************
136 ***********************************************************************/
138 /* If GLYPH_DEBUG is non-zero, additional checks are activated. Turn
139 it off by defining the macro GLYPH_DEBUG to zero. */
142 #define GLYPH_DEBUG 0
145 /* Macros to include code only if GLYPH_DEBUG != 0. */
148 #define IF_DEBUG(X) X
149 #define xassert(X) do {if (!(X)) abort ();} while (0)
151 #define IF_DEBUG(X) (void) 0
152 #define xassert(X) (void) 0
155 /* Macro for displaying traces of redisplay. If Emacs was compiled
156 with GLYPH_DEBUG != 0, the variable trace_redisplay_p can be set to
157 a non-zero value in debugging sessions to activate traces. */
161 extern int trace_redisplay_p
;
165 if (trace_redisplay_p) \
170 #else /* GLYPH_DEBUG == 0 */
172 #define TRACE(X) (void) 0
174 #endif /* GLYPH_DEBUG == 0 */
178 /***********************************************************************
180 ***********************************************************************/
182 /* Starting with Emacs 20.3, characters from strings and buffers have
183 both a character and a byte position associated with them. The
184 following structure holds such a pair of positions. */
188 /* Character position. */
191 /* Corresponding byte position. */
195 /* Access character and byte position of POS in a functional form. */
197 #define BYTEPOS(POS) (POS).bytepos
198 #define CHARPOS(POS) (POS).charpos
200 /* Set character position of POS to CHARPOS, byte position to BYTEPOS. */
202 #define SET_TEXT_POS(POS, CHARPOS, BYTEPOS) \
203 ((POS).charpos = (CHARPOS), (POS).bytepos = BYTEPOS)
205 /* Increment text position POS. */
207 #define INC_TEXT_POS(POS, MULTIBYTE_P) \
212 INC_POS ((POS).bytepos); \
218 /* Decrement text position POS. */
220 #define DEC_TEXT_POS(POS, MULTIBYTE_P) \
225 DEC_POS ((POS).bytepos); \
231 /* Set text position POS from marker MARKER. */
233 #define SET_TEXT_POS_FROM_MARKER(POS, MARKER) \
234 (CHARPOS (POS) = marker_position ((MARKER)), \
235 BYTEPOS (POS) = marker_byte_position ((MARKER)))
237 /* Set marker MARKER from text position POS. */
239 #define SET_MARKER_FROM_TEXT_POS(MARKER, POS) \
240 set_marker_both ((MARKER), Qnil, CHARPOS ((POS)), BYTEPOS ((POS)))
242 /* Value is non-zero if character and byte positions of POS1 and POS2
245 #define TEXT_POS_EQUAL_P(POS1, POS2) \
246 ((POS1).charpos == (POS2).charpos \
247 && (POS1).bytepos == (POS2).bytepos)
249 /* When rendering glyphs, redisplay scans string or buffer text,
250 overlay strings in that text, and does display table or control
251 character translations. The following structure captures a
252 position taking all this into account. */
256 /* Buffer or string position. */
259 /* If this is a position in an overlay string, overlay_string_index
260 is the index of that overlay string in the sequence of overlay
261 strings at `pos' in the order redisplay processes them. A value
262 < 0 means that this is not a position in an overlay string. */
263 int overlay_string_index
;
265 /* If this is a position in an overlay string, string_pos is the
266 position within that string. */
267 struct text_pos string_pos
;
269 /* If the character at the position above is a control character or
270 has a display table entry, dpvec_index is an index in the display
271 table or control character translation of that character. A
272 value < 0 means this is not a position in such a translation. */
278 /***********************************************************************
280 ***********************************************************************/
282 /* Enumeration of glyph types. Glyph structures contain a type field
283 containing one of the enumerators defined here. */
287 /* Glyph describes a character. */
290 /* Glyph describes a composition sequence. */
293 /* Glyph describes an image. */
296 /* Glyph is a space of fractional width and/or height. */
303 Be extra careful when changing this structure! Esp. make sure that
304 functions producing glyphs, like append_glyph, fill ALL of the
305 glyph structure, and that GLYPH_EQUAL_P compares all
306 display-relevant members of glyphs (not to imply that these are the
307 only things to check when you add a member). */
311 /* Position from which this glyph was drawn. If `object' below is a
312 Lisp string, this is a position in that string. If it is a
313 buffer, this is a position in that buffer. A value of -1
314 together with a null object means glyph is a truncation glyph at
315 the start of a row. */
318 /* Lisp object source of this glyph. Currently either a buffer or
319 a string, if the glyph was produced from characters which came from
320 a buffer or a string; or 0 if the glyph was inserted by redisplay
321 for its own purposes such as padding. */
324 /* Width in pixels. */
327 /* Ascent and descent in pixels. */
328 short ascent
, descent
;
330 /* Vertical offset. If < 0, the glyph is displayed raised, if > 0
331 the glyph is displayed lowered. */
334 /* Which kind of glyph this is---character, image etc. Value
335 should be an enumerator of type enum glyph_type. */
338 /* 1 means this glyph was produced from multibyte text. Zero
339 means it was produced from unibyte text, i.e. charsets aren't
340 applicable, and encoding is not performed. */
341 unsigned multibyte_p
: 1;
343 /* Non-zero means draw a box line at the left or right side of this
344 glyph. This is part of the implementation of the face attribute
346 unsigned left_box_line_p
: 1;
347 unsigned right_box_line_p
: 1;
349 /* Non-zero means this glyph's physical ascent or descent is greater
350 than its logical ascent/descent, i.e. it may potentially overlap
351 glyphs above or below it. */
352 unsigned overlaps_vertically_p
: 1;
354 /* 1 means glyph is a padding glyph. Padding glyphs are used for
355 characters whose visual shape consists of more than one glyph
356 (e.g. Asian characters). All but the first glyph of such a glyph
357 sequence have the padding_p flag set. Only used for terminal
358 frames, and there only to minimize code changes. A better way
359 would probably be to use the width field of glyphs to express
361 unsigned padding_p
: 1;
363 /* 1 means the actual glyph is not available, draw a box instead.
364 This can happen when a font couldn't be loaded, or a character
365 doesn't have a glyph in a font. */
366 unsigned glyph_not_available_p
: 1;
368 #define FACE_ID_BITS 21
370 /* Face of the glyph. */
371 unsigned face_id
: FACE_ID_BITS
;
373 /* Type of font used to display the character glyph. May be used to
374 determine which set of functions to use to obtain font metrics
375 for the glyph. On W32, value should be an enumerator of the type
376 w32_char_font_type. Otherwise it equals FONT_TYPE_UNKNOWN. */
377 unsigned font_type
: 3;
379 /* A union of sub-structures for different glyph types. */
382 /* Character code for character glyphs (type == CHAR_GLYPH). */
385 /* Composition ID for composition glyphs (type == COMPOSITION_GLYPH) */
388 /* Image ID for image glyphs (type == IMAGE_GLYPH). */
391 /* Sub-structure for type == STRETCH_GLYPH. */
394 /* The height of the glyph. */
395 unsigned height
: 16;
397 /* The ascent of the glyph. */
398 unsigned ascent
: 16;
402 /* Used to compare all bit-fields above in one step. */
408 /* Default value of the glyph font_type field. */
410 #define FONT_TYPE_UNKNOWN 0
412 /* Is GLYPH a space? */
414 #define CHAR_GLYPH_SPACE_P(GLYPH) \
415 (GLYPH_FROM_CHAR_GLYPH ((GLYPH)) == SPACEGLYPH)
417 /* Are glyphs *X and *Y displayed equal? */
419 #define GLYPH_EQUAL_P(X, Y) \
420 ((X)->type == (Y)->type \
421 && (X)->u.val == (Y)->u.val \
422 && (X)->face_id == (Y)->face_id \
423 && (X)->padding_p == (Y)->padding_p \
424 && (X)->left_box_line_p == (Y)->left_box_line_p \
425 && (X)->right_box_line_p == (Y)->right_box_line_p \
426 && (X)->voffset == (Y)->voffset \
427 && (X)->pixel_width == (Y)->pixel_width)
429 /* Are character codes, faces, padding_ps of glyphs *X and *Y equal? */
431 #define GLYPH_CHAR_AND_FACE_EQUAL_P(X, Y) \
432 ((X)->u.ch == (Y)->u.ch \
433 && (X)->face_id == (Y)->face_id \
434 && (X)->padding_p == (Y)->padding_p)
436 /* Fill a character glyph GLYPH. CODE, FACE_ID, PADDING_P correspond
437 to the bits defined for the typedef `GLYPH' in lisp.h. */
439 #define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P) \
442 (GLYPH).u.ch = (CODE); \
443 (GLYPH).face_id = (FACE_ID); \
444 (GLYPH).padding_p = (PADDING_P); \
448 /* Fill a character type glyph GLYPH from a glyph typedef FROM as
449 defined in lisp.h. */
451 #define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM) \
452 SET_CHAR_GLYPH ((GLYPH), \
453 FAST_GLYPH_CHAR ((FROM)), \
454 FAST_GLYPH_FACE ((FROM)), \
457 /* Construct a glyph code from a character glyph GLYPH. If the
458 character is multibyte, return -1 as we can't use glyph table for a
459 multibyte character. */
461 #define GLYPH_FROM_CHAR_GLYPH(GLYPH) \
462 ((GLYPH).u.ch < 256 \
463 ? ((GLYPH).u.ch | ((GLYPH).face_id << CHARACTERBITS)) \
466 /* Is GLYPH a padding glyph? */
468 #define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p
473 /***********************************************************************
475 ***********************************************************************/
479 Glyph memory for frame-based redisplay is allocated from the heap
480 in one vector kept in a glyph pool structure which is stored with
481 the frame. The size of the vector is made large enough to cover
482 all windows on the frame.
484 Both frame and window glyph matrices reference memory from a glyph
485 pool in frame-based redisplay.
487 In window-based redisplay, no glyphs pools exist; windows allocate
488 and free their glyph memory themselves. */
492 /* Vector of glyphs allocated from the heap. */
493 struct glyph
*glyphs
;
495 /* Allocated size of `glyphs'. */
498 /* Number of rows and columns in a matrix. */
504 /***********************************************************************
506 ***********************************************************************/
510 Three kinds of glyph matrices exist:
512 1. Frame glyph matrices. These are used for terminal frames whose
513 redisplay needs a view of the whole screen due to limited terminal
514 capabilities. Frame matrices are used only in the update phase
515 of redisplay. They are built in update_frame and not used after
516 the update has been performed.
518 2. Window glyph matrices on frames having frame glyph matrices.
519 Such matrices are sub-matrices of their corresponding frame matrix,
520 i.e. frame glyph matrices and window glyph matrices share the same
521 glyph memory which is allocated in form of a glyph_pool structure.
522 Glyph rows in such a window matrix are slices of frame matrix rows.
524 2. Free-standing window glyph matrices managing their own glyph
525 storage. This form is used in window-based redisplay which
526 includes variable width and height fonts etc.
528 The size of a window's row vector depends on the height of fonts
529 defined on its frame. It is chosen so that the vector is large
530 enough to describe all lines in a window when it is displayed in
531 the smallest possible character size. When new fonts are loaded,
532 or window sizes change, the row vector is adjusted accordingly. */
536 /* The pool from which glyph memory is allocated, if any. This is
537 null for frame matrices and for window matrices managing their
539 struct glyph_pool
*pool
;
541 /* Vector of glyph row structures. The row at nrows - 1 is reserved
542 for the mode line. */
543 struct glyph_row
*rows
;
545 /* Number of elements allocated for the vector rows above. */
548 /* The number of rows used by the window if all lines were displayed
549 with the smallest possible character height. */
552 /* Origin within the frame matrix if this is a window matrix on a
553 frame having a frame matrix. Both values are zero for
554 window-based redisplay. */
555 int matrix_x
, matrix_y
;
557 /* Width and height of the matrix in columns and rows. */
558 int matrix_w
, matrix_h
;
560 /* If this structure describes a window matrix of window W,
561 window_left_col is the value of W->left_col, window_top_line the
562 value of W->top_line, window_height and window_width are width and
563 height of W, as returned by window_box, and window_vscroll is the
564 value of W->vscroll at the time the matrix was last adjusted.
565 Only set for window-based redisplay. */
566 int window_left_col
, window_top_line
;
567 int window_height
, window_width
;
570 /* Number of glyphs reserved for left and right marginal areas when
571 the matrix was last adjusted. */
572 int left_margin_glyphs
, right_margin_glyphs
;
574 /* Flag indicating that scrolling should not be tried in
575 update_window. This flag is set by functions like try_window_id
576 which do their own scrolling. */
577 unsigned no_scrolling_p
: 1;
579 /* Non-zero means window displayed in this matrix has a top mode
581 unsigned header_line_p
: 1;
584 /* A string identifying the method used to display the matrix. */
588 /* The buffer this matrix displays. Set in
589 mark_window_display_accurate_1. */
590 struct buffer
*buffer
;
592 /* Values of BEGV and ZV as of last redisplay. Set in
593 mark_window_display_accurate_1. */
598 /* Check that glyph pointers stored in glyph rows of MATRIX are okay.
599 This aborts if any pointer is found twice. */
602 void check_matrix_pointer_lossage
P_ ((struct glyph_matrix
*));
603 #define CHECK_MATRIX(MATRIX) check_matrix_pointer_lossage ((MATRIX))
605 #define CHECK_MATRIX(MATRIX) (void) 0
610 /***********************************************************************
612 ***********************************************************************/
614 /* Area in window glyph matrix. If values are added or removed, the
615 function mark_object in alloc.c has to be changed. */
626 /* Rows of glyphs in a windows or frame glyph matrix.
628 Each row is partitioned into three areas. The start and end of
629 each area is recorded in a pointer as shown below.
631 +--------------------+-------------+---------------------+
632 | left margin area | text area | right margin area |
633 +--------------------+-------------+---------------------+
635 glyphs[LEFT_MARGIN_AREA] glyphs[RIGHT_MARGIN_AREA]
640 Rows in frame matrices reference glyph memory allocated in a frame
641 glyph pool (see the description of struct glyph_pool). Rows in
642 window matrices on frames having frame matrices reference slices of
643 the glyphs of corresponding rows in the frame matrix.
645 Rows in window matrices on frames having no frame matrices point to
646 glyphs allocated from the heap via xmalloc;
647 glyphs[LEFT_MARGIN_AREA] is the start address of the allocated
648 glyph structure array. */
652 /* Pointers to beginnings of areas. The end of an area A is found at
653 A + 1 in the vector. The last element of the vector is the end
656 Kludge alert: Even if used[TEXT_AREA] == 0, glyphs[TEXT_AREA][0]'s
657 position field is used. It is -1 if this row does not correspond
658 to any text; it is some buffer position if the row corresponds to
659 an empty display line that displays a line end. This is what old
660 redisplay used to do. (Except in code for terminal frames, this
661 kludge is no longer used, I believe. --gerd).
663 See also start, end, displays_text_p and ends_at_zv_p for cleaner
664 ways to do it. The special meaning of positions 0 and -1 will be
665 removed some day, so don't use it in new code. */
666 struct glyph
*glyphs
[1 + LAST_AREA
];
668 /* Number of glyphs actually filled in areas. */
669 short used
[LAST_AREA
];
671 /* Window-relative x and y-position of the top-left corner of this
672 row. If y < 0, this means that abs (y) pixels of the row are
673 invisible because it is partially visible at the top of a window.
674 If x < 0, this means that abs (x) pixels of the first glyph of
675 the text area of the row are invisible because the glyph is
676 partially visible. */
679 /* Width of the row in pixels without taking face extension at the
680 end of the row into account, and without counting truncation
681 and continuation glyphs at the end of a row on ttys. */
684 /* Logical ascent/height of this line. The value of ascent is zero
685 and height is 1 on terminal frames. */
688 /* Physical ascent/height of this line. If max_ascent > ascent,
689 this line overlaps the line above it on the display. Otherwise,
690 if max_height > height, this line overlaps the line beneath it. */
691 int phys_ascent
, phys_height
;
693 /* Portion of row that is visible. Partially visible rows may be
694 found at the top and bottom of a window. This is 1 for tty
695 frames. It may be < 0 in case of completely invisible rows. */
698 /* Hash code. This hash code is available as soon as the row
699 is constructed, i.e. after a call to display_line. */
702 /* First position in this row. This is the text position, including
703 overlay position information etc, where the display of this row
704 started, and can thus be less the position of the first glyph
705 (e.g. due to invisible text or horizontal scrolling). */
706 struct display_pos start
;
708 /* Text position at the end of this row. This is the position after
709 the last glyph on this row. It can be greater than the last
710 glyph position + 1, due to truncation, invisible text etc. In an
711 up-to-date display, this should always be equal to the start
712 position of the next row. */
713 struct display_pos end
;
715 /* Left fringe bitmap number (enum fringe_bitmap_type). */
716 unsigned left_user_fringe_bitmap
: FRINGE_ID_BITS
;
718 /* Face of the left fringe glyph. */
719 unsigned left_user_fringe_face_id
: FACE_ID_BITS
;
721 /* Right fringe bitmap number (enum fringe_bitmap_type). */
722 unsigned right_user_fringe_bitmap
: FRINGE_ID_BITS
;
724 /* Face of the right fringe glyph. */
725 unsigned right_user_fringe_face_id
: FACE_ID_BITS
;
727 /* Left fringe bitmap number (enum fringe_bitmap_type). */
728 unsigned left_fringe_bitmap
: FRINGE_ID_BITS
;
730 /* Face of the left fringe glyph. */
731 unsigned left_fringe_face_id
: FACE_ID_BITS
;
733 /* Right fringe bitmap number (enum fringe_bitmap_type). */
734 unsigned right_fringe_bitmap
: FRINGE_ID_BITS
;
736 /* Face of the right fringe glyph. */
737 unsigned right_fringe_face_id
: FACE_ID_BITS
;
739 /* 1 means that we must draw the bitmaps of this row. */
740 unsigned redraw_fringe_bitmaps_p
: 1;
742 /* In a desired matrix, 1 means that this row must be updated. In a
743 current matrix, 0 means that the row has been invalidated, i.e.
744 the row's contents do not agree with what is visible on the
746 unsigned enabled_p
: 1;
748 /* 1 means row displays a text line that is truncated on the left or
750 unsigned truncated_on_left_p
: 1;
751 unsigned truncated_on_right_p
: 1;
753 /* 1 means the overlay arrow is on this line. */
754 unsigned overlay_arrow_p
: 1;
756 /* 1 means that this row displays a continued line, i.e. it has a
757 continuation mark at the right side. */
758 unsigned continued_p
: 1;
760 /* 0 means that this row does not contain any text, i.e. it is
761 a blank line at the window and buffer end. */
762 unsigned displays_text_p
: 1;
764 /* 1 means that this line ends at ZV. */
765 unsigned ends_at_zv_p
: 1;
767 /* 1 means the face of the last glyph in the text area is drawn to
768 the right end of the window. This flag is used in
769 update_text_area to optimize clearing to the end of the area. */
770 unsigned fill_line_p
: 1;
772 /* Non-zero means display a bitmap on X frames indicating that this
773 line contains no text and ends in ZV. */
774 unsigned indicate_empty_line_p
: 1;
776 /* 1 means this row contains glyphs that overlap each other because
777 of lbearing or rbearing. */
778 unsigned contains_overlapping_glyphs_p
: 1;
780 /* 1 means this row is as wide as the window it is displayed in, including
781 scroll bars, fringes, and internal borders. This also
782 implies that the row doesn't have marginal areas. */
783 unsigned full_width_p
: 1;
785 /* Non-zero means row is a mode or header-line. */
786 unsigned mode_line_p
: 1;
788 /* 1 in a current row means this row is overlapped by another row. */
789 unsigned overlapped_p
: 1;
791 /* 1 means this line ends in the middle of a character consisting
792 of more than one glyph. Some glyphs have been put in this row,
793 the rest are put in rows below this one. */
794 unsigned ends_in_middle_of_char_p
: 1;
796 /* 1 means this line starts in the middle of a character consisting
797 of more than one glyph. Some glyphs have been put in the
798 previous row, the rest are put in this row. */
799 unsigned starts_in_middle_of_char_p
: 1;
801 /* 1 in a current row means this row overlaps others. */
802 unsigned overlapping_p
: 1;
804 /* 1 means some glyphs in this row are displayed in mouse-face. */
805 unsigned mouse_face_p
: 1;
807 /* 1 means this row was ended by a newline from a string. */
808 unsigned ends_in_newline_from_string_p
: 1;
810 /* 1 means this row width is exactly the width of the window, and the
811 final newline character is hidden in the right fringe. */
812 unsigned exact_window_width_line_p
: 1;
814 /* 1 means this row currently shows the cursor in the right fringe. */
815 unsigned cursor_in_fringe_p
: 1;
817 /* Non-zero means display a bitmap on X frames indicating that this
818 the first line of the buffer. */
819 unsigned indicate_bob_p
: 1;
821 /* Non-zero means display a bitmap on X frames indicating that this
822 the top line of the window, but not start of the buffer. */
823 unsigned indicate_top_line_p
: 1;
825 /* Non-zero means display a bitmap on X frames indicating that this
826 the last line of the buffer. */
827 unsigned indicate_eob_p
: 1;
829 /* Non-zero means display a bitmap on X frames indicating that this
830 the bottom line of the window, but not end of the buffer. */
831 unsigned indicate_bottom_line_p
: 1;
833 /* Continuation lines width at the start of the row. */
834 int continuation_lines_width
;
838 /* Get a pointer to row number ROW in matrix MATRIX. If GLYPH_DEBUG
839 is defined to a non-zero value, the function matrix_row checks that
840 we don't try to access rows that are out of bounds. */
843 struct glyph_row
*matrix_row
P_ ((struct glyph_matrix
*, int));
844 #define MATRIX_ROW(MATRIX, ROW) matrix_row ((MATRIX), (ROW))
846 #define MATRIX_ROW(MATRIX, ROW) ((MATRIX)->rows + (ROW))
849 /* Return a pointer to the row reserved for the mode line in MATRIX.
850 Row MATRIX->nrows - 1 is always reserved for the mode line. */
852 #define MATRIX_MODE_LINE_ROW(MATRIX) \
853 ((MATRIX)->rows + (MATRIX)->nrows - 1)
855 /* Return a pointer to the row reserved for the header line in MATRIX.
856 This is always the first row in MATRIX because that's the only
857 way that works in frame-based redisplay. */
859 #define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows
861 /* Return a pointer to first row in MATRIX used for text display. */
863 #define MATRIX_FIRST_TEXT_ROW(MATRIX) \
864 ((MATRIX)->rows->mode_line_p ? (MATRIX)->rows + 1 : (MATRIX)->rows)
866 /* Return a pointer to the first glyph in the text area of a row.
867 MATRIX is the glyph matrix accessed, and ROW is the row index in
870 #define MATRIX_ROW_GLYPH_START(MATRIX, ROW) \
871 (MATRIX_ROW ((MATRIX), (ROW))->glyphs[TEXT_AREA])
873 /* Return the number of used glyphs in the text area of a row. */
875 #define MATRIX_ROW_USED(MATRIX, ROW) \
876 (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA])
878 /* Return the character/ byte position at which the display of ROW
881 #define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->start.pos.charpos)
882 #define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->start.pos.bytepos)
884 /* Return the character/ byte position at which ROW ends. */
886 #define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->end.pos.charpos)
887 #define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->end.pos.bytepos)
889 /* Return the vertical position of ROW in MATRIX. */
891 #define MATRIX_ROW_VPOS(ROW, MATRIX) ((ROW) - (MATRIX)->rows)
893 /* Return the last glyph row + 1 in MATRIX on window W reserved for
894 text. If W has a mode line, the last row in the matrix is reserved
897 #define MATRIX_BOTTOM_TEXT_ROW(MATRIX, W) \
900 - (WINDOW_WANTS_MODELINE_P ((W)) ? 1 : 0))
902 /* Non-zero if the face of the last glyph in ROW's text area has
903 to be drawn to the end of the text area. */
905 #define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)
907 /* Set and query the enabled_p flag of glyph row ROW in MATRIX. */
909 #define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
910 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0)
912 #define MATRIX_ROW_ENABLED_P(MATRIX, ROW) \
913 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p)
915 /* Non-zero if ROW displays text. Value is non-zero if the row is
916 blank but displays a line end. */
918 #define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)
920 /* Non-zero if ROW is not completely visible in window W. */
922 #define MATRIX_ROW_PARTIALLY_VISIBLE_P(ROW) \
923 ((ROW)->height != (ROW)->visible_height)
925 /* Non-zero if ROW is partially visible at the top of window W. */
927 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW) \
928 (MATRIX_ROW_PARTIALLY_VISIBLE_P ((ROW)) \
929 && (ROW)->y < WINDOW_HEADER_LINE_HEIGHT ((W)))
931 /* Non-zero if ROW is partially visible at the bottom of window W. */
933 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW) \
934 (MATRIX_ROW_PARTIALLY_VISIBLE_P ((ROW)) \
935 && (ROW)->y + (ROW)->height > WINDOW_BOX_HEIGHT_NO_MODE_LINE ((W)))
937 /* Return the bottom Y + 1 of ROW. */
939 #define MATRIX_ROW_BOTTOM_Y(ROW) ((ROW)->y + (ROW)->height)
941 /* Is ROW the last visible one in the display described by the
942 iterator structure pointed to by IT?. */
944 #define MATRIX_ROW_LAST_VISIBLE_P(ROW, IT) \
945 (MATRIX_ROW_BOTTOM_Y ((ROW)) >= (IT)->last_visible_y)
947 /* Non-zero if ROW displays a continuation line. */
949 #define MATRIX_ROW_CONTINUATION_LINE_P(ROW) \
950 ((ROW)->continuation_lines_width > 0)
952 /* Non-zero if ROW ends in the middle of a character. This is the
953 case for continued lines showing only part of a display table entry
954 or a control char, or an overlay string. */
956 #define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW) \
957 ((ROW)->end.dpvec_index >= 0 \
958 || (ROW)->end.overlay_string_index >= 0 \
959 || (ROW)->ends_in_middle_of_char_p)
961 /* Non-zero if ROW ends in the middle of an overlay string. */
963 #define MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P(ROW) \
964 ((ROW)->end.overlay_string_index >= 0)
966 /* Non-zero if ROW starts in the middle of a character. See above. */
968 #define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW) \
969 ((ROW)->start.dpvec_index >= 0 \
970 || (ROW)->starts_in_middle_of_char_p \
971 || ((ROW)->start.overlay_string_index >= 0 \
972 && (ROW)->start.string_pos.charpos > 0))
974 /* Non-zero means ROW overlaps its predecessor. */
976 #define MATRIX_ROW_OVERLAPS_PRED_P(ROW) \
977 ((ROW)->phys_ascent > (ROW)->ascent)
979 /* Non-zero means ROW overlaps its successor. */
981 #define MATRIX_ROW_OVERLAPS_SUCC_P(ROW) \
982 ((ROW)->phys_height - (ROW)->phys_ascent \
983 > (ROW)->height - (ROW)->ascent)
985 /* Non-zero means that fonts have been loaded since the last glyph
986 matrix adjustments. The function redisplay_internal adjusts glyph
987 matrices when this flag is non-zero. */
989 extern int fonts_changed_p
;
991 /* A glyph for a space. */
993 extern struct glyph space_glyph
;
995 /* Frame being updated by update_window/update_frame. */
997 extern struct frame
*updating_frame
;
999 /* Window being updated by update_window. This is non-null as long as
1000 update_window has not finished, and null otherwise. It's role is
1001 analogous to updating_frame. */
1003 extern struct window
*updated_window
;
1005 /* Glyph row and area updated by update_window_line. */
1007 extern struct glyph_row
*updated_row
;
1008 extern int updated_area
;
1010 /* Non-zero means reading single-character input with prompt so put
1011 cursor on mini-buffer after the prompt. Positive means at end of
1012 text in echo area; negative means at beginning of line. */
1014 extern int cursor_in_echo_area
;
1016 /* Non-zero means last display completed. Zero means it was
1019 extern int display_completed
;
1021 /* Non-zero means redisplay has been performed directly (see also
1022 direct_output_for_insert and direct_output_forward_char), so that
1023 no further updating has to be performed. The function
1024 redisplay_internal checks this flag, and does nothing but reset it
1025 to zero if it is non-zero. */
1027 extern int redisplay_performed_directly_p
;
1029 /* A temporary storage area, including a row of glyphs. Initialized
1030 in xdisp.c. Used for various purposes, as an example see
1031 direct_output_for_insert. */
1033 extern struct glyph_row scratch_glyph_row
;
1037 /************************************************************************
1039 ************************************************************************/
1041 /* Enumeration for overriding/changing the face to use for drawing
1042 glyphs in draw_glyphs. */
1044 enum draw_glyphs_face
1054 #ifdef HAVE_WINDOW_SYSTEM
1056 /* A sequence of glyphs to be drawn in the same face. */
1060 /* X-origin of the string. */
1063 /* Y-origin and y-position of the base line of this string. */
1066 /* The width of the string, not including a face extension. */
1069 /* The width of the string, including a face extension. */
1070 int background_width
;
1072 /* The height of this string. This is the height of the line this
1073 string is drawn in, and can be different from the height of the
1074 font the string is drawn in. */
1077 /* Number of pixels this string overwrites in front of its x-origin.
1078 This number is zero if the string has an lbearing >= 0; it is
1079 -lbearing, if the string has an lbearing < 0. */
1082 /* Number of pixels this string overwrites past its right-most
1083 nominal x-position, i.e. x + width. Zero if the string's
1084 rbearing is <= its nominal width, rbearing - width otherwise. */
1087 /* The frame on which the glyph string is drawn. */
1090 /* The window on which the glyph string is drawn. */
1093 /* X display and window for convenience. */
1097 /* The glyph row for which this string was built. It determines the
1098 y-origin and height of the string. */
1099 struct glyph_row
*row
;
1101 /* The area within row. */
1102 enum glyph_row_area area
;
1104 /* Characters to be drawn, and number of characters. */
1108 /* A face-override for drawing cursors, mouse face and similar. */
1109 enum draw_glyphs_face hl
;
1111 /* Face in which this string is to be drawn. */
1114 /* Font in which this string is to be drawn. */
1117 /* Font info for this string. */
1118 struct font_info
*font_info
;
1120 /* Non-null means this string describes (part of) a composition.
1121 All characters from char2b are drawn composed. */
1122 struct composition
*cmp
;
1124 /* Index of this glyph string's first character in the glyph
1125 definition of CMP. If this is zero, this glyph string describes
1126 the first character of a composition. */
1129 /* 1 means this glyph strings face has to be drawn to the right end
1130 of the window's drawing area. */
1131 unsigned extends_to_end_of_line_p
: 1;
1133 /* 1 means the background of this string has been drawn. */
1134 unsigned background_filled_p
: 1;
1136 /* 1 means glyph string must be drawn with 16-bit functions. */
1137 unsigned two_byte_p
: 1;
1139 /* 1 means that the original font determined for drawing this glyph
1140 string could not be loaded. The member `font' has been set to
1141 the frame's default font in this case. */
1142 unsigned font_not_found_p
: 1;
1144 /* 1 means that the face in which this glyph string is drawn has a
1146 unsigned stippled_p
: 1;
1148 /* 1 means only the foreground of this glyph string must be drawn,
1149 and we should use the physical height of the line this glyph
1150 string appears in as clip rect. */
1151 unsigned for_overlaps_p
: 1;
1153 /* The GC to use for drawing this glyph string. */
1154 #if defined(HAVE_X_WINDOWS) || defined(HAVE_CARBON)
1157 #if defined(HAVE_NTGUI)
1162 /* A pointer to the first glyph in the string. This glyph
1163 corresponds to char2b[0]. Needed to draw rectangles if
1164 font_not_found_p is 1. */
1165 struct glyph
*first_glyph
;
1167 /* Image, if any. */
1170 struct glyph_string
*next
, *prev
;
1173 #endif /* HAVE_WINDOW_SYSTEM */
1176 /************************************************************************
1178 ************************************************************************/
1180 /* Return the height of the mode line in glyph matrix MATRIX, or zero
1181 if not known. This macro is called under circumstances where
1182 MATRIX might not have been allocated yet. */
1184 #define MATRIX_MODE_LINE_HEIGHT(MATRIX) \
1185 ((MATRIX) && (MATRIX)->rows \
1186 ? MATRIX_MODE_LINE_ROW (MATRIX)->height \
1189 /* Return the height of the header line in glyph matrix MATRIX, or zero
1190 if not known. This macro is called under circumstances where
1191 MATRIX might not have been allocated yet. */
1193 #define MATRIX_HEADER_LINE_HEIGHT(MATRIX) \
1194 ((MATRIX) && (MATRIX)->rows \
1195 ? MATRIX_HEADER_LINE_ROW (MATRIX)->height \
1198 /* Return the desired face id for the mode line of a window, depending
1199 on whether the window is selected or not, or if the window is the
1200 scrolling window for the currently active minibuffer window.
1202 Due to the way display_mode_lines manipulates with the contents of
1203 selected_window, this macro needs three arguments: SELW which is
1204 compared against the current value of selected_window, MBW which is
1205 compared against minibuf_window (if SELW doesn't match), and SCRW
1206 which is compared against minibuf_selected_window (if MBW matches). */
1208 #define CURRENT_MODE_LINE_FACE_ID_3(SELW, MBW, SCRW) \
1209 ((!mode_line_in_non_selected_windows \
1210 || (SELW) == XWINDOW (selected_window) \
1211 || (minibuf_level > 0 \
1212 && !NILP (minibuf_selected_window) \
1213 && (MBW) == XWINDOW (minibuf_window) \
1214 && (SCRW) == XWINDOW (minibuf_selected_window))) \
1215 ? MODE_LINE_FACE_ID \
1216 : MODE_LINE_INACTIVE_FACE_ID)
1219 /* Return the desired face id for the mode line of window W. */
1221 #define CURRENT_MODE_LINE_FACE_ID(W) \
1222 (CURRENT_MODE_LINE_FACE_ID_3((W), XWINDOW (selected_window), (W)))
1224 /* Return the current height of the mode line of window W. If not
1225 known from current_mode_line_height, look at W's current glyph
1226 matrix, or return a default based on the height of the font of the
1227 face `mode-line'. */
1229 #define CURRENT_MODE_LINE_HEIGHT(W) \
1230 (current_mode_line_height >= 0 \
1231 ? current_mode_line_height \
1232 : (MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1233 ? MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1234 : estimate_mode_line_height (XFRAME ((W)->frame), \
1235 CURRENT_MODE_LINE_FACE_ID (W))))
1237 /* Return the current height of the header line of window W. If not
1238 known from current_header_line_height, look at W's current glyph
1239 matrix, or return an estimation based on the height of the font of
1240 the face `header-line'. */
1242 #define CURRENT_HEADER_LINE_HEIGHT(W) \
1243 (current_header_line_height >= 0 \
1244 ? current_header_line_height \
1245 : (MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1246 ? MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1247 : estimate_mode_line_height (XFRAME ((W)->frame), \
1248 HEADER_LINE_FACE_ID)))
1250 /* Return the height of the desired mode line of window W. */
1252 #define DESIRED_MODE_LINE_HEIGHT(W) \
1253 MATRIX_MODE_LINE_HEIGHT ((W)->desired_matrix)
1255 /* Return the height of the desired header line of window W. */
1257 #define DESIRED_HEADER_LINE_HEIGHT(W) \
1258 MATRIX_HEADER_LINE_HEIGHT ((W)->desired_matrix)
1260 /* Value is non-zero if window W wants a mode line. */
1262 #define WINDOW_WANTS_MODELINE_P(W) \
1263 (!MINI_WINDOW_P ((W)) \
1264 && !(W)->pseudo_window_p \
1265 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1266 && BUFFERP ((W)->buffer) \
1267 && !NILP (XBUFFER ((W)->buffer)->mode_line_format) \
1268 && WINDOW_TOTAL_LINES (W) > 1)
1270 /* Value is non-zero if window W wants a header line. */
1272 #define WINDOW_WANTS_HEADER_LINE_P(W) \
1273 (!MINI_WINDOW_P ((W)) \
1274 && !(W)->pseudo_window_p \
1275 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1276 && BUFFERP ((W)->buffer) \
1277 && !NILP (XBUFFER ((W)->buffer)->header_line_format) \
1278 && WINDOW_TOTAL_LINES (W) > 1 + !NILP (XBUFFER ((W)->buffer)->mode_line_format))
1281 /* Return proper value to be used as baseline offset of font that has
1282 ASCENT and DESCENT to draw characters by the font at the vertical
1283 center of the line of frame F.
1285 Here, our task is to find the value of BOFF in the following figure;
1287 -------------------------+-----------+-
1288 -+-+---------+-+ | |
1290 | | | | F_ASCENT F_HEIGHT
1293 | | |-|-+------+-----------|------- baseline
1295 | |---------|-+-+ | |
1297 -+-+---------+-+ F_DESCENT |
1298 -------------------------+-----------+-
1300 -BOFF + DESCENT + (F_HEIGHT - HEIGHT) / 2 = F_DESCENT
1301 BOFF = DESCENT + (F_HEIGHT - HEIGHT) / 2 - F_DESCENT
1302 DESCENT = FONT->descent
1303 HEIGHT = FONT_HEIGHT (FONT)
1304 F_DESCENT = (FRAME_FONT (F)->descent
1305 - F->device->output_data.x->baseline_offset)
1306 F_HEIGHT = FRAME_LINE_HEIGHT (F)
1309 #define VCENTER_BASELINE_OFFSET(FONT, F) \
1310 (FONT_DESCENT (FONT) \
1311 + (FRAME_LINE_HEIGHT ((F)) - FONT_HEIGHT ((FONT)) \
1312 + (FRAME_LINE_HEIGHT ((F)) > FONT_HEIGHT ((FONT)))) / 2 \
1313 - (FONT_DESCENT (FRAME_FONT (F)) - FRAME_BASELINE_OFFSET (F)))
1316 /***********************************************************************
1318 ***********************************************************************/
1320 /* Indices of face attributes in Lisp face vectors. Slot zero is the
1323 enum lface_attribute_index
1325 LFACE_FAMILY_INDEX
= 1,
1330 LFACE_UNDERLINE_INDEX
,
1331 LFACE_INVERSE_INDEX
,
1332 LFACE_FOREGROUND_INDEX
,
1333 LFACE_BACKGROUND_INDEX
,
1334 LFACE_STIPPLE_INDEX
,
1335 LFACE_OVERLINE_INDEX
,
1336 LFACE_STRIKE_THROUGH_INDEX
,
1339 LFACE_INHERIT_INDEX
,
1340 LFACE_AVGWIDTH_INDEX
,
1345 /* Box types of faces. */
1349 /* No box around text. */
1352 /* Simple box of specified width and color. Default width is 1, and
1353 default color is the foreground color of the face. */
1356 /* Boxes with 3D shadows. Color equals the background color of the
1357 face. Width is specified. */
1363 /* Structure describing a realized face.
1365 For each Lisp face, 0..N realized faces can exist for different
1366 frames and different charsets. Realized faces are built from Lisp
1367 faces and text properties/overlays by merging faces and adding
1368 unspecified attributes from the `default' face. */
1372 /* The id of this face. The id equals the index of this face in the
1373 vector faces_by_id of its face cache. */
1376 #ifdef HAVE_WINDOW_SYSTEM
1378 /* If non-zero, this is a GC that we can use without modification for
1379 drawing the characters in this face. */
1382 /* Font used for this face, or null if the font could not be loaded
1383 for some reason. This points to a `font' slot of a struct
1384 font_info, and we should not call XFreeFont on it because the
1385 font may still be used somewhere else. */
1388 /* Background stipple or bitmap used for this face. This is
1389 an id as returned from load_pixmap. */
1392 #else /* not HAVE_WINDOW_SYSTEM */
1397 #endif /* not HAVE_WINDOW_SYSTEM */
1399 /* Pixel value of foreground color for X frames. Color index
1401 unsigned long foreground
;
1403 /* Pixel value or color index of background color. */
1404 unsigned long background
;
1406 /* Pixel value or color index of underline color. */
1407 unsigned long underline_color
;
1409 /* Pixel value or color index of overlined, strike-through, or box
1411 unsigned long overline_color
;
1412 unsigned long strike_through_color
;
1413 unsigned long box_color
;
1415 /* The font's name. This points to a `name' of a font_info, and it
1416 must not be freed. */
1419 /* Font info ID for this face's font. An ID is stored here because
1420 pointers to font_info structures may change. The reason is that
1421 they are pointers into a font table vector that is itself
1425 /* Fontset ID if this face uses a fontset, or -1. This is only >= 0
1426 if the face was realized for a composition sequence.
1427 Otherwise, a specific font is loaded from the set of fonts
1428 specified by the fontset given by the family attribute of the face. */
1431 /* Pixmap width and height. */
1432 unsigned int pixmap_w
, pixmap_h
;
1434 /* Non-zero means characters in this face have a box that thickness
1435 around them. If it is negative, the absolute value indicates the
1436 thickness, and the horizontal lines of box (top and bottom) are
1437 drawn inside of characters glyph area. The vertical lines of box
1438 (left and right) are drawn as the same way as the case that this
1439 value is positive. */
1442 /* Type of box drawn. A value of FACE_NO_BOX means no box is drawn
1443 around text in this face. A value of FACE_SIMPLE_BOX means a box
1444 of width box_line_width is drawn in color box_color. A value of
1445 FACE_RAISED_BOX or FACE_SUNKEN_BOX means a 3D box is drawn with
1446 shadow colors derived from the background color of the face. */
1447 enum face_box_type box
;
1449 /* If `box' above specifies a 3D type, 1 means use box_color for
1451 unsigned use_box_color_for_shadows_p
: 1;
1453 /* The Lisp face attributes this face realizes. All attributes
1454 in this vector are non-nil. */
1455 Lisp_Object lface
[LFACE_VECTOR_SIZE
];
1457 /* The hash value of this face. */
1460 /* The charset for which this face was realized if it was realized
1461 for use in multibyte text. If fontset >= 0, this is the charset
1462 of the first character of the composition sequence. A value of
1463 charset < 0 means the face was realized for use in unibyte text
1464 where the idea of Emacs charsets isn't applicable. */
1467 /* Non-zero if text in this face should be underlined, overlined,
1468 strike-through or have a box drawn around it. */
1469 unsigned underline_p
: 1;
1470 unsigned overline_p
: 1;
1471 unsigned strike_through_p
: 1;
1473 /* 1 means that the colors specified for this face could not be
1474 loaded, and were replaced by default colors, so they shouldn't be
1476 unsigned foreground_defaulted_p
: 1;
1477 unsigned background_defaulted_p
: 1;
1479 /* 1 means that either no color is specified for underlining or that
1480 the specified color couldn't be loaded. Use the foreground
1481 color when drawing in that case. */
1482 unsigned underline_defaulted_p
: 1;
1484 /* 1 means that either no color is specified for the corresponding
1485 attribute or that the specified color couldn't be loaded.
1486 Use the foreground color when drawing in that case. */
1487 unsigned overline_color_defaulted_p
: 1;
1488 unsigned strike_through_color_defaulted_p
: 1;
1489 unsigned box_color_defaulted_p
: 1;
1491 /* TTY appearances. Blinking is not yet implemented. Colors are
1492 found in `lface' with empty color string meaning the default
1493 color of the TTY. */
1494 unsigned tty_bold_p
: 1;
1495 unsigned tty_dim_p
: 1;
1496 unsigned tty_underline_p
: 1;
1497 unsigned tty_alt_charset_p
: 1;
1498 unsigned tty_reverse_p
: 1;
1499 unsigned tty_blinking_p
: 1;
1501 /* 1 means that colors of this face may not be freed because they
1502 have been copied bitwise from a base face (see
1504 unsigned colors_copied_bitwise_p
: 1;
1506 /* If non-zero, use overstrike (to simulate bold-face). */
1507 unsigned overstrike
: 1;
1509 /* Next and previous face in hash collision list of face cache. */
1510 struct face
*next
, *prev
;
1512 /* If this face is for ASCII characters, this points this face
1513 itself. Otherwise, this points a face for ASCII characters. */
1514 struct face
*ascii_face
;
1518 /* Color index indicating that face uses a terminal's default color. */
1520 #define FACE_TTY_DEFAULT_COLOR ((unsigned long) -1)
1522 /* Color index indicating that face uses an unknown foreground color. */
1524 #define FACE_TTY_DEFAULT_FG_COLOR ((unsigned long) -2)
1526 /* Color index indicating that face uses an unknown background color. */
1528 #define FACE_TTY_DEFAULT_BG_COLOR ((unsigned long) -3)
1530 /* Non-zero if FACE was realized for unibyte use. */
1532 #define FACE_UNIBYTE_P(FACE) ((FACE)->charset < 0)
1535 /* IDs of important faces known by the C face code. These are the IDs
1536 of the faces for CHARSET_ASCII. */
1542 MODE_LINE_INACTIVE_FACE_ID
,
1545 HEADER_LINE_FACE_ID
,
1551 BASIC_FACE_ID_SENTINEL
1554 #define MAX_FACE_ID ((1 << FACE_ID_BITS) - 1)
1556 /* A cache of realized faces. Each frame has its own cache because
1557 Emacs allows different frame-local face definitions. */
1561 /* Hash table of cached realized faces. */
1562 struct face
**buckets
;
1564 /* Back-pointer to the frame this cache belongs to. */
1567 /* A vector of faces so that faces can be referenced by an ID. */
1568 struct face
**faces_by_id
;
1570 /* The allocated size, and number of used slots of faces_by_id. */
1573 /* Flag indicating that attributes of the `menu' face have been
1575 unsigned menu_face_changed_p
: 1;
1579 /* Prepare face FACE for use on frame F. This must be called before
1580 using X resources of FACE. */
1582 #define PREPARE_FACE_FOR_DISPLAY(F, FACE) \
1583 if ((FACE)->gc == 0) \
1584 prepare_face_for_display ((F), (FACE)); \
1588 /* Return a pointer to the face with ID on frame F, or null if such a
1589 face doesn't exist. */
1591 #define FACE_FROM_ID(F, ID) \
1592 (((unsigned) (ID) < FRAME_FACE_CACHE (F)->used) \
1593 ? FRAME_FACE_CACHE (F)->faces_by_id[ID] \
1596 #ifdef HAVE_WINDOW_SYSTEM
1598 /* Non-zero if FACE is suitable for displaying character CHAR. */
1600 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) \
1601 (SINGLE_BYTE_CHAR_P (CHAR) \
1602 ? (FACE) == (FACE)->ascii_face \
1603 : face_suitable_for_char_p ((FACE), (CHAR)))
1605 /* Return the id of the realized face on frame F that is like the face
1606 with id ID but is suitable for displaying character CHAR.
1607 This macro is only meaningful for multibyte character CHAR. */
1609 #define FACE_FOR_CHAR(F, FACE, CHAR) \
1610 (SINGLE_BYTE_CHAR_P (CHAR) \
1611 ? (FACE)->ascii_face->id \
1612 : face_for_char ((F), (FACE), (CHAR)))
1614 #else /* not HAVE_WINDOW_SYSTEM */
1616 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) 1
1617 #define FACE_FOR_CHAR(F, FACE, CHAR) ((FACE)->id)
1619 #endif /* not HAVE_WINDOW_SYSTEM */
1621 /* Non-zero means face attributes have been changed since the last
1622 redisplay. Used in redisplay_internal. */
1624 extern int face_change_count
;
1629 /***********************************************************************
1631 ***********************************************************************/
1633 /* Structure used to describe where and how to draw a fringe bitmap.
1634 WHICH is the fringe bitmap to draw. WD and H is the (adjusted)
1635 width and height of the bitmap, DH is the height adjustment (if
1636 bitmap is periodic). X and Y are frame coordinates of the area to
1637 display the bitmap, DY is relative offset of the bitmap into that
1638 area. BX, NX, BY, NY specifies the area to clear if the bitmap
1639 does not fill the entire area. FACE is the fringe face. */
1641 struct draw_fringe_bitmap_params
1643 int which
; /* enum fringe_bitmap_type */
1644 unsigned short *bits
;
1648 unsigned cursor_p
: 1;
1649 unsigned overlay_p
: 1;
1653 #define MAX_FRINGE_BITMAPS (1<<FRINGE_ID_BITS)
1656 /***********************************************************************
1658 ***********************************************************************/
1660 /* Iteration over things to display in current_buffer or in a string.
1662 The iterator handles:
1664 1. Overlay strings (after-string, before-string).
1666 3. Invisible text properties.
1667 4. Selective display.
1668 5. Translation of characters via display tables.
1669 6. Translation of control characters to the forms `\003' or `^C'.
1670 7. `glyph' and `space-width' properties.
1672 Iterators are initialized by calling init_iterator or one of the
1673 equivalent functions below. A call to get_next_display_element
1674 loads the iterator structure with information about what next to
1675 display. A call to set_iterator_to_next increments the iterator's
1678 Characters from overlay strings, display table entries or control
1679 character translations are returned one at a time. For example, if
1680 we have a text of `a\x01' where `a' has a display table definition
1681 of `cd' and the control character is displayed with a leading
1682 arrow, then the iterator will return:
1684 Call Return Source Call next
1685 -----------------------------------------------------------------
1686 next c display table move
1687 next d display table move
1688 next ^ control char move
1689 next A control char move
1691 The same mechanism is also used to return characters for ellipses
1692 displayed at the end of invisible text.
1694 CAVEAT: Under some circumstances, move_.* functions can be called
1695 asynchronously, e.g. when computing a buffer position from an x and
1696 y pixel position. This means that these functions and functions
1697 called from them SHOULD NOT USE xmalloc and alike. See also the
1698 comment at the start of xdisp.c. */
1700 /* Enumeration describing what kind of display element an iterator is
1701 loaded with after a call to get_next_display_element. */
1703 enum display_element_type
1705 /* A normal character. */
1708 /* A composition sequence. */
1714 /* A flexible width and height space. */
1717 /* End of buffer or string. */
1720 /* Truncation glyphs. Never returned by get_next_display_element.
1721 Used to get display information about truncation glyphs via
1725 /* Continuation glyphs. See the comment for IT_TRUNCATION. */
1730 /* An enumerator for each text property that has a meaning for display
1739 COMPOSITION_PROP_IDX
,
1741 /* Not a property. Used to indicate changes in overlays. */
1751 /* The window in which we iterate over current_buffer (or a string). */
1755 /* The window's frame. */
1758 /* Function to call to load this structure with the next display
1760 int (* method
) P_ ((struct it
*it
));
1762 /* The next position at which to check for face changes, invisible
1763 text, overlay strings, end of text etc., which see. */
1766 /* Maximum string or buffer position + 1. ZV when iterating over
1770 /* C string to iterate over. Non-null means get characters from
1771 this string, otherwise characters are read from current_buffer
1775 /* Number of characters in the string (s, or it->string) we iterate
1779 /* Start and end of a visible region; -1 if the region is not
1780 visible in the window. */
1781 int region_beg_charpos
, region_end_charpos
;
1783 /* Position at which redisplay end trigger functions should be run. */
1784 int redisplay_end_trigger_charpos
;
1786 /* 1 means multibyte characters are enabled. */
1787 unsigned multibyte_p
: 1;
1789 /* 1 means window has a mode line at its top. */
1790 unsigned header_line_p
: 1;
1792 /* 1 means `string' is the value of a `display' property.
1793 Don't handle some `display' properties in these strings. */
1794 unsigned string_from_display_prop_p
: 1;
1796 /* Display table in effect or null for none. */
1797 struct Lisp_Char_Table
*dp
;
1799 /* Current display table vector to return characters from and its
1800 end. dpvec null means we are not returning characters from a
1801 display table entry; current.dpvec_index gives the current index
1802 into dpvec. This same mechanism is also used to return
1803 characters from translated control characters, i.e. `\003' or
1805 Lisp_Object
*dpvec
, *dpend
;
1807 /* Length in bytes of the char that filled dpvec. A value of zero
1808 means that no such character is involved. */
1811 /* Face id of the iterator saved in case a glyph from dpvec contains
1812 a face. The face is restored when all glyphs from dpvec have
1816 /* Vector of glyphs for control character translation. The pointer
1817 dpvec is set to ctl_chars when a control character is translated.
1818 This vector is also used for incomplete multibyte character
1819 translation (e.g \222\244). Such a character is at most 4 bytes,
1820 thus we need at most 16 bytes here. */
1821 Lisp_Object ctl_chars
[16];
1823 /* Initial buffer or string position of the iterator, before skipping
1824 over display properties and invisible text. */
1825 struct display_pos start
;
1827 /* Current buffer or string position of the iterator, including
1828 position in overlay strings etc. */
1829 struct display_pos current
;
1831 /* Vector of overlays to process. Overlay strings are processed
1832 OVERLAY_STRING_CHUNK_SIZE at a time. */
1833 #define OVERLAY_STRING_CHUNK_SIZE 3
1834 Lisp_Object overlay_strings
[OVERLAY_STRING_CHUNK_SIZE
];
1836 /* Total number of overlay strings to process. This can be >
1837 OVERLAY_STRING_CHUNK_SIZE. */
1838 int n_overlay_strings
;
1840 /* If non-nil, a Lisp string being processed. If
1841 current.overlay_string_index >= 0, this is an overlay string from
1845 /* Stack of saved values. New entries are pushed when we begin to
1846 process an overlay string or a string from a `glyph' property.
1847 Entries are popped when we return to deliver display elements
1848 from what we previously had. */
1849 struct iterator_stack_entry
1854 struct display_pos pos
;
1857 enum glyph_row_area area
;
1858 unsigned multibyte_p
: 1;
1859 unsigned string_from_display_prop_p
: 1;
1860 unsigned display_ellipsis_p
: 1;
1861 Lisp_Object space_width
;
1863 Lisp_Object font_height
;
1867 /* Stack pointer. */
1870 /* Setting of buffer-local variable selective-display-ellipsis. */
1871 unsigned selective_display_ellipsis_p
: 1;
1873 /* 1 means control characters are translated into the form `^C'
1874 where the `^' can be replaced by a display table entry. */
1875 unsigned ctl_arrow_p
: 1;
1877 /* -1 means selective display hides everything between a \r and the
1878 next newline; > 0 means hide lines indented more than that value. */
1881 /* An enumeration describing what the next display element is
1882 after a call to get_next_display_element. */
1883 enum display_element_type what
;
1888 /* Non-zero means that the current face has a box. */
1889 unsigned face_box_p
: 1;
1891 /* Non-null means that the current character is the first in a run
1892 of characters with box face. */
1893 unsigned start_of_box_run_p
: 1;
1895 /* Non-zero means that the current character is the last in a run
1896 of characters with box face. */
1897 unsigned end_of_box_run_p
: 1;
1899 /* 1 means overlay strings at end_charpos have been processed. */
1900 unsigned overlay_strings_at_end_processed_p
: 1;
1902 /* 1 means the actual glyph is not available in the current
1904 unsigned glyph_not_available_p
: 1;
1906 /* 1 means the next line in display_line continues a character
1907 consisting of more than one glyph, and some glyphs of this
1908 character have been put on the previous line. */
1909 unsigned starts_in_middle_of_char_p
: 1;
1911 /* If 1, saved_face_id contains the id of the face in front of text
1912 skipped due to selective display. */
1913 unsigned face_before_selective_p
: 1;
1915 /* The ID of the default face to use. One of DEFAULT_FACE_ID,
1916 MODE_LINE_FACE_ID, etc, depending on what we are displaying. */
1919 /* If what == IT_CHARACTER, character and length in bytes. This is
1920 a character from a buffer or string. It may be different from
1921 the character displayed in case that
1922 unibyte_display_via_language_environment is set.
1924 If what == IT_COMPOSITION, the first component of a composition
1925 and length in bytes of the composition. */
1928 /* If what == IT_COMPOSITION, identification number and length in
1929 chars of a composition. */
1930 int cmp_id
, cmp_len
;
1932 /* The character to display, possibly translated to multibyte
1933 if unibyte_display_via_language_environment is set. This
1934 is set after produce_glyphs has been called. */
1935 int char_to_display
;
1937 /* If what == IT_IMAGE, the id of the image to display. */
1940 /* Value of the `space-width' property, if any; nil if none. */
1941 Lisp_Object space_width
;
1943 /* Computed from the value of the `raise' property. */
1946 /* Value of the `height' property, if any; nil if none. */
1947 Lisp_Object font_height
;
1949 /* Object and position where the current display element came from.
1950 Object can be a Lisp string in case the current display element
1951 comes from an overlay string, or it is buffer. Position is
1952 a position in object. */
1954 struct text_pos position
;
1956 /* 1 means lines are truncated. */
1957 unsigned truncate_lines_p
: 1;
1959 /* Number of columns per \t. */
1962 /* Width in pixels of truncation and continuation glyphs. */
1963 short truncation_pixel_width
, continuation_pixel_width
;
1965 /* First and last visible x-position in the display area. If window
1966 is hscrolled by n columns, first_visible_x == n * FRAME_COLUMN_WIDTH
1967 (f), and last_visible_x == pixel width of W + first_visible_x. */
1968 int first_visible_x
, last_visible_x
;
1970 /* Last visible y-position + 1 in the display area without a mode
1971 line, if the window has one. */
1974 /* Additional space in pixels between lines (for window systems
1976 int extra_line_spacing
;
1978 /* If non-null, glyphs are produced in glyph_row with each call to
1980 struct glyph_row
*glyph_row
;
1982 /* The area of glyph_row to which glyphs are added. */
1983 enum glyph_row_area area
;
1985 /* Number of glyphs needed for the last character requested via
1986 produce_glyphs. This is 1 except for tabs. */
1989 /* Width of the display element in pixels. Result of
1993 /* Current, maximum logical, and maximum physical line height
1994 information. Result of produce_glyphs. */
1995 int ascent
, descent
, max_ascent
, max_descent
;
1996 int phys_ascent
, phys_descent
, max_phys_ascent
, max_phys_descent
;
1998 /* Current x pixel position within the display line. This value
1999 does not include the width of continuation lines in front of the
2000 line. The value of current_x is automatically incremented by
2001 pixel_width with each call to produce_glyphs. */
2004 /* Accumulated width of continuation lines. If > 0, this means we
2005 are currently in a continuation line. This is initially zero and
2006 incremented/reset by display_line, move_it_to etc. */
2007 int continuation_lines_width
;
2009 /* Current y-position. Automatically incremented by the height of
2010 glyph_row in move_it_to and display_line. */
2013 /* Vertical matrix position of first text line in window. */
2016 /* Current vertical matrix position, or line number. Automatically
2017 incremented by move_it_to and display_line. */
2020 /* Horizontal matrix position reached in move_it_in_display_line.
2021 Only set there, not in display_line. */
2024 /* Left fringe bitmap number (enum fringe_bitmap_type). */
2025 unsigned left_user_fringe_bitmap
: FRINGE_ID_BITS
;
2027 /* Face of the left fringe glyph. */
2028 unsigned left_user_fringe_face_id
: FACE_ID_BITS
;
2030 /* Right fringe bitmap number (enum fringe_bitmap_type). */
2031 unsigned right_user_fringe_bitmap
: FRINGE_ID_BITS
;
2033 /* Face of the right fringe glyph. */
2034 unsigned right_user_fringe_face_id
: FACE_ID_BITS
;
2038 /* Access to positions of iterator IT. */
2040 #define IT_CHARPOS(IT) CHARPOS ((IT).current.pos)
2041 #define IT_BYTEPOS(IT) BYTEPOS ((IT).current.pos)
2042 #define IT_STRING_CHARPOS(IT) CHARPOS ((IT).current.string_pos)
2043 #define IT_STRING_BYTEPOS(IT) BYTEPOS ((IT).current.string_pos)
2045 /* Test if IT has reached the end of its buffer or string. This will
2046 only work after get_next_display_element has been called. */
2048 #define ITERATOR_AT_END_P(IT) ((IT)->what == IT_EOB)
2050 /* Non-zero means IT is at the end of a line. This is the case if it
2051 is either on a newline or on a carriage return and selective
2052 display hides the rest of the line. */
2054 #define ITERATOR_AT_END_OF_LINE_P(IT) \
2055 ((IT)->what == IT_CHARACTER \
2056 && ((IT)->c == '\n' \
2057 || ((IT)->c == '\r' && (IT)->selective)))
2059 /* Call produce_glyphs or produce_glyphs_hook, if set. Shortcut to
2060 avoid the function call overhead. */
2062 #define PRODUCE_GLYPHS(IT) \
2064 extern int inhibit_free_realized_faces; \
2065 if (FRAME_RIF ((IT)->f) != NULL) \
2066 FRAME_RIF ((IT)->f)->produce_glyphs ((IT)); \
2068 produce_glyphs ((IT)); \
2069 if ((IT)->glyph_row != NULL) \
2070 inhibit_free_realized_faces = 1; \
2073 /* Bit-flags indicating what operation move_it_to should perform. */
2075 enum move_operation_enum
2077 /* Stop if specified x-position is reached. */
2080 /* Stop if specified y-position is reached. */
2083 /* Stop if specified vpos is reached. */
2084 MOVE_TO_VPOS
= 0x04,
2086 /* Stop if specified buffer or string position is reached. */
2092 /***********************************************************************
2093 Window-based redisplay interface
2094 ***********************************************************************/
2096 /* Structure used to describe runs of lines that must be scrolled. */
2100 /* Source and destination y pixel position. */
2101 int desired_y
, current_y
;
2103 /* Source and destination vpos in matrix. */
2104 int desired_vpos
, current_vpos
;
2106 /* Height in pixels, number of glyph rows. */
2111 /* Handlers for setting frame parameters. */
2113 typedef void (*frame_parm_handler
) P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
2116 /* Structure holding system-dependent interface functions needed
2117 for window-based redisplay. */
2119 struct redisplay_interface
2121 /* Handlers for setting frame parameters. */
2122 frame_parm_handler
*frame_parm_handlers
;
2124 /* Produce glyphs/get display metrics for the display element IT is
2126 void (*produce_glyphs
) P_ ((struct it
*it
));
2128 /* Write or insert LEN glyphs from STRING at the nominal output
2130 void (*write_glyphs
) P_ ((struct glyph
*string
, int len
));
2131 void (*insert_glyphs
) P_ ((struct glyph
*start
, int len
));
2133 /* Clear from nominal output position to X. X < 0 means clear
2134 to right end of display. */
2135 void (*clear_end_of_line
) P_ ((int x
));
2137 /* Function to call to scroll the display as described by RUN on
2139 void (*scroll_run_hook
) P_ ((struct window
*w
, struct run
*run
));
2141 /* Function to call after a line in a display has been completely
2142 updated. Used to draw truncation marks and alike. DESIRED_ROW
2143 is the desired row which has been updated. */
2144 void (*after_update_window_line_hook
) P_ ((struct glyph_row
*desired_row
));
2146 /* Function to call before beginning to update window W in
2147 window-based redisplay. */
2148 void (*update_window_begin_hook
) P_ ((struct window
*w
));
2150 /* Function to call after window W has been updated in window-based
2151 redisplay. CURSOR_ON_P non-zero means switch cursor on.
2152 MOUSE_FACE_OVERWRITTEN_P non-zero means that some lines in W
2153 that contained glyphs in mouse-face were overwritten, so we
2154 have to update the mouse highlight. */
2155 void (*update_window_end_hook
) P_ ((struct window
*w
, int cursor_on_p
,
2156 int mouse_face_overwritten_p
));
2158 /* Move cursor to row/column position VPOS/HPOS, pixel coordinates
2159 Y/X. HPOS/VPOS are window-relative row and column numbers and X/Y
2160 are window-relative pixel positions. */
2161 void (*cursor_to
) P_ ((int vpos
, int hpos
, int y
, int x
));
2163 /* Flush the display of frame F. For X, this is XFlush. */
2164 void (*flush_display
) P_ ((struct frame
*f
));
2166 /* Flush the display of frame F if non-NULL. This is called
2167 during redisplay, and should be NULL on systems which flushes
2168 automatically before reading input. */
2169 void (*flush_display_optional
) P_ ((struct frame
*f
));
2171 /* Clear the mouse hightlight in window W, if there is any. */
2172 void (*clear_window_mouse_face
) P_ ((struct window
*w
));
2174 /* Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
2176 void (*get_glyph_overhangs
) P_ ((struct glyph
*glyph
, struct frame
*f
,
2177 int *left
, int *right
));
2179 /* Fix the display of AREA of ROW in window W for overlapping rows.
2180 This function is called from redraw_overlapping_rows after
2181 desired rows have been made current. */
2182 void (*fix_overlapping_area
) P_ ((struct window
*w
, struct glyph_row
*row
,
2183 enum glyph_row_area area
));
2185 #ifdef HAVE_WINDOW_SYSTEM
2187 /* Draw a fringe bitmap in window W of row ROW using parameters P. */
2188 void (*draw_fringe_bitmap
) P_ ((struct window
*w
, struct glyph_row
*row
,
2189 struct draw_fringe_bitmap_params
*p
));
2191 /* Define and destroy fringe bitmap no. WHICH. */
2192 void (*define_fringe_bitmap
) P_ ((int which
, unsigned short *bits
,
2194 void (*destroy_fringe_bitmap
) P_ ((int which
));
2196 /* Get metrics of character CHAR2B in FONT of type FONT_TYPE.
2197 Value is null if CHAR2B is not contained in the font. */
2198 XCharStruct
* (*per_char_metric
) P_ ((XFontStruct
*font
, XChar2b
*char2b
,
2201 /* Encode CHAR2B using encoding information from FONT_INFO. CHAR2B is
2202 the two-byte form of C. Encoding is returned in *CHAR2B. If
2203 TWO_BYTE_P is non-null, return non-zero there if font is two-byte. */
2204 int (*encode_char
) P_ ((int c
, XChar2b
*char2b
,
2205 struct font_info
*font_into
, int *two_byte_p
));
2207 /* Compute left and right overhang of glyph string S.
2208 A NULL pointer if platform does not support this. */
2209 void (*compute_glyph_string_overhangs
) P_ ((struct glyph_string
*s
));
2211 /* Draw a glyph string S. */
2212 void (*draw_glyph_string
) P_ ((struct glyph_string
*s
));
2214 /* Define cursor CURSOR on frame F. */
2215 void (*define_frame_cursor
) P_ ((struct frame
*f
, Cursor cursor
));
2217 /* Clear the area at (X,Y,WIDTH,HEIGHT) of frame F. */
2218 void (*clear_frame_area
) P_ ((struct frame
*f
, int x
, int y
,
2219 int width
, int height
));
2221 /* Draw specified cursor CURSOR_TYPE of width CURSOR_WIDTH
2222 at row GLYPH_ROW on window W if ON_P is 1. If ON_P is
2223 0, don't draw cursor. If ACTIVE_P is 1, system caret
2224 should track this cursor (when applicable). */
2225 void (*draw_window_cursor
) P_ ((struct window
*w
,
2226 struct glyph_row
*glyph_row
,
2228 int cursor_type
, int cursor_width
,
2229 int on_p
, int active_p
));
2231 /* Draw vertical border for window W from (X,Y0) to (X,Y1). */
2232 void (*draw_vertical_window_border
) P_ ((struct window
*w
,
2233 int x
, int y0
, int y1
));
2235 /* Shift display of frame F to make room for inserted glyphs.
2236 The area at pixel (X,Y) of width WIDTH and height HEIGHT is
2237 shifted right by SHIFT_BY pixels. */
2238 void (*shift_glyphs_for_insert
) P_ ((struct frame
*f
,
2239 int x
, int y
, int width
,
2240 int height
, int shift_by
));
2242 #endif /* HAVE_WINDOW_SYSTEM */
2246 /***********************************************************************
2248 ***********************************************************************/
2250 #ifdef HAVE_WINDOW_SYSTEM
2252 /* Structure forward declarations. */
2257 /* Each image format (JPEG, TIFF, ...) supported is described by
2258 a structure of the type below. */
2262 /* A symbol uniquely identifying the image type, .e.g `jpeg'. */
2265 /* Check that SPEC is a valid image specification for the given
2266 image type. Value is non-zero if SPEC is valid. */
2267 int (* valid_p
) P_ ((Lisp_Object spec
));
2269 /* Load IMG which is used on frame F from information contained in
2270 IMG->spec. Value is non-zero if successful. */
2271 int (* load
) P_ ((struct frame
*f
, struct image
*img
));
2273 /* Free resources of image IMG which is used on frame F. */
2274 void (* free
) P_ ((struct frame
*f
, struct image
*img
));
2276 /* Next in list of all supported image types. */
2277 struct image_type
*next
;
2281 /* Structure describing an image. Specific image formats like XBM are
2282 converted into this form, so that display only has to deal with
2283 this type of image. */
2287 /* The time in seconds at which the image was last displayed. Set
2288 in prepare_image_for_display. */
2289 unsigned long timestamp
;
2291 /* Pixmaps of the image. */
2292 Pixmap pixmap
, mask
;
2294 /* Colors allocated for this image, if any. Allocated via xmalloc. */
2295 unsigned long *colors
;
2298 /* A single `background color' for this image, for the use of anyone that
2299 cares about such a thing. Only valid if the `background_valid' field
2300 is true. This should generally be accessed by calling the accessor
2301 macro `IMAGE_BACKGROUND', which will heuristically calculate a value
2303 unsigned long background
;
2305 /* True if this image has a `transparent' background -- that is, is
2306 uses an image mask. The accessor macro for this is
2307 `IMAGE_BACKGROUND_TRANSPARENT'. */
2308 unsigned background_transparent
: 1;
2310 /* True if the `background' and `background_transparent' fields are
2311 valid, respectively. */
2312 unsigned background_valid
: 1, background_transparent_valid
: 1;
2314 /* Width and height of the image. */
2317 /* These values are used for the rectangles displayed for images
2318 that can't be loaded. */
2319 #define DEFAULT_IMAGE_WIDTH 30
2320 #define DEFAULT_IMAGE_HEIGHT 30
2322 /* Percent of image height used as ascent. A value of
2323 CENTERED_IMAGE_ASCENT means draw the image centered on the
2326 #define DEFAULT_IMAGE_ASCENT 50
2327 #define CENTERED_IMAGE_ASCENT -1
2329 /* Lisp specification of this image. */
2332 /* Relief to draw around the image. */
2335 /* Optional margins around the image. This includes the relief. */
2336 int hmargin
, vmargin
;
2338 /* Reference to the type of the image. */
2339 struct image_type
*type
;
2341 /* 1 means that loading the image failed. Don't try again. */
2342 unsigned load_failed_p
;
2344 /* A place for image types to store additional data. The member
2345 data.lisp_val is marked during GC, so it's safe to store Lisp data
2346 there. Image types should free this data when their `free'
2347 function is called. */
2352 Lisp_Object lisp_val
;
2355 /* Hash value of image specification to speed up comparisons. */
2358 /* Image id of this image. */
2361 /* Hash collision chain. */
2362 struct image
*next
, *prev
;
2366 /* Cache of images. Each frame has a cache. X frames with the same
2367 x_display_info share their caches. */
2371 /* Hash table of images. */
2372 struct image
**buckets
;
2374 /* Vector mapping image ids to images. */
2375 struct image
**images
;
2377 /* Allocated size of `images'. */
2380 /* Number of images in the cache. */
2383 /* Reference count (number of frames sharing this cache). */
2388 /* Value is a pointer to the image with id ID on frame F, or null if
2389 no image with that id exists. */
2391 #define IMAGE_FROM_ID(F, ID) \
2392 (((ID) >= 0 && (ID) < (FRAME_X_IMAGE_CACHE (F)->used)) \
2393 ? FRAME_X_IMAGE_CACHE (F)->images[ID] \
2396 /* Size of bucket vector of image caches. Should be prime. */
2398 #define IMAGE_CACHE_BUCKETS_SIZE 1001
2400 #endif /* HAVE_WINDOW_SYSTEM */
2404 /***********************************************************************
2406 ***********************************************************************/
2408 /* Enumeration defining where to find tool-bar item information in
2409 tool-bar items vectors stored with frames. Each tool-bar item
2410 occupies TOOL_BAR_ITEM_NSLOTS elements in such a vector. */
2412 enum tool_bar_item_idx
2414 /* The key of the tool-bar item. Used to remove items when a binding
2415 for `undefined' is found. */
2418 /* Non-nil if item is enabled. */
2419 TOOL_BAR_ITEM_ENABLED_P
,
2421 /* Non-nil if item is selected (pressed). */
2422 TOOL_BAR_ITEM_SELECTED_P
,
2425 TOOL_BAR_ITEM_CAPTION
,
2427 /* Image(s) to display. This is either a single image specification
2428 or a vector of specifications. */
2429 TOOL_BAR_ITEM_IMAGES
,
2432 TOOL_BAR_ITEM_BINDING
,
2434 /* Button type. One of nil, `:radio' or `:toggle'. */
2440 /* Sentinel = number of slots in tool_bar_items occupied by one
2442 TOOL_BAR_ITEM_NSLOTS
2446 /* An enumeration for the different images that can be specified
2447 for a tool-bar item. */
2449 enum tool_bar_item_image
2451 TOOL_BAR_IMAGE_ENABLED_SELECTED
,
2452 TOOL_BAR_IMAGE_ENABLED_DESELECTED
,
2453 TOOL_BAR_IMAGE_DISABLED_SELECTED
,
2454 TOOL_BAR_IMAGE_DISABLED_DESELECTED
2457 /* Margin around tool-bar buttons in pixels. */
2459 extern Lisp_Object Vtool_bar_button_margin
;
2461 /* Thickness of relief to draw around tool-bar buttons. */
2463 extern EMACS_INT tool_bar_button_relief
;
2465 /* Default values of the above variables. */
2467 #define DEFAULT_TOOL_BAR_BUTTON_MARGIN 4
2468 #define DEFAULT_TOOL_BAR_BUTTON_RELIEF 1
2470 /* The height in pixels of the default tool-bar images. */
2472 #define DEFAULT_TOOL_BAR_IMAGE_HEIGHT 24
2475 /***********************************************************************
2476 Terminal Capabilities
2477 ***********************************************************************/
2479 /* Each of these is a bit representing a terminal `capability' (bold,
2480 inverse, etc). They are or'd together to specify the set of
2481 capabilities being queried for when calling `tty_capable_p' (which
2482 returns true if the terminal supports all of them). */
2484 #define TTY_CAP_INVERSE 0x01
2485 #define TTY_CAP_UNDERLINE 0x02
2486 #define TTY_CAP_BOLD 0x04
2487 #define TTY_CAP_DIM 0x08
2488 #define TTY_CAP_BLINK 0x10
2489 #define TTY_CAP_ALT_CHARSET 0x20
2492 /***********************************************************************
2494 ***********************************************************************/
2496 /* Defined in xdisp.c */
2498 struct glyph_row
*row_containing_pos
P_ ((struct window
*, int,
2500 struct glyph_row
*, int));
2501 int string_buffer_position
P_ ((struct window
*, Lisp_Object
, int));
2502 int line_bottom_y
P_ ((struct it
*));
2503 int display_prop_intangible_p
P_ ((Lisp_Object
));
2504 void resize_echo_area_exactly
P_ ((void));
2505 int resize_mini_window
P_ ((struct window
*, int));
2506 int try_window
P_ ((Lisp_Object
, struct text_pos
));
2507 void window_box
P_ ((struct window
*, int, int *, int *, int *, int *));
2508 int window_box_height
P_ ((struct window
*));
2509 int window_text_bottom_y
P_ ((struct window
*));
2510 int window_box_width
P_ ((struct window
*, int));
2511 int window_box_left
P_ ((struct window
*, int));
2512 int window_box_left_offset
P_ ((struct window
*, int));
2513 int window_box_right
P_ ((struct window
*, int));
2514 int window_box_right_offset
P_ ((struct window
*, int));
2515 void window_box_edges
P_ ((struct window
*, int, int *, int *, int *, int *));
2516 int estimate_mode_line_height
P_ ((struct frame
*, enum face_id
));
2517 void pixel_to_glyph_coords
P_ ((struct frame
*, int, int, int *, int *,
2518 NativeRectangle
*, int));
2519 int glyph_to_pixel_coords
P_ ((struct window
*, int, int, int *, int *));
2520 void mark_window_display_accurate
P_ ((Lisp_Object
, int));
2521 void redisplay_preserve_echo_area
P_ ((int));
2522 void set_cursor_from_row
P_ ((struct window
*, struct glyph_row
*,
2523 struct glyph_matrix
*, int, int, int, int));
2524 void init_iterator
P_ ((struct it
*, struct window
*, int,
2525 int, struct glyph_row
*, enum face_id
));
2526 void init_iterator_to_row_start
P_ ((struct it
*, struct window
*,
2527 struct glyph_row
*));
2528 int get_next_display_element
P_ ((struct it
*));
2529 void set_iterator_to_next
P_ ((struct it
*, int));
2530 void produce_glyphs
P_ ((struct it
*));
2531 void produce_special_glyphs
P_ ((struct it
*, enum display_element_type
));
2532 void start_display
P_ ((struct it
*, struct window
*, struct text_pos
));
2533 void move_it_to
P_ ((struct it
*, int, int, int, int, int));
2534 void move_it_vertically
P_ ((struct it
*, int));
2535 void move_it_vertically_backward
P_ ((struct it
*, int));
2536 void move_it_by_lines
P_ ((struct it
*, int, int));
2537 void move_it_past_eol
P_ ((struct it
*));
2538 int in_display_vector_p
P_ ((struct it
*));
2539 int frame_mode_line_height
P_ ((struct frame
*));
2540 void highlight_trailing_whitespace
P_ ((struct frame
*, struct glyph_row
*));
2541 extern Lisp_Object Qtool_bar
;
2542 extern Lisp_Object Vshow_trailing_whitespace
;
2543 extern int mode_line_in_non_selected_windows
;
2544 extern int redisplaying_p
;
2545 extern Lisp_Object Vimage_types
;
2546 extern void add_to_log
P_ ((char *, Lisp_Object
, Lisp_Object
));
2547 extern int help_echo_showing_p
;
2548 extern int current_mode_line_height
, current_header_line_height
;
2549 extern Lisp_Object help_echo_string
, help_echo_window
;
2550 extern Lisp_Object help_echo_object
, previous_help_echo_string
;
2551 extern int help_echo_pos
;
2552 extern struct frame
*last_mouse_frame
;
2553 extern int last_tool_bar_item
;
2554 extern int mouse_autoselect_window
;
2556 #ifdef HAVE_WINDOW_SYSTEM
2559 extern void dump_glyph_string
P_ ((struct glyph_string
*));
2562 extern void x_get_glyph_overhangs
P_ ((struct glyph
*, struct frame
*,
2564 extern void x_produce_glyphs
P_ ((struct it
*));
2566 extern void x_write_glyphs
P_ ((struct glyph
*, int));
2567 extern void x_insert_glyphs
P_ ((struct glyph
*, int len
));
2568 extern void x_clear_end_of_line
P_ ((int));
2570 extern int x_stretch_cursor_p
;
2571 extern struct cursor_pos output_cursor
;
2573 extern void x_fix_overlapping_area
P_ ((struct window
*, struct glyph_row
*,
2574 enum glyph_row_area
));
2575 extern void draw_phys_cursor_glyph
P_ ((struct window
*,
2577 enum draw_glyphs_face
));
2578 extern void erase_phys_cursor
P_ ((struct window
*));
2579 extern void display_and_set_cursor
P_ ((struct window
*,
2580 int, int, int, int, int));
2582 extern void set_output_cursor
P_ ((struct cursor_pos
*));
2583 extern void x_cursor_to
P_ ((int, int, int, int));
2585 extern void x_update_cursor
P_ ((struct frame
*, int));
2586 extern void x_clear_cursor
P_ ((struct window
*));
2587 extern void x_draw_vertical_border
P_ ((struct window
*w
));
2589 extern void frame_to_window_pixel_xy
P_ ((struct window
*, int *, int *));
2590 extern void get_glyph_string_clip_rect
P_ ((struct glyph_string
*,
2591 NativeRectangle
*nr
));
2592 extern Lisp_Object find_hot_spot
P_ ((Lisp_Object
, int, int));
2593 extern void note_mouse_highlight
P_ ((struct frame
*, int, int));
2594 extern void x_clear_window_mouse_face
P_ ((struct window
*));
2595 extern void cancel_mouse_face
P_ ((struct frame
*));
2597 extern void handle_tool_bar_click
P_ ((struct frame
*,
2598 int, int, int, unsigned int));
2600 /* msdos.c defines its own versions of these functions. */
2601 extern int clear_mouse_face
P_ ((Display_Info
*));
2602 extern void show_mouse_face
P_ ((Display_Info
*, enum draw_glyphs_face
));
2603 extern int cursor_in_mouse_face_p
P_ ((struct window
*w
));
2605 extern void expose_frame
P_ ((struct frame
*, int, int, int, int));
2606 extern int x_intersect_rectangles
P_ ((XRectangle
*, XRectangle
*,
2610 /* Defined in fringe.c */
2612 int valid_fringe_bitmap_id_p (int);
2613 void draw_fringe_bitmap
P_ ((struct window
*, struct glyph_row
*, int));
2614 void draw_row_fringe_bitmaps
P_ ((struct window
*, struct glyph_row
*));
2615 void draw_window_fringes
P_ ((struct window
*));
2616 int update_window_fringes
P_ ((struct window
*, int));
2617 void compute_fringe_widths
P_ ((struct frame
*, int));
2620 void w32_init_fringe
P_ ((void));
2621 void w32_reset_fringes
P_ ((void));
2624 /* Defined in sysdep.c */
2626 void get_tty_size
P_ ((int, int *, int *));
2627 void request_sigio
P_ ((void));
2628 void unrequest_sigio
P_ ((void));
2629 int tabs_safe_p
P_ ((int));
2630 void init_baud_rate
P_ ((int));
2631 void init_sigio
P_ ((int));
2633 /* Defined in xfaces.c */
2635 #ifdef HAVE_X_WINDOWS
2636 void x_free_colors
P_ ((struct frame
*, unsigned long *, int));
2639 void update_face_from_frame_parameter
P_ ((struct frame
*, Lisp_Object
,
2641 Lisp_Object tty_color_name
P_ ((struct frame
*, int));
2642 void clear_face_cache
P_ ((int));
2643 unsigned long load_color
P_ ((struct frame
*, struct face
*, Lisp_Object
,
2644 enum lface_attribute_index
));
2645 void unload_color
P_ ((struct frame
*, unsigned long));
2646 int face_font_available_p
P_ ((struct frame
*, Lisp_Object
));
2647 int ascii_face_of_lisp_face
P_ ((struct frame
*, int));
2648 void prepare_face_for_display
P_ ((struct frame
*, struct face
*));
2649 int xstricmp
P_ ((const unsigned char *, const unsigned char *));
2650 int lookup_face
P_ ((struct frame
*, Lisp_Object
*, int, struct face
*));
2651 int lookup_named_face
P_ ((struct frame
*, Lisp_Object
, int));
2652 int smaller_face
P_ ((struct frame
*, int, int));
2653 int face_with_height
P_ ((struct frame
*, int, int));
2654 int lookup_derived_face
P_ ((struct frame
*, Lisp_Object
, int, int));
2655 void init_frame_faces
P_ ((struct frame
*));
2656 void free_frame_faces
P_ ((struct frame
*));
2657 void recompute_basic_faces
P_ ((struct frame
*));
2658 int face_at_buffer_position
P_ ((struct window
*, int, int, int, int *,
2660 int face_at_string_position
P_ ((struct window
*, Lisp_Object
, int, int, int,
2661 int, int *, enum face_id
, int));
2662 int compute_char_face
P_ ((struct frame
*, int, Lisp_Object
));
2663 void free_all_realized_faces
P_ ((Lisp_Object
));
2664 extern Lisp_Object Qforeground_color
, Qbackground_color
;
2665 extern char unspecified_fg
[], unspecified_bg
[];
2666 void free_realized_multibyte_face
P_ ((struct frame
*, int));
2668 /* Defined in xfns.c */
2670 #ifdef HAVE_X_WINDOWS
2671 void gamma_correct
P_ ((struct frame
*, XColor
*));
2674 void gamma_correct
P_ ((struct frame
*, COLORREF
*));
2677 #ifdef HAVE_WINDOW_SYSTEM
2679 void x_kill_gs_process
P_ ((Pixmap
, struct frame
*));
2680 int x_screen_planes
P_ ((struct frame
*));
2681 void x_implicitly_set_name
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
2682 struct image_cache
*make_image_cache
P_ ((void));
2683 void free_image_cache
P_ ((struct frame
*));
2684 void clear_image_cache
P_ ((struct frame
*, int));
2685 void forall_images_in_image_cache
P_ ((struct frame
*,
2686 void (*) P_ ((struct image
*))));
2687 int valid_image_p
P_ ((Lisp_Object
));
2688 void prepare_image_for_display
P_ ((struct frame
*, struct image
*));
2689 int lookup_image
P_ ((struct frame
*, Lisp_Object
));
2691 #ifdef HAVE_X_WINDOWS
2692 unsigned long image_background
P_ ((struct image
*, struct frame
*,
2694 int image_background_transparent
P_ ((struct image
*, struct frame
*,
2696 #endif /* HAVE_X_WINDOWS */
2698 extern Lisp_Object tip_frame
;
2699 extern Window tip_window
;
2700 EXFUN (Fx_show_tip
, 6);
2701 EXFUN (Fx_hide_tip
, 0);
2702 extern void start_hourglass
P_ ((void));
2703 extern void cancel_hourglass
P_ ((void));
2704 extern int display_hourglass_p
;
2706 /* Returns the background color of IMG, calculating one heuristically if
2707 necessary. If non-zero, XIMG is an existing XImage object to use for
2710 #define IMAGE_BACKGROUND(img, f, ximg) \
2711 ((img)->background_valid \
2712 ? (img)->background \
2713 : image_background (img, f, ximg))
2715 /* Returns true if IMG has a `transparent' background, using heuristics
2716 to decide if necessary. If non-zero, MASK is an existing XImage
2717 object to use for the heuristic. */
2719 #define IMAGE_BACKGROUND_TRANSPARENT(img, f, mask) \
2720 ((img)->background_transparent_valid \
2721 ? (img)->background_transparent \
2722 : image_background_transparent (img, f, mask))
2724 #endif /* HAVE_WINDOW_SYSTEM */
2727 /* Defined in xmenu.c */
2729 int popup_activated
P_ ((void));
2731 /* Defined in dispnew.c */
2733 extern int inverse_video
;
2734 extern int required_matrix_width
P_ ((struct window
*));
2735 extern int required_matrix_height
P_ ((struct window
*));
2736 extern Lisp_Object buffer_posn_from_coords
P_ ((struct window
*,
2738 struct display_pos
*,
2740 int *, int *, int *, int *));
2741 extern Lisp_Object mode_line_string
P_ ((struct window
*, enum window_part
,
2742 int *, int *, int *,
2744 int *, int *, int *, int *));
2745 extern Lisp_Object marginal_area_string
P_ ((struct window
*, enum window_part
,
2746 int *, int *, int *,
2748 int *, int *, int *, int *));
2749 extern void redraw_frame
P_ ((struct frame
*));
2750 extern void redraw_garbaged_frames
P_ ((void));
2751 extern void cancel_line
P_ ((int, struct frame
*));
2752 extern void init_desired_glyphs
P_ ((struct frame
*));
2753 extern int scroll_frame_lines
P_ ((struct frame
*, int, int, int, int));
2754 extern int direct_output_for_insert
P_ ((int));
2755 extern int direct_output_forward_char
P_ ((int));
2756 extern int update_frame
P_ ((struct frame
*, int, int));
2757 extern int scrolling
P_ ((struct frame
*));
2758 extern void bitch_at_user
P_ ((void));
2759 void adjust_glyphs
P_ ((struct frame
*));
2760 void free_glyphs
P_ ((struct frame
*));
2761 void free_window_matrices
P_ ((struct window
*));
2762 void check_glyph_memory
P_ ((void));
2763 void mirrored_line_dance
P_ ((struct glyph_matrix
*, int, int, int *, char *));
2764 void clear_glyph_matrix
P_ ((struct glyph_matrix
*));
2765 void clear_current_matrices
P_ ((struct frame
*f
));
2766 void clear_desired_matrices
P_ ((struct frame
*));
2767 void shift_glyph_matrix
P_ ((struct window
*, struct glyph_matrix
*,
2769 void rotate_matrix
P_ ((struct glyph_matrix
*, int, int, int));
2770 void increment_matrix_positions
P_ ((struct glyph_matrix
*,
2771 int, int, int, int));
2772 void blank_row
P_ ((struct window
*, struct glyph_row
*, int));
2773 void increment_row_positions
P_ ((struct glyph_row
*, int, int));
2774 void enable_glyph_matrix_rows
P_ ((struct glyph_matrix
*, int, int, int));
2775 void clear_glyph_row
P_ ((struct glyph_row
*));
2776 void prepare_desired_row
P_ ((struct glyph_row
*));
2777 int line_hash_code
P_ ((struct glyph_row
*));
2778 void set_window_update_flags
P_ ((struct window
*, int));
2779 void write_glyphs
P_ ((struct glyph
*, int));
2780 void insert_glyphs
P_ ((struct glyph
*, int));
2781 void redraw_frame
P_ ((struct frame
*));
2782 void redraw_garbaged_frames
P_ ((void));
2783 int scroll_cost
P_ ((struct frame
*, int, int, int));
2784 int direct_output_for_insert
P_ ((int));
2785 int direct_output_forward_char
P_ ((int));
2786 int update_frame
P_ ((struct frame
*, int, int));
2787 void update_single_window
P_ ((struct window
*, int));
2788 int scrolling
P_ ((struct frame
*));
2789 void do_pending_window_change
P_ ((int));
2790 void change_frame_size
P_ ((struct frame
*, int, int, int, int, int));
2791 void bitch_at_user
P_ ((void));
2792 Lisp_Object sit_for
P_ ((int, int, int, int, int));
2793 void init_display
P_ ((void));
2794 void syms_of_display
P_ ((void));
2795 extern Lisp_Object Qredisplay_dont_pause
;
2797 /* Defined in term.c */
2799 extern void ring_bell
P_ ((void));
2800 extern void update_begin
P_ ((struct frame
*));
2801 extern void update_end
P_ ((struct frame
*));
2802 extern void set_terminal_window
P_ ((int));
2803 extern void set_scroll_region
P_ ((int, int));
2804 extern void turn_off_insert
P_ ((struct tty_display_info
*));
2805 extern void turn_off_highlight
P_ ((struct tty_display_info
*));
2806 extern void background_highlight
P_ ((struct tty_display_info
*));
2807 extern void clear_frame
P_ ((void));
2808 extern void clear_end_of_line
P_ ((int));
2809 extern void clear_end_of_line_raw
P_ ((int));
2810 extern void tty_clear_end_of_line
P_ ((int));
2811 extern void delete_glyphs
P_ ((int));
2812 extern void ins_del_lines
P_ ((int, int));
2813 extern int string_cost
P_ ((char *));
2814 extern int per_line_cost
P_ ((char *));
2815 extern void calculate_costs
P_ ((struct frame
*));
2816 extern void set_tty_color_mode
P_ ((struct frame
*, Lisp_Object
));
2817 extern void tty_setup_colors
P_ ((struct tty_display_info
*, int));
2818 extern struct display
*get_named_tty_display
P_ ((char *));
2819 extern struct display
*init_initial_display
P_ ((void));
2820 extern struct display
*term_init
P_ ((char *, char *, int));
2821 extern void delete_tty
P_ ((struct display
*));
2822 extern void fatal
P_ ((/* char *, ... */));
2823 extern void cursor_to
P_ ((int, int));
2824 extern int tty_capable_p
P_ ((struct tty_display_info
*, unsigned, unsigned long, unsigned long));
2825 extern void tty_set_terminal_modes
P_ ((struct display
*));
2826 extern void tty_reset_terminal_modes
P_ ((struct display
*));
2827 extern void create_tty_output
P_ ((struct frame
*));
2830 /* Defined in scroll.c */
2832 extern int scrolling_max_lines_saved
P_ ((int, int, int *, int *, int *));
2833 extern int scroll_cost
P_ ((struct frame
*, int, int, int));
2834 extern void do_line_insertion_deletion_costs
P_ ((struct frame
*, char *,
2835 char *, char *, char *,
2836 char *, char *, int));
2837 void scrolling_1
P_ ((struct frame
*, int, int, int, int *, int *, int *,
2840 /* Defined in frame.c */
2842 #ifdef HAVE_WINDOW_SYSTEM
2844 /* Types we might convert a resource string into. */
2854 extern Lisp_Object x_get_arg
P_ ((Display_Info
*, Lisp_Object
,
2855 Lisp_Object
, char *, char *class,
2856 enum resource_types
));
2857 extern Lisp_Object x_frame_get_arg
P_ ((struct frame
*, Lisp_Object
,
2858 Lisp_Object
, char *, char *,
2859 enum resource_types
));
2860 extern Lisp_Object x_frame_get_and_record_arg
P_ ((
2861 struct frame
*, Lisp_Object
,
2862 Lisp_Object
, char *, char *,
2863 enum resource_types
));
2864 extern Lisp_Object x_default_parameter
P_ ((struct frame
*, Lisp_Object
,
2865 Lisp_Object
, Lisp_Object
,
2867 enum resource_types
));
2869 #endif /* HAVE_WINDOW_SYSTEM */
2871 #endif /* not DISPEXTERN_H_INCLUDED */
2873 /* arch-tag: c65c475f-1c1e-4534-8795-990b8509fd65
2874 (do not change this comment) */