src/frame.h

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