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