feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Valgrind: Inline suppressiondialog.{h,cpp} into its only user

Browse Source 
Change-Id: Ica1e67ce67c15c2481b0d892090f6a59fb6d2145
Reviewed-by: Jarek Kobus <jaroslaw.kobus@qt.io>
This commit is contained in:
hjk
2023-07-25 10:52:07 +02:00
parent b53d1186ea
commit 82f39892f9
5 changed files with 233 additions and 295 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
src/plugins/valgrind/CMakeLists.txt
View File

@@ -24,7 +24,6 @@ add_qtc_plugin(Valgrind
callgrindvisualisation.cpp callgrindvisualisation.h
memcheckerrorview.cpp memcheckerrorview.h
memchecktool.cpp memchecktool.h
suppressiondialog.cpp suppressiondialog.h
valgrind.qrc
valgrindengine.cpp valgrindengine.h
valgrindplugin.cpp

237
src/plugins/valgrind/memcheckerrorview.cpp
View File

@@ -3,24 +3,33 @@
#include "memcheckerrorview.h"
#include "suppressiondialog.h"
#include "valgrindsettings.h"
#include "valgrindtr.h"
#include "xmlprotocol/error.h"
#include "xmlprotocol/errorlistmodel.h"
#include "xmlprotocol/frame.h"
#include "xmlprotocol/stack.h"
#include "xmlprotocol/suppression.h"
#include <coreplugin/editormanager/editormanager.h>
#include <projectexplorer/project.h>
#include <projectexplorer/projectexplorer.h>
#include <projectexplorer/projectmanager.h>
#include <projectexplorer/projectnodes.h>
#include <utils/qtcassert.h>
#include <utils/algorithm.h>
#include <utils/icon.h>
#include <utils/pathchooser.h>
#include <utils/qtcassert.h>
#include <utils/theme/theme.h>
#include <QAction>
#include <QDialog>
#include <QDialogButtonBox>
#include <QFormLayout>
#include <QLabel>
#include <QPlainTextEdit>
#include <QPushButton>
using namespace Utils;
using namespace Valgrind::XmlProtocol;
@@ -28,6 +37,25 @@ using namespace Valgrind::XmlProtocol;
namespace Valgrind {
namespace Internal {
class SuppressionDialog : public QDialog
{
public:
SuppressionDialog(MemcheckErrorView *view, const QList<XmlProtocol::Error> &errors);
private:
void validate();
void accept() override;
void reject() override;
MemcheckErrorView *m_view;
bool m_cleanupIfCanceled;
QList<XmlProtocol::Error> m_errors;
Utils::PathChooser *m_fileChooser;
QPlainTextEdit *m_suppressionEdit;
QDialogButtonBox *m_buttonBox;
};
MemcheckErrorView::MemcheckErrorView(QWidget *parent)
: Debugger::DetailedErrorView(parent)
{
@@ -66,7 +94,23 @@ void MemcheckErrorView::settingsChanged(ValgrindBaseSettings *settings)
void MemcheckErrorView::suppressError()
{
SuppressionDialog::maybeShow(this);
QModelIndexList indices = selectionModel()->selectedRows();
// Can happen when using arrow keys to navigate and shortcut to trigger suppression:
if (indices.isEmpty() && selectionModel()->currentIndex().isValid())
indices.append(selectionModel()->currentIndex());
QList<XmlProtocol::Error> errors;
for (const QModelIndex &index : std::as_const(indices)) {
Error error = model()->data(index, ErrorListModel::ErrorRole).value<Error>();
if (!error.suppression().isNull())
errors.append(error);
}
if (errors.isEmpty())
return;
SuppressionDialog dialog(this, errors);
dialog.exec();
}
QList<QAction *> MemcheckErrorView::customActions() const
@@ -88,5 +132,190 @@ QList<QAction *> MemcheckErrorView::customActions() const
return actions;
}
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_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 : std::as_const(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::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::ProjectManager::projectForFile(path)) {
for (ProjectExplorer::Project *p : ProjectExplorer::ProjectManager::projects()) {
if (path.startsWith(p->projectDirectory().toString())) {
p->rootProjectNode()->addFiles({path});
break;
}
}
}
m_view->settings()->suppressions.addSuppressionFile(path);
const QModelIndexList indices = Utils::sorted(m_view->selectionModel()->selectedRows(),
[](const QModelIndex &l, const QModelIndex &r) {
return l.row() > r.row();
});
QAbstractItemModel *model = m_view->model();
for (const QModelIndex &index : 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 : std::as_const(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

245
src/plugins/valgrind/suppressiondialog.cpp
View File

@@ -1,245 +0,0 @@
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only 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/project.h>
#include <projectexplorer/projectexplorer.h>
#include <projectexplorer/projectmanager.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_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 : std::as_const(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 : std::as_const(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::ProjectManager::projectForFile(path)) {
for (ProjectExplorer::Project *p : ProjectExplorer::ProjectManager::projects()) {
if (path.startsWith(p->projectDirectory().toString())) {
p->rootProjectNode()->addFiles({path});
break;
}
}
}
m_view->settings()->suppressions.addSuppressionFile(path);
const QModelIndexList indices = Utils::sorted(m_view->selectionModel()->selectedRows(),
[](const QModelIndex &l, const QModelIndex &r) {
return l.row() > r.row();
});
QAbstractItemModel *model = m_view->model();
for (const QModelIndex &index : 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 : std::as_const(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

44
src/plugins/valgrind/suppressiondialog.h
View File

@@ -1,44 +0,0 @@
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#pragma once
#include "xmlprotocol/error.h"
#include <utils/pathchooser.h>
#include <QDialog>
QT_BEGIN_NAMESPACE
class QPlainTextEdit;
class QDialogButtonBox;
QT_END_NAMESPACE
namespace Valgrind {
namespace Internal {
class MemcheckErrorView;
class SuppressionDialog : public QDialog
{
public:
SuppressionDialog(MemcheckErrorView *view,
const QList<XmlProtocol::Error> &errors);
static void maybeShow(MemcheckErrorView *view);
private:
void validate();
void accept() override;
void reject() override;
MemcheckErrorView *m_view;
bool m_cleanupIfCanceled;
QList<XmlProtocol::Error> m_errors;
Utils::PathChooser *m_fileChooser;
QPlainTextEdit *m_suppressionEdit;
QDialogButtonBox *m_buttonBox;
};
} // namespace Internal
} // namespace Valgrind

1
src/plugins/valgrind/valgrind.qbs
View File

@@ -28,7 +28,6 @@ QtcPlugin {
"callgrindvisualisation.cpp", "callgrindvisualisation.h",
"memcheckerrorview.cpp", "memcheckerrorview.h",
"memchecktool.cpp", "memchecktool.h",
"suppressiondialog.cpp", "suppressiondialog.h",
"valgrind.qrc",
"valgrindengine.cpp", "valgrindengine.h",
"valgrindplugin.cpp",