stricter NDOF guards for Windows (forgot in earlier commit)
[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/intern/GHOST_SystemWin32.h
30  *  \ingroup GHOST
31  * Declaration of GHOST_SystemWin32 class.
32  */
33
34 #ifndef _GHOST_SYSTEM_WIN32_H_
35 #define _GHOST_SYSTEM_WIN32_H_
36
37 #ifndef WIN32
38 #error WIN32 only!
39 #endif // WIN32
40
41 #define _WIN32_WINNT 0x501 // require Windows XP or newer
42 #define WIN32_LEAN_AND_MEAN
43 #include <windows.h>
44 #include <ole2.h> // for drag-n-drop
45
46 #include "GHOST_System.h"
47
48 #if defined(__CYGWIN32__)
49 #       define __int64 long long
50 #endif
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 /**
60  * WIN32 Implementation of GHOST_System class.
61  * @see GHOST_System.
62  * @author      Maarten Gribnau
63  * @date        May 10, 2001
64  */
65 class GHOST_SystemWin32 : public GHOST_System {
66 public:
67         /**
68          * Constructor.
69          */
70         GHOST_SystemWin32();
71
72         /**
73          * Destructor.
74          */
75         virtual ~GHOST_SystemWin32();
76
77         /***************************************************************************************
78          ** Time(r) functionality
79          ***************************************************************************************/
80
81         /**
82          * Returns the system time.
83          * Returns the number of milliseconds since the start of the system process.
84          * This overloaded method uses the high frequency timer if available.
85          * @return The number of milliseconds.
86          */
87         virtual GHOST_TUns64 getMilliSeconds() const;
88
89         /***************************************************************************************
90          ** Display/window management functionality
91          ***************************************************************************************/
92
93         /**
94          * Returns the number of displays on this system.
95          * @return The number of displays.
96          */
97         virtual GHOST_TUns8 getNumDisplays() const;
98
99         /**
100          * Returns the dimensions of the main display on this system.
101          * @return The dimension of the main display.
102          */
103         virtual void getMainDisplayDimensions(GHOST_TUns32& width, GHOST_TUns32& height) const;
104         
105         /**
106          * Create a new window.
107          * The new window is added to the list of windows managed. 
108          * Never explicitly delete the window, use disposeWindow() instead.
109          * @param       title   The name of the window (displayed in the title bar of the window if the OS supports it).
110          * @param       left    The coordinate of the left edge of the window.
111          * @param       top             The coordinate of the top edge of the window.
112          * @param       width   The width the window.
113          * @param       height  The height the window.
114          * @param       state   The state of the window when opened.
115          * @param       type    The type of drawing context installed in this window.
116          * @param       stereoVisual    Stereo visual for quad buffered stereo.
117          * @param       numOfAASamples  Number of samples used for AA (zero if no AA)
118          * @param       parentWindow    Parent (embedder) window
119          * @return      The new window (or 0 if creation failed).
120          */
121         virtual GHOST_IWindow* createWindow(
122                 const STR_String& title,
123                 GHOST_TInt32 left, GHOST_TInt32 top, GHOST_TUns32 width, GHOST_TUns32 height,
124                 GHOST_TWindowState state, GHOST_TDrawingContextType type,
125                 const bool stereoVisual = false,
126                 const GHOST_TUns16 numOfAASamples = 0,
127                 const GHOST_TEmbedderWindowID parentWindow = 0 );
128
129         /***************************************************************************************
130          ** Event management functionality
131          ***************************************************************************************/
132
133         /**
134          * Gets events from the system and stores them in the queue.
135          * @param waitForEvent Flag to wait for an event (or return immediately).
136          * @return Indication of the presence of events.
137          */
138         virtual bool processEvents(bool waitForEvent);
139         
140
141         /***************************************************************************************
142          ** Cursor management functionality
143          ***************************************************************************************/
144
145         /**
146          * Returns the current 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 getCursorPosition(GHOST_TInt32& x, GHOST_TInt32& y) const;
152
153         /**
154          * Updates the location of the cursor (location in screen coordinates).
155          * @param x                     The x-coordinate of the cursor.
156          * @param y                     The y-coordinate of the cursor.
157          * @return                      Indication of success.
158          */
159         virtual GHOST_TSuccess setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y);
160
161         /***************************************************************************************
162          ** Access to mouse button and keyboard states.
163          ***************************************************************************************/
164
165         /**
166          * Returns the state of all modifier keys.
167          * @param keys  The state of all modifier keys (true == pressed).
168          * @return              Indication of success.
169          */
170         virtual GHOST_TSuccess getModifierKeys(GHOST_ModifierKeys& keys) const;
171
172         /**
173          * Returns the state of the mouse buttons (ouside the message queue).
174          * @param buttons       The state of the buttons.
175          * @return                      Indication of success.
176          */
177         virtual GHOST_TSuccess getButtons(GHOST_Buttons& buttons) const;
178
179         /**
180          * Returns unsinged char from CUT_BUFFER0
181          * @param selection             Used by X11 only
182          * @return                              Returns the Clipboard
183          */
184         virtual GHOST_TUns8* getClipboard(bool selection) const;
185         
186         /**
187          * Puts buffer to system clipboard
188          * @param selection             Used by X11 only
189          * @return                              No return
190          */
191         virtual void putClipboard(GHOST_TInt8 *buffer, bool selection) const;
192
193         /**
194          * Creates a drag'n'drop event and pushes it immediately onto the event queue. 
195          * Called by GHOST_DropTargetWin32 class.
196          * @param eventType The type of drag'n'drop event
197          * @param draggedObjectType The type object concerned (currently array of file names, string, ?bitmap)
198          * @param mouseX x mouse coordinate (in window coordinates)
199          * @param mouseY y mouse coordinate
200          * @param window The window on which the event occurred
201          * @return Indication whether the event was handled. 
202          */
203         static GHOST_TSuccess pushDragDropEvent(GHOST_TEventType eventType, GHOST_TDragnDropTypes draggedObjectType,GHOST_IWindow* window, int mouseX, int mouseY, void* data);
204          
205 protected:
206         /**
207          * Initializes the system.
208          * For now, it justs registers the window class (WNDCLASS).
209          * @return A success value.
210          */
211         virtual GHOST_TSuccess init();
212
213         /**
214          * Closes the system down.
215          * @return A success value.
216          */
217         virtual GHOST_TSuccess exit();
218         
219         /**
220          * Converts raw WIN32 key codes from the wndproc to GHOST keys.
221          * @param window->      The window for this handling
222          * @param vKey          The virtual key from hardKey
223          * @param ScanCode      The ScanCode of pressed key (simular to PS/2 Set 1)
224          * @param extend        Flag if key is not primerly (left or right)
225          * @return The GHOST key (GHOST_kKeyUnknown if no match).
226          */
227         virtual GHOST_TKey convertKey(GHOST_IWindow *window, short vKey, short ScanCode, short extend) const;
228
229         /**
230          * Catches raw WIN32 key codes from WM_INPUT in the wndproc.
231          * @param window        The window for this handling
232          * @param raw           RawInput structure with detailed info about the key event
233          * @param keyDown       Pointer flag that specify if a key is down
234          * @param vk            Pointer to virtual key
235          * @return The GHOST key (GHOST_kKeyUnknown if no match).
236          */
237         virtual GHOST_TKey hardKey(GHOST_IWindow *window, RAWINPUT const& raw, int * keyDown, char * vk);
238
239         /**
240          * Creates modifier key event(s) and updates the key data stored locally (m_modifierKeys).
241          * With the modifier keys, we want to distinguish left and right keys.
242          * Sometimes this is not possible (Windows ME for instance). Then, we want
243          * events generated for both keys.
244          * @param window        The window receiving the event (the active window).
245          */
246         GHOST_EventKey* processModifierKeys(GHOST_IWindow *window);
247
248         /**
249          * Creates mouse button event.
250          * @param type          The type of event to create.
251          * @param window        The window receiving the event (the active window).
252          * @param mask          The button mask of this event.
253          * @return The event created.
254          */
255         static GHOST_EventButton* processButtonEvent(GHOST_TEventType type, GHOST_IWindow *window, GHOST_TButtonMask mask);
256
257         /**
258          * Creates cursor event.
259          * @param type          The type of event to create.
260          * @param window        The window receiving the event (the active window).
261          * @return The event created.
262          */
263         static GHOST_EventCursor* processCursorEvent(GHOST_TEventType type, GHOST_IWindow *Iwindow);
264
265         /**
266          * Creates a mouse wheel event.
267          * @param window        The window receiving the event (the active window).
268          * @param wParam        The wParam from the wndproc
269          * @param lParam        The lParam from the wndproc
270          */
271         static GHOST_EventWheel* processWheelEvent(GHOST_IWindow *window, WPARAM wParam, LPARAM lParam);
272
273         /**
274          * Creates a key event and updates the key data stored locally (m_modifierKeys).
275          * In most cases this is a straightforward conversion of key codes.
276          * For the modifier keys however, we want to distinguish left and right keys.
277          * @param window        The window receiving the event (the active window).
278          * @param raw           RawInput structure with detailed info about the key event
279          */
280         static GHOST_EventKey* processKeyEvent(GHOST_IWindow *window, RAWINPUT const& raw);
281
282         /**
283          * Process special keys (VK_OEM_*), to see if current key layout
284          * gives us anything special, like ! on french AZERTY.
285          * @param window        The window receiving the event (the active window).
286          * @param vKey          The virtual key from hardKey
287          * @param ScanCode      The ScanCode of pressed key (simular to PS/2 Set 1)
288          */
289         virtual GHOST_TKey processSpecialKey(GHOST_IWindow *window, short vKey, short scanCode) const;
290
291         /** 
292          * Creates a window event.
293          * @param type          The type of event to create.
294          * @param window        The window receiving the event (the active window).
295          * @return The event created.
296          */
297         static GHOST_Event* processWindowEvent(GHOST_TEventType type, GHOST_IWindow* window);
298
299         /**
300          * Handles minimum window size.
301          * @param minmax        The MINMAXINFO structure.
302          */
303         static void processMinMaxInfo(MINMAXINFO * minmax);
304
305 #ifdef WITH_INPUT_NDOF
306         /**
307          * Handles Motion and Button events from a SpaceNavigator or related device.
308          * Instead of returning an event object, this function communicates directly
309          * with the GHOST_NDOFManager.
310          * @param raw           RawInput structure with detailed info about the NDOF event
311          * @return Whether an event was generated and sent.
312          */
313         bool processNDOF(RAWINPUT const& raw);
314 #endif
315
316         /**
317          * Returns the local state of the modifier keys (from the message queue).
318          * @param keys The state of the keys.
319          */
320         inline virtual void retrieveModifierKeys(GHOST_ModifierKeys& keys) const;
321
322         /**
323          * Stores the state of the modifier keys locally.
324          * For internal use only!
325          * @param keys The new state of the modifier keys.
326          */
327         inline virtual void storeModifierKeys(const GHOST_ModifierKeys& keys);
328         
329         /**
330          * Check current key layout for AltGr
331          */
332         inline virtual void handleKeyboardChange(void);
333
334         /**
335          * Windows call back routine for our window class.
336          */
337         static LRESULT WINAPI s_wndProc(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam);
338
339         /**
340  * Toggles console
341  * @action      0 - Hides
342  *                      1 - Shows
343  *                      2 - Toggles
344  *                      3 - Hides if it runs not from  command line
345  *                      * - Does nothing
346  * @return current status (1 -visible, 0 - hidden)
347  */
348         int toggleConsole(int action);
349         
350         /** The current state of the modifier keys. */
351         GHOST_ModifierKeys m_modifierKeys;
352         /** State variable set at initialization. */
353         bool m_hasPerformanceCounter;
354         /** High frequency timer variable. */
355         __int64 m_freq;
356         /** High frequency timer variable. */
357         __int64 m_start;
358         /** AltGr on current keyboard layout. */
359         bool m_hasAltGr;
360         /** language identifier. */
361         WORD m_langId;
362         /** stores keyboard layout. */
363         HKL m_keylayout;
364
365         /** Console status */
366         int m_consoleStatus;
367 };
368
369 inline void GHOST_SystemWin32::retrieveModifierKeys(GHOST_ModifierKeys& keys) const
370 {
371         keys = m_modifierKeys;
372 }
373
374 inline void GHOST_SystemWin32::storeModifierKeys(const GHOST_ModifierKeys& keys)
375 {
376         m_modifierKeys = keys;
377 }
378
379 inline void GHOST_SystemWin32::handleKeyboardChange(void)
380 {
381         m_keylayout = GetKeyboardLayout(0); // get keylayout for current thread
382         int i;
383         SHORT s;
384
385         // save the language identifier.
386         m_langId = LOWORD(m_keylayout);
387
388         for(m_hasAltGr = false, i = 32; i < 256; ++i) {
389                 s = VkKeyScanEx((char)i, m_keylayout);
390                 // s == -1 means no key that translates passed char code
391                 // high byte contains shift state. bit 2 ctrl pressed, bit 4 alt pressed
392                 // if both are pressed, we have AltGr keycombo on keylayout
393                 if(s!=-1 && (s & 0x600) == 0x600) {
394                         m_hasAltGr = true;
395                         break;
396                 }
397         }
398 }
399 #endif // _GHOST_SYSTEM_WIN32_H_