src/window.h

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