clang-tools 20.0.0git
|
Finds function names that do not conform to the recommendations of the Google Objective-C Style Guide. More...
#include <FunctionNamingCheck.h>
Public Member Functions | |
FunctionNamingCheck (StringRef Name, ClangTidyContext *Context) | |
bool | isLanguageVersionSupported (const LangOptions &LangOpts) const override |
Override this to disable registering matchers and PP callbacks if an invalid language version is being used. | |
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. | |
Public Member Functions inherited from clang::tidy::ClangTidyCheck | |
ClangTidyCheck (StringRef CheckName, ClangTidyContext *Context) | |
Initializes the check with CheckName and Context . | |
virtual bool | isLanguageVersionSupported (const LangOptions &LangOpts) const |
Override this to disable registering matchers and PP callbacks if an invalid language version is being used. | |
virtual void | registerPPCallbacks (const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP) |
Override this to register PPCallbacks in the preprocessor. | |
virtual void | registerMatchers (ast_matchers::MatchFinder *Finder) |
Override this to register AST matchers with Finder . | |
virtual void | check (const ast_matchers::MatchFinder::MatchResult &Result) |
ClangTidyChecks that register ASTMatchers should do the actual work in here. | |
DiagnosticBuilder | diag (SourceLocation Loc, StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning) |
Add a diagnostic with the check's name. | |
DiagnosticBuilder | diag (StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning) |
Add a diagnostic with the check's name. | |
DiagnosticBuilder | configurationDiag (StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning) const |
Adds a diagnostic to report errors in the check's configuration. | |
virtual void | storeOptions (ClangTidyOptions::OptionMap &Options) |
Should store all options supported by this check with their current values or default values for options that haven't been overridden. | |
Additional Inherited Members | |
Protected Member Functions inherited from clang::tidy::ClangTidyCheck | |
StringRef | getCurrentMainFile () const |
Returns the main file name of the current translation unit. | |
const LangOptions & | getLangOpts () const |
Returns the language options from the context. | |
bool | areDiagsSelfContained () const |
Returns true when the check is run in a use case when only 1 fix will be applied at a time. | |
StringRef | getID () const override |
Protected Attributes inherited from clang::tidy::ClangTidyCheck | |
OptionsView | Options |
Finds function names that do not conform to the recommendations of the Google Objective-C Style Guide.
Function names should be in upper camel case including capitalized acronyms and initialisms. Functions that are not of static storage class must also have an appropriate prefix. The function main
is an exception. Note that this check does not apply to Objective-C method or property declarations.
For the user-facing documentation see: http://clang.llvm.org/extra/clang-tidy/checks/google/objc-function-naming.html
Definition at line 26 of file FunctionNamingCheck.h.
|
inline |
Definition at line 28 of file FunctionNamingCheck.h.
|
overridevirtual |
ClangTidyChecks
that register ASTMatchers should do the actual work in here.
Reimplemented from clang::tidy::ClangTidyCheck.
Definition at line 106 of file FunctionNamingCheck.cpp.
References clang::tidy::ClangTidyCheck::diag().
|
inlineoverridevirtual |
Override this to disable registering matchers and PP callbacks if an invalid language version is being used.
For example if a check is examining overloaded functions then this should be overridden to return false when the CPlusPlus flag is not set in LangOpts
.
Reimplemented from clang::tidy::ClangTidyCheck.
Definition at line 30 of file FunctionNamingCheck.h.
|
overridevirtual |
Override this to register AST matchers with Finder
.
This should be used by clang-tidy checks that analyze code properties that dependent on AST knowledge.
You can register as many matchers as necessary with Finder
. Usually, "this" will be used as callback, but you can also specify other callback classes. Thereby, different matchers can trigger different callbacks.
This will only be executed if the function isLanguageVersionSupported returns true.
If you need to merge information between the different matchers, you can store these as members of the derived class. However, note that all matches occur in the order of the AST traversal.
Reimplemented from clang::tidy::ClangTidyCheck.
Definition at line 88 of file FunctionNamingCheck.cpp.