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
240
241
242
243
244
245
246
|
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0+ OR GPL-3.0 WITH Qt-GPL-exception-1.0
#include "suppressiondialog.h"
#include "memcheckerrorview.h"
#include "valgrindsettings.h"
#include "valgrindtr.h"
#include "xmlprotocol/suppression.h"
#include "xmlprotocol/errorlistmodel.h"
#include "xmlprotocol/stack.h"
#include "xmlprotocol/frame.h"
#include <projectexplorer/projectexplorer.h>
#include <projectexplorer/session.h>
#include <projectexplorer/project.h>
#include <projectexplorer/projectnodes.h>
#include <utils/algorithm.h>
#include <utils/pathchooser.h>
#include <utils/fileutils.h>
#include <utils/qtcassert.h>
#include <QDialogButtonBox>
#include <QFile>
#include <QFormLayout>
#include <QLabel>
#include <QPlainTextEdit>
#include <QPushButton>
using namespace Utils;
using namespace Valgrind::XmlProtocol;
namespace Valgrind {
namespace Internal {
static QString suppressionText(const Error &error)
{
Suppression sup(error.suppression());
// workaround: https://bugs.kde.org/show_bug.cgi?id=255822
if (sup.frames().size() >= 24)
sup.setFrames(sup.frames().mid(0, 23));
QTC_CHECK(sup.frames().size() < 24);
// try to set some useful name automatically, instead of "insert_name_here"
// we take the last stack frame and append the suppression kind, e.g.:
// QDebug::operator<<(bool) [Memcheck:Cond]
if (!error.stacks().isEmpty() && !error.stacks().constFirst().frames().isEmpty()) {
const Frame frame = error.stacks().constFirst().frames().constFirst();
QString newName;
if (!frame.functionName().isEmpty())
newName = frame.functionName();
else if (!frame.object().isEmpty())
newName = frame.object();
if (!newName.isEmpty())
sup.setName(newName + '[' + sup.kind() + ']');
}
return sup.toString();
}
/// @p error input error, which might get hidden when it has the same stack
/// @p suppressed the error that got suppressed already
static bool equalSuppression(const Error &error, const Error &suppressed)
{
if (error.kind() != suppressed.kind() || error.suppression().isNull())
return false;
const SuppressionFrames errorFrames = error.suppression().frames();
const SuppressionFrames suppressedFrames = suppressed.suppression().frames();
// limit to 23 frames, see: https://bugs.kde.org/show_bug.cgi?id=255822
if (qMin(23, suppressedFrames.size()) > errorFrames.size())
return false;
int frames = 23;
if (errorFrames.size() < frames)
frames = errorFrames.size();
if (suppressedFrames.size() < frames)
frames = suppressedFrames.size();
for (int i = 0; i < frames; ++i)
if (errorFrames.at(i) != suppressedFrames.at(i))
return false;
return true;
}
SuppressionDialog::SuppressionDialog(MemcheckErrorView *view, const QList<Error> &errors)
: m_view(view),
m_settings(view->settings()),
m_cleanupIfCanceled(false),
m_errors(errors),
m_fileChooser(new PathChooser(this)),
m_suppressionEdit(new QPlainTextEdit(this))
{
setWindowTitle(Tr::tr("Save Suppression"));
auto fileLabel = new QLabel(Tr::tr("Suppression File:"), this);
auto suppressionsLabel = new QLabel(Tr::tr("Suppression:"), this);
suppressionsLabel->setBuddy(m_suppressionEdit);
QFont font;
font.setFamily("Monospace");
m_suppressionEdit->setFont(font);
m_buttonBox = new QDialogButtonBox(this);
m_buttonBox->setStandardButtons(QDialogButtonBox::Cancel|QDialogButtonBox::Save);
auto formLayout = new QFormLayout(this);
formLayout->addRow(fileLabel, m_fileChooser);
formLayout->addRow(suppressionsLabel);
formLayout->addRow(m_suppressionEdit);
formLayout->addRow(m_buttonBox);
const FilePath defaultSuppFile = view->defaultSuppressionFile();
if (!defaultSuppFile.exists() && defaultSuppFile.ensureExistingFile())
m_cleanupIfCanceled = true;
m_fileChooser->setExpectedKind(PathChooser::File);
m_fileChooser->setHistoryCompleter("Valgrind.Suppression.History");
m_fileChooser->setPath(defaultSuppFile.fileName());
m_fileChooser->setPromptDialogFilter("*.supp");
m_fileChooser->setPromptDialogTitle(Tr::tr("Select Suppression File"));
QString suppressions;
for (const Error &error : qAsConst(m_errors))
suppressions += suppressionText(error);
m_suppressionEdit->setPlainText(suppressions);
connect(m_fileChooser, &PathChooser::validChanged,
this, &SuppressionDialog::validate);
connect(m_suppressionEdit->document(), &QTextDocument::contentsChanged,
this, &SuppressionDialog::validate);
connect(m_buttonBox, &QDialogButtonBox::accepted,
this, &SuppressionDialog::accept);
connect(m_buttonBox, &QDialogButtonBox::rejected,
this, &SuppressionDialog::reject);
}
void SuppressionDialog::maybeShow(MemcheckErrorView *view)
{
QModelIndexList indices = view->selectionModel()->selectedRows();
// Can happen when using arrow keys to navigate and shortcut to trigger suppression:
if (indices.isEmpty() && view->selectionModel()->currentIndex().isValid())
indices.append(view->selectionModel()->currentIndex());
QList<XmlProtocol::Error> errors;
for (const QModelIndex &index : qAsConst(indices)) {
Error error = view->model()->data(index, ErrorListModel::ErrorRole).value<Error>();
if (!error.suppression().isNull())
errors.append(error);
}
if (errors.isEmpty())
return;
SuppressionDialog dialog(view, errors);
dialog.exec();
}
void SuppressionDialog::accept()
{
const FilePath path = m_fileChooser->filePath();
QTC_ASSERT(!path.isEmpty(), return);
QTC_ASSERT(!m_suppressionEdit->toPlainText().trimmed().isEmpty(), return);
FileSaver saver(path, QIODevice::Append);
if (!saver.hasError()) {
QTextStream stream(saver.file());
stream << m_suppressionEdit->toPlainText();
saver.setResult(&stream);
}
if (!saver.finalize(this))
return;
// Add file to project if there is a project containing this file on the file system.
if (!ProjectExplorer::SessionManager::projectForFile(path)) {
for (ProjectExplorer::Project *p : ProjectExplorer::SessionManager::projects()) {
if (path.startsWith(p->projectDirectory().toString())) {
p->rootProjectNode()->addFiles({path});
break;
}
}
}
m_settings->suppressions.addSuppressionFile(path);
QModelIndexList indices = m_view->selectionModel()->selectedRows();
Utils::sort(indices, [](const QModelIndex &l, const QModelIndex &r) {
return l.row() > r.row();
});
QAbstractItemModel *model = m_view->model();
for (const QModelIndex &index : qAsConst(indices)) {
bool removed = model->removeRow(index.row());
QTC_ASSERT(removed, qt_noop());
Q_UNUSED(removed)
}
// One suppression might hide multiple rows, care for that.
for (int row = 0; row < model->rowCount(); ++row ) {
const Error rowError = model->data(
model->index(row, 0), ErrorListModel::ErrorRole).value<Error>();
for (const Error &error : qAsConst(m_errors)) {
if (equalSuppression(rowError, error)) {
bool removed = model->removeRow(row);
QTC_CHECK(removed);
// Gets incremented in the for loop again.
--row;
break;
}
}
}
// Select a new item.
m_view->setCurrentIndex(indices.first());
QDialog::accept();
}
void SuppressionDialog::reject()
{
if (m_cleanupIfCanceled)
m_view->defaultSuppressionFile().removeFile();
QDialog::reject();
}
void SuppressionDialog::validate()
{
bool valid = m_fileChooser->isValid()
&& !m_suppressionEdit->toPlainText().trimmed().isEmpty();
m_buttonBox->button(QDialogButtonBox::Save)->setEnabled(valid);
}
} // namespace Internal
} // namespace Valgrind
|
