2019-11-23 20:27:39 +08:00
|
|
|
/****************************************************************************
|
|
|
|
Copyright (c) 2011-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-07-10 09:47:41 +08:00
|
|
|
https://axis-project.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.
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
#ifndef __CC_LUA_STACK_H_
|
|
|
|
#define __CC_LUA_STACK_H_
|
|
|
|
|
|
|
|
extern "C" {
|
|
|
|
#include "lua.h"
|
|
|
|
}
|
|
|
|
|
|
|
|
#include "scripting/lua-bindings/manual/CCLuaValue.h"
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @addtogroup lua
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
2022-07-11 17:50:21 +08:00
|
|
|
NS_AX_BEGIN
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
/**
|
2021-12-25 10:04:45 +08:00
|
|
|
* LuaStack is used to manager the operation on the lua_State,eg., push data onto the lua_State, execute the function
|
|
|
|
* depended on the lua_State. In the current mechanism, there is only one lua_State in one LuaStack object.
|
2019-11-23 20:27:39 +08:00
|
|
|
*
|
|
|
|
* @lua NA
|
|
|
|
* @js NA
|
|
|
|
*/
|
|
|
|
class LuaStack : public Ref
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
/**
|
|
|
|
* Create a LuaStack object, it will new a lua_State.
|
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
static LuaStack* create();
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Create a LuaStack object with the existed lua_State.
|
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
static LuaStack* attach(lua_State* L);
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/** Destructor. */
|
|
|
|
virtual ~LuaStack();
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Method used to get a pointer to the lua_State that the script module is attached to.
|
|
|
|
*
|
|
|
|
* @return A pointer to the lua_State that the script module is attached to.
|
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
lua_State* getLuaState() { return _state; }
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Add a path to find lua files in.
|
|
|
|
*
|
|
|
|
* @param path to be added to the Lua search 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.
|
2021-12-25 10:04:45 +08:00
|
|
|
*
|
2019-11-23 20:27:39 +08:00
|
|
|
* @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.
|
2019-11-23 20:27:39 +08:00
|
|
|
*
|
2021-12-25 10:04:45 +08:00
|
|
|
* 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);
|
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);
|
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);
|
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);
|
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);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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);
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Set the stack top index 0.
|
|
|
|
*/
|
|
|
|
virtual void clean();
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Pushes a integer number with value intValue onto the stack.
|
2021-12-25 10:04:45 +08:00
|
|
|
*
|
2019-11-23 20:27:39 +08:00
|
|
|
* @param intValue a integer number.
|
|
|
|
*/
|
|
|
|
virtual void pushInt(int intValue);
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Pushes a float number with value floatValue onto the stack.
|
|
|
|
*
|
|
|
|
* @param floatValue a float number.
|
|
|
|
*/
|
|
|
|
virtual void pushFloat(float floatValue);
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Pushes a long number with value longValue onto the stack.
|
2021-12-25 10:04:45 +08:00
|
|
|
*
|
2019-11-23 20:27:39 +08:00
|
|
|
* @param longValue a long number.
|
|
|
|
*/
|
|
|
|
virtual void pushLong(long longValue);
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Pushes a bool value with boolValue onto the stack.
|
2021-12-25 10:04:45 +08:00
|
|
|
*
|
2019-11-23 20:27:39 +08:00
|
|
|
* @param boolValue a bool value.
|
|
|
|
*/
|
|
|
|
virtual void pushBoolean(bool boolValue);
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Pushes the zero-terminated string pointed to by stringValue onto the stack.
|
|
|
|
*
|
|
|
|
* @param stringValue a pointer point to a zero-terminated string stringValue.
|
|
|
|
*/
|
2021-12-31 12:12:40 +08:00
|
|
|
virtual void pushString(std::string_view stringValue);
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Pushes the string pointed to by stringValue with size length onto the stack.
|
|
|
|
*
|
|
|
|
* @param stringValue a pointer point to the string stringValue.
|
|
|
|
* @param length the size.
|
|
|
|
*/
|
|
|
|
virtual void pushString(const char* stringValue, int length);
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Pushes a nil value onto the stack.
|
|
|
|
*/
|
|
|
|
virtual void pushNil();
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Pushes a Ref object onto the stack.
|
|
|
|
*
|
|
|
|
* @see toluafix_pushusertype_ccobject.
|
|
|
|
*/
|
|
|
|
virtual void pushObject(Ref* objectValue, const char* typeName);
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* According to the type of LuaValue, it would called the other push function in the internal.
|
|
|
|
* type function
|
|
|
|
* LuaValueTypeInt pushInt
|
|
|
|
* LuaValueTypeFloat pushFloat
|
|
|
|
* LuaValueTypeBoolean pushBoolean
|
|
|
|
* LuaValueTypeString pushString
|
|
|
|
* LuaValueTypeDict pushLuaValueDict
|
|
|
|
* LuaValueTypeArray pushLuaValueArray
|
|
|
|
* LuaValueTypeObject pushObject
|
2021-12-25 10:04:45 +08:00
|
|
|
*
|
2019-11-23 20:27:39 +08:00
|
|
|
* @param value a LuaValue object.
|
|
|
|
*/
|
|
|
|
virtual void pushLuaValue(const LuaValue& value);
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Pushes a lua table onto the stack.
|
|
|
|
* The key of table is the key of LuaValueDict which is std::map.
|
2021-12-25 10:04:45 +08:00
|
|
|
* The value of table is according to the type of LuaValue of LuaValueDict by calling pushLuaValue,@see
|
|
|
|
* pushLuaValue.
|
2019-11-23 20:27:39 +08:00
|
|
|
*
|
|
|
|
* @param dict a LuaValueDict object.
|
|
|
|
*/
|
|
|
|
virtual void pushLuaValueDict(const LuaValueDict& dict);
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Pushes a lua array table onto the stack.
|
|
|
|
* The index of array table is begin at 1.
|
2021-12-25 10:04:45 +08:00
|
|
|
* The value of array table is according to the type of LuaValue of LuaValueDict by calling pushLuaValue,@see
|
|
|
|
* pushLuaValue.
|
2019-11-23 20:27:39 +08:00
|
|
|
*/
|
|
|
|
virtual void pushLuaValueArray(const LuaValueArray& array);
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Get the lua function pointer from toluafix_refid_function_mapping table by giving nHanlder.
|
2021-12-25 10:04:45 +08:00
|
|
|
* If the lua function pointer corresponding to the nHanlder isn't found, it would push nil on the top index of
|
|
|
|
* stack, then it would output the error log in the debug model.
|
2019-11-23 20:27:39 +08:00
|
|
|
*
|
|
|
|
* @return true if get the no-null function pointer otherwise false.
|
|
|
|
*/
|
|
|
|
virtual bool pushFunctionByHandler(int nHandler);
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Execute the lua function on the -(numArgs + 1) index on the stack by the numArgs variables passed.
|
|
|
|
*
|
|
|
|
* @param numArgs the number of variables.
|
2021-12-25 10:04:45 +08:00
|
|
|
* @return 0 if it happen the error or it hasn't return value, otherwise it return the value by calling the lua
|
|
|
|
* function.
|
2019-11-23 20:27:39 +08:00
|
|
|
*/
|
|
|
|
virtual int executeFunction(int numArgs);
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Execute the lua function corresponding to the nHandler by the numArgs variables passed.
|
|
|
|
*
|
|
|
|
* @param nHandler the index count corresponding to the lua function.
|
|
|
|
* @param numArgs the number of variables.
|
|
|
|
* @return the return value is the same as executeFunction,please @see executeFunction.
|
|
|
|
*/
|
|
|
|
virtual int executeFunctionByHandler(int nHandler, int numArgs);
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Execute the lua function corresponding to the handler by the numArgs variables passed.
|
|
|
|
* By calling this function, the number of return value is numResults(may be > 1).
|
|
|
|
* All the return values are used in the callback func.
|
|
|
|
*
|
|
|
|
* @param handler the index count corresponding to the lua function.
|
|
|
|
* @param numArgs the number of variables.
|
|
|
|
* @param numResults the number of return value.
|
|
|
|
* @param func callback function which is called if the numResults > 0.
|
|
|
|
* @return 0 if it happen error or it hasn't return value, otherwise return 1.
|
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
virtual int executeFunction(int handler,
|
|
|
|
int numArgs,
|
|
|
|
int numResults,
|
|
|
|
const std::function<void(lua_State*, int)>& func);
|
|
|
|
|
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);
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
2021-12-25 10:04:45 +08:00
|
|
|
* Loads a buffer as a Lua chunk.This function uses lua_load to load the Lua chunk in the buffer pointed to by chunk
|
|
|
|
* with size chunkSize. If it supports xxtea encryption algorithm, the chunk and the chunkSize would be processed by
|
|
|
|
* calling xxtea_decrypt to the real buffer and buffer size.
|
2019-11-23 20:27:39 +08:00
|
|
|
*
|
|
|
|
* @param L the current lua_State.
|
|
|
|
* @param chunk the buffer pointer.
|
|
|
|
* @param chunkSize the size of buffer.
|
|
|
|
* @param chunkName the name of chunk pointer.
|
|
|
|
* @return 0, LUA_ERRSYNTAX or LUA_ERRMEM:.
|
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
int luaLoadBuffer(lua_State* L, const char* chunk, int chunkSize, const char* chunkName);
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Load the Lua chunks from the zip file
|
2021-12-25 10:04:45 +08:00
|
|
|
*
|
2019-11-23 20:27:39 +08:00
|
|
|
* @param zipFilePath file path to zip file.
|
|
|
|
* @return 1 if load successfully otherwise 0.
|
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
int loadChunksFromZIP(const char* zipFilePath);
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Load the Lua chunks from current lua_State.
|
|
|
|
*
|
|
|
|
* @param L the current lua_State.
|
|
|
|
* @return 1 if load successfully otherwise 0.
|
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
int luaLoadChunksFromZIP(lua_State* L);
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
protected:
|
2021-12-25 10:04:45 +08:00
|
|
|
LuaStack() : _state(nullptr), _callFromLua(0) {}
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
bool init();
|
2021-12-25 10:04:45 +08:00
|
|
|
bool initWithLuaState(lua_State* L);
|
|
|
|
|
|
|
|
lua_State* _state;
|
2019-11-23 20:27:39 +08:00
|
|
|
int _callFromLua;
|
|
|
|
};
|
|
|
|
|
2022-07-11 17:50:21 +08:00
|
|
|
NS_AX_END
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
// end group
|
|
|
|
/// @}
|
2021-12-25 10:04:45 +08:00
|
|
|
#endif // __CC_LUA_STACK_H_
|