clang-tools  3.8.0
Public Member Functions | List of all members
clang::tidy::HeaderGuardCheck Class Referenceabstract

Finds and fixes header guards. More...

#include <HeaderGuard.h>

Inheritance diagram for clang::tidy::HeaderGuardCheck:
[legend]
Collaboration diagram for clang::tidy::HeaderGuardCheck:
[legend]

Public Member Functions

 HeaderGuardCheck (StringRef Name, ClangTidyContext *Context)
 
void registerPPCallbacks (CompilerInstance &Compiler) override
 Override this to register PPCallbacks with Compiler. More...
 
virtual bool shouldSuggestEndifComment (StringRef Filename)
 Returns true if the checker should suggest inserting a trailing comment on the #endif of the header guard. More...
 
virtual bool shouldFixHeaderGuard (StringRef Filename)
 Returns true if the checker should suggest changing an existing header guard to the string returned by getHeaderGuard. More...
 
virtual bool shouldSuggestToAddHeaderGuard (StringRef Filename)
 Returns true if the checker should add a header guard to the file if it has none. More...
 
virtual std::string formatEndIf (StringRef HeaderGuard)
 Returns a replacement for endif line with a comment mentioning HeaderGuard. More...
 
virtual std::string getHeaderGuard (StringRef Filename, StringRef OldGuard=StringRef())=0
 Get the canonical header guard for a file. More...
 
- Public Member Functions inherited from clang::tidy::ClangTidyCheck
 ClangTidyCheck (StringRef CheckName, ClangTidyContext *Context)
 Initializes the check with CheckName and Context. More...
 
virtual void registerMatchers (ast_matchers::MatchFinder *Finder)
 Override this to register ASTMatchers 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...
 
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. 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...
 
LangOptions getLangOpts () const
 Returns the language options from the context. More...
 
- Protected Attributes inherited from clang::tidy::ClangTidyCheck
OptionsView Options
 

Detailed Description

Finds and fixes header guards.

Definition at line 19 of file HeaderGuard.h.

Constructor & Destructor Documentation

clang::tidy::HeaderGuardCheck::HeaderGuardCheck ( StringRef  Name,
ClangTidyContext Context 
)
inline

Definition at line 21 of file HeaderGuard.h.

Member Function Documentation

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

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

The replacement should start with "endif".

Definition at line 298 of file HeaderGuard.cpp.

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

Get the canonical header guard for a file.

Implemented in clang::tidy::llvm::LLVMHeaderGuardCheck.

void clang::tidy::HeaderGuardCheck::registerPPCallbacks ( CompilerInstance &  Compiler)
overridevirtual

Override this to register PPCallbacks with Compiler.

This should be used for clang-tidy checks that analyze preprocessor- dependent properties, e.g. the order of include directives.

Reimplemented from clang::tidy::ClangTidyCheck.

Definition at line 282 of file HeaderGuard.cpp.

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

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

Reimplemented in clang::tidy::llvm::LLVMHeaderGuardCheck.

Definition at line 292 of file HeaderGuard.cpp.

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

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

It will use the same name as returned by getHeaderGuard.

Reimplemented in clang::tidy::llvm::LLVMHeaderGuardCheck.

Definition at line 288 of file HeaderGuard.cpp.

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

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

Definition at line 294 of file HeaderGuard.cpp.


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