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)
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. */
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
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. */
40 { output_termcap
, output_x_window
, output_msdos_raw
, output_win32
};
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'
55 /* The name to use for the icon, the last time
56 it was refreshed. nil means not explicitly specified. */
57 Lisp_Object icon_name
;
59 /* The frame which should receive keystrokes that occur in this
60 frame, or nil if they should go to the frame itself. This is
61 usually nil, but if the frame is minibufferless, we can use this
62 to redirect keystrokes to a surrogate minibuffer frame when
65 Note that a value of nil is different than having the field point
66 to the frame itself. Whenever the Fselect_frame function is used
67 to shift from one frame to the other, any redirections to the
68 original frame are shifted to the newly selected frame; if
69 focus_frame is nil, Fselect_frame will leave it alone. */
70 Lisp_Object focus_frame
;
72 /* This frame's root window. Every frame has one.
73 If the frame has only a minibuffer window, this is it.
74 Otherwise, if the frame has a minibuffer window, this is its sibling. */
75 Lisp_Object root_window
;
77 /* This frame's selected window.
78 Each frame has its own window hierarchy
79 and one of the windows in it is selected within the frame.
80 The selected window of the selected frame is Emacs's selected window. */
81 Lisp_Object selected_window
;
83 /* This frame's minibuffer window.
84 Most frames have their own minibuffer windows,
85 but only the selected frame's minibuffer window
86 can actually appear to exist. */
87 Lisp_Object minibuffer_window
;
89 /* Parameter alist of this frame.
90 These are the parameters specified when creating the frame
91 or modified with modify-frame-parameters. */
92 Lisp_Object param_alist
;
94 /* List of scroll bars on this frame.
95 Actually, we don't specify exactly what is stored here at all; the
96 scroll bar implementation code can use it to store anything it likes.
97 This field is marked by the garbage collector. It is here
98 instead of in the `display' structure so that the garbage
99 collector doesn't need to look inside the window-system-dependent
101 Lisp_Object scroll_bars
;
102 Lisp_Object condemned_scroll_bars
;
104 /* List of elements to display in the menu bar.
105 The elements have the form (KEY STRING . nil) to start;
106 when they are displayed, the hpos of the left edge goes in the cddr. */
107 Lisp_Object menu_bar_items
;
109 /* Alist of elements (FACE-NAME . FACE-VECTOR-DATA). */
110 Lisp_Object face_alist
;
112 /* A vector that records the entire structure of this frame's menu bar.
113 For the format of the data, see extensive comments in xmenu.c.
114 Only the X toolkit version uses this. */
115 Lisp_Object menu_bar_vector
;
116 /* Number of elements in the vector that have meaningful data. */
117 EMACS_INT menu_bar_items_used
;
119 /* Predicate for selecting buffers for other-buffer. */
120 Lisp_Object buffer_predicate
;
122 /* Beyond here, there should be no more Lisp_Object components. */
125 /* A buffer to hold the frame's name. We can't use the Lisp string's
126 pointer (`name', above) because it might get relocated. */
129 /* glyphs as they appear on the frame */
130 struct frame_glyphs
*current_glyphs
;
132 /* glyphs we'd like to appear on the frame */
133 struct frame_glyphs
*desired_glyphs
;
135 /* See do_line_insertion_deletion_costs for info on these arrays. */
136 /* Cost of inserting 1 line on this frame */
137 int *insert_line_cost
;
138 /* Cost of deleting 1 line on this frame */
139 int *delete_line_cost
;
140 /* Cost of inserting n lines on this frame */
141 int *insert_n_lines_cost
;
142 /* Cost of deleting n lines on this frame */
143 int *delete_n_lines_cost
;
145 /* glyphs for the mode line */
146 struct frame_glyphs
*temp_glyphs
;
148 /* Intended cursor position of this frame.
149 Measured in characters, counting from upper left corner
154 /* Actual cursor position of this frame, and the character under it.
155 (Not used for terminal frames.) */
158 /* This is handy for undrawing the cursor, because current_glyphs is
159 not always accurate when in do_scrolling. */
160 GLYPH phys_cursor_glyph
;
162 /* Size of this frame, in units of characters. */
166 /* New height and width for pending size change. 0 if no change pending. */
167 int new_height
, new_width
;
169 /* The output method says how the contents of this frame
170 are displayed. It could be using termcap, or using an X window. */
171 enum output_method output_method
;
173 /* A structure of auxiliary data used for displaying the contents.
174 struct x_output is used for X window frames;
175 it is defined in xterm.h.
176 struct win32_output is used for Win32 window frames;
177 it is defined in w32term.h. */
178 union output_data
{ struct x_output
*x
; struct win32_output
*win32
; int nothing
; } output_data
;
181 /* A pointer to the kboard structure associated with this frame.
182 For termcap frames, this points to initial_kboard. For X frames,
183 it will be the same as display.x->display_info->kboard. */
184 struct kboard
*kboard
;
187 /* Number of lines of menu bar. */
190 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
191 /* Nonzero means using a menu bar that comes from the X toolkit. */
192 int external_menu_bar
;
195 /* Nonzero if last attempt at redisplay on this frame was preempted. */
196 char display_preempted
;
198 /* visible is nonzero if the frame is currently displayed; we check
199 it to see if we should bother updating the frame's contents.
200 DON'T SET IT DIRECTLY; instead, use FRAME_SET_VISIBLE.
202 Note that, since invisible frames aren't updated, whenever a
203 frame becomes visible again, it must be marked as garbaged. The
204 FRAME_SAMPLE_VISIBILITY macro takes care of this.
206 iconified is nonzero if the frame is currently iconified.
208 Asynchronous input handlers should NOT change these directly;
209 instead, they should change async_visible or async_iconified, and
210 let the FRAME_SAMPLE_VISIBILITY macro set visible and iconified
211 at the next redisplay.
213 These should probably be considered read-only by everyone except
214 FRAME_SAMPLE_VISIBILITY.
216 These two are mutually exclusive. They might both be zero, if the
217 frame has been made invisible without an icon. */
218 char visible
, iconified
;
220 /* Asynchronous input handlers change these, and
221 FRAME_SAMPLE_VISIBILITY copies them into visible and iconified.
222 See FRAME_SAMPLE_VISIBILITY, below. */
226 char async_visible
, async_iconified
;
228 /* Nonzero if this frame should be redrawn. */
234 /* True if frame actually has a minibuffer window on it.
235 0 if using a minibuffer window that isn't on this frame. */
238 /* 0 means, if this frame has just one window,
239 show no modeline for that window. */
242 /* Non-zero if the hardware device this frame is displaying on can
243 support scroll bars. */
244 char can_have_scroll_bars
;
246 /* If can_have_scroll_bars is non-zero, this is non-zero if we should
247 actually display them on this frame. */
248 char has_vertical_scroll_bars
;
250 /* Non-0 means raise this frame to the top of the heap when selected. */
253 /* Non-0 means lower this frame to the bottom of the stack when left. */
256 /* True if frame's root window can't be split. */
259 /* If this is set, then Emacs won't change the frame name to indicate
260 the current buffer, etcetera. If the user explicitly sets the frame
261 name, this gets set. If the user sets the name to Qnil, this is
265 /* Nonzero if size of some window on this frame has changed. */
266 char window_sizes_changed
;
268 /* Storage for messages to this frame. */
271 /* Nonnegative if current redisplay should not do scroll computation
272 for lines beyond a certain vpos. This is the vpos. */
273 int scroll_bottom_vpos
;
275 /* Width of the scroll bar, in pixels and in characters.
276 scroll_bar_cols tracks scroll_bar_pixel_width if the latter is positive;
277 a zero value in scroll_bar_pixel_width means to compute the actual width
278 on the fly, using scroll_bar_cols and the current font width. */
279 int scroll_bar_pixel_width
;
282 /* The baud rate that was used to calculate costs for this frame. */
283 int cost_calculation_baud_rate
;
285 /* Nonzero if the mouse has moved on this display
286 since the last time we checked. */
290 #ifdef MULTI_KBOARD /* Note that MULTI_KBOARD implies MULTI_FRAME */
291 #define FRAME_KBOARD(f) ((f)->kboard)
293 #define FRAME_KBOARD(f) (&the_only_kboard)
298 typedef struct frame
*FRAME_PTR
;
300 #define XFRAME(p) ((struct frame *) XPNTR (p))
301 #define XSETFRAME(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_FRAME))
303 #define WINDOW_FRAME(w) (w)->frame
305 #define FRAME_X_P(f) ((f)->output_method == output_x_window)
306 #define FRAME_WIN32_P(f) ((f)->output_method == output_win32)
308 /* FRAME_WINDOW_P tests whether the frame is a window, and is
309 defined to be the predicate for the window system being used. */
310 #ifdef HAVE_X_WINDOWS
311 #define FRAME_WINDOW_P(f) FRAME_X_P (f)
314 #define FRAME_WINDOW_P(f) FRAME_WIN32_P (f)
316 #ifndef FRAME_WINDOW_P
317 #define FRAME_WINDOW_P(f) (0)
320 #define FRAME_LIVE_P(f) ((f)->output_data.nothing != 0)
321 #define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap)
322 #define FRAME_MINIBUF_ONLY_P(f) \
323 EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f))
324 #define FRAME_HAS_MINIBUF_P(f) ((f)->has_minibuffer)
325 #define FRAME_CURRENT_GLYPHS(f) (f)->current_glyphs
326 #define FRAME_DESIRED_GLYPHS(f) (f)->desired_glyphs
327 #define FRAME_TEMP_GLYPHS(f) (f)->temp_glyphs
328 #define FRAME_HEIGHT(f) (f)->height
329 #define FRAME_WIDTH(f) (f)->width
330 #define FRAME_NEW_HEIGHT(f) (f)->new_height
331 #define FRAME_NEW_WIDTH(f) (f)->new_width
332 #define FRAME_MENU_BAR_LINES(f) (f)->menu_bar_lines
333 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
334 #define FRAME_EXTERNAL_MENU_BAR(f) (f)->external_menu_bar
336 #define FRAME_EXTERNAL_MENU_BAR(f) 0
338 #define FRAME_CURSOR_X(f) (f)->cursor_x
339 #define FRAME_CURSOR_Y(f) (f)->cursor_y
340 #define FRAME_VISIBLE_P(f) ((f)->visible != 0)
341 #define FRAME_SET_VISIBLE(f,p) \
342 ((f)->async_visible = (p), FRAME_SAMPLE_VISIBILITY (f))
343 #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1, f->garbaged = 1)
344 #define FRAME_GARBAGED_P(f) (f)->garbaged
345 #define FRAME_NO_SPLIT_P(f) (f)->no_split
346 #define FRAME_WANTS_MODELINE_P(f) (f)->wants_modeline
347 #define FRAME_ICONIFIED_P(f) (f)->iconified
348 #define FRAME_WINDOW_SIZES_CHANGED(f) (f)->window_sizes_changed
349 #define FRAME_MINIBUF_WINDOW(f) (f)->minibuffer_window
350 #define FRAME_ROOT_WINDOW(f) (f)->root_window
351 #define FRAME_SELECTED_WINDOW(f) (f)->selected_window
352 #define SET_GLYPHS_FRAME(glyphs,frame) ((glyphs)->frame = (frame))
353 #define FRAME_INSERT_COST(f) (f)->insert_line_cost
354 #define FRAME_DELETE_COST(f) (f)->delete_line_cost
355 #define FRAME_INSERTN_COST(f) (f)->insert_n_lines_cost
356 #define FRAME_DELETEN_COST(f) (f)->delete_n_lines_cost
357 #define FRAME_MESSAGE_BUF(f) (f)->message_buf
358 #define FRAME_SCROLL_BOTTOM_VPOS(f) (f)->scroll_bottom_vpos
359 #define FRAME_FOCUS_FRAME(f) (f)->focus_frame
360 #define FRAME_CAN_HAVE_SCROLL_BARS(f) ((f)->can_have_scroll_bars)
361 #define FRAME_HAS_VERTICAL_SCROLL_BARS(f) ((f)->has_vertical_scroll_bars)
362 #define FRAME_SCROLL_BAR_PIXEL_WIDTH(f) ((f)->scroll_bar_pixel_width)
363 #define FRAME_SCROLL_BAR_COLS(f) ((f)->scroll_bar_cols)
364 #define FRAME_SCROLL_BARS(f) ((f)->scroll_bars)
365 #define FRAME_CONDEMNED_SCROLL_BARS(f) ((f)->condemned_scroll_bars)
366 #define FRAME_MENU_BAR_ITEMS(f) ((f)->menu_bar_items)
367 #define FRAME_COST_BAUD_RATE(f) ((f)->cost_calculation_baud_rate)
369 /* Emacs's redisplay code could become confused if a frame's
370 visibility changes at arbitrary times. For example, if a frame is
371 visible while the desired glyphs are being built, but becomes
372 invisible before they are updated, then some rows of the
373 desired_glyphs will be left marked as enabled after redisplay is
374 complete, which should never happen. The next time the frame
375 becomes visible, redisplay will probably barf.
377 Currently, there are no similar situations involving iconified, but
378 the principle is the same.
380 So instead of having asynchronous input handlers directly set and
381 clear the frame's visibility and iconification flags, they just set
382 the async_visible and async_iconified flags; the redisplay code
383 calls the FRAME_SAMPLE_VISIBILITY macro before doing any redisplay,
384 which sets visible and iconified from their asynchronous
387 Synchronous code must use the FRAME_SET_VISIBLE macro.
389 Also, if a frame used to be invisible, but has just become visible,
390 it must be marked as garbaged, since redisplay hasn't been keeping
392 #define FRAME_SAMPLE_VISIBILITY(f) \
393 (((f)->async_visible && ! (f)->visible) ? SET_FRAME_GARBAGED (f) : 0, \
394 (f)->visible = (f)->async_visible, \
395 (f)->iconified = (f)->async_iconified)
397 #define CHECK_FRAME(x, i) \
400 x = wrong_type_argument (Qframep, (x)); \
403 #define CHECK_LIVE_FRAME(x, i) \
406 || ! FRAME_LIVE_P (XFRAME (x))) \
407 x = wrong_type_argument (Qframe_live_p, (x)); \
410 /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
411 `for' loop which iterates over the elements of Vframe_list. The
412 loop will set FRAME_VAR, a Lisp_Object, to each frame in
413 Vframe_list in succession and execute the statement. LIST_VAR
414 should be a Lisp_Object too; it is used to iterate through the
417 If MULTI_FRAME isn't defined, then this loop expands to something which
418 executes the statement once. */
419 #define FOR_EACH_FRAME(list_var, frame_var) \
420 for ((list_var) = Vframe_list; \
422 && (frame_var = XCONS (list_var)->car, 1)); \
423 list_var = XCONS (list_var)->cdr)
426 extern Lisp_Object Qframep
, Qframe_live_p
, Qicon
;
428 extern struct frame
*selected_frame
;
429 extern struct frame
*last_nonminibuf_frame
;
431 extern struct frame
*make_terminal_frame ();
432 extern struct frame
*make_frame ();
433 extern struct frame
*make_minibuffer_frame ();
434 extern struct frame
*make_frame_without_minibuffer ();
436 extern Lisp_Object Vframe_list
;
437 extern Lisp_Object Vdefault_frame_alist
;
439 extern Lisp_Object Vterminal_frame
;
441 #else /* not MULTI_FRAME */
443 /* These definitions are used in a single-frame version of Emacs. */
445 /* A frame we use to store all the data concerning the screen when we
446 don't have multiple frames. Remember, if you store any data in it
447 which needs to be protected from GC, you should staticpro that
448 element explicitly. */
449 extern struct frame the_only_frame
;
451 typedef struct frame
*FRAME_PTR
;
453 /* A function call for always getting 0 is overkill, so... */
454 #define WINDOW_FRAME(w) ({ Lisp_Object tem; XSETFASTINT (tem, 0); tem; })
456 #define WINDOW_FRAME(w) (Fselected_frame ())
458 #define XSETFRAME(p, v) (p = WINDOW_FRAME (***bogus***))
459 #define XFRAME(frame) (&the_only_frame)
461 extern FRAME_PTR selected_frame
;
462 extern FRAME_PTR last_nonminibuf_frame
;
464 #define FRAME_LIVE_P(f) 1
466 /* The following definitions could also be used in the non-MSDOS case,
467 but the constants below lead to better code. */
468 #define FRAME_TERMCAP_P(f) (the_only_frame.output_method == output_termcap)
469 #define FRAME_X_P(f) (the_only_frame.output_method != output_termcap)
471 #define FRAME_TERMCAP_P(f) 1
472 #define FRAME_X_P(f) 0
474 #define FRAME_WINDOW_P(f) FRAME_X_P (f)
475 #define FRAME_MINIBUF_ONLY_P(f) 0
476 #define FRAME_HAS_MINIBUF_P(f) 1
477 #define FRAME_CURRENT_GLYPHS(f) (the_only_frame.current_glyphs)
478 #define FRAME_DESIRED_GLYPHS(f) (the_only_frame.desired_glyphs)
479 #define FRAME_TEMP_GLYPHS(f) (the_only_frame.temp_glyphs)
480 #define FRAME_HEIGHT(f) (the_only_frame.height)
481 #define FRAME_WIDTH(f) (the_only_frame.width)
482 #define FRAME_NEW_HEIGHT(f) (the_only_frame.new_height)
483 #define FRAME_NEW_WIDTH(f) (the_only_frame.new_width)
484 #define FRAME_MENU_BAR_LINES(f) (the_only_frame.menu_bar_lines)
485 #define FRAME_CURSOR_X(f) (the_only_frame.cursor_x)
486 #define FRAME_CURSOR_Y(f) (the_only_frame.cursor_y)
487 #define FRAME_SET_VISIBLE(f,p) (p)
488 #define FRAME_VISIBLE_P(f) 1
489 #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1)
490 #define FRAME_GARBAGED_P(f) (frame_garbaged)
491 #define FRAME_NO_SPLIT_P(f) 0
492 #define FRAME_WANTS_MODELINE_P(f) 1
493 #define FRAME_ICONIFIED_P(f) 0
494 #define FRAME_WINDOW_SIZES_CHANGED(f) the_only_frame.window_sizes_changed
495 #define FRAME_MINIBUF_WINDOW(f) (minibuf_window)
496 #define FRAME_ROOT_WINDOW(f) (the_only_frame.root_window)
497 #define FRAME_SELECTED_WINDOW(f) (selected_window)
498 #define SET_GLYPHS_FRAME(glyphs,frame) do ; while (0)
499 #define FRAME_INSERT_COST(frame) (the_only_frame.insert_line_cost)
500 #define FRAME_DELETE_COST(frame) (the_only_frame.delete_line_cost)
501 #define FRAME_INSERTN_COST(frame) (the_only_frame.insert_n_lines_cost)
502 #define FRAME_DELETEN_COST(frame) (the_only_frame.delete_n_lines_cost)
503 #define FRAME_MESSAGE_BUF(f) (the_only_frame.message_buf)
504 #define FRAME_SCROLL_BOTTOM_VPOS(f) (the_only_frame.scroll_bottom_vpos)
505 #define FRAME_FOCUS_FRAME(f) (Qnil)
506 #define FRAME_CAN_HAVE_SCROLL_BARS(f) (the_only_frame.can_have_scroll_bars)
507 #define FRAME_HAS_VERTICAL_SCROLL_BARS(f) \
508 (the_only_frame.has_vertical_scroll_bars)
509 #define FRAME_SCROLL_BAR_PIXEL_WIDTH(f) (the_only_frame.scroll_bar_pixel_width)
510 #define FRAME_SCROLL_BAR_COLS(f) (the_only_frame.scroll_bar_cols)
511 #define FRAME_SCROLL_BARS(f) (the_only_frame.scroll_bars)
512 #define FRAME_CONDEMNED_SCROLL_BARS(f) (the_only_frame.condemned_scroll_bars)
513 #define FRAME_MENU_BAR_ITEMS(f) (the_only_frame.menu_bar_items)
514 #define FRAME_COST_BAUD_RATE(f) (the_only_frame.cost_calculation_baud_rate)
516 /* See comments in definition above. */
517 #define FRAME_SAMPLE_VISIBILITY(f) (0)
519 #define CHECK_FRAME(x, i) do; while (0)
520 #define CHECK_LIVE_FRAME(x, y) do; while (0)
522 /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
523 `for' loop which iterates over the elements of Vframe_list. The
524 loop will set FRAME_VAR, a Lisp_Object, to each frame in
525 Vframe_list in succession and execute the statement. LIST_VAR
526 should be a Lisp_Object too; it is used to iterate through the
529 If MULTI_FRAME _is_ defined, then this loop expands to a real
530 `for' loop which traverses Vframe_list using LIST_VAR and
532 #define FOR_EACH_FRAME(list_var, frame_var) \
533 for (list_var = Qt; frame_var = WINDOW_FRAME (***bogus***), ! NILP (list_var); list_var = Qnil)
535 #endif /* not MULTI_FRAME */
538 /* Device- and MULTI_FRAME-independent scroll bar stuff. */
540 /* Return the starting column (zero-based) of the vertical scroll bar
541 for window W. The column before this one is the last column we can
542 use for text. If the window touches the right edge of the frame,
543 we have extra space allocated for it. Otherwise, the scroll bar
544 takes over the window's rightmost columns. */
545 #define WINDOW_VERTICAL_SCROLL_BAR_COLUMN(w) \
546 (((XINT ((w)->left) + XINT ((w)->width)) \
547 < FRAME_WIDTH (XFRAME (WINDOW_FRAME (w)))) \
548 ? (XINT ((w)->left) + XINT ((w)->width) \
549 - FRAME_SCROLL_BAR_COLS (XFRAME (WINDOW_FRAME (w)))) \
550 : FRAME_WIDTH (XFRAME (WINDOW_FRAME (w))))
552 /* Return the height in lines of the vertical scroll bar in w. If the
553 window has a mode line, don't make the scroll bar extend that far. */
554 #define WINDOW_VERTICAL_SCROLL_BAR_HEIGHT(w) (window_internal_height (w))