ScriptModules/Lua/ScriptModule.h

/***********************************************************************
        created:  16/3/2005
        author:   Tomas Lindquist Olsen
        
        purpose:  Defines interface for LuaScriptModule class
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2008 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 _CEGUILua_h_
#define _CEGUILua_h_


/*************************************************************************
        Import / Export control macros
*************************************************************************/
#if (defined( __WIN32__ ) || defined( _WIN32 )) && !defined(CEGUI_STATIC)
#   ifdef CEGUILUASCRIPTMODULE_EXPORTS
#       define CEGUILUA_API __declspec(dllexport)
#   else
#       define CEGUILUA_API __declspec(dllimport)
#   endif
#else
#   define CEGUILUA_API
#endif


#include "CEGUI/ScriptModule.h"

struct lua_State;

// Start of CEGUI namespace section
namespace CEGUI
{

class CEGUILUA_API LuaScriptModule : public CEGUI::ScriptModule
{
public:
        /*************************************************************************
                Construction and Destruction
        *************************************************************************/
    static LuaScriptModule& create(lua_State* state = 0);

    static void destroy(LuaScriptModule& mod);


        /*************************************************************************
                Script Execution Functions
        *************************************************************************/
    void executeScriptFile(const String& filename, const String& resourceGroup);

    void executeScriptFile(const String& filename,
                           const String& resourceGroup,
                           const String& error_handler);

    void executeScriptFile(const String& filename,
                           const String& resourceGroup,
                           const int error_handler);

    int executeScriptGlobal(const String& function_name);

    int executeScriptGlobal(const String& function_name,
                            const String& error_handler);

    int executeScriptGlobal(const String& function_name,
                            const int error_handler);


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

    bool executeScriptedEventHandler(const String& handler_name,
                                     const EventArgs& e,
                                     const String& error_handler);

    bool executeScriptedEventHandler(const String& handler_name,
                                     const EventArgs& e,
                                     const int error_handler);

    void executeString(const String& str);

    void executeString(const String& str, const String& error_handler);

    void executeString(const String& str, const int error_handler);

    /*************************************************************************
        Event subscription
    *************************************************************************/
    Event::Connection subscribeEvent(EventSet* target, const String& name,
                                     const String& subscriber_name);

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

    Event::Connection subscribeEvent(EventSet* target, const String& name,
                                     const String& subscriber_name,
                                     const int error_handler);

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

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

    Event::Connection subscribeEvent(EventSet* target, const String& name,
                                     Event::Group group,
                                     const String& subscriber_name,
                                     const int error_handler);

    /*************************************************************************
        Bindings creation / destruction
    *************************************************************************/
    void createBindings(void);

    void destroyBindings(void);

    /*************************************************************************
        Accessor type functions
    *************************************************************************/
    lua_State* getLuaState(void) const {return d_state;}

    /*************************************************************************
        Lua error handler related functions
    *************************************************************************/
    void setDefaultPCallErrorHandler(const String& error_handler_function);

    void setDefaultPCallErrorHandler(int function_reference);

    const String& getActivePCallErrorHandlerString() const;

    int getActivePCallErrorHandlerReference() const;

private:
    /*************************************************************************
        Implementation Functions
    *************************************************************************/
    LuaScriptModule(lua_State* state);

    ~LuaScriptModule();


    void setModuleIdentifierString();
    int initErrorHandlerFunc();
    int initErrorHandlerFunc(const String func_name);
    int initErrorHandlerFunc(int func);

    void cleanupErrorHandlerFunc();

    void unrefErrorFunc();

    void executeScriptFile_impl(const String& filename,
                                const String& resourceGroup,
                                const int err_idx, const int top);

    int executeScriptGlobal_impl(const String& function_name,
                                 const int err_idx, const int top);

    bool executeScriptedEventHandler_impl(const String& handler_name,
                                          const EventArgs& e,
                                          const int err_idx, const int top);

    void executeString_impl(const String& str, const int err_idx, const int top);

    /*************************************************************************
        Implementation Data
    *************************************************************************/
    bool d_ownsState;
    lua_State* d_state;
    String d_errFuncName;
    int d_errFuncIndex;
    String d_activeErrFuncName;
    int d_activeErrFuncIndex;
};

} // namespace CEGUI

#endif // end of guard _CEGUILua_h_