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   /* Nonzero if frame is currently displayed.  */
 120   char visible;
 121
 122   /* Nonzero if window is currently iconified.
 123      This and visible are mutually exclusive.  */
 124   char iconified;
 125
 126   /* Nonzero if this frame should be redrawn.  */
 127   char garbaged;
 128
 129   /* True if frame actually has a minibuffer window on it.
 130      0 if using a minibuffer window that isn't on this frame.  */
 131   char has_minibuffer;
 132
 133   /* 0 means, if this frame has just one window,
 134      show no modeline for that window.  */
 135   char wants_modeline;
 136
 137   /* Non-0 means raise this frame to the top of the heap when selected.  */
 138   char auto_raise;
 139
 140   /* Non-0 means lower this frame to the bottom of the stack when left.  */
 141   char auto_lower;
 142
 143   /* True if frame's root window can't be split.  */
 144   char no_split;
 145
 146   /* If this is set, then Emacs won't change the frame name to indicate
 147      the current buffer, etcetera.  If the user explicitly sets the frame
 148      name, this gets set.  If the user sets the name to Qnil, this is
 149      cleared.  */
 150   char explicit_name;
 151
 152   /* Storage for messages to this frame. */
 153   char *message_buf;
 154
 155   /* Nonnegative if current redisplay should not do scroll computation
 156      for lines beyond a certain vpos.  This is the vpos.  */
 157   int scroll_bottom_vpos;
 158 };
 159
 160 #ifdef MULTI_FRAME
 161
 162 typedef struct frame *FRAME_PTR;
 163
 164 #define XFRAME(p) ((struct frame *) XPNTR (p))
 165 #define XSETFRAME(p, v) ((struct frame *) XSETPNTR (p, v))
 166
 167 #define WINDOW_FRAME(w) (w)->frame
 168
 169 #define FRAMEP(f) (XTYPE(f) == Lisp_Frame)
 170 #define FRAME_LIVE_P(f) ((f)->display.nothing != 0)
 171 #define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap)
 172 #define FRAME_X_P(f) ((f)->output_method == output_x_window)
 173 #define FRAME_MINIBUF_ONLY_P(f) \
 174   EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f))
 175 #define FRAME_HAS_MINIBUF_P(f) ((f)->has_minibuffer)
 176 #define FRAME_CURRENT_GLYPHS(f) (f)->current_glyphs
 177 #define FRAME_DESIRED_GLYPHS(f) (f)->desired_glyphs
 178 #define FRAME_TEMP_GLYPHS(f) (f)->temp_glyphs
 179 #define FRAME_HEIGHT(f) (f)->height
 180 #define FRAME_WIDTH(f) (f)->width
 181 #define FRAME_NEW_HEIGHT(f) (f)->new_height
 182 #define FRAME_NEW_WIDTH(f) (f)->new_width
 183 #define FRAME_CURSOR_X(f) (f)->cursor_x
 184 #define FRAME_CURSOR_Y(f) (f)->cursor_y
 185 #define FRAME_VISIBLE_P(f) (f)->visible
 186 #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1, f->garbaged = 1)
 187 #define FRAME_GARBAGED_P(f) (f)->garbaged
 188 #define FRAME_NO_SPLIT_P(f) (f)->no_split
 189 #define FRAME_WANTS_MODELINE_P(f) (f)->wants_modeline
 190 #define FRAME_ICONIFIED_P(f) (f)->iconified
 191 #define FRAME_MINIBUF_WINDOW(f) (f)->minibuffer_window
 192 #define FRAME_ROOT_WINDOW(f) (f)->root_window
 193 #define FRAME_SELECTED_WINDOW(f) (f)->selected_window
 194 #define SET_GLYPHS_FRAME(glyphs,frame) ((glyphs)->frame = (frame))
 195 #define FRAME_INSERT_COST(f) (f)->insert_line_cost
 196 #define FRAME_DELETE_COST(f) (f)->delete_line_cost
 197 #define FRAME_INSERTN_COST(f) (f)->insert_n_lines_cost
 198 #define FRAME_DELETEN_COST(f) (f)->delete_n_lines_cost
 199 #define FRAME_MESSAGE_BUF(f) (f)->message_buf
 200 #define FRAME_SCROLL_BOTTOM_VPOS(f) (f)->scroll_bottom_vpos
 201 #define FRAME_FOCUS_FRAME(f) (f)->focus_frame
 202
 203 #define CHECK_FRAME(x, i)                               \
 204   {                                                     \
 205     if (! FRAMEP (x))                                   \
 206       x = wrong_type_argument (Qframep, (x));           \
 207   }
 208
 209 #define CHECK_LIVE_FRAME(x, i)                          \
 210   {                                                     \
 211     if (! FRAMEP (x)                                    \
 212         || ! FRAME_LIVE_P (XFRAME (x)))         \
 213       x = wrong_type_argument (Qlive_frame_p, (x));     \
 214   }
 215
 216 /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
 217    `for' loop which iterates over the elements of Vframe_list.  The
 218    loop will set FRAME_VAR, a FRAME_PTR, to each frame in
 219    Vframe_list in succession and execute the statement.  LIST_VAR
 220    should be a Lisp_Object; it is used to iterate through the
 221    Vframe_list.
 222
 223    If MULTI_FRAME isn't defined, then this loop expands to something which
 224    executes the statement once.  */
 225 #define FOR_EACH_FRAME(list_var, frame_var)                     \
 226   for ((list_var) = Vframe_list;                                \
 227        (CONSP (list_var)                                        \
 228         && (frame_var = XFRAME (XCONS (list_var)->car), 1));    \
 229        list_var = XCONS (list_var)->cdr)
 230
 231
 232 extern Lisp_Object Qframep, Qlive_frame_p;
 233
 234 extern struct frame *selected_frame;
 235 extern struct frame *last_nonminibuf_frame;
 236
 237 extern struct frame *make_terminal_frame ();
 238 extern struct frame *make_frame ();
 239 extern struct frame *make_minibuffer_frame ();
 240 extern struct frame *make_frame_without_minibuffer ();
 241
 242 /* Nonzero means FRAME_MESSAGE_BUF (selected_frame) is being used by
 243    print.  */
 244 extern int message_buf_print;
 245
 246 extern Lisp_Object Vframe_list;
 247 extern Lisp_Object Vdefault_frame_alist;
 248
 249 extern Lisp_Object Vterminal_frame;
 250 \f
 251 #else /* not MULTI_FRAME */
 252
 253 /* These definitions are used in a single-frame version of Emacs.  */
 254
 255 #define FRAME_PTR int
 256
 257 /* A frame we use to store all the data concerning the screen when we
 258    don't have multiple frames.  Remember, if you store any data in it
 259    which needs to be protected from GC, you should staticpro that
 260    element explicitly.  */
 261 extern struct frame the_only_frame;
 262
 263 extern int selected_frame;
 264 extern int last_nonminibuf_frame;
 265
 266 /* Nonzero means FRAME_MESSAGE_BUF (selected_frame) is being used by
 267    print.  */
 268 extern int message_buf_print;
 269
 270 #define XFRAME(f) selected_frame
 271 #define WINDOW_FRAME(w) selected_frame
 272
 273 #define FRAMEP(f) (XTYPE(f) == Lisp_Frame)
 274 #define FRAME_LIVE_P(f) 1
 275 #define FRAME_TERMCAP_P(f) 1
 276 #define FRAME_X_P(f) 0
 277 #define FRAME_MINIBUF_ONLY_P(f) 0
 278 #define FRAME_HAS_MINIBUF_P(f) 1
 279 #define FRAME_CURRENT_GLYPHS(f) (the_only_frame.current_glyphs)
 280 #define FRAME_DESIRED_GLYPHS(f) (the_only_frame.desired_glyphs)
 281 #define FRAME_TEMP_GLYPHS(f) (the_only_frame.temp_glyphs)
 282 #define FRAME_HEIGHT(f) (the_only_frame.height)
 283 #define FRAME_WIDTH(f) (the_only_frame.width)
 284 #define FRAME_NEW_HEIGHT(f) (the_only_frame.new_height)
 285 #define FRAME_NEW_WIDTH(f) (the_only_frame.new_width)
 286 #define FRAME_CURSOR_X(f) (the_only_frame.cursor_x)
 287 #define FRAME_CURSOR_Y(f) (the_only_frame.cursor_y)
 288 #define FRAME_VISIBLE_P(f) 1
 289 #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1)
 290 #define FRAME_GARBAGED_P(f) (frame_garbaged)
 291 #define FRAME_NO_SPLIT_P(f) 0
 292 #define FRAME_WANTS_MODELINE_P(f) 1
 293 #define FRAME_ICONIFIED_P(f) 0
 294 #define FRAME_MINIBUF_WINDOW(f) (the_only_frame.root_window)
 295 #define FRAME_ROOT_WINDOW(f) (the_only_frame.root_window)
 296 #define FRAME_SELECTED_WINDOW(f) (selected_window)
 297 #define SET_GLYPHS_FRAME(glyphs,frame) do ; while (0)
 298 #define FRAME_INSERT_COST(frame)  (the_only_frame.insert_line_cost)
 299 #define FRAME_DELETE_COST(frame)  (the_only_frame.delete_line_cost)
 300 #define FRAME_INSERTN_COST(frame) (the_only_frame.insert_n_lines_cost)
 301 #define FRAME_DELETEN_COST(frame) (the_only_frame.delete_n_lines_cost)
 302 #define FRAME_MESSAGE_BUF(f) (the_only_frame.message_buf)
 303 #define FRAME_SCROLL_BOTTOM_VPOS(f) (the_only_frame.scroll_bottom_vpos)
 304 #define FRAME_FOCUS_FRAME(f) (0)
 305
 306 #define CHECK_FRAME(x, i) do; while (0)
 307 #define CHECK_LIVE_FRAME(x, y) do; while (0)
 308
 309 /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
 310    `for' loop which iterates over the elements of Vframe_list.  The
 311    loop will set FRAME_VAR, a FRAME_PTR, to each frame in
 312    Vframe_list in succession and execute the statement.  LIST_VAR
 313    should be a Lisp_Object; it is used to iterate through the
 314    Vframe_list.
 315
 316    If MULTI_FRAME _is_ defined, then this loop expands to a real
 317    `for' loop which traverses Vframe_list using LIST_VAR and
 318    FRAME_VAR.  */
 319 #define FOR_EACH_FRAME(list_var, frame_var)                     \
 320   for (frame_var = (FRAME_PTR) 1; frame_var; frame_var = (FRAME_PTR) 0)
 321
 322 #endif /* not MULTI_FRAME */