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
|
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing
**
** This file is part of the Qt Build Suite.
**
** 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 http://www.qt.io/terms-conditions. For further information
** use the contact form at http://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 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, The Qt Company gives you certain additional
** rights. These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/
#include "error.h"
#include <QRegularExpression>
#include <QSharedData>
#include <QStringList>
namespace qbs {
class ErrorItem::ErrorItemPrivate : public QSharedData
{
public:
QString description;
CodeLocation codeLocation;
bool isBacktraceItem = false;
};
/*!
* \class ErrorData
* \brief The \c ErrorData class describes (part of) an error resulting from a qbs operation.
* It is always delivered as part of an \c Error.
* \sa Error
*/
ErrorItem::ErrorItem() : d(new ErrorItemPrivate)
{
}
ErrorItem::ErrorItem(const QString &description, const CodeLocation &codeLocation,
bool isBacktraceItem)
: d(new ErrorItemPrivate)
{
d->description = description;
d->codeLocation = codeLocation;
d->isBacktraceItem = isBacktraceItem;
}
ErrorItem::ErrorItem(const ErrorItem &rhs) : d(rhs.d)
{
}
ErrorItem &ErrorItem::operator=(const ErrorItem &other)
{
d = other.d;
return *this;
}
ErrorItem::~ErrorItem()
{
}
QString ErrorItem::description() const
{
return d->description;
}
CodeLocation ErrorItem::codeLocation() const
{
return d->codeLocation;
}
bool ErrorItem::isBacktraceItem() const
{
return d->isBacktraceItem;
}
/*!
* \fn const QString &ErrorData::description() const
* \brief A general description of the error.
*/
/*!
* \fn const QString &ErrorData::codeLocation() const
* \brief The location at which file in which the error occurred.
* \note This information might not be applicable, in which case location().isValid() returns false
*/
/*!
* \brief A full textual description of the error using all available information.
*/
QString ErrorItem::toString() const
{
QString str = codeLocation().toString();
if (!str.isEmpty())
str += QLatin1Char(' ');
return str += description();
}
class ErrorInfo::ErrorInfoPrivate : public QSharedData
{
public:
ErrorInfoPrivate() : internalError(false) { }
QList<ErrorItem> items;
bool internalError;
};
/*!
* \class Error
* \brief Represents an error resulting from a qbs operation.
* It is made up of one or more \c ErrorData objects.
* \sa ErrorData
*/
ErrorInfo::ErrorInfo() : d(new ErrorInfoPrivate)
{
}
ErrorInfo::ErrorInfo(const ErrorInfo &rhs) : d(rhs.d)
{
}
ErrorInfo::ErrorInfo(const QString &description, const CodeLocation &location, bool internalError)
: d(new ErrorInfoPrivate)
{
append(description, location);
d->internalError = internalError;
}
ErrorInfo::ErrorInfo(const QString &description, const QStringList &backtrace)
: d(new ErrorInfoPrivate)
{
append(description);
for (const QString &traceLine : backtrace) {
QRegularExpression regexp(
QStringLiteral("^(?<message>.+) at (?<file>.+):(?<line>\\-?[0-9]+)$"));
QRegularExpressionMatch match = regexp.match(traceLine);
if (match.hasMatch()) {
const CodeLocation location(match.captured(QStringLiteral("file")),
match.captured(QStringLiteral("line")).toInt());
appendBacktrace(match.captured(QStringLiteral("message")), location);
}
}
}
ErrorInfo &ErrorInfo::operator =(const ErrorInfo &other)
{
d = other.d;
return *this;
}
ErrorInfo::~ErrorInfo()
{
}
void ErrorInfo::appendBacktrace(const QString &description, const CodeLocation &location)
{
d->items.append(ErrorItem(description, location, true));
}
void ErrorInfo::append(const QString &description, const CodeLocation &location)
{
d->items.append(ErrorItem(description, location));
}
void ErrorInfo::prepend(const QString &description, const CodeLocation &location)
{
d->items.prepend(ErrorItem(description, location));
}
/*!
* \brief A list of concrete error description.
* Most often, there will be one element in this list, but there can be more e.g. to illustrate
* how an error condition propagates through several source files.
*/
QList<ErrorItem> ErrorInfo::items() const
{
return d->items;
}
void ErrorInfo::clear()
{
d->items.clear();
}
/*!
* \brief A complete textual description of the error.
* All "sub-errors" will be represented.
* \sa Error::entries()
*/
QString ErrorInfo::toString() const
{
QStringList lines;
foreach (const ErrorItem &e, d->items) {
if (e.isBacktraceItem()) {
QString line;
if (!e.description().isEmpty())
line.append(QStringLiteral(" at %1").arg(e.description()));
if (e.codeLocation().isValid())
line.append(QStringLiteral(" in %1").arg(e.codeLocation().toString()));
if (!line.isEmpty())
lines.append(QStringLiteral("\t") + line);
} else {
lines.append(e.toString());
}
}
return lines.join(QLatin1Char('\n'));
}
/*!
* \brief Returns true if this error represents a bug in qbs, false otherwise.
*/
bool ErrorInfo::isInternalError() const
{
return d->internalError;
}
} // namespace qbs
|
