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