| 1 | /* Don't multiply include: dispextern.h includes macterm.h which includes frame.h |
| 2 | some emacs source includes both dispextern.h and frame.h */ |
| 3 | #ifndef _XFRAME_H_ |
| 4 | #define _XFRAME_H_ |
| 5 | |
| 6 | /* Define frame-object for GNU Emacs. |
| 7 | Copyright (C) 1993, 1994 Free Software Foundation, Inc. |
| 8 | |
| 9 | This file is part of GNU Emacs. |
| 10 | |
| 11 | GNU Emacs is free software; you can redistribute it and/or modify |
| 12 | it under the terms of the GNU General Public License as published by |
| 13 | the Free Software Foundation; either version 2, or (at your option) |
| 14 | any later version. |
| 15 | |
| 16 | GNU Emacs is distributed in the hope that it will be useful, |
| 17 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 18 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 19 | GNU General Public License for more details. |
| 20 | |
| 21 | You should have received a copy of the GNU General Public License |
| 22 | along with GNU Emacs; see the file COPYING. If not, write to |
| 23 | the Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
| 24 | Boston, MA 02111-1307, USA. */ |
| 25 | |
| 26 | \f |
| 27 | /* Miscellanea. */ |
| 28 | |
| 29 | /* Nonzero means don't assume anything about current contents of |
| 30 | actual terminal frame */ |
| 31 | |
| 32 | extern int frame_garbaged; |
| 33 | |
| 34 | /* Nonzero means FRAME_MESSAGE_BUF (selected_frame) is being used by |
| 35 | print. */ |
| 36 | |
| 37 | extern int message_buf_print; |
| 38 | |
| 39 | \f |
| 40 | /* The structure representing a frame. */ |
| 41 | |
| 42 | enum output_method |
| 43 | { |
| 44 | output_termcap, |
| 45 | output_x_window, |
| 46 | output_msdos_raw, |
| 47 | output_w32, |
| 48 | output_mac |
| 49 | }; |
| 50 | |
| 51 | enum vertical_scroll_bar_type |
| 52 | { |
| 53 | vertical_scroll_bar_none, |
| 54 | vertical_scroll_bar_left, |
| 55 | vertical_scroll_bar_right |
| 56 | }; |
| 57 | |
| 58 | struct frame |
| 59 | { |
| 60 | EMACS_INT size; |
| 61 | struct Lisp_Vector *next; |
| 62 | |
| 63 | /* All Lisp_Object components must come first. |
| 64 | Only EMACS_INT values can be intermixed with them. |
| 65 | That ensures they are all aligned normally. */ |
| 66 | |
| 67 | /* Name of this frame: a Lisp string. It is used for looking up resources, |
| 68 | as well as for the title in some cases. */ |
| 69 | Lisp_Object name; |
| 70 | |
| 71 | /* The name to use for the icon, the last time |
| 72 | it was refreshed. nil means not explicitly specified. */ |
| 73 | Lisp_Object icon_name; |
| 74 | |
| 75 | /* This is the frame title specified explicitly, if any. |
| 76 | Usually it is nil. */ |
| 77 | Lisp_Object title; |
| 78 | |
| 79 | /* The frame which should receive 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 | /* List of scroll bars on this frame. |
| 115 | Actually, we don't specify exactly what is stored here at all; the |
| 116 | scroll bar implementation code can use it to store anything it likes. |
| 117 | This field is marked by the garbage collector. It is here |
| 118 | instead of in the `display' structure so that the garbage |
| 119 | collector doesn't need to look inside the window-system-dependent |
| 120 | structure. */ |
| 121 | Lisp_Object scroll_bars; |
| 122 | Lisp_Object condemned_scroll_bars; |
| 123 | |
| 124 | /* Vector describing the items to display in the menu bar. |
| 125 | Each item has four elements in this vector. |
| 126 | They are KEY, STRING, SUBMAP, and HPOS. |
| 127 | (HPOS is not used in when the X toolkit is in use.) |
| 128 | There are four additional elements of nil at the end, to terminate. */ |
| 129 | Lisp_Object menu_bar_items; |
| 130 | |
| 131 | /* Alist of elements (FACE-NAME . FACE-VECTOR-DATA). */ |
| 132 | Lisp_Object face_alist; |
| 133 | |
| 134 | /* A vector that records the entire structure of this frame's menu bar. |
| 135 | For the format of the data, see extensive comments in xmenu.c. |
| 136 | Only the X toolkit version uses this. */ |
| 137 | Lisp_Object menu_bar_vector; |
| 138 | /* Number of elements in the vector that have meaningful data. */ |
| 139 | EMACS_INT menu_bar_items_used; |
| 140 | |
| 141 | /* Predicate for selecting buffers for other-buffer. */ |
| 142 | Lisp_Object buffer_predicate; |
| 143 | |
| 144 | /* List of buffers viewed in this frame, for other-buffer. */ |
| 145 | Lisp_Object buffer_list; |
| 146 | |
| 147 | /* A dummy window used to display menu bars under X when no X |
| 148 | toolkit support is available. */ |
| 149 | Lisp_Object menu_bar_window; |
| 150 | |
| 151 | /* A window used to display the tool-bar of a frame. */ |
| 152 | Lisp_Object tool_bar_window; |
| 153 | |
| 154 | /* Desired and current tool-bar items. */ |
| 155 | Lisp_Object desired_tool_bar_items, current_tool_bar_items; |
| 156 | |
| 157 | /* Desired and current contents displayed in tool_bar_window. */ |
| 158 | Lisp_Object desired_tool_bar_string, current_tool_bar_string; |
| 159 | |
| 160 | /* beyond here, there should be no more Lisp_Object components. */ |
| 161 | |
| 162 | /* Cache of realized faces. */ |
| 163 | struct face_cache *face_cache; |
| 164 | |
| 165 | /* A buffer to hold the frame's name. We can't use the Lisp |
| 166 | string's pointer (`name', above) because it might get relocated. */ |
| 167 | char *namebuf; |
| 168 | |
| 169 | /* Glyph pool and matrix. */ |
| 170 | struct glyph_pool *current_pool; |
| 171 | struct glyph_pool *desired_pool; |
| 172 | struct glyph_matrix *desired_matrix; |
| 173 | struct glyph_matrix *current_matrix; |
| 174 | |
| 175 | /* 1 means that glyphs on this frame have been initialized so it can |
| 176 | be used for output. */ |
| 177 | unsigned glyphs_initialized_p : 1; |
| 178 | |
| 179 | /* Margin at the top of the frame. Used to display the tool-bar. */ |
| 180 | int tool_bar_lines; |
| 181 | |
| 182 | int n_desired_tool_bar_items; |
| 183 | int n_current_tool_bar_items; |
| 184 | |
| 185 | /* A buffer for decode_mode_line. */ |
| 186 | char *decode_mode_spec_buffer; |
| 187 | |
| 188 | /* See do_line_insertion_deletion_costs for info on these arrays. */ |
| 189 | /* Cost of inserting 1 line on this frame */ |
| 190 | int *insert_line_cost; |
| 191 | /* Cost of deleting 1 line on this frame */ |
| 192 | int *delete_line_cost; |
| 193 | /* Cost of inserting n lines on this frame */ |
| 194 | int *insert_n_lines_cost; |
| 195 | /* Cost of deleting n lines on this frame */ |
| 196 | int *delete_n_lines_cost; |
| 197 | |
| 198 | /* Size of this frame, in units of characters. */ |
| 199 | EMACS_INT height; |
| 200 | EMACS_INT width; |
| 201 | EMACS_INT window_width; |
| 202 | EMACS_INT window_height; |
| 203 | |
| 204 | /* New height and width for pending size change. 0 if no change pending. */ |
| 205 | int new_height, new_width; |
| 206 | |
| 207 | /* The output method says how the contents of this frame |
| 208 | are displayed. It could be using termcap, or using an X window. */ |
| 209 | enum output_method output_method; |
| 210 | |
| 211 | /* A structure of auxiliary data used for displaying the contents. |
| 212 | struct x_output is used for X window frames; |
| 213 | it is defined in xterm.h. |
| 214 | struct w32_output is used for W32 window frames; |
| 215 | it is defined in w32term.h. */ |
| 216 | union output_data |
| 217 | { |
| 218 | struct x_output *x; |
| 219 | struct w32_output *w32; |
| 220 | struct mac_output *mac; |
| 221 | int nothing; |
| 222 | } |
| 223 | output_data; |
| 224 | |
| 225 | #ifdef MULTI_KBOARD |
| 226 | /* A pointer to the kboard structure associated with this frame. |
| 227 | For termcap frames, this points to initial_kboard. For X frames, |
| 228 | it will be the same as display.x->display_info->kboard. */ |
| 229 | struct kboard *kboard; |
| 230 | #endif |
| 231 | |
| 232 | /* Number of lines of menu bar. */ |
| 233 | int menu_bar_lines; |
| 234 | |
| 235 | #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) |
| 236 | /* Nonzero means using a menu bar that comes from the X toolkit. */ |
| 237 | int external_menu_bar; |
| 238 | #endif |
| 239 | |
| 240 | /* Nonzero if last attempt at redisplay on this frame was preempted. */ |
| 241 | char display_preempted; |
| 242 | |
| 243 | /* visible is nonzero if the frame is currently displayed; we check |
| 244 | it to see if we should bother updating the frame's contents. |
| 245 | DON'T SET IT DIRECTLY; instead, use FRAME_SET_VISIBLE. |
| 246 | |
| 247 | Note that, since invisible frames aren't updated, whenever a |
| 248 | frame becomes visible again, it must be marked as garbaged. The |
| 249 | FRAME_SAMPLE_VISIBILITY macro takes care of this. |
| 250 | |
| 251 | On Windows NT/9X, to avoid wasting effort updating visible frames |
| 252 | that are actually completely obscured by other windows on the |
| 253 | display, we bend the meaning of visible slightly: if greater than |
| 254 | 1, then the frame is obscured - we still consider it to be |
| 255 | "visible" as seen from lisp, but we don't bother updating it. We |
| 256 | must take care to garbage the frame when it ceaces to be obscured |
| 257 | though. Note that these semantics are only used on NT/9X. |
| 258 | |
| 259 | iconified is nonzero if the frame is currently iconified. |
| 260 | |
| 261 | Asynchronous input handlers should NOT change these directly; |
| 262 | instead, they should change async_visible or async_iconified, and |
| 263 | let the FRAME_SAMPLE_VISIBILITY macro set visible and iconified |
| 264 | at the next redisplay. |
| 265 | |
| 266 | These should probably be considered read-only by everyone except |
| 267 | FRAME_SAMPLE_VISIBILITY. |
| 268 | |
| 269 | These two are mutually exclusive. They might both be zero, if the |
| 270 | frame has been made invisible without an icon. */ |
| 271 | char visible, iconified; |
| 272 | |
| 273 | /* Asynchronous input handlers change these, and |
| 274 | FRAME_SAMPLE_VISIBILITY copies them into visible and iconified. |
| 275 | See FRAME_SAMPLE_VISIBILITY, below. */ |
| 276 | #ifdef __STDC__ |
| 277 | volatile |
| 278 | #endif |
| 279 | char async_visible, async_iconified; |
| 280 | |
| 281 | /* Nonzero if this frame should be redrawn. */ |
| 282 | #ifdef __STDC__ |
| 283 | volatile |
| 284 | #endif |
| 285 | char garbaged; |
| 286 | |
| 287 | /* True if frame actually has a minibuffer window on it. |
| 288 | 0 if using a minibuffer window that isn't on this frame. */ |
| 289 | char has_minibuffer; |
| 290 | |
| 291 | /* 0 means, if this frame has just one window, |
| 292 | show no modeline for that window. */ |
| 293 | char wants_modeline; |
| 294 | |
| 295 | /* Non-zero if the hardware device this frame is displaying on can |
| 296 | support scroll bars. */ |
| 297 | char can_have_scroll_bars; |
| 298 | |
| 299 | /* If can_have_scroll_bars is non-zero, this is non-zero if we should |
| 300 | actually display them on this frame. */ |
| 301 | enum vertical_scroll_bar_type vertical_scroll_bar_type; |
| 302 | |
| 303 | /* Non-0 means raise this frame to the top of the heap when selected. */ |
| 304 | char auto_raise; |
| 305 | |
| 306 | /* Non-0 means lower this frame to the bottom of the stack when left. */ |
| 307 | char auto_lower; |
| 308 | |
| 309 | /* True if frame's root window can't be split. */ |
| 310 | char no_split; |
| 311 | |
| 312 | /* If this is set, then Emacs won't change the frame name to indicate |
| 313 | the current buffer, etcetera. If the user explicitly sets the frame |
| 314 | name, this gets set. If the user sets the name to Qnil, this is |
| 315 | cleared. */ |
| 316 | char explicit_name; |
| 317 | |
| 318 | /* Nonzero if size of some window on this frame has changed. */ |
| 319 | char window_sizes_changed; |
| 320 | |
| 321 | /* Storage for messages to this frame. */ |
| 322 | char *message_buf; |
| 323 | |
| 324 | /* Nonnegative if current redisplay should not do scroll computation |
| 325 | for lines beyond a certain vpos. This is the vpos. */ |
| 326 | int scroll_bottom_vpos; |
| 327 | |
| 328 | /* Width of the scroll bar, in pixels and in characters. |
| 329 | scroll_bar_cols tracks scroll_bar_pixel_width if the latter is positive; |
| 330 | a zero value in scroll_bar_pixel_width means to compute the actual width |
| 331 | on the fly, using scroll_bar_cols and the current font width. */ |
| 332 | int scroll_bar_pixel_width; |
| 333 | int scroll_bar_cols; |
| 334 | |
| 335 | /* Width of area for drawing truncation marks and overlay arrow. */ |
| 336 | int trunc_area_pixel_width, trunc_area_cols; |
| 337 | |
| 338 | /* The baud rate that was used to calculate costs for this frame. */ |
| 339 | int cost_calculation_baud_rate; |
| 340 | |
| 341 | /* A pointer to the data structure containing all information of |
| 342 | fontsets associated with this frame. See the comments in |
| 343 | fontset.h for more detail. */ |
| 344 | struct fontset_data *fontset_data; |
| 345 | |
| 346 | /* Nonzero if the mouse has moved on this display |
| 347 | since the last time we checked. */ |
| 348 | char mouse_moved; |
| 349 | |
| 350 | /* Exponent for gamma correction of colors. 1/(VIEWING_GAMMA * |
| 351 | SCREEN_GAMMA) where viewing_gamma is 0.4545 and SCREEN_GAMMA is a |
| 352 | frame parameter. 0 means don't do gamma correction. */ |
| 353 | double gamma; |
| 354 | }; |
| 355 | |
| 356 | #ifdef MULTI_KBOARD |
| 357 | #define FRAME_KBOARD(f) ((f)->kboard) |
| 358 | #else |
| 359 | #define FRAME_KBOARD(f) (&the_only_kboard) |
| 360 | #endif |
| 361 | |
| 362 | typedef struct frame *FRAME_PTR; |
| 363 | |
| 364 | #define XFRAME(p) ((struct frame *) XPNTR (p)) |
| 365 | #define XSETFRAME(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_FRAME)) |
| 366 | |
| 367 | /* Given a window, return its frame as a Lisp_Object. */ |
| 368 | #define WINDOW_FRAME(w) (w)->frame |
| 369 | |
| 370 | /* Test a frame for particular kinds of display methods. */ |
| 371 | #define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap) |
| 372 | #define FRAME_X_P(f) ((f)->output_method == output_x_window) |
| 373 | #define FRAME_W32_P(f) ((f)->output_method == output_w32) |
| 374 | #define FRAME_MSDOS_P(f) ((f)->output_method == output_msdos_raw) |
| 375 | #define FRAME_MAC_P(f) ((f)->output_method == output_mac) |
| 376 | |
| 377 | /* FRAME_WINDOW_P tests whether the frame is a window, and is |
| 378 | defined to be the predicate for the window system being used. */ |
| 379 | |
| 380 | #ifdef HAVE_X_WINDOWS |
| 381 | #define FRAME_WINDOW_P(f) FRAME_X_P (f) |
| 382 | #endif |
| 383 | #ifdef HAVE_NTGUI |
| 384 | #define FRAME_WINDOW_P(f) FRAME_W32_P (f) |
| 385 | #endif |
| 386 | #ifdef macintosh |
| 387 | #define FRAME_WINDOW_P(f) FRAME_MAC_P (f) |
| 388 | #endif |
| 389 | #ifndef FRAME_WINDOW_P |
| 390 | #define FRAME_WINDOW_P(f) (0) |
| 391 | #endif |
| 392 | |
| 393 | /* Nonzero if frame F is still alive (not deleted). */ |
| 394 | #define FRAME_LIVE_P(f) ((f)->output_data.nothing != 0) |
| 395 | |
| 396 | /* Nonzero if frame F is a minibuffer-only frame. */ |
| 397 | #define FRAME_MINIBUF_ONLY_P(f) \ |
| 398 | EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f)) |
| 399 | |
| 400 | /* Nonzero if frame F contains a minibuffer window. |
| 401 | (If this is 0, F must use some other minibuffer window.) */ |
| 402 | #define FRAME_HAS_MINIBUF_P(f) ((f)->has_minibuffer) |
| 403 | #define FRAME_HEIGHT(f) (f)->height |
| 404 | |
| 405 | /* Width of frame F, measured in character columns, |
| 406 | not including scroll bars if any. */ |
| 407 | #define FRAME_WIDTH(f) (f)->width |
| 408 | |
| 409 | /* Number of lines of frame F used for menu bar. |
| 410 | This is relevant on terminal frames and on |
| 411 | X Windows when not using the X toolkit. |
| 412 | These lines are counted in FRAME_HEIGHT. */ |
| 413 | #define FRAME_MENU_BAR_LINES(f) (f)->menu_bar_lines |
| 414 | |
| 415 | /* Number of lines of frame F used for the tool-bar. */ |
| 416 | |
| 417 | #define FRAME_TOOL_BAR_LINES(f) (f)->tool_bar_lines |
| 418 | |
| 419 | /* Lines above the top-most window in frame F. */ |
| 420 | |
| 421 | #define FRAME_TOP_MARGIN(F) \ |
| 422 | (FRAME_MENU_BAR_LINES (F) + FRAME_TOOL_BAR_LINES (F)) |
| 423 | |
| 424 | /* Nonzero if this frame should display a menu bar |
| 425 | in a way that does not use any text lines. */ |
| 426 | #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) |
| 427 | #define FRAME_EXTERNAL_MENU_BAR(f) (f)->external_menu_bar |
| 428 | #else |
| 429 | #define FRAME_EXTERNAL_MENU_BAR(f) 0 |
| 430 | #endif |
| 431 | #define FRAME_VISIBLE_P(f) ((f)->visible != 0) |
| 432 | |
| 433 | /* Nonzero if frame F is currently visible but hidden. */ |
| 434 | #define FRAME_OBSCURED_P(f) ((f)->visible > 1) |
| 435 | |
| 436 | /* Nonzero if frame F is currently iconified. */ |
| 437 | #define FRAME_ICONIFIED_P(f) (f)->iconified |
| 438 | |
| 439 | #define FRAME_SET_VISIBLE(f,p) \ |
| 440 | ((f)->async_visible = (p), FRAME_SAMPLE_VISIBILITY (f)) |
| 441 | #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1, f->garbaged = 1) |
| 442 | #define FRAME_GARBAGED_P(f) (f)->garbaged |
| 443 | |
| 444 | /* Nonzero means do not allow splitting this frame's window. */ |
| 445 | #define FRAME_NO_SPLIT_P(f) (f)->no_split |
| 446 | |
| 447 | /* Not really implemented. */ |
| 448 | #define FRAME_WANTS_MODELINE_P(f) (f)->wants_modeline |
| 449 | |
| 450 | /* Nonzero if a size change has been requested for frame F |
| 451 | but not yet really put into effect. This can be true temporarily |
| 452 | when an X event comes in at a bad time. */ |
| 453 | #define FRAME_WINDOW_SIZES_CHANGED(f) (f)->window_sizes_changed |
| 454 | /* When a size change is pending, these are the requested new sizes. */ |
| 455 | #define FRAME_NEW_HEIGHT(f) (f)->new_height |
| 456 | #define FRAME_NEW_WIDTH(f) (f)->new_width |
| 457 | |
| 458 | /* The minibuffer window of frame F, if it has one; otherwise nil. */ |
| 459 | #define FRAME_MINIBUF_WINDOW(f) (f)->minibuffer_window |
| 460 | |
| 461 | /* The root window of the window tree of frame F. */ |
| 462 | #define FRAME_ROOT_WINDOW(f) (f)->root_window |
| 463 | |
| 464 | /* The currently selected window of the window tree of frame F. */ |
| 465 | #define FRAME_SELECTED_WINDOW(f) (f)->selected_window |
| 466 | |
| 467 | #define FRAME_INSERT_COST(f) (f)->insert_line_cost |
| 468 | #define FRAME_DELETE_COST(f) (f)->delete_line_cost |
| 469 | #define FRAME_INSERTN_COST(f) (f)->insert_n_lines_cost |
| 470 | #define FRAME_DELETEN_COST(f) (f)->delete_n_lines_cost |
| 471 | #define FRAME_MESSAGE_BUF(f) (f)->message_buf |
| 472 | #define FRAME_SCROLL_BOTTOM_VPOS(f) (f)->scroll_bottom_vpos |
| 473 | #define FRAME_FOCUS_FRAME(f) (f)->focus_frame |
| 474 | |
| 475 | /* Nonzero if frame F supports scroll bars. |
| 476 | If this is zero, then it is impossible to enable scroll bars |
| 477 | on frame F. */ |
| 478 | #define FRAME_CAN_HAVE_SCROLL_BARS(f) ((f)->can_have_scroll_bars) |
| 479 | |
| 480 | /* This frame slot says whether scroll bars are currently enabled for frame F, |
| 481 | and which side they are on. */ |
| 482 | #define FRAME_VERTICAL_SCROLL_BAR_TYPE(f) ((f)->vertical_scroll_bar_type) |
| 483 | #define FRAME_HAS_VERTICAL_SCROLL_BARS(f) \ |
| 484 | ((f)->vertical_scroll_bar_type != vertical_scroll_bar_none) |
| 485 | #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT(f) \ |
| 486 | ((f)->vertical_scroll_bar_type == vertical_scroll_bar_left) |
| 487 | #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT(f) \ |
| 488 | ((f)->vertical_scroll_bar_type == vertical_scroll_bar_right) |
| 489 | |
| 490 | /* Width that a scroll bar in frame F should have, if there is one. |
| 491 | Measured in pixels. |
| 492 | If scroll bars are turned off, this is still nonzero. */ |
| 493 | #define FRAME_SCROLL_BAR_PIXEL_WIDTH(f) ((f)->scroll_bar_pixel_width) |
| 494 | |
| 495 | /* Width that a scroll bar in frame F should have, if there is one. |
| 496 | Measured in columns (characters). |
| 497 | If scroll bars are turned off, this is still nonzero. */ |
| 498 | #define FRAME_SCROLL_BAR_COLS(f) ((f)->scroll_bar_cols) |
| 499 | |
| 500 | /* Width of a scroll bar in frame F, measured in columns (characters), |
| 501 | but only if scroll bars are on the left. |
| 502 | If scroll bars are on the right in this frame, it is 0. */ |
| 503 | #define FRAME_LEFT_SCROLL_BAR_WIDTH(f) \ |
| 504 | (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \ |
| 505 | ? FRAME_SCROLL_BAR_COLS (f) \ |
| 506 | : 0) |
| 507 | |
| 508 | /* Width of a scroll bar in frame F, measured in columns (characters). */ |
| 509 | #define FRAME_SCROLL_BAR_WIDTH(f) \ |
| 510 | (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \ |
| 511 | ? FRAME_SCROLL_BAR_COLS (f) \ |
| 512 | : 0) |
| 513 | |
| 514 | /* Total width of frame F, in columns (characters), |
| 515 | including the width used by scroll bars if any. */ |
| 516 | #define FRAME_WINDOW_WIDTH(f) ((f)->window_width) |
| 517 | |
| 518 | /* Set the width of frame F to VAL. |
| 519 | VAL is the width of a full-frame window, |
| 520 | not including scroll bars. */ |
| 521 | #define SET_FRAME_WIDTH(f, val) \ |
| 522 | ((f)->width = (val), \ |
| 523 | (f)->window_width = FRAME_WINDOW_WIDTH_ARG (f, (f)->width)) |
| 524 | |
| 525 | /* Given a value WIDTH for frame F's nominal width, |
| 526 | return the value that FRAME_WINDOW_WIDTH should have. */ |
| 527 | #define FRAME_WINDOW_WIDTH_ARG(f, width) \ |
| 528 | ((width) \ |
| 529 | + FRAME_SCROLL_BAR_WIDTH (f) \ |
| 530 | + FRAME_FLAGS_AREA_COLS (f)) |
| 531 | |
| 532 | /* Maximum + 1 legitimate value for FRAME_CURSOR_X. */ |
| 533 | #define FRAME_CURSOR_X_LIMIT(f) \ |
| 534 | (FRAME_WIDTH (f) + FRAME_LEFT_SCROLL_BAR_WIDTH (f)) |
| 535 | |
| 536 | /* Nonzero if frame F has scroll bars. */ |
| 537 | #define FRAME_SCROLL_BARS(f) ((f)->scroll_bars) |
| 538 | |
| 539 | #define FRAME_CONDEMNED_SCROLL_BARS(f) ((f)->condemned_scroll_bars) |
| 540 | #define FRAME_MENU_BAR_ITEMS(f) ((f)->menu_bar_items) |
| 541 | #define FRAME_COST_BAUD_RATE(f) ((f)->cost_calculation_baud_rate) |
| 542 | #define FRAME_FONTSET_DATA(f) ((f)->fontset_data) |
| 543 | |
| 544 | /* Return a pointer to the face cache of frame F. */ |
| 545 | |
| 546 | #define FRAME_FACE_CACHE(F) (F)->face_cache |
| 547 | |
| 548 | /* Return the size of message_buf of the frame F. We multiply the |
| 549 | width of the frame by 4 because multi-byte form may require at most |
| 550 | 4-byte for a character. */ |
| 551 | |
| 552 | #define FRAME_MESSAGE_BUF_SIZE(f) (((int) (f)->width) * 4) |
| 553 | |
| 554 | /* Emacs's redisplay code could become confused if a frame's |
| 555 | visibility changes at arbitrary times. For example, if a frame is |
| 556 | visible while the desired glyphs are being built, but becomes |
| 557 | invisible before they are updated, then some rows of the |
| 558 | desired_glyphs will be left marked as enabled after redisplay is |
| 559 | complete, which should never happen. The next time the frame |
| 560 | becomes visible, redisplay will probably barf. |
| 561 | |
| 562 | Currently, there are no similar situations involving iconified, but |
| 563 | the principle is the same. |
| 564 | |
| 565 | So instead of having asynchronous input handlers directly set and |
| 566 | clear the frame's visibility and iconification flags, they just set |
| 567 | the async_visible and async_iconified flags; the redisplay code |
| 568 | calls the FRAME_SAMPLE_VISIBILITY macro before doing any redisplay, |
| 569 | which sets visible and iconified from their asynchronous |
| 570 | counterparts. |
| 571 | |
| 572 | Synchronous code must use the FRAME_SET_VISIBLE macro. |
| 573 | |
| 574 | Also, if a frame used to be invisible, but has just become visible, |
| 575 | it must be marked as garbaged, since redisplay hasn't been keeping |
| 576 | up its contents. */ |
| 577 | |
| 578 | #define FRAME_SAMPLE_VISIBILITY(f) \ |
| 579 | (((f)->async_visible && (f)->visible != (f)->async_visible) ? \ |
| 580 | SET_FRAME_GARBAGED (f) : 0, \ |
| 581 | (f)->visible = (f)->async_visible, \ |
| 582 | (f)->iconified = (f)->async_iconified) |
| 583 | |
| 584 | #define CHECK_FRAME(x, i) \ |
| 585 | do { \ |
| 586 | if (! FRAMEP (x)) \ |
| 587 | x = wrong_type_argument (Qframep, (x)); \ |
| 588 | } while (0) |
| 589 | |
| 590 | #define CHECK_LIVE_FRAME(x, i) \ |
| 591 | do { \ |
| 592 | if (! FRAMEP (x) \ |
| 593 | || ! FRAME_LIVE_P (XFRAME (x))) \ |
| 594 | x = wrong_type_argument (Qframe_live_p, (x)); \ |
| 595 | } while (0) |
| 596 | |
| 597 | /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a |
| 598 | `for' loop which iterates over the elements of Vframe_list. The |
| 599 | loop will set FRAME_VAR, a Lisp_Object, to each frame in |
| 600 | Vframe_list in succession and execute the statement. LIST_VAR |
| 601 | should be a Lisp_Object too; it is used to iterate through the |
| 602 | Vframe_list. |
| 603 | |
| 604 | This macro is a holdover from a time when multiple frames weren't always |
| 605 | supported. An alternate definition of the macro would expand to |
| 606 | something which executes the statement once. */ |
| 607 | |
| 608 | #define FOR_EACH_FRAME(list_var, frame_var) \ |
| 609 | for ((list_var) = Vframe_list; \ |
| 610 | (CONSP (list_var) \ |
| 611 | && (frame_var = XCAR (list_var), 1)); \ |
| 612 | list_var = XCDR (list_var)) |
| 613 | |
| 614 | |
| 615 | extern Lisp_Object Qframep, Qframe_live_p, Qicon; |
| 616 | |
| 617 | extern struct frame *last_nonminibuf_frame; |
| 618 | |
| 619 | extern struct frame *make_terminal_frame P_ ((void)); |
| 620 | extern struct frame *make_frame P_ ((int)); |
| 621 | #ifdef HAVE_WINDOW_SYSTEM |
| 622 | extern struct frame *make_minibuffer_frame P_ ((void)); |
| 623 | extern struct frame *make_frame_without_minibuffer P_ ((Lisp_Object, |
| 624 | struct kboard *, |
| 625 | Lisp_Object)); |
| 626 | #endif /* HAVE_WINDOW_SYSTEM */ |
| 627 | extern int other_visible_frames P_ ((struct frame *)); |
| 628 | |
| 629 | extern Lisp_Object Vframe_list; |
| 630 | extern Lisp_Object Vdefault_frame_alist; |
| 631 | |
| 632 | extern Lisp_Object Vterminal_frame; |
| 633 | \f |
| 634 | /* Device-independent scroll bar stuff. */ |
| 635 | |
| 636 | /* Return the starting column (zero-based) of the vertical scroll bar |
| 637 | for window W. The column before this one is the last column we can |
| 638 | use for text. If the window touches the right edge of the frame, |
| 639 | we have extra space allocated for it. Otherwise, the scroll bar |
| 640 | takes over the window's rightmost columns. */ |
| 641 | |
| 642 | #define WINDOW_VERTICAL_SCROLL_BAR_COLUMN(w) \ |
| 643 | (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (XFRAME (WINDOW_FRAME (w))) ? \ |
| 644 | (((XINT ((w)->left) + XINT ((w)->width)) \ |
| 645 | < FRAME_WIDTH (XFRAME (WINDOW_FRAME (w)))) \ |
| 646 | ? (XINT ((w)->left) + XINT ((w)->width) \ |
| 647 | - FRAME_SCROLL_BAR_COLS (XFRAME (WINDOW_FRAME (w)))) \ |
| 648 | : FRAME_WIDTH (XFRAME (WINDOW_FRAME (w)))) \ |
| 649 | : XINT ((w)->left)) |
| 650 | |
| 651 | /* Return the height in lines of the vertical scroll bar in w. If the |
| 652 | window has a mode line, don't make the scroll bar extend that far. */ |
| 653 | |
| 654 | #define WINDOW_VERTICAL_SCROLL_BAR_HEIGHT(w) (window_internal_height (w)) |
| 655 | |
| 656 | /* The currently selected frame. */ |
| 657 | |
| 658 | extern Lisp_Object selected_frame; |
| 659 | |
| 660 | /* Value is a pointer to the selected frame. If the selected frame |
| 661 | isn't life, abort. */ |
| 662 | |
| 663 | #define SELECTED_FRAME() \ |
| 664 | ((FRAMEP (selected_frame) \ |
| 665 | && FRAME_LIVE_P (XFRAME (selected_frame))) \ |
| 666 | ? XFRAME (selected_frame) \ |
| 667 | : (struct frame *) (abort (), 0)) |
| 668 | |
| 669 | \f |
| 670 | /*********************************************************************** |
| 671 | Display-related Macros |
| 672 | ***********************************************************************/ |
| 673 | |
| 674 | /* Canonical y-unit on frame F. This value currently equals the line |
| 675 | height of the frame. Terminal specific header files are expected |
| 676 | to define the macro FRAME_LINE_HEIGHT. */ |
| 677 | |
| 678 | #define CANON_Y_UNIT(F) \ |
| 679 | (FRAME_WINDOW_P (F) ? FRAME_LINE_HEIGHT (F) : 1) |
| 680 | |
| 681 | /* Canonical x-unit on frame F. This is currently equal to the width |
| 682 | of the default font of F. Terminal specific headers are expected |
| 683 | to define the macro FRAME_DEFAULT_FONT_WIDTH. */ |
| 684 | |
| 685 | #define CANON_X_UNIT(F) \ |
| 686 | (FRAME_WINDOW_P (F) ? FRAME_DEFAULT_FONT_WIDTH (F) : 1) |
| 687 | |
| 688 | /* Pixel width of areas used to display truncation marks, continuation |
| 689 | marks, overlay arrows. This is 0 for terminal frames. */ |
| 690 | |
| 691 | #ifdef HAVE_WINDOW_SYSTEM |
| 692 | #define FRAME_FLAGS_AREA_COLS(F) \ |
| 693 | (FRAME_WINDOW_P ((F)) ? FRAME_X_FLAGS_AREA_COLS ((F)) : 0) |
| 694 | #define FRAME_FLAGS_AREA_WIDTH(F) FRAME_X_FLAGS_AREA_WIDTH (F) |
| 695 | #define FRAME_LEFT_FLAGS_AREA_WIDTH(F) FRAME_X_LEFT_FLAGS_AREA_WIDTH (F) |
| 696 | |
| 697 | #else |
| 698 | #define FRAME_FLAGS_AREA_WIDTH(F) 0 |
| 699 | #define FRAME_FLAGS_AREA_COLS(F) 0 |
| 700 | #define FRAME_LEFT_FLAGS_AREA_WIDTH(F) 0 |
| 701 | #endif |
| 702 | |
| 703 | |
| 704 | |
| 705 | \f |
| 706 | /*********************************************************************** |
| 707 | Conversion between canonical units and pixels |
| 708 | ***********************************************************************/ |
| 709 | |
| 710 | /* Canonical x-values are fractions of CANON_X_UNIT, canonical y-unit |
| 711 | are fractions of CANON_Y_UNIT of a frame. Both are represented as |
| 712 | Lisp numbers, i.e. integers or floats. */ |
| 713 | |
| 714 | /* Convert canonical value X to pixels. F is the frame whose |
| 715 | canonical char width is to be used. X must be a Lisp integer or |
| 716 | float. Value is a C integer. */ |
| 717 | |
| 718 | #define PIXEL_X_FROM_CANON_X(F, X) \ |
| 719 | (INTEGERP (X) \ |
| 720 | ? XINT (X) * CANON_X_UNIT (F) \ |
| 721 | : (int) (XFLOAT_DATA (X) * CANON_X_UNIT (F))) |
| 722 | |
| 723 | /* Convert canonical value Y to pixels. F is the frame whose |
| 724 | canonical character height is to be used. X must be a Lisp integer |
| 725 | or float. Value is a C integer. */ |
| 726 | |
| 727 | #define PIXEL_Y_FROM_CANON_Y(F, Y) \ |
| 728 | (INTEGERP (Y) \ |
| 729 | ? XINT (Y) * CANON_Y_UNIT (F) \ |
| 730 | : (int) (XFLOAT_DATA (Y) * CANON_Y_UNIT (F))) |
| 731 | |
| 732 | /* Convert pixel-value X to canonical units. F is the frame whose |
| 733 | canonical character width is to be used. X is a C integer. Result |
| 734 | is a Lisp float if X is not a multiple of the canon width, |
| 735 | otherwise it's a Lisp integer. */ |
| 736 | |
| 737 | #define CANON_X_FROM_PIXEL_X(F, X) \ |
| 738 | ((X) % CANON_X_UNIT (F) != 0 \ |
| 739 | ? make_float ((double) (X) / CANON_X_UNIT (F)) \ |
| 740 | : make_number ((X) / CANON_X_UNIT (F))) |
| 741 | |
| 742 | /* Convert pixel-value Y to canonical units. F is the frame whose |
| 743 | canonical character height is to be used. Y is a C integer. |
| 744 | Result is a Lisp float if Y is not a multiple of the canon width, |
| 745 | otherwise it's a Lisp integer. */ |
| 746 | |
| 747 | #define CANON_Y_FROM_PIXEL_Y(F, Y) \ |
| 748 | ((Y) % CANON_Y_UNIT (F) \ |
| 749 | ? make_float ((double) (Y) / CANON_Y_UNIT (F)) \ |
| 750 | : make_number ((Y) / CANON_Y_UNIT (F))) |
| 751 | |
| 752 | #endif /* not defined _FRAME_H_ */ |