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