1b7b2aad76665e68ccda093745d3137a340dd3f1
[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_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 class GHOST_EventDragnDrop;
55
56 /**
57  * WIN32 Implementation of GHOST_System class.
58  * @see GHOST_System.
59  * @author      Maarten Gribnau
60  * @date        May 10, 2001
61  */
62 class GHOST_SystemWin32 : public GHOST_System {
63 public:
64         /**
65          * Constructor.
66          */
67         GHOST_SystemWin32();
68
69         /**
70          * Destructor.
71          */
72         virtual ~GHOST_SystemWin32();
73
74         /***************************************************************************************
75          ** Time(r) functionality
76          ***************************************************************************************/
77
78         /**
79          * Returns the system time.
80          * Returns the number of milliseconds since the start of the system process.
81          * This overloaded method uses the high frequency timer if available.
82          * @return The number of milliseconds.
83          */
84         virtual GHOST_TUns64 getMilliSeconds() const;
85
86         /***************************************************************************************
87          ** Display/window management functionality
88          ***************************************************************************************/
89
90         /**
91          * Returns the number of displays on this system.
92          * @return The number of displays.
93          */
94         virtual GHOST_TUns8 getNumDisplays() const;
95
96         /**
97          * Returns the dimensions of the main display on this system.
98          * @return The dimension of the main display.
99          */
100         virtual void getMainDisplayDimensions(GHOST_TUns32& width, GHOST_TUns32& height) const;
101         
102         /**
103          * Create a new window.
104          * The new window is added to the list of windows managed. 
105          * Never explicitly delete the window, use disposeWindow() instead.
106          * @param       title   The name of the window (displayed in the title bar of the window if the OS supports it).
107          * @param       left    The coordinate of the left edge of the window.
108          * @param       top             The coordinate of the top edge of the window.
109          * @param       width   The width the window.
110          * @param       height  The height the window.
111          * @param       state   The state of the window when opened.
112          * @param       type    The type of drawing context installed in this window.
113          * @param       stereoVisual    Stereo visual for quad buffered stereo.
114          * @param       numOfAASamples  Number of samples used for AA (zero if no AA)
115          * @param       parentWindow    Parent (embedder) window
116          * @return      The new window (or 0 if creation failed).
117          */
118         virtual GHOST_IWindow* createWindow(
119                 const STR_String& title,
120                 GHOST_TInt32 left, GHOST_TInt32 top, GHOST_TUns32 width, GHOST_TUns32 height,
121                 GHOST_TWindowState state, GHOST_TDrawingContextType type,
122                 const bool stereoVisual = false,
123                 const GHOST_TUns16 numOfAASamples = 0,
124                 const GHOST_TEmbedderWindowID parentWindow = 0 );
125
126         /***************************************************************************************
127          ** Event management functionality
128          ***************************************************************************************/
129
130         /**
131          * Gets events from the system and stores them in the queue.
132          * @param waitForEvent Flag to wait for an event (or return immediately).
133          * @return Indication of the presence of events.
134          */
135         virtual bool processEvents(bool waitForEvent);
136         
137
138         /***************************************************************************************
139          ** Cursor management functionality
140          ***************************************************************************************/
141
142         /**
143          * Returns the current location of the cursor (location in screen coordinates)
144          * @param x                     The x-coordinate of the cursor.
145          * @param y                     The y-coordinate of the cursor.
146          * @return                      Indication of success.
147          */
148         virtual GHOST_TSuccess getCursorPosition(GHOST_TInt32& x, GHOST_TInt32& y) const;
149
150         /**
151          * Updates the location of the cursor (location in screen coordinates).
152          * @param x                     The x-coordinate of the cursor.
153          * @param y                     The y-coordinate of the cursor.
154          * @return                      Indication of success.
155          */
156         virtual GHOST_TSuccess setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y) const;
157
158         /***************************************************************************************
159          ** Access to mouse button and keyboard states.
160          ***************************************************************************************/
161
162         /**
163          * Returns the state of all modifier keys.
164          * @param keys  The state of all modifier keys (true == pressed).
165          * @return              Indication of success.
166          */
167         virtual GHOST_TSuccess getModifierKeys(GHOST_ModifierKeys& keys) const;
168
169         /**
170          * Returns the state of the mouse buttons (ouside the message queue).
171          * @param buttons       The state of the buttons.
172          * @return                      Indication of success.
173          */
174         virtual GHOST_TSuccess getButtons(GHOST_Buttons& buttons) const;
175
176         /**
177          * Returns unsinged char from CUT_BUFFER0
178          * @param selection             Used by X11 only
179          * @return                              Returns the Clipboard
180          */
181         virtual GHOST_TUns8* getClipboard(bool selection) const;
182         
183         /**
184          * Puts buffer to system clipboard
185          * @param selection             Used by X11 only
186          * @return                              No return
187          */
188         virtual void putClipboard(GHOST_TInt8 *buffer, bool selection) const;
189         
190
191         /**
192          * Determine the base dir in which shared resources are located. It will first try to use
193          * "unpack and run" path, then look for properly installed path, not including versioning.
194          * @return Unsigned char string pointing to system dir (eg /usr/share/blender/).
195          */
196         GHOST_TUns8* getSystemDir() const;
197
198         /**
199          * Determine the base dir in which user configuration is stored, not including versioning.
200          * If needed, it will create the base directory.
201          * @return Unsigned char string pointing to user dir (eg ~/.blender/).
202          */
203          GHOST_TUns8* getUserDir() const;
204
205         /**
206          * Creates a drag'n'drop event and pushes it immediately onto the event queue. 
207          * Called by GHOST_DropTargetWin32 class.
208          * @param eventType The type of drag'n'drop event
209          * @param draggedObjectType The type object concerned (currently array of file names, string, ?bitmap)
210          * @param mouseX x mouse coordinate (in window coordinates)
211          * @param mouseY y mouse coordinate
212          * @param window The window on which the event occured
213          * @return Indication whether the event was handled. 
214          */
215         static GHOST_TSuccess pushDragDropEvent(GHOST_TEventType eventType, GHOST_TDragnDropTypes draggedObjectType,GHOST_IWindow* window, int mouseX, int mouseY, void* data);
216          
217 protected:
218         /**
219          * Initializes the system.
220          * For now, it justs registers the window class (WNDCLASS).
221          * @return A success value.
222          */
223         virtual GHOST_TSuccess init();
224
225         /**
226          * Closes the system down.
227          * @return A success value.
228          */
229         virtual GHOST_TSuccess exit();
230         
231         /**
232          * Converts raw WIN32 key codes from the wndproc to GHOST keys.
233          * @param wParam        The wParam from the wndproc
234          * @param lParam        The lParam from the wndproc
235          * @return The GHOST key (GHOST_kKeyUnknown if no match).
236          */
237         virtual GHOST_TKey convertKey(WPARAM wParam, LPARAM lParam) const;
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         void 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 wParam        The wParam from the wndproc
279          * @param lParam        The lParam from the wndproc
280          */
281         static GHOST_EventKey* processKeyEvent(GHOST_IWindow *window, bool keyDown, WPARAM wParam, LPARAM lParam);
282
283         /** 
284          * Creates a window event.
285          * @param type          The type of event to create.
286          * @param window        The window receiving the event (the active window).
287          * @return The event created.
288          */
289         static GHOST_Event* processWindowEvent(GHOST_TEventType type, GHOST_IWindow* window);
290         /** 
291          * Handles minimum window size.
292          * @param minmax        The MINMAXINFO structure.
293          */
294         static void processMinMaxInfo(MINMAXINFO * minmax);
295         
296         /**
297          * Returns the local state of the modifier keys (from the message queue).
298          * @param keys The state of the keys.
299          */
300         inline virtual void retrieveModifierKeys(GHOST_ModifierKeys& keys) const;
301
302         /**
303          * Stores the state of the modifier keys locally.
304          * For internal use only!
305          * @param keys The new state of the modifier keys.
306          */
307         inline virtual void storeModifierKeys(const GHOST_ModifierKeys& keys);
308
309         /**
310          * Windows call back routine for our window class.
311          */
312         static LRESULT WINAPI s_wndProc(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam);
313
314         /** The current state of the modifier keys. */
315         GHOST_ModifierKeys m_modifierKeys;
316         /** State variable set at initialization. */
317         bool m_hasPerformanceCounter;
318         /** High frequency timer variable. */
319         __int64 m_freq;
320         /** High frequency timer variable. */
321         __int64 m_start;
322         /** Stores the capability of this system to distinguish left and right modifier keys. */
323         bool m_separateLeftRight;
324         /** Stores the initialization state of the member m_leftRightDistinguishable. */
325         bool m_separateLeftRightInitialized;
326         
327 };
328
329 inline void GHOST_SystemWin32::retrieveModifierKeys(GHOST_ModifierKeys& keys) const
330 {
331         keys = m_modifierKeys;
332 }
333
334 inline void GHOST_SystemWin32::storeModifierKeys(const GHOST_ModifierKeys& keys)
335 {
336         m_modifierKeys = keys;
337 }
338
339 #endif // _GHOST_SYSTEM_WIN32_H_
340