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