Added output of diagnostics in json format

Author: cmaglie

ArduinoDiagnosticConsumer.cpp

@@ -27,13 +27,22 @@
  * the GNU General Public License.
  */
 
+#include <clang/Basic/Diagnostic.h>
+
 #include "ArduinoDiagnosticConsumer.h"
 #include "CommandLine.h"
+#include "JsonImpl.hpp"
+
+using namespace clang;
 
 void ArduinoDiagnosticConsumer::collectUndeclaredIdentifiersIn(IdentifiersList &list) {
     undeclaredIdentifiersList = &list;
 }
 
+void ArduinoDiagnosticConsumer::outputJsonDiagnosticsTo(ostream &out) {
+    jsonDiagnosticOutput = &out;
+}
+
 void ArduinoDiagnosticConsumer::HandleDiagnostic(DiagnosticsEngine::Level level, const Diagnostic& info) {
     // DiagnosticConsumer::HandleDiagnostic(level, info);
 
@@ -68,6 +77,21 @@ void ArduinoDiagnosticConsumer::HandleDiagnostic(DiagnosticsEngine::Level level,
 
     }
 
+    if (jsonDiagnosticOutput) {
+        const SourceManager &sm = info.getSourceManager();
+
+        SmallString<100> message;
+        info.FormatDiagnostic(message);
+
+        json data = json{
+            {"location", encode(sm, info.getLocation())},
+            {"message", encode(message)},
+            {"ranges", encode(sm, info.getRanges())},
+            {"hints", encode(sm, info.getFixItHints())},
+        };
+        *jsonDiagnosticOutput << data.dump() << "\n";
+    }
+
     if (debugOutput) {
         SmallString<100> outStr;
         info.FormatDiagnostic(outStr);

ArduinoDiagnosticConsumer.h

@@ -41,8 +41,11 @@ class ArduinoDiagnosticConsumer : public DiagnosticConsumer {
 
     void collectUndeclaredIdentifiersIn(IdentifiersList &list);
 
+    void outputJsonDiagnosticsTo(ostream &out);
+
 private:
     IdentifiersList *undeclaredIdentifiersList = nullptr;
+    ostream *jsonDiagnosticOutput = nullptr;
 
     void HandleDiagnostic(DiagnosticsEngine::Level level, const Diagnostic& info) override;
 };

CommandLine.cpp

@@ -35,6 +35,7 @@
 using namespace std;
 
 bool debugOutput;
+bool outputDiagnostics;
 bool outputOnlyNeededPrototypes;
 
 static cl::OptionCategory arduinoToolCategory("Arduino options");
@@ -46,6 +47,7 @@ static cl::extrahelp arduinoHelp("\n"
 static cl::extrahelp commonHelp(CommonOptionsParser::HelpMessage);
 static cl::opt<bool> debugOutputOpt("debug");
 static cl::opt<bool> outputOnlyNeededPrototypesOpt("output-only-needed-prototypes");
+static cl::opt<bool> outputDiagnosticsOpt("diagnostics");
 
 static void printVersion() {
     cout << "Arduino (https://www.arduino.cc/):\n";
@@ -61,12 +63,17 @@ CommonOptionsParser doCommandLineParsing(int argc, const char **argv) {
     outputOnlyNeededPrototypesOpt.setInitialValue(false);
     outputOnlyNeededPrototypesOpt.setDescription("Output a prototype only if a forward declaration is needed (experimental)");
 
+    outputDiagnosticsOpt.setCategory(arduinoToolCategory);
+    outputDiagnosticsOpt.setInitialValue(false);
+    outputDiagnosticsOpt.setDescription("Output diagnostics (warnings/errors) in json format");
+
     cl::AddExtraVersionPrinter(printVersion);
 
     CommonOptionsParser optParser(argc, argv, arduinoToolCategory);
 
     debugOutput = debugOutputOpt.getValue();
     outputOnlyNeededPrototypes = outputOnlyNeededPrototypesOpt.getValue();
+    outputDiagnostics = outputDiagnosticsOpt.getValue();
 
     return optParser;
 }

CommandLine.h

@@ -38,5 +38,6 @@ using namespace llvm;
 
 extern bool debugOutput;
 extern bool outputOnlyNeededPrototypes;
+extern bool outputDiagnostics;
 
 CommonOptionsParser doCommandLineParsing(int argc, const char **argv);

JsonImpl.hpp

@@ -0,0 +1,81 @@
+/*
+ * This file is part of arduino-preprocessor.
+ *
+ * Copyright 2017 BCMI LABS SA
+ *
+ * arduino-preprocessor 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 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ */
+
+#pragma once
+
+#include <clang/AST/ASTConsumer.h>
+#include <sstream>
+
+using namespace clang;
+using namespace std;
+
+#define JSON_NOEXCEPTION
+#include "json.hpp"
+#include "clang/include/clang/Basic/SourceManager.h"
+using json = nlohmann::json;
+
+template<unsigned InternalLen>
+inline string encode(const SmallString<InternalLen> &s) {
+    return s.str().str();
+}
+
+inline json encode(const SourceManager &sm, const SourceLocation &loc) {
+    PresumedLoc presumed = sm.getPresumedLoc(loc);
+    stringstream pos;
+    pos << presumed.getLine() << ":" << presumed.getColumn();
+    return json{
+        {"file", presumed.getFilename()},
+        {"pos", pos.str()}};
+}
+
+inline json encode(const SourceManager &sm, const CharSourceRange &range) {
+    if (range.isInvalid()) {
+        return json{};
+    }
+    return json{
+        {"begin", encode(sm, range.getBegin())},
+        {"end", encode(sm, range.getEnd())}};
+}
+
+inline json encode(const SourceManager &sm, const FixItHint &hint) {
+    return json{
+        {"before_previous", hint.BeforePreviousInsertions},
+        {"text", hint.CodeToInsert},
+        {"insert_from", encode(sm, hint.InsertFromRange)},
+        {"remove", encode(sm, hint.RemoveRange)}};
+}
+
+template<typename T>
+inline json encode(const SourceManager &sm, const ArrayRef<T> &array) {
+    json res = json::array();
+    for (T elem : array) {
+        res.push_back(encode(sm, elem));
+    }
+    return res;
+}