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