qtdeclarative/tools/qmltc/main.cpp

/****************************************************************************
**
** 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 "qmltccompiler.h"
#include "qmltcvisitor.h"

#include <QtQml/private/qqmlirbuilder_p.h>
#include <private/qqmljscompiler_p.h>

#include <QtCore/qcoreapplication.h>
#include <QtCore/qurl.h>
#include <QtCore/qhashfunctions.h>
#include <QtCore/qfileinfo.h>
#include <QtCore/qlibraryinfo.h>
#if QT_CONFIG(commandlineparser)
#    include <QtCore/qcommandlineparser.h>
#endif

#include <cstdio>

void setupLogger(QQmlJSLogger &logger) // prepare logger to work with compiler
{
    logger.setCategoryError(Log_Compiler, 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(u"qmltc"_qs);
    QCoreApplication::setApplicationVersion(QStringLiteral(QT_VERSION_STR));

#if QT_CONFIG(commandlineparser)
    // command-line parsing:
    QCommandLineParser parser;
    parser.addHelpOption();
    parser.addVersionOption();

    QCommandLineOption importPathOption {
        u"I"_qs, QCoreApplication::translate("main", "Look for QML modules in specified directory"),
        QCoreApplication::translate("main", "import directory")
    };
    parser.addOption(importPathOption);
    QCommandLineOption qmltypesOption {
        u"i"_qs, QCoreApplication::translate("main", "Include extra qmltypes"),
        QCoreApplication::translate("main", "qmltypes file")
    };
    parser.addOption(qmltypesOption);
    QCommandLineOption outputCppOption {
        u"impl"_qs, QCoreApplication::translate("main", "Generated C++ source file path"),
        QCoreApplication::translate("main", "cpp path")
    };
    parser.addOption(outputCppOption);
    QCommandLineOption outputHOption {
        u"header"_qs, QCoreApplication::translate("main", "Generated C++ header file path"),
        QCoreApplication::translate("main", "h path")
    };
    parser.addOption(outputHOption);
    QCommandLineOption resourcePathOption {
        u"resource-path"_qs,
        QCoreApplication::translate(
                "main", "Qt resource file path corresponding to the file being compiled"),
        QCoreApplication::translate("main", "resource path")
    };
    parser.addOption(resourcePathOption);

    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: '"_qs + sources.join(u"' '"_qs)
                               + 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));
    importPaths.append(QFileInfo(url).absolutePath());
    QStringList qmltypesFiles = parser.values(qmltypesOption);

    QString outputCppFile;
    if (!parser.isSet(outputCppOption)) {
        outputCppFile = url.first(url.size() - 3) + u"cpp"_qs;
    } else {
        outputCppFile = parser.value(outputCppOption);
    }

    QString outputHFile;
    if (!parser.isSet(outputHOption)) {
        outputHFile = url.first(url.size() - 3) + u"h"_qs;
    } else {
        outputHFile = parser.value(outputHOption);
    }

    if (!parser.isSet(resourcePathOption)) {
        fprintf(stderr, "No resource path for file: %s\n", qPrintable(inputFile));
        return EXIT_FAILURE;
    }

    // main logic:
    QmlIR::Document document(false); // used by QmltcTypeResolver/QQmlJSTypeResolver
    // NB: JS unit generated here is ignored, so use noop function
    QQmlJSSaveFunction noop([](auto &&...) { return true; });
    QQmlJSCompileError error;
    if (!qCompileQmlFile(document, url, noop, nullptr, &error)) {
        error.augment(u"Error compiling qml file: "_qs).print();
        return EXIT_FAILURE;
    }

    QmltcCompilerInfo info;
    info.outputCppFile = outputCppFile;
    info.outputHFile = outputHFile;
    info.resourcePath = parser.value(resourcePathOption);

    QQmlJSImporter importer { importPaths, /* resource file mapper */ nullptr };
    QQmlJSLogger logger(url, sourceCode, /* silent */ false);
    setupLogger(logger);
    QmltcVisitor visitor(&importer, &logger, implicitImportDirectory, qmltypesFiles);
    // Type resolving is only static here due the inability to resolve parent
    // properties dynamically (QTBUG-95530). Indirect type storage is used as
    // this is a current option in qmllint (it doesn't mean that it is correct
    // for the compiler).
    QmltcTypeResolver typeResolver { &importer, &document, QQmlJSTypeResolver::Indirect,
                                     QQmlJSTypeResolver::Static, &logger };
    typeResolver.init(visitor);
    if (logger.hasWarnings() || logger.hasErrors())
        return EXIT_FAILURE;

    QmltcCompiler compiler(url, &typeResolver, &visitor, &logger);
    compiler.compile(info);
    if (logger.hasWarnings() || logger.hasErrors())
        return EXIT_FAILURE;

    return EXIT_SUCCESS;
#else
    // we need the parser at least for --resource-path option (and maybe for
    // something else in the future), so just fail here if QCommandLine parser
    // is unavailable
    fprintf(stderr,
            "qmltc requires commandlineparser feature enabled. Rebuild Qt with that feature "
            "present if you want to use this tool\n");
    return EXIT_FAILURE;
#endif
}