clang-tools  14.0.0git
Public Member Functions | List of all members
clang::tidy::utils::TransformerClangTidyCheck Class Reference

A base class for defining a ClangTidy check based on a RewriteRule. More...

#include <TransformerClangTidyCheck.h>

Inheritance diagram for clang::tidy::utils::TransformerClangTidyCheck:
Inheritance graph
[legend]
Collaboration diagram for clang::tidy::utils::TransformerClangTidyCheck:
Collaboration graph
[legend]

Public Member Functions

 TransformerClangTidyCheck (StringRef Name, ClangTidyContext *Context)
 
 TransformerClangTidyCheck (std::function< Optional< transformer::RewriteRule >(const LangOptions &, const OptionsView &)> MakeRule, StringRef Name, ClangTidyContext *Context)
 DEPRECATED: prefer the two argument constructor in conjunction with setRule. More...
 
 TransformerClangTidyCheck (transformer::RewriteRule R, StringRef Name, ClangTidyContext *Context)
 Convenience overload of the constructor when the rule doesn't have any dependencies. More...
 
void registerPPCallbacks (const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP) override
 Override this to register PPCallbacks in the preprocessor. More...
 
void registerMatchers (ast_matchers::MatchFinder *Finder) final
 Override this to register AST matchers with Finder. More...
 
void check (const ast_matchers::MatchFinder::MatchResult &Result) final
 ClangTidyChecks that register ASTMatchers should do the actual work in here. More...
 
void storeOptions (ClangTidyOptions::OptionMap &Opts) override
 Derived classes that override this function should call this method from the overridden method. More...
 
void setRule (transformer::RewriteRule R)
 Set the rule that this check implements. 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

A base class for defining a ClangTidy check based on a RewriteRule.

Definition at line 39 of file TransformerClangTidyCheck.h.

Constructor & Destructor Documentation

◆ TransformerClangTidyCheck() [1/3]

clang::tidy::utils::TransformerClangTidyCheck::TransformerClangTidyCheck ( StringRef  Name,
ClangTidyContext Context 
)

Definition at line 30 of file TransformerClangTidyCheck.cpp.

◆ TransformerClangTidyCheck() [2/3]

clang::tidy::utils::TransformerClangTidyCheck::TransformerClangTidyCheck ( std::function< Optional< transformer::RewriteRule >(const LangOptions &, const OptionsView &)>  MakeRule,
StringRef  Name,
ClangTidyContext Context 
)

DEPRECATED: prefer the two argument constructor in conjunction with setRule.

MakeRule generates the rewrite rule to be used by the check, based on the given language and clang-tidy options. It can return None to handle cases where the options disable the check.

See setRule for constraints on the rule.

◆ TransformerClangTidyCheck() [3/3]

clang::tidy::utils::TransformerClangTidyCheck::TransformerClangTidyCheck ( transformer::RewriteRule  R,
StringRef  Name,
ClangTidyContext Context 
)

Convenience overload of the constructor when the rule doesn't have any dependencies.

Member Function Documentation

◆ check()

void clang::tidy::utils::TransformerClangTidyCheck::check ( const ast_matchers::MatchFinder::MatchResult &  Result)
finalvirtual

ClangTidyChecks that register ASTMatchers should do the actual work in here.

Reimplemented from clang::tidy::ClangTidyCheck.

Definition at line 75 of file TransformerClangTidyCheck.cpp.

◆ registerMatchers()

void clang::tidy::utils::TransformerClangTidyCheck::registerMatchers ( ast_matchers::MatchFinder *  Finder)
finalvirtual

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 68 of file TransformerClangTidyCheck.cpp.

◆ registerPPCallbacks()

void clang::tidy::utils::TransformerClangTidyCheck::registerPPCallbacks ( const SourceManager &  SM,
Preprocessor *  PP,
Preprocessor *  ModuleExpanderPP 
)
overridevirtual

Override this to register PPCallbacks in the preprocessor.

This should be used for clang-tidy checks that analyze preprocessor- dependent properties, e.g. include directives and macro definitions.

This will only be executed if the function isLanguageVersionSupported returns true.

There are two Preprocessors to choose from that differ in how they handle modular #includes:

  • PP is the real Preprocessor. It doesn't walk into modular #includes and thus doesn't generate PPCallbacks for their contents.
  • ModuleExpanderPP preprocesses the whole translation unit in the non-modular mode, which allows it to generate PPCallbacks not only for the main file and textual headers, but also for all transitively included modular headers when the analysis runs with modules enabled. When modules are not enabled ModuleExpanderPP just points to the real preprocessor.

Reimplemented from clang::tidy::ClangTidyCheck.

Definition at line 63 of file TransformerClangTidyCheck.cpp.

◆ setRule()

void clang::tidy::utils::TransformerClangTidyCheck::setRule ( transformer::RewriteRule  R)

Set the rule that this check implements.

All cases in the rule must have a non-null Explanation, even though Explanation is optional for RewriteRule in general. Because the primary purpose of clang-tidy checks is to provide users with diagnostics, we assume that a missing explanation is a bug. If no explanation is desired, indicate that explicitly (for example, by passing text("no explanation") to makeRule as the Explanation argument).

Definition at line 58 of file TransformerClangTidyCheck.cpp.

References clang::tidy::utils::verifyRule().

◆ storeOptions()

void clang::tidy::utils::TransformerClangTidyCheck::storeOptions ( ClangTidyOptions::OptionMap Opts)
overridevirtual

Derived classes that override this function should call this method from the overridden method.

Reimplemented from clang::tidy::ClangTidyCheck.

Definition at line 113 of file TransformerClangTidyCheck.cpp.


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