clang-tools  14.0.0git
NoRecursionCheck.h
Go to the documentation of this file.
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 {
19 namespace misc {
20 
21 /// Finds strongly connected functions (by analyzing call graph for SCC's
22 /// that are loops), diagnoses each function in the cycle,
23 /// and displays one example of possible call graph loop (recursion).
24 ///
25 /// For the user-facing documentation see:
26 /// http://clang.llvm.org/extra/clang-tidy/checks/misc-no-recursion.html
28 public:
29  NoRecursionCheck(StringRef Name, ClangTidyContext *Context)
30  : ClangTidyCheck(Name, Context) {}
31  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
32  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
33 
34 private:
35  void handleSCC(ArrayRef<CallGraphNode *> SCC);
36 };
37 
38 } // namespace misc
39 } // namespace tidy
40 } // namespace clang
41 
42 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_NORECURSIONCHECK_H
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:54
clang::tidy::misc::NoRecursionCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: NoRecursionCheck.cpp:198
clang::tidy::misc::NoRecursionCheck
Finds strongly connected functions (by analyzing call graph for SCC's that are loops),...
Definition: NoRecursionCheck.h:27
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:72
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:28
clang::tidy::misc::NoRecursionCheck::NoRecursionCheck
NoRecursionCheck(StringRef Name, ClangTidyContext *Context)
Definition: NoRecursionCheck.h:29
clang::tidy::misc::NoRecursionCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: NoRecursionCheck.cpp:256
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27