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   /* List of buffers viewed in this frame, for other-buffer.  */
 128   Lisp_Object buffer_list;
 129
 130   /* beyond here, there should be no more Lisp_Object components.  */
 131
 132
 133   /* A buffer to hold the frame's name.  We can't use the Lisp string's
 134      pointer (`name', above) because it might get relocated.  */
 135   char *namebuf;
 136
 137   /* glyphs as they appear on the frame */
 138   struct frame_glyphs *current_glyphs;
 139
 140   /* glyphs we'd like to appear on the frame */
 141   struct frame_glyphs *desired_glyphs;
 142
 143   /* See do_line_insertion_deletion_costs for info on these arrays. */
 144   /* Cost of inserting 1 line on this frame */
 145   int *insert_line_cost;
 146   /* Cost of deleting 1 line on this frame */
 147   int *delete_line_cost;
 148   /* Cost of inserting n lines on this frame */
 149   int *insert_n_lines_cost;
 150   /* Cost of deleting n lines on this frame */
 151   int *delete_n_lines_cost;
 152
 153   /* glyphs for the mode line */
 154   struct frame_glyphs *temp_glyphs;
 155
 156   /* Intended cursor position of this frame.
 157      Measured in characters, counting from upper left corner
 158      within the frame.  */
 159   int cursor_x;
 160   int cursor_y;
 161
 162   /* Actual cursor position of this frame, and the character under it.
 163      (Not used for terminal frames.)  */
 164   int phys_cursor_x;
 165   int phys_cursor_y;
 166   /* This is handy for undrawing the cursor, because current_glyphs is
 167      not always accurate when in do_scrolling.  */
 168   GLYPH phys_cursor_glyph;
 169   /* Nonzero means the cursor is displayed.  */
 170   int phys_cursor_on;
 171
 172   /* Size of this frame, in units of characters.  */
 173   EMACS_INT height;
 174   EMACS_INT width;
 175   EMACS_INT window_width;
 176
 177   /* New height and width for pending size change.  0 if no change pending.  */
 178   int new_height, new_width;
 179
 180   /* The output method says how the contents of this frame
 181      are displayed.  It could be using termcap, or using an X window.  */
 182   enum output_method output_method;
 183
 184   /* A structure of auxiliary data used for displaying the contents.
 185      struct x_output is used for X window frames;
 186      it is defined in xterm.h.
 187      struct w32_output is used for W32 window frames;
 188      it is defined in w32term.h.  */
 189   union output_data { struct x_output *x; struct w32_output *w32; int nothing; } output_data;
 190
 191 #ifdef MULTI_KBOARD
 192   /* A pointer to the kboard structure associated with this frame.
 193      For termcap frames, this points to initial_kboard.  For X frames,
 194      it will be the same as display.x->display_info->kboard.  */
 195   struct kboard *kboard;
 196 #endif
 197
 198   /* Number of lines of menu bar.  */
 199   int menu_bar_lines;
 200
 201 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
 202   /* Nonzero means using a menu bar that comes from the X toolkit.  */
 203   int external_menu_bar;
 204 #endif
 205
 206   /* Nonzero if last attempt at redisplay on this frame was preempted.  */
 207   char display_preempted;
 208
 209   /* visible is nonzero if the frame is currently displayed; we check
 210      it to see if we should bother updating the frame's contents.
 211      DON'T SET IT DIRECTLY; instead, use FRAME_SET_VISIBLE.
 212
 213      Note that, since invisible frames aren't updated, whenever a
 214      frame becomes visible again, it must be marked as garbaged.  The
 215      FRAME_SAMPLE_VISIBILITY macro takes care of this.
 216
 217      iconified is nonzero if the frame is currently iconified.
 218
 219      Asynchronous input handlers should NOT change these directly;
 220      instead, they should change async_visible or async_iconified, and
 221      let the FRAME_SAMPLE_VISIBILITY macro set visible and iconified
 222      at the next redisplay.
 223
 224      These should probably be considered read-only by everyone except
 225      FRAME_SAMPLE_VISIBILITY.
 226
 227      These two are mutually exclusive.  They might both be zero, if the
 228      frame has been made invisible without an icon.  */
 229   char visible, iconified;
 230
 231   /* Asynchronous input handlers change these, and
 232      FRAME_SAMPLE_VISIBILITY copies them into visible and iconified.
 233      See FRAME_SAMPLE_VISIBILITY, below.  */
 234 #ifdef __STDC__
 235   volatile
 236 #endif
 237   char async_visible, async_iconified;
 238
 239   /* Nonzero if this frame should be redrawn.  */
 240 #ifdef __STDC__
 241   volatile
 242 #endif
 243   char garbaged;
 244
 245   /* True if frame actually has a minibuffer window on it.
 246      0 if using a minibuffer window that isn't on this frame.  */
 247   char has_minibuffer;
 248
 249   /* 0 means, if this frame has just one window,
 250      show no modeline for that window.  */
 251   char wants_modeline;
 252
 253   /* Non-zero if the hardware device this frame is displaying on can
 254      support scroll bars.  */
 255   char can_have_scroll_bars;
 256
 257   /* If can_have_scroll_bars is non-zero, this is non-zero if we should
 258      actually display them on this frame.  */
 259   enum vertical_scroll_bar_type vertical_scroll_bar_type;
 260
 261   /* Non-0 means raise this frame to the top of the heap when selected.  */
 262   char auto_raise;
 263
 264   /* Non-0 means lower this frame to the bottom of the stack when left.  */
 265   char auto_lower;
 266
 267   /* True if frame's root window can't be split.  */
 268   char no_split;
 269
 270   /* If this is set, then Emacs won't change the frame name to indicate
 271      the current buffer, etcetera.  If the user explicitly sets the frame
 272      name, this gets set.  If the user sets the name to Qnil, this is
 273      cleared.  */
 274   char explicit_name;
 275
 276   /* Nonzero if size of some window on this frame has changed.  */
 277   char window_sizes_changed;
 278
 279   /* Storage for messages to this frame. */
 280   char *message_buf;
 281
 282   /* Nonnegative if current redisplay should not do scroll computation
 283      for lines beyond a certain vpos.  This is the vpos.  */
 284   int scroll_bottom_vpos;
 285
 286   /* Width of the scroll bar, in pixels and in characters.
 287      scroll_bar_cols tracks scroll_bar_pixel_width if the latter is positive;
 288      a zero value in scroll_bar_pixel_width means to compute the actual width
 289      on the fly, using scroll_bar_cols and the current font width.  */
 290   int scroll_bar_pixel_width;
 291   int scroll_bar_cols;
 292
 293   /* The baud rate that was used to calculate costs for this frame.  */
 294   int cost_calculation_baud_rate;
 295
 296   /* A pointer to the data structure containing all information of
 297      fontsets associated with this frame.  See the comments in
 298      fontset.h for more detail.  */
 299   struct fontset_data *fontset_data;
 300
 301   /* Nonzero if the mouse has moved on this display
 302      since the last time we checked.  */
 303   char mouse_moved;
 304 };
 305
 306 #ifdef MULTI_KBOARD
 307 #define FRAME_KBOARD(f) ((f)->kboard)
 308 #else
 309 #define FRAME_KBOARD(f) (&the_only_kboard)
 310 #endif
 311
 312 typedef struct frame *FRAME_PTR;
 313
 314 #define XFRAME(p) ((struct frame *) XPNTR (p))
 315 #define XSETFRAME(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_FRAME))
 316
 317 #define WINDOW_FRAME(w) (w)->frame
 318
 319 #define FRAME_X_P(f) ((f)->output_method == output_x_window)
 320 #define FRAME_W32_P(f) ((f)->output_method == output_w32)
 321 #define FRAME_MSDOS_P(f) ((f)->output_method == output_msdos_raw)
 322
 323 /* FRAME_WINDOW_P tests whether the frame is a window, and is
 324    defined to be the predicate for the window system being used.  */
 325 #ifdef HAVE_X_WINDOWS
 326 #define FRAME_WINDOW_P(f) FRAME_X_P (f)
 327 #endif
 328 #ifdef HAVE_NTGUI
 329 #define FRAME_WINDOW_P(f) FRAME_W32_P (f)
 330 #endif
 331 #ifndef FRAME_WINDOW_P
 332 #define FRAME_WINDOW_P(f) (0)
 333 #endif
 334
 335 #define FRAME_LIVE_P(f) ((f)->output_data.nothing != 0)
 336 #define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap)
 337 #define FRAME_MINIBUF_ONLY_P(f) \
 338   EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f))
 339 #define FRAME_HAS_MINIBUF_P(f) ((f)->has_minibuffer)
 340 #define FRAME_CURRENT_GLYPHS(f) (f)->current_glyphs
 341 #define FRAME_DESIRED_GLYPHS(f) (f)->desired_glyphs
 342 #define FRAME_TEMP_GLYPHS(f) (f)->temp_glyphs
 343 #define FRAME_HEIGHT(f) (f)->height
 344 #define FRAME_WIDTH(f) (f)->width
 345 #define FRAME_NEW_HEIGHT(f) (f)->new_height
 346 #define FRAME_NEW_WIDTH(f) (f)->new_width
 347 #define FRAME_MENU_BAR_LINES(f) (f)->menu_bar_lines
 348 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
 349 #define FRAME_EXTERNAL_MENU_BAR(f) (f)->external_menu_bar
 350 #else
 351 #define FRAME_EXTERNAL_MENU_BAR(f) 0
 352 #endif
 353 #define FRAME_CURSOR_X(f) (f)->cursor_x
 354 #define FRAME_CURSOR_Y(f) (f)->cursor_y
 355 #define FRAME_VISIBLE_P(f) ((f)->visible != 0)
 356 #define FRAME_SET_VISIBLE(f,p) \
 357   ((f)->async_visible = (p), FRAME_SAMPLE_VISIBILITY (f))
 358 #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1, f->garbaged = 1)
 359 #define FRAME_GARBAGED_P(f) (f)->garbaged
 360 #define FRAME_NO_SPLIT_P(f) (f)->no_split
 361 #define FRAME_WANTS_MODELINE_P(f) (f)->wants_modeline
 362 #define FRAME_ICONIFIED_P(f) (f)->iconified
 363 #define FRAME_WINDOW_SIZES_CHANGED(f) (f)->window_sizes_changed
 364 #define FRAME_MINIBUF_WINDOW(f) (f)->minibuffer_window
 365 #define FRAME_ROOT_WINDOW(f) (f)->root_window
 366 #define FRAME_SELECTED_WINDOW(f) (f)->selected_window
 367 #define SET_GLYPHS_FRAME(glyphs,frame) ((glyphs)->frame = (frame))
 368 #define FRAME_INSERT_COST(f) (f)->insert_line_cost
 369 #define FRAME_DELETE_COST(f) (f)->delete_line_cost
 370 #define FRAME_INSERTN_COST(f) (f)->insert_n_lines_cost
 371 #define FRAME_DELETEN_COST(f) (f)->delete_n_lines_cost
 372 #define FRAME_MESSAGE_BUF(f) (f)->message_buf
 373 #define FRAME_SCROLL_BOTTOM_VPOS(f) (f)->scroll_bottom_vpos
 374 #define FRAME_FOCUS_FRAME(f) (f)->focus_frame
 375 #define FRAME_CAN_HAVE_SCROLL_BARS(f) ((f)->can_have_scroll_bars)
 376 #define FRAME_VERTICAL_SCROLL_BAR_TYPE(f) ((f)->vertical_scroll_bar_type)
 377 #define FRAME_HAS_VERTICAL_SCROLL_BARS(f) \
 378      ((f)->vertical_scroll_bar_type != vertical_scroll_bar_none)
 379 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT(f) \
 380      ((f)->vertical_scroll_bar_type == vertical_scroll_bar_left)
 381 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT(f) \
 382      ((f)->vertical_scroll_bar_type == vertical_scroll_bar_right)
 383 #define FRAME_SCROLL_BAR_PIXEL_WIDTH(f) ((f)->scroll_bar_pixel_width)
 384 #define FRAME_SCROLL_BAR_COLS(f) ((f)->scroll_bar_cols)
 385 #define FRAME_LEFT_SCROLL_BAR_WIDTH(f) \
 386      (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \
 387       ? FRAME_SCROLL_BAR_COLS (f) \
 388       : 0)
 389 #define FRAME_SCROLL_BAR_WIDTH(f) \
 390      (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \
 391       ? FRAME_SCROLL_BAR_COLS (f) \
 392       : 0)
 393 #define FRAME_WINDOW_WIDTH_ARG(f, width) \
 394      ((width) + FRAME_SCROLL_BAR_WIDTH (f))
 395 #define FRAME_WINDOW_WIDTH(f) ((f)->window_width)
 396 #define SET_FRAME_WIDTH(f,val) ((f)->width = (val), (f)->window_width = FRAME_WINDOW_WIDTH_ARG (f, (f)->width))
 397 #define FRAME_SCROLL_BARS(f) ((f)->scroll_bars)
 398 #define FRAME_CONDEMNED_SCROLL_BARS(f) ((f)->condemned_scroll_bars)
 399 #define FRAME_MENU_BAR_ITEMS(f) ((f)->menu_bar_items)
 400 #define FRAME_COST_BAUD_RATE(f) ((f)->cost_calculation_baud_rate)
 401 #define FRAME_FONTSET_DATA(f) ((f)->fontset_data)
 402
 403 /* Return the size of message_buf of the frame F.  We multiply the
 404    width of the frame by 4 because multi-byte form may require at most
 405    4-byte for a character.  */
 406 #define FRAME_MESSAGE_BUF_SIZE(f) (((int) (f)->width) * 4)
 407
 408 /* Emacs's redisplay code could become confused if a frame's
 409    visibility changes at arbitrary times.  For example, if a frame is
 410    visible while the desired glyphs are being built, but becomes
 411    invisible before they are updated, then some rows of the
 412    desired_glyphs will be left marked as enabled after redisplay is
 413    complete, which should never happen.  The next time the frame
 414    becomes visible, redisplay will probably barf.
 415
 416    Currently, there are no similar situations involving iconified, but
 417    the principle is the same.
 418
 419    So instead of having asynchronous input handlers directly set and
 420    clear the frame's visibility and iconification flags, they just set
 421    the async_visible and async_iconified flags; the redisplay code
 422    calls the FRAME_SAMPLE_VISIBILITY macro before doing any redisplay,
 423    which sets visible and iconified from their asynchronous
 424    counterparts.
 425
 426    Synchronous code must use the FRAME_SET_VISIBLE macro.
 427
 428    Also, if a frame used to be invisible, but has just become visible,
 429    it must be marked as garbaged, since redisplay hasn't been keeping
 430    up its contents.  */
 431 #define FRAME_SAMPLE_VISIBILITY(f) \
 432   (((f)->async_visible && ! (f)->visible) ? SET_FRAME_GARBAGED (f) : 0, \
 433    (f)->visible = (f)->async_visible, \
 434    (f)->iconified = (f)->async_iconified)
 435
 436 #define CHECK_FRAME(x, i)                               \
 437   {                                                     \
 438     if (! FRAMEP (x))                                   \
 439       x = wrong_type_argument (Qframep, (x));           \
 440   }
 441
 442 #define CHECK_LIVE_FRAME(x, i)                          \
 443   {                                                     \
 444     if (! FRAMEP (x)                                    \
 445         || ! FRAME_LIVE_P (XFRAME (x)))         \
 446       x = wrong_type_argument (Qframe_live_p, (x));     \
 447   }
 448
 449 /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
 450    `for' loop which iterates over the elements of Vframe_list.  The
 451    loop will set FRAME_VAR, a Lisp_Object, to each frame in
 452    Vframe_list in succession and execute the statement.  LIST_VAR
 453    should be a Lisp_Object too; it is used to iterate through the
 454    Vframe_list.
 455
 456    This macro is a holdover from a time when multiple frames weren't always
 457    supported.  An alternate definition of the macro would expand to
 458    something which executes the statement once.  */
 459 #define FOR_EACH_FRAME(list_var, frame_var)                     \
 460   for ((list_var) = Vframe_list;                                \
 461        (CONSP (list_var)                                        \
 462         && (frame_var = XCONS (list_var)->car, 1));             \
 463        list_var = XCONS (list_var)->cdr)
 464
 465
 466 extern Lisp_Object Qframep, Qframe_live_p, Qicon;
 467
 468 extern struct frame *selected_frame;
 469 extern struct frame *last_nonminibuf_frame;
 470
 471 extern struct frame *make_terminal_frame ();
 472 extern struct frame *make_frame ();
 473 extern struct frame *make_minibuffer_frame ();
 474 extern struct frame *make_frame_without_minibuffer ();
 475
 476 extern Lisp_Object Vframe_list;
 477 extern Lisp_Object Vdefault_frame_alist;
 478
 479 extern Lisp_Object Vterminal_frame;
 480 \f
 481 /* Device-independent scroll bar stuff.  */
 482
 483 /* Return the starting column (zero-based) of the vertical scroll bar
 484    for window W.  The column before this one is the last column we can
 485    use for text.  If the window touches the right edge of the frame,
 486    we have extra space allocated for it.  Otherwise, the scroll bar
 487    takes over the window's rightmost columns.  */
 488 #define WINDOW_VERTICAL_SCROLL_BAR_COLUMN(w) \
 489   (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (XFRAME (WINDOW_FRAME (w))) ? \
 490     (((XINT ((w)->left) + XINT ((w)->width)) \
 491       < FRAME_WIDTH (XFRAME (WINDOW_FRAME (w)))) \
 492      ? (XINT ((w)->left) + XINT ((w)->width) \
 493        - FRAME_SCROLL_BAR_COLS (XFRAME (WINDOW_FRAME (w)))) \
 494      : FRAME_WIDTH (XFRAME (WINDOW_FRAME (w)))) \
 495   : XINT ((w)->left))
 496
 497 /* Return the height in lines of the vertical scroll bar in w.  If the
 498    window has a mode line, don't make the scroll bar extend that far.  */
 499 #define WINDOW_VERTICAL_SCROLL_BAR_HEIGHT(w) (window_internal_height (w))