src/plugins/qmldesigner/designercore/pluginmanager/widgetpluginpath.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (qt-info@nokia.com)
   8 **
   9 ** No Commercial Usage
  10 **
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 **
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Nokia gives you certain additional
  26 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** If you have questions regarding the use of this file, please contact
  30 ** Nokia at qt-info@nokia.com.
  31 **
  32 **************************************************************************/
  33
  34 #ifndef WIDGETPLUGINPATH_H
  35 #define WIDGETPLUGINPATH_H
  36
  37 #include "widgetpluginmanager.h"
  38
  39 #include <QtCore/QObject>
  40 #include <QWeakPointer>
  41 #include <QtCore/QList>
  42 #include <QtCore/QDir>
  43 #include <QtGui/QStandardItem>
  44
  45 QT_BEGIN_NAMESPACE
  46 class QString;
  47 class QAbstractItemModel;
  48 QT_END_NAMESPACE
  49
  50 namespace QmlDesigner {
  51 class IWidgetPlugin;
  52 namespace Internal {
  53
  54
  55
  56 // Dumb plugin data structure. Note that whereas QObjects can
  57 // casted to an interface, QWeakPointer does not work with the
  58 // interface class, so, we need a separate QWeakPointer as a guard
  59 // to detect the deletion of a plugin instance which can happen
  60 // in theory.
  61 struct WidgetPluginData {
  62     WidgetPluginData(const QString &p = QString());
  63
  64     QString path;
  65     bool failed;
  66     QString errorMessage;
  67     QWeakPointer<QObject> instanceGuard;
  68     IWidgetPlugin *instance;
  69 };
  70
  71
  72 // PluginPath: Manages a plugin directory. It does nothing
  73 // on construction following the "as lazy as possible" principle.
  74 // In the "loaded" stage, it scans the directories and creates
  75 // a list of PluginData for the libraries found.
  76 // getInstances() will return the fully initialized list of
  77 // IPlugins.
  78
  79 class WidgetPluginPath {
  80 public:
  81     explicit WidgetPluginPath(const QDir &path);
  82
  83
  84     void getInstances(WidgetPluginManager::IWidgetPluginList *list);
  85
  86     QDir path() const { return m_path; }
  87
  88     //  Convenience to populate a "About Plugin" dialog with
  89     // plugins from that path. Forces initialization.
  90     QStandardItem *createModelItem();
  91
  92 private:
  93     typedef QList<WidgetPluginData> PluginDataList;
  94
  95     static QStringList libraryFilePaths(const QDir &dir);
  96     void clear();
  97     void ensureLoaded();
  98
  99     QDir m_path;
 100     bool m_loaded;
 101     PluginDataList m_plugins;
 102 };
 103
 104 } // namespace Internal
 105 } // namespace QmlDesigner
 106 #endif // WIDGETPLUGINPATH_H