* leim/leim-ext.el: Change method for getting comments in the output
[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 358 /* 0 means, if this frame has just one window,
efa4ce8b 359 show no modeline for that window. */
4e0f6479 360 unsigned wants_modeline : 1;
efa4ce8b 361
ff11dfa1 362 /* Non-0 means raise this frame to the top of the heap when selected. */
4e0f6479 363 unsigned auto_raise : 1;
efa4ce8b 364
ff11dfa1 365 /* Non-0 means lower this frame to the bottom of the stack when left. */
4e0f6479 366 unsigned auto_lower : 1;
efa4ce8b 367
ff11dfa1 368 /* True if frame's root window can't be split. */
4e0f6479 369 unsigned no_split : 1;
efa4ce8b 370
fbfed6f0
JB
371 /* If this is set, then Emacs won't change the frame name to indicate
372 the current buffer, etcetera. If the user explicitly sets the frame
373 name, this gets set. If the user sets the name to Qnil, this is
374 cleared. */
4e0f6479 375 unsigned explicit_name : 1;
fbfed6f0 376
adc12f0f 377 /* Nonzero if size of some window on this frame has changed. */
4e0f6479 378 unsigned window_sizes_changed : 1;
adc12f0f 379
e3d7bd83
DN
380 /* Nonzero if the mouse has moved on this display device
381 since the last time we checked. */
4e0f6479 382 unsigned mouse_moved :1;
e3d7bd83 383
e044e4fc 384 /* Nonzero means that the pointer is invisible. */
4e0f6479 385 unsigned pointer_invisible :1;
e044e4fc 386
d2e113bc
DA
387 /* Nonzero means that all windows except mini-window and
388 selected window on this frame have frozen window starts. */
389 unsigned frozen_window_starts : 1;
390
3737fee7 391 /* Nonzero if we should actually display the scroll bars on this frame. */
e3d7bd83
DN
392 enum vertical_scroll_bar_type vertical_scroll_bar_type;
393
394 /* What kind of text cursor should we draw in the future?
395 This should always be filled_box_cursor or bar_cursor. */
396 enum text_cursor_kinds desired_cursor;
397
398 /* Width of bar cursor (if we are using that). */
399 int cursor_width;
400
401 /* What kind of text cursor should we draw when the cursor blinks off?
402 This can be filled_box_cursor or bar_cursor or no_cursor. */
403 enum text_cursor_kinds blink_off_cursor;
404
405 /* Width of bar cursor (if we are using that) for blink-off state. */
406 int blink_off_cursor_width;
407
b45afe99
KS
408 /* Configured width of the scroll bar, in pixels and in characters.
409 config_scroll_bar_cols tracks config_scroll_bar_width if the
410 latter is positive; a zero value in config_scroll_bar_width means
411 to compute the actual width on the fly, using config_scroll_bar_cols
412 and the current font width. */
413 int config_scroll_bar_width;
414 int config_scroll_bar_cols;
415
416 /* The size of the extra width currently allotted for vertical
417 scroll bars in this frame, in pixels. */
418 int scroll_bar_actual_width;
95b999aa
RS
419
420 /* The baud rate that was used to calculate costs for this frame. */
421 int cost_calculation_baud_rate;
6462918c 422
91a47a68
DN
423 /* frame opacity
424 alpha[0]: alpha transparency of the active frame
f2d5c00f
CY
425 alpha[1]: alpha transparency of inactive frames
426 Negative values mean not to change alpha. */
91a47a68
DN
427 double alpha[2];
428
b61cbba3
GM
429 /* Exponent for gamma correction of colors. 1/(VIEWING_GAMMA *
430 SCREEN_GAMMA) where viewing_gamma is 0.4545 and SCREEN_GAMMA is a
431 frame parameter. 0 means don't do gamma correction. */
432 double gamma;
d1738c45
GM
433
434 /* Additional space to put between text lines on this frame. */
435 int extra_line_spacing;
f1c69c61 436
28d7d09f
KL
437 /* All display backends seem to need these two pixel values. */
438 unsigned long background_pixel;
439 unsigned long foreground_pixel;
efa4ce8b
JB
440};
441
f00af5b1
PE
442/* Most code should use these functions to set Lisp fields in struct frame. */
443
00382e8b 444INLINE void
f00af5b1
PE
445fset_buffer_list (struct frame *f, Lisp_Object val)
446{
447 f->buffer_list = val;
448}
00382e8b 449INLINE void
f00af5b1
PE
450fset_buried_buffer_list (struct frame *f, Lisp_Object val)
451{
452 f->buried_buffer_list = val;
453}
00382e8b 454INLINE void
f00af5b1
PE
455fset_condemned_scroll_bars (struct frame *f, Lisp_Object val)
456{
457 f->condemned_scroll_bars = val;
458}
00382e8b 459INLINE void
f00af5b1
PE
460fset_face_alist (struct frame *f, Lisp_Object val)
461{
462 f->face_alist = val;
463}
00382e8b 464INLINE void
f00af5b1
PE
465fset_focus_frame (struct frame *f, Lisp_Object val)
466{
467 f->focus_frame = val;
468}
00382e8b 469INLINE void
f00af5b1
PE
470fset_icon_name (struct frame *f, Lisp_Object val)
471{
472 f->icon_name = val;
473}
00382e8b 474INLINE void
f00af5b1
PE
475fset_menu_bar_items (struct frame *f, Lisp_Object val)
476{
477 f->menu_bar_items = val;
478}
00382e8b 479INLINE void
f00af5b1
PE
480fset_menu_bar_vector (struct frame *f, Lisp_Object val)
481{
482 f->menu_bar_vector = val;
483}
5a49b79c 484#if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
00382e8b 485INLINE void
f00af5b1
PE
486fset_menu_bar_window (struct frame *f, Lisp_Object val)
487{
488 f->menu_bar_window = val;
489}
5a49b79c 490#endif
00382e8b 491INLINE void
f00af5b1
PE
492fset_name (struct frame *f, Lisp_Object val)
493{
494 f->name = val;
495}
00382e8b 496INLINE void
f00af5b1
PE
497fset_param_alist (struct frame *f, Lisp_Object val)
498{
499 f->param_alist = val;
500}
00382e8b 501INLINE void
f00af5b1
PE
502fset_root_window (struct frame *f, Lisp_Object val)
503{
504 f->root_window = val;
505}
00382e8b 506INLINE void
f00af5b1
PE
507fset_scroll_bars (struct frame *f, Lisp_Object val)
508{
509 f->scroll_bars = val;
510}
00382e8b 511INLINE void
f00af5b1
PE
512fset_selected_window (struct frame *f, Lisp_Object val)
513{
514 f->selected_window = val;
515}
00382e8b 516INLINE void
f00af5b1
PE
517fset_title (struct frame *f, Lisp_Object val)
518{
519 f->title = val;
520}
00382e8b 521INLINE void
f00af5b1
PE
522fset_tool_bar_items (struct frame *f, Lisp_Object val)
523{
524 f->tool_bar_items = val;
525}
00382e8b 526INLINE void
f00af5b1
PE
527fset_tool_bar_position (struct frame *f, Lisp_Object val)
528{
529 f->tool_bar_position = val;
530}
742516e0 531#if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
00382e8b 532INLINE void
f00af5b1
PE
533fset_tool_bar_window (struct frame *f, Lisp_Object val)
534{
535 f->tool_bar_window = val;
536}
00382e8b 537INLINE void
742516e0
DA
538fset_current_tool_bar_string (struct frame *f, Lisp_Object val)
539{
540 f->current_tool_bar_string = val;
541}
00382e8b 542INLINE void
742516e0
DA
543fset_desired_tool_bar_string (struct frame *f, Lisp_Object val)
544{
545 f->desired_tool_bar_string = val;
546}
547#endif /* HAVE_WINDOW_SYSTEM && !USE_GTK && !HAVE_NS */
f00af5b1 548
42143acd
DA
549#define NUMVAL(X) ((INTEGERP (X) || FLOATP (X)) ? XFLOATINT (X) : -1)
550
00382e8b 551INLINE double
42143acd
DA
552default_pixels_per_inch_x (void)
553{
554 Lisp_Object v = (CONSP (Vdisplay_pixels_per_inch)
555 ? XCAR (Vdisplay_pixels_per_inch)
556 : Vdisplay_pixels_per_inch);
557 return NUMVAL (v) > 0 ? NUMVAL (v) : 72.0;
558}
559
00382e8b 560INLINE double
42143acd
DA
561default_pixels_per_inch_y (void)
562{
563 Lisp_Object v = (CONSP (Vdisplay_pixels_per_inch)
564 ? XCDR (Vdisplay_pixels_per_inch)
565 : Vdisplay_pixels_per_inch);
566 return NUMVAL (v) > 0 ? NUMVAL (v) : 72.0;
567}
568
6ed8eeff 569#define FRAME_KBOARD(f) ((f)->terminal->kboard)
37ea66e1 570
354884c4
SM
571/* Return a pointer to the image cache of frame F. */
572#define FRAME_IMAGE_CACHE(F) ((F)->terminal->image_cache)
573
b263a6b0
PE
574#define XFRAME(p) \
575 (eassert (FRAMEP (p)), (struct frame *) XUNTAG (p, Lisp_Vectorlike))
aac03cca 576#define XSETFRAME(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_FRAME))
ff11dfa1 577
cea6021b 578/* Given a window, return its frame as a Lisp_Object. */
fd16b54c 579#define WINDOW_FRAME(w) ((w)->frame)
ff11dfa1 580
cea6021b 581/* Test a frame for particular kinds of display methods. */
3224dac1 582#define FRAME_INITIAL_P(f) ((f)->output_method == output_initial)
cea6021b 583#define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap)
efa7f0f9 584#define FRAME_X_P(f) ((f)->output_method == output_x_window)
0fda9b75 585#ifndef HAVE_NTGUI
ff687885
DN
586#define FRAME_W32_P(f) (0)
587#else
fbd6baed 588#define FRAME_W32_P(f) ((f)->output_method == output_w32)
ff687885
DN
589#endif
590#ifndef MSDOS
591#define FRAME_MSDOS_P(f) (0)
592#else
6f181713 593#define FRAME_MSDOS_P(f) ((f)->output_method == output_msdos_raw)
ff687885
DN
594#endif
595#ifndef HAVE_NS
596#define FRAME_NS_P(f) (0)
597#else
edfda783 598#define FRAME_NS_P(f) ((f)->output_method == output_ns)
ff687885 599#endif
42143acd 600
efa7f0f9
GV
601/* FRAME_WINDOW_P tests whether the frame is a window, and is
602 defined to be the predicate for the window system being used. */
3b83d631 603
efa7f0f9
GV
604#ifdef HAVE_X_WINDOWS
605#define FRAME_WINDOW_P(f) FRAME_X_P (f)
606#endif
607#ifdef HAVE_NTGUI
fbd6baed 608#define FRAME_WINDOW_P(f) FRAME_W32_P (f)
efa7f0f9 609#endif
edfda783
AR
610#ifdef HAVE_NS
611#define FRAME_WINDOW_P(f) FRAME_NS_P(f)
612#endif
7651b07e 613#ifndef FRAME_WINDOW_P
4973679b 614#define FRAME_WINDOW_P(f) ((void) (f), 0)
7651b07e 615#endif
efa7f0f9 616
aad3612f
DA
617/* Dots per inch of the screen the frame F is on. */
618
619#ifdef HAVE_WINDOW_SYSTEM
620
621#define FRAME_RES_X(f) \
622 (eassert (FRAME_WINDOW_P (f)), FRAME_DISPLAY_INFO (f)->resx)
623#define FRAME_RES_Y(f) \
624 (eassert (FRAME_WINDOW_P (f)), FRAME_DISPLAY_INFO (f)->resy)
625
626#else /* !HAVE_WINDOW_SYSTEM */
627
628/* Defaults when no window system available. */
629
630#define FRAME_RES_X(f) default_pixels_per_inch_x ()
631#define FRAME_RES_Y(f) default_pixels_per_inch_y ()
632
633#endif /* HAVE_WINDOW_SYSTEM */
634
7ea692f6
EZ
635/* Return a pointer to the structure holding information about the
636 region of text, if any, that is currently shown in mouse-face on
8e5ba371 637 frame F. We need to define two versions because a TTY-only build
aad3612f 638 does not have FRAME_DISPLAY_INFO. */
8e5ba371
EZ
639#ifdef HAVE_WINDOW_SYSTEM
640# define MOUSE_HL_INFO(F) \
021f2e1a 641 (FRAME_WINDOW_P(F) \
aad3612f 642 ? &FRAME_DISPLAY_INFO(F)->mouse_highlight \
021f2e1a 643 : &(F)->output_data.tty->display_info->mouse_highlight)
8e5ba371
EZ
644#else
645# define MOUSE_HL_INFO(F) \
021f2e1a 646 (&(F)->output_data.tty->display_info->mouse_highlight)
8e5ba371 647#endif
7ea692f6 648
cea6021b 649/* Nonzero if frame F is still alive (not deleted). */
6ed8eeff 650#define FRAME_LIVE_P(f) ((f)->terminal != 0)
cea6021b
RS
651
652/* Nonzero if frame F is a minibuffer-only frame. */
ff11dfa1
JB
653#define FRAME_MINIBUF_ONLY_P(f) \
654 EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f))
cea6021b 655
1a23cd48
DA
656/* Nonzero if frame F contains it's own minibuffer window. Frame always has
657 minibuffer window, but it could use minibuffer window of another frame. */
658#define FRAME_HAS_MINIBUF_P(f) \
659 (WINDOWP (f->minibuffer_window) \
660 && XFRAME (XWINDOW (f->minibuffer_window)->frame) == f)
cea6021b 661
b45afe99
KS
662/* Pixel height of frame F, including non-toolkit menu bar and
663 non-toolkit tool bar lines. */
664#define FRAME_PIXEL_HEIGHT(f) ((f)->pixel_height)
665
666/* Pixel width of frame F. */
667#define FRAME_PIXEL_WIDTH(f) ((f)->pixel_width)
668
669/* Height of frame F, measured in canonical lines, including
670 non-toolkit menu bar and non-toolkit tool bar lines. */
671#define FRAME_LINES(f) (f)->text_lines
672
673/* Width of frame F, measured in canonical character columns,
cea6021b 674 not including scroll bars if any. */
b45afe99 675#define FRAME_COLS(f) (f)->text_cols
cea6021b
RS
676
677/* Number of lines of frame F used for menu bar.
678 This is relevant on terminal frames and on
679 X Windows when not using the X toolkit.
b45afe99 680 These lines are counted in FRAME_LINES. */
6d05db81 681#define FRAME_MENU_BAR_LINES(f) (f)->menu_bar_lines
cea6021b 682
488dd4c4
JD
683/* Nonzero if this frame should display a tool bar
684 in a way that does not use any text lines. */
9e2a2647 685#if defined (USE_GTK) || defined (HAVE_NS)
488dd4c4
JD
686#define FRAME_EXTERNAL_TOOL_BAR(f) (f)->external_tool_bar
687#else
688#define FRAME_EXTERNAL_TOOL_BAR(f) 0
689#endif
690
9ea173e8 691/* Number of lines of frame F used for the tool-bar. */
3b83d631 692
9ea173e8 693#define FRAME_TOOL_BAR_LINES(f) (f)->tool_bar_lines
3b83d631 694
488dd4c4 695
3b83d631
GM
696/* Lines above the top-most window in frame F. */
697
698#define FRAME_TOP_MARGIN(F) \
021f2e1a 699 (FRAME_MENU_BAR_LINES (F) + FRAME_TOOL_BAR_LINES (F))
3b83d631 700
4b00d3b1
YM
701/* Pixel height of the top margin above. */
702
703#define FRAME_TOP_MARGIN_HEIGHT(f) \
704 (FRAME_TOP_MARGIN (f) * FRAME_LINE_HEIGHT (f))
705
cea6021b
RS
706/* Nonzero if this frame should display a menu bar
707 in a way that does not use any text lines. */
9e2a2647 708#if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
edfda783 709 || defined (HAVE_NS) || defined (USE_GTK)
9c95189b 710#define FRAME_EXTERNAL_MENU_BAR(f) (f)->external_menu_bar
4c8888a0
RS
711#else
712#define FRAME_EXTERNAL_MENU_BAR(f) 0
713#endif
edfa7fa0 714#define FRAME_VISIBLE_P(f) (f)->visible
cea6021b
RS
715
716/* Nonzero if frame F is currently visible but hidden. */
0969b893 717#define FRAME_OBSCURED_P(f) ((f)->visible > 1)
cea6021b
RS
718
719/* Nonzero if frame F is currently iconified. */
720#define FRAME_ICONIFIED_P(f) (f)->iconified
721
edfa7fa0 722/* Mark frame F as currently garbaged. */
ff11dfa1 723#define SET_FRAME_GARBAGED(f) (frame_garbaged = 1, f->garbaged = 1)
edfa7fa0
DA
724
725/* Nonzero if frame F is currently garbaged. */
ff11dfa1 726#define FRAME_GARBAGED_P(f) (f)->garbaged
cea6021b
RS
727
728/* Nonzero means do not allow splitting this frame's window. */
ff11dfa1 729#define FRAME_NO_SPLIT_P(f) (f)->no_split
cea6021b
RS
730
731/* Not really implemented. */
ff11dfa1 732#define FRAME_WANTS_MODELINE_P(f) (f)->wants_modeline
cea6021b 733
d2e113bc
DA
734/* Nonzero if all windows except selected window and mini window
735 are frozen on frame F. */
736#define FRAME_WINDOWS_FROZEN(f) (f)->frozen_window_starts
737
cea6021b
RS
738/* Nonzero if a size change has been requested for frame F
739 but not yet really put into effect. This can be true temporarily
740 when an X event comes in at a bad time. */
adc12f0f 741#define FRAME_WINDOW_SIZES_CHANGED(f) (f)->window_sizes_changed
cea6021b
RS
742
743/* The minibuffer window of frame F, if it has one; otherwise nil. */
e69b0960 744#define FRAME_MINIBUF_WINDOW(f) f->minibuffer_window
cea6021b
RS
745
746/* The root window of the window tree of frame F. */
e69b0960 747#define FRAME_ROOT_WINDOW(f) f->root_window
cea6021b
RS
748
749/* The currently selected window of the window tree of frame F. */
e69b0960 750#define FRAME_SELECTED_WINDOW(f) f->selected_window
cea6021b 751
177c0ea7
JB
752#define FRAME_INSERT_COST(f) (f)->insert_line_cost
753#define FRAME_DELETE_COST(f) (f)->delete_line_cost
ff11dfa1
JB
754#define FRAME_INSERTN_COST(f) (f)->insert_n_lines_cost
755#define FRAME_DELETEN_COST(f) (f)->delete_n_lines_cost
e69b0960 756#define FRAME_FOCUS_FRAME(f) f->focus_frame
cea6021b 757
cea6021b
RS
758/* This frame slot says whether scroll bars are currently enabled for frame F,
759 and which side they are on. */
a3211441
RS
760#define FRAME_VERTICAL_SCROLL_BAR_TYPE(f) ((f)->vertical_scroll_bar_type)
761#define FRAME_HAS_VERTICAL_SCROLL_BARS(f) \
021f2e1a 762 ((f)->vertical_scroll_bar_type != vertical_scroll_bar_none)
a3211441 763#define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT(f) \
021f2e1a 764 ((f)->vertical_scroll_bar_type == vertical_scroll_bar_left)
a3211441 765#define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT(f) \
021f2e1a 766 ((f)->vertical_scroll_bar_type == vertical_scroll_bar_right)
cea6021b
RS
767
768/* Width that a scroll bar in frame F should have, if there is one.
769 Measured in pixels.
770 If scroll bars are turned off, this is still nonzero. */
b45afe99 771#define FRAME_CONFIG_SCROLL_BAR_WIDTH(f) ((f)->config_scroll_bar_width)
cea6021b
RS
772
773/* Width that a scroll bar in frame F should have, if there is one.
774 Measured in columns (characters).
775 If scroll bars are turned off, this is still nonzero. */
b45afe99 776#define FRAME_CONFIG_SCROLL_BAR_COLS(f) ((f)->config_scroll_bar_cols)
cea6021b
RS
777
778/* Width of a scroll bar in frame F, measured in columns (characters),
7d81cf83
GM
779 but only if scroll bars are on the left. If scroll bars are on
780 the right in this frame, or there are no scroll bars, value is 0. */
781
b45afe99 782#define FRAME_LEFT_SCROLL_BAR_COLS(f) \
021f2e1a
AS
783 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \
784 ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
785 : 0)
7d81cf83 786
b45afe99
KS
787/* Width of a left scroll bar in frame F, measured in pixels */
788
021f2e1a 789#define FRAME_LEFT_SCROLL_BAR_AREA_WIDTH(f) \
b45afe99
KS
790 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \
791 ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)) \
792 : 0)
793
7d81cf83
GM
794/* Width of a scroll bar in frame F, measured in columns (characters),
795 but only if scroll bars are on the right. If scroll bars are on
796 the left in this frame, or there are no scroll bars, value is 0. */
797
b45afe99 798#define FRAME_RIGHT_SCROLL_BAR_COLS(f) \
021f2e1a
AS
799 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f) \
800 ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
801 : 0)
cea6021b 802
b45afe99
KS
803/* Width of a right scroll bar area in frame F, measured in pixels */
804
021f2e1a 805#define FRAME_RIGHT_SCROLL_BAR_AREA_WIDTH(f) \
b45afe99
KS
806 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f) \
807 ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)) \
808 : 0)
809
810/* Actual width of a scroll bar in frame F, measured in columns. */
811
812#define FRAME_SCROLL_BAR_COLS(f) \
021f2e1a
AS
813 (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \
814 ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
815 : 0)
cea6021b 816
b45afe99
KS
817/* Actual width of a scroll bar area in frame F, measured in pixels. */
818
819#define FRAME_SCROLL_BAR_AREA_WIDTH(f) \
820 (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \
821 ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)) \
822 : 0)
823
cea6021b
RS
824/* Total width of frame F, in columns (characters),
825 including the width used by scroll bars if any. */
b45afe99
KS
826
827#define FRAME_TOTAL_COLS(f) ((f)->total_cols)
cea6021b
RS
828
829/* Set the width of frame F to VAL.
830 VAL is the width of a full-frame window,
b45afe99
KS
831 not including scroll bars and fringes. */
832
833#define SET_FRAME_COLS(f, val) \
021f2e1a
AS
834 (FRAME_COLS (f) = (val), \
835 (f)->total_cols = FRAME_TOTAL_COLS_ARG (f, FRAME_COLS (f)))
cea6021b
RS
836
837/* Given a value WIDTH for frame F's nominal width,
b45afe99
KS
838 return the value that FRAME_TOTAL_COLS should have. */
839
840#define FRAME_TOTAL_COLS_ARG(f, width) \
021f2e1a
AS
841 ((width) \
842 + FRAME_SCROLL_BAR_COLS (f) \
843 + FRAME_FRINGE_COLS (f))
cea6021b 844
4ff34795 845/* Maximum + 1 legitimate value for FRAME_CURSOR_X. */
b45afe99 846
4ff34795 847#define FRAME_CURSOR_X_LIMIT(f) \
021f2e1a 848 (FRAME_COLS (f) + FRAME_LEFT_SCROLL_BAR_COLS (f))
cea6021b
RS
849
850/* Nonzero if frame F has scroll bars. */
b45afe99 851
e69b0960 852#define FRAME_SCROLL_BARS(f) (f->scroll_bars)
cea6021b 853
e69b0960
DA
854#define FRAME_CONDEMNED_SCROLL_BARS(f) (f->condemned_scroll_bars)
855#define FRAME_MENU_BAR_ITEMS(f) (f->menu_bar_items)
95b999aa 856#define FRAME_COST_BAUD_RATE(f) ((f)->cost_calculation_baud_rate)
81d00831 857
4d418fcc
KS
858#define FRAME_DESIRED_CURSOR(f) ((f)->desired_cursor)
859#define FRAME_BLINK_OFF_CURSOR(f) ((f)->blink_off_cursor)
860#define FRAME_CURSOR_WIDTH(f) ((f)->cursor_width)
861#define FRAME_BLINK_OFF_CURSOR_WIDTH(f) ((f)->blink_off_cursor_width)
862
9d7693d7
DA
863#define FRAME_FOREGROUND_PIXEL(f) ((f)->foreground_pixel)
864#define FRAME_BACKGROUND_PIXEL(f) ((f)->background_pixel)
865
3b83d631
GM
866/* Return a pointer to the face cache of frame F. */
867
868#define FRAME_FACE_CACHE(F) (F)->face_cache
869
81d00831
KH
870/* Return the size of message_buf of the frame F. We multiply the
871 width of the frame by 4 because multi-byte form may require at most
872 4-byte for a character. */
177c0ea7 873
b45afe99 874#define FRAME_MESSAGE_BUF_SIZE(f) (((int) FRAME_COLS (f)) * 4)
ff11dfa1 875
915a3e00
KS
876#define CHECK_FRAME(x) \
877 CHECK_TYPE (FRAMEP (x), Qframep, x)
878
879#define CHECK_LIVE_FRAME(x) \
880 CHECK_TYPE (FRAMEP (x) && FRAME_LIVE_P (XFRAME (x)), Qframe_live_p, x)
265a9e55 881
ff11dfa1
JB
882/* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
883 `for' loop which iterates over the elements of Vframe_list. The
35f56f96 884 loop will set FRAME_VAR, a Lisp_Object, to each frame in
ff11dfa1 885 Vframe_list in succession and execute the statement. LIST_VAR
35f56f96 886 should be a Lisp_Object too; it is used to iterate through the
177c0ea7 887 Vframe_list.
e5d77022 888
e3678b64
KH
889 This macro is a holdover from a time when multiple frames weren't always
890 supported. An alternate definition of the macro would expand to
891 something which executes the statement once. */
3b83d631 892
e69b0960
DA
893#define FOR_EACH_FRAME(list_var, frame_var) \
894 for ((list_var) = Vframe_list; \
895 (CONSP (list_var) \
896 && (frame_var = XCAR (list_var), 1)); \
ee88f64d 897 list_var = XCDR (list_var))
e5d77022 898
5c747675
DA
899/* Reflect mouse movement when a complete frame update is performed. */
900
901#define FRAME_MOUSE_UPDATE(frame) \
902 do { \
903 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (frame); \
904 if (frame == hlinfo->mouse_face_mouse_frame) \
905 { \
906 block_input (); \
f8c20208
DA
907 note_mouse_highlight (hlinfo->mouse_face_mouse_frame, \
908 hlinfo->mouse_face_mouse_x, \
909 hlinfo->mouse_face_mouse_y); \
5c747675
DA
910 unblock_input (); \
911 } \
912 } while (0)
e5d77022 913
edfa7fa0
DA
914/* Set visibility of frame F, marking F as garbaged if needed. */
915
916#define SET_FRAME_VISIBLE(f, v) \
917 (((f)->visible == 0 || ((f)->visible == 2)) \
918 && ((v) == 1) ? SET_FRAME_GARBAGED (f) : 0, \
919 (f)->visible = (eassert (0 <= (v) && (v) <= 2), (v)))
920
921/* Set iconify of frame F. */
922
923#define SET_FRAME_ICONIFIED(f, i) \
924 (f)->iconified = (eassert (0 <= (i) && (i) <= 1), (i))
925
5492865b 926extern Lisp_Object selected_frame;
5e02ce11 927extern Lisp_Object Qframep, Qframe_live_p;
2666355c 928extern Lisp_Object Qtty, Qtty_type;
8848b728 929extern Lisp_Object Qtty_color_mode;
959067a1 930extern Lisp_Object Qterminal;
c53956fe 931extern Lisp_Object Qnoelisp;
efa4ce8b 932
9d7693d7
DA
933/* Nonzero means there is at least one garbaged frame. */
934extern bool frame_garbaged;
935
0ff162fc 936extern void set_menu_bar_lines (struct frame *, Lisp_Object, Lisp_Object);
7452b7bd 937extern struct frame *decode_window_system_frame (Lisp_Object);
d9f07150
DA
938extern struct frame *decode_live_frame (Lisp_Object);
939extern struct frame *decode_any_frame (Lisp_Object);
383e0970 940extern struct frame *make_initial_frame (void);
959067a1 941extern struct frame *make_frame (bool);
c9e5d3d1 942#ifdef HAVE_WINDOW_SYSTEM
383e0970
J
943extern struct frame *make_minibuffer_frame (void);
944extern struct frame *make_frame_without_minibuffer (Lisp_Object,
945 struct kboard *,
946 Lisp_Object);
c9e5d3d1 947#endif /* HAVE_WINDOW_SYSTEM */
7452b7bd
DA
948extern bool window_system_available (struct frame *);
949extern void check_window_system (struct frame *);
383e0970
J
950extern void frame_make_pointer_invisible (void);
951extern void frame_make_pointer_visible (void);
952extern Lisp_Object delete_frame (Lisp_Object, Lisp_Object);
efa4ce8b 953
ff11dfa1 954extern Lisp_Object Vframe_list;
650afd94
GM
955
956/* Value is a pointer to the selected frame. If the selected frame
b975254e 957 isn't live, abort. */
650afd94
GM
958
959#define SELECTED_FRAME() \
960 ((FRAMEP (selected_frame) \
961 && FRAME_LIVE_P (XFRAME (selected_frame))) \
962 ? XFRAME (selected_frame) \
1088b922 963 : (emacs_abort (), (struct frame *) 0))
3b83d631
GM
964
965\f
966/***********************************************************************
967 Display-related Macros
968 ***********************************************************************/
969
d3378f02 970/* Canonical y-unit on frame F.
b45afe99
KS
971 This value currently equals the line height of the frame (which is
972 the height of the default font of F). */
973
974#define FRAME_LINE_HEIGHT(F) ((F)->line_height)
3b83d631 975
d3378f02 976/* Canonical x-unit on frame F.
0fc63cc4 977 This value currently equals the average width of the default font of F. */
3b83d631 978
b45afe99 979#define FRAME_COLUMN_WIDTH(F) ((F)->column_width)
3b83d631 980
3b83d631 981/* Pixel width of areas used to display truncation marks, continuation
5cb26370 982 marks, overlay arrows. This is 0 for terminal frames. */
3b83d631
GM
983
984#ifdef HAVE_WINDOW_SYSTEM
aa5b8e15 985
b45afe99
KS
986/* Total width of fringes reserved for drawing truncation bitmaps,
987 continuation bitmaps and alike. The width is in canonical char
988 units of the frame. This must currently be the case because window
989 sizes aren't pixel values. If it weren't the case, we wouldn't be
990 able to split windows horizontally nicely. */
991
992#define FRAME_FRINGE_COLS(F) ((F)->fringe_cols)
993
994/* Pixel-width of the left and right fringe. */
995
996#define FRAME_LEFT_FRINGE_WIDTH(F) ((F)->left_fringe_width)
997#define FRAME_RIGHT_FRINGE_WIDTH(F) ((F)->right_fringe_width)
998
999/* Total width of fringes in pixels. */
1000
1001#define FRAME_TOTAL_FRINGE_WIDTH(F) \
1002 (FRAME_LEFT_FRINGE_WIDTH (F) + FRAME_RIGHT_FRINGE_WIDTH (F))
1003
1004
1005/* Pixel-width of internal border lines */
1006
1007#define FRAME_INTERNAL_BORDER_WIDTH(F) ((F)->internal_border_width)
177c0ea7 1008
aa5b8e15
GM
1009#else /* not HAVE_WINDOW_SYSTEM */
1010
986f10ad 1011#define FRAME_FRINGE_COLS(F) 0
b45afe99 1012#define FRAME_TOTAL_FRINGE_WIDTH(F) 0
986f10ad 1013#define FRAME_LEFT_FRINGE_WIDTH(F) 0
8432bb78 1014#define FRAME_RIGHT_FRINGE_WIDTH(F) 0
b45afe99 1015#define FRAME_INTERNAL_BORDER_WIDTH(F) 0
aa5b8e15
GM
1016
1017#endif /* not HAVE_WINDOW_SYSTEM */
177c0ea7 1018
3b83d631
GM
1019
1020
1021\f
1022/***********************************************************************
1023 Conversion between canonical units and pixels
1024 ***********************************************************************/
1025
b45afe99
KS
1026/* Canonical x-values are fractions of FRAME_COLUMN_WIDTH, canonical
1027 y-unit are fractions of FRAME_LINE_HEIGHT of a frame. Both are
1028 represented as Lisp numbers, i.e. integers or floats. */
3b83d631
GM
1029
1030/* Convert canonical value X to pixels. F is the frame whose
1031 canonical char width is to be used. X must be a Lisp integer or
1032 float. Value is a C integer. */
177c0ea7 1033
b45afe99 1034#define FRAME_PIXEL_X_FROM_CANON_X(F, X) \
021f2e1a
AS
1035 (INTEGERP (X) \
1036 ? XINT (X) * FRAME_COLUMN_WIDTH (F) \
1037 : (int) (XFLOAT_DATA (X) * FRAME_COLUMN_WIDTH (F)))
177c0ea7 1038
3b83d631
GM
1039/* Convert canonical value Y to pixels. F is the frame whose
1040 canonical character height is to be used. X must be a Lisp integer
1041 or float. Value is a C integer. */
177c0ea7 1042
b45afe99 1043#define FRAME_PIXEL_Y_FROM_CANON_Y(F, Y) \
021f2e1a
AS
1044 (INTEGERP (Y) \
1045 ? XINT (Y) * FRAME_LINE_HEIGHT (F) \
1046 : (int) (XFLOAT_DATA (Y) * FRAME_LINE_HEIGHT (F)))
3b83d631
GM
1047
1048/* Convert pixel-value X to canonical units. F is the frame whose
1049 canonical character width is to be used. X is a C integer. Result
1050 is a Lisp float if X is not a multiple of the canon width,
1051 otherwise it's a Lisp integer. */
1052
b45afe99 1053#define FRAME_CANON_X_FROM_PIXEL_X(F, X) \
021f2e1a
AS
1054 ((X) % FRAME_COLUMN_WIDTH (F) != 0 \
1055 ? make_float ((double) (X) / FRAME_COLUMN_WIDTH (F)) \
1056 : make_number ((X) / FRAME_COLUMN_WIDTH (F)))
3b83d631
GM
1057
1058/* Convert pixel-value Y to canonical units. F is the frame whose
1059 canonical character height is to be used. Y is a C integer.
1060 Result is a Lisp float if Y is not a multiple of the canon width,
1061 otherwise it's a Lisp integer. */
1062
b45afe99 1063#define FRAME_CANON_Y_FROM_PIXEL_Y(F, Y) \
021f2e1a
AS
1064 ((Y) % FRAME_LINE_HEIGHT (F) \
1065 ? make_float ((double) (Y) / FRAME_LINE_HEIGHT (F)) \
1066 : make_number ((Y) / FRAME_LINE_HEIGHT (F)))
b45afe99
KS
1067
1068
1069\f
1070/* Manipulating pixel sizes and character sizes.
1071 Knowledge of which factors affect the overall size of the window should
1072 be hidden in these macros, if that's possible.
1073
1074 Return the upper/left pixel position of the character cell on frame F
1075 at ROW/COL. */
1076
1077#define FRAME_LINE_TO_PIXEL_Y(f, row) \
16009a0e 1078 (((row) < FRAME_TOP_MARGIN (f) ? 0 : FRAME_INTERNAL_BORDER_WIDTH (f)) \
b45afe99
KS
1079 + (row) * FRAME_LINE_HEIGHT (f))
1080
1081#define FRAME_COL_TO_PIXEL_X(f, col) \
1082 (FRAME_INTERNAL_BORDER_WIDTH (f) \
1083 + (col) * FRAME_COLUMN_WIDTH (f))
1084
1085/* Return the pixel width/height of frame F if it has
1086 COLS columns/LINES rows. */
1087
1088#define FRAME_TEXT_COLS_TO_PIXEL_WIDTH(f, cols) \
1089 (FRAME_COL_TO_PIXEL_X (f, cols) \
1090 + (f)->scroll_bar_actual_width \
1091 + FRAME_TOTAL_FRINGE_WIDTH (f) \
1092 + FRAME_INTERNAL_BORDER_WIDTH (f))
1093
1094#define FRAME_TEXT_LINES_TO_PIXEL_HEIGHT(f, lines) \
f016f225
JD
1095 ((lines) * FRAME_LINE_HEIGHT (f) \
1096 + 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
b45afe99
KS
1097
1098
1099/* Return the row/column (zero-based) of the character cell containing
1100 the pixel on FRAME at Y/X. */
1101
1102#define FRAME_PIXEL_Y_TO_LINE(f, y) \
4b00d3b1
YM
1103 (((y) < FRAME_TOP_MARGIN_HEIGHT (f) \
1104 ? (y) \
1105 : ((y) < FRAME_TOP_MARGIN_HEIGHT (f) + FRAME_INTERNAL_BORDER_WIDTH (f) \
1106 ? (y) - (FRAME_TOP_MARGIN_HEIGHT (f) + FRAME_INTERNAL_BORDER_WIDTH (f) \
1107 /* Arrange for the division to round down. */ \
1108 + FRAME_LINE_HEIGHT (f) - 1) \
1109 : (y) - FRAME_INTERNAL_BORDER_WIDTH (f))) \
b45afe99
KS
1110 / FRAME_LINE_HEIGHT (f))
1111
1112#define FRAME_PIXEL_X_TO_COL(f, x) \
1113 (((x) - FRAME_INTERNAL_BORDER_WIDTH (f)) \
1114 / FRAME_COLUMN_WIDTH (f))
1115
1116/* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
1117 frame F? */
1118
1119#define FRAME_PIXEL_WIDTH_TO_TEXT_COLS(f, width) \
1120 (FRAME_PIXEL_X_TO_COL (f, ((width) \
1121 - FRAME_INTERNAL_BORDER_WIDTH (f) \
1122 - FRAME_TOTAL_FRINGE_WIDTH (f) \
1123 - (f)->scroll_bar_actual_width)))
1124
1125#define FRAME_PIXEL_HEIGHT_TO_TEXT_LINES(f, height) \
1126 (FRAME_PIXEL_Y_TO_LINE (f, ((height) \
1127 - FRAME_INTERNAL_BORDER_WIDTH (f))))
177c0ea7 1128
c7cc32f7
DA
1129/* Value is the smallest width of any character in any font on frame F. */
1130
1131#define FRAME_SMALLEST_CHAR_WIDTH(f) \
1132 FRAME_DISPLAY_INFO (f)->smallest_char_width
1133
1134/* Value is the smallest height of any font on frame F. */
1135
1136#define FRAME_SMALLEST_FONT_HEIGHT(f) \
1137 FRAME_DISPLAY_INFO (f)->smallest_font_height
5e02ce11
KS
1138
1139/***********************************************************************
1140 Frame Parameters
1141 ***********************************************************************/
1142
1143extern Lisp_Object Qauto_raise, Qauto_lower;
1144extern Lisp_Object Qborder_color, Qborder_width;
955cbe7b 1145extern Lisp_Object Qbuffer_predicate;
5e02ce11
KS
1146extern Lisp_Object Qcursor_color, Qcursor_type;
1147extern Lisp_Object Qfont;
1148extern Lisp_Object Qbackground_color, Qforeground_color;
1149extern Lisp_Object Qicon, Qicon_name, Qicon_type, Qicon_left, Qicon_top;
1150extern Lisp_Object Qinternal_border_width;
99f3388e 1151extern Lisp_Object Qtooltip;
2b4e6277 1152extern Lisp_Object Qmenu_bar_lines, Qtool_bar_lines, Qtool_bar_position;
5e02ce11
KS
1153extern Lisp_Object Qmouse_color;
1154extern Lisp_Object Qname, Qtitle;
1155extern Lisp_Object Qparent_id;
1156extern Lisp_Object Qunsplittable, Qvisibility;
1157extern Lisp_Object Qscroll_bar_width, Qvertical_scroll_bars;
1158extern Lisp_Object Qscroll_bar_foreground, Qscroll_bar_background;
1159extern Lisp_Object Qscreen_gamma;
1160extern Lisp_Object Qline_spacing;
1161extern Lisp_Object Qwait_for_wm;
1162extern Lisp_Object Qfullscreen;
3f1c6666 1163extern Lisp_Object Qfullwidth, Qfullheight, Qfullboth, Qmaximized;
acd51077 1164extern Lisp_Object Qsticky;
1a8a83b2 1165extern Lisp_Object Qfont_backend;
50a73869 1166extern Lisp_Object Qalpha;
5e02ce11
KS
1167
1168extern Lisp_Object Qleft_fringe, Qright_fringe;
1169extern Lisp_Object Qheight, Qwidth;
1170extern Lisp_Object Qminibuffer, Qmodeline;
4b298d5a 1171extern Lisp_Object Qx, Qw32, Qpc, Qns;
5e02ce11
KS
1172extern Lisp_Object Qvisible;
1173extern Lisp_Object Qdisplay_type;
5e02ce11
KS
1174
1175extern Lisp_Object Qx_resource_name;
1176
bfeabdc3 1177extern Lisp_Object Qleft, Qright, Qtop, Qbox, Qbottom;
5e02ce11
KS
1178extern Lisp_Object Qdisplay;
1179
99f3388e
DN
1180extern Lisp_Object Qrun_hook_with_args;
1181
5e02ce11
KS
1182#ifdef HAVE_WINDOW_SYSTEM
1183
1184/* The class of this X application. */
1185#define EMACS_CLASS "Emacs"
1186
5e02ce11
KS
1187/* These are in xterm.c, w32term.c, etc. */
1188
383e0970
J
1189extern void x_set_scroll_bar_default_width (struct frame *);
1190extern void x_set_offset (struct frame *, int, int, int);
a10c8269 1191extern void x_wm_set_size_hint (struct frame *f, long flags, bool user_position);
5e02ce11 1192
383e0970 1193extern Lisp_Object x_new_font (struct frame *, Lisp_Object, int);
5e02ce11 1194
5e02ce11
KS
1195
1196extern Lisp_Object Qface_set_after_frame_default;
1197
0fda9b75 1198#ifdef HAVE_NTGUI
383e0970
J
1199extern void x_fullscreen_adjust (struct frame *f, int *, int *,
1200 int *, int *);
81626931 1201#endif
383e0970
J
1202
1203extern void x_set_frame_parameters (struct frame *, Lisp_Object);
383e0970
J
1204
1205extern void x_set_fullscreen (struct frame *, Lisp_Object, Lisp_Object);
1206extern void x_set_line_spacing (struct frame *, Lisp_Object, Lisp_Object);
1207extern void x_set_screen_gamma (struct frame *, Lisp_Object, Lisp_Object);
1208extern void x_set_font (struct frame *, Lisp_Object, Lisp_Object);
1209extern void x_set_font_backend (struct frame *, Lisp_Object, Lisp_Object);
1210extern void x_set_fringe_width (struct frame *, Lisp_Object, Lisp_Object);
1211extern void x_set_border_width (struct frame *, Lisp_Object, Lisp_Object);
1212extern void x_set_internal_border_width (struct frame *, Lisp_Object,
1213 Lisp_Object);
1214extern void x_set_visibility (struct frame *, Lisp_Object, Lisp_Object);
1215extern void x_set_autoraise (struct frame *, Lisp_Object, Lisp_Object);
1216extern void x_set_autolower (struct frame *, Lisp_Object, Lisp_Object);
1217extern void x_set_unsplittable (struct frame *, Lisp_Object, Lisp_Object);
1218extern void x_set_vertical_scroll_bars (struct frame *, Lisp_Object,
1219 Lisp_Object);
1220extern void x_set_scroll_bar_width (struct frame *, Lisp_Object,
1221 Lisp_Object);
1222
959067a1 1223extern long x_figure_window_size (struct frame *, Lisp_Object, bool);
5e02ce11 1224
383e0970 1225extern void x_set_alpha (struct frame *, Lisp_Object, Lisp_Object);
5e02ce11 1226
383e0970 1227extern void validate_x_resource_name (void);
0ff162fc 1228
facfbbbd
SM
1229extern Lisp_Object display_x_get_resource (Display_Info *,
1230 Lisp_Object attribute,
1231 Lisp_Object class,
1232 Lisp_Object component,
1233 Lisp_Object subclass);
1234
18e27ea8 1235extern void set_frame_menubar (struct frame *f, bool first_time, bool deep_p);
17a2cbbd
DC
1236extern void x_set_window_size (struct frame *f, int change_grav,
1237 int cols, int rows);
17a2cbbd
DC
1238extern Lisp_Object x_get_focus_frame (struct frame *);
1239extern void x_set_mouse_position (struct frame *f, int h, int v);
1240extern void x_set_mouse_pixel_position (struct frame *f, int pix_x, int pix_y);
1241extern void x_make_frame_visible (struct frame *f);
1242extern void x_make_frame_invisible (struct frame *f);
1243extern void x_iconify_frame (struct frame *f);
17a2cbbd
DC
1244extern void x_set_frame_alpha (struct frame *f);
1245extern void x_set_menu_bar_lines (struct frame *, Lisp_Object, Lisp_Object);
1246extern void x_set_tool_bar_lines (struct frame *f,
1247 Lisp_Object value,
1248 Lisp_Object oldval);
1249extern void x_activate_menubar (struct frame *);
1250extern void x_real_positions (struct frame *, int *, int *);
17a2cbbd
DC
1251extern void free_frame_menubar (struct frame *);
1252extern void x_free_frame_resources (struct frame *);
1253
52b8a085
DA
1254#if defined HAVE_X_WINDOWS
1255extern void x_wm_set_icon_position (struct frame *, int, int);
1256#if !defined USE_X_TOOLKIT
018c5e19
PE
1257extern char *x_get_resource_string (const char *, const char *);
1258#endif
83fc0554
DA
1259extern void x_sync (struct frame *);
1260#endif /* HAVE_X_WINDOWS */
018c5e19 1261
17a2cbbd 1262extern void x_query_colors (struct frame *f, XColor *, int);
0fda9b75 1263extern void x_query_color (struct frame *f, XColor *);
fcd42c11 1264extern void x_focus_frame (struct frame *);
17a2cbbd 1265
2cd98812
DA
1266#ifndef HAVE_NS
1267
1268extern int x_bitmap_icon (struct frame *, Lisp_Object);
1269
1270/* Set F's bitmap icon, if specified among F's parameters. */
1271
00382e8b 1272INLINE void
2cd98812
DA
1273x_set_bitmap_icon (struct frame *f)
1274{
1275 Lisp_Object obj = assq_no_quit (Qicon_type, f->param_alist);
1276
1277 if (CONSP (obj))
1278 x_bitmap_icon (f, XCDR (obj));
1279}
1280
1281#endif /* !HAVE_NS */
1282
5e02ce11 1283#endif /* HAVE_WINDOW_SYSTEM */
fd462129 1284
00382e8b 1285INLINE void
fd462129
DA
1286flush_frame (struct frame *f)
1287{
1288 struct redisplay_interface *rif = FRAME_RIF (f);
1289
1290 if (rif && rif->flush_display)
1291 rif->flush_display (f);
1292}
1293
6799bb26
JD
1294/***********************************************************************
1295 Multimonitor data
1296 ***********************************************************************/
1297
1298#ifdef HAVE_WINDOW_SYSTEM
1299
1300struct MonitorInfo {
1301 XRectangle geom, work;
1302 int mm_width, mm_height;
1303 char *name;
1304};
1305
1306extern void free_monitors (struct MonitorInfo *monitors, int n_monitors);
1307extern Lisp_Object make_monitor_attribute_list (struct MonitorInfo *monitors,
1308 int n_monitors,
1309 int primary_monitor,
1310 Lisp_Object monitor_frames,
1311 const char *source);
1312
1313#endif /* HAVE_WINDOW_SYSTEM */
1314
5e02ce11 1315
f00af5b1
PE
1316INLINE_HEADER_END
1317
84e01749 1318#endif /* not EMACS_FRAME_H */