qtdeclarative/tools/qmltc/main.cpp

258 lines
9.4 KiB
C++

/****************************************************************************
**
** Copyright (C) 2021 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$
**
****************************************************************************/
#include "qmltccommandlineutils.h"
#include "qmltcvisitor.h"
#include "qmltctyperesolver.h"
#include "qmltccompiler.h"
#include <private/qqmljscompiler_p.h>
#include <private/qqmljsresourcefilemapper_p.h>
#include <QtCore/qcoreapplication.h>
#include <QtCore/qurl.h>
#include <QtCore/qhashfunctions.h>
#include <QtCore/qfileinfo.h>
#include <QtCore/qlibraryinfo.h>
#include <QtCore/qcommandlineparser.h>
#include <QtQml/private/qqmljslexer_p.h>
#include <QtQml/private/qqmljsparser_p.h>
#include <QtQml/private/qqmljsengine_p.h>
#include <QtQml/private/qqmljsastvisitor_p.h>
#include <QtQml/private/qqmljsast_p.h>
#include <QtQml/private/qqmljsdiagnosticmessage_p.h>
#include <cstdlib> // EXIT_SUCCESS, EXIT_FAILURE
using namespace Qt::StringLiterals;
void setupLogger(QQmlJSLogger &logger) // prepare logger to work with compiler
{
const QSet<QQmlJSLoggerCategory> exceptions {
Log_ControlsSanity, // this category is just weird
Log_UnusedImport, // not critical
};
for (int i = 0; i <= static_cast<int>(QQmlJSLoggerCategory_Last); ++i) {
const auto c = static_cast<QQmlJSLoggerCategory>(i);
if (exceptions.contains(c))
continue;
logger.setCategoryLevel(c, QtCriticalMsg);
logger.setCategoryIgnored(c, false);
}
}
int main(int argc, char **argv)
{
// Produce reliably the same output for the same input by disabling QHash's
// random seeding.
qSetGlobalQHashSeed(0);
QCoreApplication app(argc, argv);
QCoreApplication::setApplicationName(u"qmltc"_s);
QCoreApplication::setApplicationVersion(QStringLiteral(QT_VERSION_STR));
// command-line parsing:
QCommandLineParser parser;
parser.addHelpOption();
parser.addVersionOption();
QCommandLineOption importPathOption {
u"I"_s, QCoreApplication::translate("main", "Look for QML modules in specified directory"),
QCoreApplication::translate("main", "import directory")
};
parser.addOption(importPathOption);
QCommandLineOption qmldirOption {
u"i"_s, QCoreApplication::translate("main", "Include extra qmldir files"),
QCoreApplication::translate("main", "qmldir file")
};
parser.addOption(qmldirOption);
QCommandLineOption outputCppOption {
u"impl"_s, QCoreApplication::translate("main", "Generated C++ source file path"),
QCoreApplication::translate("main", "cpp path")
};
parser.addOption(outputCppOption);
QCommandLineOption outputHOption {
u"header"_s, QCoreApplication::translate("main", "Generated C++ header file path"),
QCoreApplication::translate("main", "h path")
};
parser.addOption(outputHOption);
QCommandLineOption resourceOption {
u"resource"_s,
QCoreApplication::translate(
"main", "Qt resource file that might later contain one of the compiled files"),
QCoreApplication::translate("main", "resource file name")
};
parser.addOption(resourceOption);
QCommandLineOption namespaceOption {
u"namespace"_s, QCoreApplication::translate("main", "Namespace of the generated C++ code"),
QCoreApplication::translate("main", "namespace")
};
parser.addOption(namespaceOption);
parser.process(app);
const QStringList sources = parser.positionalArguments();
if (sources.size() != 1) {
if (sources.isEmpty()) {
parser.showHelp();
} else {
fprintf(stderr, "%s\n",
qPrintable(u"Too many input files specified: '"_s + sources.join(u"' '"_s)
+ u'\''));
}
return EXIT_FAILURE;
}
const QString inputFile = sources.first();
QString url = parseUrlArgument(inputFile);
if (url.isNull())
return EXIT_FAILURE;
if (!url.endsWith(u".qml")) {
fprintf(stderr, "Non-QML file passed as input\n");
return EXIT_FAILURE;
}
QString sourceCode = loadUrl(url);
if (sourceCode.isEmpty())
return EXIT_FAILURE;
QString implicitImportDirectory = getImplicitImportDirectory(url);
if (implicitImportDirectory.isEmpty())
return EXIT_FAILURE;
QStringList importPaths = parser.values(importPathOption);
importPaths.append(QLibraryInfo::path(QLibraryInfo::QmlImportsPath));
QStringList qmldirFiles = parser.values(qmldirOption);
QString outputCppFile;
if (!parser.isSet(outputCppOption)) {
outputCppFile = url.first(url.size() - 3) + u"cpp"_s;
} else {
outputCppFile = parser.value(outputCppOption);
}
QString outputHFile;
if (!parser.isSet(outputHOption)) {
outputHFile = url.first(url.size() - 3) + u"h"_s;
} else {
outputHFile = parser.value(outputHOption);
}
if (!parser.isSet(resourceOption)) {
fprintf(stderr, "No resource paths for file: %s\n", qPrintable(inputFile));
return EXIT_FAILURE;
}
// main logic:
QQmlJS::Engine engine;
QQmlJS::Lexer lexer(&engine);
lexer.setCode(sourceCode, /*lineno = */ 1);
QQmlJS::Parser qmlParser(&engine);
if (!qmlParser.parse()) {
const auto diagnosticMessages = qmlParser.diagnosticMessages();
for (const QQmlJS::DiagnosticMessage &m : diagnosticMessages) {
fprintf(stderr, "%s\n",
qPrintable(QStringLiteral("%1:%2:%3: %4")
.arg(inputFile)
.arg(m.loc.startLine)
.arg(m.loc.startColumn)
.arg(m.message)));
}
return EXIT_FAILURE;
}
const QStringList resourceFiles = parser.values(resourceOption);
QQmlJSResourceFileMapper mapper(resourceFiles);
// verify that we can map current file to qrc (then use the qrc path later)
const QStringList paths = mapper.resourcePaths(QQmlJSResourceFileMapper::localFileFilter(url));
if (paths.isEmpty()) {
fprintf(stderr, "Failed to find a resource path for file: %s\n", qPrintable(inputFile));
return EXIT_FAILURE;
} else if (paths.size() > 1) {
fprintf(stderr, "Too many (expected 1) resource paths for file: %s\n",
qPrintable(inputFile));
return EXIT_FAILURE;
}
QmltcCompilerInfo info;
info.outputCppFile = parser.value(outputCppOption);
info.outputHFile = parser.value(outputHOption);
info.resourcePath = paths.first();
info.outputNamespace = parser.value(namespaceOption);
if (info.outputCppFile.isEmpty()) {
fprintf(stderr, "An output C++ file is required. Pass one using --impl");
return EXIT_FAILURE;
}
if (info.outputHFile.isEmpty()) {
fprintf(stderr, "An output C++ header file is required. Pass one using --header");
return EXIT_FAILURE;
}
QQmlJSImporter importer { importPaths, &mapper };
auto createQmltcVisitor = [](const QQmlJSScope::Ptr &root, QQmlJSImporter *importer,
QQmlJSLogger *logger, const QString &implicitImportDirectory,
const QStringList &qmldirFiles) -> QQmlJSImportVisitor * {
return new QmltcVisitor(root, importer, logger, implicitImportDirectory, qmldirFiles);
};
importer.setImportVisitorCreator(createQmltcVisitor);
QQmlJSLogger logger;
logger.setFileName(url);
logger.setCode(sourceCode);
setupLogger(logger);
QmltcVisitor visitor(QQmlJSScope::create(), &importer, &logger,
QQmlJSImportVisitor::implicitImportDirectory(url, &mapper), qmldirFiles);
QmltcTypeResolver typeResolver { &importer };
typeResolver.init(&visitor, qmlParser.rootNode());
if (logger.hasErrors())
return EXIT_FAILURE;
QList<QQmlJS::DiagnosticMessage> warnings = importer.takeGlobalWarnings();
if (!warnings.isEmpty()) {
logger.log(QStringLiteral("Type warnings occurred while compiling file:"), Log_Import,
QQmlJS::SourceLocation());
logger.processMessages(warnings, Log_Import);
// Log_Import is critical for the compiler
return EXIT_FAILURE;
}
QmltcCompiler compiler(url, &typeResolver, &visitor, &logger);
compiler.compile(info);
if (logger.hasErrors())
return EXIT_FAILURE;
return EXIT_SUCCESS;
}