clang-tools-extra/clang-tidy/bugprone/BranchCloneCheck.h

   1 //===--- BranchCloneCheck.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_BUGPRONE_BRANCHCLONECHECK_H
  10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_BRANCHCLONECHECK_H
  11
  12 #include "../ClangTidyCheck.h"
  13
  14 namespace clang::tidy::bugprone {
  15
  16 /// A check for detecting if/else if/else chains where two or more branches are
  17 /// Type I clones of each other (that is, they contain identical code), for
  18 /// detecting switch statements where two or more consecutive branches are
  19 /// Type I clones of each other, and for detecting conditional operators where
  20 /// the true and false expressions are Type I clones of each other.
  21 ///
  22 /// For the user-facing documentation see:
  23 /// http://clang.llvm.org/extra/clang-tidy/checks/bugprone/branch-clone.html
  24 class BranchCloneCheck : public ClangTidyCheck {
  25 public:
  26   BranchCloneCheck(StringRef Name, ClangTidyContext *Context)
  27       : ClangTidyCheck(Name, Context) {}
  28   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
  29   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
  30   std::optional<TraversalKind> getCheckTraversalKind() const override {
  31     return TK_IgnoreUnlessSpelledInSource;
  32   }
  33 };
  34
  35 } // namespace clang::tidy::bugprone
  36
  37 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_BRANCHCLONECHECK_H