]> code.delx.au - gnu-emacs/blob - src/frame.h
*** empty log message ***
[gnu-emacs] / src / frame.h
1 /* Define frame-object for GNU Emacs.
2 Copyright (C) 1988, 1992 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
21 /* The structure representing a frame.
22
23 We declare this even if MULTI_FRAME is not defined, because when
24 we lack multi-frame support, we use one instance of this structure
25 to represent the one frame we support. This is cleaner than
26 having miscellaneous random variables scattered about. */
27
28 enum output_method
29 { output_termcap, output_x_window };
30
31 struct frame
32 {
33 int size;
34 struct Lisp_Vector *next;
35
36 /* glyphs as they appear on the frame */
37 struct frame_glyphs *current_glyphs;
38
39 /* glyphs we'd like to appear on the frame */
40 struct frame_glyphs *desired_glyphs;
41
42 /* See do_line_insertion_deletion_costs for info on these arrays. */
43 /* Cost of inserting 1 line on this frame */
44 int *insert_line_cost;
45 /* Cost of deleting 1 line on this frame */
46 int *delete_line_cost;
47 /* Cost of inserting n lines on this frame */
48 int *insert_n_lines_cost;
49 /* Cost of deleting n lines on this frame */
50 int *delete_n_lines_cost;
51
52 /* glyphs for the mode line */
53 struct frame_glyphs *temp_glyphs;
54
55 /* Intended cursor position of this frame.
56 Measured in characters, counting from upper left corner
57 within the frame. */
58 int cursor_x;
59 int cursor_y;
60
61 /* Actual cursor position of this frame, and the character under it.
62 (Not used for terminal frames.) */
63 int phys_cursor_x;
64 int phys_cursor_y;
65 /* This is handy for undrawing the cursor, because current_glyphs is
66 not always accurate when in do_scrolling. */
67 GLYPH phys_cursor_glyph;
68
69 /* Size of this frame, in units of characters. */
70 int height;
71 int width;
72
73 /* New height and width for pending size change. 0 if no change pending. */
74 int new_height, new_width;
75
76 /* Name of this frame: a Lisp string. */
77 Lisp_Object name;
78
79 /* The frame which should recieve keystrokes that occur in this
80 frame. This is usually the frame itself, but if the frame is
81 minibufferless, this points to the minibuffer frame when it is
82 active. */
83 Lisp_Object focus_frame;
84
85 /* This frame's root window. Every frame has one.
86 If the frame has only a minibuffer window, this is it.
87 Otherwise, if the frame has a minibuffer window, this is its sibling. */
88 Lisp_Object root_window;
89
90 /* This frame's selected window.
91 Each frame has its own window hierarchy
92 and one of the windows in it is selected within the frame.
93 The selected window of the selected frame is Emacs's selected window. */
94 Lisp_Object selected_window;
95
96 /* This frame's minibuffer window.
97 Most frames have their own minibuffer windows,
98 but only the selected frame's minibuffer window
99 can actually appear to exist. */
100 Lisp_Object minibuffer_window;
101
102 /* Parameter alist of this frame.
103 These are the parameters specified when creating the frame
104 or modified with modify-frame-parameters. */
105 Lisp_Object param_alist;
106
107 /* The output method says how the contents of this frame
108 are displayed. It could be using termcap, or using an X window. */
109 enum output_method output_method;
110
111 /* A structure of auxiliary data used for displaying the contents.
112 struct x_display is used for X window frames;
113 it is defined in xterm.h. */
114 union display { struct x_display *x; int nothing; } display;
115
116 /* Nonzero if last attempt at redisplay on this frame was preempted. */
117 char display_preempted;
118
119 /* Nonzero if frame is currently displayed. */
120 char visible;
121
122 /* Nonzero if window is currently iconified.
123 This and visible are mutually exclusive. */
124 char iconified;
125
126 /* Nonzero if this frame should be redrawn. */
127 char garbaged;
128
129 /* True if frame actually has a minibuffer window on it.
130 0 if using a minibuffer window that isn't on this frame. */
131 char has_minibuffer;
132
133 /* 0 means, if this frame has just one window,
134 show no modeline for that window. */
135 char wants_modeline;
136
137 /* Non-0 means raise this frame to the top of the heap when selected. */
138 char auto_raise;
139
140 /* Non-0 means lower this frame to the bottom of the stack when left. */
141 char auto_lower;
142
143 /* True if frame's root window can't be split. */
144 char no_split;
145
146 /* Storage for messages to this frame. */
147 char *message_buf;
148
149 /* Nonnegative if current redisplay should not do scroll computation
150 for lines beyond a certain vpos. This is the vpos. */
151 int scroll_bottom_vpos;
152 };
153
154 #ifdef MULTI_FRAME
155
156 typedef struct frame *FRAME_PTR;
157
158 #define XFRAME(p) ((struct frame *) XPNTR (p))
159 #define XSETFRAME(p, v) ((struct frame *) XSETPNTR (p, v))
160
161 #define WINDOW_FRAME(w) (w)->frame
162
163 #define FRAMEP(f) (XTYPE(f) == Lisp_Frame)
164 #define FRAME_LIVE_P(f) ((f)->display.nothing != 0)
165 #define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap)
166 #define FRAME_X_P(f) ((f)->output_method == output_x_window)
167 #define FRAME_MINIBUF_ONLY_P(f) \
168 EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f))
169 #define FRAME_HAS_MINIBUF_P(f) ((f)->has_minibuffer)
170 #define FRAME_CURRENT_GLYPHS(f) (f)->current_glyphs
171 #define FRAME_DESIRED_GLYPHS(f) (f)->desired_glyphs
172 #define FRAME_TEMP_GLYPHS(f) (f)->temp_glyphs
173 #define FRAME_HEIGHT(f) (f)->height
174 #define FRAME_WIDTH(f) (f)->width
175 #define FRAME_NEW_HEIGHT(f) (f)->new_height
176 #define FRAME_NEW_WIDTH(f) (f)->new_width
177 #define FRAME_CURSOR_X(f) (f)->cursor_x
178 #define FRAME_CURSOR_Y(f) (f)->cursor_y
179 #define FRAME_VISIBLE_P(f) (f)->visible
180 #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1, f->garbaged = 1)
181 #define FRAME_GARBAGED_P(f) (f)->garbaged
182 #define FRAME_NO_SPLIT_P(f) (f)->no_split
183 #define FRAME_WANTS_MODELINE_P(f) (f)->wants_modeline
184 #define FRAME_ICONIFIED_P(f) (f)->iconified
185 #define FRAME_MINIBUF_WINDOW(f) (f)->minibuffer_window
186 #define FRAME_ROOT_WINDOW(f) (f)->root_window
187 #define FRAME_SELECTED_WINDOW(f) (f)->selected_window
188 #define SET_GLYPHS_FRAME(glyphs,frame) ((glyphs)->frame = (frame))
189 #define FRAME_INSERT_COST(f) (f)->insert_line_cost
190 #define FRAME_DELETE_COST(f) (f)->delete_line_cost
191 #define FRAME_INSERTN_COST(f) (f)->insert_n_lines_cost
192 #define FRAME_DELETEN_COST(f) (f)->delete_n_lines_cost
193 #define FRAME_MESSAGE_BUF(f) (f)->message_buf
194 #define FRAME_SCROLL_BOTTOM_VPOS(f) (f)->scroll_bottom_vpos
195 #define FRAME_FOCUS_FRAME(f) (f)->focus_frame
196
197 #define CHECK_FRAME(x, i) \
198 { \
199 if (! FRAMEP (x)) \
200 x = wrong_type_argument (Qframep, (x)); \
201 }
202
203 #define CHECK_LIVE_FRAME(x, i) \
204 { \
205 if (! FRAMEP (x) \
206 || ! FRAME_LIVE_P (XFRAME (x))) \
207 x = wrong_type_argument (Qlive_frame_p, (x)); \
208 }
209
210 /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
211 `for' loop which iterates over the elements of Vframe_list. The
212 loop will set FRAME_VAR, a FRAME_PTR, to each frame in
213 Vframe_list in succession and execute the statement. LIST_VAR
214 should be a Lisp_Object; it is used to iterate through the
215 Vframe_list.
216
217 If MULTI_FRAME isn't defined, then this loop expands to something which
218 executes the statement once. */
219 #define FOR_EACH_FRAME(list_var, frame_var) \
220 for ((list_var) = Vframe_list; \
221 (CONSP (list_var) \
222 && (frame_var = XFRAME (XCONS (list_var)->car), 1)); \
223 list_var = XCONS (list_var)->cdr)
224
225
226 extern Lisp_Object Qframep, Qlive_frame_p;
227
228 extern struct frame *selected_frame;
229 extern struct frame *last_nonminibuf_frame;
230
231 extern struct frame *make_terminal_frame ();
232 extern struct frame *make_frame ();
233 extern struct frame *make_minibuffer_frame ();
234 extern struct frame *make_frame_without_minibuffer ();
235
236 /* Nonzero means FRAME_MESSAGE_BUF (selected_frame) is being used by
237 print. */
238 extern int message_buf_print;
239
240 extern Lisp_Object Vframe_list;
241 extern Lisp_Object Vdefault_frame_alist;
242
243 extern Lisp_Object Vterminal_frame;
244 \f
245 #else /* not MULTI_FRAME */
246
247 /* These definitions are used in a single-frame version of Emacs. */
248
249 #define FRAME_PTR int
250
251 /* A frame we use to store all the data concerning the screen when we
252 don't have multiple frames. Remember, if you store any data in it
253 which needs to be protected from GC, you should staticpro that
254 element explicitly. */
255 extern struct frame the_only_frame;
256
257 extern int selected_frame;
258 extern int last_nonminibuf_frame;
259
260 /* Nonzero means FRAME_MESSAGE_BUF (selected_frame) is being used by
261 print. */
262 extern int message_buf_print;
263
264 #define XFRAME(f) selected_frame
265 #define WINDOW_FRAME(w) selected_frame
266
267 #define FRAMEP(f) (XTYPE(f) == Lisp_Frame)
268 #define FRAME_LIVE_P(f) 1
269 #define FRAME_TERMCAP_P(f) 1
270 #define FRAME_X_P(f) 0
271 #define FRAME_MINIBUF_ONLY_P(f) 0
272 #define FRAME_HAS_MINIBUF_P(f) 1
273 #define FRAME_CURRENT_GLYPHS(f) (the_only_frame.current_glyphs)
274 #define FRAME_DESIRED_GLYPHS(f) (the_only_frame.desired_glyphs)
275 #define FRAME_TEMP_GLYPHS(f) (the_only_frame.temp_glyphs)
276 #define FRAME_HEIGHT(f) (the_only_frame.height)
277 #define FRAME_WIDTH(f) (the_only_frame.width)
278 #define FRAME_NEW_HEIGHT(f) (the_only_frame.new_height)
279 #define FRAME_NEW_WIDTH(f) (the_only_frame.new_width)
280 #define FRAME_CURSOR_X(f) (the_only_frame.cursor_x)
281 #define FRAME_CURSOR_Y(f) (the_only_frame.cursor_y)
282 #define FRAME_VISIBLE_P(f) 1
283 #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1)
284 #define FRAME_GARBAGED_P(f) (frame_garbaged)
285 #define FRAME_NO_SPLIT_P(f) 0
286 #define FRAME_WANTS_MODELINE_P(f) 1
287 #define FRAME_ICONIFIED_P(f) 0
288 #define FRAME_MINIBUF_WINDOW(f) (minibuf_window)
289 #define FRAME_ROOT_WINDOW(f) (XWINDOW (minibuf_window)->prev)
290 #define FRAME_SELECTED_WINDOW(f) (selected_window)
291 #define SET_GLYPHS_FRAME(glyphs,frame) do ; while (0)
292 #define FRAME_INSERT_COST(frame) (the_only_frame.insert_line_cost)
293 #define FRAME_DELETE_COST(frame) (the_only_frame.delete_line_cost)
294 #define FRAME_INSERTN_COST(frame) (the_only_frame.insert_n_lines_cost)
295 #define FRAME_DELETEN_COST(frame) (the_only_frame.delete_n_lines_cost)
296 #define FRAME_MESSAGE_BUF(f) (the_only_frame.message_buf)
297 #define FRAME_SCROLL_BOTTOM_VPOS(f) (the_only_frame.scroll_bottom_vpos)
298 #define FRAME_FOCUS_FRAME(f) (0)
299
300 #define CHECK_FRAME(x, i) do; while (0)
301 #define CHECK_LIVE_FRAME(x, y) do; while (0)
302
303 /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
304 `for' loop which iterates over the elements of Vframe_list. The
305 loop will set FRAME_VAR, a FRAME_PTR, to each frame in
306 Vframe_list in succession and execute the statement. LIST_VAR
307 should be a Lisp_Object; it is used to iterate through the
308 Vframe_list.
309
310 If MULTI_FRAME _is_ defined, then this loop expands to a real
311 `for' loop which traverses Vframe_list using LIST_VAR and
312 FRAME_VAR. */
313 #define FOR_EACH_FRAME(list_var, frame_var) \
314 for (frame_var = (FRAME_PTR) 1; frame_var; frame_var = (FRAME_PTR) 0)
315
316 #endif /* not MULTI_FRAME */