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