|
428
|
1 /* Window definitions for XEmacs.
|
|
|
2 Copyright (C) 1985, 1986, 1992, 1993, 1994, 1995
|
|
|
3 Free Software Foundation, Inc.
|
|
|
4 Copyright (C) 1994, 1995 Board of Trustees, University of Illinois.
|
|
|
5 Copyright (C) 1995, 1996 Ben Wing.
|
|
|
6 Copyright (C) 1996 Chuck Thompson.
|
|
|
7
|
|
|
8 This file is part of XEmacs.
|
|
|
9
|
|
|
10 XEmacs is free software; you can redistribute it and/or modify it
|
|
|
11 under the terms of the GNU General Public License as published by the
|
|
|
12 Free Software Foundation; either version 2, or (at your option) any
|
|
|
13 later version.
|
|
|
14
|
|
|
15 XEmacs is distributed in the hope that it will be useful, but WITHOUT
|
|
|
16 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
|
17 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
|
18 for more details.
|
|
|
19
|
|
|
20 You should have received a copy of the GNU General Public License
|
|
|
21 along with XEmacs; see the file COPYING. If not, write to
|
|
|
22 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
|
23 Boston, MA 02111-1307, USA. */
|
|
|
24
|
|
|
25 /* Synched up with: FSF 19.30. */
|
|
|
26
|
|
440
|
27 #ifndef INCLUDED_window_h_
|
|
|
28 #define INCLUDED_window_h_
|
|
428
|
29
|
|
|
30 #include "redisplay.h"
|
|
|
31 #ifdef HAVE_SCROLLBARS
|
|
|
32 #include "scrollbar.h"
|
|
|
33 #endif
|
|
|
34
|
|
|
35 /* All windows in use are arranged into a tree, with pointers up and down.
|
|
|
36
|
|
|
37 Windows that are leaves of the tree are actually displayed
|
|
|
38 and show the contents of buffers. Windows that are not leaves
|
|
|
39 are used for representing the way groups of leaf windows are
|
|
|
40 arranged on the frame. Leaf windows never become non-leaves.
|
|
|
41 They are deleted only by calling delete-window on them (but
|
|
|
42 this can be done implicitly). Combination windows can be created
|
|
|
43 and deleted at any time.
|
|
|
44
|
|
|
45 A leaf window has a non-nil buffer field, and also
|
|
|
46 has markers in its start and pointm fields. Non-leaf windows
|
|
|
47 have nil in these fields.
|
|
|
48
|
|
|
49 Non-leaf windows are either vertical or horizontal combinations.
|
|
|
50
|
|
|
51 A vertical combination window has children that are arranged on the frame
|
|
|
52 one above the next. Its vchild field points to the uppermost child.
|
|
|
53 The parent field of each of the children points to the vertical
|
|
|
54 combination window. The next field of each child points to the
|
|
|
55 child below it, or is nil for the lowest child. The prev field
|
|
|
56 of each child points to the child above it, or is nil for the
|
|
|
57 highest child.
|
|
|
58
|
|
|
59 A horizontal combination window has children that are side by side.
|
|
|
60 Its hchild field points to the leftmost child. In each child
|
|
|
61 the next field points to the child to the right and the prev field
|
|
|
62 points to the child to the left.
|
|
|
63
|
|
|
64 The children of a vertical combination window may be leaf windows
|
|
|
65 or horizontal combination windows. The children of a horizontal
|
|
|
66 combination window may be leaf windows or vertical combination windows.
|
|
|
67
|
|
|
68 At the top of the tree are two windows which have nil as parent.
|
|
|
69 The second of these is minibuf_window. The first one manages all
|
|
|
70 the frame area that is not minibuffer, and is called the root window.
|
|
|
71 Different windows can be the root at different times;
|
|
|
72 initially the root window is a leaf window, but if more windows
|
|
|
73 are created then that leaf window ceases to be root and a newly
|
|
|
74 made combination window becomes root instead.
|
|
|
75
|
|
|
76 In any case, on screens which have an ordinary window and a
|
|
|
77 minibuffer, prev of the minibuf window is the root window and next of
|
|
|
78 the root window is the minibuf window. On minibufferless screens or
|
|
|
79 minibuffer-only screens, the root window and the minibuffer window are
|
|
|
80 one and the same, so its prev and next members are nil.
|
|
|
81
|
|
|
82 A dead window has the `dead' flag set on it. Note that unlike other
|
|
|
83 dead objects, dead windows can be made live again through restoring a
|
|
|
84 window configuration. This means that the values in a dead window
|
|
|
85 need to be preserved, except for those that are reconstructed by from
|
|
|
86 the window configuration. */
|
|
|
87
|
|
|
88 struct window
|
|
|
89 {
|
|
|
90 struct lcrecord_header header;
|
|
|
91
|
|
|
92 /* The upper left corner coordinates of this window,
|
|
|
93 as integers (pixels) relative to upper left corner of frame = 0, 0 */
|
|
|
94 int pixel_left;
|
|
|
95 int pixel_top;
|
|
|
96 /* The size of the window (in pixels) */
|
|
|
97 int pixel_height;
|
|
|
98 int pixel_width;
|
|
|
99
|
|
|
100 /* Number of columns display within the window is scrolled to the left. */
|
|
|
101 int hscroll;
|
|
|
102 /* Idem for the window's modeline */
|
|
438
|
103 Charcount modeline_hscroll;
|
|
428
|
104 /* Amount to clip off the top line for pixel-based scrolling. Point
|
|
|
105 will remain constant but this will be incremented to
|
|
|
106 incrementally shift lines up. */
|
|
|
107 int top_yoffset;
|
|
|
108 /* Amount to clip off the left of the lines for pixel-based
|
|
|
109 scrolling. Hscroll will remain constant but this will be
|
|
|
110 incremented to incrementally shift lines left.*/
|
|
|
111 int left_xoffset;
|
|
|
112
|
|
|
113 /* face cache elements correct for this window and its current buffer */
|
|
|
114 face_cachel_dynarr *face_cachels;
|
|
|
115 /* glyph cache elements correct for this window and its current buffer */
|
|
|
116 glyph_cachel_dynarr *glyph_cachels;
|
|
|
117 /* List of starting positions for display lines. Only valid if
|
|
|
118 buffer has not changed. */
|
|
|
119 line_start_cache_dynarr *line_start_cache;
|
|
|
120 int line_cache_validation_override;
|
|
|
121
|
|
|
122 /* Length of longest line currently displayed. Used to control the
|
|
|
123 width of the horizontal scrollbars. */
|
|
|
124 int max_line_len;
|
|
|
125
|
|
|
126 /* Frame coords of point at that time */
|
|
|
127 int last_point_x[3];
|
|
|
128 int last_point_y[3];
|
|
|
129
|
|
|
130 /* Number of characters in buffer past bottom of window,
|
|
|
131 as of last redisplay that finished. */
|
|
|
132 /* need one for each set of display structures */
|
|
|
133 int window_end_pos[3];
|
|
|
134
|
|
442
|
135 /* Set by the extent code when extents in the gutter are changed. */
|
|
|
136 int gutter_extent_modiff[4];
|
|
|
137
|
|
428
|
138 /* Set by redisplay to the last position seen. This is used
|
|
|
139 to implement the redisplay-end-trigger-functions. */
|
|
665
|
140 Charbpos last_redisplay_pos;
|
|
428
|
141
|
|
|
142 #define WINDOW_SLOT_DECLARATION
|
|
617
|
143 #define WINDOW_SLOT(slot) Lisp_Object slot;
|
|
428
|
144 #include "winslots.h"
|
|
|
145
|
|
|
146 /* one-bit flags: */
|
|
|
147
|
|
|
148 /* marker used when restoring a window configuration */
|
|
|
149 unsigned int config_mark :1;
|
|
|
150 /* Non-zero means window was dead. */
|
|
|
151 unsigned int dead :1;
|
|
|
152 /* Non-zero means next redisplay must use the value of start
|
|
|
153 set up for it in advance. Set by scrolling commands. */
|
|
|
154 unsigned int force_start :1;
|
|
|
155 /* Non-zero means must regenerate modeline of this window */
|
|
|
156 unsigned int redo_modeline :1;
|
|
|
157 /* Non-zero means current value of `start'
|
|
|
158 was the beginning of a line when it was chosen. */
|
|
|
159 unsigned int start_at_line_beg :1;
|
|
|
160 /* new redisplay flag */
|
|
|
161 unsigned int windows_changed :1;
|
|
|
162 unsigned int shadow_thickness_changed :1;
|
|
|
163 /* Vertical divider flag and validity of it */
|
|
|
164 unsigned int need_vertical_divider_p :1;
|
|
|
165 unsigned int need_vertical_divider_valid_p :1;
|
|
|
166 };
|
|
|
167
|
|
617
|
168 DECLARE_LRECORD (window, struct window);
|
|
|
169 #define XWINDOW(x) XRECORD (x, window, struct window)
|
|
|
170 #define wrap_window(p) wrap_record (p, window)
|
|
|
171 #define WINDOWP(x) RECORDP (x, window)
|
|
|
172 #define CHECK_WINDOW(x) CHECK_RECORD (x, window)
|
|
|
173 #define CONCHECK_WINDOW(x) CONCHECK_RECORD (x, window)
|
|
|
174
|
|
428
|
175 #define CURRENT_DISP 0
|
|
|
176 #define DESIRED_DISP 1
|
|
|
177 #define CMOTION_DISP 2
|
|
|
178
|
|
|
179 struct window_mirror
|
|
|
180 {
|
|
617
|
181 struct lcrecord_header header;
|
|
|
182
|
|
428
|
183 /* Frame this mirror is on. */
|
|
|
184 struct frame *frame;
|
|
|
185
|
|
|
186 /* Following child (to right or down) at same level of tree */
|
|
|
187 struct window_mirror *next;
|
|
|
188
|
|
|
189 /* There is no prev field because we never traverse this structure
|
|
|
190 backwards. Same goes for the parent field. */
|
|
|
191
|
|
|
192 /* First child of this window. */
|
|
|
193 /* vchild is used if this is a vertical combination,
|
|
|
194 hchild if this is a horizontal combination. */
|
|
|
195 struct window_mirror *hchild, *vchild;
|
|
|
196
|
|
|
197 /* Dynamic array of display lines */
|
|
|
198 display_line_dynarr *current_display_lines;
|
|
|
199 display_line_dynarr *desired_display_lines;
|
|
|
200
|
|
|
201 /* Buffer current_display_lines represent. */
|
|
|
202 struct buffer *buffer;
|
|
|
203
|
|
|
204 #ifdef HAVE_SCROLLBARS
|
|
|
205 /* Scrollbars associated with window, if any. */
|
|
|
206 struct scrollbar_instance *scrollbar_vertical_instance;
|
|
|
207 struct scrollbar_instance *scrollbar_horizontal_instance;
|
|
|
208 #endif /* HAVE_SCROLLBARS */
|
|
|
209
|
|
|
210 /* Flag indicating whether a subwindow is currently being displayed. */
|
|
|
211 unsigned int subwindows_being_displayed :1;
|
|
|
212
|
|
|
213 /* Keep track of the truncation status in this window so we can
|
|
|
214 detect when it has changed. #### Magic variables would be a huge
|
|
|
215 win here. */
|
|
|
216 unsigned int truncate_win :1;
|
|
|
217 };
|
|
|
218
|
|
617
|
219 DECLARE_LRECORD (window_mirror, struct window_mirror);
|
|
|
220 #define XWINDOW_MIRROR(x) XRECORD (x, window_mirror, struct window_mirror)
|
|
|
221 #define wrap_window_mirror(p) wrap_record (p, window_mirror)
|
|
|
222 #define WINDOW_MIRRORP(x) RECORDP (x, window_mirror)
|
|
|
223 #define CHECK_WINDOW_MIRROR(x) CHECK_RECORD (x, window_mirror)
|
|
|
224 #define CONCHECK_WINDOW_MIRROR(x) CONCHECK_RECORD (x, window_mirror)
|
|
428
|
225
|
|
|
226 #define WINDOW_LIVE_P(x) (!(x)->dead)
|
|
|
227 #define CHECK_LIVE_WINDOW(x) do { \
|
|
|
228 CHECK_WINDOW (x); \
|
|
|
229 if (!WINDOW_LIVE_P (XWINDOW (x))) \
|
|
|
230 dead_wrong_type_argument (Qwindow_live_p, (x)); \
|
|
|
231 } while (0)
|
|
|
232 #define CONCHECK_LIVE_WINDOW(x) do { \
|
|
|
233 CONCHECK_WINDOW (x); \
|
|
|
234 if (!WINDOW_LIVE_P (XWINDOW (x))) \
|
|
|
235 x = wrong_type_argument (Qwindow_live_p, (x)); \
|
|
|
236 } while (0)
|
|
|
237
|
|
|
238 /* 1 if W is a minibuffer window. */
|
|
|
239 #define MINI_WINDOW_P(W) (!NILP ((W)->mini_p))
|
|
|
240
|
|
|
241 /* 1 if we are dealing with a parentless window (this includes the
|
|
|
242 root window on a frame and the minibuffer window; both of these
|
|
|
243 are siblings). */
|
|
|
244 #define TOP_LEVEL_WINDOW_P(w) NILP ((w)->parent)
|
|
|
245
|
|
|
246 /* Set all redisplay flags indicating a window has changed */
|
|
|
247 #define MARK_WINDOWS_CHANGED(w) do { \
|
|
|
248 (w)->windows_changed = 1; \
|
|
|
249 if (!NILP (w->frame)) \
|
|
|
250 { \
|
|
|
251 struct frame *mwc_frame = XFRAME (w->frame); \
|
|
|
252 MARK_FRAME_WINDOWS_CHANGED (mwc_frame); \
|
|
|
253 } \
|
|
|
254 else \
|
|
|
255 windows_changed = 1; \
|
|
|
256 } while (0)
|
|
|
257
|
|
448
|
258 /* #### This should be fixed not to call MARK_FRAME_CHANGED because
|
|
|
259 faces are cached per window. Also, other code which changes window's
|
|
|
260 face should use this macro.
|
|
|
261 */
|
|
|
262 #define MARK_WINDOW_FACES_CHANGED(w) \
|
|
|
263 MARK_FRAME_FACES_CHANGED (XFRAME ((w)->frame))
|
|
|
264
|
|
428
|
265 #define WINDOW_TTY_P(w) FRAME_TTY_P (XFRAME ((w)->frame))
|
|
|
266 #define WINDOW_X_P(w) FRAME_X_P (XFRAME ((w)->frame))
|
|
|
267 #define WINDOW_NS_P(w) FRAME_NS_P (XFRAME ((w)->frame))
|
|
|
268 #define WINDOW_WIN_P(w) FRAME_WIN_P (XFRAME ((w)->frame))
|
|
|
269
|
|
|
270 DECLARE_LRECORD (window_configuration, struct window_config);
|
|
|
271
|
|
|
272 EXFUN (Fget_buffer_window, 3);
|
|
|
273 EXFUN (Fmove_to_window_line, 2);
|
|
|
274 EXFUN (Frecenter, 2);
|
|
444
|
275 EXFUN (Freplace_buffer_in_windows, 3);
|
|
428
|
276 EXFUN (Fselect_window, 2);
|
|
|
277 EXFUN (Fselected_window, 1);
|
|
440
|
278 EXFUN (Fset_window_buffer, 3);
|
|
428
|
279 EXFUN (Fset_window_hscroll, 2);
|
|
|
280 EXFUN (Fset_window_point, 2);
|
|
|
281 EXFUN (Fset_window_start, 3);
|
|
|
282 EXFUN (Fwindow_buffer, 1);
|
|
|
283 EXFUN (Fwindow_highest_p, 1);
|
|
|
284 EXFUN (Fwindow_point, 1);
|
|
|
285 EXFUN (Fwindow_start, 1);
|
|
|
286
|
|
|
287 /* The minibuffer window of the selected frame.
|
|
|
288 Note that you cannot test for minibufferness of an arbitrary window
|
|
|
289 by comparing against this; but you can test for minibufferness of
|
|
|
290 the selected window or of any window that is displayed. */
|
|
|
291 extern Lisp_Object minibuf_window;
|
|
|
292
|
|
|
293 /* Prompt to display in front of the minibuffer contents, or nil */
|
|
|
294 extern Lisp_Object Vminibuf_prompt;
|
|
|
295 /* Prompt to display in front of the minibuffer prompt, or nil */
|
|
|
296 extern Lisp_Object Vminibuf_preprompt;
|
|
|
297
|
|
|
298 Lisp_Object allocate_window (void);
|
|
|
299 int window_char_width (struct window *, int include_margins_p);
|
|
|
300 int window_char_height (struct window *, int include_gutters_p);
|
|
|
301 int window_displayed_height (struct window *);
|
|
|
302 int window_is_leftmost (struct window *w);
|
|
|
303 int window_is_rightmost (struct window *w);
|
|
|
304 int window_is_lowest (struct window *w);
|
|
|
305 int window_is_highest (struct window *w);
|
|
|
306 int window_truncation_on (struct window *w);
|
|
|
307 int window_needs_vertical_divider (struct window *);
|
|
|
308 int window_scrollbar_width (struct window *w);
|
|
|
309 int window_scrollbar_height (struct window *w);
|
|
|
310 int window_modeline_height (struct window *w);
|
|
|
311 int window_left_margin_width (struct window *w);
|
|
|
312 int window_right_margin_width (struct window *w);
|
|
|
313 int window_top_gutter_height (struct window *w);
|
|
|
314 int window_bottom_gutter_height (struct window *w);
|
|
|
315 int window_left_gutter_width (struct window *w, int modeline);
|
|
|
316 int window_right_gutter_width (struct window *w, int modeline);
|
|
|
317
|
|
|
318 void delete_all_subwindows (struct window *w);
|
|
|
319 void set_window_pixheight (Lisp_Object window, int pixheight,
|
|
|
320 int nodelete);
|
|
|
321 void set_window_pixwidth (Lisp_Object window, int pixwidth,
|
|
|
322 int nodelete);
|
|
|
323 void window_scroll (Lisp_Object window, Lisp_Object n, int direction,
|
|
578
|
324 Error_Behavior errb);
|
|
428
|
325 int buffer_window_count (struct buffer *b, struct frame *f);
|
|
|
326 int buffer_window_mru (struct window *w);
|
|
|
327 void check_frame_size (struct frame *frame, int *rows, int *cols);
|
|
440
|
328 int frame_pixsize_valid_p (struct frame *frame, int width, int height);
|
|
|
329 int frame_size_valid_p (struct frame *frame, int rows, int cols);
|
|
428
|
330 struct window *decode_window (Lisp_Object window);
|
|
|
331 struct window *find_window_by_pixel_pos (int pix_x, int pix_y, Lisp_Object win);
|
|
|
332
|
|
|
333 void free_window_mirror (struct window_mirror *mir);
|
|
|
334 Lisp_Object real_window (struct window_mirror *mir, int no_abort);
|
|
|
335 struct window_mirror *find_window_mirror (struct window *w);
|
|
|
336 display_line_dynarr *window_display_lines (struct window *w, int);
|
|
|
337 struct buffer *window_display_buffer (struct window *w);
|
|
|
338 void set_window_display_buffer (struct window *w, struct buffer *b);
|
|
|
339 void update_frame_window_mirror (struct frame *f);
|
|
|
340
|
|
|
341 int map_windows (struct frame *f,
|
|
|
342 int (*mapfun) (struct window *w, void *closure),
|
|
|
343 void *closure);
|
|
|
344 void some_window_value_changed (Lisp_Object specifier, struct window *w,
|
|
|
345 Lisp_Object oldval);
|
|
|
346 int invalidate_vertical_divider_cache_in_window (struct window *w,
|
|
|
347 void *u_n_u_s_e_d);
|
|
|
348 int window_divider_width (struct window *w);
|
|
|
349
|
|
|
350 #define WINDOW_FRAME(w) ((w)->frame)
|
|
442
|
351 #define WINDOW_XFRAME(w) XFRAME (WINDOW_FRAME (w))
|
|
428
|
352 #define WINDOW_BUFFER(w) ((w)->buffer)
|
|
442
|
353 #define WINDOW_XBUFFER(w) XBUFFER (WINDOW_BUFFER (w))
|
|
428
|
354 #define WINDOW_DEVICE(w) FRAME_DEVICE (XFRAME (WINDOW_FRAME (w)))
|
|
442
|
355 #define WINDOW_XDEVICE(w) XDEVICE (WINDOW_DEVICE (w))
|
|
428
|
356 #define WINDOW_CONSOLE(w) DEVICE_CONSOLE (XDEVICE (WINDOW_DEVICE (w)))
|
|
442
|
357 #define WINDOW_XCONSOLE(w) XCONSOLE (WINDOW_CONSOLE (w))
|
|
428
|
358
|
|
|
359 /* XEmacs window size and positioning macros. */
|
|
|
360 #define WINDOW_TOP(w) ((w)->pixel_top)
|
|
|
361 #define WINDOW_TEXT_TOP(w) (WINDOW_TOP (w) + window_top_gutter_height (w))
|
|
|
362 #define WINDOW_TEXT_TOP_CLIP(w) ((w)->top_yoffset)
|
|
|
363 #define WINDOW_BOTTOM(w) ((w)->pixel_top + (w)->pixel_height)
|
|
|
364 #define WINDOW_TEXT_BOTTOM(w) (WINDOW_BOTTOM (w) - window_bottom_gutter_height (w))
|
|
|
365 #define WINDOW_LEFT(w) ((w)->pixel_left)
|
|
|
366 #define WINDOW_TEXT_LEFT(w) (WINDOW_LEFT (w) + window_left_gutter_width (w, 0))
|
|
|
367 #define WINDOW_MODELINE_LEFT(w) \
|
|
|
368 (WINDOW_LEFT (w) + window_left_gutter_width (w, 1))
|
|
|
369 #define WINDOW_RIGHT(w) ((w)->pixel_left + (w)->pixel_width)
|
|
|
370 #define WINDOW_TEXT_RIGHT(w) \
|
|
|
371 (WINDOW_RIGHT (w) - window_right_gutter_width (w, 0))
|
|
|
372 #define WINDOW_MODELINE_RIGHT(w) \
|
|
|
373 (WINDOW_RIGHT (w) - window_right_gutter_width (w, 1))
|
|
|
374
|
|
|
375 #define WINDOW_HEIGHT(w) ((w)->pixel_height)
|
|
|
376 #define WINDOW_TEXT_HEIGHT(w) (WINDOW_TEXT_BOTTOM (w) - WINDOW_TEXT_TOP (w))
|
|
|
377 #define WINDOW_WIDTH(w) ((w)->pixel_width)
|
|
|
378 #define WINDOW_TEXT_WIDTH(w) (WINDOW_TEXT_RIGHT (w) - WINDOW_TEXT_LEFT (w))
|
|
|
379
|
|
|
380 #define WINDOW_HAS_MODELINE_P(w) (!NILP (w->has_modeline_p))
|
|
|
381
|
|
|
382 #define MODELINE_OFF_SHADOW_THICKNESS_ADJUSTED(win) \
|
|
|
383 abs ((!WINDOW_HAS_MODELINE_P (win) \
|
|
|
384 ? ((XINT (win->modeline_shadow_thickness) > 1) \
|
|
|
385 ? XINT (win->modeline_shadow_thickness) - 1 \
|
|
|
386 : ((XINT (win->modeline_shadow_thickness) < -1) \
|
|
|
387 ? XINT (win->modeline_shadow_thickness) + 1 \
|
|
|
388 : XINT (win->modeline_shadow_thickness))) \
|
|
|
389 : XINT (win->modeline_shadow_thickness)))
|
|
|
390
|
|
|
391 #define MODELINE_SHADOW_THICKNESS(win) \
|
|
|
392 (MODELINE_OFF_SHADOW_THICKNESS_ADJUSTED (win) > 10 \
|
|
|
393 ? 10 \
|
|
|
394 : MODELINE_OFF_SHADOW_THICKNESS_ADJUSTED (win))
|
|
|
395
|
|
440
|
396 #endif /* INCLUDED_window_h_ */
|
