Refine redisplay optimizations to only redisplay *some* frames/windows
[bpt/emacs.git] / src / frame.h
1 /* Define frame-object for GNU Emacs.
2 Copyright (C) 1993-1994, 1999-2013 Free Software Foundation, Inc.
3
4 This file is part of GNU Emacs.
5
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.
10
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.
15
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/>. */
18
19 /* Don't multiply include: dispextern.h includes macterm.h which
20 includes frame.h some emacs source includes both dispextern.h and
21 frame.h. */
22
23 #ifndef EMACS_FRAME_H
24 #define EMACS_FRAME_H
25
26 #include "dispextern.h"
27 #include "termhooks.h"
28
29 INLINE_HEADER_BEGIN
30
31 enum vertical_scroll_bar_type
32 {
33 vertical_scroll_bar_none,
34 vertical_scroll_bar_left,
35 vertical_scroll_bar_right
36 };
37
38 enum fullscreen_type
39 {
40 FULLSCREEN_NONE,
41 FULLSCREEN_WIDTH = 0x001,
42 FULLSCREEN_HEIGHT = 0x002,
43 FULLSCREEN_BOTH = 0x003,
44 FULLSCREEN_MAXIMIZED = 0x013,
45 FULLSCREEN_WAIT = 0x100
46 };
47
48 /* The structure representing a frame. */
49
50 struct frame
51 {
52 struct vectorlike_header header;
53
54 /* All Lisp_Object components must come first.
55 That ensures they are all aligned normally. */
56
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;
60
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;
64
65 /* This is the frame title specified explicitly, if any.
66 Usually it is nil. */
67 Lisp_Object title;
68
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.
74
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;
81
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;
86
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;
92
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;
98
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;
103
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;
113
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;
120
121 /* Alist of elements (FACE-NAME . FACE-VECTOR-DATA). */
122 Lisp_Object face_alist;
123
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;
128
129 /* Predicate for selecting buffers for other-buffer. */
130 Lisp_Object buffer_predicate;
131
132 /* List of buffers viewed in this frame, for other-buffer. */
133 Lisp_Object buffer_list;
134
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;
138
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
144
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;
148
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
153
154 /* Desired and current tool-bar items. */
155 Lisp_Object tool_bar_items;
156
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;
160
161 /* Beyond here, there should be no more Lisp_Object components. */
162
163 /* Cache of realized faces. */
164 struct face_cache *face_cache;
165
166 /* Number of elements in `menu_bar_vector' that have meaningful data. */
167 int menu_bar_items_used;
168
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;
172
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;
178
179 /* 1 means that glyphs on this frame have been initialized so it can
180 be used for output. */
181 bool glyphs_initialized_p : 1;
182
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 bool resized_p : 1;
186
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 bool default_face_done_p : 1;
191
192 /* Set to non-zero if this frame has already been hscrolled during
193 current redisplay. */
194 bool already_hscrolled_p : 1;
195
196 /* Set to non-zero when current redisplay has updated frame. */
197 bool updated_p : 1;
198
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 bool minimize_tool_bar_window_p : 1;
203 #endif
204
205 #if defined (USE_GTK) || defined (HAVE_NS)
206 /* Nonzero means using a tool bar that comes from the toolkit. */
207 bool external_tool_bar : 1;
208 #endif
209
210 /* Nonzero means that fonts have been loaded since the last glyph
211 matrix adjustments. */
212 bool fonts_changed : 1;
213
214 /* Nonzero means that cursor type has been changed. */
215 bool cursor_type_changed : 1;
216
217 /* True if it needs to be redisplayed. */
218 bool redisplay : 1;
219
220 /* Margin at the top of the frame. Used to display the tool-bar. */
221 int tool_bar_lines;
222
223 int n_tool_bar_rows;
224 int n_tool_bar_items;
225
226 /* A buffer for decode_mode_line. */
227 char *decode_mode_spec_buffer;
228
229 /* See do_line_insertion_deletion_costs for info on these arrays. */
230 /* Cost of inserting 1 line on this frame. */
231 int *insert_line_cost;
232 /* Cost of deleting 1 line on this frame. */
233 int *delete_line_cost;
234 /* Cost of inserting n lines on this frame. */
235 int *insert_n_lines_cost;
236 /* Cost of deleting n lines on this frame. */
237 int *delete_n_lines_cost;
238
239 /* Size of this frame, excluding fringes, scroll bars etc.,
240 in units of canonical characters. */
241 int text_lines, text_cols;
242
243 /* Total size of this frame (i.e. its native window), in units of
244 canonical characters. */
245 int total_lines, total_cols;
246
247 /* New text height and width for pending size change.
248 0 if no change pending. */
249 int new_text_lines, new_text_cols;
250
251 /* Pixel position of the frame window (x and y offsets in root window). */
252 int left_pos, top_pos;
253
254 /* Size of the frame window in pixels. */
255 int pixel_height, pixel_width;
256
257 /* These many pixels are the difference between the outer window (i.e. the
258 left and top of the window manager decoration) and FRAME_X_WINDOW. */
259 int x_pixels_diff, y_pixels_diff;
260
261 /* This is the gravity value for the specified window position. */
262 int win_gravity;
263
264 /* The geometry flags for this window. */
265 int size_hint_flags;
266
267 /* Border width of the frame window as known by the (X) window system. */
268 int border_width;
269
270 /* Width of the internal border. This is a line of background color
271 just inside the window's border. When the frame is selected,
272 a highlighting is displayed inside the internal border. */
273 int internal_border_width;
274
275 /* Canonical X unit. Width of default font, in pixels. */
276 int column_width;
277
278 /* Canonical Y unit. Height of a line, in pixels. */
279 int line_height;
280
281 /* The output method says how the contents of this frame are
282 displayed. It could be using termcap, or using an X window.
283 This must be the same as the terminal->type. */
284 enum output_method output_method;
285
286 /* The terminal device that this frame uses. If this is NULL, then
287 the frame has been deleted. */
288 struct terminal *terminal;
289
290 /* Device-dependent, frame-local auxiliary data used for displaying
291 the contents. When the frame is deleted, this data is deleted as
292 well. */
293 union output_data
294 {
295 struct tty_output *tty; /* From termchar.h. */
296 struct x_output *x; /* From xterm.h. */
297 struct w32_output *w32; /* From w32term.h. */
298 struct ns_output *ns; /* From nsterm.h. */
299 intptr_t nothing;
300 }
301 output_data;
302
303 /* List of font-drivers available on the frame. */
304 struct font_driver_list *font_driver_list;
305 /* List of data specific to font-driver and frame, but common to
306 faces. */
307 struct font_data_list *font_data_list;
308
309 /* Total width of fringes reserved for drawing truncation bitmaps,
310 continuation bitmaps and alike. The width is in canonical char
311 units of the frame. This must currently be the case because window
312 sizes aren't pixel values. If it weren't the case, we wouldn't be
313 able to split windows horizontally nicely. */
314 int fringe_cols;
315
316 /* The extra width (in pixels) currently allotted for fringes. */
317 int left_fringe_width, right_fringe_width;
318
319 /* See FULLSCREEN_ enum below. */
320 enum fullscreen_type want_fullscreen;
321
322 /* Number of lines of menu bar. */
323 int menu_bar_lines;
324
325 #if defined (HAVE_X_WINDOWS)
326 /* Used by x_wait_for_event when watching for an X event on this frame. */
327 int wait_event_type;
328 #endif
329
330 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
331 || defined (HAVE_NS) || defined (USE_GTK)
332 /* Nonzero means using a menu bar that comes from the X toolkit. */
333 bool external_menu_bar : 1;
334 #endif
335
336 /* Next two bitfields are mutually exclusive. They might both be
337 zero if the frame has been made invisible without an icon. */
338
339 /* Nonzero if the frame is currently displayed; we check
340 it to see if we should bother updating the frame's contents.
341
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. */
348 unsigned visible : 2;
349
350 /* Nonzero if the frame is currently iconified. Do not
351 set this directly, use SET_FRAME_ICONIFIED instead. */
352 bool iconified : 1;
353
354 /* Nonzero if this frame should be redrawn. */
355 bool garbaged : 1;
356
357 /* 0 means, if this frame has just one window,
358 show no modeline for that window. */
359 bool wants_modeline : 1;
360
361 /* Non-0 means raise this frame to the top of the heap when selected. */
362 bool auto_raise : 1;
363
364 /* Non-0 means lower this frame to the bottom of the stack when left. */
365 bool auto_lower : 1;
366
367 /* True if frame's root window can't be split. */
368 bool no_split : 1;
369
370 /* If this is set, then Emacs won't change the frame name to indicate
371 the current buffer, etcetera. If the user explicitly sets the frame
372 name, this gets set. If the user sets the name to Qnil, this is
373 cleared. */
374 bool explicit_name : 1;
375
376 /* Nonzero if size of some window on this frame has changed. */
377 bool window_sizes_changed : 1;
378
379 /* Nonzero if the mouse has moved on this display device
380 since the last time we checked. */
381 bool mouse_moved : 1;
382
383 /* Nonzero means that the pointer is invisible. */
384 bool pointer_invisible : 1;
385
386 /* Nonzero means that all windows except mini-window and
387 selected window on this frame have frozen window starts. */
388 bool frozen_window_starts : 1;
389
390 /* Nonzero if we should actually display the scroll bars on this frame. */
391 enum vertical_scroll_bar_type vertical_scroll_bar_type;
392
393 /* What kind of text cursor should we draw in the future?
394 This should always be filled_box_cursor or bar_cursor. */
395 enum text_cursor_kinds desired_cursor;
396
397 /* Width of bar cursor (if we are using that). */
398 int cursor_width;
399
400 /* What kind of text cursor should we draw when the cursor blinks off?
401 This can be filled_box_cursor or bar_cursor or no_cursor. */
402 enum text_cursor_kinds blink_off_cursor;
403
404 /* Width of bar cursor (if we are using that) for blink-off state. */
405 int blink_off_cursor_width;
406
407 /* Configured width of the scroll bar, in pixels and in characters.
408 config_scroll_bar_cols tracks config_scroll_bar_width if the
409 latter is positive; a zero value in config_scroll_bar_width means
410 to compute the actual width on the fly, using config_scroll_bar_cols
411 and the current font width. */
412 int config_scroll_bar_width;
413 int config_scroll_bar_cols;
414
415 /* The size of the extra width currently allotted for vertical
416 scroll bars in this frame, in pixels. */
417 int scroll_bar_actual_width;
418
419 /* The baud rate that was used to calculate costs for this frame. */
420 int cost_calculation_baud_rate;
421
422 /* frame opacity
423 alpha[0]: alpha transparency of the active frame
424 alpha[1]: alpha transparency of inactive frames
425 Negative values mean not to change alpha. */
426 double alpha[2];
427
428 /* Exponent for gamma correction of colors. 1/(VIEWING_GAMMA *
429 SCREEN_GAMMA) where viewing_gamma is 0.4545 and SCREEN_GAMMA is a
430 frame parameter. 0 means don't do gamma correction. */
431 double gamma;
432
433 /* Additional space to put between text lines on this frame. */
434 int extra_line_spacing;
435
436 /* All display backends seem to need these two pixel values. */
437 unsigned long background_pixel;
438 unsigned long foreground_pixel;
439 };
440
441 /* Most code should use these functions to set Lisp fields in struct frame. */
442
443 INLINE void
444 fset_buffer_list (struct frame *f, Lisp_Object val)
445 {
446 f->buffer_list = val;
447 }
448 INLINE void
449 fset_buried_buffer_list (struct frame *f, Lisp_Object val)
450 {
451 f->buried_buffer_list = val;
452 }
453 INLINE void
454 fset_condemned_scroll_bars (struct frame *f, Lisp_Object val)
455 {
456 f->condemned_scroll_bars = val;
457 }
458 INLINE void
459 fset_face_alist (struct frame *f, Lisp_Object val)
460 {
461 f->face_alist = val;
462 }
463 INLINE void
464 fset_focus_frame (struct frame *f, Lisp_Object val)
465 {
466 f->focus_frame = val;
467 }
468 INLINE void
469 fset_icon_name (struct frame *f, Lisp_Object val)
470 {
471 f->icon_name = val;
472 }
473 INLINE void
474 fset_menu_bar_items (struct frame *f, Lisp_Object val)
475 {
476 f->menu_bar_items = val;
477 }
478 INLINE void
479 fset_menu_bar_vector (struct frame *f, Lisp_Object val)
480 {
481 f->menu_bar_vector = val;
482 }
483 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
484 INLINE void
485 fset_menu_bar_window (struct frame *f, Lisp_Object val)
486 {
487 f->menu_bar_window = val;
488 }
489 #endif
490 INLINE void
491 fset_name (struct frame *f, Lisp_Object val)
492 {
493 f->name = val;
494 }
495 INLINE void
496 fset_param_alist (struct frame *f, Lisp_Object val)
497 {
498 f->param_alist = val;
499 }
500 INLINE void
501 fset_root_window (struct frame *f, Lisp_Object val)
502 {
503 f->root_window = val;
504 }
505 INLINE void
506 fset_scroll_bars (struct frame *f, Lisp_Object val)
507 {
508 f->scroll_bars = val;
509 }
510 INLINE void
511 fset_selected_window (struct frame *f, Lisp_Object val)
512 {
513 f->selected_window = val;
514 }
515 INLINE void
516 fset_title (struct frame *f, Lisp_Object val)
517 {
518 f->title = val;
519 }
520 INLINE void
521 fset_tool_bar_items (struct frame *f, Lisp_Object val)
522 {
523 f->tool_bar_items = val;
524 }
525 INLINE void
526 fset_tool_bar_position (struct frame *f, Lisp_Object val)
527 {
528 f->tool_bar_position = val;
529 }
530 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
531 INLINE void
532 fset_tool_bar_window (struct frame *f, Lisp_Object val)
533 {
534 f->tool_bar_window = val;
535 }
536 INLINE void
537 fset_current_tool_bar_string (struct frame *f, Lisp_Object val)
538 {
539 f->current_tool_bar_string = val;
540 }
541 INLINE void
542 fset_desired_tool_bar_string (struct frame *f, Lisp_Object val)
543 {
544 f->desired_tool_bar_string = val;
545 }
546 #endif /* HAVE_WINDOW_SYSTEM && !USE_GTK && !HAVE_NS */
547
548 #define NUMVAL(X) ((INTEGERP (X) || FLOATP (X)) ? XFLOATINT (X) : -1)
549
550 INLINE double
551 default_pixels_per_inch_x (void)
552 {
553 Lisp_Object v = (CONSP (Vdisplay_pixels_per_inch)
554 ? XCAR (Vdisplay_pixels_per_inch)
555 : Vdisplay_pixels_per_inch);
556 return NUMVAL (v) > 0 ? NUMVAL (v) : 72.0;
557 }
558
559 INLINE double
560 default_pixels_per_inch_y (void)
561 {
562 Lisp_Object v = (CONSP (Vdisplay_pixels_per_inch)
563 ? XCDR (Vdisplay_pixels_per_inch)
564 : Vdisplay_pixels_per_inch);
565 return NUMVAL (v) > 0 ? NUMVAL (v) : 72.0;
566 }
567
568 #define FRAME_KBOARD(f) ((f)->terminal->kboard)
569
570 /* Return a pointer to the image cache of frame F. */
571 #define FRAME_IMAGE_CACHE(F) ((F)->terminal->image_cache)
572
573 #define XFRAME(p) \
574 (eassert (FRAMEP (p)), (struct frame *) XUNTAG (p, Lisp_Vectorlike))
575 #define XSETFRAME(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_FRAME))
576
577 /* Given a window, return its frame as a Lisp_Object. */
578 #define WINDOW_FRAME(w) ((w)->frame)
579
580 /* Test a frame for particular kinds of display methods. */
581 #define FRAME_INITIAL_P(f) ((f)->output_method == output_initial)
582 #define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap)
583 #define FRAME_X_P(f) ((f)->output_method == output_x_window)
584 #ifndef HAVE_NTGUI
585 #define FRAME_W32_P(f) (0)
586 #else
587 #define FRAME_W32_P(f) ((f)->output_method == output_w32)
588 #endif
589 #ifndef MSDOS
590 #define FRAME_MSDOS_P(f) (0)
591 #else
592 #define FRAME_MSDOS_P(f) ((f)->output_method == output_msdos_raw)
593 #endif
594 #ifndef HAVE_NS
595 #define FRAME_NS_P(f) (0)
596 #else
597 #define FRAME_NS_P(f) ((f)->output_method == output_ns)
598 #endif
599
600 /* FRAME_WINDOW_P tests whether the frame is a window, and is
601 defined to be the predicate for the window system being used. */
602
603 #ifdef HAVE_X_WINDOWS
604 #define FRAME_WINDOW_P(f) FRAME_X_P (f)
605 #endif
606 #ifdef HAVE_NTGUI
607 #define FRAME_WINDOW_P(f) FRAME_W32_P (f)
608 #endif
609 #ifdef HAVE_NS
610 #define FRAME_WINDOW_P(f) FRAME_NS_P(f)
611 #endif
612 #ifndef FRAME_WINDOW_P
613 #define FRAME_WINDOW_P(f) ((void) (f), 0)
614 #endif
615
616 /* Dots per inch of the screen the frame F is on. */
617
618 #ifdef HAVE_WINDOW_SYSTEM
619
620 #define FRAME_RES_X(f) \
621 (eassert (FRAME_WINDOW_P (f)), FRAME_DISPLAY_INFO (f)->resx)
622 #define FRAME_RES_Y(f) \
623 (eassert (FRAME_WINDOW_P (f)), FRAME_DISPLAY_INFO (f)->resy)
624
625 #else /* !HAVE_WINDOW_SYSTEM */
626
627 /* Defaults when no window system available. */
628
629 #define FRAME_RES_X(f) default_pixels_per_inch_x ()
630 #define FRAME_RES_Y(f) default_pixels_per_inch_y ()
631
632 #endif /* HAVE_WINDOW_SYSTEM */
633
634 /* Return a pointer to the structure holding information about the
635 region of text, if any, that is currently shown in mouse-face on
636 frame F. We need to define two versions because a TTY-only build
637 does not have FRAME_DISPLAY_INFO. */
638 #ifdef HAVE_WINDOW_SYSTEM
639 # define MOUSE_HL_INFO(F) \
640 (FRAME_WINDOW_P(F) \
641 ? &FRAME_DISPLAY_INFO(F)->mouse_highlight \
642 : &(F)->output_data.tty->display_info->mouse_highlight)
643 #else
644 # define MOUSE_HL_INFO(F) \
645 (&(F)->output_data.tty->display_info->mouse_highlight)
646 #endif
647
648 /* Nonzero if frame F is still alive (not deleted). */
649 #define FRAME_LIVE_P(f) ((f)->terminal != 0)
650
651 /* Nonzero if frame F is a minibuffer-only frame. */
652 #define FRAME_MINIBUF_ONLY_P(f) \
653 EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f))
654
655 /* Nonzero if frame F contains it's own minibuffer window. Frame always has
656 minibuffer window, but it could use minibuffer window of another frame. */
657 #define FRAME_HAS_MINIBUF_P(f) \
658 (WINDOWP (f->minibuffer_window) \
659 && XFRAME (XWINDOW (f->minibuffer_window)->frame) == f)
660
661 /* Pixel height of frame F, including non-toolkit menu bar and
662 non-toolkit tool bar lines. */
663 #define FRAME_PIXEL_HEIGHT(f) ((f)->pixel_height)
664
665 /* Pixel width of frame F. */
666 #define FRAME_PIXEL_WIDTH(f) ((f)->pixel_width)
667
668 /* Height of frame F, measured in canonical lines, including
669 non-toolkit menu bar and non-toolkit tool bar lines. */
670 #define FRAME_LINES(f) (f)->text_lines
671
672 /* Width of frame F, measured in canonical character columns,
673 not including scroll bars if any. */
674 #define FRAME_COLS(f) (f)->text_cols
675
676 /* Number of lines of frame F used for menu bar.
677 This is relevant on terminal frames and on
678 X Windows when not using the X toolkit.
679 These lines are counted in FRAME_LINES. */
680 #define FRAME_MENU_BAR_LINES(f) (f)->menu_bar_lines
681
682 /* Nonzero if this frame should display a tool bar
683 in a way that does not use any text lines. */
684 #if defined (USE_GTK) || defined (HAVE_NS)
685 #define FRAME_EXTERNAL_TOOL_BAR(f) (f)->external_tool_bar
686 #else
687 #define FRAME_EXTERNAL_TOOL_BAR(f) 0
688 #endif
689
690 /* Number of lines of frame F used for the tool-bar. */
691
692 #define FRAME_TOOL_BAR_LINES(f) (f)->tool_bar_lines
693
694
695 /* Lines above the top-most window in frame F. */
696
697 #define FRAME_TOP_MARGIN(F) \
698 (FRAME_MENU_BAR_LINES (F) + FRAME_TOOL_BAR_LINES (F))
699
700 /* Pixel height of the top margin above. */
701
702 #define FRAME_TOP_MARGIN_HEIGHT(f) \
703 (FRAME_TOP_MARGIN (f) * FRAME_LINE_HEIGHT (f))
704
705 /* Nonzero if this frame should display a menu bar
706 in a way that does not use any text lines. */
707 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
708 || defined (HAVE_NS) || defined (USE_GTK)
709 #define FRAME_EXTERNAL_MENU_BAR(f) (f)->external_menu_bar
710 #else
711 #define FRAME_EXTERNAL_MENU_BAR(f) 0
712 #endif
713 #define FRAME_VISIBLE_P(f) (f)->visible
714
715 /* Nonzero if frame F is currently visible but hidden. */
716 #define FRAME_OBSCURED_P(f) ((f)->visible > 1)
717
718 /* Nonzero if frame F is currently iconified. */
719 #define FRAME_ICONIFIED_P(f) (f)->iconified
720
721 /* Mark frame F as currently garbaged. */
722 #define SET_FRAME_GARBAGED(f) \
723 (frame_garbaged = true, fset_redisplay (f), f->garbaged = true)
724
725 /* Nonzero if frame F is currently garbaged. */
726 #define FRAME_GARBAGED_P(f) (f)->garbaged
727
728 /* Nonzero means do not allow splitting this frame's window. */
729 #define FRAME_NO_SPLIT_P(f) (f)->no_split
730
731 /* Not really implemented. */
732 #define FRAME_WANTS_MODELINE_P(f) (f)->wants_modeline
733
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
737
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
742
743 /* The minibuffer window of frame F, if it has one; otherwise nil. */
744 #define FRAME_MINIBUF_WINDOW(f) f->minibuffer_window
745
746 /* The root window of the window tree of frame F. */
747 #define FRAME_ROOT_WINDOW(f) f->root_window
748
749 /* The currently selected window of the window tree of frame F. */
750 #define FRAME_SELECTED_WINDOW(f) f->selected_window
751
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
757
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)
767
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)
772
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)
777
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. */
781
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)
786
787 /* Width of a left scroll bar in frame F, measured in pixels */
788
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)
793
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. */
797
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)
802
803 /* Width of a right scroll bar area in frame F, measured in pixels */
804
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)
809
810 /* Actual width of a scroll bar in frame F, measured in columns. */
811
812 #define FRAME_SCROLL_BAR_COLS(f) \
813 (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \
814 ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
815 : 0)
816
817 /* Actual width of a scroll bar area in frame F, measured in pixels. */
818
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)
823
824 /* Total width of frame F, in columns (characters),
825 including the width used by scroll bars if any. */
826
827 #define FRAME_TOTAL_COLS(f) ((f)->total_cols)
828
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. */
832
833 #define SET_FRAME_COLS(f, val) \
834 (FRAME_COLS (f) = (val), \
835 (f)->total_cols = FRAME_TOTAL_COLS_ARG (f, FRAME_COLS (f)))
836
837 /* Given a value WIDTH for frame F's nominal width,
838 return the value that FRAME_TOTAL_COLS should have. */
839
840 #define FRAME_TOTAL_COLS_ARG(f, width) \
841 ((width) \
842 + FRAME_SCROLL_BAR_COLS (f) \
843 + FRAME_FRINGE_COLS (f))
844
845 /* Maximum + 1 legitimate value for FRAME_CURSOR_X. */
846
847 #define FRAME_CURSOR_X_LIMIT(f) \
848 (FRAME_COLS (f) + FRAME_LEFT_SCROLL_BAR_COLS (f))
849
850 /* Nonzero if frame F has scroll bars. */
851
852 #define FRAME_SCROLL_BARS(f) (f->scroll_bars)
853
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)
857
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)
862
863 #define FRAME_FOREGROUND_PIXEL(f) ((f)->foreground_pixel)
864 #define FRAME_BACKGROUND_PIXEL(f) ((f)->background_pixel)
865
866 /* Return a pointer to the face cache of frame F. */
867
868 #define FRAME_FACE_CACHE(F) (F)->face_cache
869
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. */
873
874 #define FRAME_MESSAGE_BUF_SIZE(f) (((int) FRAME_COLS (f)) * 4)
875
876 #define CHECK_FRAME(x) \
877 CHECK_TYPE (FRAMEP (x), Qframep, x)
878
879 #define CHECK_LIVE_FRAME(x) \
880 CHECK_TYPE (FRAMEP (x) && FRAME_LIVE_P (XFRAME (x)), Qframe_live_p, x)
881
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.
888
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. */
892
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))
898
899 /* Reflect mouse movement when a complete frame update is performed. */
900
901 #define FRAME_MOUSE_UPDATE(frame) \
902 do { \
903 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (frame); \
904 if (frame == hlinfo->mouse_face_mouse_frame) \
905 { \
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 (); \
911 } \
912 } while (0)
913
914 /* Set visibility of frame F.
915 We call redisplay_other_windows to make sure the frame gets redisplayed
916 if some changes were applied to it while it wasn't visible (and hence
917 wasn't redisplayed). */
918
919 #define SET_FRAME_VISIBLE(f, v) \
920 (((f)->visible == 0 || ((f)->visible == 2)) && ((v) == 1) \
921 ? redisplay_other_windows () : 0, \
922 (f)->visible = (eassert (0 <= (v) && (v) <= 2), (v)))
923
924 /* Set iconify of frame F. */
925
926 #define SET_FRAME_ICONIFIED(f, i) \
927 (f)->iconified = (eassert (0 <= (i) && (i) <= 1), (i))
928
929 extern Lisp_Object selected_frame;
930 extern Lisp_Object Qframep, Qframe_live_p;
931 extern Lisp_Object Qtty, Qtty_type;
932 extern Lisp_Object Qtty_color_mode;
933 extern Lisp_Object Qterminal;
934 extern Lisp_Object Qnoelisp;
935
936 /* Nonzero means there is at least one garbaged frame. */
937 extern bool frame_garbaged;
938
939 extern void set_menu_bar_lines (struct frame *, Lisp_Object, Lisp_Object);
940 extern struct frame *decode_window_system_frame (Lisp_Object);
941 extern struct frame *decode_live_frame (Lisp_Object);
942 extern struct frame *decode_any_frame (Lisp_Object);
943 extern struct frame *make_initial_frame (void);
944 extern struct frame *make_frame (bool);
945 #ifdef HAVE_WINDOW_SYSTEM
946 extern struct frame *make_minibuffer_frame (void);
947 extern struct frame *make_frame_without_minibuffer (Lisp_Object,
948 struct kboard *,
949 Lisp_Object);
950 #endif /* HAVE_WINDOW_SYSTEM */
951 extern bool window_system_available (struct frame *);
952 extern void check_window_system (struct frame *);
953 extern void frame_make_pointer_invisible (void);
954 extern void frame_make_pointer_visible (void);
955 extern Lisp_Object delete_frame (Lisp_Object, Lisp_Object);
956
957 extern Lisp_Object Vframe_list;
958
959 /* Value is a pointer to the selected frame. If the selected frame
960 isn't live, abort. */
961
962 #define SELECTED_FRAME() \
963 ((FRAMEP (selected_frame) \
964 && FRAME_LIVE_P (XFRAME (selected_frame))) \
965 ? XFRAME (selected_frame) \
966 : (emacs_abort (), (struct frame *) 0))
967
968 \f
969 /***********************************************************************
970 Display-related Macros
971 ***********************************************************************/
972
973 /* Canonical y-unit on frame F.
974 This value currently equals the line height of the frame (which is
975 the height of the default font of F). */
976
977 #define FRAME_LINE_HEIGHT(F) ((F)->line_height)
978
979 /* Canonical x-unit on frame F.
980 This value currently equals the average width of the default font of F. */
981
982 #define FRAME_COLUMN_WIDTH(F) ((F)->column_width)
983
984 /* Pixel width of areas used to display truncation marks, continuation
985 marks, overlay arrows. This is 0 for terminal frames. */
986
987 #ifdef HAVE_WINDOW_SYSTEM
988
989 /* Total width of fringes reserved for drawing truncation bitmaps,
990 continuation bitmaps and alike. The width is in canonical char
991 units of the frame. This must currently be the case because window
992 sizes aren't pixel values. If it weren't the case, we wouldn't be
993 able to split windows horizontally nicely. */
994
995 #define FRAME_FRINGE_COLS(F) ((F)->fringe_cols)
996
997 /* Pixel-width of the left and right fringe. */
998
999 #define FRAME_LEFT_FRINGE_WIDTH(F) ((F)->left_fringe_width)
1000 #define FRAME_RIGHT_FRINGE_WIDTH(F) ((F)->right_fringe_width)
1001
1002 /* Total width of fringes in pixels. */
1003
1004 #define FRAME_TOTAL_FRINGE_WIDTH(F) \
1005 (FRAME_LEFT_FRINGE_WIDTH (F) + FRAME_RIGHT_FRINGE_WIDTH (F))
1006
1007
1008 /* Pixel-width of internal border lines */
1009
1010 #define FRAME_INTERNAL_BORDER_WIDTH(F) ((F)->internal_border_width)
1011
1012 #else /* not HAVE_WINDOW_SYSTEM */
1013
1014 #define FRAME_FRINGE_COLS(F) 0
1015 #define FRAME_TOTAL_FRINGE_WIDTH(F) 0
1016 #define FRAME_LEFT_FRINGE_WIDTH(F) 0
1017 #define FRAME_RIGHT_FRINGE_WIDTH(F) 0
1018 #define FRAME_INTERNAL_BORDER_WIDTH(F) 0
1019
1020 #endif /* not HAVE_WINDOW_SYSTEM */
1021
1022
1023
1024 \f
1025 /***********************************************************************
1026 Conversion between canonical units and pixels
1027 ***********************************************************************/
1028
1029 /* Canonical x-values are fractions of FRAME_COLUMN_WIDTH, canonical
1030 y-unit are fractions of FRAME_LINE_HEIGHT of a frame. Both are
1031 represented as Lisp numbers, i.e. integers or floats. */
1032
1033 /* Convert canonical value X to pixels. F is the frame whose
1034 canonical char width is to be used. X must be a Lisp integer or
1035 float. Value is a C integer. */
1036
1037 #define FRAME_PIXEL_X_FROM_CANON_X(F, X) \
1038 (INTEGERP (X) \
1039 ? XINT (X) * FRAME_COLUMN_WIDTH (F) \
1040 : (int) (XFLOAT_DATA (X) * FRAME_COLUMN_WIDTH (F)))
1041
1042 /* Convert canonical value Y to pixels. F is the frame whose
1043 canonical character height is to be used. X must be a Lisp integer
1044 or float. Value is a C integer. */
1045
1046 #define FRAME_PIXEL_Y_FROM_CANON_Y(F, Y) \
1047 (INTEGERP (Y) \
1048 ? XINT (Y) * FRAME_LINE_HEIGHT (F) \
1049 : (int) (XFLOAT_DATA (Y) * FRAME_LINE_HEIGHT (F)))
1050
1051 /* Convert pixel-value X to canonical units. F is the frame whose
1052 canonical character width is to be used. X is a C integer. Result
1053 is a Lisp float if X is not a multiple of the canon width,
1054 otherwise it's a Lisp integer. */
1055
1056 #define FRAME_CANON_X_FROM_PIXEL_X(F, X) \
1057 ((X) % FRAME_COLUMN_WIDTH (F) != 0 \
1058 ? make_float ((double) (X) / FRAME_COLUMN_WIDTH (F)) \
1059 : make_number ((X) / FRAME_COLUMN_WIDTH (F)))
1060
1061 /* Convert pixel-value Y to canonical units. F is the frame whose
1062 canonical character height is to be used. Y is a C integer.
1063 Result is a Lisp float if Y is not a multiple of the canon width,
1064 otherwise it's a Lisp integer. */
1065
1066 #define FRAME_CANON_Y_FROM_PIXEL_Y(F, Y) \
1067 ((Y) % FRAME_LINE_HEIGHT (F) \
1068 ? make_float ((double) (Y) / FRAME_LINE_HEIGHT (F)) \
1069 : make_number ((Y) / FRAME_LINE_HEIGHT (F)))
1070
1071
1072 \f
1073 /* Manipulating pixel sizes and character sizes.
1074 Knowledge of which factors affect the overall size of the window should
1075 be hidden in these macros, if that's possible.
1076
1077 Return the upper/left pixel position of the character cell on frame F
1078 at ROW/COL. */
1079
1080 #define FRAME_LINE_TO_PIXEL_Y(f, row) \
1081 (((row) < FRAME_TOP_MARGIN (f) ? 0 : FRAME_INTERNAL_BORDER_WIDTH (f)) \
1082 + (row) * FRAME_LINE_HEIGHT (f))
1083
1084 #define FRAME_COL_TO_PIXEL_X(f, col) \
1085 (FRAME_INTERNAL_BORDER_WIDTH (f) \
1086 + (col) * FRAME_COLUMN_WIDTH (f))
1087
1088 /* Return the pixel width/height of frame F if it has
1089 COLS columns/LINES rows. */
1090
1091 #define FRAME_TEXT_COLS_TO_PIXEL_WIDTH(f, cols) \
1092 (FRAME_COL_TO_PIXEL_X (f, cols) \
1093 + (f)->scroll_bar_actual_width \
1094 + FRAME_TOTAL_FRINGE_WIDTH (f) \
1095 + FRAME_INTERNAL_BORDER_WIDTH (f))
1096
1097 #define FRAME_TEXT_LINES_TO_PIXEL_HEIGHT(f, lines) \
1098 ((lines) * FRAME_LINE_HEIGHT (f) \
1099 + 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
1100
1101
1102 /* Return the row/column (zero-based) of the character cell containing
1103 the pixel on FRAME at Y/X. */
1104
1105 #define FRAME_PIXEL_Y_TO_LINE(f, y) \
1106 (((y) < FRAME_TOP_MARGIN_HEIGHT (f) \
1107 ? (y) \
1108 : ((y) < FRAME_TOP_MARGIN_HEIGHT (f) + FRAME_INTERNAL_BORDER_WIDTH (f) \
1109 ? (y) - (FRAME_TOP_MARGIN_HEIGHT (f) + FRAME_INTERNAL_BORDER_WIDTH (f) \
1110 /* Arrange for the division to round down. */ \
1111 + FRAME_LINE_HEIGHT (f) - 1) \
1112 : (y) - FRAME_INTERNAL_BORDER_WIDTH (f))) \
1113 / FRAME_LINE_HEIGHT (f))
1114
1115 #define FRAME_PIXEL_X_TO_COL(f, x) \
1116 (((x) - FRAME_INTERNAL_BORDER_WIDTH (f)) \
1117 / FRAME_COLUMN_WIDTH (f))
1118
1119 /* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
1120 frame F? */
1121
1122 #define FRAME_PIXEL_WIDTH_TO_TEXT_COLS(f, width) \
1123 (FRAME_PIXEL_X_TO_COL (f, ((width) \
1124 - FRAME_INTERNAL_BORDER_WIDTH (f) \
1125 - FRAME_TOTAL_FRINGE_WIDTH (f) \
1126 - (f)->scroll_bar_actual_width)))
1127
1128 #define FRAME_PIXEL_HEIGHT_TO_TEXT_LINES(f, height) \
1129 (FRAME_PIXEL_Y_TO_LINE (f, ((height) \
1130 - FRAME_INTERNAL_BORDER_WIDTH (f))))
1131
1132 /* Value is the smallest width of any character in any font on frame F. */
1133
1134 #define FRAME_SMALLEST_CHAR_WIDTH(f) \
1135 FRAME_DISPLAY_INFO (f)->smallest_char_width
1136
1137 /* Value is the smallest height of any font on frame F. */
1138
1139 #define FRAME_SMALLEST_FONT_HEIGHT(f) \
1140 FRAME_DISPLAY_INFO (f)->smallest_font_height
1141
1142 /***********************************************************************
1143 Frame Parameters
1144 ***********************************************************************/
1145
1146 extern Lisp_Object Qauto_raise, Qauto_lower;
1147 extern Lisp_Object Qborder_color, Qborder_width;
1148 extern Lisp_Object Qbuffer_predicate;
1149 extern Lisp_Object Qcursor_color, Qcursor_type;
1150 extern Lisp_Object Qfont;
1151 extern Lisp_Object Qbackground_color, Qforeground_color;
1152 extern Lisp_Object Qicon, Qicon_name, Qicon_type, Qicon_left, Qicon_top;
1153 extern Lisp_Object Qinternal_border_width;
1154 extern Lisp_Object Qtooltip;
1155 extern Lisp_Object Qmenu_bar_lines, Qtool_bar_lines, Qtool_bar_position;
1156 extern Lisp_Object Qmouse_color;
1157 extern Lisp_Object Qname, Qtitle;
1158 extern Lisp_Object Qparent_id;
1159 extern Lisp_Object Qunsplittable, Qvisibility;
1160 extern Lisp_Object Qscroll_bar_width, Qvertical_scroll_bars;
1161 extern Lisp_Object Qscroll_bar_foreground, Qscroll_bar_background;
1162 extern Lisp_Object Qscreen_gamma;
1163 extern Lisp_Object Qline_spacing;
1164 extern Lisp_Object Qwait_for_wm;
1165 extern Lisp_Object Qfullscreen;
1166 extern Lisp_Object Qfullwidth, Qfullheight, Qfullboth, Qmaximized;
1167 extern Lisp_Object Qsticky;
1168 extern Lisp_Object Qfont_backend;
1169 extern Lisp_Object Qalpha;
1170
1171 extern Lisp_Object Qleft_fringe, Qright_fringe;
1172 extern Lisp_Object Qheight, Qwidth;
1173 extern Lisp_Object Qminibuffer, Qmodeline;
1174 extern Lisp_Object Qx, Qw32, Qpc, Qns;
1175 extern Lisp_Object Qvisible;
1176 extern Lisp_Object Qdisplay_type;
1177
1178 extern Lisp_Object Qx_resource_name;
1179
1180 extern Lisp_Object Qleft, Qright, Qtop, Qbox, Qbottom;
1181 extern Lisp_Object Qdisplay;
1182
1183 extern Lisp_Object Qrun_hook_with_args;
1184
1185 #ifdef HAVE_WINDOW_SYSTEM
1186
1187 /* The class of this X application. */
1188 #define EMACS_CLASS "Emacs"
1189
1190 /* These are in xterm.c, w32term.c, etc. */
1191
1192 extern void x_set_scroll_bar_default_width (struct frame *);
1193 extern void x_set_offset (struct frame *, int, int, int);
1194 extern void x_wm_set_size_hint (struct frame *f, long flags, bool user_position);
1195
1196 extern Lisp_Object x_new_font (struct frame *, Lisp_Object, int);
1197
1198
1199 extern Lisp_Object Qface_set_after_frame_default;
1200
1201 #ifdef HAVE_NTGUI
1202 extern void x_fullscreen_adjust (struct frame *f, int *, int *,
1203 int *, int *);
1204 #endif
1205
1206 extern void x_set_frame_parameters (struct frame *, Lisp_Object);
1207
1208 extern void x_set_fullscreen (struct frame *, Lisp_Object, Lisp_Object);
1209 extern void x_set_line_spacing (struct frame *, Lisp_Object, Lisp_Object);
1210 extern void x_set_screen_gamma (struct frame *, Lisp_Object, Lisp_Object);
1211 extern void x_set_font (struct frame *, Lisp_Object, Lisp_Object);
1212 extern void x_set_font_backend (struct frame *, Lisp_Object, Lisp_Object);
1213 extern void x_set_fringe_width (struct frame *, Lisp_Object, Lisp_Object);
1214 extern void x_set_border_width (struct frame *, Lisp_Object, Lisp_Object);
1215 extern void x_set_internal_border_width (struct frame *, Lisp_Object,
1216 Lisp_Object);
1217 extern void x_set_visibility (struct frame *, Lisp_Object, Lisp_Object);
1218 extern void x_set_autoraise (struct frame *, Lisp_Object, Lisp_Object);
1219 extern void x_set_autolower (struct frame *, Lisp_Object, Lisp_Object);
1220 extern void x_set_unsplittable (struct frame *, Lisp_Object, Lisp_Object);
1221 extern void x_set_vertical_scroll_bars (struct frame *, Lisp_Object,
1222 Lisp_Object);
1223 extern void x_set_scroll_bar_width (struct frame *, Lisp_Object,
1224 Lisp_Object);
1225
1226 extern long x_figure_window_size (struct frame *, Lisp_Object, bool);
1227
1228 extern void x_set_alpha (struct frame *, Lisp_Object, Lisp_Object);
1229
1230 extern void validate_x_resource_name (void);
1231
1232 extern Lisp_Object display_x_get_resource (Display_Info *,
1233 Lisp_Object attribute,
1234 Lisp_Object class,
1235 Lisp_Object component,
1236 Lisp_Object subclass);
1237
1238 extern void set_frame_menubar (struct frame *f, bool first_time, bool deep_p);
1239 extern void x_set_window_size (struct frame *f, int change_grav,
1240 int cols, int rows);
1241 extern Lisp_Object x_get_focus_frame (struct frame *);
1242 extern void x_set_mouse_position (struct frame *f, int h, int v);
1243 extern void x_set_mouse_pixel_position (struct frame *f, int pix_x, int pix_y);
1244 extern void x_make_frame_visible (struct frame *f);
1245 extern void x_make_frame_invisible (struct frame *f);
1246 extern void x_iconify_frame (struct frame *f);
1247 extern void x_set_frame_alpha (struct frame *f);
1248 extern void x_set_menu_bar_lines (struct frame *, Lisp_Object, Lisp_Object);
1249 extern void x_set_tool_bar_lines (struct frame *f,
1250 Lisp_Object value,
1251 Lisp_Object oldval);
1252 extern void x_activate_menubar (struct frame *);
1253 extern void x_real_positions (struct frame *, int *, int *);
1254 extern void free_frame_menubar (struct frame *);
1255 extern void x_free_frame_resources (struct frame *);
1256
1257 #if defined HAVE_X_WINDOWS
1258 extern void x_wm_set_icon_position (struct frame *, int, int);
1259 #if !defined USE_X_TOOLKIT
1260 extern char *x_get_resource_string (const char *, const char *);
1261 #endif
1262 extern void x_sync (struct frame *);
1263 #endif /* HAVE_X_WINDOWS */
1264
1265 extern void x_query_colors (struct frame *f, XColor *, int);
1266 extern void x_query_color (struct frame *f, XColor *);
1267 extern void x_focus_frame (struct frame *);
1268
1269 #ifndef HAVE_NS
1270
1271 extern int x_bitmap_icon (struct frame *, Lisp_Object);
1272
1273 /* Set F's bitmap icon, if specified among F's parameters. */
1274
1275 INLINE void
1276 x_set_bitmap_icon (struct frame *f)
1277 {
1278 Lisp_Object obj = assq_no_quit (Qicon_type, f->param_alist);
1279
1280 if (CONSP (obj))
1281 x_bitmap_icon (f, XCDR (obj));
1282 }
1283
1284 #endif /* !HAVE_NS */
1285
1286 #endif /* HAVE_WINDOW_SYSTEM */
1287
1288 INLINE void
1289 flush_frame (struct frame *f)
1290 {
1291 struct redisplay_interface *rif = FRAME_RIF (f);
1292
1293 if (rif && rif->flush_display)
1294 rif->flush_display (f);
1295 }
1296
1297 /***********************************************************************
1298 Multimonitor data
1299 ***********************************************************************/
1300
1301 #ifdef HAVE_WINDOW_SYSTEM
1302
1303 struct MonitorInfo {
1304 XRectangle geom, work;
1305 int mm_width, mm_height;
1306 char *name;
1307 };
1308
1309 extern void free_monitors (struct MonitorInfo *monitors, int n_monitors);
1310 extern Lisp_Object make_monitor_attribute_list (struct MonitorInfo *monitors,
1311 int n_monitors,
1312 int primary_monitor,
1313 Lisp_Object monitor_frames,
1314 const char *source);
1315
1316 #endif /* HAVE_WINDOW_SYSTEM */
1317
1318
1319 INLINE_HEADER_END
1320
1321 #endif /* not EMACS_FRAME_H */