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.
8 This file is part of XEmacs.
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
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
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. */
25 /* Synched up with: FSF 19.30. */
27 #ifndef _XEMACS_WINDOW_H_
28 #define _XEMACS_WINDOW_H_
30 #include "redisplay.h"
31 #ifdef HAVE_SCROLLBARS
32 #include "scrollbar.h"
35 /* All windows in use are arranged into a tree, with pointers up and down.
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.
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.
49 Non-leaf windows are either vertical or horizontal combinations.
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
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.
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.
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.
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.
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. */
90 struct lcrecord_header header;
92 /* The frame this window is on. */
94 /* t if this window is a minibuffer window. */
96 /* Following child (to right or down) at same level of tree */
98 /* Preceding child (to left or up) at same level of tree */
100 /* First child of this window. */
101 /* vchild is used if this is a vertical combination,
102 hchild if this is a horizontal combination. */
103 Lisp_Object hchild, vchild;
104 /* The window this one is a child of. */
107 /* The upper left corner coordinates of this window,
108 as integers (pixels) relative to upper left corner of frame = 0, 0 */
111 /* The size of the window (in pixels) */
115 /* The buffer displayed in this window */
116 /* Of the fields vchild, hchild and buffer, only one is non-nil. */
118 /* A marker pointing to where in the text to start displaying */
119 /* need one for each set of display structures */
120 Lisp_Object start[3];
121 /* A marker pointing to where in the text point is in this window,
122 used only when the window is not selected.
123 This exists so that when multiple windows show one buffer
124 each one can have its own value of point. */
125 /* need one for each set of display structures */
126 Lisp_Object pointm[3];
127 /* A marker pointing to where in the text the scrollbar is pointing */
128 Lisp_Object sb_point;
129 /* Number of columns display within the window is scrolled to the left. */
131 /* Idem for the window's modeline */
132 int modeline_hscroll;
133 /* Number saying how recently window was selected */
134 Lisp_Object use_time;
135 /* text.modified of displayed buffer as of last time display completed */
136 Lisp_Object last_modified[3];
137 /* Value of point at that time */
138 Lisp_Object last_point[3];
139 /* Value of start at that time */
140 Lisp_Object last_start[3];
141 /* buf.face_change as of last time display completed */
142 Lisp_Object last_facechange[3];
144 /* face cache elements correct for this window and its current buffer */
145 face_cachel_dynarr *face_cachels;
146 /* glyph cache elements correct for this window and its current buffer */
147 glyph_cachel_dynarr *glyph_cachels;
150 /* List of starting positions for display lines. Only valid if
151 buffer has not changed. */
152 line_start_cache_dynarr *line_start_cache;
153 Lisp_Object line_cache_last_updated;
154 int line_cache_validation_override;
156 /* Length of longest line currently displayed. Used to control the
157 width of the horizontal scrollbars. */
160 /* Frame coords of point at that time */
164 /* Number of characters in buffer past bottom of window,
165 as of last redisplay that finished. */
166 /* need one for each set of display structures */
167 int window_end_pos[3];
169 /* If redisplay in this window goes beyond this buffer position,
170 must run the redisplay-end-trigger-functions. */
171 Lisp_Object redisplay_end_trigger;
173 /* Set by redisplay to the last position seen. This is used
174 to implement the redisplay-end-trigger-functions. */
175 Bufpos last_redisplay_pos;
177 #define WINDOW_SLOT_DECLARATION
178 #define WINDOW_SLOT(slot, compare) Lisp_Object slot
179 #include "winslots.h"
183 /* marker used when restoring a window configuration */
184 unsigned int config_mark :1;
185 /* Non-zero means window was dead. */
186 unsigned int dead :1;
187 /* Non-zero means next redisplay must use the value of start
188 set up for it in advance. Set by scrolling commands. */
189 unsigned int force_start :1;
190 /* Non-zero means must regenerate modeline of this window */
191 unsigned int redo_modeline :1;
192 /* Non-zero means current value of `start'
193 was the beginning of a line when it was chosen. */
194 unsigned int start_at_line_beg :1;
195 /* new redisplay flag */
196 unsigned int windows_changed :1;
197 unsigned int shadow_thickness_changed :1;
198 /* Vertical divider flag and validity of it */
199 unsigned int need_vertical_divider_p :1;
200 unsigned int need_vertical_divider_valid_p :1;
203 #define CURRENT_DISP 0
204 #define DESIRED_DISP 1
205 #define CMOTION_DISP 2
209 /* Frame this mirror is on. */
212 /* Following child (to right or down) at same level of tree */
213 struct window_mirror *next;
215 /* There is no prev field because we never traverse this structure
216 backwards. Same goes for the parent field. */
218 /* First child of this window. */
219 /* vchild is used if this is a vertical combination,
220 hchild if this is a horizontal combination. */
221 struct window_mirror *hchild, *vchild;
223 /* Dynamic array of display lines */
224 display_line_dynarr *current_display_lines;
225 display_line_dynarr *desired_display_lines;
227 /* Buffer current_display_lines represent. */
228 struct buffer *buffer;
230 #ifdef HAVE_SCROLLBARS
231 /* Scrollbars associated with window, if any. */
232 struct scrollbar_instance *scrollbar_vertical_instance;
233 struct scrollbar_instance *scrollbar_horizontal_instance;
234 #endif /* HAVE_SCROLLBARS */
236 /* Flag indicating whether a subwindow is currently being displayed. */
237 unsigned int subwindows_being_displayed :1;
239 /* Keep track of the truncation status in this window so we can
240 detect when it has changed. #### Magic variables would be a huge
242 unsigned int truncate_win :1;
245 #ifdef emacs /* some things other than emacs want the structs */
247 DECLARE_LRECORD (window, struct window);
248 #define XWINDOW(x) XRECORD (x, window, struct window)
249 #define XSETWINDOW(x, p) XSETRECORD (x, p, window)
250 #define WINDOWP(x) RECORDP (x, window)
251 #define GC_WINDOWP(x) GC_RECORDP (x, window)
252 #define CHECK_WINDOW(x) CHECK_RECORD (x, window)
253 #define CONCHECK_WINDOW(x) CONCHECK_RECORD (x, window)
255 #define WINDOW_LIVE_P(x) (!(x)->dead)
256 #define CHECK_LIVE_WINDOW(x) do { \
258 if (!WINDOW_LIVE_P (XWINDOW (x))) \
259 dead_wrong_type_argument (Qwindow_live_p, (x)); \
261 #define CONCHECK_LIVE_WINDOW(x) do { \
262 CONCHECK_WINDOW (x); \
263 if (!WINDOW_LIVE_P (XWINDOW (x))) \
264 x = wrong_type_argument (Qwindow_live_p, (x)); \
267 /* 1 if W is a minibuffer window. */
268 #define MINI_WINDOW_P(W) (!NILP ((W)->mini_p))
270 /* 1 if we are dealing with a parentless window (this includes the
271 root window on a frame and the minibuffer window; both of these
273 #define TOP_LEVEL_WINDOW_P(w) NILP ((w)->parent)
275 /* Set all redisplay flags indicating a window has changed */
276 #define MARK_WINDOWS_CHANGED(w) do { \
277 (w)->windows_changed = 1; \
278 if (!NILP (w->frame)) \
280 struct frame *mwc_frame = XFRAME (w->frame); \
281 MARK_FRAME_WINDOWS_CHANGED (mwc_frame); \
284 windows_changed = 1; \
287 #define WINDOW_TTY_P(w) FRAME_TTY_P (XFRAME ((w)->frame))
288 #define WINDOW_X_P(w) FRAME_X_P (XFRAME ((w)->frame))
289 #define WINDOW_NS_P(w) FRAME_NS_P (XFRAME ((w)->frame))
290 #define WINDOW_WIN_P(w) FRAME_WIN_P (XFRAME ((w)->frame))
292 DECLARE_LRECORD (window_configuration, struct window_config);
294 EXFUN (Fget_buffer_window, 3);
295 EXFUN (Fmove_to_window_line, 2);
296 EXFUN (Frecenter, 2);
297 EXFUN (Freplace_buffer_in_windows, 1);
298 EXFUN (Fselect_window, 2);
299 EXFUN (Fselected_window, 1);
300 EXFUN (Fset_window_buffer, 2);
301 EXFUN (Fset_window_hscroll, 2);
302 EXFUN (Fset_window_point, 2);
303 EXFUN (Fset_window_start, 3);
304 EXFUN (Fwindow_buffer, 1);
305 EXFUN (Fwindow_highest_p, 1);
306 EXFUN (Fwindow_point, 1);
307 EXFUN (Fwindow_start, 1);
309 /* The minibuffer window of the selected frame.
310 Note that you cannot test for minibufferness of an arbitrary window
311 by comparing against this; but you can test for minibufferness of
312 the selected window or of any window that is displayed. */
313 extern Lisp_Object minibuf_window;
315 /* Prompt to display in front of the minibuffer contents, or nil */
316 extern Lisp_Object Vminibuf_prompt;
317 /* Prompt to display in front of the minibuffer prompt, or nil */
318 extern Lisp_Object Vminibuf_preprompt;
320 Lisp_Object allocate_window (void);
321 int window_char_width (struct window *, int include_margins_p);
322 int window_char_height (struct window *, int include_gutters_p);
323 int window_displayed_height (struct window *);
324 int window_is_leftmost (struct window *w);
325 int window_is_rightmost (struct window *w);
326 int window_truncation_on (struct window *w);
327 int window_needs_vertical_divider (struct window *);
328 int window_scrollbar_width (struct window *w);
329 int window_scrollbar_height (struct window *w);
330 int window_modeline_height (struct window *w);
331 int window_left_margin_width (struct window *w);
332 int window_right_margin_width (struct window *w);
333 int window_top_gutter_height (struct window *w);
334 int window_bottom_gutter_height (struct window *w);
335 int window_left_gutter_width (struct window *w, int modeline);
336 int window_right_gutter_width (struct window *w, int modeline);
337 int window_bottom_toolbar_height (struct window *w);
339 void delete_all_subwindows (struct window *w);
340 void set_window_pixheight (Lisp_Object window, int pixheight,
342 void set_window_pixwidth (Lisp_Object window, int pixwidth,
344 void window_scroll (Lisp_Object window, Lisp_Object n, int direction,
345 Error_behavior errb);
346 int buffer_window_count (struct buffer *b, struct frame *f);
347 int buffer_window_mru (struct window *w);
348 void check_frame_size (struct frame *frame, int *rows, int *cols);
349 struct window *decode_window (Lisp_Object window);
350 struct window *find_window_by_pixel_pos (int pix_x, int pix_y, Lisp_Object win);
352 /* new functions to handle the window mirror */
353 void free_window_mirror (struct window_mirror *mir);
354 Lisp_Object real_window (struct window_mirror *mir, int no_abort);
355 struct window_mirror *find_window_mirror (struct window *w);
356 display_line_dynarr *window_display_lines (struct window *w, int);
357 struct buffer *window_display_buffer (struct window *w);
358 void set_window_display_buffer (struct window *w, struct buffer *b);
359 void update_frame_window_mirror (struct frame *f);
361 int map_windows (struct frame *f,
362 int (*mapfun) (struct window *w, void *closure),
364 void some_window_value_changed (Lisp_Object specifier, struct window *w,
366 int invalidate_vertical_divider_cache_in_window (struct window *w,
368 int window_divider_width (struct window *w);
370 #define WINDOW_FRAME(w) ((w)->frame)
371 #define WINDOW_BUFFER(w) ((w)->buffer)
372 #define WINDOW_DEVICE(w) FRAME_DEVICE (XFRAME (WINDOW_FRAME (w)))
373 #define WINDOW_CONSOLE(w) DEVICE_CONSOLE (XDEVICE (WINDOW_DEVICE (w)))
375 /* XEmacs window size and positioning macros. */
376 #define WINDOW_TOP(w) ((w)->pixel_top)
377 #define WINDOW_TEXT_TOP(w) (WINDOW_TOP (w) + window_top_gutter_height (w))
378 #define WINDOW_BOTTOM(w) ((w)->pixel_top + (w)->pixel_height)
379 #define WINDOW_TEXT_BOTTOM(w) (WINDOW_BOTTOM (w) - window_bottom_gutter_height (w))
380 #define WINDOW_LEFT(w) ((w)->pixel_left)
381 #define WINDOW_TEXT_LEFT(w) (WINDOW_LEFT (w) + window_left_gutter_width (w, 0))
382 #define WINDOW_MODELINE_LEFT(w) \
383 (WINDOW_LEFT (w) + window_left_gutter_width (w, 1))
384 #define WINDOW_RIGHT(w) ((w)->pixel_left + (w)->pixel_width)
385 #define WINDOW_TEXT_RIGHT(w) \
386 (WINDOW_RIGHT (w) - window_right_gutter_width (w, 0))
387 #define WINDOW_MODELINE_RIGHT(w) \
388 (WINDOW_RIGHT (w) - window_right_gutter_width (w, 1))
390 #define WINDOW_HEIGHT(w) ((w)->pixel_height)
391 #define WINDOW_TEXT_HEIGHT(w) (WINDOW_TEXT_BOTTOM (w) - WINDOW_TEXT_TOP (w))
392 #define WINDOW_WIDTH(w) ((w)->pixel_width)
393 #define WINDOW_TEXT_WIDTH(w) (WINDOW_TEXT_RIGHT (w) - WINDOW_TEXT_LEFT (w))
395 #define WINDOW_HAS_MODELINE_P(w) (!NILP (w->has_modeline_p))
397 #define MODELINE_OFF_SHADOW_THICKNESS_ADJUSTED(win) \
398 abs ((!WINDOW_HAS_MODELINE_P (win) \
399 ? ((XINT (win->modeline_shadow_thickness) > 1) \
400 ? XINT (win->modeline_shadow_thickness) - 1 \
401 : ((XINT (win->modeline_shadow_thickness) < -1) \
402 ? XINT (win->modeline_shadow_thickness) + 1 \
403 : XINT (win->modeline_shadow_thickness))) \
404 : XINT (win->modeline_shadow_thickness)))
406 #define MODELINE_SHADOW_THICKNESS(win) \
407 (MODELINE_OFF_SHADOW_THICKNESS_ADJUSTED (win) > 10 \
409 : MODELINE_OFF_SHADOW_THICKNESS_ADJUSTED (win))
413 #endif /* _XEMACS_WINDOW_H_ */