window.h 41.5 KB
Newer Older
<
Jim Blandy's avatar
Jim Blandy committed
1
/* Window definitions for GNU Emacs.
Paul Eggert's avatar
Paul Eggert committed
2
   Copyright (C) 1985-1986, 1993, 1995, 1997-2019 Free Software
3
   Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6

This file is part of GNU Emacs.

7
GNU Emacs is free software: you can redistribute it and/or modify
Jim Blandy's avatar
Jim Blandy committed
8
it under the terms of the GNU General Public License as published by
9 10
the Free Software Foundation, either version 3 of the License, or (at
your option) any later version.
Jim Blandy's avatar
Jim Blandy committed
11 12 13 14 15 16 17

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
18
along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
19

20 21 22 23
#ifndef WINDOW_H_INCLUDED
#define WINDOW_H_INCLUDED

#include "dispextern.h"
Jim Blandy's avatar
Jim Blandy committed
24

Paul Eggert's avatar
Paul Eggert committed
25 26
INLINE_HEADER_BEGIN

27 28 29
/* Windows are allocated as if they were vectors, but then the Lisp
data type is changed to Lisp_Window.  They are garbage collected along
with the vectors.
Jim Blandy's avatar
Jim Blandy committed
30 31 32

All windows in use are arranged into a tree, with pointers up and down.

33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
Windows that are leaves of the tree are actually displayed and show
the contents of buffers.  Windows that are not leaves are used for
representing the way groups of leaf windows are arranged on the frame.
Leaf windows never become non-leaves.  They are deleted only by
calling `delete-window' on them (but this can be done implicitly).
Non-leaf windows never become leaf windows and can be created and
deleted at any time by the window management code.  Non-leaf windows
can be seen but not directly manipulated by Lisp functions.

A leaf window has a buffer stored in its contents field and markers in
its 'start' and 'pointm' fields.  Non-leaf windows have nil in the
latter two fields.  Non-leaf windows are either vertical or horizontal
combinations.

A vertical combination window has children that are arranged on the
frame one above the next.  Its 'contents' field points to the
uppermost child.  The 'parent' field of each of the children points to
the vertical combination window.  The 'next' field of each child
points to the child below it, or is nil for the lowest child.  The
'prev' field of each child points to the child above it, or is nil for
the highest child.

A horizontal combination window has children that are arranged side by
side.  Its 'contents' field points to the leftmost child.  In each
child the 'next' field points to the child to the right and the 'prev'
field points to the child to the left.

On each frame there are at least one and at most two windows which
have nil as parent.  The second of these, if present, is the frame's
minibuffer window and shows the minibuffer or the echo area.  The
first one manages the remaining frame area and is called the frame's
root window.  Different windows can be the root at different times;
initially the root window is a leaf window, but if more windows are
created, then that leaf window ceases to be root and a newly made
combination window becomes the root instead.

On frames which have an ordinary window and a minibuffer window,
'prev' of the minibuffer window is the root window and 'next' of the
root window is the minibuffer window.  On minibuffer-less frames there
is only a root window and 'next' of the root window is nil.  On
minibuffer-only frames, the root window and the minibuffer window are
one and the same, so its 'prev' and 'next' members are nil.  In any
case, 'prev' of a root window and 'next' of a minibuffer window are
always nil.

In Lisp parlance, leaf windows are called "live windows" and non-leaf
windows are called "internal windows".  Together, live and internal
windows form the set of "valid windows".  A window that has been
deleted is considered "dead" regardless of whether it formerly was a
leaf or a non-leaf window.  A dead window has its 'contents' field set
to nil.

Frames may also contain pseudo windows, windows that are not exposed
directly to Lisp code.  Pseudo windows are currently either used to
display the menu bar or the tool bar (when Emacs uses toolkits that
don't display their own menu bar and tool bar) or a tooltip in a
tooltip frame (when tooltips are not display by the toolkit).  */
Jim Blandy's avatar
Jim Blandy committed
90

91 92 93 94 95 96 97 98 99
struct cursor_pos
{
  /* Pixel position.  These are always window relative.  */
  int x, y;

  /* Glyph matrix position.  */
  int hpos, vpos;
};

Jim Blandy's avatar
Jim Blandy committed
100 101
struct window
  {
102
    /* This is for Lisp; the terminal code does not refer to it.  */
103
    union vectorlike_header header;
104

Jim Blandy's avatar
Jim Blandy committed
105
    /* The frame this window is on.  */
106
    Lisp_Object frame;
107

108 109
    /* Following (to right or down) and preceding (to left or up)
       child at same level of tree.  Whether this is left/right or
110 111 112 113 114 115 116 117
       up/down is determined by the parent window's 'horizontal' flag,
       see below.  On a frame that is neither a minibuffer-only nor a
       minibuffer-less frame, 'next' of the root window points to the
       frame's minibuffer window and 'prev' of the minibuffer window
       points to the frame's root window.  In all other cases, 'next'
       of the root window and 'prev' of the minibuffer window, if
       present, are nil.  'prev' of the root window and 'next' of the
       minibuffer window are always nil.  */
118 119
    Lisp_Object next;
    Lisp_Object prev;
120

121 122
    /* The window this one is a child of.  For the root and a
       minibuffer window this is always nil.  */
123
    Lisp_Object parent;
124

125 126 127
    /* The "normal" size of the window.  These are fractions, but we
       do not use C doubles to avoid creating new Lisp_Float objects
       while interfacing Lisp in Fwindow_normal_size.  */
128 129
    Lisp_Object normal_lines;
    Lisp_Object normal_cols;
130

131 132 133
    /* The new sizes of the window as proposed by the window resizing
       functions.  Note that Lisp code may set new_normal to something
       beyond an integer, so C int can't be used here.  */
134 135
    Lisp_Object new_total;
    Lisp_Object new_normal;
136
    Lisp_Object new_pixel;
137

138 139 140 141 142
    /* For a leaf window or a tooltip window this is the buffer shown
       in the window; for a combination window this is the first of
       its child windows; for a pseudo window showing the menu bar or
       tool bar this is nil.  It is a buffer for a minibuffer window
       as well.  */
143
    Lisp_Object contents;
144

145 146 147 148
    /* A marker pointing to where in the text to start displaying.
       BIDI Note: This is the _logical-order_ start, i.e. the smallest
       buffer position visible in the window, not necessarily the
       character displayed in the top left corner of the window.  */
149
    Lisp_Object start;
150

Jim Blandy's avatar
Jim Blandy committed
151 152 153 154
    /* A marker pointing to where in the text point is in this window,
       used only when the window is not selected.
       This exists so that when multiple windows show one buffer
       each one can have its own value of point.  */
155
    Lisp_Object pointm;
156

157 158 159 160 161
    /* A marker pointing to where in the text point was in this window
       at the time of last redisplay.  The value is saved for the
       selected window too.  */
    Lisp_Object old_pointm;

162 163
    /* No permanent meaning; used by save-window-excursion's
       bookkeeping.  */
164
    Lisp_Object temslot;
165

166 167 168 169 170
    /* This window's vertical scroll bar.  This field is only for use by
       the window-system-dependent code which implements the scroll
       bars; it can store anything it likes here.  If this window is
       newly created and we haven't displayed a scroll bar in it yet, or
       if the frame doesn't have any scroll bars, this is nil.  */
171
    Lisp_Object vertical_scroll_bar;
172

173 174
    /* Type of vertical scroll bar.  A value of nil means
       no scroll bar.  A value of t means use frame value.  */
175
    Lisp_Object vertical_scroll_bar_type;
176

177 178 179 180 181 182 183 184 185 186 187
    /* This window's horizontal scroll bar.  This field is only for use
       by the window-system-dependent code which implements the scroll
       bars; it can store anything it likes here.  If this window is
       newly created and we haven't displayed a scroll bar in it yet, or
       if the frame doesn't have any scroll bars, this is nil.  */
    Lisp_Object horizontal_scroll_bar;

    /* Type of horizontal scroll bar.  A value of nil means
       no scroll bar.  A value of t means use frame value.  */
    Lisp_Object horizontal_scroll_bar_type;

Jim Blandy's avatar
Jim Blandy committed
188 189
    /* Display-table to use for displaying chars in this window.
       Nil means use the buffer's own display-table.  */
190
    Lisp_Object display_table;
191

192 193 194
    /* Non-nil usually means window is marked as dedicated.
       Note Lisp code may set this to something beyond Qnil
       and Qt, so bitfield can't be used here.  */
195
    Lisp_Object dedicated;
196

197 198
    /* If redisplay in this window goes beyond this buffer position,
       must run the redisplay-end-trigger-hook.  */
199
    Lisp_Object redisplay_end_trigger;
200

201
    /* t means this window's child windows are not (re-)combined.  */
202
    Lisp_Object combination_limit;
203

Paul Eggert's avatar
Paul Eggert committed
204
    /* An alist with parameters.  */
205
    Lisp_Object window_parameters;
206

207 208 209 210 211 212 213 214
    /* No Lisp data may follow below this point without changing
       mark_object in alloc.c.  The member current_matrix must be the
       first non-Lisp member.  */

    /* Glyph matrices.  */
    struct glyph_matrix *current_matrix;
    struct glyph_matrix *desired_matrix;

215 216
    /* The two Lisp_Object fields below are marked in a special way,
       which is why they're placed after `current_matrix'.  */
217
    /* A list of <buffer, window-start, window-point> triples listing
218 219 220 221 222
       buffers previously shown in this window.  */
    Lisp_Object prev_buffers;
    /* List of buffers re-shown in this window.  */
    Lisp_Object next_buffers;

223
    /* Number saying how recently window was selected.  */
224
    EMACS_INT use_time;
225

226
    /* Unique number of window assigned when it was created.  */
227
    EMACS_INT sequence_number;
228 229 230 231 232 233

    /* The upper left corner pixel coordinates of this window, as
       integers relative to upper left corner of frame = 0, 0.  */
    int pixel_left;
    int pixel_top;

234 235 236 237 238
    /* The upper left corner coordinates of this window,
       relative to upper left corner of frame = 0, 0.  */
    int left_col;
    int top_line;

239 240 241 242
    /* The pixel size of the window.  */
    int pixel_width;
    int pixel_height;

243 244 245 246 247
    /* The pixel sizes of the window at the last time
       `window-size-change-functions' was run.  */
    int pixel_width_before_size_change;
    int pixel_height_before_size_change;

248 249
    /* The size of the window.  */
    int total_cols;
250
    int total_lines;
251

252
    /* Number of columns display within the window is scrolled to the left.  */
253
    ptrdiff_t hscroll;
254 255 256

    /* Minimum hscroll for automatic hscrolling.  This is the value
       the user has set, by set-window-hscroll for example.  */
257
    ptrdiff_t min_hscroll;
258

259 260 261 262
    /* Maximum line length in pixels within window bound by size of
       window (set up by set_horizontal_scroll_bar).  */
    ptrdiff_t hscroll_whole;

263 264 265 266 267 268 269 270 271
    /* Displayed buffer's text modification events counter as of last time
       display completed.  */
    EMACS_INT last_modified;

    /* Displayed buffer's overlays modification events counter as of last
       complete update.  */
    EMACS_INT last_overlay_modified;

    /* Value of point at that time.  Since this is a position in a buffer,
272
       it should be positive.  */
273 274
    ptrdiff_t last_point;

275 276 277 278 279 280 281 282 283 284 285 286 287
    /* Line number and position of a line somewhere above the top of the
       screen.  If this field is zero, it means we don't have a base line.  */
    ptrdiff_t base_line_number;

    /* If this field is zero, it means we don't have a base line.
       If it is -1, it means don't display the line number as long
       as the window shows its buffer.  */
    ptrdiff_t base_line_pos;

    /* The column number currently displayed in this window's mode
       line, or -1 if column numbers are not being displayed.  */
    ptrdiff_t column_number_displayed;

288 289
    /* Scaling factor for the glyph_matrix size calculation in this window.
       Used if window contains many small images or uses proportional fonts,
290
       as the normal may yield a matrix which is too small.  */
291 292
    int nrows_scale_factor, ncols_scale_factor;

293 294 295
    /* Intended cursor position.   This is a position within the
       glyph matrix.  */
    struct cursor_pos cursor;
296

297 298
    /* Where the cursor actually is.  */
    struct cursor_pos phys_cursor;
299

300 301 302
    /* Internally used for redisplay purposes.  */
    struct cursor_pos output_cursor;

303 304 305 306
    /* Vertical cursor position as of last update that completed
       without pause.  This is the position of last_point.  */
    int last_cursor_vpos;

307 308 309 310 311 312 313
#ifdef HAVE_WINDOW_SYSTEM

    /* Cursor type of last cursor drawn on the window.  */
    enum text_cursor_kinds phys_cursor_type;

    /* Width of the cursor above.  */
    int phys_cursor_width;
314 315 316

    /* This is handy for undrawing the cursor.  */
    int phys_cursor_ascent, phys_cursor_height;
317

318 319
#endif /* HAVE_WINDOW_SYSTEM */

320 321 322 323 324
    /* Width of left and right fringes, in pixels.
       A value of -1 means use frame values.  */
    int left_fringe_width;
    int right_fringe_width;

325 326 327 328
    /* Requested width of left and right marginal areas in columns.  A
       value of 0 means no margin.  The actual values are recorded in
       the window's glyph matrix, in the left_margin_glyphs and
       right_margin_glyphs members.  */
329 330 331
    int left_margin_cols;
    int right_margin_cols;

332 333 334 335
    /* Pixel width of scroll bars.
       A value of -1 means use frame values.  */
    int scroll_bar_width;

336 337 338 339
    /* Pixel height of scroll bars.
       A value of -1 means use frame values.  */
    int scroll_bar_height;

340 341 342 343 344 345
    /* Effective height of the mode line, or -1 if not known.  */
    int mode_line_height;

    /* Effective height of the header line, or -1 if not known.  */
    int header_line_height;

346
    /* Z - the buffer position of the last glyph in the current
347
       matrix of W.  Only valid if window_end_valid is true.  */
348 349 350
    ptrdiff_t window_end_pos;

    /* Glyph matrix row of the last glyph in the current matrix
351
       of W.  Only valid if window_end_valid is true.  */
352 353
    int window_end_vpos;

354 355
    /* True if this window is a minibuffer window.  */
    bool_bf mini : 1;
356

357 358 359
    /* Meaningful for internal windows only: true if this window is a
       horizontal combination, false if it is a vertical
       combination.  */
360
    bool_bf horizontal : 1;
361

362 363
    /* True means must regenerate mode line of this window.  */
    bool_bf update_mode_line : 1;
364

365
    /* True if the buffer was "modified" when the window
366
       was last updated.  */
367
    bool_bf last_had_star : 1;
368

369
    /* True means current value of `start'
370
       was the beginning of a line when it was chosen.  */
371
    bool_bf start_at_line_beg : 1;
372

373
    /* True means next redisplay must use the value of start
374
       set up for it in advance.  Set by scrolling commands.  */
375
    bool_bf force_start : 1;
376

377
    /* True means we have explicitly changed the value of start,
378 379 380
       but that the next redisplay is not obliged to use the new value.
       This is used in Fdelete_other_windows to force a call to
       Vwindow_scroll_functions; also by Frecenter with argument.  */
381
    bool_bf optional_new_start : 1;
382

383
    /* True means the cursor is currently displayed.  This can be
384
       set to zero by functions overpainting the cursor image.  */
385
    bool_bf phys_cursor_on_p : 1;
386

387
    /* False means cursor is logically on, true means it's off.  Used for
388
       blinking cursor.  */
389
    bool_bf cursor_off_p : 1;
390 391

    /* Value of cursor_off_p as of the last redisplay.  */
392
    bool_bf last_cursor_off_p : 1;
393

394
    /* True means desired matrix has been build and window must be
395
       updated in update_frame.  */
396
    bool_bf must_be_updated_p : 1;
397 398

    /* Flag indicating that this window is not a real one.
399 400
       Currently only used for menu bar windows, for tool bar windows,
       and for tooltips.  */
401
    bool_bf pseudo_window_p : 1;
402

403
    /* True means fringes are drawn outside display margins.
404
       Otherwise draw them between margin areas and text.  */
405
    bool_bf fringes_outside_margins : 1;
406

407 408
    /* True if window_end_pos and window_end_vpos are truly valid.
       This is false if nontrivial redisplay is preempted since in that case
409
       the frame image that window_end_pos did not get onto the frame.  */
410
    bool_bf window_end_valid : 1;
411 412

    /* True if it needs to be redisplayed.  */
413
    bool_bf redisplay : 1;
414

415 416 417 418
    /* True if auto hscrolling is currently suspended in this
       window.  */
    bool_bf suspend_auto_hscroll : 1;

419 420 421
    /* Amount by which lines of this window are scrolled in
       y-direction (smooth scrolling).  */
    int vscroll;
422

423
    /* Z_BYTE - buffer position of the last glyph in the current matrix of W.
424
       Should be nonnegative, and only valid if window_end_valid is true.  */
425
    ptrdiff_t window_end_bytepos;
426
  };
Jim Blandy's avatar
Jim Blandy committed
427

428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
INLINE bool
WINDOWP (Lisp_Object a)
{
  return PSEUDOVECTORP (a, PVEC_WINDOW);
}

INLINE void
CHECK_WINDOW (Lisp_Object x)
{
  CHECK_TYPE (WINDOWP (x), Qwindowp, x);
}

INLINE struct window *
XWINDOW (Lisp_Object a)
{
  eassert (WINDOWP (a));
  return XUNTAG (a, Lisp_Vectorlike);
}

Paul Eggert's avatar
Paul Eggert committed
447 448
/* Most code should use these functions to set Lisp fields in struct
   window.  */
Paul Eggert's avatar
Paul Eggert committed
449
INLINE void
Paul Eggert's avatar
Paul Eggert committed
450 451 452 453
wset_frame (struct window *w, Lisp_Object val)
{
  w->frame = val;
}
454

Paul Eggert's avatar
Paul Eggert committed
455
INLINE void
Paul Eggert's avatar
Paul Eggert committed
456 457 458 459
wset_next (struct window *w, Lisp_Object val)
{
  w->next = val;
}
460

Paul Eggert's avatar
Paul Eggert committed
461
INLINE void
Paul Eggert's avatar
Paul Eggert committed
462 463 464 465
wset_prev (struct window *w, Lisp_Object val)
{
  w->prev = val;
}
466

Paul Eggert's avatar
Paul Eggert committed
467
INLINE void
Paul Eggert's avatar
Paul Eggert committed
468 469 470 471
wset_redisplay_end_trigger (struct window *w, Lisp_Object val)
{
  w->redisplay_end_trigger = val;
}
472 473 474 475 476 477 478

INLINE void
wset_new_pixel (struct window *w, Lisp_Object val)
{
  w->new_pixel = val;
}

Paul Eggert's avatar
Paul Eggert committed
479
INLINE void
Paul Eggert's avatar
Paul Eggert committed
480 481 482 483
wset_vertical_scroll_bar (struct window *w, Lisp_Object val)
{
  w->vertical_scroll_bar = val;
}
484

485 486 487 488 489 490 491 492 493 494 495 496
INLINE void
wset_horizontal_scroll_bar (struct window *w, Lisp_Object val)
{
  w->horizontal_scroll_bar = val;
}

INLINE void
wset_horizontal_scroll_bar_type (struct window *w, Lisp_Object val)
{
  w->horizontal_scroll_bar_type = val;
}

Paul Eggert's avatar
Paul Eggert committed
497
INLINE void
498 499 500 501
wset_prev_buffers (struct window *w, Lisp_Object val)
{
  w->prev_buffers = val;
}
502

Paul Eggert's avatar
Paul Eggert committed
503
INLINE void
504 505 506 507
wset_next_buffers (struct window *w, Lisp_Object val)
{
  w->next_buffers = val;
}
Paul Eggert's avatar
Paul Eggert committed
508

509
/* True if W is a minibuffer window.  */
510
#define MINI_WINDOW_P(W) ((W)->mini)
Jim Blandy's avatar
Jim Blandy committed
511

512 513 514 515
/* True if W is a minibuffer window on a frame that contains at least
   one other window.  */
#define MINI_NON_ONLY_WINDOW_P(W)	 \
  (MINI_WINDOW_P (W) && !NILP ((W)->prev))
516

517 518 519
/* True if W is a minibuffer window that is alone on its frame.  */
#define MINI_ONLY_WINDOW_P(W)		 \
  (MINI_WINDOW_P (W) && NILP ((W)->prev))
Jim Blandy's avatar
Jim Blandy committed
520

521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541
/* General window layout:

   LEFT_EDGE_COL         RIGHT_EDGE_COL
   |                                  |
   |                                  |
   |  BOX_LEFT_EDGE_COL               |
   |  |           BOX_RIGHT_EDGE_COL  |
   |  |                            |  |
   v  v                            v  v
   <-><-><---><-----------><---><-><->
    ^  ^   ^        ^        ^   ^  ^
    |  |   |        |        |   |  |
    |  |   |        |        |   |  +-- RIGHT_SCROLL_BAR_COLS
    |  |   |        |        |   +----- RIGHT_FRINGE_WIDTH
    |  |   |        |        +--------- RIGHT_MARGIN_COLS
    |  |   |        |
    |  |   |        +------------------ TEXT_AREA_COLS
    |  |   |
    |  |   +--------------------------- LEFT_MARGIN_COLS
    |  +------------------------------- LEFT_FRINGE_WIDTH
    +---------------------------------- LEFT_SCROLL_BAR_COLS
542

543 544 545 546 547
*/


/* A handy macro.  */

548
/* Non-nil if window W is leaf window (has a buffer).  */
549 550 551
#define WINDOW_LEAF_P(W) \
  (BUFFERP ((W)->contents))

552
/* Non-nil if window W is internal (is a parent window).  */
553 554
#define WINDOW_INTERNAL_P(W) \
  (WINDOWP ((W)->contents))
555

556
/* True if window W is a horizontal combination of windows.  */
557
#define WINDOW_HORIZONTAL_COMBINATION_P(W) \
558
  (WINDOW_INTERNAL_P (W) && (W)->horizontal)
559

560
/* True if window W is a vertical combination of windows.  */
561
#define WINDOW_VERTICAL_COMBINATION_P(W) \
562
  (WINDOW_INTERNAL_P (W) && !(W)->horizontal)
563

564
/* Window W's XFRAME.  */
565
#define WINDOW_XFRAME(W) (XFRAME (WINDOW_FRAME ((W))))
566

567
/* Whether window W is a pseudo window.  */
568
#define WINDOW_PSEUDO_P(W) ((W)->pseudo_window_p)
569

570 571 572 573 574 575
/* Window W's buffer.  */
#define WINDOW_BUFFER(W)			\
  (WINDOW_LEAF_P(W)				\
   ? (W)->contents				\
   : Qnil)					\

576
/* Return the canonical column width of the frame of window W.  */
577 578 579
#define WINDOW_FRAME_COLUMN_WIDTH(W) \
  (FRAME_COLUMN_WIDTH (WINDOW_XFRAME ((W))))

580
/* Return the canonical line height of the frame of window W.  */
581 582 583
#define WINDOW_FRAME_LINE_HEIGHT(W) \
  (FRAME_LINE_HEIGHT (WINDOW_XFRAME ((W))))

584 585
/* Return the pixel width of window W.  This includes dividers, scroll
   bars, fringes and margins, if any.  */
586
#define WINDOW_PIXEL_WIDTH(W) (W)->pixel_width
587

588 589
/* Return the pixel height of window W.  This includes dividers, scroll
   bars, header and mode lines, if any.  */
590 591
#define WINDOW_PIXEL_HEIGHT(W) (W)->pixel_height

592 593 594
/* Return the width of window W in canonical column units.  This
   includes dividers, scroll bars, fringes and margins, if any.  The
   value is adjusted such that the sum of the widths of all child
595
   windows equals the width of their parent window.  */
596
#define WINDOW_TOTAL_COLS(W) (W)->total_cols
597

598 599 600 601
/* Return the height of window W in canonical line units.  This includes
   dividers, scroll bars, header and mode lines, if any.  The value is
   adjusted such that the sum of the heights of all child windows equals
   the height of their parent window.  */
602
#define WINDOW_TOTAL_LINES(W) (W)->total_lines
603

604 605
/* The smallest acceptable dimensions for a window.  Anything smaller
   might crash Emacs.  */
606 607 608 609
#define MIN_SAFE_WINDOW_WIDTH (2)

#define MIN_SAFE_WINDOW_PIXEL_WIDTH(W) \
  (2 * WINDOW_FRAME_COLUMN_WIDTH (W))
610 611

#define MIN_SAFE_WINDOW_HEIGHT (1)
612

613 614 615
#define MIN_SAFE_WINDOW_PIXEL_HEIGHT(W) \
  (WINDOW_FRAME_LINE_HEIGHT (W))

616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643
/* True if window W has no other windows to its left on its frame.  */
#define WINDOW_LEFTMOST_P(W)			\
  (WINDOW_LEFT_PIXEL_EDGE (W) == 0)

/* True if window W has no other windows above it on its frame.  */
#define WINDOW_TOPMOST_P(W)			\
  (WINDOW_TOP_PIXEL_EDGE (W) == 0)

/* True if window W has no other windows to its right on its frame.  */
#define WINDOW_RIGHTMOST_P(W)					\
  (WINDOW_RIGHT_PIXEL_EDGE (W)					\
   == (WINDOW_RIGHT_PIXEL_EDGE					\
       (XWINDOW (FRAME_ROOT_WINDOW (WINDOW_XFRAME (W))))))	\

/* True if window W has no other windows below it on its frame (the
   minibuffer window is not counted in this respect unless W itself is a
   minibuffer window).  */
#define WINDOW_BOTTOMMOST_P(W)					\
  (WINDOW_BOTTOM_PIXEL_EDGE (W)					\
   == (WINDOW_BOTTOM_PIXEL_EDGE					\
       (XWINDOW (FRAME_ROOT_WINDOW (WINDOW_XFRAME (W))))))	\

/* True if window W takes up the full width of its frame.  */
#define WINDOW_FULL_WIDTH_P(W)					\
  (WINDOW_PIXEL_WIDTH (W)					\
   == (WINDOW_PIXEL_WIDTH					\
       (XWINDOW (FRAME_ROOT_WINDOW (WINDOW_XFRAME (W))))))	\

644 645
/* Width of right divider of window W.  */
#define WINDOW_RIGHT_DIVIDER_WIDTH(W)				\
646 647 648 649 650 651 652 653 654 655 656
  (WINDOW_RIGHTMOST_P (W)					\
   ? 0 : FRAME_RIGHT_DIVIDER_WIDTH (WINDOW_XFRAME (W)))

/* Width of bottom divider of window W.  */
#define WINDOW_BOTTOM_DIVIDER_WIDTH(W)					\
  (((WINDOW_BOTTOMMOST_P (W)						\
     && NILP ((XWINDOW (FRAME_ROOT_WINDOW				\
			(WINDOW_XFRAME (W))))->next))			\
    || EQ ((W)->prev, FRAME_ROOT_WINDOW (WINDOW_XFRAME (W)))		\
    || (W)->pseudo_window_p)						\
   ? 0 : FRAME_BOTTOM_DIVIDER_WIDTH (WINDOW_XFRAME (W)))
657

658 659
/* Return the canonical frame column at which window W starts.
   This includes a left-hand scroll bar, if any.  */
660
#define WINDOW_LEFT_EDGE_COL(W) (W)->left_col
661 662

/* Return the canonical frame column before which window W ends.
663
   This includes a right-hand scroll bar, if any.  */
664 665
#define WINDOW_RIGHT_EDGE_COL(W) \
  (WINDOW_LEFT_EDGE_COL (W) + WINDOW_TOTAL_COLS (W))
666

667 668
/* Return the canonical frame line at which window W starts.
   This includes a header line, if any.  */
669
#define WINDOW_TOP_EDGE_LINE(W) (W)->top_line
670 671 672 673 674 675

/* Return the canonical frame line before which window W ends.
   This includes a mode line, if any.  */
#define WINDOW_BOTTOM_EDGE_LINE(W) \
  (WINDOW_TOP_EDGE_LINE (W) + WINDOW_TOTAL_LINES (W))

676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692
/* Return the left pixel edge at which window W starts.
   This includes a left-hand scroll bar, if any.  */
#define WINDOW_LEFT_PIXEL_EDGE(W) (W)->pixel_left

/* Return the right pixel edge before which window W ends.
   This includes a right-hand scroll bar, if any.  */
#define WINDOW_RIGHT_PIXEL_EDGE(W) \
  (WINDOW_LEFT_PIXEL_EDGE (W) + WINDOW_PIXEL_WIDTH (W))

/* Return the top pixel edge at which window W starts.
   This includes a header line, if any.  */
#define WINDOW_TOP_PIXEL_EDGE(W) (W)->pixel_top

/* Return the bottom pixel edge before which window W ends.
   This includes a mode line, if any.  */
#define WINDOW_BOTTOM_PIXEL_EDGE(W) \
  (WINDOW_TOP_PIXEL_EDGE (W) + WINDOW_PIXEL_HEIGHT (W))
693 694 695 696 697

/* Return the frame x-position at which window W starts.
   This includes a left-hand scroll bar, if any.  */
#define WINDOW_LEFT_EDGE_X(W) \
  (FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W)) \
698
   + WINDOW_LEFT_PIXEL_EDGE (W))
699 700 701 702 703

/* Return the frame x- position before which window W ends.
   This includes a right-hand scroll bar, if any.  */
#define WINDOW_RIGHT_EDGE_X(W) \
  (FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W)) \
704
   + WINDOW_RIGHT_PIXEL_EDGE (W))
705

706
/* True if W is a menu bar window.  */
707
#if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
708
#define WINDOW_MENU_BAR_P(W) \
709 710
  (WINDOWP (WINDOW_XFRAME (W)->menu_bar_window) \
   && (W) == XWINDOW (WINDOW_XFRAME (W)->menu_bar_window))
711 712
#else
/* No menu bar windows if X toolkit is in use.  */
713
#define WINDOW_MENU_BAR_P(W) false
714
#endif
715

716
/* True if W is a tool bar window.  */
717
#if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
718
#define WINDOW_TOOL_BAR_P(W) \
719 720
  (WINDOWP (WINDOW_XFRAME (W)->tool_bar_window) \
   && (W) == XWINDOW (WINDOW_XFRAME (W)->tool_bar_window))
721
#else
722
#define WINDOW_TOOL_BAR_P(W) false
723
#endif
724

725
/* Return the frame y-position at which window W starts.  */
726
#define WINDOW_TOP_EDGE_Y(W) \
727 728
  (((WINDOW_MENU_BAR_P (W) || WINDOW_TOOL_BAR_P (W)) \
    ? 0 : FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W))) \
729
   + WINDOW_TOP_PIXEL_EDGE (W))
730

731
/* Return the frame y-position before which window W ends.  */
732 733
#define WINDOW_BOTTOM_EDGE_Y(W)				   \
  (((WINDOW_MENU_BAR_P (W) || WINDOW_TOOL_BAR_P (W))	   \
734
    ? 0 : FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W))) \
735
   + WINDOW_BOTTOM_PIXEL_EDGE (W))
736

737 738
/* Return the pixel value where the text (or left fringe) in window W
   starts.  */
739 740 741 742 743 744 745 746 747 748 749 750
#define WINDOW_BOX_LEFT_PIXEL_EDGE(W)		\
  (WINDOW_LEFT_PIXEL_EDGE (W)			\
   + WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (W))

/* Return the pixel value before which the text in window W ends.  This
   is different from the `RIGHT_EDGE' because it does not include a
   right-hand scroll bar or window-separating line on the right
   edge.  */
#define WINDOW_BOX_RIGHT_PIXEL_EDGE(W)		\
  (WINDOW_RIGHT_PIXEL_EDGE (W)			\
   - WINDOW_RIGHT_DIVIDER_WIDTH (W)		\
   - WINDOW_RIGHT_SCROLL_BAR_AREA_WIDTH (W))
751

752 753 754
/* Return the frame x-position at which the text (or left fringe) in
   window W starts.  This does not include a left-hand scroll bar if
   any.  */
755
#define WINDOW_BOX_LEFT_EDGE_X(W)		   \
756
  (FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W)) \
757
   + WINDOW_BOX_LEFT_PIXEL_EDGE (W))
758

759 760 761
/* Return the frame x-position before which the text in window W ends.
   This does not include a scroll bar, divider or window-separating line
   on the right edge.  */
762
#define WINDOW_BOX_RIGHT_EDGE_X(W)		   \
763
  (FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W)) \
764
   + WINDOW_BOX_RIGHT_PIXEL_EDGE (W))
765

766
/* Widths of marginal areas in columns.  */
767
#define WINDOW_LEFT_MARGIN_COLS(W) (W->left_margin_cols)
768

769
#define WINDOW_RIGHT_MARGIN_COLS(W) (W->right_margin_cols)
770

771 772 773
#define WINDOW_MARGINS_COLS(W)			\
  (WINDOW_LEFT_MARGIN_COLS (W)			\
   + WINDOW_RIGHT_MARGIN_COLS (W))
774

775
/* Widths of marginal areas in pixels.  */
776 777
#define WINDOW_LEFT_MARGIN_WIDTH(W)			\
  (W->left_margin_cols * WINDOW_FRAME_COLUMN_WIDTH (W))
778

779
#define WINDOW_RIGHT_MARGIN_WIDTH(W)				\
780
  (W->right_margin_cols * WINDOW_FRAME_COLUMN_WIDTH (W))
781

782 783 784
#define WINDOW_MARGINS_WIDTH(W)			\
  (WINDOW_LEFT_MARGIN_WIDTH (W)			\
   + WINDOW_RIGHT_MARGIN_WIDTH (W))
785

786 787 788 789 790 791 792 793 794 795 796 797 798 799
/* Pixel-widths of fringes.  */
#define WINDOW_LEFT_FRINGE_WIDTH(W)			\
  (W->left_fringe_width >= 0				\
   ? W->left_fringe_width				\
   : FRAME_LEFT_FRINGE_WIDTH (WINDOW_XFRAME (W)))

#define WINDOW_RIGHT_FRINGE_WIDTH(W)			\
  (W->right_fringe_width >= 0				\
   ? W->right_fringe_width				\
   : FRAME_RIGHT_FRINGE_WIDTH (WINDOW_XFRAME (W)))

#define WINDOW_FRINGES_WIDTH(W)		\
  (WINDOW_LEFT_FRINGE_WIDTH (W) + WINDOW_RIGHT_FRINGE_WIDTH (W))

800 801
/* Are fringes outside display margins in window W.  */
#define WINDOW_HAS_FRINGES_OUTSIDE_MARGINS(W)	\
802
  ((W)->fringes_outside_margins)
803

804
/* Say whether vertical scroll bars are currently enabled for window W,
805
   and which side they are on.  */
806 807 808 809 810 811
#define WINDOW_VERTICAL_SCROLL_BAR_TYPE(W)		\
  (WINDOW_PSEUDO_P (W)					\
   ? vertical_scroll_bar_none				\
   : EQ (W->vertical_scroll_bar_type, Qt)		\
   ? FRAME_VERTICAL_SCROLL_BAR_TYPE (WINDOW_XFRAME (W))	\
   : EQ (W->vertical_scroll_bar_type, Qleft)		\
812
   ? vertical_scroll_bar_left				\
813
   : EQ (W->vertical_scroll_bar_type, Qright)		\
814
   ? vertical_scroll_bar_right				\
815 816 817 818 819 820 821 822 823 824 825 826
   : vertical_scroll_bar_none)

#define WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT(W)			\
  (WINDOW_VERTICAL_SCROLL_BAR_TYPE (W) == vertical_scroll_bar_left)

#define WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT(W)			\
  (WINDOW_VERTICAL_SCROLL_BAR_TYPE (W) == vertical_scroll_bar_right)

#define WINDOW_HAS_VERTICAL_SCROLL_BAR(W)		\
  (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (W)		\
   || WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (W))

827
#if (defined (HAVE_WINDOW_SYSTEM)					\
828
     && ((defined (USE_TOOLKIT_SCROLL_BARS))	\
829
	 || defined (HAVE_NTGUI)))
830 831 832 833 834 835 836 837
# define USE_HORIZONTAL_SCROLL_BARS true
#else
# define USE_HORIZONTAL_SCROLL_BARS false
#endif

/* Say whether horizontal scroll bars are currently enabled for window
   W.  Horizontal scrollbars exist for toolkit versions only.  */
#if USE_HORIZONTAL_SCROLL_BARS
838 839 840 841 842 843 844 845 846 847 848
#define WINDOW_HAS_HORIZONTAL_SCROLL_BAR(W)			\
  ((WINDOW_PSEUDO_P (W) || MINI_NON_ONLY_WINDOW_P (W))		\
   ? false							\
   : EQ (W->horizontal_scroll_bar_type, Qt)			\
   ? FRAME_HAS_HORIZONTAL_SCROLL_BARS (WINDOW_XFRAME (W))	\
   : EQ (W->horizontal_scroll_bar_type, Qbottom)		\
   ? true							\
   : false)
#else
#define WINDOW_HAS_HORIZONTAL_SCROLL_BAR(W) false
#endif
849 850 851 852

/* Width that a scroll bar in window W should have, if there is one.
   Measured in pixels.  If scroll bars are turned off, this is still
   nonzero.  */
853 854 855 856
#define WINDOW_CONFIG_SCROLL_BAR_WIDTH(W)		\
  (W->scroll_bar_width >= 0				\
   ? W->scroll_bar_width				\
   : FRAME_CONFIG_SCROLL_BAR_WIDTH (WINDOW_XFRAME (W)))
857 858 859 860

/* Width that a scroll bar in window W should have, if there is one.
   Measured in columns (characters).  If scroll bars are turned off,
   this is still nonzero.  */
861 862 863 864 865 866
#define WINDOW_CONFIG_SCROLL_BAR_COLS(W)		\
  (W->scroll_bar_width >= 0				\
   ? ((W->scroll_bar_width				\
       + WINDOW_FRAME_COLUMN_WIDTH (W) - 1)		\
      / WINDOW_FRAME_COLUMN_WIDTH (W))			\
   : FRAME_CONFIG_SCROLL_BAR_COLS (WINDOW_XFRAME (W)))
867

868 869 870
/* Width of left scroll bar in window W, measured in columns
   (characters).  If scroll bars are on the right in this frame, or
   there are no scroll bars, value is 0.  */
871 872 873
#define WINDOW_LEFT_SCROLL_BAR_COLS(W)	       \
  (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (W)  \
   ? (WINDOW_CONFIG_SCROLL_BAR_COLS (W))       \
874 875
   : 0)

876 877 878
/* Width of right scroll bar in window W, measured in columns
   (characters).  If scroll bars are on the left in this frame, or there
   are no scroll bars, value is 0.  */
879 880 881
#define WINDOW_RIGHT_SCROLL_BAR_COLS(W)		\
  (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (W)	\
   ? WINDOW_CONFIG_SCROLL_BAR_COLS (W)		\
882 883
   : 0)

884
/* Width of a scroll bar in window W, measured in columns.  */
885 886 887
#define WINDOW_SCROLL_BAR_COLS(W)	       \
  (WINDOW_HAS_VERTICAL_SCROLL_BAR (W)	       \
   ? WINDOW_CONFIG_SCROLL_BAR_COLS (W)	       \
888 889
   : 0)

890
/* Width of a left scroll bar area in window W, measured in pixels.  */
891 892 893
#define WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH(W)				\
  (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (W)				\
   ? WINDOW_CONFIG_SCROLL_BAR_WIDTH (W)					\
894
   : 0)
895

896
/* Width of a right scroll bar area in window W, measured in pixels.  */
897 898 899
#define WINDOW_RIGHT_SCROLL_BAR_AREA_WIDTH(W)				\
  (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (W)				\
   ? WINDOW_CONFIG_SCROLL_BAR_WIDTH (W)					\
900 901
   : 0)

902
/* Width of scroll bar area in window W, measured in pixels.  */
903 904 905
#define WINDOW_SCROLL_BAR_AREA_WIDTH(W)					\
  (WINDOW_HAS_VERTICAL_SCROLL_BAR (W)					\
   ? WINDOW_CONFIG_SCROLL_BAR_WIDTH (W)					\
906
   : 0)
907

908 909
/* Return the frame position where the vertical scroll bar of window W
   starts.  */
910 911 912 913 914
#define WINDOW_SCROLL_BAR_AREA_X(W)		\
  (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (W)	\
   ? WINDOW_BOX_RIGHT_EDGE_X (W)		\
   : WINDOW_LEFT_EDGE_X (W))

915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944
/* Height that a scroll bar in window W should have, if there is one.
   Measured in pixels.  If scroll bars are turned off, this is still
   nonzero.  */
#define WINDOW_CONFIG_SCROLL_BAR_HEIGHT(W)			\
  (W->scroll_bar_height >= 0					\
   ? W->scroll_bar_height					\
   : FRAME_CONFIG_SCROLL_BAR_HEIGHT (WINDOW_XFRAME (W)))

/* Height that a scroll bar in window W should have, if there is one.
   Measured in lines (characters).  If scroll bars are turned off, this
   is still nonzero.  */
#define WINDOW_CONFIG_SCROLL_BAR_LINES(W)		\
  (W->scroll_bar_height >= 0				\
   ? ((W->scroll_bar_height				\
       + WINDOW_FRAME_LINE_HEIGHT (W) - 1)		\
      / WINDOW_FRAME_LINE_HEIGHT (W))			\
   : FRAME_CONFIG_SCROLL_BAR_LINES (WINDOW_XFRAME (W)))

/* Height of a scroll bar in window W, measured in columns.  */
#define WINDOW_SCROLL_BAR_LINES(W)	       \
  (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (W)	       \
   ? WINDOW_CONFIG_SCROLL_BAR_LINES (W)	       \
   : 0)

/* Height of scroll bar area in window W, measured in pixels.  */
#define WINDOW_SCROLL_BAR_AREA_HEIGHT(W)	\
  (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (W)		\
   ? WINDOW_CONFIG_SCROLL_BAR_HEIGHT (W)	\
   : 0)

945
/* Height in pixels of the mode line.
946
   May be zero if W doesn't have a mode line.  */
947
#define WINDOW_MODE_LINE_HEIGHT(W)	\
948
  (window_wants_mode_line ((W))		\
949 950 951
   ? CURRENT_MODE_LINE_HEIGHT (W)	\
   : 0)

952
#define WINDOW_MODE_LINE_LINES(W)	\
953
  window_wants_mode_line (W)
954

955
/* Height in pixels of the header line.
956
   Zero if W doesn't have a header line.  */
957
#define WINDOW_HEADER_LINE_HEIGHT(W)	\
958
  (window_wants_header_line (W)		\
959 960 961
   ? CURRENT_HEADER_LINE_HEIGHT (W)	\
   : 0)

962
#define WINDOW_HEADER_LINE_LINES(W)	\
963
  window_wants_header_line (W)
964

965 966
/* Pixel height of window W without mode line, bottom scroll bar and
   bottom divider.  */
967
#define WINDOW_BOX_HEIGHT_NO_MODE_LINE(W)	\
968
  (WINDOW_PIXEL_HEIGHT (W)			\
969
   - WINDOW_BOTTOM_DIVIDER_WIDTH (W)		\
970 971
   - WINDOW_SCROLL_BAR_AREA_HEIGHT (W)		\
   - WINDOW_MODE_LINE_HEIGHT (W))
972

973 974
/* Pixel height of window W without mode and header line and bottom
   divider.  */
975
#define WINDOW_BOX_TEXT_HEIGHT(W)	\
976 977
  (WINDOW_PIXEL_HEIGHT ((W))		\
   - WINDOW_BOTTOM_DIVIDER_WIDTH (W)	\
978 979 980 981 982 983 984 985 986 987
   - WINDOW_SCROLL_BAR_AREA_HEIGHT (W)	\
   - WINDOW_MODE_LINE_HEIGHT (W)	\
   - WINDOW_HEADER_LINE_HEIGHT (W))

/* Return the frame position where the horizontal scroll bar of window W
   starts.  */
#define WINDOW_SCROLL_BAR_AREA_Y(W)			\
  (WINDOW_TOP_EDGE_Y (W)				\
   + (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (W)		\
      ? WINDOW_BOX_HEIGHT_NO_MODE_LINE (W) : 0))
988 989

/* Convert window W relative pixel X to frame pixel coordinates.  */
990
#define WINDOW_TO_FRAME_PIXEL_X(W, X)	\
991 992 993
  ((X) + WINDOW_BOX_LEFT_EDGE_X ((W)))

/* Convert window W relative pixel Y to frame pixel coordinates.  */
994 995
#define WINDOW_TO_FRAME_PIXEL_Y(W, Y)		\
  ((Y) + WINDOW_TOP_EDGE_Y (W))
996 997

/* Convert frame relative pixel X to window relative pixel X.  */
998
#define FRAME_TO_WINDOW_PIXEL_X(W, X)		\
999 1000 1001
  ((X) - WINDOW_BOX_LEFT_EDGE_X ((W)))

/* Convert frame relative pixel Y to window relative pixel Y.  */
1002 1003
#define FRAME_TO_WINDOW_PIXEL_Y(W, Y)		\
  ((Y) - WINDOW_TOP_EDGE_Y (W))
1004 1005 1006

/* Convert a text area relative x-position in window W to frame X
   pixel coordinates.  */
1007
#define WINDOW_TEXT_TO_FRAME_PIXEL_X(W, X)	\
1008
  (window_box_left ((W), TEXT_AREA) + (X))
1009

1010 1011 1012 1013 1014
/* This is the window in which the terminal's cursor should be left when
   nothing is being done with it.  This must always be a leaf window, and its
   buffer is selected by the top level editing loop at the end of each command.

   This value is always the same as FRAME_SELECTED_WINDOW (selected_frame).  */
Jim Blandy's avatar
Jim Blandy committed
1015 1016 1017 1018 1019

extern Lisp_Object selected_window;

/* This is a time stamp for window selection, so we can find the least
   recently used window.  Its only users are Fselect_window,
Jim Blandy's avatar
Jim Blandy committed
1020
   init_window_once, and make_frame.  */
Jim Blandy's avatar
Jim Blandy committed
1021

1022
extern EMACS_INT window_select_count;
Jim Blandy's avatar
Jim Blandy committed
1023

Jim Blandy's avatar
Jim Blandy committed
1024
/* The minibuffer window of the selected frame.
Jim Blandy's avatar
Jim Blandy committed
1025
   Note that you cannot test for minibufferness of an arbitrary window
Jim Blandy's avatar
Jim Blandy committed
1026
   by comparing against this; use the MINI_WINDOW_P macro instead.  */
Jim Blandy's avatar
Jim Blandy committed
1027 1028 1029

extern Lisp_Object minibuf_window;

1030 1031 1032
/* Non-nil means it is the window whose mode line should be
   shown as the selected window when the minibuffer is selected.  */

1033
extern Lisp_Object minibuf_selected_window;
1034

Jan D's avatar
Jan D committed
1035 1036
extern Lisp_Object make_window (void);
extern Lisp_Object window_from_coordinates (struct frame *, int, int,
1037
                                            enum window_part *, bool);
1038
extern void resize_frame_windows (struct frame *, int, bool, bool);
1039
extern void restore_window_configuration (Lisp_Object);
1040
extern void delete_all_child_windows (Lisp_Object);
1041 1042
extern void grow_mini_window (struct window *, int, bool);
extern void shrink_mini_window (struct window *, bool);
1043
extern int window_relative_x_coord (struct window *, enum window_part, int);
1044

1045
void run_window_size_change_functions (Lisp_Object);
Jim Blandy's avatar
Jim Blandy committed
1046

1047
/* Make WINDOW display BUFFER.  RUN_HOOKS_P means it's allowed
1048
   to run hooks.  See make_frame for a case where it's not allowed.  */
1049

Jan D's avatar
Jan D committed
1050
void set_window_buffer (Lisp_Object window, Lisp_Object buffer,
1051
                        bool run_hooks_p, bool keep_margins_p);
1052 1053 1054 1055 1056

/* This is the window where the echo area message was displayed.  It
   is always a minibuffer window, but it may not be the same window
   currently active as a minibuffer.  */

1057 1058
extern Lisp_Object echo_area_window;

Jim Blandy's avatar
Jim Blandy committed
1059
/* Depth in recursive edits.  */
1060

1061
extern EMACS_INT command_loop_level;
Jim Blandy's avatar
Jim Blandy committed
1062 1063

/* Depth in minibuffer invocations.  */
1064

1065
extern EMACS_INT minibuf_level;
Jim Blandy's avatar
Jim Blandy committed
1066

1067 1068 1069
/* Non-zero if we should redraw the mode lines on the next redisplay.
   Usually set to a unique small integer so we can track the main causes of
   full redisplays in `redisplay--mode-lines-cause'.  */
1070

Jim Blandy's avatar
Jim Blandy committed
1071 1072
extern int update_mode_lines;

1073
/* Nonzero if window sizes or contents have changed since last
1074 1075 1076
   redisplay that finished.  Usually set to a unique small integer so
   we can track the main causes of full redisplays in
   `redisplay--all-windows-cause'.  */
1077

Jim Blandy's avatar
Jim Blandy committed
1078 1079
extern int windows_or_buffers_changed;

1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092
/* The main redisplay routine usually only redisplays the selected-window,
   so when something's changed elsewhere, we call one of the functions below
   to indicate which other windows might also need to be redisplayed.  */

extern void wset_redisplay (struct window *w);
extern void fset_redisplay (struct frame *f);
extern void bset_redisplay (struct buffer *b);
extern void bset_update_mode_line (struct buffer *b);
/* Call this to tell redisplay to look for other windows than selected-window
   that need to be redisplayed.  Calling one of the *set_redisplay functions
   above already does it, so it's only needed in unusual cases.  */
extern void redisplay_other_windows (void);

1093
/* Return a pointer to the glyph W's physical cursor is on.  Value is
Paul Eggert's avatar
Paul Eggert committed
1094
   null if W's current matrix is invalid, so that no meaningful glyph
1095 1096
   can be returned.  */

Jan D's avatar
Jan D committed
1097
struct glyph *get_phys_cursor_glyph (struct window *w);
1098

1099
/* True if WINDOW is a valid window.  */
1100 1101 1102 1103 1104
#define WINDOW_VALID_P(WINDOW)					\
  (WINDOWP (WINDOW) && !NILP (XWINDOW (WINDOW)->contents))	\

/* A window of any sort, leaf or interior, is "valid" if its
   contents slot is non-nil.  */
1105 1106
#define CHECK_VALID_WINDOW(WINDOW)				\
  CHECK_TYPE (WINDOW_VALID_P (WINDOW), Qwindow_valid_p, WINDOW)
Gerd Moellmann's avatar
Gerd Moellmann committed
1107

1108
/* True if WINDOW is a live window.  */
1109
#define WINDOW_LIVE_P(WINDOW)					\
1110
  (WINDOWP (WINDOW) && BUFFERP (XWINDOW (WINDOW)->contents))
1111

1112 1113 1114 1115
/* A window is "live" if and only if it shows a buffer.  */
#define CHECK_LIVE_WINDOW(WINDOW)				\
  CHECK_TYPE (WINDOW_LIVE_P (WINDOW), Qwindow_live_p, WINDOW)

1116 1117 1118
/* These used to be in lisp.h.  */
extern Lisp_Object Vwindow_list;

1119
extern Lisp_Object window_list (void);
1120
extern Lisp_Object window_parameter (struct window *, Lisp_Object parameter);
1121
extern struct window *decode_live_window (Lisp_Object);
1122
extern struct window *decode_any_window (Lisp_Object);
1123
extern bool compare_window_configurations (Lisp_Object, Lisp_Object, bool);
Jan D's avatar
Jan D committed
1124
extern void mark_window_cursors_off (struct window *);
1125 1126
extern bool window_wants_mode_line (struct window *);
extern bool window_wants_header_line (struct window *);
Jan D's avatar
Jan D committed
1127
extern int window_internal_height (struct window *);
1128
extern int window_body_width (struct window *w, bool);
1129 1130
enum margin_unit { MARGIN_IN_LINES, MARGIN_IN_PIXELS };
extern int window_scroll_margin (struct window *, enum margin_unit);
Jan D's avatar
Jan D committed
1131
extern void temp_output_buffer_show (Lisp_Object);
1132
extern void replace_buffer_in_windows (Lisp_Object);
1133
extern void replace_buffer_in_windows_safely (Lisp_Object);
1134
extern void sanitize_window_sizes (Lisp_Object horizontal);
Dmitry Antipov's avatar
Dmitry Antipov committed
1135 1136
/* This looks like a setter, but it is a bit special.  */
extern void wset_buffer (struct window *, Lisp_Object);
1137
extern bool window_outdated (struct window *);
Jan D's avatar
Jan D committed
1138 1139 1140 1141
extern void init_window_once (void);
extern void init_window (void);
extern void syms_of_window (void);
extern void keys_of_window (void);
1142 1143 1144 1145 1146 1147
/* Move cursor to row/column position VPOS/HPOS, pixel coordinates
   Y/X. HPOS/VPOS are window-relative row and column numbers and X/Y
   are window-relative pixel positions.  This is always done during
   window update, so the position is the future output cursor position
   for currently updated window W.  */

Paul Eggert's avatar
Paul Eggert committed
1148
INLINE void
1149 1150 1151 1152 1153 1154 1155 1156 1157
output_cursor_to (struct window *w, int vpos, int hpos, int y, int x)
{
  eassert (w);
  w->output_cursor.hpos = hpos;
  w->output_cursor.vpos = vpos;
  w->output_cursor.x = x;
  w->output_cursor.y = y;
}

Paul Eggert's avatar
Paul Eggert committed
1158 1159
INLINE_HEADER_END