1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtCore module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QLIBRARY_H
41#define QLIBRARY_H
42
43#include <QtCore/qobject.h>
44#include <QtCore/qtaggedpointer.h>
45
46QT_REQUIRE_CONFIG(library);
47
48QT_BEGIN_NAMESPACE
49
50class QLibraryPrivate;
51
52class Q_CORE_EXPORT QLibrary : public QObject
53{
54 Q_OBJECT
55 Q_PROPERTY(QString fileName READ fileName WRITE setFileName)
56 Q_PROPERTY(LoadHints loadHints READ loadHints WRITE setLoadHints)
57public:
58 enum LoadHint {
59 ResolveAllSymbolsHint = 0x01,
60 ExportExternalSymbolsHint = 0x02,
61 LoadArchiveMemberHint = 0x04,
62 PreventUnloadHint = 0x08,
63 DeepBindHint = 0x10
64 };
65 Q_DECLARE_FLAGS(LoadHints, LoadHint)
66 Q_FLAG(LoadHint)
67 Q_FLAG(LoadHints)
68
69 explicit QLibrary(QObject *parent = nullptr);
70 explicit QLibrary(const QString &fileName, QObject *parent = nullptr);
71 explicit QLibrary(const QString &fileName, int verNum, QObject *parent = nullptr);
72 explicit QLibrary(const QString &fileName, const QString &version, QObject *parent = nullptr);
73 ~QLibrary();
74
75 QFunctionPointer resolve(const char *symbol);
76 static QFunctionPointer resolve(const QString &fileName, const char *symbol);
77 static QFunctionPointer resolve(const QString &fileName, int verNum, const char *symbol);
78 static QFunctionPointer resolve(const QString &fileName, const QString &version, const char *symbol);
79
80 bool load();
81 bool unload();
82 bool isLoaded() const;
83
84 static bool isLibrary(const QString &fileName);
85
86 void setFileName(const QString &fileName);
87 QString fileName() const;
88
89 void setFileNameAndVersion(const QString &fileName, int verNum);
90 void setFileNameAndVersion(const QString &fileName, const QString &version);
91 QString errorString() const;
92
93 void setLoadHints(LoadHints hints);
94 LoadHints loadHints() const;
95
96private:
97 enum LoadStatusTag {
98 NotLoaded,
99 Loaded
100 };
101
102 QTaggedPointer<QLibraryPrivate, LoadStatusTag> d = nullptr;
103 Q_DISABLE_COPY(QLibrary)
104};
105
106Q_DECLARE_OPERATORS_FOR_FLAGS(QLibrary::LoadHints)
107
108QT_END_NAMESPACE
109
110#endif //QLIBRARY_H
111