csv-parser: new class AbstractCsvParser

... that contains reusable code for CVS parsing taken from CweMapper

No changes in behavior intended by this commit.

Author: kdudka

src/CMakeLists.txt

@@ -26,6 +26,7 @@ add_library(cs STATIC
     csdiff-core.cc
     csfilter.cc
     csparser.cc
+    csv-parser.cc
     cswriter.cc
     cwe-mapper.cc
     deflookup.cc

src/cslinker.cc

@@ -234,7 +234,7 @@ int main(int argc, char *argv[])
         try {
             // load CWE mapping from the given file
             InStream strCwe(fnCwe);
-            if (!cweDec->cweMap().loadCweMap(strCwe.str(), fnCwe))
+            if (!cweDec->cweMap().parse(strCwe))
                 hasError = true;
         }
         catch (const InFileException &e) {

src/csv-parser.cc

@@ -0,0 +1,80 @@
+/*
+ * Copyright (C) 2020 Red Hat, Inc.
+ *
+ * This file is part of csdiff.
+ *
+ * csdiff 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
+ * any later version.
+ *
+ * csdiff 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 csdiff.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "csv-parser.hh"
+
+#include <boost/tokenizer.hpp>
+
+#include <cassert>
+
+struct AbstractCsvParser::Private {
+    const std::string      *pFileName   = nullptr;
+    int                     lineno      = 0;
+    bool                    silent      = false;
+    bool                    hasError    = false;
+};
+
+AbstractCsvParser::AbstractCsvParser():
+    d(new Private)
+{
+}
+
+AbstractCsvParser::~AbstractCsvParser()
+{
+    delete d;
+}
+
+bool AbstractCsvParser::parse(InStream &ins)
+{
+    assert(!d->pFileName);
+    d->pFileName = &ins.fileName();
+    d->hasError = false;
+
+    std::istream &str = ins.str();
+    std::string line;
+    for (d->lineno = 0; std::getline(str, line); d->lineno++) {
+        // initialize tokenizer
+        typedef boost::escaped_list_separator<char>     TSeparator;
+        typedef boost::tokenizer<TSeparator>            TTokenizer;
+        TTokenizer tok(line);
+
+        // break the current line into fields
+        const TStringList fields(tok.begin(), tok.end());
+
+        // call the template method
+        if (!/* continue */this->handleLine(fields))
+            break;
+    }
+
+    d->pFileName = nullptr;
+    return !d->hasError;
+}
+
+void AbstractCsvParser::parseError(const std::string &msg)
+{
+    assert(d->pFileName);
+    d->hasError = true;
+    if (d->silent)
+        return;
+
+    std::cerr
+        << *(d->pFileName) << ":"
+        << d->lineno << ": error: "
+        << msg << "\n";
+}

src/csv-parser.hh

@@ -0,0 +1,51 @@
+/*
+ * Copyright (C) 2020 Red Hat, Inc.
+ *
+ * This file is part of csdiff.
+ *
+ * csdiff 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
+ * any later version.
+ *
+ * csdiff 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 csdiff.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef H_GUARD_CSV_PARSER_H
+#define H_GUARD_CSV_PARSER_H
+
+#include "instream.hh"
+
+#include <vector>
+#include <string>
+
+class AbstractCsvParser {
+    public:
+        AbstractCsvParser();
+        virtual ~AbstractCsvParser();
+        bool parse(InStream &str);
+
+        void setSilent(const bool silent) {
+            this->silent = silent;
+        }
+
+    protected:
+        typedef std::vector<std::string> TStringList;
+
+        virtual bool /* continue */ handleLine(const TStringList &) = 0;
+        void parseError(const std::string &msg);
+
+        bool silent;
+
+    private:
+        struct Private;
+        Private *d;
+};
+
+#endif /* H_GUARD_CSV_PARSER_H */

src/cwe-mapper.cc

@@ -21,30 +21,18 @@
 
 #include <cstdio>
 
-#include <boost/tokenizer.hpp>
-
 // /////////////////////////////////////////////////////////////////////////////
 // implementation of CweMap
 struct CweMap::Private {
     typedef std::map<std::string, int>              TNumByEvent;
     typedef std::map<std::string, TNumByEvent>      TMapByChk;
 
-    std::string         fileName;
-    std::string         line;
-    int                 lineno;
-    bool                silent;
-    bool                hasError;
     TMapByChk           mapByChk;
-
-    void parseError(const std::string &msg);
-    void parseLine();
 };
 
 CweMap::CweMap():
     d(new Private)
 {
-    d->silent = false;
-    d->hasError = false;
 }
 
 CweMap::~CweMap()
@@ -57,35 +45,11 @@ bool CweMap::empty() const
     return d->mapByChk.empty();
 }
 
-void CweMap::setSilent(bool silent)
-{
-    d->silent = silent;
-}
-
-void CweMap::Private::parseError(const std::string &msg)
-{
-    this->hasError = true;
-    if (this->silent)
-        return;
-    std::cerr
-        << this->fileName << ":"
-        << this->lineno << ": error: "
-        << msg << "\n";
-}
-
-void CweMap::Private::parseLine()
+bool CweMap::handleLine(const TStringList &fields)
 {
-    // initialize tokenizer
-    typedef boost::escaped_list_separator<char>     TSeparator;
-    typedef boost::tokenizer<TSeparator>            TTokenizer;
-    TTokenizer tok(this->line);
-
-    // break the current line into fields
-    typedef std::vector<std::string>                TStringList;
-    TStringList fields(tok.begin(), tok.end());
     if (3U != fields.size()) {
         this->parseError("invalid count of fields");
-        return;
+        return /* continue */ true;
     }
 
     // parse CWE number
@@ -94,12 +58,12 @@ void CweMap::Private::parseLine()
     if (1 != sscanf(fields[/* CWE */ 2].c_str(), "CWE-%u%c", &cwe, &c) || !cwe)
     {
         this->parseError("invalid CWE ID");
-        return;
+        return /* continue */ true;
     }
 
     // lookup by checker
     const std::string &chk = fields[/* chk */ 0];
-    TNumByEvent &row = this->mapByChk[chk];
+    Private::TNumByEvent &row = d->mapByChk[chk];
 
     // lookup by event
     const std::string &evt = fields[/* evt */ 1];
@@ -108,19 +72,8 @@ void CweMap::Private::parseLine()
 
     // store the mapping
     row[evt] = cwe;
-}
-
-bool CweMap::loadCweMap(std::istream &str, const std::string &fileName)
-{
-    d->fileName = fileName;
-    d->lineno = 0;
-
-    while (std::getline(str, d->line)) {
-        d->lineno++;
-        d->parseLine();
-    }
 
-    return !d->hasError;
+    return /* continue */ true;
 }
 
 bool CweMap::assignCwe(Defect &def) const
@@ -134,7 +87,7 @@ bool CweMap::assignCwe(Defect &def) const
             // CWE already assigned, stay silent
             return true;
 
-        if (!d->silent)
+        if (!this->silent)
             std::cerr << "warning: CWE not found: checker = "
                 << def.checker <<"\n";
         return false;
@@ -149,7 +102,7 @@ bool CweMap::assignCwe(Defect &def) const
             // CWE already assigned, stay silent
             return true;
 
-        if (!d->silent)
+        if (!this->silent)
             std::cerr << "warning: CWE not found: checker = " << def.checker
                 << ", event = " << evt.event << "\n";
 
@@ -167,7 +120,7 @@ bool CweMap::assignCwe(Defect &def) const
         // already assigned to the requested value
         return true;
 
-    if (cweDst && !d->silent)
+    if (cweDst && !this->silent)
         // we are rewriting the CWE
         std::cerr << "warning: CWE overriden: "
             << cweSrc << " -> "

src/cwe-mapper.hh

@@ -21,18 +21,20 @@
 #define H_GUARD_CWE_MAPPER_H
 
 #include "abstract-filter.hh"
+#include "csv-parser.hh"
 
 #include <iostream>
 
-class CweMap {
+class CweMap: public AbstractCsvParser {
     public:
         CweMap();
         ~CweMap();
 
-        bool loadCweMap(std::istream &, const std::string &fileName);
         bool assignCwe(Defect &def) const;
         bool empty() const;
-        void setSilent(bool);
+
+    protected:
+        virtual bool /* continue */ handleLine(const TStringList &);
 
     private:
         struct Private;