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     /* Cursor position as of last update that completed without
 233        pause.  This is the position of last_point.  */
 234     struct cursor_pos last_cursor;
 235
 236     /* Intended cursor position.   This is a position within the
 237        glyph matrix.  */
 238     struct cursor_pos cursor;
 239
 240     /* Where the cursor actually is.  */
 241     struct cursor_pos phys_cursor;
 242
 243     /* Cursor type and width of last cursor drawn on the window.
 244        Used for X and w32 frames; -1 initially.  */
 245     int phys_cursor_type, phys_cursor_width;
 246
 247     /* This is handy for undrawing the cursor.  */
 248     int phys_cursor_ascent, phys_cursor_height;
 249
 250     /* Width of left and right fringes, in pixels.
 251        A value of -1 means use frame values.  */
 252     int left_fringe_width;
 253     int right_fringe_width;
 254
 255     /* Width of left and right marginal areas in columns.
 256        A value of 0 means no margin.  */
 257     int left_margin_cols;
 258     int right_margin_cols;
 259
 260     /* Pixel width of scroll bars.
 261        A value of -1 means use frame values.  */
 262     int scroll_bar_width;
 263
 264     /* Z - the buffer position of the last glyph in the current
 265        matrix of W.  Only valid if window_end_valid is nonzero.  */
 266     ptrdiff_t window_end_pos;
 267
 268     /* Glyph matrix row of the last glyph in the current matrix
 269        of W.  Only valid if window_end_valid is nonzero.  */
 270     int window_end_vpos;
 271
 272     /* Non-zero if this window is a minibuffer window.  */
 273     unsigned mini : 1;
 274
 275     /* Meaningful only if contents is a window, non-zero if this
 276        internal window is used in horizontal combination.  */
 277     unsigned horizontal : 1;
 278
 279     /* Non-zero means must regenerate mode line of this window.  */
 280     unsigned update_mode_line : 1;
 281
 282     /* Non-nil if the buffer was "modified" when the window
 283        was last updated.  */
 284     unsigned last_had_star : 1;
 285
 286     /* Non-zero means current value of `start'
 287        was the beginning of a line when it was chosen.  */
 288     unsigned start_at_line_beg : 1;
 289
 290     /* Non-zero means next redisplay must use the value of start
 291        set up for it in advance.  Set by scrolling commands.  */
 292     unsigned force_start : 1;
 293
 294     /* Non-zero means we have explicitly changed the value of start,
 295        but that the next redisplay is not obliged to use the new value.
 296        This is used in Fdelete_other_windows to force a call to
 297        Vwindow_scroll_functions; also by Frecenter with argument.  */
 298     unsigned optional_new_start : 1;
 299
 300     /* Non-zero means the cursor is currently displayed.  This can be
 301        set to zero by functions overpainting the cursor image.  */
 302     unsigned phys_cursor_on_p : 1;
 303
 304     /* 0 means cursor is logically on, 1 means it's off.  Used for
 305        blinking cursor.  */
 306     unsigned cursor_off_p : 1;
 307
 308     /* Value of cursor_off_p as of the last redisplay.  */
 309     unsigned last_cursor_off_p : 1;
 310
 311     /* 1 means desired matrix has been build and window must be
 312        updated in update_frame.  */
 313     unsigned must_be_updated_p : 1;
 314
 315     /* Flag indicating that this window is not a real one.
 316        Currently only used for menu bar windows of frames.  */
 317     unsigned pseudo_window_p : 1;
 318
 319     /* Non-zero means fringes are drawn outside display margins.
 320        Otherwise draw them between margin areas and text.  */
 321     unsigned fringes_outside_margins : 1;
 322
 323     /* Nonzero if window_end_pos and window_end_vpos are truly valid.
 324        This is zero if nontrivial redisplay is preempted since in that case
 325        the frame image that window_end_pos did not get onto the frame.  */
 326     unsigned window_end_valid : 1;
 327
 328     /* Amount by which lines of this window are scrolled in
 329        y-direction (smooth scrolling).  */
 330     int vscroll;
 331
 332     /* If we have highlighted the region (or any part of it), the mark
 333        (region start) position; otherwise zero.  */
 334     ptrdiff_t region_showing;
 335
 336     /* Z_BYTE - buffer position of the last glyph in the current matrix of W.
 337        Should be nonnegative, and only valid if window_end_valid is nonzero.  */
 338     ptrdiff_t window_end_bytepos;
 339 };
 340
 341 /* Most code should use these functions to set Lisp fields in struct
 342    window.  */
 343 WINDOW_INLINE void
 344 wset_frame (struct window *w, Lisp_Object val)
 345 {
 346   w->frame = val;
 347 }
 348 WINDOW_INLINE void
 349 wset_next (struct window *w, Lisp_Object val)
 350 {
 351   w->next = val;
 352 }
 353 WINDOW_INLINE void
 354 wset_prev (struct window *w, Lisp_Object val)
 355 {
 356   w->prev = val;
 357 }
 358 WINDOW_INLINE void
 359 wset_redisplay_end_trigger (struct window *w, Lisp_Object val)
 360 {
 361   w->redisplay_end_trigger = val;
 362 }
 363 WINDOW_INLINE void
 364 wset_vertical_scroll_bar (struct window *w, Lisp_Object val)
 365 {
 366   w->vertical_scroll_bar = val;
 367 }
 368 WINDOW_INLINE void
 369 wset_prev_buffers (struct window *w, Lisp_Object val)
 370 {
 371   w->prev_buffers = val;
 372 }
 373 WINDOW_INLINE void
 374 wset_next_buffers (struct window *w, Lisp_Object val)
 375 {
 376   w->next_buffers = val;
 377 }
 378
 379 /* 1 if W is a minibuffer window.  */
 380
 381 #define MINI_WINDOW_P(W)        ((W)->mini)
 382
 383 /* General window layout:
 384
 385    LEFT_EDGE_COL         RIGHT_EDGE_COL
 386    |                                  |
 387    |                                  |
 388    |  BOX_LEFT_EDGE_COL               |
 389    |  |           BOX_RIGHT_EDGE_COL  |
 390    |  |                            |  |
 391    v  v                            v  v
 392    <-><-><---><-----------><---><-><->
 393     ^  ^   ^        ^        ^   ^  ^
 394     |  |   |        |        |   |  |
 395     |  |   |        |        |   |  +-- RIGHT_SCROLL_BAR_COLS
 396     |  |   |        |        |   +----- RIGHT_FRINGE_WIDTH
 397     |  |   |        |        +--------- RIGHT_MARGIN_COLS
 398     |  |   |        |
 399     |  |   |        +------------------ TEXT_AREA_COLS
 400     |  |   |
 401     |  |   +--------------------------- LEFT_MARGIN_COLS
 402     |  +------------------------------- LEFT_FRINGE_WIDTH
 403     +---------------------------------- LEFT_SCROLL_BAR_COLS
 404
 405 */
 406
 407
 408 /* A handy macro.  */
 409
 410 /* Non-zero if W is leaf (carry the buffer).  */
 411
 412 #define WINDOW_LEAF_P(W) \
 413   (BUFFERP ((W)->contents))
 414
 415 /* Non-zero if W is a member of horizontal combination.  */
 416
 417 #define WINDOW_HORIZONTAL_COMBINATION_P(W) \
 418   (WINDOWP ((W)->contents) && (W)->horizontal)
 419
 420 /* Non-zero if W is a member of vertical combination.  */
 421
 422 #define WINDOW_VERTICAL_COMBINATION_P(W) \
 423   (WINDOWP ((W)->contents) && !(W)->horizontal)
 424
 425 #define WINDOW_XFRAME(W) \
 426   (XFRAME (WINDOW_FRAME ((W))))
 427
 428 /* Return the canonical column width of the frame of window W.  */
 429
 430 #define WINDOW_FRAME_COLUMN_WIDTH(W) \
 431   (FRAME_COLUMN_WIDTH (WINDOW_XFRAME ((W))))
 432
 433 /* Return the canonical column width of the frame of window W.  */
 434
 435 #define WINDOW_FRAME_LINE_HEIGHT(W) \
 436   (FRAME_LINE_HEIGHT (WINDOW_XFRAME ((W))))
 437
 438 /* Return the width of window W in canonical column units.
 439    This includes scroll bars and fringes.  */
 440
 441 #define WINDOW_TOTAL_COLS(W) (W)->total_cols
 442
 443 /* Return the height of window W in canonical line units.
 444    This includes header and mode lines, if any.  */
 445
 446 #define WINDOW_TOTAL_LINES(W) (W)->total_lines
 447
 448 /* Return the total pixel width of window W.  */
 449
 450 #define WINDOW_TOTAL_WIDTH(W) \
 451   (WINDOW_TOTAL_COLS (W) * WINDOW_FRAME_COLUMN_WIDTH (W))
 452
 453 /* Return the total pixel height of window W.  */
 454
 455 #define WINDOW_TOTAL_HEIGHT(W) \
 456   (WINDOW_TOTAL_LINES (W) * WINDOW_FRAME_LINE_HEIGHT (W))
 457
 458 /* For HORFLAG non-zero the total number of columns of window W.  Otherwise
 459    the total number of lines of W.  */
 460
 461 #define WINDOW_TOTAL_SIZE(w, horflag) \
 462   (horflag ? WINDOW_TOTAL_COLS (w) : WINDOW_TOTAL_LINES (w))
 463
 464 /* The smallest acceptable dimensions for a window.  Anything smaller
 465    might crash Emacs.  */
 466
 467 #define MIN_SAFE_WINDOW_WIDTH  (2)
 468 #define MIN_SAFE_WINDOW_HEIGHT (1)
 469
 470 /* Return the canonical frame column at which window W starts.
 471    This includes a left-hand scroll bar, if any.  */
 472
 473 #define WINDOW_LEFT_EDGE_COL(W) (W)->left_col
 474
 475 /* Return the canonical frame column before which window W ends.
 476    This includes a right-hand scroll bar, if any.  */
 477
 478 #define WINDOW_RIGHT_EDGE_COL(W) \
 479   (WINDOW_LEFT_EDGE_COL (W) + WINDOW_TOTAL_COLS (W))
 480
 481 /* Return the canonical frame line at which window W starts.
 482    This includes a header line, if any.  */
 483
 484 #define WINDOW_TOP_EDGE_LINE(W) (W)->top_line
 485
 486 /* Return the canonical frame line before which window W ends.
 487    This includes a mode line, if any.  */
 488
 489 #define WINDOW_BOTTOM_EDGE_LINE(W) \
 490   (WINDOW_TOP_EDGE_LINE (W) + WINDOW_TOTAL_LINES (W))
 491
 492
 493 /* Return the frame x-position at which window W starts.
 494    This includes a left-hand scroll bar, if any.  */
 495
 496 #define WINDOW_LEFT_EDGE_X(W) \
 497   (FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W)) \
 498    + WINDOW_LEFT_EDGE_COL (W) * WINDOW_FRAME_COLUMN_WIDTH (W))
 499
 500 /* Return the frame x- position before which window W ends.
 501    This includes a right-hand scroll bar, if any.  */
 502
 503 #define WINDOW_RIGHT_EDGE_X(W) \
 504   (FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W)) \
 505    + WINDOW_RIGHT_EDGE_COL (W) * WINDOW_FRAME_COLUMN_WIDTH (W))
 506
 507 /* 1 if W is a menu bar window.  */
 508
 509 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
 510 #define WINDOW_MENU_BAR_P(W) \
 511   (WINDOWP (WINDOW_XFRAME (W)->menu_bar_window) \
 512    && (W) == XWINDOW (WINDOW_XFRAME (W)->menu_bar_window))
 513 #else
 514 /* No menu bar windows if X toolkit is in use.  */
 515 #define WINDOW_MENU_BAR_P(W) (0)
 516 #endif
 517
 518 /* 1 if W is a tool bar window.  */
 519
 520 #define WINDOW_TOOL_BAR_P(W) \
 521   (WINDOWP (WINDOW_XFRAME (W)->tool_bar_window) \
 522    && (W) == XWINDOW (WINDOW_XFRAME (W)->tool_bar_window))
 523
 524 /* Return the frame y-position at which window W starts.
 525    This includes a header line, if any.  */
 526
 527 #define WINDOW_TOP_EDGE_Y(W) \
 528   (((WINDOW_MENU_BAR_P (W) || WINDOW_TOOL_BAR_P (W)) \
 529     ? 0 : FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W))) \
 530    + WINDOW_TOP_EDGE_LINE (W) * WINDOW_FRAME_LINE_HEIGHT (W))
 531
 532 /* Return the frame y-position before which window W ends.
 533    This includes a mode line, if any.  */
 534
 535 #define WINDOW_BOTTOM_EDGE_Y(W) \
 536   (((WINDOW_MENU_BAR_P (W) || WINDOW_TOOL_BAR_P (W)) \
 537     ? 0 : FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W))) \
 538    + WINDOW_BOTTOM_EDGE_LINE (W) * WINDOW_FRAME_LINE_HEIGHT (W))
 539
 540
 541 /* 1 if window W takes up the full width of its frame.  */
 542
 543 #define WINDOW_FULL_WIDTH_P(W) \
 544   (WINDOW_TOTAL_COLS (W) == FRAME_TOTAL_COLS (WINDOW_XFRAME (W)))
 545
 546 /* 1 if window W's has no other windows to its left in its frame.  */
 547
 548 #define WINDOW_LEFTMOST_P(W) \
 549   (WINDOW_LEFT_EDGE_COL (W) == 0)
 550
 551 /* 1 if window W's has no other windows to its right in its frame.  */
 552
 553 #define WINDOW_RIGHTMOST_P(W) \
 554   (WINDOW_RIGHT_EDGE_COL (W) == FRAME_TOTAL_COLS (WINDOW_XFRAME (W)))
 555
 556
 557 /* Return the frame column at which the text (or left fringe) in
 558    window W starts.  This is different from the `LEFT_EDGE' because it
 559    does not include a left-hand scroll bar if any.  */
 560
 561 #define WINDOW_BOX_LEFT_EDGE_COL(W) \
 562   (WINDOW_LEFT_EDGE_COL (W) \
 563    + WINDOW_LEFT_SCROLL_BAR_COLS (W))
 564
 565 /* Return the window column before which the text in window W ends.
 566    This is different from WINDOW_RIGHT_EDGE_COL because it does not
 567    include a scroll bar or window-separating line on the right edge.  */
 568
 569 #define WINDOW_BOX_RIGHT_EDGE_COL(W) \
 570   (WINDOW_RIGHT_EDGE_COL (W) \
 571    - WINDOW_RIGHT_SCROLL_BAR_COLS (W))
 572
 573
 574 /* Return the frame position at which the text (or left fringe) in
 575    window W starts.  This is different from the `LEFT_EDGE' because it
 576    does not include a left-hand scroll bar if any.  */
 577
 578 #define WINDOW_BOX_LEFT_EDGE_X(W) \
 579   (FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W)) \
 580    + WINDOW_BOX_LEFT_EDGE_COL (W) * WINDOW_FRAME_COLUMN_WIDTH (W))
 581
 582 /* Return the window column before which the text in window W ends.
 583    This is different from WINDOW_RIGHT_EDGE_COL because it does not
 584    include a scroll bar or window-separating line on the right edge.  */
 585
 586 #define WINDOW_BOX_RIGHT_EDGE_X(W) \
 587   (FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W)) \
 588    + WINDOW_BOX_RIGHT_EDGE_COL (W) * WINDOW_FRAME_COLUMN_WIDTH (W))
 589
 590
 591 /* Width of left margin area in columns.  */
 592
 593 #define WINDOW_LEFT_MARGIN_COLS(W) (W->left_margin_cols)
 594
 595 /* Width of right marginal area in columns.  */
 596
 597 #define WINDOW_RIGHT_MARGIN_COLS(W) (W->right_margin_cols)
 598
 599 /* Width of left margin area in pixels.  */
 600
 601 #define WINDOW_LEFT_MARGIN_WIDTH(W)                     \
 602   (W->left_margin_cols * WINDOW_FRAME_COLUMN_WIDTH (W))
 603
 604 /* Width of right marginal area in pixels.  */
 605
 606 #define WINDOW_RIGHT_MARGIN_WIDTH(W)                    \
 607   (W->right_margin_cols * WINDOW_FRAME_COLUMN_WIDTH (W))
 608
 609 /* Total width of fringes reserved for drawing truncation bitmaps,
 610    continuation bitmaps and alike.  The width is in canonical char
 611    units of the frame.  This must currently be the case because window
 612    sizes aren't pixel values.  If it weren't the case, we wouldn't be
 613    able to split windows horizontally nicely.  */
 614
 615 #define WINDOW_FRINGE_COLS(W)                   \
 616   ((W->left_fringe_width >= 0                   \
 617     && W->right_fringe_width >= 0)              \
 618    ? ((W->left_fringe_width                     \
 619        + W->right_fringe_width                  \
 620        + WINDOW_FRAME_COLUMN_WIDTH (W) - 1)     \
 621       / WINDOW_FRAME_COLUMN_WIDTH (W))          \
 622    : FRAME_FRINGE_COLS (WINDOW_XFRAME (W)))
 623
 624 /* Column-width of the left and right fringe.  */
 625
 626 #define WINDOW_LEFT_FRINGE_COLS(W)              \
 627   ((WINDOW_LEFT_FRINGE_WIDTH ((W))              \
 628     + WINDOW_FRAME_COLUMN_WIDTH (W) - 1)        \
 629    / WINDOW_FRAME_COLUMN_WIDTH (W))
 630
 631 #define WINDOW_RIGHT_FRINGE_COLS(W)             \
 632   ((WINDOW_RIGHT_FRINGE_WIDTH ((W))             \
 633     + WINDOW_FRAME_COLUMN_WIDTH (W) - 1)        \
 634    / WINDOW_FRAME_COLUMN_WIDTH (W))
 635
 636 /* Pixel-width of the left and right fringe.  */
 637
 638 #define WINDOW_LEFT_FRINGE_WIDTH(W)                     \
 639   (W->left_fringe_width >= 0 ? W->left_fringe_width     \
 640    : FRAME_LEFT_FRINGE_WIDTH (WINDOW_XFRAME (W)))
 641
 642 #define WINDOW_RIGHT_FRINGE_WIDTH(W)                    \
 643   (W->right_fringe_width >= 0 ? W->right_fringe_width   \
 644    : FRAME_RIGHT_FRINGE_WIDTH (WINDOW_XFRAME (W)))
 645
 646 /* Total width of fringes in pixels.  */
 647
 648 #define WINDOW_TOTAL_FRINGE_WIDTH(W)            \
 649   (WINDOW_LEFT_FRINGE_WIDTH (W) + WINDOW_RIGHT_FRINGE_WIDTH (W))
 650
 651 /* Are fringes outside display margins in window W.  */
 652
 653 #define WINDOW_HAS_FRINGES_OUTSIDE_MARGINS(W)   \
 654   ((W)->fringes_outside_margins)
 655
 656 /* Say whether scroll bars are currently enabled for window W,
 657    and which side they are on.  */
 658
 659 #define WINDOW_VERTICAL_SCROLL_BAR_TYPE(w)              \
 660   (EQ (w->vertical_scroll_bar_type, Qt)                 \
 661    ? FRAME_VERTICAL_SCROLL_BAR_TYPE (WINDOW_XFRAME (w)) \
 662    : EQ (w->vertical_scroll_bar_type, Qleft)            \
 663    ? vertical_scroll_bar_left                           \
 664    : EQ (w->vertical_scroll_bar_type, Qright)           \
 665    ? vertical_scroll_bar_right                          \
 666    : vertical_scroll_bar_none)                          \
 667
 668 #define WINDOW_HAS_VERTICAL_SCROLL_BAR(w)               \
 669   (EQ (w->vertical_scroll_bar_type, Qt)                 \
 670    ? FRAME_HAS_VERTICAL_SCROLL_BARS (WINDOW_XFRAME (w)) \
 671    : !NILP (w->vertical_scroll_bar_type))
 672
 673 #define WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT(w)               \
 674   (EQ (w->vertical_scroll_bar_type, Qt)                         \
 675    ? FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (WINDOW_XFRAME (w)) \
 676    : EQ (w->vertical_scroll_bar_type, Qleft))
 677
 678 #define WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT(w)                      \
 679   (EQ (w->vertical_scroll_bar_type, Qt)                                 \
 680    ? FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (WINDOW_XFRAME (w))        \
 681    : EQ (w->vertical_scroll_bar_type, Qright))
 682
 683 /* Width that a scroll bar in window W should have, if there is one.
 684    Measured in pixels.  If scroll bars are turned off, this is still
 685    nonzero.  */
 686
 687 #define WINDOW_CONFIG_SCROLL_BAR_WIDTH(w)               \
 688   (w->scroll_bar_width >= 0 ? w->scroll_bar_width       \
 689    : FRAME_CONFIG_SCROLL_BAR_WIDTH (WINDOW_XFRAME (w)))
 690
 691 /* Width that a scroll bar in window W should have, if there is one.
 692    Measured in columns (characters).  If scroll bars are turned off,
 693    this is still nonzero.  */
 694
 695 #define WINDOW_CONFIG_SCROLL_BAR_COLS(w)                \
 696   (w->scroll_bar_width >= 0                             \
 697    ? ((w->scroll_bar_width                              \
 698        + WINDOW_FRAME_COLUMN_WIDTH (w) - 1)             \
 699       / WINDOW_FRAME_COLUMN_WIDTH (w))                  \
 700    : FRAME_CONFIG_SCROLL_BAR_COLS (WINDOW_XFRAME (w)))
 701
 702 /* Width of a scroll bar in window W, measured in columns (characters),
 703    but only if scroll bars are on the left.  If scroll bars are on
 704    the right in this frame, or there are no scroll bars, value is 0.  */
 705
 706 #define WINDOW_LEFT_SCROLL_BAR_COLS(w)         \
 707   (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)  \
 708    ? (WINDOW_CONFIG_SCROLL_BAR_COLS (w))       \
 709    : 0)
 710
 711 /* Width of a left scroll bar area in window W , measured in pixels.  */
 712
 713 #define WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH(w)                             \
 714   (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)                            \
 715    ? (WINDOW_CONFIG_SCROLL_BAR_COLS (w) * WINDOW_FRAME_COLUMN_WIDTH (w)) \
 716    : 0)
 717
 718 /* Width of a scroll bar in window W, measured in columns (characters),
 719    but only if scroll bars are on the right.  If scroll bars are on
 720    the left in this frame, or there are no scroll bars, value is 0.  */
 721
 722 #define WINDOW_RIGHT_SCROLL_BAR_COLS(w)         \
 723   (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)  \
 724    ? WINDOW_CONFIG_SCROLL_BAR_COLS (w)          \
 725    : 0)
 726
 727 /* Width of a left scroll bar area in window W , measured in pixels.  */
 728
 729 #define WINDOW_RIGHT_SCROLL_BAR_AREA_WIDTH(w)                            \
 730   (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)                           \
 731    ? (WINDOW_CONFIG_SCROLL_BAR_COLS (w) * WINDOW_FRAME_COLUMN_WIDTH (w)) \
 732    : 0)
 733
 734
 735 /* Actual width of a scroll bar in window W, measured in columns.  */
 736
 737 #define WINDOW_SCROLL_BAR_COLS(w)              \
 738   (WINDOW_HAS_VERTICAL_SCROLL_BAR (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_SCROLL_BAR_AREA_WIDTH(w)                                  \
 745   (WINDOW_HAS_VERTICAL_SCROLL_BAR (w)                                    \
 746    ? (WINDOW_CONFIG_SCROLL_BAR_COLS (w) * WINDOW_FRAME_COLUMN_WIDTH (w)) \
 747    : 0)
 748
 749
 750 /* Return the frame position where the scroll bar of window W starts.  */
 751
 752 #define WINDOW_SCROLL_BAR_AREA_X(W)             \
 753   (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (W)  \
 754    ? WINDOW_BOX_RIGHT_EDGE_X (W)                \
 755    : WINDOW_LEFT_EDGE_X (W))
 756
 757
 758 /* Height in pixels, and in lines, of the mode line.
 759    May be zero if W doesn't have a mode line.  */
 760
 761 #define WINDOW_MODE_LINE_HEIGHT(W)      \
 762   (WINDOW_WANTS_MODELINE_P ((W))        \
 763    ? CURRENT_MODE_LINE_HEIGHT (W)       \
 764    : 0)
 765
 766 #define WINDOW_MODE_LINE_LINES(W)       \
 767   (!! WINDOW_WANTS_MODELINE_P ((W)))
 768
 769 /* Height in pixels, and in lines, of the header line.
 770    Zero if W doesn't have a header line.  */
 771
 772 #define WINDOW_HEADER_LINE_HEIGHT(W)    \
 773   (WINDOW_WANTS_HEADER_LINE_P ((W))     \
 774    ? CURRENT_HEADER_LINE_HEIGHT (W)     \
 775    : 0)
 776
 777 #define WINDOW_HEADER_LINE_LINES(W)     \
 778   (!! WINDOW_WANTS_HEADER_LINE_P ((W)))
 779
 780 /* Pixel height of window W without mode line.  */
 781
 782 #define WINDOW_BOX_HEIGHT_NO_MODE_LINE(W)       \
 783   (WINDOW_TOTAL_HEIGHT ((W))                    \
 784    - WINDOW_MODE_LINE_HEIGHT ((W)))
 785
 786 /* Pixel height of window W without mode and header line.  */
 787
 788 #define WINDOW_BOX_TEXT_HEIGHT(W)       \
 789   (WINDOW_TOTAL_HEIGHT ((W))            \
 790    - WINDOW_MODE_LINE_HEIGHT ((W))      \
 791    - WINDOW_HEADER_LINE_HEIGHT ((W)))
 792
 793
 794 /* Convert window W relative pixel X to frame pixel coordinates.  */
 795
 796 #define WINDOW_TO_FRAME_PIXEL_X(W, X)   \
 797   ((X) + WINDOW_BOX_LEFT_EDGE_X ((W)))
 798
 799 /* Convert window W relative pixel Y to frame pixel coordinates.  */
 800
 801 #define WINDOW_TO_FRAME_PIXEL_Y(W, Y)   \
 802   ((Y) + WINDOW_TOP_EDGE_Y ((W)))
 803
 804 /* Convert frame relative pixel X to window relative pixel X.  */
 805
 806 #define FRAME_TO_WINDOW_PIXEL_X(W, X)   \
 807   ((X) - WINDOW_BOX_LEFT_EDGE_X ((W)))
 808
 809 /* Convert frame relative pixel Y to window relative pixel Y.  */
 810
 811 #define FRAME_TO_WINDOW_PIXEL_Y(W, Y)   \
 812   ((Y) - WINDOW_TOP_EDGE_Y ((W)))
 813
 814 /* Convert a text area relative x-position in window W to frame X
 815    pixel coordinates.  */
 816
 817 #define WINDOW_TEXT_TO_FRAME_PIXEL_X(W, X)      \
 818   (window_box_left ((W), TEXT_AREA) + (X))
 819
 820 /* Nonzero if the background of the window W's fringe that is adjacent to
 821    a scroll bar is extended to the gap between the fringe and the bar.  */
 822
 823 #define WINDOW_FRINGE_EXTENDED_P(w)                     \
 824   (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)           \
 825    ? (WINDOW_LEFTMOST_P (w)                             \
 826       && WINDOW_LEFT_FRINGE_WIDTH (w)                   \
 827       && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)        \
 828           || WINDOW_LEFT_MARGIN_COLS (w) == 0))         \
 829    : (WINDOW_RIGHTMOST_P (w)                            \
 830       && WINDOW_RIGHT_FRINGE_WIDTH (w)                  \
 831       && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)        \
 832           || WINDOW_RIGHT_MARGIN_COLS (w) == 0)))
 833
 834 /* This is the window in which the terminal's cursor should be left when
 835    nothing is being done with it.  This must always be a leaf window, and its
 836    buffer is selected by the top level editing loop at the end of each command.
 837
 838    This value is always the same as FRAME_SELECTED_WINDOW (selected_frame).  */
 839
 840 extern Lisp_Object selected_window;
 841
 842 /* This is a time stamp for window selection, so we can find the least
 843    recently used window.  Its only users are Fselect_window,
 844    init_window_once, and make_frame.  */
 845
 846 extern int window_select_count;
 847
 848 /* The minibuffer window of the selected frame.
 849    Note that you cannot test for minibufferness of an arbitrary window
 850    by comparing against this; use the MINI_WINDOW_P macro instead.  */
 851
 852 extern Lisp_Object minibuf_window;
 853
 854 /* Non-nil means it is the window whose mode line should be
 855    shown as the selected window when the minibuffer is selected.  */
 856
 857 extern Lisp_Object minibuf_selected_window;
 858
 859 /* Window that the mouse is over (nil if no mouse support).  */
 860
 861 extern Lisp_Object Vmouse_window;
 862
 863 /* Last mouse-click event (nil if no mouse support).  */
 864
 865 extern Lisp_Object Vmouse_event;
 866
 867 extern Lisp_Object make_window (void);
 868 extern Lisp_Object window_from_coordinates (struct frame *, int, int,
 869                                             enum window_part *, bool);
 870 extern void resize_frame_windows (struct frame *, int, bool);
 871 extern void restore_window_configuration (Lisp_Object);
 872 extern void delete_all_child_windows (Lisp_Object);
 873 extern void grow_mini_window (struct window *, int);
 874 extern void shrink_mini_window (struct window *);
 875 extern int window_relative_x_coord (struct window *, enum window_part, int);
 876
 877 void run_window_configuration_change_hook (struct frame *f);
 878
 879 /* Make WINDOW display BUFFER as its contents.  RUN_HOOKS_P non-zero
 880    means it's allowed to run hooks.  See make_frame for a case where
 881    it's not allowed.  */
 882
 883 void set_window_buffer (Lisp_Object window, Lisp_Object buffer,
 884                         bool run_hooks_p, bool keep_margins_p);
 885
 886 /* This is the window where the echo area message was displayed.  It
 887    is always a minibuffer window, but it may not be the same window
 888    currently active as a minibuffer.  */
 889
 890 extern Lisp_Object echo_area_window;
 891
 892 /* Depth in recursive edits.  */
 893
 894 extern EMACS_INT command_loop_level;
 895
 896 /* Depth in minibuffer invocations.  */
 897
 898 extern EMACS_INT minibuf_level;
 899
 900 /* true if we should redraw the mode lines on the next redisplay.  */
 901
 902 extern int update_mode_lines;
 903
 904 /* Nonzero if window sizes or contents have changed since last
 905    redisplay that finished.  */
 906
 907 extern int windows_or_buffers_changed;
 908
 909 /* If *ROWS or *COLS are too small a size for FRAME, set them to the
 910    minimum allowable size.  */
 911
 912 extern void check_frame_size (struct frame *frame, int *rows, int *cols);
 913
 914 /* Return a pointer to the glyph W's physical cursor is on.  Value is
 915    null if W's current matrix is invalid, so that no meaningful glyph
 916    can be returned.  */
 917
 918 struct glyph *get_phys_cursor_glyph (struct window *w);
 919
 920 /* Value is non-zero if WINDOW is a valid window.  */
 921 #define WINDOW_VALID_P(WINDOW)                                  \
 922   (WINDOWP (WINDOW) && !NILP (XWINDOW (WINDOW)->contents))      \
 923
 924 /* A window of any sort, leaf or interior, is "valid" if its
 925    contents slot is non-nil.  */
 926 #define CHECK_VALID_WINDOW(WINDOW)                              \
 927   CHECK_TYPE (WINDOW_VALID_P (WINDOW), Qwindow_valid_p, WINDOW)
 928
 929 /* Value is non-zero if WINDOW is a live window.  */
 930 #define WINDOW_LIVE_P(WINDOW)                                   \
 931   (WINDOWP (WINDOW) && BUFFERP (XWINDOW (WINDOW)->contents))
 932
 933 /* A window is "live" if and only if it shows a buffer.  */
 934 #define CHECK_LIVE_WINDOW(WINDOW)                               \
 935   CHECK_TYPE (WINDOW_LIVE_P (WINDOW), Qwindow_live_p, WINDOW)
 936
 937 /* These used to be in lisp.h.  */
 938
 939 extern Lisp_Object Qwindow_live_p;
 940 extern Lisp_Object Vwindow_list;
 941
 942 extern struct window *decode_live_window (Lisp_Object);
 943 extern struct window *decode_any_window (Lisp_Object);
 944 extern bool compare_window_configurations (Lisp_Object, Lisp_Object, bool);
 945 extern void mark_window_cursors_off (struct window *);
 946 extern int window_internal_height (struct window *);
 947 extern int window_body_cols (struct window *w);
 948 extern void temp_output_buffer_show (Lisp_Object);
 949 extern void replace_buffer_in_windows (Lisp_Object);
 950 extern void replace_buffer_in_windows_safely (Lisp_Object);
 951 /* This looks like a setter, but it is a bit special.  */
 952 extern void wset_buffer (struct window *, Lisp_Object);
 953 extern bool window_outdated (struct window *);
 954 extern void init_window_once (void);
 955 extern void init_window (void);
 956 extern void syms_of_window (void);
 957 extern void keys_of_window (void);
 958
 959 INLINE_HEADER_END
 960
 961 #endif /* not WINDOW_H_INCLUDED */