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