clang 22.0.0git
clang::ento::CheckerInfo Struct Reference

Specifies a checker. More...

#include "clang/StaticAnalyzer/Core/CheckerRegistryData.h"

Public Types

enum class  StateFromCmdLine { State_Unspecified , State_Disabled , State_Enabled }

Public Member Functions

bool isEnabled (const CheckerManager &mgr) const
bool isDisabled (const CheckerManager &mgr) const
bool operator== (const CheckerInfo &Rhs) const
 CheckerInfo (RegisterCheckerFn Fn, ShouldRegisterFunction sfn, StringRef Name, StringRef Desc, StringRef DocsUri, bool IsHidden)
 CheckerInfo (StringRef FullName)
LLVM_DUMP_METHOD void dump () const
LLVM_DUMP_METHOD void dumpToStream (llvm::raw_ostream &Out) const

Public Attributes

RegisterCheckerFn Initialize = nullptr
ShouldRegisterFunction ShouldRegister = nullptr
StringRef FullName
StringRef Desc
StringRef DocumentationUri
CmdLineOptionList CmdLineOptions
bool IsHidden = false
StateFromCmdLine State = StateFromCmdLine::State_Unspecified
ConstCheckerInfoList Dependencies
ConstCheckerInfoList WeakDependencies

Detailed Description

Specifies a checker.

Note that this isn't what we call a checker object, it merely contains everything required to create one.

Definition at line 94 of file CheckerRegistryData.h.

Member Enumeration Documentation

◆ StateFromCmdLine

Enumerator
State_Unspecified 
State_Disabled 
State_Enabled 

Definition at line 95 of file CheckerRegistryData.h.

Constructor & Destructor Documentation

◆ CheckerInfo() [1/2]

clang::ento::CheckerInfo::CheckerInfo ( RegisterCheckerFn Fn,
ShouldRegisterFunction sfn,
StringRef Name,
StringRef Desc,
StringRef DocsUri,
bool IsHidden )
inline

Definition at line 130 of file CheckerRegistryData.h.

References Desc, DocumentationUri, FullName, Initialize, IsHidden, and ShouldRegister.

Referenced by dumpToStream(), and operator==().

◆ CheckerInfo() [2/2]

clang::ento::CheckerInfo::CheckerInfo ( StringRef FullName)
inlineexplicit

Definition at line 136 of file CheckerRegistryData.h.

References FullName.

Member Function Documentation

◆ dump()

LLVM_DUMP_METHOD void CheckerInfo::dump ( ) const

Definition at line 46 of file CheckerRegistryData.cpp.

References dumpToStream().

◆ dumpToStream()

LLVM_DUMP_METHOD void CheckerInfo::dumpToStream ( llvm::raw_ostream & Out) const

Definition at line 48 of file CheckerRegistryData.cpp.

References CheckerInfo(), CmdLineOptions, Dependencies, FullName, IsHidden, State, toString(), and WeakDependencies.

Referenced by dump().

◆ isDisabled()

bool clang::ento::CheckerInfo::isDisabled ( const CheckerManager & mgr) const
inline

Definition at line 120 of file CheckerRegistryData.h.

References ShouldRegister, and State.

◆ isEnabled()

bool clang::ento::CheckerInfo::isEnabled ( const CheckerManager & mgr) const
inline

Definition at line 116 of file CheckerRegistryData.h.

References ShouldRegister, and State.

◆ operator==()

bool clang::ento::CheckerInfo::operator== ( const CheckerInfo & Rhs) const
inline

Definition at line 126 of file CheckerRegistryData.h.

References CheckerInfo(), and FullName.

Member Data Documentation

◆ CmdLineOptions

CmdLineOptionList clang::ento::CheckerInfo::CmdLineOptions

Definition at line 109 of file CheckerRegistryData.h.

Referenced by dumpToStream().

◆ Dependencies

ConstCheckerInfoList clang::ento::CheckerInfo::Dependencies

Definition at line 113 of file CheckerRegistryData.h.

Referenced by dumpToStream().

◆ Desc

StringRef clang::ento::CheckerInfo::Desc

Definition at line 107 of file CheckerRegistryData.h.

Referenced by CheckerInfo().

◆ DocumentationUri

StringRef clang::ento::CheckerInfo::DocumentationUri

Definition at line 108 of file CheckerRegistryData.h.

Referenced by CheckerInfo().

◆ FullName

StringRef clang::ento::CheckerInfo::FullName

Definition at line 106 of file CheckerRegistryData.h.

Referenced by CheckerInfo(), CheckerInfo(), dumpToStream(), and operator==().

◆ Initialize

RegisterCheckerFn clang::ento::CheckerInfo::Initialize = nullptr

Definition at line 104 of file CheckerRegistryData.h.

Referenced by CheckerInfo().

◆ IsHidden

bool clang::ento::CheckerInfo::IsHidden = false

Definition at line 110 of file CheckerRegistryData.h.

Referenced by CheckerInfo(), and dumpToStream().

◆ ShouldRegister

ShouldRegisterFunction clang::ento::CheckerInfo::ShouldRegister = nullptr

Definition at line 105 of file CheckerRegistryData.h.

Referenced by CheckerInfo(), isDisabled(), and isEnabled().

◆ State

StateFromCmdLine clang::ento::CheckerInfo::State = StateFromCmdLine::State_Unspecified

Definition at line 111 of file CheckerRegistryData.h.

Referenced by dumpToStream(), isDisabled(), and isEnabled().

◆ WeakDependencies

ConstCheckerInfoList clang::ento::CheckerInfo::WeakDependencies

Definition at line 114 of file CheckerRegistryData.h.

Referenced by dumpToStream().


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