Don't let-bind copyright-update in nnfolder-save-buffer.
[emacs.git] / src / dispextern.h
blob8e19bdae19770c981c314a44b622891566074535
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, 2010, 2011
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
108 /* Number of bits allocated to store fringe bitmap height. */
109 #define FRINGE_HEIGHT_BITS 8
112 /***********************************************************************
113 Debugging
114 ***********************************************************************/
116 /* If GLYPH_DEBUG is non-zero, additional checks are activated. Turn
117 it off by defining the macro GLYPH_DEBUG to zero. */
119 #ifndef GLYPH_DEBUG
120 #define GLYPH_DEBUG 0
121 #endif
123 /* If XASSERTS is non-zero, additional consistency checks are activated.
124 Turn it off by defining the macro XASSERTS to zero. */
126 #ifndef XASSERTS
127 #define XASSERTS 0
128 #endif
130 /* Macros to include code only if GLYPH_DEBUG != 0. */
132 #if GLYPH_DEBUG
133 #define IF_DEBUG(X) X
134 #else
135 #define IF_DEBUG(X) (void) 0
136 #endif
138 #if XASSERTS
139 #define xassert(X) do {if (!(X)) abort ();} while (0)
140 #else
141 #define xassert(X) (void) 0
142 #endif
144 /* Macro for displaying traces of redisplay. If Emacs was compiled
145 with GLYPH_DEBUG != 0, the variable trace_redisplay_p can be set to
146 a non-zero value in debugging sessions to activate traces. */
148 #if GLYPH_DEBUG
150 extern int trace_redisplay_p;
151 #include <stdio.h>
153 #define TRACE(X) \
154 if (trace_redisplay_p) \
155 fprintf X; \
156 else \
157 (void) 0
159 #else /* GLYPH_DEBUG == 0 */
161 #define TRACE(X) (void) 0
163 #endif /* GLYPH_DEBUG == 0 */
167 /***********************************************************************
168 Text positions
169 ***********************************************************************/
171 /* Starting with Emacs 20.3, characters from strings and buffers have
172 both a character and a byte position associated with them. The
173 following structure holds such a pair of positions. */
175 struct text_pos
177 /* Character position. */
178 EMACS_INT charpos;
180 /* Corresponding byte position. */
181 EMACS_INT bytepos;
184 /* Access character and byte position of POS in a functional form. */
186 #define BYTEPOS(POS) (POS).bytepos
187 #define CHARPOS(POS) (POS).charpos
189 /* Set character position of POS to CHARPOS, byte position to BYTEPOS. */
191 #define SET_TEXT_POS(POS, CHARPOS, BYTEPOS) \
192 ((POS).charpos = (CHARPOS), (POS).bytepos = BYTEPOS)
194 /* Increment text position POS. */
196 #define INC_TEXT_POS(POS, MULTIBYTE_P) \
197 do \
199 ++(POS).charpos; \
200 if (MULTIBYTE_P) \
201 INC_POS ((POS).bytepos); \
202 else \
203 ++(POS).bytepos; \
205 while (0)
207 /* Decrement text position POS. */
209 #define DEC_TEXT_POS(POS, MULTIBYTE_P) \
210 do \
212 --(POS).charpos; \
213 if (MULTIBYTE_P) \
214 DEC_POS ((POS).bytepos); \
215 else \
216 --(POS).bytepos; \
218 while (0)
220 /* Set text position POS from marker MARKER. */
222 #define SET_TEXT_POS_FROM_MARKER(POS, MARKER) \
223 (CHARPOS (POS) = marker_position ((MARKER)), \
224 BYTEPOS (POS) = marker_byte_position ((MARKER)))
226 /* Set marker MARKER from text position POS. */
228 #define SET_MARKER_FROM_TEXT_POS(MARKER, POS) \
229 set_marker_both ((MARKER), Qnil, CHARPOS ((POS)), BYTEPOS ((POS)))
231 /* Value is non-zero if character and byte positions of POS1 and POS2
232 are equal. */
234 #define TEXT_POS_EQUAL_P(POS1, POS2) \
235 ((POS1).charpos == (POS2).charpos \
236 && (POS1).bytepos == (POS2).bytepos)
238 /* When rendering glyphs, redisplay scans string or buffer text,
239 overlay strings in that text, and does display table or control
240 character translations. The following structure captures a
241 position taking all this into account. */
243 struct display_pos
245 /* Buffer or string position. */
246 struct text_pos pos;
248 /* If this is a position in an overlay string, overlay_string_index
249 is the index of that overlay string in the sequence of overlay
250 strings at `pos' in the order redisplay processes them. A value
251 < 0 means that this is not a position in an overlay string. */
252 int overlay_string_index;
254 /* If this is a position in an overlay string, string_pos is the
255 position within that string. */
256 struct text_pos string_pos;
258 /* If the character at the position above is a control character or
259 has a display table entry, dpvec_index is an index in the display
260 table or control character translation of that character. A
261 value < 0 means this is not a position in such a translation. */
262 int dpvec_index;
267 /***********************************************************************
268 Glyphs
269 ***********************************************************************/
271 /* Enumeration of glyph types. Glyph structures contain a type field
272 containing one of the enumerators defined here. */
274 enum glyph_type
276 /* Glyph describes a character. */
277 CHAR_GLYPH,
279 /* Glyph describes a static composition. */
280 COMPOSITE_GLYPH,
282 /* Glyph describes an image. */
283 IMAGE_GLYPH,
285 /* Glyph is a space of fractional width and/or height. */
286 STRETCH_GLYPH
290 /* Structure describing how to use partial glyphs (images slicing) */
292 struct glyph_slice
294 unsigned x : 16;
295 unsigned y : 16;
296 unsigned width : 16;
297 unsigned height : 16;
301 /* Glyphs.
303 Be extra careful when changing this structure! Esp. make sure that
304 functions producing glyphs, like append_glyph, fill ALL of the
305 glyph structure, and that GLYPH_EQUAL_P compares all
306 display-relevant members of glyphs (not to imply that these are the
307 only things to check when you add a member). */
309 struct glyph
311 /* Position from which this glyph was drawn. If `object' below is a
312 Lisp string, this is a position in that string. If it is a
313 buffer, this is a position in that buffer. A value of -1
314 together with a null object means glyph is a truncation glyph at
315 the start of a row. */
316 EMACS_INT charpos;
318 /* Lisp object source of this glyph. Currently either a buffer or
319 a string, if the glyph was produced from characters which came from
320 a buffer or a string; or 0 if the glyph was inserted by redisplay
321 for its own purposes such as padding. */
322 Lisp_Object object;
324 /* Width in pixels. */
325 short pixel_width;
327 /* Ascent and descent in pixels. */
328 short ascent, descent;
330 /* Vertical offset. If < 0, the glyph is displayed raised, if > 0
331 the glyph is displayed lowered. */
332 short voffset;
334 /* Which kind of glyph this is---character, image etc. Value
335 should be an enumerator of type enum glyph_type. */
336 unsigned type : 2;
338 /* 1 means this glyph was produced from multibyte text. Zero
339 means it was produced from unibyte text, i.e. charsets aren't
340 applicable, and encoding is not performed. */
341 unsigned multibyte_p : 1;
343 /* Non-zero means draw a box line at the left or right side of this
344 glyph. This is part of the implementation of the face attribute
345 `:box'. */
346 unsigned left_box_line_p : 1;
347 unsigned right_box_line_p : 1;
349 /* Non-zero means this glyph's physical ascent or descent is greater
350 than its logical ascent/descent, i.e. it may potentially overlap
351 glyphs above or below it. */
352 unsigned overlaps_vertically_p : 1;
354 /* For terminal frames, 1 means glyph is a padding glyph. Padding
355 glyphs are used for characters whose visual shape consists of
356 more than one glyph (e.g. Asian characters). All but the first
357 glyph of such a glyph sequence have the padding_p flag set. This
358 flag is used only to minimize code changes. A better way would
359 probably be to use the width field of glyphs to express padding.
361 For graphic frames, 1 means the pixel width of the glyph in a
362 font is 0, but 1-pixel is padded on displaying for correct cursor
363 displaying. The member `pixel_width' above is set to 1. */
364 unsigned padding_p : 1;
366 /* 1 means the actual glyph is not available, draw a box instead.
367 This can happen when a font couldn't be loaded, or a character
368 doesn't have a glyph in a font. */
369 unsigned glyph_not_available_p : 1;
372 /* Non-zero means don't display cursor here. */
373 unsigned avoid_cursor_p : 1;
375 #define FACE_ID_BITS 20
377 /* Face of the glyph. This is a realized face ID,
378 an index in the face cache of the frame. */
379 unsigned face_id : FACE_ID_BITS;
381 /* Type of font used to display the character glyph. May be used to
382 determine which set of functions to use to obtain font metrics
383 for the glyph. On W32, value should be an enumerator of the type
384 w32_char_font_type. Otherwise it equals FONT_TYPE_UNKNOWN. */
385 unsigned font_type : 3;
387 struct glyph_slice slice;
389 /* A union of sub-structures for different glyph types. */
390 union
392 /* Character code for character glyphs (type == CHAR_GLYPH). */
393 unsigned ch;
395 /* Sub-structures for type == COMPOSITION_GLYPH. */
396 struct
398 /* Flag to tell if the composition is automatic or not. */
399 unsigned automatic : 1;
400 /* ID of the composition. */
401 unsigned id : 23;
402 /* Start and end indices of glyphs of the composition. */
403 unsigned from : 4;
404 unsigned to : 4;
405 } cmp;
407 /* Image ID for image glyphs (type == IMAGE_GLYPH). */
408 unsigned img_id;
410 /* Sub-structure for type == STRETCH_GLYPH. */
411 struct
413 /* The height of the glyph. */
414 unsigned height : 16;
416 /* The ascent of the glyph. */
417 unsigned ascent : 16;
419 stretch;
421 /* Used to compare all bit-fields above in one step. */
422 unsigned val;
423 } u;
427 /* Default value of the glyph font_type field. */
429 #define FONT_TYPE_UNKNOWN 0
431 /* Is GLYPH a space? */
433 #define CHAR_GLYPH_SPACE_P(GLYPH) \
434 ((GLYPH).u.ch == SPACEGLYPH && (GLYPH).face_id == DEFAULT_FACE_ID)
436 /* Are glyph slices of glyphs *X and *Y equal */
438 #define GLYPH_SLICE_EQUAL_P(X, Y) \
439 ((X)->slice.x == (Y)->slice.x \
440 && (X)->slice.y == (Y)->slice.y \
441 && (X)->slice.width == (Y)->slice.width \
442 && (X)->slice.height == (Y)->slice.height)
444 /* Are glyphs *X and *Y displayed equal? */
446 #define GLYPH_EQUAL_P(X, Y) \
447 ((X)->type == (Y)->type \
448 && (X)->u.val == (Y)->u.val \
449 && GLYPH_SLICE_EQUAL_P (X, Y) \
450 && (X)->face_id == (Y)->face_id \
451 && (X)->padding_p == (Y)->padding_p \
452 && (X)->left_box_line_p == (Y)->left_box_line_p \
453 && (X)->right_box_line_p == (Y)->right_box_line_p \
454 && (X)->voffset == (Y)->voffset \
455 && (X)->pixel_width == (Y)->pixel_width)
457 /* Are character codes, faces, padding_ps of glyphs *X and *Y equal? */
459 #define GLYPH_CHAR_AND_FACE_EQUAL_P(X, Y) \
460 ((X)->u.ch == (Y)->u.ch \
461 && (X)->face_id == (Y)->face_id \
462 && (X)->padding_p == (Y)->padding_p)
464 /* Fill a character glyph GLYPH. CODE, FACE_ID, PADDING_P correspond
465 to the bits defined for the typedef `GLYPH' in lisp.h. */
467 #define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P) \
468 do \
470 (GLYPH).u.ch = (CODE); \
471 (GLYPH).face_id = (FACE_ID); \
472 (GLYPH).padding_p = (PADDING_P); \
474 while (0)
476 /* Fill a character type glyph GLYPH from a glyph typedef FROM as
477 defined in lisp.h. */
479 #define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM) \
480 SET_CHAR_GLYPH ((GLYPH), \
481 GLYPH_CHAR ((FROM)), \
482 GLYPH_FACE ((FROM)), \
485 /* Construct a glyph code from a character glyph GLYPH. If the
486 character is multibyte, return -1 as we can't use glyph table for a
487 multibyte character. */
489 #define SET_GLYPH_FROM_CHAR_GLYPH(G, GLYPH) \
490 do \
492 if ((GLYPH).u.ch < 256) \
493 SET_GLYPH ((G), (GLYPH).u.ch, ((GLYPH).face_id)); \
494 else \
495 SET_GLYPH ((G), -1, 0); \
497 while (0)
499 #define GLYPH_INVALID_P(GLYPH) (GLYPH_CHAR (GLYPH) < 0)
501 /* Is GLYPH a padding glyph? */
503 #define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p
508 /***********************************************************************
509 Glyph Pools
510 ***********************************************************************/
512 /* Glyph Pool.
514 Glyph memory for frame-based redisplay is allocated from the heap
515 in one vector kept in a glyph pool structure which is stored with
516 the frame. The size of the vector is made large enough to cover
517 all windows on the frame.
519 Both frame and window glyph matrices reference memory from a glyph
520 pool in frame-based redisplay.
522 In window-based redisplay, no glyphs pools exist; windows allocate
523 and free their glyph memory themselves. */
525 struct glyph_pool
527 /* Vector of glyphs allocated from the heap. */
528 struct glyph *glyphs;
530 /* Allocated size of `glyphs'. */
531 int nglyphs;
533 /* Number of rows and columns in a matrix. */
534 int nrows, ncolumns;
539 /***********************************************************************
540 Glyph Matrix
541 ***********************************************************************/
543 /* Glyph Matrix.
545 Three kinds of glyph matrices exist:
547 1. Frame glyph matrices. These are used for terminal frames whose
548 redisplay needs a view of the whole screen due to limited terminal
549 capabilities. Frame matrices are used only in the update phase
550 of redisplay. They are built in update_frame and not used after
551 the update has been performed.
553 2. Window glyph matrices on frames having frame glyph matrices.
554 Such matrices are sub-matrices of their corresponding frame matrix,
555 i.e. frame glyph matrices and window glyph matrices share the same
556 glyph memory which is allocated in form of a glyph_pool structure.
557 Glyph rows in such a window matrix are slices of frame matrix rows.
559 2. Free-standing window glyph matrices managing their own glyph
560 storage. This form is used in window-based redisplay which
561 includes variable width and height fonts etc.
563 The size of a window's row vector depends on the height of fonts
564 defined on its frame. It is chosen so that the vector is large
565 enough to describe all lines in a window when it is displayed in
566 the smallest possible character size. When new fonts are loaded,
567 or window sizes change, the row vector is adjusted accordingly. */
569 struct glyph_matrix
571 /* The pool from which glyph memory is allocated, if any. This is
572 null for frame matrices and for window matrices managing their
573 own storage. */
574 struct glyph_pool *pool;
576 /* Vector of glyph row structures. The row at nrows - 1 is reserved
577 for the mode line. */
578 struct glyph_row *rows;
580 /* Number of elements allocated for the vector rows above. */
581 int rows_allocated;
583 /* The number of rows used by the window if all lines were displayed
584 with the smallest possible character height. */
585 int nrows;
587 /* Origin within the frame matrix if this is a window matrix on a
588 frame having a frame matrix. Both values are zero for
589 window-based redisplay. */
590 int matrix_x, matrix_y;
592 /* Width and height of the matrix in columns and rows. */
593 int matrix_w, matrix_h;
595 /* If this structure describes a window matrix of window W,
596 window_left_col is the value of W->left_col, window_top_line the
597 value of W->top_line, window_height and window_width are width and
598 height of W, as returned by window_box, and window_vscroll is the
599 value of W->vscroll at the time the matrix was last adjusted.
600 Only set for window-based redisplay. */
601 int window_left_col, window_top_line;
602 int window_height, window_width;
603 int window_vscroll;
605 /* Number of glyphs reserved for left and right marginal areas when
606 the matrix was last adjusted. */
607 int left_margin_glyphs, right_margin_glyphs;
609 /* Flag indicating that scrolling should not be tried in
610 update_window. This flag is set by functions like try_window_id
611 which do their own scrolling. */
612 unsigned no_scrolling_p : 1;
614 /* Non-zero means window displayed in this matrix has a top mode
615 line. */
616 unsigned header_line_p : 1;
618 #ifdef GLYPH_DEBUG
619 /* A string identifying the method used to display the matrix. */
620 char method[512];
621 #endif
623 /* The buffer this matrix displays. Set in
624 mark_window_display_accurate_1. */
625 struct buffer *buffer;
627 /* Values of BEGV and ZV as of last redisplay. Set in
628 mark_window_display_accurate_1. */
629 int begv, zv;
633 /* Check that glyph pointers stored in glyph rows of MATRIX are okay.
634 This aborts if any pointer is found twice. */
636 #if GLYPH_DEBUG
637 void check_matrix_pointer_lossage P_ ((struct glyph_matrix *));
638 #define CHECK_MATRIX(MATRIX) check_matrix_pointer_lossage ((MATRIX))
639 #else
640 #define CHECK_MATRIX(MATRIX) (void) 0
641 #endif
645 /***********************************************************************
646 Glyph Rows
647 ***********************************************************************/
649 /* Area in window glyph matrix. If values are added or removed, the
650 function mark_object in alloc.c has to be changed. */
652 enum glyph_row_area
654 LEFT_MARGIN_AREA,
655 TEXT_AREA,
656 RIGHT_MARGIN_AREA,
657 LAST_AREA
661 /* Rows of glyphs in a windows or frame glyph matrix.
663 Each row is partitioned into three areas. The start and end of
664 each area is recorded in a pointer as shown below.
666 +--------------------+-------------+---------------------+
667 | left margin area | text area | right margin area |
668 +--------------------+-------------+---------------------+
669 | | | |
670 glyphs[LEFT_MARGIN_AREA] glyphs[RIGHT_MARGIN_AREA]
672 glyphs[TEXT_AREA] |
673 glyphs[LAST_AREA]
675 Rows in frame matrices reference glyph memory allocated in a frame
676 glyph pool (see the description of struct glyph_pool). Rows in
677 window matrices on frames having frame matrices reference slices of
678 the glyphs of corresponding rows in the frame matrix.
680 Rows in window matrices on frames having no frame matrices point to
681 glyphs allocated from the heap via xmalloc;
682 glyphs[LEFT_MARGIN_AREA] is the start address of the allocated
683 glyph structure array. */
685 struct glyph_row
687 /* Pointers to beginnings of areas. The end of an area A is found at
688 A + 1 in the vector. The last element of the vector is the end
689 of the whole row.
691 Kludge alert: Even if used[TEXT_AREA] == 0, glyphs[TEXT_AREA][0]'s
692 position field is used. It is -1 if this row does not correspond
693 to any text; it is some buffer position if the row corresponds to
694 an empty display line that displays a line end. This is what old
695 redisplay used to do. (Except in code for terminal frames, this
696 kludge is no longer used, I believe. --gerd).
698 See also start, end, displays_text_p and ends_at_zv_p for cleaner
699 ways to do it. The special meaning of positions 0 and -1 will be
700 removed some day, so don't use it in new code. */
701 struct glyph *glyphs[1 + LAST_AREA];
703 /* Number of glyphs actually filled in areas. */
704 short used[LAST_AREA];
706 /* Window-relative x and y-position of the top-left corner of this
707 row. If y < 0, this means that eabs (y) pixels of the row are
708 invisible because it is partially visible at the top of a window.
709 If x < 0, this means that eabs (x) pixels of the first glyph of
710 the text area of the row are invisible because the glyph is
711 partially visible. */
712 int x, y;
714 /* Width of the row in pixels without taking face extension at the
715 end of the row into account, and without counting truncation
716 and continuation glyphs at the end of a row on ttys. */
717 int pixel_width;
719 /* Logical ascent/height of this line. The value of ascent is zero
720 and height is 1 on terminal frames. */
721 int ascent, height;
723 /* Physical ascent/height of this line. If max_ascent > ascent,
724 this line overlaps the line above it on the display. Otherwise,
725 if max_height > height, this line overlaps the line beneath it. */
726 int phys_ascent, phys_height;
728 /* Portion of row that is visible. Partially visible rows may be
729 found at the top and bottom of a window. This is 1 for tty
730 frames. It may be < 0 in case of completely invisible rows. */
731 int visible_height;
733 /* Extra line spacing added after this row. Do not consider this
734 in last row when checking if row is fully visible. */
735 int extra_line_spacing;
737 /* Hash code. This hash code is available as soon as the row
738 is constructed, i.e. after a call to display_line. */
739 unsigned hash;
741 /* First position in this row. This is the text position, including
742 overlay position information etc, where the display of this row
743 started, and can thus be less the position of the first glyph
744 (e.g. due to invisible text or horizontal scrolling). */
745 struct display_pos start;
747 /* Text position at the end of this row. This is the position after
748 the last glyph on this row. It can be greater than the last
749 glyph position + 1, due to truncation, invisible text etc. In an
750 up-to-date display, this should always be equal to the start
751 position of the next row. */
752 struct display_pos end;
754 /* Non-zero means the overlay arrow bitmap is on this line.
755 -1 means use default overlay arrow bitmap, else
756 it specifies actual fringe bitmap number. */
757 int overlay_arrow_bitmap;
759 /* Left fringe bitmap number (enum fringe_bitmap_type). */
760 unsigned left_user_fringe_bitmap : FRINGE_ID_BITS;
762 /* Right fringe bitmap number (enum fringe_bitmap_type). */
763 unsigned right_user_fringe_bitmap : FRINGE_ID_BITS;
765 /* Left fringe bitmap number (enum fringe_bitmap_type). */
766 unsigned left_fringe_bitmap : FRINGE_ID_BITS;
768 /* Right fringe bitmap number (enum fringe_bitmap_type). */
769 unsigned right_fringe_bitmap : FRINGE_ID_BITS;
771 /* Face of the left fringe glyph. */
772 unsigned left_user_fringe_face_id : FACE_ID_BITS;
774 /* Face of the right fringe glyph. */
775 unsigned right_user_fringe_face_id : FACE_ID_BITS;
777 /* Face of the left fringe glyph. */
778 unsigned left_fringe_face_id : FACE_ID_BITS;
780 /* Face of the right fringe glyph. */
781 unsigned right_fringe_face_id : FACE_ID_BITS;
783 /* Vertical offset of the left fringe bitmap. */
784 signed left_fringe_offset : FRINGE_HEIGHT_BITS;
786 /* Vertical offset of the right fringe bitmap. */
787 signed right_fringe_offset : FRINGE_HEIGHT_BITS;
789 /* 1 means that we must draw the bitmaps of this row. */
790 unsigned redraw_fringe_bitmaps_p : 1;
792 /* In a desired matrix, 1 means that this row must be updated. In a
793 current matrix, 0 means that the row has been invalidated, i.e.
794 the row's contents do not agree with what is visible on the
795 screen. */
796 unsigned enabled_p : 1;
798 /* 1 means row displays a text line that is truncated on the left or
799 right side. */
800 unsigned truncated_on_left_p : 1;
801 unsigned truncated_on_right_p : 1;
803 /* 1 means that this row displays a continued line, i.e. it has a
804 continuation mark at the right side. */
805 unsigned continued_p : 1;
807 /* 0 means that this row does not contain any text, i.e. it is
808 a blank line at the window and buffer end. */
809 unsigned displays_text_p : 1;
811 /* 1 means that this line ends at ZV. */
812 unsigned ends_at_zv_p : 1;
814 /* 1 means the face of the last glyph in the text area is drawn to
815 the right end of the window. This flag is used in
816 update_text_area to optimize clearing to the end of the area. */
817 unsigned fill_line_p : 1;
819 /* Non-zero means display a bitmap on X frames indicating that this
820 line contains no text and ends in ZV. */
821 unsigned indicate_empty_line_p : 1;
823 /* 1 means this row contains glyphs that overlap each other because
824 of lbearing or rbearing. */
825 unsigned contains_overlapping_glyphs_p : 1;
827 /* 1 means this row is as wide as the window it is displayed in, including
828 scroll bars, fringes, and internal borders. This also
829 implies that the row doesn't have marginal areas. */
830 unsigned full_width_p : 1;
832 /* Non-zero means row is a mode or header-line. */
833 unsigned mode_line_p : 1;
835 /* 1 in a current row means this row is overlapped by another row. */
836 unsigned overlapped_p : 1;
838 /* 1 means this line ends in the middle of a character consisting
839 of more than one glyph. Some glyphs have been put in this row,
840 the rest are put in rows below this one. */
841 unsigned ends_in_middle_of_char_p : 1;
843 /* 1 means this line starts in the middle of a character consisting
844 of more than one glyph. Some glyphs have been put in the
845 previous row, the rest are put in this row. */
846 unsigned starts_in_middle_of_char_p : 1;
848 /* 1 in a current row means this row overlaps others. */
849 unsigned overlapping_p : 1;
851 /* 1 means some glyphs in this row are displayed in mouse-face. */
852 unsigned mouse_face_p : 1;
854 /* 1 means this row was ended by a newline from a string. */
855 unsigned ends_in_newline_from_string_p : 1;
857 /* 1 means this row width is exactly the width of the window, and the
858 final newline character is hidden in the right fringe. */
859 unsigned exact_window_width_line_p : 1;
861 /* 1 means this row currently shows the cursor in the right fringe. */
862 unsigned cursor_in_fringe_p : 1;
864 /* 1 means the last glyph in the row is part of an ellipsis. */
865 unsigned ends_in_ellipsis_p : 1;
867 /* Non-zero means display a bitmap on X frames indicating that this
868 the first line of the buffer. */
869 unsigned indicate_bob_p : 1;
871 /* Non-zero means display a bitmap on X frames indicating that this
872 the top line of the window, but not start of the buffer. */
873 unsigned indicate_top_line_p : 1;
875 /* Non-zero means display a bitmap on X frames indicating that this
876 the last line of the buffer. */
877 unsigned indicate_eob_p : 1;
879 /* Non-zero means display a bitmap on X frames indicating that this
880 the bottom line of the window, but not end of the buffer. */
881 unsigned indicate_bottom_line_p : 1;
883 /* Continuation lines width at the start of the row. */
884 int continuation_lines_width;
886 #ifdef HAVE_WINDOW_SYSTEM
887 /* Non-NULL means the current clipping area. This is temporarily
888 set while exposing a region. Coordinates are frame-relative. */
889 XRectangle *clip;
890 #endif
894 /* Get a pointer to row number ROW in matrix MATRIX. If GLYPH_DEBUG
895 is defined to a non-zero value, the function matrix_row checks that
896 we don't try to access rows that are out of bounds. */
898 #if GLYPH_DEBUG
899 struct glyph_row *matrix_row P_ ((struct glyph_matrix *, int));
900 #define MATRIX_ROW(MATRIX, ROW) matrix_row ((MATRIX), (ROW))
901 #else
902 #define MATRIX_ROW(MATRIX, ROW) ((MATRIX)->rows + (ROW))
903 #endif
905 /* Return a pointer to the row reserved for the mode line in MATRIX.
906 Row MATRIX->nrows - 1 is always reserved for the mode line. */
908 #define MATRIX_MODE_LINE_ROW(MATRIX) \
909 ((MATRIX)->rows + (MATRIX)->nrows - 1)
911 /* Return a pointer to the row reserved for the header line in MATRIX.
912 This is always the first row in MATRIX because that's the only
913 way that works in frame-based redisplay. */
915 #define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows
917 /* Return a pointer to first row in MATRIX used for text display. */
919 #define MATRIX_FIRST_TEXT_ROW(MATRIX) \
920 ((MATRIX)->rows->mode_line_p ? (MATRIX)->rows + 1 : (MATRIX)->rows)
922 /* Return a pointer to the first glyph in the text area of a row.
923 MATRIX is the glyph matrix accessed, and ROW is the row index in
924 MATRIX. */
926 #define MATRIX_ROW_GLYPH_START(MATRIX, ROW) \
927 (MATRIX_ROW ((MATRIX), (ROW))->glyphs[TEXT_AREA])
929 /* Return the number of used glyphs in the text area of a row. */
931 #define MATRIX_ROW_USED(MATRIX, ROW) \
932 (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA])
934 /* Return the character/ byte position at which the display of ROW
935 starts. */
937 #define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->start.pos.charpos)
938 #define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->start.pos.bytepos)
940 /* Return the character/ byte position at which ROW ends. */
942 #define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->end.pos.charpos)
943 #define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->end.pos.bytepos)
945 /* Return the vertical position of ROW in MATRIX. */
947 #define MATRIX_ROW_VPOS(ROW, MATRIX) ((ROW) - (MATRIX)->rows)
949 /* Return the last glyph row + 1 in MATRIX on window W reserved for
950 text. If W has a mode line, the last row in the matrix is reserved
951 for it. */
953 #define MATRIX_BOTTOM_TEXT_ROW(MATRIX, W) \
954 ((MATRIX)->rows \
955 + (MATRIX)->nrows \
956 - (WINDOW_WANTS_MODELINE_P ((W)) ? 1 : 0))
958 /* Non-zero if the face of the last glyph in ROW's text area has
959 to be drawn to the end of the text area. */
961 #define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)
963 /* Set and query the enabled_p flag of glyph row ROW in MATRIX. */
965 #define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
966 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0)
968 #define MATRIX_ROW_ENABLED_P(MATRIX, ROW) \
969 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p)
971 /* Non-zero if ROW displays text. Value is non-zero if the row is
972 blank but displays a line end. */
974 #define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)
977 /* Helper macros */
979 #define MR_PARTIALLY_VISIBLE(ROW) \
980 ((ROW)->height != (ROW)->visible_height)
982 #define MR_PARTIALLY_VISIBLE_AT_TOP(W, ROW) \
983 ((ROW)->y < WINDOW_HEADER_LINE_HEIGHT ((W)))
985 #define MR_PARTIALLY_VISIBLE_AT_BOTTOM(W, ROW) \
986 (((ROW)->y + (ROW)->height - (ROW)->extra_line_spacing) \
987 > WINDOW_BOX_HEIGHT_NO_MODE_LINE ((W)))
989 /* Non-zero if ROW is not completely visible in window W. */
991 #define MATRIX_ROW_PARTIALLY_VISIBLE_P(W, ROW) \
992 (MR_PARTIALLY_VISIBLE ((ROW)) \
993 && (MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)) \
994 || MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW))))
998 /* Non-zero if ROW is partially visible at the top of window W. */
1000 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW) \
1001 (MR_PARTIALLY_VISIBLE ((ROW)) \
1002 && MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)))
1004 /* Non-zero if ROW is partially visible at the bottom of window W. */
1006 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW) \
1007 (MR_PARTIALLY_VISIBLE ((ROW)) \
1008 && MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW)))
1010 /* Return the bottom Y + 1 of ROW. */
1012 #define MATRIX_ROW_BOTTOM_Y(ROW) ((ROW)->y + (ROW)->height)
1014 /* Is ROW the last visible one in the display described by the
1015 iterator structure pointed to by IT?. */
1017 #define MATRIX_ROW_LAST_VISIBLE_P(ROW, IT) \
1018 (MATRIX_ROW_BOTTOM_Y ((ROW)) >= (IT)->last_visible_y)
1020 /* Non-zero if ROW displays a continuation line. */
1022 #define MATRIX_ROW_CONTINUATION_LINE_P(ROW) \
1023 ((ROW)->continuation_lines_width > 0)
1025 /* Non-zero if ROW ends in the middle of a character. This is the
1026 case for continued lines showing only part of a display table entry
1027 or a control char, or an overlay string. */
1029 #define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW) \
1030 ((ROW)->end.dpvec_index > 0 \
1031 || (ROW)->end.overlay_string_index >= 0 \
1032 || (ROW)->ends_in_middle_of_char_p)
1034 /* Non-zero if ROW ends in the middle of an overlay string. */
1036 #define MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P(ROW) \
1037 ((ROW)->end.overlay_string_index >= 0)
1039 /* Non-zero if ROW starts in the middle of a character. See above. */
1041 #define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW) \
1042 ((ROW)->start.dpvec_index > 0 \
1043 || (ROW)->starts_in_middle_of_char_p \
1044 || ((ROW)->start.overlay_string_index >= 0 \
1045 && (ROW)->start.string_pos.charpos > 0))
1047 /* Non-zero means ROW overlaps its predecessor. */
1049 #define MATRIX_ROW_OVERLAPS_PRED_P(ROW) \
1050 ((ROW)->phys_ascent > (ROW)->ascent)
1052 /* Non-zero means ROW overlaps its successor. */
1054 #define MATRIX_ROW_OVERLAPS_SUCC_P(ROW) \
1055 ((ROW)->phys_height - (ROW)->phys_ascent \
1056 > (ROW)->height - (ROW)->ascent)
1058 /* Non-zero means that fonts have been loaded since the last glyph
1059 matrix adjustments. The function redisplay_internal adjusts glyph
1060 matrices when this flag is non-zero. */
1062 extern int fonts_changed_p;
1064 /* A glyph for a space. */
1066 extern struct glyph space_glyph;
1068 /* Window being updated by update_window. This is non-null as long as
1069 update_window has not finished, and null otherwise. */
1071 extern struct window *updated_window;
1073 /* Glyph row and area updated by update_window_line. */
1075 extern struct glyph_row *updated_row;
1076 extern int updated_area;
1078 /* Non-zero means reading single-character input with prompt so put
1079 cursor on mini-buffer after the prompt. Positive means at end of
1080 text in echo area; negative means at beginning of line. */
1082 extern int cursor_in_echo_area;
1084 /* Non-zero means last display completed. Zero means it was
1085 preempted. */
1087 extern int display_completed;
1089 /* Non-zero means redisplay has been performed directly (see also
1090 direct_output_for_insert and direct_output_forward_char), so that
1091 no further updating has to be performed. The function
1092 redisplay_internal checks this flag, and does nothing but reset it
1093 to zero if it is non-zero. */
1095 extern int redisplay_performed_directly_p;
1097 /* A temporary storage area, including a row of glyphs. Initialized
1098 in xdisp.c. Used for various purposes, as an example see
1099 direct_output_for_insert. */
1101 extern struct glyph_row scratch_glyph_row;
1105 /************************************************************************
1106 Glyph Strings
1107 ************************************************************************/
1109 /* Enumeration for overriding/changing the face to use for drawing
1110 glyphs in draw_glyphs. */
1112 enum draw_glyphs_face
1114 DRAW_NORMAL_TEXT,
1115 DRAW_INVERSE_VIDEO,
1116 DRAW_CURSOR,
1117 DRAW_MOUSE_FACE,
1118 DRAW_IMAGE_RAISED,
1119 DRAW_IMAGE_SUNKEN
1122 #ifdef HAVE_WINDOW_SYSTEM
1124 /* A sequence of glyphs to be drawn in the same face. */
1126 struct glyph_string
1128 /* X-origin of the string. */
1129 int x;
1131 /* Y-origin and y-position of the base line of this string. */
1132 int y, ybase;
1134 /* The width of the string, not including a face extension. */
1135 int width;
1137 /* The width of the string, including a face extension. */
1138 int background_width;
1140 /* The height of this string. This is the height of the line this
1141 string is drawn in, and can be different from the height of the
1142 font the string is drawn in. */
1143 int height;
1145 /* Number of pixels this string overwrites in front of its x-origin.
1146 This number is zero if the string has an lbearing >= 0; it is
1147 -lbearing, if the string has an lbearing < 0. */
1148 int left_overhang;
1150 /* Number of pixels this string overwrites past its right-most
1151 nominal x-position, i.e. x + width. Zero if the string's
1152 rbearing is <= its nominal width, rbearing - width otherwise. */
1153 int right_overhang;
1155 /* The frame on which the glyph string is drawn. */
1156 struct frame *f;
1158 /* The window on which the glyph string is drawn. */
1159 struct window *w;
1161 /* X display and window for convenience. */
1162 Display *display;
1163 Window window;
1165 /* The glyph row for which this string was built. It determines the
1166 y-origin and height of the string. */
1167 struct glyph_row *row;
1169 /* The area within row. */
1170 enum glyph_row_area area;
1172 /* Characters to be drawn, and number of characters. */
1173 XChar2b *char2b;
1174 int nchars;
1176 /* A face-override for drawing cursors, mouse face and similar. */
1177 enum draw_glyphs_face hl;
1179 /* Face in which this string is to be drawn. */
1180 struct face *face;
1182 /* Font in which this string is to be drawn. */
1183 struct font *font;
1185 /* Non-null means this string describes (part of) a static
1186 composition. */
1187 struct composition *cmp;
1189 /* If not negative, this string describes a compos. */
1190 int cmp_id;
1192 /* Start and end glyph indices in a glyph-string. */
1193 int cmp_from, cmp_to;
1195 /* 1 means this glyph strings face has to be drawn to the right end
1196 of the window's drawing area. */
1197 unsigned extends_to_end_of_line_p : 1;
1199 /* 1 means the background of this string has been drawn. */
1200 unsigned background_filled_p : 1;
1202 /* 1 means glyph string must be drawn with 16-bit functions. */
1203 unsigned two_byte_p : 1;
1205 /* 1 means that the original font determined for drawing this glyph
1206 string could not be loaded. The member `font' has been set to
1207 the frame's default font in this case. */
1208 unsigned font_not_found_p : 1;
1210 /* 1 means that the face in which this glyph string is drawn has a
1211 stipple pattern. */
1212 unsigned stippled_p : 1;
1214 #define OVERLAPS_PRED (1 << 0)
1215 #define OVERLAPS_SUCC (1 << 1)
1216 #define OVERLAPS_BOTH (OVERLAPS_PRED | OVERLAPS_SUCC)
1217 #define OVERLAPS_ERASED_CURSOR (1 << 2)
1218 /* Non-zero means only the foreground of this glyph string must be
1219 drawn, and we should use the physical height of the line this
1220 glyph string appears in as clip rect. If the value is
1221 OVERLAPS_ERASED_CURSOR, the clip rect is restricted to the rect
1222 of the erased cursor. OVERLAPS_PRED and OVERLAPS_SUCC mean we
1223 draw overlaps with the preceding and the succeeding rows,
1224 respectively. */
1225 unsigned for_overlaps : 3;
1227 /* 1 means that all glyphs in this glyph string has the flag
1228 padding_p set, and thus must be drawn one by one to have 1-pixel
1229 width even though the logical width in the font is zero. */
1230 unsigned padding_p : 1;
1232 /* The GC to use for drawing this glyph string. */
1233 #if defined(HAVE_X_WINDOWS)
1234 GC gc;
1235 #endif
1236 #if defined(HAVE_NTGUI)
1237 XGCValues *gc;
1238 HDC hdc;
1239 #endif
1241 /* A pointer to the first glyph in the string. This glyph
1242 corresponds to char2b[0]. Needed to draw rectangles if
1243 font_not_found_p is 1. */
1244 struct glyph *first_glyph;
1246 /* Image, if any. */
1247 struct image *img;
1249 /* Slice */
1250 struct glyph_slice slice;
1252 /* Non-null means the horizontal clipping region starts from the
1253 left edge of *clip_head, and ends with the right edge of
1254 *clip_tail, not including their overhangs. */
1255 struct glyph_string *clip_head, *clip_tail;
1257 /* The current clipping areas. */
1258 NativeRectangle clip[2];
1260 /* Number of clipping areas. */
1261 int num_clips;
1263 int underline_position;
1265 int underline_thickness;
1267 struct glyph_string *next, *prev;
1270 #endif /* HAVE_WINDOW_SYSTEM */
1273 /************************************************************************
1274 Display Dimensions
1275 ************************************************************************/
1277 /* Return the height of the mode line in glyph matrix MATRIX, or zero
1278 if not known. This macro is called under circumstances where
1279 MATRIX might not have been allocated yet. */
1281 #define MATRIX_MODE_LINE_HEIGHT(MATRIX) \
1282 ((MATRIX) && (MATRIX)->rows \
1283 ? MATRIX_MODE_LINE_ROW (MATRIX)->height \
1284 : 0)
1286 /* Return the height of the header line in glyph matrix MATRIX, or zero
1287 if not known. This macro is called under circumstances where
1288 MATRIX might not have been allocated yet. */
1290 #define MATRIX_HEADER_LINE_HEIGHT(MATRIX) \
1291 ((MATRIX) && (MATRIX)->rows \
1292 ? MATRIX_HEADER_LINE_ROW (MATRIX)->height \
1293 : 0)
1295 /* Return the desired face id for the mode line of a window, depending
1296 on whether the window is selected or not, or if the window is the
1297 scrolling window for the currently active minibuffer window.
1299 Due to the way display_mode_lines manipulates with the contents of
1300 selected_window, this macro needs three arguments: SELW which is
1301 compared against the current value of selected_window, MBW which is
1302 compared against minibuf_window (if SELW doesn't match), and SCRW
1303 which is compared against minibuf_selected_window (if MBW matches). */
1305 #define CURRENT_MODE_LINE_FACE_ID_3(SELW, MBW, SCRW) \
1306 ((!mode_line_in_non_selected_windows \
1307 || (SELW) == XWINDOW (selected_window) \
1308 || (minibuf_level > 0 \
1309 && !NILP (minibuf_selected_window) \
1310 && (MBW) == XWINDOW (minibuf_window) \
1311 && (SCRW) == XWINDOW (minibuf_selected_window))) \
1312 ? MODE_LINE_FACE_ID \
1313 : MODE_LINE_INACTIVE_FACE_ID)
1316 /* Return the desired face id for the mode line of window W. */
1318 #define CURRENT_MODE_LINE_FACE_ID(W) \
1319 (CURRENT_MODE_LINE_FACE_ID_3((W), XWINDOW (selected_window), (W)))
1321 /* Return the current height of the mode line of window W. If not
1322 known from current_mode_line_height, look at W's current glyph
1323 matrix, or return a default based on the height of the font of the
1324 face `mode-line'. */
1326 #define CURRENT_MODE_LINE_HEIGHT(W) \
1327 (current_mode_line_height >= 0 \
1328 ? current_mode_line_height \
1329 : (MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1330 ? MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1331 : estimate_mode_line_height (XFRAME ((W)->frame), \
1332 CURRENT_MODE_LINE_FACE_ID (W))))
1334 /* Return the current height of the header line of window W. If not
1335 known from current_header_line_height, look at W's current glyph
1336 matrix, or return an estimation based on the height of the font of
1337 the face `header-line'. */
1339 #define CURRENT_HEADER_LINE_HEIGHT(W) \
1340 (current_header_line_height >= 0 \
1341 ? current_header_line_height \
1342 : (MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1343 ? MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1344 : estimate_mode_line_height (XFRAME ((W)->frame), \
1345 HEADER_LINE_FACE_ID)))
1347 /* Return the height of the desired mode line of window W. */
1349 #define DESIRED_MODE_LINE_HEIGHT(W) \
1350 MATRIX_MODE_LINE_HEIGHT ((W)->desired_matrix)
1352 /* Return the height of the desired header line of window W. */
1354 #define DESIRED_HEADER_LINE_HEIGHT(W) \
1355 MATRIX_HEADER_LINE_HEIGHT ((W)->desired_matrix)
1357 /* Value is non-zero if window W wants a mode line. */
1359 #define WINDOW_WANTS_MODELINE_P(W) \
1360 (!MINI_WINDOW_P ((W)) \
1361 && !(W)->pseudo_window_p \
1362 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1363 && BUFFERP ((W)->buffer) \
1364 && !NILP (XBUFFER ((W)->buffer)->mode_line_format) \
1365 && WINDOW_TOTAL_LINES (W) > 1)
1367 /* Value is non-zero if window W wants a header line. */
1369 #define WINDOW_WANTS_HEADER_LINE_P(W) \
1370 (!MINI_WINDOW_P ((W)) \
1371 && !(W)->pseudo_window_p \
1372 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1373 && BUFFERP ((W)->buffer) \
1374 && !NILP (XBUFFER ((W)->buffer)->header_line_format) \
1375 && WINDOW_TOTAL_LINES (W) > 1 + !NILP (XBUFFER ((W)->buffer)->mode_line_format))
1378 /* Return proper value to be used as baseline offset of font that has
1379 ASCENT and DESCENT to draw characters by the font at the vertical
1380 center of the line of frame F.
1382 Here, our task is to find the value of BOFF in the following figure;
1384 -------------------------+-----------+-
1385 -+-+---------+-+ | |
1386 | | | | | |
1387 | | | | F_ASCENT F_HEIGHT
1388 | | | ASCENT | |
1389 HEIGHT | | | | |
1390 | | |-|-+------+-----------|------- baseline
1391 | | | | BOFF | |
1392 | |---------|-+-+ | |
1393 | | | DESCENT | |
1394 -+-+---------+-+ F_DESCENT |
1395 -------------------------+-----------+-
1397 -BOFF + DESCENT + (F_HEIGHT - HEIGHT) / 2 = F_DESCENT
1398 BOFF = DESCENT + (F_HEIGHT - HEIGHT) / 2 - F_DESCENT
1399 DESCENT = FONT->descent
1400 HEIGHT = FONT_HEIGHT (FONT)
1401 F_DESCENT = (FRAME_FONT (F)->descent
1402 - F->terminal->output_data.x->baseline_offset)
1403 F_HEIGHT = FRAME_LINE_HEIGHT (F)
1406 #define VCENTER_BASELINE_OFFSET(FONT, F) \
1407 (FONT_DESCENT (FONT) \
1408 + (FRAME_LINE_HEIGHT ((F)) - FONT_HEIGHT ((FONT)) \
1409 + (FRAME_LINE_HEIGHT ((F)) > FONT_HEIGHT ((FONT)))) / 2 \
1410 - (FONT_DESCENT (FRAME_FONT (F)) - FRAME_BASELINE_OFFSET (F)))
1413 /***********************************************************************
1414 Faces
1415 ***********************************************************************/
1417 /* Indices of face attributes in Lisp face vectors. Slot zero is the
1418 symbol `face'. */
1420 enum lface_attribute_index
1422 LFACE_FAMILY_INDEX = 1,
1423 LFACE_FOUNDRY_INDEX,
1424 LFACE_SWIDTH_INDEX,
1425 LFACE_HEIGHT_INDEX,
1426 LFACE_WEIGHT_INDEX,
1427 LFACE_SLANT_INDEX,
1428 LFACE_UNDERLINE_INDEX,
1429 LFACE_INVERSE_INDEX,
1430 LFACE_FOREGROUND_INDEX,
1431 LFACE_BACKGROUND_INDEX,
1432 LFACE_STIPPLE_INDEX,
1433 LFACE_OVERLINE_INDEX,
1434 LFACE_STRIKE_THROUGH_INDEX,
1435 LFACE_BOX_INDEX,
1436 LFACE_FONT_INDEX,
1437 LFACE_INHERIT_INDEX,
1438 LFACE_FONTSET_INDEX,
1439 LFACE_VECTOR_SIZE
1443 /* Box types of faces. */
1445 enum face_box_type
1447 /* No box around text. */
1448 FACE_NO_BOX,
1450 /* Simple box of specified width and color. Default width is 1, and
1451 default color is the foreground color of the face. */
1452 FACE_SIMPLE_BOX,
1454 /* Boxes with 3D shadows. Color equals the background color of the
1455 face. Width is specified. */
1456 FACE_RAISED_BOX,
1457 FACE_SUNKEN_BOX
1461 /* Structure describing a realized face.
1463 For each Lisp face, 0..N realized faces can exist for different
1464 frames and different charsets. Realized faces are built from Lisp
1465 faces and text properties/overlays by merging faces and adding
1466 unspecified attributes from the `default' face. */
1468 struct face
1470 /* The id of this face. The id equals the index of this face in the
1471 vector faces_by_id of its face cache. */
1472 int id;
1474 #ifdef HAVE_WINDOW_SYSTEM
1476 /* If non-zero, this is a GC that we can use without modification for
1477 drawing the characters in this face. */
1478 GC gc;
1480 /* Background stipple or bitmap used for this face. This is
1481 an id as returned from load_pixmap. */
1482 int stipple;
1484 #else /* not HAVE_WINDOW_SYSTEM */
1486 /* Dummy. */
1487 int stipple;
1489 #endif /* not HAVE_WINDOW_SYSTEM */
1491 /* Pixel value of foreground color for X frames. Color index
1492 for tty frames. */
1493 unsigned long foreground;
1495 /* Pixel value or color index of background color. */
1496 unsigned long background;
1498 /* Pixel value or color index of underline color. */
1499 unsigned long underline_color;
1501 /* Pixel value or color index of overlined, strike-through, or box
1502 color. */
1503 unsigned long overline_color;
1504 unsigned long strike_through_color;
1505 unsigned long box_color;
1507 struct font *font;
1509 /* Fontset ID if for this face's fontset. Non-ASCII faces derived
1510 from the same ASCII face have the same fontset. */
1511 int fontset;
1513 /* Pixmap width and height. */
1514 unsigned int pixmap_w, pixmap_h;
1516 /* Non-zero means characters in this face have a box that thickness
1517 around them. If it is negative, the absolute value indicates the
1518 thickness, and the horizontal lines of box (top and bottom) are
1519 drawn inside of characters glyph area. The vertical lines of box
1520 (left and right) are drawn as the same way as the case that this
1521 value is positive. */
1522 int box_line_width;
1524 /* Type of box drawn. A value of FACE_NO_BOX means no box is drawn
1525 around text in this face. A value of FACE_SIMPLE_BOX means a box
1526 of width box_line_width is drawn in color box_color. A value of
1527 FACE_RAISED_BOX or FACE_SUNKEN_BOX means a 3D box is drawn with
1528 shadow colors derived from the background color of the face. */
1529 enum face_box_type box;
1531 /* If `box' above specifies a 3D type, 1 means use box_color for
1532 drawing shadows. */
1533 unsigned use_box_color_for_shadows_p : 1;
1535 /* Non-zero if text in this face should be underlined, overlined,
1536 strike-through or have a box drawn around it. */
1537 unsigned underline_p : 1;
1538 unsigned overline_p : 1;
1539 unsigned strike_through_p : 1;
1541 /* 1 means that the colors specified for this face could not be
1542 loaded, and were replaced by default colors, so they shouldn't be
1543 freed. */
1544 unsigned foreground_defaulted_p : 1;
1545 unsigned background_defaulted_p : 1;
1547 /* 1 means that either no color is specified for underlining or that
1548 the specified color couldn't be loaded. Use the foreground
1549 color when drawing in that case. */
1550 unsigned underline_defaulted_p : 1;
1552 /* 1 means that either no color is specified for the corresponding
1553 attribute or that the specified color couldn't be loaded.
1554 Use the foreground color when drawing in that case. */
1555 unsigned overline_color_defaulted_p : 1;
1556 unsigned strike_through_color_defaulted_p : 1;
1557 unsigned box_color_defaulted_p : 1;
1559 /* TTY appearances. Blinking is not yet implemented. Colors are
1560 found in `lface' with empty color string meaning the default
1561 color of the TTY. */
1562 unsigned tty_bold_p : 1;
1563 unsigned tty_dim_p : 1;
1564 unsigned tty_underline_p : 1;
1565 unsigned tty_alt_charset_p : 1;
1566 unsigned tty_reverse_p : 1;
1567 unsigned tty_blinking_p : 1;
1569 /* 1 means that colors of this face may not be freed because they
1570 have been copied bitwise from a base face (see
1571 realize_x_face). */
1572 unsigned colors_copied_bitwise_p : 1;
1574 /* If non-zero, use overstrike (to simulate bold-face). */
1575 unsigned overstrike : 1;
1577 /* NOTE: this is not used yet, but eventually this impl should be done
1578 similarly to overstrike */
1579 #ifdef HAVE_NS
1580 /* If non-zero, use geometric rotation (to simulate italic). */
1581 unsigned synth_ital : 1;
1582 #endif
1584 /* The Lisp face attributes this face realizes. All attributes
1585 in this vector are non-nil. */
1586 Lisp_Object lface[LFACE_VECTOR_SIZE];
1588 /* The hash value of this face. */
1589 unsigned hash;
1591 /* Next and previous face in hash collision list of face cache. */
1592 struct face *next, *prev;
1594 /* If this face is an ASCII face, this points to this face itself.
1595 Otherwise, this points to an ASCII face that has the same
1596 attributes except the font. */
1597 struct face *ascii_face;
1599 /* Extra member that a font-driver uses privately. */
1600 void *extra;
1604 /* Color index indicating that face uses a terminal's default color. */
1606 #define FACE_TTY_DEFAULT_COLOR ((unsigned long) -1)
1608 /* Color index indicating that face uses an unknown foreground color. */
1610 #define FACE_TTY_DEFAULT_FG_COLOR ((unsigned long) -2)
1612 /* Color index indicating that face uses an unknown background color. */
1614 #define FACE_TTY_DEFAULT_BG_COLOR ((unsigned long) -3)
1616 /* Non-zero if FACE was realized for unibyte use. */
1618 #define FACE_UNIBYTE_P(FACE) ((FACE)->charset < 0)
1621 /* IDs of important faces known by the C face code. These are the IDs
1622 of the faces for CHARSET_ASCII. */
1624 enum face_id
1626 DEFAULT_FACE_ID,
1627 MODE_LINE_FACE_ID,
1628 MODE_LINE_INACTIVE_FACE_ID,
1629 TOOL_BAR_FACE_ID,
1630 FRINGE_FACE_ID,
1631 HEADER_LINE_FACE_ID,
1632 SCROLL_BAR_FACE_ID,
1633 BORDER_FACE_ID,
1634 CURSOR_FACE_ID,
1635 MOUSE_FACE_ID,
1636 MENU_FACE_ID,
1637 VERTICAL_BORDER_FACE_ID,
1638 BASIC_FACE_ID_SENTINEL
1641 #define MAX_FACE_ID ((1 << FACE_ID_BITS) - 1)
1643 /* A cache of realized faces. Each frame has its own cache because
1644 Emacs allows different frame-local face definitions. */
1646 struct face_cache
1648 /* Hash table of cached realized faces. */
1649 struct face **buckets;
1651 /* Back-pointer to the frame this cache belongs to. */
1652 struct frame *f;
1654 /* A vector of faces so that faces can be referenced by an ID. */
1655 struct face **faces_by_id;
1657 /* The allocated size, and number of used slots of faces_by_id. */
1658 int size, used;
1660 /* Flag indicating that attributes of the `menu' face have been
1661 changed. */
1662 unsigned menu_face_changed_p : 1;
1666 /* Prepare face FACE for use on frame F. This must be called before
1667 using X resources of FACE. */
1669 #define PREPARE_FACE_FOR_DISPLAY(F, FACE) \
1670 if ((FACE)->gc == 0) \
1671 prepare_face_for_display ((F), (FACE)); \
1672 else \
1673 (void) 0
1675 /* Return a pointer to the face with ID on frame F, or null if such a
1676 face doesn't exist. */
1678 #define FACE_FROM_ID(F, ID) \
1679 (((unsigned) (ID) < FRAME_FACE_CACHE (F)->used) \
1680 ? FRAME_FACE_CACHE (F)->faces_by_id[ID] \
1681 : NULL)
1683 #ifdef HAVE_WINDOW_SYSTEM
1685 /* Non-zero if FACE is suitable for displaying character CHAR. */
1687 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) \
1688 (ASCII_CHAR_P (CHAR) \
1689 ? (FACE) == (FACE)->ascii_face \
1690 : face_suitable_for_char_p ((FACE), (CHAR)))
1692 /* Return the id of the realized face on frame F that is like the face
1693 with id ID but is suitable for displaying character CHAR.
1694 This macro is only meaningful for multibyte character CHAR. */
1696 #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) \
1697 ((ASCII_CHAR_P (CHAR) || CHAR_BYTE8_P (CHAR)) \
1698 ? (FACE)->ascii_face->id \
1699 : face_for_char ((F), (FACE), (CHAR), (POS), (OBJECT)))
1701 #else /* not HAVE_WINDOW_SYSTEM */
1703 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) 1
1704 #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) ((FACE)->id)
1706 #endif /* not HAVE_WINDOW_SYSTEM */
1708 /* Non-zero means face attributes have been changed since the last
1709 redisplay. Used in redisplay_internal. */
1711 extern int face_change_count;
1716 /***********************************************************************
1717 Fringes
1718 ***********************************************************************/
1720 /* Structure used to describe where and how to draw a fringe bitmap.
1721 WHICH is the fringe bitmap to draw. WD and H is the (adjusted)
1722 width and height of the bitmap, DH is the height adjustment (if
1723 bitmap is periodic). X and Y are frame coordinates of the area to
1724 display the bitmap, DY is relative offset of the bitmap into that
1725 area. BX, NX, BY, NY specifies the area to clear if the bitmap
1726 does not fill the entire area. FACE is the fringe face. */
1728 struct draw_fringe_bitmap_params
1730 int which; /* enum fringe_bitmap_type */
1731 unsigned short *bits;
1732 int wd, h, dh;
1733 int x, y;
1734 int bx, nx, by, ny;
1735 unsigned cursor_p : 1;
1736 unsigned overlay_p : 1;
1737 struct face *face;
1740 #define MAX_FRINGE_BITMAPS (1<<FRINGE_ID_BITS)
1743 /***********************************************************************
1744 Display Iterator
1745 ***********************************************************************/
1747 /* Iteration over things to display in current_buffer or in a string.
1749 The iterator handles:
1751 1. Overlay strings (after-string, before-string).
1752 2. Face properties.
1753 3. Invisible text properties.
1754 4. Selective display.
1755 5. Translation of characters via display tables.
1756 6. Translation of control characters to the forms `\003' or `^C'.
1757 7. `glyph' and `space-width' properties.
1759 Iterators are initialized by calling init_iterator or one of the
1760 equivalent functions below. A call to get_next_display_element
1761 loads the iterator structure with information about what next to
1762 display. A call to set_iterator_to_next increments the iterator's
1763 position.
1765 Characters from overlay strings, display table entries or control
1766 character translations are returned one at a time. For example, if
1767 we have a text of `a\x01' where `a' has a display table definition
1768 of `cd' and the control character is displayed with a leading
1769 arrow, then the iterator will return:
1771 Call Return Source Call next
1772 -----------------------------------------------------------------
1773 next c display table move
1774 next d display table move
1775 next ^ control char move
1776 next A control char move
1778 The same mechanism is also used to return characters for ellipses
1779 displayed at the end of invisible text.
1781 CAVEAT: Under some circumstances, move_.* functions can be called
1782 asynchronously, e.g. when computing a buffer position from an x and
1783 y pixel position. This means that these functions and functions
1784 called from them SHOULD NOT USE xmalloc and alike. See also the
1785 comment at the start of xdisp.c. */
1787 /* Enumeration describing what kind of display element an iterator is
1788 loaded with after a call to get_next_display_element. */
1790 enum display_element_type
1792 /* A normal character. */
1793 IT_CHARACTER,
1795 /* A composition (static and automatic). */
1796 IT_COMPOSITION,
1798 /* An image. */
1799 IT_IMAGE,
1801 /* A flexible width and height space. */
1802 IT_STRETCH,
1804 /* End of buffer or string. */
1805 IT_EOB,
1807 /* Truncation glyphs. Never returned by get_next_display_element.
1808 Used to get display information about truncation glyphs via
1809 produce_glyphs. */
1810 IT_TRUNCATION,
1812 /* Continuation glyphs. See the comment for IT_TRUNCATION. */
1813 IT_CONTINUATION
1817 /* An enumerator for each text property that has a meaning for display
1818 purposes. */
1820 enum prop_idx
1822 FONTIFIED_PROP_IDX,
1823 FACE_PROP_IDX,
1824 INVISIBLE_PROP_IDX,
1825 DISPLAY_PROP_IDX,
1826 COMPOSITION_PROP_IDX,
1828 /* Not a property. Used to indicate changes in overlays. */
1829 OVERLAY_PROP_IDX,
1831 /* Sentinel. */
1832 LAST_PROP_IDX
1835 /* An enumerator for the method of wrapping long lines. */
1837 enum line_wrap_method
1839 TRUNCATE,
1840 WORD_WRAP,
1841 WINDOW_WRAP
1844 struct it_slice
1846 Lisp_Object x;
1847 Lisp_Object y;
1848 Lisp_Object width;
1849 Lisp_Object height;
1852 /* Input sources for fetching characters or data to display.
1853 The input source is found in the `method' field. */
1855 enum it_method {
1856 GET_FROM_BUFFER = 0,
1857 GET_FROM_DISPLAY_VECTOR,
1858 GET_FROM_STRING,
1859 GET_FROM_C_STRING,
1860 GET_FROM_IMAGE,
1861 GET_FROM_STRETCH,
1862 NUM_IT_METHODS
1865 #define IT_STACK_SIZE 4
1867 /* Iterator for composition (both for static and automatic). */
1868 struct composition_it
1870 /* Next position at which to check the composition. */
1871 EMACS_INT stop_pos;
1872 /* ID number of the composition or glyph-string. If negative, we
1873 are not iterating over a composition now. */
1874 int id;
1875 /* If non-negative, character that triggers the automatic
1876 composition at `stop_pos', and this is an automatic composition.
1877 If negative, this is a static composition. This is set to -2
1878 temporarily if searching of composition reach a limit or a
1879 newline. */
1880 int ch;
1881 /* If this an automatic composition, how many characters to look back
1882 from the position where a character triggering the composition
1883 exists. */
1884 int lookback;
1885 /* If non-negative, number of glyphs of the glyph-string. */
1886 int nglyphs;
1887 /* Number of characters and bytes of the current grapheme cluster. */
1888 int nchars, nbytes;
1889 /* Indices of the glyphs for the current grapheme cluster. */
1890 int from, to;
1891 /* Width of the current grapheme cluster in units of pixels on a
1892 graphic display and in units of canonical characters on a
1893 terminal display. */
1894 int width;
1897 struct it
1899 /* The window in which we iterate over current_buffer (or a string). */
1900 Lisp_Object window;
1901 struct window *w;
1903 /* The window's frame. */
1904 struct frame *f;
1906 /* Method to use to load this structure with the next display element. */
1907 enum it_method method;
1909 /* The next position at which to check for face changes, invisible
1910 text, overlay strings, end of text etc., which see. */
1911 EMACS_INT stop_charpos;
1913 /* Maximum string or buffer position + 1. ZV when iterating over
1914 current_buffer. */
1915 EMACS_INT end_charpos;
1917 /* C string to iterate over. Non-null means get characters from
1918 this string, otherwise characters are read from current_buffer
1919 or it->string. */
1920 unsigned char *s;
1922 /* Number of characters in the string (s, or it->string) we iterate
1923 over. */
1924 int string_nchars;
1926 /* Start and end of a visible region; -1 if the region is not
1927 visible in the window. */
1928 EMACS_INT region_beg_charpos, region_end_charpos;
1930 /* Position at which redisplay end trigger functions should be run. */
1931 EMACS_INT redisplay_end_trigger_charpos;
1933 /* 1 means multibyte characters are enabled. */
1934 unsigned multibyte_p : 1;
1936 /* 1 means window has a mode line at its top. */
1937 unsigned header_line_p : 1;
1939 /* 1 means `string' is the value of a `display' property.
1940 Don't handle some `display' properties in these strings. */
1941 unsigned string_from_display_prop_p : 1;
1943 /* When METHOD == next_element_from_display_vector,
1944 this is 1 if we're doing an ellipsis. Otherwise meaningless. */
1945 unsigned ellipsis_p : 1;
1947 /* True means cursor shouldn't be displayed here. */
1948 unsigned avoid_cursor_p : 1;
1950 /* Display table in effect or null for none. */
1951 struct Lisp_Char_Table *dp;
1953 /* Current display table vector to return characters from and its
1954 end. dpvec null means we are not returning characters from a
1955 display table entry; current.dpvec_index gives the current index
1956 into dpvec. This same mechanism is also used to return
1957 characters from translated control characters, i.e. `\003' or
1958 `^C'. */
1959 Lisp_Object *dpvec, *dpend;
1961 /* Length in bytes of the char that filled dpvec. A value of zero
1962 means that no such character is involved. */
1963 int dpvec_char_len;
1965 /* Face id to use for all characters in display vector. -1 if unused. */
1966 int dpvec_face_id;
1968 /* Face id of the iterator saved in case a glyph from dpvec contains
1969 a face. The face is restored when all glyphs from dpvec have
1970 been delivered. */
1971 int saved_face_id;
1973 /* Vector of glyphs for control character translation. The pointer
1974 dpvec is set to ctl_chars when a control character is translated.
1975 This vector is also used for incomplete multibyte character
1976 translation (e.g \222\244). Such a character is at most 4 bytes,
1977 thus we need at most 16 bytes here. */
1978 Lisp_Object ctl_chars[16];
1980 /* Initial buffer or string position of the iterator, before skipping
1981 over display properties and invisible text. */
1982 struct display_pos start;
1984 /* Current buffer or string position of the iterator, including
1985 position in overlay strings etc. */
1986 struct display_pos current;
1988 /* Total number of overlay strings to process. This can be >
1989 OVERLAY_STRING_CHUNK_SIZE. */
1990 int n_overlay_strings;
1992 /* The charpos where n_overlay_strings was calculated. This should
1993 be set at the same time as n_overlay_strings. It is needed
1994 because we show before-strings at the start of invisible text;
1995 see handle_invisible_prop in xdisp.c. */
1996 int overlay_strings_charpos;
1998 /* Vector of overlays to process. Overlay strings are processed
1999 OVERLAY_STRING_CHUNK_SIZE at a time. */
2000 #define OVERLAY_STRING_CHUNK_SIZE 16
2001 Lisp_Object overlay_strings[OVERLAY_STRING_CHUNK_SIZE];
2003 /* For each overlay string, the overlay it came from. */
2004 Lisp_Object string_overlays[OVERLAY_STRING_CHUNK_SIZE];
2006 /* If non-nil, a Lisp string being processed. If
2007 current.overlay_string_index >= 0, this is an overlay string from
2008 pos. */
2009 Lisp_Object string;
2011 /* If non-nil, we are processing a string that came
2012 from a `display' property given by an overlay. */
2013 Lisp_Object from_overlay;
2015 /* Stack of saved values. New entries are pushed when we begin to
2016 process an overlay string or a string from a `glyph' property.
2017 Entries are popped when we return to deliver display elements
2018 from what we previously had. */
2019 struct iterator_stack_entry
2021 Lisp_Object string;
2022 int string_nchars;
2023 EMACS_INT end_charpos;
2024 EMACS_INT stop_charpos;
2025 struct composition_it cmp_it;
2026 int face_id;
2028 /* Save values specific to a given method. */
2029 union {
2030 /* method == GET_FROM_IMAGE */
2031 struct {
2032 Lisp_Object object;
2033 struct it_slice slice;
2034 int image_id;
2035 } image;
2036 /* method == GET_FROM_COMPOSITION */
2037 struct {
2038 Lisp_Object object;
2039 } comp;
2040 /* method == GET_FROM_STRETCH */
2041 struct {
2042 Lisp_Object object;
2043 } stretch;
2044 } u;
2046 /* current text and display positions. */
2047 struct text_pos position;
2048 struct display_pos current;
2049 Lisp_Object from_overlay;
2050 enum glyph_row_area area;
2051 enum it_method method;
2052 unsigned multibyte_p : 1;
2053 unsigned string_from_display_prop_p : 1;
2054 unsigned display_ellipsis_p : 1;
2055 unsigned avoid_cursor_p : 1;
2056 enum line_wrap_method line_wrap;
2058 /* properties from display property that are reset by another display property. */
2059 short voffset;
2060 Lisp_Object space_width;
2061 Lisp_Object font_height;
2063 stack[IT_STACK_SIZE];
2065 /* Stack pointer. */
2066 int sp;
2068 /* -1 means selective display hides everything between a \r and the
2069 next newline; > 0 means hide lines indented more than that value. */
2070 int selective;
2072 /* An enumeration describing what the next display element is
2073 after a call to get_next_display_element. */
2074 enum display_element_type what;
2076 /* Face to use. */
2077 int face_id;
2079 /* Setting of buffer-local variable selective-display-ellipsis. */
2080 unsigned selective_display_ellipsis_p : 1;
2082 /* 1 means control characters are translated into the form `^C'
2083 where the `^' can be replaced by a display table entry. */
2084 unsigned ctl_arrow_p : 1;
2086 /* Non-zero means that the current face has a box. */
2087 unsigned face_box_p : 1;
2089 /* Non-null means that the current character is the first in a run
2090 of characters with box face. */
2091 unsigned start_of_box_run_p : 1;
2093 /* Non-zero means that the current character is the last in a run
2094 of characters with box face. */
2095 unsigned end_of_box_run_p : 1;
2097 /* 1 means overlay strings at end_charpos have been processed. */
2098 unsigned overlay_strings_at_end_processed_p : 1;
2100 /* 1 means to ignore overlay strings at current pos, as they have
2101 already been processed. */
2102 unsigned ignore_overlay_strings_at_pos_p : 1;
2104 /* 1 means the actual glyph is not available in the current
2105 system. */
2106 unsigned glyph_not_available_p : 1;
2108 /* 1 means the next line in display_line continues a character
2109 consisting of more than one glyph, and some glyphs of this
2110 character have been put on the previous line. */
2111 unsigned starts_in_middle_of_char_p : 1;
2113 /* If 1, saved_face_id contains the id of the face in front of text
2114 skipped due to selective display. */
2115 unsigned face_before_selective_p : 1;
2117 /* If 1, adjust current glyph so it does not increase current row
2118 descent/ascent (line-height property). Reset after this glyph. */
2119 unsigned constrain_row_ascent_descent_p : 1;
2121 enum line_wrap_method line_wrap;
2123 /* The ID of the default face to use. One of DEFAULT_FACE_ID,
2124 MODE_LINE_FACE_ID, etc, depending on what we are displaying. */
2125 int base_face_id;
2127 /* If what == IT_CHARACTER, character and length in bytes. This is
2128 a character from a buffer or string. It may be different from
2129 the character displayed in case that
2130 unibyte_display_via_language_environment is set.
2132 If what == IT_COMPOSITION, the first component of a composition
2133 and length in bytes of the composition. */
2134 int c, len;
2136 /* If what == IT_COMPOSITION, iterator substructure for the
2137 composition. */
2138 struct composition_it cmp_it;
2140 /* The character to display, possibly translated to multibyte if
2141 multibyte_p is zero or unibyte_display_via_language_environment
2142 is set. This is set after get_next_display_element has been
2143 called. If we are setting it->C directly before calling
2144 PRODUCE_GLYPHS, this should be set beforehand too. */
2145 int char_to_display;
2147 /* If what == IT_IMAGE, the id of the image to display. */
2148 int image_id;
2150 /* Values from `slice' property. */
2151 struct it_slice slice;
2153 /* Value of the `space-width' property, if any; nil if none. */
2154 Lisp_Object space_width;
2156 /* Computed from the value of the `raise' property. */
2157 short voffset;
2159 /* Number of columns per \t. */
2160 short tab_width;
2162 /* Value of the `height' property, if any; nil if none. */
2163 Lisp_Object font_height;
2165 /* Object and position where the current display element came from.
2166 Object can be a Lisp string in case the current display element
2167 comes from an overlay string, or it is buffer. It may also be nil
2168 during mode-line update. Position is a position in object. */
2169 Lisp_Object object;
2170 struct text_pos position;
2172 /* Width in pixels of truncation and continuation glyphs. */
2173 short truncation_pixel_width, continuation_pixel_width;
2175 /* First and last visible x-position in the display area. If window
2176 is hscrolled by n columns, first_visible_x == n * FRAME_COLUMN_WIDTH
2177 (f), and last_visible_x == pixel width of W + first_visible_x. */
2178 int first_visible_x, last_visible_x;
2180 /* Last visible y-position + 1 in the display area without a mode
2181 line, if the window has one. */
2182 int last_visible_y;
2184 /* Default amount of additional space in pixels between lines (for
2185 window systems only.) */
2186 int extra_line_spacing;
2188 /* Max extra line spacing added in this row. */
2189 int max_extra_line_spacing;
2191 /* Override font height information for this glyph.
2192 Used if override_ascent >= 0. Cleared after this glyph. */
2193 int override_ascent, override_descent, override_boff;
2195 /* If non-null, glyphs are produced in glyph_row with each call to
2196 produce_glyphs. */
2197 struct glyph_row *glyph_row;
2199 /* The area of glyph_row to which glyphs are added. */
2200 enum glyph_row_area area;
2202 /* Number of glyphs needed for the last character requested via
2203 produce_glyphs. This is 1 except for tabs. */
2204 int nglyphs;
2206 /* Width of the display element in pixels. Result of
2207 produce_glyphs. */
2208 int pixel_width;
2210 /* Current, maximum logical, and maximum physical line height
2211 information. Result of produce_glyphs. */
2212 int ascent, descent, max_ascent, max_descent;
2213 int phys_ascent, phys_descent, max_phys_ascent, max_phys_descent;
2215 /* Current x pixel position within the display line. This value
2216 does not include the width of continuation lines in front of the
2217 line. The value of current_x is automatically incremented by
2218 pixel_width with each call to produce_glyphs. */
2219 int current_x;
2221 /* Accumulated width of continuation lines. If > 0, this means we
2222 are currently in a continuation line. This is initially zero and
2223 incremented/reset by display_line, move_it_to etc. */
2224 int continuation_lines_width;
2226 /* Current y-position. Automatically incremented by the height of
2227 glyph_row in move_it_to and display_line. */
2228 int current_y;
2230 /* Vertical matrix position of first text line in window. */
2231 int first_vpos;
2233 /* Current vertical matrix position, or line number. Automatically
2234 incremented by move_it_to and display_line. */
2235 int vpos;
2237 /* Horizontal matrix position reached in move_it_in_display_line.
2238 Only set there, not in display_line. */
2239 int hpos;
2241 /* Left fringe bitmap number (enum fringe_bitmap_type). */
2242 unsigned left_user_fringe_bitmap : FRINGE_ID_BITS;
2244 /* Right fringe bitmap number (enum fringe_bitmap_type). */
2245 unsigned right_user_fringe_bitmap : FRINGE_ID_BITS;
2247 /* Face of the left fringe glyph. */
2248 unsigned left_user_fringe_face_id : FACE_ID_BITS;
2250 /* Face of the right fringe glyph. */
2251 unsigned right_user_fringe_face_id : FACE_ID_BITS;
2255 /* Access to positions of iterator IT. */
2257 #define IT_CHARPOS(IT) CHARPOS ((IT).current.pos)
2258 #define IT_BYTEPOS(IT) BYTEPOS ((IT).current.pos)
2259 #define IT_STRING_CHARPOS(IT) CHARPOS ((IT).current.string_pos)
2260 #define IT_STRING_BYTEPOS(IT) BYTEPOS ((IT).current.string_pos)
2262 /* Test if IT has reached the end of its buffer or string. This will
2263 only work after get_next_display_element has been called. */
2265 #define ITERATOR_AT_END_P(IT) ((IT)->what == IT_EOB)
2267 /* Non-zero means IT is at the end of a line. This is the case if it
2268 is either on a newline or on a carriage return and selective
2269 display hides the rest of the line. */
2271 #define ITERATOR_AT_END_OF_LINE_P(IT) \
2272 ((IT)->what == IT_CHARACTER \
2273 && ((IT)->c == '\n' \
2274 || ((IT)->c == '\r' && (IT)->selective)))
2276 /* Call produce_glyphs or FRAME_RIF->produce_glyphs, if set. Shortcut
2277 to avoid the function call overhead. */
2279 #define PRODUCE_GLYPHS(IT) \
2280 do { \
2281 extern int inhibit_free_realized_faces; \
2282 if (FRAME_RIF ((IT)->f) != NULL) \
2283 FRAME_RIF ((IT)->f)->produce_glyphs ((IT)); \
2284 else \
2285 produce_glyphs ((IT)); \
2286 if ((IT)->glyph_row != NULL) \
2287 inhibit_free_realized_faces = 1; \
2288 } while (0)
2290 /* Bit-flags indicating what operation move_it_to should perform. */
2292 enum move_operation_enum
2294 /* Stop if specified x-position is reached. */
2295 MOVE_TO_X = 0x01,
2297 /* Stop if specified y-position is reached. */
2298 MOVE_TO_Y = 0x02,
2300 /* Stop if specified vpos is reached. */
2301 MOVE_TO_VPOS = 0x04,
2303 /* Stop if specified buffer or string position is reached. */
2304 MOVE_TO_POS = 0x08
2309 /***********************************************************************
2310 Window-based redisplay interface
2311 ***********************************************************************/
2313 /* Structure used to describe runs of lines that must be scrolled. */
2315 struct run
2317 /* Source and destination y pixel position. */
2318 int desired_y, current_y;
2320 /* Source and destination vpos in matrix. */
2321 int desired_vpos, current_vpos;
2323 /* Height in pixels, number of glyph rows. */
2324 int height, nrows;
2328 /* Handlers for setting frame parameters. */
2330 typedef void (*frame_parm_handler) P_ ((struct frame *, Lisp_Object, Lisp_Object));
2333 /* Structure holding system-dependent interface functions needed
2334 for window-based redisplay. */
2336 struct redisplay_interface
2338 /* Handlers for setting frame parameters. */
2339 frame_parm_handler *frame_parm_handlers;
2341 /* Produce glyphs/get display metrics for the display element IT is
2342 loaded with. */
2343 void (*produce_glyphs) P_ ((struct it *it));
2345 /* Write or insert LEN glyphs from STRING at the nominal output
2346 position. */
2347 void (*write_glyphs) P_ ((struct glyph *string, int len));
2348 void (*insert_glyphs) P_ ((struct glyph *start, int len));
2350 /* Clear from nominal output position to X. X < 0 means clear
2351 to right end of display. */
2352 void (*clear_end_of_line) P_ ((int x));
2354 /* Function to call to scroll the display as described by RUN on
2355 window W. */
2356 void (*scroll_run_hook) P_ ((struct window *w, struct run *run));
2358 /* Function to call after a line in a display has been completely
2359 updated. Used to draw truncation marks and alike. DESIRED_ROW
2360 is the desired row which has been updated. */
2361 void (*after_update_window_line_hook) P_ ((struct glyph_row *desired_row));
2363 /* Function to call before beginning to update window W in
2364 window-based redisplay. */
2365 void (*update_window_begin_hook) P_ ((struct window *w));
2367 /* Function to call after window W has been updated in window-based
2368 redisplay. CURSOR_ON_P non-zero means switch cursor on.
2369 MOUSE_FACE_OVERWRITTEN_P non-zero means that some lines in W
2370 that contained glyphs in mouse-face were overwritten, so we
2371 have to update the mouse highlight. */
2372 void (*update_window_end_hook) P_ ((struct window *w, int cursor_on_p,
2373 int mouse_face_overwritten_p));
2375 /* Move cursor to row/column position VPOS/HPOS, pixel coordinates
2376 Y/X. HPOS/VPOS are window-relative row and column numbers and X/Y
2377 are window-relative pixel positions. */
2378 void (*cursor_to) P_ ((int vpos, int hpos, int y, int x));
2380 /* Flush the display of frame F. For X, this is XFlush. */
2381 void (*flush_display) P_ ((struct frame *f));
2383 /* Flush the display of frame F if non-NULL. This is called
2384 during redisplay, and should be NULL on systems which flushes
2385 automatically before reading input. */
2386 void (*flush_display_optional) P_ ((struct frame *f));
2388 /* Clear the mouse hightlight in window W, if there is any. */
2389 void (*clear_window_mouse_face) P_ ((struct window *w));
2391 /* Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
2392 frame F. */
2393 void (*get_glyph_overhangs) P_ ((struct glyph *glyph, struct frame *f,
2394 int *left, int *right));
2396 /* Fix the display of AREA of ROW in window W for overlapping rows.
2397 This function is called from redraw_overlapping_rows after
2398 desired rows have been made current. */
2399 void (*fix_overlapping_area) P_ ((struct window *w, struct glyph_row *row,
2400 enum glyph_row_area area, int));
2402 #ifdef HAVE_WINDOW_SYSTEM
2404 /* Draw a fringe bitmap in window W of row ROW using parameters P. */
2405 void (*draw_fringe_bitmap) P_ ((struct window *w, struct glyph_row *row,
2406 struct draw_fringe_bitmap_params *p));
2408 /* Define and destroy fringe bitmap no. WHICH. */
2409 void (*define_fringe_bitmap) P_ ((int which, unsigned short *bits,
2410 int h, int wd));
2411 void (*destroy_fringe_bitmap) P_ ((int which));
2413 /* Compute left and right overhang of glyph string S.
2414 A NULL pointer if platform does not support this. */
2415 void (*compute_glyph_string_overhangs) P_ ((struct glyph_string *s));
2417 /* Draw a glyph string S. */
2418 void (*draw_glyph_string) P_ ((struct glyph_string *s));
2420 /* Define cursor CURSOR on frame F. */
2421 void (*define_frame_cursor) P_ ((struct frame *f, Cursor cursor));
2423 /* Clear the area at (X,Y,WIDTH,HEIGHT) of frame F. */
2424 void (*clear_frame_area) P_ ((struct frame *f, int x, int y,
2425 int width, int height));
2427 /* Draw specified cursor CURSOR_TYPE of width CURSOR_WIDTH
2428 at row GLYPH_ROW on window W if ON_P is 1. If ON_P is
2429 0, don't draw cursor. If ACTIVE_P is 1, system caret
2430 should track this cursor (when applicable). */
2431 void (*draw_window_cursor) P_ ((struct window *w,
2432 struct glyph_row *glyph_row,
2433 int x, int y,
2434 int cursor_type, int cursor_width,
2435 int on_p, int active_p));
2437 /* Draw vertical border for window W from (X,Y0) to (X,Y1). */
2438 void (*draw_vertical_window_border) P_ ((struct window *w,
2439 int x, int y0, int y1));
2441 /* Shift display of frame F to make room for inserted glyphs.
2442 The area at pixel (X,Y) of width WIDTH and height HEIGHT is
2443 shifted right by SHIFT_BY pixels. */
2444 void (*shift_glyphs_for_insert) P_ ((struct frame *f,
2445 int x, int y, int width,
2446 int height, int shift_by));
2448 #endif /* HAVE_WINDOW_SYSTEM */
2452 /***********************************************************************
2453 Images
2454 ***********************************************************************/
2456 #ifdef HAVE_WINDOW_SYSTEM
2458 /* Structure forward declarations. */
2460 struct image;
2463 /* Each image format (JPEG, TIFF, ...) supported is described by
2464 a structure of the type below. */
2466 struct image_type
2468 /* A symbol uniquely identifying the image type, .e.g `jpeg'. */
2469 Lisp_Object *type;
2471 /* Check that SPEC is a valid image specification for the given
2472 image type. Value is non-zero if SPEC is valid. */
2473 int (* valid_p) P_ ((Lisp_Object spec));
2475 /* Load IMG which is used on frame F from information contained in
2476 IMG->spec. Value is non-zero if successful. */
2477 int (* load) P_ ((struct frame *f, struct image *img));
2479 /* Free resources of image IMG which is used on frame F. */
2480 void (* free) P_ ((struct frame *f, struct image *img));
2482 /* Next in list of all supported image types. */
2483 struct image_type *next;
2487 /* Structure describing an image. Specific image formats like XBM are
2488 converted into this form, so that display only has to deal with
2489 this type of image. */
2491 struct image
2493 /* The time in seconds at which the image was last displayed. Set
2494 in prepare_image_for_display. */
2495 unsigned long timestamp;
2497 /* Pixmaps of the image. */
2498 Pixmap pixmap, mask;
2500 /* Colors allocated for this image, if any. Allocated via xmalloc. */
2501 unsigned long *colors;
2502 int ncolors;
2504 /* A single `background color' for this image, for the use of anyone that
2505 cares about such a thing. Only valid if the `background_valid' field
2506 is true. This should generally be accessed by calling the accessor
2507 macro `IMAGE_BACKGROUND', which will heuristically calculate a value
2508 if necessary. */
2509 unsigned long background;
2511 /* Foreground and background colors of the frame on which the image
2512 is created. */
2513 unsigned long frame_foreground, frame_background;
2515 /* True if this image has a `transparent' background -- that is, is
2516 uses an image mask. The accessor macro for this is
2517 `IMAGE_BACKGROUND_TRANSPARENT'. */
2518 unsigned background_transparent : 1;
2520 /* True if the `background' and `background_transparent' fields are
2521 valid, respectively. */
2522 unsigned background_valid : 1, background_transparent_valid : 1;
2524 /* Width and height of the image. */
2525 int width, height;
2527 /* These values are used for the rectangles displayed for images
2528 that can't be loaded. */
2529 #define DEFAULT_IMAGE_WIDTH 30
2530 #define DEFAULT_IMAGE_HEIGHT 30
2532 /* Top/left and bottom/right corner pixel of actual image data.
2533 Used by four_corners_best to consider the real image data,
2534 rather than looking at the optional image margin. */
2535 int corners[4];
2536 #define TOP_CORNER 0
2537 #define LEFT_CORNER 1
2538 #define BOT_CORNER 2
2539 #define RIGHT_CORNER 3
2541 /* Percent of image height used as ascent. A value of
2542 CENTERED_IMAGE_ASCENT means draw the image centered on the
2543 line. */
2544 int ascent;
2545 #define DEFAULT_IMAGE_ASCENT 50
2546 #define CENTERED_IMAGE_ASCENT -1
2548 /* Lisp specification of this image. */
2549 Lisp_Object spec;
2551 /* List of "references" followed to build the image.
2552 Typically will just contain the name of the image file.
2553 Used to allow fine-grained cache flushing. */
2554 Lisp_Object dependencies;
2556 /* Relief to draw around the image. */
2557 int relief;
2559 /* Optional margins around the image. This includes the relief. */
2560 int hmargin, vmargin;
2562 /* Reference to the type of the image. */
2563 struct image_type *type;
2565 /* 1 means that loading the image failed. Don't try again. */
2566 unsigned load_failed_p;
2568 /* A place for image types to store additional data. The member
2569 data.lisp_val is marked during GC, so it's safe to store Lisp data
2570 there. Image types should free this data when their `free'
2571 function is called. */
2572 struct
2574 int int_val;
2575 void *ptr_val;
2576 Lisp_Object lisp_val;
2577 } data;
2579 /* Hash value of image specification to speed up comparisons. */
2580 unsigned hash;
2582 /* Image id of this image. */
2583 int id;
2585 /* Hash collision chain. */
2586 struct image *next, *prev;
2590 /* Cache of images. Each frame has a cache. X frames with the same
2591 x_display_info share their caches. */
2593 struct image_cache
2595 /* Hash table of images. */
2596 struct image **buckets;
2598 /* Vector mapping image ids to images. */
2599 struct image **images;
2601 /* Allocated size of `images'. */
2602 unsigned size;
2604 /* Number of images in the cache. */
2605 unsigned used;
2607 /* Reference count (number of frames sharing this cache). */
2608 int refcount;
2612 /* Value is a pointer to the image with id ID on frame F, or null if
2613 no image with that id exists. */
2615 #define IMAGE_FROM_ID(F, ID) \
2616 (((ID) >= 0 && (ID) < (FRAME_IMAGE_CACHE (F)->used)) \
2617 ? FRAME_IMAGE_CACHE (F)->images[ID] \
2618 : NULL)
2620 /* Size of bucket vector of image caches. Should be prime. */
2622 #define IMAGE_CACHE_BUCKETS_SIZE 1001
2624 #endif /* HAVE_WINDOW_SYSTEM */
2628 /***********************************************************************
2629 Tool-bars
2630 ***********************************************************************/
2632 /* Enumeration defining where to find tool-bar item information in
2633 tool-bar items vectors stored with frames. Each tool-bar item
2634 occupies TOOL_BAR_ITEM_NSLOTS elements in such a vector. */
2636 enum tool_bar_item_idx
2638 /* The key of the tool-bar item. Used to remove items when a binding
2639 for `undefined' is found. */
2640 TOOL_BAR_ITEM_KEY,
2642 /* Non-nil if item is enabled. */
2643 TOOL_BAR_ITEM_ENABLED_P,
2645 /* Non-nil if item is selected (pressed). */
2646 TOOL_BAR_ITEM_SELECTED_P,
2648 /* Caption. */
2649 TOOL_BAR_ITEM_CAPTION,
2651 /* Image(s) to display. This is either a single image specification
2652 or a vector of specifications. */
2653 TOOL_BAR_ITEM_IMAGES,
2655 /* The binding. */
2656 TOOL_BAR_ITEM_BINDING,
2658 /* Button type. One of nil, `:radio' or `:toggle'. */
2659 TOOL_BAR_ITEM_TYPE,
2661 /* Help string. */
2662 TOOL_BAR_ITEM_HELP,
2664 /* Icon file name of right to left image when an RTL locale is used. */
2665 TOOL_BAR_ITEM_RTL_IMAGE,
2667 /* Sentinel = number of slots in tool_bar_items occupied by one
2668 tool-bar item. */
2669 TOOL_BAR_ITEM_NSLOTS
2673 /* An enumeration for the different images that can be specified
2674 for a tool-bar item. */
2676 enum tool_bar_item_image
2678 TOOL_BAR_IMAGE_ENABLED_SELECTED,
2679 TOOL_BAR_IMAGE_ENABLED_DESELECTED,
2680 TOOL_BAR_IMAGE_DISABLED_SELECTED,
2681 TOOL_BAR_IMAGE_DISABLED_DESELECTED
2684 /* Margin around tool-bar buttons in pixels. */
2686 extern Lisp_Object Vtool_bar_button_margin;
2688 /* Thickness of relief to draw around tool-bar buttons. */
2690 extern EMACS_INT tool_bar_button_relief;
2692 /* Default values of the above variables. */
2694 #define DEFAULT_TOOL_BAR_BUTTON_MARGIN 4
2695 #define DEFAULT_TOOL_BAR_BUTTON_RELIEF 1
2697 /* The height in pixels of the default tool-bar images. */
2699 #define DEFAULT_TOOL_BAR_IMAGE_HEIGHT 24
2702 /***********************************************************************
2703 Terminal Capabilities
2704 ***********************************************************************/
2706 /* Each of these is a bit representing a terminal `capability' (bold,
2707 inverse, etc). They are or'd together to specify the set of
2708 capabilities being queried for when calling `tty_capable_p' (which
2709 returns true if the terminal supports all of them). */
2711 #define TTY_CAP_INVERSE 0x01
2712 #define TTY_CAP_UNDERLINE 0x02
2713 #define TTY_CAP_BOLD 0x04
2714 #define TTY_CAP_DIM 0x08
2715 #define TTY_CAP_BLINK 0x10
2716 #define TTY_CAP_ALT_CHARSET 0x20
2719 /***********************************************************************
2720 Function Prototypes
2721 ***********************************************************************/
2723 /* Defined in xdisp.c */
2725 struct glyph_row *row_containing_pos P_ ((struct window *, int,
2726 struct glyph_row *,
2727 struct glyph_row *, int));
2728 int string_buffer_position P_ ((struct window *, Lisp_Object, int));
2729 int line_bottom_y P_ ((struct it *));
2730 int display_prop_intangible_p P_ ((Lisp_Object));
2731 void resize_echo_area_exactly P_ ((void));
2732 int resize_mini_window P_ ((struct window *, int));
2733 int try_window P_ ((Lisp_Object, struct text_pos, int));
2734 void window_box P_ ((struct window *, int, int *, int *, int *, int *));
2735 int window_box_height P_ ((struct window *));
2736 int window_text_bottom_y P_ ((struct window *));
2737 int window_box_width P_ ((struct window *, int));
2738 int window_box_left P_ ((struct window *, int));
2739 int window_box_left_offset P_ ((struct window *, int));
2740 int window_box_right P_ ((struct window *, int));
2741 int window_box_right_offset P_ ((struct window *, int));
2742 void window_box_edges P_ ((struct window *, int, int *, int *, int *, int *));
2743 int estimate_mode_line_height P_ ((struct frame *, enum face_id));
2744 void pixel_to_glyph_coords P_ ((struct frame *, int, int, int *, int *,
2745 NativeRectangle *, int));
2746 int glyph_to_pixel_coords P_ ((struct window *, int, int, int *, int *));
2747 void remember_mouse_glyph P_ ((struct frame *, int, int, NativeRectangle *));
2749 void mark_window_display_accurate P_ ((Lisp_Object, int));
2750 void redisplay_preserve_echo_area P_ ((int));
2751 int set_cursor_from_row P_ ((struct window *, struct glyph_row *,
2752 struct glyph_matrix *, int, int, int, int));
2753 void init_iterator P_ ((struct it *, struct window *, int,
2754 int, struct glyph_row *, enum face_id));
2755 void init_iterator_to_row_start P_ ((struct it *, struct window *,
2756 struct glyph_row *));
2757 int get_next_display_element P_ ((struct it *));
2758 void set_iterator_to_next P_ ((struct it *, int));
2759 void start_display P_ ((struct it *, struct window *, struct text_pos));
2760 void move_it_to P_ ((struct it *, int, int, int, int, int));
2761 void move_it_vertically P_ ((struct it *, int));
2762 void move_it_vertically_backward P_ ((struct it *, int));
2763 void move_it_by_lines P_ ((struct it *, int, int));
2764 void move_it_past_eol P_ ((struct it *));
2765 void move_it_in_display_line (struct it *it,
2766 EMACS_INT to_charpos, int to_x,
2767 enum move_operation_enum op);
2768 int in_display_vector_p P_ ((struct it *));
2769 int frame_mode_line_height P_ ((struct frame *));
2770 void highlight_trailing_whitespace P_ ((struct frame *, struct glyph_row *));
2771 extern Lisp_Object Qtool_bar;
2772 extern Lisp_Object Vshow_trailing_whitespace;
2773 extern int mode_line_in_non_selected_windows;
2774 extern int redisplaying_p;
2775 extern void add_to_log P_ ((char *, Lisp_Object, Lisp_Object));
2776 extern int help_echo_showing_p;
2777 extern int current_mode_line_height, current_header_line_height;
2778 extern Lisp_Object help_echo_string, help_echo_window;
2779 extern Lisp_Object help_echo_object, previous_help_echo_string;
2780 extern int help_echo_pos;
2781 extern struct frame *last_mouse_frame;
2782 extern int last_tool_bar_item;
2783 extern Lisp_Object Vmouse_autoselect_window;
2784 extern int unibyte_display_via_language_environment;
2785 extern EMACS_INT underline_minimum_offset;
2787 extern void reseat_at_previous_visible_line_start P_ ((struct it *));
2789 extern int calc_pixel_width_or_height P_ ((double *, struct it *, Lisp_Object,
2790 struct font *, int, int *));
2792 #ifdef HAVE_WINDOW_SYSTEM
2794 #if GLYPH_DEBUG
2795 extern void dump_glyph_string P_ ((struct glyph_string *));
2796 #endif
2798 extern void x_get_glyph_overhangs P_ ((struct glyph *, struct frame *,
2799 int *, int *));
2800 extern void x_produce_glyphs P_ ((struct it *));
2802 extern void x_write_glyphs P_ ((struct glyph *, int));
2803 extern void x_insert_glyphs P_ ((struct glyph *, int len));
2804 extern void x_clear_end_of_line P_ ((int));
2806 extern int x_stretch_cursor_p;
2807 extern struct cursor_pos output_cursor;
2809 extern void x_fix_overlapping_area P_ ((struct window *, struct glyph_row *,
2810 enum glyph_row_area, int));
2811 extern void draw_phys_cursor_glyph P_ ((struct window *,
2812 struct glyph_row *,
2813 enum draw_glyphs_face));
2814 extern void get_phys_cursor_geometry P_ ((struct window *, struct glyph_row *,
2815 struct glyph *, int *, int *, int *));
2816 extern void erase_phys_cursor P_ ((struct window *));
2817 extern void display_and_set_cursor P_ ((struct window *,
2818 int, int, int, int, int));
2820 extern void set_output_cursor P_ ((struct cursor_pos *));
2821 extern void x_cursor_to P_ ((int, int, int, int));
2823 extern void x_update_cursor P_ ((struct frame *, int));
2824 extern void x_clear_cursor P_ ((struct window *));
2825 extern void x_draw_vertical_border P_ ((struct window *w));
2827 extern void frame_to_window_pixel_xy P_ ((struct window *, int *, int *));
2828 extern int get_glyph_string_clip_rects P_ ((struct glyph_string *,
2829 NativeRectangle *, int));
2830 extern void get_glyph_string_clip_rect P_ ((struct glyph_string *,
2831 NativeRectangle *nr));
2832 extern Lisp_Object find_hot_spot P_ ((Lisp_Object, int, int));
2833 extern void note_mouse_highlight P_ ((struct frame *, int, int));
2834 extern void x_clear_window_mouse_face P_ ((struct window *));
2835 extern void cancel_mouse_face P_ ((struct frame *));
2837 extern void handle_tool_bar_click P_ ((struct frame *,
2838 int, int, int, unsigned int));
2840 /* msdos.c defines its own versions of these functions. */
2841 extern int clear_mouse_face P_ ((Display_Info *));
2842 extern void show_mouse_face P_ ((Display_Info *, enum draw_glyphs_face));
2843 extern int cursor_in_mouse_face_p P_ ((struct window *w));
2845 extern void expose_frame P_ ((struct frame *, int, int, int, int));
2846 extern int x_intersect_rectangles P_ ((XRectangle *, XRectangle *,
2847 XRectangle *));
2848 #endif
2850 /* Flags passed to try_window. */
2851 #define TRY_WINDOW_CHECK_MARGINS (1 << 0)
2852 #define TRY_WINDOW_IGNORE_FONTS_CHANGE (1 << 1)
2854 /* Defined in fringe.c */
2856 int lookup_fringe_bitmap (Lisp_Object);
2857 void draw_fringe_bitmap P_ ((struct window *, struct glyph_row *, int));
2858 void draw_row_fringe_bitmaps P_ ((struct window *, struct glyph_row *));
2859 int draw_window_fringes P_ ((struct window *, int));
2860 int update_window_fringes P_ ((struct window *, int));
2861 void compute_fringe_widths P_ ((struct frame *, int));
2863 #ifdef WINDOWSNT
2864 void w32_init_fringe P_ ((struct redisplay_interface *));
2865 void w32_reset_fringes P_ ((void));
2866 #endif
2867 /* Defined in image.c */
2869 #ifdef HAVE_WINDOW_SYSTEM
2871 extern int x_bitmap_height P_ ((struct frame *, int));
2872 extern int x_bitmap_width P_ ((struct frame *, int));
2873 extern int x_bitmap_pixmap P_ ((struct frame *, int));
2874 extern void x_reference_bitmap P_ ((struct frame *, int));
2875 extern int x_create_bitmap_from_data P_ ((struct frame *, char *,
2876 unsigned int, unsigned int));
2877 extern int x_create_bitmap_from_file P_ ((struct frame *, Lisp_Object));
2878 #if defined (HAVE_XPM) && defined (HAVE_X_WINDOWS)
2879 extern int x_create_bitmap_from_xpm_data P_ ((struct frame *f, char **bits));
2880 #endif
2881 #ifndef x_destroy_bitmap
2882 extern void x_destroy_bitmap P_ ((struct frame *, int));
2883 #endif
2884 extern void x_destroy_all_bitmaps P_ ((Display_Info *));
2885 extern int x_create_bitmap_mask P_ ((struct frame * , int));
2886 extern Lisp_Object x_find_image_file P_ ((Lisp_Object));
2888 void x_kill_gs_process P_ ((Pixmap, struct frame *));
2889 struct image_cache *make_image_cache P_ ((void));
2890 void free_image_cache P_ ((struct frame *));
2891 void clear_image_caches P_ ((Lisp_Object));
2892 void mark_image_cache P_ ((struct image_cache *));
2893 int valid_image_p P_ ((Lisp_Object));
2894 void prepare_image_for_display P_ ((struct frame *, struct image *));
2895 int lookup_image P_ ((struct frame *, Lisp_Object));
2897 unsigned long image_background P_ ((struct image *, struct frame *,
2898 XImagePtr_or_DC ximg));
2899 int image_background_transparent P_ ((struct image *, struct frame *,
2900 XImagePtr_or_DC mask));
2902 int image_ascent P_ ((struct image *, struct face *, struct glyph_slice *));
2904 #endif
2906 /* Defined in sysdep.c */
2908 void get_tty_size P_ ((int, int *, int *));
2909 void request_sigio P_ ((void));
2910 void unrequest_sigio P_ ((void));
2911 int tabs_safe_p P_ ((int));
2912 void init_baud_rate P_ ((int));
2913 void init_sigio P_ ((int));
2915 /* Defined in xfaces.c */
2917 #ifdef HAVE_X_WINDOWS
2918 void x_free_colors P_ ((struct frame *, unsigned long *, int));
2919 #endif
2921 void update_face_from_frame_parameter P_ ((struct frame *, Lisp_Object,
2922 Lisp_Object));
2923 Lisp_Object tty_color_name P_ ((struct frame *, int));
2924 void clear_face_cache P_ ((int));
2925 unsigned long load_color P_ ((struct frame *, struct face *, Lisp_Object,
2926 enum lface_attribute_index));
2927 void unload_color P_ ((struct frame *, unsigned long));
2928 char *choose_face_font P_ ((struct frame *, Lisp_Object *, Lisp_Object,
2929 int *));
2930 int ascii_face_of_lisp_face P_ ((struct frame *, int));
2931 void prepare_face_for_display P_ ((struct frame *, struct face *));
2932 int xstrcasecmp P_ ((const unsigned char *, const unsigned char *));
2933 int lookup_face P_ ((struct frame *, Lisp_Object *));
2934 int lookup_named_face P_ ((struct frame *, Lisp_Object, int));
2935 int lookup_basic_face P_ ((struct frame *, int));
2936 int smaller_face P_ ((struct frame *, int, int));
2937 int face_with_height P_ ((struct frame *, int, int));
2938 int lookup_derived_face P_ ((struct frame *, Lisp_Object, int, int));
2939 void init_frame_faces P_ ((struct frame *));
2940 void free_frame_faces P_ ((struct frame *));
2941 void recompute_basic_faces P_ ((struct frame *));
2942 int face_at_buffer_position P_ ((struct window *w, EMACS_INT pos,
2943 EMACS_INT region_beg, EMACS_INT region_end,
2944 EMACS_INT *endptr, EMACS_INT limit,
2945 int mouse, int base_face_id));
2946 int face_for_overlay_string P_ ((struct window *w, EMACS_INT pos,
2947 EMACS_INT region_beg, EMACS_INT region_end,
2948 EMACS_INT *endptr, EMACS_INT limit,
2949 int mouse, Lisp_Object overlay));
2950 int face_at_string_position P_ ((struct window *w, Lisp_Object string,
2951 EMACS_INT pos, EMACS_INT bufpos,
2952 EMACS_INT region_beg, EMACS_INT region_end,
2953 EMACS_INT *endptr, enum face_id, int mouse));
2954 int merge_faces P_ ((struct frame *, Lisp_Object, int, int));
2955 int compute_char_face P_ ((struct frame *, int, Lisp_Object));
2956 void free_all_realized_faces P_ ((Lisp_Object));
2957 void free_realized_face P_ ((struct frame *, struct face *));
2958 extern Lisp_Object Qforeground_color, Qbackground_color;
2959 extern Lisp_Object Qframe_set_background_mode;
2960 extern char unspecified_fg[], unspecified_bg[];
2962 extern Lisp_Object Vface_remapping_alist;
2964 /* Defined in xfns.c */
2966 #ifdef HAVE_X_WINDOWS
2967 void gamma_correct P_ ((struct frame *, XColor *));
2968 #endif
2969 #ifdef WINDOWSNT
2970 void gamma_correct P_ ((struct frame *, COLORREF *));
2971 #endif
2973 #ifdef HAVE_WINDOW_SYSTEM
2975 int x_screen_planes P_ ((struct frame *));
2976 void x_implicitly_set_name P_ ((struct frame *, Lisp_Object, Lisp_Object));
2978 extern Lisp_Object tip_frame;
2979 extern Window tip_window;
2980 EXFUN (Fx_show_tip, 6);
2981 EXFUN (Fx_hide_tip, 0);
2982 extern void start_hourglass P_ ((void));
2983 extern void cancel_hourglass P_ ((void));
2984 extern int hourglass_started P_ ((void));
2985 extern int display_hourglass_p;
2986 extern int hourglass_shown_p;
2987 struct atimer; /* Defined in atimer.h. */
2988 /* If non-null, an asynchronous timer that, when it expires, displays
2989 an hourglass cursor on all frames. */
2990 extern struct atimer *hourglass_atimer;
2992 /* Each GUI implements these. FIXME: move into RIF. */
2993 extern void show_hourglass P_ ((struct atimer *));
2994 extern void hide_hourglass P_ ((void));
2996 /* Returns the background color of IMG, calculating one heuristically if
2997 necessary. If non-zero, XIMG is an existing XImage object to use for
2998 the heuristic. */
3000 #define IMAGE_BACKGROUND(img, f, ximg) \
3001 ((img)->background_valid \
3002 ? (img)->background \
3003 : image_background (img, f, ximg))
3005 /* Returns true if IMG has a `transparent' background, using heuristics
3006 to decide if necessary. If non-zero, MASK is an existing XImage
3007 object to use for the heuristic. */
3009 #define IMAGE_BACKGROUND_TRANSPARENT(img, f, mask) \
3010 ((img)->background_transparent_valid \
3011 ? (img)->background_transparent \
3012 : image_background_transparent (img, f, mask))
3014 #endif /* HAVE_WINDOW_SYSTEM */
3017 /* Defined in xmenu.c */
3019 int popup_activated P_ ((void));
3021 /* Defined in dispnew.c */
3023 extern int inverse_video;
3024 extern int required_matrix_width P_ ((struct window *));
3025 extern int required_matrix_height P_ ((struct window *));
3026 extern Lisp_Object buffer_posn_from_coords P_ ((struct window *,
3027 int *, int *,
3028 struct display_pos *,
3029 Lisp_Object *,
3030 int *, int *, int *, int *));
3031 extern Lisp_Object mode_line_string P_ ((struct window *, enum window_part,
3032 int *, int *, int *,
3033 Lisp_Object *,
3034 int *, int *, int *, int *));
3035 extern Lisp_Object marginal_area_string P_ ((struct window *, enum window_part,
3036 int *, int *, int *,
3037 Lisp_Object *,
3038 int *, int *, int *, int *));
3039 extern void redraw_frame P_ ((struct frame *));
3040 extern void redraw_garbaged_frames P_ ((void));
3041 extern void cancel_line P_ ((int, struct frame *));
3042 extern void init_desired_glyphs P_ ((struct frame *));
3043 extern int scroll_frame_lines P_ ((struct frame *, int, int, int, int));
3044 extern int direct_output_for_insert P_ ((int));
3045 extern int direct_output_forward_char P_ ((int));
3046 extern int update_frame P_ ((struct frame *, int, int));
3047 extern int scrolling P_ ((struct frame *));
3048 extern void bitch_at_user P_ ((void));
3049 void adjust_glyphs P_ ((struct frame *));
3050 void free_glyphs P_ ((struct frame *));
3051 void free_window_matrices P_ ((struct window *));
3052 void check_glyph_memory P_ ((void));
3053 void mirrored_line_dance P_ ((struct glyph_matrix *, int, int, int *, char *));
3054 void clear_glyph_matrix P_ ((struct glyph_matrix *));
3055 void clear_current_matrices P_ ((struct frame *f));
3056 void clear_desired_matrices P_ ((struct frame *));
3057 void shift_glyph_matrix P_ ((struct window *, struct glyph_matrix *,
3058 int, int, int));
3059 void rotate_matrix P_ ((struct glyph_matrix *, int, int, int));
3060 void increment_matrix_positions P_ ((struct glyph_matrix *,
3061 int, int, int, int));
3062 void blank_row P_ ((struct window *, struct glyph_row *, int));
3063 void increment_row_positions P_ ((struct glyph_row *, int, int));
3064 void enable_glyph_matrix_rows P_ ((struct glyph_matrix *, int, int, int));
3065 void clear_glyph_row P_ ((struct glyph_row *));
3066 void prepare_desired_row P_ ((struct glyph_row *));
3067 int line_hash_code P_ ((struct glyph_row *));
3068 void set_window_update_flags P_ ((struct window *, int));
3069 void redraw_frame P_ ((struct frame *));
3070 void redraw_garbaged_frames P_ ((void));
3071 int scroll_cost P_ ((struct frame *, int, int, int));
3072 int direct_output_for_insert P_ ((int));
3073 int direct_output_forward_char P_ ((int));
3074 int update_frame P_ ((struct frame *, int, int));
3075 void update_single_window P_ ((struct window *, int));
3076 int scrolling P_ ((struct frame *));
3077 void do_pending_window_change P_ ((int));
3078 void change_frame_size P_ ((struct frame *, int, int, int, int, int));
3079 void bitch_at_user P_ ((void));
3080 void init_display P_ ((void));
3081 void syms_of_display P_ ((void));
3082 extern Lisp_Object Qredisplay_dont_pause;
3083 void spec_glyph_lookup_face P_ ((struct window *, GLYPH *));
3085 /* Defined in terminal.c */
3087 extern void ring_bell P_ ((struct frame *));
3088 extern void update_begin P_ ((struct frame *));
3089 extern void update_end P_ ((struct frame *));
3090 extern void set_terminal_window P_ ((struct frame *, int));
3091 extern void cursor_to P_ ((struct frame *, int, int));
3092 extern void raw_cursor_to P_ ((struct frame *, int, int));
3093 extern void clear_to_end P_ ((struct frame *));
3094 extern void clear_frame P_ ((struct frame *));
3095 extern void clear_end_of_line P_ ((struct frame *, int));
3096 extern void write_glyphs P_ ((struct frame *, struct glyph *, int));
3097 extern void insert_glyphs P_ ((struct frame *, struct glyph *, int));
3098 extern void delete_glyphs P_ ((struct frame *, int));
3099 extern void ins_del_lines P_ ((struct frame *, int, int));
3101 extern struct terminal *init_initial_terminal P_ ((void));
3104 /* Defined in term.c */
3106 extern void tty_set_terminal_modes P_ ((struct terminal *));
3107 extern void tty_reset_terminal_modes P_ ((struct terminal *));
3108 extern void tty_turn_off_insert P_ ((struct tty_display_info *));
3109 extern void tty_turn_off_highlight P_ ((struct tty_display_info *));
3110 extern int string_cost P_ ((char *));
3111 extern int per_line_cost P_ ((char *));
3112 extern void calculate_costs P_ ((struct frame *));
3113 extern void produce_glyphs P_ ((struct it *));
3114 extern void produce_special_glyphs P_ ((struct it *, enum display_element_type));
3115 extern int tty_capable_p P_ ((struct tty_display_info *, unsigned, unsigned long, unsigned long));
3116 extern void set_tty_color_mode (struct tty_display_info *, struct frame *);
3117 extern struct terminal *get_tty_terminal P_ ((Lisp_Object, int));
3118 extern struct terminal *get_named_tty P_ ((char *));
3119 EXFUN (Ftty_type, 1);
3120 extern void create_tty_output P_ ((struct frame *));
3121 extern struct terminal *init_tty P_ ((char *, char *, int));
3124 /* Defined in scroll.c */
3126 extern int scrolling_max_lines_saved P_ ((int, int, int *, int *, int *));
3127 extern int scroll_cost P_ ((struct frame *, int, int, int));
3128 extern void do_line_insertion_deletion_costs P_ ((struct frame *, char *,
3129 char *, char *, char *,
3130 char *, char *, int));
3131 void scrolling_1 P_ ((struct frame *, int, int, int, int *, int *, int *,
3132 int *, int));
3134 /* Defined in frame.c */
3136 #ifdef HAVE_WINDOW_SYSTEM
3138 /* Types we might convert a resource string into. */
3139 enum resource_types
3141 RES_TYPE_NUMBER,
3142 RES_TYPE_FLOAT,
3143 RES_TYPE_BOOLEAN,
3144 RES_TYPE_STRING,
3145 RES_TYPE_SYMBOL,
3146 RES_TYPE_BOOLEAN_NUMBER
3149 extern Lisp_Object x_get_arg P_ ((Display_Info *, Lisp_Object,
3150 Lisp_Object, char *, char *class,
3151 enum resource_types));
3152 extern Lisp_Object x_frame_get_arg P_ ((struct frame *, Lisp_Object,
3153 Lisp_Object, char *, char *,
3154 enum resource_types));
3155 extern Lisp_Object x_frame_get_and_record_arg P_ ((
3156 struct frame *, Lisp_Object,
3157 Lisp_Object, char *, char *,
3158 enum resource_types));
3159 extern Lisp_Object x_default_parameter P_ ((struct frame *, Lisp_Object,
3160 Lisp_Object, Lisp_Object,
3161 char *, char *,
3162 enum resource_types));
3164 #endif /* HAVE_WINDOW_SYSTEM */
3166 #endif /* not DISPEXTERN_H_INCLUDED */
3168 /* arch-tag: c65c475f-1c1e-4534-8795-990b8509fd65
3169 (do not change this comment) */