src/window.h

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