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