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