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