parser-json-shchk: separate module for ShellCheckTreeDecoder

Author: kdudka

src/CMakeLists.txt

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

src/parser-json-shchk.cc

@@ -0,0 +1,84 @@
+/*
+ * 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-shchk.hh"
+
+#include "parser-gcc.hh"            // for GccPostProcessor
+
+struct ShellCheckTreeDecoder::Private {
+    GccPostProcessor            postProc;
+};
+
+ShellCheckTreeDecoder::ShellCheckTreeDecoder():
+    d(new Private)
+{
+}
+
+ShellCheckTreeDecoder::~ShellCheckTreeDecoder() = default;
+
+static bool scReadEvent(DefEvent *pEvt, const pt::ptree &evtNode)
+{
+    using std::string;
+
+    // read level (error, warning, note)
+    string &evtName = pEvt->event;
+    evtName = valueOf<string>(evtNode, "level", "");
+    if (evtName.empty())
+        return false;
+
+    // read location
+    pEvt->fileName = valueOf<string>(evtNode, "file", "<unknown>");
+    pEvt->line     = valueOf<int>   (evtNode, "line", 0);
+    pEvt->column   = valueOf<int>   (evtNode, "byte-column", 0);
+
+    // read message
+    pEvt->msg = valueOf<string>(evtNode, "message", "<unknown>");
+
+    // append [SC...] if available
+    const string code = valueOf<string>(evtNode, "code", "");
+    if (!code.empty())
+        pEvt->msg += " [SC" + code + "]";
+
+    return true;
+}
+
+bool ShellCheckTreeDecoder::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;
+
+    *def = Defect("SHELLCHECK_WARNING");
+
+    // read key event
+    def->events.push_back(DefEvent());
+    if (!scReadEvent(&def->events.back(), defNode))
+        return false;
+
+    // TODO: go through fix/replacements nodes
+
+    // apply post-processing rules
+    d->postProc.apply(def);
+
+    return true;
+}

src/parser-json-shchk.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_SHCHK_H
+#define H_GUARD_PARSER_JSON_SHCHK_H
+
+#include "abstract-tree.hh"
+
+/// tree decoder of the JSON format produced by ShellCheck
+class ShellCheckTreeDecoder: public AbstractTreeDecoder {
+    public:
+        ShellCheckTreeDecoder();
+        ~ShellCheckTreeDecoder() override;
+        bool readNode(Defect *def) override;
+
+    private:
+        struct Private;
+        std::unique_ptr<Private> d;
+};
+
+#endif /* H_GUARD_PARSER_JSON_SHCHK_H */

src/parser-json.cc

@@ -19,24 +19,14 @@
 
 #include "parser-json.hh"
 
-#include "abstract-tree.hh"
-#include "parser-gcc.hh"            // for GccPostProcessor
 #include "parser-json-cov.hh"
 #include "parser-json-gcc.hh"
 #include "parser-json-sarif.hh"
+#include "parser-json-shchk.hh"
 #include "parser-json-simple.hh"
 
 #include <boost/property_tree/json_parser.hpp>
 
-/// tree decoder of the JSON format produced by ShellCheck
-class ShellCheckTreeDecoder: public AbstractTreeDecoder {
-    public:
-        bool readNode(Defect *def) override;
-
-    private:
-        const GccPostProcessor postProc;
-};
-
 struct JsonParser::Private {
     using TDecoderPtr = std::unique_ptr<AbstractTreeDecoder>;
 
@@ -145,54 +135,3 @@ bool JsonParser::getNext(Defect *def)
         }
     }
 }
-
-static bool scReadEvent(DefEvent *pEvt, const pt::ptree &evtNode)
-{
-    using std::string;
-
-    // read level (error, warning, note)
-    string &evtName = pEvt->event;
-    evtName = valueOf<string>(evtNode, "level", "");
-    if (evtName.empty())
-        return false;
-
-    // read location
-    pEvt->fileName = valueOf<string>(evtNode, "file", "<unknown>");
-    pEvt->line     = valueOf<int>   (evtNode, "line", 0);
-    pEvt->column   = valueOf<int>   (evtNode, "byte-column", 0);
-
-    // read message
-    pEvt->msg = valueOf<string>(evtNode, "message", "<unknown>");
-
-    // append [SC...] if available
-    const string code = valueOf<string>(evtNode, "code", "");
-    if (!code.empty())
-        pEvt->msg += " [SC" + code + "]";
-
-    return true;
-}
-
-bool ShellCheckTreeDecoder::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;
-
-    *def = Defect("SHELLCHECK_WARNING");
-
-    // read key event
-    def->events.push_back(DefEvent());
-    if (!scReadEvent(&def->events.back(), defNode))
-        return false;
-
-    // TODO: go through fix/replacements nodes
-
-    // apply post-processing rules
-    this->postProc.apply(def);
-
-    return true;
-}