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