src/frame.h

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