9d48c5c7cdced0676a13dbf978eddc6ada7422d2
[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  * @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_EventWindow;
56
57 /**
58  * WIN32 Implementation of GHOST_System class.
59  * @see GHOST_System.
60  * @author      Maarten Gribnau
61  * @date        May 10, 2001
62  */
63 class GHOST_SystemWin32 : public GHOST_System {
64 public:
65         /**
66          * Constructor.
67          */
68         GHOST_SystemWin32();
69
70         /**
71          * Destructor.
72          */
73         virtual ~GHOST_SystemWin32();
74
75         /***************************************************************************************
76          ** Time(r) functionality
77          ***************************************************************************************/
78
79         /**
80          * Returns the system time.
81          * Returns the number of milliseconds since the start of the system process.
82          * This overloaded method uses the high frequency timer if available.
83          * @return The number of milliseconds.
84          */
85         virtual GHOST_TUns64 getMilliSeconds() const;
86
87         /***************************************************************************************
88          ** Display/window management functionality
89          ***************************************************************************************/
90
91         /**
92          * Returns the number of displays on this system.
93          * @return The number of displays.
94          */
95         virtual GHOST_TUns8 getNumDisplays() const;
96
97         /**
98          * Returns the dimensions of the main display on this system.
99          * @return The dimension of the main display.
100          */
101         virtual void getMainDisplayDimensions(GHOST_TUns32& width, GHOST_TUns32& height) const;
102         
103         /**
104          * Create a new window.
105          * The new window is added to the list of windows managed. 
106          * Never explicitly delete the window, use disposeWindow() instead.
107          * @param       title   The name of the window (displayed in the title bar of the window if the OS supports it).
108          * @param       left    The coordinate of the left edge of the window.
109          * @param       top             The coordinate of the top edge of the window.
110          * @param       width   The width the window.
111          * @param       height  The height the window.
112          * @param       state   The state of the window when opened.
113          * @param       type    The type of drawing context installed in this window.
114          * @return      The new window (or 0 if creation failed).
115          */
116         virtual GHOST_IWindow* createWindow(
117                 const STR_String& title,
118                 GHOST_TInt32 left, GHOST_TInt32 top, GHOST_TUns32 width, GHOST_TUns32 height,
119                 GHOST_TWindowState state, GHOST_TDrawingContextType type,
120                 const bool stereoVisual);
121
122         /***************************************************************************************
123          ** Event management functionality
124          ***************************************************************************************/
125
126         /**
127          * Gets events from the system and stores them in the queue.
128          * @param waitForEvent Flag to wait for an event (or return immediately).
129          * @return Indication of the presence of events.
130          */
131         virtual bool processEvents(bool waitForEvent);
132         
133
134         /***************************************************************************************
135          ** Cursor management functionality
136          ***************************************************************************************/
137
138         /**
139          * Returns the current location of the cursor (location in screen coordinates)
140          * @param x                     The x-coordinate of the cursor.
141          * @param y                     The y-coordinate of the cursor.
142          * @return                      Indication of success.
143          */
144         virtual GHOST_TSuccess getCursorPosition(GHOST_TInt32& x, GHOST_TInt32& y) const;
145
146         /**
147          * Updates the location of the cursor (location in screen coordinates).
148          * @param x                     The x-coordinate of the cursor.
149          * @param y                     The y-coordinate of the cursor.
150          * @return                      Indication of success.
151          */
152         virtual GHOST_TSuccess setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y) const;
153
154         /***************************************************************************************
155          ** Access to mouse button and keyboard states.
156          ***************************************************************************************/
157
158         /**
159          * Returns the state of all modifier keys.
160          * @param keys  The state of all modifier keys (true == pressed).
161          * @return              Indication of success.
162          */
163         virtual GHOST_TSuccess getModifierKeys(GHOST_ModifierKeys& keys) const;
164
165         /**
166          * Returns the state of the mouse buttons (ouside the message queue).
167          * @param buttons       The state of the buttons.
168          * @return                      Indication of success.
169          */
170         virtual GHOST_TSuccess getButtons(GHOST_Buttons& buttons) const;
171
172 protected:
173         /**
174          * Initializes the system.
175          * For now, it justs registers the window class (WNDCLASS).
176          * @return A success value.
177          */
178         virtual GHOST_TSuccess init();
179
180         /**
181          * Closes the system down.
182          * @return A success value.
183          */
184         virtual GHOST_TSuccess exit();
185         
186         /**
187          * Converts raw WIN32 key codes from the wndproc to GHOST keys.
188          * @param wParam        The wParam from the wndproc
189          * @param lParam        The lParam from the wndproc
190          * @return The GHOST key (GHOST_kKeyUnknown if no match).
191          */
192         virtual GHOST_TKey convertKey(WPARAM wParam, LPARAM lParam) const;
193
194         /**
195          * Creates modifier key event(s) and updates the key data stored locally (m_modifierKeys).
196          * With the modifier keys, we want to distinguish left and right keys.
197          * Sometimes this is not possible (Windows ME for instance). Then, we want
198          * events generated for both keys.
199          */
200         void processModifierKeys(GHOST_IWindow *window);
201
202         /**
203          * Creates mouse button event.
204          * @param type  The type of event to create.
205          * @param type  The button mask of this event.
206          * @return The event created.
207          */
208         static GHOST_EventButton* processButtonEvent(GHOST_TEventType type, GHOST_IWindow *window, GHOST_TButtonMask mask);
209
210         /**
211          * Creates cursor event.
212          * @param type  The type of event to create.
213          * @return The event created.
214          */
215         static GHOST_EventCursor* processCursorEvent(GHOST_TEventType type, GHOST_IWindow *window);
216
217         /**
218          * Creates a key event and updates the key data stored locally (m_modifierKeys).
219          * In most cases this is a straightforward conversion of key codes.
220          * For the modifier keys however, we want to distinguish left and right keys.
221          */
222         static GHOST_EventKey* processKeyEvent(GHOST_IWindow *window, bool keyDown, WPARAM wParam, LPARAM lParam);
223
224         /** 
225          * Creates a window event.
226          * @param type          The type of event to create.
227          * @param window        The window receiving the event.
228          * @return The event created.
229          */
230         static GHOST_Event* processWindowEvent(GHOST_TEventType type, GHOST_IWindow* window);
231
232         /**
233          * Returns the local state of the modifier keys (from the message queue).
234          * @param keys The state of the keys.
235          */
236         inline virtual void retrieveModifierKeys(GHOST_ModifierKeys& keys) const;
237
238         /**
239          * Stores the state of the modifier keys locally.
240          * For internal use only!
241          * @param keys The new state of the modifier keys.
242          */
243         inline virtual void storeModifierKeys(const GHOST_ModifierKeys& keys);
244
245         /**
246          * Windows call back routine for our window class.
247          */
248         static LRESULT WINAPI s_wndProc(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam);
249
250         /** The current state of the modifier keys. */
251         GHOST_ModifierKeys m_modifierKeys;
252         /** State variable set at initialization. */
253         bool m_hasPerformanceCounter;
254         /** High frequency timer variable. */
255         __int64 m_freq;
256         /** High frequency timer variable. */
257         __int64 m_start;
258         /** Stores the capability of this system to distinguish left and right modifier keys. */
259         bool m_seperateLeftRight;
260         /** Stores the initialization state of the member m_leftRightDistinguishable. */
261         bool m_seperateLeftRightInitialized;
262 };
263
264 inline void GHOST_SystemWin32::retrieveModifierKeys(GHOST_ModifierKeys& keys) const
265 {
266         keys = m_modifierKeys;
267 }
268
269 inline void GHOST_SystemWin32::storeModifierKeys(const GHOST_ModifierKeys& keys)
270 {
271         m_modifierKeys = keys;
272 }
273
274 #endif // _GHOST_SYSTEM_WIN32_H_
275