2019-11-23 20:27:39 +08:00
|
|
|
/****************************************************************************
|
|
|
|
Copyright (c) 2012 cocos2d-x.org
|
|
|
|
Copyright (c) 2013-2016 Chukong Technologies Inc.
|
|
|
|
Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2022-10-01 16:24:52 +08:00
|
|
|
https://axmolengine.github.io/
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
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:
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
|
|
all copies or substantial portions of the Software.
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
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 OR COPYRIGHT HOLDERS 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.
|
|
|
|
****************************************************************************/
|
|
|
|
|
2022-07-16 10:43:05 +08:00
|
|
|
#ifndef __AX_LUA_ENGINE_H__
|
|
|
|
#define __AX_LUA_ENGINE_H__
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
extern "C" {
|
|
|
|
#include "lua.h"
|
|
|
|
}
|
|
|
|
|
2023-06-11 13:08:08 +08:00
|
|
|
#include "base/ScriptSupport.h"
|
|
|
|
#include "scripting/lua-bindings/manual/LuaStack.h"
|
|
|
|
#include "scripting/lua-bindings/manual/LuaValue.h"
|
2022-07-12 21:31:54 +08:00
|
|
|
#include "scripting/lua-bindings/manual/base/LuaScriptHandlerMgr.h"
|
2019-11-23 20:27:39 +08:00
|
|
|
#include "scripting/lua-bindings/manual/Lua-BindingsExport.h"
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @addtogroup lua
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
2022-07-11 17:50:21 +08:00
|
|
|
NS_AX_BEGIN
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
/**
|
2023-09-01 14:49:03 +08:00
|
|
|
* The Lua engine integrated into the axmol to process the interactive operation between lua and c++.
|
2019-11-23 20:27:39 +08:00
|
|
|
*
|
|
|
|
* @lua NA
|
|
|
|
* @js NA
|
|
|
|
*/
|
2022-07-16 10:43:05 +08:00
|
|
|
class AX_LUA_DLL LuaEngine : public ScriptEngineProtocol
|
2019-11-23 20:27:39 +08:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
/**
|
|
|
|
* Get instance of LuaEngine.
|
|
|
|
*
|
|
|
|
* @return the instance of LuaEngine.
|
|
|
|
*/
|
|
|
|
static LuaEngine* getInstance(void);
|
|
|
|
/**
|
|
|
|
* Get defaultEngine of LuaEngine, it was deprecated.
|
|
|
|
*
|
|
|
|
* @return the instance of LuaEngine.
|
|
|
|
*/
|
2022-07-16 10:43:05 +08:00
|
|
|
AX_DEPRECATED_ATTRIBUTE static LuaEngine* defaultEngine(void) { return LuaEngine::getInstance(); }
|
2021-12-25 10:04:45 +08:00
|
|
|
|
|
|
|
/**
|
2019-11-23 20:27:39 +08:00
|
|
|
* Destructor of LuaEngine.
|
|
|
|
*/
|
|
|
|
virtual ~LuaEngine(void);
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Get ccScriptType of LuaEngine used, it is always kScriptTypeLua.
|
|
|
|
*
|
|
|
|
* @return kScriptTypeLua.
|
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
virtual ccScriptType getScriptType() override { return kScriptTypeLua; };
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Get LuaStack of the LuaEngine.
|
|
|
|
* All the interactive operation are all base on the LuaStack.
|
|
|
|
*
|
|
|
|
* @return LuaStack object.
|
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
LuaStack* getLuaStack(void) { return _stack; }
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Add a path to find lua files in.
|
|
|
|
*
|
|
|
|
* @param path to be added to the Lua path.
|
|
|
|
*/
|
|
|
|
virtual void addSearchPath(const char* path);
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Add lua loader.
|
|
|
|
*
|
|
|
|
* @param func a function pointer point to the loader function.
|
|
|
|
*/
|
|
|
|
virtual void addLuaLoader(lua_CFunction func);
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Reload script code corresponding to moduleFileName.
|
2021-12-25 10:04:45 +08:00
|
|
|
* If value of package["loaded"][moduleFileName] is existed, it would set the value nil.Then,it calls executeString
|
|
|
|
* function.
|
2019-11-23 20:27:39 +08:00
|
|
|
*
|
|
|
|
* @param moduleFileName String object holding the filename of the script file that is to be executed.
|
|
|
|
* @return 0 if the string is executed correctly or other if the string is executed wrongly.
|
|
|
|
*/
|
|
|
|
virtual int reload(const char* moduleFileName);
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
2021-12-25 10:04:45 +08:00
|
|
|
* Remove the related reference about the Ref object stored in the Lua table by set the value of corresponding key
|
|
|
|
* nil: The related Lua tables are toluafix_refid_ptr_mapping,toluafix_refid_type_mapping,tolua_value_root and
|
|
|
|
* object_Metatable["tolua_ubox"] or tolua_ubox. Meanwhile set the corresponding userdata nullptr and remove the all
|
|
|
|
* the lua function reference corresponding to this object.
|
|
|
|
*
|
|
|
|
* In current mechanism, this function is called in the destructor of Ref object, developer don't call this
|
|
|
|
* functions.
|
2019-11-23 20:27:39 +08:00
|
|
|
*
|
|
|
|
* @param object the key object to remove script object.
|
|
|
|
*/
|
|
|
|
virtual void removeScriptObjectByObject(Ref* object) override;
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Remove Lua function reference by nHandler by setting toluafix_refid_function_mapping[nHandle] nil.
|
|
|
|
*
|
|
|
|
* @param nHandler the function reference index to find the corresponding Lua function pointer.
|
|
|
|
*/
|
|
|
|
virtual void removeScriptHandler(int nHandler) override;
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Reallocate Lua function reference index to the Lua function pointer to add reference.
|
|
|
|
*
|
|
|
|
* @param nHandler the function reference index to find the corresponding Lua function pointer.
|
|
|
|
*/
|
|
|
|
virtual int reallocateScriptHandler(int nHandler) override;
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Execute script code contained in the given string.
|
|
|
|
*
|
|
|
|
* @param codes holding the valid script code that should be executed.
|
|
|
|
* @return 0 if the string is executed correctly, other if the string is executed wrongly.
|
|
|
|
*/
|
|
|
|
virtual int executeString(const char* codes) override;
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Execute a script file.
|
|
|
|
*
|
|
|
|
* @param filename String object holding the filename of the script file that is to be executed.
|
|
|
|
* @return the return values by calling executeFunction.
|
|
|
|
*/
|
|
|
|
virtual int executeScriptFile(const char* filename) override;
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Execute a scripted global function.
|
|
|
|
* The function should not take any parameters and should return an integer.
|
|
|
|
*
|
2021-12-25 10:04:45 +08:00
|
|
|
* @param functionName String object holding the name of the function, in the global script environment, that is to
|
|
|
|
* be executed.
|
2019-11-23 20:27:39 +08:00
|
|
|
* @return The integer value returned from the script function.
|
|
|
|
*/
|
|
|
|
virtual int executeGlobalFunction(const char* functionName) override;
|
|
|
|
virtual int executeNodeEvent(Node* pNode, int nAction);
|
|
|
|
virtual int executeMenuItemEvent(MenuItem* pMenuItem);
|
|
|
|
virtual int executeCallFuncActionEvent(CallFunc* pAction, Ref* pTarget = NULL);
|
|
|
|
virtual int executeSchedule(int nHandler, float dt, Node* pNode = NULL);
|
2021-12-25 10:04:45 +08:00
|
|
|
virtual int executeLayerTouchEvent(Layer* pLayer, int eventType, Touch* pTouch);
|
2019-11-23 20:27:39 +08:00
|
|
|
virtual int executeLayerKeypadEvent(Layer* pLayer, int eventType);
|
|
|
|
virtual int executeAccelerometerEvent(Layer* pLayer, Acceleration* pAccelerationValue);
|
2021-12-25 10:04:45 +08:00
|
|
|
virtual int executeEvent(int nHandler,
|
|
|
|
const char* pEventName,
|
|
|
|
Ref* pEventSource = NULL,
|
|
|
|
const char* pEventSourceClassName = NULL);
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Handle the assert message.
|
|
|
|
*
|
|
|
|
* @return return true if current _callFromLua of LuaStack is not equal to 0 otherwise return false.
|
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
virtual bool handleAssert(const char* msg) override;
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Parse the config information data.
|
2021-12-25 10:04:45 +08:00
|
|
|
*
|
2019-11-23 20:27:39 +08:00
|
|
|
* @param type in current mechanism,it always ConfigType::COCOSTUDIO.
|
|
|
|
* @param str the information data.
|
2021-12-25 10:04:45 +08:00
|
|
|
* @return if __onParseConfig function exist in the Lua, it return the value that _stack->executeFunction returns
|
|
|
|
* otherwise return false.
|
2019-11-23 20:27:39 +08:00
|
|
|
*/
|
2021-12-31 12:12:40 +08:00
|
|
|
virtual bool parseConfig(ConfigType type, std::string_view str) override;
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
2021-12-25 10:04:45 +08:00
|
|
|
* When some events triggered in the c++ also needs to pass on to lua to handle, we could call this function to send
|
|
|
|
* events.
|
2019-11-23 20:27:39 +08:00
|
|
|
*
|
|
|
|
* @param message the ScriptEvent object that has ScriptEventType and the pointer to information data.
|
2021-12-25 10:04:45 +08:00
|
|
|
* @return default return 0 otherwise return values the same as handleNodeEvent, handleMenuClickedEvent or
|
|
|
|
* handleCallFuncActionEvent,etc.
|
2019-11-23 20:27:39 +08:00
|
|
|
*/
|
2020-02-24 23:08:47 +08:00
|
|
|
virtual int sendEvent(const ScriptEvent& message) override;
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
2021-12-25 10:04:45 +08:00
|
|
|
* Pass on the events related with ScrollView,TableCell,AssertManager, Armature, Accelerometer, Keyboard, Touch,
|
|
|
|
* Touches ,Mouse and Custom event to lua to handle.
|
2019-11-23 20:27:39 +08:00
|
|
|
*
|
|
|
|
* @param type Different ScriptHandlerMgr::HandlerType means different processing for the data.
|
2021-12-25 10:04:45 +08:00
|
|
|
* @param data The pointer point to the information which should be pass on to lua, it would be parsed in the
|
|
|
|
* function to convert to the specific data according to the ScriptHandlerMgr::HandlerType,then pass to lua as
|
|
|
|
* function parameters.
|
2019-11-23 20:27:39 +08:00
|
|
|
* @return default return 0 otherwise return values according different ScriptHandlerMgr::HandlerType.
|
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
virtual int handleEvent(ScriptHandlerMgr::HandlerType type, void* data);
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Pass on the events related with TableCell and TableView to lua to handle.
|
|
|
|
*
|
|
|
|
* @param type Different ScriptHandlerMgr::HandlerType means different processing for the data.
|
2021-12-25 10:04:45 +08:00
|
|
|
* @param data The pointer point to the information which should be pass on to lua, it would be parsed in the
|
|
|
|
* function to convert to the specific data according to the ScriptHandlerMgr::HandlerType,then pass to lua as
|
|
|
|
* function parameters.
|
2019-11-23 20:27:39 +08:00
|
|
|
* @param numResults The number of the return values.
|
|
|
|
* @param func The callback would be called when numResults is > 0.
|
|
|
|
* @return default return 0 otherwise return values according different ScriptHandlerMgr::HandlerType.
|
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
virtual int handleEvent(ScriptHandlerMgr::HandlerType type,
|
|
|
|
void* data,
|
|
|
|
int numResults,
|
|
|
|
const std::function<void(lua_State*, int)>& func);
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
private:
|
2021-12-25 10:04:45 +08:00
|
|
|
LuaEngine(void) : _stack(nullptr) {}
|
2019-11-23 20:27:39 +08:00
|
|
|
bool init(void);
|
|
|
|
int handleNodeEvent(void* data);
|
|
|
|
int handleMenuClickedEvent(void* data);
|
|
|
|
int handleCallFuncActionEvent(void* data);
|
|
|
|
int handleScheduler(void* data);
|
|
|
|
int handleKeypadEvent(void* data);
|
|
|
|
int handleAccelerometerEvent(void* data);
|
|
|
|
int handleCommonEvent(void* data);
|
|
|
|
int handleTouchEvent(void* data);
|
|
|
|
int handleTouchesEvent(void* data);
|
|
|
|
int handlerControlEvent(void* data);
|
|
|
|
int handleEvenCustom(void* data);
|
2021-12-25 10:04:45 +08:00
|
|
|
int handleAssetsManagerEvent(ScriptHandlerMgr::HandlerType type, void* data);
|
|
|
|
int handleTableViewEvent(ScriptHandlerMgr::HandlerType type, void* data);
|
|
|
|
int handleTableViewEvent(ScriptHandlerMgr::HandlerType type,
|
|
|
|
void* data,
|
|
|
|
int numResults,
|
|
|
|
const std::function<void(lua_State*, int)>& func);
|
|
|
|
int handleArmatureWrapper(ScriptHandlerMgr::HandlerType type, void* data);
|
2019-11-23 20:27:39 +08:00
|
|
|
int handleEventAcc(void* data);
|
2021-12-25 10:04:45 +08:00
|
|
|
int handleEventKeyboard(ScriptHandlerMgr::HandlerType type, void* data);
|
2019-11-23 20:27:39 +08:00
|
|
|
int handleEventTouch(ScriptHandlerMgr::HandlerType type, void* data);
|
|
|
|
int handleEventTouches(ScriptHandlerMgr::HandlerType type, void* data);
|
|
|
|
int handleEventMouse(ScriptHandlerMgr::HandlerType type, void* data);
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
private:
|
|
|
|
static LuaEngine* _defaultEngine;
|
2021-12-25 10:04:45 +08:00
|
|
|
LuaStack* _stack;
|
2019-11-23 20:27:39 +08:00
|
|
|
};
|
|
|
|
|
2022-07-11 17:50:21 +08:00
|
|
|
NS_AX_END
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
// end group
|
|
|
|
/// @}
|
|
|
|
|
2022-07-16 10:43:05 +08:00
|
|
|
#endif // __AX_LUA_ENGINE_H__
|