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
|
// Copyright (C) 2021 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#ifndef QMLJSLINTER_P_H
#define QMLJSLINTER_P_H
//
// W A R N I N G
// -------------
//
// This file is not part of the Qt API. It exists purely as an
// implementation detail. This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
#include <qtqmlcompilerexports.h>
#include <QtQmlCompiler/private/qqmljslogger_p.h>
#include <QtQmlCompiler/private/qqmljsimporter_p.h>
#include <QtQml/private/qqmljssourcelocation_p.h>
#include <QtCore/qjsonarray.h>
#include <QtCore/qstring.h>
#include <QtCore/qmap.h>
#include <QtCore/qscopedpointer.h>
#include <vector>
#include <optional>
QT_BEGIN_NAMESPACE
class QPluginLoader;
struct QStaticPlugin;
namespace QQmlSA {
class LintPlugin;
}
class Q_QMLCOMPILER_EXPORT QQmlJSLinter
{
public:
QQmlJSLinter(const QStringList &importPaths,
const QStringList &pluginPaths = { QQmlJSLinter::defaultPluginPath() },
bool useAbsolutePath = false);
enum LintResult { FailedToOpen, FailedToParse, HasWarnings, LintSuccess };
enum FixResult { NothingToFix, FixError, FixSuccess };
class Q_QMLCOMPILER_EXPORT Plugin
{
Q_DISABLE_COPY(Plugin)
public:
Plugin() = default;
Plugin(Plugin &&plugin) noexcept;
#if QT_CONFIG(library)
Plugin(QString path);
#endif
Plugin(const QStaticPlugin &plugin);
~Plugin();
const QString &name() const { return m_name; }
const QString &description() const { return m_description; }
const QString &version() const { return m_version; }
const QString &author() const { return m_author; }
const QList<QQmlJS::LoggerCategory> categories() const
{
return m_categories;
}
bool isBuiltin() const { return m_isBuiltin; }
bool isValid() const { return m_isValid; }
bool isInternal() const
{
return m_isInternal;
}
bool isEnabled() const
{
return m_isEnabled;
}
void setEnabled(bool isEnabled)
{
m_isEnabled = isEnabled;
}
private:
friend class QQmlJSLinter;
bool parseMetaData(const QJsonObject &metaData, QString pluginName);
QString m_name;
QString m_description;
QString m_version;
QString m_author;
QList<QQmlJS::LoggerCategory> m_categories;
QQmlSA::LintPlugin *m_instance;
std::unique_ptr<QPluginLoader> m_loader;
bool m_isBuiltin = false;
bool m_isInternal =
false; // Internal plugins are those developed and maintained inside the Qt project
bool m_isValid = false;
bool m_isEnabled = true;
};
static std::vector<Plugin> loadPlugins(QStringList paths);
static QString defaultPluginPath();
LintResult lintFile(const QString &filename, const QString *fileContents, const bool silent,
QJsonArray *json, const QStringList &qmlImportPaths,
const QStringList &qmldirFiles, const QStringList &resourceFiles,
const QList<QQmlJS::LoggerCategory> &categories);
LintResult lintModule(const QString &uri, const bool silent, QJsonArray *json,
const QStringList &qmlImportPaths, const QStringList &resourceFiles);
FixResult applyFixes(QString *fixedCode, bool silent);
const QQmlJSLogger *logger() const { return m_logger.get(); }
std::vector<Plugin> &plugins()
{
return m_plugins;
}
void setPlugins(std::vector<Plugin> plugins) { m_plugins = std::move(plugins); }
void setPluginsEnabled(bool enablePlugins) { m_enablePlugins = enablePlugins; }
bool pluginsEnabled() const { return m_enablePlugins; }
void clearCache() { m_importer.clearCache(); }
private:
void parseComments(QQmlJSLogger *logger, const QList<QQmlJS::SourceLocation> &comments);
void processMessages(QJsonArray &warnings);
bool m_useAbsolutePath;
bool m_enablePlugins;
QQmlJSImporter m_importer;
QScopedPointer<QQmlJSLogger> m_logger;
QString m_fileContents;
std::vector<Plugin> m_plugins;
};
QT_END_NAMESPACE
#endif // QMLJSLINTER_P_H
|
