src/frame.h

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