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