git.chise.org Git - chise/xemacs-chise.git.1/blob - src/frame.h

   1 /* Define frame-object for XEmacs.
   2    Copyright (C) 1988, 1992, 1993, 1994 Free Software Foundation, Inc.
   3
   4 This file is part of XEmacs.
   5
   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
   9 later version.
  10
  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
  14 for more details.
  15
  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.  */
  20
  21 /* Synched up with: FSF 19.30. */
  22
  23 #ifndef _XEMACS_FRAME_H_
  24 #define _XEMACS_FRAME_H_
  25
  26 #include "scrollbar.h"
  27 #include "toolbar.h"
  28 #include "device.h"
  29
  30 #define FRAME_TYPE_NAME(f) ((f)->framemeths->name)
  31 #define FRAME_TYPE(f) ((f)->framemeths->symbol)
  32
  33 /******** Accessing / calling a frame method *********/
  34
  35 #define HAS_FRAMEMETH_P(f, m) HAS_CONTYPE_METH_P ((f)->framemeths, m)
  36 #define FRAMEMETH(f, m, args) CONTYPE_METH ((f)->framemeths, m, args)
  37 #define MAYBE_FRAMEMETH(f, m, args) \
  38   MAYBE_CONTYPE_METH ((f)->framemeths, m, args)
  39 #define FRAMEMETH_OR_GIVEN(f, m, args, given) \
  40   CONTYPE_METH_OR_GIVEN((f)->framemeths, m, args, given)
  41
  42 struct frame
  43 {
  44   struct lcrecord_header header;
  45
  46   /* Methods for this frame's console.  This can also be retrieved
  47      through frame->device->console, but it's faster this way. */
  48   struct console_methods *framemeths;
  49
  50   /* Size of text only area of this frame, excluding scrollbars,
  51      toolbars and end of line glyphs. The size can be in charactes
  52      or pixels, depending on units in which window system resizes
  53      its windows */
  54   int height, width;
  55
  56   /* New height and width for pending size change, in the same units
  57      as above. 0 if no change pending.  */
  58   int new_height, new_width;
  59
  60   /* Size of text-only are of the frame, in default font characters.
  61      This may be inaccurate due to rounding error */
  62   int char_height, char_width;
  63
  64   /* Size of the whole frame, including scrollbars, toolbars and end
  65      of line glyphs, in pixels */
  66   int pixheight, pixwidth;
  67
  68 #ifdef HAVE_TTY
  69   /* The count of frame number.  This applies to TTY frames only. */
  70   int order_count;
  71 #endif
  72
  73   /* Width of the internal border.  This is a line of background color
  74      just inside the window's border.  It is normally only non-zero on
  75      X frames, but we put it here to avoid introducing window system
  76      dependencies. */
  77   int internal_border_width;
  78
  79   /* This frame's root window mirror.  This structure exactly mirrors
  80      the frame's window structure but contains only pointers to the
  81      display structures. */
  82   struct window_mirror *root_mirror;
  83
  84   int modiff;
  85
  86 #ifdef HAVE_SCROLLBARS
  87   /* frame-local scrollbar information.  See scrollbar.c. */
  88   int scrollbar_y_offset;
  89
  90   /* cache of created scrollbars */
  91   struct scrollbar_instance *sb_vcache;
  92   struct scrollbar_instance *sb_hcache;
  93 #endif
  94
  95 #ifdef HAVE_TOOLBARS
  96   /* Size of toolbars as seen by redisplay. This is used to determine
  97      whether to re-layout windows by a call to change_frame_size early
  98      in redisplay_frame. */
  99   unsigned int current_toolbar_size[4];
 100 #endif
 101
 102   /* A structure of auxiliary data specific to the device type.
 103      struct x_frame is used for X window frames; defined in console-x.h */
 104   void *frame_data;
 105
 106 #define FRAME_SLOT_DECLARATION
 107 #define MARKED_SLOT(x) Lisp_Object x
 108 #include "frameslots.h"
 109
 110     /* Nonzero if frame is currently displayed.
 111        Mutally exclusive with iconfied
 112        JV: This now a tristate flag:
 113 Value : Emacs meaning                           :f-v-p : X meaning
 114 0     : not displayed                           : nil  : unmapped
 115 >0    : user can access it,needs repainting     : t    : mapped and visible
 116 <0    : user can access it,needs no repainting  : hidden :mapped and invisible
 117      where f-v-p is the return value of frame-visible-p */
 118   int visible;
 119
 120   /* one-bit flags: */
 121
 122   /* Are we finished initializing? */
 123   unsigned int init_finished :1;
 124
 125   /* Is frame marked for deletion?  This is used in XSetErrorHandler().  */
 126   unsigned int being_deleted :1;
 127
 128   /* Nonzero if this frame has been destroyed. */
 129   unsigned int dead :1;
 130
 131   /* Nonzero if last attempt at redisplay on this frame was preempted.  */
 132   unsigned int display_preempted :1;
 133
 134   /* Nonzero if window is currently iconified.
 135      This and visible are mutually exclusive.  */
 136   unsigned int iconified :1;
 137
 138   /* Nonzero if this frame should be cleared and then redrawn.
 139      Setting this will also effectively set frame_changed. */
 140   unsigned int clear :1;
 141
 142   /* True if frame actually has a  minibuffer window on it.
 143      0 if using a minibuffer window that isn't on this frame.  */
 144   unsigned int has_minibuffer :1;
 145
 146   /* True if frame's root window can't be split.  */
 147   unsigned int no_split :1;
 148
 149   unsigned int top_toolbar_was_visible :1;
 150   unsigned int bottom_toolbar_was_visible :1;
 151   unsigned int left_toolbar_was_visible :1;
 152   unsigned int right_toolbar_was_visible :1;
 153
 154   /* redisplay flags */
 155   unsigned int buffers_changed :1;
 156   unsigned int clip_changed :1;
 157   unsigned int extents_changed :1;
 158   unsigned int faces_changed :1;
 159   unsigned int frame_changed :1;
 160   unsigned int glyphs_changed :1;
 161   unsigned int icon_changed :1;
 162   unsigned int menubar_changed :1;
 163   unsigned int modeline_changed :1;
 164   unsigned int point_changed :1;
 165   unsigned int size_changed :1;
 166   unsigned int toolbar_changed :1;
 167   unsigned int windows_changed :1;
 168   unsigned int windows_structure_changed :1;
 169   unsigned int window_face_cache_reset :1;      /* used by expose handler */
 170   unsigned int echo_area_garbaged :1;   /* used by Fredisplay_echo_area */
 171   unsigned int size_slipped :1;
 172
 173   unsigned int size_change_pending :1;
 174   unsigned int mirror_dirty :1;
 175
 176   /* flag indicating if any window on this frame is displaying a subwindow */
 177   unsigned int subwindows_being_displayed :1;
 178 };
 179
 180 EXFUN (Fdelete_frame, 2);
 181 EXFUN (Fframe_iconified_p, 1);
 182 EXFUN (Fframe_name, 1);
 183 EXFUN (Fframe_property, 3);
 184 EXFUN (Fmake_frame, 2);
 185 EXFUN (Fmake_frame_visible, 1);
 186 EXFUN (Fraise_frame, 1);
 187 EXFUN (Fselect_frame, 1);
 188 EXFUN (Fset_frame_pointer, 2);
 189 EXFUN (Fset_frame_position, 3);
 190 EXFUN (Fset_frame_size, 4);
 191
 192 extern Lisp_Object Qbackground_toolbar_color, Qbell_volume, Qborder_color;
 193 extern Lisp_Object Qborder_width, Qbottom_toolbar_shadow_color;
 194 extern Lisp_Object Qbottom_toolbar_shadow_pixmap, Qdelete_frame;
 195 extern Lisp_Object Qdeselect_frame_hook, Qdrag_and_drop_functions, Qgc_pointer;
 196 extern Lisp_Object Qiconic, Qinitially_unmapped, Qinter_line_space;
 197 extern Lisp_Object Qinternal_border_width, Qinvisible, Qmap_frame_hook;
 198 extern Lisp_Object Qminibuffer, Qmodeline_pointer, Qmouse_enter_frame_hook;
 199 extern Lisp_Object Qmouse_leave_frame_hook, Qpointer_background;
 200 extern Lisp_Object Qpointer_color, Qpopup, Qscrollbar_placement;
 201 extern Lisp_Object Qselect_frame_hook, Qspace_pointer;
 202 extern Lisp_Object Qsynchronize_minibuffers, Qtext_pointer;
 203 extern Lisp_Object Qtoolbar_shadow_thickness, Qtop_toolbar_shadow_color;
 204 extern Lisp_Object Qtop_toolbar_shadow_pixmap, Qunmap_frame_hook;
 205 extern Lisp_Object Qunsplittable, Quse_backing_store, Qvisible, Qvisual_bell;
 206 extern Lisp_Object Vframe_icon_title_format, Vframe_title_format;
 207 extern Lisp_Object Vmouse_motion_handler;
 208
 209
 210 DECLARE_LRECORD (frame, struct frame);
 211 #define XFRAME(x) XRECORD (x, frame, struct frame)
 212 #define XSETFRAME(x, p) XSETRECORD (x, p, frame)
 213 #define FRAMEP(x) RECORDP (x, frame)
 214 #define GC_FRAMEP(x) GC_RECORDP (x, frame)
 215 #define CHECK_FRAME(x) CHECK_RECORD (x, frame)
 216 #define CONCHECK_FRAME(x) CONCHECK_RECORD (x, frame)
 217
 218 #define CHECK_LIVE_FRAME(x) do {                        \
 219   CHECK_FRAME (x);                                      \
 220   if (! FRAME_LIVE_P (XFRAME (x)))                      \
 221     dead_wrong_type_argument (Qframe_live_p, (x));      \
 222 } while (0)
 223 #define CONCHECK_LIVE_FRAME(x) do {                     \
 224   CONCHECK_FRAME (x);                                   \
 225   if (! FRAME_LIVE_P (XFRAME (x)))                      \
 226     x = wrong_type_argument (Qframe_live_p, (x));       \
 227 } while (0)
 228
 229 #define FRAME_TYPE_P(f, type)   EQ (FRAME_TYPE (f), Q##type)
 230
 231 #ifdef ERROR_CHECK_TYPECHECK
 232 INLINE struct frame *
 233 error_check_frame_type (struct frame * f, Lisp_Object sym);
 234 INLINE struct frame *
 235 error_check_frame_type (struct frame * f, Lisp_Object sym)
 236 {
 237   assert (EQ (FRAME_TYPE (f), sym));
 238   return f;
 239 }
 240 # define FRAME_TYPE_DATA(f, type)                       \
 241  ((struct type##_frame *) (error_check_frame_type (f, Q##type))->frame_data)
 242 #else
 243 # define FRAME_TYPE_DATA(f, type)                       \
 244   ((struct type##_frame *) (f)->frame_data)
 245 #endif
 246
 247 #define CHECK_FRAME_TYPE(x, type)                       \
 248   do {                                                  \
 249     CHECK_FRAME (x);                                    \
 250     if (!FRAME_TYPE_P (XFRAME (x), type))               \
 251       dead_wrong_type_argument                          \
 252         (type##_console_methods->predicate_symbol, x);  \
 253   } while (0)
 254 #define CONCHECK_FRAME_TYPE(x, type)                    \
 255   do {                                                  \
 256     CONCHECK_FRAME (x);                                 \
 257     if (!FRAME_TYPE_P (XFRAME (x), type))               \
 258       x = wrong_type_argument                           \
 259         (type##_console_methods->predicate_symbol, x);  \
 260   } while (0)
 261
 262 /* #### These should be in the frame-*.h files but there are
 263    too many places where the abstraction is broken.  Need to
 264    fix. */
 265
 266 #define FRAME_X_P(frm) CONSOLE_TYPESYM_X_P (FRAME_TYPE (frm))
 267 #define CHECK_X_FRAME(z) CHECK_FRAME_TYPE (z, x)
 268 #define CONCHECK_X_FRAME(z) CONCHECK_FRAME_TYPE (z, x)
 269
 270 #define FRAME_TTY_P(frm) CONSOLE_TYPESYM_TTY_P (FRAME_TYPE (frm))
 271 #define CHECK_TTY_FRAME(z) CHECK_FRAME_TYPE (z, tty)
 272 #define CONCHECK_TTY_FRAME(z) CONCHECK_FRAME_TYPE (z, tty)
 273
 274 #define FRAME_STREAM_P(frm) CONSOLE_TYPESYM_STREAM_P (FRAME_TYPE (frm))
 275 #define CHECK_STREAM_FRAME(z) CHECK_FRAME_TYPE (z, stream)
 276 #define CONCHECK_STREAM_FRAME(z) CONCHECK_FRAME_TYPE (z, stream)
 277
 278 #define FRAME_WIN_P(frm) CONSOLE_TYPESYM_WIN_P (FRAME_TYPE (frm))
 279
 280 extern int frame_changed;
 281
 282 #define MARK_FRAME_FACES_CHANGED(f) do {                \
 283   struct frame *mffc_f = (f);                           \
 284   mffc_f->faces_changed = 1;                            \
 285   mffc_f->modiff++;                                     \
 286   if (!NILP (mffc_f->device))                           \
 287     {                                                   \
 288       struct device *mffc_d = XDEVICE (mffc_f->device); \
 289       MARK_DEVICE_FACES_CHANGED (mffc_d);               \
 290     }                                                   \
 291   else                                                  \
 292     faces_changed = 1;                                  \
 293 } while (0)
 294
 295 #define MARK_FRAME_GLYPHS_CHANGED(f) do {               \
 296   struct frame *mfgc_f = (f);                           \
 297   mfgc_f->glyphs_changed = 1;                           \
 298   mfgc_f->modiff++;                                     \
 299   if (!NILP (mfgc_f->device))                           \
 300     {                                                   \
 301       struct device *mfgc_d = XDEVICE (mfgc_f->device); \
 302       MARK_DEVICE_GLYPHS_CHANGED (mfgc_d);              \
 303     }                                                   \
 304   else                                                  \
 305     glyphs_changed = 1;                                 \
 306 } while (0)
 307
 308 #define MARK_FRAME_TOOLBARS_CHANGED(f) do {             \
 309   struct frame *mftc_f = (f);                           \
 310   mftc_f->toolbar_changed = 1;                          \
 311   mftc_f->modiff++;                                     \
 312   if (!NILP (mftc_f->device))                           \
 313     {                                                   \
 314       struct device *mftc_d = XDEVICE (mftc_f->device); \
 315       MARK_DEVICE_TOOLBARS_CHANGED (mftc_d);            \
 316     }                                                   \
 317   else                                                  \
 318     toolbar_changed = 1;                                \
 319 } while (0)
 320
 321 #define MARK_FRAME_SIZE_CHANGED(f) do {                 \
 322   struct frame *mfsc_f = (f);                           \
 323   mfsc_f->size_changed = 1;                             \
 324   mfsc_f->size_change_pending = 1;                      \
 325   mfsc_f->modiff++;                                     \
 326   if (!NILP (mfsc_f->device))                           \
 327     {                                                   \
 328       struct device *mfsc_d = XDEVICE (mfsc_f->device); \
 329       MARK_DEVICE_SIZE_CHANGED (mfsc_d);                \
 330     }                                                   \
 331   else                                                  \
 332     size_changed = 1;                                   \
 333 } while (0)
 334
 335 #define MARK_FRAME_CHANGED(f) do {                      \
 336   struct frame *mfc_f = (f);                            \
 337   mfc_f->frame_changed = 1;                             \
 338   mfc_f->modiff++;                                      \
 339   if (!NILP (mfc_f->device))                            \
 340     {                                                   \
 341       struct device *mfc_d = XDEVICE (mfc_f->device);   \
 342       MARK_DEVICE_FRAME_CHANGED (mfc_d);                \
 343     }                                                   \
 344   else                                                  \
 345     frame_changed = 1;                                  \
 346 } while (0)
 347
 348 #define MARK_FRAME_WINDOWS_CHANGED(f) do {              \
 349   struct frame *mfwc_f = (f);                           \
 350   mfwc_f->windows_changed = 1;                          \
 351   mfwc_f->modiff++;                                     \
 352   if (!NILP (mfwc_f->device))                           \
 353     {                                                   \
 354       struct device *mfwc_d = XDEVICE (mfwc_f->device); \
 355       MARK_DEVICE_WINDOWS_CHANGED (mfwc_d);             \
 356     }                                                   \
 357   else                                                  \
 358     windows_changed = 1;                                \
 359 } while (0)
 360
 361 #define MARK_FRAME_WINDOWS_STRUCTURE_CHANGED(f) do {    \
 362   struct frame *fwsc_f = (f);                           \
 363   fwsc_f->windows_structure_changed = 1;                \
 364   fwsc_f->modiff++;                                     \
 365   if (!NILP (fwsc_f->device))                           \
 366     {                                                   \
 367       struct device *fwsc_d = XDEVICE (fwsc_f->device); \
 368       MARK_DEVICE_WINDOWS_STRUCTURE_CHANGED (fwsc_d);   \
 369     }                                                   \
 370   else                                                  \
 371     windows_structure_changed = 1;                      \
 372   invalidate_vertical_divider_cache_in_frame (fwsc_f);  \
 373 } while (0)
 374
 375 #define MARK_FRAME_SIZE_SLIPPED(f) do {                 \
 376   struct frame *fwsc_f = (f);                           \
 377   fwsc_f->size_slipped = 1;                             \
 378   fwsc_f->modiff++;                                     \
 379   if (!NILP (fwsc_f->device))                           \
 380     {                                                   \
 381       struct device *fwsc_d = XDEVICE (fwsc_f->device); \
 382       MARK_DEVICE_FRAME_CHANGED (fwsc_d);               \
 383     }                                                   \
 384   else                                                  \
 385     frame_changed = 1;                                  \
 386 } while (0)
 387
 388 #define CLEAR_FRAME_SIZE_SLIPPED(f) do {                \
 389   struct frame *fwsc_f = (f);                           \
 390   fwsc_f->size_slipped = 0;                             \
 391 } while (0)
 392
 393 #define SET_FRAME_CLEAR(f) MARK_FRAME_CHANGED (f); (f)->clear = 1
 394 #define FRAME_DEVICE(f) ((f)->device)
 395 #define FRAME_CONSOLE(f) DEVICE_CONSOLE (XDEVICE (FRAME_DEVICE (f)))
 396 #define FRAME_LIVE_P(f) (!(f)->dead)
 397
 398 #define FRAME_MINIBUF_ONLY_P(f) \
 399   EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f))
 400 #define FRAME_HAS_MINIBUF_P(f) ((f)->has_minibuffer)
 401 #define FRAME_HEIGHT(f) ((f)->height)
 402 #define FRAME_WIDTH(f) ((f)->width)
 403 #define FRAME_CHARHEIGHT(f) ((f)->char_height)
 404 #define FRAME_CHARWIDTH(f) ((f)->char_width)
 405 #define FRAME_PIXHEIGHT(f) ((f)->pixheight)
 406 #define FRAME_PIXWIDTH(f) ((f)->pixwidth)
 407 #ifdef HAVE_SCROLLBARS
 408 #define FRAME_SCROLLBAR_WIDTH(f)                \
 409   (NILP ((f)->vertical_scrollbar_visible_p) ?   \
 410     0 : XINT ((f)->scrollbar_width))
 411 #define FRAME_SCROLLBAR_HEIGHT(f)               \
 412   (NILP ((f)->horizontal_scrollbar_visible_p) ? \
 413     0 : XINT ((f)->scrollbar_height))
 414 #else
 415 #define FRAME_SCROLLBAR_WIDTH(f) 0
 416 #define FRAME_SCROLLBAR_HEIGHT(f) 0
 417 #endif
 418
 419 #define FRAME_NEW_HEIGHT(f) ((f)->new_height)
 420 #define FRAME_NEW_WIDTH(f) ((f)->new_width)
 421 #define FRAME_CURSOR_X(f) ((f)->cursor_x)
 422 #define FRAME_CURSOR_Y(f) ((f)->cursor_y)
 423 #define FRAME_VISIBLE_P(f) ((f)->visible)
 424 #define FRAME_REPAINT_P(f) ((f)->visible>0)
 425 #define FRAME_NO_SPLIT_P(f) ((f)->no_split)
 426 #define FRAME_ICONIFIED_P(f) ((f)->iconified)
 427 #define FRAME_FOCUS_FRAME(f) ((f)->focus_frame)
 428 #define FRAME_MINIBUF_WINDOW(f) ((f)->minibuffer_window)
 429 #define FRAME_ROOT_WINDOW(f) ((f)->root_window)
 430 /* Catch people attempting to set this. */
 431 #define FRAME_SELECTED_WINDOW(f) NON_LVALUE ((f)->selected_window)
 432 #define FRAME_LAST_NONMINIBUF_WINDOW(f) \
 433   NON_LVALUE ((f)->last_nonminibuf_window)
 434 #define FRAME_SB_VCACHE(f) ((f)->sb_vcache)
 435 #define FRAME_SB_HCACHE(f) ((f)->sb_hcache)
 436
 437 #if 0 /* FSFmacs */
 438
 439 #define FRAME_VISIBLE_P(f) ((f)->visible != 0)
 440 #define FRAME_SET_VISIBLE(f,p) \
 441   ((f)->async_visible = (p), FRAME_SAMPLE_VISIBILITY (f))
 442
 443 /* Emacs's redisplay code could become confused if a frame's
 444    visibility changes at arbitrary times.  For example, if a frame is
 445    visible while the desired glyphs are being built, but becomes
 446    invisible before they are updated, then some rows of the
 447    desired_glyphs will be left marked as enabled after redisplay is
 448    complete, which should never happen.  The next time the frame
 449    becomes visible, redisplay will probably barf.
 450
 451    Currently, there are no similar situations involving iconified, but
 452    the principle is the same.
 453
 454    So instead of having asynchronous input handlers directly set and
 455    clear the frame's visibility and iconification flags, they just set
 456    the async_visible and async_iconified flags; the redisplay code
 457    calls the FRAME_SAMPLE_VISIBILITY macro before doing any redisplay,
 458    which sets visible and iconified from their asynchronous
 459    counterparts.
 460
 461    Synchronous code must use the FRAME_SET_VISIBLE macro.
 462
 463    Also, if a frame used to be invisible, but has just become visible,
 464    it must be marked as garbaged, since redisplay hasn't been keeping
 465    up its contents.  */
 466 #define FRAME_SAMPLE_VISIBILITY(f) \
 467   (((f)->async_visible && ! (f)->visible) ? SET_FRAME_GARBAGED (f) : 0, \
 468    (f)->visible = (f)->async_visible, \
 469    (f)->iconified = (f)->async_iconified)
 470
 471 #endif /* FSFmacs */
 472
 473 #define FRAME_BORDER_WIDTH(f) ((f)->internal_border_width)
 474 #define FRAME_BORDER_HEIGHT(f) ((f)->internal_border_width)
 475
 476 /* This returns the frame-local value; that tells you what you should
 477    use when computing the frame size.  It is *not* the actual toolbar
 478    size because that depends on the selected window.  Use the macros
 479    below for that.
 480 */
 481
 482 #ifdef HAVE_TOOLBARS
 483 #define FRAME_RAW_THEORETICAL_TOOLBAR_VISIBLE(f, pos) \
 484   (!NILP((f)->toolbar_buttons[pos]) && !NILP ((f)->toolbar_visible_p[pos]))
 485 #define FRAME_RAW_THEORETICAL_TOOLBAR_SIZE(f, pos) \
 486   (!NILP ((f)->toolbar_buttons[pos]) && INTP((f)->toolbar_size[pos]) ? \
 487    (XINT ((f)->toolbar_size[pos])) : 0)
 488 #define FRAME_RAW_THEORETICAL_TOOLBAR_BORDER_WIDTH(f, pos) \
 489   (!NILP ((f)->toolbar_buttons[pos]) && INTP((f)->toolbar_border_width[pos]) ? \
 490    (XINT ((f)->toolbar_border_width[pos])) : 0)
 491 #else
 492 #define FRAME_RAW_THEORETICAL_TOOLBAR_VISIBLE(f, pos) 0
 493 #define FRAME_RAW_THEORETICAL_TOOLBAR_SIZE(f, pos) 0
 494 #define FRAME_RAW_THEORETICAL_TOOLBAR_BORDER_WIDTH(f, pos) 0
 495 #endif
 496
 497 #define FRAME_THEORETICAL_TOOLBAR_SIZE(f, pos)          \
 498   (FRAME_RAW_THEORETICAL_TOOLBAR_VISIBLE (f, pos)       \
 499    ? FRAME_RAW_THEORETICAL_TOOLBAR_SIZE (f, pos)        \
 500    : 0)
 501
 502 #define FRAME_THEORETICAL_TOP_TOOLBAR_HEIGHT(f) \
 503   FRAME_THEORETICAL_TOOLBAR_SIZE (f, TOP_TOOLBAR)
 504 #define FRAME_THEORETICAL_BOTTOM_TOOLBAR_HEIGHT(f) \
 505   FRAME_THEORETICAL_TOOLBAR_SIZE (f, BOTTOM_TOOLBAR)
 506 #define FRAME_THEORETICAL_LEFT_TOOLBAR_WIDTH(f) \
 507   FRAME_THEORETICAL_TOOLBAR_SIZE (f, LEFT_TOOLBAR)
 508 #define FRAME_THEORETICAL_RIGHT_TOOLBAR_WIDTH(f) \
 509   FRAME_THEORETICAL_TOOLBAR_SIZE (f, RIGHT_TOOLBAR)
 510
 511 #define FRAME_THEORETICAL_TOOLBAR_BORDER_WIDTH(f, pos)          \
 512   (FRAME_RAW_THEORETICAL_TOOLBAR_VISIBLE (f, pos)       \
 513    ? FRAME_RAW_THEORETICAL_TOOLBAR_BORDER_WIDTH (f, pos)        \
 514    : 0)
 515
 516 #define FRAME_THEORETICAL_TOP_TOOLBAR_BORDER_WIDTH(f) \
 517   FRAME_THEORETICAL_TOOLBAR_BORDER_WIDTH (f, TOP_TOOLBAR)
 518 #define FRAME_THEORETICAL_BOTTOM_TOOLBAR_BORDER_WIDTH(f) \
 519   FRAME_THEORETICAL_TOOLBAR_BORDER_WIDTH (f, BOTTOM_TOOLBAR)
 520 #define FRAME_THEORETICAL_LEFT_TOOLBAR_BORDER_WIDTH(f) \
 521   FRAME_THEORETICAL_TOOLBAR_BORDER_WIDTH (f, LEFT_TOOLBAR)
 522 #define FRAME_THEORETICAL_RIGHT_TOOLBAR_BORDER_WIDTH(f) \
 523   FRAME_THEORETICAL_TOOLBAR_BORDER_WIDTH (f, RIGHT_TOOLBAR)
 524
 525 /* This returns the window-local value rather than the frame-local value;
 526    that tells you about what's actually visible rather than what should
 527    be used when computing the frame size. */
 528
 529 #ifdef HAVE_TOOLBARS
 530 #define FRAME_RAW_REAL_TOOLBAR_VISIBLE(f, pos) \
 531   (HAS_DEVMETH_P (XDEVICE (FRAME_DEVICE (f)), initialize_frame_toolbars) \
 532    && !NILP (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f))->toolbar_visible_p[pos]))
 533 #define FRAME_RAW_REAL_TOOLBAR_BORDER_WIDTH(f, pos) \
 534      ((INTP (XWINDOW \
 535              (FRAME_LAST_NONMINIBUF_WINDOW (f))->toolbar_border_width[pos])) ? \
 536       (XINT (XWINDOW \
 537              (FRAME_LAST_NONMINIBUF_WINDOW (f))->toolbar_border_width[pos])) \
 538       : 0)
 539 #define FRAME_RAW_REAL_TOOLBAR_SIZE(f, pos) \
 540      ((INTP (XWINDOW \
 541              (FRAME_LAST_NONMINIBUF_WINDOW (f))->toolbar_size[pos])) ? \
 542       (XINT (XWINDOW \
 543              (FRAME_LAST_NONMINIBUF_WINDOW (f))->toolbar_size[pos])) : 0)
 544 #define FRAME_REAL_TOOLBAR(f, pos) \
 545   (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f))->toolbar[pos])
 546 #else
 547 #define FRAME_RAW_REAL_TOOLBAR_VISIBLE(f, pos) 0
 548 #define FRAME_RAW_REAL_TOOLBAR_BORDER_WIDTH(f, pos) 0
 549 #define FRAME_RAW_REAL_TOOLBAR_SIZE(f, pos) 0
 550 #define FRAME_REAL_TOOLBAR(f, pos) Qnil
 551 #endif
 552
 553 /* Note to Chuck
 554    Note to Chuck
 555    Note to Chuck:
 556
 557    The former definitions of FRAME_REAL_FOO_TOOLBAR_VISIBLE
 558    looked at the toolbar data to see what was there.  The
 559    current ones look at the current values of the specifiers.
 560    This is a semantic change; the former definition returned
 561    what was *actually* there right at the moment, while the
 562    current one returns what *ought* to be there once redisplay
 563    has run to completion.  I think this new definition is more
 564    correct in almost all circumstances and is much less likely
 565    to lead to strange race conditions.  I'm not completely
 566    sure that there aren't some places in the redisplay code
 567    that use these macros and expect the former semantics, so
 568    if you encounter some odd toolbar behavior, you might want
 569    to look into this. --ben */
 570
 571 #define FRAME_REAL_TOOLBAR_VISIBLE(f, pos)      \
 572   ((!NILP (FRAME_REAL_TOOLBAR (f, pos))         \
 573   && FRAME_RAW_REAL_TOOLBAR_SIZE (f, pos) > 0)  \
 574    ? FRAME_RAW_REAL_TOOLBAR_VISIBLE (f, pos)    \
 575    : 0)
 576 #define FRAME_REAL_TOOLBAR_SIZE(f, pos)         \
 577   ((!NILP (FRAME_REAL_TOOLBAR (f, pos))         \
 578   && FRAME_RAW_REAL_TOOLBAR_VISIBLE (f, pos))   \
 579    ? FRAME_RAW_REAL_TOOLBAR_SIZE (f, pos)       \
 580    : 0)
 581 #define FRAME_REAL_TOOLBAR_BORDER_WIDTH(f, pos)         \
 582   ((!NILP (FRAME_REAL_TOOLBAR (f, pos))         \
 583   && FRAME_RAW_REAL_TOOLBAR_VISIBLE (f, pos))           \
 584    ? FRAME_RAW_REAL_TOOLBAR_BORDER_WIDTH (f, pos)       \
 585    : 0)
 586
 587 #define FRAME_REAL_TOP_TOOLBAR_HEIGHT(f) \
 588   FRAME_REAL_TOOLBAR_SIZE (f, TOP_TOOLBAR)
 589 #define FRAME_REAL_BOTTOM_TOOLBAR_HEIGHT(f) \
 590   FRAME_REAL_TOOLBAR_SIZE (f, BOTTOM_TOOLBAR)
 591 #define FRAME_REAL_LEFT_TOOLBAR_WIDTH(f) \
 592   FRAME_REAL_TOOLBAR_SIZE (f, LEFT_TOOLBAR)
 593 #define FRAME_REAL_RIGHT_TOOLBAR_WIDTH(f) \
 594   FRAME_REAL_TOOLBAR_SIZE (f, RIGHT_TOOLBAR)
 595
 596 #define FRAME_REAL_TOP_TOOLBAR_BORDER_WIDTH(f) \
 597   FRAME_REAL_TOOLBAR_BORDER_WIDTH (f, TOP_TOOLBAR)
 598 #define FRAME_REAL_BOTTOM_TOOLBAR_BORDER_WIDTH(f) \
 599   FRAME_REAL_TOOLBAR_BORDER_WIDTH (f, BOTTOM_TOOLBAR)
 600 #define FRAME_REAL_LEFT_TOOLBAR_BORDER_WIDTH(f) \
 601   FRAME_REAL_TOOLBAR_BORDER_WIDTH (f, LEFT_TOOLBAR)
 602 #define FRAME_REAL_RIGHT_TOOLBAR_BORDER_WIDTH(f) \
 603   FRAME_REAL_TOOLBAR_BORDER_WIDTH (f, RIGHT_TOOLBAR)
 604
 605 #define FRAME_REAL_TOP_TOOLBAR_VISIBLE(f) \
 606   FRAME_REAL_TOOLBAR_VISIBLE (f, TOP_TOOLBAR)
 607 #define FRAME_REAL_BOTTOM_TOOLBAR_VISIBLE(f) \
 608   FRAME_REAL_TOOLBAR_VISIBLE (f, BOTTOM_TOOLBAR)
 609 #define FRAME_REAL_LEFT_TOOLBAR_VISIBLE(f) \
 610   FRAME_REAL_TOOLBAR_VISIBLE (f, LEFT_TOOLBAR)
 611 #define FRAME_REAL_RIGHT_TOOLBAR_VISIBLE(f) \
 612   FRAME_REAL_TOOLBAR_VISIBLE (f, RIGHT_TOOLBAR)
 613
 614 #define FRAME_TOP_BORDER_START(f)                                       \
 615   (FRAME_REAL_TOP_TOOLBAR_HEIGHT (f) +                                  \
 616    2 * FRAME_REAL_TOP_TOOLBAR_BORDER_WIDTH (f))
 617 #define FRAME_TOP_BORDER_END(f)                                         \
 618   (FRAME_TOP_BORDER_START (f) + FRAME_BORDER_HEIGHT (f))
 619
 620 #define FRAME_BOTTOM_BORDER_START(f)                                    \
 621   (FRAME_PIXHEIGHT (f) - FRAME_BORDER_HEIGHT (f) -                      \
 622    FRAME_REAL_BOTTOM_TOOLBAR_HEIGHT (f) -                               \
 623    2 * FRAME_REAL_BOTTOM_TOOLBAR_BORDER_WIDTH (f))
 624 #define FRAME_BOTTOM_BORDER_END(f)                                      \
 625   (FRAME_PIXHEIGHT (f) - FRAME_REAL_BOTTOM_TOOLBAR_HEIGHT (f) -         \
 626    2 * FRAME_REAL_BOTTOM_TOOLBAR_BORDER_WIDTH (f))
 627
 628 #define FRAME_LEFT_BORDER_START(f)                                      \
 629   (FRAME_REAL_LEFT_TOOLBAR_WIDTH (f) +                                  \
 630    2 * FRAME_REAL_LEFT_TOOLBAR_BORDER_WIDTH (f))
 631 #define FRAME_LEFT_BORDER_END(f)                                        \
 632   (FRAME_LEFT_BORDER_START (f) + FRAME_BORDER_WIDTH (f))
 633
 634 #define FRAME_RIGHT_BORDER_START(f)                                     \
 635   (FRAME_PIXWIDTH (f) - FRAME_BORDER_WIDTH (f) -                        \
 636    FRAME_REAL_RIGHT_TOOLBAR_WIDTH(f) -                                                           \
 637    2 * FRAME_REAL_RIGHT_TOOLBAR_BORDER_WIDTH (f))
 638 #define FRAME_RIGHT_BORDER_END(f)                                       \
 639   (FRAME_PIXWIDTH (f) - FRAME_REAL_RIGHT_TOOLBAR_WIDTH (f) -            \
 640    2 * FRAME_REAL_RIGHT_TOOLBAR_BORDER_WIDTH(f))
 641
 642 /* Equivalent in FSF Emacs:
 643
 644    FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
 645    `for' loop which iterates over the elements of Vframe_list.  The
 646    loop will set FRAME_VAR, a Lisp_Object, to each frame in
 647    Vframe_list in succession and execute the statement.  LIST_VAR
 648    should be a Lisp_Object too; it is used to iterate through the
 649    Vframe_list.
 650    */
 651
 652 /* NO_BREAK means that "break" doesn't do what you think it does!
 653    Use goto instead.  "continue" is OK, though. */
 654 #define FRAME_LOOP_NO_BREAK(frmcons, devcons, concons)          \
 655   DEVICE_LOOP_NO_BREAK (devcons, concons)                       \
 656     DEVICE_FRAME_LOOP (frmcons, XDEVICE (XCAR (devcons)))
 657
 658 void update_frame_title (struct frame *f);
 659 Lisp_Object next_frame (Lisp_Object f, Lisp_Object frametype,
 660                         Lisp_Object console);
 661 Lisp_Object prev_frame (Lisp_Object f, Lisp_Object frametype,
 662                         Lisp_Object console);
 663 void store_in_alist (Lisp_Object *alistptr,
 664                      CONST char *propname,
 665                      Lisp_Object val);
 666 void pixel_to_char_size (struct frame *f, int pixel_width, int pixel_height,
 667                          int *char_width, int *char_height);
 668 void char_to_pixel_size (struct frame *f, int char_width, int char_height,
 669                          int *pixel_width, int *pixel_height);
 670 void round_size_to_char (struct frame *f, int in_width, int in_height,
 671                          int *out_width, int *out_height);
 672 void pixel_to_real_char_size (struct frame *f, int pixel_width, int pixel_height,
 673                          int *char_width, int *char_height);
 674 void char_to_real_pixel_size (struct frame *f, int char_width, int char_height,
 675                          int *pixel_width, int *pixel_height);
 676 void round_size_to_real_char (struct frame *f, int in_width, int in_height,
 677                               int *out_width, int *out_height);
 678 void change_frame_size (struct frame *frame,
 679                         int newlength, int newwidth,
 680                         int delay);
 681 void adjust_frame_size (struct frame *frame);
 682 void frame_size_slipped (Lisp_Object specifier, struct frame *f,
 683                          Lisp_Object oldval);
 684 void hold_frame_size_changes (void);
 685 void unhold_one_frame_size_changes (struct frame *f);
 686 void unhold_frame_size_changes (void);
 687 void select_frame_1 (Lisp_Object frame);
 688 void select_frame_2 (Lisp_Object frame);
 689 struct frame *selected_frame (void);
 690 struct frame *device_selected_frame (struct device *d);
 691 struct frame *decode_frame (Lisp_Object frame);
 692 struct frame *decode_frame_or_selected (Lisp_Object cdf);
 693 Lisp_Object make_frame (struct frame *f);
 694 int other_visible_frames (struct frame *f);
 695 void delete_frame_internal (struct frame *f, int force,
 696                             int called_from_delete_device,
 697                             int from_io_error);
 698 void io_error_delete_frame (Lisp_Object frame);
 699 Lisp_Object find_some_frame (int (*predicate) (Lisp_Object, void *),
 700                              void *closure);
 701 int device_matches_console_spec (Lisp_Object frame, Lisp_Object device,
 702                                  Lisp_Object console);
 703 Lisp_Object frame_first_window (struct frame *f);
 704 int show_gc_cursor (struct frame *f, Lisp_Object cursor);
 705 void set_frame_selected_window (struct frame *f, Lisp_Object window);
 706 int is_surrogate_for_selected_frame (struct frame *f);
 707 void update_frame_icon (struct frame *f);
 708 void invalidate_vertical_divider_cache_in_frame (struct frame *f);
 709
 710 #endif /* _XEMACS_FRAME_H_ */