axmol/extensions/scripting/lua-bindings/manual/CCComponentLua.cpp

271 lines
9.7 KiB
C++
Raw Normal View History

2019-11-23 20:27:39 +08:00
/****************************************************************************
Copyright (c) 2015-2016 Chukong Technologies Inc.
Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.
2021-12-25 10:04:45 +08:00
2019-11-23 20:27:39 +08:00
http://www.cocos2d-x.org
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.
****************************************************************************/
#include "scripting/lua-bindings/manual/CCComponentLua.h"
#include <string>
#include "base/CCScriptSupport.h"
#include "platform/CCFileUtils.h"
#include "scripting/lua-bindings/manual/CCLuaEngine.h"
#include "scripting/lua-bindings/manual/LuaBasicConversions.h"
#include "base/ccUTF8.h"
2019-11-23 20:27:39 +08:00
NS_CC_BEGIN
const std::string ComponentLua::ON_ENTER = "onEnter";
2021-12-25 10:04:45 +08:00
const std::string ComponentLua::ON_EXIT = "onExit";
const std::string ComponentLua::UPDATE = "update";
2019-11-23 20:27:39 +08:00
2021-12-25 10:04:45 +08:00
#define KEY_COMPONENT "component"
2019-11-23 20:27:39 +08:00
2021-12-25 10:04:45 +08:00
namespace
{
2021-12-31 11:00:35 +08:00
void adjustScriptFileName(std::string& scriptFileName)
2021-12-25 10:04:45 +08:00
{
assert(scriptFileName.size() > 4);
auto fileUtils = FileUtils::getInstance();
if (fileUtils->isFileExist(scriptFileName))
return;
const std::string luaSuffix(".lua");
const std::string luacSuffix(".luac");
// xxx.lua -> xxx.luac or
// xxx.luac -> xxx.lua
2021-12-31 11:00:35 +08:00
if (scriptFileName.compare(scriptFileName.size() - luaSuffix.size(), luaSuffix.size(), luaSuffix) == 0)
scriptFileName.replace(scriptFileName.size() - luaSuffix.size(), luaSuffix.size(), luacSuffix);
2021-12-25 10:04:45 +08:00
else
2021-12-31 11:00:35 +08:00
scriptFileName.replace(scriptFileName.size() - luacSuffix.size(), luacSuffix.size(), luaSuffix);
2019-11-23 20:27:39 +08:00
}
2021-12-25 10:04:45 +08:00
} // namespace
2019-11-23 20:27:39 +08:00
int ComponentLua::_index = 0;
2021-12-31 11:00:35 +08:00
ComponentLua* ComponentLua::create(const std::string& scriptFileName)
2019-11-23 20:27:39 +08:00
{
CC_ASSERT(!scriptFileName.empty());
2021-12-25 10:04:45 +08:00
2019-11-23 20:27:39 +08:00
initClass();
2021-12-25 10:04:45 +08:00
2021-12-31 11:00:35 +08:00
adjustScriptFileName(const_cast<std::string&>(scriptFileName));
2021-12-08 00:11:53 +08:00
auto componentLua = new ComponentLua(scriptFileName);
2019-11-23 20:27:39 +08:00
if (componentLua)
{
componentLua->autorelease();
}
2021-12-25 10:04:45 +08:00
2019-11-23 20:27:39 +08:00
return componentLua;
}
2021-12-31 11:00:35 +08:00
ComponentLua::ComponentLua(const std::string& scriptFileName)
2021-12-25 10:04:45 +08:00
: _scriptFileName(scriptFileName), _table(nullptr), _strIndex("")
2019-11-23 20:27:39 +08:00
{
_succeedLoadingScript = loadAndExecuteScript();
}
ComponentLua::~ComponentLua()
{
removeLuaTable();
}
void ComponentLua::getScriptObjectInternal() const
{
2021-12-25 10:04:45 +08:00
lua_State* l = LuaEngine::getInstance()->getLuaStack()->getLuaState();
2019-11-23 20:27:39 +08:00
lua_pushstring(l, KEY_COMPONENT); // stack: "component"
lua_rawget(l, LUA_REGISTRYINDEX); // stack: LUA_REGISTRYINDEX["component"]
lua_pushstring(l, _strIndex.c_str()); // stack: LUA_REGISTRYINDEX["component"] strIndex
lua_rawget(l, -2); // stack: LUA_REGISTRYINDEX["component"]
}
void* ComponentLua::getScriptObject() const
{
getScriptObjectInternal();
return nullptr;
}
void ComponentLua::update(float delta)
{
if (_succeedLoadingScript && getLuaFunction(ComponentLua::UPDATE))
{
getUserData();
2021-12-25 10:04:45 +08:00
lua_State* l = LuaEngine::getInstance()->getLuaStack()->getLuaState();
2019-11-23 20:27:39 +08:00
lua_pushnumber(l, delta);
LuaEngine::getInstance()->getLuaStack()->executeFunction(2);
}
}
void ComponentLua::onEnter()
{
if (_succeedLoadingScript && getLuaFunction(ComponentLua::ON_ENTER))
{
getUserData();
LuaEngine::getInstance()->getLuaStack()->executeFunction(1);
}
}
void ComponentLua::onExit()
{
if (_succeedLoadingScript && getLuaFunction(ComponentLua::ON_EXIT))
{
getUserData();
LuaEngine::getInstance()->getLuaStack()->executeFunction(1);
}
}
2021-12-31 11:00:35 +08:00
bool ComponentLua::getLuaFunction(const std::string& functionName)
2019-11-23 20:27:39 +08:00
{
2021-12-25 10:04:45 +08:00
lua_State* l = LuaEngine::getInstance()->getLuaStack()->getLuaState();
2021-12-31 11:00:35 +08:00
lua_pushstring(l, KEY_COMPONENT); // stack: "component"
lua_rawget(l, LUA_REGISTRYINDEX); // stack: table_of_component
lua_pushstring(l, _strIndex.c_str()); // stack: table_of_component strIndex
lua_rawget(l, -2); // stack: table_of_component table_of_this
lua_pushstring(l, functionName.c_str()); // stack: table_of_component table_of_this "update"
lua_rawget(l, -2); // stack: table_of_component table_of_this table_of_this["update"]
lua_remove(l, -2); // stack: table_of_component table_of_this["update"]
lua_remove(l, -2); // stack: table_of_this["update"]
2021-12-25 10:04:45 +08:00
2019-11-23 20:27:39 +08:00
int type = lua_type(l, -1);
2021-12-25 10:04:45 +08:00
// if (type != LUA_TFUNCTION)
// {
// CCLOG("can not get %s function from %s", functionName.c_str(), _scriptFileName.c_str());
// }
2019-11-23 20:27:39 +08:00
return type == LUA_TFUNCTION;
}
bool ComponentLua::loadAndExecuteScript()
{
// register native functions
2021-12-25 10:04:45 +08:00
auto engine = LuaEngine::getInstance();
lua_State* l = engine->getLuaStack()->getLuaState();
2019-11-23 20:27:39 +08:00
// load script
2021-12-25 10:04:45 +08:00
auto fileUtils = FileUtils::getInstance();
2019-11-23 20:27:39 +08:00
std::string fullPathOfScript = fileUtils->fullPathForFilename(_scriptFileName);
2021-12-25 10:04:45 +08:00
Data data = fileUtils->getDataFromFile(fullPathOfScript);
int error = LUA_ERRFILE;
if (data.getSize() > 0)
error = engine->getLuaStack()->luaLoadBuffer(l, (const char*)data.getBytes(), (int)data.getSize(),
fullPathOfScript.c_str());
2019-11-23 20:27:39 +08:00
if (error)
{
CCLOG("ComponentLua::loadAndExecuteScript: %s", lua_tostring(l, -1));
lua_pop(l, 1);
return false;
}
2021-12-25 10:04:45 +08:00
2019-11-23 20:27:39 +08:00
// execute script
error = lua_pcall(l, 0, 1, 0);
if (error)
{
CCLOG("ComponentLua::loadAndExecuteScript: %s", lua_tostring(l, -1));
lua_pop(l, 1);
return false;
}
2021-12-25 10:04:45 +08:00
2019-11-23 20:27:39 +08:00
// check the return value from lua script is a table
int type = lua_type(l, -1);
if (type != LUA_TTABLE)
{
CCLOG("%s should return a table, or the script component can not work currectly", _scriptFileName.c_str());
return false;
}
2021-12-25 10:04:45 +08:00
2019-11-23 20:27:39 +08:00
storeLuaTable();
return true;
}
void ComponentLua::initClass()
{
static bool run = true;
if (run)
{
// LUA_REGISTRYINDEX["component"] = new table
2021-12-25 10:04:45 +08:00
2019-11-23 20:27:39 +08:00
LuaEngine* engine = LuaEngine::getInstance();
2021-12-25 10:04:45 +08:00
lua_State* l = engine->getLuaStack()->getLuaState();
lua_pushstring(l, KEY_COMPONENT); // stack: "component"
lua_newtable(l); // stack: "component" table
lua_rawset(l, LUA_REGISTRYINDEX); // stack: -
2019-11-23 20:27:39 +08:00
run = false;
}
}
void ComponentLua::storeLuaTable()
{
2021-12-25 10:04:45 +08:00
lua_State* l = LuaEngine::getInstance()->getLuaStack()->getLuaState();
2019-11-23 20:27:39 +08:00
_index++;
_strIndex.append(StringUtils::toString(_index));
2021-12-25 10:04:45 +08:00
2019-11-23 20:27:39 +08:00
// LUA_REGISTRYINDEX["component"][strIndex] = table return from lua
2021-12-25 10:04:45 +08:00
lua_pushstring(l, KEY_COMPONENT); // stack: table_return_from_lua "component"
lua_rawget(l, LUA_REGISTRYINDEX); // stack: table_return_from_lua table_of_component
lua_pushstring(l, _strIndex.c_str()); // stack: table_return_from_lua table_of_component strIndex
lua_pushvalue(l, -3); // stack: table_return_from_lua table_of_component strIndex table_return_from_lua
lua_rawset(l, -3); // stack: table_return_from_lua table_of_component
lua_pop(l, 1); // stack: table_return_from_lua
2019-11-23 20:27:39 +08:00
// add table's elements to userdata's metatable
object_to_luaval<cocos2d::ComponentLua>(l, "cc.ComponentLua", this); // stack: table_return_from_lua userdata
2021-12-25 10:04:45 +08:00
lua_getmetatable(l, -1); // stack: table_return_from_lua userdata mt
lua_remove(l, -2); // stack: table_return_from_lua mt
lua_pushnil(l); // stack: table_return_from_lua mt nil
while (lua_next(l, -3)) // stack: table_return_from_lua mt key value
2019-11-23 20:27:39 +08:00
{
2021-12-25 10:04:45 +08:00
lua_pushvalue(l, -2); // stack: table_return_from_lua mt key value key
lua_insert(l, -2); // stack: table_return_from_lua mt key key value
lua_rawset(l, -4); // stack: table_return_from_lua mt key
2019-11-23 20:27:39 +08:00
}
lua_pop(l, 2);
}
void ComponentLua::removeLuaTable()
{
if (_succeedLoadingScript)
{
// LUA_REGISTRYINDEX["component"][strIndex] = nil
2021-12-25 10:04:45 +08:00
lua_State* l = LuaEngine::getInstance()->getLuaStack()->getLuaState();
2019-11-23 20:27:39 +08:00
lua_pushstring(l, KEY_COMPONENT); // stack: "component"
lua_rawget(l, LUA_REGISTRYINDEX); // stack: LUA_REGISTRYINDEX["component"]
lua_pushstring(l, _strIndex.c_str()); // stack: LUA_REGISTRYINDEX["component"] strIndex
lua_pushnil(l); // stack: LUA_REGISTRYINDEX["component"] strIndex nil
lua_rawset(l, -3); // stack: LUA_REGISTRYINDEX["component"]
}
}
void ComponentLua::getUserData()
{
2021-12-25 10:04:45 +08:00
lua_State* l = LuaEngine::getInstance()->getLuaStack()->getLuaState();
object_to_luaval<cocos2d::ComponentLua>(l, "cc.ComponentLua", this);
2019-11-23 20:27:39 +08:00
}
NS_CC_END