PathDiagnostic - PathDiagnostic objects represent a single path-sensitive diagnostic. More...

#include "clang/Analysis/PathDiagnostic.h"

Inheritance diagram for clang::ento::PathDiagnostic:

Public Types
using	meta_iterator = std::deque<std::string>::const_iterator

Public Member Functions
	PathDiagnostic ()=delete
	PathDiagnostic (StringRef CheckerName, const Decl DeclWithIssue, StringRef bugtype, StringRef verboseDesc, StringRef shortDesc, StringRef category, PathDiagnosticLocation LocationToUnique, const Decl DeclToUnique, const Decl *AnalysisEntryPoint, std::unique_ptr< FilesToLineNumsMap > ExecutedLines)
	~PathDiagnostic ()
PathPieces &	getActivePath ()
	Return the path currently used by builders for constructing the PathDiagnostic.
PathPieces &	getMutablePieces ()
	Return a mutable version of 'path'.
unsigned	full_size ()
	Return the unrolled size of the path.
void	pushActivePath (PathPieces *p)
void	popActivePath ()
bool	isWithinCall () const
void	setEndOfPath (PathDiagnosticPieceRef EndPiece)
void	appendToDesc (StringRef S)
StringRef	getVerboseDescription () const
StringRef	getShortDescription () const
StringRef	getCheckerName () const
StringRef	getBugType () const
StringRef	getCategory () const
meta_iterator	meta_begin () const
meta_iterator	meta_end () const
void	addMeta (StringRef s)
const FilesToLineNumsMap &	getExecutedLines () const
FilesToLineNumsMap &	getExecutedLines ()
const Decl *	getAnalysisEntryPoint () const
	Get the top-level entry point from which this issue was discovered.
const Decl *	getDeclWithIssue () const
	Return the semantic context where an issue occurred.
void	setDeclWithIssue (const Decl *D)
PathDiagnosticLocation	getLocation () const
void	setLocation (PathDiagnosticLocation NewLoc)
PathDiagnosticLocation	getUniqueingLoc () const
	Get the location on which the report should be uniqued.
const Decl *	getUniqueingDecl () const
	Get the declaration containing the uniqueing location.
SmallString< 32 >	getIssueHash (const SourceManager &SrcMgr, const LangOptions &LangOpts) const
	Get a hash that identifies the issue.
void	flattenLocations ()
void	Profile (llvm::FoldingSetNodeID &ID) const
	Profiles the diagnostic, independent of the path it references.
void	FullProfile (llvm::FoldingSetNodeID &ID) const
	Profiles the diagnostic, including its path.

Public Attributes
const PathPieces &	path

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 762 of file PathDiagnostic.h.

Member Typedef Documentation

◆ meta_iterator

using clang::ento::PathDiagnostic::meta_iterator = std::deque<std::string>::const_iterator

Definition at line 843 of file PathDiagnostic.h.

Constructor & Destructor Documentation

◆ PathDiagnostic() [1/2]

clang::ento::PathDiagnostic::PathDiagnostic ( )

delete

◆ PathDiagnostic() [2/2]

PathDiagnostic::PathDiagnostic	(	StringRef	CheckerName,
		const Decl *	DeclWithIssue,
		StringRef	bugtype,
		StringRef	verboseDesc,
		StringRef	shortDesc,
		StringRef	category,
		PathDiagnosticLocation	LocationToUnique,
		const Decl *	DeclToUnique,
		const Decl *	AnalysisEntryPoint,
		std::unique_ptr< FilesToLineNumsMap >	ExecutedLines )

Definition at line 110 of file PathDiagnostic.cpp.

References path, and StripTrailingDots().

◆ ~PathDiagnostic()

PathDiagnostic::~PathDiagnostic ( )

default

Member Function Documentation

◆ addMeta()

void clang::ento::PathDiagnostic::addMeta ( StringRef s )

inline

Definition at line 847 of file PathDiagnostic.h.

◆ appendToDesc()

void clang::ento::PathDiagnostic::appendToDesc ( StringRef S )

inline

Definition at line 827 of file PathDiagnostic.h.

Referenced by resetDiagnosticLocationToMainFile().

◆ flattenLocations()

void clang::ento::PathDiagnostic::flattenLocations ( )

inline

Definition at line 891 of file PathDiagnostic.h.

◆ full_size()

unsigned PathDiagnostic::full_size ( )

Return the unrolled size of the path.

Definition at line 1067 of file PathDiagnostic.cpp.

References compute_path_size(), and path.

◆ FullProfile()

void PathDiagnostic::FullProfile ( llvm::FoldingSetNodeID & ID ) const

Profiles the diagnostic, including its path.

Two diagnostics with the same issue along different paths will generate different profiles.

Definition at line 1147 of file PathDiagnostic.cpp.

References meta_begin(), meta_end(), path, and Profile().

◆ getActivePath()

PathPieces & clang::ento::PathDiagnostic::getActivePath ( )

inline

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

Definition at line 801 of file PathDiagnostic.h.

Referenced by setEndOfPath().

◆ getAnalysisEntryPoint()

const Decl * clang::ento::PathDiagnostic::getAnalysisEntryPoint ( ) const

inline

Get the top-level entry point from which this issue was discovered.

Definition at line 858 of file PathDiagnostic.h.

◆ getBugType()

StringRef clang::ento::PathDiagnostic::getBugType ( ) const

inline

Definition at line 840 of file PathDiagnostic.h.

Referenced by compare(), and getIssueHash().

◆ getCategory()

StringRef clang::ento::PathDiagnostic::getCategory ( ) const

inline

Definition at line 841 of file PathDiagnostic.h.

Referenced by compare().

◆ getCheckerName()

StringRef clang::ento::PathDiagnostic::getCheckerName ( ) const

inline

Definition at line 839 of file PathDiagnostic.h.

Referenced by getIssueHash().

◆ getDeclWithIssue()

const Decl * clang::ento::PathDiagnostic::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 863 of file PathDiagnostic.h.

Referenced by compare(), and getIssueHash().

◆ getExecutedLines() [1/2]

FilesToLineNumsMap & clang::ento::PathDiagnostic::getExecutedLines ( )

inline

Definition at line 853 of file PathDiagnostic.h.

◆ getExecutedLines() [2/2]

const FilesToLineNumsMap & clang::ento::PathDiagnostic::getExecutedLines ( ) const

inline

Definition at line 849 of file PathDiagnostic.h.

Referenced by printCoverage(), and updateExecutedLinesWithDiagnosticPieces().

◆ getIssueHash()

SmallString< 32 > PathDiagnostic::getIssueHash	(	const SourceManager &	SrcMgr,
		const LangOptions &	LangOpts ) const

Get a hash that identifies the issue.

Definition at line 1074 of file PathDiagnostic.cpp.

References clang::ento::PathDiagnosticLocation::asLocation(), getBugType(), getCheckerName(), getDeclWithIssue(), clang::getIssueHash(), getLocation(), getUniqueingLoc(), and clang::ento::PathDiagnosticLocation::isValid().

◆ getLocation()

PathDiagnosticLocation clang::ento::PathDiagnostic::getLocation ( ) const

inline

Definition at line 869 of file PathDiagnostic.h.

Referenced by compare(), getIssueHash(), and Profile().

◆ getMutablePieces()

PathPieces & clang::ento::PathDiagnostic::getMutablePieces ( )

inline

Return a mutable version of 'path'.

Definition at line 808 of file PathDiagnostic.h.

◆ getShortDescription()

StringRef clang::ento::PathDiagnostic::getShortDescription ( ) const

inline

Definition at line 835 of file PathDiagnostic.h.

Referenced by compare().

◆ getUniqueingDecl()

const Decl * clang::ento::PathDiagnostic::getUniqueingDecl ( ) const

inline

Get the declaration containing the uniqueing location.

Definition at line 883 of file PathDiagnostic.h.

Referenced by compare().

◆ getUniqueingLoc()

PathDiagnosticLocation clang::ento::PathDiagnostic::getUniqueingLoc ( ) const

inline

Get the location on which the report should be uniqued.

Definition at line 878 of file PathDiagnostic.h.

Referenced by compare(), getIssueHash(), and Profile().

◆ getVerboseDescription()

StringRef clang::ento::PathDiagnostic::getVerboseDescription ( ) const

inline

Definition at line 833 of file PathDiagnostic.h.

Referenced by compare().

◆ isWithinCall()

bool clang::ento::PathDiagnostic::isWithinCall ( ) const

inline

Definition at line 818 of file PathDiagnostic.h.

◆ meta_begin()

meta_iterator clang::ento::PathDiagnostic::meta_begin ( ) const

inline

Definition at line 845 of file PathDiagnostic.h.

Referenced by compare(), and FullProfile().

◆ meta_end()

meta_iterator clang::ento::PathDiagnostic::meta_end ( ) const

inline

Definition at line 846 of file PathDiagnostic.h.

Referenced by compare(), and FullProfile().

◆ popActivePath()

void clang::ento::PathDiagnostic::popActivePath ( )

inline

Definition at line 816 of file PathDiagnostic.h.

◆ Profile()

void PathDiagnostic::Profile ( llvm::FoldingSetNodeID & ID ) const

Profiles the diagnostic, independent of the path it references.

This can be used to merge diagnostics that refer to the same issue along different paths.

Definition at line 1139 of file PathDiagnostic.cpp.

References getLocation(), and getUniqueingLoc().

Referenced by FullProfile().

◆ pushActivePath()

void clang::ento::PathDiagnostic::pushActivePath ( PathPieces * p )

inline

Definition at line 815 of file PathDiagnostic.h.

◆ setDeclWithIssue()

void clang::ento::PathDiagnostic::setDeclWithIssue ( const Decl * D )

inline

Definition at line 865 of file PathDiagnostic.h.

Referenced by resetDiagnosticLocationToMainFile().

◆ setEndOfPath()

void clang::ento::PathDiagnostic::setEndOfPath ( PathDiagnosticPieceRef EndPiece )

inline

Definition at line 820 of file PathDiagnostic.h.

References getActivePath().

◆ setLocation()

void clang::ento::PathDiagnostic::setLocation ( PathDiagnosticLocation NewLoc )

inline

Definition at line 873 of file PathDiagnostic.h.

Referenced by resetDiagnosticLocationToMainFile().

Member Data Documentation

◆ path

const PathPieces& clang::ento::PathDiagnostic::path

Definition at line 797 of file PathDiagnostic.h.

Referenced by compare(), full_size(), FullProfile(), PathDiagnostic(), resetDiagnosticLocationToMainFile(), and updateExecutedLinesWithDiagnosticPieces().

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

include/clang/Analysis/PathDiagnostic.h
lib/Analysis/PathDiagnostic.cpp

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ meta_iterator

Constructor & Destructor Documentation

◆ PathDiagnostic() [1/2]

◆ PathDiagnostic() [2/2]

◆ ~PathDiagnostic()

Member Function Documentation

◆ addMeta()

◆ appendToDesc()

◆ flattenLocations()

◆ full_size()

◆ FullProfile()

◆ getActivePath()

◆ getAnalysisEntryPoint()

◆ getBugType()

◆ getCategory()

◆ getCheckerName()

◆ getDeclWithIssue()

◆ getExecutedLines() [1/2]

◆ getExecutedLines() [2/2]

◆ getIssueHash()

◆ getLocation()

◆ getMutablePieces()

◆ getShortDescription()

◆ getUniqueingDecl()

◆ getUniqueingLoc()

◆ getVerboseDescription()

◆ isWithinCall()

◆ meta_begin()

◆ meta_end()

◆ popActivePath()

◆ Profile()

◆ pushActivePath()

◆ setDeclWithIssue()

◆ setEndOfPath()

◆ setLocation()

Member Data Documentation

◆ path