#include "clang/Analysis/PathDiagnostic.h"

Public Member Functions
	PathDiagnosticLocation ()=default
	Create an invalid location.
	PathDiagnosticLocation (const Stmt *s, const SourceManager &sm, StackFrameOrAnalysisDeclContext SFAC)
	Create a location corresponding to the given statement.
	PathDiagnosticLocation (const Decl *d, const SourceManager &sm)
	Create a location corresponding to the given declaration.
	PathDiagnosticLocation (SourceLocation loc, const SourceManager &sm)
	Create a location at an explicit offset in the source.
bool	operator== (const PathDiagnosticLocation &X) const
bool	operator!= (const PathDiagnosticLocation &X) const
bool	isValid () const
FullSourceLoc	asLocation () const
PathDiagnosticRange	asRange () const
const Stmt *	asStmt () const
const Stmt *	getStmtOrNull () const
const Decl *	asDecl () const
bool	hasRange () const
bool	hasValidLocation () const
void	invalidate ()
void	flatten ()
const SourceManager &	getManager () const
void	Profile (llvm::FoldingSetNodeID &ID) const
void	dump () const

Static Public Member Functions
static PathDiagnosticLocation	create (const Decl *D, const SourceManager &SM)
	Create a location corresponding to the given declaration.
static PathDiagnosticLocation	createBegin (const Decl *D, const SourceManager &SM)
	Create a location for the beginning of the declaration.
static PathDiagnosticLocation	createBegin (const Decl *D, const SourceManager &SM, const StackFrameOrAnalysisDeclContext SFAC)
	Create a location for the beginning of the declaration.
static PathDiagnosticLocation	createBegin (const Stmt *S, const SourceManager &SM, const StackFrameOrAnalysisDeclContext SFAC)
	Create a location for the beginning of the statement.
static PathDiagnosticLocation	createEnd (const Stmt *S, const SourceManager &SM, const StackFrameOrAnalysisDeclContext SFAC)
	Create a location for the end of the statement.
static PathDiagnosticLocation	createOperatorLoc (const BinaryOperator *BO, const SourceManager &SM)
	Create the location for the operator of the binary expression.
static PathDiagnosticLocation	createConditionalColonLoc (const ConditionalOperator *CO, const SourceManager &SM)
static PathDiagnosticLocation	createMemberLoc (const MemberExpr *ME, const SourceManager &SM)
	For member expressions, return the location of the '.
static PathDiagnosticLocation	createBeginBrace (const CompoundStmt *CS, const SourceManager &SM)
	Create a location for the beginning of the compound statement.
static PathDiagnosticLocation	createEndBrace (const CompoundStmt *CS, const SourceManager &SM)
	Create a location for the end of the compound statement.
static PathDiagnosticLocation	createDeclBegin (const StackFrame *SF, const SourceManager &SM)
	Create a location for the beginning of the enclosing declaration body.
static PathDiagnosticLocation	createDeclEnd (const StackFrame *SF, const SourceManager &SM)
	Constructs a location for the end of the enclosing declaration body.
static PathDiagnosticLocation	create (const ProgramPoint &P, const SourceManager &SMng)
	Create a location corresponding to the given valid ProgramPoint.
static PathDiagnosticLocation	createSingleLocation (const PathDiagnosticLocation &PDL)
	Convert the given location into a single kind location.
static SourceLocation	getValidSourceLocation (const Stmt *S, StackFrameOrAnalysisDeclContext SFAC, bool UseEndOfStatement=false)
	Construct a source location that corresponds to either the beginning or the end of the given statement, or a nearby valid source location if the statement does not have a valid source location of its own.

Detailed Description

Definition at line 194 of file PathDiagnostic.h.

Constructor & Destructor Documentation

◆ PathDiagnosticLocation() [1/4]

clang::ento::PathDiagnosticLocation::PathDiagnosticLocation ( )

default

Create an invalid location.

Referenced by create(), and invalidate().

◆ PathDiagnosticLocation() [2/4]

clang::ento::PathDiagnosticLocation::PathDiagnosticLocation	(	const Stmt *	s,
		const SourceManager &	sm,
		StackFrameOrAnalysisDeclContext	SFAC )

inline

Create a location corresponding to the given statement.

Definition at line 219 of file PathDiagnostic.h.

References isValid(), clang::nullptr, and s.

◆ PathDiagnosticLocation() [3/4]

clang::ento::PathDiagnosticLocation::PathDiagnosticLocation	(	const Decl *	d,
		const SourceManager &	sm )

inline

Create a location corresponding to the given declaration.

Definition at line 230 of file PathDiagnostic.h.

◆ PathDiagnosticLocation() [4/4]

clang::ento::PathDiagnosticLocation::PathDiagnosticLocation	(	SourceLocation	loc,
		const SourceManager &	sm )

inline

Create a location at an explicit offset in the source.

This should only be used if there are no more appropriate constructors.

Definition at line 240 of file PathDiagnostic.h.

Member Function Documentation

◆ asDecl()

const Decl * clang::ento::PathDiagnosticLocation::asDecl ( ) const

inline

Definition at line 353 of file PathDiagnostic.h.

References isValid().

◆ asLocation()

FullSourceLoc clang::ento::PathDiagnosticLocation::asLocation ( ) const

inline

Definition at line 338 of file PathDiagnostic.h.

Referenced by addEdgeToPath(), compare(), compareCall(), compareControlFlow(), comparePiece(), clang::ento::bugreporter::StoreHandler::constructNote(), createSingleLocation(), dump(), clang::ento::LikelyFalsePositiveSuppressionBRVisitor::finalizeVisitor(), getFirstStackedCallToHeaderFile(), clang::ento::PathDiagnostic::getIssueHash(), clang::ento::PathDiagnosticConsumer::HandlePathDiagnostic(), and hasValidLocation().

◆ asRange()

PathDiagnosticRange clang::ento::PathDiagnosticLocation::asRange ( ) const

inline

Definition at line 342 of file PathDiagnostic.h.

◆ asStmt()

const Stmt * clang::ento::PathDiagnosticLocation::asStmt ( ) const

inline

Definition at line 346 of file PathDiagnostic.h.

References isValid().

Referenced by addContextEdges(), addEdgeToPath(), and getStmtOrNull().

◆ create() [1/2]

PathDiagnosticLocation clang::ento::PathDiagnosticLocation::create	(	const Decl *	D,
		const SourceManager &	SM )

inlinestatic

Create a location corresponding to the given declaration.

Definition at line 247 of file PathDiagnostic.h.

References PathDiagnosticLocation().

Referenced by annotateConsumedSummaryMismatch(), checkObjCUnusedIvar(), clang::ento::bugreporter::StoreHandler::constructNote(), getLocationForCaller(), clang::ento::retaincountchecker::RefCountReportVisitor::VisitNode(), clang::ento::TagVisitor::VisitNode(), and clang::ento::TrackConstraintBRVisitor::VisitNode().

◆ create() [2/2]

PathDiagnosticLocation PathDiagnosticLocation::create	(	const ProgramPoint &	P,
		const SourceManager &	SMng )

static

Create a location corresponding to the given valid ProgramPoint.

Definition at line 660 of file PathDiagnostic.cpp.

References createBegin(), createEnd(), clang::ProgramPoint::getAs(), clang::StackFrame::getDecl(), clang::CFG::getEntry(), getLocationForCaller(), clang::CFGBlock::getParent(), clang::ProgramPoint::getStackFrame(), clang::CFGBlock::getTerminator(), clang::CFGBlock::getTerminatorCondition(), and clang::CFGTerminator::isVirtualBaseBranch().

◆ createBegin() [1/3]

PathDiagnosticLocation PathDiagnosticLocation::createBegin	(	const Decl *	D,
		const SourceManager &	SM )

static

Create a location for the beginning of the declaration.

Definition at line 576 of file PathDiagnostic.cpp.

Referenced by CompareReturnTypes(), constructDebugPieceForTrackedCondition(), create(), createBegin(), dropFunctionEntryEdge(), emitDiagnostics(), emitDiagnostics(), emitDiagnostics(), clang::ento::PathSensitiveBugReport::getLocation(), makeLocation(), and clang::ento::PathDiagnosticCallPiece::setCallee().

◆ createBegin() [2/3]

PathDiagnosticLocation clang::ento::PathDiagnosticLocation::createBegin	(	const Decl *	D,
		const SourceManager &	SM,
		const StackFrameOrAnalysisDeclContext	SFAC )

inlinestatic

Create a location for the beginning of the declaration.

The third argument is ignored, useful for generic treatment of statements and declarations.

Definition at line 260 of file PathDiagnostic.h.

References createBegin().

◆ createBegin() [3/3]

PathDiagnosticLocation PathDiagnosticLocation::createBegin	(	const Stmt *	S,
		const SourceManager &	SM,
		const StackFrameOrAnalysisDeclContext	SFAC )

static

Create a location for the beginning of the statement.

Definition at line 582 of file PathDiagnostic.cpp.

References getValidSourceLocation().

◆ createBeginBrace()

PathDiagnosticLocation PathDiagnosticLocation::createBeginBrace	(	const CompoundStmt *	CS,
		const SourceManager &	SM )

static

Create a location for the beginning of the compound statement.

Assumes the statement has a valid location.

Definition at line 626 of file PathDiagnostic.cpp.

References clang::CompoundStmt::getLBracLoc().

◆ createConditionalColonLoc()

PathDiagnosticLocation PathDiagnosticLocation::createConditionalColonLoc	(	const ConditionalOperator *	CO,
		const SourceManager &	SM )

static

Definition at line 605 of file PathDiagnostic.cpp.

References clang::AbstractConditionalOperator::getColonLoc().

◆ createDeclBegin()

PathDiagnosticLocation PathDiagnosticLocation::createDeclBegin	(	const StackFrame *	SF,
		const SourceManager &	SM )

static

Create a location for the beginning of the enclosing declaration body.

Defaults to the beginning of the first statement in the declaration body.

Definition at line 640 of file PathDiagnostic.cpp.

References clang::Decl::getBody(), and clang::StackFrame::getDecl().

◆ createDeclEnd()

PathDiagnosticLocation PathDiagnosticLocation::createDeclEnd	(	const StackFrame *	SF,
		const SourceManager &	SM )

static

Constructs a location for the end of the enclosing declaration body.

Defaults to the end of brace.

Definition at line 653 of file PathDiagnostic.cpp.

References clang::Decl::getBodyRBrace(), and clang::StackFrame::getDecl().

Referenced by clang::ento::PathSensitiveBugReport::getLocation().

◆ createEnd()

PathDiagnosticLocation PathDiagnosticLocation::createEnd	(	const Stmt *	S,
		const SourceManager &	SM,
		const StackFrameOrAnalysisDeclContext	SFAC )

static

Create a location for the end of the statement.

If the statement is a CompoundStatement, the location will point to the closing brace instead of following it.

Definition at line 590 of file PathDiagnostic.cpp.

References createEndBrace(), and getValidSourceLocation().

Referenced by create(), clang::ento::PathSensitiveBugReport::getLocation(), and getLocationForCaller().

◆ createEndBrace()

PathDiagnosticLocation PathDiagnosticLocation::createEndBrace	(	const CompoundStmt *	CS,
		const SourceManager &	SM )

static

Create a location for the end of the compound statement.

Assumes the statement has a valid location.

Definition at line 633 of file PathDiagnostic.cpp.

References clang::CompoundStmt::getRBracLoc().

Referenced by createEnd().

◆ createMemberLoc()

PathDiagnosticLocation PathDiagnosticLocation::createMemberLoc	(	const MemberExpr *	ME,
		const SourceManager &	SM )

static

For member expressions, return the location of the '.

' or '->'. Assumes the statement has a valid location.

Definition at line 612 of file PathDiagnostic.cpp.

References clang::MemberExpr::getBeginLoc(), clang::MemberExpr::getMemberLoc(), and clang::SourceLocation::isValid().

Referenced by clang::ento::PathSensitiveBugReport::getLocation().

◆ createOperatorLoc()

PathDiagnosticLocation PathDiagnosticLocation::createOperatorLoc	(	const BinaryOperator *	BO,
		const SourceManager &	SM )

static

Create the location for the operator of the binary expression.

Assumes the statement has a valid location.

Definition at line 599 of file PathDiagnostic.cpp.

References clang::BinaryOperator::getOperatorLoc().

Referenced by clang::ento::PathSensitiveBugReport::getLocation().

◆ createSingleLocation()

PathDiagnosticLocation PathDiagnosticLocation::createSingleLocation ( const PathDiagnosticLocation & PDL )

static

Convert the given location into a single kind location.

Definition at line 730 of file PathDiagnostic.cpp.

References asLocation(), and clang::FullSourceLoc::getManager().

Referenced by CompactMacroExpandedPieces().

◆ dump()

LLVM_DUMP_METHOD void PathDiagnosticLocation::dump ( ) const

Definition at line 1208 of file PathDiagnostic.cpp.

References asLocation(), clang::isa(), and isValid().

◆ flatten()

void PathDiagnosticLocation::flatten ( )

Definition at line 822 of file PathDiagnostic.cpp.

◆ getManager()

const SourceManager & clang::ento::PathDiagnosticLocation::getManager ( ) const

inline

Definition at line 365 of file PathDiagnostic.h.

References isValid().

Referenced by resetDiagnosticLocationToMainFile().

◆ getStmtOrNull()

const Stmt * clang::ento::PathDiagnosticLocation::getStmtOrNull ( ) const

inline

Definition at line 347 of file PathDiagnostic.h.

References asStmt(), and isValid().

Referenced by addContextEdges(), and simplifySimpleBranches().

◆ getValidSourceLocation()

SourceLocation PathDiagnosticLocation::getValidSourceLocation	(	const Stmt *	S,
		StackFrameOrAnalysisDeclContext	SFAC,
		bool	UseEndOfStatement = false )

static

Construct a source location that corresponds to either the beginning or the end of the given statement, or a nearby valid source location if the statement does not have a valid source location of its own.

Definition at line 472 of file PathDiagnostic.cpp.

References clang::cast(), clang::Stmt::getBeginLoc(), clang::AnalysisDeclContext::getBody(), clang::AnalysisDeclContext::getDecl(), clang::Decl::getEndLoc(), clang::Stmt::getEndLoc(), clang::ParentMap::getParent(), clang::AnalysisDeclContext::getParentMap(), and clang::SourceLocation::isValid().

Referenced by createBegin(), createEnd(), and clang::ento::PathSensitiveBugReport::getLocation().

◆ hasRange()

bool clang::ento::PathDiagnosticLocation::hasRange ( ) const

inline

Definition at line 355 of file PathDiagnostic.h.

◆ hasValidLocation()

bool clang::ento::PathDiagnosticLocation::hasValidLocation ( ) const

inline

Definition at line 357 of file PathDiagnostic.h.

References asLocation(), and clang::SourceLocation::isValid().

◆ invalidate()

void clang::ento::PathDiagnosticLocation::invalidate ( )

inline

Definition at line 359 of file PathDiagnostic.h.

References PathDiagnosticLocation().

◆ isValid()

bool clang::ento::PathDiagnosticLocation::isValid ( ) const

inline

Definition at line 334 of file PathDiagnostic.h.

Referenced by addContextEdges(), addEdgeToPath(), asDecl(), asStmt(), clang::ento::bugreporter::StoreHandler::constructNote(), dump(), clang::ento::PathDiagnostic::getIssueHash(), getManager(), getStmtOrNull(), PathDiagnosticLocation(), clang::ento::PathSensitiveBugReport::Profile(), and clang::ento::TrackConstraintBRVisitor::VisitNode().

◆ operator!=()

bool clang::ento::PathDiagnosticLocation::operator!= ( const PathDiagnosticLocation & X ) const

inline

Definition at line 330 of file PathDiagnostic.h.

References X.

◆ operator==()

bool clang::ento::PathDiagnosticLocation::operator== ( const PathDiagnosticLocation & X ) const

inline

Definition at line 326 of file PathDiagnostic.h.

References X.

◆ Profile()

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

Definition at line 1090 of file PathDiagnostic.cpp.

Referenced by clang::ento::PathSensitiveBugReport::Profile().

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

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

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ PathDiagnosticLocation() [1/4]

◆ PathDiagnosticLocation() [2/4]

◆ PathDiagnosticLocation() [3/4]

◆ PathDiagnosticLocation() [4/4]

Member Function Documentation

◆ asDecl()

◆ asLocation()

◆ asRange()

◆ asStmt()

◆ create() [1/2]

◆ create() [2/2]

◆ createBegin() [1/3]

◆ createBegin() [2/3]

◆ createBegin() [3/3]

◆ createBeginBrace()

◆ createConditionalColonLoc()

◆ createDeclBegin()

◆ createDeclEnd()

◆ createEnd()

◆ createEndBrace()

◆ createMemberLoc()

◆ createOperatorLoc()

◆ createSingleLocation()

◆ dump()

◆ flatten()

◆ getManager()

◆ getStmtOrNull()

◆ getValidSourceLocation()

◆ hasRange()

◆ hasValidLocation()

◆ invalidate()

◆ isValid()

◆ operator!=()

◆ operator==()

◆ Profile()