*** empty log message ***
[bpt/emacs.git] / src / dispextern.h
CommitLineData
c22ca93b 1/* Interface definitions for display code.
d78f30b8 2 Copyright (C) 1985,93,94,97,98,99, 2000,01,02,03, 2004, 2005
5f5c8ee5 3 Free Software Foundation, Inc.
c22ca93b
JB
4
5This file is part of GNU Emacs.
6
7GNU Emacs is free software; you can redistribute it and/or modify
8it under the terms of the GNU General Public License as published by
e5d77022 9the Free Software Foundation; either version 2, or (at your option)
c22ca93b
JB
10any later version.
11
12GNU Emacs is distributed in the hope that it will be useful,
13but WITHOUT ANY WARRANTY; without even the implied warranty of
14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15GNU General Public License for more details.
16
17You should have received a copy of the GNU General Public License
18along with GNU Emacs; see the file COPYING. If not, write to
3b7ad313
EN
19the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20Boston, MA 02111-1307, USA. */
c22ca93b 21
4d2036e4 22/* New redisplay written by Gerd Moellmann <gerd@gnu.org>. */
87485d6f 23
5f5c8ee5
GM
24#ifndef DISPEXTERN_H_INCLUDED
25#define DISPEXTERN_H_INCLUDED
c22ca93b
JB
26
27#ifdef HAVE_X_WINDOWS
94e32607 28
9f2279ad 29#include <X11/Xlib.h>
8317e104
GM
30#ifdef USE_X_TOOLKIT
31#include <X11/Intrinsic.h>
32#endif /* USE_X_TOOLKIT */
94e32607
JB
33
34#else /* !HAVE_X_WINDOWS */
35
36/* X-related stuff used by non-X gui code. */
37
38typedef struct {
39 unsigned long pixel;
40 unsigned short red, green, blue;
41 char flags;
42 char pad;
43} XColor;
44
8317e104 45#endif /* HAVE_X_WINDOWS */
87485d6f
MW
46
47#ifdef MSDOS
48#include "msdos.h"
49#endif
9f2279ad 50
d74b2553
KS
51#ifdef HAVE_X_WINDOWS
52typedef struct x_display_info Display_Info;
0ccb519d
KS
53typedef XImage * XImagePtr;
54typedef XImagePtr XImagePtr_or_DC;
d74b2553
KS
55#define NativeRectangle XRectangle
56#endif
57
497fbd42 58#ifdef HAVE_NTGUI
c0ac470c 59#include "w32gui.h"
d74b2553 60typedef struct w32_display_info Display_Info;
0ccb519d
KS
61typedef XImage *XImagePtr;
62typedef HDC XImagePtr_or_DC;
497fbd42
GV
63#endif
64
b15325b2 65#ifdef MAC_OS
1a578e9b 66#include "macgui.h"
d74b2553 67typedef struct mac_display_info Display_Info;
0ccb519d
KS
68/* Mac equivalent of XImage. */
69typedef Pixmap XImagePtr;
70typedef XImagePtr XImagePtr_or_DC;
29c42596 71#endif
5f5c8ee5 72
dfbe5d05
KS
73#ifndef NativeRectangle
74#define NativeRectangle int
75#endif
76
5f5c8ee5
GM
77/* Structure forward declarations. Some are here because function
78 prototypes below reference structure types before their definition
79 in this file. Some are here because not every file including
80 dispextern.h also includes frame.h and windows.h. */
81
82struct glyph;
83struct glyph_row;
84struct glyph_matrix;
85struct glyph_pool;
86struct frame;
87struct window;
88
89
d74b2553
KS
90/* Values returned from coordinates_in_window. */
91
92enum window_part
93{
94 ON_NOTHING,
95 ON_TEXT,
96 ON_MODE_LINE,
97 ON_VERTICAL_BORDER,
98 ON_HEADER_LINE,
99 ON_LEFT_FRINGE,
100 ON_RIGHT_FRINGE,
101 ON_LEFT_MARGIN,
ab431b61
RS
102 ON_RIGHT_MARGIN,
103 ON_SCROLL_BAR
d74b2553
KS
104};
105
2251a6f2 106/* Number of bits allocated to store fringe bitmap numbers. */
b3b08f03 107#define FRINGE_ID_BITS 16
2251a6f2 108
d74b2553 109
5f5c8ee5 110\f
5f5c8ee5
GM
111/***********************************************************************
112 Debugging
113 ***********************************************************************/
114
115/* If GLYPH_DEBUG is non-zero, additional checks are activated. Turn
116 it off by defining the macro GLYPH_DEBUG to zero. */
117
118#ifndef GLYPH_DEBUG
119#define GLYPH_DEBUG 0
120#endif
121
139c65cf
KS
122/* If XASSERTS is non-zero, additional consistency checks are activated.
123 Turn it off by defining the macro XASSERTS to zero. */
124
125#ifndef XASSERTS
126#define XASSERTS 0
127#endif
128
5f5c8ee5
GM
129/* Macros to include code only if GLYPH_DEBUG != 0. */
130
131#if GLYPH_DEBUG
132#define IF_DEBUG(X) X
5f5c8ee5
GM
133#else
134#define IF_DEBUG(X) (void) 0
5f5c8ee5
GM
135#endif
136
139c65cf 137#if XASSERTS
d78f30b8 138#define xassert(X) do {if (!(X)) abort ();} while (0)
139c65cf
KS
139#else
140#define xassert(X) (void) 0
141#endif
d78f30b8 142
5f5c8ee5
GM
143/* Macro for displaying traces of redisplay. If Emacs was compiled
144 with GLYPH_DEBUG != 0, the variable trace_redisplay_p can be set to
145 a non-zero value in debugging sessions to activate traces. */
146
147#if GLYPH_DEBUG
148
149extern int trace_redisplay_p;
150#include <stdio.h>
151
152#define TRACE(X) \
153 if (trace_redisplay_p) \
154 fprintf X; \
155 else \
156 (void) 0
157
158#else /* GLYPH_DEBUG == 0 */
159
160#define TRACE(X) (void) 0
161
162#endif /* GLYPH_DEBUG == 0 */
163
177c0ea7 164
5f5c8ee5
GM
165\f
166/***********************************************************************
167 Text positions
168 ***********************************************************************/
169
170/* Starting with Emacs 20.3, characters from strings and buffers have
171 both a character and a byte position associated with them. The
172 following structure holds such a pair of positions. */
177c0ea7 173
5f5c8ee5
GM
174struct text_pos
175{
176 /* Character position. */
177 int charpos;
178
179 /* Corresponding byte position. */
180 int bytepos;
181};
182
183/* Access character and byte position of POS in a functional form. */
184
185#define BYTEPOS(POS) (POS).bytepos
186#define CHARPOS(POS) (POS).charpos
187
188/* Set character position of POS to CHARPOS, byte position to BYTEPOS. */
189
190#define SET_TEXT_POS(POS, CHARPOS, BYTEPOS) \
191 ((POS).charpos = (CHARPOS), (POS).bytepos = BYTEPOS)
192
193/* Increment text position POS. */
194
7bed37e4 195#define INC_TEXT_POS(POS, MULTIBYTE_P) \
5f5c8ee5
GM
196 do \
197 { \
198 ++(POS).charpos; \
7bed37e4
GM
199 if (MULTIBYTE_P) \
200 INC_POS ((POS).bytepos); \
201 else \
202 ++(POS).bytepos; \
5f5c8ee5
GM
203 } \
204 while (0)
205
206/* Decrement text position POS. */
207
7bed37e4 208#define DEC_TEXT_POS(POS, MULTIBYTE_P) \
5f5c8ee5
GM
209 do \
210 { \
211 --(POS).charpos; \
7bed37e4
GM
212 if (MULTIBYTE_P) \
213 DEC_POS ((POS).bytepos); \
214 else \
215 --(POS).bytepos; \
5f5c8ee5
GM
216 } \
217 while (0)
218
219/* Set text position POS from marker MARKER. */
220
221#define SET_TEXT_POS_FROM_MARKER(POS, MARKER) \
222 (CHARPOS (POS) = marker_position ((MARKER)), \
223 BYTEPOS (POS) = marker_byte_position ((MARKER)))
224
225/* Set marker MARKER from text position POS. */
226
227#define SET_MARKER_FROM_TEXT_POS(MARKER, POS) \
228 set_marker_both ((MARKER), Qnil, CHARPOS ((POS)), BYTEPOS ((POS)))
177c0ea7 229
5f5c8ee5
GM
230/* Value is non-zero if character and byte positions of POS1 and POS2
231 are equal. */
232
233#define TEXT_POS_EQUAL_P(POS1, POS2) \
234 ((POS1).charpos == (POS2).charpos \
235 && (POS1).bytepos == (POS2).bytepos)
236
237/* When rendering glyphs, redisplay scans string or buffer text,
238 overlay strings in that text, and does display table or control
239 character translations. The following structure captures a
240 position taking all this into account. */
241
242struct display_pos
243{
244 /* Buffer or string position. */
245 struct text_pos pos;
246
247 /* If this is a position in an overlay string, overlay_string_index
248 is the index of that overlay string in the sequence of overlay
249 strings at `pos' in the order redisplay processes them. A value
250 < 0 means that this is not a position in an overlay string. */
251 int overlay_string_index;
252
253 /* If this is a position in an overlay string, string_pos is the
254 position within that string. */
255 struct text_pos string_pos;
256
257 /* If the character at the position above is a control character or
258 has a display table entry, dpvec_index is an index in the display
259 table or control character translation of that character. A
260 value < 0 means this is not a position in such a translation. */
261 int dpvec_index;
262};
263
264
265\f
266/***********************************************************************
267 Glyphs
268 ***********************************************************************/
269
270/* Enumeration of glyph types. Glyph structures contain a type field
271 containing one of the enumerators defined here. */
272
273enum glyph_type
274{
275 /* Glyph describes a character. */
177c0ea7 276 CHAR_GLYPH,
5f5c8ee5 277
a90fbbf6
KH
278 /* Glyph describes a composition sequence. */
279 COMPOSITE_GLYPH,
280
5f5c8ee5
GM
281 /* Glyph describes an image. */
282 IMAGE_GLYPH,
283
284 /* Glyph is a space of fractional width and/or height. */
285 STRETCH_GLYPH
286};
287
288
0633d52c
KS
289/* Structure describing how to use partial glyphs (images slicing) */
290
291struct glyph_slice
292{
293 unsigned x : 16;
294 unsigned y : 16;
295 unsigned width : 16;
296 unsigned height : 16;
297};
298
299
827503c6
GM
300/* Glyphs.
301
302 Be extra careful when changing this structure! Esp. make sure that
d5cc60b8 303 functions producing glyphs, like append_glyph, fill ALL of the
827503c6
GM
304 glyph structure, and that GLYPH_EQUAL_P compares all
305 display-relevant members of glyphs (not to imply that these are the
306 only things to check when you add a member). */
5f5c8ee5
GM
307
308struct glyph
309{
310 /* Position from which this glyph was drawn. If `object' below is a
311 Lisp string, this is a position in that string. If it is a
312 buffer, this is a position in that buffer. A value of -1
313 together with a null object means glyph is a truncation glyph at
314 the start of a row. */
315 int charpos;
316
317 /* Lisp object source of this glyph. Currently either a buffer or
177c0ea7 318 a string, if the glyph was produced from characters which came from
f920e581
GM
319 a buffer or a string; or 0 if the glyph was inserted by redisplay
320 for its own purposes such as padding. */
5f5c8ee5
GM
321 Lisp_Object object;
322
323 /* Width in pixels. */
324 short pixel_width;
325
01b1f0c0
KS
326 /* Ascent and descent in pixels. */
327 short ascent, descent;
328
5f5c8ee5
GM
329 /* Vertical offset. If < 0, the glyph is displayed raised, if > 0
330 the glyph is displayed lowered. */
331 short voffset;
332
333 /* Which kind of glyph this is---character, image etc. Value
334 should be an enumerator of type enum glyph_type. */
335 unsigned type : 2;
336
337 /* 1 means this glyph was produced from multibyte text. Zero
338 means it was produced from unibyte text, i.e. charsets aren't
339 applicable, and encoding is not performed. */
340 unsigned multibyte_p : 1;
341
342 /* Non-zero means draw a box line at the left or right side of this
343 glyph. This is part of the implementation of the face attribute
344 `:box'. */
345 unsigned left_box_line_p : 1;
346 unsigned right_box_line_p : 1;
347
2febf6e0
GM
348 /* Non-zero means this glyph's physical ascent or descent is greater
349 than its logical ascent/descent, i.e. it may potentially overlap
350 glyphs above or below it. */
351 unsigned overlaps_vertically_p : 1;
352
3305fc6a
KH
353 /* 1 means glyph is a padding glyph. Padding glyphs are used for
354 characters whose visual shape consists of more than one glyph
355 (e.g. Asian characters). All but the first glyph of such a glyph
356 sequence have the padding_p flag set. Only used for terminal
357 frames, and there only to minimize code changes. A better way
358 would probably be to use the width field of glyphs to express
359 padding. */
360 unsigned padding_p : 1;
361
f920e581
GM
362 /* 1 means the actual glyph is not available, draw a box instead.
363 This can happen when a font couldn't be loaded, or a character
364 doesn't have a glyph in a font. */
b3091a23
KH
365 unsigned glyph_not_available_p : 1;
366
01b1f0c0
KS
367#define FACE_ID_BITS 21
368
3305fc6a 369 /* Face of the glyph. */
01b1f0c0 370 unsigned face_id : FACE_ID_BITS;
3305fc6a 371
d5cc60b8 372 /* Type of font used to display the character glyph. May be used to
b40b05b6 373 determine which set of functions to use to obtain font metrics
d5cc60b8
KS
374 for the glyph. On W32, value should be an enumerator of the type
375 w32_char_font_type. Otherwise it equals FONT_TYPE_UNKNOWN. */
376 unsigned font_type : 3;
b40b05b6 377
0633d52c
KS
378 struct glyph_slice slice;
379
5f5c8ee5
GM
380 /* A union of sub-structures for different glyph types. */
381 union
382 {
3305fc6a
KH
383 /* Character code for character glyphs (type == CHAR_GLYPH). */
384 unsigned ch;
5f5c8ee5 385
3305fc6a
KH
386 /* Composition ID for composition glyphs (type == COMPOSITION_GLYPH) */
387 unsigned cmp_id;
a90fbbf6 388
3305fc6a
KH
389 /* Image ID for image glyphs (type == IMAGE_GLYPH). */
390 unsigned img_id;
5f5c8ee5
GM
391
392 /* Sub-structure for type == STRETCH_GLYPH. */
393 struct
394 {
395 /* The height of the glyph. */
3305fc6a 396 unsigned height : 16;
5f5c8ee5
GM
397
398 /* The ascent of the glyph. */
3305fc6a 399 unsigned ascent : 16;
5f5c8ee5
GM
400 }
401 stretch;
177c0ea7 402
5f5c8ee5
GM
403 /* Used to compare all bit-fields above in one step. */
404 unsigned val;
405 } u;
406};
407
408
d5cc60b8
KS
409/* Default value of the glyph font_type field. */
410
411#define FONT_TYPE_UNKNOWN 0
412
5f5c8ee5
GM
413/* Is GLYPH a space? */
414
415#define CHAR_GLYPH_SPACE_P(GLYPH) \
416 (GLYPH_FROM_CHAR_GLYPH ((GLYPH)) == SPACEGLYPH)
417
0633d52c
KS
418/* Are glyph slices of glyphs *X and *Y equal */
419
420#define GLYPH_SLICE_EQUAL_P(X, Y) \
421 ((X)->slice.x == (Y)->slice.x \
422 && (X)->slice.y == (Y)->slice.y \
423 && (X)->slice.width == (Y)->slice.width \
424 && (X)->slice.height == (Y)->slice.height)
425
827503c6 426/* Are glyphs *X and *Y displayed equal? */
177c0ea7 427
5f5c8ee5
GM
428#define GLYPH_EQUAL_P(X, Y) \
429 ((X)->type == (Y)->type \
430 && (X)->u.val == (Y)->u.val \
0633d52c 431 && GLYPH_SLICE_EQUAL_P (X, Y) \
3305fc6a
KH
432 && (X)->face_id == (Y)->face_id \
433 && (X)->padding_p == (Y)->padding_p \
5f5c8ee5
GM
434 && (X)->left_box_line_p == (Y)->left_box_line_p \
435 && (X)->right_box_line_p == (Y)->right_box_line_p \
726950c4
GM
436 && (X)->voffset == (Y)->voffset \
437 && (X)->pixel_width == (Y)->pixel_width)
5f5c8ee5 438
3305fc6a
KH
439/* Are character codes, faces, padding_ps of glyphs *X and *Y equal? */
440
441#define GLYPH_CHAR_AND_FACE_EQUAL_P(X, Y) \
442 ((X)->u.ch == (Y)->u.ch \
443 && (X)->face_id == (Y)->face_id \
444 && (X)->padding_p == (Y)->padding_p)
445
5f5c8ee5
GM
446/* Fill a character glyph GLYPH. CODE, FACE_ID, PADDING_P correspond
447 to the bits defined for the typedef `GLYPH' in lisp.h. */
177c0ea7 448
5f5c8ee5
GM
449#define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P) \
450 do \
451 { \
3305fc6a
KH
452 (GLYPH).u.ch = (CODE); \
453 (GLYPH).face_id = (FACE_ID); \
454 (GLYPH).padding_p = (PADDING_P); \
5f5c8ee5
GM
455 } \
456 while (0)
457
458/* Fill a character type glyph GLYPH from a glyph typedef FROM as
459 defined in lisp.h. */
177c0ea7 460
5f5c8ee5
GM
461#define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM) \
462 SET_CHAR_GLYPH ((GLYPH), \
463 FAST_GLYPH_CHAR ((FROM)), \
464 FAST_GLYPH_FACE ((FROM)), \
3305fc6a 465 0)
5f5c8ee5 466
3305fc6a
KH
467/* Construct a glyph code from a character glyph GLYPH. If the
468 character is multibyte, return -1 as we can't use glyph table for a
54bff0bd 469 multibyte character. */
177c0ea7 470
4728a553
GM
471#define GLYPH_FROM_CHAR_GLYPH(GLYPH) \
472 ((GLYPH).u.ch < 256 \
473 ? ((GLYPH).u.ch | ((GLYPH).face_id << CHARACTERBITS)) \
3305fc6a 474 : -1)
5f5c8ee5
GM
475
476/* Is GLYPH a padding glyph? */
177c0ea7 477
3305fc6a 478#define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p
5f5c8ee5
GM
479
480
481
482\f
483/***********************************************************************
484 Glyph Pools
485 ***********************************************************************/
486
487/* Glyph Pool.
488
489 Glyph memory for frame-based redisplay is allocated from the heap
490 in one vector kept in a glyph pool structure which is stored with
491 the frame. The size of the vector is made large enough to cover
492 all windows on the frame.
493
494 Both frame and window glyph matrices reference memory from a glyph
495 pool in frame-based redisplay.
496
497 In window-based redisplay, no glyphs pools exist; windows allocate
498 and free their glyph memory themselves. */
499
500struct glyph_pool
501{
502 /* Vector of glyphs allocated from the heap. */
503 struct glyph *glyphs;
504
505 /* Allocated size of `glyphs'. */
506 int nglyphs;
507
508 /* Number of rows and columns in a matrix. */
509 int nrows, ncolumns;
510};
511
512
513\f
514/***********************************************************************
515 Glyph Matrix
516 ***********************************************************************/
517
518/* Glyph Matrix.
519
520 Three kinds of glyph matrices exist:
521
522 1. Frame glyph matrices. These are used for terminal frames whose
523 redisplay needs a view of the whole screen due to limited terminal
524 capabilities. Frame matrices are used only in the update phase
525 of redisplay. They are built in update_frame and not used after
526 the update has been performed.
527
528 2. Window glyph matrices on frames having frame glyph matrices.
529 Such matrices are sub-matrices of their corresponding frame matrix,
530 i.e. frame glyph matrices and window glyph matrices share the same
531 glyph memory which is allocated in form of a glyph_pool structure.
532 Glyph rows in such a window matrix are slices of frame matrix rows.
533
534 2. Free-standing window glyph matrices managing their own glyph
535 storage. This form is used in window-based redisplay which
536 includes variable width and height fonts etc.
537
538 The size of a window's row vector depends on the height of fonts
539 defined on its frame. It is chosen so that the vector is large
540 enough to describe all lines in a window when it is displayed in
541 the smallest possible character size. When new fonts are loaded,
542 or window sizes change, the row vector is adjusted accordingly. */
543
544struct glyph_matrix
545{
546 /* The pool from which glyph memory is allocated, if any. This is
547 null for frame matrices and for window matrices managing their
548 own storage. */
549 struct glyph_pool *pool;
550
551 /* Vector of glyph row structures. The row at nrows - 1 is reserved
552 for the mode line. */
553 struct glyph_row *rows;
554
555 /* Number of elements allocated for the vector rows above. */
556 int rows_allocated;
557
558 /* The number of rows used by the window if all lines were displayed
559 with the smallest possible character height. */
560 int nrows;
561
562 /* Origin within the frame matrix if this is a window matrix on a
563 frame having a frame matrix. Both values are zero for
564 window-based redisplay. */
565 int matrix_x, matrix_y;
566
567 /* Width and height of the matrix in columns and rows. */
568 int matrix_w, matrix_h;
569
6df72db9 570 /* If this structure describes a window matrix of window W,
87388f9d
KS
571 window_left_col is the value of W->left_col, window_top_line the
572 value of W->top_line, window_height and window_width are width and
573 height of W, as returned by window_box, and window_vscroll is the
574 value of W->vscroll at the time the matrix was last adjusted.
575 Only set for window-based redisplay. */
576 int window_left_col, window_top_line;
577 int window_height, window_width;
578 int window_vscroll;
5f5c8ee5
GM
579
580 /* Number of glyphs reserved for left and right marginal areas when
581 the matrix was last adjusted. */
582 int left_margin_glyphs, right_margin_glyphs;
583
584 /* Flag indicating that scrolling should not be tried in
585 update_window. This flag is set by functions like try_window_id
586 which do their own scrolling. */
587 unsigned no_scrolling_p : 1;
588
589 /* Non-zero means window displayed in this matrix has a top mode
590 line. */
045dee35 591 unsigned header_line_p : 1;
5f5c8ee5
GM
592
593#ifdef GLYPH_DEBUG
594 /* A string identifying the method used to display the matrix. */
595 char method[512];
596#endif
2201e367 597
a36d22d2
GM
598 /* The buffer this matrix displays. Set in
599 mark_window_display_accurate_1. */
2201e367
GM
600 struct buffer *buffer;
601
a36d22d2
GM
602 /* Values of BEGV and ZV as of last redisplay. Set in
603 mark_window_display_accurate_1. */
2201e367 604 int begv, zv;
5f5c8ee5
GM
605};
606
607
608/* Check that glyph pointers stored in glyph rows of MATRIX are okay.
609 This aborts if any pointer is found twice. */
610
611#if GLYPH_DEBUG
612void check_matrix_pointer_lossage P_ ((struct glyph_matrix *));
613#define CHECK_MATRIX(MATRIX) check_matrix_pointer_lossage ((MATRIX))
614#else
615#define CHECK_MATRIX(MATRIX) (void) 0
616#endif
617
618
619\f
620/***********************************************************************
621 Glyph Rows
622 ***********************************************************************/
623
624/* Area in window glyph matrix. If values are added or removed, the
625 function mark_object in alloc.c has to be changed. */
626
627enum glyph_row_area
628{
629 LEFT_MARGIN_AREA,
630 TEXT_AREA,
631 RIGHT_MARGIN_AREA,
632 LAST_AREA
633};
634
635
636/* Rows of glyphs in a windows or frame glyph matrix.
637
638 Each row is partitioned into three areas. The start and end of
639 each area is recorded in a pointer as shown below.
177c0ea7 640
5f5c8ee5
GM
641 +--------------------+-------------+---------------------+
642 | left margin area | text area | right margin area |
643 +--------------------+-------------+---------------------+
644 | | | |
645 glyphs[LEFT_MARGIN_AREA] glyphs[RIGHT_MARGIN_AREA]
646 | |
647 glyphs[TEXT_AREA] |
177c0ea7 648 glyphs[LAST_AREA]
5f5c8ee5
GM
649
650 Rows in frame matrices reference glyph memory allocated in a frame
651 glyph pool (see the description of struct glyph_pool). Rows in
652 window matrices on frames having frame matrices reference slices of
653 the glyphs of corresponding rows in the frame matrix.
177c0ea7 654
5f5c8ee5
GM
655 Rows in window matrices on frames having no frame matrices point to
656 glyphs allocated from the heap via xmalloc;
657 glyphs[LEFT_MARGIN_AREA] is the start address of the allocated
658 glyph structure array. */
659
660struct glyph_row
661{
662 /* Pointers to beginnings of areas. The end of an area A is found at
663 A + 1 in the vector. The last element of the vector is the end
664 of the whole row.
665
666 Kludge alert: Even if used[TEXT_AREA] == 0, glyphs[TEXT_AREA][0]'s
667 position field is used. It is -1 if this row does not correspond
668 to any text; it is some buffer position if the row corresponds to
669 an empty display line that displays a line end. This is what old
670 redisplay used to do. (Except in code for terminal frames, this
54bff0bd 671 kludge is no longer used, I believe. --gerd).
5f5c8ee5
GM
672
673 See also start, end, displays_text_p and ends_at_zv_p for cleaner
674 ways to do it. The special meaning of positions 0 and -1 will be
675 removed some day, so don't use it in new code. */
676 struct glyph *glyphs[1 + LAST_AREA];
677
678 /* Number of glyphs actually filled in areas. */
679 short used[LAST_AREA];
680
681 /* Window-relative x and y-position of the top-left corner of this
682 row. If y < 0, this means that abs (y) pixels of the row are
683 invisible because it is partially visible at the top of a window.
684 If x < 0, this means that abs (x) pixels of the first glyph of
685 the text area of the row are invisible because the glyph is
686 partially visible. */
687 int x, y;
688
689 /* Width of the row in pixels without taking face extension at the
6332ca8a
GM
690 end of the row into account, and without counting truncation
691 and continuation glyphs at the end of a row on ttys. */
5f5c8ee5
GM
692 int pixel_width;
693
2febf6e0
GM
694 /* Logical ascent/height of this line. The value of ascent is zero
695 and height is 1 on terminal frames. */
5f5c8ee5
GM
696 int ascent, height;
697
2febf6e0
GM
698 /* Physical ascent/height of this line. If max_ascent > ascent,
699 this line overlaps the line above it on the display. Otherwise,
700 if max_height > height, this line overlaps the line beneath it. */
701 int phys_ascent, phys_height;
702
5f5c8ee5
GM
703 /* Portion of row that is visible. Partially visible rows may be
704 found at the top and bottom of a window. This is 1 for tty
705 frames. It may be < 0 in case of completely invisible rows. */
706 int visible_height;
707
db0c5a7d
KS
708 /* Extra line spacing added after this row. Do not consider this
709 in last row when checking if row is fully visible. */
710 int extra_line_spacing;
711
5f5c8ee5
GM
712 /* Hash code. This hash code is available as soon as the row
713 is constructed, i.e. after a call to display_line. */
714 unsigned hash;
715
716 /* First position in this row. This is the text position, including
717 overlay position information etc, where the display of this row
718 started, and can thus be less the position of the first glyph
719 (e.g. due to invisible text or horizontal scrolling). */
720 struct display_pos start;
721
722 /* Text position at the end of this row. This is the position after
723 the last glyph on this row. It can be greater than the last
724 glyph position + 1, due to truncation, invisible text etc. In an
725 up-to-date display, this should always be equal to the start
726 position of the next row. */
727 struct display_pos end;
728
557c387e 729 /* Left fringe bitmap number (enum fringe_bitmap_type). */
2251a6f2
KS
730 unsigned left_user_fringe_bitmap : FRINGE_ID_BITS;
731
2251a6f2
KS
732 /* Right fringe bitmap number (enum fringe_bitmap_type). */
733 unsigned right_user_fringe_bitmap : FRINGE_ID_BITS;
734
2251a6f2
KS
735 /* Left fringe bitmap number (enum fringe_bitmap_type). */
736 unsigned left_fringe_bitmap : FRINGE_ID_BITS;
737
557c387e 738 /* Right fringe bitmap number (enum fringe_bitmap_type). */
2251a6f2
KS
739 unsigned right_fringe_bitmap : FRINGE_ID_BITS;
740
b3b08f03
KS
741 /* Face of the left fringe glyph. */
742 unsigned left_user_fringe_face_id : FACE_ID_BITS;
743
744 /* Face of the right fringe glyph. */
745 unsigned right_user_fringe_face_id : FACE_ID_BITS;
746
747 /* Face of the left fringe glyph. */
748 unsigned left_fringe_face_id : FACE_ID_BITS;
749
2251a6f2
KS
750 /* Face of the right fringe glyph. */
751 unsigned right_fringe_face_id : FACE_ID_BITS;
557c387e
KS
752
753 /* 1 means that we must draw the bitmaps of this row. */
754 unsigned redraw_fringe_bitmaps_p : 1;
755
5f5c8ee5
GM
756 /* In a desired matrix, 1 means that this row must be updated. In a
757 current matrix, 0 means that the row has been invalidated, i.e.
758 the row's contents do not agree with what is visible on the
759 screen. */
760 unsigned enabled_p : 1;
761
5f5c8ee5
GM
762 /* 1 means row displays a text line that is truncated on the left or
763 right side. */
764 unsigned truncated_on_left_p : 1;
765 unsigned truncated_on_right_p : 1;
766
767 /* 1 means the overlay arrow is on this line. */
768 unsigned overlay_arrow_p : 1;
177c0ea7 769
5f5c8ee5
GM
770 /* 1 means that this row displays a continued line, i.e. it has a
771 continuation mark at the right side. */
772 unsigned continued_p : 1;
773
774 /* 0 means that this row does not contain any text, i.e. it is
775 a blank line at the window and buffer end. */
776 unsigned displays_text_p : 1;
777
778 /* 1 means that this line ends at ZV. */
779 unsigned ends_at_zv_p : 1;
780
781 /* 1 means the face of the last glyph in the text area is drawn to
782 the right end of the window. This flag is used in
783 update_text_area to optimize clearing to the end of the area. */
784 unsigned fill_line_p : 1;
785
786 /* Non-zero means display a bitmap on X frames indicating that this
787 line contains no text and ends in ZV. */
788 unsigned indicate_empty_line_p : 1;
789
790 /* 1 means this row contains glyphs that overlap each other because
791 of lbearing or rbearing. */
792 unsigned contains_overlapping_glyphs_p : 1;
793
54bff0bd 794 /* 1 means this row is as wide as the window it is displayed in, including
afb7aabb 795 scroll bars, fringes, and internal borders. This also
5f5c8ee5
GM
796 implies that the row doesn't have marginal areas. */
797 unsigned full_width_p : 1;
798
54bff0bd 799 /* Non-zero means row is a mode or header-line. */
5f5c8ee5
GM
800 unsigned mode_line_p : 1;
801
2febf6e0
GM
802 /* 1 in a current row means this row is overlapped by another row. */
803 unsigned overlapped_p : 1;
804
666852af
GM
805 /* 1 means this line ends in the middle of a character consisting
806 of more than one glyph. Some glyphs have been put in this row,
807 the rest are put in rows below this one. */
808 unsigned ends_in_middle_of_char_p : 1;
177c0ea7 809
666852af
GM
810 /* 1 means this line starts in the middle of a character consisting
811 of more than one glyph. Some glyphs have been put in the
54bff0bd 812 previous row, the rest are put in this row. */
666852af
GM
813 unsigned starts_in_middle_of_char_p : 1;
814
2febf6e0
GM
815 /* 1 in a current row means this row overlaps others. */
816 unsigned overlapping_p : 1;
817
48b509fe
GM
818 /* 1 means some glyphs in this row are displayed in mouse-face. */
819 unsigned mouse_face_p : 1;
820
257e3f57
GM
821 /* 1 means this row was ended by a newline from a string. */
822 unsigned ends_in_newline_from_string_p : 1;
823
557c387e
KS
824 /* 1 means this row width is exactly the width of the window, and the
825 final newline character is hidden in the right fringe. */
826 unsigned exact_window_width_line_p : 1;
827
828 /* 1 means this row currently shows the cursor in the right fringe. */
829 unsigned cursor_in_fringe_p : 1;
830
b437860a
RS
831 /* 1 means the last glyph in the row is part of an ellipsis. */
832 unsigned ends_in_ellipsis_p : 1;
833
557c387e
KS
834 /* Non-zero means display a bitmap on X frames indicating that this
835 the first line of the buffer. */
836 unsigned indicate_bob_p : 1;
837
838 /* Non-zero means display a bitmap on X frames indicating that this
839 the top line of the window, but not start of the buffer. */
840 unsigned indicate_top_line_p : 1;
841
842 /* Non-zero means display a bitmap on X frames indicating that this
843 the last line of the buffer. */
844 unsigned indicate_eob_p : 1;
845
846 /* Non-zero means display a bitmap on X frames indicating that this
847 the bottom line of the window, but not end of the buffer. */
848 unsigned indicate_bottom_line_p : 1;
849
5f5c8ee5
GM
850 /* Continuation lines width at the start of the row. */
851 int continuation_lines_width;
852};
853
854
855/* Get a pointer to row number ROW in matrix MATRIX. If GLYPH_DEBUG
856 is defined to a non-zero value, the function matrix_row checks that
857 we don't try to access rows that are out of bounds. */
858
859#if GLYPH_DEBUG
860struct glyph_row *matrix_row P_ ((struct glyph_matrix *, int));
861#define MATRIX_ROW(MATRIX, ROW) matrix_row ((MATRIX), (ROW))
862#else
863#define MATRIX_ROW(MATRIX, ROW) ((MATRIX)->rows + (ROW))
864#endif
865
177c0ea7 866/* Return a pointer to the row reserved for the mode line in MATRIX.
5f5c8ee5
GM
867 Row MATRIX->nrows - 1 is always reserved for the mode line. */
868
869#define MATRIX_MODE_LINE_ROW(MATRIX) \
870 ((MATRIX)->rows + (MATRIX)->nrows - 1)
871
54bff0bd 872/* Return a pointer to the row reserved for the header line in MATRIX.
5f5c8ee5
GM
873 This is always the first row in MATRIX because that's the only
874 way that works in frame-based redisplay. */
875
045dee35 876#define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows
5f5c8ee5
GM
877
878/* Return a pointer to first row in MATRIX used for text display. */
879
880#define MATRIX_FIRST_TEXT_ROW(MATRIX) \
881 ((MATRIX)->rows->mode_line_p ? (MATRIX)->rows + 1 : (MATRIX)->rows)
882
883/* Return a pointer to the first glyph in the text area of a row.
884 MATRIX is the glyph matrix accessed, and ROW is the row index in
885 MATRIX. */
886
887#define MATRIX_ROW_GLYPH_START(MATRIX, ROW) \
888 (MATRIX_ROW ((MATRIX), (ROW))->glyphs[TEXT_AREA])
889
890/* Return the number of used glyphs in the text area of a row. */
177c0ea7 891
5f5c8ee5
GM
892#define MATRIX_ROW_USED(MATRIX, ROW) \
893 (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA])
894
895/* Return the character/ byte position at which the display of ROW
896 starts. */
177c0ea7 897
5f5c8ee5
GM
898#define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->start.pos.charpos)
899#define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->start.pos.bytepos)
900
54bff0bd 901/* Return the character/ byte position at which ROW ends. */
177c0ea7 902
5f5c8ee5
GM
903#define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->end.pos.charpos)
904#define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->end.pos.bytepos)
905
906/* Return the vertical position of ROW in MATRIX. */
177c0ea7 907
5f5c8ee5
GM
908#define MATRIX_ROW_VPOS(ROW, MATRIX) ((ROW) - (MATRIX)->rows)
909
910/* Return the last glyph row + 1 in MATRIX on window W reserved for
911 text. If W has a mode line, the last row in the matrix is reserved
912 for it. */
177c0ea7 913
5f5c8ee5
GM
914#define MATRIX_BOTTOM_TEXT_ROW(MATRIX, W) \
915 ((MATRIX)->rows \
916 + (MATRIX)->nrows \
917 - (WINDOW_WANTS_MODELINE_P ((W)) ? 1 : 0))
918
919/* Non-zero if the face of the last glyph in ROW's text area has
920 to be drawn to the end of the text area. */
177c0ea7 921
5f5c8ee5
GM
922#define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)
923
924/* Set and query the enabled_p flag of glyph row ROW in MATRIX. */
177c0ea7 925
5f5c8ee5
GM
926#define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
927 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0)
177c0ea7 928
5f5c8ee5
GM
929#define MATRIX_ROW_ENABLED_P(MATRIX, ROW) \
930 (MATRIX_ROW ((MATRIX), (ROW))->enabled_p)
931
932/* Non-zero if ROW displays text. Value is non-zero if the row is
933 blank but displays a line end. */
177c0ea7 934
5f5c8ee5
GM
935#define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)
936
db0c5a7d
KS
937
938/* Helper macros */
939
940#define MR_PARTIALLY_VISIBLE(ROW) \
941 ((ROW)->height != (ROW)->visible_height)
942
943#define MR_PARTIALLY_VISIBLE_AT_TOP(W, ROW) \
944 ((ROW)->y < WINDOW_HEADER_LINE_HEIGHT ((W)))
945
946#define MR_PARTIALLY_VISIBLE_AT_BOTTOM(W, ROW) \
947 (((ROW)->y + (ROW)->height - (ROW)->extra_line_spacing) \
948 > WINDOW_BOX_HEIGHT_NO_MODE_LINE ((W)))
949
5f5c8ee5 950/* Non-zero if ROW is not completely visible in window W. */
177c0ea7 951
db0c5a7d
KS
952#define MATRIX_ROW_PARTIALLY_VISIBLE_P(W, ROW) \
953 (MR_PARTIALLY_VISIBLE ((ROW)) \
954 && (MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)) \
955 || MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW))))
956
957
5f5c8ee5
GM
958
959/* Non-zero if ROW is partially visible at the top of window W. */
177c0ea7 960
5f5c8ee5 961#define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW) \
db0c5a7d
KS
962 (MR_PARTIALLY_VISIBLE ((ROW)) \
963 && MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)))
5f5c8ee5
GM
964
965/* Non-zero if ROW is partially visible at the bottom of window W. */
177c0ea7 966
db0c5a7d
KS
967#define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW) \
968 (MR_PARTIALLY_VISIBLE ((ROW)) \
969 && MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW)))
5f5c8ee5
GM
970
971/* Return the bottom Y + 1 of ROW. */
177c0ea7 972
5f5c8ee5
GM
973#define MATRIX_ROW_BOTTOM_Y(ROW) ((ROW)->y + (ROW)->height)
974
975/* Is ROW the last visible one in the display described by the
976 iterator structure pointed to by IT?. */
177c0ea7 977
5f5c8ee5
GM
978#define MATRIX_ROW_LAST_VISIBLE_P(ROW, IT) \
979 (MATRIX_ROW_BOTTOM_Y ((ROW)) >= (IT)->last_visible_y)
980
981/* Non-zero if ROW displays a continuation line. */
982
983#define MATRIX_ROW_CONTINUATION_LINE_P(ROW) \
984 ((ROW)->continuation_lines_width > 0)
985
986/* Non-zero if ROW ends in the middle of a character. This is the
987 case for continued lines showing only part of a display table entry
988 or a control char, or an overlay string. */
989
990#define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW) \
e6fb381c 991 ((ROW)->end.dpvec_index > 0 \
666852af
GM
992 || (ROW)->end.overlay_string_index >= 0 \
993 || (ROW)->ends_in_middle_of_char_p)
5f5c8ee5
GM
994
995/* Non-zero if ROW ends in the middle of an overlay string. */
996
997#define MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P(ROW) \
998 ((ROW)->end.overlay_string_index >= 0)
999
1000/* Non-zero if ROW starts in the middle of a character. See above. */
177c0ea7 1001
5f5c8ee5 1002#define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW) \
e6fb381c 1003 ((ROW)->start.dpvec_index > 0 \
666852af 1004 || (ROW)->starts_in_middle_of_char_p \
5f5c8ee5
GM
1005 || ((ROW)->start.overlay_string_index >= 0 \
1006 && (ROW)->start.string_pos.charpos > 0))
1007
2febf6e0
GM
1008/* Non-zero means ROW overlaps its predecessor. */
1009
1010#define MATRIX_ROW_OVERLAPS_PRED_P(ROW) \
1011 ((ROW)->phys_ascent > (ROW)->ascent)
1012
1013/* Non-zero means ROW overlaps its successor. */
1014
1015#define MATRIX_ROW_OVERLAPS_SUCC_P(ROW) \
1016 ((ROW)->phys_height - (ROW)->phys_ascent \
1017 > (ROW)->height - (ROW)->ascent)
1018
5f5c8ee5
GM
1019/* Non-zero means that fonts have been loaded since the last glyph
1020 matrix adjustments. The function redisplay_internal adjusts glyph
1021 matrices when this flag is non-zero. */
1022
1023extern int fonts_changed_p;
1024
1025/* A glyph for a space. */
1026
1027extern struct glyph space_glyph;
1028
fe01239f
GM
1029/* Frame being updated by update_window/update_frame. */
1030
1031extern struct frame *updating_frame;
1032
5f5c8ee5
GM
1033/* Window being updated by update_window. This is non-null as long as
1034 update_window has not finished, and null otherwise. It's role is
1035 analogous to updating_frame. */
1036
1037extern struct window *updated_window;
1038
1039/* Glyph row and area updated by update_window_line. */
1040
1041extern struct glyph_row *updated_row;
1042extern int updated_area;
1043
1044/* Non-zero means reading single-character input with prompt so put
1045 cursor on mini-buffer after the prompt. Positive means at end of
1046 text in echo area; negative means at beginning of line. */
1047
1048extern int cursor_in_echo_area;
1049
1050/* Non-zero means last display completed. Zero means it was
1051 preempted. */
1052
1053extern int display_completed;
1054
1055/* Non-zero means redisplay has been performed directly (see also
1056 direct_output_for_insert and direct_output_forward_char), so that
1057 no further updating has to be performed. The function
1058 redisplay_internal checks this flag, and does nothing but reset it
1059 to zero if it is non-zero. */
1060
1061extern int redisplay_performed_directly_p;
1062
1063/* A temporary storage area, including a row of glyphs. Initialized
1064 in xdisp.c. Used for various purposes, as an example see
1065 direct_output_for_insert. */
1066
1067extern struct glyph_row scratch_glyph_row;
1068
1069
1070\f
d5cc60b8
KS
1071/************************************************************************
1072 Glyph Strings
1073 ************************************************************************/
1074
1075/* Enumeration for overriding/changing the face to use for drawing
d74b2553 1076 glyphs in draw_glyphs. */
d5cc60b8
KS
1077
1078enum draw_glyphs_face
1079{
1080 DRAW_NORMAL_TEXT,
1081 DRAW_INVERSE_VIDEO,
1082 DRAW_CURSOR,
1083 DRAW_MOUSE_FACE,
1084 DRAW_IMAGE_RAISED,
1085 DRAW_IMAGE_SUNKEN
1086};
1087
79fa9e0f
KS
1088#ifdef HAVE_WINDOW_SYSTEM
1089
d5cc60b8
KS
1090/* A sequence of glyphs to be drawn in the same face. */
1091
1092struct glyph_string
1093{
1094 /* X-origin of the string. */
1095 int x;
1096
1097 /* Y-origin and y-position of the base line of this string. */
1098 int y, ybase;
1099
1100 /* The width of the string, not including a face extension. */
1101 int width;
1102
1103 /* The width of the string, including a face extension. */
1104 int background_width;
1105
1106 /* The height of this string. This is the height of the line this
1107 string is drawn in, and can be different from the height of the
1108 font the string is drawn in. */
1109 int height;
1110
1111 /* Number of pixels this string overwrites in front of its x-origin.
1112 This number is zero if the string has an lbearing >= 0; it is
1113 -lbearing, if the string has an lbearing < 0. */
1114 int left_overhang;
1115
1116 /* Number of pixels this string overwrites past its right-most
1117 nominal x-position, i.e. x + width. Zero if the string's
1118 rbearing is <= its nominal width, rbearing - width otherwise. */
1119 int right_overhang;
1120
1121 /* The frame on which the glyph string is drawn. */
1122 struct frame *f;
1123
1124 /* The window on which the glyph string is drawn. */
1125 struct window *w;
1126
1127 /* X display and window for convenience. */
1128 Display *display;
1129 Window window;
1130
1131 /* The glyph row for which this string was built. It determines the
1132 y-origin and height of the string. */
1133 struct glyph_row *row;
1134
1135 /* The area within row. */
1136 enum glyph_row_area area;
1137
1138 /* Characters to be drawn, and number of characters. */
1139 XChar2b *char2b;
1140 int nchars;
1141
1142 /* A face-override for drawing cursors, mouse face and similar. */
1143 enum draw_glyphs_face hl;
1144
1145 /* Face in which this string is to be drawn. */
1146 struct face *face;
1147
1148 /* Font in which this string is to be drawn. */
1149 XFontStruct *font;
1150
1151 /* Font info for this string. */
1152 struct font_info *font_info;
1153
1154 /* Non-null means this string describes (part of) a composition.
1155 All characters from char2b are drawn composed. */
1156 struct composition *cmp;
1157
1158 /* Index of this glyph string's first character in the glyph
1159 definition of CMP. If this is zero, this glyph string describes
1160 the first character of a composition. */
1161 int gidx;
1162
1163 /* 1 means this glyph strings face has to be drawn to the right end
1164 of the window's drawing area. */
1165 unsigned extends_to_end_of_line_p : 1;
1166
1167 /* 1 means the background of this string has been drawn. */
1168 unsigned background_filled_p : 1;
1169
1170 /* 1 means glyph string must be drawn with 16-bit functions. */
1171 unsigned two_byte_p : 1;
1172
1173 /* 1 means that the original font determined for drawing this glyph
1174 string could not be loaded. The member `font' has been set to
1175 the frame's default font in this case. */
1176 unsigned font_not_found_p : 1;
1177
1178 /* 1 means that the face in which this glyph string is drawn has a
1179 stipple pattern. */
1180 unsigned stippled_p : 1;
1181
1182 /* 1 means only the foreground of this glyph string must be drawn,
1183 and we should use the physical height of the line this glyph
1184 string appears in as clip rect. */
1185 unsigned for_overlaps_p : 1;
1186
1187 /* The GC to use for drawing this glyph string. */
b15325b2 1188#if defined(HAVE_X_WINDOWS) || defined(MAC_OS)
d5cc60b8
KS
1189 GC gc;
1190#endif
1191#if defined(HAVE_NTGUI)
1192 XGCValues *gc;
1193 HDC hdc;
1194#endif
1195
1196 /* A pointer to the first glyph in the string. This glyph
1197 corresponds to char2b[0]. Needed to draw rectangles if
1198 font_not_found_p is 1. */
1199 struct glyph *first_glyph;
1200
1201 /* Image, if any. */
1202 struct image *img;
1203
0633d52c
KS
1204 /* Slice */
1205 struct glyph_slice slice;
1206
8c2da0fa
ST
1207 /* Non-null means the horizontal clipping region starts from the
1208 left edge of *clip_head, and ends with the right edge of
1209 *clip_tail, not including their overhangs. */
1210 struct glyph_string *clip_head, *clip_tail;
1211
d5cc60b8
KS
1212 struct glyph_string *next, *prev;
1213};
1214
79fa9e0f 1215#endif /* HAVE_WINDOW_SYSTEM */
d5cc60b8
KS
1216
1217\f
5f5c8ee5
GM
1218/************************************************************************
1219 Display Dimensions
1220 ************************************************************************/
1221
1222/* Return the height of the mode line in glyph matrix MATRIX, or zero
1223 if not known. This macro is called under circumstances where
1224 MATRIX might not have been allocated yet. */
1225
1226#define MATRIX_MODE_LINE_HEIGHT(MATRIX) \
1227 ((MATRIX) && (MATRIX)->rows \
1228 ? MATRIX_MODE_LINE_ROW (MATRIX)->height \
1229 : 0)
1230
54bff0bd 1231/* Return the height of the header line in glyph matrix MATRIX, or zero
5f5c8ee5
GM
1232 if not known. This macro is called under circumstances where
1233 MATRIX might not have been allocated yet. */
1234
045dee35 1235#define MATRIX_HEADER_LINE_HEIGHT(MATRIX) \
5f5c8ee5 1236 ((MATRIX) && (MATRIX)->rows \
045dee35 1237 ? MATRIX_HEADER_LINE_ROW (MATRIX)->height \
5f5c8ee5
GM
1238 : 0)
1239
a4610492
KS
1240/* Return the desired face id for the mode line of a window, depending
1241 on whether the window is selected or not, or if the window is the
1242 scrolling window for the currently active minibuffer window.
1243
1244 Due to the way display_mode_lines manipulates with the contents of
1245 selected_window, this macro needs three arguments: SELW which is
1246 compared against the current value of selected_window, MBW which is
1247 compared against minibuf_window (if SELW doesn't match), and SCRW
5705966b 1248 which is compared against minibuf_selected_window (if MBW matches). */
a4610492
KS
1249
1250#define CURRENT_MODE_LINE_FACE_ID_3(SELW, MBW, SCRW) \
5f380a5b 1251 ((!mode_line_in_non_selected_windows \
a4610492 1252 || (SELW) == XWINDOW (selected_window) \
5f380a5b 1253 || (minibuf_level > 0 \
5705966b 1254 && !NILP (minibuf_selected_window) \
5f380a5b 1255 && (MBW) == XWINDOW (minibuf_window) \
5705966b 1256 && (SCRW) == XWINDOW (minibuf_selected_window))) \
a4610492
KS
1257 ? MODE_LINE_FACE_ID \
1258 : MODE_LINE_INACTIVE_FACE_ID)
1259
1260
1261/* Return the desired face id for the mode line of window W. */
f6911ea7
KS
1262
1263#define CURRENT_MODE_LINE_FACE_ID(W) \
a4610492 1264 (CURRENT_MODE_LINE_FACE_ID_3((W), XWINDOW (selected_window), (W)))
f6911ea7 1265
5f5c8ee5 1266/* Return the current height of the mode line of window W. If not
e9e32f46
GM
1267 known from current_mode_line_height, look at W's current glyph
1268 matrix, or return a default based on the height of the font of the
1269 face `mode-line'. */
1270
1271#define CURRENT_MODE_LINE_HEIGHT(W) \
1272 (current_mode_line_height >= 0 \
1273 ? current_mode_line_height \
1274 : (MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1275 ? MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix) \
1276 : estimate_mode_line_height (XFRAME ((W)->frame), \
f6911ea7 1277 CURRENT_MODE_LINE_FACE_ID (W))))
5f5c8ee5 1278
54bff0bd 1279/* Return the current height of the header line of window W. If not
e9e32f46
GM
1280 known from current_header_line_height, look at W's current glyph
1281 matrix, or return an estimation based on the height of the font of
1282 the face `header-line'. */
1283
1284#define CURRENT_HEADER_LINE_HEIGHT(W) \
1285 (current_header_line_height >= 0 \
1286 ? current_header_line_height \
1287 : (MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1288 ? MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix) \
1289 : estimate_mode_line_height (XFRAME ((W)->frame), \
1290 HEADER_LINE_FACE_ID)))
5f5c8ee5
GM
1291
1292/* Return the height of the desired mode line of window W. */
1293
1294#define DESIRED_MODE_LINE_HEIGHT(W) \
1295 MATRIX_MODE_LINE_HEIGHT ((W)->desired_matrix)
1296
54bff0bd 1297/* Return the height of the desired header line of window W. */
5f5c8ee5 1298
045dee35
GM
1299#define DESIRED_HEADER_LINE_HEIGHT(W) \
1300 MATRIX_HEADER_LINE_HEIGHT ((W)->desired_matrix)
5f5c8ee5 1301
54bff0bd 1302/* Value is non-zero if window W wants a mode line. */
5f5c8ee5
GM
1303
1304#define WINDOW_WANTS_MODELINE_P(W) \
2e8834ed 1305 (!MINI_WINDOW_P ((W)) \
5f5c8ee5 1306 && !(W)->pseudo_window_p \
2e8834ed 1307 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
8801a864 1308 && BUFFERP ((W)->buffer) \
2e8834ed 1309 && !NILP (XBUFFER ((W)->buffer)->mode_line_format) \
87388f9d 1310 && WINDOW_TOTAL_LINES (W) > 1)
5f5c8ee5 1311
54bff0bd 1312/* Value is non-zero if window W wants a header line. */
5f5c8ee5 1313
045dee35 1314#define WINDOW_WANTS_HEADER_LINE_P(W) \
2e8834ed 1315 (!MINI_WINDOW_P ((W)) \
5f5c8ee5 1316 && !(W)->pseudo_window_p \
2e8834ed 1317 && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \
8801a864 1318 && BUFFERP ((W)->buffer) \
2e8834ed 1319 && !NILP (XBUFFER ((W)->buffer)->header_line_format) \
87388f9d 1320 && WINDOW_TOTAL_LINES (W) > 1 + !NILP (XBUFFER ((W)->buffer)->mode_line_format))
5f5c8ee5 1321
d74b2553
KS
1322
1323/* Return proper value to be used as baseline offset of font that has
1324 ASCENT and DESCENT to draw characters by the font at the vertical
1325 center of the line of frame F.
1326
1327 Here, our task is to find the value of BOFF in the following figure;
1328
1329 -------------------------+-----------+-
1330 -+-+---------+-+ | |
1331 | | | | | |
1332 | | | | F_ASCENT F_HEIGHT
1333 | | | ASCENT | |
1334 HEIGHT | | | | |
1335 | | |-|-+------+-----------|------- baseline
1336 | | | | BOFF | |
1337 | |---------|-+-+ | |
1338 | | | DESCENT | |
1339 -+-+---------+-+ F_DESCENT |
1340 -------------------------+-----------+-
1341
1342 -BOFF + DESCENT + (F_HEIGHT - HEIGHT) / 2 = F_DESCENT
1343 BOFF = DESCENT + (F_HEIGHT - HEIGHT) / 2 - F_DESCENT
1344 DESCENT = FONT->descent
1345 HEIGHT = FONT_HEIGHT (FONT)
87388f9d 1346 F_DESCENT = (FRAME_FONT (F)->descent
d74b2553
KS
1347 - F->output_data.x->baseline_offset)
1348 F_HEIGHT = FRAME_LINE_HEIGHT (F)
1349*/
1350
1351#define VCENTER_BASELINE_OFFSET(FONT, F) \
1352 (FONT_DESCENT (FONT) \
1353 + (FRAME_LINE_HEIGHT ((F)) - FONT_HEIGHT ((FONT)) \
1354 + (FRAME_LINE_HEIGHT ((F)) > FONT_HEIGHT ((FONT)))) / 2 \
1355 - (FONT_DESCENT (FRAME_FONT (F)) - FRAME_BASELINE_OFFSET (F)))
1356
177c0ea7 1357\f
5f5c8ee5
GM
1358/***********************************************************************
1359 Faces
1360 ***********************************************************************/
177c0ea7 1361
5f5c8ee5
GM
1362/* Indices of face attributes in Lisp face vectors. Slot zero is the
1363 symbol `face'. */
1364
1365enum lface_attribute_index
1366{
1367 LFACE_FAMILY_INDEX = 1,
1368 LFACE_SWIDTH_INDEX,
1369 LFACE_HEIGHT_INDEX,
1370 LFACE_WEIGHT_INDEX,
1371 LFACE_SLANT_INDEX,
1372 LFACE_UNDERLINE_INDEX,
1373 LFACE_INVERSE_INDEX,
1374 LFACE_FOREGROUND_INDEX,
1375 LFACE_BACKGROUND_INDEX,
1376 LFACE_STIPPLE_INDEX,
1377 LFACE_OVERLINE_INDEX,
1378 LFACE_STRIKE_THROUGH_INDEX,
1379 LFACE_BOX_INDEX,
b3091a23 1380 LFACE_FONT_INDEX,
cd68bbe8 1381 LFACE_INHERIT_INDEX,
670019ba 1382 LFACE_AVGWIDTH_INDEX,
5f5c8ee5
GM
1383 LFACE_VECTOR_SIZE
1384};
1385
1386
1387/* Box types of faces. */
1388
1389enum face_box_type
1390{
1391 /* No box around text. */
1392 FACE_NO_BOX,
1393
1394 /* Simple box of specified width and color. Default width is 1, and
1395 default color is the foreground color of the face. */
1396 FACE_SIMPLE_BOX,
1397
1398 /* Boxes with 3D shadows. Color equals the background color of the
1399 face. Width is specified. */
1400 FACE_RAISED_BOX,
1401 FACE_SUNKEN_BOX
1402};
1403
1404
1405/* Structure describing a realized face.
1406
1407 For each Lisp face, 0..N realized faces can exist for different
1408 frames and different charsets. Realized faces are built from Lisp
1409 faces and text properties/overlays by merging faces and adding
1410 unspecified attributes from the `default' face. */
1411
9f2279ad 1412struct face
5f5c8ee5
GM
1413{
1414 /* The id of this face. The id equals the index of this face in the
1415 vector faces_by_id of its face cache. */
1416 int id;
1417
1418#ifdef HAVE_WINDOW_SYSTEM
177c0ea7 1419
8016e514
EZ
1420 /* If non-zero, this is a GC that we can use without modification for
1421 drawing the characters in this face. */
5f5c8ee5 1422 GC gc;
177c0ea7 1423
5f5c8ee5
GM
1424 /* Font used for this face, or null if the font could not be loaded
1425 for some reason. This points to a `font' slot of a struct
1426 font_info, and we should not call XFreeFont on it because the
1427 font may still be used somewhere else. */
1428 XFontStruct *font;
1429
831fefca
GM
1430 /* Background stipple or bitmap used for this face. This is
1431 an id as returned from load_pixmap. */
1432 int stipple;
5f5c8ee5
GM
1433
1434#else /* not HAVE_WINDOW_SYSTEM */
1435
1436 /* Dummy. */
1437 int stipple;
1438
1439#endif /* not HAVE_WINDOW_SYSTEM */
1440
1441 /* Pixel value of foreground color for X frames. Color index
1442 for tty frames. */
1443 unsigned long foreground;
177c0ea7 1444
5f5c8ee5
GM
1445 /* Pixel value or color index of background color. */
1446 unsigned long background;
1447
1448 /* Pixel value or color index of underline color. */
1449 unsigned long underline_color;
1450
1451 /* Pixel value or color index of overlined, strike-through, or box
1452 color. */
1453 unsigned long overline_color;
1454 unsigned long strike_through_color;
1455 unsigned long box_color;
1456
1457 /* The font's name. This points to a `name' of a font_info, and it
1458 must not be freed. */
1459 char *font_name;
1460
5f5c8ee5
GM
1461 /* Font info ID for this face's font. An ID is stored here because
1462 pointers to font_info structures may change. The reason is that
1463 they are pointers into a font table vector that is itself
1464 reallocated. */
1465 int font_info_id;
1466
1467 /* Fontset ID if this face uses a fontset, or -1. This is only >= 0
a90fbbf6
KH
1468 if the face was realized for a composition sequence.
1469 Otherwise, a specific font is loaded from the set of fonts
5f5c8ee5
GM
1470 specified by the fontset given by the family attribute of the face. */
1471 int fontset;
177c0ea7 1472
5f5c8ee5
GM
1473 /* Pixmap width and height. */
1474 unsigned int pixmap_w, pixmap_h;
177c0ea7 1475
5f5c8ee5 1476 /* Non-zero means characters in this face have a box that thickness
08f9976f
KH
1477 around them. If it is negative, the absolute value indicates the
1478 thickness, and the horizontal lines of box (top and bottom) are
54bff0bd 1479 drawn inside of characters glyph area. The vertical lines of box
08f9976f
KH
1480 (left and right) are drawn as the same way as the case that this
1481 value is positive. */
5f5c8ee5
GM
1482 int box_line_width;
1483
1484 /* Type of box drawn. A value of FACE_NO_BOX means no box is drawn
1485 around text in this face. A value of FACE_SIMPLE_BOX means a box
1486 of width box_line_width is drawn in color box_color. A value of
1487 FACE_RAISED_BOX or FACE_SUNKEN_BOX means a 3D box is drawn with
1488 shadow colors derived from the background color of the face. */
1489 enum face_box_type box;
1490
1491 /* If `box' above specifies a 3D type, 1 means use box_color for
1492 drawing shadows. */
1493 unsigned use_box_color_for_shadows_p : 1;
1494
1495 /* The Lisp face attributes this face realizes. All attributes
1496 in this vector are non-nil. */
1497 Lisp_Object lface[LFACE_VECTOR_SIZE];
1498
1499 /* The hash value of this face. */
1500 unsigned hash;
1501
1502 /* The charset for which this face was realized if it was realized
a90fbbf6
KH
1503 for use in multibyte text. If fontset >= 0, this is the charset
1504 of the first character of the composition sequence. A value of
1505 charset < 0 means the face was realized for use in unibyte text
1506 where the idea of Emacs charsets isn't applicable. */
5f5c8ee5
GM
1507 int charset;
1508
1509 /* Non-zero if text in this face should be underlined, overlined,
1510 strike-through or have a box drawn around it. */
1511 unsigned underline_p : 1;
1512 unsigned overline_p : 1;
1513 unsigned strike_through_p : 1;
1514
1515 /* 1 means that the colors specified for this face could not be
1516 loaded, and were replaced by default colors, so they shouldn't be
1517 freed. */
1518 unsigned foreground_defaulted_p : 1;
1519 unsigned background_defaulted_p : 1;
1520
1521 /* 1 means that either no color is specified for underlining or that
28b927d8 1522 the specified color couldn't be loaded. Use the foreground
5f5c8ee5 1523 color when drawing in that case. */
177c0ea7 1524 unsigned underline_defaulted_p : 1;
5f5c8ee5
GM
1525
1526 /* 1 means that either no color is specified for the corresponding
54bff0bd 1527 attribute or that the specified color couldn't be loaded.
5f5c8ee5
GM
1528 Use the foreground color when drawing in that case. */
1529 unsigned overline_color_defaulted_p : 1;
1530 unsigned strike_through_color_defaulted_p : 1;
1531 unsigned box_color_defaulted_p : 1;
1532
1533 /* TTY appearances. Blinking is not yet implemented. Colors are
1534 found in `lface' with empty color string meaning the default
1535 color of the TTY. */
1536 unsigned tty_bold_p : 1;
1537 unsigned tty_dim_p : 1;
1538 unsigned tty_underline_p : 1;
1539 unsigned tty_alt_charset_p : 1;
1540 unsigned tty_reverse_p : 1;
1541 unsigned tty_blinking_p : 1;
1542
dd387b25
GM
1543 /* 1 means that colors of this face may not be freed because they
1544 have been copied bitwise from a base face (see
1545 realize_x_face). */
1546 unsigned colors_copied_bitwise_p : 1;
1547
11894ceb
MB
1548 /* If non-zero, use overstrike (to simulate bold-face). */
1549 unsigned overstrike : 1;
1550
5f5c8ee5
GM
1551 /* Next and previous face in hash collision list of face cache. */
1552 struct face *next, *prev;
b3091a23
KH
1553
1554 /* If this face is for ASCII characters, this points this face
1555 itself. Otherwise, this points a face for ASCII characters. */
1556 struct face *ascii_face;
5f5c8ee5
GM
1557};
1558
1559
1560/* Color index indicating that face uses a terminal's default color. */
1561
1562#define FACE_TTY_DEFAULT_COLOR ((unsigned long) -1)
1563
f9d2fdc4
EZ
1564/* Color index indicating that face uses an unknown foreground color. */
1565
1566#define FACE_TTY_DEFAULT_FG_COLOR ((unsigned long) -2)
1567
54bff0bd 1568/* Color index indicating that face uses an unknown background color. */
f9d2fdc4
EZ
1569
1570#define FACE_TTY_DEFAULT_BG_COLOR ((unsigned long) -3)
1571
5f5c8ee5
GM
1572/* Non-zero if FACE was realized for unibyte use. */
1573
1574#define FACE_UNIBYTE_P(FACE) ((FACE)->charset < 0)
1575
1576
1577/* IDs of important faces known by the C face code. These are the IDs
1578 of the faces for CHARSET_ASCII. */
1579
1580enum face_id
1581{
1582 DEFAULT_FACE_ID,
1583 MODE_LINE_FACE_ID,
f6911ea7 1584 MODE_LINE_INACTIVE_FACE_ID,
9ea173e8 1585 TOOL_BAR_FACE_ID,
afb7aabb 1586 FRINGE_FACE_ID,
045dee35 1587 HEADER_LINE_FACE_ID,
76a6bc49
GM
1588 SCROLL_BAR_FACE_ID,
1589 BORDER_FACE_ID,
1590 CURSOR_FACE_ID,
1591 MOUSE_FACE_ID,
8317e104 1592 MENU_FACE_ID,
5f5c8ee5
GM
1593 BASIC_FACE_ID_SENTINEL
1594};
1595
01b1f0c0 1596#define MAX_FACE_ID ((1 << FACE_ID_BITS) - 1)
5f5c8ee5
GM
1597
1598/* A cache of realized faces. Each frame has its own cache because
1599 Emacs allows different frame-local face definitions. */
1600
1601struct face_cache
1602{
1603 /* Hash table of cached realized faces. */
1604 struct face **buckets;
177c0ea7 1605
5f5c8ee5
GM
1606 /* Back-pointer to the frame this cache belongs to. */
1607 struct frame *f;
1608
1609 /* A vector of faces so that faces can be referenced by an ID. */
1610 struct face **faces_by_id;
1611
1612 /* The allocated size, and number of used slots of faces_by_id. */
1613 int size, used;
90893c55
GM
1614
1615 /* Flag indicating that attributes of the `menu' face have been
1616 changed. */
1617 unsigned menu_face_changed_p : 1;
5f5c8ee5
GM
1618};
1619
1620
1621/* Prepare face FACE for use on frame F. This must be called before
1622 using X resources of FACE. */
1623
1624#define PREPARE_FACE_FOR_DISPLAY(F, FACE) \
1625 if ((FACE)->gc == 0) \
1626 prepare_face_for_display ((F), (FACE)); \
1627 else \
1628 (void) 0
1629
1630/* Return a pointer to the face with ID on frame F, or null if such a
1631 face doesn't exist. */
1632
1633#define FACE_FROM_ID(F, ID) \
c388b3c2 1634 (((unsigned) (ID) < FRAME_FACE_CACHE (F)->used) \
5f5c8ee5
GM
1635 ? FRAME_FACE_CACHE (F)->faces_by_id[ID] \
1636 : NULL)
1637
ff1a0d8e
KH
1638#ifdef HAVE_WINDOW_SYSTEM
1639
b3091a23
KH
1640/* Non-zero if FACE is suitable for displaying character CHAR. */
1641
1642#define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) \
1643 (SINGLE_BYTE_CHAR_P (CHAR) \
1644 ? (FACE) == (FACE)->ascii_face \
1645 : face_suitable_for_char_p ((FACE), (CHAR)))
1646
5f5c8ee5 1647/* Return the id of the realized face on frame F that is like the face
b3091a23
KH
1648 with id ID but is suitable for displaying character CHAR.
1649 This macro is only meaningful for multibyte character CHAR. */
177c0ea7 1650
b3091a23
KH
1651#define FACE_FOR_CHAR(F, FACE, CHAR) \
1652 (SINGLE_BYTE_CHAR_P (CHAR) \
1653 ? (FACE)->ascii_face->id \
1654 : face_for_char ((F), (FACE), (CHAR)))
5f5c8ee5 1655
ff1a0d8e 1656#else /* not HAVE_WINDOW_SYSTEM */
5f5c8ee5 1657
ff1a0d8e
KH
1658#define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) 1
1659#define FACE_FOR_CHAR(F, FACE, CHAR) ((FACE)->id)
1660
1661#endif /* not HAVE_WINDOW_SYSTEM */
5f5c8ee5
GM
1662
1663/* Non-zero means face attributes have been changed since the last
1664 redisplay. Used in redisplay_internal. */
1665
1666extern int face_change_count;
1667
1668
1669
1670\f
f4e1400d
KS
1671/***********************************************************************
1672 Fringes
1673 ***********************************************************************/
1674
f4e1400d
KS
1675/* Structure used to describe where and how to draw a fringe bitmap.
1676 WHICH is the fringe bitmap to draw. WD and H is the (adjusted)
1677 width and height of the bitmap, DH is the height adjustment (if
1678 bitmap is periodic). X and Y are frame coordinates of the area to
1679 display the bitmap, DY is relative offset of the bitmap into that
0633d52c 1680 area. BX, NX, BY, NY specifies the area to clear if the bitmap
f4e1400d
KS
1681 does not fill the entire area. FACE is the fringe face. */
1682
1683struct draw_fringe_bitmap_params
1684{
2251a6f2 1685 int which; /* enum fringe_bitmap_type */
12fde2dc 1686 unsigned short *bits;
f4e1400d
KS
1687 int wd, h, dh;
1688 int x, y;
1689 int bx, nx, by, ny;
2251a6f2
KS
1690 unsigned cursor_p : 1;
1691 unsigned overlay_p : 1;
f4e1400d
KS
1692 struct face *face;
1693};
1694
2251a6f2 1695#define MAX_FRINGE_BITMAPS (1<<FRINGE_ID_BITS)
f4e1400d
KS
1696
1697\f
5f5c8ee5
GM
1698/***********************************************************************
1699 Display Iterator
1700 ***********************************************************************/
1701
1702/* Iteration over things to display in current_buffer or in a string.
1703
1704 The iterator handles:
1705
1706 1. Overlay strings (after-string, before-string).
1707 2. Face properties.
1708 3. Invisible text properties.
1709 4. Selective display.
1710 5. Translation of characters via display tables.
1711 6. Translation of control characters to the forms `\003' or `^C'.
1712 7. `glyph' and `space-width' properties.
1713
1714 Iterators are initialized by calling init_iterator or one of the
1715 equivalent functions below. A call to get_next_display_element
1716 loads the iterator structure with information about what next to
1717 display. A call to set_iterator_to_next increments the iterator's
1718 position.
1719
1720 Characters from overlay strings, display table entries or control
1721 character translations are returned one at a time. For example, if
1722 we have a text of `a\x01' where `a' has a display table definition
1723 of `cd' and the control character is displayed with a leading
1724 arrow, then the iterator will return:
1725
1726 Call Return Source Call next
1727 -----------------------------------------------------------------
1728 next c display table move
1729 next d display table move
1730 next ^ control char move
1731 next A control char move
1732
1733 The same mechanism is also used to return characters for ellipses
1734 displayed at the end of invisible text.
1735
1736 CAVEAT: Under some circumstances, move_.* functions can be called
1737 asynchronously, e.g. when computing a buffer position from an x and
1738 y pixel position. This means that these functions and functions
1739 called from them SHOULD NOT USE xmalloc and alike. See also the
1740 comment at the start of xdisp.c. */
1741
1742/* Enumeration describing what kind of display element an iterator is
1743 loaded with after a call to get_next_display_element. */
1744
1745enum display_element_type
1746{
1747 /* A normal character. */
1748 IT_CHARACTER,
1749
a90fbbf6
KH
1750 /* A composition sequence. */
1751 IT_COMPOSITION,
1752
5f5c8ee5
GM
1753 /* An image. */
1754 IT_IMAGE,
1755
1756 /* A flexible width and height space. */
1757 IT_STRETCH,
1758
1759 /* End of buffer or string. */
1760 IT_EOB,
1761
1762 /* Truncation glyphs. Never returned by get_next_display_element.
1763 Used to get display information about truncation glyphs via
1764 produce_glyphs. */
1765 IT_TRUNCATION,
1766
1767 /* Continuation glyphs. See the comment for IT_TRUNCATION. */
1768 IT_CONTINUATION
1769};
1770
1771
1772/* An enumerator for each text property that has a meaning for display
1773 purposes. */
1774
1775enum prop_idx
1776{
1777 FONTIFIED_PROP_IDX,
1778 FACE_PROP_IDX,
1779 INVISIBLE_PROP_IDX,
1780 DISPLAY_PROP_IDX,
a90fbbf6 1781 COMPOSITION_PROP_IDX,
5f5c8ee5
GM
1782
1783 /* Not a property. Used to indicate changes in overlays. */
1784 OVERLAY_PROP_IDX,
1785
1786 /* Sentinel. */
1787 LAST_PROP_IDX
1788};
1789
1790
0633d52c
KS
1791struct it_slice
1792{
1793 Lisp_Object x;
1794 Lisp_Object y;
1795 Lisp_Object width;
1796 Lisp_Object height;
1797};
1798
6a88f968
KS
1799enum it_method {
1800 GET_FROM_BUFFER = 0,
1801 GET_FROM_DISPLAY_VECTOR,
1802 GET_FROM_COMPOSITION,
1803 GET_FROM_STRING,
1804 GET_FROM_C_STRING,
1805 GET_FROM_IMAGE,
1806 GET_FROM_STRETCH,
1807 NUM_IT_METHODS
1808};
0633d52c 1809
5f5c8ee5
GM
1810struct it
1811{
1812 /* The window in which we iterate over current_buffer (or a string). */
1813 Lisp_Object window;
1814 struct window *w;
1815
1816 /* The window's frame. */
1817 struct frame *f;
1818
6a88f968
KS
1819 /* Method to use to load this structure with the next display element. */
1820 enum it_method method;
5f5c8ee5
GM
1821
1822 /* The next position at which to check for face changes, invisible
1823 text, overlay strings, end of text etc., which see. */
1824 int stop_charpos;
1825
1826 /* Maximum string or buffer position + 1. ZV when iterating over
1827 current_buffer. */
1828 int end_charpos;
1829
1830 /* C string to iterate over. Non-null means get characters from
1831 this string, otherwise characters are read from current_buffer
1832 or it->string. */
1833 unsigned char *s;
1834
1835 /* Number of characters in the string (s, or it->string) we iterate
1836 over. */
1837 int string_nchars;
1838
1839 /* Start and end of a visible region; -1 if the region is not
1840 visible in the window. */
1841 int region_beg_charpos, region_end_charpos;
1842
1843 /* Position at which redisplay end trigger functions should be run. */
1844 int redisplay_end_trigger_charpos;
1845
1846 /* 1 means multibyte characters are enabled. */
1847 unsigned multibyte_p : 1;
1848
5f5c8ee5 1849 /* 1 means window has a mode line at its top. */
045dee35 1850 unsigned header_line_p : 1;
5f5c8ee5
GM
1851
1852 /* 1 means `string' is the value of a `display' property.
1853 Don't handle some `display' properties in these strings. */
1854 unsigned string_from_display_prop_p : 1;
1855
b437860a
RS
1856 /* When METHOD == next_element_from_display_vector,
1857 this is 1 if we're doing an ellipsis. Otherwise meaningless. */
1858 unsigned ellipsis_p : 1;
1859
5f5c8ee5
GM
1860 /* Display table in effect or null for none. */
1861 struct Lisp_Char_Table *dp;
1862
1863 /* Current display table vector to return characters from and its
1864 end. dpvec null means we are not returning characters from a
1865 display table entry; current.dpvec_index gives the current index
1866 into dpvec. This same mechanism is also used to return
1867 characters from translated control characters, i.e. `\003' or
1868 `^C'. */
1869 Lisp_Object *dpvec, *dpend;
1870
1871 /* Length in bytes of the char that filled dpvec. A value of zero
54bff0bd 1872 means that no such character is involved. */
5f5c8ee5
GM
1873 int dpvec_char_len;
1874
888ca1e7
KS
1875 /* Face id to use for all characters in display vector. -1 if unused. */
1876 int dpvec_face_id;
1877
5f5c8ee5
GM
1878 /* Face id of the iterator saved in case a glyph from dpvec contains
1879 a face. The face is restored when all glyphs from dpvec have
1880 been delivered. */
1881 int saved_face_id;
1882
1883 /* Vector of glyphs for control character translation. The pointer
4659838f
KH
1884 dpvec is set to ctl_chars when a control character is translated.
1885 This vector is also used for incomplete multibyte character
8d5b986d
GM
1886 translation (e.g \222\244). Such a character is at most 4 bytes,
1887 thus we need at most 16 bytes here. */
1888 Lisp_Object ctl_chars[16];
5f5c8ee5 1889
67435182
KS
1890 /* Initial buffer or string position of the iterator, before skipping
1891 over display properties and invisible text. */
1892 struct display_pos start;
1893
5f5c8ee5
GM
1894 /* Current buffer or string position of the iterator, including
1895 position in overlay strings etc. */
1896 struct display_pos current;
1897
1898 /* Vector of overlays to process. Overlay strings are processed
1899 OVERLAY_STRING_CHUNK_SIZE at a time. */
e9323aed 1900#define OVERLAY_STRING_CHUNK_SIZE 16
5f5c8ee5
GM
1901 Lisp_Object overlay_strings[OVERLAY_STRING_CHUNK_SIZE];
1902
1903 /* Total number of overlay strings to process. This can be >
1904 OVERLAY_STRING_CHUNK_SIZE. */
1905 int n_overlay_strings;
1906
1907 /* If non-nil, a Lisp string being processed. If
1908 current.overlay_string_index >= 0, this is an overlay string from
1909 pos. */
1910 Lisp_Object string;
1911
1912 /* Stack of saved values. New entries are pushed when we begin to
1913 process an overlay string or a string from a `glyph' property.
1914 Entries are popped when we return to deliver display elements
1915 from what we previously had. */
1916 struct iterator_stack_entry
9f2279ad 1917 {
5f5c8ee5
GM
1918 int stop_charpos;
1919 int face_id;
1920 Lisp_Object string;
1921 struct display_pos pos;
1922 int end_charpos;
1923 int string_nchars;
1924 enum glyph_row_area area;
1925 unsigned multibyte_p : 1;
1926 unsigned string_from_display_prop_p : 1;
88378b0d 1927 unsigned display_ellipsis_p : 1;
0633d52c 1928 struct it_slice slice;
5f5c8ee5
GM
1929 Lisp_Object space_width;
1930 short voffset;
1931 Lisp_Object font_height;
1932 }
1933 stack[2];
dfbb1e90 1934
5f5c8ee5
GM
1935 /* Stack pointer. */
1936 int sp;
177c0ea7 1937
5f5c8ee5
GM
1938 /* Setting of buffer-local variable selective-display-ellipsis. */
1939 unsigned selective_display_ellipsis_p : 1;
1940
1941 /* 1 means control characters are translated into the form `^C'
1942 where the `^' can be replaced by a display table entry. */
1943 unsigned ctl_arrow_p : 1;
1944
1945 /* -1 means selective display hides everything between a \r and the
1946 next newline; > 0 means hide lines indented more than that value. */
1947 int selective;
1948
1949 /* An enumeration describing what the next display element is
1950 after a call to get_next_display_element. */
1951 enum display_element_type what;
dfbb1e90 1952
5f5c8ee5
GM
1953 /* Face to use. */
1954 int face_id;
1955
1956 /* Non-zero means that the current face has a box. */
1957 unsigned face_box_p : 1;
1958
1959 /* Non-null means that the current character is the first in a run
1960 of characters with box face. */
1961 unsigned start_of_box_run_p : 1;
177c0ea7 1962
5f5c8ee5
GM
1963 /* Non-zero means that the current character is the last in a run
1964 of characters with box face. */
1965 unsigned end_of_box_run_p : 1;
1966
1967 /* 1 means overlay strings at end_charpos have been processed. */
1968 unsigned overlay_strings_at_end_processed_p : 1;
1969
b3091a23
KH
1970 /* 1 means the actual glyph is not available in the current
1971 system. */
666852af
GM
1972 unsigned glyph_not_available_p : 1;
1973
1974 /* 1 means the next line in display_line continues a character
1975 consisting of more than one glyph, and some glyphs of this
1976 character have been put on the previous line. */
1977 unsigned starts_in_middle_of_char_p : 1;
b3091a23 1978
4d2036e4
GM
1979 /* If 1, saved_face_id contains the id of the face in front of text
1980 skipped due to selective display. */
1981 unsigned face_before_selective_p : 1;
1982
0633d52c 1983 /* If 1, adjust current glyph so it does not increase current row
7293ac29 1984 descent/ascent (line-height property). Reset after this glyph. */
0633d52c
KS
1985 unsigned constrain_row_ascent_descent_p : 1;
1986
5f5c8ee5 1987 /* The ID of the default face to use. One of DEFAULT_FACE_ID,
4d2036e4 1988 MODE_LINE_FACE_ID, etc, depending on what we are displaying. */
5f5c8ee5
GM
1989 int base_face_id;
1990
1991 /* If what == IT_CHARACTER, character and length in bytes. This is
1992 a character from a buffer or string. It may be different from
1993 the character displayed in case that
a90fbbf6
KH
1994 unibyte_display_via_language_environment is set.
1995
1996 If what == IT_COMPOSITION, the first component of a composition
1997 and length in bytes of the composition. */
5f5c8ee5
GM
1998 int c, len;
1999
a90fbbf6
KH
2000 /* If what == IT_COMPOSITION, identification number and length in
2001 chars of a composition. */
2002 int cmp_id, cmp_len;
2003
5f5c8ee5
GM
2004 /* The character to display, possibly translated to multibyte
2005 if unibyte_display_via_language_environment is set. This
d5cc60b8 2006 is set after produce_glyphs has been called. */
5f5c8ee5
GM
2007 int char_to_display;
2008
5f5c8ee5
GM
2009 /* If what == IT_IMAGE, the id of the image to display. */
2010 int image_id;
2011
0633d52c
KS
2012 /* Values from `slice' property. */
2013 struct it_slice slice;
2014
5f5c8ee5
GM
2015 /* Value of the `space-width' property, if any; nil if none. */
2016 Lisp_Object space_width;
2017
2018 /* Computed from the value of the `raise' property. */
2019 short voffset;
2020
2021 /* Value of the `height' property, if any; nil if none. */
2022 Lisp_Object font_height;
2023
2024 /* Object and position where the current display element came from.
2025 Object can be a Lisp string in case the current display element
f38e5748
KS
2026 comes from an overlay string, or it is buffer. It may also be nil
2027 during mode-line update. Position is a position in object. */
5f5c8ee5
GM
2028 Lisp_Object object;
2029 struct text_pos position;
2030
2031 /* 1 means lines are truncated. */
2032 unsigned truncate_lines_p : 1;
2033
2034 /* Number of columns per \t. */
2035 short tab_width;
2036
2037 /* Width in pixels of truncation and continuation glyphs. */
2038 short truncation_pixel_width, continuation_pixel_width;
2039
2040 /* First and last visible x-position in the display area. If window
87388f9d 2041 is hscrolled by n columns, first_visible_x == n * FRAME_COLUMN_WIDTH
5f5c8ee5
GM
2042 (f), and last_visible_x == pixel width of W + first_visible_x. */
2043 int first_visible_x, last_visible_x;
2044
2045 /* Last visible y-position + 1 in the display area without a mode
2046 line, if the window has one. */
2047 int last_visible_y;
2048
db0c5a7d
KS
2049 /* Default amount of additional space in pixels between lines (for
2050 window systems only.) */
bf95c413 2051 int extra_line_spacing;
5f5c8ee5 2052
db0c5a7d
KS
2053 /* Max extra line spacing added in this row. */
2054 int max_extra_line_spacing;
2055
d956147c
KS
2056 /* Override font height information for this glyph.
2057 Used if override_ascent >= 0. Cleared after this glyph. */
2058 int override_ascent, override_descent, override_boff;
2059
5f5c8ee5
GM
2060 /* If non-null, glyphs are produced in glyph_row with each call to
2061 produce_glyphs. */
2062 struct glyph_row *glyph_row;
2063
2064 /* The area of glyph_row to which glyphs are added. */
2065 enum glyph_row_area area;
2066
2067 /* Number of glyphs needed for the last character requested via
2068 produce_glyphs. This is 1 except for tabs. */
2069 int nglyphs;
177c0ea7 2070
5f5c8ee5
GM
2071 /* Width of the display element in pixels. Result of
2072 produce_glyphs. */
2073 int pixel_width;
2074
2febf6e0
GM
2075 /* Current, maximum logical, and maximum physical line height
2076 information. Result of produce_glyphs. */
5f5c8ee5 2077 int ascent, descent, max_ascent, max_descent;
2febf6e0 2078 int phys_ascent, phys_descent, max_phys_ascent, max_phys_descent;
5f5c8ee5
GM
2079
2080 /* Current x pixel position within the display line. This value
2081 does not include the width of continuation lines in front of the
2082 line. The value of current_x is automatically incremented by
2083 pixel_width with each call to produce_glyphs. */
2084 int current_x;
2085
2086 /* Accumulated width of continuation lines. If > 0, this means we
2087 are currently in a continuation line. This is initially zero and
2088 incremented/reset by display_line, move_it_to etc. */
2089 int continuation_lines_width;
2090
2091 /* Current y-position. Automatically incremented by the height of
2092 glyph_row in move_it_to and display_line. */
2093 int current_y;
2094
ed7d07bd
KS
2095 /* Vertical matrix position of first text line in window. */
2096 int first_vpos;
2097
5f5c8ee5
GM
2098 /* Current vertical matrix position, or line number. Automatically
2099 incremented by move_it_to and display_line. */
2100 int vpos;
2101
2102 /* Horizontal matrix position reached in move_it_in_display_line.
2103 Only set there, not in display_line. */
2104 int hpos;
2251a6f2
KS
2105
2106 /* Left fringe bitmap number (enum fringe_bitmap_type). */
2107 unsigned left_user_fringe_bitmap : FRINGE_ID_BITS;
2108
2251a6f2
KS
2109 /* Right fringe bitmap number (enum fringe_bitmap_type). */
2110 unsigned right_user_fringe_bitmap : FRINGE_ID_BITS;
2111
b3b08f03
KS
2112 /* Face of the left fringe glyph. */
2113 unsigned left_user_fringe_face_id : FACE_ID_BITS;
2114
2251a6f2
KS
2115 /* Face of the right fringe glyph. */
2116 unsigned right_user_fringe_face_id : FACE_ID_BITS;
5f5c8ee5
GM
2117};
2118
2119
2120/* Access to positions of iterator IT. */
2121
2122#define IT_CHARPOS(IT) CHARPOS ((IT).current.pos)
2123#define IT_BYTEPOS(IT) BYTEPOS ((IT).current.pos)
2124#define IT_STRING_CHARPOS(IT) CHARPOS ((IT).current.string_pos)
2125#define IT_STRING_BYTEPOS(IT) BYTEPOS ((IT).current.string_pos)
2126
2127/* Test if IT has reached the end of its buffer or string. This will
2128 only work after get_next_display_element has been called. */
2129
2130#define ITERATOR_AT_END_P(IT) ((IT)->what == IT_EOB)
2131
2132/* Non-zero means IT is at the end of a line. This is the case if it
2133 is either on a newline or on a carriage return and selective
2134 display hides the rest of the line. */
2135
2136#define ITERATOR_AT_END_OF_LINE_P(IT) \
2137 ((IT)->what == IT_CHARACTER \
2138 && ((IT)->c == '\n' \
2139 || ((IT)->c == '\r' && (IT)->selective)))
2140
2141/* Call produce_glyphs or produce_glyphs_hook, if set. Shortcut to
2142 avoid the function call overhead. */
2143
18155a1d
RS
2144#define PRODUCE_GLYPHS(IT) \
2145 do { \
2146 extern int inhibit_free_realized_faces; \
2147 if (rif != NULL) \
2148 rif->produce_glyphs ((IT)); \
2149 else \
2150 produce_glyphs ((IT)); \
2151 if ((IT)->glyph_row != NULL) \
2152 inhibit_free_realized_faces = 1; \
2153 } while (0)
5f5c8ee5
GM
2154
2155/* Bit-flags indicating what operation move_it_to should perform. */
2156
2157enum move_operation_enum
2158{
2159 /* Stop if specified x-position is reached. */
2160 MOVE_TO_X = 0x01,
2161
2162 /* Stop if specified y-position is reached. */
2163 MOVE_TO_Y = 0x02,
2164
2165 /* Stop if specified vpos is reached. */
2166 MOVE_TO_VPOS = 0x04,
2167
2168 /* Stop if specified buffer or string position is reached. */
2169 MOVE_TO_POS = 0x08
2170};
2171
2172
2173\f
2174/***********************************************************************
2175 Window-based redisplay interface
2176 ***********************************************************************/
2177
2178/* Structure used to describe runs of lines that must be scrolled. */
2179
2180struct run
2181{
2182 /* Source and destination y pixel position. */
2183 int desired_y, current_y;
2184
2185 /* Source and destination vpos in matrix. */
2186 int desired_vpos, current_vpos;
2187
2188 /* Height in pixels, number of glyph rows. */
2189 int height, nrows;
2190};
2191
2192
e6b3aecd
KS
2193/* Handlers for setting frame parameters. */
2194
2195typedef void (*frame_parm_handler) P_ ((struct frame *, Lisp_Object, Lisp_Object));
2196
2197
5f5c8ee5
GM
2198/* Structure holding system-dependent interface functions needed
2199 for window-based redisplay. */
2200
2201struct redisplay_interface
2202{
e6b3aecd
KS
2203 /* Handlers for setting frame parameters. */
2204 frame_parm_handler *frame_parm_handlers;
2205
5f5c8ee5
GM
2206 /* Produce glyphs/get display metrics for the display element IT is
2207 loaded with. */
2208 void (*produce_glyphs) P_ ((struct it *it));
177c0ea7 2209
5f5c8ee5
GM
2210 /* Write or insert LEN glyphs from STRING at the nominal output
2211 position. */
2212 void (*write_glyphs) P_ ((struct glyph *string, int len));
2213 void (*insert_glyphs) P_ ((struct glyph *start, int len));
2214
2215 /* Clear from nominal output position to X. X < 0 means clear
2216 to right end of display. */
2217 void (*clear_end_of_line) P_ ((int x));
177c0ea7 2218
5f5c8ee5
GM
2219 /* Function to call to scroll the display as described by RUN on
2220 window W. */
2221 void (*scroll_run_hook) P_ ((struct window *w, struct run *run));
2222
2223 /* Function to call after a line in a display has been completely
2224 updated. Used to draw truncation marks and alike. DESIRED_ROW
2225 is the desired row which has been updated. */
2226 void (*after_update_window_line_hook) P_ ((struct glyph_row *desired_row));
42087301 2227
5f5c8ee5
GM
2228 /* Function to call before beginning to update window W in
2229 window-based redisplay. */
2230 void (*update_window_begin_hook) P_ ((struct window *w));
2231
2232 /* Function to call after window W has been updated in window-based
712eaef2
GM
2233 redisplay. CURSOR_ON_P non-zero means switch cursor on.
2234 MOUSE_FACE_OVERWRITTEN_P non-zero means that some lines in W
2235 that contained glyphs in mouse-face were overwritten, so we
54bff0bd 2236 have to update the mouse highlight. */
712eaef2
GM
2237 void (*update_window_end_hook) P_ ((struct window *w, int cursor_on_p,
2238 int mouse_face_overwritten_p));
177c0ea7 2239
5f5c8ee5
GM
2240 /* Move cursor to row/column position VPOS/HPOS, pixel coordinates
2241 Y/X. HPOS/VPOS are window-relative row and column numbers and X/Y
2242 are window-relative pixel positions. */
2243 void (*cursor_to) P_ ((int vpos, int hpos, int y, int x));
2244
2245 /* Flush the display of frame F. For X, this is XFlush. */
2246 void (*flush_display) P_ ((struct frame *f));
2247
d74b2553
KS
2248 /* Flush the display of frame F if non-NULL. This is called
2249 during redisplay, and should be NULL on systems which flushes
2250 automatically before reading input. */
2251 void (*flush_display_optional) P_ ((struct frame *f));
2252
ec68e323 2253 /* Clear the mouse hightlight in window W, if there is any. */
d74b2553 2254 void (*clear_window_mouse_face) P_ ((struct window *w));
712eaef2 2255
5f5c8ee5
GM
2256 /* Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
2257 frame F. */
2258 void (*get_glyph_overhangs) P_ ((struct glyph *glyph, struct frame *f,
2259 int *left, int *right));
2febf6e0
GM
2260
2261 /* Fix the display of AREA of ROW in window W for overlapping rows.
2262 This function is called from redraw_overlapping_rows after
2263 desired rows have been made current. */
2264 void (*fix_overlapping_area) P_ ((struct window *w, struct glyph_row *row,
2265 enum glyph_row_area area));
f4e1400d 2266
79fa9e0f
KS
2267#ifdef HAVE_WINDOW_SYSTEM
2268
f4e1400d
KS
2269 /* Draw a fringe bitmap in window W of row ROW using parameters P. */
2270 void (*draw_fringe_bitmap) P_ ((struct window *w, struct glyph_row *row,
2271 struct draw_fringe_bitmap_params *p));
2272
2251a6f2 2273 /* Define and destroy fringe bitmap no. WHICH. */
12fde2dc 2274 void (*define_fringe_bitmap) P_ ((int which, unsigned short *bits,
2251a6f2
KS
2275 int h, int wd));
2276 void (*destroy_fringe_bitmap) P_ ((int which));
2277
d5cc60b8
KS
2278/* Get metrics of character CHAR2B in FONT of type FONT_TYPE.
2279 Value is null if CHAR2B is not contained in the font. */
2280 XCharStruct * (*per_char_metric) P_ ((XFontStruct *font, XChar2b *char2b,
2281 int font_type));
2282
2283/* Encode CHAR2B using encoding information from FONT_INFO. CHAR2B is
2284 the two-byte form of C. Encoding is returned in *CHAR2B. If
2285 TWO_BYTE_P is non-null, return non-zero there if font is two-byte. */
2286 int (*encode_char) P_ ((int c, XChar2b *char2b,
2287 struct font_info *font_into, int *two_byte_p));
2288
0633d52c 2289/* Compute left and right overhang of glyph string S.
d5cc60b8
KS
2290 A NULL pointer if platform does not support this. */
2291 void (*compute_glyph_string_overhangs) P_ ((struct glyph_string *s));
2292
2293/* Draw a glyph string S. */
2294 void (*draw_glyph_string) P_ ((struct glyph_string *s));
2295
d74b2553
KS
2296/* Define cursor CURSOR on frame F. */
2297 void (*define_frame_cursor) P_ ((struct frame *f, Cursor cursor));
5f5c8ee5 2298
d74b2553
KS
2299/* Clear the area at (X,Y,WIDTH,HEIGHT) of frame F. */
2300 void (*clear_frame_area) P_ ((struct frame *f, int x, int y,
2301 int width, int height));
5f5c8ee5 2302
e5a3b7d9
KS
2303/* Draw specified cursor CURSOR_TYPE of width CURSOR_WIDTH
2304 at row GLYPH_ROW on window W if ON_P is 1. If ON_P is
2305 0, don't draw cursor. If ACTIVE_P is 1, system caret
2306 should track this cursor (when applicable). */
d74b2553
KS
2307 void (*draw_window_cursor) P_ ((struct window *w,
2308 struct glyph_row *glyph_row,
e5a3b7d9
KS
2309 int x, int y,
2310 int cursor_type, int cursor_width,
2311 int on_p, int active_p));
5f5c8ee5 2312
d74b2553
KS
2313/* Draw vertical border for window W from (X,Y0) to (X,Y1). */
2314 void (*draw_vertical_window_border) P_ ((struct window *w,
2315 int x, int y0, int y1));
d5cc60b8 2316
0633d52c 2317/* Shift display of frame F to make room for inserted glyphs.
d74b2553
KS
2318 The area at pixel (X,Y) of width WIDTH and height HEIGHT is
2319 shifted right by SHIFT_BY pixels. */
2320 void (*shift_glyphs_for_insert) P_ ((struct frame *f,
2321 int x, int y, int width,
2322 int height, int shift_by));
d5cc60b8 2323
d74b2553
KS
2324#endif /* HAVE_WINDOW_SYSTEM */
2325};
d5cc60b8 2326
d74b2553 2327/* The current interface for window-based redisplay. */
d5cc60b8 2328
d74b2553 2329extern struct redisplay_interface *rif;
d5cc60b8 2330
5f5c8ee5
GM
2331\f
2332/***********************************************************************
2333 Images
2334 ***********************************************************************/
2335
4397e334 2336#ifdef HAVE_WINDOW_SYSTEM
5f5c8ee5
GM
2337
2338/* Structure forward declarations. */
2339
2340struct image;
2341
2342
54bff0bd 2343/* Each image format (JPEG, TIFF, ...) supported is described by
5f5c8ee5
GM
2344 a structure of the type below. */
2345
2346struct image_type
2347{
2348 /* A symbol uniquely identifying the image type, .e.g `jpeg'. */
2349 Lisp_Object *type;
2350
2351 /* Check that SPEC is a valid image specification for the given
2352 image type. Value is non-zero if SPEC is valid. */
2353 int (* valid_p) P_ ((Lisp_Object spec));
2354
2355 /* Load IMG which is used on frame F from information contained in
2356 IMG->spec. Value is non-zero if successful. */
2357 int (* load) P_ ((struct frame *f, struct image *img));
2358
2359 /* Free resources of image IMG which is used on frame F. */
2360 void (* free) P_ ((struct frame *f, struct image *img));
9f2279ad 2361
5f5c8ee5
GM
2362 /* Next in list of all supported image types. */
2363 struct image_type *next;
2364};
9f2279ad 2365
9f2279ad 2366
5f5c8ee5
GM
2367/* Structure describing an image. Specific image formats like XBM are
2368 converted into this form, so that display only has to deal with
2369 this type of image. */
9f2279ad 2370
5f5c8ee5
GM
2371struct image
2372{
2373 /* The time in seconds at which the image was last displayed. Set
2374 in prepare_image_for_display. */
2375 unsigned long timestamp;
9f2279ad 2376
5f5c8ee5
GM
2377 /* Pixmaps of the image. */
2378 Pixmap pixmap, mask;
9f2279ad 2379
5f5c8ee5
GM
2380 /* Colors allocated for this image, if any. Allocated via xmalloc. */
2381 unsigned long *colors;
2382 int ncolors;
9f2279ad 2383
0ff7c0d4
MB
2384 /* A single `background color' for this image, for the use of anyone that
2385 cares about such a thing. Only valid if the `background_valid' field
2386 is true. This should generally be accessed by calling the accessor
2387 macro `IMAGE_BACKGROUND', which will heuristically calculate a value
2388 if necessary. */
2389 unsigned long background;
2390
2391 /* True if this image has a `transparent' background -- that is, is
2392 uses an image mask. The accessor macro for this is
2393 `IMAGE_BACKGROUND_TRANSPARENT'. */
2394 unsigned background_transparent : 1;
2395
2396 /* True if the `background' and `background_transparent' fields are
2397 valid, respectively. */
2398 unsigned background_valid : 1, background_transparent_valid : 1;
2399
5f5c8ee5
GM
2400 /* Width and height of the image. */
2401 int width, height;
87485d6f 2402
5f5c8ee5
GM
2403 /* These values are used for the rectangles displayed for images
2404 that can't be loaded. */
2405#define DEFAULT_IMAGE_WIDTH 30
2406#define DEFAULT_IMAGE_HEIGHT 30
9f2279ad 2407
bdda7eb0 2408 /* Percent of image height used as ascent. A value of
54bff0bd 2409 CENTERED_IMAGE_ASCENT means draw the image centered on the
bdda7eb0 2410 line. */
5f5c8ee5
GM
2411 int ascent;
2412#define DEFAULT_IMAGE_ASCENT 50
bdda7eb0 2413#define CENTERED_IMAGE_ASCENT -1
c22ca93b 2414
5f5c8ee5
GM
2415 /* Lisp specification of this image. */
2416 Lisp_Object spec;
c22ca93b 2417
5f5c8ee5
GM
2418 /* Relief to draw around the image. */
2419 int relief;
c22ca93b 2420
f8215993
GM
2421 /* Optional margins around the image. This includes the relief. */
2422 int hmargin, vmargin;
5f5c8ee5
GM
2423
2424 /* Reference to the type of the image. */
2425 struct image_type *type;
2426
a7ac64a9
GM
2427 /* 1 means that loading the image failed. Don't try again. */
2428 unsigned load_failed_p;
2429
5f5c8ee5
GM
2430 /* A place for image types to store additional data. The member
2431 data.lisp_val is marked during GC, so it's safe to store Lisp data
2432 there. Image types should free this data when their `free'
2433 function is called. */
2434 struct
c22ca93b 2435 {
5f5c8ee5
GM
2436 int int_val;
2437 void *ptr_val;
2438 Lisp_Object lisp_val;
2439 } data;
c22ca93b 2440
5f5c8ee5
GM
2441 /* Hash value of image specification to speed up comparisons. */
2442 unsigned hash;
2443
2444 /* Image id of this image. */
2445 int id;
2446
2447 /* Hash collision chain. */
2448 struct image *next, *prev;
2449};
2450
2451
2452/* Cache of images. Each frame has a cache. X frames with the same
2453 x_display_info share their caches. */
2454
2455struct image_cache
2456{
2457 /* Hash table of images. */
2458 struct image **buckets;
2459
2460 /* Vector mapping image ids to images. */
2461 struct image **images;
2462
2463 /* Allocated size of `images'. */
2464 unsigned size;
2465
2466 /* Number of images in the cache. */
2467 unsigned used;
2468
2469 /* Reference count (number of frames sharing this cache). */
2470 int refcount;
2471};
2472
2473
5f5c8ee5
GM
2474/* Value is a pointer to the image with id ID on frame F, or null if
2475 no image with that id exists. */
2476
2477#define IMAGE_FROM_ID(F, ID) \
2478 (((ID) >= 0 && (ID) < (FRAME_X_IMAGE_CACHE (F)->used)) \
2479 ? FRAME_X_IMAGE_CACHE (F)->images[ID] \
2480 : NULL)
2481
2482/* Size of bucket vector of image caches. Should be prime. */
2483
2484#define IMAGE_CACHE_BUCKETS_SIZE 1001
2485
4397e334 2486#endif /* HAVE_WINDOW_SYSTEM */
5f5c8ee5
GM
2487
2488
2489\f
2490/***********************************************************************
9ea173e8 2491 Tool-bars
5f5c8ee5
GM
2492 ***********************************************************************/
2493
9ea173e8
GM
2494/* Enumeration defining where to find tool-bar item information in
2495 tool-bar items vectors stored with frames. Each tool-bar item
2496 occupies TOOL_BAR_ITEM_NSLOTS elements in such a vector. */
5f5c8ee5 2497
9ea173e8 2498enum tool_bar_item_idx
5f5c8ee5 2499{
9ea173e8 2500 /* The key of the tool-bar item. Used to remove items when a binding
5f5c8ee5 2501 for `undefined' is found. */
9ea173e8 2502 TOOL_BAR_ITEM_KEY,
5f5c8ee5
GM
2503
2504 /* Non-nil if item is enabled. */
9ea173e8 2505 TOOL_BAR_ITEM_ENABLED_P,
5f5c8ee5
GM
2506
2507 /* Non-nil if item is selected (pressed). */
9ea173e8 2508 TOOL_BAR_ITEM_SELECTED_P,
5f5c8ee5
GM
2509
2510 /* Caption. */
9ea173e8 2511 TOOL_BAR_ITEM_CAPTION,
5f5c8ee5
GM
2512
2513 /* Image(s) to display. This is either a single image specification
2514 or a vector of specifications. */
9ea173e8 2515 TOOL_BAR_ITEM_IMAGES,
5f5c8ee5
GM
2516
2517 /* The binding. */
9ea173e8 2518 TOOL_BAR_ITEM_BINDING,
5f5c8ee5
GM
2519
2520 /* Button type. One of nil, `:radio' or `:toggle'. */
9ea173e8 2521 TOOL_BAR_ITEM_TYPE,
c22ca93b 2522
5f5c8ee5 2523 /* Help string. */
9ea173e8 2524 TOOL_BAR_ITEM_HELP,
5f5c8ee5 2525
9ea173e8
GM
2526 /* Sentinel = number of slots in tool_bar_items occupied by one
2527 tool-bar item. */
2528 TOOL_BAR_ITEM_NSLOTS
5f5c8ee5
GM
2529};
2530
2531
2532/* An enumeration for the different images that can be specified
9ea173e8 2533 for a tool-bar item. */
5f5c8ee5 2534
9ea173e8 2535enum tool_bar_item_image
5f5c8ee5 2536{
9ea173e8
GM
2537 TOOL_BAR_IMAGE_ENABLED_SELECTED,
2538 TOOL_BAR_IMAGE_ENABLED_DESELECTED,
2539 TOOL_BAR_IMAGE_DISABLED_SELECTED,
2540 TOOL_BAR_IMAGE_DISABLED_DESELECTED
5f5c8ee5
GM
2541};
2542
9ea173e8 2543/* Margin around tool-bar buttons in pixels. */
5f5c8ee5 2544
cc4cb755 2545extern Lisp_Object Vtool_bar_button_margin;
5f5c8ee5 2546
9ea173e8 2547/* Thickness of relief to draw around tool-bar buttons. */
5f5c8ee5 2548
31ade731 2549extern EMACS_INT tool_bar_button_relief;
5f5c8ee5 2550
cc4cb755
GM
2551/* Default values of the above variables. */
2552
cfa5cf43
PJ
2553#define DEFAULT_TOOL_BAR_BUTTON_MARGIN 4
2554#define DEFAULT_TOOL_BAR_BUTTON_RELIEF 1
cc4cb755
GM
2555
2556/* The height in pixels of the default tool-bar images. */
2557
2558#define DEFAULT_TOOL_BAR_IMAGE_HEIGHT 24
5f5c8ee5
GM
2559
2560\f
2561/***********************************************************************
a0816661
MB
2562 Terminal Capabilities
2563 ***********************************************************************/
2564
8da139bc
MB
2565/* Each of these is a bit representing a terminal `capability' (bold,
2566 inverse, etc). They are or'd together to specify the set of
2567 capabilities being queried for when calling `tty_capable_p' (which
2568 returns true if the terminal supports all of them). */
f0be5454 2569
a0816661
MB
2570#define TTY_CAP_INVERSE 0x01
2571#define TTY_CAP_UNDERLINE 0x02
2572#define TTY_CAP_BOLD 0x04
2573#define TTY_CAP_DIM 0x08
2574#define TTY_CAP_BLINK 0x10
2575#define TTY_CAP_ALT_CHARSET 0x20
2576
2577\f
2578/***********************************************************************
2579 Function Prototypes
5f5c8ee5
GM
2580 ***********************************************************************/
2581
2582/* Defined in xdisp.c */
2583
65ace4c2
GM
2584struct glyph_row *row_containing_pos P_ ((struct window *, int,
2585 struct glyph_row *,
229151ba 2586 struct glyph_row *, int));
56ab5d27 2587int string_buffer_position P_ ((struct window *, Lisp_Object, int));
5be57d49 2588int line_bottom_y P_ ((struct it *));
ce0b6717 2589int display_prop_intangible_p P_ ((Lisp_Object));
af42d485 2590void resize_echo_area_exactly P_ ((void));
c99f6080 2591int resize_mini_window P_ ((struct window *, int));
5f5c8ee5
GM
2592int try_window P_ ((Lisp_Object, struct text_pos));
2593void window_box P_ ((struct window *, int, int *, int *, int *, int *));
2594int window_box_height P_ ((struct window *));
2595int window_text_bottom_y P_ ((struct window *));
2596int window_box_width P_ ((struct window *, int));
2597int window_box_left P_ ((struct window *, int));
58df7256 2598int window_box_left_offset P_ ((struct window *, int));
5f5c8ee5 2599int window_box_right P_ ((struct window *, int));
58df7256 2600int window_box_right_offset P_ ((struct window *, int));
5f5c8ee5 2601void window_box_edges P_ ((struct window *, int, int *, int *, int *, int *));
d74b2553 2602int estimate_mode_line_height P_ ((struct frame *, enum face_id));
1853f74c
KS
2603void pixel_to_glyph_coords P_ ((struct frame *, int, int, int *, int *,
2604 NativeRectangle *, int));
2605int glyph_to_pixel_coords P_ ((struct window *, int, int, int *, int *));
5f5c8ee5 2606void mark_window_display_accurate P_ ((Lisp_Object, int));
69d1478a 2607void redisplay_preserve_echo_area P_ ((int));
5f5c8ee5
GM
2608void set_cursor_from_row P_ ((struct window *, struct glyph_row *,
2609 struct glyph_matrix *, int, int, int, int));
2610void init_iterator P_ ((struct it *, struct window *, int,
2611 int, struct glyph_row *, enum face_id));
2612void init_iterator_to_row_start P_ ((struct it *, struct window *,
2613 struct glyph_row *));
2614int get_next_display_element P_ ((struct it *));
ff2a2e6b 2615void set_iterator_to_next P_ ((struct it *, int));
5f5c8ee5
GM
2616void produce_glyphs P_ ((struct it *));
2617void produce_special_glyphs P_ ((struct it *, enum display_element_type));
2618void start_display P_ ((struct it *, struct window *, struct text_pos));
2619void move_it_to P_ ((struct it *, int, int, int, int, int));
2620void move_it_vertically P_ ((struct it *, int));
d1d1aa9c 2621void move_it_vertically_backward P_ ((struct it *, int));
5f5c8ee5 2622void move_it_by_lines P_ ((struct it *, int, int));
5b2ad813 2623void move_it_past_eol P_ ((struct it *));
c4f2431a 2624int in_display_vector_p P_ ((struct it *));
5f5c8ee5
GM
2625int frame_mode_line_height P_ ((struct frame *));
2626void highlight_trailing_whitespace P_ ((struct frame *, struct glyph_row *));
9ea173e8 2627extern Lisp_Object Qtool_bar;
c1ff17c5 2628extern Lisp_Object Vshow_trailing_whitespace;
5f380a5b 2629extern int mode_line_in_non_selected_windows;
5f5c8ee5 2630extern int redisplaying_p;
9ee84299 2631extern void add_to_log P_ ((char *, Lisp_Object, Lisp_Object));
583dba75 2632extern int help_echo_showing_p;
e9e32f46 2633extern int current_mode_line_height, current_header_line_height;
d74b2553 2634extern Lisp_Object help_echo_string, help_echo_window;
0633d52c 2635extern Lisp_Object help_echo_object, previous_help_echo_string;
d74b2553
KS
2636extern int help_echo_pos;
2637extern struct frame *last_mouse_frame;
2638extern int last_tool_bar_item;
2639extern int mouse_autoselect_window;
a7416ec1 2640extern void reseat_at_previous_visible_line_start P_ ((struct it *));
d74b2553 2641
7ee8103e
KS
2642extern int calc_pixel_width_or_height P_ ((double *, struct it *, Lisp_Object,
2643 /* XFontStruct */ void *, int, int *));
2644
d74b2553 2645#ifdef HAVE_WINDOW_SYSTEM
5f5c8ee5 2646
d5cc60b8
KS
2647#if GLYPH_DEBUG
2648extern void dump_glyph_string P_ ((struct glyph_string *));
2649#endif
2650
2651extern void x_get_glyph_overhangs P_ ((struct glyph *, struct frame *,
2652 int *, int *));
2653extern void x_produce_glyphs P_ ((struct it *));
d5cc60b8 2654
d74b2553
KS
2655extern void x_write_glyphs P_ ((struct glyph *, int));
2656extern void x_insert_glyphs P_ ((struct glyph *, int len));
2657extern void x_clear_end_of_line P_ ((int));
2658
2659extern int x_stretch_cursor_p;
2660extern struct cursor_pos output_cursor;
2661
2662extern void x_fix_overlapping_area P_ ((struct window *, struct glyph_row *,
2663 enum glyph_row_area));
2664extern void draw_phys_cursor_glyph P_ ((struct window *,
2665 struct glyph_row *,
2666 enum draw_glyphs_face));
4f5d6640
KS
2667extern int get_phys_cursor_geometry P_ ((struct window *, struct glyph_row *,
2668 struct glyph *, int *));
d74b2553
KS
2669extern void erase_phys_cursor P_ ((struct window *));
2670extern void display_and_set_cursor P_ ((struct window *,
2671 int, int, int, int, int));
2672
2673extern void set_output_cursor P_ ((struct cursor_pos *));
2674extern void x_cursor_to P_ ((int, int, int, int));
2675
2676extern void x_update_cursor P_ ((struct frame *, int));
2677extern void x_clear_cursor P_ ((struct window *));
2678extern void x_draw_vertical_border P_ ((struct window *w));
2679
2680extern void frame_to_window_pixel_xy P_ ((struct window *, int *, int *));
2681extern void get_glyph_string_clip_rect P_ ((struct glyph_string *,
2682 NativeRectangle *nr));
01b1f0c0 2683extern Lisp_Object find_hot_spot P_ ((Lisp_Object, int, int));
d74b2553
KS
2684extern void note_mouse_highlight P_ ((struct frame *, int, int));
2685extern void x_clear_window_mouse_face P_ ((struct window *));
2686extern void cancel_mouse_face P_ ((struct frame *));
2687
2688extern void handle_tool_bar_click P_ ((struct frame *,
2689 int, int, int, unsigned int));
2690
2691/* msdos.c defines its own versions of these functions. */
2692extern int clear_mouse_face P_ ((Display_Info *));
2693extern void show_mouse_face P_ ((Display_Info *, enum draw_glyphs_face));
2694extern int cursor_in_mouse_face_p P_ ((struct window *w));
2695
2696extern void expose_frame P_ ((struct frame *, int, int, int, int));
2697extern int x_intersect_rectangles P_ ((XRectangle *, XRectangle *,
2698 XRectangle *));
2699#endif
d5cc60b8 2700
2251a6f2
KS
2701/* Defined in fringe.c */
2702
e72d7335 2703int lookup_fringe_bitmap (Lisp_Object);
2251a6f2
KS
2704void draw_fringe_bitmap P_ ((struct window *, struct glyph_row *, int));
2705void draw_row_fringe_bitmaps P_ ((struct window *, struct glyph_row *));
98c95e4e 2706int draw_window_fringes P_ ((struct window *, int));
2251a6f2
KS
2707int update_window_fringes P_ ((struct window *, int));
2708void compute_fringe_widths P_ ((struct frame *, int));
2709
2710#ifdef WINDOWS_NT
2711void w32_init_fringe P_ ((void));
2712void w32_reset_fringes P_ ((void));
2713#endif
2714
175ca1f4
KS
2715/* Defined in image.c */
2716
d9a4b477
KS
2717#ifdef HAVE_WINDOW_SYSTEM
2718
175ca1f4
KS
2719extern int x_bitmap_height P_ ((struct frame *, int));
2720extern int x_bitmap_width P_ ((struct frame *, int));
2721extern int x_bitmap_pixmap P_ ((struct frame *, int));
2722extern void x_reference_bitmap P_ ((struct frame *, int));
2723extern int x_create_bitmap_from_data P_ ((struct frame *, char *,
2724 unsigned int, unsigned int));
2725extern int x_create_bitmap_from_file P_ ((struct frame *, Lisp_Object));
2726#ifndef x_destroy_bitmap
2727extern void x_destroy_bitmap P_ ((struct frame *, int));
2728#endif
2729extern void x_destroy_all_bitmaps P_ ((Display_Info *));
2730extern int x_create_bitmap_mask P_ ((struct frame * , int));
f27823c6 2731extern Lisp_Object x_find_image_file P_ ((Lisp_Object));
175ca1f4 2732
d9a4b477
KS
2733void x_kill_gs_process P_ ((Pixmap, struct frame *));
2734struct image_cache *make_image_cache P_ ((void));
2735void free_image_cache P_ ((struct frame *));
2736void clear_image_cache P_ ((struct frame *, int));
2737void forall_images_in_image_cache P_ ((struct frame *,
2738 void (*) P_ ((struct image *))));
2739int valid_image_p P_ ((Lisp_Object));
2740void prepare_image_for_display P_ ((struct frame *, struct image *));
2741int lookup_image P_ ((struct frame *, Lisp_Object));
2742
2743unsigned long image_background P_ ((struct image *, struct frame *,
0ccb519d 2744 XImagePtr_or_DC ximg));
d9a4b477 2745int image_background_transparent P_ ((struct image *, struct frame *,
0ccb519d 2746 XImagePtr_or_DC mask));
d9a4b477 2747
0633d52c
KS
2748int image_ascent P_ ((struct image *, struct face *, struct glyph_slice *));
2749
d9a4b477
KS
2750#endif
2751
5f5c8ee5
GM
2752/* Defined in sysdep.c */
2753
2754void get_frame_size P_ ((int *, int *));
2755void request_sigio P_ ((void));
2756void unrequest_sigio P_ ((void));
2757int tabs_safe_p P_ ((void));
2758void init_baud_rate P_ ((void));
2759void init_sigio P_ ((int));
2760
8317e104
GM
2761/* Defined in xfaces.c */
2762
2ad412d7
GM
2763#ifdef HAVE_X_WINDOWS
2764void x_free_colors P_ ((struct frame *, unsigned long *, int));
2765#endif
5f5c8ee5 2766
76a6bc49
GM
2767void update_face_from_frame_parameter P_ ((struct frame *, Lisp_Object,
2768 Lisp_Object));
036480cb 2769Lisp_Object tty_color_name P_ ((struct frame *, int));
5f5c8ee5 2770void clear_face_cache P_ ((int));
1cc03123
EZ
2771unsigned long load_color P_ ((struct frame *, struct face *, Lisp_Object,
2772 enum lface_attribute_index));
5f5c8ee5 2773void unload_color P_ ((struct frame *, unsigned long));
475a1234 2774int face_font_available_p P_ ((struct frame *, Lisp_Object));
5f5c8ee5
GM
2775int ascii_face_of_lisp_face P_ ((struct frame *, int));
2776void prepare_face_for_display P_ ((struct frame *, struct face *));
77be52b7 2777int xstricmp P_ ((const unsigned char *, const unsigned char *));
b3091a23 2778int lookup_face P_ ((struct frame *, Lisp_Object *, int, struct face *));
1c395ea7 2779int lookup_named_face P_ ((struct frame *, Lisp_Object, int, int));
5f5c8ee5
GM
2780int smaller_face P_ ((struct frame *, int, int));
2781int face_with_height P_ ((struct frame *, int, int));
19aaca78 2782int lookup_derived_face P_ ((struct frame *, Lisp_Object, int, int, int));
5f5c8ee5
GM
2783void init_frame_faces P_ ((struct frame *));
2784void free_frame_faces P_ ((struct frame *));
2785void recompute_basic_faces P_ ((struct frame *));
2786int face_at_buffer_position P_ ((struct window *, int, int, int, int *,
2787 int, int));
8d721a0d
GM
2788int face_at_string_position P_ ((struct window *, Lisp_Object, int, int, int,
2789 int, int *, enum face_id, int));
a2858aae 2790int merge_faces P_ ((struct frame *, Lisp_Object, int, int));
5f5c8ee5
GM
2791int compute_char_face P_ ((struct frame *, int, Lisp_Object));
2792void free_all_realized_faces P_ ((Lisp_Object));
2793extern Lisp_Object Qforeground_color, Qbackground_color;
f0ba2d22 2794extern char unspecified_fg[], unspecified_bg[];
b3091a23 2795void free_realized_multibyte_face P_ ((struct frame *, int));
5f5c8ee5
GM
2796
2797/* Defined in xfns.c */
2798
4397e334 2799#ifdef HAVE_X_WINDOWS
5ae040a6 2800void gamma_correct P_ ((struct frame *, XColor *));
4397e334
AI
2801#endif
2802#ifdef WINDOWSNT
2803void gamma_correct P_ ((struct frame *, COLORREF *));
2804#endif
175ca1f4
KS
2805#ifdef MAC_OS
2806void gamma_correct P_ ((struct frame *, unsigned long *));
2807#endif
4397e334
AI
2808
2809#ifdef HAVE_WINDOW_SYSTEM
2810
5f5c8ee5
GM
2811int x_screen_planes P_ ((struct frame *));
2812void x_implicitly_set_name P_ ((struct frame *, Lisp_Object, Lisp_Object));
c26e3f6c 2813
4811586b 2814extern Lisp_Object tip_frame;
5f5c8ee5 2815extern Window tip_window;
88a19a90 2816EXFUN (Fx_show_tip, 6);
5f5c8ee5 2817EXFUN (Fx_hide_tip, 0);
6a2b7977
GM
2818extern void start_hourglass P_ ((void));
2819extern void cancel_hourglass P_ ((void));
3b8029d7 2820extern int hourglass_started P_ ((void));
6a2b7977 2821extern int display_hourglass_p;
5f5c8ee5 2822
0ff7c0d4
MB
2823/* Returns the background color of IMG, calculating one heuristically if
2824 necessary. If non-zero, XIMG is an existing XImage object to use for
2825 the heuristic. */
2826
2827#define IMAGE_BACKGROUND(img, f, ximg) \
2828 ((img)->background_valid \
2829 ? (img)->background \
2830 : image_background (img, f, ximg))
2831
2832/* Returns true if IMG has a `transparent' background, using heuristics
2833 to decide if necessary. If non-zero, MASK is an existing XImage
2834 object to use for the heuristic. */
2835
2836#define IMAGE_BACKGROUND_TRANSPARENT(img, f, mask) \
2837 ((img)->background_transparent_valid \
2838 ? (img)->background_transparent \
2839 : image_background_transparent (img, f, mask))
2840
4397e334 2841#endif /* HAVE_WINDOW_SYSTEM */
5f5c8ee5
GM
2842
2843
2844/* Defined in xmenu.c */
2845
2846int popup_activated P_ ((void));
2847
3f7267e7 2848/* Defined in dispnew.c */
5f5c8ee5 2849
283c6e3e 2850extern int inverse_video;
9a636f37
GM
2851extern int required_matrix_width P_ ((struct window *));
2852extern int required_matrix_height P_ ((struct window *));
0a0c9ab0
KS
2853extern Lisp_Object buffer_posn_from_coords P_ ((struct window *,
2854 int *, int *,
2855 struct display_pos *,
0633d52c 2856 Lisp_Object *,
0a0c9ab0
KS
2857 int *, int *, int *, int *));
2858extern Lisp_Object mode_line_string P_ ((struct window *, enum window_part,
2859 int *, int *, int *,
2860 Lisp_Object *,
2861 int *, int *, int *, int *));
2862extern Lisp_Object marginal_area_string P_ ((struct window *, enum window_part,
2863 int *, int *, int *,
2864 Lisp_Object *,
2865 int *, int *, int *, int *));
ec5d8db7
AS
2866extern void redraw_frame P_ ((struct frame *));
2867extern void redraw_garbaged_frames P_ ((void));
ec5d8db7 2868extern void cancel_line P_ ((int, struct frame *));
ec5d8db7 2869extern void init_desired_glyphs P_ ((struct frame *));
ec5d8db7 2870extern int scroll_frame_lines P_ ((struct frame *, int, int, int, int));
ec5d8db7
AS
2871extern int direct_output_for_insert P_ ((int));
2872extern int direct_output_forward_char P_ ((int));
2873extern int update_frame P_ ((struct frame *, int, int));
ec5d8db7 2874extern int scrolling P_ ((struct frame *));
ec5d8db7 2875extern void bitch_at_user P_ ((void));
5f5c8ee5
GM
2876void adjust_glyphs P_ ((struct frame *));
2877void free_glyphs P_ ((struct frame *));
2878void free_window_matrices P_ ((struct window *));
2879void check_glyph_memory P_ ((void));
2880void mirrored_line_dance P_ ((struct glyph_matrix *, int, int, int *, char *));
2881void clear_glyph_matrix P_ ((struct glyph_matrix *));
2882void clear_current_matrices P_ ((struct frame *f));
2883void clear_desired_matrices P_ ((struct frame *));
2884void shift_glyph_matrix P_ ((struct window *, struct glyph_matrix *,
2885 int, int, int));
2886void rotate_matrix P_ ((struct glyph_matrix *, int, int, int));
84fc6d4d
GM
2887void increment_matrix_positions P_ ((struct glyph_matrix *,
2888 int, int, int, int));
5f5c8ee5 2889void blank_row P_ ((struct window *, struct glyph_row *, int));
84fc6d4d 2890void increment_row_positions P_ ((struct glyph_row *, int, int));
5f5c8ee5
GM
2891void enable_glyph_matrix_rows P_ ((struct glyph_matrix *, int, int, int));
2892void clear_glyph_row P_ ((struct glyph_row *));
2893void prepare_desired_row P_ ((struct glyph_row *));
2894int line_hash_code P_ ((struct glyph_row *));
2895void set_window_update_flags P_ ((struct window *, int));
2896void write_glyphs P_ ((struct glyph *, int));
2897void insert_glyphs P_ ((struct glyph *, int));
2898void redraw_frame P_ ((struct frame *));
2899void redraw_garbaged_frames P_ ((void));
2900int scroll_cost P_ ((struct frame *, int, int, int));
2901int direct_output_for_insert P_ ((int));
2902int direct_output_forward_char P_ ((int));
2903int update_frame P_ ((struct frame *, int, int));
2904void update_single_window P_ ((struct window *, int));
2905int scrolling P_ ((struct frame *));
3f7267e7
GM
2906void do_pending_window_change P_ ((int));
2907void change_frame_size P_ ((struct frame *, int, int, int, int, int));
5f5c8ee5
GM
2908void bitch_at_user P_ ((void));
2909Lisp_Object sit_for P_ ((int, int, int, int, int));
2910void init_display P_ ((void));
2911void syms_of_display P_ ((void));
69a7a14d 2912extern Lisp_Object Qredisplay_dont_pause;
ec5d8db7
AS
2913
2914/* Defined in term.c */
5f5c8ee5 2915
ec5d8db7
AS
2916extern void ring_bell P_ ((void));
2917extern void set_terminal_modes P_ ((void));
2918extern void reset_terminal_modes P_ ((void));
2919extern void update_begin P_ ((struct frame *));
2920extern void update_end P_ ((struct frame *));
2921extern void set_terminal_window P_ ((int));
2922extern void set_scroll_region P_ ((int, int));
2923extern void turn_off_insert P_ ((void));
2924extern void turn_off_highlight P_ ((void));
2925extern void background_highlight P_ ((void));
ec5d8db7
AS
2926extern void clear_frame P_ ((void));
2927extern void clear_end_of_line P_ ((int));
2928extern void clear_end_of_line_raw P_ ((int));
ec5d8db7
AS
2929extern void delete_glyphs P_ ((int));
2930extern void ins_del_lines P_ ((int, int));
2931extern int string_cost P_ ((char *));
2932extern int per_line_cost P_ ((char *));
2933extern void calculate_costs P_ ((struct frame *));
70f50bf1
EZ
2934extern void set_tty_color_mode P_ ((struct frame *, Lisp_Object));
2935extern void tty_setup_colors P_ ((int));
ec5d8db7
AS
2936extern void term_init P_ ((char *));
2937extern void fatal P_ ((/* char *, ... */));
5f5c8ee5 2938void cursor_to P_ ((int, int));
a0816661 2939extern int tty_capable_p P_ ((struct frame *, unsigned, unsigned long, unsigned long));
ec5d8db7
AS
2940
2941/* Defined in scroll.c */
5f5c8ee5 2942
ec5d8db7
AS
2943extern int scrolling_max_lines_saved P_ ((int, int, int *, int *, int *));
2944extern int scroll_cost P_ ((struct frame *, int, int, int));
2945extern void do_line_insertion_deletion_costs P_ ((struct frame *, char *,
2946 char *, char *, char *,
2947 char *, char *, int));
5f5c8ee5
GM
2948void scrolling_1 P_ ((struct frame *, int, int, int, int *, int *, int *,
2949 int *, int));
87485d6f 2950
e6b3aecd
KS
2951/* Defined in frame.c */
2952
2953#ifdef HAVE_WINDOW_SYSTEM
2954
2955/* Types we might convert a resource string into. */
2956enum resource_types
2957{
2958 RES_TYPE_NUMBER,
2959 RES_TYPE_FLOAT,
2960 RES_TYPE_BOOLEAN,
2961 RES_TYPE_STRING,
2962 RES_TYPE_SYMBOL
2963};
2964
2965extern Lisp_Object x_get_arg P_ ((Display_Info *, Lisp_Object,
2966 Lisp_Object, char *, char *class,
2967 enum resource_types));
2968extern Lisp_Object x_frame_get_arg P_ ((struct frame *, Lisp_Object,
2969 Lisp_Object, char *, char *,
2970 enum resource_types));
2971extern Lisp_Object x_frame_get_and_record_arg P_ ((
2972 struct frame *, Lisp_Object,
2973 Lisp_Object, char *, char *,
2974 enum resource_types));
2975extern Lisp_Object x_default_parameter P_ ((struct frame *, Lisp_Object,
2976 Lisp_Object, Lisp_Object,
2977 char *, char *,
2978 enum resource_types));
2979
2980#endif /* HAVE_WINDOW_SYSTEM */
2981
5f5c8ee5 2982#endif /* not DISPEXTERN_H_INCLUDED */
ab5796a9
MB
2983
2984/* arch-tag: c65c475f-1c1e-4534-8795-990b8509fd65
2985 (do not change this comment) */