Added simple reporting module + interface lister

Author: sawenzel

CMakeLists.txt

@@ -35,6 +35,8 @@ add_subdirectory(tool)
 
 # the specific aliceO2 checker code
 add_subdirectory(aliceO2)
+# the specific reporting tools code
+add_subdirectory(reporting)
 
 
 endif()

reporting/CMakeLists.txt

@@ -0,0 +1,15 @@
+set(LLVM_LINK_COMPONENTS support)
+
+add_clang_library(clangTidyReportingModule
+  ReportingTidyModule.cpp
+  InterfaceLister.cpp
+
+  LINK_LIBS
+  clangAST
+  clangASTMatchers
+  clangBasic
+  clangLex
+  clangTidy
+  clangTidyUtils
+  clangTooling
+  )

reporting/InterfaceLister.cpp

@@ -0,0 +1,38 @@
+//===--- InterfaceLister.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 "InterfaceLister.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 InterfaceLister::registerMatchers(MatchFinder *Finder) {
+  Finder->addMatcher(cxxMemberCallExpr().bind("member"), this);
+}
+
+void InterfaceLister::check(const MatchFinder::MatchResult &Result) {
+  const auto *MatchedCallExpr = Result.Nodes.getNodeAs<CXXMemberCallExpr>("member");
+  if(MatchedCallExpr)
+  {
+    if (std::strcmp(MatchedCallExpr->getRecordDecl()->getDeclName().getAsString().c_str(), ClassName.c_str()) != 0)
+      return;
+
+    std::cerr << ClassName << " : " << MatchedCallExpr->getMethodDecl()->getQualifiedNameAsString() << "\n";
+  }
+}
+
+} // namespace aliceO2
+} // namespace tidy
+} // namespace clang

reporting/InterfaceLister.h

@@ -0,0 +1,43 @@
+//===--- 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_INTERFACELISTER_NAMES_H
+#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_INTERFACELISTER_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 InterfaceLister : public ClangTidyCheck {
+private:
+  const std::string ClassName; // the class name for which we want to find
+                         // used interfaces
+
+public:
+  InterfaceLister(StringRef Name, ClangTidyContext *Context)
+      : ClangTidyCheck(Name, Context), ClassName(Options.get("ClassName", "")) {}
+
+  void storeOptions(ClangTidyOptions::OptionMap &Opts) override {
+    Options.store(Opts, "ClassName", ClassName);
+  }
+
+  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_INTERFACELISTER_NAMES_H

reporting/ReportingTidyModule.cpp

@@ -0,0 +1,37 @@
+//===--- AliceO2TidyModule.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 "../ClangTidy.h"
+#include "../ClangTidyModule.h"
+#include "../ClangTidyModuleRegistry.h"
+#include "InterfaceLister.h"
+
+namespace clang {
+namespace tidy {
+namespace reporting {
+
+class ReportingModule : public ClangTidyModule {
+public:
+  void addCheckFactories(ClangTidyCheckFactories &CheckFactories) override {
+    CheckFactories.registerCheck<InterfaceLister>("Reporting-interfaces-used");
+  }
+};
+
+} // namespace Reporting
+
+// Register the ReportingTidyModule using this statically initialized variable.
+static ClangTidyModuleRegistry::Add<reporting::ReportingModule>
+X("Reporting-module", "Adds Reporting tools (for simple analytics)");
+
+// This anchor is used to force the linker to link in the generated object file
+// and thus register the ReportingModule.
+volatile int ReportingModuleAnchorSource = 0;
+
+} // namespace tidy
+} // namespace clang

tool/CMakeLists.txt

@@ -14,6 +14,7 @@ target_link_libraries(O2codecheck
 
   # link our own checks
   clangTidyAliceO2Module
+  clangTidyReportingModule
 
   # include checkers available from main clang-tidy
   clangTidyBoostModule
@@ -37,4 +38,4 @@ install(PROGRAMS run_O2CodeChecker.py DESTINATION bin)
 
 # we need to install the builtin headers in a path which is searched by the tool
 # FIXME: a soft link would be better
-install(DIRECTORY ${LLVM_LIBRARY_DIR}/clang/${LLVM_PACKAGE_VERSION}/include DESTINATION lib/clang/${LLVM_PACKAGE_VERSION})
+install(DIRECTORY ${LLVM_LIBRARY_DIR}/clang/${LLVM_PACKAGE_VERSION}/include DESTINATION lib/clang/${LLVM_PACKAGE_VERSION})

tool/ClangTidyMain.cpp

@@ -465,11 +465,16 @@ extern volatile int ReadabilityModuleAnchorSource;
 static int LLVM_ATTRIBUTE_UNUSED ReadabilityModuleAnchorDestination =
     ReadabilityModuleAnchorSource;
 
-// This anchor is used to force the linker to link the ReadabilityModule.
+// This anchor is used to force the linker to link the AliceO2Module.
 extern volatile int AliceO2ModuleAnchorSource;
 static int LLVM_ATTRIBUTE_UNUSED AliceO2ModuleAnchorDestination =
     AliceO2ModuleAnchorSource;
 
+// This anchor is used to force the linker to link the ReportingModule.
+extern volatile int ReportingModuleAnchorSource;
+static int LLVM_ATTRIBUTE_UNUSED ReportingModuleAnchorDestination =
+    ReportingModuleAnchorSource;
+
 } // namespace tidy
 } // namespace clang