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 redrawn.  */
 379   bool_bf garbaged : 1;
 380
 381   /* False means, if this frame has just one window,
 382      show no modeline for that window.  */
 383   bool_bf wants_modeline : 1;
 384
 385   /* True means raise this frame to the top of the heap when selected.  */
 386   bool_bf auto_raise : 1;
 387
 388   /* True means lower this frame to the bottom of the stack when left.  */
 389   bool_bf auto_lower : 1;
 390
 391   /* True if frame's root window can't be split.  */
 392   bool_bf no_split : 1;
 393
 394   /* If this is set, then Emacs won't change the frame name to indicate
 395      the current buffer, etcetera.  If the user explicitly sets the frame
 396      name, this gets set.  If the user sets the name to Qnil, this is
 397      cleared.  */
 398   bool_bf explicit_name : 1;
 399
 400   /* True if size of some window on this frame has changed.  */
 401   bool_bf window_sizes_changed : 1;
 402
 403   /* True if the mouse has moved on this display device
 404      since the last time we checked.  */
 405   bool_bf mouse_moved : 1;
 406
 407   /* True means that the pointer is invisible.  */
 408   bool_bf pointer_invisible : 1;
 409
 410   /* True means that all windows except mini-window and
 411      selected window on this frame have frozen window starts.  */
 412   bool_bf frozen_window_starts : 1;
 413
 414   /* Nonzero if we should actually display the scroll bars on this frame.  */
 415   enum vertical_scroll_bar_type vertical_scroll_bar_type;
 416
 417   /* What kind of text cursor should we draw in the future?
 418      This should always be filled_box_cursor or bar_cursor.  */
 419   enum text_cursor_kinds desired_cursor;
 420
 421   /* Width of bar cursor (if we are using that).  */
 422   int cursor_width;
 423
 424   /* What kind of text cursor should we draw when the cursor blinks off?
 425      This can be filled_box_cursor or bar_cursor or no_cursor.  */
 426   enum text_cursor_kinds blink_off_cursor;
 427
 428   /* Width of bar cursor (if we are using that) for blink-off state.  */
 429   int blink_off_cursor_width;
 430
 431   /* Configured width of the scroll bar, in pixels and in characters.
 432      config_scroll_bar_cols tracks config_scroll_bar_width if the
 433      latter is positive; a zero value in config_scroll_bar_width means
 434      to compute the actual width on the fly, using config_scroll_bar_cols
 435      and the current font width.  */
 436   int config_scroll_bar_width;
 437   int config_scroll_bar_cols;
 438
 439   /* The baud rate that was used to calculate costs for this frame.  */
 440   int cost_calculation_baud_rate;
 441
 442   /* frame opacity
 443      alpha[0]: alpha transparency of the active frame
 444      alpha[1]: alpha transparency of inactive frames
 445      Negative values mean not to change alpha.  */
 446   double alpha[2];
 447
 448   /* Exponent for gamma correction of colors.  1/(VIEWING_GAMMA *
 449      SCREEN_GAMMA) where viewing_gamma is 0.4545 and SCREEN_GAMMA is a
 450      frame parameter.  0 means don't do gamma correction.  */
 451   double gamma;
 452
 453   /* Additional space to put between text lines on this frame.  */
 454   int extra_line_spacing;
 455
 456   /* All display backends seem to need these two pixel values. */
 457   unsigned long background_pixel;
 458   unsigned long foreground_pixel;
 459 };
 460
 461 /* Most code should use these functions to set Lisp fields in struct frame.  */
 462
 463 INLINE void
 464 fset_buffer_list (struct frame *f, Lisp_Object val)
 465 {
 466   f->buffer_list = val;
 467 }
 468 INLINE void
 469 fset_buried_buffer_list (struct frame *f, Lisp_Object val)
 470 {
 471   f->buried_buffer_list = val;
 472 }
 473 INLINE void
 474 fset_condemned_scroll_bars (struct frame *f, Lisp_Object val)
 475 {
 476   f->condemned_scroll_bars = val;
 477 }
 478 INLINE void
 479 fset_face_alist (struct frame *f, Lisp_Object val)
 480 {
 481   f->face_alist = val;
 482 }
 483 INLINE void
 484 fset_focus_frame (struct frame *f, Lisp_Object val)
 485 {
 486   f->focus_frame = val;
 487 }
 488 INLINE void
 489 fset_icon_name (struct frame *f, Lisp_Object val)
 490 {
 491   f->icon_name = val;
 492 }
 493 INLINE void
 494 fset_menu_bar_items (struct frame *f, Lisp_Object val)
 495 {
 496   f->menu_bar_items = val;
 497 }
 498 INLINE void
 499 fset_menu_bar_vector (struct frame *f, Lisp_Object val)
 500 {
 501   f->menu_bar_vector = val;
 502 }
 503 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
 504 INLINE void
 505 fset_menu_bar_window (struct frame *f, Lisp_Object val)
 506 {
 507   f->menu_bar_window = val;
 508 }
 509 #endif
 510 INLINE void
 511 fset_name (struct frame *f, Lisp_Object val)
 512 {
 513   f->name = val;
 514 }
 515 INLINE void
 516 fset_param_alist (struct frame *f, Lisp_Object val)
 517 {
 518   f->param_alist = val;
 519 }
 520 INLINE void
 521 fset_root_window (struct frame *f, Lisp_Object val)
 522 {
 523   f->root_window = val;
 524 }
 525 INLINE void
 526 fset_scroll_bars (struct frame *f, Lisp_Object val)
 527 {
 528   f->scroll_bars = val;
 529 }
 530 INLINE void
 531 fset_selected_window (struct frame *f, Lisp_Object val)
 532 {
 533   f->selected_window = val;
 534 }
 535 INLINE void
 536 fset_title (struct frame *f, Lisp_Object val)
 537 {
 538   f->title = val;
 539 }
 540 INLINE void
 541 fset_tool_bar_items (struct frame *f, Lisp_Object val)
 542 {
 543   f->tool_bar_items = val;
 544 }
 545 INLINE void
 546 fset_tool_bar_position (struct frame *f, Lisp_Object val)
 547 {
 548   f->tool_bar_position = val;
 549 }
 550 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
 551 INLINE void
 552 fset_tool_bar_window (struct frame *f, Lisp_Object val)
 553 {
 554   f->tool_bar_window = val;
 555 }
 556 INLINE void
 557 fset_current_tool_bar_string (struct frame *f, Lisp_Object val)
 558 {
 559   f->current_tool_bar_string = val;
 560 }
 561 INLINE void
 562 fset_desired_tool_bar_string (struct frame *f, Lisp_Object val)
 563 {
 564   f->desired_tool_bar_string = val;
 565 }
 566 #endif /* HAVE_WINDOW_SYSTEM && !USE_GTK && !HAVE_NS */
 567
 568 #define NUMVAL(X) ((INTEGERP (X) || FLOATP (X)) ? XFLOATINT (X) : -1)
 569
 570 INLINE double
 571 default_pixels_per_inch_x (void)
 572 {
 573   Lisp_Object v = (CONSP (Vdisplay_pixels_per_inch)
 574                    ? XCAR (Vdisplay_pixels_per_inch)
 575                    : Vdisplay_pixels_per_inch);
 576   return NUMVAL (v) > 0 ? NUMVAL (v) : 72.0;
 577 }
 578
 579 INLINE double
 580 default_pixels_per_inch_y (void)
 581 {
 582   Lisp_Object v = (CONSP (Vdisplay_pixels_per_inch)
 583                    ? XCDR (Vdisplay_pixels_per_inch)
 584                    : Vdisplay_pixels_per_inch);
 585   return NUMVAL (v) > 0 ? NUMVAL (v) : 72.0;
 586 }
 587
 588 #define FRAME_KBOARD(f) ((f)->terminal->kboard)
 589
 590 /* Return a pointer to the image cache of frame F.  */
 591 #define FRAME_IMAGE_CACHE(F) ((F)->terminal->image_cache)
 592
 593 #define XFRAME(p) \
 594   (eassert (FRAMEP (p)), (struct frame *) XUNTAG (p, Lisp_Vectorlike))
 595 #define XSETFRAME(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_FRAME))
 596
 597 /* Given a window, return its frame as a Lisp_Object.  */
 598 #define WINDOW_FRAME(w) ((w)->frame)
 599
 600 /* Test a frame for particular kinds of display methods.  */
 601 #define FRAME_INITIAL_P(f) ((f)->output_method == output_initial)
 602 #define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap)
 603 #define FRAME_X_P(f) ((f)->output_method == output_x_window)
 604 #ifndef HAVE_NTGUI
 605 #define FRAME_W32_P(f) false
 606 #else
 607 #define FRAME_W32_P(f) ((f)->output_method == output_w32)
 608 #endif
 609 #ifndef MSDOS
 610 #define FRAME_MSDOS_P(f) false
 611 #else
 612 #define FRAME_MSDOS_P(f) ((f)->output_method == output_msdos_raw)
 613 #endif
 614 #ifndef HAVE_NS
 615 #define FRAME_NS_P(f) false
 616 #else
 617 #define FRAME_NS_P(f) ((f)->output_method == output_ns)
 618 #endif
 619
 620 /* FRAME_WINDOW_P tests whether the frame is a window, and is
 621    defined to be the predicate for the window system being used.  */
 622
 623 #ifdef HAVE_X_WINDOWS
 624 #define FRAME_WINDOW_P(f) FRAME_X_P (f)
 625 #endif
 626 #ifdef HAVE_NTGUI
 627 #define FRAME_WINDOW_P(f) FRAME_W32_P (f)
 628 #endif
 629 #ifdef HAVE_NS
 630 #define FRAME_WINDOW_P(f) FRAME_NS_P(f)
 631 #endif
 632 #ifndef FRAME_WINDOW_P
 633 #define FRAME_WINDOW_P(f) ((void) (f), false)
 634 #endif
 635
 636 /* Dots per inch of the screen the frame F is on.  */
 637
 638 #ifdef HAVE_WINDOW_SYSTEM
 639
 640 #define FRAME_RES_X(f)                                          \
 641   (eassert (FRAME_WINDOW_P (f)), FRAME_DISPLAY_INFO (f)->resx)
 642 #define FRAME_RES_Y(f)                                          \
 643   (eassert (FRAME_WINDOW_P (f)), FRAME_DISPLAY_INFO (f)->resy)
 644
 645 #else /* !HAVE_WINDOW_SYSTEM */
 646
 647 /* Defaults when no window system available.  */
 648
 649 #define FRAME_RES_X(f) default_pixels_per_inch_x ()
 650 #define FRAME_RES_Y(f) default_pixels_per_inch_y ()
 651
 652 #endif /* HAVE_WINDOW_SYSTEM */
 653
 654 /* Return a pointer to the structure holding information about the
 655    region of text, if any, that is currently shown in mouse-face on
 656    frame F.  We need to define two versions because a TTY-only build
 657    does not have FRAME_DISPLAY_INFO.  */
 658 #ifdef HAVE_WINDOW_SYSTEM
 659 # define MOUSE_HL_INFO(F)                                       \
 660   (FRAME_WINDOW_P(F)                                            \
 661    ? &FRAME_DISPLAY_INFO(F)->mouse_highlight                    \
 662    : &(F)->output_data.tty->display_info->mouse_highlight)
 663 #else
 664 # define MOUSE_HL_INFO(F)                                       \
 665   (&(F)->output_data.tty->display_info->mouse_highlight)
 666 #endif
 667
 668 /* True if frame F is still alive (not deleted).  */
 669 #define FRAME_LIVE_P(f) ((f)->terminal != 0)
 670
 671 /* True if frame F is a minibuffer-only frame.  */
 672 #define FRAME_MINIBUF_ONLY_P(f) \
 673   EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f))
 674
 675 /* True if frame F contains it's own minibuffer window.  Frame always has
 676    minibuffer window, but it could use minibuffer window of another frame.  */
 677 #define FRAME_HAS_MINIBUF_P(f)                                  \
 678   (WINDOWP (f->minibuffer_window)                               \
 679    && XFRAME (XWINDOW (f->minibuffer_window)->frame) == f)
 680
 681 /* Pixel width of frame F.  */
 682 #define FRAME_PIXEL_WIDTH(f) ((f)->pixel_width)
 683
 684 /* Pixel height of frame F, including non-toolkit menu bar and
 685    non-toolkit tool bar lines.  */
 686 #define FRAME_PIXEL_HEIGHT(f) ((f)->pixel_height)
 687
 688 /* Width of frame F, measured in canonical character columns,
 689    not including scroll bars if any.  */
 690 #define FRAME_COLS(f) (f)->text_cols
 691
 692 /* Height of frame F, measured in canonical lines, including
 693    non-toolkit menu bar and non-toolkit tool bar lines.  */
 694 #define FRAME_LINES(f) (f)->text_lines
 695
 696 /* Width of frame F, measured in pixels not including the width for
 697    fringes, scroll bar, and internal borders.  */
 698 #define FRAME_TEXT_WIDTH(f) (f)->text_width
 699
 700 /* Height of frame F, measured in pixels not including the height
 701    for internal borders.  */
 702 #define FRAME_TEXT_HEIGHT(f) (f)->text_height
 703
 704 /* Number of lines of frame F used for menu bar.
 705    This is relevant on terminal frames and on
 706    X Windows when not using the X toolkit.
 707    These lines are counted in FRAME_LINES.  */
 708 #define FRAME_MENU_BAR_LINES(f) (f)->menu_bar_lines
 709
 710 /* Pixel height of frame F's menu bar.  */
 711 #define FRAME_MENU_BAR_HEIGHT(f) (f)->menu_bar_height
 712
 713 /* True if this frame should display a tool bar
 714    in a way that does not use any text lines.  */
 715 #if defined (USE_GTK) || defined (HAVE_NS)
 716 #define FRAME_EXTERNAL_TOOL_BAR(f) (f)->external_tool_bar
 717 #else
 718 #define FRAME_EXTERNAL_TOOL_BAR(f) false
 719 #endif
 720
 721 /* Number of lines of frame F used for the tool-bar.  */
 722 #define FRAME_TOOL_BAR_LINES(f) (f)->tool_bar_lines
 723
 724 /* Pixel height of frame F's tool-bar.  */
 725 #define FRAME_TOOL_BAR_HEIGHT(f) (f)->tool_bar_height
 726
 727 /* Lines above the top-most window in frame F.  */
 728 #define FRAME_TOP_MARGIN(F) \
 729   (FRAME_MENU_BAR_LINES (F) + FRAME_TOOL_BAR_LINES (F))
 730
 731 /* Pixel height of frame F's top margin.  */
 732 #define FRAME_TOP_MARGIN_HEIGHT(F)                              \
 733   (FRAME_MENU_BAR_HEIGHT (F) + FRAME_TOOL_BAR_HEIGHT (F))
 734
 735 /* True if this frame should display a menu bar
 736    in a way that does not use any text lines.  */
 737 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
 738      || defined (HAVE_NS) || defined (USE_GTK)
 739 #define FRAME_EXTERNAL_MENU_BAR(f) (f)->external_menu_bar
 740 #else
 741 #define FRAME_EXTERNAL_MENU_BAR(f) false
 742 #endif
 743 #define FRAME_VISIBLE_P(f) (f)->visible
 744
 745 /* True if frame F is currently visible but hidden.  */
 746 #define FRAME_OBSCURED_P(f) ((f)->visible > 1)
 747
 748 /* True if frame F is currently iconified.  */
 749 #define FRAME_ICONIFIED_P(f) (f)->iconified
 750
 751 /* Mark frame F as currently garbaged.  */
 752 #define SET_FRAME_GARBAGED(f)                           \
 753   (frame_garbaged = true, fset_redisplay (f), f->garbaged = true)
 754
 755 /* True if frame F is currently garbaged.  */
 756 #define FRAME_GARBAGED_P(f) (f)->garbaged
 757
 758 /* True means do not allow splitting this frame's window.  */
 759 #define FRAME_NO_SPLIT_P(f) (f)->no_split
 760
 761 /* Not really implemented.  */
 762 #define FRAME_WANTS_MODELINE_P(f) (f)->wants_modeline
 763
 764 /* True if all windows except selected window and mini window
 765    are frozen on frame F.  */
 766 #define FRAME_WINDOWS_FROZEN(f) (f)->frozen_window_starts
 767
 768 /* True if a size change has been requested for frame F
 769    but not yet really put into effect.  This can be true temporarily
 770    when an X event comes in at a bad time.  */
 771 #define FRAME_WINDOW_SIZES_CHANGED(f) (f)->window_sizes_changed
 772
 773 /* The minibuffer window of frame F, if it has one; otherwise nil.  */
 774 #define FRAME_MINIBUF_WINDOW(f) f->minibuffer_window
 775
 776 /* The root window of the window tree of frame F.  */
 777 #define FRAME_ROOT_WINDOW(f) f->root_window
 778
 779 /* The currently selected window of the window tree of frame F.  */
 780 #define FRAME_SELECTED_WINDOW(f) f->selected_window
 781
 782 #define FRAME_INSERT_COST(f) (f)->insert_line_cost
 783 #define FRAME_DELETE_COST(f) (f)->delete_line_cost
 784 #define FRAME_INSERTN_COST(f) (f)->insert_n_lines_cost
 785 #define FRAME_DELETEN_COST(f) (f)->delete_n_lines_cost
 786 #define FRAME_FOCUS_FRAME(f) f->focus_frame
 787
 788 /* This frame slot says whether scroll bars are currently enabled for frame F,
 789    and which side they are on.  */
 790 #define FRAME_VERTICAL_SCROLL_BAR_TYPE(f) ((f)->vertical_scroll_bar_type)
 791 #define FRAME_HAS_VERTICAL_SCROLL_BARS(f) \
 792   ((f)->vertical_scroll_bar_type != vertical_scroll_bar_none)
 793 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT(f) \
 794   ((f)->vertical_scroll_bar_type == vertical_scroll_bar_left)
 795 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT(f) \
 796   ((f)->vertical_scroll_bar_type == vertical_scroll_bar_right)
 797
 798 /* Width that a scroll bar in frame F should have, if there is one.
 799    Measured in pixels.
 800    If scroll bars are turned off, this is still nonzero.  */
 801 #define FRAME_CONFIG_SCROLL_BAR_WIDTH(f) ((f)->config_scroll_bar_width)
 802
 803 /* Width that a scroll bar in frame F should have, if there is one.
 804    Measured in columns (characters).
 805    If scroll bars are turned off, this is still nonzero.  */
 806 #define FRAME_CONFIG_SCROLL_BAR_COLS(f) ((f)->config_scroll_bar_cols)
 807
 808 /* Width of a scroll bar in frame F, measured in columns (characters),
 809    but only if scroll bars are on the left.  If scroll bars are on
 810    the right in this frame, or there are no scroll bars, value is 0.  */
 811
 812 #define FRAME_LEFT_SCROLL_BAR_COLS(f)                   \
 813   (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f)           \
 814    ? FRAME_CONFIG_SCROLL_BAR_COLS (f)                   \
 815    : 0)
 816
 817 /* Width of a left scroll bar in frame F, measured in pixels */
 818
 819 #define FRAME_LEFT_SCROLL_BAR_AREA_WIDTH(f)                             \
 820   (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f)                           \
 821    ? FRAME_CONFIG_SCROLL_BAR_WIDTH (f)                                  \
 822    : 0)
 823
 824 /* Width of a scroll bar in frame F, measured in columns (characters),
 825    but only if scroll bars are on the right.  If scroll bars are on
 826    the left in this frame, or there are no scroll bars, value is 0.  */
 827
 828 #define FRAME_RIGHT_SCROLL_BAR_COLS(f)                  \
 829   (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f)          \
 830    ? FRAME_CONFIG_SCROLL_BAR_COLS (f)                   \
 831    : 0)
 832
 833 /* Width of a right scroll bar area in frame F, measured in pixels */
 834
 835 #define FRAME_RIGHT_SCROLL_BAR_AREA_WIDTH(f)                            \
 836   (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f)                          \
 837    ? FRAME_CONFIG_SCROLL_BAR_WIDTH (f)                                  \
 838    : 0)
 839
 840 /* Actual width of a scroll bar in frame F, measured in columns.  */
 841
 842 #define FRAME_SCROLL_BAR_COLS(f)                        \
 843   (FRAME_HAS_VERTICAL_SCROLL_BARS (f)                   \
 844    ? FRAME_CONFIG_SCROLL_BAR_COLS (f)                   \
 845    : 0)
 846
 847 /* Actual width of a scroll bar area in frame F, measured in pixels.  */
 848
 849 #define FRAME_SCROLL_BAR_AREA_WIDTH(f)                                  \
 850   (FRAME_HAS_VERTICAL_SCROLL_BARS (f)                                   \
 851    ? FRAME_CONFIG_SCROLL_BAR_WIDTH (f)                                  \
 852    : 0)
 853
 854 /* Total width of frame F, in columns (characters),
 855    including the width used by scroll bars if any.  */
 856 #define FRAME_TOTAL_COLS(f) ((f)->total_cols)
 857
 858 /* Set the character widths of frame F.  WIDTH specifies a nominal
 859    character text width.  */
 860 #define SET_FRAME_COLS(f, width)                                        \
 861   ((f)->text_cols = (width),                                            \
 862    (f)->total_cols = ((width)                                           \
 863                       + FRAME_SCROLL_BAR_COLS (f)                       \
 864                       + FRAME_FRINGE_COLS (f)))
 865
 866 /* Set the pixel widths of frame F.  WIDTH specifies a nominal pixel
 867    text width.  */
 868 #define SET_FRAME_WIDTH(f, width)                                       \
 869   ((f)->text_width = (width),                                           \
 870    (f)->pixel_width = ((width)                                          \
 871                        + FRAME_SCROLL_BAR_AREA_WIDTH (f)                \
 872                        + FRAME_TOTAL_FRINGE_WIDTH (f)                   \
 873                        + 2 * FRAME_INTERNAL_BORDER_WIDTH (f)))
 874
 875 /* Set the pixel heights of frame F.  HEIGHT specifies a nominal pixel
 876    text width.  */
 877 #define SET_FRAME_HEIGHT(f, height)                                     \
 878   ((f)->text_height = (height),                                         \
 879    (f)->pixel_height = ((height)                                        \
 880                        + 2 * FRAME_INTERNAL_BORDER_WIDTH (f)))
 881
 882 /* Maximum + 1 legitimate value for FRAME_CURSOR_X.  */
 883
 884 #define FRAME_CURSOR_X_LIMIT(f) \
 885   (FRAME_COLS (f) + FRAME_LEFT_SCROLL_BAR_COLS (f))
 886
 887 #define FRAME_SCROLL_BARS(f) (f->scroll_bars)
 888
 889 #define FRAME_CONDEMNED_SCROLL_BARS(f) (f->condemned_scroll_bars)
 890 #define FRAME_MENU_BAR_ITEMS(f) (f->menu_bar_items)
 891 #define FRAME_COST_BAUD_RATE(f) ((f)->cost_calculation_baud_rate)
 892
 893 #define FRAME_DESIRED_CURSOR(f) ((f)->desired_cursor)
 894 #define FRAME_BLINK_OFF_CURSOR(f) ((f)->blink_off_cursor)
 895 #define FRAME_CURSOR_WIDTH(f) ((f)->cursor_width)
 896 #define FRAME_BLINK_OFF_CURSOR_WIDTH(f) ((f)->blink_off_cursor_width)
 897
 898 #define FRAME_FOREGROUND_PIXEL(f) ((f)->foreground_pixel)
 899 #define FRAME_BACKGROUND_PIXEL(f) ((f)->background_pixel)
 900
 901 /* Return a pointer to the face cache of frame F.  */
 902
 903 #define FRAME_FACE_CACHE(F)     (F)->face_cache
 904
 905 /* Return the size of message_buf of the frame F.  We multiply the
 906    width of the frame by 4 because multi-byte form may require at most
 907    4-byte for a character.  */
 908
 909 #define FRAME_MESSAGE_BUF_SIZE(f) (((int) FRAME_COLS (f)) * 4)
 910
 911 #define CHECK_FRAME(x) \
 912   CHECK_TYPE (FRAMEP (x), Qframep, x)
 913
 914 #define CHECK_LIVE_FRAME(x) \
 915   CHECK_TYPE (FRAMEP (x) && FRAME_LIVE_P (XFRAME (x)), Qframe_live_p, x)
 916
 917 /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
 918    `for' loop which iterates over the elements of Vframe_list.  The
 919    loop will set FRAME_VAR, a Lisp_Object, to each frame in
 920    Vframe_list in succession and execute the statement.  LIST_VAR
 921    should be a Lisp_Object too; it is used to iterate through the
 922    Vframe_list.
 923
 924    This macro is a holdover from a time when multiple frames weren't always
 925    supported.  An alternate definition of the macro would expand to
 926    something which executes the statement once.  */
 927
 928 #define FOR_EACH_FRAME(list_var, frame_var)     \
 929   for ((list_var) = Vframe_list;                \
 930        (CONSP (list_var)                        \
 931         && (frame_var = XCAR (list_var), true)); \
 932        list_var = XCDR (list_var))
 933
 934 /* Reflect mouse movement when a complete frame update is performed.  */
 935
 936 #define FRAME_MOUSE_UPDATE(frame)                               \
 937   do {                                                          \
 938     Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (frame);               \
 939     if (frame == hlinfo->mouse_face_mouse_frame)                \
 940       {                                                         \
 941         block_input ();                                         \
 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 (false)
 948
 949 /* Set visibility of frame F.
 950    We call redisplay_other_windows to make sure the frame gets redisplayed
 951    if some changes were applied to it while it wasn't visible (and hence
 952    wasn't redisplayed).  */
 953
 954 INLINE void
 955 SET_FRAME_VISIBLE (struct frame *f, int v)
 956 {
 957   eassert (0 <= v && v <= 2);
 958   if (v == 1 && f->visible != 1)
 959     redisplay_other_windows ();
 960   f->visible = v;
 961 }
 962
 963 /* Set iconify of frame F.  */
 964
 965 #define SET_FRAME_ICONIFIED(f, i)                       \
 966   (f)->iconified = (eassert (0 <= (i) && (i) <= 1), (i))
 967
 968 extern Lisp_Object selected_frame;
 969 extern Lisp_Object Qframep, Qframe_live_p;
 970 extern Lisp_Object Qtty, Qtty_type;
 971 extern Lisp_Object Qtty_color_mode;
 972 extern Lisp_Object Qterminal;
 973 extern Lisp_Object Qnoelisp;
 974
 975 /* True means there is at least one garbaged frame.  */
 976 extern bool frame_garbaged;
 977
 978 extern void set_menu_bar_lines (struct frame *, Lisp_Object, Lisp_Object);
 979 extern struct frame *decode_window_system_frame (Lisp_Object);
 980 extern struct frame *decode_live_frame (Lisp_Object);
 981 extern struct frame *decode_any_frame (Lisp_Object);
 982 extern struct frame *make_initial_frame (void);
 983 extern struct frame *make_frame (bool);
 984 #ifdef HAVE_WINDOW_SYSTEM
 985 extern struct frame *make_minibuffer_frame (void);
 986 extern struct frame *make_frame_without_minibuffer (Lisp_Object,
 987                                                     struct kboard *,
 988                                                     Lisp_Object);
 989 #endif /* HAVE_WINDOW_SYSTEM */
 990 extern bool window_system_available (struct frame *);
 991 extern void check_window_system (struct frame *);
 992 extern void frame_make_pointer_invisible (void);
 993 extern void frame_make_pointer_visible (void);
 994 extern Lisp_Object delete_frame (Lisp_Object, Lisp_Object);
 995
 996 extern Lisp_Object Vframe_list;
 997
 998 /* Value is a pointer to the selected frame.  If the selected frame
 999    isn't live, abort.  */
1000
1001 #define SELECTED_FRAME()                                \
1002      ((FRAMEP (selected_frame)                          \
1003        && FRAME_LIVE_P (XFRAME (selected_frame)))       \
1004       ? XFRAME (selected_frame)                         \
1005       : (emacs_abort (), (struct frame *) 0))
1006
1007 \f
1008 /***********************************************************************
1009                         Display-related Macros
1010  ***********************************************************************/
1011
1012 /* Canonical y-unit on frame F.
1013    This value currently equals the line height of the frame (which is
1014    the height of the default font of F).  */
1015
1016 #define FRAME_LINE_HEIGHT(F) ((F)->line_height)
1017
1018 /* Canonical x-unit on frame F.
1019    This value currently equals the average width of the default font of F.  */
1020
1021 #define FRAME_COLUMN_WIDTH(F) ((F)->column_width)
1022
1023 /* Pixel width of areas used to display truncation marks, continuation
1024    marks, overlay arrows.  This is 0 for terminal frames.  */
1025
1026 #ifdef HAVE_WINDOW_SYSTEM
1027
1028 /* Total width of fringes reserved for drawing truncation bitmaps,
1029    continuation bitmaps and alike.  The width is in canonical char
1030    units of the frame.  This must currently be the case because window
1031    sizes aren't pixel values.  If it weren't the case, we wouldn't be
1032    able to split windows horizontally nicely.  */
1033
1034 #define FRAME_FRINGE_COLS(F) ((F)->fringe_cols)
1035
1036 /* Pixel-width of the left and right fringe.  */
1037
1038 #define FRAME_LEFT_FRINGE_WIDTH(F) ((F)->left_fringe_width)
1039 #define FRAME_RIGHT_FRINGE_WIDTH(F) ((F)->right_fringe_width)
1040
1041 /* Total width of fringes in pixels.  */
1042
1043 #define FRAME_TOTAL_FRINGE_WIDTH(F) \
1044   (FRAME_LEFT_FRINGE_WIDTH (F) + FRAME_RIGHT_FRINGE_WIDTH (F))
1045
1046 /* Pixel-width of internal border lines */
1047 #define FRAME_INTERNAL_BORDER_WIDTH(F) ((F)->internal_border_width)
1048
1049 /* Pixel-size of window border lines */
1050 #define FRAME_RIGHT_DIVIDER_WIDTH(F) ((F)->right_divider_width)
1051 #define FRAME_BOTTOM_DIVIDER_WIDTH(F) ((F)->bottom_divider_width)
1052
1053 #else /* not HAVE_WINDOW_SYSTEM */
1054
1055 #define FRAME_FRINGE_COLS(F)    0
1056 #define FRAME_TOTAL_FRINGE_WIDTH(F)     0
1057 #define FRAME_LEFT_FRINGE_WIDTH(F)  0
1058 #define FRAME_RIGHT_FRINGE_WIDTH(F) 0
1059 #define FRAME_INTERNAL_BORDER_WIDTH(F) 0
1060 #define FRAME_RIGHT_DIVIDER_WIDTH(F) 0
1061 #define FRAME_BOTTOM_DIVIDER_WIDTH(F) 0
1062
1063 #endif /* not HAVE_WINDOW_SYSTEM */
1064 \f
1065 /***********************************************************************
1066             Conversion between canonical units and pixels
1067  ***********************************************************************/
1068
1069 /* Canonical x-values are fractions of FRAME_COLUMN_WIDTH, canonical
1070    y-unit are fractions of FRAME_LINE_HEIGHT of a frame.  Both are
1071    represented as Lisp numbers, i.e. integers or floats.  */
1072
1073 /* Convert canonical value X to pixels.  F is the frame whose
1074    canonical char width is to be used.  X must be a Lisp integer or
1075    float.  Value is a C integer.  */
1076
1077 #define FRAME_PIXEL_X_FROM_CANON_X(F, X)                \
1078   (INTEGERP (X)                                         \
1079    ? XINT (X) * FRAME_COLUMN_WIDTH (F)                  \
1080    : (int) (XFLOAT_DATA (X) * FRAME_COLUMN_WIDTH (F)))
1081
1082 /* Convert canonical value Y to pixels.  F is the frame whose
1083    canonical character height is to be used.  X must be a Lisp integer
1084    or float.  Value is a C integer.  */
1085
1086 #define FRAME_PIXEL_Y_FROM_CANON_Y(F, Y)                \
1087   (INTEGERP (Y)                                         \
1088    ? XINT (Y) * FRAME_LINE_HEIGHT (F)                   \
1089    : (int) (XFLOAT_DATA (Y) * FRAME_LINE_HEIGHT (F)))
1090
1091 /* Convert pixel-value X to canonical units.  F is the frame whose
1092    canonical character width is to be used.  X is a C integer.  Result
1093    is a Lisp float if X is not a multiple of the canon width,
1094    otherwise it's a Lisp integer.  */
1095
1096 #define FRAME_CANON_X_FROM_PIXEL_X(F, X)                        \
1097   ((X) % FRAME_COLUMN_WIDTH (F) != 0                            \
1098    ? make_float ((double) (X) / FRAME_COLUMN_WIDTH (F))         \
1099    : make_number ((X) / FRAME_COLUMN_WIDTH (F)))
1100
1101 /* Convert pixel-value Y to canonical units.  F is the frame whose
1102    canonical character height is to be used.  Y is a C integer.
1103    Result is a Lisp float if Y is not a multiple of the canon width,
1104    otherwise it's a Lisp integer.  */
1105
1106 #define FRAME_CANON_Y_FROM_PIXEL_Y(F, Y)                        \
1107   ((Y) % FRAME_LINE_HEIGHT (F)                                  \
1108    ? make_float ((double) (Y) / FRAME_LINE_HEIGHT (F))          \
1109    : make_number ((Y) / FRAME_LINE_HEIGHT (F)))
1110
1111
1112 \f
1113 /* Manipulating pixel sizes and character sizes.
1114    Knowledge of which factors affect the overall size of the window should
1115    be hidden in these macros, if that's possible.
1116
1117    Return the upper/left pixel position of the character cell on frame F
1118    at ROW/COL.  */
1119
1120 #define FRAME_LINE_TO_PIXEL_Y(f, row)                                   \
1121   (((row) < FRAME_TOP_MARGIN (f) ? 0 : FRAME_INTERNAL_BORDER_WIDTH (f)) \
1122    + (row) * FRAME_LINE_HEIGHT (f))
1123
1124 #define FRAME_COL_TO_PIXEL_X(f, col)            \
1125   (FRAME_INTERNAL_BORDER_WIDTH (f)              \
1126    + (col) * FRAME_COLUMN_WIDTH (f))
1127
1128 /* Return the pixel width/height of frame F if it has
1129    COLS columns/LINES rows.  */
1130
1131 #define FRAME_TEXT_COLS_TO_PIXEL_WIDTH(f, cols) \
1132   (FRAME_COL_TO_PIXEL_X (f, cols)               \
1133    + FRAME_SCROLL_BAR_AREA_WIDTH (f)            \
1134    + FRAME_TOTAL_FRINGE_WIDTH (f)               \
1135    + FRAME_INTERNAL_BORDER_WIDTH (f))
1136
1137 #define FRAME_TEXT_LINES_TO_PIXEL_HEIGHT(f, lines) \
1138   ((lines) * FRAME_LINE_HEIGHT (f)                 \
1139    + 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
1140
1141 /* Return the row/column (zero-based) of the character cell containing
1142    the pixel on FRAME at Y/X.  */
1143
1144 #define FRAME_PIXEL_Y_TO_LINE(f, y)                                     \
1145   (((y) < FRAME_TOP_MARGIN_HEIGHT (f)                                   \
1146     ? (y)                                                               \
1147     : ((y) < FRAME_TOP_MARGIN_HEIGHT (f) + FRAME_INTERNAL_BORDER_WIDTH (f) \
1148        ? (y) - (FRAME_TOP_MARGIN_HEIGHT (f) + FRAME_INTERNAL_BORDER_WIDTH (f) \
1149                 /* Arrange for the division to round down.  */          \
1150                 + FRAME_LINE_HEIGHT (f) - 1)                            \
1151        : (y) - FRAME_INTERNAL_BORDER_WIDTH (f)))                        \
1152    / FRAME_LINE_HEIGHT (f))
1153
1154 #define FRAME_PIXEL_X_TO_COL(f, x)              \
1155   (((x) - FRAME_INTERNAL_BORDER_WIDTH (f))      \
1156    / FRAME_COLUMN_WIDTH (f))
1157
1158 /* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
1159    frame F?  */
1160
1161 #define FRAME_PIXEL_WIDTH_TO_TEXT_COLS(f, width)                        \
1162   (FRAME_PIXEL_X_TO_COL (f, ((width)                                    \
1163                              - FRAME_INTERNAL_BORDER_WIDTH (f)          \
1164                              - FRAME_TOTAL_FRINGE_WIDTH (f)             \
1165                              - FRAME_SCROLL_BAR_AREA_WIDTH (f))))       \
1166
1167 #define FRAME_PIXEL_HEIGHT_TO_TEXT_LINES(f, height)                     \
1168   (FRAME_PIXEL_Y_TO_LINE (f, ((height)                                  \
1169                               - FRAME_INTERNAL_BORDER_WIDTH (f))))
1170
1171 /* Return the pixel width/height of frame F with a text size of
1172    width/height.  */
1173
1174 #define FRAME_TEXT_TO_PIXEL_WIDTH(f, width)       \
1175   ((width)                                        \
1176    + FRAME_SCROLL_BAR_AREA_WIDTH (f)              \
1177    + FRAME_TOTAL_FRINGE_WIDTH (f)                 \
1178    + 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
1179
1180 #define FRAME_TEXT_TO_PIXEL_HEIGHT(f, height)        \
1181   ((height) + 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
1182
1183 /* Return the text width/height of frame F with a pixel size of
1184    width/height.  */
1185
1186 #define FRAME_PIXEL_TO_TEXT_WIDTH(f, width)       \
1187   ((width)                                        \
1188    - FRAME_SCROLL_BAR_AREA_WIDTH (f)              \
1189    - FRAME_TOTAL_FRINGE_WIDTH (f)                 \
1190    - 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
1191
1192 #define FRAME_PIXEL_TO_TEXT_HEIGHT(f, height)           \
1193   ((height) - 2 * FRAME_INTERNAL_BORDER_WIDTH (f))
1194
1195 /* Value is the smallest width of any character in any font on frame F.  */
1196
1197 #define FRAME_SMALLEST_CHAR_WIDTH(f)            \
1198   FRAME_DISPLAY_INFO (f)->smallest_char_width
1199
1200 /* Value is the smallest height of any font on frame F.  */
1201
1202 #define FRAME_SMALLEST_FONT_HEIGHT(f)           \
1203   FRAME_DISPLAY_INFO (f)->smallest_font_height
1204
1205 /***********************************************************************
1206                                 Frame Parameters
1207  ***********************************************************************/
1208
1209 extern Lisp_Object Qauto_raise, Qauto_lower;
1210 extern Lisp_Object Qborder_color, Qborder_width;
1211 extern Lisp_Object Qbuffer_predicate;
1212 extern Lisp_Object Qcursor_color, Qcursor_type;
1213 extern Lisp_Object Qfont;
1214 extern Lisp_Object Qbackground_color, Qforeground_color;
1215 extern Lisp_Object Qicon, Qicon_name, Qicon_type, Qicon_left, Qicon_top;
1216 extern Lisp_Object Qinternal_border_width;
1217 extern Lisp_Object Qright_divider_width, Qbottom_divider_width;
1218 extern Lisp_Object Qtooltip;
1219 extern Lisp_Object Qmenu_bar_lines, Qtool_bar_lines, Qtool_bar_position;
1220 extern Lisp_Object Qmouse_color;
1221 extern Lisp_Object Qname, Qtitle;
1222 extern Lisp_Object Qparent_id;
1223 extern Lisp_Object Qunsplittable, Qvisibility;
1224 extern Lisp_Object Qscroll_bar_width, Qvertical_scroll_bars;
1225 extern Lisp_Object Qscroll_bar_foreground, Qscroll_bar_background;
1226 extern Lisp_Object Qscreen_gamma;
1227 extern Lisp_Object Qline_spacing;
1228 extern Lisp_Object Qwait_for_wm;
1229 extern Lisp_Object Qfullscreen;
1230 extern Lisp_Object Qfullwidth, Qfullheight, Qfullboth, Qmaximized;
1231 extern Lisp_Object Qsticky;
1232 extern Lisp_Object Qfont_backend;
1233 extern Lisp_Object Qalpha;
1234
1235 extern Lisp_Object Qleft_fringe, Qright_fringe;
1236 extern Lisp_Object Qheight, Qwidth;
1237 extern Lisp_Object Qminibuffer, Qmodeline;
1238 extern Lisp_Object Qx, Qw32, Qpc, Qns;
1239 extern Lisp_Object Qvisible;
1240 extern Lisp_Object Qdisplay_type;
1241
1242 extern Lisp_Object Qx_resource_name;
1243
1244 extern Lisp_Object Qleft, Qright, Qtop, Qbox, Qbottom;
1245 extern Lisp_Object Qdisplay;
1246
1247 extern Lisp_Object Qrun_hook_with_args;
1248
1249 #ifdef HAVE_WINDOW_SYSTEM
1250
1251 /* The class of this X application.  */
1252 #define EMACS_CLASS "Emacs"
1253
1254 /* These are in xterm.c, w32term.c, etc.  */
1255
1256 extern void x_set_scroll_bar_default_width (struct frame *);
1257 extern void x_set_offset (struct frame *, int, int, int);
1258 extern void x_wm_set_size_hint (struct frame *f, long flags, bool user_position);
1259
1260 extern Lisp_Object x_new_font (struct frame *, Lisp_Object, int);
1261
1262
1263 extern Lisp_Object Qface_set_after_frame_default;
1264
1265 #ifdef HAVE_NTGUI
1266 extern void x_fullscreen_adjust (struct frame *f, int *, int *,
1267                                  int *, int *);
1268 #endif
1269
1270 extern void x_set_frame_parameters (struct frame *, Lisp_Object);
1271
1272 extern void x_set_fullscreen (struct frame *, Lisp_Object, Lisp_Object);
1273 extern void x_set_line_spacing (struct frame *, Lisp_Object, Lisp_Object);
1274 extern void x_set_screen_gamma (struct frame *, Lisp_Object, Lisp_Object);
1275 extern void x_set_font (struct frame *, Lisp_Object, Lisp_Object);
1276 extern void x_set_font_backend (struct frame *, Lisp_Object, Lisp_Object);
1277 extern void x_set_fringe_width (struct frame *, Lisp_Object, Lisp_Object);
1278 extern void x_set_border_width (struct frame *, Lisp_Object, Lisp_Object);
1279 extern void x_set_internal_border_width (struct frame *, Lisp_Object,
1280                                          Lisp_Object);
1281 extern void x_set_right_divider_width (struct frame *, Lisp_Object,
1282                                        Lisp_Object);
1283 extern void x_set_bottom_divider_width (struct frame *, Lisp_Object,
1284                                         Lisp_Object);
1285 extern void x_set_visibility (struct frame *, Lisp_Object, Lisp_Object);
1286 extern void x_set_autoraise (struct frame *, Lisp_Object, Lisp_Object);
1287 extern void x_set_autolower (struct frame *, Lisp_Object, Lisp_Object);
1288 extern void x_set_unsplittable (struct frame *, Lisp_Object, Lisp_Object);
1289 extern void x_set_vertical_scroll_bars (struct frame *, Lisp_Object,
1290                                         Lisp_Object);
1291 extern void x_set_scroll_bar_width (struct frame *, Lisp_Object,
1292                                     Lisp_Object);
1293
1294 extern long x_figure_window_size (struct frame *, Lisp_Object, bool);
1295
1296 extern void x_set_alpha (struct frame *, Lisp_Object, Lisp_Object);
1297
1298 extern void validate_x_resource_name (void);
1299
1300 extern Lisp_Object display_x_get_resource (Display_Info *,
1301                                            Lisp_Object attribute,
1302                                            Lisp_Object class,
1303                                            Lisp_Object component,
1304                                            Lisp_Object subclass);
1305
1306 extern void set_frame_menubar (struct frame *f, bool first_time, bool deep_p);
1307 extern void x_set_window_size (struct frame *f, int change_grav,
1308                                int width, int height, bool pixelwise);
1309 extern Lisp_Object x_get_focus_frame (struct frame *);
1310 extern void x_set_mouse_position (struct frame *f, int h, int v);
1311 extern void x_set_mouse_pixel_position (struct frame *f, int pix_x, int pix_y);
1312 extern void x_make_frame_visible (struct frame *f);
1313 extern void x_make_frame_invisible (struct frame *f);
1314 extern void x_iconify_frame (struct frame *f);
1315 extern void x_set_frame_alpha (struct frame *f);
1316 extern void x_set_menu_bar_lines (struct frame *, Lisp_Object, Lisp_Object);
1317 extern void x_set_tool_bar_lines (struct frame *, Lisp_Object, Lisp_Object);
1318 extern void x_activate_menubar (struct frame *);
1319 extern void x_real_positions (struct frame *, int *, int *);
1320 extern void free_frame_menubar (struct frame *);
1321 extern void x_free_frame_resources (struct frame *);
1322
1323 #if defined HAVE_X_WINDOWS
1324 extern void x_wm_set_icon_position (struct frame *, int, int);
1325 #if !defined USE_X_TOOLKIT
1326 extern char *x_get_resource_string (const char *, const char *);
1327 #endif
1328 extern void x_sync (struct frame *);
1329 #endif /* HAVE_X_WINDOWS */
1330
1331 extern void x_query_colors (struct frame *f, XColor *, int);
1332 extern void x_query_color (struct frame *f, XColor *);
1333 extern void x_focus_frame (struct frame *);
1334
1335 #ifndef HAVE_NS
1336
1337 extern int x_bitmap_icon (struct frame *, Lisp_Object);
1338
1339 /* Set F's bitmap icon, if specified among F's parameters.  */
1340
1341 INLINE void
1342 x_set_bitmap_icon (struct frame *f)
1343 {
1344   Lisp_Object obj = assq_no_quit (Qicon_type, f->param_alist);
1345
1346   if (CONSP (obj))
1347     x_bitmap_icon (f, XCDR (obj));
1348 }
1349
1350 #endif /* !HAVE_NS */
1351
1352 #endif /* HAVE_WINDOW_SYSTEM */
1353
1354 INLINE void
1355 flush_frame (struct frame *f)
1356 {
1357   struct redisplay_interface *rif = FRAME_RIF (f);
1358
1359   if (rif && rif->flush_display)
1360     rif->flush_display (f);
1361 }
1362
1363 /***********************************************************************
1364                         Multimonitor data
1365  ***********************************************************************/
1366
1367 #ifdef HAVE_WINDOW_SYSTEM
1368
1369 struct MonitorInfo {
1370   XRectangle geom, work;
1371   int mm_width, mm_height;
1372   char *name;
1373 };
1374
1375 extern void free_monitors (struct MonitorInfo *monitors, int n_monitors);
1376 extern Lisp_Object make_monitor_attribute_list (struct MonitorInfo *monitors,
1377                                                 int n_monitors,
1378                                                 int primary_monitor,
1379                                                 Lisp_Object monitor_frames,
1380                                                 const char *source);
1381
1382 #endif /* HAVE_WINDOW_SYSTEM */
1383
1384
1385 INLINE_HEADER_END
1386
1387 #endif /* not EMACS_FRAME_H */