clang-tidy/google/FunctionNamingCheck.h

0001 //===--- FunctionNamingCheck.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_FUNCTION_NAMING_CHECK_H
0010 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_OBJC_FUNCTION_NAMING_CHECK_H
0011
0012 #include "../ClangTidyCheck.h"
0013 #include "llvm/ADT/StringRef.h"
0014
0015 namespace clang::tidy::google::objc {
0016
0017 /// Finds function names that do not conform to the recommendations of the
0018 /// Google Objective-C Style Guide. Function names should be in upper camel case
0019 /// including capitalized acronyms and initialisms. Functions that are not of
0020 /// static storage class must also have an appropriate prefix. The function
0021 /// `main` is an exception. Note that this check does not apply to Objective-C
0022 /// method or property declarations.
0023 ///
0024 /// For the user-facing documentation see:
0025 /// http://clang.llvm.org/extra/clang-tidy/checks/google/objc-function-naming.html
0026 class FunctionNamingCheck : public ClangTidyCheck {
0027 public:
0028   FunctionNamingCheck(StringRef Name, ClangTidyContext *Context)
0029       : ClangTidyCheck(Name, Context) {}
0030   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
0031     return LangOpts.ObjC;
0032   }
0033   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
0034   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
0035 };
0036
0037 } // namespace clang::tidy::google::objc
0038
0039 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_OBJC_FUNCTION_NAMING_CHECK_H