mirror of
https://github.com/zeek/zeek.git
synced 2025-10-06 16:48:19 +00:00
99c89b42d7
Made some class templates for code that seemed duplicated between file/protocol tags and managers. Seems like it helps a bit and hopefully can be also be used to transition other things that have enum value "tags" (e.g. logging writers, input readers) to the plugin system.
93 lines
2.5 KiB
C++
93 lines
2.5 KiB
C++
// See the file "COPYING" in the main distribution directory for copyright.
|
|
|
|
#ifndef FILE_ANALYZER_PLUGIN_COMPONENT_H
|
|
#define FILE_ANALYZER_PLUGIN_COMPONENT_H
|
|
|
|
#include "Tag.h"
|
|
#include "plugin/Component.h"
|
|
#include "plugin/TaggedComponent.h"
|
|
|
|
#include "Val.h"
|
|
|
|
#include "../config.h"
|
|
#include "../util.h"
|
|
|
|
namespace file_analysis {
|
|
|
|
class File;
|
|
class Analyzer;
|
|
|
|
/**
|
|
* Component description for plugins providing file analyzers.
|
|
*
|
|
* A plugin can provide a specific file analyzer by registering this
|
|
* analyzer component, describing the analyzer.
|
|
*/
|
|
class Component : public plugin::Component,
|
|
public plugin::TaggedComponent<file_analysis::Tag> {
|
|
public:
|
|
typedef Analyzer* (*factory_callback)(RecordVal* args, File* file);
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param name The name of the provided analyzer. This name is used
|
|
* across the system to identify the analyzer, e.g., when calling
|
|
* file_analysis::Manager::InstantiateAnalyzer with a name.
|
|
*
|
|
* @param factory A factory function to instantiate instances of the
|
|
* analyzer's class, which must be derived directly or indirectly
|
|
* from file_analysis::Analyzer. This is typically a static \c
|
|
* Instatiate() method inside the class that just allocates and
|
|
* returns a new instance.
|
|
*/
|
|
Component(const char* name, factory_callback factory);
|
|
|
|
/**
|
|
* Copy constructor.
|
|
*/
|
|
Component(const Component& other);
|
|
|
|
/**
|
|
* Destructor.
|
|
*/
|
|
~Component();
|
|
|
|
/**
|
|
* Returns the name of the analyzer. This name is unique across all
|
|
* analyzers and used to identify it. The returned name is derived
|
|
* from what's passed to the constructor but upper-cased and
|
|
* canonified to allow being part of a script-level ID.
|
|
*/
|
|
virtual const char* Name() const { return name; }
|
|
|
|
/**
|
|
* Returns a canonocalized version of the analyzer'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 char* CanonicalName() const { return canon_name; }
|
|
|
|
/**
|
|
* Returns the analyzer's factory function.
|
|
*/
|
|
factory_callback Factory() const { return factory; }
|
|
|
|
/**
|
|
* Generates a human-readable description of the component's main
|
|
* parameters. This goes into the output of \c "bro -NN".
|
|
*/
|
|
virtual void Describe(ODesc* d) const;
|
|
|
|
Component& operator=(const Component& other);
|
|
|
|
private:
|
|
const char* name; // The analyzer's name.
|
|
const char* canon_name; // The analyzer's canonical name.
|
|
factory_callback factory; // The analyzer's factory callback.
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|