clang  3.7.0
Public Types | Public Member Functions | Protected Member Functions | List of all members
clang::ento::PathDiagnosticPiece Class Referenceabstract

#include <PathDiagnostic.h>

Inheritance diagram for clang::ento::PathDiagnosticPiece:
[legend]
Collaboration diagram for clang::ento::PathDiagnosticPiece:
[legend]

Public Types

enum  Kind { ControlFlow, Event, Macro, Call }
 
enum  DisplayHint { Above, Below }
 

Public Member Functions

 ~PathDiagnosticPiece () override
 
StringRef getString () const
 
void setTag (const char *tag)
 Tag this PathDiagnosticPiece with the given C-string. More...
 
const void * getTag () const
 Return the opaque tag (if any) on the PathDiagnosticPiece. More...
 
StringRef getTagStr () const
 
DisplayHint getDisplayHint () const
 
virtual PathDiagnosticLocation getLocation () const =0
 
virtual void flattenLocations ()=0
 
Kind getKind () const
 
void addRange (SourceRange R)
 
void addRange (SourceLocation B, SourceLocation E)
 
ArrayRef< SourceRangegetRanges () const
 Return the SourceRanges associated with this PathDiagnosticPiece. More...
 
virtual void Profile (llvm::FoldingSetNodeID &ID) const
 
void setAsLastInMainSourceFile ()
 
bool isLastInMainSourceFile () const
 
virtual void dump () const =0
 

Protected Member Functions

 PathDiagnosticPiece (StringRef s, Kind k, DisplayHint hint=Below)
 
 PathDiagnosticPiece (Kind k, DisplayHint hint=Below)
 

Detailed Description

Definition at line 337 of file PathDiagnostic.h.

Member Enumeration Documentation

Enumerator
Above 
Below 

Definition at line 340 of file PathDiagnostic.h.

Enumerator
ControlFlow 
Event 
Macro 
Call 

Definition at line 339 of file PathDiagnostic.h.

Constructor & Destructor Documentation

PathDiagnosticPiece::PathDiagnosticPiece ( StringRef  s,
Kind  k,
DisplayHint  hint = Below 
)
protected

Definition at line 50 of file PathDiagnostic.cpp.

PathDiagnosticPiece::PathDiagnosticPiece ( Kind  k,
DisplayHint  hint = Below 
)
protected

Definition at line 55 of file PathDiagnostic.cpp.

PathDiagnosticPiece::~PathDiagnosticPiece ( )
override

Definition at line 58 of file PathDiagnostic.cpp.

Member Function Documentation

void clang::ento::PathDiagnosticPiece::addRange ( SourceRange  R)
inline
void clang::ento::PathDiagnosticPiece::addRange ( SourceLocation  B,
SourceLocation  E 
)
inline

Definition at line 398 of file PathDiagnostic.h.

References clang::SourceLocation::isValid().

virtual void clang::ento::PathDiagnosticPiece::dump ( ) const
pure virtual
virtual void clang::ento::PathDiagnosticPiece::flattenLocations ( )
pure virtual
DisplayHint clang::ento::PathDiagnosticPiece::getDisplayHint ( ) const
inline

getDisplayHint - Return a hint indicating where the diagnostic should be displayed by the PathDiagnosticConsumer.

Definition at line 385 of file PathDiagnostic.h.

Kind clang::ento::PathDiagnosticPiece::getKind ( ) const
inline
virtual PathDiagnosticLocation clang::ento::PathDiagnosticPiece::getLocation ( ) const
pure virtual
ArrayRef<SourceRange> clang::ento::PathDiagnosticPiece::getRanges ( ) const
inline

Return the SourceRanges associated with this PathDiagnosticPiece.

Definition at line 405 of file PathDiagnostic.h.

Referenced by comparePiece(), clang::ento::PathDiagnosticConsumer::HandlePathDiagnostic(), and ReportEvent().

StringRef clang::ento::PathDiagnosticPiece::getString ( ) const
inline
const void* clang::ento::PathDiagnosticPiece::getTag ( ) const
inline

Return the opaque tag (if any) on the PathDiagnosticPiece.

Definition at line 377 of file PathDiagnostic.h.

Referenced by eventsDescribeSameCondition().

StringRef clang::ento::PathDiagnosticPiece::getTagStr ( ) const
inline

Return the string representation of the tag. This is useful for debugging.

Definition at line 381 of file PathDiagnostic.h.

bool clang::ento::PathDiagnosticPiece::isLastInMainSourceFile ( ) const
inline

Definition at line 413 of file PathDiagnostic.h.

Referenced by ReportCall().

void PathDiagnosticPiece::Profile ( llvm::FoldingSetNodeID &  ID) const
virtual
void clang::ento::PathDiagnosticPiece::setAsLastInMainSourceFile ( )
inline

Definition at line 409 of file PathDiagnostic.h.

void clang::ento::PathDiagnosticPiece::setTag ( const char *  tag)
inline

Tag this PathDiagnosticPiece with the given C-string.

Definition at line 374 of file PathDiagnostic.h.

Referenced by clang::ento::TrackConstraintBRVisitor::VisitNode(), and clang::ento::ConditionBRVisitor::VisitNode().


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