Commit | Line | Data |
---|---|---|
ff11dfa1 | 1 | /* Define frame-object for GNU Emacs. |
1f922834 | 2 | Copyright (C) 1993, 1994, 1999, 2000, 2001 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 | |
843c9999 GM |
21 | /* Don't multiply include: dispextern.h includes macterm.h which |
22 | includes frame.h some emacs source includes both dispextern.h and | |
23 | frame.h */ | |
24 | ||
84e01749 GM |
25 | #ifndef EMACS_FRAME_H |
26 | #define EMACS_FRAME_H | |
1f922834 | 27 | |
20a6c8d7 JB |
28 | \f |
29 | /* Miscellanea. */ | |
30 | ||
3b83d631 GM |
31 | /* Nonzero means don't assume anything about current contents of |
32 | actual terminal frame */ | |
33 | ||
20a6c8d7 JB |
34 | extern int frame_garbaged; |
35 | ||
36 | /* Nonzero means FRAME_MESSAGE_BUF (selected_frame) is being used by | |
37 | print. */ | |
3b83d631 | 38 | |
20a6c8d7 | 39 | extern int message_buf_print; |
efa4ce8b | 40 | |
20a6c8d7 | 41 | \f |
e3678b64 | 42 | /* The structure representing a frame. */ |
efa4ce8b JB |
43 | |
44 | enum output_method | |
3b83d631 GM |
45 | { |
46 | output_termcap, | |
47 | output_x_window, | |
48 | output_msdos_raw, | |
0e015153 RS |
49 | output_w32, |
50 | output_mac | |
3b83d631 | 51 | }; |
efa4ce8b | 52 | |
a3211441 | 53 | enum vertical_scroll_bar_type |
3b83d631 GM |
54 | { |
55 | vertical_scroll_bar_none, | |
56 | vertical_scroll_bar_left, | |
57 | vertical_scroll_bar_right | |
58 | }; | |
a3211441 | 59 | |
2d764c78 EZ |
60 | #if !defined(MSDOS) && !defined(WINDOWSNT) && !defined(macintosh) |
61 | ||
62 | #if !defined(HAVE_X_WINDOWS) | |
63 | ||
78709231 DL |
64 | #define PIX_TYPE int |
65 | ||
2d764c78 EZ |
66 | /* A (mostly empty) x_output structure definition for building Emacs |
67 | on Unix and GNU/Linux without X support. */ | |
68 | struct x_output | |
69 | { | |
70 | PIX_TYPE background_pixel; | |
71 | PIX_TYPE foreground_pixel; | |
72 | }; | |
73 | ||
66ce15ca GM |
74 | #define FRAME_INTERNAL_BORDER_WIDTH(f) 0 |
75 | ||
2d764c78 EZ |
76 | #endif /* ! HAVE_X_WINDOWS */ |
77 | ||
3da48525 GM |
78 | |
79 | #define FRAME_FOREGROUND_PIXEL(f) ((f)->output_data.x->foreground_pixel) | |
80 | #define FRAME_BACKGROUND_PIXEL(f) ((f)->output_data.x->background_pixel) | |
81 | ||
2d764c78 EZ |
82 | /* A structure describing a termcap frame display. */ |
83 | extern struct x_output tty_display; | |
84 | ||
85 | #endif /* ! MSDOS && ! WINDOWSNT && ! macintosh */ | |
86 | ||
ff11dfa1 | 87 | struct frame |
efa4ce8b | 88 | { |
0c38c2f9 | 89 | EMACS_INT size; |
efa4ce8b JB |
90 | struct Lisp_Vector *next; |
91 | ||
21015f9c RS |
92 | /* All Lisp_Object components must come first. |
93 | Only EMACS_INT values can be intermixed with them. | |
94 | That ensures they are all aligned normally. */ | |
efa4ce8b | 95 | |
fa5d1baa RS |
96 | /* Name of this frame: a Lisp string. It is used for looking up resources, |
97 | as well as for the title in some cases. */ | |
efa4ce8b JB |
98 | Lisp_Object name; |
99 | ||
e7f79a67 RS |
100 | /* The name to use for the icon, the last time |
101 | it was refreshed. nil means not explicitly specified. */ | |
102 | Lisp_Object icon_name; | |
103 | ||
fa5d1baa RS |
104 | /* This is the frame title specified explicitly, if any. |
105 | Usually it is nil. */ | |
106 | Lisp_Object title; | |
107 | ||
eb8c3be9 | 108 | /* The frame which should receive keystrokes that occur in this |
46a5c487 JB |
109 | frame, or nil if they should go to the frame itself. This is |
110 | usually nil, but if the frame is minibufferless, we can use this | |
111 | to redirect keystrokes to a surrogate minibuffer frame when | |
112 | needed. | |
113 | ||
114 | Note that a value of nil is different than having the field point | |
115 | to the frame itself. Whenever the Fselect_frame function is used | |
116 | to shift from one frame to the other, any redirections to the | |
117 | original frame are shifted to the newly selected frame; if | |
118 | focus_frame is nil, Fselect_frame will leave it alone. */ | |
ff11dfa1 | 119 | Lisp_Object focus_frame; |
0f79a4ae | 120 | |
ff11dfa1 JB |
121 | /* This frame's root window. Every frame has one. |
122 | If the frame has only a minibuffer window, this is it. | |
123 | Otherwise, if the frame has a minibuffer window, this is its sibling. */ | |
efa4ce8b JB |
124 | Lisp_Object root_window; |
125 | ||
ff11dfa1 JB |
126 | /* This frame's selected window. |
127 | Each frame has its own window hierarchy | |
128 | and one of the windows in it is selected within the frame. | |
129 | The selected window of the selected frame is Emacs's selected window. */ | |
efa4ce8b JB |
130 | Lisp_Object selected_window; |
131 | ||
ff11dfa1 JB |
132 | /* This frame's minibuffer window. |
133 | Most frames have their own minibuffer windows, | |
134 | but only the selected frame's minibuffer window | |
efa4ce8b JB |
135 | can actually appear to exist. */ |
136 | Lisp_Object minibuffer_window; | |
137 | ||
ff11dfa1 JB |
138 | /* Parameter alist of this frame. |
139 | These are the parameters specified when creating the frame | |
140 | or modified with modify-frame-parameters. */ | |
efa4ce8b JB |
141 | Lisp_Object param_alist; |
142 | ||
a3c87d4e | 143 | /* List of scroll bars on this frame. |
20a6c8d7 | 144 | Actually, we don't specify exactly what is stored here at all; the |
a3c87d4e | 145 | scroll bar implementation code can use it to store anything it likes. |
20a6c8d7 JB |
146 | This field is marked by the garbage collector. It is here |
147 | instead of in the `display' structure so that the garbage | |
148 | collector doesn't need to look inside the window-system-dependent | |
149 | structure. */ | |
a3c87d4e JB |
150 | Lisp_Object scroll_bars; |
151 | Lisp_Object condemned_scroll_bars; | |
20a6c8d7 | 152 | |
ad6cd733 RS |
153 | /* Vector describing the items to display in the menu bar. |
154 | Each item has four elements in this vector. | |
155 | They are KEY, STRING, SUBMAP, and HPOS. | |
156 | (HPOS is not used in when the X toolkit is in use.) | |
157 | There are four additional elements of nil at the end, to terminate. */ | |
6d05db81 RS |
158 | Lisp_Object menu_bar_items; |
159 | ||
fb63ba7d RS |
160 | /* Alist of elements (FACE-NAME . FACE-VECTOR-DATA). */ |
161 | Lisp_Object face_alist; | |
162 | ||
21015f9c RS |
163 | /* A vector that records the entire structure of this frame's menu bar. |
164 | For the format of the data, see extensive comments in xmenu.c. | |
165 | Only the X toolkit version uses this. */ | |
166 | Lisp_Object menu_bar_vector; | |
167 | /* Number of elements in the vector that have meaningful data. */ | |
168 | EMACS_INT menu_bar_items_used; | |
169 | ||
170 | /* Predicate for selecting buffers for other-buffer. */ | |
171 | Lisp_Object buffer_predicate; | |
172 | ||
375ff4f1 RS |
173 | /* List of buffers viewed in this frame, for other-buffer. */ |
174 | Lisp_Object buffer_list; | |
175 | ||
3b83d631 GM |
176 | /* A dummy window used to display menu bars under X when no X |
177 | toolkit support is available. */ | |
178 | Lisp_Object menu_bar_window; | |
179 | ||
9ea173e8 GM |
180 | /* A window used to display the tool-bar of a frame. */ |
181 | Lisp_Object tool_bar_window; | |
3b83d631 | 182 | |
9ea173e8 | 183 | /* Desired and current tool-bar items. */ |
e3303a23 | 184 | Lisp_Object tool_bar_items; |
3b83d631 | 185 | |
9ea173e8 GM |
186 | /* Desired and current contents displayed in tool_bar_window. */ |
187 | Lisp_Object desired_tool_bar_string, current_tool_bar_string; | |
3b83d631 | 188 | |
375ff4f1 | 189 | /* beyond here, there should be no more Lisp_Object components. */ |
21015f9c | 190 | |
3b83d631 GM |
191 | /* Cache of realized faces. */ |
192 | struct face_cache *face_cache; | |
21015f9c | 193 | |
3b83d631 GM |
194 | /* A buffer to hold the frame's name. We can't use the Lisp |
195 | string's pointer (`name', above) because it might get relocated. */ | |
bd601e2a KH |
196 | char *namebuf; |
197 | ||
3b83d631 GM |
198 | /* Glyph pool and matrix. */ |
199 | struct glyph_pool *current_pool; | |
200 | struct glyph_pool *desired_pool; | |
201 | struct glyph_matrix *desired_matrix; | |
202 | struct glyph_matrix *current_matrix; | |
203 | ||
204 | /* 1 means that glyphs on this frame have been initialized so it can | |
205 | be used for output. */ | |
206 | unsigned glyphs_initialized_p : 1; | |
21015f9c | 207 | |
9ea173e8 GM |
208 | /* Margin at the top of the frame. Used to display the tool-bar. */ |
209 | int tool_bar_lines; | |
3b83d631 | 210 | |
e3303a23 | 211 | int n_tool_bar_items; |
3b83d631 GM |
212 | |
213 | /* A buffer for decode_mode_line. */ | |
214 | char *decode_mode_spec_buffer; | |
21015f9c RS |
215 | |
216 | /* See do_line_insertion_deletion_costs for info on these arrays. */ | |
217 | /* Cost of inserting 1 line on this frame */ | |
218 | int *insert_line_cost; | |
219 | /* Cost of deleting 1 line on this frame */ | |
220 | int *delete_line_cost; | |
221 | /* Cost of inserting n lines on this frame */ | |
222 | int *insert_n_lines_cost; | |
223 | /* Cost of deleting n lines on this frame */ | |
224 | int *delete_n_lines_cost; | |
225 | ||
21015f9c RS |
226 | /* Size of this frame, in units of characters. */ |
227 | EMACS_INT height; | |
228 | EMACS_INT width; | |
163b385a | 229 | EMACS_INT window_width; |
3b83d631 | 230 | EMACS_INT window_height; |
21015f9c RS |
231 | |
232 | /* New height and width for pending size change. 0 if no change pending. */ | |
233 | int new_height, new_width; | |
234 | ||
ff11dfa1 | 235 | /* The output method says how the contents of this frame |
efa4ce8b JB |
236 | are displayed. It could be using termcap, or using an X window. */ |
237 | enum output_method output_method; | |
238 | ||
239 | /* A structure of auxiliary data used for displaying the contents. | |
785ee691 | 240 | struct x_output is used for X window frames; |
efa7f0f9 | 241 | it is defined in xterm.h. |
fbd6baed | 242 | struct w32_output is used for W32 window frames; |
efa7f0f9 | 243 | it is defined in w32term.h. */ |
3b83d631 GM |
244 | union output_data |
245 | { | |
246 | struct x_output *x; | |
247 | struct w32_output *w32; | |
0e015153 | 248 | struct mac_output *mac; |
cf0fb540 | 249 | EMACS_INT nothing; |
3b83d631 GM |
250 | } |
251 | output_data; | |
efa4ce8b | 252 | |
37ea66e1 KH |
253 | #ifdef MULTI_KBOARD |
254 | /* A pointer to the kboard structure associated with this frame. | |
255 | For termcap frames, this points to initial_kboard. For X frames, | |
256 | it will be the same as display.x->display_info->kboard. */ | |
fadab1e3 | 257 | struct kboard *kboard; |
37ea66e1 KH |
258 | #endif |
259 | ||
6d05db81 RS |
260 | /* Number of lines of menu bar. */ |
261 | int menu_bar_lines; | |
262 | ||
1a578e9b | 263 | #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (macintosh) |
9c95189b RS |
264 | /* Nonzero means using a menu bar that comes from the X toolkit. */ |
265 | int external_menu_bar; | |
266 | #endif | |
267 | ||
ff11dfa1 | 268 | /* Nonzero if last attempt at redisplay on this frame was preempted. */ |
efa4ce8b JB |
269 | char display_preempted; |
270 | ||
a4659527 JB |
271 | /* visible is nonzero if the frame is currently displayed; we check |
272 | it to see if we should bother updating the frame's contents. | |
46a5c487 | 273 | DON'T SET IT DIRECTLY; instead, use FRAME_SET_VISIBLE. |
efa4ce8b | 274 | |
20a6c8d7 JB |
275 | Note that, since invisible frames aren't updated, whenever a |
276 | frame becomes visible again, it must be marked as garbaged. The | |
277 | FRAME_SAMPLE_VISIBILITY macro takes care of this. | |
278 | ||
0969b893 GV |
279 | On Windows NT/9X, to avoid wasting effort updating visible frames |
280 | that are actually completely obscured by other windows on the | |
281 | display, we bend the meaning of visible slightly: if greater than | |
282 | 1, then the frame is obscured - we still consider it to be | |
283 | "visible" as seen from lisp, but we don't bother updating it. We | |
284 | must take care to garbage the frame when it ceaces to be obscured | |
285 | though. Note that these semantics are only used on NT/9X. | |
286 | ||
a4659527 JB |
287 | iconified is nonzero if the frame is currently iconified. |
288 | ||
289 | Asynchronous input handlers should NOT change these directly; | |
290 | instead, they should change async_visible or async_iconified, and | |
291 | let the FRAME_SAMPLE_VISIBILITY macro set visible and iconified | |
292 | at the next redisplay. | |
293 | ||
294 | These should probably be considered read-only by everyone except | |
295 | FRAME_SAMPLE_VISIBILITY. | |
296 | ||
74cc2959 | 297 | These two are mutually exclusive. They might both be zero, if the |
a4659527 JB |
298 | frame has been made invisible without an icon. */ |
299 | char visible, iconified; | |
300 | ||
301 | /* Asynchronous input handlers change these, and | |
302 | FRAME_SAMPLE_VISIBILITY copies them into visible and iconified. | |
303 | See FRAME_SAMPLE_VISIBILITY, below. */ | |
b975254e | 304 | volatile char async_visible, async_iconified; |
efa4ce8b | 305 | |
ff11dfa1 | 306 | /* Nonzero if this frame should be redrawn. */ |
b975254e | 307 | volatile char garbaged; |
efa4ce8b | 308 | |
ff11dfa1 JB |
309 | /* True if frame actually has a minibuffer window on it. |
310 | 0 if using a minibuffer window that isn't on this frame. */ | |
efa4ce8b JB |
311 | char has_minibuffer; |
312 | ||
ff11dfa1 | 313 | /* 0 means, if this frame has just one window, |
efa4ce8b JB |
314 | show no modeline for that window. */ |
315 | char wants_modeline; | |
316 | ||
46a5c487 | 317 | /* Non-zero if the hardware device this frame is displaying on can |
a3c87d4e JB |
318 | support scroll bars. */ |
319 | char can_have_scroll_bars; | |
46a5c487 | 320 | |
a3c87d4e | 321 | /* If can_have_scroll_bars is non-zero, this is non-zero if we should |
46a5c487 | 322 | actually display them on this frame. */ |
a3211441 | 323 | enum vertical_scroll_bar_type vertical_scroll_bar_type; |
46a5c487 | 324 | |
ff11dfa1 | 325 | /* Non-0 means raise this frame to the top of the heap when selected. */ |
efa4ce8b JB |
326 | char auto_raise; |
327 | ||
ff11dfa1 | 328 | /* Non-0 means lower this frame to the bottom of the stack when left. */ |
efa4ce8b JB |
329 | char auto_lower; |
330 | ||
ff11dfa1 | 331 | /* True if frame's root window can't be split. */ |
efa4ce8b JB |
332 | char no_split; |
333 | ||
fbfed6f0 JB |
334 | /* If this is set, then Emacs won't change the frame name to indicate |
335 | the current buffer, etcetera. If the user explicitly sets the frame | |
336 | name, this gets set. If the user sets the name to Qnil, this is | |
337 | cleared. */ | |
338 | char explicit_name; | |
339 | ||
adc12f0f RS |
340 | /* Nonzero if size of some window on this frame has changed. */ |
341 | char window_sizes_changed; | |
342 | ||
ff11dfa1 | 343 | /* Storage for messages to this frame. */ |
efa4ce8b JB |
344 | char *message_buf; |
345 | ||
346 | /* Nonnegative if current redisplay should not do scroll computation | |
347 | for lines beyond a certain vpos. This is the vpos. */ | |
348 | int scroll_bottom_vpos; | |
8d6de7ce | 349 | |
bf92a755 KH |
350 | /* Width of the scroll bar, in pixels and in characters. |
351 | scroll_bar_cols tracks scroll_bar_pixel_width if the latter is positive; | |
352 | a zero value in scroll_bar_pixel_width means to compute the actual width | |
353 | on the fly, using scroll_bar_cols and the current font width. */ | |
4361366b KH |
354 | int scroll_bar_pixel_width; |
355 | int scroll_bar_cols; | |
95b999aa | 356 | |
3b83d631 GM |
357 | /* Width of area for drawing truncation marks and overlay arrow. */ |
358 | int trunc_area_pixel_width, trunc_area_cols; | |
359 | ||
95b999aa RS |
360 | /* The baud rate that was used to calculate costs for this frame. */ |
361 | int cost_calculation_baud_rate; | |
6462918c KH |
362 | |
363 | /* Nonzero if the mouse has moved on this display | |
364 | since the last time we checked. */ | |
365 | char mouse_moved; | |
b61cbba3 GM |
366 | |
367 | /* Exponent for gamma correction of colors. 1/(VIEWING_GAMMA * | |
368 | SCREEN_GAMMA) where viewing_gamma is 0.4545 and SCREEN_GAMMA is a | |
369 | frame parameter. 0 means don't do gamma correction. */ | |
370 | double gamma; | |
d1738c45 GM |
371 | |
372 | /* Additional space to put between text lines on this frame. */ | |
373 | int extra_line_spacing; | |
efa4ce8b JB |
374 | }; |
375 | ||
e3678b64 | 376 | #ifdef MULTI_KBOARD |
37ea66e1 KH |
377 | #define FRAME_KBOARD(f) ((f)->kboard) |
378 | #else | |
379 | #define FRAME_KBOARD(f) (&the_only_kboard) | |
380 | #endif | |
381 | ||
ff11dfa1 JB |
382 | typedef struct frame *FRAME_PTR; |
383 | ||
8801a864 | 384 | #define XFRAME(p) (eassert (GC_FRAMEP(p)),(struct frame *) XPNTR (p)) |
aac03cca | 385 | #define XSETFRAME(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_FRAME)) |
ff11dfa1 | 386 | |
cea6021b | 387 | /* Given a window, return its frame as a Lisp_Object. */ |
ff11dfa1 JB |
388 | #define WINDOW_FRAME(w) (w)->frame |
389 | ||
cea6021b RS |
390 | /* Test a frame for particular kinds of display methods. */ |
391 | #define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap) | |
efa7f0f9 | 392 | #define FRAME_X_P(f) ((f)->output_method == output_x_window) |
fbd6baed | 393 | #define FRAME_W32_P(f) ((f)->output_method == output_w32) |
6f181713 | 394 | #define FRAME_MSDOS_P(f) ((f)->output_method == output_msdos_raw) |
0e015153 | 395 | #define FRAME_MAC_P(f) ((f)->output_method == output_mac) |
efa7f0f9 GV |
396 | |
397 | /* FRAME_WINDOW_P tests whether the frame is a window, and is | |
398 | defined to be the predicate for the window system being used. */ | |
3b83d631 | 399 | |
efa7f0f9 GV |
400 | #ifdef HAVE_X_WINDOWS |
401 | #define FRAME_WINDOW_P(f) FRAME_X_P (f) | |
402 | #endif | |
403 | #ifdef HAVE_NTGUI | |
fbd6baed | 404 | #define FRAME_WINDOW_P(f) FRAME_W32_P (f) |
efa7f0f9 | 405 | #endif |
0e015153 RS |
406 | #ifdef macintosh |
407 | #define FRAME_WINDOW_P(f) FRAME_MAC_P (f) | |
408 | #endif | |
7651b07e RS |
409 | #ifndef FRAME_WINDOW_P |
410 | #define FRAME_WINDOW_P(f) (0) | |
411 | #endif | |
efa7f0f9 | 412 | |
cea6021b | 413 | /* Nonzero if frame F is still alive (not deleted). */ |
785ee691 | 414 | #define FRAME_LIVE_P(f) ((f)->output_data.nothing != 0) |
cea6021b RS |
415 | |
416 | /* Nonzero if frame F is a minibuffer-only frame. */ | |
ff11dfa1 JB |
417 | #define FRAME_MINIBUF_ONLY_P(f) \ |
418 | EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f)) | |
cea6021b RS |
419 | |
420 | /* Nonzero if frame F contains a minibuffer window. | |
421 | (If this is 0, F must use some other minibuffer window.) */ | |
10a4cc63 | 422 | #define FRAME_HAS_MINIBUF_P(f) ((f)->has_minibuffer) |
ff11dfa1 | 423 | #define FRAME_HEIGHT(f) (f)->height |
cea6021b RS |
424 | |
425 | /* Width of frame F, measured in character columns, | |
426 | not including scroll bars if any. */ | |
ff11dfa1 | 427 | #define FRAME_WIDTH(f) (f)->width |
cea6021b RS |
428 | |
429 | /* Number of lines of frame F used for menu bar. | |
430 | This is relevant on terminal frames and on | |
431 | X Windows when not using the X toolkit. | |
432 | These lines are counted in FRAME_HEIGHT. */ | |
6d05db81 | 433 | #define FRAME_MENU_BAR_LINES(f) (f)->menu_bar_lines |
cea6021b | 434 | |
9ea173e8 | 435 | /* Number of lines of frame F used for the tool-bar. */ |
3b83d631 | 436 | |
9ea173e8 | 437 | #define FRAME_TOOL_BAR_LINES(f) (f)->tool_bar_lines |
3b83d631 GM |
438 | |
439 | /* Lines above the top-most window in frame F. */ | |
440 | ||
441 | #define FRAME_TOP_MARGIN(F) \ | |
9ea173e8 | 442 | (FRAME_MENU_BAR_LINES (F) + FRAME_TOOL_BAR_LINES (F)) |
3b83d631 | 443 | |
cea6021b RS |
444 | /* Nonzero if this frame should display a menu bar |
445 | in a way that does not use any text lines. */ | |
1a578e9b | 446 | #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (macintosh) |
9c95189b | 447 | #define FRAME_EXTERNAL_MENU_BAR(f) (f)->external_menu_bar |
4c8888a0 RS |
448 | #else |
449 | #define FRAME_EXTERNAL_MENU_BAR(f) 0 | |
450 | #endif | |
46a5c487 | 451 | #define FRAME_VISIBLE_P(f) ((f)->visible != 0) |
cea6021b RS |
452 | |
453 | /* Nonzero if frame F is currently visible but hidden. */ | |
0969b893 | 454 | #define FRAME_OBSCURED_P(f) ((f)->visible > 1) |
cea6021b RS |
455 | |
456 | /* Nonzero if frame F is currently iconified. */ | |
457 | #define FRAME_ICONIFIED_P(f) (f)->iconified | |
458 | ||
46a5c487 JB |
459 | #define FRAME_SET_VISIBLE(f,p) \ |
460 | ((f)->async_visible = (p), FRAME_SAMPLE_VISIBILITY (f)) | |
ff11dfa1 JB |
461 | #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1, f->garbaged = 1) |
462 | #define FRAME_GARBAGED_P(f) (f)->garbaged | |
cea6021b RS |
463 | |
464 | /* Nonzero means do not allow splitting this frame's window. */ | |
ff11dfa1 | 465 | #define FRAME_NO_SPLIT_P(f) (f)->no_split |
cea6021b RS |
466 | |
467 | /* Not really implemented. */ | |
ff11dfa1 | 468 | #define FRAME_WANTS_MODELINE_P(f) (f)->wants_modeline |
cea6021b RS |
469 | |
470 | /* Nonzero if a size change has been requested for frame F | |
471 | but not yet really put into effect. This can be true temporarily | |
472 | when an X event comes in at a bad time. */ | |
adc12f0f | 473 | #define FRAME_WINDOW_SIZES_CHANGED(f) (f)->window_sizes_changed |
cea6021b RS |
474 | /* When a size change is pending, these are the requested new sizes. */ |
475 | #define FRAME_NEW_HEIGHT(f) (f)->new_height | |
476 | #define FRAME_NEW_WIDTH(f) (f)->new_width | |
477 | ||
478 | /* The minibuffer window of frame F, if it has one; otherwise nil. */ | |
ff11dfa1 | 479 | #define FRAME_MINIBUF_WINDOW(f) (f)->minibuffer_window |
cea6021b RS |
480 | |
481 | /* The root window of the window tree of frame F. */ | |
ff11dfa1 | 482 | #define FRAME_ROOT_WINDOW(f) (f)->root_window |
cea6021b RS |
483 | |
484 | /* The currently selected window of the window tree of frame F. */ | |
ff11dfa1 | 485 | #define FRAME_SELECTED_WINDOW(f) (f)->selected_window |
cea6021b | 486 | |
ff11dfa1 JB |
487 | #define FRAME_INSERT_COST(f) (f)->insert_line_cost |
488 | #define FRAME_DELETE_COST(f) (f)->delete_line_cost | |
489 | #define FRAME_INSERTN_COST(f) (f)->insert_n_lines_cost | |
490 | #define FRAME_DELETEN_COST(f) (f)->delete_n_lines_cost | |
491 | #define FRAME_MESSAGE_BUF(f) (f)->message_buf | |
492 | #define FRAME_SCROLL_BOTTOM_VPOS(f) (f)->scroll_bottom_vpos | |
493 | #define FRAME_FOCUS_FRAME(f) (f)->focus_frame | |
cea6021b RS |
494 | |
495 | /* Nonzero if frame F supports scroll bars. | |
496 | If this is zero, then it is impossible to enable scroll bars | |
497 | on frame F. */ | |
a3c87d4e | 498 | #define FRAME_CAN_HAVE_SCROLL_BARS(f) ((f)->can_have_scroll_bars) |
cea6021b RS |
499 | |
500 | /* This frame slot says whether scroll bars are currently enabled for frame F, | |
501 | and which side they are on. */ | |
a3211441 RS |
502 | #define FRAME_VERTICAL_SCROLL_BAR_TYPE(f) ((f)->vertical_scroll_bar_type) |
503 | #define FRAME_HAS_VERTICAL_SCROLL_BARS(f) \ | |
504 | ((f)->vertical_scroll_bar_type != vertical_scroll_bar_none) | |
505 | #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT(f) \ | |
506 | ((f)->vertical_scroll_bar_type == vertical_scroll_bar_left) | |
507 | #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT(f) \ | |
508 | ((f)->vertical_scroll_bar_type == vertical_scroll_bar_right) | |
cea6021b RS |
509 | |
510 | /* Width that a scroll bar in frame F should have, if there is one. | |
511 | Measured in pixels. | |
512 | If scroll bars are turned off, this is still nonzero. */ | |
4361366b | 513 | #define FRAME_SCROLL_BAR_PIXEL_WIDTH(f) ((f)->scroll_bar_pixel_width) |
cea6021b RS |
514 | |
515 | /* Width that a scroll bar in frame F should have, if there is one. | |
516 | Measured in columns (characters). | |
517 | If scroll bars are turned off, this is still nonzero. */ | |
4361366b | 518 | #define FRAME_SCROLL_BAR_COLS(f) ((f)->scroll_bar_cols) |
cea6021b RS |
519 | |
520 | /* Width of a scroll bar in frame F, measured in columns (characters), | |
7d81cf83 GM |
521 | but only if scroll bars are on the left. If scroll bars are on |
522 | the right in this frame, or there are no scroll bars, value is 0. */ | |
523 | ||
524 | #define FRAME_LEFT_SCROLL_BAR_WIDTH(f) \ | |
525 | (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \ | |
526 | ? FRAME_SCROLL_BAR_COLS (f) \ | |
527 | : 0) | |
528 | ||
529 | /* Width of a scroll bar in frame F, measured in columns (characters), | |
530 | but only if scroll bars are on the right. If scroll bars are on | |
531 | the left in this frame, or there are no scroll bars, value is 0. */ | |
532 | ||
533 | #define FRAME_RIGHT_SCROLL_BAR_WIDTH(f) \ | |
534 | (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f) \ | |
535 | ? FRAME_SCROLL_BAR_COLS (f) \ | |
a3211441 | 536 | : 0) |
cea6021b RS |
537 | |
538 | /* Width of a scroll bar in frame F, measured in columns (characters). */ | |
a3211441 RS |
539 | #define FRAME_SCROLL_BAR_WIDTH(f) \ |
540 | (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \ | |
541 | ? FRAME_SCROLL_BAR_COLS (f) \ | |
542 | : 0) | |
cea6021b RS |
543 | |
544 | /* Total width of frame F, in columns (characters), | |
545 | including the width used by scroll bars if any. */ | |
546 | #define FRAME_WINDOW_WIDTH(f) ((f)->window_width) | |
547 | ||
548 | /* Set the width of frame F to VAL. | |
549 | VAL is the width of a full-frame window, | |
550 | not including scroll bars. */ | |
551 | #define SET_FRAME_WIDTH(f, val) \ | |
552 | ((f)->width = (val), \ | |
553 | (f)->window_width = FRAME_WINDOW_WIDTH_ARG (f, (f)->width)) | |
554 | ||
555 | /* Given a value WIDTH for frame F's nominal width, | |
556 | return the value that FRAME_WINDOW_WIDTH should have. */ | |
3b83d631 GM |
557 | #define FRAME_WINDOW_WIDTH_ARG(f, width) \ |
558 | ((width) \ | |
559 | + FRAME_SCROLL_BAR_WIDTH (f) \ | |
5cb26370 | 560 | + FRAME_FLAGS_AREA_COLS (f)) |
cea6021b | 561 | |
4ff34795 RS |
562 | /* Maximum + 1 legitimate value for FRAME_CURSOR_X. */ |
563 | #define FRAME_CURSOR_X_LIMIT(f) \ | |
564 | (FRAME_WIDTH (f) + FRAME_LEFT_SCROLL_BAR_WIDTH (f)) | |
cea6021b RS |
565 | |
566 | /* Nonzero if frame F has scroll bars. */ | |
a3c87d4e | 567 | #define FRAME_SCROLL_BARS(f) ((f)->scroll_bars) |
cea6021b | 568 | |
a3c87d4e | 569 | #define FRAME_CONDEMNED_SCROLL_BARS(f) ((f)->condemned_scroll_bars) |
6d05db81 | 570 | #define FRAME_MENU_BAR_ITEMS(f) ((f)->menu_bar_items) |
95b999aa | 571 | #define FRAME_COST_BAUD_RATE(f) ((f)->cost_calculation_baud_rate) |
81d00831 | 572 | |
3b83d631 GM |
573 | /* Return a pointer to the face cache of frame F. */ |
574 | ||
575 | #define FRAME_FACE_CACHE(F) (F)->face_cache | |
576 | ||
81d00831 KH |
577 | /* Return the size of message_buf of the frame F. We multiply the |
578 | width of the frame by 4 because multi-byte form may require at most | |
579 | 4-byte for a character. */ | |
3b83d631 | 580 | |
81d00831 | 581 | #define FRAME_MESSAGE_BUF_SIZE(f) (((int) (f)->width) * 4) |
ff11dfa1 | 582 | |
a4659527 JB |
583 | /* Emacs's redisplay code could become confused if a frame's |
584 | visibility changes at arbitrary times. For example, if a frame is | |
585 | visible while the desired glyphs are being built, but becomes | |
586 | invisible before they are updated, then some rows of the | |
587 | desired_glyphs will be left marked as enabled after redisplay is | |
588 | complete, which should never happen. The next time the frame | |
589 | becomes visible, redisplay will probably barf. | |
590 | ||
591 | Currently, there are no similar situations involving iconified, but | |
592 | the principle is the same. | |
593 | ||
594 | So instead of having asynchronous input handlers directly set and | |
595 | clear the frame's visibility and iconification flags, they just set | |
596 | the async_visible and async_iconified flags; the redisplay code | |
597 | calls the FRAME_SAMPLE_VISIBILITY macro before doing any redisplay, | |
598 | which sets visible and iconified from their asynchronous | |
46a5c487 JB |
599 | counterparts. |
600 | ||
20a6c8d7 JB |
601 | Synchronous code must use the FRAME_SET_VISIBLE macro. |
602 | ||
603 | Also, if a frame used to be invisible, but has just become visible, | |
604 | it must be marked as garbaged, since redisplay hasn't been keeping | |
605 | up its contents. */ | |
3b83d631 | 606 | |
a4659527 | 607 | #define FRAME_SAMPLE_VISIBILITY(f) \ |
0969b893 GV |
608 | (((f)->async_visible && (f)->visible != (f)->async_visible) ? \ |
609 | SET_FRAME_GARBAGED (f) : 0, \ | |
20a6c8d7 | 610 | (f)->visible = (f)->async_visible, \ |
a4659527 JB |
611 | (f)->iconified = (f)->async_iconified) |
612 | ||
c3df1ad9 GM |
613 | #define CHECK_FRAME(x, i) \ |
614 | do { \ | |
615 | if (! FRAMEP (x)) \ | |
616 | x = wrong_type_argument (Qframep, (x)); \ | |
617 | } while (0) | |
265a9e55 | 618 | |
ff11dfa1 | 619 | #define CHECK_LIVE_FRAME(x, i) \ |
c3df1ad9 GM |
620 | do { \ |
621 | if (! FRAMEP (x) \ | |
622 | || ! FRAME_LIVE_P (XFRAME (x))) \ | |
623 | x = wrong_type_argument (Qframe_live_p, (x)); \ | |
624 | } while (0) | |
265a9e55 | 625 | |
ff11dfa1 JB |
626 | /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a |
627 | `for' loop which iterates over the elements of Vframe_list. The | |
35f56f96 | 628 | loop will set FRAME_VAR, a Lisp_Object, to each frame in |
ff11dfa1 | 629 | Vframe_list in succession and execute the statement. LIST_VAR |
35f56f96 | 630 | should be a Lisp_Object too; it is used to iterate through the |
ff11dfa1 | 631 | Vframe_list. |
e5d77022 | 632 | |
e3678b64 KH |
633 | This macro is a holdover from a time when multiple frames weren't always |
634 | supported. An alternate definition of the macro would expand to | |
635 | something which executes the statement once. */ | |
3b83d631 | 636 | |
ff11dfa1 JB |
637 | #define FOR_EACH_FRAME(list_var, frame_var) \ |
638 | for ((list_var) = Vframe_list; \ | |
e5d77022 | 639 | (CONSP (list_var) \ |
ee88f64d KR |
640 | && (frame_var = XCAR (list_var), 1)); \ |
641 | list_var = XCDR (list_var)) | |
e5d77022 JB |
642 | |
643 | ||
870b25a2 | 644 | extern Lisp_Object Qframep, Qframe_live_p, Qicon; |
efa4ce8b | 645 | |
ff11dfa1 | 646 | extern struct frame *last_nonminibuf_frame; |
efa4ce8b | 647 | |
fd6a330f AS |
648 | extern struct frame *make_terminal_frame P_ ((void)); |
649 | extern struct frame *make_frame P_ ((int)); | |
c9e5d3d1 | 650 | #ifdef HAVE_WINDOW_SYSTEM |
fd6a330f AS |
651 | extern struct frame *make_minibuffer_frame P_ ((void)); |
652 | extern struct frame *make_frame_without_minibuffer P_ ((Lisp_Object, | |
653 | struct kboard *, | |
654 | Lisp_Object)); | |
c9e5d3d1 | 655 | #endif /* HAVE_WINDOW_SYSTEM */ |
fd6a330f | 656 | extern int other_visible_frames P_ ((struct frame *)); |
efa4ce8b | 657 | |
ff11dfa1 JB |
658 | extern Lisp_Object Vframe_list; |
659 | extern Lisp_Object Vdefault_frame_alist; | |
efa4ce8b | 660 | |
ff11dfa1 | 661 | extern Lisp_Object Vterminal_frame; |
efa4ce8b | 662 | \f |
e3678b64 | 663 | /* Device-independent scroll bar stuff. */ |
46a5c487 | 664 | |
a3c87d4e | 665 | /* Return the starting column (zero-based) of the vertical scroll bar |
46a5c487 JB |
666 | for window W. The column before this one is the last column we can |
667 | use for text. If the window touches the right edge of the frame, | |
a3c87d4e | 668 | we have extra space allocated for it. Otherwise, the scroll bar |
46a5c487 | 669 | takes over the window's rightmost columns. */ |
3b83d631 | 670 | |
a3c87d4e | 671 | #define WINDOW_VERTICAL_SCROLL_BAR_COLUMN(w) \ |
a3211441 RS |
672 | (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (XFRAME (WINDOW_FRAME (w))) ? \ |
673 | (((XINT ((w)->left) + XINT ((w)->width)) \ | |
674 | < FRAME_WIDTH (XFRAME (WINDOW_FRAME (w)))) \ | |
675 | ? (XINT ((w)->left) + XINT ((w)->width) \ | |
676 | - FRAME_SCROLL_BAR_COLS (XFRAME (WINDOW_FRAME (w)))) \ | |
677 | : FRAME_WIDTH (XFRAME (WINDOW_FRAME (w)))) \ | |
678 | : XINT ((w)->left)) | |
46a5c487 | 679 | |
a3c87d4e JB |
680 | /* Return the height in lines of the vertical scroll bar in w. If the |
681 | window has a mode line, don't make the scroll bar extend that far. */ | |
3b83d631 | 682 | |
a3c87d4e | 683 | #define WINDOW_VERTICAL_SCROLL_BAR_HEIGHT(w) (window_internal_height (w)) |
3b83d631 | 684 | |
650afd94 GM |
685 | /* The currently selected frame. */ |
686 | ||
687 | extern Lisp_Object selected_frame; | |
688 | ||
689 | /* Value is a pointer to the selected frame. If the selected frame | |
b975254e | 690 | isn't live, abort. */ |
650afd94 GM |
691 | |
692 | #define SELECTED_FRAME() \ | |
693 | ((FRAMEP (selected_frame) \ | |
694 | && FRAME_LIVE_P (XFRAME (selected_frame))) \ | |
695 | ? XFRAME (selected_frame) \ | |
e1ef1fb2 | 696 | : (abort (), (struct frame *) 0)) |
3b83d631 GM |
697 | |
698 | \f | |
699 | /*********************************************************************** | |
700 | Display-related Macros | |
701 | ***********************************************************************/ | |
702 | ||
703 | /* Canonical y-unit on frame F. This value currently equals the line | |
704 | height of the frame. Terminal specific header files are expected | |
705 | to define the macro FRAME_LINE_HEIGHT. */ | |
706 | ||
707 | #define CANON_Y_UNIT(F) \ | |
708 | (FRAME_WINDOW_P (F) ? FRAME_LINE_HEIGHT (F) : 1) | |
709 | ||
710 | /* Canonical x-unit on frame F. This is currently equal to the width | |
711 | of the default font of F. Terminal specific headers are expected | |
712 | to define the macro FRAME_DEFAULT_FONT_WIDTH. */ | |
713 | ||
714 | #define CANON_X_UNIT(F) \ | |
715 | (FRAME_WINDOW_P (F) ? FRAME_DEFAULT_FONT_WIDTH (F) : 1) | |
716 | ||
717 | /* Pixel width of areas used to display truncation marks, continuation | |
5cb26370 | 718 | marks, overlay arrows. This is 0 for terminal frames. */ |
3b83d631 GM |
719 | |
720 | #ifdef HAVE_WINDOW_SYSTEM | |
aa5b8e15 | 721 | |
3b83d631 | 722 | #define FRAME_FLAGS_AREA_COLS(F) \ |
aa5b8e15 GM |
723 | (FRAME_WINDOW_P (F) ? FRAME_X_FLAGS_AREA_COLS (F) : 0) |
724 | #define FRAME_FLAGS_AREA_WIDTH(F) \ | |
725 | (FRAME_WINDOW_P (F) ? FRAME_X_FLAGS_AREA_WIDTH (F) : 0) | |
726 | #define FRAME_LEFT_FLAGS_AREA_WIDTH(F) \ | |
727 | (FRAME_WINDOW_P (F) ? FRAME_X_LEFT_FLAGS_AREA_WIDTH (F) : 0) | |
5cb26370 | 728 | |
aa5b8e15 GM |
729 | #else /* not HAVE_WINDOW_SYSTEM */ |
730 | ||
3b83d631 GM |
731 | #define FRAME_FLAGS_AREA_WIDTH(F) 0 |
732 | #define FRAME_FLAGS_AREA_COLS(F) 0 | |
5cb26370 | 733 | #define FRAME_LEFT_FLAGS_AREA_WIDTH(F) 0 |
aa5b8e15 GM |
734 | |
735 | #endif /* not HAVE_WINDOW_SYSTEM */ | |
3b83d631 GM |
736 | |
737 | ||
738 | ||
739 | \f | |
740 | /*********************************************************************** | |
741 | Conversion between canonical units and pixels | |
742 | ***********************************************************************/ | |
743 | ||
744 | /* Canonical x-values are fractions of CANON_X_UNIT, canonical y-unit | |
745 | are fractions of CANON_Y_UNIT of a frame. Both are represented as | |
746 | Lisp numbers, i.e. integers or floats. */ | |
747 | ||
748 | /* Convert canonical value X to pixels. F is the frame whose | |
749 | canonical char width is to be used. X must be a Lisp integer or | |
750 | float. Value is a C integer. */ | |
751 | ||
752 | #define PIXEL_X_FROM_CANON_X(F, X) \ | |
753 | (INTEGERP (X) \ | |
754 | ? XINT (X) * CANON_X_UNIT (F) \ | |
ee88f64d | 755 | : (int) (XFLOAT_DATA (X) * CANON_X_UNIT (F))) |
3b83d631 GM |
756 | |
757 | /* Convert canonical value Y to pixels. F is the frame whose | |
758 | canonical character height is to be used. X must be a Lisp integer | |
759 | or float. Value is a C integer. */ | |
760 | ||
761 | #define PIXEL_Y_FROM_CANON_Y(F, Y) \ | |
762 | (INTEGERP (Y) \ | |
763 | ? XINT (Y) * CANON_Y_UNIT (F) \ | |
ee88f64d | 764 | : (int) (XFLOAT_DATA (Y) * CANON_Y_UNIT (F))) |
3b83d631 GM |
765 | |
766 | /* Convert pixel-value X to canonical units. F is the frame whose | |
767 | canonical character width is to be used. X is a C integer. Result | |
768 | is a Lisp float if X is not a multiple of the canon width, | |
769 | otherwise it's a Lisp integer. */ | |
770 | ||
771 | #define CANON_X_FROM_PIXEL_X(F, X) \ | |
772 | ((X) % CANON_X_UNIT (F) != 0 \ | |
773 | ? make_float ((double) (X) / CANON_X_UNIT (F)) \ | |
774 | : make_number ((X) / CANON_X_UNIT (F))) | |
775 | ||
776 | /* Convert pixel-value Y to canonical units. F is the frame whose | |
777 | canonical character height is to be used. Y is a C integer. | |
778 | Result is a Lisp float if Y is not a multiple of the canon width, | |
779 | otherwise it's a Lisp integer. */ | |
780 | ||
781 | #define CANON_Y_FROM_PIXEL_Y(F, Y) \ | |
782 | ((Y) % CANON_Y_UNIT (F) \ | |
783 | ? make_float ((double) (Y) / CANON_Y_UNIT (F)) \ | |
784 | : make_number ((Y) / CANON_Y_UNIT (F))) | |
785 | ||
84e01749 | 786 | #endif /* not EMACS_FRAME_H */ |