clang-tools-extra/clang-tidy/cppcoreguidelines/AvoidGotoCheck.h

   1 //===--- AvoidGotoCheck.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_CPPCOREGUIDELINES_AVOIDGOTOCHECK_H
  10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_AVOIDGOTOCHECK_H
  11
  12 #include "../ClangTidyCheck.h"
  13
  14 namespace clang {
  15 namespace tidy {
  16 namespace cppcoreguidelines {
  17
  18 /// The usage of ``goto`` for control flow is error prone and should be replaced
  19 /// with looping constructs. Only forward jumps in nested loops are accepted.
  20 //
  21 /// For the user-facing documentation see:
  22 /// http://clang.llvm.org/extra/clang-tidy/checks/cppcoreguidelines/avoid-goto.html
  23 class AvoidGotoCheck : public ClangTidyCheck {
  24 public:
  25   AvoidGotoCheck(StringRef Name, ClangTidyContext *Context)
  26       : ClangTidyCheck(Name, Context) {}
  27   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
  28     return LangOpts.CPlusPlus;
  29   }
  30   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
  31   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
  32 };
  33
  34 } // namespace cppcoreguidelines
  35 } // namespace tidy
  36 } // namespace clang
  37
  38 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_AVOIDGOTOCHECK_H