ScriptModule.h

/***********************************************************************
        filename:       CEGUIScriptModule.h
        created:        16/7/2004
        author:         Paul D Turner

        purpose:        Abstract class interface for scripting support
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2006 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 _CEGUIScriptModule_h_
#define _CEGUIScriptModule_h_

#include "CEGUI/Base.h"
#include "CEGUI/String.h"
#include "CEGUI/Event.h"


// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT ScriptModule :
    public AllocatedObject<ScriptModule>
{
public:
        /*************************************************************************
                Construction and Destruction
        *************************************************************************/
        ScriptModule(void);


        virtual ~ScriptModule(void) {}


        /*************************************************************************
                Abstract interface
        *************************************************************************/
        virtual void    executeScriptFile(const String& filename, const String& resourceGroup = "")     = 0;


        virtual int     executeScriptGlobal(const String& function_name)        = 0;


        virtual bool    executeScriptedEventHandler(const String& handler_name, const EventArgs& e)             = 0;


    virtual void executeString(const String& str) = 0;


    virtual void createBindings(void) {}


    virtual void destroyBindings(void) {}

    const String& getIdentifierString() const;

    virtual Event::Connection   subscribeEvent(EventSet* target, const String& name, const String& subscriber_name) = 0;

    virtual Event::Connection   subscribeEvent(EventSet* target, const String& name, Event::Group group, const String& subscriber_name) = 0;

    static void setDefaultResourceGroup(const String& resourceGroup)
        { d_defaultResourceGroup = resourceGroup; }

    static const String& getDefaultResourceGroup()
        { return d_defaultResourceGroup; }

protected:
    String d_identifierString;
    static String d_defaultResourceGroup;
};


class CEGUIEXPORT ScriptFunctor :
    public AllocatedObject<ScriptFunctor>
{
public:
        ScriptFunctor(const String& functionName) : scriptFunctionName(functionName) {}
    ScriptFunctor(const ScriptFunctor& obj) : scriptFunctionName(obj.scriptFunctionName) {}
        bool    operator()(const EventArgs& e) const;

private:
    // no assignment possible
    ScriptFunctor& operator=(const ScriptFunctor& rhs);

        const String    scriptFunctionName;
};

} // End of  CEGUI namespace section


#endif  // end of guard _CEGUIScriptModule_h_