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