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