clang-tidy/readability/RedundantControlFlowCheck.h

0001 //===--- RedundantControlFlowCheck.h - clang-tidy----------------*- C++ -*-===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008
0009 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_REDUNDANT_CONTROL_FLOW_H
0010 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_REDUNDANT_CONTROL_FLOW_H
0011
0012 #include "../ClangTidyCheck.h"
0013
0014 namespace clang::tidy::readability {
0015
0016 /// Eliminates redundant `return` statements at the end of a function that
0017 /// returns `void`.
0018 ///
0019 /// Eliminates redundant `continue` statements at the end of a loop body.
0020 ///
0021 /// For the user-facing documentation see:
0022 /// http://clang.llvm.org/extra/clang-tidy/checks/readability/redundant-control-flow.html
0023 class RedundantControlFlowCheck : public ClangTidyCheck {
0024 public:
0025   RedundantControlFlowCheck(StringRef Name, ClangTidyContext *Context)
0026       : ClangTidyCheck(Name, Context) {}
0027   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
0028   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
0029
0030   std::optional<TraversalKind> getCheckTraversalKind() const override {
0031     return TK_IgnoreUnlessSpelledInSource;
0032   }
0033
0034 private:
0035   void
0036   checkRedundantReturn(const ast_matchers::MatchFinder::MatchResult &Result,
0037                        const CompoundStmt *Block);
0038
0039   void
0040   checkRedundantContinue(const ast_matchers::MatchFinder::MatchResult &Result,
0041                          const CompoundStmt *Block);
0042
0043   void issueDiagnostic(const ast_matchers::MatchFinder::MatchResult &Result,
0044                        const CompoundStmt *Block, const SourceRange &StmtRange,
0045                        const char *Diag);
0046 };
0047
0048 } // namespace clang::tidy::readability
0049
0050 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_REDUNDANT_CONTROL_FLOW_H