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