svn merge -r36603:36628 https://svn.blender.org/svnroot/bf-blender/trunk/blender
[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 #include <windows.h>
42
43 #include "GHOST_System.h"
44
45 #if defined(__CYGWIN32__)
46 #       define __int64 long long
47 #endif
48
49 #ifndef WM_INPUT
50 #define WM_INPUT 0x00FF
51 #endif 
52 #ifndef RID_INPUT
53 #define RID_INPUT 0x10000003
54 #endif
55 #ifndef RI_KEY_BREAK
56 #define RI_KEY_BREAK 0x1
57 #endif
58 #ifndef RI_KEY_E0
59 #define RI_KEY_E0 0x2
60 #endif
61 #ifndef RI_KEY_E1
62 #define RI_KEY_E1 0x4
63 #endif
64 #ifndef RIM_TYPEMOUSE
65 #define RIM_TYPEMOUSE           0x0
66 #define RIM_TYPEKEYBOARD        0x1
67 #define RIM_TYPEHID                     0x2
68
69 typedef struct tagRAWINPUTDEVICE {
70         USHORT usUsagePage;
71         USHORT usUsage;
72         DWORD dwFlags;
73         HWND hwndTarget;
74 } RAWINPUTDEVICE;
75
76
77
78 typedef struct tagRAWINPUTHEADER {
79         DWORD dwType;
80         DWORD dwSize;
81         HANDLE hDevice;
82         WPARAM wParam;
83 } RAWINPUTHEADER;
84
85 typedef struct tagRAWMOUSE {
86         USHORT usFlags;
87         union {
88                 ULONG ulButtons;
89                 struct  {
90                         USHORT  usButtonFlags;
91                         USHORT  usButtonData;
92                 };
93         };
94         ULONG   ulRawButtons;
95         LONG    lLastX;
96         LONG    lLastY;
97         ULONG   ulExtraInformation;
98 } RAWMOUSE;
99
100 typedef struct tagRAWKEYBOARD {
101         USHORT  MakeCode;
102         USHORT  Flags;
103         USHORT  Reserved;
104         USHORT  VKey;
105         UINT    Message;
106         ULONG   ExtraInformation;
107 } RAWKEYBOARD;
108
109 typedef struct tagRAWHID {
110         DWORD   dwSizeHid;
111         DWORD   dwCount;
112         BYTE    bRawData[1];
113 } RAWHID;
114
115 typedef struct tagRAWINPUT {
116         RAWINPUTHEADER header;
117         union {
118                 RAWMOUSE        mouse;
119                 RAWKEYBOARD keyboard;
120                 RAWHID      hid;
121         } data;
122 } RAWINPUT;
123
124 DECLARE_HANDLE(HRAWINPUT);
125 #endif
126
127 #ifdef FREE_WINDOWS
128 #define NEED_RAW_PROC
129 typedef BOOL (WINAPI * LPFNDLLRRID)(RAWINPUTDEVICE*,UINT, UINT);
130
131 typedef UINT (WINAPI * LPFNDLLGRID)(HRAWINPUT, UINT, LPVOID, PUINT, UINT);
132 #define GetRawInputData(hRawInput, uiCommand, pData, pcbSize, cbSizeHeader) ((pGetRawInputData)?pGetRawInputData(hRawInput, uiCommand, pData, pcbSize, cbSizeHeader):(UINT)-1)
133 #endif
134
135 class GHOST_EventButton;
136 class GHOST_EventCursor;
137 class GHOST_EventKey;
138 class GHOST_EventWheel;
139 class GHOST_EventWindow;
140 class GHOST_EventDragnDrop;
141
142 /**
143  * WIN32 Implementation of GHOST_System class.
144  * @see GHOST_System.
145  * @author      Maarten Gribnau
146  * @date        May 10, 2001
147  */
148 class GHOST_SystemWin32 : public GHOST_System {
149 public:
150         /**
151          * Constructor.
152          */
153         GHOST_SystemWin32();
154
155         /**
156          * Destructor.
157          */
158         virtual ~GHOST_SystemWin32();
159
160         /***************************************************************************************
161          ** Time(r) functionality
162          ***************************************************************************************/
163
164         /**
165          * Returns the system time.
166          * Returns the number of milliseconds since the start of the system process.
167          * This overloaded method uses the high frequency timer if available.
168          * @return The number of milliseconds.
169          */
170         virtual GHOST_TUns64 getMilliSeconds() const;
171
172         /***************************************************************************************
173          ** Display/window management functionality
174          ***************************************************************************************/
175
176         /**
177          * Returns the number of displays on this system.
178          * @return The number of displays.
179          */
180         virtual GHOST_TUns8 getNumDisplays() const;
181
182         /**
183          * Returns the dimensions of the main display on this system.
184          * @return The dimension of the main display.
185          */
186         virtual void getMainDisplayDimensions(GHOST_TUns32& width, GHOST_TUns32& height) const;
187         
188         /**
189          * Create a new window.
190          * The new window is added to the list of windows managed. 
191          * Never explicitly delete the window, use disposeWindow() instead.
192          * @param       title   The name of the window (displayed in the title bar of the window if the OS supports it).
193          * @param       left    The coordinate of the left edge of the window.
194          * @param       top             The coordinate of the top edge of the window.
195          * @param       width   The width the window.
196          * @param       height  The height the window.
197          * @param       state   The state of the window when opened.
198          * @param       type    The type of drawing context installed in this window.
199          * @param       stereoVisual    Stereo visual for quad buffered stereo.
200          * @param       numOfAASamples  Number of samples used for AA (zero if no AA)
201          * @param       parentWindow    Parent (embedder) window
202          * @return      The new window (or 0 if creation failed).
203          */
204         virtual GHOST_IWindow* createWindow(
205                 const STR_String& title,
206                 GHOST_TInt32 left, GHOST_TInt32 top, GHOST_TUns32 width, GHOST_TUns32 height,
207                 GHOST_TWindowState state, GHOST_TDrawingContextType type,
208                 const bool stereoVisual = false,
209                 const GHOST_TUns16 numOfAASamples = 0,
210                 const GHOST_TEmbedderWindowID parentWindow = 0 );
211
212         /***************************************************************************************
213          ** Event management functionality
214          ***************************************************************************************/
215
216         /**
217          * Gets events from the system and stores them in the queue.
218          * @param waitForEvent Flag to wait for an event (or return immediately).
219          * @return Indication of the presence of events.
220          */
221         virtual bool processEvents(bool waitForEvent);
222         
223
224         /***************************************************************************************
225          ** Cursor management functionality
226          ***************************************************************************************/
227
228         /**
229          * Returns the current location of the cursor (location in screen coordinates)
230          * @param x                     The x-coordinate of the cursor.
231          * @param y                     The y-coordinate of the cursor.
232          * @return                      Indication of success.
233          */
234         virtual GHOST_TSuccess getCursorPosition(GHOST_TInt32& x, GHOST_TInt32& y) const;
235
236         /**
237          * Updates the location of the cursor (location in screen coordinates).
238          * @param x                     The x-coordinate of the cursor.
239          * @param y                     The y-coordinate of the cursor.
240          * @return                      Indication of success.
241          */
242         virtual GHOST_TSuccess setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y);
243
244         /***************************************************************************************
245          ** Access to mouse button and keyboard states.
246          ***************************************************************************************/
247
248         /**
249          * Returns the state of all modifier keys.
250          * @param keys  The state of all modifier keys (true == pressed).
251          * @return              Indication of success.
252          */
253         virtual GHOST_TSuccess getModifierKeys(GHOST_ModifierKeys& keys) const;
254
255         /**
256          * Returns the state of the mouse buttons (ouside the message queue).
257          * @param buttons       The state of the buttons.
258          * @return                      Indication of success.
259          */
260         virtual GHOST_TSuccess getButtons(GHOST_Buttons& buttons) const;
261
262         /**
263          * Returns unsinged char from CUT_BUFFER0
264          * @param selection             Used by X11 only
265          * @return                              Returns the Clipboard
266          */
267         virtual GHOST_TUns8* getClipboard(bool selection) const;
268         
269         /**
270          * Puts buffer to system clipboard
271          * @param selection             Used by X11 only
272          * @return                              No return
273          */
274         virtual void putClipboard(GHOST_TInt8 *buffer, bool selection) const;
275
276         /**
277          * Creates a drag'n'drop event and pushes it immediately onto the event queue. 
278          * Called by GHOST_DropTargetWin32 class.
279          * @param eventType The type of drag'n'drop event
280          * @param draggedObjectType The type object concerned (currently array of file names, string, ?bitmap)
281          * @param mouseX x mouse coordinate (in window coordinates)
282          * @param mouseY y mouse coordinate
283          * @param window The window on which the event occurred
284          * @return Indication whether the event was handled. 
285          */
286         static GHOST_TSuccess pushDragDropEvent(GHOST_TEventType eventType, GHOST_TDragnDropTypes draggedObjectType,GHOST_IWindow* window, int mouseX, int mouseY, void* data);
287          
288 protected:
289         /**
290          * Initializes the system.
291          * For now, it justs registers the window class (WNDCLASS).
292          * @return A success value.
293          */
294         virtual GHOST_TSuccess init();
295
296         /**
297          * Closes the system down.
298          * @return A success value.
299          */
300         virtual GHOST_TSuccess exit();
301         
302         /**
303          * Converts raw WIN32 key codes from the wndproc to GHOST keys.
304          * @param window->      The window for this handling
305          * @param vKey          The virtual key from hardKey
306          * @param ScanCode      The ScanCode of pressed key (simular to PS/2 Set 1)
307          * @param extend        Flag if key is not primerly (left or right)
308          * @return The GHOST key (GHOST_kKeyUnknown if no match).
309          */
310         virtual GHOST_TKey convertKey(GHOST_IWindow *window, short vKey, short ScanCode, short extend) const;
311
312         /**
313          * Catches raw WIN32 key codes from WM_INPUT in the wndproc.
314          * @param window->      The window for this handling
315          * @param wParam        The wParam from the wndproc
316          * @param lParam        The lParam from the wndproc
317          * @param keyDown       Pointer flag that specify if a key is down
318          * @param vk            Pointer to virtual key
319          * @return The GHOST key (GHOST_kKeyUnknown if no match).
320          */
321         virtual GHOST_TKey hardKey(GHOST_IWindow *window, WPARAM wParam, LPARAM lParam, int * keyDown, char * vk);
322
323         /**
324          * Creates modifier key event(s) and updates the key data stored locally (m_modifierKeys).
325          * With the modifier keys, we want to distinguish left and right keys.
326          * Sometimes this is not possible (Windows ME for instance). Then, we want
327          * events generated for both keys.
328          * @param window        The window receiving the event (the active window).
329          */
330         GHOST_EventKey* processModifierKeys(GHOST_IWindow *window);
331
332         /**
333          * Creates mouse button event.
334          * @param type          The type of event to create.
335          * @param window        The window receiving the event (the active window).
336          * @param mask          The button mask of this event.
337          * @return The event created.
338          */
339         static GHOST_EventButton* processButtonEvent(GHOST_TEventType type, GHOST_IWindow *window, GHOST_TButtonMask mask);
340
341         /**
342          * Creates cursor event.
343          * @param type          The type of event to create.
344          * @param window        The window receiving the event (the active window).
345          * @return The event created.
346          */
347         static GHOST_EventCursor* processCursorEvent(GHOST_TEventType type, GHOST_IWindow *Iwindow);
348
349         /**
350          * Creates a mouse wheel event.
351          * @param window        The window receiving the event (the active window).
352          * @param wParam        The wParam from the wndproc
353          * @param lParam        The lParam from the wndproc
354          */
355         static GHOST_EventWheel* processWheelEvent(GHOST_IWindow *window, WPARAM wParam, LPARAM lParam);
356
357         /**
358          * Creates a key event and updates the key data stored locally (m_modifierKeys).
359          * In most cases this is a straightforward conversion of key codes.
360          * For the modifier keys however, we want to distinguish left and right keys.
361          * @param window        The window receiving the event (the active window).
362          * @param wParam        The wParam from the wndproc
363          * @param lParam        The lParam from the wndproc
364          */
365         static GHOST_EventKey* processKeyEvent(GHOST_IWindow *window, WPARAM wParam, LPARAM lParam);
366
367         /**
368          * Process special keys (VK_OEM_*), to see if current key layout
369          * gives us anything special, like ! on french AZERTY.
370          * @param window        The window receiving the event (the active window).
371          * @param vKey          The virtual key from hardKey
372          * @param ScanCode      The ScanCode of pressed key (simular to PS/2 Set 1)
373          */
374         virtual GHOST_TKey processSpecialKey(GHOST_IWindow *window, short vKey, short scanCode) const;
375
376         /** 
377          * Creates a window event.
378          * @param type          The type of event to create.
379          * @param window        The window receiving the event (the active window).
380          * @return The event created.
381          */
382         static GHOST_Event* processWindowEvent(GHOST_TEventType type, GHOST_IWindow* window);
383         /** 
384          * Handles minimum window size.
385          * @param minmax        The MINMAXINFO structure.
386          */
387         static void processMinMaxInfo(MINMAXINFO * minmax);
388         
389         /**
390          * Returns the local state of the modifier keys (from the message queue).
391          * @param keys The state of the keys.
392          */
393         inline virtual void retrieveModifierKeys(GHOST_ModifierKeys& keys) const;
394
395         /**
396          * Stores the state of the modifier keys locally.
397          * For internal use only!
398          * @param keys The new state of the modifier keys.
399          */
400         inline virtual void storeModifierKeys(const GHOST_ModifierKeys& keys);
401         
402         /**
403          * Check current key layout for AltGr
404          */
405         inline virtual void handleKeyboardChange(void);
406
407         /**
408          * Windows call back routine for our window class.
409          */
410         static LRESULT WINAPI s_wndProc(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam);
411
412         /**
413          * Initiates WM_INPUT messages from keyboard 
414          */
415         GHOST_TInt32 initKeyboardRawInput(void);
416
417         /**
418  * Toggles console
419  * @action      0 - Hides
420  *                      1 - Shows
421  *                      2 - Toggles
422  *                      3 - Hides if it runs not from  command line
423  *                      * - Does nothing
424  * @return current status (1 -visible, 0 - hidden)
425  */
426         int toggleConsole(int action);
427         
428         /** The current state of the modifier keys. */
429         GHOST_ModifierKeys m_modifierKeys;
430         /** State variable set at initialization. */
431         bool m_hasPerformanceCounter;
432         /** High frequency timer variable. */
433         __int64 m_freq;
434         /** High frequency timer variable. */
435         __int64 m_start;
436         /** AltGr on current keyboard layout. */
437         bool m_hasAltGr;
438         /** language identifier. */
439         WORD m_langId;
440         /** stores keyboard layout. */
441         HKL m_keylayout;
442
443         /** Console status */
444         int m_consoleStatus;
445
446         /** handle for user32.dll*/
447         HMODULE user32;
448         #ifdef NEED_RAW_PROC
449         /* pointer to RegisterRawInputDevices function */
450         LPFNDLLRRID pRegisterRawInputDevices;
451         /* pointer to GetRawInputData function */
452         LPFNDLLGRID pGetRawInputData;
453         #endif
454 };
455
456 inline void GHOST_SystemWin32::retrieveModifierKeys(GHOST_ModifierKeys& keys) const
457 {
458         keys = m_modifierKeys;
459 }
460
461 inline void GHOST_SystemWin32::storeModifierKeys(const GHOST_ModifierKeys& keys)
462 {
463         m_modifierKeys = keys;
464 }
465
466 inline void GHOST_SystemWin32::handleKeyboardChange(void)
467 {
468         m_keylayout = GetKeyboardLayout(0); // get keylayout for current thread
469         int i;
470         SHORT s;
471
472         // save the language identifier.
473         m_langId = LOWORD(m_keylayout);
474
475         for(m_hasAltGr = false, i = 32; i < 256; ++i) {
476                 s = VkKeyScanEx((char)i, m_keylayout);
477                 // s == -1 means no key that translates passed char code
478                 // high byte contains shift state. bit 2 ctrl pressed, bit 4 alt pressed
479                 // if both are pressed, we have AltGr keycombo on keylayout
480                 if(s!=-1 && (s & 0x600) == 0x600) {
481                         m_hasAltGr = true;
482                         break;
483                 }
484         }
485 }
486 #endif // _GHOST_SYSTEM_WIN32_H_
487