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