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