mirror of
https://github.com/zeek/zeek.git
synced 2025-10-06 00:28:21 +00:00
Reformat Zeek in Spicy style
This largely copies over Spicy's `.clang-format` configuration file. The one place where we deviate is header include order since Zeek depends on headers being included in a certain order.
This commit is contained in:
Benjamin Bannier
parent
7b8e7ed72c
commit
f5a76c1aed
786 changed files with 131714 additions and 153609 deletions
|
|
@ -17,8 +17,7 @@
|
|||
#include "zeek/module_util.h"
|
||||
#include "zeek/zeekygen/Manager.h"
|
||||
|
||||
namespace zeek::plugin
|
||||
{
|
||||
namespace zeek::plugin {
|
||||
|
||||
/**
|
||||
* A class that manages tracking of plugin components (e.g. analyzers) and
|
||||
|
|
@ -27,299 +26,286 @@ namespace zeek::plugin
|
|||
*
|
||||
* @tparam C A plugin::Component type derivative.
|
||||
*/
|
||||
template <class C> class ComponentManager
|
||||
{
|
||||
template<class C>
|
||||
class ComponentManager {
|
||||
public:
|
||||
/**
|
||||
* Constructor creates a new enum type to associate with
|
||||
* a component.
|
||||
*
|
||||
* @param module The script-layer module in which to install the ID
|
||||
* representing an enum type.
|
||||
*
|
||||
* @param local_id The local part of the ID of the new enum type
|
||||
* (e.g., "Tag").
|
||||
*/
|
||||
ComponentManager(const std::string& module, const std::string& local_id,
|
||||
const std::string& parent_module = "");
|
||||
/**
|
||||
* Constructor creates a new enum type to associate with
|
||||
* a component.
|
||||
*
|
||||
* @param module The script-layer module in which to install the ID
|
||||
* representing an enum type.
|
||||
*
|
||||
* @param local_id The local part of the ID of the new enum type
|
||||
* (e.g., "Tag").
|
||||
*/
|
||||
ComponentManager(const std::string& module, const std::string& local_id, const std::string& parent_module = "");
|
||||
|
||||
/**
|
||||
* @return The script-layer module in which the component's "Tag" ID lives.
|
||||
*/
|
||||
const std::string& GetModule() const;
|
||||
/**
|
||||
* @return The script-layer module in which the component's "Tag" ID lives.
|
||||
*/
|
||||
const std::string& GetModule() const;
|
||||
|
||||
/**
|
||||
* @return A list of all registered components.
|
||||
*/
|
||||
std::list<C*> GetComponents() const;
|
||||
/**
|
||||
* @return A list of all registered components.
|
||||
*/
|
||||
std::list<C*> GetComponents() const;
|
||||
|
||||
/**
|
||||
* @return The enum type associated with the script-layer "Tag".
|
||||
*/
|
||||
const EnumTypePtr& GetTagType() const;
|
||||
/**
|
||||
* @return The enum type associated with the script-layer "Tag".
|
||||
*/
|
||||
const EnumTypePtr& GetTagType() const;
|
||||
|
||||
/**
|
||||
* Get a component name from its tag.
|
||||
*
|
||||
* @param tag A component's tag.
|
||||
* @return The canonical component name.
|
||||
*/
|
||||
const std::string& GetComponentName(zeek::Tag tag) const;
|
||||
/**
|
||||
* Get a component name from its tag.
|
||||
*
|
||||
* @param tag A component's tag.
|
||||
* @return The canonical component name.
|
||||
*/
|
||||
const std::string& GetComponentName(zeek::Tag tag) const;
|
||||
|
||||
/**
|
||||
* Get a component name from it's enum value.
|
||||
*
|
||||
* @param val A component's enum value.
|
||||
* @return The canonical component name.
|
||||
*/
|
||||
const std::string& GetComponentName(EnumValPtr val) const;
|
||||
/**
|
||||
* Get a component name from it's enum value.
|
||||
*
|
||||
* @param val A component's enum value.
|
||||
* @return The canonical component name.
|
||||
*/
|
||||
const std::string& GetComponentName(EnumValPtr val) const;
|
||||
|
||||
/**
|
||||
* Get a component name from its tag.
|
||||
*
|
||||
* @param tag A component's tag.
|
||||
* @return The canonical component name as a StringValPtr.
|
||||
*/
|
||||
StringValPtr GetComponentNameVal(zeek::Tag tag) const;
|
||||
/**
|
||||
* Get a component name from its tag.
|
||||
*
|
||||
* @param tag A component's tag.
|
||||
* @return The canonical component name as a StringValPtr.
|
||||
*/
|
||||
StringValPtr GetComponentNameVal(zeek::Tag tag) const;
|
||||
|
||||
/**
|
||||
* Get a component name from it's enum value.
|
||||
*
|
||||
* @param val A component's enum value.
|
||||
* @return The canonical component name as a StringValPtr.
|
||||
*/
|
||||
StringValPtr GetComponentNameVal(EnumValPtr val) const;
|
||||
/**
|
||||
* Get a component name from it's enum value.
|
||||
*
|
||||
* @param val A component's enum value.
|
||||
* @return The canonical component name as a StringValPtr.
|
||||
*/
|
||||
StringValPtr GetComponentNameVal(EnumValPtr val) const;
|
||||
|
||||
/**
|
||||
* Get a component tag from its name.
|
||||
*
|
||||
* @param name A component's canonical name.
|
||||
* @return The component's tag, or a tag representing an error if
|
||||
* no such component associated with the name exists.
|
||||
*/
|
||||
zeek::Tag GetComponentTag(const std::string& name) const;
|
||||
/**
|
||||
* Get a component tag from its name.
|
||||
*
|
||||
* @param name A component's canonical name.
|
||||
* @return The component's tag, or a tag representing an error if
|
||||
* no such component associated with the name exists.
|
||||
*/
|
||||
zeek::Tag GetComponentTag(const std::string& name) const;
|
||||
|
||||
/**
|
||||
* Get a component tag from its enum value.
|
||||
*
|
||||
* @param v A component's enum value.
|
||||
* @return The component's tag, or a tag representing an error if
|
||||
* no such component associated with the value exists.
|
||||
*/
|
||||
zeek::Tag GetComponentTag(Val* v) const;
|
||||
/**
|
||||
* Get a component tag from its enum value.
|
||||
*
|
||||
* @param v A component's enum value.
|
||||
* @return The component's tag, or a tag representing an error if
|
||||
* no such component associated with the value exists.
|
||||
*/
|
||||
zeek::Tag GetComponentTag(Val* v) const;
|
||||
|
||||
/**
|
||||
* Add a component the internal maps used to keep track of it and create
|
||||
* a script-layer ID for the component's enum value.
|
||||
*
|
||||
* @param component A component to track.
|
||||
* @param prefix The script-layer ID associated with the component's enum
|
||||
* value will be a concatenation of this prefix and the component's
|
||||
* canonical name.
|
||||
*/
|
||||
void RegisterComponent(C* component, const std::string& prefix = "");
|
||||
/**
|
||||
* Add a component the internal maps used to keep track of it and create
|
||||
* a script-layer ID for the component's enum value.
|
||||
*
|
||||
* @param component A component to track.
|
||||
* @param prefix The script-layer ID associated with the component's enum
|
||||
* value will be a concatenation of this prefix and the component's
|
||||
* canonical name.
|
||||
*/
|
||||
void RegisterComponent(C* component, const std::string& prefix = "");
|
||||
|
||||
/**
|
||||
* @param name The canonical name of a component.
|
||||
* @return The component associated with the name or a null pointer if no
|
||||
* such component exists.
|
||||
*/
|
||||
C* Lookup(const std::string& name) const;
|
||||
/**
|
||||
* @param name The canonical name of a component.
|
||||
* @return The component associated with the name or a null pointer if no
|
||||
* such component exists.
|
||||
*/
|
||||
C* Lookup(const std::string& name) const;
|
||||
|
||||
/**
|
||||
* @param name A component tag.
|
||||
* @return The component associated with the tag or a null pointer if no
|
||||
* such component exists.
|
||||
*/
|
||||
C* Lookup(const zeek::Tag& tag) const;
|
||||
/**
|
||||
* @param name A component tag.
|
||||
* @return The component associated with the tag or a null pointer if no
|
||||
* such component exists.
|
||||
*/
|
||||
C* Lookup(const zeek::Tag& tag) const;
|
||||
|
||||
/**
|
||||
* @param name A component's enum value.
|
||||
* @return The component associated with the value or a null pointer if no
|
||||
* such component exists.
|
||||
*/
|
||||
C* Lookup(EnumVal* val) const;
|
||||
/**
|
||||
* @param name A component's enum value.
|
||||
* @return The component associated with the value or a null pointer if no
|
||||
* such component exists.
|
||||
*/
|
||||
C* Lookup(EnumVal* val) const;
|
||||
|
||||
private:
|
||||
/** Script layer module in which component tags live. */
|
||||
std::string module;
|
||||
std::string parent_module;
|
||||
/** Script layer module in which component tags live. */
|
||||
std::string module;
|
||||
std::string parent_module;
|
||||
|
||||
/** Module-local type of component tags. */
|
||||
EnumTypePtr tag_enum_type;
|
||||
EnumTypePtr parent_tag_enum_type;
|
||||
/** Module-local type of component tags. */
|
||||
EnumTypePtr tag_enum_type;
|
||||
EnumTypePtr parent_tag_enum_type;
|
||||
|
||||
std::map<std::string, C*> components_by_name;
|
||||
std::map<zeek::Tag, C*> components_by_tag;
|
||||
std::map<zeek_int_t, C*> components_by_val;
|
||||
};
|
||||
std::map<std::string, C*> components_by_name;
|
||||
std::map<zeek::Tag, C*> components_by_tag;
|
||||
std::map<zeek_int_t, C*> components_by_val;
|
||||
};
|
||||
|
||||
template <class C>
|
||||
template<class C>
|
||||
ComponentManager<C>::ComponentManager(const std::string& module, const std::string& local_id,
|
||||
const std::string& parent_module)
|
||||
: module(module), parent_module(parent_module)
|
||||
{
|
||||
tag_enum_type = make_intrusive<EnumType>(module + "::" + local_id);
|
||||
auto id = zeek::detail::install_ID(local_id.c_str(), module.c_str(), true, true);
|
||||
zeek::detail::add_type(id.get(), tag_enum_type, nullptr);
|
||||
zeek::detail::zeekygen_mgr->Identifier(std::move(id));
|
||||
: module(module), parent_module(parent_module) {
|
||||
tag_enum_type = make_intrusive<EnumType>(module + "::" + local_id);
|
||||
auto id = zeek::detail::install_ID(local_id.c_str(), module.c_str(), true, true);
|
||||
zeek::detail::add_type(id.get(), tag_enum_type, nullptr);
|
||||
zeek::detail::zeekygen_mgr->Identifier(std::move(id));
|
||||
|
||||
if ( ! parent_module.empty() )
|
||||
{
|
||||
// check to see if the parent module's type has been created already
|
||||
id = zeek::detail::lookup_ID(local_id.c_str(), parent_module.c_str(), false, true, false);
|
||||
if ( id != zeek::detail::ID::nil )
|
||||
{
|
||||
parent_tag_enum_type = id->GetType<EnumType>();
|
||||
}
|
||||
else
|
||||
{
|
||||
parent_tag_enum_type = make_intrusive<EnumType>(parent_module + "::" + local_id);
|
||||
id = zeek::detail::install_ID(local_id.c_str(), parent_module.c_str(), true, true);
|
||||
zeek::detail::add_type(id.get(), parent_tag_enum_type, nullptr);
|
||||
zeek::detail::zeekygen_mgr->Identifier(std::move(id));
|
||||
}
|
||||
}
|
||||
}
|
||||
if ( ! parent_module.empty() ) {
|
||||
// check to see if the parent module's type has been created already
|
||||
id = zeek::detail::lookup_ID(local_id.c_str(), parent_module.c_str(), false, true, false);
|
||||
if ( id != zeek::detail::ID::nil ) {
|
||||
parent_tag_enum_type = id->GetType<EnumType>();
|
||||
}
|
||||
else {
|
||||
parent_tag_enum_type = make_intrusive<EnumType>(parent_module + "::" + local_id);
|
||||
id = zeek::detail::install_ID(local_id.c_str(), parent_module.c_str(), true, true);
|
||||
zeek::detail::add_type(id.get(), parent_tag_enum_type, nullptr);
|
||||
zeek::detail::zeekygen_mgr->Identifier(std::move(id));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
template <class C> const std::string& ComponentManager<C>::GetModule() const
|
||||
{
|
||||
return module;
|
||||
}
|
||||
template<class C>
|
||||
const std::string& ComponentManager<C>::GetModule() const {
|
||||
return module;
|
||||
}
|
||||
|
||||
template <class C> std::list<C*> ComponentManager<C>::GetComponents() const
|
||||
{
|
||||
std::list<C*> rval;
|
||||
typename std::map<zeek::Tag, C*>::const_iterator i;
|
||||
template<class C>
|
||||
std::list<C*> ComponentManager<C>::GetComponents() const {
|
||||
std::list<C*> rval;
|
||||
typename std::map<zeek::Tag, C*>::const_iterator i;
|
||||
|
||||
for ( i = components_by_tag.begin(); i != components_by_tag.end(); ++i )
|
||||
rval.push_back(i->second);
|
||||
for ( i = components_by_tag.begin(); i != components_by_tag.end(); ++i )
|
||||
rval.push_back(i->second);
|
||||
|
||||
return rval;
|
||||
}
|
||||
return rval;
|
||||
}
|
||||
|
||||
template <class C> const EnumTypePtr& ComponentManager<C>::GetTagType() const
|
||||
{
|
||||
return tag_enum_type;
|
||||
}
|
||||
template<class C>
|
||||
const EnumTypePtr& ComponentManager<C>::GetTagType() const {
|
||||
return tag_enum_type;
|
||||
}
|
||||
|
||||
template <class C> const std::string& ComponentManager<C>::GetComponentName(zeek::Tag tag) const
|
||||
{
|
||||
static const std::string error = "<error>";
|
||||
template<class C>
|
||||
const std::string& ComponentManager<C>::GetComponentName(zeek::Tag tag) const {
|
||||
static const std::string error = "<error>";
|
||||
|
||||
if ( ! tag )
|
||||
return error;
|
||||
if ( ! tag )
|
||||
return error;
|
||||
|
||||
if ( C* c = Lookup(tag) )
|
||||
return c->CanonicalName();
|
||||
if ( C* c = Lookup(tag) )
|
||||
return c->CanonicalName();
|
||||
|
||||
reporter->InternalWarning("requested name of unknown component tag %s", tag.AsString().c_str());
|
||||
return error;
|
||||
}
|
||||
reporter->InternalWarning("requested name of unknown component tag %s", tag.AsString().c_str());
|
||||
return error;
|
||||
}
|
||||
|
||||
template <class C> const std::string& ComponentManager<C>::GetComponentName(EnumValPtr val) const
|
||||
{
|
||||
static const std::string error = "<error>";
|
||||
template<class C>
|
||||
const std::string& ComponentManager<C>::GetComponentName(EnumValPtr val) const {
|
||||
static const std::string error = "<error>";
|
||||
|
||||
if ( ! val )
|
||||
return error;
|
||||
if ( ! val )
|
||||
return error;
|
||||
|
||||
if ( C* c = Lookup(val.get()) )
|
||||
return c->CanonicalName();
|
||||
if ( C* c = Lookup(val.get()) )
|
||||
return c->CanonicalName();
|
||||
|
||||
reporter->InternalWarning("requested name of unknown component tag %s",
|
||||
val->AsString()->CheckString());
|
||||
return error;
|
||||
}
|
||||
reporter->InternalWarning("requested name of unknown component tag %s", val->AsString()->CheckString());
|
||||
return error;
|
||||
}
|
||||
|
||||
template <class C> StringValPtr ComponentManager<C>::GetComponentNameVal(zeek::Tag tag) const
|
||||
{
|
||||
static auto error = make_intrusive<StringVal>("<error>");
|
||||
template<class C>
|
||||
StringValPtr ComponentManager<C>::GetComponentNameVal(zeek::Tag tag) const {
|
||||
static auto error = make_intrusive<StringVal>("<error>");
|
||||
|
||||
if ( ! tag )
|
||||
return error;
|
||||
if ( ! tag )
|
||||
return error;
|
||||
|
||||
if ( C* c = Lookup(tag) )
|
||||
return c->CanonicalNameVal();
|
||||
if ( C* c = Lookup(tag) )
|
||||
return c->CanonicalNameVal();
|
||||
|
||||
reporter->InternalWarning("requested name of unknown component tag %s", tag.AsString().c_str());
|
||||
return error;
|
||||
}
|
||||
reporter->InternalWarning("requested name of unknown component tag %s", tag.AsString().c_str());
|
||||
return error;
|
||||
}
|
||||
|
||||
template <class C> StringValPtr ComponentManager<C>::GetComponentNameVal(EnumValPtr val) const
|
||||
{
|
||||
static auto error = make_intrusive<StringVal>("<error>");
|
||||
template<class C>
|
||||
StringValPtr ComponentManager<C>::GetComponentNameVal(EnumValPtr val) const {
|
||||
static auto error = make_intrusive<StringVal>("<error>");
|
||||
|
||||
if ( ! val )
|
||||
return error;
|
||||
if ( ! val )
|
||||
return error;
|
||||
|
||||
if ( C* c = Lookup(val.get()) )
|
||||
return c->CanonicalNameVal();
|
||||
if ( C* c = Lookup(val.get()) )
|
||||
return c->CanonicalNameVal();
|
||||
|
||||
reporter->InternalWarning("requested name of unknown component tag %s",
|
||||
val->AsString()->CheckString());
|
||||
return error;
|
||||
}
|
||||
reporter->InternalWarning("requested name of unknown component tag %s", val->AsString()->CheckString());
|
||||
return error;
|
||||
}
|
||||
|
||||
template <class C> zeek::Tag ComponentManager<C>::GetComponentTag(const std::string& name) const
|
||||
{
|
||||
C* c = Lookup(name);
|
||||
return c ? c->Tag() : zeek::Tag();
|
||||
}
|
||||
template<class C>
|
||||
zeek::Tag ComponentManager<C>::GetComponentTag(const std::string& name) const {
|
||||
C* c = Lookup(name);
|
||||
return c ? c->Tag() : zeek::Tag();
|
||||
}
|
||||
|
||||
template <class C> zeek::Tag ComponentManager<C>::GetComponentTag(Val* v) const
|
||||
{
|
||||
C* c = Lookup(v->AsEnumVal());
|
||||
return c ? c->Tag() : zeek::Tag();
|
||||
}
|
||||
template<class C>
|
||||
zeek::Tag ComponentManager<C>::GetComponentTag(Val* v) const {
|
||||
C* c = Lookup(v->AsEnumVal());
|
||||
return c ? c->Tag() : zeek::Tag();
|
||||
}
|
||||
|
||||
template <class C> C* ComponentManager<C>::Lookup(const std::string& name) const
|
||||
{
|
||||
typename std::map<std::string, C*>::const_iterator i = components_by_name.find(
|
||||
util::to_upper(name));
|
||||
return i != components_by_name.end() ? i->second : nullptr;
|
||||
}
|
||||
template<class C>
|
||||
C* ComponentManager<C>::Lookup(const std::string& name) const {
|
||||
typename std::map<std::string, C*>::const_iterator i = components_by_name.find(util::to_upper(name));
|
||||
return i != components_by_name.end() ? i->second : nullptr;
|
||||
}
|
||||
|
||||
template <class C> C* ComponentManager<C>::Lookup(const zeek::Tag& tag) const
|
||||
{
|
||||
typename std::map<zeek::Tag, C*>::const_iterator i = components_by_tag.find(tag);
|
||||
return i != components_by_tag.end() ? i->second : nullptr;
|
||||
}
|
||||
template<class C>
|
||||
C* ComponentManager<C>::Lookup(const zeek::Tag& tag) const {
|
||||
typename std::map<zeek::Tag, C*>::const_iterator i = components_by_tag.find(tag);
|
||||
return i != components_by_tag.end() ? i->second : nullptr;
|
||||
}
|
||||
|
||||
template <class C> C* ComponentManager<C>::Lookup(EnumVal* val) const
|
||||
{
|
||||
typename std::map<zeek_int_t, C*>::const_iterator i = components_by_val.find(
|
||||
val->InternalInt());
|
||||
return i != components_by_val.end() ? i->second : nullptr;
|
||||
}
|
||||
template<class C>
|
||||
C* ComponentManager<C>::Lookup(EnumVal* val) const {
|
||||
typename std::map<zeek_int_t, C*>::const_iterator i = components_by_val.find(val->InternalInt());
|
||||
return i != components_by_val.end() ? i->second : nullptr;
|
||||
}
|
||||
|
||||
template <class C>
|
||||
void ComponentManager<C>::RegisterComponent(C* component, const std::string& prefix)
|
||||
{
|
||||
std::string cname = component->CanonicalName();
|
||||
template<class C>
|
||||
void ComponentManager<C>::RegisterComponent(C* component, const std::string& prefix) {
|
||||
std::string cname = component->CanonicalName();
|
||||
|
||||
if ( Lookup(cname) )
|
||||
reporter->FatalError("Component '%s::%s' defined more than once", module.c_str(),
|
||||
cname.c_str());
|
||||
if ( Lookup(cname) )
|
||||
reporter->FatalError("Component '%s::%s' defined more than once", module.c_str(), cname.c_str());
|
||||
|
||||
DBG_LOG(DBG_PLUGINS, "Registering component %s (tag %s)", component->Name().c_str(),
|
||||
component->Tag().AsString().c_str());
|
||||
DBG_LOG(DBG_PLUGINS, "Registering component %s (tag %s)", component->Name().c_str(),
|
||||
component->Tag().AsString().c_str());
|
||||
|
||||
components_by_name.insert(std::make_pair(cname, component));
|
||||
components_by_tag.insert(std::make_pair(component->Tag(), component));
|
||||
components_by_val.insert(std::make_pair(component->Tag().AsVal()->InternalInt(), component));
|
||||
components_by_name.insert(std::make_pair(cname, component));
|
||||
components_by_tag.insert(std::make_pair(component->Tag(), component));
|
||||
components_by_val.insert(std::make_pair(component->Tag().AsVal()->InternalInt(), component));
|
||||
|
||||
// Install an identifier for enum value
|
||||
std::string id = util::fmt("%s%s", prefix.c_str(), cname.c_str());
|
||||
tag_enum_type->AddName(module, id.c_str(), component->Tag().AsVal()->InternalInt(), true,
|
||||
nullptr);
|
||||
// Install an identifier for enum value
|
||||
std::string id = util::fmt("%s%s", prefix.c_str(), cname.c_str());
|
||||
tag_enum_type->AddName(module, id.c_str(), component->Tag().AsVal()->InternalInt(), true, nullptr);
|
||||
|
||||
if ( parent_tag_enum_type )
|
||||
{
|
||||
std::string parent_id = util::fmt("%s_%s", util::strtoupper(module).c_str(), id.c_str());
|
||||
parent_tag_enum_type->AddName(parent_module, parent_id.c_str(),
|
||||
component->Tag().AsVal()->InternalInt(), true, nullptr);
|
||||
}
|
||||
}
|
||||
if ( parent_tag_enum_type ) {
|
||||
std::string parent_id = util::fmt("%s_%s", util::strtoupper(module).c_str(), id.c_str());
|
||||
parent_tag_enum_type->AddName(parent_module, parent_id.c_str(), component->Tag().AsVal()->InternalInt(), true,
|
||||
nullptr);
|
||||
}
|
||||
}
|
||||
|
||||
} // namespace zeek::plugin
|
||||
} // namespace zeek::plugin
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue