blob: e646ec9711c1c3b28de500a81ffe7a817669491d [file] [log] [blame]
Olivier Deprezf4ef2d02021-04-20 13:36:24 +02001//===--- 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
15namespace clang {
16namespace tidy {
17namespace google {
18namespace 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
29class FunctionNamingCheck : public ClangTidyCheck {
30public:
31 FunctionNamingCheck(StringRef Name, ClangTidyContext *Context)
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