clang-tools-extra/clang-tidy/misc/NoRecursionCheck.h

   1 //===--- NoRecursionCheck.h - clang-tidy ------------------------*- C++ -*-===//
   2 //
   3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
   4 // See https://llvm.org/LICENSE.txt for license information.
   5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
   6 //
   7 //===----------------------------------------------------------------------===//
   8
   9 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_NORECURSIONCHECK_H
  10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_NORECURSIONCHECK_H
  11
  12 #include "../ClangTidyCheck.h"
  13
  14 namespace clang {
  15
  16 class CallGraphNode;
  17
  18 namespace tidy::misc {
  19
  20 /// Finds strongly connected functions (by analyzing call graph for SCC's
  21 /// that are loops), diagnoses each function in the cycle,
  22 /// and displays one example of possible call graph loop (recursion).
  23 ///
  24 /// For the user-facing documentation see:
  25 /// http://clang.llvm.org/extra/clang-tidy/checks/misc/no-recursion.html
  26 class NoRecursionCheck : public ClangTidyCheck {
  27 public:
  28   NoRecursionCheck(StringRef Name, ClangTidyContext *Context)
  29       : ClangTidyCheck(Name, Context) {}
  30   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
  31   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
  32
  33 private:
  34   void handleSCC(ArrayRef<CallGraphNode *> SCC);
  35 };
  36
  37 } // namespace tidy::misc
  38 } // namespace clang
  39
  40 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_NORECURSIONCHECK_H