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