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