Mercurial > emacs
annotate src/window.h @ 15603:d0d30042bdc4
(lw_toolkit_related_event_p): A predicate to identify toolkit-specific events.
author | Miles Bader <miles@gnu.org> |
---|---|
date | Thu, 04 Jul 1996 05:50:07 +0000 |
parents | f57ee448e79e |
children | b67b2e8eacb3 |
rev | line source |
---|---|
361 | 1 /* Window definitions for GNU Emacs. |
10440
055b4219b6d7
(struct window): New member column_number_displayed.
Karl Heuer <kwzh@gnu.org>
parents:
8833
diff
changeset
|
2 Copyright (C) 1985, 1986, 1993, 1995 Free Software Foundation, Inc. |
361 | 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 | |
732 | 8 the Free Software Foundation; either version 2, or (at your option) |
361 | 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 | |
14186
ee40177f6c68
Update FSF's address in the preamble.
Erik Naggum <erik@naggum.no>
parents:
13458
diff
changeset
|
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
ee40177f6c68
Update FSF's address in the preamble.
Erik Naggum <erik@naggum.no>
parents:
13458
diff
changeset
|
19 Boston, MA 02111-1307, USA. */ |
361 | 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 | |
769 | 31 arranged on the frame. Leaf windows never become non-leaves. |
361 | 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 | |
769 | 42 A vertical combination window has children that are arranged on the frame |
361 | 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 | |
769 | 61 the frame area that is not minibuffer, and is called the root window. |
361 | 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 | |
998 | 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 | |
1445
3b0906e2b82c
* window.h (struct window): Doc fix.
Jim Blandy <jimb@redhat.com>
parents:
998
diff
changeset
|
71 one and the same, so its prev and next members are nil. |
361 | 72 |
1445
3b0906e2b82c
* window.h (struct window): Doc fix.
Jim Blandy <jimb@redhat.com>
parents:
998
diff
changeset
|
73 A dead window has its buffer, hchild, and vchild windows all nil. */ |
361 | 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. */ | |
8833
e2b9f8616738
(struct window): Use EMACS_INT.
Richard M. Stallman <rms@gnu.org>
parents:
7950
diff
changeset
|
79 EMACS_INT size; |
361 | 80 struct Lisp_Vector *vec_next; |
769 | 81 /* The frame this window is on. */ |
82 Lisp_Object frame; | |
361 | 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, | |
769 | 96 as integers relative to upper left corner of frame = 0, 0 */ |
361 | 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; | |
15542
f57ee448e79e
(struct window): New field, last_had_star.
Richard M. Stallman <rms@gnu.org>
parents:
14186
diff
changeset
|
127 /* Non-nil if the buffer was "modified" when the window |
f57ee448e79e
(struct window): New field, last_had_star.
Richard M. Stallman <rms@gnu.org>
parents:
14186
diff
changeset
|
128 was last updated. */ |
f57ee448e79e
(struct window): New field, last_had_star.
Richard M. Stallman <rms@gnu.org>
parents:
14186
diff
changeset
|
129 Lisp_Object last_had_star; |
1994
73ce9dd21093
Use the term `scroll bar', instead of `scrollbar'.
Jim Blandy <jimb@redhat.com>
parents:
1872
diff
changeset
|
130 /* This window's vertical scroll bar. This field is only for use |
1784
11f62e53acff
Make scrollbar structures into lisp objects, so that they can be
Jim Blandy <jimb@redhat.com>
parents:
1717
diff
changeset
|
131 by the window-system-dependent code which implements the |
1994
73ce9dd21093
Use the term `scroll bar', instead of `scrollbar'.
Jim Blandy <jimb@redhat.com>
parents:
1872
diff
changeset
|
132 scroll bars; it can store anything it likes here. If this |
73ce9dd21093
Use the term `scroll bar', instead of `scrollbar'.
Jim Blandy <jimb@redhat.com>
parents:
1872
diff
changeset
|
133 window is newly created and we haven't displayed a scroll bar in |
73ce9dd21093
Use the term `scroll bar', instead of `scrollbar'.
Jim Blandy <jimb@redhat.com>
parents:
1872
diff
changeset
|
134 it yet, or if the frame doesn't have any scroll bars, this is nil. */ |
73ce9dd21093
Use the term `scroll bar', instead of `scrollbar'.
Jim Blandy <jimb@redhat.com>
parents:
1872
diff
changeset
|
135 Lisp_Object vertical_scroll_bar; |
1717
aa7d6d57504b
* frame.h (struct frame): New fields `can_have_scrollbars' and
Jim Blandy <jimb@redhat.com>
parents:
1526
diff
changeset
|
136 |
361 | 137 /* The rest are currently not used or only half used */ |
769 | 138 /* Frame coords of point at that time */ |
361 | 139 Lisp_Object last_point_x; |
140 Lisp_Object last_point_y; | |
769 | 141 /* Frame coords of mark as of last time display completed */ |
142 /* May be nil if mark does not exist or was not on frame */ | |
361 | 143 Lisp_Object last_mark_x; |
144 Lisp_Object last_mark_y; | |
145 /* Number of characters in buffer past bottom of window, | |
146 as of last redisplay that finished. */ | |
147 Lisp_Object window_end_pos; | |
148 /* t if window_end_pos is truly valid. | |
149 This is nil if nontrivial redisplay is preempted | |
769 | 150 since in that case the frame image that window_end_pos |
151 did not get onto the frame. */ | |
361 | 152 Lisp_Object window_end_valid; |
153 /* Vertical position (relative to window top) of that buffer position | |
154 of the first of those characters */ | |
155 Lisp_Object window_end_vpos; | |
156 /* Non-nil means must regenerate mode line of this window */ | |
157 Lisp_Object update_mode_line; | |
158 /* Non-nil means current value of `start' | |
159 was the beginning of a line when it was chosen. */ | |
160 Lisp_Object start_at_line_beg; | |
161 /* Display-table to use for displaying chars in this window. | |
162 Nil means use the buffer's own display-table. */ | |
163 Lisp_Object display_table; | |
164 /* Non-nil means window is marked as dedicated. */ | |
165 Lisp_Object dedicated; | |
2304
480abddc8bdd
(struct window): New fields base_line_number and base_line_pos.
Richard M. Stallman <rms@gnu.org>
parents:
1994
diff
changeset
|
166 /* Line number and position of a line somewhere above the |
480abddc8bdd
(struct window): New fields base_line_number and base_line_pos.
Richard M. Stallman <rms@gnu.org>
parents:
1994
diff
changeset
|
167 top of the screen. */ |
480abddc8bdd
(struct window): New fields base_line_number and base_line_pos.
Richard M. Stallman <rms@gnu.org>
parents:
1994
diff
changeset
|
168 /* If this field is nil, it means we don't have a base line. */ |
480abddc8bdd
(struct window): New fields base_line_number and base_line_pos.
Richard M. Stallman <rms@gnu.org>
parents:
1994
diff
changeset
|
169 Lisp_Object base_line_number; |
480abddc8bdd
(struct window): New fields base_line_number and base_line_pos.
Richard M. Stallman <rms@gnu.org>
parents:
1994
diff
changeset
|
170 /* If this field is nil, it means we don't have a base line. |
480abddc8bdd
(struct window): New fields base_line_number and base_line_pos.
Richard M. Stallman <rms@gnu.org>
parents:
1994
diff
changeset
|
171 If it is a buffer, it means don't display the line number |
480abddc8bdd
(struct window): New fields base_line_number and base_line_pos.
Richard M. Stallman <rms@gnu.org>
parents:
1994
diff
changeset
|
172 as long as the window shows that buffer. */ |
480abddc8bdd
(struct window): New fields base_line_number and base_line_pos.
Richard M. Stallman <rms@gnu.org>
parents:
1994
diff
changeset
|
173 Lisp_Object base_line_pos; |
2856
794899b97115
(struct window): New slot region_showing.
Richard M. Stallman <rms@gnu.org>
parents:
2304
diff
changeset
|
174 /* If we have highlighted the region (or any part of it), |
794899b97115
(struct window): New slot region_showing.
Richard M. Stallman <rms@gnu.org>
parents:
2304
diff
changeset
|
175 this is the mark position that we used, as an integer. */ |
794899b97115
(struct window): New slot region_showing.
Richard M. Stallman <rms@gnu.org>
parents:
2304
diff
changeset
|
176 Lisp_Object region_showing; |
10440
055b4219b6d7
(struct window): New member column_number_displayed.
Karl Heuer <kwzh@gnu.org>
parents:
8833
diff
changeset
|
177 /* The column number currently displayed in this window's mode line, |
055b4219b6d7
(struct window): New member column_number_displayed.
Karl Heuer <kwzh@gnu.org>
parents:
8833
diff
changeset
|
178 or nil if column numbers are not being displayed. */ |
055b4219b6d7
(struct window): New member column_number_displayed.
Karl Heuer <kwzh@gnu.org>
parents:
8833
diff
changeset
|
179 Lisp_Object column_number_displayed; |
13458
adc8fc9fe6ed
(struct window): New field redisplay_end_trigger.
Richard M. Stallman <rms@gnu.org>
parents:
12632
diff
changeset
|
180 /* If redisplay in this window goes beyond this buffer position, |
adc8fc9fe6ed
(struct window): New field redisplay_end_trigger.
Richard M. Stallman <rms@gnu.org>
parents:
12632
diff
changeset
|
181 must run the redisplay-end-trigger-hook. */ |
adc8fc9fe6ed
(struct window): New field redisplay_end_trigger.
Richard M. Stallman <rms@gnu.org>
parents:
12632
diff
changeset
|
182 Lisp_Object redisplay_end_trigger; |
361 | 183 }; |
184 | |
185 /* 1 if W is a minibuffer window. */ | |
186 | |
187 #define MINI_WINDOW_P(W) (!EQ ((W)->mini_p, Qnil)) | |
188 | |
189 /* This is the window in which the terminal's cursor should | |
190 be left when nothing is being done with it. This must | |
191 always be a leaf window, and its buffer is selected by | |
192 the top level editing loop at the end of each command. | |
193 | |
194 This value is always the same as | |
769 | 195 FRAME_SELECTED_WINDOW (selected_frame). */ |
361 | 196 |
197 extern Lisp_Object selected_window; | |
198 | |
199 /* This is a time stamp for window selection, so we can find the least | |
200 recently used window. Its only users are Fselect_window, | |
769 | 201 init_window_once, and make_frame. */ |
361 | 202 |
203 extern int window_select_count; | |
204 | |
769 | 205 /* The minibuffer window of the selected frame. |
361 | 206 Note that you cannot test for minibufferness of an arbitrary window |
998 | 207 by comparing against this; use the MINI_WINDOW_P macro instead. */ |
361 | 208 |
209 extern Lisp_Object minibuf_window; | |
210 | |
211 /* Non-nil => window to for C-M-v to scroll | |
212 when the minibuffer is selected. */ | |
213 extern Lisp_Object Vminibuf_scroll_window; | |
214 | |
215 /* nil or a symbol naming the window system | |
216 under which emacs is running | |
217 ('x is the only current possibility) */ | |
218 extern Lisp_Object Vwindow_system; | |
219 | |
220 /* Version number of X windows: 10, 11 or nil. */ | |
221 extern Lisp_Object Vwindow_system_version; | |
222 | |
223 /* Window that the mouse is over (nil if no mouse support). */ | |
224 extern Lisp_Object Vmouse_window; | |
225 | |
226 /* Last mouse-click event (nil if no mouse support). */ | |
227 extern Lisp_Object Vmouse_event; | |
228 | |
229 extern Lisp_Object Fnext_window (); | |
230 extern Lisp_Object Fselect_window (); | |
231 extern Lisp_Object Fdisplay_buffer (); | |
232 extern Lisp_Object Fset_window_buffer (); | |
1526
a45910fb5bbc
* window.h (make_window, window_from_coordinates,
Jim Blandy <jimb@redhat.com>
parents:
1445
diff
changeset
|
233 extern Lisp_Object make_window (); |
a45910fb5bbc
* window.h (make_window, window_from_coordinates,
Jim Blandy <jimb@redhat.com>
parents:
1445
diff
changeset
|
234 extern Lisp_Object window_from_coordinates (); |
a45910fb5bbc
* window.h (make_window, window_from_coordinates,
Jim Blandy <jimb@redhat.com>
parents:
1445
diff
changeset
|
235 extern Lisp_Object Fwindow_dedicated_p (); |
361 | 236 |
237 /* Prompt to display in front of the minibuffer contents. */ | |
7950
c0a4d26e7498
(minibuf_prompt): Now a Lisp_Object. All uses changed.
Karl Heuer <kwzh@gnu.org>
parents:
5235
diff
changeset
|
238 extern Lisp_Object minibuf_prompt; |
361 | 239 |
488 | 240 /* The visual width of the above. */ |
241 extern int minibuf_prompt_width; | |
242 | |
361 | 243 /* Message to display instead of minibuffer contents. |
244 This is what the functions error and message make, | |
245 and command echoing uses it as well. It overrides the | |
246 minibuf_prompt as well as the buffer. */ | |
247 extern char *echo_area_glyphs; | |
248 | |
5235
4ae7453678af
(echo_area_glyphs_length): Declared.
Richard M. Stallman <rms@gnu.org>
parents:
2961
diff
changeset
|
249 /* This is the length of the message in echo_area_glyphs. */ |
4ae7453678af
(echo_area_glyphs_length): Declared.
Richard M. Stallman <rms@gnu.org>
parents:
2961
diff
changeset
|
250 extern int echo_area_glyphs_length; |
4ae7453678af
(echo_area_glyphs_length): Declared.
Richard M. Stallman <rms@gnu.org>
parents:
2961
diff
changeset
|
251 |
1872
ad692b76edf4
* dispnew.c (remake_frame_glyphs): When re-allocating the frame's
Jim Blandy <jimb@redhat.com>
parents:
1784
diff
changeset
|
252 /* Value of echo_area_glyphs when it was last acted on. |
ad692b76edf4
* dispnew.c (remake_frame_glyphs): When re-allocating the frame's
Jim Blandy <jimb@redhat.com>
parents:
1784
diff
changeset
|
253 If this is nonzero, there is a message on the frame |
ad692b76edf4
* dispnew.c (remake_frame_glyphs): When re-allocating the frame's
Jim Blandy <jimb@redhat.com>
parents:
1784
diff
changeset
|
254 in the minibuffer and it should be erased as soon |
ad692b76edf4
* dispnew.c (remake_frame_glyphs): When re-allocating the frame's
Jim Blandy <jimb@redhat.com>
parents:
1784
diff
changeset
|
255 as it is no longer requested to appear. */ |
ad692b76edf4
* dispnew.c (remake_frame_glyphs): When re-allocating the frame's
Jim Blandy <jimb@redhat.com>
parents:
1784
diff
changeset
|
256 extern char *previous_echo_glyphs; |
ad692b76edf4
* dispnew.c (remake_frame_glyphs): When re-allocating the frame's
Jim Blandy <jimb@redhat.com>
parents:
1784
diff
changeset
|
257 |
12632
81f12c1d0178
(echo_area_window): Declared.
Richard M. Stallman <rms@gnu.org>
parents:
11171
diff
changeset
|
258 /* This is the window where the echo area message was displayed. |
81f12c1d0178
(echo_area_window): Declared.
Richard M. Stallman <rms@gnu.org>
parents:
11171
diff
changeset
|
259 It is always a minibuffer window, but it may not be the |
81f12c1d0178
(echo_area_window): Declared.
Richard M. Stallman <rms@gnu.org>
parents:
11171
diff
changeset
|
260 same window currently active as a minibuffer. */ |
81f12c1d0178
(echo_area_window): Declared.
Richard M. Stallman <rms@gnu.org>
parents:
11171
diff
changeset
|
261 extern Lisp_Object echo_area_window; |
81f12c1d0178
(echo_area_window): Declared.
Richard M. Stallman <rms@gnu.org>
parents:
11171
diff
changeset
|
262 |
361 | 263 /* Depth in recursive edits. */ |
264 extern int command_loop_level; | |
265 | |
266 /* Depth in minibuffer invocations. */ | |
267 extern int minibuf_level; | |
268 | |
269 /* true iff we should redraw the mode lines on the next redisplay. */ | |
270 extern int update_mode_lines; | |
271 | |
11171 | 272 /* Minimum value of GPT - BEG since last redisplay that finished. */ |
361 | 273 |
274 extern int beg_unchanged; | |
275 | |
276 /* Minimum value of Z - GPT since last redisplay that finished. */ | |
277 | |
278 extern int end_unchanged; | |
279 | |
280 /* MODIFF as of last redisplay that finished; | |
11171 | 281 if it matches MODIFF, beg_unchanged and end_unchanged |
361 | 282 contain no useful information. */ |
283 extern int unchanged_modified; | |
284 | |
285 /* Nonzero if BEGV - BEG or Z - ZV of current buffer has changed | |
286 since last redisplay that finished. */ | |
287 extern int clip_changed; | |
288 | |
289 /* Nonzero if window sizes or contents have changed | |
290 since last redisplay that finished */ | |
291 extern int windows_or_buffers_changed; | |
292 | |
293 /* Number of windows displaying the selected buffer. | |
294 Normally this is 1, but it can be more. */ | |
295 extern int buffer_shared; | |
998 | 296 |
297 /* If *ROWS or *COLS are too small a size for FRAME, set them to the | |
298 minimum allowable size. */ | |
299 extern void check_frame_size ( /* FRAME_PTR frame, int *rows, int *cols */ ); |