src/frame.h

   1 /* Don't multiply include: dispextern.h includes macterm.h which includes frame.h
   2    some emacs source includes both dispextern.h and frame.h */
   3 #ifndef _XFRAME_H_
   4 #define _XFRAME_H_
   5
   6 /* Define frame-object for GNU Emacs.
   7    Copyright (C) 1993, 1994 Free Software Foundation, Inc.
   8
   9 This file is part of GNU Emacs.
  10
  11 GNU Emacs is free software; you can redistribute it and/or modify
  12 it under the terms of the GNU General Public License as published by
  13 the Free Software Foundation; either version 2, or (at your option)
  14 any later version.
  15
  16 GNU Emacs is distributed in the hope that it will be useful,
  17 but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 GNU General Public License for more details.
  20
  21 You should have received a copy of the GNU General Public License
  22 along with GNU Emacs; see the file COPYING.  If not, write to
  23 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  24 Boston, MA 02111-1307, USA.  */
  25
  26 \f
  27 /* Miscellanea.  */
  28
  29 /* Nonzero means don't assume anything about current contents of
  30    actual terminal frame */
  31
  32 extern int frame_garbaged;
  33
  34 /* Nonzero means FRAME_MESSAGE_BUF (selected_frame) is being used by
  35    print.  */
  36
  37 extern int message_buf_print;
  38
  39 \f
  40 /* The structure representing a frame.  */
  41
  42 enum output_method
  43 {
  44   output_termcap,
  45   output_x_window,
  46   output_msdos_raw,
  47   output_w32,
  48   output_mac
  49 };
  50
  51 enum vertical_scroll_bar_type
  52 {
  53   vertical_scroll_bar_none,
  54   vertical_scroll_bar_left,
  55   vertical_scroll_bar_right
  56 };
  57
  58 #if !defined(MSDOS) && !defined(WINDOWSNT) && !defined(macintosh)
  59
  60 #if !defined(HAVE_X_WINDOWS)
  61
  62 #define PIX_TYPE int
  63
  64 /* A (mostly empty) x_output structure definition for building Emacs
  65    on Unix and GNU/Linux without X support.  */
  66 struct x_output
  67 {
  68   PIX_TYPE background_pixel;
  69   PIX_TYPE foreground_pixel;
  70 };
  71
  72 #endif /* ! HAVE_X_WINDOWS */
  73
  74 /* A structure describing a termcap frame display.  */
  75 extern struct x_output tty_display;
  76
  77 #endif /* ! MSDOS && ! WINDOWSNT && ! macintosh */
  78
  79 struct frame
  80 {
  81   EMACS_INT size;
  82   struct Lisp_Vector *next;
  83
  84   /* All Lisp_Object components must come first.
  85      Only EMACS_INT values can be intermixed with them.
  86      That ensures they are all aligned normally.  */
  87
  88   /* Name of this frame: a Lisp string.  It is used for looking up resources,
  89      as well as for the title in some cases.  */
  90   Lisp_Object name;
  91
  92   /* The name to use for the icon, the last time
  93      it was refreshed.  nil means not explicitly specified.  */
  94   Lisp_Object icon_name;
  95
  96   /* This is the frame title specified explicitly, if any.
  97      Usually it is nil.  */
  98   Lisp_Object title;
  99
 100   /* The frame which should receive keystrokes that occur in this
 101      frame, or nil if they should go to the frame itself.  This is
 102      usually nil, but if the frame is minibufferless, we can use this
 103      to redirect keystrokes to a surrogate minibuffer frame when
 104      needed.
 105
 106      Note that a value of nil is different than having the field point
 107      to the frame itself.  Whenever the Fselect_frame function is used
 108      to shift from one frame to the other, any redirections to the
 109      original frame are shifted to the newly selected frame; if
 110      focus_frame is nil, Fselect_frame will leave it alone.  */
 111   Lisp_Object focus_frame;
 112
 113   /* This frame's root window.  Every frame has one.
 114      If the frame has only a minibuffer window, this is it.
 115      Otherwise, if the frame has a minibuffer window, this is its sibling.  */
 116   Lisp_Object root_window;
 117
 118   /* This frame's selected window.
 119      Each frame has its own window hierarchy
 120      and one of the windows in it is selected within the frame.
 121      The selected window of the selected frame is Emacs's selected window.  */
 122   Lisp_Object selected_window;
 123
 124   /* This frame's minibuffer window.
 125      Most frames have their own minibuffer windows,
 126      but only the selected frame's minibuffer window
 127      can actually appear to exist.  */
 128   Lisp_Object minibuffer_window;
 129
 130   /* Parameter alist of this frame.
 131      These are the parameters specified when creating the frame
 132      or modified with modify-frame-parameters.  */
 133   Lisp_Object param_alist;
 134
 135   /* List of scroll bars on this frame.
 136      Actually, we don't specify exactly what is stored here at all; the
 137      scroll bar implementation code can use it to store anything it likes.
 138      This field is marked by the garbage collector.  It is here
 139      instead of in the `display' structure so that the garbage
 140      collector doesn't need to look inside the window-system-dependent
 141      structure.  */
 142   Lisp_Object scroll_bars;
 143   Lisp_Object condemned_scroll_bars;
 144
 145   /* Vector describing the items to display in the menu bar.
 146      Each item has four elements in this vector.
 147      They are KEY, STRING, SUBMAP, and HPOS.
 148      (HPOS is not used in when the X toolkit is in use.)
 149      There are four additional elements of nil at the end, to terminate.  */
 150   Lisp_Object menu_bar_items;
 151
 152   /* Alist of elements (FACE-NAME . FACE-VECTOR-DATA).  */
 153   Lisp_Object face_alist;
 154
 155   /* A vector that records the entire structure of this frame's menu bar.
 156      For the format of the data, see extensive comments in xmenu.c.
 157      Only the X toolkit version uses this.  */
 158   Lisp_Object menu_bar_vector;
 159   /* Number of elements in the vector that have meaningful data.  */
 160   EMACS_INT menu_bar_items_used;
 161
 162   /* Predicate for selecting buffers for other-buffer.  */
 163   Lisp_Object buffer_predicate;
 164
 165   /* List of buffers viewed in this frame, for other-buffer.  */
 166   Lisp_Object buffer_list;
 167
 168   /* A dummy window used to display menu bars under X when no X
 169      toolkit support is available.  */
 170   Lisp_Object menu_bar_window;
 171
 172   /* A window used to display the tool-bar of a frame.  */
 173   Lisp_Object tool_bar_window;
 174
 175   /* Desired and current tool-bar items.  */
 176   Lisp_Object desired_tool_bar_items, current_tool_bar_items;
 177
 178   /* Desired and current contents displayed in tool_bar_window.  */
 179   Lisp_Object desired_tool_bar_string, current_tool_bar_string;
 180
 181   /* beyond here, there should be no more Lisp_Object components.  */
 182
 183   /* Cache of realized faces.  */
 184   struct face_cache *face_cache;
 185
 186   /* A buffer to hold the frame's name.  We can't use the Lisp
 187      string's pointer (`name', above) because it might get relocated.  */
 188   char *namebuf;
 189
 190   /* Glyph pool and matrix. */
 191   struct glyph_pool *current_pool;
 192   struct glyph_pool *desired_pool;
 193   struct glyph_matrix *desired_matrix;
 194   struct glyph_matrix *current_matrix;
 195
 196   /* 1 means that glyphs on this frame have been initialized so it can
 197      be used for output.  */
 198   unsigned glyphs_initialized_p : 1;
 199
 200   /* Margin at the top of the frame.  Used to display the tool-bar.  */
 201   int tool_bar_lines;
 202
 203   int n_desired_tool_bar_items;
 204   int n_current_tool_bar_items;
 205
 206   /* A buffer for decode_mode_line. */
 207   char *decode_mode_spec_buffer;
 208
 209   /* See do_line_insertion_deletion_costs for info on these arrays. */
 210   /* Cost of inserting 1 line on this frame */
 211   int *insert_line_cost;
 212   /* Cost of deleting 1 line on this frame */
 213   int *delete_line_cost;
 214   /* Cost of inserting n lines on this frame */
 215   int *insert_n_lines_cost;
 216   /* Cost of deleting n lines on this frame */
 217   int *delete_n_lines_cost;
 218
 219   /* Size of this frame, in units of characters.  */
 220   EMACS_INT height;
 221   EMACS_INT width;
 222   EMACS_INT window_width;
 223   EMACS_INT window_height;
 224
 225   /* New height and width for pending size change.  0 if no change pending.  */
 226   int new_height, new_width;
 227
 228   /* The output method says how the contents of this frame
 229      are displayed.  It could be using termcap, or using an X window.  */
 230   enum output_method output_method;
 231
 232   /* A structure of auxiliary data used for displaying the contents.
 233      struct x_output is used for X window frames;
 234      it is defined in xterm.h.
 235      struct w32_output is used for W32 window frames;
 236      it is defined in w32term.h.  */
 237   union output_data
 238   {
 239     struct x_output *x;
 240     struct w32_output *w32;
 241     struct mac_output *mac;
 242     int nothing;
 243   }
 244   output_data;
 245
 246 #ifdef MULTI_KBOARD
 247   /* A pointer to the kboard structure associated with this frame.
 248      For termcap frames, this points to initial_kboard.  For X frames,
 249      it will be the same as display.x->display_info->kboard.  */
 250   struct kboard *kboard;
 251 #endif
 252
 253   /* Number of lines of menu bar.  */
 254   int menu_bar_lines;
 255
 256 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
 257   /* Nonzero means using a menu bar that comes from the X toolkit.  */
 258   int external_menu_bar;
 259 #endif
 260
 261   /* Nonzero if last attempt at redisplay on this frame was preempted.  */
 262   char display_preempted;
 263
 264   /* visible is nonzero if the frame is currently displayed; we check
 265      it to see if we should bother updating the frame's contents.
 266      DON'T SET IT DIRECTLY; instead, use FRAME_SET_VISIBLE.
 267
 268      Note that, since invisible frames aren't updated, whenever a
 269      frame becomes visible again, it must be marked as garbaged.  The
 270      FRAME_SAMPLE_VISIBILITY macro takes care of this.
 271
 272      On Windows NT/9X, to avoid wasting effort updating visible frames
 273      that are actually completely obscured by other windows on the
 274      display, we bend the meaning of visible slightly: if greater than
 275      1, then the frame is obscured - we still consider it to be
 276      "visible" as seen from lisp, but we don't bother updating it.  We
 277      must take care to garbage the frame when it ceaces to be obscured
 278      though.  Note that these semantics are only used on NT/9X.
 279
 280      iconified is nonzero if the frame is currently iconified.
 281
 282      Asynchronous input handlers should NOT change these directly;
 283      instead, they should change async_visible or async_iconified, and
 284      let the FRAME_SAMPLE_VISIBILITY macro set visible and iconified
 285      at the next redisplay.
 286
 287      These should probably be considered read-only by everyone except
 288      FRAME_SAMPLE_VISIBILITY.
 289
 290      These two are mutually exclusive.  They might both be zero, if the
 291      frame has been made invisible without an icon.  */
 292   char visible, iconified;
 293
 294   /* Asynchronous input handlers change these, and
 295      FRAME_SAMPLE_VISIBILITY copies them into visible and iconified.
 296      See FRAME_SAMPLE_VISIBILITY, below.  */
 297 #ifdef __STDC__
 298   volatile
 299 #endif
 300   char async_visible, async_iconified;
 301
 302   /* Nonzero if this frame should be redrawn.  */
 303 #ifdef __STDC__
 304   volatile
 305 #endif
 306   char garbaged;
 307
 308   /* True if frame actually has a minibuffer window on it.
 309      0 if using a minibuffer window that isn't on this frame.  */
 310   char has_minibuffer;
 311
 312   /* 0 means, if this frame has just one window,
 313      show no modeline for that window.  */
 314   char wants_modeline;
 315
 316   /* Non-zero if the hardware device this frame is displaying on can
 317      support scroll bars.  */
 318   char can_have_scroll_bars;
 319
 320   /* If can_have_scroll_bars is non-zero, this is non-zero if we should
 321      actually display them on this frame.  */
 322   enum vertical_scroll_bar_type vertical_scroll_bar_type;
 323
 324   /* Non-0 means raise this frame to the top of the heap when selected.  */
 325   char auto_raise;
 326
 327   /* Non-0 means lower this frame to the bottom of the stack when left.  */
 328   char auto_lower;
 329
 330   /* True if frame's root window can't be split.  */
 331   char no_split;
 332
 333   /* If this is set, then Emacs won't change the frame name to indicate
 334      the current buffer, etcetera.  If the user explicitly sets the frame
 335      name, this gets set.  If the user sets the name to Qnil, this is
 336      cleared.  */
 337   char explicit_name;
 338
 339   /* Nonzero if size of some window on this frame has changed.  */
 340   char window_sizes_changed;
 341
 342   /* Storage for messages to this frame. */
 343   char *message_buf;
 344
 345   /* Nonnegative if current redisplay should not do scroll computation
 346      for lines beyond a certain vpos.  This is the vpos.  */
 347   int scroll_bottom_vpos;
 348
 349   /* Width of the scroll bar, in pixels and in characters.
 350      scroll_bar_cols tracks scroll_bar_pixel_width if the latter is positive;
 351      a zero value in scroll_bar_pixel_width means to compute the actual width
 352      on the fly, using scroll_bar_cols and the current font width.  */
 353   int scroll_bar_pixel_width;
 354   int scroll_bar_cols;
 355
 356   /* Width of area for drawing truncation marks and overlay arrow.  */
 357   int trunc_area_pixel_width, trunc_area_cols;
 358
 359   /* The baud rate that was used to calculate costs for this frame.  */
 360   int cost_calculation_baud_rate;
 361
 362   /* A pointer to the data structure containing all information of
 363      fontsets associated with this frame.  See the comments in
 364      fontset.h for more detail.  */
 365   struct fontset_data *fontset_data;
 366
 367   /* Nonzero if the mouse has moved on this display
 368      since the last time we checked.  */
 369   char mouse_moved;
 370
 371   /* Exponent for gamma correction of colors.  1/(VIEWING_GAMMA *
 372      SCREEN_GAMMA) where viewing_gamma is 0.4545 and SCREEN_GAMMA is a
 373      frame parameter.  0 means don't do gamma correction.  */
 374   double gamma;
 375 };
 376
 377 #ifdef MULTI_KBOARD
 378 #define FRAME_KBOARD(f) ((f)->kboard)
 379 #else
 380 #define FRAME_KBOARD(f) (&the_only_kboard)
 381 #endif
 382
 383 typedef struct frame *FRAME_PTR;
 384
 385 #define XFRAME(p) ((struct frame *) XPNTR (p))
 386 #define XSETFRAME(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_FRAME))
 387
 388 /* Given a window, return its frame as a Lisp_Object.  */
 389 #define WINDOW_FRAME(w) (w)->frame
 390
 391 /* Test a frame for particular kinds of display methods.  */
 392 #define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap)
 393 #define FRAME_X_P(f) ((f)->output_method == output_x_window)
 394 #define FRAME_W32_P(f) ((f)->output_method == output_w32)
 395 #define FRAME_MSDOS_P(f) ((f)->output_method == output_msdos_raw)
 396 #define FRAME_MAC_P(f) ((f)->output_method == output_mac)
 397
 398 /* FRAME_WINDOW_P tests whether the frame is a window, and is
 399    defined to be the predicate for the window system being used.  */
 400
 401 #ifdef HAVE_X_WINDOWS
 402 #define FRAME_WINDOW_P(f) FRAME_X_P (f)
 403 #endif
 404 #ifdef HAVE_NTGUI
 405 #define FRAME_WINDOW_P(f) FRAME_W32_P (f)
 406 #endif
 407 #ifdef macintosh
 408 #define FRAME_WINDOW_P(f) FRAME_MAC_P (f)
 409 #endif
 410 #ifndef FRAME_WINDOW_P
 411 #define FRAME_WINDOW_P(f) (0)
 412 #endif
 413
 414 /* Nonzero if frame F is still alive (not deleted).  */
 415 #define FRAME_LIVE_P(f) ((f)->output_data.nothing != 0)
 416
 417 /* Nonzero if frame F is a minibuffer-only frame.  */
 418 #define FRAME_MINIBUF_ONLY_P(f) \
 419   EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f))
 420
 421 /* Nonzero if frame F contains a minibuffer window.
 422    (If this is 0, F must use some other minibuffer window.)  */
 423 #define FRAME_HAS_MINIBUF_P(f) ((f)->has_minibuffer)
 424 #define FRAME_HEIGHT(f) (f)->height
 425
 426 /* Width of frame F, measured in character columns,
 427    not including scroll bars if any.  */
 428 #define FRAME_WIDTH(f) (f)->width
 429
 430 /* Number of lines of frame F used for menu bar.
 431    This is relevant on terminal frames and on
 432    X Windows when not using the X toolkit.
 433    These lines are counted in FRAME_HEIGHT.  */
 434 #define FRAME_MENU_BAR_LINES(f) (f)->menu_bar_lines
 435
 436 /* Number of lines of frame F used for the tool-bar.  */
 437
 438 #define FRAME_TOOL_BAR_LINES(f) (f)->tool_bar_lines
 439
 440 /* Lines above the top-most window in frame F.  */
 441
 442 #define FRAME_TOP_MARGIN(F) \
 443      (FRAME_MENU_BAR_LINES (F) + FRAME_TOOL_BAR_LINES (F))
 444
 445 /* Nonzero if this frame should display a menu bar
 446    in a way that does not use any text lines.  */
 447 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
 448 #define FRAME_EXTERNAL_MENU_BAR(f) (f)->external_menu_bar
 449 #else
 450 #define FRAME_EXTERNAL_MENU_BAR(f) 0
 451 #endif
 452 #define FRAME_VISIBLE_P(f) ((f)->visible != 0)
 453
 454 /* Nonzero if frame F is currently visible but hidden.  */
 455 #define FRAME_OBSCURED_P(f) ((f)->visible > 1)
 456
 457 /* Nonzero if frame F is currently iconified.  */
 458 #define FRAME_ICONIFIED_P(f) (f)->iconified
 459
 460 #define FRAME_SET_VISIBLE(f,p) \
 461   ((f)->async_visible = (p), FRAME_SAMPLE_VISIBILITY (f))
 462 #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1, f->garbaged = 1)
 463 #define FRAME_GARBAGED_P(f) (f)->garbaged
 464
 465 /* Nonzero means do not allow splitting this frame's window.  */
 466 #define FRAME_NO_SPLIT_P(f) (f)->no_split
 467
 468 /* Not really implemented.  */
 469 #define FRAME_WANTS_MODELINE_P(f) (f)->wants_modeline
 470
 471 /* Nonzero if a size change has been requested for frame F
 472    but not yet really put into effect.  This can be true temporarily
 473    when an X event comes in at a bad time.  */
 474 #define FRAME_WINDOW_SIZES_CHANGED(f) (f)->window_sizes_changed
 475 /* When a size change is pending, these are the requested new sizes.  */
 476 #define FRAME_NEW_HEIGHT(f) (f)->new_height
 477 #define FRAME_NEW_WIDTH(f) (f)->new_width
 478
 479 /* The minibuffer window of frame F, if it has one; otherwise nil.  */
 480 #define FRAME_MINIBUF_WINDOW(f) (f)->minibuffer_window
 481
 482 /* The root window of the window tree of frame F.  */
 483 #define FRAME_ROOT_WINDOW(f) (f)->root_window
 484
 485 /* The currently selected window of the window tree of frame F.  */
 486 #define FRAME_SELECTED_WINDOW(f) (f)->selected_window
 487
 488 #define FRAME_INSERT_COST(f) (f)->insert_line_cost
 489 #define FRAME_DELETE_COST(f) (f)->delete_line_cost
 490 #define FRAME_INSERTN_COST(f) (f)->insert_n_lines_cost
 491 #define FRAME_DELETEN_COST(f) (f)->delete_n_lines_cost
 492 #define FRAME_MESSAGE_BUF(f) (f)->message_buf
 493 #define FRAME_SCROLL_BOTTOM_VPOS(f) (f)->scroll_bottom_vpos
 494 #define FRAME_FOCUS_FRAME(f) (f)->focus_frame
 495
 496 /* Nonzero if frame F supports scroll bars.
 497    If this is zero, then it is impossible to enable scroll bars
 498    on frame F.  */
 499 #define FRAME_CAN_HAVE_SCROLL_BARS(f) ((f)->can_have_scroll_bars)
 500
 501 /* This frame slot says whether scroll bars are currently enabled for frame F,
 502    and which side they are on.  */
 503 #define FRAME_VERTICAL_SCROLL_BAR_TYPE(f) ((f)->vertical_scroll_bar_type)
 504 #define FRAME_HAS_VERTICAL_SCROLL_BARS(f) \
 505      ((f)->vertical_scroll_bar_type != vertical_scroll_bar_none)
 506 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT(f) \
 507      ((f)->vertical_scroll_bar_type == vertical_scroll_bar_left)
 508 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT(f) \
 509      ((f)->vertical_scroll_bar_type == vertical_scroll_bar_right)
 510
 511 /* Width that a scroll bar in frame F should have, if there is one.
 512    Measured in pixels.
 513    If scroll bars are turned off, this is still nonzero.  */
 514 #define FRAME_SCROLL_BAR_PIXEL_WIDTH(f) ((f)->scroll_bar_pixel_width)
 515
 516 /* Width that a scroll bar in frame F should have, if there is one.
 517    Measured in columns (characters).
 518    If scroll bars are turned off, this is still nonzero.  */
 519 #define FRAME_SCROLL_BAR_COLS(f) ((f)->scroll_bar_cols)
 520
 521 /* Width of a scroll bar in frame F, measured in columns (characters),
 522    but only if scroll bars are on the left.
 523    If scroll bars are on the right in this frame, it is 0.  */
 524 #define FRAME_LEFT_SCROLL_BAR_WIDTH(f) \
 525      (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \
 526       ? FRAME_SCROLL_BAR_COLS (f) \
 527       : 0)
 528
 529 /* Width of a scroll bar in frame F, measured in columns (characters).  */
 530 #define FRAME_SCROLL_BAR_WIDTH(f) \
 531      (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \
 532       ? FRAME_SCROLL_BAR_COLS (f) \
 533       : 0)
 534
 535 /* Total width of frame F, in columns (characters),
 536    including the width used by scroll bars if any.  */
 537 #define FRAME_WINDOW_WIDTH(f) ((f)->window_width)
 538
 539 /* Set the width of frame F to VAL.
 540    VAL is the width of a full-frame window,
 541    not including scroll bars.  */
 542 #define SET_FRAME_WIDTH(f, val)                                         \
 543      ((f)->width = (val),                                               \
 544       (f)->window_width = FRAME_WINDOW_WIDTH_ARG (f, (f)->width))
 545
 546 /* Given a value WIDTH for frame F's nominal width,
 547    return the value that FRAME_WINDOW_WIDTH should have.  */
 548 #define FRAME_WINDOW_WIDTH_ARG(f, width)        \
 549      ((width)                                   \
 550       + FRAME_SCROLL_BAR_WIDTH (f)              \
 551       + FRAME_FLAGS_AREA_COLS (f))
 552
 553 /* Maximum + 1 legitimate value for FRAME_CURSOR_X.  */
 554 #define FRAME_CURSOR_X_LIMIT(f) \
 555      (FRAME_WIDTH (f) + FRAME_LEFT_SCROLL_BAR_WIDTH (f))
 556
 557 /* Nonzero if frame F has scroll bars.  */
 558 #define FRAME_SCROLL_BARS(f) ((f)->scroll_bars)
 559
 560 #define FRAME_CONDEMNED_SCROLL_BARS(f) ((f)->condemned_scroll_bars)
 561 #define FRAME_MENU_BAR_ITEMS(f) ((f)->menu_bar_items)
 562 #define FRAME_COST_BAUD_RATE(f) ((f)->cost_calculation_baud_rate)
 563 #define FRAME_FONTSET_DATA(f) ((f)->fontset_data)
 564
 565 /* Return a pointer to the face cache of frame F.  */
 566
 567 #define FRAME_FACE_CACHE(F)     (F)->face_cache
 568
 569 /* Return the size of message_buf of the frame F.  We multiply the
 570    width of the frame by 4 because multi-byte form may require at most
 571    4-byte for a character.  */
 572
 573 #define FRAME_MESSAGE_BUF_SIZE(f) (((int) (f)->width) * 4)
 574
 575 /* Emacs's redisplay code could become confused if a frame's
 576    visibility changes at arbitrary times.  For example, if a frame is
 577    visible while the desired glyphs are being built, but becomes
 578    invisible before they are updated, then some rows of the
 579    desired_glyphs will be left marked as enabled after redisplay is
 580    complete, which should never happen.  The next time the frame
 581    becomes visible, redisplay will probably barf.
 582
 583    Currently, there are no similar situations involving iconified, but
 584    the principle is the same.
 585
 586    So instead of having asynchronous input handlers directly set and
 587    clear the frame's visibility and iconification flags, they just set
 588    the async_visible and async_iconified flags; the redisplay code
 589    calls the FRAME_SAMPLE_VISIBILITY macro before doing any redisplay,
 590    which sets visible and iconified from their asynchronous
 591    counterparts.
 592
 593    Synchronous code must use the FRAME_SET_VISIBLE macro.
 594
 595    Also, if a frame used to be invisible, but has just become visible,
 596    it must be marked as garbaged, since redisplay hasn't been keeping
 597    up its contents.  */
 598
 599 #define FRAME_SAMPLE_VISIBILITY(f) \
 600   (((f)->async_visible && (f)->visible != (f)->async_visible) ? \
 601    SET_FRAME_GARBAGED (f) : 0, \
 602    (f)->visible = (f)->async_visible, \
 603    (f)->iconified = (f)->async_iconified)
 604
 605 #define CHECK_FRAME(x, i)                               \
 606      do {                                               \
 607        if (! FRAMEP (x))                                \
 608          x = wrong_type_argument (Qframep, (x));        \
 609      } while (0)
 610
 611 #define CHECK_LIVE_FRAME(x, i)                          \
 612      do {                                               \
 613        if (! FRAMEP (x)                                 \
 614            || ! FRAME_LIVE_P (XFRAME (x)))              \
 615          x = wrong_type_argument (Qframe_live_p, (x));  \
 616      } while (0)
 617
 618 /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
 619    `for' loop which iterates over the elements of Vframe_list.  The
 620    loop will set FRAME_VAR, a Lisp_Object, to each frame in
 621    Vframe_list in succession and execute the statement.  LIST_VAR
 622    should be a Lisp_Object too; it is used to iterate through the
 623    Vframe_list.
 624
 625    This macro is a holdover from a time when multiple frames weren't always
 626    supported.  An alternate definition of the macro would expand to
 627    something which executes the statement once.  */
 628
 629 #define FOR_EACH_FRAME(list_var, frame_var)                     \
 630   for ((list_var) = Vframe_list;                                \
 631        (CONSP (list_var)                                        \
 632         && (frame_var = XCAR (list_var), 1));           \
 633        list_var = XCDR (list_var))
 634
 635
 636 extern Lisp_Object Qframep, Qframe_live_p, Qicon;
 637
 638 extern struct frame *last_nonminibuf_frame;
 639
 640 extern struct frame *make_terminal_frame P_ ((void));
 641 extern struct frame *make_frame P_ ((int));
 642 #ifdef HAVE_WINDOW_SYSTEM
 643 extern struct frame *make_minibuffer_frame P_ ((void));
 644 extern struct frame *make_frame_without_minibuffer P_ ((Lisp_Object,
 645                                                         struct kboard *,
 646                                                         Lisp_Object));
 647 #endif /* HAVE_WINDOW_SYSTEM */
 648 extern int other_visible_frames P_ ((struct frame *));
 649
 650 extern Lisp_Object Vframe_list;
 651 extern Lisp_Object Vdefault_frame_alist;
 652
 653 extern Lisp_Object Vterminal_frame;
 654 \f
 655 /* Device-independent scroll bar stuff.  */
 656
 657 /* Return the starting column (zero-based) of the vertical scroll bar
 658    for window W.  The column before this one is the last column we can
 659    use for text.  If the window touches the right edge of the frame,
 660    we have extra space allocated for it.  Otherwise, the scroll bar
 661    takes over the window's rightmost columns.  */
 662
 663 #define WINDOW_VERTICAL_SCROLL_BAR_COLUMN(w) \
 664   (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (XFRAME (WINDOW_FRAME (w))) ? \
 665     (((XINT ((w)->left) + XINT ((w)->width)) \
 666       < FRAME_WIDTH (XFRAME (WINDOW_FRAME (w)))) \
 667      ? (XINT ((w)->left) + XINT ((w)->width) \
 668        - FRAME_SCROLL_BAR_COLS (XFRAME (WINDOW_FRAME (w)))) \
 669      : FRAME_WIDTH (XFRAME (WINDOW_FRAME (w)))) \
 670   : XINT ((w)->left))
 671
 672 /* Return the height in lines of the vertical scroll bar in w.  If the
 673    window has a mode line, don't make the scroll bar extend that far.  */
 674
 675 #define WINDOW_VERTICAL_SCROLL_BAR_HEIGHT(w) (window_internal_height (w))
 676
 677 /* The currently selected frame.  */
 678
 679 extern Lisp_Object selected_frame;
 680
 681 /* Value is a pointer to the selected frame.  If the selected frame
 682    isn't life, abort.  */
 683
 684 #define SELECTED_FRAME()                                \
 685      ((FRAMEP (selected_frame)                          \
 686        && FRAME_LIVE_P (XFRAME (selected_frame)))       \
 687       ? XFRAME (selected_frame)                         \
 688       : (struct frame *) (abort (), 0))
 689
 690 \f
 691 /***********************************************************************
 692                         Display-related Macros
 693  ***********************************************************************/
 694
 695 /* Canonical y-unit on frame F.  This value currently equals the line
 696    height of the frame.  Terminal specific header files are expected
 697    to define the macro FRAME_LINE_HEIGHT.  */
 698
 699 #define CANON_Y_UNIT(F) \
 700      (FRAME_WINDOW_P (F) ? FRAME_LINE_HEIGHT (F) : 1)
 701
 702 /* Canonical x-unit on frame F.  This is currently equal to the width
 703    of the default font of F.  Terminal specific headers are expected
 704    to define the macro FRAME_DEFAULT_FONT_WIDTH.  */
 705
 706 #define CANON_X_UNIT(F) \
 707      (FRAME_WINDOW_P (F) ? FRAME_DEFAULT_FONT_WIDTH (F) : 1)
 708
 709 /* Pixel width of areas used to display truncation marks, continuation
 710    marks, overlay arrows.  This is 0 for terminal frames.  */
 711
 712 #ifdef HAVE_WINDOW_SYSTEM
 713 #define FRAME_FLAGS_AREA_COLS(F) \
 714      (FRAME_WINDOW_P ((F)) ? FRAME_X_FLAGS_AREA_COLS ((F)) : 0)
 715 #define FRAME_FLAGS_AREA_WIDTH(F) FRAME_X_FLAGS_AREA_WIDTH (F)
 716 #define FRAME_LEFT_FLAGS_AREA_WIDTH(F) FRAME_X_LEFT_FLAGS_AREA_WIDTH (F)
 717
 718 #else
 719 #define FRAME_FLAGS_AREA_WIDTH(F)       0
 720 #define FRAME_FLAGS_AREA_COLS(F)        0
 721 #define FRAME_LEFT_FLAGS_AREA_WIDTH(F)  0
 722 #endif
 723
 724
 725
 726 \f
 727 /***********************************************************************
 728             Conversion between canonical units and pixels
 729  ***********************************************************************/
 730
 731 /* Canonical x-values are fractions of CANON_X_UNIT, canonical y-unit
 732    are fractions of CANON_Y_UNIT of a frame.  Both are represented as
 733    Lisp numbers, i.e. integers or floats.  */
 734
 735 /* Convert canonical value X to pixels.  F is the frame whose
 736    canonical char width is to be used.  X must be a Lisp integer or
 737    float.  Value is a C integer.  */
 738
 739 #define PIXEL_X_FROM_CANON_X(F, X)                      \
 740      (INTEGERP (X)                                      \
 741       ? XINT (X) * CANON_X_UNIT (F)                     \
 742       : (int) (XFLOAT_DATA (X) * CANON_X_UNIT (F)))
 743
 744 /* Convert canonical value Y to pixels.  F is the frame whose
 745    canonical character height is to be used.  X must be a Lisp integer
 746    or float.  Value is a C integer.  */
 747
 748 #define PIXEL_Y_FROM_CANON_Y(F, Y)                      \
 749      (INTEGERP (Y)                                      \
 750       ? XINT (Y) * CANON_Y_UNIT (F)                     \
 751       : (int) (XFLOAT_DATA (Y) * CANON_Y_UNIT (F)))
 752
 753 /* Convert pixel-value X to canonical units.  F is the frame whose
 754    canonical character width is to be used.  X is a C integer.  Result
 755    is a Lisp float if X is not a multiple of the canon width,
 756    otherwise it's a Lisp integer.  */
 757
 758 #define CANON_X_FROM_PIXEL_X(F, X)                      \
 759      ((X) % CANON_X_UNIT (F) != 0                       \
 760       ? make_float ((double) (X) / CANON_X_UNIT (F))    \
 761       : make_number ((X) / CANON_X_UNIT (F)))
 762
 763 /* Convert pixel-value Y to canonical units.  F is the frame whose
 764    canonical character height is to be used.  Y is a C integer.
 765    Result is a Lisp float if Y is not a multiple of the canon width,
 766    otherwise it's a Lisp integer.  */
 767
 768 #define CANON_Y_FROM_PIXEL_Y(F, Y)                      \
 769      ((Y) % CANON_Y_UNIT (F)                            \
 770       ? make_float ((double) (Y) / CANON_Y_UNIT (F))    \
 771       : make_number ((Y) / CANON_Y_UNIT (F)))
 772
 773 #endif /* not defined _FRAME_H_ */