Commit | Line | Data |
---|---|---|
ff11dfa1 | 1 | /* Define frame-object for GNU Emacs. |
73b0cd50 | 2 | Copyright (C) 1993-1994, 1999-2011 Free Software Foundation, Inc. |
efa4ce8b JB |
3 | |
4 | This file is part of GNU Emacs. | |
5 | ||
b9b1cc14 | 6 | GNU Emacs is free software: you can redistribute it and/or modify |
efa4ce8b | 7 | it under the terms of the GNU General Public License as published by |
b9b1cc14 GM |
8 | the Free Software Foundation, either version 3 of the License, or |
9 | (at your option) any later version. | |
efa4ce8b JB |
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 | |
b9b1cc14 | 17 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */ |
efa4ce8b | 18 | |
843c9999 GM |
19 | /* Don't multiply include: dispextern.h includes macterm.h which |
20 | includes frame.h some emacs source includes both dispextern.h and | |
21 | frame.h */ | |
22 | ||
84e01749 GM |
23 | #ifndef EMACS_FRAME_H |
24 | #define EMACS_FRAME_H | |
1f922834 | 25 | |
facfbbbd SM |
26 | #include "dispextern.h" |
27 | ||
20a6c8d7 JB |
28 | \f |
29 | /* Miscellanea. */ | |
30 | ||
9628b887 | 31 | /* Nonzero means there is at least one garbaged frame. */ |
20a6c8d7 JB |
32 | extern int frame_garbaged; |
33 | ||
20a6c8d7 | 34 | \f |
e3678b64 | 35 | /* The structure representing a frame. */ |
efa4ce8b JB |
36 | |
37 | enum output_method | |
3b83d631 | 38 | { |
3224dac1 | 39 | output_initial, |
3b83d631 GM |
40 | output_termcap, |
41 | output_x_window, | |
42 | output_msdos_raw, | |
0e015153 | 43 | output_w32, |
edfda783 AR |
44 | output_mac, |
45 | output_ns | |
3b83d631 | 46 | }; |
efa4ce8b | 47 | |
a3211441 | 48 | enum vertical_scroll_bar_type |
3b83d631 GM |
49 | { |
50 | vertical_scroll_bar_none, | |
51 | vertical_scroll_bar_left, | |
52 | vertical_scroll_bar_right | |
53 | }; | |
a3211441 | 54 | |
4d418fcc KS |
55 | enum text_cursor_kinds |
56 | { | |
57 | DEFAULT_CURSOR = -2, | |
58 | NO_CURSOR = -1, | |
59 | FILLED_BOX_CURSOR, | |
60 | HOLLOW_BOX_CURSOR, | |
61 | BAR_CURSOR, | |
62 | HBAR_CURSOR | |
63 | }; | |
64 | ||
2806a183 SM |
65 | enum fullscreen_type |
66 | { | |
3f1c6666 JD |
67 | FULLSCREEN_NONE, |
68 | FULLSCREEN_WIDTH = 0x001, | |
69 | FULLSCREEN_HEIGHT = 0x002, | |
70 | FULLSCREEN_BOTH = 0x003, | |
71 | FULLSCREEN_MAXIMIZED = 0x013, | |
72 | FULLSCREEN_WAIT = 0x100 | |
2806a183 SM |
73 | }; |
74 | ||
75 | ||
28d7d09f KL |
76 | #define FRAME_FOREGROUND_PIXEL(f) ((f)->foreground_pixel) |
77 | #define FRAME_BACKGROUND_PIXEL(f) ((f)->background_pixel) | |
2d764c78 | 78 | |
6ed8eeff | 79 | struct terminal; |
2d764c78 | 80 | |
adf494ff | 81 | struct font_driver_list; |
adf494ff | 82 | |
ff11dfa1 | 83 | struct frame |
efa4ce8b | 84 | { |
b102ceb1 | 85 | struct vectorlike_header header; |
efa4ce8b | 86 | |
21015f9c | 87 | /* All Lisp_Object components must come first. |
21015f9c | 88 | That ensures they are all aligned normally. */ |
efa4ce8b | 89 | |
fa5d1baa RS |
90 | /* Name of this frame: a Lisp string. It is used for looking up resources, |
91 | as well as for the title in some cases. */ | |
efa4ce8b JB |
92 | Lisp_Object name; |
93 | ||
e7f79a67 RS |
94 | /* The name to use for the icon, the last time |
95 | it was refreshed. nil means not explicitly specified. */ | |
96 | Lisp_Object icon_name; | |
97 | ||
fa5d1baa RS |
98 | /* This is the frame title specified explicitly, if any. |
99 | Usually it is nil. */ | |
100 | Lisp_Object title; | |
101 | ||
eb8c3be9 | 102 | /* The frame which should receive keystrokes that occur in this |
46a5c487 JB |
103 | frame, or nil if they should go to the frame itself. This is |
104 | usually nil, but if the frame is minibufferless, we can use this | |
105 | to redirect keystrokes to a surrogate minibuffer frame when | |
106 | needed. | |
107 | ||
108 | Note that a value of nil is different than having the field point | |
109 | to the frame itself. Whenever the Fselect_frame function is used | |
110 | to shift from one frame to the other, any redirections to the | |
111 | original frame are shifted to the newly selected frame; if | |
112 | focus_frame is nil, Fselect_frame will leave it alone. */ | |
ff11dfa1 | 113 | Lisp_Object focus_frame; |
0f79a4ae | 114 | |
ff11dfa1 JB |
115 | /* This frame's root window. Every frame has one. |
116 | If the frame has only a minibuffer window, this is it. | |
117 | Otherwise, if the frame has a minibuffer window, this is its sibling. */ | |
efa4ce8b JB |
118 | Lisp_Object root_window; |
119 | ||
ff11dfa1 JB |
120 | /* This frame's selected window. |
121 | Each frame has its own window hierarchy | |
122 | and one of the windows in it is selected within the frame. | |
123 | The selected window of the selected frame is Emacs's selected window. */ | |
efa4ce8b JB |
124 | Lisp_Object selected_window; |
125 | ||
ff11dfa1 JB |
126 | /* This frame's minibuffer window. |
127 | Most frames have their own minibuffer windows, | |
128 | but only the selected frame's minibuffer window | |
efa4ce8b JB |
129 | can actually appear to exist. */ |
130 | Lisp_Object minibuffer_window; | |
131 | ||
ff11dfa1 JB |
132 | /* Parameter alist of this frame. |
133 | These are the parameters specified when creating the frame | |
134 | or modified with modify-frame-parameters. */ | |
efa4ce8b JB |
135 | Lisp_Object param_alist; |
136 | ||
177c0ea7 | 137 | /* List of scroll bars on this frame. |
20a6c8d7 | 138 | Actually, we don't specify exactly what is stored here at all; the |
a3c87d4e | 139 | scroll bar implementation code can use it to store anything it likes. |
20a6c8d7 | 140 | This field is marked by the garbage collector. It is here |
7e59217d | 141 | instead of in the `device' structure so that the garbage |
20a6c8d7 JB |
142 | collector doesn't need to look inside the window-system-dependent |
143 | structure. */ | |
a3c87d4e JB |
144 | Lisp_Object scroll_bars; |
145 | Lisp_Object condemned_scroll_bars; | |
20a6c8d7 | 146 | |
ad6cd733 RS |
147 | /* Vector describing the items to display in the menu bar. |
148 | Each item has four elements in this vector. | |
149 | They are KEY, STRING, SUBMAP, and HPOS. | |
150 | (HPOS is not used in when the X toolkit is in use.) | |
151 | There are four additional elements of nil at the end, to terminate. */ | |
6d05db81 RS |
152 | Lisp_Object menu_bar_items; |
153 | ||
fb63ba7d RS |
154 | /* Alist of elements (FACE-NAME . FACE-VECTOR-DATA). */ |
155 | Lisp_Object face_alist; | |
156 | ||
21015f9c RS |
157 | /* A vector that records the entire structure of this frame's menu bar. |
158 | For the format of the data, see extensive comments in xmenu.c. | |
159 | Only the X toolkit version uses this. */ | |
160 | Lisp_Object menu_bar_vector; | |
21015f9c RS |
161 | |
162 | /* Predicate for selecting buffers for other-buffer. */ | |
163 | Lisp_Object buffer_predicate; | |
164 | ||
375ff4f1 RS |
165 | /* List of buffers viewed in this frame, for other-buffer. */ |
166 | Lisp_Object buffer_list; | |
167 | ||
a18b8cb5 KL |
168 | /* List of buffers that were viewed, then buried in this frame. The |
169 | most recently buried buffer is first. For last-buffer. */ | |
170 | Lisp_Object buried_buffer_list; | |
63bb3d8e | 171 | |
3b83d631 GM |
172 | /* A dummy window used to display menu bars under X when no X |
173 | toolkit support is available. */ | |
174 | Lisp_Object menu_bar_window; | |
175 | ||
9ea173e8 GM |
176 | /* A window used to display the tool-bar of a frame. */ |
177 | Lisp_Object tool_bar_window; | |
3b83d631 | 178 | |
9ea173e8 | 179 | /* Desired and current tool-bar items. */ |
e3303a23 | 180 | Lisp_Object tool_bar_items; |
3b83d631 | 181 | |
bfeabdc3 JD |
182 | /* Where tool bar is, can be left, right, top or bottom. The native |
183 | tool bar only supports top. */ | |
184 | Lisp_Object tool_bar_position; | |
185 | ||
9ea173e8 GM |
186 | /* Desired and current contents displayed in tool_bar_window. */ |
187 | Lisp_Object desired_tool_bar_string, current_tool_bar_string; | |
3b83d631 | 188 | |
63bb3d8e | 189 | /* Beyond here, there should be no more Lisp_Object components. */ |
21015f9c | 190 | |
3b83d631 GM |
191 | /* Cache of realized faces. */ |
192 | struct face_cache *face_cache; | |
21015f9c | 193 | |
a390930c SM |
194 | /* Number of elements in `menu_bar_vector' that have meaningful data. */ |
195 | EMACS_INT menu_bar_items_used; | |
196 | ||
3b83d631 GM |
197 | /* A buffer to hold the frame's name. We can't use the Lisp |
198 | string's pointer (`name', above) because it might get relocated. */ | |
bd601e2a KH |
199 | char *namebuf; |
200 | ||
3b83d631 GM |
201 | /* Glyph pool and matrix. */ |
202 | struct glyph_pool *current_pool; | |
203 | struct glyph_pool *desired_pool; | |
204 | struct glyph_matrix *desired_matrix; | |
205 | struct glyph_matrix *current_matrix; | |
206 | ||
207 | /* 1 means that glyphs on this frame have been initialized so it can | |
208 | be used for output. */ | |
209 | unsigned glyphs_initialized_p : 1; | |
21015f9c | 210 | |
e3d7bd83 DN |
211 | /* Set to non-zero in change_frame_size when size of frame changed |
212 | Clear the frame in clear_garbaged_frames if set. */ | |
213 | unsigned resized_p : 1; | |
214 | ||
215 | /* Set to non-zero in when we want for force a flush_display in | |
216 | update_frame, usually after resizing the frame. */ | |
217 | unsigned force_flush_display_p : 1; | |
218 | ||
219 | /* Set to non-zero if the default face for the frame has been | |
220 | realized. Reset to zero whenever the default face changes. | |
221 | Used to see the difference between a font change and face change. */ | |
222 | unsigned default_face_done_p : 1; | |
223 | ||
224 | /* Set to non-zero if this frame has already been hscrolled during | |
225 | current redisplay. */ | |
226 | unsigned already_hscrolled_p : 1; | |
227 | ||
228 | /* Set to non-zero when current redisplay has updated frame. */ | |
229 | unsigned updated_p : 1; | |
230 | ||
231 | /* Set to non-zero to minimize tool-bar height even when | |
232 | auto-resize-tool-bar is set to grow-only. */ | |
233 | unsigned minimize_tool_bar_window_p : 1; | |
234 | ||
9e2a2647 | 235 | #if defined (USE_GTK) || defined (HAVE_NS) |
488dd4c4 JD |
236 | /* Nonzero means using a tool bar that comes from the toolkit. */ |
237 | int external_tool_bar; | |
238 | #endif | |
239 | ||
9ea173e8 GM |
240 | /* Margin at the top of the frame. Used to display the tool-bar. */ |
241 | int tool_bar_lines; | |
3b83d631 | 242 | |
045cff16 | 243 | int n_tool_bar_rows; |
e3303a23 | 244 | int n_tool_bar_items; |
177c0ea7 | 245 | |
3b83d631 GM |
246 | /* A buffer for decode_mode_line. */ |
247 | char *decode_mode_spec_buffer; | |
21015f9c RS |
248 | |
249 | /* See do_line_insertion_deletion_costs for info on these arrays. */ | |
250 | /* Cost of inserting 1 line on this frame */ | |
251 | int *insert_line_cost; | |
252 | /* Cost of deleting 1 line on this frame */ | |
253 | int *delete_line_cost; | |
254 | /* Cost of inserting n lines on this frame */ | |
255 | int *insert_n_lines_cost; | |
256 | /* Cost of deleting n lines on this frame */ | |
257 | int *delete_n_lines_cost; | |
258 | ||
b45afe99 KS |
259 | /* Size of this frame, excluding fringes, scroll bars etc., |
260 | in units of canonical characters. */ | |
261 | EMACS_INT text_lines, text_cols; | |
262 | ||
263 | /* Total size of this frame (i.e. its native window), in units of | |
264 | canonical characters. */ | |
265 | EMACS_INT total_lines, total_cols; | |
266 | ||
267 | /* New text height and width for pending size change. | |
268 | 0 if no change pending. */ | |
269 | int new_text_lines, new_text_cols; | |
270 | ||
271 | /* Pixel position of the frame window (x and y offsets in root window). */ | |
272 | int left_pos, top_pos; | |
273 | ||
274 | /* Size of the frame window in pixels. */ | |
275 | int pixel_height, pixel_width; | |
276 | ||
adf494ff KH |
277 | /* Dots per inch of the screen the frame is on. */ |
278 | double resx, resy; | |
279 | ||
b45afe99 KS |
280 | /* These many pixels are the difference between the outer window (i.e. the |
281 | left and top of the window manager decoration) and FRAME_X_WINDOW. */ | |
282 | int x_pixels_diff, y_pixels_diff; | |
283 | ||
284 | /* This is the gravity value for the specified window position. */ | |
285 | int win_gravity; | |
286 | ||
287 | /* The geometry flags for this window. */ | |
288 | int size_hint_flags; | |
21015f9c | 289 | |
b45afe99 KS |
290 | /* Border width of the frame window as known by the (X) window system. */ |
291 | int border_width; | |
292 | ||
293 | /* Width of the internal border. This is a line of background color | |
294 | just inside the window's border. When the frame is selected, | |
295 | a highlighting is displayed inside the internal border. */ | |
296 | int internal_border_width; | |
297 | ||
298 | /* Canonical X unit. Width of default font, in pixels. */ | |
299 | int column_width; | |
300 | ||
40b1a3a9 | 301 | /* Width of space glyph of default font, in pixels. */ |
0fc63cc4 KH |
302 | int space_width; |
303 | ||
b45afe99 KS |
304 | /* Canonical Y unit. Height of a line, in pixels. */ |
305 | int line_height; | |
21015f9c | 306 | |
428a555e KL |
307 | /* The output method says how the contents of this frame are |
308 | displayed. It could be using termcap, or using an X window. | |
6ed8eeff | 309 | This must be the same as the terminal->type. */ |
efa4ce8b JB |
310 | enum output_method output_method; |
311 | ||
6ed8eeff | 312 | /* The terminal device that this frame uses. If this is NULL, then |
7e59217d | 313 | the frame has been deleted. */ |
6ed8eeff | 314 | struct terminal *terminal; |
63bb3d8e | 315 | |
7e59217d | 316 | /* Device-dependent, frame-local auxiliary data used for displaying |
428a555e KL |
317 | the contents. When the frame is deleted, this data is deleted as |
318 | well. */ | |
3b83d631 GM |
319 | union output_data |
320 | { | |
428a555e KL |
321 | struct tty_output *tty; /* termchar.h */ |
322 | struct x_output *x; /* xterm.h */ | |
323 | struct w32_output *w32; /* w32term.h */ | |
edfda783 | 324 | struct ns_output *ns; /* nsterm.h */ |
cf0fb540 | 325 | EMACS_INT nothing; |
3b83d631 GM |
326 | } |
327 | output_data; | |
efa4ce8b | 328 | |
adf494ff KH |
329 | /* List of font-drivers available on the frame. */ |
330 | struct font_driver_list *font_driver_list; | |
6aae9c92 KH |
331 | /* List of data specific to font-driver and frame, but common to |
332 | faces. */ | |
333 | struct font_data_list *font_data_list; | |
adf494ff | 334 | |
b45afe99 KS |
335 | /* Total width of fringes reserved for drawing truncation bitmaps, |
336 | continuation bitmaps and alike. The width is in canonical char | |
337 | units of the frame. This must currently be the case because window | |
338 | sizes aren't pixel values. If it weren't the case, we wouldn't be | |
339 | able to split windows horizontally nicely. */ | |
340 | int fringe_cols; | |
341 | ||
342 | /* The extra width (in pixels) currently allotted for fringes. */ | |
343 | int left_fringe_width, right_fringe_width; | |
344 | ||
b45afe99 | 345 | /* See FULLSCREEN_ enum below */ |
2806a183 | 346 | enum fullscreen_type want_fullscreen; |
b45afe99 | 347 | |
6d05db81 RS |
348 | /* Number of lines of menu bar. */ |
349 | int menu_bar_lines; | |
350 | ||
9e2a2647 | 351 | #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \ |
edfda783 | 352 | || defined (HAVE_NS) || defined (USE_GTK) |
9c95189b | 353 | /* Nonzero means using a menu bar that comes from the X toolkit. */ |
2806a183 | 354 | unsigned int external_menu_bar : 1; |
9c95189b RS |
355 | #endif |
356 | ||
ff11dfa1 | 357 | /* Nonzero if last attempt at redisplay on this frame was preempted. */ |
2806a183 | 358 | unsigned char display_preempted : 1; |
efa4ce8b | 359 | |
a4659527 JB |
360 | /* visible is nonzero if the frame is currently displayed; we check |
361 | it to see if we should bother updating the frame's contents. | |
46a5c487 | 362 | DON'T SET IT DIRECTLY; instead, use FRAME_SET_VISIBLE. |
efa4ce8b | 363 | |
20a6c8d7 JB |
364 | Note that, since invisible frames aren't updated, whenever a |
365 | frame becomes visible again, it must be marked as garbaged. The | |
366 | FRAME_SAMPLE_VISIBILITY macro takes care of this. | |
367 | ||
6548cf00 KL |
368 | On ttys and on Windows NT/9X, to avoid wasting effort updating |
369 | visible frames that are actually completely obscured by other | |
370 | windows on the display, we bend the meaning of visible slightly: | |
371 | if greater than 1, then the frame is obscured - we still consider | |
372 | it to be "visible" as seen from lisp, but we don't bother | |
373 | updating it. We must take care to garbage the frame when it | |
374 | ceaces to be obscured though. | |
0969b893 | 375 | |
a4659527 JB |
376 | iconified is nonzero if the frame is currently iconified. |
377 | ||
378 | Asynchronous input handlers should NOT change these directly; | |
379 | instead, they should change async_visible or async_iconified, and | |
380 | let the FRAME_SAMPLE_VISIBILITY macro set visible and iconified | |
381 | at the next redisplay. | |
382 | ||
383 | These should probably be considered read-only by everyone except | |
384 | FRAME_SAMPLE_VISIBILITY. | |
385 | ||
74cc2959 | 386 | These two are mutually exclusive. They might both be zero, if the |
a4659527 | 387 | frame has been made invisible without an icon. */ |
d4417eb0 | 388 | unsigned char visible : 2; |
2806a183 SM |
389 | unsigned char iconified : 1; |
390 | ||
391 | /* Let's not use bitfields for volatile variables. */ | |
a4659527 JB |
392 | |
393 | /* Asynchronous input handlers change these, and | |
394 | FRAME_SAMPLE_VISIBILITY copies them into visible and iconified. | |
395 | See FRAME_SAMPLE_VISIBILITY, below. */ | |
b975254e | 396 | volatile char async_visible, async_iconified; |
efa4ce8b | 397 | |
ff11dfa1 | 398 | /* Nonzero if this frame should be redrawn. */ |
b975254e | 399 | volatile char garbaged; |
efa4ce8b | 400 | |
ff11dfa1 JB |
401 | /* True if frame actually has a minibuffer window on it. |
402 | 0 if using a minibuffer window that isn't on this frame. */ | |
2806a183 | 403 | unsigned char has_minibuffer : 1; |
177c0ea7 | 404 | |
ff11dfa1 | 405 | /* 0 means, if this frame has just one window, |
efa4ce8b | 406 | show no modeline for that window. */ |
2806a183 | 407 | unsigned char wants_modeline : 1; |
efa4ce8b | 408 | |
46a5c487 | 409 | /* Non-zero if the hardware device this frame is displaying on can |
a3c87d4e JB |
410 | support scroll bars. */ |
411 | char can_have_scroll_bars; | |
46a5c487 | 412 | |
ff11dfa1 | 413 | /* Non-0 means raise this frame to the top of the heap when selected. */ |
2806a183 | 414 | unsigned char auto_raise : 1; |
efa4ce8b | 415 | |
ff11dfa1 | 416 | /* Non-0 means lower this frame to the bottom of the stack when left. */ |
2806a183 | 417 | unsigned char auto_lower : 1; |
efa4ce8b | 418 | |
ff11dfa1 | 419 | /* True if frame's root window can't be split. */ |
2806a183 | 420 | unsigned char no_split : 1; |
efa4ce8b | 421 | |
fbfed6f0 JB |
422 | /* If this is set, then Emacs won't change the frame name to indicate |
423 | the current buffer, etcetera. If the user explicitly sets the frame | |
424 | name, this gets set. If the user sets the name to Qnil, this is | |
425 | cleared. */ | |
2806a183 | 426 | unsigned char explicit_name : 1; |
fbfed6f0 | 427 | |
adc12f0f | 428 | /* Nonzero if size of some window on this frame has changed. */ |
2806a183 | 429 | unsigned char window_sizes_changed : 1; |
adc12f0f | 430 | |
e3d7bd83 DN |
431 | /* Nonzero if the mouse has moved on this display device |
432 | since the last time we checked. */ | |
2806a183 | 433 | unsigned char mouse_moved :1; |
e3d7bd83 | 434 | |
e044e4fc JD |
435 | /* Nonzero means that the pointer is invisible. */ |
436 | unsigned char pointer_invisible :1; | |
437 | ||
e3d7bd83 DN |
438 | /* If can_have_scroll_bars is non-zero, this is non-zero if we should |
439 | actually display them on this frame. */ | |
440 | enum vertical_scroll_bar_type vertical_scroll_bar_type; | |
441 | ||
442 | /* What kind of text cursor should we draw in the future? | |
443 | This should always be filled_box_cursor or bar_cursor. */ | |
444 | enum text_cursor_kinds desired_cursor; | |
445 | ||
446 | /* Width of bar cursor (if we are using that). */ | |
447 | int cursor_width; | |
448 | ||
449 | /* What kind of text cursor should we draw when the cursor blinks off? | |
450 | This can be filled_box_cursor or bar_cursor or no_cursor. */ | |
451 | enum text_cursor_kinds blink_off_cursor; | |
452 | ||
453 | /* Width of bar cursor (if we are using that) for blink-off state. */ | |
454 | int blink_off_cursor_width; | |
455 | ||
ff11dfa1 | 456 | /* Storage for messages to this frame. */ |
efa4ce8b JB |
457 | char *message_buf; |
458 | ||
459 | /* Nonnegative if current redisplay should not do scroll computation | |
460 | for lines beyond a certain vpos. This is the vpos. */ | |
461 | int scroll_bottom_vpos; | |
8d6de7ce | 462 | |
b45afe99 KS |
463 | /* Configured width of the scroll bar, in pixels and in characters. |
464 | config_scroll_bar_cols tracks config_scroll_bar_width if the | |
465 | latter is positive; a zero value in config_scroll_bar_width means | |
466 | to compute the actual width on the fly, using config_scroll_bar_cols | |
467 | and the current font width. */ | |
468 | int config_scroll_bar_width; | |
469 | int config_scroll_bar_cols; | |
470 | ||
471 | /* The size of the extra width currently allotted for vertical | |
472 | scroll bars in this frame, in pixels. */ | |
473 | int scroll_bar_actual_width; | |
95b999aa RS |
474 | |
475 | /* The baud rate that was used to calculate costs for this frame. */ | |
476 | int cost_calculation_baud_rate; | |
6462918c | 477 | |
91a47a68 DN |
478 | /* frame opacity |
479 | alpha[0]: alpha transparency of the active frame | |
f2d5c00f CY |
480 | alpha[1]: alpha transparency of inactive frames |
481 | Negative values mean not to change alpha. */ | |
91a47a68 DN |
482 | double alpha[2]; |
483 | ||
b61cbba3 GM |
484 | /* Exponent for gamma correction of colors. 1/(VIEWING_GAMMA * |
485 | SCREEN_GAMMA) where viewing_gamma is 0.4545 and SCREEN_GAMMA is a | |
486 | frame parameter. 0 means don't do gamma correction. */ | |
487 | double gamma; | |
d1738c45 GM |
488 | |
489 | /* Additional space to put between text lines on this frame. */ | |
490 | int extra_line_spacing; | |
f1c69c61 | 491 | |
28d7d09f KL |
492 | /* All display backends seem to need these two pixel values. */ |
493 | unsigned long background_pixel; | |
494 | unsigned long foreground_pixel; | |
efa4ce8b JB |
495 | }; |
496 | ||
6ed8eeff | 497 | #define FRAME_KBOARD(f) ((f)->terminal->kboard) |
37ea66e1 | 498 | |
354884c4 SM |
499 | /* Return a pointer to the image cache of frame F. */ |
500 | #define FRAME_IMAGE_CACHE(F) ((F)->terminal->image_cache) | |
501 | ||
ff11dfa1 JB |
502 | typedef struct frame *FRAME_PTR; |
503 | ||
8e50cc2d | 504 | #define XFRAME(p) (eassert (FRAMEP(p)),(struct frame *) XPNTR (p)) |
aac03cca | 505 | #define XSETFRAME(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_FRAME)) |
ff11dfa1 | 506 | |
cea6021b | 507 | /* Given a window, return its frame as a Lisp_Object. */ |
ff11dfa1 JB |
508 | #define WINDOW_FRAME(w) (w)->frame |
509 | ||
cea6021b | 510 | /* Test a frame for particular kinds of display methods. */ |
3224dac1 | 511 | #define FRAME_INITIAL_P(f) ((f)->output_method == output_initial) |
cea6021b | 512 | #define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap) |
efa7f0f9 | 513 | #define FRAME_X_P(f) ((f)->output_method == output_x_window) |
fbd6baed | 514 | #define FRAME_W32_P(f) ((f)->output_method == output_w32) |
6f181713 | 515 | #define FRAME_MSDOS_P(f) ((f)->output_method == output_msdos_raw) |
0e015153 | 516 | #define FRAME_MAC_P(f) ((f)->output_method == output_mac) |
edfda783 | 517 | #define FRAME_NS_P(f) ((f)->output_method == output_ns) |
efa7f0f9 GV |
518 | |
519 | /* FRAME_WINDOW_P tests whether the frame is a window, and is | |
520 | defined to be the predicate for the window system being used. */ | |
3b83d631 | 521 | |
efa7f0f9 GV |
522 | #ifdef HAVE_X_WINDOWS |
523 | #define FRAME_WINDOW_P(f) FRAME_X_P (f) | |
524 | #endif | |
525 | #ifdef HAVE_NTGUI | |
fbd6baed | 526 | #define FRAME_WINDOW_P(f) FRAME_W32_P (f) |
efa7f0f9 | 527 | #endif |
edfda783 AR |
528 | #ifdef HAVE_NS |
529 | #define FRAME_WINDOW_P(f) FRAME_NS_P(f) | |
530 | #endif | |
7651b07e RS |
531 | #ifndef FRAME_WINDOW_P |
532 | #define FRAME_WINDOW_P(f) (0) | |
533 | #endif | |
efa7f0f9 | 534 | |
7ea692f6 EZ |
535 | /* Return a pointer to the structure holding information about the |
536 | region of text, if any, that is currently shown in mouse-face on | |
8e5ba371 EZ |
537 | frame F. We need to define two versions because a TTY-only build |
538 | does not have FRAME_X_DISPLAY_INFO. */ | |
539 | #ifdef HAVE_WINDOW_SYSTEM | |
540 | # define MOUSE_HL_INFO(F) \ | |
541 | (FRAME_WINDOW_P(F) \ | |
542 | ? &(FRAME_X_DISPLAY_INFO(F)->mouse_highlight) \ | |
543 | : &(((F)->output_data.tty->display_info)->mouse_highlight)) | |
544 | #else | |
545 | # define MOUSE_HL_INFO(F) \ | |
546 | (&(((F)->output_data.tty->display_info)->mouse_highlight)) | |
547 | #endif | |
7ea692f6 | 548 | |
cea6021b | 549 | /* Nonzero if frame F is still alive (not deleted). */ |
6ed8eeff | 550 | #define FRAME_LIVE_P(f) ((f)->terminal != 0) |
cea6021b RS |
551 | |
552 | /* Nonzero if frame F is a minibuffer-only frame. */ | |
ff11dfa1 JB |
553 | #define FRAME_MINIBUF_ONLY_P(f) \ |
554 | EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f)) | |
cea6021b RS |
555 | |
556 | /* Nonzero if frame F contains a minibuffer window. | |
557 | (If this is 0, F must use some other minibuffer window.) */ | |
10a4cc63 | 558 | #define FRAME_HAS_MINIBUF_P(f) ((f)->has_minibuffer) |
cea6021b | 559 | |
b45afe99 KS |
560 | /* Pixel height of frame F, including non-toolkit menu bar and |
561 | non-toolkit tool bar lines. */ | |
562 | #define FRAME_PIXEL_HEIGHT(f) ((f)->pixel_height) | |
563 | ||
564 | /* Pixel width of frame F. */ | |
565 | #define FRAME_PIXEL_WIDTH(f) ((f)->pixel_width) | |
566 | ||
567 | /* Height of frame F, measured in canonical lines, including | |
568 | non-toolkit menu bar and non-toolkit tool bar lines. */ | |
569 | #define FRAME_LINES(f) (f)->text_lines | |
570 | ||
571 | /* Width of frame F, measured in canonical character columns, | |
cea6021b | 572 | not including scroll bars if any. */ |
b45afe99 | 573 | #define FRAME_COLS(f) (f)->text_cols |
cea6021b RS |
574 | |
575 | /* Number of lines of frame F used for menu bar. | |
576 | This is relevant on terminal frames and on | |
577 | X Windows when not using the X toolkit. | |
b45afe99 | 578 | These lines are counted in FRAME_LINES. */ |
6d05db81 | 579 | #define FRAME_MENU_BAR_LINES(f) (f)->menu_bar_lines |
cea6021b | 580 | |
488dd4c4 JD |
581 | /* Nonzero if this frame should display a tool bar |
582 | in a way that does not use any text lines. */ | |
9e2a2647 | 583 | #if defined (USE_GTK) || defined (HAVE_NS) |
488dd4c4 JD |
584 | #define FRAME_EXTERNAL_TOOL_BAR(f) (f)->external_tool_bar |
585 | #else | |
586 | #define FRAME_EXTERNAL_TOOL_BAR(f) 0 | |
587 | #endif | |
588 | ||
9ea173e8 | 589 | /* Number of lines of frame F used for the tool-bar. */ |
3b83d631 | 590 | |
9ea173e8 | 591 | #define FRAME_TOOL_BAR_LINES(f) (f)->tool_bar_lines |
3b83d631 | 592 | |
488dd4c4 | 593 | |
3b83d631 GM |
594 | /* Lines above the top-most window in frame F. */ |
595 | ||
596 | #define FRAME_TOP_MARGIN(F) \ | |
9ea173e8 | 597 | (FRAME_MENU_BAR_LINES (F) + FRAME_TOOL_BAR_LINES (F)) |
3b83d631 | 598 | |
4b00d3b1 YM |
599 | /* Pixel height of the top margin above. */ |
600 | ||
601 | #define FRAME_TOP_MARGIN_HEIGHT(f) \ | |
602 | (FRAME_TOP_MARGIN (f) * FRAME_LINE_HEIGHT (f)) | |
603 | ||
cea6021b RS |
604 | /* Nonzero if this frame should display a menu bar |
605 | in a way that does not use any text lines. */ | |
9e2a2647 | 606 | #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \ |
edfda783 | 607 | || defined (HAVE_NS) || defined (USE_GTK) |
9c95189b | 608 | #define FRAME_EXTERNAL_MENU_BAR(f) (f)->external_menu_bar |
4c8888a0 RS |
609 | #else |
610 | #define FRAME_EXTERNAL_MENU_BAR(f) 0 | |
611 | #endif | |
46a5c487 | 612 | #define FRAME_VISIBLE_P(f) ((f)->visible != 0) |
cea6021b RS |
613 | |
614 | /* Nonzero if frame F is currently visible but hidden. */ | |
0969b893 | 615 | #define FRAME_OBSCURED_P(f) ((f)->visible > 1) |
cea6021b RS |
616 | |
617 | /* Nonzero if frame F is currently iconified. */ | |
618 | #define FRAME_ICONIFIED_P(f) (f)->iconified | |
619 | ||
46a5c487 JB |
620 | #define FRAME_SET_VISIBLE(f,p) \ |
621 | ((f)->async_visible = (p), FRAME_SAMPLE_VISIBILITY (f)) | |
ff11dfa1 JB |
622 | #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1, f->garbaged = 1) |
623 | #define FRAME_GARBAGED_P(f) (f)->garbaged | |
cea6021b RS |
624 | |
625 | /* Nonzero means do not allow splitting this frame's window. */ | |
ff11dfa1 | 626 | #define FRAME_NO_SPLIT_P(f) (f)->no_split |
cea6021b RS |
627 | |
628 | /* Not really implemented. */ | |
ff11dfa1 | 629 | #define FRAME_WANTS_MODELINE_P(f) (f)->wants_modeline |
cea6021b RS |
630 | |
631 | /* Nonzero if a size change has been requested for frame F | |
632 | but not yet really put into effect. This can be true temporarily | |
633 | when an X event comes in at a bad time. */ | |
adc12f0f | 634 | #define FRAME_WINDOW_SIZES_CHANGED(f) (f)->window_sizes_changed |
cea6021b RS |
635 | |
636 | /* The minibuffer window of frame F, if it has one; otherwise nil. */ | |
ff11dfa1 | 637 | #define FRAME_MINIBUF_WINDOW(f) (f)->minibuffer_window |
cea6021b RS |
638 | |
639 | /* The root window of the window tree of frame F. */ | |
ff11dfa1 | 640 | #define FRAME_ROOT_WINDOW(f) (f)->root_window |
cea6021b RS |
641 | |
642 | /* The currently selected window of the window tree of frame F. */ | |
ff11dfa1 | 643 | #define FRAME_SELECTED_WINDOW(f) (f)->selected_window |
cea6021b | 644 | |
177c0ea7 JB |
645 | #define FRAME_INSERT_COST(f) (f)->insert_line_cost |
646 | #define FRAME_DELETE_COST(f) (f)->delete_line_cost | |
ff11dfa1 JB |
647 | #define FRAME_INSERTN_COST(f) (f)->insert_n_lines_cost |
648 | #define FRAME_DELETEN_COST(f) (f)->delete_n_lines_cost | |
649 | #define FRAME_MESSAGE_BUF(f) (f)->message_buf | |
650 | #define FRAME_SCROLL_BOTTOM_VPOS(f) (f)->scroll_bottom_vpos | |
651 | #define FRAME_FOCUS_FRAME(f) (f)->focus_frame | |
cea6021b RS |
652 | |
653 | /* Nonzero if frame F supports scroll bars. | |
654 | If this is zero, then it is impossible to enable scroll bars | |
655 | on frame F. */ | |
a3c87d4e | 656 | #define FRAME_CAN_HAVE_SCROLL_BARS(f) ((f)->can_have_scroll_bars) |
cea6021b RS |
657 | |
658 | /* This frame slot says whether scroll bars are currently enabled for frame F, | |
659 | and which side they are on. */ | |
a3211441 RS |
660 | #define FRAME_VERTICAL_SCROLL_BAR_TYPE(f) ((f)->vertical_scroll_bar_type) |
661 | #define FRAME_HAS_VERTICAL_SCROLL_BARS(f) \ | |
662 | ((f)->vertical_scroll_bar_type != vertical_scroll_bar_none) | |
663 | #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT(f) \ | |
664 | ((f)->vertical_scroll_bar_type == vertical_scroll_bar_left) | |
665 | #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT(f) \ | |
666 | ((f)->vertical_scroll_bar_type == vertical_scroll_bar_right) | |
cea6021b RS |
667 | |
668 | /* Width that a scroll bar in frame F should have, if there is one. | |
669 | Measured in pixels. | |
670 | If scroll bars are turned off, this is still nonzero. */ | |
b45afe99 | 671 | #define FRAME_CONFIG_SCROLL_BAR_WIDTH(f) ((f)->config_scroll_bar_width) |
cea6021b RS |
672 | |
673 | /* Width that a scroll bar in frame F should have, if there is one. | |
674 | Measured in columns (characters). | |
675 | If scroll bars are turned off, this is still nonzero. */ | |
b45afe99 | 676 | #define FRAME_CONFIG_SCROLL_BAR_COLS(f) ((f)->config_scroll_bar_cols) |
cea6021b RS |
677 | |
678 | /* Width of a scroll bar in frame F, measured in columns (characters), | |
7d81cf83 GM |
679 | but only if scroll bars are on the left. If scroll bars are on |
680 | the right in this frame, or there are no scroll bars, value is 0. */ | |
681 | ||
b45afe99 | 682 | #define FRAME_LEFT_SCROLL_BAR_COLS(f) \ |
7d81cf83 | 683 | (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \ |
b45afe99 | 684 | ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \ |
7d81cf83 GM |
685 | : 0) |
686 | ||
b45afe99 KS |
687 | /* Width of a left scroll bar in frame F, measured in pixels */ |
688 | ||
689 | #define FRAME_LEFT_SCROLL_BAR_AREA_WIDTH(f) \ | |
690 | (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \ | |
691 | ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)) \ | |
692 | : 0) | |
693 | ||
7d81cf83 GM |
694 | /* Width of a scroll bar in frame F, measured in columns (characters), |
695 | but only if scroll bars are on the right. If scroll bars are on | |
696 | the left in this frame, or there are no scroll bars, value is 0. */ | |
697 | ||
b45afe99 | 698 | #define FRAME_RIGHT_SCROLL_BAR_COLS(f) \ |
7d81cf83 | 699 | (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f) \ |
b45afe99 | 700 | ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \ |
a3211441 | 701 | : 0) |
cea6021b | 702 | |
b45afe99 KS |
703 | /* Width of a right scroll bar area in frame F, measured in pixels */ |
704 | ||
705 | #define FRAME_RIGHT_SCROLL_BAR_AREA_WIDTH(f) \ | |
706 | (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f) \ | |
707 | ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)) \ | |
708 | : 0) | |
709 | ||
710 | /* Actual width of a scroll bar in frame F, measured in columns. */ | |
711 | ||
712 | #define FRAME_SCROLL_BAR_COLS(f) \ | |
713 | (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \ | |
714 | ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \ | |
a3211441 | 715 | : 0) |
cea6021b | 716 | |
b45afe99 KS |
717 | /* Actual width of a scroll bar area in frame F, measured in pixels. */ |
718 | ||
719 | #define FRAME_SCROLL_BAR_AREA_WIDTH(f) \ | |
720 | (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \ | |
721 | ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)) \ | |
722 | : 0) | |
723 | ||
cea6021b RS |
724 | /* Total width of frame F, in columns (characters), |
725 | including the width used by scroll bars if any. */ | |
b45afe99 KS |
726 | |
727 | #define FRAME_TOTAL_COLS(f) ((f)->total_cols) | |
cea6021b RS |
728 | |
729 | /* Set the width of frame F to VAL. | |
730 | VAL is the width of a full-frame window, | |
b45afe99 KS |
731 | not including scroll bars and fringes. */ |
732 | ||
733 | #define SET_FRAME_COLS(f, val) \ | |
734 | (FRAME_COLS (f) = (val), \ | |
735 | (f)->total_cols = FRAME_TOTAL_COLS_ARG (f, FRAME_COLS (f))) | |
cea6021b RS |
736 | |
737 | /* Given a value WIDTH for frame F's nominal width, | |
b45afe99 KS |
738 | return the value that FRAME_TOTAL_COLS should have. */ |
739 | ||
740 | #define FRAME_TOTAL_COLS_ARG(f, width) \ | |
3b83d631 | 741 | ((width) \ |
b45afe99 | 742 | + FRAME_SCROLL_BAR_COLS (f) \ |
986f10ad | 743 | + FRAME_FRINGE_COLS (f)) |
cea6021b | 744 | |
4ff34795 | 745 | /* Maximum + 1 legitimate value for FRAME_CURSOR_X. */ |
b45afe99 | 746 | |
4ff34795 | 747 | #define FRAME_CURSOR_X_LIMIT(f) \ |
b45afe99 | 748 | (FRAME_COLS (f) + FRAME_LEFT_SCROLL_BAR_COLS (f)) |
cea6021b RS |
749 | |
750 | /* Nonzero if frame F has scroll bars. */ | |
b45afe99 | 751 | |
a3c87d4e | 752 | #define FRAME_SCROLL_BARS(f) ((f)->scroll_bars) |
cea6021b | 753 | |
a3c87d4e | 754 | #define FRAME_CONDEMNED_SCROLL_BARS(f) ((f)->condemned_scroll_bars) |
6d05db81 | 755 | #define FRAME_MENU_BAR_ITEMS(f) ((f)->menu_bar_items) |
95b999aa | 756 | #define FRAME_COST_BAUD_RATE(f) ((f)->cost_calculation_baud_rate) |
81d00831 | 757 | |
4d418fcc KS |
758 | #define FRAME_DESIRED_CURSOR(f) ((f)->desired_cursor) |
759 | #define FRAME_BLINK_OFF_CURSOR(f) ((f)->blink_off_cursor) | |
760 | #define FRAME_CURSOR_WIDTH(f) ((f)->cursor_width) | |
761 | #define FRAME_BLINK_OFF_CURSOR_WIDTH(f) ((f)->blink_off_cursor_width) | |
762 | ||
3b83d631 GM |
763 | /* Return a pointer to the face cache of frame F. */ |
764 | ||
765 | #define FRAME_FACE_CACHE(F) (F)->face_cache | |
766 | ||
81d00831 KH |
767 | /* Return the size of message_buf of the frame F. We multiply the |
768 | width of the frame by 4 because multi-byte form may require at most | |
769 | 4-byte for a character. */ | |
177c0ea7 | 770 | |
b45afe99 | 771 | #define FRAME_MESSAGE_BUF_SIZE(f) (((int) FRAME_COLS (f)) * 4) |
ff11dfa1 | 772 | |
a4659527 JB |
773 | /* Emacs's redisplay code could become confused if a frame's |
774 | visibility changes at arbitrary times. For example, if a frame is | |
775 | visible while the desired glyphs are being built, but becomes | |
776 | invisible before they are updated, then some rows of the | |
777 | desired_glyphs will be left marked as enabled after redisplay is | |
778 | complete, which should never happen. The next time the frame | |
779 | becomes visible, redisplay will probably barf. | |
780 | ||
781 | Currently, there are no similar situations involving iconified, but | |
782 | the principle is the same. | |
783 | ||
784 | So instead of having asynchronous input handlers directly set and | |
785 | clear the frame's visibility and iconification flags, they just set | |
786 | the async_visible and async_iconified flags; the redisplay code | |
787 | calls the FRAME_SAMPLE_VISIBILITY macro before doing any redisplay, | |
788 | which sets visible and iconified from their asynchronous | |
46a5c487 JB |
789 | counterparts. |
790 | ||
20a6c8d7 JB |
791 | Synchronous code must use the FRAME_SET_VISIBLE macro. |
792 | ||
793 | Also, if a frame used to be invisible, but has just become visible, | |
794 | it must be marked as garbaged, since redisplay hasn't been keeping | |
9628b887 KL |
795 | up its contents. |
796 | ||
797 | Note that a tty frame is visible if and only if it is the topmost | |
798 | frame. */ | |
177c0ea7 | 799 | |
a4659527 | 800 | #define FRAME_SAMPLE_VISIBILITY(f) \ |
0969b893 GV |
801 | (((f)->async_visible && (f)->visible != (f)->async_visible) ? \ |
802 | SET_FRAME_GARBAGED (f) : 0, \ | |
20a6c8d7 | 803 | (f)->visible = (f)->async_visible, \ |
a4659527 JB |
804 | (f)->iconified = (f)->async_iconified) |
805 | ||
915a3e00 KS |
806 | #define CHECK_FRAME(x) \ |
807 | CHECK_TYPE (FRAMEP (x), Qframep, x) | |
808 | ||
809 | #define CHECK_LIVE_FRAME(x) \ | |
810 | CHECK_TYPE (FRAMEP (x) && FRAME_LIVE_P (XFRAME (x)), Qframe_live_p, x) | |
265a9e55 | 811 | |
ff11dfa1 JB |
812 | /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a |
813 | `for' loop which iterates over the elements of Vframe_list. The | |
35f56f96 | 814 | loop will set FRAME_VAR, a Lisp_Object, to each frame in |
ff11dfa1 | 815 | Vframe_list in succession and execute the statement. LIST_VAR |
35f56f96 | 816 | should be a Lisp_Object too; it is used to iterate through the |
177c0ea7 | 817 | Vframe_list. |
e5d77022 | 818 | |
e3678b64 KH |
819 | This macro is a holdover from a time when multiple frames weren't always |
820 | supported. An alternate definition of the macro would expand to | |
821 | something which executes the statement once. */ | |
3b83d631 | 822 | |
ff11dfa1 JB |
823 | #define FOR_EACH_FRAME(list_var, frame_var) \ |
824 | for ((list_var) = Vframe_list; \ | |
e5d77022 | 825 | (CONSP (list_var) \ |
ee88f64d KR |
826 | && (frame_var = XCAR (list_var), 1)); \ |
827 | list_var = XCDR (list_var)) | |
e5d77022 JB |
828 | |
829 | ||
5e02ce11 | 830 | extern Lisp_Object Qframep, Qframe_live_p; |
2666355c | 831 | extern Lisp_Object Qtty, Qtty_type; |
8848b728 | 832 | extern Lisp_Object Qtty_color_mode; |
6ed8eeff | 833 | extern Lisp_Object Qterminal, Qterminal_live_p; |
c53956fe | 834 | extern Lisp_Object Qnoelisp; |
efa4ce8b | 835 | |
ff11dfa1 | 836 | extern struct frame *last_nonminibuf_frame; |
efa4ce8b | 837 | |
0ff162fc | 838 | extern void set_menu_bar_lines (struct frame *, Lisp_Object, Lisp_Object); |
383e0970 | 839 | extern struct frame *make_initial_frame (void); |
383e0970 | 840 | extern struct frame *make_frame (int); |
c9e5d3d1 | 841 | #ifdef HAVE_WINDOW_SYSTEM |
383e0970 J |
842 | extern struct frame *make_minibuffer_frame (void); |
843 | extern struct frame *make_frame_without_minibuffer (Lisp_Object, | |
844 | struct kboard *, | |
845 | Lisp_Object); | |
c9e5d3d1 | 846 | #endif /* HAVE_WINDOW_SYSTEM */ |
383e0970 J |
847 | extern int other_visible_frames (struct frame *); |
848 | extern void frame_make_pointer_invisible (void); | |
849 | extern void frame_make_pointer_visible (void); | |
850 | extern Lisp_Object delete_frame (Lisp_Object, Lisp_Object); | |
efa4ce8b | 851 | |
ff11dfa1 | 852 | extern Lisp_Object Vframe_list; |
efa4ce8b | 853 | \f |
650afd94 GM |
854 | /* The currently selected frame. */ |
855 | ||
856 | extern Lisp_Object selected_frame; | |
857 | ||
858 | /* Value is a pointer to the selected frame. If the selected frame | |
b975254e | 859 | isn't live, abort. */ |
650afd94 GM |
860 | |
861 | #define SELECTED_FRAME() \ | |
862 | ((FRAMEP (selected_frame) \ | |
863 | && FRAME_LIVE_P (XFRAME (selected_frame))) \ | |
864 | ? XFRAME (selected_frame) \ | |
e1ef1fb2 | 865 | : (abort (), (struct frame *) 0)) |
3b83d631 GM |
866 | |
867 | \f | |
868 | /*********************************************************************** | |
869 | Display-related Macros | |
870 | ***********************************************************************/ | |
871 | ||
d3378f02 | 872 | /* Canonical y-unit on frame F. |
b45afe99 KS |
873 | This value currently equals the line height of the frame (which is |
874 | the height of the default font of F). */ | |
875 | ||
876 | #define FRAME_LINE_HEIGHT(F) ((F)->line_height) | |
3b83d631 | 877 | |
d3378f02 | 878 | /* Canonical x-unit on frame F. |
0fc63cc4 | 879 | This value currently equals the average width of the default font of F. */ |
3b83d631 | 880 | |
b45afe99 | 881 | #define FRAME_COLUMN_WIDTH(F) ((F)->column_width) |
3b83d631 | 882 | |
0fc63cc4 KH |
883 | /* Space glyph width of the default font of frame F. */ |
884 | ||
885 | #define FRAME_SPACE_WIDTH(F) ((F)->space_width) | |
886 | ||
3b83d631 GM |
887 | |
888 | /* Pixel width of areas used to display truncation marks, continuation | |
5cb26370 | 889 | marks, overlay arrows. This is 0 for terminal frames. */ |
3b83d631 GM |
890 | |
891 | #ifdef HAVE_WINDOW_SYSTEM | |
aa5b8e15 | 892 | |
b45afe99 KS |
893 | /* Total width of fringes reserved for drawing truncation bitmaps, |
894 | continuation bitmaps and alike. The width is in canonical char | |
895 | units of the frame. This must currently be the case because window | |
896 | sizes aren't pixel values. If it weren't the case, we wouldn't be | |
897 | able to split windows horizontally nicely. */ | |
898 | ||
899 | #define FRAME_FRINGE_COLS(F) ((F)->fringe_cols) | |
900 | ||
901 | /* Pixel-width of the left and right fringe. */ | |
902 | ||
903 | #define FRAME_LEFT_FRINGE_WIDTH(F) ((F)->left_fringe_width) | |
904 | #define FRAME_RIGHT_FRINGE_WIDTH(F) ((F)->right_fringe_width) | |
905 | ||
906 | /* Total width of fringes in pixels. */ | |
907 | ||
908 | #define FRAME_TOTAL_FRINGE_WIDTH(F) \ | |
909 | (FRAME_LEFT_FRINGE_WIDTH (F) + FRAME_RIGHT_FRINGE_WIDTH (F)) | |
910 | ||
911 | ||
912 | /* Pixel-width of internal border lines */ | |
913 | ||
914 | #define FRAME_INTERNAL_BORDER_WIDTH(F) ((F)->internal_border_width) | |
177c0ea7 | 915 | |
aa5b8e15 GM |
916 | #else /* not HAVE_WINDOW_SYSTEM */ |
917 | ||
986f10ad | 918 | #define FRAME_FRINGE_COLS(F) 0 |
b45afe99 | 919 | #define FRAME_TOTAL_FRINGE_WIDTH(F) 0 |
986f10ad | 920 | #define FRAME_LEFT_FRINGE_WIDTH(F) 0 |
8432bb78 | 921 | #define FRAME_RIGHT_FRINGE_WIDTH(F) 0 |
b45afe99 | 922 | #define FRAME_INTERNAL_BORDER_WIDTH(F) 0 |
aa5b8e15 GM |
923 | |
924 | #endif /* not HAVE_WINDOW_SYSTEM */ | |
177c0ea7 | 925 | |
3b83d631 GM |
926 | |
927 | ||
928 | \f | |
929 | /*********************************************************************** | |
930 | Conversion between canonical units and pixels | |
931 | ***********************************************************************/ | |
932 | ||
b45afe99 KS |
933 | /* Canonical x-values are fractions of FRAME_COLUMN_WIDTH, canonical |
934 | y-unit are fractions of FRAME_LINE_HEIGHT of a frame. Both are | |
935 | represented as Lisp numbers, i.e. integers or floats. */ | |
3b83d631 GM |
936 | |
937 | /* Convert canonical value X to pixels. F is the frame whose | |
938 | canonical char width is to be used. X must be a Lisp integer or | |
939 | float. Value is a C integer. */ | |
177c0ea7 | 940 | |
b45afe99 | 941 | #define FRAME_PIXEL_X_FROM_CANON_X(F, X) \ |
3b83d631 | 942 | (INTEGERP (X) \ |
b45afe99 KS |
943 | ? XINT (X) * FRAME_COLUMN_WIDTH (F) \ |
944 | : (int) (XFLOAT_DATA (X) * FRAME_COLUMN_WIDTH (F))) | |
177c0ea7 | 945 | |
3b83d631 GM |
946 | /* Convert canonical value Y to pixels. F is the frame whose |
947 | canonical character height is to be used. X must be a Lisp integer | |
948 | or float. Value is a C integer. */ | |
177c0ea7 | 949 | |
b45afe99 | 950 | #define FRAME_PIXEL_Y_FROM_CANON_Y(F, Y) \ |
3b83d631 | 951 | (INTEGERP (Y) \ |
b45afe99 KS |
952 | ? XINT (Y) * FRAME_LINE_HEIGHT (F) \ |
953 | : (int) (XFLOAT_DATA (Y) * FRAME_LINE_HEIGHT (F))) | |
3b83d631 GM |
954 | |
955 | /* Convert pixel-value X to canonical units. F is the frame whose | |
956 | canonical character width is to be used. X is a C integer. Result | |
957 | is a Lisp float if X is not a multiple of the canon width, | |
958 | otherwise it's a Lisp integer. */ | |
959 | ||
b45afe99 KS |
960 | #define FRAME_CANON_X_FROM_PIXEL_X(F, X) \ |
961 | ((X) % FRAME_COLUMN_WIDTH (F) != 0 \ | |
962 | ? make_float ((double) (X) / FRAME_COLUMN_WIDTH (F)) \ | |
963 | : make_number ((X) / FRAME_COLUMN_WIDTH (F))) | |
3b83d631 GM |
964 | |
965 | /* Convert pixel-value Y to canonical units. F is the frame whose | |
966 | canonical character height is to be used. Y is a C integer. | |
967 | Result is a Lisp float if Y is not a multiple of the canon width, | |
968 | otherwise it's a Lisp integer. */ | |
969 | ||
b45afe99 KS |
970 | #define FRAME_CANON_Y_FROM_PIXEL_Y(F, Y) \ |
971 | ((Y) % FRAME_LINE_HEIGHT (F) \ | |
972 | ? make_float ((double) (Y) / FRAME_LINE_HEIGHT (F)) \ | |
973 | : make_number ((Y) / FRAME_LINE_HEIGHT (F))) | |
974 | ||
975 | ||
976 | \f | |
977 | /* Manipulating pixel sizes and character sizes. | |
978 | Knowledge of which factors affect the overall size of the window should | |
979 | be hidden in these macros, if that's possible. | |
980 | ||
981 | Return the upper/left pixel position of the character cell on frame F | |
982 | at ROW/COL. */ | |
983 | ||
984 | #define FRAME_LINE_TO_PIXEL_Y(f, row) \ | |
16009a0e | 985 | (((row) < FRAME_TOP_MARGIN (f) ? 0 : FRAME_INTERNAL_BORDER_WIDTH (f)) \ |
b45afe99 KS |
986 | + (row) * FRAME_LINE_HEIGHT (f)) |
987 | ||
988 | #define FRAME_COL_TO_PIXEL_X(f, col) \ | |
989 | (FRAME_INTERNAL_BORDER_WIDTH (f) \ | |
990 | + (col) * FRAME_COLUMN_WIDTH (f)) | |
991 | ||
992 | /* Return the pixel width/height of frame F if it has | |
993 | COLS columns/LINES rows. */ | |
994 | ||
995 | #define FRAME_TEXT_COLS_TO_PIXEL_WIDTH(f, cols) \ | |
996 | (FRAME_COL_TO_PIXEL_X (f, cols) \ | |
997 | + (f)->scroll_bar_actual_width \ | |
998 | + FRAME_TOTAL_FRINGE_WIDTH (f) \ | |
999 | + FRAME_INTERNAL_BORDER_WIDTH (f)) | |
1000 | ||
1001 | #define FRAME_TEXT_LINES_TO_PIXEL_HEIGHT(f, lines) \ | |
f016f225 JD |
1002 | ((lines) * FRAME_LINE_HEIGHT (f) \ |
1003 | + 2 * FRAME_INTERNAL_BORDER_WIDTH (f)) | |
b45afe99 KS |
1004 | |
1005 | ||
1006 | /* Return the row/column (zero-based) of the character cell containing | |
1007 | the pixel on FRAME at Y/X. */ | |
1008 | ||
1009 | #define FRAME_PIXEL_Y_TO_LINE(f, y) \ | |
4b00d3b1 YM |
1010 | (((y) < FRAME_TOP_MARGIN_HEIGHT (f) \ |
1011 | ? (y) \ | |
1012 | : ((y) < FRAME_TOP_MARGIN_HEIGHT (f) + FRAME_INTERNAL_BORDER_WIDTH (f) \ | |
1013 | ? (y) - (FRAME_TOP_MARGIN_HEIGHT (f) + FRAME_INTERNAL_BORDER_WIDTH (f) \ | |
1014 | /* Arrange for the division to round down. */ \ | |
1015 | + FRAME_LINE_HEIGHT (f) - 1) \ | |
1016 | : (y) - FRAME_INTERNAL_BORDER_WIDTH (f))) \ | |
b45afe99 KS |
1017 | / FRAME_LINE_HEIGHT (f)) |
1018 | ||
1019 | #define FRAME_PIXEL_X_TO_COL(f, x) \ | |
1020 | (((x) - FRAME_INTERNAL_BORDER_WIDTH (f)) \ | |
1021 | / FRAME_COLUMN_WIDTH (f)) | |
1022 | ||
1023 | /* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on | |
1024 | frame F? */ | |
1025 | ||
1026 | #define FRAME_PIXEL_WIDTH_TO_TEXT_COLS(f, width) \ | |
1027 | (FRAME_PIXEL_X_TO_COL (f, ((width) \ | |
1028 | - FRAME_INTERNAL_BORDER_WIDTH (f) \ | |
1029 | - FRAME_TOTAL_FRINGE_WIDTH (f) \ | |
1030 | - (f)->scroll_bar_actual_width))) | |
1031 | ||
1032 | #define FRAME_PIXEL_HEIGHT_TO_TEXT_LINES(f, height) \ | |
1033 | (FRAME_PIXEL_Y_TO_LINE (f, ((height) \ | |
1034 | - FRAME_INTERNAL_BORDER_WIDTH (f)))) | |
177c0ea7 | 1035 | |
5e02ce11 KS |
1036 | |
1037 | /*********************************************************************** | |
1038 | Frame Parameters | |
1039 | ***********************************************************************/ | |
1040 | ||
1041 | extern Lisp_Object Qauto_raise, Qauto_lower; | |
1042 | extern Lisp_Object Qborder_color, Qborder_width; | |
955cbe7b | 1043 | extern Lisp_Object Qbuffer_predicate; |
5e02ce11 KS |
1044 | extern Lisp_Object Qcursor_color, Qcursor_type; |
1045 | extern Lisp_Object Qfont; | |
1046 | extern Lisp_Object Qbackground_color, Qforeground_color; | |
1047 | extern Lisp_Object Qicon, Qicon_name, Qicon_type, Qicon_left, Qicon_top; | |
1048 | extern Lisp_Object Qinternal_border_width; | |
99f3388e | 1049 | extern Lisp_Object Qtooltip; |
2b4e6277 | 1050 | extern Lisp_Object Qmenu_bar_lines, Qtool_bar_lines, Qtool_bar_position; |
5e02ce11 KS |
1051 | extern Lisp_Object Qmouse_color; |
1052 | extern Lisp_Object Qname, Qtitle; | |
1053 | extern Lisp_Object Qparent_id; | |
1054 | extern Lisp_Object Qunsplittable, Qvisibility; | |
1055 | extern Lisp_Object Qscroll_bar_width, Qvertical_scroll_bars; | |
1056 | extern Lisp_Object Qscroll_bar_foreground, Qscroll_bar_background; | |
1057 | extern Lisp_Object Qscreen_gamma; | |
1058 | extern Lisp_Object Qline_spacing; | |
1059 | extern Lisp_Object Qwait_for_wm; | |
1060 | extern Lisp_Object Qfullscreen; | |
3f1c6666 | 1061 | extern Lisp_Object Qfullwidth, Qfullheight, Qfullboth, Qmaximized; |
acd51077 | 1062 | extern Lisp_Object Qsticky; |
1a8a83b2 | 1063 | extern Lisp_Object Qfont_backend; |
50a73869 | 1064 | extern Lisp_Object Qalpha; |
5e02ce11 KS |
1065 | |
1066 | extern Lisp_Object Qleft_fringe, Qright_fringe; | |
1067 | extern Lisp_Object Qheight, Qwidth; | |
1068 | extern Lisp_Object Qminibuffer, Qmodeline; | |
edfda783 | 1069 | extern Lisp_Object Qx, Qw32, Qmac, Qpc, Qns; |
5e02ce11 KS |
1070 | extern Lisp_Object Qvisible; |
1071 | extern Lisp_Object Qdisplay_type; | |
5e02ce11 KS |
1072 | |
1073 | extern Lisp_Object Qx_resource_name; | |
1074 | ||
bfeabdc3 | 1075 | extern Lisp_Object Qleft, Qright, Qtop, Qbox, Qbottom; |
5e02ce11 KS |
1076 | extern Lisp_Object Qdisplay; |
1077 | ||
99f3388e DN |
1078 | extern Lisp_Object Qrun_hook_with_args; |
1079 | ||
5e02ce11 KS |
1080 | #ifdef HAVE_WINDOW_SYSTEM |
1081 | ||
1082 | /* The class of this X application. */ | |
1083 | #define EMACS_CLASS "Emacs" | |
1084 | ||
5e02ce11 KS |
1085 | /* These are in xterm.c, w32term.c, etc. */ |
1086 | ||
383e0970 J |
1087 | extern void x_set_scroll_bar_default_width (struct frame *); |
1088 | extern void x_set_offset (struct frame *, int, int, int); | |
1089 | extern void x_wm_set_icon_position (struct frame *, int, int); | |
5e02ce11 | 1090 | |
383e0970 | 1091 | extern Lisp_Object x_new_font (struct frame *, Lisp_Object, int); |
5e02ce11 | 1092 | |
5e02ce11 KS |
1093 | |
1094 | extern Lisp_Object Qface_set_after_frame_default; | |
1095 | ||
81626931 | 1096 | #ifdef WINDOWSNT |
383e0970 J |
1097 | extern void x_fullscreen_adjust (struct frame *f, int *, int *, |
1098 | int *, int *); | |
81626931 | 1099 | #endif |
383e0970 J |
1100 | |
1101 | extern void x_set_frame_parameters (struct frame *, Lisp_Object); | |
383e0970 J |
1102 | |
1103 | extern void x_set_fullscreen (struct frame *, Lisp_Object, Lisp_Object); | |
1104 | extern void x_set_line_spacing (struct frame *, Lisp_Object, Lisp_Object); | |
1105 | extern void x_set_screen_gamma (struct frame *, Lisp_Object, Lisp_Object); | |
1106 | extern void x_set_font (struct frame *, Lisp_Object, Lisp_Object); | |
1107 | extern void x_set_font_backend (struct frame *, Lisp_Object, Lisp_Object); | |
1108 | extern void x_set_fringe_width (struct frame *, Lisp_Object, Lisp_Object); | |
1109 | extern void x_set_border_width (struct frame *, Lisp_Object, Lisp_Object); | |
1110 | extern void x_set_internal_border_width (struct frame *, Lisp_Object, | |
1111 | Lisp_Object); | |
1112 | extern void x_set_visibility (struct frame *, Lisp_Object, Lisp_Object); | |
1113 | extern void x_set_autoraise (struct frame *, Lisp_Object, Lisp_Object); | |
1114 | extern void x_set_autolower (struct frame *, Lisp_Object, Lisp_Object); | |
1115 | extern void x_set_unsplittable (struct frame *, Lisp_Object, Lisp_Object); | |
1116 | extern void x_set_vertical_scroll_bars (struct frame *, Lisp_Object, | |
1117 | Lisp_Object); | |
1118 | extern void x_set_scroll_bar_width (struct frame *, Lisp_Object, | |
1119 | Lisp_Object); | |
1120 | ||
1121 | extern Lisp_Object x_icon_type (struct frame *); | |
1122 | ||
1123 | extern int x_figure_window_size (struct frame *, Lisp_Object, int); | |
5e02ce11 | 1124 | |
383e0970 | 1125 | extern void x_set_alpha (struct frame *, Lisp_Object, Lisp_Object); |
5e02ce11 | 1126 | |
383e0970 | 1127 | extern void validate_x_resource_name (void); |
0ff162fc | 1128 | |
facfbbbd SM |
1129 | extern Lisp_Object display_x_get_resource (Display_Info *, |
1130 | Lisp_Object attribute, | |
1131 | Lisp_Object class, | |
1132 | Lisp_Object component, | |
1133 | Lisp_Object subclass); | |
1134 | ||
018c5e19 PE |
1135 | #if defined HAVE_X_WINDOWS && !defined USE_X_TOOLKIT |
1136 | extern char *x_get_resource_string (const char *, const char *); | |
1137 | #endif | |
1138 | ||
99f3388e DN |
1139 | /* In xmenu.c */ |
1140 | extern void set_frame_menubar (FRAME_PTR, int, int); | |
1141 | ||
5e02ce11 KS |
1142 | #endif /* HAVE_WINDOW_SYSTEM */ |
1143 | ||
84e01749 | 1144 | #endif /* not EMACS_FRAME_H */ |