src/window.h

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