clang-tools  14.0.0git
Public Member Functions | List of all members
clang::tidy::bugprone::ReservedIdentifierCheck Class Referencefinal

Checks for usages of identifiers reserved for use by the implementation. More...

#include <ReservedIdentifierCheck.h>

Inheritance diagram for clang::tidy::bugprone::ReservedIdentifierCheck:
Inheritance graph
[legend]
Collaboration diagram for clang::tidy::bugprone::ReservedIdentifierCheck:
Collaboration graph
[legend]

Public Member Functions

 ReservedIdentifierCheck (StringRef Name, ClangTidyContext *Context)
 
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...
 
- 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

- 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 >
 
- 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 usages of identifiers reserved for use by the implementation.

The C and C++ standards both reserve the following names for such use:

The C standard additionally reserves names beginning with a double underscore, while the C++ standard strengthens this to reserve names with a double underscore occurring anywhere.

For the user-facing documentation see: http://clang.llvm.org/extra/clang-tidy/checks/bugprone-reserved-identifier.html

Definition at line 33 of file ReservedIdentifierCheck.h.

Constructor & Destructor Documentation

◆ ReservedIdentifierCheck()

clang::tidy::bugprone::ReservedIdentifierCheck::ReservedIdentifierCheck ( StringRef  Name,
ClangTidyContext Context 
)

Definition at line 43 of file ReservedIdentifierCheck.cpp.

Member Function Documentation

◆ storeOptions()

void clang::tidy::bugprone::ReservedIdentifierCheck::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 50 of file ReservedIdentifierCheck.cpp.


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