Adding reporting code spitting out virtual functions that override something

Author: sawenzel

reporting/CMakeLists.txt

@@ -3,6 +3,7 @@ set(LLVM_LINK_COMPONENTS support)
 add_clang_library(clangTidyReportingModule
   ReportingTidyModule.cpp
   InterfaceLister.cpp
+  VirtFuncLister.cpp
 
   LINK_LIBS
   clangAST

reporting/InterfaceLister.cpp

@@ -41,6 +41,6 @@ void InterfaceLister::check(const MatchFinder::MatchResult &Result) {
   }
 }
 
-} // namespace aliceO2
+} // namespace reporting
 } // namespace tidy
 } // namespace clang

reporting/ReportingTidyModule.cpp

@@ -11,6 +11,7 @@
 #include "../ClangTidyModule.h"
 #include "../ClangTidyModuleRegistry.h"
 #include "InterfaceLister.h"
+#include "VirtFuncLister.h"
 
 namespace clang {
 namespace tidy {
@@ -20,6 +21,8 @@ class ReportingModule : public ClangTidyModule {
 public:
   void addCheckFactories(ClangTidyCheckFactories &CheckFactories) override {
     CheckFactories.registerCheck<InterfaceLister>("Reporting-interfaces-used");
+
+    CheckFactories.registerCheck<VirtFuncLister>("Reporting-unusedvirtfunc");
   }
 };
 

reporting/VirtFuncLister.cpp

@@ -0,0 +1,84 @@
+//===--- VirtFuncLister.cpp - clang-tidy---------------------------------===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#include "VirtFuncLister.h"
+#include "clang/AST/ASTContext.h"
+#include "clang/ASTMatchers/ASTMatchFinder.h"
+#include <iostream>
+
+using namespace clang::ast_matchers;
+
+namespace clang {
+namespace tidy {
+namespace reporting {
+
+void VirtFuncLister::registerMatchers(MatchFinder *Finder) {
+  Finder->addMatcher(cxxMethodDecl().bind("method"), this);
+}
+
+void VirtFuncLister::check(const MatchFinder::MatchResult &Result) {
+  const auto *MatchedDecl =
+      Result.Nodes.getNodeAs<CXXMethodDecl>("method");
+  if (MatchedDecl) {
+      DeclarationNameInfo name_info = MatchedDecl->getNameInfo();
+      std::string func_name = name_info.getAsString();
+
+      bool isvirtual = MatchedDecl->isVirtual();
+
+        llvm::errs() << "MEMBER FUNCTION DECL " << func_name << "("<<MatchedDecl<<")" <<
+        " marked virtual "
+               << MatchedDecl->isVirtualAsWritten() << " is virtual "
+               << isvirtual << "\n";
+
+      // get class declaration of this member function
+      // auto record = MatchedDecl->getCanonicalDecl()->getParent();
+
+      // we need to get source location the base node
+      // as well as overriding node
+      if (isvirtual) {
+        auto iter = MatchedDecl->begin_overridden_methods();
+        auto enditer = MatchedDecl->end_overridden_methods();
+
+        if (iter == enditer) {
+          SourceLocation loc = MatchedDecl->getLocStart();//getLocation();
+          loc.dump(MyContext->getSourceManager());
+          llvm::errs() << "VIRTUAL-START-DECLARATION \n";
+        } else {
+          // otherwise find the base this is referring to
+          decltype(iter) lastiter = iter;
+          while (iter != enditer) {
+            lastiter = iter;
+            // counter number of paths up; if there is more than one
+            // we have to give up for the moment
+            int counter = 0;
+            decltype(iter) countiter = iter;
+            for (; countiter != enditer; ++countiter) {
+              counter++;
+            }
+            if (counter > 1) {
+              llvm::errs() << " OVERRIDING MULTIPLE FUNCTIONS NOT TREATED YET\n";
+              return;
+            }
+            enditer = (*iter)->end_overridden_methods();
+            iter = (*iter)->begin_overridden_methods();
+          }
+          SourceLocation loc = (*lastiter)->getLocStart();//getLocation();
+          loc.dump(MyContext->getSourceManager());
+          llvm::errs() << " OVERRIDEN-AT ";
+          loc = MatchedDecl->getLocStart();//getLocation();
+          loc.dump(MyContext->getSourceManager());
+          llvm::errs() << "\n";
+        }
+      }
+    }
+}
+
+} // namespace reporting
+} // namespace tidy
+} // namespace clang

reporting/VirtFuncLister.h

@@ -0,0 +1,37 @@
+//===--- MemberNamesCheck.h - clang-tidy-------------------------*- C++ -*-===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_VIRTFUNCLISTER_NAMES_H
+#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_VIRTFUNCLISTER_NAMES_H
+
+#include "../ClangTidy.h"
+
+namespace clang {
+namespace tidy {
+namespace reporting {
+
+/// A simple tool/check that given a ClassName reports the interfaces
+/// used in the code base
+///
+class VirtFuncLister : public ClangTidyCheck {
+private:
+  ClangTidyContext * MyContext;
+public:
+  VirtFuncLister(StringRef Name, ClangTidyContext *Context)
+      : ClangTidyCheck(Name, Context), MyContext(Context) {}
+
+  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
+  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
+};
+
+} // namespace reporting
+} // namespace tidy
+} // namespace clang
+
+#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_VIRTFUNCLISTER_NAMES_H