clang-tools  10.0.0git
GlobalVariableDeclarationCheck.h
Go to the documentation of this file.
1 //===--- GlobalVariableDeclarationCheck.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_GOOGLE_OBJC_GLOBAL_VARIABLE_DECLARATION_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_OBJC_GLOBAL_VARIABLE_DECLARATION_H
11 
12 #include "../ClangTidyCheck.h"
13 
14 namespace clang {
15 namespace tidy {
16 namespace google {
17 namespace objc {
18 
19 /// The check for Objective-C global variables and constants naming convention.
20 /// The declaration should follow the patterns of 'k[A-Z].*' (constants) or
21 /// 'g[A-Z].*' (variables).
22 ///
23 /// For the user-facing documentation see:
24 /// http://clang.llvm.org/extra/clang-tidy/checks/google-objc-global-variable-declaration.html
26  public:
28  : ClangTidyCheck(Name, Context) {}
29  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
30  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
31 };
32 
33 } // namespace objc
34 } // namespace google
35 } // namespace tidy
36 } // namespace clang
37 
38 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_OBJC_GLOBAL_VARIABLE_DECLARATION_H
Base class for all clang-tidy checks.
static constexpr llvm::StringLiteral Name
GlobalVariableDeclarationCheck(StringRef Name, ClangTidyContext *Context)
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
The check for Objective-C global variables and constants naming convention.