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