GHOST_ISystem.h

Go to the documentation of this file.

/*
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 *
 * The Original Code is: all of this file.
 *
 * Contributor(s): none yet.
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#ifndef _GHOST_ISYSTEM_H_
#define _GHOST_ISYSTEM_H_

#include "GHOST_Types.h"
#include "GHOST_ITimerTask.h"
#include "GHOST_IWindow.h"

class GHOST_IEventConsumer;

class GHOST_ISystem
{
public:
    static GHOST_TSuccess createSystem();

    static GHOST_TSuccess disposeSystem();

    static GHOST_ISystem* getSystem();

protected:
    GHOST_ISystem() {}

    virtual ~GHOST_ISystem() {}

public:
    /***************************************************************************************
     ** Time(r) functionality
     ***************************************************************************************/

    virtual GHOST_TUns64 getMilliSeconds() const = 0;

    virtual GHOST_ITimerTask* installTimer(GHOST_TUns64 delay,
                                           GHOST_TUns64 interval,
                                           GHOST_TimerProcPtr timerProc,
                                           GHOST_TUserDataPtr userData = 0) = 0;

    virtual GHOST_TSuccess removeTimer(GHOST_ITimerTask* timerTask) = 0;

    /***************************************************************************************
     ** Display/window management functionality
     ***************************************************************************************/

    virtual GHOST_TUns8 getNumDisplays() const = 0;

    virtual void getMainDisplayDimensions(GHOST_TUns32& width, GHOST_TUns32& height) const = 0;
    
    virtual GHOST_IWindow* createWindow(
        const STR_String& title,
        GHOST_TInt32 left, GHOST_TInt32 top, GHOST_TUns32 width, GHOST_TUns32 height,
        GHOST_TWindowState state, GHOST_TDrawingContextType type,
        const bool stereoVisual = false,
        const GHOST_TUns16 numOfAASamples = 0,
        const GHOST_TEmbedderWindowID parentWindow = 0) = 0;

    virtual GHOST_TSuccess disposeWindow(GHOST_IWindow* window) = 0;

    virtual bool validWindow(GHOST_IWindow* window) = 0;

    virtual GHOST_TSuccess beginFullScreen(const GHOST_DisplaySetting& setting, GHOST_IWindow** window,
        const bool stereoVisual, const GHOST_TUns16 numOfAASamples=0) = 0;

    virtual GHOST_TSuccess endFullScreen(void) = 0;

    virtual bool getFullScreen(void) = 0;

    /***************************************************************************************
     ** Event management functionality
     ***************************************************************************************/

    virtual bool processEvents(bool waitForEvent) = 0;
    
    virtual bool dispatchEvents() = 0;

    virtual GHOST_TSuccess addEventConsumer(GHOST_IEventConsumer* consumer) = 0;

    virtual GHOST_TSuccess removeEventConsumer(GHOST_IEventConsumer* consumer) = 0;

    /***************************************************************************************
     ** Cursor management functionality
     ***************************************************************************************/

    virtual GHOST_TSuccess getCursorPosition(GHOST_TInt32& x, GHOST_TInt32& y) const = 0;

    virtual GHOST_TSuccess setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y) = 0;

    /***************************************************************************************
     ** Access to mouse button and keyboard states.
     ***************************************************************************************/

    virtual GHOST_TSuccess getModifierKeyState(GHOST_TModifierKeyMask mask, bool& isDown) const = 0;

    virtual GHOST_TSuccess getButtonState(GHOST_TButtonMask mask, bool& isDown) const = 0;

    virtual int toggleConsole(int action) = 0;
    
    /***************************************************************************************
     ** Access to clipboard.
     ***************************************************************************************/
    
    virtual GHOST_TUns8* getClipboard(bool selection) const = 0;

    virtual void putClipboard(GHOST_TInt8 *buffer, bool selection) const = 0;

    
protected:
    virtual GHOST_TSuccess init() = 0;

    virtual GHOST_TSuccess exit() = 0;

    static GHOST_ISystem* m_system;

#ifdef WITH_CXX_GUARDEDALLOC
public:
    void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GHOST:GHOST_ISystem"); }
    void operator delete( void *mem ) { MEM_freeN(mem); }
#endif
};

#endif // _GHOST_ISYSTEM_H_