src/frame.h

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