blob: 1c707835a033da73ee6c1d080e58b012b1d0b764 [file] [log] [blame]
Olivier Deprezf4ef2d02021-04-20 13:36:24 +02001//===--- 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
14namespace clang {
15namespace tidy {
16namespace google {
17namespace 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
25class GlobalVariableDeclarationCheck : public ClangTidyCheck {
26 public:
27 GlobalVariableDeclarationCheck(StringRef Name, ClangTidyContext *Context)
28 : ClangTidyCheck(Name, Context) {}
29 bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
30 return LangOpts.ObjC;
31 }
32 void registerMatchers(ast_matchers::MatchFinder *Finder) override;
33 void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
34};
35
36} // namespace objc
37} // namespace google
38} // namespace tidy
39} // namespace clang
40
41#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_OBJC_GLOBAL_VARIABLE_DECLARATION_H