src/window.h

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