Merge branch 'master' into blender2.8
[blender.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_IContext.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/resources/libraries/glut/">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  *
65  * - Time(r) management.
66  * - Display/window management (windows are only created on the main display).
67  * - Event management.
68  * - Cursor shape management (no custom cursors for now).
69  * - Access to the state of the mouse buttons and the keyboard.
70  * - Menus for windows with events generated when they are accessed (this is
71  *   work in progress).
72  * - Video mode switching.
73  * - Copy/Paste buffers.
74  * - System paths.
75  *
76  * Font management has been moved to a separate library.
77  *
78  * \section platforms Platforms
79  *
80  * GHOST supports the following platforms:
81  *
82  * - OSX Cocoa.
83  * - Windows.
84  * - X11.
85  * - SDL2 (experimental).
86  * - NULL (headless mode).
87  *
88  * \section Building GHOST
89  *
90  * GHOST is not build standalone however there are tests in intern/ghost/test
91  *
92  * \section interface Interface
93  * GHOST has two programming interfaces:
94  *
95  * - The C-API. For programs written in C.
96  * - The C++-API. For programs written in C++.
97  *
98  * GHOST itself is written in C++ and the C-API is a wrapper around the C++
99  * API.
100  *
101  * \subsection cplusplus_api The C++ API consists of the following files:
102  *
103  * - GHOST_IEvent.h
104  * - GHOST_IEventConsumer.h
105  * - GHOST_ISystem.h
106  * - GHOST_ITimerTask.h
107  * - GHOST_IWindow.h
108  * - GHOST_Rect.h
109  * - GHOST_Types.h
110  *
111  * For an example of using the C++-API, have a look at the GHOST_C-Test.cpp
112  * program in the ?/ghost/test/gears/ directory.
113  *
114  * \subsection c_api The C-API
115  * To use GHOST in programs written in C, include the file GHOST_C-API.h in
116  * your program. This file includes the GHOST_Types.h file for all GHOST types
117  * and defines functions that give you access to the same functionality present
118  * in the C++ API.<br>
119  * For an example of using the C-API, have a look at the GHOST_C-Test.c program
120  * in the ?/ghost/test/gears/ directory.
121  *
122  * \section work Work in progress
123  * \todo write WIP section
124  */
125
126 /** \interface GHOST_ISystem
127  * Interface for classes that provide access to the operating system.
128  * There should be only one system class in an application.
129  * Therefore, the routines to create and dispose the system are static.
130  * Provides:
131  *  -# Time(r) management.
132  *  -# Display/window management (windows are only created on the main display).
133  *  -# Event management.
134  *  -# Cursor shape management (no custom cursors for now).
135  *  -# Access to the state of the mouse buttons and the keyboard.
136  *  -# Menus for windows with events generated when they are accessed (this is
137  *     work in progress).
138  * \author  Maarten Gribnau
139  * \date    May 30, 2001
140  */
141 class GHOST_ISystem
142 {
143 public:
144         /**
145          * Creates the one and only system.
146          * \return An indication of success.
147          */
148         static GHOST_TSuccess createSystem();
149
150         /**
151          * Disposes the one and only system.
152          * \return An indication of success.
153          */
154         static GHOST_TSuccess disposeSystem();
155
156         /**
157          * Returns a pointer to the one and only system (nil if it hasn't been created).
158          * \return A pointer to the system.
159          */
160         static GHOST_ISystem *getSystem();
161
162 protected:
163         /**
164          * Constructor.
165          * Protected default constructor to force use of static createSystem member.
166          */
167         GHOST_ISystem() {
168         }
169
170         /**
171          * Destructor.
172          * Protected default constructor to force use of static dispose member.
173          */
174         virtual ~GHOST_ISystem() {
175         }
176
177 public:
178         /***************************************************************************************
179          * Time(r) functionality
180          ***************************************************************************************/
181
182         /**
183          * Returns the system time.
184          * Returns the number of milliseconds since the start of the system process.
185          * Based on ANSI clock() routine.
186          * \return The number of milliseconds.
187          */
188         virtual GHOST_TUns64 getMilliSeconds() const = 0;
189
190         /**
191          * Installs a timer.
192          * Note that, on most operating systems, messages need to be processed in order
193          * for the timer callbacks to be invoked.
194          * \param delay     The time to wait for the first call to the timerProc (in milliseconds)
195          * \param interval  The interval between calls to the timerProc (in milliseconds)
196          * \param timerProc The callback invoked when the interval expires,
197          * \param userData  Placeholder for user data.
198          * \return A timer task (0 if timer task installation failed).
199          */
200         virtual GHOST_ITimerTask *installTimer(GHOST_TUns64 delay,
201                                                GHOST_TUns64 interval,
202                                                GHOST_TimerProcPtr timerProc,
203                                                GHOST_TUserDataPtr userData = NULL) = 0;
204
205         /**
206          * Removes a timer.
207          * \param timerTask Timer task to be removed.
208          * \return Indication of success.
209          */
210         virtual GHOST_TSuccess removeTimer(GHOST_ITimerTask *timerTask) = 0;
211
212         /***************************************************************************************
213          * Display/window management functionality
214          ***************************************************************************************/
215
216         /**
217          * Returns the number of displays on this system.
218          * \return The number of displays.
219          */
220         virtual GHOST_TUns8 getNumDisplays() const = 0;
221
222         /**
223          * Returns the dimensions of the main display on this system.
224          * \return The dimension of the main display.
225          */
226         virtual void getMainDisplayDimensions(GHOST_TUns32& width, GHOST_TUns32& height) const = 0;
227
228         /**
229          * Returns the combine dimensions of all monitors.
230          * \return The dimension of the workspace.
231          */
232         virtual void getAllDisplayDimensions(GHOST_TUns32& width, GHOST_TUns32& height) const = 0;
233
234         /**
235          * Create a new window.
236          * The new window is added to the list of windows managed.
237          * Never explicitly delete the window, use disposeWindow() instead.
238          * \param   title           The name of the window (displayed in the title bar of the window if the OS supports it).
239          * \param   left            The coordinate of the left edge of the window.
240          * \param   top             The coordinate of the top edge of the window.
241          * \param   width           The width the window.
242          * \param   height          The height the window.
243          * \param   state           The state of the window when opened.
244          * \param   type            The type of drawing context installed in this window.
245          * \param glSettings: Misc OpenGL settings.
246          * \param exclusive: Use to show the window ontop and ignore others (used fullscreen).
247          * \param   parentWindow    Parent (embedder) window
248          * \return  The new window (or 0 if creation failed).
249          */
250         virtual GHOST_IWindow *createWindow(
251                 const STR_String& title,
252                 GHOST_TInt32 left, GHOST_TInt32 top, GHOST_TUns32 width, GHOST_TUns32 height,
253                 GHOST_TWindowState state, GHOST_TDrawingContextType type,
254                 GHOST_GLSettings glSettings,
255                 const bool exclusive = false,
256                 const GHOST_TEmbedderWindowID parentWindow = 0) = 0;
257
258         /**
259          * Dispose a window.
260          * \param   window Pointer to the window to be disposed.
261          * \return  Indication of success.
262          */
263         virtual GHOST_TSuccess disposeWindow(GHOST_IWindow *window) = 0;
264
265         /**
266          * Create a new offscreen context.
267          * Never explicitly delete the context, use disposeContext() instead.
268          * \return  The new context (or 0 if creation failed).
269          */
270         virtual GHOST_IContext *createOffscreenContext() = 0;
271
272         /**
273          * Dispose of a context.
274          * \param   context Pointer to the context to be disposed.
275          * \return  Indication of success.
276          */
277         virtual GHOST_TSuccess disposeContext(GHOST_IContext *context) = 0;
278
279         /**
280          * Returns whether a window is valid.
281          * \param   window Pointer to the window to be checked.
282          * \return  Indication of validity.
283          */
284         virtual bool validWindow(GHOST_IWindow *window) = 0;
285
286         /**
287          * Begins full screen mode.
288          * \param setting   The new setting of the display.
289          * \param window    Window displayed in full screen.
290          *                  This window is invalid after full screen has been ended.
291          * \return  Indication of success.
292          */
293         virtual GHOST_TSuccess beginFullScreen(
294                 const GHOST_DisplaySetting& setting, GHOST_IWindow **window,
295                 const bool stereoVisual, const bool alphaBackground = 0, const GHOST_TUns16 numOfAASamples = 0) = 0;
296
297         /**
298          * Updates the resolution while in fullscreen mode.
299          * \param setting   The new setting of the display.
300          * \param window    Window displayed in full screen.
301          *
302          * \return  Indication of success.
303          */
304         virtual GHOST_TSuccess updateFullScreen(
305                 const GHOST_DisplaySetting& setting, GHOST_IWindow **window) = 0;
306
307         /**
308          * Ends full screen mode.
309          * \return  Indication of success.
310          */
311         virtual GHOST_TSuccess endFullScreen(void) = 0;
312
313         /**
314          * Returns current full screen mode status.
315          * \return The current status.
316          */
317         virtual bool getFullScreen(void) = 0;
318
319         /**
320          * Native pixel size support (MacBook 'retina').
321          */
322         virtual bool useNativePixel(void) = 0;
323
324         /***************************************************************************************
325          * Event management functionality
326          ***************************************************************************************/
327
328         /**
329          * Retrieves events from the system and stores them in the queue.
330          * \param waitForEvent Flag to wait for an event (or return immediately).
331          * \return Indication of the presence of events.
332          */
333         virtual bool processEvents(bool waitForEvent) = 0;
334
335         /**
336          * Retrieves events from the queue and send them to the event consumers.
337          */
338         virtual void dispatchEvents() = 0;
339
340         /**
341          * Adds the given event consumer to our list.
342          * \param consumer The event consumer to add.
343          * \return Indication of success.
344          */
345         virtual GHOST_TSuccess addEventConsumer(GHOST_IEventConsumer *consumer) = 0;
346
347         /**
348          * Removes the given event consumer to our list.
349          * \param consumer The event consumer to remove.
350          * \return Indication of success.
351          */
352         virtual GHOST_TSuccess removeEventConsumer(GHOST_IEventConsumer *consumer) = 0;
353
354         /***************************************************************************************
355          * Cursor management functionality
356          ***************************************************************************************/
357
358         /**
359          * Returns the current location of the cursor (location in screen coordinates)
360          * \param x         The x-coordinate of the cursor.
361          * \param y         The y-coordinate of the cursor.
362          * \return          Indication of success.
363          */
364         virtual GHOST_TSuccess getCursorPosition(GHOST_TInt32& x, GHOST_TInt32& y) const = 0;
365
366         /**
367          * Updates the location of the cursor (location in screen coordinates).
368          * Not all operating systems allow the cursor to be moved (without the input device being moved).
369          * \param x         The x-coordinate of the cursor.
370          * \param y         The y-coordinate of the cursor.
371          * \return          Indication of success.
372          */
373         virtual GHOST_TSuccess setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y) = 0;
374
375         /***************************************************************************************
376          * Access to mouse button and keyboard states.
377          ***************************************************************************************/
378
379         /**
380          * Returns the state of a modifier key (ouside the message queue).
381          * \param mask      The modifier key state to retrieve.
382          * \param isDown    The state of a modifier key (true == pressed).
383          * \return          Indication of success.
384          */
385         virtual GHOST_TSuccess getModifierKeyState(GHOST_TModifierKeyMask mask, bool& isDown) const = 0;
386
387         /**
388          * Returns the state of a mouse button (ouside the message queue).
389          * \param mask      The button state to retrieve.
390          * \param isDown    Button state.
391          * \return          Indication of success.
392          */
393         virtual GHOST_TSuccess getButtonState(GHOST_TButtonMask mask, bool& isDown) const = 0;
394
395 #ifdef WITH_INPUT_NDOF
396         /**
397          * Sets 3D mouse deadzone
398          * \param deadzone: Deadzone of the 3D mouse (both for rotation and pan) relative to full range
399          */
400         virtual void setNDOFDeadZone(float deadzone) = 0;
401 #endif
402
403         /**
404          * Toggles console
405          * \param action
406          * - 0: Hides
407          * - 1: Shows
408          * - 2: Toggles
409          * - 3: Hides if it runs not from  command line
410          * - *: Does nothing
411          * \return current status (1 -visible, 0 - hidden)
412          */
413         virtual int toggleConsole(int action) = 0;
414
415         /***************************************************************************************
416          * Access to clipboard.
417          ***************************************************************************************/
418
419         /**
420          * Returns the selection buffer
421          * \return "unsigned char" from X11 XA_CUT_BUFFER0 buffer
422          *
423          */
424         virtual GHOST_TUns8 *getClipboard(bool selection) const = 0;
425
426         /**
427          * Put data to the Clipboard
428          */
429         virtual void putClipboard(GHOST_TInt8 *buffer, bool selection) const = 0;
430
431         /**
432          * Confirms quitting he program when there is just one window left open
433          * in the application
434          */
435         virtual int confirmQuit(GHOST_IWindow *window) const = 0;
436
437         /**
438          * Informs if the system provides native dialogs (eg. confirm quit)
439          */
440         virtual bool supportsNativeDialogs(void) = 0;
441
442 protected:
443         /**
444          * Initialize the system.
445          * \return Indication of success.
446          */
447         virtual GHOST_TSuccess init() = 0;
448
449         /**
450          * Shut the system down.
451          * \return Indication of success.
452          */
453         virtual GHOST_TSuccess exit() = 0;
454
455         /** The one and only system */
456         static GHOST_ISystem *m_system;
457
458
459 #ifdef WITH_CXX_GUARDEDALLOC
460         MEM_CXX_CLASS_ALLOC_FUNCS("GHOST:GHOST_ISystem")
461 #endif
462 };
463
464 #endif // __GHOST_ISYSTEM_H__
465