(struct frame): New member kboard.
[bpt/emacs.git] / src / frame.h
1 /* Define frame-object for GNU Emacs.
2 Copyright (C) 1993, 1994 Free Software Foundation, Inc.
3
4 This file is part of GNU Emacs.
5
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
9 any later version.
10
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
19
20 \f
21 /* Miscellanea. */
22
23 /* Nonzero means don't assume anything about current
24 contents of actual terminal frame */
25 extern int frame_garbaged;
26
27 /* Nonzero means FRAME_MESSAGE_BUF (selected_frame) is being used by
28 print. */
29 extern int message_buf_print;
30
31 \f
32 /* The structure representing a frame.
33
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. */
38
39 enum output_method
40 { output_termcap, output_x_window, output_msdos_raw };
41
42 struct frame
43 {
44 EMACS_INT size;
45 struct Lisp_Vector *next;
46
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. */
50
51 /* Name of this frame: a Lisp string. See also `explicit_name'. */
52 Lisp_Object name;
53
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.
59
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;
66
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;
71
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;
77
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;
83
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;
88
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;
98
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;
103
104 /* Alist of elements (FACE-NAME . FACE-VECTOR-DATA). */
105 Lisp_Object face_alist;
106
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;
113
114 /* Predicate for selecting buffers for other-buffer. */
115 Lisp_Object buffer_predicate;
116
117 /* Beyond here, there should be no more Lisp_Object components. */
118
119
120 /* glyphs as they appear on the frame */
121 struct frame_glyphs *current_glyphs;
122
123 /* glyphs we'd like to appear on the frame */
124 struct frame_glyphs *desired_glyphs;
125
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;
135
136 /* glyphs for the mode line */
137 struct frame_glyphs *temp_glyphs;
138
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;
144
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;
152
153 /* Size of this frame, in units of characters. */
154 EMACS_INT height;
155 EMACS_INT width;
156
157 /* New height and width for pending size change. 0 if no change pending. */
158 int new_height, new_width;
159
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;
163
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;
168
169 #ifdef MULTI_KBOARD
170 /* A pointer to the kboard structure associated with this frame.
171 For termcap frames, this points to initial_kboard. For X frames,
172 it will be the same as display.x->display_info->kboard. */
173 KBOARD *kboard;
174 #endif
175
176 /* Number of lines of menu bar. */
177 int menu_bar_lines;
178
179 #ifdef USE_X_TOOLKIT
180 /* Nonzero means using a menu bar that comes from the X toolkit. */
181 int external_menu_bar;
182 #endif
183
184 /* Nonzero if last attempt at redisplay on this frame was preempted. */
185 char display_preempted;
186
187 /* visible is nonzero if the frame is currently displayed; we check
188 it to see if we should bother updating the frame's contents.
189 DON'T SET IT DIRECTLY; instead, use FRAME_SET_VISIBLE.
190
191 Note that, since invisible frames aren't updated, whenever a
192 frame becomes visible again, it must be marked as garbaged. The
193 FRAME_SAMPLE_VISIBILITY macro takes care of this.
194
195 iconified is nonzero if the frame is currently iconified.
196
197 Asynchronous input handlers should NOT change these directly;
198 instead, they should change async_visible or async_iconified, and
199 let the FRAME_SAMPLE_VISIBILITY macro set visible and iconified
200 at the next redisplay.
201
202 These should probably be considered read-only by everyone except
203 FRAME_SAMPLE_VISIBILITY.
204
205 These two are mutually exclusive. They might both be zero, if the
206 frame has been made invisible without an icon. */
207 char visible, iconified;
208
209 /* Asynchronous input handlers change these, and
210 FRAME_SAMPLE_VISIBILITY copies them into visible and iconified.
211 See FRAME_SAMPLE_VISIBILITY, below. */
212 #ifdef __STDC__
213 volatile
214 #endif
215 char async_visible, async_iconified;
216
217 /* Nonzero if this frame should be redrawn. */
218 #ifdef __STDC__
219 volatile
220 #endif
221 char garbaged;
222
223 /* True if frame actually has a minibuffer window on it.
224 0 if using a minibuffer window that isn't on this frame. */
225 char has_minibuffer;
226
227 /* 0 means, if this frame has just one window,
228 show no modeline for that window. */
229 char wants_modeline;
230
231 /* Non-zero if the hardware device this frame is displaying on can
232 support scroll bars. */
233 char can_have_scroll_bars;
234
235 /* If can_have_scroll_bars is non-zero, this is non-zero if we should
236 actually display them on this frame. */
237 char has_vertical_scroll_bars;
238
239 /* Non-0 means raise this frame to the top of the heap when selected. */
240 char auto_raise;
241
242 /* Non-0 means lower this frame to the bottom of the stack when left. */
243 char auto_lower;
244
245 /* True if frame's root window can't be split. */
246 char no_split;
247
248 /* If this is set, then Emacs won't change the frame name to indicate
249 the current buffer, etcetera. If the user explicitly sets the frame
250 name, this gets set. If the user sets the name to Qnil, this is
251 cleared. */
252 char explicit_name;
253
254 /* Nonzero if size of some window on this frame has changed. */
255 char window_sizes_changed;
256
257 /* Storage for messages to this frame. */
258 char *message_buf;
259
260 /* Nonnegative if current redisplay should not do scroll computation
261 for lines beyond a certain vpos. This is the vpos. */
262 int scroll_bottom_vpos;
263
264 /* Width of the scroll bar, in pixels and in characters.
265 scroll_bar_cols tracks scroll_bar_pixel_width if the latter is positive;
266 a zero value in scroll_bar_pixel_width means to compute the actual width
267 on the fly, using scroll_bar_cols and the current font width. */
268 int scroll_bar_pixel_width;
269 int scroll_bar_cols;
270
271 /* The baud rate that was used to calculate costs for this frame. */
272 int cost_calculation_baud_rate;
273 };
274
275 #ifdef MULTI_KBOARD /* Note that MULTI_KBOARD implies MULTI_FRAME */
276 #define FRAME_KBOARD(f) ((f)->kboard)
277 #else
278 #define FRAME_KBOARD(f) (&the_only_kboard)
279 #endif
280
281 #ifdef MULTI_FRAME
282
283 typedef struct frame *FRAME_PTR;
284
285 #define XFRAME(p) ((struct frame *) XPNTR (p))
286 #define XSETFRAME(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_FRAME))
287
288 #define WINDOW_FRAME(w) (w)->frame
289
290 #define FRAME_LIVE_P(f) ((f)->display.nothing != 0)
291 #define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap)
292 #define FRAME_X_P(f) ((f)->output_method == output_x_window)
293 #define FRAME_MINIBUF_ONLY_P(f) \
294 EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f))
295 #define FRAME_HAS_MINIBUF_P(f) ((f)->has_minibuffer)
296 #define FRAME_CURRENT_GLYPHS(f) (f)->current_glyphs
297 #define FRAME_DESIRED_GLYPHS(f) (f)->desired_glyphs
298 #define FRAME_TEMP_GLYPHS(f) (f)->temp_glyphs
299 #define FRAME_HEIGHT(f) (f)->height
300 #define FRAME_WIDTH(f) (f)->width
301 #define FRAME_NEW_HEIGHT(f) (f)->new_height
302 #define FRAME_NEW_WIDTH(f) (f)->new_width
303 #define FRAME_MENU_BAR_LINES(f) (f)->menu_bar_lines
304 #ifdef USE_X_TOOLKIT
305 #define FRAME_EXTERNAL_MENU_BAR(f) (f)->external_menu_bar
306 #else
307 #define FRAME_EXTERNAL_MENU_BAR(f) 0
308 #endif
309 #define FRAME_CURSOR_X(f) (f)->cursor_x
310 #define FRAME_CURSOR_Y(f) (f)->cursor_y
311 #define FRAME_VISIBLE_P(f) ((f)->visible != 0)
312 #define FRAME_SET_VISIBLE(f,p) \
313 ((f)->async_visible = (p), FRAME_SAMPLE_VISIBILITY (f))
314 #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1, f->garbaged = 1)
315 #define FRAME_GARBAGED_P(f) (f)->garbaged
316 #define FRAME_NO_SPLIT_P(f) (f)->no_split
317 #define FRAME_WANTS_MODELINE_P(f) (f)->wants_modeline
318 #define FRAME_ICONIFIED_P(f) (f)->iconified
319 #define FRAME_WINDOW_SIZES_CHANGED(f) (f)->window_sizes_changed
320 #define FRAME_MINIBUF_WINDOW(f) (f)->minibuffer_window
321 #define FRAME_ROOT_WINDOW(f) (f)->root_window
322 #define FRAME_SELECTED_WINDOW(f) (f)->selected_window
323 #define SET_GLYPHS_FRAME(glyphs,frame) ((glyphs)->frame = (frame))
324 #define FRAME_INSERT_COST(f) (f)->insert_line_cost
325 #define FRAME_DELETE_COST(f) (f)->delete_line_cost
326 #define FRAME_INSERTN_COST(f) (f)->insert_n_lines_cost
327 #define FRAME_DELETEN_COST(f) (f)->delete_n_lines_cost
328 #define FRAME_MESSAGE_BUF(f) (f)->message_buf
329 #define FRAME_SCROLL_BOTTOM_VPOS(f) (f)->scroll_bottom_vpos
330 #define FRAME_FOCUS_FRAME(f) (f)->focus_frame
331 #define FRAME_CAN_HAVE_SCROLL_BARS(f) ((f)->can_have_scroll_bars)
332 #define FRAME_HAS_VERTICAL_SCROLL_BARS(f) ((f)->has_vertical_scroll_bars)
333 #define FRAME_SCROLL_BAR_PIXEL_WIDTH(f) ((f)->scroll_bar_pixel_width)
334 #define FRAME_SCROLL_BAR_COLS(f) ((f)->scroll_bar_cols)
335 #define FRAME_SCROLL_BARS(f) ((f)->scroll_bars)
336 #define FRAME_CONDEMNED_SCROLL_BARS(f) ((f)->condemned_scroll_bars)
337 #define FRAME_MENU_BAR_ITEMS(f) ((f)->menu_bar_items)
338 #define FRAME_COST_BAUD_RATE(f) ((f)->cost_calculation_baud_rate)
339
340 /* Emacs's redisplay code could become confused if a frame's
341 visibility changes at arbitrary times. For example, if a frame is
342 visible while the desired glyphs are being built, but becomes
343 invisible before they are updated, then some rows of the
344 desired_glyphs will be left marked as enabled after redisplay is
345 complete, which should never happen. The next time the frame
346 becomes visible, redisplay will probably barf.
347
348 Currently, there are no similar situations involving iconified, but
349 the principle is the same.
350
351 So instead of having asynchronous input handlers directly set and
352 clear the frame's visibility and iconification flags, they just set
353 the async_visible and async_iconified flags; the redisplay code
354 calls the FRAME_SAMPLE_VISIBILITY macro before doing any redisplay,
355 which sets visible and iconified from their asynchronous
356 counterparts.
357
358 Synchronous code must use the FRAME_SET_VISIBLE macro.
359
360 Also, if a frame used to be invisible, but has just become visible,
361 it must be marked as garbaged, since redisplay hasn't been keeping
362 up its contents. */
363 #define FRAME_SAMPLE_VISIBILITY(f) \
364 (((f)->async_visible && ! (f)->visible) ? SET_FRAME_GARBAGED (f) : 0, \
365 (f)->visible = (f)->async_visible, \
366 (f)->iconified = (f)->async_iconified)
367
368 #define CHECK_FRAME(x, i) \
369 { \
370 if (! FRAMEP (x)) \
371 x = wrong_type_argument (Qframep, (x)); \
372 }
373
374 #define CHECK_LIVE_FRAME(x, i) \
375 { \
376 if (! FRAMEP (x) \
377 || ! FRAME_LIVE_P (XFRAME (x))) \
378 x = wrong_type_argument (Qframe_live_p, (x)); \
379 }
380
381 /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
382 `for' loop which iterates over the elements of Vframe_list. The
383 loop will set FRAME_VAR, a Lisp_Object, to each frame in
384 Vframe_list in succession and execute the statement. LIST_VAR
385 should be a Lisp_Object too; it is used to iterate through the
386 Vframe_list.
387
388 If MULTI_FRAME isn't defined, then this loop expands to something which
389 executes the statement once. */
390 #define FOR_EACH_FRAME(list_var, frame_var) \
391 for ((list_var) = Vframe_list; \
392 (CONSP (list_var) \
393 && (frame_var = XCONS (list_var)->car, 1)); \
394 list_var = XCONS (list_var)->cdr)
395
396
397 extern Lisp_Object Qframep, Qframe_live_p, Qicon;
398
399 extern struct frame *selected_frame;
400 extern struct frame *last_nonminibuf_frame;
401
402 extern struct frame *make_terminal_frame ();
403 extern struct frame *make_frame ();
404 extern struct frame *make_minibuffer_frame ();
405 extern struct frame *make_frame_without_minibuffer ();
406
407 extern Lisp_Object Vframe_list;
408 extern Lisp_Object Vdefault_frame_alist;
409
410 extern Lisp_Object Vterminal_frame;
411 \f
412 #else /* not MULTI_FRAME */
413
414 /* These definitions are used in a single-frame version of Emacs. */
415
416 /* A frame we use to store all the data concerning the screen when we
417 don't have multiple frames. Remember, if you store any data in it
418 which needs to be protected from GC, you should staticpro that
419 element explicitly. */
420 extern struct frame the_only_frame;
421
422 typedef struct frame *FRAME_PTR;
423 #ifdef __GNUC__
424 /* A function call for always getting 0 is overkill, so... */
425 #define WINDOW_FRAME(w) ({ Lisp_Object tem; XSETFASTINT (tem, 0); tem; })
426 #else
427 #define WINDOW_FRAME(w) (Fselected_frame ())
428 #endif
429 #define XSETFRAME(p, v) (p = WINDOW_FRAME (***bogus***))
430 #define XFRAME(frame) (&the_only_frame)
431
432 extern FRAME_PTR selected_frame;
433 extern FRAME_PTR last_nonminibuf_frame;
434
435 #define FRAME_LIVE_P(f) 1
436 #ifdef MSDOS
437 /* The following definitions could also be used in the non-MSDOS case,
438 but the constants below lead to better code. */
439 #define FRAME_TERMCAP_P(f) (the_only_frame.output_method == output_termcap)
440 #define FRAME_X_P(f) (the_only_frame.output_method != output_termcap)
441 #else
442 #define FRAME_TERMCAP_P(f) 1
443 #define FRAME_X_P(f) 0
444 #endif
445 #define FRAME_MINIBUF_ONLY_P(f) 0
446 #define FRAME_HAS_MINIBUF_P(f) 1
447 #define FRAME_CURRENT_GLYPHS(f) (the_only_frame.current_glyphs)
448 #define FRAME_DESIRED_GLYPHS(f) (the_only_frame.desired_glyphs)
449 #define FRAME_TEMP_GLYPHS(f) (the_only_frame.temp_glyphs)
450 #define FRAME_HEIGHT(f) (the_only_frame.height)
451 #define FRAME_WIDTH(f) (the_only_frame.width)
452 #define FRAME_NEW_HEIGHT(f) (the_only_frame.new_height)
453 #define FRAME_NEW_WIDTH(f) (the_only_frame.new_width)
454 #define FRAME_MENU_BAR_LINES(f) (the_only_frame.menu_bar_lines)
455 #define FRAME_CURSOR_X(f) (the_only_frame.cursor_x)
456 #define FRAME_CURSOR_Y(f) (the_only_frame.cursor_y)
457 #define FRAME_SET_VISIBLE(f,p) (p)
458 #define FRAME_VISIBLE_P(f) 1
459 #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1)
460 #define FRAME_GARBAGED_P(f) (frame_garbaged)
461 #define FRAME_NO_SPLIT_P(f) 0
462 #define FRAME_WANTS_MODELINE_P(f) 1
463 #define FRAME_ICONIFIED_P(f) 0
464 #define FRAME_WINDOW_SIZES_CHANGED(f) the_only_frame.window_sizes_changed
465 #define FRAME_MINIBUF_WINDOW(f) (minibuf_window)
466 #define FRAME_ROOT_WINDOW(f) (the_only_frame.root_window)
467 #define FRAME_SELECTED_WINDOW(f) (selected_window)
468 #define SET_GLYPHS_FRAME(glyphs,frame) do ; while (0)
469 #define FRAME_INSERT_COST(frame) (the_only_frame.insert_line_cost)
470 #define FRAME_DELETE_COST(frame) (the_only_frame.delete_line_cost)
471 #define FRAME_INSERTN_COST(frame) (the_only_frame.insert_n_lines_cost)
472 #define FRAME_DELETEN_COST(frame) (the_only_frame.delete_n_lines_cost)
473 #define FRAME_MESSAGE_BUF(f) (the_only_frame.message_buf)
474 #define FRAME_SCROLL_BOTTOM_VPOS(f) (the_only_frame.scroll_bottom_vpos)
475 #define FRAME_FOCUS_FRAME(f) (Qnil)
476 #define FRAME_CAN_HAVE_SCROLL_BARS(f) (the_only_frame.can_have_scroll_bars)
477 #define FRAME_HAS_VERTICAL_SCROLL_BARS(f) \
478 (the_only_frame.has_vertical_scroll_bars)
479 #define FRAME_SCROLL_BAR_PIXEL_WIDTH(f) (the_only_frame.scroll_bar_pixel_width)
480 #define FRAME_SCROLL_BAR_COLS(f) (the_only_frame.scroll_bar_cols)
481 #define FRAME_SCROLL_BARS(f) (the_only_frame.scroll_bars)
482 #define FRAME_CONDEMNED_SCROLL_BARS(f) (the_only_frame.condemned_scroll_bars)
483 #define FRAME_MENU_BAR_ITEMS(f) (the_only_frame.menu_bar_items)
484 #define FRAME_COST_BAUD_RATE(f) (the_only_frame.cost_calculation_baud_rate)
485
486 /* See comments in definition above. */
487 #define FRAME_SAMPLE_VISIBILITY(f) (0)
488
489 #define CHECK_FRAME(x, i) do; while (0)
490 #define CHECK_LIVE_FRAME(x, y) do; while (0)
491
492 /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
493 `for' loop which iterates over the elements of Vframe_list. The
494 loop will set FRAME_VAR, a Lisp_Object, to each frame in
495 Vframe_list in succession and execute the statement. LIST_VAR
496 should be a Lisp_Object too; it is used to iterate through the
497 Vframe_list.
498
499 If MULTI_FRAME _is_ defined, then this loop expands to a real
500 `for' loop which traverses Vframe_list using LIST_VAR and
501 FRAME_VAR. */
502 #define FOR_EACH_FRAME(list_var, frame_var) \
503 for (list_var = Qt; frame_var = WINDOW_FRAME (***bogus***), ! NILP (list_var); list_var = Qnil)
504
505 #endif /* not MULTI_FRAME */
506
507 \f
508 /* Device- and MULTI_FRAME-independent scroll bar stuff. */
509
510 /* Return the starting column (zero-based) of the vertical scroll bar
511 for window W. The column before this one is the last column we can
512 use for text. If the window touches the right edge of the frame,
513 we have extra space allocated for it. Otherwise, the scroll bar
514 takes over the window's rightmost columns. */
515 #define WINDOW_VERTICAL_SCROLL_BAR_COLUMN(w) \
516 (((XINT ((w)->left) + XINT ((w)->width)) \
517 < FRAME_WIDTH (XFRAME (WINDOW_FRAME (w)))) \
518 ? (XINT ((w)->left) + XINT ((w)->width) \
519 - FRAME_SCROLL_BAR_COLS (XFRAME (WINDOW_FRAME (w)))) \
520 : FRAME_WIDTH (XFRAME (WINDOW_FRAME (w))))
521
522 /* Return the height in lines of the vertical scroll bar in w. If the
523 window has a mode line, don't make the scroll bar extend that far. */
524 #define WINDOW_VERTICAL_SCROLL_BAR_HEIGHT(w) (window_internal_height (w))