clang-tools  14.0.0git
Classes | Public Types | Public Member Functions | List of all members
clang::tidy::readability::IdentifierNamingCheck Class Referencefinal

Checks for identifiers naming style mismatch. More...

#include <IdentifierNamingCheck.h>

Inheritance diagram for clang::tidy::readability::IdentifierNamingCheck:
Inheritance graph
[legend]
Collaboration diagram for clang::tidy::readability::IdentifierNamingCheck:
Collaboration graph
[legend]

Classes

struct  FileStyle
 
struct  HungarianNotation
 
struct  HungarianNotationOption
 
struct  NamingStyle
 

Public Types

enum  CaseType {
  CT_AnyCase = 0, CT_LowerCase, CT_CamelBack, CT_UpperCase,
  CT_CamelCase, CT_CamelSnakeCase, CT_CamelSnakeBack
}
 
enum  HungarianPrefixType { HPT_Off = 0, HPT_On, HPT_LowerCase, HPT_CamelCase }
 
- Public Types inherited from clang::tidy::RenamerClangTidyCheck
enum  ShouldFixStatus {
  ShouldFixStatus::ShouldFix, ShouldFixStatus::ConflictsWithKeyword, ShouldFixStatus::ConflictsWithMacroDefinition, ShouldFixStatus::FixInvalidIdentifier,
  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...
 
IdentifierNamingCheck::FileStyle getFileStyleFromOptions (const ClangTidyCheck::OptionsView &Options) const
 
bool matchesStyle (StringRef Type, StringRef Name, const IdentifierNamingCheck::NamingStyle &Style, const IdentifierNamingCheck::HungarianNotationOption &HNOption, const NamedDecl *Decl) const
 
std::string fixupWithCase (StringRef Type, StringRef Name, const Decl *D, const IdentifierNamingCheck::NamingStyle &Style, const IdentifierNamingCheck::HungarianNotationOption &HNOption, IdentifierNamingCheck::CaseType Case) const
 
std::string fixupWithStyle (StringRef Type, StringRef Name, const IdentifierNamingCheck::NamingStyle &Style, const IdentifierNamingCheck::HungarianNotationOption &HNOption, const Decl *D) const
 
StyleKind findStyleKind (const NamedDecl *D, ArrayRef< llvm::Optional< IdentifierNamingCheck::NamingStyle >> NamingStyles, bool IgnoreMainLikeFunctions) const
 
llvm::Optional< RenamerClangTidyCheck::FailureInfogetFailureInfo (StringRef Type, StringRef Name, const NamedDecl *ND, SourceLocation Location, ArrayRef< llvm::Optional< IdentifierNamingCheck::NamingStyle >> NamingStyles, const IdentifierNamingCheck::HungarianNotationOption &HNOption, StyleKind SK, const SourceManager &SM, bool IgnoreFailedSplit) const
 
bool isParamInMainLikeFunction (const ParmVarDecl &ParmDecl, bool IncludeMainLike) const
 
- Public Member Functions inherited from clang::tidy::RenamerClangTidyCheck
 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...
 
- Public Member Functions inherited from clang::tidy::ClangTidyCheck
 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...
 
DiagnosticBuilder diag (StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning)
 Add a diagnostic with the check's name. More...
 
DiagnosticBuilder configurationDiag (StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning) const
 Adds a diagnostic to report errors in the check's configuration. More...
 

Additional Inherited Members

- Protected Member Functions inherited from clang::tidy::ClangTidyCheck
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...
 
- Protected Attributes inherited from clang::tidy::ClangTidyCheck
OptionsView Options
 

Detailed Description

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 36 of file IdentifierNamingCheck.h.

Member Enumeration Documentation

◆ CaseType

Enumerator
CT_AnyCase 
CT_LowerCase 
CT_CamelBack 
CT_UpperCase 
CT_CamelCase 
CT_CamelSnakeCase 
CT_CamelSnakeBack 

Definition at line 43 of file IdentifierNamingCheck.h.

◆ HungarianPrefixType

Enumerator
HPT_Off 
HPT_On 
HPT_LowerCase 
HPT_CamelCase 

Definition at line 53 of file IdentifierNamingCheck.h.

Constructor & Destructor Documentation

◆ IdentifierNamingCheck()

clang::tidy::readability::IdentifierNamingCheck::IdentifierNamingCheck ( StringRef  Name,
ClangTidyContext Context 
)

Definition at line 393 of file IdentifierNamingCheck.cpp.

◆ ~IdentifierNamingCheck()

clang::tidy::readability::IdentifierNamingCheck::~IdentifierNamingCheck ( )
default

Member Function Documentation

◆ findStyleKind()

StyleKind clang::tidy::readability::IdentifierNamingCheck::findStyleKind ( const NamedDecl *  D,
ArrayRef< llvm::Optional< IdentifierNamingCheck::NamingStyle >>  NamingStyles,
bool  IgnoreMainLikeFunctions 
) const

◆ fixupWithCase()

std::string clang::tidy::readability::IdentifierNamingCheck::fixupWithCase ( StringRef  Type,
StringRef  Name,
const Decl D,
const IdentifierNamingCheck::NamingStyle Style,
const IdentifierNamingCheck::HungarianNotationOption HNOption,
IdentifierNamingCheck::CaseType  Case 
) const

Definition at line 862 of file IdentifierNamingCheck.cpp.

◆ fixupWithStyle()

std::string clang::tidy::readability::IdentifierNamingCheck::fixupWithStyle ( StringRef  Type,
StringRef  Name,
const IdentifierNamingCheck::NamingStyle Style,
const IdentifierNamingCheck::HungarianNotationOption HNOption,
const Decl D 
) const

Definition at line 1030 of file IdentifierNamingCheck.cpp.

◆ getFailureInfo()

llvm::Optional< RenamerClangTidyCheck::FailureInfo > clang::tidy::readability::IdentifierNamingCheck::getFailureInfo ( StringRef  Type,
StringRef  Name,
const NamedDecl *  ND,
SourceLocation  Location,
ArrayRef< llvm::Optional< IdentifierNamingCheck::NamingStyle >>  NamingStyles,
const IdentifierNamingCheck::HungarianNotationOption HNOption,
StyleKind  SK,
const SourceManager &  SM,
bool  IgnoreFailedSplit 
) const

Definition at line 1348 of file IdentifierNamingCheck.cpp.

References clang::tidy::readability::SK_Invalid.

◆ getFileStyleFromOptions()

IdentifierNamingCheck::FileStyle clang::tidy::readability::IdentifierNamingCheck::getFileStyleFromOptions ( const ClangTidyCheck::OptionsView Options) const

◆ isParamInMainLikeFunction()

bool clang::tidy::readability::IdentifierNamingCheck::isParamInMainLikeFunction ( const ParmVarDecl &  ParmDecl,
bool  IncludeMainLike 
) const

Definition at line 966 of file IdentifierNamingCheck.cpp.

References Type.

Referenced by findStyleKind().

◆ matchesStyle()

bool clang::tidy::readability::IdentifierNamingCheck::matchesStyle ( StringRef  Type,
StringRef  Name,
const IdentifierNamingCheck::NamingStyle Style,
const IdentifierNamingCheck::HungarianNotationOption HNOption,
const NamedDecl *  Decl 
) const

Definition at line 826 of file IdentifierNamingCheck.cpp.

◆ storeOptions()

void clang::tidy::readability::IdentifierNamingCheck::storeOptions ( ClangTidyOptions::OptionMap Options)
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 792 of file IdentifierNamingCheck.cpp.


The documentation for this class was generated from the following files: