* progmodes/python.el Fixed defsubst warning.
[emacs.git] / src / frame.h
blobe07974fb4d273b6e6e0f526efb9e5f6ab63ff1d3
1 /* Define frame-object for GNU Emacs.
2 Copyright (C) 1993-1994, 1999-2012 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
19 /* Don't multiply include: dispextern.h includes macterm.h which
20 includes frame.h some emacs source includes both dispextern.h and
21 frame.h */
23 #ifndef EMACS_FRAME_H
24 #define EMACS_FRAME_H
26 #include "dispextern.h"
29 /* Miscellanea. */
31 /* Nonzero means there is at least one garbaged frame. */
32 extern int frame_garbaged;
35 /* The structure representing a frame. */
37 enum output_method
39 output_initial,
40 output_termcap,
41 output_x_window,
42 output_msdos_raw,
43 output_w32,
44 output_mac,
45 output_ns
48 enum vertical_scroll_bar_type
50 vertical_scroll_bar_none,
51 vertical_scroll_bar_left,
52 vertical_scroll_bar_right
55 enum text_cursor_kinds
57 DEFAULT_CURSOR = -2,
58 NO_CURSOR = -1,
59 FILLED_BOX_CURSOR,
60 HOLLOW_BOX_CURSOR,
61 BAR_CURSOR,
62 HBAR_CURSOR
65 enum fullscreen_type
67 FULLSCREEN_NONE,
68 FULLSCREEN_WIDTH = 0x001,
69 FULLSCREEN_HEIGHT = 0x002,
70 FULLSCREEN_BOTH = 0x003,
71 FULLSCREEN_MAXIMIZED = 0x013,
72 FULLSCREEN_WAIT = 0x100
76 #define FRAME_FOREGROUND_PIXEL(f) ((f)->foreground_pixel)
77 #define FRAME_BACKGROUND_PIXEL(f) ((f)->background_pixel)
79 struct terminal;
81 struct font_driver_list;
83 /* Most code should use this macro to set Lisp field in struct frame. */
85 #define FSET(f, field, value) ((f)->field = (value))
87 struct frame
89 struct vectorlike_header header;
91 /* All Lisp_Object components must come first.
92 That ensures they are all aligned normally. */
94 /* Name of this frame: a Lisp string. It is used for looking up resources,
95 as well as for the title in some cases. */
96 Lisp_Object name;
98 /* The name to use for the icon, the last time
99 it was refreshed. nil means not explicitly specified. */
100 Lisp_Object icon_name;
102 /* This is the frame title specified explicitly, if any.
103 Usually it is nil. */
104 Lisp_Object title;
106 /* The frame which should receive keystrokes that occur in this
107 frame, or nil if they should go to the frame itself. This is
108 usually nil, but if the frame is minibufferless, we can use this
109 to redirect keystrokes to a surrogate minibuffer frame when
110 needed.
112 Note that a value of nil is different than having the field point
113 to the frame itself. Whenever the Fselect_frame function is used
114 to shift from one frame to the other, any redirections to the
115 original frame are shifted to the newly selected frame; if
116 focus_frame is nil, Fselect_frame will leave it alone. */
117 Lisp_Object focus_frame;
119 /* This frame's root window. Every frame has one.
120 If the frame has only a minibuffer window, this is it.
121 Otherwise, if the frame has a minibuffer window, this is its sibling. */
122 Lisp_Object root_window;
124 /* This frame's selected window.
125 Each frame has its own window hierarchy
126 and one of the windows in it is selected within the frame.
127 The selected window of the selected frame is Emacs's selected window. */
128 Lisp_Object selected_window;
130 /* This frame's minibuffer window.
131 Most frames have their own minibuffer windows,
132 but only the selected frame's minibuffer window
133 can actually appear to exist. */
134 Lisp_Object minibuffer_window;
136 /* Parameter alist of this frame.
137 These are the parameters specified when creating the frame
138 or modified with modify-frame-parameters. */
139 Lisp_Object param_alist;
141 /* List of scroll bars on this frame.
142 Actually, we don't specify exactly what is stored here at all; the
143 scroll bar implementation code can use it to store anything it likes.
144 This field is marked by the garbage collector. It is here
145 instead of in the `device' structure so that the garbage
146 collector doesn't need to look inside the window-system-dependent
147 structure. */
148 Lisp_Object scroll_bars;
149 Lisp_Object condemned_scroll_bars;
151 /* Vector describing the items to display in the menu bar.
152 Each item has four elements in this vector.
153 They are KEY, STRING, SUBMAP, and HPOS.
154 (HPOS is not used in when the X toolkit is in use.)
155 There are four additional elements of nil at the end, to terminate. */
156 Lisp_Object menu_bar_items;
158 /* Alist of elements (FACE-NAME . FACE-VECTOR-DATA). */
159 Lisp_Object face_alist;
161 /* A vector that records the entire structure of this frame's menu bar.
162 For the format of the data, see extensive comments in xmenu.c.
163 Only the X toolkit version uses this. */
164 Lisp_Object menu_bar_vector;
166 /* Predicate for selecting buffers for other-buffer. */
167 Lisp_Object buffer_predicate;
169 /* List of buffers viewed in this frame, for other-buffer. */
170 Lisp_Object buffer_list;
172 /* List of buffers that were viewed, then buried in this frame. The
173 most recently buried buffer is first. For last-buffer. */
174 Lisp_Object buried_buffer_list;
176 /* A dummy window used to display menu bars under X when no X
177 toolkit support is available. */
178 Lisp_Object menu_bar_window;
180 /* A window used to display the tool-bar of a frame. */
181 Lisp_Object tool_bar_window;
183 /* Desired and current tool-bar items. */
184 Lisp_Object tool_bar_items;
186 /* Where tool bar is, can be left, right, top or bottom. The native
187 tool bar only supports top. */
188 Lisp_Object tool_bar_position;
190 /* Desired and current contents displayed in tool_bar_window. */
191 Lisp_Object desired_tool_bar_string;
192 Lisp_Object current_tool_bar_string;
194 /* Beyond here, there should be no more Lisp_Object components. */
196 /* Cache of realized faces. */
197 struct face_cache *face_cache;
199 /* Number of elements in `menu_bar_vector' that have meaningful data. */
200 int menu_bar_items_used;
202 /* A buffer to hold the frame's name. We can't use the Lisp
203 string's pointer (`name', above) because it might get relocated. */
204 char *namebuf;
206 /* Glyph pool and matrix. */
207 struct glyph_pool *current_pool;
208 struct glyph_pool *desired_pool;
209 struct glyph_matrix *desired_matrix;
210 struct glyph_matrix *current_matrix;
212 /* 1 means that glyphs on this frame have been initialized so it can
213 be used for output. */
214 unsigned glyphs_initialized_p : 1;
216 /* Set to non-zero in change_frame_size when size of frame changed
217 Clear the frame in clear_garbaged_frames if set. */
218 unsigned resized_p : 1;
220 /* Set to non-zero in when we want for force a flush_display in
221 update_frame, usually after resizing the frame. */
222 unsigned force_flush_display_p : 1;
224 /* Set to non-zero if the default face for the frame has been
225 realized. Reset to zero whenever the default face changes.
226 Used to see the difference between a font change and face change. */
227 unsigned default_face_done_p : 1;
229 /* Set to non-zero if this frame has already been hscrolled during
230 current redisplay. */
231 unsigned already_hscrolled_p : 1;
233 /* Set to non-zero when current redisplay has updated frame. */
234 unsigned updated_p : 1;
236 /* Set to non-zero to minimize tool-bar height even when
237 auto-resize-tool-bar is set to grow-only. */
238 unsigned minimize_tool_bar_window_p : 1;
240 #if defined (USE_GTK) || defined (HAVE_NS)
241 /* Nonzero means using a tool bar that comes from the toolkit. */
242 int external_tool_bar;
243 #endif
245 /* Margin at the top of the frame. Used to display the tool-bar. */
246 int tool_bar_lines;
248 int n_tool_bar_rows;
249 int n_tool_bar_items;
251 /* A buffer for decode_mode_line. */
252 char *decode_mode_spec_buffer;
254 /* See do_line_insertion_deletion_costs for info on these arrays. */
255 /* Cost of inserting 1 line on this frame */
256 int *insert_line_cost;
257 /* Cost of deleting 1 line on this frame */
258 int *delete_line_cost;
259 /* Cost of inserting n lines on this frame */
260 int *insert_n_lines_cost;
261 /* Cost of deleting n lines on this frame */
262 int *delete_n_lines_cost;
264 /* Size of this frame, excluding fringes, scroll bars etc.,
265 in units of canonical characters. */
266 int text_lines, text_cols;
268 /* Total size of this frame (i.e. its native window), in units of
269 canonical characters. */
270 int total_lines, total_cols;
272 /* New text height and width for pending size change.
273 0 if no change pending. */
274 int new_text_lines, new_text_cols;
276 /* Pixel position of the frame window (x and y offsets in root window). */
277 int left_pos, top_pos;
279 /* Size of the frame window in pixels. */
280 int pixel_height, pixel_width;
282 /* Dots per inch of the screen the frame is on. */
283 double resx, resy;
285 /* These many pixels are the difference between the outer window (i.e. the
286 left and top of the window manager decoration) and FRAME_X_WINDOW. */
287 int x_pixels_diff, y_pixels_diff;
289 /* This is the gravity value for the specified window position. */
290 int win_gravity;
292 /* The geometry flags for this window. */
293 int size_hint_flags;
295 /* Border width of the frame window as known by the (X) window system. */
296 int border_width;
298 /* Width of the internal border. This is a line of background color
299 just inside the window's border. When the frame is selected,
300 a highlighting is displayed inside the internal border. */
301 int internal_border_width;
303 /* Canonical X unit. Width of default font, in pixels. */
304 int column_width;
306 /* Width of space glyph of default font, in pixels. */
307 int space_width;
309 /* Canonical Y unit. Height of a line, in pixels. */
310 int line_height;
312 /* The output method says how the contents of this frame are
313 displayed. It could be using termcap, or using an X window.
314 This must be the same as the terminal->type. */
315 enum output_method output_method;
317 /* The terminal device that this frame uses. If this is NULL, then
318 the frame has been deleted. */
319 struct terminal *terminal;
321 /* Device-dependent, frame-local auxiliary data used for displaying
322 the contents. When the frame is deleted, this data is deleted as
323 well. */
324 union output_data
326 struct tty_output *tty; /* termchar.h */
327 struct x_output *x; /* xterm.h */
328 struct w32_output *w32; /* w32term.h */
329 struct ns_output *ns; /* nsterm.h */
330 intptr_t nothing;
332 output_data;
334 /* List of font-drivers available on the frame. */
335 struct font_driver_list *font_driver_list;
336 /* List of data specific to font-driver and frame, but common to
337 faces. */
338 struct font_data_list *font_data_list;
340 /* Total width of fringes reserved for drawing truncation bitmaps,
341 continuation bitmaps and alike. The width is in canonical char
342 units of the frame. This must currently be the case because window
343 sizes aren't pixel values. If it weren't the case, we wouldn't be
344 able to split windows horizontally nicely. */
345 int fringe_cols;
347 /* The extra width (in pixels) currently allotted for fringes. */
348 int left_fringe_width, right_fringe_width;
350 /* See FULLSCREEN_ enum below */
351 enum fullscreen_type want_fullscreen;
353 /* Number of lines of menu bar. */
354 int menu_bar_lines;
356 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
357 || defined (HAVE_NS) || defined (USE_GTK)
358 /* Nonzero means using a menu bar that comes from the X toolkit. */
359 unsigned int external_menu_bar : 1;
360 #endif
362 /* Nonzero if last attempt at redisplay on this frame was preempted. */
363 unsigned char display_preempted : 1;
365 /* visible is nonzero if the frame is currently displayed; we check
366 it to see if we should bother updating the frame's contents.
367 DON'T SET IT DIRECTLY; instead, use FRAME_SET_VISIBLE.
369 Note that, since invisible frames aren't updated, whenever a
370 frame becomes visible again, it must be marked as garbaged. The
371 FRAME_SAMPLE_VISIBILITY macro takes care of this.
373 On ttys and on Windows NT/9X, to avoid wasting effort updating
374 visible frames that are actually completely obscured by other
375 windows on the display, we bend the meaning of visible slightly:
376 if greater than 1, then the frame is obscured - we still consider
377 it to be "visible" as seen from lisp, but we don't bother
378 updating it. We must take care to garbage the frame when it
379 ceases to be obscured though.
381 iconified is nonzero if the frame is currently iconified.
383 Asynchronous input handlers should NOT change these directly;
384 instead, they should change async_visible or async_iconified, and
385 let the FRAME_SAMPLE_VISIBILITY macro set visible and iconified
386 at the next redisplay.
388 These should probably be considered read-only by everyone except
389 FRAME_SAMPLE_VISIBILITY.
391 These two are mutually exclusive. They might both be zero, if the
392 frame has been made invisible without an icon. */
393 unsigned char visible : 2;
394 unsigned char iconified : 1;
396 /* Let's not use bitfields for volatile variables. */
398 /* Asynchronous input handlers change these, and
399 FRAME_SAMPLE_VISIBILITY copies them into visible and iconified.
400 See FRAME_SAMPLE_VISIBILITY, below. */
401 volatile char async_visible, async_iconified;
403 /* Nonzero if this frame should be redrawn. */
404 volatile char garbaged;
406 /* True if frame actually has a minibuffer window on it.
407 0 if using a minibuffer window that isn't on this frame. */
408 unsigned char has_minibuffer : 1;
410 /* 0 means, if this frame has just one window,
411 show no modeline for that window. */
412 unsigned char wants_modeline : 1;
414 /* Non-zero if the hardware device this frame is displaying on can
415 support scroll bars. */
416 char can_have_scroll_bars;
418 /* Non-0 means raise this frame to the top of the heap when selected. */
419 unsigned char auto_raise : 1;
421 /* Non-0 means lower this frame to the bottom of the stack when left. */
422 unsigned char auto_lower : 1;
424 /* True if frame's root window can't be split. */
425 unsigned char no_split : 1;
427 /* If this is set, then Emacs won't change the frame name to indicate
428 the current buffer, etcetera. If the user explicitly sets the frame
429 name, this gets set. If the user sets the name to Qnil, this is
430 cleared. */
431 unsigned char explicit_name : 1;
433 /* Nonzero if size of some window on this frame has changed. */
434 unsigned char window_sizes_changed : 1;
436 /* Nonzero if the mouse has moved on this display device
437 since the last time we checked. */
438 unsigned char mouse_moved :1;
440 /* Nonzero means that the pointer is invisible. */
441 unsigned char pointer_invisible :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) \
510 (eassert (FRAMEP (p)), (struct frame *) XUNTAG (p, Lisp_Vectorlike))
511 #define XSETFRAME(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_FRAME))
513 /* Given a window, return its frame as a Lisp_Object. */
514 #define WINDOW_FRAME(w) w->frame
516 /* Test a frame for particular kinds of display methods. */
517 #define FRAME_INITIAL_P(f) ((f)->output_method == output_initial)
518 #define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap)
519 #define FRAME_X_P(f) ((f)->output_method == output_x_window)
520 #define FRAME_W32_P(f) ((f)->output_method == output_w32)
521 #define FRAME_MSDOS_P(f) ((f)->output_method == output_msdos_raw)
522 #define FRAME_MAC_P(f) ((f)->output_method == output_mac)
523 #define FRAME_NS_P(f) ((f)->output_method == output_ns)
525 /* FRAME_WINDOW_P tests whether the frame is a window, and is
526 defined to be the predicate for the window system being used. */
528 #ifdef HAVE_X_WINDOWS
529 #define FRAME_WINDOW_P(f) FRAME_X_P (f)
530 #endif
531 #ifdef HAVE_NTGUI
532 #define FRAME_WINDOW_P(f) FRAME_W32_P (f)
533 #endif
534 #ifdef HAVE_NS
535 #define FRAME_WINDOW_P(f) FRAME_NS_P(f)
536 #endif
537 #ifndef FRAME_WINDOW_P
538 #define FRAME_WINDOW_P(f) (0)
539 #endif
541 /* Return a pointer to the structure holding information about the
542 region of text, if any, that is currently shown in mouse-face on
543 frame F. We need to define two versions because a TTY-only build
544 does not have FRAME_X_DISPLAY_INFO. */
545 #ifdef HAVE_WINDOW_SYSTEM
546 # define MOUSE_HL_INFO(F) \
547 (FRAME_WINDOW_P(F) \
548 ? &FRAME_X_DISPLAY_INFO(F)->mouse_highlight \
549 : &(F)->output_data.tty->display_info->mouse_highlight)
550 #else
551 # define MOUSE_HL_INFO(F) \
552 (&(F)->output_data.tty->display_info->mouse_highlight)
553 #endif
555 /* Nonzero if frame F is still alive (not deleted). */
556 #define FRAME_LIVE_P(f) ((f)->terminal != 0)
558 /* Nonzero if frame F is a minibuffer-only frame. */
559 #define FRAME_MINIBUF_ONLY_P(f) \
560 EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f))
562 /* Nonzero if frame F contains a minibuffer window.
563 (If this is 0, F must use some other minibuffer window.) */
564 #define FRAME_HAS_MINIBUF_P(f) ((f)->has_minibuffer)
566 /* Pixel height of frame F, including non-toolkit menu bar and
567 non-toolkit tool bar lines. */
568 #define FRAME_PIXEL_HEIGHT(f) ((f)->pixel_height)
570 /* Pixel width of frame F. */
571 #define FRAME_PIXEL_WIDTH(f) ((f)->pixel_width)
573 /* Height of frame F, measured in canonical lines, including
574 non-toolkit menu bar and non-toolkit tool bar lines. */
575 #define FRAME_LINES(f) (f)->text_lines
577 /* Width of frame F, measured in canonical character columns,
578 not including scroll bars if any. */
579 #define FRAME_COLS(f) (f)->text_cols
581 /* Number of lines of frame F used for menu bar.
582 This is relevant on terminal frames and on
583 X Windows when not using the X toolkit.
584 These lines are counted in FRAME_LINES. */
585 #define FRAME_MENU_BAR_LINES(f) (f)->menu_bar_lines
587 /* Nonzero if this frame should display a tool bar
588 in a way that does not use any text lines. */
589 #if defined (USE_GTK) || defined (HAVE_NS)
590 #define FRAME_EXTERNAL_TOOL_BAR(f) (f)->external_tool_bar
591 #else
592 #define FRAME_EXTERNAL_TOOL_BAR(f) 0
593 #endif
595 /* Number of lines of frame F used for the tool-bar. */
597 #define FRAME_TOOL_BAR_LINES(f) (f)->tool_bar_lines
600 /* Lines above the top-most window in frame F. */
602 #define FRAME_TOP_MARGIN(F) \
603 (FRAME_MENU_BAR_LINES (F) + FRAME_TOOL_BAR_LINES (F))
605 /* Pixel height of the top margin above. */
607 #define FRAME_TOP_MARGIN_HEIGHT(f) \
608 (FRAME_TOP_MARGIN (f) * FRAME_LINE_HEIGHT (f))
610 /* Nonzero if this frame should display a menu bar
611 in a way that does not use any text lines. */
612 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
613 || defined (HAVE_NS) || defined (USE_GTK)
614 #define FRAME_EXTERNAL_MENU_BAR(f) (f)->external_menu_bar
615 #else
616 #define FRAME_EXTERNAL_MENU_BAR(f) 0
617 #endif
618 #define FRAME_VISIBLE_P(f) ((f)->visible != 0)
620 /* Nonzero if frame F is currently visible but hidden. */
621 #define FRAME_OBSCURED_P(f) ((f)->visible > 1)
623 /* Nonzero if frame F is currently iconified. */
624 #define FRAME_ICONIFIED_P(f) (f)->iconified
626 #define FRAME_SET_VISIBLE(f,p) \
627 ((f)->async_visible = (p), FRAME_SAMPLE_VISIBILITY (f))
628 #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1, f->garbaged = 1)
629 #define FRAME_GARBAGED_P(f) (f)->garbaged
631 /* Nonzero means do not allow splitting this frame's window. */
632 #define FRAME_NO_SPLIT_P(f) (f)->no_split
634 /* Not really implemented. */
635 #define FRAME_WANTS_MODELINE_P(f) (f)->wants_modeline
637 /* Nonzero if a size change has been requested for frame F
638 but not yet really put into effect. This can be true temporarily
639 when an X event comes in at a bad time. */
640 #define FRAME_WINDOW_SIZES_CHANGED(f) (f)->window_sizes_changed
642 /* The minibuffer window of frame F, if it has one; otherwise nil. */
643 #define FRAME_MINIBUF_WINDOW(f) f->minibuffer_window
645 /* The root window of the window tree of frame F. */
646 #define FRAME_ROOT_WINDOW(f) f->root_window
648 /* The currently selected window of the window tree of frame F. */
649 #define FRAME_SELECTED_WINDOW(f) f->selected_window
651 #define FRAME_INSERT_COST(f) (f)->insert_line_cost
652 #define FRAME_DELETE_COST(f) (f)->delete_line_cost
653 #define FRAME_INSERTN_COST(f) (f)->insert_n_lines_cost
654 #define FRAME_DELETEN_COST(f) (f)->delete_n_lines_cost
655 #define FRAME_MESSAGE_BUF(f) (f)->message_buf
656 #define FRAME_SCROLL_BOTTOM_VPOS(f) (f)->scroll_bottom_vpos
657 #define FRAME_FOCUS_FRAME(f) f->focus_frame
659 /* Nonzero if frame F supports scroll bars.
660 If this is zero, then it is impossible to enable scroll bars
661 on frame F. */
662 #define FRAME_CAN_HAVE_SCROLL_BARS(f) ((f)->can_have_scroll_bars)
664 /* This frame slot says whether scroll bars are currently enabled for frame F,
665 and which side they are on. */
666 #define FRAME_VERTICAL_SCROLL_BAR_TYPE(f) ((f)->vertical_scroll_bar_type)
667 #define FRAME_HAS_VERTICAL_SCROLL_BARS(f) \
668 ((f)->vertical_scroll_bar_type != vertical_scroll_bar_none)
669 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT(f) \
670 ((f)->vertical_scroll_bar_type == vertical_scroll_bar_left)
671 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT(f) \
672 ((f)->vertical_scroll_bar_type == vertical_scroll_bar_right)
674 /* Width that a scroll bar in frame F should have, if there is one.
675 Measured in pixels.
676 If scroll bars are turned off, this is still nonzero. */
677 #define FRAME_CONFIG_SCROLL_BAR_WIDTH(f) ((f)->config_scroll_bar_width)
679 /* Width that a scroll bar in frame F should have, if there is one.
680 Measured in columns (characters).
681 If scroll bars are turned off, this is still nonzero. */
682 #define FRAME_CONFIG_SCROLL_BAR_COLS(f) ((f)->config_scroll_bar_cols)
684 /* Width of a scroll bar in frame F, measured in columns (characters),
685 but only if scroll bars are on the left. If scroll bars are on
686 the right in this frame, or there are no scroll bars, value is 0. */
688 #define FRAME_LEFT_SCROLL_BAR_COLS(f) \
689 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \
690 ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
691 : 0)
693 /* Width of a left scroll bar in frame F, measured in pixels */
695 #define FRAME_LEFT_SCROLL_BAR_AREA_WIDTH(f) \
696 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \
697 ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)) \
698 : 0)
700 /* Width of a scroll bar in frame F, measured in columns (characters),
701 but only if scroll bars are on the right. If scroll bars are on
702 the left in this frame, or there are no scroll bars, value is 0. */
704 #define FRAME_RIGHT_SCROLL_BAR_COLS(f) \
705 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f) \
706 ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
707 : 0)
709 /* Width of a right scroll bar area in frame F, measured in pixels */
711 #define FRAME_RIGHT_SCROLL_BAR_AREA_WIDTH(f) \
712 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f) \
713 ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)) \
714 : 0)
716 /* Actual width of a scroll bar in frame F, measured in columns. */
718 #define FRAME_SCROLL_BAR_COLS(f) \
719 (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \
720 ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
721 : 0)
723 /* Actual width of a scroll bar area in frame F, measured in pixels. */
725 #define FRAME_SCROLL_BAR_AREA_WIDTH(f) \
726 (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \
727 ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)) \
728 : 0)
730 /* Total width of frame F, in columns (characters),
731 including the width used by scroll bars if any. */
733 #define FRAME_TOTAL_COLS(f) ((f)->total_cols)
735 /* Set the width of frame F to VAL.
736 VAL is the width of a full-frame window,
737 not including scroll bars and fringes. */
739 #define SET_FRAME_COLS(f, val) \
740 (FRAME_COLS (f) = (val), \
741 (f)->total_cols = FRAME_TOTAL_COLS_ARG (f, FRAME_COLS (f)))
743 /* Given a value WIDTH for frame F's nominal width,
744 return the value that FRAME_TOTAL_COLS should have. */
746 #define FRAME_TOTAL_COLS_ARG(f, width) \
747 ((width) \
748 + FRAME_SCROLL_BAR_COLS (f) \
749 + FRAME_FRINGE_COLS (f))
751 /* Maximum + 1 legitimate value for FRAME_CURSOR_X. */
753 #define FRAME_CURSOR_X_LIMIT(f) \
754 (FRAME_COLS (f) + FRAME_LEFT_SCROLL_BAR_COLS (f))
756 /* Nonzero if frame F has scroll bars. */
758 #define FRAME_SCROLL_BARS(f) (f->scroll_bars)
760 #define FRAME_CONDEMNED_SCROLL_BARS(f) (f->condemned_scroll_bars)
761 #define FRAME_MENU_BAR_ITEMS(f) (f->menu_bar_items)
762 #define FRAME_COST_BAUD_RATE(f) ((f)->cost_calculation_baud_rate)
764 #define FRAME_DESIRED_CURSOR(f) ((f)->desired_cursor)
765 #define FRAME_BLINK_OFF_CURSOR(f) ((f)->blink_off_cursor)
766 #define FRAME_CURSOR_WIDTH(f) ((f)->cursor_width)
767 #define FRAME_BLINK_OFF_CURSOR_WIDTH(f) ((f)->blink_off_cursor_width)
769 /* Return a pointer to the face cache of frame F. */
771 #define FRAME_FACE_CACHE(F) (F)->face_cache
773 /* Return the size of message_buf of the frame F. We multiply the
774 width of the frame by 4 because multi-byte form may require at most
775 4-byte for a character. */
777 #define FRAME_MESSAGE_BUF_SIZE(f) (((int) FRAME_COLS (f)) * 4)
779 /* Emacs's redisplay code could become confused if a frame's
780 visibility changes at arbitrary times. For example, if a frame is
781 visible while the desired glyphs are being built, but becomes
782 invisible before they are updated, then some rows of the
783 desired_glyphs will be left marked as enabled after redisplay is
784 complete, which should never happen. The next time the frame
785 becomes visible, redisplay will probably barf.
787 Currently, there are no similar situations involving iconified, but
788 the principle is the same.
790 So instead of having asynchronous input handlers directly set and
791 clear the frame's visibility and iconification flags, they just set
792 the async_visible and async_iconified flags; the redisplay code
793 calls the FRAME_SAMPLE_VISIBILITY macro before doing any redisplay,
794 which sets visible and iconified from their asynchronous
795 counterparts.
797 Synchronous code must use the FRAME_SET_VISIBLE macro.
799 Also, if a frame used to be invisible, but has just become visible,
800 it must be marked as garbaged, since redisplay hasn't been keeping
801 up its contents.
803 Note that a tty frame is visible if and only if it is the topmost
804 frame. */
806 #define FRAME_SAMPLE_VISIBILITY(f) \
807 (((f)->async_visible && (f)->visible != (f)->async_visible) ? \
808 SET_FRAME_GARBAGED (f) : 0, \
809 (f)->visible = (f)->async_visible, \
810 (f)->iconified = (f)->async_iconified)
812 #define CHECK_FRAME(x) \
813 CHECK_TYPE (FRAMEP (x), Qframep, x)
815 #define CHECK_LIVE_FRAME(x) \
816 CHECK_TYPE (FRAMEP (x) && FRAME_LIVE_P (XFRAME (x)), Qframe_live_p, x)
818 /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
819 `for' loop which iterates over the elements of Vframe_list. The
820 loop will set FRAME_VAR, a Lisp_Object, to each frame in
821 Vframe_list in succession and execute the statement. LIST_VAR
822 should be a Lisp_Object too; it is used to iterate through the
823 Vframe_list.
825 This macro is a holdover from a time when multiple frames weren't always
826 supported. An alternate definition of the macro would expand to
827 something which executes the statement once. */
829 #define FOR_EACH_FRAME(list_var, frame_var) \
830 for ((list_var) = Vframe_list; \
831 (CONSP (list_var) \
832 && (frame_var = XCAR (list_var), 1)); \
833 list_var = XCDR (list_var))
836 extern Lisp_Object Qframep, Qframe_live_p;
837 extern Lisp_Object Qtty, Qtty_type;
838 extern Lisp_Object Qtty_color_mode;
839 extern Lisp_Object Qterminal, Qterminal_live_p;
840 extern Lisp_Object Qnoelisp;
842 extern struct frame *last_nonminibuf_frame;
844 extern void set_menu_bar_lines (struct frame *, Lisp_Object, Lisp_Object);
845 extern struct frame *make_initial_frame (void);
846 extern struct frame *make_frame (int);
847 #ifdef HAVE_WINDOW_SYSTEM
848 extern struct frame *make_minibuffer_frame (void);
849 extern struct frame *make_frame_without_minibuffer (Lisp_Object,
850 struct kboard *,
851 Lisp_Object);
852 #endif /* HAVE_WINDOW_SYSTEM */
853 extern void frame_make_pointer_invisible (void);
854 extern void frame_make_pointer_visible (void);
855 extern Lisp_Object delete_frame (Lisp_Object, Lisp_Object);
857 extern Lisp_Object Vframe_list;
859 /* The currently selected frame. */
861 extern Lisp_Object selected_frame;
863 /* Value is a pointer to the selected frame. If the selected frame
864 isn't live, abort. */
866 #define SELECTED_FRAME() \
867 ((FRAMEP (selected_frame) \
868 && FRAME_LIVE_P (XFRAME (selected_frame))) \
869 ? XFRAME (selected_frame) \
870 : (abort (), (struct frame *) 0))
873 /***********************************************************************
874 Display-related Macros
875 ***********************************************************************/
877 /* Canonical y-unit on frame F.
878 This value currently equals the line height of the frame (which is
879 the height of the default font of F). */
881 #define FRAME_LINE_HEIGHT(F) ((F)->line_height)
883 /* Canonical x-unit on frame F.
884 This value currently equals the average width of the default font of F. */
886 #define FRAME_COLUMN_WIDTH(F) ((F)->column_width)
888 /* Space glyph width of the default font of frame F. */
890 #define FRAME_SPACE_WIDTH(F) ((F)->space_width)
893 /* Pixel width of areas used to display truncation marks, continuation
894 marks, overlay arrows. This is 0 for terminal frames. */
896 #ifdef HAVE_WINDOW_SYSTEM
898 /* Total width of fringes reserved for drawing truncation bitmaps,
899 continuation bitmaps and alike. The width is in canonical char
900 units of the frame. This must currently be the case because window
901 sizes aren't pixel values. If it weren't the case, we wouldn't be
902 able to split windows horizontally nicely. */
904 #define FRAME_FRINGE_COLS(F) ((F)->fringe_cols)
906 /* Pixel-width of the left and right fringe. */
908 #define FRAME_LEFT_FRINGE_WIDTH(F) ((F)->left_fringe_width)
909 #define FRAME_RIGHT_FRINGE_WIDTH(F) ((F)->right_fringe_width)
911 /* Total width of fringes in pixels. */
913 #define FRAME_TOTAL_FRINGE_WIDTH(F) \
914 (FRAME_LEFT_FRINGE_WIDTH (F) + FRAME_RIGHT_FRINGE_WIDTH (F))
917 /* Pixel-width of internal border lines */
919 #define FRAME_INTERNAL_BORDER_WIDTH(F) ((F)->internal_border_width)
921 #else /* not HAVE_WINDOW_SYSTEM */
923 #define FRAME_FRINGE_COLS(F) 0
924 #define FRAME_TOTAL_FRINGE_WIDTH(F) 0
925 #define FRAME_LEFT_FRINGE_WIDTH(F) 0
926 #define FRAME_RIGHT_FRINGE_WIDTH(F) 0
927 #define FRAME_INTERNAL_BORDER_WIDTH(F) 0
929 #endif /* not HAVE_WINDOW_SYSTEM */
934 /***********************************************************************
935 Conversion between canonical units and pixels
936 ***********************************************************************/
938 /* Canonical x-values are fractions of FRAME_COLUMN_WIDTH, canonical
939 y-unit are fractions of FRAME_LINE_HEIGHT of a frame. Both are
940 represented as Lisp numbers, i.e. integers or floats. */
942 /* Convert canonical value X to pixels. F is the frame whose
943 canonical char width is to be used. X must be a Lisp integer or
944 float. Value is a C integer. */
946 #define FRAME_PIXEL_X_FROM_CANON_X(F, X) \
947 (INTEGERP (X) \
948 ? XINT (X) * FRAME_COLUMN_WIDTH (F) \
949 : (int) (XFLOAT_DATA (X) * FRAME_COLUMN_WIDTH (F)))
951 /* Convert canonical value Y to pixels. F is the frame whose
952 canonical character height is to be used. X must be a Lisp integer
953 or float. Value is a C integer. */
955 #define FRAME_PIXEL_Y_FROM_CANON_Y(F, Y) \
956 (INTEGERP (Y) \
957 ? XINT (Y) * FRAME_LINE_HEIGHT (F) \
958 : (int) (XFLOAT_DATA (Y) * FRAME_LINE_HEIGHT (F)))
960 /* Convert pixel-value X to canonical units. F is the frame whose
961 canonical character width is to be used. X is a C integer. Result
962 is a Lisp float if X is not a multiple of the canon width,
963 otherwise it's a Lisp integer. */
965 #define FRAME_CANON_X_FROM_PIXEL_X(F, X) \
966 ((X) % FRAME_COLUMN_WIDTH (F) != 0 \
967 ? make_float ((double) (X) / FRAME_COLUMN_WIDTH (F)) \
968 : make_number ((X) / FRAME_COLUMN_WIDTH (F)))
970 /* Convert pixel-value Y to canonical units. F is the frame whose
971 canonical character height is to be used. Y is a C integer.
972 Result is a Lisp float if Y is not a multiple of the canon width,
973 otherwise it's a Lisp integer. */
975 #define FRAME_CANON_Y_FROM_PIXEL_Y(F, Y) \
976 ((Y) % FRAME_LINE_HEIGHT (F) \
977 ? make_float ((double) (Y) / FRAME_LINE_HEIGHT (F)) \
978 : make_number ((Y) / FRAME_LINE_HEIGHT (F)))
982 /* Manipulating pixel sizes and character sizes.
983 Knowledge of which factors affect the overall size of the window should
984 be hidden in these macros, if that's possible.
986 Return the upper/left pixel position of the character cell on frame F
987 at ROW/COL. */
989 #define FRAME_LINE_TO_PIXEL_Y(f, row) \
990 (((row) < FRAME_TOP_MARGIN (f) ? 0 : FRAME_INTERNAL_BORDER_WIDTH (f)) \
991 + (row) * FRAME_LINE_HEIGHT (f))
993 #define FRAME_COL_TO_PIXEL_X(f, col) \
994 (FRAME_INTERNAL_BORDER_WIDTH (f) \
995 + (col) * FRAME_COLUMN_WIDTH (f))
997 /* Return the pixel width/height of frame F if it has
998 COLS columns/LINES rows. */
1000 #define FRAME_TEXT_COLS_TO_PIXEL_WIDTH(f, cols) \
1001 (FRAME_COL_TO_PIXEL_X (f, cols) \
1002 + (f)->scroll_bar_actual_width \
1003 + FRAME_TOTAL_FRINGE_WIDTH (f) \
1004 + FRAME_INTERNAL_BORDER_WIDTH (f))
1006 #define FRAME_TEXT_LINES_TO_PIXEL_HEIGHT(f, lines) \
1007 ((lines) * FRAME_LINE_HEIGHT (f) \
1008 + 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
1011 /* Return the row/column (zero-based) of the character cell containing
1012 the pixel on FRAME at Y/X. */
1014 #define FRAME_PIXEL_Y_TO_LINE(f, y) \
1015 (((y) < FRAME_TOP_MARGIN_HEIGHT (f) \
1016 ? (y) \
1017 : ((y) < FRAME_TOP_MARGIN_HEIGHT (f) + FRAME_INTERNAL_BORDER_WIDTH (f) \
1018 ? (y) - (FRAME_TOP_MARGIN_HEIGHT (f) + FRAME_INTERNAL_BORDER_WIDTH (f) \
1019 /* Arrange for the division to round down. */ \
1020 + FRAME_LINE_HEIGHT (f) - 1) \
1021 : (y) - FRAME_INTERNAL_BORDER_WIDTH (f))) \
1022 / FRAME_LINE_HEIGHT (f))
1024 #define FRAME_PIXEL_X_TO_COL(f, x) \
1025 (((x) - FRAME_INTERNAL_BORDER_WIDTH (f)) \
1026 / FRAME_COLUMN_WIDTH (f))
1028 /* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
1029 frame F? */
1031 #define FRAME_PIXEL_WIDTH_TO_TEXT_COLS(f, width) \
1032 (FRAME_PIXEL_X_TO_COL (f, ((width) \
1033 - FRAME_INTERNAL_BORDER_WIDTH (f) \
1034 - FRAME_TOTAL_FRINGE_WIDTH (f) \
1035 - (f)->scroll_bar_actual_width)))
1037 #define FRAME_PIXEL_HEIGHT_TO_TEXT_LINES(f, height) \
1038 (FRAME_PIXEL_Y_TO_LINE (f, ((height) \
1039 - FRAME_INTERNAL_BORDER_WIDTH (f))))
1042 /***********************************************************************
1043 Frame Parameters
1044 ***********************************************************************/
1046 extern Lisp_Object Qauto_raise, Qauto_lower;
1047 extern Lisp_Object Qborder_color, Qborder_width;
1048 extern Lisp_Object Qbuffer_predicate;
1049 extern Lisp_Object Qcursor_color, Qcursor_type;
1050 extern Lisp_Object Qfont;
1051 extern Lisp_Object Qbackground_color, Qforeground_color;
1052 extern Lisp_Object Qicon, Qicon_name, Qicon_type, Qicon_left, Qicon_top;
1053 extern Lisp_Object Qinternal_border_width;
1054 extern Lisp_Object Qtooltip;
1055 extern Lisp_Object Qmenu_bar_lines, Qtool_bar_lines, Qtool_bar_position;
1056 extern Lisp_Object Qmouse_color;
1057 extern Lisp_Object Qname, Qtitle;
1058 extern Lisp_Object Qparent_id;
1059 extern Lisp_Object Qunsplittable, Qvisibility;
1060 extern Lisp_Object Qscroll_bar_width, Qvertical_scroll_bars;
1061 extern Lisp_Object Qscroll_bar_foreground, Qscroll_bar_background;
1062 extern Lisp_Object Qscreen_gamma;
1063 extern Lisp_Object Qline_spacing;
1064 extern Lisp_Object Qwait_for_wm;
1065 extern Lisp_Object Qfullscreen;
1066 extern Lisp_Object Qfullwidth, Qfullheight, Qfullboth, Qmaximized;
1067 extern Lisp_Object Qsticky;
1068 extern Lisp_Object Qfont_backend;
1069 extern Lisp_Object Qalpha;
1071 extern Lisp_Object Qleft_fringe, Qright_fringe;
1072 extern Lisp_Object Qheight, Qwidth;
1073 extern Lisp_Object Qminibuffer, Qmodeline;
1074 extern Lisp_Object Qx, Qw32, Qmac, Qpc, Qns;
1075 extern Lisp_Object Qvisible;
1076 extern Lisp_Object Qdisplay_type;
1078 extern Lisp_Object Qx_resource_name;
1080 extern Lisp_Object Qleft, Qright, Qtop, Qbox, Qbottom;
1081 extern Lisp_Object Qdisplay;
1083 extern Lisp_Object Qrun_hook_with_args;
1085 #ifdef HAVE_WINDOW_SYSTEM
1087 /* The class of this X application. */
1088 #define EMACS_CLASS "Emacs"
1090 /* These are in xterm.c, w32term.c, etc. */
1092 extern void x_set_scroll_bar_default_width (struct frame *);
1093 extern void x_set_offset (struct frame *, int, int, int);
1094 extern void x_wm_set_icon_position (struct frame *, int, int);
1096 extern Lisp_Object x_new_font (struct frame *, Lisp_Object, int);
1099 extern Lisp_Object Qface_set_after_frame_default;
1101 #ifdef WINDOWSNT
1102 extern void x_fullscreen_adjust (struct frame *f, int *, int *,
1103 int *, int *);
1104 #endif
1106 extern void x_set_frame_parameters (struct frame *, Lisp_Object);
1108 extern void x_set_fullscreen (struct frame *, Lisp_Object, Lisp_Object);
1109 extern void x_set_line_spacing (struct frame *, Lisp_Object, Lisp_Object);
1110 extern void x_set_screen_gamma (struct frame *, Lisp_Object, Lisp_Object);
1111 extern void x_set_font (struct frame *, Lisp_Object, Lisp_Object);
1112 extern void x_set_font_backend (struct frame *, Lisp_Object, Lisp_Object);
1113 extern void x_set_fringe_width (struct frame *, Lisp_Object, Lisp_Object);
1114 extern void x_set_border_width (struct frame *, Lisp_Object, Lisp_Object);
1115 extern void x_set_internal_border_width (struct frame *, Lisp_Object,
1116 Lisp_Object);
1117 extern void x_set_visibility (struct frame *, Lisp_Object, Lisp_Object);
1118 extern void x_set_autoraise (struct frame *, Lisp_Object, Lisp_Object);
1119 extern void x_set_autolower (struct frame *, Lisp_Object, Lisp_Object);
1120 extern void x_set_unsplittable (struct frame *, Lisp_Object, Lisp_Object);
1121 extern void x_set_vertical_scroll_bars (struct frame *, Lisp_Object,
1122 Lisp_Object);
1123 extern void x_set_scroll_bar_width (struct frame *, Lisp_Object,
1124 Lisp_Object);
1126 extern Lisp_Object x_icon_type (struct frame *);
1128 extern int x_figure_window_size (struct frame *, Lisp_Object, int);
1130 extern void x_set_alpha (struct frame *, Lisp_Object, Lisp_Object);
1132 extern void validate_x_resource_name (void);
1134 extern Lisp_Object display_x_get_resource (Display_Info *,
1135 Lisp_Object attribute,
1136 Lisp_Object class,
1137 Lisp_Object component,
1138 Lisp_Object subclass);
1140 #if defined HAVE_X_WINDOWS && !defined USE_X_TOOLKIT
1141 extern char *x_get_resource_string (const char *, const char *);
1142 #endif
1144 /* In xmenu.c */
1145 extern void set_frame_menubar (FRAME_PTR, int, int);
1147 #endif /* HAVE_WINDOW_SYSTEM */
1149 #endif /* not EMACS_FRAME_H */