(url-retrieve-synchronously): Don't autoload.
[emacs.git] / src / window.h
blob46d75de384fac011e0bfff90071b57c777b3756a
1 /* Window definitions for GNU Emacs.
2 Copyright (C) 1985, 1986, 1993, 1995, 1997, 1998, 1999, 2000, 2001,
3 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
22 #ifndef WINDOW_H_INCLUDED
23 #define WINDOW_H_INCLUDED
25 #include "dispextern.h"
27 extern Lisp_Object Qleft, Qright;
29 /* Windows are allocated as if they were vectors, but then the
30 Lisp data type is changed to Lisp_Window. They are garbage
31 collected along with the vectors.
33 All windows in use are arranged into a tree, with pointers up and down.
35 Windows that are leaves of the tree are actually displayed
36 and show the contents of buffers. Windows that are not leaves
37 are used for representing the way groups of leaf windows are
38 arranged on the frame. Leaf windows never become non-leaves.
39 They are deleted only by calling delete-window on them (but
40 this can be done implicitly). Combination windows can be created
41 and deleted at any time.
43 A leaf window has a non-nil buffer field, and also
44 has markers in its start and pointm fields. Non-leaf windows
45 have nil in these fields.
47 Non-leaf windows are either vertical or horizontal combinations.
49 A vertical combination window has children that are arranged on the frame
50 one above the next. Its vchild field points to the uppermost child.
51 The parent field of each of the children points to the vertical
52 combination window. The next field of each child points to the
53 child below it, or is nil for the lowest child. The prev field
54 of each child points to the child above it, or is nil for the
55 highest child.
57 A horizontal combination window has children that are side by side.
58 Its hchild field points to the leftmost child. In each child
59 the next field points to the child to the right and the prev field
60 points to the child to the left.
62 The children of a vertical combination window may be leaf windows
63 or horizontal combination windows. The children of a horizontal
64 combination window may be leaf windows or vertical combination windows.
66 At the top of the tree are two windows which have nil as parent.
67 The second of these is minibuf_window. The first one manages all
68 the frame area that is not minibuffer, and is called the root window.
69 Different windows can be the root at different times;
70 initially the root window is a leaf window, but if more windows
71 are created then that leaf window ceases to be root and a newly
72 made combination window becomes root instead.
74 In any case, on screens which have an ordinary window and a
75 minibuffer, prev of the minibuf window is the root window and next of
76 the root window is the minibuf window. On minibufferless screens or
77 minibuffer-only screens, the root window and the minibuffer window are
78 one and the same, so its prev and next members are nil.
80 A dead window has its buffer, hchild, and vchild windows all nil. */
82 struct cursor_pos
84 /* Pixel position. These are always window relative. */
85 int x, y;
87 /* Glyph matrix position. */
88 int hpos, vpos;
91 struct window
93 /* The first two fields are really the header of a vector */
94 /* The window code does not refer to them. */
95 EMACS_INT size;
96 struct Lisp_Vector *vec_next;
97 /* The frame this window is on. */
98 Lisp_Object frame;
99 /* t if this window is a minibuffer window. */
100 Lisp_Object mini_p;
101 /* Following child (to right or down) at same level of tree */
102 Lisp_Object next;
103 /* Preceding child (to left or up) at same level of tree */
104 Lisp_Object prev;
105 /* First child of this window. */
106 /* vchild is used if this is a vertical combination,
107 hchild if this is a horizontal combination. */
108 Lisp_Object hchild, vchild;
109 /* The window this one is a child of. */
110 Lisp_Object parent;
111 /* The upper left corner coordinates of this window,
112 as integers relative to upper left corner of frame = 0, 0 */
113 Lisp_Object left_col;
114 Lisp_Object top_line;
115 /* The size of the window */
116 Lisp_Object total_lines;
117 Lisp_Object total_cols;
118 /* The buffer displayed in this window */
119 /* Of the fields vchild, hchild and buffer, only one is non-nil. */
120 Lisp_Object buffer;
121 /* A marker pointing to where in the text to start displaying */
122 Lisp_Object start;
123 /* A marker pointing to where in the text point is in this window,
124 used only when the window is not selected.
125 This exists so that when multiple windows show one buffer
126 each one can have its own value of point. */
127 Lisp_Object pointm;
128 /* Non-nil means next redisplay must use the value of start
129 set up for it in advance. Set by scrolling commands. */
130 Lisp_Object force_start;
131 /* Non-nil means we have explicitly changed the value of start,
132 but that the next redisplay is not obliged to use the new value.
133 This is used in Fdelete_other_windows to force a call to
134 Vwindow_scroll_functions; also by Frecenter with argument. */
135 Lisp_Object optional_new_start;
136 /* Number of columns display within the window is scrolled to the left. */
137 Lisp_Object hscroll;
138 /* Minimum hscroll for automatic hscrolling. This is the value
139 the user has set, by set-window-hscroll for example. */
140 Lisp_Object min_hscroll;
141 /* Number saying how recently window was selected */
142 Lisp_Object use_time;
143 /* Unique number of window assigned when it was created */
144 Lisp_Object sequence_number;
145 /* No permanent meaning; used by save-window-excursion's bookkeeping */
146 Lisp_Object temslot;
147 /* text.modified of displayed buffer as of last time display completed */
148 Lisp_Object last_modified;
149 /* BUF_OVERLAY_MODIFIED of displayed buffer as of last complete update. */
150 Lisp_Object last_overlay_modified;
151 /* Value of point at that time */
152 Lisp_Object last_point;
153 /* Non-nil if the buffer was "modified" when the window
154 was last updated. */
155 Lisp_Object last_had_star;
156 /* This window's vertical scroll bar. This field is only for use
157 by the window-system-dependent code which implements the
158 scroll bars; it can store anything it likes here. If this
159 window is newly created and we haven't displayed a scroll bar in
160 it yet, or if the frame doesn't have any scroll bars, this is nil. */
161 Lisp_Object vertical_scroll_bar;
163 /* Width of left and right marginal areas. A value of nil means
164 no margin. */
165 Lisp_Object left_margin_cols, right_margin_cols;
167 /* Width of left and right fringes.
168 A value of nil or t means use frame values. */
169 Lisp_Object left_fringe_width, right_fringe_width;
171 /* Non-nil means fringes are drawn outside display margins;
172 othersize draw them between margin areas and text. */
173 Lisp_Object fringes_outside_margins;
175 /* Pixel width of scroll bars.
176 A value of nil or t means use frame values. */
177 Lisp_Object scroll_bar_width;
178 /* Type of vertical scroll bar. A value of nil means
179 no scroll bar. A value of t means use frame value. */
180 Lisp_Object vertical_scroll_bar_type;
182 /* Frame coords of mark as of last time display completed */
183 /* May be nil if mark does not exist or was not on frame */
184 Lisp_Object last_mark_x;
185 Lisp_Object last_mark_y;
186 /* Z - the buffer position of the last glyph in the current matrix
187 of W. Only valid if WINDOW_END_VALID is not nil. */
188 Lisp_Object window_end_pos;
189 /* Glyph matrix row of the last glyph in the current matrix
190 of W. Only valid if WINDOW_END_VALID is not nil. */
191 Lisp_Object window_end_vpos;
192 /* t if window_end_pos is truly valid.
193 This is nil if nontrivial redisplay is preempted
194 since in that case the frame image that window_end_pos
195 did not get onto the frame. */
196 Lisp_Object window_end_valid;
197 /* Non-nil means must regenerate mode line of this window */
198 Lisp_Object update_mode_line;
199 /* Non-nil means current value of `start'
200 was the beginning of a line when it was chosen. */
201 Lisp_Object start_at_line_beg;
202 /* Display-table to use for displaying chars in this window.
203 Nil means use the buffer's own display-table. */
204 Lisp_Object display_table;
205 /* Non-nil means window is marked as dedicated. */
206 Lisp_Object dedicated;
207 /* Line number and position of a line somewhere above the
208 top of the screen. */
209 /* If this field is nil, it means we don't have a base line. */
210 Lisp_Object base_line_number;
211 /* If this field is nil, it means we don't have a base line.
212 If it is a buffer, it means don't display the line number
213 as long as the window shows that buffer. */
214 Lisp_Object base_line_pos;
215 /* If we have highlighted the region (or any part of it),
216 this is the mark position that we used, as an integer. */
217 Lisp_Object region_showing;
218 /* The column number currently displayed in this window's mode line,
219 or nil if column numbers are not being displayed. */
220 Lisp_Object column_number_displayed;
221 /* If redisplay in this window goes beyond this buffer position,
222 must run the redisplay-end-trigger-hook. */
223 Lisp_Object redisplay_end_trigger;
224 /* Non-nil means don't delete this window for becoming "too small". */
225 Lisp_Object too_small_ok;
227 /* Original window height and top before mini-window was
228 enlarged. */
229 Lisp_Object orig_total_lines, orig_top_line;
231 /* No Lisp data may follow below this point without changing
232 mark_object in alloc.c. The member current_matrix must be the
233 first non-Lisp member. */
235 /* Glyph matrices. */
236 struct glyph_matrix *current_matrix;
237 struct glyph_matrix *desired_matrix;
239 /* Scaling factor for the glyph_matrix size calculation in this window.
240 Used if window contains many small images or uses proportional fonts,
241 as the normal may yield a matrix which is too small. */
242 int nrows_scale_factor, ncols_scale_factor;
244 /* Cursor position as of last update that completed without
245 pause. This is the position of last_point. */
246 struct cursor_pos last_cursor;
248 /* Intended cursor position. This is a position within the
249 glyph matrix. */
250 struct cursor_pos cursor;
252 /* Where the cursor actually is. */
253 struct cursor_pos phys_cursor;
255 /* Cursor type and width of last cursor drawn on the window.
256 Used for X and w32 frames; -1 initially. */
257 int phys_cursor_type, phys_cursor_width;
259 /* This is handy for undrawing the cursor. */
260 int phys_cursor_ascent, phys_cursor_height;
262 /* Non-zero means the cursor is currently displayed. This can be
263 set to zero by functions overpainting the cursor image. */
264 unsigned phys_cursor_on_p : 1;
266 /* 0 means cursor is logically on, 1 means it's off. Used for
267 blinking cursor. */
268 unsigned cursor_off_p : 1;
270 /* Value of cursor_off_p as of the last redisplay. */
271 unsigned last_cursor_off_p : 1;
273 /* 1 means desired matrix has been build and window must be
274 updated in update_frame. */
275 unsigned must_be_updated_p : 1;
277 /* Flag indicating that this window is not a real one.
278 Currently only used for menu bar windows of frames. */
279 unsigned pseudo_window_p : 1;
281 /* Amount by which lines of this window are scrolled in
282 y-direction (smooth scrolling). */
283 int vscroll;
285 /* Z_BYTE - the buffer position of the last glyph in the current matrix
286 of W. Only valid if WINDOW_END_VALID is not nil. */
287 int window_end_bytepos;
289 /* 1 means the window start of this window is frozen and may not
290 be changed during redisplay. If point is not in the window,
291 accept that. */
292 unsigned frozen_window_start_p : 1;
295 /* 1 if W is a minibuffer window. */
297 #define MINI_WINDOW_P(W) (!NILP ((W)->mini_p))
299 /* General window layout:
301 LEFT_EDGE_COL RIGHT_EDGE_COL
304 | BOX_LEFT_EDGE_COL |
305 | | BOX_RIGHT_EDGE_COL |
306 | | | |
307 v v v v
308 <-><-><---><-----------><---><-><->
309 ^ ^ ^ ^ ^ ^ ^
310 | | | | | | |
311 | | | | | | +-- RIGHT_SCROLL_BAR_COLS
312 | | | | | +----- RIGHT_FRINGE_WIDTH
313 | | | | +--------- RIGHT_MARGIN_COLS
314 | | | |
315 | | | +------------------ TEXT_AREA_COLS
316 | | |
317 | | +--------------------------- LEFT_MARGIN_COLS
318 | +------------------------------- LEFT_FRINGE_WIDTH
319 +---------------------------------- LEFT_SCROLL_BAR_COLS
324 /* A handy macro. */
326 #define WINDOW_XFRAME(W) \
327 (XFRAME (WINDOW_FRAME ((W))))
329 /* Return the canonical column width of the frame of window W. */
331 #define WINDOW_FRAME_COLUMN_WIDTH(W) \
332 (FRAME_COLUMN_WIDTH (WINDOW_XFRAME ((W))))
334 /* Return the canonical column width of the frame of window W. */
336 #define WINDOW_FRAME_LINE_HEIGHT(W) \
337 (FRAME_LINE_HEIGHT (WINDOW_XFRAME ((W))))
340 /* Return the frame width in canonical column units.
341 This includes scroll bars and fringes. */
343 #define WINDOW_TOTAL_COLS(W) \
344 (XFASTINT ((W)->total_cols))
346 /* Return the frame height in canonical line units.
347 This includes header and mode lines, if any. */
349 #define WINDOW_TOTAL_LINES(W) \
350 (XFASTINT ((W)->total_lines))
353 /* Return the total pixel width of window W. */
355 #define WINDOW_TOTAL_WIDTH(W) \
356 (WINDOW_TOTAL_COLS (W) * WINDOW_FRAME_COLUMN_WIDTH (W))
358 /* Return the total pixel height of window W. */
360 #define WINDOW_TOTAL_HEIGHT(W) \
361 (WINDOW_TOTAL_LINES (W) * WINDOW_FRAME_LINE_HEIGHT (W))
364 /* Return the canonical frame column at which window W starts.
365 This includes a left-hand scroll bar, if any. */
367 #define WINDOW_LEFT_EDGE_COL(W) \
368 (XFASTINT ((W)->left_col))
370 /* Return the canonical frame column before which window W ends.
371 This includes a right-hand scroll bar, if any. */
373 #define WINDOW_RIGHT_EDGE_COL(W) \
374 (WINDOW_LEFT_EDGE_COL (W) + WINDOW_TOTAL_COLS (W))
376 /* Return the canonical frame line at which window W starts.
377 This includes a header line, if any. */
379 #define WINDOW_TOP_EDGE_LINE(W) \
380 (XFASTINT ((W)->top_line))
382 /* Return the canonical frame line before which window W ends.
383 This includes a mode line, if any. */
385 #define WINDOW_BOTTOM_EDGE_LINE(W) \
386 (WINDOW_TOP_EDGE_LINE (W) + WINDOW_TOTAL_LINES (W))
389 /* Return the frame x-position at which window W starts.
390 This includes a left-hand scroll bar, if any. */
392 #define WINDOW_LEFT_EDGE_X(W) \
393 (FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W)) \
394 + WINDOW_LEFT_EDGE_COL (W) * WINDOW_FRAME_COLUMN_WIDTH (W))
396 /* Return the frame x- position before which window W ends.
397 This includes a right-hand scroll bar, if any. */
399 #define WINDOW_RIGHT_EDGE_X(W) \
400 (FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W)) \
401 + WINDOW_RIGHT_EDGE_COL (W) * WINDOW_FRAME_COLUMN_WIDTH (W))
403 /* Return the frame y-position at which window W starts.
404 This includes a header line, if any. */
406 #define WINDOW_TOP_EDGE_Y(W) \
407 (FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W)) \
408 + WINDOW_TOP_EDGE_LINE (W) * WINDOW_FRAME_LINE_HEIGHT (W))
410 /* Return the frame y-position before which window W ends.
411 This includes a mode line, if any. */
413 #define WINDOW_BOTTOM_EDGE_Y(W) \
414 (FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W)) \
415 + WINDOW_BOTTOM_EDGE_LINE (W) * WINDOW_FRAME_LINE_HEIGHT (W))
418 /* 1 if window W takes up the full width of its frame. */
420 #define WINDOW_FULL_WIDTH_P(W) \
421 (WINDOW_TOTAL_COLS (W) == FRAME_TOTAL_COLS (WINDOW_XFRAME (W)))
423 /* 1 if window W's has no other windows to its left in its frame. */
425 #define WINDOW_LEFTMOST_P(W) \
426 (WINDOW_LEFT_EDGE_COL (W) == 0)
428 /* 1 if window W's has no other windows to its right in its frame. */
430 #define WINDOW_RIGHTMOST_P(W) \
431 (WINDOW_RIGHT_EDGE_COL (W) == FRAME_TOTAL_COLS (WINDOW_XFRAME (W)))
434 /* Return the frame column at which the text (or left fringe) in
435 window W starts. This is different from the `LEFT_EDGE' because it
436 does not include a left-hand scroll bar if any. */
438 #define WINDOW_BOX_LEFT_EDGE_COL(W) \
439 (WINDOW_LEFT_EDGE_COL (W) \
440 + WINDOW_LEFT_SCROLL_BAR_COLS (W))
442 /* Return the window column before which the text in window W ends.
443 This is different from WINDOW_RIGHT_EDGE_COL because it does not
444 include a scroll bar or window-separating line on the right edge. */
446 #define WINDOW_BOX_RIGHT_EDGE_COL(W) \
447 (WINDOW_RIGHT_EDGE_COL (W) \
448 - WINDOW_RIGHT_SCROLL_BAR_COLS (W))
451 /* Return the frame position at which the text (or left fringe) in
452 window W starts. This is different from the `LEFT_EDGE' because it
453 does not include a left-hand scroll bar if any. */
455 #define WINDOW_BOX_LEFT_EDGE_X(W) \
456 (FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W)) \
457 + WINDOW_BOX_LEFT_EDGE_COL (W) * WINDOW_FRAME_COLUMN_WIDTH (W))
459 /* Return the window column before which the text in window W ends.
460 This is different from WINDOW_RIGHT_EDGE_COL because it does not
461 include a scroll bar or window-separating line on the right edge. */
463 #define WINDOW_BOX_RIGHT_EDGE_X(W) \
464 (FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W)) \
465 + WINDOW_BOX_RIGHT_EDGE_COL (W) * WINDOW_FRAME_COLUMN_WIDTH (W))
468 /* Width of left margin area in columns. */
470 #define WINDOW_LEFT_MARGIN_COLS(W) \
471 (NILP ((W)->left_margin_cols) \
472 ? 0 \
473 : XINT ((W)->left_margin_cols))
475 /* Width of right marginal area in columns. */
477 #define WINDOW_RIGHT_MARGIN_COLS(W) \
478 (NILP ((W)->right_margin_cols) \
479 ? 0 \
480 : XINT ((W)->right_margin_cols))
482 /* Width of left margin area in pixels. */
484 #define WINDOW_LEFT_MARGIN_WIDTH(W) \
485 (NILP ((W)->left_margin_cols) \
486 ? 0 \
487 : (XINT ((W)->left_margin_cols) \
488 * WINDOW_FRAME_COLUMN_WIDTH (W)))
490 /* Width of right marginal area in pixels. */
492 #define WINDOW_RIGHT_MARGIN_WIDTH(W) \
493 (NILP ((W)->right_margin_cols) \
494 ? 0 \
495 : (XINT ((W)->right_margin_cols) \
496 * WINDOW_FRAME_COLUMN_WIDTH (W)))
498 /* Total width of fringes reserved for drawing truncation bitmaps,
499 continuation bitmaps and alike. The width is in canonical char
500 units of the frame. This must currently be the case because window
501 sizes aren't pixel values. If it weren't the case, we wouldn't be
502 able to split windows horizontally nicely. */
504 #define WINDOW_FRINGE_COLS(W) \
505 ((INTEGERP ((W)->left_fringe_width) \
506 || INTEGERP ((W)->right_fringe_width)) \
507 ? ((WINDOW_LEFT_FRINGE_WIDTH (W) \
508 + WINDOW_RIGHT_FRINGE_WIDTH (W) \
509 + WINDOW_FRAME_COLUMN_WIDTH (W) - 1) \
510 / WINDOW_FRAME_COLUMN_WIDTH (W)) \
511 : FRAME_FRINGE_COLS (WINDOW_XFRAME (W)))
513 /* Column-width of the left and right fringe. */
515 #define WINDOW_LEFT_FRINGE_COLS(W) \
516 ((WINDOW_LEFT_FRINGE_WIDTH ((W)) \
517 + WINDOW_FRAME_COLUMN_WIDTH (W) - 1) \
518 / WINDOW_FRAME_COLUMN_WIDTH (W))
520 #define WINDOW_RIGHT_FRINGE_COLS(W) \
521 ((WINDOW_RIGHT_FRINGE_WIDTH ((W)) \
522 + WINDOW_FRAME_COLUMN_WIDTH (W) - 1) \
523 / WINDOW_FRAME_COLUMN_WIDTH (W))
525 /* Pixel-width of the left and right fringe. */
527 #define WINDOW_LEFT_FRINGE_WIDTH(W) \
528 (INTEGERP ((W)->left_fringe_width) \
529 ? XFASTINT ((W)->left_fringe_width) \
530 : FRAME_LEFT_FRINGE_WIDTH (WINDOW_XFRAME (W)))
532 #define WINDOW_RIGHT_FRINGE_WIDTH(W) \
533 (INTEGERP ((W)->right_fringe_width) \
534 ? XFASTINT ((W)->right_fringe_width) \
535 : FRAME_RIGHT_FRINGE_WIDTH (WINDOW_XFRAME (W)))
537 /* Total width of fringes in pixels. */
539 #define WINDOW_TOTAL_FRINGE_WIDTH(W) \
540 (WINDOW_LEFT_FRINGE_WIDTH (W) + WINDOW_RIGHT_FRINGE_WIDTH (W))
542 /* Are fringes outside display margins in window W. */
544 #define WINDOW_HAS_FRINGES_OUTSIDE_MARGINS(W) \
545 (!NILP ((W)->fringes_outside_margins))
547 /* Say whether scroll bars are currently enabled for window W,
548 and which side they are on. */
550 #define WINDOW_VERTICAL_SCROLL_BAR_TYPE(w) \
551 (EQ ((w)->vertical_scroll_bar_type, Qt) \
552 ? FRAME_VERTICAL_SCROLL_BAR_TYPE (WINDOW_XFRAME (w)) \
553 : EQ ((w)->vertical_scroll_bar_type, Qleft) \
554 ? vertical_scroll_bar_left \
555 : EQ ((w)->vertical_scroll_bar_type, Qright) \
556 ? vertical_scroll_bar_right \
557 : vertical_scroll_bar_none) \
559 #define WINDOW_HAS_VERTICAL_SCROLL_BAR(w) \
560 (EQ ((w)->vertical_scroll_bar_type, Qt) \
561 ? FRAME_HAS_VERTICAL_SCROLL_BARS (WINDOW_XFRAME (w)) \
562 : !NILP ((w)->vertical_scroll_bar_type))
564 #define WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT(w) \
565 (EQ ((w)->vertical_scroll_bar_type, Qt) \
566 ? FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (WINDOW_XFRAME (w)) \
567 : EQ ((w)->vertical_scroll_bar_type, Qleft))
569 #define WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT(w) \
570 (EQ ((w)->vertical_scroll_bar_type, Qt) \
571 ? FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (WINDOW_XFRAME (w))\
572 : EQ ((w)->vertical_scroll_bar_type, Qright))
574 /* Width that a scroll bar in window W should have, if there is one.
575 Measured in pixels. If scroll bars are turned off, this is still
576 nonzero. */
578 #define WINDOW_CONFIG_SCROLL_BAR_WIDTH(w) \
579 (INTEGERP ((w)->scroll_bar_width) \
580 ? XFASTINT ((w)->scroll_bar_width) \
581 : FRAME_CONFIG_SCROLL_BAR_WIDTH (WINDOW_XFRAME (w)))
583 /* Width that a scroll bar in window W should have, if there is one.
584 Measured in columns (characters). If scroll bars are turned off,
585 this is still nonzero. */
587 #define WINDOW_CONFIG_SCROLL_BAR_COLS(w) \
588 (INTEGERP ((w)->scroll_bar_width) \
589 ? ((XFASTINT ((w)->scroll_bar_width) \
590 + WINDOW_FRAME_COLUMN_WIDTH (w) - 1) \
591 / WINDOW_FRAME_COLUMN_WIDTH (w)) \
592 : FRAME_CONFIG_SCROLL_BAR_COLS (WINDOW_XFRAME (w)))
594 /* Width of a scroll bar in window W, measured in columns (characters),
595 but only if scroll bars are on the left. If scroll bars are on
596 the right in this frame, or there are no scroll bars, value is 0. */
598 #define WINDOW_LEFT_SCROLL_BAR_COLS(w) \
599 (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w) \
600 ? (WINDOW_CONFIG_SCROLL_BAR_COLS (w)) \
601 : 0)
603 /* Width of a left scroll bar area in window W , measured in pixels. */
605 #define WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH(w) \
606 (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w) \
607 ? (WINDOW_CONFIG_SCROLL_BAR_COLS (w) * WINDOW_FRAME_COLUMN_WIDTH (w)) \
608 : 0)
610 /* Width of a scroll bar in window W, measured in columns (characters),
611 but only if scroll bars are on the right. If scroll bars are on
612 the left in this frame, or there are no scroll bars, value is 0. */
614 #define WINDOW_RIGHT_SCROLL_BAR_COLS(w) \
615 (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w) \
616 ? WINDOW_CONFIG_SCROLL_BAR_COLS (w) \
617 : 0)
619 /* Width of a left scroll bar area in window W , measured in pixels. */
621 #define WINDOW_RIGHT_SCROLL_BAR_AREA_WIDTH(w) \
622 (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w) \
623 ? (WINDOW_CONFIG_SCROLL_BAR_COLS (w) * WINDOW_FRAME_COLUMN_WIDTH (w)) \
624 : 0)
627 /* Actual width of a scroll bar in window W, measured in columns. */
629 #define WINDOW_SCROLL_BAR_COLS(w) \
630 (WINDOW_HAS_VERTICAL_SCROLL_BAR (w) \
631 ? WINDOW_CONFIG_SCROLL_BAR_COLS (w) \
632 : 0)
634 /* Width of a left scroll bar area in window W , measured in pixels. */
636 #define WINDOW_SCROLL_BAR_AREA_WIDTH(w) \
637 (WINDOW_HAS_VERTICAL_SCROLL_BAR (w) \
638 ? (WINDOW_CONFIG_SCROLL_BAR_COLS (w) * WINDOW_FRAME_COLUMN_WIDTH (w)) \
639 : 0)
642 /* Return the frame position where the scroll bar of window W starts. */
644 #define WINDOW_SCROLL_BAR_AREA_X(W) \
645 (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (W) \
646 ? WINDOW_BOX_RIGHT_EDGE_X (W) \
647 : WINDOW_LEFT_EDGE_X (W))
650 /* Height in pixels, and in lines, of the mode line.
651 May be zero if W doesn't have a mode line. */
653 #define WINDOW_MODE_LINE_HEIGHT(W) \
654 (WINDOW_WANTS_MODELINE_P ((W)) \
655 ? CURRENT_MODE_LINE_HEIGHT (W) \
656 : 0)
658 #define WINDOW_MODE_LINE_LINES(W) \
659 (!! WINDOW_WANTS_MODELINE_P ((W)))
661 /* Height in pixels, and in lines, of the header line.
662 Zero if W doesn't have a header line. */
664 #define WINDOW_HEADER_LINE_HEIGHT(W) \
665 (WINDOW_WANTS_HEADER_LINE_P ((W)) \
666 ? CURRENT_HEADER_LINE_HEIGHT (W) \
667 : 0)
669 #define WINDOW_HEADER_LINE_LINES(W) \
670 (!! WINDOW_WANTS_HEADER_LINE_P ((W)))
672 /* Pixel height of window W without mode line. */
674 #define WINDOW_BOX_HEIGHT_NO_MODE_LINE(W) \
675 (WINDOW_TOTAL_HEIGHT ((W)) \
676 - WINDOW_MODE_LINE_HEIGHT ((W)))
678 /* Pixel height of window W without mode and header line. */
680 #define WINDOW_BOX_TEXT_HEIGHT(W) \
681 (WINDOW_TOTAL_HEIGHT ((W)) \
682 - WINDOW_MODE_LINE_HEIGHT ((W)) \
683 - WINDOW_HEADER_LINE_HEIGHT ((W)))
686 /* Convert window W relative pixel X to frame pixel coordinates. */
688 #define WINDOW_TO_FRAME_PIXEL_X(W, X) \
689 ((X) + WINDOW_BOX_LEFT_EDGE_X ((W)))
691 /* Convert window W relative pixel Y to frame pixel coordinates. */
693 #define WINDOW_TO_FRAME_PIXEL_Y(W, Y) \
694 ((Y) + WINDOW_TOP_EDGE_Y ((W)))
696 /* Convert frame relative pixel X to window relative pixel X. */
698 #define FRAME_TO_WINDOW_PIXEL_X(W, X) \
699 ((X) - WINDOW_BOX_LEFT_EDGE_X ((W)))
701 /* Convert frame relative pixel Y to window relative pixel Y. */
703 #define FRAME_TO_WINDOW_PIXEL_Y(W, Y) \
704 ((Y) - WINDOW_TOP_EDGE_Y ((W)))
706 /* Convert a text area relative x-position in window W to frame X
707 pixel coordinates. */
709 #define WINDOW_TEXT_TO_FRAME_PIXEL_X(W, X) \
710 (window_box_left ((W), TEXT_AREA) + (X))
712 /* This is the window in which the terminal's cursor should
713 be left when nothing is being done with it. This must
714 always be a leaf window, and its buffer is selected by
715 the top level editing loop at the end of each command.
717 This value is always the same as
718 FRAME_SELECTED_WINDOW (selected_frame). */
720 extern Lisp_Object selected_window;
722 /* This is a time stamp for window selection, so we can find the least
723 recently used window. Its only users are Fselect_window,
724 init_window_once, and make_frame. */
726 extern int window_select_count;
728 /* The minibuffer window of the selected frame.
729 Note that you cannot test for minibufferness of an arbitrary window
730 by comparing against this; use the MINI_WINDOW_P macro instead. */
732 extern Lisp_Object minibuf_window;
734 /* Non-nil means it is the window whose mode line should be
735 shown as the selected window when the minibuffer is selected. */
737 extern Lisp_Object minibuf_selected_window;
739 /* Non-nil => window to for C-M-v to scroll when the minibuffer is
740 selected. */
742 extern Lisp_Object Vminibuf_scroll_window;
744 /* Nil or a symbol naming the window system under which emacs is
745 running ('x is the only current possibility) */
747 extern Lisp_Object Vwindow_system;
749 /* Version number of X windows: 10, 11 or nil. */
751 extern Lisp_Object Vwindow_system_version;
753 /* Window that the mouse is over (nil if no mouse support). */
755 extern Lisp_Object Vmouse_window;
757 /* Last mouse-click event (nil if no mouse support). */
759 extern Lisp_Object Vmouse_event;
761 EXFUN (Fnext_window, 3);
762 EXFUN (Fselect_window, 2);
763 EXFUN (Fdisplay_buffer, 3);
764 EXFUN (Fset_window_buffer, 3);
765 EXFUN (Fset_window_hscroll, 2);
766 EXFUN (Fwindow_hscroll, 1);
767 EXFUN (Fset_window_vscroll, 3);
768 EXFUN (Fwindow_vscroll, 2);
769 EXFUN (Fset_window_margins, 3);
770 EXFUN (Fwindow_live_p, 1);
771 EXFUN (Fset_window_point, 2);
772 extern Lisp_Object make_window P_ ((void));
773 extern void delete_window P_ ((Lisp_Object));
774 extern Lisp_Object window_from_coordinates P_ ((struct frame *, int, int,
775 enum window_part *,
776 int *, int*, int));
777 EXFUN (Fwindow_dedicated_p, 1);
778 extern int window_height P_ ((Lisp_Object));
779 extern int window_width P_ ((Lisp_Object));
780 extern void set_window_height P_ ((Lisp_Object, int, int));
781 extern void set_window_width P_ ((Lisp_Object, int, int));
782 extern void change_window_heights P_ ((Lisp_Object, int));
783 extern void delete_all_subwindows P_ ((struct window *));
784 extern void freeze_window_starts P_ ((struct frame *, int));
785 extern void foreach_window P_ ((struct frame *,
786 int (* fn) (struct window *, void *),
787 void *));
788 extern void grow_mini_window P_ ((struct window *, int));
789 extern void shrink_mini_window P_ ((struct window *));
792 /* Make WINDOW display BUFFER as its contents. RUN_HOOKS_P non-zero
793 means it's allowed to run hooks. See make_frame for a case where
794 it's not allowed. */
796 void set_window_buffer P_ ((Lisp_Object window, Lisp_Object buffer,
797 int run_hooks_p, int keep_margins_p));
799 /* Prompt to display in front of the minibuffer contents. */
801 extern Lisp_Object minibuf_prompt;
803 /* The visual width of the above. */
805 extern int minibuf_prompt_width;
807 /* This is the window where the echo area message was displayed. It
808 is always a minibuffer window, but it may not be the same window
809 currently active as a minibuffer. */
811 extern Lisp_Object echo_area_window;
813 /* Depth in recursive edits. */
815 extern int command_loop_level;
817 /* Depth in minibuffer invocations. */
819 extern int minibuf_level;
821 /* true iff we should redraw the mode lines on the next redisplay. */
823 extern int update_mode_lines;
825 /* Nonzero if BEGV - BEG or Z - ZV of current buffer has changed since
826 last redisplay that finished. */
828 extern int clip_changed;
830 /* Nonzero if window sizes or contents have changed since last
831 redisplay that finished */
833 extern int windows_or_buffers_changed;
835 /* Nonzero means a frame's cursor type has been changed. */
837 extern int cursor_type_changed;
839 /* Number of windows displaying the selected buffer. Normally this is
840 1, but it can be more. */
842 extern int buffer_shared;
844 /* If *ROWS or *COLS are too small a size for FRAME, set them to the
845 minimum allowable size. */
847 extern void check_frame_size P_ ((struct frame *frame, int *rows, int *cols));
849 /* Return a pointer to the glyph W's physical cursor is on. Value is
850 null if W's current matrix is invalid, so that no meaningfull glyph
851 can be returned. */
853 struct glyph *get_phys_cursor_glyph P_ ((struct window *w));
855 /* Value is non-zero if WINDOW is a live window. */
857 #define WINDOW_LIVE_P(WINDOW) \
858 (WINDOWP ((WINDOW)) && !NILP (XWINDOW ((WINDOW))->buffer))
861 /* These used to be in lisp.h. */
863 extern Lisp_Object Qwindowp, Qwindow_live_p;
864 extern Lisp_Object Vwindow_list;
866 EXFUN (Fwindow_end, 2);
867 EXFUN (Fselected_window, 0);
868 EXFUN (Fdelete_window, 1);
869 EXFUN (Fwindow_buffer, 1);
870 EXFUN (Fget_buffer_window, 2);
871 EXFUN (Fsave_window_excursion, UNEVALLED);
872 EXFUN (Fsplit_window, 3);
873 EXFUN (Fset_window_configuration, 1);
874 EXFUN (Fcurrent_window_configuration, 1);
875 extern int compare_window_configurations P_ ((Lisp_Object, Lisp_Object, int));
876 EXFUN (Fcoordinates_in_window_p, 2);
877 EXFUN (Fwindow_at, 3);
878 EXFUN (Fpos_visible_in_window_p, 3);
879 extern void mark_window_cursors_off P_ ((struct window *));
880 extern int window_internal_height P_ ((struct window *));
881 extern int window_internal_width P_ ((struct window *));
882 EXFUN (Frecenter, 1);
883 EXFUN (Fscroll_other_window, 1);
884 EXFUN (Fset_window_start, 3);
885 extern void temp_output_buffer_show P_ ((Lisp_Object));
886 extern void replace_buffer_in_all_windows P_ ((Lisp_Object));
887 extern void init_window_once P_ ((void));
888 extern void init_window P_ ((void));
889 extern void syms_of_window P_ ((void));
890 extern void keys_of_window P_ ((void));
892 extern int window_box_text_cols P_ ((struct window *w));
894 #endif /* not WINDOW_H_INCLUDED */
896 /* arch-tag: d4a6942f-e433-4ffe-ac10-2c3574f28577
897 (do not change this comment) */