Add a method to get the list of registered static analyzer checkers.

[alexfh]

Summary

This provides a better interface for clang-tidy and encapsulates the knowledge
about experimental checkers instead of leaving this to the clients.

[zaks.anna]

Thanks for fixing this!

lib/StaticAnalyzer/Core/AnalyzerOptions.cpp

39 ↗

(On Diff #76944)

Debug checkers are not user-facing; they are used to debug the analyzer. So we should either have another flag for them or always skip them.

[alexfh]

• Don't expose debug checkers.

[zaks.anna]

Looks good. Thank you!

cfe/trunk/include/clang/StaticAnalyzer/Core/AnalyzerOptions.h

enum IPAKind {
   /// exact type info is unavailable.
   IPAK_DynamicDispatchBifurcate = 5
 };
 
 class AnalyzerOptions : public RefCountedBase<AnalyzerOptions> {
 public:
   typedef llvm::StringMap<std::string> ConfigTable;
 
+  static std::vector<StringRef>
+  getRegisteredCheckers(bool IncludeExperimental = false);
+
   /// \brief Pair of checker name and enable/disable.
   std::vector<std::pair<std::string, bool> > CheckersControlList;
   
   /// \brief A key-value table of use-specified configuration values.
   ConfigTable Config;
   AnalysisStores AnalysisStoreOpt;
   AnalysisConstraints AnalysisConstraintsOpt;
   AnalysisDiagClients AnalysisDiagOpt;

cfe/trunk/lib/StaticAnalyzer/Core/AnalyzerOptions.cpp

 #include "llvm/ADT/StringSwitch.h"
 #include "llvm/Support/ErrorHandling.h"
 #include "llvm/Support/raw_ostream.h"
 
 using namespace clang;
 using namespace ento;
 using namespace llvm;
 
+std::vector<StringRef>
+AnalyzerOptions::getRegisteredCheckers(bool IncludeExperimental /* = false */) {
+  static const StringRef StaticAnalyzerChecks[] = {
+#define GET_CHECKERS
+#define CHECKER(FULLNAME, CLASS, DESCFILE, HELPTEXT, GROUPINDEX, HIDDEN)       \
+  FULLNAME,
+#include "clang/StaticAnalyzer/Checkers/Checkers.inc"
+#undef CHECKER
+#undef GET_CHECKERS
+  };
+  std::vector<StringRef> Result;
+  for (StringRef CheckName : StaticAnalyzerChecks) {
+    if (!CheckName.startswith("debug.") &&
+        (IncludeExperimental || !CheckName.startswith("alpha.")))
+      Result.push_back(CheckName);
+  }
+  return Result;
+}
+
 AnalyzerOptions::UserModeKind AnalyzerOptions::getUserMode() {
   if (UserMode == UMK_NotSet) {
     StringRef ModeStr =
         Config.insert(std::make_pair("mode", "deep")).first->second;
     UserMode = llvm::StringSwitch<UserModeKind>(ModeStr)
       .Case("shallow", UMK_Shallow)
       .Case("deep", UMK_Deep)
       .Default(UMK_NotSet);

cfe/trunk/unittests/StaticAnalyzer/AnalyzerOptionsTest.cpp

 //===- unittest/Analysis/AnalyzerOptionsTest.cpp - SA Options test --------===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
 #include "clang/StaticAnalyzer/Core/AnalyzerOptions.h"
 #include "clang/StaticAnalyzer/Core/Checker.h"
 #include "gtest/gtest.h"
 
 namespace clang {
 namespace ento {
 
+TEST(StaticAnalyzerOptions, getRegisteredCheckers) {
+  auto IsDebugChecker = [](StringRef CheckerName) {
+    return CheckerName.startswith("debug");
+  };
+  auto IsAlphaChecker = [](StringRef CheckerName) {
+    return CheckerName.startswith("alpha");
+  };
+  const auto &AllCheckers =
+      AnalyzerOptions::getRegisteredCheckers(/*IncludeExperimental=*/true);
+  EXPECT_FALSE(llvm::any_of(AllCheckers, IsDebugChecker));
+  EXPECT_TRUE(llvm::any_of(AllCheckers, IsAlphaChecker));
+
+  const auto &StableCheckers = AnalyzerOptions::getRegisteredCheckers();
+  EXPECT_FALSE(llvm::any_of(StableCheckers, IsDebugChecker));
+  EXPECT_FALSE(llvm::any_of(StableCheckers, IsAlphaChecker));
+}
+
 TEST(StaticAnalyzerOptions, SearchInParentPackageTests) {
   AnalyzerOptions Opts;
   Opts.Config["Outer.Inner.CheckerOne:Option"] = "true";
   Opts.Config["Outer.Inner:Option"] = "false";
   Opts.Config["Outer.Inner:Option2"] = "true";
   Opts.Config["Outer:Option2"] = "false";
 
   struct CheckerOneMock : CheckerBase {