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