1 /* Define frame-object for GNU Emacs.
2 Copyright (C) 1993, 1994, 1999, 2000, 2001, 2002, 2003, 2004,
3 2005, 2006, 2007 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, or (at your option)
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; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
22 /* Don't multiply include: dispextern.h includes macterm.h which
23 includes frame.h some emacs source includes both dispextern.h and
32 /* Nonzero means don't assume anything about current contents of
33 actual terminal frame */
35 extern int frame_garbaged
;
37 /* Nonzero means FRAME_MESSAGE_BUF (selected_frame) is being used by
40 extern int message_buf_print
;
43 /* 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
71 #if !defined(MSDOS) && !defined(WINDOWSNT) && !defined(MAC_OS)
73 #if !defined(HAVE_X_WINDOWS)
75 #define PIX_TYPE unsigned long
77 /* A (mostly empty) x_output structure definition for building Emacs
78 on Unix and GNU/Linux without X support. */
81 PIX_TYPE background_pixel
;
82 PIX_TYPE foreground_pixel
;
85 #endif /* ! HAVE_X_WINDOWS */
88 #define FRAME_FOREGROUND_PIXEL(f) ((f)->output_data.x->foreground_pixel)
89 #define FRAME_BACKGROUND_PIXEL(f) ((f)->output_data.x->background_pixel)
91 /* A structure describing a termcap frame display. */
92 extern struct x_output tty_display
;
94 #endif /* ! MSDOS && ! WINDOWSNT && ! MAC_OS */
99 struct Lisp_Vector
*next
;
101 /* All Lisp_Object components must come first.
102 Only EMACS_INT values can be intermixed with them.
103 That ensures they are all aligned normally. */
105 /* Name of this frame: a Lisp string. It is used for looking up resources,
106 as well as for the title in some cases. */
109 /* The name to use for the icon, the last time
110 it was refreshed. nil means not explicitly specified. */
111 Lisp_Object icon_name
;
113 /* This is the frame title specified explicitly, if any.
114 Usually it is nil. */
117 /* The frame which should receive keystrokes that occur in this
118 frame, or nil if they should go to the frame itself. This is
119 usually nil, but if the frame is minibufferless, we can use this
120 to redirect keystrokes to a surrogate minibuffer frame when
123 Note that a value of nil is different than having the field point
124 to the frame itself. Whenever the Fselect_frame function is used
125 to shift from one frame to the other, any redirections to the
126 original frame are shifted to the newly selected frame; if
127 focus_frame is nil, Fselect_frame will leave it alone. */
128 Lisp_Object focus_frame
;
130 /* This frame's root window. Every frame has one.
131 If the frame has only a minibuffer window, this is it.
132 Otherwise, if the frame has a minibuffer window, this is its sibling. */
133 Lisp_Object root_window
;
135 /* This frame's selected window.
136 Each frame has its own window hierarchy
137 and one of the windows in it is selected within the frame.
138 The selected window of the selected frame is Emacs's selected window. */
139 Lisp_Object selected_window
;
141 /* This frame's minibuffer window.
142 Most frames have their own minibuffer windows,
143 but only the selected frame's minibuffer window
144 can actually appear to exist. */
145 Lisp_Object minibuffer_window
;
147 /* Parameter alist of this frame.
148 These are the parameters specified when creating the frame
149 or modified with modify-frame-parameters. */
150 Lisp_Object param_alist
;
152 /* List of scroll bars on this frame.
153 Actually, we don't specify exactly what is stored here at all; the
154 scroll bar implementation code can use it to store anything it likes.
155 This field is marked by the garbage collector. It is here
156 instead of in the `display' structure so that the garbage
157 collector doesn't need to look inside the window-system-dependent
159 Lisp_Object scroll_bars
;
160 Lisp_Object condemned_scroll_bars
;
162 /* Vector describing the items to display in the menu bar.
163 Each item has four elements in this vector.
164 They are KEY, STRING, SUBMAP, and HPOS.
165 (HPOS is not used in when the X toolkit is in use.)
166 There are four additional elements of nil at the end, to terminate. */
167 Lisp_Object menu_bar_items
;
169 /* Alist of elements (FACE-NAME . FACE-VECTOR-DATA). */
170 Lisp_Object face_alist
;
172 /* A vector that records the entire structure of this frame's menu bar.
173 For the format of the data, see extensive comments in xmenu.c.
174 Only the X toolkit version uses this. */
175 Lisp_Object menu_bar_vector
;
176 /* Number of elements in the vector that have meaningful data. */
177 EMACS_INT menu_bar_items_used
;
179 /* Predicate for selecting buffers for other-buffer. */
180 Lisp_Object buffer_predicate
;
182 /* List of buffers viewed in this frame, for other-buffer. */
183 Lisp_Object buffer_list
;
185 /* A dummy window used to display menu bars under X when no X
186 toolkit support is available. */
187 Lisp_Object menu_bar_window
;
189 /* A window used to display the tool-bar of a frame. */
190 Lisp_Object tool_bar_window
;
192 /* Desired and current tool-bar items. */
193 Lisp_Object tool_bar_items
;
195 /* Desired and current contents displayed in tool_bar_window. */
196 Lisp_Object desired_tool_bar_string
, current_tool_bar_string
;
198 /* beyond here, there should be no more Lisp_Object components. */
200 /* Cache of realized faces. */
201 struct face_cache
*face_cache
;
203 /* A buffer to hold the frame's name. We can't use the Lisp
204 string's pointer (`name', above) because it might get relocated. */
207 /* Glyph pool and matrix. */
208 struct glyph_pool
*current_pool
;
209 struct glyph_pool
*desired_pool
;
210 struct glyph_matrix
*desired_matrix
;
211 struct glyph_matrix
*current_matrix
;
213 /* 1 means that glyphs on this frame have been initialized so it can
214 be used for output. */
215 unsigned glyphs_initialized_p
: 1;
217 #if defined (USE_GTK)
218 /* Nonzero means using a tool bar that comes from the toolkit. */
219 int external_tool_bar
;
222 /* Margin at the top of the frame. Used to display the tool-bar. */
226 int n_tool_bar_items
;
228 /* A buffer for decode_mode_line. */
229 char *decode_mode_spec_buffer
;
231 /* See do_line_insertion_deletion_costs for info on these arrays. */
232 /* Cost of inserting 1 line on this frame */
233 int *insert_line_cost
;
234 /* Cost of deleting 1 line on this frame */
235 int *delete_line_cost
;
236 /* Cost of inserting n lines on this frame */
237 int *insert_n_lines_cost
;
238 /* Cost of deleting n lines on this frame */
239 int *delete_n_lines_cost
;
241 /* Size of this frame, excluding fringes, scroll bars etc.,
242 in units of canonical characters. */
243 EMACS_INT text_lines
, text_cols
;
245 /* Total size of this frame (i.e. its native window), in units of
246 canonical characters. */
247 EMACS_INT total_lines
, total_cols
;
249 /* New text height and width for pending size change.
250 0 if no change pending. */
251 int new_text_lines
, new_text_cols
;
253 /* Pixel position of the frame window (x and y offsets in root window). */
254 int left_pos
, top_pos
;
256 /* Size of the frame window in pixels. */
257 int pixel_height
, pixel_width
;
259 /* These many pixels are the difference between the outer window (i.e. the
260 left and top of the window manager decoration) and FRAME_X_WINDOW. */
261 int x_pixels_diff
, y_pixels_diff
;
263 /* This is the gravity value for the specified window position. */
266 /* The geometry flags for this window. */
269 /* Border width of the frame window as known by the (X) window system. */
272 /* Width of the internal border. This is a line of background color
273 just inside the window's border. When the frame is selected,
274 a highlighting is displayed inside the internal border. */
275 int internal_border_width
;
277 /* Canonical X unit. Width of default font, in pixels. */
280 /* Widht of space glyph of default font, in pixels. */
283 /* Canonical Y unit. Height of a line, in pixels. */
286 /* The output method says how the contents of this frame
287 are displayed. It could be using termcap, or using an X window. */
288 enum output_method output_method
;
290 /* A structure of auxiliary data used for displaying the contents.
291 struct x_output is used for X window frames;
292 it is defined in xterm.h.
293 struct w32_output is used for W32 window frames;
294 it is defined in w32term.h. */
298 struct w32_output
*w32
;
299 struct mac_output
*mac
;
304 /* Total width of fringes reserved for drawing truncation bitmaps,
305 continuation bitmaps and alike. The width is in canonical char
306 units of the frame. This must currently be the case because window
307 sizes aren't pixel values. If it weren't the case, we wouldn't be
308 able to split windows horizontally nicely. */
311 /* The extra width (in pixels) currently allotted for fringes. */
312 int left_fringe_width
, right_fringe_width
;
315 /* A pointer to the kboard structure associated with this frame.
316 For termcap frames, this points to initial_kboard. For X frames,
317 it will be the same as display.x->display_info->kboard. */
318 struct kboard
*kboard
;
321 /* See FULLSCREEN_ enum below */
324 /* Number of lines of menu bar. */
327 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
329 /* Nonzero means using a menu bar that comes from the X toolkit. */
330 int external_menu_bar
;
333 /* Nonzero if last attempt at redisplay on this frame was preempted. */
334 char display_preempted
;
336 /* visible is nonzero if the frame is currently displayed; we check
337 it to see if we should bother updating the frame's contents.
338 DON'T SET IT DIRECTLY; instead, use FRAME_SET_VISIBLE.
340 Note that, since invisible frames aren't updated, whenever a
341 frame becomes visible again, it must be marked as garbaged. The
342 FRAME_SAMPLE_VISIBILITY macro takes care of this.
344 On Windows NT/9X, to avoid wasting effort updating visible frames
345 that are actually completely obscured by other windows on the
346 display, we bend the meaning of visible slightly: if greater than
347 1, then the frame is obscured - we still consider it to be
348 "visible" as seen from lisp, but we don't bother updating it. We
349 must take care to garbage the frame when it ceaces to be obscured
350 though. Note that these semantics are only used on NT/9X.
352 iconified is nonzero if the frame is currently iconified.
354 Asynchronous input handlers should NOT change these directly;
355 instead, they should change async_visible or async_iconified, and
356 let the FRAME_SAMPLE_VISIBILITY macro set visible and iconified
357 at the next redisplay.
359 These should probably be considered read-only by everyone except
360 FRAME_SAMPLE_VISIBILITY.
362 These two are mutually exclusive. They might both be zero, if the
363 frame has been made invisible without an icon. */
364 char visible
, iconified
;
366 /* Asynchronous input handlers change these, and
367 FRAME_SAMPLE_VISIBILITY copies them into visible and iconified.
368 See FRAME_SAMPLE_VISIBILITY, below. */
369 volatile char async_visible
, async_iconified
;
371 /* Nonzero if this frame should be redrawn. */
372 volatile char garbaged
;
374 /* True if frame actually has a minibuffer window on it.
375 0 if using a minibuffer window that isn't on this frame. */
378 /* 0 means, if this frame has just one window,
379 show no modeline for that window. */
382 /* Non-zero if the hardware device this frame is displaying on can
383 support scroll bars. */
384 char can_have_scroll_bars
;
386 /* If can_have_scroll_bars is non-zero, this is non-zero if we should
387 actually display them on this frame. */
388 enum vertical_scroll_bar_type vertical_scroll_bar_type
;
390 /* What kind of text cursor should we draw in the future?
391 This should always be filled_box_cursor or bar_cursor. */
392 enum text_cursor_kinds desired_cursor
;
394 /* Width of bar cursor (if we are using that). */
397 /* What kind of text cursor should we draw when the cursor blinks off?
398 This can be filled_box_cursor or bar_cursor or no_cursor. */
399 enum text_cursor_kinds blink_off_cursor
;
401 /* Width of bar cursor (if we are using that) for blink-off state. */
402 int blink_off_cursor_width
;
404 /* Non-0 means raise this frame to the top of the heap when selected. */
407 /* Non-0 means lower this frame to the bottom of the stack when left. */
410 /* True if frame's root window can't be split. */
413 /* If this is set, then Emacs won't change the frame name to indicate
414 the current buffer, etcetera. If the user explicitly sets the frame
415 name, this gets set. If the user sets the name to Qnil, this is
419 /* Nonzero if size of some window on this frame has changed. */
420 char window_sizes_changed
;
422 /* Storage for messages to this frame. */
425 /* Nonnegative if current redisplay should not do scroll computation
426 for lines beyond a certain vpos. This is the vpos. */
427 int scroll_bottom_vpos
;
429 /* Configured width of the scroll bar, in pixels and in characters.
430 config_scroll_bar_cols tracks config_scroll_bar_width if the
431 latter is positive; a zero value in config_scroll_bar_width means
432 to compute the actual width on the fly, using config_scroll_bar_cols
433 and the current font width. */
434 int config_scroll_bar_width
;
435 int config_scroll_bar_cols
;
437 /* The size of the extra width currently allotted for vertical
438 scroll bars in this frame, in pixels. */
439 int scroll_bar_actual_width
;
441 /* The baud rate that was used to calculate costs for this frame. */
442 int cost_calculation_baud_rate
;
444 /* Nonzero if the mouse has moved on this display
445 since the last time we checked. */
448 /* Exponent for gamma correction of colors. 1/(VIEWING_GAMMA *
449 SCREEN_GAMMA) where viewing_gamma is 0.4545 and SCREEN_GAMMA is a
450 frame parameter. 0 means don't do gamma correction. */
453 /* Additional space to put between text lines on this frame. */
454 int extra_line_spacing
;
456 /* Set to non-zero in change_frame_size when size of frame changed
457 Clear the frame in clear_garbaged_frames if set. */
458 unsigned resized_p
: 1;
460 /* Set to non-zero in when we want for force a flush_display in
461 update_frame, usually after resizing the frame. */
462 unsigned force_flush_display_p
: 1;
464 /* Set to non-zero if the default face for the frame has been
465 realized. Reset to zero whenever the default face changes.
466 Used to see the difference between a font change and face change. */
467 unsigned default_face_done_p
: 1;
469 /* Set to non-zero if this frame has already been hscrolled during
470 current redisplay. */
471 unsigned already_hscrolled_p
: 1;
473 /* Set to non-zero when current redisplay has updated frame. */
474 unsigned updated_p
: 1;
476 /* Set to non-zero to minimize tool-bar height even when
477 auto-resize-tool-bar is set to grow-only. */
478 unsigned minimize_tool_bar_window_p
: 1;
482 #define FRAME_KBOARD(f) ((f)->kboard)
484 #define FRAME_KBOARD(f) (&the_only_kboard)
487 typedef struct frame
*FRAME_PTR
;
489 #define XFRAME(p) (eassert (GC_FRAMEP(p)),(struct frame *) XPNTR (p))
490 #define XSETFRAME(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_FRAME))
492 /* Given a window, return its frame as a Lisp_Object. */
493 #define WINDOW_FRAME(w) (w)->frame
495 /* Test a frame for particular kinds of display methods. */
496 #define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap)
497 #define FRAME_X_P(f) ((f)->output_method == output_x_window)
498 #define FRAME_W32_P(f) ((f)->output_method == output_w32)
499 #define FRAME_MSDOS_P(f) ((f)->output_method == output_msdos_raw)
500 #define FRAME_MAC_P(f) ((f)->output_method == output_mac)
502 /* FRAME_WINDOW_P tests whether the frame is a window, and is
503 defined to be the predicate for the window system being used. */
505 #ifdef HAVE_X_WINDOWS
506 #define FRAME_WINDOW_P(f) FRAME_X_P (f)
509 #define FRAME_WINDOW_P(f) FRAME_W32_P (f)
512 #define FRAME_WINDOW_P(f) FRAME_MAC_P (f)
514 #ifndef FRAME_WINDOW_P
515 #define FRAME_WINDOW_P(f) (0)
518 /* Nonzero if frame F is still alive (not deleted). */
519 #define FRAME_LIVE_P(f) ((f)->output_data.nothing != 0)
521 /* Nonzero if frame F is a minibuffer-only frame. */
522 #define FRAME_MINIBUF_ONLY_P(f) \
523 EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f))
525 /* Nonzero if frame F contains a minibuffer window.
526 (If this is 0, F must use some other minibuffer window.) */
527 #define FRAME_HAS_MINIBUF_P(f) ((f)->has_minibuffer)
529 /* Pixel height of frame F, including non-toolkit menu bar and
530 non-toolkit tool bar lines. */
531 #define FRAME_PIXEL_HEIGHT(f) ((f)->pixel_height)
533 /* Pixel width of frame F. */
534 #define FRAME_PIXEL_WIDTH(f) ((f)->pixel_width)
536 /* Height of frame F, measured in canonical lines, including
537 non-toolkit menu bar and non-toolkit tool bar lines. */
538 #define FRAME_LINES(f) (f)->text_lines
540 /* Width of frame F, measured in canonical character columns,
541 not including scroll bars if any. */
542 #define FRAME_COLS(f) (f)->text_cols
544 /* Number of lines of frame F used for menu bar.
545 This is relevant on terminal frames and on
546 X Windows when not using the X toolkit.
547 These lines are counted in FRAME_LINES. */
548 #define FRAME_MENU_BAR_LINES(f) (f)->menu_bar_lines
550 /* Nonzero if this frame should display a tool bar
551 in a way that does not use any text lines. */
552 #if defined (USE_GTK)
553 #define FRAME_EXTERNAL_TOOL_BAR(f) (f)->external_tool_bar
555 #define FRAME_EXTERNAL_TOOL_BAR(f) 0
558 /* Number of lines of frame F used for the tool-bar. */
560 #define FRAME_TOOL_BAR_LINES(f) (f)->tool_bar_lines
563 /* Lines above the top-most window in frame F. */
565 #define FRAME_TOP_MARGIN(F) \
566 (FRAME_MENU_BAR_LINES (F) + FRAME_TOOL_BAR_LINES (F))
568 /* Nonzero if this frame should display a menu bar
569 in a way that does not use any text lines. */
570 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
572 #define FRAME_EXTERNAL_MENU_BAR(f) (f)->external_menu_bar
574 #define FRAME_EXTERNAL_MENU_BAR(f) 0
576 #define FRAME_VISIBLE_P(f) ((f)->visible != 0)
578 /* Nonzero if frame F is currently visible but hidden. */
579 #define FRAME_OBSCURED_P(f) ((f)->visible > 1)
581 /* Nonzero if frame F is currently iconified. */
582 #define FRAME_ICONIFIED_P(f) (f)->iconified
584 #define FRAME_SET_VISIBLE(f,p) \
585 ((f)->async_visible = (p), FRAME_SAMPLE_VISIBILITY (f))
586 #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1, f->garbaged = 1)
587 #define FRAME_GARBAGED_P(f) (f)->garbaged
589 /* Nonzero means do not allow splitting this frame's window. */
590 #define FRAME_NO_SPLIT_P(f) (f)->no_split
592 /* Not really implemented. */
593 #define FRAME_WANTS_MODELINE_P(f) (f)->wants_modeline
595 /* Nonzero if a size change has been requested for frame F
596 but not yet really put into effect. This can be true temporarily
597 when an X event comes in at a bad time. */
598 #define FRAME_WINDOW_SIZES_CHANGED(f) (f)->window_sizes_changed
600 /* The minibuffer window of frame F, if it has one; otherwise nil. */
601 #define FRAME_MINIBUF_WINDOW(f) (f)->minibuffer_window
603 /* The root window of the window tree of frame F. */
604 #define FRAME_ROOT_WINDOW(f) (f)->root_window
606 /* The currently selected window of the window tree of frame F. */
607 #define FRAME_SELECTED_WINDOW(f) (f)->selected_window
609 #define FRAME_INSERT_COST(f) (f)->insert_line_cost
610 #define FRAME_DELETE_COST(f) (f)->delete_line_cost
611 #define FRAME_INSERTN_COST(f) (f)->insert_n_lines_cost
612 #define FRAME_DELETEN_COST(f) (f)->delete_n_lines_cost
613 #define FRAME_MESSAGE_BUF(f) (f)->message_buf
614 #define FRAME_SCROLL_BOTTOM_VPOS(f) (f)->scroll_bottom_vpos
615 #define FRAME_FOCUS_FRAME(f) (f)->focus_frame
617 /* Nonzero if frame F supports scroll bars.
618 If this is zero, then it is impossible to enable scroll bars
620 #define FRAME_CAN_HAVE_SCROLL_BARS(f) ((f)->can_have_scroll_bars)
622 /* This frame slot says whether scroll bars are currently enabled for frame F,
623 and which side they are on. */
624 #define FRAME_VERTICAL_SCROLL_BAR_TYPE(f) ((f)->vertical_scroll_bar_type)
625 #define FRAME_HAS_VERTICAL_SCROLL_BARS(f) \
626 ((f)->vertical_scroll_bar_type != vertical_scroll_bar_none)
627 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT(f) \
628 ((f)->vertical_scroll_bar_type == vertical_scroll_bar_left)
629 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT(f) \
630 ((f)->vertical_scroll_bar_type == vertical_scroll_bar_right)
632 /* Width that a scroll bar in frame F should have, if there is one.
634 If scroll bars are turned off, this is still nonzero. */
635 #define FRAME_CONFIG_SCROLL_BAR_WIDTH(f) ((f)->config_scroll_bar_width)
637 /* Width that a scroll bar in frame F should have, if there is one.
638 Measured in columns (characters).
639 If scroll bars are turned off, this is still nonzero. */
640 #define FRAME_CONFIG_SCROLL_BAR_COLS(f) ((f)->config_scroll_bar_cols)
642 /* Width of a scroll bar in frame F, measured in columns (characters),
643 but only if scroll bars are on the left. If scroll bars are on
644 the right in this frame, or there are no scroll bars, value is 0. */
646 #define FRAME_LEFT_SCROLL_BAR_COLS(f) \
647 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \
648 ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
651 /* Width of a left scroll bar in frame F, measured in pixels */
653 #define FRAME_LEFT_SCROLL_BAR_AREA_WIDTH(f) \
654 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \
655 ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)) \
658 /* Width of a scroll bar in frame F, measured in columns (characters),
659 but only if scroll bars are on the right. If scroll bars are on
660 the left in this frame, or there are no scroll bars, value is 0. */
662 #define FRAME_RIGHT_SCROLL_BAR_COLS(f) \
663 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f) \
664 ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
667 /* Width of a right scroll bar area in frame F, measured in pixels */
669 #define FRAME_RIGHT_SCROLL_BAR_AREA_WIDTH(f) \
670 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f) \
671 ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)) \
674 /* Actual width of a scroll bar in frame F, measured in columns. */
676 #define FRAME_SCROLL_BAR_COLS(f) \
677 (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \
678 ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
681 /* Actual width of a scroll bar area in frame F, measured in pixels. */
683 #define FRAME_SCROLL_BAR_AREA_WIDTH(f) \
684 (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \
685 ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)) \
688 /* Total width of frame F, in columns (characters),
689 including the width used by scroll bars if any. */
691 #define FRAME_TOTAL_COLS(f) ((f)->total_cols)
693 /* Set the width of frame F to VAL.
694 VAL is the width of a full-frame window,
695 not including scroll bars and fringes. */
697 #define SET_FRAME_COLS(f, val) \
698 (FRAME_COLS (f) = (val), \
699 (f)->total_cols = FRAME_TOTAL_COLS_ARG (f, FRAME_COLS (f)))
701 /* Given a value WIDTH for frame F's nominal width,
702 return the value that FRAME_TOTAL_COLS should have. */
704 #define FRAME_TOTAL_COLS_ARG(f, width) \
706 + FRAME_SCROLL_BAR_COLS (f) \
707 + FRAME_FRINGE_COLS (f))
709 /* Maximum + 1 legitimate value for FRAME_CURSOR_X. */
711 #define FRAME_CURSOR_X_LIMIT(f) \
712 (FRAME_COLS (f) + FRAME_LEFT_SCROLL_BAR_COLS (f))
714 /* Nonzero if frame F has scroll bars. */
716 #define FRAME_SCROLL_BARS(f) ((f)->scroll_bars)
718 #define FRAME_CONDEMNED_SCROLL_BARS(f) ((f)->condemned_scroll_bars)
719 #define FRAME_MENU_BAR_ITEMS(f) ((f)->menu_bar_items)
720 #define FRAME_COST_BAUD_RATE(f) ((f)->cost_calculation_baud_rate)
722 #define FRAME_DESIRED_CURSOR(f) ((f)->desired_cursor)
723 #define FRAME_BLINK_OFF_CURSOR(f) ((f)->blink_off_cursor)
724 #define FRAME_CURSOR_WIDTH(f) ((f)->cursor_width)
725 #define FRAME_BLINK_OFF_CURSOR_WIDTH(f) ((f)->blink_off_cursor_width)
727 /* Return a pointer to the face cache of frame F. */
729 #define FRAME_FACE_CACHE(F) (F)->face_cache
731 /* Return the size of message_buf of the frame F. We multiply the
732 width of the frame by 4 because multi-byte form may require at most
733 4-byte for a character. */
735 #define FRAME_MESSAGE_BUF_SIZE(f) (((int) FRAME_COLS (f)) * 4)
737 /* Emacs's redisplay code could become confused if a frame's
738 visibility changes at arbitrary times. For example, if a frame is
739 visible while the desired glyphs are being built, but becomes
740 invisible before they are updated, then some rows of the
741 desired_glyphs will be left marked as enabled after redisplay is
742 complete, which should never happen. The next time the frame
743 becomes visible, redisplay will probably barf.
745 Currently, there are no similar situations involving iconified, but
746 the principle is the same.
748 So instead of having asynchronous input handlers directly set and
749 clear the frame's visibility and iconification flags, they just set
750 the async_visible and async_iconified flags; the redisplay code
751 calls the FRAME_SAMPLE_VISIBILITY macro before doing any redisplay,
752 which sets visible and iconified from their asynchronous
755 Synchronous code must use the FRAME_SET_VISIBLE macro.
757 Also, if a frame used to be invisible, but has just become visible,
758 it must be marked as garbaged, since redisplay hasn't been keeping
761 #define FRAME_SAMPLE_VISIBILITY(f) \
762 (((f)->async_visible && (f)->visible != (f)->async_visible) ? \
763 SET_FRAME_GARBAGED (f) : 0, \
764 (f)->visible = (f)->async_visible, \
765 (f)->iconified = (f)->async_iconified)
767 #define CHECK_FRAME(x) \
768 CHECK_TYPE (FRAMEP (x), Qframep, x)
770 #define CHECK_LIVE_FRAME(x) \
771 CHECK_TYPE (FRAMEP (x) && FRAME_LIVE_P (XFRAME (x)), Qframe_live_p, x)
773 /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
774 `for' loop which iterates over the elements of Vframe_list. The
775 loop will set FRAME_VAR, a Lisp_Object, to each frame in
776 Vframe_list in succession and execute the statement. LIST_VAR
777 should be a Lisp_Object too; it is used to iterate through the
780 This macro is a holdover from a time when multiple frames weren't always
781 supported. An alternate definition of the macro would expand to
782 something which executes the statement once. */
784 #define FOR_EACH_FRAME(list_var, frame_var) \
785 for ((list_var) = Vframe_list; \
787 && (frame_var = XCAR (list_var), 1)); \
788 list_var = XCDR (list_var))
791 extern Lisp_Object Qframep
, Qframe_live_p
;
793 extern struct frame
*last_nonminibuf_frame
;
795 extern struct frame
*make_terminal_frame
P_ ((void));
796 extern struct frame
*make_frame
P_ ((int));
797 #ifdef HAVE_WINDOW_SYSTEM
798 extern struct frame
*make_minibuffer_frame
P_ ((void));
799 extern struct frame
*make_frame_without_minibuffer
P_ ((Lisp_Object
,
802 #endif /* HAVE_WINDOW_SYSTEM */
803 extern int other_visible_frames
P_ ((struct frame
*));
805 extern Lisp_Object Vframe_list
;
806 extern Lisp_Object Vdefault_frame_alist
;
808 extern Lisp_Object Vterminal_frame
;
810 extern Lisp_Object Vmouse_highlight
;
812 /* The currently selected frame. */
814 extern Lisp_Object selected_frame
;
816 /* Value is a pointer to the selected frame. If the selected frame
817 isn't live, abort. */
819 #define SELECTED_FRAME() \
820 ((FRAMEP (selected_frame) \
821 && FRAME_LIVE_P (XFRAME (selected_frame))) \
822 ? XFRAME (selected_frame) \
823 : (abort (), (struct frame *) 0))
826 /***********************************************************************
827 Display-related Macros
828 ***********************************************************************/
830 /* Canonical y-unit on frame F.
831 This value currently equals the line height of the frame (which is
832 the height of the default font of F). */
834 #define FRAME_LINE_HEIGHT(F) ((F)->line_height)
836 /* Canonical x-unit on frame F.
837 This value currently equals the average width of the default font of F. */
839 #define FRAME_COLUMN_WIDTH(F) ((F)->column_width)
841 /* Space glyph width of the default font of frame F. */
843 #define FRAME_SPACE_WIDTH(F) ((F)->space_width)
846 /* Pixel width of areas used to display truncation marks, continuation
847 marks, overlay arrows. This is 0 for terminal frames. */
849 #ifdef HAVE_WINDOW_SYSTEM
851 /* Total width of fringes reserved for drawing truncation bitmaps,
852 continuation bitmaps and alike. The width is in canonical char
853 units of the frame. This must currently be the case because window
854 sizes aren't pixel values. If it weren't the case, we wouldn't be
855 able to split windows horizontally nicely. */
857 #define FRAME_FRINGE_COLS(F) ((F)->fringe_cols)
859 /* Pixel-width of the left and right fringe. */
861 #define FRAME_LEFT_FRINGE_WIDTH(F) ((F)->left_fringe_width)
862 #define FRAME_RIGHT_FRINGE_WIDTH(F) ((F)->right_fringe_width)
864 /* Total width of fringes in pixels. */
866 #define FRAME_TOTAL_FRINGE_WIDTH(F) \
867 (FRAME_LEFT_FRINGE_WIDTH (F) + FRAME_RIGHT_FRINGE_WIDTH (F))
870 /* Pixel-width of internal border lines */
872 #define FRAME_INTERNAL_BORDER_WIDTH(F) ((F)->internal_border_width)
874 #else /* not HAVE_WINDOW_SYSTEM */
876 #define FRAME_FRINGE_COLS(F) 0
877 #define FRAME_TOTAL_FRINGE_WIDTH(F) 0
878 #define FRAME_LEFT_FRINGE_WIDTH(F) 0
879 #define FRAME_RIGHT_FRINGE_WIDTH(F) 0
880 #define FRAME_INTERNAL_BORDER_WIDTH(F) 0
882 #endif /* not HAVE_WINDOW_SYSTEM */
887 /***********************************************************************
888 Conversion between canonical units and pixels
889 ***********************************************************************/
891 /* Canonical x-values are fractions of FRAME_COLUMN_WIDTH, canonical
892 y-unit are fractions of FRAME_LINE_HEIGHT of a frame. Both are
893 represented as Lisp numbers, i.e. integers or floats. */
895 /* Convert canonical value X to pixels. F is the frame whose
896 canonical char width is to be used. X must be a Lisp integer or
897 float. Value is a C integer. */
899 #define FRAME_PIXEL_X_FROM_CANON_X(F, X) \
901 ? XINT (X) * FRAME_COLUMN_WIDTH (F) \
902 : (int) (XFLOAT_DATA (X) * FRAME_COLUMN_WIDTH (F)))
904 /* Convert canonical value Y to pixels. F is the frame whose
905 canonical character height is to be used. X must be a Lisp integer
906 or float. Value is a C integer. */
908 #define FRAME_PIXEL_Y_FROM_CANON_Y(F, Y) \
910 ? XINT (Y) * FRAME_LINE_HEIGHT (F) \
911 : (int) (XFLOAT_DATA (Y) * FRAME_LINE_HEIGHT (F)))
913 /* Convert pixel-value X to canonical units. F is the frame whose
914 canonical character width is to be used. X is a C integer. Result
915 is a Lisp float if X is not a multiple of the canon width,
916 otherwise it's a Lisp integer. */
918 #define FRAME_CANON_X_FROM_PIXEL_X(F, X) \
919 ((X) % FRAME_COLUMN_WIDTH (F) != 0 \
920 ? make_float ((double) (X) / FRAME_COLUMN_WIDTH (F)) \
921 : make_number ((X) / FRAME_COLUMN_WIDTH (F)))
923 /* Convert pixel-value Y to canonical units. F is the frame whose
924 canonical character height is to be used. Y is a C integer.
925 Result is a Lisp float if Y is not a multiple of the canon width,
926 otherwise it's a Lisp integer. */
928 #define FRAME_CANON_Y_FROM_PIXEL_Y(F, Y) \
929 ((Y) % FRAME_LINE_HEIGHT (F) \
930 ? make_float ((double) (Y) / FRAME_LINE_HEIGHT (F)) \
931 : make_number ((Y) / FRAME_LINE_HEIGHT (F)))
935 /* Manipulating pixel sizes and character sizes.
936 Knowledge of which factors affect the overall size of the window should
937 be hidden in these macros, if that's possible.
939 Return the upper/left pixel position of the character cell on frame F
942 #define FRAME_LINE_TO_PIXEL_Y(f, row) \
943 (FRAME_INTERNAL_BORDER_WIDTH (f) \
944 + (row) * FRAME_LINE_HEIGHT (f))
946 #define FRAME_COL_TO_PIXEL_X(f, col) \
947 (FRAME_INTERNAL_BORDER_WIDTH (f) \
948 + (col) * FRAME_COLUMN_WIDTH (f))
950 /* Return the pixel width/height of frame F if it has
951 COLS columns/LINES rows. */
953 #define FRAME_TEXT_COLS_TO_PIXEL_WIDTH(f, cols) \
954 (FRAME_COL_TO_PIXEL_X (f, cols) \
955 + (f)->scroll_bar_actual_width \
956 + FRAME_TOTAL_FRINGE_WIDTH (f) \
957 + FRAME_INTERNAL_BORDER_WIDTH (f))
959 #define FRAME_TEXT_LINES_TO_PIXEL_HEIGHT(f, lines) \
960 (FRAME_LINE_TO_PIXEL_Y (f, lines) \
961 + FRAME_INTERNAL_BORDER_WIDTH (f))
964 /* Return the row/column (zero-based) of the character cell containing
965 the pixel on FRAME at Y/X. */
967 #define FRAME_PIXEL_Y_TO_LINE(f, y) \
968 (((y) - FRAME_INTERNAL_BORDER_WIDTH (f)) \
969 / FRAME_LINE_HEIGHT (f))
971 #define FRAME_PIXEL_X_TO_COL(f, x) \
972 (((x) - FRAME_INTERNAL_BORDER_WIDTH (f)) \
973 / FRAME_COLUMN_WIDTH (f))
975 /* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
978 #define FRAME_PIXEL_WIDTH_TO_TEXT_COLS(f, width) \
979 (FRAME_PIXEL_X_TO_COL (f, ((width) \
980 - FRAME_INTERNAL_BORDER_WIDTH (f) \
981 - FRAME_TOTAL_FRINGE_WIDTH (f) \
982 - (f)->scroll_bar_actual_width)))
984 #define FRAME_PIXEL_HEIGHT_TO_TEXT_LINES(f, height) \
985 (FRAME_PIXEL_Y_TO_LINE (f, ((height) \
986 - FRAME_INTERNAL_BORDER_WIDTH (f))))
989 /***********************************************************************
991 ***********************************************************************/
993 extern Lisp_Object Qauto_raise
, Qauto_lower
;
994 extern Lisp_Object Qborder_color
, Qborder_width
;
995 extern Lisp_Object Qbuffer_predicate
, Qbuffer_list
;
996 extern Lisp_Object Qcursor_color
, Qcursor_type
;
997 extern Lisp_Object Qfont
;
998 extern Lisp_Object Qbackground_color
, Qforeground_color
;
999 extern Lisp_Object Qicon
, Qicon_name
, Qicon_type
, Qicon_left
, Qicon_top
;
1000 extern Lisp_Object Qinternal_border_width
;
1001 extern Lisp_Object Qmenu_bar_lines
, Qtool_bar_lines
;
1002 extern Lisp_Object Qmouse_color
;
1003 extern Lisp_Object Qname
, Qtitle
;
1004 extern Lisp_Object Qparent_id
;
1005 extern Lisp_Object Qunsplittable
, Qvisibility
;
1006 extern Lisp_Object Qscroll_bar_width
, Qvertical_scroll_bars
;
1007 extern Lisp_Object Qscroll_bar_foreground
, Qscroll_bar_background
;
1008 extern Lisp_Object Qscreen_gamma
;
1009 extern Lisp_Object Qline_spacing
;
1010 extern Lisp_Object Qwait_for_wm
;
1011 extern Lisp_Object Qfullscreen
;
1013 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
1014 extern Lisp_Object Qheight
, Qwidth
;
1015 extern Lisp_Object Qminibuffer
, Qmodeline
;
1016 extern Lisp_Object Qonly
;
1017 extern Lisp_Object Qx
, Qw32
, Qmac
, Qpc
;
1018 extern Lisp_Object Qvisible
;
1019 extern Lisp_Object Qdisplay_type
;
1020 extern Lisp_Object Qbackground_mode
;
1022 extern Lisp_Object Qx_resource_name
;
1024 extern Lisp_Object Qleft
, Qright
, Qtop
, Qbox
;
1025 extern Lisp_Object Qdisplay
;
1027 #ifdef HAVE_WINDOW_SYSTEM
1029 /* The class of this X application. */
1030 #define EMACS_CLASS "Emacs"
1034 /* Values used as a bit mask, BOTH == WIDTH | HEIGHT. */
1035 FULLSCREEN_NONE
= 0,
1036 FULLSCREEN_WIDTH
= 1,
1037 FULLSCREEN_HEIGHT
= 2,
1038 FULLSCREEN_BOTH
= 3,
1039 FULLSCREEN_WAIT
= 4,
1043 /* These are in xterm.c, w32term.c, etc. */
1045 extern void x_set_scroll_bar_default_width
P_ ((struct frame
*));
1046 extern void x_set_offset
P_ ((struct frame
*, int, int, int));
1047 extern void x_wm_set_icon_position
P_ ((struct frame
*, int, int));
1049 extern Lisp_Object x_new_font
P_ ((struct frame
*, char *));
1050 extern Lisp_Object x_new_fontset
P_ ((struct frame
*, char *));
1053 /* These are in frame.c */
1055 extern Lisp_Object Vx_resource_name
;
1056 extern Lisp_Object Vx_resource_class
;
1059 extern Lisp_Object Qface_set_after_frame_default
;
1061 extern void x_fullscreen_adjust
P_ ((struct frame
*f
, int *, int *,
1064 extern void x_set_frame_parameters
P_ ((struct frame
*, Lisp_Object
));
1065 extern void x_report_frame_params
P_ ((struct frame
*, Lisp_Object
*));
1067 extern void x_set_fullscreen
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
1068 extern void x_set_line_spacing
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
1069 extern void x_set_screen_gamma
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
1070 extern void x_set_font
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
1071 extern void x_set_fringe_width
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
1072 extern void x_set_border_width
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
1073 extern void x_set_internal_border_width
P_ ((struct frame
*, Lisp_Object
,
1075 extern void x_set_visibility
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
1076 extern void x_set_autoraise
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
1077 extern void x_set_autolower
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
1078 extern void x_set_unsplittable
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
1079 extern void x_set_vertical_scroll_bars
P_ ((struct frame
*, Lisp_Object
,
1081 extern void x_set_scroll_bar_width
P_ ((struct frame
*, Lisp_Object
,
1084 extern Lisp_Object x_icon_type
P_ ((struct frame
*));
1086 extern int x_figure_window_size
P_ ((struct frame
*, Lisp_Object
, int));
1089 extern void validate_x_resource_name
P_ ((void));
1091 #endif /* HAVE_WINDOW_SYSTEM */
1093 #endif /* not EMACS_FRAME_H */
1095 /* arch-tag: 0df048ee-e6bf-4f48-bd56-e3cd055dd8c4
1096 (do not change this comment) */