src/window.h

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