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 #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 desired_tool_bar_items, current_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_desired_tool_bar_items;
 210   int n_current_tool_bar_items;
 211
 212   /* A buffer for decode_mode_line. */
 213   char *decode_mode_spec_buffer;
 214
 215   /* See do_line_insertion_deletion_costs for info on these arrays. */
 216   /* Cost of inserting 1 line on this frame */
 217   int *insert_line_cost;
 218   /* Cost of deleting 1 line on this frame */
 219   int *delete_line_cost;
 220   /* Cost of inserting n lines on this frame */
 221   int *insert_n_lines_cost;
 222   /* Cost of deleting n lines on this frame */
 223   int *delete_n_lines_cost;
 224
 225   /* Size of this frame, in units of characters.  */
 226   EMACS_INT height;
 227   EMACS_INT width;
 228   EMACS_INT window_width;
 229   EMACS_INT window_height;
 230
 231   /* New height and width for pending size change.  0 if no change pending.  */
 232   int new_height, new_width;
 233
 234   /* The output method says how the contents of this frame
 235      are displayed.  It could be using termcap, or using an X window.  */
 236   enum output_method output_method;
 237
 238   /* A structure of auxiliary data used for displaying the contents.
 239      struct x_output is used for X window frames;
 240      it is defined in xterm.h.
 241      struct w32_output is used for W32 window frames;
 242      it is defined in w32term.h.  */
 243   union output_data
 244   {
 245     struct x_output *x;
 246     struct w32_output *w32;
 247     struct mac_output *mac;
 248     EMACS_INT nothing;
 249   }
 250   output_data;
 251
 252 #ifdef MULTI_KBOARD
 253   /* A pointer to the kboard structure associated with this frame.
 254      For termcap frames, this points to initial_kboard.  For X frames,
 255      it will be the same as display.x->display_info->kboard.  */
 256   struct kboard *kboard;
 257 #endif
 258
 259   /* Number of lines of menu bar.  */
 260   int menu_bar_lines;
 261
 262 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
 263   /* Nonzero means using a menu bar that comes from the X toolkit.  */
 264   int external_menu_bar;
 265 #endif
 266
 267   /* Nonzero if last attempt at redisplay on this frame was preempted.  */
 268   char display_preempted;
 269
 270   /* visible is nonzero if the frame is currently displayed; we check
 271      it to see if we should bother updating the frame's contents.
 272      DON'T SET IT DIRECTLY; instead, use FRAME_SET_VISIBLE.
 273
 274      Note that, since invisible frames aren't updated, whenever a
 275      frame becomes visible again, it must be marked as garbaged.  The
 276      FRAME_SAMPLE_VISIBILITY macro takes care of this.
 277
 278      On Windows NT/9X, to avoid wasting effort updating visible frames
 279      that are actually completely obscured by other windows on the
 280      display, we bend the meaning of visible slightly: if greater than
 281      1, then the frame is obscured - we still consider it to be
 282      "visible" as seen from lisp, but we don't bother updating it.  We
 283      must take care to garbage the frame when it ceaces to be obscured
 284      though.  Note that these semantics are only used on NT/9X.
 285
 286      iconified is nonzero if the frame is currently iconified.
 287
 288      Asynchronous input handlers should NOT change these directly;
 289      instead, they should change async_visible or async_iconified, and
 290      let the FRAME_SAMPLE_VISIBILITY macro set visible and iconified
 291      at the next redisplay.
 292
 293      These should probably be considered read-only by everyone except
 294      FRAME_SAMPLE_VISIBILITY.
 295
 296      These two are mutually exclusive.  They might both be zero, if the
 297      frame has been made invisible without an icon.  */
 298   char visible, iconified;
 299
 300   /* Asynchronous input handlers change these, and
 301      FRAME_SAMPLE_VISIBILITY copies them into visible and iconified.
 302      See FRAME_SAMPLE_VISIBILITY, below.  */
 303   volatile char async_visible, async_iconified;
 304
 305   /* Nonzero if this frame should be redrawn.  */
 306   volatile 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   /* Nonzero if the mouse has moved on this display
 363      since the last time we checked.  */
 364   char mouse_moved;
 365
 366   /* Exponent for gamma correction of colors.  1/(VIEWING_GAMMA *
 367      SCREEN_GAMMA) where viewing_gamma is 0.4545 and SCREEN_GAMMA is a
 368      frame parameter.  0 means don't do gamma correction.  */
 369   double gamma;
 370
 371   /* Additional space to put between text lines on this frame.  */
 372   int extra_line_spacing;
 373 };
 374
 375 #ifdef MULTI_KBOARD
 376 #define FRAME_KBOARD(f) ((f)->kboard)
 377 #else
 378 #define FRAME_KBOARD(f) (&the_only_kboard)
 379 #endif
 380
 381 typedef struct frame *FRAME_PTR;
 382
 383 #define XFRAME(p) (eassert (GC_FRAMEP(p)),(struct frame *) XPNTR (p))
 384 #define XSETFRAME(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_FRAME))
 385
 386 /* Given a window, return its frame as a Lisp_Object.  */
 387 #define WINDOW_FRAME(w) (w)->frame
 388
 389 /* Test a frame for particular kinds of display methods.  */
 390 #define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap)
 391 #define FRAME_X_P(f) ((f)->output_method == output_x_window)
 392 #define FRAME_W32_P(f) ((f)->output_method == output_w32)
 393 #define FRAME_MSDOS_P(f) ((f)->output_method == output_msdos_raw)
 394 #define FRAME_MAC_P(f) ((f)->output_method == output_mac)
 395
 396 /* FRAME_WINDOW_P tests whether the frame is a window, and is
 397    defined to be the predicate for the window system being used.  */
 398
 399 #ifdef HAVE_X_WINDOWS
 400 #define FRAME_WINDOW_P(f) FRAME_X_P (f)
 401 #endif
 402 #ifdef HAVE_NTGUI
 403 #define FRAME_WINDOW_P(f) FRAME_W32_P (f)
 404 #endif
 405 #ifdef macintosh
 406 #define FRAME_WINDOW_P(f) FRAME_MAC_P (f)
 407 #endif
 408 #ifndef FRAME_WINDOW_P
 409 #define FRAME_WINDOW_P(f) (0)
 410 #endif
 411
 412 /* Nonzero if frame F is still alive (not deleted).  */
 413 #define FRAME_LIVE_P(f) ((f)->output_data.nothing != 0)
 414
 415 /* Nonzero if frame F is a minibuffer-only frame.  */
 416 #define FRAME_MINIBUF_ONLY_P(f) \
 417   EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f))
 418
 419 /* Nonzero if frame F contains a minibuffer window.
 420    (If this is 0, F must use some other minibuffer window.)  */
 421 #define FRAME_HAS_MINIBUF_P(f) ((f)->has_minibuffer)
 422 #define FRAME_HEIGHT(f) (f)->height
 423
 424 /* Width of frame F, measured in character columns,
 425    not including scroll bars if any.  */
 426 #define FRAME_WIDTH(f) (f)->width
 427
 428 /* Number of lines of frame F used for menu bar.
 429    This is relevant on terminal frames and on
 430    X Windows when not using the X toolkit.
 431    These lines are counted in FRAME_HEIGHT.  */
 432 #define FRAME_MENU_BAR_LINES(f) (f)->menu_bar_lines
 433
 434 /* Number of lines of frame F used for the tool-bar.  */
 435
 436 #define FRAME_TOOL_BAR_LINES(f) (f)->tool_bar_lines
 437
 438 /* Lines above the top-most window in frame F.  */
 439
 440 #define FRAME_TOP_MARGIN(F) \
 441      (FRAME_MENU_BAR_LINES (F) + FRAME_TOOL_BAR_LINES (F))
 442
 443 /* Nonzero if this frame should display a menu bar
 444    in a way that does not use any text lines.  */
 445 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
 446 #define FRAME_EXTERNAL_MENU_BAR(f) (f)->external_menu_bar
 447 #else
 448 #define FRAME_EXTERNAL_MENU_BAR(f) 0
 449 #endif
 450 #define FRAME_VISIBLE_P(f) ((f)->visible != 0)
 451
 452 /* Nonzero if frame F is currently visible but hidden.  */
 453 #define FRAME_OBSCURED_P(f) ((f)->visible > 1)
 454
 455 /* Nonzero if frame F is currently iconified.  */
 456 #define FRAME_ICONIFIED_P(f) (f)->iconified
 457
 458 #define FRAME_SET_VISIBLE(f,p) \
 459   ((f)->async_visible = (p), FRAME_SAMPLE_VISIBILITY (f))
 460 #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1, f->garbaged = 1)
 461 #define FRAME_GARBAGED_P(f) (f)->garbaged
 462
 463 /* Nonzero means do not allow splitting this frame's window.  */
 464 #define FRAME_NO_SPLIT_P(f) (f)->no_split
 465
 466 /* Not really implemented.  */
 467 #define FRAME_WANTS_MODELINE_P(f) (f)->wants_modeline
 468
 469 /* Nonzero if a size change has been requested for frame F
 470    but not yet really put into effect.  This can be true temporarily
 471    when an X event comes in at a bad time.  */
 472 #define FRAME_WINDOW_SIZES_CHANGED(f) (f)->window_sizes_changed
 473 /* When a size change is pending, these are the requested new sizes.  */
 474 #define FRAME_NEW_HEIGHT(f) (f)->new_height
 475 #define FRAME_NEW_WIDTH(f) (f)->new_width
 476
 477 /* The minibuffer window of frame F, if it has one; otherwise nil.  */
 478 #define FRAME_MINIBUF_WINDOW(f) (f)->minibuffer_window
 479
 480 /* The root window of the window tree of frame F.  */
 481 #define FRAME_ROOT_WINDOW(f) (f)->root_window
 482
 483 /* The currently selected window of the window tree of frame F.  */
 484 #define FRAME_SELECTED_WINDOW(f) (f)->selected_window
 485
 486 #define FRAME_INSERT_COST(f) (f)->insert_line_cost
 487 #define FRAME_DELETE_COST(f) (f)->delete_line_cost
 488 #define FRAME_INSERTN_COST(f) (f)->insert_n_lines_cost
 489 #define FRAME_DELETEN_COST(f) (f)->delete_n_lines_cost
 490 #define FRAME_MESSAGE_BUF(f) (f)->message_buf
 491 #define FRAME_SCROLL_BOTTOM_VPOS(f) (f)->scroll_bottom_vpos
 492 #define FRAME_FOCUS_FRAME(f) (f)->focus_frame
 493
 494 /* Nonzero if frame F supports scroll bars.
 495    If this is zero, then it is impossible to enable scroll bars
 496    on frame F.  */
 497 #define FRAME_CAN_HAVE_SCROLL_BARS(f) ((f)->can_have_scroll_bars)
 498
 499 /* This frame slot says whether scroll bars are currently enabled for frame F,
 500    and which side they are on.  */
 501 #define FRAME_VERTICAL_SCROLL_BAR_TYPE(f) ((f)->vertical_scroll_bar_type)
 502 #define FRAME_HAS_VERTICAL_SCROLL_BARS(f) \
 503      ((f)->vertical_scroll_bar_type != vertical_scroll_bar_none)
 504 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT(f) \
 505      ((f)->vertical_scroll_bar_type == vertical_scroll_bar_left)
 506 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT(f) \
 507      ((f)->vertical_scroll_bar_type == vertical_scroll_bar_right)
 508
 509 /* Width that a scroll bar in frame F should have, if there is one.
 510    Measured in pixels.
 511    If scroll bars are turned off, this is still nonzero.  */
 512 #define FRAME_SCROLL_BAR_PIXEL_WIDTH(f) ((f)->scroll_bar_pixel_width)
 513
 514 /* Width that a scroll bar in frame F should have, if there is one.
 515    Measured in columns (characters).
 516    If scroll bars are turned off, this is still nonzero.  */
 517 #define FRAME_SCROLL_BAR_COLS(f) ((f)->scroll_bar_cols)
 518
 519 /* Width of a scroll bar in frame F, measured in columns (characters),
 520    but only if scroll bars are on the left.
 521    If scroll bars are on the right in this frame, it is 0.  */
 522 #define FRAME_LEFT_SCROLL_BAR_WIDTH(f) \
 523      (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \
 524       ? FRAME_SCROLL_BAR_COLS (f) \
 525       : 0)
 526
 527 /* Width of a scroll bar in frame F, measured in columns (characters).  */
 528 #define FRAME_SCROLL_BAR_WIDTH(f) \
 529      (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \
 530       ? FRAME_SCROLL_BAR_COLS (f) \
 531       : 0)
 532
 533 /* Total width of frame F, in columns (characters),
 534    including the width used by scroll bars if any.  */
 535 #define FRAME_WINDOW_WIDTH(f) ((f)->window_width)
 536
 537 /* Set the width of frame F to VAL.
 538    VAL is the width of a full-frame window,
 539    not including scroll bars.  */
 540 #define SET_FRAME_WIDTH(f, val)                                         \
 541      ((f)->width = (val),                                               \
 542       (f)->window_width = FRAME_WINDOW_WIDTH_ARG (f, (f)->width))
 543
 544 /* Given a value WIDTH for frame F's nominal width,
 545    return the value that FRAME_WINDOW_WIDTH should have.  */
 546 #define FRAME_WINDOW_WIDTH_ARG(f, width)        \
 547      ((width)                                   \
 548       + FRAME_SCROLL_BAR_WIDTH (f)              \
 549       + FRAME_FLAGS_AREA_COLS (f))
 550
 551 /* Maximum + 1 legitimate value for FRAME_CURSOR_X.  */
 552 #define FRAME_CURSOR_X_LIMIT(f) \
 553      (FRAME_WIDTH (f) + FRAME_LEFT_SCROLL_BAR_WIDTH (f))
 554
 555 /* Nonzero if frame F has scroll bars.  */
 556 #define FRAME_SCROLL_BARS(f) ((f)->scroll_bars)
 557
 558 #define FRAME_CONDEMNED_SCROLL_BARS(f) ((f)->condemned_scroll_bars)
 559 #define FRAME_MENU_BAR_ITEMS(f) ((f)->menu_bar_items)
 560 #define FRAME_COST_BAUD_RATE(f) ((f)->cost_calculation_baud_rate)
 561
 562 /* Return a pointer to the face cache of frame F.  */
 563
 564 #define FRAME_FACE_CACHE(F)     (F)->face_cache
 565
 566 /* Return the size of message_buf of the frame F.  We multiply the
 567    width of the frame by 4 because multi-byte form may require at most
 568    4-byte for a character.  */
 569
 570 #define FRAME_MESSAGE_BUF_SIZE(f) (((int) (f)->width) * 4)
 571
 572 /* Emacs's redisplay code could become confused if a frame's
 573    visibility changes at arbitrary times.  For example, if a frame is
 574    visible while the desired glyphs are being built, but becomes
 575    invisible before they are updated, then some rows of the
 576    desired_glyphs will be left marked as enabled after redisplay is
 577    complete, which should never happen.  The next time the frame
 578    becomes visible, redisplay will probably barf.
 579
 580    Currently, there are no similar situations involving iconified, but
 581    the principle is the same.
 582
 583    So instead of having asynchronous input handlers directly set and
 584    clear the frame's visibility and iconification flags, they just set
 585    the async_visible and async_iconified flags; the redisplay code
 586    calls the FRAME_SAMPLE_VISIBILITY macro before doing any redisplay,
 587    which sets visible and iconified from their asynchronous
 588    counterparts.
 589
 590    Synchronous code must use the FRAME_SET_VISIBLE macro.
 591
 592    Also, if a frame used to be invisible, but has just become visible,
 593    it must be marked as garbaged, since redisplay hasn't been keeping
 594    up its contents.  */
 595
 596 #define FRAME_SAMPLE_VISIBILITY(f) \
 597   (((f)->async_visible && (f)->visible != (f)->async_visible) ? \
 598    SET_FRAME_GARBAGED (f) : 0, \
 599    (f)->visible = (f)->async_visible, \
 600    (f)->iconified = (f)->async_iconified)
 601
 602 #define CHECK_FRAME(x, i)                               \
 603      do {                                               \
 604        if (! FRAMEP (x))                                \
 605          x = wrong_type_argument (Qframep, (x));        \
 606      } while (0)
 607
 608 #define CHECK_LIVE_FRAME(x, i)                          \
 609      do {                                               \
 610        if (! FRAMEP (x)                                 \
 611            || ! FRAME_LIVE_P (XFRAME (x)))              \
 612          x = wrong_type_argument (Qframe_live_p, (x));  \
 613      } while (0)
 614
 615 /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
 616    `for' loop which iterates over the elements of Vframe_list.  The
 617    loop will set FRAME_VAR, a Lisp_Object, to each frame in
 618    Vframe_list in succession and execute the statement.  LIST_VAR
 619    should be a Lisp_Object too; it is used to iterate through the
 620    Vframe_list.
 621
 622    This macro is a holdover from a time when multiple frames weren't always
 623    supported.  An alternate definition of the macro would expand to
 624    something which executes the statement once.  */
 625
 626 #define FOR_EACH_FRAME(list_var, frame_var)                     \
 627   for ((list_var) = Vframe_list;                                \
 628        (CONSP (list_var)                                        \
 629         && (frame_var = XCAR (list_var), 1));           \
 630        list_var = XCDR (list_var))
 631
 632
 633 extern Lisp_Object Qframep, Qframe_live_p, Qicon;
 634
 635 extern struct frame *last_nonminibuf_frame;
 636
 637 extern struct frame *make_terminal_frame P_ ((void));
 638 extern struct frame *make_frame P_ ((int));
 639 #ifdef HAVE_WINDOW_SYSTEM
 640 extern struct frame *make_minibuffer_frame P_ ((void));
 641 extern struct frame *make_frame_without_minibuffer P_ ((Lisp_Object,
 642                                                         struct kboard *,
 643                                                         Lisp_Object));
 644 #endif /* HAVE_WINDOW_SYSTEM */
 645 extern int other_visible_frames P_ ((struct frame *));
 646
 647 extern Lisp_Object Vframe_list;
 648 extern Lisp_Object Vdefault_frame_alist;
 649
 650 extern Lisp_Object Vterminal_frame;
 651 \f
 652 /* Device-independent scroll bar stuff.  */
 653
 654 /* Return the starting column (zero-based) of the vertical scroll bar
 655    for window W.  The column before this one is the last column we can
 656    use for text.  If the window touches the right edge of the frame,
 657    we have extra space allocated for it.  Otherwise, the scroll bar
 658    takes over the window's rightmost columns.  */
 659
 660 #define WINDOW_VERTICAL_SCROLL_BAR_COLUMN(w) \
 661   (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (XFRAME (WINDOW_FRAME (w))) ? \
 662     (((XINT ((w)->left) + XINT ((w)->width)) \
 663       < FRAME_WIDTH (XFRAME (WINDOW_FRAME (w)))) \
 664      ? (XINT ((w)->left) + XINT ((w)->width) \
 665        - FRAME_SCROLL_BAR_COLS (XFRAME (WINDOW_FRAME (w)))) \
 666      : FRAME_WIDTH (XFRAME (WINDOW_FRAME (w)))) \
 667   : XINT ((w)->left))
 668
 669 /* Return the height in lines of the vertical scroll bar in w.  If the
 670    window has a mode line, don't make the scroll bar extend that far.  */
 671
 672 #define WINDOW_VERTICAL_SCROLL_BAR_HEIGHT(w) (window_internal_height (w))
 673
 674 /* The currently selected frame.  */
 675
 676 extern Lisp_Object selected_frame;
 677
 678 /* Value is a pointer to the selected frame.  If the selected frame
 679    isn't live, abort.  */
 680
 681 #define SELECTED_FRAME()                                \
 682      ((FRAMEP (selected_frame)                          \
 683        && FRAME_LIVE_P (XFRAME (selected_frame)))       \
 684       ? XFRAME (selected_frame)                         \
 685       : (abort (), (struct frame *) 0))
 686
 687 \f
 688 /***********************************************************************
 689                         Display-related Macros
 690  ***********************************************************************/
 691
 692 /* Canonical y-unit on frame F.  This value currently equals the line
 693    height of the frame.  Terminal specific header files are expected
 694    to define the macro FRAME_LINE_HEIGHT.  */
 695
 696 #define CANON_Y_UNIT(F) \
 697      (FRAME_WINDOW_P (F) ? FRAME_LINE_HEIGHT (F) : 1)
 698
 699 /* Canonical x-unit on frame F.  This is currently equal to the width
 700    of the default font of F.  Terminal specific headers are expected
 701    to define the macro FRAME_DEFAULT_FONT_WIDTH.  */
 702
 703 #define CANON_X_UNIT(F) \
 704      (FRAME_WINDOW_P (F) ? FRAME_DEFAULT_FONT_WIDTH (F) : 1)
 705
 706 /* Pixel width of areas used to display truncation marks, continuation
 707    marks, overlay arrows.  This is 0 for terminal frames.  */
 708
 709 #ifdef HAVE_WINDOW_SYSTEM
 710
 711 #define FRAME_FLAGS_AREA_COLS(F) \
 712      (FRAME_WINDOW_P (F) ? FRAME_X_FLAGS_AREA_COLS (F) : 0)
 713 #define FRAME_FLAGS_AREA_WIDTH(F) \
 714      (FRAME_WINDOW_P (F) ? FRAME_X_FLAGS_AREA_WIDTH (F) : 0)
 715 #define FRAME_LEFT_FLAGS_AREA_WIDTH(F) \
 716      (FRAME_WINDOW_P (F) ? FRAME_X_LEFT_FLAGS_AREA_WIDTH (F) : 0)
 717
 718 #else /* not HAVE_WINDOW_SYSTEM */
 719
 720 #define FRAME_FLAGS_AREA_WIDTH(F)       0
 721 #define FRAME_FLAGS_AREA_COLS(F)        0
 722 #define FRAME_LEFT_FLAGS_AREA_WIDTH(F)  0
 723
 724 #endif /* not HAVE_WINDOW_SYSTEM */
 725
 726
 727
 728 \f
 729 /***********************************************************************
 730             Conversion between canonical units and pixels
 731  ***********************************************************************/
 732
 733 /* Canonical x-values are fractions of CANON_X_UNIT, canonical y-unit
 734    are fractions of CANON_Y_UNIT of a frame.  Both are represented as
 735    Lisp numbers, i.e. integers or floats.  */
 736
 737 /* Convert canonical value X to pixels.  F is the frame whose
 738    canonical char width is to be used.  X must be a Lisp integer or
 739    float.  Value is a C integer.  */
 740
 741 #define PIXEL_X_FROM_CANON_X(F, X)                      \
 742      (INTEGERP (X)                                      \
 743       ? XINT (X) * CANON_X_UNIT (F)                     \
 744       : (int) (XFLOAT_DATA (X) * CANON_X_UNIT (F)))
 745
 746 /* Convert canonical value Y to pixels.  F is the frame whose
 747    canonical character height is to be used.  X must be a Lisp integer
 748    or float.  Value is a C integer.  */
 749
 750 #define PIXEL_Y_FROM_CANON_Y(F, Y)                      \
 751      (INTEGERP (Y)                                      \
 752       ? XINT (Y) * CANON_Y_UNIT (F)                     \
 753       : (int) (XFLOAT_DATA (Y) * CANON_Y_UNIT (F)))
 754
 755 /* Convert pixel-value X to canonical units.  F is the frame whose
 756    canonical character width is to be used.  X is a C integer.  Result
 757    is a Lisp float if X is not a multiple of the canon width,
 758    otherwise it's a Lisp integer.  */
 759
 760 #define CANON_X_FROM_PIXEL_X(F, X)                      \
 761      ((X) % CANON_X_UNIT (F) != 0                       \
 762       ? make_float ((double) (X) / CANON_X_UNIT (F))    \
 763       : make_number ((X) / CANON_X_UNIT (F)))
 764
 765 /* Convert pixel-value Y to canonical units.  F is the frame whose
 766    canonical character height is to be used.  Y is a C integer.
 767    Result is a Lisp float if Y is not a multiple of the canon width,
 768    otherwise it's a Lisp integer.  */
 769
 770 #define CANON_Y_FROM_PIXEL_Y(F, Y)                      \
 771      ((Y) % CANON_Y_UNIT (F)                            \
 772       ? make_float ((double) (Y) / CANON_Y_UNIT (F))    \
 773       : make_number ((Y) / CANON_Y_UNIT (F)))
 774
 775 #endif /* not defined _FRAME_H_ */