*** empty log message ***
[emacs.git] / src / dispextern.h
blob257998ccfc15eb4c3572796724aac033f83b7ca7
1 /* Interface definitions for display code.
2 Copyright (C) 1985, 1993, 1994, 1997, 1998, 1999, 2000
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
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., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>. */
24 #ifndef DISPEXTERN_H_INCLUDED
25 #define DISPEXTERN_H_INCLUDED
27 #ifdef HAVE_X_WINDOWS
28 #include <X11/Xlib.h>
29 #ifdef USE_X_TOOLKIT
30 #include <X11/Intrinsic.h>
31 #endif /* USE_X_TOOLKIT */
32 #endif /* HAVE_X_WINDOWS */
34 #ifdef MSDOS
35 #include "msdos.h"
36 #endif
38 #ifdef HAVE_NTGUI
39 #include "w32gui.h"
40 #endif
42 #ifdef macintosh
43 #include "macgui.h"
44 #endif
46 /* Structure forward declarations. Some are here because function
47 prototypes below reference structure types before their definition
48 in this file. Some are here because not every file including
49 dispextern.h also includes frame.h and windows.h. */
51 struct glyph;
52 struct glyph_row;
53 struct glyph_matrix;
54 struct glyph_pool;
55 struct frame;
56 struct window;
60 /***********************************************************************
61 Debugging
62 ***********************************************************************/
64 /* If GLYPH_DEBUG is non-zero, additional checks are activated. Turn
65 it off by defining the macro GLYPH_DEBUG to zero. */
67 #ifndef GLYPH_DEBUG
68 #define GLYPH_DEBUG 0
69 #endif
71 /* Macros to include code only if GLYPH_DEBUG != 0. */
73 #if GLYPH_DEBUG
74 #define IF_DEBUG(X) X
75 #define xassert(X) do {if (!(X)) abort ();} while (0)
76 #else
77 #define IF_DEBUG(X) (void) 0
78 #define xassert(X) (void) 0
79 #endif
81 /* Macro for displaying traces of redisplay. If Emacs was compiled
82 with GLYPH_DEBUG != 0, the variable trace_redisplay_p can be set to
83 a non-zero value in debugging sessions to activate traces. */
85 #if GLYPH_DEBUG
87 extern int trace_redisplay_p;
88 #include <stdio.h>
90 #define TRACE(X) \
91 if (trace_redisplay_p) \
92 fprintf X; \
93 else \
94 (void) 0
96 #else /* GLYPH_DEBUG == 0 */
98 #define TRACE(X) (void) 0
100 #endif /* GLYPH_DEBUG == 0 */
104 /***********************************************************************
105 Text positions
106 ***********************************************************************/
108 /* Starting with Emacs 20.3, characters from strings and buffers have
109 both a character and a byte position associated with them. The
110 following structure holds such a pair of positions. */
112 struct text_pos
114 /* Character position. */
115 int charpos;
117 /* Corresponding byte position. */
118 int bytepos;
121 /* Access character and byte position of POS in a functional form. */
123 #define BYTEPOS(POS) (POS).bytepos
124 #define CHARPOS(POS) (POS).charpos
126 /* Set character position of POS to CHARPOS, byte position to BYTEPOS. */
128 #define SET_TEXT_POS(POS, CHARPOS, BYTEPOS) \
129 ((POS).charpos = (CHARPOS), (POS).bytepos = BYTEPOS)
131 /* Increment text position POS. */
133 #define INC_TEXT_POS(POS, MULTIBYTE_P) \
134 do \
136 ++(POS).charpos; \
137 if (MULTIBYTE_P) \
138 INC_POS ((POS).bytepos); \
139 else \
140 ++(POS).bytepos; \
142 while (0)
144 /* Decrement text position POS. */
146 #define DEC_TEXT_POS(POS, MULTIBYTE_P) \
147 do \
149 --(POS).charpos; \
150 if (MULTIBYTE_P) \
151 DEC_POS ((POS).bytepos); \
152 else \
153 --(POS).bytepos; \
155 while (0)
157 /* Set text position POS from marker MARKER. */
159 #define SET_TEXT_POS_FROM_MARKER(POS, MARKER) \
160 (CHARPOS (POS) = marker_position ((MARKER)), \
161 BYTEPOS (POS) = marker_byte_position ((MARKER)))
163 /* Set marker MARKER from text position POS. */
165 #define SET_MARKER_FROM_TEXT_POS(MARKER, POS) \
166 set_marker_both ((MARKER), Qnil, CHARPOS ((POS)), BYTEPOS ((POS)))
168 /* Value is non-zero if character and byte positions of POS1 and POS2
169 are equal. */
171 #define TEXT_POS_EQUAL_P(POS1, POS2) \
172 ((POS1).charpos == (POS2).charpos \
173 && (POS1).bytepos == (POS2).bytepos)
175 /* When rendering glyphs, redisplay scans string or buffer text,
176 overlay strings in that text, and does display table or control
177 character translations. The following structure captures a
178 position taking all this into account. */
180 struct display_pos
182 /* Buffer or string position. */
183 struct text_pos pos;
185 /* If this is a position in an overlay string, overlay_string_index
186 is the index of that overlay string in the sequence of overlay
187 strings at `pos' in the order redisplay processes them. A value
188 < 0 means that this is not a position in an overlay string. */
189 int overlay_string_index;
191 /* If this is a position in an overlay string, string_pos is the
192 position within that string. */
193 struct text_pos string_pos;
195 /* If the character at the position above is a control character or
196 has a display table entry, dpvec_index is an index in the display
197 table or control character translation of that character. A
198 value < 0 means this is not a position in such a translation. */
199 int dpvec_index;
204 /***********************************************************************
205 Glyphs
206 ***********************************************************************/
208 /* Enumeration of glyph types. Glyph structures contain a type field
209 containing one of the enumerators defined here. */
211 enum glyph_type
213 /* Glyph describes a character. */
214 CHAR_GLYPH,
216 /* Glyph describes a composition sequence. */
217 COMPOSITE_GLYPH,
219 /* Glyph describes an image. */
220 IMAGE_GLYPH,
222 /* Glyph is a space of fractional width and/or height. */
223 STRETCH_GLYPH
227 /* Glyphs.
229 Be extra careful when changing this structure! Esp. make sure that
230 functions producing glyphs, like x_append_glyph, fill ALL of the
231 glyph structure, and that GLYPH_EQUAL_P compares all
232 display-relevant members of glyphs (not to imply that these are the
233 only things to check when you add a member). */
235 struct glyph
237 /* Position from which this glyph was drawn. If `object' below is a
238 Lisp string, this is a position in that string. If it is a
239 buffer, this is a position in that buffer. A value of -1
240 together with a null object means glyph is a truncation glyph at
241 the start of a row. */
242 int charpos;
244 /* Lisp object source of this glyph. Currently either a buffer or
245 a string, or 0. */
246 Lisp_Object object;
248 /* Width in pixels. */
249 short pixel_width;
251 /* Vertical offset. If < 0, the glyph is displayed raised, if > 0
252 the glyph is displayed lowered. */
253 short voffset;
255 /* Which kind of glyph this is---character, image etc. Value
256 should be an enumerator of type enum glyph_type. */
257 unsigned type : 2;
259 /* 1 means this glyph was produced from multibyte text. Zero
260 means it was produced from unibyte text, i.e. charsets aren't
261 applicable, and encoding is not performed. */
262 unsigned multibyte_p : 1;
264 /* Non-zero means draw a box line at the left or right side of this
265 glyph. This is part of the implementation of the face attribute
266 `:box'. */
267 unsigned left_box_line_p : 1;
268 unsigned right_box_line_p : 1;
270 /* Non-zero means this glyph's physical ascent or descent is greater
271 than its logical ascent/descent, i.e. it may potentially overlap
272 glyphs above or below it. */
273 unsigned overlaps_vertically_p : 1;
275 /* 1 means glyph is a padding glyph. Padding glyphs are used for
276 characters whose visual shape consists of more than one glyph
277 (e.g. Asian characters). All but the first glyph of such a glyph
278 sequence have the padding_p flag set. Only used for terminal
279 frames, and there only to minimize code changes. A better way
280 would probably be to use the width field of glyphs to express
281 padding. */
282 unsigned padding_p : 1;
284 /* 1 means the actual glyph is not available in the current
285 system. */
286 unsigned glyph_not_available_p : 1;
288 /* Face of the glyph. */
289 unsigned face_id : 22;
291 #ifdef WINDOWSNT
292 /* Type of font used to display the character glyph. Used to
293 determine which set of functions to use to obtain font metrics
294 for the glyph. Value should be an enumerator of the type
295 w32_char_font_type. */
296 unsigned w32_font_type : 2;
297 #endif
299 /* A union of sub-structures for different glyph types. */
300 union
302 /* Character code for character glyphs (type == CHAR_GLYPH). */
303 unsigned ch;
305 /* Composition ID for composition glyphs (type == COMPOSITION_GLYPH) */
306 unsigned cmp_id;
308 /* Image ID for image glyphs (type == IMAGE_GLYPH). */
309 unsigned img_id;
311 /* Sub-structure for type == STRETCH_GLYPH. */
312 struct
314 /* The height of the glyph. */
315 unsigned height : 16;
317 /* The ascent of the glyph. */
318 unsigned ascent : 16;
320 stretch;
322 /* Used to compare all bit-fields above in one step. */
323 unsigned val;
324 } u;
328 /* Is GLYPH a space? */
330 #define CHAR_GLYPH_SPACE_P(GLYPH) \
331 (GLYPH_FROM_CHAR_GLYPH ((GLYPH)) == SPACEGLYPH)
333 /* Are glyphs *X and *Y displayed equal? */
335 #define GLYPH_EQUAL_P(X, Y) \
336 ((X)->type == (Y)->type \
337 && (X)->u.val == (Y)->u.val \
338 && (X)->face_id == (Y)->face_id \
339 && (X)->padding_p == (Y)->padding_p \
340 && (X)->left_box_line_p == (Y)->left_box_line_p \
341 && (X)->right_box_line_p == (Y)->right_box_line_p \
342 && (X)->voffset == (Y)->voffset)
344 /* Are character codes, faces, padding_ps of glyphs *X and *Y equal? */
346 #define GLYPH_CHAR_AND_FACE_EQUAL_P(X, Y) \
347 ((X)->u.ch == (Y)->u.ch \
348 && (X)->face_id == (Y)->face_id \
349 && (X)->padding_p == (Y)->padding_p)
351 /* Fill a character glyph GLYPH. CODE, FACE_ID, PADDING_P correspond
352 to the bits defined for the typedef `GLYPH' in lisp.h. */
354 #define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P) \
355 do \
357 (GLYPH).u.ch = (CODE); \
358 (GLYPH).face_id = (FACE_ID); \
359 (GLYPH).padding_p = (PADDING_P); \
361 while (0)
363 /* Fill a character type glyph GLYPH from a glyph typedef FROM as
364 defined in lisp.h. */
366 #define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM) \
367 SET_CHAR_GLYPH ((GLYPH), \
368 FAST_GLYPH_CHAR ((FROM)), \
369 FAST_GLYPH_FACE ((FROM)), \
372 /* Construct a glyph code from a character glyph GLYPH. If the
373 character is multibyte, return -1 as we can't use glyph table for a
374 multibyte character. */
376 #define GLYPH_FROM_CHAR_GLYPH(GLYPH) \
377 ((GLYPH).u.ch < 256 \
378 ? ((GLYPH).u.ch | ((GLYPH).face_id << CHARACTERBITS)) \
379 : -1)
381 /* Is GLYPH a padding glyph? */
383 #define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p
388 /***********************************************************************
389 Glyph Pools
390 ***********************************************************************/
392 /* Glyph Pool.
394 Glyph memory for frame-based redisplay is allocated from the heap
395 in one vector kept in a glyph pool structure which is stored with
396 the frame. The size of the vector is made large enough to cover
397 all windows on the frame.
399 Both frame and window glyph matrices reference memory from a glyph
400 pool in frame-based redisplay.
402 In window-based redisplay, no glyphs pools exist; windows allocate
403 and free their glyph memory themselves. */
405 struct glyph_pool
407 /* Vector of glyphs allocated from the heap. */
408 struct glyph *glyphs;
410 /* Allocated size of `glyphs'. */
411 int nglyphs;
413 /* Number of rows and columns in a matrix. */
414 int nrows, ncolumns;
419 /***********************************************************************
420 Glyph Matrix
421 ***********************************************************************/
423 /* Glyph Matrix.
425 Three kinds of glyph matrices exist:
427 1. Frame glyph matrices. These are used for terminal frames whose
428 redisplay needs a view of the whole screen due to limited terminal
429 capabilities. Frame matrices are used only in the update phase
430 of redisplay. They are built in update_frame and not used after
431 the update has been performed.
433 2. Window glyph matrices on frames having frame glyph matrices.
434 Such matrices are sub-matrices of their corresponding frame matrix,
435 i.e. frame glyph matrices and window glyph matrices share the same
436 glyph memory which is allocated in form of a glyph_pool structure.
437 Glyph rows in such a window matrix are slices of frame matrix rows.
439 2. Free-standing window glyph matrices managing their own glyph
440 storage. This form is used in window-based redisplay which
441 includes variable width and height fonts etc.
443 The size of a window's row vector depends on the height of fonts
444 defined on its frame. It is chosen so that the vector is large
445 enough to describe all lines in a window when it is displayed in
446 the smallest possible character size. When new fonts are loaded,
447 or window sizes change, the row vector is adjusted accordingly. */
449 struct glyph_matrix
451 /* The pool from which glyph memory is allocated, if any. This is
452 null for frame matrices and for window matrices managing their
453 own storage. */
454 struct glyph_pool *pool;
456 /* Vector of glyph row structures. The row at nrows - 1 is reserved
457 for the mode line. */
458 struct glyph_row *rows;
460 /* Number of elements allocated for the vector rows above. */
461 int rows_allocated;
463 /* The number of rows used by the window if all lines were displayed
464 with the smallest possible character height. */
465 int nrows;
467 /* Origin within the frame matrix if this is a window matrix on a
468 frame having a frame matrix. Both values are zero for
469 window-based redisplay. */
470 int matrix_x, matrix_y;
472 /* Width and height of the matrix in columns and rows. */
473 int matrix_w, matrix_h;
475 /* If this structure describes a window matrix of window W,
476 window_left_x is the value of W->left, window_top_y the value of
477 W->top, window_height and window_width are width and height of W,
478 as returned by window_box, and window_vscroll is the value of
479 W->vscroll at the time the matrix was last adjusted. Only set
480 for window-based redisplay. */
481 int window_left_x, window_top_y, window_height, window_width, window_vscroll;
483 /* Number of glyphs reserved for left and right marginal areas when
484 the matrix was last adjusted. */
485 int left_margin_glyphs, right_margin_glyphs;
487 /* Flag indicating that scrolling should not be tried in
488 update_window. This flag is set by functions like try_window_id
489 which do their own scrolling. */
490 unsigned no_scrolling_p : 1;
492 /* Non-zero means window displayed in this matrix has a top mode
493 line. */
494 unsigned header_line_p : 1;
496 #ifdef GLYPH_DEBUG
497 /* A string identifying the method used to display the matrix. */
498 char method[512];
499 #endif
501 /* The buffer this matrix displays. Set in redisplay_internal. */
502 struct buffer *buffer;
504 /* Values of BEGV and ZV as of last redisplay. */
505 int begv, zv;
509 /* Check that glyph pointers stored in glyph rows of MATRIX are okay.
510 This aborts if any pointer is found twice. */
512 #if GLYPH_DEBUG
513 void check_matrix_pointer_lossage P_ ((struct glyph_matrix *));
514 #define CHECK_MATRIX(MATRIX) check_matrix_pointer_lossage ((MATRIX))
515 #else
516 #define CHECK_MATRIX(MATRIX) (void) 0
517 #endif
521 /***********************************************************************
522 Glyph Rows
523 ***********************************************************************/
525 /* Area in window glyph matrix. If values are added or removed, the
526 function mark_object in alloc.c has to be changed. */
528 enum glyph_row_area
530 LEFT_MARGIN_AREA,
531 TEXT_AREA,
532 RIGHT_MARGIN_AREA,
533 LAST_AREA
537 /* Rows of glyphs in a windows or frame glyph matrix.
539 Each row is partitioned into three areas. The start and end of
540 each area is recorded in a pointer as shown below.
542 +--------------------+-------------+---------------------+
543 | left margin area | text area | right margin area |
544 +--------------------+-------------+---------------------+
545 | | | |
546 glyphs[LEFT_MARGIN_AREA] glyphs[RIGHT_MARGIN_AREA]
548 glyphs[TEXT_AREA] |
549 glyphs[LAST_AREA]
551 Rows in frame matrices reference glyph memory allocated in a frame
552 glyph pool (see the description of struct glyph_pool). Rows in
553 window matrices on frames having frame matrices reference slices of
554 the glyphs of corresponding rows in the frame matrix.
556 Rows in window matrices on frames having no frame matrices point to
557 glyphs allocated from the heap via xmalloc;
558 glyphs[LEFT_MARGIN_AREA] is the start address of the allocated
559 glyph structure array. */
561 struct glyph_row
563 /* Pointers to beginnings of areas. The end of an area A is found at
564 A + 1 in the vector. The last element of the vector is the end
565 of the whole row.
567 Kludge alert: Even if used[TEXT_AREA] == 0, glyphs[TEXT_AREA][0]'s
568 position field is used. It is -1 if this row does not correspond
569 to any text; it is some buffer position if the row corresponds to
570 an empty display line that displays a line end. This is what old
571 redisplay used to do. (Except in code for terminal frames, this
572 kludge is no longer use, I believe. --gerd).
574 See also start, end, displays_text_p and ends_at_zv_p for cleaner
575 ways to do it. The special meaning of positions 0 and -1 will be
576 removed some day, so don't use it in new code. */
577 struct glyph *glyphs[1 + LAST_AREA];
579 /* Number of glyphs actually filled in areas. */
580 short used[LAST_AREA];
582 /* Window-relative x and y-position of the top-left corner of this
583 row. If y < 0, this means that abs (y) pixels of the row are
584 invisible because it is partially visible at the top of a window.
585 If x < 0, this means that abs (x) pixels of the first glyph of
586 the text area of the row are invisible because the glyph is
587 partially visible. */
588 int x, y;
590 /* Width of the row in pixels without taking face extension at the
591 end of the row into account. */
592 int pixel_width;
594 /* Logical ascent/height of this line. The value of ascent is zero
595 and height is 1 on terminal frames. */
596 int ascent, height;
598 /* Physical ascent/height of this line. If max_ascent > ascent,
599 this line overlaps the line above it on the display. Otherwise,
600 if max_height > height, this line overlaps the line beneath it. */
601 int phys_ascent, phys_height;
603 /* Portion of row that is visible. Partially visible rows may be
604 found at the top and bottom of a window. This is 1 for tty
605 frames. It may be < 0 in case of completely invisible rows. */
606 int visible_height;
608 /* Hash code. This hash code is available as soon as the row
609 is constructed, i.e. after a call to display_line. */
610 unsigned hash;
612 /* First position in this row. This is the text position, including
613 overlay position information etc, where the display of this row
614 started, and can thus be less the position of the first glyph
615 (e.g. due to invisible text or horizontal scrolling). */
616 struct display_pos start;
618 /* Text position at the end of this row. This is the position after
619 the last glyph on this row. It can be greater than the last
620 glyph position + 1, due to truncation, invisible text etc. In an
621 up-to-date display, this should always be equal to the start
622 position of the next row. */
623 struct display_pos end;
625 /* In a desired matrix, 1 means that this row must be updated. In a
626 current matrix, 0 means that the row has been invalidated, i.e.
627 the row's contents do not agree with what is visible on the
628 screen. */
629 unsigned enabled_p : 1;
631 /* Display this line in inverse video? Used for the mode line and
632 menu bar lines. */
633 unsigned inverse_p : 1;
635 /* 1 means row displays a text line that is truncated on the left or
636 right side. */
637 unsigned truncated_on_left_p : 1;
638 unsigned truncated_on_right_p : 1;
640 /* 1 means the overlay arrow is on this line. */
641 unsigned overlay_arrow_p : 1;
643 /* 1 means that this row displays a continued line, i.e. it has a
644 continuation mark at the right side. */
645 unsigned continued_p : 1;
647 /* 0 means that this row does not contain any text, i.e. it is
648 a blank line at the window and buffer end. */
649 unsigned displays_text_p : 1;
651 /* 1 means that this line ends at ZV. */
652 unsigned ends_at_zv_p : 1;
654 /* 1 means the face of the last glyph in the text area is drawn to
655 the right end of the window. This flag is used in
656 update_text_area to optimize clearing to the end of the area. */
657 unsigned fill_line_p : 1;
659 /* Non-zero means display a bitmap on X frames indicating that this
660 line contains no text and ends in ZV. */
661 unsigned indicate_empty_line_p : 1;
663 /* 1 means this row contains glyphs that overlap each other because
664 of lbearing or rbearing. */
665 unsigned contains_overlapping_glyphs_p : 1;
667 /* 1 means this row is a wide as the window it is displayed in, including
668 scroll bars, bitmap areas, and internal borders. This also
669 implies that the row doesn't have marginal areas. */
670 unsigned full_width_p : 1;
672 /* Non-zero means row is a mode or top-line. */
673 unsigned mode_line_p : 1;
675 /* 1 in a current row means this row is overlapped by another row. */
676 unsigned overlapped_p : 1;
678 /* 1 means this line ends in the middle of a character consisting
679 of more than one glyph. Some glyphs have been put in this row,
680 the rest are put in rows below this one. */
681 unsigned ends_in_middle_of_char_p : 1;
683 /* 1 means this line starts in the middle of a character consisting
684 of more than one glyph. Some glyphs have been put in the
685 previoius row, the rest are put in this row. */
686 unsigned starts_in_middle_of_char_p : 1;
688 /* 1 in a current row means this row overlaps others. */
689 unsigned overlapping_p : 1;
691 /* 1 means some glyphs in this row are displayed in mouse-face. */
692 unsigned mouse_face_p : 1;
694 /* Continuation lines width at the start of the row. */
695 int continuation_lines_width;
699 /* Get a pointer to row number ROW in matrix MATRIX. If GLYPH_DEBUG
700 is defined to a non-zero value, the function matrix_row checks that
701 we don't try to access rows that are out of bounds. */
703 #if GLYPH_DEBUG
704 struct glyph_row *matrix_row P_ ((struct glyph_matrix *, int));
705 #define MATRIX_ROW(MATRIX, ROW) matrix_row ((MATRIX), (ROW))
706 #else
707 #define MATRIX_ROW(MATRIX, ROW) ((MATRIX)->rows + (ROW))
708 #endif
710 /* Return a pointer to the row reserved for the mode line in MATRIX.
711 Row MATRIX->nrows - 1 is always reserved for the mode line. */
713 #define MATRIX_MODE_LINE_ROW(MATRIX) \
714 ((MATRIX)->rows + (MATRIX)->nrows - 1)
716 /* Return a pointer to the row reserved for the top line in MATRIX.
717 This is always the first row in MATRIX because that's the only
718 way that works in frame-based redisplay. */
720 #define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows
722 /* Return a pointer to first row in MATRIX used for text display. */
724 #define MATRIX_FIRST_TEXT_ROW(MATRIX) \
725 ((MATRIX)->rows->mode_line_p ? (MATRIX)->rows + 1 : (MATRIX)->rows)
727 /* Return a pointer to the first glyph in the text area of a row.
728 MATRIX is the glyph matrix accessed, and ROW is the row index in
729 MATRIX. */
731 #define MATRIX_ROW_GLYPH_START(MATRIX, ROW) \
732 (MATRIX_ROW ((MATRIX), (ROW))->glyphs[TEXT_AREA])
734 /* Return the number of used glyphs in the text area of a row. */
736 #define MATRIX_ROW_USED(MATRIX, ROW) \
737 (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA])
739 /* Return the character/ byte position at which the display of ROW
740 starts. */
742 #define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->start.pos.charpos)
743 #define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->start.pos.bytepos)
745 /* Return character/ byte position at which ROW ends. */
747 #define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->end.pos.charpos)
748 #define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->end.pos.bytepos)
750 /* Return the vertical position of ROW in MATRIX. */
752 #define MATRIX_ROW_VPOS(ROW, MATRIX) ((ROW) - (MATRIX)->rows)
754 /* Return the last glyph row + 1 in MATRIX on window W reserved for
755 text. If W has a mode line, the last row in the matrix is reserved
756 for it. */
758 #define MATRIX_BOTTOM_TEXT_ROW(MATRIX, W) \
759 ((MATRIX)->rows \
760 + (MATRIX)->nrows \
761 - (WINDOW_WANTS_MODELINE_P ((W)) ? 1 : 0))
763 /* Non-zero if the face of the last glyph in ROW's text area has
764 to be drawn to the end of the text area. */
766 #define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)
768 /* Set and query the enabled_p flag of glyph row ROW in MATRIX. */
770 #define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
771 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0)
773 #define MATRIX_ROW_ENABLED_P(MATRIX, ROW) \
774 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p)
776 /* Non-zero if ROW displays text. Value is non-zero if the row is
777 blank but displays a line end. */
779 #define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)
781 /* Non-zero if ROW is not completely visible in window W. */
783 #define MATRIX_ROW_PARTIALLY_VISIBLE_P(ROW) \
784 ((ROW)->height != (ROW)->visible_height)
786 /* Non-zero if ROW is partially visible at the top of window W. */
788 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW) \
789 (MATRIX_ROW_PARTIALLY_VISIBLE_P ((ROW)) \
790 && (ROW)->y < WINDOW_DISPLAY_HEADER_LINE_HEIGHT ((W)))
792 /* Non-zero if ROW is partially visible at the bottom of window W. */
794 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW) \
795 (MATRIX_ROW_PARTIALLY_VISIBLE_P ((ROW)) \
796 && (ROW)->y + (ROW)->height > WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE ((W)))
798 /* Return the bottom Y + 1 of ROW. */
800 #define MATRIX_ROW_BOTTOM_Y(ROW) ((ROW)->y + (ROW)->height)
802 /* Is ROW the last visible one in the display described by the
803 iterator structure pointed to by IT?. */
805 #define MATRIX_ROW_LAST_VISIBLE_P(ROW, IT) \
806 (MATRIX_ROW_BOTTOM_Y ((ROW)) >= (IT)->last_visible_y)
808 /* Non-zero if ROW displays a continuation line. */
810 #define MATRIX_ROW_CONTINUATION_LINE_P(ROW) \
811 ((ROW)->continuation_lines_width > 0)
813 /* Non-zero if ROW ends in the middle of a character. This is the
814 case for continued lines showing only part of a display table entry
815 or a control char, or an overlay string. */
817 #define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW) \
818 ((ROW)->end.dpvec_index >= 0 \
819 || (ROW)->end.overlay_string_index >= 0 \
820 || (ROW)->ends_in_middle_of_char_p)
822 /* Non-zero if ROW ends in the middle of an overlay string. */
824 #define MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P(ROW) \
825 ((ROW)->end.overlay_string_index >= 0)
827 /* Non-zero if ROW starts in the middle of a character. See above. */
829 #define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW) \
830 ((ROW)->start.dpvec_index >= 0 \
831 || (ROW)->starts_in_middle_of_char_p \
832 || ((ROW)->start.overlay_string_index >= 0 \
833 && (ROW)->start.string_pos.charpos > 0))
835 /* Non-zero means ROW overlaps its predecessor. */
837 #define MATRIX_ROW_OVERLAPS_PRED_P(ROW) \
838 ((ROW)->phys_ascent > (ROW)->ascent)
840 /* Non-zero means ROW overlaps its successor. */
842 #define MATRIX_ROW_OVERLAPS_SUCC_P(ROW) \
843 ((ROW)->phys_height - (ROW)->phys_ascent \
844 > (ROW)->height - (ROW)->ascent)
846 /* Non-zero means that fonts have been loaded since the last glyph
847 matrix adjustments. The function redisplay_internal adjusts glyph
848 matrices when this flag is non-zero. */
850 extern int fonts_changed_p;
852 /* A glyph for a space. */
854 extern struct glyph space_glyph;
856 /* Frame being updated by update_window/update_frame. */
858 extern struct frame *updating_frame;
860 /* Window being updated by update_window. This is non-null as long as
861 update_window has not finished, and null otherwise. It's role is
862 analogous to updating_frame. */
864 extern struct window *updated_window;
866 /* Glyph row and area updated by update_window_line. */
868 extern struct glyph_row *updated_row;
869 extern int updated_area;
871 /* Non-zero means reading single-character input with prompt so put
872 cursor on mini-buffer after the prompt. Positive means at end of
873 text in echo area; negative means at beginning of line. */
875 extern int cursor_in_echo_area;
877 /* Non-zero means last display completed. Zero means it was
878 preempted. */
880 extern int display_completed;
882 /* Non-zero means redisplay has been performed directly (see also
883 direct_output_for_insert and direct_output_forward_char), so that
884 no further updating has to be performed. The function
885 redisplay_internal checks this flag, and does nothing but reset it
886 to zero if it is non-zero. */
888 extern int redisplay_performed_directly_p;
890 /* A temporary storage area, including a row of glyphs. Initialized
891 in xdisp.c. Used for various purposes, as an example see
892 direct_output_for_insert. */
894 extern struct glyph_row scratch_glyph_row;
898 /************************************************************************
899 Display Dimensions
900 ************************************************************************/
902 /* Return the height of the mode line in glyph matrix MATRIX, or zero
903 if not known. This macro is called under circumstances where
904 MATRIX might not have been allocated yet. */
906 #define MATRIX_MODE_LINE_HEIGHT(MATRIX) \
907 ((MATRIX) && (MATRIX)->rows \
908 ? MATRIX_MODE_LINE_ROW (MATRIX)->height \
909 : 0)
911 /* Return the height of the top line in glyph matrix MATRIX, or zero
912 if not known. This macro is called under circumstances where
913 MATRIX might not have been allocated yet. */
915 #define MATRIX_HEADER_LINE_HEIGHT(MATRIX) \
916 ((MATRIX) && (MATRIX)->rows \
917 ? MATRIX_HEADER_LINE_ROW (MATRIX)->height \
918 : 0)
920 /* Return the current height of the mode line of window W. If not
921 known from current_mode_line_height, look at W's current glyph
922 matrix, or return a default based on the height of the font of the
923 face `mode-line'. */
925 #define CURRENT_MODE_LINE_HEIGHT(W) \
926 (current_mode_line_height >= 0 \
927 ? current_mode_line_height \
928 : (MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
929 ? MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
930 : estimate_mode_line_height (XFRAME ((W)->frame), \
931 MODE_LINE_FACE_ID)))
933 /* Return the current height of the top line of window W. If not
934 known from current_header_line_height, look at W's current glyph
935 matrix, or return an estimation based on the height of the font of
936 the face `header-line'. */
938 #define CURRENT_HEADER_LINE_HEIGHT(W) \
939 (current_header_line_height >= 0 \
940 ? current_header_line_height \
941 : (MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
942 ? MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
943 : estimate_mode_line_height (XFRAME ((W)->frame), \
944 HEADER_LINE_FACE_ID)))
946 /* Return the height of the desired mode line of window W. */
948 #define DESIRED_MODE_LINE_HEIGHT(W) \
949 MATRIX_MODE_LINE_HEIGHT ((W)->desired_matrix)
951 /* Return the height of the desired top line of window W. */
953 #define DESIRED_HEADER_LINE_HEIGHT(W) \
954 MATRIX_HEADER_LINE_HEIGHT ((W)->desired_matrix)
956 /* Like FRAME_INTERNAL_BORDER_WIDTH but checks whether frame F is a
957 window-system frame. */
959 #define FRAME_INTERNAL_BORDER_WIDTH_SAFE(F) \
960 (FRAME_WINDOW_P (F) ? FRAME_INTERNAL_BORDER_WIDTH (F) : 0)
962 /* Width of display region of window W. For terminal frames, this
963 equals the width of W since there are no vertical scroll bars. For
964 window system frames, the value has to be corrected by the pixel
965 width of vertical scroll bars, and bitmap areas. */
967 #define WINDOW_DISPLAY_PIXEL_WIDTH(W) \
968 (((XFASTINT ((W)->width) \
969 - FRAME_SCROLL_BAR_WIDTH (XFRAME (WINDOW_FRAME ((W)))) \
970 - FRAME_FLAGS_AREA_COLS (XFRAME (WINDOW_FRAME ((W))))) \
971 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))))
973 /* Height of the display region of W, including a mode line, if any. */
975 #define WINDOW_DISPLAY_PIXEL_HEIGHT(W) \
976 (XFASTINT ((W)->height) \
977 * CANON_Y_UNIT (XFRAME (WINDOW_FRAME ((W)))))
979 /* Height in pixels of the mode line. May be zero if W doesn't have a
980 mode line. */
982 #define WINDOW_DISPLAY_MODE_LINE_HEIGHT(W) \
983 (WINDOW_WANTS_MODELINE_P ((W)) \
984 ? CURRENT_MODE_LINE_HEIGHT (W) \
985 : 0)
987 /* Height in pixels of the top line. Zero if W doesn't have a top
988 line. */
990 #define WINDOW_DISPLAY_HEADER_LINE_HEIGHT(W) \
991 (WINDOW_WANTS_HEADER_LINE_P ((W)) \
992 ? CURRENT_HEADER_LINE_HEIGHT (W) \
993 : 0)
995 /* Pixel height of window W without mode line. */
997 #define WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE(W) \
998 (WINDOW_DISPLAY_PIXEL_HEIGHT ((W)) \
999 - WINDOW_DISPLAY_MODE_LINE_HEIGHT ((W)))
1001 /* Pixel height of window W without mode and top line. */
1003 #define WINDOW_DISPLAY_TEXT_HEIGHT(W) \
1004 (WINDOW_DISPLAY_PIXEL_HEIGHT ((W)) \
1005 - WINDOW_DISPLAY_MODE_LINE_HEIGHT ((W)) \
1006 - WINDOW_DISPLAY_HEADER_LINE_HEIGHT ((W)))
1008 /* Left edge of W in pixels relative to its frame. */
1010 #define WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X(W) \
1011 (FRAME_INTERNAL_BORDER_WIDTH_SAFE (XFRAME (WINDOW_FRAME ((W)))) \
1012 + (WINDOW_LEFT_MARGIN ((W)) \
1013 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))) \
1014 + FRAME_LEFT_FLAGS_AREA_WIDTH (XFRAME (WINDOW_FRAME ((W)))))
1016 /* Right edge of window W in pixels, relative to its frame. */
1018 #define WINDOW_DISPLAY_RIGHT_EDGE_PIXEL_X(W) \
1019 (WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X ((W)) \
1020 + WINDOW_DISPLAY_PIXEL_WIDTH ((W)))
1022 /* Top edge of W in pixels relative to its frame. */
1024 #define WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y(W) \
1025 (FRAME_INTERNAL_BORDER_WIDTH_SAFE (XFRAME (WINDOW_FRAME ((W)))) \
1026 + (XFASTINT ((W)->top) \
1027 * CANON_Y_UNIT (XFRAME (WINDOW_FRAME ((W))))))
1029 /* Bottom edge of window W relative to its frame. */
1031 #define WINDOW_DISPLAY_BOTTOM_EDGE_PIXEL_Y(W) \
1032 (WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y ((W)) \
1033 + WINDOW_DISPLAY_PIXEL_HEIGHT ((W)))
1035 /* Convert window W relative pixel X to frame pixel coordinates. */
1037 #define WINDOW_TO_FRAME_PIXEL_X(W, X) \
1038 ((X) + WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X ((W)))
1040 /* Convert window W relative pixel Y to frame pixel coordinates. */
1042 #define WINDOW_TO_FRAME_PIXEL_Y(W, Y) \
1043 ((Y) + WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y ((W)))
1045 /* Convert frame relative pixel X to window relative pixel X. */
1047 #define FRAME_TO_WINDOW_PIXEL_X(W, X) \
1048 ((X) - WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X ((W)))
1050 /* Convert frame relative pixel X to window relative pixel Y. */
1052 #define FRAME_TO_WINDOW_PIXEL_Y(W, Y) \
1053 ((Y) - WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y ((W)))
1055 /* Width of left margin area in pixels. */
1057 #define WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH(W) \
1058 (NILP ((W)->left_margin_width) \
1059 ? 0 \
1060 : (XINT ((W)->left_margin_width) \
1061 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))))
1063 /* Width of right marginal area in pixels. */
1065 #define WINDOW_DISPLAY_RIGHT_AREA_PIXEL_WIDTH(W) \
1066 (NILP ((W)->right_margin_width) \
1067 ? 0 \
1068 : (XINT ((W)->right_margin_width) \
1069 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))))
1071 /* Width of text area in pixels. */
1073 #define WINDOW_DISPLAY_TEXT_AREA_PIXEL_WIDTH(W) \
1074 (WINDOW_DISPLAY_PIXEL_WIDTH ((W)) \
1075 - WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)) \
1076 - WINDOW_DISPLAY_RIGHT_AREA_PIXEL_WIDTH ((W)))
1078 /* Convert a text area relative x-position in window W to frame X
1079 pixel coordinates. */
1081 #define WINDOW_TEXT_TO_FRAME_PIXEL_X(W, X) \
1082 (WINDOW_TO_FRAME_PIXEL_X ((W), (X)) \
1083 + WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)))
1085 /* Translate an x-position relative to AREA in window W to frame pixel
1086 coordinates. */
1088 #define WINDOW_AREA_TO_FRAME_PIXEL_X(W, AREA, X) \
1089 (WINDOW_TO_FRAME_PIXEL_X ((W), (X)) \
1090 + (((AREA) > LEFT_MARGIN_AREA) \
1091 ? WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)) \
1092 : 0) \
1093 + (((AREA) > TEXT_AREA) \
1094 ? WINDOW_DISPLAY_TEXT_AREA_PIXEL_WIDTH ((W)) \
1095 : 0))
1097 /* Return the pixel width of AREA in W. */
1099 #define WINDOW_AREA_PIXEL_WIDTH(W, AREA) \
1100 (((AREA) == TEXT_AREA) \
1101 ? WINDOW_DISPLAY_TEXT_AREA_PIXEL_WIDTH ((W)) \
1102 : (((AREA) == LEFT_MARGIN_AREA) \
1103 ? WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)) \
1104 : WINDOW_DISPLAY_RIGHT_AREA_PIXEL_WIDTH ((W))))
1106 /* Value is non-zero if window W has a mode line. */
1108 #define WINDOW_WANTS_MODELINE_P(W) \
1109 (!MINI_WINDOW_P (W) \
1110 && !(W)->pseudo_window_p \
1111 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME (W))) \
1112 && BUFFERP ((W)->buffer) \
1113 && !NILP (XBUFFER ((W)->buffer)->mode_line_format))
1115 /* Value is non-zero if window W wants a top line. */
1117 #define WINDOW_WANTS_HEADER_LINE_P(W) \
1118 (!MINI_WINDOW_P (W) \
1119 && !(W)->pseudo_window_p \
1120 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME (W))) \
1121 && BUFFERP ((W)->buffer) \
1122 && !NILP (XBUFFER ((W)->buffer)->header_line_format))
1125 /***********************************************************************
1126 Faces
1127 ***********************************************************************/
1129 /* Indices of face attributes in Lisp face vectors. Slot zero is the
1130 symbol `face'. */
1132 enum lface_attribute_index
1134 LFACE_FAMILY_INDEX = 1,
1135 LFACE_SWIDTH_INDEX,
1136 LFACE_HEIGHT_INDEX,
1137 LFACE_WEIGHT_INDEX,
1138 LFACE_SLANT_INDEX,
1139 LFACE_UNDERLINE_INDEX,
1140 LFACE_INVERSE_INDEX,
1141 LFACE_FOREGROUND_INDEX,
1142 LFACE_BACKGROUND_INDEX,
1143 LFACE_STIPPLE_INDEX,
1144 LFACE_OVERLINE_INDEX,
1145 LFACE_STRIKE_THROUGH_INDEX,
1146 LFACE_BOX_INDEX,
1147 LFACE_FONT_INDEX,
1148 LFACE_INHERIT_INDEX,
1149 LFACE_VECTOR_SIZE
1153 /* Box types of faces. */
1155 enum face_box_type
1157 /* No box around text. */
1158 FACE_NO_BOX,
1160 /* Simple box of specified width and color. Default width is 1, and
1161 default color is the foreground color of the face. */
1162 FACE_SIMPLE_BOX,
1164 /* Boxes with 3D shadows. Color equals the background color of the
1165 face. Width is specified. */
1166 FACE_RAISED_BOX,
1167 FACE_SUNKEN_BOX
1171 /* Structure describing a realized face.
1173 For each Lisp face, 0..N realized faces can exist for different
1174 frames and different charsets. Realized faces are built from Lisp
1175 faces and text properties/overlays by merging faces and adding
1176 unspecified attributes from the `default' face. */
1178 struct face
1180 /* The id of this face. The id equals the index of this face in the
1181 vector faces_by_id of its face cache. */
1182 int id;
1184 #ifdef HAVE_WINDOW_SYSTEM
1186 /* If non-zero, a GC we can use without modification to draw
1187 characters in this face. */
1188 GC gc;
1190 /* Font used for this face, or null if the font could not be loaded
1191 for some reason. This points to a `font' slot of a struct
1192 font_info, and we should not call XFreeFont on it because the
1193 font may still be used somewhere else. */
1194 XFontStruct *font;
1196 /* Background stipple or bitmap used for this face. */
1197 Pixmap stipple;
1199 #else /* not HAVE_WINDOW_SYSTEM */
1201 /* Dummy. */
1202 int stipple;
1204 #endif /* not HAVE_WINDOW_SYSTEM */
1206 /* Pixel value of foreground color for X frames. Color index
1207 for tty frames. */
1208 unsigned long foreground;
1210 /* Pixel value or color index of background color. */
1211 unsigned long background;
1213 /* Pixel value or color index of underline color. */
1214 unsigned long underline_color;
1216 /* Pixel value or color index of overlined, strike-through, or box
1217 color. */
1218 unsigned long overline_color;
1219 unsigned long strike_through_color;
1220 unsigned long box_color;
1222 /* The font's name. This points to a `name' of a font_info, and it
1223 must not be freed. */
1224 char *font_name;
1226 /* Font info ID for this face's font. An ID is stored here because
1227 pointers to font_info structures may change. The reason is that
1228 they are pointers into a font table vector that is itself
1229 reallocated. */
1230 int font_info_id;
1232 /* Fontset ID if this face uses a fontset, or -1. This is only >= 0
1233 if the face was realized for a composition sequence.
1234 Otherwise, a specific font is loaded from the set of fonts
1235 specified by the fontset given by the family attribute of the face. */
1236 int fontset;
1238 /* Pixmap width and height. */
1239 unsigned int pixmap_w, pixmap_h;
1241 /* Non-zero means characters in this face have a box that thickness
1242 around them. */
1243 int box_line_width;
1245 /* Type of box drawn. A value of FACE_NO_BOX means no box is drawn
1246 around text in this face. A value of FACE_SIMPLE_BOX means a box
1247 of width box_line_width is drawn in color box_color. A value of
1248 FACE_RAISED_BOX or FACE_SUNKEN_BOX means a 3D box is drawn with
1249 shadow colors derived from the background color of the face. */
1250 enum face_box_type box;
1252 /* If `box' above specifies a 3D type, 1 means use box_color for
1253 drawing shadows. */
1254 unsigned use_box_color_for_shadows_p : 1;
1256 /* The Lisp face attributes this face realizes. All attributes
1257 in this vector are non-nil. */
1258 Lisp_Object lface[LFACE_VECTOR_SIZE];
1260 /* The hash value of this face. */
1261 unsigned hash;
1263 /* The charset for which this face was realized if it was realized
1264 for use in multibyte text. If fontset >= 0, this is the charset
1265 of the first character of the composition sequence. A value of
1266 charset < 0 means the face was realized for use in unibyte text
1267 where the idea of Emacs charsets isn't applicable. */
1268 int charset;
1270 /* Non-zero if text in this face should be underlined, overlined,
1271 strike-through or have a box drawn around it. */
1272 unsigned underline_p : 1;
1273 unsigned overline_p : 1;
1274 unsigned strike_through_p : 1;
1276 /* 1 means that the colors specified for this face could not be
1277 loaded, and were replaced by default colors, so they shouldn't be
1278 freed. */
1279 unsigned foreground_defaulted_p : 1;
1280 unsigned background_defaulted_p : 1;
1282 /* 1 means that either no color is specified for underlining or that
1283 the the specified color couldn't be loaded. Use the foreground
1284 color when drawing in that case. */
1285 unsigned underline_defaulted_p : 1;
1287 /* 1 means that either no color is specified for the corresponding
1288 attribute or that the the specified color couldn't be loaded.
1289 Use the foreground color when drawing in that case. */
1290 unsigned overline_color_defaulted_p : 1;
1291 unsigned strike_through_color_defaulted_p : 1;
1292 unsigned box_color_defaulted_p : 1;
1294 /* TTY appearances. Blinking is not yet implemented. Colors are
1295 found in `lface' with empty color string meaning the default
1296 color of the TTY. */
1297 unsigned tty_bold_p : 1;
1298 unsigned tty_dim_p : 1;
1299 unsigned tty_underline_p : 1;
1300 unsigned tty_alt_charset_p : 1;
1301 unsigned tty_reverse_p : 1;
1302 unsigned tty_blinking_p : 1;
1304 /* Next and previous face in hash collision list of face cache. */
1305 struct face *next, *prev;
1307 /* If this face is for ASCII characters, this points this face
1308 itself. Otherwise, this points a face for ASCII characters. */
1309 struct face *ascii_face;
1313 /* Color index indicating that face uses a terminal's default color. */
1315 #define FACE_TTY_DEFAULT_COLOR ((unsigned long) -1)
1317 /* Color index indicating that face uses an unknown foreground color. */
1319 #define FACE_TTY_DEFAULT_FG_COLOR ((unsigned long) -2)
1321 /* Color index indicating that face uses an unsigned background color. */
1323 #define FACE_TTY_DEFAULT_BG_COLOR ((unsigned long) -3)
1325 /* Non-zero if FACE was realized for unibyte use. */
1327 #define FACE_UNIBYTE_P(FACE) ((FACE)->charset < 0)
1330 /* IDs of important faces known by the C face code. These are the IDs
1331 of the faces for CHARSET_ASCII. */
1333 enum face_id
1335 DEFAULT_FACE_ID,
1336 MODE_LINE_FACE_ID,
1337 TOOL_BAR_FACE_ID,
1338 BITMAP_AREA_FACE_ID,
1339 HEADER_LINE_FACE_ID,
1340 SCROLL_BAR_FACE_ID,
1341 BORDER_FACE_ID,
1342 CURSOR_FACE_ID,
1343 MOUSE_FACE_ID,
1344 MENU_FACE_ID,
1345 BASIC_FACE_ID_SENTINEL
1349 /* A cache of realized faces. Each frame has its own cache because
1350 Emacs allows different frame-local face definitions. */
1352 struct face_cache
1354 /* Hash table of cached realized faces. */
1355 struct face **buckets;
1357 /* Back-pointer to the frame this cache belongs to. */
1358 struct frame *f;
1360 /* A vector of faces so that faces can be referenced by an ID. */
1361 struct face **faces_by_id;
1363 /* The allocated size, and number of used slots of faces_by_id. */
1364 int size, used;
1368 /* Prepare face FACE for use on frame F. This must be called before
1369 using X resources of FACE. */
1371 #define PREPARE_FACE_FOR_DISPLAY(F, FACE) \
1372 if ((FACE)->gc == 0) \
1373 prepare_face_for_display ((F), (FACE)); \
1374 else \
1375 (void) 0
1377 /* Return a pointer to the face with ID on frame F, or null if such a
1378 face doesn't exist. */
1380 #define FACE_FROM_ID(F, ID) \
1381 (((unsigned) (ID) < FRAME_FACE_CACHE (F)->used) \
1382 ? FRAME_FACE_CACHE (F)->faces_by_id[ID] \
1383 : NULL)
1385 #ifdef HAVE_WINDOW_SYSTEM
1387 /* Non-zero if FACE is suitable for displaying character CHAR. */
1389 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) \
1390 (SINGLE_BYTE_CHAR_P (CHAR) \
1391 ? (FACE) == (FACE)->ascii_face \
1392 : face_suitable_for_char_p ((FACE), (CHAR)))
1394 /* Return the id of the realized face on frame F that is like the face
1395 with id ID but is suitable for displaying character CHAR.
1396 This macro is only meaningful for multibyte character CHAR. */
1398 #define FACE_FOR_CHAR(F, FACE, CHAR) \
1399 (SINGLE_BYTE_CHAR_P (CHAR) \
1400 ? (FACE)->ascii_face->id \
1401 : face_for_char ((F), (FACE), (CHAR)))
1403 #else /* not HAVE_WINDOW_SYSTEM */
1405 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) 1
1406 #define FACE_FOR_CHAR(F, FACE, CHAR) ((FACE)->id)
1408 #endif /* not HAVE_WINDOW_SYSTEM */
1410 /* Non-zero means face attributes have been changed since the last
1411 redisplay. Used in redisplay_internal. */
1413 extern int face_change_count;
1418 /***********************************************************************
1419 Display Iterator
1420 ***********************************************************************/
1422 /* Iteration over things to display in current_buffer or in a string.
1424 The iterator handles:
1426 1. Overlay strings (after-string, before-string).
1427 2. Face properties.
1428 3. Invisible text properties.
1429 4. Selective display.
1430 5. Translation of characters via display tables.
1431 6. Translation of control characters to the forms `\003' or `^C'.
1432 7. `glyph' and `space-width' properties.
1434 Iterators are initialized by calling init_iterator or one of the
1435 equivalent functions below. A call to get_next_display_element
1436 loads the iterator structure with information about what next to
1437 display. A call to set_iterator_to_next increments the iterator's
1438 position.
1440 Characters from overlay strings, display table entries or control
1441 character translations are returned one at a time. For example, if
1442 we have a text of `a\x01' where `a' has a display table definition
1443 of `cd' and the control character is displayed with a leading
1444 arrow, then the iterator will return:
1446 Call Return Source Call next
1447 -----------------------------------------------------------------
1448 next c display table move
1449 next d display table move
1450 next ^ control char move
1451 next A control char move
1453 The same mechanism is also used to return characters for ellipses
1454 displayed at the end of invisible text.
1456 CAVEAT: Under some circumstances, move_.* functions can be called
1457 asynchronously, e.g. when computing a buffer position from an x and
1458 y pixel position. This means that these functions and functions
1459 called from them SHOULD NOT USE xmalloc and alike. See also the
1460 comment at the start of xdisp.c. */
1462 /* Enumeration describing what kind of display element an iterator is
1463 loaded with after a call to get_next_display_element. */
1465 enum display_element_type
1467 /* A normal character. */
1468 IT_CHARACTER,
1470 /* A composition sequence. */
1471 IT_COMPOSITION,
1473 /* An image. */
1474 IT_IMAGE,
1476 /* A flexible width and height space. */
1477 IT_STRETCH,
1479 /* End of buffer or string. */
1480 IT_EOB,
1482 /* Truncation glyphs. Never returned by get_next_display_element.
1483 Used to get display information about truncation glyphs via
1484 produce_glyphs. */
1485 IT_TRUNCATION,
1487 /* Continuation glyphs. See the comment for IT_TRUNCATION. */
1488 IT_CONTINUATION
1492 /* An enumerator for each text property that has a meaning for display
1493 purposes. */
1495 enum prop_idx
1497 FONTIFIED_PROP_IDX,
1498 FACE_PROP_IDX,
1499 INVISIBLE_PROP_IDX,
1500 DISPLAY_PROP_IDX,
1501 COMPOSITION_PROP_IDX,
1503 /* Not a property. Used to indicate changes in overlays. */
1504 OVERLAY_PROP_IDX,
1506 /* Sentinel. */
1507 LAST_PROP_IDX
1511 struct it
1513 /* The window in which we iterate over current_buffer (or a string). */
1514 Lisp_Object window;
1515 struct window *w;
1517 /* The window's frame. */
1518 struct frame *f;
1520 /* Function to call to load this structure with the next display
1521 element. */
1522 int (* method) P_ ((struct it *it));
1524 /* The next position at which to check for face changes, invisible
1525 text, overlay strings, end of text etc., which see. */
1526 int stop_charpos;
1528 /* Maximum string or buffer position + 1. ZV when iterating over
1529 current_buffer. */
1530 int end_charpos;
1532 /* C string to iterate over. Non-null means get characters from
1533 this string, otherwise characters are read from current_buffer
1534 or it->string. */
1535 unsigned char *s;
1537 /* Number of characters in the string (s, or it->string) we iterate
1538 over. */
1539 int string_nchars;
1541 /* Start and end of a visible region; -1 if the region is not
1542 visible in the window. */
1543 int region_beg_charpos, region_end_charpos;
1545 /* Position at which redisplay end trigger functions should be run. */
1546 int redisplay_end_trigger_charpos;
1548 /* 1 means multibyte characters are enabled. */
1549 unsigned multibyte_p : 1;
1551 /* 1 means window has a mode line at its top. */
1552 unsigned header_line_p : 1;
1554 /* 1 means `string' is the value of a `display' property.
1555 Don't handle some `display' properties in these strings. */
1556 unsigned string_from_display_prop_p : 1;
1558 /* Display table in effect or null for none. */
1559 struct Lisp_Char_Table *dp;
1561 /* Current display table vector to return characters from and its
1562 end. dpvec null means we are not returning characters from a
1563 display table entry; current.dpvec_index gives the current index
1564 into dpvec. This same mechanism is also used to return
1565 characters from translated control characters, i.e. `\003' or
1566 `^C'. */
1567 Lisp_Object *dpvec, *dpend;
1569 /* Length in bytes of the char that filled dpvec. A value of zero
1570 means that no character such character is involved. */
1571 int dpvec_char_len;
1573 /* Face id of the iterator saved in case a glyph from dpvec contains
1574 a face. The face is restored when all glyphs from dpvec have
1575 been delivered. */
1576 int saved_face_id;
1578 /* Vector of glyphs for control character translation. The pointer
1579 dpvec is set to ctl_chars when a control character is translated.
1580 This vector is also used for incomplete multibyte character
1581 translation (e.g \222\244). Such a character is at most 3 bytes,
1582 thus we need at most 12 bytes here. */
1583 Lisp_Object ctl_chars[12];
1585 /* Current buffer or string position of the iterator, including
1586 position in overlay strings etc. */
1587 struct display_pos current;
1589 /* Vector of overlays to process. Overlay strings are processed
1590 OVERLAY_STRING_CHUNK_SIZE at a time. */
1591 #define OVERLAY_STRING_CHUNK_SIZE 3
1592 Lisp_Object overlay_strings[OVERLAY_STRING_CHUNK_SIZE];
1594 /* Total number of overlay strings to process. This can be >
1595 OVERLAY_STRING_CHUNK_SIZE. */
1596 int n_overlay_strings;
1598 /* If non-nil, a Lisp string being processed. If
1599 current.overlay_string_index >= 0, this is an overlay string from
1600 pos. */
1601 Lisp_Object string;
1603 /* Stack of saved values. New entries are pushed when we begin to
1604 process an overlay string or a string from a `glyph' property.
1605 Entries are popped when we return to deliver display elements
1606 from what we previously had. */
1607 struct iterator_stack_entry
1609 int stop_charpos;
1610 int face_id;
1611 Lisp_Object string;
1612 struct display_pos pos;
1613 int end_charpos;
1614 int string_nchars;
1615 enum glyph_row_area area;
1616 unsigned multibyte_p : 1;
1617 unsigned string_from_display_prop_p : 1;
1618 Lisp_Object space_width;
1619 short voffset;
1620 Lisp_Object font_height;
1622 stack[2];
1624 /* Stack pointer. */
1625 int sp;
1627 /* Setting of buffer-local variable selective-display-ellipsis. */
1628 unsigned selective_display_ellipsis_p : 1;
1630 /* 1 means control characters are translated into the form `^C'
1631 where the `^' can be replaced by a display table entry. */
1632 unsigned ctl_arrow_p : 1;
1634 /* -1 means selective display hides everything between a \r and the
1635 next newline; > 0 means hide lines indented more than that value. */
1636 int selective;
1638 /* An enumeration describing what the next display element is
1639 after a call to get_next_display_element. */
1640 enum display_element_type what;
1642 /* Face to use. */
1643 int face_id;
1645 /* Non-zero means that the current face has a box. */
1646 unsigned face_box_p : 1;
1648 /* Non-null means that the current character is the first in a run
1649 of characters with box face. */
1650 unsigned start_of_box_run_p : 1;
1652 /* Non-zero means that the current character is the last in a run
1653 of characters with box face. */
1654 unsigned end_of_box_run_p : 1;
1656 /* 1 means overlay strings at end_charpos have been processed. */
1657 unsigned overlay_strings_at_end_processed_p : 1;
1659 /* 1 means the actual glyph is not available in the current
1660 system. */
1661 unsigned glyph_not_available_p : 1;
1663 /* 1 means the next line in display_line continues a character
1664 consisting of more than one glyph, and some glyphs of this
1665 character have been put on the previous line. */
1666 unsigned starts_in_middle_of_char_p : 1;
1668 /* If 1, saved_face_id contains the id of the face in front of text
1669 skipped due to selective display. */
1670 unsigned face_before_selective_p : 1;
1672 /* The ID of the default face to use. One of DEFAULT_FACE_ID,
1673 MODE_LINE_FACE_ID, etc, depending on what we are displaying. */
1674 int base_face_id;
1676 /* If what == IT_CHARACTER, character and length in bytes. This is
1677 a character from a buffer or string. It may be different from
1678 the character displayed in case that
1679 unibyte_display_via_language_environment is set.
1681 If what == IT_COMPOSITION, the first component of a composition
1682 and length in bytes of the composition. */
1683 int c, len;
1685 /* If what == IT_COMPOSITION, identification number and length in
1686 chars of a composition. */
1687 int cmp_id, cmp_len;
1689 /* The character to display, possibly translated to multibyte
1690 if unibyte_display_via_language_environment is set. This
1691 is set after x_produce_glyphs has been called. */
1692 int char_to_display;
1694 /* If what == IT_IMAGE, the id of the image to display. */
1695 int image_id;
1697 /* Value of the `space-width' property, if any; nil if none. */
1698 Lisp_Object space_width;
1700 /* Computed from the value of the `raise' property. */
1701 short voffset;
1703 /* Value of the `height' property, if any; nil if none. */
1704 Lisp_Object font_height;
1706 /* Object and position where the current display element came from.
1707 Object can be a Lisp string in case the current display element
1708 comes from an overlay string, or it is buffer. Position is
1709 a position in object. */
1710 Lisp_Object object;
1711 struct text_pos position;
1713 /* 1 means lines are truncated. */
1714 unsigned truncate_lines_p : 1;
1716 /* Number of columns per \t. */
1717 short tab_width;
1719 /* Width in pixels of truncation and continuation glyphs. */
1720 short truncation_pixel_width, continuation_pixel_width;
1722 /* First and last visible x-position in the display area. If window
1723 is hscrolled by n columns, first_visible_x == n * CANON_X_UNIT
1724 (f), and last_visible_x == pixel width of W + first_visible_x. */
1725 int first_visible_x, last_visible_x;
1727 /* Last visible y-position + 1 in the display area without a mode
1728 line, if the window has one. */
1729 int last_visible_y;
1731 /* Additional space in pixels between lines (for window systems
1732 only.). */
1733 int extra_line_spacing;
1735 /* If non-null, glyphs are produced in glyph_row with each call to
1736 produce_glyphs. */
1737 struct glyph_row *glyph_row;
1739 /* The area of glyph_row to which glyphs are added. */
1740 enum glyph_row_area area;
1742 /* Number of glyphs needed for the last character requested via
1743 produce_glyphs. This is 1 except for tabs. */
1744 int nglyphs;
1746 /* Width of the display element in pixels. Result of
1747 produce_glyphs. */
1748 int pixel_width;
1750 /* Current, maximum logical, and maximum physical line height
1751 information. Result of produce_glyphs. */
1752 int ascent, descent, max_ascent, max_descent;
1753 int phys_ascent, phys_descent, max_phys_ascent, max_phys_descent;
1755 /* Current x pixel position within the display line. This value
1756 does not include the width of continuation lines in front of the
1757 line. The value of current_x is automatically incremented by
1758 pixel_width with each call to produce_glyphs. */
1759 int current_x;
1761 /* Accumulated width of continuation lines. If > 0, this means we
1762 are currently in a continuation line. This is initially zero and
1763 incremented/reset by display_line, move_it_to etc. */
1764 int continuation_lines_width;
1766 /* Current y-position. Automatically incremented by the height of
1767 glyph_row in move_it_to and display_line. */
1768 int current_y;
1770 /* Current vertical matrix position, or line number. Automatically
1771 incremented by move_it_to and display_line. */
1772 int vpos;
1774 /* Horizontal matrix position reached in move_it_in_display_line.
1775 Only set there, not in display_line. */
1776 int hpos;
1780 /* Access to positions of iterator IT. */
1782 #define IT_CHARPOS(IT) CHARPOS ((IT).current.pos)
1783 #define IT_BYTEPOS(IT) BYTEPOS ((IT).current.pos)
1784 #define IT_STRING_CHARPOS(IT) CHARPOS ((IT).current.string_pos)
1785 #define IT_STRING_BYTEPOS(IT) BYTEPOS ((IT).current.string_pos)
1787 /* Test if IT has reached the end of its buffer or string. This will
1788 only work after get_next_display_element has been called. */
1790 #define ITERATOR_AT_END_P(IT) ((IT)->what == IT_EOB)
1792 /* Non-zero means IT is at the end of a line. This is the case if it
1793 is either on a newline or on a carriage return and selective
1794 display hides the rest of the line. */
1796 #define ITERATOR_AT_END_OF_LINE_P(IT) \
1797 ((IT)->what == IT_CHARACTER \
1798 && ((IT)->c == '\n' \
1799 || ((IT)->c == '\r' && (IT)->selective)))
1801 /* Call produce_glyphs or produce_glyphs_hook, if set. Shortcut to
1802 avoid the function call overhead. */
1804 #define PRODUCE_GLYPHS(IT) \
1805 (rif \
1806 ? rif->produce_glyphs ((IT)) \
1807 : produce_glyphs ((IT)))
1809 /* Bit-flags indicating what operation move_it_to should perform. */
1811 enum move_operation_enum
1813 /* Stop if specified x-position is reached. */
1814 MOVE_TO_X = 0x01,
1816 /* Stop if specified y-position is reached. */
1817 MOVE_TO_Y = 0x02,
1819 /* Stop if specified vpos is reached. */
1820 MOVE_TO_VPOS = 0x04,
1822 /* Stop if specified buffer or string position is reached. */
1823 MOVE_TO_POS = 0x08
1828 /***********************************************************************
1829 Window-based redisplay interface
1830 ***********************************************************************/
1832 /* Structure used to describe runs of lines that must be scrolled. */
1834 struct run
1836 /* Source and destination y pixel position. */
1837 int desired_y, current_y;
1839 /* Source and destination vpos in matrix. */
1840 int desired_vpos, current_vpos;
1842 /* Height in pixels, number of glyph rows. */
1843 int height, nrows;
1847 /* Structure holding system-dependent interface functions needed
1848 for window-based redisplay. */
1850 struct redisplay_interface
1852 /* Produce glyphs/get display metrics for the display element IT is
1853 loaded with. */
1854 void (*produce_glyphs) P_ ((struct it *it));
1856 /* Write or insert LEN glyphs from STRING at the nominal output
1857 position. */
1858 void (*write_glyphs) P_ ((struct glyph *string, int len));
1859 void (*insert_glyphs) P_ ((struct glyph *start, int len));
1861 /* Clear from nominal output position to X. X < 0 means clear
1862 to right end of display. */
1863 void (*clear_end_of_line) P_ ((int x));
1865 /* Function to call to scroll the display as described by RUN on
1866 window W. */
1867 void (*scroll_run_hook) P_ ((struct window *w, struct run *run));
1869 /* Function to call after a line in a display has been completely
1870 updated. Used to draw truncation marks and alike. DESIRED_ROW
1871 is the desired row which has been updated. */
1872 void (*after_update_window_line_hook) P_ ((struct glyph_row *desired_row));
1874 /* Function to call before beginning to update window W in
1875 window-based redisplay. */
1876 void (*update_window_begin_hook) P_ ((struct window *w));
1878 /* Function to call after window W has been updated in window-based
1879 redisplay. CURSOR_ON_P non-zero means switch cursor on.
1880 MOUSE_FACE_OVERWRITTEN_P non-zero means that some lines in W
1881 that contained glyphs in mouse-face were overwritten, so we
1882 have to update the mouse hightlight. */
1883 void (*update_window_end_hook) P_ ((struct window *w, int cursor_on_p,
1884 int mouse_face_overwritten_p));
1886 /* Move cursor to row/column position VPOS/HPOS, pixel coordinates
1887 Y/X. HPOS/VPOS are window-relative row and column numbers and X/Y
1888 are window-relative pixel positions. */
1889 void (*cursor_to) P_ ((int vpos, int hpos, int y, int x));
1891 /* Flush the display of frame F. For X, this is XFlush. */
1892 void (*flush_display) P_ ((struct frame *f));
1894 /* Clear the mouse hightlight in window W, if there is any. */
1895 void (*clear_mouse_face) P_ ((struct window *w));
1897 /* Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
1898 frame F. */
1899 void (*get_glyph_overhangs) P_ ((struct glyph *glyph, struct frame *f,
1900 int *left, int *right));
1902 /* Fix the display of AREA of ROW in window W for overlapping rows.
1903 This function is called from redraw_overlapping_rows after
1904 desired rows have been made current. */
1905 void (*fix_overlapping_area) P_ ((struct window *w, struct glyph_row *row,
1906 enum glyph_row_area area));
1909 /* The current interface for window-based redisplay. */
1911 extern struct redisplay_interface *rif;
1913 /* Hook to call in estimate_mode_line_height. */
1915 extern int (* estimate_mode_line_height_hook) P_ ((struct frame *,
1916 enum face_id));
1919 /***********************************************************************
1920 Images
1921 ***********************************************************************/
1923 #ifdef HAVE_WINDOW_SYSTEM
1925 /* Structure forward declarations. */
1927 struct image;
1930 /* Each image format (JPEG, IIFF, ...) supported is described by
1931 a structure of the type below. */
1933 struct image_type
1935 /* A symbol uniquely identifying the image type, .e.g `jpeg'. */
1936 Lisp_Object *type;
1938 /* Check that SPEC is a valid image specification for the given
1939 image type. Value is non-zero if SPEC is valid. */
1940 int (* valid_p) P_ ((Lisp_Object spec));
1942 /* Load IMG which is used on frame F from information contained in
1943 IMG->spec. Value is non-zero if successful. */
1944 int (* load) P_ ((struct frame *f, struct image *img));
1946 /* Free resources of image IMG which is used on frame F. */
1947 void (* free) P_ ((struct frame *f, struct image *img));
1949 /* Next in list of all supported image types. */
1950 struct image_type *next;
1954 /* Structure describing an image. Specific image formats like XBM are
1955 converted into this form, so that display only has to deal with
1956 this type of image. */
1958 struct image
1960 /* The time in seconds at which the image was last displayed. Set
1961 in prepare_image_for_display. */
1962 unsigned long timestamp;
1964 /* Pixmaps of the image. */
1965 Pixmap pixmap, mask;
1967 /* Colors allocated for this image, if any. Allocated via xmalloc. */
1968 unsigned long *colors;
1969 int ncolors;
1971 /* Width and height of the image. */
1972 int width, height;
1974 /* These values are used for the rectangles displayed for images
1975 that can't be loaded. */
1976 #define DEFAULT_IMAGE_WIDTH 30
1977 #define DEFAULT_IMAGE_HEIGHT 30
1979 /* Percent of image height used as ascent. A value of
1980 CENTERED_IMAGE_ASCENT means draw center the image centered on the
1981 line. */
1982 int ascent;
1983 #define DEFAULT_IMAGE_ASCENT 50
1984 #define CENTERED_IMAGE_ASCENT -1
1986 /* Lisp specification of this image. */
1987 Lisp_Object spec;
1989 /* Relief to draw around the image. */
1990 int relief;
1992 /* Optional margin around the image. This includes the relief. */
1993 int margin;
1995 /* Reference to the type of the image. */
1996 struct image_type *type;
1998 /* 1 means that loading the image failed. Don't try again. */
1999 unsigned load_failed_p;
2001 /* A place for image types to store additional data. The member
2002 data.lisp_val is marked during GC, so it's safe to store Lisp data
2003 there. Image types should free this data when their `free'
2004 function is called. */
2005 struct
2007 int int_val;
2008 void *ptr_val;
2009 Lisp_Object lisp_val;
2010 } data;
2012 /* Hash value of image specification to speed up comparisons. */
2013 unsigned hash;
2015 /* Image id of this image. */
2016 int id;
2018 /* Hash collision chain. */
2019 struct image *next, *prev;
2023 /* Cache of images. Each frame has a cache. X frames with the same
2024 x_display_info share their caches. */
2026 struct image_cache
2028 /* Hash table of images. */
2029 struct image **buckets;
2031 /* Vector mapping image ids to images. */
2032 struct image **images;
2034 /* Allocated size of `images'. */
2035 unsigned size;
2037 /* Number of images in the cache. */
2038 unsigned used;
2040 /* Reference count (number of frames sharing this cache). */
2041 int refcount;
2045 /* Value is a pointer to the image with id ID on frame F, or null if
2046 no image with that id exists. */
2048 #define IMAGE_FROM_ID(F, ID) \
2049 (((ID) >= 0 && (ID) < (FRAME_X_IMAGE_CACHE (F)->used)) \
2050 ? FRAME_X_IMAGE_CACHE (F)->images[ID] \
2051 : NULL)
2053 /* Size of bucket vector of image caches. Should be prime. */
2055 #define IMAGE_CACHE_BUCKETS_SIZE 1001
2057 #endif /* HAVE_WINDOW_SYSTEM */
2061 /***********************************************************************
2062 Tool-bars
2063 ***********************************************************************/
2065 /* Enumeration defining where to find tool-bar item information in
2066 tool-bar items vectors stored with frames. Each tool-bar item
2067 occupies TOOL_BAR_ITEM_NSLOTS elements in such a vector. */
2069 enum tool_bar_item_idx
2071 /* The key of the tool-bar item. Used to remove items when a binding
2072 for `undefined' is found. */
2073 TOOL_BAR_ITEM_KEY,
2075 /* Non-nil if item is enabled. */
2076 TOOL_BAR_ITEM_ENABLED_P,
2078 /* Non-nil if item is selected (pressed). */
2079 TOOL_BAR_ITEM_SELECTED_P,
2081 /* Caption. */
2082 TOOL_BAR_ITEM_CAPTION,
2084 /* Image(s) to display. This is either a single image specification
2085 or a vector of specifications. */
2086 TOOL_BAR_ITEM_IMAGES,
2088 /* The binding. */
2089 TOOL_BAR_ITEM_BINDING,
2091 /* Button type. One of nil, `:radio' or `:toggle'. */
2092 TOOL_BAR_ITEM_TYPE,
2094 /* Help string. */
2095 TOOL_BAR_ITEM_HELP,
2097 /* Sentinel = number of slots in tool_bar_items occupied by one
2098 tool-bar item. */
2099 TOOL_BAR_ITEM_NSLOTS
2103 /* An enumeration for the different images that can be specified
2104 for a tool-bar item. */
2106 enum tool_bar_item_image
2108 TOOL_BAR_IMAGE_ENABLED_SELECTED,
2109 TOOL_BAR_IMAGE_ENABLED_DESELECTED,
2110 TOOL_BAR_IMAGE_DISABLED_SELECTED,
2111 TOOL_BAR_IMAGE_DISABLED_DESELECTED
2114 /* Non-zero means raise tool-bar buttons when the mouse moves over them. */
2116 extern int auto_raise_tool_bar_buttons_p;
2118 /* Margin around tool-bar buttons in pixels. */
2120 extern int tool_bar_button_margin;
2122 /* Thickness of relief to draw around tool-bar buttons. */
2124 extern int tool_bar_button_relief;
2128 /***********************************************************************
2129 Function Prototypes
2130 ***********************************************************************/
2132 /* Defined in xdisp.c */
2134 int display_prop_intangible_p P_ ((Lisp_Object));
2135 void resize_echo_area_axactly P_ ((void));
2136 int resize_mini_window P_ ((struct window *, int));
2137 int try_window P_ ((Lisp_Object, struct text_pos));
2138 void window_box P_ ((struct window *, int, int *, int *, int *, int *));
2139 int window_box_height P_ ((struct window *));
2140 int window_text_bottom_y P_ ((struct window *));
2141 int window_box_width P_ ((struct window *, int));
2142 int window_box_left P_ ((struct window *, int));
2143 int window_box_right P_ ((struct window *, int));
2144 void window_box_edges P_ ((struct window *, int, int *, int *, int *, int *));
2145 void mark_window_display_accurate P_ ((Lisp_Object, int));
2146 void redisplay_preserve_echo_area P_ ((void));
2147 void set_cursor_from_row P_ ((struct window *, struct glyph_row *,
2148 struct glyph_matrix *, int, int, int, int));
2149 void init_iterator P_ ((struct it *, struct window *, int,
2150 int, struct glyph_row *, enum face_id));
2151 void init_iterator_to_row_start P_ ((struct it *, struct window *,
2152 struct glyph_row *));
2153 int get_next_display_element P_ ((struct it *));
2154 void set_iterator_to_next P_ ((struct it *, int));
2155 void produce_glyphs P_ ((struct it *));
2156 void produce_special_glyphs P_ ((struct it *, enum display_element_type));
2157 void start_display P_ ((struct it *, struct window *, struct text_pos));
2158 void move_it_to P_ ((struct it *, int, int, int, int, int));
2159 void move_it_vertically P_ ((struct it *, int));
2160 void move_it_by_lines P_ ((struct it *, int, int));
2161 int frame_mode_line_height P_ ((struct frame *));
2162 void highlight_trailing_whitespace P_ ((struct frame *, struct glyph_row *));
2163 int tool_bar_item_info P_ ((struct frame *, struct glyph *, int *));
2164 extern Lisp_Object Qtool_bar;
2165 extern Lisp_Object Vshow_trailing_whitespace;
2166 extern int redisplaying_p;
2167 extern Lisp_Object Vimage_types;
2168 extern void add_to_log P_ ((char *, Lisp_Object, Lisp_Object));
2169 extern int help_echo_showing_p;
2170 extern int current_mode_line_height, current_header_line_height;
2171 extern int cursor_in_non_selected_windows;
2173 /* Defined in sysdep.c */
2175 void get_frame_size P_ ((int *, int *));
2176 void request_sigio P_ ((void));
2177 void unrequest_sigio P_ ((void));
2178 int tabs_safe_p P_ ((void));
2179 void init_baud_rate P_ ((void));
2180 void init_sigio P_ ((int));
2182 /* Defined in xfaces.c */
2184 #ifdef USE_X_TOOLKIT
2185 void x_set_menu_resources_from_menu_face P_ ((struct frame *, Widget));
2186 #endif
2187 #ifdef HAVE_X_WINDOWS
2188 void x_free_colors P_ ((struct frame *, unsigned long *, int));
2189 #endif
2191 void update_face_from_frame_parameter P_ ((struct frame *, Lisp_Object,
2192 Lisp_Object));
2193 Lisp_Object tty_color_name P_ ((struct frame *, int));
2194 void clear_face_cache P_ ((int));
2195 unsigned long load_color P_ ((struct frame *, struct face *, Lisp_Object,
2196 enum lface_attribute_index));
2197 void unload_color P_ ((struct frame *, unsigned long));
2198 int frame_update_line_height P_ ((struct frame *));
2199 int ascii_face_of_lisp_face P_ ((struct frame *, int));
2200 void prepare_face_for_display P_ ((struct frame *, struct face *));
2201 int xstricmp P_ ((unsigned char *, unsigned char *));
2202 int lookup_face P_ ((struct frame *, Lisp_Object *, int, struct face *));
2203 int lookup_named_face P_ ((struct frame *, Lisp_Object, int));
2204 int smaller_face P_ ((struct frame *, int, int));
2205 int face_with_height P_ ((struct frame *, int, int));
2206 int lookup_derived_face P_ ((struct frame *, Lisp_Object, int, int));
2207 void init_frame_faces P_ ((struct frame *));
2208 void free_frame_faces P_ ((struct frame *));
2209 void recompute_basic_faces P_ ((struct frame *));
2210 int face_at_buffer_position P_ ((struct window *, int, int, int, int *,
2211 int, int));
2212 int face_at_string_position P_ ((struct window *, Lisp_Object,
2213 int, int, int, int, int *, enum face_id));
2214 int compute_char_face P_ ((struct frame *, int, Lisp_Object));
2215 void free_all_realized_faces P_ ((Lisp_Object));
2216 extern Lisp_Object Qforeground_color, Qbackground_color;
2217 extern char unspecified_fg[], unspecified_bg[];
2218 void free_realized_multibyte_face P_ ((struct frame *, int));
2220 /* Defined in xfns.c */
2222 #ifdef HAVE_X_WINDOWS
2223 void gamma_correct P_ ((struct frame *, XColor *));
2224 #endif
2225 #ifdef WINDOWSNT
2226 void gamma_correct P_ ((struct frame *, COLORREF *));
2227 #endif
2229 #ifdef HAVE_WINDOW_SYSTEM
2231 void x_kill_gs_process P_ ((Pixmap, struct frame *));
2232 int x_screen_planes P_ ((struct frame *));
2233 void x_implicitly_set_name P_ ((struct frame *, Lisp_Object, Lisp_Object));
2234 struct image_cache *make_image_cache P_ ((void));
2235 void free_image_cache P_ ((struct frame *));
2236 void clear_image_cache P_ ((struct frame *, int));
2237 void forall_images_in_image_cache P_ ((struct frame *,
2238 void (*) P_ ((struct image *))));
2239 int valid_image_p P_ ((Lisp_Object));
2240 void prepare_image_for_display P_ ((struct frame *, struct image *));
2241 int lookup_image P_ ((struct frame *, Lisp_Object));
2242 extern Lisp_Object tip_frame;
2243 extern Window tip_window;
2244 EXFUN (Fx_show_tip, 6);
2245 EXFUN (Fx_hide_tip, 0);
2246 extern void start_busy_cursor P_ ((void));
2247 extern void cancel_busy_cursor P_ ((void));
2248 extern int display_busy_cursor_p;
2250 #endif /* HAVE_WINDOW_SYSTEM */
2253 /* Defined in xmenu.c */
2255 int popup_activated P_ ((void));
2257 /* Defined in dispnew.c */
2259 int estimate_mode_line_height P_ ((struct frame *, enum face_id));
2260 Lisp_Object mode_line_string P_ ((struct window *, int, int, int, int *));
2261 extern void redraw_frame P_ ((struct frame *));
2262 extern void redraw_garbaged_frames P_ ((void));
2263 extern void cancel_line P_ ((int, struct frame *));
2264 extern void init_desired_glyphs P_ ((struct frame *));
2265 extern int scroll_frame_lines P_ ((struct frame *, int, int, int, int));
2266 extern int direct_output_for_insert P_ ((int));
2267 extern int direct_output_forward_char P_ ((int));
2268 extern int update_frame P_ ((struct frame *, int, int));
2269 extern int scrolling P_ ((struct frame *));
2270 extern void bitch_at_user P_ ((void));
2271 void adjust_glyphs P_ ((struct frame *));
2272 void free_glyphs P_ ((struct frame *));
2273 void free_window_matrices P_ ((struct window *));
2274 void check_glyph_memory P_ ((void));
2275 void mirrored_line_dance P_ ((struct glyph_matrix *, int, int, int *, char *));
2276 void clear_glyph_matrix P_ ((struct glyph_matrix *));
2277 void clear_current_matrices P_ ((struct frame *f));
2278 void clear_desired_matrices P_ ((struct frame *));
2279 void shift_glyph_matrix P_ ((struct window *, struct glyph_matrix *,
2280 int, int, int));
2281 void rotate_matrix P_ ((struct glyph_matrix *, int, int, int));
2282 void increment_matrix_positions P_ ((struct glyph_matrix *,
2283 int, int, int, int));
2284 void blank_row P_ ((struct window *, struct glyph_row *, int));
2285 void increment_row_positions P_ ((struct glyph_row *, int, int));
2286 void enable_glyph_matrix_rows P_ ((struct glyph_matrix *, int, int, int));
2287 void clear_glyph_row P_ ((struct glyph_row *));
2288 void prepare_desired_row P_ ((struct glyph_row *));
2289 int line_hash_code P_ ((struct glyph_row *));
2290 void set_window_update_flags P_ ((struct window *, int));
2291 void write_glyphs P_ ((struct glyph *, int));
2292 void insert_glyphs P_ ((struct glyph *, int));
2293 void redraw_frame P_ ((struct frame *));
2294 void redraw_garbaged_frames P_ ((void));
2295 int scroll_cost P_ ((struct frame *, int, int, int));
2296 int direct_output_for_insert P_ ((int));
2297 int direct_output_forward_char P_ ((int));
2298 int update_frame P_ ((struct frame *, int, int));
2299 void update_single_window P_ ((struct window *, int));
2300 int scrolling P_ ((struct frame *));
2301 int buffer_posn_from_coords P_ ((struct window *, int *, int *));
2302 void do_pending_window_change P_ ((int));
2303 void change_frame_size P_ ((struct frame *, int, int, int, int, int));
2304 void bitch_at_user P_ ((void));
2305 Lisp_Object sit_for P_ ((int, int, int, int, int));
2306 void init_display P_ ((void));
2307 void syms_of_display P_ ((void));
2308 extern Lisp_Object Qredisplay_dont_pause;
2310 /* Defined in term.c */
2312 extern void ring_bell P_ ((void));
2313 extern void set_terminal_modes P_ ((void));
2314 extern void reset_terminal_modes P_ ((void));
2315 extern void update_begin P_ ((struct frame *));
2316 extern void update_end P_ ((struct frame *));
2317 extern void set_terminal_window P_ ((int));
2318 extern void set_scroll_region P_ ((int, int));
2319 extern void turn_off_insert P_ ((void));
2320 extern void turn_off_highlight P_ ((void));
2321 extern void background_highlight P_ ((void));
2322 extern void reassert_line_highlight P_ ((int, int));
2323 extern void clear_frame P_ ((void));
2324 extern void clear_end_of_line P_ ((int));
2325 extern void clear_end_of_line_raw P_ ((int));
2326 extern void delete_glyphs P_ ((int));
2327 extern void ins_del_lines P_ ((int, int));
2328 extern int string_cost P_ ((char *));
2329 extern int per_line_cost P_ ((char *));
2330 extern void calculate_costs P_ ((struct frame *));
2331 extern void term_init P_ ((char *));
2332 extern void fatal P_ ((/* char *, ... */));
2333 void cursor_to P_ ((int, int));
2334 void change_line_highlight P_ ((int, int, int, int));
2336 /* Defined in scroll.c */
2338 extern int scrolling_max_lines_saved P_ ((int, int, int *, int *, int *));
2339 extern int scroll_cost P_ ((struct frame *, int, int, int));
2340 extern void do_line_insertion_deletion_costs P_ ((struct frame *, char *,
2341 char *, char *, char *,
2342 char *, char *, int));
2343 void scrolling_1 P_ ((struct frame *, int, int, int, int *, int *, int *,
2344 int *, int));
2346 #endif /* not DISPEXTERN_H_INCLUDED */