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