cpg-core/de.fraunhofer.aisec.cpg/CallResolutionResult

CallResolutionResult

data class CallResolutionResult(val source: Expression, val arguments: List<Expression>, var candidateFunctions: Set<FunctionDeclaration>, var viableFunctions: Set<FunctionDeclaration>, var signatureResults: Map<FunctionDeclaration, SignatureResult>, var bestViable: Set<FunctionDeclaration>, var success: CallResolutionResult.SuccessKind, var actualStartScope: Scope?)

This is the result of SymbolResolver.resolveWithArguments. It holds all necessary intermediate results (such as candidateFunctions, viableFunctions) as well as the final result (see bestViable) of the call resolution.

Constructors

constructor(source: Expression, arguments: List<Expression>, candidateFunctions: Set<FunctionDeclaration>, viableFunctions: Set<FunctionDeclaration>, signatureResults: Map<FunctionDeclaration, SignatureResult>, bestViable: Set<FunctionDeclaration>, success: CallResolutionResult.SuccessKind, actualStartScope: Scope?)

Types

SuccessKind

enum SuccessKind : Enum<CallResolutionResult.SuccessKind>

This enum holds information about the kind of success this call resolution had. For example, whether it was successful without any errors or if an ambiguous result was returned.

Properties

actualStartScope

var actualStartScope: Scope?

The actual start scope of the resolution, after ScopeManager.extractScope is called on the callee. This can differ from the original start scope parameter handed to SymbolResolver.resolveWithArguments if the callee contains an FQN.

arguments

val arguments: List<Expression>

The arguments that were supplied to the expression.

bestViable

var bestViable: Set<FunctionDeclaration>

This set contains the best viable function(s) of the viableFunctions. Ideally this is only one, but because of ambiguities or other factors, this can contain multiple functions.

candidateFunctions

var candidateFunctions: Set<FunctionDeclaration>

A set of candidate symbols we discovered based on the CallExpression.callee (using ScopeManager.lookupSymbolByName), more specifically a list of FunctionDeclaration nodes.

signatureResults

var signatureResults: Map<FunctionDeclaration, SignatureResult>

A helper map to store the SignatureResult of each call to FunctionDeclaration.matchesSignature for each function in viableFunctions.

source

val source: Expression

The original expression that triggered the resolution. Most likely a CallExpression.

success

var success: CallResolutionResult.SuccessKind

The kind of success this resolution had.

viableFunctions

var viableFunctions: Set<FunctionDeclaration>

A set of functions, that restrict the candidateFunctions to those whose signature match.