clang API Documentation

Public Types | Public Member Functions | Protected Member Functions
clang::ento::PathDiagnosticPiece Class Reference

#include <PathDiagnostic.h>

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

List of all members.

Public Types

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

Public Member Functions

virtual ~PathDiagnosticPiece ()
StringRef getString () const
void setTag (const char *tag)
 Tag this PathDiagnosticPiece with the given C-string.
const void * getTag () const
 Return the opaque tag (if any) on the PathDiagnosticPiece.
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.
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 333 of file PathDiagnostic.h.


Member Enumeration Documentation

Enumerator:
Above 
Below 

Definition at line 336 of file PathDiagnostic.h.

Enumerator:
ControlFlow 
Event 
Macro 
Call 

Definition at line 335 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.

Definition at line 58 of file PathDiagnostic.cpp.


Member Function Documentation

Definition at line 394 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]

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

Definition at line 381 of file PathDiagnostic.h.

Return the SourceRanges associated with this PathDiagnosticPiece.

Definition at line 401 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 373 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 377 of file PathDiagnostic.h.

Definition at line 409 of file PathDiagnostic.h.

Referenced by ReportCall().

void PathDiagnosticPiece::Profile ( llvm::FoldingSetNodeID &  ID) const [virtual]

Definition at line 405 of file PathDiagnostic.h.

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

Tag this PathDiagnosticPiece with the given C-string.

Definition at line 370 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: