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