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