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::tidy::readability {
  15
  16 /// Eliminates redundant `return` statements at the end of a function that
  17 /// returns `void`.
  18 ///
  19 /// Eliminates redundant `continue` statements at the end of a loop body.
  20 ///
  21 /// For the user-facing documentation see:
  22 /// http://clang.llvm.org/extra/clang-tidy/checks/readability/redundant-control-flow.html
  23 class RedundantControlFlowCheck : public ClangTidyCheck {
  24 public:
  25   RedundantControlFlowCheck(StringRef Name, ClangTidyContext *Context)
  26       : ClangTidyCheck(Name, Context) {}
  27   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
  28   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
  29
  30   std::optional<TraversalKind> getCheckTraversalKind() const override {
  31     return TK_IgnoreUnlessSpelledInSource;
  32   }
  33
  34 private:
  35   void
  36   checkRedundantReturn(const ast_matchers::MatchFinder::MatchResult &Result,
  37                        const CompoundStmt *Block);
  38
  39   void
  40   checkRedundantContinue(const ast_matchers::MatchFinder::MatchResult &Result,
  41                          const CompoundStmt *Block);
  42
  43   void issueDiagnostic(const ast_matchers::MatchFinder::MatchResult &Result,
  44                        const CompoundStmt *Block, const SourceRange &StmtRange,
  45                        const char *Diag);
  46 };
  47
  48 } // namespace clang::tidy::readability
  49
  50 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_REDUNDANT_CONTROL_FLOW_H