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