/home/kitware/dashboards/avogadro/libavogadro/src/pluginmanager.h

/**********************************************************************
  PluginManager - Class to handle dynamic loading/unloading of plugins

  Copyright (C) 2008 Donald Ephraim Curtis
  Copyright (C) 2008,2009 Tim Vandermeersch
  Copyright (C) 2008 Marcus D. Hanwell

  This file is part of the Avogadro molecular editor project.
  For more information, see <http://avogadro.openmolecules.net/>

  Avogadro is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.

  Avogadro is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  02110-1301, USA.
 **********************************************************************/

#ifndef PLUGINMANAGER_H
#define PLUGINMANAGER_H

#include <avogadro/global.h>
#include <avogadro/plugin.h>

#include <QStringList>

class QDir;
class QSettings;
class QFileInfo;

namespace Avogadro {

  class PluginFactory;
  class Tool;
  class Engine;
  class Extension;
  class Color;
  class PluginItemPrivate;

  class A_EXPORT PluginItem
  {
  public:
    PluginItem();
    //    PluginItem(int type, const QString &fileName, 
    //               const QString &filePath, PluginFactory *factory);
    PluginItem(const QString &name, const QString &identifier,
               const QString &description,
               Plugin::Type type, const QString &fileName, 
               const QString &filePath, PluginFactory *factory = 0, 
               bool enabled = true);
    ~PluginItem();

    int type() const;

    QString name() const;

    QString description() const;

    QString identifier() const;

    QString fileName() const;

    QString absoluteFilePath() const;

    bool isEnabled() const;

    PluginFactory *factory() const;

    void setType( Plugin::Type type );

    void setName( const QString &name );

    void setIdentifier( const QString &id );

    void setDescription( const QString &description );

    void setFileName( const QString &fileName );

    void setAbsoluteFilePath( const QString &filePath );

    void setEnabled( bool enable );

    void setFactory( PluginFactory *factory );

  private:
    PluginItemPrivate * const d;
  };

  class PluginManagerPrivate;
  class A_EXPORT PluginManager: public QObject
  {
  Q_OBJECT

  public:
    PluginManager(QObject *parent = 0);
    ~PluginManager();

    static PluginManager* instance();

    void setPluginPath(const QStringList& path);

    void setPluginPath(const QString& path);

    void addToPluginPath(const QStringList& path);

    void addToPluginPath(const QString& path);

    QStringList pluginPath() const;

    void loadFactories(const QString& dir = "");

    static void loadPluginList(const QDir &dir, const QStringList &plugins,
                               QSettings &settings);

    QList<PluginFactory *> factories( Plugin::Type type );

    PluginFactory *factory(const QString &id, Plugin::Type type);

    Extension *extension(const QString &id, QObject *parent = 0);

    Tool *tool(const QString &id, QObject *parent = 0);

    Color *color(const QString &id, QObject *parent = 0);

    Engine *engine(const QString &id, QObject *parent = 0);

    QList<QString> names(Plugin::Type type);

    QList<QString> identifiers(Plugin::Type type);

    QList<QString> descriptions(Plugin::Type type);

    QList<Extension *> extensions(QObject *parent=0);

    QList<Tool *> tools(QObject *parent=0);

    QList<Color *> colors(QObject *parent=0);

    void writeSettings(QSettings &settings);
    /*static void readSettings(QSettings &settings);*/

    QList<QString> toolScripts();

    QList<QString> engineScripts();

    QList<QString> extensionScripts();

    QList<PluginItem *> pluginItems(Plugin::Type);

  public Q_SLOTS:
    void reload();

  Q_SIGNALS:
    void reloadPlugins();

  private:
    PluginManagerPrivate * const d;

    static void loadPluginDir(const QString &directory, QSettings &settings);
    static void loadFactory(PluginFactory *factory, QFileInfo &fileInfo,
                            QSettings &settings);
    static QList<QString> scripts(const QString &type);
    static void initializeSearchDirs(QStringList &searchDirs);
  };

}

#endif