#include <PluginFactory.h>

Inheritance diagram for cet::PluginFactory:

Public Member Functions
	PluginFactory (cet::search_path const &search_path, std::string const &suffix="plugin")

void	setDiagReleaseVersion (std::string const &rv)

void	setDiagReleaseVersion (std::function< std::string()> rvf)

template<typename RESULT_TYPE , typename... ARGS>
RESULT_TYPE	call (std::string const &libspec, std::string const &funcname, ARGS &&...args) const

template<typename RESULT_TYPE , typename... ARGS>
auto	find (std::string const &funcname, std::string const &libspec) const -> RESULT_TYPE(*)(ARGS...)

template<typename RESULT_TYPE , typename... ARGS>
auto	find (std::string const &funcname, std::string const &libspec, LibraryManager::nothrow_t) const -> RESULT_TYPE(*)(ARGS...)

template<typename FUNCTION_TYPE >
std::enable_if_t< std::is_function_v< FUNCTION_TYPE >, FUNCTION_TYPE * >	find (std::string const &funcname, std::string const &libspec) const

virtual	~PluginFactory ()=default

	PluginFactory (PluginFactory const &)=delete

PluginFactory &	operator= (PluginFactory const &)=delete

Static Public Attributes
static LibraryManager::nothrow_t	nothrow

Private Member Functions
template<typename T >
void	resolveSymbolOrThrow_ (std::string const &libspec, std::string const &funcname, T &symbol) const

std::string	releaseVersion_ () const

Private Attributes
LibraryManager	lm_

std::string	releaseVersionString_ {}

std::function< std::string()>	releaseVersionFunc_ {}

Detailed Description

Definition at line 35 of file PluginFactory.h.

Constructor & Destructor Documentation

cet::PluginFactory::PluginFactory	(	cet::search_path const &	search_path,
		std::string const &	suffix = `"plugin"`
	)

explicit

Definition at line 5 of file PluginFactory.cc.

7 : lm_{search_path, suffix}

8 {}

cet::PluginFactory::lm_

LibraryManager lm_

Definition: PluginFactory.h:88

virtual cet::PluginFactory::~PluginFactory ( )

virtualdefault

cet::PluginFactory::PluginFactory ( PluginFactory const & )

delete

Member Function Documentation

template<typename RESULT_TYPE , typename... ARGS>

RESULT_TYPE cet::PluginFactory::call	(	std::string const &	libspec,
		std::string const &	funcname,
		ARGS &&...	args
	)		const

inline

Definition at line 107 of file PluginFactory.h.

 {
   return (*find<RESULT_TYPE, ARGS...>(libspec, funcname))(
     std::forward<ARGS>(args)...);
 }

template<typename RESULT_TYPE , typename... ARGS>

auto cet::PluginFactory::find	(	std::string const &	funcname,
		std::string const &	libspec
	)		const -> RESULT_TYPE (*)(ARGS...)

inline

Definition at line 127 of file PluginFactory.h.

 {
   RESULT_TYPE (*symbol)(ARGS...) = nullptr;
   resolveSymbolOrThrow_(libspec, funcname, symbol);
   return symbol;
 }

template<typename RESULT_TYPE , typename... ARGS>

auto cet::PluginFactory::find	(	std::string const &	funcname,
		std::string const &	libspec,
		LibraryManager::nothrow_t	nothrow
	)		const -> RESULT_TYPE (*)(ARGS...)

inline

Definition at line 138 of file PluginFactory.h.

 {
   return lm_.getSymbolByLibspec<RESULT_TYPE (*)(ARGS...)>(
     libspec, funcname, nothrow);
 }

template<typename FUNCTION_TYPE >

std::enable_if_t< std::is_function_v< FUNCTION_TYPE >, FUNCTION_TYPE * > cet::PluginFactory::find	(	std::string const &	funcname,
		std::string const &	libspec
	)		const

inline

Definition at line 117 of file PluginFactory.h.

 {
   FUNCTION_TYPE** symbol{nullptr};
   resolveSymbolOrThrow_(libspec, funcname, symbol);
   return *symbol;
 }

PluginFactory& cet::PluginFactory::operator= ( PluginFactory const & )

delete

std::string cet::PluginFactory::releaseVersion_ ( ) const

private

Definition at line 11 of file PluginFactory.cc.

 {
   std::string result;
   if (releaseVersionFunc_) {
     result = releaseVersionFunc_();
   } else {
     result = releaseVersionString_.empty() ? "Unknown" : releaseVersionString_;
   }
   return result;
 }

template<typename T >

void cet::PluginFactory::resolveSymbolOrThrow_	(	std::string const &	libspec,
		std::string const &	funcname,
		T &	symbol
	)		const

private

Definition at line 149 of file PluginFactory.h.

 {
   try {
     lm_.getSymbolByLibspec(libspec, funcname, symbol);
   }
   catch (exception const& e) {
     detail::wrapLibraryManagerException(
       e, "Plugin", libspec, releaseVersion_());
   }
   if (symbol == nullptr) {
     throw exception("Configuration", "BadPluginLibrary")
       << "Plugin " << libspec << " with version " << releaseVersion_()
       << " has internal symbol definition problems: consult an expert.";
   }
 }

void cet::PluginFactory::setDiagReleaseVersion ( std::string const & rv )

inline

Definition at line 100 of file PluginFactory.h.

 {
   releaseVersionString_ = rv;
 }

void cet::PluginFactory::setDiagReleaseVersion ( std::function< std::string()> rvf )

inline

Definition at line 94 of file PluginFactory.h.

 {
   releaseVersionFunc_ = rvf;
 }

Member Data Documentation

LibraryManager cet::PluginFactory::lm_

private

Definition at line 88 of file PluginFactory.h.

LibraryManager::nothrow_t cet::PluginFactory::nothrow

static

Definition at line 54 of file PluginFactory.h.

std::function<std::string()> cet::PluginFactory::releaseVersionFunc_ {}

private

Definition at line 90 of file PluginFactory.h.

std::string cet::PluginFactory::releaseVersionString_ {}

private

Definition at line 89 of file PluginFactory.h.

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

cetlib/cetlib/PluginFactory.h
cetlib/cetlib/PluginFactory.cc

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation