opluginloader.h

Go to the documentation of this file.

/*
 * LGPLv2 or later
 * zecke@handhelds.org
 */
#ifndef ODP_CORE_OPLUGIN_LOADER_H
#define ODP_CORE_OPLUGIN_LOADER_H

#include <qpe/qlibrary.h>

#include <qptrdict.h>
#include <qstringlist.h>

namespace Opie {
namespace Core {
class OConfig;
namespace Internal {
class OPluginLibraryHolder;
}

class OPluginItem {
public:
    typedef QValueList<OPluginItem> List;
    OPluginItem();
    OPluginItem( const QString& name, const QString& path, bool enabled = true, int pos = -1 );
    ~OPluginItem();

    bool isEmpty()const;

    bool operator==( const OPluginItem& )const;
    bool operator!=( const OPluginItem& )const;


    QString  name()const;
    QString  path()const;
    bool isEnabled()const;
    int position()const;

    void setName( const QString& );
    void setPath( const QString& );
    void setEnabled(  bool );
    void setPosition( int );

private:
    QString m_name;
    QString m_path;
    bool  m_enabled : 1;
    int m_pos;
    struct Private;
    Private *d;
};

class OGenericPluginLoader {
public:
    typedef OPluginItem::List List;
    OGenericPluginLoader( const QString &name, bool isSorted = false );
    virtual ~OGenericPluginLoader();

    void setAutoDelete( bool );
    bool autoDelete()const;
    void clear();

    QString name()const;
    bool isSorted()const;
    bool isInSafeMode()const;


    List  allAvailable(bool sorted = false )const;
    List  filtered(bool sorted = false )const;


    virtual QUnknownInterface* load( const OPluginItem& item, const QUuid& );
    virtual void unload( QUnknownInterface* );

protected:
    friend class OPluginManager; // we need the static unlibify
    void readConfig();
    virtual List plugins( const QString& dir, bool sorted, bool disabled )const;
    void setPluginDirs( const QStringList& );
    void setPluginDir( const QString& );
    void setSafeMode(const QString& app = QString::null,  bool b = false);
    static QString unlibify( const QString& str );
private:
    QStringList languageList();
    void installTranslators(const QString& type);
    QString m_dir;
    QStringList m_plugDirs;
    QStringList m_languages;
    bool m_autoDelete : 1;
    bool m_isSafeMode : 1;
    bool m_isSorted   : 1;
    QPtrDict<QLibrary> m_library;

    struct Private;
    Private* d;
};

class OPluginLoader : public OGenericPluginLoader {
public:
    OPluginLoader( const QString& name, bool sorted = false );
    virtual ~OPluginLoader();

    template<class IFace>
    IFace* load( const OPluginItem& item, const QUuid& );
};

class OPluginManager {
public:
    typedef QValueList<OPluginManager*> List;
    OPluginManager( OGenericPluginLoader* );
    OPluginManager( const QString& name, const OPluginItem::List&, bool isSorted = false );
    virtual ~OPluginManager();

    OPluginItem crashedPlugin()const;

    OPluginItem::List managedPlugins()const;

    void setPosition( const OPluginItem& );
    void enable( const OPluginItem& );
    void disable( const OPluginItem& );
    void setEnabled( const OPluginItem&, bool = true);

    virtual void load();
    virtual void save();

protected:
    QString configName()const;
    void replace( const OPluginItem& );
private:
    OGenericPluginLoader *m_loader;
    QString m_cfgName;
    OPluginItem::List m_plugins;
    OPluginItem m_crashed;
    bool m_isSorted : 1;
};


template<class IFace>
IFace* OPluginLoader::load( const OPluginItem& item, const QUuid& uid ) {
    return static_cast<IFace*>( OGenericPluginLoader::load( item, uid ) );
}

}
}


#endif

---