mirror of
https://github.com/scp-fs2open/fs2open.github.com.git
synced 2026-11-07 18:31:26 -10:00
asarium
4a6628e16f
I added a pretty generic container structure for the scripting documentation when adding JSON output. However, I did not use that new structure for the HTML output since that was just too much work. This moves the HTML output over to the new structure so now the scripting API handling code is independent from how the resulting documentation is generated. I also moved that code out of the main scripting code which removes quite a lot of clutter in those files. This is mostly a straight port of the old code with no significant changes (except the changes to make it use the new data).
132 lines
3.8 KiB
C++
132 lines
3.8 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
|
|
|
|
HookVariableDocumentation::HookVariableDocumentation(const char* name_, ade_type_info type_, const char* description_)
|
|
: name(name_), type(std::move(type_)), description(description_)
|
|
{
|
|
}
|
|
|
|
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
|