src/frame.h

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