Added Copy and Paste functions to GHOST.
[blender-staging.git] / intern / ghost / intern / GHOST_SystemWin32.h
1 /**
2  * $Id$
3  * ***** BEGIN GPL/BL DUAL 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. The Blender
9  * Foundation also sells licenses for use in proprietary software under
10  * the Blender License.  See http://www.blender.org/BL/ for information
11  * about this.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL/BL DUAL LICENSE BLOCK *****
30  */
31 /**
32  * @file        GHOST_SystemWin32.h
33  * Declaration of GHOST_SystemWin32 class.
34  */
35
36 #ifndef _GHOST_SYSTEM_WIN32_H_
37 #define _GHOST_SYSTEM_WIN32_H_
38
39 #ifndef WIN32
40 #error WIN32 only!
41 #endif // WIN32
42
43 #include <windows.h>
44
45 #include "GHOST_System.h"
46
47 #if defined(__CYGWIN32__)
48 #       define __int64 long long
49 #endif
50
51
52 class GHOST_EventButton;
53 class GHOST_EventCursor;
54 class GHOST_EventKey;
55 class GHOST_EventWheel;
56 class GHOST_EventWindow;
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          * @return      The new window (or 0 if creation failed).
116          */
117         virtual GHOST_IWindow* createWindow(
118                 const STR_String& title,
119                 GHOST_TInt32 left, GHOST_TInt32 top, GHOST_TUns32 width, GHOST_TUns32 height,
120                 GHOST_TWindowState state, GHOST_TDrawingContextType type,
121                 const bool stereoVisual);
122
123         /***************************************************************************************
124          ** Event management functionality
125          ***************************************************************************************/
126
127         /**
128          * Gets events from the system and stores them in the queue.
129          * @param waitForEvent Flag to wait for an event (or return immediately).
130          * @return Indication of the presence of events.
131          */
132         virtual bool processEvents(bool waitForEvent);
133         
134
135         /***************************************************************************************
136          ** Cursor management functionality
137          ***************************************************************************************/
138
139         /**
140          * Returns the current location of the cursor (location in screen coordinates)
141          * @param x                     The x-coordinate of the cursor.
142          * @param y                     The y-coordinate of the cursor.
143          * @return                      Indication of success.
144          */
145         virtual GHOST_TSuccess getCursorPosition(GHOST_TInt32& x, GHOST_TInt32& y) const;
146
147         /**
148          * Updates the location of the cursor (location in screen coordinates).
149          * @param x                     The x-coordinate of the cursor.
150          * @param y                     The y-coordinate of the cursor.
151          * @return                      Indication of success.
152          */
153         virtual GHOST_TSuccess setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y) const;
154
155         /***************************************************************************************
156          ** Access to mouse button and keyboard states.
157          ***************************************************************************************/
158
159         /**
160          * Returns the state of all modifier keys.
161          * @param keys  The state of all modifier keys (true == pressed).
162          * @return              Indication of success.
163          */
164         virtual GHOST_TSuccess getModifierKeys(GHOST_ModifierKeys& keys) const;
165
166         /**
167          * Returns the state of the mouse buttons (ouside the message queue).
168          * @param buttons       The state of the buttons.
169          * @return                      Indication of success.
170          */
171         virtual GHOST_TSuccess getButtons(GHOST_Buttons& buttons) const;
172
173         /**
174          * Returns unsinged char from CUT_BUFFER0
175          * @param flag          Flag is not used on win32 on used on X11
176          * @return              Returns the Clipboard
177          */
178         virtual GHOST_TUns8* getClipboard(int flag) const;
179         
180         /**
181          * Puts buffer to system clipboard
182          * @param flag          Flag is not used on win32 on used on X11
183          * @return              No return
184          */
185         virtual void putClipboard(GHOST_TInt8 *buffer, int flag) const;
186          
187 protected:
188         /**
189          * Initializes the system.
190          * For now, it justs registers the window class (WNDCLASS).
191          * @return A success value.
192          */
193         virtual GHOST_TSuccess init();
194
195         /**
196          * Closes the system down.
197          * @return A success value.
198          */
199         virtual GHOST_TSuccess exit();
200         
201         /**
202          * Converts raw WIN32 key codes from the wndproc to GHOST keys.
203          * @param wParam        The wParam from the wndproc
204          * @param lParam        The lParam from the wndproc
205          * @return The GHOST key (GHOST_kKeyUnknown if no match).
206          */
207         virtual GHOST_TKey convertKey(WPARAM wParam, LPARAM lParam) const;
208
209         /**
210          * Creates modifier key event(s) and updates the key data stored locally (m_modifierKeys).
211          * With the modifier keys, we want to distinguish left and right keys.
212          * Sometimes this is not possible (Windows ME for instance). Then, we want
213          * events generated for both keys.
214          * @param window        The window receiving the event (the active window).
215          */
216         void processModifierKeys(GHOST_IWindow *window);
217
218         /**
219          * Creates mouse button event.
220          * @param type          The type of event to create.
221          * @param window        The window receiving the event (the active window).
222          * @param mask          The button mask of this event.
223          * @return The event created.
224          */
225         static GHOST_EventButton* processButtonEvent(GHOST_TEventType type, GHOST_IWindow *window, GHOST_TButtonMask mask);
226
227         /**
228          * Creates cursor event.
229          * @param type          The type of event to create.
230          * @param window        The window receiving the event (the active window).
231          * @return The event created.
232          */
233         static GHOST_EventCursor* processCursorEvent(GHOST_TEventType type, GHOST_IWindow *window);
234
235         /**
236          * Creates a mouse wheel event.
237          * @param window        The window receiving the event (the active window).
238          * @param wParam        The wParam from the wndproc
239          * @param lParam        The lParam from the wndproc
240          */
241         static GHOST_EventWheel* processWheelEvent(GHOST_IWindow *window, WPARAM wParam, LPARAM lParam);
242
243         /**
244          * Creates a key event and updates the key data stored locally (m_modifierKeys).
245          * In most cases this is a straightforward conversion of key codes.
246          * For the modifier keys however, we want to distinguish left and right keys.
247          * @param window        The window receiving the event (the active window).
248          * @param wParam        The wParam from the wndproc
249          * @param lParam        The lParam from the wndproc
250          */
251         static GHOST_EventKey* processKeyEvent(GHOST_IWindow *window, bool keyDown, WPARAM wParam, LPARAM lParam);
252
253         /** 
254          * Creates a window event.
255          * @param type          The type of event to create.
256          * @param window        The window receiving the event (the active window).
257          * @return The event created.
258          */
259         static GHOST_Event* processWindowEvent(GHOST_TEventType type, GHOST_IWindow* window);
260
261         /**
262          * Returns the local state of the modifier keys (from the message queue).
263          * @param keys The state of the keys.
264          */
265         inline virtual void retrieveModifierKeys(GHOST_ModifierKeys& keys) const;
266
267         /**
268          * Stores the state of the modifier keys locally.
269          * For internal use only!
270          * @param keys The new state of the modifier keys.
271          */
272         inline virtual void storeModifierKeys(const GHOST_ModifierKeys& keys);
273
274         /**
275          * Windows call back routine for our window class.
276          */
277         static LRESULT WINAPI s_wndProc(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam);
278
279         /** The current state of the modifier keys. */
280         GHOST_ModifierKeys m_modifierKeys;
281         /** State variable set at initialization. */
282         bool m_hasPerformanceCounter;
283         /** High frequency timer variable. */
284         __int64 m_freq;
285         /** High frequency timer variable. */
286         __int64 m_start;
287         /** Stores the capability of this system to distinguish left and right modifier keys. */
288         bool m_seperateLeftRight;
289         /** Stores the initialization state of the member m_leftRightDistinguishable. */
290         bool m_seperateLeftRightInitialized;
291         
292 };
293
294 inline void GHOST_SystemWin32::retrieveModifierKeys(GHOST_ModifierKeys& keys) const
295 {
296         keys = m_modifierKeys;
297 }
298
299 inline void GHOST_SystemWin32::storeModifierKeys(const GHOST_ModifierKeys& keys)
300 {
301         m_modifierKeys = keys;
302 }
303
304 #endif // _GHOST_SYSTEM_WIN32_H_
305