* custom.texi (Init Examples): Add example of changing load-path.
[emacs.git] / src / frame.h
blob9193da3edf328b65fe16da43afdf86f67644ed20
1 /* Define frame-object for GNU Emacs.
2 Copyright (C) 1993, 1994, 1999, 2000, 2001, 2002, 2003, 2004,
3 2005, 2006, 2007, 2008, 2009 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 /* Values used as a bit mask, BOTH == WIDTH | HEIGHT. */
79 FULLSCREEN_NONE = 0,
80 FULLSCREEN_WIDTH = 1,
81 FULLSCREEN_HEIGHT = 2,
82 FULLSCREEN_BOTH = 3,
83 FULLSCREEN_WAIT = 4
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 EMACS_UINT size;
97 struct Lisp_Vector *next;
99 /* All Lisp_Object components must come first.
100 That ensures they are all aligned normally. */
102 /* Name of this frame: a Lisp string. It is used for looking up resources,
103 as well as for the title in some cases. */
104 Lisp_Object name;
106 /* The name to use for the icon, the last time
107 it was refreshed. nil means not explicitly specified. */
108 Lisp_Object icon_name;
110 /* This is the frame title specified explicitly, if any.
111 Usually it is nil. */
112 Lisp_Object title;
114 /* The frame which should receive keystrokes that occur in this
115 frame, or nil if they should go to the frame itself. This is
116 usually nil, but if the frame is minibufferless, we can use this
117 to redirect keystrokes to a surrogate minibuffer frame when
118 needed.
120 Note that a value of nil is different than having the field point
121 to the frame itself. Whenever the Fselect_frame function is used
122 to shift from one frame to the other, any redirections to the
123 original frame are shifted to the newly selected frame; if
124 focus_frame is nil, Fselect_frame will leave it alone. */
125 Lisp_Object focus_frame;
127 /* This frame's root window. Every frame has one.
128 If the frame has only a minibuffer window, this is it.
129 Otherwise, if the frame has a minibuffer window, this is its sibling. */
130 Lisp_Object root_window;
132 /* This frame's selected window.
133 Each frame has its own window hierarchy
134 and one of the windows in it is selected within the frame.
135 The selected window of the selected frame is Emacs's selected window. */
136 Lisp_Object selected_window;
138 /* This frame's minibuffer window.
139 Most frames have their own minibuffer windows,
140 but only the selected frame's minibuffer window
141 can actually appear to exist. */
142 Lisp_Object minibuffer_window;
144 /* Parameter alist of this frame.
145 These are the parameters specified when creating the frame
146 or modified with modify-frame-parameters. */
147 Lisp_Object param_alist;
149 /* List of scroll bars on this frame.
150 Actually, we don't specify exactly what is stored here at all; the
151 scroll bar implementation code can use it to store anything it likes.
152 This field is marked by the garbage collector. It is here
153 instead of in the `device' structure so that the garbage
154 collector doesn't need to look inside the window-system-dependent
155 structure. */
156 Lisp_Object scroll_bars;
157 Lisp_Object condemned_scroll_bars;
159 /* Vector describing the items to display in the menu bar.
160 Each item has four elements in this vector.
161 They are KEY, STRING, SUBMAP, and HPOS.
162 (HPOS is not used in when the X toolkit is in use.)
163 There are four additional elements of nil at the end, to terminate. */
164 Lisp_Object menu_bar_items;
166 /* Alist of elements (FACE-NAME . FACE-VECTOR-DATA). */
167 Lisp_Object face_alist;
169 /* A vector that records the entire structure of this frame's menu bar.
170 For the format of the data, see extensive comments in xmenu.c.
171 Only the X toolkit version uses this. */
172 Lisp_Object menu_bar_vector;
174 /* Predicate for selecting buffers for other-buffer. */
175 Lisp_Object buffer_predicate;
177 /* List of buffers viewed in this frame, for other-buffer. */
178 Lisp_Object buffer_list;
180 /* List of buffers that were viewed, then buried in this frame. The
181 most recently buried buffer is first. For last-buffer. */
182 Lisp_Object buried_buffer_list;
184 /* A dummy window used to display menu bars under X when no X
185 toolkit support is available. */
186 Lisp_Object menu_bar_window;
188 /* A window used to display the tool-bar of a frame. */
189 Lisp_Object tool_bar_window;
191 /* Desired and current tool-bar items. */
192 Lisp_Object tool_bar_items;
194 /* Desired and current contents displayed in tool_bar_window. */
195 Lisp_Object desired_tool_bar_string, current_tool_bar_string;
197 /* Beyond here, there should be no more Lisp_Object components. */
199 /* Cache of realized faces. */
200 struct face_cache *face_cache;
202 /* Number of elements in `menu_bar_vector' that have meaningful data. */
203 EMACS_INT menu_bar_items_used;
205 /* A buffer to hold the frame's name. We can't use the Lisp
206 string's pointer (`name', above) because it might get relocated. */
207 char *namebuf;
209 /* Glyph pool and matrix. */
210 struct glyph_pool *current_pool;
211 struct glyph_pool *desired_pool;
212 struct glyph_matrix *desired_matrix;
213 struct glyph_matrix *current_matrix;
215 /* 1 means that glyphs on this frame have been initialized so it can
216 be used for output. */
217 unsigned glyphs_initialized_p : 1;
219 /* Set to non-zero in change_frame_size when size of frame changed
220 Clear the frame in clear_garbaged_frames if set. */
221 unsigned resized_p : 1;
223 /* Set to non-zero in when we want for force a flush_display in
224 update_frame, usually after resizing the frame. */
225 unsigned force_flush_display_p : 1;
227 /* Set to non-zero if the default face for the frame has been
228 realized. Reset to zero whenever the default face changes.
229 Used to see the difference between a font change and face change. */
230 unsigned default_face_done_p : 1;
232 /* Set to non-zero if this frame has already been hscrolled during
233 current redisplay. */
234 unsigned already_hscrolled_p : 1;
236 /* Set to non-zero when current redisplay has updated frame. */
237 unsigned updated_p : 1;
239 /* Set to non-zero to minimize tool-bar height even when
240 auto-resize-tool-bar is set to grow-only. */
241 unsigned minimize_tool_bar_window_p : 1;
243 #if defined (USE_GTK) || defined (HAVE_NS)
244 /* Nonzero means using a tool bar that comes from the toolkit. */
245 int external_tool_bar;
246 #endif
248 /* Margin at the top of the frame. Used to display the tool-bar. */
249 int tool_bar_lines;
251 int n_tool_bar_rows;
252 int n_tool_bar_items;
254 /* A buffer for decode_mode_line. */
255 char *decode_mode_spec_buffer;
257 /* See do_line_insertion_deletion_costs for info on these arrays. */
258 /* Cost of inserting 1 line on this frame */
259 int *insert_line_cost;
260 /* Cost of deleting 1 line on this frame */
261 int *delete_line_cost;
262 /* Cost of inserting n lines on this frame */
263 int *insert_n_lines_cost;
264 /* Cost of deleting n lines on this frame */
265 int *delete_n_lines_cost;
267 /* Size of this frame, excluding fringes, scroll bars etc.,
268 in units of canonical characters. */
269 EMACS_INT text_lines, text_cols;
271 /* Total size of this frame (i.e. its native window), in units of
272 canonical characters. */
273 EMACS_INT total_lines, total_cols;
275 /* New text height and width for pending size change.
276 0 if no change pending. */
277 int new_text_lines, new_text_cols;
279 /* Pixel position of the frame window (x and y offsets in root window). */
280 int left_pos, top_pos;
282 /* Size of the frame window in pixels. */
283 int pixel_height, pixel_width;
285 /* Dots per inch of the screen the frame is on. */
286 double resx, resy;
288 /* These many pixels are the difference between the outer window (i.e. the
289 left and top of the window manager decoration) and FRAME_X_WINDOW. */
290 int x_pixels_diff, y_pixels_diff;
292 /* This is the gravity value for the specified window position. */
293 int win_gravity;
295 /* The geometry flags for this window. */
296 int size_hint_flags;
298 /* Border width of the frame window as known by the (X) window system. */
299 int border_width;
301 /* Width of the internal border. This is a line of background color
302 just inside the window's border. When the frame is selected,
303 a highlighting is displayed inside the internal border. */
304 int internal_border_width;
306 /* Canonical X unit. Width of default font, in pixels. */
307 int column_width;
309 /* Widht of space glyph of default font, in pixels. */
310 int space_width;
312 /* Canonical Y unit. Height of a line, in pixels. */
313 int line_height;
315 /* The output method says how the contents of this frame are
316 displayed. It could be using termcap, or using an X window.
317 This must be the same as the terminal->type. */
318 enum output_method output_method;
320 /* The terminal device that this frame uses. If this is NULL, then
321 the frame has been deleted. */
322 struct terminal *terminal;
324 /* Device-dependent, frame-local auxiliary data used for displaying
325 the contents. When the frame is deleted, this data is deleted as
326 well. */
327 union output_data
329 struct tty_output *tty; /* termchar.h */
330 struct x_output *x; /* xterm.h */
331 struct w32_output *w32; /* w32term.h */
332 struct ns_output *ns; /* nsterm.h */
333 EMACS_INT nothing;
335 output_data;
337 /* List of font-drivers available on the frame. */
338 struct font_driver_list *font_driver_list;
339 /* List of data specific to font-driver and frame, but common to
340 faces. */
341 struct font_data_list *font_data_list;
343 /* Total width of fringes reserved for drawing truncation bitmaps,
344 continuation bitmaps and alike. The width is in canonical char
345 units of the frame. This must currently be the case because window
346 sizes aren't pixel values. If it weren't the case, we wouldn't be
347 able to split windows horizontally nicely. */
348 int fringe_cols;
350 /* The extra width (in pixels) currently allotted for fringes. */
351 int left_fringe_width, right_fringe_width;
353 /* See FULLSCREEN_ enum below */
354 enum fullscreen_type want_fullscreen;
356 /* Number of lines of menu bar. */
357 int menu_bar_lines;
359 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
360 || defined (HAVE_NS) || defined (USE_GTK)
361 /* Nonzero means using a menu bar that comes from the X toolkit. */
362 unsigned int external_menu_bar : 1;
363 #endif
365 /* Nonzero if last attempt at redisplay on this frame was preempted. */
366 unsigned char display_preempted : 1;
368 /* visible is nonzero if the frame is currently displayed; we check
369 it to see if we should bother updating the frame's contents.
370 DON'T SET IT DIRECTLY; instead, use FRAME_SET_VISIBLE.
372 Note that, since invisible frames aren't updated, whenever a
373 frame becomes visible again, it must be marked as garbaged. The
374 FRAME_SAMPLE_VISIBILITY macro takes care of this.
376 On ttys and on Windows NT/9X, to avoid wasting effort updating
377 visible frames that are actually completely obscured by other
378 windows on the display, we bend the meaning of visible slightly:
379 if greater than 1, then the frame is obscured - we still consider
380 it to be "visible" as seen from lisp, but we don't bother
381 updating it. We must take care to garbage the frame when it
382 ceaces to be obscured though.
384 iconified is nonzero if the frame is currently iconified.
386 Asynchronous input handlers should NOT change these directly;
387 instead, they should change async_visible or async_iconified, and
388 let the FRAME_SAMPLE_VISIBILITY macro set visible and iconified
389 at the next redisplay.
391 These should probably be considered read-only by everyone except
392 FRAME_SAMPLE_VISIBILITY.
394 These two are mutually exclusive. They might both be zero, if the
395 frame has been made invisible without an icon. */
396 unsigned char visible : 2;
397 unsigned char iconified : 1;
399 /* Let's not use bitfields for volatile variables. */
401 /* Asynchronous input handlers change these, and
402 FRAME_SAMPLE_VISIBILITY copies them into visible and iconified.
403 See FRAME_SAMPLE_VISIBILITY, below. */
404 volatile char async_visible, async_iconified;
406 /* Nonzero if this frame should be redrawn. */
407 volatile char garbaged;
409 /* True if frame actually has a minibuffer window on it.
410 0 if using a minibuffer window that isn't on this frame. */
411 unsigned char has_minibuffer : 1;
413 /* 0 means, if this frame has just one window,
414 show no modeline for that window. */
415 unsigned char wants_modeline : 1;
417 /* Non-zero if the hardware device this frame is displaying on can
418 support scroll bars. */
419 char can_have_scroll_bars;
421 /* Non-0 means raise this frame to the top of the heap when selected. */
422 unsigned char auto_raise : 1;
424 /* Non-0 means lower this frame to the bottom of the stack when left. */
425 unsigned char auto_lower : 1;
427 /* True if frame's root window can't be split. */
428 unsigned char no_split : 1;
430 /* If this is set, then Emacs won't change the frame name to indicate
431 the current buffer, etcetera. If the user explicitly sets the frame
432 name, this gets set. If the user sets the name to Qnil, this is
433 cleared. */
434 unsigned char explicit_name : 1;
436 /* Nonzero if size of some window on this frame has changed. */
437 unsigned char window_sizes_changed : 1;
439 /* Nonzero if the mouse has moved on this display device
440 since the last time we checked. */
441 unsigned char mouse_moved :1;
443 /* If can_have_scroll_bars is non-zero, this is non-zero if we should
444 actually display them on this frame. */
445 enum vertical_scroll_bar_type vertical_scroll_bar_type;
447 /* What kind of text cursor should we draw in the future?
448 This should always be filled_box_cursor or bar_cursor. */
449 enum text_cursor_kinds desired_cursor;
451 /* Width of bar cursor (if we are using that). */
452 int cursor_width;
454 /* What kind of text cursor should we draw when the cursor blinks off?
455 This can be filled_box_cursor or bar_cursor or no_cursor. */
456 enum text_cursor_kinds blink_off_cursor;
458 /* Width of bar cursor (if we are using that) for blink-off state. */
459 int blink_off_cursor_width;
461 /* Storage for messages to this frame. */
462 char *message_buf;
464 /* Nonnegative if current redisplay should not do scroll computation
465 for lines beyond a certain vpos. This is the vpos. */
466 int scroll_bottom_vpos;
468 /* Configured width of the scroll bar, in pixels and in characters.
469 config_scroll_bar_cols tracks config_scroll_bar_width if the
470 latter is positive; a zero value in config_scroll_bar_width means
471 to compute the actual width on the fly, using config_scroll_bar_cols
472 and the current font width. */
473 int config_scroll_bar_width;
474 int config_scroll_bar_cols;
476 /* The size of the extra width currently allotted for vertical
477 scroll bars in this frame, in pixels. */
478 int scroll_bar_actual_width;
480 /* The baud rate that was used to calculate costs for this frame. */
481 int cost_calculation_baud_rate;
483 /* frame opacity
484 alpha[0]: alpha transparency of the active frame
485 alpha[1]: alpha transparency of inactive frames
486 Negative values mean not to change alpha. */
487 double alpha[2];
489 /* Exponent for gamma correction of colors. 1/(VIEWING_GAMMA *
490 SCREEN_GAMMA) where viewing_gamma is 0.4545 and SCREEN_GAMMA is a
491 frame parameter. 0 means don't do gamma correction. */
492 double gamma;
494 /* Additional space to put between text lines on this frame. */
495 int extra_line_spacing;
497 /* All display backends seem to need these two pixel values. */
498 unsigned long background_pixel;
499 unsigned long foreground_pixel;
502 #define FRAME_KBOARD(f) ((f)->terminal->kboard)
504 /* Return a pointer to the image cache of frame F. */
505 #define FRAME_IMAGE_CACHE(F) ((F)->terminal->image_cache)
507 typedef struct frame *FRAME_PTR;
509 #define XFRAME(p) (eassert (FRAMEP(p)),(struct frame *) XPNTR (p))
510 #define XSETFRAME(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_FRAME))
512 /* Given a window, return its frame as a Lisp_Object. */
513 #define WINDOW_FRAME(w) (w)->frame
515 /* Test a frame for particular kinds of display methods. */
516 #define FRAME_INITIAL_P(f) ((f)->output_method == output_initial)
517 #define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap)
518 #define FRAME_X_P(f) ((f)->output_method == output_x_window)
519 #define FRAME_W32_P(f) ((f)->output_method == output_w32)
520 #define FRAME_MSDOS_P(f) ((f)->output_method == output_msdos_raw)
521 #define FRAME_MAC_P(f) ((f)->output_method == output_mac)
522 #define FRAME_NS_P(f) ((f)->output_method == output_ns)
524 /* FRAME_WINDOW_P tests whether the frame is a window, and is
525 defined to be the predicate for the window system being used. */
527 #ifdef HAVE_X_WINDOWS
528 #define FRAME_WINDOW_P(f) FRAME_X_P (f)
529 #endif
530 #ifdef HAVE_NTGUI
531 #define FRAME_WINDOW_P(f) FRAME_W32_P (f)
532 #endif
533 #ifdef HAVE_NS
534 #define FRAME_WINDOW_P(f) FRAME_NS_P(f)
535 #endif
536 #ifndef FRAME_WINDOW_P
537 #define FRAME_WINDOW_P(f) (0)
538 #endif
540 /* Nonzero if frame F is still alive (not deleted). */
541 #define FRAME_LIVE_P(f) ((f)->terminal != 0)
543 /* Nonzero if frame F is a minibuffer-only frame. */
544 #define FRAME_MINIBUF_ONLY_P(f) \
545 EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f))
547 /* Nonzero if frame F contains a minibuffer window.
548 (If this is 0, F must use some other minibuffer window.) */
549 #define FRAME_HAS_MINIBUF_P(f) ((f)->has_minibuffer)
551 /* Pixel height of frame F, including non-toolkit menu bar and
552 non-toolkit tool bar lines. */
553 #define FRAME_PIXEL_HEIGHT(f) ((f)->pixel_height)
555 /* Pixel width of frame F. */
556 #define FRAME_PIXEL_WIDTH(f) ((f)->pixel_width)
558 /* Height of frame F, measured in canonical lines, including
559 non-toolkit menu bar and non-toolkit tool bar lines. */
560 #define FRAME_LINES(f) (f)->text_lines
562 /* Width of frame F, measured in canonical character columns,
563 not including scroll bars if any. */
564 #define FRAME_COLS(f) (f)->text_cols
566 /* Number of lines of frame F used for menu bar.
567 This is relevant on terminal frames and on
568 X Windows when not using the X toolkit.
569 These lines are counted in FRAME_LINES. */
570 #define FRAME_MENU_BAR_LINES(f) (f)->menu_bar_lines
572 /* Nonzero if this frame should display a tool bar
573 in a way that does not use any text lines. */
574 #if defined (USE_GTK) || defined (HAVE_NS)
575 #define FRAME_EXTERNAL_TOOL_BAR(f) (f)->external_tool_bar
576 #else
577 #define FRAME_EXTERNAL_TOOL_BAR(f) 0
578 #endif
580 /* Number of lines of frame F used for the tool-bar. */
582 #define FRAME_TOOL_BAR_LINES(f) (f)->tool_bar_lines
585 /* Lines above the top-most window in frame F. */
587 #define FRAME_TOP_MARGIN(F) \
588 (FRAME_MENU_BAR_LINES (F) + FRAME_TOOL_BAR_LINES (F))
590 /* Nonzero if this frame should display a menu bar
591 in a way that does not use any text lines. */
592 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
593 || defined (HAVE_NS) || defined (USE_GTK)
594 #define FRAME_EXTERNAL_MENU_BAR(f) (f)->external_menu_bar
595 #else
596 #define FRAME_EXTERNAL_MENU_BAR(f) 0
597 #endif
598 #define FRAME_VISIBLE_P(f) ((f)->visible != 0)
600 /* Nonzero if frame F is currently visible but hidden. */
601 #define FRAME_OBSCURED_P(f) ((f)->visible > 1)
603 /* Nonzero if frame F is currently iconified. */
604 #define FRAME_ICONIFIED_P(f) (f)->iconified
606 #define FRAME_SET_VISIBLE(f,p) \
607 ((f)->async_visible = (p), FRAME_SAMPLE_VISIBILITY (f))
608 #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1, f->garbaged = 1)
609 #define FRAME_GARBAGED_P(f) (f)->garbaged
611 /* Nonzero means do not allow splitting this frame's window. */
612 #define FRAME_NO_SPLIT_P(f) (f)->no_split
614 /* Not really implemented. */
615 #define FRAME_WANTS_MODELINE_P(f) (f)->wants_modeline
617 /* Nonzero if a size change has been requested for frame F
618 but not yet really put into effect. This can be true temporarily
619 when an X event comes in at a bad time. */
620 #define FRAME_WINDOW_SIZES_CHANGED(f) (f)->window_sizes_changed
622 /* The minibuffer window of frame F, if it has one; otherwise nil. */
623 #define FRAME_MINIBUF_WINDOW(f) (f)->minibuffer_window
625 /* The root window of the window tree of frame F. */
626 #define FRAME_ROOT_WINDOW(f) (f)->root_window
628 /* The currently selected window of the window tree of frame F. */
629 #define FRAME_SELECTED_WINDOW(f) (f)->selected_window
631 #define FRAME_INSERT_COST(f) (f)->insert_line_cost
632 #define FRAME_DELETE_COST(f) (f)->delete_line_cost
633 #define FRAME_INSERTN_COST(f) (f)->insert_n_lines_cost
634 #define FRAME_DELETEN_COST(f) (f)->delete_n_lines_cost
635 #define FRAME_MESSAGE_BUF(f) (f)->message_buf
636 #define FRAME_SCROLL_BOTTOM_VPOS(f) (f)->scroll_bottom_vpos
637 #define FRAME_FOCUS_FRAME(f) (f)->focus_frame
639 /* Nonzero if frame F supports scroll bars.
640 If this is zero, then it is impossible to enable scroll bars
641 on frame F. */
642 #define FRAME_CAN_HAVE_SCROLL_BARS(f) ((f)->can_have_scroll_bars)
644 /* This frame slot says whether scroll bars are currently enabled for frame F,
645 and which side they are on. */
646 #define FRAME_VERTICAL_SCROLL_BAR_TYPE(f) ((f)->vertical_scroll_bar_type)
647 #define FRAME_HAS_VERTICAL_SCROLL_BARS(f) \
648 ((f)->vertical_scroll_bar_type != vertical_scroll_bar_none)
649 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT(f) \
650 ((f)->vertical_scroll_bar_type == vertical_scroll_bar_left)
651 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT(f) \
652 ((f)->vertical_scroll_bar_type == vertical_scroll_bar_right)
654 /* Width that a scroll bar in frame F should have, if there is one.
655 Measured in pixels.
656 If scroll bars are turned off, this is still nonzero. */
657 #define FRAME_CONFIG_SCROLL_BAR_WIDTH(f) ((f)->config_scroll_bar_width)
659 /* Width that a scroll bar in frame F should have, if there is one.
660 Measured in columns (characters).
661 If scroll bars are turned off, this is still nonzero. */
662 #define FRAME_CONFIG_SCROLL_BAR_COLS(f) ((f)->config_scroll_bar_cols)
664 /* Width of a scroll bar in frame F, measured in columns (characters),
665 but only if scroll bars are on the left. If scroll bars are on
666 the right in this frame, or there are no scroll bars, value is 0. */
668 #define FRAME_LEFT_SCROLL_BAR_COLS(f) \
669 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \
670 ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
671 : 0)
673 /* Width of a left scroll bar in frame F, measured in pixels */
675 #define FRAME_LEFT_SCROLL_BAR_AREA_WIDTH(f) \
676 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \
677 ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)) \
678 : 0)
680 /* Width of a scroll bar in frame F, measured in columns (characters),
681 but only if scroll bars are on the right. If scroll bars are on
682 the left in this frame, or there are no scroll bars, value is 0. */
684 #define FRAME_RIGHT_SCROLL_BAR_COLS(f) \
685 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f) \
686 ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
687 : 0)
689 /* Width of a right scroll bar area in frame F, measured in pixels */
691 #define FRAME_RIGHT_SCROLL_BAR_AREA_WIDTH(f) \
692 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f) \
693 ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)) \
694 : 0)
696 /* Actual width of a scroll bar in frame F, measured in columns. */
698 #define FRAME_SCROLL_BAR_COLS(f) \
699 (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \
700 ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
701 : 0)
703 /* Actual width of a scroll bar area in frame F, measured in pixels. */
705 #define FRAME_SCROLL_BAR_AREA_WIDTH(f) \
706 (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \
707 ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)) \
708 : 0)
710 /* Total width of frame F, in columns (characters),
711 including the width used by scroll bars if any. */
713 #define FRAME_TOTAL_COLS(f) ((f)->total_cols)
715 /* Set the width of frame F to VAL.
716 VAL is the width of a full-frame window,
717 not including scroll bars and fringes. */
719 #define SET_FRAME_COLS(f, val) \
720 (FRAME_COLS (f) = (val), \
721 (f)->total_cols = FRAME_TOTAL_COLS_ARG (f, FRAME_COLS (f)))
723 /* Given a value WIDTH for frame F's nominal width,
724 return the value that FRAME_TOTAL_COLS should have. */
726 #define FRAME_TOTAL_COLS_ARG(f, width) \
727 ((width) \
728 + FRAME_SCROLL_BAR_COLS (f) \
729 + FRAME_FRINGE_COLS (f))
731 /* Maximum + 1 legitimate value for FRAME_CURSOR_X. */
733 #define FRAME_CURSOR_X_LIMIT(f) \
734 (FRAME_COLS (f) + FRAME_LEFT_SCROLL_BAR_COLS (f))
736 /* Nonzero if frame F has scroll bars. */
738 #define FRAME_SCROLL_BARS(f) ((f)->scroll_bars)
740 #define FRAME_CONDEMNED_SCROLL_BARS(f) ((f)->condemned_scroll_bars)
741 #define FRAME_MENU_BAR_ITEMS(f) ((f)->menu_bar_items)
742 #define FRAME_COST_BAUD_RATE(f) ((f)->cost_calculation_baud_rate)
744 #define FRAME_DESIRED_CURSOR(f) ((f)->desired_cursor)
745 #define FRAME_BLINK_OFF_CURSOR(f) ((f)->blink_off_cursor)
746 #define FRAME_CURSOR_WIDTH(f) ((f)->cursor_width)
747 #define FRAME_BLINK_OFF_CURSOR_WIDTH(f) ((f)->blink_off_cursor_width)
749 /* Return a pointer to the face cache of frame F. */
751 #define FRAME_FACE_CACHE(F) (F)->face_cache
753 /* Return the size of message_buf of the frame F. We multiply the
754 width of the frame by 4 because multi-byte form may require at most
755 4-byte for a character. */
757 #define FRAME_MESSAGE_BUF_SIZE(f) (((int) FRAME_COLS (f)) * 4)
759 /* Emacs's redisplay code could become confused if a frame's
760 visibility changes at arbitrary times. For example, if a frame is
761 visible while the desired glyphs are being built, but becomes
762 invisible before they are updated, then some rows of the
763 desired_glyphs will be left marked as enabled after redisplay is
764 complete, which should never happen. The next time the frame
765 becomes visible, redisplay will probably barf.
767 Currently, there are no similar situations involving iconified, but
768 the principle is the same.
770 So instead of having asynchronous input handlers directly set and
771 clear the frame's visibility and iconification flags, they just set
772 the async_visible and async_iconified flags; the redisplay code
773 calls the FRAME_SAMPLE_VISIBILITY macro before doing any redisplay,
774 which sets visible and iconified from their asynchronous
775 counterparts.
777 Synchronous code must use the FRAME_SET_VISIBLE macro.
779 Also, if a frame used to be invisible, but has just become visible,
780 it must be marked as garbaged, since redisplay hasn't been keeping
781 up its contents.
783 Note that a tty frame is visible if and only if it is the topmost
784 frame. */
786 #define FRAME_SAMPLE_VISIBILITY(f) \
787 (((f)->async_visible && (f)->visible != (f)->async_visible) ? \
788 SET_FRAME_GARBAGED (f) : 0, \
789 (f)->visible = (f)->async_visible, \
790 (f)->iconified = (f)->async_iconified)
792 #define CHECK_FRAME(x) \
793 CHECK_TYPE (FRAMEP (x), Qframep, x)
795 #define CHECK_LIVE_FRAME(x) \
796 CHECK_TYPE (FRAMEP (x) && FRAME_LIVE_P (XFRAME (x)), Qframe_live_p, x)
798 /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
799 `for' loop which iterates over the elements of Vframe_list. The
800 loop will set FRAME_VAR, a Lisp_Object, to each frame in
801 Vframe_list in succession and execute the statement. LIST_VAR
802 should be a Lisp_Object too; it is used to iterate through the
803 Vframe_list.
805 This macro is a holdover from a time when multiple frames weren't always
806 supported. An alternate definition of the macro would expand to
807 something which executes the statement once. */
809 #define FOR_EACH_FRAME(list_var, frame_var) \
810 for ((list_var) = Vframe_list; \
811 (CONSP (list_var) \
812 && (frame_var = XCAR (list_var), 1)); \
813 list_var = XCDR (list_var))
816 extern Lisp_Object Qframep, Qframe_live_p;
817 extern Lisp_Object Qtty, Qtty_type;
818 extern Lisp_Object Qterminal, Qterminal_live_p;
819 extern Lisp_Object Qnoelisp;
821 extern struct frame *last_nonminibuf_frame;
823 extern struct frame *make_initial_frame P_ ((void));
824 extern struct frame *make_terminal_frame P_ ((struct terminal *));
825 extern struct frame *make_frame P_ ((int));
826 #ifdef HAVE_WINDOW_SYSTEM
827 extern struct frame *make_minibuffer_frame P_ ((void));
828 extern struct frame *make_frame_without_minibuffer P_ ((Lisp_Object,
829 struct kboard *,
830 Lisp_Object));
831 #endif /* HAVE_WINDOW_SYSTEM */
832 extern int other_visible_frames P_ ((struct frame *));
834 extern Lisp_Object Vframe_list;
835 extern Lisp_Object Vdefault_frame_alist;
837 extern Lisp_Object Vterminal_frame;
839 extern Lisp_Object Vmouse_highlight;
841 /* The currently selected frame. */
843 extern Lisp_Object selected_frame;
845 /* Value is a pointer to the selected frame. If the selected frame
846 isn't live, abort. */
848 #define SELECTED_FRAME() \
849 ((FRAMEP (selected_frame) \
850 && FRAME_LIVE_P (XFRAME (selected_frame))) \
851 ? XFRAME (selected_frame) \
852 : (abort (), (struct frame *) 0))
855 /***********************************************************************
856 Display-related Macros
857 ***********************************************************************/
859 /* Canonical y-unit on frame F.
860 This value currently equals the line height of the frame (which is
861 the height of the default font of F). */
863 #define FRAME_LINE_HEIGHT(F) ((F)->line_height)
865 /* Canonical x-unit on frame F.
866 This value currently equals the average width of the default font of F. */
868 #define FRAME_COLUMN_WIDTH(F) ((F)->column_width)
870 /* Space glyph width of the default font of frame F. */
872 #define FRAME_SPACE_WIDTH(F) ((F)->space_width)
875 /* Pixel width of areas used to display truncation marks, continuation
876 marks, overlay arrows. This is 0 for terminal frames. */
878 #ifdef HAVE_WINDOW_SYSTEM
880 /* Total width of fringes reserved for drawing truncation bitmaps,
881 continuation bitmaps and alike. The width is in canonical char
882 units of the frame. This must currently be the case because window
883 sizes aren't pixel values. If it weren't the case, we wouldn't be
884 able to split windows horizontally nicely. */
886 #define FRAME_FRINGE_COLS(F) ((F)->fringe_cols)
888 /* Pixel-width of the left and right fringe. */
890 #define FRAME_LEFT_FRINGE_WIDTH(F) ((F)->left_fringe_width)
891 #define FRAME_RIGHT_FRINGE_WIDTH(F) ((F)->right_fringe_width)
893 /* Total width of fringes in pixels. */
895 #define FRAME_TOTAL_FRINGE_WIDTH(F) \
896 (FRAME_LEFT_FRINGE_WIDTH (F) + FRAME_RIGHT_FRINGE_WIDTH (F))
899 /* Pixel-width of internal border lines */
901 #define FRAME_INTERNAL_BORDER_WIDTH(F) ((F)->internal_border_width)
903 #else /* not HAVE_WINDOW_SYSTEM */
905 #define FRAME_FRINGE_COLS(F) 0
906 #define FRAME_TOTAL_FRINGE_WIDTH(F) 0
907 #define FRAME_LEFT_FRINGE_WIDTH(F) 0
908 #define FRAME_RIGHT_FRINGE_WIDTH(F) 0
909 #define FRAME_INTERNAL_BORDER_WIDTH(F) 0
911 #endif /* not HAVE_WINDOW_SYSTEM */
916 /***********************************************************************
917 Conversion between canonical units and pixels
918 ***********************************************************************/
920 /* Canonical x-values are fractions of FRAME_COLUMN_WIDTH, canonical
921 y-unit are fractions of FRAME_LINE_HEIGHT of a frame. Both are
922 represented as Lisp numbers, i.e. integers or floats. */
924 /* Convert canonical value X to pixels. F is the frame whose
925 canonical char width is to be used. X must be a Lisp integer or
926 float. Value is a C integer. */
928 #define FRAME_PIXEL_X_FROM_CANON_X(F, X) \
929 (INTEGERP (X) \
930 ? XINT (X) * FRAME_COLUMN_WIDTH (F) \
931 : (int) (XFLOAT_DATA (X) * FRAME_COLUMN_WIDTH (F)))
933 /* Convert canonical value Y to pixels. F is the frame whose
934 canonical character height is to be used. X must be a Lisp integer
935 or float. Value is a C integer. */
937 #define FRAME_PIXEL_Y_FROM_CANON_Y(F, Y) \
938 (INTEGERP (Y) \
939 ? XINT (Y) * FRAME_LINE_HEIGHT (F) \
940 : (int) (XFLOAT_DATA (Y) * FRAME_LINE_HEIGHT (F)))
942 /* Convert pixel-value X to canonical units. F is the frame whose
943 canonical character width is to be used. X is a C integer. Result
944 is a Lisp float if X is not a multiple of the canon width,
945 otherwise it's a Lisp integer. */
947 #define FRAME_CANON_X_FROM_PIXEL_X(F, X) \
948 ((X) % FRAME_COLUMN_WIDTH (F) != 0 \
949 ? make_float ((double) (X) / FRAME_COLUMN_WIDTH (F)) \
950 : make_number ((X) / FRAME_COLUMN_WIDTH (F)))
952 /* Convert pixel-value Y to canonical units. F is the frame whose
953 canonical character height is to be used. Y is a C integer.
954 Result is a Lisp float if Y is not a multiple of the canon width,
955 otherwise it's a Lisp integer. */
957 #define FRAME_CANON_Y_FROM_PIXEL_Y(F, Y) \
958 ((Y) % FRAME_LINE_HEIGHT (F) \
959 ? make_float ((double) (Y) / FRAME_LINE_HEIGHT (F)) \
960 : make_number ((Y) / FRAME_LINE_HEIGHT (F)))
964 /* Manipulating pixel sizes and character sizes.
965 Knowledge of which factors affect the overall size of the window should
966 be hidden in these macros, if that's possible.
968 Return the upper/left pixel position of the character cell on frame F
969 at ROW/COL. */
971 #define FRAME_LINE_TO_PIXEL_Y(f, row) \
972 (FRAME_INTERNAL_BORDER_WIDTH (f) \
973 + (row) * FRAME_LINE_HEIGHT (f))
975 #define FRAME_COL_TO_PIXEL_X(f, col) \
976 (FRAME_INTERNAL_BORDER_WIDTH (f) \
977 + (col) * FRAME_COLUMN_WIDTH (f))
979 /* Return the pixel width/height of frame F if it has
980 COLS columns/LINES rows. */
982 #define FRAME_TEXT_COLS_TO_PIXEL_WIDTH(f, cols) \
983 (FRAME_COL_TO_PIXEL_X (f, cols) \
984 + (f)->scroll_bar_actual_width \
985 + FRAME_TOTAL_FRINGE_WIDTH (f) \
986 + FRAME_INTERNAL_BORDER_WIDTH (f))
988 #define FRAME_TEXT_LINES_TO_PIXEL_HEIGHT(f, lines) \
989 (FRAME_LINE_TO_PIXEL_Y (f, lines) \
990 + FRAME_INTERNAL_BORDER_WIDTH (f))
993 /* Return the row/column (zero-based) of the character cell containing
994 the pixel on FRAME at Y/X. */
996 #define FRAME_PIXEL_Y_TO_LINE(f, y) \
997 (((y) - FRAME_INTERNAL_BORDER_WIDTH (f)) \
998 / FRAME_LINE_HEIGHT (f))
1000 #define FRAME_PIXEL_X_TO_COL(f, x) \
1001 (((x) - FRAME_INTERNAL_BORDER_WIDTH (f)) \
1002 / FRAME_COLUMN_WIDTH (f))
1004 /* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
1005 frame F? */
1007 #define FRAME_PIXEL_WIDTH_TO_TEXT_COLS(f, width) \
1008 (FRAME_PIXEL_X_TO_COL (f, ((width) \
1009 - FRAME_INTERNAL_BORDER_WIDTH (f) \
1010 - FRAME_TOTAL_FRINGE_WIDTH (f) \
1011 - (f)->scroll_bar_actual_width)))
1013 #define FRAME_PIXEL_HEIGHT_TO_TEXT_LINES(f, height) \
1014 (FRAME_PIXEL_Y_TO_LINE (f, ((height) \
1015 - FRAME_INTERNAL_BORDER_WIDTH (f))))
1018 /***********************************************************************
1019 Frame Parameters
1020 ***********************************************************************/
1022 extern Lisp_Object Qauto_raise, Qauto_lower;
1023 extern Lisp_Object Qborder_color, Qborder_width;
1024 extern Lisp_Object Qbuffer_predicate, Qbuffer_list, Qburied_buffer_list;
1025 extern Lisp_Object Qcursor_color, Qcursor_type;
1026 extern Lisp_Object Qfont;
1027 extern Lisp_Object Qbackground_color, Qforeground_color;
1028 extern Lisp_Object Qicon, Qicon_name, Qicon_type, Qicon_left, Qicon_top;
1029 extern Lisp_Object Qinternal_border_width;
1030 extern Lisp_Object Qmenu_bar_lines, Qtool_bar_lines;
1031 extern Lisp_Object Qmouse_color;
1032 extern Lisp_Object Qname, Qtitle;
1033 extern Lisp_Object Qparent_id;
1034 extern Lisp_Object Qunsplittable, Qvisibility;
1035 extern Lisp_Object Qscroll_bar_width, Qvertical_scroll_bars;
1036 extern Lisp_Object Qscroll_bar_foreground, Qscroll_bar_background;
1037 extern Lisp_Object Qscreen_gamma;
1038 extern Lisp_Object Qline_spacing;
1039 extern Lisp_Object Qwait_for_wm;
1040 extern Lisp_Object Qfullscreen;
1041 extern Lisp_Object Qfont_backend;
1042 extern Lisp_Object Qalpha;
1044 extern Lisp_Object Qleft_fringe, Qright_fringe;
1045 extern Lisp_Object Qheight, Qwidth;
1046 extern Lisp_Object Qminibuffer, Qmodeline;
1047 extern Lisp_Object Qonly;
1048 extern Lisp_Object Qx, Qw32, Qmac, Qpc, Qns;
1049 extern Lisp_Object Qvisible;
1050 extern Lisp_Object Qdisplay_type;
1051 extern Lisp_Object Qbackground_mode;
1053 extern Lisp_Object Qx_resource_name;
1055 extern Lisp_Object Qleft, Qright, Qtop, Qbox;
1056 extern Lisp_Object Qdisplay;
1058 #ifdef HAVE_WINDOW_SYSTEM
1060 /* The class of this X application. */
1061 #define EMACS_CLASS "Emacs"
1063 /* These are in xterm.c, w32term.c, etc. */
1065 extern void x_set_scroll_bar_default_width P_ ((struct frame *));
1066 extern void x_set_offset P_ ((struct frame *, int, int, int));
1067 extern void x_wm_set_icon_position P_ ((struct frame *, int, int));
1069 extern Lisp_Object x_new_font P_ ((struct frame *, Lisp_Object, int));
1071 /* These are in frame.c */
1073 extern Lisp_Object Vx_resource_name;
1074 extern Lisp_Object Vx_resource_class;
1077 extern Lisp_Object Qface_set_after_frame_default;
1079 extern void x_fullscreen_adjust P_ ((struct frame *f, int *, int *,
1080 int *, int *));
1082 extern void x_set_frame_parameters P_ ((struct frame *, Lisp_Object));
1083 extern void x_report_frame_params P_ ((struct frame *, Lisp_Object *));
1085 extern void x_set_fullscreen P_ ((struct frame *, Lisp_Object, Lisp_Object));
1086 extern void x_set_line_spacing P_ ((struct frame *, Lisp_Object, Lisp_Object));
1087 extern void x_set_screen_gamma P_ ((struct frame *, Lisp_Object, Lisp_Object));
1088 extern void x_set_font P_ ((struct frame *, Lisp_Object, Lisp_Object));
1089 extern void x_set_font_backend P_ ((struct frame *, Lisp_Object, Lisp_Object));
1090 extern void x_set_fringe_width P_ ((struct frame *, Lisp_Object, Lisp_Object));
1091 extern void x_set_border_width P_ ((struct frame *, Lisp_Object, Lisp_Object));
1092 extern void x_set_internal_border_width P_ ((struct frame *, Lisp_Object,
1093 Lisp_Object));
1094 extern void x_set_visibility P_ ((struct frame *, Lisp_Object, Lisp_Object));
1095 extern void x_set_autoraise P_ ((struct frame *, Lisp_Object, Lisp_Object));
1096 extern void x_set_autolower P_ ((struct frame *, Lisp_Object, Lisp_Object));
1097 extern void x_set_unsplittable P_ ((struct frame *, Lisp_Object, Lisp_Object));
1098 extern void x_set_vertical_scroll_bars P_ ((struct frame *, Lisp_Object,
1099 Lisp_Object));
1100 extern void x_set_scroll_bar_width P_ ((struct frame *, Lisp_Object,
1101 Lisp_Object));
1103 extern Lisp_Object x_icon_type P_ ((struct frame *));
1105 extern int x_figure_window_size P_ ((struct frame *, Lisp_Object, int));
1107 extern Lisp_Object Vframe_alpha_lower_limit;
1108 extern void x_set_alpha P_ ((struct frame *, Lisp_Object, Lisp_Object));
1110 extern void validate_x_resource_name P_ ((void));
1112 extern Lisp_Object display_x_get_resource (Display_Info *,
1113 Lisp_Object attribute,
1114 Lisp_Object class,
1115 Lisp_Object component,
1116 Lisp_Object subclass);
1118 extern Lisp_Object delete_frame P_ ((Lisp_Object, Lisp_Object));
1120 #endif /* HAVE_WINDOW_SYSTEM */
1122 #endif /* not EMACS_FRAME_H */
1124 /* arch-tag: 0df048ee-e6bf-4f48-bd56-e3cd055dd8c4
1125 (do not change this comment) */