1 /* scrollbar implementation -- mswindows interface.
2 Copyright (C) 1994, 1995 Board of Trustees, University of Illinois.
3 Copyright (C) 1994 Amdahl Corporation.
4 Copyright (C) 1995 Sun Microsystems, Inc.
5 Copyright (C) 1995 Darrell Kindred <dkindred+@cmu.edu>.
7 This file is part of XEmacs.
9 XEmacs is free software; you can redistribute it and/or modify it
10 under the terms of the GNU General Public License as published by the
11 Free Software Foundation; either version 2, or (at your option) any
14 XEmacs is distributed in the hope that it will be useful, but WITHOUT
15 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
16 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19 You should have received a copy of the GNU General Public License
20 along with XEmacs; see the file COPYING. If not, write to
21 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 Boston, MA 02111-1307, USA. */
24 /* Synched up with: Not in FSF. */
29 #include "console-msw.h"
32 #include "scrollbar-msw.h"
33 #include "scrollbar.h"
34 #include "specifier.h"
37 /* We use a similar sort of vertical scrollbar drag hack for mswindows
38 * scrollbars as is used for Motif or Lucid scrollbars under X.
39 * We do character-based instead of line-based scrolling, which can mean that
40 * without the hack it is impossible to drag to the end of a buffer. */
41 #define VERTICAL_SCROLLBAR_DRAG_HACK
43 static int vertical_drag_in_progress = 0;
44 extern Lisp_Object mswindows_find_frame (HWND hwnd);
47 mswindows_create_scrollbar_instance (struct frame *f, int vertical,
48 struct scrollbar_instance *sb)
52 sb->scrollbar_data = xnew_and_zero (struct mswindows_scrollbar_data);
55 orientation = SBS_VERT;
57 orientation = SBS_HORZ;
59 SCROLLBAR_MSW_HANDLE (sb) =
60 CreateWindowEx(0, "SCROLLBAR", 0, orientation|WS_CHILD,
61 CW_USEDEFAULT, CW_USEDEFAULT,
62 CW_USEDEFAULT, CW_USEDEFAULT,
63 FRAME_MSWINDOWS_HANDLE (f),
65 SCROLLBAR_MSW_INFO (sb).cbSize = sizeof(SCROLLINFO);
66 SCROLLBAR_MSW_INFO (sb).fMask = SIF_ALL;
67 GetScrollInfo(SCROLLBAR_MSW_HANDLE (sb), SB_CTL,
68 &SCROLLBAR_MSW_INFO (sb));
69 SetWindowLong (SCROLLBAR_MSW_HANDLE(sb), GWL_USERDATA, (LONG)sb);
73 HWND h = SCROLLBAR_MSW_HANDLE (sb);
74 int x = SetWindowLong (SCROLLBAR_MSW_HANDLE(sb), GWL_USERDATA, (LONG)sb);
75 int y = GetLastError();
76 struct scrollbar_instance *z = (struct scrollbar_instance *)GetWindowLong (SCROLLBAR_MSW_HANDLE(sb),
84 mswindows_free_scrollbar_instance (struct scrollbar_instance *sb)
86 DestroyWindow (SCROLLBAR_MSW_HANDLE (sb));
87 if (sb->scrollbar_data)
88 xfree (sb->scrollbar_data);
92 unshow_that_mofo (void *handle)
94 ShowScrollBar ((HWND) handle, SB_CTL, 0);
98 mswindows_release_scrollbar_instance (struct scrollbar_instance *sb)
101 /* #### way bogus! need to remove the offending call.
102 see mark_redisplay(). */
103 register_post_gc_action (unshow_that_mofo,
104 (void *) SCROLLBAR_MSW_HANDLE (sb));
106 ShowScrollBar (SCROLLBAR_MSW_HANDLE (sb), SB_CTL, 0);
107 SCROLLBAR_MSW_SIZE (sb) = 0;
110 #define UPDATE_POS_FIELD(field) \
111 if (new_##field >= 0 && SCROLLBAR_MSW_DATA (sb)->field != new_##field) { \
112 SCROLLBAR_MSW_DATA (sb)->field = new_##field; \
117 mswindows_update_scrollbar_instance_values (struct window *w,
118 struct scrollbar_instance *sb,
119 int new_line_increment,
120 int new_page_increment,
121 int new_minimum, int new_maximum,
123 int new_slider_position,
124 int new_scrollbar_width,
125 int new_scrollbar_height,
130 long styles = GetWindowLong (SCROLLBAR_MSW_HANDLE (sb), GWL_STYLE);
131 int vert = styles & SBS_VERT;
134 mswindows_output_last_error("GetWindowLong");
139 stderr_out ("[%d, %d], page = %d, pos = %d, inhibit = %d\n", new_minimum, new_maximum,
140 new_slider_size, new_slider_position,inhibit_slider_size_change);
143 /* These might be optimized, but since at least one will change at each
144 call, it's probably not worth it. */
145 SCROLLBAR_MSW_INFO (sb).nMin = new_minimum;
146 SCROLLBAR_MSW_INFO (sb).nMax = new_maximum;
147 SCROLLBAR_MSW_INFO (sb).nPage = new_slider_size + 1; /* +1 for DISABLENOSCROLL */
148 SCROLLBAR_MSW_INFO (sb).nPos = new_slider_position;
149 #ifndef VERTICAL_SCROLLBAR_DRAG_HACK
150 SCROLLBAR_MSW_INFO (sb).fMask = ((vert && vertical_drag_in_progress)
151 ? SIF_RANGE | SIF_POS
152 : SIF_ALL | SIF_DISABLENOSCROLL);
154 SCROLLBAR_MSW_INFO (sb).fMask = SIF_ALL | SIF_DISABLENOSCROLL;
156 /* Ignore XEmacs' requests to update the thumb position and size; they don't
157 * bear any relation to reality because we're reporting made-up positions */
158 if (!(vert && vertical_drag_in_progress))
160 SetScrollInfo (SCROLLBAR_MSW_HANDLE (sb), SB_CTL, &SCROLLBAR_MSW_INFO (sb),
163 UPDATE_POS_FIELD (scrollbar_x);
164 UPDATE_POS_FIELD (scrollbar_y);
165 UPDATE_POS_FIELD (scrollbar_width);
166 UPDATE_POS_FIELD (scrollbar_height);
170 MoveWindow(SCROLLBAR_MSW_HANDLE (sb),
171 new_scrollbar_x, new_scrollbar_y,
172 new_scrollbar_width, new_scrollbar_height,
178 mswindows_update_scrollbar_instance_status (struct window *w,
179 int active, int size,
180 struct scrollbar_instance *sb)
182 if (SCROLLBAR_MSW_SIZE (sb) != size)
184 SCROLLBAR_MSW_SIZE (sb) = size;
185 ShowScrollBar (SCROLLBAR_MSW_HANDLE (sb), SB_CTL,
186 SCROLLBAR_MSW_SIZE (sb));
187 SCROLLBAR_MSW_INFO(sb).fMask |= SIF_DISABLENOSCROLL;
188 SetScrollInfo(SCROLLBAR_MSW_HANDLE (sb), SB_CTL, &SCROLLBAR_MSW_INFO (sb), TRUE);
193 mswindows_handle_scrollbar_event (HWND hwnd, int code, int pos)
196 Lisp_Object win, frame;
197 struct scrollbar_instance *sb;
198 long styles = GetWindowLong (hwnd, GWL_STYLE);
199 int vert = styles & SBS_VERT;
202 mswindows_output_last_error("GetWindowLong");
206 sb = (struct scrollbar_instance *)GetWindowLong (hwnd, GWL_USERDATA);
209 win = real_window (sb->mirror, 1);
210 /* "0 as the second parameter" refers to the call to real_window
211 above. This comment was taken from Ben's 21.5 code that differs
212 somewhat from this, I don't think the 21.4 code ever had a 0
213 there. #### we're still hitting an abort here with 0 as the
214 second parameter, although only occasionally. It seems that
215 sometimes we receive events for scrollbars that don't exist
216 anymore. I assume it must happen like this: The user does
217 something that causes a scrollbar to disappear (e.g. Alt-TAB,
218 causing recomputation of everything in the new frame) and then
219 immediately uses the mouse wheel, generating scrollbar events.
220 Both events get posted before we have a chance to process them,
221 and in processing the first, the scrollbar mentioned in the
222 second disappears. */
225 frame = XWINDOW (win)->frame;
230 /* I'm not sure if this is right, but its much better than
231 passing an HNWD to real_window() - which is what the previous
233 frame = mswindows_find_frame (GetFocus());
235 win = FRAME_SELECTED_WINDOW (f);
238 /* SB_LINEDOWN == SB_CHARLEFT etc. This is the way they will
239 always be - any Windows is binary compatible backward with
245 mswindows_enqueue_misc_user_event
246 (frame, vert ? Qscrollbar_line_down : Qscrollbar_char_right, win);
250 mswindows_enqueue_misc_user_event
251 (frame, vert ? Qscrollbar_line_up : Qscrollbar_char_left, win);
255 mswindows_enqueue_misc_user_event
256 (win, vert ? Qscrollbar_page_down : Qscrollbar_page_right,
257 vert ? Fcons (win, Qnil) : win);
261 mswindows_enqueue_misc_user_event
263 vert ? Qscrollbar_page_up : Qscrollbar_page_left,
264 vert ? Fcons (win, Qnil) : win);
268 mswindows_enqueue_misc_user_event
269 (frame, vert ? Qscrollbar_to_bottom : Qscrollbar_to_right, win);
273 mswindows_enqueue_misc_user_event
274 (frame, vert ? Qscrollbar_to_top : Qscrollbar_to_left, win);
278 case SB_THUMBPOSITION:
281 SCROLLINFO scrollinfo;
282 scrollinfo.cbSize = sizeof(SCROLLINFO);
283 scrollinfo.fMask = SIF_ALL;
284 GetScrollInfo (hwnd, SB_CTL, &scrollinfo);
285 vertical_drag_in_progress = vert;
286 #ifdef VERTICAL_SCROLLBAR_DRAG_HACK
287 if (vert && (scrollinfo.nTrackPos > scrollinfo.nPos))
288 /* new buffer position =
289 * buffer position at start of drag +
290 * ((text remaining in buffer at start of drag) *
291 * (amount that the thumb has been moved) /
292 * (space that remained past end of the thumb at start of drag)) */
296 (scrollinfo.nMax - scrollinfo.nPos)
297 * (scrollinfo.nTrackPos - scrollinfo.nPos))
298 / (scrollinfo.nMax - scrollinfo.nPage - scrollinfo.nPos)))
299 - 2; /* ensure that the last line doesn't disappear off screen */
302 pos = scrollinfo.nTrackPos;
303 mswindows_enqueue_misc_user_event
305 vert ? Qscrollbar_vertical_drag : Qscrollbar_horizontal_drag,
306 Fcons (win, make_int (pos)));
311 #ifdef VERTICAL_SCROLLBAR_DRAG_HACK
312 if (vertical_drag_in_progress && sb)
313 /* User has just dropped the thumb - finally update it */
314 SetScrollInfo (SCROLLBAR_MSW_HANDLE (sb), SB_CTL,
315 &SCROLLBAR_MSW_INFO (sb), TRUE);
317 vertical_drag_in_progress = 0;
323 can_scroll (struct scrollbar_instance* scrollbar)
325 return scrollbar != NULL
326 && IsWindowVisible (SCROLLBAR_MSW_HANDLE (scrollbar))
327 && IsWindowEnabled (SCROLLBAR_MSW_HANDLE (scrollbar));
331 mswindows_handle_mousewheel_event (Lisp_Object frame, int keys, int delta,
334 int hasVertBar, hasHorzBar; /* Indicates presence of scroll bars */
335 unsigned wheelScrollLines = 0; /* Number of lines per wheel notch */
336 Lisp_Object win, corpore, sano;
337 struct window_mirror *mirror;
338 int mene, _mene, tekel, upharsin;
341 struct window *needle_in_haystack = 0;
344 donde_esta.x = where.x;
345 donde_esta.y = where.y;
347 /* Find the window to scroll */
349 /* The mouse event could actually occur outside of the emacs
351 if (ScreenToClient (FRAME_MSWINDOWS_HANDLE (XFRAME (frame)),
354 /* stderr_out ("donde_esta: %d %d\n", donde_esta.x, donde_esta.y); */
355 pixel_to_glyph_translation (XFRAME (frame), donde_esta.x, donde_esta.y,
356 &mene, &_mene, &tekel, &upharsin,
358 &mens, &sana, &in, &corpore, &sano);
360 if (needle_in_haystack)
362 XSETWINDOW (win, needle_in_haystack);
363 /* stderr_out ("found needle\n");
364 debug_print (win); */
368 if (!needle_in_haystack)
370 win = FRAME_SELECTED_WINDOW (XFRAME (frame));
371 needle_in_haystack = XWINDOW (win);
374 mirror = find_window_mirror (needle_in_haystack);
376 /* Check that there is something to scroll */
377 hasVertBar = can_scroll (mirror->scrollbar_vertical_instance);
378 hasHorzBar = can_scroll (mirror->scrollbar_horizontal_instance);
379 if (!hasVertBar && !hasHorzBar)
382 /* No support for panning and zooming, so ignore */
383 if (keys & (MK_SHIFT | MK_CONTROL))
386 /* Get the number of lines per wheel delta */
387 SystemParametersInfo (SPI_GETWHEELSCROLLLINES, 0, &wheelScrollLines, 0);
389 /* Calculate the amount to scroll */
390 if (wheelScrollLines == WHEEL_PAGESCROLL)
392 /* Scroll by a page */
393 Lisp_Object function;
395 function = delta > 0 ? Qscrollbar_page_up : Qscrollbar_page_down;
397 function = delta > 0 ? Qscrollbar_page_left : Qscrollbar_page_right;
398 mswindows_enqueue_misc_user_event (frame, function, Fcons (win, Qnil));
400 else /* Scroll by a number of lines */
402 /* Calc the number of lines to scroll */
403 int toScroll = MulDiv (delta, wheelScrollLines, WHEEL_DELTA);
406 Lisp_Object function;
408 function = delta > 0 ? Qscrollbar_line_up : Qscrollbar_line_down;
410 function = delta > 0 ? Qscrollbar_char_left : Qscrollbar_char_right;
412 toScroll = -toScroll;
414 mswindows_enqueue_misc_user_event (frame, function, win);
420 #ifdef MEMORY_USAGE_STATS
423 mswindows_compute_scrollbar_instance_usage (struct device *d,
424 struct scrollbar_instance *inst,
425 struct overhead_stats *ovstats)
431 struct mswindows_scrollbar_data *data =
432 (struct mswindows_scrollbar_data *) inst->scrollbar_data;
434 total += malloced_storage_size (data, sizeof (*data), ovstats);
441 #endif /* MEMORY_USAGE_STATS */
443 /************************************************************************/
444 /* Device-specific ghost specifiers initialization */
445 /************************************************************************/
447 DEFUN ("mswindows-init-scrollbar-metrics", Fmswindows_init_scrollbar_metrics, 1, 1, 0, /*
451 if (DEVICEP (locale))
453 add_spec_to_ghost_specifier (Vscrollbar_width,
454 make_int (GetSystemMetrics (SM_CXVSCROLL)),
455 locale, Qmswindows, Qnil);
456 add_spec_to_ghost_specifier (Vscrollbar_height,
457 make_int (GetSystemMetrics (SM_CYHSCROLL)),
458 locale, Qmswindows, Qnil);
464 /************************************************************************/
466 /************************************************************************/
469 console_type_create_scrollbar_mswindows (void)
471 CONSOLE_HAS_METHOD (mswindows, create_scrollbar_instance);
472 CONSOLE_HAS_METHOD (mswindows, free_scrollbar_instance);
473 CONSOLE_HAS_METHOD (mswindows, release_scrollbar_instance);
474 CONSOLE_HAS_METHOD (mswindows, update_scrollbar_instance_values);
475 CONSOLE_HAS_METHOD (mswindows, update_scrollbar_instance_status);
476 /* CONSOLE_HAS_METHOD (mswindows, scrollbar_width_changed_in_frame); */
477 #ifdef MEMORY_USAGE_STATS
478 CONSOLE_HAS_METHOD (mswindows, compute_scrollbar_instance_usage);
483 syms_of_scrollbar_mswindows(void)
485 DEFSUBR (Fmswindows_init_scrollbar_metrics);
489 vars_of_scrollbar_mswindows(void)
491 Fprovide (intern ("mswindows-scrollbars"));