Mercurial > emacs
annotate src/window.h @ 3729:b9d69ed987e7
* s/linux.h (LIBS_MACHINE, HAVE_SYSVIPC): Set the former to -lipc,
and #define the latter.
author | Jim Blandy <jimb@redhat.com> |
---|---|
date | Mon, 14 Jun 1993 15:35:55 +0000 |
parents | e94a593c3952 |
children | 4ae7453678af |
rev | line source |
---|---|
361 | 1 /* Window definitions for GNU Emacs. |
2961 | 2 Copyright (C) 1985, 1986, 1993 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 | |
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 | |
769 | 30 arranged on the frame. Leaf windows never become non-leaves. |
361 | 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 | |
769 | 41 A vertical combination window has children that are arranged on the frame |
361 | 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 | |
769 | 60 the frame area that is not minibuffer, and is called the root window. |
361 | 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 | |
998 | 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 | |
1445
3b0906e2b82c
* window.h (struct window): Doc fix.
Jim Blandy <jimb@redhat.com>
parents:
998
diff
changeset
|
70 one and the same, so its prev and next members are nil. |
361 | 71 |
1445
3b0906e2b82c
* window.h (struct window): Doc fix.
Jim Blandy <jimb@redhat.com>
parents:
998
diff
changeset
|
72 A dead window has its buffer, hchild, and vchild windows all nil. */ |
361 | 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; | |
769 | 80 /* The frame this window is on. */ |
81 Lisp_Object frame; | |
361 | 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, | |
769 | 95 as integers relative to upper left corner of frame = 0, 0 */ |
361 | 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; | |
1994
73ce9dd21093
Use the term `scroll bar', instead of `scrollbar'.
Jim Blandy <jimb@redhat.com>
parents:
1872
diff
changeset
|
126 /* 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
|
127 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
|
128 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
|
129 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
|
130 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
|
131 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
|
132 |
361 | 133 /* The rest are currently not used or only half used */ |
769 | 134 /* Frame coords of point at that time */ |
361 | 135 Lisp_Object last_point_x; |
136 Lisp_Object last_point_y; | |
769 | 137 /* Frame coords of mark as of last time display completed */ |
138 /* May be nil if mark does not exist or was not on frame */ | |
361 | 139 Lisp_Object last_mark_x; |
140 Lisp_Object last_mark_y; | |
141 /* Number of characters in buffer past bottom of window, | |
142 as of last redisplay that finished. */ | |
143 Lisp_Object window_end_pos; | |
144 /* t if window_end_pos is truly valid. | |
145 This is nil if nontrivial redisplay is preempted | |
769 | 146 since in that case the frame image that window_end_pos |
147 did not get onto the frame. */ | |
361 | 148 Lisp_Object window_end_valid; |
149 /* Vertical position (relative to window top) of that buffer position | |
150 of the first of those characters */ | |
151 Lisp_Object window_end_vpos; | |
152 /* Non-nil means must regenerate mode line of this window */ | |
153 Lisp_Object update_mode_line; | |
154 /* Non-nil means current value of `start' | |
155 was the beginning of a line when it was chosen. */ | |
156 Lisp_Object start_at_line_beg; | |
157 /* Display-table to use for displaying chars in this window. | |
158 Nil means use the buffer's own display-table. */ | |
159 Lisp_Object display_table; | |
160 /* Non-nil means window is marked as dedicated. */ | |
161 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
|
162 /* 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
|
163 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
|
164 /* 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
|
165 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
|
166 /* 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
|
167 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
|
168 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
|
169 Lisp_Object base_line_pos; |
2856
794899b97115
(struct window): New slot region_showing.
Richard M. Stallman <rms@gnu.org>
parents:
2304
diff
changeset
|
170 /* 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
|
171 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
|
172 Lisp_Object region_showing; |
361 | 173 }; |
174 | |
175 /* 1 if W is a minibuffer window. */ | |
176 | |
177 #define MINI_WINDOW_P(W) (!EQ ((W)->mini_p, Qnil)) | |
178 | |
179 /* This is the window in which the terminal's cursor should | |
180 be left when nothing is being done with it. This must | |
181 always be a leaf window, and its buffer is selected by | |
182 the top level editing loop at the end of each command. | |
183 | |
184 This value is always the same as | |
769 | 185 FRAME_SELECTED_WINDOW (selected_frame). */ |
361 | 186 |
187 extern Lisp_Object selected_window; | |
188 | |
189 /* This is a time stamp for window selection, so we can find the least | |
190 recently used window. Its only users are Fselect_window, | |
769 | 191 init_window_once, and make_frame. */ |
361 | 192 |
193 extern int window_select_count; | |
194 | |
769 | 195 /* The minibuffer window of the selected frame. |
361 | 196 Note that you cannot test for minibufferness of an arbitrary window |
998 | 197 by comparing against this; use the MINI_WINDOW_P macro instead. */ |
361 | 198 |
199 extern Lisp_Object minibuf_window; | |
200 | |
201 /* Non-nil => window to for C-M-v to scroll | |
202 when the minibuffer is selected. */ | |
203 extern Lisp_Object Vminibuf_scroll_window; | |
204 | |
205 /* nil or a symbol naming the window system | |
206 under which emacs is running | |
207 ('x is the only current possibility) */ | |
208 extern Lisp_Object Vwindow_system; | |
209 | |
210 /* Version number of X windows: 10, 11 or nil. */ | |
211 extern Lisp_Object Vwindow_system_version; | |
212 | |
213 /* Window that the mouse is over (nil if no mouse support). */ | |
214 extern Lisp_Object Vmouse_window; | |
215 | |
216 /* Last mouse-click event (nil if no mouse support). */ | |
217 extern Lisp_Object Vmouse_event; | |
218 | |
219 extern Lisp_Object Fnext_window (); | |
220 extern Lisp_Object Fselect_window (); | |
221 extern Lisp_Object Fdisplay_buffer (); | |
222 extern Lisp_Object Fset_window_buffer (); | |
1526
a45910fb5bbc
* window.h (make_window, window_from_coordinates,
Jim Blandy <jimb@redhat.com>
parents:
1445
diff
changeset
|
223 extern Lisp_Object make_window (); |
a45910fb5bbc
* window.h (make_window, window_from_coordinates,
Jim Blandy <jimb@redhat.com>
parents:
1445
diff
changeset
|
224 extern Lisp_Object window_from_coordinates (); |
a45910fb5bbc
* window.h (make_window, window_from_coordinates,
Jim Blandy <jimb@redhat.com>
parents:
1445
diff
changeset
|
225 extern Lisp_Object Fwindow_dedicated_p (); |
361 | 226 |
227 /* Prompt to display in front of the minibuffer contents. */ | |
228 extern char *minibuf_prompt; | |
229 | |
488 | 230 /* The visual width of the above. */ |
231 extern int minibuf_prompt_width; | |
232 | |
361 | 233 /* Message to display instead of minibuffer contents. |
234 This is what the functions error and message make, | |
235 and command echoing uses it as well. It overrides the | |
236 minibuf_prompt as well as the buffer. */ | |
237 extern char *echo_area_glyphs; | |
238 | |
1872
ad692b76edf4
* dispnew.c (remake_frame_glyphs): When re-allocating the frame's
Jim Blandy <jimb@redhat.com>
parents:
1784
diff
changeset
|
239 /* 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
|
240 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
|
241 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
|
242 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
|
243 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
|
244 |
361 | 245 /* Depth in recursive edits. */ |
246 extern int command_loop_level; | |
247 | |
248 /* Depth in minibuffer invocations. */ | |
249 extern int minibuf_level; | |
250 | |
251 /* true iff we should redraw the mode lines on the next redisplay. */ | |
252 extern int update_mode_lines; | |
253 | |
254 /* Minimum value of GPT since last redisplay that finished. */ | |
255 | |
256 extern int beg_unchanged; | |
257 | |
258 /* Minimum value of Z - GPT since last redisplay that finished. */ | |
259 | |
260 extern int end_unchanged; | |
261 | |
262 /* MODIFF as of last redisplay that finished; | |
263 if it matches MODIFF, beg_unchanged and end_unchangedn | |
264 contain no useful information. */ | |
265 extern int unchanged_modified; | |
266 | |
267 /* Nonzero if BEGV - BEG or Z - ZV of current buffer has changed | |
268 since last redisplay that finished. */ | |
269 extern int clip_changed; | |
270 | |
271 /* Nonzero if window sizes or contents have changed | |
272 since last redisplay that finished */ | |
273 extern int windows_or_buffers_changed; | |
274 | |
275 /* Number of windows displaying the selected buffer. | |
276 Normally this is 1, but it can be more. */ | |
277 extern int buffer_shared; | |
998 | 278 |
279 /* If *ROWS or *COLS are too small a size for FRAME, set them to the | |
280 minimum allowable size. */ | |
281 extern void check_frame_size ( /* FRAME_PTR frame, int *rows, int *cols */ ); |