src/window.h

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