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

   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::tidy::google::objc {
  16
  17 /// Finds function names that do not conform to the recommendations of the
  18 /// Google Objective-C Style Guide. Function names should be in upper camel case
  19 /// including capitalized acronyms and initialisms. Functions that are not of
  20 /// static storage class must also have an appropriate prefix. The function
  21 /// `main` is an exception. Note that this check does not apply to Objective-C
  22 /// method or property declarations.
  23 ///
  24 /// For the user-facing documentation see:
  25 /// http://clang.llvm.org/extra/clang-tidy/checks/google/objc-function-naming.html
  26 class FunctionNamingCheck : public ClangTidyCheck {
  27 public:
  28   FunctionNamingCheck(StringRef Name, ClangTidyContext *Context)
  29       : ClangTidyCheck(Name, Context) {}
  30   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
  31     return LangOpts.ObjC;
  32   }
  33   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
  34   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
  35 };
  36
  37 } // namespace clang::tidy::google::objc
  38
  39 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_OBJC_FUNCTION_NAMING_CHECK_H