clang-tools
5.0.0
|
Finds and fixes header guards that do not adhere to LLVM style. More...
#include <HeaderGuardCheck.h>
Public Member Functions | |
LLVMHeaderGuardCheck (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... | |
bool | shouldSuggestEndifComment (StringRef Filename) override |
Returns true if the check should suggest inserting a trailing comment on the #endif of the header guard. More... | |
bool | shouldFixHeaderGuard (StringRef Filename) override |
Returns true if the check should suggest changing an existing header guard to the string returned by HeaderGuardCheck::getHeaderGuard . More... | |
std::string | getHeaderGuard (StringRef Filename, StringRef OldGuard) override |
Gets the canonical header guard for a file. More... | |
![]() | |
HeaderGuardCheck (StringRef Name, ClangTidyContext *Context) | |
void | registerPPCallbacks (CompilerInstance &Compiler) override |
Override this to register PPCallbacks with Compiler . More... | |
virtual bool | shouldSuggestToAddHeaderGuard (StringRef Filename) |
Returns true if the check should add a header guard to the file if it has none. More... | |
virtual std::string | formatEndIf (StringRef HeaderGuard) |
Returns a replacement for the #endif line with a comment mentioning HeaderGuard . More... | |
![]() | |
ClangTidyCheck (StringRef CheckName, ClangTidyContext *Context) | |
Initializes the check with CheckName and Context . More... | |
virtual void | registerMatchers (ast_matchers::MatchFinder *Finder) |
Override this to register AST matchers with Finder . More... | |
virtual void | check (const ast_matchers::MatchFinder::MatchResult &Result) |
ClangTidyChecks that register ASTMatchers should do the actual work in here. More... | |
DiagnosticBuilder | diag (SourceLocation Loc, StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning) |
Add a diagnostic with the check's name. More... | |
Additional Inherited Members | |
![]() | |
StringRef | getCurrentMainFile () const |
Returns the main file name of the current translation unit. More... | |
LangOptions | getLangOpts () const |
Returns the language options from the context. More... | |
![]() | |
OptionsView | Options |
Finds and fixes header guards that do not adhere to LLVM style.
For the user-facing documentation see: http://clang.llvm.org/extra/clang-tidy/checks/llvm-header-guard.html The check supports these options:
HeaderFileExtensions
: a comma-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 28 of file HeaderGuardCheck.h.
clang::tidy::llvm::LLVMHeaderGuardCheck::LLVMHeaderGuardCheck | ( | StringRef | Name, |
ClangTidyContext * | Context | ||
) |
Definition at line 16 of file HeaderGuardCheck.cpp.
References clang::tidy::utils::parseHeaderFileExtensions().
|
overridevirtual |
Gets the canonical header guard for a file.
Implements clang::tidy::utils::HeaderGuardCheck.
Definition at line 33 of file HeaderGuardCheck.cpp.
|
overridevirtual |
Returns true
if the check should suggest changing an existing header guard to the string returned by HeaderGuardCheck::getHeaderGuard
.
Reimplemented from clang::tidy::utils::HeaderGuardCheck.
Definition at line 29 of file HeaderGuardCheck.cpp.
References clang::tidy::utils::isHeaderFileExtension().
|
inlineoverridevirtual |
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 from clang::tidy::utils::HeaderGuardCheck.
Definition at line 33 of file HeaderGuardCheck.h.
|
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 25 of file HeaderGuardCheck.cpp.
References clang::tidy::ClangTidyCheck::Options, and clang::tidy::OptionsView::store().