parser-json-cov: separate module for CovTreeDecoder

Author: kdudka

src/CMakeLists.txt

@@ -76,6 +76,7 @@ add_library(cs STATIC
     parser-cov.cc
     parser-gcc.cc
     parser-json.cc
+    parser-json-cov.cc
     parser-json-simple.cc
     parser-xml.cc
     shared-string.cc

src/parser-json-cov.cc

@@ -0,0 +1,86 @@
+/*
+ * Copyright (C) 2012-2022 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 "parser-json-cov.hh"
+
+#include "parser-cov.hh"            // for KeyEventDigger
+
+struct CovTreeDecoder::Private {
+    KeyEventDigger              keDigger;
+};
+
+CovTreeDecoder::CovTreeDecoder():
+    d(new Private)
+{
+}
+
+CovTreeDecoder::~CovTreeDecoder() = default;
+
+bool CovTreeDecoder::readNode(Defect *def)
+{
+    // move the iterator after we get the current position
+    const pt::ptree *pNode = this->nextNode();
+    if (!pNode)
+        // failed initialization or EOF
+        return false;
+
+    const pt::ptree &defNode = *pNode;
+
+    // read per-defect properties
+    def->checker = defNode.get<std::string>("checkerName");
+    def->function = valueOf<std::string>(defNode, "functionDisplayName", "");
+    def->language = valueOf<std::string>(defNode, "code-language", "");
+
+    // out of the supported tools, only Coverity produces this data format
+    def->tool = "coverity";
+
+    // read CWE if available
+    const pt::ptree *checkerProps;
+    if (findChildOf(&checkerProps, defNode, "checkerProperties"))
+        def->cwe = valueOf<int>(*checkerProps, "cweCategory", 0);
+
+    // count the events and allocate dst array
+    const pt::ptree &evtList = defNode.get_child("events");
+    def->events.resize(evtList.size());
+
+    // decode events one by one
+    unsigned idx = 0;
+    pt::ptree::const_iterator it;
+    for (it = evtList.begin(); it != evtList.end(); ++it, ++idx) {
+        const pt::ptree &evtNode = it->second;
+        DefEvent &evt = def->events[idx];
+
+        evt.fileName    = valueOf<std::string>(evtNode, "filePathname"    , "");
+        evt.line        = valueOf<int>        (evtNode, "lineNumber"      , 0 );
+        // TODO: read column?
+        evt.event       = valueOf<std::string>(evtNode, "eventTag"        , "");
+        evt.msg         = valueOf<std::string>(evtNode, "eventDescription", "");
+
+        if (evtNode.get<bool>("main"))
+            // this is a key event
+            // TODO: detect and report re-definitions of key events
+            def->keyEventIdx = idx;
+    }
+
+    // initialize verbosity level of all events
+    d->keDigger.initVerbosity(def);
+
+    return true;
+}
+

src/parser-json-cov.hh

@@ -0,0 +1,37 @@
+/*
+ * Copyright (C) 2012-2022 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_PARSER_JSON_COV_H
+#define H_GUARD_PARSER_JSON_COV_H
+
+#include "abstract-tree.hh"
+
+/// tree decoder of the Coverity JSON format
+class CovTreeDecoder: public AbstractTreeDecoder {
+    public:
+        CovTreeDecoder();
+        ~CovTreeDecoder() override;
+        bool readNode(Defect *def) override;
+
+    private:
+        struct Private;
+        std::unique_ptr<Private> d;
+};
+
+#endif /* H_GUARD_PARSER_JSON_COV_H */

src/parser-json.cc

@@ -21,23 +21,14 @@
 
 #include "abstract-tree.hh"
 #include "parser-common.hh"
-#include "parser-cov.hh"            // for KeyEventDigger
 #include "parser-gcc.hh"            // for GccPostProcessor
+#include "parser-json-cov.hh"
 #include "parser-json-simple.hh"
 #include "regex.hh"
 
 #include <boost/algorithm/string/predicate.hpp>
 #include <boost/property_tree/json_parser.hpp>
 
-/// tree decoder of the Coverity JSON format
-class CovTreeDecoder: public AbstractTreeDecoder {
-    public:
-        bool readNode(Defect *def) override;
-
-    private:
-        KeyEventDigger              keDigger;
-};
-
 /// tree decoder of the SARIF format
 class SarifTreeDecoder: public AbstractTreeDecoder {
     public:
@@ -192,58 +183,6 @@ bool JsonParser::getNext(Defect *def)
     }
 }
 
-bool CovTreeDecoder::readNode(Defect *def)
-{
-    // move the iterator after we get the current position
-    const pt::ptree *pNode = this->nextNode();
-    if (!pNode)
-        // failed initialization or EOF
-        return false;
-
-    const pt::ptree &defNode = *pNode;
-
-    // read per-defect properties
-    def->checker = defNode.get<std::string>("checkerName");
-    def->function = valueOf<std::string>(defNode, "functionDisplayName", "");
-    def->language = valueOf<std::string>(defNode, "code-language", "");
-
-    // out of the supported tools, only Coverity produces this data format
-    def->tool = "coverity";
-
-    // read CWE if available
-    const pt::ptree *checkerProps;
-    if (findChildOf(&checkerProps, defNode, "checkerProperties"))
-        def->cwe = valueOf<int>(*checkerProps, "cweCategory", 0);
-
-    // count the events and allocate dst array
-    const pt::ptree &evtList = defNode.get_child("events");
-    def->events.resize(evtList.size());
-
-    // decode events one by one
-    unsigned idx = 0;
-    pt::ptree::const_iterator it;
-    for (it = evtList.begin(); it != evtList.end(); ++it, ++idx) {
-        const pt::ptree &evtNode = it->second;
-        DefEvent &evt = def->events[idx];
-
-        evt.fileName    = valueOf<std::string>(evtNode, "filePathname"    , "");
-        evt.line        = valueOf<int>        (evtNode, "lineNumber"      , 0 );
-        // TODO: read column?
-        evt.event       = valueOf<std::string>(evtNode, "eventTag"        , "");
-        evt.msg         = valueOf<std::string>(evtNode, "eventDescription", "");
-
-        if (evtNode.get<bool>("main"))
-            // this is a key event
-            // TODO: detect and report re-definitions of key events
-            def->keyEventIdx = idx;
-    }
-
-    // initialize verbosity level of all events
-    this->keDigger.initVerbosity(def);
-
-    return true;
-}
-
 void SarifTreeDecoder::updateCweMap(const pt::ptree *driverNode)
 {
     const pt::ptree *rules;