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 | |
3b7ad313 EN |
18 | the Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
19 | Boston, MA 02111-1307, USA. */ | |
efa4ce8b | 20 | |
20a6c8d7 JB |
21 | \f |
22 | /* Miscellanea. */ | |
23 | ||
24 | /* Nonzero means don't assume anything about current | |
25 | contents of actual terminal frame */ | |
26 | extern int frame_garbaged; | |
27 | ||
28 | /* Nonzero means FRAME_MESSAGE_BUF (selected_frame) is being used by | |
29 | print. */ | |
30 | extern int message_buf_print; | |
efa4ce8b | 31 | |
20a6c8d7 | 32 | \f |
e3678b64 | 33 | /* The structure representing a frame. */ |
efa4ce8b JB |
34 | |
35 | enum output_method | |
fbd6baed | 36 | { output_termcap, output_x_window, output_msdos_raw, output_w32 }; |
efa4ce8b | 37 | |
a3211441 RS |
38 | enum vertical_scroll_bar_type |
39 | { vertical_scroll_bar_none, vertical_scroll_bar_left, vertical_scroll_bar_right }; | |
40 | ||
ff11dfa1 | 41 | struct frame |
efa4ce8b | 42 | { |
0c38c2f9 | 43 | EMACS_INT size; |
efa4ce8b JB |
44 | struct Lisp_Vector *next; |
45 | ||
21015f9c RS |
46 | /* All Lisp_Object components must come first. |
47 | Only EMACS_INT values can be intermixed with them. | |
48 | That ensures they are all aligned normally. */ | |
efa4ce8b | 49 | |
fa5d1baa RS |
50 | /* Name of this frame: a Lisp string. It is used for looking up resources, |
51 | as well as for the title in some cases. */ | |
efa4ce8b JB |
52 | Lisp_Object name; |
53 | ||
e7f79a67 RS |
54 | /* The name to use for the icon, the last time |
55 | it was refreshed. nil means not explicitly specified. */ | |
56 | Lisp_Object icon_name; | |
57 | ||
fa5d1baa RS |
58 | /* This is the frame title specified explicitly, if any. |
59 | Usually it is nil. */ | |
60 | Lisp_Object title; | |
61 | ||
eb8c3be9 | 62 | /* The frame which should receive keystrokes that occur in this |
46a5c487 JB |
63 | frame, or nil if they should go to the frame itself. This is |
64 | usually nil, but if the frame is minibufferless, we can use this | |
65 | to redirect keystrokes to a surrogate minibuffer frame when | |
66 | needed. | |
67 | ||
68 | Note that a value of nil is different than having the field point | |
69 | to the frame itself. Whenever the Fselect_frame function is used | |
70 | to shift from one frame to the other, any redirections to the | |
71 | original frame are shifted to the newly selected frame; if | |
72 | focus_frame is nil, Fselect_frame will leave it alone. */ | |
ff11dfa1 | 73 | Lisp_Object focus_frame; |
0f79a4ae | 74 | |
ff11dfa1 JB |
75 | /* This frame's root window. Every frame has one. |
76 | If the frame has only a minibuffer window, this is it. | |
77 | Otherwise, if the frame has a minibuffer window, this is its sibling. */ | |
efa4ce8b JB |
78 | Lisp_Object root_window; |
79 | ||
ff11dfa1 JB |
80 | /* This frame's selected window. |
81 | Each frame has its own window hierarchy | |
82 | and one of the windows in it is selected within the frame. | |
83 | The selected window of the selected frame is Emacs's selected window. */ | |
efa4ce8b JB |
84 | Lisp_Object selected_window; |
85 | ||
ff11dfa1 JB |
86 | /* This frame's minibuffer window. |
87 | Most frames have their own minibuffer windows, | |
88 | but only the selected frame's minibuffer window | |
efa4ce8b JB |
89 | can actually appear to exist. */ |
90 | Lisp_Object minibuffer_window; | |
91 | ||
ff11dfa1 JB |
92 | /* Parameter alist of this frame. |
93 | These are the parameters specified when creating the frame | |
94 | or modified with modify-frame-parameters. */ | |
efa4ce8b JB |
95 | Lisp_Object param_alist; |
96 | ||
a3c87d4e | 97 | /* List of scroll bars on this frame. |
20a6c8d7 | 98 | Actually, we don't specify exactly what is stored here at all; the |
a3c87d4e | 99 | scroll bar implementation code can use it to store anything it likes. |
20a6c8d7 JB |
100 | This field is marked by the garbage collector. It is here |
101 | instead of in the `display' structure so that the garbage | |
102 | collector doesn't need to look inside the window-system-dependent | |
103 | structure. */ | |
a3c87d4e JB |
104 | Lisp_Object scroll_bars; |
105 | Lisp_Object condemned_scroll_bars; | |
20a6c8d7 | 106 | |
ad6cd733 RS |
107 | /* Vector describing the items to display in the menu bar. |
108 | Each item has four elements in this vector. | |
109 | They are KEY, STRING, SUBMAP, and HPOS. | |
110 | (HPOS is not used in when the X toolkit is in use.) | |
111 | There are four additional elements of nil at the end, to terminate. */ | |
6d05db81 RS |
112 | Lisp_Object menu_bar_items; |
113 | ||
fb63ba7d RS |
114 | /* Alist of elements (FACE-NAME . FACE-VECTOR-DATA). */ |
115 | Lisp_Object face_alist; | |
116 | ||
21015f9c RS |
117 | /* A vector that records the entire structure of this frame's menu bar. |
118 | For the format of the data, see extensive comments in xmenu.c. | |
119 | Only the X toolkit version uses this. */ | |
120 | Lisp_Object menu_bar_vector; | |
121 | /* Number of elements in the vector that have meaningful data. */ | |
122 | EMACS_INT menu_bar_items_used; | |
123 | ||
124 | /* Predicate for selecting buffers for other-buffer. */ | |
125 | Lisp_Object buffer_predicate; | |
126 | ||
375ff4f1 RS |
127 | /* List of buffers viewed in this frame, for other-buffer. */ |
128 | Lisp_Object buffer_list; | |
129 | ||
130 | /* beyond here, there should be no more Lisp_Object components. */ | |
21015f9c RS |
131 | |
132 | ||
bd601e2a KH |
133 | /* A buffer to hold the frame's name. We can't use the Lisp string's |
134 | pointer (`name', above) because it might get relocated. */ | |
135 | char *namebuf; | |
136 | ||
21015f9c RS |
137 | /* glyphs as they appear on the frame */ |
138 | struct frame_glyphs *current_glyphs; | |
139 | ||
140 | /* glyphs we'd like to appear on the frame */ | |
141 | struct frame_glyphs *desired_glyphs; | |
142 | ||
143 | /* See do_line_insertion_deletion_costs for info on these arrays. */ | |
144 | /* Cost of inserting 1 line on this frame */ | |
145 | int *insert_line_cost; | |
146 | /* Cost of deleting 1 line on this frame */ | |
147 | int *delete_line_cost; | |
148 | /* Cost of inserting n lines on this frame */ | |
149 | int *insert_n_lines_cost; | |
150 | /* Cost of deleting n lines on this frame */ | |
151 | int *delete_n_lines_cost; | |
152 | ||
153 | /* glyphs for the mode line */ | |
154 | struct frame_glyphs *temp_glyphs; | |
155 | ||
156 | /* Intended cursor position of this frame. | |
157 | Measured in characters, counting from upper left corner | |
158 | within the frame. */ | |
159 | int cursor_x; | |
160 | int cursor_y; | |
161 | ||
162 | /* Actual cursor position of this frame, and the character under it. | |
163 | (Not used for terminal frames.) */ | |
164 | int phys_cursor_x; | |
165 | int phys_cursor_y; | |
166 | /* This is handy for undrawing the cursor, because current_glyphs is | |
167 | not always accurate when in do_scrolling. */ | |
168 | GLYPH phys_cursor_glyph; | |
e85276be RS |
169 | /* Nonzero means the cursor is displayed. */ |
170 | int phys_cursor_on; | |
21015f9c RS |
171 | |
172 | /* Size of this frame, in units of characters. */ | |
173 | EMACS_INT height; | |
174 | EMACS_INT width; | |
163b385a | 175 | EMACS_INT window_width; |
21015f9c RS |
176 | |
177 | /* New height and width for pending size change. 0 if no change pending. */ | |
178 | int new_height, new_width; | |
179 | ||
ff11dfa1 | 180 | /* The output method says how the contents of this frame |
efa4ce8b JB |
181 | are displayed. It could be using termcap, or using an X window. */ |
182 | enum output_method output_method; | |
183 | ||
184 | /* A structure of auxiliary data used for displaying the contents. | |
785ee691 | 185 | struct x_output is used for X window frames; |
efa7f0f9 | 186 | it is defined in xterm.h. |
fbd6baed | 187 | struct w32_output is used for W32 window frames; |
efa7f0f9 | 188 | it is defined in w32term.h. */ |
fbd6baed | 189 | union output_data { struct x_output *x; struct w32_output *w32; int nothing; } output_data; |
efa4ce8b | 190 | |
37ea66e1 KH |
191 | #ifdef MULTI_KBOARD |
192 | /* A pointer to the kboard structure associated with this frame. | |
193 | For termcap frames, this points to initial_kboard. For X frames, | |
194 | it will be the same as display.x->display_info->kboard. */ | |
fadab1e3 | 195 | struct kboard *kboard; |
37ea66e1 KH |
196 | #endif |
197 | ||
6d05db81 RS |
198 | /* Number of lines of menu bar. */ |
199 | int menu_bar_lines; | |
200 | ||
efa7f0f9 | 201 | #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) |
9c95189b RS |
202 | /* Nonzero means using a menu bar that comes from the X toolkit. */ |
203 | int external_menu_bar; | |
204 | #endif | |
205 | ||
ff11dfa1 | 206 | /* Nonzero if last attempt at redisplay on this frame was preempted. */ |
efa4ce8b JB |
207 | char display_preempted; |
208 | ||
a4659527 JB |
209 | /* visible is nonzero if the frame is currently displayed; we check |
210 | it to see if we should bother updating the frame's contents. | |
46a5c487 | 211 | DON'T SET IT DIRECTLY; instead, use FRAME_SET_VISIBLE. |
efa4ce8b | 212 | |
20a6c8d7 JB |
213 | Note that, since invisible frames aren't updated, whenever a |
214 | frame becomes visible again, it must be marked as garbaged. The | |
215 | FRAME_SAMPLE_VISIBILITY macro takes care of this. | |
216 | ||
0969b893 GV |
217 | On Windows NT/9X, to avoid wasting effort updating visible frames |
218 | that are actually completely obscured by other windows on the | |
219 | display, we bend the meaning of visible slightly: if greater than | |
220 | 1, then the frame is obscured - we still consider it to be | |
221 | "visible" as seen from lisp, but we don't bother updating it. We | |
222 | must take care to garbage the frame when it ceaces to be obscured | |
223 | though. Note that these semantics are only used on NT/9X. | |
224 | ||
a4659527 JB |
225 | iconified is nonzero if the frame is currently iconified. |
226 | ||
227 | Asynchronous input handlers should NOT change these directly; | |
228 | instead, they should change async_visible or async_iconified, and | |
229 | let the FRAME_SAMPLE_VISIBILITY macro set visible and iconified | |
230 | at the next redisplay. | |
231 | ||
232 | These should probably be considered read-only by everyone except | |
233 | FRAME_SAMPLE_VISIBILITY. | |
234 | ||
74cc2959 | 235 | These two are mutually exclusive. They might both be zero, if the |
a4659527 JB |
236 | frame has been made invisible without an icon. */ |
237 | char visible, iconified; | |
238 | ||
239 | /* Asynchronous input handlers change these, and | |
240 | FRAME_SAMPLE_VISIBILITY copies them into visible and iconified. | |
241 | See FRAME_SAMPLE_VISIBILITY, below. */ | |
242 | #ifdef __STDC__ | |
243 | volatile | |
244 | #endif | |
245 | char async_visible, async_iconified; | |
efa4ce8b | 246 | |
ff11dfa1 | 247 | /* Nonzero if this frame should be redrawn. */ |
a4659527 JB |
248 | #ifdef __STDC__ |
249 | volatile | |
250 | #endif | |
efa4ce8b JB |
251 | char garbaged; |
252 | ||
ff11dfa1 JB |
253 | /* True if frame actually has a minibuffer window on it. |
254 | 0 if using a minibuffer window that isn't on this frame. */ | |
efa4ce8b JB |
255 | char has_minibuffer; |
256 | ||
ff11dfa1 | 257 | /* 0 means, if this frame has just one window, |
efa4ce8b JB |
258 | show no modeline for that window. */ |
259 | char wants_modeline; | |
260 | ||
46a5c487 | 261 | /* Non-zero if the hardware device this frame is displaying on can |
a3c87d4e JB |
262 | support scroll bars. */ |
263 | char can_have_scroll_bars; | |
46a5c487 | 264 | |
a3c87d4e | 265 | /* If can_have_scroll_bars is non-zero, this is non-zero if we should |
46a5c487 | 266 | actually display them on this frame. */ |
a3211441 | 267 | enum vertical_scroll_bar_type vertical_scroll_bar_type; |
46a5c487 | 268 | |
ff11dfa1 | 269 | /* Non-0 means raise this frame to the top of the heap when selected. */ |
efa4ce8b JB |
270 | char auto_raise; |
271 | ||
ff11dfa1 | 272 | /* Non-0 means lower this frame to the bottom of the stack when left. */ |
efa4ce8b JB |
273 | char auto_lower; |
274 | ||
ff11dfa1 | 275 | /* True if frame's root window can't be split. */ |
efa4ce8b JB |
276 | char no_split; |
277 | ||
fbfed6f0 JB |
278 | /* If this is set, then Emacs won't change the frame name to indicate |
279 | the current buffer, etcetera. If the user explicitly sets the frame | |
280 | name, this gets set. If the user sets the name to Qnil, this is | |
281 | cleared. */ | |
282 | char explicit_name; | |
283 | ||
adc12f0f RS |
284 | /* Nonzero if size of some window on this frame has changed. */ |
285 | char window_sizes_changed; | |
286 | ||
ff11dfa1 | 287 | /* Storage for messages to this frame. */ |
efa4ce8b JB |
288 | char *message_buf; |
289 | ||
290 | /* Nonnegative if current redisplay should not do scroll computation | |
291 | for lines beyond a certain vpos. This is the vpos. */ | |
292 | int scroll_bottom_vpos; | |
8d6de7ce | 293 | |
bf92a755 KH |
294 | /* Width of the scroll bar, in pixels and in characters. |
295 | scroll_bar_cols tracks scroll_bar_pixel_width if the latter is positive; | |
296 | a zero value in scroll_bar_pixel_width means to compute the actual width | |
297 | on the fly, using scroll_bar_cols and the current font width. */ | |
4361366b KH |
298 | int scroll_bar_pixel_width; |
299 | int scroll_bar_cols; | |
95b999aa RS |
300 | |
301 | /* The baud rate that was used to calculate costs for this frame. */ | |
302 | int cost_calculation_baud_rate; | |
6462918c | 303 | |
81d00831 KH |
304 | /* A pointer to the data structure containing all information of |
305 | fontsets associated with this frame. See the comments in | |
306 | fontset.h for more detail. */ | |
307 | struct fontset_data *fontset_data; | |
308 | ||
6462918c KH |
309 | /* Nonzero if the mouse has moved on this display |
310 | since the last time we checked. */ | |
311 | char mouse_moved; | |
efa4ce8b JB |
312 | }; |
313 | ||
e3678b64 | 314 | #ifdef MULTI_KBOARD |
37ea66e1 KH |
315 | #define FRAME_KBOARD(f) ((f)->kboard) |
316 | #else | |
317 | #define FRAME_KBOARD(f) (&the_only_kboard) | |
318 | #endif | |
319 | ||
ff11dfa1 JB |
320 | typedef struct frame *FRAME_PTR; |
321 | ||
322 | #define XFRAME(p) ((struct frame *) XPNTR (p)) | |
aac03cca | 323 | #define XSETFRAME(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_FRAME)) |
ff11dfa1 | 324 | |
cea6021b | 325 | /* Given a window, return its frame as a Lisp_Object. */ |
ff11dfa1 JB |
326 | #define WINDOW_FRAME(w) (w)->frame |
327 | ||
cea6021b RS |
328 | /* Test a frame for particular kinds of display methods. */ |
329 | #define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap) | |
efa7f0f9 | 330 | #define FRAME_X_P(f) ((f)->output_method == output_x_window) |
fbd6baed | 331 | #define FRAME_W32_P(f) ((f)->output_method == output_w32) |
6f181713 | 332 | #define FRAME_MSDOS_P(f) ((f)->output_method == output_msdos_raw) |
efa7f0f9 GV |
333 | |
334 | /* FRAME_WINDOW_P tests whether the frame is a window, and is | |
335 | defined to be the predicate for the window system being used. */ | |
336 | #ifdef HAVE_X_WINDOWS | |
337 | #define FRAME_WINDOW_P(f) FRAME_X_P (f) | |
338 | #endif | |
339 | #ifdef HAVE_NTGUI | |
fbd6baed | 340 | #define FRAME_WINDOW_P(f) FRAME_W32_P (f) |
efa7f0f9 | 341 | #endif |
7651b07e RS |
342 | #ifndef FRAME_WINDOW_P |
343 | #define FRAME_WINDOW_P(f) (0) | |
344 | #endif | |
efa7f0f9 | 345 | |
cea6021b | 346 | /* Nonzero if frame F is still alive (not deleted). */ |
785ee691 | 347 | #define FRAME_LIVE_P(f) ((f)->output_data.nothing != 0) |
cea6021b RS |
348 | |
349 | /* Nonzero if frame F is a minibuffer-only frame. */ | |
ff11dfa1 JB |
350 | #define FRAME_MINIBUF_ONLY_P(f) \ |
351 | EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f)) | |
cea6021b RS |
352 | |
353 | /* Nonzero if frame F contains a minibuffer window. | |
354 | (If this is 0, F must use some other minibuffer window.) */ | |
10a4cc63 | 355 | #define FRAME_HAS_MINIBUF_P(f) ((f)->has_minibuffer) |
cea6021b RS |
356 | |
357 | /* This points to the structure which describes the contents | |
358 | currently displayed on frame F. See dispextern.h. */ | |
ff11dfa1 | 359 | #define FRAME_CURRENT_GLYPHS(f) (f)->current_glyphs |
cea6021b RS |
360 | |
361 | /* This points to the structure which describes the contents | |
362 | intended to be displayed on frame F. See dispextern.h. */ | |
ff11dfa1 | 363 | #define FRAME_DESIRED_GLYPHS(f) (f)->desired_glyphs |
cea6021b | 364 | |
ff11dfa1 | 365 | #define FRAME_TEMP_GLYPHS(f) (f)->temp_glyphs |
cea6021b RS |
366 | #define SET_GLYPHS_FRAME(glyphs,frame) ((glyphs)->frame = (frame)) |
367 | ||
368 | /* Height of frame F, measured in character lines. */ | |
ff11dfa1 | 369 | #define FRAME_HEIGHT(f) (f)->height |
cea6021b RS |
370 | |
371 | /* Width of frame F, measured in character columns, | |
372 | not including scroll bars if any. */ | |
ff11dfa1 | 373 | #define FRAME_WIDTH(f) (f)->width |
cea6021b RS |
374 | |
375 | /* Number of lines of frame F used for menu bar. | |
376 | This is relevant on terminal frames and on | |
377 | X Windows when not using the X toolkit. | |
378 | These lines are counted in FRAME_HEIGHT. */ | |
6d05db81 | 379 | #define FRAME_MENU_BAR_LINES(f) (f)->menu_bar_lines |
cea6021b RS |
380 | |
381 | /* Nonzero if this frame should display a menu bar | |
382 | in a way that does not use any text lines. */ | |
efa7f0f9 | 383 | #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) |
9c95189b | 384 | #define FRAME_EXTERNAL_MENU_BAR(f) (f)->external_menu_bar |
4c8888a0 RS |
385 | #else |
386 | #define FRAME_EXTERNAL_MENU_BAR(f) 0 | |
387 | #endif | |
cea6021b RS |
388 | |
389 | /* Current cursor position for frame F. */ | |
ff11dfa1 JB |
390 | #define FRAME_CURSOR_X(f) (f)->cursor_x |
391 | #define FRAME_CURSOR_Y(f) (f)->cursor_y | |
cea6021b RS |
392 | |
393 | /* Nonzero if frame F is currently visible. */ | |
46a5c487 | 394 | #define FRAME_VISIBLE_P(f) ((f)->visible != 0) |
cea6021b RS |
395 | |
396 | /* Nonzero if frame F is currently visible but hidden. */ | |
0969b893 | 397 | #define FRAME_OBSCURED_P(f) ((f)->visible > 1) |
cea6021b RS |
398 | |
399 | /* Nonzero if frame F is currently iconified. */ | |
400 | #define FRAME_ICONIFIED_P(f) (f)->iconified | |
401 | ||
46a5c487 JB |
402 | #define FRAME_SET_VISIBLE(f,p) \ |
403 | ((f)->async_visible = (p), FRAME_SAMPLE_VISIBILITY (f)) | |
ff11dfa1 JB |
404 | #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1, f->garbaged = 1) |
405 | #define FRAME_GARBAGED_P(f) (f)->garbaged | |
cea6021b RS |
406 | |
407 | /* Nonzero means do not allow splitting this frame's window. */ | |
ff11dfa1 | 408 | #define FRAME_NO_SPLIT_P(f) (f)->no_split |
cea6021b RS |
409 | |
410 | /* Not really implemented. */ | |
ff11dfa1 | 411 | #define FRAME_WANTS_MODELINE_P(f) (f)->wants_modeline |
cea6021b RS |
412 | |
413 | /* Nonzero if a size change has been requested for frame F | |
414 | but not yet really put into effect. This can be true temporarily | |
415 | when an X event comes in at a bad time. */ | |
adc12f0f | 416 | #define FRAME_WINDOW_SIZES_CHANGED(f) (f)->window_sizes_changed |
cea6021b RS |
417 | /* When a size change is pending, these are the requested new sizes. */ |
418 | #define FRAME_NEW_HEIGHT(f) (f)->new_height | |
419 | #define FRAME_NEW_WIDTH(f) (f)->new_width | |
420 | ||
421 | /* The minibuffer window of frame F, if it has one; otherwise nil. */ | |
ff11dfa1 | 422 | #define FRAME_MINIBUF_WINDOW(f) (f)->minibuffer_window |
cea6021b RS |
423 | |
424 | /* The root window of the window tree of frame F. */ | |
ff11dfa1 | 425 | #define FRAME_ROOT_WINDOW(f) (f)->root_window |
cea6021b RS |
426 | |
427 | /* The currently selected window of the window tree of frame F. */ | |
ff11dfa1 | 428 | #define FRAME_SELECTED_WINDOW(f) (f)->selected_window |
cea6021b | 429 | |
ff11dfa1 JB |
430 | #define FRAME_INSERT_COST(f) (f)->insert_line_cost |
431 | #define FRAME_DELETE_COST(f) (f)->delete_line_cost | |
432 | #define FRAME_INSERTN_COST(f) (f)->insert_n_lines_cost | |
433 | #define FRAME_DELETEN_COST(f) (f)->delete_n_lines_cost | |
434 | #define FRAME_MESSAGE_BUF(f) (f)->message_buf | |
435 | #define FRAME_SCROLL_BOTTOM_VPOS(f) (f)->scroll_bottom_vpos | |
436 | #define FRAME_FOCUS_FRAME(f) (f)->focus_frame | |
cea6021b RS |
437 | |
438 | /* Nonzero if frame F supports scroll bars. | |
439 | If this is zero, then it is impossible to enable scroll bars | |
440 | on frame F. */ | |
a3c87d4e | 441 | #define FRAME_CAN_HAVE_SCROLL_BARS(f) ((f)->can_have_scroll_bars) |
cea6021b RS |
442 | |
443 | /* This frame slot says whether scroll bars are currently enabled for frame F, | |
444 | and which side they are on. */ | |
a3211441 RS |
445 | #define FRAME_VERTICAL_SCROLL_BAR_TYPE(f) ((f)->vertical_scroll_bar_type) |
446 | #define FRAME_HAS_VERTICAL_SCROLL_BARS(f) \ | |
447 | ((f)->vertical_scroll_bar_type != vertical_scroll_bar_none) | |
448 | #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT(f) \ | |
449 | ((f)->vertical_scroll_bar_type == vertical_scroll_bar_left) | |
450 | #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT(f) \ | |
451 | ((f)->vertical_scroll_bar_type == vertical_scroll_bar_right) | |
cea6021b RS |
452 | |
453 | /* Width that a scroll bar in frame F should have, if there is one. | |
454 | Measured in pixels. | |
455 | If scroll bars are turned off, this is still nonzero. */ | |
4361366b | 456 | #define FRAME_SCROLL_BAR_PIXEL_WIDTH(f) ((f)->scroll_bar_pixel_width) |
cea6021b RS |
457 | |
458 | /* Width that a scroll bar in frame F should have, if there is one. | |
459 | Measured in columns (characters). | |
460 | If scroll bars are turned off, this is still nonzero. */ | |
4361366b | 461 | #define FRAME_SCROLL_BAR_COLS(f) ((f)->scroll_bar_cols) |
cea6021b RS |
462 | |
463 | /* Width of a scroll bar in frame F, measured in columns (characters), | |
464 | but only if scroll bars are on the left. | |
465 | If scroll bars are on the right in this frame, it is 0. */ | |
a3211441 RS |
466 | #define FRAME_LEFT_SCROLL_BAR_WIDTH(f) \ |
467 | (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \ | |
468 | ? FRAME_SCROLL_BAR_COLS (f) \ | |
469 | : 0) | |
cea6021b RS |
470 | |
471 | /* Width of a scroll bar in frame F, measured in columns (characters). */ | |
a3211441 RS |
472 | #define FRAME_SCROLL_BAR_WIDTH(f) \ |
473 | (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \ | |
474 | ? FRAME_SCROLL_BAR_COLS (f) \ | |
475 | : 0) | |
cea6021b RS |
476 | |
477 | /* Total width of frame F, in columns (characters), | |
478 | including the width used by scroll bars if any. */ | |
479 | #define FRAME_WINDOW_WIDTH(f) ((f)->window_width) | |
480 | ||
481 | /* Set the width of frame F to VAL. | |
482 | VAL is the width of a full-frame window, | |
483 | not including scroll bars. */ | |
484 | #define SET_FRAME_WIDTH(f, val) \ | |
485 | ((f)->width = (val), \ | |
486 | (f)->window_width = FRAME_WINDOW_WIDTH_ARG (f, (f)->width)) | |
487 | ||
488 | /* Given a value WIDTH for frame F's nominal width, | |
489 | return the value that FRAME_WINDOW_WIDTH should have. */ | |
a3211441 RS |
490 | #define FRAME_WINDOW_WIDTH_ARG(f, width) \ |
491 | ((width) + FRAME_SCROLL_BAR_WIDTH (f)) | |
cea6021b | 492 | |
4ff34795 RS |
493 | /* Maximum + 1 legitimate value for FRAME_CURSOR_X. */ |
494 | #define FRAME_CURSOR_X_LIMIT(f) \ | |
495 | (FRAME_WIDTH (f) + FRAME_LEFT_SCROLL_BAR_WIDTH (f)) | |
cea6021b RS |
496 | |
497 | /* Nonzero if frame F has scroll bars. */ | |
a3c87d4e | 498 | #define FRAME_SCROLL_BARS(f) ((f)->scroll_bars) |
cea6021b | 499 | |
a3c87d4e | 500 | #define FRAME_CONDEMNED_SCROLL_BARS(f) ((f)->condemned_scroll_bars) |
6d05db81 | 501 | #define FRAME_MENU_BAR_ITEMS(f) ((f)->menu_bar_items) |
95b999aa | 502 | #define FRAME_COST_BAUD_RATE(f) ((f)->cost_calculation_baud_rate) |
81d00831 KH |
503 | #define FRAME_FONTSET_DATA(f) ((f)->fontset_data) |
504 | ||
505 | /* Return the size of message_buf of the frame F. We multiply the | |
506 | width of the frame by 4 because multi-byte form may require at most | |
507 | 4-byte for a character. */ | |
508 | #define FRAME_MESSAGE_BUF_SIZE(f) (((int) (f)->width) * 4) | |
ff11dfa1 | 509 | |
a4659527 JB |
510 | /* Emacs's redisplay code could become confused if a frame's |
511 | visibility changes at arbitrary times. For example, if a frame is | |
512 | visible while the desired glyphs are being built, but becomes | |
513 | invisible before they are updated, then some rows of the | |
514 | desired_glyphs will be left marked as enabled after redisplay is | |
515 | complete, which should never happen. The next time the frame | |
516 | becomes visible, redisplay will probably barf. | |
517 | ||
518 | Currently, there are no similar situations involving iconified, but | |
519 | the principle is the same. | |
520 | ||
521 | So instead of having asynchronous input handlers directly set and | |
522 | clear the frame's visibility and iconification flags, they just set | |
523 | the async_visible and async_iconified flags; the redisplay code | |
524 | calls the FRAME_SAMPLE_VISIBILITY macro before doing any redisplay, | |
525 | which sets visible and iconified from their asynchronous | |
46a5c487 JB |
526 | counterparts. |
527 | ||
20a6c8d7 JB |
528 | Synchronous code must use the FRAME_SET_VISIBLE macro. |
529 | ||
530 | Also, if a frame used to be invisible, but has just become visible, | |
531 | it must be marked as garbaged, since redisplay hasn't been keeping | |
532 | up its contents. */ | |
a4659527 | 533 | #define FRAME_SAMPLE_VISIBILITY(f) \ |
0969b893 GV |
534 | (((f)->async_visible && (f)->visible != (f)->async_visible) ? \ |
535 | SET_FRAME_GARBAGED (f) : 0, \ | |
20a6c8d7 | 536 | (f)->visible = (f)->async_visible, \ |
a4659527 JB |
537 | (f)->iconified = (f)->async_iconified) |
538 | ||
ff11dfa1 | 539 | #define CHECK_FRAME(x, i) \ |
265a9e55 | 540 | { \ |
ff11dfa1 JB |
541 | if (! FRAMEP (x)) \ |
542 | x = wrong_type_argument (Qframep, (x)); \ | |
265a9e55 JB |
543 | } |
544 | ||
ff11dfa1 | 545 | #define CHECK_LIVE_FRAME(x, i) \ |
265a9e55 | 546 | { \ |
ff11dfa1 JB |
547 | if (! FRAMEP (x) \ |
548 | || ! FRAME_LIVE_P (XFRAME (x))) \ | |
dbc4e1c1 | 549 | x = wrong_type_argument (Qframe_live_p, (x)); \ |
265a9e55 JB |
550 | } |
551 | ||
ff11dfa1 JB |
552 | /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a |
553 | `for' loop which iterates over the elements of Vframe_list. The | |
35f56f96 | 554 | loop will set FRAME_VAR, a Lisp_Object, to each frame in |
ff11dfa1 | 555 | Vframe_list in succession and execute the statement. LIST_VAR |
35f56f96 | 556 | should be a Lisp_Object too; it is used to iterate through the |
ff11dfa1 | 557 | Vframe_list. |
e5d77022 | 558 | |
e3678b64 KH |
559 | This macro is a holdover from a time when multiple frames weren't always |
560 | supported. An alternate definition of the macro would expand to | |
561 | something which executes the statement once. */ | |
ff11dfa1 JB |
562 | #define FOR_EACH_FRAME(list_var, frame_var) \ |
563 | for ((list_var) = Vframe_list; \ | |
e5d77022 | 564 | (CONSP (list_var) \ |
35f56f96 | 565 | && (frame_var = XCONS (list_var)->car, 1)); \ |
e5d77022 JB |
566 | list_var = XCONS (list_var)->cdr) |
567 | ||
568 | ||
870b25a2 | 569 | extern Lisp_Object Qframep, Qframe_live_p, Qicon; |
efa4ce8b | 570 | |
ff11dfa1 JB |
571 | extern struct frame *selected_frame; |
572 | extern struct frame *last_nonminibuf_frame; | |
efa4ce8b | 573 | |
fd6a330f AS |
574 | extern struct frame *make_terminal_frame P_ ((void)); |
575 | extern struct frame *make_frame P_ ((int)); | |
c9e5d3d1 | 576 | #ifdef HAVE_WINDOW_SYSTEM |
fd6a330f AS |
577 | extern struct frame *make_minibuffer_frame P_ ((void)); |
578 | extern struct frame *make_frame_without_minibuffer P_ ((Lisp_Object, | |
579 | struct kboard *, | |
580 | Lisp_Object)); | |
c9e5d3d1 | 581 | #endif /* HAVE_WINDOW_SYSTEM */ |
fd6a330f | 582 | extern int other_visible_frames P_ ((struct frame *)); |
efa4ce8b | 583 | |
ff11dfa1 JB |
584 | extern Lisp_Object Vframe_list; |
585 | extern Lisp_Object Vdefault_frame_alist; | |
efa4ce8b | 586 | |
ff11dfa1 | 587 | extern Lisp_Object Vterminal_frame; |
efa4ce8b | 588 | \f |
e3678b64 | 589 | /* Device-independent scroll bar stuff. */ |
46a5c487 | 590 | |
a3c87d4e | 591 | /* Return the starting column (zero-based) of the vertical scroll bar |
46a5c487 JB |
592 | for window W. The column before this one is the last column we can |
593 | use for text. If the window touches the right edge of the frame, | |
a3c87d4e | 594 | we have extra space allocated for it. Otherwise, the scroll bar |
46a5c487 | 595 | takes over the window's rightmost columns. */ |
a3c87d4e | 596 | #define WINDOW_VERTICAL_SCROLL_BAR_COLUMN(w) \ |
a3211441 RS |
597 | (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (XFRAME (WINDOW_FRAME (w))) ? \ |
598 | (((XINT ((w)->left) + XINT ((w)->width)) \ | |
599 | < FRAME_WIDTH (XFRAME (WINDOW_FRAME (w)))) \ | |
600 | ? (XINT ((w)->left) + XINT ((w)->width) \ | |
601 | - FRAME_SCROLL_BAR_COLS (XFRAME (WINDOW_FRAME (w)))) \ | |
602 | : FRAME_WIDTH (XFRAME (WINDOW_FRAME (w)))) \ | |
603 | : XINT ((w)->left)) | |
46a5c487 | 604 | |
a3c87d4e JB |
605 | /* Return the height in lines of the vertical scroll bar in w. If the |
606 | window has a mode line, don't make the scroll bar extend that far. */ | |
607 | #define WINDOW_VERTICAL_SCROLL_BAR_HEIGHT(w) (window_internal_height (w)) |