Allow comma separated lists after Java "implements".
[emacs.git] / src / frame.h
blob8dfcaae114b8537d5e6ba116eaf3017b918600d2
1 /* Define frame-object for GNU Emacs.
2 Copyright (C) 1993-1994, 1999-2013 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"
29 INLINE_HEADER_BEGIN
31 enum vertical_scroll_bar_type
33 vertical_scroll_bar_none,
34 vertical_scroll_bar_left,
35 vertical_scroll_bar_right
38 enum fullscreen_type
40 FULLSCREEN_NONE,
41 FULLSCREEN_WIDTH = 0x001,
42 FULLSCREEN_HEIGHT = 0x002,
43 FULLSCREEN_BOTH = 0x003,
44 FULLSCREEN_MAXIMIZED = 0x013,
45 FULLSCREEN_WAIT = 0x100
48 /* The structure representing a frame. */
50 struct frame
52 struct vectorlike_header header;
54 /* All Lisp_Object components must come first.
55 That ensures they are all aligned normally. */
57 /* Name of this frame: a Lisp string. It is used for looking up resources,
58 as well as for the title in some cases. */
59 Lisp_Object name;
61 /* The name to use for the icon, the last time
62 it was refreshed. nil means not explicitly specified. */
63 Lisp_Object icon_name;
65 /* This is the frame title specified explicitly, if any.
66 Usually it is nil. */
67 Lisp_Object title;
69 /* The frame which should receive keystrokes that occur in this
70 frame, or nil if they should go to the frame itself. This is
71 usually nil, but if the frame is minibufferless, we can use this
72 to redirect keystrokes to a surrogate minibuffer frame when
73 needed.
75 Note that a value of nil is different than having the field point
76 to the frame itself. Whenever the Fselect_frame function is used
77 to shift from one frame to the other, any redirections to the
78 original frame are shifted to the newly selected frame; if
79 focus_frame is nil, Fselect_frame will leave it alone. */
80 Lisp_Object focus_frame;
82 /* This frame's root window. Every frame has one.
83 If the frame has only a minibuffer window, this is it.
84 Otherwise, if the frame has a minibuffer window, this is its sibling. */
85 Lisp_Object root_window;
87 /* This frame's selected window.
88 Each frame has its own window hierarchy
89 and one of the windows in it is selected within the frame.
90 The selected window of the selected frame is Emacs's selected window. */
91 Lisp_Object selected_window;
93 /* This frame's minibuffer window.
94 Most frames have their own minibuffer windows,
95 but only the selected frame's minibuffer window
96 can actually appear to exist. */
97 Lisp_Object minibuffer_window;
99 /* Parameter alist of this frame.
100 These are the parameters specified when creating the frame
101 or modified with modify-frame-parameters. */
102 Lisp_Object param_alist;
104 /* List of scroll bars on this frame.
105 Actually, we don't specify exactly what is stored here at all; the
106 scroll bar implementation code can use it to store anything it likes.
107 This field is marked by the garbage collector. It is here
108 instead of in the `device' structure so that the garbage
109 collector doesn't need to look inside the window-system-dependent
110 structure. */
111 Lisp_Object scroll_bars;
112 Lisp_Object condemned_scroll_bars;
114 /* Vector describing the items to display in the menu bar.
115 Each item has four elements in this vector.
116 They are KEY, STRING, SUBMAP, and HPOS.
117 (HPOS is not used in when the X toolkit is in use.)
118 There are four additional elements of nil at the end, to terminate. */
119 Lisp_Object menu_bar_items;
121 /* Alist of elements (FACE-NAME . FACE-VECTOR-DATA). */
122 Lisp_Object face_alist;
124 /* A vector that records the entire structure of this frame's menu bar.
125 For the format of the data, see extensive comments in xmenu.c.
126 Only the X toolkit version uses this. */
127 Lisp_Object menu_bar_vector;
129 /* Predicate for selecting buffers for other-buffer. */
130 Lisp_Object buffer_predicate;
132 /* List of buffers viewed in this frame, for other-buffer. */
133 Lisp_Object buffer_list;
135 /* List of buffers that were viewed, then buried in this frame. The
136 most recently buried buffer is first. For last-buffer. */
137 Lisp_Object buried_buffer_list;
139 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
140 /* A dummy window used to display menu bars under X when no X
141 toolkit support is available. */
142 Lisp_Object menu_bar_window;
143 #endif
145 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
146 /* A window used to display the tool-bar of a frame. */
147 Lisp_Object tool_bar_window;
149 /* Desired and current contents displayed in that window. */
150 Lisp_Object desired_tool_bar_string;
151 Lisp_Object current_tool_bar_string;
152 #endif
154 /* Desired and current tool-bar items. */
155 Lisp_Object tool_bar_items;
157 /* Where tool bar is, can be left, right, top or bottom. The native
158 tool bar only supports top. */
159 Lisp_Object tool_bar_position;
161 /* Beyond here, there should be no more Lisp_Object components. */
163 /* Cache of realized faces. */
164 struct face_cache *face_cache;
166 /* Number of elements in `menu_bar_vector' that have meaningful data. */
167 int menu_bar_items_used;
169 /* A buffer to hold the frame's name. We can't use the Lisp
170 string's pointer (`name', above) because it might get relocated. */
171 char *namebuf;
173 /* Glyph pool and matrix. */
174 struct glyph_pool *current_pool;
175 struct glyph_pool *desired_pool;
176 struct glyph_matrix *desired_matrix;
177 struct glyph_matrix *current_matrix;
179 /* 1 means that glyphs on this frame have been initialized so it can
180 be used for output. */
181 unsigned glyphs_initialized_p : 1;
183 /* Set to non-zero in change_frame_size when size of frame changed
184 Clear the frame in clear_garbaged_frames if set. */
185 unsigned resized_p : 1;
187 /* Set to non-zero if the default face for the frame has been
188 realized. Reset to zero whenever the default face changes.
189 Used to see the difference between a font change and face change. */
190 unsigned default_face_done_p : 1;
192 /* Set to non-zero if this frame has already been hscrolled during
193 current redisplay. */
194 unsigned already_hscrolled_p : 1;
196 /* Set to non-zero when current redisplay has updated frame. */
197 unsigned updated_p : 1;
199 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
200 /* Set to non-zero to minimize tool-bar height even when
201 auto-resize-tool-bar is set to grow-only. */
202 unsigned minimize_tool_bar_window_p : 1;
203 #endif
205 #if defined (USE_GTK) || defined (HAVE_NS)
206 /* Nonzero means using a tool bar that comes from the toolkit. */
207 unsigned external_tool_bar : 1;
208 #endif
210 /* Nonzero means that fonts have been loaded since the last glyph
211 matrix adjustments. */
212 unsigned fonts_changed : 1;
214 /* Nonzero means that cursor type has been changed. */
215 unsigned cursor_type_changed : 1;
217 /* Margin at the top of the frame. Used to display the tool-bar. */
218 int tool_bar_lines;
220 int n_tool_bar_rows;
221 int n_tool_bar_items;
223 /* A buffer for decode_mode_line. */
224 char *decode_mode_spec_buffer;
226 /* See do_line_insertion_deletion_costs for info on these arrays. */
227 /* Cost of inserting 1 line on this frame */
228 int *insert_line_cost;
229 /* Cost of deleting 1 line on this frame */
230 int *delete_line_cost;
231 /* Cost of inserting n lines on this frame */
232 int *insert_n_lines_cost;
233 /* Cost of deleting n lines on this frame */
234 int *delete_n_lines_cost;
236 /* Size of this frame, excluding fringes, scroll bars etc.,
237 in units of canonical characters. */
238 int text_lines, text_cols;
240 /* Total size of this frame (i.e. its native window), in units of
241 canonical characters. */
242 int total_lines, total_cols;
244 /* New text height and width for pending size change.
245 0 if no change pending. */
246 int new_text_lines, new_text_cols;
248 /* Pixel position of the frame window (x and y offsets in root window). */
249 int left_pos, top_pos;
251 /* Size of the frame window in pixels. */
252 int pixel_height, pixel_width;
254 /* These many pixels are the difference between the outer window (i.e. the
255 left and top of the window manager decoration) and FRAME_X_WINDOW. */
256 int x_pixels_diff, y_pixels_diff;
258 /* This is the gravity value for the specified window position. */
259 int win_gravity;
261 /* The geometry flags for this window. */
262 int size_hint_flags;
264 /* Border width of the frame window as known by the (X) window system. */
265 int border_width;
267 /* Width of the internal border. This is a line of background color
268 just inside the window's border. When the frame is selected,
269 a highlighting is displayed inside the internal border. */
270 int internal_border_width;
272 /* Canonical X unit. Width of default font, in pixels. */
273 int column_width;
275 /* Canonical Y unit. Height of a line, in pixels. */
276 int line_height;
278 /* The output method says how the contents of this frame are
279 displayed. It could be using termcap, or using an X window.
280 This must be the same as the terminal->type. */
281 enum output_method output_method;
283 /* The terminal device that this frame uses. If this is NULL, then
284 the frame has been deleted. */
285 struct terminal *terminal;
287 /* Device-dependent, frame-local auxiliary data used for displaying
288 the contents. When the frame is deleted, this data is deleted as
289 well. */
290 union output_data
292 struct tty_output *tty; /* termchar.h */
293 struct x_output *x; /* xterm.h */
294 struct w32_output *w32; /* w32term.h */
295 struct ns_output *ns; /* nsterm.h */
296 intptr_t nothing;
298 output_data;
300 /* List of font-drivers available on the frame. */
301 struct font_driver_list *font_driver_list;
302 /* List of data specific to font-driver and frame, but common to
303 faces. */
304 struct font_data_list *font_data_list;
306 /* Total width of fringes reserved for drawing truncation bitmaps,
307 continuation bitmaps and alike. The width is in canonical char
308 units of the frame. This must currently be the case because window
309 sizes aren't pixel values. If it weren't the case, we wouldn't be
310 able to split windows horizontally nicely. */
311 int fringe_cols;
313 /* The extra width (in pixels) currently allotted for fringes. */
314 int left_fringe_width, right_fringe_width;
316 /* See FULLSCREEN_ enum below */
317 enum fullscreen_type want_fullscreen;
319 /* Number of lines of menu bar. */
320 int menu_bar_lines;
322 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
323 || defined (HAVE_NS) || defined (USE_GTK)
324 /* Nonzero means using a menu bar that comes from the X toolkit. */
325 unsigned int external_menu_bar : 1;
326 #endif
328 #if defined (HAVE_X_WINDOWS)
329 /* Used by x_wait_for_event when watching for an X event on this frame. */
330 int wait_event_type;
331 #endif
333 /* Next two bitfields are mutually exclusive. They might both be
334 zero if the frame has been made invisible without an icon. */
336 /* Nonzero if the frame is currently displayed; we check
337 it to see if we should bother updating the frame's contents.
339 Note that, since invisible frames aren't updated, whenever a
340 frame becomes visible again, it must be marked as garbaged.
342 On ttys and on Windows NT/9X, to avoid wasting effort updating
343 visible frames that are actually completely obscured by other
344 windows on the display, we bend the meaning of visible slightly:
345 if equal to 2, then the frame is obscured - we still consider
346 it to be "visible" as seen from lisp, but we don't bother
347 updating it. We must take care to garbage the frame when it
348 ceases to be obscured though. See SET_FRAME_VISIBLE below. */
349 unsigned visible : 2;
351 /* Nonzero if the frame is currently iconified. Do not
352 set this directly, use SET_FRAME_ICONIFIED instead. */
353 unsigned iconified : 1;
355 /* Nonzero if this frame should be redrawn. */
356 unsigned garbaged : 1;
358 /* 0 means, if this frame has just one window,
359 show no modeline for that window. */
360 unsigned wants_modeline : 1;
362 /* Non-0 means raise this frame to the top of the heap when selected. */
363 unsigned auto_raise : 1;
365 /* Non-0 means lower this frame to the bottom of the stack when left. */
366 unsigned auto_lower : 1;
368 /* True if frame's root window can't be split. */
369 unsigned no_split : 1;
371 /* If this is set, then Emacs won't change the frame name to indicate
372 the current buffer, etcetera. If the user explicitly sets the frame
373 name, this gets set. If the user sets the name to Qnil, this is
374 cleared. */
375 unsigned explicit_name : 1;
377 /* Nonzero if size of some window on this frame has changed. */
378 unsigned window_sizes_changed : 1;
380 /* Nonzero if the mouse has moved on this display device
381 since the last time we checked. */
382 unsigned mouse_moved :1;
384 /* Nonzero means that the pointer is invisible. */
385 unsigned pointer_invisible :1;
387 /* Nonzero means that all windows except mini-window and
388 selected window on this frame have frozen window starts. */
389 unsigned frozen_window_starts : 1;
391 /* Nonzero if we should actually display the scroll bars on this frame. */
392 enum vertical_scroll_bar_type vertical_scroll_bar_type;
394 /* What kind of text cursor should we draw in the future?
395 This should always be filled_box_cursor or bar_cursor. */
396 enum text_cursor_kinds desired_cursor;
398 /* Width of bar cursor (if we are using that). */
399 int cursor_width;
401 /* What kind of text cursor should we draw when the cursor blinks off?
402 This can be filled_box_cursor or bar_cursor or no_cursor. */
403 enum text_cursor_kinds blink_off_cursor;
405 /* Width of bar cursor (if we are using that) for blink-off state. */
406 int blink_off_cursor_width;
408 /* Configured width of the scroll bar, in pixels and in characters.
409 config_scroll_bar_cols tracks config_scroll_bar_width if the
410 latter is positive; a zero value in config_scroll_bar_width means
411 to compute the actual width on the fly, using config_scroll_bar_cols
412 and the current font width. */
413 int config_scroll_bar_width;
414 int config_scroll_bar_cols;
416 /* The size of the extra width currently allotted for vertical
417 scroll bars in this frame, in pixels. */
418 int scroll_bar_actual_width;
420 /* The baud rate that was used to calculate costs for this frame. */
421 int cost_calculation_baud_rate;
423 /* frame opacity
424 alpha[0]: alpha transparency of the active frame
425 alpha[1]: alpha transparency of inactive frames
426 Negative values mean not to change alpha. */
427 double alpha[2];
429 /* Exponent for gamma correction of colors. 1/(VIEWING_GAMMA *
430 SCREEN_GAMMA) where viewing_gamma is 0.4545 and SCREEN_GAMMA is a
431 frame parameter. 0 means don't do gamma correction. */
432 double gamma;
434 /* Additional space to put between text lines on this frame. */
435 int extra_line_spacing;
437 /* All display backends seem to need these two pixel values. */
438 unsigned long background_pixel;
439 unsigned long foreground_pixel;
442 /* Most code should use these functions to set Lisp fields in struct frame. */
444 INLINE void
445 fset_buffer_list (struct frame *f, Lisp_Object val)
447 f->buffer_list = val;
449 INLINE void
450 fset_buried_buffer_list (struct frame *f, Lisp_Object val)
452 f->buried_buffer_list = val;
454 INLINE void
455 fset_condemned_scroll_bars (struct frame *f, Lisp_Object val)
457 f->condemned_scroll_bars = val;
459 INLINE void
460 fset_face_alist (struct frame *f, Lisp_Object val)
462 f->face_alist = val;
464 INLINE void
465 fset_focus_frame (struct frame *f, Lisp_Object val)
467 f->focus_frame = val;
469 INLINE void
470 fset_icon_name (struct frame *f, Lisp_Object val)
472 f->icon_name = val;
474 INLINE void
475 fset_menu_bar_items (struct frame *f, Lisp_Object val)
477 f->menu_bar_items = val;
479 INLINE void
480 fset_menu_bar_vector (struct frame *f, Lisp_Object val)
482 f->menu_bar_vector = val;
484 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
485 INLINE void
486 fset_menu_bar_window (struct frame *f, Lisp_Object val)
488 f->menu_bar_window = val;
490 #endif
491 INLINE void
492 fset_name (struct frame *f, Lisp_Object val)
494 f->name = val;
496 INLINE void
497 fset_param_alist (struct frame *f, Lisp_Object val)
499 f->param_alist = val;
501 INLINE void
502 fset_root_window (struct frame *f, Lisp_Object val)
504 f->root_window = val;
506 INLINE void
507 fset_scroll_bars (struct frame *f, Lisp_Object val)
509 f->scroll_bars = val;
511 INLINE void
512 fset_selected_window (struct frame *f, Lisp_Object val)
514 f->selected_window = val;
516 INLINE void
517 fset_title (struct frame *f, Lisp_Object val)
519 f->title = val;
521 INLINE void
522 fset_tool_bar_items (struct frame *f, Lisp_Object val)
524 f->tool_bar_items = val;
526 INLINE void
527 fset_tool_bar_position (struct frame *f, Lisp_Object val)
529 f->tool_bar_position = val;
531 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
532 INLINE void
533 fset_tool_bar_window (struct frame *f, Lisp_Object val)
535 f->tool_bar_window = val;
537 INLINE void
538 fset_current_tool_bar_string (struct frame *f, Lisp_Object val)
540 f->current_tool_bar_string = val;
542 INLINE void
543 fset_desired_tool_bar_string (struct frame *f, Lisp_Object val)
545 f->desired_tool_bar_string = val;
547 #endif /* HAVE_WINDOW_SYSTEM && !USE_GTK && !HAVE_NS */
549 #define NUMVAL(X) ((INTEGERP (X) || FLOATP (X)) ? XFLOATINT (X) : -1)
551 INLINE double
552 default_pixels_per_inch_x (void)
554 Lisp_Object v = (CONSP (Vdisplay_pixels_per_inch)
555 ? XCAR (Vdisplay_pixels_per_inch)
556 : Vdisplay_pixels_per_inch);
557 return NUMVAL (v) > 0 ? NUMVAL (v) : 72.0;
560 INLINE double
561 default_pixels_per_inch_y (void)
563 Lisp_Object v = (CONSP (Vdisplay_pixels_per_inch)
564 ? XCDR (Vdisplay_pixels_per_inch)
565 : Vdisplay_pixels_per_inch);
566 return NUMVAL (v) > 0 ? NUMVAL (v) : 72.0;
569 #define FRAME_KBOARD(f) ((f)->terminal->kboard)
571 /* Return a pointer to the image cache of frame F. */
572 #define FRAME_IMAGE_CACHE(F) ((F)->terminal->image_cache)
574 #define XFRAME(p) \
575 (eassert (FRAMEP (p)), (struct frame *) XUNTAG (p, Lisp_Vectorlike))
576 #define XSETFRAME(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_FRAME))
578 /* Given a window, return its frame as a Lisp_Object. */
579 #define WINDOW_FRAME(w) ((w)->frame)
581 /* Test a frame for particular kinds of display methods. */
582 #define FRAME_INITIAL_P(f) ((f)->output_method == output_initial)
583 #define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap)
584 #define FRAME_X_P(f) ((f)->output_method == output_x_window)
585 #ifndef HAVE_NTGUI
586 #define FRAME_W32_P(f) (0)
587 #else
588 #define FRAME_W32_P(f) ((f)->output_method == output_w32)
589 #endif
590 #ifndef MSDOS
591 #define FRAME_MSDOS_P(f) (0)
592 #else
593 #define FRAME_MSDOS_P(f) ((f)->output_method == output_msdos_raw)
594 #endif
595 #ifndef HAVE_NS
596 #define FRAME_NS_P(f) (0)
597 #else
598 #define FRAME_NS_P(f) ((f)->output_method == output_ns)
599 #endif
601 /* FRAME_WINDOW_P tests whether the frame is a window, and is
602 defined to be the predicate for the window system being used. */
604 #ifdef HAVE_X_WINDOWS
605 #define FRAME_WINDOW_P(f) FRAME_X_P (f)
606 #endif
607 #ifdef HAVE_NTGUI
608 #define FRAME_WINDOW_P(f) FRAME_W32_P (f)
609 #endif
610 #ifdef HAVE_NS
611 #define FRAME_WINDOW_P(f) FRAME_NS_P(f)
612 #endif
613 #ifndef FRAME_WINDOW_P
614 #define FRAME_WINDOW_P(f) ((void) (f), 0)
615 #endif
617 /* Dots per inch of the screen the frame F is on. */
619 #ifdef HAVE_WINDOW_SYSTEM
621 #define FRAME_RES_X(f) \
622 (eassert (FRAME_WINDOW_P (f)), FRAME_DISPLAY_INFO (f)->resx)
623 #define FRAME_RES_Y(f) \
624 (eassert (FRAME_WINDOW_P (f)), FRAME_DISPLAY_INFO (f)->resy)
626 #else /* !HAVE_WINDOW_SYSTEM */
628 /* Defaults when no window system available. */
630 #define FRAME_RES_X(f) default_pixels_per_inch_x ()
631 #define FRAME_RES_Y(f) default_pixels_per_inch_y ()
633 #endif /* HAVE_WINDOW_SYSTEM */
635 /* Return a pointer to the structure holding information about the
636 region of text, if any, that is currently shown in mouse-face on
637 frame F. We need to define two versions because a TTY-only build
638 does not have FRAME_DISPLAY_INFO. */
639 #ifdef HAVE_WINDOW_SYSTEM
640 # define MOUSE_HL_INFO(F) \
641 (FRAME_WINDOW_P(F) \
642 ? &FRAME_DISPLAY_INFO(F)->mouse_highlight \
643 : &(F)->output_data.tty->display_info->mouse_highlight)
644 #else
645 # define MOUSE_HL_INFO(F) \
646 (&(F)->output_data.tty->display_info->mouse_highlight)
647 #endif
649 /* Nonzero if frame F is still alive (not deleted). */
650 #define FRAME_LIVE_P(f) ((f)->terminal != 0)
652 /* Nonzero if frame F is a minibuffer-only frame. */
653 #define FRAME_MINIBUF_ONLY_P(f) \
654 EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f))
656 /* Nonzero if frame F contains it's own minibuffer window. Frame always has
657 minibuffer window, but it could use minibuffer window of another frame. */
658 #define FRAME_HAS_MINIBUF_P(f) \
659 (WINDOWP (f->minibuffer_window) \
660 && XFRAME (XWINDOW (f->minibuffer_window)->frame) == f)
662 /* Pixel height of frame F, including non-toolkit menu bar and
663 non-toolkit tool bar lines. */
664 #define FRAME_PIXEL_HEIGHT(f) ((f)->pixel_height)
666 /* Pixel width of frame F. */
667 #define FRAME_PIXEL_WIDTH(f) ((f)->pixel_width)
669 /* Height of frame F, measured in canonical lines, including
670 non-toolkit menu bar and non-toolkit tool bar lines. */
671 #define FRAME_LINES(f) (f)->text_lines
673 /* Width of frame F, measured in canonical character columns,
674 not including scroll bars if any. */
675 #define FRAME_COLS(f) (f)->text_cols
677 /* Number of lines of frame F used for menu bar.
678 This is relevant on terminal frames and on
679 X Windows when not using the X toolkit.
680 These lines are counted in FRAME_LINES. */
681 #define FRAME_MENU_BAR_LINES(f) (f)->menu_bar_lines
683 /* Nonzero if this frame should display a tool bar
684 in a way that does not use any text lines. */
685 #if defined (USE_GTK) || defined (HAVE_NS)
686 #define FRAME_EXTERNAL_TOOL_BAR(f) (f)->external_tool_bar
687 #else
688 #define FRAME_EXTERNAL_TOOL_BAR(f) 0
689 #endif
691 /* Number of lines of frame F used for the tool-bar. */
693 #define FRAME_TOOL_BAR_LINES(f) (f)->tool_bar_lines
696 /* Lines above the top-most window in frame F. */
698 #define FRAME_TOP_MARGIN(F) \
699 (FRAME_MENU_BAR_LINES (F) + FRAME_TOOL_BAR_LINES (F))
701 /* Pixel height of the top margin above. */
703 #define FRAME_TOP_MARGIN_HEIGHT(f) \
704 (FRAME_TOP_MARGIN (f) * FRAME_LINE_HEIGHT (f))
706 /* Nonzero if this frame should display a menu bar
707 in a way that does not use any text lines. */
708 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
709 || defined (HAVE_NS) || defined (USE_GTK)
710 #define FRAME_EXTERNAL_MENU_BAR(f) (f)->external_menu_bar
711 #else
712 #define FRAME_EXTERNAL_MENU_BAR(f) 0
713 #endif
714 #define FRAME_VISIBLE_P(f) (f)->visible
716 /* Nonzero if frame F is currently visible but hidden. */
717 #define FRAME_OBSCURED_P(f) ((f)->visible > 1)
719 /* Nonzero if frame F is currently iconified. */
720 #define FRAME_ICONIFIED_P(f) (f)->iconified
722 /* Mark frame F as currently garbaged. */
723 #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1, f->garbaged = 1)
725 /* Nonzero if frame F is currently garbaged. */
726 #define FRAME_GARBAGED_P(f) (f)->garbaged
728 /* Nonzero means do not allow splitting this frame's window. */
729 #define FRAME_NO_SPLIT_P(f) (f)->no_split
731 /* Not really implemented. */
732 #define FRAME_WANTS_MODELINE_P(f) (f)->wants_modeline
734 /* Nonzero if all windows except selected window and mini window
735 are frozen on frame F. */
736 #define FRAME_WINDOWS_FROZEN(f) (f)->frozen_window_starts
738 /* Nonzero if a size change has been requested for frame F
739 but not yet really put into effect. This can be true temporarily
740 when an X event comes in at a bad time. */
741 #define FRAME_WINDOW_SIZES_CHANGED(f) (f)->window_sizes_changed
743 /* The minibuffer window of frame F, if it has one; otherwise nil. */
744 #define FRAME_MINIBUF_WINDOW(f) f->minibuffer_window
746 /* The root window of the window tree of frame F. */
747 #define FRAME_ROOT_WINDOW(f) f->root_window
749 /* The currently selected window of the window tree of frame F. */
750 #define FRAME_SELECTED_WINDOW(f) f->selected_window
752 #define FRAME_INSERT_COST(f) (f)->insert_line_cost
753 #define FRAME_DELETE_COST(f) (f)->delete_line_cost
754 #define FRAME_INSERTN_COST(f) (f)->insert_n_lines_cost
755 #define FRAME_DELETEN_COST(f) (f)->delete_n_lines_cost
756 #define FRAME_FOCUS_FRAME(f) f->focus_frame
758 /* This frame slot says whether scroll bars are currently enabled for frame F,
759 and which side they are on. */
760 #define FRAME_VERTICAL_SCROLL_BAR_TYPE(f) ((f)->vertical_scroll_bar_type)
761 #define FRAME_HAS_VERTICAL_SCROLL_BARS(f) \
762 ((f)->vertical_scroll_bar_type != vertical_scroll_bar_none)
763 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT(f) \
764 ((f)->vertical_scroll_bar_type == vertical_scroll_bar_left)
765 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT(f) \
766 ((f)->vertical_scroll_bar_type == vertical_scroll_bar_right)
768 /* Width that a scroll bar in frame F should have, if there is one.
769 Measured in pixels.
770 If scroll bars are turned off, this is still nonzero. */
771 #define FRAME_CONFIG_SCROLL_BAR_WIDTH(f) ((f)->config_scroll_bar_width)
773 /* Width that a scroll bar in frame F should have, if there is one.
774 Measured in columns (characters).
775 If scroll bars are turned off, this is still nonzero. */
776 #define FRAME_CONFIG_SCROLL_BAR_COLS(f) ((f)->config_scroll_bar_cols)
778 /* Width of a scroll bar in frame F, measured in columns (characters),
779 but only if scroll bars are on the left. If scroll bars are on
780 the right in this frame, or there are no scroll bars, value is 0. */
782 #define FRAME_LEFT_SCROLL_BAR_COLS(f) \
783 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \
784 ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
785 : 0)
787 /* Width of a left scroll bar in frame F, measured in pixels */
789 #define FRAME_LEFT_SCROLL_BAR_AREA_WIDTH(f) \
790 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \
791 ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)) \
792 : 0)
794 /* Width of a scroll bar in frame F, measured in columns (characters),
795 but only if scroll bars are on the right. If scroll bars are on
796 the left in this frame, or there are no scroll bars, value is 0. */
798 #define FRAME_RIGHT_SCROLL_BAR_COLS(f) \
799 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f) \
800 ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
801 : 0)
803 /* Width of a right scroll bar area in frame F, measured in pixels */
805 #define FRAME_RIGHT_SCROLL_BAR_AREA_WIDTH(f) \
806 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f) \
807 ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)) \
808 : 0)
810 /* Actual width of a scroll bar in frame F, measured in columns. */
812 #define FRAME_SCROLL_BAR_COLS(f) \
813 (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \
814 ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
815 : 0)
817 /* Actual width of a scroll bar area in frame F, measured in pixels. */
819 #define FRAME_SCROLL_BAR_AREA_WIDTH(f) \
820 (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \
821 ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)) \
822 : 0)
824 /* Total width of frame F, in columns (characters),
825 including the width used by scroll bars if any. */
827 #define FRAME_TOTAL_COLS(f) ((f)->total_cols)
829 /* Set the width of frame F to VAL.
830 VAL is the width of a full-frame window,
831 not including scroll bars and fringes. */
833 #define SET_FRAME_COLS(f, val) \
834 (FRAME_COLS (f) = (val), \
835 (f)->total_cols = FRAME_TOTAL_COLS_ARG (f, FRAME_COLS (f)))
837 /* Given a value WIDTH for frame F's nominal width,
838 return the value that FRAME_TOTAL_COLS should have. */
840 #define FRAME_TOTAL_COLS_ARG(f, width) \
841 ((width) \
842 + FRAME_SCROLL_BAR_COLS (f) \
843 + FRAME_FRINGE_COLS (f))
845 /* Maximum + 1 legitimate value for FRAME_CURSOR_X. */
847 #define FRAME_CURSOR_X_LIMIT(f) \
848 (FRAME_COLS (f) + FRAME_LEFT_SCROLL_BAR_COLS (f))
850 /* Nonzero if frame F has scroll bars. */
852 #define FRAME_SCROLL_BARS(f) (f->scroll_bars)
854 #define FRAME_CONDEMNED_SCROLL_BARS(f) (f->condemned_scroll_bars)
855 #define FRAME_MENU_BAR_ITEMS(f) (f->menu_bar_items)
856 #define FRAME_COST_BAUD_RATE(f) ((f)->cost_calculation_baud_rate)
858 #define FRAME_DESIRED_CURSOR(f) ((f)->desired_cursor)
859 #define FRAME_BLINK_OFF_CURSOR(f) ((f)->blink_off_cursor)
860 #define FRAME_CURSOR_WIDTH(f) ((f)->cursor_width)
861 #define FRAME_BLINK_OFF_CURSOR_WIDTH(f) ((f)->blink_off_cursor_width)
863 #define FRAME_FOREGROUND_PIXEL(f) ((f)->foreground_pixel)
864 #define FRAME_BACKGROUND_PIXEL(f) ((f)->background_pixel)
866 /* Return a pointer to the face cache of frame F. */
868 #define FRAME_FACE_CACHE(F) (F)->face_cache
870 /* Return the size of message_buf of the frame F. We multiply the
871 width of the frame by 4 because multi-byte form may require at most
872 4-byte for a character. */
874 #define FRAME_MESSAGE_BUF_SIZE(f) (((int) FRAME_COLS (f)) * 4)
876 #define CHECK_FRAME(x) \
877 CHECK_TYPE (FRAMEP (x), Qframep, x)
879 #define CHECK_LIVE_FRAME(x) \
880 CHECK_TYPE (FRAMEP (x) && FRAME_LIVE_P (XFRAME (x)), Qframe_live_p, x)
882 /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
883 `for' loop which iterates over the elements of Vframe_list. The
884 loop will set FRAME_VAR, a Lisp_Object, to each frame in
885 Vframe_list in succession and execute the statement. LIST_VAR
886 should be a Lisp_Object too; it is used to iterate through the
887 Vframe_list.
889 This macro is a holdover from a time when multiple frames weren't always
890 supported. An alternate definition of the macro would expand to
891 something which executes the statement once. */
893 #define FOR_EACH_FRAME(list_var, frame_var) \
894 for ((list_var) = Vframe_list; \
895 (CONSP (list_var) \
896 && (frame_var = XCAR (list_var), 1)); \
897 list_var = XCDR (list_var))
899 /* Reflect mouse movement when a complete frame update is performed. */
901 #define FRAME_MOUSE_UPDATE(frame) \
902 do { \
903 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (frame); \
904 if (frame == hlinfo->mouse_face_mouse_frame) \
906 block_input (); \
907 note_mouse_highlight (hlinfo->mouse_face_mouse_frame, \
908 hlinfo->mouse_face_mouse_x, \
909 hlinfo->mouse_face_mouse_y); \
910 unblock_input (); \
912 } while (0)
914 /* Set visibility of frame F, marking F as garbaged if needed. */
916 #define SET_FRAME_VISIBLE(f, v) \
917 (((f)->visible == 0 || ((f)->visible == 2)) \
918 && ((v) == 1) ? SET_FRAME_GARBAGED (f) : 0, \
919 (f)->visible = (eassert (0 <= (v) && (v) <= 2), (v)))
921 /* Set iconify of frame F. */
923 #define SET_FRAME_ICONIFIED(f, i) \
924 (f)->iconified = (eassert (0 <= (i) && (i) <= 1), (i))
926 extern Lisp_Object selected_frame;
927 extern Lisp_Object Qframep, Qframe_live_p;
928 extern Lisp_Object Qtty, Qtty_type;
929 extern Lisp_Object Qtty_color_mode;
930 extern Lisp_Object Qterminal;
931 extern Lisp_Object Qnoelisp;
933 /* Nonzero means there is at least one garbaged frame. */
934 extern bool frame_garbaged;
936 extern void set_menu_bar_lines (struct frame *, Lisp_Object, Lisp_Object);
937 extern struct frame *decode_window_system_frame (Lisp_Object);
938 extern struct frame *decode_live_frame (Lisp_Object);
939 extern struct frame *decode_any_frame (Lisp_Object);
940 extern struct frame *make_initial_frame (void);
941 extern struct frame *make_frame (bool);
942 #ifdef HAVE_WINDOW_SYSTEM
943 extern struct frame *make_minibuffer_frame (void);
944 extern struct frame *make_frame_without_minibuffer (Lisp_Object,
945 struct kboard *,
946 Lisp_Object);
947 #endif /* HAVE_WINDOW_SYSTEM */
948 extern bool window_system_available (struct frame *);
949 extern void check_window_system (struct frame *);
950 extern void frame_make_pointer_invisible (void);
951 extern void frame_make_pointer_visible (void);
952 extern Lisp_Object delete_frame (Lisp_Object, Lisp_Object);
954 extern Lisp_Object Vframe_list;
956 /* Value is a pointer to the selected frame. If the selected frame
957 isn't live, abort. */
959 #define SELECTED_FRAME() \
960 ((FRAMEP (selected_frame) \
961 && FRAME_LIVE_P (XFRAME (selected_frame))) \
962 ? XFRAME (selected_frame) \
963 : (emacs_abort (), (struct frame *) 0))
966 /***********************************************************************
967 Display-related Macros
968 ***********************************************************************/
970 /* Canonical y-unit on frame F.
971 This value currently equals the line height of the frame (which is
972 the height of the default font of F). */
974 #define FRAME_LINE_HEIGHT(F) ((F)->line_height)
976 /* Canonical x-unit on frame F.
977 This value currently equals the average width of the default font of F. */
979 #define FRAME_COLUMN_WIDTH(F) ((F)->column_width)
981 /* Pixel width of areas used to display truncation marks, continuation
982 marks, overlay arrows. This is 0 for terminal frames. */
984 #ifdef HAVE_WINDOW_SYSTEM
986 /* Total width of fringes reserved for drawing truncation bitmaps,
987 continuation bitmaps and alike. The width is in canonical char
988 units of the frame. This must currently be the case because window
989 sizes aren't pixel values. If it weren't the case, we wouldn't be
990 able to split windows horizontally nicely. */
992 #define FRAME_FRINGE_COLS(F) ((F)->fringe_cols)
994 /* Pixel-width of the left and right fringe. */
996 #define FRAME_LEFT_FRINGE_WIDTH(F) ((F)->left_fringe_width)
997 #define FRAME_RIGHT_FRINGE_WIDTH(F) ((F)->right_fringe_width)
999 /* Total width of fringes in pixels. */
1001 #define FRAME_TOTAL_FRINGE_WIDTH(F) \
1002 (FRAME_LEFT_FRINGE_WIDTH (F) + FRAME_RIGHT_FRINGE_WIDTH (F))
1005 /* Pixel-width of internal border lines */
1007 #define FRAME_INTERNAL_BORDER_WIDTH(F) ((F)->internal_border_width)
1009 #else /* not HAVE_WINDOW_SYSTEM */
1011 #define FRAME_FRINGE_COLS(F) 0
1012 #define FRAME_TOTAL_FRINGE_WIDTH(F) 0
1013 #define FRAME_LEFT_FRINGE_WIDTH(F) 0
1014 #define FRAME_RIGHT_FRINGE_WIDTH(F) 0
1015 #define FRAME_INTERNAL_BORDER_WIDTH(F) 0
1017 #endif /* not HAVE_WINDOW_SYSTEM */
1022 /***********************************************************************
1023 Conversion between canonical units and pixels
1024 ***********************************************************************/
1026 /* Canonical x-values are fractions of FRAME_COLUMN_WIDTH, canonical
1027 y-unit are fractions of FRAME_LINE_HEIGHT of a frame. Both are
1028 represented as Lisp numbers, i.e. integers or floats. */
1030 /* Convert canonical value X to pixels. F is the frame whose
1031 canonical char width is to be used. X must be a Lisp integer or
1032 float. Value is a C integer. */
1034 #define FRAME_PIXEL_X_FROM_CANON_X(F, X) \
1035 (INTEGERP (X) \
1036 ? XINT (X) * FRAME_COLUMN_WIDTH (F) \
1037 : (int) (XFLOAT_DATA (X) * FRAME_COLUMN_WIDTH (F)))
1039 /* Convert canonical value Y to pixels. F is the frame whose
1040 canonical character height is to be used. X must be a Lisp integer
1041 or float. Value is a C integer. */
1043 #define FRAME_PIXEL_Y_FROM_CANON_Y(F, Y) \
1044 (INTEGERP (Y) \
1045 ? XINT (Y) * FRAME_LINE_HEIGHT (F) \
1046 : (int) (XFLOAT_DATA (Y) * FRAME_LINE_HEIGHT (F)))
1048 /* Convert pixel-value X to canonical units. F is the frame whose
1049 canonical character width is to be used. X is a C integer. Result
1050 is a Lisp float if X is not a multiple of the canon width,
1051 otherwise it's a Lisp integer. */
1053 #define FRAME_CANON_X_FROM_PIXEL_X(F, X) \
1054 ((X) % FRAME_COLUMN_WIDTH (F) != 0 \
1055 ? make_float ((double) (X) / FRAME_COLUMN_WIDTH (F)) \
1056 : make_number ((X) / FRAME_COLUMN_WIDTH (F)))
1058 /* Convert pixel-value Y to canonical units. F is the frame whose
1059 canonical character height is to be used. Y is a C integer.
1060 Result is a Lisp float if Y is not a multiple of the canon width,
1061 otherwise it's a Lisp integer. */
1063 #define FRAME_CANON_Y_FROM_PIXEL_Y(F, Y) \
1064 ((Y) % FRAME_LINE_HEIGHT (F) \
1065 ? make_float ((double) (Y) / FRAME_LINE_HEIGHT (F)) \
1066 : make_number ((Y) / FRAME_LINE_HEIGHT (F)))
1070 /* Manipulating pixel sizes and character sizes.
1071 Knowledge of which factors affect the overall size of the window should
1072 be hidden in these macros, if that's possible.
1074 Return the upper/left pixel position of the character cell on frame F
1075 at ROW/COL. */
1077 #define FRAME_LINE_TO_PIXEL_Y(f, row) \
1078 (((row) < FRAME_TOP_MARGIN (f) ? 0 : FRAME_INTERNAL_BORDER_WIDTH (f)) \
1079 + (row) * FRAME_LINE_HEIGHT (f))
1081 #define FRAME_COL_TO_PIXEL_X(f, col) \
1082 (FRAME_INTERNAL_BORDER_WIDTH (f) \
1083 + (col) * FRAME_COLUMN_WIDTH (f))
1085 /* Return the pixel width/height of frame F if it has
1086 COLS columns/LINES rows. */
1088 #define FRAME_TEXT_COLS_TO_PIXEL_WIDTH(f, cols) \
1089 (FRAME_COL_TO_PIXEL_X (f, cols) \
1090 + (f)->scroll_bar_actual_width \
1091 + FRAME_TOTAL_FRINGE_WIDTH (f) \
1092 + FRAME_INTERNAL_BORDER_WIDTH (f))
1094 #define FRAME_TEXT_LINES_TO_PIXEL_HEIGHT(f, lines) \
1095 ((lines) * FRAME_LINE_HEIGHT (f) \
1096 + 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
1099 /* Return the row/column (zero-based) of the character cell containing
1100 the pixel on FRAME at Y/X. */
1102 #define FRAME_PIXEL_Y_TO_LINE(f, y) \
1103 (((y) < FRAME_TOP_MARGIN_HEIGHT (f) \
1104 ? (y) \
1105 : ((y) < FRAME_TOP_MARGIN_HEIGHT (f) + FRAME_INTERNAL_BORDER_WIDTH (f) \
1106 ? (y) - (FRAME_TOP_MARGIN_HEIGHT (f) + FRAME_INTERNAL_BORDER_WIDTH (f) \
1107 /* Arrange for the division to round down. */ \
1108 + FRAME_LINE_HEIGHT (f) - 1) \
1109 : (y) - FRAME_INTERNAL_BORDER_WIDTH (f))) \
1110 / FRAME_LINE_HEIGHT (f))
1112 #define FRAME_PIXEL_X_TO_COL(f, x) \
1113 (((x) - FRAME_INTERNAL_BORDER_WIDTH (f)) \
1114 / FRAME_COLUMN_WIDTH (f))
1116 /* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
1117 frame F? */
1119 #define FRAME_PIXEL_WIDTH_TO_TEXT_COLS(f, width) \
1120 (FRAME_PIXEL_X_TO_COL (f, ((width) \
1121 - FRAME_INTERNAL_BORDER_WIDTH (f) \
1122 - FRAME_TOTAL_FRINGE_WIDTH (f) \
1123 - (f)->scroll_bar_actual_width)))
1125 #define FRAME_PIXEL_HEIGHT_TO_TEXT_LINES(f, height) \
1126 (FRAME_PIXEL_Y_TO_LINE (f, ((height) \
1127 - FRAME_INTERNAL_BORDER_WIDTH (f))))
1129 /* Value is the smallest width of any character in any font on frame F. */
1131 #define FRAME_SMALLEST_CHAR_WIDTH(f) \
1132 FRAME_DISPLAY_INFO (f)->smallest_char_width
1134 /* Value is the smallest height of any font on frame F. */
1136 #define FRAME_SMALLEST_FONT_HEIGHT(f) \
1137 FRAME_DISPLAY_INFO (f)->smallest_font_height
1139 /***********************************************************************
1140 Frame Parameters
1141 ***********************************************************************/
1143 extern Lisp_Object Qauto_raise, Qauto_lower;
1144 extern Lisp_Object Qborder_color, Qborder_width;
1145 extern Lisp_Object Qbuffer_predicate;
1146 extern Lisp_Object Qcursor_color, Qcursor_type;
1147 extern Lisp_Object Qfont;
1148 extern Lisp_Object Qbackground_color, Qforeground_color;
1149 extern Lisp_Object Qicon, Qicon_name, Qicon_type, Qicon_left, Qicon_top;
1150 extern Lisp_Object Qinternal_border_width;
1151 extern Lisp_Object Qtooltip;
1152 extern Lisp_Object Qmenu_bar_lines, Qtool_bar_lines, Qtool_bar_position;
1153 extern Lisp_Object Qmouse_color;
1154 extern Lisp_Object Qname, Qtitle;
1155 extern Lisp_Object Qparent_id;
1156 extern Lisp_Object Qunsplittable, Qvisibility;
1157 extern Lisp_Object Qscroll_bar_width, Qvertical_scroll_bars;
1158 extern Lisp_Object Qscroll_bar_foreground, Qscroll_bar_background;
1159 extern Lisp_Object Qscreen_gamma;
1160 extern Lisp_Object Qline_spacing;
1161 extern Lisp_Object Qwait_for_wm;
1162 extern Lisp_Object Qfullscreen;
1163 extern Lisp_Object Qfullwidth, Qfullheight, Qfullboth, Qmaximized;
1164 extern Lisp_Object Qsticky;
1165 extern Lisp_Object Qfont_backend;
1166 extern Lisp_Object Qalpha;
1168 extern Lisp_Object Qleft_fringe, Qright_fringe;
1169 extern Lisp_Object Qheight, Qwidth;
1170 extern Lisp_Object Qminibuffer, Qmodeline;
1171 extern Lisp_Object Qx, Qw32, Qpc, Qns;
1172 extern Lisp_Object Qvisible;
1173 extern Lisp_Object Qdisplay_type;
1175 extern Lisp_Object Qx_resource_name;
1177 extern Lisp_Object Qleft, Qright, Qtop, Qbox, Qbottom;
1178 extern Lisp_Object Qdisplay;
1180 extern Lisp_Object Qrun_hook_with_args;
1182 #ifdef HAVE_WINDOW_SYSTEM
1184 /* The class of this X application. */
1185 #define EMACS_CLASS "Emacs"
1187 /* These are in xterm.c, w32term.c, etc. */
1189 extern void x_set_scroll_bar_default_width (struct frame *);
1190 extern void x_set_offset (struct frame *, int, int, int);
1191 extern void x_wm_set_size_hint (struct frame *f, long flags, bool user_position);
1193 extern Lisp_Object x_new_font (struct frame *, Lisp_Object, int);
1196 extern Lisp_Object Qface_set_after_frame_default;
1198 #ifdef HAVE_NTGUI
1199 extern void x_fullscreen_adjust (struct frame *f, int *, int *,
1200 int *, int *);
1201 #endif
1203 extern void x_set_frame_parameters (struct frame *, Lisp_Object);
1205 extern void x_set_fullscreen (struct frame *, Lisp_Object, Lisp_Object);
1206 extern void x_set_line_spacing (struct frame *, Lisp_Object, Lisp_Object);
1207 extern void x_set_screen_gamma (struct frame *, Lisp_Object, Lisp_Object);
1208 extern void x_set_font (struct frame *, Lisp_Object, Lisp_Object);
1209 extern void x_set_font_backend (struct frame *, Lisp_Object, Lisp_Object);
1210 extern void x_set_fringe_width (struct frame *, Lisp_Object, Lisp_Object);
1211 extern void x_set_border_width (struct frame *, Lisp_Object, Lisp_Object);
1212 extern void x_set_internal_border_width (struct frame *, Lisp_Object,
1213 Lisp_Object);
1214 extern void x_set_visibility (struct frame *, Lisp_Object, Lisp_Object);
1215 extern void x_set_autoraise (struct frame *, Lisp_Object, Lisp_Object);
1216 extern void x_set_autolower (struct frame *, Lisp_Object, Lisp_Object);
1217 extern void x_set_unsplittable (struct frame *, Lisp_Object, Lisp_Object);
1218 extern void x_set_vertical_scroll_bars (struct frame *, Lisp_Object,
1219 Lisp_Object);
1220 extern void x_set_scroll_bar_width (struct frame *, Lisp_Object,
1221 Lisp_Object);
1223 extern long x_figure_window_size (struct frame *, Lisp_Object, bool);
1225 extern void x_set_alpha (struct frame *, Lisp_Object, Lisp_Object);
1227 extern void validate_x_resource_name (void);
1229 extern Lisp_Object display_x_get_resource (Display_Info *,
1230 Lisp_Object attribute,
1231 Lisp_Object class,
1232 Lisp_Object component,
1233 Lisp_Object subclass);
1235 extern void set_frame_menubar (struct frame *f, bool first_time, bool deep_p);
1236 extern void x_set_window_size (struct frame *f, int change_grav,
1237 int cols, int rows);
1238 extern Lisp_Object x_get_focus_frame (struct frame *);
1239 extern void x_set_mouse_position (struct frame *f, int h, int v);
1240 extern void x_set_mouse_pixel_position (struct frame *f, int pix_x, int pix_y);
1241 extern void x_make_frame_visible (struct frame *f);
1242 extern void x_make_frame_invisible (struct frame *f);
1243 extern void x_iconify_frame (struct frame *f);
1244 extern void x_set_frame_alpha (struct frame *f);
1245 extern void x_set_menu_bar_lines (struct frame *, Lisp_Object, Lisp_Object);
1246 extern void x_set_tool_bar_lines (struct frame *f,
1247 Lisp_Object value,
1248 Lisp_Object oldval);
1249 extern void x_activate_menubar (struct frame *);
1250 extern void x_real_positions (struct frame *, int *, int *);
1251 extern void free_frame_menubar (struct frame *);
1252 extern void x_free_frame_resources (struct frame *);
1254 #if defined HAVE_X_WINDOWS
1255 extern void x_wm_set_icon_position (struct frame *, int, int);
1256 #if !defined USE_X_TOOLKIT
1257 extern char *x_get_resource_string (const char *, const char *);
1258 #endif
1259 extern void x_sync (struct frame *);
1260 #endif /* HAVE_X_WINDOWS */
1262 extern void x_query_colors (struct frame *f, XColor *, int);
1263 extern void x_query_color (struct frame *f, XColor *);
1264 extern void x_focus_frame (struct frame *);
1266 #ifndef HAVE_NS
1268 extern int x_bitmap_icon (struct frame *, Lisp_Object);
1270 /* Set F's bitmap icon, if specified among F's parameters. */
1272 INLINE void
1273 x_set_bitmap_icon (struct frame *f)
1275 Lisp_Object obj = assq_no_quit (Qicon_type, f->param_alist);
1277 if (CONSP (obj))
1278 x_bitmap_icon (f, XCDR (obj));
1281 #endif /* !HAVE_NS */
1283 #endif /* HAVE_WINDOW_SYSTEM */
1285 INLINE void
1286 flush_frame (struct frame *f)
1288 struct redisplay_interface *rif = FRAME_RIF (f);
1290 if (rif && rif->flush_display)
1291 rif->flush_display (f);
1294 /***********************************************************************
1295 Multimonitor data
1296 ***********************************************************************/
1298 #ifdef HAVE_WINDOW_SYSTEM
1300 struct MonitorInfo {
1301 XRectangle geom, work;
1302 int mm_width, mm_height;
1303 char *name;
1306 extern void free_monitors (struct MonitorInfo *monitors, int n_monitors);
1307 extern Lisp_Object make_monitor_attribute_list (struct MonitorInfo *monitors,
1308 int n_monitors,
1309 int primary_monitor,
1310 Lisp_Object monitor_frames,
1311 const char *source);
1313 #endif /* HAVE_WINDOW_SYSTEM */
1316 INLINE_HEADER_END
1318 #endif /* not EMACS_FRAME_H */