src/frame.h

   1 /* Define frame-object for GNU Emacs.
   2    Copyright (C) 1993, 1994 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 2, or (at your option)
   9 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; see the file COPYING.  If not, write to
  18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19 Boston, MA 02111-1307, USA.  */
  20
  21 \f
  22 /* Miscellanea.  */
  23
  24 /* Nonzero means don't assume anything about current
  25    contents of actual terminal frame */
  26 extern int frame_garbaged;
  27
  28 /* Nonzero means FRAME_MESSAGE_BUF (selected_frame) is being used by
  29    print.  */
  30 extern int message_buf_print;
  31
  32 \f
  33 /* The structure representing a frame.  */
  34
  35 enum output_method
  36 { output_termcap, output_x_window, output_msdos_raw, output_w32 };
  37
  38 enum vertical_scroll_bar_type
  39 { vertical_scroll_bar_none, vertical_scroll_bar_left, vertical_scroll_bar_right };
  40
  41 struct frame
  42 {
  43   EMACS_INT size;
  44   struct Lisp_Vector *next;
  45
  46   /* All Lisp_Object components must come first.
  47      Only EMACS_INT values can be intermixed with them.
  48      That ensures they are all aligned normally.  */
  49
  50   /* Name of this frame: a Lisp string.  It is used for looking up resources,
  51      as well as for the title in some cases.  */
  52   Lisp_Object name;
  53
  54   /* The name to use for the icon, the last time
  55      it was refreshed.  nil means not explicitly specified.  */
  56   Lisp_Object icon_name;
  57
  58   /* This is the frame title specified explicitly, if any.
  59      Usually it is nil.  */
  60   Lisp_Object title;
  61
  62   /* The frame which should receive keystrokes that occur in this
  63      frame, or nil if they should go to the frame itself.  This is
  64      usually nil, but if the frame is minibufferless, we can use this
  65      to redirect keystrokes to a surrogate minibuffer frame when
  66      needed.
  67
  68      Note that a value of nil is different than having the field point
  69      to the frame itself.  Whenever the Fselect_frame function is used
  70      to shift from one frame to the other, any redirections to the
  71      original frame are shifted to the newly selected frame; if
  72      focus_frame is nil, Fselect_frame will leave it alone.  */
  73   Lisp_Object focus_frame;
  74
  75   /* This frame's root window.  Every frame has one.
  76      If the frame has only a minibuffer window, this is it.
  77      Otherwise, if the frame has a minibuffer window, this is its sibling.  */
  78   Lisp_Object root_window;
  79
  80   /* This frame's selected window.
  81      Each frame has its own window hierarchy
  82      and one of the windows in it is selected within the frame.
  83      The selected window of the selected frame is Emacs's selected window.  */
  84   Lisp_Object selected_window;
  85
  86   /* This frame's minibuffer window.
  87      Most frames have their own minibuffer windows,
  88      but only the selected frame's minibuffer window
  89      can actually appear to exist.  */
  90   Lisp_Object minibuffer_window;
  91
  92   /* Parameter alist of this frame.
  93      These are the parameters specified when creating the frame
  94      or modified with modify-frame-parameters.  */
  95   Lisp_Object param_alist;
  96
  97   /* List of scroll bars on this frame.
  98      Actually, we don't specify exactly what is stored here at all; the
  99      scroll bar implementation code can use it to store anything it likes.
 100      This field is marked by the garbage collector.  It is here
 101      instead of in the `display' structure so that the garbage
 102      collector doesn't need to look inside the window-system-dependent
 103      structure.  */
 104   Lisp_Object scroll_bars;
 105   Lisp_Object condemned_scroll_bars;
 106
 107   /* Vector describing the items to display in the menu bar.
 108      Each item has four elements in this vector.
 109      They are KEY, STRING, SUBMAP, and HPOS.
 110      (HPOS is not used in when the X toolkit is in use.)
 111      There are four additional elements of nil at the end, to terminate.  */
 112   Lisp_Object menu_bar_items;
 113
 114   /* Alist of elements (FACE-NAME . FACE-VECTOR-DATA).  */
 115   Lisp_Object face_alist;
 116
 117   /* A vector that records the entire structure of this frame's menu bar.
 118      For the format of the data, see extensive comments in xmenu.c.
 119      Only the X toolkit version uses this.  */
 120   Lisp_Object menu_bar_vector;
 121   /* Number of elements in the vector that have meaningful data.  */
 122   EMACS_INT menu_bar_items_used;
 123
 124   /* Predicate for selecting buffers for other-buffer.  */
 125   Lisp_Object buffer_predicate;
 126
 127   /* Beyond here, there should be no more Lisp_Object components.  */
 128
 129
 130   /* A buffer to hold the frame's name.  We can't use the Lisp string's
 131      pointer (`name', above) because it might get relocated.  */
 132   char *namebuf;
 133
 134   /* glyphs as they appear on the frame */
 135   struct frame_glyphs *current_glyphs;
 136
 137   /* glyphs we'd like to appear on the frame */
 138   struct frame_glyphs *desired_glyphs;
 139
 140   /* See do_line_insertion_deletion_costs for info on these arrays. */
 141   /* Cost of inserting 1 line on this frame */
 142   int *insert_line_cost;
 143   /* Cost of deleting 1 line on this frame */
 144   int *delete_line_cost;
 145   /* Cost of inserting n lines on this frame */
 146   int *insert_n_lines_cost;
 147   /* Cost of deleting n lines on this frame */
 148   int *delete_n_lines_cost;
 149
 150   /* glyphs for the mode line */
 151   struct frame_glyphs *temp_glyphs;
 152
 153   /* Intended cursor position of this frame.
 154      Measured in characters, counting from upper left corner
 155      within the frame.  */
 156   int cursor_x;
 157   int cursor_y;
 158
 159   /* Actual cursor position of this frame, and the character under it.
 160      (Not used for terminal frames.)  */
 161   int phys_cursor_x;
 162   int phys_cursor_y;
 163   /* This is handy for undrawing the cursor, because current_glyphs is
 164      not always accurate when in do_scrolling.  */
 165   GLYPH phys_cursor_glyph;
 166   /* Nonzero means the cursor is displayed.  */
 167   int phys_cursor_on;
 168
 169   /* Size of this frame, in units of characters.  */
 170   EMACS_INT height;
 171   EMACS_INT width;
 172   EMACS_INT window_width;
 173
 174   /* New height and width for pending size change.  0 if no change pending.  */
 175   int new_height, new_width;
 176
 177   /* The output method says how the contents of this frame
 178      are displayed.  It could be using termcap, or using an X window.  */
 179   enum output_method output_method;
 180
 181   /* A structure of auxiliary data used for displaying the contents.
 182      struct x_output is used for X window frames;
 183      it is defined in xterm.h.
 184      struct w32_output is used for W32 window frames;
 185      it is defined in w32term.h.  */
 186   union output_data { struct x_output *x; struct w32_output *w32; int nothing; } output_data;
 187
 188 #ifdef MULTI_KBOARD
 189   /* A pointer to the kboard structure associated with this frame.
 190      For termcap frames, this points to initial_kboard.  For X frames,
 191      it will be the same as display.x->display_info->kboard.  */
 192   struct kboard *kboard;
 193 #endif
 194
 195   /* Number of lines of menu bar.  */
 196   int menu_bar_lines;
 197
 198 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
 199   /* Nonzero means using a menu bar that comes from the X toolkit.  */
 200   int external_menu_bar;
 201 #endif
 202
 203   /* Nonzero if last attempt at redisplay on this frame was preempted.  */
 204   char display_preempted;
 205
 206   /* visible is nonzero if the frame is currently displayed; we check
 207      it to see if we should bother updating the frame's contents.
 208      DON'T SET IT DIRECTLY; instead, use FRAME_SET_VISIBLE.
 209
 210      Note that, since invisible frames aren't updated, whenever a
 211      frame becomes visible again, it must be marked as garbaged.  The
 212      FRAME_SAMPLE_VISIBILITY macro takes care of this.
 213
 214      iconified is nonzero if the frame is currently iconified.
 215
 216      Asynchronous input handlers should NOT change these directly;
 217      instead, they should change async_visible or async_iconified, and
 218      let the FRAME_SAMPLE_VISIBILITY macro set visible and iconified
 219      at the next redisplay.
 220
 221      These should probably be considered read-only by everyone except
 222      FRAME_SAMPLE_VISIBILITY.
 223
 224      These two are mutually exclusive.  They might both be zero, if the
 225      frame has been made invisible without an icon.  */
 226   char visible, iconified;
 227
 228   /* Asynchronous input handlers change these, and
 229      FRAME_SAMPLE_VISIBILITY copies them into visible and iconified.
 230      See FRAME_SAMPLE_VISIBILITY, below.  */
 231 #ifdef __STDC__
 232   volatile
 233 #endif
 234   char async_visible, async_iconified;
 235
 236   /* Nonzero if this frame should be redrawn.  */
 237 #ifdef __STDC__
 238   volatile
 239 #endif
 240   char garbaged;
 241
 242   /* True if frame actually has a minibuffer window on it.
 243      0 if using a minibuffer window that isn't on this frame.  */
 244   char has_minibuffer;
 245
 246   /* 0 means, if this frame has just one window,
 247      show no modeline for that window.  */
 248   char wants_modeline;
 249
 250   /* Non-zero if the hardware device this frame is displaying on can
 251      support scroll bars.  */
 252   char can_have_scroll_bars;
 253
 254   /* If can_have_scroll_bars is non-zero, this is non-zero if we should
 255      actually display them on this frame.  */
 256   enum vertical_scroll_bar_type vertical_scroll_bar_type;
 257
 258   /* Non-0 means raise this frame to the top of the heap when selected.  */
 259   char auto_raise;
 260
 261   /* Non-0 means lower this frame to the bottom of the stack when left.  */
 262   char auto_lower;
 263
 264   /* True if frame's root window can't be split.  */
 265   char no_split;
 266
 267   /* If this is set, then Emacs won't change the frame name to indicate
 268      the current buffer, etcetera.  If the user explicitly sets the frame
 269      name, this gets set.  If the user sets the name to Qnil, this is
 270      cleared.  */
 271   char explicit_name;
 272
 273   /* Nonzero if size of some window on this frame has changed.  */
 274   char window_sizes_changed;
 275
 276   /* Storage for messages to this frame. */
 277   char *message_buf;
 278
 279   /* Nonnegative if current redisplay should not do scroll computation
 280      for lines beyond a certain vpos.  This is the vpos.  */
 281   int scroll_bottom_vpos;
 282
 283   /* Width of the scroll bar, in pixels and in characters.
 284      scroll_bar_cols tracks scroll_bar_pixel_width if the latter is positive;
 285      a zero value in scroll_bar_pixel_width means to compute the actual width
 286      on the fly, using scroll_bar_cols and the current font width.  */
 287   int scroll_bar_pixel_width;
 288   int scroll_bar_cols;
 289
 290   /* The baud rate that was used to calculate costs for this frame.  */
 291   int cost_calculation_baud_rate;
 292
 293   /* Nonzero if the mouse has moved on this display
 294      since the last time we checked.  */
 295   char mouse_moved;
 296 };
 297
 298 #ifdef MULTI_KBOARD
 299 #define FRAME_KBOARD(f) ((f)->kboard)
 300 #else
 301 #define FRAME_KBOARD(f) (&the_only_kboard)
 302 #endif
 303
 304 typedef struct frame *FRAME_PTR;
 305
 306 #define XFRAME(p) ((struct frame *) XPNTR (p))
 307 #define XSETFRAME(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_FRAME))
 308
 309 #define WINDOW_FRAME(w) (w)->frame
 310
 311 #define FRAME_X_P(f) ((f)->output_method == output_x_window)
 312 #define FRAME_W32_P(f) ((f)->output_method == output_w32)
 313 #define FRAME_MSDOS_P(f) ((f)->output_method == output_msdos_raw)
 314
 315 /* FRAME_WINDOW_P tests whether the frame is a window, and is
 316    defined to be the predicate for the window system being used.  */
 317 #ifdef HAVE_X_WINDOWS
 318 #define FRAME_WINDOW_P(f) FRAME_X_P (f)
 319 #endif
 320 #ifdef HAVE_NTGUI
 321 #define FRAME_WINDOW_P(f) FRAME_W32_P (f)
 322 #endif
 323 #ifndef FRAME_WINDOW_P
 324 #define FRAME_WINDOW_P(f) (0)
 325 #endif
 326
 327 #define FRAME_LIVE_P(f) ((f)->output_data.nothing != 0)
 328 #define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap)
 329 #define FRAME_MINIBUF_ONLY_P(f) \
 330   EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f))
 331 #define FRAME_HAS_MINIBUF_P(f) ((f)->has_minibuffer)
 332 #define FRAME_CURRENT_GLYPHS(f) (f)->current_glyphs
 333 #define FRAME_DESIRED_GLYPHS(f) (f)->desired_glyphs
 334 #define FRAME_TEMP_GLYPHS(f) (f)->temp_glyphs
 335 #define FRAME_HEIGHT(f) (f)->height
 336 #define FRAME_WIDTH(f) (f)->width
 337 #define FRAME_NEW_HEIGHT(f) (f)->new_height
 338 #define FRAME_NEW_WIDTH(f) (f)->new_width
 339 #define FRAME_MENU_BAR_LINES(f) (f)->menu_bar_lines
 340 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
 341 #define FRAME_EXTERNAL_MENU_BAR(f) (f)->external_menu_bar
 342 #else
 343 #define FRAME_EXTERNAL_MENU_BAR(f) 0
 344 #endif
 345 #define FRAME_CURSOR_X(f) (f)->cursor_x
 346 #define FRAME_CURSOR_Y(f) (f)->cursor_y
 347 #define FRAME_VISIBLE_P(f) ((f)->visible != 0)
 348 #define FRAME_SET_VISIBLE(f,p) \
 349   ((f)->async_visible = (p), FRAME_SAMPLE_VISIBILITY (f))
 350 #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1, f->garbaged = 1)
 351 #define FRAME_GARBAGED_P(f) (f)->garbaged
 352 #define FRAME_NO_SPLIT_P(f) (f)->no_split
 353 #define FRAME_WANTS_MODELINE_P(f) (f)->wants_modeline
 354 #define FRAME_ICONIFIED_P(f) (f)->iconified
 355 #define FRAME_WINDOW_SIZES_CHANGED(f) (f)->window_sizes_changed
 356 #define FRAME_MINIBUF_WINDOW(f) (f)->minibuffer_window
 357 #define FRAME_ROOT_WINDOW(f) (f)->root_window
 358 #define FRAME_SELECTED_WINDOW(f) (f)->selected_window
 359 #define SET_GLYPHS_FRAME(glyphs,frame) ((glyphs)->frame = (frame))
 360 #define FRAME_INSERT_COST(f) (f)->insert_line_cost
 361 #define FRAME_DELETE_COST(f) (f)->delete_line_cost
 362 #define FRAME_INSERTN_COST(f) (f)->insert_n_lines_cost
 363 #define FRAME_DELETEN_COST(f) (f)->delete_n_lines_cost
 364 #define FRAME_MESSAGE_BUF(f) (f)->message_buf
 365 #define FRAME_SCROLL_BOTTOM_VPOS(f) (f)->scroll_bottom_vpos
 366 #define FRAME_FOCUS_FRAME(f) (f)->focus_frame
 367 #define FRAME_CAN_HAVE_SCROLL_BARS(f) ((f)->can_have_scroll_bars)
 368 #define FRAME_VERTICAL_SCROLL_BAR_TYPE(f) ((f)->vertical_scroll_bar_type)
 369 #define FRAME_HAS_VERTICAL_SCROLL_BARS(f) \
 370      ((f)->vertical_scroll_bar_type != vertical_scroll_bar_none)
 371 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT(f) \
 372      ((f)->vertical_scroll_bar_type == vertical_scroll_bar_left)
 373 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT(f) \
 374      ((f)->vertical_scroll_bar_type == vertical_scroll_bar_right)
 375 #define FRAME_SCROLL_BAR_PIXEL_WIDTH(f) ((f)->scroll_bar_pixel_width)
 376 #define FRAME_SCROLL_BAR_COLS(f) ((f)->scroll_bar_cols)
 377 #define FRAME_LEFT_SCROLL_BAR_WIDTH(f) \
 378      (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \
 379       ? FRAME_SCROLL_BAR_COLS (f) \
 380       : 0)
 381 #define FRAME_SCROLL_BAR_WIDTH(f) \
 382      (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \
 383       ? FRAME_SCROLL_BAR_COLS (f) \
 384       : 0)
 385 #define FRAME_WINDOW_WIDTH_ARG(f, width) \
 386      ((width) + FRAME_SCROLL_BAR_WIDTH (f))
 387 #define FRAME_WINDOW_WIDTH(f) ((f)->window_width)
 388 #define SET_FRAME_WIDTH(f,val) ((f)->width = (val), (f)->window_width = FRAME_WINDOW_WIDTH_ARG (f, (f)->width))
 389 #define FRAME_SCROLL_BARS(f) ((f)->scroll_bars)
 390 #define FRAME_CONDEMNED_SCROLL_BARS(f) ((f)->condemned_scroll_bars)
 391 #define FRAME_MENU_BAR_ITEMS(f) ((f)->menu_bar_items)
 392 #define FRAME_COST_BAUD_RATE(f) ((f)->cost_calculation_baud_rate)
 393
 394 /* Emacs's redisplay code could become confused if a frame's
 395    visibility changes at arbitrary times.  For example, if a frame is
 396    visible while the desired glyphs are being built, but becomes
 397    invisible before they are updated, then some rows of the
 398    desired_glyphs will be left marked as enabled after redisplay is
 399    complete, which should never happen.  The next time the frame
 400    becomes visible, redisplay will probably barf.
 401
 402    Currently, there are no similar situations involving iconified, but
 403    the principle is the same.
 404
 405    So instead of having asynchronous input handlers directly set and
 406    clear the frame's visibility and iconification flags, they just set
 407    the async_visible and async_iconified flags; the redisplay code
 408    calls the FRAME_SAMPLE_VISIBILITY macro before doing any redisplay,
 409    which sets visible and iconified from their asynchronous
 410    counterparts.
 411
 412    Synchronous code must use the FRAME_SET_VISIBLE macro.
 413
 414    Also, if a frame used to be invisible, but has just become visible,
 415    it must be marked as garbaged, since redisplay hasn't been keeping
 416    up its contents.  */
 417 #define FRAME_SAMPLE_VISIBILITY(f) \
 418   (((f)->async_visible && ! (f)->visible) ? SET_FRAME_GARBAGED (f) : 0, \
 419    (f)->visible = (f)->async_visible, \
 420    (f)->iconified = (f)->async_iconified)
 421
 422 #define CHECK_FRAME(x, i)                               \
 423   {                                                     \
 424     if (! FRAMEP (x))                                   \
 425       x = wrong_type_argument (Qframep, (x));           \
 426   }
 427
 428 #define CHECK_LIVE_FRAME(x, i)                          \
 429   {                                                     \
 430     if (! FRAMEP (x)                                    \
 431         || ! FRAME_LIVE_P (XFRAME (x)))         \
 432       x = wrong_type_argument (Qframe_live_p, (x));     \
 433   }
 434
 435 /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
 436    `for' loop which iterates over the elements of Vframe_list.  The
 437    loop will set FRAME_VAR, a Lisp_Object, to each frame in
 438    Vframe_list in succession and execute the statement.  LIST_VAR
 439    should be a Lisp_Object too; it is used to iterate through the
 440    Vframe_list.
 441
 442    This macro is a holdover from a time when multiple frames weren't always
 443    supported.  An alternate definition of the macro would expand to
 444    something which executes the statement once.  */
 445 #define FOR_EACH_FRAME(list_var, frame_var)                     \
 446   for ((list_var) = Vframe_list;                                \
 447        (CONSP (list_var)                                        \
 448         && (frame_var = XCONS (list_var)->car, 1));             \
 449        list_var = XCONS (list_var)->cdr)
 450
 451
 452 extern Lisp_Object Qframep, Qframe_live_p, Qicon;
 453
 454 extern struct frame *selected_frame;
 455 extern struct frame *last_nonminibuf_frame;
 456
 457 extern struct frame *make_terminal_frame ();
 458 extern struct frame *make_frame ();
 459 extern struct frame *make_minibuffer_frame ();
 460 extern struct frame *make_frame_without_minibuffer ();
 461
 462 extern Lisp_Object Vframe_list;
 463 extern Lisp_Object Vdefault_frame_alist;
 464
 465 extern Lisp_Object Vterminal_frame;
 466 \f
 467 /* Device-independent scroll bar stuff.  */
 468
 469 /* Return the starting column (zero-based) of the vertical scroll bar
 470    for window W.  The column before this one is the last column we can
 471    use for text.  If the window touches the right edge of the frame,
 472    we have extra space allocated for it.  Otherwise, the scroll bar
 473    takes over the window's rightmost columns.  */
 474 #define WINDOW_VERTICAL_SCROLL_BAR_COLUMN(w) \
 475   (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (XFRAME (WINDOW_FRAME (w))) ? \
 476     (((XINT ((w)->left) + XINT ((w)->width)) \
 477       < FRAME_WIDTH (XFRAME (WINDOW_FRAME (w)))) \
 478      ? (XINT ((w)->left) + XINT ((w)->width) \
 479        - FRAME_SCROLL_BAR_COLS (XFRAME (WINDOW_FRAME (w)))) \
 480      : FRAME_WIDTH (XFRAME (WINDOW_FRAME (w)))) \
 481   : XINT ((w)->left))
 482
 483 /* Return the height in lines of the vertical scroll bar in w.  If the
 484    window has a mode line, don't make the scroll bar extend that far.  */
 485 #define WINDOW_VERTICAL_SCROLL_BAR_HEIGHT(w) (window_internal_height (w))