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