A little helper class used to produce diagnostics. More...
#include <Diagnostic.h>
Public Member Functions | |
| DiagnosticBuilder (const DiagnosticBuilder &D) | |
| ~DiagnosticBuilder () | |
| Emits the diagnostic. | |
| const DiagnosticBuilder & | setForceEmit () const |
| Forces the diagnostic to be emitted. | |
| operator bool () const | |
Conversion of DiagnosticBuilder to bool always returns true. | |
| void | AddString (StringRef S) const |
| void | AddTaggedVal (intptr_t V, DiagnosticsEngine::ArgumentKind Kind) const |
| void | AddSourceRange (const CharSourceRange &R) const |
| void | AddFixItHint (const FixItHint &Hint) const |
| void | addFlagValue (StringRef V) const |
Static Public Member Functions | |
| static DiagnosticBuilder | getEmpty () |
| Retrieve an empty diagnostic builder. | |
Protected Member Functions | |
| void | FlushCounts () |
| void | Clear () const |
| Clear out the current diagnostic. | |
| bool | isActive () const |
| Determine whether this diagnostic is still active. | |
| bool | Emit () |
| Force the diagnostic builder to emit the diagnostic now. | |
Friends | |
| class | DiagnosticsEngine |
| class | PartialDiagnostic |
Detailed Description
A little helper class used to produce diagnostics.
This is constructed by the DiagnosticsEngine::Report method, and allows insertion of extra information (arguments and source ranges) into the currently "in flight" diagnostic. When the temporary for the builder is destroyed, the diagnostic is issued.
Note that many of these will be created as temporary objects (many call sites), so we want them to be small and we never want their address taken. This ensures that compilers with somewhat reasonable optimizers will promote the common fields to registers, eliminating increments of the NumArgs field, for example.
Definition at line 864 of file Diagnostic.h.
Constructor & Destructor Documentation
| clang::DiagnosticBuilder::DiagnosticBuilder | ( | const DiagnosticBuilder & | D | ) | [inline] |
Copy constructor. When copied, this "takes" the diagnostic info from the input and neuters it.
Definition at line 937 of file Diagnostic.h.
References Clear().
| clang::DiagnosticBuilder::~DiagnosticBuilder | ( | ) | [inline] |
Member Function Documentation
| void clang::DiagnosticBuilder::AddFixItHint | ( | const FixItHint & | Hint | ) | const [inline] |
Definition at line 991 of file Diagnostic.h.
References isActive().
Referenced by addFixitForObjCARCConversion(), applyCocoaAPICheck(), clang::PartialDiagnostic::Emit(), and clang::operator<<().
| void clang::DiagnosticBuilder::addFlagValue | ( | StringRef | V | ) | const [inline] |
Definition at line 996 of file Diagnostic.h.
Referenced by clang::operator<<().
| void clang::DiagnosticBuilder::AddSourceRange | ( | const CharSourceRange & | R | ) | const [inline] |
Definition at line 986 of file Diagnostic.h.
References isActive().
Referenced by clang::PartialDiagnostic::Emit(), and clang::operator<<().
| void clang::DiagnosticBuilder::AddString | ( | StringRef | S | ) | const [inline] |
Definition at line 970 of file Diagnostic.h.
References clang::DiagnosticsEngine::ak_std_string, isActive(), and S.
Referenced by clang::PartialDiagnostic::Emit(), and clang::operator<<().
| void clang::DiagnosticBuilder::AddTaggedVal | ( | intptr_t | V, |
| DiagnosticsEngine::ArgumentKind | Kind | ||
| ) | const [inline] |
Definition at line 978 of file Diagnostic.h.
References isActive().
Referenced by clang::PartialDiagnostic::Emit(), and clang::operator<<().
| void clang::DiagnosticBuilder::Clear | ( | ) | const [inline, protected] |
Clear out the current diagnostic.
Definition at line 900 of file Diagnostic.h.
Referenced by DiagnosticBuilder(), Emit(), and clang::Sema::SemaDiagnosticBuilder::~SemaDiagnosticBuilder().
| bool clang::DiagnosticBuilder::Emit | ( | ) | [inline, protected] |
Force the diagnostic builder to emit the diagnostic now.
Once this function has been called, the DiagnosticBuilder object should not be used again before it is destroyed.
- Returns:
- true if a diagnostic was emitted, false if the diagnostic was suppressed.
Definition at line 916 of file Diagnostic.h.
References Clear(), clang::DiagnosticsEngine::EmitCurrentDiagnostic(), FlushCounts(), and isActive().
Referenced by ~DiagnosticBuilder().
| void clang::DiagnosticBuilder::FlushCounts | ( | ) | [inline, protected] |
Definition at line 895 of file Diagnostic.h.
Referenced by Emit(), and clang::Sema::SemaDiagnosticBuilder::~SemaDiagnosticBuilder().
| static DiagnosticBuilder clang::DiagnosticBuilder::getEmpty | ( | ) | [inline, static] |
Retrieve an empty diagnostic builder.
Definition at line 946 of file Diagnostic.h.
| bool clang::DiagnosticBuilder::isActive | ( | ) | const [inline, protected] |
Determine whether this diagnostic is still active.
Definition at line 907 of file Diagnostic.h.
Referenced by AddFixItHint(), AddSourceRange(), AddString(), AddTaggedVal(), Emit(), and clang::Sema::SemaDiagnosticBuilder::~SemaDiagnosticBuilder().
| clang::DiagnosticBuilder::operator bool | ( | ) | const [inline] |
Conversion of DiagnosticBuilder to bool always returns true.
This allows is to be used in boolean error contexts (where true is used to indicate that an error has occurred), like:
return Diag(...);
Definition at line 968 of file Diagnostic.h.
| const DiagnosticBuilder& clang::DiagnosticBuilder::setForceEmit | ( | ) | const [inline] |
Forces the diagnostic to be emitted.
Definition at line 956 of file Diagnostic.h.
Referenced by PrintExpected(), and PrintUnexpected().
Friends And Related Function Documentation
friend class DiagnosticsEngine [friend] |
Definition at line 880 of file Diagnostic.h.
friend class PartialDiagnostic [friend] |
Definition at line 892 of file Diagnostic.h.
The documentation for this class was generated from the following file: