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