autorevert: Resume with polling if file is deleted
[emacs.git] / src / frame.h
blob9de672c8635964ef0e3b8d1f0ce466d61b0c85d4
1 /* Define frame-object for GNU Emacs.
2 Copyright (C) 1993-1994, 1999-2016 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 (at
9 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 #ifndef EMACS_FRAME_H
20 #define EMACS_FRAME_H
22 #include "termhooks.h"
23 #include "window.h"
25 INLINE_HEADER_BEGIN
27 enum vertical_scroll_bar_type
29 vertical_scroll_bar_none,
30 vertical_scroll_bar_left,
31 vertical_scroll_bar_right
34 #ifdef HAVE_WINDOW_SYSTEM
36 enum fullscreen_type
38 FULLSCREEN_NONE,
39 FULLSCREEN_WIDTH = 0x1,
40 FULLSCREEN_HEIGHT = 0x2,
41 FULLSCREEN_BOTH = 0x3, /* Not a typo but means "width and height". */
42 FULLSCREEN_MAXIMIZED = 0x4,
43 #ifdef HAVE_NTGUI
44 FULLSCREEN_WAIT = 0x8
45 #endif
48 #endif /* HAVE_WINDOW_SYSTEM */
50 /* The structure representing a frame. */
52 struct frame
54 struct vectorlike_header header;
56 /* All Lisp_Object components must come first.
57 That ensures they are all aligned normally. */
59 /* Name of this frame: a Lisp string. It is used for looking up resources,
60 as well as for the title in some cases. */
61 Lisp_Object name;
63 /* The name to use for the icon, the last time
64 it was refreshed. nil means not explicitly specified. */
65 Lisp_Object icon_name;
67 /* This is the frame title specified explicitly, if any.
68 Usually it is nil. */
69 Lisp_Object title;
71 /* The frame which should receive keystrokes that occur in this
72 frame, or nil if they should go to the frame itself. This is
73 usually nil, but if the frame is minibufferless, we can use this
74 to redirect keystrokes to a surrogate minibuffer frame when
75 needed.
77 Note that a value of nil is different than having the field point
78 to the frame itself. Whenever the Fselect_frame function is used
79 to shift from one frame to the other, any redirections to the
80 original frame are shifted to the newly selected frame; if
81 focus_frame is nil, Fselect_frame will leave it alone. */
82 Lisp_Object focus_frame;
84 /* This frame's root window. Every frame has one.
85 If the frame has only a minibuffer window, this is it.
86 Otherwise, if the frame has a minibuffer window, this is its sibling. */
87 Lisp_Object root_window;
89 /* This frame's selected window.
90 Each frame has its own window hierarchy
91 and one of the windows in it is selected within the frame.
92 The selected window of the selected frame is Emacs's selected window. */
93 Lisp_Object selected_window;
95 /* This frame's minibuffer window.
96 Most frames have their own minibuffer windows,
97 but only the selected frame's minibuffer window
98 can actually appear to exist. */
99 Lisp_Object minibuffer_window;
101 /* Parameter alist of this frame.
102 These are the parameters specified when creating the frame
103 or modified with modify-frame-parameters. */
104 Lisp_Object param_alist;
106 /* List of scroll bars on this frame.
107 Actually, we don't specify exactly what is stored here at all; the
108 scroll bar implementation code can use it to store anything it likes.
109 This field is marked by the garbage collector. It is here
110 instead of in the `device' structure so that the garbage
111 collector doesn't need to look inside the window-system-dependent
112 structure. */
113 Lisp_Object scroll_bars;
114 Lisp_Object condemned_scroll_bars;
116 /* Vector describing the items to display in the menu bar.
117 Each item has four elements in this vector.
118 They are KEY, STRING, SUBMAP, and HPOS.
119 (HPOS is not used in when the X toolkit is in use.)
120 There are four additional elements of nil at the end, to terminate. */
121 Lisp_Object menu_bar_items;
123 /* Alist of elements (FACE-NAME . FACE-VECTOR-DATA). */
124 Lisp_Object face_alist;
126 /* A vector that records the entire structure of this frame's menu bar.
127 For the format of the data, see extensive comments in xmenu.c.
128 Only the X toolkit version uses this. */
129 Lisp_Object menu_bar_vector;
131 /* Predicate for selecting buffers for other-buffer. */
132 Lisp_Object buffer_predicate;
134 /* List of buffers viewed in this frame, for other-buffer. */
135 Lisp_Object buffer_list;
137 /* List of buffers that were viewed, then buried in this frame. The
138 most recently buried buffer is first. For last-buffer. */
139 Lisp_Object buried_buffer_list;
141 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
142 /* A dummy window used to display menu bars under X when no X
143 toolkit support is available. */
144 Lisp_Object menu_bar_window;
145 #endif
147 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
148 /* A window used to display the tool-bar of a frame. */
149 Lisp_Object tool_bar_window;
151 /* Desired and current contents displayed in that window. */
152 Lisp_Object desired_tool_bar_string;
153 Lisp_Object current_tool_bar_string;
154 #endif
156 /* Desired and current tool-bar items. */
157 Lisp_Object tool_bar_items;
159 #ifdef USE_GTK
160 /* Where tool bar is, can be left, right, top or bottom.
161 Except with GTK, the only supported position is `top'. */
162 Lisp_Object tool_bar_position;
163 #endif
165 #if defined (HAVE_XFT) || defined (HAVE_FREETYPE)
166 /* List of data specific to font-driver and frame, but common to faces. */
167 Lisp_Object font_data;
168 #endif
170 /* Beyond here, there should be no more Lisp_Object components. */
172 /* Cache of realized faces. */
173 struct face_cache *face_cache;
175 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
176 /* Tool-bar item index of the item on which a mouse button was pressed. */
177 int last_tool_bar_item;
178 #endif
180 /* Number of elements in `menu_bar_vector' that have meaningful data. */
181 int menu_bar_items_used;
183 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
184 /* A buffer to hold the frame's name. Since this is used by the
185 window system toolkit, we can't use the Lisp string's pointer
186 (`name', above) because it might get relocated. */
187 char *namebuf;
188 #endif
190 #ifdef USE_X_TOOLKIT
191 /* Used to pass geometry parameters to toolkit functions. */
192 char *shell_position;
193 #endif
195 /* Glyph pool and matrix. */
196 struct glyph_pool *current_pool;
197 struct glyph_pool *desired_pool;
198 struct glyph_matrix *desired_matrix;
199 struct glyph_matrix *current_matrix;
201 /* Bitfield area begins here. Keep them together to avoid extra padding. */
203 /* True means that glyphs on this frame have been initialized so it can
204 be used for output. */
205 bool_bf glyphs_initialized_p : 1;
207 /* Set to true in change_frame_size when size of frame changed
208 Clear the frame in clear_garbaged_frames if set. */
209 bool_bf resized_p : 1;
211 /* Set to true if the default face for the frame has been
212 realized. Reset to zero whenever the default face changes.
213 Used to see the difference between a font change and face change. */
214 bool_bf default_face_done_p : 1;
216 /* Set to true if this frame has already been hscrolled during
217 current redisplay. */
218 bool_bf already_hscrolled_p : 1;
220 /* Set to true when current redisplay has updated frame. */
221 bool_bf updated_p : 1;
223 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
224 /* Set to true to minimize tool-bar height even when
225 auto-resize-tool-bar is set to grow-only. */
226 bool_bf minimize_tool_bar_window_p : 1;
227 #endif
229 #if defined (USE_GTK) || defined (HAVE_NS)
230 /* True means using a tool bar that comes from the toolkit. */
231 bool_bf external_tool_bar : 1;
232 #endif
234 /* True means that fonts have been loaded since the last glyph
235 matrix adjustments. */
236 bool_bf fonts_changed : 1;
238 /* True means that cursor type has been changed. */
239 bool_bf cursor_type_changed : 1;
241 /* True if it needs to be redisplayed. */
242 bool_bf redisplay : 1;
244 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
245 || defined (HAVE_NS) || defined (USE_GTK)
246 /* True means using a menu bar that comes from the X toolkit. */
247 bool_bf external_menu_bar : 1;
248 #endif
250 /* Next two bitfields are mutually exclusive. They might both be
251 zero if the frame has been made invisible without an icon. */
253 /* Nonzero if the frame is currently displayed; we check
254 it to see if we should bother updating the frame's contents.
256 On ttys and on Windows NT/9X, to avoid wasting effort updating
257 visible frames that are actually completely obscured by other
258 windows on the display, we bend the meaning of visible slightly:
259 if equal to 2, then the frame is obscured - we still consider
260 it to be "visible" as seen from lisp, but we don't bother
261 updating it. */
262 unsigned visible : 2;
264 /* True if the frame is currently iconified. Do not
265 set this directly, use SET_FRAME_ICONIFIED instead. */
266 bool_bf iconified : 1;
268 /* True if this frame should be fully redisplayed. Disables all
269 optimizations while rebuilding matrices and redrawing. */
270 bool_bf garbaged : 1;
272 /* False means, if this frame has just one window,
273 show no modeline for that window. */
274 bool_bf wants_modeline : 1;
276 /* True means raise this frame to the top of the heap when selected. */
277 bool_bf auto_raise : 1;
279 /* True means lower this frame to the bottom of the stack when left. */
280 bool_bf auto_lower : 1;
282 /* True if frame's root window can't be split. */
283 bool_bf no_split : 1;
285 /* If this is set, then Emacs won't change the frame name to indicate
286 the current buffer, etcetera. If the user explicitly sets the frame
287 name, this gets set. If the user sets the name to Qnil, this is
288 cleared. */
289 bool_bf explicit_name : 1;
291 /* True if configuration of windows on this frame has changed since
292 last call of run_window_size_change_functions. */
293 bool_bf window_configuration_changed : 1;
295 /* True if the mouse has moved on this display device
296 since the last time we checked. */
297 bool_bf mouse_moved : 1;
299 /* True means that the pointer is invisible. */
300 bool_bf pointer_invisible : 1;
302 /* True means that all windows except mini-window and
303 selected window on this frame have frozen window starts. */
304 bool_bf frozen_window_starts : 1;
306 /* The output method says how the contents of this frame are
307 displayed. It could be using termcap, or using an X window.
308 This must be the same as the terminal->type. */
309 ENUM_BF (output_method) output_method : 3;
311 #ifdef HAVE_WINDOW_SYSTEM
312 /* See FULLSCREEN_ enum on top. */
313 ENUM_BF (fullscreen_type) want_fullscreen : 4;
315 /* If not vertical_scroll_bar_none, we should actually
316 display the scroll bars of this type on this frame. */
317 ENUM_BF (vertical_scroll_bar_type) vertical_scroll_bar_type : 2;
319 /* Nonzero if we should actually display horizontal scroll bars on this frame. */
320 bool_bf horizontal_scroll_bars : 1;
321 #endif /* HAVE_WINDOW_SYSTEM */
323 /* Whether new_height and new_width shall be interpreted
324 in pixels. */
325 bool_bf new_pixelwise : 1;
327 /* True means x_set_window_size requests can be processed for this
328 frame. */
329 bool_bf can_x_set_window_size : 1;
331 /* Set to true after this frame was made by `make-frame'. */
332 bool_bf after_make_frame : 1;
334 /* Whether the tool bar height change should be taken into account. */
335 bool_bf tool_bar_redisplayed : 1;
336 bool_bf tool_bar_resized : 1;
338 /* Inhibit implied resize before after_make_frame is set. */
339 bool_bf inhibit_horizontal_resize : 1;
340 bool_bf inhibit_vertical_resize : 1;
342 /* Non-zero if this frame's faces need to be recomputed. */
343 bool_bf face_change : 1;
345 /* Bitfield area ends here. */
347 /* Number of lines (rounded up) of tool bar. REMOVE THIS */
348 int tool_bar_lines;
350 /* Height of frame internal tool bar in pixels. */
351 int tool_bar_height;
353 int n_tool_bar_rows;
354 int n_tool_bar_items;
356 /* A buffer for decode_mode_line. */
357 char *decode_mode_spec_buffer;
359 /* See do_line_insertion_deletion_costs for info on these arrays. */
360 /* Cost of inserting 1 line on this frame. */
361 int *insert_line_cost;
362 /* Cost of deleting 1 line on this frame. */
363 int *delete_line_cost;
364 /* Cost of inserting n lines on this frame. */
365 int *insert_n_lines_cost;
366 /* Cost of deleting n lines on this frame. */
367 int *delete_n_lines_cost;
369 /* Text width of this frame (excluding fringes, vertical scroll bar
370 and internal border widths) and text height (excluding menu bar,
371 tool bar, horizontal scroll bar and internal border widths) in
372 units of canonical characters. */
373 int text_cols, text_lines;
375 /* Total width of this frame (including fringes, vertical scroll bar
376 and internal border widths) and total height (including menu bar,
377 tool bar, horizontal scroll bar and internal border widths) in
378 units of canonical characters. */
379 int total_cols, total_lines;
381 /* Text width of this frame (excluding fringes, vertical scroll bar
382 and internal border widths) and text height (excluding menu bar,
383 tool bar, horizontal scroll bar and internal border widths) in
384 pixels. */
385 int text_width, text_height;
387 /* New text height and width for pending size change. 0 if no change
388 pending. These values represent pixels or canonical character units
389 according to the value of new_pixelwise and correlate to the the
390 text width/height of the frame. */
391 int new_width, new_height;
393 /* Pixel position of the frame window (x and y offsets in root window). */
394 int left_pos, top_pos;
396 /* Total width of this frame (including fringes, vertical scroll bar
397 and internal border widths) and total height (including internal
398 menu and tool bars, horizontal scroll bar and internal border
399 widths) in pixels. */
400 int pixel_width, pixel_height;
402 /* This is the gravity value for the specified window position. */
403 int win_gravity;
405 /* The geometry flags for this window. */
406 int size_hint_flags;
408 /* Border width of the frame window as known by the (X) window system. */
409 int border_width;
411 /* Width of the internal border. This is a line of background color
412 just inside the window's border. When the frame is selected,
413 a highlighting is displayed inside the internal border. */
414 int internal_border_width;
416 /* Widths of dividers between this frame's windows in pixels. */
417 int right_divider_width, bottom_divider_width;
419 /* Widths of fringes in pixels. */
420 int left_fringe_width, right_fringe_width;
422 /* Total width of fringes reserved for drawing truncation bitmaps,
423 continuation bitmaps and alike - REMOVE THIS !!!!. */
424 int fringe_cols;
426 /* Number of lines of menu bar. */
427 int menu_bar_lines;
429 /* Pixel height of menubar. */
430 int menu_bar_height;
432 /* Canonical X unit. Width of default font, in pixels. */
433 int column_width;
435 /* Canonical Y unit. Height of a line, in pixels. */
436 int line_height;
438 /* The terminal device that this frame uses. If this is NULL, then
439 the frame has been deleted. */
440 struct terminal *terminal;
442 /* Device-dependent, frame-local auxiliary data used for displaying
443 the contents. When the frame is deleted, this data is deleted as
444 well. */
445 union output_data
447 struct tty_output *tty; /* From termchar.h. */
448 struct x_output *x; /* From xterm.h. */
449 struct w32_output *w32; /* From w32term.h. */
450 struct ns_output *ns; /* From nsterm.h. */
451 intptr_t nothing;
453 output_data;
455 /* List of font-drivers available on the frame. */
456 struct font_driver_list *font_driver_list;
458 #if defined (HAVE_X_WINDOWS)
459 /* Used by x_wait_for_event when watching for an X event on this frame. */
460 int wait_event_type;
461 #endif
463 /* What kind of text cursor should we draw in the future?
464 This should always be filled_box_cursor or bar_cursor. */
465 enum text_cursor_kinds desired_cursor;
467 /* Width of bar cursor (if we are using that). */
468 int cursor_width;
470 /* What kind of text cursor should we draw when the cursor blinks off?
471 This can be filled_box_cursor or bar_cursor or no_cursor. */
472 enum text_cursor_kinds blink_off_cursor;
474 /* Width of bar cursor (if we are using that) for blink-off state. */
475 int blink_off_cursor_width;
477 /* Configured width of the scroll bar, in pixels and in characters.
478 config_scroll_bar_cols tracks config_scroll_bar_width if the
479 latter is positive; a zero value in config_scroll_bar_width means
480 to compute the actual width on the fly, using config_scroll_bar_cols
481 and the current font width. */
482 int config_scroll_bar_width;
483 int config_scroll_bar_cols;
485 /* Configured height of the scroll bar, in pixels and in characters.
486 config_scroll_bar_lines tracks config_scroll_bar_height if the
487 latter is positive; a zero value in config_scroll_bar_height means
488 to compute the actual width on the fly, using
489 config_scroll_bar_lines and the current font width. */
490 int config_scroll_bar_height;
491 int config_scroll_bar_lines;
493 /* The baud rate that was used to calculate costs for this frame. */
494 int cost_calculation_baud_rate;
496 /* Frame opacity
497 alpha[0]: alpha transparency of the active frame
498 alpha[1]: alpha transparency of inactive frames
499 Negative values mean not to change alpha. */
500 double alpha[2];
502 /* Exponent for gamma correction of colors. 1/(VIEWING_GAMMA *
503 SCREEN_GAMMA) where viewing_gamma is 0.4545 and SCREEN_GAMMA is a
504 frame parameter. 0 means don't do gamma correction. */
505 double gamma;
507 /* Additional space to put between text lines on this frame. */
508 int extra_line_spacing;
510 /* All display backends seem to need these two pixel values. */
511 unsigned long background_pixel;
512 unsigned long foreground_pixel;
515 /* Most code should use these functions to set Lisp fields in struct frame. */
517 INLINE void
518 fset_buffer_list (struct frame *f, Lisp_Object val)
520 f->buffer_list = val;
522 INLINE void
523 fset_buried_buffer_list (struct frame *f, Lisp_Object val)
525 f->buried_buffer_list = val;
527 INLINE void
528 fset_condemned_scroll_bars (struct frame *f, Lisp_Object val)
530 f->condemned_scroll_bars = val;
532 INLINE void
533 fset_face_alist (struct frame *f, Lisp_Object val)
535 f->face_alist = val;
537 INLINE void
538 fset_focus_frame (struct frame *f, Lisp_Object val)
540 f->focus_frame = val;
542 INLINE void
543 fset_icon_name (struct frame *f, Lisp_Object val)
545 f->icon_name = val;
547 INLINE void
548 fset_menu_bar_items (struct frame *f, Lisp_Object val)
550 f->menu_bar_items = val;
552 INLINE void
553 fset_menu_bar_vector (struct frame *f, Lisp_Object val)
555 f->menu_bar_vector = val;
557 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
558 INLINE void
559 fset_menu_bar_window (struct frame *f, Lisp_Object val)
561 f->menu_bar_window = val;
563 #endif
564 INLINE void
565 fset_name (struct frame *f, Lisp_Object val)
567 f->name = val;
569 INLINE void
570 fset_param_alist (struct frame *f, Lisp_Object val)
572 f->param_alist = val;
574 INLINE void
575 fset_root_window (struct frame *f, Lisp_Object val)
577 f->root_window = val;
579 INLINE void
580 fset_scroll_bars (struct frame *f, Lisp_Object val)
582 f->scroll_bars = val;
584 INLINE void
585 fset_selected_window (struct frame *f, Lisp_Object val)
587 f->selected_window = val;
589 INLINE void
590 fset_title (struct frame *f, Lisp_Object val)
592 f->title = val;
594 INLINE void
595 fset_tool_bar_items (struct frame *f, Lisp_Object val)
597 f->tool_bar_items = val;
599 #ifdef USE_GTK
600 INLINE void
601 fset_tool_bar_position (struct frame *f, Lisp_Object val)
603 f->tool_bar_position = val;
605 #endif /* USE_GTK */
606 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
607 INLINE void
608 fset_tool_bar_window (struct frame *f, Lisp_Object val)
610 f->tool_bar_window = val;
612 INLINE void
613 fset_current_tool_bar_string (struct frame *f, Lisp_Object val)
615 f->current_tool_bar_string = val;
617 INLINE void
618 fset_desired_tool_bar_string (struct frame *f, Lisp_Object val)
620 f->desired_tool_bar_string = val;
622 #endif /* HAVE_WINDOW_SYSTEM && !USE_GTK && !HAVE_NS */
624 #define NUMVAL(X) (NUMBERP (X) ? XFLOATINT (X) : -1)
626 INLINE double
627 default_pixels_per_inch_x (void)
629 Lisp_Object v = (CONSP (Vdisplay_pixels_per_inch)
630 ? XCAR (Vdisplay_pixels_per_inch)
631 : Vdisplay_pixels_per_inch);
632 return NUMVAL (v) > 0 ? NUMVAL (v) : 72.0;
635 INLINE double
636 default_pixels_per_inch_y (void)
638 Lisp_Object v = (CONSP (Vdisplay_pixels_per_inch)
639 ? XCDR (Vdisplay_pixels_per_inch)
640 : Vdisplay_pixels_per_inch);
641 return NUMVAL (v) > 0 ? NUMVAL (v) : 72.0;
644 #define FRAME_KBOARD(f) ((f)->terminal->kboard)
646 /* Return a pointer to the image cache of frame F. */
647 #define FRAME_IMAGE_CACHE(F) ((F)->terminal->image_cache)
649 #define XFRAME(p) \
650 (eassert (FRAMEP (p)), (struct frame *) XUNTAG (p, Lisp_Vectorlike))
651 #define XSETFRAME(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_FRAME))
653 /* Given a window, return its frame as a Lisp_Object. */
654 #define WINDOW_FRAME(w) ((w)->frame)
656 /* Test a frame for particular kinds of display methods. */
657 #define FRAME_INITIAL_P(f) ((f)->output_method == output_initial)
658 #define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap)
659 #define FRAME_X_P(f) ((f)->output_method == output_x_window)
660 #ifndef HAVE_NTGUI
661 #define FRAME_W32_P(f) false
662 #else
663 #define FRAME_W32_P(f) ((f)->output_method == output_w32)
664 #endif
665 #ifndef MSDOS
666 #define FRAME_MSDOS_P(f) false
667 #else
668 #define FRAME_MSDOS_P(f) ((f)->output_method == output_msdos_raw)
669 #endif
670 #ifndef HAVE_NS
671 #define FRAME_NS_P(f) false
672 #else
673 #define FRAME_NS_P(f) ((f)->output_method == output_ns)
674 #endif
676 /* FRAME_WINDOW_P tests whether the frame is a window, and is
677 defined to be the predicate for the window system being used. */
679 #ifdef HAVE_X_WINDOWS
680 #define FRAME_WINDOW_P(f) FRAME_X_P (f)
681 #endif
682 #ifdef HAVE_NTGUI
683 #define FRAME_WINDOW_P(f) FRAME_W32_P (f)
684 #endif
685 #ifdef HAVE_NS
686 #define FRAME_WINDOW_P(f) FRAME_NS_P(f)
687 #endif
688 #ifndef FRAME_WINDOW_P
689 #define FRAME_WINDOW_P(f) ((void) (f), false)
690 #endif
692 /* Dots per inch of the screen the frame F is on. */
694 #ifdef HAVE_WINDOW_SYSTEM
696 #define FRAME_RES_X(f) \
697 (eassert (FRAME_WINDOW_P (f)), FRAME_DISPLAY_INFO (f)->resx)
698 #define FRAME_RES_Y(f) \
699 (eassert (FRAME_WINDOW_P (f)), FRAME_DISPLAY_INFO (f)->resy)
701 #else /* !HAVE_WINDOW_SYSTEM */
703 /* Defaults when no window system available. */
705 #define FRAME_RES_X(f) default_pixels_per_inch_x ()
706 #define FRAME_RES_Y(f) default_pixels_per_inch_y ()
708 #endif /* HAVE_WINDOW_SYSTEM */
710 /* Return a pointer to the structure holding information about the
711 region of text, if any, that is currently shown in mouse-face on
712 frame F. We need to define two versions because a TTY-only build
713 does not have FRAME_DISPLAY_INFO. */
714 #ifdef HAVE_WINDOW_SYSTEM
715 # define MOUSE_HL_INFO(F) \
716 (FRAME_WINDOW_P(F) \
717 ? &FRAME_DISPLAY_INFO(F)->mouse_highlight \
718 : &(F)->output_data.tty->display_info->mouse_highlight)
719 #else
720 # define MOUSE_HL_INFO(F) \
721 (&(F)->output_data.tty->display_info->mouse_highlight)
722 #endif
724 /* True if frame F is still alive (not deleted). */
725 #define FRAME_LIVE_P(f) ((f)->terminal != 0)
727 /* True if frame F is a minibuffer-only frame. */
728 #define FRAME_MINIBUF_ONLY_P(f) \
729 EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f))
731 /* True if frame F contains it's own minibuffer window. Frame always has
732 minibuffer window, but it could use minibuffer window of another frame. */
733 #define FRAME_HAS_MINIBUF_P(f) \
734 (WINDOWP (f->minibuffer_window) \
735 && XFRAME (XWINDOW (f->minibuffer_window)->frame) == f)
737 /* Pixel width of frame F. */
738 #define FRAME_PIXEL_WIDTH(f) ((f)->pixel_width)
740 /* Pixel height of frame F. */
741 #define FRAME_PIXEL_HEIGHT(f) ((f)->pixel_height)
743 /* Width of frame F, measured in canonical character columns,
744 not including scroll bars if any. */
745 #define FRAME_COLS(f) (f)->text_cols
747 /* Height of frame F, measured in canonical lines, including
748 non-toolkit menu bar and non-toolkit tool bar lines. */
749 #define FRAME_LINES(f) (f)->text_lines
751 /* Width of frame F, measured in pixels not including the width for
752 fringes, scroll bar, and internal borders. */
753 #define FRAME_TEXT_WIDTH(f) (f)->text_width
755 /* Height of frame F, measured in pixels not including the height
756 for scroll bar and internal borders. */
757 #define FRAME_TEXT_HEIGHT(f) (f)->text_height
759 /* Number of lines of frame F used for menu bar.
760 This is relevant on terminal frames and on
761 X Windows when not using the X toolkit.
762 These lines are counted in FRAME_LINES. */
763 #define FRAME_MENU_BAR_LINES(f) (f)->menu_bar_lines
765 /* Pixel height of frame F's menu bar. */
766 #define FRAME_MENU_BAR_HEIGHT(f) (f)->menu_bar_height
768 /* True if this frame should display a tool bar
769 in a way that does not use any text lines. */
770 #if defined (USE_GTK) || defined (HAVE_NS)
771 #define FRAME_EXTERNAL_TOOL_BAR(f) (f)->external_tool_bar
772 #else
773 #define FRAME_EXTERNAL_TOOL_BAR(f) false
774 #endif
776 /* This is really supported only with GTK. */
777 #ifdef USE_GTK
778 #define FRAME_TOOL_BAR_POSITION(f) (f)->tool_bar_position
779 #else
780 #define FRAME_TOOL_BAR_POSITION(f) ((void) f, Qtop)
781 #endif
783 /* Number of lines of frame F used for the tool-bar. */
784 #define FRAME_TOOL_BAR_LINES(f) (f)->tool_bar_lines
786 /* Pixel height of frame F's tool-bar. */
787 #define FRAME_TOOL_BAR_HEIGHT(f) (f)->tool_bar_height
789 /* Lines above the top-most window in frame F. */
790 #define FRAME_TOP_MARGIN(F) \
791 (FRAME_MENU_BAR_LINES (F) + FRAME_TOOL_BAR_LINES (F))
793 /* Pixel height of frame F's top margin. */
794 #define FRAME_TOP_MARGIN_HEIGHT(F) \
795 (FRAME_MENU_BAR_HEIGHT (F) + FRAME_TOOL_BAR_HEIGHT (F))
797 /* True if this frame should display a menu bar
798 in a way that does not use any text lines. */
799 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
800 || defined (HAVE_NS) || defined (USE_GTK)
801 #define FRAME_EXTERNAL_MENU_BAR(f) (f)->external_menu_bar
802 #else
803 #define FRAME_EXTERNAL_MENU_BAR(f) false
804 #endif
806 /* True if frame F is currently visible. */
807 #define FRAME_VISIBLE_P(f) (f)->visible
809 /* True if frame F is currently visible but hidden. */
810 #define FRAME_OBSCURED_P(f) ((f)->visible > 1)
812 /* True if frame F is currently iconified. */
813 #define FRAME_ICONIFIED_P(f) (f)->iconified
815 /* Mark frame F as currently garbaged. */
816 #define SET_FRAME_GARBAGED(f) \
817 (frame_garbaged = true, fset_redisplay (f), f->garbaged = true)
819 /* True if frame F is currently garbaged. */
820 #define FRAME_GARBAGED_P(f) (f)->garbaged
822 /* True means do not allow splitting this frame's window. */
823 #define FRAME_NO_SPLIT_P(f) (f)->no_split
825 /* Not really implemented. */
826 #define FRAME_WANTS_MODELINE_P(f) (f)->wants_modeline
828 /* True if all windows except selected window and mini window
829 are frozen on frame F. */
830 #define FRAME_WINDOWS_FROZEN(f) (f)->frozen_window_starts
832 /* True if the frame's window configuration has changed since last call
833 of run_window_size_change_functions. */
834 #define FRAME_WINDOW_CONFIGURATION_CHANGED(f) \
835 (f)->window_configuration_changed
837 /* The minibuffer window of frame F, if it has one; otherwise nil. */
838 #define FRAME_MINIBUF_WINDOW(f) f->minibuffer_window
840 /* The root window of the window tree of frame F. */
841 #define FRAME_ROOT_WINDOW(f) f->root_window
843 /* The currently selected window of the window tree of frame F. */
844 #define FRAME_SELECTED_WINDOW(f) f->selected_window
846 #define FRAME_INSERT_COST(f) (f)->insert_line_cost
847 #define FRAME_DELETE_COST(f) (f)->delete_line_cost
848 #define FRAME_INSERTN_COST(f) (f)->insert_n_lines_cost
849 #define FRAME_DELETEN_COST(f) (f)->delete_n_lines_cost
850 #define FRAME_FOCUS_FRAME(f) f->focus_frame
852 #ifdef HAVE_WINDOW_SYSTEM
854 /* This frame slot says whether scroll bars are currently enabled for frame F,
855 and which side they are on. */
856 #define FRAME_VERTICAL_SCROLL_BAR_TYPE(f) ((f)->vertical_scroll_bar_type)
857 #define FRAME_HAS_VERTICAL_SCROLL_BARS(f) \
858 ((f)->vertical_scroll_bar_type != vertical_scroll_bar_none)
859 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT(f) \
860 ((f)->vertical_scroll_bar_type == vertical_scroll_bar_left)
861 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT(f) \
862 ((f)->vertical_scroll_bar_type == vertical_scroll_bar_right)
864 #else /* not HAVE_WINDOW_SYSTEM */
866 /* If there is no window system, there are no scroll bars. */
867 #define FRAME_VERTICAL_SCROLL_BAR_TYPE(f) ((void) f, vertical_scroll_bar_none)
868 #define FRAME_HAS_VERTICAL_SCROLL_BARS(f) ((void) f, 0)
869 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT(f) ((void) f, 0)
870 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT(f) ((void) f, 0)
872 #endif /* HAVE_WINDOW_SYSTEM */
874 /* Whether horizontal scroll bars are currently enabled for frame F. */
875 #if USE_HORIZONTAL_SCROLL_BARS
876 #define FRAME_HAS_HORIZONTAL_SCROLL_BARS(f) \
877 ((f)->horizontal_scroll_bars)
878 #else
879 #define FRAME_HAS_HORIZONTAL_SCROLL_BARS(f) ((void) f, 0)
880 #endif
882 /* Width that a scroll bar in frame F should have, if there is one.
883 Measured in pixels.
884 If scroll bars are turned off, this is still nonzero. */
885 #define FRAME_CONFIG_SCROLL_BAR_WIDTH(f) ((f)->config_scroll_bar_width)
887 /* Height that a scroll bar in frame F should have, if there is one.
888 Measured in pixels.
889 If scroll bars are turned off, this is still nonzero. */
890 #define FRAME_CONFIG_SCROLL_BAR_HEIGHT(f) ((f)->config_scroll_bar_height)
892 /* Width that a scroll bar in frame F should have, if there is one.
893 Measured in columns (characters).
894 If scroll bars are turned off, this is still nonzero. */
895 #define FRAME_CONFIG_SCROLL_BAR_COLS(f) ((f)->config_scroll_bar_cols)
897 /* Height that a scroll bar in frame F should have, if there is one.
898 Measured in lines (characters).
899 If scroll bars are turned off, this is still nonzero. */
900 #define FRAME_CONFIG_SCROLL_BAR_LINES(f) ((f)->config_scroll_bar_lines)
902 /* Width of a left scroll bar in frame F, measured in pixels */
903 #define FRAME_LEFT_SCROLL_BAR_AREA_WIDTH(f) \
904 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \
905 ? FRAME_CONFIG_SCROLL_BAR_WIDTH (f) \
906 : 0)
908 /* Width of a right scroll bar area in frame F, measured in pixels */
909 #define FRAME_RIGHT_SCROLL_BAR_AREA_WIDTH(f) \
910 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f) \
911 ? FRAME_CONFIG_SCROLL_BAR_WIDTH (f) \
912 : 0)
914 /* Width of a left scroll bar in frame F, measured in columns
915 (characters), but only if scroll bars are on the left. If scroll
916 bars are on the right in this frame, or there are no scroll bars,
917 value is 0. */
918 #define FRAME_LEFT_SCROLL_BAR_COLS(f) \
919 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \
920 ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
921 : 0)
923 /* Width of a right scroll bar in frame F, measured in columns
924 (characters), but only if scroll bars are on the right. If scroll
925 bars are on the left in this frame, or there are no scroll bars,
926 value is 0. */
927 #define FRAME_RIGHT_SCROLL_BAR_COLS(f) \
928 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f) \
929 ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
930 : 0)
932 /* Width of a vertical scroll bar area in frame F, measured in
933 pixels. */
934 #define FRAME_SCROLL_BAR_AREA_WIDTH(f) \
935 (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \
936 ? FRAME_CONFIG_SCROLL_BAR_WIDTH (f) \
937 : 0)
939 /* Height of horizontal scroll bar area in frame F, measured in
940 pixels. */
941 #define FRAME_SCROLL_BAR_AREA_HEIGHT(f) \
942 (FRAME_HAS_HORIZONTAL_SCROLL_BARS (f) \
943 ? FRAME_CONFIG_SCROLL_BAR_HEIGHT (f) \
944 : 0)
946 /* Width of vertical scroll bar in frame F, measured in columns. */
947 #define FRAME_SCROLL_BAR_COLS(f) \
948 (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \
949 ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
950 : 0)
952 /* Height of horizontal scroll bar in frame F, measured in lines. */
953 #define FRAME_SCROLL_BAR_LINES(f) \
954 (FRAME_HAS_HORIZONTAL_SCROLL_BARS (f) \
955 ? FRAME_CONFIG_SCROLL_BAR_LINES (f) \
956 : 0)
958 /* Total width of frame F, in columns (characters),
959 including the width used by scroll bars if any. */
960 #define FRAME_TOTAL_COLS(f) ((f)->total_cols)
962 /* Total height of frame F, in lines (characters),
963 including the height used by scroll bars if any. */
964 #define FRAME_TOTAL_LINES(f) ((f)->total_lines)
966 /* Set the character widths of frame F. WIDTH specifies a nominal
967 character text width. */
968 #define SET_FRAME_COLS(f, width) \
969 ((f)->text_cols = (width), \
970 (f)->total_cols = ((width) \
971 + FRAME_SCROLL_BAR_COLS (f) \
972 + FRAME_FRINGE_COLS (f)))
974 /* Set the character heights of frame F. HEIGHT specifies a nominal
975 character text height. */
976 #define SET_FRAME_LINES(f, height) \
977 ((f)->text_lines = (height), \
978 (f)->total_lines = ((height) \
979 + FRAME_TOP_MARGIN (f) \
980 + FRAME_SCROLL_BAR_LINES (f)))
982 /* Set the widths of frame F. WIDTH specifies a nominal pixel text
983 width. */
984 #define SET_FRAME_WIDTH(f, width) \
985 ((f)->text_width = (width), \
986 (f)->pixel_width = ((width) \
987 + FRAME_SCROLL_BAR_AREA_WIDTH (f) \
988 + FRAME_TOTAL_FRINGE_WIDTH (f) \
989 + 2 * FRAME_INTERNAL_BORDER_WIDTH (f)))
991 /* Set the heights of frame F. HEIGHT specifies a nominal pixel text
992 height. */
993 #define SET_FRAME_HEIGHT(f, height) \
994 ((f)->text_height = (height), \
995 (f)->pixel_height = ((height) \
996 + FRAME_TOP_MARGIN_HEIGHT (f) \
997 + FRAME_SCROLL_BAR_AREA_HEIGHT (f) \
998 + 2 * FRAME_INTERNAL_BORDER_WIDTH (f)))
1000 /* Maximum + 1 legitimate value for FRAME_CURSOR_X. */
1001 #define FRAME_CURSOR_X_LIMIT(f) \
1002 (FRAME_COLS (f) + FRAME_LEFT_SCROLL_BAR_COLS (f))
1004 /* Nonzero if frame F has scroll bars. */
1005 #define FRAME_SCROLL_BARS(f) (f->scroll_bars)
1006 #define FRAME_CONDEMNED_SCROLL_BARS(f) (f->condemned_scroll_bars)
1008 #define FRAME_MENU_BAR_ITEMS(f) (f->menu_bar_items)
1009 #define FRAME_COST_BAUD_RATE(f) ((f)->cost_calculation_baud_rate)
1011 #define FRAME_DESIRED_CURSOR(f) ((f)->desired_cursor)
1012 #define FRAME_BLINK_OFF_CURSOR(f) ((f)->blink_off_cursor)
1013 #define FRAME_CURSOR_WIDTH(f) ((f)->cursor_width)
1014 #define FRAME_BLINK_OFF_CURSOR_WIDTH(f) ((f)->blink_off_cursor_width)
1016 #define FRAME_FOREGROUND_PIXEL(f) ((f)->foreground_pixel)
1017 #define FRAME_BACKGROUND_PIXEL(f) ((f)->background_pixel)
1019 /* Return a pointer to the face cache of frame F. */
1021 #define FRAME_FACE_CACHE(F) (F)->face_cache
1023 /* Return the size of message_buf of the frame F. We multiply the
1024 width of the frame by 4 because multi-byte form may require at most
1025 4-byte for a character. */
1027 #define FRAME_MESSAGE_BUF_SIZE(f) (((int) FRAME_COLS (f)) * 4)
1029 #define CHECK_FRAME(x) \
1030 CHECK_TYPE (FRAMEP (x), Qframep, x)
1032 #define CHECK_LIVE_FRAME(x) \
1033 CHECK_TYPE (FRAMEP (x) && FRAME_LIVE_P (XFRAME (x)), Qframe_live_p, x)
1035 /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
1036 `for' loop which iterates over the elements of Vframe_list. The
1037 loop will set FRAME_VAR, a Lisp_Object, to each frame in
1038 Vframe_list in succession and execute the statement. LIST_VAR
1039 should be a Lisp_Object too; it is used to iterate through the
1040 Vframe_list.
1042 This macro is a holdover from a time when multiple frames weren't always
1043 supported. An alternate definition of the macro would expand to
1044 something which executes the statement once. */
1046 #define FOR_EACH_FRAME(list_var, frame_var) \
1047 for ((list_var) = Vframe_list; \
1048 (CONSP (list_var) \
1049 && (frame_var = XCAR (list_var), true)); \
1050 list_var = XCDR (list_var))
1052 /* Reflect mouse movement when a complete frame update is performed. */
1054 #define FRAME_MOUSE_UPDATE(frame) \
1055 do { \
1056 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (frame); \
1057 if (frame == hlinfo->mouse_face_mouse_frame) \
1059 block_input (); \
1060 note_mouse_highlight (hlinfo->mouse_face_mouse_frame, \
1061 hlinfo->mouse_face_mouse_x, \
1062 hlinfo->mouse_face_mouse_y); \
1063 unblock_input (); \
1065 } while (false)
1067 /* Handy macro to construct an argument to Fmodify_frame_parameters. */
1069 #define AUTO_FRAME_ARG(name, parameter, value) \
1070 AUTO_LIST1 (name, AUTO_CONS_EXPR (parameter, value))
1072 /* False means there are no visible garbaged frames. */
1073 extern bool frame_garbaged;
1075 /* Set visibility of frame F.
1076 We call redisplay_other_windows to make sure the frame gets redisplayed
1077 if some changes were applied to it while it wasn't visible (and hence
1078 wasn't redisplayed). */
1080 INLINE void
1081 SET_FRAME_VISIBLE (struct frame *f, int v)
1083 eassert (0 <= v && v <= 2);
1084 if (v)
1086 if (v == 1 && f->visible != 1)
1087 redisplay_other_windows ();
1088 if (FRAME_GARBAGED_P (f))
1089 frame_garbaged = true;
1091 f->visible = v;
1094 /* Set iconify of frame F. */
1096 #define SET_FRAME_ICONIFIED(f, i) \
1097 (f)->iconified = (eassert (0 <= (i) && (i) <= 1), (i))
1099 extern Lisp_Object selected_frame;
1101 #if ! (defined USE_GTK || defined HAVE_NS)
1102 extern int frame_default_tool_bar_height;
1103 #endif
1105 extern struct frame *decode_window_system_frame (Lisp_Object);
1106 extern struct frame *decode_live_frame (Lisp_Object);
1107 extern struct frame *decode_any_frame (Lisp_Object);
1108 extern struct frame *make_initial_frame (void);
1109 extern struct frame *make_frame (bool);
1110 #ifdef HAVE_WINDOW_SYSTEM
1111 extern struct frame *make_minibuffer_frame (void);
1112 extern struct frame *make_frame_without_minibuffer (Lisp_Object,
1113 struct kboard *,
1114 Lisp_Object);
1115 extern bool window_system_available (struct frame *);
1116 #else /* not HAVE_WINDOW_SYSTEM */
1117 #define window_system_available(f) ((void) (f), false)
1118 #endif /* HAVE_WINDOW_SYSTEM */
1119 extern void check_window_system (struct frame *);
1120 extern void frame_make_pointer_invisible (struct frame *);
1121 extern void frame_make_pointer_visible (struct frame *);
1122 extern Lisp_Object delete_frame (Lisp_Object, Lisp_Object);
1123 extern bool frame_inhibit_resize (struct frame *, bool, Lisp_Object);
1124 extern void adjust_frame_size (struct frame *, int, int, int, bool, Lisp_Object);
1125 extern void frame_size_history_add (struct frame *f, Lisp_Object fun_symbol,
1126 int width, int height, Lisp_Object rest);
1128 extern Lisp_Object Vframe_list;
1130 /* Value is a pointer to the selected frame. If the selected frame
1131 isn't live, abort. */
1133 #define SELECTED_FRAME() \
1134 ((FRAMEP (selected_frame) \
1135 && FRAME_LIVE_P (XFRAME (selected_frame))) \
1136 ? XFRAME (selected_frame) \
1137 : (emacs_abort (), (struct frame *) 0))
1140 /***********************************************************************
1141 Display-related Macros
1142 ***********************************************************************/
1144 /* Canonical y-unit on frame F.
1145 This value currently equals the line height of the frame (which is
1146 the height of the default font of F). */
1147 #define FRAME_LINE_HEIGHT(F) ((F)->line_height)
1149 /* Canonical x-unit on frame F.
1150 This value currently equals the average width of the default font of F. */
1151 #define FRAME_COLUMN_WIDTH(F) ((F)->column_width)
1153 /* Pixel width of areas used to display truncation marks, continuation
1154 marks, overlay arrows. This is 0 for terminal frames. */
1156 #ifdef HAVE_WINDOW_SYSTEM
1158 /* Total width of fringes reserved for drawing truncation bitmaps,
1159 continuation bitmaps and alike. The width is in canonical char
1160 units of the frame. This must currently be the case because window
1161 sizes aren't pixel values. If it weren't the case, we wouldn't be
1162 able to split windows horizontally nicely. */
1163 #define FRAME_FRINGE_COLS(F) ((F)->fringe_cols)
1165 /* Pixel-width of the left and right fringe. */
1167 #define FRAME_LEFT_FRINGE_WIDTH(F) ((F)->left_fringe_width)
1168 #define FRAME_RIGHT_FRINGE_WIDTH(F) ((F)->right_fringe_width)
1170 /* Total width of fringes in pixels. */
1172 #define FRAME_TOTAL_FRINGE_WIDTH(F) \
1173 (FRAME_LEFT_FRINGE_WIDTH (F) + FRAME_RIGHT_FRINGE_WIDTH (F))
1175 /* Pixel-width of internal border lines */
1176 #define FRAME_INTERNAL_BORDER_WIDTH(F) ((F)->internal_border_width)
1178 /* Pixel-size of window border lines */
1179 #define FRAME_RIGHT_DIVIDER_WIDTH(F) ((F)->right_divider_width)
1180 #define FRAME_BOTTOM_DIVIDER_WIDTH(F) ((F)->bottom_divider_width)
1182 #else /* not HAVE_WINDOW_SYSTEM */
1184 #define FRAME_FRINGE_COLS(F) 0
1185 #define FRAME_TOTAL_FRINGE_WIDTH(F) 0
1186 #define FRAME_LEFT_FRINGE_WIDTH(F) 0
1187 #define FRAME_RIGHT_FRINGE_WIDTH(F) 0
1188 #define FRAME_INTERNAL_BORDER_WIDTH(F) 0
1189 #define FRAME_RIGHT_DIVIDER_WIDTH(F) 0
1190 #define FRAME_BOTTOM_DIVIDER_WIDTH(F) 0
1192 #endif /* not HAVE_WINDOW_SYSTEM */
1194 /***********************************************************************
1195 Conversion between canonical units and pixels
1196 ***********************************************************************/
1198 /* Canonical x-values are fractions of FRAME_COLUMN_WIDTH, canonical
1199 y-unit are fractions of FRAME_LINE_HEIGHT of a frame. Both are
1200 represented as Lisp numbers, i.e. integers or floats. */
1202 /* Convert canonical value X to pixels. F is the frame whose
1203 canonical char width is to be used. X must be a Lisp integer or
1204 float. Value is a C integer. */
1205 #define FRAME_PIXEL_X_FROM_CANON_X(F, X) \
1206 (INTEGERP (X) \
1207 ? XINT (X) * FRAME_COLUMN_WIDTH (F) \
1208 : (int) (XFLOAT_DATA (X) * FRAME_COLUMN_WIDTH (F)))
1210 /* Convert canonical value Y to pixels. F is the frame whose
1211 canonical character height is to be used. X must be a Lisp integer
1212 or float. Value is a C integer. */
1213 #define FRAME_PIXEL_Y_FROM_CANON_Y(F, Y) \
1214 (INTEGERP (Y) \
1215 ? XINT (Y) * FRAME_LINE_HEIGHT (F) \
1216 : (int) (XFLOAT_DATA (Y) * FRAME_LINE_HEIGHT (F)))
1218 /* Convert pixel-value X to canonical units. F is the frame whose
1219 canonical character width is to be used. X is a C integer. Result
1220 is a Lisp float if X is not a multiple of the canon width,
1221 otherwise it's a Lisp integer. */
1222 #define FRAME_CANON_X_FROM_PIXEL_X(F, X) \
1223 ((X) % FRAME_COLUMN_WIDTH (F) != 0 \
1224 ? make_float ((double) (X) / FRAME_COLUMN_WIDTH (F)) \
1225 : make_number ((X) / FRAME_COLUMN_WIDTH (F)))
1227 /* Convert pixel-value Y to canonical units. F is the frame whose
1228 canonical character height is to be used. Y is a C integer.
1229 Result is a Lisp float if Y is not a multiple of the canon width,
1230 otherwise it's a Lisp integer. */
1231 #define FRAME_CANON_Y_FROM_PIXEL_Y(F, Y) \
1232 ((Y) % FRAME_LINE_HEIGHT (F) \
1233 ? make_float ((double) (Y) / FRAME_LINE_HEIGHT (F)) \
1234 : make_number ((Y) / FRAME_LINE_HEIGHT (F)))
1238 /* Manipulating pixel sizes and character sizes.
1239 Knowledge of which factors affect the overall size of the window should
1240 be hidden in these macros, if that's possible.
1242 Return the upper/left pixel position of the character cell on frame F
1243 at ROW/COL. */
1244 #define FRAME_LINE_TO_PIXEL_Y(f, row) \
1245 (((row) < FRAME_TOP_MARGIN (f) ? 0 : FRAME_INTERNAL_BORDER_WIDTH (f)) \
1246 + (row) * FRAME_LINE_HEIGHT (f))
1248 #define FRAME_COL_TO_PIXEL_X(f, col) \
1249 (FRAME_INTERNAL_BORDER_WIDTH (f) \
1250 + (col) * FRAME_COLUMN_WIDTH (f))
1252 /* Return the pixel width/height of frame F if it has
1253 COLS columns/LINES rows. */
1254 #define FRAME_TEXT_COLS_TO_PIXEL_WIDTH(f, cols) \
1255 ((cols) * FRAME_COLUMN_WIDTH (f) \
1256 + FRAME_SCROLL_BAR_AREA_WIDTH (f) \
1257 + FRAME_TOTAL_FRINGE_WIDTH (f) \
1258 + 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
1260 #define FRAME_TEXT_LINES_TO_PIXEL_HEIGHT(f, lines) \
1261 ((lines) * FRAME_LINE_HEIGHT (f) \
1262 + FRAME_TOP_MARGIN_HEIGHT (f) \
1263 + FRAME_SCROLL_BAR_AREA_HEIGHT (f) \
1264 + 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
1266 /* Return the row/column (zero-based) of the character cell containing
1267 the pixel on FRAME at Y/X. */
1268 #define FRAME_PIXEL_Y_TO_LINE(f, y) \
1269 (((y) < FRAME_TOP_MARGIN_HEIGHT (f) \
1270 ? (y) \
1271 : ((y) < (FRAME_TOP_MARGIN_HEIGHT (f) \
1272 + FRAME_INTERNAL_BORDER_WIDTH (f)) \
1273 ? (y) - (FRAME_TOP_MARGIN_HEIGHT (f) \
1274 + FRAME_INTERNAL_BORDER_WIDTH (f) \
1275 /* Arrange for the division to round down. */ \
1276 + FRAME_LINE_HEIGHT (f) - 1) \
1277 : (y) - FRAME_INTERNAL_BORDER_WIDTH (f))) \
1278 / FRAME_LINE_HEIGHT (f))
1280 #define FRAME_PIXEL_X_TO_COL(f, x) \
1281 (((x) - FRAME_INTERNAL_BORDER_WIDTH (f)) \
1282 / FRAME_COLUMN_WIDTH (f))
1284 /* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
1285 frame F (so we round down)? */
1286 #define FRAME_PIXEL_WIDTH_TO_TEXT_COLS(f, width) \
1287 (((width) \
1288 - FRAME_TOTAL_FRINGE_WIDTH (f) \
1289 - FRAME_SCROLL_BAR_AREA_WIDTH (f) \
1290 - 2 * FRAME_INTERNAL_BORDER_WIDTH (f)) \
1291 / FRAME_COLUMN_WIDTH (f)) \
1293 #define FRAME_PIXEL_HEIGHT_TO_TEXT_LINES(f, height) \
1294 (((height) \
1295 - FRAME_TOP_MARGIN_HEIGHT (f) \
1296 - FRAME_SCROLL_BAR_AREA_HEIGHT (f) \
1297 - 2 * FRAME_INTERNAL_BORDER_WIDTH (f)) \
1298 / FRAME_LINE_HEIGHT (f))
1300 /* Return the pixel width/height of frame F with a text size of
1301 width/height. */
1302 #define FRAME_TEXT_TO_PIXEL_WIDTH(f, width) \
1303 ((width) \
1304 + FRAME_SCROLL_BAR_AREA_WIDTH (f) \
1305 + FRAME_TOTAL_FRINGE_WIDTH (f) \
1306 + 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
1308 #define FRAME_TEXT_TO_PIXEL_HEIGHT(f, height) \
1309 ((height) \
1310 + FRAME_TOP_MARGIN_HEIGHT (f) \
1311 + FRAME_SCROLL_BAR_AREA_HEIGHT (f) \
1312 + 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
1314 /* Return the text width/height of frame F with a pixel size of
1315 width/height. */
1316 #define FRAME_PIXEL_TO_TEXT_WIDTH(f, width) \
1317 ((width) \
1318 - FRAME_SCROLL_BAR_AREA_WIDTH (f) \
1319 - FRAME_TOTAL_FRINGE_WIDTH (f) \
1320 - 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
1322 #define FRAME_PIXEL_TO_TEXT_HEIGHT(f, height) \
1323 ((height) \
1324 - FRAME_TOP_MARGIN_HEIGHT (f) \
1325 - FRAME_SCROLL_BAR_AREA_HEIGHT (f) \
1326 - 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
1328 /* Return the width/height reserved for the windows of frame F. */
1329 #define FRAME_WINDOWS_WIDTH(f) \
1330 (FRAME_PIXEL_WIDTH (f) \
1331 - 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
1333 #define FRAME_WINDOWS_HEIGHT(f) \
1334 (FRAME_PIXEL_HEIGHT (f) \
1335 - FRAME_TOP_MARGIN_HEIGHT (f) \
1336 - 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
1338 /* Value is the smallest width of any character in any font on frame F. */
1339 #define FRAME_SMALLEST_CHAR_WIDTH(f) \
1340 FRAME_DISPLAY_INFO (f)->smallest_char_width
1342 /* Value is the smallest height of any font on frame F. */
1343 #define FRAME_SMALLEST_FONT_HEIGHT(f) \
1344 FRAME_DISPLAY_INFO (f)->smallest_font_height
1346 /***********************************************************************
1347 Frame Parameters
1348 ***********************************************************************/
1350 #ifdef HAVE_WINDOW_SYSTEM
1352 /* The class of this X application. */
1353 #define EMACS_CLASS "Emacs"
1355 extern void x_set_scroll_bar_default_width (struct frame *);
1356 extern void x_set_scroll_bar_default_height (struct frame *);
1357 extern void x_set_offset (struct frame *, int, int, int);
1358 extern void x_wm_set_size_hint (struct frame *f, long flags, bool user_position);
1359 extern Lisp_Object x_new_font (struct frame *, Lisp_Object, int);
1360 extern void x_set_frame_parameters (struct frame *, Lisp_Object);
1361 extern void x_set_fullscreen (struct frame *, Lisp_Object, Lisp_Object);
1362 extern void x_set_line_spacing (struct frame *, Lisp_Object, Lisp_Object);
1363 extern void x_set_screen_gamma (struct frame *, Lisp_Object, Lisp_Object);
1364 extern void x_set_font (struct frame *, Lisp_Object, Lisp_Object);
1365 extern void x_set_font_backend (struct frame *, Lisp_Object, Lisp_Object);
1366 extern void x_set_left_fringe (struct frame *, Lisp_Object, Lisp_Object);
1367 extern void x_set_right_fringe (struct frame *, Lisp_Object, Lisp_Object);
1368 extern void x_set_border_width (struct frame *, Lisp_Object, Lisp_Object);
1369 extern void x_set_right_divider_width (struct frame *, Lisp_Object,
1370 Lisp_Object);
1371 extern void x_set_bottom_divider_width (struct frame *, Lisp_Object,
1372 Lisp_Object);
1373 extern void x_set_visibility (struct frame *, Lisp_Object, Lisp_Object);
1374 extern void x_set_autoraise (struct frame *, Lisp_Object, Lisp_Object);
1375 extern void x_set_autolower (struct frame *, Lisp_Object, Lisp_Object);
1376 extern void x_set_unsplittable (struct frame *, Lisp_Object, Lisp_Object);
1377 extern void x_set_vertical_scroll_bars (struct frame *, Lisp_Object, Lisp_Object);
1378 extern void x_set_horizontal_scroll_bars (struct frame *, Lisp_Object, Lisp_Object);
1379 extern void x_set_scroll_bar_width (struct frame *, Lisp_Object, Lisp_Object);
1380 extern void x_set_scroll_bar_height (struct frame *, Lisp_Object, Lisp_Object);
1382 extern long x_figure_window_size (struct frame *, Lisp_Object, bool, int *, int *);
1384 extern void x_set_alpha (struct frame *, Lisp_Object, Lisp_Object);
1386 extern void validate_x_resource_name (void);
1388 extern Lisp_Object display_x_get_resource (Display_Info *,
1389 Lisp_Object attribute,
1390 Lisp_Object class,
1391 Lisp_Object component,
1392 Lisp_Object subclass);
1394 extern void set_frame_menubar (struct frame *f, bool first_time, bool deep_p);
1395 extern void x_set_window_size (struct frame *f, bool change_gravity,
1396 int width, int height, bool pixelwise);
1397 extern Lisp_Object x_get_focus_frame (struct frame *);
1398 extern void frame_set_mouse_pixel_position (struct frame *f, int pix_x, int pix_y);
1399 extern void x_make_frame_visible (struct frame *f);
1400 extern void x_make_frame_invisible (struct frame *f);
1401 extern void x_iconify_frame (struct frame *f);
1402 extern void x_set_frame_alpha (struct frame *f);
1403 extern void x_activate_menubar (struct frame *);
1404 extern void x_real_positions (struct frame *, int *, int *);
1405 extern void free_frame_menubar (struct frame *);
1406 extern void x_free_frame_resources (struct frame *);
1408 #if defined HAVE_X_WINDOWS
1409 extern void x_wm_set_icon_position (struct frame *, int, int);
1410 #if !defined USE_X_TOOLKIT
1411 extern char *x_get_resource_string (const char *, const char *);
1412 #endif
1413 extern void x_sync (struct frame *);
1414 #endif /* HAVE_X_WINDOWS */
1416 extern void x_query_colors (struct frame *f, XColor *, int);
1417 extern void x_focus_frame (struct frame *);
1419 #ifndef HAVE_NS
1421 extern bool x_bitmap_icon (struct frame *, Lisp_Object);
1423 /* Set F's bitmap icon, if specified among F's parameters. */
1425 INLINE void
1426 x_set_bitmap_icon (struct frame *f)
1428 Lisp_Object obj = assq_no_quit (Qicon_type, f->param_alist);
1430 if (CONSP (obj) && !NILP (XCDR (obj)))
1431 x_bitmap_icon (f, XCDR (obj));
1434 #endif /* !HAVE_NS */
1435 #endif /* HAVE_WINDOW_SYSTEM */
1437 INLINE void
1438 flush_frame (struct frame *f)
1440 struct redisplay_interface *rif = FRAME_RIF (f);
1442 if (rif && rif->flush_display)
1443 rif->flush_display (f);
1446 /***********************************************************************
1447 Multimonitor data
1448 ***********************************************************************/
1450 #ifdef HAVE_WINDOW_SYSTEM
1452 struct MonitorInfo {
1453 XRectangle geom, work;
1454 int mm_width, mm_height;
1455 char *name;
1458 extern void free_monitors (struct MonitorInfo *monitors, int n_monitors);
1459 extern Lisp_Object make_monitor_attribute_list (struct MonitorInfo *monitors,
1460 int n_monitors,
1461 int primary_monitor,
1462 Lisp_Object monitor_frames,
1463 const char *source);
1465 #endif /* HAVE_WINDOW_SYSTEM */
1468 INLINE_HEADER_END
1470 /* Suppress -Wsuggest-attribute=const if there are no scroll bars.
1471 This is for functions like x_set_horizontal_scroll_bars that have
1472 no effect in this case. */
1473 #if ! USE_HORIZONTAL_SCROLL_BARS && 4 < __GNUC__ + (6 <= __GNUC_MINOR__)
1474 # pragma GCC diagnostic ignored "-Wsuggest-attribute=const"
1475 #endif
1477 #endif /* not EMACS_FRAME_H */