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

/****************************************************************************
 Copyright (c) 2015-2016 Chukong Technologies Inc.
 Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.

 https://adxeproject.github.io/

 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 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"

NS_CC_BEGIN

const std::string ComponentLua::ON_ENTER = "onEnter";
const std::string ComponentLua::ON_EXIT  = "onExit";
const std::string ComponentLua::UPDATE   = "update";

#define KEY_COMPONENT "component"

namespace
{
void adjustScriptFileName(std::string_view& scriptFileName, std::string& holder)
{
    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
    holder = scriptFileName;
    if (holder.compare(holder.size() - luaSuffix.size(), luaSuffix.size(), luaSuffix) == 0)
        holder.replace(holder.size() - luaSuffix.size(), luaSuffix.size(), luacSuffix);
    else
        holder.replace(holder.size() - luacSuffix.size(), luacSuffix.size(), luaSuffix);

    scriptFileName = holder;
}
}  // namespace

int ComponentLua::_index = 0;

ComponentLua* ComponentLua::create(std::string_view scriptFileName)
{
    CC_ASSERT(!scriptFileName.empty());

    initClass();

    std::string holder;
    adjustScriptFileName(scriptFileName, holder);
    auto componentLua = new ComponentLua(scriptFileName);
    if (componentLua)
    {
        componentLua->autorelease();
    }

    return componentLua;
}

ComponentLua::ComponentLua(std::string_view scriptFileName)
    : _scriptFileName(scriptFileName), _table(nullptr), _strIndex("")
{
    _succeedLoadingScript = loadAndExecuteScript();
}

ComponentLua::~ComponentLua()
{
    removeLuaTable();
}

void ComponentLua::getScriptObjectInternal() const
{
    lua_State* l = LuaEngine::getInstance()->getLuaStack()->getLuaState();
    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();
        lua_State* l = LuaEngine::getInstance()->getLuaStack()->getLuaState();
        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);
    }
}

bool ComponentLua::getLuaFunction(std::string_view functionName)
{
    lua_State* l = LuaEngine::getInstance()->getLuaStack()->getLuaState();

    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_pushlstring(l, functionName.data(), functionName.length());  // 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"]

    int type = lua_type(l, -1);
    //    if (type != LUA_TFUNCTION)
    //    {
    //        CCLOG("can not get %s function from %s", functionName.c_str(), _scriptFileName.c_str());
    //    }

    return type == LUA_TFUNCTION;
}

bool ComponentLua::loadAndExecuteScript()
{
    // register native functions
    auto engine  = LuaEngine::getInstance();
    lua_State* l = engine->getLuaStack()->getLuaState();

    // load script
    auto fileUtils               = FileUtils::getInstance();
    std::string fullPathOfScript = fileUtils->fullPathForFilename(_scriptFileName);
    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());
    if (error)
    {
        CCLOG("ComponentLua::loadAndExecuteScript: %s", lua_tostring(l, -1));
        lua_pop(l, 1);
        return false;
    }

    // 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;
    }

    // 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;
    }

    storeLuaTable();
    return true;
}

void ComponentLua::initClass()
{
    static bool run = true;
    if (run)
    {
        // LUA_REGISTRYINDEX["component"] = new table

        LuaEngine* engine = LuaEngine::getInstance();
        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: -

        run = false;
    }
}

void ComponentLua::storeLuaTable()
{
    lua_State* l = LuaEngine::getInstance()->getLuaStack()->getLuaState();

    _index++;
    _strIndex.append(StringUtils::toString(_index));

    // LUA_REGISTRYINDEX["component"][strIndex] = table return from lua
    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

    // add table's elements to userdata's metatable
    object_to_luaval<cocos2d::ComponentLua>(l, "cc.ComponentLua", this);  // stack: table_return_from_lua userdata
    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
    {
        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
    }
    lua_pop(l, 2);
}

void ComponentLua::removeLuaTable()
{
    if (_succeedLoadingScript)
    {
        // LUA_REGISTRYINDEX["component"][strIndex] = nil

        lua_State* l = LuaEngine::getInstance()->getLuaStack()->getLuaState();

        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()
{
    lua_State* l = LuaEngine::getInstance()->getLuaStack()->getLuaState();
    object_to_luaval<cocos2d::ComponentLua>(l, "cc.ComponentLua", this);
}

NS_CC_END