1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
|
#pragma once
#include "globalincs/pstypes.h"
#include "globalincs/version.h"
#include "ade_api.h"
#include "scripting.h"
#include "utils/tuples.h"
#include <utility>
#include <tl/optional.hpp>
namespace scripting {
namespace detail {
ade_odata_setter<object_h> convert_arg_type(object* objp);
ade_odata_setter<vec3d> convert_arg_type(vec3d vec);
template <typename T>
T&& convert_arg_type(T&& arg)
{
return std::forward<T>(arg);
}
template <typename T>
struct HookParameterInstance {
SCP_string name;
char type = '\0';
T value;
bool enabled = true;
HookParameterInstance(SCP_string name_, char type_, T&& value_, bool enabled_)
: name(std::move(name_)), type(type_), value(std::forward<T>(value_)), enabled(enabled_)
{
}
};
struct SetSingleHookVarHelper {
SCP_vector<SCP_string>& paramNames;
SetSingleHookVarHelper(SCP_vector<SCP_string>& paramNames_) : paramNames(paramNames_) {}
template <typename T>
void operator()(HookParameterInstance<T>&& instance)
{
// If a parameter is not enabled, skip it
if (!instance.enabled) {
return;
}
paramNames.push_back(instance.name);
Script_system.SetHookVar(instance.name.c_str(),
instance.type,
detail::convert_arg_type(std::move(instance.value)));
}
};
template <typename... Args>
struct HookParameterInstanceList {
std::tuple<HookParameterInstance<Args>...> params;
HookParameterInstanceList(HookParameterInstance<Args>&&... params_)
: params(std::forward<HookParameterInstance<Args>>(params_)...)
{
}
void setHookVars(SCP_vector<SCP_string>& paramNames)
{
util::tuples::for_each<0, SetSingleHookVarHelper, HookParameterInstance<Args>...>(
std::move(params),
SetSingleHookVarHelper(paramNames));
}
};
} // namespace detail
template <typename T>
detail::HookParameterInstance<T> hook_param(SCP_string name_, char type_, T&& value_, bool enabled = true)
{
return detail::HookParameterInstance<T>(std::move(name_), type_, std::forward<T>(value_), enabled);
}
template <typename... Args>
detail::HookParameterInstanceList<Args...> hook_param_list(detail::HookParameterInstance<Args>&&... params)
{
return detail::HookParameterInstanceList<Args...>(std::forward<detail::HookParameterInstance<Args>>(params)...);
}
struct HookVariableDocumentation {
const char* name = nullptr;
scripting::ade_type_info type;
const char* description = nullptr;
HookVariableDocumentation(const char* name_, scripting::ade_type_info type_, const char* description_);
};
struct HookDeprecationOptions {
gameversion::version deprecatedSince;
enum class DeprecationLevel {
LEVEL_WARN, //Will warn a user if an engine version before deprecatedSince is targeted and error if a later version is targeted.
LEVEL_ERROR //Will always error if used.
} level_hook, level_override;
HookDeprecationOptions(gameversion::version version, DeprecationLevel _level_hook, DeprecationLevel _level_override) : deprecatedSince(std::move(version)), level_hook(_level_hook), level_override(_level_override) { }
HookDeprecationOptions(gameversion::version version, DeprecationLevel _level_hook = DeprecationLevel::LEVEL_WARN) : HookDeprecationOptions(std::move(version), _level_hook, _level_hook) { }
};
class HookBase {
public:
HookBase(SCP_string hookName,
SCP_string description,
SCP_vector<HookVariableDocumentation> parameters,
const SCP_unordered_map<SCP_string, const std::unique_ptr<const ParseableCondition>>& conditions,
tl::optional<HookDeprecationOptions> deprecation,
int32_t hookId = -1);
virtual ~HookBase();
const SCP_string& getHookName() const;
const SCP_string& getDescription() const;
const SCP_vector<HookVariableDocumentation>& getParameters() const;
const tl::optional<HookDeprecationOptions>& getDeprecation() const;
int32_t getHookId() const;
virtual bool isActive() const = 0;
virtual bool isOverridable() const = 0;
const SCP_unordered_map<SCP_string, const std::unique_ptr<const ParseableCondition>>& _conditions;
protected:
SCP_string _hookName;
SCP_string _description;
SCP_vector<HookVariableDocumentation> _parameters;
tl::optional<HookDeprecationOptions> _deprecation;
int32_t _hookId = 0;
bool hasParameter(const SCP_string& param) const
{
return std::find_if(_parameters.begin(), _parameters.end(), [¶m](const HookVariableDocumentation& test) {
return test.name == param;
}) != _parameters.end();
}
};
template<typename condition_t>
class HookImpl : public HookBase {
protected:
HookImpl(SCP_string hookName, SCP_string description, SCP_vector<HookVariableDocumentation> parameters, tl::optional<HookDeprecationOptions> deprecation, int32_t hookId)
: HookBase(std::move(hookName), std::move(description), std::move(parameters), condition_t::conditions, std::move(deprecation), hookId) { };
template <typename... Args>
int run(condition_t condition, detail::HookParameterInstanceList<Args...> argsList = hook_param_list<Args...>()) const
{
if (!Scripting_game_init_run)
return 0;
SCP_vector<SCP_string> paramNames;
argsList.setHookVars(paramNames);
#ifndef NDEBUG
std::for_each(paramNames.begin(), paramNames.end(), [this](const SCP_string& param) {
Assertion(this->hasParameter(param),
"Hook '%s' does not accept parameter '%s'.",
this->_hookName.c_str(),
param.c_str());
});
#endif
const auto num_run = Script_system.RunCondition(this->_hookId, linb::any(std::move(condition)));
for (const auto& param : paramNames) {
Script_system.RemHookVar(param.c_str());
}
return num_run;
}
};
template<>
class HookImpl<void> : public HookBase {
static const SCP_unordered_map<SCP_string, const std::unique_ptr<const ParseableCondition>> emptyConditions;
protected:
HookImpl(SCP_string hookName, SCP_string description, SCP_vector<HookVariableDocumentation> parameters, tl::optional<HookDeprecationOptions> deprecation, int32_t hookId)
: HookBase(std::move(hookName), std::move(description), std::move(parameters), emptyConditions, std::move(deprecation), hookId) { };
template <typename... Args>
int run(detail::HookParameterInstanceList<Args...> argsList = hook_param_list<Args...>()) const
{
if (!Scripting_game_init_run)
return 0;
SCP_vector<SCP_string> paramNames;
argsList.setHookVars(paramNames);
#ifndef NDEBUG
std::for_each(paramNames.begin(), paramNames.end(), [this](const SCP_string& param) {
Assertion(this->hasParameter(param),
"Hook '%s' does not accept parameter '%s'.",
this->_hookName.c_str(),
param.c_str());
});
#endif
const auto num_run = Script_system.RunCondition(this->_hookId, linb::any{});
for (const auto& param : paramNames) {
Script_system.RemHookVar(param.c_str());
}
return num_run;
}
};
template<typename condition_t = void>
class Hook : public HookImpl<condition_t> {
public:
using HookImpl<condition_t>::HookImpl;
~Hook() override = default;
static std::shared_ptr<Hook<condition_t>> Factory(SCP_string hookName,
SCP_string description,
SCP_vector<HookVariableDocumentation> parameters,
tl::optional<HookDeprecationOptions> deprecation = tl::nullopt,
int32_t hookId = -1) {
return std::shared_ptr<Hook<condition_t>>(new Hook<condition_t>(std::move(hookName), std::move(description), std::move(parameters), std::move(deprecation), hookId));
}
bool isActive() const override {
return Script_system.IsActiveAction(this->_hookId);
}
bool isOverridable() const override {
return false;
};
using HookImpl<condition_t>::run;
};
template<typename condition_t>
class OverridableHookImpl : public Hook<condition_t> {
protected:
OverridableHookImpl(SCP_string hookName, SCP_string description, SCP_vector<HookVariableDocumentation> parameters, tl::optional<HookDeprecationOptions> deprecation, int32_t hookId)
: Hook<condition_t>(std::move(hookName), std::move(description), std::move(parameters), std::move(deprecation), hookId) { }
template <typename... Args>
bool isOverride(condition_t condition, detail::HookParameterInstanceList<Args...> argsList = hook_param_list<Args...>()) const
{
if (!Scripting_game_init_run)
return false;
SCP_vector<SCP_string> paramNames;
argsList.setHookVars(paramNames);
#ifndef NDEBUG
std::for_each(paramNames.begin(), paramNames.end(), [this](const SCP_string& param) {
Assertion(this->hasParameter(param),
"Hook '%s' does not accept parameter '%s'.",
this->_hookName.c_str(),
param.c_str());
});
#endif
const auto ret_val = Script_system.IsConditionOverride(this->_hookId, linb::any(std::move(condition)));
for (const auto& param : paramNames) {
Script_system.RemHookVar(param.c_str());
}
return ret_val;
}
};
template<>
class OverridableHookImpl<void> : public Hook<void> {
protected:
OverridableHookImpl(SCP_string hookName, SCP_string description, SCP_vector<HookVariableDocumentation> parameters, tl::optional<HookDeprecationOptions> deprecation, int32_t hookId)
: Hook<void>(std::move(hookName), std::move(description), std::move(parameters), std::move(deprecation), hookId) { }
template <typename... Args>
bool isOverride(detail::HookParameterInstanceList<Args...> argsList = hook_param_list<Args...>()) const
{
if (!Scripting_game_init_run)
return false;
SCP_vector<SCP_string> paramNames;
argsList.setHookVars(paramNames);
#ifndef NDEBUG
std::for_each(paramNames.begin(), paramNames.end(), [this](const SCP_string& param) {
Assertion(this->hasParameter(param),
"Hook '%s' does not accept parameter '%s'.",
this->_hookName.c_str(),
param.c_str());
});
#endif
const auto ret_val = Script_system.IsConditionOverride(this->_hookId, linb::any{});
for (const auto& param : paramNames) {
Script_system.RemHookVar(param.c_str());
}
return ret_val;
}
};
template<typename condition_t = void>
class OverridableHook : public OverridableHookImpl<condition_t> {
public:
using OverridableHookImpl<condition_t>::OverridableHookImpl;
~OverridableHook() override = default;
static std::shared_ptr<OverridableHook<condition_t>> Factory(SCP_string hookName,
SCP_string description,
SCP_vector<HookVariableDocumentation> parameters,
tl::optional<HookDeprecationOptions> deprecation = tl::nullopt,
int32_t hookId = -1) {
return std::shared_ptr<OverridableHook<condition_t>>(new OverridableHook<condition_t>(std::move(hookName),
std::move(description),
std::move(parameters),
std::move(deprecation),
hookId));
}
bool isOverridable() const override {
return true;
}
using OverridableHookImpl<condition_t>::isOverride;
};
const SCP_vector<HookBase*>& getHooks();
} // namespace scripting
|