/**************************************************************************** ** ** Copyright (C) 2016 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the QtQml module 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 #include #include #include #include #include #include #include #include #include #include QT_BEGIN_NAMESPACE namespace QV4 { namespace JIT { Q_QML_EXPORT QV4::EvalISelFactory *createISelForArchitecture(const QString &architecture); } } QT_END_NAMESPACE QSet illegalNames; void setupIllegalNames() { // #### this in incomplete illegalNames.insert(QStringLiteral("Math")); illegalNames.insert(QStringLiteral("Array")); illegalNames.insert(QStringLiteral("String")); illegalNames.insert(QStringLiteral("Function")); illegalNames.insert(QStringLiteral("Boolean")); illegalNames.insert(QStringLiteral("Number")); illegalNames.insert(QStringLiteral("Date")); illegalNames.insert(QStringLiteral("RegExp")); illegalNames.insert(QStringLiteral("Error")); illegalNames.insert(QStringLiteral("Object")); } struct Error { QString message; void print(); Error augment(const QString &contextErrorMessage) const; }; void Error::print() { fprintf(stderr, "%s\n", qPrintable(message)); } Error Error::augment(const QString &contextErrorMessage) const { Error augmented; augmented.message = contextErrorMessage + message; return augmented; } QString diagnosticErrorMessage(const QString &fileName, const QQmlJS::DiagnosticMessage &m) { QString message; message = fileName + QLatin1Char(':') + QString::number(m.loc.startLine) + QLatin1Char(':'); if (m.loc.startColumn > 0) message += QString::number(m.loc.startColumn) + QLatin1Char(':'); if (m.isError()) message += QLatin1String(" error: "); else message += QLatin1String(" warning: "); message += m.message; return message; } // Ensure that ListElement objects keep all property assignments in their string form static void annotateListElements(QmlIR::Document *document) { QStringList listElementNames; foreach (const QV4::CompiledData::Import *import, document->imports) { const QString uri = document->stringAt(import->uriIndex); if (uri != QStringLiteral("QtQml.Models") && uri != QStringLiteral("QtQuick")) continue; QString listElementName = QStringLiteral("ListElement"); const QString qualifier = document->stringAt(import->qualifierIndex); if (!qualifier.isEmpty()) { listElementName.prepend(QLatin1Char('.')); listElementName.prepend(qualifier); } listElementNames.append(listElementName); } if (listElementNames.isEmpty()) return; foreach (QmlIR::Object *object, document->objects) { if (!listElementNames.contains(document->stringAt(object->inheritedTypeNameIndex))) continue; for (QmlIR::Binding *binding = object->firstBinding(); binding; binding = binding->next) { if (binding->type != QV4::CompiledData::Binding::Type_Script) continue; binding->stringIndex = document->registerString(object->bindingAsString(document, binding->value.compiledScriptIndex)); } } } static bool checkArgumentsObjectUseInSignalHandlers(const QmlIR::Document &doc, Error *error) { for (QmlIR::Object *object: qAsConst(doc.objects)) { for (auto binding = object->bindingsBegin(); binding != object->bindingsEnd(); ++binding) { if (binding->type != QV4::CompiledData::Binding::Type_Script) continue; const QString propName = doc.stringAt(binding->propertyNameIndex); if (!propName.startsWith(QLatin1String("on")) || propName.length() < 3 || !propName.at(2).isUpper()) continue; auto compiledFunction = doc.jsModule.functions.value(object->runtimeFunctionIndices.at(binding->value.compiledScriptIndex)); if (!compiledFunction) continue; if (compiledFunction->usesArgumentsObject) { error->message = QLatin1Char(':') + QString::number(compiledFunction->line) + QLatin1Char(':'); if (compiledFunction->column > 0) error->message += QString::number(compiledFunction->column) + QLatin1Char(':'); error->message += QLatin1String(" error: The use of the arguments object in signal handlers is\n" "not supported when compiling qml files ahead of time, because it may be ambiguous if\n" "any signal parameter is called \"arguments\". Unfortunately we cannot distinguish\n" "between it being a parameter or the JavaScript arguments object at this point.\n" "Consider renaming the parameter of the signal if applicable."); return false; } } } return true; } static bool compileQmlFile(const QString &inputFileName, const QString &outputFileName, QV4::EvalISelFactory *iselFactory, const QString &targetABI, Error *error) { QmlIR::Document irDocument(/*debugMode*/false); irDocument.jsModule.targetABI = targetABI; QString sourceCode; { QFile f(inputFileName); if (!f.open(QIODevice::ReadOnly)) { error->message = QLatin1String("Error opening ") + inputFileName + QLatin1Char(':') + f.errorString(); return false; } sourceCode = QString::fromUtf8(f.readAll()); if (f.error() != QFileDevice::NoError) { error->message = QLatin1String("Error reading from ") + inputFileName + QLatin1Char(':') + f.errorString(); return false; } } { QmlIR::IRBuilder irBuilder(illegalNames); if (!irBuilder.generateFromQml(sourceCode, inputFileName, &irDocument)) { for (const QQmlJS::DiagnosticMessage &parseError: qAsConst(irBuilder.errors)) { if (!error->message.isEmpty()) error->message += QLatin1Char('\n'); error->message += diagnosticErrorMessage(inputFileName, parseError); } return false; } } annotateListElements(&irDocument); { QmlIR::JSCodeGen v4CodeGen(/*empty input file name*/QString(), QString(), irDocument.code, &irDocument.jsModule, &irDocument.jsParserEngine, irDocument.program, /*import cache*/0, &irDocument.jsGenerator.stringTable, illegalNames); for (QmlIR::Object *object: qAsConst(irDocument.objects)) { if (object->functionsAndExpressions->count == 0) continue; QList functionsToCompile; for (QmlIR::CompiledFunctionOrExpression *foe = object->functionsAndExpressions->first; foe; foe = foe->next) { foe->disableAcceleratedLookups = true; functionsToCompile << *foe; } const QVector runtimeFunctionIndices = v4CodeGen.generateJSCodeForFunctionsAndBindings(functionsToCompile); QList jsErrors = v4CodeGen.errors(); if (!jsErrors.isEmpty()) { for (const QQmlJS::DiagnosticMessage &e: qAsConst(jsErrors)) { if (!error->message.isEmpty()) error->message += QLatin1Char('\n'); error->message += diagnosticErrorMessage(inputFileName, e); } return false; } QQmlJS::MemoryPool *pool = irDocument.jsParserEngine.pool(); object->runtimeFunctionIndices.allocate(pool, runtimeFunctionIndices); } if (!checkArgumentsObjectUseInSignalHandlers(irDocument, error)) { *error = error->augment(inputFileName); return false; } QmlIR::QmlUnitGenerator generator; { QQmlJavaScriptBindingExpressionSimplificationPass pass(irDocument.objects, &irDocument.jsModule, &irDocument.jsGenerator); pass.reduceTranslationBindings(); } QV4::ExecutableAllocator allocator; QScopedPointer isel(iselFactory->create(/*engine*/nullptr, &allocator, &irDocument.jsModule, &irDocument.jsGenerator)); // Disable lookups in non-standalone (aka QML) mode isel->setUseFastLookups(false); irDocument.javaScriptCompilationUnit = isel->compile(/*generate unit*/false); QV4::CompiledData::Unit *unit = generator.generate(irDocument); unit->flags |= QV4::CompiledData::Unit::StaticData; unit->flags |= QV4::CompiledData::Unit::PendingTypeCompilation; irDocument.javaScriptCompilationUnit->data = unit; if (!irDocument.javaScriptCompilationUnit->saveToDisk(outputFileName, &error->message)) return false; free(unit); } return true; } static bool compileJSFile(const QString &inputFileName, const QString &outputFileName, QV4::EvalISelFactory *iselFactory, const QString &targetABI, Error *error) { QmlIR::Document irDocument(/*debugMode*/false); irDocument.jsModule.targetABI = targetABI; QString sourceCode; { QFile f(inputFileName); if (!f.open(QIODevice::ReadOnly)) { error->message = QLatin1String("Error opening ") + inputFileName + QLatin1Char(':') + f.errorString(); return false; } sourceCode = QString::fromUtf8(f.readAll()); if (f.error() != QFileDevice::NoError) { error->message = QLatin1String("Error reading from ") + inputFileName + QLatin1Char(':') + f.errorString(); return false; } } QQmlJS::Engine *engine = &irDocument.jsParserEngine; QmlIR::ScriptDirectivesCollector directivesCollector(engine, &irDocument.jsGenerator); QQmlJS::Directives *oldDirs = engine->directives(); engine->setDirectives(&directivesCollector); QQmlJS::AST::Program *program = nullptr; { QQmlJS::Lexer lexer(engine); lexer.setCode(sourceCode, /*line*/1, /*parseAsBinding*/false); QQmlJS::Parser parser(engine); bool parsed = parser.parseProgram(); for (const QQmlJS::DiagnosticMessage &parseError: parser.diagnosticMessages()) { if (!error->message.isEmpty()) error->message += QLatin1Char('\n'); error->message += diagnosticErrorMessage(inputFileName, parseError); } if (!parsed) { engine->setDirectives(oldDirs); return false; } program = QQmlJS::AST::cast(parser.rootNode()); if (!program) { lexer.setCode(QStringLiteral("undefined;"), 1, false); parsed = parser.parseProgram(); Q_ASSERT(parsed); program = QQmlJS::AST::cast(parser.rootNode()); Q_ASSERT(program); } } { QmlIR::JSCodeGen v4CodeGen(inputFileName, inputFileName, irDocument.code, &irDocument.jsModule, &irDocument.jsParserEngine, irDocument.program, /*import cache*/0, &irDocument.jsGenerator.stringTable, illegalNames); v4CodeGen.generateFromProgram(/*empty input file name*/QString(), QString(), sourceCode, program, &irDocument.jsModule, QQmlJS::Codegen::GlobalCode); QList jsErrors = v4CodeGen.errors(); if (!jsErrors.isEmpty()) { for (const QQmlJS::DiagnosticMessage &e: qAsConst(jsErrors)) { if (!error->message.isEmpty()) error->message += QLatin1Char('\n'); error->message += diagnosticErrorMessage(inputFileName, e); } engine->setDirectives(oldDirs); return false; } QmlIR::QmlUnitGenerator generator; QV4::ExecutableAllocator allocator; QScopedPointer isel(iselFactory->create(/*engine*/nullptr, &allocator, &irDocument.jsModule, &irDocument.jsGenerator)); // Disable lookups in non-standalone (aka QML) mode isel->setUseFastLookups(false); irDocument.javaScriptCompilationUnit = isel->compile(/*generate unit*/false); QV4::CompiledData::Unit *unit = generator.generate(irDocument); unit->flags |= QV4::CompiledData::Unit::StaticData; irDocument.javaScriptCompilationUnit->data = unit; if (!irDocument.javaScriptCompilationUnit->saveToDisk(outputFileName, &error->message)) { engine->setDirectives(oldDirs); return false; } free(unit); } engine->setDirectives(oldDirs); return true; } 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(QStringLiteral("qmlcachegen")); QCoreApplication::setApplicationVersion(QLatin1String(QT_VERSION_STR)); QCommandLineParser parser; parser.addHelpOption(); parser.addVersionOption(); QCommandLineOption targetArchitectureOption(QStringLiteral("target-architecture"), QCoreApplication::translate("main", "Target architecture"), QCoreApplication::translate("main", "architecture")); parser.addOption(targetArchitectureOption); QCommandLineOption targetABIOption(QStringLiteral("target-abi"), QCoreApplication::translate("main", "Target architecture binary interface"), QCoreApplication::translate("main", "abi")); parser.addOption(targetABIOption); QCommandLineOption outputFileOption(QStringLiteral("o"), QCoreApplication::translate("main", "Output file name"), QCoreApplication::translate("main", "file name")); parser.addOption(outputFileOption); QCommandLineOption checkIfSupportedOption(QStringLiteral("check-if-supported"), QCoreApplication::translate("main", "Check if cache generate is supported on the specified target architecture")); parser.addOption(checkIfSupportedOption); parser.addPositionalArgument(QStringLiteral("[qml file]"), QStringLiteral("QML source file to generate cache for.")); parser.process(app); if (!parser.isSet(targetArchitectureOption)) { fprintf(stderr, "Target architecture not specified. Please specify with --target-architecture=\n"); parser.showHelp(); return EXIT_FAILURE; } QScopedPointer isel; const QString targetArchitecture = parser.value(targetArchitectureOption); isel.reset(QV4::JIT::createISelForArchitecture(targetArchitecture)); if (parser.isSet(checkIfSupportedOption)) { if (isel.isNull()) return EXIT_FAILURE; else return EXIT_SUCCESS; } const QStringList sources = parser.positionalArguments(); if (sources.isEmpty()){ parser.showHelp(); } else if (sources.count() > 1) { fprintf(stderr, "%s\n", qPrintable(QStringLiteral("Too many input files specified: '") + sources.join(QStringLiteral("' '")) + QLatin1Char('\''))); return EXIT_FAILURE; } const QString inputFile = sources.first(); if (!isel) isel.reset(new QV4::Moth::ISelFactory); Error error; QString outputFileName = inputFile + QLatin1Char('c'); if (parser.isSet(outputFileOption)) outputFileName = parser.value(outputFileOption); setupIllegalNames(); const QString targetABI = parser.value(targetABIOption); if (inputFile.endsWith(QLatin1String(".qml"))) { if (!compileQmlFile(inputFile, outputFileName, isel.data(), targetABI, &error)) { error.augment(QLatin1String("Error compiling qml file: ")).print(); return EXIT_FAILURE; } } else if (inputFile.endsWith(QLatin1String(".js"))) { if (!compileJSFile(inputFile, outputFileName, isel.data(), targetABI, &error)) { error.augment(QLatin1String("Error compiling qml file: ")).print(); return EXIT_FAILURE; } } else { fprintf(stderr, "Ignoring %s input file as it is not QML source code - maybe remove from QML_FILES?\n", qPrintable(inputFile)); } return EXIT_SUCCESS; }