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