OpenSpace/src/scripting/scriptscheduler_lua.inl

/*****************************************************************************************
 *                                                                                       *
 * OpenSpace                                                                             *
 *                                                                                       *
 * Copyright (c) 2014-2021                                                               *
 *                                                                                       *
 * 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 <openspace/engine/globals.h>

namespace openspace::luascriptfunctions {

int loadFile(lua_State* L) {
    ghoul::lua::checkArgumentsAndThrow(L, 1, "lua::loadFile");

    const std::string& fileName = ghoul::lua::value<std::string>(
        L,
        1,
        ghoul::lua::PopValue::Yes
    );
    if (fileName.empty()) {
        return ghoul::lua::luaError(L, "filepath string is empty");
    }

    ghoul::Dictionary scriptsDict = ghoul::lua::loadDictionaryFromFile(fileName, L);
    documentation::testSpecificationAndThrow(
        scripting::ScriptScheduler::Documentation(),
        scriptsDict,
        "ScriptScheduler"
    );


    std::vector<scripting::ScriptScheduler::ScheduledScript> scripts;
    for (int i = 1; i <= scriptsDict.size(); ++i) {
        ghoul::Dictionary d = scriptsDict.value<ghoul::Dictionary>(std::to_string(i));

        scripting::ScriptScheduler::ScheduledScript script;
        constexpr const char* KeyTime = "Time";
        if (d.hasValue<std::string>(KeyTime)) {
            script.time = Time::convertTime(d.value<std::string>(KeyTime));
        }
        constexpr const char* KeyForwardScript = "ForwardScript";
        if (d.hasValue<std::string>(KeyForwardScript)) {
            script.forwardScript = d.value<std::string>(KeyForwardScript);
        }
        constexpr const char* KeyBackwardScript = "BackwardScript";
        if (d.hasValue<std::string>(KeyBackwardScript)) {
            script.backwardScript = d.value<std::string>(KeyBackwardScript);
        }
        constexpr const char* KeyUniversalScript = "Script";
        if (d.hasValue<std::string>(KeyUniversalScript)) {
            script.universalScript = d.value<std::string>(KeyUniversalScript);
        }
        scripts.push_back(script);
    }

    global::scriptScheduler->loadScripts(scripts);

    ghoul_assert(lua_gettop(L) == 0, "Incorrect number of items left on stack");
    return 0;
}

int loadScheduledScript(lua_State* L) {
    int nArguments = ghoul::lua::checkArgumentsAndThrow(
        L,
        { 2, 4 },
        "lua::loadScheduledScript"
    );

    scripting::ScriptScheduler::ScheduledScript script;

    std::string time = ghoul::lua::value<std::string>(L, 1);
    script.time = Time::convertTime(time);
    std::string forwardScript = ghoul::lua::value<std::string>(L, 2);
    script.forwardScript = std::move(forwardScript);

    if (nArguments == 3) {
        std::string backwardScript = ghoul::lua::value<std::string>(L, 3);
        script.backwardScript = std::move(backwardScript);
    }
    else if (nArguments == 4) {
        std::string backwardScript = ghoul::lua::value<std::string>(L, 3);
        script.backwardScript = std::move(backwardScript);
        std::string universalScript = ghoul::lua::value<std::string>(L, 4);
        script.universalScript = std::move(universalScript);
    }
    std::vector<scripting::ScriptScheduler::ScheduledScript> scripts;
    scripts.push_back(std::move(script));
    global::scriptScheduler->loadScripts(scripts);

    lua_settop(L, 0);

    ghoul_assert(lua_gettop(L) == 0, "Incorrect number of items left on stack");
    return 0;
}

int setModeApplicationTime(lua_State* L) {
    ghoul::lua::checkArgumentsAndThrow(L, 0, "lua::setModeApplicationTime");

    global::scriptScheduler->setModeApplicationTime();

    ghoul_assert(lua_gettop(L) == 0, "Incorrect number of items left on stack");
    return 0;
}

int setModeRecordedTime(lua_State* L) {
    ghoul::lua::checkArgumentsAndThrow(L, 0, "lua::setModeRecordedTime");

    global::scriptScheduler->setModeRecordedTime();

    ghoul_assert(lua_gettop(L) == 0, "Incorrect number of items left on stack");
    return 0;
}

int setModeSimulationTime(lua_State* L) {
    ghoul::lua::checkArgumentsAndThrow(L, 0, "lua::setModeSimulationTime");

    global::scriptScheduler->setModeSimulationTime();

    ghoul_assert(lua_gettop(L) == 0, "Incorrect number of items left on stack");
    return 0;
}

int clear(lua_State* L) {
    ghoul::lua::checkArgumentsAndThrow(L, 0, "lua::clear");

    global::scriptScheduler->clearSchedule();

    ghoul_assert(lua_gettop(L) == 0, "Incorrect number of items left on stack");
    return 0;
}

} // namespace openspace::luascriptfunction