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