Commit | Line | Data |
---|---|---|
ff11dfa1 | 1 | /* Define frame-object for GNU Emacs. |
3a22ee35 | 2 | Copyright (C) 1993, 1994 Free Software Foundation, Inc. |
efa4ce8b JB |
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 | |
e5d77022 | 8 | the Free Software Foundation; either version 2, or (at your option) |
efa4ce8b JB |
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 | ||
20a6c8d7 JB |
20 | \f |
21 | /* Miscellanea. */ | |
22 | ||
23 | /* Nonzero means don't assume anything about current | |
24 | contents of actual terminal frame */ | |
25 | extern int frame_garbaged; | |
26 | ||
27 | /* Nonzero means FRAME_MESSAGE_BUF (selected_frame) is being used by | |
28 | print. */ | |
29 | extern int message_buf_print; | |
efa4ce8b | 30 | |
20a6c8d7 | 31 | \f |
ff11dfa1 | 32 | /* The structure representing a frame. |
e5d77022 | 33 | |
ff11dfa1 JB |
34 | We declare this even if MULTI_FRAME is not defined, because when |
35 | we lack multi-frame support, we use one instance of this structure | |
36 | to represent the one frame we support. This is cleaner than | |
e5d77022 | 37 | having miscellaneous random variables scattered about. */ |
efa4ce8b JB |
38 | |
39 | enum output_method | |
87485d6f | 40 | { output_termcap, output_x_window, output_msdos_raw }; |
efa4ce8b | 41 | |
ff11dfa1 | 42 | struct frame |
efa4ce8b | 43 | { |
0c38c2f9 | 44 | EMACS_INT size; |
efa4ce8b JB |
45 | struct Lisp_Vector *next; |
46 | ||
21015f9c RS |
47 | /* All Lisp_Object components must come first. |
48 | Only EMACS_INT values can be intermixed with them. | |
49 | That ensures they are all aligned normally. */ | |
efa4ce8b | 50 | |
bd601e2a KH |
51 | /* Name of this frame: a Lisp string. See also `explicit_name' |
52 | and `namebuf'. */ | |
efa4ce8b JB |
53 | Lisp_Object name; |
54 | ||
eb8c3be9 | 55 | /* The frame which should receive keystrokes that occur in this |
46a5c487 JB |
56 | frame, or nil if they should go to the frame itself. This is |
57 | usually nil, but if the frame is minibufferless, we can use this | |
58 | to redirect keystrokes to a surrogate minibuffer frame when | |
59 | needed. | |
60 | ||
61 | Note that a value of nil is different than having the field point | |
62 | to the frame itself. Whenever the Fselect_frame function is used | |
63 | to shift from one frame to the other, any redirections to the | |
64 | original frame are shifted to the newly selected frame; if | |
65 | focus_frame is nil, Fselect_frame will leave it alone. */ | |
ff11dfa1 | 66 | Lisp_Object focus_frame; |
0f79a4ae | 67 | |
ff11dfa1 JB |
68 | /* This frame's root window. Every frame has one. |
69 | If the frame has only a minibuffer window, this is it. | |
70 | Otherwise, if the frame has a minibuffer window, this is its sibling. */ | |
efa4ce8b JB |
71 | Lisp_Object root_window; |
72 | ||
ff11dfa1 JB |
73 | /* This frame's selected window. |
74 | Each frame has its own window hierarchy | |
75 | and one of the windows in it is selected within the frame. | |
76 | The selected window of the selected frame is Emacs's selected window. */ | |
efa4ce8b JB |
77 | Lisp_Object selected_window; |
78 | ||
ff11dfa1 JB |
79 | /* This frame's minibuffer window. |
80 | Most frames have their own minibuffer windows, | |
81 | but only the selected frame's minibuffer window | |
efa4ce8b JB |
82 | can actually appear to exist. */ |
83 | Lisp_Object minibuffer_window; | |
84 | ||
ff11dfa1 JB |
85 | /* Parameter alist of this frame. |
86 | These are the parameters specified when creating the frame | |
87 | or modified with modify-frame-parameters. */ | |
efa4ce8b JB |
88 | Lisp_Object param_alist; |
89 | ||
a3c87d4e | 90 | /* List of scroll bars on this frame. |
20a6c8d7 | 91 | Actually, we don't specify exactly what is stored here at all; the |
a3c87d4e | 92 | scroll bar implementation code can use it to store anything it likes. |
20a6c8d7 JB |
93 | This field is marked by the garbage collector. It is here |
94 | instead of in the `display' structure so that the garbage | |
95 | collector doesn't need to look inside the window-system-dependent | |
96 | structure. */ | |
a3c87d4e JB |
97 | Lisp_Object scroll_bars; |
98 | Lisp_Object condemned_scroll_bars; | |
20a6c8d7 | 99 | |
fb63ba7d RS |
100 | /* List of elements to display in the menu bar. |
101 | The elements have the form (KEY STRING . nil) to start; | |
102 | when they are displayed, the hpos of the left edge goes in the cddr. */ | |
6d05db81 RS |
103 | Lisp_Object menu_bar_items; |
104 | ||
fb63ba7d RS |
105 | /* Alist of elements (FACE-NAME . FACE-VECTOR-DATA). */ |
106 | Lisp_Object face_alist; | |
107 | ||
21015f9c RS |
108 | /* A vector that records the entire structure of this frame's menu bar. |
109 | For the format of the data, see extensive comments in xmenu.c. | |
110 | Only the X toolkit version uses this. */ | |
111 | Lisp_Object menu_bar_vector; | |
112 | /* Number of elements in the vector that have meaningful data. */ | |
113 | EMACS_INT menu_bar_items_used; | |
114 | ||
115 | /* Predicate for selecting buffers for other-buffer. */ | |
116 | Lisp_Object buffer_predicate; | |
117 | ||
118 | /* Beyond here, there should be no more Lisp_Object components. */ | |
119 | ||
120 | ||
bd601e2a KH |
121 | /* A buffer to hold the frame's name. We can't use the Lisp string's |
122 | pointer (`name', above) because it might get relocated. */ | |
123 | char *namebuf; | |
124 | ||
21015f9c RS |
125 | /* glyphs as they appear on the frame */ |
126 | struct frame_glyphs *current_glyphs; | |
127 | ||
128 | /* glyphs we'd like to appear on the frame */ | |
129 | struct frame_glyphs *desired_glyphs; | |
130 | ||
131 | /* See do_line_insertion_deletion_costs for info on these arrays. */ | |
132 | /* Cost of inserting 1 line on this frame */ | |
133 | int *insert_line_cost; | |
134 | /* Cost of deleting 1 line on this frame */ | |
135 | int *delete_line_cost; | |
136 | /* Cost of inserting n lines on this frame */ | |
137 | int *insert_n_lines_cost; | |
138 | /* Cost of deleting n lines on this frame */ | |
139 | int *delete_n_lines_cost; | |
140 | ||
141 | /* glyphs for the mode line */ | |
142 | struct frame_glyphs *temp_glyphs; | |
143 | ||
144 | /* Intended cursor position of this frame. | |
145 | Measured in characters, counting from upper left corner | |
146 | within the frame. */ | |
147 | int cursor_x; | |
148 | int cursor_y; | |
149 | ||
150 | /* Actual cursor position of this frame, and the character under it. | |
151 | (Not used for terminal frames.) */ | |
152 | int phys_cursor_x; | |
153 | int phys_cursor_y; | |
154 | /* This is handy for undrawing the cursor, because current_glyphs is | |
155 | not always accurate when in do_scrolling. */ | |
156 | GLYPH phys_cursor_glyph; | |
157 | ||
158 | /* Size of this frame, in units of characters. */ | |
159 | EMACS_INT height; | |
160 | EMACS_INT width; | |
161 | ||
162 | /* New height and width for pending size change. 0 if no change pending. */ | |
163 | int new_height, new_width; | |
164 | ||
ff11dfa1 | 165 | /* The output method says how the contents of this frame |
efa4ce8b JB |
166 | are displayed. It could be using termcap, or using an X window. */ |
167 | enum output_method output_method; | |
168 | ||
169 | /* A structure of auxiliary data used for displaying the contents. | |
ff11dfa1 | 170 | struct x_display is used for X window frames; |
efa4ce8b JB |
171 | it is defined in xterm.h. */ |
172 | union display { struct x_display *x; int nothing; } display; | |
173 | ||
37ea66e1 KH |
174 | #ifdef MULTI_KBOARD |
175 | /* A pointer to the kboard structure associated with this frame. | |
176 | For termcap frames, this points to initial_kboard. For X frames, | |
177 | it will be the same as display.x->display_info->kboard. */ | |
fadab1e3 | 178 | struct kboard *kboard; |
37ea66e1 KH |
179 | #endif |
180 | ||
6d05db81 RS |
181 | /* Number of lines of menu bar. */ |
182 | int menu_bar_lines; | |
183 | ||
9c95189b RS |
184 | #ifdef USE_X_TOOLKIT |
185 | /* Nonzero means using a menu bar that comes from the X toolkit. */ | |
186 | int external_menu_bar; | |
187 | #endif | |
188 | ||
ff11dfa1 | 189 | /* Nonzero if last attempt at redisplay on this frame was preempted. */ |
efa4ce8b JB |
190 | char display_preempted; |
191 | ||
a4659527 JB |
192 | /* visible is nonzero if the frame is currently displayed; we check |
193 | it to see if we should bother updating the frame's contents. | |
46a5c487 | 194 | DON'T SET IT DIRECTLY; instead, use FRAME_SET_VISIBLE. |
efa4ce8b | 195 | |
20a6c8d7 JB |
196 | Note that, since invisible frames aren't updated, whenever a |
197 | frame becomes visible again, it must be marked as garbaged. The | |
198 | FRAME_SAMPLE_VISIBILITY macro takes care of this. | |
199 | ||
a4659527 JB |
200 | iconified is nonzero if the frame is currently iconified. |
201 | ||
202 | Asynchronous input handlers should NOT change these directly; | |
203 | instead, they should change async_visible or async_iconified, and | |
204 | let the FRAME_SAMPLE_VISIBILITY macro set visible and iconified | |
205 | at the next redisplay. | |
206 | ||
207 | These should probably be considered read-only by everyone except | |
208 | FRAME_SAMPLE_VISIBILITY. | |
209 | ||
74cc2959 | 210 | These two are mutually exclusive. They might both be zero, if the |
a4659527 JB |
211 | frame has been made invisible without an icon. */ |
212 | char visible, iconified; | |
213 | ||
214 | /* Asynchronous input handlers change these, and | |
215 | FRAME_SAMPLE_VISIBILITY copies them into visible and iconified. | |
216 | See FRAME_SAMPLE_VISIBILITY, below. */ | |
217 | #ifdef __STDC__ | |
218 | volatile | |
219 | #endif | |
220 | char async_visible, async_iconified; | |
efa4ce8b | 221 | |
ff11dfa1 | 222 | /* Nonzero if this frame should be redrawn. */ |
a4659527 JB |
223 | #ifdef __STDC__ |
224 | volatile | |
225 | #endif | |
efa4ce8b JB |
226 | char garbaged; |
227 | ||
ff11dfa1 JB |
228 | /* True if frame actually has a minibuffer window on it. |
229 | 0 if using a minibuffer window that isn't on this frame. */ | |
efa4ce8b JB |
230 | char has_minibuffer; |
231 | ||
ff11dfa1 | 232 | /* 0 means, if this frame has just one window, |
efa4ce8b JB |
233 | show no modeline for that window. */ |
234 | char wants_modeline; | |
235 | ||
46a5c487 | 236 | /* Non-zero if the hardware device this frame is displaying on can |
a3c87d4e JB |
237 | support scroll bars. */ |
238 | char can_have_scroll_bars; | |
46a5c487 | 239 | |
a3c87d4e | 240 | /* If can_have_scroll_bars is non-zero, this is non-zero if we should |
46a5c487 | 241 | actually display them on this frame. */ |
a3c87d4e | 242 | char has_vertical_scroll_bars; |
46a5c487 | 243 | |
ff11dfa1 | 244 | /* Non-0 means raise this frame to the top of the heap when selected. */ |
efa4ce8b JB |
245 | char auto_raise; |
246 | ||
ff11dfa1 | 247 | /* Non-0 means lower this frame to the bottom of the stack when left. */ |
efa4ce8b JB |
248 | char auto_lower; |
249 | ||
ff11dfa1 | 250 | /* True if frame's root window can't be split. */ |
efa4ce8b JB |
251 | char no_split; |
252 | ||
fbfed6f0 JB |
253 | /* If this is set, then Emacs won't change the frame name to indicate |
254 | the current buffer, etcetera. If the user explicitly sets the frame | |
255 | name, this gets set. If the user sets the name to Qnil, this is | |
256 | cleared. */ | |
257 | char explicit_name; | |
258 | ||
adc12f0f RS |
259 | /* Nonzero if size of some window on this frame has changed. */ |
260 | char window_sizes_changed; | |
261 | ||
ff11dfa1 | 262 | /* Storage for messages to this frame. */ |
efa4ce8b JB |
263 | char *message_buf; |
264 | ||
265 | /* Nonnegative if current redisplay should not do scroll computation | |
266 | for lines beyond a certain vpos. This is the vpos. */ | |
267 | int scroll_bottom_vpos; | |
8d6de7ce | 268 | |
bf92a755 KH |
269 | /* Width of the scroll bar, in pixels and in characters. |
270 | scroll_bar_cols tracks scroll_bar_pixel_width if the latter is positive; | |
271 | a zero value in scroll_bar_pixel_width means to compute the actual width | |
272 | on the fly, using scroll_bar_cols and the current font width. */ | |
4361366b KH |
273 | int scroll_bar_pixel_width; |
274 | int scroll_bar_cols; | |
95b999aa RS |
275 | |
276 | /* The baud rate that was used to calculate costs for this frame. */ | |
277 | int cost_calculation_baud_rate; | |
efa4ce8b JB |
278 | }; |
279 | ||
37ea66e1 KH |
280 | #ifdef MULTI_KBOARD /* Note that MULTI_KBOARD implies MULTI_FRAME */ |
281 | #define FRAME_KBOARD(f) ((f)->kboard) | |
282 | #else | |
283 | #define FRAME_KBOARD(f) (&the_only_kboard) | |
284 | #endif | |
285 | ||
ff11dfa1 JB |
286 | #ifdef MULTI_FRAME |
287 | ||
288 | typedef struct frame *FRAME_PTR; | |
289 | ||
290 | #define XFRAME(p) ((struct frame *) XPNTR (p)) | |
aac03cca | 291 | #define XSETFRAME(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_FRAME)) |
ff11dfa1 JB |
292 | |
293 | #define WINDOW_FRAME(w) (w)->frame | |
294 | ||
ff11dfa1 | 295 | #define FRAME_LIVE_P(f) ((f)->display.nothing != 0) |
10a4cc63 JB |
296 | #define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap) |
297 | #define FRAME_X_P(f) ((f)->output_method == output_x_window) | |
ff11dfa1 JB |
298 | #define FRAME_MINIBUF_ONLY_P(f) \ |
299 | EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f)) | |
10a4cc63 | 300 | #define FRAME_HAS_MINIBUF_P(f) ((f)->has_minibuffer) |
ff11dfa1 JB |
301 | #define FRAME_CURRENT_GLYPHS(f) (f)->current_glyphs |
302 | #define FRAME_DESIRED_GLYPHS(f) (f)->desired_glyphs | |
303 | #define FRAME_TEMP_GLYPHS(f) (f)->temp_glyphs | |
304 | #define FRAME_HEIGHT(f) (f)->height | |
305 | #define FRAME_WIDTH(f) (f)->width | |
306 | #define FRAME_NEW_HEIGHT(f) (f)->new_height | |
307 | #define FRAME_NEW_WIDTH(f) (f)->new_width | |
6d05db81 | 308 | #define FRAME_MENU_BAR_LINES(f) (f)->menu_bar_lines |
4c8888a0 | 309 | #ifdef USE_X_TOOLKIT |
9c95189b | 310 | #define FRAME_EXTERNAL_MENU_BAR(f) (f)->external_menu_bar |
4c8888a0 RS |
311 | #else |
312 | #define FRAME_EXTERNAL_MENU_BAR(f) 0 | |
313 | #endif | |
ff11dfa1 JB |
314 | #define FRAME_CURSOR_X(f) (f)->cursor_x |
315 | #define FRAME_CURSOR_Y(f) (f)->cursor_y | |
46a5c487 JB |
316 | #define FRAME_VISIBLE_P(f) ((f)->visible != 0) |
317 | #define FRAME_SET_VISIBLE(f,p) \ | |
318 | ((f)->async_visible = (p), FRAME_SAMPLE_VISIBILITY (f)) | |
ff11dfa1 JB |
319 | #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1, f->garbaged = 1) |
320 | #define FRAME_GARBAGED_P(f) (f)->garbaged | |
321 | #define FRAME_NO_SPLIT_P(f) (f)->no_split | |
322 | #define FRAME_WANTS_MODELINE_P(f) (f)->wants_modeline | |
323 | #define FRAME_ICONIFIED_P(f) (f)->iconified | |
adc12f0f | 324 | #define FRAME_WINDOW_SIZES_CHANGED(f) (f)->window_sizes_changed |
ff11dfa1 JB |
325 | #define FRAME_MINIBUF_WINDOW(f) (f)->minibuffer_window |
326 | #define FRAME_ROOT_WINDOW(f) (f)->root_window | |
327 | #define FRAME_SELECTED_WINDOW(f) (f)->selected_window | |
328 | #define SET_GLYPHS_FRAME(glyphs,frame) ((glyphs)->frame = (frame)) | |
329 | #define FRAME_INSERT_COST(f) (f)->insert_line_cost | |
330 | #define FRAME_DELETE_COST(f) (f)->delete_line_cost | |
331 | #define FRAME_INSERTN_COST(f) (f)->insert_n_lines_cost | |
332 | #define FRAME_DELETEN_COST(f) (f)->delete_n_lines_cost | |
333 | #define FRAME_MESSAGE_BUF(f) (f)->message_buf | |
334 | #define FRAME_SCROLL_BOTTOM_VPOS(f) (f)->scroll_bottom_vpos | |
335 | #define FRAME_FOCUS_FRAME(f) (f)->focus_frame | |
a3c87d4e JB |
336 | #define FRAME_CAN_HAVE_SCROLL_BARS(f) ((f)->can_have_scroll_bars) |
337 | #define FRAME_HAS_VERTICAL_SCROLL_BARS(f) ((f)->has_vertical_scroll_bars) | |
4361366b KH |
338 | #define FRAME_SCROLL_BAR_PIXEL_WIDTH(f) ((f)->scroll_bar_pixel_width) |
339 | #define FRAME_SCROLL_BAR_COLS(f) ((f)->scroll_bar_cols) | |
a3c87d4e JB |
340 | #define FRAME_SCROLL_BARS(f) ((f)->scroll_bars) |
341 | #define FRAME_CONDEMNED_SCROLL_BARS(f) ((f)->condemned_scroll_bars) | |
6d05db81 | 342 | #define FRAME_MENU_BAR_ITEMS(f) ((f)->menu_bar_items) |
95b999aa | 343 | #define FRAME_COST_BAUD_RATE(f) ((f)->cost_calculation_baud_rate) |
ff11dfa1 | 344 | |
a4659527 JB |
345 | /* Emacs's redisplay code could become confused if a frame's |
346 | visibility changes at arbitrary times. For example, if a frame is | |
347 | visible while the desired glyphs are being built, but becomes | |
348 | invisible before they are updated, then some rows of the | |
349 | desired_glyphs will be left marked as enabled after redisplay is | |
350 | complete, which should never happen. The next time the frame | |
351 | becomes visible, redisplay will probably barf. | |
352 | ||
353 | Currently, there are no similar situations involving iconified, but | |
354 | the principle is the same. | |
355 | ||
356 | So instead of having asynchronous input handlers directly set and | |
357 | clear the frame's visibility and iconification flags, they just set | |
358 | the async_visible and async_iconified flags; the redisplay code | |
359 | calls the FRAME_SAMPLE_VISIBILITY macro before doing any redisplay, | |
360 | which sets visible and iconified from their asynchronous | |
46a5c487 JB |
361 | counterparts. |
362 | ||
20a6c8d7 JB |
363 | Synchronous code must use the FRAME_SET_VISIBLE macro. |
364 | ||
365 | Also, if a frame used to be invisible, but has just become visible, | |
366 | it must be marked as garbaged, since redisplay hasn't been keeping | |
367 | up its contents. */ | |
a4659527 | 368 | #define FRAME_SAMPLE_VISIBILITY(f) \ |
20a6c8d7 JB |
369 | (((f)->async_visible && ! (f)->visible) ? SET_FRAME_GARBAGED (f) : 0, \ |
370 | (f)->visible = (f)->async_visible, \ | |
a4659527 JB |
371 | (f)->iconified = (f)->async_iconified) |
372 | ||
ff11dfa1 | 373 | #define CHECK_FRAME(x, i) \ |
265a9e55 | 374 | { \ |
ff11dfa1 JB |
375 | if (! FRAMEP (x)) \ |
376 | x = wrong_type_argument (Qframep, (x)); \ | |
265a9e55 JB |
377 | } |
378 | ||
ff11dfa1 | 379 | #define CHECK_LIVE_FRAME(x, i) \ |
265a9e55 | 380 | { \ |
ff11dfa1 JB |
381 | if (! FRAMEP (x) \ |
382 | || ! FRAME_LIVE_P (XFRAME (x))) \ | |
dbc4e1c1 | 383 | x = wrong_type_argument (Qframe_live_p, (x)); \ |
265a9e55 JB |
384 | } |
385 | ||
ff11dfa1 JB |
386 | /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a |
387 | `for' loop which iterates over the elements of Vframe_list. The | |
35f56f96 | 388 | loop will set FRAME_VAR, a Lisp_Object, to each frame in |
ff11dfa1 | 389 | Vframe_list in succession and execute the statement. LIST_VAR |
35f56f96 | 390 | should be a Lisp_Object too; it is used to iterate through the |
ff11dfa1 | 391 | Vframe_list. |
e5d77022 | 392 | |
ff11dfa1 | 393 | If MULTI_FRAME isn't defined, then this loop expands to something which |
e5d77022 | 394 | executes the statement once. */ |
ff11dfa1 JB |
395 | #define FOR_EACH_FRAME(list_var, frame_var) \ |
396 | for ((list_var) = Vframe_list; \ | |
e5d77022 | 397 | (CONSP (list_var) \ |
35f56f96 | 398 | && (frame_var = XCONS (list_var)->car, 1)); \ |
e5d77022 JB |
399 | list_var = XCONS (list_var)->cdr) |
400 | ||
401 | ||
870b25a2 | 402 | extern Lisp_Object Qframep, Qframe_live_p, Qicon; |
efa4ce8b | 403 | |
ff11dfa1 JB |
404 | extern struct frame *selected_frame; |
405 | extern struct frame *last_nonminibuf_frame; | |
efa4ce8b | 406 | |
ff11dfa1 JB |
407 | extern struct frame *make_terminal_frame (); |
408 | extern struct frame *make_frame (); | |
409 | extern struct frame *make_minibuffer_frame (); | |
410 | extern struct frame *make_frame_without_minibuffer (); | |
efa4ce8b | 411 | |
ff11dfa1 JB |
412 | extern Lisp_Object Vframe_list; |
413 | extern Lisp_Object Vdefault_frame_alist; | |
efa4ce8b | 414 | |
ff11dfa1 | 415 | extern Lisp_Object Vterminal_frame; |
efa4ce8b | 416 | \f |
ff11dfa1 | 417 | #else /* not MULTI_FRAME */ |
efa4ce8b | 418 | |
ff11dfa1 | 419 | /* These definitions are used in a single-frame version of Emacs. */ |
efa4ce8b | 420 | |
ce4e9d43 JB |
421 | /* A frame we use to store all the data concerning the screen when we |
422 | don't have multiple frames. Remember, if you store any data in it | |
423 | which needs to be protected from GC, you should staticpro that | |
424 | element explicitly. */ | |
ff11dfa1 | 425 | extern struct frame the_only_frame; |
e5d77022 | 426 | |
87485d6f MW |
427 | typedef struct frame *FRAME_PTR; |
428 | #ifdef __GNUC__ | |
429 | /* A function call for always getting 0 is overkill, so... */ | |
430 | #define WINDOW_FRAME(w) ({ Lisp_Object tem; XSETFASTINT (tem, 0); tem; }) | |
431 | #else | |
432 | #define WINDOW_FRAME(w) (Fselected_frame ()) | |
433 | #endif | |
434 | #define XSETFRAME(p, v) (p = WINDOW_FRAME (***bogus***)) | |
435 | #define XFRAME(frame) (&the_only_frame) | |
e5d77022 | 436 | |
87485d6f MW |
437 | extern FRAME_PTR selected_frame; |
438 | extern FRAME_PTR last_nonminibuf_frame; | |
ff11dfa1 | 439 | |
ff11dfa1 | 440 | #define FRAME_LIVE_P(f) 1 |
87485d6f MW |
441 | #ifdef MSDOS |
442 | /* The following definitions could also be used in the non-MSDOS case, | |
443 | but the constants below lead to better code. */ | |
444 | #define FRAME_TERMCAP_P(f) (the_only_frame.output_method == output_termcap) | |
445 | #define FRAME_X_P(f) (the_only_frame.output_method != output_termcap) | |
446 | #else | |
10a4cc63 JB |
447 | #define FRAME_TERMCAP_P(f) 1 |
448 | #define FRAME_X_P(f) 0 | |
87485d6f | 449 | #endif |
ff11dfa1 | 450 | #define FRAME_MINIBUF_ONLY_P(f) 0 |
10a4cc63 | 451 | #define FRAME_HAS_MINIBUF_P(f) 1 |
ce4e9d43 JB |
452 | #define FRAME_CURRENT_GLYPHS(f) (the_only_frame.current_glyphs) |
453 | #define FRAME_DESIRED_GLYPHS(f) (the_only_frame.desired_glyphs) | |
454 | #define FRAME_TEMP_GLYPHS(f) (the_only_frame.temp_glyphs) | |
455 | #define FRAME_HEIGHT(f) (the_only_frame.height) | |
456 | #define FRAME_WIDTH(f) (the_only_frame.width) | |
457 | #define FRAME_NEW_HEIGHT(f) (the_only_frame.new_height) | |
458 | #define FRAME_NEW_WIDTH(f) (the_only_frame.new_width) | |
6d05db81 | 459 | #define FRAME_MENU_BAR_LINES(f) (the_only_frame.menu_bar_lines) |
ce4e9d43 JB |
460 | #define FRAME_CURSOR_X(f) (the_only_frame.cursor_x) |
461 | #define FRAME_CURSOR_Y(f) (the_only_frame.cursor_y) | |
46a5c487 | 462 | #define FRAME_SET_VISIBLE(f,p) (p) |
ff11dfa1 JB |
463 | #define FRAME_VISIBLE_P(f) 1 |
464 | #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1) | |
ce4e9d43 | 465 | #define FRAME_GARBAGED_P(f) (frame_garbaged) |
ff11dfa1 JB |
466 | #define FRAME_NO_SPLIT_P(f) 0 |
467 | #define FRAME_WANTS_MODELINE_P(f) 1 | |
468 | #define FRAME_ICONIFIED_P(f) 0 | |
adc12f0f | 469 | #define FRAME_WINDOW_SIZES_CHANGED(f) the_only_frame.window_sizes_changed |
0a94d04e | 470 | #define FRAME_MINIBUF_WINDOW(f) (minibuf_window) |
fbfed6f0 | 471 | #define FRAME_ROOT_WINDOW(f) (the_only_frame.root_window) |
ce4e9d43 JB |
472 | #define FRAME_SELECTED_WINDOW(f) (selected_window) |
473 | #define SET_GLYPHS_FRAME(glyphs,frame) do ; while (0) | |
474 | #define FRAME_INSERT_COST(frame) (the_only_frame.insert_line_cost) | |
475 | #define FRAME_DELETE_COST(frame) (the_only_frame.delete_line_cost) | |
476 | #define FRAME_INSERTN_COST(frame) (the_only_frame.insert_n_lines_cost) | |
477 | #define FRAME_DELETEN_COST(frame) (the_only_frame.delete_n_lines_cost) | |
478 | #define FRAME_MESSAGE_BUF(f) (the_only_frame.message_buf) | |
479 | #define FRAME_SCROLL_BOTTOM_VPOS(f) (the_only_frame.scroll_bottom_vpos) | |
46a5c487 | 480 | #define FRAME_FOCUS_FRAME(f) (Qnil) |
a3c87d4e JB |
481 | #define FRAME_CAN_HAVE_SCROLL_BARS(f) (the_only_frame.can_have_scroll_bars) |
482 | #define FRAME_HAS_VERTICAL_SCROLL_BARS(f) \ | |
483 | (the_only_frame.has_vertical_scroll_bars) | |
4361366b KH |
484 | #define FRAME_SCROLL_BAR_PIXEL_WIDTH(f) (the_only_frame.scroll_bar_pixel_width) |
485 | #define FRAME_SCROLL_BAR_COLS(f) (the_only_frame.scroll_bar_cols) | |
a3c87d4e JB |
486 | #define FRAME_SCROLL_BARS(f) (the_only_frame.scroll_bars) |
487 | #define FRAME_CONDEMNED_SCROLL_BARS(f) (the_only_frame.condemned_scroll_bars) | |
6d05db81 | 488 | #define FRAME_MENU_BAR_ITEMS(f) (the_only_frame.menu_bar_items) |
95b999aa | 489 | #define FRAME_COST_BAUD_RATE(f) (the_only_frame.cost_calculation_baud_rate) |
ff11dfa1 | 490 | |
a4659527 JB |
491 | /* See comments in definition above. */ |
492 | #define FRAME_SAMPLE_VISIBILITY(f) (0) | |
493 | ||
10a4cc63 JB |
494 | #define CHECK_FRAME(x, i) do; while (0) |
495 | #define CHECK_LIVE_FRAME(x, y) do; while (0) | |
ff11dfa1 JB |
496 | |
497 | /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a | |
498 | `for' loop which iterates over the elements of Vframe_list. The | |
35f56f96 | 499 | loop will set FRAME_VAR, a Lisp_Object, to each frame in |
ff11dfa1 | 500 | Vframe_list in succession and execute the statement. LIST_VAR |
35f56f96 | 501 | should be a Lisp_Object too; it is used to iterate through the |
ff11dfa1 | 502 | Vframe_list. |
e5d77022 | 503 | |
ff11dfa1 JB |
504 | If MULTI_FRAME _is_ defined, then this loop expands to a real |
505 | `for' loop which traverses Vframe_list using LIST_VAR and | |
506 | FRAME_VAR. */ | |
507 | #define FOR_EACH_FRAME(list_var, frame_var) \ | |
87485d6f | 508 | for (list_var = Qt; frame_var = WINDOW_FRAME (***bogus***), ! NILP (list_var); list_var = Qnil) |
efa4ce8b | 509 | |
ff11dfa1 | 510 | #endif /* not MULTI_FRAME */ |
46a5c487 JB |
511 | |
512 | \f | |
a3c87d4e | 513 | /* Device- and MULTI_FRAME-independent scroll bar stuff. */ |
46a5c487 | 514 | |
a3c87d4e | 515 | /* Return the starting column (zero-based) of the vertical scroll bar |
46a5c487 JB |
516 | for window W. The column before this one is the last column we can |
517 | use for text. If the window touches the right edge of the frame, | |
a3c87d4e | 518 | we have extra space allocated for it. Otherwise, the scroll bar |
46a5c487 | 519 | takes over the window's rightmost columns. */ |
a3c87d4e | 520 | #define WINDOW_VERTICAL_SCROLL_BAR_COLUMN(w) \ |
46a5c487 JB |
521 | (((XINT ((w)->left) + XINT ((w)->width)) \ |
522 | < FRAME_WIDTH (XFRAME (WINDOW_FRAME (w)))) \ | |
4361366b KH |
523 | ? (XINT ((w)->left) + XINT ((w)->width) \ |
524 | - FRAME_SCROLL_BAR_COLS (XFRAME (WINDOW_FRAME (w)))) \ | |
46a5c487 JB |
525 | : FRAME_WIDTH (XFRAME (WINDOW_FRAME (w)))) |
526 | ||
a3c87d4e JB |
527 | /* Return the height in lines of the vertical scroll bar in w. If the |
528 | window has a mode line, don't make the scroll bar extend that far. */ | |
529 | #define WINDOW_VERTICAL_SCROLL_BAR_HEIGHT(w) (window_internal_height (w)) |