M3::DynamicPlugin Class Reference

Manages the lifecycle of a dynamically loaded plugin. More...

#include <CLI/DynamicPlugin.hpp>

Inheritance diagram for M3::DynamicPlugin:

Collaboration diagram for M3::DynamicPlugin:

Public Member Functions
	DynamicPlugin (const std::string &sofile)
	Constructor that loads a plugin from a shared library file. More...
	DynamicPlugin (const char *sofile)
	Constructor that loads a plugin from a shared library file. More...
int	Run () override
	Run the plugin's main functionality. More...
MaCh3ArgumentParser *	get_parser () override
	Get the argument parser for this plugin. More...
virtual	~DynamicPlugin ()=default
	Destructor closes the shared library handle. More...
Public Member Functions inherited from M3::IPlugin
virtual	~IPlugin ()=default

Static Private Member Functions
static void	dlcloser (void *h)

Private Attributes
MaCh3ArgumentParser *	m_parser = nullptr
	Pointer to the plugin's argument parser, owned by the shared library. More...
std::unique_ptr< void, decltype(&dlcloser)>	m_handle
	Handle to the loaded shared library. More...
std::unique_ptr< IPlugin, destroy_plugin_t >	m_plugin
	Smart pointer to plugin with custom deleter. More...

Detailed Description

Manages the lifecycle of a dynamically loaded plugin.

This class wraps a plugin loaded from a shared library, maintaining the library handle and providing cleanup functionality using smart pointers.

Definition at line 16 of file DynamicPlugin.hpp.

Constructor & Destructor Documentation

DynamicPlugin() [1/2]

M3::DynamicPlugin::DynamicPlugin ( const std::string &  sofile )

inline

Constructor that loads a plugin from a shared library file.

Parameters

sofile

Path to the shared library file (.so)

Definition at line 20 of file DynamicPlugin.hpp.

                : DynamicPlugin(sofile.c_str()) {}

DynamicPlugin() [2/2]

M3::DynamicPlugin::DynamicPlugin ( const char *  sofile )

inline

Constructor that loads a plugin from a shared library file.

Parameters

sofile

Path to the shared library file (.so)

Definition at line 25 of file DynamicPlugin.hpp.

                : m_handle(nullptr, &DynamicPlugin::dlcloser),
                  m_plugin(nullptr, nullptr){
 
                
                m_handle.reset(dlopen(sofile, RTLD_NOW));
                if (!m_handle) {
                    std::cerr << "dlopen failed - shared library '"<< sofile << "' not loaded: " << dlerror() << "\n";
                    throw std::runtime_error("dlopen failed");
                }
 
                auto create = reinterpret_cast<create_plugin_t>(dlsym(m_handle.get(), "create_plugin"));
                auto destroy = reinterpret_cast<destroy_plugin_t>(dlsym(m_handle.get(), "destroy_plugin"));
 
                if (!create || !destroy) {
                    std::cerr << "Invalid plugin: " << sofile << "\n";
                    m_handle.reset(nullptr);
                    throw std::runtime_error("Invalid plugin - missing create_plugin or destroy_plugin");
                }
 
                try{
                    m_plugin = std::unique_ptr<IPlugin, destroy_plugin_t>(create(), destroy);
                    if (!m_plugin){
                        throw std::runtime_error("null pointer");
                    }
                }
                catch (...){
                    std::cerr << "Error instantiating plugin: " << sofile << "\n";
                    m_handle.reset(nullptr);
                    throw std::runtime_error("Error instantiating plugin");
                }
 
                try{
                    m_parser = m_plugin->get_parser();
                    if (!m_parser){
                        throw std::runtime_error("null pointer");
                    }
                }
                catch(...){
                    std::cerr<< "Error retrieving parser" << "\n";
                    m_plugin.reset(nullptr);
                    m_handle.reset(nullptr);
                    throw std::runtime_error("Error retrieving parser");
                }
            }

~DynamicPlugin()

virtual M3::DynamicPlugin::~DynamicPlugin ( )

virtualdefault

Destructor closes the shared library handle.

Member Function Documentation

dlcloser()

static void M3::DynamicPlugin::dlcloser ( void *  h )

inlinestaticprivate

Definition at line 90 of file DynamicPlugin.hpp.

                                          {
                if (h) dlclose(h);
            }

get_parser()

MaCh3ArgumentParser* M3::DynamicPlugin::get_parser ( )

inlineoverridevirtual

Get the argument parser for this plugin.

Returns

Pointer to the plugin's argument parser

pointer is owned by the shared library and will be deleted when the library is unloaded

Implements M3::IPlugin.

Definition at line 81 of file DynamicPlugin.hpp.

                                                       {
                return m_parser;
            }

Run()

int M3::DynamicPlugin::Run ( )

inlineoverridevirtual

Run the plugin's main functionality.

Returns

Exit code from the plugin

Implements M3::IPlugin.

Definition at line 73 of file DynamicPlugin.hpp.

                               {
                return m_plugin->Run();
            }

Member Data Documentation

m_handle

std::unique_ptr<void, decltype(&dlcloser)> M3::DynamicPlugin::m_handle

private

Handle to the loaded shared library.

Definition at line 95 of file DynamicPlugin.hpp.

m_parser

MaCh3ArgumentParser* M3::DynamicPlugin::m_parser = nullptr

private

Pointer to the plugin's argument parser, owned by the shared library.

Definition at line 93 of file DynamicPlugin.hpp.

m_plugin

std::unique_ptr<IPlugin, destroy_plugin_t> M3::DynamicPlugin::m_plugin

private

Smart pointer to plugin with custom deleter.

Definition at line 96 of file DynamicPlugin.hpp.

---

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

• CLI/DynamicPlugin.hpp