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