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