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