frame.h 19 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Define frame-object for GNU Emacs.
Karl Heuer's avatar
Karl Heuer committed
2
   Copyright (C) 1993, 1994 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
3 4 5 6 7

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Jim Blandy's avatar
Jim Blandy committed
8
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
9 10 11 12 13 14 15 16 17 18 19
any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */

20 21 22 23 24 25 26 27 28 29

/* Miscellanea.  */

/* Nonzero means don't assume anything about current
   contents of actual terminal frame */
extern int frame_garbaged;

/* Nonzero means FRAME_MESSAGE_BUF (selected_frame) is being used by
   print.  */
extern int message_buf_print;
Jim Blandy's avatar
Jim Blandy committed
30

31

Jim Blandy's avatar
Jim Blandy committed
32
/* The structure representing a frame.
Jim Blandy's avatar
Jim Blandy committed
33

Jim Blandy's avatar
Jim Blandy committed
34 35 36
   We declare this even if MULTI_FRAME is not defined, because when
   we lack multi-frame support, we use one instance of this structure
   to represent the one frame we support.  This is cleaner than
Jim Blandy's avatar
Jim Blandy committed
37
   having miscellaneous random variables scattered about.  */
Jim Blandy's avatar
Jim Blandy committed
38 39

enum output_method
Morten Welinder's avatar
Morten Welinder committed
40
{ output_termcap, output_x_window, output_msdos_raw };
Jim Blandy's avatar
Jim Blandy committed
41

Jim Blandy's avatar
Jim Blandy committed
42
struct frame
Jim Blandy's avatar
Jim Blandy committed
43
{
44
  EMACS_INT size;
Jim Blandy's avatar
Jim Blandy committed
45 46
  struct Lisp_Vector *next;

Jim Blandy's avatar
Jim Blandy committed
47 48
  /* glyphs as they appear on the frame */
  struct frame_glyphs *current_glyphs;
Jim Blandy's avatar
Jim Blandy committed
49

Jim Blandy's avatar
Jim Blandy committed
50 51
  /* glyphs we'd like to appear on the frame */
  struct frame_glyphs *desired_glyphs;
Jim Blandy's avatar
Jim Blandy committed
52

Jim Blandy's avatar
Jim Blandy committed
53
  /* See do_line_insertion_deletion_costs for info on these arrays. */
Jim Blandy's avatar
Jim Blandy committed
54
  /* Cost of inserting 1 line on this frame */
Jim Blandy's avatar
Jim Blandy committed
55
  int *insert_line_cost;
Jim Blandy's avatar
Jim Blandy committed
56
  /* Cost of deleting 1 line on this frame */
Jim Blandy's avatar
Jim Blandy committed
57
  int *delete_line_cost;
Jim Blandy's avatar
Jim Blandy committed
58
  /* Cost of inserting n lines on this frame */
Jim Blandy's avatar
Jim Blandy committed
59
  int *insert_n_lines_cost;
Jim Blandy's avatar
Jim Blandy committed
60
  /* Cost of deleting n lines on this frame */
Jim Blandy's avatar
Jim Blandy committed
61 62 63
  int *delete_n_lines_cost;

  /* glyphs for the mode line */
Jim Blandy's avatar
Jim Blandy committed
64
  struct frame_glyphs *temp_glyphs;
Jim Blandy's avatar
Jim Blandy committed
65

Jim Blandy's avatar
Jim Blandy committed
66
  /* Intended cursor position of this frame.
Jim Blandy's avatar
Jim Blandy committed
67
     Measured in characters, counting from upper left corner
Jim Blandy's avatar
Jim Blandy committed
68
     within the frame.  */
Jim Blandy's avatar
Jim Blandy committed
69 70 71
  int cursor_x;
  int cursor_y;

Jim Blandy's avatar
Jim Blandy committed
72 73
  /* Actual cursor position of this frame, and the character under it.
     (Not used for terminal frames.)  */
Jim Blandy's avatar
Jim Blandy committed
74 75
  int phys_cursor_x;
  int phys_cursor_y;
Jim Blandy's avatar
Jim Blandy committed
76 77 78
  /* This is handy for undrawing the cursor, because current_glyphs is
     not always accurate when in do_scrolling.  */
  GLYPH phys_cursor_glyph;
Jim Blandy's avatar
Jim Blandy committed
79

Jim Blandy's avatar
Jim Blandy committed
80
  /* Size of this frame, in units of characters.  */
81 82
  EMACS_INT height;
  EMACS_INT width;
Jim Blandy's avatar
Jim Blandy committed
83 84 85 86

  /* New height and width for pending size change.  0 if no change pending.  */
  int new_height, new_width;

Jim Blandy's avatar
Jim Blandy committed
87
  /* Name of this frame: a Lisp string.  See also `explicit_name'.  */
Jim Blandy's avatar
Jim Blandy committed
88 89
  Lisp_Object name;

90
  /* The frame which should receive keystrokes that occur in this
91 92 93 94 95 96 97 98 99 100
     frame, or nil if they should go to the frame itself.  This is
     usually nil, but if the frame is minibufferless, we can use this
     to redirect keystrokes to a surrogate minibuffer frame when
     needed.

     Note that a value of nil is different than having the field point
     to the frame itself.  Whenever the Fselect_frame function is used
     to shift from one frame to the other, any redirections to the
     original frame are shifted to the newly selected frame; if
     focus_frame is nil, Fselect_frame will leave it alone.  */
Jim Blandy's avatar
Jim Blandy committed
101
  Lisp_Object focus_frame;
Jim Blandy's avatar
Jim Blandy committed
102

Jim Blandy's avatar
Jim Blandy committed
103 104 105
  /* This frame's root window.  Every frame has one.
     If the frame has only a minibuffer window, this is it.
     Otherwise, if the frame has a minibuffer window, this is its sibling.  */
Jim Blandy's avatar
Jim Blandy committed
106 107
  Lisp_Object root_window;

Jim Blandy's avatar
Jim Blandy committed
108 109 110 111
  /* This frame's selected window.
     Each frame has its own window hierarchy
     and one of the windows in it is selected within the frame.
     The selected window of the selected frame is Emacs's selected window.  */
Jim Blandy's avatar
Jim Blandy committed
112 113
  Lisp_Object selected_window;

Jim Blandy's avatar
Jim Blandy committed
114 115 116
  /* This frame's minibuffer window.
     Most frames have their own minibuffer windows,
     but only the selected frame's minibuffer window
Jim Blandy's avatar
Jim Blandy committed
117 118 119
     can actually appear to exist.  */
  Lisp_Object minibuffer_window;

Jim Blandy's avatar
Jim Blandy committed
120 121 122
  /* Parameter alist of this frame.
     These are the parameters specified when creating the frame
     or modified with modify-frame-parameters.  */
Jim Blandy's avatar
Jim Blandy committed
123 124
  Lisp_Object param_alist;

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 129 130 131
     This field is marked by the garbage collector.  It is here
     instead of in the `display' structure so that the garbage
     collector doesn't need to look inside the window-system-dependent
     structure.  */
132 133
  Lisp_Object scroll_bars;
  Lisp_Object condemned_scroll_bars;
134

135 136 137
  /* List of elements to display in the menu bar.
     The elements have the form (KEY STRING . nil) to start;
     when they are displayed, the hpos of the left edge goes in the cddr.  */
138 139
  Lisp_Object menu_bar_items;

140 141 142
  /* Alist of elements (FACE-NAME . FACE-VECTOR-DATA).  */
  Lisp_Object face_alist;

Jim Blandy's avatar
Jim Blandy committed
143
  /* The output method says how the contents of this frame
Jim Blandy's avatar
Jim Blandy committed
144 145 146 147
     are displayed.  It could be using termcap, or using an X window.  */
  enum output_method output_method;

  /* A structure of auxiliary data used for displaying the contents.
Jim Blandy's avatar
Jim Blandy committed
148
     struct x_display is used for X window frames;
Jim Blandy's avatar
Jim Blandy committed
149 150 151
     it is defined in xterm.h.  */
  union display { struct x_display *x; int nothing; } display;

152 153 154
  /* Number of lines of menu bar.  */
  int menu_bar_lines;

155 156 157 158 159
#ifdef USE_X_TOOLKIT
  /* Nonzero means using a menu bar that comes from the X toolkit.  */
  int external_menu_bar;
#endif

Jim Blandy's avatar
Jim Blandy committed
160
  /* Nonzero if last attempt at redisplay on this frame was preempted.  */
Jim Blandy's avatar
Jim Blandy committed
161 162
  char display_preempted;

163 164
  /* visible is nonzero if the frame is currently displayed; we check
     it to see if we should bother updating the frame's contents.
165
     DON'T SET IT DIRECTLY; instead, use FRAME_SET_VISIBLE.
Jim Blandy's avatar
Jim Blandy committed
166

167 168 169 170
     Note that, since invisible frames aren't updated, whenever a
     frame becomes visible again, it must be marked as garbaged.  The
     FRAME_SAMPLE_VISIBILITY macro takes care of this.

171 172 173 174 175 176 177 178 179 180
     iconified is nonzero if the frame is currently iconified.

     Asynchronous input handlers should NOT change these directly;
     instead, they should change async_visible or async_iconified, and
     let the FRAME_SAMPLE_VISIBILITY macro set visible and iconified
     at the next redisplay.

     These should probably be considered read-only by everyone except
     FRAME_SAMPLE_VISIBILITY.

Karl Heuer's avatar
Karl Heuer committed
181
     These two are mutually exclusive.  They might both be zero, if the
182 183 184 185 186 187 188 189 190 191
     frame has been made invisible without an icon.  */
  char visible, iconified;

  /* Asynchronous input handlers change these, and
     FRAME_SAMPLE_VISIBILITY copies them into visible and iconified.
     See FRAME_SAMPLE_VISIBILITY, below.  */
#ifdef __STDC__
  volatile
#endif
  char async_visible, async_iconified;
Jim Blandy's avatar
Jim Blandy committed
192

Jim Blandy's avatar
Jim Blandy committed
193
  /* Nonzero if this frame should be redrawn.  */
194 195 196
#ifdef __STDC__
  volatile
#endif
Jim Blandy's avatar
Jim Blandy committed
197 198
  char garbaged;

Jim Blandy's avatar
Jim Blandy committed
199 200
  /* True if frame actually has a minibuffer window on it.
     0 if using a minibuffer window that isn't on this frame.  */
Jim Blandy's avatar
Jim Blandy committed
201 202
  char has_minibuffer;
     
Jim Blandy's avatar
Jim Blandy committed
203
  /* 0 means, if this frame has just one window,
Jim Blandy's avatar
Jim Blandy committed
204 205 206
     show no modeline for that window.  */
  char wants_modeline;

207
  /* Non-zero if the hardware device this frame is displaying on can
208 209
     support scroll bars.  */
  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

Jim Blandy's avatar
Jim Blandy committed
215
  /* Non-0 means raise this frame to the top of the heap when selected.  */
Jim Blandy's avatar
Jim Blandy committed
216 217
  char auto_raise;

Jim Blandy's avatar
Jim Blandy committed
218
  /* Non-0 means lower this frame to the bottom of the stack when left.  */
Jim Blandy's avatar
Jim Blandy committed
219 220
  char auto_lower;

Jim Blandy's avatar
Jim Blandy committed
221
  /* True if frame's root window can't be split.  */
Jim Blandy's avatar
Jim Blandy committed
222 223
  char no_split;

Jim Blandy's avatar
Jim Blandy committed
224 225 226 227 228 229
  /* If this is set, then Emacs won't change the frame name to indicate
     the current buffer, etcetera.  If the user explicitly sets the frame
     name, this gets set.  If the user sets the name to Qnil, this is
     cleared.  */
  char explicit_name;

Jim Blandy's avatar
Jim Blandy committed
230
  /* Storage for messages to this frame. */
Jim Blandy's avatar
Jim Blandy committed
231 232 233 234 235
  char *message_buf;

  /* Nonnegative if current redisplay should not do scroll computation
     for lines beyond a certain vpos.  This is the vpos.  */
  int scroll_bottom_vpos;
236 237 238 239 240 241 242

  /* A vector that records the entire structure of this frame's menu bar.
     For the format of the data, see extensive comments in xmenu.c.
     Only the X toolkit version uses this.  */
  Lisp_Object menu_bar_vector;
  /* Number of elements in the vector that have meaningful data.  */
  int menu_bar_items_used;
243

244 245 246 247
  /* Width of the scroll bar, in pixels and in characters.
     scroll_bar_cols tracks scroll_bar_pixel_width if the latter is positive;
     a zero value in scroll_bar_pixel_width means to compute the actual width
     on the fly, using scroll_bar_cols and the current font width.  */
248 249
  int scroll_bar_pixel_width;
  int scroll_bar_cols;
250 251 252

  /* The baud rate that was used to calculate costs for this frame.  */
  int cost_calculation_baud_rate;
Jim Blandy's avatar
Jim Blandy committed
253 254
};

Jim Blandy's avatar
Jim Blandy committed
255 256 257 258 259
#ifdef MULTI_FRAME

typedef struct frame *FRAME_PTR;

#define XFRAME(p) ((struct frame *) XPNTR (p))
260
#define XSETFRAME(p, v) XSET (p, Lisp_Frame, v)
Jim Blandy's avatar
Jim Blandy committed
261 262 263 264

#define WINDOW_FRAME(w) (w)->frame

#define FRAME_LIVE_P(f) ((f)->display.nothing != 0)
Jim Blandy's avatar
Jim Blandy committed
265 266
#define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap)
#define FRAME_X_P(f) ((f)->output_method == output_x_window)
Jim Blandy's avatar
Jim Blandy committed
267 268
#define FRAME_MINIBUF_ONLY_P(f) \
  EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f))
Jim Blandy's avatar
Jim Blandy committed
269
#define FRAME_HAS_MINIBUF_P(f) ((f)->has_minibuffer)
Jim Blandy's avatar
Jim Blandy committed
270 271 272 273 274 275 276
#define FRAME_CURRENT_GLYPHS(f) (f)->current_glyphs
#define FRAME_DESIRED_GLYPHS(f) (f)->desired_glyphs
#define FRAME_TEMP_GLYPHS(f) (f)->temp_glyphs
#define FRAME_HEIGHT(f) (f)->height
#define FRAME_WIDTH(f) (f)->width
#define FRAME_NEW_HEIGHT(f) (f)->new_height
#define FRAME_NEW_WIDTH(f) (f)->new_width
277
#define FRAME_MENU_BAR_LINES(f) (f)->menu_bar_lines
278
#ifdef USE_X_TOOLKIT
279
#define FRAME_EXTERNAL_MENU_BAR(f) (f)->external_menu_bar
280 281 282
#else
#define FRAME_EXTERNAL_MENU_BAR(f) 0
#endif
Jim Blandy's avatar
Jim Blandy committed
283 284
#define FRAME_CURSOR_X(f) (f)->cursor_x
#define FRAME_CURSOR_Y(f) (f)->cursor_y
285 286 287
#define FRAME_VISIBLE_P(f) ((f)->visible != 0)
#define FRAME_SET_VISIBLE(f,p) \
  ((f)->async_visible = (p), FRAME_SAMPLE_VISIBILITY (f))
Jim Blandy's avatar
Jim Blandy committed
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
#define SET_FRAME_GARBAGED(f) (frame_garbaged = 1, f->garbaged = 1)
#define FRAME_GARBAGED_P(f) (f)->garbaged
#define FRAME_NO_SPLIT_P(f) (f)->no_split
#define FRAME_WANTS_MODELINE_P(f) (f)->wants_modeline
#define FRAME_ICONIFIED_P(f) (f)->iconified
#define FRAME_MINIBUF_WINDOW(f) (f)->minibuffer_window
#define FRAME_ROOT_WINDOW(f) (f)->root_window
#define FRAME_SELECTED_WINDOW(f) (f)->selected_window
#define SET_GLYPHS_FRAME(glyphs,frame) ((glyphs)->frame = (frame))
#define FRAME_INSERT_COST(f) (f)->insert_line_cost    
#define FRAME_DELETE_COST(f) (f)->delete_line_cost    
#define FRAME_INSERTN_COST(f) (f)->insert_n_lines_cost
#define FRAME_DELETEN_COST(f) (f)->delete_n_lines_cost
#define FRAME_MESSAGE_BUF(f) (f)->message_buf
#define FRAME_SCROLL_BOTTOM_VPOS(f) (f)->scroll_bottom_vpos
#define FRAME_FOCUS_FRAME(f) (f)->focus_frame
304 305
#define FRAME_CAN_HAVE_SCROLL_BARS(f) ((f)->can_have_scroll_bars)
#define FRAME_HAS_VERTICAL_SCROLL_BARS(f) ((f)->has_vertical_scroll_bars)
306 307
#define FRAME_SCROLL_BAR_PIXEL_WIDTH(f) ((f)->scroll_bar_pixel_width)
#define FRAME_SCROLL_BAR_COLS(f) ((f)->scroll_bar_cols)
308 309
#define FRAME_SCROLL_BARS(f) ((f)->scroll_bars)
#define FRAME_CONDEMNED_SCROLL_BARS(f) ((f)->condemned_scroll_bars)
310
#define FRAME_MENU_BAR_ITEMS(f) ((f)->menu_bar_items)
311
#define FRAME_COST_BAUD_RATE(f) ((f)->cost_calculation_baud_rate)
Jim Blandy's avatar
Jim Blandy committed
312

313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
/* Emacs's redisplay code could become confused if a frame's
   visibility changes at arbitrary times.  For example, if a frame is
   visible while the desired glyphs are being built, but becomes
   invisible before they are updated, then some rows of the
   desired_glyphs will be left marked as enabled after redisplay is
   complete, which should never happen.  The next time the frame
   becomes visible, redisplay will probably barf.

   Currently, there are no similar situations involving iconified, but
   the principle is the same.

   So instead of having asynchronous input handlers directly set and
   clear the frame's visibility and iconification flags, they just set
   the async_visible and async_iconified flags; the redisplay code
   calls the FRAME_SAMPLE_VISIBILITY macro before doing any redisplay,
   which sets visible and iconified from their asynchronous
329 330
   counterparts.

331 332 333 334 335
   Synchronous code must use the FRAME_SET_VISIBLE macro.

   Also, if a frame used to be invisible, but has just become visible,
   it must be marked as garbaged, since redisplay hasn't been keeping
   up its contents.  */
336
#define FRAME_SAMPLE_VISIBILITY(f) \
337 338
  (((f)->async_visible && ! (f)->visible) ? SET_FRAME_GARBAGED (f) : 0, \
   (f)->visible = (f)->async_visible, \
339 340
   (f)->iconified = (f)->async_iconified)

Jim Blandy's avatar
Jim Blandy committed
341
#define CHECK_FRAME(x, i)				\
Jim Blandy's avatar
Jim Blandy committed
342
  {							\
Jim Blandy's avatar
Jim Blandy committed
343 344
    if (! FRAMEP (x))					\
      x = wrong_type_argument (Qframep, (x));		\
Jim Blandy's avatar
Jim Blandy committed
345 346
  }

Jim Blandy's avatar
Jim Blandy committed
347
#define CHECK_LIVE_FRAME(x, i)				\
Jim Blandy's avatar
Jim Blandy committed
348
  {							\
Jim Blandy's avatar
Jim Blandy committed
349 350
    if (! FRAMEP (x)					\
	|| ! FRAME_LIVE_P (XFRAME (x)))		\
Jim Blandy's avatar
Jim Blandy committed
351
      x = wrong_type_argument (Qframe_live_p, (x));	\
Jim Blandy's avatar
Jim Blandy committed
352 353
  }

Jim Blandy's avatar
Jim Blandy committed
354 355
/* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
   `for' loop which iterates over the elements of Vframe_list.  The
356
   loop will set FRAME_VAR, a Lisp_Object, to each frame in
Jim Blandy's avatar
Jim Blandy committed
357
   Vframe_list in succession and execute the statement.  LIST_VAR
358
   should be a Lisp_Object too; it is used to iterate through the
Jim Blandy's avatar
Jim Blandy committed
359
   Vframe_list.  
Jim Blandy's avatar
Jim Blandy committed
360

Jim Blandy's avatar
Jim Blandy committed
361
   If MULTI_FRAME isn't defined, then this loop expands to something which 
Jim Blandy's avatar
Jim Blandy committed
362
   executes the statement once.  */
Jim Blandy's avatar
Jim Blandy committed
363 364
#define FOR_EACH_FRAME(list_var, frame_var)			\
  for ((list_var) = Vframe_list;				\
Jim Blandy's avatar
Jim Blandy committed
365
       (CONSP (list_var)					\
366
	&& (frame_var = XCONS (list_var)->car, 1));		\
Jim Blandy's avatar
Jim Blandy committed
367 368 369
       list_var = XCONS (list_var)->cdr)


Richard M. Stallman's avatar
Richard M. Stallman committed
370
extern Lisp_Object Qframep, Qframe_live_p, Qicon;
Jim Blandy's avatar
Jim Blandy committed
371

Jim Blandy's avatar
Jim Blandy committed
372 373
extern struct frame *selected_frame;
extern struct frame *last_nonminibuf_frame;
Jim Blandy's avatar
Jim Blandy committed
374

Jim Blandy's avatar
Jim Blandy committed
375 376 377 378
extern struct frame *make_terminal_frame ();
extern struct frame *make_frame ();
extern struct frame *make_minibuffer_frame ();
extern struct frame *make_frame_without_minibuffer ();
Jim Blandy's avatar
Jim Blandy committed
379

Jim Blandy's avatar
Jim Blandy committed
380 381
extern Lisp_Object Vframe_list;
extern Lisp_Object Vdefault_frame_alist;
Jim Blandy's avatar
Jim Blandy committed
382

Jim Blandy's avatar
Jim Blandy committed
383
extern Lisp_Object Vterminal_frame;
Jim Blandy's avatar
Jim Blandy committed
384

Jim Blandy's avatar
Jim Blandy committed
385
#else /* not MULTI_FRAME */
Jim Blandy's avatar
Jim Blandy committed
386

Jim Blandy's avatar
Jim Blandy committed
387
/* These definitions are used in a single-frame version of Emacs.  */
Jim Blandy's avatar
Jim Blandy committed
388

Jim Blandy's avatar
Jim Blandy committed
389 390 391 392
/* A frame we use to store all the data concerning the screen when we
   don't have multiple frames.  Remember, if you store any data in it
   which needs to be protected from GC, you should staticpro that
   element explicitly.  */
Jim Blandy's avatar
Jim Blandy committed
393
extern struct frame the_only_frame;
Jim Blandy's avatar
Jim Blandy committed
394

Morten Welinder's avatar
Morten Welinder committed
395 396 397 398 399 400 401 402 403
typedef struct frame *FRAME_PTR;
#ifdef __GNUC__
/* A function call for always getting 0 is overkill, so... */
#define WINDOW_FRAME(w) ({ Lisp_Object tem; XSETFASTINT (tem, 0); tem; })
#else
#define WINDOW_FRAME(w) (Fselected_frame ())
#endif
#define XSETFRAME(p, v) (p = WINDOW_FRAME (***bogus***))
#define XFRAME(frame) (&the_only_frame)
Jim Blandy's avatar
Jim Blandy committed
404

Morten Welinder's avatar
Morten Welinder committed
405 406
extern FRAME_PTR selected_frame;
extern FRAME_PTR last_nonminibuf_frame;
Jim Blandy's avatar
Jim Blandy committed
407 408

#define FRAME_LIVE_P(f) 1
Morten Welinder's avatar
Morten Welinder committed
409 410 411 412 413 414
#ifdef MSDOS
/* The following definitions could also be used in the non-MSDOS case,
   but the constants below lead to better code.  */
#define FRAME_TERMCAP_P(f) (the_only_frame.output_method == output_termcap)
#define FRAME_X_P(f) (the_only_frame.output_method != output_termcap)
#else
Jim Blandy's avatar
Jim Blandy committed
415 416
#define FRAME_TERMCAP_P(f) 1
#define FRAME_X_P(f) 0
Morten Welinder's avatar
Morten Welinder committed
417
#endif
Jim Blandy's avatar
Jim Blandy committed
418
#define FRAME_MINIBUF_ONLY_P(f) 0
Jim Blandy's avatar
Jim Blandy committed
419
#define FRAME_HAS_MINIBUF_P(f) 1
Jim Blandy's avatar
Jim Blandy committed
420 421 422 423 424 425 426
#define FRAME_CURRENT_GLYPHS(f) (the_only_frame.current_glyphs)
#define FRAME_DESIRED_GLYPHS(f) (the_only_frame.desired_glyphs)
#define FRAME_TEMP_GLYPHS(f) (the_only_frame.temp_glyphs)
#define FRAME_HEIGHT(f) (the_only_frame.height)
#define FRAME_WIDTH(f) (the_only_frame.width)
#define FRAME_NEW_HEIGHT(f) (the_only_frame.new_height)
#define FRAME_NEW_WIDTH(f) (the_only_frame.new_width)
427
#define FRAME_MENU_BAR_LINES(f) (the_only_frame.menu_bar_lines)
Jim Blandy's avatar
Jim Blandy committed
428 429
#define FRAME_CURSOR_X(f) (the_only_frame.cursor_x)
#define FRAME_CURSOR_Y(f) (the_only_frame.cursor_y)
430
#define FRAME_SET_VISIBLE(f,p) (p)
Jim Blandy's avatar
Jim Blandy committed
431 432
#define FRAME_VISIBLE_P(f) 1
#define SET_FRAME_GARBAGED(f) (frame_garbaged = 1)
Jim Blandy's avatar
Jim Blandy committed
433
#define FRAME_GARBAGED_P(f) (frame_garbaged)
Jim Blandy's avatar
Jim Blandy committed
434 435 436
#define FRAME_NO_SPLIT_P(f) 0
#define FRAME_WANTS_MODELINE_P(f) 1
#define FRAME_ICONIFIED_P(f) 0
437
#define FRAME_MINIBUF_WINDOW(f) (minibuf_window)
Jim Blandy's avatar
Jim Blandy committed
438
#define FRAME_ROOT_WINDOW(f) (the_only_frame.root_window)
Jim Blandy's avatar
Jim Blandy committed
439 440 441 442 443 444 445 446
#define FRAME_SELECTED_WINDOW(f) (selected_window)
#define SET_GLYPHS_FRAME(glyphs,frame) do ; while (0)
#define FRAME_INSERT_COST(frame)  (the_only_frame.insert_line_cost)
#define FRAME_DELETE_COST(frame)  (the_only_frame.delete_line_cost)
#define FRAME_INSERTN_COST(frame) (the_only_frame.insert_n_lines_cost)
#define FRAME_DELETEN_COST(frame) (the_only_frame.delete_n_lines_cost)
#define FRAME_MESSAGE_BUF(f) (the_only_frame.message_buf)
#define FRAME_SCROLL_BOTTOM_VPOS(f) (the_only_frame.scroll_bottom_vpos)
447
#define FRAME_FOCUS_FRAME(f) (Qnil)
448 449 450
#define FRAME_CAN_HAVE_SCROLL_BARS(f) (the_only_frame.can_have_scroll_bars)
#define FRAME_HAS_VERTICAL_SCROLL_BARS(f) \
  (the_only_frame.has_vertical_scroll_bars)
451 452
#define FRAME_SCROLL_BAR_PIXEL_WIDTH(f) (the_only_frame.scroll_bar_pixel_width)
#define FRAME_SCROLL_BAR_COLS(f) (the_only_frame.scroll_bar_cols)
453 454
#define FRAME_SCROLL_BARS(f) (the_only_frame.scroll_bars)
#define FRAME_CONDEMNED_SCROLL_BARS(f) (the_only_frame.condemned_scroll_bars)
455
#define FRAME_MENU_BAR_ITEMS(f) (the_only_frame.menu_bar_items)
456
#define FRAME_COST_BAUD_RATE(f) (the_only_frame.cost_calculation_baud_rate)
Jim Blandy's avatar
Jim Blandy committed
457

458 459 460
/* See comments in definition above.  */
#define FRAME_SAMPLE_VISIBILITY(f) (0)

Jim Blandy's avatar
Jim Blandy committed
461 462
#define CHECK_FRAME(x, i) do; while (0)
#define CHECK_LIVE_FRAME(x, y) do; while (0)
Jim Blandy's avatar
Jim Blandy committed
463 464 465

/* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
   `for' loop which iterates over the elements of Vframe_list.  The
466
   loop will set FRAME_VAR, a Lisp_Object, to each frame in
Jim Blandy's avatar
Jim Blandy committed
467
   Vframe_list in succession and execute the statement.  LIST_VAR
468
   should be a Lisp_Object too; it is used to iterate through the
Jim Blandy's avatar
Jim Blandy committed
469
   Vframe_list.  
Jim Blandy's avatar
Jim Blandy committed
470

Jim Blandy's avatar
Jim Blandy committed
471 472 473 474
   If MULTI_FRAME _is_ defined, then this loop expands to a real
   `for' loop which traverses Vframe_list using LIST_VAR and
   FRAME_VAR.  */
#define FOR_EACH_FRAME(list_var, frame_var)			\
Morten Welinder's avatar
Morten Welinder committed
475
  for (list_var = Qt; frame_var = WINDOW_FRAME (***bogus***), ! NILP (list_var); list_var = Qnil)
Jim Blandy's avatar
Jim Blandy committed
476

Jim Blandy's avatar
Jim Blandy committed
477
#endif /* not MULTI_FRAME */
478 479


480
/* Device- and MULTI_FRAME-independent scroll bar stuff.  */
481

482
/* Return the starting column (zero-based) of the vertical scroll bar
483 484
   for window W.  The column before this one is the last column we can
   use for text.  If the window touches the right edge of the frame,
485
   we have extra space allocated for it.  Otherwise, the scroll bar
486
   takes over the window's rightmost columns.  */
487
#define WINDOW_VERTICAL_SCROLL_BAR_COLUMN(w) \
488 489
  (((XINT ((w)->left) + XINT ((w)->width)) \
    < FRAME_WIDTH (XFRAME (WINDOW_FRAME (w)))) \
490 491
   ? (XINT ((w)->left) + XINT ((w)->width) \
      - FRAME_SCROLL_BAR_COLS (XFRAME (WINDOW_FRAME (w)))) \
492 493
   : FRAME_WIDTH (XFRAME (WINDOW_FRAME (w))))

494 495 496
/* Return the height in lines of the vertical scroll bar in w.  If the
   window has a mode line, don't make the scroll bar extend that far.  */
#define WINDOW_VERTICAL_SCROLL_BAR_HEIGHT(w) (window_internal_height (w))