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

#include <TransformerClangTidyCheck.h>

Inheritance diagram for clang::tidy::utils::TransformerClangTidyCheck:

[legend]

Public Member Functions
	TransformerClangTidyCheck (StringRef Name, ClangTidyContext *Context)

	TransformerClangTidyCheck (std::function< std::optional< transformer::RewriteRuleWith< std::string > >(const LangOptions &, const OptionsView &)> MakeRule, StringRef Name, ClangTidyContext *Context)
	DEPRECATED: prefer the two argument constructor in conjunction with `setRule`.

	TransformerClangTidyCheck (transformer::RewriteRuleWith< std::string > R, StringRef Name, ClangTidyContext *Context)
	Convenience overload of the constructor when the rule doesn't have any dependencies.

void	registerPPCallbacks (const SourceManager &SM, Preprocessor PP, Preprocessor ModuleExpanderPP) override
	Override this to register `PPCallbacks` in the preprocessor.

void	registerMatchers (ast_matchers::MatchFinder *Finder) final
	Override this to register AST matchers with `Finder`.

void	check (const ast_matchers::MatchFinder::MatchResult &Result) final
	`ClangTidyChecks` that register ASTMatchers should do the actual work in here.

void	storeOptions (ClangTidyOptions::OptionMap &Opts) override
	Derived classes that override this function should call this method from the overridden method.

void	setRule (transformer::RewriteRuleWith< std::string > R)
	Set the rule that this check implements.

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

Detailed Description

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

Definition at line 38 of file TransformerClangTidyCheck.h.

Constructor & Destructor Documentation

◆ TransformerClangTidyCheck() [1/3]

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

Definition at line 57 of file TransformerClangTidyCheck.cpp.

◆ TransformerClangTidyCheck() [2/3]

clang::tidy::utils::TransformerClangTidyCheck::TransformerClangTidyCheck	(	std::function< std::optional< transformer::RewriteRuleWith< std::string > >(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 std::nullopt 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::RewriteRuleWith< std::string >	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 103 of file TransformerClangTidyCheck.cpp.

References clang::tidy::utils::IncludeInserter::createIncludeInsertion(), clang::tidy::ClangTidyCheck::diag(), clang::tidy::utils::escapeForDiagnostic(), and Range.

◆ 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 96 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 91 of file TransformerClangTidyCheck.cpp.

References clang::tidy::utils::IncludeInserter::registerPreprocessor().

◆ setRule()

void clang::tidy::utils::TransformerClangTidyCheck::setRule ( transformer::RewriteRuleWith< std::string > 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 85 of file TransformerClangTidyCheck.cpp.

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

Referenced by clang::tidy::abseil::StringFindStrContainsCheck::StringFindStrContainsCheck().