Commit | Line | Data |
---|---|---|
c22ca93b | 1 | /* Interface definitions for display code. |
0b5538bd | 2 | Copyright (C) 1985, 1993, 1994, 1997, 1998, 1999, 2000, 2001, 2002, |
aaef169d | 3 | 2003, 2004, 2005, 2006 Free Software Foundation, Inc. |
c22ca93b JB |
4 | |
5 | This file is part of GNU Emacs. | |
6 | ||
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 | |
e5d77022 | 9 | the Free Software Foundation; either version 2, or (at your option) |
c22ca93b JB |
10 | any later version. |
11 | ||
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. | |
16 | ||
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 | |
4fc5845f LK |
19 | the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
20 | Boston, MA 02110-1301, USA. */ | |
c22ca93b | 21 | |
4d2036e4 | 22 | /* New redisplay written by Gerd Moellmann <gerd@gnu.org>. */ |
87485d6f | 23 | |
5f5c8ee5 GM |
24 | #ifndef DISPEXTERN_H_INCLUDED |
25 | #define DISPEXTERN_H_INCLUDED | |
c22ca93b JB |
26 | |
27 | #ifdef HAVE_X_WINDOWS | |
94e32607 | 28 | |
9f2279ad | 29 | #include <X11/Xlib.h> |
8317e104 GM |
30 | #ifdef USE_X_TOOLKIT |
31 | #include <X11/Intrinsic.h> | |
32 | #endif /* USE_X_TOOLKIT */ | |
94e32607 JB |
33 | |
34 | #else /* !HAVE_X_WINDOWS */ | |
35 | ||
36 | /* X-related stuff used by non-X gui code. */ | |
37 | ||
38 | typedef struct { | |
39 | unsigned long pixel; | |
40 | unsigned short red, green, blue; | |
41 | char flags; | |
42 | char pad; | |
43 | } XColor; | |
44 | ||
8317e104 | 45 | #endif /* HAVE_X_WINDOWS */ |
87485d6f MW |
46 | |
47 | #ifdef MSDOS | |
48 | #include "msdos.h" | |
49 | #endif | |
9f2279ad | 50 | |
d74b2553 KS |
51 | #ifdef HAVE_X_WINDOWS |
52 | typedef struct x_display_info Display_Info; | |
0ccb519d KS |
53 | typedef XImage * XImagePtr; |
54 | typedef XImagePtr XImagePtr_or_DC; | |
d74b2553 KS |
55 | #define NativeRectangle XRectangle |
56 | #endif | |
57 | ||
497fbd42 | 58 | #ifdef HAVE_NTGUI |
c0ac470c | 59 | #include "w32gui.h" |
d74b2553 | 60 | typedef struct w32_display_info Display_Info; |
0ccb519d KS |
61 | typedef XImage *XImagePtr; |
62 | typedef HDC XImagePtr_or_DC; | |
497fbd42 GV |
63 | #endif |
64 | ||
b15325b2 | 65 | #ifdef MAC_OS |
1a578e9b | 66 | #include "macgui.h" |
d74b2553 | 67 | typedef struct mac_display_info Display_Info; |
0ccb519d KS |
68 | /* Mac equivalent of XImage. */ |
69 | typedef Pixmap XImagePtr; | |
70 | typedef XImagePtr XImagePtr_or_DC; | |
29c42596 | 71 | #endif |
5f5c8ee5 | 72 | |
dfbe5d05 KS |
73 | #ifndef NativeRectangle |
74 | #define NativeRectangle int | |
75 | #endif | |
76 | ||
5f5c8ee5 GM |
77 | /* Structure forward declarations. Some are here because function |
78 | prototypes below reference structure types before their definition | |
79 | in this file. Some are here because not every file including | |
80 | dispextern.h also includes frame.h and windows.h. */ | |
81 | ||
82 | struct glyph; | |
83 | struct glyph_row; | |
84 | struct glyph_matrix; | |
85 | struct glyph_pool; | |
86 | struct frame; | |
87 | struct window; | |
88 | ||
89 | ||
d74b2553 KS |
90 | /* Values returned from coordinates_in_window. */ |
91 | ||
92 | enum window_part | |
93 | { | |
94 | ON_NOTHING, | |
95 | ON_TEXT, | |
96 | ON_MODE_LINE, | |
97 | ON_VERTICAL_BORDER, | |
98 | ON_HEADER_LINE, | |
99 | ON_LEFT_FRINGE, | |
100 | ON_RIGHT_FRINGE, | |
101 | ON_LEFT_MARGIN, | |
ab431b61 RS |
102 | ON_RIGHT_MARGIN, |
103 | ON_SCROLL_BAR | |
d74b2553 KS |
104 | }; |
105 | ||
2251a6f2 | 106 | /* Number of bits allocated to store fringe bitmap numbers. */ |
b3b08f03 | 107 | #define FRINGE_ID_BITS 16 |
2251a6f2 | 108 | |
d74b2553 | 109 | |
5f5c8ee5 | 110 | \f |
5f5c8ee5 GM |
111 | /*********************************************************************** |
112 | Debugging | |
113 | ***********************************************************************/ | |
114 | ||
115 | /* If GLYPH_DEBUG is non-zero, additional checks are activated. Turn | |
116 | it off by defining the macro GLYPH_DEBUG to zero. */ | |
117 | ||
118 | #ifndef GLYPH_DEBUG | |
119 | #define GLYPH_DEBUG 0 | |
120 | #endif | |
121 | ||
139c65cf KS |
122 | /* If XASSERTS is non-zero, additional consistency checks are activated. |
123 | Turn it off by defining the macro XASSERTS to zero. */ | |
124 | ||
125 | #ifndef XASSERTS | |
126 | #define XASSERTS 0 | |
127 | #endif | |
128 | ||
5f5c8ee5 GM |
129 | /* Macros to include code only if GLYPH_DEBUG != 0. */ |
130 | ||
131 | #if GLYPH_DEBUG | |
132 | #define IF_DEBUG(X) X | |
5f5c8ee5 GM |
133 | #else |
134 | #define IF_DEBUG(X) (void) 0 | |
5f5c8ee5 GM |
135 | #endif |
136 | ||
139c65cf | 137 | #if XASSERTS |
d78f30b8 | 138 | #define xassert(X) do {if (!(X)) abort ();} while (0) |
139c65cf KS |
139 | #else |
140 | #define xassert(X) (void) 0 | |
141 | #endif | |
d78f30b8 | 142 | |
5f5c8ee5 GM |
143 | /* Macro for displaying traces of redisplay. If Emacs was compiled |
144 | with GLYPH_DEBUG != 0, the variable trace_redisplay_p can be set to | |
145 | a non-zero value in debugging sessions to activate traces. */ | |
146 | ||
147 | #if GLYPH_DEBUG | |
148 | ||
149 | extern int trace_redisplay_p; | |
150 | #include <stdio.h> | |
151 | ||
152 | #define TRACE(X) \ | |
153 | if (trace_redisplay_p) \ | |
154 | fprintf X; \ | |
155 | else \ | |
156 | (void) 0 | |
157 | ||
158 | #else /* GLYPH_DEBUG == 0 */ | |
159 | ||
160 | #define TRACE(X) (void) 0 | |
161 | ||
162 | #endif /* GLYPH_DEBUG == 0 */ | |
163 | ||
177c0ea7 | 164 | |
5f5c8ee5 GM |
165 | \f |
166 | /*********************************************************************** | |
167 | Text positions | |
168 | ***********************************************************************/ | |
169 | ||
170 | /* Starting with Emacs 20.3, characters from strings and buffers have | |
171 | both a character and a byte position associated with them. The | |
172 | following structure holds such a pair of positions. */ | |
177c0ea7 | 173 | |
5f5c8ee5 GM |
174 | struct text_pos |
175 | { | |
176 | /* Character position. */ | |
177 | int charpos; | |
178 | ||
179 | /* Corresponding byte position. */ | |
180 | int bytepos; | |
181 | }; | |
182 | ||
183 | /* Access character and byte position of POS in a functional form. */ | |
184 | ||
185 | #define BYTEPOS(POS) (POS).bytepos | |
186 | #define CHARPOS(POS) (POS).charpos | |
187 | ||
188 | /* Set character position of POS to CHARPOS, byte position to BYTEPOS. */ | |
189 | ||
190 | #define SET_TEXT_POS(POS, CHARPOS, BYTEPOS) \ | |
191 | ((POS).charpos = (CHARPOS), (POS).bytepos = BYTEPOS) | |
192 | ||
193 | /* Increment text position POS. */ | |
194 | ||
7bed37e4 | 195 | #define INC_TEXT_POS(POS, MULTIBYTE_P) \ |
5f5c8ee5 GM |
196 | do \ |
197 | { \ | |
198 | ++(POS).charpos; \ | |
7bed37e4 GM |
199 | if (MULTIBYTE_P) \ |
200 | INC_POS ((POS).bytepos); \ | |
201 | else \ | |
202 | ++(POS).bytepos; \ | |
5f5c8ee5 GM |
203 | } \ |
204 | while (0) | |
205 | ||
206 | /* Decrement text position POS. */ | |
207 | ||
7bed37e4 | 208 | #define DEC_TEXT_POS(POS, MULTIBYTE_P) \ |
5f5c8ee5 GM |
209 | do \ |
210 | { \ | |
211 | --(POS).charpos; \ | |
7bed37e4 GM |
212 | if (MULTIBYTE_P) \ |
213 | DEC_POS ((POS).bytepos); \ | |
214 | else \ | |
215 | --(POS).bytepos; \ | |
5f5c8ee5 GM |
216 | } \ |
217 | while (0) | |
218 | ||
219 | /* Set text position POS from marker MARKER. */ | |
220 | ||
221 | #define SET_TEXT_POS_FROM_MARKER(POS, MARKER) \ | |
222 | (CHARPOS (POS) = marker_position ((MARKER)), \ | |
223 | BYTEPOS (POS) = marker_byte_position ((MARKER))) | |
224 | ||
225 | /* Set marker MARKER from text position POS. */ | |
226 | ||
227 | #define SET_MARKER_FROM_TEXT_POS(MARKER, POS) \ | |
228 | set_marker_both ((MARKER), Qnil, CHARPOS ((POS)), BYTEPOS ((POS))) | |
177c0ea7 | 229 | |
5f5c8ee5 GM |
230 | /* Value is non-zero if character and byte positions of POS1 and POS2 |
231 | are equal. */ | |
232 | ||
233 | #define TEXT_POS_EQUAL_P(POS1, POS2) \ | |
234 | ((POS1).charpos == (POS2).charpos \ | |
235 | && (POS1).bytepos == (POS2).bytepos) | |
236 | ||
237 | /* When rendering glyphs, redisplay scans string or buffer text, | |
238 | overlay strings in that text, and does display table or control | |
239 | character translations. The following structure captures a | |
240 | position taking all this into account. */ | |
241 | ||
242 | struct display_pos | |
243 | { | |
244 | /* Buffer or string position. */ | |
245 | struct text_pos pos; | |
246 | ||
247 | /* If this is a position in an overlay string, overlay_string_index | |
248 | is the index of that overlay string in the sequence of overlay | |
249 | strings at `pos' in the order redisplay processes them. A value | |
250 | < 0 means that this is not a position in an overlay string. */ | |
251 | int overlay_string_index; | |
252 | ||
253 | /* If this is a position in an overlay string, string_pos is the | |
254 | position within that string. */ | |
255 | struct text_pos string_pos; | |
256 | ||
257 | /* If the character at the position above is a control character or | |
258 | has a display table entry, dpvec_index is an index in the display | |
259 | table or control character translation of that character. A | |
260 | value < 0 means this is not a position in such a translation. */ | |
261 | int dpvec_index; | |
262 | }; | |
263 | ||
264 | ||
265 | \f | |
266 | /*********************************************************************** | |
267 | Glyphs | |
268 | ***********************************************************************/ | |
269 | ||
270 | /* Enumeration of glyph types. Glyph structures contain a type field | |
271 | containing one of the enumerators defined here. */ | |
272 | ||
273 | enum glyph_type | |
274 | { | |
275 | /* Glyph describes a character. */ | |
177c0ea7 | 276 | CHAR_GLYPH, |
5f5c8ee5 | 277 | |
a90fbbf6 KH |
278 | /* Glyph describes a composition sequence. */ |
279 | COMPOSITE_GLYPH, | |
280 | ||
5f5c8ee5 GM |
281 | /* Glyph describes an image. */ |
282 | IMAGE_GLYPH, | |
283 | ||
284 | /* Glyph is a space of fractional width and/or height. */ | |
285 | STRETCH_GLYPH | |
286 | }; | |
287 | ||
288 | ||
0633d52c KS |
289 | /* Structure describing how to use partial glyphs (images slicing) */ |
290 | ||
291 | struct glyph_slice | |
292 | { | |
293 | unsigned x : 16; | |
294 | unsigned y : 16; | |
295 | unsigned width : 16; | |
296 | unsigned height : 16; | |
297 | }; | |
298 | ||
299 | ||
827503c6 GM |
300 | /* Glyphs. |
301 | ||
302 | Be extra careful when changing this structure! Esp. make sure that | |
d5cc60b8 | 303 | functions producing glyphs, like append_glyph, fill ALL of the |
827503c6 GM |
304 | glyph structure, and that GLYPH_EQUAL_P compares all |
305 | display-relevant members of glyphs (not to imply that these are the | |
306 | only things to check when you add a member). */ | |
5f5c8ee5 GM |
307 | |
308 | struct glyph | |
309 | { | |
310 | /* Position from which this glyph was drawn. If `object' below is a | |
311 | Lisp string, this is a position in that string. If it is a | |
312 | buffer, this is a position in that buffer. A value of -1 | |
313 | together with a null object means glyph is a truncation glyph at | |
314 | the start of a row. */ | |
315 | int charpos; | |
316 | ||
317 | /* Lisp object source of this glyph. Currently either a buffer or | |
177c0ea7 | 318 | a string, if the glyph was produced from characters which came from |
f920e581 GM |
319 | a buffer or a string; or 0 if the glyph was inserted by redisplay |
320 | for its own purposes such as padding. */ | |
5f5c8ee5 GM |
321 | Lisp_Object object; |
322 | ||
323 | /* Width in pixels. */ | |
324 | short pixel_width; | |
325 | ||
01b1f0c0 KS |
326 | /* Ascent and descent in pixels. */ |
327 | short ascent, descent; | |
328 | ||
5f5c8ee5 GM |
329 | /* Vertical offset. If < 0, the glyph is displayed raised, if > 0 |
330 | the glyph is displayed lowered. */ | |
331 | short voffset; | |
332 | ||
333 | /* Which kind of glyph this is---character, image etc. Value | |
334 | should be an enumerator of type enum glyph_type. */ | |
335 | unsigned type : 2; | |
336 | ||
337 | /* 1 means this glyph was produced from multibyte text. Zero | |
338 | means it was produced from unibyte text, i.e. charsets aren't | |
339 | applicable, and encoding is not performed. */ | |
340 | unsigned multibyte_p : 1; | |
341 | ||
342 | /* Non-zero means draw a box line at the left or right side of this | |
343 | glyph. This is part of the implementation of the face attribute | |
344 | `:box'. */ | |
345 | unsigned left_box_line_p : 1; | |
346 | unsigned right_box_line_p : 1; | |
347 | ||
2febf6e0 GM |
348 | /* Non-zero means this glyph's physical ascent or descent is greater |
349 | than its logical ascent/descent, i.e. it may potentially overlap | |
350 | glyphs above or below it. */ | |
351 | unsigned overlaps_vertically_p : 1; | |
352 | ||
3305fc6a KH |
353 | /* 1 means glyph is a padding glyph. Padding glyphs are used for |
354 | characters whose visual shape consists of more than one glyph | |
355 | (e.g. Asian characters). All but the first glyph of such a glyph | |
356 | sequence have the padding_p flag set. Only used for terminal | |
357 | frames, and there only to minimize code changes. A better way | |
358 | would probably be to use the width field of glyphs to express | |
359 | padding. */ | |
360 | unsigned padding_p : 1; | |
361 | ||
f920e581 GM |
362 | /* 1 means the actual glyph is not available, draw a box instead. |
363 | This can happen when a font couldn't be loaded, or a character | |
364 | doesn't have a glyph in a font. */ | |
b3091a23 KH |
365 | unsigned glyph_not_available_p : 1; |
366 | ||
01b1f0c0 KS |
367 | #define FACE_ID_BITS 21 |
368 | ||
c68b9c2f RS |
369 | /* Face of the glyph. This is a realized face ID, |
370 | an index in the face cache of the frame. */ | |
01b1f0c0 | 371 | unsigned face_id : FACE_ID_BITS; |
3305fc6a | 372 | |
d5cc60b8 | 373 | /* Type of font used to display the character glyph. May be used to |
b40b05b6 | 374 | determine which set of functions to use to obtain font metrics |
d5cc60b8 KS |
375 | for the glyph. On W32, value should be an enumerator of the type |
376 | w32_char_font_type. Otherwise it equals FONT_TYPE_UNKNOWN. */ | |
377 | unsigned font_type : 3; | |
b40b05b6 | 378 | |
0633d52c KS |
379 | struct glyph_slice slice; |
380 | ||
5f5c8ee5 GM |
381 | /* A union of sub-structures for different glyph types. */ |
382 | union | |
383 | { | |
3305fc6a KH |
384 | /* Character code for character glyphs (type == CHAR_GLYPH). */ |
385 | unsigned ch; | |
5f5c8ee5 | 386 | |
3305fc6a KH |
387 | /* Composition ID for composition glyphs (type == COMPOSITION_GLYPH) */ |
388 | unsigned cmp_id; | |
a90fbbf6 | 389 | |
3305fc6a KH |
390 | /* Image ID for image glyphs (type == IMAGE_GLYPH). */ |
391 | unsigned img_id; | |
5f5c8ee5 GM |
392 | |
393 | /* Sub-structure for type == STRETCH_GLYPH. */ | |
394 | struct | |
395 | { | |
396 | /* The height of the glyph. */ | |
3305fc6a | 397 | unsigned height : 16; |
5f5c8ee5 GM |
398 | |
399 | /* The ascent of the glyph. */ | |
3305fc6a | 400 | unsigned ascent : 16; |
5f5c8ee5 GM |
401 | } |
402 | stretch; | |
177c0ea7 | 403 | |
5f5c8ee5 GM |
404 | /* Used to compare all bit-fields above in one step. */ |
405 | unsigned val; | |
406 | } u; | |
407 | }; | |
408 | ||
409 | ||
d5cc60b8 KS |
410 | /* Default value of the glyph font_type field. */ |
411 | ||
412 | #define FONT_TYPE_UNKNOWN 0 | |
413 | ||
5f5c8ee5 GM |
414 | /* Is GLYPH a space? */ |
415 | ||
416 | #define CHAR_GLYPH_SPACE_P(GLYPH) \ | |
417 | (GLYPH_FROM_CHAR_GLYPH ((GLYPH)) == SPACEGLYPH) | |
418 | ||
0633d52c KS |
419 | /* Are glyph slices of glyphs *X and *Y equal */ |
420 | ||
421 | #define GLYPH_SLICE_EQUAL_P(X, Y) \ | |
422 | ((X)->slice.x == (Y)->slice.x \ | |
423 | && (X)->slice.y == (Y)->slice.y \ | |
424 | && (X)->slice.width == (Y)->slice.width \ | |
425 | && (X)->slice.height == (Y)->slice.height) | |
426 | ||
827503c6 | 427 | /* Are glyphs *X and *Y displayed equal? */ |
177c0ea7 | 428 | |
5f5c8ee5 GM |
429 | #define GLYPH_EQUAL_P(X, Y) \ |
430 | ((X)->type == (Y)->type \ | |
431 | && (X)->u.val == (Y)->u.val \ | |
0633d52c | 432 | && GLYPH_SLICE_EQUAL_P (X, Y) \ |
3305fc6a KH |
433 | && (X)->face_id == (Y)->face_id \ |
434 | && (X)->padding_p == (Y)->padding_p \ | |
5f5c8ee5 GM |
435 | && (X)->left_box_line_p == (Y)->left_box_line_p \ |
436 | && (X)->right_box_line_p == (Y)->right_box_line_p \ | |
726950c4 GM |
437 | && (X)->voffset == (Y)->voffset \ |
438 | && (X)->pixel_width == (Y)->pixel_width) | |
5f5c8ee5 | 439 | |
3305fc6a KH |
440 | /* Are character codes, faces, padding_ps of glyphs *X and *Y equal? */ |
441 | ||
442 | #define GLYPH_CHAR_AND_FACE_EQUAL_P(X, Y) \ | |
443 | ((X)->u.ch == (Y)->u.ch \ | |
444 | && (X)->face_id == (Y)->face_id \ | |
445 | && (X)->padding_p == (Y)->padding_p) | |
446 | ||
5f5c8ee5 GM |
447 | /* Fill a character glyph GLYPH. CODE, FACE_ID, PADDING_P correspond |
448 | to the bits defined for the typedef `GLYPH' in lisp.h. */ | |
177c0ea7 | 449 | |
5f5c8ee5 GM |
450 | #define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P) \ |
451 | do \ | |
452 | { \ | |
3305fc6a KH |
453 | (GLYPH).u.ch = (CODE); \ |
454 | (GLYPH).face_id = (FACE_ID); \ | |
455 | (GLYPH).padding_p = (PADDING_P); \ | |
5f5c8ee5 GM |
456 | } \ |
457 | while (0) | |
458 | ||
459 | /* Fill a character type glyph GLYPH from a glyph typedef FROM as | |
460 | defined in lisp.h. */ | |
177c0ea7 | 461 | |
5f5c8ee5 GM |
462 | #define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM) \ |
463 | SET_CHAR_GLYPH ((GLYPH), \ | |
464 | FAST_GLYPH_CHAR ((FROM)), \ | |
465 | FAST_GLYPH_FACE ((FROM)), \ | |
3305fc6a | 466 | 0) |
5f5c8ee5 | 467 | |
3305fc6a KH |
468 | /* Construct a glyph code from a character glyph GLYPH. If the |
469 | character is multibyte, return -1 as we can't use glyph table for a | |
54bff0bd | 470 | multibyte character. */ |
177c0ea7 | 471 | |
4728a553 GM |
472 | #define GLYPH_FROM_CHAR_GLYPH(GLYPH) \ |
473 | ((GLYPH).u.ch < 256 \ | |
474 | ? ((GLYPH).u.ch | ((GLYPH).face_id << CHARACTERBITS)) \ | |
3305fc6a | 475 | : -1) |
5f5c8ee5 GM |
476 | |
477 | /* Is GLYPH a padding glyph? */ | |
177c0ea7 | 478 | |
3305fc6a | 479 | #define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p |
5f5c8ee5 GM |
480 | |
481 | ||
482 | ||
483 | \f | |
484 | /*********************************************************************** | |
485 | Glyph Pools | |
486 | ***********************************************************************/ | |
487 | ||
488 | /* Glyph Pool. | |
489 | ||
490 | Glyph memory for frame-based redisplay is allocated from the heap | |
491 | in one vector kept in a glyph pool structure which is stored with | |
492 | the frame. The size of the vector is made large enough to cover | |
493 | all windows on the frame. | |
494 | ||
495 | Both frame and window glyph matrices reference memory from a glyph | |
496 | pool in frame-based redisplay. | |
497 | ||
498 | In window-based redisplay, no glyphs pools exist; windows allocate | |
499 | and free their glyph memory themselves. */ | |
500 | ||
501 | struct glyph_pool | |
502 | { | |
503 | /* Vector of glyphs allocated from the heap. */ | |
504 | struct glyph *glyphs; | |
505 | ||
506 | /* Allocated size of `glyphs'. */ | |
507 | int nglyphs; | |
508 | ||
509 | /* Number of rows and columns in a matrix. */ | |
510 | int nrows, ncolumns; | |
511 | }; | |
512 | ||
513 | ||
514 | \f | |
515 | /*********************************************************************** | |
516 | Glyph Matrix | |
517 | ***********************************************************************/ | |
518 | ||
519 | /* Glyph Matrix. | |
520 | ||
521 | Three kinds of glyph matrices exist: | |
522 | ||
523 | 1. Frame glyph matrices. These are used for terminal frames whose | |
524 | redisplay needs a view of the whole screen due to limited terminal | |
525 | capabilities. Frame matrices are used only in the update phase | |
526 | of redisplay. They are built in update_frame and not used after | |
527 | the update has been performed. | |
528 | ||
529 | 2. Window glyph matrices on frames having frame glyph matrices. | |
530 | Such matrices are sub-matrices of their corresponding frame matrix, | |
531 | i.e. frame glyph matrices and window glyph matrices share the same | |
532 | glyph memory which is allocated in form of a glyph_pool structure. | |
533 | Glyph rows in such a window matrix are slices of frame matrix rows. | |
534 | ||
535 | 2. Free-standing window glyph matrices managing their own glyph | |
536 | storage. This form is used in window-based redisplay which | |
537 | includes variable width and height fonts etc. | |
538 | ||
539 | The size of a window's row vector depends on the height of fonts | |
540 | defined on its frame. It is chosen so that the vector is large | |
541 | enough to describe all lines in a window when it is displayed in | |
542 | the smallest possible character size. When new fonts are loaded, | |
543 | or window sizes change, the row vector is adjusted accordingly. */ | |
544 | ||
545 | struct glyph_matrix | |
546 | { | |
547 | /* The pool from which glyph memory is allocated, if any. This is | |
548 | null for frame matrices and for window matrices managing their | |
549 | own storage. */ | |
550 | struct glyph_pool *pool; | |
551 | ||
552 | /* Vector of glyph row structures. The row at nrows - 1 is reserved | |
553 | for the mode line. */ | |
554 | struct glyph_row *rows; | |
555 | ||
556 | /* Number of elements allocated for the vector rows above. */ | |
557 | int rows_allocated; | |
558 | ||
559 | /* The number of rows used by the window if all lines were displayed | |
560 | with the smallest possible character height. */ | |
561 | int nrows; | |
562 | ||
563 | /* Origin within the frame matrix if this is a window matrix on a | |
564 | frame having a frame matrix. Both values are zero for | |
565 | window-based redisplay. */ | |
566 | int matrix_x, matrix_y; | |
567 | ||
568 | /* Width and height of the matrix in columns and rows. */ | |
569 | int matrix_w, matrix_h; | |
570 | ||
6df72db9 | 571 | /* If this structure describes a window matrix of window W, |
87388f9d KS |
572 | window_left_col is the value of W->left_col, window_top_line the |
573 | value of W->top_line, window_height and window_width are width and | |
574 | height of W, as returned by window_box, and window_vscroll is the | |
575 | value of W->vscroll at the time the matrix was last adjusted. | |
576 | Only set for window-based redisplay. */ | |
577 | int window_left_col, window_top_line; | |
578 | int window_height, window_width; | |
579 | int window_vscroll; | |
5f5c8ee5 GM |
580 | |
581 | /* Number of glyphs reserved for left and right marginal areas when | |
582 | the matrix was last adjusted. */ | |
583 | int left_margin_glyphs, right_margin_glyphs; | |
584 | ||
585 | /* Flag indicating that scrolling should not be tried in | |
586 | update_window. This flag is set by functions like try_window_id | |
587 | which do their own scrolling. */ | |
588 | unsigned no_scrolling_p : 1; | |
589 | ||
590 | /* Non-zero means window displayed in this matrix has a top mode | |
591 | line. */ | |
045dee35 | 592 | unsigned header_line_p : 1; |
5f5c8ee5 GM |
593 | |
594 | #ifdef GLYPH_DEBUG | |
595 | /* A string identifying the method used to display the matrix. */ | |
596 | char method[512]; | |
597 | #endif | |
2201e367 | 598 | |
a36d22d2 GM |
599 | /* The buffer this matrix displays. Set in |
600 | mark_window_display_accurate_1. */ | |
2201e367 GM |
601 | struct buffer *buffer; |
602 | ||
a36d22d2 GM |
603 | /* Values of BEGV and ZV as of last redisplay. Set in |
604 | mark_window_display_accurate_1. */ | |
2201e367 | 605 | int begv, zv; |
5f5c8ee5 GM |
606 | }; |
607 | ||
608 | ||
609 | /* Check that glyph pointers stored in glyph rows of MATRIX are okay. | |
610 | This aborts if any pointer is found twice. */ | |
611 | ||
612 | #if GLYPH_DEBUG | |
613 | void check_matrix_pointer_lossage P_ ((struct glyph_matrix *)); | |
614 | #define CHECK_MATRIX(MATRIX) check_matrix_pointer_lossage ((MATRIX)) | |
615 | #else | |
616 | #define CHECK_MATRIX(MATRIX) (void) 0 | |
617 | #endif | |
618 | ||
619 | ||
620 | \f | |
621 | /*********************************************************************** | |
622 | Glyph Rows | |
623 | ***********************************************************************/ | |
624 | ||
625 | /* Area in window glyph matrix. If values are added or removed, the | |
626 | function mark_object in alloc.c has to be changed. */ | |
627 | ||
628 | enum glyph_row_area | |
629 | { | |
630 | LEFT_MARGIN_AREA, | |
631 | TEXT_AREA, | |
632 | RIGHT_MARGIN_AREA, | |
633 | LAST_AREA | |
634 | }; | |
635 | ||
636 | ||
637 | /* Rows of glyphs in a windows or frame glyph matrix. | |
638 | ||
639 | Each row is partitioned into three areas. The start and end of | |
640 | each area is recorded in a pointer as shown below. | |
177c0ea7 | 641 | |
5f5c8ee5 GM |
642 | +--------------------+-------------+---------------------+ |
643 | | left margin area | text area | right margin area | | |
644 | +--------------------+-------------+---------------------+ | |
645 | | | | | | |
646 | glyphs[LEFT_MARGIN_AREA] glyphs[RIGHT_MARGIN_AREA] | |
647 | | | | |
648 | glyphs[TEXT_AREA] | | |
177c0ea7 | 649 | glyphs[LAST_AREA] |
5f5c8ee5 GM |
650 | |
651 | Rows in frame matrices reference glyph memory allocated in a frame | |
652 | glyph pool (see the description of struct glyph_pool). Rows in | |
653 | window matrices on frames having frame matrices reference slices of | |
654 | the glyphs of corresponding rows in the frame matrix. | |
177c0ea7 | 655 | |
5f5c8ee5 GM |
656 | Rows in window matrices on frames having no frame matrices point to |
657 | glyphs allocated from the heap via xmalloc; | |
658 | glyphs[LEFT_MARGIN_AREA] is the start address of the allocated | |
659 | glyph structure array. */ | |
660 | ||
661 | struct glyph_row | |
662 | { | |
663 | /* Pointers to beginnings of areas. The end of an area A is found at | |
664 | A + 1 in the vector. The last element of the vector is the end | |
665 | of the whole row. | |
666 | ||
667 | Kludge alert: Even if used[TEXT_AREA] == 0, glyphs[TEXT_AREA][0]'s | |
668 | position field is used. It is -1 if this row does not correspond | |
669 | to any text; it is some buffer position if the row corresponds to | |
670 | an empty display line that displays a line end. This is what old | |
671 | redisplay used to do. (Except in code for terminal frames, this | |
54bff0bd | 672 | kludge is no longer used, I believe. --gerd). |
5f5c8ee5 GM |
673 | |
674 | See also start, end, displays_text_p and ends_at_zv_p for cleaner | |
675 | ways to do it. The special meaning of positions 0 and -1 will be | |
676 | removed some day, so don't use it in new code. */ | |
677 | struct glyph *glyphs[1 + LAST_AREA]; | |
678 | ||
679 | /* Number of glyphs actually filled in areas. */ | |
680 | short used[LAST_AREA]; | |
681 | ||
682 | /* Window-relative x and y-position of the top-left corner of this | |
683 | row. If y < 0, this means that abs (y) pixels of the row are | |
684 | invisible because it is partially visible at the top of a window. | |
685 | If x < 0, this means that abs (x) pixels of the first glyph of | |
686 | the text area of the row are invisible because the glyph is | |
687 | partially visible. */ | |
688 | int x, y; | |
689 | ||
690 | /* Width of the row in pixels without taking face extension at the | |
6332ca8a GM |
691 | end of the row into account, and without counting truncation |
692 | and continuation glyphs at the end of a row on ttys. */ | |
5f5c8ee5 GM |
693 | int pixel_width; |
694 | ||
2febf6e0 GM |
695 | /* Logical ascent/height of this line. The value of ascent is zero |
696 | and height is 1 on terminal frames. */ | |
5f5c8ee5 GM |
697 | int ascent, height; |
698 | ||
2febf6e0 GM |
699 | /* Physical ascent/height of this line. If max_ascent > ascent, |
700 | this line overlaps the line above it on the display. Otherwise, | |
701 | if max_height > height, this line overlaps the line beneath it. */ | |
702 | int phys_ascent, phys_height; | |
703 | ||
5f5c8ee5 GM |
704 | /* Portion of row that is visible. Partially visible rows may be |
705 | found at the top and bottom of a window. This is 1 for tty | |
706 | frames. It may be < 0 in case of completely invisible rows. */ | |
707 | int visible_height; | |
708 | ||
db0c5a7d KS |
709 | /* Extra line spacing added after this row. Do not consider this |
710 | in last row when checking if row is fully visible. */ | |
711 | int extra_line_spacing; | |
712 | ||
5f5c8ee5 GM |
713 | /* Hash code. This hash code is available as soon as the row |
714 | is constructed, i.e. after a call to display_line. */ | |
715 | unsigned hash; | |
716 | ||
717 | /* First position in this row. This is the text position, including | |
718 | overlay position information etc, where the display of this row | |
719 | started, and can thus be less the position of the first glyph | |
720 | (e.g. due to invisible text or horizontal scrolling). */ | |
721 | struct display_pos start; | |
722 | ||
723 | /* Text position at the end of this row. This is the position after | |
724 | the last glyph on this row. It can be greater than the last | |
725 | glyph position + 1, due to truncation, invisible text etc. In an | |
726 | up-to-date display, this should always be equal to the start | |
727 | position of the next row. */ | |
728 | struct display_pos end; | |
729 | ||
e937c046 KS |
730 | /* Non-zero means the overlay arrow bitmap is on this line. |
731 | -1 means use default overlay arrow bitmap, else | |
732 | it specifies actual fringe bitmap number. */ | |
733 | int overlay_arrow_bitmap; | |
734 | ||
557c387e | 735 | /* Left fringe bitmap number (enum fringe_bitmap_type). */ |
2251a6f2 KS |
736 | unsigned left_user_fringe_bitmap : FRINGE_ID_BITS; |
737 | ||
2251a6f2 KS |
738 | /* Right fringe bitmap number (enum fringe_bitmap_type). */ |
739 | unsigned right_user_fringe_bitmap : FRINGE_ID_BITS; | |
740 | ||
2251a6f2 KS |
741 | /* Left fringe bitmap number (enum fringe_bitmap_type). */ |
742 | unsigned left_fringe_bitmap : FRINGE_ID_BITS; | |
743 | ||
557c387e | 744 | /* Right fringe bitmap number (enum fringe_bitmap_type). */ |
2251a6f2 KS |
745 | unsigned right_fringe_bitmap : FRINGE_ID_BITS; |
746 | ||
b3b08f03 KS |
747 | /* Face of the left fringe glyph. */ |
748 | unsigned left_user_fringe_face_id : FACE_ID_BITS; | |
749 | ||
750 | /* Face of the right fringe glyph. */ | |
751 | unsigned right_user_fringe_face_id : FACE_ID_BITS; | |
752 | ||
753 | /* Face of the left fringe glyph. */ | |
754 | unsigned left_fringe_face_id : FACE_ID_BITS; | |
755 | ||
2251a6f2 KS |
756 | /* Face of the right fringe glyph. */ |
757 | unsigned right_fringe_face_id : FACE_ID_BITS; | |
557c387e KS |
758 | |
759 | /* 1 means that we must draw the bitmaps of this row. */ | |
760 | unsigned redraw_fringe_bitmaps_p : 1; | |
761 | ||
5f5c8ee5 GM |
762 | /* In a desired matrix, 1 means that this row must be updated. In a |
763 | current matrix, 0 means that the row has been invalidated, i.e. | |
764 | the row's contents do not agree with what is visible on the | |
765 | screen. */ | |
766 | unsigned enabled_p : 1; | |
767 | ||
5f5c8ee5 GM |
768 | /* 1 means row displays a text line that is truncated on the left or |
769 | right side. */ | |
770 | unsigned truncated_on_left_p : 1; | |
771 | unsigned truncated_on_right_p : 1; | |
772 | ||
5f5c8ee5 GM |
773 | /* 1 means that this row displays a continued line, i.e. it has a |
774 | continuation mark at the right side. */ | |
775 | unsigned continued_p : 1; | |
776 | ||
777 | /* 0 means that this row does not contain any text, i.e. it is | |
778 | a blank line at the window and buffer end. */ | |
779 | unsigned displays_text_p : 1; | |
780 | ||
781 | /* 1 means that this line ends at ZV. */ | |
782 | unsigned ends_at_zv_p : 1; | |
783 | ||
784 | /* 1 means the face of the last glyph in the text area is drawn to | |
785 | the right end of the window. This flag is used in | |
786 | update_text_area to optimize clearing to the end of the area. */ | |
787 | unsigned fill_line_p : 1; | |
788 | ||
789 | /* Non-zero means display a bitmap on X frames indicating that this | |
790 | line contains no text and ends in ZV. */ | |
791 | unsigned indicate_empty_line_p : 1; | |
792 | ||
793 | /* 1 means this row contains glyphs that overlap each other because | |
794 | of lbearing or rbearing. */ | |
795 | unsigned contains_overlapping_glyphs_p : 1; | |
796 | ||
54bff0bd | 797 | /* 1 means this row is as wide as the window it is displayed in, including |
afb7aabb | 798 | scroll bars, fringes, and internal borders. This also |
5f5c8ee5 GM |
799 | implies that the row doesn't have marginal areas. */ |
800 | unsigned full_width_p : 1; | |
801 | ||
54bff0bd | 802 | /* Non-zero means row is a mode or header-line. */ |
5f5c8ee5 GM |
803 | unsigned mode_line_p : 1; |
804 | ||
2febf6e0 GM |
805 | /* 1 in a current row means this row is overlapped by another row. */ |
806 | unsigned overlapped_p : 1; | |
807 | ||
666852af GM |
808 | /* 1 means this line ends in the middle of a character consisting |
809 | of more than one glyph. Some glyphs have been put in this row, | |
810 | the rest are put in rows below this one. */ | |
811 | unsigned ends_in_middle_of_char_p : 1; | |
177c0ea7 | 812 | |
666852af GM |
813 | /* 1 means this line starts in the middle of a character consisting |
814 | of more than one glyph. Some glyphs have been put in the | |
54bff0bd | 815 | previous row, the rest are put in this row. */ |
666852af GM |
816 | unsigned starts_in_middle_of_char_p : 1; |
817 | ||
2febf6e0 GM |
818 | /* 1 in a current row means this row overlaps others. */ |
819 | unsigned overlapping_p : 1; | |
820 | ||
48b509fe GM |
821 | /* 1 means some glyphs in this row are displayed in mouse-face. */ |
822 | unsigned mouse_face_p : 1; | |
823 | ||
257e3f57 GM |
824 | /* 1 means this row was ended by a newline from a string. */ |
825 | unsigned ends_in_newline_from_string_p : 1; | |
826 | ||
557c387e KS |
827 | /* 1 means this row width is exactly the width of the window, and the |
828 | final newline character is hidden in the right fringe. */ | |
829 | unsigned exact_window_width_line_p : 1; | |
830 | ||
831 | /* 1 means this row currently shows the cursor in the right fringe. */ | |
832 | unsigned cursor_in_fringe_p : 1; | |
833 | ||
b437860a RS |
834 | /* 1 means the last glyph in the row is part of an ellipsis. */ |
835 | unsigned ends_in_ellipsis_p : 1; | |
836 | ||
557c387e KS |
837 | /* Non-zero means display a bitmap on X frames indicating that this |
838 | the first line of the buffer. */ | |
839 | unsigned indicate_bob_p : 1; | |
840 | ||
841 | /* Non-zero means display a bitmap on X frames indicating that this | |
842 | the top line of the window, but not start of the buffer. */ | |
843 | unsigned indicate_top_line_p : 1; | |
844 | ||
845 | /* Non-zero means display a bitmap on X frames indicating that this | |
846 | the last line of the buffer. */ | |
847 | unsigned indicate_eob_p : 1; | |
848 | ||
849 | /* Non-zero means display a bitmap on X frames indicating that this | |
850 | the bottom line of the window, but not end of the buffer. */ | |
851 | unsigned indicate_bottom_line_p : 1; | |
852 | ||
5f5c8ee5 GM |
853 | /* Continuation lines width at the start of the row. */ |
854 | int continuation_lines_width; | |
855 | }; | |
856 | ||
857 | ||
858 | /* Get a pointer to row number ROW in matrix MATRIX. If GLYPH_DEBUG | |
859 | is defined to a non-zero value, the function matrix_row checks that | |
860 | we don't try to access rows that are out of bounds. */ | |
861 | ||
862 | #if GLYPH_DEBUG | |
863 | struct glyph_row *matrix_row P_ ((struct glyph_matrix *, int)); | |
864 | #define MATRIX_ROW(MATRIX, ROW) matrix_row ((MATRIX), (ROW)) | |
865 | #else | |
866 | #define MATRIX_ROW(MATRIX, ROW) ((MATRIX)->rows + (ROW)) | |
867 | #endif | |
868 | ||
177c0ea7 | 869 | /* Return a pointer to the row reserved for the mode line in MATRIX. |
5f5c8ee5 GM |
870 | Row MATRIX->nrows - 1 is always reserved for the mode line. */ |
871 | ||
872 | #define MATRIX_MODE_LINE_ROW(MATRIX) \ | |
873 | ((MATRIX)->rows + (MATRIX)->nrows - 1) | |
874 | ||
54bff0bd | 875 | /* Return a pointer to the row reserved for the header line in MATRIX. |
5f5c8ee5 GM |
876 | This is always the first row in MATRIX because that's the only |
877 | way that works in frame-based redisplay. */ | |
878 | ||
045dee35 | 879 | #define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows |
5f5c8ee5 GM |
880 | |
881 | /* Return a pointer to first row in MATRIX used for text display. */ | |
882 | ||
883 | #define MATRIX_FIRST_TEXT_ROW(MATRIX) \ | |
884 | ((MATRIX)->rows->mode_line_p ? (MATRIX)->rows + 1 : (MATRIX)->rows) | |
885 | ||
886 | /* Return a pointer to the first glyph in the text area of a row. | |
887 | MATRIX is the glyph matrix accessed, and ROW is the row index in | |
888 | MATRIX. */ | |
889 | ||
890 | #define MATRIX_ROW_GLYPH_START(MATRIX, ROW) \ | |
891 | (MATRIX_ROW ((MATRIX), (ROW))->glyphs[TEXT_AREA]) | |
892 | ||
893 | /* Return the number of used glyphs in the text area of a row. */ | |
177c0ea7 | 894 | |
5f5c8ee5 GM |
895 | #define MATRIX_ROW_USED(MATRIX, ROW) \ |
896 | (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA]) | |
897 | ||
898 | /* Return the character/ byte position at which the display of ROW | |
899 | starts. */ | |
177c0ea7 | 900 | |
5f5c8ee5 GM |
901 | #define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->start.pos.charpos) |
902 | #define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->start.pos.bytepos) | |
903 | ||
54bff0bd | 904 | /* Return the character/ byte position at which ROW ends. */ |
177c0ea7 | 905 | |
5f5c8ee5 GM |
906 | #define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->end.pos.charpos) |
907 | #define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->end.pos.bytepos) | |
908 | ||
909 | /* Return the vertical position of ROW in MATRIX. */ | |
177c0ea7 | 910 | |
5f5c8ee5 GM |
911 | #define MATRIX_ROW_VPOS(ROW, MATRIX) ((ROW) - (MATRIX)->rows) |
912 | ||
913 | /* Return the last glyph row + 1 in MATRIX on window W reserved for | |
914 | text. If W has a mode line, the last row in the matrix is reserved | |
915 | for it. */ | |
177c0ea7 | 916 | |
5f5c8ee5 GM |
917 | #define MATRIX_BOTTOM_TEXT_ROW(MATRIX, W) \ |
918 | ((MATRIX)->rows \ | |
919 | + (MATRIX)->nrows \ | |
920 | - (WINDOW_WANTS_MODELINE_P ((W)) ? 1 : 0)) | |
921 | ||
922 | /* Non-zero if the face of the last glyph in ROW's text area has | |
923 | to be drawn to the end of the text area. */ | |
177c0ea7 | 924 | |
5f5c8ee5 GM |
925 | #define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p) |
926 | ||
927 | /* Set and query the enabled_p flag of glyph row ROW in MATRIX. */ | |
177c0ea7 | 928 | |
5f5c8ee5 GM |
929 | #define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \ |
930 | (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0) | |
177c0ea7 | 931 | |
5f5c8ee5 GM |
932 | #define MATRIX_ROW_ENABLED_P(MATRIX, ROW) \ |
933 | (MATRIX_ROW ((MATRIX), (ROW))->enabled_p) | |
934 | ||
935 | /* Non-zero if ROW displays text. Value is non-zero if the row is | |
936 | blank but displays a line end. */ | |
177c0ea7 | 937 | |
5f5c8ee5 GM |
938 | #define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p) |
939 | ||
db0c5a7d KS |
940 | |
941 | /* Helper macros */ | |
942 | ||
943 | #define MR_PARTIALLY_VISIBLE(ROW) \ | |
944 | ((ROW)->height != (ROW)->visible_height) | |
945 | ||
946 | #define MR_PARTIALLY_VISIBLE_AT_TOP(W, ROW) \ | |
947 | ((ROW)->y < WINDOW_HEADER_LINE_HEIGHT ((W))) | |
948 | ||
949 | #define MR_PARTIALLY_VISIBLE_AT_BOTTOM(W, ROW) \ | |
950 | (((ROW)->y + (ROW)->height - (ROW)->extra_line_spacing) \ | |
951 | > WINDOW_BOX_HEIGHT_NO_MODE_LINE ((W))) | |
952 | ||
5f5c8ee5 | 953 | /* Non-zero if ROW is not completely visible in window W. */ |
177c0ea7 | 954 | |
db0c5a7d KS |
955 | #define MATRIX_ROW_PARTIALLY_VISIBLE_P(W, ROW) \ |
956 | (MR_PARTIALLY_VISIBLE ((ROW)) \ | |
957 | && (MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)) \ | |
958 | || MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW)))) | |
959 | ||
960 | ||
5f5c8ee5 GM |
961 | |
962 | /* Non-zero if ROW is partially visible at the top of window W. */ | |
177c0ea7 | 963 | |
5f5c8ee5 | 964 | #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW) \ |
db0c5a7d KS |
965 | (MR_PARTIALLY_VISIBLE ((ROW)) \ |
966 | && MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW))) | |
5f5c8ee5 GM |
967 | |
968 | /* Non-zero if ROW is partially visible at the bottom of window W. */ | |
177c0ea7 | 969 | |
db0c5a7d KS |
970 | #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW) \ |
971 | (MR_PARTIALLY_VISIBLE ((ROW)) \ | |
972 | && MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW))) | |
5f5c8ee5 GM |
973 | |
974 | /* Return the bottom Y + 1 of ROW. */ | |
177c0ea7 | 975 | |
5f5c8ee5 GM |
976 | #define MATRIX_ROW_BOTTOM_Y(ROW) ((ROW)->y + (ROW)->height) |
977 | ||
978 | /* Is ROW the last visible one in the display described by the | |
979 | iterator structure pointed to by IT?. */ | |
177c0ea7 | 980 | |
5f5c8ee5 GM |
981 | #define MATRIX_ROW_LAST_VISIBLE_P(ROW, IT) \ |
982 | (MATRIX_ROW_BOTTOM_Y ((ROW)) >= (IT)->last_visible_y) | |
983 | ||
984 | /* Non-zero if ROW displays a continuation line. */ | |
985 | ||
986 | #define MATRIX_ROW_CONTINUATION_LINE_P(ROW) \ | |
987 | ((ROW)->continuation_lines_width > 0) | |
988 | ||
989 | /* Non-zero if ROW ends in the middle of a character. This is the | |
990 | case for continued lines showing only part of a display table entry | |
991 | or a control char, or an overlay string. */ | |
992 | ||
993 | #define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW) \ | |
e6fb381c | 994 | ((ROW)->end.dpvec_index > 0 \ |
666852af GM |
995 | || (ROW)->end.overlay_string_index >= 0 \ |
996 | || (ROW)->ends_in_middle_of_char_p) | |
5f5c8ee5 GM |
997 | |
998 | /* Non-zero if ROW ends in the middle of an overlay string. */ | |
999 | ||
1000 | #define MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P(ROW) \ | |
1001 | ((ROW)->end.overlay_string_index >= 0) | |
1002 | ||
1003 | /* Non-zero if ROW starts in the middle of a character. See above. */ | |
177c0ea7 | 1004 | |
5f5c8ee5 | 1005 | #define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW) \ |
e6fb381c | 1006 | ((ROW)->start.dpvec_index > 0 \ |
666852af | 1007 | || (ROW)->starts_in_middle_of_char_p \ |
5f5c8ee5 GM |
1008 | || ((ROW)->start.overlay_string_index >= 0 \ |
1009 | && (ROW)->start.string_pos.charpos > 0)) | |
1010 | ||
2febf6e0 GM |
1011 | /* Non-zero means ROW overlaps its predecessor. */ |
1012 | ||
1013 | #define MATRIX_ROW_OVERLAPS_PRED_P(ROW) \ | |
1014 | ((ROW)->phys_ascent > (ROW)->ascent) | |
1015 | ||
1016 | /* Non-zero means ROW overlaps its successor. */ | |
1017 | ||
1018 | #define MATRIX_ROW_OVERLAPS_SUCC_P(ROW) \ | |
1019 | ((ROW)->phys_height - (ROW)->phys_ascent \ | |
1020 | > (ROW)->height - (ROW)->ascent) | |
1021 | ||
5f5c8ee5 GM |
1022 | /* Non-zero means that fonts have been loaded since the last glyph |
1023 | matrix adjustments. The function redisplay_internal adjusts glyph | |
1024 | matrices when this flag is non-zero. */ | |
1025 | ||
1026 | extern int fonts_changed_p; | |
1027 | ||
1028 | /* A glyph for a space. */ | |
1029 | ||
1030 | extern struct glyph space_glyph; | |
1031 | ||
1032 | /* Window being updated by update_window. This is non-null as long as | |
856dd475 | 1033 | update_window has not finished, and null otherwise. */ |
5f5c8ee5 GM |
1034 | |
1035 | extern struct window *updated_window; | |
1036 | ||
1037 | /* Glyph row and area updated by update_window_line. */ | |
1038 | ||
1039 | extern struct glyph_row *updated_row; | |
1040 | extern int updated_area; | |
1041 | ||
1042 | /* Non-zero means reading single-character input with prompt so put | |
1043 | cursor on mini-buffer after the prompt. Positive means at end of | |
1044 | text in echo area; negative means at beginning of line. */ | |
1045 | ||
1046 | extern int cursor_in_echo_area; | |
1047 | ||
1048 | /* Non-zero means last display completed. Zero means it was | |
1049 | preempted. */ | |
1050 | ||
1051 | extern int display_completed; | |
1052 | ||
1053 | /* Non-zero means redisplay has been performed directly (see also | |
1054 | direct_output_for_insert and direct_output_forward_char), so that | |
1055 | no further updating has to be performed. The function | |
1056 | redisplay_internal checks this flag, and does nothing but reset it | |
1057 | to zero if it is non-zero. */ | |
1058 | ||
1059 | extern int redisplay_performed_directly_p; | |
1060 | ||
1061 | /* A temporary storage area, including a row of glyphs. Initialized | |
1062 | in xdisp.c. Used for various purposes, as an example see | |
1063 | direct_output_for_insert. */ | |
1064 | ||
1065 | extern struct glyph_row scratch_glyph_row; | |
1066 | ||
1067 | ||
1068 | \f | |
d5cc60b8 KS |
1069 | /************************************************************************ |
1070 | Glyph Strings | |
1071 | ************************************************************************/ | |
1072 | ||
1073 | /* Enumeration for overriding/changing the face to use for drawing | |
d74b2553 | 1074 | glyphs in draw_glyphs. */ |
d5cc60b8 KS |
1075 | |
1076 | enum draw_glyphs_face | |
1077 | { | |
1078 | DRAW_NORMAL_TEXT, | |
1079 | DRAW_INVERSE_VIDEO, | |
1080 | DRAW_CURSOR, | |
1081 | DRAW_MOUSE_FACE, | |
1082 | DRAW_IMAGE_RAISED, | |
1083 | DRAW_IMAGE_SUNKEN | |
1084 | }; | |
1085 | ||
79fa9e0f KS |
1086 | #ifdef HAVE_WINDOW_SYSTEM |
1087 | ||
d5cc60b8 KS |
1088 | /* A sequence of glyphs to be drawn in the same face. */ |
1089 | ||
1090 | struct glyph_string | |
1091 | { | |
1092 | /* X-origin of the string. */ | |
1093 | int x; | |
1094 | ||
1095 | /* Y-origin and y-position of the base line of this string. */ | |
1096 | int y, ybase; | |
1097 | ||
1098 | /* The width of the string, not including a face extension. */ | |
1099 | int width; | |
1100 | ||
1101 | /* The width of the string, including a face extension. */ | |
1102 | int background_width; | |
1103 | ||
1104 | /* The height of this string. This is the height of the line this | |
1105 | string is drawn in, and can be different from the height of the | |
1106 | font the string is drawn in. */ | |
1107 | int height; | |
1108 | ||
1109 | /* Number of pixels this string overwrites in front of its x-origin. | |
1110 | This number is zero if the string has an lbearing >= 0; it is | |
1111 | -lbearing, if the string has an lbearing < 0. */ | |
1112 | int left_overhang; | |
1113 | ||
1114 | /* Number of pixels this string overwrites past its right-most | |
1115 | nominal x-position, i.e. x + width. Zero if the string's | |
1116 | rbearing is <= its nominal width, rbearing - width otherwise. */ | |
1117 | int right_overhang; | |
1118 | ||
1119 | /* The frame on which the glyph string is drawn. */ | |
1120 | struct frame *f; | |
1121 | ||
1122 | /* The window on which the glyph string is drawn. */ | |
1123 | struct window *w; | |
1124 | ||
1125 | /* X display and window for convenience. */ | |
1126 | Display *display; | |
1127 | Window window; | |
1128 | ||
1129 | /* The glyph row for which this string was built. It determines the | |
1130 | y-origin and height of the string. */ | |
1131 | struct glyph_row *row; | |
1132 | ||
1133 | /* The area within row. */ | |
1134 | enum glyph_row_area area; | |
1135 | ||
1136 | /* Characters to be drawn, and number of characters. */ | |
1137 | XChar2b *char2b; | |
1138 | int nchars; | |
1139 | ||
1140 | /* A face-override for drawing cursors, mouse face and similar. */ | |
1141 | enum draw_glyphs_face hl; | |
1142 | ||
1143 | /* Face in which this string is to be drawn. */ | |
1144 | struct face *face; | |
1145 | ||
1146 | /* Font in which this string is to be drawn. */ | |
1147 | XFontStruct *font; | |
1148 | ||
1149 | /* Font info for this string. */ | |
1150 | struct font_info *font_info; | |
1151 | ||
1152 | /* Non-null means this string describes (part of) a composition. | |
1153 | All characters from char2b are drawn composed. */ | |
1154 | struct composition *cmp; | |
1155 | ||
1156 | /* Index of this glyph string's first character in the glyph | |
1157 | definition of CMP. If this is zero, this glyph string describes | |
1158 | the first character of a composition. */ | |
1159 | int gidx; | |
1160 | ||
1161 | /* 1 means this glyph strings face has to be drawn to the right end | |
1162 | of the window's drawing area. */ | |
1163 | unsigned extends_to_end_of_line_p : 1; | |
1164 | ||
1165 | /* 1 means the background of this string has been drawn. */ | |
1166 | unsigned background_filled_p : 1; | |
1167 | ||
1168 | /* 1 means glyph string must be drawn with 16-bit functions. */ | |
1169 | unsigned two_byte_p : 1; | |
1170 | ||
1171 | /* 1 means that the original font determined for drawing this glyph | |
1172 | string could not be loaded. The member `font' has been set to | |
1173 | the frame's default font in this case. */ | |
1174 | unsigned font_not_found_p : 1; | |
1175 | ||
1176 | /* 1 means that the face in which this glyph string is drawn has a | |
1177 | stipple pattern. */ | |
1178 | unsigned stippled_p : 1; | |
1179 | ||
10a07952 YM |
1180 | #define OVERLAPS_PRED (1 << 0) |
1181 | #define OVERLAPS_SUCC (1 << 1) | |
1182 | #define OVERLAPS_BOTH (OVERLAPS_PRED | OVERLAPS_SUCC) | |
1183 | #define OVERLAPS_ERASED_CURSOR (1 << 2) | |
1184 | /* Non-zero means only the foreground of this glyph string must be | |
1185 | drawn, and we should use the physical height of the line this | |
1186 | glyph string appears in as clip rect. If the value is | |
1187 | OVERLAPS_ERASED_CURSOR, the clip rect is restricted to the rect | |
1188 | of the erased cursor. OVERLAPS_PRED and OVERLAPS_SUCC mean we | |
1189 | draw overlaps with the preceding and the succeeding rows, | |
1190 | respectively. */ | |
1191 | unsigned for_overlaps : 3; | |
d5cc60b8 KS |
1192 | |
1193 | /* The GC to use for drawing this glyph string. */ | |
b15325b2 | 1194 | #if defined(HAVE_X_WINDOWS) || defined(MAC_OS) |
d5cc60b8 KS |
1195 | GC gc; |
1196 | #endif | |
1197 | #if defined(HAVE_NTGUI) | |
1198 | XGCValues *gc; | |
1199 | HDC hdc; | |
1200 | #endif | |
1201 | ||
1202 | /* A pointer to the first glyph in the string. This glyph | |
1203 | corresponds to char2b[0]. Needed to draw rectangles if | |
1204 | font_not_found_p is 1. */ | |
1205 | struct glyph *first_glyph; | |
1206 | ||
1207 | /* Image, if any. */ | |
1208 | struct image *img; | |
1209 | ||
0633d52c KS |
1210 | /* Slice */ |
1211 | struct glyph_slice slice; | |
1212 | ||
8c2da0fa ST |
1213 | /* Non-null means the horizontal clipping region starts from the |
1214 | left edge of *clip_head, and ends with the right edge of | |
1215 | *clip_tail, not including their overhangs. */ | |
1216 | struct glyph_string *clip_head, *clip_tail; | |
1217 | ||
d5cc60b8 KS |
1218 | struct glyph_string *next, *prev; |
1219 | }; | |
1220 | ||
79fa9e0f | 1221 | #endif /* HAVE_WINDOW_SYSTEM */ |
d5cc60b8 KS |
1222 | |
1223 | \f | |
5f5c8ee5 GM |
1224 | /************************************************************************ |
1225 | Display Dimensions | |
1226 | ************************************************************************/ | |
1227 | ||
1228 | /* Return the height of the mode line in glyph matrix MATRIX, or zero | |
1229 | if not known. This macro is called under circumstances where | |
1230 | MATRIX might not have been allocated yet. */ | |
1231 | ||
1232 | #define MATRIX_MODE_LINE_HEIGHT(MATRIX) \ | |
1233 | ((MATRIX) && (MATRIX)->rows \ | |
1234 | ? MATRIX_MODE_LINE_ROW (MATRIX)->height \ | |
1235 | : 0) | |
1236 | ||
54bff0bd | 1237 | /* Return the height of the header line in glyph matrix MATRIX, or zero |
5f5c8ee5 GM |
1238 | if not known. This macro is called under circumstances where |
1239 | MATRIX might not have been allocated yet. */ | |
1240 | ||
045dee35 | 1241 | #define MATRIX_HEADER_LINE_HEIGHT(MATRIX) \ |
5f5c8ee5 | 1242 | ((MATRIX) && (MATRIX)->rows \ |
045dee35 | 1243 | ? MATRIX_HEADER_LINE_ROW (MATRIX)->height \ |
5f5c8ee5 GM |
1244 | : 0) |
1245 | ||
a4610492 KS |
1246 | /* Return the desired face id for the mode line of a window, depending |
1247 | on whether the window is selected or not, or if the window is the | |
1248 | scrolling window for the currently active minibuffer window. | |
1249 | ||
1250 | Due to the way display_mode_lines manipulates with the contents of | |
1251 | selected_window, this macro needs three arguments: SELW which is | |
1252 | compared against the current value of selected_window, MBW which is | |
1253 | compared against minibuf_window (if SELW doesn't match), and SCRW | |
5705966b | 1254 | which is compared against minibuf_selected_window (if MBW matches). */ |
a4610492 KS |
1255 | |
1256 | #define CURRENT_MODE_LINE_FACE_ID_3(SELW, MBW, SCRW) \ | |
5f380a5b | 1257 | ((!mode_line_in_non_selected_windows \ |
a4610492 | 1258 | || (SELW) == XWINDOW (selected_window) \ |
5f380a5b | 1259 | || (minibuf_level > 0 \ |
5705966b | 1260 | && !NILP (minibuf_selected_window) \ |
5f380a5b | 1261 | && (MBW) == XWINDOW (minibuf_window) \ |
5705966b | 1262 | && (SCRW) == XWINDOW (minibuf_selected_window))) \ |
a4610492 KS |
1263 | ? MODE_LINE_FACE_ID \ |
1264 | : MODE_LINE_INACTIVE_FACE_ID) | |
1265 | ||
1266 | ||
1267 | /* Return the desired face id for the mode line of window W. */ | |
f6911ea7 KS |
1268 | |
1269 | #define CURRENT_MODE_LINE_FACE_ID(W) \ | |
a4610492 | 1270 | (CURRENT_MODE_LINE_FACE_ID_3((W), XWINDOW (selected_window), (W))) |
f6911ea7 | 1271 | |
5f5c8ee5 | 1272 | /* Return the current height of the mode line of window W. If not |
e9e32f46 GM |
1273 | known from current_mode_line_height, look at W's current glyph |
1274 | matrix, or return a default based on the height of the font of the | |
1275 | face `mode-line'. */ | |
1276 | ||
1277 | #define CURRENT_MODE_LINE_HEIGHT(W) \ | |
1278 | (current_mode_line_height >= 0 \ | |
1279 | ? current_mode_line_height \ | |
1280 | : (MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \ | |
1281 | ? MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \ | |
1282 | : estimate_mode_line_height (XFRAME ((W)->frame), \ | |
f6911ea7 | 1283 | CURRENT_MODE_LINE_FACE_ID (W)))) |
5f5c8ee5 | 1284 | |
54bff0bd | 1285 | /* Return the current height of the header line of window W. If not |
e9e32f46 GM |
1286 | known from current_header_line_height, look at W's current glyph |
1287 | matrix, or return an estimation based on the height of the font of | |
1288 | the face `header-line'. */ | |
1289 | ||
1290 | #define CURRENT_HEADER_LINE_HEIGHT(W) \ | |
1291 | (current_header_line_height >= 0 \ | |
1292 | ? current_header_line_height \ | |
1293 | : (MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \ | |
1294 | ? MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \ | |
1295 | : estimate_mode_line_height (XFRAME ((W)->frame), \ | |
1296 | HEADER_LINE_FACE_ID))) | |
5f5c8ee5 GM |
1297 | |
1298 | /* Return the height of the desired mode line of window W. */ | |
1299 | ||
1300 | #define DESIRED_MODE_LINE_HEIGHT(W) \ | |
1301 | MATRIX_MODE_LINE_HEIGHT ((W)->desired_matrix) | |
1302 | ||
54bff0bd | 1303 | /* Return the height of the desired header line of window W. */ |
5f5c8ee5 | 1304 | |
045dee35 GM |
1305 | #define DESIRED_HEADER_LINE_HEIGHT(W) \ |
1306 | MATRIX_HEADER_LINE_HEIGHT ((W)->desired_matrix) | |
5f5c8ee5 | 1307 | |
54bff0bd | 1308 | /* Value is non-zero if window W wants a mode line. */ |
5f5c8ee5 GM |
1309 | |
1310 | #define WINDOW_WANTS_MODELINE_P(W) \ | |
2e8834ed | 1311 | (!MINI_WINDOW_P ((W)) \ |
5f5c8ee5 | 1312 | && !(W)->pseudo_window_p \ |
2e8834ed | 1313 | && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \ |
8801a864 | 1314 | && BUFFERP ((W)->buffer) \ |
2e8834ed | 1315 | && !NILP (XBUFFER ((W)->buffer)->mode_line_format) \ |
87388f9d | 1316 | && WINDOW_TOTAL_LINES (W) > 1) |
5f5c8ee5 | 1317 | |
54bff0bd | 1318 | /* Value is non-zero if window W wants a header line. */ |
5f5c8ee5 | 1319 | |
045dee35 | 1320 | #define WINDOW_WANTS_HEADER_LINE_P(W) \ |
2e8834ed | 1321 | (!MINI_WINDOW_P ((W)) \ |
5f5c8ee5 | 1322 | && !(W)->pseudo_window_p \ |
2e8834ed | 1323 | && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \ |
8801a864 | 1324 | && BUFFERP ((W)->buffer) \ |
2e8834ed | 1325 | && !NILP (XBUFFER ((W)->buffer)->header_line_format) \ |
87388f9d | 1326 | && WINDOW_TOTAL_LINES (W) > 1 + !NILP (XBUFFER ((W)->buffer)->mode_line_format)) |
5f5c8ee5 | 1327 | |
d74b2553 KS |
1328 | |
1329 | /* Return proper value to be used as baseline offset of font that has | |
1330 | ASCENT and DESCENT to draw characters by the font at the vertical | |
1331 | center of the line of frame F. | |
1332 | ||
1333 | Here, our task is to find the value of BOFF in the following figure; | |
1334 | ||
1335 | -------------------------+-----------+- | |
1336 | -+-+---------+-+ | | | |
1337 | | | | | | | | |
1338 | | | | | F_ASCENT F_HEIGHT | |
1339 | | | | ASCENT | | | |
1340 | HEIGHT | | | | | | |
1341 | | | |-|-+------+-----------|------- baseline | |
1342 | | | | | BOFF | | | |
1343 | | |---------|-+-+ | | | |
1344 | | | | DESCENT | | | |
1345 | -+-+---------+-+ F_DESCENT | | |
1346 | -------------------------+-----------+- | |
1347 | ||
1348 | -BOFF + DESCENT + (F_HEIGHT - HEIGHT) / 2 = F_DESCENT | |
1349 | BOFF = DESCENT + (F_HEIGHT - HEIGHT) / 2 - F_DESCENT | |
1350 | DESCENT = FONT->descent | |
1351 | HEIGHT = FONT_HEIGHT (FONT) | |
87388f9d | 1352 | F_DESCENT = (FRAME_FONT (F)->descent |
6ed8eeff | 1353 | - F->terminal->output_data.x->baseline_offset) |
d74b2553 KS |
1354 | F_HEIGHT = FRAME_LINE_HEIGHT (F) |
1355 | */ | |
1356 | ||
1357 | #define VCENTER_BASELINE_OFFSET(FONT, F) \ | |
1358 | (FONT_DESCENT (FONT) \ | |
1359 | + (FRAME_LINE_HEIGHT ((F)) - FONT_HEIGHT ((FONT)) \ | |
1360 | + (FRAME_LINE_HEIGHT ((F)) > FONT_HEIGHT ((FONT)))) / 2 \ | |
1361 | - (FONT_DESCENT (FRAME_FONT (F)) - FRAME_BASELINE_OFFSET (F))) | |
1362 | ||
177c0ea7 | 1363 | \f |
5f5c8ee5 GM |
1364 | /*********************************************************************** |
1365 | Faces | |
1366 | ***********************************************************************/ | |
177c0ea7 | 1367 | |
5f5c8ee5 GM |
1368 | /* Indices of face attributes in Lisp face vectors. Slot zero is the |
1369 | symbol `face'. */ | |
1370 | ||
1371 | enum lface_attribute_index | |
1372 | { | |
1373 | LFACE_FAMILY_INDEX = 1, | |
1374 | LFACE_SWIDTH_INDEX, | |
1375 | LFACE_HEIGHT_INDEX, | |
1376 | LFACE_WEIGHT_INDEX, | |
1377 | LFACE_SLANT_INDEX, | |
1378 | LFACE_UNDERLINE_INDEX, | |
1379 | LFACE_INVERSE_INDEX, | |
1380 | LFACE_FOREGROUND_INDEX, | |
1381 | LFACE_BACKGROUND_INDEX, | |
1382 | LFACE_STIPPLE_INDEX, | |
1383 | LFACE_OVERLINE_INDEX, | |
1384 | LFACE_STRIKE_THROUGH_INDEX, | |
1385 | LFACE_BOX_INDEX, | |
b3091a23 | 1386 | LFACE_FONT_INDEX, |
cd68bbe8 | 1387 | LFACE_INHERIT_INDEX, |
670019ba | 1388 | LFACE_AVGWIDTH_INDEX, |
5f5c8ee5 GM |
1389 | LFACE_VECTOR_SIZE |
1390 | }; | |
1391 | ||
1392 | ||
1393 | /* Box types of faces. */ | |
1394 | ||
1395 | enum face_box_type | |
1396 | { | |
1397 | /* No box around text. */ | |
1398 | FACE_NO_BOX, | |
1399 | ||
1400 | /* Simple box of specified width and color. Default width is 1, and | |
1401 | default color is the foreground color of the face. */ | |
1402 | FACE_SIMPLE_BOX, | |
1403 | ||
1404 | /* Boxes with 3D shadows. Color equals the background color of the | |
1405 | face. Width is specified. */ | |
1406 | FACE_RAISED_BOX, | |
1407 | FACE_SUNKEN_BOX | |
1408 | }; | |
1409 | ||
1410 | ||
1411 | /* Structure describing a realized face. | |
1412 | ||
1413 | For each Lisp face, 0..N realized faces can exist for different | |
1414 | frames and different charsets. Realized faces are built from Lisp | |
1415 | faces and text properties/overlays by merging faces and adding | |
1416 | unspecified attributes from the `default' face. */ | |
1417 | ||
9f2279ad | 1418 | struct face |
5f5c8ee5 GM |
1419 | { |
1420 | /* The id of this face. The id equals the index of this face in the | |
1421 | vector faces_by_id of its face cache. */ | |
1422 | int id; | |
1423 | ||
1424 | #ifdef HAVE_WINDOW_SYSTEM | |
177c0ea7 | 1425 | |
8016e514 EZ |
1426 | /* If non-zero, this is a GC that we can use without modification for |
1427 | drawing the characters in this face. */ | |
5f5c8ee5 | 1428 | GC gc; |
177c0ea7 | 1429 | |
5f5c8ee5 GM |
1430 | /* Font used for this face, or null if the font could not be loaded |
1431 | for some reason. This points to a `font' slot of a struct | |
1432 | font_info, and we should not call XFreeFont on it because the | |
1433 | font may still be used somewhere else. */ | |
1434 | XFontStruct *font; | |
1435 | ||
831fefca GM |
1436 | /* Background stipple or bitmap used for this face. This is |
1437 | an id as returned from load_pixmap. */ | |
1438 | int stipple; | |
5f5c8ee5 GM |
1439 | |
1440 | #else /* not HAVE_WINDOW_SYSTEM */ | |
1441 | ||
1442 | /* Dummy. */ | |
1443 | int stipple; | |
1444 | ||
1445 | #endif /* not HAVE_WINDOW_SYSTEM */ | |
1446 | ||
1447 | /* Pixel value of foreground color for X frames. Color index | |
1448 | for tty frames. */ | |
1449 | unsigned long foreground; | |
177c0ea7 | 1450 | |
5f5c8ee5 GM |
1451 | /* Pixel value or color index of background color. */ |
1452 | unsigned long background; | |
1453 | ||
1454 | /* Pixel value or color index of underline color. */ | |
1455 | unsigned long underline_color; | |
1456 | ||
1457 | /* Pixel value or color index of overlined, strike-through, or box | |
1458 | color. */ | |
1459 | unsigned long overline_color; | |
1460 | unsigned long strike_through_color; | |
1461 | unsigned long box_color; | |
1462 | ||
1463 | /* The font's name. This points to a `name' of a font_info, and it | |
1464 | must not be freed. */ | |
1465 | char *font_name; | |
1466 | ||
5f5c8ee5 GM |
1467 | /* Font info ID for this face's font. An ID is stored here because |
1468 | pointers to font_info structures may change. The reason is that | |
1469 | they are pointers into a font table vector that is itself | |
1470 | reallocated. */ | |
1471 | int font_info_id; | |
1472 | ||
1473 | /* Fontset ID if this face uses a fontset, or -1. This is only >= 0 | |
a90fbbf6 KH |
1474 | if the face was realized for a composition sequence. |
1475 | Otherwise, a specific font is loaded from the set of fonts | |
5f5c8ee5 GM |
1476 | specified by the fontset given by the family attribute of the face. */ |
1477 | int fontset; | |
177c0ea7 | 1478 | |
5f5c8ee5 GM |
1479 | /* Pixmap width and height. */ |
1480 | unsigned int pixmap_w, pixmap_h; | |
177c0ea7 | 1481 | |
5f5c8ee5 | 1482 | /* Non-zero means characters in this face have a box that thickness |
08f9976f KH |
1483 | around them. If it is negative, the absolute value indicates the |
1484 | thickness, and the horizontal lines of box (top and bottom) are | |
54bff0bd | 1485 | drawn inside of characters glyph area. The vertical lines of box |
08f9976f KH |
1486 | (left and right) are drawn as the same way as the case that this |
1487 | value is positive. */ | |
5f5c8ee5 GM |
1488 | int box_line_width; |
1489 | ||
1490 | /* Type of box drawn. A value of FACE_NO_BOX means no box is drawn | |
1491 | around text in this face. A value of FACE_SIMPLE_BOX means a box | |
1492 | of width box_line_width is drawn in color box_color. A value of | |
1493 | FACE_RAISED_BOX or FACE_SUNKEN_BOX means a 3D box is drawn with | |
1494 | shadow colors derived from the background color of the face. */ | |
1495 | enum face_box_type box; | |
1496 | ||
1497 | /* If `box' above specifies a 3D type, 1 means use box_color for | |
1498 | drawing shadows. */ | |
1499 | unsigned use_box_color_for_shadows_p : 1; | |
1500 | ||
1501 | /* The Lisp face attributes this face realizes. All attributes | |
1502 | in this vector are non-nil. */ | |
1503 | Lisp_Object lface[LFACE_VECTOR_SIZE]; | |
1504 | ||
1505 | /* The hash value of this face. */ | |
1506 | unsigned hash; | |
1507 | ||
1508 | /* The charset for which this face was realized if it was realized | |
a90fbbf6 KH |
1509 | for use in multibyte text. If fontset >= 0, this is the charset |
1510 | of the first character of the composition sequence. A value of | |
1511 | charset < 0 means the face was realized for use in unibyte text | |
1512 | where the idea of Emacs charsets isn't applicable. */ | |
5f5c8ee5 GM |
1513 | int charset; |
1514 | ||
1515 | /* Non-zero if text in this face should be underlined, overlined, | |
1516 | strike-through or have a box drawn around it. */ | |
1517 | unsigned underline_p : 1; | |
1518 | unsigned overline_p : 1; | |
1519 | unsigned strike_through_p : 1; | |
1520 | ||
1521 | /* 1 means that the colors specified for this face could not be | |
1522 | loaded, and were replaced by default colors, so they shouldn't be | |
1523 | freed. */ | |
1524 | unsigned foreground_defaulted_p : 1; | |
1525 | unsigned background_defaulted_p : 1; | |
1526 | ||
1527 | /* 1 means that either no color is specified for underlining or that | |
28b927d8 | 1528 | the specified color couldn't be loaded. Use the foreground |
5f5c8ee5 | 1529 | color when drawing in that case. */ |
177c0ea7 | 1530 | unsigned underline_defaulted_p : 1; |
5f5c8ee5 GM |
1531 | |
1532 | /* 1 means that either no color is specified for the corresponding | |
54bff0bd | 1533 | attribute or that the specified color couldn't be loaded. |
5f5c8ee5 GM |
1534 | Use the foreground color when drawing in that case. */ |
1535 | unsigned overline_color_defaulted_p : 1; | |
1536 | unsigned strike_through_color_defaulted_p : 1; | |
1537 | unsigned box_color_defaulted_p : 1; | |
1538 | ||
1539 | /* TTY appearances. Blinking is not yet implemented. Colors are | |
1540 | found in `lface' with empty color string meaning the default | |
1541 | color of the TTY. */ | |
1542 | unsigned tty_bold_p : 1; | |
1543 | unsigned tty_dim_p : 1; | |
1544 | unsigned tty_underline_p : 1; | |
1545 | unsigned tty_alt_charset_p : 1; | |
1546 | unsigned tty_reverse_p : 1; | |
1547 | unsigned tty_blinking_p : 1; | |
1548 | ||
dd387b25 GM |
1549 | /* 1 means that colors of this face may not be freed because they |
1550 | have been copied bitwise from a base face (see | |
1551 | realize_x_face). */ | |
1552 | unsigned colors_copied_bitwise_p : 1; | |
1553 | ||
11894ceb MB |
1554 | /* If non-zero, use overstrike (to simulate bold-face). */ |
1555 | unsigned overstrike : 1; | |
1556 | ||
5f5c8ee5 GM |
1557 | /* Next and previous face in hash collision list of face cache. */ |
1558 | struct face *next, *prev; | |
b3091a23 KH |
1559 | |
1560 | /* If this face is for ASCII characters, this points this face | |
1561 | itself. Otherwise, this points a face for ASCII characters. */ | |
1562 | struct face *ascii_face; | |
5f5c8ee5 GM |
1563 | }; |
1564 | ||
1565 | ||
1566 | /* Color index indicating that face uses a terminal's default color. */ | |
1567 | ||
1568 | #define FACE_TTY_DEFAULT_COLOR ((unsigned long) -1) | |
1569 | ||
f9d2fdc4 EZ |
1570 | /* Color index indicating that face uses an unknown foreground color. */ |
1571 | ||
1572 | #define FACE_TTY_DEFAULT_FG_COLOR ((unsigned long) -2) | |
1573 | ||
54bff0bd | 1574 | /* Color index indicating that face uses an unknown background color. */ |
f9d2fdc4 EZ |
1575 | |
1576 | #define FACE_TTY_DEFAULT_BG_COLOR ((unsigned long) -3) | |
1577 | ||
5f5c8ee5 GM |
1578 | /* Non-zero if FACE was realized for unibyte use. */ |
1579 | ||
1580 | #define FACE_UNIBYTE_P(FACE) ((FACE)->charset < 0) | |
1581 | ||
1582 | ||
1583 | /* IDs of important faces known by the C face code. These are the IDs | |
1584 | of the faces for CHARSET_ASCII. */ | |
1585 | ||
1586 | enum face_id | |
1587 | { | |
1588 | DEFAULT_FACE_ID, | |
1589 | MODE_LINE_FACE_ID, | |
f6911ea7 | 1590 | MODE_LINE_INACTIVE_FACE_ID, |
9ea173e8 | 1591 | TOOL_BAR_FACE_ID, |
afb7aabb | 1592 | FRINGE_FACE_ID, |
045dee35 | 1593 | HEADER_LINE_FACE_ID, |
76a6bc49 GM |
1594 | SCROLL_BAR_FACE_ID, |
1595 | BORDER_FACE_ID, | |
1596 | CURSOR_FACE_ID, | |
1597 | MOUSE_FACE_ID, | |
8317e104 | 1598 | MENU_FACE_ID, |
53abc3bf | 1599 | VERTICAL_BORDER_FACE_ID, |
5f5c8ee5 GM |
1600 | BASIC_FACE_ID_SENTINEL |
1601 | }; | |
1602 | ||
01b1f0c0 | 1603 | #define MAX_FACE_ID ((1 << FACE_ID_BITS) - 1) |
5f5c8ee5 GM |
1604 | |
1605 | /* A cache of realized faces. Each frame has its own cache because | |
1606 | Emacs allows different frame-local face definitions. */ | |
1607 | ||
1608 | struct face_cache | |
1609 | { | |
1610 | /* Hash table of cached realized faces. */ | |
1611 | struct face **buckets; | |
177c0ea7 | 1612 | |
5f5c8ee5 GM |
1613 | /* Back-pointer to the frame this cache belongs to. */ |
1614 | struct frame *f; | |
1615 | ||
1616 | /* A vector of faces so that faces can be referenced by an ID. */ | |
1617 | struct face **faces_by_id; | |
1618 | ||
1619 | /* The allocated size, and number of used slots of faces_by_id. */ | |
1620 | int size, used; | |
90893c55 GM |
1621 | |
1622 | /* Flag indicating that attributes of the `menu' face have been | |
1623 | changed. */ | |
1624 | unsigned menu_face_changed_p : 1; | |
5f5c8ee5 GM |
1625 | }; |
1626 | ||
1627 | ||
1628 | /* Prepare face FACE for use on frame F. This must be called before | |
1629 | using X resources of FACE. */ | |
1630 | ||
1631 | #define PREPARE_FACE_FOR_DISPLAY(F, FACE) \ | |
1632 | if ((FACE)->gc == 0) \ | |
1633 | prepare_face_for_display ((F), (FACE)); \ | |
1634 | else \ | |
1635 | (void) 0 | |
1636 | ||
1637 | /* Return a pointer to the face with ID on frame F, or null if such a | |
1638 | face doesn't exist. */ | |
1639 | ||
1640 | #define FACE_FROM_ID(F, ID) \ | |
c388b3c2 | 1641 | (((unsigned) (ID) < FRAME_FACE_CACHE (F)->used) \ |
5f5c8ee5 GM |
1642 | ? FRAME_FACE_CACHE (F)->faces_by_id[ID] \ |
1643 | : NULL) | |
1644 | ||
ff1a0d8e KH |
1645 | #ifdef HAVE_WINDOW_SYSTEM |
1646 | ||
b3091a23 KH |
1647 | /* Non-zero if FACE is suitable for displaying character CHAR. */ |
1648 | ||
1649 | #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) \ | |
1650 | (SINGLE_BYTE_CHAR_P (CHAR) \ | |
1651 | ? (FACE) == (FACE)->ascii_face \ | |
1652 | : face_suitable_for_char_p ((FACE), (CHAR))) | |
1653 | ||
5f5c8ee5 | 1654 | /* Return the id of the realized face on frame F that is like the face |
b3091a23 KH |
1655 | with id ID but is suitable for displaying character CHAR. |
1656 | This macro is only meaningful for multibyte character CHAR. */ | |
177c0ea7 | 1657 | |
b3091a23 KH |
1658 | #define FACE_FOR_CHAR(F, FACE, CHAR) \ |
1659 | (SINGLE_BYTE_CHAR_P (CHAR) \ | |
1660 | ? (FACE)->ascii_face->id \ | |
1661 | : face_for_char ((F), (FACE), (CHAR))) | |
5f5c8ee5 | 1662 | |
ff1a0d8e | 1663 | #else /* not HAVE_WINDOW_SYSTEM */ |
5f5c8ee5 | 1664 | |
ff1a0d8e KH |
1665 | #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) 1 |
1666 | #define FACE_FOR_CHAR(F, FACE, CHAR) ((FACE)->id) | |
1667 | ||
1668 | #endif /* not HAVE_WINDOW_SYSTEM */ | |
5f5c8ee5 GM |
1669 | |
1670 | /* Non-zero means face attributes have been changed since the last | |
1671 | redisplay. Used in redisplay_internal. */ | |
1672 | ||
1673 | extern int face_change_count; | |
1674 | ||
1675 | ||
1676 | ||
1677 | \f | |
f4e1400d KS |
1678 | /*********************************************************************** |
1679 | Fringes | |
1680 | ***********************************************************************/ | |
1681 | ||
f4e1400d KS |
1682 | /* Structure used to describe where and how to draw a fringe bitmap. |
1683 | WHICH is the fringe bitmap to draw. WD and H is the (adjusted) | |
1684 | width and height of the bitmap, DH is the height adjustment (if | |
1685 | bitmap is periodic). X and Y are frame coordinates of the area to | |
1686 | display the bitmap, DY is relative offset of the bitmap into that | |
0633d52c | 1687 | area. BX, NX, BY, NY specifies the area to clear if the bitmap |
f4e1400d KS |
1688 | does not fill the entire area. FACE is the fringe face. */ |
1689 | ||
1690 | struct draw_fringe_bitmap_params | |
1691 | { | |
2251a6f2 | 1692 | int which; /* enum fringe_bitmap_type */ |
12fde2dc | 1693 | unsigned short *bits; |
f4e1400d KS |
1694 | int wd, h, dh; |
1695 | int x, y; | |
1696 | int bx, nx, by, ny; | |
2251a6f2 KS |
1697 | unsigned cursor_p : 1; |
1698 | unsigned overlay_p : 1; | |
f4e1400d KS |
1699 | struct face *face; |
1700 | }; | |
1701 | ||
2251a6f2 | 1702 | #define MAX_FRINGE_BITMAPS (1<<FRINGE_ID_BITS) |
f4e1400d KS |
1703 | |
1704 | \f | |
5f5c8ee5 GM |
1705 | /*********************************************************************** |
1706 | Display Iterator | |
1707 | ***********************************************************************/ | |
1708 | ||
1709 | /* Iteration over things to display in current_buffer or in a string. | |
1710 | ||
1711 | The iterator handles: | |
1712 | ||
1713 | 1. Overlay strings (after-string, before-string). | |
1714 | 2. Face properties. | |
1715 | 3. Invisible text properties. | |
1716 | 4. Selective display. | |
1717 | 5. Translation of characters via display tables. | |
1718 | 6. Translation of control characters to the forms `\003' or `^C'. | |
1719 | 7. `glyph' and `space-width' properties. | |
1720 | ||
1721 | Iterators are initialized by calling init_iterator or one of the | |
1722 | equivalent functions below. A call to get_next_display_element | |
1723 | loads the iterator structure with information about what next to | |
1724 | display. A call to set_iterator_to_next increments the iterator's | |
1725 | position. | |
1726 | ||
1727 | Characters from overlay strings, display table entries or control | |
1728 | character translations are returned one at a time. For example, if | |
1729 | we have a text of `a\x01' where `a' has a display table definition | |
1730 | of `cd' and the control character is displayed with a leading | |
1731 | arrow, then the iterator will return: | |
1732 | ||
1733 | Call Return Source Call next | |
1734 | ----------------------------------------------------------------- | |
1735 | next c display table move | |
1736 | next d display table move | |
1737 | next ^ control char move | |
1738 | next A control char move | |
1739 | ||
1740 | The same mechanism is also used to return characters for ellipses | |
1741 | displayed at the end of invisible text. | |
1742 | ||
1743 | CAVEAT: Under some circumstances, move_.* functions can be called | |
1744 | asynchronously, e.g. when computing a buffer position from an x and | |
1745 | y pixel position. This means that these functions and functions | |
1746 | called from them SHOULD NOT USE xmalloc and alike. See also the | |
1747 | comment at the start of xdisp.c. */ | |
1748 | ||
1749 | /* Enumeration describing what kind of display element an iterator is | |
1750 | loaded with after a call to get_next_display_element. */ | |
1751 | ||
1752 | enum display_element_type | |
1753 | { | |
1754 | /* A normal character. */ | |
1755 | IT_CHARACTER, | |
1756 | ||
a90fbbf6 KH |
1757 | /* A composition sequence. */ |
1758 | IT_COMPOSITION, | |
1759 | ||
5f5c8ee5 GM |
1760 | /* An image. */ |
1761 | IT_IMAGE, | |
1762 | ||
1763 | /* A flexible width and height space. */ | |
1764 | IT_STRETCH, | |
1765 | ||
1766 | /* End of buffer or string. */ | |
1767 | IT_EOB, | |
1768 | ||
1769 | /* Truncation glyphs. Never returned by get_next_display_element. | |
1770 | Used to get display information about truncation glyphs via | |
1771 | produce_glyphs. */ | |
1772 | IT_TRUNCATION, | |
1773 | ||
1774 | /* Continuation glyphs. See the comment for IT_TRUNCATION. */ | |
1775 | IT_CONTINUATION | |
1776 | }; | |
1777 | ||
1778 | ||
1779 | /* An enumerator for each text property that has a meaning for display | |
1780 | purposes. */ | |
1781 | ||
1782 | enum prop_idx | |
1783 | { | |
1784 | FONTIFIED_PROP_IDX, | |
1785 | FACE_PROP_IDX, | |
1786 | INVISIBLE_PROP_IDX, | |
1787 | DISPLAY_PROP_IDX, | |
a90fbbf6 | 1788 | COMPOSITION_PROP_IDX, |
5f5c8ee5 GM |
1789 | |
1790 | /* Not a property. Used to indicate changes in overlays. */ | |
1791 | OVERLAY_PROP_IDX, | |
1792 | ||
1793 | /* Sentinel. */ | |
1794 | LAST_PROP_IDX | |
1795 | }; | |
1796 | ||
1797 | ||
0633d52c KS |
1798 | struct it_slice |
1799 | { | |
1800 | Lisp_Object x; | |
1801 | Lisp_Object y; | |
1802 | Lisp_Object width; | |
1803 | Lisp_Object height; | |
1804 | }; | |
1805 | ||
6a88f968 KS |
1806 | enum it_method { |
1807 | GET_FROM_BUFFER = 0, | |
1808 | GET_FROM_DISPLAY_VECTOR, | |
1809 | GET_FROM_COMPOSITION, | |
1810 | GET_FROM_STRING, | |
1811 | GET_FROM_C_STRING, | |
1812 | GET_FROM_IMAGE, | |
1813 | GET_FROM_STRETCH, | |
1814 | NUM_IT_METHODS | |
1815 | }; | |
0633d52c | 1816 | |
5f5c8ee5 GM |
1817 | struct it |
1818 | { | |
1819 | /* The window in which we iterate over current_buffer (or a string). */ | |
1820 | Lisp_Object window; | |
1821 | struct window *w; | |
1822 | ||
1823 | /* The window's frame. */ | |
1824 | struct frame *f; | |
1825 | ||
6a88f968 KS |
1826 | /* Method to use to load this structure with the next display element. */ |
1827 | enum it_method method; | |
5f5c8ee5 GM |
1828 | |
1829 | /* The next position at which to check for face changes, invisible | |
1830 | text, overlay strings, end of text etc., which see. */ | |
1831 | int stop_charpos; | |
1832 | ||
1833 | /* Maximum string or buffer position + 1. ZV when iterating over | |
1834 | current_buffer. */ | |
1835 | int end_charpos; | |
1836 | ||
1837 | /* C string to iterate over. Non-null means get characters from | |
1838 | this string, otherwise characters are read from current_buffer | |
1839 | or it->string. */ | |
1840 | unsigned char *s; | |
1841 | ||
1842 | /* Number of characters in the string (s, or it->string) we iterate | |
1843 | over. */ | |
1844 | int string_nchars; | |
1845 | ||
1846 | /* Start and end of a visible region; -1 if the region is not | |
1847 | visible in the window. */ | |
1848 | int region_beg_charpos, region_end_charpos; | |
1849 | ||
1850 | /* Position at which redisplay end trigger functions should be run. */ | |
1851 | int redisplay_end_trigger_charpos; | |
1852 | ||
1853 | /* 1 means multibyte characters are enabled. */ | |
1854 | unsigned multibyte_p : 1; | |
1855 | ||
5f5c8ee5 | 1856 | /* 1 means window has a mode line at its top. */ |
045dee35 | 1857 | unsigned header_line_p : 1; |
5f5c8ee5 GM |
1858 | |
1859 | /* 1 means `string' is the value of a `display' property. | |
1860 | Don't handle some `display' properties in these strings. */ | |
1861 | unsigned string_from_display_prop_p : 1; | |
1862 | ||
b437860a RS |
1863 | /* When METHOD == next_element_from_display_vector, |
1864 | this is 1 if we're doing an ellipsis. Otherwise meaningless. */ | |
1865 | unsigned ellipsis_p : 1; | |
1866 | ||
5f5c8ee5 GM |
1867 | /* Display table in effect or null for none. */ |
1868 | struct Lisp_Char_Table *dp; | |
1869 | ||
1870 | /* Current display table vector to return characters from and its | |
1871 | end. dpvec null means we are not returning characters from a | |
1872 | display table entry; current.dpvec_index gives the current index | |
1873 | into dpvec. This same mechanism is also used to return | |
1874 | characters from translated control characters, i.e. `\003' or | |
1875 | `^C'. */ | |
1876 | Lisp_Object *dpvec, *dpend; | |
1877 | ||
1878 | /* Length in bytes of the char that filled dpvec. A value of zero | |
54bff0bd | 1879 | means that no such character is involved. */ |
5f5c8ee5 GM |
1880 | int dpvec_char_len; |
1881 | ||
888ca1e7 KS |
1882 | /* Face id to use for all characters in display vector. -1 if unused. */ |
1883 | int dpvec_face_id; | |
1884 | ||
5f5c8ee5 GM |
1885 | /* Face id of the iterator saved in case a glyph from dpvec contains |
1886 | a face. The face is restored when all glyphs from dpvec have | |
1887 | been delivered. */ | |
1888 | int saved_face_id; | |
1889 | ||
1890 | /* Vector of glyphs for control character translation. The pointer | |
4659838f KH |
1891 | dpvec is set to ctl_chars when a control character is translated. |
1892 | This vector is also used for incomplete multibyte character | |
8d5b986d GM |
1893 | translation (e.g \222\244). Such a character is at most 4 bytes, |
1894 | thus we need at most 16 bytes here. */ | |
1895 | Lisp_Object ctl_chars[16]; | |
5f5c8ee5 | 1896 | |
67435182 KS |
1897 | /* Initial buffer or string position of the iterator, before skipping |
1898 | over display properties and invisible text. */ | |
1899 | struct display_pos start; | |
1900 | ||
5f5c8ee5 GM |
1901 | /* Current buffer or string position of the iterator, including |
1902 | position in overlay strings etc. */ | |
1903 | struct display_pos current; | |
1904 | ||
1905 | /* Vector of overlays to process. Overlay strings are processed | |
1906 | OVERLAY_STRING_CHUNK_SIZE at a time. */ | |
e9323aed | 1907 | #define OVERLAY_STRING_CHUNK_SIZE 16 |
5f5c8ee5 GM |
1908 | Lisp_Object overlay_strings[OVERLAY_STRING_CHUNK_SIZE]; |
1909 | ||
1910 | /* Total number of overlay strings to process. This can be > | |
1911 | OVERLAY_STRING_CHUNK_SIZE. */ | |
1912 | int n_overlay_strings; | |
1913 | ||
1914 | /* If non-nil, a Lisp string being processed. If | |
1915 | current.overlay_string_index >= 0, this is an overlay string from | |
1916 | pos. */ | |
1917 | Lisp_Object string; | |
1918 | ||
1919 | /* Stack of saved values. New entries are pushed when we begin to | |
1920 | process an overlay string or a string from a `glyph' property. | |
1921 | Entries are popped when we return to deliver display elements | |
1922 | from what we previously had. */ | |
1923 | struct iterator_stack_entry | |
9f2279ad | 1924 | { |
5f5c8ee5 GM |
1925 | int stop_charpos; |
1926 | int face_id; | |
1927 | Lisp_Object string; | |
1928 | struct display_pos pos; | |
1929 | int end_charpos; | |
1930 | int string_nchars; | |
1931 | enum glyph_row_area area; | |
1932 | unsigned multibyte_p : 1; | |
1933 | unsigned string_from_display_prop_p : 1; | |
88378b0d | 1934 | unsigned display_ellipsis_p : 1; |
0633d52c | 1935 | struct it_slice slice; |
5f5c8ee5 GM |
1936 | Lisp_Object space_width; |
1937 | short voffset; | |
1938 | Lisp_Object font_height; | |
1939 | } | |
1940 | stack[2]; | |
dfbb1e90 | 1941 | |
5f5c8ee5 GM |
1942 | /* Stack pointer. */ |
1943 | int sp; | |
177c0ea7 | 1944 | |
5f5c8ee5 GM |
1945 | /* Setting of buffer-local variable selective-display-ellipsis. */ |
1946 | unsigned selective_display_ellipsis_p : 1; | |
1947 | ||
1948 | /* 1 means control characters are translated into the form `^C' | |
1949 | where the `^' can be replaced by a display table entry. */ | |
1950 | unsigned ctl_arrow_p : 1; | |
1951 | ||
1952 | /* -1 means selective display hides everything between a \r and the | |
1953 | next newline; > 0 means hide lines indented more than that value. */ | |
1954 | int selective; | |
1955 | ||
1956 | /* An enumeration describing what the next display element is | |
1957 | after a call to get_next_display_element. */ | |
1958 | enum display_element_type what; | |
dfbb1e90 | 1959 | |
5f5c8ee5 GM |
1960 | /* Face to use. */ |
1961 | int face_id; | |
1962 | ||
1963 | /* Non-zero means that the current face has a box. */ | |
1964 | unsigned face_box_p : 1; | |
1965 | ||
1966 | /* Non-null means that the current character is the first in a run | |
1967 | of characters with box face. */ | |
1968 | unsigned start_of_box_run_p : 1; | |
177c0ea7 | 1969 | |
5f5c8ee5 GM |
1970 | /* Non-zero means that the current character is the last in a run |
1971 | of characters with box face. */ | |
1972 | unsigned end_of_box_run_p : 1; | |
1973 | ||
1974 | /* 1 means overlay strings at end_charpos have been processed. */ | |
1975 | unsigned overlay_strings_at_end_processed_p : 1; | |
1976 | ||
fcc38f6d KS |
1977 | /* 1 means to ignore overlay strings at current pos, as they have |
1978 | already been processed. */ | |
1979 | unsigned ignore_overlay_strings_at_pos_p : 1; | |
1980 | ||
b3091a23 KH |
1981 | /* 1 means the actual glyph is not available in the current |
1982 | system. */ | |
666852af GM |
1983 | unsigned glyph_not_available_p : 1; |
1984 | ||
1985 | /* 1 means the next line in display_line continues a character | |
1986 | consisting of more than one glyph, and some glyphs of this | |
1987 | character have been put on the previous line. */ | |
1988 | unsigned starts_in_middle_of_char_p : 1; | |
b3091a23 | 1989 | |
4d2036e4 GM |
1990 | /* If 1, saved_face_id contains the id of the face in front of text |
1991 | skipped due to selective display. */ | |
1992 | unsigned face_before_selective_p : 1; | |
1993 | ||
0633d52c | 1994 | /* If 1, adjust current glyph so it does not increase current row |
7293ac29 | 1995 | descent/ascent (line-height property). Reset after this glyph. */ |
0633d52c KS |
1996 | unsigned constrain_row_ascent_descent_p : 1; |
1997 | ||
5f5c8ee5 | 1998 | /* The ID of the default face to use. One of DEFAULT_FACE_ID, |
4d2036e4 | 1999 | MODE_LINE_FACE_ID, etc, depending on what we are displaying. */ |
5f5c8ee5 GM |
2000 | int base_face_id; |
2001 | ||
2002 | /* If what == IT_CHARACTER, character and length in bytes. This is | |
2003 | a character from a buffer or string. It may be different from | |
2004 | the character displayed in case that | |
a90fbbf6 KH |
2005 | unibyte_display_via_language_environment is set. |
2006 | ||
2007 | If what == IT_COMPOSITION, the first component of a composition | |
2008 | and length in bytes of the composition. */ | |
5f5c8ee5 GM |
2009 | int c, len; |
2010 | ||
a90fbbf6 KH |
2011 | /* If what == IT_COMPOSITION, identification number and length in |
2012 | chars of a composition. */ | |
2013 | int cmp_id, cmp_len; | |
2014 | ||
5f5c8ee5 GM |
2015 | /* The character to display, possibly translated to multibyte |
2016 | if unibyte_display_via_language_environment is set. This | |
d5cc60b8 | 2017 | is set after produce_glyphs has been called. */ |
5f5c8ee5 GM |
2018 | int char_to_display; |
2019 | ||
5f5c8ee5 GM |
2020 | /* If what == IT_IMAGE, the id of the image to display. */ |
2021 | int image_id; | |
2022 | ||
0633d52c KS |
2023 | /* Values from `slice' property. */ |
2024 | struct it_slice slice; | |
2025 | ||
5f5c8ee5 GM |
2026 | /* Value of the `space-width' property, if any; nil if none. */ |
2027 | Lisp_Object space_width; | |
2028 | ||
2029 | /* Computed from the value of the `raise' property. */ | |
2030 | short voffset; | |
2031 | ||
2032 | /* Value of the `height' property, if any; nil if none. */ | |
2033 | Lisp_Object font_height; | |
2034 | ||
2035 | /* Object and position where the current display element came from. | |
2036 | Object can be a Lisp string in case the current display element | |
f38e5748 KS |
2037 | comes from an overlay string, or it is buffer. It may also be nil |
2038 | during mode-line update. Position is a position in object. */ | |
5f5c8ee5 GM |
2039 | Lisp_Object object; |
2040 | struct text_pos position; | |
2041 | ||
2042 | /* 1 means lines are truncated. */ | |
2043 | unsigned truncate_lines_p : 1; | |
2044 | ||
2045 | /* Number of columns per \t. */ | |
2046 | short tab_width; | |
2047 | ||
2048 | /* Width in pixels of truncation and continuation glyphs. */ | |
2049 | short truncation_pixel_width, continuation_pixel_width; | |
2050 | ||
2051 | /* First and last visible x-position in the display area. If window | |
87388f9d | 2052 | is hscrolled by n columns, first_visible_x == n * FRAME_COLUMN_WIDTH |
5f5c8ee5 GM |
2053 | (f), and last_visible_x == pixel width of W + first_visible_x. */ |
2054 | int first_visible_x, last_visible_x; | |
2055 | ||
2056 | /* Last visible y-position + 1 in the display area without a mode | |
2057 | line, if the window has one. */ | |
2058 | int last_visible_y; | |
2059 | ||
db0c5a7d KS |
2060 | /* Default amount of additional space in pixels between lines (for |
2061 | window systems only.) */ | |
bf95c413 | 2062 | int extra_line_spacing; |
5f5c8ee5 | 2063 | |
db0c5a7d KS |
2064 | /* Max extra line spacing added in this row. */ |
2065 | int max_extra_line_spacing; | |
2066 | ||
d956147c KS |
2067 | /* Override font height information for this glyph. |
2068 | Used if override_ascent >= 0. Cleared after this glyph. */ | |
2069 | int override_ascent, override_descent, override_boff; | |
2070 | ||
5f5c8ee5 GM |
2071 | /* If non-null, glyphs are produced in glyph_row with each call to |
2072 | produce_glyphs. */ | |
2073 | struct glyph_row *glyph_row; | |
2074 | ||
2075 | /* The area of glyph_row to which glyphs are added. */ | |
2076 | enum glyph_row_area area; | |
2077 | ||
2078 | /* Number of glyphs needed for the last character requested via | |
2079 | produce_glyphs. This is 1 except for tabs. */ | |
2080 | int nglyphs; | |
177c0ea7 | 2081 | |
5f5c8ee5 GM |
2082 | /* Width of the display element in pixels. Result of |
2083 | produce_glyphs. */ | |
2084 | int pixel_width; | |
2085 | ||
2febf6e0 GM |
2086 | /* Current, maximum logical, and maximum physical line height |
2087 | information. Result of produce_glyphs. */ | |
5f5c8ee5 | 2088 | int ascent, descent, max_ascent, max_descent; |
2febf6e0 | 2089 | int phys_ascent, phys_descent, max_phys_ascent, max_phys_descent; |
5f5c8ee5 GM |
2090 | |
2091 | /* Current x pixel position within the display line. This value | |
2092 | does not include the width of continuation lines in front of the | |
2093 | line. The value of current_x is automatically incremented by | |
2094 | pixel_width with each call to produce_glyphs. */ | |
2095 | int current_x; | |
2096 | ||
2097 | /* Accumulated width of continuation lines. If > 0, this means we | |
2098 | are currently in a continuation line. This is initially zero and | |
2099 | incremented/reset by display_line, move_it_to etc. */ | |
2100 | int continuation_lines_width; | |
2101 | ||
2102 | /* Current y-position. Automatically incremented by the height of | |
2103 | glyph_row in move_it_to and display_line. */ | |
2104 | int current_y; | |
2105 | ||
ed7d07bd KS |
2106 | /* Vertical matrix position of first text line in window. */ |
2107 | int first_vpos; | |
2108 | ||
5f5c8ee5 GM |
2109 | /* Current vertical matrix position, or line number. Automatically |
2110 | incremented by move_it_to and display_line. */ | |
2111 | int vpos; | |
2112 | ||
2113 | /* Horizontal matrix position reached in move_it_in_display_line. | |
2114 | Only set there, not in display_line. */ | |
2115 | int hpos; | |
2251a6f2 KS |
2116 | |
2117 | /* Left fringe bitmap number (enum fringe_bitmap_type). */ | |
2118 | unsigned left_user_fringe_bitmap : FRINGE_ID_BITS; | |
2119 | ||
2251a6f2 KS |
2120 | /* Right fringe bitmap number (enum fringe_bitmap_type). */ |
2121 | unsigned right_user_fringe_bitmap : FRINGE_ID_BITS; | |
2122 | ||
b3b08f03 KS |
2123 | /* Face of the left fringe glyph. */ |
2124 | unsigned left_user_fringe_face_id : FACE_ID_BITS; | |
2125 | ||
2251a6f2 KS |
2126 | /* Face of the right fringe glyph. */ |
2127 | unsigned right_user_fringe_face_id : FACE_ID_BITS; | |
5f5c8ee5 GM |
2128 | }; |
2129 | ||
2130 | ||
2131 | /* Access to positions of iterator IT. */ | |
2132 | ||
2133 | #define IT_CHARPOS(IT) CHARPOS ((IT).current.pos) | |
2134 | #define IT_BYTEPOS(IT) BYTEPOS ((IT).current.pos) | |
2135 | #define IT_STRING_CHARPOS(IT) CHARPOS ((IT).current.string_pos) | |
2136 | #define IT_STRING_BYTEPOS(IT) BYTEPOS ((IT).current.string_pos) | |
2137 | ||
2138 | /* Test if IT has reached the end of its buffer or string. This will | |
2139 | only work after get_next_display_element has been called. */ | |
2140 | ||
2141 | #define ITERATOR_AT_END_P(IT) ((IT)->what == IT_EOB) | |
2142 | ||
2143 | /* Non-zero means IT is at the end of a line. This is the case if it | |
2144 | is either on a newline or on a carriage return and selective | |
2145 | display hides the rest of the line. */ | |
2146 | ||
2147 | #define ITERATOR_AT_END_OF_LINE_P(IT) \ | |
2148 | ((IT)->what == IT_CHARACTER \ | |
2149 | && ((IT)->c == '\n' \ | |
2150 | || ((IT)->c == '\r' && (IT)->selective))) | |
2151 | ||
2152 | /* Call produce_glyphs or produce_glyphs_hook, if set. Shortcut to | |
2153 | avoid the function call overhead. */ | |
2154 | ||
fa971ac3 KL |
2155 | #define PRODUCE_GLYPHS(IT) \ |
2156 | do { \ | |
2157 | extern int inhibit_free_realized_faces; \ | |
2158 | if (FRAME_RIF ((IT)->f) != NULL) \ | |
2159 | FRAME_RIF ((IT)->f)->produce_glyphs ((IT)); \ | |
2160 | else \ | |
2161 | produce_glyphs ((IT)); \ | |
2162 | if ((IT)->glyph_row != NULL) \ | |
2163 | inhibit_free_realized_faces = 1; \ | |
2164 | } while (0) | |
5f5c8ee5 GM |
2165 | |
2166 | /* Bit-flags indicating what operation move_it_to should perform. */ | |
2167 | ||
2168 | enum move_operation_enum | |
2169 | { | |
2170 | /* Stop if specified x-position is reached. */ | |
2171 | MOVE_TO_X = 0x01, | |
2172 | ||
2173 | /* Stop if specified y-position is reached. */ | |
2174 | MOVE_TO_Y = 0x02, | |
2175 | ||
2176 | /* Stop if specified vpos is reached. */ | |
2177 | MOVE_TO_VPOS = 0x04, | |
2178 | ||
2179 | /* Stop if specified buffer or string position is reached. */ | |
2180 | MOVE_TO_POS = 0x08 | |
2181 | }; | |
2182 | ||
2183 | ||
2184 | \f | |
2185 | /*********************************************************************** | |
2186 | Window-based redisplay interface | |
2187 | ***********************************************************************/ | |
2188 | ||
2189 | /* Structure used to describe runs of lines that must be scrolled. */ | |
2190 | ||
2191 | struct run | |
2192 | { | |
2193 | /* Source and destination y pixel position. */ | |
2194 | int desired_y, current_y; | |
2195 | ||
2196 | /* Source and destination vpos in matrix. */ | |
2197 | int desired_vpos, current_vpos; | |
2198 | ||
2199 | /* Height in pixels, number of glyph rows. */ | |
2200 | int height, nrows; | |
2201 | }; | |
2202 | ||
2203 | ||
e6b3aecd KS |
2204 | /* Handlers for setting frame parameters. */ |
2205 | ||
2206 | typedef void (*frame_parm_handler) P_ ((struct frame *, Lisp_Object, Lisp_Object)); | |
2207 | ||
2208 | ||
5f5c8ee5 GM |
2209 | /* Structure holding system-dependent interface functions needed |
2210 | for window-based redisplay. */ | |
2211 | ||
2212 | struct redisplay_interface | |
2213 | { | |
e6b3aecd KS |
2214 | /* Handlers for setting frame parameters. */ |
2215 | frame_parm_handler *frame_parm_handlers; | |
2216 | ||
5f5c8ee5 GM |
2217 | /* Produce glyphs/get display metrics for the display element IT is |
2218 | loaded with. */ | |
2219 | void (*produce_glyphs) P_ ((struct it *it)); | |
177c0ea7 | 2220 | |
5f5c8ee5 GM |
2221 | /* Write or insert LEN glyphs from STRING at the nominal output |
2222 | position. */ | |
2223 | void (*write_glyphs) P_ ((struct glyph *string, int len)); | |
2224 | void (*insert_glyphs) P_ ((struct glyph *start, int len)); | |
2225 | ||
2226 | /* Clear from nominal output position to X. X < 0 means clear | |
2227 | to right end of display. */ | |
2228 | void (*clear_end_of_line) P_ ((int x)); | |
177c0ea7 | 2229 | |
5f5c8ee5 GM |
2230 | /* Function to call to scroll the display as described by RUN on |
2231 | window W. */ | |
2232 | void (*scroll_run_hook) P_ ((struct window *w, struct run *run)); | |
2233 | ||
2234 | /* Function to call after a line in a display has been completely | |
2235 | updated. Used to draw truncation marks and alike. DESIRED_ROW | |
2236 | is the desired row which has been updated. */ | |
2237 | void (*after_update_window_line_hook) P_ ((struct glyph_row *desired_row)); | |
42087301 | 2238 | |
5f5c8ee5 GM |
2239 | /* Function to call before beginning to update window W in |
2240 | window-based redisplay. */ | |
2241 | void (*update_window_begin_hook) P_ ((struct window *w)); | |
2242 | ||
2243 | /* Function to call after window W has been updated in window-based | |
712eaef2 GM |
2244 | redisplay. CURSOR_ON_P non-zero means switch cursor on. |
2245 | MOUSE_FACE_OVERWRITTEN_P non-zero means that some lines in W | |
2246 | that contained glyphs in mouse-face were overwritten, so we | |
54bff0bd | 2247 | have to update the mouse highlight. */ |
712eaef2 GM |
2248 | void (*update_window_end_hook) P_ ((struct window *w, int cursor_on_p, |
2249 | int mouse_face_overwritten_p)); | |
177c0ea7 | 2250 | |
5f5c8ee5 GM |
2251 | /* Move cursor to row/column position VPOS/HPOS, pixel coordinates |
2252 | Y/X. HPOS/VPOS are window-relative row and column numbers and X/Y | |
2253 | are window-relative pixel positions. */ | |
2254 | void (*cursor_to) P_ ((int vpos, int hpos, int y, int x)); | |
2255 | ||
2256 | /* Flush the display of frame F. For X, this is XFlush. */ | |
2257 | void (*flush_display) P_ ((struct frame *f)); | |
2258 | ||
d74b2553 KS |
2259 | /* Flush the display of frame F if non-NULL. This is called |
2260 | during redisplay, and should be NULL on systems which flushes | |
2261 | automatically before reading input. */ | |
2262 | void (*flush_display_optional) P_ ((struct frame *f)); | |
2263 | ||
ec68e323 | 2264 | /* Clear the mouse hightlight in window W, if there is any. */ |
d74b2553 | 2265 | void (*clear_window_mouse_face) P_ ((struct window *w)); |
712eaef2 | 2266 | |
5f5c8ee5 GM |
2267 | /* Set *LEFT and *RIGHT to the left and right overhang of GLYPH on |
2268 | frame F. */ | |
2269 | void (*get_glyph_overhangs) P_ ((struct glyph *glyph, struct frame *f, | |
2270 | int *left, int *right)); | |
2febf6e0 GM |
2271 | |
2272 | /* Fix the display of AREA of ROW in window W for overlapping rows. | |
2273 | This function is called from redraw_overlapping_rows after | |
2274 | desired rows have been made current. */ | |
2275 | void (*fix_overlapping_area) P_ ((struct window *w, struct glyph_row *row, | |
10a07952 | 2276 | enum glyph_row_area area, int)); |
f4e1400d | 2277 | |
79fa9e0f KS |
2278 | #ifdef HAVE_WINDOW_SYSTEM |
2279 | ||
f4e1400d KS |
2280 | /* Draw a fringe bitmap in window W of row ROW using parameters P. */ |
2281 | void (*draw_fringe_bitmap) P_ ((struct window *w, struct glyph_row *row, | |
2282 | struct draw_fringe_bitmap_params *p)); | |
2283 | ||
2251a6f2 | 2284 | /* Define and destroy fringe bitmap no. WHICH. */ |
12fde2dc | 2285 | void (*define_fringe_bitmap) P_ ((int which, unsigned short *bits, |
2251a6f2 KS |
2286 | int h, int wd)); |
2287 | void (*destroy_fringe_bitmap) P_ ((int which)); | |
2288 | ||
d5cc60b8 KS |
2289 | /* Get metrics of character CHAR2B in FONT of type FONT_TYPE. |
2290 | Value is null if CHAR2B is not contained in the font. */ | |
2291 | XCharStruct * (*per_char_metric) P_ ((XFontStruct *font, XChar2b *char2b, | |
2292 | int font_type)); | |
2293 | ||
2294 | /* Encode CHAR2B using encoding information from FONT_INFO. CHAR2B is | |
2295 | the two-byte form of C. Encoding is returned in *CHAR2B. If | |
2296 | TWO_BYTE_P is non-null, return non-zero there if font is two-byte. */ | |
2297 | int (*encode_char) P_ ((int c, XChar2b *char2b, | |
2298 | struct font_info *font_into, int *two_byte_p)); | |
2299 | ||
0633d52c | 2300 | /* Compute left and right overhang of glyph string S. |
d5cc60b8 KS |
2301 | A NULL pointer if platform does not support this. */ |
2302 | void (*compute_glyph_string_overhangs) P_ ((struct glyph_string *s)); | |
2303 | ||
2304 | /* Draw a glyph string S. */ | |
2305 | void (*draw_glyph_string) P_ ((struct glyph_string *s)); | |
2306 | ||
d74b2553 KS |
2307 | /* Define cursor CURSOR on frame F. */ |
2308 | void (*define_frame_cursor) P_ ((struct frame *f, Cursor cursor)); | |
5f5c8ee5 | 2309 | |
d74b2553 KS |
2310 | /* Clear the area at (X,Y,WIDTH,HEIGHT) of frame F. */ |
2311 | void (*clear_frame_area) P_ ((struct frame *f, int x, int y, | |
2312 | int width, int height)); | |
5f5c8ee5 | 2313 | |
e5a3b7d9 KS |
2314 | /* Draw specified cursor CURSOR_TYPE of width CURSOR_WIDTH |
2315 | at row GLYPH_ROW on window W if ON_P is 1. If ON_P is | |
2316 | 0, don't draw cursor. If ACTIVE_P is 1, system caret | |
2317 | should track this cursor (when applicable). */ | |
d74b2553 KS |
2318 | void (*draw_window_cursor) P_ ((struct window *w, |
2319 | struct glyph_row *glyph_row, | |
e5a3b7d9 KS |
2320 | int x, int y, |
2321 | int cursor_type, int cursor_width, | |
2322 | int on_p, int active_p)); | |
5f5c8ee5 | 2323 | |
d74b2553 KS |
2324 | /* Draw vertical border for window W from (X,Y0) to (X,Y1). */ |
2325 | void (*draw_vertical_window_border) P_ ((struct window *w, | |
2326 | int x, int y0, int y1)); | |
d5cc60b8 | 2327 | |
0633d52c | 2328 | /* Shift display of frame F to make room for inserted glyphs. |
d74b2553 KS |
2329 | The area at pixel (X,Y) of width WIDTH and height HEIGHT is |
2330 | shifted right by SHIFT_BY pixels. */ | |
2331 | void (*shift_glyphs_for_insert) P_ ((struct frame *f, | |
2332 | int x, int y, int width, | |
2333 | int height, int shift_by)); | |
d5cc60b8 | 2334 | |
d74b2553 KS |
2335 | #endif /* HAVE_WINDOW_SYSTEM */ |
2336 | }; | |
d5cc60b8 | 2337 | |
5f5c8ee5 GM |
2338 | \f |
2339 | /*********************************************************************** | |
2340 | Images | |
2341 | ***********************************************************************/ | |
2342 | ||
4397e334 | 2343 | #ifdef HAVE_WINDOW_SYSTEM |
5f5c8ee5 GM |
2344 | |
2345 | /* Structure forward declarations. */ | |
2346 | ||
2347 | struct image; | |
2348 | ||
2349 | ||
54bff0bd | 2350 | /* Each image format (JPEG, TIFF, ...) supported is described by |
5f5c8ee5 GM |
2351 | a structure of the type below. */ |
2352 | ||
2353 | struct image_type | |
2354 | { | |
2355 | /* A symbol uniquely identifying the image type, .e.g `jpeg'. */ | |
2356 | Lisp_Object *type; | |
2357 | ||
2358 | /* Check that SPEC is a valid image specification for the given | |
2359 | image type. Value is non-zero if SPEC is valid. */ | |
2360 | int (* valid_p) P_ ((Lisp_Object spec)); | |
2361 | ||
2362 | /* Load IMG which is used on frame F from information contained in | |
2363 | IMG->spec. Value is non-zero if successful. */ | |
2364 | int (* load) P_ ((struct frame *f, struct image *img)); | |
2365 | ||
2366 | /* Free resources of image IMG which is used on frame F. */ | |
2367 | void (* free) P_ ((struct frame *f, struct image *img)); | |
9f2279ad | 2368 | |
5f5c8ee5 GM |
2369 | /* Next in list of all supported image types. */ |
2370 | struct image_type *next; | |
2371 | }; | |
9f2279ad | 2372 | |
9f2279ad | 2373 | |
5f5c8ee5 GM |
2374 | /* Structure describing an image. Specific image formats like XBM are |
2375 | converted into this form, so that display only has to deal with | |
2376 | this type of image. */ | |
9f2279ad | 2377 | |
5f5c8ee5 GM |
2378 | struct image |
2379 | { | |
2380 | /* The time in seconds at which the image was last displayed. Set | |
2381 | in prepare_image_for_display. */ | |
2382 | unsigned long timestamp; | |
9f2279ad | 2383 | |
5f5c8ee5 GM |
2384 | /* Pixmaps of the image. */ |
2385 | Pixmap pixmap, mask; | |
9f2279ad | 2386 | |
5f5c8ee5 GM |
2387 | /* Colors allocated for this image, if any. Allocated via xmalloc. */ |
2388 | unsigned long *colors; | |
2389 | int ncolors; | |
9f2279ad | 2390 | |
0ff7c0d4 MB |
2391 | /* A single `background color' for this image, for the use of anyone that |
2392 | cares about such a thing. Only valid if the `background_valid' field | |
2393 | is true. This should generally be accessed by calling the accessor | |
2394 | macro `IMAGE_BACKGROUND', which will heuristically calculate a value | |
2395 | if necessary. */ | |
2396 | unsigned long background; | |
2397 | ||
2398 | /* True if this image has a `transparent' background -- that is, is | |
2399 | uses an image mask. The accessor macro for this is | |
2400 | `IMAGE_BACKGROUND_TRANSPARENT'. */ | |
2401 | unsigned background_transparent : 1; | |
2402 | ||
2403 | /* True if the `background' and `background_transparent' fields are | |
2404 | valid, respectively. */ | |
2405 | unsigned background_valid : 1, background_transparent_valid : 1; | |
2406 | ||
5f5c8ee5 GM |
2407 | /* Width and height of the image. */ |
2408 | int width, height; | |
87485d6f | 2409 | |
5f5c8ee5 GM |
2410 | /* These values are used for the rectangles displayed for images |
2411 | that can't be loaded. */ | |
2412 | #define DEFAULT_IMAGE_WIDTH 30 | |
2413 | #define DEFAULT_IMAGE_HEIGHT 30 | |
9f2279ad | 2414 | |
bdda7eb0 | 2415 | /* Percent of image height used as ascent. A value of |
54bff0bd | 2416 | CENTERED_IMAGE_ASCENT means draw the image centered on the |
bdda7eb0 | 2417 | line. */ |
5f5c8ee5 GM |
2418 | int ascent; |
2419 | #define DEFAULT_IMAGE_ASCENT 50 | |
bdda7eb0 | 2420 | #define CENTERED_IMAGE_ASCENT -1 |
c22ca93b | 2421 | |
5f5c8ee5 GM |
2422 | /* Lisp specification of this image. */ |
2423 | Lisp_Object spec; | |
c22ca93b | 2424 | |
5f5c8ee5 GM |
2425 | /* Relief to draw around the image. */ |
2426 | int relief; | |
c22ca93b | 2427 | |
f8215993 GM |
2428 | /* Optional margins around the image. This includes the relief. */ |
2429 | int hmargin, vmargin; | |
5f5c8ee5 GM |
2430 | |
2431 | /* Reference to the type of the image. */ | |
2432 | struct image_type *type; | |
2433 | ||
a7ac64a9 GM |
2434 | /* 1 means that loading the image failed. Don't try again. */ |
2435 | unsigned load_failed_p; | |
2436 | ||
5f5c8ee5 GM |
2437 | /* A place for image types to store additional data. The member |
2438 | data.lisp_val is marked during GC, so it's safe to store Lisp data | |
2439 | there. Image types should free this data when their `free' | |
2440 | function is called. */ | |
2441 | struct | |
c22ca93b | 2442 | { |
5f5c8ee5 GM |
2443 | int int_val; |
2444 | void *ptr_val; | |
2445 | Lisp_Object lisp_val; | |
2446 | } data; | |
c22ca93b | 2447 | |
5f5c8ee5 GM |
2448 | /* Hash value of image specification to speed up comparisons. */ |
2449 | unsigned hash; | |
2450 | ||
2451 | /* Image id of this image. */ | |
2452 | int id; | |
2453 | ||
2454 | /* Hash collision chain. */ | |
2455 | struct image *next, *prev; | |
2456 | }; | |
2457 | ||
2458 | ||
2459 | /* Cache of images. Each frame has a cache. X frames with the same | |
2460 | x_display_info share their caches. */ | |
2461 | ||
2462 | struct image_cache | |
2463 | { | |
2464 | /* Hash table of images. */ | |
2465 | struct image **buckets; | |
2466 | ||
2467 | /* Vector mapping image ids to images. */ | |
2468 | struct image **images; | |
2469 | ||
2470 | /* Allocated size of `images'. */ | |
2471 | unsigned size; | |
2472 | ||
2473 | /* Number of images in the cache. */ | |
2474 | unsigned used; | |
2475 | ||
2476 | /* Reference count (number of frames sharing this cache). */ | |
2477 | int refcount; | |
2478 | }; | |
2479 | ||
2480 | ||
5f5c8ee5 GM |
2481 | /* Value is a pointer to the image with id ID on frame F, or null if |
2482 | no image with that id exists. */ | |
2483 | ||
2484 | #define IMAGE_FROM_ID(F, ID) \ | |
2485 | (((ID) >= 0 && (ID) < (FRAME_X_IMAGE_CACHE (F)->used)) \ | |
2486 | ? FRAME_X_IMAGE_CACHE (F)->images[ID] \ | |
2487 | : NULL) | |
2488 | ||
2489 | /* Size of bucket vector of image caches. Should be prime. */ | |
2490 | ||
2491 | #define IMAGE_CACHE_BUCKETS_SIZE 1001 | |
2492 | ||
4397e334 | 2493 | #endif /* HAVE_WINDOW_SYSTEM */ |
5f5c8ee5 GM |
2494 | |
2495 | ||
2496 | \f | |
2497 | /*********************************************************************** | |
9ea173e8 | 2498 | Tool-bars |
5f5c8ee5 GM |
2499 | ***********************************************************************/ |
2500 | ||
9ea173e8 GM |
2501 | /* Enumeration defining where to find tool-bar item information in |
2502 | tool-bar items vectors stored with frames. Each tool-bar item | |
2503 | occupies TOOL_BAR_ITEM_NSLOTS elements in such a vector. */ | |
5f5c8ee5 | 2504 | |
9ea173e8 | 2505 | enum tool_bar_item_idx |
5f5c8ee5 | 2506 | { |
9ea173e8 | 2507 | /* The key of the tool-bar item. Used to remove items when a binding |
5f5c8ee5 | 2508 | for `undefined' is found. */ |
9ea173e8 | 2509 | TOOL_BAR_ITEM_KEY, |
5f5c8ee5 GM |
2510 | |
2511 | /* Non-nil if item is enabled. */ | |
9ea173e8 | 2512 | TOOL_BAR_ITEM_ENABLED_P, |
5f5c8ee5 GM |
2513 | |
2514 | /* Non-nil if item is selected (pressed). */ | |
9ea173e8 | 2515 | TOOL_BAR_ITEM_SELECTED_P, |
5f5c8ee5 GM |
2516 | |
2517 | /* Caption. */ | |
9ea173e8 | 2518 | TOOL_BAR_ITEM_CAPTION, |
5f5c8ee5 GM |
2519 | |
2520 | /* Image(s) to display. This is either a single image specification | |
2521 | or a vector of specifications. */ | |
9ea173e8 | 2522 | TOOL_BAR_ITEM_IMAGES, |
5f5c8ee5 GM |
2523 | |
2524 | /* The binding. */ | |
9ea173e8 | 2525 | TOOL_BAR_ITEM_BINDING, |
5f5c8ee5 GM |
2526 | |
2527 | /* Button type. One of nil, `:radio' or `:toggle'. */ | |
9ea173e8 | 2528 | TOOL_BAR_ITEM_TYPE, |
c22ca93b | 2529 | |
5f5c8ee5 | 2530 | /* Help string. */ |
9ea173e8 | 2531 | TOOL_BAR_ITEM_HELP, |
5f5c8ee5 | 2532 | |
9ea173e8 GM |
2533 | /* Sentinel = number of slots in tool_bar_items occupied by one |
2534 | tool-bar item. */ | |
2535 | TOOL_BAR_ITEM_NSLOTS | |
5f5c8ee5 GM |
2536 | }; |
2537 | ||
2538 | ||
2539 | /* An enumeration for the different images that can be specified | |
9ea173e8 | 2540 | for a tool-bar item. */ |
5f5c8ee5 | 2541 | |
9ea173e8 | 2542 | enum tool_bar_item_image |
5f5c8ee5 | 2543 | { |
9ea173e8 GM |
2544 | TOOL_BAR_IMAGE_ENABLED_SELECTED, |
2545 | TOOL_BAR_IMAGE_ENABLED_DESELECTED, | |
2546 | TOOL_BAR_IMAGE_DISABLED_SELECTED, | |
2547 | TOOL_BAR_IMAGE_DISABLED_DESELECTED | |
5f5c8ee5 GM |
2548 | }; |
2549 | ||
9ea173e8 | 2550 | /* Margin around tool-bar buttons in pixels. */ |
5f5c8ee5 | 2551 | |
cc4cb755 | 2552 | extern Lisp_Object Vtool_bar_button_margin; |
5f5c8ee5 | 2553 | |
9ea173e8 | 2554 | /* Thickness of relief to draw around tool-bar buttons. */ |
5f5c8ee5 | 2555 | |
31ade731 | 2556 | extern EMACS_INT tool_bar_button_relief; |
5f5c8ee5 | 2557 | |
cc4cb755 GM |
2558 | /* Default values of the above variables. */ |
2559 | ||
cfa5cf43 PJ |
2560 | #define DEFAULT_TOOL_BAR_BUTTON_MARGIN 4 |
2561 | #define DEFAULT_TOOL_BAR_BUTTON_RELIEF 1 | |
cc4cb755 GM |
2562 | |
2563 | /* The height in pixels of the default tool-bar images. */ | |
2564 | ||
2565 | #define DEFAULT_TOOL_BAR_IMAGE_HEIGHT 24 | |
5f5c8ee5 GM |
2566 | |
2567 | \f | |
2568 | /*********************************************************************** | |
a0816661 MB |
2569 | Terminal Capabilities |
2570 | ***********************************************************************/ | |
2571 | ||
8da139bc MB |
2572 | /* Each of these is a bit representing a terminal `capability' (bold, |
2573 | inverse, etc). They are or'd together to specify the set of | |
2574 | capabilities being queried for when calling `tty_capable_p' (which | |
2575 | returns true if the terminal supports all of them). */ | |
f0be5454 | 2576 | |
a0816661 MB |
2577 | #define TTY_CAP_INVERSE 0x01 |
2578 | #define TTY_CAP_UNDERLINE 0x02 | |
2579 | #define TTY_CAP_BOLD 0x04 | |
2580 | #define TTY_CAP_DIM 0x08 | |
2581 | #define TTY_CAP_BLINK 0x10 | |
2582 | #define TTY_CAP_ALT_CHARSET 0x20 | |
2583 | ||
2584 | \f | |
2585 | /*********************************************************************** | |
2586 | Function Prototypes | |
5f5c8ee5 GM |
2587 | ***********************************************************************/ |
2588 | ||
2589 | /* Defined in xdisp.c */ | |
2590 | ||
65ace4c2 GM |
2591 | struct glyph_row *row_containing_pos P_ ((struct window *, int, |
2592 | struct glyph_row *, | |
229151ba | 2593 | struct glyph_row *, int)); |
56ab5d27 | 2594 | int string_buffer_position P_ ((struct window *, Lisp_Object, int)); |
5be57d49 | 2595 | int line_bottom_y P_ ((struct it *)); |
ce0b6717 | 2596 | int display_prop_intangible_p P_ ((Lisp_Object)); |
af42d485 | 2597 | void resize_echo_area_exactly P_ ((void)); |
c99f6080 | 2598 | int resize_mini_window P_ ((struct window *, int)); |
92489bdd | 2599 | int try_window P_ ((Lisp_Object, struct text_pos, int)); |
5f5c8ee5 GM |
2600 | void window_box P_ ((struct window *, int, int *, int *, int *, int *)); |
2601 | int window_box_height P_ ((struct window *)); | |
2602 | int window_text_bottom_y P_ ((struct window *)); | |
2603 | int window_box_width P_ ((struct window *, int)); | |
2604 | int window_box_left P_ ((struct window *, int)); | |
58df7256 | 2605 | int window_box_left_offset P_ ((struct window *, int)); |
5f5c8ee5 | 2606 | int window_box_right P_ ((struct window *, int)); |
58df7256 | 2607 | int window_box_right_offset P_ ((struct window *, int)); |
5f5c8ee5 | 2608 | void window_box_edges P_ ((struct window *, int, int *, int *, int *, int *)); |
d74b2553 | 2609 | int estimate_mode_line_height P_ ((struct frame *, enum face_id)); |
1853f74c KS |
2610 | void pixel_to_glyph_coords P_ ((struct frame *, int, int, int *, int *, |
2611 | NativeRectangle *, int)); | |
2612 | int glyph_to_pixel_coords P_ ((struct window *, int, int, int *, int *)); | |
d7f18f68 KS |
2613 | void remember_mouse_glyph P_ ((struct frame *, int, int, NativeRectangle *)); |
2614 | ||
5f5c8ee5 | 2615 | void mark_window_display_accurate P_ ((Lisp_Object, int)); |
69d1478a | 2616 | void redisplay_preserve_echo_area P_ ((int)); |
5f5c8ee5 GM |
2617 | void set_cursor_from_row P_ ((struct window *, struct glyph_row *, |
2618 | struct glyph_matrix *, int, int, int, int)); | |
2619 | void init_iterator P_ ((struct it *, struct window *, int, | |
2620 | int, struct glyph_row *, enum face_id)); | |
2621 | void init_iterator_to_row_start P_ ((struct it *, struct window *, | |
2622 | struct glyph_row *)); | |
2623 | int get_next_display_element P_ ((struct it *)); | |
ff2a2e6b | 2624 | void set_iterator_to_next P_ ((struct it *, int)); |
5f5c8ee5 GM |
2625 | void start_display P_ ((struct it *, struct window *, struct text_pos)); |
2626 | void move_it_to P_ ((struct it *, int, int, int, int, int)); | |
2627 | void move_it_vertically P_ ((struct it *, int)); | |
d1d1aa9c | 2628 | void move_it_vertically_backward P_ ((struct it *, int)); |
5f5c8ee5 | 2629 | void move_it_by_lines P_ ((struct it *, int, int)); |
5b2ad813 | 2630 | void move_it_past_eol P_ ((struct it *)); |
c4f2431a | 2631 | int in_display_vector_p P_ ((struct it *)); |
5f5c8ee5 GM |
2632 | int frame_mode_line_height P_ ((struct frame *)); |
2633 | void highlight_trailing_whitespace P_ ((struct frame *, struct glyph_row *)); | |
9ea173e8 | 2634 | extern Lisp_Object Qtool_bar; |
c1ff17c5 | 2635 | extern Lisp_Object Vshow_trailing_whitespace; |
5f380a5b | 2636 | extern int mode_line_in_non_selected_windows; |
5f5c8ee5 | 2637 | extern int redisplaying_p; |
9ee84299 | 2638 | extern void add_to_log P_ ((char *, Lisp_Object, Lisp_Object)); |
583dba75 | 2639 | extern int help_echo_showing_p; |
e9e32f46 | 2640 | extern int current_mode_line_height, current_header_line_height; |
d74b2553 | 2641 | extern Lisp_Object help_echo_string, help_echo_window; |
0633d52c | 2642 | extern Lisp_Object help_echo_object, previous_help_echo_string; |
d74b2553 KS |
2643 | extern int help_echo_pos; |
2644 | extern struct frame *last_mouse_frame; | |
2645 | extern int last_tool_bar_item; | |
2646 | extern int mouse_autoselect_window; | |
502b3128 KH |
2647 | extern int unibyte_display_via_language_environment; |
2648 | ||
a7416ec1 | 2649 | extern void reseat_at_previous_visible_line_start P_ ((struct it *)); |
d74b2553 | 2650 | |
7ee8103e KS |
2651 | extern int calc_pixel_width_or_height P_ ((double *, struct it *, Lisp_Object, |
2652 | /* XFontStruct */ void *, int, int *)); | |
2653 | ||
d74b2553 | 2654 | #ifdef HAVE_WINDOW_SYSTEM |
5f5c8ee5 | 2655 | |
d5cc60b8 KS |
2656 | #if GLYPH_DEBUG |
2657 | extern void dump_glyph_string P_ ((struct glyph_string *)); | |
2658 | #endif | |
2659 | ||
2660 | extern void x_get_glyph_overhangs P_ ((struct glyph *, struct frame *, | |
2661 | int *, int *)); | |
2662 | extern void x_produce_glyphs P_ ((struct it *)); | |
d5cc60b8 | 2663 | |
d74b2553 KS |
2664 | extern void x_write_glyphs P_ ((struct glyph *, int)); |
2665 | extern void x_insert_glyphs P_ ((struct glyph *, int len)); | |
2666 | extern void x_clear_end_of_line P_ ((int)); | |
2667 | ||
2668 | extern int x_stretch_cursor_p; | |
2669 | extern struct cursor_pos output_cursor; | |
2670 | ||
2671 | extern void x_fix_overlapping_area P_ ((struct window *, struct glyph_row *, | |
10a07952 | 2672 | enum glyph_row_area, int)); |
d74b2553 KS |
2673 | extern void draw_phys_cursor_glyph P_ ((struct window *, |
2674 | struct glyph_row *, | |
2675 | enum draw_glyphs_face)); | |
4f5d6640 KS |
2676 | extern int get_phys_cursor_geometry P_ ((struct window *, struct glyph_row *, |
2677 | struct glyph *, int *)); | |
d74b2553 KS |
2678 | extern void erase_phys_cursor P_ ((struct window *)); |
2679 | extern void display_and_set_cursor P_ ((struct window *, | |
2680 | int, int, int, int, int)); | |
2681 | ||
2682 | extern void set_output_cursor P_ ((struct cursor_pos *)); | |
2683 | extern void x_cursor_to P_ ((int, int, int, int)); | |
2684 | ||
2685 | extern void x_update_cursor P_ ((struct frame *, int)); | |
2686 | extern void x_clear_cursor P_ ((struct window *)); | |
2687 | extern void x_draw_vertical_border P_ ((struct window *w)); | |
2688 | ||
2689 | extern void frame_to_window_pixel_xy P_ ((struct window *, int *, int *)); | |
10a07952 YM |
2690 | extern int get_glyph_string_clip_rects P_ ((struct glyph_string *, |
2691 | NativeRectangle *, int)); | |
d74b2553 KS |
2692 | extern void get_glyph_string_clip_rect P_ ((struct glyph_string *, |
2693 | NativeRectangle *nr)); | |
01b1f0c0 | 2694 | extern Lisp_Object find_hot_spot P_ ((Lisp_Object, int, int)); |
d74b2553 KS |
2695 | extern void note_mouse_highlight P_ ((struct frame *, int, int)); |
2696 | extern void x_clear_window_mouse_face P_ ((struct window *)); | |
2697 | extern void cancel_mouse_face P_ ((struct frame *)); | |
2698 | ||
2699 | extern void handle_tool_bar_click P_ ((struct frame *, | |
2700 | int, int, int, unsigned int)); | |
2701 | ||
2702 | /* msdos.c defines its own versions of these functions. */ | |
2703 | extern int clear_mouse_face P_ ((Display_Info *)); | |
2704 | extern void show_mouse_face P_ ((Display_Info *, enum draw_glyphs_face)); | |
2705 | extern int cursor_in_mouse_face_p P_ ((struct window *w)); | |
2706 | ||
2707 | extern void expose_frame P_ ((struct frame *, int, int, int, int)); | |
2708 | extern int x_intersect_rectangles P_ ((XRectangle *, XRectangle *, | |
2709 | XRectangle *)); | |
2710 | #endif | |
d5cc60b8 | 2711 | |
2251a6f2 KS |
2712 | /* Defined in fringe.c */ |
2713 | ||
e72d7335 | 2714 | int lookup_fringe_bitmap (Lisp_Object); |
2251a6f2 KS |
2715 | void draw_fringe_bitmap P_ ((struct window *, struct glyph_row *, int)); |
2716 | void draw_row_fringe_bitmaps P_ ((struct window *, struct glyph_row *)); | |
98c95e4e | 2717 | int draw_window_fringes P_ ((struct window *, int)); |
2251a6f2 KS |
2718 | int update_window_fringes P_ ((struct window *, int)); |
2719 | void compute_fringe_widths P_ ((struct frame *, int)); | |
2720 | ||
2721 | #ifdef WINDOWS_NT | |
2722 | void w32_init_fringe P_ ((void)); | |
2723 | void w32_reset_fringes P_ ((void)); | |
2724 | #endif | |
ea21ef78 YM |
2725 | #ifdef MAC_OS |
2726 | void mac_init_fringe P_ ((void)); | |
2727 | #endif | |
2251a6f2 | 2728 | |
175ca1f4 KS |
2729 | /* Defined in image.c */ |
2730 | ||
d9a4b477 KS |
2731 | #ifdef HAVE_WINDOW_SYSTEM |
2732 | ||
175ca1f4 KS |
2733 | extern int x_bitmap_height P_ ((struct frame *, int)); |
2734 | extern int x_bitmap_width P_ ((struct frame *, int)); | |
2735 | extern int x_bitmap_pixmap P_ ((struct frame *, int)); | |
2736 | extern void x_reference_bitmap P_ ((struct frame *, int)); | |
2737 | extern int x_create_bitmap_from_data P_ ((struct frame *, char *, | |
2738 | unsigned int, unsigned int)); | |
2739 | extern int x_create_bitmap_from_file P_ ((struct frame *, Lisp_Object)); | |
2740 | #ifndef x_destroy_bitmap | |
2741 | extern void x_destroy_bitmap P_ ((struct frame *, int)); | |
2742 | #endif | |
2743 | extern void x_destroy_all_bitmaps P_ ((Display_Info *)); | |
2744 | extern int x_create_bitmap_mask P_ ((struct frame * , int)); | |
f27823c6 | 2745 | extern Lisp_Object x_find_image_file P_ ((Lisp_Object)); |
175ca1f4 | 2746 | |
d9a4b477 KS |
2747 | void x_kill_gs_process P_ ((Pixmap, struct frame *)); |
2748 | struct image_cache *make_image_cache P_ ((void)); | |
2749 | void free_image_cache P_ ((struct frame *)); | |
2750 | void clear_image_cache P_ ((struct frame *, int)); | |
2751 | void forall_images_in_image_cache P_ ((struct frame *, | |
2752 | void (*) P_ ((struct image *)))); | |
2753 | int valid_image_p P_ ((Lisp_Object)); | |
2754 | void prepare_image_for_display P_ ((struct frame *, struct image *)); | |
2755 | int lookup_image P_ ((struct frame *, Lisp_Object)); | |
2756 | ||
2757 | unsigned long image_background P_ ((struct image *, struct frame *, | |
0ccb519d | 2758 | XImagePtr_or_DC ximg)); |
d9a4b477 | 2759 | int image_background_transparent P_ ((struct image *, struct frame *, |
0ccb519d | 2760 | XImagePtr_or_DC mask)); |
d9a4b477 | 2761 | |
0633d52c KS |
2762 | int image_ascent P_ ((struct image *, struct face *, struct glyph_slice *)); |
2763 | ||
d9a4b477 KS |
2764 | #endif |
2765 | ||
5f5c8ee5 GM |
2766 | /* Defined in sysdep.c */ |
2767 | ||
16c290d8 | 2768 | void get_tty_size P_ ((int, int *, int *)); |
5f5c8ee5 GM |
2769 | void request_sigio P_ ((void)); |
2770 | void unrequest_sigio P_ ((void)); | |
16c290d8 KL |
2771 | int tabs_safe_p P_ ((int)); |
2772 | void init_baud_rate P_ ((int)); | |
5f5c8ee5 GM |
2773 | void init_sigio P_ ((int)); |
2774 | ||
8317e104 GM |
2775 | /* Defined in xfaces.c */ |
2776 | ||
2ad412d7 GM |
2777 | #ifdef HAVE_X_WINDOWS |
2778 | void x_free_colors P_ ((struct frame *, unsigned long *, int)); | |
2779 | #endif | |
5f5c8ee5 | 2780 | |
76a6bc49 GM |
2781 | void update_face_from_frame_parameter P_ ((struct frame *, Lisp_Object, |
2782 | Lisp_Object)); | |
036480cb | 2783 | Lisp_Object tty_color_name P_ ((struct frame *, int)); |
5f5c8ee5 | 2784 | void clear_face_cache P_ ((int)); |
1cc03123 EZ |
2785 | unsigned long load_color P_ ((struct frame *, struct face *, Lisp_Object, |
2786 | enum lface_attribute_index)); | |
5f5c8ee5 | 2787 | void unload_color P_ ((struct frame *, unsigned long)); |
475a1234 | 2788 | int face_font_available_p P_ ((struct frame *, Lisp_Object)); |
5f5c8ee5 GM |
2789 | int ascii_face_of_lisp_face P_ ((struct frame *, int)); |
2790 | void prepare_face_for_display P_ ((struct frame *, struct face *)); | |
77be52b7 | 2791 | int xstricmp P_ ((const unsigned char *, const unsigned char *)); |
b3091a23 | 2792 | int lookup_face P_ ((struct frame *, Lisp_Object *, int, struct face *)); |
1c395ea7 | 2793 | int lookup_named_face P_ ((struct frame *, Lisp_Object, int, int)); |
5f5c8ee5 GM |
2794 | int smaller_face P_ ((struct frame *, int, int)); |
2795 | int face_with_height P_ ((struct frame *, int, int)); | |
19aaca78 | 2796 | int lookup_derived_face P_ ((struct frame *, Lisp_Object, int, int, int)); |
5f5c8ee5 GM |
2797 | void init_frame_faces P_ ((struct frame *)); |
2798 | void free_frame_faces P_ ((struct frame *)); | |
2799 | void recompute_basic_faces P_ ((struct frame *)); | |
2800 | int face_at_buffer_position P_ ((struct window *, int, int, int, int *, | |
2801 | int, int)); | |
8d721a0d GM |
2802 | int face_at_string_position P_ ((struct window *, Lisp_Object, int, int, int, |
2803 | int, int *, enum face_id, int)); | |
a2858aae | 2804 | int merge_faces P_ ((struct frame *, Lisp_Object, int, int)); |
5f5c8ee5 GM |
2805 | int compute_char_face P_ ((struct frame *, int, Lisp_Object)); |
2806 | void free_all_realized_faces P_ ((Lisp_Object)); | |
2807 | extern Lisp_Object Qforeground_color, Qbackground_color; | |
9b0ad2cb | 2808 | extern Lisp_Object Qframe_set_background_mode; |
f0ba2d22 | 2809 | extern char unspecified_fg[], unspecified_bg[]; |
b3091a23 | 2810 | void free_realized_multibyte_face P_ ((struct frame *, int)); |
5f5c8ee5 GM |
2811 | |
2812 | /* Defined in xfns.c */ | |
2813 | ||
4397e334 | 2814 | #ifdef HAVE_X_WINDOWS |
5ae040a6 | 2815 | void gamma_correct P_ ((struct frame *, XColor *)); |
4397e334 AI |
2816 | #endif |
2817 | #ifdef WINDOWSNT | |
2818 | void gamma_correct P_ ((struct frame *, COLORREF *)); | |
2819 | #endif | |
175ca1f4 KS |
2820 | #ifdef MAC_OS |
2821 | void gamma_correct P_ ((struct frame *, unsigned long *)); | |
2822 | #endif | |
4397e334 AI |
2823 | |
2824 | #ifdef HAVE_WINDOW_SYSTEM | |
2825 | ||
5f5c8ee5 GM |
2826 | int x_screen_planes P_ ((struct frame *)); |
2827 | void x_implicitly_set_name P_ ((struct frame *, Lisp_Object, Lisp_Object)); | |
c26e3f6c | 2828 | |
4811586b | 2829 | extern Lisp_Object tip_frame; |
5f5c8ee5 | 2830 | extern Window tip_window; |
88a19a90 | 2831 | EXFUN (Fx_show_tip, 6); |
5f5c8ee5 | 2832 | EXFUN (Fx_hide_tip, 0); |
6a2b7977 GM |
2833 | extern void start_hourglass P_ ((void)); |
2834 | extern void cancel_hourglass P_ ((void)); | |
3b8029d7 | 2835 | extern int hourglass_started P_ ((void)); |
6a2b7977 | 2836 | extern int display_hourglass_p; |
5f5c8ee5 | 2837 | |
0ff7c0d4 MB |
2838 | /* Returns the background color of IMG, calculating one heuristically if |
2839 | necessary. If non-zero, XIMG is an existing XImage object to use for | |
2840 | the heuristic. */ | |
2841 | ||
2842 | #define IMAGE_BACKGROUND(img, f, ximg) \ | |
2843 | ((img)->background_valid \ | |
2844 | ? (img)->background \ | |
2845 | : image_background (img, f, ximg)) | |
2846 | ||
2847 | /* Returns true if IMG has a `transparent' background, using heuristics | |
2848 | to decide if necessary. If non-zero, MASK is an existing XImage | |
2849 | object to use for the heuristic. */ | |
2850 | ||
2851 | #define IMAGE_BACKGROUND_TRANSPARENT(img, f, mask) \ | |
2852 | ((img)->background_transparent_valid \ | |
2853 | ? (img)->background_transparent \ | |
2854 | : image_background_transparent (img, f, mask)) | |
2855 | ||
4397e334 | 2856 | #endif /* HAVE_WINDOW_SYSTEM */ |
5f5c8ee5 GM |
2857 | |
2858 | ||
2859 | /* Defined in xmenu.c */ | |
2860 | ||
2861 | int popup_activated P_ ((void)); | |
2862 | ||
3f7267e7 | 2863 | /* Defined in dispnew.c */ |
5f5c8ee5 | 2864 | |
283c6e3e | 2865 | extern int inverse_video; |
9a636f37 GM |
2866 | extern int required_matrix_width P_ ((struct window *)); |
2867 | extern int required_matrix_height P_ ((struct window *)); | |
0a0c9ab0 KS |
2868 | extern Lisp_Object buffer_posn_from_coords P_ ((struct window *, |
2869 | int *, int *, | |
2870 | struct display_pos *, | |
0633d52c | 2871 | Lisp_Object *, |
0a0c9ab0 KS |
2872 | int *, int *, int *, int *)); |
2873 | extern Lisp_Object mode_line_string P_ ((struct window *, enum window_part, | |
2874 | int *, int *, int *, | |
2875 | Lisp_Object *, | |
2876 | int *, int *, int *, int *)); | |
2877 | extern Lisp_Object marginal_area_string P_ ((struct window *, enum window_part, | |
2878 | int *, int *, int *, | |
2879 | Lisp_Object *, | |
2880 | int *, int *, int *, int *)); | |
ec5d8db7 AS |
2881 | extern void redraw_frame P_ ((struct frame *)); |
2882 | extern void redraw_garbaged_frames P_ ((void)); | |
ec5d8db7 | 2883 | extern void cancel_line P_ ((int, struct frame *)); |
ec5d8db7 | 2884 | extern void init_desired_glyphs P_ ((struct frame *)); |
ec5d8db7 | 2885 | extern int scroll_frame_lines P_ ((struct frame *, int, int, int, int)); |
ec5d8db7 AS |
2886 | extern int direct_output_for_insert P_ ((int)); |
2887 | extern int direct_output_forward_char P_ ((int)); | |
2888 | extern int update_frame P_ ((struct frame *, int, int)); | |
ec5d8db7 | 2889 | extern int scrolling P_ ((struct frame *)); |
ec5d8db7 | 2890 | extern void bitch_at_user P_ ((void)); |
5f5c8ee5 GM |
2891 | void adjust_glyphs P_ ((struct frame *)); |
2892 | void free_glyphs P_ ((struct frame *)); | |
2893 | void free_window_matrices P_ ((struct window *)); | |
2894 | void check_glyph_memory P_ ((void)); | |
2895 | void mirrored_line_dance P_ ((struct glyph_matrix *, int, int, int *, char *)); | |
2896 | void clear_glyph_matrix P_ ((struct glyph_matrix *)); | |
2897 | void clear_current_matrices P_ ((struct frame *f)); | |
2898 | void clear_desired_matrices P_ ((struct frame *)); | |
2899 | void shift_glyph_matrix P_ ((struct window *, struct glyph_matrix *, | |
2900 | int, int, int)); | |
2901 | void rotate_matrix P_ ((struct glyph_matrix *, int, int, int)); | |
84fc6d4d GM |
2902 | void increment_matrix_positions P_ ((struct glyph_matrix *, |
2903 | int, int, int, int)); | |
5f5c8ee5 | 2904 | void blank_row P_ ((struct window *, struct glyph_row *, int)); |
84fc6d4d | 2905 | void increment_row_positions P_ ((struct glyph_row *, int, int)); |
5f5c8ee5 GM |
2906 | void enable_glyph_matrix_rows P_ ((struct glyph_matrix *, int, int, int)); |
2907 | void clear_glyph_row P_ ((struct glyph_row *)); | |
2908 | void prepare_desired_row P_ ((struct glyph_row *)); | |
2909 | int line_hash_code P_ ((struct glyph_row *)); | |
2910 | void set_window_update_flags P_ ((struct window *, int)); | |
5f5c8ee5 GM |
2911 | void redraw_frame P_ ((struct frame *)); |
2912 | void redraw_garbaged_frames P_ ((void)); | |
2913 | int scroll_cost P_ ((struct frame *, int, int, int)); | |
2914 | int direct_output_for_insert P_ ((int)); | |
2915 | int direct_output_forward_char P_ ((int)); | |
2916 | int update_frame P_ ((struct frame *, int, int)); | |
2917 | void update_single_window P_ ((struct window *, int)); | |
2918 | int scrolling P_ ((struct frame *)); | |
3f7267e7 GM |
2919 | void do_pending_window_change P_ ((int)); |
2920 | void change_frame_size P_ ((struct frame *, int, int, int, int, int)); | |
5f5c8ee5 GM |
2921 | void bitch_at_user P_ ((void)); |
2922 | Lisp_Object sit_for P_ ((int, int, int, int, int)); | |
2923 | void init_display P_ ((void)); | |
2924 | void syms_of_display P_ ((void)); | |
69a7a14d | 2925 | extern Lisp_Object Qredisplay_dont_pause; |
c68b9c2f | 2926 | GLYPH spec_glyph_lookup_face P_ ((struct window *, GLYPH)); |
ec5d8db7 | 2927 | |
ed8dad6b | 2928 | /* Defined in terminal.c */ |
5f5c8ee5 | 2929 | |
385ed61f | 2930 | extern void ring_bell P_ ((struct frame *)); |
ec5d8db7 AS |
2931 | extern void update_begin P_ ((struct frame *)); |
2932 | extern void update_end P_ ((struct frame *)); | |
385ed61f | 2933 | extern void set_terminal_window P_ ((struct frame *, int)); |
ed8dad6b | 2934 | extern void cursor_to P_ ((struct frame *, int, int)); |
ed8dad6b KL |
2935 | extern void raw_cursor_to P_ ((struct frame *, int, int)); |
2936 | extern void clear_to_end P_ ((struct frame *)); | |
385ed61f KL |
2937 | extern void clear_frame P_ ((struct frame *)); |
2938 | extern void clear_end_of_line P_ ((struct frame *, int)); | |
ed8dad6b KL |
2939 | extern void write_glyphs P_ ((struct frame *, struct glyph *, int)); |
2940 | extern void insert_glyphs P_ ((struct frame *, struct glyph *, int)); | |
385ed61f KL |
2941 | extern void delete_glyphs P_ ((struct frame *, int)); |
2942 | extern void ins_del_lines P_ ((struct frame *, int, int)); | |
ed8dad6b | 2943 | |
6ed8eeff | 2944 | extern struct terminal *init_initial_terminal P_ ((void)); |
ed8dad6b KL |
2945 | |
2946 | ||
2947 | /* Defined in term.c */ | |
2948 | ||
6ed8eeff KL |
2949 | extern void tty_set_terminal_modes P_ ((struct terminal *)); |
2950 | extern void tty_reset_terminal_modes P_ ((struct terminal *)); | |
ed8dad6b KL |
2951 | extern void tty_turn_off_insert P_ ((struct tty_display_info *)); |
2952 | extern void tty_turn_off_highlight P_ ((struct tty_display_info *)); | |
ec5d8db7 AS |
2953 | extern int string_cost P_ ((char *)); |
2954 | extern int per_line_cost P_ ((char *)); | |
2955 | extern void calculate_costs P_ ((struct frame *)); | |
ed8dad6b KL |
2956 | extern void produce_glyphs P_ ((struct it *)); |
2957 | extern void produce_special_glyphs P_ ((struct it *, enum display_element_type)); | |
2958 | extern int tty_capable_p P_ ((struct tty_display_info *, unsigned, unsigned long, unsigned long)); | |
70f50bf1 | 2959 | extern void set_tty_color_mode P_ ((struct frame *, Lisp_Object)); |
6ed8eeff KL |
2960 | extern struct terminal *get_tty_terminal P_ ((Lisp_Object terminal)); |
2961 | extern struct terminal *get_named_tty P_ ((char *)); | |
2962 | EXFUN (Ftty_type, 1); | |
b2fedb04 | 2963 | extern void create_tty_output P_ ((struct frame *)); |
6ed8eeff | 2964 | extern struct terminal *init_tty P_ ((char *, char *, int)); |
b2fedb04 | 2965 | |
ec5d8db7 AS |
2966 | |
2967 | /* Defined in scroll.c */ | |
5f5c8ee5 | 2968 | |
ec5d8db7 AS |
2969 | extern int scrolling_max_lines_saved P_ ((int, int, int *, int *, int *)); |
2970 | extern int scroll_cost P_ ((struct frame *, int, int, int)); | |
2971 | extern void do_line_insertion_deletion_costs P_ ((struct frame *, char *, | |
2972 | char *, char *, char *, | |
2973 | char *, char *, int)); | |
5f5c8ee5 GM |
2974 | void scrolling_1 P_ ((struct frame *, int, int, int, int *, int *, int *, |
2975 | int *, int)); | |
87485d6f | 2976 | |
e6b3aecd KS |
2977 | /* Defined in frame.c */ |
2978 | ||
2979 | #ifdef HAVE_WINDOW_SYSTEM | |
2980 | ||
2981 | /* Types we might convert a resource string into. */ | |
2982 | enum resource_types | |
2983 | { | |
2984 | RES_TYPE_NUMBER, | |
2985 | RES_TYPE_FLOAT, | |
2986 | RES_TYPE_BOOLEAN, | |
2987 | RES_TYPE_STRING, | |
2988 | RES_TYPE_SYMBOL | |
2989 | }; | |
2990 | ||
2991 | extern Lisp_Object x_get_arg P_ ((Display_Info *, Lisp_Object, | |
2992 | Lisp_Object, char *, char *class, | |
2993 | enum resource_types)); | |
2994 | extern Lisp_Object x_frame_get_arg P_ ((struct frame *, Lisp_Object, | |
2995 | Lisp_Object, char *, char *, | |
2996 | enum resource_types)); | |
2997 | extern Lisp_Object x_frame_get_and_record_arg P_ (( | |
2998 | struct frame *, Lisp_Object, | |
2999 | Lisp_Object, char *, char *, | |
3000 | enum resource_types)); | |
3001 | extern Lisp_Object x_default_parameter P_ ((struct frame *, Lisp_Object, | |
3002 | Lisp_Object, Lisp_Object, | |
3003 | char *, char *, | |
3004 | enum resource_types)); | |
3005 | ||
3006 | #endif /* HAVE_WINDOW_SYSTEM */ | |
3007 | ||
5f5c8ee5 | 3008 | #endif /* not DISPEXTERN_H_INCLUDED */ |
ab5796a9 MB |
3009 | |
3010 | /* arch-tag: c65c475f-1c1e-4534-8795-990b8509fd65 | |
3011 | (do not change this comment) */ |