Apply patch [#20145] Ghost Win32 roundup patch: Minimum Window Size, Continuous Grab...
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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       parentWindow    Parent (embedder) window
114          * @return      The new window (or 0 if creation failed).
115          */
116         virtual GHOST_IWindow* createWindow(
117                 const STR_String& title,
118                 GHOST_TInt32 left, GHOST_TInt32 top, GHOST_TUns32 width, GHOST_TUns32 height,
119                 GHOST_TWindowState state, GHOST_TDrawingContextType type,
120                 const bool stereoVisual, const GHOST_TEmbedderWindowID parentWindow = 0 );
121
122         /***************************************************************************************
123          ** Event management functionality
124          ***************************************************************************************/
125
126         /**
127          * Gets events from the system and stores them in the queue.
128          * @param waitForEvent Flag to wait for an event (or return immediately).
129          * @return Indication of the presence of events.
130          */
131         virtual bool processEvents(bool waitForEvent);
132         
133
134         /***************************************************************************************
135          ** Cursor management functionality
136          ***************************************************************************************/
137
138         /**
139          * Returns the current location of the cursor (location in screen coordinates)
140          * @param x                     The x-coordinate of the cursor.
141          * @param y                     The y-coordinate of the cursor.
142          * @return                      Indication of success.
143          */
144         virtual GHOST_TSuccess getCursorPosition(GHOST_TInt32& x, GHOST_TInt32& y) const;
145
146         /**
147          * Updates the location of the cursor (location in screen coordinates).
148          * @param x                     The x-coordinate of the cursor.
149          * @param y                     The y-coordinate of the cursor.
150          * @return                      Indication of success.
151          */
152         virtual GHOST_TSuccess setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y) const;
153
154         /***************************************************************************************
155          ** Access to mouse button and keyboard states.
156          ***************************************************************************************/
157
158         /**
159          * Returns the state of all modifier keys.
160          * @param keys  The state of all modifier keys (true == pressed).
161          * @return              Indication of success.
162          */
163         virtual GHOST_TSuccess getModifierKeys(GHOST_ModifierKeys& keys) const;
164
165         /**
166          * Returns the state of the mouse buttons (ouside the message queue).
167          * @param buttons       The state of the buttons.
168          * @return                      Indication of success.
169          */
170         virtual GHOST_TSuccess getButtons(GHOST_Buttons& buttons) const;
171
172         /**
173          * Returns unsinged char from CUT_BUFFER0
174          * @param selection             Used by X11 only
175          * @return                              Returns the Clipboard
176          */
177         virtual GHOST_TUns8* getClipboard(bool selection) const;
178         
179         /**
180          * Puts buffer to system clipboard
181          * @param selection             Used by X11 only
182          * @return                              No return
183          */
184         virtual void putClipboard(GHOST_TInt8 *buffer, bool selection) const;
185         
186         /**
187          * Creates a drag'n'drop event and pushes it immediately onto the event queue. 
188          * Called by GHOST_DropTargetWin32 class.
189          * @param eventType The type of drag'n'drop event
190          * @param draggedObjectType The type object concerned (currently array of file names, string, ?bitmap)
191          * @param mouseX x mouse coordinate (in window coordinates)
192          * @param mouseY y mouse coordinate
193          * @param window The window on which the event occured
194          * @return Indication whether the event was handled. 
195          */
196         static GHOST_TSuccess pushDragDropEvent(GHOST_TEventType eventType, GHOST_TDragnDropTypes draggedObjectType,GHOST_IWindow* window, int mouseX, int mouseY, void* data);
197          
198 protected:
199         /**
200          * Initializes the system.
201          * For now, it justs registers the window class (WNDCLASS).
202          * @return A success value.
203          */
204         virtual GHOST_TSuccess init();
205
206         /**
207          * Closes the system down.
208          * @return A success value.
209          */
210         virtual GHOST_TSuccess exit();
211         
212         /**
213          * Converts raw WIN32 key codes from the wndproc to GHOST keys.
214          * @param wParam        The wParam from the wndproc
215          * @param lParam        The lParam from the wndproc
216          * @return The GHOST key (GHOST_kKeyUnknown if no match).
217          */
218         virtual GHOST_TKey convertKey(WPARAM wParam, LPARAM lParam) const;
219
220         /**
221          * Creates modifier key event(s) and updates the key data stored locally (m_modifierKeys).
222          * With the modifier keys, we want to distinguish left and right keys.
223          * Sometimes this is not possible (Windows ME for instance). Then, we want
224          * events generated for both keys.
225          * @param window        The window receiving the event (the active window).
226          */
227         void processModifierKeys(GHOST_IWindow *window);
228
229         /**
230          * Creates mouse button event.
231          * @param type          The type of event to create.
232          * @param window        The window receiving the event (the active window).
233          * @param mask          The button mask of this event.
234          * @return The event created.
235          */
236         static GHOST_EventButton* processButtonEvent(GHOST_TEventType type, GHOST_IWindow *window, GHOST_TButtonMask mask);
237
238         /**
239          * Creates cursor event.
240          * @param type          The type of event to create.
241          * @param window        The window receiving the event (the active window).
242          * @return The event created.
243          */
244         static GHOST_EventCursor* processCursorEvent(GHOST_TEventType type, GHOST_IWindow *Iwindow);
245
246         /**
247          * Creates a mouse wheel event.
248          * @param window        The window receiving the event (the active window).
249          * @param wParam        The wParam from the wndproc
250          * @param lParam        The lParam from the wndproc
251          */
252         static GHOST_EventWheel* processWheelEvent(GHOST_IWindow *window, WPARAM wParam, LPARAM lParam);
253
254         /**
255          * Creates a key event and updates the key data stored locally (m_modifierKeys).
256          * In most cases this is a straightforward conversion of key codes.
257          * For the modifier keys however, we want to distinguish left and right keys.
258          * @param window        The window receiving the event (the active window).
259          * @param wParam        The wParam from the wndproc
260          * @param lParam        The lParam from the wndproc
261          */
262         static GHOST_EventKey* processKeyEvent(GHOST_IWindow *window, bool keyDown, WPARAM wParam, LPARAM lParam);
263
264         /** 
265          * Creates a window event.
266          * @param type          The type of event to create.
267          * @param window        The window receiving the event (the active window).
268          * @return The event created.
269          */
270         static GHOST_Event* processWindowEvent(GHOST_TEventType type, GHOST_IWindow* window);
271         /** 
272          * Handles minimum window size.
273          * @param minmax        The MINMAXINFO structure.
274          */
275         static void processMinMaxInfo(MINMAXINFO * minmax);
276         
277         /**
278          * Returns the local state of the modifier keys (from the message queue).
279          * @param keys The state of the keys.
280          */
281         inline virtual void retrieveModifierKeys(GHOST_ModifierKeys& keys) const;
282
283         /**
284          * Stores the state of the modifier keys locally.
285          * For internal use only!
286          * @param keys The new state of the modifier keys.
287          */
288         inline virtual void storeModifierKeys(const GHOST_ModifierKeys& keys);
289
290         /**
291          * Windows call back routine for our window class.
292          */
293         static LRESULT WINAPI s_wndProc(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam);
294
295         /** The current state of the modifier keys. */
296         GHOST_ModifierKeys m_modifierKeys;
297         /** State variable set at initialization. */
298         bool m_hasPerformanceCounter;
299         /** High frequency timer variable. */
300         __int64 m_freq;
301         /** High frequency timer variable. */
302         __int64 m_start;
303         /** Stores the capability of this system to distinguish left and right modifier keys. */
304         bool m_separateLeftRight;
305         /** Stores the initialization state of the member m_leftRightDistinguishable. */
306         bool m_separateLeftRightInitialized;
307         
308 };
309
310 inline void GHOST_SystemWin32::retrieveModifierKeys(GHOST_ModifierKeys& keys) const
311 {
312         keys = m_modifierKeys;
313 }
314
315 inline void GHOST_SystemWin32::storeModifierKeys(const GHOST_ModifierKeys& keys)
316 {
317         m_modifierKeys = keys;
318 }
319
320 #endif // _GHOST_SYSTEM_WIN32_H_
321