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