Initial revision
[emacs.git] / src / frame.h
blobd523046266035fd75c053a777fbe6860403d84cb
1 /* Define frame-object for GNU Emacs.
2 Copyright (C) 1993, 1994 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
9 any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
21 /* Miscellanea. */
23 /* Nonzero means don't assume anything about current
24 contents of actual terminal frame */
25 extern int frame_garbaged;
27 /* Nonzero means FRAME_MESSAGE_BUF (selected_frame) is being used by
28 print. */
29 extern int message_buf_print;
32 /* The structure representing a frame.
34 We declare this even if MULTI_FRAME is not defined, because when
35 we lack multi-frame support, we use one instance of this structure
36 to represent the one frame we support. This is cleaner than
37 having miscellaneous random variables scattered about. */
39 enum output_method
40 { output_termcap, output_x_window, output_msdos_raw };
42 struct frame
44 EMACS_INT size;
45 struct Lisp_Vector *next;
47 /* All Lisp_Object components must come first.
48 Only EMACS_INT values can be intermixed with them.
49 That ensures they are all aligned normally. */
51 /* Name of this frame: a Lisp string. See also `explicit_name'. */
52 Lisp_Object name;
54 /* The frame which should receive keystrokes that occur in this
55 frame, or nil if they should go to the frame itself. This is
56 usually nil, but if the frame is minibufferless, we can use this
57 to redirect keystrokes to a surrogate minibuffer frame when
58 needed.
60 Note that a value of nil is different than having the field point
61 to the frame itself. Whenever the Fselect_frame function is used
62 to shift from one frame to the other, any redirections to the
63 original frame are shifted to the newly selected frame; if
64 focus_frame is nil, Fselect_frame will leave it alone. */
65 Lisp_Object focus_frame;
67 /* This frame's root window. Every frame has one.
68 If the frame has only a minibuffer window, this is it.
69 Otherwise, if the frame has a minibuffer window, this is its sibling. */
70 Lisp_Object root_window;
72 /* This frame's selected window.
73 Each frame has its own window hierarchy
74 and one of the windows in it is selected within the frame.
75 The selected window of the selected frame is Emacs's selected window. */
76 Lisp_Object selected_window;
78 /* This frame's minibuffer window.
79 Most frames have their own minibuffer windows,
80 but only the selected frame's minibuffer window
81 can actually appear to exist. */
82 Lisp_Object minibuffer_window;
84 /* Parameter alist of this frame.
85 These are the parameters specified when creating the frame
86 or modified with modify-frame-parameters. */
87 Lisp_Object param_alist;
89 /* List of scroll bars on this frame.
90 Actually, we don't specify exactly what is stored here at all; the
91 scroll bar implementation code can use it to store anything it likes.
92 This field is marked by the garbage collector. It is here
93 instead of in the `display' structure so that the garbage
94 collector doesn't need to look inside the window-system-dependent
95 structure. */
96 Lisp_Object scroll_bars;
97 Lisp_Object condemned_scroll_bars;
99 /* List of elements to display in the menu bar.
100 The elements have the form (KEY STRING . nil) to start;
101 when they are displayed, the hpos of the left edge goes in the cddr. */
102 Lisp_Object menu_bar_items;
104 /* Alist of elements (FACE-NAME . FACE-VECTOR-DATA). */
105 Lisp_Object face_alist;
107 /* A vector that records the entire structure of this frame's menu bar.
108 For the format of the data, see extensive comments in xmenu.c.
109 Only the X toolkit version uses this. */
110 Lisp_Object menu_bar_vector;
111 /* Number of elements in the vector that have meaningful data. */
112 EMACS_INT menu_bar_items_used;
114 /* Predicate for selecting buffers for other-buffer. */
115 Lisp_Object buffer_predicate;
117 /* Beyond here, there should be no more Lisp_Object components. */
120 /* glyphs as they appear on the frame */
121 struct frame_glyphs *current_glyphs;
123 /* glyphs we'd like to appear on the frame */
124 struct frame_glyphs *desired_glyphs;
126 /* See do_line_insertion_deletion_costs for info on these arrays. */
127 /* Cost of inserting 1 line on this frame */
128 int *insert_line_cost;
129 /* Cost of deleting 1 line on this frame */
130 int *delete_line_cost;
131 /* Cost of inserting n lines on this frame */
132 int *insert_n_lines_cost;
133 /* Cost of deleting n lines on this frame */
134 int *delete_n_lines_cost;
136 /* glyphs for the mode line */
137 struct frame_glyphs *temp_glyphs;
139 /* Intended cursor position of this frame.
140 Measured in characters, counting from upper left corner
141 within the frame. */
142 int cursor_x;
143 int cursor_y;
145 /* Actual cursor position of this frame, and the character under it.
146 (Not used for terminal frames.) */
147 int phys_cursor_x;
148 int phys_cursor_y;
149 /* This is handy for undrawing the cursor, because current_glyphs is
150 not always accurate when in do_scrolling. */
151 GLYPH phys_cursor_glyph;
153 /* Size of this frame, in units of characters. */
154 EMACS_INT height;
155 EMACS_INT width;
157 /* New height and width for pending size change. 0 if no change pending. */
158 int new_height, new_width;
160 /* The output method says how the contents of this frame
161 are displayed. It could be using termcap, or using an X window. */
162 enum output_method output_method;
164 /* A structure of auxiliary data used for displaying the contents.
165 struct x_display is used for X window frames;
166 it is defined in xterm.h. */
167 union display { struct x_display *x; int nothing; } display;
169 /* Number of lines of menu bar. */
170 int menu_bar_lines;
172 #ifdef USE_X_TOOLKIT
173 /* Nonzero means using a menu bar that comes from the X toolkit. */
174 int external_menu_bar;
175 #endif
177 /* Nonzero if last attempt at redisplay on this frame was preempted. */
178 char display_preempted;
180 /* visible is nonzero if the frame is currently displayed; we check
181 it to see if we should bother updating the frame's contents.
182 DON'T SET IT DIRECTLY; instead, use FRAME_SET_VISIBLE.
184 Note that, since invisible frames aren't updated, whenever a
185 frame becomes visible again, it must be marked as garbaged. The
186 FRAME_SAMPLE_VISIBILITY macro takes care of this.
188 iconified is nonzero if the frame is currently iconified.
190 Asynchronous input handlers should NOT change these directly;
191 instead, they should change async_visible or async_iconified, and
192 let the FRAME_SAMPLE_VISIBILITY macro set visible and iconified
193 at the next redisplay.
195 These should probably be considered read-only by everyone except
196 FRAME_SAMPLE_VISIBILITY.
198 These two are mutually exclusive. They might both be zero, if the
199 frame has been made invisible without an icon. */
200 char visible, iconified;
202 /* Asynchronous input handlers change these, and
203 FRAME_SAMPLE_VISIBILITY copies them into visible and iconified.
204 See FRAME_SAMPLE_VISIBILITY, below. */
205 #ifdef __STDC__
206 volatile
207 #endif
208 char async_visible, async_iconified;
210 /* Nonzero if this frame should be redrawn. */
211 #ifdef __STDC__
212 volatile
213 #endif
214 char garbaged;
216 /* True if frame actually has a minibuffer window on it.
217 0 if using a minibuffer window that isn't on this frame. */
218 char has_minibuffer;
220 /* 0 means, if this frame has just one window,
221 show no modeline for that window. */
222 char wants_modeline;
224 /* Non-zero if the hardware device this frame is displaying on can
225 support scroll bars. */
226 char can_have_scroll_bars;
228 /* If can_have_scroll_bars is non-zero, this is non-zero if we should
229 actually display them on this frame. */
230 char has_vertical_scroll_bars;
232 /* Non-0 means raise this frame to the top of the heap when selected. */
233 char auto_raise;
235 /* Non-0 means lower this frame to the bottom of the stack when left. */
236 char auto_lower;
238 /* True if frame's root window can't be split. */
239 char no_split;
241 /* If this is set, then Emacs won't change the frame name to indicate
242 the current buffer, etcetera. If the user explicitly sets the frame
243 name, this gets set. If the user sets the name to Qnil, this is
244 cleared. */
245 char explicit_name;
247 /* Storage for messages to this frame. */
248 char *message_buf;
250 /* Nonnegative if current redisplay should not do scroll computation
251 for lines beyond a certain vpos. This is the vpos. */
252 int scroll_bottom_vpos;
254 /* Width of the scroll bar, in pixels and in characters.
255 scroll_bar_cols tracks scroll_bar_pixel_width if the latter is positive;
256 a zero value in scroll_bar_pixel_width means to compute the actual width
257 on the fly, using scroll_bar_cols and the current font width. */
258 int scroll_bar_pixel_width;
259 int scroll_bar_cols;
261 /* The baud rate that was used to calculate costs for this frame. */
262 int cost_calculation_baud_rate;
265 #ifdef MULTI_FRAME
267 typedef struct frame *FRAME_PTR;
269 #define XFRAME(p) ((struct frame *) XPNTR (p))
270 #define XSETFRAME(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_FRAME))
272 #define WINDOW_FRAME(w) (w)->frame
274 #define FRAME_LIVE_P(f) ((f)->display.nothing != 0)
275 #define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap)
276 #define FRAME_X_P(f) ((f)->output_method == output_x_window)
277 #define FRAME_MINIBUF_ONLY_P(f) \
278 EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f))
279 #define FRAME_HAS_MINIBUF_P(f) ((f)->has_minibuffer)
280 #define FRAME_CURRENT_GLYPHS(f) (f)->current_glyphs
281 #define FRAME_DESIRED_GLYPHS(f) (f)->desired_glyphs
282 #define FRAME_TEMP_GLYPHS(f) (f)->temp_glyphs
283 #define FRAME_HEIGHT(f) (f)->height
284 #define FRAME_WIDTH(f) (f)->width
285 #define FRAME_NEW_HEIGHT(f) (f)->new_height
286 #define FRAME_NEW_WIDTH(f) (f)->new_width
287 #define FRAME_MENU_BAR_LINES(f) (f)->menu_bar_lines
288 #ifdef USE_X_TOOLKIT
289 #define FRAME_EXTERNAL_MENU_BAR(f) (f)->external_menu_bar
290 #else
291 #define FRAME_EXTERNAL_MENU_BAR(f) 0
292 #endif
293 #define FRAME_CURSOR_X(f) (f)->cursor_x
294 #define FRAME_CURSOR_Y(f) (f)->cursor_y
295 #define FRAME_VISIBLE_P(f) ((f)->visible != 0)
296 #define FRAME_SET_VISIBLE(f,p) \
297 ((f)->async_visible = (p), FRAME_SAMPLE_VISIBILITY (f))
298 #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1, f->garbaged = 1)
299 #define FRAME_GARBAGED_P(f) (f)->garbaged
300 #define FRAME_NO_SPLIT_P(f) (f)->no_split
301 #define FRAME_WANTS_MODELINE_P(f) (f)->wants_modeline
302 #define FRAME_ICONIFIED_P(f) (f)->iconified
303 #define FRAME_MINIBUF_WINDOW(f) (f)->minibuffer_window
304 #define FRAME_ROOT_WINDOW(f) (f)->root_window
305 #define FRAME_SELECTED_WINDOW(f) (f)->selected_window
306 #define SET_GLYPHS_FRAME(glyphs,frame) ((glyphs)->frame = (frame))
307 #define FRAME_INSERT_COST(f) (f)->insert_line_cost
308 #define FRAME_DELETE_COST(f) (f)->delete_line_cost
309 #define FRAME_INSERTN_COST(f) (f)->insert_n_lines_cost
310 #define FRAME_DELETEN_COST(f) (f)->delete_n_lines_cost
311 #define FRAME_MESSAGE_BUF(f) (f)->message_buf
312 #define FRAME_SCROLL_BOTTOM_VPOS(f) (f)->scroll_bottom_vpos
313 #define FRAME_FOCUS_FRAME(f) (f)->focus_frame
314 #define FRAME_CAN_HAVE_SCROLL_BARS(f) ((f)->can_have_scroll_bars)
315 #define FRAME_HAS_VERTICAL_SCROLL_BARS(f) ((f)->has_vertical_scroll_bars)
316 #define FRAME_SCROLL_BAR_PIXEL_WIDTH(f) ((f)->scroll_bar_pixel_width)
317 #define FRAME_SCROLL_BAR_COLS(f) ((f)->scroll_bar_cols)
318 #define FRAME_SCROLL_BARS(f) ((f)->scroll_bars)
319 #define FRAME_CONDEMNED_SCROLL_BARS(f) ((f)->condemned_scroll_bars)
320 #define FRAME_MENU_BAR_ITEMS(f) ((f)->menu_bar_items)
321 #define FRAME_COST_BAUD_RATE(f) ((f)->cost_calculation_baud_rate)
323 /* Emacs's redisplay code could become confused if a frame's
324 visibility changes at arbitrary times. For example, if a frame is
325 visible while the desired glyphs are being built, but becomes
326 invisible before they are updated, then some rows of the
327 desired_glyphs will be left marked as enabled after redisplay is
328 complete, which should never happen. The next time the frame
329 becomes visible, redisplay will probably barf.
331 Currently, there are no similar situations involving iconified, but
332 the principle is the same.
334 So instead of having asynchronous input handlers directly set and
335 clear the frame's visibility and iconification flags, they just set
336 the async_visible and async_iconified flags; the redisplay code
337 calls the FRAME_SAMPLE_VISIBILITY macro before doing any redisplay,
338 which sets visible and iconified from their asynchronous
339 counterparts.
341 Synchronous code must use the FRAME_SET_VISIBLE macro.
343 Also, if a frame used to be invisible, but has just become visible,
344 it must be marked as garbaged, since redisplay hasn't been keeping
345 up its contents. */
346 #define FRAME_SAMPLE_VISIBILITY(f) \
347 (((f)->async_visible && ! (f)->visible) ? SET_FRAME_GARBAGED (f) : 0, \
348 (f)->visible = (f)->async_visible, \
349 (f)->iconified = (f)->async_iconified)
351 #define CHECK_FRAME(x, i) \
353 if (! FRAMEP (x)) \
354 x = wrong_type_argument (Qframep, (x)); \
357 #define CHECK_LIVE_FRAME(x, i) \
359 if (! FRAMEP (x) \
360 || ! FRAME_LIVE_P (XFRAME (x))) \
361 x = wrong_type_argument (Qframe_live_p, (x)); \
364 /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
365 `for' loop which iterates over the elements of Vframe_list. The
366 loop will set FRAME_VAR, a Lisp_Object, to each frame in
367 Vframe_list in succession and execute the statement. LIST_VAR
368 should be a Lisp_Object too; it is used to iterate through the
369 Vframe_list.
371 If MULTI_FRAME isn't defined, then this loop expands to something which
372 executes the statement once. */
373 #define FOR_EACH_FRAME(list_var, frame_var) \
374 for ((list_var) = Vframe_list; \
375 (CONSP (list_var) \
376 && (frame_var = XCONS (list_var)->car, 1)); \
377 list_var = XCONS (list_var)->cdr)
380 extern Lisp_Object Qframep, Qframe_live_p, Qicon;
382 extern struct frame *selected_frame;
383 extern struct frame *last_nonminibuf_frame;
385 extern struct frame *make_terminal_frame ();
386 extern struct frame *make_frame ();
387 extern struct frame *make_minibuffer_frame ();
388 extern struct frame *make_frame_without_minibuffer ();
390 extern Lisp_Object Vframe_list;
391 extern Lisp_Object Vdefault_frame_alist;
393 extern Lisp_Object Vterminal_frame;
395 #else /* not MULTI_FRAME */
397 /* These definitions are used in a single-frame version of Emacs. */
399 /* A frame we use to store all the data concerning the screen when we
400 don't have multiple frames. Remember, if you store any data in it
401 which needs to be protected from GC, you should staticpro that
402 element explicitly. */
403 extern struct frame the_only_frame;
405 typedef struct frame *FRAME_PTR;
406 #ifdef __GNUC__
407 /* A function call for always getting 0 is overkill, so... */
408 #define WINDOW_FRAME(w) ({ Lisp_Object tem; XSETFASTINT (tem, 0); tem; })
409 #else
410 #define WINDOW_FRAME(w) (Fselected_frame ())
411 #endif
412 #define XSETFRAME(p, v) (p = WINDOW_FRAME (***bogus***))
413 #define XFRAME(frame) (&the_only_frame)
415 extern FRAME_PTR selected_frame;
416 extern FRAME_PTR last_nonminibuf_frame;
418 #define FRAME_LIVE_P(f) 1
419 #ifdef MSDOS
420 /* The following definitions could also be used in the non-MSDOS case,
421 but the constants below lead to better code. */
422 #define FRAME_TERMCAP_P(f) (the_only_frame.output_method == output_termcap)
423 #define FRAME_X_P(f) (the_only_frame.output_method != output_termcap)
424 #else
425 #define FRAME_TERMCAP_P(f) 1
426 #define FRAME_X_P(f) 0
427 #endif
428 #define FRAME_MINIBUF_ONLY_P(f) 0
429 #define FRAME_HAS_MINIBUF_P(f) 1
430 #define FRAME_CURRENT_GLYPHS(f) (the_only_frame.current_glyphs)
431 #define FRAME_DESIRED_GLYPHS(f) (the_only_frame.desired_glyphs)
432 #define FRAME_TEMP_GLYPHS(f) (the_only_frame.temp_glyphs)
433 #define FRAME_HEIGHT(f) (the_only_frame.height)
434 #define FRAME_WIDTH(f) (the_only_frame.width)
435 #define FRAME_NEW_HEIGHT(f) (the_only_frame.new_height)
436 #define FRAME_NEW_WIDTH(f) (the_only_frame.new_width)
437 #define FRAME_MENU_BAR_LINES(f) (the_only_frame.menu_bar_lines)
438 #define FRAME_CURSOR_X(f) (the_only_frame.cursor_x)
439 #define FRAME_CURSOR_Y(f) (the_only_frame.cursor_y)
440 #define FRAME_SET_VISIBLE(f,p) (p)
441 #define FRAME_VISIBLE_P(f) 1
442 #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1)
443 #define FRAME_GARBAGED_P(f) (frame_garbaged)
444 #define FRAME_NO_SPLIT_P(f) 0
445 #define FRAME_WANTS_MODELINE_P(f) 1
446 #define FRAME_ICONIFIED_P(f) 0
447 #define FRAME_MINIBUF_WINDOW(f) (minibuf_window)
448 #define FRAME_ROOT_WINDOW(f) (the_only_frame.root_window)
449 #define FRAME_SELECTED_WINDOW(f) (selected_window)
450 #define SET_GLYPHS_FRAME(glyphs,frame) do ; while (0)
451 #define FRAME_INSERT_COST(frame) (the_only_frame.insert_line_cost)
452 #define FRAME_DELETE_COST(frame) (the_only_frame.delete_line_cost)
453 #define FRAME_INSERTN_COST(frame) (the_only_frame.insert_n_lines_cost)
454 #define FRAME_DELETEN_COST(frame) (the_only_frame.delete_n_lines_cost)
455 #define FRAME_MESSAGE_BUF(f) (the_only_frame.message_buf)
456 #define FRAME_SCROLL_BOTTOM_VPOS(f) (the_only_frame.scroll_bottom_vpos)
457 #define FRAME_FOCUS_FRAME(f) (Qnil)
458 #define FRAME_CAN_HAVE_SCROLL_BARS(f) (the_only_frame.can_have_scroll_bars)
459 #define FRAME_HAS_VERTICAL_SCROLL_BARS(f) \
460 (the_only_frame.has_vertical_scroll_bars)
461 #define FRAME_SCROLL_BAR_PIXEL_WIDTH(f) (the_only_frame.scroll_bar_pixel_width)
462 #define FRAME_SCROLL_BAR_COLS(f) (the_only_frame.scroll_bar_cols)
463 #define FRAME_SCROLL_BARS(f) (the_only_frame.scroll_bars)
464 #define FRAME_CONDEMNED_SCROLL_BARS(f) (the_only_frame.condemned_scroll_bars)
465 #define FRAME_MENU_BAR_ITEMS(f) (the_only_frame.menu_bar_items)
466 #define FRAME_COST_BAUD_RATE(f) (the_only_frame.cost_calculation_baud_rate)
468 /* See comments in definition above. */
469 #define FRAME_SAMPLE_VISIBILITY(f) (0)
471 #define CHECK_FRAME(x, i) do; while (0)
472 #define CHECK_LIVE_FRAME(x, y) do; while (0)
474 /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
475 `for' loop which iterates over the elements of Vframe_list. The
476 loop will set FRAME_VAR, a Lisp_Object, to each frame in
477 Vframe_list in succession and execute the statement. LIST_VAR
478 should be a Lisp_Object too; it is used to iterate through the
479 Vframe_list.
481 If MULTI_FRAME _is_ defined, then this loop expands to a real
482 `for' loop which traverses Vframe_list using LIST_VAR and
483 FRAME_VAR. */
484 #define FOR_EACH_FRAME(list_var, frame_var) \
485 for (list_var = Qt; frame_var = WINDOW_FRAME (***bogus***), ! NILP (list_var); list_var = Qnil)
487 #endif /* not MULTI_FRAME */
490 /* Device- and MULTI_FRAME-independent scroll bar stuff. */
492 /* Return the starting column (zero-based) of the vertical scroll bar
493 for window W. The column before this one is the last column we can
494 use for text. If the window touches the right edge of the frame,
495 we have extra space allocated for it. Otherwise, the scroll bar
496 takes over the window's rightmost columns. */
497 #define WINDOW_VERTICAL_SCROLL_BAR_COLUMN(w) \
498 (((XINT ((w)->left) + XINT ((w)->width)) \
499 < FRAME_WIDTH (XFRAME (WINDOW_FRAME (w)))) \
500 ? (XINT ((w)->left) + XINT ((w)->width) \
501 - FRAME_SCROLL_BAR_COLS (XFRAME (WINDOW_FRAME (w)))) \
502 : FRAME_WIDTH (XFRAME (WINDOW_FRAME (w))))
504 /* Return the height in lines of the vertical scroll bar in w. If the
505 window has a mode line, don't make the scroll bar extend that far. */
506 #define WINDOW_VERTICAL_SCROLL_BAR_HEIGHT(w) (window_internal_height (w))