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
|
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtQml module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** 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-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**/
#ifndef ERRORMESSAGE_H
#define ERRORMESSAGE_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 "qqmldom_global.h"
#include "qqmldomstringdumper_p.h"
#include "qqmldompath_p.h"
#include <QtQml/private/qqmljsast_p.h>
#include <QtCore/QCoreApplication>
#include <QtCore/QString>
#include <QtCore/QCborArray>
#include <QtCore/QCborMap>
#include <QtQml/private/qqmljsdiagnosticmessage_p.h>
QT_BEGIN_NAMESPACE
namespace QQmlJS {
namespace Dom {
QMLDOM_EXPORT ErrorLevel errorLevelFromQtMsgType(QtMsgType msgType);
class ErrorGroups;
class DomItem;
using std::function;
#define NewErrorGroup(name) QQmlJS::Dom::ErrorGroup(QT_TRANSLATE_NOOP("ErrorGroup", name))
class QMLDOM_EXPORT ErrorGroup {
Q_GADGET
Q_DECLARE_TR_FUNCTIONS(ErrorGroup)
public:
constexpr ErrorGroup(const char *groupId):
m_groupId(groupId)
{}
void dump(Sink sink) const;
void dumpId(Sink sink) const;
QLatin1String groupId() const;
QString groupName() const;
private:
const char *m_groupId;
};
class QMLDOM_EXPORT ErrorGroups{
Q_GADGET
public:
void dump(Sink sink) const;
void dumpId(Sink sink) const;
QCborArray toCbor() const;
[[nodiscard]] ErrorMessage errorMessage(Dumper msg, ErrorLevel level, Path element = Path(), QString canonicalFilePath = QString(), SourceLocation location = SourceLocation()) const;
[[nodiscard]] ErrorMessage errorMessage(const DiagnosticMessage &msg, Path element = Path(), QString canonicalFilePath = QString()) const;
void fatal(Dumper msg, Path element = Path(), QStringView canonicalFilePath = u"", SourceLocation location = SourceLocation()) const;
[[nodiscard]] ErrorMessage debug(QString message) const;
[[nodiscard]] ErrorMessage debug(Dumper message) const;
[[nodiscard]] ErrorMessage info(QString message) const;
[[nodiscard]] ErrorMessage info(Dumper message) const;
[[nodiscard]] ErrorMessage hint(QString message) const;
[[nodiscard]] ErrorMessage hint(Dumper message) const;
[[nodiscard]] ErrorMessage maybeWarning(QString message) const;
[[nodiscard]] ErrorMessage maybeWarning(Dumper message) const;
[[nodiscard]] ErrorMessage warning(QString message) const;
[[nodiscard]] ErrorMessage warning(Dumper message) const;
[[nodiscard]] ErrorMessage maybeError(QString message) const;
[[nodiscard]] ErrorMessage maybeError(Dumper message) const;
[[nodiscard]] ErrorMessage error(QString message) const;
[[nodiscard]] ErrorMessage error(Dumper message) const;
static int cmp(const ErrorGroups &g1, const ErrorGroups &g2);
QVector<ErrorGroup> groups;
};
inline bool operator==(const ErrorGroups& lhs, const ErrorGroups& rhs){ return ErrorGroups::cmp(lhs,rhs) == 0; }
inline bool operator!=(const ErrorGroups& lhs, const ErrorGroups& rhs){ return ErrorGroups::cmp(lhs,rhs) != 0; }
inline bool operator< (const ErrorGroups& lhs, const ErrorGroups& rhs){ return ErrorGroups::cmp(lhs,rhs) < 0; }
inline bool operator> (const ErrorGroups& lhs, const ErrorGroups& rhs){ return ErrorGroups::cmp(lhs,rhs) > 0; }
inline bool operator<=(const ErrorGroups& lhs, const ErrorGroups& rhs){ return ErrorGroups::cmp(lhs,rhs) <= 0; }
inline bool operator>=(const ErrorGroups& lhs, const ErrorGroups& rhs){ return ErrorGroups::cmp(lhs,rhs) >= 0; }
class QMLDOM_EXPORT ErrorMessage { // reuse Some of the other DiagnosticMessages?
Q_GADGET
Q_DECLARE_TR_FUNCTIONS(ErrorMessage)
public:
using Level = ErrorLevel;
// error registry (usage is optional)
static QLatin1String msg(const char *errorId, ErrorMessage err);
static QLatin1String msg(QLatin1String errorId, ErrorMessage err);
static void visitRegisteredMessages(std::function<bool(ErrorMessage)> visitor);
[[nodiscard]] static ErrorMessage load(QLatin1String errorId);
[[nodiscard]] static ErrorMessage load(const char *errorId);
template<typename... T>
[[nodiscard]] static ErrorMessage load(QLatin1String errorId, T... args){
ErrorMessage res = load(errorId);
res.message = res.message.arg(args...);
return res;
}
ErrorMessage(QString message, ErrorGroups errorGroups, Level level = Level::Warning, Path path = Path(), QString file = QString(), SourceLocation location = SourceLocation(), QLatin1String errorId = QLatin1String(""));
ErrorMessage(ErrorGroups errorGroups, const DiagnosticMessage &msg, Path path = Path(), QString file = QString(), QLatin1String errorId = QLatin1String(""));
[[nodiscard]] ErrorMessage &withErrorId(QLatin1String errorId);
[[nodiscard]] ErrorMessage &withPath(const Path &);
[[nodiscard]] ErrorMessage &withFile(QString);
[[nodiscard]] ErrorMessage &withFile(QStringView);
[[nodiscard]] ErrorMessage &withLocation(SourceLocation);
[[nodiscard]] ErrorMessage &withItem(DomItem);
ErrorMessage handle(const ErrorHandler &errorHandler=nullptr);
void dump(Sink s) const;
QString toString() const;
QCborMap toCbor() const;
QLatin1String errorId;
QString message;
ErrorGroups errorGroups;
Level level;
Path path;
QString file;
SourceLocation location;
};
inline bool operator !=(const ErrorMessage &e1, const ErrorMessage &e2) {
return e1.errorId != e2.errorId || e1.message != e2.message || e1.errorGroups != e2.errorGroups
|| e1.level != e2.level || e1.path != e2.path || e1.file != e2.file
|| e1.location.startLine != e2.location.startLine || e1.location.offset != e2.location.offset
|| e1.location.startColumn != e2.location.startColumn || e1.location.length != e2.location.length;
}
inline bool operator ==(const ErrorMessage &e1, const ErrorMessage &e2) {
return !(e1 != e2);
}
QMLDOM_EXPORT void silentError(const ErrorMessage &);
QMLDOM_EXPORT void errorToQDebug(const ErrorMessage &);
QMLDOM_EXPORT void defaultErrorHandler(const ErrorMessage &);
QMLDOM_EXPORT void setDefaultErrorHandler(ErrorHandler h);
} // end namespace Dom
} // end namespace QQmlJS
QT_END_NAMESPACE
#endif // ERRORMESSAGE_H
|
