| 1 | /* Interface definitions for display code. |
| 2 | Copyright (C) 1985, 1993, 1994 Free Software Foundation, Inc. |
| 3 | |
| 4 | This file is part of GNU Emacs. |
| 5 | |
| 6 | GNU Emacs is free software; you can redistribute it and/or modify |
| 7 | it under the terms of the GNU General Public License as published by |
| 8 | the Free Software Foundation; either version 2, or (at your option) |
| 9 | any later version. |
| 10 | |
| 11 | GNU Emacs is distributed in the hope that it will be useful, |
| 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 14 | GNU General Public License for more details. |
| 15 | |
| 16 | You should have received a copy of the GNU General Public License |
| 17 | along with GNU Emacs; see the file COPYING. If not, write to |
| 18 | the Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
| 19 | Boston, MA 02111-1307, USA. */ |
| 20 | |
| 21 | #ifndef _DISPEXTERN_H_ |
| 22 | #define _DISPEXTERN_H_ |
| 23 | |
| 24 | /* Nonzero means last display completed and cursor is really at |
| 25 | cursX, cursY. Zero means it was preempted. */ |
| 26 | extern int display_completed; |
| 27 | |
| 28 | #ifdef HAVE_X_WINDOWS |
| 29 | #include <X11/Xlib.h> |
| 30 | #endif |
| 31 | |
| 32 | #ifdef MSDOS |
| 33 | #include "msdos.h" |
| 34 | #endif |
| 35 | |
| 36 | #ifdef HAVE_NTGUI |
| 37 | #include "w32gui.h" |
| 38 | #endif |
| 39 | |
| 40 | #ifdef HAVE_FACES |
| 41 | struct face |
| 42 | { |
| 43 | /* If this is non-zero, it is a GC we can use without modification |
| 44 | to represent this face. Used only for ASCII characters. */ |
| 45 | GC gc; |
| 46 | |
| 47 | /* GC used for non-ASCII characters. */ |
| 48 | GC non_ascii_gc; |
| 49 | |
| 50 | /* Pixel value for foreground color. */ |
| 51 | EMACS_UINT foreground; |
| 52 | |
| 53 | /* Pixel value for background color. */ |
| 54 | EMACS_UINT background; |
| 55 | |
| 56 | /* Font used for this face. If any fontset is set for this face, |
| 57 | this points to a `font' slot of the struct `font_info' for an |
| 58 | ASCII font of the fontset. In that case, we should not call |
| 59 | XFreeFont on it because the font may still be used somewhere |
| 60 | else. */ |
| 61 | XFontStruct *font; |
| 62 | |
| 63 | /* Fontset ID if any fontset is set for this face, else -1. */ |
| 64 | int fontset; |
| 65 | |
| 66 | /* Background stipple or bitmap used for this face. */ |
| 67 | Pixmap stipple; |
| 68 | |
| 69 | /* Pixmap_depth. */ |
| 70 | unsigned int pixmap_w, pixmap_h; |
| 71 | |
| 72 | /* Whether or not to underline text in this face. */ |
| 73 | char underline; |
| 74 | }; |
| 75 | |
| 76 | /* Let's stop using this and get rid of it. */ |
| 77 | typedef struct face *FACE; |
| 78 | |
| 79 | #define NORMAL_FACE ((struct face *) 0) |
| 80 | |
| 81 | #define FACE_HAS_GC(f) ((f)->gc) |
| 82 | #define FACE_GC(f) ((f)->gc) |
| 83 | #define FACE_NON_ASCII_GC(f) ((f)->non_ascii_gc) |
| 84 | #define FACE_FOREGROUND(f) ((f)->foreground) |
| 85 | #define FACE_BACKGROUND(f) ((f)->background) |
| 86 | #define FACE_FONT(f) ((f)->font) |
| 87 | #define FACE_FONTSET(f) ((f)->fontset) |
| 88 | #define FACE_STIPPLE(f) ((f)->stipple) |
| 89 | #define FACE_UNDERLINE_P(f) ((f)->underline) |
| 90 | |
| 91 | #else /* not HAVE_FACES */ |
| 92 | |
| 93 | typedef int FACE; |
| 94 | |
| 95 | #define NORMAL_FACE 0x0 |
| 96 | #define HIGHLIGHT_FACE 0x1 |
| 97 | #define UNDERLINE_FACE 0x2 |
| 98 | #define HIGHLIGHT_UNDERLINE_FACE 0x3 |
| 99 | |
| 100 | #define FACE_HIGHLIGHT(f) ((f) & 0x1) |
| 101 | #define FACE_UNDERLINE(f) ((f) & 0x2) |
| 102 | |
| 103 | #endif /* not HAVE_FACES */ |
| 104 | |
| 105 | |
| 106 | /* This structure is used for the actual display of text on a frame. |
| 107 | |
| 108 | There are two instantiations of it: the glyphs currently displayed, |
| 109 | and the glyphs we desire to display. The latter object is generated |
| 110 | from buffers being displayed. */ |
| 111 | |
| 112 | struct frame_glyphs |
| 113 | { |
| 114 | struct frame *frame; /* Frame these glyphs belong to. */ |
| 115 | int height; |
| 116 | int width; |
| 117 | |
| 118 | /* Contents of the frame. |
| 119 | glyphs[V][H] is the glyph at position V, H. |
| 120 | Note that glyphs[V][-1], |
| 121 | glyphs[V][used[V]], |
| 122 | and glyphs[V][frame_width] are always '\0'. */ |
| 123 | GLYPH **glyphs; |
| 124 | /* long vector from which the strings in `glyphs' are taken. */ |
| 125 | GLYPH *total_contents; |
| 126 | |
| 127 | /* When representing a desired frame, |
| 128 | enable[n] == 0 means that line n is same as current frame. |
| 129 | Between updates, all lines should be disabled. |
| 130 | When representing current frame contents, |
| 131 | enable[n] == 0 means that line n is blank. */ |
| 132 | char *enable; |
| 133 | |
| 134 | /* Everything on line n after column used[n] is considered blank. */ |
| 135 | int *used; |
| 136 | |
| 137 | /* highlight[n] != 0 iff line n is highlighted. */ |
| 138 | char *highlight; |
| 139 | |
| 140 | /* Buffer offset of this line's first char. |
| 141 | This is not really implemented, and cannot be, |
| 142 | and should be deleted. */ |
| 143 | int *bufp; |
| 144 | |
| 145 | #ifdef HAVE_WINDOW_SYSTEM |
| 146 | /* Pixel position of top left corner of line. */ |
| 147 | short *top_left_x; |
| 148 | short *top_left_y; |
| 149 | |
| 150 | /* Pixel width of line. */ |
| 151 | short *pix_width; |
| 152 | |
| 153 | /* Pixel height of line. */ |
| 154 | short *pix_height; |
| 155 | |
| 156 | /* Largest font ascent on this line. */ |
| 157 | short *max_ascent; |
| 158 | #endif /* HAVE_WINDOW_SYSTEM */ |
| 159 | |
| 160 | /* Mapping of coordinate pairs to buffer positions. |
| 161 | This field holds a vector indexed by row number. |
| 162 | Its elements are vectors indexed by column number. |
| 163 | Each element of these vectors is a buffer position, 0, or -1. |
| 164 | |
| 165 | For a column where the image of a text character starts, |
| 166 | the element value is the buffer position of that character. |
| 167 | When a window's screen line starts in mid character, |
| 168 | the element for the line's first column (at the window's left margin) |
| 169 | is that character's position. |
| 170 | For successive columns within a multicolumn character, |
| 171 | the element is -1. |
| 172 | For the column just beyond the last glyph on a line, |
| 173 | the element is the buffer position of the end of the line. |
| 174 | For following columns within the same window, the element is 0. |
| 175 | For rows past the end of the accessible buffer text, |
| 176 | the window's first column has ZV and other columns have 0. |
| 177 | |
| 178 | Mode lines and vertical separator lines have 0. |
| 179 | |
| 180 | The column of a window's left margin |
| 181 | always has a positive value (a buffer position), not 0 or -1, |
| 182 | for each line in that window's interior. */ |
| 183 | |
| 184 | int **charstarts; |
| 185 | |
| 186 | /* This holds all the space in the subvectors of the charstarts field. */ |
| 187 | int *total_charstarts; |
| 188 | }; |
| 189 | |
| 190 | extern void get_display_line (); |
| 191 | extern Lisp_Object sit_for (); |
| 192 | |
| 193 | #endif /* not _DISPEXTERN_H_ */ |