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