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