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