clang API Documentation

Public Types | Public Member Functions | Public Attributes
clang::ento::PathDiagnostic Class Reference

#include <PathDiagnostic.h>

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

List of all members.

Public Types

typedef std::deque
< std::string >
::const_iterator 
meta_iterator

Public Member Functions

PathPiecesgetActivePath ()
PathPiecesgetMutablePieces ()
 Return a mutable version of 'path'.
unsigned full_size ()
 Return the unrolled size of the path.
void pushActivePath (PathPieces *p)
void popActivePath ()
 PathDiagnostic (const Decl *DeclWithIssue, StringRef bugtype, StringRef desc, StringRef category)
 ~PathDiagnostic ()
StringRef getDescription () const
StringRef getBugType () const
StringRef getCategory () const
const DeclgetDeclWithIssue () const
meta_iterator meta_begin () const
meta_iterator meta_end () const
void addMeta (StringRef s)
PathDiagnosticLocation getLocation () const
void flattenLocations ()
void Profile (llvm::FoldingSetNodeID &ID) const
void FullProfile (llvm::FoldingSetNodeID &ID) const

Public Attributes

const PathPiecespath

Detailed Description

PathDiagnostic - PathDiagnostic objects represent a single path-sensitive diagnostic. It represents an ordered-collection of PathDiagnosticPieces, each which represent the pieces of the path.

Definition at line 609 of file PathDiagnostic.h.


Member Typedef Documentation

typedef std::deque<std::string>::const_iterator clang::ento::PathDiagnostic::meta_iterator

Definition at line 658 of file PathDiagnostic.h.


Constructor & Destructor Documentation

clang::ento::PathDiagnostic::PathDiagnostic ( const Decl DeclWithIssue,
StringRef  bugtype,
StringRef  desc,
StringRef  category 
)
PathDiagnostic::~PathDiagnostic ( )

Definition at line 61 of file PathDiagnostic.cpp.


Member Function Documentation

void clang::ento::PathDiagnostic::addMeta ( StringRef  s) [inline]

Definition at line 661 of file PathDiagnostic.h.

void clang::ento::PathDiagnostic::flattenLocations ( ) [inline]
unsigned PathDiagnostic::full_size ( )

Return the unrolled size of the path.

Definition at line 596 of file PathDiagnostic.cpp.

References compute_path_size().

Referenced by clang::ento::PathDiagnosticConsumer::HandlePathDiagnostic().

void PathDiagnostic::FullProfile ( llvm::FoldingSetNodeID &  ID) const
PathPieces& clang::ento::PathDiagnostic::getActivePath ( ) [inline]

Return the path currently used by builders for constructing the PathDiagnostic.

Definition at line 624 of file PathDiagnostic.h.

Referenced by clang::ento::GRBugReporter::GeneratePathDiagnostic().

StringRef clang::ento::PathDiagnostic::getBugType ( ) const [inline]

Definition at line 650 of file PathDiagnostic.h.

StringRef clang::ento::PathDiagnostic::getCategory ( ) const [inline]

Definition at line 651 of file PathDiagnostic.h.

const Decl * BugReport::getDeclWithIssue ( ) const [inline]

Return the semantic context where an issue occurred. If the issue occurs along a path, this represents the "central" area where the bug manifests.

Definition at line 656 of file PathDiagnostic.h.

StringRef clang::ento::PathDiagnostic::getDescription ( ) const [inline]

Definition at line 649 of file PathDiagnostic.h.

PathDiagnosticLocation clang::ento::PathDiagnostic::getLocation ( ) const
PathPieces& clang::ento::PathDiagnostic::getMutablePieces ( ) [inline]

Return a mutable version of 'path'.

Definition at line 631 of file PathDiagnostic.h.

Referenced by clang::ento::GRBugReporter::GeneratePathDiagnostic().

meta_iterator clang::ento::PathDiagnostic::meta_begin ( ) const [inline]

Definition at line 659 of file PathDiagnostic.h.

Referenced by FullProfile().

meta_iterator clang::ento::PathDiagnostic::meta_end ( ) const [inline]

Definition at line 660 of file PathDiagnostic.h.

Referenced by FullProfile().

void clang::ento::PathDiagnostic::popActivePath ( ) [inline]

Definition at line 639 of file PathDiagnostic.h.

void clang::ento::PathDiagnostic::Profile ( llvm::FoldingSetNodeID &  ID) const
void clang::ento::PathDiagnostic::pushActivePath ( PathPieces p) [inline]

Definition at line 638 of file PathDiagnostic.h.


Member Data Documentation


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