clang  3.7.0
Public Member Functions | Protected Attributes | List of all members
clang::DiagnosticConsumer Class Reference

Abstract interface, implemented by clients of the front-end, which formats and prints fully processed diagnostics. More...

#include <Diagnostic.h>

Inheritance diagram for clang::DiagnosticConsumer:
[legend]
Collaboration diagram for clang::DiagnosticConsumer:
[legend]

Public Member Functions

 DiagnosticConsumer ()
 
unsigned getNumErrors () const
 
unsigned getNumWarnings () const
 
virtual void clear ()
 
virtual ~DiagnosticConsumer ()
 
virtual void BeginSourceFile (const LangOptions &LangOpts, const Preprocessor *PP=nullptr)
 Callback to inform the diagnostic client that processing of a source file is beginning. More...
 
virtual void EndSourceFile ()
 Callback to inform the diagnostic client that processing of a source file has ended. More...
 
virtual void finish ()
 Callback to inform the diagnostic client that processing of all source files has ended. More...
 
virtual bool IncludeInDiagnosticCounts () const
 Indicates whether the diagnostics handled by this DiagnosticConsumer should be included in the number of diagnostics reported by DiagnosticsEngine. More...
 
virtual void HandleDiagnostic (DiagnosticsEngine::Level DiagLevel, const Diagnostic &Info)
 Handle this diagnostic, reporting it to the user or capturing it to a log as needed. More...
 

Protected Attributes

unsigned NumWarnings
 Number of warnings reported. More...
 
unsigned NumErrors
 Number of errors reported. More...
 

Detailed Description

Abstract interface, implemented by clients of the front-end, which formats and prints fully processed diagnostics.

Definition at line 1309 of file Diagnostic.h.

Constructor & Destructor Documentation

clang::DiagnosticConsumer::DiagnosticConsumer ( )
inline

Definition at line 1315 of file Diagnostic.h.

DiagnosticConsumer::~DiagnosticConsumer ( )
virtual

Definition at line 396 of file Diagnostic.cpp.

Member Function Documentation

virtual void clang::DiagnosticConsumer::BeginSourceFile ( const LangOptions LangOpts,
const Preprocessor PP = nullptr 
)
inlinevirtual

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 in clang::VerifyDiagnosticConsumer, clang::LogDiagnosticPrinter, clang::TextDiagnosticPrinter, and clang::ChainedDiagnosticConsumer.

Definition at line 1334 of file Diagnostic.h.

Referenced by clang::arcmt::MigrationProcess::applyTransform(), clang::ChainedDiagnosticConsumer::BeginSourceFile(), clang::FrontendAction::BeginSourceFile(), clang::VerifyDiagnosticConsumer::BeginSourceFile(), clang::arcmt::checkForManualIssues(), and clang::ASTMergeAction::ExecuteAction().

virtual void clang::DiagnosticConsumer::clear ( )
inlinevirtual
virtual void clang::DiagnosticConsumer::EndSourceFile ( )
inlinevirtual
virtual void clang::DiagnosticConsumer::finish ( )
inlinevirtual

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

Reimplemented in clang::ChainedDiagnosticConsumer.

Definition at line 1346 of file Diagnostic.h.

Referenced by clang::CompilerInstance::ExecuteAction(), and clang::ChainedDiagnosticConsumer::finish().

unsigned clang::DiagnosticConsumer::getNumErrors ( ) const
inline
unsigned clang::DiagnosticConsumer::getNumWarnings ( ) const
inline

Definition at line 1318 of file Diagnostic.h.

References NumWarnings.

Referenced by clang::CompilerInstance::ExecuteAction().

void DiagnosticConsumer::HandleDiagnostic ( DiagnosticsEngine::Level  DiagLevel,
const Diagnostic Info 
)
virtual
bool DiagnosticConsumer::IncludeInDiagnosticCounts ( ) const
virtual

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 in clang::ForwardingDiagnosticConsumer, clang::FixItRewriter, and clang::ChainedDiagnosticConsumer.

Definition at line 984 of file Diagnostic.cpp.

Referenced by HandleDiagnostic(), clang::ChainedDiagnosticConsumer::IncludeInDiagnosticCounts(), clang::FixItRewriter::IncludeInDiagnosticCounts(), clang::ForwardingDiagnosticConsumer::IncludeInDiagnosticCounts(), and clang::DiagnosticsEngine::Report().

Member Data Documentation

unsigned clang::DiagnosticConsumer::NumErrors
protected

Number of errors reported.

Definition at line 1312 of file Diagnostic.h.

Referenced by clear(), getNumErrors(), and HandleDiagnostic().

unsigned clang::DiagnosticConsumer::NumWarnings
protected

Number of warnings reported.

Definition at line 1311 of file Diagnostic.h.

Referenced by clear(), getNumWarnings(), and HandleDiagnostic().


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