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(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_GTK_P(frm) CONSOLE_TYPESYM_GTK_P (FRAME_TYPE (frm))
 345 #define CHECK_GTK_FRAME(z) CHECK_FRAME_TYPE (z, gtk)
 346 #define CONCHECK_GTK_FRAME(z) CONCHECK_FRAME_TYPE (z, gtk)
 347
 348 #define FRAME_TTY_P(frm) CONSOLE_TYPESYM_TTY_P (FRAME_TYPE (frm))
 349 #define CHECK_TTY_FRAME(z) CHECK_FRAME_TYPE (z, tty)
 350 #define CONCHECK_TTY_FRAME(z) CONCHECK_FRAME_TYPE (z, tty)
 351
 352 #define FRAME_STREAM_P(frm) CONSOLE_TYPESYM_STREAM_P (FRAME_TYPE (frm))
 353 #define CHECK_STREAM_FRAME(z) CHECK_FRAME_TYPE (z, stream)
 354 #define CONCHECK_STREAM_FRAME(z) CONCHECK_FRAME_TYPE (z, stream)
 355
 356 #define FRAME_WIN_P(frm) CONSOLE_TYPESYM_WIN_P (FRAME_TYPE (frm))
 357
 358 extern int frame_changed;
 359
 360 #define MARK_FRAME_FACES_CHANGED(f) do {                \
 361   struct frame *mffc_f = (f);                           \
 362   mffc_f->faces_changed = 1;                            \
 363   mffc_f->modiff++;                                     \
 364   if (!NILP (mffc_f->device))                           \
 365     {                                                   \
 366       struct device *mffc_d = XDEVICE (mffc_f->device); \
 367       MARK_DEVICE_FACES_CHANGED (mffc_d);               \
 368     }                                                   \
 369   else                                                  \
 370     faces_changed = 1;                                  \
 371 } while (0)
 372
 373 #define MARK_FRAME_GLYPHS_CHANGED(f) do {               \
 374   struct frame *mfgc_f = (f);                           \
 375   mfgc_f->glyphs_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_GLYPHS_CHANGED (mfgc_d);              \
 381     }                                                   \
 382   else                                                  \
 383     glyphs_changed = 1;                                 \
 384 } while (0)
 385
 386 #define MARK_FRAME_SUBWINDOWS_CHANGED(f) do {           \
 387   struct frame *mfgc_f = (f);                           \
 388   mfgc_f->subwindows_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_CHANGED (mfgc_d);          \
 394     }                                                   \
 395   else                                                  \
 396     subwindows_changed = 1;                             \
 397 } while (0)
 398
 399 #define MARK_FRAME_SUBWINDOWS_STATE_CHANGED(f) do {     \
 400   struct frame *mfgc_f = (f);                           \
 401   mfgc_f->subwindows_state_changed = 1;                 \
 402   mfgc_f->modiff++;                                     \
 403   if (!NILP (mfgc_f->device))                           \
 404     {                                                   \
 405       struct device *mfgc_d = XDEVICE (mfgc_f->device); \
 406       MARK_DEVICE_SUBWINDOWS_STATE_CHANGED (mfgc_d);    \
 407     }                                                   \
 408   else                                                  \
 409     subwindows_state_changed = 1;                       \
 410 } while (0)
 411
 412 #define MARK_FRAME_TOOLBARS_CHANGED(f) do {             \
 413   struct frame *mftc_f = (f);                           \
 414   mftc_f->toolbar_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_TOOLBARS_CHANGED (mftc_d);            \
 420     }                                                   \
 421   else                                                  \
 422     toolbar_changed = 1;                                \
 423 } while (0)
 424
 425 #define MARK_FRAME_GUTTERS_CHANGED(f) do {              \
 426   struct frame *mftc_f = (f);                           \
 427   mftc_f->gutter_changed = 1;                           \
 428   mftc_f->modiff++;                                     \
 429   if (!NILP (mftc_f->device))                           \
 430     {                                                   \
 431       struct device *mftc_d = XDEVICE (mftc_f->device); \
 432       MARK_DEVICE_GUTTERS_CHANGED (mftc_d);             \
 433     }                                                   \
 434   else                                                  \
 435     gutter_changed = 1;                                 \
 436 } while (0)
 437
 438 #define MARK_FRAME_SIZE_CHANGED(f) do {                 \
 439   struct frame *mfsc_f = (f);                           \
 440   mfsc_f->size_changed = 1;                             \
 441   mfsc_f->size_change_pending = 1;                      \
 442   mfsc_f->modiff++;                                     \
 443   if (!NILP (mfsc_f->device))                           \
 444     {                                                   \
 445       struct device *mfsc_d = XDEVICE (mfsc_f->device); \
 446       MARK_DEVICE_SIZE_CHANGED (mfsc_d);                \
 447     }                                                   \
 448   else                                                  \
 449     size_changed = 1;                                   \
 450 } while (0)
 451
 452 #define MARK_FRAME_CHANGED(f) do {                      \
 453   struct frame *mfc_f = (f);                            \
 454   mfc_f->frame_changed = 1;                             \
 455   mfc_f->modiff++;                                      \
 456   if (!NILP (mfc_f->device))                            \
 457     {                                                   \
 458       struct device *mfc_d = XDEVICE (mfc_f->device);   \
 459       MARK_DEVICE_FRAME_CHANGED (mfc_d);                \
 460     }                                                   \
 461   else                                                  \
 462     frame_changed = 1;                                  \
 463 } while (0)
 464
 465 #define MARK_FRAME_LAYOUT_CHANGED(f) do {               \
 466   struct frame *mfc_f = (f);                            \
 467   mfc_f->frame_layout_changed = 1;                      \
 468   mfc_f->modiff++;                                      \
 469   if (!NILP (mfc_f->device))                            \
 470     {                                                   \
 471       struct device *mfc_d = XDEVICE (mfc_f->device);   \
 472       MARK_DEVICE_FRAME_LAYOUT_CHANGED (mfc_d);         \
 473     }                                                   \
 474   else                                                  \
 475     frame_layout_changed = 1;                           \
 476 } while (0)
 477
 478 #define MARK_FRAME_WINDOWS_CHANGED(f) do {              \
 479   struct frame *mfwc_f = (f);                           \
 480   mfwc_f->windows_changed = 1;                          \
 481   mfwc_f->modiff++;                                     \
 482   if (!NILP (mfwc_f->device))                           \
 483     {                                                   \
 484       struct device *mfwc_d = XDEVICE (mfwc_f->device); \
 485       MARK_DEVICE_WINDOWS_CHANGED (mfwc_d);             \
 486     }                                                   \
 487   else                                                  \
 488     windows_changed = 1;                                \
 489 } while (0)
 490
 491 #define MARK_FRAME_WINDOWS_STRUCTURE_CHANGED(f) do {    \
 492   struct frame *fwsc_f = (f);                           \
 493   fwsc_f->windows_structure_changed = 1;                \
 494   fwsc_f->modiff++;                                     \
 495   if (!NILP (fwsc_f->device))                           \
 496     {                                                   \
 497       struct device *fwsc_d = XDEVICE (fwsc_f->device); \
 498       MARK_DEVICE_WINDOWS_STRUCTURE_CHANGED (fwsc_d);   \
 499     }                                                   \
 500   else                                                  \
 501     windows_structure_changed = 1;                      \
 502   invalidate_vertical_divider_cache_in_frame (fwsc_f);  \
 503 } while (0)
 504
 505 #define MARK_FRAME_SIZE_SLIPPED(f) do {                 \
 506   struct frame *fwsc_f = (f);                           \
 507   fwsc_f->size_slipped = 1;                             \
 508   fwsc_f->modiff++;                                     \
 509   if (!NILP (fwsc_f->device))                           \
 510     {                                                   \
 511       struct device *fwsc_d = XDEVICE (fwsc_f->device); \
 512       MARK_DEVICE_FRAME_CHANGED (fwsc_d);               \
 513     }                                                   \
 514   else                                                  \
 515     frame_changed = 1;                                  \
 516 } while (0)
 517
 518 #define CLEAR_FRAME_SIZE_SLIPPED(f) do {                \
 519   struct frame *fwsc_f = (f);                           \
 520   fwsc_f->size_slipped = 0;                             \
 521 } while (0)
 522
 523 #define SET_FRAME_CLEAR(f) MARK_FRAME_CHANGED (f); (f)->clear = 1
 524 #define FRAME_DEVICE(f) ((f)->device)
 525 #define FRAME_CONSOLE(f) DEVICE_CONSOLE (XDEVICE (FRAME_DEVICE (f)))
 526 #define FRAME_LIVE_P(f) (!(f)->dead)
 527
 528 #define FRAME_MINIBUF_ONLY_P(f) \
 529   EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f))
 530 #define FRAME_HAS_MINIBUF_P(f)  ((f)->has_minibuffer)
 531 #define FRAME_HEIGHT(f)         ((f)->height)
 532 #define FRAME_WIDTH(f)          ((f)->width)
 533 #define FRAME_CHARHEIGHT(f)     ((f)->char_height)
 534 #define FRAME_CHARWIDTH(f)      ((f)->char_width)
 535 #define FRAME_PIXHEIGHT(f)      ((f)->pixheight)
 536 #define FRAME_PIXWIDTH(f)       ((f)->pixwidth)
 537 #define FRAME_PAGENUMBER(f)     ((f)->page_number + 0)
 538 #define FRAME_SET_PAGENUMBER(f,x) (f)->page_number = (x);
 539 #ifdef HAVE_SCROLLBARS
 540 #define FRAME_SCROLLBAR_WIDTH(f)                \
 541   (NILP ((f)->vertical_scrollbar_visible_p) ?   \
 542     0 : XINT ((f)->scrollbar_width))
 543 #define FRAME_SCROLLBAR_HEIGHT(f)               \
 544   (NILP ((f)->horizontal_scrollbar_visible_p) ? \
 545     0 : XINT ((f)->scrollbar_height))
 546 #else
 547 #define FRAME_SCROLLBAR_WIDTH(f) 0
 548 #define FRAME_SCROLLBAR_HEIGHT(f) 0
 549 #endif
 550
 551 #define FW_FRAME(obj)                                   \
 552    (WINDOWP (obj) ? WINDOW_FRAME (XWINDOW (obj))        \
 553     : (FRAMEP  (obj) ? obj                              \
 554        : Qnil))
 555
 556 #define FRAME_NEW_HEIGHT(f) ((f)->new_height)
 557 #define FRAME_NEW_WIDTH(f) ((f)->new_width)
 558 #define FRAME_CURSOR_X(f) ((f)->cursor_x)
 559 #define FRAME_CURSOR_Y(f) ((f)->cursor_y)
 560 #define FRAME_VISIBLE_P(f) ((f)->visible)
 561 #define FRAME_REPAINT_P(f) ((f)->visible>0)
 562 #define FRAME_NO_SPLIT_P(f) ((f)->no_split)
 563 #define FRAME_ICONIFIED_P(f) ((f)->iconified)
 564 #define FRAME_FOCUS_FRAME(f) ((f)->focus_frame)
 565 #define FRAME_MINIBUF_WINDOW(f) ((f)->minibuffer_window)
 566 #define FRAME_ROOT_WINDOW(f) ((f)->root_window)
 567 /* Catch people attempting to set this. */
 568 #define FRAME_SELECTED_WINDOW(f) NON_LVALUE ((f)->selected_window)
 569 #define FRAME_LAST_NONMINIBUF_WINDOW(f) \
 570   NON_LVALUE ((f)->last_nonminibuf_window)
 571 #define FRAME_SB_VCACHE(f) ((f)->sb_vcache)
 572 #define FRAME_SB_HCACHE(f) ((f)->sb_hcache)
 573 #define FRAME_SUBWINDOW_CACHE(f) ((f)->subwindow_instance_cache)
 574
 575 #if 0                           /* FSFmacs */
 576
 577 #define FRAME_VISIBLE_P(f) ((f)->visible != 0)
 578 #define FRAME_SET_VISIBLE(f,p) \
 579   ((f)->async_visible = (p), FRAME_SAMPLE_VISIBILITY (f))
 580
 581 /* Emacs's redisplay code could become confused if a frame's
 582    visibility changes at arbitrary times.  For example, if a frame is
 583    visible while the desired glyphs are being built, but becomes
 584    invisible before they are updated, then some rows of the
 585    desired_glyphs will be left marked as enabled after redisplay is
 586    complete, which should never happen.  The next time the frame
 587    becomes visible, redisplay will probably barf.
 588
 589    Currently, there are no similar situations involving iconified, but
 590    the principle is the same.
 591
 592    So instead of having asynchronous input handlers directly set and
 593    clear the frame's visibility and iconification flags, they just set
 594    the async_visible and async_iconified flags; the redisplay code
 595    calls the FRAME_SAMPLE_VISIBILITY macro before doing any redisplay,
 596    which sets visible and iconified from their asynchronous
 597    counterparts.
 598
 599    Synchronous code must use the FRAME_SET_VISIBLE macro.
 600
 601    Also, if a frame used to be invisible, but has just become visible,
 602    it must be marked as garbaged, since redisplay hasn't been keeping
 603    up its contents.  */
 604 #define FRAME_SAMPLE_VISIBILITY(f) \
 605   (((f)->async_visible && ! (f)->visible) ? SET_FRAME_GARBAGED (f) : 0, \
 606    (f)->visible = (f)->async_visible, \
 607    (f)->iconified = (f)->async_iconified)
 608
 609 #endif                          /* FSFmacs */
 610
 611 #define FRAME_BORDER_WIDTH(f) ((f)->internal_border_width)
 612 #define FRAME_BORDER_HEIGHT(f) ((f)->internal_border_width)
 613
 614 /* This returns the frame-local value; that tells you what you should
 615    use when computing the frame size.  It is *not* the actual toolbar
 616    size because that depends on the selected window.  Use the macros
 617    below for that.
 618 */
 619
 620 #ifdef HAVE_TOOLBARS
 621 #define FRAME_RAW_THEORETICAL_TOOLBAR_VISIBLE(f, pos) \
 622   (!NILP((f)->toolbar_buttons[pos]) && !NILP ((f)->toolbar_visible_p[pos]))
 623 #define FRAME_RAW_THEORETICAL_TOOLBAR_SIZE(f, pos) \
 624   (!NILP ((f)->toolbar_buttons[pos]) && INTP((f)->toolbar_size[pos]) ? \
 625    (XINT ((f)->toolbar_size[pos])) : 0)
 626 #define FRAME_RAW_THEORETICAL_TOOLBAR_BORDER_WIDTH(f, pos) \
 627   (!NILP ((f)->toolbar_buttons[pos]) && INTP((f)->toolbar_border_width[pos]) ? \
 628    (XINT ((f)->toolbar_border_width[pos])) : 0)
 629 #else
 630 #define FRAME_RAW_THEORETICAL_TOOLBAR_VISIBLE(f, pos) 0
 631 #define FRAME_RAW_THEORETICAL_TOOLBAR_SIZE(f, pos) 0
 632 #define FRAME_RAW_THEORETICAL_TOOLBAR_BORDER_WIDTH(f, pos) 0
 633 #endif
 634
 635 #define FRAME_THEORETICAL_TOOLBAR_SIZE(f, pos)          \
 636   (FRAME_RAW_THEORETICAL_TOOLBAR_VISIBLE (f, pos)       \
 637    ? FRAME_RAW_THEORETICAL_TOOLBAR_SIZE (f, pos)        \
 638    : 0)
 639
 640 #define FRAME_THEORETICAL_TOP_TOOLBAR_HEIGHT(f) \
 641   FRAME_THEORETICAL_TOOLBAR_SIZE (f, TOP_TOOLBAR)
 642 #define FRAME_THEORETICAL_BOTTOM_TOOLBAR_HEIGHT(f) \
 643   FRAME_THEORETICAL_TOOLBAR_SIZE (f, BOTTOM_TOOLBAR)
 644 #define FRAME_THEORETICAL_LEFT_TOOLBAR_WIDTH(f) \
 645   FRAME_THEORETICAL_TOOLBAR_SIZE (f, LEFT_TOOLBAR)
 646 #define FRAME_THEORETICAL_RIGHT_TOOLBAR_WIDTH(f) \
 647   FRAME_THEORETICAL_TOOLBAR_SIZE (f, RIGHT_TOOLBAR)
 648
 649 #define FRAME_THEORETICAL_TOOLBAR_BORDER_WIDTH(f, pos)          \
 650   (FRAME_RAW_THEORETICAL_TOOLBAR_VISIBLE (f, pos)               \
 651    ? FRAME_RAW_THEORETICAL_TOOLBAR_BORDER_WIDTH (f, pos)        \
 652    : 0)
 653
 654 #define FRAME_THEORETICAL_TOP_TOOLBAR_BORDER_WIDTH(f) \
 655   FRAME_THEORETICAL_TOOLBAR_BORDER_WIDTH (f, TOP_TOOLBAR)
 656 #define FRAME_THEORETICAL_BOTTOM_TOOLBAR_BORDER_WIDTH(f) \
 657   FRAME_THEORETICAL_TOOLBAR_BORDER_WIDTH (f, BOTTOM_TOOLBAR)
 658 #define FRAME_THEORETICAL_LEFT_TOOLBAR_BORDER_WIDTH(f) \
 659   FRAME_THEORETICAL_TOOLBAR_BORDER_WIDTH (f, LEFT_TOOLBAR)
 660 #define FRAME_THEORETICAL_RIGHT_TOOLBAR_BORDER_WIDTH(f) \
 661   FRAME_THEORETICAL_TOOLBAR_BORDER_WIDTH (f, RIGHT_TOOLBAR)
 662
 663 /* This returns the window-local value rather than the frame-local value;
 664    that tells you about what's actually visible rather than what should
 665    be used when computing the frame size. */
 666
 667 #ifdef HAVE_TOOLBARS
 668 #define FRAME_RAW_REAL_TOOLBAR_VISIBLE(f, pos) \
 669   (HAS_DEVMETH_P (XDEVICE (FRAME_DEVICE (f)), initialize_frame_toolbars) \
 670    && !NILP (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f))->toolbar_visible_p[pos]))
 671 #define FRAME_RAW_REAL_TOOLBAR_BORDER_WIDTH(f, pos) \
 672      ((INTP (XWINDOW \
 673              (FRAME_LAST_NONMINIBUF_WINDOW (f))->toolbar_border_width[pos])) ? \
 674       (XINT (XWINDOW \
 675              (FRAME_LAST_NONMINIBUF_WINDOW (f))->toolbar_border_width[pos])) \
 676       : 0)
 677 #define FRAME_RAW_REAL_TOOLBAR_SIZE(f, pos) \
 678      ((INTP (XWINDOW \
 679              (FRAME_LAST_NONMINIBUF_WINDOW (f))->toolbar_size[pos])) ? \
 680       (XINT (XWINDOW \
 681              (FRAME_LAST_NONMINIBUF_WINDOW (f))->toolbar_size[pos])) : 0)
 682 #define FRAME_REAL_TOOLBAR(f, pos) \
 683   (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f))->toolbar[pos])
 684 #else
 685 #define FRAME_RAW_REAL_TOOLBAR_VISIBLE(f, pos) 0
 686 #define FRAME_RAW_REAL_TOOLBAR_BORDER_WIDTH(f, pos) 0
 687 #define FRAME_RAW_REAL_TOOLBAR_SIZE(f, pos) 0
 688 #define FRAME_REAL_TOOLBAR(f, pos) Qnil
 689 #endif
 690
 691 /* Note to Chuck
 692    Note to Chuck
 693    Note to Chuck:
 694
 695    The former definitions of FRAME_REAL_FOO_TOOLBAR_VISIBLE
 696    looked at the toolbar data to see what was there.  The
 697    current ones look at the current values of the specifiers.
 698    This is a semantic change; the former definition returned
 699    what was *actually* there right at the moment, while the
 700    current one returns what *ought* to be there once redisplay
 701    has run to completion.  I think this new definition is more
 702    correct in almost all circumstances and is much less likely
 703    to lead to strange race conditions.  I'm not completely
 704    sure that there aren't some places in the redisplay code
 705    that use these macros and expect the former semantics, so
 706    if you encounter some odd toolbar behavior, you might want
 707    to look into this. --ben */
 708
 709 #define FRAME_REAL_TOOLBAR_VISIBLE(f, pos)              \
 710   ((!NILP (FRAME_REAL_TOOLBAR (f, pos))                 \
 711   && FRAME_RAW_REAL_TOOLBAR_SIZE (f, pos) > 0)          \
 712    ? FRAME_RAW_REAL_TOOLBAR_VISIBLE (f, pos)            \
 713    : 0)
 714 #define FRAME_REAL_TOOLBAR_SIZE(f, pos)                 \
 715   ((!NILP (FRAME_REAL_TOOLBAR (f, pos))                 \
 716   && FRAME_RAW_REAL_TOOLBAR_VISIBLE (f, pos))           \
 717    ? FRAME_RAW_REAL_TOOLBAR_SIZE (f, pos)               \
 718    : 0)
 719 #define FRAME_REAL_TOOLBAR_BORDER_WIDTH(f, pos)         \
 720   ((!NILP (FRAME_REAL_TOOLBAR (f, pos))                 \
 721   && FRAME_RAW_REAL_TOOLBAR_VISIBLE (f, pos))           \
 722    ? FRAME_RAW_REAL_TOOLBAR_BORDER_WIDTH (f, pos)       \
 723    : 0)
 724
 725 #define FRAME_REAL_TOP_TOOLBAR_HEIGHT(f) \
 726   FRAME_REAL_TOOLBAR_SIZE (f, TOP_TOOLBAR)
 727 #define FRAME_REAL_BOTTOM_TOOLBAR_HEIGHT(f) \
 728   FRAME_REAL_TOOLBAR_SIZE (f, BOTTOM_TOOLBAR)
 729 #define FRAME_REAL_LEFT_TOOLBAR_WIDTH(f) \
 730   FRAME_REAL_TOOLBAR_SIZE (f, LEFT_TOOLBAR)
 731 #define FRAME_REAL_RIGHT_TOOLBAR_WIDTH(f) \
 732   FRAME_REAL_TOOLBAR_SIZE (f, RIGHT_TOOLBAR)
 733
 734 #define FRAME_REAL_TOP_TOOLBAR_BORDER_WIDTH(f) \
 735   FRAME_REAL_TOOLBAR_BORDER_WIDTH (f, TOP_TOOLBAR)
 736 #define FRAME_REAL_BOTTOM_TOOLBAR_BORDER_WIDTH(f) \
 737   FRAME_REAL_TOOLBAR_BORDER_WIDTH (f, BOTTOM_TOOLBAR)
 738 #define FRAME_REAL_LEFT_TOOLBAR_BORDER_WIDTH(f) \
 739   FRAME_REAL_TOOLBAR_BORDER_WIDTH (f, LEFT_TOOLBAR)
 740 #define FRAME_REAL_RIGHT_TOOLBAR_BORDER_WIDTH(f) \
 741   FRAME_REAL_TOOLBAR_BORDER_WIDTH (f, RIGHT_TOOLBAR)
 742
 743 #define FRAME_REAL_TOP_TOOLBAR_VISIBLE(f) \
 744   FRAME_REAL_TOOLBAR_VISIBLE (f, TOP_TOOLBAR)
 745 #define FRAME_REAL_BOTTOM_TOOLBAR_VISIBLE(f) \
 746   FRAME_REAL_TOOLBAR_VISIBLE (f, BOTTOM_TOOLBAR)
 747 #define FRAME_REAL_LEFT_TOOLBAR_VISIBLE(f) \
 748   FRAME_REAL_TOOLBAR_VISIBLE (f, LEFT_TOOLBAR)
 749 #define FRAME_REAL_RIGHT_TOOLBAR_VISIBLE(f) \
 750   FRAME_REAL_TOOLBAR_VISIBLE (f, RIGHT_TOOLBAR)
 751
 752 #define FRAME_TOP_BORDER_START(f)                               \
 753   (FRAME_REAL_TOP_TOOLBAR_HEIGHT (f) +                          \
 754    2 * FRAME_REAL_TOP_TOOLBAR_BORDER_WIDTH (f))
 755 #define FRAME_TOP_BORDER_END(f)                                 \
 756   (FRAME_TOP_BORDER_START (f) + FRAME_BORDER_HEIGHT (f))
 757
 758 #define FRAME_BOTTOM_BORDER_START(f)                            \
 759   (FRAME_PIXHEIGHT (f) - FRAME_BORDER_HEIGHT (f) -              \
 760    FRAME_REAL_BOTTOM_TOOLBAR_HEIGHT (f) -                       \
 761    2 * FRAME_REAL_BOTTOM_TOOLBAR_BORDER_WIDTH (f))
 762 #define FRAME_BOTTOM_BORDER_END(f)                              \
 763   (FRAME_PIXHEIGHT (f) - FRAME_REAL_BOTTOM_TOOLBAR_HEIGHT (f) - \
 764    2 * FRAME_REAL_BOTTOM_TOOLBAR_BORDER_WIDTH (f))
 765
 766 #define FRAME_LEFT_BORDER_START(f)                              \
 767   (FRAME_REAL_LEFT_TOOLBAR_WIDTH (f) +                          \
 768    2 * FRAME_REAL_LEFT_TOOLBAR_BORDER_WIDTH (f))
 769 #define FRAME_LEFT_BORDER_END(f)                                \
 770   (FRAME_LEFT_BORDER_START (f) + FRAME_BORDER_WIDTH (f))
 771
 772 #define FRAME_RIGHT_BORDER_START(f)                             \
 773   (FRAME_PIXWIDTH (f) - FRAME_BORDER_WIDTH (f) -                \
 774    FRAME_REAL_RIGHT_TOOLBAR_WIDTH(f) -                          \
 775    2 * FRAME_REAL_RIGHT_TOOLBAR_BORDER_WIDTH (f))
 776 #define FRAME_RIGHT_BORDER_END(f)                               \
 777   (FRAME_PIXWIDTH (f) - FRAME_REAL_RIGHT_TOOLBAR_WIDTH (f) -    \
 778    2 * FRAME_REAL_RIGHT_TOOLBAR_BORDER_WIDTH(f))
 779
 780 /* Equivalent in FSF Emacs:
 781
 782    FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
 783    `for' loop which iterates over the elements of Vframe_list.  The
 784    loop will set FRAME_VAR, a Lisp_Object, to each frame in
 785    Vframe_list in succession and execute the statement.  LIST_VAR
 786    should be a Lisp_Object too; it is used to iterate through the
 787    Vframe_list.
 788    */
 789
 790 /* NO_BREAK means that "break" doesn't do what you think it does!
 791    Use goto instead.  "continue" is OK, though. */
 792 #define FRAME_LOOP_NO_BREAK(frmcons, devcons, concons)          \
 793   DEVICE_LOOP_NO_BREAK (devcons, concons)                       \
 794     DEVICE_FRAME_LOOP (frmcons, XDEVICE (XCAR (devcons)))
 795
 796 void update_frame_title(struct frame *f);
 797 Lisp_Object next_frame(Lisp_Object, Lisp_Object, Lisp_Object);
 798 Lisp_Object previous_frame(Lisp_Object, Lisp_Object, Lisp_Object);
 799 void pixel_to_char_size(struct frame *f, int pixel_width, int pixel_height,
 800                         int *char_width, int *char_height);
 801 void char_to_pixel_size(struct frame *f, int char_width, int char_height,
 802                         int *pixel_width, int *pixel_height);
 803 void round_size_to_char(struct frame *f, int in_width, int in_height,
 804                         int *out_width, int *out_height);
 805 void pixel_to_real_char_size(struct frame *f, int pixel_width, int pixel_height,
 806                              int *char_width, int *char_height);
 807 void char_to_real_pixel_size(struct frame *f, int char_width, int char_height,
 808                              int *pixel_width, int *pixel_height);
 809 void round_size_to_real_char(struct frame *f, int in_width, int in_height,
 810                              int *out_width, int *out_height);
 811 void change_frame_size(struct frame *frame,
 812                        int newlength, int newwidth, int delay);
 813 void adjust_frame_size(struct frame *frame);
 814 void frame_size_slipped(Lisp_Object specifier, struct frame *f,
 815                         Lisp_Object oldval);
 816 void hold_frame_size_changes(void);
 817 void unhold_one_frame_size_changes(struct frame *f);
 818 void unhold_frame_size_changes(void);
 819 void select_frame_1(Lisp_Object frame);
 820 void select_frame_2(Lisp_Object frame);
 821 struct frame *selected_frame(void);
 822 struct frame *device_selected_frame(struct device *d);
 823 struct frame *decode_frame(Lisp_Object frame);
 824 struct frame *decode_frame_or_selected(Lisp_Object cdf);
 825 Lisp_Object make_frame(struct frame *f);
 826 int other_visible_frames(struct frame *f);
 827 void delete_frame_internal(struct frame *f, int force,
 828                            int called_from_delete_device, int from_io_error);
 829 void io_error_delete_frame(Lisp_Object frame);
 830 Lisp_Object find_some_frame(int (*predicate) (Lisp_Object, void *),
 831                             void *closure);
 832 int device_matches_device_spec(Lisp_Object device, Lisp_Object device_spec);
 833 Lisp_Object frame_first_window(struct frame *f);
 834 int show_gc_cursor(struct frame *f, Lisp_Object cursor);
 835 void set_frame_selected_window(struct frame *f, Lisp_Object window);
 836 int is_surrogate_for_selected_frame(struct frame *f);
 837 void update_frame_icon(struct frame *f);
 838 void invalidate_vertical_divider_cache_in_frame(struct frame *f);
 839
 840 void init_frame(void);
 841
 842 #endif                          /* INCLUDED_frame_h_ */