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