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