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