/***************************************************************************** * Copyright (c) 2014-2020 OpenRCT2 developers * * For a complete list of all authors, please refer to contributors.md * Interested in contributing? Visit https://github.com/OpenRCT2/OpenRCT2 * * OpenRCT2 is licensed under the GNU General Public License version 3. *****************************************************************************/ #pragma once #ifdef ENABLE_SCRIPTING # include "../common.h" # include "../core/FileWatcher.h" # include "../management/Finance.h" # include "../world/Location.hpp" # include "HookEngine.h" # include "Plugin.h" # include # include # include # include # include # include # include # include struct duk_hthread; typedef struct duk_hthread duk_context; struct GameAction; class GameActionResult; class FileWatcher; class InteractiveConsole; namespace OpenRCT2 { struct IPlatformEnvironment; } namespace OpenRCT2::Scripting { # ifndef DISABLE_NETWORK class ScSocketBase; # endif class ScriptExecutionInfo { private: std::shared_ptr _plugin; bool _isGameStateMutable{}; public: class PluginScope { private: ScriptExecutionInfo& _execInfo; std::shared_ptr _plugin; public: PluginScope(ScriptExecutionInfo& execInfo, std::shared_ptr plugin, bool isGameStateMutable) : _execInfo(execInfo) , _plugin(plugin) { _execInfo._plugin = plugin; _execInfo._isGameStateMutable = isGameStateMutable; } PluginScope(const PluginScope&) = delete; ~PluginScope() { _execInfo._plugin = nullptr; _execInfo._isGameStateMutable = false; } }; std::shared_ptr GetCurrentPlugin() { return _plugin; } bool IsGameStateMutable() { return _isGameStateMutable; } }; class DukContext { private: duk_context* _context{}; public: DukContext(); DukContext(DukContext&) = delete; DukContext(DukContext&& src) noexcept : _context(std::move(src._context)) { src._context = {}; } ~DukContext(); operator duk_context*() { return _context; } }; class ScriptEngine { private: InteractiveConsole& _console; IPlatformEnvironment& _env; DukContext _context; bool _initialised{}; bool _pluginsLoaded{}; bool _pluginsStarted{}; std::queue, std::string>> _evalQueue; std::vector> _plugins; uint32_t _lastHotReloadCheckTick{}; HookEngine _hookEngine; ScriptExecutionInfo _execInfo; DukValue _sharedStorage; std::unique_ptr _pluginFileWatcher; std::unordered_set _changedPluginFiles; std::mutex _changedPluginFilesMutex; std::vector)>> _pluginStoppedSubscriptions; struct CustomActionInfo { std::shared_ptr Owner; std::string Name; DukValue Query; DukValue Execute; }; std::unordered_map _customActions; # ifndef DISABLE_NETWORK std::vector> _sockets; # endif public: ScriptEngine(InteractiveConsole& console, IPlatformEnvironment& env); ScriptEngine(ScriptEngine&) = delete; duk_context* GetContext() { return _context; } HookEngine& GetHookEngine() { return _hookEngine; } ScriptExecutionInfo& GetExecInfo() { return _execInfo; } DukValue GetSharedStorage() { return _sharedStorage; } std::vector>& GetPlugins() { return _plugins; } void LoadPlugins(); void UnloadPlugins(); void Update(); std::future Eval(const std::string& s); DukValue ExecutePluginCall( const std::shared_ptr& plugin, const DukValue& func, const std::vector& args, bool isGameStateMutable); void LogPluginInfo(const std::shared_ptr& plugin, const std::string_view& message); void SubscribeToPluginStoppedEvent(std::function)> callback) { _pluginStoppedSubscriptions.push_back(callback); } void AddNetworkPlugin(const std::string_view& code); std::unique_ptr QueryOrExecuteCustomGameAction( const std::string_view& id, const std::string_view& args, bool isExecute); bool RegisterCustomAction( const std::shared_ptr& plugin, const std::string_view& action, const DukValue& query, const DukValue& execute); void RunGameActionHooks(const GameAction& action, std::unique_ptr& result, bool isExecute); std::unique_ptr CreateGameAction(const std::string& actionid, const DukValue& args); void SaveSharedStorage(); # ifndef DISABLE_NETWORK void AddSocket(const std::shared_ptr& socket); # endif private: void Initialise(); void StartPlugins(); void StopPlugins(); void LoadPlugin(const std::string& path); void LoadPlugin(std::shared_ptr& plugin); void StopPlugin(std::shared_ptr plugin); bool ShouldLoadScript(const std::string& path); bool ShouldStartPlugin(const std::shared_ptr& plugin); void SetupHotReloading(); void AutoReloadPlugins(); void ProcessREPL(); void RemoveCustomGameActions(const std::shared_ptr& plugin); std::unique_ptr DukToGameActionResult(const DukValue& d); DukValue GameActionResultToDuk(const GameAction& action, const std::unique_ptr& result); static std::string_view ExpenditureTypeToString(ExpenditureType expenditureType); static ExpenditureType StringToExpenditureType(const std::string_view& expenditureType); void InitSharedStorage(); void LoadSharedStorage(); void UpdateSockets(); void RemoveSockets(const std::shared_ptr& plugin); }; bool IsGameStateMutable(); void ThrowIfGameStateNotMutable(); std::string Stringify(const DukValue& value); } // namespace OpenRCT2::Scripting #endif