ServerScriptEngine.h

Go to the documentation of this file.

 
// =============================================================================
// This file is adopted from rorserver at commit 4a7109ae2d9a081ccfdad8cc696dc54efe49acb3
// Changes from the original are marked with "//RIGSOFRODS"
// =============================================================================
 
/*
This file is part of "Rigs of Rods Server" (Relay mode)
 
Copyright 2007   Pierre-Michel Ricordel
Copyright 2014+  Rigs of Rods Community
 
"Rigs of Rods Server" is free software: you can redistribute it
and/or modify it under the terms of the GNU General Public License
as published by the Free Software Foundation, either version 3
of the License, or (at your option) any later version.
 
"Rigs of Rods Server" is distributed in the hope that it will
be useful, but WITHOUT ANY WARRANTY; without even the implied
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with Foobar. If not, see <http://www.gnu.org/licenses/>.
*/
 
#pragma once
 
#ifdef USE_ANGELSCRIPT
 
#include "ServerScriptCurlHelpers.h"
#include "ServerScriptLogger.h"
#include "ServerScriptSequencer.h"
#include "ServerScript.h"
#include <map>
#include <mutex>
#include <thread>
#include <vector>
#include "angelscript.h"
#include "RoRnet.h"
 
namespace RoR { // RIGSOFRODS
 
struct rorserver_callback_t {
    AngelScript::asIScriptObject *obj{nullptr};  
    AngelScript::asIScriptFunction *func{nullptr}; 
};
typedef std::vector<rorserver_callback_t> callbackList;
 
 
class ServerScriptEngine {
public:
    enum class ThreadState
    {
        NOT_RUNNING,
        RUNNING,
        STOP_REQUESTED
    };
 
    ServerScriptEngine(ServerScriptSequencer* sequencer);
 
    ~ServerScriptEngine();
 
    int loadScript(std::string scriptName);
 
    void unloadScript(); // RIGSOFRODS: Unload the script (only one can run at a time).
 
 
    void playerDeleted(int uid, int crash = 0);
 
    void playerAdded(RoRnet::UserInfo& user);
 
    int streamAdded(int uid, RoRnet::StreamRegister *reg);
 
    int playerChat(int uid, std::string msg);
 
    void gameCmd(int uid, const std::string &cmd);
 
    void curlStatus(ServerScriptCurlStatusType type, int n1, int n2, std::string displayname, std::string message);
 
    int frameStep(float dt);
 
 
    AngelScript::asIScriptEngine *getEngine() { return engine; };
 
    void setException(const std::string &message);
 
    void addCallback(const std::string &type, AngelScript::asIScriptFunction *func, AngelScript::asIScriptObject *obj);
 
    void addCallbackScript(const std::string &type, const std::string &func, AngelScript::asIScriptObject *obj);
 
    void deleteCallback(const std::string &type, AngelScript::asIScriptFunction *func, AngelScript::asIScriptObject *obj);
 
    void deleteCallbackScript(const std::string &type, const std::string &_func, AngelScript::asIScriptObject *obj);
 
    void deleteAllCallbacks();
 
    bool callbackExists(const std::string &type, AngelScript::asIScriptFunction *func, AngelScript::asIScriptObject *obj);
 
    // Timer thread control
    void        EnsureTimerThreadRunning();
    void        StopTimerThread();
    ThreadState GetTimerThreadState();
 
protected:
    ServerScriptSequencer* seq;
    AngelScript::asIScriptEngine *engine;                
    AngelScript::asIScriptContext *context;              
    std::map<std::string, callbackList> callbacks; 
 
    // Timer thread context
    std::thread m_timer_thread;
    ThreadState m_timer_thread_state = ThreadState::NOT_RUNNING;
    std::mutex  m_timer_thread_mutex;
 
    void init();
 
    void msgCallback(const AngelScript::asSMessageInfo *msg);
 
    void ExceptionCallback(AngelScript::asIScriptContext *ctx, void *param);
 
    void PrintVariables(AngelScript::asIScriptContext *ctx, int stackLevel);
 
    void LineCallback(AngelScript::asIScriptContext *ctx, void *param);
 
    void TimerThreadMain();
};
 
} // namespace RoR
 
#endif // USE_ANGELSCRIPT