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