cppcheck/gui/txtreport.h

76 lines
1.7 KiB
C
Raw Normal View History

/*
* Cppcheck - A tool for static C/C++ code analysis
2023-06-21 16:41:22 +02:00
* Copyright (C) 2007-2023 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 TXT_REPORT_H
#define TXT_REPORT_H
2022-02-02 16:17:28 +01:00
#include "report.h"
#include <QString>
#include <QObject>
#include <QTextStream>
class ErrorItem;
/// @addtogroup GUI
/// @{
/**
2021-08-07 20:51:18 +02:00
* @brief Text file report.
* This report mimics the output of the command line cppcheck.
*/
2011-10-13 20:53:06 +02:00
class TxtReport : public Report {
2011-06-15 10:28:47 +02:00
Q_OBJECT
public:
explicit TxtReport(const QString &filename);
~TxtReport() override;
/**
2021-08-07 20:51:18 +02:00
* @brief Create the report (file).
* @return true if succeeded, false if file could not be created.
*/
bool create() override;
/**
2021-08-07 20:51:18 +02:00
* @brief Write report header.
*/
void writeHeader() override;
/**
2021-08-07 20:51:18 +02:00
* @brief Write report footer.
*/
void writeFooter() override;
/**
2021-08-07 20:51:18 +02:00
* @brief Write error to report.
* @param error Error data.
*/
void writeError(const ErrorItem &error) override;
private:
/**
2021-08-07 20:51:18 +02:00
* @brief Text stream writer for writing the report in text format.
*/
QTextStream mTxtWriter;
};
/// @}
#endif // TXT_REPORT_H