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