src/declarative/qml/qdeclarativeimport_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtDeclarative module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  33 **
  34 **
  35 **
  36 **
  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
  72 class QDeclarativeImports
  73 {
  74 public:
  75     QDeclarativeImports();
  76     QDeclarativeImports(const QDeclarativeImports &);
  77     ~QDeclarativeImports();
  78     QDeclarativeImports &operator=(const QDeclarativeImports &);
  79
  80     void setBaseUrl(const QUrl &url);
  81     QUrl baseUrl() const;
  82
  83     bool resolveType(const QByteArray& type,
  84                      QDeclarativeType** type_return, QUrl* url_return,
  85                      int *version_major, int *version_minor,
  86                      QDeclarativeImportedNamespace** ns_return,
  87                      QList<QDeclarativeError> *errors = 0) const;
  88     bool resolveType(QDeclarativeImportedNamespace*,
  89                      const QByteArray& type,
  90                      QDeclarativeType** type_return, QUrl* url_return,
  91                      int *version_major, int *version_minor) const;
  92
  93     bool addImport(QDeclarativeImportDatabase *,
  94                    const QString& uri, const QString& prefix, int vmaj, int vmin,
  95                    QDeclarativeScriptParser::Import::Type importType,
  96                    const QDeclarativeDirComponents &qmldircomponentsnetwork,
  97                    QList<QDeclarativeError> *errors);
  98
  99     void populateCache(QDeclarativeTypeNameCache *cache, QDeclarativeEngine *) const;
 100
 101 private:
 102     friend class QDeclarativeImportDatabase;
 103     QDeclarativeImportsPrivate *d;
 104 };
 105
 106 class QDeclarativeImportDatabase
 107 {
 108     Q_DECLARE_TR_FUNCTIONS(QDeclarativeImportDatabase)
 109 public:
 110     QDeclarativeImportDatabase(QDeclarativeEngine *);
 111     ~QDeclarativeImportDatabase();
 112
 113     bool importPlugin(const QString &filePath, const QString &uri, QList<QDeclarativeError> *errors);
 114
 115     QStringList importPathList() const;
 116     void setImportPathList(const QStringList &paths);
 117     void addImportPath(const QString& dir);
 118
 119     QStringList pluginPathList() const;
 120     void setPluginPathList(const QStringList &paths);
 121     void addPluginPath(const QString& path);
 122
 123 private:
 124     friend class QDeclarativeImportsPrivate;
 125     QString resolvePlugin(const QDir &qmldirPath, const QString &qmldirPluginPath,
 126                           const QString &baseName, const QStringList &suffixes,
 127                           const QString &prefix = QString());
 128     QString resolvePlugin(const QDir &qmldirPath, const QString &qmldirPluginPath,
 129                           const QString &baseName);
 130
 131
 132     QStringList filePluginPath;
 133     QStringList fileImportPath;
 134
 135     QSet<QString> initializedPlugins;
 136     QDeclarativeEngine *engine;
 137 };
 138
 139 QT_END_NAMESPACE
 140
 141 #endif // QDECLARATIVEIMPORT_P_H
 142