Finds and fixes header guards. More...

#include <HeaderGuard.h>

Inheritance diagram for clang::tidy::utils::HeaderGuardCheck:

[legend]

Public Member Functions
	HeaderGuardCheck (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.

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

std::string	sanitizeHeaderGuard (StringRef Guard)
	Ensure that the provided header guard is a non-reserved identifier.

virtual bool	shouldSuggestEndifComment (StringRef Filename)
	Returns `true` if the check should suggest inserting a trailing comment on the `#endif` of the header guard.

virtual bool	shouldFixHeaderGuard (StringRef Filename)
	Returns `true` if the check should suggest changing an existing header guard to the string returned by `HeaderGuardCheck::getHeaderGuard`.

virtual bool	shouldSuggestToAddHeaderGuard (StringRef Filename)
	Returns `true` if the check should add a header guard to the file if it has none.

virtual std::string	formatEndIf (StringRef HeaderGuard)
	Returns a replacement for the `#endif` line with a comment mentioning `HeaderGuard`.

virtual std::string	getHeaderGuard (StringRef Filename, StringRef OldGuard=StringRef())=0
	Gets the canonical header guard for a file.

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

Finds and fixes header guards.

The check supports these options:

HeaderFileExtensions: a semicolon-separated list of filename extensions of header files (The filename extension should not contain "." prefix). ";h;hh;hpp;hxx" by default.

For extension-less header files, using an empty string or leaving an empty string between ";" if there are other filename extensions.

Definition at line 25 of file HeaderGuard.h.

Constructor & Destructor Documentation

◆ HeaderGuardCheck()

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

inline

Definition at line 27 of file HeaderGuard.h.

References clang::tidy::ClangTidyCheck::configurationDiag(), clang::tidy::utils::defaultFileExtensionDelimiters(), clang::tidy::utils::defaultHeaderFileExtensions(), clang::tidy::ClangTidyCheck::OptionsView::get(), clang::tidy::ClangTidyCheck::Options, and clang::tidy::utils::parseFileExtensions().

Member Function Documentation

◆ formatEndIf()

std::string clang::tidy::utils::HeaderGuardCheck::formatEndIf ( StringRef HeaderGuard )

virtual

Returns a replacement for the #endif line with a comment mentioning HeaderGuard.

The replacement should start with endif.

Definition at line 296 of file HeaderGuard.cpp.

◆ getHeaderGuard()

virtual std::string clang::tidy::utils::HeaderGuardCheck::getHeaderGuard	(	StringRef	Filename,
		StringRef	OldGuard = `StringRef()`
	)

pure virtual

Gets the canonical header guard for a file.

Implemented in clang::tidy::llvm_check::LLVMHeaderGuardCheck.

◆ registerPPCallbacks()

void clang::tidy::utils::HeaderGuardCheck::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 275 of file HeaderGuard.cpp.

◆ sanitizeHeaderGuard()

std::string clang::tidy::utils::HeaderGuardCheck::sanitizeHeaderGuard ( StringRef Guard )

Ensure that the provided header guard is a non-reserved identifier.

Definition at line 281 of file HeaderGuard.cpp.

References C.

◆ shouldFixHeaderGuard()

bool clang::tidy::utils::HeaderGuardCheck::shouldFixHeaderGuard ( StringRef Filename )

virtual

Returns true if the check should suggest changing an existing header guard to the string returned by HeaderGuardCheck::getHeaderGuard.

Definition at line 290 of file HeaderGuard.cpp.

◆ shouldSuggestEndifComment()

bool clang::tidy::utils::HeaderGuardCheck::shouldSuggestEndifComment ( StringRef Filename )

virtual

Returns true if the check should suggest inserting a trailing comment on the #endif of the header guard.

It will use the same name as returned by HeaderGuardCheck::getHeaderGuard.

Reimplemented in clang::tidy::llvm_check::LLVMHeaderGuardCheck.

Definition at line 286 of file HeaderGuard.cpp.

References FileName, and clang::tidy::utils::isFileExtension().

◆ shouldSuggestToAddHeaderGuard()

bool clang::tidy::utils::HeaderGuardCheck::shouldSuggestToAddHeaderGuard ( StringRef Filename )

virtual

Returns true if the check should add a header guard to the file if it has none.

Definition at line 292 of file HeaderGuard.cpp.

References FileName, and clang::tidy::utils::isFileExtension().

◆ storeOptions()

void clang::tidy::utils::HeaderGuardCheck::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 271 of file HeaderGuard.cpp.

References clang::tidy::ClangTidyCheck::Options, and clang::tidy::ClangTidyCheck::OptionsView::store().

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HeaderGuardCheck()

Member Function Documentation

◆ formatEndIf()

◆ getHeaderGuard()

◆ registerPPCallbacks()

◆ sanitizeHeaderGuard()

◆ shouldFixHeaderGuard()

◆ shouldSuggestEndifComment()

◆ shouldSuggestToAddHeaderGuard()

◆ storeOptions()