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