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 JB |
20 | |
21 | ||
22 | /* Windows are allocated as if they were vectors, but then the | |
23 | Lisp data type is changed to Lisp_Window. They are garbage | |
24 | collected along with the vectors. | |
25 | ||
26 | All windows in use are arranged into a tree, with pointers up and down. | |
27 | ||
28 | Windows that are leaves of the tree are actually displayed | |
29 | and show the contents of buffers. Windows that are not leaves | |
30 | are used for representing the way groups of leaf windows are | |
44fa5b1e | 31 | arranged on the frame. Leaf windows never become non-leaves. |
83b2229f JB |
32 | They are deleted only by calling delete-window on them (but |
33 | this can be done implicitly). Combination windows can be created | |
34 | and deleted at any time. | |
35 | ||
36 | A leaf window has a non-nil buffer field, and also | |
37 | has markers in its start and pointm fields. Non-leaf windows | |
38 | have nil in these fields. | |
39 | ||
40 | Non-leaf windows are either vertical or horizontal combinations. | |
41 | ||
44fa5b1e | 42 | A vertical combination window has children that are arranged on the frame |
83b2229f JB |
43 | one above the next. Its vchild field points to the uppermost child. |
44 | The parent field of each of the children points to the vertical | |
45 | combination window. The next field of each child points to the | |
46 | child below it, or is nil for the lowest child. The prev field | |
47 | of each child points to the child above it, or is nil for the | |
48 | highest child. | |
49 | ||
50 | A horizontal combination window has children that are side by side. | |
51 | Its hchild field points to the leftmost child. In each child | |
52 | the next field points to the child to the right and the prev field | |
53 | points to the child to the left. | |
54 | ||
55 | The children of a vertical combination window may be leaf windows | |
56 | or horizontal combination windows. The children of a horizontal | |
57 | combination window may be leaf windows or vertical combination windows. | |
58 | ||
59 | At the top of the tree are two windows which have nil as parent. | |
60 | The second of these is minibuf_window. The first one manages all | |
44fa5b1e | 61 | the frame area that is not minibuffer, and is called the root window. |
83b2229f JB |
62 | Different windows can be the root at different times; |
63 | initially the root window is a leaf window, but if more windows | |
64 | are created then that leaf window ceases to be root and a newly | |
65 | made combination window becomes root instead. | |
66 | ||
fbfed6f0 JB |
67 | In any case, on screens which have an ordinary window and a |
68 | minibuffer, prev of the minibuf window is the root window and next of | |
69 | the root window is the minibuf window. On minibufferless screens or | |
70 | minibuffer-only screens, the root window and the minibuffer window are | |
27daff1e | 71 | one and the same, so its prev and next members are nil. |
83b2229f | 72 | |
27daff1e | 73 | A dead window has its buffer, hchild, and vchild windows all nil. */ |
83b2229f JB |
74 | |
75 | struct window | |
76 | { | |
77 | /* The first two fields are really the header of a vector */ | |
78 | /* The window code does not refer to them. */ | |
dc83de2d | 79 | EMACS_INT size; |
83b2229f | 80 | struct Lisp_Vector *vec_next; |
44fa5b1e JB |
81 | /* The frame this window is on. */ |
82 | Lisp_Object frame; | |
83b2229f JB |
83 | /* t if this window is a minibuffer window. */ |
84 | Lisp_Object mini_p; | |
85 | /* Following child (to right or down) at same level of tree */ | |
86 | Lisp_Object next; | |
87 | /* Preceding child (to left or up) at same level of tree */ | |
88 | Lisp_Object prev; | |
89 | /* First child of this window. */ | |
90 | /* vchild is used if this is a vertical combination, | |
91 | hchild if this is a horizontal combination. */ | |
92 | Lisp_Object hchild, vchild; | |
93 | /* The window this one is a child of. */ | |
94 | Lisp_Object parent; | |
95 | /* The upper left corner coordinates of this window, | |
44fa5b1e | 96 | as integers relative to upper left corner of frame = 0, 0 */ |
83b2229f JB |
97 | Lisp_Object left; |
98 | Lisp_Object top; | |
99 | /* The size of the window */ | |
100 | Lisp_Object height; | |
101 | Lisp_Object width; | |
102 | /* The buffer displayed in this window */ | |
103 | /* Of the fields vchild, hchild and buffer, only one is non-nil. */ | |
104 | Lisp_Object buffer; | |
105 | /* A marker pointing to where in the text to start displaying */ | |
106 | Lisp_Object start; | |
107 | /* A marker pointing to where in the text point is in this window, | |
108 | used only when the window is not selected. | |
109 | This exists so that when multiple windows show one buffer | |
110 | each one can have its own value of point. */ | |
111 | Lisp_Object pointm; | |
112 | /* Non-nil means next redisplay must use the value of start | |
113 | set up for it in advance. Set by scrolling commands. */ | |
114 | Lisp_Object force_start; | |
115 | /* Number of columns display within the window is scrolled to the left. */ | |
116 | Lisp_Object hscroll; | |
117 | /* Number saying how recently window was selected */ | |
118 | Lisp_Object use_time; | |
119 | /* Unique number of window assigned when it was created */ | |
120 | Lisp_Object sequence_number; | |
121 | /* No permanent meaning; used by save-window-excursion's bookkeeping */ | |
122 | Lisp_Object temslot; | |
123 | /* text.modified of displayed buffer as of last time display completed */ | |
124 | Lisp_Object last_modified; | |
125 | /* Value of point at that time */ | |
126 | Lisp_Object last_point; | |
a3c87d4e | 127 | /* This window's vertical scroll bar. This field is only for use |
7c299e7a | 128 | by the window-system-dependent code which implements the |
a3c87d4e JB |
129 | scroll bars; it can store anything it likes here. If this |
130 | window is newly created and we haven't displayed a scroll bar in | |
131 | it yet, or if the frame doesn't have any scroll bars, this is nil. */ | |
132 | Lisp_Object vertical_scroll_bar; | |
20a558dc | 133 | |
83b2229f | 134 | /* The rest are currently not used or only half used */ |
44fa5b1e | 135 | /* Frame coords of point at that time */ |
83b2229f JB |
136 | Lisp_Object last_point_x; |
137 | Lisp_Object last_point_y; | |
44fa5b1e JB |
138 | /* Frame coords of mark as of last time display completed */ |
139 | /* May be nil if mark does not exist or was not on frame */ | |
83b2229f JB |
140 | Lisp_Object last_mark_x; |
141 | Lisp_Object last_mark_y; | |
142 | /* Number of characters in buffer past bottom of window, | |
143 | as of last redisplay that finished. */ | |
144 | Lisp_Object window_end_pos; | |
145 | /* t if window_end_pos is truly valid. | |
146 | This is nil if nontrivial redisplay is preempted | |
44fa5b1e JB |
147 | since in that case the frame image that window_end_pos |
148 | did not get onto the frame. */ | |
83b2229f JB |
149 | Lisp_Object window_end_valid; |
150 | /* Vertical position (relative to window top) of that buffer position | |
151 | of the first of those characters */ | |
152 | Lisp_Object window_end_vpos; | |
153 | /* Non-nil means must regenerate mode line of this window */ | |
154 | Lisp_Object update_mode_line; | |
155 | /* Non-nil means current value of `start' | |
156 | was the beginning of a line when it was chosen. */ | |
157 | Lisp_Object start_at_line_beg; | |
158 | /* Display-table to use for displaying chars in this window. | |
159 | Nil means use the buffer's own display-table. */ | |
160 | Lisp_Object display_table; | |
161 | /* Non-nil means window is marked as dedicated. */ | |
162 | Lisp_Object dedicated; | |
e024395e RS |
163 | /* Line number and position of a line somewhere above the |
164 | top of the screen. */ | |
165 | /* If this field is nil, it means we don't have a base line. */ | |
166 | Lisp_Object base_line_number; | |
167 | /* If this field is nil, it means we don't have a base line. | |
168 | If it is a buffer, it means don't display the line number | |
169 | as long as the window shows that buffer. */ | |
170 | Lisp_Object base_line_pos; | |
096855a6 RS |
171 | /* If we have highlighted the region (or any part of it), |
172 | this is the mark position that we used, as an integer. */ | |
173 | Lisp_Object region_showing; | |
1262267a KH |
174 | /* The column number currently displayed in this window's mode line, |
175 | or nil if column numbers are not being displayed. */ | |
176 | Lisp_Object column_number_displayed; | |
a3bee872 RS |
177 | /* If redisplay in this window goes beyond this buffer position, |
178 | must run the redisplay-end-trigger-hook. */ | |
179 | Lisp_Object redisplay_end_trigger; | |
83b2229f JB |
180 | }; |
181 | ||
182 | /* 1 if W is a minibuffer window. */ | |
183 | ||
184 | #define MINI_WINDOW_P(W) (!EQ ((W)->mini_p, Qnil)) | |
185 | ||
186 | /* This is the window in which the terminal's cursor should | |
187 | be left when nothing is being done with it. This must | |
188 | always be a leaf window, and its buffer is selected by | |
189 | the top level editing loop at the end of each command. | |
190 | ||
191 | This value is always the same as | |
44fa5b1e | 192 | FRAME_SELECTED_WINDOW (selected_frame). */ |
83b2229f JB |
193 | |
194 | extern Lisp_Object selected_window; | |
195 | ||
196 | /* This is a time stamp for window selection, so we can find the least | |
197 | recently used window. Its only users are Fselect_window, | |
44fa5b1e | 198 | init_window_once, and make_frame. */ |
83b2229f JB |
199 | |
200 | extern int window_select_count; | |
201 | ||
44fa5b1e | 202 | /* The minibuffer window of the selected frame. |
83b2229f | 203 | Note that you cannot test for minibufferness of an arbitrary window |
fbfed6f0 | 204 | by comparing against this; use the MINI_WINDOW_P macro instead. */ |
83b2229f JB |
205 | |
206 | extern Lisp_Object minibuf_window; | |
207 | ||
208 | /* Non-nil => window to for C-M-v to scroll | |
209 | when the minibuffer is selected. */ | |
210 | extern Lisp_Object Vminibuf_scroll_window; | |
211 | ||
212 | /* nil or a symbol naming the window system | |
213 | under which emacs is running | |
214 | ('x is the only current possibility) */ | |
215 | extern Lisp_Object Vwindow_system; | |
216 | ||
217 | /* Version number of X windows: 10, 11 or nil. */ | |
218 | extern Lisp_Object Vwindow_system_version; | |
219 | ||
220 | /* Window that the mouse is over (nil if no mouse support). */ | |
221 | extern Lisp_Object Vmouse_window; | |
222 | ||
223 | /* Last mouse-click event (nil if no mouse support). */ | |
224 | extern Lisp_Object Vmouse_event; | |
225 | ||
226 | extern Lisp_Object Fnext_window (); | |
227 | extern Lisp_Object Fselect_window (); | |
228 | extern Lisp_Object Fdisplay_buffer (); | |
229 | extern Lisp_Object Fset_window_buffer (); | |
77511369 JB |
230 | extern Lisp_Object make_window (); |
231 | extern Lisp_Object window_from_coordinates (); | |
232 | extern Lisp_Object Fwindow_dedicated_p (); | |
83b2229f JB |
233 | |
234 | /* Prompt to display in front of the minibuffer contents. */ | |
21826734 | 235 | extern Lisp_Object minibuf_prompt; |
83b2229f | 236 | |
56a98455 JB |
237 | /* The visual width of the above. */ |
238 | extern int minibuf_prompt_width; | |
239 | ||
83b2229f JB |
240 | /* Message to display instead of minibuffer contents. |
241 | This is what the functions error and message make, | |
242 | and command echoing uses it as well. It overrides the | |
243 | minibuf_prompt as well as the buffer. */ | |
244 | extern char *echo_area_glyphs; | |
245 | ||
7f434d8e RS |
246 | /* This is the length of the message in echo_area_glyphs. */ |
247 | extern int echo_area_glyphs_length; | |
248 | ||
832a0726 JB |
249 | /* Value of echo_area_glyphs when it was last acted on. |
250 | If this is nonzero, there is a message on the frame | |
251 | in the minibuffer and it should be erased as soon | |
252 | as it is no longer requested to appear. */ | |
253 | extern char *previous_echo_glyphs; | |
254 | ||
c0acc112 RS |
255 | /* This is the window where the echo area message was displayed. |
256 | It is always a minibuffer window, but it may not be the | |
257 | same window currently active as a minibuffer. */ | |
258 | extern Lisp_Object echo_area_window; | |
259 | ||
83b2229f JB |
260 | /* Depth in recursive edits. */ |
261 | extern int command_loop_level; | |
262 | ||
263 | /* Depth in minibuffer invocations. */ | |
264 | extern int minibuf_level; | |
265 | ||
266 | /* true iff we should redraw the mode lines on the next redisplay. */ | |
267 | extern int update_mode_lines; | |
268 | ||
0bb083c2 | 269 | /* Minimum value of GPT - BEG since last redisplay that finished. */ |
83b2229f JB |
270 | |
271 | extern int beg_unchanged; | |
272 | ||
273 | /* Minimum value of Z - GPT since last redisplay that finished. */ | |
274 | ||
275 | extern int end_unchanged; | |
276 | ||
277 | /* MODIFF as of last redisplay that finished; | |
0bb083c2 | 278 | if it matches MODIFF, beg_unchanged and end_unchanged |
83b2229f JB |
279 | contain no useful information. */ |
280 | extern int unchanged_modified; | |
281 | ||
282 | /* Nonzero if BEGV - BEG or Z - ZV of current buffer has changed | |
283 | since last redisplay that finished. */ | |
284 | extern int clip_changed; | |
285 | ||
286 | /* Nonzero if window sizes or contents have changed | |
287 | since last redisplay that finished */ | |
288 | extern int windows_or_buffers_changed; | |
289 | ||
290 | /* Number of windows displaying the selected buffer. | |
291 | Normally this is 1, but it can be more. */ | |
292 | extern int buffer_shared; | |
fbfed6f0 JB |
293 | |
294 | /* If *ROWS or *COLS are too small a size for FRAME, set them to the | |
295 | minimum allowable size. */ | |
296 | extern void check_frame_size ( /* FRAME_PTR frame, int *rows, int *cols */ ); |