forked from qt-creator/qt-creator
af88a7876b
this is needed (among other things) for * null coalescing * shebang support Change-Id: I1b37fd86593f143de8b39c0daf433831a8785568 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
416 lines
16 KiB
C++
416 lines
16 KiB
C++
/****************************************************************************
|
|
**
|
|
** Copyright (C) 2021 The Qt Company Ltd.
|
|
** Contact: https://www.qt.io/licensing/
|
|
**
|
|
** This file is part of Qt Creator.
|
|
**
|
|
** 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.
|
|
**
|
|
****************************************************************************/
|
|
|
|
#include "qmldirparser_p.h"
|
|
|
|
#include <utils/qtcassert.h>
|
|
|
|
#include <QtCore/QtDebug>
|
|
|
|
QT_QML_BEGIN_NAMESPACE
|
|
|
|
using namespace LanguageUtils;
|
|
|
|
static int parseInt(QStringView str, bool *ok)
|
|
{
|
|
int pos = 0;
|
|
int number = 0;
|
|
while (pos < str.length() && str.at(pos).isDigit()) {
|
|
if (pos != 0)
|
|
number *= 10;
|
|
number += str.at(pos).unicode() - '0';
|
|
++pos;
|
|
}
|
|
if (pos != str.length())
|
|
*ok = false;
|
|
else
|
|
*ok = true;
|
|
return number;
|
|
}
|
|
|
|
static bool parseVersion(const QString &str, int *major, int *minor)
|
|
{
|
|
const int dotIndex = str.indexOf(QLatin1Char('.'));
|
|
if (dotIndex != -1 && str.indexOf(QLatin1Char('.'), dotIndex + 1) == -1) {
|
|
bool ok = false;
|
|
*major = parseInt(QStringView(str.constData(), dotIndex), &ok);
|
|
if (ok)
|
|
*minor = parseInt(QStringView(str.constData() + dotIndex + 1, str.length() - dotIndex - 1),
|
|
&ok);
|
|
return ok;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
static ComponentVersion parseImportVersion(const QString &str)
|
|
{
|
|
int minor = -1;
|
|
int major = -1;
|
|
const int dotIndex = str.indexOf(QLatin1Char('.'));
|
|
bool ok = false;
|
|
if (dotIndex != -1 && str.indexOf(QLatin1Char('.'), dotIndex + 1) == -1) {
|
|
major = parseInt(QStringView(str.constData(), dotIndex), &ok);
|
|
if (ok) {
|
|
if (str.length() > dotIndex + 1) {
|
|
minor = parseInt(QStringView(str.constData() + dotIndex + 1, str.length() - dotIndex - 1),
|
|
&ok);
|
|
if (!ok)
|
|
minor = ComponentVersion::NoVersion;
|
|
} else {
|
|
minor = ComponentVersion::MaxVersion;
|
|
}
|
|
}
|
|
} else if (str.length() > 0) {
|
|
QTC_ASSERT(str != QLatin1String("auto"), return ComponentVersion(-1, -1));
|
|
major = parseInt(QStringView(str.constData(), str.length()),
|
|
&ok);
|
|
minor = ComponentVersion::MaxVersion;
|
|
}
|
|
return ComponentVersion(major, minor);
|
|
}
|
|
|
|
void QmlDirParser::clear()
|
|
{
|
|
_errors.clear();
|
|
_typeNamespace.clear();
|
|
_components.clear();
|
|
_dependencies.clear();
|
|
_imports.clear();
|
|
_scripts.clear();
|
|
_plugins.clear();
|
|
_designerSupported = false;
|
|
_typeInfos.clear();
|
|
_classNames.clear();
|
|
}
|
|
|
|
inline static void scanSpace(const QChar *&ch) {
|
|
while (ch->isSpace() && !ch->isNull() && *ch != QLatin1Char('\n'))
|
|
++ch;
|
|
}
|
|
|
|
inline static void scanToEnd(const QChar *&ch) {
|
|
while (*ch != QLatin1Char('\n') && !ch->isNull())
|
|
++ch;
|
|
}
|
|
|
|
inline static void scanWord(const QChar *&ch) {
|
|
while (!ch->isSpace() && !ch->isNull())
|
|
++ch;
|
|
}
|
|
|
|
/*!
|
|
\a url is used for generating errors.
|
|
*/
|
|
bool QmlDirParser::parse(const QString &source)
|
|
{
|
|
quint16 lineNumber = 0;
|
|
bool firstLine = true;
|
|
|
|
auto readImport = [&](const QString *sections, int sectionCount, Import::Flags flags) {
|
|
Import import;
|
|
if (sectionCount == 2) {
|
|
import = Import(sections[1], ComponentVersion(), flags);
|
|
} else if (sectionCount == 3) {
|
|
if (sections[2] == QLatin1String("auto")) {
|
|
import = Import(sections[1], ComponentVersion(), flags | Import::Auto);
|
|
} else {
|
|
const auto version = parseImportVersion(sections[2]);
|
|
if (version.isValid()) {
|
|
import = Import(sections[1], version, flags);
|
|
} else {
|
|
reportError(lineNumber, 0,
|
|
QStringLiteral("invalid version %1, expected <major>.<minor>")
|
|
.arg(sections[2]));
|
|
return false;
|
|
}
|
|
}
|
|
} else {
|
|
reportError(lineNumber, 0,
|
|
QStringLiteral("%1 requires 1 or 2 arguments, but %2 were provided")
|
|
.arg(sections[0]).arg(sectionCount - 1));
|
|
return false;
|
|
}
|
|
if (sections[0] == QStringLiteral("import"))
|
|
_imports.append(import);
|
|
else
|
|
_dependencies.append(import);
|
|
return true;
|
|
};
|
|
|
|
auto readPlugin = [&](const QString *sections, int sectionCount, bool isOptional) {
|
|
if (sectionCount < 2 || sectionCount > 3) {
|
|
reportError(lineNumber, 0, QStringLiteral("plugin directive requires one or two "
|
|
"arguments, but %1 were provided")
|
|
.arg(sectionCount - 1));
|
|
return false;
|
|
}
|
|
|
|
const Plugin entry(sections[1], sections[2], isOptional);
|
|
_plugins.append(entry);
|
|
return true;
|
|
};
|
|
|
|
const QChar *ch = source.constData();
|
|
while (!ch->isNull()) {
|
|
++lineNumber;
|
|
|
|
bool invalidLine = false;
|
|
const QChar *lineStart = ch;
|
|
|
|
scanSpace(ch);
|
|
if (*ch == QLatin1Char('\n')) {
|
|
++ch;
|
|
continue;
|
|
}
|
|
if (ch->isNull())
|
|
break;
|
|
|
|
QString sections[4];
|
|
int sectionCount = 0;
|
|
|
|
do {
|
|
if (*ch == QLatin1Char('#')) {
|
|
scanToEnd(ch);
|
|
break;
|
|
}
|
|
const QChar *start = ch;
|
|
scanWord(ch);
|
|
if (sectionCount < 4) {
|
|
sections[sectionCount++] = source.mid(start-source.constData(), ch-start);
|
|
} else {
|
|
reportError(lineNumber, start-lineStart, QLatin1String("unexpected token"));
|
|
scanToEnd(ch);
|
|
invalidLine = true;
|
|
break;
|
|
}
|
|
scanSpace(ch);
|
|
} while (*ch != QLatin1Char('\n') && !ch->isNull());
|
|
|
|
if (!ch->isNull())
|
|
++ch;
|
|
|
|
if (invalidLine) {
|
|
reportError(lineNumber, 0,
|
|
QStringLiteral("invalid qmldir directive contains too many tokens"));
|
|
continue;
|
|
} else if (sectionCount == 0) {
|
|
continue; // no sections, no party.
|
|
|
|
} else if (sections[0] == QLatin1String("module")) {
|
|
if (sectionCount != 2) {
|
|
reportError(lineNumber, 0,
|
|
QStringLiteral("module identifier directive requires one argument, but %1 were provided").arg(sectionCount - 1));
|
|
continue;
|
|
}
|
|
if (!_typeNamespace.isEmpty()) {
|
|
reportError(lineNumber, 0,
|
|
QStringLiteral("only one module identifier directive may be defined in a qmldir file"));
|
|
continue;
|
|
}
|
|
if (!firstLine) {
|
|
reportError(lineNumber, 0,
|
|
QStringLiteral("module identifier directive must be the first directive in a qmldir file"));
|
|
continue;
|
|
}
|
|
|
|
_typeNamespace = sections[1];
|
|
|
|
} else if (sections[0] == QLatin1String("plugin")) {
|
|
if (!readPlugin(sections, sectionCount, false))
|
|
continue;
|
|
} else if (sections[0] == QLatin1String("optional")) {
|
|
if (sectionCount < 2) {
|
|
reportError(lineNumber, 0, QStringLiteral("optional directive requires further "
|
|
"arguments, but none were provided."));
|
|
continue;
|
|
}
|
|
|
|
if (sections[1] == QStringLiteral("plugin")) {
|
|
if (!readPlugin(sections + 1, sectionCount - 1, true))
|
|
continue;
|
|
} else if (sections[1] == QLatin1String("import")) {
|
|
if (!readImport(sections + 1, sectionCount - 1, Import::Optional))
|
|
continue;
|
|
} else {
|
|
reportError(lineNumber, 0, QStringLiteral("only import and plugin can be optional, "
|
|
"not %1.").arg(sections[1]));
|
|
continue;
|
|
}
|
|
} else if (sections[0] == QLatin1String("classname")) {
|
|
if (sectionCount < 2) {
|
|
reportError(lineNumber, 0,
|
|
QStringLiteral("classname directive requires an argument, but %1 were provided").arg(sectionCount - 1));
|
|
|
|
continue;
|
|
}
|
|
|
|
_classNames.append(sections[1]);
|
|
|
|
} else if (sections[0] == QLatin1String("internal")) {
|
|
if (sectionCount != 3) {
|
|
reportError(lineNumber, 0,
|
|
QStringLiteral("internal types require 2 arguments, but %1 were provided").arg(sectionCount - 1));
|
|
continue;
|
|
}
|
|
Component entry(sections[1], sections[2], -1, -1);
|
|
entry.internal = true;
|
|
_components.insert(entry.typeName, entry);
|
|
} else if (sections[0] == QLatin1String("singleton")) {
|
|
if (sectionCount < 3 || sectionCount > 4) {
|
|
reportError(lineNumber, 0,
|
|
QStringLiteral("singleton types require 2 or 3 arguments, but %1 were provided").arg(sectionCount - 1));
|
|
continue;
|
|
} else if (sectionCount == 3) {
|
|
// handle qmldir directory listing case where singleton is defined in the following pattern:
|
|
// singleton TestSingletonType TestSingletonType.qml
|
|
Component entry(sections[1], sections[2], -1, -1);
|
|
entry.singleton = true;
|
|
_components.insert(entry.typeName, entry);
|
|
} else {
|
|
// handle qmldir module listing case where singleton is defined in the following pattern:
|
|
// singleton TestSingletonType 2.0 TestSingletonType20.qml
|
|
int major, minor;
|
|
if (parseVersion(sections[2], &major, &minor)) {
|
|
const QString &fileName = sections[3];
|
|
Component entry(sections[1], fileName, major, minor);
|
|
entry.singleton = true;
|
|
_components.insert(entry.typeName, entry);
|
|
} else {
|
|
reportError(lineNumber, 0, QStringLiteral("invalid version %1, expected <major>.<minor>").arg(sections[2]));
|
|
}
|
|
}
|
|
} else if (sections[0] == QLatin1String("typeinfo")) {
|
|
if (sectionCount != 2) {
|
|
reportError(lineNumber, 0,
|
|
QStringLiteral("typeinfo requires 1 argument, but %1 were provided").arg(sectionCount - 1));
|
|
continue;
|
|
}
|
|
_typeInfos.append(sections[1]);
|
|
} else if (sections[0] == QLatin1String("designersupported")) {
|
|
if (sectionCount != 1)
|
|
reportError(lineNumber, 0, QStringLiteral("designersupported does not expect any argument"));
|
|
else
|
|
_designerSupported = true;
|
|
} else if (sections[0] == QLatin1String("import")
|
|
|| sections[0] == QLatin1String("depends")) {
|
|
if (!readImport(sections, sectionCount, Import::Default))
|
|
continue;
|
|
} else if (sections[0] == QLatin1String("prefer")) {
|
|
if (sectionCount < 2) {
|
|
reportError(lineNumber, 0,
|
|
QStringLiteral("prefer directive requires one argument, "
|
|
"but %1 were provided").arg(sectionCount - 1));
|
|
continue;
|
|
}
|
|
|
|
if (!_preferredPath.isEmpty()) {
|
|
reportError(lineNumber, 0, QStringLiteral(
|
|
"only one prefer directive may be defined in a qmldir file"));
|
|
continue;
|
|
}
|
|
|
|
if (!sections[1].endsWith(u'/')) {
|
|
// Yes. People should realize it's a directory.
|
|
reportError(lineNumber, 0, QStringLiteral(
|
|
"the preferred directory has to end with a '/'"));
|
|
continue;
|
|
}
|
|
|
|
_preferredPath = sections[1];
|
|
} else if (sectionCount == 2) {
|
|
// No version specified (should only be used for relative qmldir files)
|
|
const Component entry(sections[0], sections[1], -1, -1);
|
|
_components.insert(entry.typeName, entry);
|
|
} else if (sectionCount == 3) {
|
|
int major, minor;
|
|
if (parseVersion(sections[1], &major, &minor)) {
|
|
const QString &fileName = sections[2];
|
|
|
|
if (fileName.endsWith(QLatin1String(".js")) || fileName.endsWith(QLatin1String(".mjs"))) {
|
|
// A 'js' extension indicates a namespaced script import
|
|
const Script entry(sections[0], fileName, major, minor);
|
|
_scripts.append(entry);
|
|
} else {
|
|
const Component entry(sections[0], fileName, major, minor);
|
|
_components.insert(entry.typeName, entry);
|
|
}
|
|
} else {
|
|
reportError(lineNumber, 0, QStringLiteral("invalid version %1, expected <major>.<minor>").arg(sections[1]));
|
|
}
|
|
} else {
|
|
reportError(lineNumber, 0,
|
|
QStringLiteral("a component declaration requires two or three arguments, but %1 were provided").arg(sectionCount));
|
|
}
|
|
|
|
firstLine = false;
|
|
}
|
|
|
|
return hasError();
|
|
}
|
|
|
|
void QmlDirParser::reportError(quint16 line, quint16 column, const QString &description)
|
|
{
|
|
QmlJS::DiagnosticMessage error;
|
|
error.loc.startLine = line;
|
|
error.loc.startColumn = column;
|
|
error.message = description;
|
|
_errors.append(error);
|
|
}
|
|
|
|
void QmlDirParser::setError(const QmlJS::DiagnosticMessage &e)
|
|
{
|
|
_errors.clear();
|
|
reportError(e.loc.startLine, e.loc.startColumn, e.message);
|
|
}
|
|
|
|
QList<QmlJS::DiagnosticMessage> QmlDirParser::errors(const QString &uri) const
|
|
{
|
|
QList<QmlJS::DiagnosticMessage> errors;
|
|
const int numErrors = _errors.size();
|
|
errors.reserve(numErrors);
|
|
for (int i = 0; i < numErrors; ++i) {
|
|
QmlJS::DiagnosticMessage e = _errors.at(i);
|
|
e.message.replace(QLatin1String("$$URI$$"), uri);
|
|
errors << e;
|
|
}
|
|
return errors;
|
|
}
|
|
|
|
QDebug &operator<< (QDebug &debug, const QmlDirParser::Component &component)
|
|
{
|
|
const QString output = QStringLiteral("{%1 %2.%3}").
|
|
arg(component.typeName).arg(component.majorVersion).arg(component.minorVersion);
|
|
return debug << qPrintable(output);
|
|
}
|
|
|
|
QDebug &operator<< (QDebug &debug, const QmlDirParser::Script &script)
|
|
{
|
|
const QString output = QStringLiteral("{%1 %2.%3}").
|
|
arg(script.nameSpace).arg(script.majorVersion).arg(script.minorVersion);
|
|
return debug << qPrintable(output);
|
|
}
|
|
|
|
QT_QML_END_NAMESPACE
|