* lisp/progmodes/ruby-mode.el (ruby-operator-re): Consider line
[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
PE
29INLINE_HEADER_BEGIN
30#ifndef FRAME_INLINE
31# define FRAME_INLINE INLINE
32#endif
33
a3211441 34enum vertical_scroll_bar_type
3b83d631
GM
35{
36 vertical_scroll_bar_none,
37 vertical_scroll_bar_left,
38 vertical_scroll_bar_right
39};
a3211441 40
2806a183
SM
41enum fullscreen_type
42{
3f1c6666
JD
43 FULLSCREEN_NONE,
44 FULLSCREEN_WIDTH = 0x001,
45 FULLSCREEN_HEIGHT = 0x002,
46 FULLSCREEN_BOTH = 0x003,
47 FULLSCREEN_MAXIMIZED = 0x013,
48 FULLSCREEN_WAIT = 0x100
2806a183
SM
49};
50
9d7693d7 51/* The structure representing a frame. */
adf494ff 52
ff11dfa1 53struct frame
efa4ce8b 54{
b102ceb1 55 struct vectorlike_header header;
efa4ce8b 56
21015f9c 57 /* All Lisp_Object components must come first.
21015f9c 58 That ensures they are all aligned normally. */
efa4ce8b 59
fa5d1baa
RS
60 /* Name of this frame: a Lisp string. It is used for looking up resources,
61 as well as for the title in some cases. */
e69b0960 62 Lisp_Object name;
efa4ce8b 63
e7f79a67
RS
64 /* The name to use for the icon, the last time
65 it was refreshed. nil means not explicitly specified. */
e69b0960 66 Lisp_Object icon_name;
e7f79a67 67
fa5d1baa
RS
68 /* This is the frame title specified explicitly, if any.
69 Usually it is nil. */
e69b0960 70 Lisp_Object title;
fa5d1baa 71
eb8c3be9 72 /* The frame which should receive keystrokes that occur in this
46a5c487
JB
73 frame, or nil if they should go to the frame itself. This is
74 usually nil, but if the frame is minibufferless, we can use this
75 to redirect keystrokes to a surrogate minibuffer frame when
76 needed.
77
78 Note that a value of nil is different than having the field point
79 to the frame itself. Whenever the Fselect_frame function is used
80 to shift from one frame to the other, any redirections to the
81 original frame are shifted to the newly selected frame; if
82 focus_frame is nil, Fselect_frame will leave it alone. */
e69b0960 83 Lisp_Object focus_frame;
0f79a4ae 84
ff11dfa1
JB
85 /* This frame's root window. Every frame has one.
86 If the frame has only a minibuffer window, this is it.
87 Otherwise, if the frame has a minibuffer window, this is its sibling. */
e69b0960 88 Lisp_Object root_window;
efa4ce8b 89
ff11dfa1
JB
90 /* This frame's selected window.
91 Each frame has its own window hierarchy
92 and one of the windows in it is selected within the frame.
93 The selected window of the selected frame is Emacs's selected window. */
e69b0960 94 Lisp_Object selected_window;
efa4ce8b 95
ff11dfa1
JB
96 /* This frame's minibuffer window.
97 Most frames have their own minibuffer windows,
98 but only the selected frame's minibuffer window
efa4ce8b 99 can actually appear to exist. */
e69b0960 100 Lisp_Object minibuffer_window;
efa4ce8b 101
ff11dfa1
JB
102 /* Parameter alist of this frame.
103 These are the parameters specified when creating the frame
104 or modified with modify-frame-parameters. */
e69b0960 105 Lisp_Object param_alist;
efa4ce8b 106
177c0ea7 107 /* List of scroll bars on this frame.
20a6c8d7 108 Actually, we don't specify exactly what is stored here at all; the
a3c87d4e 109 scroll bar implementation code can use it to store anything it likes.
20a6c8d7 110 This field is marked by the garbage collector. It is here
7e59217d 111 instead of in the `device' structure so that the garbage
20a6c8d7
JB
112 collector doesn't need to look inside the window-system-dependent
113 structure. */
e69b0960
DA
114 Lisp_Object scroll_bars;
115 Lisp_Object condemned_scroll_bars;
20a6c8d7 116
ad6cd733
RS
117 /* Vector describing the items to display in the menu bar.
118 Each item has four elements in this vector.
119 They are KEY, STRING, SUBMAP, and HPOS.
120 (HPOS is not used in when the X toolkit is in use.)
121 There are four additional elements of nil at the end, to terminate. */
e69b0960 122 Lisp_Object menu_bar_items;
6d05db81 123
fb63ba7d 124 /* Alist of elements (FACE-NAME . FACE-VECTOR-DATA). */
e69b0960 125 Lisp_Object face_alist;
fb63ba7d 126
21015f9c
RS
127 /* A vector that records the entire structure of this frame's menu bar.
128 For the format of the data, see extensive comments in xmenu.c.
129 Only the X toolkit version uses this. */
e69b0960 130 Lisp_Object menu_bar_vector;
21015f9c
RS
131
132 /* Predicate for selecting buffers for other-buffer. */
e69b0960 133 Lisp_Object buffer_predicate;
21015f9c 134
375ff4f1 135 /* List of buffers viewed in this frame, for other-buffer. */
e69b0960 136 Lisp_Object buffer_list;
375ff4f1 137
a18b8cb5
KL
138 /* List of buffers that were viewed, then buried in this frame. The
139 most recently buried buffer is first. For last-buffer. */
e69b0960 140 Lisp_Object buried_buffer_list;
63bb3d8e 141
5a49b79c 142#if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
3b83d631
GM
143 /* A dummy window used to display menu bars under X when no X
144 toolkit support is available. */
e69b0960 145 Lisp_Object menu_bar_window;
5a49b79c 146#endif
3b83d631 147
742516e0 148#if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
9ea173e8 149 /* A window used to display the tool-bar of a frame. */
e69b0960 150 Lisp_Object tool_bar_window;
3b83d631 151
742516e0
DA
152 /* Desired and current contents displayed in that window. */
153 Lisp_Object desired_tool_bar_string;
154 Lisp_Object current_tool_bar_string;
155#endif
156
9ea173e8 157 /* Desired and current tool-bar items. */
e69b0960 158 Lisp_Object tool_bar_items;
3b83d631 159
bfeabdc3
JD
160 /* Where tool bar is, can be left, right, top or bottom. The native
161 tool bar only supports top. */
e69b0960 162 Lisp_Object tool_bar_position;
bfeabdc3 163
63bb3d8e 164 /* Beyond here, there should be no more Lisp_Object components. */
21015f9c 165
3b83d631
GM
166 /* Cache of realized faces. */
167 struct face_cache *face_cache;
21015f9c 168
a390930c 169 /* Number of elements in `menu_bar_vector' that have meaningful data. */
d230cb74 170 int menu_bar_items_used;
a390930c 171
3b83d631
GM
172 /* A buffer to hold the frame's name. We can't use the Lisp
173 string's pointer (`name', above) because it might get relocated. */
bd601e2a
KH
174 char *namebuf;
175
b09cca6a 176 /* Glyph pool and matrix. */
3b83d631
GM
177 struct glyph_pool *current_pool;
178 struct glyph_pool *desired_pool;
179 struct glyph_matrix *desired_matrix;
180 struct glyph_matrix *current_matrix;
181
182 /* 1 means that glyphs on this frame have been initialized so it can
183 be used for output. */
184 unsigned glyphs_initialized_p : 1;
21015f9c 185
e3d7bd83
DN
186 /* Set to non-zero in change_frame_size when size of frame changed
187 Clear the frame in clear_garbaged_frames if set. */
188 unsigned resized_p : 1;
189
e3d7bd83
DN
190 /* Set to non-zero if the default face for the frame has been
191 realized. Reset to zero whenever the default face changes.
192 Used to see the difference between a font change and face change. */
193 unsigned default_face_done_p : 1;
194
195 /* Set to non-zero if this frame has already been hscrolled during
196 current redisplay. */
197 unsigned already_hscrolled_p : 1;
198
199 /* Set to non-zero when current redisplay has updated frame. */
200 unsigned updated_p : 1;
201
742516e0 202#if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
e3d7bd83
DN
203 /* Set to non-zero to minimize tool-bar height even when
204 auto-resize-tool-bar is set to grow-only. */
205 unsigned minimize_tool_bar_window_p : 1;
742516e0 206#endif
e3d7bd83 207
9e2a2647 208#if defined (USE_GTK) || defined (HAVE_NS)
488dd4c4 209 /* Nonzero means using a tool bar that comes from the toolkit. */
be49ba74 210 unsigned external_tool_bar : 1;
488dd4c4
JD
211#endif
212
bd0443bb
DA
213 /* Nonzero means that fonts have been loaded since the last glyph
214 matrix adjustments. */
215 unsigned fonts_changed : 1;
216
7f6c6450
DA
217 /* Nonzero means that cursor type has been changed. */
218 unsigned cursor_type_changed : 1;
219
9ea173e8
GM
220 /* Margin at the top of the frame. Used to display the tool-bar. */
221 int tool_bar_lines;
3b83d631 222
045cff16 223 int n_tool_bar_rows;
e3303a23 224 int n_tool_bar_items;
177c0ea7 225
3b83d631
GM
226 /* A buffer for decode_mode_line. */
227 char *decode_mode_spec_buffer;
21015f9c
RS
228
229 /* See do_line_insertion_deletion_costs for info on these arrays. */
230 /* Cost of inserting 1 line on this frame */
231 int *insert_line_cost;
232 /* Cost of deleting 1 line on this frame */
233 int *delete_line_cost;
234 /* Cost of inserting n lines on this frame */
235 int *insert_n_lines_cost;
236 /* Cost of deleting n lines on this frame */
237 int *delete_n_lines_cost;
238
b45afe99
KS
239 /* Size of this frame, excluding fringes, scroll bars etc.,
240 in units of canonical characters. */
2f645268 241 int text_lines, text_cols;
b45afe99
KS
242
243 /* Total size of this frame (i.e. its native window), in units of
244 canonical characters. */
2f645268 245 int total_lines, total_cols;
b45afe99
KS
246
247 /* New text height and width for pending size change.
248 0 if no change pending. */
249 int new_text_lines, new_text_cols;
250
251 /* Pixel position of the frame window (x and y offsets in root window). */
252 int left_pos, top_pos;
253
254 /* Size of the frame window in pixels. */
255 int pixel_height, pixel_width;
256
257 /* These many pixels are the difference between the outer window (i.e. the
258 left and top of the window manager decoration) and FRAME_X_WINDOW. */
259 int x_pixels_diff, y_pixels_diff;
260
261 /* This is the gravity value for the specified window position. */
262 int win_gravity;
263
264 /* The geometry flags for this window. */
265 int size_hint_flags;
21015f9c 266
b45afe99
KS
267 /* Border width of the frame window as known by the (X) window system. */
268 int border_width;
269
270 /* Width of the internal border. This is a line of background color
271 just inside the window's border. When the frame is selected,
272 a highlighting is displayed inside the internal border. */
273 int internal_border_width;
274
275 /* Canonical X unit. Width of default font, in pixels. */
276 int column_width;
277
278 /* Canonical Y unit. Height of a line, in pixels. */
279 int line_height;
21015f9c 280
428a555e
KL
281 /* The output method says how the contents of this frame are
282 displayed. It could be using termcap, or using an X window.
6ed8eeff 283 This must be the same as the terminal->type. */
efa4ce8b
JB
284 enum output_method output_method;
285
6ed8eeff 286 /* The terminal device that this frame uses. If this is NULL, then
7e59217d 287 the frame has been deleted. */
6ed8eeff 288 struct terminal *terminal;
63bb3d8e 289
7e59217d 290 /* Device-dependent, frame-local auxiliary data used for displaying
428a555e
KL
291 the contents. When the frame is deleted, this data is deleted as
292 well. */
3b83d631
GM
293 union output_data
294 {
428a555e
KL
295 struct tty_output *tty; /* termchar.h */
296 struct x_output *x; /* xterm.h */
297 struct w32_output *w32; /* w32term.h */
edfda783 298 struct ns_output *ns; /* nsterm.h */
d311d28c 299 intptr_t nothing;
3b83d631
GM
300 }
301 output_data;
efa4ce8b 302
adf494ff
KH
303 /* List of font-drivers available on the frame. */
304 struct font_driver_list *font_driver_list;
6aae9c92
KH
305 /* List of data specific to font-driver and frame, but common to
306 faces. */
307 struct font_data_list *font_data_list;
adf494ff 308
b45afe99
KS
309 /* Total width of fringes reserved for drawing truncation bitmaps,
310 continuation bitmaps and alike. The width is in canonical char
311 units of the frame. This must currently be the case because window
312 sizes aren't pixel values. If it weren't the case, we wouldn't be
313 able to split windows horizontally nicely. */
314 int fringe_cols;
315
316 /* The extra width (in pixels) currently allotted for fringes. */
317 int left_fringe_width, right_fringe_width;
318
b45afe99 319 /* See FULLSCREEN_ enum below */
2806a183 320 enum fullscreen_type want_fullscreen;
b45afe99 321
6d05db81
RS
322 /* Number of lines of menu bar. */
323 int menu_bar_lines;
324
9e2a2647 325#if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
edfda783 326 || defined (HAVE_NS) || defined (USE_GTK)
9c95189b 327 /* Nonzero means using a menu bar that comes from the X toolkit. */
2806a183 328 unsigned int external_menu_bar : 1;
9c95189b
RS
329#endif
330
edfa7fa0
DA
331 /* Next two bitfields are mutually exclusive. They might both be
332 zero if the frame has been made invisible without an icon. */
333
334 /* Nonzero if the frame is currently displayed; we check
a4659527 335 it to see if we should bother updating the frame's contents.
efa4ce8b 336
20a6c8d7 337 Note that, since invisible frames aren't updated, whenever a
edfa7fa0 338 frame becomes visible again, it must be marked as garbaged.
20a6c8d7 339
6548cf00
KL
340 On ttys and on Windows NT/9X, to avoid wasting effort updating
341 visible frames that are actually completely obscured by other
342 windows on the display, we bend the meaning of visible slightly:
edfa7fa0 343 if equal to 2, then the frame is obscured - we still consider
6548cf00
KL
344 it to be "visible" as seen from lisp, but we don't bother
345 updating it. We must take care to garbage the frame when it
edfa7fa0 346 ceases to be obscured though. See SET_FRAME_VISIBLE below. */
4e0f6479 347 unsigned visible : 2;
a4659527 348
edfa7fa0
DA
349 /* Nonzero if the frame is currently iconified. Do not
350 set this directly, use SET_FRAME_ICONIFIED instead. */
351 unsigned iconified : 1;
efa4ce8b 352
ff11dfa1 353 /* Nonzero if this frame should be redrawn. */
edfa7fa0 354 unsigned garbaged : 1;
efa4ce8b 355
ff11dfa1
JB
356 /* True if frame actually has a minibuffer window on it.
357 0 if using a minibuffer window that isn't on this frame. */
4e0f6479 358 unsigned has_minibuffer : 1;
177c0ea7 359
ff11dfa1 360 /* 0 means, if this frame has just one window,
efa4ce8b 361 show no modeline for that window. */
4e0f6479 362 unsigned wants_modeline : 1;
efa4ce8b 363
ff11dfa1 364 /* Non-0 means raise this frame to the top of the heap when selected. */
4e0f6479 365 unsigned auto_raise : 1;
efa4ce8b 366
ff11dfa1 367 /* Non-0 means lower this frame to the bottom of the stack when left. */
4e0f6479 368 unsigned auto_lower : 1;
efa4ce8b 369
ff11dfa1 370 /* True if frame's root window can't be split. */
4e0f6479 371 unsigned no_split : 1;
efa4ce8b 372
fbfed6f0
JB
373 /* If this is set, then Emacs won't change the frame name to indicate
374 the current buffer, etcetera. If the user explicitly sets the frame
375 name, this gets set. If the user sets the name to Qnil, this is
376 cleared. */
4e0f6479 377 unsigned explicit_name : 1;
fbfed6f0 378
adc12f0f 379 /* Nonzero if size of some window on this frame has changed. */
4e0f6479 380 unsigned window_sizes_changed : 1;
adc12f0f 381
e3d7bd83
DN
382 /* Nonzero if the mouse has moved on this display device
383 since the last time we checked. */
4e0f6479 384 unsigned mouse_moved :1;
e3d7bd83 385
e044e4fc 386 /* Nonzero means that the pointer is invisible. */
4e0f6479 387 unsigned pointer_invisible :1;
e044e4fc 388
d2e113bc
DA
389 /* Nonzero means that all windows except mini-window and
390 selected window on this frame have frozen window starts. */
391 unsigned frozen_window_starts : 1;
392
3737fee7 393 /* Nonzero if we should actually display the scroll bars on this frame. */
e3d7bd83
DN
394 enum vertical_scroll_bar_type vertical_scroll_bar_type;
395
396 /* What kind of text cursor should we draw in the future?
397 This should always be filled_box_cursor or bar_cursor. */
398 enum text_cursor_kinds desired_cursor;
399
400 /* Width of bar cursor (if we are using that). */
401 int cursor_width;
402
403 /* What kind of text cursor should we draw when the cursor blinks off?
404 This can be filled_box_cursor or bar_cursor or no_cursor. */
405 enum text_cursor_kinds blink_off_cursor;
406
407 /* Width of bar cursor (if we are using that) for blink-off state. */
408 int blink_off_cursor_width;
409
b45afe99
KS
410 /* Configured width of the scroll bar, in pixels and in characters.
411 config_scroll_bar_cols tracks config_scroll_bar_width if the
412 latter is positive; a zero value in config_scroll_bar_width means
413 to compute the actual width on the fly, using config_scroll_bar_cols
414 and the current font width. */
415 int config_scroll_bar_width;
416 int config_scroll_bar_cols;
417
418 /* The size of the extra width currently allotted for vertical
419 scroll bars in this frame, in pixels. */
420 int scroll_bar_actual_width;
95b999aa
RS
421
422 /* The baud rate that was used to calculate costs for this frame. */
423 int cost_calculation_baud_rate;
6462918c 424
91a47a68
DN
425 /* frame opacity
426 alpha[0]: alpha transparency of the active frame
f2d5c00f
CY
427 alpha[1]: alpha transparency of inactive frames
428 Negative values mean not to change alpha. */
91a47a68
DN
429 double alpha[2];
430
b61cbba3
GM
431 /* Exponent for gamma correction of colors. 1/(VIEWING_GAMMA *
432 SCREEN_GAMMA) where viewing_gamma is 0.4545 and SCREEN_GAMMA is a
433 frame parameter. 0 means don't do gamma correction. */
434 double gamma;
d1738c45
GM
435
436 /* Additional space to put between text lines on this frame. */
437 int extra_line_spacing;
f1c69c61 438
28d7d09f
KL
439 /* All display backends seem to need these two pixel values. */
440 unsigned long background_pixel;
441 unsigned long foreground_pixel;
efa4ce8b
JB
442};
443
f00af5b1
PE
444/* Most code should use these functions to set Lisp fields in struct frame. */
445
446FRAME_INLINE void
447fset_buffer_list (struct frame *f, Lisp_Object val)
448{
449 f->buffer_list = val;
450}
451FRAME_INLINE void
452fset_buried_buffer_list (struct frame *f, Lisp_Object val)
453{
454 f->buried_buffer_list = val;
455}
456FRAME_INLINE void
457fset_condemned_scroll_bars (struct frame *f, Lisp_Object val)
458{
459 f->condemned_scroll_bars = val;
460}
461FRAME_INLINE void
f00af5b1
PE
462fset_face_alist (struct frame *f, Lisp_Object val)
463{
464 f->face_alist = val;
465}
466FRAME_INLINE void
467fset_focus_frame (struct frame *f, Lisp_Object val)
468{
469 f->focus_frame = val;
470}
471FRAME_INLINE void
472fset_icon_name (struct frame *f, Lisp_Object val)
473{
474 f->icon_name = val;
475}
476FRAME_INLINE void
477fset_menu_bar_items (struct frame *f, Lisp_Object val)
478{
479 f->menu_bar_items = val;
480}
481FRAME_INLINE void
482fset_menu_bar_vector (struct frame *f, Lisp_Object val)
483{
484 f->menu_bar_vector = val;
485}
5a49b79c 486#if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
f00af5b1
PE
487FRAME_INLINE void
488fset_menu_bar_window (struct frame *f, Lisp_Object val)
489{
490 f->menu_bar_window = val;
491}
5a49b79c 492#endif
f00af5b1
PE
493FRAME_INLINE void
494fset_name (struct frame *f, Lisp_Object val)
495{
496 f->name = val;
497}
498FRAME_INLINE void
499fset_param_alist (struct frame *f, Lisp_Object val)
500{
501 f->param_alist = val;
502}
503FRAME_INLINE void
504fset_root_window (struct frame *f, Lisp_Object val)
505{
506 f->root_window = val;
507}
508FRAME_INLINE void
509fset_scroll_bars (struct frame *f, Lisp_Object val)
510{
511 f->scroll_bars = val;
512}
513FRAME_INLINE void
514fset_selected_window (struct frame *f, Lisp_Object val)
515{
516 f->selected_window = val;
517}
518FRAME_INLINE void
519fset_title (struct frame *f, Lisp_Object val)
520{
521 f->title = val;
522}
523FRAME_INLINE void
524fset_tool_bar_items (struct frame *f, Lisp_Object val)
525{
526 f->tool_bar_items = val;
527}
528FRAME_INLINE void
529fset_tool_bar_position (struct frame *f, Lisp_Object val)
530{
531 f->tool_bar_position = val;
532}
742516e0 533#if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
f00af5b1
PE
534FRAME_INLINE void
535fset_tool_bar_window (struct frame *f, Lisp_Object val)
536{
537 f->tool_bar_window = val;
538}
742516e0
DA
539FRAME_INLINE void
540fset_current_tool_bar_string (struct frame *f, Lisp_Object val)
541{
542 f->current_tool_bar_string = val;
543}
544FRAME_INLINE void
545fset_desired_tool_bar_string (struct frame *f, Lisp_Object val)
546{
547 f->desired_tool_bar_string = val;
548}
549#endif /* HAVE_WINDOW_SYSTEM && !USE_GTK && !HAVE_NS */
f00af5b1 550
42143acd
DA
551#define NUMVAL(X) ((INTEGERP (X) || FLOATP (X)) ? XFLOATINT (X) : -1)
552
553FRAME_INLINE double
554default_pixels_per_inch_x (void)
555{
556 Lisp_Object v = (CONSP (Vdisplay_pixels_per_inch)
557 ? XCAR (Vdisplay_pixels_per_inch)
558 : Vdisplay_pixels_per_inch);
559 return NUMVAL (v) > 0 ? NUMVAL (v) : 72.0;
560}
561
562FRAME_INLINE double
563default_pixels_per_inch_y (void)
564{
565 Lisp_Object v = (CONSP (Vdisplay_pixels_per_inch)
566 ? XCDR (Vdisplay_pixels_per_inch)
567 : Vdisplay_pixels_per_inch);
568 return NUMVAL (v) > 0 ? NUMVAL (v) : 72.0;
569}
570
6ed8eeff 571#define FRAME_KBOARD(f) ((f)->terminal->kboard)
37ea66e1 572
354884c4
SM
573/* Return a pointer to the image cache of frame F. */
574#define FRAME_IMAGE_CACHE(F) ((F)->terminal->image_cache)
575
b263a6b0
PE
576#define XFRAME(p) \
577 (eassert (FRAMEP (p)), (struct frame *) XUNTAG (p, Lisp_Vectorlike))
aac03cca 578#define XSETFRAME(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_FRAME))
ff11dfa1 579
cea6021b 580/* Given a window, return its frame as a Lisp_Object. */
fd16b54c 581#define WINDOW_FRAME(w) ((w)->frame)
ff11dfa1 582
cea6021b 583/* Test a frame for particular kinds of display methods. */
3224dac1 584#define FRAME_INITIAL_P(f) ((f)->output_method == output_initial)
cea6021b 585#define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap)
efa7f0f9 586#define FRAME_X_P(f) ((f)->output_method == output_x_window)
0fda9b75 587#ifndef HAVE_NTGUI
ff687885
DN
588#define FRAME_W32_P(f) (0)
589#else
fbd6baed 590#define FRAME_W32_P(f) ((f)->output_method == output_w32)
ff687885
DN
591#endif
592#ifndef MSDOS
593#define FRAME_MSDOS_P(f) (0)
594#else
6f181713 595#define FRAME_MSDOS_P(f) ((f)->output_method == output_msdos_raw)
ff687885
DN
596#endif
597#ifndef HAVE_NS
598#define FRAME_NS_P(f) (0)
599#else
edfda783 600#define FRAME_NS_P(f) ((f)->output_method == output_ns)
ff687885 601#endif
42143acd 602
efa7f0f9
GV
603/* FRAME_WINDOW_P tests whether the frame is a window, and is
604 defined to be the predicate for the window system being used. */
3b83d631 605
efa7f0f9
GV
606#ifdef HAVE_X_WINDOWS
607#define FRAME_WINDOW_P(f) FRAME_X_P (f)
608#endif
609#ifdef HAVE_NTGUI
fbd6baed 610#define FRAME_WINDOW_P(f) FRAME_W32_P (f)
efa7f0f9 611#endif
edfda783
AR
612#ifdef HAVE_NS
613#define FRAME_WINDOW_P(f) FRAME_NS_P(f)
614#endif
7651b07e 615#ifndef FRAME_WINDOW_P
4973679b 616#define FRAME_WINDOW_P(f) ((void) (f), 0)
7651b07e 617#endif
efa7f0f9 618
aad3612f
DA
619/* Dots per inch of the screen the frame F is on. */
620
621#ifdef HAVE_WINDOW_SYSTEM
622
623#define FRAME_RES_X(f) \
624 (eassert (FRAME_WINDOW_P (f)), FRAME_DISPLAY_INFO (f)->resx)
625#define FRAME_RES_Y(f) \
626 (eassert (FRAME_WINDOW_P (f)), FRAME_DISPLAY_INFO (f)->resy)
627
628#else /* !HAVE_WINDOW_SYSTEM */
629
630/* Defaults when no window system available. */
631
632#define FRAME_RES_X(f) default_pixels_per_inch_x ()
633#define FRAME_RES_Y(f) default_pixels_per_inch_y ()
634
635#endif /* HAVE_WINDOW_SYSTEM */
636
7ea692f6
EZ
637/* Return a pointer to the structure holding information about the
638 region of text, if any, that is currently shown in mouse-face on
8e5ba371 639 frame F. We need to define two versions because a TTY-only build
aad3612f 640 does not have FRAME_DISPLAY_INFO. */
8e5ba371
EZ
641#ifdef HAVE_WINDOW_SYSTEM
642# define MOUSE_HL_INFO(F) \
021f2e1a 643 (FRAME_WINDOW_P(F) \
aad3612f 644 ? &FRAME_DISPLAY_INFO(F)->mouse_highlight \
021f2e1a 645 : &(F)->output_data.tty->display_info->mouse_highlight)
8e5ba371
EZ
646#else
647# define MOUSE_HL_INFO(F) \
021f2e1a 648 (&(F)->output_data.tty->display_info->mouse_highlight)
8e5ba371 649#endif
7ea692f6 650
cea6021b 651/* Nonzero if frame F is still alive (not deleted). */
6ed8eeff 652#define FRAME_LIVE_P(f) ((f)->terminal != 0)
cea6021b
RS
653
654/* Nonzero if frame F is a minibuffer-only frame. */
ff11dfa1
JB
655#define FRAME_MINIBUF_ONLY_P(f) \
656 EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f))
cea6021b
RS
657
658/* Nonzero if frame F contains a minibuffer window.
659 (If this is 0, F must use some other minibuffer window.) */
10a4cc63 660#define FRAME_HAS_MINIBUF_P(f) ((f)->has_minibuffer)
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
5e02ce11 926extern Lisp_Object Qframep, Qframe_live_p;
2666355c 927extern Lisp_Object Qtty, Qtty_type;
8848b728 928extern Lisp_Object Qtty_color_mode;
959067a1 929extern Lisp_Object Qterminal;
c53956fe 930extern Lisp_Object Qnoelisp;
efa4ce8b 931
9d7693d7
DA
932/* Nonzero means there is at least one garbaged frame. */
933extern bool frame_garbaged;
934
ff11dfa1 935extern struct frame *last_nonminibuf_frame;
efa4ce8b 936
0ff162fc 937extern void set_menu_bar_lines (struct frame *, Lisp_Object, Lisp_Object);
7452b7bd 938extern struct frame *decode_window_system_frame (Lisp_Object);
d9f07150
DA
939extern struct frame *decode_live_frame (Lisp_Object);
940extern struct frame *decode_any_frame (Lisp_Object);
383e0970 941extern struct frame *make_initial_frame (void);
959067a1 942extern struct frame *make_frame (bool);
c9e5d3d1 943#ifdef HAVE_WINDOW_SYSTEM
383e0970
J
944extern struct frame *make_minibuffer_frame (void);
945extern struct frame *make_frame_without_minibuffer (Lisp_Object,
946 struct kboard *,
947 Lisp_Object);
c9e5d3d1 948#endif /* HAVE_WINDOW_SYSTEM */
7452b7bd
DA
949extern bool window_system_available (struct frame *);
950extern void check_window_system (struct frame *);
383e0970
J
951extern void frame_make_pointer_invisible (void);
952extern void frame_make_pointer_visible (void);
953extern Lisp_Object delete_frame (Lisp_Object, Lisp_Object);
efa4ce8b 954
ff11dfa1 955extern Lisp_Object Vframe_list;
efa4ce8b 956\f
650afd94
GM
957/* The currently selected frame. */
958
959extern Lisp_Object selected_frame;
960
961/* Value is a pointer to the selected frame. If the selected frame
b975254e 962 isn't live, abort. */
650afd94
GM
963
964#define SELECTED_FRAME() \
965 ((FRAMEP (selected_frame) \
966 && FRAME_LIVE_P (XFRAME (selected_frame))) \
967 ? XFRAME (selected_frame) \
1088b922 968 : (emacs_abort (), (struct frame *) 0))
3b83d631
GM
969
970\f
971/***********************************************************************
972 Display-related Macros
973 ***********************************************************************/
974
d3378f02 975/* Canonical y-unit on frame F.
b45afe99
KS
976 This value currently equals the line height of the frame (which is
977 the height of the default font of F). */
978
979#define FRAME_LINE_HEIGHT(F) ((F)->line_height)
3b83d631 980
d3378f02 981/* Canonical x-unit on frame F.
0fc63cc4 982 This value currently equals the average width of the default font of F. */
3b83d631 983
b45afe99 984#define FRAME_COLUMN_WIDTH(F) ((F)->column_width)
3b83d631 985
3b83d631 986/* Pixel width of areas used to display truncation marks, continuation
5cb26370 987 marks, overlay arrows. This is 0 for terminal frames. */
3b83d631
GM
988
989#ifdef HAVE_WINDOW_SYSTEM
aa5b8e15 990
b45afe99
KS
991/* Total width of fringes reserved for drawing truncation bitmaps,
992 continuation bitmaps and alike. The width is in canonical char
993 units of the frame. This must currently be the case because window
994 sizes aren't pixel values. If it weren't the case, we wouldn't be
995 able to split windows horizontally nicely. */
996
997#define FRAME_FRINGE_COLS(F) ((F)->fringe_cols)
998
999/* Pixel-width of the left and right fringe. */
1000
1001#define FRAME_LEFT_FRINGE_WIDTH(F) ((F)->left_fringe_width)
1002#define FRAME_RIGHT_FRINGE_WIDTH(F) ((F)->right_fringe_width)
1003
1004/* Total width of fringes in pixels. */
1005
1006#define FRAME_TOTAL_FRINGE_WIDTH(F) \
1007 (FRAME_LEFT_FRINGE_WIDTH (F) + FRAME_RIGHT_FRINGE_WIDTH (F))
1008
1009
1010/* Pixel-width of internal border lines */
1011
1012#define FRAME_INTERNAL_BORDER_WIDTH(F) ((F)->internal_border_width)
177c0ea7 1013
aa5b8e15
GM
1014#else /* not HAVE_WINDOW_SYSTEM */
1015
986f10ad 1016#define FRAME_FRINGE_COLS(F) 0
b45afe99 1017#define FRAME_TOTAL_FRINGE_WIDTH(F) 0
986f10ad 1018#define FRAME_LEFT_FRINGE_WIDTH(F) 0
8432bb78 1019#define FRAME_RIGHT_FRINGE_WIDTH(F) 0
b45afe99 1020#define FRAME_INTERNAL_BORDER_WIDTH(F) 0
aa5b8e15
GM
1021
1022#endif /* not HAVE_WINDOW_SYSTEM */
177c0ea7 1023
3b83d631
GM
1024
1025
1026\f
1027/***********************************************************************
1028 Conversion between canonical units and pixels
1029 ***********************************************************************/
1030
b45afe99
KS
1031/* Canonical x-values are fractions of FRAME_COLUMN_WIDTH, canonical
1032 y-unit are fractions of FRAME_LINE_HEIGHT of a frame. Both are
1033 represented as Lisp numbers, i.e. integers or floats. */
3b83d631
GM
1034
1035/* Convert canonical value X to pixels. F is the frame whose
1036 canonical char width is to be used. X must be a Lisp integer or
1037 float. Value is a C integer. */
177c0ea7 1038
b45afe99 1039#define FRAME_PIXEL_X_FROM_CANON_X(F, X) \
021f2e1a
AS
1040 (INTEGERP (X) \
1041 ? XINT (X) * FRAME_COLUMN_WIDTH (F) \
1042 : (int) (XFLOAT_DATA (X) * FRAME_COLUMN_WIDTH (F)))
177c0ea7 1043
3b83d631
GM
1044/* Convert canonical value Y to pixels. F is the frame whose
1045 canonical character height is to be used. X must be a Lisp integer
1046 or float. Value is a C integer. */
177c0ea7 1047
b45afe99 1048#define FRAME_PIXEL_Y_FROM_CANON_Y(F, Y) \
021f2e1a
AS
1049 (INTEGERP (Y) \
1050 ? XINT (Y) * FRAME_LINE_HEIGHT (F) \
1051 : (int) (XFLOAT_DATA (Y) * FRAME_LINE_HEIGHT (F)))
3b83d631
GM
1052
1053/* Convert pixel-value X to canonical units. F is the frame whose
1054 canonical character width is to be used. X is a C integer. Result
1055 is a Lisp float if X is not a multiple of the canon width,
1056 otherwise it's a Lisp integer. */
1057
b45afe99 1058#define FRAME_CANON_X_FROM_PIXEL_X(F, X) \
021f2e1a
AS
1059 ((X) % FRAME_COLUMN_WIDTH (F) != 0 \
1060 ? make_float ((double) (X) / FRAME_COLUMN_WIDTH (F)) \
1061 : make_number ((X) / FRAME_COLUMN_WIDTH (F)))
3b83d631
GM
1062
1063/* Convert pixel-value Y to canonical units. F is the frame whose
1064 canonical character height is to be used. Y is a C integer.
1065 Result is a Lisp float if Y is not a multiple of the canon width,
1066 otherwise it's a Lisp integer. */
1067
b45afe99 1068#define FRAME_CANON_Y_FROM_PIXEL_Y(F, Y) \
021f2e1a
AS
1069 ((Y) % FRAME_LINE_HEIGHT (F) \
1070 ? make_float ((double) (Y) / FRAME_LINE_HEIGHT (F)) \
1071 : make_number ((Y) / FRAME_LINE_HEIGHT (F)))
b45afe99
KS
1072
1073
1074\f
1075/* Manipulating pixel sizes and character sizes.
1076 Knowledge of which factors affect the overall size of the window should
1077 be hidden in these macros, if that's possible.
1078
1079 Return the upper/left pixel position of the character cell on frame F
1080 at ROW/COL. */
1081
1082#define FRAME_LINE_TO_PIXEL_Y(f, row) \
16009a0e 1083 (((row) < FRAME_TOP_MARGIN (f) ? 0 : FRAME_INTERNAL_BORDER_WIDTH (f)) \
b45afe99
KS
1084 + (row) * FRAME_LINE_HEIGHT (f))
1085
1086#define FRAME_COL_TO_PIXEL_X(f, col) \
1087 (FRAME_INTERNAL_BORDER_WIDTH (f) \
1088 + (col) * FRAME_COLUMN_WIDTH (f))
1089
1090/* Return the pixel width/height of frame F if it has
1091 COLS columns/LINES rows. */
1092
1093#define FRAME_TEXT_COLS_TO_PIXEL_WIDTH(f, cols) \
1094 (FRAME_COL_TO_PIXEL_X (f, cols) \
1095 + (f)->scroll_bar_actual_width \
1096 + FRAME_TOTAL_FRINGE_WIDTH (f) \
1097 + FRAME_INTERNAL_BORDER_WIDTH (f))
1098
1099#define FRAME_TEXT_LINES_TO_PIXEL_HEIGHT(f, lines) \
f016f225
JD
1100 ((lines) * FRAME_LINE_HEIGHT (f) \
1101 + 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
b45afe99
KS
1102
1103
1104/* Return the row/column (zero-based) of the character cell containing
1105 the pixel on FRAME at Y/X. */
1106
1107#define FRAME_PIXEL_Y_TO_LINE(f, y) \
4b00d3b1
YM
1108 (((y) < FRAME_TOP_MARGIN_HEIGHT (f) \
1109 ? (y) \
1110 : ((y) < FRAME_TOP_MARGIN_HEIGHT (f) + FRAME_INTERNAL_BORDER_WIDTH (f) \
1111 ? (y) - (FRAME_TOP_MARGIN_HEIGHT (f) + FRAME_INTERNAL_BORDER_WIDTH (f) \
1112 /* Arrange for the division to round down. */ \
1113 + FRAME_LINE_HEIGHT (f) - 1) \
1114 : (y) - FRAME_INTERNAL_BORDER_WIDTH (f))) \
b45afe99
KS
1115 / FRAME_LINE_HEIGHT (f))
1116
1117#define FRAME_PIXEL_X_TO_COL(f, x) \
1118 (((x) - FRAME_INTERNAL_BORDER_WIDTH (f)) \
1119 / FRAME_COLUMN_WIDTH (f))
1120
1121/* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
1122 frame F? */
1123
1124#define FRAME_PIXEL_WIDTH_TO_TEXT_COLS(f, width) \
1125 (FRAME_PIXEL_X_TO_COL (f, ((width) \
1126 - FRAME_INTERNAL_BORDER_WIDTH (f) \
1127 - FRAME_TOTAL_FRINGE_WIDTH (f) \
1128 - (f)->scroll_bar_actual_width)))
1129
1130#define FRAME_PIXEL_HEIGHT_TO_TEXT_LINES(f, height) \
1131 (FRAME_PIXEL_Y_TO_LINE (f, ((height) \
1132 - FRAME_INTERNAL_BORDER_WIDTH (f))))
177c0ea7 1133
c7cc32f7
DA
1134/* Value is the smallest width of any character in any font on frame F. */
1135
1136#define FRAME_SMALLEST_CHAR_WIDTH(f) \
1137 FRAME_DISPLAY_INFO (f)->smallest_char_width
1138
1139/* Value is the smallest height of any font on frame F. */
1140
1141#define FRAME_SMALLEST_FONT_HEIGHT(f) \
1142 FRAME_DISPLAY_INFO (f)->smallest_font_height
5e02ce11
KS
1143
1144/***********************************************************************
1145 Frame Parameters
1146 ***********************************************************************/
1147
1148extern Lisp_Object Qauto_raise, Qauto_lower;
1149extern Lisp_Object Qborder_color, Qborder_width;
955cbe7b 1150extern Lisp_Object Qbuffer_predicate;
5e02ce11
KS
1151extern Lisp_Object Qcursor_color, Qcursor_type;
1152extern Lisp_Object Qfont;
1153extern Lisp_Object Qbackground_color, Qforeground_color;
1154extern Lisp_Object Qicon, Qicon_name, Qicon_type, Qicon_left, Qicon_top;
1155extern Lisp_Object Qinternal_border_width;
99f3388e 1156extern Lisp_Object Qtooltip;
2b4e6277 1157extern Lisp_Object Qmenu_bar_lines, Qtool_bar_lines, Qtool_bar_position;
5e02ce11
KS
1158extern Lisp_Object Qmouse_color;
1159extern Lisp_Object Qname, Qtitle;
1160extern Lisp_Object Qparent_id;
1161extern Lisp_Object Qunsplittable, Qvisibility;
1162extern Lisp_Object Qscroll_bar_width, Qvertical_scroll_bars;
1163extern Lisp_Object Qscroll_bar_foreground, Qscroll_bar_background;
1164extern Lisp_Object Qscreen_gamma;
1165extern Lisp_Object Qline_spacing;
1166extern Lisp_Object Qwait_for_wm;
1167extern Lisp_Object Qfullscreen;
3f1c6666 1168extern Lisp_Object Qfullwidth, Qfullheight, Qfullboth, Qmaximized;
acd51077 1169extern Lisp_Object Qsticky;
1a8a83b2 1170extern Lisp_Object Qfont_backend;
50a73869 1171extern Lisp_Object Qalpha;
5e02ce11
KS
1172
1173extern Lisp_Object Qleft_fringe, Qright_fringe;
1174extern Lisp_Object Qheight, Qwidth;
1175extern Lisp_Object Qminibuffer, Qmodeline;
4b298d5a 1176extern Lisp_Object Qx, Qw32, Qpc, Qns;
5e02ce11
KS
1177extern Lisp_Object Qvisible;
1178extern Lisp_Object Qdisplay_type;
5e02ce11
KS
1179
1180extern Lisp_Object Qx_resource_name;
1181
bfeabdc3 1182extern Lisp_Object Qleft, Qright, Qtop, Qbox, Qbottom;
5e02ce11
KS
1183extern Lisp_Object Qdisplay;
1184
99f3388e
DN
1185extern Lisp_Object Qrun_hook_with_args;
1186
5e02ce11
KS
1187#ifdef HAVE_WINDOW_SYSTEM
1188
1189/* The class of this X application. */
1190#define EMACS_CLASS "Emacs"
1191
5e02ce11
KS
1192/* These are in xterm.c, w32term.c, etc. */
1193
383e0970
J
1194extern void x_set_scroll_bar_default_width (struct frame *);
1195extern void x_set_offset (struct frame *, int, int, int);
a10c8269 1196extern void x_wm_set_size_hint (struct frame *f, long flags, bool user_position);
5e02ce11 1197
383e0970 1198extern Lisp_Object x_new_font (struct frame *, Lisp_Object, int);
5e02ce11 1199
5e02ce11
KS
1200
1201extern Lisp_Object Qface_set_after_frame_default;
1202
0fda9b75 1203#ifdef HAVE_NTGUI
383e0970
J
1204extern void x_fullscreen_adjust (struct frame *f, int *, int *,
1205 int *, int *);
81626931 1206#endif
383e0970
J
1207
1208extern void x_set_frame_parameters (struct frame *, Lisp_Object);
383e0970
J
1209
1210extern void x_set_fullscreen (struct frame *, Lisp_Object, Lisp_Object);
1211extern void x_set_line_spacing (struct frame *, Lisp_Object, Lisp_Object);
1212extern void x_set_screen_gamma (struct frame *, Lisp_Object, Lisp_Object);
1213extern void x_set_font (struct frame *, Lisp_Object, Lisp_Object);
1214extern void x_set_font_backend (struct frame *, Lisp_Object, Lisp_Object);
1215extern void x_set_fringe_width (struct frame *, Lisp_Object, Lisp_Object);
1216extern void x_set_border_width (struct frame *, Lisp_Object, Lisp_Object);
1217extern void x_set_internal_border_width (struct frame *, Lisp_Object,
1218 Lisp_Object);
1219extern void x_set_visibility (struct frame *, Lisp_Object, Lisp_Object);
1220extern void x_set_autoraise (struct frame *, Lisp_Object, Lisp_Object);
1221extern void x_set_autolower (struct frame *, Lisp_Object, Lisp_Object);
1222extern void x_set_unsplittable (struct frame *, Lisp_Object, Lisp_Object);
1223extern void x_set_vertical_scroll_bars (struct frame *, Lisp_Object,
1224 Lisp_Object);
1225extern void x_set_scroll_bar_width (struct frame *, Lisp_Object,
1226 Lisp_Object);
1227
1228extern Lisp_Object x_icon_type (struct frame *);
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 *);
1258extern int x_bitmap_icon (struct frame *, Lisp_Object);
1259extern void x_set_menu_bar_lines (struct frame *,
1260 Lisp_Object,
1261 Lisp_Object);
1262extern void free_frame_menubar (struct frame *);
1263extern void x_free_frame_resources (struct frame *);
1264
52b8a085
DA
1265#if defined HAVE_X_WINDOWS
1266extern void x_wm_set_icon_position (struct frame *, int, int);
1267#if !defined USE_X_TOOLKIT
018c5e19
PE
1268extern char *x_get_resource_string (const char *, const char *);
1269#endif
83fc0554
DA
1270extern void x_sync (struct frame *);
1271#endif /* HAVE_X_WINDOWS */
018c5e19 1272
17a2cbbd 1273extern void x_query_colors (struct frame *f, XColor *, int);
0fda9b75 1274extern void x_query_color (struct frame *f, XColor *);
fcd42c11 1275extern void x_focus_frame (struct frame *);
17a2cbbd 1276
5e02ce11 1277#endif /* HAVE_WINDOW_SYSTEM */
6799bb26 1278\f
fd462129
DA
1279
1280FRAME_INLINE void
1281flush_frame (struct frame *f)
1282{
1283 struct redisplay_interface *rif = FRAME_RIF (f);
1284
1285 if (rif && rif->flush_display)
1286 rif->flush_display (f);
1287}
1288
6799bb26
JD
1289/***********************************************************************
1290 Multimonitor data
1291 ***********************************************************************/
1292
1293#ifdef HAVE_WINDOW_SYSTEM
1294
1295struct MonitorInfo {
1296 XRectangle geom, work;
1297 int mm_width, mm_height;
1298 char *name;
1299};
1300
1301extern void free_monitors (struct MonitorInfo *monitors, int n_monitors);
1302extern Lisp_Object make_monitor_attribute_list (struct MonitorInfo *monitors,
1303 int n_monitors,
1304 int primary_monitor,
1305 Lisp_Object monitor_frames,
1306 const char *source);
1307
1308#endif /* HAVE_WINDOW_SYSTEM */
1309
5e02ce11 1310
f00af5b1
PE
1311INLINE_HEADER_END
1312
84e01749 1313#endif /* not EMACS_FRAME_H */