src/window.h

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