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