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