clang-tools  9.0.0svn
Classes | Public Member Functions | Friends | List of all members
clang::tidy::ClangTidyContext Class Reference

Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context. More...

#include <ClangTidyDiagnosticConsumer.h>

Classes

class  CachedGlobList
 

Public Member Functions

 ClangTidyContext (std::unique_ptr< ClangTidyOptionsProvider > OptionsProvider, bool AllowEnablingAnalyzerAlphaCheckers=false)
 Initializes ClangTidyContext instance. More...
 
void setDiagnosticsEngine (DiagnosticsEngine *DiagEngine)
 Sets the DiagnosticsEngine that diag() will emit diagnostics to. More...
 
 ~ClangTidyContext ()
 
DiagnosticBuilder diag (StringRef CheckName, SourceLocation Loc, StringRef Message, DiagnosticIDs::Level Level=DiagnosticIDs::Warning)
 Report any errors detected using this method. More...
 
void setSourceManager (SourceManager *SourceMgr)
 Sets the SourceManager of the used DiagnosticsEngine. More...
 
void setCurrentFile (StringRef File)
 Should be called when starting to process new translation unit. More...
 
StringRef getCurrentFile () const
 Returns the main file name of the current translation unit. More...
 
void setASTContext (ASTContext *Context)
 Sets ASTContext for the current translation unit. More...
 
const LangOptions & getLangOpts () const
 Gets the language options from the AST context. More...
 
StringRef getCheckName (unsigned DiagnosticID) const
 Returns the name of the clang-tidy check which produced this diagnostic ID. More...
 
bool isCheckEnabled (StringRef CheckName) const
 Returns true if the check is enabled for the CurrentFile. More...
 
bool treatAsError (StringRef CheckName) const
 Returns true if the check should be upgraded to error for the CurrentFile. More...
 
const ClangTidyGlobalOptionsgetGlobalOptions () const
 Returns global options. More...
 
const ClangTidyOptionsgetOptions () const
 Returns options for CurrentFile. More...
 
ClangTidyOptions getOptionsForFile (StringRef File) const
 Returns options for File. More...
 
const ClangTidyStatsgetStats () const
 Returns ClangTidyStats containing issued and ignored diagnostic counters. More...
 
void setEnableProfiling (bool Profile)
 Control profile collection in clang-tidy. More...
 
bool getEnableProfiling () const
 
void setProfileStoragePrefix (StringRef ProfilePrefix)
 Control storage of profile date. More...
 
llvm::Optional< ClangTidyProfiling::StorageParamsgetProfileStorageParams () const
 
void setCurrentBuildDirectory (StringRef BuildDirectory)
 Should be called when starting to process new translation unit. More...
 
const std::string & getCurrentBuildDirectory ()
 Returns build directory of the current translation unit. More...
 
bool canEnableAnalyzerAlphaCheckers () const
 If the experimental alpha checkers from the static analyzer can be enabled. More...
 

Friends

class ClangTidyDiagnosticConsumer
 

Detailed Description

Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.

A ClangTidyCheck always has access to the active context to report warnings like:

Context->Diag(Loc, "Single-argument constructors must be explicit")
<< FixItHint::CreateInsertion(Loc, "explicit ");

Definition at line 99 of file ClangTidyDiagnosticConsumer.h.

Constructor & Destructor Documentation

◆ ClangTidyContext()

ClangTidyContext::ClangTidyContext ( std::unique_ptr< ClangTidyOptionsProvider OptionsProvider,
bool  AllowEnablingAnalyzerAlphaCheckers = false 
)

Initializes ClangTidyContext instance.

Definition at line 178 of file ClangTidyDiagnosticConsumer.cpp.

References setCurrentFile(), and ~ClangTidyContext().

◆ ~ClangTidyContext()

ClangTidyContext::~ClangTidyContext ( )
default

Referenced by ClangTidyContext().

Member Function Documentation

◆ canEnableAnalyzerAlphaCheckers()

bool clang::tidy::ClangTidyContext::canEnableAnalyzerAlphaCheckers ( ) const
inline

If the experimental alpha checkers from the static analyzer can be enabled.

Definition at line 189 of file ClangTidyDiagnosticConsumer.h.

References AllowEnablingAnalyzerAlphaCheckers().

Referenced by clang::tidy::ClangTidyASTConsumerFactory::getCheckNames().

◆ diag()

DiagnosticBuilder ClangTidyContext::diag ( StringRef  CheckName,
SourceLocation  Loc,
StringRef  Message,
DiagnosticIDs::Level  Level = DiagnosticIDs::Warning 
)

Report any errors detected using this method.

This is still under heavy development and will likely change towards using tablegen'd diagnostic IDs. FIXME: Figure out a way to manage ID spaces.

Definition at line 191 of file ClangTidyDiagnosticConsumer.cpp.

Referenced by clang::tidy::ClangTidyCheck::diag().

◆ getCheckName()

StringRef ClangTidyContext::getCheckName ( unsigned  DiagnosticID) const

Returns the name of the clang-tidy check which produced this diagnostic ID.

Definition at line 257 of file ClangTidyDiagnosticConsumer.cpp.

Referenced by clang::tidy::ClangTidyDiagnosticConsumer::HandleDiagnostic(), and IsNOLINTFound().

◆ getCurrentBuildDirectory()

const std::string& clang::tidy::ClangTidyContext::getCurrentBuildDirectory ( )
inline

Returns build directory of the current translation unit.

Definition at line 183 of file ClangTidyDiagnosticConsumer.h.

Referenced by clang::tidy::ClangTidyDiagnosticConsumer::HandleDiagnostic().

◆ getCurrentFile()

StringRef clang::tidy::ClangTidyContext::getCurrentFile ( ) const
inline

Returns the main file name of the current translation unit.

Definition at line 131 of file ClangTidyDiagnosticConsumer.h.

Referenced by clang::tidy::ClangTidyCheck::getCurrentMainFile().

◆ getEnableProfiling()

bool clang::tidy::ClangTidyContext::getEnableProfiling ( ) const
inline

Definition at line 170 of file ClangTidyDiagnosticConsumer.h.

◆ getGlobalOptions()

const ClangTidyGlobalOptions & ClangTidyContext::getGlobalOptions ( ) const

Returns global options.

Definition at line 218 of file ClangTidyDiagnosticConsumer.cpp.

Referenced by clang::tidy::ClangTidyDiagnosticConsumer::HandleDiagnostic().

◆ getLangOpts()

const LangOptions& clang::tidy::ClangTidyContext::getLangOpts ( ) const
inline

Gets the language options from the AST context.

Definition at line 137 of file ClangTidyDiagnosticConsumer.h.

Referenced by clang::tidy::ClangTidyCheck::getLangOpts(), and clang::tidy::ClangTidyDiagnosticConsumer::HandleDiagnostic().

◆ getOptions()

const ClangTidyOptions & ClangTidyContext::getOptions ( ) const

Returns options for CurrentFile.

The CurrentFile can be changed using setCurrentFile.

Definition at line 222 of file ClangTidyDiagnosticConsumer.cpp.

Referenced by setCurrentFile().

◆ getOptionsForFile()

ClangTidyOptions ClangTidyContext::getOptionsForFile ( StringRef  File) const

Returns options for File.

Does not change or depend on CurrentFile.

Definition at line 226 of file ClangTidyDiagnosticConsumer.cpp.

References clang::tidy::ClangTidyOptions::getDefaults(), and clang::tidy::ClangTidyOptions::mergeWith().

Referenced by setCurrentFile().

◆ getProfileStorageParams()

llvm::Optional< ClangTidyProfiling::StorageParams > ClangTidyContext::getProfileStorageParams ( ) const

Definition at line 240 of file ClangTidyDiagnosticConsumer.cpp.

◆ getStats()

const ClangTidyStats& clang::tidy::ClangTidyContext::getStats ( ) const
inline

Returns ClangTidyStats containing issued and ignored diagnostic counters.

Definition at line 166 of file ClangTidyDiagnosticConsumer.h.

◆ isCheckEnabled()

bool ClangTidyContext::isCheckEnabled ( StringRef  CheckName) const

Returns true if the check is enabled for the CurrentFile.

The CurrentFile can be changed using setCurrentFile.

Definition at line 247 of file ClangTidyDiagnosticConsumer.cpp.

Referenced by clang::tidy::ClangTidyASTConsumerFactory::getCheckNames().

◆ setASTContext()

void ClangTidyContext::setASTContext ( ASTContext *  Context)

Sets ASTContext for the current translation unit.

Definition at line 213 of file ClangTidyDiagnosticConsumer.cpp.

Referenced by clang::tidy::ClangTidyASTConsumerFactory::CreateASTConsumer().

◆ setCurrentBuildDirectory()

void clang::tidy::ClangTidyContext::setCurrentBuildDirectory ( StringRef  BuildDirectory)
inline

Should be called when starting to process new translation unit.

Definition at line 178 of file ClangTidyDiagnosticConsumer.h.

Referenced by clang::tidy::ClangTidyASTConsumerFactory::CreateASTConsumer().

◆ setCurrentFile()

void ClangTidyContext::setCurrentFile ( StringRef  File)

◆ setDiagnosticsEngine()

void clang::tidy::ClangTidyContext::setDiagnosticsEngine ( DiagnosticsEngine *  DiagEngine)
inline

Sets the DiagnosticsEngine that diag() will emit diagnostics to.

Definition at line 107 of file ClangTidyDiagnosticConsumer.h.

References Loc, and clang::tidy::modernize::Message.

◆ setEnableProfiling()

void ClangTidyContext::setEnableProfiling ( bool  Profile)

Control profile collection in clang-tidy.

Definition at line 233 of file ClangTidyDiagnosticConsumer.cpp.

◆ setProfileStoragePrefix()

void ClangTidyContext::setProfileStoragePrefix ( StringRef  ProfilePrefix)

Control storage of profile date.

Definition at line 235 of file ClangTidyDiagnosticConsumer.cpp.

◆ setSourceManager()

void ClangTidyContext::setSourceManager ( SourceManager *  SourceMgr)

Sets the SourceManager of the used DiagnosticsEngine.

This is called from the ClangTidyCheck base class.

Definition at line 201 of file ClangTidyDiagnosticConsumer.cpp.

Referenced by clang::tidy::ClangTidyASTConsumerFactory::CreateASTConsumer().

◆ treatAsError()

bool ClangTidyContext::treatAsError ( StringRef  CheckName) const

Returns true if the check should be upgraded to error for the CurrentFile.

Definition at line 252 of file ClangTidyDiagnosticConsumer.cpp.

Referenced by clang::tidy::ClangTidyDiagnosticConsumer::HandleDiagnostic().

Friends And Related Function Documentation

◆ ClangTidyDiagnosticConsumer

friend class ClangTidyDiagnosticConsumer
friend

Definition at line 195 of file ClangTidyDiagnosticConsumer.h.


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