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