1 /* Define frame-object for GNU Emacs.
2 Copyright (C) 1993, 1994, 1999, 2000, 2001, 2002, 2003, 2004,
3 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 /* Don't multiply include: dispextern.h includes macterm.h which
21 includes frame.h some emacs source includes both dispextern.h and
27 #include "dispextern.h"
32 /* Nonzero means there is at least one garbaged frame. */
33 extern int frame_garbaged
;
35 /* Nonzero means FRAME_MESSAGE_BUF (selected_frame) is being used by
38 extern int message_buf_print
;
41 /* The structure representing a frame. */
54 enum vertical_scroll_bar_type
56 vertical_scroll_bar_none
,
57 vertical_scroll_bar_left
,
58 vertical_scroll_bar_right
61 enum text_cursor_kinds
74 FULLSCREEN_WIDTH
= 0x001,
75 FULLSCREEN_HEIGHT
= 0x002,
76 FULLSCREEN_BOTH
= 0x003,
77 FULLSCREEN_MAXIMIZED
= 0x013,
78 FULLSCREEN_WAIT
= 0x100
82 #define FRAME_FOREGROUND_PIXEL(f) ((f)->foreground_pixel)
83 #define FRAME_BACKGROUND_PIXEL(f) ((f)->background_pixel)
87 struct font_driver_list
;
92 struct Lisp_Vector
*next
;
94 /* All Lisp_Object components must come first.
95 That ensures they are all aligned normally. */
97 /* Name of this frame: a Lisp string. It is used for looking up resources,
98 as well as for the title in some cases. */
101 /* The name to use for the icon, the last time
102 it was refreshed. nil means not explicitly specified. */
103 Lisp_Object icon_name
;
105 /* This is the frame title specified explicitly, if any.
106 Usually it is nil. */
109 /* The frame which should receive keystrokes that occur in this
110 frame, or nil if they should go to the frame itself. This is
111 usually nil, but if the frame is minibufferless, we can use this
112 to redirect keystrokes to a surrogate minibuffer frame when
115 Note that a value of nil is different than having the field point
116 to the frame itself. Whenever the Fselect_frame function is used
117 to shift from one frame to the other, any redirections to the
118 original frame are shifted to the newly selected frame; if
119 focus_frame is nil, Fselect_frame will leave it alone. */
120 Lisp_Object focus_frame
;
122 /* This frame's root window. Every frame has one.
123 If the frame has only a minibuffer window, this is it.
124 Otherwise, if the frame has a minibuffer window, this is its sibling. */
125 Lisp_Object root_window
;
127 /* This frame's selected window.
128 Each frame has its own window hierarchy
129 and one of the windows in it is selected within the frame.
130 The selected window of the selected frame is Emacs's selected window. */
131 Lisp_Object selected_window
;
133 /* This frame's minibuffer window.
134 Most frames have their own minibuffer windows,
135 but only the selected frame's minibuffer window
136 can actually appear to exist. */
137 Lisp_Object minibuffer_window
;
139 /* Parameter alist of this frame.
140 These are the parameters specified when creating the frame
141 or modified with modify-frame-parameters. */
142 Lisp_Object param_alist
;
144 /* List of scroll bars on this frame.
145 Actually, we don't specify exactly what is stored here at all; the
146 scroll bar implementation code can use it to store anything it likes.
147 This field is marked by the garbage collector. It is here
148 instead of in the `device' structure so that the garbage
149 collector doesn't need to look inside the window-system-dependent
151 Lisp_Object scroll_bars
;
152 Lisp_Object condemned_scroll_bars
;
154 /* Vector describing the items to display in the menu bar.
155 Each item has four elements in this vector.
156 They are KEY, STRING, SUBMAP, and HPOS.
157 (HPOS is not used in when the X toolkit is in use.)
158 There are four additional elements of nil at the end, to terminate. */
159 Lisp_Object menu_bar_items
;
161 /* Alist of elements (FACE-NAME . FACE-VECTOR-DATA). */
162 Lisp_Object face_alist
;
164 /* A vector that records the entire structure of this frame's menu bar.
165 For the format of the data, see extensive comments in xmenu.c.
166 Only the X toolkit version uses this. */
167 Lisp_Object menu_bar_vector
;
169 /* Predicate for selecting buffers for other-buffer. */
170 Lisp_Object buffer_predicate
;
172 /* List of buffers viewed in this frame, for other-buffer. */
173 Lisp_Object buffer_list
;
175 /* List of buffers that were viewed, then buried in this frame. The
176 most recently buried buffer is first. For last-buffer. */
177 Lisp_Object buried_buffer_list
;
179 /* A dummy window used to display menu bars under X when no X
180 toolkit support is available. */
181 Lisp_Object menu_bar_window
;
183 /* A window used to display the tool-bar of a frame. */
184 Lisp_Object tool_bar_window
;
186 /* Desired and current tool-bar items. */
187 Lisp_Object tool_bar_items
;
189 /* Where tool bar is, can be left, right, top or bottom. The native
190 tool bar only supports top. */
191 Lisp_Object tool_bar_position
;
193 /* Desired and current contents displayed in tool_bar_window. */
194 Lisp_Object desired_tool_bar_string
, current_tool_bar_string
;
196 /* Beyond here, there should be no more Lisp_Object components. */
198 /* Cache of realized faces. */
199 struct face_cache
*face_cache
;
201 /* Number of elements in `menu_bar_vector' that have meaningful data. */
202 EMACS_INT menu_bar_items_used
;
204 /* A buffer to hold the frame's name. We can't use the Lisp
205 string's pointer (`name', above) because it might get relocated. */
208 /* Glyph pool and matrix. */
209 struct glyph_pool
*current_pool
;
210 struct glyph_pool
*desired_pool
;
211 struct glyph_matrix
*desired_matrix
;
212 struct glyph_matrix
*current_matrix
;
214 /* 1 means that glyphs on this frame have been initialized so it can
215 be used for output. */
216 unsigned glyphs_initialized_p
: 1;
218 /* Set to non-zero in change_frame_size when size of frame changed
219 Clear the frame in clear_garbaged_frames if set. */
220 unsigned resized_p
: 1;
222 /* Set to non-zero in when we want for force a flush_display in
223 update_frame, usually after resizing the frame. */
224 unsigned force_flush_display_p
: 1;
226 /* Set to non-zero if the default face for the frame has been
227 realized. Reset to zero whenever the default face changes.
228 Used to see the difference between a font change and face change. */
229 unsigned default_face_done_p
: 1;
231 /* Set to non-zero if this frame has already been hscrolled during
232 current redisplay. */
233 unsigned already_hscrolled_p
: 1;
235 /* Set to non-zero when current redisplay has updated frame. */
236 unsigned updated_p
: 1;
238 /* Set to non-zero to minimize tool-bar height even when
239 auto-resize-tool-bar is set to grow-only. */
240 unsigned minimize_tool_bar_window_p
: 1;
242 #if defined (USE_GTK) || defined (HAVE_NS)
243 /* Nonzero means using a tool bar that comes from the toolkit. */
244 int external_tool_bar
;
247 /* Margin at the top of the frame. Used to display the tool-bar. */
251 int n_tool_bar_items
;
253 /* A buffer for decode_mode_line. */
254 char *decode_mode_spec_buffer
;
256 /* See do_line_insertion_deletion_costs for info on these arrays. */
257 /* Cost of inserting 1 line on this frame */
258 int *insert_line_cost
;
259 /* Cost of deleting 1 line on this frame */
260 int *delete_line_cost
;
261 /* Cost of inserting n lines on this frame */
262 int *insert_n_lines_cost
;
263 /* Cost of deleting n lines on this frame */
264 int *delete_n_lines_cost
;
266 /* Size of this frame, excluding fringes, scroll bars etc.,
267 in units of canonical characters. */
268 EMACS_INT text_lines
, text_cols
;
270 /* Total size of this frame (i.e. its native window), in units of
271 canonical characters. */
272 EMACS_INT total_lines
, total_cols
;
274 /* New text height and width for pending size change.
275 0 if no change pending. */
276 int new_text_lines
, new_text_cols
;
278 /* Pixel position of the frame window (x and y offsets in root window). */
279 int left_pos
, top_pos
;
281 /* Size of the frame window in pixels. */
282 int pixel_height
, pixel_width
;
284 /* Dots per inch of the screen the frame is on. */
287 /* These many pixels are the difference between the outer window (i.e. the
288 left and top of the window manager decoration) and FRAME_X_WINDOW. */
289 int x_pixels_diff
, y_pixels_diff
;
291 /* This is the gravity value for the specified window position. */
294 /* The geometry flags for this window. */
297 /* Border width of the frame window as known by the (X) window system. */
300 /* Width of the internal border. This is a line of background color
301 just inside the window's border. When the frame is selected,
302 a highlighting is displayed inside the internal border. */
303 int internal_border_width
;
305 /* Canonical X unit. Width of default font, in pixels. */
308 /* Width of space glyph of default font, in pixels. */
311 /* Canonical Y unit. Height of a line, in pixels. */
314 /* The output method says how the contents of this frame are
315 displayed. It could be using termcap, or using an X window.
316 This must be the same as the terminal->type. */
317 enum output_method output_method
;
319 /* The terminal device that this frame uses. If this is NULL, then
320 the frame has been deleted. */
321 struct terminal
*terminal
;
323 /* Device-dependent, frame-local auxiliary data used for displaying
324 the contents. When the frame is deleted, this data is deleted as
328 struct tty_output
*tty
; /* termchar.h */
329 struct x_output
*x
; /* xterm.h */
330 struct w32_output
*w32
; /* w32term.h */
331 struct ns_output
*ns
; /* nsterm.h */
336 /* List of font-drivers available on the frame. */
337 struct font_driver_list
*font_driver_list
;
338 /* List of data specific to font-driver and frame, but common to
340 struct font_data_list
*font_data_list
;
342 /* Total width of fringes reserved for drawing truncation bitmaps,
343 continuation bitmaps and alike. The width is in canonical char
344 units of the frame. This must currently be the case because window
345 sizes aren't pixel values. If it weren't the case, we wouldn't be
346 able to split windows horizontally nicely. */
349 /* The extra width (in pixels) currently allotted for fringes. */
350 int left_fringe_width
, right_fringe_width
;
352 /* See FULLSCREEN_ enum below */
353 enum fullscreen_type want_fullscreen
;
355 /* Number of lines of menu bar. */
358 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
359 || defined (HAVE_NS) || defined (USE_GTK)
360 /* Nonzero means using a menu bar that comes from the X toolkit. */
361 unsigned int external_menu_bar
: 1;
364 /* Nonzero if last attempt at redisplay on this frame was preempted. */
365 unsigned char display_preempted
: 1;
367 /* visible is nonzero if the frame is currently displayed; we check
368 it to see if we should bother updating the frame's contents.
369 DON'T SET IT DIRECTLY; instead, use FRAME_SET_VISIBLE.
371 Note that, since invisible frames aren't updated, whenever a
372 frame becomes visible again, it must be marked as garbaged. The
373 FRAME_SAMPLE_VISIBILITY macro takes care of this.
375 On ttys and on Windows NT/9X, to avoid wasting effort updating
376 visible frames that are actually completely obscured by other
377 windows on the display, we bend the meaning of visible slightly:
378 if greater than 1, then the frame is obscured - we still consider
379 it to be "visible" as seen from lisp, but we don't bother
380 updating it. We must take care to garbage the frame when it
381 ceaces to be obscured though.
383 iconified is nonzero if the frame is currently iconified.
385 Asynchronous input handlers should NOT change these directly;
386 instead, they should change async_visible or async_iconified, and
387 let the FRAME_SAMPLE_VISIBILITY macro set visible and iconified
388 at the next redisplay.
390 These should probably be considered read-only by everyone except
391 FRAME_SAMPLE_VISIBILITY.
393 These two are mutually exclusive. They might both be zero, if the
394 frame has been made invisible without an icon. */
395 unsigned char visible
: 2;
396 unsigned char iconified
: 1;
398 /* Let's not use bitfields for volatile variables. */
400 /* Asynchronous input handlers change these, and
401 FRAME_SAMPLE_VISIBILITY copies them into visible and iconified.
402 See FRAME_SAMPLE_VISIBILITY, below. */
403 volatile char async_visible
, async_iconified
;
405 /* Nonzero if this frame should be redrawn. */
406 volatile char garbaged
;
408 /* True if frame actually has a minibuffer window on it.
409 0 if using a minibuffer window that isn't on this frame. */
410 unsigned char has_minibuffer
: 1;
412 /* 0 means, if this frame has just one window,
413 show no modeline for that window. */
414 unsigned char wants_modeline
: 1;
416 /* Non-zero if the hardware device this frame is displaying on can
417 support scroll bars. */
418 char can_have_scroll_bars
;
420 /* Non-0 means raise this frame to the top of the heap when selected. */
421 unsigned char auto_raise
: 1;
423 /* Non-0 means lower this frame to the bottom of the stack when left. */
424 unsigned char auto_lower
: 1;
426 /* True if frame's root window can't be split. */
427 unsigned char no_split
: 1;
429 /* If this is set, then Emacs won't change the frame name to indicate
430 the current buffer, etcetera. If the user explicitly sets the frame
431 name, this gets set. If the user sets the name to Qnil, this is
433 unsigned char explicit_name
: 1;
435 /* Nonzero if size of some window on this frame has changed. */
436 unsigned char window_sizes_changed
: 1;
438 /* Nonzero if the mouse has moved on this display device
439 since the last time we checked. */
440 unsigned char mouse_moved
:1;
442 /* Nonzero means that the pointer is invisible. */
443 unsigned char pointer_invisible
:1;
445 /* If can_have_scroll_bars is non-zero, this is non-zero if we should
446 actually display them on this frame. */
447 enum vertical_scroll_bar_type vertical_scroll_bar_type
;
449 /* What kind of text cursor should we draw in the future?
450 This should always be filled_box_cursor or bar_cursor. */
451 enum text_cursor_kinds desired_cursor
;
453 /* Width of bar cursor (if we are using that). */
456 /* What kind of text cursor should we draw when the cursor blinks off?
457 This can be filled_box_cursor or bar_cursor or no_cursor. */
458 enum text_cursor_kinds blink_off_cursor
;
460 /* Width of bar cursor (if we are using that) for blink-off state. */
461 int blink_off_cursor_width
;
463 /* Storage for messages to this frame. */
466 /* Nonnegative if current redisplay should not do scroll computation
467 for lines beyond a certain vpos. This is the vpos. */
468 int scroll_bottom_vpos
;
470 /* Configured width of the scroll bar, in pixels and in characters.
471 config_scroll_bar_cols tracks config_scroll_bar_width if the
472 latter is positive; a zero value in config_scroll_bar_width means
473 to compute the actual width on the fly, using config_scroll_bar_cols
474 and the current font width. */
475 int config_scroll_bar_width
;
476 int config_scroll_bar_cols
;
478 /* The size of the extra width currently allotted for vertical
479 scroll bars in this frame, in pixels. */
480 int scroll_bar_actual_width
;
482 /* The baud rate that was used to calculate costs for this frame. */
483 int cost_calculation_baud_rate
;
486 alpha[0]: alpha transparency of the active frame
487 alpha[1]: alpha transparency of inactive frames
488 Negative values mean not to change alpha. */
491 /* Exponent for gamma correction of colors. 1/(VIEWING_GAMMA *
492 SCREEN_GAMMA) where viewing_gamma is 0.4545 and SCREEN_GAMMA is a
493 frame parameter. 0 means don't do gamma correction. */
496 /* Additional space to put between text lines on this frame. */
497 int extra_line_spacing
;
499 /* All display backends seem to need these two pixel values. */
500 unsigned long background_pixel
;
501 unsigned long foreground_pixel
;
504 #define FRAME_KBOARD(f) ((f)->terminal->kboard)
506 /* Return a pointer to the image cache of frame F. */
507 #define FRAME_IMAGE_CACHE(F) ((F)->terminal->image_cache)
509 typedef struct frame
*FRAME_PTR
;
511 #define XFRAME(p) (eassert (FRAMEP(p)),(struct frame *) XPNTR (p))
512 #define XSETFRAME(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_FRAME))
514 /* Given a window, return its frame as a Lisp_Object. */
515 #define WINDOW_FRAME(w) (w)->frame
517 /* Test a frame for particular kinds of display methods. */
518 #define FRAME_INITIAL_P(f) ((f)->output_method == output_initial)
519 #define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap)
520 #define FRAME_X_P(f) ((f)->output_method == output_x_window)
521 #define FRAME_W32_P(f) ((f)->output_method == output_w32)
522 #define FRAME_MSDOS_P(f) ((f)->output_method == output_msdos_raw)
523 #define FRAME_MAC_P(f) ((f)->output_method == output_mac)
524 #define FRAME_NS_P(f) ((f)->output_method == output_ns)
526 /* FRAME_WINDOW_P tests whether the frame is a window, and is
527 defined to be the predicate for the window system being used. */
529 #ifdef HAVE_X_WINDOWS
530 #define FRAME_WINDOW_P(f) FRAME_X_P (f)
533 #define FRAME_WINDOW_P(f) FRAME_W32_P (f)
536 #define FRAME_WINDOW_P(f) FRAME_NS_P(f)
538 #ifndef FRAME_WINDOW_P
539 #define FRAME_WINDOW_P(f) (0)
542 /* Return a pointer to the structure holding information about the
543 region of text, if any, that is currently shown in mouse-face on
544 frame F. We need to define two versions because a TTY-only build
545 does not have FRAME_X_DISPLAY_INFO. */
546 #ifdef HAVE_WINDOW_SYSTEM
547 # define MOUSE_HL_INFO(F) \
549 ? &(FRAME_X_DISPLAY_INFO(F)->mouse_highlight) \
550 : &(((F)->output_data.tty->display_info)->mouse_highlight))
552 # define MOUSE_HL_INFO(F) \
553 (&(((F)->output_data.tty->display_info)->mouse_highlight))
556 /* Nonzero if frame F is still alive (not deleted). */
557 #define FRAME_LIVE_P(f) ((f)->terminal != 0)
559 /* Nonzero if frame F is a minibuffer-only frame. */
560 #define FRAME_MINIBUF_ONLY_P(f) \
561 EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f))
563 /* Nonzero if frame F contains a minibuffer window.
564 (If this is 0, F must use some other minibuffer window.) */
565 #define FRAME_HAS_MINIBUF_P(f) ((f)->has_minibuffer)
567 /* Pixel height of frame F, including non-toolkit menu bar and
568 non-toolkit tool bar lines. */
569 #define FRAME_PIXEL_HEIGHT(f) ((f)->pixel_height)
571 /* Pixel width of frame F. */
572 #define FRAME_PIXEL_WIDTH(f) ((f)->pixel_width)
574 /* Height of frame F, measured in canonical lines, including
575 non-toolkit menu bar and non-toolkit tool bar lines. */
576 #define FRAME_LINES(f) (f)->text_lines
578 /* Width of frame F, measured in canonical character columns,
579 not including scroll bars if any. */
580 #define FRAME_COLS(f) (f)->text_cols
582 /* Number of lines of frame F used for menu bar.
583 This is relevant on terminal frames and on
584 X Windows when not using the X toolkit.
585 These lines are counted in FRAME_LINES. */
586 #define FRAME_MENU_BAR_LINES(f) (f)->menu_bar_lines
588 /* Nonzero if this frame should display a tool bar
589 in a way that does not use any text lines. */
590 #if defined (USE_GTK) || defined (HAVE_NS)
591 #define FRAME_EXTERNAL_TOOL_BAR(f) (f)->external_tool_bar
593 #define FRAME_EXTERNAL_TOOL_BAR(f) 0
596 /* Number of lines of frame F used for the tool-bar. */
598 #define FRAME_TOOL_BAR_LINES(f) (f)->tool_bar_lines
601 /* Lines above the top-most window in frame F. */
603 #define FRAME_TOP_MARGIN(F) \
604 (FRAME_MENU_BAR_LINES (F) + FRAME_TOOL_BAR_LINES (F))
606 /* Pixel height of the top margin above. */
608 #define FRAME_TOP_MARGIN_HEIGHT(f) \
609 (FRAME_TOP_MARGIN (f) * FRAME_LINE_HEIGHT (f))
611 /* Nonzero if this frame should display a menu bar
612 in a way that does not use any text lines. */
613 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
614 || defined (HAVE_NS) || defined (USE_GTK)
615 #define FRAME_EXTERNAL_MENU_BAR(f) (f)->external_menu_bar
617 #define FRAME_EXTERNAL_MENU_BAR(f) 0
619 #define FRAME_VISIBLE_P(f) ((f)->visible != 0)
621 /* Nonzero if frame F is currently visible but hidden. */
622 #define FRAME_OBSCURED_P(f) ((f)->visible > 1)
624 /* Nonzero if frame F is currently iconified. */
625 #define FRAME_ICONIFIED_P(f) (f)->iconified
627 #define FRAME_SET_VISIBLE(f,p) \
628 ((f)->async_visible = (p), FRAME_SAMPLE_VISIBILITY (f))
629 #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1, f->garbaged = 1)
630 #define FRAME_GARBAGED_P(f) (f)->garbaged
632 /* Nonzero means do not allow splitting this frame's window. */
633 #define FRAME_NO_SPLIT_P(f) (f)->no_split
635 /* Not really implemented. */
636 #define FRAME_WANTS_MODELINE_P(f) (f)->wants_modeline
638 /* Nonzero if a size change has been requested for frame F
639 but not yet really put into effect. This can be true temporarily
640 when an X event comes in at a bad time. */
641 #define FRAME_WINDOW_SIZES_CHANGED(f) (f)->window_sizes_changed
643 /* The minibuffer window of frame F, if it has one; otherwise nil. */
644 #define FRAME_MINIBUF_WINDOW(f) (f)->minibuffer_window
646 /* The root window of the window tree of frame F. */
647 #define FRAME_ROOT_WINDOW(f) (f)->root_window
649 /* The currently selected window of the window tree of frame F. */
650 #define FRAME_SELECTED_WINDOW(f) (f)->selected_window
652 #define FRAME_INSERT_COST(f) (f)->insert_line_cost
653 #define FRAME_DELETE_COST(f) (f)->delete_line_cost
654 #define FRAME_INSERTN_COST(f) (f)->insert_n_lines_cost
655 #define FRAME_DELETEN_COST(f) (f)->delete_n_lines_cost
656 #define FRAME_MESSAGE_BUF(f) (f)->message_buf
657 #define FRAME_SCROLL_BOTTOM_VPOS(f) (f)->scroll_bottom_vpos
658 #define FRAME_FOCUS_FRAME(f) (f)->focus_frame
660 /* Nonzero if frame F supports scroll bars.
661 If this is zero, then it is impossible to enable scroll bars
663 #define FRAME_CAN_HAVE_SCROLL_BARS(f) ((f)->can_have_scroll_bars)
665 /* This frame slot says whether scroll bars are currently enabled for frame F,
666 and which side they are on. */
667 #define FRAME_VERTICAL_SCROLL_BAR_TYPE(f) ((f)->vertical_scroll_bar_type)
668 #define FRAME_HAS_VERTICAL_SCROLL_BARS(f) \
669 ((f)->vertical_scroll_bar_type != vertical_scroll_bar_none)
670 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT(f) \
671 ((f)->vertical_scroll_bar_type == vertical_scroll_bar_left)
672 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT(f) \
673 ((f)->vertical_scroll_bar_type == vertical_scroll_bar_right)
675 /* Width that a scroll bar in frame F should have, if there is one.
677 If scroll bars are turned off, this is still nonzero. */
678 #define FRAME_CONFIG_SCROLL_BAR_WIDTH(f) ((f)->config_scroll_bar_width)
680 /* Width that a scroll bar in frame F should have, if there is one.
681 Measured in columns (characters).
682 If scroll bars are turned off, this is still nonzero. */
683 #define FRAME_CONFIG_SCROLL_BAR_COLS(f) ((f)->config_scroll_bar_cols)
685 /* Width of a scroll bar in frame F, measured in columns (characters),
686 but only if scroll bars are on the left. If scroll bars are on
687 the right in this frame, or there are no scroll bars, value is 0. */
689 #define FRAME_LEFT_SCROLL_BAR_COLS(f) \
690 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \
691 ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
694 /* Width of a left scroll bar in frame F, measured in pixels */
696 #define FRAME_LEFT_SCROLL_BAR_AREA_WIDTH(f) \
697 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \
698 ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)) \
701 /* Width of a scroll bar in frame F, measured in columns (characters),
702 but only if scroll bars are on the right. If scroll bars are on
703 the left in this frame, or there are no scroll bars, value is 0. */
705 #define FRAME_RIGHT_SCROLL_BAR_COLS(f) \
706 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f) \
707 ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
710 /* Width of a right scroll bar area in frame F, measured in pixels */
712 #define FRAME_RIGHT_SCROLL_BAR_AREA_WIDTH(f) \
713 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f) \
714 ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)) \
717 /* Actual width of a scroll bar in frame F, measured in columns. */
719 #define FRAME_SCROLL_BAR_COLS(f) \
720 (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \
721 ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
724 /* Actual width of a scroll bar area in frame F, measured in pixels. */
726 #define FRAME_SCROLL_BAR_AREA_WIDTH(f) \
727 (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \
728 ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)) \
731 /* Total width of frame F, in columns (characters),
732 including the width used by scroll bars if any. */
734 #define FRAME_TOTAL_COLS(f) ((f)->total_cols)
736 /* Set the width of frame F to VAL.
737 VAL is the width of a full-frame window,
738 not including scroll bars and fringes. */
740 #define SET_FRAME_COLS(f, val) \
741 (FRAME_COLS (f) = (val), \
742 (f)->total_cols = FRAME_TOTAL_COLS_ARG (f, FRAME_COLS (f)))
744 /* Given a value WIDTH for frame F's nominal width,
745 return the value that FRAME_TOTAL_COLS should have. */
747 #define FRAME_TOTAL_COLS_ARG(f, width) \
749 + FRAME_SCROLL_BAR_COLS (f) \
750 + FRAME_FRINGE_COLS (f))
752 /* Maximum + 1 legitimate value for FRAME_CURSOR_X. */
754 #define FRAME_CURSOR_X_LIMIT(f) \
755 (FRAME_COLS (f) + FRAME_LEFT_SCROLL_BAR_COLS (f))
757 /* Nonzero if frame F has scroll bars. */
759 #define FRAME_SCROLL_BARS(f) ((f)->scroll_bars)
761 #define FRAME_CONDEMNED_SCROLL_BARS(f) ((f)->condemned_scroll_bars)
762 #define FRAME_MENU_BAR_ITEMS(f) ((f)->menu_bar_items)
763 #define FRAME_COST_BAUD_RATE(f) ((f)->cost_calculation_baud_rate)
765 #define FRAME_DESIRED_CURSOR(f) ((f)->desired_cursor)
766 #define FRAME_BLINK_OFF_CURSOR(f) ((f)->blink_off_cursor)
767 #define FRAME_CURSOR_WIDTH(f) ((f)->cursor_width)
768 #define FRAME_BLINK_OFF_CURSOR_WIDTH(f) ((f)->blink_off_cursor_width)
770 /* Return a pointer to the face cache of frame F. */
772 #define FRAME_FACE_CACHE(F) (F)->face_cache
774 /* Return the size of message_buf of the frame F. We multiply the
775 width of the frame by 4 because multi-byte form may require at most
776 4-byte for a character. */
778 #define FRAME_MESSAGE_BUF_SIZE(f) (((int) FRAME_COLS (f)) * 4)
780 /* Emacs's redisplay code could become confused if a frame's
781 visibility changes at arbitrary times. For example, if a frame is
782 visible while the desired glyphs are being built, but becomes
783 invisible before they are updated, then some rows of the
784 desired_glyphs will be left marked as enabled after redisplay is
785 complete, which should never happen. The next time the frame
786 becomes visible, redisplay will probably barf.
788 Currently, there are no similar situations involving iconified, but
789 the principle is the same.
791 So instead of having asynchronous input handlers directly set and
792 clear the frame's visibility and iconification flags, they just set
793 the async_visible and async_iconified flags; the redisplay code
794 calls the FRAME_SAMPLE_VISIBILITY macro before doing any redisplay,
795 which sets visible and iconified from their asynchronous
798 Synchronous code must use the FRAME_SET_VISIBLE macro.
800 Also, if a frame used to be invisible, but has just become visible,
801 it must be marked as garbaged, since redisplay hasn't been keeping
804 Note that a tty frame is visible if and only if it is the topmost
807 #define FRAME_SAMPLE_VISIBILITY(f) \
808 (((f)->async_visible && (f)->visible != (f)->async_visible) ? \
809 SET_FRAME_GARBAGED (f) : 0, \
810 (f)->visible = (f)->async_visible, \
811 (f)->iconified = (f)->async_iconified)
813 #define CHECK_FRAME(x) \
814 CHECK_TYPE (FRAMEP (x), Qframep, x)
816 #define CHECK_LIVE_FRAME(x) \
817 CHECK_TYPE (FRAMEP (x) && FRAME_LIVE_P (XFRAME (x)), Qframe_live_p, x)
819 /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
820 `for' loop which iterates over the elements of Vframe_list. The
821 loop will set FRAME_VAR, a Lisp_Object, to each frame in
822 Vframe_list in succession and execute the statement. LIST_VAR
823 should be a Lisp_Object too; it is used to iterate through the
826 This macro is a holdover from a time when multiple frames weren't always
827 supported. An alternate definition of the macro would expand to
828 something which executes the statement once. */
830 #define FOR_EACH_FRAME(list_var, frame_var) \
831 for ((list_var) = Vframe_list; \
833 && (frame_var = XCAR (list_var), 1)); \
834 list_var = XCDR (list_var))
837 extern Lisp_Object Qframep
, Qframe_live_p
;
838 extern Lisp_Object Qtty
, Qtty_type
;
839 extern Lisp_Object Qtty_color_mode
;
840 extern Lisp_Object Qterminal
, Qterminal_live_p
;
841 extern Lisp_Object Qnoelisp
;
843 extern struct frame
*last_nonminibuf_frame
;
845 extern struct frame
*make_initial_frame (void);
846 extern struct frame
*make_terminal_frame (struct terminal
*);
847 extern struct frame
*make_frame (int);
848 #ifdef HAVE_WINDOW_SYSTEM
849 extern struct frame
*make_minibuffer_frame (void);
850 extern struct frame
*make_frame_without_minibuffer (Lisp_Object
,
853 #endif /* HAVE_WINDOW_SYSTEM */
854 extern int other_visible_frames (struct frame
*);
855 extern void frame_make_pointer_invisible (void);
856 extern void frame_make_pointer_visible (void);
857 extern Lisp_Object
delete_frame (Lisp_Object
, Lisp_Object
);
859 extern Lisp_Object Vframe_list
;
861 /* The currently selected frame. */
863 extern Lisp_Object selected_frame
;
865 /* Value is a pointer to the selected frame. If the selected frame
866 isn't live, abort. */
868 #define SELECTED_FRAME() \
869 ((FRAMEP (selected_frame) \
870 && FRAME_LIVE_P (XFRAME (selected_frame))) \
871 ? XFRAME (selected_frame) \
872 : (abort (), (struct frame *) 0))
875 /***********************************************************************
876 Display-related Macros
877 ***********************************************************************/
879 /* Canonical y-unit on frame F.
880 This value currently equals the line height of the frame (which is
881 the height of the default font of F). */
883 #define FRAME_LINE_HEIGHT(F) ((F)->line_height)
885 /* Canonical x-unit on frame F.
886 This value currently equals the average width of the default font of F. */
888 #define FRAME_COLUMN_WIDTH(F) ((F)->column_width)
890 /* Space glyph width of the default font of frame F. */
892 #define FRAME_SPACE_WIDTH(F) ((F)->space_width)
895 /* Pixel width of areas used to display truncation marks, continuation
896 marks, overlay arrows. This is 0 for terminal frames. */
898 #ifdef HAVE_WINDOW_SYSTEM
900 /* Total width of fringes reserved for drawing truncation bitmaps,
901 continuation bitmaps and alike. The width is in canonical char
902 units of the frame. This must currently be the case because window
903 sizes aren't pixel values. If it weren't the case, we wouldn't be
904 able to split windows horizontally nicely. */
906 #define FRAME_FRINGE_COLS(F) ((F)->fringe_cols)
908 /* Pixel-width of the left and right fringe. */
910 #define FRAME_LEFT_FRINGE_WIDTH(F) ((F)->left_fringe_width)
911 #define FRAME_RIGHT_FRINGE_WIDTH(F) ((F)->right_fringe_width)
913 /* Total width of fringes in pixels. */
915 #define FRAME_TOTAL_FRINGE_WIDTH(F) \
916 (FRAME_LEFT_FRINGE_WIDTH (F) + FRAME_RIGHT_FRINGE_WIDTH (F))
919 /* Pixel-width of internal border lines */
921 #define FRAME_INTERNAL_BORDER_WIDTH(F) ((F)->internal_border_width)
923 #else /* not HAVE_WINDOW_SYSTEM */
925 #define FRAME_FRINGE_COLS(F) 0
926 #define FRAME_TOTAL_FRINGE_WIDTH(F) 0
927 #define FRAME_LEFT_FRINGE_WIDTH(F) 0
928 #define FRAME_RIGHT_FRINGE_WIDTH(F) 0
929 #define FRAME_INTERNAL_BORDER_WIDTH(F) 0
931 #endif /* not HAVE_WINDOW_SYSTEM */
936 /***********************************************************************
937 Conversion between canonical units and pixels
938 ***********************************************************************/
940 /* Canonical x-values are fractions of FRAME_COLUMN_WIDTH, canonical
941 y-unit are fractions of FRAME_LINE_HEIGHT of a frame. Both are
942 represented as Lisp numbers, i.e. integers or floats. */
944 /* Convert canonical value X to pixels. F is the frame whose
945 canonical char width is to be used. X must be a Lisp integer or
946 float. Value is a C integer. */
948 #define FRAME_PIXEL_X_FROM_CANON_X(F, X) \
950 ? XINT (X) * FRAME_COLUMN_WIDTH (F) \
951 : (int) (XFLOAT_DATA (X) * FRAME_COLUMN_WIDTH (F)))
953 /* Convert canonical value Y to pixels. F is the frame whose
954 canonical character height is to be used. X must be a Lisp integer
955 or float. Value is a C integer. */
957 #define FRAME_PIXEL_Y_FROM_CANON_Y(F, Y) \
959 ? XINT (Y) * FRAME_LINE_HEIGHT (F) \
960 : (int) (XFLOAT_DATA (Y) * FRAME_LINE_HEIGHT (F)))
962 /* Convert pixel-value X to canonical units. F is the frame whose
963 canonical character width is to be used. X is a C integer. Result
964 is a Lisp float if X is not a multiple of the canon width,
965 otherwise it's a Lisp integer. */
967 #define FRAME_CANON_X_FROM_PIXEL_X(F, X) \
968 ((X) % FRAME_COLUMN_WIDTH (F) != 0 \
969 ? make_float ((double) (X) / FRAME_COLUMN_WIDTH (F)) \
970 : make_number ((X) / FRAME_COLUMN_WIDTH (F)))
972 /* Convert pixel-value Y to canonical units. F is the frame whose
973 canonical character height is to be used. Y is a C integer.
974 Result is a Lisp float if Y is not a multiple of the canon width,
975 otherwise it's a Lisp integer. */
977 #define FRAME_CANON_Y_FROM_PIXEL_Y(F, Y) \
978 ((Y) % FRAME_LINE_HEIGHT (F) \
979 ? make_float ((double) (Y) / FRAME_LINE_HEIGHT (F)) \
980 : make_number ((Y) / FRAME_LINE_HEIGHT (F)))
984 /* Manipulating pixel sizes and character sizes.
985 Knowledge of which factors affect the overall size of the window should
986 be hidden in these macros, if that's possible.
988 Return the upper/left pixel position of the character cell on frame F
991 #define FRAME_LINE_TO_PIXEL_Y(f, row) \
992 (((row) < FRAME_TOP_MARGIN (f) ? 0 : FRAME_INTERNAL_BORDER_WIDTH (f)) \
993 + (row) * FRAME_LINE_HEIGHT (f))
995 #define FRAME_COL_TO_PIXEL_X(f, col) \
996 (FRAME_INTERNAL_BORDER_WIDTH (f) \
997 + (col) * FRAME_COLUMN_WIDTH (f))
999 /* Return the pixel width/height of frame F if it has
1000 COLS columns/LINES rows. */
1002 #define FRAME_TEXT_COLS_TO_PIXEL_WIDTH(f, cols) \
1003 (FRAME_COL_TO_PIXEL_X (f, cols) \
1004 + (f)->scroll_bar_actual_width \
1005 + FRAME_TOTAL_FRINGE_WIDTH (f) \
1006 + FRAME_INTERNAL_BORDER_WIDTH (f))
1008 #define FRAME_TEXT_LINES_TO_PIXEL_HEIGHT(f, lines) \
1009 ((lines) * FRAME_LINE_HEIGHT (f) \
1010 + 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
1013 /* Return the row/column (zero-based) of the character cell containing
1014 the pixel on FRAME at Y/X. */
1016 #define FRAME_PIXEL_Y_TO_LINE(f, y) \
1017 (((y) < FRAME_TOP_MARGIN_HEIGHT (f) \
1019 : ((y) < FRAME_TOP_MARGIN_HEIGHT (f) + FRAME_INTERNAL_BORDER_WIDTH (f) \
1020 ? (y) - (FRAME_TOP_MARGIN_HEIGHT (f) + FRAME_INTERNAL_BORDER_WIDTH (f) \
1021 /* Arrange for the division to round down. */ \
1022 + FRAME_LINE_HEIGHT (f) - 1) \
1023 : (y) - FRAME_INTERNAL_BORDER_WIDTH (f))) \
1024 / FRAME_LINE_HEIGHT (f))
1026 #define FRAME_PIXEL_X_TO_COL(f, x) \
1027 (((x) - FRAME_INTERNAL_BORDER_WIDTH (f)) \
1028 / FRAME_COLUMN_WIDTH (f))
1030 /* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
1033 #define FRAME_PIXEL_WIDTH_TO_TEXT_COLS(f, width) \
1034 (FRAME_PIXEL_X_TO_COL (f, ((width) \
1035 - FRAME_INTERNAL_BORDER_WIDTH (f) \
1036 - FRAME_TOTAL_FRINGE_WIDTH (f) \
1037 - (f)->scroll_bar_actual_width)))
1039 #define FRAME_PIXEL_HEIGHT_TO_TEXT_LINES(f, height) \
1040 (FRAME_PIXEL_Y_TO_LINE (f, ((height) \
1041 - FRAME_INTERNAL_BORDER_WIDTH (f))))
1044 /***********************************************************************
1046 ***********************************************************************/
1048 extern Lisp_Object Qauto_raise
, Qauto_lower
;
1049 extern Lisp_Object Qborder_color
, Qborder_width
;
1050 extern Lisp_Object Qbuffer_predicate
, Qbuffer_list
, Qburied_buffer_list
;
1051 extern Lisp_Object Qcursor_color
, Qcursor_type
;
1052 extern Lisp_Object Qfont
;
1053 extern Lisp_Object Qbackground_color
, Qforeground_color
;
1054 extern Lisp_Object Qicon
, Qicon_name
, Qicon_type
, Qicon_left
, Qicon_top
;
1055 extern Lisp_Object Qinternal_border_width
;
1056 extern Lisp_Object Qtooltip
;
1057 extern Lisp_Object Qmenu_bar_lines
, Qtool_bar_lines
, Qtool_bar_position
;
1058 extern Lisp_Object Qmouse_color
;
1059 extern Lisp_Object Qname
, Qtitle
;
1060 extern Lisp_Object Qparent_id
;
1061 extern Lisp_Object Qunsplittable
, Qvisibility
;
1062 extern Lisp_Object Qscroll_bar_width
, Qvertical_scroll_bars
;
1063 extern Lisp_Object Qscroll_bar_foreground
, Qscroll_bar_background
;
1064 extern Lisp_Object Qscreen_gamma
;
1065 extern Lisp_Object Qline_spacing
;
1066 extern Lisp_Object Qwait_for_wm
;
1067 extern Lisp_Object Qfullscreen
;
1068 extern Lisp_Object Qfullwidth
, Qfullheight
, Qfullboth
, Qmaximized
;
1069 extern Lisp_Object Qsticky
;
1070 extern Lisp_Object Qfont_backend
;
1071 extern Lisp_Object Qalpha
;
1073 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
1074 extern Lisp_Object Qheight
, Qwidth
;
1075 extern Lisp_Object Qminibuffer
, Qmodeline
;
1076 extern Lisp_Object Qx
, Qw32
, Qmac
, Qpc
, Qns
;
1077 extern Lisp_Object Qvisible
;
1078 extern Lisp_Object Qdisplay_type
;
1079 extern Lisp_Object Qbackground_mode
;
1081 extern Lisp_Object Qx_resource_name
;
1083 extern Lisp_Object Qleft
, Qright
, Qtop
, Qbox
, Qbottom
;
1084 extern Lisp_Object Qdisplay
;
1086 extern Lisp_Object Qrun_hook_with_args
;
1088 #ifdef HAVE_WINDOW_SYSTEM
1090 /* The class of this X application. */
1091 #define EMACS_CLASS "Emacs"
1093 /* These are in xterm.c, w32term.c, etc. */
1095 extern void x_set_scroll_bar_default_width (struct frame
*);
1096 extern void x_set_offset (struct frame
*, int, int, int);
1097 extern void x_wm_set_icon_position (struct frame
*, int, int);
1099 extern Lisp_Object
x_new_font (struct frame
*, Lisp_Object
, int);
1102 extern Lisp_Object Qface_set_after_frame_default
;
1104 extern void x_fullscreen_adjust (struct frame
*f
, int *, int *,
1107 extern void x_set_frame_parameters (struct frame
*, Lisp_Object
);
1108 extern void x_report_frame_params (struct frame
*, Lisp_Object
*);
1110 extern void x_set_fullscreen (struct frame
*, Lisp_Object
, Lisp_Object
);
1111 extern void x_set_line_spacing (struct frame
*, Lisp_Object
, Lisp_Object
);
1112 extern void x_set_screen_gamma (struct frame
*, Lisp_Object
, Lisp_Object
);
1113 extern void x_set_font (struct frame
*, Lisp_Object
, Lisp_Object
);
1114 extern void x_set_font_backend (struct frame
*, Lisp_Object
, Lisp_Object
);
1115 extern void x_set_fringe_width (struct frame
*, Lisp_Object
, Lisp_Object
);
1116 extern void x_set_border_width (struct frame
*, Lisp_Object
, Lisp_Object
);
1117 extern void x_set_internal_border_width (struct frame
*, Lisp_Object
,
1119 extern void x_set_visibility (struct frame
*, Lisp_Object
, Lisp_Object
);
1120 extern void x_set_autoraise (struct frame
*, Lisp_Object
, Lisp_Object
);
1121 extern void x_set_autolower (struct frame
*, Lisp_Object
, Lisp_Object
);
1122 extern void x_set_unsplittable (struct frame
*, Lisp_Object
, Lisp_Object
);
1123 extern void x_set_vertical_scroll_bars (struct frame
*, Lisp_Object
,
1125 extern void x_set_scroll_bar_width (struct frame
*, Lisp_Object
,
1128 extern Lisp_Object
x_icon_type (struct frame
*);
1130 extern int x_figure_window_size (struct frame
*, Lisp_Object
, int);
1132 extern void x_set_alpha (struct frame
*, Lisp_Object
, Lisp_Object
);
1134 extern void validate_x_resource_name (void);
1136 extern Lisp_Object
display_x_get_resource (Display_Info
*,
1137 Lisp_Object attribute
,
1139 Lisp_Object component
,
1140 Lisp_Object subclass
);
1143 extern void set_frame_menubar (FRAME_PTR
, int, int);
1145 #endif /* HAVE_WINDOW_SYSTEM */
1147 #endif /* not EMACS_FRAME_H */