src/frame.h

   1 /* Define frame-object for GNU Emacs.
   2    Copyright (C) 1988, 1992, 1993 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 recieve 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 scrollbars on this frame.
 126      Actually, we don't specify exactly what is stored here at all; the
 127      scrollbar 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 scrollbars;
 133   Lisp_Object condemned_scrollbars;
 134
 135   /* The output method says how the contents of this frame
 136      are displayed.  It could be using termcap, or using an X window.  */
 137   enum output_method output_method;
 138
 139   /* A structure of auxiliary data used for displaying the contents.
 140      struct x_display is used for X window frames;
 141      it is defined in xterm.h.  */
 142   union display { struct x_display *x; int nothing; } display;
 143
 144   /* Nonzero if last attempt at redisplay on this frame was preempted.  */
 145   char display_preempted;
 146
 147   /* visible is nonzero if the frame is currently displayed; we check
 148      it to see if we should bother updating the frame's contents.
 149      DON'T SET IT DIRECTLY; instead, use FRAME_SET_VISIBLE.
 150
 151      Note that, since invisible frames aren't updated, whenever a
 152      frame becomes visible again, it must be marked as garbaged.  The
 153      FRAME_SAMPLE_VISIBILITY macro takes care of this.
 154
 155      iconified is nonzero if the frame is currently iconified.
 156
 157      Asynchronous input handlers should NOT change these directly;
 158      instead, they should change async_visible or async_iconified, and
 159      let the FRAME_SAMPLE_VISIBILITY macro set visible and iconified
 160      at the next redisplay.
 161
 162      These should probably be considered read-only by everyone except
 163      FRAME_SAMPLE_VISIBILITY.
 164
 165      This two are mutually exclusive.  They might both be zero, if the
 166      frame has been made invisible without an icon.  */
 167   char visible, iconified;
 168
 169   /* Asynchronous input handlers change these, and
 170      FRAME_SAMPLE_VISIBILITY copies them into visible and iconified.
 171      See FRAME_SAMPLE_VISIBILITY, below.  */
 172 #ifdef __STDC__
 173   volatile
 174 #endif
 175   char async_visible, async_iconified;
 176
 177   /* Nonzero if this frame should be redrawn.  */
 178 #ifdef __STDC__
 179   volatile
 180 #endif
 181   char garbaged;
 182
 183   /* True if frame actually has a minibuffer window on it.
 184      0 if using a minibuffer window that isn't on this frame.  */
 185   char has_minibuffer;
 186
 187   /* 0 means, if this frame has just one window,
 188      show no modeline for that window.  */
 189   char wants_modeline;
 190
 191   /* Non-zero if the hardware device this frame is displaying on can
 192      support scrollbars.  */
 193   char can_have_scrollbars;
 194
 195   /* If can_have_scrollbars is non-zero, this is non-zero if we should
 196      actually display them on this frame.  */
 197   char has_vertical_scrollbars;
 198
 199   /* Non-0 means raise this frame to the top of the heap when selected.  */
 200   char auto_raise;
 201
 202   /* Non-0 means lower this frame to the bottom of the stack when left.  */
 203   char auto_lower;
 204
 205   /* True if frame's root window can't be split.  */
 206   char no_split;
 207
 208   /* If this is set, then Emacs won't change the frame name to indicate
 209      the current buffer, etcetera.  If the user explicitly sets the frame
 210      name, this gets set.  If the user sets the name to Qnil, this is
 211      cleared.  */
 212   char explicit_name;
 213
 214   /* Storage for messages to this frame. */
 215   char *message_buf;
 216
 217   /* Nonnegative if current redisplay should not do scroll computation
 218      for lines beyond a certain vpos.  This is the vpos.  */
 219   int scroll_bottom_vpos;
 220 };
 221
 222 #ifdef MULTI_FRAME
 223
 224 typedef struct frame *FRAME_PTR;
 225
 226 #define XFRAME(p) ((struct frame *) XPNTR (p))
 227 #define XSETFRAME(p, v) ((struct frame *) XSETPNTR (p, v))
 228
 229 #define WINDOW_FRAME(w) (w)->frame
 230
 231 #define FRAMEP(f) (XTYPE(f) == Lisp_Frame)
 232 #define FRAME_LIVE_P(f) ((f)->display.nothing != 0)
 233 #define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap)
 234 #define FRAME_X_P(f) ((f)->output_method == output_x_window)
 235 #define FRAME_MINIBUF_ONLY_P(f) \
 236   EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f))
 237 #define FRAME_HAS_MINIBUF_P(f) ((f)->has_minibuffer)
 238 #define FRAME_CURRENT_GLYPHS(f) (f)->current_glyphs
 239 #define FRAME_DESIRED_GLYPHS(f) (f)->desired_glyphs
 240 #define FRAME_TEMP_GLYPHS(f) (f)->temp_glyphs
 241 #define FRAME_HEIGHT(f) (f)->height
 242 #define FRAME_WIDTH(f) (f)->width
 243 #define FRAME_NEW_HEIGHT(f) (f)->new_height
 244 #define FRAME_NEW_WIDTH(f) (f)->new_width
 245 #define FRAME_CURSOR_X(f) (f)->cursor_x
 246 #define FRAME_CURSOR_Y(f) (f)->cursor_y
 247 #define FRAME_VISIBLE_P(f) ((f)->visible != 0)
 248 #define FRAME_SET_VISIBLE(f,p) \
 249   ((f)->async_visible = (p), FRAME_SAMPLE_VISIBILITY (f))
 250 #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1, f->garbaged = 1)
 251 #define FRAME_GARBAGED_P(f) (f)->garbaged
 252 #define FRAME_NO_SPLIT_P(f) (f)->no_split
 253 #define FRAME_WANTS_MODELINE_P(f) (f)->wants_modeline
 254 #define FRAME_ICONIFIED_P(f) (f)->iconified
 255 #define FRAME_MINIBUF_WINDOW(f) (f)->minibuffer_window
 256 #define FRAME_ROOT_WINDOW(f) (f)->root_window
 257 #define FRAME_SELECTED_WINDOW(f) (f)->selected_window
 258 #define SET_GLYPHS_FRAME(glyphs,frame) ((glyphs)->frame = (frame))
 259 #define FRAME_INSERT_COST(f) (f)->insert_line_cost
 260 #define FRAME_DELETE_COST(f) (f)->delete_line_cost
 261 #define FRAME_INSERTN_COST(f) (f)->insert_n_lines_cost
 262 #define FRAME_DELETEN_COST(f) (f)->delete_n_lines_cost
 263 #define FRAME_MESSAGE_BUF(f) (f)->message_buf
 264 #define FRAME_SCROLL_BOTTOM_VPOS(f) (f)->scroll_bottom_vpos
 265 #define FRAME_FOCUS_FRAME(f) (f)->focus_frame
 266 #define FRAME_CAN_HAVE_SCROLLBARS(f) ((f)->can_have_scrollbars)
 267 #define FRAME_HAS_VERTICAL_SCROLLBARS(f) ((f)->has_vertical_scrollbars)
 268 #define FRAME_SCROLLBARS(f) ((f)->scrollbars)
 269 #define FRAME_CONDEMNED_SCROLLBARS(f) ((f)->condemned_scrollbars)
 270
 271 /* Emacs's redisplay code could become confused if a frame's
 272    visibility changes at arbitrary times.  For example, if a frame is
 273    visible while the desired glyphs are being built, but becomes
 274    invisible before they are updated, then some rows of the
 275    desired_glyphs will be left marked as enabled after redisplay is
 276    complete, which should never happen.  The next time the frame
 277    becomes visible, redisplay will probably barf.
 278
 279    Currently, there are no similar situations involving iconified, but
 280    the principle is the same.
 281
 282    So instead of having asynchronous input handlers directly set and
 283    clear the frame's visibility and iconification flags, they just set
 284    the async_visible and async_iconified flags; the redisplay code
 285    calls the FRAME_SAMPLE_VISIBILITY macro before doing any redisplay,
 286    which sets visible and iconified from their asynchronous
 287    counterparts.
 288
 289    Synchronous code must use the FRAME_SET_VISIBLE macro.
 290
 291    Also, if a frame used to be invisible, but has just become visible,
 292    it must be marked as garbaged, since redisplay hasn't been keeping
 293    up its contents.  */
 294 #define FRAME_SAMPLE_VISIBILITY(f) \
 295   (((f)->async_visible && ! (f)->visible) ? SET_FRAME_GARBAGED (f) : 0, \
 296    (f)->visible = (f)->async_visible, \
 297    (f)->iconified = (f)->async_iconified)
 298
 299 #define CHECK_FRAME(x, i)                               \
 300   {                                                     \
 301     if (! FRAMEP (x))                                   \
 302       x = wrong_type_argument (Qframep, (x));           \
 303   }
 304
 305 #define CHECK_LIVE_FRAME(x, i)                          \
 306   {                                                     \
 307     if (! FRAMEP (x)                                    \
 308         || ! FRAME_LIVE_P (XFRAME (x)))         \
 309       x = wrong_type_argument (Qframe_live_p, (x));     \
 310   }
 311
 312 /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
 313    `for' loop which iterates over the elements of Vframe_list.  The
 314    loop will set FRAME_VAR, a FRAME_PTR, to each frame in
 315    Vframe_list in succession and execute the statement.  LIST_VAR
 316    should be a Lisp_Object; it is used to iterate through the
 317    Vframe_list.
 318
 319    If MULTI_FRAME isn't defined, then this loop expands to something which
 320    executes the statement once.  */
 321 #define FOR_EACH_FRAME(list_var, frame_var)                     \
 322   for ((list_var) = Vframe_list;                                \
 323        (CONSP (list_var)                                        \
 324         && (frame_var = XFRAME (XCONS (list_var)->car), 1));    \
 325        list_var = XCONS (list_var)->cdr)
 326
 327
 328 extern Lisp_Object Qframep, Qframe_live_p;
 329
 330 extern struct frame *selected_frame;
 331 extern struct frame *last_nonminibuf_frame;
 332
 333 extern struct frame *make_terminal_frame ();
 334 extern struct frame *make_frame ();
 335 extern struct frame *make_minibuffer_frame ();
 336 extern struct frame *make_frame_without_minibuffer ();
 337
 338 extern Lisp_Object Vframe_list;
 339 extern Lisp_Object Vdefault_frame_alist;
 340
 341 extern Lisp_Object Vterminal_frame;
 342 \f
 343 #else /* not MULTI_FRAME */
 344
 345 /* These definitions are used in a single-frame version of Emacs.  */
 346
 347 #define FRAME_PTR int
 348
 349 /* A frame we use to store all the data concerning the screen when we
 350    don't have multiple frames.  Remember, if you store any data in it
 351    which needs to be protected from GC, you should staticpro that
 352    element explicitly.  */
 353 extern struct frame the_only_frame;
 354
 355 extern int selected_frame;
 356 extern int last_nonminibuf_frame;
 357
 358 #define XFRAME(f) selected_frame
 359 #define WINDOW_FRAME(w) selected_frame
 360
 361 #define FRAMEP(f) (XTYPE(f) == Lisp_Frame)
 362 #define FRAME_LIVE_P(f) 1
 363 #define FRAME_TERMCAP_P(f) 1
 364 #define FRAME_X_P(f) 0
 365 #define FRAME_MINIBUF_ONLY_P(f) 0
 366 #define FRAME_HAS_MINIBUF_P(f) 1
 367 #define FRAME_CURRENT_GLYPHS(f) (the_only_frame.current_glyphs)
 368 #define FRAME_DESIRED_GLYPHS(f) (the_only_frame.desired_glyphs)
 369 #define FRAME_TEMP_GLYPHS(f) (the_only_frame.temp_glyphs)
 370 #define FRAME_HEIGHT(f) (the_only_frame.height)
 371 #define FRAME_WIDTH(f) (the_only_frame.width)
 372 #define FRAME_NEW_HEIGHT(f) (the_only_frame.new_height)
 373 #define FRAME_NEW_WIDTH(f) (the_only_frame.new_width)
 374 #define FRAME_CURSOR_X(f) (the_only_frame.cursor_x)
 375 #define FRAME_CURSOR_Y(f) (the_only_frame.cursor_y)
 376 #define FRAME_SET_VISIBLE(f,p) (p)
 377 #define FRAME_VISIBLE_P(f) 1
 378 #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1)
 379 #define FRAME_GARBAGED_P(f) (frame_garbaged)
 380 #define FRAME_NO_SPLIT_P(f) 0
 381 #define FRAME_WANTS_MODELINE_P(f) 1
 382 #define FRAME_ICONIFIED_P(f) 0
 383 #define FRAME_MINIBUF_WINDOW(f) (the_only_frame.root_window)
 384 #define FRAME_ROOT_WINDOW(f) (the_only_frame.root_window)
 385 #define FRAME_SELECTED_WINDOW(f) (selected_window)
 386 #define SET_GLYPHS_FRAME(glyphs,frame) do ; while (0)
 387 #define FRAME_INSERT_COST(frame)  (the_only_frame.insert_line_cost)
 388 #define FRAME_DELETE_COST(frame)  (the_only_frame.delete_line_cost)
 389 #define FRAME_INSERTN_COST(frame) (the_only_frame.insert_n_lines_cost)
 390 #define FRAME_DELETEN_COST(frame) (the_only_frame.delete_n_lines_cost)
 391 #define FRAME_MESSAGE_BUF(f) (the_only_frame.message_buf)
 392 #define FRAME_SCROLL_BOTTOM_VPOS(f) (the_only_frame.scroll_bottom_vpos)
 393 #define FRAME_FOCUS_FRAME(f) (Qnil)
 394 #define FRAME_CAN_HAVE_SCROLLBARS(f) (the_only_frame.can_have_scrollbars)
 395 #define FRAME_HAS_VERTICAL_SCROLLBARS(f) \
 396   (the_only_frame.has_vertical_scrollbars)
 397 #define FRAME_SCROLLBARS(f) (the_only_frame.scrollbars)
 398 #define FRAME_CONDEMNED_SCROLLBARS(f) (the_only_frame.condemned_scrollbars)
 399
 400 /* See comments in definition above.  */
 401 #define FRAME_SAMPLE_VISIBILITY(f) (0)
 402
 403 #define CHECK_FRAME(x, i) do; while (0)
 404 #define CHECK_LIVE_FRAME(x, y) do; while (0)
 405
 406 /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
 407    `for' loop which iterates over the elements of Vframe_list.  The
 408    loop will set FRAME_VAR, a FRAME_PTR, to each frame in
 409    Vframe_list in succession and execute the statement.  LIST_VAR
 410    should be a Lisp_Object; it is used to iterate through the
 411    Vframe_list.
 412
 413    If MULTI_FRAME _is_ defined, then this loop expands to a real
 414    `for' loop which traverses Vframe_list using LIST_VAR and
 415    FRAME_VAR.  */
 416 #define FOR_EACH_FRAME(list_var, frame_var)                     \
 417   for (frame_var = (FRAME_PTR) 1; frame_var; frame_var = (FRAME_PTR) 0)
 418
 419 #endif /* not MULTI_FRAME */
 420
 421 \f
 422 /* Device- and MULTI_FRAME-independent scrollbar stuff.  */
 423
 424 /* The number of columns a vertical scrollbar occupies.  */
 425 #define VERTICAL_SCROLLBAR_WIDTH (2)
 426
 427 /* Return the starting column (zero-based) of the vertical scrollbar
 428    for window W.  The column before this one is the last column we can
 429    use for text.  If the window touches the right edge of the frame,
 430    we have extra space allocated for it.  Otherwise, the scrollbar
 431    takes over the window's rightmost columns.  */
 432 #define WINDOW_VERTICAL_SCROLLBAR_COLUMN(w) \
 433   (((XINT ((w)->left) + XINT ((w)->width)) \
 434     < FRAME_WIDTH (XFRAME (WINDOW_FRAME (w)))) \
 435    ? XINT ((w)->left) + XINT ((w)->width) - VERTICAL_SCROLLBAR_WIDTH \
 436    : FRAME_WIDTH (XFRAME (WINDOW_FRAME (w))))
 437
 438 /* Return the height in lines of the vertical scrollbar in w.  If the
 439    window has a mode line, don't make the scrollbar extend that far.  */
 440 #define WINDOW_VERTICAL_SCROLLBAR_HEIGHT(w) (window_internal_height (w))