clang  6.0.0svn
Public Member Functions | List of all members
clang::ChainedDiagnosticConsumer Class Reference

ChainedDiagnosticConsumer - Chain two diagnostic clients so that diagnostics go to the first client and then the second. More...

#include "clang/Frontend/ChainedDiagnosticConsumer.h"

Inheritance diagram for clang::ChainedDiagnosticConsumer:
Inheritance graph
[legend]
Collaboration diagram for clang::ChainedDiagnosticConsumer:
Collaboration graph
[legend]

Public Member Functions

 ChainedDiagnosticConsumer (std::unique_ptr< DiagnosticConsumer > Primary, std::unique_ptr< DiagnosticConsumer > Secondary)
 
 ChainedDiagnosticConsumer (DiagnosticConsumer *Primary, std::unique_ptr< DiagnosticConsumer > Secondary)
 Construct without taking ownership of Primary. More...
 
void BeginSourceFile (const LangOptions &LO, const Preprocessor *PP) override
 Callback to inform the diagnostic client that processing of a source file is beginning. More...
 
void EndSourceFile () override
 Callback to inform the diagnostic client that processing of a source file has ended. More...
 
void finish () override
 Callback to inform the diagnostic client that processing of all source files has ended. More...
 
bool IncludeInDiagnosticCounts () const override
 Indicates whether the diagnostics handled by this DiagnosticConsumer should be included in the number of diagnostics reported by DiagnosticsEngine. More...
 
void HandleDiagnostic (DiagnosticsEngine::Level DiagLevel, const Diagnostic &Info) override
 Handle this diagnostic, reporting it to the user or capturing it to a log as needed. More...
 
- Public Member Functions inherited from clang::DiagnosticConsumer
 DiagnosticConsumer ()=default
 
virtual ~DiagnosticConsumer ()
 
unsigned getNumErrors () const
 
unsigned getNumWarnings () const
 
virtual void clear ()
 

Additional Inherited Members

- Protected Attributes inherited from clang::DiagnosticConsumer
unsigned NumWarnings = 0
 Number of warnings reported. More...
 
unsigned NumErrors = 0
 Number of errors reported. More...
 

Detailed Description

ChainedDiagnosticConsumer - Chain two diagnostic clients so that diagnostics go to the first client and then the second.

The first diagnostic client should be the "primary" client, and will be used for computing whether the diagnostics should be included in counts.

Definition at line 23 of file ChainedDiagnosticConsumer.h.

Constructor & Destructor Documentation

◆ ChainedDiagnosticConsumer() [1/2]

clang::ChainedDiagnosticConsumer::ChainedDiagnosticConsumer ( std::unique_ptr< DiagnosticConsumer Primary,
std::unique_ptr< DiagnosticConsumer Secondary 
)
inline

Definition at line 30 of file ChainedDiagnosticConsumer.h.

◆ ChainedDiagnosticConsumer() [2/2]

clang::ChainedDiagnosticConsumer::ChainedDiagnosticConsumer ( DiagnosticConsumer Primary,
std::unique_ptr< DiagnosticConsumer Secondary 
)
inline

Construct without taking ownership of Primary.

Definition at line 36 of file ChainedDiagnosticConsumer.h.

Member Function Documentation

◆ BeginSourceFile()

void clang::ChainedDiagnosticConsumer::BeginSourceFile ( const LangOptions LangOpts,
const Preprocessor PP 
)
inlineoverridevirtual

Callback to inform the diagnostic client that processing of a source file is beginning.

Note that diagnostics may be emitted outside the processing of a source file, for example during the parsing of command line options. However, diagnostics with source range information are required to only be emitted in between BeginSourceFile() and EndSourceFile().

Parameters
LangOptsThe language options for the source file being processed.
PPThe preprocessor object being used for the source; this is optional, e.g., it may not be present when processing AST source files.

Reimplemented from clang::DiagnosticConsumer.

Definition at line 40 of file ChainedDiagnosticConsumer.h.

References clang::DiagnosticConsumer::BeginSourceFile().

◆ EndSourceFile()

void clang::ChainedDiagnosticConsumer::EndSourceFile ( )
inlineoverridevirtual

Callback to inform the diagnostic client that processing of a source file has ended.

The diagnostic client should assume that any objects made available via BeginSourceFile() are inaccessible.

Reimplemented from clang::DiagnosticConsumer.

Definition at line 46 of file ChainedDiagnosticConsumer.h.

References clang::DiagnosticConsumer::EndSourceFile().

◆ finish()

void clang::ChainedDiagnosticConsumer::finish ( )
inlineoverridevirtual

Callback to inform the diagnostic client that processing of all source files has ended.

Reimplemented from clang::DiagnosticConsumer.

Definition at line 51 of file ChainedDiagnosticConsumer.h.

References clang::DiagnosticConsumer::finish().

◆ HandleDiagnostic()

void clang::ChainedDiagnosticConsumer::HandleDiagnostic ( DiagnosticsEngine::Level  DiagLevel,
const Diagnostic Info 
)
inlineoverridevirtual

Handle this diagnostic, reporting it to the user or capturing it to a log as needed.

The default implementation just keeps track of the total number of warnings and errors.

Reimplemented from clang::DiagnosticConsumer.

Definition at line 60 of file ChainedDiagnosticConsumer.h.

References clang::DiagnosticConsumer::HandleDiagnostic().

◆ IncludeInDiagnosticCounts()

bool clang::ChainedDiagnosticConsumer::IncludeInDiagnosticCounts ( ) const
inlineoverridevirtual

Indicates whether the diagnostics handled by this DiagnosticConsumer should be included in the number of diagnostics reported by DiagnosticsEngine.

IncludeInDiagnosticCounts - This method (whose default implementation returns true) indicates whether the diagnostics handled by this DiagnosticConsumer should be included in the number of diagnostics reported by DiagnosticsEngine.

The default implementation returns true.

Reimplemented from clang::DiagnosticConsumer.

Definition at line 56 of file ChainedDiagnosticConsumer.h.

References clang::DiagnosticConsumer::IncludeInDiagnosticCounts().


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