clang-tools  10.0.0svn
AvoidGotoCheck.h
Go to the documentation of this file.
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 "../ClangTidy.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
24 public:
25  AvoidGotoCheck(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 
31 } // namespace cppcoreguidelines
32 } // namespace tidy
33 } // namespace clang
34 
35 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_AVOIDGOTOCHECK_H
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
AvoidGotoCheck(StringRef Name, ClangTidyContext *Context)
Base class for all clang-tidy checks.
The usage of goto for control flow is error prone and should be replaced with looping constructs...
static constexpr llvm::StringLiteral Name
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.