clang  6.0.0svn
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
clang::ento::AnyFunctionCall Class Reference

Represents a call to any sort of function that might have a FunctionDecl. More...

#include "clang/StaticAnalyzer/Core/PathSensitive/CallEvent.h"

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

Public Member Functions

const FunctionDeclgetDecl () const override
 Returns the declaration of the function or method that will be called. More...
 
RuntimeDefinition getRuntimeDefinition () const override
 Returns the definition of the function or method that will be called. More...
 
bool argumentsMayEscape () const override
 Returns true if any of the arguments are known to escape to long- term storage, even if this method will not modify them. More...
 
void getInitialStackFrameContents (const StackFrameContext *CalleeCtx, BindingsTy &Bindings) const override
 Populates the given SmallVector with the bindings in the callee's stack frame at the start of this call. More...
 
ArrayRef< ParmVarDecl * > parameters () const override
 Return call's formal parameters. More...
 
- Public Member Functions inherited from clang::ento::CallEvent
virtual ~CallEvent ()
 
virtual Kind getKind () const =0
 Returns the kind of call this is. More...
 
const ProgramStateRefgetState () const
 The state in which the call is being evaluated. More...
 
const LocationContextgetLocationContext () const
 The context in which the call is being evaluated. More...
 
const ExprgetOriginExpr () const
 Returns the expression whose value will be the result of this call. More...
 
virtual unsigned getNumArgs () const =0
 Returns the number of arguments (explicit and implicit). More...
 
bool isInSystemHeader () const
 Returns true if the callee is known to be from a system header. More...
 
bool isCalled (const CallDescription &CD) const
 Returns true if the CallEvent is a call to a function that matches the CallDescription. More...
 
virtual SourceRange getSourceRange () const
 Returns a source range for the entire call, suitable for outputting in diagnostics. More...
 
virtual SVal getArgSVal (unsigned Index) const
 Returns the value of a given argument at the time of the call. More...
 
virtual const ExprgetArgExpr (unsigned Index) const
 Returns the expression associated with a given argument. More...
 
virtual SourceRange getArgSourceRange (unsigned Index) const
 Returns the source range for errors associated with this argument. More...
 
QualType getResultType () const
 Returns the result type, adjusted for references. More...
 
SVal getReturnValue () const
 Returns the return value of the call. More...
 
bool hasNonNullArgumentsWithType (bool(*Condition)(QualType)) const
 Returns true if the type of any of the non-null arguments satisfies the condition. More...
 
bool hasNonZeroCallbackArg () const
 Returns true if any of the arguments appear to represent callbacks. More...
 
bool hasVoidPointerToNonConstArg () const
 Returns true if any of the arguments is void*. More...
 
bool isGlobalCFunction (StringRef SpecificName=StringRef()) const
 Returns true if the callee is an externally-visible function in the top-level namespace, such as malloc. More...
 
const IdentifierInfogetCalleeIdentifier () const
 Returns the name of the callee, if its name is a simple identifier. More...
 
ProgramPoint getProgramPoint (bool IsPreVisit=false, const ProgramPointTag *Tag=nullptr) const
 Returns an appropriate ProgramPoint for this call. More...
 
ProgramStateRef invalidateRegions (unsigned BlockCount, ProgramStateRef Orig=nullptr) const
 Returns a new state with all argument regions invalidated. More...
 
template<typename T >
CallEventRef< TcloneWithState (ProgramStateRef NewState) const
 Returns a copy of this CallEvent, but using the given state. More...
 
CallEventRef cloneWithState (ProgramStateRef NewState) const
 Returns a copy of this CallEvent, but using the given state. More...
 
param_type_iterator param_type_begin () const
 Returns an iterator over the types of the call's formal parameters. More...
 
param_type_iterator param_type_end () const
 
void dump (raw_ostream &Out) const
 
void dump () const
 
template<typename T >
CallEventRef< TcloneWithState (ProgramStateRef NewState) const
 

Static Public Member Functions

static bool classof (const CallEvent *CA)
 
- Static Public Member Functions inherited from clang::ento::CallEvent
static bool isCallStmt (const Stmt *S)
 Returns true if this is a statement is a function or method call of some kind. More...
 
static QualType getDeclaredResultType (const Decl *D)
 Returns the result type of a function or method declaration. More...
 
static bool isVariadic (const Decl *D)
 Returns true if the given decl is known to be variadic. More...
 

Protected Member Functions

 AnyFunctionCall (const Expr *E, ProgramStateRef St, const LocationContext *LCtx)
 
 AnyFunctionCall (const Decl *D, ProgramStateRef St, const LocationContext *LCtx)
 
 AnyFunctionCall (const AnyFunctionCall &Other)
 
- Protected Member Functions inherited from clang::ento::CallEvent
 CallEvent (const Expr *E, ProgramStateRef state, const LocationContext *lctx)
 
 CallEvent (const Decl *D, ProgramStateRef state, const LocationContext *lctx)
 
 CallEvent (const CallEvent &Original)
 
virtual void cloneTo (void *Dest) const =0
 Copies this CallEvent, with vtable intact, into a new block of memory. More...
 
SVal getSVal (const Stmt *S) const
 Get the value of arbitrary expressions at this point in the path. More...
 
virtual void getExtraInvalidatedValues (ValueList &Values, RegionAndSymbolInvalidationTraits *ETraits) const
 Used to specify non-argument regions that will be invalidated as a result of this call. More...
 

Additional Inherited Members

- Public Types inherited from clang::ento::CallEvent
typedef CallEventKind Kind
 
typedef std::pair< Loc, SValFrameBindingTy
 
typedef SmallVectorImpl< FrameBindingTyBindingsTy
 
typedef llvm::mapped_iterator< ArrayRef< ParmVarDecl * >::iterator, GetTypeFn > param_type_iterator
 
- Protected Types inherited from clang::ento::CallEvent
typedef SmallVectorImpl< SValValueList
 
- Protected Attributes inherited from clang::ento::CallEvent
const void * Data
 
SourceLocation Location
 

Detailed Description

Represents a call to any sort of function that might have a FunctionDecl.

Definition at line 422 of file CallEvent.h.

Constructor & Destructor Documentation

◆ AnyFunctionCall() [1/3]

clang::ento::AnyFunctionCall::AnyFunctionCall ( const Expr E,
ProgramStateRef  St,
const LocationContext LCtx 
)
inlineprotected

Definition at line 424 of file CallEvent.h.

◆ AnyFunctionCall() [2/3]

clang::ento::AnyFunctionCall::AnyFunctionCall ( const Decl D,
ProgramStateRef  St,
const LocationContext LCtx 
)
inlineprotected

Definition at line 427 of file CallEvent.h.

◆ AnyFunctionCall() [3/3]

clang::ento::AnyFunctionCall::AnyFunctionCall ( const AnyFunctionCall Other)
inlineprotected

Definition at line 430 of file CallEvent.h.

Member Function Documentation

◆ argumentsMayEscape()

bool AnyFunctionCall::argumentsMayEscape ( ) const
overridevirtual

Returns true if any of the arguments are known to escape to long- term storage, even if this method will not modify them.

Reimplemented from clang::ento::CallEvent.

Definition at line 382 of file CallEvent.cpp.

References clang::ento::CallEvent::argumentsMayEscape(), clang::ento::CallEvent::getDecl(), clang::NamedDecl::getIdentifier(), clang::IdentifierInfo::getName(), clang::ento::CallEvent::hasVoidPointerToNonConstArg(), and clang::IdentifierInfo::isStr().

◆ classof()

static bool clang::ento::AnyFunctionCall::classof ( const CallEvent CA)
inlinestatic

◆ getDecl()

const FunctionDecl* clang::ento::AnyFunctionCall::getDecl ( ) const
inlineoverridevirtual

Returns the declaration of the function or method that will be called.

May be null.

Reimplemented from clang::ento::CallEvent.

Reimplemented in clang::ento::SimpleFunctionCall.

Definition at line 435 of file CallEvent.h.

References clang::ento::CallEvent::getDecl().

Referenced by clang::CXXInstanceCall::getDecl().

◆ getInitialStackFrameContents()

void AnyFunctionCall::getInitialStackFrameContents ( const StackFrameContext CalleeCtx,
BindingsTy Bindings 
) const
overridevirtual

Populates the given SmallVector with the bindings in the callee's stack frame at the start of this call.

Implements clang::ento::CallEvent.

Definition at line 373 of file CallEvent.cpp.

References addParameterValuesToBindings(), clang::LocationContext::getDecl(), clang::ento::CallEvent::getState(), and clang::FunctionDecl::parameters().

Referenced by clang::CXXInstanceCall::getInitialStackFrameContents(), and clang::CXXConstructorCall::getInitialStackFrameContents().

◆ getRuntimeDefinition()

RuntimeDefinition AnyFunctionCall::getRuntimeDefinition ( ) const
overridevirtual

◆ parameters()

ArrayRef< ParmVarDecl * > AnyFunctionCall::parameters ( ) const
overridevirtual

Return call's formal parameters.

Remember that the number of formal parameters may not match the number of arguments for all calls. However, the first parameter will always correspond with the argument value returned by getArgSVal(0).

Implements clang::ento::CallEvent.

Definition at line 342 of file CallEvent.cpp.

References clang::ento::CallEvent::getDecl(), and clang::FunctionDecl::parameters().


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