1 /* Interface definitions for display code.
2 Copyright (C) 1985, 1993, 1994 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
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)
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.
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. */
21 #ifndef _DISPEXTERN_H_
22 #define _DISPEXTERN_H_
24 /* Nonzero means last display completed and cursor is really at
25 cursX, cursY. Zero means it was preempted. */
26 extern int display_completed
;
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. */
47 /* GC used for non-ASCII characters. */
50 /* Pixel value for foreground color. */
51 EMACS_UINT foreground
;
53 /* Pixel value for background color. */
54 EMACS_UINT background
;
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
63 /* Fontset ID if any fontset is set for this face, else -1. */
66 /* Background stipple or bitmap used for this face. */
70 unsigned int pixmap_w
, pixmap_h
;
72 /* Whether or not to underline text in this face. */
76 /* Let's stop using this and get rid of it. */
77 typedef struct face
*FACE
;
79 #define NORMAL_FACE ((struct face *) 0)
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)
91 #else /* not HAVE_FACES */
95 #define NORMAL_FACE 0x0
96 #define HIGHLIGHT_FACE 0x1
97 #define UNDERLINE_FACE 0x2
98 #define HIGHLIGHT_UNDERLINE_FACE 0x3
100 #define FACE_HIGHLIGHT(f) ((f) & 0x1)
101 #define FACE_UNDERLINE(f) ((f) & 0x2)
103 #endif /* not HAVE_FACES */
106 /* This structure is used for the actual display of text on a frame.
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. */
114 struct frame
*frame
; /* Frame these glyphs belong to. */
118 /* Contents of the frame.
119 glyphs[V][H] is the glyph at position V, H.
120 Note that glyphs[V][-1],
122 and glyphs[V][frame_width] are always '\0'. */
124 /* long vector from which the strings in `glyphs' are taken. */
125 GLYPH
*total_contents
;
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. */
134 /* Everything on line n after column used[n] is considered blank. */
137 /* highlight[n] != 0 iff line n is highlighted. */
140 /* Buffer offset of this line's first char.
141 This is not really implemented, and cannot be,
142 and should be deleted. */
145 #ifdef HAVE_WINDOW_SYSTEM
146 /* Pixel position of top left corner of line. */
150 /* Pixel width of line. */
153 /* Pixel height of line. */
156 /* Largest font ascent on this line. */
158 #endif /* HAVE_WINDOW_SYSTEM */
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.
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,
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.
178 Mode lines and vertical separator lines have 0.
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. */
186 /* This holds all the space in the subvectors of the charstarts field. */
187 int *total_charstarts
;
190 extern void redraw_frame
P_ ((struct frame
*));
191 extern void redraw_garbaged_frames
P_ ((void));
192 extern void free_frame_glyphs
P_ ((struct frame
*, struct frame_glyphs
*));
193 extern void remake_frame_glyphs
P_ ((struct frame
*));
194 extern void cancel_line
P_ ((int, struct frame
*));
195 extern void clear_frame_records
P_ ((struct frame
*));
196 extern void init_desired_glyphs
P_ ((struct frame
*));
197 extern void get_display_line
P_ ((struct frame
*, int, int));
198 extern int scroll_frame_lines
P_ ((struct frame
*, int, int, int, int));
199 extern void preserve_other_columns
P_ ((struct window
*));
200 extern void adjust_window_charstarts
P_ ((struct window
*, int, int));
201 extern void verify_charstarts
P_ ((struct window
*));
202 extern void cancel_my_columns
P_ ((struct window
*));
203 extern int direct_output_for_insert
P_ ((int));
204 extern int direct_output_forward_char
P_ ((int));
205 extern int update_frame
P_ ((struct frame
*, int, int));
206 extern void quit_error_check
P_ ((void));
207 extern int scrolling
P_ ((struct frame
*));
208 extern int buffer_posn_from_coords
P_ ((struct window
*, int, int));
209 extern void do_pending_window_change
P_ ((void));
210 extern void change_frame_size
P_ ((struct frame
*, int, int, int, int));
211 extern void bitch_at_user
P_ ((void));
213 /* Defined in term.c */
214 extern void ring_bell
P_ ((void));
215 extern void set_terminal_modes
P_ ((void));
216 extern void reset_terminal_modes
P_ ((void));
217 extern void update_begin
P_ ((struct frame
*));
218 extern void update_end
P_ ((struct frame
*));
219 extern void set_terminal_window
P_ ((int));
220 extern void set_scroll_region
P_ ((int, int));
221 extern void turn_off_insert
P_ ((void));
222 extern void turn_off_highlight
P_ ((void));
223 extern void background_highlight
P_ ((void));
224 extern void reassert_line_highlight
P_ ((int, int));
225 extern void change_line_highlight
P_ ((int, int, int));
226 extern void cursor_to
P_ ((int, int));
227 extern void clear_frame
P_ ((void));
228 extern void clear_end_of_line
P_ ((int));
229 extern void clear_end_of_line_raw
P_ ((int));
230 extern void write_glyphs
P_ ((GLYPH
*, int));
231 extern void insert_glyphs
P_ ((GLYPH
*, int));
232 extern void delete_glyphs
P_ ((int));
233 extern void ins_del_lines
P_ ((int, int));
234 extern int string_cost
P_ ((char *));
235 extern int per_line_cost
P_ ((char *));
236 extern void calculate_costs
P_ ((struct frame
*));
237 extern void term_init
P_ ((char *));
238 extern void fatal
P_ ((/* char *, ... */));
240 /* Defined in scroll.c */
241 extern int scrolling_max_lines_saved
P_ ((int, int, int *, int *, int *));
242 extern int scroll_cost
P_ ((struct frame
*, int, int, int));
243 extern void do_line_insertion_deletion_costs
P_ ((struct frame
*, char *,
244 char *, char *, char *,
245 char *, char *, int));
247 #endif /* not _DISPEXTERN_H_ */