System.h

/***********************************************************************
        created:        20/2/2004
        author:         Paul D Turner

        purpose:        Defines interface for main GUI system class
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2012 Paul D Turner & The CEGUI Development Team
 *
 *   Permission is hereby granted, free of charge, to any person obtaining
 *   a copy of this software and associated documentation files (the
 *   "Software"), to deal in the Software without restriction, including
 *   without limitation the rights to use, copy, modify, merge, publish,
 *   distribute, sublicense, and/or sell copies of the Software, and to
 *   permit persons to whom the Software is furnished to do so, subject to
 *   the following conditions:
 *
 *   The above copyright notice and this permission notice shall be
 *   included in all copies or substantial portions of the Software.
 *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 *   OTHER DEALINGS IN THE SOFTWARE.
 ***************************************************************************/
#ifndef _CEGUISystem_h_
#define _CEGUISystem_h_

#include "CEGUI/Base.h"
#include "CEGUI/String.h"
#include "CEGUI/Singleton.h"
#include "CEGUI/EventSet.h"
#include "CEGUI/Renderer.h"
#include "CEGUI/InputEvent.h"
#include "CEGUI/ResourceProvider.h"
#include <vector>

#if defined(__WIN32__) || defined(_WIN32)
#   include "CEGUI/Win32StringTranscoder.h"
#else
#   include "CEGUI/IconvStringTranscoder.h"
#endif

#if defined(_MSC_VER)
#       pragma warning(push)
#       pragma warning(disable : 4275)
#       pragma warning(disable : 4251)
#endif


// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT System :
    public Singleton<System>,
    public EventSet,
    public AllocatedObject<System>
{
public:
        static const String EventNamespace;                             

        /*************************************************************************
                Constants
        *************************************************************************/
        // event names
    static const String EventDisplaySizeChanged;
    static const String EventRenderedStringParserChanged;

        /*************************************************************************
                Construction and Destruction
        *************************************************************************/
    static System& create(Renderer& renderer,
                          ResourceProvider* resourceProvider = 0,
                          XMLParser* xmlParser = 0,
                          ImageCodec* imageCodec = 0,
                          ScriptModule* scriptModule = 0,
                          const String& configFile = "",
                          const String& logFile = "CEGUI.log",
                          const int abi = CEGUI_VERSION_ABI);

    static void destroy();

    static unsigned int getMajorVersion();

    static unsigned int getMinorVersion();

    static unsigned int getPatchVersion();

    static const String& getVersion();

    static const String& getVerboseVersion();

        Renderer*       getRenderer(void) const                 {return d_renderer;}


        static  System& getSingleton(void);


        static  System* getSingletonPtr(void);

    Clipboard* getClipboard() const         {return d_clipboard;}

    GUIContext& getDefaultGUIContext() const;

    void renderAllGUIContexts();


        ScriptModule*   getScriptingModule(void) const;

    void setScriptingModule(ScriptModule* scriptModule);

        ResourceProvider* getResourceProvider(void) const;

        void    executeScriptFile(const String& filename, const String& resourceGroup = "") const;


        int             executeScriptGlobal(const String& function_name) const;


    void executeScriptString(const String& str) const;


    void setXMLParser(const String& parserName);

    void setXMLParser(XMLParser* parser);

    XMLParser* getXMLParser(void) const     { return d_xmlParser; }


    static void setDefaultXMLParserName(const String& parserName);

    static const String getDefaultXMLParserName();
    
    ImageCodec& getImageCodec() const;

    void setImageCodec(const String& codecName);

    void setImageCodec(ImageCodec& codec);

    static void setDefaultImageCodecName(const String& codecName);

    static const String& getDefaultImageCodecName();

    void notifyDisplaySizeChanged(const Sizef& new_size);

    RenderedStringParser* getDefaultCustomRenderedStringParser() const;

    void setDefaultCustomRenderedStringParser(RenderedStringParser* parser);

    void invalidateAllCachedRendering();

    RegexMatcher* createRegexMatcher() const;

    void destroyRegexMatcher(RegexMatcher* rm) const;

    bool injectTimePulse(float timeElapsed);

    GUIContext& createGUIContext(RenderTarget& rt);
    void destroyGUIContext(GUIContext& context);

    void addStandardWindowFactories();

    static const StringTranscoder& getStringTranscoder();

    static void performVersionTest(const int expected, const int received,
                                   const String& func);

private:
    // unimplemented constructors / assignment
    System(const System& obj);
    System& operator=(const System& obj);

protected:
        /*************************************************************************
                Implementation Functions
        *************************************************************************/
    System(Renderer& renderer, ResourceProvider* resourceProvider,
           XMLParser* xmlParser, ImageCodec* imageCodec,
           ScriptModule* scriptModule, const String& configFile,
           const String& logFile);

    ~System(void);

    void outputLogHeader();

    void createSingletons();

    void destroySingletons();

    void setupXMLParser();

    void cleanupXMLParser();

    void setupImageCodec(const String& codecName);

    void cleanupImageCodec();

    void invalidateAllWindows();

        /*************************************************************************
                Implementation Data
        *************************************************************************/
        Renderer*       d_renderer;                     
    ResourceProvider* d_resourceProvider;      
        bool d_ourResourceProvider;

    Clipboard* d_clipboard;         

        // scripting
        ScriptModule*   d_scriptModule;                 
        String                  d_termScriptName;               

    XMLParser*  d_xmlParser;        
    bool        d_ourXmlParser;     
    DynamicModule* d_parserModule;  

    static String   d_defaultXMLParserName; 

    ImageCodec* d_imageCodec;
    bool d_ourImageCodec;
    DynamicModule* d_imageCodecModule;
    static String d_defaultImageCodecName;
    bool d_ourLogger;
    RenderedStringParser* d_customRenderedStringParser;

    typedef std::vector<GUIContext* CEGUI_VECTOR_ALLOC(GUIContext*)> GUIContextCollection;
    GUIContextCollection d_guiContexts;
#if defined(__WIN32__) || defined(_WIN32)
    static const Win32StringTranscoder d_stringTranscoder;
#else
    static const IconvStringTranscoder d_stringTranscoder;
#endif
};

} // End of  CEGUI namespace section


#if defined(_MSC_VER)
#       pragma warning(pop)
#endif

#endif  // end of guard _CEGUISystem_h_