clang-tools  14.0.0git
RedundantControlFlowCheck.h
Go to the documentation of this file.
1 //===--- RedundantControlFlowCheck.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_READABILITY_REDUNDANT_CONTROL_FLOW_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_REDUNDANT_CONTROL_FLOW_H
11 
12 #include "../ClangTidyCheck.h"
13 
14 namespace clang {
15 namespace tidy {
16 namespace readability {
17 
18 /// Eliminates redundant `return` statements at the end of a function that
19 /// returns `void`.
20 ///
21 /// Eliminates redundant `continue` statements at the end of a loop body.
22 ///
23 /// For the user-facing documentation see:
24 /// http://clang.llvm.org/extra/clang-tidy/checks/readability-redundant-control-flow.html
26 public:
28  : ClangTidyCheck(Name, Context) {}
29  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
30  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
31 
32  llvm::Optional<TraversalKind> getCheckTraversalKind() const override {
33  return TK_IgnoreUnlessSpelledInSource;
34  }
35 
36 private:
37  void
38  checkRedundantReturn(const ast_matchers::MatchFinder::MatchResult &Result,
39  const CompoundStmt *Block);
40 
41  void
42  checkRedundantContinue(const ast_matchers::MatchFinder::MatchResult &Result,
43  const CompoundStmt *Block);
44 
45  void issueDiagnostic(const ast_matchers::MatchFinder::MatchResult &Result,
46  const CompoundStmt *Block, const SourceRange &StmtRange,
47  const char *Diag);
48 };
49 
50 } // namespace readability
51 } // namespace tidy
52 } // namespace clang
53 
54 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_REDUNDANT_CONTROL_FLOW_H
clang::tidy::readability::RedundantControlFlowCheck::getCheckTraversalKind
llvm::Optional< TraversalKind > getCheckTraversalKind() const override
Definition: RedundantControlFlowCheck.h:32
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:54
clang::tidy::readability::RedundantControlFlowCheck
Eliminates redundant return statements at the end of a function that returns void.
Definition: RedundantControlFlowCheck.h:25
clang::tidy::readability::RedundantControlFlowCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: RedundantControlFlowCheck.cpp:47
clang::tidy::readability::RedundantControlFlowCheck::RedundantControlFlowCheck
RedundantControlFlowCheck(StringRef Name, ClangTidyContext *Context)
Definition: RedundantControlFlowCheck.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::readability::RedundantControlFlowCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: RedundantControlFlowCheck.cpp:33
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27