src/corelib/plugin/qlibrary_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtCore module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QLIBRARY_P_H
  43 #define QLIBRARY_P_H
  44
  45 //
  46 //  W A R N I N G
  47 //  -------------
  48 //
  49 // This file is not part of the Qt API.  It exists for the convenience
  50 // of the QLibrary class.  This header file may change from
  51 // version to version without notice, or even be removed.
  52 //
  53 // We mean it.
  54 //
  55
  56 #include "QtCore/qlibrary.h"
  57 #include "QtCore/qpointer.h"
  58 #include "QtCore/qstringlist.h"
  59 #include "QtCore/qplugin.h"
  60 #include "QtCore/qsharedpointer.h"
  61 #include "QtCore/qjsonobject.h"
  62 #include "QtCore/qjsondocument.h"
  63 #include "QtCore/qendian.h"
  64 #ifdef Q_OS_WIN
  65 #  include "QtCore/qt_windows.h"
  66 #endif
  67
  68 #ifndef QT_NO_LIBRARY
  69
  70 QT_BEGIN_NAMESPACE
  71
  72 bool qt_debug_component();
  73
  74 class QLibraryPrivate
  75 {
  76 public:
  77
  78 #ifdef Q_OS_WIN
  79     HINSTANCE
  80 #else
  81     void *
  82 #endif
  83     pHnd;
  84
  85     QString fileName, qualifiedFileName;
  86     QString fullVersion;
  87
  88     bool load();
  89     bool loadPlugin(); // loads and resolves instance
  90     bool unload();
  91     void release();
  92     QFunctionPointer resolve(const char *);
  93
  94     static QLibraryPrivate *findOrCreate(const QString &fileName, const QString &version = QString());
  95
  96     static QVector<QStaticPlugin> staticPlugins();
  97
  98
  99     QPointer<QObject> inst;
 100     QtPluginInstanceFunction instance;
 101     QJsonObject metaData;
 102     bool compatPlugin;
 103
 104     QString errorString;
 105     QLibrary::LoadHints loadHints;
 106
 107     bool isPlugin();
 108
 109     static inline QJsonDocument fromRawMetaData(const char *raw) {
 110         raw += strlen("QTMETADATA  ");
 111         // the size of the embedded JSON object can be found 8 bytes into the data (see qjson_p.h),
 112         // but doesn't include the size of the header (8 bytes)
 113         QByteArray json(raw, qFromLittleEndian<uint>(*(uint *)(raw + 8)) + 8);
 114         return QJsonDocument::fromBinaryData(json);
 115     }
 116
 117 private:
 118     explicit QLibraryPrivate(const QString &canonicalFileName, const QString &version);
 119     ~QLibraryPrivate();
 120
 121     bool load_sys();
 122     bool unload_sys();
 123     QFunctionPointer resolve_sys(const char *);
 124
 125     QAtomicInt libraryRefCount;
 126     QAtomicInt libraryUnloadCount;
 127
 128     enum { IsAPlugin, IsNotAPlugin, MightBeAPlugin } pluginState;
 129     friend class QLibraryPrivateHasFriends;
 130 };
 131
 132 QT_END_NAMESPACE
 133
 134 #endif // QT_NO_LIBRARY
 135
 136 #endif // QLIBRARY_P_H