(merge_named_face): GCPRO the face_name in the
[emacs.git] / src / frame.h
blob8bdaff99754c6fe06b22e4e72113f3f9291e252b
1 /* Define frame-object for GNU Emacs.
2 Copyright (C) 1993, 1994, 1999, 2000, 2001 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 2, or (at your option)
9 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; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
21 /* Don't multiply include: dispextern.h includes macterm.h which
22 includes frame.h some emacs source includes both dispextern.h and
23 frame.h */
25 #ifndef EMACS_FRAME_H
26 #define EMACS_FRAME_H
29 /* Miscellanea. */
31 /* Nonzero means don't assume anything about current contents of
32 actual terminal frame */
34 extern int frame_garbaged;
36 /* Nonzero means FRAME_MESSAGE_BUF (selected_frame) is being used by
37 print. */
39 extern int message_buf_print;
42 /* The structure representing a frame. */
44 enum output_method
46 output_termcap,
47 output_x_window,
48 output_msdos_raw,
49 output_w32,
50 output_mac
53 enum vertical_scroll_bar_type
55 vertical_scroll_bar_none,
56 vertical_scroll_bar_left,
57 vertical_scroll_bar_right
60 enum text_cursor_kinds
62 DEFAULT_CURSOR = -2,
63 NO_CURSOR = -1,
64 FILLED_BOX_CURSOR,
65 HOLLOW_BOX_CURSOR,
66 BAR_CURSOR,
67 HBAR_CURSOR
70 #if !defined(MSDOS) && !defined(WINDOWSNT) && !defined(MAC_OS)
72 #if !defined(HAVE_X_WINDOWS)
74 #define PIX_TYPE int
76 /* A (mostly empty) x_output structure definition for building Emacs
77 on Unix and GNU/Linux without X support. */
78 struct x_output
80 PIX_TYPE background_pixel;
81 PIX_TYPE foreground_pixel;
84 #endif /* ! HAVE_X_WINDOWS */
87 #define FRAME_FOREGROUND_PIXEL(f) ((f)->output_data.x->foreground_pixel)
88 #define FRAME_BACKGROUND_PIXEL(f) ((f)->output_data.x->background_pixel)
90 /* A structure describing a termcap frame display. */
91 extern struct x_output tty_display;
93 #endif /* ! MSDOS && ! WINDOWSNT && ! MAC_OS */
95 struct frame
97 EMACS_INT size;
98 struct Lisp_Vector *next;
100 /* All Lisp_Object components must come first.
101 Only EMACS_INT values can be intermixed with them.
102 That ensures they are all aligned normally. */
104 /* Name of this frame: a Lisp string. It is used for looking up resources,
105 as well as for the title in some cases. */
106 Lisp_Object name;
108 /* The name to use for the icon, the last time
109 it was refreshed. nil means not explicitly specified. */
110 Lisp_Object icon_name;
112 /* This is the frame title specified explicitly, if any.
113 Usually it is nil. */
114 Lisp_Object title;
116 /* The frame which should receive keystrokes that occur in this
117 frame, or nil if they should go to the frame itself. This is
118 usually nil, but if the frame is minibufferless, we can use this
119 to redirect keystrokes to a surrogate minibuffer frame when
120 needed.
122 Note that a value of nil is different than having the field point
123 to the frame itself. Whenever the Fselect_frame function is used
124 to shift from one frame to the other, any redirections to the
125 original frame are shifted to the newly selected frame; if
126 focus_frame is nil, Fselect_frame will leave it alone. */
127 Lisp_Object focus_frame;
129 /* This frame's root window. Every frame has one.
130 If the frame has only a minibuffer window, this is it.
131 Otherwise, if the frame has a minibuffer window, this is its sibling. */
132 Lisp_Object root_window;
134 /* This frame's selected window.
135 Each frame has its own window hierarchy
136 and one of the windows in it is selected within the frame.
137 The selected window of the selected frame is Emacs's selected window. */
138 Lisp_Object selected_window;
140 /* This frame's minibuffer window.
141 Most frames have their own minibuffer windows,
142 but only the selected frame's minibuffer window
143 can actually appear to exist. */
144 Lisp_Object minibuffer_window;
146 /* Parameter alist of this frame.
147 These are the parameters specified when creating the frame
148 or modified with modify-frame-parameters. */
149 Lisp_Object param_alist;
151 /* List of scroll bars on this frame.
152 Actually, we don't specify exactly what is stored here at all; the
153 scroll bar implementation code can use it to store anything it likes.
154 This field is marked by the garbage collector. It is here
155 instead of in the `display' structure so that the garbage
156 collector doesn't need to look inside the window-system-dependent
157 structure. */
158 Lisp_Object scroll_bars;
159 Lisp_Object condemned_scroll_bars;
161 /* Vector describing the items to display in the menu bar.
162 Each item has four elements in this vector.
163 They are KEY, STRING, SUBMAP, and HPOS.
164 (HPOS is not used in when the X toolkit is in use.)
165 There are four additional elements of nil at the end, to terminate. */
166 Lisp_Object menu_bar_items;
168 /* Alist of elements (FACE-NAME . FACE-VECTOR-DATA). */
169 Lisp_Object face_alist;
171 /* A vector that records the entire structure of this frame's menu bar.
172 For the format of the data, see extensive comments in xmenu.c.
173 Only the X toolkit version uses this. */
174 Lisp_Object menu_bar_vector;
175 /* Number of elements in the vector that have meaningful data. */
176 EMACS_INT menu_bar_items_used;
178 /* Predicate for selecting buffers for other-buffer. */
179 Lisp_Object buffer_predicate;
181 /* List of buffers viewed in this frame, for other-buffer. */
182 Lisp_Object 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 /* 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 #if defined (USE_GTK)
217 /* Nonzero means using a tool bar that comes from the toolkit. */
218 int external_tool_bar;
219 #endif
221 /* Margin at the top of the frame. Used to display the tool-bar. */
222 int tool_bar_lines;
224 int n_tool_bar_items;
226 /* A buffer for decode_mode_line. */
227 char *decode_mode_spec_buffer;
229 /* See do_line_insertion_deletion_costs for info on these arrays. */
230 /* Cost of inserting 1 line on this frame */
231 int *insert_line_cost;
232 /* Cost of deleting 1 line on this frame */
233 int *delete_line_cost;
234 /* Cost of inserting n lines on this frame */
235 int *insert_n_lines_cost;
236 /* Cost of deleting n lines on this frame */
237 int *delete_n_lines_cost;
239 /* Size of this frame, excluding fringes, scroll bars etc.,
240 in units of canonical characters. */
241 EMACS_INT text_lines, text_cols;
243 /* Total size of this frame (i.e. its native window), in units of
244 canonical characters. */
245 EMACS_INT total_lines, total_cols;
247 /* New text height and width for pending size change.
248 0 if no change pending. */
249 int new_text_lines, new_text_cols;
251 /* Pixel position of the frame window (x and y offsets in root window). */
252 int left_pos, top_pos;
254 /* Size of the frame window in pixels. */
255 int pixel_height, pixel_width;
257 /* These many pixels are the difference between the outer window (i.e. the
258 left and top of the window manager decoration) and FRAME_X_WINDOW. */
259 int x_pixels_diff, y_pixels_diff;
261 /* This is the gravity value for the specified window position. */
262 int win_gravity;
264 /* The geometry flags for this window. */
265 int size_hint_flags;
267 /* Border width of the frame window as known by the (X) window system. */
268 int border_width;
270 /* Width of the internal border. This is a line of background color
271 just inside the window's border. When the frame is selected,
272 a highlighting is displayed inside the internal border. */
273 int internal_border_width;
275 /* Canonical X unit. Width of default font, in pixels. */
276 int column_width;
278 /* Canonical Y unit. Height of a line, in pixels. */
279 int line_height;
281 /* The output method says how the contents of this frame
282 are displayed. It could be using termcap, or using an X window. */
283 enum output_method output_method;
285 /* A structure of auxiliary data used for displaying the contents.
286 struct x_output is used for X window frames;
287 it is defined in xterm.h.
288 struct w32_output is used for W32 window frames;
289 it is defined in w32term.h. */
290 union output_data
292 struct x_output *x;
293 struct w32_output *w32;
294 struct mac_output *mac;
295 EMACS_INT nothing;
297 output_data;
299 /* Total width of fringes reserved for drawing truncation bitmaps,
300 continuation bitmaps and alike. The width is in canonical char
301 units of the frame. This must currently be the case because window
302 sizes aren't pixel values. If it weren't the case, we wouldn't be
303 able to split windows horizontally nicely. */
304 int fringe_cols;
306 /* The extra width (in pixels) currently allotted for fringes. */
307 int left_fringe_width, right_fringe_width;
309 #ifdef MULTI_KBOARD
310 /* A pointer to the kboard structure associated with this frame.
311 For termcap frames, this points to initial_kboard. For X frames,
312 it will be the same as display.x->display_info->kboard. */
313 struct kboard *kboard;
314 #endif
316 /* See FULLSCREEN_ enum below */
317 int want_fullscreen;
319 /* Number of lines of menu bar. */
320 int menu_bar_lines;
322 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
323 || defined (USE_GTK)
324 /* Nonzero means using a menu bar that comes from the X toolkit. */
325 int external_menu_bar;
326 #endif
328 /* Nonzero if last attempt at redisplay on this frame was preempted. */
329 char display_preempted;
331 /* visible is nonzero if the frame is currently displayed; we check
332 it to see if we should bother updating the frame's contents.
333 DON'T SET IT DIRECTLY; instead, use FRAME_SET_VISIBLE.
335 Note that, since invisible frames aren't updated, whenever a
336 frame becomes visible again, it must be marked as garbaged. The
337 FRAME_SAMPLE_VISIBILITY macro takes care of this.
339 On Windows NT/9X, to avoid wasting effort updating visible frames
340 that are actually completely obscured by other windows on the
341 display, we bend the meaning of visible slightly: if greater than
342 1, then the frame is obscured - we still consider it to be
343 "visible" as seen from lisp, but we don't bother updating it. We
344 must take care to garbage the frame when it ceaces to be obscured
345 though. Note that these semantics are only used on NT/9X.
347 iconified is nonzero if the frame is currently iconified.
349 Asynchronous input handlers should NOT change these directly;
350 instead, they should change async_visible or async_iconified, and
351 let the FRAME_SAMPLE_VISIBILITY macro set visible and iconified
352 at the next redisplay.
354 These should probably be considered read-only by everyone except
355 FRAME_SAMPLE_VISIBILITY.
357 These two are mutually exclusive. They might both be zero, if the
358 frame has been made invisible without an icon. */
359 char visible, iconified;
361 /* Asynchronous input handlers change these, and
362 FRAME_SAMPLE_VISIBILITY copies them into visible and iconified.
363 See FRAME_SAMPLE_VISIBILITY, below. */
364 volatile char async_visible, async_iconified;
366 /* Nonzero if this frame should be redrawn. */
367 volatile char garbaged;
369 /* True if frame actually has a minibuffer window on it.
370 0 if using a minibuffer window that isn't on this frame. */
371 char has_minibuffer;
373 /* 0 means, if this frame has just one window,
374 show no modeline for that window. */
375 char wants_modeline;
377 /* Non-zero if the hardware device this frame is displaying on can
378 support scroll bars. */
379 char can_have_scroll_bars;
381 /* If can_have_scroll_bars is non-zero, this is non-zero if we should
382 actually display them on this frame. */
383 enum vertical_scroll_bar_type vertical_scroll_bar_type;
385 /* What kind of text cursor should we draw in the future?
386 This should always be filled_box_cursor or bar_cursor. */
387 enum text_cursor_kinds desired_cursor;
389 /* Width of bar cursor (if we are using that). */
390 int cursor_width;
392 /* What kind of text cursor should we draw when the cursor blinks off?
393 This can be filled_box_cursor or bar_cursor or no_cursor. */
394 enum text_cursor_kinds blink_off_cursor;
396 /* Width of bar cursor (if we are using that) for blink-off state. */
397 int blink_off_cursor_width;
399 /* Non-0 means raise this frame to the top of the heap when selected. */
400 char auto_raise;
402 /* Non-0 means lower this frame to the bottom of the stack when left. */
403 char auto_lower;
405 /* True if frame's root window can't be split. */
406 char no_split;
408 /* If this is set, then Emacs won't change the frame name to indicate
409 the current buffer, etcetera. If the user explicitly sets the frame
410 name, this gets set. If the user sets the name to Qnil, this is
411 cleared. */
412 char explicit_name;
414 /* Nonzero if size of some window on this frame has changed. */
415 char window_sizes_changed;
417 /* Storage for messages to this frame. */
418 char *message_buf;
420 /* Nonnegative if current redisplay should not do scroll computation
421 for lines beyond a certain vpos. This is the vpos. */
422 int scroll_bottom_vpos;
424 /* Configured width of the scroll bar, in pixels and in characters.
425 config_scroll_bar_cols tracks config_scroll_bar_width if the
426 latter is positive; a zero value in config_scroll_bar_width means
427 to compute the actual width on the fly, using config_scroll_bar_cols
428 and the current font width. */
429 int config_scroll_bar_width;
430 int config_scroll_bar_cols;
432 /* The size of the extra width currently allotted for vertical
433 scroll bars in this frame, in pixels. */
434 int scroll_bar_actual_width;
436 /* The baud rate that was used to calculate costs for this frame. */
437 int cost_calculation_baud_rate;
439 /* Nonzero if the mouse has moved on this display
440 since the last time we checked. */
441 char mouse_moved;
443 /* Exponent for gamma correction of colors. 1/(VIEWING_GAMMA *
444 SCREEN_GAMMA) where viewing_gamma is 0.4545 and SCREEN_GAMMA is a
445 frame parameter. 0 means don't do gamma correction. */
446 double gamma;
448 /* Additional space to put between text lines on this frame. */
449 int extra_line_spacing;
451 /* Set to non-zero in change_frame_size when size of frame changed
452 Clear the frame in clear_garbaged_frames if set. */
453 unsigned resized_p : 1;
455 /* Set to non-zero in when we want for force a flush_display in
456 update_frame, usually after resizing the frame. */
457 unsigned force_flush_display_p : 1;
459 /* Set to non-zero if the default face for the frame has been
460 realized. Reset to zero whenever the default face changes.
461 Used to see the difference between a font change and face change. */
462 unsigned default_face_done_p : 1;
465 #ifdef MULTI_KBOARD
466 #define FRAME_KBOARD(f) ((f)->kboard)
467 #else
468 #define FRAME_KBOARD(f) (&the_only_kboard)
469 #endif
471 typedef struct frame *FRAME_PTR;
473 #define XFRAME(p) (eassert (GC_FRAMEP(p)),(struct frame *) XPNTR (p))
474 #define XSETFRAME(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_FRAME))
476 /* Given a window, return its frame as a Lisp_Object. */
477 #define WINDOW_FRAME(w) (w)->frame
479 /* Test a frame for particular kinds of display methods. */
480 #define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap)
481 #define FRAME_X_P(f) ((f)->output_method == output_x_window)
482 #define FRAME_W32_P(f) ((f)->output_method == output_w32)
483 #define FRAME_MSDOS_P(f) ((f)->output_method == output_msdos_raw)
484 #define FRAME_MAC_P(f) ((f)->output_method == output_mac)
486 /* FRAME_WINDOW_P tests whether the frame is a window, and is
487 defined to be the predicate for the window system being used. */
489 #ifdef HAVE_X_WINDOWS
490 #define FRAME_WINDOW_P(f) FRAME_X_P (f)
491 #endif
492 #ifdef HAVE_NTGUI
493 #define FRAME_WINDOW_P(f) FRAME_W32_P (f)
494 #endif
495 #ifdef MAC_OS
496 #define FRAME_WINDOW_P(f) FRAME_MAC_P (f)
497 #endif
498 #ifndef FRAME_WINDOW_P
499 #define FRAME_WINDOW_P(f) (0)
500 #endif
502 /* Nonzero if frame F is still alive (not deleted). */
503 #define FRAME_LIVE_P(f) ((f)->output_data.nothing != 0)
505 /* Nonzero if frame F is a minibuffer-only frame. */
506 #define FRAME_MINIBUF_ONLY_P(f) \
507 EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f))
509 /* Nonzero if frame F contains a minibuffer window.
510 (If this is 0, F must use some other minibuffer window.) */
511 #define FRAME_HAS_MINIBUF_P(f) ((f)->has_minibuffer)
513 /* Pixel height of frame F, including non-toolkit menu bar and
514 non-toolkit tool bar lines. */
515 #define FRAME_PIXEL_HEIGHT(f) ((f)->pixel_height)
517 /* Pixel width of frame F. */
518 #define FRAME_PIXEL_WIDTH(f) ((f)->pixel_width)
520 /* Height of frame F, measured in canonical lines, including
521 non-toolkit menu bar and non-toolkit tool bar lines. */
522 #define FRAME_LINES(f) (f)->text_lines
524 /* Width of frame F, measured in canonical character columns,
525 not including scroll bars if any. */
526 #define FRAME_COLS(f) (f)->text_cols
528 /* Number of lines of frame F used for menu bar.
529 This is relevant on terminal frames and on
530 X Windows when not using the X toolkit.
531 These lines are counted in FRAME_LINES. */
532 #define FRAME_MENU_BAR_LINES(f) (f)->menu_bar_lines
534 /* Nonzero if this frame should display a tool bar
535 in a way that does not use any text lines. */
536 #if defined (USE_GTK)
537 #define FRAME_EXTERNAL_TOOL_BAR(f) (f)->external_tool_bar
538 #else
539 #define FRAME_EXTERNAL_TOOL_BAR(f) 0
540 #endif
542 /* Number of lines of frame F used for the tool-bar. */
544 #define FRAME_TOOL_BAR_LINES(f) (f)->tool_bar_lines
547 /* Lines above the top-most window in frame F. */
549 #define FRAME_TOP_MARGIN(F) \
550 (FRAME_MENU_BAR_LINES (F) + FRAME_TOOL_BAR_LINES (F))
552 /* Nonzero if this frame should display a menu bar
553 in a way that does not use any text lines. */
554 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
555 || defined (USE_GTK)
556 #define FRAME_EXTERNAL_MENU_BAR(f) (f)->external_menu_bar
557 #else
558 #define FRAME_EXTERNAL_MENU_BAR(f) 0
559 #endif
560 #define FRAME_VISIBLE_P(f) ((f)->visible != 0)
562 /* Nonzero if frame F is currently visible but hidden. */
563 #define FRAME_OBSCURED_P(f) ((f)->visible > 1)
565 /* Nonzero if frame F is currently iconified. */
566 #define FRAME_ICONIFIED_P(f) (f)->iconified
568 #define FRAME_SET_VISIBLE(f,p) \
569 ((f)->async_visible = (p), FRAME_SAMPLE_VISIBILITY (f))
570 #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1, f->garbaged = 1)
571 #define FRAME_GARBAGED_P(f) (f)->garbaged
573 /* Nonzero means do not allow splitting this frame's window. */
574 #define FRAME_NO_SPLIT_P(f) (f)->no_split
576 /* Not really implemented. */
577 #define FRAME_WANTS_MODELINE_P(f) (f)->wants_modeline
579 /* Nonzero if a size change has been requested for frame F
580 but not yet really put into effect. This can be true temporarily
581 when an X event comes in at a bad time. */
582 #define FRAME_WINDOW_SIZES_CHANGED(f) (f)->window_sizes_changed
584 /* The minibuffer window of frame F, if it has one; otherwise nil. */
585 #define FRAME_MINIBUF_WINDOW(f) (f)->minibuffer_window
587 /* The root window of the window tree of frame F. */
588 #define FRAME_ROOT_WINDOW(f) (f)->root_window
590 /* The currently selected window of the window tree of frame F. */
591 #define FRAME_SELECTED_WINDOW(f) (f)->selected_window
593 #define FRAME_INSERT_COST(f) (f)->insert_line_cost
594 #define FRAME_DELETE_COST(f) (f)->delete_line_cost
595 #define FRAME_INSERTN_COST(f) (f)->insert_n_lines_cost
596 #define FRAME_DELETEN_COST(f) (f)->delete_n_lines_cost
597 #define FRAME_MESSAGE_BUF(f) (f)->message_buf
598 #define FRAME_SCROLL_BOTTOM_VPOS(f) (f)->scroll_bottom_vpos
599 #define FRAME_FOCUS_FRAME(f) (f)->focus_frame
601 /* Nonzero if frame F supports scroll bars.
602 If this is zero, then it is impossible to enable scroll bars
603 on frame F. */
604 #define FRAME_CAN_HAVE_SCROLL_BARS(f) ((f)->can_have_scroll_bars)
606 /* This frame slot says whether scroll bars are currently enabled for frame F,
607 and which side they are on. */
608 #define FRAME_VERTICAL_SCROLL_BAR_TYPE(f) ((f)->vertical_scroll_bar_type)
609 #define FRAME_HAS_VERTICAL_SCROLL_BARS(f) \
610 ((f)->vertical_scroll_bar_type != vertical_scroll_bar_none)
611 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT(f) \
612 ((f)->vertical_scroll_bar_type == vertical_scroll_bar_left)
613 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT(f) \
614 ((f)->vertical_scroll_bar_type == vertical_scroll_bar_right)
616 /* Width that a scroll bar in frame F should have, if there is one.
617 Measured in pixels.
618 If scroll bars are turned off, this is still nonzero. */
619 #define FRAME_CONFIG_SCROLL_BAR_WIDTH(f) ((f)->config_scroll_bar_width)
621 /* Width that a scroll bar in frame F should have, if there is one.
622 Measured in columns (characters).
623 If scroll bars are turned off, this is still nonzero. */
624 #define FRAME_CONFIG_SCROLL_BAR_COLS(f) ((f)->config_scroll_bar_cols)
626 /* Width of a scroll bar in frame F, measured in columns (characters),
627 but only if scroll bars are on the left. If scroll bars are on
628 the right in this frame, or there are no scroll bars, value is 0. */
630 #define FRAME_LEFT_SCROLL_BAR_COLS(f) \
631 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \
632 ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
633 : 0)
635 /* Width of a left scroll bar in frame F, measured in pixels */
637 #define FRAME_LEFT_SCROLL_BAR_AREA_WIDTH(f) \
638 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \
639 ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)) \
640 : 0)
642 /* Width of a scroll bar in frame F, measured in columns (characters),
643 but only if scroll bars are on the right. If scroll bars are on
644 the left in this frame, or there are no scroll bars, value is 0. */
646 #define FRAME_RIGHT_SCROLL_BAR_COLS(f) \
647 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f) \
648 ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
649 : 0)
651 /* Width of a right scroll bar area in frame F, measured in pixels */
653 #define FRAME_RIGHT_SCROLL_BAR_AREA_WIDTH(f) \
654 (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f) \
655 ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)) \
656 : 0)
658 /* Actual width of a scroll bar in frame F, measured in columns. */
660 #define FRAME_SCROLL_BAR_COLS(f) \
661 (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \
662 ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
663 : 0)
665 /* Actual width of a scroll bar area in frame F, measured in pixels. */
667 #define FRAME_SCROLL_BAR_AREA_WIDTH(f) \
668 (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \
669 ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)) \
670 : 0)
672 /* Total width of frame F, in columns (characters),
673 including the width used by scroll bars if any. */
675 #define FRAME_TOTAL_COLS(f) ((f)->total_cols)
677 /* Set the width of frame F to VAL.
678 VAL is the width of a full-frame window,
679 not including scroll bars and fringes. */
681 #define SET_FRAME_COLS(f, val) \
682 (FRAME_COLS (f) = (val), \
683 (f)->total_cols = FRAME_TOTAL_COLS_ARG (f, FRAME_COLS (f)))
685 /* Given a value WIDTH for frame F's nominal width,
686 return the value that FRAME_TOTAL_COLS should have. */
688 #define FRAME_TOTAL_COLS_ARG(f, width) \
689 ((width) \
690 + FRAME_SCROLL_BAR_COLS (f) \
691 + FRAME_FRINGE_COLS (f))
693 /* Maximum + 1 legitimate value for FRAME_CURSOR_X. */
695 #define FRAME_CURSOR_X_LIMIT(f) \
696 (FRAME_COLS (f) + FRAME_LEFT_SCROLL_BAR_COLS (f))
698 /* Nonzero if frame F has scroll bars. */
700 #define FRAME_SCROLL_BARS(f) ((f)->scroll_bars)
702 #define FRAME_CONDEMNED_SCROLL_BARS(f) ((f)->condemned_scroll_bars)
703 #define FRAME_MENU_BAR_ITEMS(f) ((f)->menu_bar_items)
704 #define FRAME_COST_BAUD_RATE(f) ((f)->cost_calculation_baud_rate)
706 #define FRAME_DESIRED_CURSOR(f) ((f)->desired_cursor)
707 #define FRAME_BLINK_OFF_CURSOR(f) ((f)->blink_off_cursor)
708 #define FRAME_CURSOR_WIDTH(f) ((f)->cursor_width)
709 #define FRAME_BLINK_OFF_CURSOR_WIDTH(f) ((f)->blink_off_cursor_width)
711 /* Return a pointer to the face cache of frame F. */
713 #define FRAME_FACE_CACHE(F) (F)->face_cache
715 /* Return the size of message_buf of the frame F. We multiply the
716 width of the frame by 4 because multi-byte form may require at most
717 4-byte for a character. */
719 #define FRAME_MESSAGE_BUF_SIZE(f) (((int) FRAME_COLS (f)) * 4)
721 /* Emacs's redisplay code could become confused if a frame's
722 visibility changes at arbitrary times. For example, if a frame is
723 visible while the desired glyphs are being built, but becomes
724 invisible before they are updated, then some rows of the
725 desired_glyphs will be left marked as enabled after redisplay is
726 complete, which should never happen. The next time the frame
727 becomes visible, redisplay will probably barf.
729 Currently, there are no similar situations involving iconified, but
730 the principle is the same.
732 So instead of having asynchronous input handlers directly set and
733 clear the frame's visibility and iconification flags, they just set
734 the async_visible and async_iconified flags; the redisplay code
735 calls the FRAME_SAMPLE_VISIBILITY macro before doing any redisplay,
736 which sets visible and iconified from their asynchronous
737 counterparts.
739 Synchronous code must use the FRAME_SET_VISIBLE macro.
741 Also, if a frame used to be invisible, but has just become visible,
742 it must be marked as garbaged, since redisplay hasn't been keeping
743 up its contents. */
745 #define FRAME_SAMPLE_VISIBILITY(f) \
746 (((f)->async_visible && (f)->visible != (f)->async_visible) ? \
747 SET_FRAME_GARBAGED (f) : 0, \
748 (f)->visible = (f)->async_visible, \
749 (f)->iconified = (f)->async_iconified)
751 #define CHECK_FRAME(x) \
752 do { \
753 if (! FRAMEP (x)) \
754 x = wrong_type_argument (Qframep, (x)); \
755 } while (0)
757 #define CHECK_LIVE_FRAME(x) \
758 do { \
759 if (! FRAMEP (x) \
760 || ! FRAME_LIVE_P (XFRAME (x))) \
761 x = wrong_type_argument (Qframe_live_p, (x)); \
762 } while (0)
764 /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
765 `for' loop which iterates over the elements of Vframe_list. The
766 loop will set FRAME_VAR, a Lisp_Object, to each frame in
767 Vframe_list in succession and execute the statement. LIST_VAR
768 should be a Lisp_Object too; it is used to iterate through the
769 Vframe_list.
771 This macro is a holdover from a time when multiple frames weren't always
772 supported. An alternate definition of the macro would expand to
773 something which executes the statement once. */
775 #define FOR_EACH_FRAME(list_var, frame_var) \
776 for ((list_var) = Vframe_list; \
777 (CONSP (list_var) \
778 && (frame_var = XCAR (list_var), 1)); \
779 list_var = XCDR (list_var))
782 extern Lisp_Object Qframep, Qframe_live_p;
784 extern struct frame *last_nonminibuf_frame;
786 extern struct frame *make_terminal_frame P_ ((void));
787 extern struct frame *make_frame P_ ((int));
788 #ifdef HAVE_WINDOW_SYSTEM
789 extern struct frame *make_minibuffer_frame P_ ((void));
790 extern struct frame *make_frame_without_minibuffer P_ ((Lisp_Object,
791 struct kboard *,
792 Lisp_Object));
793 #endif /* HAVE_WINDOW_SYSTEM */
794 extern int other_visible_frames P_ ((struct frame *));
796 extern Lisp_Object Vframe_list;
797 extern Lisp_Object Vdefault_frame_alist;
799 extern Lisp_Object Vterminal_frame;
801 extern Lisp_Object Vmouse_highlight;
803 /* The currently selected frame. */
805 extern Lisp_Object selected_frame;
807 /* Value is a pointer to the selected frame. If the selected frame
808 isn't live, abort. */
810 #define SELECTED_FRAME() \
811 ((FRAMEP (selected_frame) \
812 && FRAME_LIVE_P (XFRAME (selected_frame))) \
813 ? XFRAME (selected_frame) \
814 : (abort (), (struct frame *) 0))
817 /***********************************************************************
818 Display-related Macros
819 ***********************************************************************/
821 /* Canonical y-unit on frame F.
822 This value currently equals the line height of the frame (which is
823 the height of the default font of F). */
825 #define FRAME_LINE_HEIGHT(F) ((F)->line_height)
827 /* Canonical x-unit on frame F.
828 This value currently equals the width of the default font of F. */
830 #define FRAME_COLUMN_WIDTH(F) ((F)->column_width)
833 /* Pixel width of areas used to display truncation marks, continuation
834 marks, overlay arrows. This is 0 for terminal frames. */
836 #ifdef HAVE_WINDOW_SYSTEM
838 /* Total width of fringes reserved for drawing truncation bitmaps,
839 continuation bitmaps and alike. The width is in canonical char
840 units of the frame. This must currently be the case because window
841 sizes aren't pixel values. If it weren't the case, we wouldn't be
842 able to split windows horizontally nicely. */
844 #define FRAME_FRINGE_COLS(F) ((F)->fringe_cols)
846 /* Pixel-width of the left and right fringe. */
848 #define FRAME_LEFT_FRINGE_WIDTH(F) ((F)->left_fringe_width)
849 #define FRAME_RIGHT_FRINGE_WIDTH(F) ((F)->right_fringe_width)
851 /* Total width of fringes in pixels. */
853 #define FRAME_TOTAL_FRINGE_WIDTH(F) \
854 (FRAME_LEFT_FRINGE_WIDTH (F) + FRAME_RIGHT_FRINGE_WIDTH (F))
857 /* Pixel-width of internal border lines */
859 #define FRAME_INTERNAL_BORDER_WIDTH(F) ((F)->internal_border_width)
861 #else /* not HAVE_WINDOW_SYSTEM */
863 #define FRAME_FRINGE_COLS(F) 0
864 #define FRAME_TOTAL_FRINGE_WIDTH(F) 0
865 #define FRAME_LEFT_FRINGE_WIDTH(F) 0
866 #define FRAME_RIGHT_FRINGE_WIDTH(F) 0
867 #define FRAME_INTERNAL_BORDER_WIDTH(F) 0
869 #endif /* not HAVE_WINDOW_SYSTEM */
874 /***********************************************************************
875 Conversion between canonical units and pixels
876 ***********************************************************************/
878 /* Canonical x-values are fractions of FRAME_COLUMN_WIDTH, canonical
879 y-unit are fractions of FRAME_LINE_HEIGHT of a frame. Both are
880 represented as Lisp numbers, i.e. integers or floats. */
882 /* Convert canonical value X to pixels. F is the frame whose
883 canonical char width is to be used. X must be a Lisp integer or
884 float. Value is a C integer. */
886 #define FRAME_PIXEL_X_FROM_CANON_X(F, X) \
887 (INTEGERP (X) \
888 ? XINT (X) * FRAME_COLUMN_WIDTH (F) \
889 : (int) (XFLOAT_DATA (X) * FRAME_COLUMN_WIDTH (F)))
891 /* Convert canonical value Y to pixels. F is the frame whose
892 canonical character height is to be used. X must be a Lisp integer
893 or float. Value is a C integer. */
895 #define FRAME_PIXEL_Y_FROM_CANON_Y(F, Y) \
896 (INTEGERP (Y) \
897 ? XINT (Y) * FRAME_LINE_HEIGHT (F) \
898 : (int) (XFLOAT_DATA (Y) * FRAME_LINE_HEIGHT (F)))
900 /* Convert pixel-value X to canonical units. F is the frame whose
901 canonical character width is to be used. X is a C integer. Result
902 is a Lisp float if X is not a multiple of the canon width,
903 otherwise it's a Lisp integer. */
905 #define FRAME_CANON_X_FROM_PIXEL_X(F, X) \
906 ((X) % FRAME_COLUMN_WIDTH (F) != 0 \
907 ? make_float ((double) (X) / FRAME_COLUMN_WIDTH (F)) \
908 : make_number ((X) / FRAME_COLUMN_WIDTH (F)))
910 /* Convert pixel-value Y to canonical units. F is the frame whose
911 canonical character height is to be used. Y is a C integer.
912 Result is a Lisp float if Y is not a multiple of the canon width,
913 otherwise it's a Lisp integer. */
915 #define FRAME_CANON_Y_FROM_PIXEL_Y(F, Y) \
916 ((Y) % FRAME_LINE_HEIGHT (F) \
917 ? make_float ((double) (Y) / FRAME_LINE_HEIGHT (F)) \
918 : make_number ((Y) / FRAME_LINE_HEIGHT (F)))
922 /* Manipulating pixel sizes and character sizes.
923 Knowledge of which factors affect the overall size of the window should
924 be hidden in these macros, if that's possible.
926 Return the upper/left pixel position of the character cell on frame F
927 at ROW/COL. */
929 #define FRAME_LINE_TO_PIXEL_Y(f, row) \
930 (FRAME_INTERNAL_BORDER_WIDTH (f) \
931 + (row) * FRAME_LINE_HEIGHT (f))
933 #define FRAME_COL_TO_PIXEL_X(f, col) \
934 (FRAME_INTERNAL_BORDER_WIDTH (f) \
935 + (col) * FRAME_COLUMN_WIDTH (f))
937 /* Return the pixel width/height of frame F if it has
938 COLS columns/LINES rows. */
940 #define FRAME_TEXT_COLS_TO_PIXEL_WIDTH(f, cols) \
941 (FRAME_COL_TO_PIXEL_X (f, cols) \
942 + (f)->scroll_bar_actual_width \
943 + FRAME_TOTAL_FRINGE_WIDTH (f) \
944 + FRAME_INTERNAL_BORDER_WIDTH (f))
946 #define FRAME_TEXT_LINES_TO_PIXEL_HEIGHT(f, lines) \
947 (FRAME_LINE_TO_PIXEL_Y (f, lines) \
948 + FRAME_INTERNAL_BORDER_WIDTH (f))
951 /* Return the row/column (zero-based) of the character cell containing
952 the pixel on FRAME at Y/X. */
954 #define FRAME_PIXEL_Y_TO_LINE(f, y) \
955 (((y) - FRAME_INTERNAL_BORDER_WIDTH (f)) \
956 / FRAME_LINE_HEIGHT (f))
958 #define FRAME_PIXEL_X_TO_COL(f, x) \
959 (((x) - FRAME_INTERNAL_BORDER_WIDTH (f)) \
960 / FRAME_COLUMN_WIDTH (f))
962 /* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
963 frame F? */
965 #define FRAME_PIXEL_WIDTH_TO_TEXT_COLS(f, width) \
966 (FRAME_PIXEL_X_TO_COL (f, ((width) \
967 - FRAME_INTERNAL_BORDER_WIDTH (f) \
968 - FRAME_TOTAL_FRINGE_WIDTH (f) \
969 - (f)->scroll_bar_actual_width)))
971 #define FRAME_PIXEL_HEIGHT_TO_TEXT_LINES(f, height) \
972 (FRAME_PIXEL_Y_TO_LINE (f, ((height) \
973 - FRAME_INTERNAL_BORDER_WIDTH (f))))
976 /***********************************************************************
977 Frame Parameters
978 ***********************************************************************/
980 extern Lisp_Object Qauto_raise, Qauto_lower;
981 extern Lisp_Object Qborder_color, Qborder_width;
982 extern Lisp_Object Qbuffer_predicate, Qbuffer_list;
983 extern Lisp_Object Qcursor_color, Qcursor_type;
984 extern Lisp_Object Qfont;
985 extern Lisp_Object Qbackground_color, Qforeground_color;
986 extern Lisp_Object Qicon, Qicon_name, Qicon_type, Qicon_left, Qicon_top;
987 extern Lisp_Object Qinternal_border_width;
988 extern Lisp_Object Qmenu_bar_lines, Qtool_bar_lines;
989 extern Lisp_Object Qmouse_color;
990 extern Lisp_Object Qname, Qtitle;
991 extern Lisp_Object Qparent_id;
992 extern Lisp_Object Qunsplittable, Qvisibility;
993 extern Lisp_Object Qscroll_bar_width, Qvertical_scroll_bars;
994 extern Lisp_Object Qscroll_bar_foreground, Qscroll_bar_background;
995 extern Lisp_Object Qscreen_gamma;
996 extern Lisp_Object Qline_spacing;
997 extern Lisp_Object Qwait_for_wm;
998 extern Lisp_Object Qfullscreen;
1000 extern Lisp_Object Qleft_fringe, Qright_fringe;
1001 extern Lisp_Object Qheight, Qwidth;
1002 extern Lisp_Object Qminibuffer, Qmodeline;
1003 extern Lisp_Object Qonly;
1004 extern Lisp_Object Qx, Qw32, Qmac, Qpc;
1005 extern Lisp_Object Qvisible;
1006 extern Lisp_Object Qdisplay_type;
1007 extern Lisp_Object Qbackground_mode;
1009 extern Lisp_Object Qx_resource_name;
1011 extern Lisp_Object Qleft, Qright, Qtop, Qbox;
1012 extern Lisp_Object Qdisplay;
1014 #ifdef HAVE_WINDOW_SYSTEM
1016 /* The class of this X application. */
1017 #define EMACS_CLASS "Emacs"
1019 enum
1021 /* Values used as a bit mask, BOTH == WIDTH | HEIGHT. */
1022 FULLSCREEN_NONE = 0,
1023 FULLSCREEN_WIDTH = 1,
1024 FULLSCREEN_HEIGHT = 2,
1025 FULLSCREEN_BOTH = 3,
1026 FULLSCREEN_WAIT = 4,
1030 /* These are in xterm.c, w32term.c, etc. */
1032 extern void x_set_scroll_bar_default_width P_ ((struct frame *));
1033 extern void x_set_offset P_ ((struct frame *, int, int, int));
1034 extern void x_wm_set_icon_position P_ ((struct frame *, int, int));
1036 extern Lisp_Object x_new_font P_ ((struct frame *, char *));
1037 extern Lisp_Object x_new_fontset P_ ((struct frame *, char *));
1040 /* These are in frame.c */
1042 extern Lisp_Object Vx_resource_name;
1043 extern Lisp_Object Vx_resource_class;
1046 extern Lisp_Object Qface_set_after_frame_default;
1048 extern void x_fullscreen_adjust P_ ((struct frame *f, int *, int *,
1049 int *, int *));
1051 extern void x_set_frame_parameters P_ ((struct frame *, Lisp_Object));
1052 extern void x_report_frame_params P_ ((struct frame *, Lisp_Object *));
1054 extern void x_set_fullscreen P_ ((struct frame *, Lisp_Object, Lisp_Object));
1055 extern void x_set_line_spacing P_ ((struct frame *, Lisp_Object, Lisp_Object));
1056 extern void x_set_screen_gamma P_ ((struct frame *, Lisp_Object, Lisp_Object));
1057 extern void x_set_font P_ ((struct frame *, Lisp_Object, Lisp_Object));
1058 extern void x_set_fringe_width P_ ((struct frame *, Lisp_Object, Lisp_Object));
1059 extern void x_set_border_width P_ ((struct frame *, Lisp_Object, Lisp_Object));
1060 extern void x_set_internal_border_width P_ ((struct frame *, Lisp_Object,
1061 Lisp_Object));
1062 extern void x_set_visibility P_ ((struct frame *, Lisp_Object, Lisp_Object));
1063 extern void x_set_autoraise P_ ((struct frame *, Lisp_Object, Lisp_Object));
1064 extern void x_set_autolower P_ ((struct frame *, Lisp_Object, Lisp_Object));
1065 extern void x_set_unsplittable P_ ((struct frame *, Lisp_Object, Lisp_Object));
1066 extern void x_set_vertical_scroll_bars P_ ((struct frame *, Lisp_Object,
1067 Lisp_Object));
1068 extern void x_set_scroll_bar_width P_ ((struct frame *, Lisp_Object,
1069 Lisp_Object));
1071 extern Lisp_Object x_icon_type P_ ((struct frame *));
1073 extern int x_figure_window_size P_ ((struct frame *, Lisp_Object, int));
1076 extern void validate_x_resource_name P_ ((void));
1078 #endif /* HAVE_WINDOW_SYSTEM */
1080 #endif /* not EMACS_FRAME_H */
1082 /* arch-tag: 0df048ee-e6bf-4f48-bd56-e3cd055dd8c4
1083 (do not change this comment) */