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
|
// 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>
#if QT_CONFIG(commandlineparser)
# include <QCommandLineParser>
#endif
#include "../shared/qqmltoolingsettings.h"
using namespace QQmlJS::Dom;
struct Options
{
bool verbose = false;
bool inplace = false;
bool force = false;
bool tabs = false;
bool valid = false;
bool normalize = false;
bool ignoreSettings = false;
bool writeDefaultSettings = false;
int indentWidth = 4;
bool indentWidthSet = false;
QString newline = "native";
QStringList files;
QStringList arguments;
QStringList errors;
};
bool parseFile(const QString &filename, const Options &options)
{
DomItem env =
DomEnvironment::create(QStringList(),
QQmlJS::Dom::DomEnvironment::Option::SingleThreaded
| QQmlJS::Dom::DomEnvironment::Option::NoDependencies);
DomItem tFile; // place where to store the loaded file
env.loadFile(
filename, QString(),
[&tFile](Path, const DomItem &, const DomItem &newIt) {
tFile = newIt; // callback called when everything is loaded that receives the loaded
// external file pair (path, oldValue, newValue)
},
LoadOption::DefaultLoad);
env.loadPendingDependencies();
DomItem qmlFile = tFile.fileObject();
std::shared_ptr<QmlFile> qmlFilePtr = qmlFile.ownerAs<QmlFile>();
if (!qmlFilePtr || !qmlFilePtr->isValid()) {
qmlFile.iterateErrors(
[](DomItem, ErrorMessage msg) {
errorToQDebug(msg);
return true;
},
true);
qWarning().noquote() << "Failed to parse" << filename;
return false;
}
// Turn AST back into source code
if (options.verbose)
qWarning().noquote() << "Dumping" << filename;
LineWriterOptions lwOptions;
lwOptions.formatOptions.indentSize = options.indentWidth;
lwOptions.formatOptions.useTabs = options.tabs;
lwOptions.updateOptions = LineWriterOptions::Update::None;
if (options.newline == "native") {
// find out current line endings...
QStringView code = qmlFilePtr->code();
int newlineIndex = code.indexOf(QChar(u'\n'));
int crIndex = code.indexOf(QChar(u'\r'));
if (newlineIndex >= 0) {
if (crIndex >= 0) {
if (crIndex + 1 == newlineIndex)
lwOptions.lineEndings = LineWriterOptions::LineEndings::Windows;
else
qWarning().noquote() << "Invalid line ending in file, using default";
} else {
lwOptions.lineEndings = LineWriterOptions::LineEndings::Unix;
}
} else if (crIndex >= 0) {
lwOptions.lineEndings = LineWriterOptions::LineEndings::OldMacOs;
} else {
qWarning().noquote() << "Unknown line ending in file, using default";
}
} else if (options.newline == "macos") {
lwOptions.lineEndings = LineWriterOptions::LineEndings::OldMacOs;
} else if (options.newline == "windows") {
lwOptions.lineEndings = LineWriterOptions::LineEndings::Windows;
} else if (options.newline == "unix") {
lwOptions.lineEndings = LineWriterOptions::LineEndings::Unix;
} else {
qWarning().noquote() << "Unknown line ending type" << options.newline;
return false;
}
if (options.normalize)
lwOptions.attributesSequence = LineWriterOptions::AttributesSequence::Normalize;
else
lwOptions.attributesSequence = LineWriterOptions::AttributesSequence::Preserve;
WriteOutChecks checks = WriteOutCheck::Default;
if (options.force || qmlFilePtr->code().size() > 32000)
checks = WriteOutCheck::None;
MutableDomItem res;
if (options.inplace) {
if (options.verbose)
qWarning().noquote() << "Writing to file" << filename;
FileWriter fw;
res = qmlFile.writeOut(filename, 2, lwOptions, &fw, checks);
} else {
QFile out;
out.open(stdout, QIODevice::WriteOnly);
LineWriter lw([&out](QStringView s) { out.write(s.toUtf8()); }, filename, lwOptions);
OutWriter ow(lw);
res = qmlFile.writeOutForFile(ow, checks);
ow.flush();
}
return bool(res);
}
Options buildCommandLineOptions(const QCoreApplication &app)
{
#if QT_CONFIG(commandlineparser)
QCommandLineParser parser;
parser.setApplicationDescription("Formats QML files according to the QML Coding Conventions.");
parser.addHelpOption();
parser.addVersionOption();
parser.addOption(
QCommandLineOption({ "V", "verbose" },
QStringLiteral("Verbose mode. Outputs more detailed information.")));
QCommandLineOption writeDefaultsOption(
QStringList() << "write-defaults",
QLatin1String("Writes defaults settings to .qmlformat.ini and exits (Warning: This "
"will overwrite any existing settings and comments!)"));
parser.addOption(writeDefaultsOption);
QCommandLineOption ignoreSettings(QStringList() << "ignore-settings",
QLatin1String("Ignores all settings files and only takes "
"command line options into consideration"));
parser.addOption(ignoreSettings);
parser.addOption(QCommandLineOption(
{ "i", "inplace" },
QStringLiteral("Edit file in-place instead of outputting to stdout.")));
parser.addOption(QCommandLineOption({ "f", "force" },
QStringLiteral("Continue even if an error has occurred.")));
parser.addOption(
QCommandLineOption({ "t", "tabs" }, QStringLiteral("Use tabs instead of spaces.")));
parser.addOption(QCommandLineOption({ "w", "indent-width" },
QStringLiteral("How many spaces are used when indenting."),
"width", "4"));
parser.addOption(QCommandLineOption({ "n", "normalize" },
QStringLiteral("Reorders the attributes of the objects "
"according to the QML Coding Guidelines.")));
parser.addOption(QCommandLineOption(
{ "F", "files" }, QStringLiteral("Format all files listed in file, in-place"), "file"));
parser.addOption(QCommandLineOption(
{ "l", "newline" },
QStringLiteral("Override the new line format to use (native macos unix windows)."),
"newline", "native"));
parser.addPositionalArgument("filenames", "files to be processed by qmlformat");
parser.process(app);
if (parser.isSet(writeDefaultsOption)) {
Options options;
options.writeDefaultSettings = true;
options.valid = true;
return options;
}
bool indentWidthOkay = false;
const int indentWidth = parser.value("indent-width").toInt(&indentWidthOkay);
if (!indentWidthOkay) {
Options options;
options.errors.push_back("Error: Invalid value passed to -w");
return options;
}
QStringList files;
if (!parser.value("files").isEmpty()) {
QFile file(parser.value("files"));
file.open(QIODevice::Text | QIODevice::ReadOnly);
if (file.isOpen()) {
QTextStream in(&file);
while (!in.atEnd()) {
QString file = in.readLine();
if (file.isEmpty())
continue;
files.push_back(file);
}
}
}
Options options;
options.verbose = parser.isSet("verbose");
options.inplace = parser.isSet("inplace");
options.force = parser.isSet("force");
options.tabs = parser.isSet("tabs");
options.normalize = parser.isSet("normalize");
options.ignoreSettings = parser.isSet("ignore-settings");
options.valid = true;
options.indentWidth = indentWidth;
options.indentWidthSet = parser.isSet("indent-width");
options.newline = parser.value("newline");
options.files = files;
options.arguments = parser.positionalArguments();
return options;
#else
return Options {};
#endif
}
int main(int argc, char *argv[])
{
QCoreApplication app(argc, argv);
QCoreApplication::setApplicationName("qmlformat");
QCoreApplication::setApplicationVersion(QT_VERSION_STR);
QQmlToolingSettings settings(QLatin1String("qmlformat"));
const QString &useTabsSetting = QStringLiteral("UseTabs");
settings.addOption(useTabsSetting);
const QString &indentWidthSetting = QStringLiteral("IndentWidth");
settings.addOption(indentWidthSetting, 4);
const QString &normalizeSetting = QStringLiteral("NormalizeOrder");
settings.addOption(normalizeSetting);
const QString &newlineSetting = QStringLiteral("NewlineType");
settings.addOption(newlineSetting, QStringLiteral("native"));
const auto options = buildCommandLineOptions(app);
if (!options.valid) {
for (const auto &error : options.errors) {
qWarning().noquote() << error;
}
return -1;
}
if (options.writeDefaultSettings)
return settings.writeDefaults() ? 0 : -1;
auto getSettings = [&](const QString &file, Options options) {
if (options.ignoreSettings || !settings.search(file))
return options;
Options perFileOptions = options;
// Allow for tab settings to be overwritten by the command line
if (!options.indentWidthSet) {
if (settings.isSet(indentWidthSetting))
perFileOptions.indentWidth = settings.value(indentWidthSetting).toInt();
if (settings.isSet(useTabsSetting))
perFileOptions.tabs = settings.value(useTabsSetting).toBool();
}
if (settings.isSet(normalizeSetting))
perFileOptions.normalize = settings.value(normalizeSetting).toBool();
if (settings.isSet(newlineSetting))
perFileOptions.newline = settings.value(newlineSetting).toString();
return perFileOptions;
};
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, getSettings(file, options)))
success = false;
}
} else {
for (const QString &file : options.arguments) {
if (!parseFile(file, getSettings(file, options)))
success = false;
}
}
return success ? 0 : 1;
}
|