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