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
|
// 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 QQMLJSLOGGER_P_H
#define QQMLJSLOGGER_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 "qcoloroutput_p.h"
#include "qqmljsloggingutils_p.h"
#include <private/qqmljsdiagnosticmessage_p.h>
#include <QtCore/qhash.h>
#include <QtCore/qmap.h>
#include <QtCore/qstring.h>
#include <QtCore/qlist.h>
#include <QtCore/qset.h>
#include <QtCore/QLoggingCategory>
#include <optional>
QT_BEGIN_NAMESPACE
/*!
\internal
Used to print the line containing the location of a certain error
*/
class Q_QMLCOMPILER_EXPORT IssueLocationWithContext
{
public:
/*!
\internal
\param code: The whole text of a translation unit
\param location: The location where an error occurred.
*/
IssueLocationWithContext(QStringView code, const QQmlJS::SourceLocation &location) {
quint32 before = qMax(0, code.lastIndexOf(QLatin1Char('\n'), location.offset));
if (before != 0 && before < location.offset)
before++;
m_beforeText = code.mid(before, location.offset - before);
m_issueText = code.mid(location.offset, location.length);
int after = code.indexOf(QLatin1Char('\n'), location.offset + location.length);
m_afterText = code.mid(location.offset + location.length,
after - (location.offset+location.length));
}
// returns start of the line till first character of location
QStringView beforeText() const { return m_beforeText; }
// returns the text at location
QStringView issueText() const { return m_issueText; }
// returns any text after location until the end of the line is reached
QStringView afterText() const { return m_afterText; }
private:
QStringView m_beforeText;
QStringView m_issueText;
QStringView m_afterText;
};
class Q_QMLCOMPILER_EXPORT QQmlJSFixSuggestion
{
public:
QQmlJSFixSuggestion() = default;
QQmlJSFixSuggestion(const QString &fixDescription, const QQmlJS::SourceLocation &location,
const QString &replacement = QString());
QString fixDescription() const { return m_fixDescription; }
QQmlJS::SourceLocation location() const { return m_location; }
QString replacement() const { return m_replacement; }
void setFilename(const QString &filename) { m_filename = filename; }
QString filename() const { return m_filename; }
void setHint(const QString &hint) { m_hint = hint; }
QString hint() const { return m_hint; }
void setAutoApplicable(bool autoApply = true) { m_autoApplicable = autoApply; }
bool isAutoApplicable() const { return m_autoApplicable; }
bool operator==(const QQmlJSFixSuggestion &) const;
bool operator!=(const QQmlJSFixSuggestion &) const;
private:
QQmlJS::SourceLocation m_location;
QString m_fixDescription;
QString m_replacement;
QString m_filename;
QString m_hint;
bool m_autoApplicable = false;
};
struct Message : public QQmlJS::DiagnosticMessage
{
// This doesn't need to be an owning-reference since the string is expected to outlive any
// Message object by virtue of coming from a LoggerWarningId.
QAnyStringView id;
std::optional<QQmlJSFixSuggestion> fixSuggestion;
};
class Q_QMLCOMPILER_EXPORT QQmlJSLogger
{
Q_DISABLE_COPY_MOVE(QQmlJSLogger)
public:
QList<QQmlJS::LoggerCategory> categories() const;
static const QList<QQmlJS::LoggerCategory> &defaultCategories();
void registerCategory(const QQmlJS::LoggerCategory &category);
QQmlJSLogger();
~QQmlJSLogger() = default;
bool hasWarnings() const { return !m_warnings.isEmpty(); }
bool hasErrors() const { return !m_errors.isEmpty(); }
const QList<Message> &infos() const { return m_infos; }
const QList<Message> &warnings() const { return m_warnings; }
const QList<Message> &errors() const { return m_errors; }
QtMsgType categoryLevel(QQmlJS::LoggerWarningId id) const
{
return m_categoryLevels[id.name().toString()];
}
void setCategoryLevel(QQmlJS::LoggerWarningId id, QtMsgType level)
{
m_categoryLevels[id.name().toString()] = level;
m_categoryChanged[id.name().toString()] = true;
}
bool isCategoryIgnored(QQmlJS::LoggerWarningId id) const
{
return m_categoryIgnored[id.name().toString()];
}
void setCategoryIgnored(QQmlJS::LoggerWarningId id, bool error)
{
m_categoryIgnored[id.name().toString()] = error;
m_categoryChanged[id.name().toString()] = true;
}
bool isCategoryFatal(QQmlJS::LoggerWarningId id) const
{
return m_categoryFatal[id.name().toString()];
}
void setCategoryFatal(QQmlJS::LoggerWarningId id, bool error)
{
m_categoryFatal[id.name().toString()] = error;
m_categoryChanged[id.name().toString()] = true;
}
bool wasCategoryChanged(QQmlJS::LoggerWarningId id) const
{
return m_categoryChanged[id.name().toString()];
}
/*! \internal
Logs \a message with severity deduced from \a category. Prefer using
this function in most cases.
\sa setCategoryLevel
*/
void log(const QString &message, QQmlJS::LoggerWarningId id,
const QQmlJS::SourceLocation &srcLocation, bool showContext = true,
bool showFileName = true, const std::optional<QQmlJSFixSuggestion> &suggestion = {},
const QString overrideFileName = QString())
{
log(message, id, srcLocation, m_categoryLevels[id.name().toString()], showContext,
showFileName, suggestion, overrideFileName);
}
void processMessages(const QList<QQmlJS::DiagnosticMessage> &messages,
const QQmlJS::LoggerWarningId id);
void ignoreWarnings(uint32_t line, const QSet<QString> &categories)
{
m_ignoredWarnings[line] = categories;
}
void setSilent(bool silent) { m_output.setSilent(silent); }
bool isSilent() const { return m_output.isSilent(); }
void setCode(const QString &code) { m_code = code; }
QString code() const { return m_code; }
void setFileName(const QString &fileName) { m_fileName = fileName; }
QString fileName() const { return m_fileName; }
private:
QMap<QString, QQmlJS::LoggerCategory> m_categories;
void printContext(const QString &overrideFileName, const QQmlJS::SourceLocation &location);
void printFix(const QQmlJSFixSuggestion &fix);
void log(const QString &message, QQmlJS::LoggerWarningId id,
const QQmlJS::SourceLocation &srcLocation, QtMsgType type, bool showContext,
bool showFileName, const std::optional<QQmlJSFixSuggestion> &suggestion,
const QString overrideFileName);
QString m_fileName;
QString m_code;
QColorOutput m_output;
QHash<QString, QtMsgType> m_categoryLevels;
QHash<QString, bool> m_categoryIgnored;
// If true, triggers qFatal on documents with "pragma Strict"
// TODO: Works only for qmlCompiler category so far.
QHash<QString, bool> m_categoryFatal;
QHash<QString, bool> m_categoryChanged;
QList<Message> m_infos;
QList<Message> m_warnings;
QList<Message> m_errors;
QHash<uint32_t, QSet<QString>> m_ignoredWarnings;
// the compiler needs private log() function at the moment
friend class QQmlJSAotCompiler;
};
QT_END_NAMESPACE
#endif // QQMLJSLOGGER_P_H
|
