Commit | Line | Data |
---|---|---|
83b2229f | 1 | /* Window definitions for GNU Emacs. |
1262267a | 2 | Copyright (C) 1985, 1986, 1993, 1995 Free Software Foundation, Inc. |
83b2229f JB |
3 | |
4 | This file is part of GNU Emacs. | |
5 | ||
6 | GNU Emacs is free software; you can redistribute it and/or modify | |
7 | it under the terms of the GNU General Public License as published by | |
e5d77022 | 8 | the Free Software Foundation; either version 2, or (at your option) |
83b2229f JB |
9 | any later version. |
10 | ||
11 | GNU Emacs is distributed in the hope that it will be useful, | |
12 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | GNU General Public License for more details. | |
15 | ||
16 | You should have received a copy of the GNU General Public License | |
17 | along with GNU Emacs; see the file COPYING. If not, write to | |
3b7ad313 EN |
18 | the Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
19 | Boston, MA 02111-1307, USA. */ | |
83b2229f | 20 | |
f43dd834 GM |
21 | #ifndef WINDOW_H_INCLUDED |
22 | #define WINDOW_H_INCLUDED | |
23 | ||
24 | #include "dispextern.h" | |
83b2229f JB |
25 | |
26 | /* Windows are allocated as if they were vectors, but then the | |
27 | Lisp data type is changed to Lisp_Window. They are garbage | |
28 | collected along with the vectors. | |
29 | ||
30 | All windows in use are arranged into a tree, with pointers up and down. | |
31 | ||
32 | Windows that are leaves of the tree are actually displayed | |
33 | and show the contents of buffers. Windows that are not leaves | |
34 | are used for representing the way groups of leaf windows are | |
44fa5b1e | 35 | arranged on the frame. Leaf windows never become non-leaves. |
83b2229f JB |
36 | They are deleted only by calling delete-window on them (but |
37 | this can be done implicitly). Combination windows can be created | |
38 | and deleted at any time. | |
39 | ||
40 | A leaf window has a non-nil buffer field, and also | |
41 | has markers in its start and pointm fields. Non-leaf windows | |
42 | have nil in these fields. | |
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 |
83b2229f JB |
47 | one above the next. Its vchild field points to the uppermost child. |
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. | |
55 | Its hchild field points to the leftmost child. In each child | |
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 | |
27daff1e | 77 | A dead window has its buffer, hchild, and vchild windows all 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 | { | |
90 | /* The first two fields are really the header of a vector */ | |
91 | /* The window code does not refer to them. */ | |
dc83de2d | 92 | EMACS_INT size; |
83b2229f | 93 | struct Lisp_Vector *vec_next; |
44fa5b1e JB |
94 | /* The frame this window is on. */ |
95 | Lisp_Object frame; | |
83b2229f JB |
96 | /* t if this window is a minibuffer window. */ |
97 | Lisp_Object mini_p; | |
98 | /* Following child (to right or down) at same level of tree */ | |
99 | Lisp_Object next; | |
100 | /* Preceding child (to left or up) at same level of tree */ | |
101 | Lisp_Object prev; | |
102 | /* First child of this window. */ | |
103 | /* vchild is used if this is a vertical combination, | |
104 | hchild if this is a horizontal combination. */ | |
105 | Lisp_Object hchild, vchild; | |
106 | /* The window this one is a child of. */ | |
107 | Lisp_Object parent; | |
108 | /* The upper left corner coordinates of this window, | |
44fa5b1e | 109 | as integers relative to upper left corner of frame = 0, 0 */ |
83b2229f JB |
110 | Lisp_Object left; |
111 | Lisp_Object top; | |
112 | /* The size of the window */ | |
113 | Lisp_Object height; | |
114 | Lisp_Object width; | |
115 | /* The buffer displayed in this window */ | |
116 | /* Of the fields vchild, hchild and buffer, only one is non-nil. */ | |
117 | Lisp_Object buffer; | |
118 | /* A marker pointing to where in the text to start displaying */ | |
119 | Lisp_Object start; | |
120 | /* A marker pointing to where in the text point is in this window, | |
121 | used only when the window is not selected. | |
122 | This exists so that when multiple windows show one buffer | |
123 | each one can have its own value of point. */ | |
124 | Lisp_Object pointm; | |
125 | /* Non-nil means next redisplay must use the value of start | |
126 | set up for it in advance. Set by scrolling commands. */ | |
127 | Lisp_Object force_start; | |
fbf44f72 RS |
128 | /* Non-nil means we have explicitly changed the value of start, |
129 | but that the next redisplay is not obliged to use the new value. */ | |
130 | Lisp_Object optional_new_start; | |
83b2229f JB |
131 | /* Number of columns display within the window is scrolled to the left. */ |
132 | Lisp_Object hscroll; | |
133 | /* Number saying how recently window was selected */ | |
134 | Lisp_Object use_time; | |
135 | /* Unique number of window assigned when it was created */ | |
136 | Lisp_Object sequence_number; | |
137 | /* No permanent meaning; used by save-window-excursion's bookkeeping */ | |
138 | Lisp_Object temslot; | |
139 | /* text.modified of displayed buffer as of last time display completed */ | |
140 | Lisp_Object last_modified; | |
cc885e42 RS |
141 | /* BUF_OVERLAY_MODIFIED of displayed buffer as of last complete update. */ |
142 | Lisp_Object last_overlay_modified; | |
83b2229f JB |
143 | /* Value of point at that time */ |
144 | Lisp_Object last_point; | |
30308d5e RS |
145 | /* Non-nil if the buffer was "modified" when the window |
146 | was last updated. */ | |
147 | Lisp_Object last_had_star; | |
a3c87d4e | 148 | /* This window's vertical scroll bar. This field is only for use |
7c299e7a | 149 | by the window-system-dependent code which implements the |
a3c87d4e JB |
150 | scroll bars; it can store anything it likes here. If this |
151 | window is newly created and we haven't displayed a scroll bar in | |
152 | it yet, or if the frame doesn't have any scroll bars, this is nil. */ | |
153 | Lisp_Object vertical_scroll_bar; | |
20a558dc | 154 | |
f43dd834 GM |
155 | /* Width of left and right marginal areas. A value of nil means |
156 | no margin. */ | |
157 | Lisp_Object left_margin_width; | |
158 | Lisp_Object right_margin_width; | |
159 | ||
83b2229f | 160 | /* The rest are currently not used or only half used */ |
44fa5b1e JB |
161 | /* Frame coords of mark as of last time display completed */ |
162 | /* May be nil if mark does not exist or was not on frame */ | |
83b2229f JB |
163 | Lisp_Object last_mark_x; |
164 | Lisp_Object last_mark_y; | |
f43dd834 GM |
165 | /* Z - the buffer position of the last glyph in the current matrix |
166 | of W. Only valid if WINDOW_END_VALID is not nil. */ | |
83b2229f | 167 | Lisp_Object window_end_pos; |
f43dd834 GM |
168 | /* Glyph matrix row of the last glyph in the current matrix |
169 | of W. Only valid if WINDOW_END_VALID is not nil. */ | |
170 | Lisp_Object window_end_vpos; | |
83b2229f JB |
171 | /* t if window_end_pos is truly valid. |
172 | This is nil if nontrivial redisplay is preempted | |
44fa5b1e JB |
173 | since in that case the frame image that window_end_pos |
174 | did not get onto the frame. */ | |
83b2229f | 175 | Lisp_Object window_end_valid; |
83b2229f JB |
176 | /* Non-nil means must regenerate mode line of this window */ |
177 | Lisp_Object update_mode_line; | |
178 | /* Non-nil means current value of `start' | |
179 | was the beginning of a line when it was chosen. */ | |
180 | Lisp_Object start_at_line_beg; | |
181 | /* Display-table to use for displaying chars in this window. | |
182 | Nil means use the buffer's own display-table. */ | |
183 | Lisp_Object display_table; | |
184 | /* Non-nil means window is marked as dedicated. */ | |
185 | Lisp_Object dedicated; | |
e024395e RS |
186 | /* Line number and position of a line somewhere above the |
187 | top of the screen. */ | |
188 | /* If this field is nil, it means we don't have a base line. */ | |
189 | Lisp_Object base_line_number; | |
190 | /* If this field is nil, it means we don't have a base line. | |
191 | If it is a buffer, it means don't display the line number | |
192 | as long as the window shows that buffer. */ | |
193 | Lisp_Object base_line_pos; | |
096855a6 RS |
194 | /* If we have highlighted the region (or any part of it), |
195 | this is the mark position that we used, as an integer. */ | |
196 | Lisp_Object region_showing; | |
1262267a KH |
197 | /* The column number currently displayed in this window's mode line, |
198 | or nil if column numbers are not being displayed. */ | |
199 | Lisp_Object column_number_displayed; | |
a3bee872 RS |
200 | /* If redisplay in this window goes beyond this buffer position, |
201 | must run the redisplay-end-trigger-hook. */ | |
202 | Lisp_Object redisplay_end_trigger; | |
5f47720c GM |
203 | /* Non-nil means don't delete this window for becoming "too small". */ |
204 | Lisp_Object too_small_ok; | |
f43dd834 GM |
205 | |
206 | /* No Lisp data may follow below this point without changing | |
207 | mark_object in alloc.c. The member current_matrix must be the | |
208 | first non-Lisp member. */ | |
209 | ||
210 | /* Glyph matrices. */ | |
211 | struct glyph_matrix *current_matrix; | |
212 | struct glyph_matrix *desired_matrix; | |
213 | ||
214 | /* Cursor position as of last update that completed without | |
215 | pause. This is the position of last_point. */ | |
216 | struct cursor_pos last_cursor; | |
217 | ||
218 | /* Intended cursor position. This is a position within the | |
219 | glyph matrix. */ | |
220 | struct cursor_pos cursor; | |
221 | ||
222 | /* Where the cursor actually is. */ | |
223 | struct cursor_pos phys_cursor; | |
224 | ||
225 | /* Cursor type last drawn on the window. Used for X frames; -1 | |
226 | initially. */ | |
227 | int phys_cursor_type; | |
228 | ||
229 | /* This is handy for undrawing the cursor. */ | |
230 | int phys_cursor_ascent, phys_cursor_height; | |
231 | ||
232 | /* Non-zero means the cursor is currently displayed. This can be | |
233 | set to zero by functions overpainting the cursor image. */ | |
234 | unsigned phys_cursor_on_p : 1; | |
235 | ||
236 | /* 0 means cursor is logically on, 1 means it's off. Used for | |
237 | blinking cursor. */ | |
238 | unsigned cursor_off_p : 1; | |
239 | ||
240 | /* Value of cursor_off_p as of the last redisplay. */ | |
241 | unsigned last_cursor_off_p : 1; | |
242 | ||
243 | /* 1 means desired matrix has been build and window must be | |
244 | updated in update_frame. */ | |
245 | unsigned must_be_updated_p : 1; | |
246 | ||
247 | /* Flag indicating that this window is not a real one. | |
248 | Currently only used for menu bar windows of frames. */ | |
249 | unsigned pseudo_window_p : 1; | |
250 | ||
251 | /* Amount by which lines of this window are scrolled in | |
252 | y-direction (smooth scrolling). */ | |
253 | int vscroll; | |
254 | ||
255 | /* Z_BYTE - the buffer position of the last glyph in the current matrix | |
256 | of W. Only valid if WINDOW_END_VALID is not nil. */ | |
257 | int window_end_bytepos; | |
258 | }; | |
83b2229f JB |
259 | |
260 | /* 1 if W is a minibuffer window. */ | |
261 | ||
f43dd834 | 262 | #define MINI_WINDOW_P(W) (!EQ ((W)->mini_p, Qnil)) |
83b2229f | 263 | |
f43dd834 | 264 | /* Return the window column at which the text in window W starts. |
8516ba9a RS |
265 | This is different from the `left' field because it does not include |
266 | a left-hand scroll bar if any. */ | |
267 | ||
268 | #define WINDOW_LEFT_MARGIN(W) \ | |
269 | (XFASTINT ((W)->left) \ | |
270 | + FRAME_LEFT_SCROLL_BAR_WIDTH (XFRAME (WINDOW_FRAME (W)))) | |
271 | ||
f43dd834 | 272 | /* Return the window column before which window W ends. |
8516ba9a RS |
273 | This includes a right-hand scroll bar, if any. */ |
274 | ||
275 | #define WINDOW_RIGHT_EDGE(W) \ | |
276 | (XFASTINT ((W)->left) + XFASTINT ((W)->width)) | |
277 | ||
f43dd834 | 278 | /* Return the window column before which the text in window W ends. |
8516ba9a | 279 | This is different from WINDOW_RIGHT_EDGE because it does not include |
14a65ffe RS |
280 | a scroll bar or window-separating line on the right edge. */ |
281 | ||
f43dd834 GM |
282 | #define WINDOW_RIGHT_MARGIN(W) \ |
283 | (WINDOW_RIGHT_EDGE (W) \ | |
284 | - (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (XFRAME (WINDOW_FRAME (W))) \ | |
285 | ? FRAME_SCROLL_BAR_COLS (XFRAME (WINDOW_FRAME (W))) \ | |
286 | : 0)) | |
8516ba9a RS |
287 | |
288 | /* 1 if window W takes up the full width of its frame. */ | |
289 | ||
290 | #define WINDOW_FULL_WIDTH_P(W) \ | |
291 | (XFASTINT ((W)->width) == FRAME_WINDOW_WIDTH (XFRAME (WINDOW_FRAME (W)))) | |
292 | ||
293 | /* 1 if window W's has no other windows to its right in its frame. */ | |
294 | ||
295 | #define WINDOW_RIGHTMOST_P(W) \ | |
296 | (WINDOW_RIGHT_EDGE (W) == FRAME_WINDOW_WIDTH (XFRAME (WINDOW_FRAME (W)))) | |
297 | ||
f43dd834 | 298 | |
83b2229f JB |
299 | /* This is the window in which the terminal's cursor should |
300 | be left when nothing is being done with it. This must | |
301 | always be a leaf window, and its buffer is selected by | |
302 | the top level editing loop at the end of each command. | |
303 | ||
304 | This value is always the same as | |
44fa5b1e | 305 | FRAME_SELECTED_WINDOW (selected_frame). */ |
83b2229f JB |
306 | |
307 | extern Lisp_Object selected_window; | |
308 | ||
309 | /* This is a time stamp for window selection, so we can find the least | |
310 | recently used window. Its only users are Fselect_window, | |
44fa5b1e | 311 | init_window_once, and make_frame. */ |
83b2229f JB |
312 | |
313 | extern int window_select_count; | |
314 | ||
44fa5b1e | 315 | /* The minibuffer window of the selected frame. |
83b2229f | 316 | Note that you cannot test for minibufferness of an arbitrary window |
fbfed6f0 | 317 | by comparing against this; use the MINI_WINDOW_P macro instead. */ |
83b2229f JB |
318 | |
319 | extern Lisp_Object minibuf_window; | |
320 | ||
f43dd834 GM |
321 | /* Non-nil => window to for C-M-v to scroll when the minibuffer is |
322 | selected. */ | |
323 | ||
83b2229f JB |
324 | extern Lisp_Object Vminibuf_scroll_window; |
325 | ||
f43dd834 GM |
326 | /* Nil or a symbol naming the window system under which emacs is |
327 | running ('x is the only current possibility) */ | |
328 | ||
83b2229f JB |
329 | extern Lisp_Object Vwindow_system; |
330 | ||
331 | /* Version number of X windows: 10, 11 or nil. */ | |
f43dd834 | 332 | |
83b2229f JB |
333 | extern Lisp_Object Vwindow_system_version; |
334 | ||
335 | /* Window that the mouse is over (nil if no mouse support). */ | |
f43dd834 | 336 | |
83b2229f JB |
337 | extern Lisp_Object Vmouse_window; |
338 | ||
339 | /* Last mouse-click event (nil if no mouse support). */ | |
f43dd834 | 340 | |
83b2229f JB |
341 | extern Lisp_Object Vmouse_event; |
342 | ||
4c571d09 AS |
343 | EXFUN (Fnext_window, 3); |
344 | EXFUN (Fselect_window, 1); | |
c2579332 | 345 | EXFUN (Fdisplay_buffer, 3); |
4c571d09 | 346 | EXFUN (Fset_window_buffer, 2); |
f43dd834 GM |
347 | EXFUN (Fset_window_hscroll, 2); |
348 | EXFUN (Fwindow_hscroll, 1); | |
349 | EXFUN (Fset_window_vscroll, 2); | |
350 | EXFUN (Fwindow_vscroll, 1); | |
351 | EXFUN (Fset_window_margins, 3); | |
4c571d09 AS |
352 | extern Lisp_Object make_window P_ ((void)); |
353 | extern void delete_window P_ ((Lisp_Object)); | |
f43dd834 | 354 | extern Lisp_Object window_from_coordinates P_ ((struct frame *, int, int, int *, int)); |
4c571d09 AS |
355 | EXFUN (Fwindow_dedicated_p, 1); |
356 | extern int window_height P_ ((Lisp_Object)); | |
357 | extern int window_width P_ ((Lisp_Object)); | |
358 | extern void set_window_height P_ ((Lisp_Object, int, int)); | |
359 | extern void set_window_width P_ ((Lisp_Object, int, int)); | |
360 | extern void change_window_height P_ ((int, int)); | |
361 | extern void delete_all_subwindows P_ ((struct window *)); | |
83b2229f | 362 | |
f43dd834 GM |
363 | /* Make WINDOW display BUFFER as its contents. RUN_HOOKS_P non-zero |
364 | means it's allowed to run hooks. See make_frame for a case where | |
365 | it's not allowed. */ | |
366 | ||
367 | void set_window_buffer P_ ((Lisp_Object window, Lisp_Object buffer, | |
368 | int run_hooks_p)); | |
369 | ||
83b2229f | 370 | /* Prompt to display in front of the minibuffer contents. */ |
f43dd834 | 371 | |
21826734 | 372 | extern Lisp_Object minibuf_prompt; |
83b2229f | 373 | |
56a98455 | 374 | /* The visual width of the above. */ |
f43dd834 | 375 | |
56a98455 JB |
376 | extern int minibuf_prompt_width; |
377 | ||
f43dd834 GM |
378 | /* Message to display instead of minibuffer contents. This is what |
379 | the functions error and message make, and command echoing uses it | |
380 | as well. It overrides the minibuf_prompt as well as the buffer. */ | |
381 | ||
83b2229f JB |
382 | extern char *echo_area_glyphs; |
383 | ||
f43dd834 GM |
384 | /* A Lisp string to display instead of mini-buffer contents, analogous |
385 | to echo_area_glyphs. If this is a string, display that string. | |
386 | Otherwise, if echo_area_glyphs is non-null, display that. */ | |
387 | ||
388 | extern Lisp_Object echo_area_message; | |
389 | ||
7f434d8e | 390 | /* This is the length of the message in echo_area_glyphs. */ |
f43dd834 | 391 | |
7f434d8e RS |
392 | extern int echo_area_glyphs_length; |
393 | ||
f43dd834 GM |
394 | /* Value of echo_area_glyphs when it was last acted on. If this is |
395 | nonzero, there is a message on the frame in the minibuffer and it | |
396 | should be erased as soon as it is no longer requested to appear. */ | |
397 | ||
832a0726 JB |
398 | extern char *previous_echo_glyphs; |
399 | ||
f43dd834 GM |
400 | extern Lisp_Object previous_echo_area_message; |
401 | ||
402 | /* This is the window where the echo area message was displayed. It | |
403 | is always a minibuffer window, but it may not be the same window | |
404 | currently active as a minibuffer. */ | |
405 | ||
c0acc112 RS |
406 | extern Lisp_Object echo_area_window; |
407 | ||
83b2229f | 408 | /* Depth in recursive edits. */ |
f43dd834 | 409 | |
83b2229f JB |
410 | extern int command_loop_level; |
411 | ||
412 | /* Depth in minibuffer invocations. */ | |
f43dd834 | 413 | |
83b2229f JB |
414 | extern int minibuf_level; |
415 | ||
416 | /* true iff we should redraw the mode lines on the next redisplay. */ | |
f43dd834 | 417 | |
83b2229f JB |
418 | extern int update_mode_lines; |
419 | ||
0bb083c2 | 420 | /* Minimum value of GPT - BEG since last redisplay that finished. */ |
83b2229f JB |
421 | |
422 | extern int beg_unchanged; | |
423 | ||
424 | /* Minimum value of Z - GPT since last redisplay that finished. */ | |
425 | ||
426 | extern int end_unchanged; | |
427 | ||
f43dd834 GM |
428 | /* MODIFF as of last redisplay that finished; if it matches MODIFF, |
429 | beg_unchanged and end_unchanged contain no useful information. */ | |
430 | ||
83b2229f JB |
431 | extern int unchanged_modified; |
432 | ||
f43dd834 GM |
433 | /* BUF_OVERLAY_MODIFF of current buffer, as of last redisplay that |
434 | finished; if it matches BUF_OVERLAY_MODIFF, beg_unchanged and | |
435 | end_unchanged contain no useful information. */ | |
436 | ||
cc885e42 RS |
437 | extern int overlay_unchanged_modified; |
438 | ||
f43dd834 GM |
439 | /* Nonzero if BEGV - BEG or Z - ZV of current buffer has changed since |
440 | last redisplay that finished. */ | |
441 | ||
83b2229f JB |
442 | extern int clip_changed; |
443 | ||
f43dd834 GM |
444 | /* Nonzero if window sizes or contents have changed since last |
445 | redisplay that finished */ | |
446 | ||
83b2229f JB |
447 | extern int windows_or_buffers_changed; |
448 | ||
f43dd834 GM |
449 | /* Number of windows displaying the selected buffer. Normally this is |
450 | 1, but it can be more. */ | |
451 | ||
83b2229f | 452 | extern int buffer_shared; |
fbfed6f0 JB |
453 | |
454 | /* If *ROWS or *COLS are too small a size for FRAME, set them to the | |
455 | minimum allowable size. */ | |
f43dd834 | 456 | |
4c571d09 | 457 | extern void check_frame_size P_ ((struct frame *frame, int *rows, int *cols)); |
f43dd834 GM |
458 | |
459 | /* Return a pointer to the glyph W's physical cursor is on. Value is | |
460 | null if W's current matrix is invalid, so that no meaningfull glyph | |
461 | can be returned. */ | |
462 | ||
463 | struct glyph *get_phys_cursor_glyph P_ ((struct window *w)); | |
464 | ||
465 | #endif /* not WINDOW_H_INCLUDED */ |