GUI: Renamed methods in Report

danmar · danmar · commit 0d8b7af2b344 · 2017-07-28T11:12:05.000+02:00
diff --git a/gui/csvreport.cpp b/gui/csvreport.cpp
@@ -32,26 +32,26 @@ CsvReport::~CsvReport()
 {
 }
 
-bool CsvReport::Create()
+bool CsvReport::create()
 {
-    if (Report::Create()) {
-        mTxtWriter.setDevice(Report::GetFile());
+    if (Report::create()) {
+        mTxtWriter.setDevice(Report::getFile());
         return true;
     }
     return false;
 }
 
-void CsvReport::WriteHeader()
+void CsvReport::writeHeader()
 {
     // No header for CSV report
 }
 
-void CsvReport::WriteFooter()
+void CsvReport::writeFooter()
 {
     // No footer for CSV report
 }
 
-void CsvReport::WriteError(const ErrorItem &error)
+void CsvReport::writeError(const ErrorItem &error)
 {
     /*
     Error as CSV line
diff --git a/gui/csvreport.h b/gui/csvreport.h
@@ -42,23 +42,23 @@ class CsvReport : public Report {
     * @brief Create the report (file).
     * @return true if succeeded, false if file could not be created.
     */
-    virtual bool Create();
+    virtual bool create();
 
     /**
     * @brief Write report header.
     */
-    virtual void WriteHeader();
+    virtual void writeHeader();
 
     /**
     * @brief Write report footer.
     */
-    virtual void WriteFooter();
+    virtual void writeFooter();
 
     /**
     * @brief Write error to report.
     * @param error Error data.
     */
-    virtual void WriteError(const ErrorItem &error);
+    virtual void writeError(const ErrorItem &error);
 
 private:
 
diff --git a/gui/printablereport.cpp b/gui/printablereport.cpp
@@ -28,22 +28,22 @@ PrintableReport::~PrintableReport()
 {
 }
 
-bool PrintableReport::Create()
+bool PrintableReport::create()
 {
     return true;
 }
 
-void PrintableReport::WriteHeader()
+void PrintableReport::writeHeader()
 {
     // No header for printable report
 }
 
-void PrintableReport::WriteFooter()
+void PrintableReport::writeFooter()
 {
     // No footer for printable report
 }
 
-void PrintableReport::WriteError(const ErrorItem &error)
+void PrintableReport::writeError(const ErrorItem &error)
 {
     const QString file = QDir::toNativeSeparators(error.errorPath.back().file);
     QString line = QString("%1,%2,").arg(file).arg(error.errorPath.back().line);
@@ -53,7 +53,7 @@ void PrintableReport::WriteError(const ErrorItem &error)
     mFormattedReport += "\n";
 }
 
-QString PrintableReport::GetFormattedReportText() const
+QString PrintableReport::getFormattedReportText() const
 {
     return mFormattedReport;
 }
diff --git a/gui/printablereport.h b/gui/printablereport.h
@@ -38,28 +38,28 @@ class PrintableReport : public Report {
     * @brief Create the report (file).
     * @return true if succeeded, false if file could not be created.
     */
-    virtual bool Create();
+    virtual bool create();
 
     /**
     * @brief Write report header.
     */
-    virtual void WriteHeader();
+    virtual void writeHeader();
 
     /**
     * @brief Write report footer.
     */
-    virtual void WriteFooter();
+    virtual void writeFooter();
 
     /**
     * @brief Write error to report.
     * @param error Error data.
     */
-    virtual void WriteError(const ErrorItem &error);
+    virtual void writeError(const ErrorItem &error);
 
     /**
     * @brief Returns the formatted report.
     */
-    QString GetFormattedReportText() const;
+    QString getFormattedReportText() const;
 
 private:
 
diff --git a/gui/report.cpp b/gui/report.cpp
@@ -16,22 +16,22 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include <QObject>
 #include <QString>
 #include <QFile>
 #include "report.h"
 
 Report::Report(const QString &filename) :
+    QObject(),
     mFilename(filename)
 {
 }
 
 Report::~Report()
 {
-    Close();
+    close();
 }
 
-bool Report::Create()
+bool Report::create()
 {
     bool succeed = false;
     if (!mFile.isOpen()) {
@@ -41,7 +41,7 @@ bool Report::Create()
     return succeed;
 }
 
-bool Report::Open()
+bool Report::open()
 {
     bool succeed = false;
     if (!mFile.isOpen()) {
@@ -51,13 +51,13 @@ bool Report::Open()
     return succeed;
 }
 
-void Report::Close()
+void Report::close()
 {
     if (mFile.isOpen())
         mFile.close();
 }
 
-QFile* Report::GetFile()
+QFile* Report::getFile()
 {
     return &mFile;
 }
diff --git a/gui/report.h b/gui/report.h
@@ -47,41 +47,41 @@ class Report : public QObject {
     * @brief Create the report (file).
     * @return true if succeeded, false if file could not be created.
     */
-    virtual bool Create();
+    virtual bool create();
 
     /**
     * @brief Open the existing report (file).
     * @return true if succeeded, false if file could not be created.
     */
-    virtual bool Open();
+    virtual bool open();
 
     /**
     * @brief Close the report (file).
     */
-    virtual void Close();
+    virtual void close();
 
     /**
     * @brief Write report header.
     */
-    virtual void WriteHeader() = 0;
+    virtual void writeHeader() = 0;
 
     /**
     * @brief Write report footer.
     */
-    virtual void WriteFooter() = 0;
+    virtual void writeFooter() = 0;
 
     /**
     * @brief Write error to report.
     * @param error Error data.
     */
-    virtual void WriteError(const ErrorItem &error) = 0;
+    virtual void writeError(const ErrorItem &error) = 0;
 
 protected:
 
     /**
     * @brief Get the file object where the report is written to.
     */
-    QFile* GetFile();
+    QFile* getFile();
 
 private:
 
diff --git a/gui/resultstree.cpp b/gui/resultstree.cpp
@@ -964,15 +964,15 @@ QString ResultsTree::SeverityToIcon(Severity::SeverityType severity) const
 
 void ResultsTree::SaveResults(Report *report) const
 {
-    report->WriteHeader();
+    report->writeHeader();
 
     for (int i = 0; i < mModel.rowCount(); i++) {
         QStandardItem *item = mModel.item(i, 0);
         if (!isRowHidden(i, QModelIndex()))
             SaveErrors(report, item);
     }
 
-    report->WriteFooter();
+    report->writeFooter();
 }
 
 void ResultsTree::SaveErrors(Report *report, QStandardItem *item) const
@@ -1027,7 +1027,7 @@ void ResultsTree::SaveErrors(Report *report, QStandardItem *item) const
             item.errorPath << e;
         }
 
-        report->WriteError(item);
+        report->writeError(item);
     }
 }
 
diff --git a/gui/resultsview.cpp b/gui/resultsview.cpp
@@ -162,7 +162,7 @@ void ResultsView::Save(const QString &filename, Report::Type type) const
     }
 
     if (report) {
-        if (report->Create())
+        if (report->create())
             mUI.mTree->SaveResults(report);
         else {
             QMessageBox msgBox;
@@ -211,7 +211,7 @@ void ResultsView::Print(QPrinter* printer)
 
     PrintableReport report;
     mUI.mTree->SaveResults(&report);
-    QTextDocument doc(report.GetFormattedReportText());
+    QTextDocument doc(report.getFormattedReportText());
     doc.print(printer);
 }
 
@@ -322,8 +322,8 @@ void ResultsView::ReadErrorsXml(const QString &filename)
 
     QList<ErrorItem> errors;
     if (report) {
-        if (report->Open())
-            errors = report->Read();
+        if (report->open())
+            errors = report->read();
         else {
             QMessageBox msgBox;
             msgBox.setText(tr("Failed to read the report."));
diff --git a/gui/txtreport.cpp b/gui/txtreport.cpp
@@ -28,26 +28,26 @@ TxtReport::~TxtReport()
 {
 }
 
-bool TxtReport::Create()
+bool TxtReport::create()
 {
-    if (Report::Create()) {
-        mTxtWriter.setDevice(Report::GetFile());
+    if (Report::create()) {
+        mTxtWriter.setDevice(Report::getFile());
         return true;
     }
     return false;
 }
 
-void TxtReport::WriteHeader()
+void TxtReport::writeHeader()
 {
     // No header for txt report
 }
 
-void TxtReport::WriteFooter()
+void TxtReport::writeFooter()
 {
     // No footer for txt report
 }
 
-void TxtReport::WriteError(const ErrorItem &error)
+void TxtReport::writeError(const ErrorItem &error)
 {
     /*
     Error example from the core program in text
diff --git a/gui/txtreport.h b/gui/txtreport.h
@@ -42,23 +42,23 @@ class TxtReport : public Report {
     * @brief Create the report (file).
     * @return true if succeeded, false if file could not be created.
     */
-    virtual bool Create();
+    virtual bool create();
 
     /**
     * @brief Write report header.
     */
-    virtual void WriteHeader();
+    virtual void writeHeader();
 
     /**
     * @brief Write report footer.
     */
-    virtual void WriteFooter();
+    virtual void writeFooter();
 
     /**
     * @brief Write error to report.
     * @param error Error data.
     */
-    virtual void WriteError(const ErrorItem &error);
+    virtual void writeError(const ErrorItem &error);
 
 private:
 
diff --git a/gui/xmlreport.h b/gui/xmlreport.h
@@ -40,7 +40,7 @@ class XmlReport : public Report {
     /**
      * @brief Read contents of the report file.
      */
-    virtual QList<ErrorItem> Read() = 0;
+    virtual QList<ErrorItem> read() = 0;
 
     /**
      * @brief Quote the message.
diff --git a/gui/xmlreportv1.cpp b/gui/xmlreportv1.cpp
diff --git a/gui/xmlreportv1.h b/gui/xmlreportv1.h
diff --git a/gui/xmlreportv2.cpp b/gui/xmlreportv2.cpp
diff --git a/gui/xmlreportv2.h b/gui/xmlreportv2.h

Original file line number	Diff line number	Diff line change
`@@ -32,26 +32,26 @@ CsvReport::~CsvReport()`
`32`	`32`	`{`
`33`	`33`	`}`
`34`	`34`
`35`		`-bool CsvReport::Create()`
	`35`	`+bool CsvReport::create()`
`36`	`36`	`{`
`37`		`- if (Report::Create()) {`
`38`		`- mTxtWriter.setDevice(Report::GetFile());`
	`37`	`+ if (Report::create()) {`
	`38`	`+ mTxtWriter.setDevice(Report::getFile());`
`39`	`39`	`return true;`
`40`	`40`	`}`
`41`	`41`	`return false;`
`42`	`42`	`}`
`43`	`43`
`44`		`-void CsvReport::WriteHeader()`
	`44`	`+void CsvReport::writeHeader()`
`45`	`45`	`{`
`46`	`46`	`// No header for CSV report`
`47`	`47`	`}`
`48`	`48`
`49`		`-void CsvReport::WriteFooter()`
	`49`	`+void CsvReport::writeFooter()`
`50`	`50`	`{`
`51`	`51`	`// No footer for CSV report`
`52`	`52`	`}`
`53`	`53`
`54`		`-void CsvReport::WriteError(const ErrorItem &error)`
	`54`	`+void CsvReport::writeError(const ErrorItem &error)`
`55`	`55`	`{`
`56`	`56`	`/*`
`57`	`57`	`Error as CSV line`
Original file line number	Diff line number	Diff line change
`@@ -28,22 +28,22 @@ PrintableReport::~PrintableReport()`
`28`	`28`	`{`
`29`	`29`	`}`
`30`	`30`
`31`		`-bool PrintableReport::Create()`
	`31`	`+bool PrintableReport::create()`
`32`	`32`	`{`
`33`	`33`	`return true;`
`34`	`34`	`}`
`35`	`35`
`36`		`-void PrintableReport::WriteHeader()`
	`36`	`+void PrintableReport::writeHeader()`
`37`	`37`	`{`
`38`	`38`	`// No header for printable report`
`39`	`39`	`}`
`40`	`40`
`41`		`-void PrintableReport::WriteFooter()`
	`41`	`+void PrintableReport::writeFooter()`
`42`	`42`	`{`
`43`	`43`	`// No footer for printable report`
`44`	`44`	`}`
`45`	`45`
`46`		`-void PrintableReport::WriteError(const ErrorItem &error)`
	`46`	`+void PrintableReport::writeError(const ErrorItem &error)`
`47`	`47`	`{`
`48`	`48`	`const QString file = QDir::toNativeSeparators(error.errorPath.back().file);`
`49`	`49`	`QString line = QString("%1,%2,").arg(file).arg(error.errorPath.back().line);`
`@@ -53,7 +53,7 @@ void PrintableReport::WriteError(const ErrorItem &error)`
`53`	`53`	`mFormattedReport += "\n";`
`54`	`54`	`}`
`55`	`55`
`56`		`-QString PrintableReport::GetFormattedReportText() const`
	`56`	`+QString PrintableReport::getFormattedReportText() const`
`57`	`57`	`{`
`58`	`58`	`return mFormattedReport;`
`59`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,22 +16,22 @@`
`16`	`16`	`* along with this program. If not, see <http://www.gnu.org/licenses/>.`
`17`	`17`	`*/`
`18`	`18`
`19`		`-#include <QObject>`
`20`	`19`	`#include <QString>`
`21`	`20`	`#include <QFile>`
`22`	`21`	`#include "report.h"`
`23`	`22`
`24`	`23`	`Report::Report(const QString &filename) :`
	`24`	`+ QObject(),`
`25`	`25`	`mFilename(filename)`
`26`	`26`	`{`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`Report::~Report()`
`30`	`30`	`{`
`31`		`- Close();`
	`31`	`+ close();`
`32`	`32`	`}`
`33`	`33`
`34`		`-bool Report::Create()`
	`34`	`+bool Report::create()`
`35`	`35`	`{`
`36`	`36`	`bool succeed = false;`
`37`	`37`	`if (!mFile.isOpen()) {`
`@@ -41,7 +41,7 @@ bool Report::Create()`
`41`	`41`	`return succeed;`
`42`	`42`	`}`
`43`	`43`
`44`		`-bool Report::Open()`
	`44`	`+bool Report::open()`
`45`	`45`	`{`
`46`	`46`	`bool succeed = false;`
`47`	`47`	`if (!mFile.isOpen()) {`
`@@ -51,13 +51,13 @@ bool Report::Open()`
`51`	`51`	`return succeed;`
`52`	`52`	`}`
`53`	`53`
`54`		`-void Report::Close()`
	`54`	`+void Report::close()`
`55`	`55`	`{`
`56`	`56`	`if (mFile.isOpen())`
`57`	`57`	`mFile.close();`
`58`	`58`	`}`
`59`	`59`
`60`		`-QFile* Report::GetFile()`
	`60`	`+QFile* Report::getFile()`
`61`	`61`	`{`
`62`	`62`	`return &mFile;`
`63`	`63`	`}`
Original file line number	Diff line number	Diff line change
`@@ -964,15 +964,15 @@ QString ResultsTree::SeverityToIcon(Severity::SeverityType severity) const`
`964`	`964`
`965`	`965`	`void ResultsTree::SaveResults(Report *report) const`
`966`	`966`	`{`
`967`		`- report->WriteHeader();`
	`967`	`+ report->writeHeader();`
`968`	`968`
`969`	`969`	`for (int i = 0; i < mModel.rowCount(); i++) {`
`970`	`970`	`QStandardItem *item = mModel.item(i, 0);`
`971`	`971`	`if (!isRowHidden(i, QModelIndex()))`
`972`	`972`	`SaveErrors(report, item);`
`973`	`973`	`}`
`974`	`974`
`975`		`- report->WriteFooter();`
	`975`	`+ report->writeFooter();`
`976`	`976`	`}`
`977`	`977`
`978`	`978`	`void ResultsTree::SaveErrors(Report report, QStandardItem item) const`
`@@ -1027,7 +1027,7 @@ void ResultsTree::SaveErrors(Report report, QStandardItem item) const`
`1027`	`1027`	`item.errorPath << e;`
`1028`	`1028`	`}`
`1029`	`1029`
`1030`		`- report->WriteError(item);`
	`1030`	`+ report->writeError(item);`
`1031`	`1031`	`}`
`1032`	`1032`	`}`
`1033`	`1033`
Original file line number	Diff line number	Diff line change
`@@ -28,26 +28,26 @@ TxtReport::~TxtReport()`
`28`	`28`	`{`
`29`	`29`	`}`
`30`	`30`
`31`		`-bool TxtReport::Create()`
	`31`	`+bool TxtReport::create()`
`32`	`32`	`{`
`33`		`- if (Report::Create()) {`
`34`		`- mTxtWriter.setDevice(Report::GetFile());`
	`33`	`+ if (Report::create()) {`
	`34`	`+ mTxtWriter.setDevice(Report::getFile());`
`35`	`35`	`return true;`
`36`	`36`	`}`
`37`	`37`	`return false;`
`38`	`38`	`}`
`39`	`39`
`40`		`-void TxtReport::WriteHeader()`
	`40`	`+void TxtReport::writeHeader()`
`41`	`41`	`{`
`42`	`42`	`// No header for txt report`
`43`	`43`	`}`
`44`	`44`
`45`		`-void TxtReport::WriteFooter()`
	`45`	`+void TxtReport::writeFooter()`
`46`	`46`	`{`
`47`	`47`	`// No footer for txt report`
`48`	`48`	`}`
`49`	`49`
`50`		`-void TxtReport::WriteError(const ErrorItem &error)`
	`50`	`+void TxtReport::writeError(const ErrorItem &error)`
`51`	`51`	`{`
`52`	`52`	`/*`
`53`	`53`	`Error example from the core program in text`