src/frame.h

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