=bmesh= merge from trunk at r36529
[blender.git] / intern / ghost / GHOST_ISystem.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/GHOST_ISystem.h
30  *  \ingroup GHOST
31  * %Main interface file for C++ Api with declaration of GHOST_ISystem interface
32  * class.
33  * Contains the doxygen documentation main page.
34  */
35
36 #ifndef _GHOST_ISYSTEM_H_
37 #define _GHOST_ISYSTEM_H_
38
39 #include "GHOST_Types.h"
40 #include "GHOST_ITimerTask.h"
41 #include "GHOST_IWindow.h"
42
43 class GHOST_IEventConsumer;
44
45 /**
46  * \page GHOSTPage GHOST
47  *
48  * \section intro Introduction
49  *
50  * GHOST is yet another acronym. It stands for "Generic Handy Operating System
51  * Toolkit". It has been created to replace the OpenGL utility tool kit  
52  * <a href="http://www.opengl.org/developers/documentation/glut.html">GLUT</a>.
53  * GLUT was used in <a href="http://www.blender3d.com">Blender</a> until the
54  * point that Blender needed to be ported to Apple's Mac OSX. Blender needed a
55  * number of modifications in GLUT to work but the GLUT sources for OSX were
56  * unavailable at the time. The decision was made to build our own replacement
57  * for GLUT. In those days, NaN Technologies BV was the company that developed 
58  * Blender. 
59  * <br><br>
60  * Enough history. What does GHOST have to offer?<br>
61  * In short: everything that Blender needed from GLUT to run on all it's supported
62  * operating systems and some extra's.
63  * This includes :
64  * <ul>
65  * <li> Time(r) management.</li>
66  * <li> Display/window management (windows are only created on the main display).
67  * <li> Event management.</li>
68  * <li> Cursor shape management (no custom cursors for now).</li>
69  * <li> Access to the state of the mouse buttons and the keyboard.</li>
70  * <li> Menus for windows with events generated when they are accessed (this is
71  *     work in progress).</li>
72  * </ul>
73  * Font management has been moved to a separate library.
74  *
75  * \section platforms Platforms
76  *
77  * \section Building GHOST
78  *
79  * \section interface Interface
80  * GHOST has two programming interfaces:
81  * <ul>
82  * <li>The C-API. For programs written in C.</li>
83  * <li>The C++-API. For programs written in C++.</li>
84  * </ul>
85  * GHOST itself is writtem in C++ and the C-API is a wrapper around the C++ 
86  * API.
87  *
88  * \subsection cplusplus_api The C++ API consists of the following files:
89  * <ul>
90  * <li>GHOST_IEvent.h</li>
91  * <li>GHOST_IEventConsumer.h</li>
92  * <li>GHOST_ISystem.h</li>
93  * <li>GHOST_ITimerTask.h</li>
94  * <li>GHOST_IWindow.h</li>
95  * <li>GHOST_Rect.h</li>
96  * <li>GHOST_Types.h</li>
97  * </ul>
98  * For an example of using the C++-API, have a look at the GHOST_C-Test.cpp
99  * program in the ?/ghost/test/gears/ directory.
100  *
101  * \subsection c_api The C-API
102  * To use GHOST in programs written in C, include the file GHOST_C-API.h in 
103  * your program. This file includes the GHOST_Types.h file for all GHOST types
104  * and defines functions that give you access to the same functionality present
105  * in the C++ API.<br>
106  * For an example of using the C-API, have a look at the GHOST_C-Test.c program
107  * in the ?/ghost/test/gears/ directory.
108  *
109  * \section work Work in progress
110  * \todo write WIP section
111  */
112  
113 /** \interface GHOST_ISystem
114  * Interface for classes that provide access to the operating system.
115  * There should be only one system class in an application.
116  * Therefore, the routines to create and dispose the system are static.
117  * Provides:
118  *      -# Time(r) management.
119  *      -# Display/window management (windows are only created on the main display).
120  *      -# Event management.
121  *      -# Cursor shape management (no custom cursors for now).
122  *      -# Access to the state of the mouse buttons and the keyboard.
123  *      -# Menus for windows with events generated when they are accessed (this is
124  *     work in progress).
125  * @author      Maarten Gribnau
126  * @date        May 30, 2001
127  */
128 class GHOST_ISystem
129 {
130 public:
131         /**
132          * Creates the one and only system.
133          * @return An indication of success.
134          */
135         static GHOST_TSuccess createSystem();
136
137         /**
138          * Disposes the one and only system.
139          * @return An indication of success.
140          */
141         static GHOST_TSuccess disposeSystem();
142
143         /**
144          * Returns a pointer to the one and only system (nil if it hasn't been created).
145          * @return A pointer to the system.
146          */
147         static GHOST_ISystem* getSystem();
148
149 protected:
150         /**
151          * Constructor.
152          * Protected default constructor to force use of static createSystem member.
153          */
154         GHOST_ISystem() {}
155
156         /**
157          * Destructor.
158          * Protected default constructor to force use of static dispose member.
159          */
160         virtual ~GHOST_ISystem() {}
161
162 public:
163         /***************************************************************************************
164          ** Time(r) functionality
165          ***************************************************************************************/
166
167         /**
168          * Returns the system time.
169          * Returns the number of milliseconds since the start of the system process.
170          * Based on ANSI clock() routine.
171          * @return The number of milliseconds.
172          */
173         virtual GHOST_TUns64 getMilliSeconds() const = 0;
174
175         /**
176          * Installs a timer.
177          * Note that, on most operating systems, messages need to be processed in order 
178          * for the timer callbacks to be invoked.
179          * @param delay         The time to wait for the first call to the timerProc (in milliseconds)
180          * @param interval      The interval between calls to the timerProc (in milliseconds)
181          * @param timerProc     The callback invoked when the interval expires,
182          * @param userData      Placeholder for user data.
183          * @return A timer task (0 if timer task installation failed).
184          */
185         virtual GHOST_ITimerTask* installTimer(GHOST_TUns64 delay, GHOST_TUns64 interval, GHOST_TimerProcPtr timerProc, GHOST_TUserDataPtr userData = 0) = 0;
186
187         /**
188          * Removes a timer.
189          * @param timerTask Timer task to be removed.
190          * @return Indication of success.
191          */
192         virtual GHOST_TSuccess removeTimer(GHOST_ITimerTask* timerTask) = 0;
193
194         /***************************************************************************************
195          ** Display/window management functionality
196          ***************************************************************************************/
197
198         /**
199          * Returns the number of displays on this system.
200          * @return The number of displays.
201          */
202         virtual GHOST_TUns8 getNumDisplays() const = 0;
203
204         /**
205          * Returns the dimensions of the main display on this system.
206          * @return The dimension of the main display.
207          */
208         virtual void getMainDisplayDimensions(GHOST_TUns32& width, GHOST_TUns32& height) const = 0;
209         
210         /**
211          * Create a new window.
212          * The new window is added to the list of windows managed. 
213          * Never explicitly delete the window, use disposeWindow() instead.
214          * @param       title                   The name of the window (displayed in the title bar of the window if the OS supports it).
215          * @param       left                    The coordinate of the left edge of the window.
216          * @param       top                             The coordinate of the top edge of the window.
217          * @param       width                   The width the window.
218          * @param       height                  The height the window.
219          * @param       state                   The state of the window when opened.
220          * @param       type                    The type of drawing context installed in this window.
221          * @param       stereoVisual    Create a stereo visual for quad buffered stereo.
222          * @param       numOfAASamples  Number of samples used for AA (zero if no AA)
223          * @param       parentWindow    Parent (embedder) window
224          * @return      The new window (or 0 if creation failed).
225          */
226         virtual GHOST_IWindow* createWindow(
227                 const STR_String& title,
228                 GHOST_TInt32 left, GHOST_TInt32 top, GHOST_TUns32 width, GHOST_TUns32 height,
229                 GHOST_TWindowState state, GHOST_TDrawingContextType type,
230                 const bool stereoVisual = false,
231                 const GHOST_TUns16 numOfAASamples = 0,
232                 const GHOST_TEmbedderWindowID parentWindow = 0) = 0;
233
234         /**
235          * Dispose a window.
236          * @param       window Pointer to the window to be disposed.
237          * @return      Indication of success.
238          */
239         virtual GHOST_TSuccess disposeWindow(GHOST_IWindow* window) = 0;
240
241         /**
242          * Returns whether a window is valid.
243          * @param       window Pointer to the window to be checked.
244          * @return      Indication of validity.
245          */
246         virtual bool validWindow(GHOST_IWindow* window) = 0;
247
248         /**
249          * Begins full screen mode.
250          * @param setting       The new setting of the display.
251          * @param window        Window displayed in full screen.
252          *                                      This window is invalid after full screen has been ended.
253          * @return      Indication of success.
254          */
255         virtual GHOST_TSuccess beginFullScreen(const GHOST_DisplaySetting& setting, GHOST_IWindow** window,
256                 const bool stereoVisual) = 0;
257
258         /**
259          * Ends full screen mode.
260          * @return      Indication of success.
261          */
262         virtual GHOST_TSuccess endFullScreen(void) = 0;
263
264         /**
265          * Returns current full screen mode status.
266          * @return The current status.
267          */
268         virtual bool getFullScreen(void) = 0;
269
270         /***************************************************************************************
271          ** Event management functionality
272          ***************************************************************************************/
273         
274         virtual GHOST_TSuccess beginRecord(FILE *file) = 0;
275         virtual GHOST_TSuccess endRecord() = 0;
276         virtual GHOST_TSuccess playbackEvents(FILE *file) = 0;
277         
278         virtual bool playingEvents(bool *hasevent) const = 0;
279         virtual bool recordingEvents() = 0;
280
281         /**
282          * Retrieves events from the system and stores them in the queue.
283          * @param waitForEvent Flag to wait for an event (or return immediately).
284          * @return Indication of the presence of events.
285          */
286         virtual bool processEvents(bool waitForEvent) = 0;
287         
288         /**
289          * Retrieves events from the queue and send them to the event consumers.
290          * @return Indication of the presence of events.
291          */
292         virtual bool dispatchEvents() = 0;
293
294         /**
295          * Adds the given event consumer to our list.
296          * @param consumer The event consumer to add.
297          * @return Indication of success.
298          */
299         virtual GHOST_TSuccess addEventConsumer(GHOST_IEventConsumer* consumer) = 0;
300
301         /**
302          * Removes the given event consumer to our list.
303          * @param consumer The event consumer to remove.
304          * @return Indication of success.
305          */
306         virtual GHOST_TSuccess removeEventConsumer(GHOST_IEventConsumer* consumer) = 0;
307
308          /***************************************************************************************
309          ** N-degree of freedom device management functionality
310          ***************************************************************************************/
311
312    /**
313     * Starts the N-degree of freedom device manager
314     */
315    virtual int openNDOF(GHOST_IWindow*,
316        GHOST_NDOFLibraryInit_fp setNdofLibraryInit, 
317        GHOST_NDOFLibraryShutdown_fp setNdofLibraryShutdown,
318        GHOST_NDOFDeviceOpen_fp setNdofDeviceOpen
319        // original patch only
320       // GHOST_NDOFEventHandler_fp setNdofEventHandler
321        ) = 0;
322
323
324         /***************************************************************************************
325          ** Cursor management functionality
326          ***************************************************************************************/
327
328         /**
329          * Returns the current location of the cursor (location in screen coordinates)
330          * @param x                     The x-coordinate of the cursor.
331          * @param y                     The y-coordinate of the cursor.
332          * @return                      Indication of success.
333          */
334         virtual GHOST_TSuccess getCursorPosition(GHOST_TInt32& x, GHOST_TInt32& y) const = 0;
335
336         /**
337          * Updates the location of the cursor (location in screen coordinates).
338          * Not all operating systems allow the cursor to be moved (without the input device being moved).
339          * @param x                     The x-coordinate of the cursor.
340          * @param y                     The y-coordinate of the cursor.
341          * @return                      Indication of success.
342          */
343         virtual GHOST_TSuccess setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y) = 0;
344
345         /***************************************************************************************
346          ** Access to mouse button and keyboard states.
347          ***************************************************************************************/
348
349         /**
350          * Returns the state of a modifier key (ouside the message queue).
351          * @param mask          The modifier key state to retrieve.
352          * @param isDown        The state of a modifier key (true == pressed).
353          * @return                      Indication of success.
354          */
355         virtual GHOST_TSuccess getModifierKeyState(GHOST_TModifierKeyMask mask, bool& isDown) const = 0;
356
357         /**
358          * Returns the state of a mouse button (ouside the message queue).
359          * @param mask          The button state to retrieve.
360          * @param isDown        Button state.
361          * @return                      Indication of success.
362          */
363         virtual GHOST_TSuccess getButtonState(GHOST_TButtonMask mask, bool& isDown) const = 0;
364
365         /**
366          * Toggles console
367          * @action      0 - Hides
368          *                      1 - Shows
369          *                      2 - Toggles
370          *                      3 - Hides if it runs not from  command line
371          *                      * - Does nothing
372          * @return current status (1 -visible, 0 - hidden)
373          */
374         virtual int toggleConsole(int action) = 0;
375         
376         /***************************************************************************************
377          ** Access to clipboard.
378          ***************************************************************************************/
379         
380         /**
381          * Returns the selection buffer
382          * @return Returns "unsinged char" from X11 XA_CUT_BUFFER0 buffer
383          *
384          */
385          virtual GHOST_TUns8* getClipboard(bool selection) const = 0;
386
387         /**
388          * Put data to the Clipboard
389          */
390         virtual void putClipboard(GHOST_TInt8 *buffer, bool selection) const = 0;
391
392         
393 protected:
394         /**
395          * Initialize the system.
396          * @return Indication of success.
397          */
398         virtual GHOST_TSuccess init() = 0;
399
400         /**
401          * Shut the system down.
402          * @return Indication of success.
403          */
404         virtual GHOST_TSuccess exit() = 0;
405
406         /** The one and only system */
407         static GHOST_ISystem* m_system;
408
409 #ifdef WITH_CXX_GUARDEDALLOC
410 public:
411         void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GHOST:GHOST_ISystem"); }
412         void operator delete( void *mem ) { MEM_freeN(mem); }
413 #endif
414 };
415
416 #endif // _GHOST_ISYSTEM_H_
417