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