1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
|
// Copyright (C) 2021 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#include "qmltccommandlineutils.h"
#include "qmltcvisitor.h"
#include "qmltctyperesolver.h"
#include "qmltccompiler.h"
#include <private/qqmljscompiler_p.h>
#include <private/qqmljsresourcefilemapper_p.h>
#include <private/qqmljsutils_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 <QtCore/qregularexpression.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 <QtQmlCompiler/qqmlsa.h>
#include <QtQmlCompiler/private/qqmljsliteralbindingcheck_p.h>
#include <cstdlib> // EXIT_SUCCESS, EXIT_FAILURE
using namespace Qt::StringLiterals;
void setupLogger(QQmlJSLogger &logger) // prepare logger to work with compiler
{
for (const QQmlJS::LoggerCategory &category : logger.categories()) {
if (category.id() == qmlUnusedImports)
continue;
logger.setCategoryLevel(category.id(), QtCriticalMsg);
logger.setCategoryIgnored(category.id(), false);
}
}
int main(int argc, char **argv)
{
// Produce reliably the same output for the same input by disabling QHash's
// random seeding.
QHashSeed::setDeterministicGlobalSeed();
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 bareOption {
u"bare"_s,
QCoreApplication::translate(
"main", "Do not include default import directories. This may be used to run "
"qmltc on a project using a different Qt version.")
};
parser.addOption(bareOption);
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 metaResourceOption {
u"meta-resource"_s,
QCoreApplication::translate("main", "Qt meta information file (in .qrc format)"),
QCoreApplication::translate("main", "meta file name")
};
parser.addOption(metaResourceOption);
QCommandLineOption namespaceOption {
u"namespace"_s, QCoreApplication::translate("main", "Namespace of the generated C++ code"),
QCoreApplication::translate("main", "namespace")
};
parser.addOption(namespaceOption);
QCommandLineOption moduleOption{
u"module"_s,
QCoreApplication::translate("main",
"Name of the QML module that this QML code belongs to."),
QCoreApplication::translate("main", "module")
};
parser.addOption(moduleOption);
QCommandLineOption exportOption{ u"export"_s,
QCoreApplication::translate(
"main", "Export macro used in the generated C++ code"),
QCoreApplication::translate("main", "export") };
parser.addOption(exportOption);
QCommandLineOption exportIncludeOption{
u"exportInclude"_s,
QCoreApplication::translate(
"main", "Header defining the export macro to be used in the generated C++ code"),
QCoreApplication::translate("main", "exportInclude")
};
parser.addOption(exportIncludeOption);
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;
}
static QRegularExpression nameChecker(u"^[a-zA-Z_][a-zA-Z0-9_]*\\.qml$"_s);
if (auto match = nameChecker.match(QUrl(url).fileName()); !match.hasMatch()) {
fprintf(stderr,
"The given QML filename is unsuited for type compilation: the name must consist of "
"letters, digits and underscores, starting with "
"a letter or an underscore and ending in '.qml'!\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;
if (parser.isSet(resourceOption)) {
importPaths.append(QLatin1String(":/qt-project.org/imports"));
importPaths.append(QLatin1String(":/qt/qml"));
};
if (parser.isSet(importPathOption))
importPaths.append(parser.values(importPathOption));
if (!parser.isSet(bareOption))
importPaths.append(QLibraryInfo::path(QLibraryInfo::QmlImportsPath));
QStringList qmldirFiles = QQmlJSUtils::cleanPaths(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);
const QStringList metaResourceFiles = parser.values(metaResourceOption);
QQmlJSResourceFileMapper metaDataMapper(metaResourceFiles);
const auto firstQml = [](const QStringList &paths) {
auto it = std::find_if(paths.cbegin(), paths.cend(),
[](const QString &x) { return x.endsWith(u".qml"_s); });
if (it == paths.cend())
return QString();
return *it;
};
// 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) {
bool good = !firstQml(paths).isEmpty();
good &= std::any_of(paths.cbegin(), paths.cend(),
[](const QString &x) { return x.endsWith(u".h"_s); });
if (!good || paths.size() > 2) {
fprintf(stderr, "Unexpected 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 = firstQml(paths);
info.outputNamespace = parser.value(namespaceOption);
info.exportMacro = parser.value(exportOption);
info.exportInclude = parser.value(exportIncludeOption);
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 };
importer.setMetaDataMapper(&metaDataMapper);
auto qmltcVisitor = [](QQmlJS::AST::Node *rootNode, QQmlJSImporter *self,
const QQmlJSImporter::ImportVisitorPrerequisites &p) {
QmltcVisitor v(p.m_target, self, p.m_logger, p.m_implicitImportDirectory, p.m_qmldirFiles);
QQmlJS::AST::Node::accept(rootNode, &v);
};
importer.setImportVisitor(qmltcVisitor);
QQmlJSLogger logger;
logger.setFilePath(url);
logger.setCode(sourceCode);
setupLogger(logger);
auto currentScope = QQmlJSScope::create();
if (parser.isSet(moduleOption))
currentScope->setOwnModuleName(parser.value(moduleOption));
QmltcVisitor visitor(currentScope, &importer, &logger,
QQmlJSImportVisitor::implicitImportDirectory(url, &mapper), qmldirFiles);
visitor.setMode(QmltcVisitor::Compile);
QmltcTypeResolver typeResolver { &importer };
typeResolver.init(&visitor, qmlParser.rootNode());
using PassManagerPtr =
std::unique_ptr<QQmlSA::PassManager,
decltype(&QQmlSA::PassManagerPrivate::deletePassManager)>;
PassManagerPtr passMan(QQmlSA::PassManagerPrivate::createPassManager(&visitor, &typeResolver),
&QQmlSA::PassManagerPrivate::deletePassManager);
passMan->registerPropertyPass(std::make_unique<QQmlJSLiteralBindingCheck>(passMan.get()),
QString(), QString(), QString());
passMan->analyze(QQmlJSScope::createQQmlSAElement(visitor.result()));
if (logger.hasErrors()) {
if (visitor.hasSeenCustomParsers()) {
logger.log(QStringLiteral("qmltc does not support custom parsers such as ListModel or "
"old forms of Connections and PropertyChanges."),
qmlCompiler, QQmlJS::SourceLocation());
}
return EXIT_FAILURE;
}
QList<QQmlJS::DiagnosticMessage> warnings = importer.takeGlobalWarnings();
if (!warnings.isEmpty()) {
logger.log(QStringLiteral("Type warnings occurred while compiling file:"), qmlImport,
QQmlJS::SourceLocation());
logger.processMessages(warnings, qmlImport);
// 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;
}
|