frame.h 16.9 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Define frame-object for GNU Emacs.
2
   Copyright (C) 1988, 1992, 1993 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 40 41

enum output_method
{ output_termcap, output_x_window };

Jim Blandy's avatar
Jim Blandy committed
42
struct frame
Jim Blandy's avatar
Jim Blandy committed
43 44 45 46
{
  int size;
  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.  */
Jim Blandy's avatar
Jim Blandy committed
81 82 83 84 85 86
  int height;
  int width;

  /* 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;

Jim Blandy's avatar
Jim Blandy committed
90
  /* The frame which should recieve 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
  Lisp_Object menu_bar_items;

Jim Blandy's avatar
Jim Blandy committed
137
  /* The output method says how the contents of this frame
Jim Blandy's avatar
Jim Blandy committed
138 139 140 141
     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
142
     struct x_display is used for X window frames;
Jim Blandy's avatar
Jim Blandy committed
143 144 145
     it is defined in xterm.h.  */
  union display { struct x_display *x; int nothing; } display;

146 147 148
  /* Number of lines of menu bar.  */
  int menu_bar_lines;

Jim Blandy's avatar
Jim Blandy committed
149
  /* Nonzero if last attempt at redisplay on this frame was preempted.  */
Jim Blandy's avatar
Jim Blandy committed
150 151
  char display_preempted;

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

156 157 158 159
     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.

160 161 162 163 164 165 166 167 168 169 170 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.

     This two are mutually exclusive.  They might both be zero, if the
     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
181

Jim Blandy's avatar
Jim Blandy committed
182
  /* Nonzero if this frame should be redrawn.  */
183 184 185
#ifdef __STDC__
  volatile
#endif
Jim Blandy's avatar
Jim Blandy committed
186 187
  char garbaged;

Jim Blandy's avatar
Jim Blandy committed
188 189
  /* 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
190 191
  char has_minibuffer;
     
Jim Blandy's avatar
Jim Blandy committed
192
  /* 0 means, if this frame has just one window,
Jim Blandy's avatar
Jim Blandy committed
193 194 195
     show no modeline for that window.  */
  char wants_modeline;

196
  /* Non-zero if the hardware device this frame is displaying on can
197 198
     support scroll bars.  */
  char can_have_scroll_bars;
199

200
  /* If can_have_scroll_bars is non-zero, this is non-zero if we should
201
     actually display them on this frame.  */
202
  char has_vertical_scroll_bars;
203

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

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

Jim Blandy's avatar
Jim Blandy committed
210
  /* True if frame's root window can't be split.  */
Jim Blandy's avatar
Jim Blandy committed
211 212
  char no_split;

Jim Blandy's avatar
Jim Blandy committed
213 214 215 216 217 218
  /* 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
219
  /* Storage for messages to this frame. */
Jim Blandy's avatar
Jim Blandy committed
220 221 222 223 224 225 226
  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;
};

Jim Blandy's avatar
Jim Blandy committed
227 228 229 230 231 232 233 234 235 236
#ifdef MULTI_FRAME

typedef struct frame *FRAME_PTR;

#define XFRAME(p) ((struct frame *) XPNTR (p))
#define XSETFRAME(p, v) ((struct frame *) XSETPNTR (p, v))

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

#define FRAME_LIVE_P(f) ((f)->display.nothing != 0)
Jim Blandy's avatar
Jim Blandy committed
237 238
#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
239 240
#define FRAME_MINIBUF_ONLY_P(f) \
  EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f))
Jim Blandy's avatar
Jim Blandy committed
241
#define FRAME_HAS_MINIBUF_P(f) ((f)->has_minibuffer)
Jim Blandy's avatar
Jim Blandy committed
242 243 244 245 246 247 248
#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
249
#define FRAME_MENU_BAR_LINES(f) (f)->menu_bar_lines
Jim Blandy's avatar
Jim Blandy committed
250 251
#define FRAME_CURSOR_X(f) (f)->cursor_x
#define FRAME_CURSOR_Y(f) (f)->cursor_y
252 253 254
#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
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
#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
271 272 273 274
#define FRAME_CAN_HAVE_SCROLL_BARS(f) ((f)->can_have_scroll_bars)
#define FRAME_HAS_VERTICAL_SCROLL_BARS(f) ((f)->has_vertical_scroll_bars)
#define FRAME_SCROLL_BARS(f) ((f)->scroll_bars)
#define FRAME_CONDEMNED_SCROLL_BARS(f) ((f)->condemned_scroll_bars)
275
#define FRAME_MENU_BAR_ITEMS(f) ((f)->menu_bar_items)
Jim Blandy's avatar
Jim Blandy committed
276

277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
/* 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
293 294
   counterparts.

295 296 297 298 299
   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.  */
300
#define FRAME_SAMPLE_VISIBILITY(f) \
301 302
  (((f)->async_visible && ! (f)->visible) ? SET_FRAME_GARBAGED (f) : 0, \
   (f)->visible = (f)->async_visible, \
303 304
   (f)->iconified = (f)->async_iconified)

Jim Blandy's avatar
Jim Blandy committed
305
#define CHECK_FRAME(x, i)				\
Jim Blandy's avatar
Jim Blandy committed
306
  {							\
Jim Blandy's avatar
Jim Blandy committed
307 308
    if (! FRAMEP (x))					\
      x = wrong_type_argument (Qframep, (x));		\
Jim Blandy's avatar
Jim Blandy committed
309 310
  }

Jim Blandy's avatar
Jim Blandy committed
311
#define CHECK_LIVE_FRAME(x, i)				\
Jim Blandy's avatar
Jim Blandy committed
312
  {							\
Jim Blandy's avatar
Jim Blandy committed
313 314
    if (! FRAMEP (x)					\
	|| ! FRAME_LIVE_P (XFRAME (x)))		\
Jim Blandy's avatar
Jim Blandy committed
315
      x = wrong_type_argument (Qframe_live_p, (x));	\
Jim Blandy's avatar
Jim Blandy committed
316 317
  }

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

Jim Blandy's avatar
Jim Blandy committed
325
   If MULTI_FRAME isn't defined, then this loop expands to something which 
Jim Blandy's avatar
Jim Blandy committed
326
   executes the statement once.  */
Jim Blandy's avatar
Jim Blandy committed
327 328
#define FOR_EACH_FRAME(list_var, frame_var)			\
  for ((list_var) = Vframe_list;				\
Jim Blandy's avatar
Jim Blandy committed
329
       (CONSP (list_var)					\
330
	&& (frame_var = XCONS (list_var)->car, 1));		\
Jim Blandy's avatar
Jim Blandy committed
331 332 333
       list_var = XCONS (list_var)->cdr)


Jim Blandy's avatar
Jim Blandy committed
334
extern Lisp_Object Qframep, Qframe_live_p;
Jim Blandy's avatar
Jim Blandy committed
335

Jim Blandy's avatar
Jim Blandy committed
336 337
extern struct frame *selected_frame;
extern struct frame *last_nonminibuf_frame;
Jim Blandy's avatar
Jim Blandy committed
338

Jim Blandy's avatar
Jim Blandy committed
339 340 341 342
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
343

Jim Blandy's avatar
Jim Blandy committed
344 345
extern Lisp_Object Vframe_list;
extern Lisp_Object Vdefault_frame_alist;
Jim Blandy's avatar
Jim Blandy committed
346

Jim Blandy's avatar
Jim Blandy committed
347
extern Lisp_Object Vterminal_frame;
Jim Blandy's avatar
Jim Blandy committed
348

Jim Blandy's avatar
Jim Blandy committed
349
#else /* not MULTI_FRAME */
Jim Blandy's avatar
Jim Blandy committed
350

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

Jim Blandy's avatar
Jim Blandy committed
353
#define FRAME_PTR int
Jim Blandy's avatar
Jim Blandy committed
354

Jim Blandy's avatar
Jim Blandy committed
355 356 357 358
/* 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
359
extern struct frame the_only_frame;
Jim Blandy's avatar
Jim Blandy committed
360

Jim Blandy's avatar
Jim Blandy committed
361 362
extern int selected_frame;
extern int last_nonminibuf_frame;
Jim Blandy's avatar
Jim Blandy committed
363

Jim Blandy's avatar
Jim Blandy committed
364 365 366 367
#define XFRAME(f) selected_frame
#define WINDOW_FRAME(w) selected_frame

#define FRAME_LIVE_P(f) 1
Jim Blandy's avatar
Jim Blandy committed
368 369
#define FRAME_TERMCAP_P(f) 1
#define FRAME_X_P(f) 0
Jim Blandy's avatar
Jim Blandy committed
370
#define FRAME_MINIBUF_ONLY_P(f) 0
Jim Blandy's avatar
Jim Blandy committed
371
#define FRAME_HAS_MINIBUF_P(f) 1
Jim Blandy's avatar
Jim Blandy committed
372 373 374 375 376 377 378
#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)
379
#define FRAME_MENU_BAR_LINES(f) (the_only_frame.menu_bar_lines)
Jim Blandy's avatar
Jim Blandy committed
380 381
#define FRAME_CURSOR_X(f) (the_only_frame.cursor_x)
#define FRAME_CURSOR_Y(f) (the_only_frame.cursor_y)
382
#define FRAME_SET_VISIBLE(f,p) (p)
Jim Blandy's avatar
Jim Blandy committed
383 384
#define FRAME_VISIBLE_P(f) 1
#define SET_FRAME_GARBAGED(f) (frame_garbaged = 1)
Jim Blandy's avatar
Jim Blandy committed
385
#define FRAME_GARBAGED_P(f) (frame_garbaged)
Jim Blandy's avatar
Jim Blandy committed
386 387 388
#define FRAME_NO_SPLIT_P(f) 0
#define FRAME_WANTS_MODELINE_P(f) 1
#define FRAME_ICONIFIED_P(f) 0
Jim Blandy's avatar
Jim Blandy committed
389 390
#define FRAME_MINIBUF_WINDOW(f) (the_only_frame.root_window)
#define FRAME_ROOT_WINDOW(f) (the_only_frame.root_window)
Jim Blandy's avatar
Jim Blandy committed
391 392 393 394 395 396 397 398
#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)
399
#define FRAME_FOCUS_FRAME(f) (Qnil)
400 401 402 403 404
#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)
#define FRAME_SCROLL_BARS(f) (the_only_frame.scroll_bars)
#define FRAME_CONDEMNED_SCROLL_BARS(f) (the_only_frame.condemned_scroll_bars)
405
#define FRAME_MENU_BAR_ITEMS(f) (the_only_frame.menu_bar_items)
Jim Blandy's avatar
Jim Blandy committed
406

407 408 409
/* See comments in definition above.  */
#define FRAME_SAMPLE_VISIBILITY(f) (0)

Jim Blandy's avatar
Jim Blandy committed
410 411
#define CHECK_FRAME(x, i) do; while (0)
#define CHECK_LIVE_FRAME(x, y) do; while (0)
Jim Blandy's avatar
Jim Blandy committed
412 413 414

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

Jim Blandy's avatar
Jim Blandy committed
420 421 422 423
   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)			\
424
  for (list_var = Qt; frame_var = selected_frame, ! NILP (list_var); list_var = Qnil)
Jim Blandy's avatar
Jim Blandy committed
425

Jim Blandy's avatar
Jim Blandy committed
426
#endif /* not MULTI_FRAME */
427 428


429
/* Device- and MULTI_FRAME-independent scroll bar stuff.  */
430

431 432
/* The number of columns a vertical scroll bar occupies.  */
#define VERTICAL_SCROLL_BAR_WIDTH (2)
433

434
/* Return the starting column (zero-based) of the vertical scroll bar
435 436
   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,
437
   we have extra space allocated for it.  Otherwise, the scroll bar
438
   takes over the window's rightmost columns.  */
439
#define WINDOW_VERTICAL_SCROLL_BAR_COLUMN(w) \
440 441
  (((XINT ((w)->left) + XINT ((w)->width)) \
    < FRAME_WIDTH (XFRAME (WINDOW_FRAME (w)))) \
442
   ? XINT ((w)->left) + XINT ((w)->width) - VERTICAL_SCROLL_BAR_WIDTH \
443 444
   : FRAME_WIDTH (XFRAME (WINDOW_FRAME (w))))

445 446 447
/* 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))