pluginmanager.h 4.52 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2 3 4
**
** This file is part of Qt Creator
**
con's avatar
con committed
5
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
con's avatar
con committed
8
**
9
**
10
** GNU Lesser General Public License Usage
11
**
hjk's avatar
hjk committed
12 13 14 15 16 17
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this file.
** Please review the following information to ensure the GNU Lesser General
** Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
18
**
con's avatar
con committed
19
** In addition, as a special exception, Nokia gives you certain additional
hjk's avatar
hjk committed
20
** rights. These rights are described in the Nokia Qt LGPL Exception
con's avatar
con committed
21 22
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
23 24 25 26 27
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
con's avatar
con committed
28
** If you have questions regarding the use of this file, please contact
29
** Nokia at qt-info@nokia.com.
con's avatar
con committed
30
**
31
**************************************************************************/
hjk's avatar
hjk committed
32

con's avatar
con committed
33 34 35 36 37 38 39 40
#ifndef EXTENSIONSYSTEM_PLUGINMANAGER_H
#define EXTENSIONSYSTEM_PLUGINMANAGER_H

#include "extensionsystem_global.h"
#include <aggregation/aggregate.h>

#include <QtCore/QObject>
#include <QtCore/QReadWriteLock>
41
#include <QtCore/QStringList>
con's avatar
con committed
42 43 44

QT_BEGIN_NAMESPACE
class QTextStream;
45
class QSettings;
con's avatar
con committed
46 47 48
QT_END_NAMESPACE

namespace ExtensionSystem {
49
class PluginCollection;
hjk's avatar
hjk committed
50

con's avatar
con committed
51
namespace Internal {
hjk's avatar
hjk committed
52
class PluginManagerPrivate;
con's avatar
con committed
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
}

class IPlugin;
class PluginSpec;

class EXTENSIONSYSTEM_EXPORT PluginManager : public QObject
{
    Q_OBJECT

public:
    static PluginManager *instance();

    PluginManager();
    virtual ~PluginManager();

    // Object pool operations
    void addObject(QObject *obj);
    void removeObject(QObject *obj);
    QList<QObject *> allObjects() const;
    template <typename T> QList<T *> getObjects() const
    {
        QReadLocker lock(&m_lock);
        QList<T *> results;
        QList<QObject *> all = allObjects();
        QList<T *> result;
        foreach (QObject *obj, all) {
            result = Aggregation::query_all<T>(obj);
            if (!result.isEmpty())
                results += result;
        }
        return results;
    }
    template <typename T> T *getObject() const
    {
        QReadLocker lock(&m_lock);
        QList<QObject *> all = allObjects();
        T *result = 0;
        foreach (QObject *obj, all) {
            if ((result = Aggregation::query<T>(obj)) != 0)
                break;
        }
        return result;
    }

97 98 99
    QObject *getObjectByName(const QString &name) const;
    QObject *getObjectByClassName(const QString &className) const;

con's avatar
con committed
100
    // Plugin operations
101
    QList<PluginSpec *> loadQueue();
con's avatar
con committed
102 103 104
    void loadPlugins();
    QStringList pluginPaths() const;
    void setPluginPaths(const QStringList &paths);
105
    QList<PluginSpec *> plugins() const;
106
    QHash<QString, PluginCollection *> pluginCollections() const;
con's avatar
con committed
107 108
    void setFileExtension(const QString &extension);
    QString fileExtension() const;
109
    bool hasError() const;
con's avatar
con committed
110

111
    // Settings
112 113 114
    void setSettings(QSettings *settings);
    QSettings *settings() const;
    void readSettings();
115 116
    void writeSettings();

con's avatar
con committed
117 118 119 120 121 122 123 124 125 126
    // command line arguments
    QStringList arguments() const;
    bool parseOptions(const QStringList &args,
        const QMap<QString, bool> &appOptions,
        QMap<QString, QString> *foundAppOptions,
        QString *errorString);
    static void formatOptions(QTextStream &str, int optionIndentation, int descriptionIndentation);
    void formatPluginOptions(QTextStream &str, int optionIndentation, int descriptionIndentation) const;
    void formatPluginVersions(QTextStream &str) const;

127 128
    QString serializedArguments() const;

con's avatar
con committed
129 130 131
    bool runningTests() const;
    QString testDataDirectory() const;

132 133
    void profilingReport(const char *what, const PluginSpec *spec = 0);

con's avatar
con committed
134 135 136 137 138
signals:
    void objectAdded(QObject *obj);
    void aboutToRemoveObject(QObject *obj);

    void pluginsChanged();
139 140 141

public slots:
    void remoteArguments(const QString &serializedArguments);
142
    void shutdown();
143

con's avatar
con committed
144 145 146 147 148 149 150 151 152 153 154
private slots:
    void startTests();

private:
    Internal::PluginManagerPrivate *d;
    static PluginManager *m_instance;
    mutable QReadWriteLock m_lock;

    friend class Internal::PluginManagerPrivate;
};

hjk's avatar
hjk committed
155
} // namespace ExtensionSystem
con's avatar
con committed
156

hjk's avatar
hjk committed
157
#endif // EXTENSIONSYSTEM_PLUGINMANAGER_H