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