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