cppcheck/gui/xmlreportv2.h

95 lines
2.3 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 XML_REPORTV2_H
#define XML_REPORTV2_H
#include "xmlreport.h"
2022-02-02 16:17:28 +01:00
#include <QString>
class QXmlStreamReader;
class QXmlStreamWriter;
/// @addtogroup GUI
/// @{
/**
2021-08-07 20:51:18 +02:00
* @brief XML file report version 2.
* This report outputs XML-formatted report. The XML format must match command
* line version's XML output.
*/
2011-10-13 20:53:06 +02:00
class XmlReportV2 : public XmlReport {
public:
explicit XmlReportV2(const QString &filename);
~XmlReportV2() 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.
*/
2018-05-15 16:37:40 +02:00
virtual bool create() override;
/**
2021-08-07 20:51:18 +02:00
* @brief Open existing report file.
*/
2018-05-15 16:37:40 +02:00
virtual bool open() 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;
/**
2021-08-07 20:51:18 +02:00
* @brief Read contents of the report file.
*/
2018-05-15 16:37:40 +02:00
virtual QList<ErrorItem> read() override;
protected:
/**
2021-08-07 20:51:18 +02:00
* @brief Read and parse error item from XML stream.
* @param reader XML stream reader to use.
*/
2017-07-28 11:12:05 +02:00
ErrorItem readError(QXmlStreamReader *reader);
private:
/**
2021-08-07 20:51:18 +02:00
* @brief XML stream reader for reading the report in XML format.
*/
QXmlStreamReader *mXmlReader;
/**
2021-08-07 20:51:18 +02:00
* @brief XML stream writer for writing the report in XML format.
*/
QXmlStreamWriter *mXmlWriter;
};
/// @}
#endif // XML_REPORTV2_H