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