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