src/frame.h

   1 /* Define frame-object for GNU Emacs.
   2    Copyright (C) 1993, 1994, 1999, 2000, 2001, 2002, 2003, 2004,
   3                  2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
   4
   5 This file is part of GNU Emacs.
   6
   7 GNU Emacs is free software: you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation, either version 3 of the License, or
  10 (at your option) any later version.
  11
  12 GNU Emacs is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 /* Don't multiply include: dispextern.h includes macterm.h which
  21    includes frame.h some emacs source includes both dispextern.h and
  22    frame.h */
  23
  24 #ifndef EMACS_FRAME_H
  25 #define EMACS_FRAME_H
  26
  27 #include "dispextern.h"
  28
  29 \f
  30 /* Miscellanea.  */
  31
  32 /* Nonzero means there is at least one garbaged frame. */
  33 extern int frame_garbaged;
  34
  35 /* Nonzero means FRAME_MESSAGE_BUF (selected_frame) is being used by
  36    print.  */
  37
  38 extern int message_buf_print;
  39
  40 /* Nonzero means window system changes focus when moving the
  41    mouse.  */
  42
  43 extern int focus_follows_mouse;
  44
  45 \f
  46 /* The structure representing a frame.  */
  47
  48 enum output_method
  49 {
  50   output_initial,
  51   output_termcap,
  52   output_x_window,
  53   output_msdos_raw,
  54   output_w32,
  55   output_mac,
  56   output_ns
  57 };
  58
  59 enum vertical_scroll_bar_type
  60 {
  61   vertical_scroll_bar_none,
  62   vertical_scroll_bar_left,
  63   vertical_scroll_bar_right
  64 };
  65
  66 enum text_cursor_kinds
  67 {
  68   DEFAULT_CURSOR = -2,
  69   NO_CURSOR = -1,
  70   FILLED_BOX_CURSOR,
  71   HOLLOW_BOX_CURSOR,
  72   BAR_CURSOR,
  73   HBAR_CURSOR
  74 };
  75
  76 enum fullscreen_type
  77 {
  78   FULLSCREEN_NONE,
  79   FULLSCREEN_WIDTH     = 0x001,
  80   FULLSCREEN_HEIGHT    = 0x002,
  81   FULLSCREEN_BOTH      = 0x003,
  82   FULLSCREEN_MAXIMIZED = 0x013,
  83   FULLSCREEN_WAIT      = 0x100
  84 };
  85
  86
  87 #define FRAME_FOREGROUND_PIXEL(f) ((f)->foreground_pixel)
  88 #define FRAME_BACKGROUND_PIXEL(f) ((f)->background_pixel)
  89
  90 struct terminal;
  91
  92 struct font_driver_list;
  93
  94 struct frame
  95 {
  96   EMACS_UINT size;
  97   struct Lisp_Vector *next;
  98
  99   /* All Lisp_Object components must come first.
 100      That ensures they are all aligned normally.  */
 101
 102   /* Name of this frame: a Lisp string.  It is used for looking up resources,
 103      as well as for the title in some cases.  */
 104   Lisp_Object name;
 105
 106   /* The name to use for the icon, the last time
 107      it was refreshed.  nil means not explicitly specified.  */
 108   Lisp_Object icon_name;
 109
 110   /* This is the frame title specified explicitly, if any.
 111      Usually it is nil.  */
 112   Lisp_Object title;
 113
 114   /* The frame which should receive keystrokes that occur in this
 115      frame, or nil if they should go to the frame itself.  This is
 116      usually nil, but if the frame is minibufferless, we can use this
 117      to redirect keystrokes to a surrogate minibuffer frame when
 118      needed.
 119
 120      Note that a value of nil is different than having the field point
 121      to the frame itself.  Whenever the Fselect_frame function is used
 122      to shift from one frame to the other, any redirections to the
 123      original frame are shifted to the newly selected frame; if
 124      focus_frame is nil, Fselect_frame will leave it alone.  */
 125   Lisp_Object focus_frame;
 126
 127   /* This frame's root window.  Every frame has one.
 128      If the frame has only a minibuffer window, this is it.
 129      Otherwise, if the frame has a minibuffer window, this is its sibling.  */
 130   Lisp_Object root_window;
 131
 132   /* This frame's selected window.
 133      Each frame has its own window hierarchy
 134      and one of the windows in it is selected within the frame.
 135      The selected window of the selected frame is Emacs's selected window.  */
 136   Lisp_Object selected_window;
 137
 138   /* This frame's minibuffer window.
 139      Most frames have their own minibuffer windows,
 140      but only the selected frame's minibuffer window
 141      can actually appear to exist.  */
 142   Lisp_Object minibuffer_window;
 143
 144   /* Parameter alist of this frame.
 145      These are the parameters specified when creating the frame
 146      or modified with modify-frame-parameters.  */
 147   Lisp_Object param_alist;
 148
 149   /* List of scroll bars on this frame.
 150      Actually, we don't specify exactly what is stored here at all; the
 151      scroll bar implementation code can use it to store anything it likes.
 152      This field is marked by the garbage collector.  It is here
 153      instead of in the `device' structure so that the garbage
 154      collector doesn't need to look inside the window-system-dependent
 155      structure.  */
 156   Lisp_Object scroll_bars;
 157   Lisp_Object condemned_scroll_bars;
 158
 159   /* Vector describing the items to display in the menu bar.
 160      Each item has four elements in this vector.
 161      They are KEY, STRING, SUBMAP, and HPOS.
 162      (HPOS is not used in when the X toolkit is in use.)
 163      There are four additional elements of nil at the end, to terminate.  */
 164   Lisp_Object menu_bar_items;
 165
 166   /* Alist of elements (FACE-NAME . FACE-VECTOR-DATA).  */
 167   Lisp_Object face_alist;
 168
 169   /* A vector that records the entire structure of this frame's menu bar.
 170      For the format of the data, see extensive comments in xmenu.c.
 171      Only the X toolkit version uses this.  */
 172   Lisp_Object menu_bar_vector;
 173
 174   /* Predicate for selecting buffers for other-buffer.  */
 175   Lisp_Object buffer_predicate;
 176
 177   /* List of buffers viewed in this frame, for other-buffer.  */
 178   Lisp_Object buffer_list;
 179
 180   /* List of buffers that were viewed, then buried in this frame.  The
 181      most recently buried buffer is first.  For last-buffer.  */
 182   Lisp_Object buried_buffer_list;
 183
 184   /* A dummy window used to display menu bars under X when no X
 185      toolkit support is available.  */
 186   Lisp_Object menu_bar_window;
 187
 188   /* A window used to display the tool-bar of a frame.  */
 189   Lisp_Object tool_bar_window;
 190
 191   /* Desired and current tool-bar items.  */
 192   Lisp_Object tool_bar_items;
 193
 194   /* Where tool bar is, can be left, right, top or bottom.  The native
 195      tool bar only supports top.  */
 196   Lisp_Object tool_bar_position;
 197
 198   /* Desired and current contents displayed in tool_bar_window.  */
 199   Lisp_Object desired_tool_bar_string, current_tool_bar_string;
 200
 201   /* Beyond here, there should be no more Lisp_Object components.  */
 202
 203   /* Cache of realized faces.  */
 204   struct face_cache *face_cache;
 205
 206   /* Number of elements in `menu_bar_vector' that have meaningful data.  */
 207   EMACS_INT menu_bar_items_used;
 208
 209   /* A buffer to hold the frame's name.  We can't use the Lisp
 210      string's pointer (`name', above) because it might get relocated.  */
 211   char *namebuf;
 212
 213   /* Glyph pool and matrix. */
 214   struct glyph_pool *current_pool;
 215   struct glyph_pool *desired_pool;
 216   struct glyph_matrix *desired_matrix;
 217   struct glyph_matrix *current_matrix;
 218
 219   /* 1 means that glyphs on this frame have been initialized so it can
 220      be used for output.  */
 221   unsigned glyphs_initialized_p : 1;
 222
 223   /* Set to non-zero in change_frame_size when size of frame changed
 224      Clear the frame in clear_garbaged_frames if set.  */
 225   unsigned resized_p : 1;
 226
 227   /* Set to non-zero in when we want for force a flush_display in
 228      update_frame, usually after resizing the frame.  */
 229   unsigned force_flush_display_p : 1;
 230
 231   /* Set to non-zero if the default face for the frame has been
 232      realized.  Reset to zero whenever the default face changes.
 233      Used to see the difference between a font change and face change.  */
 234   unsigned default_face_done_p : 1;
 235
 236   /* Set to non-zero if this frame has already been hscrolled during
 237      current redisplay.  */
 238   unsigned already_hscrolled_p : 1;
 239
 240   /* Set to non-zero when current redisplay has updated frame.  */
 241   unsigned updated_p : 1;
 242
 243   /* Set to non-zero to minimize tool-bar height even when
 244      auto-resize-tool-bar is set to grow-only.  */
 245   unsigned minimize_tool_bar_window_p : 1;
 246
 247 #if defined (USE_GTK) || defined (HAVE_NS)
 248   /* Nonzero means using a tool bar that comes from the toolkit.  */
 249   int external_tool_bar;
 250 #endif
 251
 252   /* Margin at the top of the frame.  Used to display the tool-bar.  */
 253   int tool_bar_lines;
 254
 255   int n_tool_bar_rows;
 256   int n_tool_bar_items;
 257
 258   /* A buffer for decode_mode_line. */
 259   char *decode_mode_spec_buffer;
 260
 261   /* See do_line_insertion_deletion_costs for info on these arrays. */
 262   /* Cost of inserting 1 line on this frame */
 263   int *insert_line_cost;
 264   /* Cost of deleting 1 line on this frame */
 265   int *delete_line_cost;
 266   /* Cost of inserting n lines on this frame */
 267   int *insert_n_lines_cost;
 268   /* Cost of deleting n lines on this frame */
 269   int *delete_n_lines_cost;
 270
 271   /* Size of this frame, excluding fringes, scroll bars etc.,
 272      in units of canonical characters.  */
 273   EMACS_INT text_lines, text_cols;
 274
 275   /* Total size of this frame (i.e. its native window), in units of
 276      canonical characters.  */
 277   EMACS_INT total_lines, total_cols;
 278
 279   /* New text height and width for pending size change.
 280      0 if no change pending.  */
 281   int new_text_lines, new_text_cols;
 282
 283   /* Pixel position of the frame window (x and y offsets in root window).  */
 284   int left_pos, top_pos;
 285
 286   /* Size of the frame window in pixels.  */
 287   int pixel_height, pixel_width;
 288
 289   /* Dots per inch of the screen the frame is on.  */
 290   double resx, resy;
 291
 292   /* These many pixels are the difference between the outer window (i.e. the
 293      left and top of the window manager decoration) and FRAME_X_WINDOW. */
 294   int x_pixels_diff, y_pixels_diff;
 295
 296   /* This is the gravity value for the specified window position.  */
 297   int win_gravity;
 298
 299   /* The geometry flags for this window.  */
 300   int size_hint_flags;
 301
 302   /* Border width of the frame window as known by the (X) window system.  */
 303   int border_width;
 304
 305   /* Width of the internal border.  This is a line of background color
 306      just inside the window's border.  When the frame is selected,
 307      a highlighting is displayed inside the internal border.  */
 308   int internal_border_width;
 309
 310   /* Canonical X unit.  Width of default font, in pixels.  */
 311   int column_width;
 312
 313   /* Width of space glyph of default font, in pixels.  */
 314   int space_width;
 315
 316   /* Canonical Y unit.  Height of a line, in pixels.  */
 317   int line_height;
 318
 319   /* The output method says how the contents of this frame are
 320      displayed.  It could be using termcap, or using an X window.
 321      This must be the same as the terminal->type. */
 322   enum output_method output_method;
 323
 324   /* The terminal device that this frame uses.  If this is NULL, then
 325      the frame has been deleted. */
 326   struct terminal *terminal;
 327
 328   /* Device-dependent, frame-local auxiliary data used for displaying
 329      the contents.  When the frame is deleted, this data is deleted as
 330      well. */
 331   union output_data
 332   {
 333     struct tty_output *tty;     /* termchar.h */
 334     struct x_output *x;         /* xterm.h */
 335     struct w32_output *w32;     /* w32term.h */
 336     struct ns_output *ns;       /* nsterm.h */
 337     EMACS_INT nothing;
 338   }
 339   output_data;
 340
 341   /* List of font-drivers available on the frame. */
 342   struct font_driver_list *font_driver_list;
 343   /* List of data specific to font-driver and frame, but common to
 344      faces.  */
 345   struct font_data_list *font_data_list;
 346
 347   /* Total width of fringes reserved for drawing truncation bitmaps,
 348      continuation bitmaps and alike.  The width is in canonical char
 349      units of the frame.  This must currently be the case because window
 350      sizes aren't pixel values.  If it weren't the case, we wouldn't be
 351      able to split windows horizontally nicely.  */
 352   int fringe_cols;
 353
 354   /* The extra width (in pixels) currently allotted for fringes.  */
 355   int left_fringe_width, right_fringe_width;
 356
 357   /* See FULLSCREEN_ enum below */
 358   enum fullscreen_type want_fullscreen;
 359
 360   /* Number of lines of menu bar.  */
 361   int menu_bar_lines;
 362
 363 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
 364     || defined (HAVE_NS) || defined (USE_GTK)
 365   /* Nonzero means using a menu bar that comes from the X toolkit.  */
 366   unsigned int external_menu_bar : 1;
 367 #endif
 368
 369   /* Nonzero if last attempt at redisplay on this frame was preempted.  */
 370   unsigned char display_preempted : 1;
 371
 372   /* visible is nonzero if the frame is currently displayed; we check
 373      it to see if we should bother updating the frame's contents.
 374      DON'T SET IT DIRECTLY; instead, use FRAME_SET_VISIBLE.
 375
 376      Note that, since invisible frames aren't updated, whenever a
 377      frame becomes visible again, it must be marked as garbaged.  The
 378      FRAME_SAMPLE_VISIBILITY macro takes care of this.
 379
 380      On ttys and on Windows NT/9X, to avoid wasting effort updating
 381      visible frames that are actually completely obscured by other
 382      windows on the display, we bend the meaning of visible slightly:
 383      if greater than 1, then the frame is obscured - we still consider
 384      it to be "visible" as seen from lisp, but we don't bother
 385      updating it.  We must take care to garbage the frame when it
 386      ceaces to be obscured though.
 387
 388      iconified is nonzero if the frame is currently iconified.
 389
 390      Asynchronous input handlers should NOT change these directly;
 391      instead, they should change async_visible or async_iconified, and
 392      let the FRAME_SAMPLE_VISIBILITY macro set visible and iconified
 393      at the next redisplay.
 394
 395      These should probably be considered read-only by everyone except
 396      FRAME_SAMPLE_VISIBILITY.
 397
 398      These two are mutually exclusive.  They might both be zero, if the
 399      frame has been made invisible without an icon.  */
 400   unsigned char visible : 2;
 401   unsigned char iconified : 1;
 402
 403   /* Let's not use bitfields for volatile variables.  */
 404
 405   /* Asynchronous input handlers change these, and
 406      FRAME_SAMPLE_VISIBILITY copies them into visible and iconified.
 407      See FRAME_SAMPLE_VISIBILITY, below.  */
 408   volatile char async_visible, async_iconified;
 409
 410   /* Nonzero if this frame should be redrawn.  */
 411   volatile char garbaged;
 412
 413   /* True if frame actually has a minibuffer window on it.
 414      0 if using a minibuffer window that isn't on this frame.  */
 415   unsigned char has_minibuffer : 1;
 416
 417   /* 0 means, if this frame has just one window,
 418      show no modeline for that window.  */
 419   unsigned char wants_modeline : 1;
 420
 421   /* Non-zero if the hardware device this frame is displaying on can
 422      support scroll bars.  */
 423   char can_have_scroll_bars;
 424
 425   /* Non-0 means raise this frame to the top of the heap when selected.  */
 426   unsigned char auto_raise : 1;
 427
 428   /* Non-0 means lower this frame to the bottom of the stack when left.  */
 429   unsigned char auto_lower : 1;
 430
 431   /* True if frame's root window can't be split.  */
 432   unsigned char no_split : 1;
 433
 434   /* If this is set, then Emacs won't change the frame name to indicate
 435      the current buffer, etcetera.  If the user explicitly sets the frame
 436      name, this gets set.  If the user sets the name to Qnil, this is
 437      cleared.  */
 438   unsigned char explicit_name : 1;
 439
 440   /* Nonzero if size of some window on this frame has changed.  */
 441   unsigned char window_sizes_changed : 1;
 442
 443   /* Nonzero if the mouse has moved on this display device
 444      since the last time we checked.  */
 445   unsigned char mouse_moved :1;
 446
 447   /* Nonzero means that the pointer is invisible. */
 448   unsigned char pointer_invisible :1;
 449
 450   /* If can_have_scroll_bars is non-zero, this is non-zero if we should
 451      actually display them on this frame.  */
 452   enum vertical_scroll_bar_type vertical_scroll_bar_type;
 453
 454   /* What kind of text cursor should we draw in the future?
 455      This should always be filled_box_cursor or bar_cursor.  */
 456   enum text_cursor_kinds desired_cursor;
 457
 458   /* Width of bar cursor (if we are using that).  */
 459   int cursor_width;
 460
 461   /* What kind of text cursor should we draw when the cursor blinks off?
 462      This can be filled_box_cursor or bar_cursor or no_cursor.  */
 463   enum text_cursor_kinds blink_off_cursor;
 464
 465   /* Width of bar cursor (if we are using that) for blink-off state.  */
 466   int blink_off_cursor_width;
 467
 468   /* Storage for messages to this frame. */
 469   char *message_buf;
 470
 471   /* Nonnegative if current redisplay should not do scroll computation
 472      for lines beyond a certain vpos.  This is the vpos.  */
 473   int scroll_bottom_vpos;
 474
 475   /* Configured width of the scroll bar, in pixels and in characters.
 476      config_scroll_bar_cols tracks config_scroll_bar_width if the
 477      latter is positive; a zero value in config_scroll_bar_width means
 478      to compute the actual width on the fly, using config_scroll_bar_cols
 479      and the current font width.  */
 480   int config_scroll_bar_width;
 481   int config_scroll_bar_cols;
 482
 483   /* The size of the extra width currently allotted for vertical
 484      scroll bars in this frame, in pixels.  */
 485   int scroll_bar_actual_width;
 486
 487   /* The baud rate that was used to calculate costs for this frame.  */
 488   int cost_calculation_baud_rate;
 489
 490   /* frame opacity
 491      alpha[0]: alpha transparency of the active frame
 492      alpha[1]: alpha transparency of inactive frames
 493      Negative values mean not to change alpha.  */
 494   double alpha[2];
 495
 496   /* Exponent for gamma correction of colors.  1/(VIEWING_GAMMA *
 497      SCREEN_GAMMA) where viewing_gamma is 0.4545 and SCREEN_GAMMA is a
 498      frame parameter.  0 means don't do gamma correction.  */
 499   double gamma;
 500
 501   /* Additional space to put between text lines on this frame.  */
 502   int extra_line_spacing;
 503
 504   /* All display backends seem to need these two pixel values. */
 505   unsigned long background_pixel;
 506   unsigned long foreground_pixel;
 507 };
 508
 509 #define FRAME_KBOARD(f) ((f)->terminal->kboard)
 510
 511 /* Return a pointer to the image cache of frame F.  */
 512 #define FRAME_IMAGE_CACHE(F) ((F)->terminal->image_cache)
 513
 514 typedef struct frame *FRAME_PTR;
 515
 516 #define XFRAME(p) (eassert (FRAMEP(p)),(struct frame *) XPNTR (p))
 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) (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) (f)->minibuffer_window
 650
 651 /* The root window of the window tree of frame F.  */
 652 #define FRAME_ROOT_WINDOW(f) (f)->root_window
 653
 654 /* The currently selected window of the window tree of frame F.  */
 655 #define FRAME_SELECTED_WINDOW(f) (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) (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) ((f)->scroll_bars)
 765
 766 #define FRAME_CONDEMNED_SCROLL_BARS(f) ((f)->condemned_scroll_bars)
 767 #define FRAME_MENU_BAR_ITEMS(f) ((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 struct frame *make_initial_frame (void);
 851 extern struct frame *make_terminal_frame (struct terminal *);
 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 int other_visible_frames (struct frame *);
 860 extern void frame_make_pointer_invisible (void);
 861 extern void frame_make_pointer_visible (void);
 862 extern Lisp_Object delete_frame (Lisp_Object, Lisp_Object);
 863
 864 extern Lisp_Object Vframe_list;
 865 extern Lisp_Object Vdefault_frame_alist;
 866
 867 extern Lisp_Object Vterminal_frame;
 868
 869 extern Lisp_Object Vmouse_highlight;
 870 \f
 871 /* The currently selected frame.  */
 872
 873 extern Lisp_Object selected_frame;
 874
 875 /* Value is a pointer to the selected frame.  If the selected frame
 876    isn't live, abort.  */
 877
 878 #define SELECTED_FRAME()                                \
 879      ((FRAMEP (selected_frame)                          \
 880        && FRAME_LIVE_P (XFRAME (selected_frame)))       \
 881       ? XFRAME (selected_frame)                         \
 882       : (abort (), (struct frame *) 0))
 883
 884 \f
 885 /***********************************************************************
 886                         Display-related Macros
 887  ***********************************************************************/
 888
 889 /* Canonical y-unit on frame F.
 890    This value currently equals the line height of the frame (which is
 891    the height of the default font of F).  */
 892
 893 #define FRAME_LINE_HEIGHT(F) ((F)->line_height)
 894
 895 /* Canonical x-unit on frame F.
 896    This value currently equals the average width of the default font of F.  */
 897
 898 #define FRAME_COLUMN_WIDTH(F) ((F)->column_width)
 899
 900 /* Space glyph width of the default font of frame F.  */
 901
 902 #define FRAME_SPACE_WIDTH(F) ((F)->space_width)
 903
 904
 905 /* Pixel width of areas used to display truncation marks, continuation
 906    marks, overlay arrows.  This is 0 for terminal frames.  */
 907
 908 #ifdef HAVE_WINDOW_SYSTEM
 909
 910 /* Total width of fringes reserved for drawing truncation bitmaps,
 911    continuation bitmaps and alike.  The width is in canonical char
 912    units of the frame.  This must currently be the case because window
 913    sizes aren't pixel values.  If it weren't the case, we wouldn't be
 914    able to split windows horizontally nicely.  */
 915
 916 #define FRAME_FRINGE_COLS(F) ((F)->fringe_cols)
 917
 918 /* Pixel-width of the left and right fringe.  */
 919
 920 #define FRAME_LEFT_FRINGE_WIDTH(F) ((F)->left_fringe_width)
 921 #define FRAME_RIGHT_FRINGE_WIDTH(F) ((F)->right_fringe_width)
 922
 923 /* Total width of fringes in pixels.  */
 924
 925 #define FRAME_TOTAL_FRINGE_WIDTH(F) \
 926   (FRAME_LEFT_FRINGE_WIDTH (F) + FRAME_RIGHT_FRINGE_WIDTH (F))
 927
 928
 929 /* Pixel-width of internal border lines */
 930
 931 #define FRAME_INTERNAL_BORDER_WIDTH(F) ((F)->internal_border_width)
 932
 933 #else /* not HAVE_WINDOW_SYSTEM */
 934
 935 #define FRAME_FRINGE_COLS(F)    0
 936 #define FRAME_TOTAL_FRINGE_WIDTH(F)     0
 937 #define FRAME_LEFT_FRINGE_WIDTH(F)  0
 938 #define FRAME_RIGHT_FRINGE_WIDTH(F) 0
 939 #define FRAME_INTERNAL_BORDER_WIDTH(F) 0
 940
 941 #endif /* not HAVE_WINDOW_SYSTEM */
 942
 943
 944
 945 \f
 946 /***********************************************************************
 947             Conversion between canonical units and pixels
 948  ***********************************************************************/
 949
 950 /* Canonical x-values are fractions of FRAME_COLUMN_WIDTH, canonical
 951    y-unit are fractions of FRAME_LINE_HEIGHT of a frame.  Both are
 952    represented as Lisp numbers, i.e. integers or floats.  */
 953
 954 /* Convert canonical value X to pixels.  F is the frame whose
 955    canonical char width is to be used.  X must be a Lisp integer or
 956    float.  Value is a C integer.  */
 957
 958 #define FRAME_PIXEL_X_FROM_CANON_X(F, X)                \
 959      (INTEGERP (X)                                      \
 960       ? XINT (X) * FRAME_COLUMN_WIDTH (F)               \
 961       : (int) (XFLOAT_DATA (X) * FRAME_COLUMN_WIDTH (F)))
 962
 963 /* Convert canonical value Y to pixels.  F is the frame whose
 964    canonical character height is to be used.  X must be a Lisp integer
 965    or float.  Value is a C integer.  */
 966
 967 #define FRAME_PIXEL_Y_FROM_CANON_Y(F, Y)                \
 968      (INTEGERP (Y)                                      \
 969       ? XINT (Y) * FRAME_LINE_HEIGHT (F)                \
 970       : (int) (XFLOAT_DATA (Y) * FRAME_LINE_HEIGHT (F)))
 971
 972 /* Convert pixel-value X to canonical units.  F is the frame whose
 973    canonical character width is to be used.  X is a C integer.  Result
 974    is a Lisp float if X is not a multiple of the canon width,
 975    otherwise it's a Lisp integer.  */
 976
 977 #define FRAME_CANON_X_FROM_PIXEL_X(F, X)                        \
 978      ((X) % FRAME_COLUMN_WIDTH (F) != 0                         \
 979       ? make_float ((double) (X) / FRAME_COLUMN_WIDTH (F))      \
 980       : make_number ((X) / FRAME_COLUMN_WIDTH (F)))
 981
 982 /* Convert pixel-value Y to canonical units.  F is the frame whose
 983    canonical character height is to be used.  Y is a C integer.
 984    Result is a Lisp float if Y is not a multiple of the canon width,
 985    otherwise it's a Lisp integer.  */
 986
 987 #define FRAME_CANON_Y_FROM_PIXEL_Y(F, Y)                        \
 988      ((Y) % FRAME_LINE_HEIGHT (F)                               \
 989       ? make_float ((double) (Y) / FRAME_LINE_HEIGHT (F))       \
 990       : make_number ((Y) / FRAME_LINE_HEIGHT (F)))
 991
 992
 993 \f
 994 /* Manipulating pixel sizes and character sizes.
 995    Knowledge of which factors affect the overall size of the window should
 996    be hidden in these macros, if that's possible.
 997
 998    Return the upper/left pixel position of the character cell on frame F
 999    at ROW/COL.  */
1000
1001 #define FRAME_LINE_TO_PIXEL_Y(f, row) \
1002   (((row) < FRAME_TOP_MARGIN (f) ? 0 : FRAME_INTERNAL_BORDER_WIDTH (f)) \
1003    + (row) * FRAME_LINE_HEIGHT (f))
1004
1005 #define FRAME_COL_TO_PIXEL_X(f, col) \
1006   (FRAME_INTERNAL_BORDER_WIDTH (f) \
1007    + (col) * FRAME_COLUMN_WIDTH (f))
1008
1009 /* Return the pixel width/height of frame F if it has
1010    COLS columns/LINES rows.  */
1011
1012 #define FRAME_TEXT_COLS_TO_PIXEL_WIDTH(f, cols) \
1013   (FRAME_COL_TO_PIXEL_X (f, cols) \
1014    + (f)->scroll_bar_actual_width \
1015    + FRAME_TOTAL_FRINGE_WIDTH (f)      \
1016    + FRAME_INTERNAL_BORDER_WIDTH (f))
1017
1018 #define FRAME_TEXT_LINES_TO_PIXEL_HEIGHT(f, lines) \
1019   ((lines) * FRAME_LINE_HEIGHT (f) \
1020    + 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
1021
1022
1023 /* Return the row/column (zero-based) of the character cell containing
1024    the pixel on FRAME at Y/X.  */
1025
1026 #define FRAME_PIXEL_Y_TO_LINE(f, y) \
1027   (((y) < FRAME_TOP_MARGIN_HEIGHT (f)   \
1028     ? (y)       \
1029     : ((y) < FRAME_TOP_MARGIN_HEIGHT (f) + FRAME_INTERNAL_BORDER_WIDTH (f) \
1030        ? (y) - (FRAME_TOP_MARGIN_HEIGHT (f) + FRAME_INTERNAL_BORDER_WIDTH (f) \
1031                 /* Arrange for the division to round down.  */  \
1032                 + FRAME_LINE_HEIGHT (f) - 1)    \
1033        : (y) - FRAME_INTERNAL_BORDER_WIDTH (f)))        \
1034    / FRAME_LINE_HEIGHT (f))
1035
1036 #define FRAME_PIXEL_X_TO_COL(f, x) \
1037   (((x) - FRAME_INTERNAL_BORDER_WIDTH (f))      \
1038    / FRAME_COLUMN_WIDTH (f))
1039
1040 /* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
1041    frame F?  */
1042
1043 #define FRAME_PIXEL_WIDTH_TO_TEXT_COLS(f, width)                \
1044   (FRAME_PIXEL_X_TO_COL (f, ((width)                            \
1045                              - FRAME_INTERNAL_BORDER_WIDTH (f)  \
1046                              - FRAME_TOTAL_FRINGE_WIDTH (f)     \
1047                              - (f)->scroll_bar_actual_width)))
1048
1049 #define FRAME_PIXEL_HEIGHT_TO_TEXT_LINES(f, height) \
1050   (FRAME_PIXEL_Y_TO_LINE (f, ((height) \
1051                               - FRAME_INTERNAL_BORDER_WIDTH (f))))
1052
1053
1054 /***********************************************************************
1055                                 Frame Parameters
1056  ***********************************************************************/
1057
1058 extern Lisp_Object Qauto_raise, Qauto_lower;
1059 extern Lisp_Object Qborder_color, Qborder_width;
1060 extern Lisp_Object Qbuffer_predicate, Qbuffer_list, Qburied_buffer_list;
1061 extern Lisp_Object Qcursor_color, Qcursor_type;
1062 extern Lisp_Object Qfont;
1063 extern Lisp_Object Qbackground_color, Qforeground_color;
1064 extern Lisp_Object Qicon, Qicon_name, Qicon_type, Qicon_left, Qicon_top;
1065 extern Lisp_Object Qinternal_border_width;
1066 extern Lisp_Object Qtooltip;
1067 extern Lisp_Object Qmenu_bar_lines, Qtool_bar_lines, Qtool_bar_position;
1068 extern Lisp_Object Qmouse_color;
1069 extern Lisp_Object Qname, Qtitle;
1070 extern Lisp_Object Qparent_id;
1071 extern Lisp_Object Qunsplittable, Qvisibility;
1072 extern Lisp_Object Qscroll_bar_width, Qvertical_scroll_bars;
1073 extern Lisp_Object Qscroll_bar_foreground, Qscroll_bar_background;
1074 extern Lisp_Object Qscreen_gamma;
1075 extern Lisp_Object Qline_spacing;
1076 extern Lisp_Object Qwait_for_wm;
1077 extern Lisp_Object Qfullscreen;
1078 extern Lisp_Object Qfullwidth, Qfullheight, Qfullboth, Qmaximized;
1079 extern Lisp_Object Qsticky;
1080 extern Lisp_Object Qfont_backend;
1081 extern Lisp_Object Qalpha;
1082
1083 extern Lisp_Object Qleft_fringe, Qright_fringe;
1084 extern Lisp_Object Qheight, Qwidth;
1085 extern Lisp_Object Qminibuffer, Qmodeline;
1086 extern Lisp_Object Qx, Qw32, Qmac, Qpc, Qns;
1087 extern Lisp_Object Qvisible;
1088 extern Lisp_Object Qdisplay_type;
1089 extern Lisp_Object Qbackground_mode;
1090
1091 extern Lisp_Object Qx_resource_name;
1092
1093 extern Lisp_Object Qleft, Qright, Qtop, Qbox, Qbottom;
1094 extern Lisp_Object Qdisplay;
1095
1096 extern Lisp_Object Qrun_hook_with_args;
1097
1098 #ifdef HAVE_WINDOW_SYSTEM
1099
1100 /* The class of this X application.  */
1101 #define EMACS_CLASS "Emacs"
1102
1103 /* These are in xterm.c, w32term.c, etc.  */
1104
1105 extern void x_set_scroll_bar_default_width (struct frame *);
1106 extern void x_set_offset (struct frame *, int, int, int);
1107 extern void x_wm_set_icon_position (struct frame *, int, int);
1108
1109 extern Lisp_Object x_new_font (struct frame *, Lisp_Object, int);
1110
1111 /* These are in frame.c  */
1112
1113 extern Lisp_Object Vx_resource_name;
1114 extern Lisp_Object Vx_resource_class;
1115 extern Lisp_Object Vmenu_bar_mode, Vtool_bar_mode;
1116
1117
1118 extern Lisp_Object Qface_set_after_frame_default;
1119
1120 extern void x_fullscreen_adjust (struct frame *f, int *, int *,
1121                                  int *, int *);
1122
1123 extern void x_set_frame_parameters (struct frame *, Lisp_Object);
1124 extern void x_report_frame_params (struct frame *, Lisp_Object *);
1125
1126 extern void x_set_fullscreen (struct frame *, Lisp_Object, Lisp_Object);
1127 extern void x_set_line_spacing (struct frame *, Lisp_Object, Lisp_Object);
1128 extern void x_set_screen_gamma (struct frame *, Lisp_Object, Lisp_Object);
1129 extern void x_set_font (struct frame *, Lisp_Object, Lisp_Object);
1130 extern void x_set_font_backend (struct frame *, Lisp_Object, Lisp_Object);
1131 extern void x_set_fringe_width (struct frame *, Lisp_Object, Lisp_Object);
1132 extern void x_set_border_width (struct frame *, Lisp_Object, Lisp_Object);
1133 extern void x_set_internal_border_width (struct frame *, Lisp_Object,
1134                                          Lisp_Object);
1135 extern void x_set_visibility (struct frame *, Lisp_Object, Lisp_Object);
1136 extern void x_set_autoraise (struct frame *, Lisp_Object, Lisp_Object);
1137 extern void x_set_autolower (struct frame *, Lisp_Object, Lisp_Object);
1138 extern void x_set_unsplittable (struct frame *, Lisp_Object, Lisp_Object);
1139 extern void x_set_vertical_scroll_bars (struct frame *, Lisp_Object,
1140                                         Lisp_Object);
1141 extern void x_set_scroll_bar_width (struct frame *, Lisp_Object,
1142                                     Lisp_Object);
1143
1144 extern Lisp_Object x_icon_type (struct frame *);
1145
1146 extern int x_figure_window_size (struct frame *, Lisp_Object, int);
1147
1148 extern Lisp_Object Vframe_alpha_lower_limit;
1149 extern void x_set_alpha (struct frame *, Lisp_Object, Lisp_Object);
1150
1151 extern void validate_x_resource_name (void);
1152
1153 extern Lisp_Object display_x_get_resource (Display_Info *,
1154                                            Lisp_Object attribute,
1155                                            Lisp_Object class,
1156                                            Lisp_Object component,
1157                                            Lisp_Object subclass);
1158
1159 /* In xmenu.c */
1160 extern void set_frame_menubar (FRAME_PTR, int, int);
1161
1162 #endif /* HAVE_WINDOW_SYSTEM */
1163
1164 #endif /* not EMACS_FRAME_H */
1165
1166 /* arch-tag: 0df048ee-e6bf-4f48-bd56-e3cd055dd8c4
1167    (do not change this comment) */