a6798ee7109c15d8afef29b183bcc5542560b18c
[blender-staging.git] / intern / ghost / intern / GHOST_SystemWin32.h
1 /**
2  * $Id$
3  * ***** BEGIN GPL/BL DUAL 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. The Blender
9  * Foundation also sells licenses for use in proprietary software under
10  * the Blender License.  See http://www.blender.org/BL/ for information
11  * about this.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL/BL DUAL LICENSE BLOCK *****
30  */
31 /**
32  * @file        GHOST_SystemWin32.h
33  * Declaration of GHOST_SystemWin32 class.
34  */
35
36 #ifndef _GHOST_SYSTEM_WIN32_H_
37 #define _GHOST_SYSTEM_WIN32_H_
38
39 #ifndef WIN32
40 #error WIN32 only!
41 #endif // WIN32
42
43 #include <windows.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
58 /**
59  * WIN32 Implementation of GHOST_System class.
60  * @see GHOST_System.
61  * @author      Maarten Gribnau
62  * @date        May 10, 2001
63  */
64 class GHOST_SystemWin32 : public GHOST_System {
65 public:
66         /**
67          * Constructor.
68          */
69         GHOST_SystemWin32();
70
71         /**
72          * Destructor.
73          */
74         virtual ~GHOST_SystemWin32();
75
76         /***************************************************************************************
77          ** Time(r) functionality
78          ***************************************************************************************/
79
80         /**
81          * Returns the system time.
82          * Returns the number of milliseconds since the start of the system process.
83          * This overloaded method uses the high frequency timer if available.
84          * @return The number of milliseconds.
85          */
86         virtual GHOST_TUns64 getMilliSeconds() const;
87
88         /***************************************************************************************
89          ** Display/window management functionality
90          ***************************************************************************************/
91
92         /**
93          * Returns the number of displays on this system.
94          * @return The number of displays.
95          */
96         virtual GHOST_TUns8 getNumDisplays() const;
97
98         /**
99          * Returns the dimensions of the main display on this system.
100          * @return The dimension of the main display.
101          */
102         virtual void getMainDisplayDimensions(GHOST_TUns32& width, GHOST_TUns32& height) const;
103         
104         /**
105          * Create a new window.
106          * The new window is added to the list of windows managed. 
107          * Never explicitly delete the window, use disposeWindow() instead.
108          * @param       title   The name of the window (displayed in the title bar of the window if the OS supports it).
109          * @param       left    The coordinate of the left edge of the window.
110          * @param       top             The coordinate of the top edge of the window.
111          * @param       width   The width the window.
112          * @param       height  The height the window.
113          * @param       state   The state of the window when opened.
114          * @param       type    The type of drawing context installed in this window.
115          * @return      The new window (or 0 if creation failed).
116          */
117         virtual GHOST_IWindow* createWindow(
118                 const STR_String& title,
119                 GHOST_TInt32 left, GHOST_TInt32 top, GHOST_TUns32 width, GHOST_TUns32 height,
120                 GHOST_TWindowState state, GHOST_TDrawingContextType type,
121                 const bool stereoVisual);
122
123         /***************************************************************************************
124          ** Event management functionality
125          ***************************************************************************************/
126
127         /**
128          * Gets events from the system and stores them in the queue.
129          * @param waitForEvent Flag to wait for an event (or return immediately).
130          * @return Indication of the presence of events.
131          */
132         virtual bool processEvents(bool waitForEvent);
133         
134
135         /***************************************************************************************
136          ** Cursor management functionality
137          ***************************************************************************************/
138
139         /**
140          * Returns the current location of the cursor (location in screen coordinates)
141          * @param x                     The x-coordinate of the cursor.
142          * @param y                     The y-coordinate of the cursor.
143          * @return                      Indication of success.
144          */
145         virtual GHOST_TSuccess getCursorPosition(GHOST_TInt32& x, GHOST_TInt32& y) const;
146
147         /**
148          * Updates the 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 setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y) const;
154
155         /***************************************************************************************
156          ** Access to mouse button and keyboard states.
157          ***************************************************************************************/
158
159         /**
160          * Returns the state of all modifier keys.
161          * @param keys  The state of all modifier keys (true == pressed).
162          * @return              Indication of success.
163          */
164         virtual GHOST_TSuccess getModifierKeys(GHOST_ModifierKeys& keys) const;
165
166         /**
167          * Returns the state of the mouse buttons (ouside the message queue).
168          * @param buttons       The state of the buttons.
169          * @return                      Indication of success.
170          */
171         virtual GHOST_TSuccess getButtons(GHOST_Buttons& buttons) const;
172
173 protected:
174         /**
175          * Initializes the system.
176          * For now, it justs registers the window class (WNDCLASS).
177          * @return A success value.
178          */
179         virtual GHOST_TSuccess init();
180
181         /**
182          * Closes the system down.
183          * @return A success value.
184          */
185         virtual GHOST_TSuccess exit();
186         
187         /**
188          * Converts raw WIN32 key codes from the wndproc to GHOST keys.
189          * @param wParam        The wParam from the wndproc
190          * @param lParam        The lParam from the wndproc
191          * @return The GHOST key (GHOST_kKeyUnknown if no match).
192          */
193         virtual GHOST_TKey convertKey(WPARAM wParam, LPARAM lParam) const;
194
195         /**
196          * Creates modifier key event(s) and updates the key data stored locally (m_modifierKeys).
197          * With the modifier keys, we want to distinguish left and right keys.
198          * Sometimes this is not possible (Windows ME for instance). Then, we want
199          * events generated for both keys.
200          * @param window        The window receiving the event (the active window).
201          */
202         void processModifierKeys(GHOST_IWindow *window);
203
204         /**
205          * Creates mouse button event.
206          * @param type          The type of event to create.
207          * @param window        The window receiving the event (the active window).
208          * @param mask          The button mask of this event.
209          * @return The event created.
210          */
211         static GHOST_EventButton* processButtonEvent(GHOST_TEventType type, GHOST_IWindow *window, GHOST_TButtonMask mask);
212
213         /**
214          * Creates cursor event.
215          * @param type          The type of event to create.
216          * @param window        The window receiving the event (the active window).
217          * @return The event created.
218          */
219         static GHOST_EventCursor* processCursorEvent(GHOST_TEventType type, GHOST_IWindow *window);
220
221         /**
222          * Creates a mouse wheel event.
223          * @param window        The window receiving the event (the active window).
224          * @param wParam        The wParam from the wndproc
225          * @param lParam        The lParam from the wndproc
226          */
227         static GHOST_EventWheel* processWheelEvent(GHOST_IWindow *window, WPARAM wParam, LPARAM lParam);
228
229         /**
230          * Creates a key event and updates the key data stored locally (m_modifierKeys).
231          * In most cases this is a straightforward conversion of key codes.
232          * For the modifier keys however, we want to distinguish left and right keys.
233          * @param window        The window receiving the event (the active window).
234          * @param wParam        The wParam from the wndproc
235          * @param lParam        The lParam from the wndproc
236          */
237         static GHOST_EventKey* processKeyEvent(GHOST_IWindow *window, bool keyDown, WPARAM wParam, LPARAM lParam);
238
239         /** 
240          * Creates a window event.
241          * @param type          The type of event to create.
242          * @param window        The window receiving the event (the active window).
243          * @return The event created.
244          */
245         static GHOST_Event* processWindowEvent(GHOST_TEventType type, GHOST_IWindow* window);
246
247         /**
248          * Returns the local state of the modifier keys (from the message queue).
249          * @param keys The state of the keys.
250          */
251         inline virtual void retrieveModifierKeys(GHOST_ModifierKeys& keys) const;
252
253         /**
254          * Stores the state of the modifier keys locally.
255          * For internal use only!
256          * @param keys The new state of the modifier keys.
257          */
258         inline virtual void storeModifierKeys(const GHOST_ModifierKeys& keys);
259
260         /**
261          * Windows call back routine for our window class.
262          */
263         static LRESULT WINAPI s_wndProc(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam);
264
265         /** The current state of the modifier keys. */
266         GHOST_ModifierKeys m_modifierKeys;
267         /** State variable set at initialization. */
268         bool m_hasPerformanceCounter;
269         /** High frequency timer variable. */
270         __int64 m_freq;
271         /** High frequency timer variable. */
272         __int64 m_start;
273         /** Stores the capability of this system to distinguish left and right modifier keys. */
274         bool m_seperateLeftRight;
275         /** Stores the initialization state of the member m_leftRightDistinguishable. */
276         bool m_seperateLeftRightInitialized;
277 };
278
279 inline void GHOST_SystemWin32::retrieveModifierKeys(GHOST_ModifierKeys& keys) const
280 {
281         keys = m_modifierKeys;
282 }
283
284 inline void GHOST_SystemWin32::storeModifierKeys(const GHOST_ModifierKeys& keys)
285 {
286         m_modifierKeys = keys;
287 }
288
289 #endif // _GHOST_SYSTEM_WIN32_H_
290