clang-tools  14.0.0git
FunctionNamingCheck.h
Go to the documentation of this file.
1 //===--- FunctionNamingCheck.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_FUNCTION_NAMING_CHECK_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_OBJC_FUNCTION_NAMING_CHECK_H
11 
12 #include "../ClangTidyCheck.h"
13 #include "llvm/ADT/StringRef.h"
14 
15 namespace clang {
16 namespace tidy {
17 namespace google {
18 namespace objc {
19 
20 /// Finds function names that do not conform to the recommendations of the
21 /// Google Objective-C Style Guide. Function names should be in upper camel case
22 /// including capitalized acronyms and initialisms. Functions that are not of
23 /// static storage class must also have an appropriate prefix. The function
24 /// `main` is an exception. Note that this check does not apply to Objective-C
25 /// method or property declarations.
26 ///
27 /// For the user-facing documentation see:
28 /// http://clang.llvm.org/extra/clang-tidy/checks/google-objc-function-naming.html
30 public:
32  : ClangTidyCheck(Name, Context) {}
33  bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
34  return LangOpts.ObjC;
35  }
36  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
37  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
38 };
39 
40 } // namespace objc
41 } // namespace google
42 } // namespace tidy
43 } // namespace clang
44 
45 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_OBJC_FUNCTION_NAMING_CHECK_H
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:54
clang::tidy::google::objc::FunctionNamingCheck
Finds function names that do not conform to the recommendations of the Google Objective-C Style Guide...
Definition: FunctionNamingCheck.h:29
clang::tidy::google::objc::FunctionNamingCheck::FunctionNamingCheck
FunctionNamingCheck(StringRef Name, ClangTidyContext *Context)
Definition: FunctionNamingCheck.h:31
clang::tidy::google::objc::FunctionNamingCheck::isLanguageVersionSupported
bool isLanguageVersionSupported(const LangOptions &LangOpts) const override
Override this to disable registering matchers and PP callbacks if an invalid language version is bein...
Definition: FunctionNamingCheck.h:33
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:71
clang::tidy::google::objc::FunctionNamingCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: FunctionNamingCheck.cpp:91
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:28
clang::tidy::google::objc::FunctionNamingCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: FunctionNamingCheck.cpp:109
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27