PluginManager.hpp

Go to the documentation of this file.

/*
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
#ifndef PLUGINMANAGER_H_
#define PLUGINMANAGER_H_

#include <string>
#include <vector>
#include <map>

namespace OpenAB {
class PluginManager
{
  public:

    static PluginManager& getInstance();

    virtual ~PluginManager();

    void scanDirectory(const std::string& path);

    std::string getDefaultModulesDirectory() const;

    std::map<std::string, std::string> getListOfPlugins() const;

    bool isPluginAvailable(const std::string& pluginName) const;

    template<typename __C, typename __P>
    __C* getPluginInstance(const std::string& pluginName, const __P& params);

    template<typename __C>
    void freePluginInstance(__C* instance);

#ifdef TESTING
    void clean()
    {
      pluginsInfo.clear();
      loadedModulesInfo.clear();
      pluginInstancesInfo.clear();
    }

    std::map<void*, std::string> getPluginInstancesInfo()
    {
      return pluginInstancesInfo;
    }

    std::vector<std::string> getLoadedModules()
    {
      std::vector<std::string> result;
      std::map<std::string, LoadedModulesInfo>::iterator it;
      for (it = loadedModulesInfo.begin(); it != loadedModulesInfo.end(); ++it)
      {
        result.push_back((*it).first);
      }

      return result;
    }

#endif
  private:
    PluginManager();

    PluginManager(PluginManager const &other);

    PluginManager& operator=(PluginManager const &other);

    bool loadModule(const std::string& modulePath);

    bool unloadModule(const std::string& modulePath);

    std::string getPluginModuleName(const std::string& pluginName) const;

    static void pluginLoadedCb(const std::string& name);

    static std::vector<std::string> loadedPlugins;


    typedef std::map<std::string, std::string> PluginsInfo;

    PluginsInfo pluginsInfo;

    struct LoadedModulesInfo
    {
        LoadedModulesInfo() :
          refCount(0),
          module(NULL)
        {}

        LoadedModulesInfo(void* p) :
          refCount(0),
          module(p)
        {}

        unsigned int refCount;
        void* module;
    };

    std::map<std::string, LoadedModulesInfo> loadedModulesInfo;

    std::map<void*, std::string> pluginInstancesInfo;

    static PluginManager instance;
};

} // namespace OpenAB
#include <helpers/PluginManagerTemplates.hpp>

#endif // PLUGINMANAGER_H_