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