Mirror/zeek
1
0
Fork 0
mirror of https://github.com/zeek/zeek.git synced 2025-10-08 01:28:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

A set of interface changes in preparation for merging into BinPAC++

Browse source 
branch.
This commit is contained in:
Robin Sommer 2013-04-09 16:23:20 -07:00
parent 52cd02173d
commit 2002787c6e
27 changed files with 381 additions and 172 deletions
Download patch file Download diff file Expand all files Collapse all files

68
src/plugin/Plugin.h
View file

@ -14,25 +14,30 @@ namespace plugin {
class Manager;
class Component;
struct Description {
std::string name;
std::string description;
std::string url;
int version;
int api_version;
Description();
void Describe(ODesc* d);
};
struct BifItem {
class BifItem {
public:
// Values must match the integers bifcl generates.
enum Type { FUNCTION = 1, EVENT = 2, CONSTANT = 3, GLOBAL = 4, TYPE = 5 };
std::string id;
BifItem(const std::string& id, Type type);
BifItem(const BifItem& other);
BifItem& operator=(const BifItem& other);
~BifItem();
const char* GetID() const { return id; }
Type GetType() const { return type; }
private:
const char* id;
Type type;
};
inline BifItem::BifItem(const std::string& arg_id, Type arg_type)
{
id = copy_string(arg_id.c_str());
type = arg_type;
}
class Plugin {
public:
typedef std::list<Component *> component_list;
@ -41,15 +46,17 @@ public:
Plugin();
virtual ~Plugin();
Description GetDescription() const;
void SetDescription(Description& desc);
const char* Name();
const char* Description();
int Version();
int APIVersion();
component_list Components();
void InitBif();
// Must be called after InitBif() only.
const bif_item_list& BifItems();
bif_item_list BifItems();
virtual void Init();
virtual void Done();
@ -57,19 +64,42 @@ public:
void Describe(ODesc* d);
protected:
typedef std::list<std::pair<const char*, int> > bif_init_func_result;
typedef bif_init_func_result (*bif_init_func)();
void SetName(const char* name);
void SetDescription(const char* descr);
void SetVersion(int version);
void SetAPIVersion(int version);
/**
* Takes ownership.
*/
void AddComponent(Component* c);
typedef std::list<std::pair<std::string, int> > bif_init_func_result;
typedef bif_init_func_result (*bif_init_func)();
/**
* Can be overriden by derived class to inform the plugin about
* further BiF items they provide on their own (i.e., outside of the
* standard mechanism processing *.bif files automatically.). This
* information is for information purpuses only and will show up in
* the result of BifItem() as well as in the Describe() output.
*/
virtual bif_item_list CustomBifItems() ;
/**
* Internal function adding an entry point for registering
* auto-generated BiFs.
*/
void AddBifInitFunction(bif_init_func c);
private:
typedef std::list<bif_init_func> bif_init_func_list;
plugin::Description description;
const char* name;
const char* description;
int version;
int api_version;
component_list components;
bif_item_list bif_items;
bif_init_func_list bif_inits;