src/frame.h

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