src/window.h

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