Introducing ArduinoDiagnosticConsumer class

This class will be extended in later commits.

Author: cmaglie

ArduinoDiagnosticConsumer.cpp

@@ -0,0 +1,75 @@
+/*
+ * 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.
+ */
+
+#include "ArduinoDiagnosticConsumer.h"
+#include "CommandLine.h"
+
+void ArduinoDiagnosticConsumer::collectUndeclaredIdentifiersIn(IdentifiersList &list) {
+    undeclaredIdentifiersList = &list;
+}
+
+void ArduinoDiagnosticConsumer::HandleDiagnostic(DiagnosticsEngine::Level level, const Diagnostic& info) {
+    // DiagnosticConsumer::HandleDiagnostic(level, info);
+
+    if (undeclaredIdentifiersList && level == DiagnosticsEngine::Level::Error) {
+        const SourceManager &sm = info.getSourceManager();
+        const SourceLocation &loc = info.getLocation();
+        const SourceLocation &sl = sm.getSpellingLoc(loc);
+        if (debugOutput) {
+            outs() << sm.getSpellingLineNumber(sl) << ":" << sm.getSpellingColumnNumber(sl) << " ";
+        }
+
+        unsigned id = info.getID();
+        if (id == 3441 /* use of undeclared identifier */) {
+            // It seems that the only way to retrieve the undeclared symbol
+            // is to print it as a localization string.
+            const char *fmt = "%0";
+            SmallString<100> outArg;
+            info.FormatDiagnostic(fmt, fmt + 2, outArg);
+            // we should also remove quotes as well...
+            StringRef identifier = outArg.substr(1, outArg.size() - 2);
+            if (debugOutput) {
+                outs() << "Found undeclared identifier '" << identifier << "'\n";
+            }
+
+            // Save the identifier position for later processing
+            IdentifierLocation *m = new IdentifierLocation;
+            m->location = FullSourceLoc(loc, sm);
+            m->identifier = identifier.str();
+            undeclaredIdentifiersList->push_front(m);
+            return;
+        }
+
+        if (debugOutput) {
+            SmallString<100> outStr;
+            info.FormatDiagnostic(outStr);
+            outs() << "(" << id << ") " << outStr << "\n";
+        }
+    }
+}

ArduinoDiagnosticConsumer.h

@@ -0,0 +1,48 @@
+/*
+ * 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 "IdentifiersList.h"
+
+using namespace clang;
+using namespace llvm;
+
+class ArduinoDiagnosticConsumer : public DiagnosticConsumer {
+public:
+
+    void collectUndeclaredIdentifiersIn(IdentifiersList &list);
+
+private:
+    IdentifiersList *undeclaredIdentifiersList = nullptr;
+
+    void HandleDiagnostic(DiagnosticsEngine::Level level, const Diagnostic& info) override;
+};

main.cpp

@@ -45,6 +45,7 @@
 #include <sstream>
 #include <list>
 
+#include "ArduinoDiagnosticConsumer.h"
 #include "Config.h"
 #include "CommandLine.h"
 #include "IdentifiersList.h"
@@ -57,49 +58,6 @@ using namespace std;
 
 IdentifiersList undeclaredIdentifiers;
 
-class UndefinedIdentifiersCollector : public DiagnosticConsumer {
-
-    void HandleDiagnostic(DiagnosticsEngine::Level level, const Diagnostic& info) override {
-        // DiagnosticConsumer::HandleDiagnostic(level, info);
-
-        if (level == DiagnosticsEngine::Level::Error) {
-            const SourceManager &sm = info.getSourceManager();
-            const SourceLocation &loc = info.getLocation();
-            const SourceLocation &sl = sm.getSpellingLoc(loc);
-            if (debugOutput) {
-                outs() << sm.getSpellingLineNumber(sl) << ":" << sm.getSpellingColumnNumber(sl) << " ";
-            }
-
-            unsigned id = info.getID();
-            if (id == 3441 /* use of undeclared identifier */) {
-                // It seems that the only way to retrieve the undeclared symbol
-                // is to print it as a localization string.
-                const char *fmt = "%0";
-                SmallString<100> outArg;
-                info.FormatDiagnostic(fmt, fmt + 2, outArg);
-                // we should also remove quotes as well...
-                StringRef identifier = outArg.substr(1, outArg.size() - 2);
-                if (debugOutput) {
-                    outs() << "Found undeclared identifier '" << identifier << "'\n";
-                }
-
-                // Save the identifier position for later processing
-                IdentifierLocation *m = new IdentifierLocation;
-                m->location = FullSourceLoc(loc, sm);
-                m->identifier = identifier.str();
-                undeclaredIdentifiers.push_front(m);
-                return;
-            }
-
-            if (debugOutput) {
-                SmallString<100> outStr;
-                info.FormatDiagnostic(outStr);
-                outs() << "(" << id << ") " << outStr << "\n";
-            }
-        }
-    }
-};
-
 Rewriter rewriter;
 
 class INOPreprocessorMatcherCallback : public MatchFinder::MatchCallback {
@@ -249,7 +207,10 @@ int main(int argc, const char **argv) {
     CommonOptionsParser optParser = doCommandLineParsing(argc, argv);
     ClangTool tool(optParser.getCompilations(), optParser.getSourcePathList());
 
-    UndefinedIdentifiersCollector dc;
+    ArduinoDiagnosticConsumer dc;
+    if (outputOnlyNeededPrototypes) {
+        dc.collectUndeclaredIdentifiersIn(undeclaredIdentifiers);
+    }
     tool.setDiagnosticConsumer(&dc);
 
     int res = tool.run(newFrontendActionFactory<INOPreprocessAction>().get());

package-arduino-preprocessor.bash

@@ -108,7 +108,7 @@ CXXFLAGS=`clang/bin/llvm-config --cxxflags`
 LDFLAGS=`clang/bin/llvm-config --ldflags`
 LLVMLIBS=`clang/bin/llvm-config --libs --system-libs`
 CLANGLIBS=`ls clang/lib/libclang*.a | sed s/.*libclang/-lclang/ | sed s/.a$//`
-SOURCES="main.cpp CommandLine.cpp IdentifiersList.cpp"
+SOURCES="main.cpp ArduinoDiagnosticConsumer.cpp CommandLine.cpp IdentifiersList.cpp"
 $CXX $SOURCES -o objdir/arduino-preprocessor $CXXFLAGS $LDFLAGS -Wl,--start-group $LLVMLIBS $CLANGLIBS -Wl,--end-group
 
 rm -f arduino-preprocessor-${OUTPUT_VERSION}-${OUTPUT_TAG}.tar.bz2