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