clang API Documentation

Public Member Functions
clang::ChainedDiagnosticConsumer Class Reference

#include <ChainedDiagnosticConsumer.h>

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

List of all members.

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.
void BeginSourceFile (const LangOptions &LO, const Preprocessor *PP) override
 Callback to inform the diagnostic client that processing of a source file is beginning.
void EndSourceFile () override
 Callback to inform the diagnostic client that processing of a source file has ended.
void finish () override
 Callback to inform the diagnostic client that processing of all source files has ended.
bool IncludeInDiagnosticCounts () const override
 Indicates whether the diagnostics handled by this DiagnosticConsumer should be included in the number of diagnostics reported by DiagnosticsEngine.
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.

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

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

Definition at line 30 of file ChainedDiagnosticConsumer.h.

Construct without taking ownership of Primary.

Definition at line 36 of file ChainedDiagnosticConsumer.h.


Member Function Documentation

void clang::ChainedDiagnosticConsumer::BeginSourceFile ( const LangOptions LangOpts,
const Preprocessor PP 
) [inline, override, virtual]

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().

void clang::ChainedDiagnosticConsumer::EndSourceFile ( ) [inline, override, virtual]

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().

void clang::ChainedDiagnosticConsumer::finish ( ) [inline, override, virtual]

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().

void clang::ChainedDiagnosticConsumer::HandleDiagnostic ( DiagnosticsEngine::Level  DiagLevel,
const Diagnostic Info 
) [inline, override, virtual]

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().

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

The default implementation returns true.

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.

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: