* doc/misc/eshell.texi: Fill most of the missing sections.
[emacs.git] / src / frame.h
blob92270d8a517f4f108bee5c2a70a679ba7abb41fa
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, 2012 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
22 frame.h */
24 #ifndef EMACS_FRAME_H
25 #define EMACS_FRAME_H
27 #include "dispextern.h"
30 /* Miscellanea. */
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
36 print. */
38 extern int message_buf_print;
40 /* Nonzero means window system changes focus when moving the
41 mouse. */
43 extern int focus_follows_mouse;
46 /* The structure representing a frame. */
48 enum output_method
50 output_initial,
51 output_termcap,
52 output_x_window,
53 output_msdos_raw,
54 output_w32,
55 output_mac,
56 output_ns
59 enum vertical_scroll_bar_type
61 vertical_scroll_bar_none,
62 vertical_scroll_bar_left,
63 vertical_scroll_bar_right
66 enum text_cursor_kinds
68 DEFAULT_CURSOR = -2,
69 NO_CURSOR = -1,
70 FILLED_BOX_CURSOR,
71 HOLLOW_BOX_CURSOR,
72 BAR_CURSOR,
73 HBAR_CURSOR
76 enum fullscreen_type
78 FULLSCREEN_NONE,
79 FULLSCREEN_WIDTH = 0x001,
80 FULLSCREEN_HEIGHT = 0x002,
81 FULLSCREEN_BOTH = 0x003,
82 FULLSCREEN_MAXIMIZED = 0x013,
83 FULLSCREEN_WAIT = 0x100
87 #define FRAME_FOREGROUND_PIXEL(f) ((f)->foreground_pixel)
88 #define FRAME_BACKGROUND_PIXEL(f) ((f)->background_pixel)
90 struct terminal;
92 struct font_driver_list;
94 struct frame
96 struct vectorlike_header header;
98 /* All Lisp_Object components must come first.
99 That ensures they are all aligned normally. */
101 /* Name of this frame: a Lisp string. It is used for looking up resources,
102 as well as for the title in some cases. */
103 Lisp_Object name;
105 /* The name to use for the icon, the last time
106 it was refreshed. nil means not explicitly specified. */
107 Lisp_Object icon_name;
109 /* This is the frame title specified explicitly, if any.
110 Usually it is nil. */
111 Lisp_Object title;
113 /* The frame which should receive keystrokes that occur in this
114 frame, or nil if they should go to the frame itself. This is
115 usually nil, but if the frame is minibufferless, we can use this
116 to redirect keystrokes to a surrogate minibuffer frame when
117 needed.
119 Note that a value of nil is different than having the field point
120 to the frame itself. Whenever the Fselect_frame function is used
121 to shift from one frame to the other, any redirections to the
122 original frame are shifted to the newly selected frame; if
123 focus_frame is nil, Fselect_frame will leave it alone. */
124 Lisp_Object focus_frame;
126 /* This frame's root window. Every frame has one.
127 If the frame has only a minibuffer window, this is it.
128 Otherwise, if the frame has a minibuffer window, this is its sibling. */
129 Lisp_Object root_window;
131 /* This frame's selected window.
132 Each frame has its own window hierarchy
133 and one of the windows in it is selected within the frame.
134 The selected window of the selected frame is Emacs's selected window. */
135 Lisp_Object selected_window;
137 /* This frame's minibuffer window.
138 Most frames have their own minibuffer windows,
139 but only the selected frame's minibuffer window
140 can actually appear to exist. */
141 Lisp_Object minibuffer_window;
143 /* Parameter alist of this frame.
144 These are the parameters specified when creating the frame
145 or modified with modify-frame-parameters. */
146 Lisp_Object param_alist;
148 /* List of scroll bars on this frame.
149 Actually, we don't specify exactly what is stored here at all; the
150 scroll bar implementation code can use it to store anything it likes.
151 This field is marked by the garbage collector. It is here
152 instead of in the `device' structure so that the garbage
153 collector doesn't need to look inside the window-system-dependent
154 structure. */
155 Lisp_Object scroll_bars;
156 Lisp_Object condemned_scroll_bars;
158 /* Vector describing the items to display in the menu bar.
159 Each item has four elements in this vector.
160 They are KEY, STRING, SUBMAP, and HPOS.
161 (HPOS is not used in when the X toolkit is in use.)
162 There are four additional elements of nil at the end, to terminate. */
163 Lisp_Object menu_bar_items;
165 /* Alist of elements (FACE-NAME . FACE-VECTOR-DATA). */
166 Lisp_Object face_alist;
168 /* A vector that records the entire structure of this frame's menu bar.
169 For the format of the data, see extensive comments in xmenu.c.
170 Only the X toolkit version uses this. */
171 Lisp_Object menu_bar_vector;
173 /* Predicate for selecting buffers for other-buffer. */
174 Lisp_Object buffer_predicate;
176 /* List of buffers viewed in this frame, for other-buffer. */
177 Lisp_Object buffer_list;
179 /* List of buffers that were viewed, then buried in this frame. The
180 most recently buried buffer is first. For last-buffer. */
181 Lisp_Object buried_buffer_list;
183 /* A dummy window used to display menu bars under X when no X
184 toolkit support is available. */
185 Lisp_Object menu_bar_window;
187 /* A window used to display the tool-bar of a frame. */
188 Lisp_Object tool_bar_window;
190 /* Desired and current tool-bar items. */
191 Lisp_Object tool_bar_items;
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. */
206 char *namebuf;
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;
245 #endif
247 /* Margin at the top of the frame. Used to display the tool-bar. */
248 int tool_bar_lines;
250 int n_tool_bar_rows;
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. */
285 double resx, resy;
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. */
292 int win_gravity;
294 /* The geometry flags for this window. */
295 int size_hint_flags;
297 /* Border width of the frame window as known by the (X) window system. */
298 int border_width;
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. */
306 int column_width;
308 /* Width of space glyph of default font, in pixels. */
309 int space_width;
311 /* Canonical Y unit. Height of a line, in pixels. */
312 int line_height;
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
325 well. */
326 union output_data
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 */
332 EMACS_INT nothing;
334 output_data;
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
339 faces. */
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. */
347 int fringe_cols;
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. */
356 int menu_bar_lines;
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;
362 #endif
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
432 cleared. */
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). */
454 int cursor_width;
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. */
464 char *message_buf;
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;
485 /* frame opacity
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. */
489 double alpha[2];
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. */
494 double gamma;
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)
531 #endif
532 #ifdef HAVE_NTGUI
533 #define FRAME_WINDOW_P(f) FRAME_W32_P (f)
534 #endif
535 #ifdef HAVE_NS
536 #define FRAME_WINDOW_P(f) FRAME_NS_P(f)
537 #endif
538 #ifndef FRAME_WINDOW_P
539 #define FRAME_WINDOW_P(f) (0)
540 #endif
542 /* Nonzero if frame F is still alive (not deleted). */
543 #define FRAME_LIVE_P(f) ((f)->terminal != 0)
545 /* Nonzero if frame F is a minibuffer-only frame. */
546 #define FRAME_MINIBUF_ONLY_P(f) \
547 EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f))
549 /* Nonzero if frame F contains a minibuffer window.
550 (If this is 0, F must use some other minibuffer window.) */
551 #define FRAME_HAS_MINIBUF_P(f) ((f)->has_minibuffer)
553 /* Pixel height of frame F, including non-toolkit menu bar and
554 non-toolkit tool bar lines. */
555 #define FRAME_PIXEL_HEIGHT(f) ((f)->pixel_height)
557 /* Pixel width of frame F. */
558 #define FRAME_PIXEL_WIDTH(f) ((f)->pixel_width)
560 /* Height of frame F, measured in canonical lines, including
561 non-toolkit menu bar and non-toolkit tool bar lines. */
562 #define FRAME_LINES(f) (f)->text_lines
564 /* Width of frame F, measured in canonical character columns,
565 not including scroll bars if any. */
566 #define FRAME_COLS(f) (f)->text_cols
568 /* Number of lines of frame F used for menu bar.
569 This is relevant on terminal frames and on
570 X Windows when not using the X toolkit.
571 These lines are counted in FRAME_LINES. */
572 #define FRAME_MENU_BAR_LINES(f) (f)->menu_bar_lines
574 /* Nonzero if this frame should display a tool bar
575 in a way that does not use any text lines. */
576 #if defined (USE_GTK) || defined (HAVE_NS)
577 #define FRAME_EXTERNAL_TOOL_BAR(f) (f)->external_tool_bar
578 #else
579 #define FRAME_EXTERNAL_TOOL_BAR(f) 0
580 #endif
582 /* Number of lines of frame F used for the tool-bar. */
584 #define FRAME_TOOL_BAR_LINES(f) (f)->tool_bar_lines
587 /* Lines above the top-most window in frame F. */
589 #define FRAME_TOP_MARGIN(F) \
590 (FRAME_MENU_BAR_LINES (F) + FRAME_TOOL_BAR_LINES (F))
592 /* Pixel height of the top margin above. */
594 #define FRAME_TOP_MARGIN_HEIGHT(f) \
595 (FRAME_TOP_MARGIN (f) * FRAME_LINE_HEIGHT (f))
597 /* Nonzero if this frame should display a menu bar
598 in a way that does not use any text lines. */
599 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
600 || defined (HAVE_NS) || defined (USE_GTK)
601 #define FRAME_EXTERNAL_MENU_BAR(f) (f)->external_menu_bar
602 #else
603 #define FRAME_EXTERNAL_MENU_BAR(f) 0
604 #endif
605 #define FRAME_VISIBLE_P(f) ((f)->visible != 0)
607 /* Nonzero if frame F is currently visible but hidden. */
608 #define FRAME_OBSCURED_P(f) ((f)->visible > 1)
610 /* Nonzero if frame F is currently iconified. */
611 #define FRAME_ICONIFIED_P(f) (f)->iconified
613 #define FRAME_SET_VISIBLE(f,p) \
614 ((f)->async_visible = (p), FRAME_SAMPLE_VISIBILITY (f))
615 #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1, f->garbaged = 1)
616 #define FRAME_GARBAGED_P(f) (f)->garbaged
618 /* Nonzero means do not allow splitting this frame's window. */
619 #define FRAME_NO_SPLIT_P(f) (f)->no_split
621 /* Not really implemented. */
622 #define FRAME_WANTS_MODELINE_P(f) (f)->wants_modeline
624 /* Nonzero if a size change has been requested for frame F
625 but not yet really put into effect. This can be true temporarily
626 when an X event comes in at a bad time. */
627 #define FRAME_WINDOW_SIZES_CHANGED(f) (f)->window_sizes_changed
629 /* The minibuffer window of frame F, if it has one; otherwise nil. */
630 #define FRAME_MINIBUF_WINDOW(f) (f)->minibuffer_window
632 /* The root window of the window tree of frame F. */
633 #define FRAME_ROOT_WINDOW(f) (f)->root_window
635 /* The currently selected window of the window tree of frame F. */
636 #define FRAME_SELECTED_WINDOW(f) (f)->selected_window
638 #define FRAME_INSERT_COST(f) (f)->insert_line_cost
639 #define FRAME_DELETE_COST(f) (f)->delete_line_cost
640 #define FRAME_INSERTN_COST(f) (f)->insert_n_lines_cost
641 #define FRAME_DELETEN_COST(f) (f)->delete_n_lines_cost
642 #define FRAME_MESSAGE_BUF(f) (f)->message_buf
643 #define FRAME_SCROLL_BOTTOM_VPOS(f) (f)->scroll_bottom_vpos
644 #define FRAME_FOCUS_FRAME(f) (f)->focus_frame
646 /* Nonzero if frame F supports scroll bars.
647 If this is zero, then it is impossible to enable scroll bars
648 on frame F. */
649 #define FRAME_CAN_HAVE_SCROLL_BARS(f) ((f)->can_have_scroll_bars)
651 /* This frame slot says whether scroll bars are currently enabled for frame F,
652 and which side they are on. */
653 #define FRAME_VERTICAL_SCROLL_BAR_TYPE(f) ((f)->vertical_scroll_bar_type)
654 #define FRAME_HAS_VERTICAL_SCROLL_BARS(f) \
655 ((f)->vertical_scroll_bar_type != vertical_scroll_bar_none)
656 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT(f) \
657 ((f)->vertical_scroll_bar_type == vertical_scroll_bar_left)
658 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT(f) \
659 ((f)->vertical_scroll_bar_type == vertical_scroll_bar_right)
661 /* Width that a scroll bar in frame F should have, if there is one.
662 Measured in pixels.
663 If scroll bars are turned off, this is still nonzero. */
664 #define FRAME_CONFIG_SCROLL_BAR_WIDTH(f) ((f)->config_scroll_bar_width)
666 /* Width that a scroll bar in frame F should have, if there is one.
667 Measured in columns (characters).
668 If scroll bars are turned off, this is still nonzero. */
669 #define FRAME_CONFIG_SCROLL_BAR_COLS(f) ((f)->config_scroll_bar_cols)
671 /* Width of a scroll bar in frame F, measured in columns (characters),
672 but only if scroll bars are on the left. If scroll bars are on
673 the right in this frame, or there are no scroll bars, value is 0. */
675 #define FRAME_LEFT_SCROLL_BAR_COLS(f) \
676 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \
677 ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
678 : 0)
680 /* Width of a left scroll bar in frame F, measured in pixels */
682 #define FRAME_LEFT_SCROLL_BAR_AREA_WIDTH(f) \
683 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \
684 ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)) \
685 : 0)
687 /* Width of a scroll bar in frame F, measured in columns (characters),
688 but only if scroll bars are on the right. If scroll bars are on
689 the left in this frame, or there are no scroll bars, value is 0. */
691 #define FRAME_RIGHT_SCROLL_BAR_COLS(f) \
692 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f) \
693 ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
694 : 0)
696 /* Width of a right scroll bar area in frame F, measured in pixels */
698 #define FRAME_RIGHT_SCROLL_BAR_AREA_WIDTH(f) \
699 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f) \
700 ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)) \
701 : 0)
703 /* Actual width of a scroll bar in frame F, measured in columns. */
705 #define FRAME_SCROLL_BAR_COLS(f) \
706 (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \
707 ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
708 : 0)
710 /* Actual width of a scroll bar area in frame F, measured in pixels. */
712 #define FRAME_SCROLL_BAR_AREA_WIDTH(f) \
713 (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \
714 ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)) \
715 : 0)
717 /* Total width of frame F, in columns (characters),
718 including the width used by scroll bars if any. */
720 #define FRAME_TOTAL_COLS(f) ((f)->total_cols)
722 /* Set the width of frame F to VAL.
723 VAL is the width of a full-frame window,
724 not including scroll bars and fringes. */
726 #define SET_FRAME_COLS(f, val) \
727 (FRAME_COLS (f) = (val), \
728 (f)->total_cols = FRAME_TOTAL_COLS_ARG (f, FRAME_COLS (f)))
730 /* Given a value WIDTH for frame F's nominal width,
731 return the value that FRAME_TOTAL_COLS should have. */
733 #define FRAME_TOTAL_COLS_ARG(f, width) \
734 ((width) \
735 + FRAME_SCROLL_BAR_COLS (f) \
736 + FRAME_FRINGE_COLS (f))
738 /* Maximum + 1 legitimate value for FRAME_CURSOR_X. */
740 #define FRAME_CURSOR_X_LIMIT(f) \
741 (FRAME_COLS (f) + FRAME_LEFT_SCROLL_BAR_COLS (f))
743 /* Nonzero if frame F has scroll bars. */
745 #define FRAME_SCROLL_BARS(f) ((f)->scroll_bars)
747 #define FRAME_CONDEMNED_SCROLL_BARS(f) ((f)->condemned_scroll_bars)
748 #define FRAME_MENU_BAR_ITEMS(f) ((f)->menu_bar_items)
749 #define FRAME_COST_BAUD_RATE(f) ((f)->cost_calculation_baud_rate)
751 #define FRAME_DESIRED_CURSOR(f) ((f)->desired_cursor)
752 #define FRAME_BLINK_OFF_CURSOR(f) ((f)->blink_off_cursor)
753 #define FRAME_CURSOR_WIDTH(f) ((f)->cursor_width)
754 #define FRAME_BLINK_OFF_CURSOR_WIDTH(f) ((f)->blink_off_cursor_width)
756 /* Return a pointer to the face cache of frame F. */
758 #define FRAME_FACE_CACHE(F) (F)->face_cache
760 /* Return the size of message_buf of the frame F. We multiply the
761 width of the frame by 4 because multi-byte form may require at most
762 4-byte for a character. */
764 #define FRAME_MESSAGE_BUF_SIZE(f) (((int) FRAME_COLS (f)) * 4)
766 /* Emacs's redisplay code could become confused if a frame's
767 visibility changes at arbitrary times. For example, if a frame is
768 visible while the desired glyphs are being built, but becomes
769 invisible before they are updated, then some rows of the
770 desired_glyphs will be left marked as enabled after redisplay is
771 complete, which should never happen. The next time the frame
772 becomes visible, redisplay will probably barf.
774 Currently, there are no similar situations involving iconified, but
775 the principle is the same.
777 So instead of having asynchronous input handlers directly set and
778 clear the frame's visibility and iconification flags, they just set
779 the async_visible and async_iconified flags; the redisplay code
780 calls the FRAME_SAMPLE_VISIBILITY macro before doing any redisplay,
781 which sets visible and iconified from their asynchronous
782 counterparts.
784 Synchronous code must use the FRAME_SET_VISIBLE macro.
786 Also, if a frame used to be invisible, but has just become visible,
787 it must be marked as garbaged, since redisplay hasn't been keeping
788 up its contents.
790 Note that a tty frame is visible if and only if it is the topmost
791 frame. */
793 #define FRAME_SAMPLE_VISIBILITY(f) \
794 (((f)->async_visible && (f)->visible != (f)->async_visible) ? \
795 SET_FRAME_GARBAGED (f) : 0, \
796 (f)->visible = (f)->async_visible, \
797 (f)->iconified = (f)->async_iconified)
799 #define CHECK_FRAME(x) \
800 CHECK_TYPE (FRAMEP (x), Qframep, x)
802 #define CHECK_LIVE_FRAME(x) \
803 CHECK_TYPE (FRAMEP (x) && FRAME_LIVE_P (XFRAME (x)), Qframe_live_p, x)
805 /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
806 `for' loop which iterates over the elements of Vframe_list. The
807 loop will set FRAME_VAR, a Lisp_Object, to each frame in
808 Vframe_list in succession and execute the statement. LIST_VAR
809 should be a Lisp_Object too; it is used to iterate through the
810 Vframe_list.
812 This macro is a holdover from a time when multiple frames weren't always
813 supported. An alternate definition of the macro would expand to
814 something which executes the statement once. */
816 #define FOR_EACH_FRAME(list_var, frame_var) \
817 for ((list_var) = Vframe_list; \
818 (CONSP (list_var) \
819 && (frame_var = XCAR (list_var), 1)); \
820 list_var = XCDR (list_var))
823 extern Lisp_Object Qframep, Qframe_live_p;
824 extern Lisp_Object Qtty, Qtty_type;
825 extern Lisp_Object Qterminal, Qterminal_live_p;
826 extern Lisp_Object Qnoelisp;
828 extern struct frame *last_nonminibuf_frame;
830 extern struct frame *make_initial_frame P_ ((void));
831 extern struct frame *make_terminal_frame P_ ((struct terminal *));
832 extern struct frame *make_frame P_ ((int));
833 #ifdef HAVE_WINDOW_SYSTEM
834 extern struct frame *make_minibuffer_frame P_ ((void));
835 extern struct frame *make_frame_without_minibuffer P_ ((Lisp_Object,
836 struct kboard *,
837 Lisp_Object));
838 #endif /* HAVE_WINDOW_SYSTEM */
839 extern int other_visible_frames P_ ((struct frame *));
840 extern void frame_make_pointer_invisible P_ ((void));
841 extern void frame_make_pointer_visible P_ ((void));
842 extern Lisp_Object delete_frame P_ ((Lisp_Object, Lisp_Object));
844 extern Lisp_Object Vframe_list;
845 extern Lisp_Object Vdefault_frame_alist;
847 extern Lisp_Object Vterminal_frame;
849 extern Lisp_Object Vmouse_highlight;
851 /* The currently selected frame. */
853 extern Lisp_Object selected_frame;
855 /* Value is a pointer to the selected frame. If the selected frame
856 isn't live, abort. */
858 #define SELECTED_FRAME() \
859 ((FRAMEP (selected_frame) \
860 && FRAME_LIVE_P (XFRAME (selected_frame))) \
861 ? XFRAME (selected_frame) \
862 : (abort (), (struct frame *) 0))
865 /***********************************************************************
866 Display-related Macros
867 ***********************************************************************/
869 /* Canonical y-unit on frame F.
870 This value currently equals the line height of the frame (which is
871 the height of the default font of F). */
873 #define FRAME_LINE_HEIGHT(F) ((F)->line_height)
875 /* Canonical x-unit on frame F.
876 This value currently equals the average width of the default font of F. */
878 #define FRAME_COLUMN_WIDTH(F) ((F)->column_width)
880 /* Space glyph width of the default font of frame F. */
882 #define FRAME_SPACE_WIDTH(F) ((F)->space_width)
885 /* Pixel width of areas used to display truncation marks, continuation
886 marks, overlay arrows. This is 0 for terminal frames. */
888 #ifdef HAVE_WINDOW_SYSTEM
890 /* Total width of fringes reserved for drawing truncation bitmaps,
891 continuation bitmaps and alike. The width is in canonical char
892 units of the frame. This must currently be the case because window
893 sizes aren't pixel values. If it weren't the case, we wouldn't be
894 able to split windows horizontally nicely. */
896 #define FRAME_FRINGE_COLS(F) ((F)->fringe_cols)
898 /* Pixel-width of the left and right fringe. */
900 #define FRAME_LEFT_FRINGE_WIDTH(F) ((F)->left_fringe_width)
901 #define FRAME_RIGHT_FRINGE_WIDTH(F) ((F)->right_fringe_width)
903 /* Total width of fringes in pixels. */
905 #define FRAME_TOTAL_FRINGE_WIDTH(F) \
906 (FRAME_LEFT_FRINGE_WIDTH (F) + FRAME_RIGHT_FRINGE_WIDTH (F))
909 /* Pixel-width of internal border lines */
911 #define FRAME_INTERNAL_BORDER_WIDTH(F) ((F)->internal_border_width)
913 #else /* not HAVE_WINDOW_SYSTEM */
915 #define FRAME_FRINGE_COLS(F) 0
916 #define FRAME_TOTAL_FRINGE_WIDTH(F) 0
917 #define FRAME_LEFT_FRINGE_WIDTH(F) 0
918 #define FRAME_RIGHT_FRINGE_WIDTH(F) 0
919 #define FRAME_INTERNAL_BORDER_WIDTH(F) 0
921 #endif /* not HAVE_WINDOW_SYSTEM */
926 /***********************************************************************
927 Conversion between canonical units and pixels
928 ***********************************************************************/
930 /* Canonical x-values are fractions of FRAME_COLUMN_WIDTH, canonical
931 y-unit are fractions of FRAME_LINE_HEIGHT of a frame. Both are
932 represented as Lisp numbers, i.e. integers or floats. */
934 /* Convert canonical value X to pixels. F is the frame whose
935 canonical char width is to be used. X must be a Lisp integer or
936 float. Value is a C integer. */
938 #define FRAME_PIXEL_X_FROM_CANON_X(F, X) \
939 (INTEGERP (X) \
940 ? XINT (X) * FRAME_COLUMN_WIDTH (F) \
941 : (int) (XFLOAT_DATA (X) * FRAME_COLUMN_WIDTH (F)))
943 /* Convert canonical value Y to pixels. F is the frame whose
944 canonical character height is to be used. X must be a Lisp integer
945 or float. Value is a C integer. */
947 #define FRAME_PIXEL_Y_FROM_CANON_Y(F, Y) \
948 (INTEGERP (Y) \
949 ? XINT (Y) * FRAME_LINE_HEIGHT (F) \
950 : (int) (XFLOAT_DATA (Y) * FRAME_LINE_HEIGHT (F)))
952 /* Convert pixel-value X to canonical units. F is the frame whose
953 canonical character width is to be used. X is a C integer. Result
954 is a Lisp float if X is not a multiple of the canon width,
955 otherwise it's a Lisp integer. */
957 #define FRAME_CANON_X_FROM_PIXEL_X(F, X) \
958 ((X) % FRAME_COLUMN_WIDTH (F) != 0 \
959 ? make_float ((double) (X) / FRAME_COLUMN_WIDTH (F)) \
960 : make_number ((X) / FRAME_COLUMN_WIDTH (F)))
962 /* Convert pixel-value Y to canonical units. F is the frame whose
963 canonical character height is to be used. Y is a C integer.
964 Result is a Lisp float if Y is not a multiple of the canon width,
965 otherwise it's a Lisp integer. */
967 #define FRAME_CANON_Y_FROM_PIXEL_Y(F, Y) \
968 ((Y) % FRAME_LINE_HEIGHT (F) \
969 ? make_float ((double) (Y) / FRAME_LINE_HEIGHT (F)) \
970 : make_number ((Y) / FRAME_LINE_HEIGHT (F)))
974 /* Manipulating pixel sizes and character sizes.
975 Knowledge of which factors affect the overall size of the window should
976 be hidden in these macros, if that's possible.
978 Return the upper/left pixel position of the character cell on frame F
979 at ROW/COL. */
981 #define FRAME_LINE_TO_PIXEL_Y(f, row) \
982 (((row) < FRAME_TOP_MARGIN (f) ? 0 : FRAME_INTERNAL_BORDER_WIDTH (f)) \
983 + (row) * FRAME_LINE_HEIGHT (f))
985 #define FRAME_COL_TO_PIXEL_X(f, col) \
986 (FRAME_INTERNAL_BORDER_WIDTH (f) \
987 + (col) * FRAME_COLUMN_WIDTH (f))
989 /* Return the pixel width/height of frame F if it has
990 COLS columns/LINES rows. */
992 #define FRAME_TEXT_COLS_TO_PIXEL_WIDTH(f, cols) \
993 (FRAME_COL_TO_PIXEL_X (f, cols) \
994 + (f)->scroll_bar_actual_width \
995 + FRAME_TOTAL_FRINGE_WIDTH (f) \
996 + FRAME_INTERNAL_BORDER_WIDTH (f))
998 #define FRAME_TEXT_LINES_TO_PIXEL_HEIGHT(f, lines) \
999 ((lines) * FRAME_LINE_HEIGHT (f) \
1000 + 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
1003 /* Return the row/column (zero-based) of the character cell containing
1004 the pixel on FRAME at Y/X. */
1006 #define FRAME_PIXEL_Y_TO_LINE(f, y) \
1007 (((y) < FRAME_TOP_MARGIN_HEIGHT (f) \
1008 ? (y) \
1009 : ((y) < FRAME_TOP_MARGIN_HEIGHT (f) + FRAME_INTERNAL_BORDER_WIDTH (f) \
1010 ? (y) - (FRAME_TOP_MARGIN_HEIGHT (f) + FRAME_INTERNAL_BORDER_WIDTH (f) \
1011 /* Arrange for the division to round down. */ \
1012 + FRAME_LINE_HEIGHT (f) - 1) \
1013 : (y) - FRAME_INTERNAL_BORDER_WIDTH (f))) \
1014 / FRAME_LINE_HEIGHT (f))
1016 #define FRAME_PIXEL_X_TO_COL(f, x) \
1017 (((x) - FRAME_INTERNAL_BORDER_WIDTH (f)) \
1018 / FRAME_COLUMN_WIDTH (f))
1020 /* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
1021 frame F? */
1023 #define FRAME_PIXEL_WIDTH_TO_TEXT_COLS(f, width) \
1024 (FRAME_PIXEL_X_TO_COL (f, ((width) \
1025 - FRAME_INTERNAL_BORDER_WIDTH (f) \
1026 - FRAME_TOTAL_FRINGE_WIDTH (f) \
1027 - (f)->scroll_bar_actual_width)))
1029 #define FRAME_PIXEL_HEIGHT_TO_TEXT_LINES(f, height) \
1030 (FRAME_PIXEL_Y_TO_LINE (f, ((height) \
1031 - FRAME_INTERNAL_BORDER_WIDTH (f))))
1034 /***********************************************************************
1035 Frame Parameters
1036 ***********************************************************************/
1038 extern Lisp_Object Qauto_raise, Qauto_lower;
1039 extern Lisp_Object Qborder_color, Qborder_width;
1040 extern Lisp_Object Qbuffer_predicate, Qbuffer_list, Qburied_buffer_list;
1041 extern Lisp_Object Qcursor_color, Qcursor_type;
1042 extern Lisp_Object Qfont;
1043 extern Lisp_Object Qbackground_color, Qforeground_color;
1044 extern Lisp_Object Qicon, Qicon_name, Qicon_type, Qicon_left, Qicon_top;
1045 extern Lisp_Object Qinternal_border_width;
1046 extern Lisp_Object Qmenu_bar_lines, Qtool_bar_lines;
1047 extern Lisp_Object Qmouse_color;
1048 extern Lisp_Object Qname, Qtitle;
1049 extern Lisp_Object Qparent_id;
1050 extern Lisp_Object Qunsplittable, Qvisibility;
1051 extern Lisp_Object Qscroll_bar_width, Qvertical_scroll_bars;
1052 extern Lisp_Object Qscroll_bar_foreground, Qscroll_bar_background;
1053 extern Lisp_Object Qscreen_gamma;
1054 extern Lisp_Object Qline_spacing;
1055 extern Lisp_Object Qwait_for_wm;
1056 extern Lisp_Object Qfullscreen;
1057 extern Lisp_Object Qfullwidth, Qfullheight, Qfullboth, Qmaximized;
1058 extern Lisp_Object Qsticky;
1059 extern Lisp_Object Qfont_backend;
1060 extern Lisp_Object Qalpha;
1062 extern Lisp_Object Qleft_fringe, Qright_fringe;
1063 extern Lisp_Object Qheight, Qwidth;
1064 extern Lisp_Object Qminibuffer, Qmodeline;
1065 extern Lisp_Object Qonly;
1066 extern Lisp_Object Qx, Qw32, Qmac, Qpc, Qns;
1067 extern Lisp_Object Qvisible;
1068 extern Lisp_Object Qdisplay_type;
1069 extern Lisp_Object Qbackground_mode;
1071 extern Lisp_Object Qx_resource_name;
1073 extern Lisp_Object Qleft, Qright, Qtop, Qbox;
1074 extern Lisp_Object Qdisplay;
1076 #ifdef HAVE_WINDOW_SYSTEM
1078 /* The class of this X application. */
1079 #define EMACS_CLASS "Emacs"
1081 /* These are in xterm.c, w32term.c, etc. */
1083 extern void x_set_scroll_bar_default_width P_ ((struct frame *));
1084 extern void x_set_offset P_ ((struct frame *, int, int, int));
1085 extern void x_wm_set_icon_position P_ ((struct frame *, int, int));
1087 extern Lisp_Object x_new_font P_ ((struct frame *, Lisp_Object, int));
1089 /* These are in frame.c */
1091 extern Lisp_Object Vx_resource_name;
1092 extern Lisp_Object Vx_resource_class;
1095 extern Lisp_Object Qface_set_after_frame_default;
1097 extern void x_fullscreen_adjust P_ ((struct frame *f, int *, int *,
1098 int *, int *));
1100 extern void x_set_frame_parameters P_ ((struct frame *, Lisp_Object));
1101 extern void x_report_frame_params P_ ((struct frame *, Lisp_Object *));
1103 extern void x_set_fullscreen P_ ((struct frame *, Lisp_Object, Lisp_Object));
1104 extern void x_set_line_spacing P_ ((struct frame *, Lisp_Object, Lisp_Object));
1105 extern void x_set_screen_gamma P_ ((struct frame *, Lisp_Object, Lisp_Object));
1106 extern void x_set_font P_ ((struct frame *, Lisp_Object, Lisp_Object));
1107 extern void x_set_font_backend P_ ((struct frame *, Lisp_Object, Lisp_Object));
1108 extern void x_set_fringe_width P_ ((struct frame *, Lisp_Object, Lisp_Object));
1109 extern void x_set_border_width P_ ((struct frame *, Lisp_Object, Lisp_Object));
1110 extern void x_set_internal_border_width P_ ((struct frame *, Lisp_Object,
1111 Lisp_Object));
1112 extern void x_set_visibility P_ ((struct frame *, Lisp_Object, Lisp_Object));
1113 extern void x_set_autoraise P_ ((struct frame *, Lisp_Object, Lisp_Object));
1114 extern void x_set_autolower P_ ((struct frame *, Lisp_Object, Lisp_Object));
1115 extern void x_set_unsplittable P_ ((struct frame *, Lisp_Object, Lisp_Object));
1116 extern void x_set_vertical_scroll_bars P_ ((struct frame *, Lisp_Object,
1117 Lisp_Object));
1118 extern void x_set_scroll_bar_width P_ ((struct frame *, Lisp_Object,
1119 Lisp_Object));
1121 extern Lisp_Object x_icon_type P_ ((struct frame *));
1123 extern int x_figure_window_size P_ ((struct frame *, Lisp_Object, int));
1125 extern Lisp_Object Vframe_alpha_lower_limit;
1126 extern void x_set_alpha P_ ((struct frame *, Lisp_Object, Lisp_Object));
1128 extern void validate_x_resource_name P_ ((void));
1130 extern Lisp_Object display_x_get_resource (Display_Info *,
1131 Lisp_Object attribute,
1132 Lisp_Object class,
1133 Lisp_Object component,
1134 Lisp_Object subclass);
1136 #endif /* HAVE_WINDOW_SYSTEM */
1138 #endif /* not EMACS_FRAME_H */
1140 /* arch-tag: 0df048ee-e6bf-4f48-bd56-e3cd055dd8c4
1141 (do not change this comment) */