File: erroritem.h

package info (click to toggle)
cppcheck 2.19.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 26,688 kB
  • sloc: cpp: 272,455; python: 22,408; ansic: 8,088; sh: 1,059; makefile: 1,041; xml: 987; cs: 291
file content (122 lines) | stat: -rw-r--r-- 3,316 bytes parent folder | download
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
/* -*- C++ -*-
 * Cppcheck - A tool for static C/C++ code analysis
 * Copyright (C) 2007-2025 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"

#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:
    static QString toString(Severity severity) {
        return QString::fromStdString(severityToString(severity));
    }

    static Severity fromString(const QString &severity) {
        return severityFromString(severity.toStdString());
    }
};

/**
 * @brief A class containing data for one error path item
 */
class QErrorPathItem {
public:
    QErrorPathItem() : line(0), column(-1) {}
    explicit QErrorPathItem(const ErrorMessage::FileLocation &loc);
    QString file;
    int line;
    int column;
    QString info;
};

bool operator==(const QErrorPathItem &i1, const QErrorPathItem &i2);

/**
 * @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.
 */
class ErrorItem {
public:
    ErrorItem();
    explicit ErrorItem(const ErrorMessage &errmsg);

    /**
     * @brief Convert error item to string.
     * @return Error item as string.
     */
    QString toString() const;
    QString tool() const;

    int getMainLocIndex() const {
        return isClangResult() ? 0 : errorPath.size() - 1;
    }

    QString getFile() const {
        return errorPath.isEmpty() ? QString() : errorPath[getMainLocIndex()].file;
    }

    bool isClangResult() const {
        return errorId.startsWith("clang");
    }

    bool filterMatch(const QString& filter) const;

    QString file0;
    QString errorId;
    Severity severity;
    bool inconclusive;
    QString summary;
    QString message;
    int cwe;
    unsigned long long hash;
    QList<QErrorPathItem> errorPath;
    QString symbolNames;
    QString remark;
    QString classification; // misra/cert/etc: classification/level
    QString guideline; // misra/cert/etc: guideline/rule

    // Special GUI properties
    QString sinceDate;
    QString tags;

    /**
     * Compare Hash and fields
     */
    static bool same(const ErrorItem &errorItem1, const ErrorItem &errorItem2);
};
/// @}
#endif // ERRORITEM_H