merged 29285:30707 from trunk
[blender.git] / intern / ghost / intern / GHOST_SystemWin32.h
1 /**
2  * $Id$
3  * ***** BEGIN GPL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software Foundation,
17  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18  *
19  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
20  * All rights reserved.
21  *
22  * The Original Code is: all of this file.
23  *
24  * Contributor(s): none yet.
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28 /**
29  * @file        GHOST_SystemWin32.h
30  * Declaration of GHOST_SystemWin32 class.
31  */
32
33 #ifndef _GHOST_SYSTEM_WIN32_H_
34 #define _GHOST_SYSTEM_WIN32_H_
35
36 #ifndef WIN32
37 #error WIN32 only!
38 #endif // WIN32
39
40 #define _WIN32_WINNT 0x501 // require Windows XP or newer
41 #define WIN32_LEAN_AND_MEAN
42 #include <windows.h>
43 #include <ole2.h>
44
45 #include "GHOST_System.h"
46
47 #if defined(__CYGWIN32__)
48 #       define __int64 long long
49 #endif
50
51
52 class GHOST_EventButton;
53 class GHOST_EventCursor;
54 class GHOST_EventKey;
55 class GHOST_EventWheel;
56 class GHOST_EventWindow;
57 class GHOST_EventDragnDrop;
58
59 class GHOST_WindowWin32;
60
61 /**
62  * WIN32 Implementation of GHOST_System class.
63  * @see GHOST_System.
64  * @author      Maarten Gribnau
65  * @date        May 10, 2001
66  */
67 class GHOST_SystemWin32 : public GHOST_System {
68 public:
69         /**
70          * Constructor.
71          */
72         GHOST_SystemWin32();
73
74         /**
75          * Destructor.
76          */
77         virtual ~GHOST_SystemWin32();
78
79         /***************************************************************************************
80          ** Time(r) functionality
81          ***************************************************************************************/
82
83         /**
84          * Returns the system time.
85          * Returns the number of milliseconds since the start of the system process.
86          * This overloaded method uses the high frequency timer if available.
87          * @return The number of milliseconds.
88          */
89         virtual GHOST_TUns64 getMilliSeconds() const;
90
91         /***************************************************************************************
92          ** Display/window management functionality
93          ***************************************************************************************/
94
95         /**
96          * Returns the number of displays on this system.
97          * @return The number of displays.
98          */
99         virtual GHOST_TUns8 getNumDisplays() const;
100
101         /**
102          * Returns the dimensions of the main display on this system.
103          * @return The dimension of the main display.
104          */
105         virtual void getMainDisplayDimensions(GHOST_TUns32& width, GHOST_TUns32& height) const;
106         
107         /**
108          * Create a new window.
109          * The new window is added to the list of windows managed. 
110          * Never explicitly delete the window, use disposeWindow() instead.
111          * @param       title   The name of the window (displayed in the title bar of the window if the OS supports it).
112          * @param       left    The coordinate of the left edge of the window.
113          * @param       top             The coordinate of the top edge of the window.
114          * @param       width   The width the window.
115          * @param       height  The height the window.
116          * @param       state   The state of the window when opened.
117          * @param       type    The type of drawing context installed in this window.
118          * @param       stereoVisual    Stereo visual for quad buffered stereo.
119          * @param       numOfAASamples  Number of samples used for AA (zero if no AA)
120          * @param       parentWindow    Parent (embedder) window
121          * @return      The new window (or 0 if creation failed).
122          */
123         virtual GHOST_IWindow* createWindow(
124                 const STR_String& title,
125                 GHOST_TInt32 left, GHOST_TInt32 top, GHOST_TUns32 width, GHOST_TUns32 height,
126                 GHOST_TWindowState state, GHOST_TDrawingContextType type,
127                 const bool stereoVisual = false,
128                 const GHOST_TUns16 numOfAASamples = 0,
129                 const GHOST_TEmbedderWindowID parentWindow = 0 );
130
131         /***************************************************************************************
132          ** Event management functionality
133          ***************************************************************************************/
134
135         /**
136          * Gets events from the system and stores them in the queue.
137          * @param waitForEvent Flag to wait for an event (or return immediately).
138          * @return Indication of the presence of events.
139          */
140         virtual bool processEvents(bool waitForEvent);
141         
142
143         /***************************************************************************************
144          ** Cursor management functionality
145          ***************************************************************************************/
146
147         /**
148          * Returns the current location of the cursor (location in screen coordinates)
149          * @param x                     The x-coordinate of the cursor.
150          * @param y                     The y-coordinate of the cursor.
151          * @return                      Indication of success.
152          */
153         virtual GHOST_TSuccess getCursorPosition(GHOST_TInt32& x, GHOST_TInt32& y) const;
154
155         /**
156          * Updates the location of the cursor (location in screen coordinates).
157          * @param x                     The x-coordinate of the cursor.
158          * @param y                     The y-coordinate of the cursor.
159          * @return                      Indication of success.
160          */
161         virtual GHOST_TSuccess setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y);
162
163         /***************************************************************************************
164          ** Access to mouse button and keyboard states.
165          ***************************************************************************************/
166
167         /**
168          * Returns the state of all modifier keys.
169          * @param keys  The state of all modifier keys (true == pressed).
170          * @return              Indication of success.
171          */
172         virtual GHOST_TSuccess getModifierKeys(GHOST_ModifierKeys& keys) const;
173
174         /**
175          * Returns the state of the mouse buttons (ouside the message queue).
176          * @param buttons       The state of the buttons.
177          * @return                      Indication of success.
178          */
179         virtual GHOST_TSuccess getButtons(GHOST_Buttons& buttons) const;
180
181         /**
182          * Returns unsinged char from CUT_BUFFER0
183          * @param selection             Used by X11 only
184          * @return                              Returns the Clipboard
185          */
186         virtual GHOST_TUns8* getClipboard(bool selection) const;
187         
188         /**
189          * Puts buffer to system clipboard
190          * @param selection             Used by X11 only
191          * @return                              No return
192          */
193         virtual void putClipboard(GHOST_TInt8 *buffer, bool selection) const;
194
195         /**
196          * Determine the base dir in which shared resources are located. It will first try to use
197          * "unpack and run" path, then look for properly installed path, not including versioning.
198          * @return Unsigned char string pointing to system dir (eg /usr/share/).
199          */
200         virtual const GHOST_TUns8* getSystemDir() const;
201
202         /**
203          * Determine the base dir in which user configuration is stored, not including versioning.
204          * If needed, it will create the base directory.
205          * @return Unsigned char string pointing to user dir (eg ~/).
206          */
207          virtual const GHOST_TUns8* getUserDir() const;
208
209          /**
210           * Determine the directory of the current binary
211           * @return Unsigned char string pointing to the binary dir
212           */
213          virtual const GHOST_TUns8* getBinaryDir() const;
214
215         /**
216          * Creates a drag'n'drop event and pushes it immediately onto the event queue. 
217          * Called by GHOST_DropTargetWin32 class.
218          * @param eventType The type of drag'n'drop event
219          * @param draggedObjectType The type object concerned (currently array of file names, string, ?bitmap)
220          * @param mouseX x mouse coordinate (in window coordinates)
221          * @param mouseY y mouse coordinate
222          * @param window The window on which the event occurred
223          * @return Indication whether the event was handled. 
224          */
225         static GHOST_TSuccess pushDragDropEvent(GHOST_TEventType eventType, GHOST_TDragnDropTypes draggedObjectType,GHOST_IWindow* window, int mouseX, int mouseY, void* data);
226          
227 protected:
228         /**
229          * Initializes the system.
230          * For now, it justs registers the window class (WNDCLASS).
231          * @return A success value.
232          */
233         virtual GHOST_TSuccess init();
234
235         /**
236          * Closes the system down.
237          * @return A success value.
238          */
239         virtual GHOST_TSuccess exit();
240         
241         /**
242          * Converts raw WIN32 key codes from the wndproc to GHOST keys.
243          * @param wParam        The wParam from the wndproc
244          * @param lParam        The lParam from the wndproc
245          * @return The GHOST key (GHOST_kKeyUnknown if no match).
246          */
247         virtual GHOST_TKey convertKey(WPARAM wParam, LPARAM lParam) const;
248
249         /**
250          * Creates modifier key event(s) and updates the key data stored locally (m_modifierKeys).
251          * With the modifier keys, we want to distinguish left and right keys.
252          * Sometimes this is not possible (Windows ME for instance). Then, we want
253          * events generated for both keys.
254          * @param window        The window receiving the event (the active window).
255          */
256         void processModifierKeys(GHOST_IWindow *window);
257
258         /**
259          * Creates mouse button event.
260          * @param type          The type of event to create.
261          * @param window        The window receiving the event (the active window).
262          * @param mask          The button mask of this event.
263          * @return The event created.
264          */
265         static GHOST_EventButton* processButtonEvent(GHOST_TEventType type, GHOST_IWindow *window, GHOST_TButtonMask mask);
266
267         /**
268          * Creates cursor event.
269          * @param type          The type of event to create.
270          * @param window        The window receiving the event (the active window).
271          * @param x,y           Cursor position.
272          * @return The event created.
273          */
274         static GHOST_EventCursor* processCursorEvent(GHOST_TEventType type, GHOST_IWindow *Iwindow, int x, int y);
275
276         /**
277          * Creates a mouse wheel event.
278          * @param window        The window receiving the event (the active window).
279          * @param wParam        The wParam from the wndproc
280          * @param lParam        The lParam from the wndproc
281          */
282         static GHOST_EventWheel* processWheelEvent(GHOST_IWindow *window, WPARAM wParam, LPARAM lParam);
283
284         /**
285          * Creates a key event and updates the key data stored locally (m_modifierKeys).
286          * In most cases this is a straightforward conversion of key codes.
287          * For the modifier keys however, we want to distinguish left and right keys.
288          * @param window        The window receiving the event (the active window).
289          * @param wParam        The wParam from the wndproc
290          * @param lParam        The lParam from the wndproc
291          */
292         static GHOST_EventKey* processKeyEvent(GHOST_IWindow *window, bool keyDown, WPARAM wParam, LPARAM lParam);
293
294         /** 
295          * Creates a window event.
296          * @param type          The type of event to create.
297          * @param window        The window receiving the event (the active window).
298          * @return The event created.
299          */
300         static GHOST_Event* processWindowEvent(GHOST_TEventType type, GHOST_IWindow* window);
301
302         /**
303          * Handles minimum window size.
304          * @param minmax        The MINMAXINFO structure.
305          */
306         static void processMinMaxInfo(MINMAXINFO * minmax);
307
308         /**
309          * Creates and sends mouse or multi-axis events.
310          * @param raw           a single RawInput structure
311          * @param window        The window receiving the event (the active window).
312          * @return Whether any events (possibly more than one) were created and sent.
313          */
314         bool processRawInput(RAWINPUT const& raw, GHOST_WindowWin32* window);
315
316         /**
317          * Creates and sends mouse events for mouse movements "in between" WM_MOUSEMOVEs.
318          * @param Latest        screen coords from latest WM_MOUSEMOVE
319          * @param Prev          screen coords from previous WM_MOUSEMOVE
320          * @param window        The window receiving the event (the active window).
321          * @return How many events (possibly many) were created and sent.
322          */
323         int getMoreMousePoints(int xLatest, int yLatest, int xPrev, int yPrev, GHOST_WindowWin32* window);
324
325         /**
326          * Returns the local state of the modifier keys (from the message queue).
327          * @param keys The state of the keys.
328          */
329         inline virtual void retrieveModifierKeys(GHOST_ModifierKeys& keys) const;
330
331         /**
332          * Stores the state of the modifier keys locally.
333          * For internal use only!
334          * @param keys The new state of the modifier keys.
335          */
336         inline virtual void storeModifierKeys(const GHOST_ModifierKeys& keys);
337
338         /**
339          * Windows call back routine for our window class.
340          * This handles general errors, then passes control to handleEvent.
341          */
342         static LRESULT WINAPI s_wndProc(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam);
343
344         /** Non-static version of WndProc. */
345         bool handleEvent(GHOST_WindowWin32* window, UINT msg, WPARAM wParam, LPARAM lParam);
346
347         /** The current state of the modifier keys. */
348         GHOST_ModifierKeys m_modifierKeys;
349         /** State variable set at initialization. */
350         bool m_hasPerformanceCounter;
351         /** High frequency timer variable. */
352         __int64 m_freq;
353         /** High frequency timer variable. */
354         __int64 m_start;
355         /** Stores the capability of this system to distinguish left and right modifier keys. */
356         bool m_separateLeftRight;
357         /** Stores the initialization state of the member m_leftRightDistinguishable. */
358         bool m_separateLeftRightInitialized;
359         
360 };
361
362 inline void GHOST_SystemWin32::retrieveModifierKeys(GHOST_ModifierKeys& keys) const
363 {
364         keys = m_modifierKeys;
365 }
366
367 inline void GHOST_SystemWin32::storeModifierKeys(const GHOST_ModifierKeys& keys)
368 {
369         m_modifierKeys = keys;
370 }
371
372 #endif // _GHOST_SYSTEM_WIN32_H_
373