1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://www.qt.io/licensing/
5 **
6 ** This file is part of the QtDeclarative 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 http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://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 2.1 or version 3 as published by the Free
20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22 ** following information to ensure the GNU Lesser General Public License
23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 **
26 ** As a special exception, The Qt Company gives you certain additional
27 ** rights. These rights are described in The Qt Company LGPL Exception
28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 **
30 ** GNU General Public License Usage
31 ** Alternatively, this file may be used under the terms of the GNU
32 ** General Public License version 3.0 as published by the Free Software
33 ** Foundation and appearing in the file LICENSE.GPL included in the
34 ** packaging of this file.  Please review the following information to
35 ** ensure the GNU General Public License version 3.0 requirements will be
36 ** met: http://www.gnu.org/copyleft/gpl.html.
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41 
42 #ifndef QDECLARATIVEIMPORT_P_H
43 #define QDECLARATIVEIMPORT_P_H
44 
45 #include <QtCore/qurl.h>
46 #include <QtCore/qcoreapplication.h>
47 #include <QtCore/qset.h>
48 #include <private/qdeclarativedirparser_p.h>
49 #include <private/qdeclarativescriptparser_p.h>
50 #include <private/qdeclarativemetatype_p.h>
51 
52 //
53 //  W A R N I N G
54 //  -------------
55 //
56 // This file is not part of the Qt API.  It exists purely as an
57 // implementation detail.  This header file may change from version to
58 // version without notice, or even be removed.
59 //
60 // We mean it.
61 //
62 
63 QT_BEGIN_NAMESPACE
64 
65 class QDeclarativeTypeNameCache;
66 class QDeclarativeEngine;
67 class QDir;
68 class QDeclarativeImportedNamespace;
69 class QDeclarativeImportsPrivate;
70 class QDeclarativeImportDatabase;
71 class QDeclarativeTypeLoader;
72 
73 class QDeclarativeImports
74 {
75 public:
76     QDeclarativeImports();
77     QDeclarativeImports(QDeclarativeTypeLoader *);
78     QDeclarativeImports(const QDeclarativeImports &);
79     ~QDeclarativeImports();
80     QDeclarativeImports &operator=(const QDeclarativeImports &);
81 
82     void setBaseUrl(const QUrl &url);
83     QUrl baseUrl() const;
84 
85     bool resolveType(const QByteArray& type,
86                      QDeclarativeType** type_return, QUrl* url_return,
87                      int *version_major, int *version_minor,
88                      QDeclarativeImportedNamespace** ns_return,
89                      QString *errorString = 0) const;
90     bool resolveType(QDeclarativeImportedNamespace*,
91                      const QByteArray& type,
92                      QDeclarativeType** type_return, QUrl* url_return,
93                      int *version_major, int *version_minor) const;
94 
95     bool addImport(QDeclarativeImportDatabase *,
96                    const QString& uri, const QString& prefix, int vmaj, int vmin,
97                    QDeclarativeScriptParser::Import::Type importType,
98                    const QDeclarativeDirComponents &qmldircomponentsnetwork,
99                    QString *errorString);
100 
101     void populateCache(QDeclarativeTypeNameCache *cache, QDeclarativeEngine *) const;
102 
103 private:
104     friend class QDeclarativeImportDatabase;
105     QDeclarativeImportsPrivate *d;
106 };
107 
108 class QDeclarativeImportDatabase
109 {
110     Q_DECLARE_TR_FUNCTIONS(QDeclarativeImportDatabase)
111 public:
112     QDeclarativeImportDatabase(QDeclarativeEngine *);
113     ~QDeclarativeImportDatabase();
114 
115     bool importPlugin(const QString &filePath, const QString &uri, QString *errorString);
116 
117     QStringList importPathList() const;
118     void setImportPathList(const QStringList &paths);
119     void addImportPath(const QString& dir);
120 
121     QStringList pluginPathList() const;
122     void setPluginPathList(const QStringList &paths);
123     void addPluginPath(const QString& path);
124 
125 private:
126     friend class QDeclarativeImportsPrivate;
127     QString resolvePlugin(const QDir &qmldirPath, const QString &qmldirPluginPath,
128                           const QString &baseName, const QStringList &suffixes,
129                           const QString &prefix = QString());
130     QString resolvePlugin(const QDir &qmldirPath, const QString &qmldirPluginPath,
131                           const QString &baseName);
132 
133 
134     QStringList filePluginPath;
135     QStringList fileImportPath;
136 
137     QSet<QString> initializedPlugins;
138     QDeclarativeEngine *engine;
139 };
140 
141 QT_END_NAMESPACE
142 
143 #endif // QDECLARATIVEIMPORT_P_H
144 
145