src/frame.h

   1 /* Define frame-object for GNU Emacs.
   2    Copyright (C) 1993, 1994 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 \f
  22 /* Miscellanea.  */
  23
  24 /* Nonzero means don't assume anything about current
  25    contents of actual terminal frame */
  26 extern int frame_garbaged;
  27
  28 /* Nonzero means FRAME_MESSAGE_BUF (selected_frame) is being used by
  29    print.  */
  30 extern int message_buf_print;
  31
  32 \f
  33 /* The structure representing a frame.
  34
  35    We declare this even if MULTI_FRAME is not defined, because when
  36    we lack multi-frame support, we use one instance of this structure
  37    to represent the one frame we support.  This is cleaner than
  38    having miscellaneous random variables scattered about.  */
  39
  40 enum output_method
  41 { output_termcap, output_x_window, output_msdos_raw, output_win32 };
  42
  43 struct frame
  44 {
  45   EMACS_INT size;
  46   struct Lisp_Vector *next;
  47
  48   /* All Lisp_Object components must come first.
  49      Only EMACS_INT values can be intermixed with them.
  50      That ensures they are all aligned normally.  */
  51
  52   /* Name of this frame: a Lisp string.  It is used for looking up resources,
  53      as well as for the title in some cases.  */
  54   Lisp_Object name;
  55
  56   /* The name to use for the icon, the last time
  57      it was refreshed.  nil means not explicitly specified.  */
  58   Lisp_Object icon_name;
  59
  60   /* This is the frame title specified explicitly, if any.
  61      Usually it is nil.  */
  62   Lisp_Object title;
  63
  64   /* The frame which should receive keystrokes that occur in this
  65      frame, or nil if they should go to the frame itself.  This is
  66      usually nil, but if the frame is minibufferless, we can use this
  67      to redirect keystrokes to a surrogate minibuffer frame when
  68      needed.
  69
  70      Note that a value of nil is different than having the field point
  71      to the frame itself.  Whenever the Fselect_frame function is used
  72      to shift from one frame to the other, any redirections to the
  73      original frame are shifted to the newly selected frame; if
  74      focus_frame is nil, Fselect_frame will leave it alone.  */
  75   Lisp_Object focus_frame;
  76
  77   /* This frame's root window.  Every frame has one.
  78      If the frame has only a minibuffer window, this is it.
  79      Otherwise, if the frame has a minibuffer window, this is its sibling.  */
  80   Lisp_Object root_window;
  81
  82   /* This frame's selected window.
  83      Each frame has its own window hierarchy
  84      and one of the windows in it is selected within the frame.
  85      The selected window of the selected frame is Emacs's selected window.  */
  86   Lisp_Object selected_window;
  87
  88   /* This frame's minibuffer window.
  89      Most frames have their own minibuffer windows,
  90      but only the selected frame's minibuffer window
  91      can actually appear to exist.  */
  92   Lisp_Object minibuffer_window;
  93
  94   /* Parameter alist of this frame.
  95      These are the parameters specified when creating the frame
  96      or modified with modify-frame-parameters.  */
  97   Lisp_Object param_alist;
  98
  99   /* List of scroll bars on this frame.
 100      Actually, we don't specify exactly what is stored here at all; the
 101      scroll bar implementation code can use it to store anything it likes.
 102      This field is marked by the garbage collector.  It is here
 103      instead of in the `display' structure so that the garbage
 104      collector doesn't need to look inside the window-system-dependent
 105      structure.  */
 106   Lisp_Object scroll_bars;
 107   Lisp_Object condemned_scroll_bars;
 108
 109   /* List of elements to display in the menu bar.
 110      The elements have the form (KEY STRING . nil) to start;
 111      when they are displayed, the hpos of the left edge goes in the cddr.  */
 112   Lisp_Object menu_bar_items;
 113
 114   /* Alist of elements (FACE-NAME . FACE-VECTOR-DATA).  */
 115   Lisp_Object face_alist;
 116
 117   /* A vector that records the entire structure of this frame's menu bar.
 118      For the format of the data, see extensive comments in xmenu.c.
 119      Only the X toolkit version uses this.  */
 120   Lisp_Object menu_bar_vector;
 121   /* Number of elements in the vector that have meaningful data.  */
 122   EMACS_INT menu_bar_items_used;
 123
 124   /* Predicate for selecting buffers for other-buffer.  */
 125   Lisp_Object buffer_predicate;
 126
 127   /* Beyond here, there should be no more Lisp_Object components.  */
 128
 129
 130   /* A buffer to hold the frame's name.  We can't use the Lisp string's
 131      pointer (`name', above) because it might get relocated.  */
 132   char *namebuf;
 133
 134   /* glyphs as they appear on the frame */
 135   struct frame_glyphs *current_glyphs;
 136
 137   /* glyphs we'd like to appear on the frame */
 138   struct frame_glyphs *desired_glyphs;
 139
 140   /* See do_line_insertion_deletion_costs for info on these arrays. */
 141   /* Cost of inserting 1 line on this frame */
 142   int *insert_line_cost;
 143   /* Cost of deleting 1 line on this frame */
 144   int *delete_line_cost;
 145   /* Cost of inserting n lines on this frame */
 146   int *insert_n_lines_cost;
 147   /* Cost of deleting n lines on this frame */
 148   int *delete_n_lines_cost;
 149
 150   /* glyphs for the mode line */
 151   struct frame_glyphs *temp_glyphs;
 152
 153   /* Intended cursor position of this frame.
 154      Measured in characters, counting from upper left corner
 155      within the frame.  */
 156   int cursor_x;
 157   int cursor_y;
 158
 159   /* Actual cursor position of this frame, and the character under it.
 160      (Not used for terminal frames.)  */
 161   int phys_cursor_x;
 162   int phys_cursor_y;
 163   /* This is handy for undrawing the cursor, because current_glyphs is
 164      not always accurate when in do_scrolling.  */
 165   GLYPH phys_cursor_glyph;
 166
 167   /* Size of this frame, in units of characters.  */
 168   EMACS_INT height;
 169   EMACS_INT width;
 170
 171   /* New height and width for pending size change.  0 if no change pending.  */
 172   int new_height, new_width;
 173
 174   /* The output method says how the contents of this frame
 175      are displayed.  It could be using termcap, or using an X window.  */
 176   enum output_method output_method;
 177
 178   /* A structure of auxiliary data used for displaying the contents.
 179      struct x_output is used for X window frames;
 180      it is defined in xterm.h.
 181      struct win32_output is used for Win32 window frames;
 182      it is defined in w32term.h.  */
 183   union output_data { struct x_output *x; struct win32_output *win32; int nothing; } output_data;
 184
 185 #ifdef MULTI_KBOARD
 186   /* A pointer to the kboard structure associated with this frame.
 187      For termcap frames, this points to initial_kboard.  For X frames,
 188      it will be the same as display.x->display_info->kboard.  */
 189   struct kboard *kboard;
 190 #endif
 191
 192   /* Number of lines of menu bar.  */
 193   int menu_bar_lines;
 194
 195 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
 196   /* Nonzero means using a menu bar that comes from the X toolkit.  */
 197   int external_menu_bar;
 198 #endif
 199
 200   /* Nonzero if last attempt at redisplay on this frame was preempted.  */
 201   char display_preempted;
 202
 203   /* visible is nonzero if the frame is currently displayed; we check
 204      it to see if we should bother updating the frame's contents.
 205      DON'T SET IT DIRECTLY; instead, use FRAME_SET_VISIBLE.
 206
 207      Note that, since invisible frames aren't updated, whenever a
 208      frame becomes visible again, it must be marked as garbaged.  The
 209      FRAME_SAMPLE_VISIBILITY macro takes care of this.
 210
 211      iconified is nonzero if the frame is currently iconified.
 212
 213      Asynchronous input handlers should NOT change these directly;
 214      instead, they should change async_visible or async_iconified, and
 215      let the FRAME_SAMPLE_VISIBILITY macro set visible and iconified
 216      at the next redisplay.
 217
 218      These should probably be considered read-only by everyone except
 219      FRAME_SAMPLE_VISIBILITY.
 220
 221      These two are mutually exclusive.  They might both be zero, if the
 222      frame has been made invisible without an icon.  */
 223   char visible, iconified;
 224
 225   /* Asynchronous input handlers change these, and
 226      FRAME_SAMPLE_VISIBILITY copies them into visible and iconified.
 227      See FRAME_SAMPLE_VISIBILITY, below.  */
 228 #ifdef __STDC__
 229   volatile
 230 #endif
 231   char async_visible, async_iconified;
 232
 233   /* Nonzero if this frame should be redrawn.  */
 234 #ifdef __STDC__
 235   volatile
 236 #endif
 237   char garbaged;
 238
 239   /* True if frame actually has a minibuffer window on it.
 240      0 if using a minibuffer window that isn't on this frame.  */
 241   char has_minibuffer;
 242
 243   /* 0 means, if this frame has just one window,
 244      show no modeline for that window.  */
 245   char wants_modeline;
 246
 247   /* Non-zero if the hardware device this frame is displaying on can
 248      support scroll bars.  */
 249   char can_have_scroll_bars;
 250
 251   /* If can_have_scroll_bars is non-zero, this is non-zero if we should
 252      actually display them on this frame.  */
 253   char has_vertical_scroll_bars;
 254
 255   /* Non-0 means raise this frame to the top of the heap when selected.  */
 256   char auto_raise;
 257
 258   /* Non-0 means lower this frame to the bottom of the stack when left.  */
 259   char auto_lower;
 260
 261   /* True if frame's root window can't be split.  */
 262   char no_split;
 263
 264   /* If this is set, then Emacs won't change the frame name to indicate
 265      the current buffer, etcetera.  If the user explicitly sets the frame
 266      name, this gets set.  If the user sets the name to Qnil, this is
 267      cleared.  */
 268   char explicit_name;
 269
 270   /* Nonzero if size of some window on this frame has changed.  */
 271   char window_sizes_changed;
 272
 273   /* Storage for messages to this frame. */
 274   char *message_buf;
 275
 276   /* Nonnegative if current redisplay should not do scroll computation
 277      for lines beyond a certain vpos.  This is the vpos.  */
 278   int scroll_bottom_vpos;
 279
 280   /* Width of the scroll bar, in pixels and in characters.
 281      scroll_bar_cols tracks scroll_bar_pixel_width if the latter is positive;
 282      a zero value in scroll_bar_pixel_width means to compute the actual width
 283      on the fly, using scroll_bar_cols and the current font width.  */
 284   int scroll_bar_pixel_width;
 285   int scroll_bar_cols;
 286
 287   /* The baud rate that was used to calculate costs for this frame.  */
 288   int cost_calculation_baud_rate;
 289
 290   /* Nonzero if the mouse has moved on this display
 291      since the last time we checked.  */
 292   char mouse_moved;
 293 };
 294
 295 #ifdef MULTI_KBOARD  /* Note that MULTI_KBOARD implies MULTI_FRAME */
 296 #define FRAME_KBOARD(f) ((f)->kboard)
 297 #else
 298 #define FRAME_KBOARD(f) (&the_only_kboard)
 299 #endif
 300
 301 #ifdef MULTI_FRAME
 302
 303 typedef struct frame *FRAME_PTR;
 304
 305 #define XFRAME(p) ((struct frame *) XPNTR (p))
 306 #define XSETFRAME(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_FRAME))
 307
 308 #define WINDOW_FRAME(w) (w)->frame
 309
 310 #define FRAME_X_P(f) ((f)->output_method == output_x_window)
 311 #define FRAME_WIN32_P(f) ((f)->output_method == output_win32)
 312
 313 /* FRAME_WINDOW_P tests whether the frame is a window, and is
 314    defined to be the predicate for the window system being used.  */
 315 #ifdef HAVE_X_WINDOWS
 316 #define FRAME_WINDOW_P(f) FRAME_X_P (f)
 317 #endif
 318 #ifdef HAVE_NTGUI
 319 #define FRAME_WINDOW_P(f) FRAME_WIN32_P (f)
 320 #endif
 321 #ifndef FRAME_WINDOW_P
 322 #define FRAME_WINDOW_P(f) (0)
 323 #endif
 324
 325 #define FRAME_LIVE_P(f) ((f)->output_data.nothing != 0)
 326 #define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap)
 327 #define FRAME_MINIBUF_ONLY_P(f) \
 328   EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f))
 329 #define FRAME_HAS_MINIBUF_P(f) ((f)->has_minibuffer)
 330 #define FRAME_CURRENT_GLYPHS(f) (f)->current_glyphs
 331 #define FRAME_DESIRED_GLYPHS(f) (f)->desired_glyphs
 332 #define FRAME_TEMP_GLYPHS(f) (f)->temp_glyphs
 333 #define FRAME_HEIGHT(f) (f)->height
 334 #define FRAME_WIDTH(f) (f)->width
 335 #define FRAME_NEW_HEIGHT(f) (f)->new_height
 336 #define FRAME_NEW_WIDTH(f) (f)->new_width
 337 #define FRAME_MENU_BAR_LINES(f) (f)->menu_bar_lines
 338 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
 339 #define FRAME_EXTERNAL_MENU_BAR(f) (f)->external_menu_bar
 340 #else
 341 #define FRAME_EXTERNAL_MENU_BAR(f) 0
 342 #endif
 343 #define FRAME_CURSOR_X(f) (f)->cursor_x
 344 #define FRAME_CURSOR_Y(f) (f)->cursor_y
 345 #define FRAME_VISIBLE_P(f) ((f)->visible != 0)
 346 #define FRAME_SET_VISIBLE(f,p) \
 347   ((f)->async_visible = (p), FRAME_SAMPLE_VISIBILITY (f))
 348 #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1, f->garbaged = 1)
 349 #define FRAME_GARBAGED_P(f) (f)->garbaged
 350 #define FRAME_NO_SPLIT_P(f) (f)->no_split
 351 #define FRAME_WANTS_MODELINE_P(f) (f)->wants_modeline
 352 #define FRAME_ICONIFIED_P(f) (f)->iconified
 353 #define FRAME_WINDOW_SIZES_CHANGED(f) (f)->window_sizes_changed
 354 #define FRAME_MINIBUF_WINDOW(f) (f)->minibuffer_window
 355 #define FRAME_ROOT_WINDOW(f) (f)->root_window
 356 #define FRAME_SELECTED_WINDOW(f) (f)->selected_window
 357 #define SET_GLYPHS_FRAME(glyphs,frame) ((glyphs)->frame = (frame))
 358 #define FRAME_INSERT_COST(f) (f)->insert_line_cost
 359 #define FRAME_DELETE_COST(f) (f)->delete_line_cost
 360 #define FRAME_INSERTN_COST(f) (f)->insert_n_lines_cost
 361 #define FRAME_DELETEN_COST(f) (f)->delete_n_lines_cost
 362 #define FRAME_MESSAGE_BUF(f) (f)->message_buf
 363 #define FRAME_SCROLL_BOTTOM_VPOS(f) (f)->scroll_bottom_vpos
 364 #define FRAME_FOCUS_FRAME(f) (f)->focus_frame
 365 #define FRAME_CAN_HAVE_SCROLL_BARS(f) ((f)->can_have_scroll_bars)
 366 #define FRAME_HAS_VERTICAL_SCROLL_BARS(f) ((f)->has_vertical_scroll_bars)
 367 #define FRAME_SCROLL_BAR_PIXEL_WIDTH(f) ((f)->scroll_bar_pixel_width)
 368 #define FRAME_SCROLL_BAR_COLS(f) ((f)->scroll_bar_cols)
 369 #define FRAME_SCROLL_BARS(f) ((f)->scroll_bars)
 370 #define FRAME_CONDEMNED_SCROLL_BARS(f) ((f)->condemned_scroll_bars)
 371 #define FRAME_MENU_BAR_ITEMS(f) ((f)->menu_bar_items)
 372 #define FRAME_COST_BAUD_RATE(f) ((f)->cost_calculation_baud_rate)
 373
 374 /* Emacs's redisplay code could become confused if a frame's
 375    visibility changes at arbitrary times.  For example, if a frame is
 376    visible while the desired glyphs are being built, but becomes
 377    invisible before they are updated, then some rows of the
 378    desired_glyphs will be left marked as enabled after redisplay is
 379    complete, which should never happen.  The next time the frame
 380    becomes visible, redisplay will probably barf.
 381
 382    Currently, there are no similar situations involving iconified, but
 383    the principle is the same.
 384
 385    So instead of having asynchronous input handlers directly set and
 386    clear the frame's visibility and iconification flags, they just set
 387    the async_visible and async_iconified flags; the redisplay code
 388    calls the FRAME_SAMPLE_VISIBILITY macro before doing any redisplay,
 389    which sets visible and iconified from their asynchronous
 390    counterparts.
 391
 392    Synchronous code must use the FRAME_SET_VISIBLE macro.
 393
 394    Also, if a frame used to be invisible, but has just become visible,
 395    it must be marked as garbaged, since redisplay hasn't been keeping
 396    up its contents.  */
 397 #define FRAME_SAMPLE_VISIBILITY(f) \
 398   (((f)->async_visible && ! (f)->visible) ? SET_FRAME_GARBAGED (f) : 0, \
 399    (f)->visible = (f)->async_visible, \
 400    (f)->iconified = (f)->async_iconified)
 401
 402 #define CHECK_FRAME(x, i)                               \
 403   {                                                     \
 404     if (! FRAMEP (x))                                   \
 405       x = wrong_type_argument (Qframep, (x));           \
 406   }
 407
 408 #define CHECK_LIVE_FRAME(x, i)                          \
 409   {                                                     \
 410     if (! FRAMEP (x)                                    \
 411         || ! FRAME_LIVE_P (XFRAME (x)))         \
 412       x = wrong_type_argument (Qframe_live_p, (x));     \
 413   }
 414
 415 /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
 416    `for' loop which iterates over the elements of Vframe_list.  The
 417    loop will set FRAME_VAR, a Lisp_Object, to each frame in
 418    Vframe_list in succession and execute the statement.  LIST_VAR
 419    should be a Lisp_Object too; it is used to iterate through the
 420    Vframe_list.
 421
 422    If MULTI_FRAME isn't defined, then this loop expands to something which
 423    executes the statement once.  */
 424 #define FOR_EACH_FRAME(list_var, frame_var)                     \
 425   for ((list_var) = Vframe_list;                                \
 426        (CONSP (list_var)                                        \
 427         && (frame_var = XCONS (list_var)->car, 1));             \
 428        list_var = XCONS (list_var)->cdr)
 429
 430
 431 extern Lisp_Object Qframep, Qframe_live_p, Qicon;
 432
 433 extern struct frame *selected_frame;
 434 extern struct frame *last_nonminibuf_frame;
 435
 436 extern struct frame *make_terminal_frame ();
 437 extern struct frame *make_frame ();
 438 extern struct frame *make_minibuffer_frame ();
 439 extern struct frame *make_frame_without_minibuffer ();
 440
 441 extern Lisp_Object Vframe_list;
 442 extern Lisp_Object Vdefault_frame_alist;
 443
 444 extern Lisp_Object Vterminal_frame;
 445 \f
 446 #else /* not MULTI_FRAME */
 447
 448 /* These definitions are used in a single-frame version of Emacs.  */
 449
 450 /* A frame we use to store all the data concerning the screen when we
 451    don't have multiple frames.  Remember, if you store any data in it
 452    which needs to be protected from GC, you should staticpro that
 453    element explicitly.  */
 454 extern struct frame the_only_frame;
 455
 456 typedef struct frame *FRAME_PTR;
 457 #ifdef __GNUC__
 458 /* A function call for always getting 0 is overkill, so... */
 459 #define WINDOW_FRAME(w) ({ Lisp_Object tem; XSETFASTINT (tem, 0); tem; })
 460 #else
 461 #define WINDOW_FRAME(w) (Fselected_frame ())
 462 #endif
 463 #define XSETFRAME(p, v) (p = WINDOW_FRAME (***bogus***))
 464 #define XFRAME(frame) (&the_only_frame)
 465
 466 extern FRAME_PTR selected_frame;
 467 extern FRAME_PTR last_nonminibuf_frame;
 468
 469 #define FRAME_LIVE_P(f) 1
 470 #ifdef MSDOS
 471 /* The following definitions could also be used in the non-MSDOS case,
 472    but the constants below lead to better code.  */
 473 #define FRAME_TERMCAP_P(f) (the_only_frame.output_method == output_termcap)
 474 #define FRAME_X_P(f) (the_only_frame.output_method != output_termcap)
 475 #else
 476 #define FRAME_TERMCAP_P(f) 1
 477 #define FRAME_X_P(f) 0
 478 #endif
 479 #define FRAME_WINDOW_P(f) FRAME_X_P (f)
 480 #define FRAME_MINIBUF_ONLY_P(f) 0
 481 #define FRAME_HAS_MINIBUF_P(f) 1
 482 #define FRAME_CURRENT_GLYPHS(f) (the_only_frame.current_glyphs)
 483 #define FRAME_DESIRED_GLYPHS(f) (the_only_frame.desired_glyphs)
 484 #define FRAME_TEMP_GLYPHS(f) (the_only_frame.temp_glyphs)
 485 #define FRAME_HEIGHT(f) (the_only_frame.height)
 486 #define FRAME_WIDTH(f) (the_only_frame.width)
 487 #define FRAME_NEW_HEIGHT(f) (the_only_frame.new_height)
 488 #define FRAME_NEW_WIDTH(f) (the_only_frame.new_width)
 489 #define FRAME_MENU_BAR_LINES(f) (the_only_frame.menu_bar_lines)
 490 #define FRAME_CURSOR_X(f) (the_only_frame.cursor_x)
 491 #define FRAME_CURSOR_Y(f) (the_only_frame.cursor_y)
 492 #define FRAME_SET_VISIBLE(f,p) (p)
 493 #define FRAME_VISIBLE_P(f) 1
 494 #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1)
 495 #define FRAME_GARBAGED_P(f) (frame_garbaged)
 496 #define FRAME_NO_SPLIT_P(f) 0
 497 #define FRAME_WANTS_MODELINE_P(f) 1
 498 #define FRAME_ICONIFIED_P(f) 0
 499 #define FRAME_WINDOW_SIZES_CHANGED(f) the_only_frame.window_sizes_changed
 500 #define FRAME_MINIBUF_WINDOW(f) (minibuf_window)
 501 #define FRAME_ROOT_WINDOW(f) (the_only_frame.root_window)
 502 #define FRAME_SELECTED_WINDOW(f) (selected_window)
 503 #define SET_GLYPHS_FRAME(glyphs,frame) do ; while (0)
 504 #define FRAME_INSERT_COST(frame)  (the_only_frame.insert_line_cost)
 505 #define FRAME_DELETE_COST(frame)  (the_only_frame.delete_line_cost)
 506 #define FRAME_INSERTN_COST(frame) (the_only_frame.insert_n_lines_cost)
 507 #define FRAME_DELETEN_COST(frame) (the_only_frame.delete_n_lines_cost)
 508 #define FRAME_MESSAGE_BUF(f) (the_only_frame.message_buf)
 509 #define FRAME_SCROLL_BOTTOM_VPOS(f) (the_only_frame.scroll_bottom_vpos)
 510 #define FRAME_FOCUS_FRAME(f) (Qnil)
 511 #define FRAME_CAN_HAVE_SCROLL_BARS(f) (the_only_frame.can_have_scroll_bars)
 512 #define FRAME_HAS_VERTICAL_SCROLL_BARS(f) \
 513   (the_only_frame.has_vertical_scroll_bars)
 514 #define FRAME_SCROLL_BAR_PIXEL_WIDTH(f) (the_only_frame.scroll_bar_pixel_width)
 515 #define FRAME_SCROLL_BAR_COLS(f) (the_only_frame.scroll_bar_cols)
 516 #define FRAME_SCROLL_BARS(f) (the_only_frame.scroll_bars)
 517 #define FRAME_CONDEMNED_SCROLL_BARS(f) (the_only_frame.condemned_scroll_bars)
 518 #define FRAME_MENU_BAR_ITEMS(f) (the_only_frame.menu_bar_items)
 519 #define FRAME_COST_BAUD_RATE(f) (the_only_frame.cost_calculation_baud_rate)
 520
 521 /* See comments in definition above.  */
 522 #define FRAME_SAMPLE_VISIBILITY(f) (0)
 523
 524 #define CHECK_FRAME(x, i) do; while (0)
 525 #define CHECK_LIVE_FRAME(x, y) do; while (0)
 526
 527 /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
 528    `for' loop which iterates over the elements of Vframe_list.  The
 529    loop will set FRAME_VAR, a Lisp_Object, to each frame in
 530    Vframe_list in succession and execute the statement.  LIST_VAR
 531    should be a Lisp_Object too; it is used to iterate through the
 532    Vframe_list.
 533
 534    If MULTI_FRAME _is_ defined, then this loop expands to a real
 535    `for' loop which traverses Vframe_list using LIST_VAR and
 536    FRAME_VAR.  */
 537 #define FOR_EACH_FRAME(list_var, frame_var)                     \
 538   for (list_var = Qt; frame_var = WINDOW_FRAME (***bogus***), ! NILP (list_var); list_var = Qnil)
 539
 540 #endif /* not MULTI_FRAME */
 541
 542 \f
 543 /* Device- and MULTI_FRAME-independent scroll bar stuff.  */
 544
 545 /* Return the starting column (zero-based) of the vertical scroll bar
 546    for window W.  The column before this one is the last column we can
 547    use for text.  If the window touches the right edge of the frame,
 548    we have extra space allocated for it.  Otherwise, the scroll bar
 549    takes over the window's rightmost columns.  */
 550 #define WINDOW_VERTICAL_SCROLL_BAR_COLUMN(w) \
 551   (((XINT ((w)->left) + XINT ((w)->width)) \
 552     < FRAME_WIDTH (XFRAME (WINDOW_FRAME (w)))) \
 553    ? (XINT ((w)->left) + XINT ((w)->width) \
 554       - FRAME_SCROLL_BAR_COLS (XFRAME (WINDOW_FRAME (w)))) \
 555    : FRAME_WIDTH (XFRAME (WINDOW_FRAME (w))))
 556
 557 /* Return the height in lines of the vertical scroll bar in w.  If the
 558    window has a mode line, don't make the scroll bar extend that far.  */
 559 #define WINDOW_VERTICAL_SCROLL_BAR_HEIGHT(w) (window_internal_height (w))