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