Commit | Line | Data |
---|---|---|
83b2229f | 1 | /* Window definitions for GNU Emacs. |
73b0cd50 | 2 | Copyright (C) 1985-1986, 1993, 1995, 1997-2011 |
8cabe764 | 3 | Free Software 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 | |
6000501b KS |
25 | extern Lisp_Object Qleft, Qright; |
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 | ||
41 | A leaf window has a non-nil buffer field, and also | |
42 | has markers in its start and pointm fields. Non-leaf windows | |
43 | have nil in these fields. | |
44 | ||
45 | Non-leaf windows are either vertical or horizontal combinations. | |
46 | ||
44fa5b1e | 47 | A vertical combination window has children that are arranged on the frame |
83b2229f JB |
48 | one above the next. Its vchild field points to the uppermost child. |
49 | The parent field of each of the children points to the vertical | |
50 | combination window. The next field of each child points to the | |
51 | child below it, or is nil for the lowest child. The prev field | |
52 | of each child points to the child above it, or is nil for the | |
53 | highest child. | |
54 | ||
55 | A horizontal combination window has children that are side by side. | |
56 | Its hchild field points to the leftmost child. In each child | |
57 | the next field points to the child to the right and the prev field | |
58 | points to the child to the left. | |
59 | ||
60 | The children of a vertical combination window may be leaf windows | |
61 | or horizontal combination windows. The children of a horizontal | |
62 | combination window may be leaf windows or vertical combination windows. | |
63 | ||
64 | At the top of the tree are two windows which have nil as parent. | |
65 | The second of these is minibuf_window. The first one manages all | |
44fa5b1e | 66 | the frame area that is not minibuffer, and is called the root window. |
83b2229f JB |
67 | Different windows can be the root at different times; |
68 | initially the root window is a leaf window, but if more windows | |
69 | are created then that leaf window ceases to be root and a newly | |
70 | made combination window becomes root instead. | |
71 | ||
fbfed6f0 JB |
72 | In any case, on screens which have an ordinary window and a |
73 | minibuffer, prev of the minibuf window is the root window and next of | |
74 | the root window is the minibuf window. On minibufferless screens or | |
75 | minibuffer-only screens, the root window and the minibuffer window are | |
27daff1e | 76 | one and the same, so its prev and next members are nil. |
83b2229f | 77 | |
27daff1e | 78 | A dead window has its buffer, hchild, and vchild windows all nil. */ |
83b2229f | 79 | |
f43dd834 GM |
80 | struct cursor_pos |
81 | { | |
82 | /* Pixel position. These are always window relative. */ | |
83 | int x, y; | |
84 | ||
85 | /* Glyph matrix position. */ | |
86 | int hpos, vpos; | |
87 | }; | |
88 | ||
83b2229f JB |
89 | struct window |
90 | { | |
91 | /* The first two fields are really the header of a vector */ | |
92 | /* The window code does not refer to them. */ | |
d0fdb6da | 93 | EMACS_UINT size; |
83b2229f | 94 | struct Lisp_Vector *vec_next; |
44fa5b1e JB |
95 | /* The frame this window is on. */ |
96 | Lisp_Object frame; | |
83b2229f JB |
97 | /* t if this window is a minibuffer window. */ |
98 | Lisp_Object mini_p; | |
99 | /* Following child (to right or down) at same level of tree */ | |
100 | Lisp_Object next; | |
101 | /* Preceding child (to left or up) at same level of tree */ | |
102 | Lisp_Object prev; | |
103 | /* First child of this window. */ | |
104 | /* vchild is used if this is a vertical combination, | |
105 | hchild if this is a horizontal combination. */ | |
106 | Lisp_Object hchild, vchild; | |
107 | /* The window this one is a child of. */ | |
108 | Lisp_Object parent; | |
109 | /* The upper left corner coordinates of this window, | |
44fa5b1e | 110 | as integers relative to upper left corner of frame = 0, 0 */ |
6000501b KS |
111 | Lisp_Object left_col; |
112 | Lisp_Object top_line; | |
83b2229f | 113 | /* The size of the window */ |
6000501b KS |
114 | Lisp_Object total_lines; |
115 | Lisp_Object total_cols; | |
83b2229f JB |
116 | /* The buffer displayed in this window */ |
117 | /* Of the fields vchild, hchild and buffer, only one is non-nil. */ | |
118 | Lisp_Object buffer; | |
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. */ | |
83b2229f JB |
123 | Lisp_Object start; |
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. */ | |
128 | Lisp_Object pointm; | |
129 | /* Non-nil means next redisplay must use the value of start | |
130 | set up for it in advance. Set by scrolling commands. */ | |
131 | Lisp_Object force_start; | |
fbf44f72 | 132 | /* Non-nil means we have explicitly changed the value of start, |
65113618 GM |
133 | but that the next redisplay is not obliged to use the new value. |
134 | This is used in Fdelete_other_windows to force a call to | |
f47d4504 | 135 | Vwindow_scroll_functions; also by Frecenter with argument. */ |
fbf44f72 | 136 | Lisp_Object optional_new_start; |
83b2229f JB |
137 | /* Number of columns display within the window is scrolled to the left. */ |
138 | Lisp_Object hscroll; | |
0248728d GM |
139 | /* Minimum hscroll for automatic hscrolling. This is the value |
140 | the user has set, by set-window-hscroll for example. */ | |
141 | Lisp_Object min_hscroll; | |
83b2229f JB |
142 | /* Number saying how recently window was selected */ |
143 | Lisp_Object use_time; | |
144 | /* Unique number of window assigned when it was created */ | |
145 | Lisp_Object sequence_number; | |
146 | /* No permanent meaning; used by save-window-excursion's bookkeeping */ | |
147 | Lisp_Object temslot; | |
148 | /* text.modified of displayed buffer as of last time display completed */ | |
149 | Lisp_Object last_modified; | |
cc885e42 RS |
150 | /* BUF_OVERLAY_MODIFIED of displayed buffer as of last complete update. */ |
151 | Lisp_Object last_overlay_modified; | |
83b2229f JB |
152 | /* Value of point at that time */ |
153 | Lisp_Object last_point; | |
30308d5e RS |
154 | /* Non-nil if the buffer was "modified" when the window |
155 | was last updated. */ | |
156 | Lisp_Object last_had_star; | |
a3c87d4e | 157 | /* This window's vertical scroll bar. This field is only for use |
7c299e7a | 158 | by the window-system-dependent code which implements the |
a3c87d4e JB |
159 | scroll bars; it can store anything it likes here. If this |
160 | window is newly created and we haven't displayed a scroll bar in | |
161 | it yet, or if the frame doesn't have any scroll bars, this is nil. */ | |
162 | Lisp_Object vertical_scroll_bar; | |
20a558dc | 163 | |
f43dd834 GM |
164 | /* Width of left and right marginal areas. A value of nil means |
165 | no margin. */ | |
6000501b KS |
166 | Lisp_Object left_margin_cols, right_margin_cols; |
167 | ||
168 | /* Width of left and right fringes. | |
169 | A value of nil or t means use frame values. */ | |
170 | Lisp_Object left_fringe_width, right_fringe_width; | |
171 | ||
172 | /* Non-nil means fringes are drawn outside display margins; | |
173 | othersize draw them between margin areas and text. */ | |
174 | Lisp_Object fringes_outside_margins; | |
175 | ||
176 | /* Pixel width of scroll bars. | |
177 | A value of nil or t means use frame values. */ | |
178 | Lisp_Object scroll_bar_width; | |
179 | /* Type of vertical scroll bar. A value of nil means | |
180 | no scroll bar. A value of t means use frame value. */ | |
181 | Lisp_Object vertical_scroll_bar_type; | |
f43dd834 | 182 | |
44fa5b1e JB |
183 | /* Frame coords of mark as of last time display completed */ |
184 | /* May be nil if mark does not exist or was not on frame */ | |
83b2229f JB |
185 | Lisp_Object last_mark_x; |
186 | Lisp_Object last_mark_y; | |
f43dd834 GM |
187 | /* Z - the buffer position of the last glyph in the current matrix |
188 | of W. Only valid if WINDOW_END_VALID is not nil. */ | |
83b2229f | 189 | Lisp_Object window_end_pos; |
f43dd834 GM |
190 | /* Glyph matrix row of the last glyph in the current matrix |
191 | of W. Only valid if WINDOW_END_VALID is not nil. */ | |
192 | Lisp_Object window_end_vpos; | |
83b2229f JB |
193 | /* t if window_end_pos is truly valid. |
194 | This is nil if nontrivial redisplay is preempted | |
44fa5b1e JB |
195 | since in that case the frame image that window_end_pos |
196 | did not get onto the frame. */ | |
83b2229f | 197 | Lisp_Object window_end_valid; |
83b2229f JB |
198 | /* Non-nil means must regenerate mode line of this window */ |
199 | Lisp_Object update_mode_line; | |
200 | /* Non-nil means current value of `start' | |
201 | was the beginning of a line when it was chosen. */ | |
202 | Lisp_Object start_at_line_beg; | |
203 | /* Display-table to use for displaying chars in this window. | |
204 | Nil means use the buffer's own display-table. */ | |
205 | Lisp_Object display_table; | |
206 | /* Non-nil means window is marked as dedicated. */ | |
207 | Lisp_Object dedicated; | |
e024395e RS |
208 | /* Line number and position of a line somewhere above the |
209 | top of the screen. */ | |
210 | /* If this field is nil, it means we don't have a base line. */ | |
211 | Lisp_Object base_line_number; | |
212 | /* If this field is nil, it means we don't have a base line. | |
213 | If it is a buffer, it means don't display the line number | |
214 | as long as the window shows that buffer. */ | |
215 | Lisp_Object base_line_pos; | |
096855a6 RS |
216 | /* If we have highlighted the region (or any part of it), |
217 | this is the mark position that we used, as an integer. */ | |
218 | Lisp_Object region_showing; | |
1262267a KH |
219 | /* The column number currently displayed in this window's mode line, |
220 | or nil if column numbers are not being displayed. */ | |
221 | Lisp_Object column_number_displayed; | |
a3bee872 RS |
222 | /* If redisplay in this window goes beyond this buffer position, |
223 | must run the redisplay-end-trigger-hook. */ | |
224 | Lisp_Object redisplay_end_trigger; | |
92f774f3 MR |
225 | /* Non-nil means resizing windows will attempt to resize this window |
226 | proportionally. */ | |
227 | Lisp_Object resize_proportionally; | |
57209cba | 228 | |
e6841c3b | 229 | /* Original window height and top before mini-window was enlarged. */ |
6000501b | 230 | Lisp_Object orig_total_lines, orig_top_line; |
177c0ea7 | 231 | |
e6841c3b JB |
232 | /* An alist with parameteres. */ |
233 | Lisp_Object window_parameters; | |
234 | ||
f43dd834 GM |
235 | /* No Lisp data may follow below this point without changing |
236 | mark_object in alloc.c. The member current_matrix must be the | |
237 | first non-Lisp member. */ | |
238 | ||
239 | /* Glyph matrices. */ | |
240 | struct glyph_matrix *current_matrix; | |
241 | struct glyph_matrix *desired_matrix; | |
242 | ||
71a0ff9a KS |
243 | /* Scaling factor for the glyph_matrix size calculation in this window. |
244 | Used if window contains many small images or uses proportional fonts, | |
245 | as the normal may yield a matrix which is too small. */ | |
246 | int nrows_scale_factor, ncols_scale_factor; | |
247 | ||
f43dd834 GM |
248 | /* Cursor position as of last update that completed without |
249 | pause. This is the position of last_point. */ | |
250 | struct cursor_pos last_cursor; | |
251 | ||
252 | /* Intended cursor position. This is a position within the | |
253 | glyph matrix. */ | |
254 | struct cursor_pos cursor; | |
177c0ea7 | 255 | |
f43dd834 GM |
256 | /* Where the cursor actually is. */ |
257 | struct cursor_pos phys_cursor; | |
177c0ea7 JB |
258 | |
259 | /* Cursor type and width of last cursor drawn on the window. | |
7e913f91 KS |
260 | Used for X and w32 frames; -1 initially. */ |
261 | int phys_cursor_type, phys_cursor_width; | |
f43dd834 GM |
262 | |
263 | /* This is handy for undrawing the cursor. */ | |
264 | int phys_cursor_ascent, phys_cursor_height; | |
177c0ea7 | 265 | |
f43dd834 GM |
266 | /* Non-zero means the cursor is currently displayed. This can be |
267 | set to zero by functions overpainting the cursor image. */ | |
268 | unsigned phys_cursor_on_p : 1; | |
269 | ||
270 | /* 0 means cursor is logically on, 1 means it's off. Used for | |
271 | blinking cursor. */ | |
272 | unsigned cursor_off_p : 1; | |
273 | ||
274 | /* Value of cursor_off_p as of the last redisplay. */ | |
275 | unsigned last_cursor_off_p : 1; | |
276 | ||
277 | /* 1 means desired matrix has been build and window must be | |
278 | updated in update_frame. */ | |
279 | unsigned must_be_updated_p : 1; | |
280 | ||
281 | /* Flag indicating that this window is not a real one. | |
282 | Currently only used for menu bar windows of frames. */ | |
283 | unsigned pseudo_window_p : 1; | |
284 | ||
91a47a68 DN |
285 | /* 1 means the window start of this window is frozen and may not |
286 | be changed during redisplay. If point is not in the window, | |
287 | accept that. */ | |
288 | unsigned frozen_window_start_p : 1; | |
289 | ||
f43dd834 GM |
290 | /* Amount by which lines of this window are scrolled in |
291 | y-direction (smooth scrolling). */ | |
292 | int vscroll; | |
177c0ea7 | 293 | |
f43dd834 GM |
294 | /* Z_BYTE - the buffer position of the last glyph in the current matrix |
295 | of W. Only valid if WINDOW_END_VALID is not nil. */ | |
296 | int window_end_bytepos; | |
297 | }; | |
83b2229f JB |
298 | |
299 | /* 1 if W is a minibuffer window. */ | |
300 | ||
36d8561d | 301 | #define MINI_WINDOW_P(W) (!NILP ((W)->mini_p)) |
83b2229f | 302 | |
6000501b KS |
303 | /* General window layout: |
304 | ||
305 | LEFT_EDGE_COL RIGHT_EDGE_COL | |
306 | | | | |
307 | | | | |
308 | | BOX_LEFT_EDGE_COL | | |
309 | | | BOX_RIGHT_EDGE_COL | | |
310 | | | | | | |
311 | v v v v | |
312 | <-><-><---><-----------><---><-><-> | |
313 | ^ ^ ^ ^ ^ ^ ^ | |
314 | | | | | | | | | |
315 | | | | | | | +-- RIGHT_SCROLL_BAR_COLS | |
316 | | | | | | +----- RIGHT_FRINGE_WIDTH | |
317 | | | | | +--------- RIGHT_MARGIN_COLS | |
318 | | | | | | |
319 | | | | +------------------ TEXT_AREA_COLS | |
320 | | | | | |
321 | | | +--------------------------- LEFT_MARGIN_COLS | |
322 | | +------------------------------- LEFT_FRINGE_WIDTH | |
323 | +---------------------------------- LEFT_SCROLL_BAR_COLS | |
754dc3d8 | 324 | |
6000501b KS |
325 | */ |
326 | ||
327 | ||
328 | /* A handy macro. */ | |
329 | ||
330 | #define WINDOW_XFRAME(W) \ | |
331 | (XFRAME (WINDOW_FRAME ((W)))) | |
332 | ||
333 | /* Return the canonical column width of the frame of window W. */ | |
334 | ||
335 | #define WINDOW_FRAME_COLUMN_WIDTH(W) \ | |
336 | (FRAME_COLUMN_WIDTH (WINDOW_XFRAME ((W)))) | |
337 | ||
338 | /* Return the canonical column width of the frame of window W. */ | |
339 | ||
340 | #define WINDOW_FRAME_LINE_HEIGHT(W) \ | |
341 | (FRAME_LINE_HEIGHT (WINDOW_XFRAME ((W)))) | |
342 | ||
92f774f3 | 343 | /* Return the width of window W in canonical column units. |
6000501b | 344 | This includes scroll bars and fringes. */ |
8516ba9a | 345 | |
6000501b KS |
346 | #define WINDOW_TOTAL_COLS(W) \ |
347 | (XFASTINT ((W)->total_cols)) | |
348 | ||
92f774f3 | 349 | /* Return the height of window W in canonical line units. |
6000501b KS |
350 | This includes header and mode lines, if any. */ |
351 | ||
352 | #define WINDOW_TOTAL_LINES(W) \ | |
353 | (XFASTINT ((W)->total_lines)) | |
354 | ||
6000501b KS |
355 | /* Return the total pixel width of window W. */ |
356 | ||
357 | #define WINDOW_TOTAL_WIDTH(W) \ | |
358 | (WINDOW_TOTAL_COLS (W) * WINDOW_FRAME_COLUMN_WIDTH (W)) | |
359 | ||
360 | /* Return the total pixel height of window W. */ | |
361 | ||
362 | #define WINDOW_TOTAL_HEIGHT(W) \ | |
363 | (WINDOW_TOTAL_LINES (W) * WINDOW_FRAME_LINE_HEIGHT (W)) | |
364 | ||
365 | ||
366 | /* Return the canonical frame column at which window W starts. | |
367 | This includes a left-hand scroll bar, if any. */ | |
368 | ||
369 | #define WINDOW_LEFT_EDGE_COL(W) \ | |
370 | (XFASTINT ((W)->left_col)) | |
371 | ||
372 | /* Return the canonical frame column before which window W ends. | |
8516ba9a RS |
373 | This includes a right-hand scroll bar, if any. */ |
374 | ||
6000501b KS |
375 | #define WINDOW_RIGHT_EDGE_COL(W) \ |
376 | (WINDOW_LEFT_EDGE_COL (W) + WINDOW_TOTAL_COLS (W)) | |
8516ba9a | 377 | |
6000501b KS |
378 | /* Return the canonical frame line at which window W starts. |
379 | This includes a header line, if any. */ | |
380 | ||
381 | #define WINDOW_TOP_EDGE_LINE(W) \ | |
382 | (XFASTINT ((W)->top_line)) | |
383 | ||
384 | /* Return the canonical frame line before which window W ends. | |
385 | This includes a mode line, if any. */ | |
386 | ||
387 | #define WINDOW_BOTTOM_EDGE_LINE(W) \ | |
388 | (WINDOW_TOP_EDGE_LINE (W) + WINDOW_TOTAL_LINES (W)) | |
389 | ||
390 | ||
391 | /* Return the frame x-position at which window W starts. | |
392 | This includes a left-hand scroll bar, if any. */ | |
393 | ||
394 | #define WINDOW_LEFT_EDGE_X(W) \ | |
395 | (FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W)) \ | |
396 | + WINDOW_LEFT_EDGE_COL (W) * WINDOW_FRAME_COLUMN_WIDTH (W)) | |
397 | ||
398 | /* Return the frame x- position before which window W ends. | |
399 | This includes a right-hand scroll bar, if any. */ | |
400 | ||
401 | #define WINDOW_RIGHT_EDGE_X(W) \ | |
402 | (FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W)) \ | |
403 | + WINDOW_RIGHT_EDGE_COL (W) * WINDOW_FRAME_COLUMN_WIDTH (W)) | |
404 | ||
4b00d3b1 YM |
405 | /* 1 if W is a menu bar window. */ |
406 | ||
407 | #define WINDOW_MENU_BAR_P(W) \ | |
408 | (WINDOWP (WINDOW_XFRAME (W)->menu_bar_window) \ | |
409 | && (W) == XWINDOW (WINDOW_XFRAME (W)->menu_bar_window)) | |
410 | ||
411 | /* 1 if W is a tool bar window. */ | |
412 | ||
413 | #define WINDOW_TOOL_BAR_P(W) \ | |
414 | (WINDOWP (WINDOW_XFRAME (W)->tool_bar_window) \ | |
415 | && (W) == XWINDOW (WINDOW_XFRAME (W)->tool_bar_window)) | |
416 | ||
6000501b KS |
417 | /* Return the frame y-position at which window W starts. |
418 | This includes a header line, if any. */ | |
419 | ||
420 | #define WINDOW_TOP_EDGE_Y(W) \ | |
4b00d3b1 YM |
421 | (((WINDOW_MENU_BAR_P (W) || WINDOW_TOOL_BAR_P (W)) \ |
422 | ? 0 : FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W))) \ | |
6000501b KS |
423 | + WINDOW_TOP_EDGE_LINE (W) * WINDOW_FRAME_LINE_HEIGHT (W)) |
424 | ||
425 | /* Return the frame y-position before which window W ends. | |
426 | This includes a mode line, if any. */ | |
427 | ||
428 | #define WINDOW_BOTTOM_EDGE_Y(W) \ | |
4b00d3b1 YM |
429 | (((WINDOW_MENU_BAR_P (W) || WINDOW_TOOL_BAR_P (W)) \ |
430 | ? 0 : FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W))) \ | |
6000501b | 431 | + WINDOW_BOTTOM_EDGE_LINE (W) * WINDOW_FRAME_LINE_HEIGHT (W)) |
14a65ffe | 432 | |
8516ba9a | 433 | |
177c0ea7 | 434 | /* 1 if window W takes up the full width of its frame. */ |
8516ba9a RS |
435 | |
436 | #define WINDOW_FULL_WIDTH_P(W) \ | |
6000501b KS |
437 | (WINDOW_TOTAL_COLS (W) == FRAME_TOTAL_COLS (WINDOW_XFRAME (W))) |
438 | ||
439 | /* 1 if window W's has no other windows to its left in its frame. */ | |
440 | ||
441 | #define WINDOW_LEFTMOST_P(W) \ | |
442 | (WINDOW_LEFT_EDGE_COL (W) == 0) | |
8516ba9a | 443 | |
177c0ea7 | 444 | /* 1 if window W's has no other windows to its right in its frame. */ |
8516ba9a RS |
445 | |
446 | #define WINDOW_RIGHTMOST_P(W) \ | |
6000501b KS |
447 | (WINDOW_RIGHT_EDGE_COL (W) == FRAME_TOTAL_COLS (WINDOW_XFRAME (W))) |
448 | ||
449 | ||
450 | /* Return the frame column at which the text (or left fringe) in | |
451 | window W starts. This is different from the `LEFT_EDGE' because it | |
452 | does not include a left-hand scroll bar if any. */ | |
453 | ||
454 | #define WINDOW_BOX_LEFT_EDGE_COL(W) \ | |
455 | (WINDOW_LEFT_EDGE_COL (W) \ | |
456 | + WINDOW_LEFT_SCROLL_BAR_COLS (W)) | |
457 | ||
458 | /* Return the window column before which the text in window W ends. | |
459 | This is different from WINDOW_RIGHT_EDGE_COL because it does not | |
460 | include a scroll bar or window-separating line on the right edge. */ | |
461 | ||
462 | #define WINDOW_BOX_RIGHT_EDGE_COL(W) \ | |
463 | (WINDOW_RIGHT_EDGE_COL (W) \ | |
464 | - WINDOW_RIGHT_SCROLL_BAR_COLS (W)) | |
465 | ||
466 | ||
467 | /* Return the frame position at which the text (or left fringe) in | |
468 | window W starts. This is different from the `LEFT_EDGE' because it | |
469 | does not include a left-hand scroll bar if any. */ | |
470 | ||
471 | #define WINDOW_BOX_LEFT_EDGE_X(W) \ | |
472 | (FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W)) \ | |
473 | + WINDOW_BOX_LEFT_EDGE_COL (W) * WINDOW_FRAME_COLUMN_WIDTH (W)) | |
474 | ||
475 | /* Return the window column before which the text in window W ends. | |
476 | This is different from WINDOW_RIGHT_EDGE_COL because it does not | |
477 | include a scroll bar or window-separating line on the right edge. */ | |
478 | ||
479 | #define WINDOW_BOX_RIGHT_EDGE_X(W) \ | |
480 | (FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W)) \ | |
481 | + WINDOW_BOX_RIGHT_EDGE_COL (W) * WINDOW_FRAME_COLUMN_WIDTH (W)) | |
482 | ||
483 | ||
484 | /* Width of left margin area in columns. */ | |
485 | ||
486 | #define WINDOW_LEFT_MARGIN_COLS(W) \ | |
487 | (NILP ((W)->left_margin_cols) \ | |
488 | ? 0 \ | |
489 | : XINT ((W)->left_margin_cols)) | |
490 | ||
491 | /* Width of right marginal area in columns. */ | |
492 | ||
493 | #define WINDOW_RIGHT_MARGIN_COLS(W) \ | |
494 | (NILP ((W)->right_margin_cols) \ | |
495 | ? 0 \ | |
496 | : XINT ((W)->right_margin_cols)) | |
497 | ||
498 | /* Width of left margin area in pixels. */ | |
499 | ||
500 | #define WINDOW_LEFT_MARGIN_WIDTH(W) \ | |
501 | (NILP ((W)->left_margin_cols) \ | |
502 | ? 0 \ | |
503 | : (XINT ((W)->left_margin_cols) \ | |
504 | * WINDOW_FRAME_COLUMN_WIDTH (W))) | |
505 | ||
506 | /* Width of right marginal area in pixels. */ | |
507 | ||
508 | #define WINDOW_RIGHT_MARGIN_WIDTH(W) \ | |
509 | (NILP ((W)->right_margin_cols) \ | |
510 | ? 0 \ | |
511 | : (XINT ((W)->right_margin_cols) \ | |
512 | * WINDOW_FRAME_COLUMN_WIDTH (W))) | |
513 | ||
514 | /* Total width of fringes reserved for drawing truncation bitmaps, | |
515 | continuation bitmaps and alike. The width is in canonical char | |
516 | units of the frame. This must currently be the case because window | |
517 | sizes aren't pixel values. If it weren't the case, we wouldn't be | |
518 | able to split windows horizontally nicely. */ | |
519 | ||
520 | #define WINDOW_FRINGE_COLS(W) \ | |
521 | ((INTEGERP ((W)->left_fringe_width) \ | |
522 | || INTEGERP ((W)->right_fringe_width)) \ | |
523 | ? ((WINDOW_LEFT_FRINGE_WIDTH (W) \ | |
524 | + WINDOW_RIGHT_FRINGE_WIDTH (W) \ | |
525 | + WINDOW_FRAME_COLUMN_WIDTH (W) - 1) \ | |
526 | / WINDOW_FRAME_COLUMN_WIDTH (W)) \ | |
527 | : FRAME_FRINGE_COLS (WINDOW_XFRAME (W))) | |
528 | ||
01aa0b2e RS |
529 | /* Column-width of the left and right fringe. */ |
530 | ||
531 | #define WINDOW_LEFT_FRINGE_COLS(W) \ | |
532 | ((WINDOW_LEFT_FRINGE_WIDTH ((W)) \ | |
533 | + WINDOW_FRAME_COLUMN_WIDTH (W) - 1) \ | |
534 | / WINDOW_FRAME_COLUMN_WIDTH (W)) | |
535 | ||
536 | #define WINDOW_RIGHT_FRINGE_COLS(W) \ | |
537 | ((WINDOW_RIGHT_FRINGE_WIDTH ((W)) \ | |
538 | + WINDOW_FRAME_COLUMN_WIDTH (W) - 1) \ | |
539 | / WINDOW_FRAME_COLUMN_WIDTH (W)) | |
540 | ||
6000501b KS |
541 | /* Pixel-width of the left and right fringe. */ |
542 | ||
543 | #define WINDOW_LEFT_FRINGE_WIDTH(W) \ | |
544 | (INTEGERP ((W)->left_fringe_width) \ | |
545 | ? XFASTINT ((W)->left_fringe_width) \ | |
546 | : FRAME_LEFT_FRINGE_WIDTH (WINDOW_XFRAME (W))) | |
547 | ||
548 | #define WINDOW_RIGHT_FRINGE_WIDTH(W) \ | |
549 | (INTEGERP ((W)->right_fringe_width) \ | |
550 | ? XFASTINT ((W)->right_fringe_width) \ | |
551 | : FRAME_RIGHT_FRINGE_WIDTH (WINDOW_XFRAME (W))) | |
552 | ||
553 | /* Total width of fringes in pixels. */ | |
554 | ||
555 | #define WINDOW_TOTAL_FRINGE_WIDTH(W) \ | |
556 | (WINDOW_LEFT_FRINGE_WIDTH (W) + WINDOW_RIGHT_FRINGE_WIDTH (W)) | |
557 | ||
558 | /* Are fringes outside display margins in window W. */ | |
559 | ||
560 | #define WINDOW_HAS_FRINGES_OUTSIDE_MARGINS(W) \ | |
561 | (!NILP ((W)->fringes_outside_margins)) | |
562 | ||
563 | /* Say whether scroll bars are currently enabled for window W, | |
564 | and which side they are on. */ | |
565 | ||
566 | #define WINDOW_VERTICAL_SCROLL_BAR_TYPE(w) \ | |
567 | (EQ ((w)->vertical_scroll_bar_type, Qt) \ | |
568 | ? FRAME_VERTICAL_SCROLL_BAR_TYPE (WINDOW_XFRAME (w)) \ | |
569 | : EQ ((w)->vertical_scroll_bar_type, Qleft) \ | |
570 | ? vertical_scroll_bar_left \ | |
571 | : EQ ((w)->vertical_scroll_bar_type, Qright) \ | |
572 | ? vertical_scroll_bar_right \ | |
573 | : vertical_scroll_bar_none) \ | |
574 | ||
575 | #define WINDOW_HAS_VERTICAL_SCROLL_BAR(w) \ | |
576 | (EQ ((w)->vertical_scroll_bar_type, Qt) \ | |
577 | ? FRAME_HAS_VERTICAL_SCROLL_BARS (WINDOW_XFRAME (w)) \ | |
578 | : !NILP ((w)->vertical_scroll_bar_type)) | |
579 | ||
580 | #define WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT(w) \ | |
581 | (EQ ((w)->vertical_scroll_bar_type, Qt) \ | |
582 | ? FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (WINDOW_XFRAME (w)) \ | |
583 | : EQ ((w)->vertical_scroll_bar_type, Qleft)) | |
584 | ||
585 | #define WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT(w) \ | |
586 | (EQ ((w)->vertical_scroll_bar_type, Qt) \ | |
587 | ? FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (WINDOW_XFRAME (w))\ | |
588 | : EQ ((w)->vertical_scroll_bar_type, Qright)) | |
589 | ||
590 | /* Width that a scroll bar in window W should have, if there is one. | |
591 | Measured in pixels. If scroll bars are turned off, this is still | |
592 | nonzero. */ | |
593 | ||
594 | #define WINDOW_CONFIG_SCROLL_BAR_WIDTH(w) \ | |
595 | (INTEGERP ((w)->scroll_bar_width) \ | |
596 | ? XFASTINT ((w)->scroll_bar_width) \ | |
597 | : FRAME_CONFIG_SCROLL_BAR_WIDTH (WINDOW_XFRAME (w))) | |
598 | ||
599 | /* Width that a scroll bar in window W should have, if there is one. | |
600 | Measured in columns (characters). If scroll bars are turned off, | |
601 | this is still nonzero. */ | |
602 | ||
603 | #define WINDOW_CONFIG_SCROLL_BAR_COLS(w) \ | |
604 | (INTEGERP ((w)->scroll_bar_width) \ | |
605 | ? ((XFASTINT ((w)->scroll_bar_width) \ | |
606 | + WINDOW_FRAME_COLUMN_WIDTH (w) - 1) \ | |
607 | / WINDOW_FRAME_COLUMN_WIDTH (w)) \ | |
608 | : FRAME_CONFIG_SCROLL_BAR_COLS (WINDOW_XFRAME (w))) | |
609 | ||
610 | /* Width of a scroll bar in window W, measured in columns (characters), | |
611 | but only if scroll bars are on the left. If scroll bars are on | |
612 | the right in this frame, or there are no scroll bars, value is 0. */ | |
613 | ||
614 | #define WINDOW_LEFT_SCROLL_BAR_COLS(w) \ | |
615 | (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w) \ | |
616 | ? (WINDOW_CONFIG_SCROLL_BAR_COLS (w)) \ | |
617 | : 0) | |
618 | ||
619 | /* Width of a left scroll bar area in window W , measured in pixels. */ | |
620 | ||
621 | #define WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH(w) \ | |
622 | (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w) \ | |
623 | ? (WINDOW_CONFIG_SCROLL_BAR_COLS (w) * WINDOW_FRAME_COLUMN_WIDTH (w)) \ | |
624 | : 0) | |
625 | ||
626 | /* Width of a scroll bar in window W, measured in columns (characters), | |
627 | but only if scroll bars are on the right. If scroll bars are on | |
628 | the left in this frame, or there are no scroll bars, value is 0. */ | |
629 | ||
630 | #define WINDOW_RIGHT_SCROLL_BAR_COLS(w) \ | |
631 | (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w) \ | |
632 | ? WINDOW_CONFIG_SCROLL_BAR_COLS (w) \ | |
633 | : 0) | |
634 | ||
635 | /* Width of a left scroll bar area in window W , measured in pixels. */ | |
636 | ||
637 | #define WINDOW_RIGHT_SCROLL_BAR_AREA_WIDTH(w) \ | |
638 | (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w) \ | |
639 | ? (WINDOW_CONFIG_SCROLL_BAR_COLS (w) * WINDOW_FRAME_COLUMN_WIDTH (w)) \ | |
640 | : 0) | |
641 | ||
642 | ||
643 | /* Actual width of a scroll bar in window W, measured in columns. */ | |
644 | ||
645 | #define WINDOW_SCROLL_BAR_COLS(w) \ | |
646 | (WINDOW_HAS_VERTICAL_SCROLL_BAR (w) \ | |
647 | ? WINDOW_CONFIG_SCROLL_BAR_COLS (w) \ | |
648 | : 0) | |
649 | ||
650 | /* Width of a left scroll bar area in window W , measured in pixels. */ | |
651 | ||
652 | #define WINDOW_SCROLL_BAR_AREA_WIDTH(w) \ | |
653 | (WINDOW_HAS_VERTICAL_SCROLL_BAR (w) \ | |
654 | ? (WINDOW_CONFIG_SCROLL_BAR_COLS (w) * WINDOW_FRAME_COLUMN_WIDTH (w)) \ | |
655 | : 0) | |
656 | ||
657 | ||
658 | /* Return the frame position where the scroll bar of window W starts. */ | |
659 | ||
660 | #define WINDOW_SCROLL_BAR_AREA_X(W) \ | |
661 | (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (W) \ | |
662 | ? WINDOW_BOX_RIGHT_EDGE_X (W) \ | |
663 | : WINDOW_LEFT_EDGE_X (W)) | |
664 | ||
665 | ||
01aa0b2e RS |
666 | /* Height in pixels, and in lines, of the mode line. |
667 | May be zero if W doesn't have a mode line. */ | |
6000501b KS |
668 | |
669 | #define WINDOW_MODE_LINE_HEIGHT(W) \ | |
670 | (WINDOW_WANTS_MODELINE_P ((W)) \ | |
671 | ? CURRENT_MODE_LINE_HEIGHT (W) \ | |
672 | : 0) | |
673 | ||
01aa0b2e RS |
674 | #define WINDOW_MODE_LINE_LINES(W) \ |
675 | (!! WINDOW_WANTS_MODELINE_P ((W))) | |
676 | ||
677 | /* Height in pixels, and in lines, of the header line. | |
678 | Zero if W doesn't have a header line. */ | |
6000501b KS |
679 | |
680 | #define WINDOW_HEADER_LINE_HEIGHT(W) \ | |
681 | (WINDOW_WANTS_HEADER_LINE_P ((W)) \ | |
682 | ? CURRENT_HEADER_LINE_HEIGHT (W) \ | |
683 | : 0) | |
684 | ||
01aa0b2e RS |
685 | #define WINDOW_HEADER_LINE_LINES(W) \ |
686 | (!! WINDOW_WANTS_HEADER_LINE_P ((W))) | |
687 | ||
6000501b KS |
688 | /* Pixel height of window W without mode line. */ |
689 | ||
690 | #define WINDOW_BOX_HEIGHT_NO_MODE_LINE(W) \ | |
691 | (WINDOW_TOTAL_HEIGHT ((W)) \ | |
692 | - WINDOW_MODE_LINE_HEIGHT ((W))) | |
693 | ||
694 | /* Pixel height of window W without mode and header line. */ | |
695 | ||
696 | #define WINDOW_BOX_TEXT_HEIGHT(W) \ | |
697 | (WINDOW_TOTAL_HEIGHT ((W)) \ | |
698 | - WINDOW_MODE_LINE_HEIGHT ((W)) \ | |
699 | - WINDOW_HEADER_LINE_HEIGHT ((W))) | |
700 | ||
701 | ||
702 | /* Convert window W relative pixel X to frame pixel coordinates. */ | |
703 | ||
704 | #define WINDOW_TO_FRAME_PIXEL_X(W, X) \ | |
705 | ((X) + WINDOW_BOX_LEFT_EDGE_X ((W))) | |
706 | ||
707 | /* Convert window W relative pixel Y to frame pixel coordinates. */ | |
708 | ||
709 | #define WINDOW_TO_FRAME_PIXEL_Y(W, Y) \ | |
710 | ((Y) + WINDOW_TOP_EDGE_Y ((W))) | |
711 | ||
712 | /* Convert frame relative pixel X to window relative pixel X. */ | |
713 | ||
714 | #define FRAME_TO_WINDOW_PIXEL_X(W, X) \ | |
715 | ((X) - WINDOW_BOX_LEFT_EDGE_X ((W))) | |
716 | ||
717 | /* Convert frame relative pixel Y to window relative pixel Y. */ | |
718 | ||
719 | #define FRAME_TO_WINDOW_PIXEL_Y(W, Y) \ | |
720 | ((Y) - WINDOW_TOP_EDGE_Y ((W))) | |
721 | ||
722 | /* Convert a text area relative x-position in window W to frame X | |
723 | pixel coordinates. */ | |
177c0ea7 | 724 | |
6000501b KS |
725 | #define WINDOW_TEXT_TO_FRAME_PIXEL_X(W, X) \ |
726 | (window_box_left ((W), TEXT_AREA) + (X)) | |
f43dd834 | 727 | |
83b2229f JB |
728 | /* This is the window in which the terminal's cursor should |
729 | be left when nothing is being done with it. This must | |
730 | always be a leaf window, and its buffer is selected by | |
731 | the top level editing loop at the end of each command. | |
732 | ||
733 | This value is always the same as | |
44fa5b1e | 734 | FRAME_SELECTED_WINDOW (selected_frame). */ |
83b2229f JB |
735 | |
736 | extern Lisp_Object selected_window; | |
737 | ||
738 | /* This is a time stamp for window selection, so we can find the least | |
739 | recently used window. Its only users are Fselect_window, | |
44fa5b1e | 740 | init_window_once, and make_frame. */ |
83b2229f JB |
741 | |
742 | extern int window_select_count; | |
743 | ||
44fa5b1e | 744 | /* The minibuffer window of the selected frame. |
83b2229f | 745 | Note that you cannot test for minibufferness of an arbitrary window |
fbfed6f0 | 746 | by comparing against this; use the MINI_WINDOW_P macro instead. */ |
83b2229f JB |
747 | |
748 | extern Lisp_Object minibuf_window; | |
749 | ||
76e316e0 KS |
750 | /* Non-nil means it is the window whose mode line should be |
751 | shown as the selected window when the minibuffer is selected. */ | |
752 | ||
5705966b | 753 | extern Lisp_Object minibuf_selected_window; |
76e316e0 | 754 | |
83b2229f | 755 | /* Window that the mouse is over (nil if no mouse support). */ |
f43dd834 | 756 | |
83b2229f JB |
757 | extern Lisp_Object Vmouse_window; |
758 | ||
759 | /* Last mouse-click event (nil if no mouse support). */ | |
f43dd834 | 760 | |
83b2229f JB |
761 | extern Lisp_Object Vmouse_event; |
762 | ||
4c571d09 | 763 | EXFUN (Fnext_window, 3); |
f1321dc3 | 764 | EXFUN (Fselect_window, 2); |
6000501b | 765 | EXFUN (Fset_window_buffer, 3); |
30da6d95 | 766 | EXFUN (Fset_window_point, 2); |
383e0970 | 767 | extern Lisp_Object make_window (void); |
383e0970 | 768 | extern Lisp_Object window_from_coordinates (struct frame *, int, int, |
9173a8fb | 769 | enum window_part *, int); |
4c571d09 | 770 | EXFUN (Fwindow_dedicated_p, 1); |
383e0970 J |
771 | extern void set_window_height (Lisp_Object, int, int); |
772 | extern void set_window_width (Lisp_Object, int, int); | |
773 | extern void change_window_heights (Lisp_Object, int); | |
774 | extern void delete_all_subwindows (struct window *); | |
775 | extern void freeze_window_starts (struct frame *, int); | |
383e0970 J |
776 | extern void grow_mini_window (struct window *, int); |
777 | extern void shrink_mini_window (struct window *); | |
9173a8fb | 778 | extern int window_relative_x_coord (struct window *, enum window_part, int); |
57209cba | 779 | |
ef264c42 | 780 | void run_window_configuration_change_hook (struct frame *f); |
83b2229f | 781 | |
f43dd834 GM |
782 | /* Make WINDOW display BUFFER as its contents. RUN_HOOKS_P non-zero |
783 | means it's allowed to run hooks. See make_frame for a case where | |
784 | it's not allowed. */ | |
785 | ||
383e0970 J |
786 | void set_window_buffer (Lisp_Object window, Lisp_Object buffer, |
787 | int run_hooks_p, int keep_margins_p); | |
f43dd834 | 788 | |
f43dd834 GM |
789 | /* This is the window where the echo area message was displayed. It |
790 | is always a minibuffer window, but it may not be the same window | |
791 | currently active as a minibuffer. */ | |
792 | ||
c0acc112 RS |
793 | extern Lisp_Object echo_area_window; |
794 | ||
83b2229f | 795 | /* Depth in recursive edits. */ |
f43dd834 | 796 | |
83b2229f JB |
797 | extern int command_loop_level; |
798 | ||
799 | /* Depth in minibuffer invocations. */ | |
f43dd834 | 800 | |
83b2229f JB |
801 | extern int minibuf_level; |
802 | ||
e0f24100 | 803 | /* true if we should redraw the mode lines on the next redisplay. */ |
f43dd834 | 804 | |
83b2229f JB |
805 | extern int update_mode_lines; |
806 | ||
f43dd834 GM |
807 | /* Nonzero if BEGV - BEG or Z - ZV of current buffer has changed since |
808 | last redisplay that finished. */ | |
809 | ||
83b2229f JB |
810 | extern int clip_changed; |
811 | ||
f43dd834 GM |
812 | /* Nonzero if window sizes or contents have changed since last |
813 | redisplay that finished */ | |
814 | ||
83b2229f JB |
815 | extern int windows_or_buffers_changed; |
816 | ||
d1a0ea0a RS |
817 | /* Nonzero means a frame's cursor type has been changed. */ |
818 | ||
819 | extern int cursor_type_changed; | |
820 | ||
f43dd834 GM |
821 | /* Number of windows displaying the selected buffer. Normally this is |
822 | 1, but it can be more. */ | |
823 | ||
83b2229f | 824 | extern int buffer_shared; |
fbfed6f0 JB |
825 | |
826 | /* If *ROWS or *COLS are too small a size for FRAME, set them to the | |
827 | minimum allowable size. */ | |
f43dd834 | 828 | |
383e0970 | 829 | extern void check_frame_size (struct frame *frame, int *rows, int *cols); |
f43dd834 GM |
830 | |
831 | /* Return a pointer to the glyph W's physical cursor is on. Value is | |
832 | null if W's current matrix is invalid, so that no meaningfull glyph | |
833 | can be returned. */ | |
834 | ||
383e0970 | 835 | struct glyph *get_phys_cursor_glyph (struct window *w); |
f43dd834 | 836 | |
91523be9 GM |
837 | /* Value is non-zero if WINDOW is a live window. */ |
838 | ||
839 | #define WINDOW_LIVE_P(WINDOW) \ | |
840 | (WINDOWP ((WINDOW)) && !NILP (XWINDOW ((WINDOW))->buffer)) | |
841 | ||
9a274fbd SM |
842 | |
843 | /* These used to be in lisp.h. */ | |
844 | ||
845 | extern Lisp_Object Qwindowp, Qwindow_live_p; | |
846 | extern Lisp_Object Vwindow_list; | |
847 | ||
9a274fbd | 848 | EXFUN (Fselected_window, 0); |
e7b394e1 | 849 | EXFUN (Fwindow_minibuffer_p, 1); |
9a274fbd SM |
850 | EXFUN (Fdelete_window, 1); |
851 | EXFUN (Fwindow_buffer, 1); | |
852 | EXFUN (Fget_buffer_window, 2); | |
9a274fbd SM |
853 | EXFUN (Fset_window_configuration, 1); |
854 | EXFUN (Fcurrent_window_configuration, 1); | |
383e0970 | 855 | extern int compare_window_configurations (Lisp_Object, Lisp_Object, int); |
9a274fbd | 856 | EXFUN (Fpos_visible_in_window_p, 3); |
383e0970 J |
857 | extern void mark_window_cursors_off (struct window *); |
858 | extern int window_internal_height (struct window *); | |
9a274fbd | 859 | EXFUN (Frecenter, 1); |
383e0970 J |
860 | extern void temp_output_buffer_show (Lisp_Object); |
861 | extern void replace_buffer_in_all_windows (Lisp_Object); | |
862 | extern void init_window_once (void); | |
863 | extern void init_window (void); | |
864 | extern void syms_of_window (void); | |
865 | extern void keys_of_window (void); | |
866 | ||
867 | extern int window_box_text_cols (struct window *w); | |
9a274fbd | 868 | |
f43dd834 | 869 | #endif /* not WINDOW_H_INCLUDED */ |