Checked anti.texi, errors.texi, and maps.texi.
[emacs.git] / src / dispextern.h
blob706dba776c4c24f6b29e9a81c2030e3970b440c5
1 /* Interface definitions for display code.
2 Copyright (C) 1985, 1993, 1994, 1997, 1998, 1999, 2000, 2001, 2002,
3 2003, 2004, 2005, 2006, 2007, 2008, 2009
4 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>. */
23 #ifndef DISPEXTERN_H_INCLUDED
24 #define DISPEXTERN_H_INCLUDED
26 #ifdef HAVE_X_WINDOWS
28 #include <X11/Xlib.h>
29 #ifdef USE_X_TOOLKIT
30 #include <X11/Intrinsic.h>
31 #endif /* USE_X_TOOLKIT */
33 #else /* !HAVE_X_WINDOWS */
35 /* X-related stuff used by non-X gui code. */
37 typedef struct {
38 unsigned long pixel;
39 unsigned short red, green, blue;
40 char flags;
41 char pad;
42 } XColor;
44 #endif /* HAVE_X_WINDOWS */
46 #ifdef MSDOS
47 #include "msdos.h"
48 #endif
50 #ifdef HAVE_X_WINDOWS
51 typedef struct x_display_info Display_Info;
52 typedef XImage * XImagePtr;
53 typedef XImagePtr XImagePtr_or_DC;
54 #define NativeRectangle XRectangle
55 #endif
57 #ifdef HAVE_NTGUI
58 #include "w32gui.h"
59 typedef struct w32_display_info Display_Info;
60 typedef XImage *XImagePtr;
61 typedef HDC XImagePtr_or_DC;
62 #endif
64 #ifdef HAVE_NS
65 #include "nsgui.h"
66 /* following typedef needed to accomodate the MSDOS port, believe it or not */
67 typedef struct ns_display_info Display_Info;
68 typedef Pixmap XImagePtr;
69 typedef XImagePtr XImagePtr_or_DC;
70 #endif
72 #ifndef NativeRectangle
73 #define NativeRectangle int
74 #endif
76 /* Structure forward declarations. Some are here because function
77 prototypes below reference structure types before their definition
78 in this file. Some are here because not every file including
79 dispextern.h also includes frame.h and windows.h. */
81 struct glyph;
82 struct glyph_row;
83 struct glyph_matrix;
84 struct glyph_pool;
85 struct frame;
86 struct window;
89 /* Values returned from coordinates_in_window. */
91 enum window_part
93 ON_NOTHING,
94 ON_TEXT,
95 ON_MODE_LINE,
96 ON_VERTICAL_BORDER,
97 ON_HEADER_LINE,
98 ON_LEFT_FRINGE,
99 ON_RIGHT_FRINGE,
100 ON_LEFT_MARGIN,
101 ON_RIGHT_MARGIN,
102 ON_SCROLL_BAR
105 /* Number of bits allocated to store fringe bitmap numbers. */
106 #define FRINGE_ID_BITS 16
110 /***********************************************************************
111 Debugging
112 ***********************************************************************/
114 /* If GLYPH_DEBUG is non-zero, additional checks are activated. Turn
115 it off by defining the macro GLYPH_DEBUG to zero. */
117 #ifndef GLYPH_DEBUG
118 #define GLYPH_DEBUG 0
119 #endif
121 /* If XASSERTS is non-zero, additional consistency checks are activated.
122 Turn it off by defining the macro XASSERTS to zero. */
124 #ifndef XASSERTS
125 #define XASSERTS 0
126 #endif
128 /* Macros to include code only if GLYPH_DEBUG != 0. */
130 #if GLYPH_DEBUG
131 #define IF_DEBUG(X) X
132 #else
133 #define IF_DEBUG(X) (void) 0
134 #endif
136 #if XASSERTS
137 #define xassert(X) do {if (!(X)) abort ();} while (0)
138 #else
139 #define xassert(X) (void) 0
140 #endif
142 /* Macro for displaying traces of redisplay. If Emacs was compiled
143 with GLYPH_DEBUG != 0, the variable trace_redisplay_p can be set to
144 a non-zero value in debugging sessions to activate traces. */
146 #if GLYPH_DEBUG
148 extern int trace_redisplay_p;
149 #include <stdio.h>
151 #define TRACE(X) \
152 if (trace_redisplay_p) \
153 fprintf X; \
154 else \
155 (void) 0
157 #else /* GLYPH_DEBUG == 0 */
159 #define TRACE(X) (void) 0
161 #endif /* GLYPH_DEBUG == 0 */
165 /***********************************************************************
166 Text positions
167 ***********************************************************************/
169 /* Starting with Emacs 20.3, characters from strings and buffers have
170 both a character and a byte position associated with them. The
171 following structure holds such a pair of positions. */
173 struct text_pos
175 /* Character position. */
176 int charpos;
178 /* Corresponding byte position. */
179 int bytepos;
182 /* Access character and byte position of POS in a functional form. */
184 #define BYTEPOS(POS) (POS).bytepos
185 #define CHARPOS(POS) (POS).charpos
187 /* Set character position of POS to CHARPOS, byte position to BYTEPOS. */
189 #define SET_TEXT_POS(POS, CHARPOS, BYTEPOS) \
190 ((POS).charpos = (CHARPOS), (POS).bytepos = BYTEPOS)
192 /* Increment text position POS. */
194 #define INC_TEXT_POS(POS, MULTIBYTE_P) \
195 do \
197 ++(POS).charpos; \
198 if (MULTIBYTE_P) \
199 INC_POS ((POS).bytepos); \
200 else \
201 ++(POS).bytepos; \
203 while (0)
205 /* Decrement text position POS. */
207 #define DEC_TEXT_POS(POS, MULTIBYTE_P) \
208 do \
210 --(POS).charpos; \
211 if (MULTIBYTE_P) \
212 DEC_POS ((POS).bytepos); \
213 else \
214 --(POS).bytepos; \
216 while (0)
218 /* Set text position POS from marker MARKER. */
220 #define SET_TEXT_POS_FROM_MARKER(POS, MARKER) \
221 (CHARPOS (POS) = marker_position ((MARKER)), \
222 BYTEPOS (POS) = marker_byte_position ((MARKER)))
224 /* Set marker MARKER from text position POS. */
226 #define SET_MARKER_FROM_TEXT_POS(MARKER, POS) \
227 set_marker_both ((MARKER), Qnil, CHARPOS ((POS)), BYTEPOS ((POS)))
229 /* Value is non-zero if character and byte positions of POS1 and POS2
230 are equal. */
232 #define TEXT_POS_EQUAL_P(POS1, POS2) \
233 ((POS1).charpos == (POS2).charpos \
234 && (POS1).bytepos == (POS2).bytepos)
236 /* When rendering glyphs, redisplay scans string or buffer text,
237 overlay strings in that text, and does display table or control
238 character translations. The following structure captures a
239 position taking all this into account. */
241 struct display_pos
243 /* Buffer or string position. */
244 struct text_pos pos;
246 /* If this is a position in an overlay string, overlay_string_index
247 is the index of that overlay string in the sequence of overlay
248 strings at `pos' in the order redisplay processes them. A value
249 < 0 means that this is not a position in an overlay string. */
250 int overlay_string_index;
252 /* If this is a position in an overlay string, string_pos is the
253 position within that string. */
254 struct text_pos string_pos;
256 /* If the character at the position above is a control character or
257 has a display table entry, dpvec_index is an index in the display
258 table or control character translation of that character. A
259 value < 0 means this is not a position in such a translation. */
260 int dpvec_index;
265 /***********************************************************************
266 Glyphs
267 ***********************************************************************/
269 /* Enumeration of glyph types. Glyph structures contain a type field
270 containing one of the enumerators defined here. */
272 enum glyph_type
274 /* Glyph describes a character. */
275 CHAR_GLYPH,
277 /* Glyph describes a static composition. */
278 COMPOSITE_GLYPH,
280 /* Glyph describes an image. */
281 IMAGE_GLYPH,
283 /* Glyph is a space of fractional width and/or height. */
284 STRETCH_GLYPH
288 /* Structure describing how to use partial glyphs (images slicing) */
290 struct glyph_slice
292 unsigned x : 16;
293 unsigned y : 16;
294 unsigned width : 16;
295 unsigned height : 16;
299 /* Glyphs.
301 Be extra careful when changing this structure! Esp. make sure that
302 functions producing glyphs, like append_glyph, fill ALL of the
303 glyph structure, and that GLYPH_EQUAL_P compares all
304 display-relevant members of glyphs (not to imply that these are the
305 only things to check when you add a member). */
307 struct glyph
309 /* Position from which this glyph was drawn. If `object' below is a
310 Lisp string, this is a position in that string. If it is a
311 buffer, this is a position in that buffer. A value of -1
312 together with a null object means glyph is a truncation glyph at
313 the start of a row. */
314 int charpos;
316 /* Lisp object source of this glyph. Currently either a buffer or
317 a string, if the glyph was produced from characters which came from
318 a buffer or a string; or 0 if the glyph was inserted by redisplay
319 for its own purposes such as padding. */
320 Lisp_Object object;
322 /* Width in pixels. */
323 short pixel_width;
325 /* Ascent and descent in pixels. */
326 short ascent, descent;
328 /* Vertical offset. If < 0, the glyph is displayed raised, if > 0
329 the glyph is displayed lowered. */
330 short voffset;
332 /* Which kind of glyph this is---character, image etc. Value
333 should be an enumerator of type enum glyph_type. */
334 unsigned type : 2;
336 /* 1 means this glyph was produced from multibyte text. Zero
337 means it was produced from unibyte text, i.e. charsets aren't
338 applicable, and encoding is not performed. */
339 unsigned multibyte_p : 1;
341 /* Non-zero means draw a box line at the left or right side of this
342 glyph. This is part of the implementation of the face attribute
343 `:box'. */
344 unsigned left_box_line_p : 1;
345 unsigned right_box_line_p : 1;
347 /* Non-zero means this glyph's physical ascent or descent is greater
348 than its logical ascent/descent, i.e. it may potentially overlap
349 glyphs above or below it. */
350 unsigned overlaps_vertically_p : 1;
352 /* For terminal frames, 1 means glyph is a padding glyph. Padding
353 glyphs are used for characters whose visual shape consists of
354 more than one glyph (e.g. Asian characters). All but the first
355 glyph of such a glyph sequence have the padding_p flag set. This
356 flag is used only to minimize code changes. A better way would
357 probably be to use the width field of glyphs to express padding.
359 For graphic frames, 1 means the pixel width of the glyph in a
360 font is 0, but 1-pixel is padded on displaying for correct cursor
361 displaying. The member `pixel_width' above is set to 1. */
362 unsigned padding_p : 1;
364 /* 1 means the actual glyph is not available, draw a box instead.
365 This can happen when a font couldn't be loaded, or a character
366 doesn't have a glyph in a font. */
367 unsigned glyph_not_available_p : 1;
370 /* Non-zero means don't display cursor here. */
371 unsigned avoid_cursor_p : 1;
373 #define FACE_ID_BITS 20
375 /* Face of the glyph. This is a realized face ID,
376 an index in the face cache of the frame. */
377 unsigned face_id : FACE_ID_BITS;
379 /* Type of font used to display the character glyph. May be used to
380 determine which set of functions to use to obtain font metrics
381 for the glyph. On W32, value should be an enumerator of the type
382 w32_char_font_type. Otherwise it equals FONT_TYPE_UNKNOWN. */
383 unsigned font_type : 3;
385 struct glyph_slice slice;
387 /* A union of sub-structures for different glyph types. */
388 union
390 /* Character code for character glyphs (type == CHAR_GLYPH). */
391 unsigned ch;
393 /* Sub-structures for type == COMPOSITION_GLYPH. */
394 struct
396 /* Flag to tell if the composition is automatic or not. */
397 unsigned automatic : 1;
398 /* ID of the composition. */
399 unsigned id : 23;
400 /* Start and end indices of glyphs of the composition. */
401 unsigned from : 4;
402 unsigned to : 4;
403 } cmp;
405 /* Image ID for image glyphs (type == IMAGE_GLYPH). */
406 unsigned img_id;
408 /* Sub-structure for type == STRETCH_GLYPH. */
409 struct
411 /* The height of the glyph. */
412 unsigned height : 16;
414 /* The ascent of the glyph. */
415 unsigned ascent : 16;
417 stretch;
419 /* Used to compare all bit-fields above in one step. */
420 unsigned val;
421 } u;
425 /* Default value of the glyph font_type field. */
427 #define FONT_TYPE_UNKNOWN 0
429 /* Is GLYPH a space? */
431 #define CHAR_GLYPH_SPACE_P(GLYPH) \
432 ((GLYPH).u.ch == SPACEGLYPH && (GLYPH).face_id == DEFAULT_FACE_ID)
434 /* Are glyph slices of glyphs *X and *Y equal */
436 #define GLYPH_SLICE_EQUAL_P(X, Y) \
437 ((X)->slice.x == (Y)->slice.x \
438 && (X)->slice.y == (Y)->slice.y \
439 && (X)->slice.width == (Y)->slice.width \
440 && (X)->slice.height == (Y)->slice.height)
442 /* Are glyphs *X and *Y displayed equal? */
444 #define GLYPH_EQUAL_P(X, Y) \
445 ((X)->type == (Y)->type \
446 && (X)->u.val == (Y)->u.val \
447 && GLYPH_SLICE_EQUAL_P (X, Y) \
448 && (X)->face_id == (Y)->face_id \
449 && (X)->padding_p == (Y)->padding_p \
450 && (X)->left_box_line_p == (Y)->left_box_line_p \
451 && (X)->right_box_line_p == (Y)->right_box_line_p \
452 && (X)->voffset == (Y)->voffset \
453 && (X)->pixel_width == (Y)->pixel_width)
455 /* Are character codes, faces, padding_ps of glyphs *X and *Y equal? */
457 #define GLYPH_CHAR_AND_FACE_EQUAL_P(X, Y) \
458 ((X)->u.ch == (Y)->u.ch \
459 && (X)->face_id == (Y)->face_id \
460 && (X)->padding_p == (Y)->padding_p)
462 /* Fill a character glyph GLYPH. CODE, FACE_ID, PADDING_P correspond
463 to the bits defined for the typedef `GLYPH' in lisp.h. */
465 #define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P) \
466 do \
468 (GLYPH).u.ch = (CODE); \
469 (GLYPH).face_id = (FACE_ID); \
470 (GLYPH).padding_p = (PADDING_P); \
472 while (0)
474 /* Fill a character type glyph GLYPH from a glyph typedef FROM as
475 defined in lisp.h. */
477 #define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM) \
478 SET_CHAR_GLYPH ((GLYPH), \
479 GLYPH_CHAR ((FROM)), \
480 GLYPH_FACE ((FROM)), \
483 /* Construct a glyph code from a character glyph GLYPH. If the
484 character is multibyte, return -1 as we can't use glyph table for a
485 multibyte character. */
487 #define SET_GLYPH_FROM_CHAR_GLYPH(G, GLYPH) \
488 do \
490 if ((GLYPH).u.ch < 256) \
491 SET_GLYPH ((G), (GLYPH).u.ch, ((GLYPH).face_id)); \
492 else \
493 SET_GLYPH ((G), -1, 0); \
495 while (0)
497 #define GLYPH_INVALID_P(GLYPH) (GLYPH_CHAR (GLYPH) < 0)
499 /* Is GLYPH a padding glyph? */
501 #define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p
506 /***********************************************************************
507 Glyph Pools
508 ***********************************************************************/
510 /* Glyph Pool.
512 Glyph memory for frame-based redisplay is allocated from the heap
513 in one vector kept in a glyph pool structure which is stored with
514 the frame. The size of the vector is made large enough to cover
515 all windows on the frame.
517 Both frame and window glyph matrices reference memory from a glyph
518 pool in frame-based redisplay.
520 In window-based redisplay, no glyphs pools exist; windows allocate
521 and free their glyph memory themselves. */
523 struct glyph_pool
525 /* Vector of glyphs allocated from the heap. */
526 struct glyph *glyphs;
528 /* Allocated size of `glyphs'. */
529 int nglyphs;
531 /* Number of rows and columns in a matrix. */
532 int nrows, ncolumns;
537 /***********************************************************************
538 Glyph Matrix
539 ***********************************************************************/
541 /* Glyph Matrix.
543 Three kinds of glyph matrices exist:
545 1. Frame glyph matrices. These are used for terminal frames whose
546 redisplay needs a view of the whole screen due to limited terminal
547 capabilities. Frame matrices are used only in the update phase
548 of redisplay. They are built in update_frame and not used after
549 the update has been performed.
551 2. Window glyph matrices on frames having frame glyph matrices.
552 Such matrices are sub-matrices of their corresponding frame matrix,
553 i.e. frame glyph matrices and window glyph matrices share the same
554 glyph memory which is allocated in form of a glyph_pool structure.
555 Glyph rows in such a window matrix are slices of frame matrix rows.
557 2. Free-standing window glyph matrices managing their own glyph
558 storage. This form is used in window-based redisplay which
559 includes variable width and height fonts etc.
561 The size of a window's row vector depends on the height of fonts
562 defined on its frame. It is chosen so that the vector is large
563 enough to describe all lines in a window when it is displayed in
564 the smallest possible character size. When new fonts are loaded,
565 or window sizes change, the row vector is adjusted accordingly. */
567 struct glyph_matrix
569 /* The pool from which glyph memory is allocated, if any. This is
570 null for frame matrices and for window matrices managing their
571 own storage. */
572 struct glyph_pool *pool;
574 /* Vector of glyph row structures. The row at nrows - 1 is reserved
575 for the mode line. */
576 struct glyph_row *rows;
578 /* Number of elements allocated for the vector rows above. */
579 int rows_allocated;
581 /* The number of rows used by the window if all lines were displayed
582 with the smallest possible character height. */
583 int nrows;
585 /* Origin within the frame matrix if this is a window matrix on a
586 frame having a frame matrix. Both values are zero for
587 window-based redisplay. */
588 int matrix_x, matrix_y;
590 /* Width and height of the matrix in columns and rows. */
591 int matrix_w, matrix_h;
593 /* If this structure describes a window matrix of window W,
594 window_left_col is the value of W->left_col, window_top_line the
595 value of W->top_line, window_height and window_width are width and
596 height of W, as returned by window_box, and window_vscroll is the
597 value of W->vscroll at the time the matrix was last adjusted.
598 Only set for window-based redisplay. */
599 int window_left_col, window_top_line;
600 int window_height, window_width;
601 int window_vscroll;
603 /* Number of glyphs reserved for left and right marginal areas when
604 the matrix was last adjusted. */
605 int left_margin_glyphs, right_margin_glyphs;
607 /* Flag indicating that scrolling should not be tried in
608 update_window. This flag is set by functions like try_window_id
609 which do their own scrolling. */
610 unsigned no_scrolling_p : 1;
612 /* Non-zero means window displayed in this matrix has a top mode
613 line. */
614 unsigned header_line_p : 1;
616 #ifdef GLYPH_DEBUG
617 /* A string identifying the method used to display the matrix. */
618 char method[512];
619 #endif
621 /* The buffer this matrix displays. Set in
622 mark_window_display_accurate_1. */
623 struct buffer *buffer;
625 /* Values of BEGV and ZV as of last redisplay. Set in
626 mark_window_display_accurate_1. */
627 int begv, zv;
631 /* Check that glyph pointers stored in glyph rows of MATRIX are okay.
632 This aborts if any pointer is found twice. */
634 #if GLYPH_DEBUG
635 void check_matrix_pointer_lossage P_ ((struct glyph_matrix *));
636 #define CHECK_MATRIX(MATRIX) check_matrix_pointer_lossage ((MATRIX))
637 #else
638 #define CHECK_MATRIX(MATRIX) (void) 0
639 #endif
643 /***********************************************************************
644 Glyph Rows
645 ***********************************************************************/
647 /* Area in window glyph matrix. If values are added or removed, the
648 function mark_object in alloc.c has to be changed. */
650 enum glyph_row_area
652 LEFT_MARGIN_AREA,
653 TEXT_AREA,
654 RIGHT_MARGIN_AREA,
655 LAST_AREA
659 /* Rows of glyphs in a windows or frame glyph matrix.
661 Each row is partitioned into three areas. The start and end of
662 each area is recorded in a pointer as shown below.
664 +--------------------+-------------+---------------------+
665 | left margin area | text area | right margin area |
666 +--------------------+-------------+---------------------+
667 | | | |
668 glyphs[LEFT_MARGIN_AREA] glyphs[RIGHT_MARGIN_AREA]
670 glyphs[TEXT_AREA] |
671 glyphs[LAST_AREA]
673 Rows in frame matrices reference glyph memory allocated in a frame
674 glyph pool (see the description of struct glyph_pool). Rows in
675 window matrices on frames having frame matrices reference slices of
676 the glyphs of corresponding rows in the frame matrix.
678 Rows in window matrices on frames having no frame matrices point to
679 glyphs allocated from the heap via xmalloc;
680 glyphs[LEFT_MARGIN_AREA] is the start address of the allocated
681 glyph structure array. */
683 struct glyph_row
685 /* Pointers to beginnings of areas. The end of an area A is found at
686 A + 1 in the vector. The last element of the vector is the end
687 of the whole row.
689 Kludge alert: Even if used[TEXT_AREA] == 0, glyphs[TEXT_AREA][0]'s
690 position field is used. It is -1 if this row does not correspond
691 to any text; it is some buffer position if the row corresponds to
692 an empty display line that displays a line end. This is what old
693 redisplay used to do. (Except in code for terminal frames, this
694 kludge is no longer used, I believe. --gerd).
696 See also start, end, displays_text_p and ends_at_zv_p for cleaner
697 ways to do it. The special meaning of positions 0 and -1 will be
698 removed some day, so don't use it in new code. */
699 struct glyph *glyphs[1 + LAST_AREA];
701 /* Number of glyphs actually filled in areas. */
702 short used[LAST_AREA];
704 /* Window-relative x and y-position of the top-left corner of this
705 row. If y < 0, this means that eabs (y) pixels of the row are
706 invisible because it is partially visible at the top of a window.
707 If x < 0, this means that eabs (x) pixels of the first glyph of
708 the text area of the row are invisible because the glyph is
709 partially visible. */
710 int x, y;
712 /* Width of the row in pixels without taking face extension at the
713 end of the row into account, and without counting truncation
714 and continuation glyphs at the end of a row on ttys. */
715 int pixel_width;
717 /* Logical ascent/height of this line. The value of ascent is zero
718 and height is 1 on terminal frames. */
719 int ascent, height;
721 /* Physical ascent/height of this line. If max_ascent > ascent,
722 this line overlaps the line above it on the display. Otherwise,
723 if max_height > height, this line overlaps the line beneath it. */
724 int phys_ascent, phys_height;
726 /* Portion of row that is visible. Partially visible rows may be
727 found at the top and bottom of a window. This is 1 for tty
728 frames. It may be < 0 in case of completely invisible rows. */
729 int visible_height;
731 /* Extra line spacing added after this row. Do not consider this
732 in last row when checking if row is fully visible. */
733 int extra_line_spacing;
735 /* Hash code. This hash code is available as soon as the row
736 is constructed, i.e. after a call to display_line. */
737 unsigned hash;
739 /* First position in this row. This is the text position, including
740 overlay position information etc, where the display of this row
741 started, and can thus be less the position of the first glyph
742 (e.g. due to invisible text or horizontal scrolling). */
743 struct display_pos start;
745 /* Text position at the end of this row. This is the position after
746 the last glyph on this row. It can be greater than the last
747 glyph position + 1, due to truncation, invisible text etc. In an
748 up-to-date display, this should always be equal to the start
749 position of the next row. */
750 struct display_pos end;
752 /* Non-zero means the overlay arrow bitmap is on this line.
753 -1 means use default overlay arrow bitmap, else
754 it specifies actual fringe bitmap number. */
755 int overlay_arrow_bitmap;
757 /* Left fringe bitmap number (enum fringe_bitmap_type). */
758 unsigned left_user_fringe_bitmap : FRINGE_ID_BITS;
760 /* Right fringe bitmap number (enum fringe_bitmap_type). */
761 unsigned right_user_fringe_bitmap : FRINGE_ID_BITS;
763 /* Left fringe bitmap number (enum fringe_bitmap_type). */
764 unsigned left_fringe_bitmap : FRINGE_ID_BITS;
766 /* Right fringe bitmap number (enum fringe_bitmap_type). */
767 unsigned right_fringe_bitmap : FRINGE_ID_BITS;
769 /* Face of the left fringe glyph. */
770 unsigned left_user_fringe_face_id : FACE_ID_BITS;
772 /* Face of the right fringe glyph. */
773 unsigned right_user_fringe_face_id : FACE_ID_BITS;
775 /* Face of the left fringe glyph. */
776 unsigned left_fringe_face_id : FACE_ID_BITS;
778 /* Face of the right fringe glyph. */
779 unsigned right_fringe_face_id : FACE_ID_BITS;
781 /* 1 means that we must draw the bitmaps of this row. */
782 unsigned redraw_fringe_bitmaps_p : 1;
784 /* In a desired matrix, 1 means that this row must be updated. In a
785 current matrix, 0 means that the row has been invalidated, i.e.
786 the row's contents do not agree with what is visible on the
787 screen. */
788 unsigned enabled_p : 1;
790 /* 1 means row displays a text line that is truncated on the left or
791 right side. */
792 unsigned truncated_on_left_p : 1;
793 unsigned truncated_on_right_p : 1;
795 /* 1 means that this row displays a continued line, i.e. it has a
796 continuation mark at the right side. */
797 unsigned continued_p : 1;
799 /* 0 means that this row does not contain any text, i.e. it is
800 a blank line at the window and buffer end. */
801 unsigned displays_text_p : 1;
803 /* 1 means that this line ends at ZV. */
804 unsigned ends_at_zv_p : 1;
806 /* 1 means the face of the last glyph in the text area is drawn to
807 the right end of the window. This flag is used in
808 update_text_area to optimize clearing to the end of the area. */
809 unsigned fill_line_p : 1;
811 /* Non-zero means display a bitmap on X frames indicating that this
812 line contains no text and ends in ZV. */
813 unsigned indicate_empty_line_p : 1;
815 /* 1 means this row contains glyphs that overlap each other because
816 of lbearing or rbearing. */
817 unsigned contains_overlapping_glyphs_p : 1;
819 /* 1 means this row is as wide as the window it is displayed in, including
820 scroll bars, fringes, and internal borders. This also
821 implies that the row doesn't have marginal areas. */
822 unsigned full_width_p : 1;
824 /* Non-zero means row is a mode or header-line. */
825 unsigned mode_line_p : 1;
827 /* 1 in a current row means this row is overlapped by another row. */
828 unsigned overlapped_p : 1;
830 /* 1 means this line ends in the middle of a character consisting
831 of more than one glyph. Some glyphs have been put in this row,
832 the rest are put in rows below this one. */
833 unsigned ends_in_middle_of_char_p : 1;
835 /* 1 means this line starts in the middle of a character consisting
836 of more than one glyph. Some glyphs have been put in the
837 previous row, the rest are put in this row. */
838 unsigned starts_in_middle_of_char_p : 1;
840 /* 1 in a current row means this row overlaps others. */
841 unsigned overlapping_p : 1;
843 /* 1 means some glyphs in this row are displayed in mouse-face. */
844 unsigned mouse_face_p : 1;
846 /* 1 means this row was ended by a newline from a string. */
847 unsigned ends_in_newline_from_string_p : 1;
849 /* 1 means this row width is exactly the width of the window, and the
850 final newline character is hidden in the right fringe. */
851 unsigned exact_window_width_line_p : 1;
853 /* 1 means this row currently shows the cursor in the right fringe. */
854 unsigned cursor_in_fringe_p : 1;
856 /* 1 means the last glyph in the row is part of an ellipsis. */
857 unsigned ends_in_ellipsis_p : 1;
859 /* Non-zero means display a bitmap on X frames indicating that this
860 the first line of the buffer. */
861 unsigned indicate_bob_p : 1;
863 /* Non-zero means display a bitmap on X frames indicating that this
864 the top line of the window, but not start of the buffer. */
865 unsigned indicate_top_line_p : 1;
867 /* Non-zero means display a bitmap on X frames indicating that this
868 the last line of the buffer. */
869 unsigned indicate_eob_p : 1;
871 /* Non-zero means display a bitmap on X frames indicating that this
872 the bottom line of the window, but not end of the buffer. */
873 unsigned indicate_bottom_line_p : 1;
875 /* Continuation lines width at the start of the row. */
876 int continuation_lines_width;
878 #ifdef HAVE_WINDOW_SYSTEM
879 /* Non-NULL means the current clipping area. This is temporarily
880 set while exposing a region. Coordinates are frame-relative. */
881 XRectangle *clip;
882 #endif
886 /* Get a pointer to row number ROW in matrix MATRIX. If GLYPH_DEBUG
887 is defined to a non-zero value, the function matrix_row checks that
888 we don't try to access rows that are out of bounds. */
890 #if GLYPH_DEBUG
891 struct glyph_row *matrix_row P_ ((struct glyph_matrix *, int));
892 #define MATRIX_ROW(MATRIX, ROW) matrix_row ((MATRIX), (ROW))
893 #else
894 #define MATRIX_ROW(MATRIX, ROW) ((MATRIX)->rows + (ROW))
895 #endif
897 /* Return a pointer to the row reserved for the mode line in MATRIX.
898 Row MATRIX->nrows - 1 is always reserved for the mode line. */
900 #define MATRIX_MODE_LINE_ROW(MATRIX) \
901 ((MATRIX)->rows + (MATRIX)->nrows - 1)
903 /* Return a pointer to the row reserved for the header line in MATRIX.
904 This is always the first row in MATRIX because that's the only
905 way that works in frame-based redisplay. */
907 #define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows
909 /* Return a pointer to first row in MATRIX used for text display. */
911 #define MATRIX_FIRST_TEXT_ROW(MATRIX) \
912 ((MATRIX)->rows->mode_line_p ? (MATRIX)->rows + 1 : (MATRIX)->rows)
914 /* Return a pointer to the first glyph in the text area of a row.
915 MATRIX is the glyph matrix accessed, and ROW is the row index in
916 MATRIX. */
918 #define MATRIX_ROW_GLYPH_START(MATRIX, ROW) \
919 (MATRIX_ROW ((MATRIX), (ROW))->glyphs[TEXT_AREA])
921 /* Return the number of used glyphs in the text area of a row. */
923 #define MATRIX_ROW_USED(MATRIX, ROW) \
924 (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA])
926 /* Return the character/ byte position at which the display of ROW
927 starts. */
929 #define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->start.pos.charpos)
930 #define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->start.pos.bytepos)
932 /* Return the character/ byte position at which ROW ends. */
934 #define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->end.pos.charpos)
935 #define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->end.pos.bytepos)
937 /* Return the vertical position of ROW in MATRIX. */
939 #define MATRIX_ROW_VPOS(ROW, MATRIX) ((ROW) - (MATRIX)->rows)
941 /* Return the last glyph row + 1 in MATRIX on window W reserved for
942 text. If W has a mode line, the last row in the matrix is reserved
943 for it. */
945 #define MATRIX_BOTTOM_TEXT_ROW(MATRIX, W) \
946 ((MATRIX)->rows \
947 + (MATRIX)->nrows \
948 - (WINDOW_WANTS_MODELINE_P ((W)) ? 1 : 0))
950 /* Non-zero if the face of the last glyph in ROW's text area has
951 to be drawn to the end of the text area. */
953 #define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)
955 /* Set and query the enabled_p flag of glyph row ROW in MATRIX. */
957 #define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
958 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0)
960 #define MATRIX_ROW_ENABLED_P(MATRIX, ROW) \
961 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p)
963 /* Non-zero if ROW displays text. Value is non-zero if the row is
964 blank but displays a line end. */
966 #define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)
969 /* Helper macros */
971 #define MR_PARTIALLY_VISIBLE(ROW) \
972 ((ROW)->height != (ROW)->visible_height)
974 #define MR_PARTIALLY_VISIBLE_AT_TOP(W, ROW) \
975 ((ROW)->y < WINDOW_HEADER_LINE_HEIGHT ((W)))
977 #define MR_PARTIALLY_VISIBLE_AT_BOTTOM(W, ROW) \
978 (((ROW)->y + (ROW)->height - (ROW)->extra_line_spacing) \
979 > WINDOW_BOX_HEIGHT_NO_MODE_LINE ((W)))
981 /* Non-zero if ROW is not completely visible in window W. */
983 #define MATRIX_ROW_PARTIALLY_VISIBLE_P(W, ROW) \
984 (MR_PARTIALLY_VISIBLE ((ROW)) \
985 && (MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)) \
986 || MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW))))
990 /* Non-zero if ROW is partially visible at the top of window W. */
992 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW) \
993 (MR_PARTIALLY_VISIBLE ((ROW)) \
994 && MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)))
996 /* Non-zero if ROW is partially visible at the bottom of window W. */
998 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW) \
999 (MR_PARTIALLY_VISIBLE ((ROW)) \
1000 && MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW)))
1002 /* Return the bottom Y + 1 of ROW. */
1004 #define MATRIX_ROW_BOTTOM_Y(ROW) ((ROW)->y + (ROW)->height)
1006 /* Is ROW the last visible one in the display described by the
1007 iterator structure pointed to by IT?. */
1009 #define MATRIX_ROW_LAST_VISIBLE_P(ROW, IT) \
1010 (MATRIX_ROW_BOTTOM_Y ((ROW)) >= (IT)->last_visible_y)
1012 /* Non-zero if ROW displays a continuation line. */
1014 #define MATRIX_ROW_CONTINUATION_LINE_P(ROW) \
1015 ((ROW)->continuation_lines_width > 0)
1017 /* Non-zero if ROW ends in the middle of a character. This is the
1018 case for continued lines showing only part of a display table entry
1019 or a control char, or an overlay string. */
1021 #define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW) \
1022 ((ROW)->end.dpvec_index > 0 \
1023 || (ROW)->end.overlay_string_index >= 0 \
1024 || (ROW)->ends_in_middle_of_char_p)
1026 /* Non-zero if ROW ends in the middle of an overlay string. */
1028 #define MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P(ROW) \
1029 ((ROW)->end.overlay_string_index >= 0)
1031 /* Non-zero if ROW starts in the middle of a character. See above. */
1033 #define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW) \
1034 ((ROW)->start.dpvec_index > 0 \
1035 || (ROW)->starts_in_middle_of_char_p \
1036 || ((ROW)->start.overlay_string_index >= 0 \
1037 && (ROW)->start.string_pos.charpos > 0))
1039 /* Non-zero means ROW overlaps its predecessor. */
1041 #define MATRIX_ROW_OVERLAPS_PRED_P(ROW) \
1042 ((ROW)->phys_ascent > (ROW)->ascent)
1044 /* Non-zero means ROW overlaps its successor. */
1046 #define MATRIX_ROW_OVERLAPS_SUCC_P(ROW) \
1047 ((ROW)->phys_height - (ROW)->phys_ascent \
1048 > (ROW)->height - (ROW)->ascent)
1050 /* Non-zero means that fonts have been loaded since the last glyph
1051 matrix adjustments. The function redisplay_internal adjusts glyph
1052 matrices when this flag is non-zero. */
1054 extern int fonts_changed_p;
1056 /* A glyph for a space. */
1058 extern struct glyph space_glyph;
1060 /* Window being updated by update_window. This is non-null as long as
1061 update_window has not finished, and null otherwise. */
1063 extern struct window *updated_window;
1065 /* Glyph row and area updated by update_window_line. */
1067 extern struct glyph_row *updated_row;
1068 extern int updated_area;
1070 /* Non-zero means reading single-character input with prompt so put
1071 cursor on mini-buffer after the prompt. Positive means at end of
1072 text in echo area; negative means at beginning of line. */
1074 extern int cursor_in_echo_area;
1076 /* Non-zero means last display completed. Zero means it was
1077 preempted. */
1079 extern int display_completed;
1081 /* Non-zero means redisplay has been performed directly (see also
1082 direct_output_for_insert and direct_output_forward_char), so that
1083 no further updating has to be performed. The function
1084 redisplay_internal checks this flag, and does nothing but reset it
1085 to zero if it is non-zero. */
1087 extern int redisplay_performed_directly_p;
1089 /* A temporary storage area, including a row of glyphs. Initialized
1090 in xdisp.c. Used for various purposes, as an example see
1091 direct_output_for_insert. */
1093 extern struct glyph_row scratch_glyph_row;
1097 /************************************************************************
1098 Glyph Strings
1099 ************************************************************************/
1101 /* Enumeration for overriding/changing the face to use for drawing
1102 glyphs in draw_glyphs. */
1104 enum draw_glyphs_face
1106 DRAW_NORMAL_TEXT,
1107 DRAW_INVERSE_VIDEO,
1108 DRAW_CURSOR,
1109 DRAW_MOUSE_FACE,
1110 DRAW_IMAGE_RAISED,
1111 DRAW_IMAGE_SUNKEN
1114 #ifdef HAVE_WINDOW_SYSTEM
1116 /* A sequence of glyphs to be drawn in the same face. */
1118 struct glyph_string
1120 /* X-origin of the string. */
1121 int x;
1123 /* Y-origin and y-position of the base line of this string. */
1124 int y, ybase;
1126 /* The width of the string, not including a face extension. */
1127 int width;
1129 /* The width of the string, including a face extension. */
1130 int background_width;
1132 /* The height of this string. This is the height of the line this
1133 string is drawn in, and can be different from the height of the
1134 font the string is drawn in. */
1135 int height;
1137 /* Number of pixels this string overwrites in front of its x-origin.
1138 This number is zero if the string has an lbearing >= 0; it is
1139 -lbearing, if the string has an lbearing < 0. */
1140 int left_overhang;
1142 /* Number of pixels this string overwrites past its right-most
1143 nominal x-position, i.e. x + width. Zero if the string's
1144 rbearing is <= its nominal width, rbearing - width otherwise. */
1145 int right_overhang;
1147 /* The frame on which the glyph string is drawn. */
1148 struct frame *f;
1150 /* The window on which the glyph string is drawn. */
1151 struct window *w;
1153 /* X display and window for convenience. */
1154 Display *display;
1155 Window window;
1157 /* The glyph row for which this string was built. It determines the
1158 y-origin and height of the string. */
1159 struct glyph_row *row;
1161 /* The area within row. */
1162 enum glyph_row_area area;
1164 /* Characters to be drawn, and number of characters. */
1165 XChar2b *char2b;
1166 int nchars;
1168 /* A face-override for drawing cursors, mouse face and similar. */
1169 enum draw_glyphs_face hl;
1171 /* Face in which this string is to be drawn. */
1172 struct face *face;
1174 /* Font in which this string is to be drawn. */
1175 struct font *font;
1177 /* Non-null means this string describes (part of) a static
1178 composition. */
1179 struct composition *cmp;
1181 /* If not negative, this string describes a compos. */
1182 int cmp_id;
1184 /* Start and end glyph indices in a glyph-string. */
1185 int cmp_from, cmp_to;
1187 /* 1 means this glyph strings face has to be drawn to the right end
1188 of the window's drawing area. */
1189 unsigned extends_to_end_of_line_p : 1;
1191 /* 1 means the background of this string has been drawn. */
1192 unsigned background_filled_p : 1;
1194 /* 1 means glyph string must be drawn with 16-bit functions. */
1195 unsigned two_byte_p : 1;
1197 /* 1 means that the original font determined for drawing this glyph
1198 string could not be loaded. The member `font' has been set to
1199 the frame's default font in this case. */
1200 unsigned font_not_found_p : 1;
1202 /* 1 means that the face in which this glyph string is drawn has a
1203 stipple pattern. */
1204 unsigned stippled_p : 1;
1206 #define OVERLAPS_PRED (1 << 0)
1207 #define OVERLAPS_SUCC (1 << 1)
1208 #define OVERLAPS_BOTH (OVERLAPS_PRED | OVERLAPS_SUCC)
1209 #define OVERLAPS_ERASED_CURSOR (1 << 2)
1210 /* Non-zero means only the foreground of this glyph string must be
1211 drawn, and we should use the physical height of the line this
1212 glyph string appears in as clip rect. If the value is
1213 OVERLAPS_ERASED_CURSOR, the clip rect is restricted to the rect
1214 of the erased cursor. OVERLAPS_PRED and OVERLAPS_SUCC mean we
1215 draw overlaps with the preceding and the succeeding rows,
1216 respectively. */
1217 unsigned for_overlaps : 3;
1219 /* 1 means that all glyphs in this glyph string has the flag
1220 padding_p set, and thus must be drawn one by one to have 1-pixel
1221 width even though the logical width in the font is zero. */
1222 unsigned padding_p : 1;
1224 /* The GC to use for drawing this glyph string. */
1225 #if defined(HAVE_X_WINDOWS)
1226 GC gc;
1227 #endif
1228 #if defined(HAVE_NTGUI)
1229 XGCValues *gc;
1230 HDC hdc;
1231 #endif
1233 /* A pointer to the first glyph in the string. This glyph
1234 corresponds to char2b[0]. Needed to draw rectangles if
1235 font_not_found_p is 1. */
1236 struct glyph *first_glyph;
1238 /* Image, if any. */
1239 struct image *img;
1241 /* Slice */
1242 struct glyph_slice slice;
1244 /* Non-null means the horizontal clipping region starts from the
1245 left edge of *clip_head, and ends with the right edge of
1246 *clip_tail, not including their overhangs. */
1247 struct glyph_string *clip_head, *clip_tail;
1249 /* The current clipping areas. */
1250 NativeRectangle clip[2];
1252 /* Number of clipping areas. */
1253 int num_clips;
1255 int underline_position;
1257 int underline_thickness;
1259 struct glyph_string *next, *prev;
1262 #endif /* HAVE_WINDOW_SYSTEM */
1265 /************************************************************************
1266 Display Dimensions
1267 ************************************************************************/
1269 /* Return the height of the mode line in glyph matrix MATRIX, or zero
1270 if not known. This macro is called under circumstances where
1271 MATRIX might not have been allocated yet. */
1273 #define MATRIX_MODE_LINE_HEIGHT(MATRIX) \
1274 ((MATRIX) && (MATRIX)->rows \
1275 ? MATRIX_MODE_LINE_ROW (MATRIX)->height \
1276 : 0)
1278 /* Return the height of the header line in glyph matrix MATRIX, or zero
1279 if not known. This macro is called under circumstances where
1280 MATRIX might not have been allocated yet. */
1282 #define MATRIX_HEADER_LINE_HEIGHT(MATRIX) \
1283 ((MATRIX) && (MATRIX)->rows \
1284 ? MATRIX_HEADER_LINE_ROW (MATRIX)->height \
1285 : 0)
1287 /* Return the desired face id for the mode line of a window, depending
1288 on whether the window is selected or not, or if the window is the
1289 scrolling window for the currently active minibuffer window.
1291 Due to the way display_mode_lines manipulates with the contents of
1292 selected_window, this macro needs three arguments: SELW which is
1293 compared against the current value of selected_window, MBW which is
1294 compared against minibuf_window (if SELW doesn't match), and SCRW
1295 which is compared against minibuf_selected_window (if MBW matches). */
1297 #define CURRENT_MODE_LINE_FACE_ID_3(SELW, MBW, SCRW) \
1298 ((!mode_line_in_non_selected_windows \
1299 || (SELW) == XWINDOW (selected_window) \
1300 || (minibuf_level > 0 \
1301 && !NILP (minibuf_selected_window) \
1302 && (MBW) == XWINDOW (minibuf_window) \
1303 && (SCRW) == XWINDOW (minibuf_selected_window))) \
1304 ? MODE_LINE_FACE_ID \
1305 : MODE_LINE_INACTIVE_FACE_ID)
1308 /* Return the desired face id for the mode line of window W. */
1310 #define CURRENT_MODE_LINE_FACE_ID(W) \
1311 (CURRENT_MODE_LINE_FACE_ID_3((W), XWINDOW (selected_window), (W)))
1313 /* Return the current height of the mode line of window W. If not
1314 known from current_mode_line_height, look at W's current glyph
1315 matrix, or return a default based on the height of the font of the
1316 face `mode-line'. */
1318 #define CURRENT_MODE_LINE_HEIGHT(W) \
1319 (current_mode_line_height >= 0 \
1320 ? current_mode_line_height \
1321 : (MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1322 ? MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1323 : estimate_mode_line_height (XFRAME ((W)->frame), \
1324 CURRENT_MODE_LINE_FACE_ID (W))))
1326 /* Return the current height of the header line of window W. If not
1327 known from current_header_line_height, look at W's current glyph
1328 matrix, or return an estimation based on the height of the font of
1329 the face `header-line'. */
1331 #define CURRENT_HEADER_LINE_HEIGHT(W) \
1332 (current_header_line_height >= 0 \
1333 ? current_header_line_height \
1334 : (MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1335 ? MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1336 : estimate_mode_line_height (XFRAME ((W)->frame), \
1337 HEADER_LINE_FACE_ID)))
1339 /* Return the height of the desired mode line of window W. */
1341 #define DESIRED_MODE_LINE_HEIGHT(W) \
1342 MATRIX_MODE_LINE_HEIGHT ((W)->desired_matrix)
1344 /* Return the height of the desired header line of window W. */
1346 #define DESIRED_HEADER_LINE_HEIGHT(W) \
1347 MATRIX_HEADER_LINE_HEIGHT ((W)->desired_matrix)
1349 /* Value is non-zero if window W wants a mode line. */
1351 #define WINDOW_WANTS_MODELINE_P(W) \
1352 (!MINI_WINDOW_P ((W)) \
1353 && !(W)->pseudo_window_p \
1354 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1355 && BUFFERP ((W)->buffer) \
1356 && !NILP (XBUFFER ((W)->buffer)->mode_line_format) \
1357 && WINDOW_TOTAL_LINES (W) > 1)
1359 /* Value is non-zero if window W wants a header line. */
1361 #define WINDOW_WANTS_HEADER_LINE_P(W) \
1362 (!MINI_WINDOW_P ((W)) \
1363 && !(W)->pseudo_window_p \
1364 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1365 && BUFFERP ((W)->buffer) \
1366 && !NILP (XBUFFER ((W)->buffer)->header_line_format) \
1367 && WINDOW_TOTAL_LINES (W) > 1 + !NILP (XBUFFER ((W)->buffer)->mode_line_format))
1370 /* Return proper value to be used as baseline offset of font that has
1371 ASCENT and DESCENT to draw characters by the font at the vertical
1372 center of the line of frame F.
1374 Here, our task is to find the value of BOFF in the following figure;
1376 -------------------------+-----------+-
1377 -+-+---------+-+ | |
1378 | | | | | |
1379 | | | | F_ASCENT F_HEIGHT
1380 | | | ASCENT | |
1381 HEIGHT | | | | |
1382 | | |-|-+------+-----------|------- baseline
1383 | | | | BOFF | |
1384 | |---------|-+-+ | |
1385 | | | DESCENT | |
1386 -+-+---------+-+ F_DESCENT |
1387 -------------------------+-----------+-
1389 -BOFF + DESCENT + (F_HEIGHT - HEIGHT) / 2 = F_DESCENT
1390 BOFF = DESCENT + (F_HEIGHT - HEIGHT) / 2 - F_DESCENT
1391 DESCENT = FONT->descent
1392 HEIGHT = FONT_HEIGHT (FONT)
1393 F_DESCENT = (FRAME_FONT (F)->descent
1394 - F->terminal->output_data.x->baseline_offset)
1395 F_HEIGHT = FRAME_LINE_HEIGHT (F)
1398 #define VCENTER_BASELINE_OFFSET(FONT, F) \
1399 (FONT_DESCENT (FONT) \
1400 + (FRAME_LINE_HEIGHT ((F)) - FONT_HEIGHT ((FONT)) \
1401 + (FRAME_LINE_HEIGHT ((F)) > FONT_HEIGHT ((FONT)))) / 2 \
1402 - (FONT_DESCENT (FRAME_FONT (F)) - FRAME_BASELINE_OFFSET (F)))
1405 /***********************************************************************
1406 Faces
1407 ***********************************************************************/
1409 /* Indices of face attributes in Lisp face vectors. Slot zero is the
1410 symbol `face'. */
1412 enum lface_attribute_index
1414 LFACE_FAMILY_INDEX = 1,
1415 LFACE_FOUNDRY_INDEX,
1416 LFACE_SWIDTH_INDEX,
1417 LFACE_HEIGHT_INDEX,
1418 LFACE_WEIGHT_INDEX,
1419 LFACE_SLANT_INDEX,
1420 LFACE_UNDERLINE_INDEX,
1421 LFACE_INVERSE_INDEX,
1422 LFACE_FOREGROUND_INDEX,
1423 LFACE_BACKGROUND_INDEX,
1424 LFACE_STIPPLE_INDEX,
1425 LFACE_OVERLINE_INDEX,
1426 LFACE_STRIKE_THROUGH_INDEX,
1427 LFACE_BOX_INDEX,
1428 LFACE_FONT_INDEX,
1429 LFACE_INHERIT_INDEX,
1430 LFACE_FONTSET_INDEX,
1431 LFACE_VECTOR_SIZE
1435 /* Box types of faces. */
1437 enum face_box_type
1439 /* No box around text. */
1440 FACE_NO_BOX,
1442 /* Simple box of specified width and color. Default width is 1, and
1443 default color is the foreground color of the face. */
1444 FACE_SIMPLE_BOX,
1446 /* Boxes with 3D shadows. Color equals the background color of the
1447 face. Width is specified. */
1448 FACE_RAISED_BOX,
1449 FACE_SUNKEN_BOX
1453 /* Structure describing a realized face.
1455 For each Lisp face, 0..N realized faces can exist for different
1456 frames and different charsets. Realized faces are built from Lisp
1457 faces and text properties/overlays by merging faces and adding
1458 unspecified attributes from the `default' face. */
1460 struct face
1462 /* The id of this face. The id equals the index of this face in the
1463 vector faces_by_id of its face cache. */
1464 int id;
1466 #ifdef HAVE_WINDOW_SYSTEM
1468 /* If non-zero, this is a GC that we can use without modification for
1469 drawing the characters in this face. */
1470 GC gc;
1472 /* Background stipple or bitmap used for this face. This is
1473 an id as returned from load_pixmap. */
1474 int stipple;
1476 #else /* not HAVE_WINDOW_SYSTEM */
1478 /* Dummy. */
1479 int stipple;
1481 #endif /* not HAVE_WINDOW_SYSTEM */
1483 /* Pixel value of foreground color for X frames. Color index
1484 for tty frames. */
1485 unsigned long foreground;
1487 /* Pixel value or color index of background color. */
1488 unsigned long background;
1490 /* Pixel value or color index of underline color. */
1491 unsigned long underline_color;
1493 /* Pixel value or color index of overlined, strike-through, or box
1494 color. */
1495 unsigned long overline_color;
1496 unsigned long strike_through_color;
1497 unsigned long box_color;
1499 struct font *font;
1501 /* Fontset ID if for this face's fontset. Non-ASCII faces derived
1502 from the same ASCII face have the same fontset. */
1503 int fontset;
1505 /* Pixmap width and height. */
1506 unsigned int pixmap_w, pixmap_h;
1508 /* Non-zero means characters in this face have a box that thickness
1509 around them. If it is negative, the absolute value indicates the
1510 thickness, and the horizontal lines of box (top and bottom) are
1511 drawn inside of characters glyph area. The vertical lines of box
1512 (left and right) are drawn as the same way as the case that this
1513 value is positive. */
1514 int box_line_width;
1516 /* Type of box drawn. A value of FACE_NO_BOX means no box is drawn
1517 around text in this face. A value of FACE_SIMPLE_BOX means a box
1518 of width box_line_width is drawn in color box_color. A value of
1519 FACE_RAISED_BOX or FACE_SUNKEN_BOX means a 3D box is drawn with
1520 shadow colors derived from the background color of the face. */
1521 enum face_box_type box;
1523 /* If `box' above specifies a 3D type, 1 means use box_color for
1524 drawing shadows. */
1525 unsigned use_box_color_for_shadows_p : 1;
1527 /* Non-zero if text in this face should be underlined, overlined,
1528 strike-through or have a box drawn around it. */
1529 unsigned underline_p : 1;
1530 unsigned overline_p : 1;
1531 unsigned strike_through_p : 1;
1533 /* 1 means that the colors specified for this face could not be
1534 loaded, and were replaced by default colors, so they shouldn't be
1535 freed. */
1536 unsigned foreground_defaulted_p : 1;
1537 unsigned background_defaulted_p : 1;
1539 /* 1 means that either no color is specified for underlining or that
1540 the specified color couldn't be loaded. Use the foreground
1541 color when drawing in that case. */
1542 unsigned underline_defaulted_p : 1;
1544 /* 1 means that either no color is specified for the corresponding
1545 attribute or that the specified color couldn't be loaded.
1546 Use the foreground color when drawing in that case. */
1547 unsigned overline_color_defaulted_p : 1;
1548 unsigned strike_through_color_defaulted_p : 1;
1549 unsigned box_color_defaulted_p : 1;
1551 /* TTY appearances. Blinking is not yet implemented. Colors are
1552 found in `lface' with empty color string meaning the default
1553 color of the TTY. */
1554 unsigned tty_bold_p : 1;
1555 unsigned tty_dim_p : 1;
1556 unsigned tty_underline_p : 1;
1557 unsigned tty_alt_charset_p : 1;
1558 unsigned tty_reverse_p : 1;
1559 unsigned tty_blinking_p : 1;
1561 /* 1 means that colors of this face may not be freed because they
1562 have been copied bitwise from a base face (see
1563 realize_x_face). */
1564 unsigned colors_copied_bitwise_p : 1;
1566 /* If non-zero, use overstrike (to simulate bold-face). */
1567 unsigned overstrike : 1;
1569 /* NOTE: this is not used yet, but eventually this impl should be done
1570 similarly to overstrike */
1571 #ifdef HAVE_NS
1572 /* If non-zero, use geometric rotation (to simulate italic). */
1573 unsigned synth_ital : 1;
1574 #endif
1576 /* The Lisp face attributes this face realizes. All attributes
1577 in this vector are non-nil. */
1578 Lisp_Object lface[LFACE_VECTOR_SIZE];
1580 /* The hash value of this face. */
1581 unsigned hash;
1583 /* Next and previous face in hash collision list of face cache. */
1584 struct face *next, *prev;
1586 /* If this face is an ASCII face, this points to this face itself.
1587 Otherwise, this points to an ASCII face that has the same
1588 attributes except the font. */
1589 struct face *ascii_face;
1591 /* Extra member that a font-driver uses privately. */
1592 void *extra;
1596 /* Color index indicating that face uses a terminal's default color. */
1598 #define FACE_TTY_DEFAULT_COLOR ((unsigned long) -1)
1600 /* Color index indicating that face uses an unknown foreground color. */
1602 #define FACE_TTY_DEFAULT_FG_COLOR ((unsigned long) -2)
1604 /* Color index indicating that face uses an unknown background color. */
1606 #define FACE_TTY_DEFAULT_BG_COLOR ((unsigned long) -3)
1608 /* Non-zero if FACE was realized for unibyte use. */
1610 #define FACE_UNIBYTE_P(FACE) ((FACE)->charset < 0)
1613 /* IDs of important faces known by the C face code. These are the IDs
1614 of the faces for CHARSET_ASCII. */
1616 enum face_id
1618 DEFAULT_FACE_ID,
1619 MODE_LINE_FACE_ID,
1620 MODE_LINE_INACTIVE_FACE_ID,
1621 TOOL_BAR_FACE_ID,
1622 FRINGE_FACE_ID,
1623 HEADER_LINE_FACE_ID,
1624 SCROLL_BAR_FACE_ID,
1625 BORDER_FACE_ID,
1626 CURSOR_FACE_ID,
1627 MOUSE_FACE_ID,
1628 MENU_FACE_ID,
1629 VERTICAL_BORDER_FACE_ID,
1630 BASIC_FACE_ID_SENTINEL
1633 #define MAX_FACE_ID ((1 << FACE_ID_BITS) - 1)
1635 /* A cache of realized faces. Each frame has its own cache because
1636 Emacs allows different frame-local face definitions. */
1638 struct face_cache
1640 /* Hash table of cached realized faces. */
1641 struct face **buckets;
1643 /* Back-pointer to the frame this cache belongs to. */
1644 struct frame *f;
1646 /* A vector of faces so that faces can be referenced by an ID. */
1647 struct face **faces_by_id;
1649 /* The allocated size, and number of used slots of faces_by_id. */
1650 int size, used;
1652 /* Flag indicating that attributes of the `menu' face have been
1653 changed. */
1654 unsigned menu_face_changed_p : 1;
1658 /* Prepare face FACE for use on frame F. This must be called before
1659 using X resources of FACE. */
1661 #define PREPARE_FACE_FOR_DISPLAY(F, FACE) \
1662 if ((FACE)->gc == 0) \
1663 prepare_face_for_display ((F), (FACE)); \
1664 else \
1665 (void) 0
1667 /* Return a pointer to the face with ID on frame F, or null if such a
1668 face doesn't exist. */
1670 #define FACE_FROM_ID(F, ID) \
1671 (((unsigned) (ID) < FRAME_FACE_CACHE (F)->used) \
1672 ? FRAME_FACE_CACHE (F)->faces_by_id[ID] \
1673 : NULL)
1675 #ifdef HAVE_WINDOW_SYSTEM
1677 /* Non-zero if FACE is suitable for displaying character CHAR. */
1679 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) \
1680 (ASCII_CHAR_P (CHAR) \
1681 ? (FACE) == (FACE)->ascii_face \
1682 : face_suitable_for_char_p ((FACE), (CHAR)))
1684 /* Return the id of the realized face on frame F that is like the face
1685 with id ID but is suitable for displaying character CHAR.
1686 This macro is only meaningful for multibyte character CHAR. */
1688 #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) \
1689 (ASCII_CHAR_P (CHAR) \
1690 ? (FACE)->ascii_face->id \
1691 : face_for_char ((F), (FACE), (CHAR), (POS), (OBJECT)))
1693 #else /* not HAVE_WINDOW_SYSTEM */
1695 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) 1
1696 #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) ((FACE)->id)
1698 #endif /* not HAVE_WINDOW_SYSTEM */
1700 /* Non-zero means face attributes have been changed since the last
1701 redisplay. Used in redisplay_internal. */
1703 extern int face_change_count;
1708 /***********************************************************************
1709 Fringes
1710 ***********************************************************************/
1712 /* Structure used to describe where and how to draw a fringe bitmap.
1713 WHICH is the fringe bitmap to draw. WD and H is the (adjusted)
1714 width and height of the bitmap, DH is the height adjustment (if
1715 bitmap is periodic). X and Y are frame coordinates of the area to
1716 display the bitmap, DY is relative offset of the bitmap into that
1717 area. BX, NX, BY, NY specifies the area to clear if the bitmap
1718 does not fill the entire area. FACE is the fringe face. */
1720 struct draw_fringe_bitmap_params
1722 int which; /* enum fringe_bitmap_type */
1723 unsigned short *bits;
1724 int wd, h, dh;
1725 int x, y;
1726 int bx, nx, by, ny;
1727 unsigned cursor_p : 1;
1728 unsigned overlay_p : 1;
1729 struct face *face;
1732 #define MAX_FRINGE_BITMAPS (1<<FRINGE_ID_BITS)
1735 /***********************************************************************
1736 Display Iterator
1737 ***********************************************************************/
1739 /* Iteration over things to display in current_buffer or in a string.
1741 The iterator handles:
1743 1. Overlay strings (after-string, before-string).
1744 2. Face properties.
1745 3. Invisible text properties.
1746 4. Selective display.
1747 5. Translation of characters via display tables.
1748 6. Translation of control characters to the forms `\003' or `^C'.
1749 7. `glyph' and `space-width' properties.
1751 Iterators are initialized by calling init_iterator or one of the
1752 equivalent functions below. A call to get_next_display_element
1753 loads the iterator structure with information about what next to
1754 display. A call to set_iterator_to_next increments the iterator's
1755 position.
1757 Characters from overlay strings, display table entries or control
1758 character translations are returned one at a time. For example, if
1759 we have a text of `a\x01' where `a' has a display table definition
1760 of `cd' and the control character is displayed with a leading
1761 arrow, then the iterator will return:
1763 Call Return Source Call next
1764 -----------------------------------------------------------------
1765 next c display table move
1766 next d display table move
1767 next ^ control char move
1768 next A control char move
1770 The same mechanism is also used to return characters for ellipses
1771 displayed at the end of invisible text.
1773 CAVEAT: Under some circumstances, move_.* functions can be called
1774 asynchronously, e.g. when computing a buffer position from an x and
1775 y pixel position. This means that these functions and functions
1776 called from them SHOULD NOT USE xmalloc and alike. See also the
1777 comment at the start of xdisp.c. */
1779 /* Enumeration describing what kind of display element an iterator is
1780 loaded with after a call to get_next_display_element. */
1782 enum display_element_type
1784 /* A normal character. */
1785 IT_CHARACTER,
1787 /* A composition (static and automatic). */
1788 IT_COMPOSITION,
1790 /* An image. */
1791 IT_IMAGE,
1793 /* A flexible width and height space. */
1794 IT_STRETCH,
1796 /* End of buffer or string. */
1797 IT_EOB,
1799 /* Truncation glyphs. Never returned by get_next_display_element.
1800 Used to get display information about truncation glyphs via
1801 produce_glyphs. */
1802 IT_TRUNCATION,
1804 /* Continuation glyphs. See the comment for IT_TRUNCATION. */
1805 IT_CONTINUATION
1809 /* An enumerator for each text property that has a meaning for display
1810 purposes. */
1812 enum prop_idx
1814 AUTO_COMPOSED_PROP_IDX,
1815 FONTIFIED_PROP_IDX,
1816 FACE_PROP_IDX,
1817 INVISIBLE_PROP_IDX,
1818 DISPLAY_PROP_IDX,
1819 COMPOSITION_PROP_IDX,
1821 /* Not a property. Used to indicate changes in overlays. */
1822 OVERLAY_PROP_IDX,
1824 /* Sentinel. */
1825 LAST_PROP_IDX
1828 /* An enumerator for the method of wrapping long lines. */
1830 enum line_wrap_method
1832 TRUNCATE,
1833 WORD_WRAP,
1834 WINDOW_WRAP
1837 struct it_slice
1839 Lisp_Object x;
1840 Lisp_Object y;
1841 Lisp_Object width;
1842 Lisp_Object height;
1845 /* Input sources for fetching characters or data to display.
1846 The input source is found in the `method' field. */
1848 enum it_method {
1849 GET_FROM_BUFFER = 0,
1850 GET_FROM_DISPLAY_VECTOR,
1851 GET_FROM_STRING,
1852 GET_FROM_C_STRING,
1853 GET_FROM_IMAGE,
1854 GET_FROM_STRETCH,
1855 NUM_IT_METHODS
1858 #define IT_STACK_SIZE 4
1860 /* Iterator for composition (both for static and automatic). */
1861 struct composition_it
1863 /* Next position at which to check the composition. */
1864 EMACS_INT stop_pos;
1865 /* ID number of the composition or glyph-string. If negative, we
1866 are not iterating over a composition now. */
1867 int id;
1868 /* If non-negative, character that triggers the automatic
1869 composition at `stop_pos', and this is an automatic compositoin.
1870 If negative, this is a static composition. This is set to -2
1871 temporarily if searching of composition reach a limit or a
1872 newline. */
1873 int ch;
1874 /* If this an automatic composition, how many characters to look back
1875 from the position where a character triggering the composition
1876 exists. */
1877 int lookback;
1878 /* If non-negative, number of glyphs of the glyph-string. */
1879 int nglyphs;
1880 /* Number of characters and bytes of the current grapheme cluster. */
1881 int nchars, nbytes;
1882 /* Indices of the glyphs for the current grapheme cluster. */
1883 int from, to;
1884 /* Width of the current grapheme cluster in units of pixels on a
1885 graphic display and in units of canonical characters on a
1886 terminal display. */
1887 int width;
1890 struct it
1892 /* The window in which we iterate over current_buffer (or a string). */
1893 Lisp_Object window;
1894 struct window *w;
1896 /* The window's frame. */
1897 struct frame *f;
1899 /* Method to use to load this structure with the next display element. */
1900 enum it_method method;
1902 /* The next position at which to check for face changes, invisible
1903 text, overlay strings, end of text etc., which see. */
1904 int stop_charpos;
1906 /* Maximum string or buffer position + 1. ZV when iterating over
1907 current_buffer. */
1908 int end_charpos;
1910 /* C string to iterate over. Non-null means get characters from
1911 this string, otherwise characters are read from current_buffer
1912 or it->string. */
1913 unsigned char *s;
1915 /* Number of characters in the string (s, or it->string) we iterate
1916 over. */
1917 int string_nchars;
1919 /* Start and end of a visible region; -1 if the region is not
1920 visible in the window. */
1921 int region_beg_charpos, region_end_charpos;
1923 /* Position at which redisplay end trigger functions should be run. */
1924 int redisplay_end_trigger_charpos;
1926 /* 1 means multibyte characters are enabled. */
1927 unsigned multibyte_p : 1;
1929 /* 1 means window has a mode line at its top. */
1930 unsigned header_line_p : 1;
1932 /* 1 means `string' is the value of a `display' property.
1933 Don't handle some `display' properties in these strings. */
1934 unsigned string_from_display_prop_p : 1;
1936 /* When METHOD == next_element_from_display_vector,
1937 this is 1 if we're doing an ellipsis. Otherwise meaningless. */
1938 unsigned ellipsis_p : 1;
1940 /* True means cursor shouldn't be displayed here. */
1941 unsigned avoid_cursor_p : 1;
1943 /* Display table in effect or null for none. */
1944 struct Lisp_Char_Table *dp;
1946 /* Current display table vector to return characters from and its
1947 end. dpvec null means we are not returning characters from a
1948 display table entry; current.dpvec_index gives the current index
1949 into dpvec. This same mechanism is also used to return
1950 characters from translated control characters, i.e. `\003' or
1951 `^C'. */
1952 Lisp_Object *dpvec, *dpend;
1954 /* Length in bytes of the char that filled dpvec. A value of zero
1955 means that no such character is involved. */
1956 int dpvec_char_len;
1958 /* Face id to use for all characters in display vector. -1 if unused. */
1959 int dpvec_face_id;
1961 /* Face id of the iterator saved in case a glyph from dpvec contains
1962 a face. The face is restored when all glyphs from dpvec have
1963 been delivered. */
1964 int saved_face_id;
1966 /* Vector of glyphs for control character translation. The pointer
1967 dpvec is set to ctl_chars when a control character is translated.
1968 This vector is also used for incomplete multibyte character
1969 translation (e.g \222\244). Such a character is at most 4 bytes,
1970 thus we need at most 16 bytes here. */
1971 Lisp_Object ctl_chars[16];
1973 /* Initial buffer or string position of the iterator, before skipping
1974 over display properties and invisible text. */
1975 struct display_pos start;
1977 /* Current buffer or string position of the iterator, including
1978 position in overlay strings etc. */
1979 struct display_pos current;
1981 /* Total number of overlay strings to process. This can be >
1982 OVERLAY_STRING_CHUNK_SIZE. */
1983 int n_overlay_strings;
1985 /* Vector of overlays to process. Overlay strings are processed
1986 OVERLAY_STRING_CHUNK_SIZE at a time. */
1987 #define OVERLAY_STRING_CHUNK_SIZE 16
1988 Lisp_Object overlay_strings[OVERLAY_STRING_CHUNK_SIZE];
1990 /* For each overlay string, the overlay it came from. */
1991 Lisp_Object string_overlays[OVERLAY_STRING_CHUNK_SIZE];
1993 /* If non-nil, a Lisp string being processed. If
1994 current.overlay_string_index >= 0, this is an overlay string from
1995 pos. */
1996 Lisp_Object string;
1998 /* If non-nil, we are processing a string that came
1999 from a `display' property given by an overlay. */
2000 Lisp_Object from_overlay;
2002 /* Stack of saved values. New entries are pushed when we begin to
2003 process an overlay string or a string from a `glyph' property.
2004 Entries are popped when we return to deliver display elements
2005 from what we previously had. */
2006 struct iterator_stack_entry
2008 Lisp_Object string;
2009 int string_nchars;
2010 int end_charpos;
2011 int stop_charpos;
2012 struct composition_it cmp_it;
2013 int face_id;
2015 /* Save values specific to a given method. */
2016 union {
2017 /* method == GET_FROM_IMAGE */
2018 struct {
2019 Lisp_Object object;
2020 struct it_slice slice;
2021 int image_id;
2022 } image;
2023 /* method == GET_FROM_COMPOSITION */
2024 struct {
2025 Lisp_Object object;
2026 } comp;
2027 /* method == GET_FROM_STRETCH */
2028 struct {
2029 Lisp_Object object;
2030 } stretch;
2031 } u;
2033 /* current text and display positions. */
2034 struct text_pos position;
2035 struct display_pos current;
2036 Lisp_Object from_overlay;
2037 enum glyph_row_area area;
2038 enum it_method method;
2039 unsigned multibyte_p : 1;
2040 unsigned string_from_display_prop_p : 1;
2041 unsigned display_ellipsis_p : 1;
2042 unsigned avoid_cursor_p : 1;
2043 enum line_wrap_method line_wrap;
2045 /* properties from display property that are reset by another display property. */
2046 short voffset;
2047 Lisp_Object space_width;
2048 Lisp_Object font_height;
2050 stack[IT_STACK_SIZE];
2052 /* Stack pointer. */
2053 int sp;
2055 /* -1 means selective display hides everything between a \r and the
2056 next newline; > 0 means hide lines indented more than that value. */
2057 int selective;
2059 /* An enumeration describing what the next display element is
2060 after a call to get_next_display_element. */
2061 enum display_element_type what;
2063 /* Face to use. */
2064 int face_id;
2066 /* Setting of buffer-local variable selective-display-ellipsis. */
2067 unsigned selective_display_ellipsis_p : 1;
2069 /* 1 means control characters are translated into the form `^C'
2070 where the `^' can be replaced by a display table entry. */
2071 unsigned ctl_arrow_p : 1;
2073 /* Non-zero means that the current face has a box. */
2074 unsigned face_box_p : 1;
2076 /* Non-null means that the current character is the first in a run
2077 of characters with box face. */
2078 unsigned start_of_box_run_p : 1;
2080 /* Non-zero means that the current character is the last in a run
2081 of characters with box face. */
2082 unsigned end_of_box_run_p : 1;
2084 /* 1 means overlay strings at end_charpos have been processed. */
2085 unsigned overlay_strings_at_end_processed_p : 1;
2087 /* 1 means to ignore overlay strings at current pos, as they have
2088 already been processed. */
2089 unsigned ignore_overlay_strings_at_pos_p : 1;
2091 /* 1 means the actual glyph is not available in the current
2092 system. */
2093 unsigned glyph_not_available_p : 1;
2095 /* 1 means the next line in display_line continues a character
2096 consisting of more than one glyph, and some glyphs of this
2097 character have been put on the previous line. */
2098 unsigned starts_in_middle_of_char_p : 1;
2100 /* If 1, saved_face_id contains the id of the face in front of text
2101 skipped due to selective display. */
2102 unsigned face_before_selective_p : 1;
2104 /* If 1, adjust current glyph so it does not increase current row
2105 descent/ascent (line-height property). Reset after this glyph. */
2106 unsigned constrain_row_ascent_descent_p : 1;
2108 enum line_wrap_method line_wrap;
2110 /* The ID of the default face to use. One of DEFAULT_FACE_ID,
2111 MODE_LINE_FACE_ID, etc, depending on what we are displaying. */
2112 int base_face_id;
2114 /* If what == IT_CHARACTER, character and length in bytes. This is
2115 a character from a buffer or string. It may be different from
2116 the character displayed in case that
2117 unibyte_display_via_language_environment is set.
2119 If what == IT_COMPOSITION, the first component of a composition
2120 and length in bytes of the composition. */
2121 int c, len;
2123 /* If what == IT_COMPOSITION, iterator substructure for the
2124 composition. */
2125 struct composition_it cmp_it;
2127 /* The character to display, possibly translated to multibyte
2128 if unibyte_display_via_language_environment is set. This
2129 is set after produce_glyphs has been called. */
2130 int char_to_display;
2132 /* If what == IT_IMAGE, the id of the image to display. */
2133 int image_id;
2135 /* Values from `slice' property. */
2136 struct it_slice slice;
2138 /* Value of the `space-width' property, if any; nil if none. */
2139 Lisp_Object space_width;
2141 /* Computed from the value of the `raise' property. */
2142 short voffset;
2144 /* Number of columns per \t. */
2145 short tab_width;
2147 /* Value of the `height' property, if any; nil if none. */
2148 Lisp_Object font_height;
2150 /* Object and position where the current display element came from.
2151 Object can be a Lisp string in case the current display element
2152 comes from an overlay string, or it is buffer. It may also be nil
2153 during mode-line update. Position is a position in object. */
2154 Lisp_Object object;
2155 struct text_pos position;
2157 /* Width in pixels of truncation and continuation glyphs. */
2158 short truncation_pixel_width, continuation_pixel_width;
2160 /* First and last visible x-position in the display area. If window
2161 is hscrolled by n columns, first_visible_x == n * FRAME_COLUMN_WIDTH
2162 (f), and last_visible_x == pixel width of W + first_visible_x. */
2163 int first_visible_x, last_visible_x;
2165 /* Last visible y-position + 1 in the display area without a mode
2166 line, if the window has one. */
2167 int last_visible_y;
2169 /* Default amount of additional space in pixels between lines (for
2170 window systems only.) */
2171 int extra_line_spacing;
2173 /* Max extra line spacing added in this row. */
2174 int max_extra_line_spacing;
2176 /* Override font height information for this glyph.
2177 Used if override_ascent >= 0. Cleared after this glyph. */
2178 int override_ascent, override_descent, override_boff;
2180 /* If non-null, glyphs are produced in glyph_row with each call to
2181 produce_glyphs. */
2182 struct glyph_row *glyph_row;
2184 /* The area of glyph_row to which glyphs are added. */
2185 enum glyph_row_area area;
2187 /* Number of glyphs needed for the last character requested via
2188 produce_glyphs. This is 1 except for tabs. */
2189 int nglyphs;
2191 /* Width of the display element in pixels. Result of
2192 produce_glyphs. */
2193 int pixel_width;
2195 /* Current, maximum logical, and maximum physical line height
2196 information. Result of produce_glyphs. */
2197 int ascent, descent, max_ascent, max_descent;
2198 int phys_ascent, phys_descent, max_phys_ascent, max_phys_descent;
2200 /* Current x pixel position within the display line. This value
2201 does not include the width of continuation lines in front of the
2202 line. The value of current_x is automatically incremented by
2203 pixel_width with each call to produce_glyphs. */
2204 int current_x;
2206 /* Accumulated width of continuation lines. If > 0, this means we
2207 are currently in a continuation line. This is initially zero and
2208 incremented/reset by display_line, move_it_to etc. */
2209 int continuation_lines_width;
2211 /* Current y-position. Automatically incremented by the height of
2212 glyph_row in move_it_to and display_line. */
2213 int current_y;
2215 /* Vertical matrix position of first text line in window. */
2216 int first_vpos;
2218 /* Current vertical matrix position, or line number. Automatically
2219 incremented by move_it_to and display_line. */
2220 int vpos;
2222 /* Horizontal matrix position reached in move_it_in_display_line.
2223 Only set there, not in display_line. */
2224 int hpos;
2226 /* Left fringe bitmap number (enum fringe_bitmap_type). */
2227 unsigned left_user_fringe_bitmap : FRINGE_ID_BITS;
2229 /* Right fringe bitmap number (enum fringe_bitmap_type). */
2230 unsigned right_user_fringe_bitmap : FRINGE_ID_BITS;
2232 /* Face of the left fringe glyph. */
2233 unsigned left_user_fringe_face_id : FACE_ID_BITS;
2235 /* Face of the right fringe glyph. */
2236 unsigned right_user_fringe_face_id : FACE_ID_BITS;
2240 /* Access to positions of iterator IT. */
2242 #define IT_CHARPOS(IT) CHARPOS ((IT).current.pos)
2243 #define IT_BYTEPOS(IT) BYTEPOS ((IT).current.pos)
2244 #define IT_STRING_CHARPOS(IT) CHARPOS ((IT).current.string_pos)
2245 #define IT_STRING_BYTEPOS(IT) BYTEPOS ((IT).current.string_pos)
2247 /* Test if IT has reached the end of its buffer or string. This will
2248 only work after get_next_display_element has been called. */
2250 #define ITERATOR_AT_END_P(IT) ((IT)->what == IT_EOB)
2252 /* Non-zero means IT is at the end of a line. This is the case if it
2253 is either on a newline or on a carriage return and selective
2254 display hides the rest of the line. */
2256 #define ITERATOR_AT_END_OF_LINE_P(IT) \
2257 ((IT)->what == IT_CHARACTER \
2258 && ((IT)->c == '\n' \
2259 || ((IT)->c == '\r' && (IT)->selective)))
2261 /* Call produce_glyphs or produce_glyphs_hook, if set. Shortcut to
2262 avoid the function call overhead. */
2264 #define PRODUCE_GLYPHS(IT) \
2265 do { \
2266 extern int inhibit_free_realized_faces; \
2267 if (FRAME_RIF ((IT)->f) != NULL) \
2268 FRAME_RIF ((IT)->f)->produce_glyphs ((IT)); \
2269 else \
2270 produce_glyphs ((IT)); \
2271 if ((IT)->glyph_row != NULL) \
2272 inhibit_free_realized_faces = 1; \
2273 } while (0)
2275 /* Bit-flags indicating what operation move_it_to should perform. */
2277 enum move_operation_enum
2279 /* Stop if specified x-position is reached. */
2280 MOVE_TO_X = 0x01,
2282 /* Stop if specified y-position is reached. */
2283 MOVE_TO_Y = 0x02,
2285 /* Stop if specified vpos is reached. */
2286 MOVE_TO_VPOS = 0x04,
2288 /* Stop if specified buffer or string position is reached. */
2289 MOVE_TO_POS = 0x08
2294 /***********************************************************************
2295 Window-based redisplay interface
2296 ***********************************************************************/
2298 /* Structure used to describe runs of lines that must be scrolled. */
2300 struct run
2302 /* Source and destination y pixel position. */
2303 int desired_y, current_y;
2305 /* Source and destination vpos in matrix. */
2306 int desired_vpos, current_vpos;
2308 /* Height in pixels, number of glyph rows. */
2309 int height, nrows;
2313 /* Handlers for setting frame parameters. */
2315 typedef void (*frame_parm_handler) P_ ((struct frame *, Lisp_Object, Lisp_Object));
2318 /* Structure holding system-dependent interface functions needed
2319 for window-based redisplay. */
2321 struct redisplay_interface
2323 /* Handlers for setting frame parameters. */
2324 frame_parm_handler *frame_parm_handlers;
2326 /* Produce glyphs/get display metrics for the display element IT is
2327 loaded with. */
2328 void (*produce_glyphs) P_ ((struct it *it));
2330 /* Write or insert LEN glyphs from STRING at the nominal output
2331 position. */
2332 void (*write_glyphs) P_ ((struct glyph *string, int len));
2333 void (*insert_glyphs) P_ ((struct glyph *start, int len));
2335 /* Clear from nominal output position to X. X < 0 means clear
2336 to right end of display. */
2337 void (*clear_end_of_line) P_ ((int x));
2339 /* Function to call to scroll the display as described by RUN on
2340 window W. */
2341 void (*scroll_run_hook) P_ ((struct window *w, struct run *run));
2343 /* Function to call after a line in a display has been completely
2344 updated. Used to draw truncation marks and alike. DESIRED_ROW
2345 is the desired row which has been updated. */
2346 void (*after_update_window_line_hook) P_ ((struct glyph_row *desired_row));
2348 /* Function to call before beginning to update window W in
2349 window-based redisplay. */
2350 void (*update_window_begin_hook) P_ ((struct window *w));
2352 /* Function to call after window W has been updated in window-based
2353 redisplay. CURSOR_ON_P non-zero means switch cursor on.
2354 MOUSE_FACE_OVERWRITTEN_P non-zero means that some lines in W
2355 that contained glyphs in mouse-face were overwritten, so we
2356 have to update the mouse highlight. */
2357 void (*update_window_end_hook) P_ ((struct window *w, int cursor_on_p,
2358 int mouse_face_overwritten_p));
2360 /* Move cursor to row/column position VPOS/HPOS, pixel coordinates
2361 Y/X. HPOS/VPOS are window-relative row and column numbers and X/Y
2362 are window-relative pixel positions. */
2363 void (*cursor_to) P_ ((int vpos, int hpos, int y, int x));
2365 /* Flush the display of frame F. For X, this is XFlush. */
2366 void (*flush_display) P_ ((struct frame *f));
2368 /* Flush the display of frame F if non-NULL. This is called
2369 during redisplay, and should be NULL on systems which flushes
2370 automatically before reading input. */
2371 void (*flush_display_optional) P_ ((struct frame *f));
2373 /* Clear the mouse hightlight in window W, if there is any. */
2374 void (*clear_window_mouse_face) P_ ((struct window *w));
2376 /* Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
2377 frame F. */
2378 void (*get_glyph_overhangs) P_ ((struct glyph *glyph, struct frame *f,
2379 int *left, int *right));
2381 /* Fix the display of AREA of ROW in window W for overlapping rows.
2382 This function is called from redraw_overlapping_rows after
2383 desired rows have been made current. */
2384 void (*fix_overlapping_area) P_ ((struct window *w, struct glyph_row *row,
2385 enum glyph_row_area area, int));
2387 #ifdef HAVE_WINDOW_SYSTEM
2389 /* Draw a fringe bitmap in window W of row ROW using parameters P. */
2390 void (*draw_fringe_bitmap) P_ ((struct window *w, struct glyph_row *row,
2391 struct draw_fringe_bitmap_params *p));
2393 /* Define and destroy fringe bitmap no. WHICH. */
2394 void (*define_fringe_bitmap) P_ ((int which, unsigned short *bits,
2395 int h, int wd));
2396 void (*destroy_fringe_bitmap) P_ ((int which));
2398 /* Compute left and right overhang of glyph string S.
2399 A NULL pointer if platform does not support this. */
2400 void (*compute_glyph_string_overhangs) P_ ((struct glyph_string *s));
2402 /* Draw a glyph string S. */
2403 void (*draw_glyph_string) P_ ((struct glyph_string *s));
2405 /* Define cursor CURSOR on frame F. */
2406 void (*define_frame_cursor) P_ ((struct frame *f, Cursor cursor));
2408 /* Clear the area at (X,Y,WIDTH,HEIGHT) of frame F. */
2409 void (*clear_frame_area) P_ ((struct frame *f, int x, int y,
2410 int width, int height));
2412 /* Draw specified cursor CURSOR_TYPE of width CURSOR_WIDTH
2413 at row GLYPH_ROW on window W if ON_P is 1. If ON_P is
2414 0, don't draw cursor. If ACTIVE_P is 1, system caret
2415 should track this cursor (when applicable). */
2416 void (*draw_window_cursor) P_ ((struct window *w,
2417 struct glyph_row *glyph_row,
2418 int x, int y,
2419 int cursor_type, int cursor_width,
2420 int on_p, int active_p));
2422 /* Draw vertical border for window W from (X,Y0) to (X,Y1). */
2423 void (*draw_vertical_window_border) P_ ((struct window *w,
2424 int x, int y0, int y1));
2426 /* Shift display of frame F to make room for inserted glyphs.
2427 The area at pixel (X,Y) of width WIDTH and height HEIGHT is
2428 shifted right by SHIFT_BY pixels. */
2429 void (*shift_glyphs_for_insert) P_ ((struct frame *f,
2430 int x, int y, int width,
2431 int height, int shift_by));
2433 #endif /* HAVE_WINDOW_SYSTEM */
2437 /***********************************************************************
2438 Images
2439 ***********************************************************************/
2441 #ifdef HAVE_WINDOW_SYSTEM
2443 /* Structure forward declarations. */
2445 struct image;
2448 /* Each image format (JPEG, TIFF, ...) supported is described by
2449 a structure of the type below. */
2451 struct image_type
2453 /* A symbol uniquely identifying the image type, .e.g `jpeg'. */
2454 Lisp_Object *type;
2456 /* Check that SPEC is a valid image specification for the given
2457 image type. Value is non-zero if SPEC is valid. */
2458 int (* valid_p) P_ ((Lisp_Object spec));
2460 /* Load IMG which is used on frame F from information contained in
2461 IMG->spec. Value is non-zero if successful. */
2462 int (* load) P_ ((struct frame *f, struct image *img));
2464 /* Free resources of image IMG which is used on frame F. */
2465 void (* free) P_ ((struct frame *f, struct image *img));
2467 /* Next in list of all supported image types. */
2468 struct image_type *next;
2472 /* Structure describing an image. Specific image formats like XBM are
2473 converted into this form, so that display only has to deal with
2474 this type of image. */
2476 struct image
2478 /* The time in seconds at which the image was last displayed. Set
2479 in prepare_image_for_display. */
2480 unsigned long timestamp;
2482 /* Pixmaps of the image. */
2483 Pixmap pixmap, mask;
2485 /* Colors allocated for this image, if any. Allocated via xmalloc. */
2486 unsigned long *colors;
2487 int ncolors;
2489 /* A single `background color' for this image, for the use of anyone that
2490 cares about such a thing. Only valid if the `background_valid' field
2491 is true. This should generally be accessed by calling the accessor
2492 macro `IMAGE_BACKGROUND', which will heuristically calculate a value
2493 if necessary. */
2494 unsigned long background;
2496 /* Foreground and background colors of the frame on which the image
2497 is created. */
2498 unsigned long frame_foreground, frame_background;
2500 /* True if this image has a `transparent' background -- that is, is
2501 uses an image mask. The accessor macro for this is
2502 `IMAGE_BACKGROUND_TRANSPARENT'. */
2503 unsigned background_transparent : 1;
2505 /* True if the `background' and `background_transparent' fields are
2506 valid, respectively. */
2507 unsigned background_valid : 1, background_transparent_valid : 1;
2509 /* Width and height of the image. */
2510 int width, height;
2512 /* These values are used for the rectangles displayed for images
2513 that can't be loaded. */
2514 #define DEFAULT_IMAGE_WIDTH 30
2515 #define DEFAULT_IMAGE_HEIGHT 30
2517 /* Top/left and bottom/right corner pixel of actual image data.
2518 Used by four_corners_best to consider the real image data,
2519 rather than looking at the optional image margin. */
2520 int corners[4];
2521 #define TOP_CORNER 0
2522 #define LEFT_CORNER 1
2523 #define BOT_CORNER 2
2524 #define RIGHT_CORNER 3
2526 /* Percent of image height used as ascent. A value of
2527 CENTERED_IMAGE_ASCENT means draw the image centered on the
2528 line. */
2529 int ascent;
2530 #define DEFAULT_IMAGE_ASCENT 50
2531 #define CENTERED_IMAGE_ASCENT -1
2533 /* Lisp specification of this image. */
2534 Lisp_Object spec;
2536 /* List of "references" followed to build the image.
2537 Typically will just contain the name of the image file.
2538 Used to allow fine-grained cache flushing. */
2539 Lisp_Object dependencies;
2541 /* Relief to draw around the image. */
2542 int relief;
2544 /* Optional margins around the image. This includes the relief. */
2545 int hmargin, vmargin;
2547 /* Reference to the type of the image. */
2548 struct image_type *type;
2550 /* 1 means that loading the image failed. Don't try again. */
2551 unsigned load_failed_p;
2553 /* A place for image types to store additional data. The member
2554 data.lisp_val is marked during GC, so it's safe to store Lisp data
2555 there. Image types should free this data when their `free'
2556 function is called. */
2557 struct
2559 int int_val;
2560 void *ptr_val;
2561 Lisp_Object lisp_val;
2562 } data;
2564 /* Hash value of image specification to speed up comparisons. */
2565 unsigned hash;
2567 /* Image id of this image. */
2568 int id;
2570 /* Hash collision chain. */
2571 struct image *next, *prev;
2575 /* Cache of images. Each frame has a cache. X frames with the same
2576 x_display_info share their caches. */
2578 struct image_cache
2580 /* Hash table of images. */
2581 struct image **buckets;
2583 /* Vector mapping image ids to images. */
2584 struct image **images;
2586 /* Allocated size of `images'. */
2587 unsigned size;
2589 /* Number of images in the cache. */
2590 unsigned used;
2592 /* Reference count (number of frames sharing this cache). */
2593 int refcount;
2597 /* Value is a pointer to the image with id ID on frame F, or null if
2598 no image with that id exists. */
2600 #define IMAGE_FROM_ID(F, ID) \
2601 (((ID) >= 0 && (ID) < (FRAME_IMAGE_CACHE (F)->used)) \
2602 ? FRAME_IMAGE_CACHE (F)->images[ID] \
2603 : NULL)
2605 /* Size of bucket vector of image caches. Should be prime. */
2607 #define IMAGE_CACHE_BUCKETS_SIZE 1001
2609 #endif /* HAVE_WINDOW_SYSTEM */
2613 /***********************************************************************
2614 Tool-bars
2615 ***********************************************************************/
2617 /* Enumeration defining where to find tool-bar item information in
2618 tool-bar items vectors stored with frames. Each tool-bar item
2619 occupies TOOL_BAR_ITEM_NSLOTS elements in such a vector. */
2621 enum tool_bar_item_idx
2623 /* The key of the tool-bar item. Used to remove items when a binding
2624 for `undefined' is found. */
2625 TOOL_BAR_ITEM_KEY,
2627 /* Non-nil if item is enabled. */
2628 TOOL_BAR_ITEM_ENABLED_P,
2630 /* Non-nil if item is selected (pressed). */
2631 TOOL_BAR_ITEM_SELECTED_P,
2633 /* Caption. */
2634 TOOL_BAR_ITEM_CAPTION,
2636 /* Image(s) to display. This is either a single image specification
2637 or a vector of specifications. */
2638 TOOL_BAR_ITEM_IMAGES,
2640 /* The binding. */
2641 TOOL_BAR_ITEM_BINDING,
2643 /* Button type. One of nil, `:radio' or `:toggle'. */
2644 TOOL_BAR_ITEM_TYPE,
2646 /* Help string. */
2647 TOOL_BAR_ITEM_HELP,
2649 /* Icon file name of right to left image when an RTL locale is used. */
2650 TOOL_BAR_ITEM_RTL_IMAGE,
2652 /* Sentinel = number of slots in tool_bar_items occupied by one
2653 tool-bar item. */
2654 TOOL_BAR_ITEM_NSLOTS
2658 /* An enumeration for the different images that can be specified
2659 for a tool-bar item. */
2661 enum tool_bar_item_image
2663 TOOL_BAR_IMAGE_ENABLED_SELECTED,
2664 TOOL_BAR_IMAGE_ENABLED_DESELECTED,
2665 TOOL_BAR_IMAGE_DISABLED_SELECTED,
2666 TOOL_BAR_IMAGE_DISABLED_DESELECTED
2669 /* Margin around tool-bar buttons in pixels. */
2671 extern Lisp_Object Vtool_bar_button_margin;
2673 /* Thickness of relief to draw around tool-bar buttons. */
2675 extern EMACS_INT tool_bar_button_relief;
2677 /* Default values of the above variables. */
2679 #define DEFAULT_TOOL_BAR_BUTTON_MARGIN 4
2680 #define DEFAULT_TOOL_BAR_BUTTON_RELIEF 1
2682 /* The height in pixels of the default tool-bar images. */
2684 #define DEFAULT_TOOL_BAR_IMAGE_HEIGHT 24
2687 /***********************************************************************
2688 Terminal Capabilities
2689 ***********************************************************************/
2691 /* Each of these is a bit representing a terminal `capability' (bold,
2692 inverse, etc). They are or'd together to specify the set of
2693 capabilities being queried for when calling `tty_capable_p' (which
2694 returns true if the terminal supports all of them). */
2696 #define TTY_CAP_INVERSE 0x01
2697 #define TTY_CAP_UNDERLINE 0x02
2698 #define TTY_CAP_BOLD 0x04
2699 #define TTY_CAP_DIM 0x08
2700 #define TTY_CAP_BLINK 0x10
2701 #define TTY_CAP_ALT_CHARSET 0x20
2704 /***********************************************************************
2705 Function Prototypes
2706 ***********************************************************************/
2708 /* Defined in xdisp.c */
2710 struct glyph_row *row_containing_pos P_ ((struct window *, int,
2711 struct glyph_row *,
2712 struct glyph_row *, int));
2713 int string_buffer_position P_ ((struct window *, Lisp_Object, int));
2714 int line_bottom_y P_ ((struct it *));
2715 int display_prop_intangible_p P_ ((Lisp_Object));
2716 void resize_echo_area_exactly P_ ((void));
2717 int resize_mini_window P_ ((struct window *, int));
2718 int try_window P_ ((Lisp_Object, struct text_pos, int));
2719 void window_box P_ ((struct window *, int, int *, int *, int *, int *));
2720 int window_box_height P_ ((struct window *));
2721 int window_text_bottom_y P_ ((struct window *));
2722 int window_box_width P_ ((struct window *, int));
2723 int window_box_left P_ ((struct window *, int));
2724 int window_box_left_offset P_ ((struct window *, int));
2725 int window_box_right P_ ((struct window *, int));
2726 int window_box_right_offset P_ ((struct window *, int));
2727 void window_box_edges P_ ((struct window *, int, int *, int *, int *, int *));
2728 int estimate_mode_line_height P_ ((struct frame *, enum face_id));
2729 void pixel_to_glyph_coords P_ ((struct frame *, int, int, int *, int *,
2730 NativeRectangle *, int));
2731 int glyph_to_pixel_coords P_ ((struct window *, int, int, int *, int *));
2732 void remember_mouse_glyph P_ ((struct frame *, int, int, NativeRectangle *));
2734 void mark_window_display_accurate P_ ((Lisp_Object, int));
2735 void redisplay_preserve_echo_area P_ ((int));
2736 int set_cursor_from_row P_ ((struct window *, struct glyph_row *,
2737 struct glyph_matrix *, int, int, int, int));
2738 void init_iterator P_ ((struct it *, struct window *, int,
2739 int, struct glyph_row *, enum face_id));
2740 void init_iterator_to_row_start P_ ((struct it *, struct window *,
2741 struct glyph_row *));
2742 int get_next_display_element P_ ((struct it *));
2743 void set_iterator_to_next P_ ((struct it *, int));
2744 void start_display P_ ((struct it *, struct window *, struct text_pos));
2745 void move_it_to P_ ((struct it *, int, int, int, int, int));
2746 void move_it_vertically P_ ((struct it *, int));
2747 void move_it_vertically_backward P_ ((struct it *, int));
2748 void move_it_by_lines P_ ((struct it *, int, int));
2749 void move_it_past_eol P_ ((struct it *));
2750 void move_it_in_display_line (struct it *it,
2751 EMACS_INT to_charpos, int to_x,
2752 enum move_operation_enum op);
2753 int in_display_vector_p P_ ((struct it *));
2754 int frame_mode_line_height P_ ((struct frame *));
2755 void highlight_trailing_whitespace P_ ((struct frame *, struct glyph_row *));
2756 extern Lisp_Object Qtool_bar;
2757 extern Lisp_Object Vshow_trailing_whitespace;
2758 extern int mode_line_in_non_selected_windows;
2759 extern int redisplaying_p;
2760 extern void add_to_log P_ ((char *, Lisp_Object, Lisp_Object));
2761 extern int help_echo_showing_p;
2762 extern int current_mode_line_height, current_header_line_height;
2763 extern Lisp_Object help_echo_string, help_echo_window;
2764 extern Lisp_Object help_echo_object, previous_help_echo_string;
2765 extern int help_echo_pos;
2766 extern struct frame *last_mouse_frame;
2767 extern int last_tool_bar_item;
2768 extern Lisp_Object Vmouse_autoselect_window;
2769 extern int unibyte_display_via_language_environment;
2770 extern EMACS_INT underline_minimum_offset;
2772 extern void reseat_at_previous_visible_line_start P_ ((struct it *));
2774 extern int calc_pixel_width_or_height P_ ((double *, struct it *, Lisp_Object,
2775 struct font *, int, int *));
2777 #ifdef HAVE_WINDOW_SYSTEM
2779 #if GLYPH_DEBUG
2780 extern void dump_glyph_string P_ ((struct glyph_string *));
2781 #endif
2783 extern void x_get_glyph_overhangs P_ ((struct glyph *, struct frame *,
2784 int *, int *));
2785 extern void x_produce_glyphs P_ ((struct it *));
2787 extern void x_write_glyphs P_ ((struct glyph *, int));
2788 extern void x_insert_glyphs P_ ((struct glyph *, int len));
2789 extern void x_clear_end_of_line P_ ((int));
2791 extern int x_stretch_cursor_p;
2792 extern struct cursor_pos output_cursor;
2794 extern void x_fix_overlapping_area P_ ((struct window *, struct glyph_row *,
2795 enum glyph_row_area, int));
2796 extern void draw_phys_cursor_glyph P_ ((struct window *,
2797 struct glyph_row *,
2798 enum draw_glyphs_face));
2799 extern void get_phys_cursor_geometry P_ ((struct window *, struct glyph_row *,
2800 struct glyph *, int *, int *, int *));
2801 extern void erase_phys_cursor P_ ((struct window *));
2802 extern void display_and_set_cursor P_ ((struct window *,
2803 int, int, int, int, int));
2805 extern void set_output_cursor P_ ((struct cursor_pos *));
2806 extern void x_cursor_to P_ ((int, int, int, int));
2808 extern void x_update_cursor P_ ((struct frame *, int));
2809 extern void x_clear_cursor P_ ((struct window *));
2810 extern void x_draw_vertical_border P_ ((struct window *w));
2812 extern void frame_to_window_pixel_xy P_ ((struct window *, int *, int *));
2813 extern int get_glyph_string_clip_rects P_ ((struct glyph_string *,
2814 NativeRectangle *, int));
2815 extern void get_glyph_string_clip_rect P_ ((struct glyph_string *,
2816 NativeRectangle *nr));
2817 extern Lisp_Object find_hot_spot P_ ((Lisp_Object, int, int));
2818 extern void note_mouse_highlight P_ ((struct frame *, int, int));
2819 extern void x_clear_window_mouse_face P_ ((struct window *));
2820 extern void cancel_mouse_face P_ ((struct frame *));
2822 extern void handle_tool_bar_click P_ ((struct frame *,
2823 int, int, int, unsigned int));
2825 /* msdos.c defines its own versions of these functions. */
2826 extern int clear_mouse_face P_ ((Display_Info *));
2827 extern void show_mouse_face P_ ((Display_Info *, enum draw_glyphs_face));
2828 extern int cursor_in_mouse_face_p P_ ((struct window *w));
2830 extern void expose_frame P_ ((struct frame *, int, int, int, int));
2831 extern int x_intersect_rectangles P_ ((XRectangle *, XRectangle *,
2832 XRectangle *));
2833 #endif
2835 /* Defined in fringe.c */
2837 int lookup_fringe_bitmap (Lisp_Object);
2838 void draw_fringe_bitmap P_ ((struct window *, struct glyph_row *, int));
2839 void draw_row_fringe_bitmaps P_ ((struct window *, struct glyph_row *));
2840 int draw_window_fringes P_ ((struct window *, int));
2841 int update_window_fringes P_ ((struct window *, int));
2842 void compute_fringe_widths P_ ((struct frame *, int));
2844 #ifdef WINDOWSNT
2845 void w32_init_fringe P_ ((struct redisplay_interface *));
2846 void w32_reset_fringes P_ ((void));
2847 #endif
2848 /* Defined in image.c */
2850 #ifdef HAVE_WINDOW_SYSTEM
2852 extern int x_bitmap_height P_ ((struct frame *, int));
2853 extern int x_bitmap_width P_ ((struct frame *, int));
2854 extern int x_bitmap_pixmap P_ ((struct frame *, int));
2855 extern void x_reference_bitmap P_ ((struct frame *, int));
2856 extern int x_create_bitmap_from_data P_ ((struct frame *, char *,
2857 unsigned int, unsigned int));
2858 extern int x_create_bitmap_from_file P_ ((struct frame *, Lisp_Object));
2859 #if defined (HAVE_XPM) && defined (HAVE_X_WINDOWS)
2860 extern int x_create_bitmap_from_xpm_data P_ ((struct frame *f, char **bits));
2861 #endif
2862 #ifndef x_destroy_bitmap
2863 extern void x_destroy_bitmap P_ ((struct frame *, int));
2864 #endif
2865 extern void x_destroy_all_bitmaps P_ ((Display_Info *));
2866 extern int x_create_bitmap_mask P_ ((struct frame * , int));
2867 extern Lisp_Object x_find_image_file P_ ((Lisp_Object));
2869 void x_kill_gs_process P_ ((Pixmap, struct frame *));
2870 struct image_cache *make_image_cache P_ ((void));
2871 void free_image_cache P_ ((struct frame *));
2872 void clear_image_caches P_ ((Lisp_Object));
2873 void mark_image_cache P_ ((struct image_cache *));
2874 int valid_image_p P_ ((Lisp_Object));
2875 void prepare_image_for_display P_ ((struct frame *, struct image *));
2876 int lookup_image P_ ((struct frame *, Lisp_Object));
2878 unsigned long image_background P_ ((struct image *, struct frame *,
2879 XImagePtr_or_DC ximg));
2880 int image_background_transparent P_ ((struct image *, struct frame *,
2881 XImagePtr_or_DC mask));
2883 int image_ascent P_ ((struct image *, struct face *, struct glyph_slice *));
2885 #endif
2887 /* Defined in sysdep.c */
2889 void get_tty_size P_ ((int, int *, int *));
2890 void request_sigio P_ ((void));
2891 void unrequest_sigio P_ ((void));
2892 int tabs_safe_p P_ ((int));
2893 void init_baud_rate P_ ((int));
2894 void init_sigio P_ ((int));
2896 /* Defined in xfaces.c */
2898 #ifdef HAVE_X_WINDOWS
2899 void x_free_colors P_ ((struct frame *, unsigned long *, int));
2900 #endif
2902 void update_face_from_frame_parameter P_ ((struct frame *, Lisp_Object,
2903 Lisp_Object));
2904 Lisp_Object tty_color_name P_ ((struct frame *, int));
2905 void clear_face_cache P_ ((int));
2906 unsigned long load_color P_ ((struct frame *, struct face *, Lisp_Object,
2907 enum lface_attribute_index));
2908 void unload_color P_ ((struct frame *, unsigned long));
2909 char *choose_face_font P_ ((struct frame *, Lisp_Object *, Lisp_Object,
2910 int *));
2911 int ascii_face_of_lisp_face P_ ((struct frame *, int));
2912 void prepare_face_for_display P_ ((struct frame *, struct face *));
2913 int xstrcasecmp P_ ((const unsigned char *, const unsigned char *));
2914 int lookup_face P_ ((struct frame *, Lisp_Object *));
2915 int lookup_named_face P_ ((struct frame *, Lisp_Object, int));
2916 int lookup_basic_face P_ ((struct frame *, int));
2917 int smaller_face P_ ((struct frame *, int, int));
2918 int face_with_height P_ ((struct frame *, int, int));
2919 int lookup_derived_face P_ ((struct frame *, Lisp_Object, int, int));
2920 void init_frame_faces P_ ((struct frame *));
2921 void free_frame_faces P_ ((struct frame *));
2922 void recompute_basic_faces P_ ((struct frame *));
2923 int face_at_buffer_position P_ ((struct window *w, EMACS_INT pos,
2924 EMACS_INT region_beg, EMACS_INT region_end,
2925 EMACS_INT *endptr, EMACS_INT limit,
2926 int mouse, int base_face_id));
2927 int face_for_overlay_string P_ ((struct window *w, EMACS_INT pos,
2928 EMACS_INT region_beg, EMACS_INT region_end,
2929 EMACS_INT *endptr, EMACS_INT limit,
2930 int mouse, Lisp_Object overlay));
2931 int face_at_string_position P_ ((struct window *w, Lisp_Object string,
2932 EMACS_INT pos, EMACS_INT bufpos,
2933 EMACS_INT region_beg, EMACS_INT region_end,
2934 EMACS_INT *endptr, enum face_id, int mouse));
2935 int merge_faces P_ ((struct frame *, Lisp_Object, int, int));
2936 int compute_char_face P_ ((struct frame *, int, Lisp_Object));
2937 void free_all_realized_faces P_ ((Lisp_Object));
2938 void free_realized_face P_ ((struct frame *, struct face *));
2939 extern Lisp_Object Qforeground_color, Qbackground_color;
2940 extern Lisp_Object Qframe_set_background_mode;
2941 extern char unspecified_fg[], unspecified_bg[];
2943 extern Lisp_Object Vface_remapping_alist;
2945 /* Defined in xfns.c */
2947 #ifdef HAVE_X_WINDOWS
2948 void gamma_correct P_ ((struct frame *, XColor *));
2949 #endif
2950 #ifdef WINDOWSNT
2951 void gamma_correct P_ ((struct frame *, COLORREF *));
2952 #endif
2954 #ifdef HAVE_WINDOW_SYSTEM
2956 int x_screen_planes P_ ((struct frame *));
2957 void x_implicitly_set_name P_ ((struct frame *, Lisp_Object, Lisp_Object));
2959 extern Lisp_Object tip_frame;
2960 extern Window tip_window;
2961 EXFUN (Fx_show_tip, 6);
2962 EXFUN (Fx_hide_tip, 0);
2963 extern void start_hourglass P_ ((void));
2964 extern void cancel_hourglass P_ ((void));
2965 extern int hourglass_started P_ ((void));
2966 extern int display_hourglass_p;
2967 extern int hourglass_shown_p;
2968 struct atimer; /* Defined in atimer.h. */
2969 /* If non-null, an asynchronous timer that, when it expires, displays
2970 an hourglass cursor on all frames. */
2971 extern struct atimer *hourglass_atimer;
2973 /* Each GUI implements these. FIXME: move into RIF. */
2974 extern void show_hourglass P_ ((struct atimer *));
2975 extern void hide_hourglass P_ ((void));
2977 /* Returns the background color of IMG, calculating one heuristically if
2978 necessary. If non-zero, XIMG is an existing XImage object to use for
2979 the heuristic. */
2981 #define IMAGE_BACKGROUND(img, f, ximg) \
2982 ((img)->background_valid \
2983 ? (img)->background \
2984 : image_background (img, f, ximg))
2986 /* Returns true if IMG has a `transparent' background, using heuristics
2987 to decide if necessary. If non-zero, MASK is an existing XImage
2988 object to use for the heuristic. */
2990 #define IMAGE_BACKGROUND_TRANSPARENT(img, f, mask) \
2991 ((img)->background_transparent_valid \
2992 ? (img)->background_transparent \
2993 : image_background_transparent (img, f, mask))
2995 #endif /* HAVE_WINDOW_SYSTEM */
2998 /* Defined in xmenu.c */
3000 int popup_activated P_ ((void));
3002 /* Defined in dispnew.c */
3004 extern int inverse_video;
3005 extern int required_matrix_width P_ ((struct window *));
3006 extern int required_matrix_height P_ ((struct window *));
3007 extern Lisp_Object buffer_posn_from_coords P_ ((struct window *,
3008 int *, int *,
3009 struct display_pos *,
3010 Lisp_Object *,
3011 int *, int *, int *, int *));
3012 extern Lisp_Object mode_line_string P_ ((struct window *, enum window_part,
3013 int *, int *, int *,
3014 Lisp_Object *,
3015 int *, int *, int *, int *));
3016 extern Lisp_Object marginal_area_string P_ ((struct window *, enum window_part,
3017 int *, int *, int *,
3018 Lisp_Object *,
3019 int *, int *, int *, int *));
3020 extern void redraw_frame P_ ((struct frame *));
3021 extern void redraw_garbaged_frames P_ ((void));
3022 extern void cancel_line P_ ((int, struct frame *));
3023 extern void init_desired_glyphs P_ ((struct frame *));
3024 extern int scroll_frame_lines P_ ((struct frame *, int, int, int, int));
3025 extern int direct_output_for_insert P_ ((int));
3026 extern int direct_output_forward_char P_ ((int));
3027 extern int update_frame P_ ((struct frame *, int, int));
3028 extern int scrolling P_ ((struct frame *));
3029 extern void bitch_at_user P_ ((void));
3030 void adjust_glyphs P_ ((struct frame *));
3031 void free_glyphs P_ ((struct frame *));
3032 void free_window_matrices P_ ((struct window *));
3033 void check_glyph_memory P_ ((void));
3034 void mirrored_line_dance P_ ((struct glyph_matrix *, int, int, int *, char *));
3035 void clear_glyph_matrix P_ ((struct glyph_matrix *));
3036 void clear_current_matrices P_ ((struct frame *f));
3037 void clear_desired_matrices P_ ((struct frame *));
3038 void shift_glyph_matrix P_ ((struct window *, struct glyph_matrix *,
3039 int, int, int));
3040 void rotate_matrix P_ ((struct glyph_matrix *, int, int, int));
3041 void increment_matrix_positions P_ ((struct glyph_matrix *,
3042 int, int, int, int));
3043 void blank_row P_ ((struct window *, struct glyph_row *, int));
3044 void increment_row_positions P_ ((struct glyph_row *, int, int));
3045 void enable_glyph_matrix_rows P_ ((struct glyph_matrix *, int, int, int));
3046 void clear_glyph_row P_ ((struct glyph_row *));
3047 void prepare_desired_row P_ ((struct glyph_row *));
3048 int line_hash_code P_ ((struct glyph_row *));
3049 void set_window_update_flags P_ ((struct window *, int));
3050 void redraw_frame P_ ((struct frame *));
3051 void redraw_garbaged_frames P_ ((void));
3052 int scroll_cost P_ ((struct frame *, int, int, int));
3053 int direct_output_for_insert P_ ((int));
3054 int direct_output_forward_char P_ ((int));
3055 int update_frame P_ ((struct frame *, int, int));
3056 void update_single_window P_ ((struct window *, int));
3057 int scrolling P_ ((struct frame *));
3058 void do_pending_window_change P_ ((int));
3059 void change_frame_size P_ ((struct frame *, int, int, int, int, int));
3060 void bitch_at_user P_ ((void));
3061 void init_display P_ ((void));
3062 void syms_of_display P_ ((void));
3063 extern Lisp_Object Qredisplay_dont_pause;
3064 void spec_glyph_lookup_face P_ ((struct window *, GLYPH *));
3066 /* Defined in terminal.c */
3068 extern void ring_bell P_ ((struct frame *));
3069 extern void update_begin P_ ((struct frame *));
3070 extern void update_end P_ ((struct frame *));
3071 extern void set_terminal_window P_ ((struct frame *, int));
3072 extern void cursor_to P_ ((struct frame *, int, int));
3073 extern void raw_cursor_to P_ ((struct frame *, int, int));
3074 extern void clear_to_end P_ ((struct frame *));
3075 extern void clear_frame P_ ((struct frame *));
3076 extern void clear_end_of_line P_ ((struct frame *, int));
3077 extern void write_glyphs P_ ((struct frame *, struct glyph *, int));
3078 extern void insert_glyphs P_ ((struct frame *, struct glyph *, int));
3079 extern void delete_glyphs P_ ((struct frame *, int));
3080 extern void ins_del_lines P_ ((struct frame *, int, int));
3082 extern struct terminal *init_initial_terminal P_ ((void));
3085 /* Defined in term.c */
3087 extern void tty_set_terminal_modes P_ ((struct terminal *));
3088 extern void tty_reset_terminal_modes P_ ((struct terminal *));
3089 extern void tty_turn_off_insert P_ ((struct tty_display_info *));
3090 extern void tty_turn_off_highlight P_ ((struct tty_display_info *));
3091 extern int string_cost P_ ((char *));
3092 extern int per_line_cost P_ ((char *));
3093 extern void calculate_costs P_ ((struct frame *));
3094 extern void produce_glyphs P_ ((struct it *));
3095 extern void produce_special_glyphs P_ ((struct it *, enum display_element_type));
3096 extern int tty_capable_p P_ ((struct tty_display_info *, unsigned, unsigned long, unsigned long));
3097 extern void set_tty_color_mode (struct tty_display_info *, struct frame *);
3098 extern struct terminal *get_tty_terminal P_ ((Lisp_Object, int));
3099 extern struct terminal *get_named_tty P_ ((char *));
3100 EXFUN (Ftty_type, 1);
3101 extern void create_tty_output P_ ((struct frame *));
3102 extern struct terminal *init_tty P_ ((char *, char *, int));
3105 /* Defined in scroll.c */
3107 extern int scrolling_max_lines_saved P_ ((int, int, int *, int *, int *));
3108 extern int scroll_cost P_ ((struct frame *, int, int, int));
3109 extern void do_line_insertion_deletion_costs P_ ((struct frame *, char *,
3110 char *, char *, char *,
3111 char *, char *, int));
3112 void scrolling_1 P_ ((struct frame *, int, int, int, int *, int *, int *,
3113 int *, int));
3115 /* Defined in frame.c */
3117 #ifdef HAVE_WINDOW_SYSTEM
3119 /* Types we might convert a resource string into. */
3120 enum resource_types
3122 RES_TYPE_NUMBER,
3123 RES_TYPE_FLOAT,
3124 RES_TYPE_BOOLEAN,
3125 RES_TYPE_STRING,
3126 RES_TYPE_SYMBOL
3129 extern Lisp_Object x_get_arg P_ ((Display_Info *, Lisp_Object,
3130 Lisp_Object, char *, char *class,
3131 enum resource_types));
3132 extern Lisp_Object x_frame_get_arg P_ ((struct frame *, Lisp_Object,
3133 Lisp_Object, char *, char *,
3134 enum resource_types));
3135 extern Lisp_Object x_frame_get_and_record_arg P_ ((
3136 struct frame *, Lisp_Object,
3137 Lisp_Object, char *, char *,
3138 enum resource_types));
3139 extern Lisp_Object x_default_parameter P_ ((struct frame *, Lisp_Object,
3140 Lisp_Object, Lisp_Object,
3141 char *, char *,
3142 enum resource_types));
3144 #endif /* HAVE_WINDOW_SYSTEM */
3146 #endif /* not DISPEXTERN_H_INCLUDED */
3148 /* arch-tag: c65c475f-1c1e-4534-8795-990b8509fd65
3149 (do not change this comment) */