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
|
// Copyright (C) 2019 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#include <QCoreApplication>
#include <QFile>
#include <QTextStream>
#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 <QtQmlDom/private/qqmldomitem_p.h>
#include <QtQmlDom/private/qqmldomexternalitems_p.h>
#include <QtQmlDom/private/qqmldomtop_p.h>
#include <QtQmlDom/private/qqmldomoutwriter_p.h>
#include <QtQmlDom/private/qqmldomlinewriterfactory_p.h>
#if QT_CONFIG(commandlineparser)
# include <QCommandLineParser>
#endif
#include <QtQmlToolingSettings/private/qqmltoolingsettings_p.h>
#include <QtQmlFormat/private/qqmlformatsettings_p.h>
#include <QtQmlFormat/private/qqmlformatoptions_p.h>
using namespace QQmlJS::Dom;
static void logParsingErrors(const DomItem &fileItem, const QString &filename)
{
fileItem.iterateErrors(
[](const DomItem &, const ErrorMessage &msg) {
errorToQDebug(msg);
return true;
},
true);
qWarning().noquote() << "Failed to parse" << filename;
}
// TODO
// refactor this workaround. ExternalOWningItem is not recognized as an owning type
// in ownerAs.
static std::shared_ptr<ExternalOwningItem> getFileItemOwner(const DomItem &fileItem)
{
std::shared_ptr<ExternalOwningItem> filePtr = nullptr;
switch (fileItem.internalKind()) {
case DomType::JsFile:
filePtr = fileItem.ownerAs<JsFile>();
break;
default:
filePtr = fileItem.ownerAs<QmlFile>();
break;
}
return filePtr;
}
// TODO refactor
// Introduce better encapsulation and separation of concerns and move to DOM API
// returns a DomItem corresponding to the loaded file and bool indicating the validity of the file
static std::pair<DomItem, bool> parse(const QString &filename)
{
auto envPtr =
DomEnvironment::create(QStringList(),
QQmlJS::Dom::DomEnvironment::Option::SingleThreaded
| QQmlJS::Dom::DomEnvironment::Option::NoDependencies);
// placeholder for a node
// containing metadata (ExternalItemInfo) about the loaded file
DomItem fMetadataItem;
envPtr->loadFile(FileToLoad::fromFileSystem(envPtr, filename),
// callback called when everything is loaded that receives the
// loaded external file pair (path, oldValue, newValue)
[&fMetadataItem](Path, const DomItem &, const DomItem &extItemInfo) {
fMetadataItem = extItemInfo;
});
auto fItem = fMetadataItem.fileObject();
auto filePtr = getFileItemOwner(fItem);
return { fItem, filePtr && filePtr->isValid() };
}
static bool parseFile(const QString &filename, const QQmlFormatOptions &options)
{
const auto [fileItem, validFile] = parse(filename);
if (!validFile) {
logParsingErrors(fileItem, filename);
return false;
}
// Turn AST back into source code
if (options.isVerbose())
qWarning().noquote() << "Dumping" << filename;
const auto &code = getFileItemOwner(fileItem)->code();
auto lwOptions = options.optionsForCode(code);
WriteOutChecks checks = WriteOutCheck::Default;
//Disable writeOutChecks for some usecases
if (options.forceEnabled() || options.isMaxColumnWidthSet() || code.size() > 32000
|| fileItem.internalKind() == DomType::JsFile) {
checks = WriteOutCheck::None;
}
bool res = false;
if (options.isInplace()) {
if (options.isVerbose())
qWarning().noquote() << "Writing to file" << filename;
FileWriter fw;
const unsigned numberOfBackupFiles = 0;
res = fileItem.writeOut(filename, numberOfBackupFiles, lwOptions, &fw, checks);
} else {
QFile out;
if (out.open(stdout, QIODevice::WriteOnly)) {
auto lw = createLineWriter([&out](QStringView s) { out.write(s.toUtf8()); }, filename,
lwOptions);
OutWriter ow(*lw);
res = fileItem.writeOutForFile(ow, checks);
ow.flush();
} else {
res = false;
}
}
return res;
}
int main(int argc, char *argv[])
{
QCoreApplication app(argc, argv);
QCoreApplication::setApplicationName("qmlformat");
QCoreApplication::setApplicationVersion(QT_VERSION_STR);
QQmlFormatSettings settings(QLatin1String("qmlformat"));
const auto &options = QQmlFormatOptions::buildCommandLineOptions(app.arguments());
if (!options.isValid()) {
for (const auto &error : options.errors()) {
qWarning().noquote() << error;
}
return -1;
}
if (options.writeDefaultSettingsEnabled())
return settings.writeDefaults() ? 0 : -1;
bool success = true;
if (!options.files().isEmpty()) {
if (!options.arguments().isEmpty())
qWarning() << "Warning: Positional arguments are ignored when -F is used";
for (const QString &file : options.files()) {
Q_ASSERT(!file.isEmpty());
if (!parseFile(file, options.optionsForFile(file, &settings)))
success = false;
}
} else {
for (const QString &file : options.arguments()) {
if (!parseFile(file, options.optionsForFile(file, &settings)))
success = false;
}
}
return success ? 0 : 1;
}
|