mirror of
https://github.com/scp-fs2open/fs2open.github.com.git
synced 2026-11-09 04:49:39 -10:00
asarium
1c12349990
This moves towards defining the hooks in the code module that executes them. Also provides the API necessary for better documentation of hooks. This only covers a few hooks as a test and demonstration of the new API. If no issues are found with this it can be extended in the future.
127 lines
3.6 KiB
C++
127 lines
3.6 KiB
C++
#include "hook_api.h"
|
|
|
|
#include "globalincs/pstypes.h"
|
|
|
|
#include <utility>
|
|
|
|
namespace scripting {
|
|
|
|
namespace {
|
|
|
|
class HookManager {
|
|
public:
|
|
int32_t addHook(HookBase* hook)
|
|
{
|
|
Assertion(std::find_if(_hooks.cbegin(),
|
|
_hooks.cend(),
|
|
[hook](const HookBase* test) { return test->getHookName() == hook->getHookName(); }) ==
|
|
_hooks.cend(),
|
|
"Hook '%s' already exists!",
|
|
hook->getHookName().c_str());
|
|
|
|
const auto id = ++_lastId;
|
|
_hooks.push_back(hook);
|
|
return id;
|
|
}
|
|
|
|
void addHookWithId(HookBase* hook)
|
|
{
|
|
Assertion(std::find_if(_hooks.cbegin(),
|
|
_hooks.cend(),
|
|
[hook](const HookBase* test) { return test->getHookName() == hook->getHookName(); }) ==
|
|
_hooks.cend(),
|
|
"Hook '%s' already exists!",
|
|
hook->getHookName().c_str());
|
|
|
|
_hooks.push_back(hook);
|
|
}
|
|
|
|
const SCP_vector<HookBase*>& getHooks() const { return _hooks; }
|
|
|
|
private:
|
|
int32_t _lastId = CHA_LAST;
|
|
SCP_vector<HookBase*> _hooks;
|
|
};
|
|
|
|
HookManager& getHookManager()
|
|
{
|
|
static HookManager mgr;
|
|
return mgr;
|
|
}
|
|
} // namespace
|
|
|
|
namespace detail {
|
|
ade_odata_setter<object_h> convert_arg_type(object* objp)
|
|
{
|
|
return ade_object_to_odata(objp != nullptr ? OBJ_INDEX(objp) : -1);
|
|
}
|
|
} // namespace detail
|
|
|
|
HookBase::HookBase(SCP_string hookName,
|
|
SCP_string description,
|
|
SCP_vector<HookVariableDocumentation> parameters,
|
|
int32_t hookId)
|
|
: _hookName(std::move(hookName)), _description(std::move(description)), _parameters(std::move(parameters))
|
|
{
|
|
// If we specify a forced id then use that. This is for special hooks that need a guaranteed id
|
|
if (hookId >= 0) {
|
|
_hookId = hookId;
|
|
getHookManager().addHookWithId(this);
|
|
} else {
|
|
_hookId = getHookManager().addHook(this);
|
|
}
|
|
}
|
|
|
|
const SCP_string& HookBase::getHookName() const { return _hookName; }
|
|
const SCP_string& HookBase::getDescription() const { return _description; }
|
|
const SCP_vector<HookVariableDocumentation>& HookBase::getParameters() const { return _parameters; }
|
|
int32_t HookBase::getHookId() const { return _hookId; }
|
|
HookBase::~HookBase() = default;
|
|
|
|
std::shared_ptr<Hook> Hook::Factory(SCP_string hookName,
|
|
SCP_string description,
|
|
SCP_vector<HookVariableDocumentation> parameters,
|
|
int32_t hookId)
|
|
{
|
|
return std::make_shared<Hook>(std::move(hookName), std::move(description), std::move(parameters), hookId);
|
|
}
|
|
std::shared_ptr<Hook> Hook::Factory(SCP_string hookName, int32_t hookId)
|
|
{
|
|
return std::make_shared<Hook>(std::move(hookName), SCP_string(), SCP_vector<HookVariableDocumentation>(), hookId);
|
|
}
|
|
Hook::Hook(SCP_string hookName,
|
|
SCP_string description,
|
|
SCP_vector<HookVariableDocumentation> parameters,
|
|
int32_t hookId)
|
|
: HookBase(std::move(hookName), std::move(description), std::move(parameters), hookId)
|
|
{
|
|
}
|
|
Hook::~Hook() = default;
|
|
|
|
bool Hook::isOverridable() const { return false; }
|
|
|
|
OverridableHook::OverridableHook(SCP_string hookName,
|
|
SCP_string description,
|
|
SCP_vector<HookVariableDocumentation> parameters,
|
|
int32_t hookId)
|
|
: Hook(std::move(hookName), std::move(description), std::move(parameters), hookId)
|
|
{
|
|
}
|
|
OverridableHook::~OverridableHook() = default;
|
|
|
|
std::shared_ptr<OverridableHook> OverridableHook::Factory(SCP_string hookName,
|
|
SCP_string description,
|
|
SCP_vector<HookVariableDocumentation> parameters,
|
|
int32_t hookId)
|
|
{
|
|
return std::make_shared<OverridableHook>(std::move(hookName),
|
|
std::move(description),
|
|
std::move(parameters),
|
|
hookId);
|
|
}
|
|
bool OverridableHook::isOverridable() const { return true; }
|
|
|
|
const SCP_vector<HookBase*>& getHooks() { return getHookManager().getHooks(); }
|
|
|
|
} // namespace scripting
|