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