clang-tidy/google/GlobalVariableDeclarationCheck.h

0001 //===--- GlobalVariableDeclarationCheck.h - clang-tidy-----------*- C++ -*-===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008
0009 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_OBJC_GLOBAL_VARIABLE_DECLARATION_H
0010 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_OBJC_GLOBAL_VARIABLE_DECLARATION_H
0011
0012 #include "../ClangTidyCheck.h"
0013
0014 namespace clang::tidy::google::objc {
0015
0016 /// The check for Objective-C global variables and constants naming convention.
0017 /// The declaration should follow the patterns of 'k[A-Z].*' (constants) or
0018 /// 'g[A-Z].*' (variables).
0019 ///
0020 /// For the user-facing documentation see:
0021 /// http://clang.llvm.org/extra/clang-tidy/checks/google/objc-global-variable-declaration.html
0022 class GlobalVariableDeclarationCheck : public ClangTidyCheck {
0023  public:
0024   GlobalVariableDeclarationCheck(StringRef Name, ClangTidyContext *Context)
0025       : ClangTidyCheck(Name, Context) {}
0026   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
0027     return LangOpts.ObjC;
0028   }
0029   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
0030   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
0031 };
0032
0033 } // namespace clang::tidy::google::objc
0034
0035 #endif  // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_OBJC_GLOBAL_VARIABLE_DECLARATION_H