diff options
author | Ulf Hermann <ulf.hermann@qt.io> | 2020-09-29 15:49:16 +0200 |
---|---|---|
committer | Ulf Hermann <ulf.hermann@qt.io> | 2020-10-02 15:32:15 +0200 |
commit | 48426aa705cb7ed88489200864c2fc0143058671 (patch) | |
tree | 964b8588157dc122f7cf744ca8501ca4276dbeba /tools/shared/qmljsimporter.h | |
parent | febb6ba891616b71476b736d4c583054685c7766 (diff) |
Move the import handling code out of qmllint
We want to re-use this logic in other places.
Change-Id: I63cbee86a83265ddd241a4fae9ce8c48f38b5f18
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
Diffstat (limited to 'tools/shared/qmljsimporter.h')
-rw-r--r-- | tools/shared/qmljsimporter.h | 105 |
1 files changed, 105 insertions, 0 deletions
diff --git a/tools/shared/qmljsimporter.h b/tools/shared/qmljsimporter.h new file mode 100644 index 0000000000..44536acc51 --- /dev/null +++ b/tools/shared/qmljsimporter.h @@ -0,0 +1,105 @@ +/**************************************************************************** +** +** Copyright (C) 2020 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the tools applications of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:GPL-EXCEPT$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 3 as published by the Free Software +** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT +** included in the packaging of this file. Please review the following +** information to ensure the GNU General Public License requirements will +** be met: https://www.gnu.org/licenses/gpl-3.0.html. +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#ifndef QMLJSIMPORTER_H +#define QMLJSIMPORTER_H + +// +// W A R N I N G +// ------------- +// +// This file is not part of the Qt API. It exists purely as an +// implementation detail. This header file may change from version to +// version without notice, or even be removed. +// +// We mean it. + +#include "scopetree.h" +#include <QtQml/private/qqmldirparser_p.h> + +class QmlJSImporter +{ +public: + struct ImportedTypes + { + // C++ names used in qmltypes files for non-composite types + QHash<QString, ScopeTree::Ptr> cppNames; + + // Names a component intends to export, without prefix + QHash<QString, ScopeTree::Ptr> exportedQmlNames; + + // Names the importing component sees, possibly adding a prefix + QHash<QString, ScopeTree::Ptr> importedQmlNames; + }; + + QmlJSImporter(const QString ¤tDir, const QStringList &importPaths) : + m_currentDir(currentDir), m_importPaths(importPaths) {} + + ImportedTypes importBaseQmlTypes(const QStringList &qmltypesFiles); + ImportedTypes importFileOrDirectory( + const QString &fileOrDirectory, const QString &prefix = QString()); + ImportedTypes importModule( + const QString &module, const QString &prefix = QString(), + QTypeRevision version = QTypeRevision()); + + QStringList takeWarnings() + { + QStringList result = std::move(m_warnings); + m_warnings.clear(); + return result; + } + +private: + struct Import { + QHash<QString, ScopeTree::Ptr> objects; + QHash<QString, ScopeTree::Ptr> scripts; + QList<QQmlDirParser::Import> imports; + QList<QQmlDirParser::Import> dependencies; + }; + + void importHelper(const QString &module, ImportedTypes *types, + const QString &prefix = QString(), + QTypeRevision version = QTypeRevision()); + void processImport(const Import &import, ImportedTypes *types, + const QString &prefix = QString()); + void importDependencies(const QmlJSImporter::Import &import, + ImportedTypes *types, + const QString &prefix = QString(), + QTypeRevision version = QTypeRevision()); + void readQmltypes(const QString &filename, QHash<QString, ScopeTree::Ptr> *objects); + Import readQmldir(const QString &dirname); + ScopeTree::Ptr localFile2ScopeTree(const QString &filePath); + + QString m_currentDir; + QStringList m_importPaths; + QHash<QPair<QString, QTypeRevision>, Import> m_seenImports; + QHash<QString, ScopeTree::Ptr> m_importedFiles; + QStringList m_warnings; +}; + +#endif // QMLJSIMPORTER_H |