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