Mercurial > hg > xemacs-beta

comparison src/window.h @ 428:3ecd8885ac67 r21-2-22

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import from CVS: tag r21-2-22
author cvs
date Mon, 13 Aug 2007 11:28:15 +0200
parents
children 84b14dcb0985
comparison
equal deleted inserted replaced
427:0a0253eac470 428:3ecd8885ac67
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
27 #ifndef _XEMACS_WINDOW_H_
28 #define _XEMACS_WINDOW_H_
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 frame this window is on. */
93 Lisp_Object frame;
94 /* t if this window is a minibuffer window. */
95 Lisp_Object mini_p;
96 /* Following child (to right or down) at same level of tree */
97 Lisp_Object next;
98 /* Preceding child (to left or up) at same level of tree */
99 Lisp_Object prev;
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. */
105 Lisp_Object parent;
106
107 /* The upper left corner coordinates of this window,
108 as integers (pixels) relative to upper left corner of frame = 0, 0 */
109 int pixel_left;
110 int pixel_top;
111 /* The size of the window (in pixels) */
112 int pixel_height;
113 int pixel_width;
114
115 /* The buffer displayed in this window */
116 /* Of the fields vchild, hchild and buffer, only one is non-nil. */
117 Lisp_Object buffer;
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. */
130 int hscroll;
131 /* Idem for the window's modeline */
132 int modeline_hscroll;
133 /* Amount to clip off the top line for pixel-based scrolling. Point
134 will remain constant but this will be incremented to
135 incrementally shift lines up. */
136 int top_yoffset;
137 /* Amount to clip off the left of the lines for pixel-based
138 scrolling. Hscroll will remain constant but this will be
139 incremented to incrementally shift lines left.*/
140 int left_xoffset;
141 /* Number saying how recently window was selected */
142 Lisp_Object use_time;
143 /* text.modified of displayed buffer as of last time display completed */
144 Lisp_Object last_modified[3];
145 /* Value of point at that time */
146 Lisp_Object last_point[3];
147 /* Value of start at that time */
148 Lisp_Object last_start[3];
149 /* buf.face_change as of last time display completed */
150 Lisp_Object last_facechange[3];
151
152 /* face cache elements correct for this window and its current buffer */
153 face_cachel_dynarr *face_cachels;
154 /* glyph cache elements correct for this window and its current buffer */
155 glyph_cachel_dynarr *glyph_cachels;
156 /* we cannot have a per-device cache of widgets / subwindows because
157 each visible instance needs to be a separate instance. The lowest
158 level of granularity we can get easily is the window that the
159 subwindow is in. This will fail if we attach the same subwindow
160 twice to a buffer. However, we are quite unlikely to do this,
161 especially with buttons which will need individual callbacks. The
162 proper solution is probably not worth the effort. */
163 Lisp_Object subwindow_instance_cache;
164 /* List of starting positions for display lines. Only valid if
165 buffer has not changed. */
166 line_start_cache_dynarr *line_start_cache;
167 Lisp_Object line_cache_last_updated;
168 int line_cache_validation_override;
169
170 /* Length of longest line currently displayed. Used to control the
171 width of the horizontal scrollbars. */
172 int max_line_len;
173
174 /* Frame coords of point at that time */
175 int last_point_x[3];
176 int last_point_y[3];
177
178 /* Number of characters in buffer past bottom of window,
179 as of last redisplay that finished. */
180 /* need one for each set of display structures */
181 int window_end_pos[3];
182
183 /* If redisplay in this window goes beyond this buffer position,
184 must run the redisplay-end-trigger-functions. */
185 Lisp_Object redisplay_end_trigger;
186
187 /* Set by redisplay to the last position seen. This is used
188 to implement the redisplay-end-trigger-functions. */
189 Bufpos last_redisplay_pos;
190
191 #define WINDOW_SLOT_DECLARATION
192 #define WINDOW_SLOT(slot, compare) Lisp_Object slot
193 #include "winslots.h"
194
195 /* one-bit flags: */
196
197 /* marker used when restoring a window configuration */
198 unsigned int config_mark :1;
199 /* Non-zero means window was dead. */
200 unsigned int dead :1;
201 /* Non-zero means next redisplay must use the value of start
202 set up for it in advance. Set by scrolling commands. */
203 unsigned int force_start :1;
204 /* Non-zero means must regenerate modeline of this window */
205 unsigned int redo_modeline :1;
206 /* Non-zero means current value of `start'
207 was the beginning of a line when it was chosen. */
208 unsigned int start_at_line_beg :1;
209 /* new redisplay flag */
210 unsigned int windows_changed :1;
211 unsigned int shadow_thickness_changed :1;
212 /* Vertical divider flag and validity of it */
213 unsigned int need_vertical_divider_p :1;
214 unsigned int need_vertical_divider_valid_p :1;
215 };
216
217 #define CURRENT_DISP 0
218 #define DESIRED_DISP 1
219 #define CMOTION_DISP 2
220
221 struct window_mirror
222 {
223 /* Frame this mirror is on. */
224 struct frame *frame;
225
226 /* Following child (to right or down) at same level of tree */
227 struct window_mirror *next;
228
229 /* There is no prev field because we never traverse this structure
230 backwards. Same goes for the parent field. */
231
232 /* First child of this window. */
233 /* vchild is used if this is a vertical combination,
234 hchild if this is a horizontal combination. */
235 struct window_mirror *hchild, *vchild;
236
237 /* Dynamic array of display lines */
238 display_line_dynarr *current_display_lines;
239 display_line_dynarr *desired_display_lines;
240
241 /* Buffer current_display_lines represent. */
242 struct buffer *buffer;
243
244 #ifdef HAVE_SCROLLBARS
245 /* Scrollbars associated with window, if any. */
246 struct scrollbar_instance *scrollbar_vertical_instance;
247 struct scrollbar_instance *scrollbar_horizontal_instance;
248 #endif /* HAVE_SCROLLBARS */
249
250 /* Flag indicating whether a subwindow is currently being displayed. */
251 unsigned int subwindows_being_displayed :1;
252
253 /* Keep track of the truncation status in this window so we can
254 detect when it has changed. #### Magic variables would be a huge
255 win here. */
256 unsigned int truncate_win :1;
257 };
258
259 #ifdef emacs /* some things other than emacs want the structs */
260
261 DECLARE_LRECORD (window, struct window);
262 #define XWINDOW(x) XRECORD (x, window, struct window)
263 #define XSETWINDOW(x, p) XSETRECORD (x, p, window)
264 #define WINDOWP(x) RECORDP (x, window)
265 #define CHECK_WINDOW(x) CHECK_RECORD (x, window)
266 #define CONCHECK_WINDOW(x) CONCHECK_RECORD (x, window)
267
268 #define WINDOW_LIVE_P(x) (!(x)->dead)
269 #define CHECK_LIVE_WINDOW(x) do { \
270 CHECK_WINDOW (x); \
271 if (!WINDOW_LIVE_P (XWINDOW (x))) \
272 dead_wrong_type_argument (Qwindow_live_p, (x)); \
273 } while (0)
274 #define CONCHECK_LIVE_WINDOW(x) do { \
275 CONCHECK_WINDOW (x); \
276 if (!WINDOW_LIVE_P (XWINDOW (x))) \
277 x = wrong_type_argument (Qwindow_live_p, (x)); \
278 } while (0)
279
280 /* 1 if W is a minibuffer window. */
281 #define MINI_WINDOW_P(W) (!NILP ((W)->mini_p))
282
283 /* 1 if we are dealing with a parentless window (this includes the
284 root window on a frame and the minibuffer window; both of these
285 are siblings). */
286 #define TOP_LEVEL_WINDOW_P(w) NILP ((w)->parent)
287
288 /* Set all redisplay flags indicating a window has changed */
289 #define MARK_WINDOWS_CHANGED(w) do { \
290 (w)->windows_changed = 1; \
291 if (!NILP (w->frame)) \
292 { \
293 struct frame *mwc_frame = XFRAME (w->frame); \
294 MARK_FRAME_WINDOWS_CHANGED (mwc_frame); \
295 } \
296 else \
297 windows_changed = 1; \
298 } while (0)
299
300 #define WINDOW_TTY_P(w) FRAME_TTY_P (XFRAME ((w)->frame))
301 #define WINDOW_X_P(w) FRAME_X_P (XFRAME ((w)->frame))
302 #define WINDOW_NS_P(w) FRAME_NS_P (XFRAME ((w)->frame))
303 #define WINDOW_WIN_P(w) FRAME_WIN_P (XFRAME ((w)->frame))
304
305 DECLARE_LRECORD (window_configuration, struct window_config);
306
307 EXFUN (Fget_buffer_window, 3);
308 EXFUN (Fmove_to_window_line, 2);
309 EXFUN (Frecenter, 2);
310 EXFUN (Freplace_buffer_in_windows, 1);
311 EXFUN (Fselect_window, 2);
312 EXFUN (Fselected_window, 1);
313 EXFUN (Fset_window_buffer, 2);
314 EXFUN (Fset_window_hscroll, 2);
315 EXFUN (Fset_window_point, 2);
316 EXFUN (Fset_window_start, 3);
317 EXFUN (Fwindow_buffer, 1);
318 EXFUN (Fwindow_highest_p, 1);
319 EXFUN (Fwindow_point, 1);
320 EXFUN (Fwindow_start, 1);
321
322 /* The minibuffer window of the selected frame.
323 Note that you cannot test for minibufferness of an arbitrary window
324 by comparing against this; but you can test for minibufferness of
325 the selected window or of any window that is displayed. */
326 extern Lisp_Object minibuf_window;
327
328 /* Prompt to display in front of the minibuffer contents, or nil */
329 extern Lisp_Object Vminibuf_prompt;
330 /* Prompt to display in front of the minibuffer prompt, or nil */
331 extern Lisp_Object Vminibuf_preprompt;
332
333 Lisp_Object allocate_window (void);
334 int window_char_width (struct window *, int include_margins_p);
335 int window_char_height (struct window *, int include_gutters_p);
336 int window_displayed_height (struct window *);
337 int window_is_leftmost (struct window *w);
338 int window_is_rightmost (struct window *w);
339 int window_is_lowest (struct window *w);
340 int window_is_highest (struct window *w);
341 int window_truncation_on (struct window *w);
342 int window_needs_vertical_divider (struct window *);
343 int window_scrollbar_width (struct window *w);
344 int window_scrollbar_height (struct window *w);
345 int window_modeline_height (struct window *w);
346 int window_left_margin_width (struct window *w);
347 int window_right_margin_width (struct window *w);
348 int window_top_gutter_height (struct window *w);
349 int window_bottom_gutter_height (struct window *w);
350 int window_left_gutter_width (struct window *w, int modeline);
351 int window_right_gutter_width (struct window *w, int modeline);
352
353 void delete_all_subwindows (struct window *w);
354 void set_window_pixheight (Lisp_Object window, int pixheight,
355 int nodelete);
356 void set_window_pixwidth (Lisp_Object window, int pixwidth,
357 int nodelete);
358 void window_scroll (Lisp_Object window, Lisp_Object n, int direction,
359 Error_behavior errb);
360 int buffer_window_count (struct buffer *b, struct frame *f);
361 int buffer_window_mru (struct window *w);
362 void check_frame_size (struct frame *frame, int *rows, int *cols);
363 struct window *decode_window (Lisp_Object window);
364 struct window *find_window_by_pixel_pos (int pix_x, int pix_y, Lisp_Object win);
365
366 /* new functions to handle the window mirror */
367 void free_window_mirror (struct window_mirror *mir);
368 Lisp_Object real_window (struct window_mirror *mir, int no_abort);
369 struct window_mirror *find_window_mirror (struct window *w);
370 display_line_dynarr *window_display_lines (struct window *w, int);
371 struct buffer *window_display_buffer (struct window *w);
372 void set_window_display_buffer (struct window *w, struct buffer *b);
373 void update_frame_window_mirror (struct frame *f);
374
375 int map_windows (struct frame *f,
376 int (*mapfun) (struct window *w, void *closure),
377 void *closure);
378 void some_window_value_changed (Lisp_Object specifier, struct window *w,
379 Lisp_Object oldval);
380 int invalidate_vertical_divider_cache_in_window (struct window *w,
381 void *u_n_u_s_e_d);
382 int window_divider_width (struct window *w);
383
384 #define WINDOW_FRAME(w) ((w)->frame)
385 #define WINDOW_BUFFER(w) ((w)->buffer)
386 #define WINDOW_DEVICE(w) FRAME_DEVICE (XFRAME (WINDOW_FRAME (w)))
387 #define WINDOW_CONSOLE(w) DEVICE_CONSOLE (XDEVICE (WINDOW_DEVICE (w)))
388
389 /* XEmacs window size and positioning macros. */
390 #define WINDOW_TOP(w) ((w)->pixel_top)
391 #define WINDOW_TEXT_TOP(w) (WINDOW_TOP (w) + window_top_gutter_height (w))
392 #define WINDOW_TEXT_TOP_CLIP(w) ((w)->top_yoffset)
393 #define WINDOW_BOTTOM(w) ((w)->pixel_top + (w)->pixel_height)
394 #define WINDOW_TEXT_BOTTOM(w) (WINDOW_BOTTOM (w) - window_bottom_gutter_height (w))
395 #define WINDOW_LEFT(w) ((w)->pixel_left)
396 #define WINDOW_TEXT_LEFT(w) (WINDOW_LEFT (w) + window_left_gutter_width (w, 0))
397 #define WINDOW_MODELINE_LEFT(w) \
398 (WINDOW_LEFT (w) + window_left_gutter_width (w, 1))
399 #define WINDOW_RIGHT(w) ((w)->pixel_left + (w)->pixel_width)
400 #define WINDOW_TEXT_RIGHT(w) \
401 (WINDOW_RIGHT (w) - window_right_gutter_width (w, 0))
402 #define WINDOW_MODELINE_RIGHT(w) \
403 (WINDOW_RIGHT (w) - window_right_gutter_width (w, 1))
404
405 #define WINDOW_HEIGHT(w) ((w)->pixel_height)
406 #define WINDOW_TEXT_HEIGHT(w) (WINDOW_TEXT_BOTTOM (w) - WINDOW_TEXT_TOP (w))
407 #define WINDOW_WIDTH(w) ((w)->pixel_width)
408 #define WINDOW_TEXT_WIDTH(w) (WINDOW_TEXT_RIGHT (w) - WINDOW_TEXT_LEFT (w))
409
410 #define WINDOW_HAS_MODELINE_P(w) (!NILP (w->has_modeline_p))
411
412 #define MODELINE_OFF_SHADOW_THICKNESS_ADJUSTED(win) \
413 abs ((!WINDOW_HAS_MODELINE_P (win) \
414 ? ((XINT (win->modeline_shadow_thickness) > 1) \
415 ? XINT (win->modeline_shadow_thickness) - 1 \
416 : ((XINT (win->modeline_shadow_thickness) < -1) \
417 ? XINT (win->modeline_shadow_thickness) + 1 \
418 : XINT (win->modeline_shadow_thickness))) \
419 : XINT (win->modeline_shadow_thickness)))
420
421 #define MODELINE_SHADOW_THICKNESS(win) \
422 (MODELINE_OFF_SHADOW_THICKNESS_ADJUSTED (win) > 10 \
423 ? 10 \
424 : MODELINE_OFF_SHADOW_THICKNESS_ADJUSTED (win))
425
426 #endif /* emacs */
427
428 #endif /* _XEMACS_WINDOW_H_ */