361
|
1 /* Window definitions for GNU Emacs.
|
|
2 Copyright (C) 1985, 1986 Free Software Foundation, Inc.
|
|
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
|
|
8 the Free Software Foundation; either version 1, or (at your option)
|
|
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
|
|
30 arranged on the screen. Leaf windows never become non-leaves.
|
|
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
|
|
41 A vertical combination window has children that are arranged on the screen
|
|
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
|
|
60 the screen area that is not minibuffer, and is called the root window.
|
|
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
|
|
66 In any case, prev of the minibuf window is the root window and
|
|
67 next of the root window is the minibuf window. To find the
|
|
68 root window at any time, do XWINDOW (minibuf_window)->prev.
|
|
69
|
|
70 */
|
|
71
|
|
72 struct window
|
|
73 {
|
|
74 /* The first two fields are really the header of a vector */
|
|
75 /* The window code does not refer to them. */
|
|
76 int size;
|
|
77 struct Lisp_Vector *vec_next;
|
|
78 /* The screen this window is on. */
|
|
79 Lisp_Object screen;
|
|
80 /* t if this window is a minibuffer window. */
|
|
81 Lisp_Object mini_p;
|
|
82 /* Following child (to right or down) at same level of tree */
|
|
83 Lisp_Object next;
|
|
84 /* Preceding child (to left or up) at same level of tree */
|
|
85 Lisp_Object prev;
|
|
86 /* First child of this window. */
|
|
87 /* vchild is used if this is a vertical combination,
|
|
88 hchild if this is a horizontal combination. */
|
|
89 Lisp_Object hchild, vchild;
|
|
90 /* The window this one is a child of. */
|
|
91 Lisp_Object parent;
|
|
92 /* The upper left corner coordinates of this window,
|
|
93 as integers relative to upper left corner of screen = 0, 0 */
|
|
94 Lisp_Object left;
|
|
95 Lisp_Object top;
|
|
96 /* The size of the window */
|
|
97 Lisp_Object height;
|
|
98 Lisp_Object width;
|
|
99 /* The buffer displayed in this window */
|
|
100 /* Of the fields vchild, hchild and buffer, only one is non-nil. */
|
|
101 Lisp_Object buffer;
|
|
102 /* A marker pointing to where in the text to start displaying */
|
|
103 Lisp_Object start;
|
|
104 /* A marker pointing to where in the text point is in this window,
|
|
105 used only when the window is not selected.
|
|
106 This exists so that when multiple windows show one buffer
|
|
107 each one can have its own value of point. */
|
|
108 Lisp_Object pointm;
|
|
109 /* Non-nil means next redisplay must use the value of start
|
|
110 set up for it in advance. Set by scrolling commands. */
|
|
111 Lisp_Object force_start;
|
|
112 /* Number of columns display within the window is scrolled to the left. */
|
|
113 Lisp_Object hscroll;
|
|
114 /* Number saying how recently window was selected */
|
|
115 Lisp_Object use_time;
|
|
116 /* Unique number of window assigned when it was created */
|
|
117 Lisp_Object sequence_number;
|
|
118 /* No permanent meaning; used by save-window-excursion's bookkeeping */
|
|
119 Lisp_Object temslot;
|
|
120 /* text.modified of displayed buffer as of last time display completed */
|
|
121 Lisp_Object last_modified;
|
|
122 /* Value of point at that time */
|
|
123 Lisp_Object last_point;
|
|
124 /* The rest are currently not used or only half used */
|
|
125 /* Screen coords of point at that time */
|
|
126 Lisp_Object last_point_x;
|
|
127 Lisp_Object last_point_y;
|
|
128 /* Screen coords of mark as of last time display completed */
|
|
129 /* May be nil if mark does not exist or was not on screen */
|
|
130 Lisp_Object last_mark_x;
|
|
131 Lisp_Object last_mark_y;
|
|
132 /* Number of characters in buffer past bottom of window,
|
|
133 as of last redisplay that finished. */
|
|
134 Lisp_Object window_end_pos;
|
|
135 /* t if window_end_pos is truly valid.
|
|
136 This is nil if nontrivial redisplay is preempted
|
|
137 since in that case the screen image that window_end_pos
|
|
138 did not get onto the screen. */
|
|
139 Lisp_Object window_end_valid;
|
|
140 /* Vertical position (relative to window top) of that buffer position
|
|
141 of the first of those characters */
|
|
142 Lisp_Object window_end_vpos;
|
|
143 /* Non-nil means must regenerate mode line of this window */
|
|
144 Lisp_Object update_mode_line;
|
|
145 /* Non-nil means current value of `start'
|
|
146 was the beginning of a line when it was chosen. */
|
|
147 Lisp_Object start_at_line_beg;
|
|
148 /* Display-table to use for displaying chars in this window.
|
|
149 Nil means use the buffer's own display-table. */
|
|
150 Lisp_Object display_table;
|
|
151 /* Non-nil means window is marked as dedicated. */
|
|
152 Lisp_Object dedicated;
|
|
153 };
|
|
154
|
|
155 /* 1 if W is a minibuffer window. */
|
|
156
|
|
157 #define MINI_WINDOW_P(W) (!EQ ((W)->mini_p, Qnil))
|
|
158
|
|
159 /* This is the window in which the terminal's cursor should
|
|
160 be left when nothing is being done with it. This must
|
|
161 always be a leaf window, and its buffer is selected by
|
|
162 the top level editing loop at the end of each command.
|
|
163
|
|
164 This value is always the same as
|
|
165 SCREEN_SELECTED_WINDOW (selected_screen). */
|
|
166
|
|
167 extern Lisp_Object selected_window;
|
|
168
|
|
169 /* This is a time stamp for window selection, so we can find the least
|
|
170 recently used window. Its only users are Fselect_window,
|
|
171 init_window_once, and make_screen. */
|
|
172
|
|
173 extern int window_select_count;
|
|
174
|
|
175 /* The minibuffer window of the selected screen.
|
|
176 Note that you cannot test for minibufferness of an arbitrary window
|
|
177 by comparing against this; but you can test for minibufferness of
|
|
178 the selected window or of any window that is displayed. */
|
|
179
|
|
180 extern Lisp_Object minibuf_window;
|
|
181
|
|
182 /* Non-nil => window to for C-M-v to scroll
|
|
183 when the minibuffer is selected. */
|
|
184 extern Lisp_Object Vminibuf_scroll_window;
|
|
185
|
|
186 /* nil or a symbol naming the window system
|
|
187 under which emacs is running
|
|
188 ('x is the only current possibility) */
|
|
189 extern Lisp_Object Vwindow_system;
|
|
190
|
|
191 /* Version number of X windows: 10, 11 or nil. */
|
|
192 extern Lisp_Object Vwindow_system_version;
|
|
193
|
|
194 /* Window that the mouse is over (nil if no mouse support). */
|
|
195 extern Lisp_Object Vmouse_window;
|
|
196
|
|
197 /* Last mouse-click event (nil if no mouse support). */
|
|
198 extern Lisp_Object Vmouse_event;
|
|
199
|
|
200 extern Lisp_Object Fnext_window ();
|
|
201 extern Lisp_Object Fselect_window ();
|
|
202 extern Lisp_Object Fdisplay_buffer ();
|
|
203 extern Lisp_Object Fset_window_buffer ();
|
|
204
|
|
205 /* Prompt to display in front of the minibuffer contents. */
|
|
206 extern char *minibuf_prompt;
|
|
207
|
|
208 /* Message to display instead of minibuffer contents.
|
|
209 This is what the functions error and message make,
|
|
210 and command echoing uses it as well. It overrides the
|
|
211 minibuf_prompt as well as the buffer. */
|
|
212 extern char *echo_area_glyphs;
|
|
213
|
|
214 /* Depth in recursive edits. */
|
|
215 extern int command_loop_level;
|
|
216
|
|
217 /* Depth in minibuffer invocations. */
|
|
218 extern int minibuf_level;
|
|
219
|
|
220 /* true iff we should redraw the mode lines on the next redisplay. */
|
|
221 extern int update_mode_lines;
|
|
222
|
|
223 /* Minimum value of GPT since last redisplay that finished. */
|
|
224
|
|
225 extern int beg_unchanged;
|
|
226
|
|
227 /* Minimum value of Z - GPT since last redisplay that finished. */
|
|
228
|
|
229 extern int end_unchanged;
|
|
230
|
|
231 /* MODIFF as of last redisplay that finished;
|
|
232 if it matches MODIFF, beg_unchanged and end_unchangedn
|
|
233 contain no useful information. */
|
|
234 extern int unchanged_modified;
|
|
235
|
|
236 /* Nonzero if BEGV - BEG or Z - ZV of current buffer has changed
|
|
237 since last redisplay that finished. */
|
|
238 extern int clip_changed;
|
|
239
|
|
240 /* Nonzero if window sizes or contents have changed
|
|
241 since last redisplay that finished */
|
|
242 extern int windows_or_buffers_changed;
|
|
243
|
|
244 /* Number of windows displaying the selected buffer.
|
|
245 Normally this is 1, but it can be more. */
|
|
246 extern int buffer_shared;
|