(url-retrieve-synchronously): Don't autoload.
[emacs.git] / src / dispextern.h
blobf07f761301f1c287de31620c0412bb411f2dc31e
1 /* Interface definitions for display code.
2 Copyright (C) 1985, 1993, 1994, 1997, 1998, 1999, 2000, 2001, 2002,
3 2003, 2004, 2005 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
22 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>. */
24 #ifndef DISPEXTERN_H_INCLUDED
25 #define DISPEXTERN_H_INCLUDED
27 #ifdef HAVE_X_WINDOWS
29 #include <X11/Xlib.h>
30 #ifdef USE_X_TOOLKIT
31 #include <X11/Intrinsic.h>
32 #endif /* USE_X_TOOLKIT */
34 #else /* !HAVE_X_WINDOWS */
36 /* X-related stuff used by non-X gui code. */
38 typedef struct {
39 unsigned long pixel;
40 unsigned short red, green, blue;
41 char flags;
42 char pad;
43 } XColor;
45 #endif /* HAVE_X_WINDOWS */
47 #ifdef MSDOS
48 #include "msdos.h"
49 #endif
51 #ifdef HAVE_X_WINDOWS
52 typedef struct x_display_info Display_Info;
53 typedef XImage * XImagePtr;
54 typedef XImagePtr XImagePtr_or_DC;
55 #define NativeRectangle XRectangle
56 #endif
58 #ifdef HAVE_NTGUI
59 #include "w32gui.h"
60 typedef struct w32_display_info Display_Info;
61 typedef XImage *XImagePtr;
62 typedef HDC XImagePtr_or_DC;
63 #endif
65 #ifdef MAC_OS
66 #include "macgui.h"
67 typedef struct mac_display_info Display_Info;
68 /* Mac equivalent of XImage. */
69 typedef Pixmap XImagePtr;
70 typedef XImagePtr XImagePtr_or_DC;
71 #endif
73 #ifndef NativeRectangle
74 #define NativeRectangle int
75 #endif
77 /* Structure forward declarations. Some are here because function
78 prototypes below reference structure types before their definition
79 in this file. Some are here because not every file including
80 dispextern.h also includes frame.h and windows.h. */
82 struct glyph;
83 struct glyph_row;
84 struct glyph_matrix;
85 struct glyph_pool;
86 struct frame;
87 struct window;
90 /* Values returned from coordinates_in_window. */
92 enum window_part
94 ON_NOTHING,
95 ON_TEXT,
96 ON_MODE_LINE,
97 ON_VERTICAL_BORDER,
98 ON_HEADER_LINE,
99 ON_LEFT_FRINGE,
100 ON_RIGHT_FRINGE,
101 ON_LEFT_MARGIN,
102 ON_RIGHT_MARGIN,
103 ON_SCROLL_BAR
106 /* Number of bits allocated to store fringe bitmap numbers. */
107 #define FRINGE_ID_BITS 16
111 /***********************************************************************
112 Debugging
113 ***********************************************************************/
115 /* If GLYPH_DEBUG is non-zero, additional checks are activated. Turn
116 it off by defining the macro GLYPH_DEBUG to zero. */
118 #ifndef GLYPH_DEBUG
119 #define GLYPH_DEBUG 0
120 #endif
122 /* If XASSERTS is non-zero, additional consistency checks are activated.
123 Turn it off by defining the macro XASSERTS to zero. */
125 #ifndef XASSERTS
126 #define XASSERTS 0
127 #endif
129 /* Macros to include code only if GLYPH_DEBUG != 0. */
131 #if GLYPH_DEBUG
132 #define IF_DEBUG(X) X
133 #else
134 #define IF_DEBUG(X) (void) 0
135 #endif
137 #if XASSERTS
138 #define xassert(X) do {if (!(X)) abort ();} while (0)
139 #else
140 #define xassert(X) (void) 0
141 #endif
143 /* Macro for displaying traces of redisplay. If Emacs was compiled
144 with GLYPH_DEBUG != 0, the variable trace_redisplay_p can be set to
145 a non-zero value in debugging sessions to activate traces. */
147 #if GLYPH_DEBUG
149 extern int trace_redisplay_p;
150 #include <stdio.h>
152 #define TRACE(X) \
153 if (trace_redisplay_p) \
154 fprintf X; \
155 else \
156 (void) 0
158 #else /* GLYPH_DEBUG == 0 */
160 #define TRACE(X) (void) 0
162 #endif /* GLYPH_DEBUG == 0 */
166 /***********************************************************************
167 Text positions
168 ***********************************************************************/
170 /* Starting with Emacs 20.3, characters from strings and buffers have
171 both a character and a byte position associated with them. The
172 following structure holds such a pair of positions. */
174 struct text_pos
176 /* Character position. */
177 int charpos;
179 /* Corresponding byte position. */
180 int bytepos;
183 /* Access character and byte position of POS in a functional form. */
185 #define BYTEPOS(POS) (POS).bytepos
186 #define CHARPOS(POS) (POS).charpos
188 /* Set character position of POS to CHARPOS, byte position to BYTEPOS. */
190 #define SET_TEXT_POS(POS, CHARPOS, BYTEPOS) \
191 ((POS).charpos = (CHARPOS), (POS).bytepos = BYTEPOS)
193 /* Increment text position POS. */
195 #define INC_TEXT_POS(POS, MULTIBYTE_P) \
196 do \
198 ++(POS).charpos; \
199 if (MULTIBYTE_P) \
200 INC_POS ((POS).bytepos); \
201 else \
202 ++(POS).bytepos; \
204 while (0)
206 /* Decrement text position POS. */
208 #define DEC_TEXT_POS(POS, MULTIBYTE_P) \
209 do \
211 --(POS).charpos; \
212 if (MULTIBYTE_P) \
213 DEC_POS ((POS).bytepos); \
214 else \
215 --(POS).bytepos; \
217 while (0)
219 /* Set text position POS from marker MARKER. */
221 #define SET_TEXT_POS_FROM_MARKER(POS, MARKER) \
222 (CHARPOS (POS) = marker_position ((MARKER)), \
223 BYTEPOS (POS) = marker_byte_position ((MARKER)))
225 /* Set marker MARKER from text position POS. */
227 #define SET_MARKER_FROM_TEXT_POS(MARKER, POS) \
228 set_marker_both ((MARKER), Qnil, CHARPOS ((POS)), BYTEPOS ((POS)))
230 /* Value is non-zero if character and byte positions of POS1 and POS2
231 are equal. */
233 #define TEXT_POS_EQUAL_P(POS1, POS2) \
234 ((POS1).charpos == (POS2).charpos \
235 && (POS1).bytepos == (POS2).bytepos)
237 /* When rendering glyphs, redisplay scans string or buffer text,
238 overlay strings in that text, and does display table or control
239 character translations. The following structure captures a
240 position taking all this into account. */
242 struct display_pos
244 /* Buffer or string position. */
245 struct text_pos pos;
247 /* If this is a position in an overlay string, overlay_string_index
248 is the index of that overlay string in the sequence of overlay
249 strings at `pos' in the order redisplay processes them. A value
250 < 0 means that this is not a position in an overlay string. */
251 int overlay_string_index;
253 /* If this is a position in an overlay string, string_pos is the
254 position within that string. */
255 struct text_pos string_pos;
257 /* If the character at the position above is a control character or
258 has a display table entry, dpvec_index is an index in the display
259 table or control character translation of that character. A
260 value < 0 means this is not a position in such a translation. */
261 int dpvec_index;
266 /***********************************************************************
267 Glyphs
268 ***********************************************************************/
270 /* Enumeration of glyph types. Glyph structures contain a type field
271 containing one of the enumerators defined here. */
273 enum glyph_type
275 /* Glyph describes a character. */
276 CHAR_GLYPH,
278 /* Glyph describes a composition sequence. */
279 COMPOSITE_GLYPH,
281 /* Glyph describes an image. */
282 IMAGE_GLYPH,
284 /* Glyph is a space of fractional width and/or height. */
285 STRETCH_GLYPH
289 /* Structure describing how to use partial glyphs (images slicing) */
291 struct glyph_slice
293 unsigned x : 16;
294 unsigned y : 16;
295 unsigned width : 16;
296 unsigned height : 16;
300 /* Glyphs.
302 Be extra careful when changing this structure! Esp. make sure that
303 functions producing glyphs, like append_glyph, fill ALL of the
304 glyph structure, and that GLYPH_EQUAL_P compares all
305 display-relevant members of glyphs (not to imply that these are the
306 only things to check when you add a member). */
308 struct glyph
310 /* Position from which this glyph was drawn. If `object' below is a
311 Lisp string, this is a position in that string. If it is a
312 buffer, this is a position in that buffer. A value of -1
313 together with a null object means glyph is a truncation glyph at
314 the start of a row. */
315 int charpos;
317 /* Lisp object source of this glyph. Currently either a buffer or
318 a string, if the glyph was produced from characters which came from
319 a buffer or a string; or 0 if the glyph was inserted by redisplay
320 for its own purposes such as padding. */
321 Lisp_Object object;
323 /* Width in pixels. */
324 short pixel_width;
326 /* Ascent and descent in pixels. */
327 short ascent, descent;
329 /* Vertical offset. If < 0, the glyph is displayed raised, if > 0
330 the glyph is displayed lowered. */
331 short voffset;
333 /* Which kind of glyph this is---character, image etc. Value
334 should be an enumerator of type enum glyph_type. */
335 unsigned type : 2;
337 /* 1 means this glyph was produced from multibyte text. Zero
338 means it was produced from unibyte text, i.e. charsets aren't
339 applicable, and encoding is not performed. */
340 unsigned multibyte_p : 1;
342 /* Non-zero means draw a box line at the left or right side of this
343 glyph. This is part of the implementation of the face attribute
344 `:box'. */
345 unsigned left_box_line_p : 1;
346 unsigned right_box_line_p : 1;
348 /* Non-zero means this glyph's physical ascent or descent is greater
349 than its logical ascent/descent, i.e. it may potentially overlap
350 glyphs above or below it. */
351 unsigned overlaps_vertically_p : 1;
353 /* 1 means glyph is a padding glyph. Padding glyphs are used for
354 characters whose visual shape consists of more than one glyph
355 (e.g. Asian characters). All but the first glyph of such a glyph
356 sequence have the padding_p flag set. Only used for terminal
357 frames, and there only to minimize code changes. A better way
358 would probably be to use the width field of glyphs to express
359 padding. */
360 unsigned padding_p : 1;
362 /* 1 means the actual glyph is not available, draw a box instead.
363 This can happen when a font couldn't be loaded, or a character
364 doesn't have a glyph in a font. */
365 unsigned glyph_not_available_p : 1;
367 #define FACE_ID_BITS 21
369 /* Face of the glyph. This is a realized face ID,
370 an index in the face cache of the frame. */
371 unsigned face_id : FACE_ID_BITS;
373 /* Type of font used to display the character glyph. May be used to
374 determine which set of functions to use to obtain font metrics
375 for the glyph. On W32, value should be an enumerator of the type
376 w32_char_font_type. Otherwise it equals FONT_TYPE_UNKNOWN. */
377 unsigned font_type : 3;
379 struct glyph_slice slice;
381 /* A union of sub-structures for different glyph types. */
382 union
384 /* Character code for character glyphs (type == CHAR_GLYPH). */
385 unsigned ch;
387 /* Composition ID for composition glyphs (type == COMPOSITION_GLYPH) */
388 unsigned cmp_id;
390 /* Image ID for image glyphs (type == IMAGE_GLYPH). */
391 unsigned img_id;
393 /* Sub-structure for type == STRETCH_GLYPH. */
394 struct
396 /* The height of the glyph. */
397 unsigned height : 16;
399 /* The ascent of the glyph. */
400 unsigned ascent : 16;
402 stretch;
404 /* Used to compare all bit-fields above in one step. */
405 unsigned val;
406 } u;
410 /* Default value of the glyph font_type field. */
412 #define FONT_TYPE_UNKNOWN 0
414 /* Is GLYPH a space? */
416 #define CHAR_GLYPH_SPACE_P(GLYPH) \
417 (GLYPH_FROM_CHAR_GLYPH ((GLYPH)) == SPACEGLYPH)
419 /* Are glyph slices of glyphs *X and *Y equal */
421 #define GLYPH_SLICE_EQUAL_P(X, Y) \
422 ((X)->slice.x == (Y)->slice.x \
423 && (X)->slice.y == (Y)->slice.y \
424 && (X)->slice.width == (Y)->slice.width \
425 && (X)->slice.height == (Y)->slice.height)
427 /* Are glyphs *X and *Y displayed equal? */
429 #define GLYPH_EQUAL_P(X, Y) \
430 ((X)->type == (Y)->type \
431 && (X)->u.val == (Y)->u.val \
432 && GLYPH_SLICE_EQUAL_P (X, Y) \
433 && (X)->face_id == (Y)->face_id \
434 && (X)->padding_p == (Y)->padding_p \
435 && (X)->left_box_line_p == (Y)->left_box_line_p \
436 && (X)->right_box_line_p == (Y)->right_box_line_p \
437 && (X)->voffset == (Y)->voffset \
438 && (X)->pixel_width == (Y)->pixel_width)
440 /* Are character codes, faces, padding_ps of glyphs *X and *Y equal? */
442 #define GLYPH_CHAR_AND_FACE_EQUAL_P(X, Y) \
443 ((X)->u.ch == (Y)->u.ch \
444 && (X)->face_id == (Y)->face_id \
445 && (X)->padding_p == (Y)->padding_p)
447 /* Fill a character glyph GLYPH. CODE, FACE_ID, PADDING_P correspond
448 to the bits defined for the typedef `GLYPH' in lisp.h. */
450 #define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P) \
451 do \
453 (GLYPH).u.ch = (CODE); \
454 (GLYPH).face_id = (FACE_ID); \
455 (GLYPH).padding_p = (PADDING_P); \
457 while (0)
459 /* Fill a character type glyph GLYPH from a glyph typedef FROM as
460 defined in lisp.h. */
462 #define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM) \
463 SET_CHAR_GLYPH ((GLYPH), \
464 FAST_GLYPH_CHAR ((FROM)), \
465 FAST_GLYPH_FACE ((FROM)), \
468 /* Construct a glyph code from a character glyph GLYPH. If the
469 character is multibyte, return -1 as we can't use glyph table for a
470 multibyte character. */
472 #define GLYPH_FROM_CHAR_GLYPH(GLYPH) \
473 ((GLYPH).u.ch < 256 \
474 ? ((GLYPH).u.ch | ((GLYPH).face_id << CHARACTERBITS)) \
475 : -1)
477 /* Is GLYPH a padding glyph? */
479 #define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p
484 /***********************************************************************
485 Glyph Pools
486 ***********************************************************************/
488 /* Glyph Pool.
490 Glyph memory for frame-based redisplay is allocated from the heap
491 in one vector kept in a glyph pool structure which is stored with
492 the frame. The size of the vector is made large enough to cover
493 all windows on the frame.
495 Both frame and window glyph matrices reference memory from a glyph
496 pool in frame-based redisplay.
498 In window-based redisplay, no glyphs pools exist; windows allocate
499 and free their glyph memory themselves. */
501 struct glyph_pool
503 /* Vector of glyphs allocated from the heap. */
504 struct glyph *glyphs;
506 /* Allocated size of `glyphs'. */
507 int nglyphs;
509 /* Number of rows and columns in a matrix. */
510 int nrows, ncolumns;
515 /***********************************************************************
516 Glyph Matrix
517 ***********************************************************************/
519 /* Glyph Matrix.
521 Three kinds of glyph matrices exist:
523 1. Frame glyph matrices. These are used for terminal frames whose
524 redisplay needs a view of the whole screen due to limited terminal
525 capabilities. Frame matrices are used only in the update phase
526 of redisplay. They are built in update_frame and not used after
527 the update has been performed.
529 2. Window glyph matrices on frames having frame glyph matrices.
530 Such matrices are sub-matrices of their corresponding frame matrix,
531 i.e. frame glyph matrices and window glyph matrices share the same
532 glyph memory which is allocated in form of a glyph_pool structure.
533 Glyph rows in such a window matrix are slices of frame matrix rows.
535 2. Free-standing window glyph matrices managing their own glyph
536 storage. This form is used in window-based redisplay which
537 includes variable width and height fonts etc.
539 The size of a window's row vector depends on the height of fonts
540 defined on its frame. It is chosen so that the vector is large
541 enough to describe all lines in a window when it is displayed in
542 the smallest possible character size. When new fonts are loaded,
543 or window sizes change, the row vector is adjusted accordingly. */
545 struct glyph_matrix
547 /* The pool from which glyph memory is allocated, if any. This is
548 null for frame matrices and for window matrices managing their
549 own storage. */
550 struct glyph_pool *pool;
552 /* Vector of glyph row structures. The row at nrows - 1 is reserved
553 for the mode line. */
554 struct glyph_row *rows;
556 /* Number of elements allocated for the vector rows above. */
557 int rows_allocated;
559 /* The number of rows used by the window if all lines were displayed
560 with the smallest possible character height. */
561 int nrows;
563 /* Origin within the frame matrix if this is a window matrix on a
564 frame having a frame matrix. Both values are zero for
565 window-based redisplay. */
566 int matrix_x, matrix_y;
568 /* Width and height of the matrix in columns and rows. */
569 int matrix_w, matrix_h;
571 /* If this structure describes a window matrix of window W,
572 window_left_col is the value of W->left_col, window_top_line the
573 value of W->top_line, window_height and window_width are width and
574 height of W, as returned by window_box, and window_vscroll is the
575 value of W->vscroll at the time the matrix was last adjusted.
576 Only set for window-based redisplay. */
577 int window_left_col, window_top_line;
578 int window_height, window_width;
579 int window_vscroll;
581 /* Number of glyphs reserved for left and right marginal areas when
582 the matrix was last adjusted. */
583 int left_margin_glyphs, right_margin_glyphs;
585 /* Flag indicating that scrolling should not be tried in
586 update_window. This flag is set by functions like try_window_id
587 which do their own scrolling. */
588 unsigned no_scrolling_p : 1;
590 /* Non-zero means window displayed in this matrix has a top mode
591 line. */
592 unsigned header_line_p : 1;
594 #ifdef GLYPH_DEBUG
595 /* A string identifying the method used to display the matrix. */
596 char method[512];
597 #endif
599 /* The buffer this matrix displays. Set in
600 mark_window_display_accurate_1. */
601 struct buffer *buffer;
603 /* Values of BEGV and ZV as of last redisplay. Set in
604 mark_window_display_accurate_1. */
605 int begv, zv;
609 /* Check that glyph pointers stored in glyph rows of MATRIX are okay.
610 This aborts if any pointer is found twice. */
612 #if GLYPH_DEBUG
613 void check_matrix_pointer_lossage P_ ((struct glyph_matrix *));
614 #define CHECK_MATRIX(MATRIX) check_matrix_pointer_lossage ((MATRIX))
615 #else
616 #define CHECK_MATRIX(MATRIX) (void) 0
617 #endif
621 /***********************************************************************
622 Glyph Rows
623 ***********************************************************************/
625 /* Area in window glyph matrix. If values are added or removed, the
626 function mark_object in alloc.c has to be changed. */
628 enum glyph_row_area
630 LEFT_MARGIN_AREA,
631 TEXT_AREA,
632 RIGHT_MARGIN_AREA,
633 LAST_AREA
637 /* Rows of glyphs in a windows or frame glyph matrix.
639 Each row is partitioned into three areas. The start and end of
640 each area is recorded in a pointer as shown below.
642 +--------------------+-------------+---------------------+
643 | left margin area | text area | right margin area |
644 +--------------------+-------------+---------------------+
645 | | | |
646 glyphs[LEFT_MARGIN_AREA] glyphs[RIGHT_MARGIN_AREA]
648 glyphs[TEXT_AREA] |
649 glyphs[LAST_AREA]
651 Rows in frame matrices reference glyph memory allocated in a frame
652 glyph pool (see the description of struct glyph_pool). Rows in
653 window matrices on frames having frame matrices reference slices of
654 the glyphs of corresponding rows in the frame matrix.
656 Rows in window matrices on frames having no frame matrices point to
657 glyphs allocated from the heap via xmalloc;
658 glyphs[LEFT_MARGIN_AREA] is the start address of the allocated
659 glyph structure array. */
661 struct glyph_row
663 /* Pointers to beginnings of areas. The end of an area A is found at
664 A + 1 in the vector. The last element of the vector is the end
665 of the whole row.
667 Kludge alert: Even if used[TEXT_AREA] == 0, glyphs[TEXT_AREA][0]'s
668 position field is used. It is -1 if this row does not correspond
669 to any text; it is some buffer position if the row corresponds to
670 an empty display line that displays a line end. This is what old
671 redisplay used to do. (Except in code for terminal frames, this
672 kludge is no longer used, I believe. --gerd).
674 See also start, end, displays_text_p and ends_at_zv_p for cleaner
675 ways to do it. The special meaning of positions 0 and -1 will be
676 removed some day, so don't use it in new code. */
677 struct glyph *glyphs[1 + LAST_AREA];
679 /* Number of glyphs actually filled in areas. */
680 short used[LAST_AREA];
682 /* Window-relative x and y-position of the top-left corner of this
683 row. If y < 0, this means that abs (y) pixels of the row are
684 invisible because it is partially visible at the top of a window.
685 If x < 0, this means that abs (x) pixels of the first glyph of
686 the text area of the row are invisible because the glyph is
687 partially visible. */
688 int x, y;
690 /* Width of the row in pixels without taking face extension at the
691 end of the row into account, and without counting truncation
692 and continuation glyphs at the end of a row on ttys. */
693 int pixel_width;
695 /* Logical ascent/height of this line. The value of ascent is zero
696 and height is 1 on terminal frames. */
697 int ascent, height;
699 /* Physical ascent/height of this line. If max_ascent > ascent,
700 this line overlaps the line above it on the display. Otherwise,
701 if max_height > height, this line overlaps the line beneath it. */
702 int phys_ascent, phys_height;
704 /* Portion of row that is visible. Partially visible rows may be
705 found at the top and bottom of a window. This is 1 for tty
706 frames. It may be < 0 in case of completely invisible rows. */
707 int visible_height;
709 /* Extra line spacing added after this row. Do not consider this
710 in last row when checking if row is fully visible. */
711 int extra_line_spacing;
713 /* Hash code. This hash code is available as soon as the row
714 is constructed, i.e. after a call to display_line. */
715 unsigned hash;
717 /* First position in this row. This is the text position, including
718 overlay position information etc, where the display of this row
719 started, and can thus be less the position of the first glyph
720 (e.g. due to invisible text or horizontal scrolling). */
721 struct display_pos start;
723 /* Text position at the end of this row. This is the position after
724 the last glyph on this row. It can be greater than the last
725 glyph position + 1, due to truncation, invisible text etc. In an
726 up-to-date display, this should always be equal to the start
727 position of the next row. */
728 struct display_pos end;
730 /* Non-zero means the overlay arrow bitmap is on this line.
731 -1 means use default overlay arrow bitmap, else
732 it specifies actual fringe bitmap number. */
733 int overlay_arrow_bitmap;
735 /* Left fringe bitmap number (enum fringe_bitmap_type). */
736 unsigned left_user_fringe_bitmap : FRINGE_ID_BITS;
738 /* Right fringe bitmap number (enum fringe_bitmap_type). */
739 unsigned right_user_fringe_bitmap : FRINGE_ID_BITS;
741 /* Left fringe bitmap number (enum fringe_bitmap_type). */
742 unsigned left_fringe_bitmap : FRINGE_ID_BITS;
744 /* Right fringe bitmap number (enum fringe_bitmap_type). */
745 unsigned right_fringe_bitmap : FRINGE_ID_BITS;
747 /* Face of the left fringe glyph. */
748 unsigned left_user_fringe_face_id : FACE_ID_BITS;
750 /* Face of the right fringe glyph. */
751 unsigned right_user_fringe_face_id : FACE_ID_BITS;
753 /* Face of the left fringe glyph. */
754 unsigned left_fringe_face_id : FACE_ID_BITS;
756 /* Face of the right fringe glyph. */
757 unsigned right_fringe_face_id : FACE_ID_BITS;
759 /* 1 means that we must draw the bitmaps of this row. */
760 unsigned redraw_fringe_bitmaps_p : 1;
762 /* In a desired matrix, 1 means that this row must be updated. In a
763 current matrix, 0 means that the row has been invalidated, i.e.
764 the row's contents do not agree with what is visible on the
765 screen. */
766 unsigned enabled_p : 1;
768 /* 1 means row displays a text line that is truncated on the left or
769 right side. */
770 unsigned truncated_on_left_p : 1;
771 unsigned truncated_on_right_p : 1;
773 /* 1 means that this row displays a continued line, i.e. it has a
774 continuation mark at the right side. */
775 unsigned continued_p : 1;
777 /* 0 means that this row does not contain any text, i.e. it is
778 a blank line at the window and buffer end. */
779 unsigned displays_text_p : 1;
781 /* 1 means that this line ends at ZV. */
782 unsigned ends_at_zv_p : 1;
784 /* 1 means the face of the last glyph in the text area is drawn to
785 the right end of the window. This flag is used in
786 update_text_area to optimize clearing to the end of the area. */
787 unsigned fill_line_p : 1;
789 /* Non-zero means display a bitmap on X frames indicating that this
790 line contains no text and ends in ZV. */
791 unsigned indicate_empty_line_p : 1;
793 /* 1 means this row contains glyphs that overlap each other because
794 of lbearing or rbearing. */
795 unsigned contains_overlapping_glyphs_p : 1;
797 /* 1 means this row is as wide as the window it is displayed in, including
798 scroll bars, fringes, and internal borders. This also
799 implies that the row doesn't have marginal areas. */
800 unsigned full_width_p : 1;
802 /* Non-zero means row is a mode or header-line. */
803 unsigned mode_line_p : 1;
805 /* 1 in a current row means this row is overlapped by another row. */
806 unsigned overlapped_p : 1;
808 /* 1 means this line ends in the middle of a character consisting
809 of more than one glyph. Some glyphs have been put in this row,
810 the rest are put in rows below this one. */
811 unsigned ends_in_middle_of_char_p : 1;
813 /* 1 means this line starts in the middle of a character consisting
814 of more than one glyph. Some glyphs have been put in the
815 previous row, the rest are put in this row. */
816 unsigned starts_in_middle_of_char_p : 1;
818 /* 1 in a current row means this row overlaps others. */
819 unsigned overlapping_p : 1;
821 /* 1 means some glyphs in this row are displayed in mouse-face. */
822 unsigned mouse_face_p : 1;
824 /* 1 means this row was ended by a newline from a string. */
825 unsigned ends_in_newline_from_string_p : 1;
827 /* 1 means this row width is exactly the width of the window, and the
828 final newline character is hidden in the right fringe. */
829 unsigned exact_window_width_line_p : 1;
831 /* 1 means this row currently shows the cursor in the right fringe. */
832 unsigned cursor_in_fringe_p : 1;
834 /* 1 means the last glyph in the row is part of an ellipsis. */
835 unsigned ends_in_ellipsis_p : 1;
837 /* Non-zero means display a bitmap on X frames indicating that this
838 the first line of the buffer. */
839 unsigned indicate_bob_p : 1;
841 /* Non-zero means display a bitmap on X frames indicating that this
842 the top line of the window, but not start of the buffer. */
843 unsigned indicate_top_line_p : 1;
845 /* Non-zero means display a bitmap on X frames indicating that this
846 the last line of the buffer. */
847 unsigned indicate_eob_p : 1;
849 /* Non-zero means display a bitmap on X frames indicating that this
850 the bottom line of the window, but not end of the buffer. */
851 unsigned indicate_bottom_line_p : 1;
853 /* Continuation lines width at the start of the row. */
854 int continuation_lines_width;
858 /* Get a pointer to row number ROW in matrix MATRIX. If GLYPH_DEBUG
859 is defined to a non-zero value, the function matrix_row checks that
860 we don't try to access rows that are out of bounds. */
862 #if GLYPH_DEBUG
863 struct glyph_row *matrix_row P_ ((struct glyph_matrix *, int));
864 #define MATRIX_ROW(MATRIX, ROW) matrix_row ((MATRIX), (ROW))
865 #else
866 #define MATRIX_ROW(MATRIX, ROW) ((MATRIX)->rows + (ROW))
867 #endif
869 /* Return a pointer to the row reserved for the mode line in MATRIX.
870 Row MATRIX->nrows - 1 is always reserved for the mode line. */
872 #define MATRIX_MODE_LINE_ROW(MATRIX) \
873 ((MATRIX)->rows + (MATRIX)->nrows - 1)
875 /* Return a pointer to the row reserved for the header line in MATRIX.
876 This is always the first row in MATRIX because that's the only
877 way that works in frame-based redisplay. */
879 #define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows
881 /* Return a pointer to first row in MATRIX used for text display. */
883 #define MATRIX_FIRST_TEXT_ROW(MATRIX) \
884 ((MATRIX)->rows->mode_line_p ? (MATRIX)->rows + 1 : (MATRIX)->rows)
886 /* Return a pointer to the first glyph in the text area of a row.
887 MATRIX is the glyph matrix accessed, and ROW is the row index in
888 MATRIX. */
890 #define MATRIX_ROW_GLYPH_START(MATRIX, ROW) \
891 (MATRIX_ROW ((MATRIX), (ROW))->glyphs[TEXT_AREA])
893 /* Return the number of used glyphs in the text area of a row. */
895 #define MATRIX_ROW_USED(MATRIX, ROW) \
896 (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA])
898 /* Return the character/ byte position at which the display of ROW
899 starts. */
901 #define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->start.pos.charpos)
902 #define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->start.pos.bytepos)
904 /* Return the character/ byte position at which ROW ends. */
906 #define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->end.pos.charpos)
907 #define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->end.pos.bytepos)
909 /* Return the vertical position of ROW in MATRIX. */
911 #define MATRIX_ROW_VPOS(ROW, MATRIX) ((ROW) - (MATRIX)->rows)
913 /* Return the last glyph row + 1 in MATRIX on window W reserved for
914 text. If W has a mode line, the last row in the matrix is reserved
915 for it. */
917 #define MATRIX_BOTTOM_TEXT_ROW(MATRIX, W) \
918 ((MATRIX)->rows \
919 + (MATRIX)->nrows \
920 - (WINDOW_WANTS_MODELINE_P ((W)) ? 1 : 0))
922 /* Non-zero if the face of the last glyph in ROW's text area has
923 to be drawn to the end of the text area. */
925 #define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)
927 /* Set and query the enabled_p flag of glyph row ROW in MATRIX. */
929 #define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
930 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0)
932 #define MATRIX_ROW_ENABLED_P(MATRIX, ROW) \
933 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p)
935 /* Non-zero if ROW displays text. Value is non-zero if the row is
936 blank but displays a line end. */
938 #define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)
941 /* Helper macros */
943 #define MR_PARTIALLY_VISIBLE(ROW) \
944 ((ROW)->height != (ROW)->visible_height)
946 #define MR_PARTIALLY_VISIBLE_AT_TOP(W, ROW) \
947 ((ROW)->y < WINDOW_HEADER_LINE_HEIGHT ((W)))
949 #define MR_PARTIALLY_VISIBLE_AT_BOTTOM(W, ROW) \
950 (((ROW)->y + (ROW)->height - (ROW)->extra_line_spacing) \
951 > WINDOW_BOX_HEIGHT_NO_MODE_LINE ((W)))
953 /* Non-zero if ROW is not completely visible in window W. */
955 #define MATRIX_ROW_PARTIALLY_VISIBLE_P(W, ROW) \
956 (MR_PARTIALLY_VISIBLE ((ROW)) \
957 && (MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)) \
958 || MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW))))
962 /* Non-zero if ROW is partially visible at the top of window W. */
964 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW) \
965 (MR_PARTIALLY_VISIBLE ((ROW)) \
966 && MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)))
968 /* Non-zero if ROW is partially visible at the bottom of window W. */
970 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW) \
971 (MR_PARTIALLY_VISIBLE ((ROW)) \
972 && MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW)))
974 /* Return the bottom Y + 1 of ROW. */
976 #define MATRIX_ROW_BOTTOM_Y(ROW) ((ROW)->y + (ROW)->height)
978 /* Is ROW the last visible one in the display described by the
979 iterator structure pointed to by IT?. */
981 #define MATRIX_ROW_LAST_VISIBLE_P(ROW, IT) \
982 (MATRIX_ROW_BOTTOM_Y ((ROW)) >= (IT)->last_visible_y)
984 /* Non-zero if ROW displays a continuation line. */
986 #define MATRIX_ROW_CONTINUATION_LINE_P(ROW) \
987 ((ROW)->continuation_lines_width > 0)
989 /* Non-zero if ROW ends in the middle of a character. This is the
990 case for continued lines showing only part of a display table entry
991 or a control char, or an overlay string. */
993 #define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW) \
994 ((ROW)->end.dpvec_index > 0 \
995 || (ROW)->end.overlay_string_index >= 0 \
996 || (ROW)->ends_in_middle_of_char_p)
998 /* Non-zero if ROW ends in the middle of an overlay string. */
1000 #define MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P(ROW) \
1001 ((ROW)->end.overlay_string_index >= 0)
1003 /* Non-zero if ROW starts in the middle of a character. See above. */
1005 #define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW) \
1006 ((ROW)->start.dpvec_index > 0 \
1007 || (ROW)->starts_in_middle_of_char_p \
1008 || ((ROW)->start.overlay_string_index >= 0 \
1009 && (ROW)->start.string_pos.charpos > 0))
1011 /* Non-zero means ROW overlaps its predecessor. */
1013 #define MATRIX_ROW_OVERLAPS_PRED_P(ROW) \
1014 ((ROW)->phys_ascent > (ROW)->ascent)
1016 /* Non-zero means ROW overlaps its successor. */
1018 #define MATRIX_ROW_OVERLAPS_SUCC_P(ROW) \
1019 ((ROW)->phys_height - (ROW)->phys_ascent \
1020 > (ROW)->height - (ROW)->ascent)
1022 /* Non-zero means that fonts have been loaded since the last glyph
1023 matrix adjustments. The function redisplay_internal adjusts glyph
1024 matrices when this flag is non-zero. */
1026 extern int fonts_changed_p;
1028 /* A glyph for a space. */
1030 extern struct glyph space_glyph;
1032 /* Frame being updated by update_window/update_frame. */
1034 extern struct frame *updating_frame;
1036 /* Window being updated by update_window. This is non-null as long as
1037 update_window has not finished, and null otherwise. It's role is
1038 analogous to updating_frame. */
1040 extern struct window *updated_window;
1042 /* Glyph row and area updated by update_window_line. */
1044 extern struct glyph_row *updated_row;
1045 extern int updated_area;
1047 /* Non-zero means reading single-character input with prompt so put
1048 cursor on mini-buffer after the prompt. Positive means at end of
1049 text in echo area; negative means at beginning of line. */
1051 extern int cursor_in_echo_area;
1053 /* Non-zero means last display completed. Zero means it was
1054 preempted. */
1056 extern int display_completed;
1058 /* Non-zero means redisplay has been performed directly (see also
1059 direct_output_for_insert and direct_output_forward_char), so that
1060 no further updating has to be performed. The function
1061 redisplay_internal checks this flag, and does nothing but reset it
1062 to zero if it is non-zero. */
1064 extern int redisplay_performed_directly_p;
1066 /* A temporary storage area, including a row of glyphs. Initialized
1067 in xdisp.c. Used for various purposes, as an example see
1068 direct_output_for_insert. */
1070 extern struct glyph_row scratch_glyph_row;
1074 /************************************************************************
1075 Glyph Strings
1076 ************************************************************************/
1078 /* Enumeration for overriding/changing the face to use for drawing
1079 glyphs in draw_glyphs. */
1081 enum draw_glyphs_face
1083 DRAW_NORMAL_TEXT,
1084 DRAW_INVERSE_VIDEO,
1085 DRAW_CURSOR,
1086 DRAW_MOUSE_FACE,
1087 DRAW_IMAGE_RAISED,
1088 DRAW_IMAGE_SUNKEN
1091 #ifdef HAVE_WINDOW_SYSTEM
1093 /* A sequence of glyphs to be drawn in the same face. */
1095 struct glyph_string
1097 /* X-origin of the string. */
1098 int x;
1100 /* Y-origin and y-position of the base line of this string. */
1101 int y, ybase;
1103 /* The width of the string, not including a face extension. */
1104 int width;
1106 /* The width of the string, including a face extension. */
1107 int background_width;
1109 /* The height of this string. This is the height of the line this
1110 string is drawn in, and can be different from the height of the
1111 font the string is drawn in. */
1112 int height;
1114 /* Number of pixels this string overwrites in front of its x-origin.
1115 This number is zero if the string has an lbearing >= 0; it is
1116 -lbearing, if the string has an lbearing < 0. */
1117 int left_overhang;
1119 /* Number of pixels this string overwrites past its right-most
1120 nominal x-position, i.e. x + width. Zero if the string's
1121 rbearing is <= its nominal width, rbearing - width otherwise. */
1122 int right_overhang;
1124 /* The frame on which the glyph string is drawn. */
1125 struct frame *f;
1127 /* The window on which the glyph string is drawn. */
1128 struct window *w;
1130 /* X display and window for convenience. */
1131 Display *display;
1132 Window window;
1134 /* The glyph row for which this string was built. It determines the
1135 y-origin and height of the string. */
1136 struct glyph_row *row;
1138 /* The area within row. */
1139 enum glyph_row_area area;
1141 /* Characters to be drawn, and number of characters. */
1142 XChar2b *char2b;
1143 int nchars;
1145 /* A face-override for drawing cursors, mouse face and similar. */
1146 enum draw_glyphs_face hl;
1148 /* Face in which this string is to be drawn. */
1149 struct face *face;
1151 /* Font in which this string is to be drawn. */
1152 XFontStruct *font;
1154 /* Font info for this string. */
1155 struct font_info *font_info;
1157 /* Non-null means this string describes (part of) a composition.
1158 All characters from char2b are drawn composed. */
1159 struct composition *cmp;
1161 /* Index of this glyph string's first character in the glyph
1162 definition of CMP. If this is zero, this glyph string describes
1163 the first character of a composition. */
1164 int gidx;
1166 /* 1 means this glyph strings face has to be drawn to the right end
1167 of the window's drawing area. */
1168 unsigned extends_to_end_of_line_p : 1;
1170 /* 1 means the background of this string has been drawn. */
1171 unsigned background_filled_p : 1;
1173 /* 1 means glyph string must be drawn with 16-bit functions. */
1174 unsigned two_byte_p : 1;
1176 /* 1 means that the original font determined for drawing this glyph
1177 string could not be loaded. The member `font' has been set to
1178 the frame's default font in this case. */
1179 unsigned font_not_found_p : 1;
1181 /* 1 means that the face in which this glyph string is drawn has a
1182 stipple pattern. */
1183 unsigned stippled_p : 1;
1185 #define OVERLAPS_PRED (1 << 0)
1186 #define OVERLAPS_SUCC (1 << 1)
1187 #define OVERLAPS_BOTH (OVERLAPS_PRED | OVERLAPS_SUCC)
1188 #define OVERLAPS_ERASED_CURSOR (1 << 2)
1189 /* Non-zero means only the foreground of this glyph string must be
1190 drawn, and we should use the physical height of the line this
1191 glyph string appears in as clip rect. If the value is
1192 OVERLAPS_ERASED_CURSOR, the clip rect is restricted to the rect
1193 of the erased cursor. OVERLAPS_PRED and OVERLAPS_SUCC mean we
1194 draw overlaps with the preceding and the succeeding rows,
1195 respectively. */
1196 unsigned for_overlaps : 3;
1198 /* The GC to use for drawing this glyph string. */
1199 #if defined(HAVE_X_WINDOWS) || defined(MAC_OS)
1200 GC gc;
1201 #endif
1202 #if defined(HAVE_NTGUI)
1203 XGCValues *gc;
1204 HDC hdc;
1205 #endif
1207 /* A pointer to the first glyph in the string. This glyph
1208 corresponds to char2b[0]. Needed to draw rectangles if
1209 font_not_found_p is 1. */
1210 struct glyph *first_glyph;
1212 /* Image, if any. */
1213 struct image *img;
1215 /* Slice */
1216 struct glyph_slice slice;
1218 /* Non-null means the horizontal clipping region starts from the
1219 left edge of *clip_head, and ends with the right edge of
1220 *clip_tail, not including their overhangs. */
1221 struct glyph_string *clip_head, *clip_tail;
1223 struct glyph_string *next, *prev;
1226 #endif /* HAVE_WINDOW_SYSTEM */
1229 /************************************************************************
1230 Display Dimensions
1231 ************************************************************************/
1233 /* Return the height of the mode line in glyph matrix MATRIX, or zero
1234 if not known. This macro is called under circumstances where
1235 MATRIX might not have been allocated yet. */
1237 #define MATRIX_MODE_LINE_HEIGHT(MATRIX) \
1238 ((MATRIX) && (MATRIX)->rows \
1239 ? MATRIX_MODE_LINE_ROW (MATRIX)->height \
1240 : 0)
1242 /* Return the height of the header line in glyph matrix MATRIX, or zero
1243 if not known. This macro is called under circumstances where
1244 MATRIX might not have been allocated yet. */
1246 #define MATRIX_HEADER_LINE_HEIGHT(MATRIX) \
1247 ((MATRIX) && (MATRIX)->rows \
1248 ? MATRIX_HEADER_LINE_ROW (MATRIX)->height \
1249 : 0)
1251 /* Return the desired face id for the mode line of a window, depending
1252 on whether the window is selected or not, or if the window is the
1253 scrolling window for the currently active minibuffer window.
1255 Due to the way display_mode_lines manipulates with the contents of
1256 selected_window, this macro needs three arguments: SELW which is
1257 compared against the current value of selected_window, MBW which is
1258 compared against minibuf_window (if SELW doesn't match), and SCRW
1259 which is compared against minibuf_selected_window (if MBW matches). */
1261 #define CURRENT_MODE_LINE_FACE_ID_3(SELW, MBW, SCRW) \
1262 ((!mode_line_in_non_selected_windows \
1263 || (SELW) == XWINDOW (selected_window) \
1264 || (minibuf_level > 0 \
1265 && !NILP (minibuf_selected_window) \
1266 && (MBW) == XWINDOW (minibuf_window) \
1267 && (SCRW) == XWINDOW (minibuf_selected_window))) \
1268 ? MODE_LINE_FACE_ID \
1269 : MODE_LINE_INACTIVE_FACE_ID)
1272 /* Return the desired face id for the mode line of window W. */
1274 #define CURRENT_MODE_LINE_FACE_ID(W) \
1275 (CURRENT_MODE_LINE_FACE_ID_3((W), XWINDOW (selected_window), (W)))
1277 /* Return the current height of the mode line of window W. If not
1278 known from current_mode_line_height, look at W's current glyph
1279 matrix, or return a default based on the height of the font of the
1280 face `mode-line'. */
1282 #define CURRENT_MODE_LINE_HEIGHT(W) \
1283 (current_mode_line_height >= 0 \
1284 ? current_mode_line_height \
1285 : (MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1286 ? MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1287 : estimate_mode_line_height (XFRAME ((W)->frame), \
1288 CURRENT_MODE_LINE_FACE_ID (W))))
1290 /* Return the current height of the header line of window W. If not
1291 known from current_header_line_height, look at W's current glyph
1292 matrix, or return an estimation based on the height of the font of
1293 the face `header-line'. */
1295 #define CURRENT_HEADER_LINE_HEIGHT(W) \
1296 (current_header_line_height >= 0 \
1297 ? current_header_line_height \
1298 : (MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1299 ? MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1300 : estimate_mode_line_height (XFRAME ((W)->frame), \
1301 HEADER_LINE_FACE_ID)))
1303 /* Return the height of the desired mode line of window W. */
1305 #define DESIRED_MODE_LINE_HEIGHT(W) \
1306 MATRIX_MODE_LINE_HEIGHT ((W)->desired_matrix)
1308 /* Return the height of the desired header line of window W. */
1310 #define DESIRED_HEADER_LINE_HEIGHT(W) \
1311 MATRIX_HEADER_LINE_HEIGHT ((W)->desired_matrix)
1313 /* Value is non-zero if window W wants a mode line. */
1315 #define WINDOW_WANTS_MODELINE_P(W) \
1316 (!MINI_WINDOW_P ((W)) \
1317 && !(W)->pseudo_window_p \
1318 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1319 && BUFFERP ((W)->buffer) \
1320 && !NILP (XBUFFER ((W)->buffer)->mode_line_format) \
1321 && WINDOW_TOTAL_LINES (W) > 1)
1323 /* Value is non-zero if window W wants a header line. */
1325 #define WINDOW_WANTS_HEADER_LINE_P(W) \
1326 (!MINI_WINDOW_P ((W)) \
1327 && !(W)->pseudo_window_p \
1328 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
1329 && BUFFERP ((W)->buffer) \
1330 && !NILP (XBUFFER ((W)->buffer)->header_line_format) \
1331 && WINDOW_TOTAL_LINES (W) > 1 + !NILP (XBUFFER ((W)->buffer)->mode_line_format))
1334 /* Return proper value to be used as baseline offset of font that has
1335 ASCENT and DESCENT to draw characters by the font at the vertical
1336 center of the line of frame F.
1338 Here, our task is to find the value of BOFF in the following figure;
1340 -------------------------+-----------+-
1341 -+-+---------+-+ | |
1342 | | | | | |
1343 | | | | F_ASCENT F_HEIGHT
1344 | | | ASCENT | |
1345 HEIGHT | | | | |
1346 | | |-|-+------+-----------|------- baseline
1347 | | | | BOFF | |
1348 | |---------|-+-+ | |
1349 | | | DESCENT | |
1350 -+-+---------+-+ F_DESCENT |
1351 -------------------------+-----------+-
1353 -BOFF + DESCENT + (F_HEIGHT - HEIGHT) / 2 = F_DESCENT
1354 BOFF = DESCENT + (F_HEIGHT - HEIGHT) / 2 - F_DESCENT
1355 DESCENT = FONT->descent
1356 HEIGHT = FONT_HEIGHT (FONT)
1357 F_DESCENT = (FRAME_FONT (F)->descent
1358 - F->output_data.x->baseline_offset)
1359 F_HEIGHT = FRAME_LINE_HEIGHT (F)
1362 #define VCENTER_BASELINE_OFFSET(FONT, F) \
1363 (FONT_DESCENT (FONT) \
1364 + (FRAME_LINE_HEIGHT ((F)) - FONT_HEIGHT ((FONT)) \
1365 + (FRAME_LINE_HEIGHT ((F)) > FONT_HEIGHT ((FONT)))) / 2 \
1366 - (FONT_DESCENT (FRAME_FONT (F)) - FRAME_BASELINE_OFFSET (F)))
1369 /***********************************************************************
1370 Faces
1371 ***********************************************************************/
1373 /* Indices of face attributes in Lisp face vectors. Slot zero is the
1374 symbol `face'. */
1376 enum lface_attribute_index
1378 LFACE_FAMILY_INDEX = 1,
1379 LFACE_SWIDTH_INDEX,
1380 LFACE_HEIGHT_INDEX,
1381 LFACE_WEIGHT_INDEX,
1382 LFACE_SLANT_INDEX,
1383 LFACE_UNDERLINE_INDEX,
1384 LFACE_INVERSE_INDEX,
1385 LFACE_FOREGROUND_INDEX,
1386 LFACE_BACKGROUND_INDEX,
1387 LFACE_STIPPLE_INDEX,
1388 LFACE_OVERLINE_INDEX,
1389 LFACE_STRIKE_THROUGH_INDEX,
1390 LFACE_BOX_INDEX,
1391 LFACE_FONT_INDEX,
1392 LFACE_INHERIT_INDEX,
1393 LFACE_AVGWIDTH_INDEX,
1394 LFACE_VECTOR_SIZE
1398 /* Box types of faces. */
1400 enum face_box_type
1402 /* No box around text. */
1403 FACE_NO_BOX,
1405 /* Simple box of specified width and color. Default width is 1, and
1406 default color is the foreground color of the face. */
1407 FACE_SIMPLE_BOX,
1409 /* Boxes with 3D shadows. Color equals the background color of the
1410 face. Width is specified. */
1411 FACE_RAISED_BOX,
1412 FACE_SUNKEN_BOX
1416 /* Structure describing a realized face.
1418 For each Lisp face, 0..N realized faces can exist for different
1419 frames and different charsets. Realized faces are built from Lisp
1420 faces and text properties/overlays by merging faces and adding
1421 unspecified attributes from the `default' face. */
1423 struct face
1425 /* The id of this face. The id equals the index of this face in the
1426 vector faces_by_id of its face cache. */
1427 int id;
1429 #ifdef HAVE_WINDOW_SYSTEM
1431 /* If non-zero, this is a GC that we can use without modification for
1432 drawing the characters in this face. */
1433 GC gc;
1435 /* Font used for this face, or null if the font could not be loaded
1436 for some reason. This points to a `font' slot of a struct
1437 font_info, and we should not call XFreeFont on it because the
1438 font may still be used somewhere else. */
1439 XFontStruct *font;
1441 /* Background stipple or bitmap used for this face. This is
1442 an id as returned from load_pixmap. */
1443 int stipple;
1445 #else /* not HAVE_WINDOW_SYSTEM */
1447 /* Dummy. */
1448 int stipple;
1450 #endif /* not HAVE_WINDOW_SYSTEM */
1452 /* Pixel value of foreground color for X frames. Color index
1453 for tty frames. */
1454 unsigned long foreground;
1456 /* Pixel value or color index of background color. */
1457 unsigned long background;
1459 /* Pixel value or color index of underline color. */
1460 unsigned long underline_color;
1462 /* Pixel value or color index of overlined, strike-through, or box
1463 color. */
1464 unsigned long overline_color;
1465 unsigned long strike_through_color;
1466 unsigned long box_color;
1468 /* The font's name. This points to a `name' of a font_info, and it
1469 must not be freed. */
1470 char *font_name;
1472 /* Font info ID for this face's font. An ID is stored here because
1473 pointers to font_info structures may change. The reason is that
1474 they are pointers into a font table vector that is itself
1475 reallocated. */
1476 int font_info_id;
1478 /* Fontset ID if this face uses a fontset, or -1. This is only >= 0
1479 if the face was realized for a composition sequence.
1480 Otherwise, a specific font is loaded from the set of fonts
1481 specified by the fontset given by the family attribute of the face. */
1482 int fontset;
1484 /* Pixmap width and height. */
1485 unsigned int pixmap_w, pixmap_h;
1487 /* Non-zero means characters in this face have a box that thickness
1488 around them. If it is negative, the absolute value indicates the
1489 thickness, and the horizontal lines of box (top and bottom) are
1490 drawn inside of characters glyph area. The vertical lines of box
1491 (left and right) are drawn as the same way as the case that this
1492 value is positive. */
1493 int box_line_width;
1495 /* Type of box drawn. A value of FACE_NO_BOX means no box is drawn
1496 around text in this face. A value of FACE_SIMPLE_BOX means a box
1497 of width box_line_width is drawn in color box_color. A value of
1498 FACE_RAISED_BOX or FACE_SUNKEN_BOX means a 3D box is drawn with
1499 shadow colors derived from the background color of the face. */
1500 enum face_box_type box;
1502 /* If `box' above specifies a 3D type, 1 means use box_color for
1503 drawing shadows. */
1504 unsigned use_box_color_for_shadows_p : 1;
1506 /* The Lisp face attributes this face realizes. All attributes
1507 in this vector are non-nil. */
1508 Lisp_Object lface[LFACE_VECTOR_SIZE];
1510 /* The hash value of this face. */
1511 unsigned hash;
1513 /* The charset for which this face was realized if it was realized
1514 for use in multibyte text. If fontset >= 0, this is the charset
1515 of the first character of the composition sequence. A value of
1516 charset < 0 means the face was realized for use in unibyte text
1517 where the idea of Emacs charsets isn't applicable. */
1518 int charset;
1520 /* Non-zero if text in this face should be underlined, overlined,
1521 strike-through or have a box drawn around it. */
1522 unsigned underline_p : 1;
1523 unsigned overline_p : 1;
1524 unsigned strike_through_p : 1;
1526 /* 1 means that the colors specified for this face could not be
1527 loaded, and were replaced by default colors, so they shouldn't be
1528 freed. */
1529 unsigned foreground_defaulted_p : 1;
1530 unsigned background_defaulted_p : 1;
1532 /* 1 means that either no color is specified for underlining or that
1533 the specified color couldn't be loaded. Use the foreground
1534 color when drawing in that case. */
1535 unsigned underline_defaulted_p : 1;
1537 /* 1 means that either no color is specified for the corresponding
1538 attribute or that the specified color couldn't be loaded.
1539 Use the foreground color when drawing in that case. */
1540 unsigned overline_color_defaulted_p : 1;
1541 unsigned strike_through_color_defaulted_p : 1;
1542 unsigned box_color_defaulted_p : 1;
1544 /* TTY appearances. Blinking is not yet implemented. Colors are
1545 found in `lface' with empty color string meaning the default
1546 color of the TTY. */
1547 unsigned tty_bold_p : 1;
1548 unsigned tty_dim_p : 1;
1549 unsigned tty_underline_p : 1;
1550 unsigned tty_alt_charset_p : 1;
1551 unsigned tty_reverse_p : 1;
1552 unsigned tty_blinking_p : 1;
1554 /* 1 means that colors of this face may not be freed because they
1555 have been copied bitwise from a base face (see
1556 realize_x_face). */
1557 unsigned colors_copied_bitwise_p : 1;
1559 /* If non-zero, use overstrike (to simulate bold-face). */
1560 unsigned overstrike : 1;
1562 /* Next and previous face in hash collision list of face cache. */
1563 struct face *next, *prev;
1565 /* If this face is for ASCII characters, this points this face
1566 itself. Otherwise, this points a face for ASCII characters. */
1567 struct face *ascii_face;
1571 /* Color index indicating that face uses a terminal's default color. */
1573 #define FACE_TTY_DEFAULT_COLOR ((unsigned long) -1)
1575 /* Color index indicating that face uses an unknown foreground color. */
1577 #define FACE_TTY_DEFAULT_FG_COLOR ((unsigned long) -2)
1579 /* Color index indicating that face uses an unknown background color. */
1581 #define FACE_TTY_DEFAULT_BG_COLOR ((unsigned long) -3)
1583 /* Non-zero if FACE was realized for unibyte use. */
1585 #define FACE_UNIBYTE_P(FACE) ((FACE)->charset < 0)
1588 /* IDs of important faces known by the C face code. These are the IDs
1589 of the faces for CHARSET_ASCII. */
1591 enum face_id
1593 DEFAULT_FACE_ID,
1594 MODE_LINE_FACE_ID,
1595 MODE_LINE_INACTIVE_FACE_ID,
1596 TOOL_BAR_FACE_ID,
1597 FRINGE_FACE_ID,
1598 HEADER_LINE_FACE_ID,
1599 SCROLL_BAR_FACE_ID,
1600 BORDER_FACE_ID,
1601 CURSOR_FACE_ID,
1602 MOUSE_FACE_ID,
1603 MENU_FACE_ID,
1604 VERTICAL_BORDER_FACE_ID,
1605 BASIC_FACE_ID_SENTINEL
1608 #define MAX_FACE_ID ((1 << FACE_ID_BITS) - 1)
1610 /* A cache of realized faces. Each frame has its own cache because
1611 Emacs allows different frame-local face definitions. */
1613 struct face_cache
1615 /* Hash table of cached realized faces. */
1616 struct face **buckets;
1618 /* Back-pointer to the frame this cache belongs to. */
1619 struct frame *f;
1621 /* A vector of faces so that faces can be referenced by an ID. */
1622 struct face **faces_by_id;
1624 /* The allocated size, and number of used slots of faces_by_id. */
1625 int size, used;
1627 /* Flag indicating that attributes of the `menu' face have been
1628 changed. */
1629 unsigned menu_face_changed_p : 1;
1633 /* Prepare face FACE for use on frame F. This must be called before
1634 using X resources of FACE. */
1636 #define PREPARE_FACE_FOR_DISPLAY(F, FACE) \
1637 if ((FACE)->gc == 0) \
1638 prepare_face_for_display ((F), (FACE)); \
1639 else \
1640 (void) 0
1642 /* Return a pointer to the face with ID on frame F, or null if such a
1643 face doesn't exist. */
1645 #define FACE_FROM_ID(F, ID) \
1646 (((unsigned) (ID) < FRAME_FACE_CACHE (F)->used) \
1647 ? FRAME_FACE_CACHE (F)->faces_by_id[ID] \
1648 : NULL)
1650 #ifdef HAVE_WINDOW_SYSTEM
1652 /* Non-zero if FACE is suitable for displaying character CHAR. */
1654 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) \
1655 (SINGLE_BYTE_CHAR_P (CHAR) \
1656 ? (FACE) == (FACE)->ascii_face \
1657 : face_suitable_for_char_p ((FACE), (CHAR)))
1659 /* Return the id of the realized face on frame F that is like the face
1660 with id ID but is suitable for displaying character CHAR.
1661 This macro is only meaningful for multibyte character CHAR. */
1663 #define FACE_FOR_CHAR(F, FACE, CHAR) \
1664 (SINGLE_BYTE_CHAR_P (CHAR) \
1665 ? (FACE)->ascii_face->id \
1666 : face_for_char ((F), (FACE), (CHAR)))
1668 #else /* not HAVE_WINDOW_SYSTEM */
1670 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) 1
1671 #define FACE_FOR_CHAR(F, FACE, CHAR) ((FACE)->id)
1673 #endif /* not HAVE_WINDOW_SYSTEM */
1675 /* Non-zero means face attributes have been changed since the last
1676 redisplay. Used in redisplay_internal. */
1678 extern int face_change_count;
1683 /***********************************************************************
1684 Fringes
1685 ***********************************************************************/
1687 /* Structure used to describe where and how to draw a fringe bitmap.
1688 WHICH is the fringe bitmap to draw. WD and H is the (adjusted)
1689 width and height of the bitmap, DH is the height adjustment (if
1690 bitmap is periodic). X and Y are frame coordinates of the area to
1691 display the bitmap, DY is relative offset of the bitmap into that
1692 area. BX, NX, BY, NY specifies the area to clear if the bitmap
1693 does not fill the entire area. FACE is the fringe face. */
1695 struct draw_fringe_bitmap_params
1697 int which; /* enum fringe_bitmap_type */
1698 unsigned short *bits;
1699 int wd, h, dh;
1700 int x, y;
1701 int bx, nx, by, ny;
1702 unsigned cursor_p : 1;
1703 unsigned overlay_p : 1;
1704 struct face *face;
1707 #define MAX_FRINGE_BITMAPS (1<<FRINGE_ID_BITS)
1710 /***********************************************************************
1711 Display Iterator
1712 ***********************************************************************/
1714 /* Iteration over things to display in current_buffer or in a string.
1716 The iterator handles:
1718 1. Overlay strings (after-string, before-string).
1719 2. Face properties.
1720 3. Invisible text properties.
1721 4. Selective display.
1722 5. Translation of characters via display tables.
1723 6. Translation of control characters to the forms `\003' or `^C'.
1724 7. `glyph' and `space-width' properties.
1726 Iterators are initialized by calling init_iterator or one of the
1727 equivalent functions below. A call to get_next_display_element
1728 loads the iterator structure with information about what next to
1729 display. A call to set_iterator_to_next increments the iterator's
1730 position.
1732 Characters from overlay strings, display table entries or control
1733 character translations are returned one at a time. For example, if
1734 we have a text of `a\x01' where `a' has a display table definition
1735 of `cd' and the control character is displayed with a leading
1736 arrow, then the iterator will return:
1738 Call Return Source Call next
1739 -----------------------------------------------------------------
1740 next c display table move
1741 next d display table move
1742 next ^ control char move
1743 next A control char move
1745 The same mechanism is also used to return characters for ellipses
1746 displayed at the end of invisible text.
1748 CAVEAT: Under some circumstances, move_.* functions can be called
1749 asynchronously, e.g. when computing a buffer position from an x and
1750 y pixel position. This means that these functions and functions
1751 called from them SHOULD NOT USE xmalloc and alike. See also the
1752 comment at the start of xdisp.c. */
1754 /* Enumeration describing what kind of display element an iterator is
1755 loaded with after a call to get_next_display_element. */
1757 enum display_element_type
1759 /* A normal character. */
1760 IT_CHARACTER,
1762 /* A composition sequence. */
1763 IT_COMPOSITION,
1765 /* An image. */
1766 IT_IMAGE,
1768 /* A flexible width and height space. */
1769 IT_STRETCH,
1771 /* End of buffer or string. */
1772 IT_EOB,
1774 /* Truncation glyphs. Never returned by get_next_display_element.
1775 Used to get display information about truncation glyphs via
1776 produce_glyphs. */
1777 IT_TRUNCATION,
1779 /* Continuation glyphs. See the comment for IT_TRUNCATION. */
1780 IT_CONTINUATION
1784 /* An enumerator for each text property that has a meaning for display
1785 purposes. */
1787 enum prop_idx
1789 FONTIFIED_PROP_IDX,
1790 FACE_PROP_IDX,
1791 INVISIBLE_PROP_IDX,
1792 DISPLAY_PROP_IDX,
1793 COMPOSITION_PROP_IDX,
1795 /* Not a property. Used to indicate changes in overlays. */
1796 OVERLAY_PROP_IDX,
1798 /* Sentinel. */
1799 LAST_PROP_IDX
1803 struct it_slice
1805 Lisp_Object x;
1806 Lisp_Object y;
1807 Lisp_Object width;
1808 Lisp_Object height;
1811 enum it_method {
1812 GET_FROM_BUFFER = 0,
1813 GET_FROM_DISPLAY_VECTOR,
1814 GET_FROM_COMPOSITION,
1815 GET_FROM_STRING,
1816 GET_FROM_C_STRING,
1817 GET_FROM_IMAGE,
1818 GET_FROM_STRETCH,
1819 NUM_IT_METHODS
1822 struct it
1824 /* The window in which we iterate over current_buffer (or a string). */
1825 Lisp_Object window;
1826 struct window *w;
1828 /* The window's frame. */
1829 struct frame *f;
1831 /* Method to use to load this structure with the next display element. */
1832 enum it_method method;
1834 /* The next position at which to check for face changes, invisible
1835 text, overlay strings, end of text etc., which see. */
1836 int stop_charpos;
1838 /* Maximum string or buffer position + 1. ZV when iterating over
1839 current_buffer. */
1840 int end_charpos;
1842 /* C string to iterate over. Non-null means get characters from
1843 this string, otherwise characters are read from current_buffer
1844 or it->string. */
1845 unsigned char *s;
1847 /* Number of characters in the string (s, or it->string) we iterate
1848 over. */
1849 int string_nchars;
1851 /* Start and end of a visible region; -1 if the region is not
1852 visible in the window. */
1853 int region_beg_charpos, region_end_charpos;
1855 /* Position at which redisplay end trigger functions should be run. */
1856 int redisplay_end_trigger_charpos;
1858 /* 1 means multibyte characters are enabled. */
1859 unsigned multibyte_p : 1;
1861 /* 1 means window has a mode line at its top. */
1862 unsigned header_line_p : 1;
1864 /* 1 means `string' is the value of a `display' property.
1865 Don't handle some `display' properties in these strings. */
1866 unsigned string_from_display_prop_p : 1;
1868 /* When METHOD == next_element_from_display_vector,
1869 this is 1 if we're doing an ellipsis. Otherwise meaningless. */
1870 unsigned ellipsis_p : 1;
1872 /* Display table in effect or null for none. */
1873 struct Lisp_Char_Table *dp;
1875 /* Current display table vector to return characters from and its
1876 end. dpvec null means we are not returning characters from a
1877 display table entry; current.dpvec_index gives the current index
1878 into dpvec. This same mechanism is also used to return
1879 characters from translated control characters, i.e. `\003' or
1880 `^C'. */
1881 Lisp_Object *dpvec, *dpend;
1883 /* Length in bytes of the char that filled dpvec. A value of zero
1884 means that no such character is involved. */
1885 int dpvec_char_len;
1887 /* Face id to use for all characters in display vector. -1 if unused. */
1888 int dpvec_face_id;
1890 /* Face id of the iterator saved in case a glyph from dpvec contains
1891 a face. The face is restored when all glyphs from dpvec have
1892 been delivered. */
1893 int saved_face_id;
1895 /* Vector of glyphs for control character translation. The pointer
1896 dpvec is set to ctl_chars when a control character is translated.
1897 This vector is also used for incomplete multibyte character
1898 translation (e.g \222\244). Such a character is at most 4 bytes,
1899 thus we need at most 16 bytes here. */
1900 Lisp_Object ctl_chars[16];
1902 /* Initial buffer or string position of the iterator, before skipping
1903 over display properties and invisible text. */
1904 struct display_pos start;
1906 /* Current buffer or string position of the iterator, including
1907 position in overlay strings etc. */
1908 struct display_pos current;
1910 /* Vector of overlays to process. Overlay strings are processed
1911 OVERLAY_STRING_CHUNK_SIZE at a time. */
1912 #define OVERLAY_STRING_CHUNK_SIZE 16
1913 Lisp_Object overlay_strings[OVERLAY_STRING_CHUNK_SIZE];
1915 /* Total number of overlay strings to process. This can be >
1916 OVERLAY_STRING_CHUNK_SIZE. */
1917 int n_overlay_strings;
1919 /* If non-nil, a Lisp string being processed. If
1920 current.overlay_string_index >= 0, this is an overlay string from
1921 pos. */
1922 Lisp_Object string;
1924 /* Stack of saved values. New entries are pushed when we begin to
1925 process an overlay string or a string from a `glyph' property.
1926 Entries are popped when we return to deliver display elements
1927 from what we previously had. */
1928 struct iterator_stack_entry
1930 int stop_charpos;
1931 int face_id;
1932 Lisp_Object string;
1933 struct display_pos pos;
1934 int end_charpos;
1935 int string_nchars;
1936 enum glyph_row_area area;
1937 unsigned multibyte_p : 1;
1938 unsigned string_from_display_prop_p : 1;
1939 unsigned display_ellipsis_p : 1;
1940 struct it_slice slice;
1941 Lisp_Object space_width;
1942 short voffset;
1943 Lisp_Object font_height;
1945 stack[2];
1947 /* Stack pointer. */
1948 int sp;
1950 /* Setting of buffer-local variable selective-display-ellipsis. */
1951 unsigned selective_display_ellipsis_p : 1;
1953 /* 1 means control characters are translated into the form `^C'
1954 where the `^' can be replaced by a display table entry. */
1955 unsigned ctl_arrow_p : 1;
1957 /* -1 means selective display hides everything between a \r and the
1958 next newline; > 0 means hide lines indented more than that value. */
1959 int selective;
1961 /* An enumeration describing what the next display element is
1962 after a call to get_next_display_element. */
1963 enum display_element_type what;
1965 /* Face to use. */
1966 int face_id;
1968 /* Non-zero means that the current face has a box. */
1969 unsigned face_box_p : 1;
1971 /* Non-null means that the current character is the first in a run
1972 of characters with box face. */
1973 unsigned start_of_box_run_p : 1;
1975 /* Non-zero means that the current character is the last in a run
1976 of characters with box face. */
1977 unsigned end_of_box_run_p : 1;
1979 /* 1 means overlay strings at end_charpos have been processed. */
1980 unsigned overlay_strings_at_end_processed_p : 1;
1982 /* 1 means to ignore overlay strings at current pos, as they have
1983 already been processed. */
1984 unsigned ignore_overlay_strings_at_pos_p : 1;
1986 /* 1 means the actual glyph is not available in the current
1987 system. */
1988 unsigned glyph_not_available_p : 1;
1990 /* 1 means the next line in display_line continues a character
1991 consisting of more than one glyph, and some glyphs of this
1992 character have been put on the previous line. */
1993 unsigned starts_in_middle_of_char_p : 1;
1995 /* If 1, saved_face_id contains the id of the face in front of text
1996 skipped due to selective display. */
1997 unsigned face_before_selective_p : 1;
1999 /* If 1, adjust current glyph so it does not increase current row
2000 descent/ascent (line-height property). Reset after this glyph. */
2001 unsigned constrain_row_ascent_descent_p : 1;
2003 /* The ID of the default face to use. One of DEFAULT_FACE_ID,
2004 MODE_LINE_FACE_ID, etc, depending on what we are displaying. */
2005 int base_face_id;
2007 /* If what == IT_CHARACTER, character and length in bytes. This is
2008 a character from a buffer or string. It may be different from
2009 the character displayed in case that
2010 unibyte_display_via_language_environment is set.
2012 If what == IT_COMPOSITION, the first component of a composition
2013 and length in bytes of the composition. */
2014 int c, len;
2016 /* If what == IT_COMPOSITION, identification number and length in
2017 chars of a composition. */
2018 int cmp_id, cmp_len;
2020 /* The character to display, possibly translated to multibyte
2021 if unibyte_display_via_language_environment is set. This
2022 is set after produce_glyphs has been called. */
2023 int char_to_display;
2025 /* If what == IT_IMAGE, the id of the image to display. */
2026 int image_id;
2028 /* Values from `slice' property. */
2029 struct it_slice slice;
2031 /* Value of the `space-width' property, if any; nil if none. */
2032 Lisp_Object space_width;
2034 /* Computed from the value of the `raise' property. */
2035 short voffset;
2037 /* Value of the `height' property, if any; nil if none. */
2038 Lisp_Object font_height;
2040 /* Object and position where the current display element came from.
2041 Object can be a Lisp string in case the current display element
2042 comes from an overlay string, or it is buffer. It may also be nil
2043 during mode-line update. Position is a position in object. */
2044 Lisp_Object object;
2045 struct text_pos position;
2047 /* 1 means lines are truncated. */
2048 unsigned truncate_lines_p : 1;
2050 /* Number of columns per \t. */
2051 short tab_width;
2053 /* Width in pixels of truncation and continuation glyphs. */
2054 short truncation_pixel_width, continuation_pixel_width;
2056 /* First and last visible x-position in the display area. If window
2057 is hscrolled by n columns, first_visible_x == n * FRAME_COLUMN_WIDTH
2058 (f), and last_visible_x == pixel width of W + first_visible_x. */
2059 int first_visible_x, last_visible_x;
2061 /* Last visible y-position + 1 in the display area without a mode
2062 line, if the window has one. */
2063 int last_visible_y;
2065 /* Default amount of additional space in pixels between lines (for
2066 window systems only.) */
2067 int extra_line_spacing;
2069 /* Max extra line spacing added in this row. */
2070 int max_extra_line_spacing;
2072 /* Override font height information for this glyph.
2073 Used if override_ascent >= 0. Cleared after this glyph. */
2074 int override_ascent, override_descent, override_boff;
2076 /* If non-null, glyphs are produced in glyph_row with each call to
2077 produce_glyphs. */
2078 struct glyph_row *glyph_row;
2080 /* The area of glyph_row to which glyphs are added. */
2081 enum glyph_row_area area;
2083 /* Number of glyphs needed for the last character requested via
2084 produce_glyphs. This is 1 except for tabs. */
2085 int nglyphs;
2087 /* Width of the display element in pixels. Result of
2088 produce_glyphs. */
2089 int pixel_width;
2091 /* Current, maximum logical, and maximum physical line height
2092 information. Result of produce_glyphs. */
2093 int ascent, descent, max_ascent, max_descent;
2094 int phys_ascent, phys_descent, max_phys_ascent, max_phys_descent;
2096 /* Current x pixel position within the display line. This value
2097 does not include the width of continuation lines in front of the
2098 line. The value of current_x is automatically incremented by
2099 pixel_width with each call to produce_glyphs. */
2100 int current_x;
2102 /* Accumulated width of continuation lines. If > 0, this means we
2103 are currently in a continuation line. This is initially zero and
2104 incremented/reset by display_line, move_it_to etc. */
2105 int continuation_lines_width;
2107 /* Current y-position. Automatically incremented by the height of
2108 glyph_row in move_it_to and display_line. */
2109 int current_y;
2111 /* Vertical matrix position of first text line in window. */
2112 int first_vpos;
2114 /* Current vertical matrix position, or line number. Automatically
2115 incremented by move_it_to and display_line. */
2116 int vpos;
2118 /* Horizontal matrix position reached in move_it_in_display_line.
2119 Only set there, not in display_line. */
2120 int hpos;
2122 /* Left fringe bitmap number (enum fringe_bitmap_type). */
2123 unsigned left_user_fringe_bitmap : FRINGE_ID_BITS;
2125 /* Right fringe bitmap number (enum fringe_bitmap_type). */
2126 unsigned right_user_fringe_bitmap : FRINGE_ID_BITS;
2128 /* Face of the left fringe glyph. */
2129 unsigned left_user_fringe_face_id : FACE_ID_BITS;
2131 /* Face of the right fringe glyph. */
2132 unsigned right_user_fringe_face_id : FACE_ID_BITS;
2136 /* Access to positions of iterator IT. */
2138 #define IT_CHARPOS(IT) CHARPOS ((IT).current.pos)
2139 #define IT_BYTEPOS(IT) BYTEPOS ((IT).current.pos)
2140 #define IT_STRING_CHARPOS(IT) CHARPOS ((IT).current.string_pos)
2141 #define IT_STRING_BYTEPOS(IT) BYTEPOS ((IT).current.string_pos)
2143 /* Test if IT has reached the end of its buffer or string. This will
2144 only work after get_next_display_element has been called. */
2146 #define ITERATOR_AT_END_P(IT) ((IT)->what == IT_EOB)
2148 /* Non-zero means IT is at the end of a line. This is the case if it
2149 is either on a newline or on a carriage return and selective
2150 display hides the rest of the line. */
2152 #define ITERATOR_AT_END_OF_LINE_P(IT) \
2153 ((IT)->what == IT_CHARACTER \
2154 && ((IT)->c == '\n' \
2155 || ((IT)->c == '\r' && (IT)->selective)))
2157 /* Call produce_glyphs or produce_glyphs_hook, if set. Shortcut to
2158 avoid the function call overhead. */
2160 #define PRODUCE_GLYPHS(IT) \
2161 do { \
2162 extern int inhibit_free_realized_faces; \
2163 if (rif != NULL) \
2164 rif->produce_glyphs ((IT)); \
2165 else \
2166 produce_glyphs ((IT)); \
2167 if ((IT)->glyph_row != NULL) \
2168 inhibit_free_realized_faces = 1; \
2169 } while (0)
2171 /* Bit-flags indicating what operation move_it_to should perform. */
2173 enum move_operation_enum
2175 /* Stop if specified x-position is reached. */
2176 MOVE_TO_X = 0x01,
2178 /* Stop if specified y-position is reached. */
2179 MOVE_TO_Y = 0x02,
2181 /* Stop if specified vpos is reached. */
2182 MOVE_TO_VPOS = 0x04,
2184 /* Stop if specified buffer or string position is reached. */
2185 MOVE_TO_POS = 0x08
2190 /***********************************************************************
2191 Window-based redisplay interface
2192 ***********************************************************************/
2194 /* Structure used to describe runs of lines that must be scrolled. */
2196 struct run
2198 /* Source and destination y pixel position. */
2199 int desired_y, current_y;
2201 /* Source and destination vpos in matrix. */
2202 int desired_vpos, current_vpos;
2204 /* Height in pixels, number of glyph rows. */
2205 int height, nrows;
2209 /* Handlers for setting frame parameters. */
2211 typedef void (*frame_parm_handler) P_ ((struct frame *, Lisp_Object, Lisp_Object));
2214 /* Structure holding system-dependent interface functions needed
2215 for window-based redisplay. */
2217 struct redisplay_interface
2219 /* Handlers for setting frame parameters. */
2220 frame_parm_handler *frame_parm_handlers;
2222 /* Produce glyphs/get display metrics for the display element IT is
2223 loaded with. */
2224 void (*produce_glyphs) P_ ((struct it *it));
2226 /* Write or insert LEN glyphs from STRING at the nominal output
2227 position. */
2228 void (*write_glyphs) P_ ((struct glyph *string, int len));
2229 void (*insert_glyphs) P_ ((struct glyph *start, int len));
2231 /* Clear from nominal output position to X. X < 0 means clear
2232 to right end of display. */
2233 void (*clear_end_of_line) P_ ((int x));
2235 /* Function to call to scroll the display as described by RUN on
2236 window W. */
2237 void (*scroll_run_hook) P_ ((struct window *w, struct run *run));
2239 /* Function to call after a line in a display has been completely
2240 updated. Used to draw truncation marks and alike. DESIRED_ROW
2241 is the desired row which has been updated. */
2242 void (*after_update_window_line_hook) P_ ((struct glyph_row *desired_row));
2244 /* Function to call before beginning to update window W in
2245 window-based redisplay. */
2246 void (*update_window_begin_hook) P_ ((struct window *w));
2248 /* Function to call after window W has been updated in window-based
2249 redisplay. CURSOR_ON_P non-zero means switch cursor on.
2250 MOUSE_FACE_OVERWRITTEN_P non-zero means that some lines in W
2251 that contained glyphs in mouse-face were overwritten, so we
2252 have to update the mouse highlight. */
2253 void (*update_window_end_hook) P_ ((struct window *w, int cursor_on_p,
2254 int mouse_face_overwritten_p));
2256 /* Move cursor to row/column position VPOS/HPOS, pixel coordinates
2257 Y/X. HPOS/VPOS are window-relative row and column numbers and X/Y
2258 are window-relative pixel positions. */
2259 void (*cursor_to) P_ ((int vpos, int hpos, int y, int x));
2261 /* Flush the display of frame F. For X, this is XFlush. */
2262 void (*flush_display) P_ ((struct frame *f));
2264 /* Flush the display of frame F if non-NULL. This is called
2265 during redisplay, and should be NULL on systems which flushes
2266 automatically before reading input. */
2267 void (*flush_display_optional) P_ ((struct frame *f));
2269 /* Clear the mouse hightlight in window W, if there is any. */
2270 void (*clear_window_mouse_face) P_ ((struct window *w));
2272 /* Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
2273 frame F. */
2274 void (*get_glyph_overhangs) P_ ((struct glyph *glyph, struct frame *f,
2275 int *left, int *right));
2277 /* Fix the display of AREA of ROW in window W for overlapping rows.
2278 This function is called from redraw_overlapping_rows after
2279 desired rows have been made current. */
2280 void (*fix_overlapping_area) P_ ((struct window *w, struct glyph_row *row,
2281 enum glyph_row_area area, int));
2283 #ifdef HAVE_WINDOW_SYSTEM
2285 /* Draw a fringe bitmap in window W of row ROW using parameters P. */
2286 void (*draw_fringe_bitmap) P_ ((struct window *w, struct glyph_row *row,
2287 struct draw_fringe_bitmap_params *p));
2289 /* Define and destroy fringe bitmap no. WHICH. */
2290 void (*define_fringe_bitmap) P_ ((int which, unsigned short *bits,
2291 int h, int wd));
2292 void (*destroy_fringe_bitmap) P_ ((int which));
2294 /* Get metrics of character CHAR2B in FONT of type FONT_TYPE.
2295 Value is null if CHAR2B is not contained in the font. */
2296 XCharStruct * (*per_char_metric) P_ ((XFontStruct *font, XChar2b *char2b,
2297 int font_type));
2299 /* Encode CHAR2B using encoding information from FONT_INFO. CHAR2B is
2300 the two-byte form of C. Encoding is returned in *CHAR2B. If
2301 TWO_BYTE_P is non-null, return non-zero there if font is two-byte. */
2302 int (*encode_char) P_ ((int c, XChar2b *char2b,
2303 struct font_info *font_into, int *two_byte_p));
2305 /* Compute left and right overhang of glyph string S.
2306 A NULL pointer if platform does not support this. */
2307 void (*compute_glyph_string_overhangs) P_ ((struct glyph_string *s));
2309 /* Draw a glyph string S. */
2310 void (*draw_glyph_string) P_ ((struct glyph_string *s));
2312 /* Define cursor CURSOR on frame F. */
2313 void (*define_frame_cursor) P_ ((struct frame *f, Cursor cursor));
2315 /* Clear the area at (X,Y,WIDTH,HEIGHT) of frame F. */
2316 void (*clear_frame_area) P_ ((struct frame *f, int x, int y,
2317 int width, int height));
2319 /* Draw specified cursor CURSOR_TYPE of width CURSOR_WIDTH
2320 at row GLYPH_ROW on window W if ON_P is 1. If ON_P is
2321 0, don't draw cursor. If ACTIVE_P is 1, system caret
2322 should track this cursor (when applicable). */
2323 void (*draw_window_cursor) P_ ((struct window *w,
2324 struct glyph_row *glyph_row,
2325 int x, int y,
2326 int cursor_type, int cursor_width,
2327 int on_p, int active_p));
2329 /* Draw vertical border for window W from (X,Y0) to (X,Y1). */
2330 void (*draw_vertical_window_border) P_ ((struct window *w,
2331 int x, int y0, int y1));
2333 /* Shift display of frame F to make room for inserted glyphs.
2334 The area at pixel (X,Y) of width WIDTH and height HEIGHT is
2335 shifted right by SHIFT_BY pixels. */
2336 void (*shift_glyphs_for_insert) P_ ((struct frame *f,
2337 int x, int y, int width,
2338 int height, int shift_by));
2340 #endif /* HAVE_WINDOW_SYSTEM */
2343 /* The current interface for window-based redisplay. */
2345 extern struct redisplay_interface *rif;
2348 /***********************************************************************
2349 Images
2350 ***********************************************************************/
2352 #ifdef HAVE_WINDOW_SYSTEM
2354 /* Structure forward declarations. */
2356 struct image;
2359 /* Each image format (JPEG, TIFF, ...) supported is described by
2360 a structure of the type below. */
2362 struct image_type
2364 /* A symbol uniquely identifying the image type, .e.g `jpeg'. */
2365 Lisp_Object *type;
2367 /* Check that SPEC is a valid image specification for the given
2368 image type. Value is non-zero if SPEC is valid. */
2369 int (* valid_p) P_ ((Lisp_Object spec));
2371 /* Load IMG which is used on frame F from information contained in
2372 IMG->spec. Value is non-zero if successful. */
2373 int (* load) P_ ((struct frame *f, struct image *img));
2375 /* Free resources of image IMG which is used on frame F. */
2376 void (* free) P_ ((struct frame *f, struct image *img));
2378 /* Next in list of all supported image types. */
2379 struct image_type *next;
2383 /* Structure describing an image. Specific image formats like XBM are
2384 converted into this form, so that display only has to deal with
2385 this type of image. */
2387 struct image
2389 /* The time in seconds at which the image was last displayed. Set
2390 in prepare_image_for_display. */
2391 unsigned long timestamp;
2393 /* Pixmaps of the image. */
2394 Pixmap pixmap, mask;
2396 /* Colors allocated for this image, if any. Allocated via xmalloc. */
2397 unsigned long *colors;
2398 int ncolors;
2400 /* A single `background color' for this image, for the use of anyone that
2401 cares about such a thing. Only valid if the `background_valid' field
2402 is true. This should generally be accessed by calling the accessor
2403 macro `IMAGE_BACKGROUND', which will heuristically calculate a value
2404 if necessary. */
2405 unsigned long background;
2407 /* True if this image has a `transparent' background -- that is, is
2408 uses an image mask. The accessor macro for this is
2409 `IMAGE_BACKGROUND_TRANSPARENT'. */
2410 unsigned background_transparent : 1;
2412 /* True if the `background' and `background_transparent' fields are
2413 valid, respectively. */
2414 unsigned background_valid : 1, background_transparent_valid : 1;
2416 /* Width and height of the image. */
2417 int width, height;
2419 /* These values are used for the rectangles displayed for images
2420 that can't be loaded. */
2421 #define DEFAULT_IMAGE_WIDTH 30
2422 #define DEFAULT_IMAGE_HEIGHT 30
2424 /* Percent of image height used as ascent. A value of
2425 CENTERED_IMAGE_ASCENT means draw the image centered on the
2426 line. */
2427 int ascent;
2428 #define DEFAULT_IMAGE_ASCENT 50
2429 #define CENTERED_IMAGE_ASCENT -1
2431 /* Lisp specification of this image. */
2432 Lisp_Object spec;
2434 /* Relief to draw around the image. */
2435 int relief;
2437 /* Optional margins around the image. This includes the relief. */
2438 int hmargin, vmargin;
2440 /* Reference to the type of the image. */
2441 struct image_type *type;
2443 /* 1 means that loading the image failed. Don't try again. */
2444 unsigned load_failed_p;
2446 /* A place for image types to store additional data. The member
2447 data.lisp_val is marked during GC, so it's safe to store Lisp data
2448 there. Image types should free this data when their `free'
2449 function is called. */
2450 struct
2452 int int_val;
2453 void *ptr_val;
2454 Lisp_Object lisp_val;
2455 } data;
2457 /* Hash value of image specification to speed up comparisons. */
2458 unsigned hash;
2460 /* Image id of this image. */
2461 int id;
2463 /* Hash collision chain. */
2464 struct image *next, *prev;
2468 /* Cache of images. Each frame has a cache. X frames with the same
2469 x_display_info share their caches. */
2471 struct image_cache
2473 /* Hash table of images. */
2474 struct image **buckets;
2476 /* Vector mapping image ids to images. */
2477 struct image **images;
2479 /* Allocated size of `images'. */
2480 unsigned size;
2482 /* Number of images in the cache. */
2483 unsigned used;
2485 /* Reference count (number of frames sharing this cache). */
2486 int refcount;
2490 /* Value is a pointer to the image with id ID on frame F, or null if
2491 no image with that id exists. */
2493 #define IMAGE_FROM_ID(F, ID) \
2494 (((ID) >= 0 && (ID) < (FRAME_X_IMAGE_CACHE (F)->used)) \
2495 ? FRAME_X_IMAGE_CACHE (F)->images[ID] \
2496 : NULL)
2498 /* Size of bucket vector of image caches. Should be prime. */
2500 #define IMAGE_CACHE_BUCKETS_SIZE 1001
2502 #endif /* HAVE_WINDOW_SYSTEM */
2506 /***********************************************************************
2507 Tool-bars
2508 ***********************************************************************/
2510 /* Enumeration defining where to find tool-bar item information in
2511 tool-bar items vectors stored with frames. Each tool-bar item
2512 occupies TOOL_BAR_ITEM_NSLOTS elements in such a vector. */
2514 enum tool_bar_item_idx
2516 /* The key of the tool-bar item. Used to remove items when a binding
2517 for `undefined' is found. */
2518 TOOL_BAR_ITEM_KEY,
2520 /* Non-nil if item is enabled. */
2521 TOOL_BAR_ITEM_ENABLED_P,
2523 /* Non-nil if item is selected (pressed). */
2524 TOOL_BAR_ITEM_SELECTED_P,
2526 /* Caption. */
2527 TOOL_BAR_ITEM_CAPTION,
2529 /* Image(s) to display. This is either a single image specification
2530 or a vector of specifications. */
2531 TOOL_BAR_ITEM_IMAGES,
2533 /* The binding. */
2534 TOOL_BAR_ITEM_BINDING,
2536 /* Button type. One of nil, `:radio' or `:toggle'. */
2537 TOOL_BAR_ITEM_TYPE,
2539 /* Help string. */
2540 TOOL_BAR_ITEM_HELP,
2542 /* Sentinel = number of slots in tool_bar_items occupied by one
2543 tool-bar item. */
2544 TOOL_BAR_ITEM_NSLOTS
2548 /* An enumeration for the different images that can be specified
2549 for a tool-bar item. */
2551 enum tool_bar_item_image
2553 TOOL_BAR_IMAGE_ENABLED_SELECTED,
2554 TOOL_BAR_IMAGE_ENABLED_DESELECTED,
2555 TOOL_BAR_IMAGE_DISABLED_SELECTED,
2556 TOOL_BAR_IMAGE_DISABLED_DESELECTED
2559 /* Margin around tool-bar buttons in pixels. */
2561 extern Lisp_Object Vtool_bar_button_margin;
2563 /* Thickness of relief to draw around tool-bar buttons. */
2565 extern EMACS_INT tool_bar_button_relief;
2567 /* Default values of the above variables. */
2569 #define DEFAULT_TOOL_BAR_BUTTON_MARGIN 4
2570 #define DEFAULT_TOOL_BAR_BUTTON_RELIEF 1
2572 /* The height in pixels of the default tool-bar images. */
2574 #define DEFAULT_TOOL_BAR_IMAGE_HEIGHT 24
2577 /***********************************************************************
2578 Terminal Capabilities
2579 ***********************************************************************/
2581 /* Each of these is a bit representing a terminal `capability' (bold,
2582 inverse, etc). They are or'd together to specify the set of
2583 capabilities being queried for when calling `tty_capable_p' (which
2584 returns true if the terminal supports all of them). */
2586 #define TTY_CAP_INVERSE 0x01
2587 #define TTY_CAP_UNDERLINE 0x02
2588 #define TTY_CAP_BOLD 0x04
2589 #define TTY_CAP_DIM 0x08
2590 #define TTY_CAP_BLINK 0x10
2591 #define TTY_CAP_ALT_CHARSET 0x20
2594 /***********************************************************************
2595 Function Prototypes
2596 ***********************************************************************/
2598 /* Defined in xdisp.c */
2600 struct glyph_row *row_containing_pos P_ ((struct window *, int,
2601 struct glyph_row *,
2602 struct glyph_row *, int));
2603 int string_buffer_position P_ ((struct window *, Lisp_Object, int));
2604 int line_bottom_y P_ ((struct it *));
2605 int display_prop_intangible_p P_ ((Lisp_Object));
2606 void resize_echo_area_exactly P_ ((void));
2607 int resize_mini_window P_ ((struct window *, int));
2608 int try_window P_ ((Lisp_Object, struct text_pos, int));
2609 void window_box P_ ((struct window *, int, int *, int *, int *, int *));
2610 int window_box_height P_ ((struct window *));
2611 int window_text_bottom_y P_ ((struct window *));
2612 int window_box_width P_ ((struct window *, int));
2613 int window_box_left P_ ((struct window *, int));
2614 int window_box_left_offset P_ ((struct window *, int));
2615 int window_box_right P_ ((struct window *, int));
2616 int window_box_right_offset P_ ((struct window *, int));
2617 void window_box_edges P_ ((struct window *, int, int *, int *, int *, int *));
2618 int estimate_mode_line_height P_ ((struct frame *, enum face_id));
2619 void pixel_to_glyph_coords P_ ((struct frame *, int, int, int *, int *,
2620 NativeRectangle *, int));
2621 int glyph_to_pixel_coords P_ ((struct window *, int, int, int *, int *));
2622 void remember_mouse_glyph P_ ((struct frame *, int, int, NativeRectangle *));
2624 void mark_window_display_accurate P_ ((Lisp_Object, int));
2625 void redisplay_preserve_echo_area P_ ((int));
2626 void set_cursor_from_row P_ ((struct window *, struct glyph_row *,
2627 struct glyph_matrix *, int, int, int, int));
2628 void init_iterator P_ ((struct it *, struct window *, int,
2629 int, struct glyph_row *, enum face_id));
2630 void init_iterator_to_row_start P_ ((struct it *, struct window *,
2631 struct glyph_row *));
2632 int get_next_display_element P_ ((struct it *));
2633 void set_iterator_to_next P_ ((struct it *, int));
2634 void produce_glyphs P_ ((struct it *));
2635 void produce_special_glyphs P_ ((struct it *, enum display_element_type));
2636 void start_display P_ ((struct it *, struct window *, struct text_pos));
2637 void move_it_to P_ ((struct it *, int, int, int, int, int));
2638 void move_it_vertically P_ ((struct it *, int));
2639 void move_it_vertically_backward P_ ((struct it *, int));
2640 void move_it_by_lines P_ ((struct it *, int, int));
2641 void move_it_past_eol P_ ((struct it *));
2642 int in_display_vector_p P_ ((struct it *));
2643 int frame_mode_line_height P_ ((struct frame *));
2644 void highlight_trailing_whitespace P_ ((struct frame *, struct glyph_row *));
2645 extern Lisp_Object Qtool_bar;
2646 extern Lisp_Object Vshow_trailing_whitespace;
2647 extern int mode_line_in_non_selected_windows;
2648 extern int redisplaying_p;
2649 extern void add_to_log P_ ((char *, Lisp_Object, Lisp_Object));
2650 extern int help_echo_showing_p;
2651 extern int current_mode_line_height, current_header_line_height;
2652 extern Lisp_Object help_echo_string, help_echo_window;
2653 extern Lisp_Object help_echo_object, previous_help_echo_string;
2654 extern int help_echo_pos;
2655 extern struct frame *last_mouse_frame;
2656 extern int last_tool_bar_item;
2657 extern int mouse_autoselect_window;
2658 extern void reseat_at_previous_visible_line_start P_ ((struct it *));
2660 extern int calc_pixel_width_or_height P_ ((double *, struct it *, Lisp_Object,
2661 /* XFontStruct */ void *, int, int *));
2663 #ifdef HAVE_WINDOW_SYSTEM
2665 #if GLYPH_DEBUG
2666 extern void dump_glyph_string P_ ((struct glyph_string *));
2667 #endif
2669 extern void x_get_glyph_overhangs P_ ((struct glyph *, struct frame *,
2670 int *, int *));
2671 extern void x_produce_glyphs P_ ((struct it *));
2673 extern void x_write_glyphs P_ ((struct glyph *, int));
2674 extern void x_insert_glyphs P_ ((struct glyph *, int len));
2675 extern void x_clear_end_of_line P_ ((int));
2677 extern int x_stretch_cursor_p;
2678 extern struct cursor_pos output_cursor;
2680 extern void x_fix_overlapping_area P_ ((struct window *, struct glyph_row *,
2681 enum glyph_row_area, int));
2682 extern void draw_phys_cursor_glyph P_ ((struct window *,
2683 struct glyph_row *,
2684 enum draw_glyphs_face));
2685 extern int get_phys_cursor_geometry P_ ((struct window *, struct glyph_row *,
2686 struct glyph *, int *));
2687 extern void erase_phys_cursor P_ ((struct window *));
2688 extern void display_and_set_cursor P_ ((struct window *,
2689 int, int, int, int, int));
2691 extern void set_output_cursor P_ ((struct cursor_pos *));
2692 extern void x_cursor_to P_ ((int, int, int, int));
2694 extern void x_update_cursor P_ ((struct frame *, int));
2695 extern void x_clear_cursor P_ ((struct window *));
2696 extern void x_draw_vertical_border P_ ((struct window *w));
2698 extern void frame_to_window_pixel_xy P_ ((struct window *, int *, int *));
2699 extern int get_glyph_string_clip_rects P_ ((struct glyph_string *,
2700 NativeRectangle *, int));
2701 extern void get_glyph_string_clip_rect P_ ((struct glyph_string *,
2702 NativeRectangle *nr));
2703 extern Lisp_Object find_hot_spot P_ ((Lisp_Object, int, int));
2704 extern void note_mouse_highlight P_ ((struct frame *, int, int));
2705 extern void x_clear_window_mouse_face P_ ((struct window *));
2706 extern void cancel_mouse_face P_ ((struct frame *));
2708 extern void handle_tool_bar_click P_ ((struct frame *,
2709 int, int, int, unsigned int));
2711 /* msdos.c defines its own versions of these functions. */
2712 extern int clear_mouse_face P_ ((Display_Info *));
2713 extern void show_mouse_face P_ ((Display_Info *, enum draw_glyphs_face));
2714 extern int cursor_in_mouse_face_p P_ ((struct window *w));
2716 extern void expose_frame P_ ((struct frame *, int, int, int, int));
2717 extern int x_intersect_rectangles P_ ((XRectangle *, XRectangle *,
2718 XRectangle *));
2719 #endif
2721 /* Defined in fringe.c */
2723 int lookup_fringe_bitmap (Lisp_Object);
2724 void draw_fringe_bitmap P_ ((struct window *, struct glyph_row *, int));
2725 void draw_row_fringe_bitmaps P_ ((struct window *, struct glyph_row *));
2726 int draw_window_fringes P_ ((struct window *, int));
2727 int update_window_fringes P_ ((struct window *, int));
2728 void compute_fringe_widths P_ ((struct frame *, int));
2730 #ifdef WINDOWS_NT
2731 void w32_init_fringe P_ ((void));
2732 void w32_reset_fringes P_ ((void));
2733 #endif
2735 /* Defined in image.c */
2737 #ifdef HAVE_WINDOW_SYSTEM
2739 extern int x_bitmap_height P_ ((struct frame *, int));
2740 extern int x_bitmap_width P_ ((struct frame *, int));
2741 extern int x_bitmap_pixmap P_ ((struct frame *, int));
2742 extern void x_reference_bitmap P_ ((struct frame *, int));
2743 extern int x_create_bitmap_from_data P_ ((struct frame *, char *,
2744 unsigned int, unsigned int));
2745 extern int x_create_bitmap_from_file P_ ((struct frame *, Lisp_Object));
2746 #ifndef x_destroy_bitmap
2747 extern void x_destroy_bitmap P_ ((struct frame *, int));
2748 #endif
2749 extern void x_destroy_all_bitmaps P_ ((Display_Info *));
2750 extern int x_create_bitmap_mask P_ ((struct frame * , int));
2751 extern Lisp_Object x_find_image_file P_ ((Lisp_Object));
2753 void x_kill_gs_process P_ ((Pixmap, struct frame *));
2754 struct image_cache *make_image_cache P_ ((void));
2755 void free_image_cache P_ ((struct frame *));
2756 void clear_image_cache P_ ((struct frame *, int));
2757 void forall_images_in_image_cache P_ ((struct frame *,
2758 void (*) P_ ((struct image *))));
2759 int valid_image_p P_ ((Lisp_Object));
2760 void prepare_image_for_display P_ ((struct frame *, struct image *));
2761 int lookup_image P_ ((struct frame *, Lisp_Object));
2763 unsigned long image_background P_ ((struct image *, struct frame *,
2764 XImagePtr_or_DC ximg));
2765 int image_background_transparent P_ ((struct image *, struct frame *,
2766 XImagePtr_or_DC mask));
2768 int image_ascent P_ ((struct image *, struct face *, struct glyph_slice *));
2770 #endif
2772 /* Defined in sysdep.c */
2774 void get_frame_size P_ ((int *, int *));
2775 void request_sigio P_ ((void));
2776 void unrequest_sigio P_ ((void));
2777 int tabs_safe_p P_ ((void));
2778 void init_baud_rate P_ ((void));
2779 void init_sigio P_ ((int));
2781 /* Defined in xfaces.c */
2783 #ifdef HAVE_X_WINDOWS
2784 void x_free_colors P_ ((struct frame *, unsigned long *, int));
2785 #endif
2787 void update_face_from_frame_parameter P_ ((struct frame *, Lisp_Object,
2788 Lisp_Object));
2789 Lisp_Object tty_color_name P_ ((struct frame *, int));
2790 void clear_face_cache P_ ((int));
2791 unsigned long load_color P_ ((struct frame *, struct face *, Lisp_Object,
2792 enum lface_attribute_index));
2793 void unload_color P_ ((struct frame *, unsigned long));
2794 int face_font_available_p P_ ((struct frame *, Lisp_Object));
2795 int ascii_face_of_lisp_face P_ ((struct frame *, int));
2796 void prepare_face_for_display P_ ((struct frame *, struct face *));
2797 int xstricmp P_ ((const unsigned char *, const unsigned char *));
2798 int lookup_face P_ ((struct frame *, Lisp_Object *, int, struct face *));
2799 int lookup_named_face P_ ((struct frame *, Lisp_Object, int, int));
2800 int smaller_face P_ ((struct frame *, int, int));
2801 int face_with_height P_ ((struct frame *, int, int));
2802 int lookup_derived_face P_ ((struct frame *, Lisp_Object, int, int, int));
2803 void init_frame_faces P_ ((struct frame *));
2804 void free_frame_faces P_ ((struct frame *));
2805 void recompute_basic_faces P_ ((struct frame *));
2806 int face_at_buffer_position P_ ((struct window *, int, int, int, int *,
2807 int, int));
2808 int face_at_string_position P_ ((struct window *, Lisp_Object, int, int, int,
2809 int, int *, enum face_id, int));
2810 int merge_faces P_ ((struct frame *, Lisp_Object, int, int));
2811 int compute_char_face P_ ((struct frame *, int, Lisp_Object));
2812 void free_all_realized_faces P_ ((Lisp_Object));
2813 extern Lisp_Object Qforeground_color, Qbackground_color;
2814 extern Lisp_Object Qframe_set_background_mode;
2815 extern char unspecified_fg[], unspecified_bg[];
2816 void free_realized_multibyte_face P_ ((struct frame *, int));
2818 /* Defined in xfns.c */
2820 #ifdef HAVE_X_WINDOWS
2821 void gamma_correct P_ ((struct frame *, XColor *));
2822 #endif
2823 #ifdef WINDOWSNT
2824 void gamma_correct P_ ((struct frame *, COLORREF *));
2825 #endif
2826 #ifdef MAC_OS
2827 void gamma_correct P_ ((struct frame *, unsigned long *));
2828 #endif
2830 #ifdef HAVE_WINDOW_SYSTEM
2832 int x_screen_planes P_ ((struct frame *));
2833 void x_implicitly_set_name P_ ((struct frame *, Lisp_Object, Lisp_Object));
2835 extern Lisp_Object tip_frame;
2836 extern Window tip_window;
2837 EXFUN (Fx_show_tip, 6);
2838 EXFUN (Fx_hide_tip, 0);
2839 extern void start_hourglass P_ ((void));
2840 extern void cancel_hourglass P_ ((void));
2841 extern int hourglass_started P_ ((void));
2842 extern int display_hourglass_p;
2844 /* Returns the background color of IMG, calculating one heuristically if
2845 necessary. If non-zero, XIMG is an existing XImage object to use for
2846 the heuristic. */
2848 #define IMAGE_BACKGROUND(img, f, ximg) \
2849 ((img)->background_valid \
2850 ? (img)->background \
2851 : image_background (img, f, ximg))
2853 /* Returns true if IMG has a `transparent' background, using heuristics
2854 to decide if necessary. If non-zero, MASK is an existing XImage
2855 object to use for the heuristic. */
2857 #define IMAGE_BACKGROUND_TRANSPARENT(img, f, mask) \
2858 ((img)->background_transparent_valid \
2859 ? (img)->background_transparent \
2860 : image_background_transparent (img, f, mask))
2862 #endif /* HAVE_WINDOW_SYSTEM */
2865 /* Defined in xmenu.c */
2867 int popup_activated P_ ((void));
2869 /* Defined in dispnew.c */
2871 extern int inverse_video;
2872 extern int required_matrix_width P_ ((struct window *));
2873 extern int required_matrix_height P_ ((struct window *));
2874 extern Lisp_Object buffer_posn_from_coords P_ ((struct window *,
2875 int *, int *,
2876 struct display_pos *,
2877 Lisp_Object *,
2878 int *, int *, int *, int *));
2879 extern Lisp_Object mode_line_string P_ ((struct window *, enum window_part,
2880 int *, int *, int *,
2881 Lisp_Object *,
2882 int *, int *, int *, int *));
2883 extern Lisp_Object marginal_area_string P_ ((struct window *, enum window_part,
2884 int *, int *, int *,
2885 Lisp_Object *,
2886 int *, int *, int *, int *));
2887 extern void redraw_frame P_ ((struct frame *));
2888 extern void redraw_garbaged_frames P_ ((void));
2889 extern void cancel_line P_ ((int, struct frame *));
2890 extern void init_desired_glyphs P_ ((struct frame *));
2891 extern int scroll_frame_lines P_ ((struct frame *, int, int, int, int));
2892 extern int direct_output_for_insert P_ ((int));
2893 extern int direct_output_forward_char P_ ((int));
2894 extern int update_frame P_ ((struct frame *, int, int));
2895 extern int scrolling P_ ((struct frame *));
2896 extern void bitch_at_user P_ ((void));
2897 void adjust_glyphs P_ ((struct frame *));
2898 void free_glyphs P_ ((struct frame *));
2899 void free_window_matrices P_ ((struct window *));
2900 void check_glyph_memory P_ ((void));
2901 void mirrored_line_dance P_ ((struct glyph_matrix *, int, int, int *, char *));
2902 void clear_glyph_matrix P_ ((struct glyph_matrix *));
2903 void clear_current_matrices P_ ((struct frame *f));
2904 void clear_desired_matrices P_ ((struct frame *));
2905 void shift_glyph_matrix P_ ((struct window *, struct glyph_matrix *,
2906 int, int, int));
2907 void rotate_matrix P_ ((struct glyph_matrix *, int, int, int));
2908 void increment_matrix_positions P_ ((struct glyph_matrix *,
2909 int, int, int, int));
2910 void blank_row P_ ((struct window *, struct glyph_row *, int));
2911 void increment_row_positions P_ ((struct glyph_row *, int, int));
2912 void enable_glyph_matrix_rows P_ ((struct glyph_matrix *, int, int, int));
2913 void clear_glyph_row P_ ((struct glyph_row *));
2914 void prepare_desired_row P_ ((struct glyph_row *));
2915 int line_hash_code P_ ((struct glyph_row *));
2916 void set_window_update_flags P_ ((struct window *, int));
2917 void write_glyphs P_ ((struct glyph *, int));
2918 void insert_glyphs P_ ((struct glyph *, int));
2919 void redraw_frame P_ ((struct frame *));
2920 void redraw_garbaged_frames P_ ((void));
2921 int scroll_cost P_ ((struct frame *, int, int, int));
2922 int direct_output_for_insert P_ ((int));
2923 int direct_output_forward_char P_ ((int));
2924 int update_frame P_ ((struct frame *, int, int));
2925 void update_single_window P_ ((struct window *, int));
2926 int scrolling P_ ((struct frame *));
2927 void do_pending_window_change P_ ((int));
2928 void change_frame_size P_ ((struct frame *, int, int, int, int, int));
2929 void bitch_at_user P_ ((void));
2930 Lisp_Object sit_for P_ ((int, int, int, int, int));
2931 void init_display P_ ((void));
2932 void syms_of_display P_ ((void));
2933 extern Lisp_Object Qredisplay_dont_pause;
2934 GLYPH spec_glyph_lookup_face P_ ((struct window *, GLYPH));
2936 /* Defined in term.c */
2938 extern void ring_bell P_ ((void));
2939 extern void set_terminal_modes P_ ((void));
2940 extern void reset_terminal_modes P_ ((void));
2941 extern void update_begin P_ ((struct frame *));
2942 extern void update_end P_ ((struct frame *));
2943 extern void set_terminal_window P_ ((int));
2944 extern void set_scroll_region P_ ((int, int));
2945 extern void turn_off_insert P_ ((void));
2946 extern void turn_off_highlight P_ ((void));
2947 extern void background_highlight P_ ((void));
2948 extern void clear_frame P_ ((void));
2949 extern void clear_end_of_line P_ ((int));
2950 extern void clear_end_of_line_raw P_ ((int));
2951 extern void delete_glyphs P_ ((int));
2952 extern void ins_del_lines P_ ((int, int));
2953 extern int string_cost P_ ((char *));
2954 extern int per_line_cost P_ ((char *));
2955 extern void calculate_costs P_ ((struct frame *));
2956 extern void set_tty_color_mode P_ ((struct frame *, Lisp_Object));
2957 extern void tty_setup_colors P_ ((int));
2958 extern void term_init P_ ((char *));
2959 void cursor_to P_ ((int, int));
2960 extern int tty_capable_p P_ ((struct frame *, unsigned, unsigned long, unsigned long));
2962 /* Defined in scroll.c */
2964 extern int scrolling_max_lines_saved P_ ((int, int, int *, int *, int *));
2965 extern int scroll_cost P_ ((struct frame *, int, int, int));
2966 extern void do_line_insertion_deletion_costs P_ ((struct frame *, char *,
2967 char *, char *, char *,
2968 char *, char *, int));
2969 void scrolling_1 P_ ((struct frame *, int, int, int, int *, int *, int *,
2970 int *, int));
2972 /* Defined in frame.c */
2974 #ifdef HAVE_WINDOW_SYSTEM
2976 /* Types we might convert a resource string into. */
2977 enum resource_types
2979 RES_TYPE_NUMBER,
2980 RES_TYPE_FLOAT,
2981 RES_TYPE_BOOLEAN,
2982 RES_TYPE_STRING,
2983 RES_TYPE_SYMBOL
2986 extern Lisp_Object x_get_arg P_ ((Display_Info *, Lisp_Object,
2987 Lisp_Object, char *, char *class,
2988 enum resource_types));
2989 extern Lisp_Object x_frame_get_arg P_ ((struct frame *, Lisp_Object,
2990 Lisp_Object, char *, char *,
2991 enum resource_types));
2992 extern Lisp_Object x_frame_get_and_record_arg P_ ((
2993 struct frame *, Lisp_Object,
2994 Lisp_Object, char *, char *,
2995 enum resource_types));
2996 extern Lisp_Object x_default_parameter P_ ((struct frame *, Lisp_Object,
2997 Lisp_Object, Lisp_Object,
2998 char *, char *,
2999 enum resource_types));
3001 #endif /* HAVE_WINDOW_SYSTEM */
3003 #endif /* not DISPEXTERN_H_INCLUDED */
3005 /* arch-tag: c65c475f-1c1e-4534-8795-990b8509fd65
3006 (do not change this comment) */