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