mirror of
https://github.com/zeek/zeek.git
synced 2025-10-11 02:58:20 +00:00
149e3b3c32
Clang automatically disables deprecation warnings for types used within already-deprecated contexts, such as if you use a deprecated type inside of a method that's beeen marked as deprecated. GCC doesn't have this feature so it spews a lot more warnings. These functions are now wrapped in pragmas that disable the warnings for the usage.
140 lines
3.4 KiB
C++
140 lines
3.4 KiB
C++
// See the file "COPYING" in the main distribution directory for copyright.
|
|
|
|
#pragma once
|
|
|
|
#include <string>
|
|
|
|
class ODesc;
|
|
|
|
namespace plugin::component {
|
|
|
|
enum [[deprecated("Remove in v4.1. Use zeek::plugin::component::Type instead.")]] Type {
|
|
READER, /// An input reader (not currently used).
|
|
WRITER, /// A logging writer (not currenly used).
|
|
ANALYZER, /// A protocol analyzer.
|
|
FILE_ANALYZER, /// A file analyzer.
|
|
IOSOURCE, /// An I/O source, excluding packet sources.
|
|
PKTSRC, /// A packet source.
|
|
PKTDUMPER /// A packet dumper.
|
|
};
|
|
|
|
}
|
|
|
|
namespace zeek::plugin {
|
|
|
|
namespace component {
|
|
|
|
/**
|
|
* Component types.
|
|
*/
|
|
enum Type {
|
|
READER, /// An input reader (not currently used).
|
|
WRITER, /// A logging writer (not currenly used).
|
|
ANALYZER, /// A protocol analyzer.
|
|
FILE_ANALYZER, /// A file analyzer.
|
|
IOSOURCE, /// An I/O source, excluding packet sources.
|
|
PKTSRC, /// A packet source.
|
|
PKTDUMPER /// A packet dumper.
|
|
};
|
|
|
|
}
|
|
|
|
/**
|
|
* Base class for plugin components. A component is a specific piece of
|
|
* functionality that a plugin provides, such as a protocol analyzer or a log
|
|
* writer.
|
|
*/
|
|
class Component
|
|
{
|
|
public:
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param type The type of the compoment.
|
|
*
|
|
* @param name A descriptive name for the component. This name must
|
|
* be unique across all components of the same type.
|
|
*/
|
|
Component(component::Type type, const std::string& name);
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param type The type of the compoment.
|
|
*
|
|
* @param name A descriptive name for the component. This name must
|
|
* be unique across all components of the same type.
|
|
*/
|
|
#pragma GCC diagnostic push
|
|
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
|
|
[[deprecated("Remove in v4.1. Use the version that takes zeek::plugin::component::Type instead")]]
|
|
Component(::plugin::component::Type type, const std::string& name);
|
|
#pragma GCC diagnostic pop
|
|
|
|
/**
|
|
* Destructor.
|
|
*/
|
|
virtual ~Component();
|
|
|
|
/**
|
|
* Initialization function. This function has to be called before any
|
|
* plugin component functionality is used; it commonly is used to add the
|
|
* plugin component to the list of components and to initialize tags
|
|
*/
|
|
virtual void Initialize() {}
|
|
|
|
/**
|
|
* Returns the compoment's type.
|
|
*/
|
|
component::Type Type() const;
|
|
|
|
/**
|
|
* Returns the compoment's name.
|
|
*/
|
|
const std::string& Name() const;
|
|
|
|
/**
|
|
* Returns a canonocalized version of the components's name. The
|
|
* returned name is derived from what's passed to the constructor but
|
|
* upper-cased and transformed to allow being part of a script-level
|
|
* ID.
|
|
*/
|
|
const std::string& CanonicalName() const { return canon_name; }
|
|
|
|
/**
|
|
* Returns a textual representation of the component. This goes into
|
|
* the output of "bro -NN".
|
|
*
|
|
* By default, this just outputs the type and the name. Derived
|
|
* versions can override DoDescribe() to add type specific details.
|
|
*
|
|
* @param d The description object to use.
|
|
*/
|
|
void Describe(ODesc* d) const;
|
|
|
|
protected:
|
|
/**
|
|
* Adds type specific information to the output of Describe().
|
|
*
|
|
* The default version does nothing.
|
|
*
|
|
* @param d The description object to use.
|
|
*/
|
|
virtual void DoDescribe(ODesc* d) const { }
|
|
|
|
private:
|
|
// Disable.
|
|
Component(const Component& other);
|
|
Component operator=(const Component& other);
|
|
|
|
component::Type type;
|
|
std::string name;
|
|
std::string canon_name;
|
|
};
|
|
|
|
}
|
|
|
|
namespace plugin
|
|
{
|
|
using Component [[deprecated("Remove in v4.1. Use zeek::plugin::Component instead.")]] = zeek::plugin::Component;
|
|
}
|