| 1 | /* Interface definitions for display code. |
| 2 | Copyright (C) 1985, 1993 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, 675 Mass Ave, Cambridge, MA 02139, USA. */ |
| 19 | |
| 20 | /* Nonzero means last display completed and cursor is really at |
| 21 | cursX, cursY. Zero means it was preempted. */ |
| 22 | extern int display_completed; |
| 23 | |
| 24 | #ifdef HAVE_X_WINDOWS |
| 25 | #include <X11/Xlib.h> |
| 26 | |
| 27 | struct face |
| 28 | { |
| 29 | /* If this is non-zero, it is a GC we can use without modification |
| 30 | to represent this face. */ |
| 31 | GC gc; |
| 32 | |
| 33 | /* If we have ever called get_cached_face on this face structure, |
| 34 | here is the index in face_vector of the face it returned. It |
| 35 | might not be valid any more, but it's a good place to start |
| 36 | looking; get_cached_face tries to use this to avoid searching |
| 37 | all of face_vector. */ |
| 38 | int cached_index; |
| 39 | |
| 40 | /* Pixel value for foreground color. */ |
| 41 | int foreground; |
| 42 | |
| 43 | /* Pixel value for background color. */ |
| 44 | int background; |
| 45 | |
| 46 | /* Font used for this face. */ |
| 47 | XFontStruct *font; |
| 48 | |
| 49 | /* Background stipple or bitmap used for this face. */ |
| 50 | Pixmap stipple; |
| 51 | |
| 52 | /* Pixmap_depth. */ |
| 53 | unsigned int pixmap_w, pixmap_h; |
| 54 | |
| 55 | /* Whether or not to underline text in this face. */ |
| 56 | char underline; |
| 57 | |
| 58 | /* Does this face own its resources? (color, font, etcetera) |
| 59 | If this is a face which we computed by combining other faces, |
| 60 | then this is true, and we shouldn't free any of the resources |
| 61 | it refers to; the faces from which it was constructed own it. |
| 62 | On the other hand, if this is a face the user created and |
| 63 | filled in directly, then this is false, and we should free the |
| 64 | resources when we free it. */ |
| 65 | char copy; |
| 66 | }; |
| 67 | |
| 68 | /* Let's stop using this and get rid of it. */ |
| 69 | typedef struct face *FACE; |
| 70 | |
| 71 | #define NORMAL_FACE ((struct face *) 0) |
| 72 | |
| 73 | #define FACE_HAS_GC(f) ((f)->gc) |
| 74 | #define FACE_GC(f) ((f)->gc) |
| 75 | #define FACE_FOREGROUND(f) ((f)->foreground) |
| 76 | #define FACE_BACKGROUND(f) ((f)->background) |
| 77 | #define FACE_FONT(f) ((f)->font) |
| 78 | #define FACE_STIPPLE(f) ((f)->stipple) |
| 79 | #define FACE_UNDERLINE_P(f) ((f)->underline) |
| 80 | |
| 81 | #else /* Not X */ |
| 82 | |
| 83 | typedef int FACE; |
| 84 | |
| 85 | #define NORMAL_FACE 0x0 |
| 86 | #define HIGHLIGHT_FACE 0x1 |
| 87 | #define UNDERLINE_FACE 0x2 |
| 88 | #define HIGHLIGHT_UNDERLINE_FACE 0x3 |
| 89 | |
| 90 | #define FACE_HIGHLIGHT(f) ((f) & 0x1) |
| 91 | #define FACE_UNDERLINE(f) ((f) & 0x2) |
| 92 | #endif /* Not X */ |
| 93 | |
| 94 | |
| 95 | /* This structure is used for the actual display of text on a frame. |
| 96 | |
| 97 | There are two instantiations of it: the glyphs currently displayed, |
| 98 | and the glyphs we desire to display. The latter object is generated |
| 99 | from buffers being displayed. */ |
| 100 | |
| 101 | struct frame_glyphs |
| 102 | { |
| 103 | #ifdef MULTI_FRAME |
| 104 | struct frame *frame; /* Frame these glyphs belong to. */ |
| 105 | #endif /* MULTI_FRAME */ |
| 106 | int height; |
| 107 | int width; |
| 108 | |
| 109 | /* Contents of the frame. |
| 110 | glyphs[V][H] is the glyph at position V, H. |
| 111 | Note that glyphs[V][-1], |
| 112 | glyphs[V][used[V]], |
| 113 | and glyphs[V][frame_width] are always '\0'. */ |
| 114 | GLYPH **glyphs; |
| 115 | /* long vector from which the strings in `glyphs' are taken. */ |
| 116 | GLYPH *total_contents; |
| 117 | |
| 118 | /* When representing a desired frame, |
| 119 | enable[n] == 0 means that line n is same as current frame. |
| 120 | Between updates, all lines should be disabled. |
| 121 | When representing current frame contents, |
| 122 | enable[n] == 0 means that line n is blank. */ |
| 123 | char *enable; |
| 124 | |
| 125 | /* Everything on line n after column used[n] is considered blank. */ |
| 126 | int *used; |
| 127 | |
| 128 | /* highlight[n] != 0 iff line n is highlighted. */ |
| 129 | char *highlight; |
| 130 | |
| 131 | /* Buffer offset of this line's first char. */ |
| 132 | int *bufp; |
| 133 | |
| 134 | #ifdef HAVE_X_WINDOWS |
| 135 | /* Pixel position of top left corner of line. */ |
| 136 | short *top_left_x; |
| 137 | short *top_left_y; |
| 138 | |
| 139 | /* Pixel width of line. */ |
| 140 | short *pix_width; |
| 141 | |
| 142 | /* Pixel height of line. */ |
| 143 | short *pix_height; |
| 144 | |
| 145 | /* Largest font ascent on this line. */ |
| 146 | short *max_ascent; |
| 147 | #endif /* HAVE_X_WINDOWS */ |
| 148 | }; |
| 149 | |
| 150 | extern void get_display_line (); |
| 151 | extern Lisp_Object sit_for (); |