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