clang-tools
11.0.0
|
Checks for identifiers naming style mismatch. More...
#include <IdentifierNamingCheck.h>
Classes | |
struct | NamingStyle |
Public Types | |
enum | CaseType { CT_AnyCase = 0, CT_LowerCase, CT_CamelBack, CT_UpperCase, CT_CamelCase, CT_CamelSnakeCase, CT_CamelSnakeBack } |
![]() | |
enum | ShouldFixStatus { ShouldFixStatus::ShouldFix, ShouldFixStatus::ConflictsWithKeyword, ShouldFixStatus::ConflictsWithMacroDefinition, ShouldFixStatus::IgnoreFailureThreshold, ShouldFixStatus::InsideMacro } |
This enum will be used in select of the diagnostic message. More... | |
using | NamingCheckId = std::pair< SourceLocation, std::string > |
using | NamingCheckFailureMap = llvm::DenseMap< NamingCheckId, NamingCheckFailure > |
Public Member Functions | |
IdentifierNamingCheck (StringRef Name, ClangTidyContext *Context) | |
~IdentifierNamingCheck () | |
void | storeOptions (ClangTidyOptions::OptionMap &Opts) override |
Should store all options supported by this check with their current values or default values for options that haven't been overridden. More... | |
![]() | |
RenamerClangTidyCheck (StringRef CheckName, ClangTidyContext *Context) | |
~RenamerClangTidyCheck () | |
void | registerMatchers (ast_matchers::MatchFinder *Finder) override final |
Derived classes should not implement any matching logic themselves; this class will do the matching and call the derived class' GetDeclFailureInfo() and GetMacroFailureInfo() for determining whether a given identifier passes or fails the check. More... | |
void | check (const ast_matchers::MatchFinder::MatchResult &Result) override final |
ClangTidyChecks that register ASTMatchers should do the actual work in here. More... | |
void | registerPPCallbacks (const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP) override final |
Override this to register PPCallbacks in the preprocessor. More... | |
void | onEndOfTranslationUnit () override final |
void | storeOptions (ClangTidyOptions::OptionMap &Opts) override |
Derived classes that override this function should call this method from the overridden method. More... | |
void | checkMacro (SourceManager &sourceMgr, const Token &MacroNameTok, const MacroInfo *MI) |
Check Macros for style violations. More... | |
void | expandMacro (const Token &MacroNameTok, const MacroInfo *MI) |
Add a usage of a macro if it already has a violation. More... | |
void | addUsage (const RenamerClangTidyCheck::NamingCheckId &Decl, SourceRange Range, SourceManager *SourceMgr=nullptr) |
void | addUsage (const NamedDecl *Decl, SourceRange Range, SourceManager *SourceMgr=nullptr) |
Convenience method when the usage to be added is a NamedDecl. More... | |
![]() | |
ClangTidyCheck (StringRef CheckName, ClangTidyContext *Context) | |
Initializes the check with CheckName and Context . More... | |
virtual bool | isLanguageVersionSupported (const LangOptions &LangOpts) const |
Override this to disable registering matchers and PP callbacks if an invalid language version is being used. More... | |
DiagnosticBuilder | diag (SourceLocation Loc, StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning) |
Add a diagnostic with the check's name. More... | |
Additional Inherited Members | |
![]() | |
StringRef | getCurrentMainFile () const |
Returns the main file name of the current translation unit. More... | |
const LangOptions & | getLangOpts () const |
Returns the language options from the context. More... | |
![]() | |
OptionsView | Options |
Checks for identifiers naming style mismatch.
This check will try to enforce coding guidelines on the identifiers naming. It supports lower_case
, UPPER_CASE
, camelBack
and CamelCase
casing and tries to convert from one to another if a mismatch is detected.
It also supports a fixed prefix and suffix that will be prepended or appended to the identifiers, regardless of the casing.
Many configuration options are available, in order to be able to create different rules for different kind of identifier. In general, the rules are falling back to a more generic rule if the specific case is not configured.
Definition at line 33 of file IdentifierNamingCheck.h.
Enumerator | |
---|---|
CT_AnyCase | |
CT_LowerCase | |
CT_CamelBack | |
CT_UpperCase | |
CT_CamelCase | |
CT_CamelSnakeCase | |
CT_CamelSnakeBack |
Definition at line 40 of file IdentifierNamingCheck.h.
clang::tidy::readability::IdentifierNamingCheck::IdentifierNamingCheck | ( | StringRef | Name, |
ClangTidyContext * | Context | ||
) |
Definition at line 122 of file IdentifierNamingCheck.cpp.
|
default |
|
overridevirtual |
Should store all options supported by this check with their current values or default values for options that haven't been overridden.
The check should use Options.store()
to store each option it supports whether it has the default value or it has been overridden.
Reimplemented from clang::tidy::ClangTidyCheck.
Definition at line 155 of file IdentifierNamingCheck.cpp.