csdiff --html-output: write the result in HTML format

Suggested-by: Fabio M. Di Nitto
Fixes: https://github.com/kdudka/csdiff/issues/13
Closes: https://github.com/kdudka/csdiff/pull/14

Author: kdudka

abstract-parser.hh

@@ -32,7 +32,8 @@ enum EFileFormat {
     FF_AUTO,                                ///< choose format automatically
     FF_COVERITY,                            ///< what cov-format-errors produces
     FF_GCC,                                 ///< GCC format
-    FF_JSON                                 ///< JSON format
+    FF_JSON,                                ///< JSON format
+    FF_HTML                                 ///< HTML format (output only)
 };
 
 // abstract class with a factory method

abstract-writer.cc

@@ -22,6 +22,7 @@
 #include "cswriter.hh"
 #include "instream.hh"
 #include "json-writer.hh"
+#include "html-writer.hh"
 
 #include <boost/regex.hpp>
 
@@ -74,27 +75,36 @@ void AbstractWriter::setScanProps(const TScanProps &scanProps) {
 }
 
 AbstractWriter* createWriter(
+        std::ostream               &strDst,
         const EFileFormat           format,
         const EColorMode            cm,
         const TScanProps           &scanProps)
 {
     AbstractWriter *writer = 0;
 
     switch (format) {
+        case FF_GCC:
+            // we have no writer for GCC format, fallback to Coverity
+            // fall through!
+
         case FF_INVALID:
         case FF_COVERITY:
-            writer = new CovWriter(std::cout, cm);
+            writer = new CovWriter(strDst, cm);
             break;
 
-        case FF_GCC:
-            // TODO
-
         case FF_AUTO:
             // TODO
 
         case FF_JSON:
-            writer = new JsonWriter(std::cout);
+            writer = new JsonWriter(strDst);
+            break;
+
+        case FF_HTML: {
+            const std::string emp;
+            const std::string spPlacement = "bottom";
+            writer = new HtmlWriter(strDst, emp, emp, spPlacement);
             break;
+        }
     }
 
     if (!scanProps.empty())

abstract-writer.hh

@@ -68,6 +68,7 @@ class AbstractWriter {
 };
 
 AbstractWriter* createWriter(
+        std::ostream               &strDst,
         const EFileFormat           format,
         const EColorMode            cm        = CM_AUTO,
         const TScanProps           &scanProps = TScanProps());

csdiff-core.cc

@@ -54,21 +54,17 @@ bool /* anyError */ diffScans(
     Parser pOld(strOld, fnOld, silent);
     Parser pNew(strNew, fnNew, silent);
 
+    // propagate scan properties if available
+    TScanProps props = pNew.getScanProps();
+    mergeScanProps(props, pOld.getScanProps());
+
     // decide which format use for the output
     if (format == FF_AUTO)
         format = pNew.inputFormat();
 
     // create the appropriate writer
-    boost::shared_ptr<AbstractWriter> writer;
-    if (format == FF_JSON)
-        writer.reset(new JsonWriter(strDst));
-    else
-        writer.reset(new CovWriter(strDst, cm));
-
-    // propagate scan properties if available
-    TScanProps props = pNew.getScanProps();
-    mergeScanProps(props, pOld.getScanProps());
-    writer->setScanProps(props);
+    typedef boost::shared_ptr<AbstractWriter> TWriterPtr;
+    TWriterPtr writer(createWriter(strDst, format, cm, props));
 
     // read old
     DefLookup stor(/* TODO: document this side effect */ showInternal);

csdiff.cc

@@ -49,6 +49,7 @@ int main(int argc, char *argv[])
             ("quiet,q", "do not report any parsing errors")
             ("coverity-output,c", "write the result in Coverity format")
             ("json-output,j", "write the result in JSON format")
+            ("html-output", "write the result in HTML format")
             ("file-rename,s", po::value<TStringList>(),
              "account the file base-name change, [OLD,NEW] (*testing*)");
 
@@ -91,9 +92,10 @@ int main(int argc, char *argv[])
 
     const bool forceCov  = !!vm.count("coverity-output");
     const bool forceJson = !!vm.count("json-output");
-    if (forceCov && forceJson) {
+    const bool useHtml = !!vm.count("html-output");
+    if (1 < static_cast<int>(forceCov) + forceJson + useHtml) {
         std::cerr << name << ": error: options --coverity-output(-c) "
-            "and --json-output(-j) are mutually exclusive\n\n";
+            "--json-output(-j), and --html-output are mutually exclusive\n\n";
         return 1;
     }
 
@@ -102,6 +104,8 @@ int main(int argc, char *argv[])
         format = FF_COVERITY;
     else if (forceJson)
         format = FF_JSON;
+    else if (useHtml)
+        format = FF_HTML;
     else
         format = FF_AUTO;
 

cssort.cc

@@ -49,8 +49,8 @@ class GenericSort: public AbstractWriter {
             std::sort(cont_.begin(), cont_.end());
 
             // use the same output format is the input format
-            AbstractWriter *writer = createWriter(this->inputFormat(), cm_);
-            writer->setScanProps(scanProps_);
+            AbstractWriter *writer =
+                createWriter(std::cout, this->inputFormat(), cm_, scanProps_);
 
             // write the data
             BOOST_FOREACH(const Defect &def, cont_)