clang::ento::CheckerFrontend Class Reference

A CheckerFrontend instance is what the user recognizes as "one checker": it has a public canonical name (injected from the CheckerManager), can be enabled or disabled, can have associated checker options and can be printed as the "source" of bug reports. More...

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

Inheritance diagram for clang::ento::CheckerFrontend:

Public Member Functions
void	enable (CheckerManager &Mgr)
bool	isEnabled () const
CheckerNameRef	getName () const

Detailed Description

A CheckerFrontend instance is what the user recognizes as "one checker": it has a public canonical name (injected from the CheckerManager), can be enabled or disabled, can have associated checker options and can be printed as the "source" of bug reports.

The singleton instance of a simple Checker<...> is-a CheckerFrontend (for historical reasons, to preserve old straightforward code), while the singleton instance of a CheckerFamily<...> class owns multiple CheckerFrontend instances as data members. Modeling checkers that are hidden from the user but can be enabled or disabled separately (as dependencies of other checkers) are also considered to be CheckerFrontends.

Definition at line 514 of file Checker.h.

Member Function Documentation

enable()

void clang::ento::CheckerFrontend::enable ( CheckerManager & Mgr )

inline

Definition at line 519 of file Checker.h.

References clang::ento::CheckerManager::getCurrentCheckerName().

getName()

CheckerNameRef clang::ento::CheckerFrontend::getName ( ) const

inline

Definition at line 524 of file Checker.h.

Referenced by clang::ento::BugReporter::EmitBasicReport(), clang::ento::CheckerBase::getDebugTag(), and clang::ento::CheckerManager::reportInvalidCheckerOptionValue().

isEnabled()

bool clang::ento::CheckerFrontend::isEnabled ( ) const

inline

Definition at line 523 of file Checker.h.

Referenced by clang::ento::CheckerRegistry::initializeRegistry().

---

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

• include/clang/StaticAnalyzer/Core/Checker.h