src/window.h

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