1 /* Define frame-object for XEmacs.
2 Copyright (C) 1988, 1992, 1993, 1994 Free Software Foundation, Inc.
4 This file is part of XEmacs.
6 XEmacs is free software; you can redistribute it and/or modify it
7 under the terms of the GNU General Public License as published by the
8 Free Software Foundation; either version 2, or (at your option) any
11 XEmacs is distributed in the hope that it will be useful, but WITHOUT
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 You should have received a copy of the GNU General Public License
17 along with XEmacs; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
21 /* Synched up with: FSF 19.30. */
23 #ifndef _XEMACS_FRAME_H_
24 #define _XEMACS_FRAME_H_
26 #ifdef HAVE_SCROLLBARS
27 #include "scrollbar.h"
36 #include "redisplay.h"
38 #define FRAME_TYPE_NAME(f) ((f)->framemeths->name)
39 #define FRAME_TYPE(f) ((f)->framemeths->symbol)
41 /******** Accessing / calling a frame method *********/
43 #define HAS_FRAMEMETH_P(f, m) HAS_CONTYPE_METH_P ((f)->framemeths, m)
44 #define FRAMEMETH(f, m, args) CONTYPE_METH ((f)->framemeths, m, args)
45 #define MAYBE_FRAMEMETH(f, m, args) \
46 MAYBE_CONTYPE_METH ((f)->framemeths, m, args)
47 #define FRAMEMETH_OR_GIVEN(f, m, args, given) \
48 CONTYPE_METH_OR_GIVEN((f)->framemeths, m, args, given)
52 struct lcrecord_header header;
54 /* Methods for this frame's console. This can also be retrieved
55 through frame->device->console, but it's faster this way. */
56 struct console_methods *framemeths;
58 /* Size of text only area of this frame, excluding scrollbars,
59 toolbars and end of line glyphs. The size can be in characters
60 or pixels, depending on units in which window system resizes
64 /* New height and width for pending size change, in the same units
65 as above. 0 if no change pending. */
66 int new_height, new_width;
68 /* Size of text-only are of the frame, in default font characters.
69 This may be inaccurate due to rounding error */
70 int char_height, char_width;
72 /* Size of the whole frame, including scrollbars, toolbars and end
73 of line glyphs, in pixels */
74 int pixheight, pixwidth;
77 /* The count of frame number. This applies to TTY frames only. */
81 /* Width of the internal border. This is a line of background color
82 just inside the window's border. It is normally only non-zero on
83 X frames, but we put it here to avoid introducing window system
85 int internal_border_width;
87 /* This frame's root window mirror. This structure exactly mirrors
88 the frame's window structure but contains only pointers to the
89 display structures. */
90 struct window_mirror *root_mirror;
94 /* subwindow cache elements for this frame */
95 subwindow_cachel_dynarr *subwindow_cachels;
97 #ifdef HAVE_SCROLLBARS
98 /* frame-local scrollbar information. See scrollbar.c. */
99 int scrollbar_y_offset;
101 /* cache of created scrollbars */
102 struct scrollbar_instance *sb_vcache;
103 struct scrollbar_instance *sb_hcache;
107 /* Size of toolbars as seen by redisplay. This is used to determine
108 whether to re-layout windows by a call to change_frame_size early
109 in redisplay_frame. */
110 unsigned int current_toolbar_size[4];
113 /* Dynamic array of display lines for gutters */
114 display_line_dynarr *current_display_lines;
115 display_line_dynarr *desired_display_lines;
117 /* A structure of auxiliary data specific to the device type.
118 struct x_frame is used for X window frames; defined in console-x.h */
121 #define FRAME_SLOT_DECLARATION
122 #define MARKED_SLOT(x) Lisp_Object x
123 #include "frameslots.h"
125 /* Nonzero if frame is currently displayed.
126 Mutually exclusive with iconified
127 JV: This now a tristate flag:
128 Value : Emacs meaning :f-v-p : X meaning
129 0 : not displayed : nil : unmapped
130 >0 : user can access it,needs repainting : t : mapped and visible
131 <0 : user can access it,needs no repainting : hidden :mapped and invisible
132 where f-v-p is the return value of frame-visible-p */
137 /* Are we finished initializing? */
138 unsigned int init_finished :1;
140 /* Is frame marked for deletion? This is used in XSetErrorHandler(). */
141 unsigned int being_deleted :1;
143 /* Nonzero if this frame has been destroyed. */
144 unsigned int dead :1;
146 /* Nonzero if last attempt at redisplay on this frame was preempted. */
147 unsigned int display_preempted :1;
149 /* Nonzero if window is currently iconified.
150 This and visible are mutually exclusive. */
151 unsigned int iconified :1;
153 /* Nonzero if this frame should be cleared and then redrawn.
154 Setting this will also effectively set frame_changed. */
155 unsigned int clear :1;
157 /* True if frame actually has a minibuffer window on it.
158 0 if using a minibuffer window that isn't on this frame. */
159 unsigned int has_minibuffer :1;
161 /* True if frame's root window can't be split. */
162 unsigned int no_split :1;
164 unsigned int top_toolbar_was_visible :1;
165 unsigned int bottom_toolbar_was_visible :1;
166 unsigned int left_toolbar_was_visible :1;
167 unsigned int right_toolbar_was_visible :1;
168 /* gutter visibility */
169 unsigned int top_gutter_was_visible :1;
170 unsigned int bottom_gutter_was_visible :1;
171 unsigned int left_gutter_was_visible :1;
172 unsigned int right_gutter_was_visible :1;
174 /* redisplay flags */
175 unsigned int buffers_changed :1;
176 unsigned int clip_changed :1;
177 unsigned int extents_changed :1;
178 unsigned int faces_changed :1;
179 unsigned int frame_changed :1;
180 unsigned int subwindows_changed :1;
181 unsigned int glyphs_changed :1;
182 unsigned int icon_changed :1;
183 unsigned int menubar_changed :1;
184 unsigned int modeline_changed :1;
185 unsigned int point_changed :1;
186 unsigned int size_changed :1;
187 unsigned int toolbar_changed :1;
188 unsigned int gutter_changed :1;
189 unsigned int windows_changed :1;
190 unsigned int windows_structure_changed :1;
191 unsigned int window_face_cache_reset :1; /* used by expose handler */
192 unsigned int echo_area_garbaged :1; /* used by Fredisplay_echo_area */
193 unsigned int size_slipped :1;
195 unsigned int size_change_pending :1;
196 unsigned int mirror_dirty :1;
198 /* flag indicating if any window on this frame is displaying a subwindow */
199 unsigned int subwindows_being_displayed :1;
202 EXFUN (Fdelete_frame, 2);
203 EXFUN (Fframe_iconified_p, 1);
204 EXFUN (Fframe_name, 1);
205 EXFUN (Fframe_property, 3);
206 EXFUN (Fmake_frame, 2);
207 EXFUN (Fmake_frame_visible, 1);
208 EXFUN (Fraise_frame, 1);
209 EXFUN (Fselect_frame, 1);
210 EXFUN (Fset_frame_pointer, 2);
211 EXFUN (Fset_frame_position, 3);
212 EXFUN (Fset_frame_size, 4);
214 extern Lisp_Object Qbackground_toolbar_color, Qbell_volume, Qborder_color;
215 extern Lisp_Object Qborder_width, Qbottom_toolbar_shadow_color;
216 extern Lisp_Object Qbottom_toolbar_shadow_pixmap, Qdelete_frame;
217 extern Lisp_Object Qdeselect_frame_hook, Qdrag_and_drop_functions, Qgc_pointer;
218 extern Lisp_Object Qiconic, Qinitially_unmapped, Qinter_line_space;
219 extern Lisp_Object Qinternal_border_width, Qinvisible, Qmap_frame_hook;
220 extern Lisp_Object Qminibuffer, Qmodeline_pointer, Qmouse_enter_frame_hook;
221 extern Lisp_Object Qmouse_leave_frame_hook, Qpointer_background;
222 extern Lisp_Object Qpointer_color, Qpopup, Qscrollbar_placement;
223 extern Lisp_Object Qselect_frame_hook, Qspace_pointer;
224 extern Lisp_Object Qsynchronize_minibuffers, Qtext_pointer;
225 extern Lisp_Object Qtoolbar_shadow_thickness, Qtop_toolbar_shadow_color;
226 extern Lisp_Object Qtop_toolbar_shadow_pixmap, Qunmap_frame_hook;
227 extern Lisp_Object Qunsplittable, Quse_backing_store, Qvisible, Qvisual_bell;
228 extern Lisp_Object Vframe_icon_title_format, Vframe_title_format;
229 extern Lisp_Object Vmouse_motion_handler;
232 DECLARE_LRECORD (frame, struct frame);
233 #define XFRAME(x) XRECORD (x, frame, struct frame)
234 #define XSETFRAME(x, p) XSETRECORD (x, p, frame)
235 #define FRAMEP(x) RECORDP (x, frame)
236 #define GC_FRAMEP(x) GC_RECORDP (x, frame)
237 #define CHECK_FRAME(x) CHECK_RECORD (x, frame)
238 #define CONCHECK_FRAME(x) CONCHECK_RECORD (x, frame)
240 #define CHECK_LIVE_FRAME(x) do { \
242 if (! FRAME_LIVE_P (XFRAME (x))) \
243 dead_wrong_type_argument (Qframe_live_p, (x)); \
245 #define CONCHECK_LIVE_FRAME(x) do { \
246 CONCHECK_FRAME (x); \
247 if (! FRAME_LIVE_P (XFRAME (x))) \
248 x = wrong_type_argument (Qframe_live_p, (x)); \
251 #define FRAME_TYPE_P(f, type) EQ (FRAME_TYPE (f), Q##type)
253 #ifdef ERROR_CHECK_TYPECHECK
254 INLINE struct frame *
255 error_check_frame_type (struct frame * f, Lisp_Object sym);
256 INLINE struct frame *
257 error_check_frame_type (struct frame * f, Lisp_Object sym)
259 assert (EQ (FRAME_TYPE (f), sym));
262 # define FRAME_TYPE_DATA(f, type) \
263 ((struct type##_frame *) (error_check_frame_type (f, Q##type))->frame_data)
265 # define FRAME_TYPE_DATA(f, type) \
266 ((struct type##_frame *) (f)->frame_data)
269 #define CHECK_FRAME_TYPE(x, type) \
272 if (!FRAME_TYPE_P (XFRAME (x), type)) \
273 dead_wrong_type_argument \
274 (type##_console_methods->predicate_symbol, x); \
276 #define CONCHECK_FRAME_TYPE(x, type) \
278 CONCHECK_FRAME (x); \
279 if (!FRAME_TYPE_P (XFRAME (x), type)) \
280 x = wrong_type_argument \
281 (type##_console_methods->predicate_symbol, x); \
284 /* #### These should be in the frame-*.h files but there are
285 too many places where the abstraction is broken. Need to
288 #define FRAME_X_P(frm) CONSOLE_TYPESYM_X_P (FRAME_TYPE (frm))
289 #define CHECK_X_FRAME(z) CHECK_FRAME_TYPE (z, x)
290 #define CONCHECK_X_FRAME(z) CONCHECK_FRAME_TYPE (z, x)
292 #define FRAME_TTY_P(frm) CONSOLE_TYPESYM_TTY_P (FRAME_TYPE (frm))
293 #define CHECK_TTY_FRAME(z) CHECK_FRAME_TYPE (z, tty)
294 #define CONCHECK_TTY_FRAME(z) CONCHECK_FRAME_TYPE (z, tty)
296 #define FRAME_STREAM_P(frm) CONSOLE_TYPESYM_STREAM_P (FRAME_TYPE (frm))
297 #define CHECK_STREAM_FRAME(z) CHECK_FRAME_TYPE (z, stream)
298 #define CONCHECK_STREAM_FRAME(z) CONCHECK_FRAME_TYPE (z, stream)
300 #define FRAME_WIN_P(frm) CONSOLE_TYPESYM_WIN_P (FRAME_TYPE (frm))
302 extern int frame_changed;
304 #define MARK_FRAME_FACES_CHANGED(f) do { \
305 struct frame *mffc_f = (f); \
306 mffc_f->faces_changed = 1; \
308 if (!NILP (mffc_f->device)) \
310 struct device *mffc_d = XDEVICE (mffc_f->device); \
311 MARK_DEVICE_FACES_CHANGED (mffc_d); \
317 #define MARK_FRAME_GLYPHS_CHANGED(f) do { \
318 struct frame *mfgc_f = (f); \
319 mfgc_f->glyphs_changed = 1; \
321 if (!NILP (mfgc_f->device)) \
323 struct device *mfgc_d = XDEVICE (mfgc_f->device); \
324 MARK_DEVICE_GLYPHS_CHANGED (mfgc_d); \
327 glyphs_changed = 1; \
330 #define MARK_FRAME_SUBWINDOWS_CHANGED(f) do { \
331 struct frame *mfgc_f = (f); \
332 mfgc_f->subwindows_changed = 1; \
334 if (!NILP (mfgc_f->device)) \
336 struct device *mfgc_d = XDEVICE (mfgc_f->device); \
337 MARK_DEVICE_SUBWINDOWS_CHANGED (mfgc_d); \
340 subwindows_changed = 1; \
343 #define MARK_FRAME_TOOLBARS_CHANGED(f) do { \
344 struct frame *mftc_f = (f); \
345 mftc_f->toolbar_changed = 1; \
347 if (!NILP (mftc_f->device)) \
349 struct device *mftc_d = XDEVICE (mftc_f->device); \
350 MARK_DEVICE_TOOLBARS_CHANGED (mftc_d); \
353 toolbar_changed = 1; \
356 #define MARK_FRAME_GUTTERS_CHANGED(f) do { \
357 struct frame *mftc_f = (f); \
358 mftc_f->gutter_changed = 1; \
360 if (!NILP (mftc_f->device)) \
362 struct device *mftc_d = XDEVICE (mftc_f->device); \
363 MARK_DEVICE_GUTTERS_CHANGED (mftc_d); \
366 gutter_changed = 1; \
369 #define MARK_FRAME_SIZE_CHANGED(f) do { \
370 struct frame *mfsc_f = (f); \
371 mfsc_f->size_changed = 1; \
372 mfsc_f->size_change_pending = 1; \
374 if (!NILP (mfsc_f->device)) \
376 struct device *mfsc_d = XDEVICE (mfsc_f->device); \
377 MARK_DEVICE_SIZE_CHANGED (mfsc_d); \
383 #define MARK_FRAME_CHANGED(f) do { \
384 struct frame *mfc_f = (f); \
385 mfc_f->frame_changed = 1; \
387 if (!NILP (mfc_f->device)) \
389 struct device *mfc_d = XDEVICE (mfc_f->device); \
390 MARK_DEVICE_FRAME_CHANGED (mfc_d); \
396 #define MARK_FRAME_WINDOWS_CHANGED(f) do { \
397 struct frame *mfwc_f = (f); \
398 mfwc_f->windows_changed = 1; \
400 if (!NILP (mfwc_f->device)) \
402 struct device *mfwc_d = XDEVICE (mfwc_f->device); \
403 MARK_DEVICE_WINDOWS_CHANGED (mfwc_d); \
406 windows_changed = 1; \
409 #define MARK_FRAME_WINDOWS_STRUCTURE_CHANGED(f) do { \
410 struct frame *fwsc_f = (f); \
411 fwsc_f->windows_structure_changed = 1; \
413 if (!NILP (fwsc_f->device)) \
415 struct device *fwsc_d = XDEVICE (fwsc_f->device); \
416 MARK_DEVICE_WINDOWS_STRUCTURE_CHANGED (fwsc_d); \
419 windows_structure_changed = 1; \
420 invalidate_vertical_divider_cache_in_frame (fwsc_f); \
423 #define MARK_FRAME_SIZE_SLIPPED(f) do { \
424 struct frame *fwsc_f = (f); \
425 fwsc_f->size_slipped = 1; \
427 if (!NILP (fwsc_f->device)) \
429 struct device *fwsc_d = XDEVICE (fwsc_f->device); \
430 MARK_DEVICE_FRAME_CHANGED (fwsc_d); \
436 #define CLEAR_FRAME_SIZE_SLIPPED(f) do { \
437 struct frame *fwsc_f = (f); \
438 fwsc_f->size_slipped = 0; \
441 #define SET_FRAME_CLEAR(f) MARK_FRAME_CHANGED (f); (f)->clear = 1
442 #define FRAME_DEVICE(f) ((f)->device)
443 #define FRAME_CONSOLE(f) DEVICE_CONSOLE (XDEVICE (FRAME_DEVICE (f)))
444 #define FRAME_LIVE_P(f) (!(f)->dead)
446 #define FRAME_MINIBUF_ONLY_P(f) \
447 EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f))
448 #define FRAME_HAS_MINIBUF_P(f) ((f)->has_minibuffer)
449 #define FRAME_HEIGHT(f) ((f)->height)
450 #define FRAME_WIDTH(f) ((f)->width)
451 #define FRAME_CHARHEIGHT(f) ((f)->char_height)
452 #define FRAME_CHARWIDTH(f) ((f)->char_width)
453 #define FRAME_PIXHEIGHT(f) ((f)->pixheight)
454 #define FRAME_PIXWIDTH(f) ((f)->pixwidth)
455 #ifdef HAVE_SCROLLBARS
456 #define FRAME_SCROLLBAR_WIDTH(f) \
457 (NILP ((f)->vertical_scrollbar_visible_p) ? \
458 0 : XINT ((f)->scrollbar_width))
459 #define FRAME_SCROLLBAR_HEIGHT(f) \
460 (NILP ((f)->horizontal_scrollbar_visible_p) ? \
461 0 : XINT ((f)->scrollbar_height))
463 #define FRAME_SCROLLBAR_WIDTH(f) 0
464 #define FRAME_SCROLLBAR_HEIGHT(f) 0
467 #define FW_FRAME(obj) \
468 (WINDOWP (obj) ? WINDOW_FRAME (XWINDOW (obj)) \
469 : (FRAMEP (obj) ? obj \
472 #define FRAME_NEW_HEIGHT(f) ((f)->new_height)
473 #define FRAME_NEW_WIDTH(f) ((f)->new_width)
474 #define FRAME_CURSOR_X(f) ((f)->cursor_x)
475 #define FRAME_CURSOR_Y(f) ((f)->cursor_y)
476 #define FRAME_VISIBLE_P(f) ((f)->visible)
477 #define FRAME_REPAINT_P(f) ((f)->visible>0)
478 #define FRAME_NO_SPLIT_P(f) ((f)->no_split)
479 #define FRAME_ICONIFIED_P(f) ((f)->iconified)
480 #define FRAME_FOCUS_FRAME(f) ((f)->focus_frame)
481 #define FRAME_MINIBUF_WINDOW(f) ((f)->minibuffer_window)
482 #define FRAME_ROOT_WINDOW(f) ((f)->root_window)
483 /* Catch people attempting to set this. */
484 #define FRAME_SELECTED_WINDOW(f) NON_LVALUE ((f)->selected_window)
485 #define FRAME_LAST_NONMINIBUF_WINDOW(f) \
486 NON_LVALUE ((f)->last_nonminibuf_window)
487 #define FRAME_SB_VCACHE(f) ((f)->sb_vcache)
488 #define FRAME_SB_HCACHE(f) ((f)->sb_hcache)
489 #define FRAME_SUBWINDOW_CACHE(f) ((f)->subwindow_cachels)
493 #define FRAME_VISIBLE_P(f) ((f)->visible != 0)
494 #define FRAME_SET_VISIBLE(f,p) \
495 ((f)->async_visible = (p), FRAME_SAMPLE_VISIBILITY (f))
497 /* Emacs's redisplay code could become confused if a frame's
498 visibility changes at arbitrary times. For example, if a frame is
499 visible while the desired glyphs are being built, but becomes
500 invisible before they are updated, then some rows of the
501 desired_glyphs will be left marked as enabled after redisplay is
502 complete, which should never happen. The next time the frame
503 becomes visible, redisplay will probably barf.
505 Currently, there are no similar situations involving iconified, but
506 the principle is the same.
508 So instead of having asynchronous input handlers directly set and
509 clear the frame's visibility and iconification flags, they just set
510 the async_visible and async_iconified flags; the redisplay code
511 calls the FRAME_SAMPLE_VISIBILITY macro before doing any redisplay,
512 which sets visible and iconified from their asynchronous
515 Synchronous code must use the FRAME_SET_VISIBLE macro.
517 Also, if a frame used to be invisible, but has just become visible,
518 it must be marked as garbaged, since redisplay hasn't been keeping
520 #define FRAME_SAMPLE_VISIBILITY(f) \
521 (((f)->async_visible && ! (f)->visible) ? SET_FRAME_GARBAGED (f) : 0, \
522 (f)->visible = (f)->async_visible, \
523 (f)->iconified = (f)->async_iconified)
527 #define FRAME_BORDER_WIDTH(f) ((f)->internal_border_width)
528 #define FRAME_BORDER_HEIGHT(f) ((f)->internal_border_width)
530 /* This returns the frame-local value; that tells you what you should
531 use when computing the frame size. It is *not* the actual toolbar
532 size because that depends on the selected window. Use the macros
537 #define FRAME_RAW_THEORETICAL_TOOLBAR_VISIBLE(f, pos) \
538 (!NILP((f)->toolbar_buttons[pos]) && !NILP ((f)->toolbar_visible_p[pos]))
539 #define FRAME_RAW_THEORETICAL_TOOLBAR_SIZE(f, pos) \
540 (!NILP ((f)->toolbar_buttons[pos]) && INTP((f)->toolbar_size[pos]) ? \
541 (XINT ((f)->toolbar_size[pos])) : 0)
542 #define FRAME_RAW_THEORETICAL_TOOLBAR_BORDER_WIDTH(f, pos) \
543 (!NILP ((f)->toolbar_buttons[pos]) && INTP((f)->toolbar_border_width[pos]) ? \
544 (XINT ((f)->toolbar_border_width[pos])) : 0)
546 #define FRAME_RAW_THEORETICAL_TOOLBAR_VISIBLE(f, pos) 0
547 #define FRAME_RAW_THEORETICAL_TOOLBAR_SIZE(f, pos) 0
548 #define FRAME_RAW_THEORETICAL_TOOLBAR_BORDER_WIDTH(f, pos) 0
551 #define FRAME_THEORETICAL_TOOLBAR_SIZE(f, pos) \
552 (FRAME_RAW_THEORETICAL_TOOLBAR_VISIBLE (f, pos) \
553 ? FRAME_RAW_THEORETICAL_TOOLBAR_SIZE (f, pos) \
556 #define FRAME_THEORETICAL_TOP_TOOLBAR_HEIGHT(f) \
557 FRAME_THEORETICAL_TOOLBAR_SIZE (f, TOP_TOOLBAR)
558 #define FRAME_THEORETICAL_BOTTOM_TOOLBAR_HEIGHT(f) \
559 FRAME_THEORETICAL_TOOLBAR_SIZE (f, BOTTOM_TOOLBAR)
560 #define FRAME_THEORETICAL_LEFT_TOOLBAR_WIDTH(f) \
561 FRAME_THEORETICAL_TOOLBAR_SIZE (f, LEFT_TOOLBAR)
562 #define FRAME_THEORETICAL_RIGHT_TOOLBAR_WIDTH(f) \
563 FRAME_THEORETICAL_TOOLBAR_SIZE (f, RIGHT_TOOLBAR)
565 #define FRAME_THEORETICAL_TOOLBAR_BORDER_WIDTH(f, pos) \
566 (FRAME_RAW_THEORETICAL_TOOLBAR_VISIBLE (f, pos) \
567 ? FRAME_RAW_THEORETICAL_TOOLBAR_BORDER_WIDTH (f, pos) \
570 #define FRAME_THEORETICAL_TOP_TOOLBAR_BORDER_WIDTH(f) \
571 FRAME_THEORETICAL_TOOLBAR_BORDER_WIDTH (f, TOP_TOOLBAR)
572 #define FRAME_THEORETICAL_BOTTOM_TOOLBAR_BORDER_WIDTH(f) \
573 FRAME_THEORETICAL_TOOLBAR_BORDER_WIDTH (f, BOTTOM_TOOLBAR)
574 #define FRAME_THEORETICAL_LEFT_TOOLBAR_BORDER_WIDTH(f) \
575 FRAME_THEORETICAL_TOOLBAR_BORDER_WIDTH (f, LEFT_TOOLBAR)
576 #define FRAME_THEORETICAL_RIGHT_TOOLBAR_BORDER_WIDTH(f) \
577 FRAME_THEORETICAL_TOOLBAR_BORDER_WIDTH (f, RIGHT_TOOLBAR)
579 /* This returns the window-local value rather than the frame-local value;
580 that tells you about what's actually visible rather than what should
581 be used when computing the frame size. */
584 #define FRAME_RAW_REAL_TOOLBAR_VISIBLE(f, pos) \
585 (HAS_DEVMETH_P (XDEVICE (FRAME_DEVICE (f)), initialize_frame_toolbars) \
586 && !NILP (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f))->toolbar_visible_p[pos]))
587 #define FRAME_RAW_REAL_TOOLBAR_BORDER_WIDTH(f, pos) \
589 (FRAME_LAST_NONMINIBUF_WINDOW (f))->toolbar_border_width[pos])) ? \
591 (FRAME_LAST_NONMINIBUF_WINDOW (f))->toolbar_border_width[pos])) \
593 #define FRAME_RAW_REAL_TOOLBAR_SIZE(f, pos) \
595 (FRAME_LAST_NONMINIBUF_WINDOW (f))->toolbar_size[pos])) ? \
597 (FRAME_LAST_NONMINIBUF_WINDOW (f))->toolbar_size[pos])) : 0)
598 #define FRAME_REAL_TOOLBAR(f, pos) \
599 (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f))->toolbar[pos])
601 #define FRAME_RAW_REAL_TOOLBAR_VISIBLE(f, pos) 0
602 #define FRAME_RAW_REAL_TOOLBAR_BORDER_WIDTH(f, pos) 0
603 #define FRAME_RAW_REAL_TOOLBAR_SIZE(f, pos) 0
604 #define FRAME_REAL_TOOLBAR(f, pos) Qnil
611 The former definitions of FRAME_REAL_FOO_TOOLBAR_VISIBLE
612 looked at the toolbar data to see what was there. The
613 current ones look at the current values of the specifiers.
614 This is a semantic change; the former definition returned
615 what was *actually* there right at the moment, while the
616 current one returns what *ought* to be there once redisplay
617 has run to completion. I think this new definition is more
618 correct in almost all circumstances and is much less likely
619 to lead to strange race conditions. I'm not completely
620 sure that there aren't some places in the redisplay code
621 that use these macros and expect the former semantics, so
622 if you encounter some odd toolbar behavior, you might want
623 to look into this. --ben */
625 #define FRAME_REAL_TOOLBAR_VISIBLE(f, pos) \
626 ((!NILP (FRAME_REAL_TOOLBAR (f, pos)) \
627 && FRAME_RAW_REAL_TOOLBAR_SIZE (f, pos) > 0) \
628 ? FRAME_RAW_REAL_TOOLBAR_VISIBLE (f, pos) \
630 #define FRAME_REAL_TOOLBAR_SIZE(f, pos) \
631 ((!NILP (FRAME_REAL_TOOLBAR (f, pos)) \
632 && FRAME_RAW_REAL_TOOLBAR_VISIBLE (f, pos)) \
633 ? FRAME_RAW_REAL_TOOLBAR_SIZE (f, pos) \
635 #define FRAME_REAL_TOOLBAR_BORDER_WIDTH(f, pos) \
636 ((!NILP (FRAME_REAL_TOOLBAR (f, pos)) \
637 && FRAME_RAW_REAL_TOOLBAR_VISIBLE (f, pos)) \
638 ? FRAME_RAW_REAL_TOOLBAR_BORDER_WIDTH (f, pos) \
641 #define FRAME_REAL_TOP_TOOLBAR_HEIGHT(f) \
642 FRAME_REAL_TOOLBAR_SIZE (f, TOP_TOOLBAR)
643 #define FRAME_REAL_BOTTOM_TOOLBAR_HEIGHT(f) \
644 FRAME_REAL_TOOLBAR_SIZE (f, BOTTOM_TOOLBAR)
645 #define FRAME_REAL_LEFT_TOOLBAR_WIDTH(f) \
646 FRAME_REAL_TOOLBAR_SIZE (f, LEFT_TOOLBAR)
647 #define FRAME_REAL_RIGHT_TOOLBAR_WIDTH(f) \
648 FRAME_REAL_TOOLBAR_SIZE (f, RIGHT_TOOLBAR)
650 #define FRAME_REAL_TOP_TOOLBAR_BORDER_WIDTH(f) \
651 FRAME_REAL_TOOLBAR_BORDER_WIDTH (f, TOP_TOOLBAR)
652 #define FRAME_REAL_BOTTOM_TOOLBAR_BORDER_WIDTH(f) \
653 FRAME_REAL_TOOLBAR_BORDER_WIDTH (f, BOTTOM_TOOLBAR)
654 #define FRAME_REAL_LEFT_TOOLBAR_BORDER_WIDTH(f) \
655 FRAME_REAL_TOOLBAR_BORDER_WIDTH (f, LEFT_TOOLBAR)
656 #define FRAME_REAL_RIGHT_TOOLBAR_BORDER_WIDTH(f) \
657 FRAME_REAL_TOOLBAR_BORDER_WIDTH (f, RIGHT_TOOLBAR)
659 #define FRAME_REAL_TOP_TOOLBAR_VISIBLE(f) \
660 FRAME_REAL_TOOLBAR_VISIBLE (f, TOP_TOOLBAR)
661 #define FRAME_REAL_BOTTOM_TOOLBAR_VISIBLE(f) \
662 FRAME_REAL_TOOLBAR_VISIBLE (f, BOTTOM_TOOLBAR)
663 #define FRAME_REAL_LEFT_TOOLBAR_VISIBLE(f) \
664 FRAME_REAL_TOOLBAR_VISIBLE (f, LEFT_TOOLBAR)
665 #define FRAME_REAL_RIGHT_TOOLBAR_VISIBLE(f) \
666 FRAME_REAL_TOOLBAR_VISIBLE (f, RIGHT_TOOLBAR)
668 #define FRAME_TOP_BORDER_START(f) \
669 (FRAME_REAL_TOP_TOOLBAR_HEIGHT (f) + \
670 2 * FRAME_REAL_TOP_TOOLBAR_BORDER_WIDTH (f))
671 #define FRAME_TOP_BORDER_END(f) \
672 (FRAME_TOP_BORDER_START (f) + FRAME_BORDER_HEIGHT (f))
674 #define FRAME_BOTTOM_BORDER_START(f) \
675 (FRAME_PIXHEIGHT (f) - FRAME_BORDER_HEIGHT (f) - \
676 FRAME_REAL_BOTTOM_TOOLBAR_HEIGHT (f) - \
677 2 * FRAME_REAL_BOTTOM_TOOLBAR_BORDER_WIDTH (f))
678 #define FRAME_BOTTOM_BORDER_END(f) \
679 (FRAME_PIXHEIGHT (f) - FRAME_REAL_BOTTOM_TOOLBAR_HEIGHT (f) - \
680 2 * FRAME_REAL_BOTTOM_TOOLBAR_BORDER_WIDTH (f))
682 #define FRAME_LEFT_BORDER_START(f) \
683 (FRAME_REAL_LEFT_TOOLBAR_WIDTH (f) + \
684 2 * FRAME_REAL_LEFT_TOOLBAR_BORDER_WIDTH (f))
685 #define FRAME_LEFT_BORDER_END(f) \
686 (FRAME_LEFT_BORDER_START (f) + FRAME_BORDER_WIDTH (f))
688 #define FRAME_RIGHT_BORDER_START(f) \
689 (FRAME_PIXWIDTH (f) - FRAME_BORDER_WIDTH (f) - \
690 FRAME_REAL_RIGHT_TOOLBAR_WIDTH(f) - \
691 2 * FRAME_REAL_RIGHT_TOOLBAR_BORDER_WIDTH (f))
692 #define FRAME_RIGHT_BORDER_END(f) \
693 (FRAME_PIXWIDTH (f) - FRAME_REAL_RIGHT_TOOLBAR_WIDTH (f) - \
694 2 * FRAME_REAL_RIGHT_TOOLBAR_BORDER_WIDTH(f))
696 /* Equivalent in FSF Emacs:
698 FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
699 `for' loop which iterates over the elements of Vframe_list. The
700 loop will set FRAME_VAR, a Lisp_Object, to each frame in
701 Vframe_list in succession and execute the statement. LIST_VAR
702 should be a Lisp_Object too; it is used to iterate through the
706 /* NO_BREAK means that "break" doesn't do what you think it does!
707 Use goto instead. "continue" is OK, though. */
708 #define FRAME_LOOP_NO_BREAK(frmcons, devcons, concons) \
709 DEVICE_LOOP_NO_BREAK (devcons, concons) \
710 DEVICE_FRAME_LOOP (frmcons, XDEVICE (XCAR (devcons)))
712 void update_frame_title (struct frame *f);
713 Lisp_Object next_frame (Lisp_Object f, Lisp_Object frametype,
714 Lisp_Object console);
715 Lisp_Object prev_frame (Lisp_Object f, Lisp_Object frametype,
716 Lisp_Object console);
717 void store_in_alist (Lisp_Object *alistptr,
718 CONST char *propname,
720 void pixel_to_char_size (struct frame *f, int pixel_width, int pixel_height,
721 int *char_width, int *char_height);
722 void char_to_pixel_size (struct frame *f, int char_width, int char_height,
723 int *pixel_width, int *pixel_height);
724 void round_size_to_char (struct frame *f, int in_width, int in_height,
725 int *out_width, int *out_height);
726 void pixel_to_real_char_size (struct frame *f, int pixel_width, int pixel_height,
727 int *char_width, int *char_height);
728 void char_to_real_pixel_size (struct frame *f, int char_width, int char_height,
729 int *pixel_width, int *pixel_height);
730 void round_size_to_real_char (struct frame *f, int in_width, int in_height,
731 int *out_width, int *out_height);
732 void change_frame_size (struct frame *frame,
733 int newlength, int newwidth,
735 void adjust_frame_size (struct frame *frame);
736 void frame_size_slipped (Lisp_Object specifier, struct frame *f,
738 void hold_frame_size_changes (void);
739 void unhold_one_frame_size_changes (struct frame *f);
740 void unhold_frame_size_changes (void);
741 void select_frame_1 (Lisp_Object frame);
742 void select_frame_2 (Lisp_Object frame);
743 struct frame *selected_frame (void);
744 struct frame *device_selected_frame (struct device *d);
745 struct frame *decode_frame (Lisp_Object frame);
746 struct frame *decode_frame_or_selected (Lisp_Object cdf);
747 Lisp_Object make_frame (struct frame *f);
748 int other_visible_frames (struct frame *f);
749 void delete_frame_internal (struct frame *f, int force,
750 int called_from_delete_device,
752 void io_error_delete_frame (Lisp_Object frame);
753 Lisp_Object find_some_frame (int (*predicate) (Lisp_Object, void *),
755 int device_matches_console_spec (Lisp_Object frame, Lisp_Object device,
756 Lisp_Object console);
757 Lisp_Object frame_first_window (struct frame *f);
758 int show_gc_cursor (struct frame *f, Lisp_Object cursor);
759 void set_frame_selected_window (struct frame *f, Lisp_Object window);
760 int is_surrogate_for_selected_frame (struct frame *f);
761 void update_frame_icon (struct frame *f);
762 void invalidate_vertical_divider_cache_in_frame (struct frame *f);
764 #endif /* _XEMACS_FRAME_H_ */