code.delx.au - gnu-emacs/blob - 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.  This is usually the frame itself, but if the frame is
  81      minibufferless, this points to the minibuffer frame when it is
  82      active.  */
  83   Lisp_Object focus_frame;
  84
  85   /* This frame's root window.  Every frame has one.
  86      If the frame has only a minibuffer window, this is it.
  87      Otherwise, if the frame has a minibuffer window, this is its sibling.  */
  88   Lisp_Object root_window;
  89
  90   /* This frame's selected window.
  91      Each frame has its own window hierarchy
  92      and one of the windows in it is selected within the frame.
  93      The selected window of the selected frame is Emacs's selected window.  */
  94   Lisp_Object selected_window;
  95
  96   /* This frame's minibuffer window.
  97      Most frames have their own minibuffer windows,
  98      but only the selected frame's minibuffer window
  99      can actually appear to exist.  */
 100   Lisp_Object minibuffer_window;
 101
 102   /* Parameter alist of this frame.
 103      These are the parameters specified when creating the frame
 104      or modified with modify-frame-parameters.  */
 105   Lisp_Object param_alist;
 106
 107   /* The output method says how the contents of this frame
 108      are displayed.  It could be using termcap, or using an X window.  */
 109   enum output_method output_method;
 110
 111   /* A structure of auxiliary data used for displaying the contents.
 112      struct x_display is used for X window frames;
 113      it is defined in xterm.h.  */
 114   union display { struct x_display *x; int nothing; } display;
 115
 116   /* Nonzero if last attempt at redisplay on this frame was preempted.  */
 117   char display_preempted;
 118
 119   /* visible is nonzero if the frame is currently displayed; we check
 120      it to see if we should bother updating the frame's contents.
 121
 122      iconified is nonzero if the frame is currently iconified.
 123
 124      Asynchronous input handlers should NOT change these directly;
 125      instead, they should change async_visible or async_iconified, and
 126      let the FRAME_SAMPLE_VISIBILITY macro set visible and iconified
 127      at the next redisplay.
 128
 129      These should probably be considered read-only by everyone except
 130      FRAME_SAMPLE_VISIBILITY.
 131
 132      This two are mutually exclusive.  They might both be zero, if the
 133      frame has been made invisible without an icon.  */
 134   char visible, iconified;
 135
 136   /* Asynchronous input handlers change these, and
 137      FRAME_SAMPLE_VISIBILITY copies them into visible and iconified.
 138      See FRAME_SAMPLE_VISIBILITY, below.  */
 139 #ifdef __STDC__
 140   volatile
 141 #endif
 142   char async_visible, async_iconified;
 143
 144   /* Nonzero if this frame should be redrawn.  */
 145 #ifdef __STDC__
 146   volatile
 147 #endif
 148   char garbaged;
 149
 150   /* True if frame actually has a minibuffer window on it.
 151      0 if using a minibuffer window that isn't on this frame.  */
 152   char has_minibuffer;
 153
 154   /* 0 means, if this frame has just one window,
 155      show no modeline for that window.  */
 156   char wants_modeline;
 157
 158   /* Non-0 means raise this frame to the top of the heap when selected.  */
 159   char auto_raise;
 160
 161   /* Non-0 means lower this frame to the bottom of the stack when left.  */
 162   char auto_lower;
 163
 164   /* True if frame's root window can't be split.  */
 165   char no_split;
 166
 167   /* If this is set, then Emacs won't change the frame name to indicate
 168      the current buffer, etcetera.  If the user explicitly sets the frame
 169      name, this gets set.  If the user sets the name to Qnil, this is
 170      cleared.  */
 171   char explicit_name;
 172
 173   /* Storage for messages to this frame. */
 174   char *message_buf;
 175
 176   /* Nonnegative if current redisplay should not do scroll computation
 177      for lines beyond a certain vpos.  This is the vpos.  */
 178   int scroll_bottom_vpos;
 179 };
 180
 181 #ifdef MULTI_FRAME
 182
 183 typedef struct frame *FRAME_PTR;
 184
 185 #define XFRAME(p) ((struct frame *) XPNTR (p))
 186 #define XSETFRAME(p, v) ((struct frame *) XSETPNTR (p, v))
 187
 188 #define WINDOW_FRAME(w) (w)->frame
 189
 190 #define FRAMEP(f) (XTYPE(f) == Lisp_Frame)
 191 #define FRAME_LIVE_P(f) ((f)->display.nothing != 0)
 192 #define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap)
 193 #define FRAME_X_P(f) ((f)->output_method == output_x_window)
 194 #define FRAME_MINIBUF_ONLY_P(f) \
 195   EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f))
 196 #define FRAME_HAS_MINIBUF_P(f) ((f)->has_minibuffer)
 197 #define FRAME_CURRENT_GLYPHS(f) (f)->current_glyphs
 198 #define FRAME_DESIRED_GLYPHS(f) (f)->desired_glyphs
 199 #define FRAME_TEMP_GLYPHS(f) (f)->temp_glyphs
 200 #define FRAME_HEIGHT(f) (f)->height
 201 #define FRAME_WIDTH(f) (f)->width
 202 #define FRAME_NEW_HEIGHT(f) (f)->new_height
 203 #define FRAME_NEW_WIDTH(f) (f)->new_width
 204 #define FRAME_CURSOR_X(f) (f)->cursor_x
 205 #define FRAME_CURSOR_Y(f) (f)->cursor_y
 206 #define FRAME_VISIBLE_P(f) (f)->visible
 207 #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1, f->garbaged = 1)
 208 #define FRAME_GARBAGED_P(f) (f)->garbaged
 209 #define FRAME_NO_SPLIT_P(f) (f)->no_split
 210 #define FRAME_WANTS_MODELINE_P(f) (f)->wants_modeline
 211 #define FRAME_ICONIFIED_P(f) (f)->iconified
 212 #define FRAME_MINIBUF_WINDOW(f) (f)->minibuffer_window
 213 #define FRAME_ROOT_WINDOW(f) (f)->root_window
 214 #define FRAME_SELECTED_WINDOW(f) (f)->selected_window
 215 #define SET_GLYPHS_FRAME(glyphs,frame) ((glyphs)->frame = (frame))
 216 #define FRAME_INSERT_COST(f) (f)->insert_line_cost
 217 #define FRAME_DELETE_COST(f) (f)->delete_line_cost
 218 #define FRAME_INSERTN_COST(f) (f)->insert_n_lines_cost
 219 #define FRAME_DELETEN_COST(f) (f)->delete_n_lines_cost
 220 #define FRAME_MESSAGE_BUF(f) (f)->message_buf
 221 #define FRAME_SCROLL_BOTTOM_VPOS(f) (f)->scroll_bottom_vpos
 222 #define FRAME_FOCUS_FRAME(f) (f)->focus_frame
 223
 224 /* Emacs's redisplay code could become confused if a frame's
 225    visibility changes at arbitrary times.  For example, if a frame is
 226    visible while the desired glyphs are being built, but becomes
 227    invisible before they are updated, then some rows of the
 228    desired_glyphs will be left marked as enabled after redisplay is
 229    complete, which should never happen.  The next time the frame
 230    becomes visible, redisplay will probably barf.
 231
 232    Currently, there are no similar situations involving iconified, but
 233    the principle is the same.
 234
 235    So instead of having asynchronous input handlers directly set and
 236    clear the frame's visibility and iconification flags, they just set
 237    the async_visible and async_iconified flags; the redisplay code
 238    calls the FRAME_SAMPLE_VISIBILITY macro before doing any redisplay,
 239    which sets visible and iconified from their asynchronous
 240    counterparts.  */
 241 #define FRAME_SAMPLE_VISIBILITY(f) \
 242   ((f)->visible = (f)->async_visible, \
 243    (f)->iconified = (f)->async_iconified)
 244
 245 #define CHECK_FRAME(x, i)                               \
 246   {                                                     \
 247     if (! FRAMEP (x))                                   \
 248       x = wrong_type_argument (Qframep, (x));           \
 249   }
 250
 251 #define CHECK_LIVE_FRAME(x, i)                          \
 252   {                                                     \
 253     if (! FRAMEP (x)                                    \
 254         || ! FRAME_LIVE_P (XFRAME (x)))         \
 255       x = wrong_type_argument (Qlive_frame_p, (x));     \
 256   }
 257
 258 /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
 259    `for' loop which iterates over the elements of Vframe_list.  The
 260    loop will set FRAME_VAR, a FRAME_PTR, to each frame in
 261    Vframe_list in succession and execute the statement.  LIST_VAR
 262    should be a Lisp_Object; it is used to iterate through the
 263    Vframe_list.
 264
 265    If MULTI_FRAME isn't defined, then this loop expands to something which
 266    executes the statement once.  */
 267 #define FOR_EACH_FRAME(list_var, frame_var)                     \
 268   for ((list_var) = Vframe_list;                                \
 269        (CONSP (list_var)                                        \
 270         && (frame_var = XFRAME (XCONS (list_var)->car), 1));    \
 271        list_var = XCONS (list_var)->cdr)
 272
 273
 274 extern Lisp_Object Qframep, Qlive_frame_p;
 275
 276 extern struct frame *selected_frame;
 277 extern struct frame *last_nonminibuf_frame;
 278
 279 extern struct frame *make_terminal_frame ();
 280 extern struct frame *make_frame ();
 281 extern struct frame *make_minibuffer_frame ();
 282 extern struct frame *make_frame_without_minibuffer ();
 283
 284 /* Nonzero means FRAME_MESSAGE_BUF (selected_frame) is being used by
 285    print.  */
 286 extern int message_buf_print;
 287
 288 extern Lisp_Object Vframe_list;
 289 extern Lisp_Object Vdefault_frame_alist;
 290
 291 extern Lisp_Object Vterminal_frame;
 292 \f
 293 #else /* not MULTI_FRAME */
 294
 295 /* These definitions are used in a single-frame version of Emacs.  */
 296
 297 #define FRAME_PTR int
 298
 299 /* A frame we use to store all the data concerning the screen when we
 300    don't have multiple frames.  Remember, if you store any data in it
 301    which needs to be protected from GC, you should staticpro that
 302    element explicitly.  */
 303 extern struct frame the_only_frame;
 304
 305 extern int selected_frame;
 306 extern int last_nonminibuf_frame;
 307
 308 /* Nonzero means FRAME_MESSAGE_BUF (selected_frame) is being used by
 309    print.  */
 310 extern int message_buf_print;
 311
 312 #define XFRAME(f) selected_frame
 313 #define WINDOW_FRAME(w) selected_frame
 314
 315 #define FRAMEP(f) (XTYPE(f) == Lisp_Frame)
 316 #define FRAME_LIVE_P(f) 1
 317 #define FRAME_TERMCAP_P(f) 1
 318 #define FRAME_X_P(f) 0
 319 #define FRAME_MINIBUF_ONLY_P(f) 0
 320 #define FRAME_HAS_MINIBUF_P(f) 1
 321 #define FRAME_CURRENT_GLYPHS(f) (the_only_frame.current_glyphs)
 322 #define FRAME_DESIRED_GLYPHS(f) (the_only_frame.desired_glyphs)
 323 #define FRAME_TEMP_GLYPHS(f) (the_only_frame.temp_glyphs)
 324 #define FRAME_HEIGHT(f) (the_only_frame.height)
 325 #define FRAME_WIDTH(f) (the_only_frame.width)
 326 #define FRAME_NEW_HEIGHT(f) (the_only_frame.new_height)
 327 #define FRAME_NEW_WIDTH(f) (the_only_frame.new_width)
 328 #define FRAME_CURSOR_X(f) (the_only_frame.cursor_x)
 329 #define FRAME_CURSOR_Y(f) (the_only_frame.cursor_y)
 330 #define FRAME_VISIBLE_P(f) 1
 331 #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1)
 332 #define FRAME_GARBAGED_P(f) (frame_garbaged)
 333 #define FRAME_NO_SPLIT_P(f) 0
 334 #define FRAME_WANTS_MODELINE_P(f) 1
 335 #define FRAME_ICONIFIED_P(f) 0
 336 #define FRAME_MINIBUF_WINDOW(f) (the_only_frame.root_window)
 337 #define FRAME_ROOT_WINDOW(f) (the_only_frame.root_window)
 338 #define FRAME_SELECTED_WINDOW(f) (selected_window)
 339 #define SET_GLYPHS_FRAME(glyphs,frame) do ; while (0)
 340 #define FRAME_INSERT_COST(frame)  (the_only_frame.insert_line_cost)
 341 #define FRAME_DELETE_COST(frame)  (the_only_frame.delete_line_cost)
 342 #define FRAME_INSERTN_COST(frame) (the_only_frame.insert_n_lines_cost)
 343 #define FRAME_DELETEN_COST(frame) (the_only_frame.delete_n_lines_cost)
 344 #define FRAME_MESSAGE_BUF(f) (the_only_frame.message_buf)
 345 #define FRAME_SCROLL_BOTTOM_VPOS(f) (the_only_frame.scroll_bottom_vpos)
 346 #define FRAME_FOCUS_FRAME(f) (0)
 347
 348 /* See comments in definition above.  */
 349 #define FRAME_SAMPLE_VISIBILITY(f) (0)
 350
 351 #define CHECK_FRAME(x, i) do; while (0)
 352 #define CHECK_LIVE_FRAME(x, y) do; while (0)
 353
 354 /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
 355    `for' loop which iterates over the elements of Vframe_list.  The
 356    loop will set FRAME_VAR, a FRAME_PTR, to each frame in
 357    Vframe_list in succession and execute the statement.  LIST_VAR
 358    should be a Lisp_Object; it is used to iterate through the
 359    Vframe_list.
 360
 361    If MULTI_FRAME _is_ defined, then this loop expands to a real
 362    `for' loop which traverses Vframe_list using LIST_VAR and
 363    FRAME_VAR.  */
 364 #define FOR_EACH_FRAME(list_var, frame_var)                     \
 365   for (frame_var = (FRAME_PTR) 1; frame_var; frame_var = (FRAME_PTR) 0)
 366
 367 #endif /* not MULTI_FRAME */