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