Mercurial > hg > xemacs-beta
annotate src/window-impl.h @ 5697:40fbceabaafd
menubar-items.el (default-menubar): Reorganize.
Add PROBLEMS to toplevel.
New "More about XEmacs" submenu for NEWS, licensing, etc.
New "Recent History" menu for messages, lossage, etc.
Get rid of ugly and unexpressive ellipses.
| author | Stephen J. Turnbull <stephen@xemacs.org> |
|---|---|
| date | Mon, 24 Dec 2012 03:08:33 +0900 |
| parents | 56144c8593a8 |
| children |
| rev | line source |
|---|---|
| 872 | 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, 2002 Ben Wing. | |
| 6 Copyright (C) 1996 Chuck Thompson. | |
| 7 | |
| 8 This file is part of XEmacs. | |
| 9 | |
|
5402
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5127
diff
changeset
|
10 XEmacs is free software: you can redistribute it and/or modify it |
| 872 | 11 under the terms of the GNU General Public License as published by the |
|
5402
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5127
diff
changeset
|
12 Free Software Foundation, either version 3 of the License, or (at your |
|
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5127
diff
changeset
|
13 option) any later version. |
| 872 | 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 | |
|
5402
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5127
diff
changeset
|
21 along with XEmacs. If not, see <http://www.gnu.org/licenses/>. */ |
| 872 | 22 |
| 23 /* Synched up with: FSF 19.30. */ | |
| 24 | |
| 25 #ifndef INCLUDED_window_impl_h_ | |
| 26 #define INCLUDED_window_impl_h_ | |
| 27 | |
| 28 #include "window.h" | |
| 29 | |
| 30 /* All windows in use are arranged into a tree, with pointers up and down. | |
| 31 | |
| 32 Windows that are leaves of the tree are actually displayed | |
| 33 and show the contents of buffers. Windows that are not leaves | |
| 34 are used for representing the way groups of leaf windows are | |
| 35 arranged on the frame. Leaf windows never become non-leaves. | |
| 36 They are deleted only by calling delete-window on them (but | |
| 37 this can be done implicitly). Combination windows can be created | |
| 38 and deleted at any time. | |
| 39 | |
| 40 A leaf window has a non-nil buffer field, and also | |
| 41 has markers in its start and pointm fields. Non-leaf windows | |
| 42 have nil in these fields. | |
| 43 | |
| 44 Non-leaf windows are either vertical or horizontal combinations. | |
| 45 | |
| 46 A vertical combination window has children that are arranged on the frame | |
| 47 one above the next. Its vchild field points to the uppermost child. | |
| 48 The parent field of each of the children points to the vertical | |
| 49 combination window. The next field of each child points to the | |
| 50 child below it, or is nil for the lowest child. The prev field | |
| 51 of each child points to the child above it, or is nil for the | |
| 52 highest child. | |
| 53 | |
| 54 A horizontal combination window has children that are side by side. | |
| 55 Its hchild field points to the leftmost child. In each child | |
| 56 the next field points to the child to the right and the prev field | |
| 57 points to the child to the left. | |
| 58 | |
| 59 The children of a vertical combination window may be leaf windows | |
| 60 or horizontal combination windows. The children of a horizontal | |
| 61 combination window may be leaf windows or vertical combination windows. | |
| 62 | |
| 63 At the top of the tree are two windows which have nil as parent. | |
| 64 The second of these is minibuf_window. The first one manages all | |
| 65 the frame area that is not minibuffer, and is called the root window. | |
| 66 Different windows can be the root at different times; | |
| 67 initially the root window is a leaf window, but if more windows | |
| 68 are created then that leaf window ceases to be root and a newly | |
| 69 made combination window becomes root instead. | |
| 70 | |
| 71 In any case, on screens which have an ordinary window and a | |
| 72 minibuffer, prev of the minibuf window is the root window and next of | |
| 73 the root window is the minibuf window. On minibufferless screens or | |
| 74 minibuffer-only screens, the root window and the minibuffer window are | |
| 75 one and the same, so its prev and next members are nil. | |
| 76 | |
| 77 A dead window has the `dead' flag set on it. Note that unlike other | |
| 78 dead objects, dead windows can be made live again through restoring a | |
| 79 window configuration. This means that the values in a dead window | |
| 80 need to be preserved, except for those that are reconstructed by from | |
| 81 the window configuration. */ | |
| 82 | |
| 83 struct window | |
| 84 { | |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
85 NORMAL_LISP_OBJECT_HEADER header; |
| 872 | 86 |
| 87 /* The upper left corner coordinates of this window, | |
| 88 as integers (pixels) relative to upper left corner of frame = 0, 0 */ | |
| 89 int pixel_left; | |
| 90 int pixel_top; | |
| 91 /* The size of the window (in pixels) */ | |
| 92 int pixel_height; | |
| 93 int pixel_width; | |
| 94 | |
| 95 /* Number of columns display within the window is scrolled to the left. */ | |
| 96 int hscroll; | |
| 97 /* Idem for the window's modeline */ | |
| 98 Charcount modeline_hscroll; | |
| 99 /* Amount to clip off the top line for pixel-based scrolling. Point | |
| 100 will remain constant but this will be incremented to | |
| 101 incrementally shift lines up. */ | |
| 102 int top_yoffset; | |
| 103 /* Amount to clip off the left of the lines for pixel-based | |
| 104 scrolling. Hscroll will remain constant but this will be | |
| 105 incremented to incrementally shift lines left.*/ | |
| 106 int left_xoffset; | |
| 107 | |
| 108 /* face cache elements correct for this window and its current buffer */ | |
| 109 face_cachel_dynarr *face_cachels; | |
| 110 /* glyph cache elements correct for this window and its current buffer */ | |
| 111 glyph_cachel_dynarr *glyph_cachels; | |
| 112 /* List of starting positions for display lines. Only valid if | |
| 113 buffer has not changed. */ | |
| 114 line_start_cache_dynarr *line_start_cache; | |
| 115 int line_cache_validation_override; | |
| 116 | |
| 117 /* Length of longest line currently displayed. Used to control the | |
| 118 width of the horizontal scrollbars. */ | |
| 119 int max_line_len; | |
| 120 | |
| 121 /* Frame coords of point at that time */ | |
| 122 int last_point_x[3]; | |
| 123 int last_point_y[3]; | |
| 124 | |
| 125 /* Number of characters in buffer past bottom of window, | |
| 126 as of last redisplay that finished. */ | |
| 127 /* need one for each set of display structures */ | |
| 128 int window_end_pos[3]; | |
| 129 | |
| 130 /* Set by the extent code when extents in the gutter are changed. */ | |
| 131 int gutter_extent_modiff[4]; | |
| 132 | |
| 133 /* Set by redisplay to the last position seen. This is used | |
| 134 to implement the redisplay-end-trigger-functions. */ | |
| 135 Charbpos last_redisplay_pos; | |
| 136 | |
| 137 #define WINDOW_SLOT_DECLARATION | |
| 138 #define WINDOW_SLOT(slot) Lisp_Object slot; | |
| 139 #include "winslots.h" | |
| 140 | |
| 141 /* one-bit flags: */ | |
| 142 | |
| 143 /* marker used when restoring a window configuration */ | |
| 144 unsigned int config_mark :1; | |
| 145 /* Non-zero means window was dead. */ | |
| 146 unsigned int dead :1; | |
| 147 /* Non-zero means next redisplay must use the value of start | |
| 148 set up for it in advance. Set by scrolling commands. */ | |
| 149 unsigned int force_start :1; | |
| 150 /* Non-zero means must regenerate modeline of this window */ | |
| 151 unsigned int redo_modeline :1; | |
| 152 /* Non-zero means current value of `start' | |
| 153 was the beginning of a line when it was chosen. */ | |
| 154 unsigned int start_at_line_beg :1; | |
| 155 /* new redisplay flag */ | |
| 156 unsigned int windows_changed :1; | |
| 157 unsigned int shadow_thickness_changed :1; | |
| 158 /* Vertical divider flag and validity of it */ | |
| 159 unsigned int need_vertical_divider_p :1; | |
| 160 unsigned int need_vertical_divider_valid_p :1; | |
| 161 }; | |
| 162 | |
| 163 #define CURRENT_DISP 0 | |
| 164 #define DESIRED_DISP 1 | |
| 165 #define CMOTION_DISP 2 | |
| 166 | |
| 167 struct window_mirror | |
| 168 { | |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
169 NORMAL_LISP_OBJECT_HEADER header; |
| 872 | 170 |
| 171 /* Frame this mirror is on. */ | |
| 172 struct frame *frame; | |
| 173 | |
| 174 /* Following child (to right or down) at same level of tree */ | |
| 175 struct window_mirror *next; | |
| 176 | |
| 177 /* There is no prev field because we never traverse this structure | |
| 178 backwards. Same goes for the parent field. */ | |
| 179 | |
| 180 /* First child of this window. */ | |
| 181 /* vchild is used if this is a vertical combination, | |
| 182 hchild if this is a horizontal combination. */ | |
| 183 struct window_mirror *hchild, *vchild; | |
| 184 | |
| 185 /* Dynamic array of display lines */ | |
| 186 display_line_dynarr *current_display_lines; | |
| 187 display_line_dynarr *desired_display_lines; | |
| 188 | |
| 189 /* Buffer current_display_lines represent. */ | |
| 190 struct buffer *buffer; | |
| 191 | |
| 192 #ifdef HAVE_SCROLLBARS | |
| 193 /* Scrollbars associated with window, if any. */ | |
| 194 struct scrollbar_instance *scrollbar_vertical_instance; | |
| 195 struct scrollbar_instance *scrollbar_horizontal_instance; | |
| 196 #endif /* HAVE_SCROLLBARS */ | |
| 197 | |
| 198 /* Flag indicating whether a subwindow is currently being displayed. */ | |
| 199 unsigned int subwindows_being_displayed :1; | |
| 200 | |
| 201 /* Keep track of the truncation status in this window so we can | |
| 202 detect when it has changed. #### Magic variables would be a huge | |
| 203 win here. */ | |
| 204 unsigned int truncate_win :1; | |
| 205 }; | |
| 206 | |
| 207 /* Redefine basic properties more efficiently */ | |
| 208 | |
| 209 #undef WINDOW_LIVE_P | |
| 210 #define WINDOW_LIVE_P(x) (!(x)->dead) | |
| 211 #undef WINDOW_FRAME | |
| 212 #define WINDOW_FRAME(w) ((w)->frame) | |
| 213 #undef WINDOW_BUFFER | |
| 214 #define WINDOW_BUFFER(w) ((w)->buffer) | |
| 215 | |
| 216 /* 1 if W is a minibuffer window. */ | |
| 217 #define MINI_WINDOW_P(W) (!NILP ((W)->mini_p)) | |
| 218 | |
| 219 /* 1 if we are dealing with a parentless window (this includes the | |
| 220 root window on a frame and the minibuffer window; both of these | |
| 221 are siblings). */ | |
| 222 #define TOP_LEVEL_WINDOW_P(w) NILP ((w)->parent) | |
| 223 | |
| 224 /* Set all redisplay flags indicating a window has changed */ | |
| 225 #define MARK_WINDOWS_CHANGED(w) do { \ | |
| 226 (w)->windows_changed = 1; \ | |
| 227 if (!NILP (w->frame)) \ | |
| 228 { \ | |
| 229 struct frame *mwc_frame = XFRAME (w->frame); \ | |
| 230 MARK_FRAME_WINDOWS_CHANGED (mwc_frame); \ | |
| 231 } \ | |
| 232 else \ | |
| 233 windows_changed = 1; \ | |
| 234 } while (0) | |
| 235 | |
| 236 /* #### This should be fixed not to call MARK_FRAME_CHANGED because | |
| 237 faces are cached per window. Also, other code which changes window's | |
| 238 face should use this macro. | |
| 239 */ | |
| 240 #define MARK_WINDOW_FACES_CHANGED(w) \ | |
| 241 MARK_FRAME_FACES_CHANGED (XFRAME ((w)->frame)) | |
| 242 | |
| 243 #define WINDOW_TTY_P(w) FRAME_TTY_P (XFRAME ((w)->frame)) | |
| 244 #define WINDOW_X_P(w) FRAME_X_P (XFRAME ((w)->frame)) | |
| 245 #define WINDOW_NS_P(w) FRAME_NS_P (XFRAME ((w)->frame)) | |
| 246 #define WINDOW_WIN_P(w) FRAME_WIN_P (XFRAME ((w)->frame)) | |
| 247 | |
| 248 /* XEmacs window size and positioning macros. */ | |
| 249 #define WINDOW_TOP(w) ((w)->pixel_top) | |
| 250 #define WINDOW_TEXT_TOP(w) (WINDOW_TOP (w) + window_top_gutter_height (w)) | |
| 251 #define WINDOW_TEXT_TOP_CLIP(w) ((w)->top_yoffset) | |
| 252 #define WINDOW_BOTTOM(w) ((w)->pixel_top + (w)->pixel_height) | |
| 253 #define WINDOW_TEXT_BOTTOM(w) (WINDOW_BOTTOM (w) - window_bottom_gutter_height (w)) | |
| 254 #define WINDOW_LEFT(w) ((w)->pixel_left) | |
| 255 #define WINDOW_TEXT_LEFT(w) (WINDOW_LEFT (w) + window_left_gutter_width (w, 0)) | |
| 256 #define WINDOW_MODELINE_LEFT(w) \ | |
| 257 (WINDOW_LEFT (w) + window_left_gutter_width (w, 1)) | |
| 258 #define WINDOW_RIGHT(w) ((w)->pixel_left + (w)->pixel_width) | |
| 259 #define WINDOW_TEXT_RIGHT(w) \ | |
| 260 (WINDOW_RIGHT (w) - window_right_gutter_width (w, 0)) | |
| 261 #define WINDOW_MODELINE_RIGHT(w) \ | |
| 262 (WINDOW_RIGHT (w) - window_right_gutter_width (w, 1)) | |
| 263 | |
| 264 #define WINDOW_HEIGHT(w) ((w)->pixel_height) | |
| 265 #define WINDOW_TEXT_HEIGHT(w) (WINDOW_TEXT_BOTTOM (w) - WINDOW_TEXT_TOP (w)) | |
| 266 #define WINDOW_WIDTH(w) ((w)->pixel_width) | |
| 267 #define WINDOW_TEXT_WIDTH(w) (WINDOW_TEXT_RIGHT (w) - WINDOW_TEXT_LEFT (w)) | |
| 268 | |
| 269 #define WINDOW_HAS_MODELINE_P(w) (!NILP (w->has_modeline_p)) | |
| 270 | |
| 271 #define MODELINE_OFF_SHADOW_THICKNESS_ADJUSTED(win) \ | |
| 272 abs ((!WINDOW_HAS_MODELINE_P (win) \ | |
|
5581
56144c8593a8
Mechanically change INT to FIXNUM in our sources.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5402
diff
changeset
|
273 ? ((XFIXNUM (win->modeline_shadow_thickness) > 1) \ |
|
56144c8593a8
Mechanically change INT to FIXNUM in our sources.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5402
diff
changeset
|
274 ? XFIXNUM (win->modeline_shadow_thickness) - 1 \ |
|
56144c8593a8
Mechanically change INT to FIXNUM in our sources.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5402
diff
changeset
|
275 : ((XFIXNUM (win->modeline_shadow_thickness) < -1) \ |
|
56144c8593a8
Mechanically change INT to FIXNUM in our sources.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5402
diff
changeset
|
276 ? XFIXNUM (win->modeline_shadow_thickness) + 1 \ |
|
56144c8593a8
Mechanically change INT to FIXNUM in our sources.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5402
diff
changeset
|
277 : XFIXNUM (win->modeline_shadow_thickness))) \ |
|
56144c8593a8
Mechanically change INT to FIXNUM in our sources.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5402
diff
changeset
|
278 : XFIXNUM (win->modeline_shadow_thickness))) |
| 872 | 279 |
| 280 #define MODELINE_SHADOW_THICKNESS(win) \ | |
| 281 (MODELINE_OFF_SHADOW_THICKNESS_ADJUSTED (win) > 10 \ | |
| 282 ? 10 \ | |
| 283 : MODELINE_OFF_SHADOW_THICKNESS_ADJUSTED (win)) | |
| 284 | |
| 285 #endif /* INCLUDED_window_impl_h_ */ |