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