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