cppcheck/gui/erroritem.h

129 lines
3.2 KiB
C
Raw Normal View History

/*
* Cppcheck - A tool for static C/C++ code analysis
2022-02-05 11:45:17 +01:00
* Copyright (C) 2007-2022 Cppcheck team.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef ERRORITEM_H
#define ERRORITEM_H
#include "errorlogger.h"
#include "errortypes.h"
2022-02-02 16:17:28 +01:00
#include <QList>
#include <QMetaType>
#include <QString>
/// @addtogroup GUI
/// @{
/**
* @brief GUI versions of severity conversions.
* GUI needs wrappers for conversion functions since GUI uses Qt's QString
* instead of the std::string used by lib/cli.
*/
class GuiSeverity {
public:
2014-11-20 14:20:09 +01:00
static QString toString(Severity::SeverityType severity) {
2016-10-02 18:11:44 +02:00
return QString::fromStdString(Severity::toString(severity));
}
2014-11-20 14:20:09 +01:00
static Severity::SeverityType fromString(const QString &severity) {
return Severity::fromString(severity.toStdString());
}
};
2017-05-21 08:25:55 +02:00
/**
2021-08-07 20:51:18 +02:00
* @brief A class containing data for one error path item
*/
2017-05-21 08:25:55 +02:00
class QErrorPathItem {
public:
QErrorPathItem() : line(0), column(-1) {}
2020-05-23 07:16:49 +02:00
explicit QErrorPathItem(const ErrorMessage::FileLocation &loc);
2017-05-21 08:25:55 +02:00
QString file;
int line;
int column;
2017-05-21 08:25:55 +02:00
QString info;
};
bool operator==(const QErrorPathItem &i1, const QErrorPathItem &i2);
/**
2021-08-07 20:51:18 +02:00
* @brief A class containing error data for one error.
*
* The paths are stored with internal ("/") separators. Only when we show the
* path or copy if for user (to clipboard) we convert to native separators.
* Full path is stored instead of relative path for flexibility. It is easy
* to get the relative path from full path when needed.
*/
2011-10-13 20:53:06 +02:00
class ErrorItem {
public:
ErrorItem();
2020-05-23 07:16:49 +02:00
explicit ErrorItem(const ErrorMessage &errmsg);
/**
2021-08-07 20:51:18 +02:00
* @brief Convert error item to string.
* @return Error item as string.
*/
2020-07-15 07:59:05 +02:00
QString toString() const;
2017-08-09 20:53:17 +02:00
QString tool() const;
QString file0;
QString errorId;
Severity::SeverityType severity;
bool inconclusive;
QString summary;
QString message;
2017-05-21 08:25:55 +02:00
int cwe;
2020-07-21 11:27:03 +02:00
unsigned long long hash;
2017-05-21 08:25:55 +02:00
QList<QErrorPathItem> errorPath;
QString symbolNames;
// Special GUI properties
QString sinceDate;
QString tags;
2018-10-20 16:30:40 +02:00
/**
* Compare "CID"
*/
static bool sameCID(const ErrorItem &errorItem1, const ErrorItem &errorItem2);
};
// NOLINTNEXTLINE(performance-no-int-to-ptr)
Q_DECLARE_METATYPE(ErrorItem)
/**
2021-08-07 20:51:18 +02:00
* @brief A class containing error data for one shown error line.
*/
2011-10-13 20:53:06 +02:00
class ErrorLine {
public:
QString file;
int line;
2017-05-21 08:25:55 +02:00
QString file0;
QString errorId;
int cwe;
2020-07-21 11:27:03 +02:00
unsigned long long hash;
bool inconclusive;
Severity::SeverityType severity;
QString summary;
QString message;
QString sinceDate;
QString tags;
};
/// @}
#endif // ERRORITEM_H