clang-tools  6.0.0svn
Public Member Functions | List of all members
clang::tidy::llvm::LLVMHeaderGuardCheck Class Reference

Finds and fixes header guards that do not adhere to LLVM style. More...

#include <HeaderGuardCheck.h>

Inheritance diagram for clang::tidy::llvm::LLVMHeaderGuardCheck:
Inheritance graph
[legend]
Collaboration diagram for clang::tidy::llvm::LLVMHeaderGuardCheck:
Collaboration graph
[legend]

Public Member Functions

 LLVMHeaderGuardCheck (StringRef Name, ClangTidyContext *Context)
 
bool shouldSuggestEndifComment (StringRef Filename) override
 Returns true if the check should suggest inserting a trailing comment on the #endif of the header guard. More...
 
std::string getHeaderGuard (StringRef Filename, StringRef OldGuard) override
 Gets the canonical header guard for a file. More...
 
- Public Member Functions inherited from clang::tidy::utils::HeaderGuardCheck
 HeaderGuardCheck (StringRef Name, ClangTidyContext *Context)
 
void registerPPCallbacks (CompilerInstance &Compiler) override
 Override this to register PPCallbacks with Compiler. More...
 
virtual bool shouldFixHeaderGuard (StringRef Filename)
 Returns true if the check should suggest changing an existing header guard to the string returned by HeaderGuardCheck::getHeaderGuard. 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...
 
- 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 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...
 
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 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:

Definition at line 28 of file HeaderGuardCheck.h.

Constructor & Destructor Documentation

◆ LLVMHeaderGuardCheck()

clang::tidy::llvm::LLVMHeaderGuardCheck::LLVMHeaderGuardCheck ( StringRef  Name,
ClangTidyContext Context 
)

Definition at line 16 of file HeaderGuardCheck.cpp.

Member Function Documentation

◆ getHeaderGuard()

std::string clang::tidy::llvm::LLVMHeaderGuardCheck::getHeaderGuard ( StringRef  Filename,
StringRef  OldGuard 
)
overridevirtual

Gets the canonical header guard for a file.

Implements clang::tidy::utils::HeaderGuardCheck.

Definition at line 20 of file HeaderGuardCheck.cpp.

Referenced by shouldSuggestEndifComment().

◆ shouldSuggestEndifComment()

bool clang::tidy::llvm::LLVMHeaderGuardCheck::shouldSuggestEndifComment ( StringRef  Filename)
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 32 of file HeaderGuardCheck.h.

References Filename, and getHeaderGuard().


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