This commit was manufactured by cvs2svn to create branch 'XEmacs-21_4'.
[chise/xemacs-chise.git-] / src / scrollbar-msw.c
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>.
6
7 This file is part of XEmacs.
8
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
12 later version.
13
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
17 for more details.
18
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.  */
23
24 /* Synched up with: Not in FSF. */
25
26 #include <config.h>
27 #include "lisp.h"
28
29 #include "console-msw.h"
30 #include "events.h"
31 #include "frame.h"
32 #include "scrollbar-msw.h"
33 #include "scrollbar.h"
34 #include "specifier.h"
35 #include "window.h"
36
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
42
43 static int vertical_drag_in_progress = 0;
44
45 static void
46 mswindows_create_scrollbar_instance (struct frame *f, int vertical,
47                                      struct scrollbar_instance *sb)
48 {
49   int orientation;
50
51   sb->scrollbar_data = xnew_and_zero (struct mswindows_scrollbar_data);
52
53   if (vertical)
54     orientation = SBS_VERT;
55   else
56     orientation = SBS_HORZ;
57
58   SCROLLBAR_MSW_HANDLE (sb) =
59     CreateWindowEx(0, "SCROLLBAR", 0, orientation|WS_CHILD,
60                  CW_USEDEFAULT, CW_USEDEFAULT,
61                  CW_USEDEFAULT, CW_USEDEFAULT,
62                  FRAME_MSWINDOWS_HANDLE (f),
63                  NULL, NULL, NULL);
64   SCROLLBAR_MSW_INFO (sb).cbSize = sizeof(SCROLLINFO);
65   SCROLLBAR_MSW_INFO (sb).fMask = SIF_ALL;
66   GetScrollInfo(SCROLLBAR_MSW_HANDLE (sb), SB_CTL,
67                 &SCROLLBAR_MSW_INFO (sb));
68   SetWindowLong (SCROLLBAR_MSW_HANDLE(sb), GWL_USERDATA, (LONG)sb);
69
70 #if 0
71   {
72           HWND h = SCROLLBAR_MSW_HANDLE (sb);
73           int x = SetWindowLong (SCROLLBAR_MSW_HANDLE(sb), GWL_USERDATA, (LONG)sb);
74           int y = GetLastError();
75           struct scrollbar_instance *z = (struct scrollbar_instance *)GetWindowLong (SCROLLBAR_MSW_HANDLE(sb),
76                   GWL_USERDATA);
77           *z = *z;
78   }
79 #endif
80 }
81
82 static void
83 mswindows_free_scrollbar_instance (struct scrollbar_instance *sb)
84 {
85   DestroyWindow (SCROLLBAR_MSW_HANDLE (sb));
86   if (sb->scrollbar_data)
87     xfree (sb->scrollbar_data);
88 }
89
90 static void
91 mswindows_release_scrollbar_instance (struct scrollbar_instance *sb)
92 {
93   ShowScrollBar (SCROLLBAR_MSW_HANDLE (sb), SB_CTL, 0);
94   SCROLLBAR_MSW_SIZE (sb) = 0;
95 }
96
97 #define UPDATE_POS_FIELD(field)                                            \
98   if (new_##field >= 0 && SCROLLBAR_MSW_DATA (sb)->field != new_##field) { \
99     SCROLLBAR_MSW_DATA (sb)->field = new_##field;                          \
100     pos_changed = 1;                                                       \
101   }
102
103 static void
104 mswindows_update_scrollbar_instance_values (struct window *w,
105                                             struct scrollbar_instance *sb,
106                                             int new_line_increment,
107                                             int new_page_increment,
108                                             int new_minimum, int new_maximum,
109                                             int new_slider_size,
110                                             int new_slider_position,
111                                             int new_scrollbar_width,
112                                             int new_scrollbar_height,
113                                             int new_scrollbar_x,
114                                             int new_scrollbar_y)
115 {
116   int pos_changed = 0;
117   int vert = GetWindowLong (SCROLLBAR_MSW_HANDLE (sb), GWL_STYLE) & SBS_VERT;
118
119 #if 0
120   stderr_out ("[%d, %d], page = %d, pos = %d, inhibit = %d\n", new_minimum, new_maximum,
121               new_slider_size, new_slider_position,inhibit_slider_size_change);
122 #endif
123
124   /* These might be optimized, but since at least one will change at each
125      call, it's probably not worth it. */
126   SCROLLBAR_MSW_INFO (sb).nMin = new_minimum;
127   SCROLLBAR_MSW_INFO (sb).nMax = new_maximum;
128   SCROLLBAR_MSW_INFO (sb).nPage = new_slider_size + 1; /* +1 for DISABLENOSCROLL */
129   SCROLLBAR_MSW_INFO (sb).nPos = new_slider_position;
130 #ifndef VERTICAL_SCROLLBAR_DRAG_HACK
131   SCROLLBAR_MSW_INFO (sb).fMask = ((vert && vertical_drag_in_progress)
132                                    ? SIF_RANGE | SIF_POS
133                                    : SIF_ALL | SIF_DISABLENOSCROLL);
134 #else
135   SCROLLBAR_MSW_INFO (sb).fMask = SIF_ALL | SIF_DISABLENOSCROLL;
136
137   /* Ignore XEmacs' requests to update the thumb position and size; they don't
138    * bear any relation to reality because we're reporting made-up positions */
139   if (!(vert && vertical_drag_in_progress))
140 #endif
141     SetScrollInfo (SCROLLBAR_MSW_HANDLE (sb), SB_CTL, &SCROLLBAR_MSW_INFO (sb),
142                    TRUE);
143
144   UPDATE_POS_FIELD (scrollbar_x);
145   UPDATE_POS_FIELD (scrollbar_y);
146   UPDATE_POS_FIELD (scrollbar_width);
147   UPDATE_POS_FIELD (scrollbar_height);
148
149   if (pos_changed)
150     {
151       MoveWindow(SCROLLBAR_MSW_HANDLE (sb),
152                  new_scrollbar_x, new_scrollbar_y,
153                  new_scrollbar_width, new_scrollbar_height,
154                  TRUE);
155     }
156 }
157
158 static void
159 mswindows_update_scrollbar_instance_status (struct window *w,
160                                             int active, int size,
161                                             struct scrollbar_instance *sb)
162 {
163   if (SCROLLBAR_MSW_SIZE (sb) != size)
164     {
165       SCROLLBAR_MSW_SIZE (sb) = size;
166       ShowScrollBar (SCROLLBAR_MSW_HANDLE (sb), SB_CTL,
167                      SCROLLBAR_MSW_SIZE (sb));
168       SCROLLBAR_MSW_INFO(sb).fMask |= SIF_DISABLENOSCROLL;
169       SetScrollInfo(SCROLLBAR_MSW_HANDLE (sb), SB_CTL, &SCROLLBAR_MSW_INFO (sb), TRUE);
170     }
171 }
172
173 void
174 mswindows_handle_scrollbar_event (HWND hwnd, int code, int pos)
175 {
176   struct frame *f;
177   Lisp_Object win, frame;
178   struct scrollbar_instance *sb;
179   SCROLLINFO scrollinfo;
180   int vert = GetWindowLong (hwnd, GWL_STYLE) & SBS_VERT;
181   int value;
182
183   sb = (struct scrollbar_instance *)GetWindowLong (hwnd, GWL_USERDATA);
184   win = real_window (sb->mirror, 1);
185   frame = XWINDOW (win)->frame;
186   f = XFRAME (frame);
187
188   /* SB_LINEDOWN == SB_CHARLEFT etc. This is the way they will
189      always be - any Windows is binary compatible backward with
190      old programs */
191
192   switch (code)
193     {
194     case SB_LINEDOWN:
195       mswindows_enqueue_misc_user_event
196         (frame, vert ? Qscrollbar_line_down : Qscrollbar_char_right, win);
197       break;
198
199     case SB_LINEUP:
200       mswindows_enqueue_misc_user_event
201         (frame, vert ? Qscrollbar_line_up : Qscrollbar_char_left, win);
202       break;
203
204     case SB_PAGEDOWN:
205       mswindows_enqueue_misc_user_event
206         (win, vert ? Qscrollbar_page_down : Qscrollbar_page_right,
207          vert ? Fcons (win, Qnil) : win);
208       break;
209
210     case SB_PAGEUP:
211       mswindows_enqueue_misc_user_event
212         (frame,
213          vert ? Qscrollbar_page_up : Qscrollbar_page_left,
214          vert ? Fcons (win, Qnil) : win);
215       break;
216
217     case SB_BOTTOM:
218       mswindows_enqueue_misc_user_event
219         (frame, vert ? Qscrollbar_to_bottom : Qscrollbar_to_right, win);
220       break;
221
222     case SB_TOP:
223       mswindows_enqueue_misc_user_event
224         (frame, vert ? Qscrollbar_to_top : Qscrollbar_to_left, win);
225       break;
226
227     case SB_THUMBTRACK:
228     case SB_THUMBPOSITION:
229       scrollinfo.cbSize = sizeof(SCROLLINFO);
230       scrollinfo.fMask = SIF_ALL;
231       GetScrollInfo (hwnd, SB_CTL, &scrollinfo);
232       vertical_drag_in_progress = vert;
233 #ifdef VERTICAL_SCROLLBAR_DRAG_HACK
234       if (vert && (scrollinfo.nTrackPos > scrollinfo.nPos))
235         /* new buffer position =
236          *  buffer position at start of drag +
237          *   ((text remaining in buffer at start of drag) *
238          *    (amount that the thumb has been moved) /
239          *    (space that remained past end of the thumb at start of drag)) */
240         value = (int)
241           (scrollinfo.nPos
242            + (((double)
243               (scrollinfo.nMax - scrollinfo.nPos)
244                * (scrollinfo.nTrackPos - scrollinfo.nPos))
245               / (scrollinfo.nMax - scrollinfo.nPage - scrollinfo.nPos)))
246           - 2;  /* ensure that the last line doesn't disappear off screen */
247       else
248 #endif
249         value = scrollinfo.nTrackPos;
250       mswindows_enqueue_misc_user_event
251         (frame,
252          vert ? Qscrollbar_vertical_drag : Qscrollbar_horizontal_drag,
253          Fcons (win, make_int (value)));
254       break;
255
256     case SB_ENDSCROLL:
257 #ifdef VERTICAL_SCROLLBAR_DRAG_HACK
258       if (vertical_drag_in_progress)
259         /* User has just dropped the thumb - finally update it */
260         SetScrollInfo (SCROLLBAR_MSW_HANDLE (sb), SB_CTL,
261                        &SCROLLBAR_MSW_INFO (sb), TRUE);
262 #endif
263       vertical_drag_in_progress = 0;
264       break;
265     }
266 }
267
268 static int
269 can_scroll(struct scrollbar_instance* scrollbar)
270 {
271   return scrollbar != NULL
272         && IsWindowVisible (SCROLLBAR_MSW_HANDLE (scrollbar))
273         && IsWindowEnabled (SCROLLBAR_MSW_HANDLE (scrollbar));
274 }
275
276 int
277 mswindows_handle_mousewheel_event (Lisp_Object frame, int keys, int delta)
278 {
279   int hasVertBar, hasHorzBar;   /* Indicates presence of scroll bars */
280   unsigned wheelScrollLines = 0; /* Number of lines per wheel notch */
281
282   /* Find the currently selected window */
283   Lisp_Object win = FRAME_SELECTED_WINDOW (XFRAME (frame));
284   struct window* w = XWINDOW (win);
285   struct window_mirror* mirror = find_window_mirror (w);
286
287   /* Check that there is something to scroll */
288   hasVertBar = can_scroll (mirror->scrollbar_vertical_instance);
289   hasHorzBar = can_scroll (mirror->scrollbar_horizontal_instance);
290   if (!hasVertBar && !hasHorzBar)
291     return FALSE;
292
293   /* No support for panning and zooming, so ignore */
294   if (keys & (MK_SHIFT | MK_CONTROL))
295     return FALSE;
296
297   /* Get the number of lines per wheel delta */
298   SystemParametersInfo (SPI_GETWHEELSCROLLLINES, 0, &wheelScrollLines, 0);
299
300   /* Calculate the amount to scroll */
301   if (wheelScrollLines == WHEEL_PAGESCROLL)
302     {
303       /* Scroll by a page */
304       Lisp_Object function;
305       if (hasVertBar)
306         function = delta > 0 ? Qscrollbar_page_up : Qscrollbar_page_down;
307       else
308         function = delta > 0 ? Qscrollbar_page_left : Qscrollbar_page_right;
309       mswindows_enqueue_misc_user_event (frame, function, Fcons (win, Qnil));
310     }
311   else /* Scroll by a number of lines */
312     {
313       /* Calc the number of lines to scroll */
314       int toScroll = MulDiv (delta, wheelScrollLines, WHEEL_DELTA);
315
316       /* Do the scroll */
317       Lisp_Object function;
318       if (hasVertBar)
319         function = delta > 0 ? Qscrollbar_line_up : Qscrollbar_line_down;
320       else
321         function = delta > 0 ? Qscrollbar_char_left : Qscrollbar_char_right;
322       if (toScroll < 0)
323         toScroll = -toScroll;
324       while (toScroll--)
325         mswindows_enqueue_misc_user_event (frame, function, win);
326     }
327
328   return TRUE;
329 }
330
331 #ifdef MEMORY_USAGE_STATS
332
333 static int
334 mswindows_compute_scrollbar_instance_usage (struct device *d,
335                                     struct scrollbar_instance *inst,
336                                     struct overhead_stats *ovstats)
337 {
338   int total = 0;
339
340   while (inst)
341     {
342       struct mswindows_scrollbar_data *data =
343         (struct mswindows_scrollbar_data *) inst->scrollbar_data;
344
345       total += malloced_storage_size (data, sizeof (*data), ovstats);
346       inst = inst->next;
347     }
348
349   return total;
350 }
351
352 #endif /* MEMORY_USAGE_STATS */
353 \f
354 /************************************************************************/
355 /*          Device-specific ghost specifiers initialization             */
356 /************************************************************************/
357
358 DEFUN ("mswindows-init-scrollbar-metrics", Fmswindows_init_scrollbar_metrics, 1, 1, 0, /*
359 */
360        (locale))
361 {
362   if (DEVICEP (locale))
363     {
364       add_spec_to_ghost_specifier (Vscrollbar_width,
365                                    make_int (GetSystemMetrics (SM_CXVSCROLL)),
366                                    locale, Qmswindows, Qnil);
367       add_spec_to_ghost_specifier (Vscrollbar_height,
368                                    make_int (GetSystemMetrics (SM_CYHSCROLL)),
369                                    locale, Qmswindows, Qnil);
370     }
371   return Qnil;
372 }
373
374 \f
375 /************************************************************************/
376 /*                            initialization                            */
377 /************************************************************************/
378
379 void
380 console_type_create_scrollbar_mswindows (void)
381 {
382   CONSOLE_HAS_METHOD (mswindows, create_scrollbar_instance);
383   CONSOLE_HAS_METHOD (mswindows, free_scrollbar_instance);
384   CONSOLE_HAS_METHOD (mswindows, release_scrollbar_instance);
385   CONSOLE_HAS_METHOD (mswindows, update_scrollbar_instance_values);
386   CONSOLE_HAS_METHOD (mswindows, update_scrollbar_instance_status);
387 /*  CONSOLE_HAS_METHOD (mswindows, scrollbar_width_changed_in_frame); */
388 #ifdef MEMORY_USAGE_STATS
389   CONSOLE_HAS_METHOD (mswindows, compute_scrollbar_instance_usage);
390 #endif
391 }
392
393 void
394 syms_of_scrollbar_mswindows(void)
395 {
396   DEFSUBR (Fmswindows_init_scrollbar_metrics);
397 }
398
399 void
400 vars_of_scrollbar_mswindows(void)
401 {
402   Fprovide (intern ("mswindows-scrollbars"));
403 }
404