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 there is at least one garbaged frame. */
  32 extern int frame_garbaged;
  33
  34 /* Nonzero means FRAME_MESSAGE_BUF (selected_frame) is being used by
  35    print.  */
  36
  37 extern int message_buf_print;
  38
  39 \f
  40 /* The structure representing a frame.  */
  41
  42 enum output_method
  43 {
  44   output_initial,
  45   output_termcap,
  46   output_x_window,
  47   output_msdos_raw,
  48   output_w32,
  49   output_mac
  50 };
  51
  52 enum vertical_scroll_bar_type
  53 {
  54   vertical_scroll_bar_none,
  55   vertical_scroll_bar_left,
  56   vertical_scroll_bar_right
  57 };
  58
  59 enum text_cursor_kinds
  60 {
  61   DEFAULT_CURSOR = -2,
  62   NO_CURSOR = -1,
  63   FILLED_BOX_CURSOR,
  64   HOLLOW_BOX_CURSOR,
  65   BAR_CURSOR,
  66   HBAR_CURSOR
  67 };
  68
  69 #define FRAME_FOREGROUND_PIXEL(f) ((f)->foreground_pixel)
  70 #define FRAME_BACKGROUND_PIXEL(f) ((f)->background_pixel)
  71
  72 struct display;
  73
  74 struct frame
  75 {
  76   EMACS_INT size;
  77   struct Lisp_Vector *next;
  78
  79   /* All Lisp_Object components must come first.
  80      Only EMACS_INT values can be intermixed with them.
  81      That ensures they are all aligned normally.  */
  82
  83   /* Name of this frame: a Lisp string.  It is used for looking up resources,
  84      as well as for the title in some cases.  */
  85   Lisp_Object name;
  86
  87   /* The name to use for the icon, the last time
  88      it was refreshed.  nil means not explicitly specified.  */
  89   Lisp_Object icon_name;
  90
  91   /* This is the frame title specified explicitly, if any.
  92      Usually it is nil.  */
  93   Lisp_Object title;
  94
  95   /* The frame which should receive keystrokes that occur in this
  96      frame, or nil if they should go to the frame itself.  This is
  97      usually nil, but if the frame is minibufferless, we can use this
  98      to redirect keystrokes to a surrogate minibuffer frame when
  99      needed.
 100
 101      Note that a value of nil is different than having the field point
 102      to the frame itself.  Whenever the Fselect_frame function is used
 103      to shift from one frame to the other, any redirections to the
 104      original frame are shifted to the newly selected frame; if
 105      focus_frame is nil, Fselect_frame will leave it alone.  */
 106   Lisp_Object focus_frame;
 107
 108   /* This frame's root window.  Every frame has one.
 109      If the frame has only a minibuffer window, this is it.
 110      Otherwise, if the frame has a minibuffer window, this is its sibling.  */
 111   Lisp_Object root_window;
 112
 113   /* This frame's selected window.
 114      Each frame has its own window hierarchy
 115      and one of the windows in it is selected within the frame.
 116      The selected window of the selected frame is Emacs's selected window.  */
 117   Lisp_Object selected_window;
 118
 119   /* This frame's minibuffer window.
 120      Most frames have their own minibuffer windows,
 121      but only the selected frame's minibuffer window
 122      can actually appear to exist.  */
 123   Lisp_Object minibuffer_window;
 124
 125   /* Parameter alist of this frame.
 126      These are the parameters specified when creating the frame
 127      or modified with modify-frame-parameters.  */
 128   Lisp_Object param_alist;
 129
 130   /* List of scroll bars on this frame.
 131      Actually, we don't specify exactly what is stored here at all; the
 132      scroll bar implementation code can use it to store anything it likes.
 133      This field is marked by the garbage collector.  It is here
 134      instead of in the `display' structure so that the garbage
 135      collector doesn't need to look inside the window-system-dependent
 136      structure.  */
 137   Lisp_Object scroll_bars;
 138   Lisp_Object condemned_scroll_bars;
 139
 140   /* Vector describing the items to display in the menu bar.
 141      Each item has four elements in this vector.
 142      They are KEY, STRING, SUBMAP, and HPOS.
 143      (HPOS is not used in when the X toolkit is in use.)
 144      There are four additional elements of nil at the end, to terminate.  */
 145   Lisp_Object menu_bar_items;
 146
 147   /* Alist of elements (FACE-NAME . FACE-VECTOR-DATA).  */
 148   Lisp_Object face_alist;
 149
 150   /* A vector that records the entire structure of this frame's menu bar.
 151      For the format of the data, see extensive comments in xmenu.c.
 152      Only the X toolkit version uses this.  */
 153   Lisp_Object menu_bar_vector;
 154   /* Number of elements in the vector that have meaningful data.  */
 155   EMACS_INT menu_bar_items_used;
 156
 157   /* Predicate for selecting buffers for other-buffer.  */
 158   Lisp_Object buffer_predicate;
 159
 160   /* List of buffers viewed in this frame, for other-buffer.  */
 161   Lisp_Object buffer_list;
 162
 163   /* A dummy window used to display menu bars under X when no X
 164      toolkit support is available.  */
 165   Lisp_Object menu_bar_window;
 166
 167   /* A window used to display the tool-bar of a frame.  */
 168   Lisp_Object tool_bar_window;
 169
 170   /* Desired and current tool-bar items.  */
 171   Lisp_Object tool_bar_items;
 172
 173   /* Desired and current contents displayed in tool_bar_window.  */
 174   Lisp_Object desired_tool_bar_string, current_tool_bar_string;
 175
 176   /* beyond here, there should be no more Lisp_Object components.  */
 177
 178   /* Cache of realized faces.  */
 179   struct face_cache *face_cache;
 180
 181   /* A buffer to hold the frame's name.  We can't use the Lisp
 182      string's pointer (`name', above) because it might get relocated.  */
 183   char *namebuf;
 184
 185   /* Glyph pool and matrix. */
 186   struct glyph_pool *current_pool;
 187   struct glyph_pool *desired_pool;
 188   struct glyph_matrix *desired_matrix;
 189   struct glyph_matrix *current_matrix;
 190
 191   /* 1 means that glyphs on this frame have been initialized so it can
 192      be used for output.  */
 193   unsigned glyphs_initialized_p : 1;
 194
 195 #if defined (USE_GTK)
 196   /* Nonzero means using a tool bar that comes from the toolkit.  */
 197   int external_tool_bar;
 198 #endif
 199
 200   /* Margin at the top of the frame.  Used to display the tool-bar.  */
 201   int tool_bar_lines;
 202
 203   int n_tool_bar_items;
 204
 205   /* A buffer for decode_mode_line. */
 206   char *decode_mode_spec_buffer;
 207
 208   /* See do_line_insertion_deletion_costs for info on these arrays. */
 209   /* Cost of inserting 1 line on this frame */
 210   int *insert_line_cost;
 211   /* Cost of deleting 1 line on this frame */
 212   int *delete_line_cost;
 213   /* Cost of inserting n lines on this frame */
 214   int *insert_n_lines_cost;
 215   /* Cost of deleting n lines on this frame */
 216   int *delete_n_lines_cost;
 217
 218   /* Size of this frame, excluding fringes, scroll bars etc.,
 219      in units of canonical characters.  */
 220   EMACS_INT text_lines, text_cols;
 221
 222   /* Total size of this frame (i.e. its native window), in units of
 223      canonical characters.  */
 224   EMACS_INT total_lines, total_cols;
 225
 226   /* New text height and width for pending size change.
 227      0 if no change pending.  */
 228   int new_text_lines, new_text_cols;
 229
 230   /* Pixel position of the frame window (x and y offsets in root window).  */
 231   int left_pos, top_pos;
 232
 233   /* Size of the frame window in pixels.  */
 234   int pixel_height, pixel_width;
 235
 236   /* These many pixels are the difference between the outer window (i.e. the
 237      left and top of the window manager decoration) and FRAME_X_WINDOW. */
 238   int x_pixels_diff, y_pixels_diff;
 239
 240   /* This is the gravity value for the specified window position.  */
 241   int win_gravity;
 242
 243   /* The geometry flags for this window.  */
 244   int size_hint_flags;
 245
 246   /* Border width of the frame window as known by the (X) window system.  */
 247   int border_width;
 248
 249   /* Width of the internal border.  This is a line of background color
 250      just inside the window's border.  When the frame is selected,
 251      a highlighting is displayed inside the internal border.  */
 252   int internal_border_width;
 253
 254   /* Canonical X unit.  Width of default font, in pixels.  */
 255   int column_width;
 256
 257   /* Canonical Y unit.  Height of a line, in pixels.  */
 258   int line_height;
 259
 260   /* The output method says how the contents of this frame are
 261      displayed.  It could be using termcap, or using an X window.
 262      This must be the same as the display->type. */
 263   enum output_method output_method;
 264
 265   /* The display that this frame uses.  If this is NULL, then the
 266      frame is deleted. */
 267   struct display *display;
 268
 269   /* Display-dependent, frame-local auxiliary data used for displaying
 270      the contents.  When the frame is deleted, this data is deleted as
 271      well. */
 272   union output_data
 273   {
 274     struct tty_output *tty;     /* termchar.h */
 275     struct x_output *x;         /* xterm.h */
 276     struct w32_output *w32;     /* w32term.h */
 277     struct mac_output *mac;     /* macterm.h */
 278     EMACS_INT nothing;
 279   }
 280   output_data;
 281
 282   /* Total width of fringes reserved for drawing truncation bitmaps,
 283      continuation bitmaps and alike.  The width is in canonical char
 284      units of the frame.  This must currently be the case because window
 285      sizes aren't pixel values.  If it weren't the case, we wouldn't be
 286      able to split windows horizontally nicely.  */
 287   int fringe_cols;
 288
 289   /* The extra width (in pixels) currently allotted for fringes.  */
 290   int left_fringe_width, right_fringe_width;
 291
 292 #ifdef MULTI_KBOARD
 293   /* XXX Maybe this should be moved to struct display, too. */
 294   /* A pointer to the kboard structure associated with this frame.
 295      For termcap frames, it will be the same as
 296      display->display_info.tty->kboard.
 297      For X frames, it will be the same as
 298      display->display_info.x->kboard.  */
 299   struct kboard *kboard;
 300 #endif
 301
 302   /* See FULLSCREEN_ enum below */
 303   int want_fullscreen;
 304
 305   /* Number of lines of menu bar.  */
 306   int menu_bar_lines;
 307
 308 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
 309     || defined (USE_GTK)
 310   /* Nonzero means using a menu bar that comes from the X toolkit.  */
 311   int external_menu_bar;
 312 #endif
 313
 314   /* Nonzero if last attempt at redisplay on this frame was preempted.  */
 315   char display_preempted;
 316
 317   /* visible is nonzero if the frame is currently displayed; we check
 318      it to see if we should bother updating the frame's contents.
 319      DON'T SET IT DIRECTLY; instead, use FRAME_SET_VISIBLE.
 320
 321      Note that, since invisible frames aren't updated, whenever a
 322      frame becomes visible again, it must be marked as garbaged.  The
 323      FRAME_SAMPLE_VISIBILITY macro takes care of this.
 324
 325      On ttys and on Windows NT/9X, to avoid wasting effort updating
 326      visible frames that are actually completely obscured by other
 327      windows on the display, we bend the meaning of visible slightly:
 328      if greater than 1, then the frame is obscured - we still consider
 329      it to be "visible" as seen from lisp, but we don't bother
 330      updating it.  We must take care to garbage the frame when it
 331      ceaces to be obscured though.
 332
 333      iconified is nonzero if the frame is currently iconified.
 334
 335      Asynchronous input handlers should NOT change these directly;
 336      instead, they should change async_visible or async_iconified, and
 337      let the FRAME_SAMPLE_VISIBILITY macro set visible and iconified
 338      at the next redisplay.
 339
 340      These should probably be considered read-only by everyone except
 341      FRAME_SAMPLE_VISIBILITY.
 342
 343      These two are mutually exclusive.  They might both be zero, if the
 344      frame has been made invisible without an icon.  */
 345   char visible, iconified;
 346
 347   /* Asynchronous input handlers change these, and
 348      FRAME_SAMPLE_VISIBILITY copies them into visible and iconified.
 349      See FRAME_SAMPLE_VISIBILITY, below.  */
 350   volatile char async_visible, async_iconified;
 351
 352   /* Nonzero if this frame should be redrawn.  */
 353   volatile char garbaged;
 354
 355   /* True if frame actually has a minibuffer window on it.
 356      0 if using a minibuffer window that isn't on this frame.  */
 357   char has_minibuffer;
 358
 359   /* 0 means, if this frame has just one window,
 360      show no modeline for that window.  */
 361   char wants_modeline;
 362
 363   /* Non-zero if the hardware device this frame is displaying on can
 364      support scroll bars.  */
 365   char can_have_scroll_bars;
 366
 367   /* If can_have_scroll_bars is non-zero, this is non-zero if we should
 368      actually display them on this frame.  */
 369   enum vertical_scroll_bar_type vertical_scroll_bar_type;
 370
 371   /* What kind of text cursor should we draw in the future?
 372      This should always be filled_box_cursor or bar_cursor.  */
 373   enum text_cursor_kinds desired_cursor;
 374
 375   /* Width of bar cursor (if we are using that).  */
 376   int cursor_width;
 377
 378   /* What kind of text cursor should we draw when the cursor blinks off?
 379      This can be filled_box_cursor or bar_cursor or no_cursor.  */
 380   enum text_cursor_kinds blink_off_cursor;
 381
 382   /* Width of bar cursor (if we are using that) for blink-off state.  */
 383   int blink_off_cursor_width;
 384
 385   /* Non-0 means raise this frame to the top of the heap when selected.  */
 386   char auto_raise;
 387
 388   /* Non-0 means lower this frame to the bottom of the stack when left.  */
 389   char auto_lower;
 390
 391   /* True if frame's root window can't be split.  */
 392   char no_split;
 393
 394   /* If this is set, then Emacs won't change the frame name to indicate
 395      the current buffer, etcetera.  If the user explicitly sets the frame
 396      name, this gets set.  If the user sets the name to Qnil, this is
 397      cleared.  */
 398   char explicit_name;
 399
 400   /* Nonzero if size of some window on this frame has changed.  */
 401   char window_sizes_changed;
 402
 403   /* Storage for messages to this frame. */
 404   char *message_buf;
 405
 406   /* Nonnegative if current redisplay should not do scroll computation
 407      for lines beyond a certain vpos.  This is the vpos.  */
 408   int scroll_bottom_vpos;
 409
 410   /* Configured width of the scroll bar, in pixels and in characters.
 411      config_scroll_bar_cols tracks config_scroll_bar_width if the
 412      latter is positive; a zero value in config_scroll_bar_width means
 413      to compute the actual width on the fly, using config_scroll_bar_cols
 414      and the current font width.  */
 415   int config_scroll_bar_width;
 416   int config_scroll_bar_cols;
 417
 418   /* The size of the extra width currently allotted for vertical
 419      scroll bars in this frame, in pixels.  */
 420   int scroll_bar_actual_width;
 421
 422   /* The baud rate that was used to calculate costs for this frame.  */
 423   int cost_calculation_baud_rate;
 424
 425   /* Nonzero if the mouse has moved on this display
 426      since the last time we checked.  */
 427   char mouse_moved;
 428
 429   /* Exponent for gamma correction of colors.  1/(VIEWING_GAMMA *
 430      SCREEN_GAMMA) where viewing_gamma is 0.4545 and SCREEN_GAMMA is a
 431      frame parameter.  0 means don't do gamma correction.  */
 432   double gamma;
 433
 434   /* Additional space to put between text lines on this frame.  */
 435   int extra_line_spacing;
 436
 437   /* Set to non-zero in change_frame_size when size of frame changed
 438      Clear the frame in clear_garbaged_frames if set.  */
 439   unsigned resized_p : 1;
 440
 441   /* Set to non-zero in when we want for force a flush_display in
 442      update_frame, usually after resizing the frame.  */
 443   unsigned force_flush_display_p : 1;
 444
 445   /* All display backends seem to need these two pixel values. */
 446   unsigned long background_pixel;
 447   unsigned long foreground_pixel;
 448
 449   /* Set to non-zero if the default face for the frame has been
 450      realized.  Reset to zero whenever the default face changes.
 451      Used to see the difference between a font change and face change.  */
 452   unsigned default_face_done_p : 1;
 453 };
 454
 455 #ifdef MULTI_KBOARD
 456 #define FRAME_KBOARD(f) ((f)->kboard)
 457 #else
 458 #define FRAME_KBOARD(f) (&the_only_kboard)
 459 #endif
 460
 461 typedef struct frame *FRAME_PTR;
 462
 463 #define XFRAME(p) (eassert (GC_FRAMEP(p)),(struct frame *) XPNTR (p))
 464 #define XSETFRAME(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_FRAME))
 465
 466 /* Given a window, return its frame as a Lisp_Object.  */
 467 #define WINDOW_FRAME(w) (w)->frame
 468
 469 /* Test a frame for particular kinds of display methods.  */
 470 #define FRAME_INITIAL_P(f) ((f)->output_method == output_initial)
 471 #define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap)
 472 #define FRAME_X_P(f) ((f)->output_method == output_x_window)
 473 #define FRAME_W32_P(f) ((f)->output_method == output_w32)
 474 #define FRAME_MSDOS_P(f) ((f)->output_method == output_msdos_raw)
 475 #define FRAME_MAC_P(f) ((f)->output_method == output_mac)
 476
 477 /* FRAME_WINDOW_P tests whether the frame is a window, and is
 478    defined to be the predicate for the window system being used.  */
 479
 480 #ifdef HAVE_X_WINDOWS
 481 #define FRAME_WINDOW_P(f) FRAME_X_P (f)
 482 #endif
 483 #ifdef HAVE_NTGUI
 484 #define FRAME_WINDOW_P(f) FRAME_W32_P (f)
 485 #endif
 486 #ifdef MAC_OS
 487 #define FRAME_WINDOW_P(f) FRAME_MAC_P (f)
 488 #endif
 489 #ifndef FRAME_WINDOW_P
 490 #define FRAME_WINDOW_P(f) (0)
 491 #endif
 492
 493 /* Nonzero if frame F is still alive (not deleted).  */
 494 #define FRAME_LIVE_P(f) ((f)->display != 0)
 495
 496 /* Nonzero if frame F is a minibuffer-only frame.  */
 497 #define FRAME_MINIBUF_ONLY_P(f) \
 498   EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f))
 499
 500 /* Nonzero if frame F contains a minibuffer window.
 501    (If this is 0, F must use some other minibuffer window.)  */
 502 #define FRAME_HAS_MINIBUF_P(f) ((f)->has_minibuffer)
 503
 504 /* Pixel height of frame F, including non-toolkit menu bar and
 505    non-toolkit tool bar lines.  */
 506 #define FRAME_PIXEL_HEIGHT(f) ((f)->pixel_height)
 507
 508 /* Pixel width of frame F.  */
 509 #define FRAME_PIXEL_WIDTH(f) ((f)->pixel_width)
 510
 511 /* Height of frame F, measured in canonical lines, including
 512    non-toolkit menu bar and non-toolkit tool bar lines.  */
 513 #define FRAME_LINES(f) (f)->text_lines
 514
 515 /* Width of frame F, measured in canonical character columns,
 516    not including scroll bars if any.  */
 517 #define FRAME_COLS(f) (f)->text_cols
 518
 519 /* Number of lines of frame F used for menu bar.
 520    This is relevant on terminal frames and on
 521    X Windows when not using the X toolkit.
 522    These lines are counted in FRAME_LINES.  */
 523 #define FRAME_MENU_BAR_LINES(f) (f)->menu_bar_lines
 524
 525 /* Nonzero if this frame should display a tool bar
 526    in a way that does not use any text lines.  */
 527 #if defined (USE_GTK)
 528 #define FRAME_EXTERNAL_TOOL_BAR(f) (f)->external_tool_bar
 529 #else
 530 #define FRAME_EXTERNAL_TOOL_BAR(f) 0
 531 #endif
 532
 533 /* Number of lines of frame F used for the tool-bar.  */
 534
 535 #define FRAME_TOOL_BAR_LINES(f) (f)->tool_bar_lines
 536
 537
 538 /* Lines above the top-most window in frame F.  */
 539
 540 #define FRAME_TOP_MARGIN(F) \
 541      (FRAME_MENU_BAR_LINES (F) + FRAME_TOOL_BAR_LINES (F))
 542
 543 /* Nonzero if this frame should display a menu bar
 544    in a way that does not use any text lines.  */
 545 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
 546     || defined (USE_GTK)
 547 #define FRAME_EXTERNAL_MENU_BAR(f) (f)->external_menu_bar
 548 #else
 549 #define FRAME_EXTERNAL_MENU_BAR(f) 0
 550 #endif
 551 #define FRAME_VISIBLE_P(f) ((f)->visible != 0)
 552
 553 /* Nonzero if frame F is currently visible but hidden.  */
 554 #define FRAME_OBSCURED_P(f) ((f)->visible > 1)
 555
 556 /* Nonzero if frame F is currently iconified.  */
 557 #define FRAME_ICONIFIED_P(f) (f)->iconified
 558
 559 #define FRAME_SET_VISIBLE(f,p) \
 560   ((f)->async_visible = (p), FRAME_SAMPLE_VISIBILITY (f))
 561 #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1, f->garbaged = 1)
 562 #define FRAME_GARBAGED_P(f) (f)->garbaged
 563
 564 /* Nonzero means do not allow splitting this frame's window.  */
 565 #define FRAME_NO_SPLIT_P(f) (f)->no_split
 566
 567 /* Not really implemented.  */
 568 #define FRAME_WANTS_MODELINE_P(f) (f)->wants_modeline
 569
 570 /* Nonzero if a size change has been requested for frame F
 571    but not yet really put into effect.  This can be true temporarily
 572    when an X event comes in at a bad time.  */
 573 #define FRAME_WINDOW_SIZES_CHANGED(f) (f)->window_sizes_changed
 574
 575 /* The minibuffer window of frame F, if it has one; otherwise nil.  */
 576 #define FRAME_MINIBUF_WINDOW(f) (f)->minibuffer_window
 577
 578 /* The root window of the window tree of frame F.  */
 579 #define FRAME_ROOT_WINDOW(f) (f)->root_window
 580
 581 /* The currently selected window of the window tree of frame F.  */
 582 #define FRAME_SELECTED_WINDOW(f) (f)->selected_window
 583
 584 #define FRAME_INSERT_COST(f) (f)->insert_line_cost
 585 #define FRAME_DELETE_COST(f) (f)->delete_line_cost
 586 #define FRAME_INSERTN_COST(f) (f)->insert_n_lines_cost
 587 #define FRAME_DELETEN_COST(f) (f)->delete_n_lines_cost
 588 #define FRAME_MESSAGE_BUF(f) (f)->message_buf
 589 #define FRAME_SCROLL_BOTTOM_VPOS(f) (f)->scroll_bottom_vpos
 590 #define FRAME_FOCUS_FRAME(f) (f)->focus_frame
 591
 592 /* Nonzero if frame F supports scroll bars.
 593    If this is zero, then it is impossible to enable scroll bars
 594    on frame F.  */
 595 #define FRAME_CAN_HAVE_SCROLL_BARS(f) ((f)->can_have_scroll_bars)
 596
 597 /* This frame slot says whether scroll bars are currently enabled for frame F,
 598    and which side they are on.  */
 599 #define FRAME_VERTICAL_SCROLL_BAR_TYPE(f) ((f)->vertical_scroll_bar_type)
 600 #define FRAME_HAS_VERTICAL_SCROLL_BARS(f) \
 601      ((f)->vertical_scroll_bar_type != vertical_scroll_bar_none)
 602 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT(f) \
 603      ((f)->vertical_scroll_bar_type == vertical_scroll_bar_left)
 604 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT(f) \
 605      ((f)->vertical_scroll_bar_type == vertical_scroll_bar_right)
 606
 607 /* Width that a scroll bar in frame F should have, if there is one.
 608    Measured in pixels.
 609    If scroll bars are turned off, this is still nonzero.  */
 610 #define FRAME_CONFIG_SCROLL_BAR_WIDTH(f) ((f)->config_scroll_bar_width)
 611
 612 /* Width that a scroll bar in frame F should have, if there is one.
 613    Measured in columns (characters).
 614    If scroll bars are turned off, this is still nonzero.  */
 615 #define FRAME_CONFIG_SCROLL_BAR_COLS(f) ((f)->config_scroll_bar_cols)
 616
 617 /* Width of a scroll bar in frame F, measured in columns (characters),
 618    but only if scroll bars are on the left.  If scroll bars are on
 619    the right in this frame, or there are no scroll bars, value is 0.  */
 620
 621 #define FRAME_LEFT_SCROLL_BAR_COLS(f)                   \
 622      (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f)        \
 623       ? FRAME_CONFIG_SCROLL_BAR_COLS (f)                \
 624       : 0)
 625
 626 /* Width of a left scroll bar in frame F, measured in pixels */
 627
 628 #define FRAME_LEFT_SCROLL_BAR_AREA_WIDTH(f)                                     \
 629   (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f)                           \
 630    ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f))        \
 631    : 0)
 632
 633 /* Width of a scroll bar in frame F, measured in columns (characters),
 634    but only if scroll bars are on the right.  If scroll bars are on
 635    the left in this frame, or there are no scroll bars, value is 0.  */
 636
 637 #define FRAME_RIGHT_SCROLL_BAR_COLS(f)                  \
 638      (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f)       \
 639       ? FRAME_CONFIG_SCROLL_BAR_COLS (f)                \
 640       : 0)
 641
 642 /* Width of a right scroll bar area in frame F, measured in pixels */
 643
 644 #define FRAME_RIGHT_SCROLL_BAR_AREA_WIDTH(f)                                    \
 645   (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f)                          \
 646    ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f))        \
 647    : 0)
 648
 649 /* Actual width of a scroll bar in frame F, measured in columns.  */
 650
 651 #define FRAME_SCROLL_BAR_COLS(f)                        \
 652      (FRAME_HAS_VERTICAL_SCROLL_BARS (f)                \
 653       ? FRAME_CONFIG_SCROLL_BAR_COLS (f)                \
 654       : 0)
 655
 656 /* Actual width of a scroll bar area in frame F, measured in pixels.  */
 657
 658 #define FRAME_SCROLL_BAR_AREA_WIDTH(f)                                  \
 659   (FRAME_HAS_VERTICAL_SCROLL_BARS (f)                                   \
 660    ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f))        \
 661    : 0)
 662
 663 /* Total width of frame F, in columns (characters),
 664    including the width used by scroll bars if any.  */
 665
 666 #define FRAME_TOTAL_COLS(f) ((f)->total_cols)
 667
 668 /* Set the width of frame F to VAL.
 669    VAL is the width of a full-frame window,
 670    not including scroll bars and fringes.  */
 671
 672 #define SET_FRAME_COLS(f, val)                                          \
 673      (FRAME_COLS (f) = (val),                                           \
 674       (f)->total_cols = FRAME_TOTAL_COLS_ARG (f, FRAME_COLS (f)))
 675
 676 /* Given a value WIDTH for frame F's nominal width,
 677    return the value that FRAME_TOTAL_COLS should have.  */
 678
 679 #define FRAME_TOTAL_COLS_ARG(f, width)          \
 680      ((width)                                   \
 681       + FRAME_SCROLL_BAR_COLS (f)               \
 682       + FRAME_FRINGE_COLS (f))
 683
 684 /* Maximum + 1 legitimate value for FRAME_CURSOR_X.  */
 685
 686 #define FRAME_CURSOR_X_LIMIT(f) \
 687      (FRAME_COLS (f) + FRAME_LEFT_SCROLL_BAR_COLS (f))
 688
 689 /* Nonzero if frame F has scroll bars.  */
 690
 691 #define FRAME_SCROLL_BARS(f) ((f)->scroll_bars)
 692
 693 #define FRAME_CONDEMNED_SCROLL_BARS(f) ((f)->condemned_scroll_bars)
 694 #define FRAME_MENU_BAR_ITEMS(f) ((f)->menu_bar_items)
 695 #define FRAME_COST_BAUD_RATE(f) ((f)->cost_calculation_baud_rate)
 696
 697 #define FRAME_DESIRED_CURSOR(f) ((f)->desired_cursor)
 698 #define FRAME_BLINK_OFF_CURSOR(f) ((f)->blink_off_cursor)
 699 #define FRAME_CURSOR_WIDTH(f) ((f)->cursor_width)
 700 #define FRAME_BLINK_OFF_CURSOR_WIDTH(f) ((f)->blink_off_cursor_width)
 701
 702 /* Return a pointer to the face cache of frame F.  */
 703
 704 #define FRAME_FACE_CACHE(F)     (F)->face_cache
 705
 706 /* Return the size of message_buf of the frame F.  We multiply the
 707    width of the frame by 4 because multi-byte form may require at most
 708    4-byte for a character.  */
 709
 710 #define FRAME_MESSAGE_BUF_SIZE(f) (((int) FRAME_COLS (f)) * 4)
 711
 712 /* Emacs's redisplay code could become confused if a frame's
 713    visibility changes at arbitrary times.  For example, if a frame is
 714    visible while the desired glyphs are being built, but becomes
 715    invisible before they are updated, then some rows of the
 716    desired_glyphs will be left marked as enabled after redisplay is
 717    complete, which should never happen.  The next time the frame
 718    becomes visible, redisplay will probably barf.
 719
 720    Currently, there are no similar situations involving iconified, but
 721    the principle is the same.
 722
 723    So instead of having asynchronous input handlers directly set and
 724    clear the frame's visibility and iconification flags, they just set
 725    the async_visible and async_iconified flags; the redisplay code
 726    calls the FRAME_SAMPLE_VISIBILITY macro before doing any redisplay,
 727    which sets visible and iconified from their asynchronous
 728    counterparts.
 729
 730    Synchronous code must use the FRAME_SET_VISIBLE macro.
 731
 732    Also, if a frame used to be invisible, but has just become visible,
 733    it must be marked as garbaged, since redisplay hasn't been keeping
 734    up its contents.
 735
 736    Note that a tty frame is visible if and only if it is the topmost
 737    frame. */
 738
 739 #define FRAME_SAMPLE_VISIBILITY(f) \
 740   (((f)->async_visible && (f)->visible != (f)->async_visible) ? \
 741    SET_FRAME_GARBAGED (f) : 0, \
 742    (f)->visible = (f)->async_visible, \
 743    (f)->iconified = (f)->async_iconified)
 744
 745 #define CHECK_FRAME(x)                                  \
 746      do {                                               \
 747        if (! FRAMEP (x))                                \
 748          x = wrong_type_argument (Qframep, (x));        \
 749      } while (0)
 750
 751 #define CHECK_LIVE_FRAME(x)                             \
 752      do {                                               \
 753        if (! FRAMEP (x)                                 \
 754            || ! FRAME_LIVE_P (XFRAME (x)))              \
 755          x = wrong_type_argument (Qframe_live_p, (x));  \
 756      } while (0)
 757
 758 /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
 759    `for' loop which iterates over the elements of Vframe_list.  The
 760    loop will set FRAME_VAR, a Lisp_Object, to each frame in
 761    Vframe_list in succession and execute the statement.  LIST_VAR
 762    should be a Lisp_Object too; it is used to iterate through the
 763    Vframe_list.
 764
 765    This macro is a holdover from a time when multiple frames weren't always
 766    supported.  An alternate definition of the macro would expand to
 767    something which executes the statement once.  */
 768
 769 #define FOR_EACH_FRAME(list_var, frame_var)                     \
 770   for ((list_var) = Vframe_list;                                \
 771        (CONSP (list_var)                                        \
 772         && (frame_var = XCAR (list_var), 1));           \
 773        list_var = XCDR (list_var))
 774
 775
 776 extern Lisp_Object Qframep, Qframe_live_p;
 777 extern Lisp_Object Qtty, Qtty_type;
 778 extern Lisp_Object Qdisplay_id, Qdisplay_live_p;
 779
 780 extern struct frame *last_nonminibuf_frame;
 781
 782 extern struct frame *make_initial_frame P_ ((void));
 783 extern struct frame *make_terminal_frame P_ ((struct display *));
 784 extern struct frame *make_frame P_ ((int));
 785 #ifdef HAVE_WINDOW_SYSTEM
 786 extern struct frame *make_minibuffer_frame P_ ((void));
 787 extern struct frame *make_frame_without_minibuffer P_ ((Lisp_Object,
 788                                                         struct kboard *,
 789                                                         Lisp_Object));
 790 #endif /* HAVE_WINDOW_SYSTEM */
 791 extern int other_visible_frames P_ ((struct frame *));
 792
 793 extern Lisp_Object Vframe_list;
 794 extern Lisp_Object Vdefault_frame_alist;
 795
 796 extern Lisp_Object Vterminal_frame;
 797
 798 extern Lisp_Object Vmouse_highlight;
 799 \f
 800 /* The currently selected frame.  */
 801
 802 extern Lisp_Object selected_frame;
 803
 804 /* Value is a pointer to the selected frame.  If the selected frame
 805    isn't live, abort.  */
 806
 807 #define SELECTED_FRAME()                                \
 808      ((FRAMEP (selected_frame)                          \
 809        && FRAME_LIVE_P (XFRAME (selected_frame)))       \
 810       ? XFRAME (selected_frame)                         \
 811       : (abort (), (struct frame *) 0))
 812
 813 \f
 814 /***********************************************************************
 815                         Display-related Macros
 816  ***********************************************************************/
 817
 818 /* Canonical y-unit on frame F.
 819    This value currently equals the line height of the frame (which is
 820    the height of the default font of F).  */
 821
 822 #define FRAME_LINE_HEIGHT(F) ((F)->line_height)
 823
 824 /* Canonical x-unit on frame F.
 825    This value currently equals the width of the default font of F.  */
 826
 827 #define FRAME_COLUMN_WIDTH(F) ((F)->column_width)
 828
 829
 830 /* Pixel width of areas used to display truncation marks, continuation
 831    marks, overlay arrows.  This is 0 for terminal frames.  */
 832
 833 #ifdef HAVE_WINDOW_SYSTEM
 834
 835 /* Total width of fringes reserved for drawing truncation bitmaps,
 836    continuation bitmaps and alike.  The width is in canonical char
 837    units of the frame.  This must currently be the case because window
 838    sizes aren't pixel values.  If it weren't the case, we wouldn't be
 839    able to split windows horizontally nicely.  */
 840
 841 #define FRAME_FRINGE_COLS(F) ((F)->fringe_cols)
 842
 843 /* Pixel-width of the left and right fringe.  */
 844
 845 #define FRAME_LEFT_FRINGE_WIDTH(F) ((F)->left_fringe_width)
 846 #define FRAME_RIGHT_FRINGE_WIDTH(F) ((F)->right_fringe_width)
 847
 848 /* Total width of fringes in pixels.  */
 849
 850 #define FRAME_TOTAL_FRINGE_WIDTH(F) \
 851   (FRAME_LEFT_FRINGE_WIDTH (F) + FRAME_RIGHT_FRINGE_WIDTH (F))
 852
 853
 854 /* Pixel-width of internal border lines */
 855
 856 #define FRAME_INTERNAL_BORDER_WIDTH(F) ((F)->internal_border_width)
 857
 858 #else /* not HAVE_WINDOW_SYSTEM */
 859
 860 #define FRAME_FRINGE_COLS(F)    0
 861 #define FRAME_TOTAL_FRINGE_WIDTH(F)     0
 862 #define FRAME_LEFT_FRINGE_WIDTH(F)  0
 863 #define FRAME_RIGHT_FRINGE_WIDTH(F) 0
 864 #define FRAME_INTERNAL_BORDER_WIDTH(F) 0
 865
 866 #endif /* not HAVE_WINDOW_SYSTEM */
 867
 868
 869
 870 \f
 871 /***********************************************************************
 872             Conversion between canonical units and pixels
 873  ***********************************************************************/
 874
 875 /* Canonical x-values are fractions of FRAME_COLUMN_WIDTH, canonical
 876    y-unit are fractions of FRAME_LINE_HEIGHT of a frame.  Both are
 877    represented as Lisp numbers, i.e. integers or floats.  */
 878
 879 /* Convert canonical value X to pixels.  F is the frame whose
 880    canonical char width is to be used.  X must be a Lisp integer or
 881    float.  Value is a C integer.  */
 882
 883 #define FRAME_PIXEL_X_FROM_CANON_X(F, X)                \
 884      (INTEGERP (X)                                      \
 885       ? XINT (X) * FRAME_COLUMN_WIDTH (F)               \
 886       : (int) (XFLOAT_DATA (X) * FRAME_COLUMN_WIDTH (F)))
 887
 888 /* Convert canonical value Y to pixels.  F is the frame whose
 889    canonical character height is to be used.  X must be a Lisp integer
 890    or float.  Value is a C integer.  */
 891
 892 #define FRAME_PIXEL_Y_FROM_CANON_Y(F, Y)                \
 893      (INTEGERP (Y)                                      \
 894       ? XINT (Y) * FRAME_LINE_HEIGHT (F)                \
 895       : (int) (XFLOAT_DATA (Y) * FRAME_LINE_HEIGHT (F)))
 896
 897 /* Convert pixel-value X to canonical units.  F is the frame whose
 898    canonical character width is to be used.  X is a C integer.  Result
 899    is a Lisp float if X is not a multiple of the canon width,
 900    otherwise it's a Lisp integer.  */
 901
 902 #define FRAME_CANON_X_FROM_PIXEL_X(F, X)                        \
 903      ((X) % FRAME_COLUMN_WIDTH (F) != 0                         \
 904       ? make_float ((double) (X) / FRAME_COLUMN_WIDTH (F))      \
 905       : make_number ((X) / FRAME_COLUMN_WIDTH (F)))
 906
 907 /* Convert pixel-value Y to canonical units.  F is the frame whose
 908    canonical character height is to be used.  Y is a C integer.
 909    Result is a Lisp float if Y is not a multiple of the canon width,
 910    otherwise it's a Lisp integer.  */
 911
 912 #define FRAME_CANON_Y_FROM_PIXEL_Y(F, Y)                        \
 913      ((Y) % FRAME_LINE_HEIGHT (F)                               \
 914       ? make_float ((double) (Y) / FRAME_LINE_HEIGHT (F))       \
 915       : make_number ((Y) / FRAME_LINE_HEIGHT (F)))
 916
 917
 918 \f
 919 /* Manipulating pixel sizes and character sizes.
 920    Knowledge of which factors affect the overall size of the window should
 921    be hidden in these macros, if that's possible.
 922
 923    Return the upper/left pixel position of the character cell on frame F
 924    at ROW/COL.  */
 925
 926 #define FRAME_LINE_TO_PIXEL_Y(f, row) \
 927   (FRAME_INTERNAL_BORDER_WIDTH (f)  \
 928    + (row) * FRAME_LINE_HEIGHT (f))
 929
 930 #define FRAME_COL_TO_PIXEL_X(f, col) \
 931   (FRAME_INTERNAL_BORDER_WIDTH (f) \
 932    + (col) * FRAME_COLUMN_WIDTH (f))
 933
 934 /* Return the pixel width/height of frame F if it has
 935    COLS columns/LINES rows.  */
 936
 937 #define FRAME_TEXT_COLS_TO_PIXEL_WIDTH(f, cols) \
 938   (FRAME_COL_TO_PIXEL_X (f, cols) \
 939    + (f)->scroll_bar_actual_width \
 940    + FRAME_TOTAL_FRINGE_WIDTH (f)      \
 941    + FRAME_INTERNAL_BORDER_WIDTH (f))
 942
 943 #define FRAME_TEXT_LINES_TO_PIXEL_HEIGHT(f, lines) \
 944   (FRAME_LINE_TO_PIXEL_Y (f, lines) \
 945    + FRAME_INTERNAL_BORDER_WIDTH (f))
 946
 947
 948 /* Return the row/column (zero-based) of the character cell containing
 949    the pixel on FRAME at Y/X.  */
 950
 951 #define FRAME_PIXEL_Y_TO_LINE(f, y) \
 952   (((y) - FRAME_INTERNAL_BORDER_WIDTH (f))      \
 953    / FRAME_LINE_HEIGHT (f))
 954
 955 #define FRAME_PIXEL_X_TO_COL(f, x) \
 956   (((x) - FRAME_INTERNAL_BORDER_WIDTH (f))      \
 957    / FRAME_COLUMN_WIDTH (f))
 958
 959 /* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
 960    frame F?  */
 961
 962 #define FRAME_PIXEL_WIDTH_TO_TEXT_COLS(f, width)                \
 963   (FRAME_PIXEL_X_TO_COL (f, ((width)                            \
 964                              - FRAME_INTERNAL_BORDER_WIDTH (f)  \
 965                              - FRAME_TOTAL_FRINGE_WIDTH (f)     \
 966                              - (f)->scroll_bar_actual_width)))
 967
 968 #define FRAME_PIXEL_HEIGHT_TO_TEXT_LINES(f, height) \
 969   (FRAME_PIXEL_Y_TO_LINE (f, ((height) \
 970                               - FRAME_INTERNAL_BORDER_WIDTH (f))))
 971
 972
 973 /***********************************************************************
 974                                 Frame Parameters
 975  ***********************************************************************/
 976
 977 extern Lisp_Object Qauto_raise, Qauto_lower;
 978 extern Lisp_Object Qborder_color, Qborder_width;
 979 extern Lisp_Object Qbuffer_predicate, Qbuffer_list;
 980 extern Lisp_Object Qcursor_color, Qcursor_type;
 981 extern Lisp_Object Qfont;
 982 extern Lisp_Object Qbackground_color, Qforeground_color;
 983 extern Lisp_Object Qicon, Qicon_name, Qicon_type, Qicon_left, Qicon_top;
 984 extern Lisp_Object Qinternal_border_width;
 985 extern Lisp_Object Qmenu_bar_lines, Qtool_bar_lines;
 986 extern Lisp_Object Qmouse_color;
 987 extern Lisp_Object Qname, Qtitle;
 988 extern Lisp_Object Qparent_id;
 989 extern Lisp_Object Qunsplittable, Qvisibility;
 990 extern Lisp_Object Qscroll_bar_width, Qvertical_scroll_bars;
 991 extern Lisp_Object Qscroll_bar_foreground, Qscroll_bar_background;
 992 extern Lisp_Object Qscreen_gamma;
 993 extern Lisp_Object Qline_spacing;
 994 extern Lisp_Object Qwait_for_wm;
 995 extern Lisp_Object Qfullscreen;
 996
 997 extern Lisp_Object Qleft_fringe, Qright_fringe;
 998 extern Lisp_Object Qheight, Qwidth;
 999 extern Lisp_Object Qminibuffer, Qmodeline;
1000 extern Lisp_Object Qonly;
1001 extern Lisp_Object Qx, Qw32, Qmac, Qpc;
1002 extern Lisp_Object Qvisible;
1003 extern Lisp_Object Qdisplay_type;
1004 extern Lisp_Object Qbackground_mode;
1005
1006 extern Lisp_Object Qx_resource_name;
1007
1008 extern Lisp_Object Qleft, Qright, Qtop, Qbox;
1009 extern Lisp_Object Qdisplay;
1010
1011 extern Lisp_Object Qwindow_system;
1012
1013 #ifdef HAVE_WINDOW_SYSTEM
1014
1015 /* The class of this X application.  */
1016 #define EMACS_CLASS "Emacs"
1017
1018 enum
1019 {
1020   /* Values used as a bit mask, BOTH == WIDTH | HEIGHT.  */
1021   FULLSCREEN_NONE       = 0,
1022   FULLSCREEN_WIDTH      = 1,
1023   FULLSCREEN_HEIGHT     = 2,
1024   FULLSCREEN_BOTH       = 3,
1025   FULLSCREEN_WAIT       = 4,
1026 };
1027
1028
1029 /* These are in xterm.c, w32term.c, etc.  */
1030
1031 extern void x_set_scroll_bar_default_width P_ ((struct frame *));
1032 extern void x_set_offset P_ ((struct frame *, int, int, int));
1033 extern void x_wm_set_icon_position P_ ((struct frame *, int, int));
1034
1035 extern Lisp_Object x_new_font P_ ((struct frame *, char *));
1036 extern Lisp_Object x_new_fontset P_ ((struct frame *, char *));
1037
1038
1039 /* These are in frame.c  */
1040
1041 extern Lisp_Object Vx_resource_name;
1042 extern Lisp_Object Vx_resource_class;
1043
1044
1045 extern Lisp_Object Qface_set_after_frame_default;
1046
1047 extern void x_fullscreen_adjust P_ ((struct frame *f, int *, int *,
1048                                      int *, int *));
1049
1050 extern void x_set_frame_parameters P_ ((struct frame *, Lisp_Object));
1051 extern void x_report_frame_params P_ ((struct frame *, Lisp_Object *));
1052
1053 extern void x_set_fullscreen P_ ((struct frame *, Lisp_Object, Lisp_Object));
1054 extern void x_set_line_spacing P_ ((struct frame *, Lisp_Object, Lisp_Object));
1055 extern void x_set_screen_gamma P_ ((struct frame *, Lisp_Object, Lisp_Object));
1056 extern void x_set_font P_ ((struct frame *, Lisp_Object, Lisp_Object));
1057 extern void x_set_fringe_width P_ ((struct frame *, Lisp_Object, Lisp_Object));
1058 extern void x_set_border_width P_ ((struct frame *, Lisp_Object, Lisp_Object));
1059 extern void x_set_internal_border_width P_ ((struct frame *, Lisp_Object,
1060                                              Lisp_Object));
1061 extern void x_set_visibility P_ ((struct frame *, Lisp_Object, Lisp_Object));
1062 extern void x_set_autoraise P_ ((struct frame *, Lisp_Object, Lisp_Object));
1063 extern void x_set_autolower P_ ((struct frame *, Lisp_Object, Lisp_Object));
1064 extern void x_set_unsplittable P_ ((struct frame *, Lisp_Object, Lisp_Object));
1065 extern void x_set_vertical_scroll_bars P_ ((struct frame *, Lisp_Object,
1066                                             Lisp_Object));
1067 extern void x_set_scroll_bar_width P_ ((struct frame *, Lisp_Object,
1068                                         Lisp_Object));
1069
1070 extern Lisp_Object x_icon_type P_ ((struct frame *));
1071
1072 extern int x_figure_window_size P_ ((struct frame *, Lisp_Object, int));
1073
1074
1075 extern void validate_x_resource_name P_ ((void));
1076
1077 #endif /* HAVE_WINDOW_SYSTEM */
1078
1079 #endif /* not EMACS_FRAME_H */
1080
1081 /* arch-tag: 0df048ee-e6bf-4f48-bd56-e3cd055dd8c4
1082    (do not change this comment) */