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

#include "clang/Frontend/TextDiagnosticPrinter.h"

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

Public Member Functions

 TextDiagnosticPrinter (raw_ostream &os, DiagnosticOptions *diags, bool OwnsOutputStream=false)
 
 ~TextDiagnosticPrinter () override
 
void setPrefix (std::string Value)
 setPrefix - Set the diagnostic printer prefix string, which will be printed at the start of any diagnostics. 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 HandleDiagnostic (DiagnosticsEngine::Level Level, 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 ()
 
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...
 

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

Definition at line 28 of file TextDiagnosticPrinter.h.

Constructor & Destructor Documentation

◆ TextDiagnosticPrinter()

TextDiagnosticPrinter::TextDiagnosticPrinter ( raw_ostream &  os,
DiagnosticOptions diags,
bool  OwnsOutputStream = false 
)

Definition at line 25 of file TextDiagnosticPrinter.cpp.

◆ ~TextDiagnosticPrinter()

TextDiagnosticPrinter::~TextDiagnosticPrinter ( )
override

Definition at line 32 of file TextDiagnosticPrinter.cpp.

Member Function Documentation

◆ BeginSourceFile()

void TextDiagnosticPrinter::BeginSourceFile ( const LangOptions LangOpts,
const Preprocessor PP 
)
overridevirtual

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 37 of file TextDiagnosticPrinter.cpp.

Referenced by emitPremigrationErrors(), and setPrefix().

◆ EndSourceFile()

void TextDiagnosticPrinter::EndSourceFile ( )
overridevirtual

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 43 of file TextDiagnosticPrinter.cpp.

Referenced by emitPremigrationErrors(), and setPrefix().

◆ HandleDiagnostic()

void TextDiagnosticPrinter::HandleDiagnostic ( DiagnosticsEngine::Level  DiagLevel,
const Diagnostic Info 
)
overridevirtual

◆ setPrefix()

void clang::TextDiagnosticPrinter::setPrefix ( std::string  Value)
inline

setPrefix - Set the diagnostic printer prefix string, which will be printed at the start of any diagnostics.

If empty, no prefix string is used.

Definition at line 48 of file TextDiagnosticPrinter.h.

References BeginSourceFile(), EndSourceFile(), and HandleDiagnostic().


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