*** empty log message ***
[emacs.git] / src / dispextern.h
blob4f41244cf13f69a8d9c36f1b7d2355f76e4289a8
1 /* Interface definitions for display code.
2 Copyright (C) 1985, 1993, 1994, 1997, 1998, 1999
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@acm.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 "macterm.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, window_top_y is the
476 top-most y-position and window_height is the height of the
477 window, and window_vscroll is the vscroll at the time the matrix
478 was last adjusted. Only set for window-based redisplay. */
479 int window_top_y, window_height, window_width, window_vscroll;
481 /* Number of glyphs reserved for left and right marginal areas when
482 the matrix was last adjusted. */
483 int left_margin_glyphs, right_margin_glyphs;
485 /* Flag indicating that scrolling should not be tried in
486 update_window. This flag is set by functions like try_window_id
487 which do their own scrolling. */
488 unsigned no_scrolling_p : 1;
490 /* Non-zero means window displayed in this matrix has a top mode
491 line. */
492 unsigned header_line_p : 1;
494 #ifdef GLYPH_DEBUG
495 /* A string identifying the method used to display the matrix. */
496 char method[512];
497 #endif
499 /* The buffer this matrix displays. Set in redisplay_internal. */
500 struct buffer *buffer;
502 /* Values of BEGV and ZV as of last redisplay. */
503 int begv, zv;
507 /* Check that glyph pointers stored in glyph rows of MATRIX are okay.
508 This aborts if any pointer is found twice. */
510 #if GLYPH_DEBUG
511 void check_matrix_pointer_lossage P_ ((struct glyph_matrix *));
512 #define CHECK_MATRIX(MATRIX) check_matrix_pointer_lossage ((MATRIX))
513 #else
514 #define CHECK_MATRIX(MATRIX) (void) 0
515 #endif
519 /***********************************************************************
520 Glyph Rows
521 ***********************************************************************/
523 /* Area in window glyph matrix. If values are added or removed, the
524 function mark_object in alloc.c has to be changed. */
526 enum glyph_row_area
528 LEFT_MARGIN_AREA,
529 TEXT_AREA,
530 RIGHT_MARGIN_AREA,
531 LAST_AREA
535 /* Rows of glyphs in a windows or frame glyph matrix.
537 Each row is partitioned into three areas. The start and end of
538 each area is recorded in a pointer as shown below.
540 +--------------------+-------------+---------------------+
541 | left margin area | text area | right margin area |
542 +--------------------+-------------+---------------------+
543 | | | |
544 glyphs[LEFT_MARGIN_AREA] glyphs[RIGHT_MARGIN_AREA]
546 glyphs[TEXT_AREA] |
547 glyphs[LAST_AREA]
549 Rows in frame matrices reference glyph memory allocated in a frame
550 glyph pool (see the description of struct glyph_pool). Rows in
551 window matrices on frames having frame matrices reference slices of
552 the glyphs of corresponding rows in the frame matrix.
554 Rows in window matrices on frames having no frame matrices point to
555 glyphs allocated from the heap via xmalloc;
556 glyphs[LEFT_MARGIN_AREA] is the start address of the allocated
557 glyph structure array. */
559 struct glyph_row
561 /* Pointers to beginnings of areas. The end of an area A is found at
562 A + 1 in the vector. The last element of the vector is the end
563 of the whole row.
565 Kludge alert: Even if used[TEXT_AREA] == 0, glyphs[TEXT_AREA][0]'s
566 position field is used. It is -1 if this row does not correspond
567 to any text; it is some buffer position if the row corresponds to
568 an empty display line that displays a line end. This is what old
569 redisplay used to do. (Except in code for terminal frames, this
570 kludge is no longer use, I believe. --gerd).
572 See also start, end, displays_text_p and ends_at_zv_p for cleaner
573 ways to do it. The special meaning of positions 0 and -1 will be
574 removed some day, so don't use it in new code. */
575 struct glyph *glyphs[1 + LAST_AREA];
577 /* Number of glyphs actually filled in areas. */
578 short used[LAST_AREA];
580 /* Window-relative x and y-position of the top-left corner of this
581 row. If y < 0, this means that abs (y) pixels of the row are
582 invisible because it is partially visible at the top of a window.
583 If x < 0, this means that abs (x) pixels of the first glyph of
584 the text area of the row are invisible because the glyph is
585 partially visible. */
586 int x, y;
588 /* Width of the row in pixels without taking face extension at the
589 end of the row into account. */
590 int pixel_width;
592 /* Logical ascent/height of this line. The value of ascent is zero
593 and height is 1 on terminal frames. */
594 int ascent, height;
596 /* Physical ascent/height of this line. If max_ascent > ascent,
597 this line overlaps the line above it on the display. Otherwise,
598 if max_height > height, this line overlaps the line beneath it. */
599 int phys_ascent, phys_height;
601 /* Portion of row that is visible. Partially visible rows may be
602 found at the top and bottom of a window. This is 1 for tty
603 frames. It may be < 0 in case of completely invisible rows. */
604 int visible_height;
606 /* Hash code. This hash code is available as soon as the row
607 is constructed, i.e. after a call to display_line. */
608 unsigned hash;
610 /* First position in this row. This is the text position, including
611 overlay position information etc, where the display of this row
612 started, and can thus be less the position of the first glyph
613 (e.g. due to invisible text or horizontal scrolling). */
614 struct display_pos start;
616 /* Text position at the end of this row. This is the position after
617 the last glyph on this row. It can be greater than the last
618 glyph position + 1, due to truncation, invisible text etc. In an
619 up-to-date display, this should always be equal to the start
620 position of the next row. */
621 struct display_pos end;
623 /* In a desired matrix, 1 means that this row must be updated. In a
624 current matrix, 0 means that the row has been invalidated, i.e.
625 the row's contents do not agree with what is visible on the
626 screen. */
627 unsigned enabled_p : 1;
629 /* Display this line in inverse video? Used for the mode line and
630 menu bar lines. */
631 unsigned inverse_p : 1;
633 /* 1 means row displays a text line that is truncated on the left or
634 right side. */
635 unsigned truncated_on_left_p : 1;
636 unsigned truncated_on_right_p : 1;
638 /* 1 means the overlay arrow is on this line. */
639 unsigned overlay_arrow_p : 1;
641 /* 1 means that this row displays a continued line, i.e. it has a
642 continuation mark at the right side. */
643 unsigned continued_p : 1;
645 /* 0 means that this row does not contain any text, i.e. it is
646 a blank line at the window and buffer end. */
647 unsigned displays_text_p : 1;
649 /* 1 means that this line ends at ZV. */
650 unsigned ends_at_zv_p : 1;
652 /* 1 means the face of the last glyph in the text area is drawn to
653 the right end of the window. This flag is used in
654 update_text_area to optimize clearing to the end of the area. */
655 unsigned fill_line_p : 1;
657 /* Non-zero means display a bitmap on X frames indicating that this
658 line contains no text and ends in ZV. */
659 unsigned indicate_empty_line_p : 1;
661 /* 1 means this row contains glyphs that overlap each other because
662 of lbearing or rbearing. */
663 unsigned contains_overlapping_glyphs_p : 1;
665 /* 1 means this row is a wide as the window it is displayed in, including
666 scroll bars, bitmap areas, and internal borders. This also
667 implies that the row doesn't have marginal areas. */
668 unsigned full_width_p : 1;
670 /* Non-zero means row is a mode or top-line. */
671 unsigned mode_line_p : 1;
673 /* 1 in a current row means this row is overlapped by another row. */
674 unsigned overlapped_p : 1;
676 /* 1 means this line ends in the middle of a character consisting
677 of more than one glyph. Some glyphs have been put in this row,
678 the rest are put in rows below this one. */
679 unsigned ends_in_middle_of_char_p : 1;
681 /* 1 means this line starts in the middle of a character consisting
682 of more than one glyph. Some glyphs have been put in the
683 previoius row, the rest are put in this row. */
684 unsigned starts_in_middle_of_char_p : 1;
686 /* 1 in a current row means this row overlaps others. */
687 unsigned overlapping_p : 1;
689 /* 1 means some glyphs in this row are displayed in mouse-face. */
690 unsigned mouse_face_p : 1;
692 /* Continuation lines width at the start of the row. */
693 int continuation_lines_width;
697 /* Get a pointer to row number ROW in matrix MATRIX. If GLYPH_DEBUG
698 is defined to a non-zero value, the function matrix_row checks that
699 we don't try to access rows that are out of bounds. */
701 #if GLYPH_DEBUG
702 struct glyph_row *matrix_row P_ ((struct glyph_matrix *, int));
703 #define MATRIX_ROW(MATRIX, ROW) matrix_row ((MATRIX), (ROW))
704 #else
705 #define MATRIX_ROW(MATRIX, ROW) ((MATRIX)->rows + (ROW))
706 #endif
708 /* Return a pointer to the row reserved for the mode line in MATRIX.
709 Row MATRIX->nrows - 1 is always reserved for the mode line. */
711 #define MATRIX_MODE_LINE_ROW(MATRIX) \
712 ((MATRIX)->rows + (MATRIX)->nrows - 1)
714 /* Return a pointer to the row reserved for the top line in MATRIX.
715 This is always the first row in MATRIX because that's the only
716 way that works in frame-based redisplay. */
718 #define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows
720 /* Return a pointer to first row in MATRIX used for text display. */
722 #define MATRIX_FIRST_TEXT_ROW(MATRIX) \
723 ((MATRIX)->rows->mode_line_p ? (MATRIX)->rows + 1 : (MATRIX)->rows)
725 /* Return a pointer to the first glyph in the text area of a row.
726 MATRIX is the glyph matrix accessed, and ROW is the row index in
727 MATRIX. */
729 #define MATRIX_ROW_GLYPH_START(MATRIX, ROW) \
730 (MATRIX_ROW ((MATRIX), (ROW))->glyphs[TEXT_AREA])
732 /* Return the number of used glyphs in the text area of a row. */
734 #define MATRIX_ROW_USED(MATRIX, ROW) \
735 (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA])
737 /* Return the character/ byte position at which the display of ROW
738 starts. */
740 #define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->start.pos.charpos)
741 #define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->start.pos.bytepos)
743 /* Return character/ byte position at which ROW ends. */
745 #define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->end.pos.charpos)
746 #define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->end.pos.bytepos)
748 /* Return the vertical position of ROW in MATRIX. */
750 #define MATRIX_ROW_VPOS(ROW, MATRIX) ((ROW) - (MATRIX)->rows)
752 /* Return the last glyph row + 1 in MATRIX on window W reserved for
753 text. If W has a mode line, the last row in the matrix is reserved
754 for it. */
756 #define MATRIX_BOTTOM_TEXT_ROW(MATRIX, W) \
757 ((MATRIX)->rows \
758 + (MATRIX)->nrows \
759 - (WINDOW_WANTS_MODELINE_P ((W)) ? 1 : 0))
761 /* Non-zero if the face of the last glyph in ROW's text area has
762 to be drawn to the end of the text area. */
764 #define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)
766 /* Set and query the enabled_p flag of glyph row ROW in MATRIX. */
768 #define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
769 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0)
771 #define MATRIX_ROW_ENABLED_P(MATRIX, ROW) \
772 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p)
774 /* Non-zero if ROW displays text. Value is non-zero if the row is
775 blank but displays a line end. */
777 #define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)
779 /* Non-zero if ROW is not completely visible in window W. */
781 #define MATRIX_ROW_PARTIALLY_VISIBLE_P(ROW) \
782 ((ROW)->height != (ROW)->visible_height)
784 /* Non-zero if ROW is partially visible at the top of window W. */
786 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW) \
787 (MATRIX_ROW_PARTIALLY_VISIBLE_P ((ROW)) \
788 && (ROW)->y < WINDOW_DISPLAY_HEADER_LINE_HEIGHT ((W)))
790 /* Non-zero if ROW is partially visible at the bottom of window W. */
792 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW) \
793 (MATRIX_ROW_PARTIALLY_VISIBLE_P ((ROW)) \
794 && (ROW)->y + (ROW)->height > WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE ((W)))
796 /* Return the bottom Y + 1 of ROW. */
798 #define MATRIX_ROW_BOTTOM_Y(ROW) ((ROW)->y + (ROW)->height)
800 /* Is ROW the last visible one in the display described by the
801 iterator structure pointed to by IT?. */
803 #define MATRIX_ROW_LAST_VISIBLE_P(ROW, IT) \
804 (MATRIX_ROW_BOTTOM_Y ((ROW)) >= (IT)->last_visible_y)
806 /* Non-zero if ROW displays a continuation line. */
808 #define MATRIX_ROW_CONTINUATION_LINE_P(ROW) \
809 ((ROW)->continuation_lines_width > 0)
811 /* Non-zero if ROW ends in the middle of a character. This is the
812 case for continued lines showing only part of a display table entry
813 or a control char, or an overlay string. */
815 #define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW) \
816 ((ROW)->end.dpvec_index >= 0 \
817 || (ROW)->end.overlay_string_index >= 0 \
818 || (ROW)->ends_in_middle_of_char_p)
820 /* Non-zero if ROW ends in the middle of an overlay string. */
822 #define MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P(ROW) \
823 ((ROW)->end.overlay_string_index >= 0)
825 /* Non-zero if ROW starts in the middle of a character. See above. */
827 #define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW) \
828 ((ROW)->start.dpvec_index >= 0 \
829 || (ROW)->starts_in_middle_of_char_p \
830 || ((ROW)->start.overlay_string_index >= 0 \
831 && (ROW)->start.string_pos.charpos > 0))
833 /* Non-zero means ROW overlaps its predecessor. */
835 #define MATRIX_ROW_OVERLAPS_PRED_P(ROW) \
836 ((ROW)->phys_ascent > (ROW)->ascent)
838 /* Non-zero means ROW overlaps its successor. */
840 #define MATRIX_ROW_OVERLAPS_SUCC_P(ROW) \
841 ((ROW)->phys_height - (ROW)->phys_ascent \
842 > (ROW)->height - (ROW)->ascent)
844 /* Non-zero means that fonts have been loaded since the last glyph
845 matrix adjustments. The function redisplay_internal adjusts glyph
846 matrices when this flag is non-zero. */
848 extern int fonts_changed_p;
850 /* A glyph for a space. */
852 extern struct glyph space_glyph;
854 /* Window being updated by update_window. This is non-null as long as
855 update_window has not finished, and null otherwise. It's role is
856 analogous to updating_frame. */
858 extern struct window *updated_window;
860 /* Glyph row and area updated by update_window_line. */
862 extern struct glyph_row *updated_row;
863 extern int updated_area;
865 /* Non-zero means reading single-character input with prompt so put
866 cursor on mini-buffer after the prompt. Positive means at end of
867 text in echo area; negative means at beginning of line. */
869 extern int cursor_in_echo_area;
871 /* Non-zero means last display completed. Zero means it was
872 preempted. */
874 extern int display_completed;
876 /* Non-zero means redisplay has been performed directly (see also
877 direct_output_for_insert and direct_output_forward_char), so that
878 no further updating has to be performed. The function
879 redisplay_internal checks this flag, and does nothing but reset it
880 to zero if it is non-zero. */
882 extern int redisplay_performed_directly_p;
884 /* A temporary storage area, including a row of glyphs. Initialized
885 in xdisp.c. Used for various purposes, as an example see
886 direct_output_for_insert. */
888 extern struct glyph_row scratch_glyph_row;
892 /************************************************************************
893 Display Dimensions
894 ************************************************************************/
896 /* Return the height of the mode line in glyph matrix MATRIX, or zero
897 if not known. This macro is called under circumstances where
898 MATRIX might not have been allocated yet. */
900 #define MATRIX_MODE_LINE_HEIGHT(MATRIX) \
901 ((MATRIX) && (MATRIX)->rows \
902 ? MATRIX_MODE_LINE_ROW (MATRIX)->height \
903 : 0)
905 /* Return the height of the top line in glyph matrix MATRIX, or zero
906 if not known. This macro is called under circumstances where
907 MATRIX might not have been allocated yet. */
909 #define MATRIX_HEADER_LINE_HEIGHT(MATRIX) \
910 ((MATRIX) && (MATRIX)->rows \
911 ? MATRIX_HEADER_LINE_ROW (MATRIX)->height \
912 : 0)
914 /* Return the current height of the mode line of window W. If not
915 known from W's current glyph matrix, return a default based on the
916 height of the font of the face `modeline'. */
918 #define CURRENT_MODE_LINE_HEIGHT(W) \
919 (MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
920 ? MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
921 : estimate_mode_line_height (XFRAME ((W)->frame), MODE_LINE_FACE_ID))
923 /* Return the current height of the top line of window W. If not
924 known from W's current glyph matrix, return an estimation based on
925 the height of the font of the face `top-line'. */
927 #define CURRENT_HEADER_LINE_HEIGHT(W) \
928 (MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
929 ? MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
930 : estimate_mode_line_height (XFRAME ((W)->frame), HEADER_LINE_FACE_ID))
932 /* Return the height of the desired mode line of window W. */
934 #define DESIRED_MODE_LINE_HEIGHT(W) \
935 MATRIX_MODE_LINE_HEIGHT ((W)->desired_matrix)
937 /* Return the height of the desired top line of window W. */
939 #define DESIRED_HEADER_LINE_HEIGHT(W) \
940 MATRIX_HEADER_LINE_HEIGHT ((W)->desired_matrix)
942 /* Like FRAME_INTERNAL_BORDER_WIDTH but checks whether frame F is a
943 window-system frame. */
945 #define FRAME_INTERNAL_BORDER_WIDTH_SAFE(F) \
946 (FRAME_WINDOW_P (F) ? FRAME_INTERNAL_BORDER_WIDTH (F) : 0)
948 /* Width of display region of window W. For terminal frames, this
949 equals the width of W since there are no vertical scroll bars. For
950 window system frames, the value has to be corrected by the pixel
951 width of vertical scroll bars, and bitmap areas. */
953 #define WINDOW_DISPLAY_PIXEL_WIDTH(W) \
954 (((XFASTINT ((W)->width) \
955 - FRAME_SCROLL_BAR_WIDTH (XFRAME (WINDOW_FRAME ((W)))) \
956 - FRAME_FLAGS_AREA_COLS (XFRAME (WINDOW_FRAME ((W))))) \
957 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))))
959 /* Height of the display region of W, including a mode line, if any. */
961 #define WINDOW_DISPLAY_PIXEL_HEIGHT(W) \
962 (XFASTINT ((W)->height) \
963 * CANON_Y_UNIT (XFRAME (WINDOW_FRAME ((W)))))
965 /* Height in pixels of the mode line. May be zero if W doesn't have a
966 mode line. */
968 #define WINDOW_DISPLAY_MODE_LINE_HEIGHT(W) \
969 (WINDOW_WANTS_MODELINE_P ((W)) \
970 ? CURRENT_MODE_LINE_HEIGHT (W) \
971 : 0)
973 /* Height in pixels of the top line. Zero if W doesn't have a top
974 line. */
976 #define WINDOW_DISPLAY_HEADER_LINE_HEIGHT(W) \
977 (WINDOW_WANTS_HEADER_LINE_P ((W)) \
978 ? CURRENT_HEADER_LINE_HEIGHT (W) \
979 : 0)
981 /* Pixel height of window W without mode line. */
983 #define WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE(W) \
984 (WINDOW_DISPLAY_PIXEL_HEIGHT ((W)) \
985 - WINDOW_DISPLAY_MODE_LINE_HEIGHT ((W)))
987 /* Pixel height of window W without mode and top line. */
989 #define WINDOW_DISPLAY_TEXT_HEIGHT(W) \
990 (WINDOW_DISPLAY_PIXEL_HEIGHT ((W)) \
991 - WINDOW_DISPLAY_MODE_LINE_HEIGHT ((W)) \
992 - WINDOW_DISPLAY_HEADER_LINE_HEIGHT ((W)))
994 /* Left edge of W in pixels relative to its frame. */
996 #define WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X(W) \
997 (FRAME_INTERNAL_BORDER_WIDTH_SAFE (XFRAME (WINDOW_FRAME ((W)))) \
998 + (WINDOW_LEFT_MARGIN ((W)) \
999 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))) \
1000 + FRAME_LEFT_FLAGS_AREA_WIDTH (XFRAME (WINDOW_FRAME ((W)))))
1002 /* Right edge of window W in pixels, relative to its frame. */
1004 #define WINDOW_DISPLAY_RIGHT_EDGE_PIXEL_X(W) \
1005 (WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X ((W)) \
1006 + WINDOW_DISPLAY_PIXEL_WIDTH ((W)))
1008 /* Top edge of W in pixels relative to its frame. */
1010 #define WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y(W) \
1011 (FRAME_INTERNAL_BORDER_WIDTH_SAFE (XFRAME (WINDOW_FRAME ((W)))) \
1012 + (XFASTINT ((W)->top) \
1013 * CANON_Y_UNIT (XFRAME (WINDOW_FRAME ((W))))))
1015 /* Bottom edge of window W relative to its frame. */
1017 #define WINDOW_DISPLAY_BOTTOM_EDGE_PIXEL_Y(W) \
1018 (WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y ((W)) \
1019 + WINDOW_DISPLAY_PIXEL_HEIGHT ((W)))
1021 /* Convert window W relative pixel X to frame pixel coordinates. */
1023 #define WINDOW_TO_FRAME_PIXEL_X(W, X) \
1024 ((X) + WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X ((W)))
1026 /* Convert window W relative pixel Y to frame pixel coordinates. */
1028 #define WINDOW_TO_FRAME_PIXEL_Y(W, Y) \
1029 ((Y) + WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y ((W)))
1031 /* Convert frame relative pixel X to window relative pixel X. */
1033 #define FRAME_TO_WINDOW_PIXEL_X(W, X) \
1034 ((X) - WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X ((W)))
1036 /* Convert frame relative pixel X to window relative pixel Y. */
1038 #define FRAME_TO_WINDOW_PIXEL_Y(W, Y) \
1039 ((Y) - WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y ((W)))
1041 /* Width of left margin area in pixels. */
1043 #define WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH(W) \
1044 (NILP ((W)->left_margin_width) \
1045 ? 0 \
1046 : (XINT ((W)->left_margin_width) \
1047 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))))
1049 /* Width of right marginal area in pixels. */
1051 #define WINDOW_DISPLAY_RIGHT_AREA_PIXEL_WIDTH(W) \
1052 (NILP ((W)->right_margin_width) \
1053 ? 0 \
1054 : (XINT ((W)->right_margin_width) \
1055 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))))
1057 /* Width of text area in pixels. */
1059 #define WINDOW_DISPLAY_TEXT_AREA_PIXEL_WIDTH(W) \
1060 (WINDOW_DISPLAY_PIXEL_WIDTH ((W)) \
1061 - WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)) \
1062 - WINDOW_DISPLAY_RIGHT_AREA_PIXEL_WIDTH ((W)))
1064 /* Convert a text area relative x-position in window W to frame X
1065 pixel coordinates. */
1067 #define WINDOW_TEXT_TO_FRAME_PIXEL_X(W, X) \
1068 (WINDOW_TO_FRAME_PIXEL_X ((W), (X)) \
1069 + WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)))
1071 /* Translate an x-position relative to AREA in window W to frame pixel
1072 coordinates. */
1074 #define WINDOW_AREA_TO_FRAME_PIXEL_X(W, AREA, X) \
1075 (WINDOW_TO_FRAME_PIXEL_X ((W), (X)) \
1076 + (((AREA) > LEFT_MARGIN_AREA) \
1077 ? WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)) \
1078 : 0) \
1079 + (((AREA) > TEXT_AREA) \
1080 ? WINDOW_DISPLAY_TEXT_AREA_PIXEL_WIDTH ((W)) \
1081 : 0))
1083 /* Return the pixel width of AREA in W. */
1085 #define WINDOW_AREA_PIXEL_WIDTH(W, AREA) \
1086 (((AREA) == TEXT_AREA) \
1087 ? WINDOW_DISPLAY_TEXT_AREA_PIXEL_WIDTH ((W)) \
1088 : (((AREA) == LEFT_MARGIN_AREA) \
1089 ? WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)) \
1090 : WINDOW_DISPLAY_RIGHT_AREA_PIXEL_WIDTH ((W))))
1092 /* Value is non-zero if window W has a mode line. */
1094 #define WINDOW_WANTS_MODELINE_P(W) \
1095 (!MINI_WINDOW_P (W) \
1096 && !(W)->pseudo_window_p \
1097 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME (W))) \
1098 && BUFFERP ((W)->buffer) \
1099 && !NILP (XBUFFER ((W)->buffer)->mode_line_format))
1101 /* Value is non-zero if window W wants a top line. */
1103 #define WINDOW_WANTS_HEADER_LINE_P(W) \
1104 (!MINI_WINDOW_P (W) \
1105 && !(W)->pseudo_window_p \
1106 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME (W))) \
1107 && BUFFERP ((W)->buffer) \
1108 && !NILP (XBUFFER ((W)->buffer)->header_line_format))
1111 /***********************************************************************
1112 Faces
1113 ***********************************************************************/
1115 /* Indices of face attributes in Lisp face vectors. Slot zero is the
1116 symbol `face'. */
1118 enum lface_attribute_index
1120 LFACE_FAMILY_INDEX = 1,
1121 LFACE_SWIDTH_INDEX,
1122 LFACE_HEIGHT_INDEX,
1123 LFACE_WEIGHT_INDEX,
1124 LFACE_SLANT_INDEX,
1125 LFACE_UNDERLINE_INDEX,
1126 LFACE_INVERSE_INDEX,
1127 LFACE_FOREGROUND_INDEX,
1128 LFACE_BACKGROUND_INDEX,
1129 LFACE_STIPPLE_INDEX,
1130 LFACE_OVERLINE_INDEX,
1131 LFACE_STRIKE_THROUGH_INDEX,
1132 LFACE_BOX_INDEX,
1133 LFACE_FONT_INDEX,
1134 LFACE_INHERIT_INDEX,
1135 LFACE_VECTOR_SIZE
1139 /* Box types of faces. */
1141 enum face_box_type
1143 /* No box around text. */
1144 FACE_NO_BOX,
1146 /* Simple box of specified width and color. Default width is 1, and
1147 default color is the foreground color of the face. */
1148 FACE_SIMPLE_BOX,
1150 /* Boxes with 3D shadows. Color equals the background color of the
1151 face. Width is specified. */
1152 FACE_RAISED_BOX,
1153 FACE_SUNKEN_BOX
1157 /* Structure describing a realized face.
1159 For each Lisp face, 0..N realized faces can exist for different
1160 frames and different charsets. Realized faces are built from Lisp
1161 faces and text properties/overlays by merging faces and adding
1162 unspecified attributes from the `default' face. */
1164 struct face
1166 /* The id of this face. The id equals the index of this face in the
1167 vector faces_by_id of its face cache. */
1168 int id;
1170 #ifdef HAVE_WINDOW_SYSTEM
1172 /* If non-zero, a GC we can use without modification to draw
1173 characters in this face. */
1174 GC gc;
1176 /* Font used for this face, or null if the font could not be loaded
1177 for some reason. This points to a `font' slot of a struct
1178 font_info, and we should not call XFreeFont on it because the
1179 font may still be used somewhere else. */
1180 XFontStruct *font;
1182 /* Background stipple or bitmap used for this face. */
1183 Pixmap stipple;
1185 #else /* not HAVE_WINDOW_SYSTEM */
1187 /* Dummy. */
1188 int stipple;
1190 #endif /* not HAVE_WINDOW_SYSTEM */
1192 /* Pixel value of foreground color for X frames. Color index
1193 for tty frames. */
1194 unsigned long foreground;
1196 /* Pixel value or color index of background color. */
1197 unsigned long background;
1199 /* Pixel value or color index of underline color. */
1200 unsigned long underline_color;
1202 /* Pixel value or color index of overlined, strike-through, or box
1203 color. */
1204 unsigned long overline_color;
1205 unsigned long strike_through_color;
1206 unsigned long box_color;
1208 /* The font's name. This points to a `name' of a font_info, and it
1209 must not be freed. */
1210 char *font_name;
1212 /* Font info ID for this face's font. An ID is stored here because
1213 pointers to font_info structures may change. The reason is that
1214 they are pointers into a font table vector that is itself
1215 reallocated. */
1216 int font_info_id;
1218 /* Fontset ID if this face uses a fontset, or -1. This is only >= 0
1219 if the face was realized for a composition sequence.
1220 Otherwise, a specific font is loaded from the set of fonts
1221 specified by the fontset given by the family attribute of the face. */
1222 int fontset;
1224 /* Pixmap width and height. */
1225 unsigned int pixmap_w, pixmap_h;
1227 /* Non-zero means characters in this face have a box that thickness
1228 around them. */
1229 int box_line_width;
1231 /* Type of box drawn. A value of FACE_NO_BOX means no box is drawn
1232 around text in this face. A value of FACE_SIMPLE_BOX means a box
1233 of width box_line_width is drawn in color box_color. A value of
1234 FACE_RAISED_BOX or FACE_SUNKEN_BOX means a 3D box is drawn with
1235 shadow colors derived from the background color of the face. */
1236 enum face_box_type box;
1238 /* If `box' above specifies a 3D type, 1 means use box_color for
1239 drawing shadows. */
1240 unsigned use_box_color_for_shadows_p : 1;
1242 /* The Lisp face attributes this face realizes. All attributes
1243 in this vector are non-nil. */
1244 Lisp_Object lface[LFACE_VECTOR_SIZE];
1246 /* The hash value of this face. */
1247 unsigned hash;
1249 /* The charset for which this face was realized if it was realized
1250 for use in multibyte text. If fontset >= 0, this is the charset
1251 of the first character of the composition sequence. A value of
1252 charset < 0 means the face was realized for use in unibyte text
1253 where the idea of Emacs charsets isn't applicable. */
1254 int charset;
1256 /* Non-zero if text in this face should be underlined, overlined,
1257 strike-through or have a box drawn around it. */
1258 unsigned underline_p : 1;
1259 unsigned overline_p : 1;
1260 unsigned strike_through_p : 1;
1262 /* 1 means that the colors specified for this face could not be
1263 loaded, and were replaced by default colors, so they shouldn't be
1264 freed. */
1265 unsigned foreground_defaulted_p : 1;
1266 unsigned background_defaulted_p : 1;
1268 /* 1 means that either no color is specified for underlining or that
1269 the the specified color couldn't be loaded. Use the foreground
1270 color when drawing in that case. */
1271 unsigned underline_defaulted_p : 1;
1273 /* 1 means that either no color is specified for the corresponding
1274 attribute or that the the specified color couldn't be loaded.
1275 Use the foreground color when drawing in that case. */
1276 unsigned overline_color_defaulted_p : 1;
1277 unsigned strike_through_color_defaulted_p : 1;
1278 unsigned box_color_defaulted_p : 1;
1280 /* TTY appearances. Blinking is not yet implemented. Colors are
1281 found in `lface' with empty color string meaning the default
1282 color of the TTY. */
1283 unsigned tty_bold_p : 1;
1284 unsigned tty_dim_p : 1;
1285 unsigned tty_underline_p : 1;
1286 unsigned tty_alt_charset_p : 1;
1287 unsigned tty_reverse_p : 1;
1288 unsigned tty_blinking_p : 1;
1290 /* Next and previous face in hash collision list of face cache. */
1291 struct face *next, *prev;
1293 /* If this face is for ASCII characters, this points this face
1294 itself. Otherwise, this points a face for ASCII characters. */
1295 struct face *ascii_face;
1299 /* Color index indicating that face uses a terminal's default color. */
1301 #define FACE_TTY_DEFAULT_COLOR ((unsigned long) -1)
1303 /* Color index indicating that face uses an unknown foreground color. */
1305 #define FACE_TTY_DEFAULT_FG_COLOR ((unsigned long) -2)
1307 /* Color index indicating that face uses an unsigned background color. */
1309 #define FACE_TTY_DEFAULT_BG_COLOR ((unsigned long) -3)
1311 /* Non-zero if FACE was realized for unibyte use. */
1313 #define FACE_UNIBYTE_P(FACE) ((FACE)->charset < 0)
1316 /* IDs of important faces known by the C face code. These are the IDs
1317 of the faces for CHARSET_ASCII. */
1319 enum face_id
1321 DEFAULT_FACE_ID,
1322 MODE_LINE_FACE_ID,
1323 TOOL_BAR_FACE_ID,
1324 BITMAP_AREA_FACE_ID,
1325 HEADER_LINE_FACE_ID,
1326 SCROLL_BAR_FACE_ID,
1327 BORDER_FACE_ID,
1328 CURSOR_FACE_ID,
1329 MOUSE_FACE_ID,
1330 MENU_FACE_ID,
1331 BASIC_FACE_ID_SENTINEL
1335 /* A cache of realized faces. Each frame has its own cache because
1336 Emacs allows different frame-local face definitions. */
1338 struct face_cache
1340 /* Hash table of cached realized faces. */
1341 struct face **buckets;
1343 /* Back-pointer to the frame this cache belongs to. */
1344 struct frame *f;
1346 /* A vector of faces so that faces can be referenced by an ID. */
1347 struct face **faces_by_id;
1349 /* The allocated size, and number of used slots of faces_by_id. */
1350 int size, used;
1354 /* Prepare face FACE for use on frame F. This must be called before
1355 using X resources of FACE. */
1357 #define PREPARE_FACE_FOR_DISPLAY(F, FACE) \
1358 if ((FACE)->gc == 0) \
1359 prepare_face_for_display ((F), (FACE)); \
1360 else \
1361 (void) 0
1363 /* Return a pointer to the face with ID on frame F, or null if such a
1364 face doesn't exist. */
1366 #define FACE_FROM_ID(F, ID) \
1367 (((unsigned) (ID) < FRAME_FACE_CACHE (F)->used) \
1368 ? FRAME_FACE_CACHE (F)->faces_by_id[ID] \
1369 : NULL)
1371 #ifdef HAVE_WINDOW_SYSTEM
1373 /* Non-zero if FACE is suitable for displaying character CHAR. */
1375 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) \
1376 (SINGLE_BYTE_CHAR_P (CHAR) \
1377 ? (FACE) == (FACE)->ascii_face \
1378 : face_suitable_for_char_p ((FACE), (CHAR)))
1380 /* Return the id of the realized face on frame F that is like the face
1381 with id ID but is suitable for displaying character CHAR.
1382 This macro is only meaningful for multibyte character CHAR. */
1384 #define FACE_FOR_CHAR(F, FACE, CHAR) \
1385 (SINGLE_BYTE_CHAR_P (CHAR) \
1386 ? (FACE)->ascii_face->id \
1387 : face_for_char ((F), (FACE), (CHAR)))
1389 #else /* not HAVE_WINDOW_SYSTEM */
1391 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) 1
1392 #define FACE_FOR_CHAR(F, FACE, CHAR) ((FACE)->id)
1394 #endif /* not HAVE_WINDOW_SYSTEM */
1396 /* Non-zero means face attributes have been changed since the last
1397 redisplay. Used in redisplay_internal. */
1399 extern int face_change_count;
1404 /***********************************************************************
1405 Display Iterator
1406 ***********************************************************************/
1408 /* Iteration over things to display in current_buffer or in a string.
1410 The iterator handles:
1412 1. Overlay strings (after-string, before-string).
1413 2. Face properties.
1414 3. Invisible text properties.
1415 4. Selective display.
1416 5. Translation of characters via display tables.
1417 6. Translation of control characters to the forms `\003' or `^C'.
1418 7. `glyph' and `space-width' properties.
1420 Iterators are initialized by calling init_iterator or one of the
1421 equivalent functions below. A call to get_next_display_element
1422 loads the iterator structure with information about what next to
1423 display. A call to set_iterator_to_next increments the iterator's
1424 position.
1426 Characters from overlay strings, display table entries or control
1427 character translations are returned one at a time. For example, if
1428 we have a text of `a\x01' where `a' has a display table definition
1429 of `cd' and the control character is displayed with a leading
1430 arrow, then the iterator will return:
1432 Call Return Source Call next
1433 -----------------------------------------------------------------
1434 next c display table move
1435 next d display table move
1436 next ^ control char move
1437 next A control char move
1439 The same mechanism is also used to return characters for ellipses
1440 displayed at the end of invisible text.
1442 CAVEAT: Under some circumstances, move_.* functions can be called
1443 asynchronously, e.g. when computing a buffer position from an x and
1444 y pixel position. This means that these functions and functions
1445 called from them SHOULD NOT USE xmalloc and alike. See also the
1446 comment at the start of xdisp.c. */
1448 /* Enumeration describing what kind of display element an iterator is
1449 loaded with after a call to get_next_display_element. */
1451 enum display_element_type
1453 /* A normal character. */
1454 IT_CHARACTER,
1456 /* A composition sequence. */
1457 IT_COMPOSITION,
1459 /* An image. */
1460 IT_IMAGE,
1462 /* A flexible width and height space. */
1463 IT_STRETCH,
1465 /* End of buffer or string. */
1466 IT_EOB,
1468 /* Truncation glyphs. Never returned by get_next_display_element.
1469 Used to get display information about truncation glyphs via
1470 produce_glyphs. */
1471 IT_TRUNCATION,
1473 /* Continuation glyphs. See the comment for IT_TRUNCATION. */
1474 IT_CONTINUATION
1478 /* An enumerator for each text property that has a meaning for display
1479 purposes. */
1481 enum prop_idx
1483 FONTIFIED_PROP_IDX,
1484 FACE_PROP_IDX,
1485 INVISIBLE_PROP_IDX,
1486 DISPLAY_PROP_IDX,
1487 COMPOSITION_PROP_IDX,
1489 /* Not a property. Used to indicate changes in overlays. */
1490 OVERLAY_PROP_IDX,
1492 /* Sentinel. */
1493 LAST_PROP_IDX
1497 struct it
1499 /* The window in which we iterate over current_buffer (or a string). */
1500 Lisp_Object window;
1501 struct window *w;
1503 /* The window's frame. */
1504 struct frame *f;
1506 /* Function to call to load this structure with the next display
1507 element. */
1508 int (* method) P_ ((struct it *it));
1510 /* The next position at which to check for face changes, invisible
1511 text, overlay strings, end of text etc., which see. */
1512 int stop_charpos;
1514 /* Maximum string or buffer position + 1. ZV when iterating over
1515 current_buffer. */
1516 int end_charpos;
1518 /* C string to iterate over. Non-null means get characters from
1519 this string, otherwise characters are read from current_buffer
1520 or it->string. */
1521 unsigned char *s;
1523 /* Number of characters in the string (s, or it->string) we iterate
1524 over. */
1525 int string_nchars;
1527 /* Start and end of a visible region; -1 if the region is not
1528 visible in the window. */
1529 int region_beg_charpos, region_end_charpos;
1531 /* Position at which redisplay end trigger functions should be run. */
1532 int redisplay_end_trigger_charpos;
1534 /* 1 means multibyte characters are enabled. */
1535 unsigned multibyte_p : 1;
1537 /* 1 means window has a mode line at its top. */
1538 unsigned header_line_p : 1;
1540 /* 1 means `string' is the value of a `display' property.
1541 Don't handle some `display' properties in these strings. */
1542 unsigned string_from_display_prop_p : 1;
1544 /* Display table in effect or null for none. */
1545 struct Lisp_Char_Table *dp;
1547 /* Current display table vector to return characters from and its
1548 end. dpvec null means we are not returning characters from a
1549 display table entry; current.dpvec_index gives the current index
1550 into dpvec. This same mechanism is also used to return
1551 characters from translated control characters, i.e. `\003' or
1552 `^C'. */
1553 Lisp_Object *dpvec, *dpend;
1555 /* Length in bytes of the char that filled dpvec. A value of zero
1556 means that no character such character is involved. */
1557 int dpvec_char_len;
1559 /* Face id of the iterator saved in case a glyph from dpvec contains
1560 a face. The face is restored when all glyphs from dpvec have
1561 been delivered. */
1562 int saved_face_id;
1564 /* Vector of glyphs for control character translation. The pointer
1565 dpvec is set to ctl_chars when a control character is translated.
1566 This vector is also used for incomplete multibyte character
1567 translation (e.g \222\244). Such a character is at most 3 bytes,
1568 thus we need at most 12 bytes here. */
1569 Lisp_Object ctl_chars[12];
1571 /* Current buffer or string position of the iterator, including
1572 position in overlay strings etc. */
1573 struct display_pos current;
1575 /* Vector of overlays to process. Overlay strings are processed
1576 OVERLAY_STRING_CHUNK_SIZE at a time. */
1577 #define OVERLAY_STRING_CHUNK_SIZE 3
1578 Lisp_Object overlay_strings[OVERLAY_STRING_CHUNK_SIZE];
1580 /* Total number of overlay strings to process. This can be >
1581 OVERLAY_STRING_CHUNK_SIZE. */
1582 int n_overlay_strings;
1584 /* If non-zero, an additional overlay start position to take overlay
1585 strings from. */
1586 int add_overlay_start;
1588 /* If non-nil, a Lisp string being processed. If
1589 current.overlay_string_index >= 0, this is an overlay string from
1590 pos. */
1591 Lisp_Object string;
1593 /* Stack of saved values. New entries are pushed when we begin to
1594 process an overlay string or a string from a `glyph' property.
1595 Entries are popped when we return to deliver display elements
1596 from what we previously had. */
1597 struct iterator_stack_entry
1599 int stop_charpos;
1600 int face_id;
1601 Lisp_Object string;
1602 struct display_pos pos;
1603 int end_charpos;
1604 int string_nchars;
1605 enum glyph_row_area area;
1606 unsigned multibyte_p : 1;
1607 unsigned string_from_display_prop_p : 1;
1608 Lisp_Object space_width;
1609 short voffset;
1610 Lisp_Object font_height;
1612 stack[2];
1614 /* Stack pointer. */
1615 int sp;
1617 /* Setting of buffer-local variable selective-display-ellipsis. */
1618 unsigned selective_display_ellipsis_p : 1;
1620 /* 1 means control characters are translated into the form `^C'
1621 where the `^' can be replaced by a display table entry. */
1622 unsigned ctl_arrow_p : 1;
1624 /* -1 means selective display hides everything between a \r and the
1625 next newline; > 0 means hide lines indented more than that value. */
1626 int selective;
1628 /* An enumeration describing what the next display element is
1629 after a call to get_next_display_element. */
1630 enum display_element_type what;
1632 /* Face to use. */
1633 int face_id;
1635 /* Non-zero means that the current face has a box. */
1636 unsigned face_box_p : 1;
1638 /* Non-null means that the current character is the first in a run
1639 of characters with box face. */
1640 unsigned start_of_box_run_p : 1;
1642 /* Non-zero means that the current character is the last in a run
1643 of characters with box face. */
1644 unsigned end_of_box_run_p : 1;
1646 /* 1 means overlay strings at end_charpos have been processed. */
1647 unsigned overlay_strings_at_end_processed_p : 1;
1649 /* 1 means the actual glyph is not available in the current
1650 system. */
1651 unsigned glyph_not_available_p : 1;
1653 /* 1 means the next line in display_line continues a character
1654 consisting of more than one glyph, and some glyphs of this
1655 character have been put on the previous line. */
1656 unsigned starts_in_middle_of_char_p : 1;
1658 /* The ID of the default face to use. One of DEFAULT_FACE_ID,
1659 MODE_LINE_FACE_ID, or TOOL_BAR_FACE_ID, depending on what we
1660 are displaying. */
1661 int base_face_id;
1663 /* If what == IT_CHARACTER, character and length in bytes. This is
1664 a character from a buffer or string. It may be different from
1665 the character displayed in case that
1666 unibyte_display_via_language_environment is set.
1668 If what == IT_COMPOSITION, the first component of a composition
1669 and length in bytes of the composition. */
1670 int c, len;
1672 /* If what == IT_COMPOSITION, identification number and length in
1673 chars of a composition. */
1674 int cmp_id, cmp_len;
1676 /* The character to display, possibly translated to multibyte
1677 if unibyte_display_via_language_environment is set. This
1678 is set after x_produce_glyphs has been called. */
1679 int char_to_display;
1681 /* If what == IT_IMAGE, the id of the image to display. */
1682 int image_id;
1684 /* Value of the `space-width' property, if any; nil if none. */
1685 Lisp_Object space_width;
1687 /* Computed from the value of the `raise' property. */
1688 short voffset;
1690 /* Value of the `height' property, if any; nil if none. */
1691 Lisp_Object font_height;
1693 /* Object and position where the current display element came from.
1694 Object can be a Lisp string in case the current display element
1695 comes from an overlay string, or it is buffer. Position is
1696 a position in object. */
1697 Lisp_Object object;
1698 struct text_pos position;
1700 /* 1 means lines are truncated. */
1701 unsigned truncate_lines_p : 1;
1703 /* Number of columns per \t. */
1704 short tab_width;
1706 /* Width in pixels of truncation and continuation glyphs. */
1707 short truncation_pixel_width, continuation_pixel_width;
1709 /* First and last visible x-position in the display area. If window
1710 is hscrolled by n columns, first_visible_x == n * CANON_X_UNIT
1711 (f), and last_visible_x == pixel width of W + first_visible_x. */
1712 int first_visible_x, last_visible_x;
1714 /* Last visible y-position + 1 in the display area without a mode
1715 line, if the window has one. */
1716 int last_visible_y;
1718 /* Additional space in pixels between lines (for window systems
1719 only.). */
1720 int extra_line_spacing;
1722 /* If non-null, glyphs are produced in glyph_row with each call to
1723 produce_glyphs. */
1724 struct glyph_row *glyph_row;
1726 /* The area of glyph_row to which glyphs are added. */
1727 enum glyph_row_area area;
1729 /* Number of glyphs needed for the last character requested via
1730 produce_glyphs. This is 1 except for tabs. */
1731 int nglyphs;
1733 /* Width of the display element in pixels. Result of
1734 produce_glyphs. */
1735 int pixel_width;
1737 /* Current, maximum logical, and maximum physical line height
1738 information. Result of produce_glyphs. */
1739 int ascent, descent, max_ascent, max_descent;
1740 int phys_ascent, phys_descent, max_phys_ascent, max_phys_descent;
1742 /* Current x pixel position within the display line. This value
1743 does not include the width of continuation lines in front of the
1744 line. The value of current_x is automatically incremented by
1745 pixel_width with each call to produce_glyphs. */
1746 int current_x;
1748 /* Accumulated width of continuation lines. If > 0, this means we
1749 are currently in a continuation line. This is initially zero and
1750 incremented/reset by display_line, move_it_to etc. */
1751 int continuation_lines_width;
1753 /* Current y-position. Automatically incremented by the height of
1754 glyph_row in move_it_to and display_line. */
1755 int current_y;
1757 /* Current vertical matrix position, or line number. Automatically
1758 incremented by move_it_to and display_line. */
1759 int vpos;
1761 /* Horizontal matrix position reached in move_it_in_display_line.
1762 Only set there, not in display_line. */
1763 int hpos;
1767 /* Access to positions of iterator IT. */
1769 #define IT_CHARPOS(IT) CHARPOS ((IT).current.pos)
1770 #define IT_BYTEPOS(IT) BYTEPOS ((IT).current.pos)
1771 #define IT_STRING_CHARPOS(IT) CHARPOS ((IT).current.string_pos)
1772 #define IT_STRING_BYTEPOS(IT) BYTEPOS ((IT).current.string_pos)
1774 /* Test if IT has reached the end of its buffer or string. This will
1775 only work after get_next_display_element has been called. */
1777 #define ITERATOR_AT_END_P(IT) ((IT)->what == IT_EOB)
1779 /* Non-zero means IT is at the end of a line. This is the case if it
1780 is either on a newline or on a carriage return and selective
1781 display hides the rest of the line. */
1783 #define ITERATOR_AT_END_OF_LINE_P(IT) \
1784 ((IT)->what == IT_CHARACTER \
1785 && ((IT)->c == '\n' \
1786 || ((IT)->c == '\r' && (IT)->selective)))
1788 /* Call produce_glyphs or produce_glyphs_hook, if set. Shortcut to
1789 avoid the function call overhead. */
1791 #define PRODUCE_GLYPHS(IT) \
1792 (rif \
1793 ? rif->produce_glyphs ((IT)) \
1794 : produce_glyphs ((IT)))
1796 /* Bit-flags indicating what operation move_it_to should perform. */
1798 enum move_operation_enum
1800 /* Stop if specified x-position is reached. */
1801 MOVE_TO_X = 0x01,
1803 /* Stop if specified y-position is reached. */
1804 MOVE_TO_Y = 0x02,
1806 /* Stop if specified vpos is reached. */
1807 MOVE_TO_VPOS = 0x04,
1809 /* Stop if specified buffer or string position is reached. */
1810 MOVE_TO_POS = 0x08
1815 /***********************************************************************
1816 Window-based redisplay interface
1817 ***********************************************************************/
1819 /* Structure used to describe runs of lines that must be scrolled. */
1821 struct run
1823 /* Source and destination y pixel position. */
1824 int desired_y, current_y;
1826 /* Source and destination vpos in matrix. */
1827 int desired_vpos, current_vpos;
1829 /* Height in pixels, number of glyph rows. */
1830 int height, nrows;
1834 /* Structure holding system-dependent interface functions needed
1835 for window-based redisplay. */
1837 struct redisplay_interface
1839 /* Produce glyphs/get display metrics for the display element IT is
1840 loaded with. */
1841 void (*produce_glyphs) P_ ((struct it *it));
1843 /* Write or insert LEN glyphs from STRING at the nominal output
1844 position. */
1845 void (*write_glyphs) P_ ((struct glyph *string, int len));
1846 void (*insert_glyphs) P_ ((struct glyph *start, int len));
1848 /* Clear from nominal output position to X. X < 0 means clear
1849 to right end of display. */
1850 void (*clear_end_of_line) P_ ((int x));
1852 /* Function to call to scroll the display as described by RUN on
1853 window W. */
1854 void (*scroll_run_hook) P_ ((struct window *w, struct run *run));
1856 /* Function to call after a line in a display has been completely
1857 updated. Used to draw truncation marks and alike. DESIRED_ROW
1858 is the desired row which has been updated. */
1859 void (*after_update_window_line_hook) P_ ((struct glyph_row *desired_row));
1861 /* Function to call before beginning to update window W in
1862 window-based redisplay. */
1863 void (*update_window_begin_hook) P_ ((struct window *w));
1865 /* Function to call after window W has been updated in window-based
1866 redisplay. CURSOR_ON_P non-zero means switch cursor on.
1867 MOUSE_FACE_OVERWRITTEN_P non-zero means that some lines in W
1868 that contained glyphs in mouse-face were overwritten, so we
1869 have to update the mouse hightlight. */
1870 void (*update_window_end_hook) P_ ((struct window *w, int cursor_on_p,
1871 int mouse_face_overwritten_p));
1873 /* Move cursor to row/column position VPOS/HPOS, pixel coordinates
1874 Y/X. HPOS/VPOS are window-relative row and column numbers and X/Y
1875 are window-relative pixel positions. */
1876 void (*cursor_to) P_ ((int vpos, int hpos, int y, int x));
1878 /* Flush the display of frame F. For X, this is XFlush. */
1879 void (*flush_display) P_ ((struct frame *f));
1881 /* Clear the mouse hightlight in window W, if there is any. */
1882 void (*clear_mouse_face) P_ ((struct window *w));
1884 /* Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
1885 frame F. */
1886 void (*get_glyph_overhangs) P_ ((struct glyph *glyph, struct frame *f,
1887 int *left, int *right));
1889 /* Fix the display of AREA of ROW in window W for overlapping rows.
1890 This function is called from redraw_overlapping_rows after
1891 desired rows have been made current. */
1892 void (*fix_overlapping_area) P_ ((struct window *w, struct glyph_row *row,
1893 enum glyph_row_area area));
1896 /* The current interface for window-based redisplay. */
1898 extern struct redisplay_interface *rif;
1900 /* Hook to call in estimate_mode_line_height. */
1902 extern int (* estimate_mode_line_height_hook) P_ ((struct frame *,
1903 enum face_id));
1906 /***********************************************************************
1907 Images
1908 ***********************************************************************/
1910 #ifdef HAVE_WINDOW_SYSTEM
1912 /* Structure forward declarations. */
1914 struct image;
1917 /* Each image format (JPEG, IIFF, ...) supported is described by
1918 a structure of the type below. */
1920 struct image_type
1922 /* A symbol uniquely identifying the image type, .e.g `jpeg'. */
1923 Lisp_Object *type;
1925 /* Check that SPEC is a valid image specification for the given
1926 image type. Value is non-zero if SPEC is valid. */
1927 int (* valid_p) P_ ((Lisp_Object spec));
1929 /* Load IMG which is used on frame F from information contained in
1930 IMG->spec. Value is non-zero if successful. */
1931 int (* load) P_ ((struct frame *f, struct image *img));
1933 /* Free resources of image IMG which is used on frame F. */
1934 void (* free) P_ ((struct frame *f, struct image *img));
1936 /* Next in list of all supported image types. */
1937 struct image_type *next;
1941 /* Structure describing an image. Specific image formats like XBM are
1942 converted into this form, so that display only has to deal with
1943 this type of image. */
1945 struct image
1947 /* The time in seconds at which the image was last displayed. Set
1948 in prepare_image_for_display. */
1949 unsigned long timestamp;
1951 /* Pixmaps of the image. */
1952 Pixmap pixmap, mask;
1954 /* Colors allocated for this image, if any. Allocated via xmalloc. */
1955 unsigned long *colors;
1956 int ncolors;
1958 /* Width and height of the image. */
1959 int width, height;
1961 /* These values are used for the rectangles displayed for images
1962 that can't be loaded. */
1963 #define DEFAULT_IMAGE_WIDTH 30
1964 #define DEFAULT_IMAGE_HEIGHT 30
1966 /* Percent of image height used as ascent. A value of
1967 CENTERED_IMAGE_ASCENT means draw center the image centered on the
1968 line. */
1969 int ascent;
1970 #define DEFAULT_IMAGE_ASCENT 50
1971 #define CENTERED_IMAGE_ASCENT -1
1973 /* Lisp specification of this image. */
1974 Lisp_Object spec;
1976 /* Relief to draw around the image. */
1977 int relief;
1979 /* Optional margin around the image. This includes the relief. */
1980 int margin;
1982 /* Reference to the type of the image. */
1983 struct image_type *type;
1985 /* 1 means that loading the image failed. Don't try again. */
1986 unsigned load_failed_p;
1988 /* A place for image types to store additional data. The member
1989 data.lisp_val is marked during GC, so it's safe to store Lisp data
1990 there. Image types should free this data when their `free'
1991 function is called. */
1992 struct
1994 int int_val;
1995 void *ptr_val;
1996 Lisp_Object lisp_val;
1997 } data;
1999 /* Hash value of image specification to speed up comparisons. */
2000 unsigned hash;
2002 /* Image id of this image. */
2003 int id;
2005 /* Hash collision chain. */
2006 struct image *next, *prev;
2010 /* Cache of images. Each frame has a cache. X frames with the same
2011 x_display_info share their caches. */
2013 struct image_cache
2015 /* Hash table of images. */
2016 struct image **buckets;
2018 /* Vector mapping image ids to images. */
2019 struct image **images;
2021 /* Allocated size of `images'. */
2022 unsigned size;
2024 /* Number of images in the cache. */
2025 unsigned used;
2027 /* Reference count (number of frames sharing this cache). */
2028 int refcount;
2032 /* Value is a pointer to the image with id ID on frame F, or null if
2033 no image with that id exists. */
2035 #define IMAGE_FROM_ID(F, ID) \
2036 (((ID) >= 0 && (ID) < (FRAME_X_IMAGE_CACHE (F)->used)) \
2037 ? FRAME_X_IMAGE_CACHE (F)->images[ID] \
2038 : NULL)
2040 /* Size of bucket vector of image caches. Should be prime. */
2042 #define IMAGE_CACHE_BUCKETS_SIZE 1001
2044 #endif /* HAVE_WINDOW_SYSTEM */
2048 /***********************************************************************
2049 Tool-bars
2050 ***********************************************************************/
2052 /* Enumeration defining where to find tool-bar item information in
2053 tool-bar items vectors stored with frames. Each tool-bar item
2054 occupies TOOL_BAR_ITEM_NSLOTS elements in such a vector. */
2056 enum tool_bar_item_idx
2058 /* The key of the tool-bar item. Used to remove items when a binding
2059 for `undefined' is found. */
2060 TOOL_BAR_ITEM_KEY,
2062 /* Non-nil if item is enabled. */
2063 TOOL_BAR_ITEM_ENABLED_P,
2065 /* Non-nil if item is selected (pressed). */
2066 TOOL_BAR_ITEM_SELECTED_P,
2068 /* Caption. */
2069 TOOL_BAR_ITEM_CAPTION,
2071 /* Image(s) to display. This is either a single image specification
2072 or a vector of specifications. */
2073 TOOL_BAR_ITEM_IMAGES,
2075 /* The binding. */
2076 TOOL_BAR_ITEM_BINDING,
2078 /* Button type. One of nil, `:radio' or `:toggle'. */
2079 TOOL_BAR_ITEM_TYPE,
2081 /* Help string. */
2082 TOOL_BAR_ITEM_HELP,
2084 /* Sentinel = number of slots in tool_bar_items occupied by one
2085 tool-bar item. */
2086 TOOL_BAR_ITEM_NSLOTS
2090 /* An enumeration for the different images that can be specified
2091 for a tool-bar item. */
2093 enum tool_bar_item_image
2095 TOOL_BAR_IMAGE_ENABLED_SELECTED,
2096 TOOL_BAR_IMAGE_ENABLED_DESELECTED,
2097 TOOL_BAR_IMAGE_DISABLED_SELECTED,
2098 TOOL_BAR_IMAGE_DISABLED_DESELECTED
2101 /* Non-zero means raise tool-bar buttons when the mouse moves over them. */
2103 extern int auto_raise_tool_bar_buttons_p;
2105 /* Margin around tool-bar buttons in pixels. */
2107 extern int tool_bar_button_margin;
2109 /* Thickness of relief to draw around tool-bar buttons. */
2111 extern int tool_bar_button_relief;
2115 /***********************************************************************
2116 Function Prototypes
2117 ***********************************************************************/
2119 /* Defined in xdisp.c */
2121 int display_prop_intangible_p P_ ((Lisp_Object));
2122 void resize_echo_area_axactly P_ ((void));
2123 int resize_mini_window P_ ((struct window *, int));
2124 int try_window P_ ((Lisp_Object, struct text_pos));
2125 void window_box P_ ((struct window *, int, int *, int *, int *, int *));
2126 int window_box_height P_ ((struct window *));
2127 int window_text_bottom_y P_ ((struct window *));
2128 int window_box_width P_ ((struct window *, int));
2129 int window_box_left P_ ((struct window *, int));
2130 int window_box_right P_ ((struct window *, int));
2131 void window_box_edges P_ ((struct window *, int, int *, int *, int *, int *));
2132 void mark_window_display_accurate P_ ((Lisp_Object, int));
2133 void redisplay_preserve_echo_area P_ ((void));
2134 void set_cursor_from_row P_ ((struct window *, struct glyph_row *,
2135 struct glyph_matrix *, int, int, int, int));
2136 void init_iterator P_ ((struct it *, struct window *, int,
2137 int, struct glyph_row *, enum face_id));
2138 void init_iterator_to_row_start P_ ((struct it *, struct window *,
2139 struct glyph_row *));
2140 int get_next_display_element P_ ((struct it *));
2141 void set_iterator_to_next P_ ((struct it *));
2142 void produce_glyphs P_ ((struct it *));
2143 void produce_special_glyphs P_ ((struct it *, enum display_element_type));
2144 void start_display P_ ((struct it *, struct window *, struct text_pos));
2145 void move_it_to P_ ((struct it *, int, int, int, int, int));
2146 void move_it_vertically P_ ((struct it *, int));
2147 void move_it_by_lines P_ ((struct it *, int, int));
2148 int frame_mode_line_height P_ ((struct frame *));
2149 void highlight_trailing_whitespace P_ ((struct frame *, struct glyph_row *));
2150 int tool_bar_item_info P_ ((struct frame *, struct glyph *, int *));
2151 extern Lisp_Object Qtool_bar;
2152 extern Lisp_Object Vshow_trailing_whitespace;
2153 extern int redisplaying_p;
2154 extern Lisp_Object Vimage_types;
2155 extern void add_to_log P_ ((char *, Lisp_Object, Lisp_Object));
2157 /* Defined in sysdep.c */
2159 void get_frame_size P_ ((int *, int *));
2160 void request_sigio P_ ((void));
2161 void unrequest_sigio P_ ((void));
2162 int tabs_safe_p P_ ((void));
2163 void init_baud_rate P_ ((void));
2164 void init_sigio P_ ((int));
2166 /* Defined in xfaces.c */
2168 #ifdef USE_X_TOOLKIT
2169 void x_set_menu_resources_from_menu_face P_ ((struct frame *, Widget));
2170 #endif
2171 #ifdef HAVE_X_WINDOWS
2172 void x_free_colors P_ ((struct frame *, unsigned long *, int));
2173 #endif
2175 void update_face_from_frame_parameter P_ ((struct frame *, Lisp_Object,
2176 Lisp_Object));
2177 Lisp_Object tty_color_name P_ ((struct frame *, int));
2178 void clear_face_cache P_ ((int));
2179 unsigned long load_color P_ ((struct frame *, struct face *, Lisp_Object,
2180 enum lface_attribute_index));
2181 void unload_color P_ ((struct frame *, unsigned long));
2182 int frame_update_line_height P_ ((struct frame *));
2183 int ascii_face_of_lisp_face P_ ((struct frame *, int));
2184 void prepare_face_for_display P_ ((struct frame *, struct face *));
2185 int xstricmp P_ ((unsigned char *, unsigned char *));
2186 int lookup_face P_ ((struct frame *, Lisp_Object *, int, struct face *));
2187 int lookup_named_face P_ ((struct frame *, Lisp_Object, int));
2188 int smaller_face P_ ((struct frame *, int, int));
2189 int face_with_height P_ ((struct frame *, int, int));
2190 int lookup_derived_face P_ ((struct frame *, Lisp_Object, int, int));
2191 void init_frame_faces P_ ((struct frame *));
2192 void free_frame_faces P_ ((struct frame *));
2193 void recompute_basic_faces P_ ((struct frame *));
2194 int face_at_buffer_position P_ ((struct window *, int, int, int, int *,
2195 int, int));
2196 int face_at_string_position P_ ((struct window *, Lisp_Object,
2197 int, int, int, int, int *, enum face_id));
2198 int compute_char_face P_ ((struct frame *, int, Lisp_Object));
2199 void free_all_realized_faces P_ ((Lisp_Object));
2200 extern Lisp_Object Qforeground_color, Qbackground_color;
2201 void free_realized_multibyte_face P_ ((struct frame *, int));
2203 /* Defined in xfns.c */
2205 #ifdef HAVE_X_WINDOWS
2206 void gamma_correct P_ ((struct frame *, XColor *));
2207 #endif
2208 #ifdef WINDOWSNT
2209 void gamma_correct P_ ((struct frame *, COLORREF *));
2210 #endif
2212 #ifdef HAVE_WINDOW_SYSTEM
2214 void x_kill_gs_process P_ ((Pixmap, struct frame *));
2215 int x_screen_planes P_ ((struct frame *));
2216 void x_implicitly_set_name P_ ((struct frame *, Lisp_Object, Lisp_Object));
2217 struct image_cache *make_image_cache P_ ((void));
2218 void free_image_cache P_ ((struct frame *));
2219 void clear_image_cache P_ ((struct frame *, int));
2220 void forall_images_in_image_cache P_ ((struct frame *,
2221 void (*) P_ ((struct image *))));
2222 int valid_image_p P_ ((Lisp_Object));
2223 void prepare_image_for_display P_ ((struct frame *, struct image *));
2224 int lookup_image P_ ((struct frame *, Lisp_Object));
2225 extern struct frame *tip_frame;
2226 extern Window tip_window;
2227 EXFUN (Fx_show_tip, 6);
2228 EXFUN (Fx_hide_tip, 0);
2229 extern void start_busy_cursor P_ ((void));
2230 extern void cancel_busy_cursor P_ ((void));
2231 extern int display_busy_cursor_p;
2233 #endif /* HAVE_WINDOW_SYSTEM */
2236 /* Defined in xmenu.c */
2238 int popup_activated P_ ((void));
2240 /* Defined in dispnew.c */
2242 int estimate_mode_line_height P_ ((struct frame *, enum face_id));
2243 Lisp_Object mode_line_string P_ ((struct window *, int, int, int, int *));
2244 extern void redraw_frame P_ ((struct frame *));
2245 extern void redraw_garbaged_frames P_ ((void));
2246 extern void cancel_line P_ ((int, struct frame *));
2247 extern void init_desired_glyphs P_ ((struct frame *));
2248 extern int scroll_frame_lines P_ ((struct frame *, int, int, int, int));
2249 extern int direct_output_for_insert P_ ((int));
2250 extern int direct_output_forward_char P_ ((int));
2251 extern int update_frame P_ ((struct frame *, int, int));
2252 extern int scrolling P_ ((struct frame *));
2253 extern void bitch_at_user P_ ((void));
2254 void adjust_glyphs P_ ((struct frame *));
2255 void free_glyphs P_ ((struct frame *));
2256 void free_window_matrices P_ ((struct window *));
2257 void check_glyph_memory P_ ((void));
2258 void mirrored_line_dance P_ ((struct glyph_matrix *, int, int, int *, char *));
2259 void clear_glyph_matrix P_ ((struct glyph_matrix *));
2260 void clear_current_matrices P_ ((struct frame *f));
2261 void clear_desired_matrices P_ ((struct frame *));
2262 void shift_glyph_matrix P_ ((struct window *, struct glyph_matrix *,
2263 int, int, int));
2264 void rotate_matrix P_ ((struct glyph_matrix *, int, int, int));
2265 void increment_matrix_positions P_ ((struct glyph_matrix *,
2266 int, int, int, int));
2267 void blank_row P_ ((struct window *, struct glyph_row *, int));
2268 void increment_row_positions P_ ((struct glyph_row *, int, int));
2269 void enable_glyph_matrix_rows P_ ((struct glyph_matrix *, int, int, int));
2270 void clear_glyph_row P_ ((struct glyph_row *));
2271 void prepare_desired_row P_ ((struct glyph_row *));
2272 int line_hash_code P_ ((struct glyph_row *));
2273 void set_window_update_flags P_ ((struct window *, int));
2274 void write_glyphs P_ ((struct glyph *, int));
2275 void insert_glyphs P_ ((struct glyph *, int));
2276 void redraw_frame P_ ((struct frame *));
2277 void redraw_garbaged_frames P_ ((void));
2278 int scroll_cost P_ ((struct frame *, int, int, int));
2279 int direct_output_for_insert P_ ((int));
2280 int direct_output_forward_char P_ ((int));
2281 int update_frame P_ ((struct frame *, int, int));
2282 void update_single_window P_ ((struct window *, int));
2283 int scrolling P_ ((struct frame *));
2284 int buffer_posn_from_coords P_ ((struct window *, int *, int *));
2285 void do_pending_window_change P_ ((int));
2286 void change_frame_size P_ ((struct frame *, int, int, int, int, int));
2287 void bitch_at_user P_ ((void));
2288 Lisp_Object sit_for P_ ((int, int, int, int, int));
2289 void init_display P_ ((void));
2290 void syms_of_display P_ ((void));
2291 extern Lisp_Object Qredisplay_dont_pause;
2293 /* Defined in term.c */
2295 extern void ring_bell P_ ((void));
2296 extern void set_terminal_modes P_ ((void));
2297 extern void reset_terminal_modes P_ ((void));
2298 extern void update_begin P_ ((struct frame *));
2299 extern void update_end P_ ((struct frame *));
2300 extern void set_terminal_window P_ ((int));
2301 extern void set_scroll_region P_ ((int, int));
2302 extern void turn_off_insert P_ ((void));
2303 extern void turn_off_highlight P_ ((void));
2304 extern void background_highlight P_ ((void));
2305 extern void reassert_line_highlight P_ ((int, int));
2306 extern void clear_frame P_ ((void));
2307 extern void clear_end_of_line P_ ((int));
2308 extern void clear_end_of_line_raw P_ ((int));
2309 extern void delete_glyphs P_ ((int));
2310 extern void ins_del_lines P_ ((int, int));
2311 extern int string_cost P_ ((char *));
2312 extern int per_line_cost P_ ((char *));
2313 extern void calculate_costs P_ ((struct frame *));
2314 extern void term_init P_ ((char *));
2315 extern void fatal P_ ((/* char *, ... */));
2316 void cursor_to P_ ((int, int));
2317 void change_line_highlight P_ ((int, int, int, int));
2319 /* Defined in scroll.c */
2321 extern int scrolling_max_lines_saved P_ ((int, int, int *, int *, int *));
2322 extern int scroll_cost P_ ((struct frame *, int, int, int));
2323 extern void do_line_insertion_deletion_costs P_ ((struct frame *, char *,
2324 char *, char *, char *,
2325 char *, char *, int));
2326 void scrolling_1 P_ ((struct frame *, int, int, int, int *, int *, int *,
2327 int *, int));
2329 #endif /* not DISPEXTERN_H_INCLUDED */