cppcheck/gui/csvreport.h

73 lines
1.8 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 CSV_REPORT_H
#define CSV_REPORT_H
2022-02-02 16:17:28 +01:00
#include "report.h"
#include <QString>
#include <QTextStream>
/// @addtogroup GUI
/// @{
/**
2021-08-07 20:51:18 +02:00
* @brief CSV text file report.
* This report exports results as CSV (comma separated values). CSV files are
* easy to import to many other programs.
* @todo This class should be inherited from TxtReport?
*/
2011-10-13 20:53:06 +02:00
class CsvReport : public Report {
public:
explicit CsvReport(const QString &filename);
virtual ~CsvReport();
/**
2021-08-07 20:51:18 +02:00
* @brief Create the report (file).
* @return true if succeeded, false if file could not be created.
*/
2018-05-15 16:37:40 +02:00
virtual bool create() override;
/**
2021-08-07 20:51:18 +02:00
* @brief Write report header.
*/
2018-05-15 16:37:40 +02:00
virtual void writeHeader() override;
/**
2021-08-07 20:51:18 +02:00
* @brief Write report footer.
*/
2018-05-15 16:37:40 +02:00
virtual void writeFooter() override;
/**
2021-08-07 20:51:18 +02:00
* @brief Write error to report.
* @param error Error data.
*/
2018-05-15 16:37:40 +02:00
virtual 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 // CSV_REPORT_H