pluginManager.h

Go to the documentation of this file.

#ifndef BALL_PLUGIN_PLUGINMANAGER_H
#define BALL_PLUGIN_PLUGINMANAGER_H

#ifndef BALL_COMMON_GLOBAL_H
# include <BALL/COMMON/global.h>
#endif

#ifndef BALL_DATATYPE_STRING_H
# include <BALL/DATATYPE/string.h>
#endif

#include <QtCore/QString>
#include <QtCore/QStringList>
#include <QtCore/QHash>
#include <QtCore/QMutex>
#include <QtCore/QReadWriteLock>

#include <boost/shared_ptr.hpp>

#include <list>
#include <map>

class QPluginLoader;
class QObject;

namespace BALL
{
  class BALLPlugin;
  class PluginHandler;

  class BALL_EXPORT PluginManager
  {
    public:

      virtual ~PluginManager();

      static PluginManager& instance();

      bool addPluginDirectory(const QString& dir);

      bool removePluginDirectory(const QString& dir);

      std::vector<QString> getPluginDirectories() const;

      BALLPlugin* loadPlugin(const QString& plugin_name);

      bool unloadPlugin(const QString& plugin);

      QObject* getPluginInstance(const QString& plugin);

      QObject* getPluginInstance(int pos);

      bool startPlugin(int plugin);

      bool startPlugin(const QString& plugin);

      bool startPlugin(BALLPlugin* plugin);

      bool stopPlugin(int plugin);

      bool stopPlugin(const QString& plugin);

      bool stopPlugin(BALLPlugin* plugin);

      void unloadAllPlugins();

      int getPluginCount() const;

      void registerHandler(PluginHandler* h);

      void registerHandler(boost::shared_ptr<PluginHandler> h);

      bool unregisterHandler(PluginHandler* h);

      // needed for storing this classes' preferences
      virtual bool getPluginDirectories(String& value) const;
      virtual bool setPluginDirectories(const String&);

      virtual QString getAutoActivatePlugins() const;
      virtual bool setAutoActivatePlugins(const QString&);

      void autoActivatePlugin(const QString& str);
      void doNotAutoActivatePlugin(const QString& str);

    protected:
      static const char* BETWEEN_PLUGINDIR_SEPERATOR;

      typedef std::map<QString, vector<BALLPlugin*> > PluginDirMap;

      PluginManager();
      PluginManager(const PluginManager&);
      PluginManager& operator=(const PluginManager&);

      bool unloadDirectoryPlugins_(PluginDirMap::iterator it);
      PluginDirMap loaded_plugin_dirs_;

      QHash<QString, QPluginLoader*> loaders_;
      std::list<PluginHandler*> handlers_;
      std::list<boost::shared_ptr<PluginHandler> > shared_handlers_;

      QStringList autoactivate_plugins_;

      static boost::shared_ptr<PluginManager> manager_;

      //This mutex is used in the creation of the singleton
      static QMutex mutex_;
      //This mutex guards the handlers_ list
      mutable QReadWriteLock handler_mutex_;
      //This mutex guards the loaders_ list
      mutable QReadWriteLock loader_mutex_;
  };
}

#endif //BALL_PLUGIN_PLUGINMANAGER_H