clang-tools  14.0.0git
AvoidNonConstGlobalVariablesCheck.h
Go to the documentation of this file.
1 //===--- AvoidNonConstGlobalVariablesCheck.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_AVOIDNONCONSTGLOBALVARIABLESCHECK_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_AVOIDNONCONSTGLOBALVARIABLESCHECK_H
11 
12 #include "../ClangTidyCheck.h"
13 
14 namespace clang {
15 namespace tidy {
16 namespace cppcoreguidelines {
17 
18 /// Non-const global variables hide dependencies and make the dependencies
19 /// subject to unpredictable changes.
20 ///
21 /// For the user-facing documentation see:
22 /// http://clang.llvm.org/extra/clang-tidy/checks/cppcoreguidelines-avoid-non-const-global-variables.html
24 public:
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_AVOIDNONCONSTGLOBALVARIABLESCHECK_H
clang::tidy::cppcoreguidelines::AvoidNonConstGlobalVariablesCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: AvoidNonConstGlobalVariablesCheck.cpp:24
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:54
clang::tidy::cppcoreguidelines::AvoidNonConstGlobalVariablesCheck::AvoidNonConstGlobalVariablesCheck
AvoidNonConstGlobalVariablesCheck(StringRef Name, ClangTidyContext *Context)
Definition: AvoidNonConstGlobalVariablesCheck.h:25
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:72
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:28
clang::tidy::cppcoreguidelines::AvoidNonConstGlobalVariablesCheck
Non-const global variables hide dependencies and make the dependencies subject to unpredictable chang...
Definition: AvoidNonConstGlobalVariablesCheck.h:23
clang::tidy::cppcoreguidelines::AvoidNonConstGlobalVariablesCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: AvoidNonConstGlobalVariablesCheck.cpp:47
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27