Use functions and constants to manipulate Lisp_Save_Value objects.
[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
3b83d631
GM
173 /* A dummy window used to display menu bars under X when no X
174 toolkit support is available. */
e69b0960 175 Lisp_Object menu_bar_window;
3b83d631 176
9ea173e8 177 /* A window used to display the tool-bar of a frame. */
e69b0960 178 Lisp_Object tool_bar_window;
3b83d631 179
9ea173e8 180 /* Desired and current tool-bar items. */
e69b0960 181 Lisp_Object tool_bar_items;
3b83d631 182
bfeabdc3
JD
183 /* Where tool bar is, can be left, right, top or bottom. The native
184 tool bar only supports top. */
e69b0960 185 Lisp_Object tool_bar_position;
bfeabdc3 186
9ea173e8 187 /* Desired and current contents displayed in tool_bar_window. */
e69b0960
DA
188 Lisp_Object desired_tool_bar_string;
189 Lisp_Object current_tool_bar_string;
3b83d631 190
63bb3d8e 191 /* Beyond here, there should be no more Lisp_Object components. */
21015f9c 192
3b83d631
GM
193 /* Cache of realized faces. */
194 struct face_cache *face_cache;
21015f9c 195
a390930c 196 /* Number of elements in `menu_bar_vector' that have meaningful data. */
d230cb74 197 int menu_bar_items_used;
a390930c 198
3b83d631
GM
199 /* A buffer to hold the frame's name. We can't use the Lisp
200 string's pointer (`name', above) because it might get relocated. */
bd601e2a
KH
201 char *namebuf;
202
b09cca6a 203 /* Glyph pool and matrix. */
3b83d631
GM
204 struct glyph_pool *current_pool;
205 struct glyph_pool *desired_pool;
206 struct glyph_matrix *desired_matrix;
207 struct glyph_matrix *current_matrix;
208
209 /* 1 means that glyphs on this frame have been initialized so it can
210 be used for output. */
211 unsigned glyphs_initialized_p : 1;
21015f9c 212
e3d7bd83
DN
213 /* Set to non-zero in change_frame_size when size of frame changed
214 Clear the frame in clear_garbaged_frames if set. */
215 unsigned resized_p : 1;
216
217 /* Set to non-zero in when we want for force a flush_display in
218 update_frame, usually after resizing the frame. */
219 unsigned force_flush_display_p : 1;
220
221 /* Set to non-zero if the default face for the frame has been
222 realized. Reset to zero whenever the default face changes.
223 Used to see the difference between a font change and face change. */
224 unsigned default_face_done_p : 1;
225
226 /* Set to non-zero if this frame has already been hscrolled during
227 current redisplay. */
228 unsigned already_hscrolled_p : 1;
229
230 /* Set to non-zero when current redisplay has updated frame. */
231 unsigned updated_p : 1;
232
233 /* Set to non-zero to minimize tool-bar height even when
234 auto-resize-tool-bar is set to grow-only. */
235 unsigned minimize_tool_bar_window_p : 1;
236
9e2a2647 237#if defined (USE_GTK) || defined (HAVE_NS)
488dd4c4 238 /* Nonzero means using a tool bar that comes from the toolkit. */
be49ba74 239 unsigned external_tool_bar : 1;
488dd4c4
JD
240#endif
241
9ea173e8
GM
242 /* Margin at the top of the frame. Used to display the tool-bar. */
243 int tool_bar_lines;
3b83d631 244
045cff16 245 int n_tool_bar_rows;
e3303a23 246 int n_tool_bar_items;
177c0ea7 247
3b83d631
GM
248 /* A buffer for decode_mode_line. */
249 char *decode_mode_spec_buffer;
21015f9c
RS
250
251 /* See do_line_insertion_deletion_costs for info on these arrays. */
252 /* Cost of inserting 1 line on this frame */
253 int *insert_line_cost;
254 /* Cost of deleting 1 line on this frame */
255 int *delete_line_cost;
256 /* Cost of inserting n lines on this frame */
257 int *insert_n_lines_cost;
258 /* Cost of deleting n lines on this frame */
259 int *delete_n_lines_cost;
260
b45afe99
KS
261 /* Size of this frame, excluding fringes, scroll bars etc.,
262 in units of canonical characters. */
2f645268 263 int text_lines, text_cols;
b45afe99
KS
264
265 /* Total size of this frame (i.e. its native window), in units of
266 canonical characters. */
2f645268 267 int total_lines, total_cols;
b45afe99
KS
268
269 /* New text height and width for pending size change.
270 0 if no change pending. */
271 int new_text_lines, new_text_cols;
272
273 /* Pixel position of the frame window (x and y offsets in root window). */
274 int left_pos, top_pos;
275
276 /* Size of the frame window in pixels. */
277 int pixel_height, pixel_width;
278
279 /* These many pixels are the difference between the outer window (i.e. the
280 left and top of the window manager decoration) and FRAME_X_WINDOW. */
281 int x_pixels_diff, y_pixels_diff;
282
283 /* This is the gravity value for the specified window position. */
284 int win_gravity;
285
286 /* The geometry flags for this window. */
287 int size_hint_flags;
21015f9c 288
b45afe99
KS
289 /* Border width of the frame window as known by the (X) window system. */
290 int border_width;
291
292 /* Width of the internal border. This is a line of background color
293 just inside the window's border. When the frame is selected,
294 a highlighting is displayed inside the internal border. */
295 int internal_border_width;
296
297 /* Canonical X unit. Width of default font, in pixels. */
298 int column_width;
299
300 /* Canonical Y unit. Height of a line, in pixels. */
301 int line_height;
21015f9c 302
428a555e
KL
303 /* The output method says how the contents of this frame are
304 displayed. It could be using termcap, or using an X window.
6ed8eeff 305 This must be the same as the terminal->type. */
efa4ce8b
JB
306 enum output_method output_method;
307
6ed8eeff 308 /* The terminal device that this frame uses. If this is NULL, then
7e59217d 309 the frame has been deleted. */
6ed8eeff 310 struct terminal *terminal;
63bb3d8e 311
7e59217d 312 /* Device-dependent, frame-local auxiliary data used for displaying
428a555e
KL
313 the contents. When the frame is deleted, this data is deleted as
314 well. */
3b83d631
GM
315 union output_data
316 {
428a555e
KL
317 struct tty_output *tty; /* termchar.h */
318 struct x_output *x; /* xterm.h */
319 struct w32_output *w32; /* w32term.h */
edfda783 320 struct ns_output *ns; /* nsterm.h */
d311d28c 321 intptr_t nothing;
3b83d631
GM
322 }
323 output_data;
efa4ce8b 324
adf494ff
KH
325 /* List of font-drivers available on the frame. */
326 struct font_driver_list *font_driver_list;
6aae9c92
KH
327 /* List of data specific to font-driver and frame, but common to
328 faces. */
329 struct font_data_list *font_data_list;
adf494ff 330
b45afe99
KS
331 /* Total width of fringes reserved for drawing truncation bitmaps,
332 continuation bitmaps and alike. The width is in canonical char
333 units of the frame. This must currently be the case because window
334 sizes aren't pixel values. If it weren't the case, we wouldn't be
335 able to split windows horizontally nicely. */
336 int fringe_cols;
337
338 /* The extra width (in pixels) currently allotted for fringes. */
339 int left_fringe_width, right_fringe_width;
340
b45afe99 341 /* See FULLSCREEN_ enum below */
2806a183 342 enum fullscreen_type want_fullscreen;
b45afe99 343
6d05db81
RS
344 /* Number of lines of menu bar. */
345 int menu_bar_lines;
346
9e2a2647 347#if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
edfda783 348 || defined (HAVE_NS) || defined (USE_GTK)
9c95189b 349 /* Nonzero means using a menu bar that comes from the X toolkit. */
2806a183 350 unsigned int external_menu_bar : 1;
9c95189b
RS
351#endif
352
edfa7fa0
DA
353 /* Next two bitfields are mutually exclusive. They might both be
354 zero if the frame has been made invisible without an icon. */
355
356 /* Nonzero if the frame is currently displayed; we check
a4659527 357 it to see if we should bother updating the frame's contents.
efa4ce8b 358
20a6c8d7 359 Note that, since invisible frames aren't updated, whenever a
edfa7fa0 360 frame becomes visible again, it must be marked as garbaged.
20a6c8d7 361
6548cf00
KL
362 On ttys and on Windows NT/9X, to avoid wasting effort updating
363 visible frames that are actually completely obscured by other
364 windows on the display, we bend the meaning of visible slightly:
edfa7fa0 365 if equal to 2, then the frame is obscured - we still consider
6548cf00
KL
366 it to be "visible" as seen from lisp, but we don't bother
367 updating it. We must take care to garbage the frame when it
edfa7fa0 368 ceases to be obscured though. See SET_FRAME_VISIBLE below. */
4e0f6479 369 unsigned visible : 2;
a4659527 370
edfa7fa0
DA
371 /* Nonzero if the frame is currently iconified. Do not
372 set this directly, use SET_FRAME_ICONIFIED instead. */
373 unsigned iconified : 1;
efa4ce8b 374
ff11dfa1 375 /* Nonzero if this frame should be redrawn. */
edfa7fa0 376 unsigned garbaged : 1;
efa4ce8b 377
ff11dfa1
JB
378 /* True if frame actually has a minibuffer window on it.
379 0 if using a minibuffer window that isn't on this frame. */
4e0f6479 380 unsigned has_minibuffer : 1;
177c0ea7 381
ff11dfa1 382 /* 0 means, if this frame has just one window,
efa4ce8b 383 show no modeline for that window. */
4e0f6479 384 unsigned wants_modeline : 1;
efa4ce8b 385
ff11dfa1 386 /* Non-0 means raise this frame to the top of the heap when selected. */
4e0f6479 387 unsigned auto_raise : 1;
efa4ce8b 388
ff11dfa1 389 /* Non-0 means lower this frame to the bottom of the stack when left. */
4e0f6479 390 unsigned auto_lower : 1;
efa4ce8b 391
ff11dfa1 392 /* True if frame's root window can't be split. */
4e0f6479 393 unsigned no_split : 1;
efa4ce8b 394
fbfed6f0
JB
395 /* If this is set, then Emacs won't change the frame name to indicate
396 the current buffer, etcetera. If the user explicitly sets the frame
397 name, this gets set. If the user sets the name to Qnil, this is
398 cleared. */
4e0f6479 399 unsigned explicit_name : 1;
fbfed6f0 400
adc12f0f 401 /* Nonzero if size of some window on this frame has changed. */
4e0f6479 402 unsigned window_sizes_changed : 1;
adc12f0f 403
e3d7bd83
DN
404 /* Nonzero if the mouse has moved on this display device
405 since the last time we checked. */
4e0f6479 406 unsigned mouse_moved :1;
e3d7bd83 407
e044e4fc 408 /* Nonzero means that the pointer is invisible. */
4e0f6479 409 unsigned pointer_invisible :1;
e044e4fc 410
3737fee7 411 /* Nonzero if we should actually display the scroll bars on this frame. */
e3d7bd83
DN
412 enum vertical_scroll_bar_type vertical_scroll_bar_type;
413
414 /* What kind of text cursor should we draw in the future?
415 This should always be filled_box_cursor or bar_cursor. */
416 enum text_cursor_kinds desired_cursor;
417
418 /* Width of bar cursor (if we are using that). */
419 int cursor_width;
420
421 /* What kind of text cursor should we draw when the cursor blinks off?
422 This can be filled_box_cursor or bar_cursor or no_cursor. */
423 enum text_cursor_kinds blink_off_cursor;
424
425 /* Width of bar cursor (if we are using that) for blink-off state. */
426 int blink_off_cursor_width;
427
efa4ce8b
JB
428 /* Nonnegative if current redisplay should not do scroll computation
429 for lines beyond a certain vpos. This is the vpos. */
430 int scroll_bottom_vpos;
8d6de7ce 431
b45afe99
KS
432 /* Configured width of the scroll bar, in pixels and in characters.
433 config_scroll_bar_cols tracks config_scroll_bar_width if the
434 latter is positive; a zero value in config_scroll_bar_width means
435 to compute the actual width on the fly, using config_scroll_bar_cols
436 and the current font width. */
437 int config_scroll_bar_width;
438 int config_scroll_bar_cols;
439
440 /* The size of the extra width currently allotted for vertical
441 scroll bars in this frame, in pixels. */
442 int scroll_bar_actual_width;
95b999aa
RS
443
444 /* The baud rate that was used to calculate costs for this frame. */
445 int cost_calculation_baud_rate;
6462918c 446
91a47a68
DN
447 /* frame opacity
448 alpha[0]: alpha transparency of the active frame
f2d5c00f
CY
449 alpha[1]: alpha transparency of inactive frames
450 Negative values mean not to change alpha. */
91a47a68
DN
451 double alpha[2];
452
b61cbba3
GM
453 /* Exponent for gamma correction of colors. 1/(VIEWING_GAMMA *
454 SCREEN_GAMMA) where viewing_gamma is 0.4545 and SCREEN_GAMMA is a
455 frame parameter. 0 means don't do gamma correction. */
456 double gamma;
d1738c45
GM
457
458 /* Additional space to put between text lines on this frame. */
459 int extra_line_spacing;
f1c69c61 460
28d7d09f
KL
461 /* All display backends seem to need these two pixel values. */
462 unsigned long background_pixel;
463 unsigned long foreground_pixel;
efa4ce8b
JB
464};
465
f00af5b1
PE
466/* Most code should use these functions to set Lisp fields in struct frame. */
467
468FRAME_INLINE void
469fset_buffer_list (struct frame *f, Lisp_Object val)
470{
471 f->buffer_list = val;
472}
473FRAME_INLINE void
474fset_buried_buffer_list (struct frame *f, Lisp_Object val)
475{
476 f->buried_buffer_list = val;
477}
478FRAME_INLINE void
479fset_condemned_scroll_bars (struct frame *f, Lisp_Object val)
480{
481 f->condemned_scroll_bars = val;
482}
483FRAME_INLINE void
484fset_current_tool_bar_string (struct frame *f, Lisp_Object val)
485{
486 f->current_tool_bar_string = val;
487}
488FRAME_INLINE void
489fset_desired_tool_bar_string (struct frame *f, Lisp_Object val)
490{
491 f->desired_tool_bar_string = val;
492}
493FRAME_INLINE void
494fset_face_alist (struct frame *f, Lisp_Object val)
495{
496 f->face_alist = val;
497}
498FRAME_INLINE void
499fset_focus_frame (struct frame *f, Lisp_Object val)
500{
501 f->focus_frame = val;
502}
503FRAME_INLINE void
504fset_icon_name (struct frame *f, Lisp_Object val)
505{
506 f->icon_name = val;
507}
508FRAME_INLINE void
509fset_menu_bar_items (struct frame *f, Lisp_Object val)
510{
511 f->menu_bar_items = val;
512}
513FRAME_INLINE void
514fset_menu_bar_vector (struct frame *f, Lisp_Object val)
515{
516 f->menu_bar_vector = val;
517}
518FRAME_INLINE void
519fset_menu_bar_window (struct frame *f, Lisp_Object val)
520{
521 f->menu_bar_window = val;
522}
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
ff11dfa1 784#define FRAME_SCROLL_BOTTOM_VPOS(f) (f)->scroll_bottom_vpos
e69b0960 785#define FRAME_FOCUS_FRAME(f) f->focus_frame
cea6021b 786
cea6021b
RS
787/* This frame slot says whether scroll bars are currently enabled for frame F,
788 and which side they are on. */
a3211441
RS
789#define FRAME_VERTICAL_SCROLL_BAR_TYPE(f) ((f)->vertical_scroll_bar_type)
790#define FRAME_HAS_VERTICAL_SCROLL_BARS(f) \
021f2e1a 791 ((f)->vertical_scroll_bar_type != vertical_scroll_bar_none)
a3211441 792#define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT(f) \
021f2e1a 793 ((f)->vertical_scroll_bar_type == vertical_scroll_bar_left)
a3211441 794#define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT(f) \
021f2e1a 795 ((f)->vertical_scroll_bar_type == vertical_scroll_bar_right)
cea6021b
RS
796
797/* Width that a scroll bar in frame F should have, if there is one.
798 Measured in pixels.
799 If scroll bars are turned off, this is still nonzero. */
b45afe99 800#define FRAME_CONFIG_SCROLL_BAR_WIDTH(f) ((f)->config_scroll_bar_width)
cea6021b
RS
801
802/* Width that a scroll bar in frame F should have, if there is one.
803 Measured in columns (characters).
804 If scroll bars are turned off, this is still nonzero. */
b45afe99 805#define FRAME_CONFIG_SCROLL_BAR_COLS(f) ((f)->config_scroll_bar_cols)
cea6021b
RS
806
807/* Width of a scroll bar in frame F, measured in columns (characters),
7d81cf83
GM
808 but only if scroll bars are on the left. If scroll bars are on
809 the right in this frame, or there are no scroll bars, value is 0. */
810
b45afe99 811#define FRAME_LEFT_SCROLL_BAR_COLS(f) \
021f2e1a
AS
812 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \
813 ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
814 : 0)
7d81cf83 815
b45afe99
KS
816/* Width of a left scroll bar in frame F, measured in pixels */
817
021f2e1a 818#define FRAME_LEFT_SCROLL_BAR_AREA_WIDTH(f) \
b45afe99
KS
819 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \
820 ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)) \
821 : 0)
822
7d81cf83
GM
823/* Width of a scroll bar in frame F, measured in columns (characters),
824 but only if scroll bars are on the right. If scroll bars are on
825 the left in this frame, or there are no scroll bars, value is 0. */
826
b45afe99 827#define FRAME_RIGHT_SCROLL_BAR_COLS(f) \
021f2e1a
AS
828 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f) \
829 ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
830 : 0)
cea6021b 831
b45afe99
KS
832/* Width of a right scroll bar area in frame F, measured in pixels */
833
021f2e1a 834#define FRAME_RIGHT_SCROLL_BAR_AREA_WIDTH(f) \
b45afe99
KS
835 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f) \
836 ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)) \
837 : 0)
838
839/* Actual width of a scroll bar in frame F, measured in columns. */
840
841#define FRAME_SCROLL_BAR_COLS(f) \
021f2e1a
AS
842 (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \
843 ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
844 : 0)
cea6021b 845
b45afe99
KS
846/* Actual width of a scroll bar area in frame F, measured in pixels. */
847
848#define FRAME_SCROLL_BAR_AREA_WIDTH(f) \
849 (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \
850 ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)) \
851 : 0)
852
cea6021b
RS
853/* Total width of frame F, in columns (characters),
854 including the width used by scroll bars if any. */
b45afe99
KS
855
856#define FRAME_TOTAL_COLS(f) ((f)->total_cols)
cea6021b
RS
857
858/* Set the width of frame F to VAL.
859 VAL is the width of a full-frame window,
b45afe99
KS
860 not including scroll bars and fringes. */
861
862#define SET_FRAME_COLS(f, val) \
021f2e1a
AS
863 (FRAME_COLS (f) = (val), \
864 (f)->total_cols = FRAME_TOTAL_COLS_ARG (f, FRAME_COLS (f)))
cea6021b
RS
865
866/* Given a value WIDTH for frame F's nominal width,
b45afe99
KS
867 return the value that FRAME_TOTAL_COLS should have. */
868
869#define FRAME_TOTAL_COLS_ARG(f, width) \
021f2e1a
AS
870 ((width) \
871 + FRAME_SCROLL_BAR_COLS (f) \
872 + FRAME_FRINGE_COLS (f))
cea6021b 873
4ff34795 874/* Maximum + 1 legitimate value for FRAME_CURSOR_X. */
b45afe99 875
4ff34795 876#define FRAME_CURSOR_X_LIMIT(f) \
021f2e1a 877 (FRAME_COLS (f) + FRAME_LEFT_SCROLL_BAR_COLS (f))
cea6021b
RS
878
879/* Nonzero if frame F has scroll bars. */
b45afe99 880
e69b0960 881#define FRAME_SCROLL_BARS(f) (f->scroll_bars)
cea6021b 882
e69b0960
DA
883#define FRAME_CONDEMNED_SCROLL_BARS(f) (f->condemned_scroll_bars)
884#define FRAME_MENU_BAR_ITEMS(f) (f->menu_bar_items)
95b999aa 885#define FRAME_COST_BAUD_RATE(f) ((f)->cost_calculation_baud_rate)
81d00831 886
4d418fcc
KS
887#define FRAME_DESIRED_CURSOR(f) ((f)->desired_cursor)
888#define FRAME_BLINK_OFF_CURSOR(f) ((f)->blink_off_cursor)
889#define FRAME_CURSOR_WIDTH(f) ((f)->cursor_width)
890#define FRAME_BLINK_OFF_CURSOR_WIDTH(f) ((f)->blink_off_cursor_width)
891
3b83d631
GM
892/* Return a pointer to the face cache of frame F. */
893
894#define FRAME_FACE_CACHE(F) (F)->face_cache
895
81d00831
KH
896/* Return the size of message_buf of the frame F. We multiply the
897 width of the frame by 4 because multi-byte form may require at most
898 4-byte for a character. */
177c0ea7 899
b45afe99 900#define FRAME_MESSAGE_BUF_SIZE(f) (((int) FRAME_COLS (f)) * 4)
ff11dfa1 901
915a3e00
KS
902#define CHECK_FRAME(x) \
903 CHECK_TYPE (FRAMEP (x), Qframep, x)
904
905#define CHECK_LIVE_FRAME(x) \
906 CHECK_TYPE (FRAMEP (x) && FRAME_LIVE_P (XFRAME (x)), Qframe_live_p, x)
265a9e55 907
ff11dfa1
JB
908/* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
909 `for' loop which iterates over the elements of Vframe_list. The
35f56f96 910 loop will set FRAME_VAR, a Lisp_Object, to each frame in
ff11dfa1 911 Vframe_list in succession and execute the statement. LIST_VAR
35f56f96 912 should be a Lisp_Object too; it is used to iterate through the
177c0ea7 913 Vframe_list.
e5d77022 914
e3678b64
KH
915 This macro is a holdover from a time when multiple frames weren't always
916 supported. An alternate definition of the macro would expand to
917 something which executes the statement once. */
3b83d631 918
e69b0960
DA
919#define FOR_EACH_FRAME(list_var, frame_var) \
920 for ((list_var) = Vframe_list; \
921 (CONSP (list_var) \
922 && (frame_var = XCAR (list_var), 1)); \
ee88f64d 923 list_var = XCDR (list_var))
e5d77022 924
5c747675
DA
925/* Reflect mouse movement when a complete frame update is performed. */
926
927#define FRAME_MOUSE_UPDATE(frame) \
928 do { \
929 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (frame); \
930 if (frame == hlinfo->mouse_face_mouse_frame) \
931 { \
932 block_input (); \
933 if (hlinfo->mouse_face_mouse_frame) \
934 note_mouse_highlight (hlinfo->mouse_face_mouse_frame, \
edfa7fa0
DA
935 hlinfo->mouse_face_mouse_x, \
936 hlinfo->mouse_face_mouse_y); \
5c747675
DA
937 unblock_input (); \
938 } \
939 } while (0)
e5d77022 940
edfa7fa0
DA
941/* Set visibility of frame F, marking F as garbaged if needed. */
942
943#define SET_FRAME_VISIBLE(f, v) \
944 (((f)->visible == 0 || ((f)->visible == 2)) \
945 && ((v) == 1) ? SET_FRAME_GARBAGED (f) : 0, \
946 (f)->visible = (eassert (0 <= (v) && (v) <= 2), (v)))
947
948/* Set iconify of frame F. */
949
950#define SET_FRAME_ICONIFIED(f, i) \
951 (f)->iconified = (eassert (0 <= (i) && (i) <= 1), (i))
952
5e02ce11 953extern Lisp_Object Qframep, Qframe_live_p;
2666355c 954extern Lisp_Object Qtty, Qtty_type;
8848b728 955extern Lisp_Object Qtty_color_mode;
6ed8eeff 956extern Lisp_Object Qterminal, Qterminal_live_p;
c53956fe 957extern Lisp_Object Qnoelisp;
efa4ce8b 958
ff11dfa1 959extern struct frame *last_nonminibuf_frame;
efa4ce8b 960
0ff162fc 961extern void set_menu_bar_lines (struct frame *, Lisp_Object, 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 */
383e0970
J
972extern void frame_make_pointer_invisible (void);
973extern void frame_make_pointer_visible (void);
974extern Lisp_Object delete_frame (Lisp_Object, Lisp_Object);
efa4ce8b 975
ff11dfa1 976extern Lisp_Object Vframe_list;
efa4ce8b 977\f
650afd94
GM
978/* The currently selected frame. */
979
980extern Lisp_Object selected_frame;
981
982/* Value is a pointer to the selected frame. If the selected frame
b975254e 983 isn't live, abort. */
650afd94
GM
984
985#define SELECTED_FRAME() \
986 ((FRAMEP (selected_frame) \
987 && FRAME_LIVE_P (XFRAME (selected_frame))) \
988 ? XFRAME (selected_frame) \
1088b922 989 : (emacs_abort (), (struct frame *) 0))
3b83d631
GM
990
991\f
992/***********************************************************************
993 Display-related Macros
994 ***********************************************************************/
995
d3378f02 996/* Canonical y-unit on frame F.
b45afe99
KS
997 This value currently equals the line height of the frame (which is
998 the height of the default font of F). */
999
1000#define FRAME_LINE_HEIGHT(F) ((F)->line_height)
3b83d631 1001
d3378f02 1002/* Canonical x-unit on frame F.
0fc63cc4 1003 This value currently equals the average width of the default font of F. */
3b83d631 1004
b45afe99 1005#define FRAME_COLUMN_WIDTH(F) ((F)->column_width)
3b83d631 1006
3b83d631 1007/* Pixel width of areas used to display truncation marks, continuation
5cb26370 1008 marks, overlay arrows. This is 0 for terminal frames. */
3b83d631
GM
1009
1010#ifdef HAVE_WINDOW_SYSTEM
aa5b8e15 1011
b45afe99
KS
1012/* Total width of fringes reserved for drawing truncation bitmaps,
1013 continuation bitmaps and alike. The width is in canonical char
1014 units of the frame. This must currently be the case because window
1015 sizes aren't pixel values. If it weren't the case, we wouldn't be
1016 able to split windows horizontally nicely. */
1017
1018#define FRAME_FRINGE_COLS(F) ((F)->fringe_cols)
1019
1020/* Pixel-width of the left and right fringe. */
1021
1022#define FRAME_LEFT_FRINGE_WIDTH(F) ((F)->left_fringe_width)
1023#define FRAME_RIGHT_FRINGE_WIDTH(F) ((F)->right_fringe_width)
1024
1025/* Total width of fringes in pixels. */
1026
1027#define FRAME_TOTAL_FRINGE_WIDTH(F) \
1028 (FRAME_LEFT_FRINGE_WIDTH (F) + FRAME_RIGHT_FRINGE_WIDTH (F))
1029
1030
1031/* Pixel-width of internal border lines */
1032
1033#define FRAME_INTERNAL_BORDER_WIDTH(F) ((F)->internal_border_width)
177c0ea7 1034
aa5b8e15
GM
1035#else /* not HAVE_WINDOW_SYSTEM */
1036
986f10ad 1037#define FRAME_FRINGE_COLS(F) 0
b45afe99 1038#define FRAME_TOTAL_FRINGE_WIDTH(F) 0
986f10ad 1039#define FRAME_LEFT_FRINGE_WIDTH(F) 0
8432bb78 1040#define FRAME_RIGHT_FRINGE_WIDTH(F) 0
b45afe99 1041#define FRAME_INTERNAL_BORDER_WIDTH(F) 0
aa5b8e15
GM
1042
1043#endif /* not HAVE_WINDOW_SYSTEM */
177c0ea7 1044
3b83d631
GM
1045
1046
1047\f
1048/***********************************************************************
1049 Conversion between canonical units and pixels
1050 ***********************************************************************/
1051
b45afe99
KS
1052/* Canonical x-values are fractions of FRAME_COLUMN_WIDTH, canonical
1053 y-unit are fractions of FRAME_LINE_HEIGHT of a frame. Both are
1054 represented as Lisp numbers, i.e. integers or floats. */
3b83d631
GM
1055
1056/* Convert canonical value X to pixels. F is the frame whose
1057 canonical char width is to be used. X must be a Lisp integer or
1058 float. Value is a C integer. */
177c0ea7 1059
b45afe99 1060#define FRAME_PIXEL_X_FROM_CANON_X(F, X) \
021f2e1a
AS
1061 (INTEGERP (X) \
1062 ? XINT (X) * FRAME_COLUMN_WIDTH (F) \
1063 : (int) (XFLOAT_DATA (X) * FRAME_COLUMN_WIDTH (F)))
177c0ea7 1064
3b83d631
GM
1065/* Convert canonical value Y to pixels. F is the frame whose
1066 canonical character height is to be used. X must be a Lisp integer
1067 or float. Value is a C integer. */
177c0ea7 1068
b45afe99 1069#define FRAME_PIXEL_Y_FROM_CANON_Y(F, Y) \
021f2e1a
AS
1070 (INTEGERP (Y) \
1071 ? XINT (Y) * FRAME_LINE_HEIGHT (F) \
1072 : (int) (XFLOAT_DATA (Y) * FRAME_LINE_HEIGHT (F)))
3b83d631
GM
1073
1074/* Convert pixel-value X to canonical units. F is the frame whose
1075 canonical character width is to be used. X is a C integer. Result
1076 is a Lisp float if X is not a multiple of the canon width,
1077 otherwise it's a Lisp integer. */
1078
b45afe99 1079#define FRAME_CANON_X_FROM_PIXEL_X(F, X) \
021f2e1a
AS
1080 ((X) % FRAME_COLUMN_WIDTH (F) != 0 \
1081 ? make_float ((double) (X) / FRAME_COLUMN_WIDTH (F)) \
1082 : make_number ((X) / FRAME_COLUMN_WIDTH (F)))
3b83d631
GM
1083
1084/* Convert pixel-value Y to canonical units. F is the frame whose
1085 canonical character height is to be used. Y is a C integer.
1086 Result is a Lisp float if Y is not a multiple of the canon width,
1087 otherwise it's a Lisp integer. */
1088
b45afe99 1089#define FRAME_CANON_Y_FROM_PIXEL_Y(F, Y) \
021f2e1a
AS
1090 ((Y) % FRAME_LINE_HEIGHT (F) \
1091 ? make_float ((double) (Y) / FRAME_LINE_HEIGHT (F)) \
1092 : make_number ((Y) / FRAME_LINE_HEIGHT (F)))
b45afe99
KS
1093
1094
1095\f
1096/* Manipulating pixel sizes and character sizes.
1097 Knowledge of which factors affect the overall size of the window should
1098 be hidden in these macros, if that's possible.
1099
1100 Return the upper/left pixel position of the character cell on frame F
1101 at ROW/COL. */
1102
1103#define FRAME_LINE_TO_PIXEL_Y(f, row) \
16009a0e 1104 (((row) < FRAME_TOP_MARGIN (f) ? 0 : FRAME_INTERNAL_BORDER_WIDTH (f)) \
b45afe99
KS
1105 + (row) * FRAME_LINE_HEIGHT (f))
1106
1107#define FRAME_COL_TO_PIXEL_X(f, col) \
1108 (FRAME_INTERNAL_BORDER_WIDTH (f) \
1109 + (col) * FRAME_COLUMN_WIDTH (f))
1110
1111/* Return the pixel width/height of frame F if it has
1112 COLS columns/LINES rows. */
1113
1114#define FRAME_TEXT_COLS_TO_PIXEL_WIDTH(f, cols) \
1115 (FRAME_COL_TO_PIXEL_X (f, cols) \
1116 + (f)->scroll_bar_actual_width \
1117 + FRAME_TOTAL_FRINGE_WIDTH (f) \
1118 + FRAME_INTERNAL_BORDER_WIDTH (f))
1119
1120#define FRAME_TEXT_LINES_TO_PIXEL_HEIGHT(f, lines) \
f016f225
JD
1121 ((lines) * FRAME_LINE_HEIGHT (f) \
1122 + 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
b45afe99
KS
1123
1124
1125/* Return the row/column (zero-based) of the character cell containing
1126 the pixel on FRAME at Y/X. */
1127
1128#define FRAME_PIXEL_Y_TO_LINE(f, y) \
4b00d3b1
YM
1129 (((y) < FRAME_TOP_MARGIN_HEIGHT (f) \
1130 ? (y) \
1131 : ((y) < FRAME_TOP_MARGIN_HEIGHT (f) + FRAME_INTERNAL_BORDER_WIDTH (f) \
1132 ? (y) - (FRAME_TOP_MARGIN_HEIGHT (f) + FRAME_INTERNAL_BORDER_WIDTH (f) \
1133 /* Arrange for the division to round down. */ \
1134 + FRAME_LINE_HEIGHT (f) - 1) \
1135 : (y) - FRAME_INTERNAL_BORDER_WIDTH (f))) \
b45afe99
KS
1136 / FRAME_LINE_HEIGHT (f))
1137
1138#define FRAME_PIXEL_X_TO_COL(f, x) \
1139 (((x) - FRAME_INTERNAL_BORDER_WIDTH (f)) \
1140 / FRAME_COLUMN_WIDTH (f))
1141
1142/* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
1143 frame F? */
1144
1145#define FRAME_PIXEL_WIDTH_TO_TEXT_COLS(f, width) \
1146 (FRAME_PIXEL_X_TO_COL (f, ((width) \
1147 - FRAME_INTERNAL_BORDER_WIDTH (f) \
1148 - FRAME_TOTAL_FRINGE_WIDTH (f) \
1149 - (f)->scroll_bar_actual_width)))
1150
1151#define FRAME_PIXEL_HEIGHT_TO_TEXT_LINES(f, height) \
1152 (FRAME_PIXEL_Y_TO_LINE (f, ((height) \
1153 - FRAME_INTERNAL_BORDER_WIDTH (f))))
177c0ea7 1154
5e02ce11
KS
1155
1156/***********************************************************************
1157 Frame Parameters
1158 ***********************************************************************/
1159
1160extern Lisp_Object Qauto_raise, Qauto_lower;
1161extern Lisp_Object Qborder_color, Qborder_width;
955cbe7b 1162extern Lisp_Object Qbuffer_predicate;
5e02ce11
KS
1163extern Lisp_Object Qcursor_color, Qcursor_type;
1164extern Lisp_Object Qfont;
1165extern Lisp_Object Qbackground_color, Qforeground_color;
1166extern Lisp_Object Qicon, Qicon_name, Qicon_type, Qicon_left, Qicon_top;
1167extern Lisp_Object Qinternal_border_width;
99f3388e 1168extern Lisp_Object Qtooltip;
2b4e6277 1169extern Lisp_Object Qmenu_bar_lines, Qtool_bar_lines, Qtool_bar_position;
5e02ce11
KS
1170extern Lisp_Object Qmouse_color;
1171extern Lisp_Object Qname, Qtitle;
1172extern Lisp_Object Qparent_id;
1173extern Lisp_Object Qunsplittable, Qvisibility;
1174extern Lisp_Object Qscroll_bar_width, Qvertical_scroll_bars;
1175extern Lisp_Object Qscroll_bar_foreground, Qscroll_bar_background;
1176extern Lisp_Object Qscreen_gamma;
1177extern Lisp_Object Qline_spacing;
1178extern Lisp_Object Qwait_for_wm;
1179extern Lisp_Object Qfullscreen;
3f1c6666 1180extern Lisp_Object Qfullwidth, Qfullheight, Qfullboth, Qmaximized;
acd51077 1181extern Lisp_Object Qsticky;
1a8a83b2 1182extern Lisp_Object Qfont_backend;
50a73869 1183extern Lisp_Object Qalpha;
5e02ce11
KS
1184
1185extern Lisp_Object Qleft_fringe, Qright_fringe;
1186extern Lisp_Object Qheight, Qwidth;
1187extern Lisp_Object Qminibuffer, Qmodeline;
4b298d5a 1188extern Lisp_Object Qx, Qw32, Qpc, Qns;
5e02ce11
KS
1189extern Lisp_Object Qvisible;
1190extern Lisp_Object Qdisplay_type;
5e02ce11
KS
1191
1192extern Lisp_Object Qx_resource_name;
1193
bfeabdc3 1194extern Lisp_Object Qleft, Qright, Qtop, Qbox, Qbottom;
5e02ce11
KS
1195extern Lisp_Object Qdisplay;
1196
99f3388e
DN
1197extern Lisp_Object Qrun_hook_with_args;
1198
5e02ce11
KS
1199#ifdef HAVE_WINDOW_SYSTEM
1200
1201/* The class of this X application. */
1202#define EMACS_CLASS "Emacs"
1203
5e02ce11
KS
1204/* These are in xterm.c, w32term.c, etc. */
1205
383e0970
J
1206extern void x_set_scroll_bar_default_width (struct frame *);
1207extern void x_set_offset (struct frame *, int, int, int);
1208extern void x_wm_set_icon_position (struct frame *, int, int);
18e27ea8 1209extern void x_wm_set_size_hint (FRAME_PTR f, long flags, bool user_position);
5e02ce11 1210
383e0970 1211extern Lisp_Object x_new_font (struct frame *, Lisp_Object, int);
5e02ce11 1212
5e02ce11
KS
1213
1214extern Lisp_Object Qface_set_after_frame_default;
1215
0fda9b75 1216#ifdef HAVE_NTGUI
383e0970
J
1217extern void x_fullscreen_adjust (struct frame *f, int *, int *,
1218 int *, int *);
81626931 1219#endif
383e0970
J
1220
1221extern void x_set_frame_parameters (struct frame *, Lisp_Object);
383e0970
J
1222
1223extern void x_set_fullscreen (struct frame *, Lisp_Object, Lisp_Object);
1224extern void x_set_line_spacing (struct frame *, Lisp_Object, Lisp_Object);
1225extern void x_set_screen_gamma (struct frame *, Lisp_Object, Lisp_Object);
1226extern void x_set_font (struct frame *, Lisp_Object, Lisp_Object);
1227extern void x_set_font_backend (struct frame *, Lisp_Object, Lisp_Object);
1228extern void x_set_fringe_width (struct frame *, Lisp_Object, Lisp_Object);
1229extern void x_set_border_width (struct frame *, Lisp_Object, Lisp_Object);
1230extern void x_set_internal_border_width (struct frame *, Lisp_Object,
1231 Lisp_Object);
1232extern void x_set_visibility (struct frame *, Lisp_Object, Lisp_Object);
1233extern void x_set_autoraise (struct frame *, Lisp_Object, Lisp_Object);
1234extern void x_set_autolower (struct frame *, Lisp_Object, Lisp_Object);
1235extern void x_set_unsplittable (struct frame *, Lisp_Object, Lisp_Object);
1236extern void x_set_vertical_scroll_bars (struct frame *, Lisp_Object,
1237 Lisp_Object);
1238extern void x_set_scroll_bar_width (struct frame *, Lisp_Object,
1239 Lisp_Object);
1240
1241extern Lisp_Object x_icon_type (struct frame *);
1242
1243extern int x_figure_window_size (struct frame *, Lisp_Object, int);
5e02ce11 1244
383e0970 1245extern void x_set_alpha (struct frame *, Lisp_Object, Lisp_Object);
5e02ce11 1246
383e0970 1247extern void validate_x_resource_name (void);
0ff162fc 1248
facfbbbd
SM
1249extern Lisp_Object display_x_get_resource (Display_Info *,
1250 Lisp_Object attribute,
1251 Lisp_Object class,
1252 Lisp_Object component,
1253 Lisp_Object subclass);
1254
18e27ea8 1255extern void set_frame_menubar (struct frame *f, bool first_time, bool deep_p);
17a2cbbd
DC
1256extern void x_set_window_size (struct frame *f, int change_grav,
1257 int cols, int rows);
1258extern void x_sync (struct frame *);
1259extern Lisp_Object x_get_focus_frame (struct frame *);
1260extern void x_set_mouse_position (struct frame *f, int h, int v);
1261extern void x_set_mouse_pixel_position (struct frame *f, int pix_x, int pix_y);
1262extern void x_make_frame_visible (struct frame *f);
1263extern void x_make_frame_invisible (struct frame *f);
1264extern void x_iconify_frame (struct frame *f);
17a2cbbd
DC
1265extern int x_pixel_width (struct frame *f);
1266extern int x_pixel_height (struct frame *f);
1267extern void x_set_frame_alpha (struct frame *f);
1268extern void x_set_menu_bar_lines (struct frame *, Lisp_Object, Lisp_Object);
1269extern void x_set_tool_bar_lines (struct frame *f,
1270 Lisp_Object value,
1271 Lisp_Object oldval);
1272extern void x_activate_menubar (struct frame *);
1273extern void x_real_positions (struct frame *, int *, int *);
1274extern int x_bitmap_icon (struct frame *, Lisp_Object);
1275extern void x_set_menu_bar_lines (struct frame *,
1276 Lisp_Object,
1277 Lisp_Object);
1278extern void free_frame_menubar (struct frame *);
1279extern void x_free_frame_resources (struct frame *);
1280
018c5e19
PE
1281#if defined HAVE_X_WINDOWS && !defined USE_X_TOOLKIT
1282extern char *x_get_resource_string (const char *, const char *);
1283#endif
1284
17a2cbbd 1285extern void x_query_colors (struct frame *f, XColor *, int);
0fda9b75 1286extern void x_query_color (struct frame *f, XColor *);
17a2cbbd 1287
5e02ce11
KS
1288#endif /* HAVE_WINDOW_SYSTEM */
1289
f00af5b1
PE
1290INLINE_HEADER_END
1291
84e01749 1292#endif /* not EMACS_FRAME_H */