src/window.h

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