merge with/from trunk at r35190
[blender.git] / intern / ghost / intern / GHOST_System.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_System.h
30  *  \ingroup GHOST
31  * Declaration of GHOST_System class.
32  */
33
34 #ifndef _GHOST_SYSTEM_H_
35 #define _GHOST_SYSTEM_H_
36
37 #include "GHOST_ISystem.h"
38
39 #include "GHOST_Debug.h"
40 #include "GHOST_Buttons.h"
41 #include "GHOST_ModifierKeys.h"
42 #include "GHOST_EventManager.h"
43 #ifdef GHOST_DEBUG
44 #include "GHOST_EventPrinter.h"
45 #endif // GHOST_DEBUG
46
47 class GHOST_DisplayManager;
48 class GHOST_Event;
49 class GHOST_TimerManager;
50 class GHOST_Window;
51 class GHOST_WindowManager;
52 class GHOST_NDOFManager;
53
54 /**
55  * Implementation of platform independent functionality of the GHOST_ISystem
56  * interface.
57  * GHOST_System is an abstract class because not all methods of GHOST_ISystem
58  * are implemented.
59  * @see GHOST_ISystem.
60  * @author      Maarten Gribnau
61  * @date        May 7, 2001
62  */
63 class GHOST_System : public GHOST_ISystem
64 {
65 protected:
66         /**
67          * Constructor.
68          * Protected default constructor to force use of static createSystem member.
69          */
70         GHOST_System();
71
72         /**
73          * Destructor.
74          * Protected default constructor to force use of static dispose member.
75          */
76         virtual ~GHOST_System();
77
78 public:
79         /***************************************************************************************
80          ** Time(r) functionality
81          ***************************************************************************************/
82
83         /**
84          * Returns the system time.
85          * Returns the number of milliseconds since the start of the system process.
86          * Based on ANSI clock() routine.
87          * @return The number of milliseconds.
88          */
89         virtual GHOST_TUns64 getMilliSeconds() const;
90
91         /**
92          * Installs a timer.
93          * Note that, on most operating systems, messages need to be processed in order 
94          * for the timer callbacks to be invoked.
95          * @param delay         The time to wait for the first call to the timerProc (in milliseconds)
96          * @param interval      The interval between calls to the timerProc
97          * @param timerProc     The callback invoked when the interval expires,
98          * @param userData      Placeholder for user data.
99          * @return A timer task (0 if timer task installation failed).
100          */
101         virtual GHOST_ITimerTask* installTimer(GHOST_TUns64 delay, GHOST_TUns64 interval, GHOST_TimerProcPtr timerProc, GHOST_TUserDataPtr userData = 0);
102
103         /**
104          * Removes a timer.
105          * @param timerTask Timer task to be removed.
106          * @return Indication of success.
107          */
108         virtual GHOST_TSuccess removeTimer(GHOST_ITimerTask* timerTask);
109
110         /***************************************************************************************
111          ** Display/window management functionality
112          ***************************************************************************************/
113         
114         /**
115          * Inherited from GHOST_ISystem but left pure virtual
116          *
117          * virtual      GHOST_TUns8 getNumDisplays() const = 0;
118          * virtual void getMainDisplayDimensions(...) const = 0;
119          * virtual GHOST_IWindow* createWindow(..)
120          */
121
122         /**
123          * Dispose a window.
124          * @param       window Pointer to the window to be disposed.
125          * @return      Indication of success.
126          */
127         virtual GHOST_TSuccess disposeWindow(GHOST_IWindow* window);
128
129         /**
130          * Returns whether a window is valid.
131          * @param       window Pointer to the window to be checked.
132          * @return      Indication of validity.
133          */
134         virtual bool validWindow(GHOST_IWindow* window);
135
136         /**
137          * Begins full screen mode.
138          * @param setting       The new setting of the display.
139          * @param window        Window displayed in full screen.
140          * @param stereoVisual  Stereo visual for quad buffered stereo.
141          * This window is invalid after full screen has been ended.
142          * @return      Indication of success.
143          */
144         virtual GHOST_TSuccess beginFullScreen(const GHOST_DisplaySetting& setting, GHOST_IWindow** window,
145                 const bool stereoVisual);
146
147         /**
148          * Ends full screen mode.
149          * @return      Indication of success.
150          */
151         virtual GHOST_TSuccess endFullScreen(void);
152
153         /**
154          * Returns current full screen mode status.
155          * @return The current status.
156          */
157         virtual bool getFullScreen(void);
158
159
160         /***************************************************************************************
161          ** Event management functionality
162          ***************************************************************************************/
163
164         /**
165          * Inherited from GHOST_ISystem but left pure virtual
166          *
167          *      virtual bool processEvents(bool waitForEvent) = 0;
168          */
169
170
171
172         /**
173          * Dispatches all the events on the stack.
174          * The event stack will be empty afterwards.
175          * @return Indication as to whether any of the consumers handled the events.
176          */
177         virtual bool dispatchEvents();
178
179         /**
180          * Adds the given event consumer to our list.
181          * @param consumer The event consumer to add.
182          * @return Indication of success.
183          */
184         virtual GHOST_TSuccess addEventConsumer(GHOST_IEventConsumer* consumer);
185
186
187
188         /***************************************************************************************
189          ** N-degree of freedom devcice management functionality
190          ***************************************************************************************/
191
192         /** Inherited from GHOST_ISystem
193      *  Opens the N-degree of freedom device manager
194          * return 0 if device found, 1 otherwise
195      */
196     virtual int openNDOF(GHOST_IWindow* w,        
197         GHOST_NDOFLibraryInit_fp setNdofLibraryInit, 
198         GHOST_NDOFLibraryShutdown_fp setNdofLibraryShutdown,
199         GHOST_NDOFDeviceOpen_fp setNdofDeviceOpen);
200         
201 // original patch only        
202 //        GHOST_NDOFEventHandler_fp setNdofEventHandler);
203
204
205
206
207         /***************************************************************************************
208          ** Cursor management functionality
209          ***************************************************************************************/
210
211         /** Inherited from GHOST_ISystem but left pure virtual
212          *      GHOST_TSuccess getCursorPosition(GHOST_TInt32& x, GHOST_TInt32& y) const = 0;   
213          *  GHOST_TSuccess setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y)
214          */
215
216         /***************************************************************************************
217          ** Access to mouse button and keyboard states.
218          ***************************************************************************************/
219
220         /**
221          * Returns the state of a modifier key (ouside the message queue).
222          * @param mask          The modifier key state to retrieve.
223          * @param isDown        The state of a modifier key (true == pressed).
224          * @return                      Indication of success.
225          */
226         virtual GHOST_TSuccess getModifierKeyState(GHOST_TModifierKeyMask mask, bool& isDown) const;
227
228         /**
229          * Returns the state of a mouse button (ouside the message queue).
230          * @param mask          The button state to retrieve.
231          * @param isDown        Button state.
232          * @return                      Indication of success.
233          */
234         virtual GHOST_TSuccess getButtonState(GHOST_TButtonMask mask, bool& isDown) const;
235         
236         /***************************************************************************************
237          ** Other (internal) functionality.
238          ***************************************************************************************/
239
240         virtual GHOST_TSuccess beginRecord(FILE *file);
241         virtual GHOST_TSuccess endRecord();
242         virtual GHOST_TSuccess playbackEvents(FILE *file);
243         
244         virtual bool playingEvents(bool *hasevent) const;
245         virtual bool recordingEvents();
246         
247         /**
248          * Pushes an event on the stack.
249          * To dispatch it, call dispatchEvent() or dispatchEvents().
250          * Do not delete the event!
251          * @param event The event to push on the stack.
252          */
253         virtual GHOST_TSuccess pushEvent(GHOST_IEvent* event);
254
255         /**
256          * Returns the timer manager.
257          * @return The timer manager.
258          */
259         inline virtual GHOST_TimerManager* getTimerManager() const;
260
261         /**
262          * Returns a pointer to our event manager.
263          * @return A pointer to our event manager.
264          */
265         virtual inline GHOST_EventManager* getEventManager() const;
266
267         /**
268          * Returns a pointer to our window manager.
269          * @return A pointer to our window manager.
270          */
271         virtual inline GHOST_WindowManager* getWindowManager() const;
272
273         /**
274          * Returns a pointer to our n-degree of freedeom manager.
275          * @return A pointer to our n-degree of freedeom manager.
276          */
277         virtual inline GHOST_NDOFManager* getNDOFManager() const;
278
279         /**
280          * Returns the state of all modifier keys.
281          * @param keys  The state of all modifier keys (true == pressed).
282          * @return              Indication of success.
283          */
284         virtual GHOST_TSuccess getModifierKeys(GHOST_ModifierKeys& keys) const = 0;
285
286         /**
287          * Returns the state of the mouse buttons (ouside the message queue).
288          * @param buttons       The state of the buttons.
289          * @return                      Indication of success.
290          */
291         virtual GHOST_TSuccess getButtons(GHOST_Buttons& buttons) const = 0;
292
293         /**
294          * Returns the selection buffer
295          * @param selection             Only used on X11
296          * @return                              Returns the clipboard data
297          *
298          */
299          virtual GHOST_TUns8* getClipboard(bool selection) const = 0;
300           
301           /**
302            * Put data to the Clipboard
303            * @param buffer              The buffer to copy to the clipboard
304            * @param selection   The clipboard to copy too only used on X11
305            */
306           virtual void putClipboard(GHOST_TInt8 *buffer, bool selection) const = 0;
307
308         
309 protected:
310         /**
311          * Initialize the system.
312          * @return Indication of success.
313          */
314         virtual GHOST_TSuccess init();
315
316         /**
317          * Shut the system down.
318          * @return Indication of success.
319          */
320         virtual GHOST_TSuccess exit();
321
322         /**
323          * Creates a fullscreen window.
324          * @param window The window created.
325          * @return Indication of success.
326          */
327         virtual GHOST_TSuccess createFullScreenWindow(GHOST_Window** window,
328                 const bool stereoVisual);
329
330         /** The display manager (platform dependant). */
331         GHOST_DisplayManager* m_displayManager;
332
333         /** The timer manager. */
334         GHOST_TimerManager* m_timerManager;
335
336         /** The window manager. */
337         GHOST_WindowManager* m_windowManager;
338
339         /** The event manager. */
340         GHOST_EventManager* m_eventManager;
341
342     /** The N-degree of freedom device manager */
343     GHOST_NDOFManager* m_ndofManager;
344         
345         /** Prints all the events. */
346 #ifdef GHOST_DEBUG
347         GHOST_EventPrinter* m_eventPrinter;
348 #endif // GHOST_DEBUG
349
350         /** Settings of the display before the display went fullscreen. */
351         GHOST_DisplaySetting m_preFullScreenSetting;
352 };
353
354 inline GHOST_TimerManager* GHOST_System::getTimerManager() const
355 {
356         return m_timerManager;
357 }
358
359 inline GHOST_EventManager* GHOST_System::getEventManager() const
360 {
361         return m_eventManager;
362 }
363
364 inline GHOST_WindowManager* GHOST_System::getWindowManager() const
365 {
366         return m_windowManager;
367 }
368
369 inline GHOST_NDOFManager* GHOST_System::getNDOFManager() const
370 {
371         return m_ndofManager;
372 }
373
374 #endif // _GHOST_SYSTEM_H_
375