telPluginManager.h

Go to the documentation of this file.

#ifndef telPluginManagerH
#define telPluginManagerH
#include <vector>
#include <string>
#include <sstream>
#include <ostream>
#include "telCoreExporter.h"
#include "telConstants.h"
#include "telStringList.h"
#include "Poco/SharedLibrary.h"

//---------------------------------------------------------------------------
/* A minimalistic Plugin manager. */

namespace tlp
{

using std::stringstream;
using std::string;
using std::vector;
using std::pair;
using std::ostream;
using tlp::gEmptyString;

//using tlp::StringList;
using Poco::SharedLibrary;

class Plugin;

typedef pair< Poco::SharedLibrary*, Plugin* > telPlugin;

class CORE_DECLSPEC PluginManager
{
    public:
                                            PluginManager(const string& pluginFolder = gEmptyString);
        virtual                            ~PluginManager();

        string                              getInfo() const;

        bool                                setPluginDir(const string& dir);

        string                              getPluginDir() const;

        int                                 load(const string& pluginName = gEmptyString);

        bool                                unload(Plugin* plugin = NULL);

        int                                 getNumberOfPlugins() const;

        int                                 getNumberOfCategories() const;

        Plugin*                             getFirstPlugin() const;

        Plugin*                             getNextPlugin() const;

        Plugin*                             getPreviousPlugin() const;

        Plugin*                             getCurrentPlugin() const;

        Plugin*                             getPlugin(const string& name) const;

        tlp::StringList                     getPluginNames() const;

        tlp::StringList                     getPluginLibraryNames() const;

        CORE_DECLSPEC
        friend ostream&                     operator<<(ostream& os, PluginManager& pm);

        Plugin*                             operator[](const int& i);

        bool                                hasLoadErrors() const;
        string                              getLoadErrors() const;

    private:
        string                              mPluginFolder;
        string                              mPluginExtension;       //Different on different OS's
        string                              mPluginPrefix;          //Different on different OS's
        stringstream                        mLoadPluginErrors;      //Accumulated load errors
        mutable vector< telPlugin >                 mPlugins;
        mutable vector< telPlugin >::iterator       mPluginsIter;

        bool                                loadPlugin(const string& sharedLib);
        bool                                checkImplementationLanguage(SharedLibrary* plugin);
        const char*                         getImplementationLanguage(SharedLibrary* plugin);
        Plugin*                             createCPlugin(SharedLibrary *libHandle);
        Plugin*                             getPlugin(const int& i);
        bool                                unloadAll();
        void                                clearLoadErrors();
};

}
#endif