| 1 | /* Window definitions for GNU Emacs. |
| 2 | Copyright (C) 1985-1986, 1993, 1995, 1997-2013 Free Software |
| 3 | Foundation, Inc. |
| 4 | |
| 5 | This file is part of GNU Emacs. |
| 6 | |
| 7 | GNU Emacs is free software: you can redistribute it and/or modify |
| 8 | it under the terms of the GNU General Public License as published by |
| 9 | the Free Software Foundation, either version 3 of the License, or |
| 10 | (at your option) any later version. |
| 11 | |
| 12 | GNU Emacs is distributed in the hope that it will be useful, |
| 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 15 | GNU General Public License for more details. |
| 16 | |
| 17 | You should have received a copy of the GNU General Public License |
| 18 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */ |
| 19 | |
| 20 | #ifndef WINDOW_H_INCLUDED |
| 21 | #define WINDOW_H_INCLUDED |
| 22 | |
| 23 | #include "dispextern.h" |
| 24 | |
| 25 | INLINE_HEADER_BEGIN |
| 26 | |
| 27 | /* Windows are allocated as if they were vectors, but then the |
| 28 | Lisp data type is changed to Lisp_Window. They are garbage |
| 29 | collected along with the vectors. |
| 30 | |
| 31 | All windows in use are arranged into a tree, with pointers up and down. |
| 32 | |
| 33 | Windows that are leaves of the tree are actually displayed |
| 34 | and show the contents of buffers. Windows that are not leaves |
| 35 | are used for representing the way groups of leaf windows are |
| 36 | arranged on the frame. Leaf windows never become non-leaves. |
| 37 | They are deleted only by calling delete-window on them (but |
| 38 | this can be done implicitly). Combination windows can be created |
| 39 | and deleted at any time. |
| 40 | |
| 41 | A leaf window has a buffer stored in contents field and markers in its start |
| 42 | and pointm fields. Non-leaf windows have nil in the latter two fields. |
| 43 | |
| 44 | Non-leaf windows are either vertical or horizontal combinations. |
| 45 | |
| 46 | A vertical combination window has children that are arranged on the frame |
| 47 | one above the next. Its contents field points to the uppermost child. |
| 48 | The parent field of each of the children points to the vertical |
| 49 | combination window. The next field of each child points to the |
| 50 | child below it, or is nil for the lowest child. The prev field |
| 51 | of each child points to the child above it, or is nil for the |
| 52 | highest child. |
| 53 | |
| 54 | A horizontal combination window has children that are side by side. |
| 55 | Its contents field points to the leftmost child. In each child |
| 56 | the next field points to the child to the right and the prev field |
| 57 | points to the child to the left. |
| 58 | |
| 59 | The children of a vertical combination window may be leaf windows |
| 60 | or horizontal combination windows. The children of a horizontal |
| 61 | combination window may be leaf windows or vertical combination windows. |
| 62 | |
| 63 | At the top of the tree are two windows which have nil as parent. |
| 64 | The second of these is minibuf_window. The first one manages all |
| 65 | the frame area that is not minibuffer, and is called the root window. |
| 66 | Different windows can be the root at different times; |
| 67 | initially the root window is a leaf window, but if more windows |
| 68 | are created then that leaf window ceases to be root and a newly |
| 69 | made combination window becomes root instead. |
| 70 | |
| 71 | In any case, on screens which have an ordinary window and a |
| 72 | minibuffer, prev of the minibuf window is the root window and next of |
| 73 | the root window is the minibuf window. On minibufferless screens or |
| 74 | minibuffer-only screens, the root window and the minibuffer window are |
| 75 | one and the same, so its prev and next members are nil. |
| 76 | |
| 77 | A dead window has its contents field set to nil. */ |
| 78 | |
| 79 | struct cursor_pos |
| 80 | { |
| 81 | /* Pixel position. These are always window relative. */ |
| 82 | int x, y; |
| 83 | |
| 84 | /* Glyph matrix position. */ |
| 85 | int hpos, vpos; |
| 86 | }; |
| 87 | |
| 88 | struct window |
| 89 | { |
| 90 | /* This is for Lisp; the terminal code does not refer to it. */ |
| 91 | struct vectorlike_header header; |
| 92 | |
| 93 | /* The frame this window is on. */ |
| 94 | Lisp_Object frame; |
| 95 | |
| 96 | /* Following (to right or down) and preceding (to left or up) child |
| 97 | at same level of tree. */ |
| 98 | Lisp_Object next; |
| 99 | Lisp_Object prev; |
| 100 | |
| 101 | /* The window this one is a child of. */ |
| 102 | Lisp_Object parent; |
| 103 | |
| 104 | /* The normal size of the window. These are fractions, but we do |
| 105 | not use C doubles to avoid creating new Lisp_Float objects while |
| 106 | interfacing Lisp in Fwindow_normal_size. */ |
| 107 | Lisp_Object normal_lines; |
| 108 | Lisp_Object normal_cols; |
| 109 | |
| 110 | /* New sizes of the window. Note that Lisp code may set new_normal |
| 111 | to something beyond an integer, so C int can't be used here. */ |
| 112 | Lisp_Object new_total; |
| 113 | Lisp_Object new_normal; |
| 114 | |
| 115 | /* May be buffer, window, or nil. */ |
| 116 | Lisp_Object contents; |
| 117 | |
| 118 | /* A marker pointing to where in the text to start displaying. |
| 119 | BIDI Note: This is the _logical-order_ start, i.e. the smallest |
| 120 | buffer position visible in the window, not necessarily the |
| 121 | character displayed in the top left corner of the window. */ |
| 122 | Lisp_Object start; |
| 123 | |
| 124 | /* A marker pointing to where in the text point is in this window, |
| 125 | used only when the window is not selected. |
| 126 | This exists so that when multiple windows show one buffer |
| 127 | each one can have its own value of point. */ |
| 128 | Lisp_Object pointm; |
| 129 | |
| 130 | /* No permanent meaning; used by save-window-excursion's |
| 131 | bookkeeping. */ |
| 132 | Lisp_Object temslot; |
| 133 | |
| 134 | /* This window's vertical scroll bar. This field is only for use |
| 135 | by the window-system-dependent code which implements the |
| 136 | scroll bars; it can store anything it likes here. If this |
| 137 | window is newly created and we haven't displayed a scroll bar in |
| 138 | it yet, or if the frame doesn't have any scroll bars, this is nil. */ |
| 139 | Lisp_Object vertical_scroll_bar; |
| 140 | |
| 141 | /* Type of vertical scroll bar. A value of nil means |
| 142 | no scroll bar. A value of t means use frame value. */ |
| 143 | Lisp_Object vertical_scroll_bar_type; |
| 144 | |
| 145 | /* Display-table to use for displaying chars in this window. |
| 146 | Nil means use the buffer's own display-table. */ |
| 147 | Lisp_Object display_table; |
| 148 | |
| 149 | /* Non-nil usually means window is marked as dedicated. |
| 150 | Note Lisp code may set this to something beyond Qnil |
| 151 | and Qt, so bitfield can't be used here. */ |
| 152 | Lisp_Object dedicated; |
| 153 | |
| 154 | /* If redisplay in this window goes beyond this buffer position, |
| 155 | must run the redisplay-end-trigger-hook. */ |
| 156 | Lisp_Object redisplay_end_trigger; |
| 157 | |
| 158 | /* t means this window's child windows are not (re-)combined. */ |
| 159 | Lisp_Object combination_limit; |
| 160 | |
| 161 | /* An alist with parameters. */ |
| 162 | Lisp_Object window_parameters; |
| 163 | |
| 164 | /* No Lisp data may follow below this point without changing |
| 165 | mark_object in alloc.c. The member current_matrix must be the |
| 166 | first non-Lisp member. */ |
| 167 | |
| 168 | /* Glyph matrices. */ |
| 169 | struct glyph_matrix *current_matrix; |
| 170 | struct glyph_matrix *desired_matrix; |
| 171 | |
| 172 | /* The two Lisp_Object fields below are marked in a special way, |
| 173 | which is why they're placed after `current_matrix'. */ |
| 174 | /* Alist of <buffer, window-start, window-point> triples listing |
| 175 | buffers previously shown in this window. */ |
| 176 | Lisp_Object prev_buffers; |
| 177 | /* List of buffers re-shown in this window. */ |
| 178 | Lisp_Object next_buffers; |
| 179 | |
| 180 | /* Number saying how recently window was selected. */ |
| 181 | int use_time; |
| 182 | |
| 183 | /* The upper left corner coordinates of this window, |
| 184 | relative to upper left corner of frame = 0, 0. */ |
| 185 | int left_col; |
| 186 | int top_line; |
| 187 | |
| 188 | /* The size of the window. */ |
| 189 | int total_lines; |
| 190 | int total_cols; |
| 191 | |
| 192 | /* Number of columns display within the window is scrolled to the left. */ |
| 193 | ptrdiff_t hscroll; |
| 194 | |
| 195 | /* Minimum hscroll for automatic hscrolling. This is the value |
| 196 | the user has set, by set-window-hscroll for example. */ |
| 197 | ptrdiff_t min_hscroll; |
| 198 | |
| 199 | /* Displayed buffer's text modification events counter as of last time |
| 200 | display completed. */ |
| 201 | EMACS_INT last_modified; |
| 202 | |
| 203 | /* Displayed buffer's overlays modification events counter as of last |
| 204 | complete update. */ |
| 205 | EMACS_INT last_overlay_modified; |
| 206 | |
| 207 | /* Value of point at that time. Since this is a position in a buffer, |
| 208 | it should be positive. */ |
| 209 | ptrdiff_t last_point; |
| 210 | |
| 211 | /* Line number and position of a line somewhere above the top of the |
| 212 | screen. If this field is zero, it means we don't have a base line. */ |
| 213 | ptrdiff_t base_line_number; |
| 214 | |
| 215 | /* If this field is zero, it means we don't have a base line. |
| 216 | If it is -1, it means don't display the line number as long |
| 217 | as the window shows its buffer. */ |
| 218 | ptrdiff_t base_line_pos; |
| 219 | |
| 220 | /* The column number currently displayed in this window's mode |
| 221 | line, or -1 if column numbers are not being displayed. */ |
| 222 | ptrdiff_t column_number_displayed; |
| 223 | |
| 224 | /* Scaling factor for the glyph_matrix size calculation in this window. |
| 225 | Used if window contains many small images or uses proportional fonts, |
| 226 | as the normal may yield a matrix which is too small. */ |
| 227 | int nrows_scale_factor, ncols_scale_factor; |
| 228 | |
| 229 | /* Intended cursor position. This is a position within the |
| 230 | glyph matrix. */ |
| 231 | struct cursor_pos cursor; |
| 232 | |
| 233 | /* Where the cursor actually is. */ |
| 234 | struct cursor_pos phys_cursor; |
| 235 | |
| 236 | /* Internally used for redisplay purposes. */ |
| 237 | struct cursor_pos output_cursor; |
| 238 | |
| 239 | /* Vertical cursor position as of last update that completed |
| 240 | without pause. This is the position of last_point. */ |
| 241 | int last_cursor_vpos; |
| 242 | |
| 243 | /* Cursor type and width of last cursor drawn on the window. |
| 244 | Used for X and w32 frames; -1 initially. */ |
| 245 | int phys_cursor_type, phys_cursor_width; |
| 246 | |
| 247 | /* This is handy for undrawing the cursor. */ |
| 248 | int phys_cursor_ascent, phys_cursor_height; |
| 249 | |
| 250 | /* Width of left and right fringes, in pixels. |
| 251 | A value of -1 means use frame values. */ |
| 252 | int left_fringe_width; |
| 253 | int right_fringe_width; |
| 254 | |
| 255 | /* Width of left and right marginal areas in columns. |
| 256 | A value of 0 means no margin. */ |
| 257 | int left_margin_cols; |
| 258 | int right_margin_cols; |
| 259 | |
| 260 | /* Pixel width of scroll bars. |
| 261 | A value of -1 means use frame values. */ |
| 262 | int scroll_bar_width; |
| 263 | |
| 264 | /* Effective height of the mode line, or -1 if not known. */ |
| 265 | int mode_line_height; |
| 266 | |
| 267 | /* Effective height of the header line, or -1 if not known. */ |
| 268 | int header_line_height; |
| 269 | |
| 270 | /* Z - the buffer position of the last glyph in the current |
| 271 | matrix of W. Only valid if window_end_valid is nonzero. */ |
| 272 | ptrdiff_t window_end_pos; |
| 273 | |
| 274 | /* Glyph matrix row of the last glyph in the current matrix |
| 275 | of W. Only valid if window_end_valid is nonzero. */ |
| 276 | int window_end_vpos; |
| 277 | |
| 278 | /* Non-zero if this window is a minibuffer window. */ |
| 279 | unsigned mini : 1; |
| 280 | |
| 281 | /* Meaningful only if contents is a window, non-zero if this |
| 282 | internal window is used in horizontal combination. */ |
| 283 | unsigned horizontal : 1; |
| 284 | |
| 285 | /* Non-zero means must regenerate mode line of this window. */ |
| 286 | unsigned update_mode_line : 1; |
| 287 | |
| 288 | /* Non-nil if the buffer was "modified" when the window |
| 289 | was last updated. */ |
| 290 | unsigned last_had_star : 1; |
| 291 | |
| 292 | /* Non-zero means current value of `start' |
| 293 | was the beginning of a line when it was chosen. */ |
| 294 | unsigned start_at_line_beg : 1; |
| 295 | |
| 296 | /* Non-zero means next redisplay must use the value of start |
| 297 | set up for it in advance. Set by scrolling commands. */ |
| 298 | unsigned force_start : 1; |
| 299 | |
| 300 | /* Non-zero means we have explicitly changed the value of start, |
| 301 | but that the next redisplay is not obliged to use the new value. |
| 302 | This is used in Fdelete_other_windows to force a call to |
| 303 | Vwindow_scroll_functions; also by Frecenter with argument. */ |
| 304 | unsigned optional_new_start : 1; |
| 305 | |
| 306 | /* Non-zero means the cursor is currently displayed. This can be |
| 307 | set to zero by functions overpainting the cursor image. */ |
| 308 | unsigned phys_cursor_on_p : 1; |
| 309 | |
| 310 | /* 0 means cursor is logically on, 1 means it's off. Used for |
| 311 | blinking cursor. */ |
| 312 | unsigned cursor_off_p : 1; |
| 313 | |
| 314 | /* Value of cursor_off_p as of the last redisplay. */ |
| 315 | unsigned last_cursor_off_p : 1; |
| 316 | |
| 317 | /* 1 means desired matrix has been build and window must be |
| 318 | updated in update_frame. */ |
| 319 | unsigned must_be_updated_p : 1; |
| 320 | |
| 321 | /* Flag indicating that this window is not a real one. |
| 322 | Currently only used for menu bar windows of frames. */ |
| 323 | unsigned pseudo_window_p : 1; |
| 324 | |
| 325 | /* Non-zero means fringes are drawn outside display margins. |
| 326 | Otherwise draw them between margin areas and text. */ |
| 327 | unsigned fringes_outside_margins : 1; |
| 328 | |
| 329 | /* Nonzero if window_end_pos and window_end_vpos are truly valid. |
| 330 | This is zero if nontrivial redisplay is preempted since in that case |
| 331 | the frame image that window_end_pos did not get onto the frame. */ |
| 332 | unsigned window_end_valid : 1; |
| 333 | |
| 334 | /* Amount by which lines of this window are scrolled in |
| 335 | y-direction (smooth scrolling). */ |
| 336 | int vscroll; |
| 337 | |
| 338 | /* If we have highlighted the region (or any part of it), the mark |
| 339 | (region start) position; otherwise zero. */ |
| 340 | ptrdiff_t region_showing; |
| 341 | |
| 342 | /* Z_BYTE - buffer position of the last glyph in the current matrix of W. |
| 343 | Should be nonnegative, and only valid if window_end_valid is nonzero. */ |
| 344 | ptrdiff_t window_end_bytepos; |
| 345 | }; |
| 346 | |
| 347 | /* Most code should use these functions to set Lisp fields in struct |
| 348 | window. */ |
| 349 | INLINE void |
| 350 | wset_frame (struct window *w, Lisp_Object val) |
| 351 | { |
| 352 | w->frame = val; |
| 353 | } |
| 354 | INLINE void |
| 355 | wset_next (struct window *w, Lisp_Object val) |
| 356 | { |
| 357 | w->next = val; |
| 358 | } |
| 359 | INLINE void |
| 360 | wset_prev (struct window *w, Lisp_Object val) |
| 361 | { |
| 362 | w->prev = val; |
| 363 | } |
| 364 | INLINE void |
| 365 | wset_redisplay_end_trigger (struct window *w, Lisp_Object val) |
| 366 | { |
| 367 | w->redisplay_end_trigger = val; |
| 368 | } |
| 369 | INLINE void |
| 370 | wset_vertical_scroll_bar (struct window *w, Lisp_Object val) |
| 371 | { |
| 372 | w->vertical_scroll_bar = val; |
| 373 | } |
| 374 | INLINE void |
| 375 | wset_prev_buffers (struct window *w, Lisp_Object val) |
| 376 | { |
| 377 | w->prev_buffers = val; |
| 378 | } |
| 379 | INLINE void |
| 380 | wset_next_buffers (struct window *w, Lisp_Object val) |
| 381 | { |
| 382 | w->next_buffers = val; |
| 383 | } |
| 384 | |
| 385 | /* 1 if W is a minibuffer window. */ |
| 386 | |
| 387 | #define MINI_WINDOW_P(W) ((W)->mini) |
| 388 | |
| 389 | /* General window layout: |
| 390 | |
| 391 | LEFT_EDGE_COL RIGHT_EDGE_COL |
| 392 | | | |
| 393 | | | |
| 394 | | BOX_LEFT_EDGE_COL | |
| 395 | | | BOX_RIGHT_EDGE_COL | |
| 396 | | | | | |
| 397 | v v v v |
| 398 | <-><-><---><-----------><---><-><-> |
| 399 | ^ ^ ^ ^ ^ ^ ^ |
| 400 | | | | | | | | |
| 401 | | | | | | | +-- RIGHT_SCROLL_BAR_COLS |
| 402 | | | | | | +----- RIGHT_FRINGE_WIDTH |
| 403 | | | | | +--------- RIGHT_MARGIN_COLS |
| 404 | | | | | |
| 405 | | | | +------------------ TEXT_AREA_COLS |
| 406 | | | | |
| 407 | | | +--------------------------- LEFT_MARGIN_COLS |
| 408 | | +------------------------------- LEFT_FRINGE_WIDTH |
| 409 | +---------------------------------- LEFT_SCROLL_BAR_COLS |
| 410 | |
| 411 | */ |
| 412 | |
| 413 | |
| 414 | /* A handy macro. */ |
| 415 | |
| 416 | /* Non-zero if W is leaf (carry the buffer). */ |
| 417 | |
| 418 | #define WINDOW_LEAF_P(W) \ |
| 419 | (BUFFERP ((W)->contents)) |
| 420 | |
| 421 | /* Non-zero if W is a member of horizontal combination. */ |
| 422 | |
| 423 | #define WINDOW_HORIZONTAL_COMBINATION_P(W) \ |
| 424 | (WINDOWP ((W)->contents) && (W)->horizontal) |
| 425 | |
| 426 | /* Non-zero if W is a member of vertical combination. */ |
| 427 | |
| 428 | #define WINDOW_VERTICAL_COMBINATION_P(W) \ |
| 429 | (WINDOWP ((W)->contents) && !(W)->horizontal) |
| 430 | |
| 431 | #define WINDOW_XFRAME(W) \ |
| 432 | (XFRAME (WINDOW_FRAME ((W)))) |
| 433 | |
| 434 | /* Return the canonical column width of the frame of window W. */ |
| 435 | |
| 436 | #define WINDOW_FRAME_COLUMN_WIDTH(W) \ |
| 437 | (FRAME_COLUMN_WIDTH (WINDOW_XFRAME ((W)))) |
| 438 | |
| 439 | /* Return the canonical column width of the frame of window W. */ |
| 440 | |
| 441 | #define WINDOW_FRAME_LINE_HEIGHT(W) \ |
| 442 | (FRAME_LINE_HEIGHT (WINDOW_XFRAME ((W)))) |
| 443 | |
| 444 | /* Return the width of window W in canonical column units. |
| 445 | This includes scroll bars and fringes. */ |
| 446 | |
| 447 | #define WINDOW_TOTAL_COLS(W) (W)->total_cols |
| 448 | |
| 449 | /* Return the height of window W in canonical line units. |
| 450 | This includes header and mode lines, if any. */ |
| 451 | |
| 452 | #define WINDOW_TOTAL_LINES(W) (W)->total_lines |
| 453 | |
| 454 | /* Return the total pixel width of window W. */ |
| 455 | |
| 456 | #define WINDOW_TOTAL_WIDTH(W) \ |
| 457 | (WINDOW_TOTAL_COLS (W) * WINDOW_FRAME_COLUMN_WIDTH (W)) |
| 458 | |
| 459 | /* Return the total pixel height of window W. */ |
| 460 | |
| 461 | #define WINDOW_TOTAL_HEIGHT(W) \ |
| 462 | (WINDOW_TOTAL_LINES (W) * WINDOW_FRAME_LINE_HEIGHT (W)) |
| 463 | |
| 464 | /* For HORFLAG non-zero the total number of columns of window W. Otherwise |
| 465 | the total number of lines of W. */ |
| 466 | |
| 467 | #define WINDOW_TOTAL_SIZE(w, horflag) \ |
| 468 | (horflag ? WINDOW_TOTAL_COLS (w) : WINDOW_TOTAL_LINES (w)) |
| 469 | |
| 470 | /* The smallest acceptable dimensions for a window. Anything smaller |
| 471 | might crash Emacs. */ |
| 472 | |
| 473 | #define MIN_SAFE_WINDOW_WIDTH (2) |
| 474 | #define MIN_SAFE_WINDOW_HEIGHT (1) |
| 475 | |
| 476 | /* Return the canonical frame column at which window W starts. |
| 477 | This includes a left-hand scroll bar, if any. */ |
| 478 | |
| 479 | #define WINDOW_LEFT_EDGE_COL(W) (W)->left_col |
| 480 | |
| 481 | /* Return the canonical frame column before which window W ends. |
| 482 | This includes a right-hand scroll bar, if any. */ |
| 483 | |
| 484 | #define WINDOW_RIGHT_EDGE_COL(W) \ |
| 485 | (WINDOW_LEFT_EDGE_COL (W) + WINDOW_TOTAL_COLS (W)) |
| 486 | |
| 487 | /* Return the canonical frame line at which window W starts. |
| 488 | This includes a header line, if any. */ |
| 489 | |
| 490 | #define WINDOW_TOP_EDGE_LINE(W) (W)->top_line |
| 491 | |
| 492 | /* Return the canonical frame line before which window W ends. |
| 493 | This includes a mode line, if any. */ |
| 494 | |
| 495 | #define WINDOW_BOTTOM_EDGE_LINE(W) \ |
| 496 | (WINDOW_TOP_EDGE_LINE (W) + WINDOW_TOTAL_LINES (W)) |
| 497 | |
| 498 | |
| 499 | /* Return the frame x-position at which window W starts. |
| 500 | This includes a left-hand scroll bar, if any. */ |
| 501 | |
| 502 | #define WINDOW_LEFT_EDGE_X(W) \ |
| 503 | (FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W)) \ |
| 504 | + WINDOW_LEFT_EDGE_COL (W) * WINDOW_FRAME_COLUMN_WIDTH (W)) |
| 505 | |
| 506 | /* Return the frame x- position before which window W ends. |
| 507 | This includes a right-hand scroll bar, if any. */ |
| 508 | |
| 509 | #define WINDOW_RIGHT_EDGE_X(W) \ |
| 510 | (FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W)) \ |
| 511 | + WINDOW_RIGHT_EDGE_COL (W) * WINDOW_FRAME_COLUMN_WIDTH (W)) |
| 512 | |
| 513 | /* 1 if W is a menu bar window. */ |
| 514 | |
| 515 | #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) |
| 516 | #define WINDOW_MENU_BAR_P(W) \ |
| 517 | (WINDOWP (WINDOW_XFRAME (W)->menu_bar_window) \ |
| 518 | && (W) == XWINDOW (WINDOW_XFRAME (W)->menu_bar_window)) |
| 519 | #else |
| 520 | /* No menu bar windows if X toolkit is in use. */ |
| 521 | #define WINDOW_MENU_BAR_P(W) (0) |
| 522 | #endif |
| 523 | |
| 524 | /* 1 if W is a tool bar window. */ |
| 525 | #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS) |
| 526 | #define WINDOW_TOOL_BAR_P(W) \ |
| 527 | (WINDOWP (WINDOW_XFRAME (W)->tool_bar_window) \ |
| 528 | && (W) == XWINDOW (WINDOW_XFRAME (W)->tool_bar_window)) |
| 529 | #else |
| 530 | #define WINDOW_TOOL_BAR_P(W) (0) |
| 531 | #endif |
| 532 | |
| 533 | /* Return the frame y-position at which window W starts. |
| 534 | This includes a header line, if any. */ |
| 535 | |
| 536 | #define WINDOW_TOP_EDGE_Y(W) \ |
| 537 | (((WINDOW_MENU_BAR_P (W) || WINDOW_TOOL_BAR_P (W)) \ |
| 538 | ? 0 : FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W))) \ |
| 539 | + WINDOW_TOP_EDGE_LINE (W) * WINDOW_FRAME_LINE_HEIGHT (W)) |
| 540 | |
| 541 | /* Return the frame y-position before which window W ends. |
| 542 | This includes a mode line, if any. */ |
| 543 | |
| 544 | #define WINDOW_BOTTOM_EDGE_Y(W) \ |
| 545 | (((WINDOW_MENU_BAR_P (W) || WINDOW_TOOL_BAR_P (W)) \ |
| 546 | ? 0 : FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W))) \ |
| 547 | + WINDOW_BOTTOM_EDGE_LINE (W) * WINDOW_FRAME_LINE_HEIGHT (W)) |
| 548 | |
| 549 | |
| 550 | /* 1 if window W takes up the full width of its frame. */ |
| 551 | |
| 552 | #define WINDOW_FULL_WIDTH_P(W) \ |
| 553 | (WINDOW_TOTAL_COLS (W) == FRAME_TOTAL_COLS (WINDOW_XFRAME (W))) |
| 554 | |
| 555 | /* 1 if window W's has no other windows to its left in its frame. */ |
| 556 | |
| 557 | #define WINDOW_LEFTMOST_P(W) \ |
| 558 | (WINDOW_LEFT_EDGE_COL (W) == 0) |
| 559 | |
| 560 | /* 1 if window W's has no other windows to its right in its frame. */ |
| 561 | |
| 562 | #define WINDOW_RIGHTMOST_P(W) \ |
| 563 | (WINDOW_RIGHT_EDGE_COL (W) == FRAME_TOTAL_COLS (WINDOW_XFRAME (W))) |
| 564 | |
| 565 | |
| 566 | /* Return the frame column at which the text (or left fringe) in |
| 567 | window W starts. This is different from the `LEFT_EDGE' because it |
| 568 | does not include a left-hand scroll bar if any. */ |
| 569 | |
| 570 | #define WINDOW_BOX_LEFT_EDGE_COL(W) \ |
| 571 | (WINDOW_LEFT_EDGE_COL (W) \ |
| 572 | + WINDOW_LEFT_SCROLL_BAR_COLS (W)) |
| 573 | |
| 574 | /* Return the window column before which the text in window W ends. |
| 575 | This is different from WINDOW_RIGHT_EDGE_COL because it does not |
| 576 | include a scroll bar or window-separating line on the right edge. */ |
| 577 | |
| 578 | #define WINDOW_BOX_RIGHT_EDGE_COL(W) \ |
| 579 | (WINDOW_RIGHT_EDGE_COL (W) \ |
| 580 | - WINDOW_RIGHT_SCROLL_BAR_COLS (W)) |
| 581 | |
| 582 | |
| 583 | /* Return the frame position at which the text (or left fringe) in |
| 584 | window W starts. This is different from the `LEFT_EDGE' because it |
| 585 | does not include a left-hand scroll bar if any. */ |
| 586 | |
| 587 | #define WINDOW_BOX_LEFT_EDGE_X(W) \ |
| 588 | (FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W)) \ |
| 589 | + WINDOW_BOX_LEFT_EDGE_COL (W) * WINDOW_FRAME_COLUMN_WIDTH (W)) |
| 590 | |
| 591 | /* Return the window column before which the text in window W ends. |
| 592 | This is different from WINDOW_RIGHT_EDGE_COL because it does not |
| 593 | include a scroll bar or window-separating line on the right edge. */ |
| 594 | |
| 595 | #define WINDOW_BOX_RIGHT_EDGE_X(W) \ |
| 596 | (FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W)) \ |
| 597 | + WINDOW_BOX_RIGHT_EDGE_COL (W) * WINDOW_FRAME_COLUMN_WIDTH (W)) |
| 598 | |
| 599 | |
| 600 | /* Width of left margin area in columns. */ |
| 601 | |
| 602 | #define WINDOW_LEFT_MARGIN_COLS(W) (W->left_margin_cols) |
| 603 | |
| 604 | /* Width of right marginal area in columns. */ |
| 605 | |
| 606 | #define WINDOW_RIGHT_MARGIN_COLS(W) (W->right_margin_cols) |
| 607 | |
| 608 | /* Width of left margin area in pixels. */ |
| 609 | |
| 610 | #define WINDOW_LEFT_MARGIN_WIDTH(W) \ |
| 611 | (W->left_margin_cols * WINDOW_FRAME_COLUMN_WIDTH (W)) |
| 612 | |
| 613 | /* Width of right marginal area in pixels. */ |
| 614 | |
| 615 | #define WINDOW_RIGHT_MARGIN_WIDTH(W) \ |
| 616 | (W->right_margin_cols * WINDOW_FRAME_COLUMN_WIDTH (W)) |
| 617 | |
| 618 | /* Total width of fringes reserved for drawing truncation bitmaps, |
| 619 | continuation bitmaps and alike. The width is in canonical char |
| 620 | units of the frame. This must currently be the case because window |
| 621 | sizes aren't pixel values. If it weren't the case, we wouldn't be |
| 622 | able to split windows horizontally nicely. */ |
| 623 | |
| 624 | #define WINDOW_FRINGE_COLS(W) \ |
| 625 | ((W->left_fringe_width >= 0 \ |
| 626 | && W->right_fringe_width >= 0) \ |
| 627 | ? ((W->left_fringe_width \ |
| 628 | + W->right_fringe_width \ |
| 629 | + WINDOW_FRAME_COLUMN_WIDTH (W) - 1) \ |
| 630 | / WINDOW_FRAME_COLUMN_WIDTH (W)) \ |
| 631 | : FRAME_FRINGE_COLS (WINDOW_XFRAME (W))) |
| 632 | |
| 633 | /* Column-width of the left and right fringe. */ |
| 634 | |
| 635 | #define WINDOW_LEFT_FRINGE_COLS(W) \ |
| 636 | ((WINDOW_LEFT_FRINGE_WIDTH ((W)) \ |
| 637 | + WINDOW_FRAME_COLUMN_WIDTH (W) - 1) \ |
| 638 | / WINDOW_FRAME_COLUMN_WIDTH (W)) |
| 639 | |
| 640 | #define WINDOW_RIGHT_FRINGE_COLS(W) \ |
| 641 | ((WINDOW_RIGHT_FRINGE_WIDTH ((W)) \ |
| 642 | + WINDOW_FRAME_COLUMN_WIDTH (W) - 1) \ |
| 643 | / WINDOW_FRAME_COLUMN_WIDTH (W)) |
| 644 | |
| 645 | /* Pixel-width of the left and right fringe. */ |
| 646 | |
| 647 | #define WINDOW_LEFT_FRINGE_WIDTH(W) \ |
| 648 | (W->left_fringe_width >= 0 ? W->left_fringe_width \ |
| 649 | : FRAME_LEFT_FRINGE_WIDTH (WINDOW_XFRAME (W))) |
| 650 | |
| 651 | #define WINDOW_RIGHT_FRINGE_WIDTH(W) \ |
| 652 | (W->right_fringe_width >= 0 ? W->right_fringe_width \ |
| 653 | : FRAME_RIGHT_FRINGE_WIDTH (WINDOW_XFRAME (W))) |
| 654 | |
| 655 | /* Total width of fringes in pixels. */ |
| 656 | |
| 657 | #define WINDOW_TOTAL_FRINGE_WIDTH(W) \ |
| 658 | (WINDOW_LEFT_FRINGE_WIDTH (W) + WINDOW_RIGHT_FRINGE_WIDTH (W)) |
| 659 | |
| 660 | /* Are fringes outside display margins in window W. */ |
| 661 | |
| 662 | #define WINDOW_HAS_FRINGES_OUTSIDE_MARGINS(W) \ |
| 663 | ((W)->fringes_outside_margins) |
| 664 | |
| 665 | /* Say whether scroll bars are currently enabled for window W, |
| 666 | and which side they are on. */ |
| 667 | |
| 668 | #define WINDOW_VERTICAL_SCROLL_BAR_TYPE(w) \ |
| 669 | (EQ (w->vertical_scroll_bar_type, Qt) \ |
| 670 | ? FRAME_VERTICAL_SCROLL_BAR_TYPE (WINDOW_XFRAME (w)) \ |
| 671 | : EQ (w->vertical_scroll_bar_type, Qleft) \ |
| 672 | ? vertical_scroll_bar_left \ |
| 673 | : EQ (w->vertical_scroll_bar_type, Qright) \ |
| 674 | ? vertical_scroll_bar_right \ |
| 675 | : vertical_scroll_bar_none) \ |
| 676 | |
| 677 | #define WINDOW_HAS_VERTICAL_SCROLL_BAR(w) \ |
| 678 | (EQ (w->vertical_scroll_bar_type, Qt) \ |
| 679 | ? FRAME_HAS_VERTICAL_SCROLL_BARS (WINDOW_XFRAME (w)) \ |
| 680 | : !NILP (w->vertical_scroll_bar_type)) |
| 681 | |
| 682 | #define WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT(w) \ |
| 683 | (EQ (w->vertical_scroll_bar_type, Qt) \ |
| 684 | ? FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (WINDOW_XFRAME (w)) \ |
| 685 | : EQ (w->vertical_scroll_bar_type, Qleft)) |
| 686 | |
| 687 | #define WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT(w) \ |
| 688 | (EQ (w->vertical_scroll_bar_type, Qt) \ |
| 689 | ? FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (WINDOW_XFRAME (w)) \ |
| 690 | : EQ (w->vertical_scroll_bar_type, Qright)) |
| 691 | |
| 692 | /* Width that a scroll bar in window W should have, if there is one. |
| 693 | Measured in pixels. If scroll bars are turned off, this is still |
| 694 | nonzero. */ |
| 695 | |
| 696 | #define WINDOW_CONFIG_SCROLL_BAR_WIDTH(w) \ |
| 697 | (w->scroll_bar_width >= 0 ? w->scroll_bar_width \ |
| 698 | : FRAME_CONFIG_SCROLL_BAR_WIDTH (WINDOW_XFRAME (w))) |
| 699 | |
| 700 | /* Width that a scroll bar in window W should have, if there is one. |
| 701 | Measured in columns (characters). If scroll bars are turned off, |
| 702 | this is still nonzero. */ |
| 703 | |
| 704 | #define WINDOW_CONFIG_SCROLL_BAR_COLS(w) \ |
| 705 | (w->scroll_bar_width >= 0 \ |
| 706 | ? ((w->scroll_bar_width \ |
| 707 | + WINDOW_FRAME_COLUMN_WIDTH (w) - 1) \ |
| 708 | / WINDOW_FRAME_COLUMN_WIDTH (w)) \ |
| 709 | : FRAME_CONFIG_SCROLL_BAR_COLS (WINDOW_XFRAME (w))) |
| 710 | |
| 711 | /* Width of a scroll bar in window W, measured in columns (characters), |
| 712 | but only if scroll bars are on the left. If scroll bars are on |
| 713 | the right in this frame, or there are no scroll bars, value is 0. */ |
| 714 | |
| 715 | #define WINDOW_LEFT_SCROLL_BAR_COLS(w) \ |
| 716 | (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w) \ |
| 717 | ? (WINDOW_CONFIG_SCROLL_BAR_COLS (w)) \ |
| 718 | : 0) |
| 719 | |
| 720 | /* Width of a left scroll bar area in window W , measured in pixels. */ |
| 721 | |
| 722 | #define WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH(w) \ |
| 723 | (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w) \ |
| 724 | ? (WINDOW_CONFIG_SCROLL_BAR_COLS (w) * WINDOW_FRAME_COLUMN_WIDTH (w)) \ |
| 725 | : 0) |
| 726 | |
| 727 | /* Width of a scroll bar in window W, measured in columns (characters), |
| 728 | but only if scroll bars are on the right. If scroll bars are on |
| 729 | the left in this frame, or there are no scroll bars, value is 0. */ |
| 730 | |
| 731 | #define WINDOW_RIGHT_SCROLL_BAR_COLS(w) \ |
| 732 | (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w) \ |
| 733 | ? WINDOW_CONFIG_SCROLL_BAR_COLS (w) \ |
| 734 | : 0) |
| 735 | |
| 736 | /* Width of a left scroll bar area in window W , measured in pixels. */ |
| 737 | |
| 738 | #define WINDOW_RIGHT_SCROLL_BAR_AREA_WIDTH(w) \ |
| 739 | (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w) \ |
| 740 | ? (WINDOW_CONFIG_SCROLL_BAR_COLS (w) * WINDOW_FRAME_COLUMN_WIDTH (w)) \ |
| 741 | : 0) |
| 742 | |
| 743 | |
| 744 | /* Actual width of a scroll bar in window W, measured in columns. */ |
| 745 | |
| 746 | #define WINDOW_SCROLL_BAR_COLS(w) \ |
| 747 | (WINDOW_HAS_VERTICAL_SCROLL_BAR (w) \ |
| 748 | ? WINDOW_CONFIG_SCROLL_BAR_COLS (w) \ |
| 749 | : 0) |
| 750 | |
| 751 | /* Width of a left scroll bar area in window W , measured in pixels. */ |
| 752 | |
| 753 | #define WINDOW_SCROLL_BAR_AREA_WIDTH(w) \ |
| 754 | (WINDOW_HAS_VERTICAL_SCROLL_BAR (w) \ |
| 755 | ? (WINDOW_CONFIG_SCROLL_BAR_COLS (w) * WINDOW_FRAME_COLUMN_WIDTH (w)) \ |
| 756 | : 0) |
| 757 | |
| 758 | |
| 759 | /* Return the frame position where the scroll bar of window W starts. */ |
| 760 | |
| 761 | #define WINDOW_SCROLL_BAR_AREA_X(W) \ |
| 762 | (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (W) \ |
| 763 | ? WINDOW_BOX_RIGHT_EDGE_X (W) \ |
| 764 | : WINDOW_LEFT_EDGE_X (W)) |
| 765 | |
| 766 | |
| 767 | /* Height in pixels, and in lines, of the mode line. |
| 768 | May be zero if W doesn't have a mode line. */ |
| 769 | |
| 770 | #define WINDOW_MODE_LINE_HEIGHT(W) \ |
| 771 | (WINDOW_WANTS_MODELINE_P ((W)) \ |
| 772 | ? CURRENT_MODE_LINE_HEIGHT (W) \ |
| 773 | : 0) |
| 774 | |
| 775 | #define WINDOW_MODE_LINE_LINES(W) \ |
| 776 | (!! WINDOW_WANTS_MODELINE_P ((W))) |
| 777 | |
| 778 | /* Height in pixels, and in lines, of the header line. |
| 779 | Zero if W doesn't have a header line. */ |
| 780 | |
| 781 | #define WINDOW_HEADER_LINE_HEIGHT(W) \ |
| 782 | (WINDOW_WANTS_HEADER_LINE_P ((W)) \ |
| 783 | ? CURRENT_HEADER_LINE_HEIGHT (W) \ |
| 784 | : 0) |
| 785 | |
| 786 | #define WINDOW_HEADER_LINE_LINES(W) \ |
| 787 | (!! WINDOW_WANTS_HEADER_LINE_P ((W))) |
| 788 | |
| 789 | /* Pixel height of window W without mode line. */ |
| 790 | |
| 791 | #define WINDOW_BOX_HEIGHT_NO_MODE_LINE(W) \ |
| 792 | (WINDOW_TOTAL_HEIGHT ((W)) \ |
| 793 | - WINDOW_MODE_LINE_HEIGHT ((W))) |
| 794 | |
| 795 | /* Pixel height of window W without mode and header line. */ |
| 796 | |
| 797 | #define WINDOW_BOX_TEXT_HEIGHT(W) \ |
| 798 | (WINDOW_TOTAL_HEIGHT ((W)) \ |
| 799 | - WINDOW_MODE_LINE_HEIGHT ((W)) \ |
| 800 | - WINDOW_HEADER_LINE_HEIGHT ((W))) |
| 801 | |
| 802 | |
| 803 | /* Convert window W relative pixel X to frame pixel coordinates. */ |
| 804 | |
| 805 | #define WINDOW_TO_FRAME_PIXEL_X(W, X) \ |
| 806 | ((X) + WINDOW_BOX_LEFT_EDGE_X ((W))) |
| 807 | |
| 808 | /* Convert window W relative pixel Y to frame pixel coordinates. */ |
| 809 | |
| 810 | #define WINDOW_TO_FRAME_PIXEL_Y(W, Y) \ |
| 811 | ((Y) + WINDOW_TOP_EDGE_Y ((W))) |
| 812 | |
| 813 | /* Convert frame relative pixel X to window relative pixel X. */ |
| 814 | |
| 815 | #define FRAME_TO_WINDOW_PIXEL_X(W, X) \ |
| 816 | ((X) - WINDOW_BOX_LEFT_EDGE_X ((W))) |
| 817 | |
| 818 | /* Convert frame relative pixel Y to window relative pixel Y. */ |
| 819 | |
| 820 | #define FRAME_TO_WINDOW_PIXEL_Y(W, Y) \ |
| 821 | ((Y) - WINDOW_TOP_EDGE_Y ((W))) |
| 822 | |
| 823 | /* Convert a text area relative x-position in window W to frame X |
| 824 | pixel coordinates. */ |
| 825 | |
| 826 | #define WINDOW_TEXT_TO_FRAME_PIXEL_X(W, X) \ |
| 827 | (window_box_left ((W), TEXT_AREA) + (X)) |
| 828 | |
| 829 | /* Nonzero if the background of the window W's fringe that is adjacent to |
| 830 | a scroll bar is extended to the gap between the fringe and the bar. */ |
| 831 | |
| 832 | #define WINDOW_FRINGE_EXTENDED_P(w) \ |
| 833 | (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w) \ |
| 834 | ? (WINDOW_LEFTMOST_P (w) \ |
| 835 | && WINDOW_LEFT_FRINGE_WIDTH (w) \ |
| 836 | && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w) \ |
| 837 | || WINDOW_LEFT_MARGIN_COLS (w) == 0)) \ |
| 838 | : (WINDOW_RIGHTMOST_P (w) \ |
| 839 | && WINDOW_RIGHT_FRINGE_WIDTH (w) \ |
| 840 | && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w) \ |
| 841 | || WINDOW_RIGHT_MARGIN_COLS (w) == 0))) |
| 842 | |
| 843 | /* This is the window in which the terminal's cursor should be left when |
| 844 | nothing is being done with it. This must always be a leaf window, and its |
| 845 | buffer is selected by the top level editing loop at the end of each command. |
| 846 | |
| 847 | This value is always the same as FRAME_SELECTED_WINDOW (selected_frame). */ |
| 848 | |
| 849 | extern Lisp_Object selected_window; |
| 850 | |
| 851 | /* This is a time stamp for window selection, so we can find the least |
| 852 | recently used window. Its only users are Fselect_window, |
| 853 | init_window_once, and make_frame. */ |
| 854 | |
| 855 | extern int window_select_count; |
| 856 | |
| 857 | /* The minibuffer window of the selected frame. |
| 858 | Note that you cannot test for minibufferness of an arbitrary window |
| 859 | by comparing against this; use the MINI_WINDOW_P macro instead. */ |
| 860 | |
| 861 | extern Lisp_Object minibuf_window; |
| 862 | |
| 863 | /* Non-nil means it is the window whose mode line should be |
| 864 | shown as the selected window when the minibuffer is selected. */ |
| 865 | |
| 866 | extern Lisp_Object minibuf_selected_window; |
| 867 | |
| 868 | extern Lisp_Object make_window (void); |
| 869 | extern Lisp_Object window_from_coordinates (struct frame *, int, int, |
| 870 | enum window_part *, bool); |
| 871 | extern void resize_frame_windows (struct frame *, int, bool); |
| 872 | extern void restore_window_configuration (Lisp_Object); |
| 873 | extern void delete_all_child_windows (Lisp_Object); |
| 874 | extern void grow_mini_window (struct window *, int); |
| 875 | extern void shrink_mini_window (struct window *); |
| 876 | extern int window_relative_x_coord (struct window *, enum window_part, int); |
| 877 | |
| 878 | void run_window_configuration_change_hook (struct frame *f); |
| 879 | |
| 880 | /* Make WINDOW display BUFFER as its contents. RUN_HOOKS_P non-zero |
| 881 | means it's allowed to run hooks. See make_frame for a case where |
| 882 | it's not allowed. */ |
| 883 | |
| 884 | void set_window_buffer (Lisp_Object window, Lisp_Object buffer, |
| 885 | bool run_hooks_p, bool keep_margins_p); |
| 886 | |
| 887 | /* This is the window where the echo area message was displayed. It |
| 888 | is always a minibuffer window, but it may not be the same window |
| 889 | currently active as a minibuffer. */ |
| 890 | |
| 891 | extern Lisp_Object echo_area_window; |
| 892 | |
| 893 | /* Depth in recursive edits. */ |
| 894 | |
| 895 | extern EMACS_INT command_loop_level; |
| 896 | |
| 897 | /* Depth in minibuffer invocations. */ |
| 898 | |
| 899 | extern EMACS_INT minibuf_level; |
| 900 | |
| 901 | /* true if we should redraw the mode lines on the next redisplay. */ |
| 902 | |
| 903 | extern int update_mode_lines; |
| 904 | |
| 905 | /* Nonzero if window sizes or contents have changed since last |
| 906 | redisplay that finished. */ |
| 907 | |
| 908 | extern int windows_or_buffers_changed; |
| 909 | |
| 910 | /* If *ROWS or *COLS are too small a size for FRAME, set them to the |
| 911 | minimum allowable size. */ |
| 912 | |
| 913 | extern void check_frame_size (struct frame *frame, int *rows, int *cols); |
| 914 | |
| 915 | /* Return a pointer to the glyph W's physical cursor is on. Value is |
| 916 | null if W's current matrix is invalid, so that no meaningful glyph |
| 917 | can be returned. */ |
| 918 | |
| 919 | struct glyph *get_phys_cursor_glyph (struct window *w); |
| 920 | |
| 921 | /* Value is non-zero if WINDOW is a valid window. */ |
| 922 | #define WINDOW_VALID_P(WINDOW) \ |
| 923 | (WINDOWP (WINDOW) && !NILP (XWINDOW (WINDOW)->contents)) \ |
| 924 | |
| 925 | /* A window of any sort, leaf or interior, is "valid" if its |
| 926 | contents slot is non-nil. */ |
| 927 | #define CHECK_VALID_WINDOW(WINDOW) \ |
| 928 | CHECK_TYPE (WINDOW_VALID_P (WINDOW), Qwindow_valid_p, WINDOW) |
| 929 | |
| 930 | /* Value is non-zero if WINDOW is a live window. */ |
| 931 | #define WINDOW_LIVE_P(WINDOW) \ |
| 932 | (WINDOWP (WINDOW) && BUFFERP (XWINDOW (WINDOW)->contents)) |
| 933 | |
| 934 | /* A window is "live" if and only if it shows a buffer. */ |
| 935 | #define CHECK_LIVE_WINDOW(WINDOW) \ |
| 936 | CHECK_TYPE (WINDOW_LIVE_P (WINDOW), Qwindow_live_p, WINDOW) |
| 937 | |
| 938 | /* These used to be in lisp.h. */ |
| 939 | |
| 940 | extern Lisp_Object Qwindow_live_p; |
| 941 | extern Lisp_Object Vwindow_list; |
| 942 | |
| 943 | extern struct window *decode_live_window (Lisp_Object); |
| 944 | extern struct window *decode_any_window (Lisp_Object); |
| 945 | extern bool compare_window_configurations (Lisp_Object, Lisp_Object, bool); |
| 946 | extern void mark_window_cursors_off (struct window *); |
| 947 | extern int window_internal_height (struct window *); |
| 948 | extern int window_body_cols (struct window *w); |
| 949 | extern void temp_output_buffer_show (Lisp_Object); |
| 950 | extern void replace_buffer_in_windows (Lisp_Object); |
| 951 | extern void replace_buffer_in_windows_safely (Lisp_Object); |
| 952 | /* This looks like a setter, but it is a bit special. */ |
| 953 | extern void wset_buffer (struct window *, Lisp_Object); |
| 954 | extern bool window_outdated (struct window *); |
| 955 | extern void init_window_once (void); |
| 956 | extern void init_window (void); |
| 957 | extern void syms_of_window (void); |
| 958 | extern void keys_of_window (void); |
| 959 | |
| 960 | /* Move cursor to row/column position VPOS/HPOS, pixel coordinates |
| 961 | Y/X. HPOS/VPOS are window-relative row and column numbers and X/Y |
| 962 | are window-relative pixel positions. This is always done during |
| 963 | window update, so the position is the future output cursor position |
| 964 | for currently updated window W. */ |
| 965 | |
| 966 | INLINE void |
| 967 | output_cursor_to (struct window *w, int vpos, int hpos, int y, int x) |
| 968 | { |
| 969 | eassert (w); |
| 970 | w->output_cursor.hpos = hpos; |
| 971 | w->output_cursor.vpos = vpos; |
| 972 | w->output_cursor.x = x; |
| 973 | w->output_cursor.y = y; |
| 974 | } |
| 975 | |
| 976 | INLINE_HEADER_END |
| 977 | |
| 978 | #endif /* not WINDOW_H_INCLUDED */ |