clang-tools-extra/clang-tidy/readability/RedundantControlFlowCheck.h

   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
  25 class RedundantControlFlowCheck : public ClangTidyCheck {
  26 public:
  27   RedundantControlFlowCheck(StringRef Name, ClangTidyContext *Context)
  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