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