Merge from origin/emacs-24
[emacs.git] / src / frame.h
blob1aa88042ad3ecd12cc7b55b15391e0a13a32c570
1 /* Define frame-object for GNU Emacs.
2 Copyright (C) 1993-1994, 1999-2014 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
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. */
23 #ifndef EMACS_FRAME_H
24 #define EMACS_FRAME_H
26 #include "dispextern.h"
27 #include "termhooks.h"
28 #include "window.h"
30 INLINE_HEADER_BEGIN
32 enum vertical_scroll_bar_type
34 vertical_scroll_bar_none,
35 vertical_scroll_bar_left,
36 vertical_scroll_bar_right
39 #ifdef HAVE_WINDOW_SYSTEM
41 enum fullscreen_type
43 FULLSCREEN_NONE,
44 FULLSCREEN_WIDTH = 0x1,
45 FULLSCREEN_HEIGHT = 0x2,
46 FULLSCREEN_BOTH = 0x3, /* Not a typo but means "width and height". */
47 FULLSCREEN_MAXIMIZED = 0x4,
48 #ifdef HAVE_NTGUI
49 FULLSCREEN_WAIT = 0x8
50 #endif
53 #endif /* HAVE_WINDOW_SYSTEM */
55 /* The structure representing a frame. */
57 struct frame
59 struct vectorlike_header header;
61 /* All Lisp_Object components must come first.
62 That ensures they are all aligned normally. */
64 /* Name of this frame: a Lisp string. It is used for looking up resources,
65 as well as for the title in some cases. */
66 Lisp_Object name;
68 /* The name to use for the icon, the last time
69 it was refreshed. nil means not explicitly specified. */
70 Lisp_Object icon_name;
72 /* This is the frame title specified explicitly, if any.
73 Usually it is nil. */
74 Lisp_Object title;
76 /* The frame which should receive keystrokes that occur in this
77 frame, or nil if they should go to the frame itself. This is
78 usually nil, but if the frame is minibufferless, we can use this
79 to redirect keystrokes to a surrogate minibuffer frame when
80 needed.
82 Note that a value of nil is different than having the field point
83 to the frame itself. Whenever the Fselect_frame function is used
84 to shift from one frame to the other, any redirections to the
85 original frame are shifted to the newly selected frame; if
86 focus_frame is nil, Fselect_frame will leave it alone. */
87 Lisp_Object focus_frame;
89 /* This frame's root window. Every frame has one.
90 If the frame has only a minibuffer window, this is it.
91 Otherwise, if the frame has a minibuffer window, this is its sibling. */
92 Lisp_Object root_window;
94 /* This frame's selected window.
95 Each frame has its own window hierarchy
96 and one of the windows in it is selected within the frame.
97 The selected window of the selected frame is Emacs's selected window. */
98 Lisp_Object selected_window;
100 /* This frame's minibuffer window.
101 Most frames have their own minibuffer windows,
102 but only the selected frame's minibuffer window
103 can actually appear to exist. */
104 Lisp_Object minibuffer_window;
106 /* Parameter alist of this frame.
107 These are the parameters specified when creating the frame
108 or modified with modify-frame-parameters. */
109 Lisp_Object param_alist;
111 /* List of scroll bars on this frame.
112 Actually, we don't specify exactly what is stored here at all; the
113 scroll bar implementation code can use it to store anything it likes.
114 This field is marked by the garbage collector. It is here
115 instead of in the `device' structure so that the garbage
116 collector doesn't need to look inside the window-system-dependent
117 structure. */
118 Lisp_Object scroll_bars;
119 Lisp_Object condemned_scroll_bars;
121 /* Vector describing the items to display in the menu bar.
122 Each item has four elements in this vector.
123 They are KEY, STRING, SUBMAP, and HPOS.
124 (HPOS is not used in when the X toolkit is in use.)
125 There are four additional elements of nil at the end, to terminate. */
126 Lisp_Object menu_bar_items;
128 /* Alist of elements (FACE-NAME . FACE-VECTOR-DATA). */
129 Lisp_Object face_alist;
131 /* A vector that records the entire structure of this frame's menu bar.
132 For the format of the data, see extensive comments in xmenu.c.
133 Only the X toolkit version uses this. */
134 Lisp_Object menu_bar_vector;
136 /* Predicate for selecting buffers for other-buffer. */
137 Lisp_Object buffer_predicate;
139 /* List of buffers viewed in this frame, for other-buffer. */
140 Lisp_Object buffer_list;
142 /* List of buffers that were viewed, then buried in this frame. The
143 most recently buried buffer is first. For last-buffer. */
144 Lisp_Object buried_buffer_list;
146 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
147 /* A dummy window used to display menu bars under X when no X
148 toolkit support is available. */
149 Lisp_Object menu_bar_window;
150 #endif
152 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
153 /* A window used to display the tool-bar of a frame. */
154 Lisp_Object tool_bar_window;
156 /* Desired and current contents displayed in that window. */
157 Lisp_Object desired_tool_bar_string;
158 Lisp_Object current_tool_bar_string;
159 #endif
161 /* Desired and current tool-bar items. */
162 Lisp_Object tool_bar_items;
164 #ifdef USE_GTK
165 /* Where tool bar is, can be left, right, top or bottom.
166 Except with GTK, the only supported position is `top'. */
167 Lisp_Object tool_bar_position;
168 #endif
170 #if defined (HAVE_XFT) || defined (HAVE_FREETYPE)
171 /* List of data specific to font-driver and frame, but common to faces. */
172 Lisp_Object font_data;
173 #endif
175 /* Beyond here, there should be no more Lisp_Object components. */
177 /* Cache of realized faces. */
178 struct face_cache *face_cache;
180 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
181 /* Tool-bar item index of the item on which a mouse button was pressed. */
182 int last_tool_bar_item;
183 #endif
185 /* Number of elements in `menu_bar_vector' that have meaningful data. */
186 int menu_bar_items_used;
188 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
189 /* A buffer to hold the frame's name. Since this is used by the
190 window system toolkit, we can't use the Lisp string's pointer
191 (`name', above) because it might get relocated. */
192 char *namebuf;
193 #endif
195 #ifdef USE_X_TOOLKIT
196 /* Used to pass geometry parameters to toolkit functions. */
197 char *shell_position;
198 #endif
200 /* Glyph pool and matrix. */
201 struct glyph_pool *current_pool;
202 struct glyph_pool *desired_pool;
203 struct glyph_matrix *desired_matrix;
204 struct glyph_matrix *current_matrix;
206 /* Bitfield area begins here. Keep them together to avoid extra padding. */
208 /* True means that glyphs on this frame have been initialized so it can
209 be used for output. */
210 bool_bf glyphs_initialized_p : 1;
212 /* Set to true in change_frame_size when size of frame changed
213 Clear the frame in clear_garbaged_frames if set. */
214 bool_bf resized_p : 1;
216 /* Set to true if the default face for the frame has been
217 realized. Reset to zero whenever the default face changes.
218 Used to see the difference between a font change and face change. */
219 bool_bf default_face_done_p : 1;
221 /* Set to true if this frame has already been hscrolled during
222 current redisplay. */
223 bool_bf already_hscrolled_p : 1;
225 /* Set to true when current redisplay has updated frame. */
226 bool_bf updated_p : 1;
228 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
229 /* Set to true to minimize tool-bar height even when
230 auto-resize-tool-bar is set to grow-only. */
231 bool_bf minimize_tool_bar_window_p : 1;
232 #endif
234 #if defined (USE_GTK) || defined (HAVE_NS)
235 /* True means using a tool bar that comes from the toolkit. */
236 bool_bf external_tool_bar : 1;
237 #endif
239 /* True means that fonts have been loaded since the last glyph
240 matrix adjustments. */
241 bool_bf fonts_changed : 1;
243 /* True means that cursor type has been changed. */
244 bool_bf cursor_type_changed : 1;
246 /* True if it needs to be redisplayed. */
247 bool_bf redisplay : 1;
249 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
250 || defined (HAVE_NS) || defined (USE_GTK)
251 /* True means using a menu bar that comes from the X toolkit. */
252 bool_bf external_menu_bar : 1;
253 #endif
255 /* Next two bitfields are mutually exclusive. They might both be
256 zero if the frame has been made invisible without an icon. */
258 /* Nonzero if the frame is currently displayed; we check
259 it to see if we should bother updating the frame's contents.
261 On ttys and on Windows NT/9X, to avoid wasting effort updating
262 visible frames that are actually completely obscured by other
263 windows on the display, we bend the meaning of visible slightly:
264 if equal to 2, then the frame is obscured - we still consider
265 it to be "visible" as seen from lisp, but we don't bother
266 updating it. */
267 unsigned visible : 2;
269 /* True if the frame is currently iconified. Do not
270 set this directly, use SET_FRAME_ICONIFIED instead. */
271 bool_bf iconified : 1;
273 /* True if this frame should be fully redisplayed. Disables all
274 optimizations while rebuilding matrices and redrawing. */
275 bool_bf garbaged : 1;
277 /* False means, if this frame has just one window,
278 show no modeline for that window. */
279 bool_bf wants_modeline : 1;
281 /* True means raise this frame to the top of the heap when selected. */
282 bool_bf auto_raise : 1;
284 /* True means lower this frame to the bottom of the stack when left. */
285 bool_bf auto_lower : 1;
287 /* True if frame's root window can't be split. */
288 bool_bf no_split : 1;
290 /* If this is set, then Emacs won't change the frame name to indicate
291 the current buffer, etcetera. If the user explicitly sets the frame
292 name, this gets set. If the user sets the name to Qnil, this is
293 cleared. */
294 bool_bf explicit_name : 1;
296 /* True if size of some window on this frame has changed. */
297 bool_bf window_sizes_changed : 1;
299 /* True if the mouse has moved on this display device
300 since the last time we checked. */
301 bool_bf mouse_moved : 1;
303 /* True means that the pointer is invisible. */
304 bool_bf pointer_invisible : 1;
306 /* True means that all windows except mini-window and
307 selected window on this frame have frozen window starts. */
308 bool_bf frozen_window_starts : 1;
310 /* The output method says how the contents of this frame are
311 displayed. It could be using termcap, or using an X window.
312 This must be the same as the terminal->type. */
313 ENUM_BF (output_method) output_method : 3;
315 #ifdef HAVE_WINDOW_SYSTEM
316 /* See FULLSCREEN_ enum on top. */
317 ENUM_BF (fullscreen_type) want_fullscreen : 4;
319 /* If not vertical_scroll_bar_none, we should actually
320 display the scroll bars of this type on this frame. */
321 ENUM_BF (vertical_scroll_bar_type) vertical_scroll_bar_type : 2;
323 /* Nonzero if we should actually display horizontal scroll bars on this frame. */
324 bool_bf horizontal_scroll_bars : 1;
325 #endif /* HAVE_WINDOW_SYSTEM */
327 /* Whether new_height and new_width shall be interpreted
328 in pixels. */
329 bool_bf new_pixelwise : 1;
331 /* True means x_set_window_size requests can be processed for this
332 frame. */
333 bool_bf can_x_set_window_size : 1;
335 /* True means run_window_configuration_change_hook can be processed
336 for this frame. */
337 bool_bf can_run_window_configuration_change_hook : 1;
339 /* Bitfield area ends here. */
341 /* Number of lines (rounded up) of tool bar. REMOVE THIS */
342 int tool_bar_lines;
344 /* Height of frame internal tool bar in pixels. */
345 int tool_bar_height;
347 int n_tool_bar_rows;
348 int n_tool_bar_items;
350 /* A buffer for decode_mode_line. */
351 char *decode_mode_spec_buffer;
353 /* See do_line_insertion_deletion_costs for info on these arrays. */
354 /* Cost of inserting 1 line on this frame. */
355 int *insert_line_cost;
356 /* Cost of deleting 1 line on this frame. */
357 int *delete_line_cost;
358 /* Cost of inserting n lines on this frame. */
359 int *insert_n_lines_cost;
360 /* Cost of deleting n lines on this frame. */
361 int *delete_n_lines_cost;
363 /* Text width of this frame (excluding fringes, vertical scroll bar
364 and internal border widths) and text height (excluding menu bar,
365 tool bar, horizontal scroll bar and internal border widths) in
366 units of canonical characters. */
367 int text_cols, text_lines;
369 /* Total width of this frame (including fringes, vertical scroll bar
370 and internal border widths) and total height (including menu bar,
371 tool bar, horizontal scroll bar and internal border widths) in
372 units of canonical characters. */
373 int total_cols, total_lines;
375 /* Text width of this frame (excluding fringes, vertical scroll bar
376 and internal border widths) and text height (excluding menu bar,
377 tool bar, horizontal scroll bar and internal border widths) in
378 pixels. */
379 int text_width, text_height;
381 /* New text height and width for pending size change. 0 if no change
382 pending. These values represent pixels or canonical character units
383 according to the value of new_pixelwise and correlate to the the
384 text width/height of the frame. */
385 int new_width, new_height;
387 /* Pixel position of the frame window (x and y offsets in root window). */
388 int left_pos, top_pos;
390 /* Total width of this frame (including fringes, vertical scroll bar
391 and internal border widths) and total height (including menu bar,
392 tool bar, horizontal scroll bar and internal border widths) in
393 pixels. */
394 int pixel_width, pixel_height;
396 /* These many pixels are the difference between the outer window (i.e. the
397 left and top of the window manager decoration) and FRAME_X_WINDOW. */
398 int x_pixels_diff, y_pixels_diff;
400 /* This is the gravity value for the specified window position. */
401 int win_gravity;
403 /* The geometry flags for this window. */
404 int size_hint_flags;
406 /* Border width of the frame window as known by the (X) window system. */
407 int border_width;
409 /* Width of the internal border. This is a line of background color
410 just inside the window's border. When the frame is selected,
411 a highlighting is displayed inside the internal border. */
412 int internal_border_width;
414 /* Widths of dividers between this frame's windows in pixels. */
415 int right_divider_width, bottom_divider_width;
417 /* Widths of fringes in pixels. */
418 int left_fringe_width, right_fringe_width;
420 /* Total width of fringes reserved for drawing truncation bitmaps,
421 continuation bitmaps and alike - REMOVE THIS !!!!. */
422 int fringe_cols;
424 /* Number of lines of menu bar. */
425 int menu_bar_lines;
427 /* Pixel height of menubar. */
428 int menu_bar_height;
430 /* Canonical X unit. Width of default font, in pixels. */
431 int column_width;
433 /* Canonical Y unit. Height of a line, in pixels. */
434 int line_height;
436 /* The terminal device that this frame uses. If this is NULL, then
437 the frame has been deleted. */
438 struct terminal *terminal;
440 /* Device-dependent, frame-local auxiliary data used for displaying
441 the contents. When the frame is deleted, this data is deleted as
442 well. */
443 union output_data
445 struct tty_output *tty; /* From termchar.h. */
446 struct x_output *x; /* From xterm.h. */
447 struct w32_output *w32; /* From w32term.h. */
448 struct ns_output *ns; /* From nsterm.h. */
449 intptr_t nothing;
451 output_data;
453 /* List of font-drivers available on the frame. */
454 struct font_driver_list *font_driver_list;
456 #if defined (HAVE_X_WINDOWS)
457 /* Used by x_wait_for_event when watching for an X event on this frame. */
458 int wait_event_type;
459 #endif
461 /* What kind of text cursor should we draw in the future?
462 This should always be filled_box_cursor or bar_cursor. */
463 enum text_cursor_kinds desired_cursor;
465 /* Width of bar cursor (if we are using that). */
466 int cursor_width;
468 /* What kind of text cursor should we draw when the cursor blinks off?
469 This can be filled_box_cursor or bar_cursor or no_cursor. */
470 enum text_cursor_kinds blink_off_cursor;
472 /* Width of bar cursor (if we are using that) for blink-off state. */
473 int blink_off_cursor_width;
475 /* Configured width of the scroll bar, in pixels and in characters.
476 config_scroll_bar_cols tracks config_scroll_bar_width if the
477 latter is positive; a zero value in config_scroll_bar_width means
478 to compute the actual width on the fly, using config_scroll_bar_cols
479 and the current font width. */
480 int config_scroll_bar_width;
481 int config_scroll_bar_cols;
483 /* Configured height of the scroll bar, in pixels and in characters.
484 config_scroll_bar_lines tracks config_scroll_bar_height if the
485 latter is positive; a zero value in config_scroll_bar_height means
486 to compute the actual width on the fly, using
487 config_scroll_bar_lines and the current font width. */
488 int config_scroll_bar_height;
489 int config_scroll_bar_lines;
491 /* The baud rate that was used to calculate costs for this frame. */
492 int cost_calculation_baud_rate;
494 /* Frame opacity
495 alpha[0]: alpha transparency of the active frame
496 alpha[1]: alpha transparency of inactive frames
497 Negative values mean not to change alpha. */
498 double alpha[2];
500 /* Exponent for gamma correction of colors. 1/(VIEWING_GAMMA *
501 SCREEN_GAMMA) where viewing_gamma is 0.4545 and SCREEN_GAMMA is a
502 frame parameter. 0 means don't do gamma correction. */
503 double gamma;
505 /* Additional space to put between text lines on this frame. */
506 int extra_line_spacing;
508 /* All display backends seem to need these two pixel values. */
509 unsigned long background_pixel;
510 unsigned long foreground_pixel;
513 /* Most code should use these functions to set Lisp fields in struct frame. */
515 INLINE void
516 fset_buffer_list (struct frame *f, Lisp_Object val)
518 f->buffer_list = val;
520 INLINE void
521 fset_buried_buffer_list (struct frame *f, Lisp_Object val)
523 f->buried_buffer_list = val;
525 INLINE void
526 fset_condemned_scroll_bars (struct frame *f, Lisp_Object val)
528 f->condemned_scroll_bars = val;
530 INLINE void
531 fset_face_alist (struct frame *f, Lisp_Object val)
533 f->face_alist = val;
535 INLINE void
536 fset_focus_frame (struct frame *f, Lisp_Object val)
538 f->focus_frame = val;
540 INLINE void
541 fset_icon_name (struct frame *f, Lisp_Object val)
543 f->icon_name = val;
545 INLINE void
546 fset_menu_bar_items (struct frame *f, Lisp_Object val)
548 f->menu_bar_items = val;
550 INLINE void
551 fset_menu_bar_vector (struct frame *f, Lisp_Object val)
553 f->menu_bar_vector = val;
555 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
556 INLINE void
557 fset_menu_bar_window (struct frame *f, Lisp_Object val)
559 f->menu_bar_window = val;
561 #endif
562 INLINE void
563 fset_name (struct frame *f, Lisp_Object val)
565 f->name = val;
567 INLINE void
568 fset_param_alist (struct frame *f, Lisp_Object val)
570 f->param_alist = val;
572 INLINE void
573 fset_root_window (struct frame *f, Lisp_Object val)
575 f->root_window = val;
577 INLINE void
578 fset_scroll_bars (struct frame *f, Lisp_Object val)
580 f->scroll_bars = val;
582 INLINE void
583 fset_selected_window (struct frame *f, Lisp_Object val)
585 f->selected_window = val;
587 INLINE void
588 fset_title (struct frame *f, Lisp_Object val)
590 f->title = val;
592 INLINE void
593 fset_tool_bar_items (struct frame *f, Lisp_Object val)
595 f->tool_bar_items = val;
597 #ifdef USE_GTK
598 INLINE void
599 fset_tool_bar_position (struct frame *f, Lisp_Object val)
601 f->tool_bar_position = val;
603 #endif /* USE_GTK */
604 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
605 INLINE void
606 fset_tool_bar_window (struct frame *f, Lisp_Object val)
608 f->tool_bar_window = val;
610 INLINE void
611 fset_current_tool_bar_string (struct frame *f, Lisp_Object val)
613 f->current_tool_bar_string = val;
615 INLINE void
616 fset_desired_tool_bar_string (struct frame *f, Lisp_Object val)
618 f->desired_tool_bar_string = val;
620 #endif /* HAVE_WINDOW_SYSTEM && !USE_GTK && !HAVE_NS */
622 #define NUMVAL(X) ((INTEGERP (X) || FLOATP (X)) ? XFLOATINT (X) : -1)
624 INLINE double
625 default_pixels_per_inch_x (void)
627 Lisp_Object v = (CONSP (Vdisplay_pixels_per_inch)
628 ? XCAR (Vdisplay_pixels_per_inch)
629 : Vdisplay_pixels_per_inch);
630 return NUMVAL (v) > 0 ? NUMVAL (v) : 72.0;
633 INLINE double
634 default_pixels_per_inch_y (void)
636 Lisp_Object v = (CONSP (Vdisplay_pixels_per_inch)
637 ? XCDR (Vdisplay_pixels_per_inch)
638 : Vdisplay_pixels_per_inch);
639 return NUMVAL (v) > 0 ? NUMVAL (v) : 72.0;
642 #define FRAME_KBOARD(f) ((f)->terminal->kboard)
644 /* Return a pointer to the image cache of frame F. */
645 #define FRAME_IMAGE_CACHE(F) ((F)->terminal->image_cache)
647 #define XFRAME(p) \
648 (eassert (FRAMEP (p)), (struct frame *) XUNTAG (p, Lisp_Vectorlike))
649 #define XSETFRAME(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_FRAME))
651 /* Given a window, return its frame as a Lisp_Object. */
652 #define WINDOW_FRAME(w) ((w)->frame)
654 /* Test a frame for particular kinds of display methods. */
655 #define FRAME_INITIAL_P(f) ((f)->output_method == output_initial)
656 #define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap)
657 #define FRAME_X_P(f) ((f)->output_method == output_x_window)
658 #ifndef HAVE_NTGUI
659 #define FRAME_W32_P(f) false
660 #else
661 #define FRAME_W32_P(f) ((f)->output_method == output_w32)
662 #endif
663 #ifndef MSDOS
664 #define FRAME_MSDOS_P(f) false
665 #else
666 #define FRAME_MSDOS_P(f) ((f)->output_method == output_msdos_raw)
667 #endif
668 #ifndef HAVE_NS
669 #define FRAME_NS_P(f) false
670 #else
671 #define FRAME_NS_P(f) ((f)->output_method == output_ns)
672 #endif
674 /* FRAME_WINDOW_P tests whether the frame is a window, and is
675 defined to be the predicate for the window system being used. */
677 #ifdef HAVE_X_WINDOWS
678 #define FRAME_WINDOW_P(f) FRAME_X_P (f)
679 #endif
680 #ifdef HAVE_NTGUI
681 #define FRAME_WINDOW_P(f) FRAME_W32_P (f)
682 #endif
683 #ifdef HAVE_NS
684 #define FRAME_WINDOW_P(f) FRAME_NS_P(f)
685 #endif
686 #ifndef FRAME_WINDOW_P
687 #define FRAME_WINDOW_P(f) ((void) (f), false)
688 #endif
690 /* Dots per inch of the screen the frame F is on. */
692 #ifdef HAVE_WINDOW_SYSTEM
694 #define FRAME_RES_X(f) \
695 (eassert (FRAME_WINDOW_P (f)), FRAME_DISPLAY_INFO (f)->resx)
696 #define FRAME_RES_Y(f) \
697 (eassert (FRAME_WINDOW_P (f)), FRAME_DISPLAY_INFO (f)->resy)
699 #else /* !HAVE_WINDOW_SYSTEM */
701 /* Defaults when no window system available. */
703 #define FRAME_RES_X(f) default_pixels_per_inch_x ()
704 #define FRAME_RES_Y(f) default_pixels_per_inch_y ()
706 #endif /* HAVE_WINDOW_SYSTEM */
708 /* Return a pointer to the structure holding information about the
709 region of text, if any, that is currently shown in mouse-face on
710 frame F. We need to define two versions because a TTY-only build
711 does not have FRAME_DISPLAY_INFO. */
712 #ifdef HAVE_WINDOW_SYSTEM
713 # define MOUSE_HL_INFO(F) \
714 (FRAME_WINDOW_P(F) \
715 ? &FRAME_DISPLAY_INFO(F)->mouse_highlight \
716 : &(F)->output_data.tty->display_info->mouse_highlight)
717 #else
718 # define MOUSE_HL_INFO(F) \
719 (&(F)->output_data.tty->display_info->mouse_highlight)
720 #endif
722 /* True if frame F is still alive (not deleted). */
723 #define FRAME_LIVE_P(f) ((f)->terminal != 0)
725 /* True if frame F is a minibuffer-only frame. */
726 #define FRAME_MINIBUF_ONLY_P(f) \
727 EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f))
729 /* True if frame F contains it's own minibuffer window. Frame always has
730 minibuffer window, but it could use minibuffer window of another frame. */
731 #define FRAME_HAS_MINIBUF_P(f) \
732 (WINDOWP (f->minibuffer_window) \
733 && XFRAME (XWINDOW (f->minibuffer_window)->frame) == f)
735 /* Pixel width of frame F. */
736 #define FRAME_PIXEL_WIDTH(f) ((f)->pixel_width)
738 /* Pixel height of frame F. */
739 #define FRAME_PIXEL_HEIGHT(f) ((f)->pixel_height)
741 /* Width of frame F, measured in canonical character columns,
742 not including scroll bars if any. */
743 #define FRAME_COLS(f) (f)->text_cols
745 /* Height of frame F, measured in canonical lines, including
746 non-toolkit menu bar and non-toolkit tool bar lines. */
747 #define FRAME_LINES(f) (f)->text_lines
749 /* Width of frame F, measured in pixels not including the width for
750 fringes, scroll bar, and internal borders. */
751 #define FRAME_TEXT_WIDTH(f) (f)->text_width
753 /* Height of frame F, measured in pixels not including the height
754 for scroll bar and internal borders. */
755 #define FRAME_TEXT_HEIGHT(f) (f)->text_height
757 /* Number of lines of frame F used for menu bar.
758 This is relevant on terminal frames and on
759 X Windows when not using the X toolkit.
760 These lines are counted in FRAME_LINES. */
761 #define FRAME_MENU_BAR_LINES(f) (f)->menu_bar_lines
763 /* Pixel height of frame F's menu bar. */
764 #define FRAME_MENU_BAR_HEIGHT(f) (f)->menu_bar_height
766 /* True if this frame should display a tool bar
767 in a way that does not use any text lines. */
768 #if defined (USE_GTK) || defined (HAVE_NS)
769 #define FRAME_EXTERNAL_TOOL_BAR(f) (f)->external_tool_bar
770 #else
771 #define FRAME_EXTERNAL_TOOL_BAR(f) false
772 #endif
774 /* This is really supported only with GTK. */
775 #ifdef USE_GTK
776 #define FRAME_TOOL_BAR_POSITION(f) (f)->tool_bar_position
777 #else
778 #define FRAME_TOOL_BAR_POSITION(f) ((void) f, Qtop)
779 #endif
781 /* Number of lines of frame F used for the tool-bar. */
782 #define FRAME_TOOL_BAR_LINES(f) (f)->tool_bar_lines
784 /* Pixel height of frame F's tool-bar. */
785 #define FRAME_TOOL_BAR_HEIGHT(f) (f)->tool_bar_height
787 /* Lines above the top-most window in frame F. */
788 #define FRAME_TOP_MARGIN(F) \
789 (FRAME_MENU_BAR_LINES (F) + FRAME_TOOL_BAR_LINES (F))
791 /* Pixel height of frame F's top margin. */
792 #define FRAME_TOP_MARGIN_HEIGHT(F) \
793 (FRAME_MENU_BAR_HEIGHT (F) + FRAME_TOOL_BAR_HEIGHT (F))
795 /* True if this frame should display a menu bar
796 in a way that does not use any text lines. */
797 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
798 || defined (HAVE_NS) || defined (USE_GTK)
799 #define FRAME_EXTERNAL_MENU_BAR(f) (f)->external_menu_bar
800 #else
801 #define FRAME_EXTERNAL_MENU_BAR(f) false
802 #endif
804 /* True if frame F is currently visible. */
805 #define FRAME_VISIBLE_P(f) (f)->visible
807 /* True if frame F is currently visible but hidden. */
808 #define FRAME_OBSCURED_P(f) ((f)->visible > 1)
810 /* True if frame F is currently iconified. */
811 #define FRAME_ICONIFIED_P(f) (f)->iconified
813 /* Mark frame F as currently garbaged. */
814 #define SET_FRAME_GARBAGED(f) \
815 (frame_garbaged = true, fset_redisplay (f), f->garbaged = true)
817 /* True if frame F is currently garbaged. */
818 #define FRAME_GARBAGED_P(f) (f)->garbaged
820 /* True means do not allow splitting this frame's window. */
821 #define FRAME_NO_SPLIT_P(f) (f)->no_split
823 /* Not really implemented. */
824 #define FRAME_WANTS_MODELINE_P(f) (f)->wants_modeline
826 /* True if all windows except selected window and mini window
827 are frozen on frame F. */
828 #define FRAME_WINDOWS_FROZEN(f) (f)->frozen_window_starts
830 /* True if a size change has been requested for frame F
831 but not yet really put into effect. This can be true temporarily
832 when an X event comes in at a bad time. */
833 #define FRAME_WINDOW_SIZES_CHANGED(f) (f)->window_sizes_changed
835 /* The minibuffer window of frame F, if it has one; otherwise nil. */
836 #define FRAME_MINIBUF_WINDOW(f) f->minibuffer_window
838 /* The root window of the window tree of frame F. */
839 #define FRAME_ROOT_WINDOW(f) f->root_window
841 /* The currently selected window of the window tree of frame F. */
842 #define FRAME_SELECTED_WINDOW(f) f->selected_window
844 #define FRAME_INSERT_COST(f) (f)->insert_line_cost
845 #define FRAME_DELETE_COST(f) (f)->delete_line_cost
846 #define FRAME_INSERTN_COST(f) (f)->insert_n_lines_cost
847 #define FRAME_DELETEN_COST(f) (f)->delete_n_lines_cost
848 #define FRAME_FOCUS_FRAME(f) f->focus_frame
850 #ifdef HAVE_WINDOW_SYSTEM
852 /* This frame slot says whether scroll bars are currently enabled for frame F,
853 and which side they are on. */
854 #define FRAME_VERTICAL_SCROLL_BAR_TYPE(f) ((f)->vertical_scroll_bar_type)
855 #define FRAME_HAS_VERTICAL_SCROLL_BARS(f) \
856 ((f)->vertical_scroll_bar_type != vertical_scroll_bar_none)
857 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT(f) \
858 ((f)->vertical_scroll_bar_type == vertical_scroll_bar_left)
859 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT(f) \
860 ((f)->vertical_scroll_bar_type == vertical_scroll_bar_right)
862 #else /* not HAVE_WINDOW_SYSTEM */
864 /* If there is no window system, there are no scroll bars. */
865 #define FRAME_VERTICAL_SCROLL_BAR_TYPE(f) ((void) f, vertical_scroll_bar_none)
866 #define FRAME_HAS_VERTICAL_SCROLL_BARS(f) ((void) f, 0)
867 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT(f) ((void) f, 0)
868 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT(f) ((void) f, 0)
870 #endif /* HAVE_WINDOW_SYSTEM */
872 /* Whether horizontal scroll bars are currently enabled for frame F. */
873 #if USE_HORIZONTAL_SCROLL_BARS
874 #define FRAME_HAS_HORIZONTAL_SCROLL_BARS(f) \
875 ((f)->horizontal_scroll_bars)
876 #else
877 #define FRAME_HAS_HORIZONTAL_SCROLL_BARS(f) ((void) f, 0)
878 #endif
880 /* Width that a scroll bar in frame F should have, if there is one.
881 Measured in pixels.
882 If scroll bars are turned off, this is still nonzero. */
883 #define FRAME_CONFIG_SCROLL_BAR_WIDTH(f) ((f)->config_scroll_bar_width)
885 /* Height that a scroll bar in frame F should have, if there is one.
886 Measured in pixels.
887 If scroll bars are turned off, this is still nonzero. */
888 #define FRAME_CONFIG_SCROLL_BAR_HEIGHT(f) ((f)->config_scroll_bar_height)
890 /* Width that a scroll bar in frame F should have, if there is one.
891 Measured in columns (characters).
892 If scroll bars are turned off, this is still nonzero. */
893 #define FRAME_CONFIG_SCROLL_BAR_COLS(f) ((f)->config_scroll_bar_cols)
895 /* Height that a scroll bar in frame F should have, if there is one.
896 Measured in lines (characters).
897 If scroll bars are turned off, this is still nonzero. */
898 #define FRAME_CONFIG_SCROLL_BAR_LINES(f) ((f)->config_scroll_bar_lines)
900 /* Width of a left scroll bar in frame F, measured in pixels */
901 #define FRAME_LEFT_SCROLL_BAR_AREA_WIDTH(f) \
902 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \
903 ? FRAME_CONFIG_SCROLL_BAR_WIDTH (f) \
904 : 0)
906 /* Width of a right scroll bar area in frame F, measured in pixels */
907 #define FRAME_RIGHT_SCROLL_BAR_AREA_WIDTH(f) \
908 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f) \
909 ? FRAME_CONFIG_SCROLL_BAR_WIDTH (f) \
910 : 0)
912 /* Width of a left scroll bar in frame F, measured in columns
913 (characters), but only if scroll bars are on the left. If scroll
914 bars are on the right in this frame, or there are no scroll bars,
915 value is 0. */
916 #define FRAME_LEFT_SCROLL_BAR_COLS(f) \
917 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \
918 ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
919 : 0)
921 /* Width of a right scroll bar in frame F, measured in columns
922 (characters), but only if scroll bars are on the right. If scroll
923 bars are on the left in this frame, or there are no scroll bars,
924 value is 0. */
925 #define FRAME_RIGHT_SCROLL_BAR_COLS(f) \
926 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f) \
927 ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
928 : 0)
930 /* Width of a vertical scroll bar area in frame F, measured in
931 pixels. */
932 #define FRAME_SCROLL_BAR_AREA_WIDTH(f) \
933 (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \
934 ? FRAME_CONFIG_SCROLL_BAR_WIDTH (f) \
935 : 0)
937 /* Height of horizontal scroll bar area in frame F, measured in
938 pixels. */
939 #define FRAME_SCROLL_BAR_AREA_HEIGHT(f) \
940 (FRAME_HAS_HORIZONTAL_SCROLL_BARS (f) \
941 ? FRAME_CONFIG_SCROLL_BAR_HEIGHT (f) \
942 : 0)
944 /* Width of vertical scroll bar in frame F, measured in columns. */
945 #define FRAME_SCROLL_BAR_COLS(f) \
946 (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \
947 ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
948 : 0)
950 /* Height of horizontal scroll bar in frame F, measured in lines. */
951 #define FRAME_SCROLL_BAR_LINES(f) \
952 (FRAME_HAS_HORIZONTAL_SCROLL_BARS (f) \
953 ? FRAME_CONFIG_SCROLL_BAR_LINES (f) \
954 : 0)
956 /* Total width of frame F, in columns (characters),
957 including the width used by scroll bars if any. */
958 #define FRAME_TOTAL_COLS(f) ((f)->total_cols)
960 /* Total height of frame F, in lines (characters),
961 including the height used by scroll bars if any. */
962 #define FRAME_TOTAL_LINES(f) ((f)->total_lines)
964 /* Set the character widths of frame F. WIDTH specifies a nominal
965 character text width. */
966 #define SET_FRAME_COLS(f, width) \
967 ((f)->text_cols = (width), \
968 (f)->total_cols = ((width) \
969 + FRAME_SCROLL_BAR_COLS (f) \
970 + FRAME_FRINGE_COLS (f)))
972 /* Set the character heights of frame F. HEIGHT specifies a nominal
973 character text height. */
974 #define SET_FRAME_LINES(f, height) \
975 ((f)->text_lines = (height), \
976 (f)->total_lines = ((height) \
977 + FRAME_TOP_MARGIN (f) \
978 + FRAME_SCROLL_BAR_LINES (f)))
980 /* Set the widths of frame F. WIDTH specifies a nominal pixel text
981 width. */
982 #define SET_FRAME_WIDTH(f, width) \
983 ((f)->text_width = (width), \
984 (f)->pixel_width = ((width) \
985 + FRAME_SCROLL_BAR_AREA_WIDTH (f) \
986 + FRAME_TOTAL_FRINGE_WIDTH (f) \
987 + 2 * FRAME_INTERNAL_BORDER_WIDTH (f)))
989 /* Set the heights of frame F. HEIGHT specifies a nominal pixel text
990 height. */
991 #define SET_FRAME_HEIGHT(f, height) \
992 ((f)->text_height = (height), \
993 (f)->pixel_height = ((height) \
994 + FRAME_TOP_MARGIN_HEIGHT (f) \
995 + FRAME_SCROLL_BAR_AREA_HEIGHT (f) \
996 + 2 * FRAME_INTERNAL_BORDER_WIDTH (f)))
998 /* Maximum + 1 legitimate value for FRAME_CURSOR_X. */
999 #define FRAME_CURSOR_X_LIMIT(f) \
1000 (FRAME_COLS (f) + FRAME_LEFT_SCROLL_BAR_COLS (f))
1002 /* Nonzero if frame F has scroll bars. */
1003 #define FRAME_SCROLL_BARS(f) (f->scroll_bars)
1004 #define FRAME_CONDEMNED_SCROLL_BARS(f) (f->condemned_scroll_bars)
1006 #define FRAME_MENU_BAR_ITEMS(f) (f->menu_bar_items)
1007 #define FRAME_COST_BAUD_RATE(f) ((f)->cost_calculation_baud_rate)
1009 #define FRAME_DESIRED_CURSOR(f) ((f)->desired_cursor)
1010 #define FRAME_BLINK_OFF_CURSOR(f) ((f)->blink_off_cursor)
1011 #define FRAME_CURSOR_WIDTH(f) ((f)->cursor_width)
1012 #define FRAME_BLINK_OFF_CURSOR_WIDTH(f) ((f)->blink_off_cursor_width)
1014 #define FRAME_FOREGROUND_PIXEL(f) ((f)->foreground_pixel)
1015 #define FRAME_BACKGROUND_PIXEL(f) ((f)->background_pixel)
1017 /* Return a pointer to the face cache of frame F. */
1019 #define FRAME_FACE_CACHE(F) (F)->face_cache
1021 /* Return the size of message_buf of the frame F. We multiply the
1022 width of the frame by 4 because multi-byte form may require at most
1023 4-byte for a character. */
1025 #define FRAME_MESSAGE_BUF_SIZE(f) (((int) FRAME_COLS (f)) * 4)
1027 #define CHECK_FRAME(x) \
1028 CHECK_TYPE (FRAMEP (x), Qframep, x)
1030 #define CHECK_LIVE_FRAME(x) \
1031 CHECK_TYPE (FRAMEP (x) && FRAME_LIVE_P (XFRAME (x)), Qframe_live_p, x)
1033 /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
1034 `for' loop which iterates over the elements of Vframe_list. The
1035 loop will set FRAME_VAR, a Lisp_Object, to each frame in
1036 Vframe_list in succession and execute the statement. LIST_VAR
1037 should be a Lisp_Object too; it is used to iterate through the
1038 Vframe_list.
1040 This macro is a holdover from a time when multiple frames weren't always
1041 supported. An alternate definition of the macro would expand to
1042 something which executes the statement once. */
1044 #define FOR_EACH_FRAME(list_var, frame_var) \
1045 for ((list_var) = Vframe_list; \
1046 (CONSP (list_var) \
1047 && (frame_var = XCAR (list_var), true)); \
1048 list_var = XCDR (list_var))
1050 /* Reflect mouse movement when a complete frame update is performed. */
1052 #define FRAME_MOUSE_UPDATE(frame) \
1053 do { \
1054 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (frame); \
1055 if (frame == hlinfo->mouse_face_mouse_frame) \
1057 block_input (); \
1058 note_mouse_highlight (hlinfo->mouse_face_mouse_frame, \
1059 hlinfo->mouse_face_mouse_x, \
1060 hlinfo->mouse_face_mouse_y); \
1061 unblock_input (); \
1063 } while (false)
1065 /* Handy macro to construct an argument to Fmodify_frame_parameters. */
1067 #define AUTO_FRAME_ARG(name, parameter, value) \
1068 AUTO_LIST1 (name, AUTO_CONS_EXPR (parameter, value))
1070 /* False means there are no visible garbaged frames. */
1071 extern bool frame_garbaged;
1073 /* Set visibility of frame F.
1074 We call redisplay_other_windows to make sure the frame gets redisplayed
1075 if some changes were applied to it while it wasn't visible (and hence
1076 wasn't redisplayed). */
1078 INLINE void
1079 SET_FRAME_VISIBLE (struct frame *f, int v)
1081 eassert (0 <= v && v <= 2);
1082 if (v)
1084 if (v == 1 && f->visible != 1)
1085 redisplay_other_windows ();
1086 if (FRAME_GARBAGED_P (f))
1087 frame_garbaged = true;
1089 f->visible = v;
1092 /* Set iconify of frame F. */
1094 #define SET_FRAME_ICONIFIED(f, i) \
1095 (f)->iconified = (eassert (0 <= (i) && (i) <= 1), (i))
1097 extern Lisp_Object selected_frame;
1098 extern Lisp_Object Qframep, Qframe_live_p;
1099 extern Lisp_Object Qtty, Qtty_type;
1100 extern Lisp_Object Qtty_color_mode;
1101 extern Lisp_Object Qterminal;
1102 extern Lisp_Object Qnoelisp;
1104 extern struct frame *decode_window_system_frame (Lisp_Object);
1105 extern struct frame *decode_live_frame (Lisp_Object);
1106 extern struct frame *decode_any_frame (Lisp_Object);
1107 extern struct frame *make_initial_frame (void);
1108 extern struct frame *make_frame (bool);
1109 #ifdef HAVE_WINDOW_SYSTEM
1110 extern struct frame *make_minibuffer_frame (void);
1111 extern struct frame *make_frame_without_minibuffer (Lisp_Object,
1112 struct kboard *,
1113 Lisp_Object);
1114 extern bool window_system_available (struct frame *);
1115 #else /* not HAVE_WINDOW_SYSTEM */
1116 #define window_system_available(f) ((void) (f), false)
1117 #endif /* HAVE_WINDOW_SYSTEM */
1118 extern void check_window_system (struct frame *);
1119 extern void frame_make_pointer_invisible (struct frame *);
1120 extern void frame_make_pointer_visible (struct frame *);
1121 extern Lisp_Object delete_frame (Lisp_Object, Lisp_Object);
1122 extern bool frame_inhibit_resize (struct frame *, bool, Lisp_Object);
1123 extern void adjust_frame_size (struct frame *, int, int, int, bool, Lisp_Object);
1125 extern Lisp_Object Vframe_list;
1127 /* Value is a pointer to the selected frame. If the selected frame
1128 isn't live, abort. */
1130 #define SELECTED_FRAME() \
1131 ((FRAMEP (selected_frame) \
1132 && FRAME_LIVE_P (XFRAME (selected_frame))) \
1133 ? XFRAME (selected_frame) \
1134 : (emacs_abort (), (struct frame *) 0))
1137 /***********************************************************************
1138 Display-related Macros
1139 ***********************************************************************/
1141 /* Canonical y-unit on frame F.
1142 This value currently equals the line height of the frame (which is
1143 the height of the default font of F). */
1144 #define FRAME_LINE_HEIGHT(F) ((F)->line_height)
1146 /* Canonical x-unit on frame F.
1147 This value currently equals the average width of the default font of F. */
1148 #define FRAME_COLUMN_WIDTH(F) ((F)->column_width)
1150 /* Pixel width of areas used to display truncation marks, continuation
1151 marks, overlay arrows. This is 0 for terminal frames. */
1153 #ifdef HAVE_WINDOW_SYSTEM
1155 /* Total width of fringes reserved for drawing truncation bitmaps,
1156 continuation bitmaps and alike. The width is in canonical char
1157 units of the frame. This must currently be the case because window
1158 sizes aren't pixel values. If it weren't the case, we wouldn't be
1159 able to split windows horizontally nicely. */
1160 #define FRAME_FRINGE_COLS(F) ((F)->fringe_cols)
1162 /* Pixel-width of the left and right fringe. */
1164 #define FRAME_LEFT_FRINGE_WIDTH(F) ((F)->left_fringe_width)
1165 #define FRAME_RIGHT_FRINGE_WIDTH(F) ((F)->right_fringe_width)
1167 /* Total width of fringes in pixels. */
1169 #define FRAME_TOTAL_FRINGE_WIDTH(F) \
1170 (FRAME_LEFT_FRINGE_WIDTH (F) + FRAME_RIGHT_FRINGE_WIDTH (F))
1172 /* Pixel-width of internal border lines */
1173 #define FRAME_INTERNAL_BORDER_WIDTH(F) ((F)->internal_border_width)
1175 /* Pixel-size of window border lines */
1176 #define FRAME_RIGHT_DIVIDER_WIDTH(F) ((F)->right_divider_width)
1177 #define FRAME_BOTTOM_DIVIDER_WIDTH(F) ((F)->bottom_divider_width)
1179 #else /* not HAVE_WINDOW_SYSTEM */
1181 #define FRAME_FRINGE_COLS(F) 0
1182 #define FRAME_TOTAL_FRINGE_WIDTH(F) 0
1183 #define FRAME_LEFT_FRINGE_WIDTH(F) 0
1184 #define FRAME_RIGHT_FRINGE_WIDTH(F) 0
1185 #define FRAME_INTERNAL_BORDER_WIDTH(F) 0
1186 #define FRAME_RIGHT_DIVIDER_WIDTH(F) 0
1187 #define FRAME_BOTTOM_DIVIDER_WIDTH(F) 0
1189 #endif /* not HAVE_WINDOW_SYSTEM */
1191 /***********************************************************************
1192 Conversion between canonical units and pixels
1193 ***********************************************************************/
1195 /* Canonical x-values are fractions of FRAME_COLUMN_WIDTH, canonical
1196 y-unit are fractions of FRAME_LINE_HEIGHT of a frame. Both are
1197 represented as Lisp numbers, i.e. integers or floats. */
1199 /* Convert canonical value X to pixels. F is the frame whose
1200 canonical char width is to be used. X must be a Lisp integer or
1201 float. Value is a C integer. */
1202 #define FRAME_PIXEL_X_FROM_CANON_X(F, X) \
1203 (INTEGERP (X) \
1204 ? XINT (X) * FRAME_COLUMN_WIDTH (F) \
1205 : (int) (XFLOAT_DATA (X) * FRAME_COLUMN_WIDTH (F)))
1207 /* Convert canonical value Y to pixels. F is the frame whose
1208 canonical character height is to be used. X must be a Lisp integer
1209 or float. Value is a C integer. */
1210 #define FRAME_PIXEL_Y_FROM_CANON_Y(F, Y) \
1211 (INTEGERP (Y) \
1212 ? XINT (Y) * FRAME_LINE_HEIGHT (F) \
1213 : (int) (XFLOAT_DATA (Y) * FRAME_LINE_HEIGHT (F)))
1215 /* Convert pixel-value X to canonical units. F is the frame whose
1216 canonical character width is to be used. X is a C integer. Result
1217 is a Lisp float if X is not a multiple of the canon width,
1218 otherwise it's a Lisp integer. */
1219 #define FRAME_CANON_X_FROM_PIXEL_X(F, X) \
1220 ((X) % FRAME_COLUMN_WIDTH (F) != 0 \
1221 ? make_float ((double) (X) / FRAME_COLUMN_WIDTH (F)) \
1222 : make_number ((X) / FRAME_COLUMN_WIDTH (F)))
1224 /* Convert pixel-value Y to canonical units. F is the frame whose
1225 canonical character height is to be used. Y is a C integer.
1226 Result is a Lisp float if Y is not a multiple of the canon width,
1227 otherwise it's a Lisp integer. */
1228 #define FRAME_CANON_Y_FROM_PIXEL_Y(F, Y) \
1229 ((Y) % FRAME_LINE_HEIGHT (F) \
1230 ? make_float ((double) (Y) / FRAME_LINE_HEIGHT (F)) \
1231 : make_number ((Y) / FRAME_LINE_HEIGHT (F)))
1235 /* Manipulating pixel sizes and character sizes.
1236 Knowledge of which factors affect the overall size of the window should
1237 be hidden in these macros, if that's possible.
1239 Return the upper/left pixel position of the character cell on frame F
1240 at ROW/COL. */
1241 #define FRAME_LINE_TO_PIXEL_Y(f, row) \
1242 (((row) < FRAME_TOP_MARGIN (f) ? 0 : FRAME_INTERNAL_BORDER_WIDTH (f)) \
1243 + (row) * FRAME_LINE_HEIGHT (f))
1245 #define FRAME_COL_TO_PIXEL_X(f, col) \
1246 (FRAME_INTERNAL_BORDER_WIDTH (f) \
1247 + (col) * FRAME_COLUMN_WIDTH (f))
1249 /* Return the pixel width/height of frame F if it has
1250 COLS columns/LINES rows. */
1251 #define FRAME_TEXT_COLS_TO_PIXEL_WIDTH(f, cols) \
1252 ((cols) * FRAME_COLUMN_WIDTH (f) \
1253 + FRAME_SCROLL_BAR_AREA_WIDTH (f) \
1254 + FRAME_TOTAL_FRINGE_WIDTH (f) \
1255 + 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
1257 #define FRAME_TEXT_LINES_TO_PIXEL_HEIGHT(f, lines) \
1258 ((lines) * FRAME_LINE_HEIGHT (f) \
1259 + FRAME_TOP_MARGIN_HEIGHT (f) \
1260 + FRAME_SCROLL_BAR_AREA_HEIGHT (f) \
1261 + 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
1263 /* Return the row/column (zero-based) of the character cell containing
1264 the pixel on FRAME at Y/X. */
1265 #define FRAME_PIXEL_Y_TO_LINE(f, y) \
1266 (((y) < FRAME_TOP_MARGIN_HEIGHT (f) \
1267 ? (y) \
1268 : ((y) < (FRAME_TOP_MARGIN_HEIGHT (f) \
1269 + FRAME_INTERNAL_BORDER_WIDTH (f)) \
1270 ? (y) - (FRAME_TOP_MARGIN_HEIGHT (f) \
1271 + FRAME_INTERNAL_BORDER_WIDTH (f) \
1272 /* Arrange for the division to round down. */ \
1273 + FRAME_LINE_HEIGHT (f) - 1) \
1274 : (y) - FRAME_INTERNAL_BORDER_WIDTH (f))) \
1275 / FRAME_LINE_HEIGHT (f))
1277 #define FRAME_PIXEL_X_TO_COL(f, x) \
1278 (((x) - FRAME_INTERNAL_BORDER_WIDTH (f)) \
1279 / FRAME_COLUMN_WIDTH (f))
1281 /* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
1282 frame F (so we round down)? */
1283 #define FRAME_PIXEL_WIDTH_TO_TEXT_COLS(f, width) \
1284 (((width) \
1285 - FRAME_TOTAL_FRINGE_WIDTH (f) \
1286 - FRAME_SCROLL_BAR_AREA_WIDTH (f) \
1287 - 2 * FRAME_INTERNAL_BORDER_WIDTH (f)) \
1288 / FRAME_COLUMN_WIDTH (f)) \
1290 #define FRAME_PIXEL_HEIGHT_TO_TEXT_LINES(f, height) \
1291 (((height) \
1292 - FRAME_TOP_MARGIN_HEIGHT (f) \
1293 - FRAME_SCROLL_BAR_AREA_HEIGHT (f) \
1294 - 2 * FRAME_INTERNAL_BORDER_WIDTH (f)) \
1295 / FRAME_LINE_HEIGHT (f))
1297 /* Return the pixel width/height of frame F with a text size of
1298 width/height. */
1299 #define FRAME_TEXT_TO_PIXEL_WIDTH(f, width) \
1300 ((width) \
1301 + FRAME_SCROLL_BAR_AREA_WIDTH (f) \
1302 + FRAME_TOTAL_FRINGE_WIDTH (f) \
1303 + 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
1305 #define FRAME_TEXT_TO_PIXEL_HEIGHT(f, height) \
1306 ((height) \
1307 + FRAME_TOP_MARGIN_HEIGHT (f) \
1308 + FRAME_SCROLL_BAR_AREA_HEIGHT (f) \
1309 + 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
1311 /* Return the text width/height of frame F with a pixel size of
1312 width/height. */
1313 #define FRAME_PIXEL_TO_TEXT_WIDTH(f, width) \
1314 ((width) \
1315 - FRAME_SCROLL_BAR_AREA_WIDTH (f) \
1316 - FRAME_TOTAL_FRINGE_WIDTH (f) \
1317 - 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
1319 #define FRAME_PIXEL_TO_TEXT_HEIGHT(f, height) \
1320 ((height) \
1321 - FRAME_TOP_MARGIN_HEIGHT (f) \
1322 - FRAME_SCROLL_BAR_AREA_HEIGHT (f) \
1323 - 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
1325 /* Return the width/height reserved for the windows of frame F. */
1326 #define FRAME_WINDOWS_WIDTH(f) \
1327 (FRAME_PIXEL_WIDTH (f) \
1328 - 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
1330 #define FRAME_WINDOWS_HEIGHT(f) \
1331 (FRAME_PIXEL_HEIGHT (f) \
1332 - FRAME_TOP_MARGIN_HEIGHT (f) \
1333 - 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
1335 /* Value is the smallest width of any character in any font on frame F. */
1336 #define FRAME_SMALLEST_CHAR_WIDTH(f) \
1337 FRAME_DISPLAY_INFO (f)->smallest_char_width
1339 /* Value is the smallest height of any font on frame F. */
1340 #define FRAME_SMALLEST_FONT_HEIGHT(f) \
1341 FRAME_DISPLAY_INFO (f)->smallest_font_height
1343 /***********************************************************************
1344 Frame Parameters
1345 ***********************************************************************/
1347 extern Lisp_Object Qauto_raise, Qauto_lower;
1348 extern Lisp_Object Qborder_color, Qborder_width;
1349 extern Lisp_Object Qbuffer_predicate;
1350 extern Lisp_Object Qcursor_color, Qcursor_type;
1351 extern Lisp_Object Qfont;
1352 extern Lisp_Object Qicon, Qicon_name, Qicon_type, Qicon_left, Qicon_top;
1353 extern Lisp_Object Qinternal_border_width;
1354 extern Lisp_Object Qright_divider_width, Qbottom_divider_width;
1355 extern Lisp_Object Qtooltip;
1356 extern Lisp_Object Qmenu_bar_lines, Qtool_bar_lines, Qtool_bar_position;
1357 extern Lisp_Object Qmouse_color;
1358 extern Lisp_Object Qname, Qtitle;
1359 extern Lisp_Object Qparent_id;
1360 extern Lisp_Object Qunsplittable, Qvisibility;
1361 extern Lisp_Object Qscroll_bar_width, Qvertical_scroll_bars;
1362 extern Lisp_Object Qscroll_bar_height, Qhorizontal_scroll_bars;
1363 extern Lisp_Object Qscroll_bar_foreground, Qscroll_bar_background;
1364 extern Lisp_Object Qscreen_gamma;
1365 extern Lisp_Object Qline_spacing;
1366 extern Lisp_Object Qwait_for_wm;
1367 extern Lisp_Object Qfullscreen;
1368 extern Lisp_Object Qfullwidth, Qfullheight, Qfullboth, Qmaximized;
1369 extern Lisp_Object Qsticky;
1370 extern Lisp_Object Qfont_backend;
1371 extern Lisp_Object Qalpha;
1373 extern Lisp_Object Qleft_fringe, Qright_fringe;
1374 extern Lisp_Object Qheight, Qwidth;
1375 extern Lisp_Object Qminibuffer, Qmodeline;
1376 extern Lisp_Object Qx, Qw32, Qpc, Qns;
1377 extern Lisp_Object Qvisible;
1378 extern Lisp_Object Qdisplay_type;
1380 extern Lisp_Object Qx_resource_name;
1382 extern Lisp_Object Qtop, Qbox, Qbottom;
1383 extern Lisp_Object Qdisplay;
1385 extern Lisp_Object Qframe_position, Qframe_outer_size, Qframe_inner_size;
1386 extern Lisp_Object Qexternal_border_size, Qtitle_height;
1387 extern Lisp_Object Qmenu_bar_external, Qmenu_bar_size;
1388 extern Lisp_Object Qtool_bar_external, Qtool_bar_size;
1390 extern Lisp_Object Qrun_hook_with_args;
1392 #ifdef HAVE_WINDOW_SYSTEM
1394 /* The class of this X application. */
1395 #define EMACS_CLASS "Emacs"
1397 extern void x_set_scroll_bar_default_width (struct frame *);
1398 extern void x_set_scroll_bar_default_height (struct frame *);
1399 extern void x_set_offset (struct frame *, int, int, int);
1400 extern void x_wm_set_size_hint (struct frame *f, long flags, bool user_position);
1401 extern Lisp_Object x_new_font (struct frame *, Lisp_Object, int);
1402 extern Lisp_Object Qface_set_after_frame_default;
1403 extern void x_set_frame_parameters (struct frame *, Lisp_Object);
1404 extern void x_set_fullscreen (struct frame *, Lisp_Object, Lisp_Object);
1405 extern void x_set_line_spacing (struct frame *, Lisp_Object, Lisp_Object);
1406 extern void x_set_screen_gamma (struct frame *, Lisp_Object, Lisp_Object);
1407 extern void x_set_font (struct frame *, Lisp_Object, Lisp_Object);
1408 extern void x_set_font_backend (struct frame *, Lisp_Object, Lisp_Object);
1409 extern void x_set_left_fringe (struct frame *, Lisp_Object, Lisp_Object);
1410 extern void x_set_right_fringe (struct frame *, Lisp_Object, Lisp_Object);
1411 extern void x_set_border_width (struct frame *, Lisp_Object, Lisp_Object);
1412 extern void x_set_right_divider_width (struct frame *, Lisp_Object,
1413 Lisp_Object);
1414 extern void x_set_bottom_divider_width (struct frame *, Lisp_Object,
1415 Lisp_Object);
1416 extern void x_set_visibility (struct frame *, Lisp_Object, Lisp_Object);
1417 extern void x_set_autoraise (struct frame *, Lisp_Object, Lisp_Object);
1418 extern void x_set_autolower (struct frame *, Lisp_Object, Lisp_Object);
1419 extern void x_set_unsplittable (struct frame *, Lisp_Object, Lisp_Object);
1420 extern void x_set_vertical_scroll_bars (struct frame *, Lisp_Object, Lisp_Object);
1421 extern void x_set_horizontal_scroll_bars (struct frame *, Lisp_Object, Lisp_Object);
1422 extern void x_set_scroll_bar_width (struct frame *, Lisp_Object, Lisp_Object);
1423 extern void x_set_scroll_bar_height (struct frame *, Lisp_Object, Lisp_Object);
1425 extern long x_figure_window_size (struct frame *, Lisp_Object, bool);
1427 extern void x_set_alpha (struct frame *, Lisp_Object, Lisp_Object);
1429 extern void validate_x_resource_name (void);
1431 extern Lisp_Object display_x_get_resource (Display_Info *,
1432 Lisp_Object attribute,
1433 Lisp_Object class,
1434 Lisp_Object component,
1435 Lisp_Object subclass);
1437 extern void set_frame_menubar (struct frame *f, bool first_time, bool deep_p);
1438 extern void x_set_window_size (struct frame *f, bool change_gravity,
1439 int width, int height, bool pixelwise);
1440 extern Lisp_Object x_get_focus_frame (struct frame *);
1441 extern void frame_set_mouse_pixel_position (struct frame *f, int pix_x, int pix_y);
1442 extern void x_make_frame_visible (struct frame *f);
1443 extern void x_make_frame_invisible (struct frame *f);
1444 extern void x_iconify_frame (struct frame *f);
1445 extern void x_set_frame_alpha (struct frame *f);
1446 extern void x_activate_menubar (struct frame *);
1447 extern void x_real_positions (struct frame *, int *, int *);
1448 extern void free_frame_menubar (struct frame *);
1449 extern void x_free_frame_resources (struct frame *);
1451 #if defined HAVE_X_WINDOWS
1452 extern void x_wm_set_icon_position (struct frame *, int, int);
1453 #if !defined USE_X_TOOLKIT
1454 extern char *x_get_resource_string (const char *, const char *);
1455 #endif
1456 extern void x_sync (struct frame *);
1457 #endif /* HAVE_X_WINDOWS */
1459 extern void x_query_colors (struct frame *f, XColor *, int);
1460 extern void x_query_color (struct frame *f, XColor *);
1461 extern void x_focus_frame (struct frame *);
1463 #ifndef HAVE_NS
1465 extern bool x_bitmap_icon (struct frame *, Lisp_Object);
1467 /* Set F's bitmap icon, if specified among F's parameters. */
1469 INLINE void
1470 x_set_bitmap_icon (struct frame *f)
1472 Lisp_Object obj = assq_no_quit (Qicon_type, f->param_alist);
1474 if (CONSP (obj))
1475 x_bitmap_icon (f, XCDR (obj));
1478 #endif /* !HAVE_NS */
1479 #endif /* HAVE_WINDOW_SYSTEM */
1481 INLINE void
1482 flush_frame (struct frame *f)
1484 struct redisplay_interface *rif = FRAME_RIF (f);
1486 if (rif && rif->flush_display)
1487 rif->flush_display (f);
1490 /***********************************************************************
1491 Multimonitor data
1492 ***********************************************************************/
1494 #ifdef HAVE_WINDOW_SYSTEM
1496 struct MonitorInfo {
1497 XRectangle geom, work;
1498 int mm_width, mm_height;
1499 char *name;
1502 extern void free_monitors (struct MonitorInfo *monitors, int n_monitors);
1503 extern Lisp_Object make_monitor_attribute_list (struct MonitorInfo *monitors,
1504 int n_monitors,
1505 int primary_monitor,
1506 Lisp_Object monitor_frames,
1507 const char *source);
1509 #endif /* HAVE_WINDOW_SYSTEM */
1512 INLINE_HEADER_END
1514 /* Suppress -Wsuggest-attribute=const if there are no scroll bars.
1515 This is for functions like x_set_horizontal_scroll_bars that have
1516 no effect in this case. */
1517 #if ! USE_HORIZONTAL_SCROLL_BARS && 4 < __GNUC__ + (6 <= __GNUC_MINOR__)
1518 # pragma GCC diagnostic ignored "-Wsuggest-attribute=const"
1519 #endif
1521 #endif /* not EMACS_FRAME_H */