clang-tools 20.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
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
27public:
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
llvm::SmallString< 256U > Name
Base class for all clang-tidy checks.
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Finds function names that do not conform to the recommendations of the Google Objective-C Style Guide...
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
bool isLanguageVersionSupported(const LangOptions &LangOpts) const override
Override this to disable registering matchers and PP callbacks if an invalid language version is bein...
FunctionNamingCheck(StringRef Name, ClangTidyContext *Context)