window.h 31.4 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Window definitions for GNU Emacs.
2
   Copyright (C) 1985-1986, 1993, 1995, 1997-2012
Glenn Morris's avatar
Glenn Morris committed
3
                 Free Software 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 <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
19

Gerd Moellmann's avatar
Gerd Moellmann committed
20 21 22 23
#ifndef WINDOW_H_INCLUDED
#define WINDOW_H_INCLUDED

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

25 26
extern Lisp_Object Qleft, Qright;

Jim Blandy's avatar
Jim Blandy committed
27 28 29 30 31 32 33 34 35
/* 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.

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

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
Jim Blandy's avatar
Jim Blandy committed
36
arranged on the frame.  Leaf windows never become non-leaves.
Jim Blandy's avatar
Jim Blandy committed
37 38 39 40 41 42 43 44 45 46
They are deleted only by calling delete-window on them (but
this can be done implicitly).  Combination windows can be created
and deleted at any time.

A leaf window has a non-nil buffer field, and also
 has markers in its start and pointm fields.  Non-leaf windows
 have nil in these fields.

Non-leaf windows are either vertical or horizontal combinations.

Jim Blandy's avatar
Jim Blandy committed
47
A vertical combination window has children that are arranged on the frame
Jim Blandy's avatar
Jim Blandy committed
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
one above the next.  Its vchild 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 side by side.
Its hchild 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.

The children of a vertical combination window may be leaf windows
or horizontal combination windows.  The children of a horizontal
combination window may be leaf windows or vertical combination windows.

At the top of the tree are two windows which have nil as parent.
The second of these is minibuf_window.  The first one manages all
Jim Blandy's avatar
Jim Blandy committed
66
the frame area that is not minibuffer, and is called the root window.
Jim Blandy's avatar
Jim Blandy committed
67 68 69 70 71
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 root instead.

Jim Blandy's avatar
Jim Blandy committed
72 73 74 75
In any case, on screens which have an ordinary window and a
minibuffer, prev of the minibuf window is the root window and next of
the root window is the minibuf window.  On minibufferless screens or
minibuffer-only screens, the root window and the minibuffer window are
76
one and the same, so its prev and next members are nil.
Jim Blandy's avatar
Jim Blandy committed
77

78
A dead window has its buffer, hchild, and vchild windows all nil.  */
Jim Blandy's avatar
Jim Blandy committed
79

Gerd Moellmann's avatar
Gerd Moellmann committed
80 81 82 83 84 85 86 87 88
struct cursor_pos
{
  /* Pixel position.  These are always window relative.  */
  int x, y;

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

89
/* Most code should use this macro to set Lisp fields in struct window.  */
90

91
#define WSET(w, field, value) ((w)->field = (value))
92

Jim Blandy's avatar
Jim Blandy committed
93 94
struct window
  {
95
    /* This is for Lisp; the terminal code does not refer to it.  */
96
    struct vectorlike_header header;
97

Jim Blandy's avatar
Jim Blandy committed
98
    /* The frame this window is on.  */
99
    Lisp_Object frame;
100 101 102

    /* Following (to right or down) and preceding (to left or up) child
       at same level of tree.  */
103 104
    Lisp_Object next;
    Lisp_Object prev;
105 106 107 108 109

    /* First child of this window: vchild is used if this is a vertical
       combination, hchild if this is a horizontal combination.  Of the
       fields vchild, hchild and buffer, one and only one is non-nil
       unless the window is dead.  */
110 111
    Lisp_Object hchild;
    Lisp_Object vchild;
112 113

    /* The window this one is a child of.  */
114
    Lisp_Object parent;
115 116 117

    /* The upper left corner coordinates of this window, as integers
       relative to upper left corner of frame = 0, 0.  */
118 119
    Lisp_Object left_col;
    Lisp_Object top_line;
120 121

    /* The size of the window.  */
122 123
    Lisp_Object total_lines;
    Lisp_Object total_cols;
124 125

    /* The normal size of the window.  */
126 127
    Lisp_Object normal_lines;
    Lisp_Object normal_cols;
128 129

    /* New sizes of the window.  */
130 131
    Lisp_Object new_total;
    Lisp_Object new_normal;
132 133 134 135

    /* The buffer displayed in this window.  Of the fields vchild,
       hchild and buffer, one and only one is non-nil unless the window
       is dead.  */
136
    Lisp_Object buffer;
137

138 139 140 141
    /* 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.  */
142
    Lisp_Object start;
143

Jim Blandy's avatar
Jim Blandy committed
144 145 146 147
    /* 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.  */
148
    Lisp_Object pointm;
149 150 151

    /* No permanent meaning; used by save-window-excursion's
       bookkeeping.  */
152
    Lisp_Object 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 157 158
       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.  */
159
    Lisp_Object vertical_scroll_bar;
160

Gerd Moellmann's avatar
Gerd Moellmann committed
161 162
    /* Width of left and right marginal areas.  A value of nil means
       no margin.  */
163 164
    Lisp_Object left_margin_cols;
    Lisp_Object right_margin_cols;
165 166 167

    /* Width of left and right fringes.
       A value of nil or t means use frame values.  */
168 169
    Lisp_Object left_fringe_width;
    Lisp_Object right_fringe_width;
170 171 172

    /* Pixel width of scroll bars.
       A value of nil or t means use frame values.  */
173
    Lisp_Object scroll_bar_width;
174

175 176
    /* Type of vertical scroll bar.  A value of nil means
       no scroll bar.  A value of t means use frame value.  */
177
    Lisp_Object vertical_scroll_bar_type;
Gerd Moellmann's avatar
Gerd Moellmann committed
178 179 180

    /* Z - the buffer position of the last glyph in the current matrix
       of W.  Only valid if WINDOW_END_VALID is not nil.  */
181
    Lisp_Object window_end_pos;
Gerd Moellmann's avatar
Gerd Moellmann committed
182 183
    /* Glyph matrix row of the last glyph in the current matrix
       of W.  Only valid if WINDOW_END_VALID is not nil.  */
184
    Lisp_Object window_end_vpos;
Jim Blandy's avatar
Jim Blandy committed
185 186
    /* t if window_end_pos is truly valid.
       This is nil if nontrivial redisplay is preempted
Jim Blandy's avatar
Jim Blandy committed
187 188
       since in that case the frame image that window_end_pos
       did not get onto the frame.  */
189
    Lisp_Object window_end_valid;
190

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

195 196 197
    /* 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.  */
198
    Lisp_Object dedicated;
199 200 201 202

    /* Line number and position of a line somewhere above the top of the
       screen.  If this field is nil, it means we don't have a base
       line.  */
203
    Lisp_Object base_line_number;
204 205 206
    /* If this field is nil, it means we don't have a base line.
       If it is a buffer, it means don't display the line number
       as long as the window shows that buffer.  */
207
    Lisp_Object base_line_pos;
208

209 210
    /* If we have highlighted the region (or any part of it),
       this is the mark position that we used, as an integer.  */
211
    Lisp_Object region_showing;
212

213 214
    /* The column number currently displayed in this window's mode line,
       or nil if column numbers are not being displayed.  */
215
    Lisp_Object column_number_displayed;
216

217 218
    /* If redisplay in this window goes beyond this buffer position,
       must run the redisplay-end-trigger-hook.  */
219
    Lisp_Object redisplay_end_trigger;
220

221
    /* t means this window's child windows are not (re-)combined.  */
222
    Lisp_Object combination_limit;
223 224 225

    /* Alist of <buffer, window-start, window-point> triples listing
       buffers previously shown in this window.  */
226
    Lisp_Object prev_buffers;
227 228

    /* List of buffers re-shown in this window.  */
229
    Lisp_Object next_buffers;
230

Paul Eggert's avatar
Paul Eggert committed
231
    /* An alist with parameters.  */
232
    Lisp_Object window_parameters;
233

Gerd Moellmann's avatar
Gerd Moellmann committed
234 235 236 237 238 239 240 241
    /* 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;

242 243 244 245 246 247
    /* Number saying how recently window was selected.  */
    int use_time;

    /* Unique number of window assigned when it was created.  */
    int sequence_number;

248
    /* Number of columns display within the window is scrolled to the left.  */
249
    ptrdiff_t hscroll;
250 251 252

    /* Minimum hscroll for automatic hscrolling.  This is the value
       the user has set, by set-window-hscroll for example.  */
253
    ptrdiff_t min_hscroll;
254 255 256 257 258 259 260 261 262 263 264 265 266

    /* 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,
       it should be positive. */
    ptrdiff_t last_point;

267 268 269 270 271
    /* Scaling factor for the glyph_matrix size calculation in this window.
       Used if window contains many small images or uses proportional fonts,
       as the normal  may yield a matrix which is too small.  */
    int nrows_scale_factor, ncols_scale_factor;

Gerd Moellmann's avatar
Gerd Moellmann committed
272 273 274 275 276 277 278
    /* Cursor position as of last update that completed without
       pause.  This is the position of last_point.  */
    struct cursor_pos last_cursor;

    /* Intended cursor position.   This is a position within the
       glyph matrix.  */
    struct cursor_pos cursor;
279

Gerd Moellmann's avatar
Gerd Moellmann committed
280 281
    /* Where the cursor actually is.  */
    struct cursor_pos phys_cursor;
282 283

    /* Cursor type and width of last cursor drawn on the window.
284 285
       Used for X and w32 frames; -1 initially.  */
    int phys_cursor_type, phys_cursor_width;
Gerd Moellmann's avatar
Gerd Moellmann committed
286 287 288

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

290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
    /* Non-zero if this window is a minibuffer window.  */
    unsigned mini : 1;

    /* Non-zero means must regenerate mode line of this window */
    unsigned update_mode_line : 1;

    /* Non-nil if the buffer was "modified" when the window
       was last updated.  */
    unsigned last_had_star : 1;

    /* Non-zero means current value of `start'
       was the beginning of a line when it was chosen.  */
    unsigned start_at_line_beg : 1;

    /* Non-zero means next redisplay must use the value of start
       set up for it in advance.  Set by scrolling commands.  */
    unsigned force_start : 1;

    /* Non-zero means we have explicitly changed the value of start,
       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.  */
    unsigned optional_new_start : 1;

Gerd Moellmann's avatar
Gerd Moellmann committed
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
    /* Non-zero means the cursor is currently displayed.  This can be
       set to zero by functions overpainting the cursor image.  */
    unsigned phys_cursor_on_p : 1;

    /* 0 means cursor is logically on, 1 means it's off.  Used for
       blinking cursor.  */
    unsigned cursor_off_p : 1;

    /* Value of cursor_off_p as of the last redisplay.  */
    unsigned last_cursor_off_p : 1;

    /* 1 means desired matrix has been build and window must be
       updated in update_frame.  */
    unsigned must_be_updated_p : 1;

    /* Flag indicating that this window is not a real one.
       Currently only used for menu bar windows of frames.  */
    unsigned pseudo_window_p : 1;

333 334 335 336 337
    /* 1 means the window start of this window is frozen and may not
       be changed during redisplay.  If point is not in the window,
       accept that.  */
    unsigned frozen_window_start_p : 1;

338 339 340 341
    /* Non-zero means fringes are drawn outside display margins.
       Otherwise draw them between margin areas and text.  */
    unsigned fringes_outside_margins : 1;

Gerd Moellmann's avatar
Gerd Moellmann committed
342 343 344
    /* Amount by which lines of this window are scrolled in
       y-direction (smooth scrolling).  */
    int vscroll;
345

346 347 348
    /* Z_BYTE - the buffer position of the last glyph in the current matrix of W.
       Should be nonnegative, and only valid if window_end_valid is not nil.  */
    ptrdiff_t window_end_bytepos;
Gerd Moellmann's avatar
Gerd Moellmann committed
349
};
Jim Blandy's avatar
Jim Blandy committed
350 351 352

/* 1 if W is a minibuffer window.  */

353
#define MINI_WINDOW_P(W)	((W)->mini)
Jim Blandy's avatar
Jim Blandy committed
354

355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
/* 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
376

377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
*/


/* A handy macro.  */

#define WINDOW_XFRAME(W) \
  (XFRAME (WINDOW_FRAME ((W))))

/* Return the canonical column width of the frame of window W.  */

#define WINDOW_FRAME_COLUMN_WIDTH(W) \
  (FRAME_COLUMN_WIDTH (WINDOW_XFRAME ((W))))

/* Return the canonical column width of the frame of window W.  */

#define WINDOW_FRAME_LINE_HEIGHT(W) \
  (FRAME_LINE_HEIGHT (WINDOW_XFRAME ((W))))

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 (W->total_cols))
400

401
/* Return the height of window W in canonical line units.
402 403 404
   This includes header and mode lines, if any.  */

#define WINDOW_TOTAL_LINES(W) \
405
  (XFASTINT (W->total_lines))
406 407 408 409 410 411 412 413 414 415 416

/* Return the total pixel width of window W.  */

#define WINDOW_TOTAL_WIDTH(W) \
  (WINDOW_TOTAL_COLS (W) * WINDOW_FRAME_COLUMN_WIDTH (W))

/* Return the total pixel height of window W.  */

#define WINDOW_TOTAL_HEIGHT(W) \
  (WINDOW_TOTAL_LINES (W) * WINDOW_FRAME_LINE_HEIGHT (W))

417 418 419 420 421 422 423 424 425 426 427
/* For HORFLAG non-zero the total number of columns of window W.  Otherwise
   the total number of lines of W.  */

#define WINDOW_TOTAL_SIZE(w, horflag) \
  (horflag ? WINDOW_TOTAL_COLS (w) : WINDOW_TOTAL_LINES (w))

/* The smallest acceptable dimensions for a window.  Anything smaller
   might crash Emacs.  */

#define MIN_SAFE_WINDOW_WIDTH  (2)
#define MIN_SAFE_WINDOW_HEIGHT (1)
428 429 430 431 432

/* Return the canonical frame column at which window W starts.
   This includes a left-hand scroll bar, if any.  */

#define WINDOW_LEFT_EDGE_COL(W) \
433
  (XFASTINT (W->left_col))
434 435

/* Return the canonical frame column before which window W ends.
436 437
   This includes a right-hand scroll bar, if any.  */

438 439
#define WINDOW_RIGHT_EDGE_COL(W) \
  (WINDOW_LEFT_EDGE_COL (W) + WINDOW_TOTAL_COLS (W))
440

441 442 443 444
/* Return the canonical frame line at which window W starts.
   This includes a header line, if any.  */

#define WINDOW_TOP_EDGE_LINE(W) \
445
  (XFASTINT (W->top_line))
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467

/* 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))


/* 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)) \
   + WINDOW_LEFT_EDGE_COL (W) * WINDOW_FRAME_COLUMN_WIDTH (W))

/* 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)) \
   + WINDOW_RIGHT_EDGE_COL (W) * WINDOW_FRAME_COLUMN_WIDTH (W))

468 469 470
/* 1 if W is a menu bar window.  */

#define WINDOW_MENU_BAR_P(W) \
471 472
  (WINDOWP (WINDOW_XFRAME (W)->menu_bar_window) \
   && (W) == XWINDOW (WINDOW_XFRAME (W)->menu_bar_window))
473 474 475 476

/* 1 if W is a tool bar window.  */

#define WINDOW_TOOL_BAR_P(W) \
477 478
  (WINDOWP (WINDOW_XFRAME (W)->tool_bar_window) \
   && (W) == XWINDOW (WINDOW_XFRAME (W)->tool_bar_window))
479

480 481 482 483
/* Return the frame y-position at which window W starts.
   This includes a header line, if any.  */

#define WINDOW_TOP_EDGE_Y(W) \
484 485
  (((WINDOW_MENU_BAR_P (W) || WINDOW_TOOL_BAR_P (W)) \
    ? 0 : FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W))) \
486 487 488 489 490 491
   + WINDOW_TOP_EDGE_LINE (W) * WINDOW_FRAME_LINE_HEIGHT (W))

/* Return the frame y-position before which window W ends.
   This includes a mode line, if any.  */

#define WINDOW_BOTTOM_EDGE_Y(W) \
492 493
  (((WINDOW_MENU_BAR_P (W) || WINDOW_TOOL_BAR_P (W)) \
    ? 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 501 502 503 504 505
  (WINDOW_TOTAL_COLS (W) == FRAME_TOTAL_COLS (WINDOW_XFRAME (W)))

/* 1 if window W's has no other windows to its left in its frame.  */

#define WINDOW_LEFTMOST_P(W) \
  (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 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
  (WINDOW_RIGHT_EDGE_COL (W) == FRAME_TOTAL_COLS (WINDOW_XFRAME (W)))


/* Return the frame column at which the text (or left fringe) in
   window W starts.  This is different from the `LEFT_EDGE' because it
   does not include a left-hand scroll bar if any.  */

#define WINDOW_BOX_LEFT_EDGE_COL(W) \
  (WINDOW_LEFT_EDGE_COL (W) \
   + WINDOW_LEFT_SCROLL_BAR_COLS (W))

/* Return the window column before which the text in window W ends.
   This is different from WINDOW_RIGHT_EDGE_COL because it does not
   include a scroll bar or window-separating line on the right edge.  */

#define WINDOW_BOX_RIGHT_EDGE_COL(W) \
  (WINDOW_RIGHT_EDGE_COL (W) \
   - WINDOW_RIGHT_SCROLL_BAR_COLS (W))


/* Return the frame position at which the text (or left fringe) in
   window W starts.  This is different from the `LEFT_EDGE' because it
   does not include a left-hand scroll bar if any.  */

#define WINDOW_BOX_LEFT_EDGE_X(W) \
  (FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W)) \
   + WINDOW_BOX_LEFT_EDGE_COL (W) * WINDOW_FRAME_COLUMN_WIDTH (W))

/* Return the window column before which the text in window W ends.
   This is different from WINDOW_RIGHT_EDGE_COL because it does not
   include a scroll bar or window-separating line on the right edge.  */

#define WINDOW_BOX_RIGHT_EDGE_X(W) \
  (FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W)) \
   + WINDOW_BOX_RIGHT_EDGE_COL (W) * WINDOW_FRAME_COLUMN_WIDTH (W))


/* Width of left margin area in columns.  */

549 550 551 552
#define WINDOW_LEFT_MARGIN_COLS(W)	\
  (NILP (W->left_margin_cols)		\
   ? 0					\
   : XINT (W->left_margin_cols))
553 554 555

/* Width of right marginal area in columns.  */

556 557 558 559
#define WINDOW_RIGHT_MARGIN_COLS(W)	\
  (NILP (W->right_margin_cols)		\
   ? 0					\
   : XINT (W->right_margin_cols))
560 561 562

/* Width of left margin area in pixels.  */

563 564 565 566
#define WINDOW_LEFT_MARGIN_WIDTH(W)	\
  (NILP (W->left_margin_cols)		\
   ? 0					\
   : (XINT (W->left_margin_cols)	\
567 568 569 570
      * WINDOW_FRAME_COLUMN_WIDTH (W)))

/* Width of right marginal area in pixels.  */

571 572 573 574
#define WINDOW_RIGHT_MARGIN_WIDTH(W)	\
  (NILP (W->right_margin_cols)		\
   ? 0					\
   : (XINT (W->right_margin_cols)	\
575 576 577 578 579 580 581 582
      * WINDOW_FRAME_COLUMN_WIDTH (W)))

/* Total width of fringes reserved for drawing truncation bitmaps,
   continuation bitmaps and alike.  The width is in canonical char
   units of the frame.  This must currently be the case because window
   sizes aren't pixel values.  If it weren't the case, we wouldn't be
   able to split windows horizontally nicely.  */

583 584 585 586 587 588 589
#define WINDOW_FRINGE_COLS(W)			\
  ((INTEGERP (W->left_fringe_width)		\
    || INTEGERP (W->right_fringe_width))	\
   ? ((WINDOW_LEFT_FRINGE_WIDTH (W)		\
       + WINDOW_RIGHT_FRINGE_WIDTH (W)		\
       + WINDOW_FRAME_COLUMN_WIDTH (W) - 1)	\
      / WINDOW_FRAME_COLUMN_WIDTH (W))		\
590 591
   : FRAME_FRINGE_COLS (WINDOW_XFRAME (W)))

592 593
/* Column-width of the left and right fringe.  */

594 595 596
#define WINDOW_LEFT_FRINGE_COLS(W)		\
  ((WINDOW_LEFT_FRINGE_WIDTH ((W))		\
    + WINDOW_FRAME_COLUMN_WIDTH (W) - 1)	\
597 598
   / WINDOW_FRAME_COLUMN_WIDTH (W))

599 600 601
#define WINDOW_RIGHT_FRINGE_COLS(W)		\
  ((WINDOW_RIGHT_FRINGE_WIDTH ((W))		\
    + WINDOW_FRAME_COLUMN_WIDTH (W) - 1)	\
602 603
   / WINDOW_FRAME_COLUMN_WIDTH (W))

604 605 606
/* Pixel-width of the left and right fringe.  */

#define WINDOW_LEFT_FRINGE_WIDTH(W)			\
607 608
  (INTEGERP (W->left_fringe_width)			\
   ? XFASTINT (W->left_fringe_width)			\
609 610 611
   : FRAME_LEFT_FRINGE_WIDTH (WINDOW_XFRAME (W)))

#define WINDOW_RIGHT_FRINGE_WIDTH(W)			\
612 613
  (INTEGERP (W->right_fringe_width)			\
   ? XFASTINT (W->right_fringe_width)			\
614 615 616 617 618 619 620 621 622 623
   : FRAME_RIGHT_FRINGE_WIDTH (WINDOW_XFRAME (W)))

/* Total width of fringes in pixels.  */

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

/* Are fringes outside display margins in window W.  */

#define WINDOW_HAS_FRINGES_OUTSIDE_MARGINS(W)	\
624
  ((W)->fringes_outside_margins)
625 626 627 628 629

/* Say whether scroll bars are currently enabled for window W,
   and which side they are on.  */

#define WINDOW_VERTICAL_SCROLL_BAR_TYPE(w)		\
630
  (EQ (w->vertical_scroll_bar_type, Qt)			\
631
   ? FRAME_VERTICAL_SCROLL_BAR_TYPE (WINDOW_XFRAME (w))	\
632
   : EQ (w->vertical_scroll_bar_type, Qleft)		\
633
   ? vertical_scroll_bar_left				\
634
   : EQ (w->vertical_scroll_bar_type, Qright)		\
635 636 637 638
   ? vertical_scroll_bar_right				\
   : vertical_scroll_bar_none)				\

#define WINDOW_HAS_VERTICAL_SCROLL_BAR(w)		\
639
  (EQ (w->vertical_scroll_bar_type, Qt)			\
640
   ? FRAME_HAS_VERTICAL_SCROLL_BARS (WINDOW_XFRAME (w))	\
641
   : !NILP (w->vertical_scroll_bar_type))
642 643

#define WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT(w)		\
644
  (EQ (w->vertical_scroll_bar_type, Qt)				\
645
   ? FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (WINDOW_XFRAME (w))	\
646
   : EQ (w->vertical_scroll_bar_type, Qleft))
647

648 649 650 651
#define WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT(w)			\
  (EQ (w->vertical_scroll_bar_type, Qt)					\
   ? FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (WINDOW_XFRAME (w))	\
   : EQ (w->vertical_scroll_bar_type, Qright))
652 653 654 655 656 657

/* 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.  */

#define WINDOW_CONFIG_SCROLL_BAR_WIDTH(w)		\
658 659
  (INTEGERP (w->scroll_bar_width)			\
   ? XFASTINT (w->scroll_bar_width)			\
660 661 662 663 664 665 666
   : FRAME_CONFIG_SCROLL_BAR_WIDTH (WINDOW_XFRAME (w)))

/* 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.  */

#define WINDOW_CONFIG_SCROLL_BAR_COLS(w)		\
667 668
  (INTEGERP (w->scroll_bar_width)			\
   ? ((XFASTINT (w->scroll_bar_width)			\
669 670 671 672 673 674 675 676 677
       + WINDOW_FRAME_COLUMN_WIDTH (w) - 1)		\
      / WINDOW_FRAME_COLUMN_WIDTH (w))			\
   : FRAME_CONFIG_SCROLL_BAR_COLS (WINDOW_XFRAME (w)))

/* Width of a scroll bar in window W, measured in columns (characters),
   but only if scroll bars are on the left.  If scroll bars are on
   the right in this frame, or there are no scroll bars, value is 0.  */

#define WINDOW_LEFT_SCROLL_BAR_COLS(w)	       \
678
  (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)  \
679 680 681 682 683
   ? (WINDOW_CONFIG_SCROLL_BAR_COLS (w))       \
   : 0)

/* Width of a left scroll bar area in window W , measured in pixels.  */

684 685
#define WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH(w)				 \
  (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)				 \
686 687 688 689 690 691 692 693
   ? (WINDOW_CONFIG_SCROLL_BAR_COLS (w) * WINDOW_FRAME_COLUMN_WIDTH (w)) \
   : 0)

/* Width of a scroll bar in window W, measured in columns (characters),
   but only if scroll bars are on the right.  If scroll bars are on
   the left in this frame, or there are no scroll bars, value is 0.  */

#define WINDOW_RIGHT_SCROLL_BAR_COLS(w)		\
694
  (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)	\
695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715
   ? WINDOW_CONFIG_SCROLL_BAR_COLS (w)		\
   : 0)

/* Width of a left scroll bar area in window W , measured in pixels.  */

#define WINDOW_RIGHT_SCROLL_BAR_AREA_WIDTH(w)				 \
  (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)				 \
   ? (WINDOW_CONFIG_SCROLL_BAR_COLS (w) * WINDOW_FRAME_COLUMN_WIDTH (w)) \
   : 0)


/* Actual width of a scroll bar in window W, measured in columns.  */

#define WINDOW_SCROLL_BAR_COLS(w)	       \
  (WINDOW_HAS_VERTICAL_SCROLL_BAR (w)	       \
   ? WINDOW_CONFIG_SCROLL_BAR_COLS (w)	       \
   : 0)

/* Width of a left scroll bar area in window W , measured in pixels.  */

#define WINDOW_SCROLL_BAR_AREA_WIDTH(w)					 \
716
  (WINDOW_HAS_VERTICAL_SCROLL_BAR (w)					 \
717 718 719 720 721 722 723 724 725 726 727 728
   ? (WINDOW_CONFIG_SCROLL_BAR_COLS (w) * WINDOW_FRAME_COLUMN_WIDTH (w)) \
   : 0)


/* Return the frame position where the scroll bar of window W starts.  */

#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))


729 730
/* Height in pixels, and in lines, of the mode line.
   May be zero if W doesn't have a mode line.  */
731 732 733 734 735 736

#define WINDOW_MODE_LINE_HEIGHT(W)	\
  (WINDOW_WANTS_MODELINE_P ((W))	\
   ? CURRENT_MODE_LINE_HEIGHT (W)	\
   : 0)

737
#define WINDOW_MODE_LINE_LINES(W)	\
738 739 740 741
  (!! WINDOW_WANTS_MODELINE_P ((W)))

/* Height in pixels, and in lines, of the header line.
   Zero if W doesn't have a header line.  */
742 743 744 745 746 747

#define WINDOW_HEADER_LINE_HEIGHT(W)	\
  (WINDOW_WANTS_HEADER_LINE_P ((W))	\
   ? CURRENT_HEADER_LINE_HEIGHT (W)	\
   : 0)

748
#define WINDOW_HEADER_LINE_LINES(W)	\
749 750
  (!! WINDOW_WANTS_HEADER_LINE_P ((W)))

751 752 753 754 755 756 757 758
/* Pixel height of window W without mode line.  */

#define WINDOW_BOX_HEIGHT_NO_MODE_LINE(W)	\
  (WINDOW_TOTAL_HEIGHT ((W))			\
   - WINDOW_MODE_LINE_HEIGHT ((W)))

/* Pixel height of window W without mode and header line.  */

759 760 761
#define WINDOW_BOX_TEXT_HEIGHT(W)	\
  (WINDOW_TOTAL_HEIGHT ((W))		\
   - WINDOW_MODE_LINE_HEIGHT ((W))	\
762 763 764 765 766
   - WINDOW_HEADER_LINE_HEIGHT ((W)))


/* Convert window W relative pixel X to frame pixel coordinates.  */

767
#define WINDOW_TO_FRAME_PIXEL_X(W, X)	\
768 769 770 771
  ((X) + WINDOW_BOX_LEFT_EDGE_X ((W)))

/* Convert window W relative pixel Y to frame pixel coordinates.  */

772
#define WINDOW_TO_FRAME_PIXEL_Y(W, Y)	\
773 774 775 776
  ((Y) + WINDOW_TOP_EDGE_Y ((W)))

/* Convert frame relative pixel X to window relative pixel X.  */

777
#define FRAME_TO_WINDOW_PIXEL_X(W, X)	\
778 779 780 781
  ((X) - WINDOW_BOX_LEFT_EDGE_X ((W)))

/* Convert frame relative pixel Y to window relative pixel Y.  */

782
#define FRAME_TO_WINDOW_PIXEL_Y(W, Y)	\
783 784 785 786
  ((Y) - WINDOW_TOP_EDGE_Y ((W)))

/* Convert a text area relative x-position in window W to frame X
   pixel coordinates.  */
787

788
#define WINDOW_TEXT_TO_FRAME_PIXEL_X(W, X)	\
789
  (window_box_left ((W), TEXT_AREA) + (X))
Gerd Moellmann's avatar
Gerd Moellmann committed
790

Jim Blandy's avatar
Jim Blandy committed
791 792 793 794 795 796
/* 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
Jim Blandy's avatar
Jim Blandy committed
797
    FRAME_SELECTED_WINDOW (selected_frame).  */
Jim Blandy's avatar
Jim Blandy committed
798 799 800 801 802

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
803
   init_window_once, and make_frame.  */
Jim Blandy's avatar
Jim Blandy committed
804 805 806

extern int window_select_count;

Jim Blandy's avatar
Jim Blandy committed
807
/* The minibuffer window of the selected frame.
Jim Blandy's avatar
Jim Blandy committed
808
   Note that you cannot test for minibufferness of an arbitrary window
Jim Blandy's avatar
Jim Blandy committed
809
   by comparing against this; use the MINI_WINDOW_P macro instead.  */
Jim Blandy's avatar
Jim Blandy committed
810 811 812

extern Lisp_Object minibuf_window;

813 814 815
/* Non-nil means it is the window whose mode line should be
   shown as the selected window when the minibuffer is selected.  */

816
extern Lisp_Object minibuf_selected_window;
817

Jim Blandy's avatar
Jim Blandy committed
818
/* Window that the mouse is over (nil if no mouse support).  */
Gerd Moellmann's avatar
Gerd Moellmann committed
819

Jim Blandy's avatar
Jim Blandy committed
820 821 822
extern Lisp_Object Vmouse_window;

/* Last mouse-click event (nil if no mouse support).  */
Gerd Moellmann's avatar
Gerd Moellmann committed
823

Jim Blandy's avatar
Jim Blandy committed
824 825
extern Lisp_Object Vmouse_event;

Jan D's avatar
Jan D committed
826 827
extern Lisp_Object make_window (void);
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);
Jan D's avatar
Jan D committed
831 832 833
extern void freeze_window_starts (struct frame *, int);
extern void grow_mini_window (struct window *, int);
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);
Jim Blandy's avatar
Jim Blandy committed
837

Gerd Moellmann's avatar
Gerd Moellmann committed
838 839 840 841
/* Make WINDOW display BUFFER as its contents.  RUN_HOOKS_P non-zero
   means it's allowed to run hooks.  See make_frame for a case where
   it's not allowed.  */

Jan D's avatar
Jan D committed
842 843
void set_window_buffer (Lisp_Object window, Lisp_Object buffer,
                        int run_hooks_p, int keep_margins_p);
Gerd Moellmann's avatar
Gerd Moellmann committed
844 845 846 847 848

/* 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.  */

849 850
extern Lisp_Object echo_area_window;

Jim Blandy's avatar
Jim Blandy committed
851
/* Depth in recursive edits.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
852

853
extern EMACS_INT command_loop_level;
Jim Blandy's avatar
Jim Blandy committed
854 855

/* Depth in minibuffer invocations.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
856

857
extern EMACS_INT minibuf_level;
Jim Blandy's avatar
Jim Blandy committed
858

Glenn Morris's avatar
Glenn Morris committed
859
/* true if we should redraw the mode lines on the next redisplay.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
860

Jim Blandy's avatar
Jim Blandy committed
861 862
extern int update_mode_lines;

Gerd Moellmann's avatar
Gerd Moellmann committed
863 864 865
/* Nonzero if window sizes or contents have changed since last
   redisplay that finished */

Jim Blandy's avatar
Jim Blandy committed
866 867
extern int windows_or_buffers_changed;

868 869 870 871
/* Nonzero means a frame's cursor type has been changed.  */

extern int cursor_type_changed;

Gerd Moellmann's avatar
Gerd Moellmann committed
872 873 874
/* Number of windows displaying the selected buffer.  Normally this is
   1, but it can be more.  */

Jim Blandy's avatar
Jim Blandy committed
875
extern int buffer_shared;
Jim Blandy's avatar
Jim Blandy committed
876 877 878

/* If *ROWS or *COLS are too small a size for FRAME, set them to the
   minimum allowable size.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
879

Jan D's avatar
Jan D committed
880
extern void check_frame_size (struct frame *frame, int *rows, int *cols);
Gerd Moellmann's avatar
Gerd Moellmann committed
881 882

/* Return a pointer to the glyph W's physical cursor is on.  Value is
Paul Eggert's avatar
Paul Eggert committed
883
   null if W's current matrix is invalid, so that no meaningful glyph
Gerd Moellmann's avatar
Gerd Moellmann committed
884 885
   can be returned.  */

Jan D's avatar
Jan D committed
886
struct glyph *get_phys_cursor_glyph (struct window *w);
Gerd Moellmann's avatar
Gerd Moellmann committed
887

888 889 890 891 892 893 894
/* Value is non-zero if WINDOW is a valid window.  */
#define WINDOW_VALID_P(WINDOW)				\
  (WINDOWP (WINDOW)					\
   && (!NILP (XWINDOW (WINDOW)->buffer)			\
       || !NILP (XWINDOW (WINDOW)->vchild)		\
       || !NILP (XWINDOW (WINDOW)->hchild)))

Gerd Moellmann's avatar
Gerd Moellmann committed
895

896
/* Value is non-zero if WINDOW is a live window.  */
897
#define WINDOW_LIVE_P(WINDOW)					\
898
  (WINDOWP (WINDOW) && !NILP (XWINDOW (WINDOW)->buffer))
899 900 901 902 903 904

/* These used to be in lisp.h.  */

extern Lisp_Object Qwindowp, Qwindow_live_p;
extern Lisp_Object Vwindow_list;

905 906
extern struct window *decode_valid_window (Lisp_Object);
extern struct window *decode_live_window (Lisp_Object);
Jan D's avatar
Jan D committed
907 908 909
extern int compare_window_configurations (Lisp_Object, Lisp_Object, int);
extern void mark_window_cursors_off (struct window *);
extern int window_internal_height (struct window *);
910
extern int window_body_cols (struct window *w);
Jan D's avatar
Jan D committed
911
extern void temp_output_buffer_show (Lisp_Object);
912
extern void replace_buffer_in_windows (Lisp_Object);
913
extern void replace_buffer_in_windows_safely (Lisp_Object);
Jan D's avatar
Jan D committed
914 915 916 917 918
extern void init_window_once (void);
extern void init_window (void);
extern void syms_of_window (void);
extern void keys_of_window (void);

Gerd Moellmann's avatar
Gerd Moellmann committed
919
#endif /* not WINDOW_H_INCLUDED */