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