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
|
/* -*- C++ -*-
* Cppcheck - A tool for static C/C++ code analysis
* Copyright (C) 2007-2024 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 REPORT_H
#define REPORT_H
#include <cstdint>
#include <QFile>
#include <QObject>
#include <QString>
class ErrorItem;
/// @addtogroup GUI
/// @{
/**
* @brief A base class for reports.
*/
class Report : public QObject {
public:
enum Type : std::uint8_t {
TXT,
XMLV2,
CSV,
};
explicit Report(QString filename);
~Report() override;
/**
* @brief Create the report (file).
* @return true if succeeded, false if file could not be created.
*/
virtual bool create();
/**
* @brief Open the existing report (file).
* @return true if succeeded, false if file could not be created.
*/
virtual bool open();
/**
* @brief Close the report (file).
*/
void close();
/**
* @brief Write report header.
*/
virtual void writeHeader() = 0;
/**
* @brief Write report footer.
*/
virtual void writeFooter() = 0;
/**
* @brief Write error to report.
* @param error Error data.
*/
virtual void writeError(const ErrorItem &error) = 0;
protected:
/**
* @brief Get the file object where the report is written to.
*/
QFile* getFile();
private:
/**
* @brief Filename of the report.
*/
QString mFilename;
/**
* @brief Fileobject for the report file.
*/
QFile mFile;
};
/// @}
#endif // REPORT_H
|
