window.h 30.8 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Window definitions for GNU Emacs.
2
   Copyright (C) 1985-1986, 1993, 1995, 1997-2011
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;
};

Jim Blandy's avatar
Jim Blandy committed
89 90 91 92
struct window
  {
    /* The first two fields are really the header of a vector */
    /* The window code does not refer to them.  */
Stefan Monnier's avatar
Stefan Monnier committed
93
    EMACS_UINT size;
Jim Blandy's avatar
Jim Blandy committed
94
    struct Lisp_Vector *vec_next;
Jim Blandy's avatar
Jim Blandy committed
95 96
    /* The frame this window is on.  */
    Lisp_Object frame;
Jim Blandy's avatar
Jim Blandy committed
97 98 99 100 101 102 103 104 105 106 107 108 109
    /* t if this window is a minibuffer window.  */
    Lisp_Object mini_p;
    /* Following child (to right or down) at same level of tree */
    Lisp_Object next;
    /* Preceding child (to left or up) at same level of tree */
    Lisp_Object prev;
    /* First child of this window. */
    /* vchild is used if this is a vertical combination,
       hchild if this is a horizontal combination. */
    Lisp_Object hchild, vchild;
    /* The window this one is a child of. */
    Lisp_Object parent;
    /* The upper left corner coordinates of this window,
Jim Blandy's avatar
Jim Blandy committed
110
       as integers relative to upper left corner of frame = 0, 0 */
111 112
    Lisp_Object left_col;
    Lisp_Object top_line;
Jim Blandy's avatar
Jim Blandy committed
113
    /* The size of the window */
114 115
    Lisp_Object total_lines;
    Lisp_Object total_cols;
Jim Blandy's avatar
Jim Blandy committed
116 117 118
    /* The buffer displayed in this window */
    /* Of the fields vchild, hchild and buffer, only one is non-nil.  */
    Lisp_Object buffer;
119 120 121 122
    /* 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.  */
Jim Blandy's avatar
Jim Blandy committed
123 124 125 126 127 128 129 130 131
    Lisp_Object start;
    /* 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.  */
    Lisp_Object pointm;
    /* Non-nil means next redisplay must use the value of start
       set up for it in advance.  Set by scrolling commands.  */
    Lisp_Object force_start;
132
    /* Non-nil means we have explicitly changed the value of start,
133 134
       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
Richard M. Stallman's avatar
Richard M. Stallman committed
135
       Vwindow_scroll_functions; also by Frecenter with argument.  */
136
    Lisp_Object optional_new_start;
Jim Blandy's avatar
Jim Blandy committed
137 138
    /* Number of columns display within the window is scrolled to the left.  */
    Lisp_Object hscroll;
139 140 141
    /* Minimum hscroll for automatic hscrolling.  This is the value
       the user has set, by set-window-hscroll for example.  */
    Lisp_Object min_hscroll;
Jim Blandy's avatar
Jim Blandy committed
142 143 144 145 146 147 148 149
    /* Number saying how recently window was selected */
    Lisp_Object use_time;
    /* Unique number of window assigned when it was created */
    Lisp_Object sequence_number;
    /* No permanent meaning; used by save-window-excursion's bookkeeping */
    Lisp_Object temslot;
    /* text.modified of displayed buffer as of last time display completed */
    Lisp_Object last_modified;
150 151
    /* BUF_OVERLAY_MODIFIED of displayed buffer as of last complete update.  */
    Lisp_Object last_overlay_modified;
Jim Blandy's avatar
Jim Blandy committed
152 153
    /* Value of point at that time */
    Lisp_Object last_point;
154 155 156
    /* Non-nil if the buffer was "modified" when the window
       was last updated.  */
    Lisp_Object last_had_star;
157
    /* This window's vertical scroll bar.  This field is only for use
158
       by the window-system-dependent code which implements the
159 160 161 162
       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 vertical_scroll_bar;
163

Gerd Moellmann's avatar
Gerd Moellmann committed
164 165
    /* Width of left and right marginal areas.  A value of nil means
       no margin.  */
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
    Lisp_Object left_margin_cols, right_margin_cols;

    /* Width of left and right fringes.
       A value of nil or t means use frame values.  */
    Lisp_Object left_fringe_width, right_fringe_width;

  /* Non-nil means fringes are drawn outside display margins;
     othersize draw them between margin areas and text.  */
    Lisp_Object fringes_outside_margins;

    /* Pixel width of scroll bars.
       A value of nil or t means use frame values.  */
    Lisp_Object scroll_bar_width;
    /* Type of vertical scroll bar.  A value of nil means
       no scroll bar.  A value of t means use frame value.  */
    Lisp_Object vertical_scroll_bar_type;
Gerd Moellmann's avatar
Gerd Moellmann committed
182

Jim Blandy's avatar
Jim Blandy committed
183 184
    /* Frame coords of mark as of last time display completed */
    /* May be nil if mark does not exist or was not on frame */
Jim Blandy's avatar
Jim Blandy committed
185 186
    Lisp_Object last_mark_x;
    Lisp_Object last_mark_y;
Gerd Moellmann's avatar
Gerd Moellmann committed
187 188
    /* Z - the buffer position of the last glyph in the current matrix
       of W.  Only valid if WINDOW_END_VALID is not nil.  */
Jim Blandy's avatar
Jim Blandy committed
189
    Lisp_Object window_end_pos;
Gerd Moellmann's avatar
Gerd Moellmann committed
190 191 192
    /* Glyph matrix row of the last glyph in the current matrix
       of W.  Only valid if WINDOW_END_VALID is not nil.  */
    Lisp_Object window_end_vpos;
Jim Blandy's avatar
Jim Blandy committed
193 194
    /* t if window_end_pos is truly valid.
       This is nil if nontrivial redisplay is preempted
Jim Blandy's avatar
Jim Blandy committed
195 196
       since in that case the frame image that window_end_pos
       did not get onto the frame.  */
Jim Blandy's avatar
Jim Blandy committed
197 198 199 200 201 202 203 204 205 206 207
    Lisp_Object window_end_valid;
    /* Non-nil means must regenerate mode line of this window */
    Lisp_Object update_mode_line;
    /* Non-nil means current value of `start'
       was the beginning of a line when it was chosen.  */
    Lisp_Object start_at_line_beg;
    /* Display-table to use for displaying chars in this window.
       Nil means use the buffer's own display-table.  */
    Lisp_Object display_table;
    /* Non-nil means window is marked as dedicated.  */
    Lisp_Object dedicated;
208 209 210 211 212 213 214 215
    /* 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.  */
    Lisp_Object base_line_number;
    /* 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.  */
    Lisp_Object base_line_pos;
216 217 218
    /* If we have highlighted the region (or any part of it),
       this is the mark position that we used, as an integer.  */
    Lisp_Object region_showing;
219 220 221
    /* The column number currently displayed in this window's mode line,
       or nil if column numbers are not being displayed.  */
    Lisp_Object column_number_displayed;
222 223 224
    /* If redisplay in this window goes beyond this buffer position,
       must run the redisplay-end-trigger-hook.  */
    Lisp_Object redisplay_end_trigger;
225 226 227
    /* Non-nil means resizing windows will attempt to resize this window
       proportionally.  */
    Lisp_Object resize_proportionally;
228

229
    /* Original window height and top before mini-window was enlarged. */
230
    Lisp_Object orig_total_lines, orig_top_line;
231

232 233 234
    /* An alist with parameteres.  */
    Lisp_Object window_parameters;

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

243 244 245 246 247
    /* 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
248 249 250 251 252 253 254
    /* 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;
255

Gerd Moellmann's avatar
Gerd Moellmann committed
256 257
    /* Where the cursor actually is.  */
    struct cursor_pos phys_cursor;
258 259

    /* Cursor type and width of last cursor drawn on the window.
260 261
       Used for X and w32 frames; -1 initially.  */
    int phys_cursor_type, phys_cursor_width;
Gerd Moellmann's avatar
Gerd Moellmann committed
262 263 264

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

Gerd Moellmann's avatar
Gerd Moellmann committed
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
    /* 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;

285 286 287 288 289
    /* 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;

Gerd Moellmann's avatar
Gerd Moellmann committed
290 291 292
    /* Amount by which lines of this window are scrolled in
       y-direction (smooth scrolling).  */
    int vscroll;
293

Gerd Moellmann's avatar
Gerd Moellmann committed
294 295 296 297
    /* Z_BYTE - the buffer position of the last glyph in the current matrix
       of W.  Only valid if WINDOW_END_VALID is not nil.  */
    int window_end_bytepos;
};
Jim Blandy's avatar
Jim Blandy committed
298 299 300

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

Gerd Moellmann's avatar
Gerd Moellmann committed
301
#define MINI_WINDOW_P(W)	(!NILP ((W)->mini_p))
Jim Blandy's avatar
Jim Blandy committed
302

303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
/* 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
324

325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
*/


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

343
/* Return the width of window W in canonical column units.
344
   This includes scroll bars and fringes.  */
345

346 347 348
#define WINDOW_TOTAL_COLS(W) \
  (XFASTINT ((W)->total_cols))

349
/* Return the height of window W in canonical line units.
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372
   This includes header and mode lines, if any.  */

#define WINDOW_TOTAL_LINES(W) \
  (XFASTINT ((W)->total_lines))

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


/* 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) \
  (XFASTINT ((W)->left_col))

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

375 376
#define WINDOW_RIGHT_EDGE_COL(W) \
  (WINDOW_LEFT_EDGE_COL (W) + WINDOW_TOTAL_COLS (W))
377

378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
/* Return the canonical frame line at which window W starts.
   This includes a header line, if any.  */

#define WINDOW_TOP_EDGE_LINE(W) \
  (XFASTINT ((W)->top_line))

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

405 406 407 408 409 410 411 412 413 414 415 416
/* 1 if W is a menu bar window.  */

#define WINDOW_MENU_BAR_P(W) \
  (WINDOWP (WINDOW_XFRAME (W)->menu_bar_window) \
   && (W) == XWINDOW (WINDOW_XFRAME (W)->menu_bar_window))

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

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

417 418 419 420
/* Return the frame y-position at which window W starts.
   This includes a header line, if any.  */

#define WINDOW_TOP_EDGE_Y(W) \
421 422
  (((WINDOW_MENU_BAR_P (W) || WINDOW_TOOL_BAR_P (W)) \
    ? 0 : FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W))) \
423 424 425 426 427 428
   + 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) \
429 430
  (((WINDOW_MENU_BAR_P (W) || WINDOW_TOOL_BAR_P (W)) \
    ? 0 : FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W))) \
431
   + WINDOW_BOTTOM_EDGE_LINE (W) * WINDOW_FRAME_LINE_HEIGHT (W))
432

433

434
/* 1 if window W takes up the full width of its frame.  */
435 436

#define WINDOW_FULL_WIDTH_P(W) \
437 438 439 440 441 442
  (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)
443

444
/* 1 if window W's has no other windows to its right in its frame.  */
445 446

#define WINDOW_RIGHTMOST_P(W) \
447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528
  (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.  */

#define WINDOW_LEFT_MARGIN_COLS(W)			\
  (NILP ((W)->left_margin_cols)				\
   ? 0							\
   : XINT ((W)->left_margin_cols))

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

#define WINDOW_RIGHT_MARGIN_COLS(W)			\
  (NILP ((W)->right_margin_cols)			\
   ? 0							\
   : XINT ((W)->right_margin_cols))

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

#define WINDOW_LEFT_MARGIN_WIDTH(W)			\
  (NILP ((W)->left_margin_cols)				\
   ? 0							\
   : (XINT ((W)->left_margin_cols)			\
      * WINDOW_FRAME_COLUMN_WIDTH (W)))

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

#define WINDOW_RIGHT_MARGIN_WIDTH(W)			\
  (NILP ((W)->right_margin_cols)			\
   ? 0							\
   : (XINT ((W)->right_margin_cols)			\
      * 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.  */

#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))			\
   : FRAME_FRINGE_COLS (WINDOW_XFRAME (W)))

529 530 531 532 533 534 535 536 537 538 539 540
/* Column-width of the left and right fringe.  */

#define WINDOW_LEFT_FRINGE_COLS(W)			\
  ((WINDOW_LEFT_FRINGE_WIDTH ((W))			\
    + WINDOW_FRAME_COLUMN_WIDTH (W) - 1)		\
   / WINDOW_FRAME_COLUMN_WIDTH (W))

#define WINDOW_RIGHT_FRINGE_COLS(W)			\
  ((WINDOW_RIGHT_FRINGE_WIDTH ((W))			\
    + WINDOW_FRAME_COLUMN_WIDTH (W) - 1)		\
   / WINDOW_FRAME_COLUMN_WIDTH (W))

541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 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 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
/* Pixel-width of the left and right fringe.  */

#define WINDOW_LEFT_FRINGE_WIDTH(W)			\
  (INTEGERP ((W)->left_fringe_width)			\
   ? XFASTINT ((W)->left_fringe_width)			\
   : FRAME_LEFT_FRINGE_WIDTH (WINDOW_XFRAME (W)))

#define WINDOW_RIGHT_FRINGE_WIDTH(W)			\
  (INTEGERP ((W)->right_fringe_width)			\
   ? XFASTINT ((W)->right_fringe_width)			\
   : 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)	\
  (!NILP ((W)->fringes_outside_margins))

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

#define WINDOW_VERTICAL_SCROLL_BAR_TYPE(w)		\
  (EQ ((w)->vertical_scroll_bar_type, Qt)		\
   ? FRAME_VERTICAL_SCROLL_BAR_TYPE (WINDOW_XFRAME (w))	\
   : EQ ((w)->vertical_scroll_bar_type, Qleft)		\
   ? vertical_scroll_bar_left				\
   : EQ ((w)->vertical_scroll_bar_type, Qright)		\
   ? vertical_scroll_bar_right				\
   : vertical_scroll_bar_none)				\

#define WINDOW_HAS_VERTICAL_SCROLL_BAR(w)		\
  (EQ ((w)->vertical_scroll_bar_type, Qt)		\
   ? FRAME_HAS_VERTICAL_SCROLL_BARS (WINDOW_XFRAME (w))	\
   : !NILP ((w)->vertical_scroll_bar_type))

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

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

/* 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)		\
  (INTEGERP ((w)->scroll_bar_width)			\
   ? XFASTINT ((w)->scroll_bar_width)			\
   : 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)		\
  (INTEGERP ((w)->scroll_bar_width)			\
   ? ((XFASTINT ((w)->scroll_bar_width)			\
       + 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)	       \
  (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w) \
   ? (WINDOW_CONFIG_SCROLL_BAR_COLS (w))       \
   : 0)

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

#define WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH(w) \
  (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w) \
   ? (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)		\
  (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w) \
   ? 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)					 \
  (WINDOW_HAS_VERTICAL_SCROLL_BAR (w)					\
   ? (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))


666 667
/* Height in pixels, and in lines, of the mode line.
   May be zero if W doesn't have a mode line.  */
668 669 670 671 672 673

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

674 675 676 677 678
#define WINDOW_MODE_LINE_LINES(W)		\
  (!! WINDOW_WANTS_MODELINE_P ((W)))

/* Height in pixels, and in lines, of the header line.
   Zero if W doesn't have a header line.  */
679 680 681 682 683 684

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

685 686 687
#define WINDOW_HEADER_LINE_LINES(W)		\
  (!! WINDOW_WANTS_HEADER_LINE_P ((W)))

688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723
/* 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.  */

#define WINDOW_BOX_TEXT_HEIGHT(W)		\
  (WINDOW_TOTAL_HEIGHT ((W))			\
   - WINDOW_MODE_LINE_HEIGHT ((W))		\
   - WINDOW_HEADER_LINE_HEIGHT ((W)))


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

#define WINDOW_TO_FRAME_PIXEL_X(W, X)		\
  ((X) + WINDOW_BOX_LEFT_EDGE_X ((W)))

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

#define WINDOW_TO_FRAME_PIXEL_Y(W, Y)		\
  ((Y) + WINDOW_TOP_EDGE_Y ((W)))

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

#define FRAME_TO_WINDOW_PIXEL_X(W, X)		\
  ((X) - WINDOW_BOX_LEFT_EDGE_X ((W)))

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

#define FRAME_TO_WINDOW_PIXEL_Y(W, Y)		\
  ((Y) - WINDOW_TOP_EDGE_Y ((W)))

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

725 726
#define WINDOW_TEXT_TO_FRAME_PIXEL_X(W, X)		\
  (window_box_left ((W), TEXT_AREA) + (X))
Gerd Moellmann's avatar
Gerd Moellmann committed
727

Jim Blandy's avatar
Jim Blandy committed
728 729 730 731 732 733
/* 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
734
    FRAME_SELECTED_WINDOW (selected_frame).  */
Jim Blandy's avatar
Jim Blandy committed
735 736 737 738 739

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
740
   init_window_once, and make_frame.  */
Jim Blandy's avatar
Jim Blandy committed
741 742 743

extern int window_select_count;

Jim Blandy's avatar
Jim Blandy committed
744
/* The minibuffer window of the selected frame.
Jim Blandy's avatar
Jim Blandy committed
745
   Note that you cannot test for minibufferness of an arbitrary window
Jim Blandy's avatar
Jim Blandy committed
746
   by comparing against this; use the MINI_WINDOW_P macro instead.  */
Jim Blandy's avatar
Jim Blandy committed
747 748 749

extern Lisp_Object minibuf_window;

750 751 752
/* Non-nil means it is the window whose mode line should be
   shown as the selected window when the minibuffer is selected.  */

753
extern Lisp_Object minibuf_selected_window;
754

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

Jim Blandy's avatar
Jim Blandy committed
757 758 759
extern Lisp_Object Vmouse_window;

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

Jim Blandy's avatar
Jim Blandy committed
761 762
extern Lisp_Object Vmouse_event;

Andreas Schwab's avatar
Andreas Schwab committed
763
EXFUN (Fnext_window, 3);
764
EXFUN (Fselect_window, 2);
765
EXFUN (Fset_window_buffer, 3);
766
EXFUN (Fset_window_vscroll, 3);
Gerd Moellmann's avatar
Gerd Moellmann committed
767
EXFUN (Fset_window_margins, 3);
Dave Love's avatar
Dave Love committed
768
EXFUN (Fset_window_point, 2);
Jan D's avatar
Jan D committed
769 770
extern Lisp_Object make_window (void);
extern Lisp_Object window_from_coordinates (struct frame *, int, int,
771
                                            enum window_part *, int);
Andreas Schwab's avatar
Andreas Schwab committed
772
EXFUN (Fwindow_dedicated_p, 1);
Jan D's avatar
Jan D committed
773 774 775 776 777 778 779
extern void set_window_height (Lisp_Object, int, int);
extern void set_window_width (Lisp_Object, int, int);
extern void change_window_heights (Lisp_Object, int);
extern void delete_all_subwindows (struct window *);
extern void freeze_window_starts (struct frame *, int);
extern void grow_mini_window (struct window *, int);
extern void shrink_mini_window (struct window *);
780
extern int window_relative_x_coord (struct window *, enum window_part, int);
781

782
void run_window_configuration_change_hook (struct frame *f);
Jim Blandy's avatar
Jim Blandy committed
783

Gerd Moellmann's avatar
Gerd Moellmann committed
784 785 786 787
/* 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
788 789
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
790 791 792 793 794

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

795 796
extern Lisp_Object echo_area_window;

Jim Blandy's avatar
Jim Blandy committed
797
/* Depth in recursive edits.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
798

Jim Blandy's avatar
Jim Blandy committed
799 800 801
extern int command_loop_level;

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

Jim Blandy's avatar
Jim Blandy committed
803 804
extern int minibuf_level;

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

Jim Blandy's avatar
Jim Blandy committed
807 808
extern int update_mode_lines;

Gerd Moellmann's avatar
Gerd Moellmann committed
809 810 811
/* Nonzero if BEGV - BEG or Z - ZV of current buffer has changed since
   last redisplay that finished.  */

Jim Blandy's avatar
Jim Blandy committed
812 813
extern int clip_changed;

Gerd Moellmann's avatar
Gerd Moellmann committed
814 815 816
/* Nonzero if window sizes or contents have changed since last
   redisplay that finished */

Jim Blandy's avatar
Jim Blandy committed
817 818
extern int windows_or_buffers_changed;

819 820 821 822
/* Nonzero means a frame's cursor type has been changed.  */

extern int cursor_type_changed;

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

Jim Blandy's avatar
Jim Blandy committed
826
extern int buffer_shared;
Jim Blandy's avatar
Jim Blandy committed
827 828 829

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

Jan D's avatar
Jan D committed
831
extern void check_frame_size (struct frame *frame, int *rows, int *cols);
Gerd Moellmann's avatar
Gerd Moellmann committed
832 833 834 835 836

/* Return a pointer to the glyph W's physical cursor is on.  Value is
   null if W's current matrix is invalid, so that no meaningfull glyph
   can be returned.  */

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

Gerd Moellmann's avatar
Gerd Moellmann committed
839 840 841 842 843
/* Value is non-zero if WINDOW is a live window.  */

#define WINDOW_LIVE_P(WINDOW) \
     (WINDOWP ((WINDOW)) && !NILP (XWINDOW ((WINDOW))->buffer))

844 845 846 847 848 849 850

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

extern Lisp_Object Qwindowp, Qwindow_live_p;
extern Lisp_Object Vwindow_list;

EXFUN (Fselected_window, 0);
851
EXFUN (Fwindow_minibuffer_p, 1);
852 853 854 855 856 857
EXFUN (Fdelete_window, 1);
EXFUN (Fwindow_buffer, 1);
EXFUN (Fget_buffer_window, 2);
EXFUN (Fsave_window_excursion, UNEVALLED);
EXFUN (Fset_window_configuration, 1);
EXFUN (Fcurrent_window_configuration, 1);
Jan D's avatar
Jan D committed
858
extern int compare_window_configurations (Lisp_Object, Lisp_Object, int);
859
EXFUN (Fpos_visible_in_window_p, 3);
Jan D's avatar
Jan D committed
860 861
extern void mark_window_cursors_off (struct window *);
extern int window_internal_height (struct window *);
862
EXFUN (Frecenter, 1);
Jan D's avatar
Jan D committed
863 864 865 866 867 868 869 870
extern void temp_output_buffer_show (Lisp_Object);
extern void replace_buffer_in_all_windows (Lisp_Object);
extern void init_window_once (void);
extern void init_window (void);
extern void syms_of_window (void);
extern void keys_of_window (void);

extern int window_box_text_cols (struct window *w);
871

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