Elektra  0.8.16
Public Member Functions
kdb::tools::ModulesPluginDatabase Class Reference

A plugin database that works with installed modules. More...

#include <plugindatabase.hpp>

Inheritance diagram for kdb::tools::ModulesPluginDatabase:
Inheritance graph
[legend]
Collaboration diagram for kdb::tools::ModulesPluginDatabase:
Collaboration graph
[legend]

Public Member Functions

std::vector< std::string > listAllPlugins () const
 list all plugins More...
 
std::string lookupInfo (PluginSpec const &spec, std::string const &which) const
 lookup contract clauses or dynamic information More...
 
PluginSpec lookupMetadata (std::string const &which) const
 lookup which plugin handles meta data More...
 
PluginSpec lookupProvides (std::string const &provides) const
 lookup which plugin is a provider for that plugin More...
 

Additional Inherited Members

- Public Types inherited from kdb::tools::PluginDatabase
enum  Status { provides, real, missing }
 
- Static Public Member Functions inherited from kdb::tools::PluginDatabase
static int calculateStatus (std::string statusString)
 

Detailed Description

A plugin database that works with installed modules.

Member Function Documentation

std::vector< std::string > kdb::tools::ModulesPluginDatabase::listAllPlugins ( ) const
virtual

list all plugins

If Elektra is compiled with plugins, it will search for shared libraries. In any case, if no shared libraries were found it will fallback to an internal list (plugins that were compiled together with Elektra).

Returns
a list of all available plugins

Implements kdb::tools::PluginDatabase.

Reimplemented in kdb::tools::MockPluginDatabase.

std::string kdb::tools::ModulesPluginDatabase::lookupInfo ( PluginSpec const &  whichplugin,
std::string const &  which 
) const
virtual

lookup contract clauses or dynamic information

Parameters
whichpluginabout which plugin?
whichabout which clause in the contract?
Returns
the clause of the contract

Implements kdb::tools::PluginDatabase.

Reimplemented in kdb::tools::MockPluginDatabase.

PluginSpec kdb::tools::ModulesPluginDatabase::lookupMetadata ( std::string const &  which) const
virtual

lookup which plugin handles meta data

Parameters
whichthe meta data of interest
Returns
the best suited plugin specification which provides it

Implements kdb::tools::PluginDatabase.

PluginSpec kdb::tools::ModulesPluginDatabase::lookupProvides ( std::string const &  provides) const
virtual

lookup which plugin is a provider for that plugin

Note
will return a PluginSpec with getName() == provides if the string provides actually is a plugin name.
Parameters
providesis the provider to find
Exceptions
NoPluginif no plugin that provides the functionality could be found
Returns
the plugin itself or the best suited plugin specification which provides it

Implements kdb::tools::PluginDatabase.


The documentation for this class was generated from the following files: