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