Initial revision
[blender.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 /**
33
34  * $Id$
35  * Copyright (C) 2001 NaN Technologies B.V.
36  * @author      Maarten Gribnau
37  * @date        May 10, 2001
38  */
39
40 #ifndef _GHOST_SYSTEM_WIN32_H_
41 #define _GHOST_SYSTEM_WIN32_H_
42
43 #ifndef WIN32
44 #error WIN32 only!
45 #endif // WIN32
46
47 #include "GHOST_System.h"
48
49 #include <windows.h>
50
51 #if defined(__CYGWIN32__)
52 #       define __int64 long long
53 #endif
54
55
56 class GHOST_EventButton;
57 class GHOST_EventCursor;
58 class GHOST_EventKey;
59 class GHOST_EventWindow;
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          * @return      The new window (or 0 if creation failed).
119          */
120         virtual GHOST_IWindow* createWindow(
121                 const STR_String& title,
122                 GHOST_TInt32 left, GHOST_TInt32 top, GHOST_TUns32 width, GHOST_TUns32 height,
123                 GHOST_TWindowState state, GHOST_TDrawingContextType type,
124                 const bool stereoVisual);
125
126         /***************************************************************************************
127          ** Event management functionality
128          ***************************************************************************************/
129
130         /**
131          * Gets events from the system and stores them in the queue.
132          * @param waitForEvent Flag to wait for an event (or return immediately).
133          * @return Indication of the presence of events.
134          */
135         virtual bool processEvents(bool waitForEvent);
136         
137
138         /***************************************************************************************
139          ** Cursor management functionality
140          ***************************************************************************************/
141
142         /**
143          * Returns the current location of the cursor (location in screen coordinates)
144          * @param x                     The x-coordinate of the cursor.
145          * @param y                     The y-coordinate of the cursor.
146          * @return                      Indication of success.
147          */
148         virtual GHOST_TSuccess getCursorPosition(GHOST_TInt32& x, GHOST_TInt32& y) const;
149
150         /**
151          * Updates the location of the cursor (location in screen coordinates).
152          * @param x                     The x-coordinate of the cursor.
153          * @param y                     The y-coordinate of the cursor.
154          * @return                      Indication of success.
155          */
156         virtual GHOST_TSuccess setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y) const;
157
158         /***************************************************************************************
159          ** Access to mouse button and keyboard states.
160          ***************************************************************************************/
161
162         /**
163          * Returns the state of all modifier keys.
164          * @param keys  The state of all modifier keys (true == pressed).
165          * @return              Indication of success.
166          */
167         virtual GHOST_TSuccess getModifierKeys(GHOST_ModifierKeys& keys) const;
168
169         /**
170          * Returns the state of the mouse buttons (ouside the message queue).
171          * @param buttons       The state of the buttons.
172          * @return                      Indication of success.
173          */
174         virtual GHOST_TSuccess getButtons(GHOST_Buttons& buttons) const;
175
176 protected:
177         /**
178          * Initializes the system.
179          * For now, it justs registers the window class (WNDCLASS).
180          * @return A success value.
181          */
182         virtual GHOST_TSuccess init();
183
184         /**
185          * Closes the system down.
186          * @return A success value.
187          */
188         virtual GHOST_TSuccess exit();
189         
190         /**
191          * Converts raw WIN32 key codes from the wndproc to GHOST keys.
192          * @param wParam        The wParam from the wndproc
193          * @param lParam        The lParam from the wndproc
194          * @return The GHOST key (GHOST_kKeyUnknown if no match).
195          */
196         virtual GHOST_TKey convertKey(WPARAM wParam, LPARAM lParam) const;
197
198         /**
199          * Creates modifier key event(s) and updates the key data stored locally (m_modifierKeys).
200          * With the modifier keys, we want to distinguish left and right keys.
201          * Sometimes this is not possible (Windows ME for instance). Then, we want
202          * events generated for both keys.
203          */
204         void processModifierKeys(GHOST_IWindow *window);
205
206         /**
207          * Creates mouse button event.
208          * @param type  The type of event to create.
209          * @param type  The button mask of this event.
210          * @return The event created.
211          */
212         static GHOST_EventButton* processButtonEvent(GHOST_TEventType type, GHOST_IWindow *window, GHOST_TButtonMask mask);
213
214         /**
215          * Creates cursor event.
216          * @param type  The type of event to create.
217          * @return The event created.
218          */
219         static GHOST_EventCursor* processCursorEvent(GHOST_TEventType type, GHOST_IWindow *window);
220
221         /**
222          * Creates a key event and updates the key data stored locally (m_modifierKeys).
223          * In most cases this is a straightforward conversion of key codes.
224          * For the modifier keys however, we want to distinguish left and right keys.
225          */
226         static GHOST_EventKey* processKeyEvent(GHOST_IWindow *window, bool keyDown, WPARAM wParam, LPARAM lParam);
227
228         /** 
229          * Creates a window event.
230          * @param type          The type of event to create.
231          * @param window        The window receiving the event.
232          * @return The event created.
233          */
234         static GHOST_Event* processWindowEvent(GHOST_TEventType type, GHOST_IWindow* window);
235
236         /**
237          * Returns the local state of the modifier keys (from the message queue).
238          * @param keys The state of the keys.
239          */
240         inline virtual void retrieveModifierKeys(GHOST_ModifierKeys& keys) const;
241
242         /**
243          * Stores the state of the modifier keys locally.
244          * For internal use only!
245          * @param keys The new state of the modifier keys.
246          */
247         inline virtual void storeModifierKeys(const GHOST_ModifierKeys& keys);
248
249         /**
250          * Windows call back routine for our window class.
251          */
252         static LRESULT WINAPI s_wndProc(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam);
253
254         /** The current state of the modifier keys. */
255         GHOST_ModifierKeys m_modifierKeys;
256         /** State variable set at initialization. */
257         bool m_hasPerformanceCounter;
258         /** High frequency timer variable. */
259         __int64 m_freq;
260         /** High frequency timer variable. */
261         __int64 m_start;
262         /** Stores the capability of this system to distinguish left and right modifier keys. */
263         bool m_seperateLeftRight;
264         /** Stores the initialization state of the member m_leftRightDistinguishable. */
265         bool m_seperateLeftRightInitialized;
266 };
267
268 inline void GHOST_SystemWin32::retrieveModifierKeys(GHOST_ModifierKeys& keys) const
269 {
270         keys = m_modifierKeys;
271 }
272
273 inline void GHOST_SystemWin32::storeModifierKeys(const GHOST_ModifierKeys& keys)
274 {
275         m_modifierKeys = keys;
276 }
277
278 #endif // _GHOST_SYSTEM_WIN32_H_