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