src/frame.h

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