clang-tools-extra/clang-tidy/google/GlobalVariableDeclarationCheck.h

   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::tidy::google::objc {
  15
  16 /// The check for Objective-C global variables and constants naming convention.
  17 /// The declaration should follow the patterns of 'k[A-Z].*' (constants) or
  18 /// 'g[A-Z].*' (variables).
  19 ///
  20 /// For the user-facing documentation see:
  21 /// http://clang.llvm.org/extra/clang-tidy/checks/google/objc-global-variable-declaration.html
  22 class GlobalVariableDeclarationCheck : public ClangTidyCheck {
  23  public:
  24   GlobalVariableDeclarationCheck(StringRef Name, ClangTidyContext *Context)
  25       : ClangTidyCheck(Name, Context) {}
  26   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
  27     return LangOpts.ObjC;
  28   }
  29   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
  30   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
  31 };
  32
  33 } // namespace clang::tidy::google::objc
  34
  35 #endif  // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_OBJC_GLOBAL_VARIABLE_DECLARATION_H