cpg-core/de.fraunhofer.aisec.cpg.graph.edges.flows/Dataflows

Dataflows

class Dataflows<T : Node>(thisRef: Node, var mirrorProperty: KProperty<MutableCollection<Dataflow>>, outgoing: Boolean) : EdgeSet<Node, Dataflow> , MirroredEdgeCollection<Node, Dataflow>

This class represents a container of Dataflow property edges in a thisRef.

Constructors

Dataflows

constructor(thisRef: Node, mirrorProperty: KProperty<MutableCollection<Dataflow>>, outgoing: Boolean)

Properties

commonType

val Collection<Type>.commonType: Type?

This computed property returns the common type in a Collection of Type objects. For example, if two types A and B both derive from the interface C`` then C` would be returned.

init

open override var init: (start: Node, end: Node) -> Dataflow

mirrorProperty

open override var mirrorProperty: KProperty<MutableCollection<Dataflow>>

onAdd

open override var onAdd: (Dataflow) -> Unit?

onRemove

open override var onRemove: (Dataflow) -> Unit?

outgoing

open override var outgoing: Boolean

size

open override val size: Int

thisRef

open override var thisRef: Node

Functions

add

open fun add(target: Node, init: (Node, Node) -> Dataflow = this.init, builder: Dataflow.() -> Unit? = null): Boolean

Creates a new edge with the target node and an optional builder to include edge properties. If outgoing is true, the edge is created from thisRef ->target, otherwise from target to thisRef.

open override fun add(element: Dataflow): Boolean

addAll

open fun addAll(targets: Collection<Node>, builder: Dataflow.() -> Unit? = null): Boolean

open override fun addAll(elements: Collection<Dataflow>): Boolean

addContextSensitive

fun addContextSensitive(node: T, granularity: Granularity = default(), callingContext: CallingContext)

Adds a ContextSensitiveDataflow edge from/to (depending on outgoing) the node which contains this edge container to/from node, with the given Granularity.

byNameOrNull

fun <T : Node> Collection<T>?.byNameOrNull(lookup: String, modifier: SearchModifier): T?

This function returns the first node that matches the name on the supplied list of nodes.

clear

open override fun clear()

clone

open override fun clone(): Any

contains

open fun contains(target: Node): Boolean

open operator override fun contains(element: Dataflow): Boolean

containsAll

open override fun containsAll(elements: Collection<Dataflow>): Boolean

createEdge

open fun <NodeType : Node, PropertyEdgeType : Edge<NodeType>> createEdge(target: NodeType, init: (Node, NodeType) -> PropertyEdgeType, outgoing: Boolean = true, builder: PropertyEdgeType.() -> Unit? = null): PropertyEdgeType

equals

open operator override fun equals(other: Any?): Boolean

get

operator fun <T : Node> Collection<T>?.get(predicate: (T) -> Boolean, modifier: SearchModifier = SearchModifier.NONE): T?

A shortcut to call firstOrNull using the [] syntax.

operator fun <T : Node> Collection<T>?.get(lookup: String, modifier: SearchModifier = SearchModifier.NONE): T?

A shortcut to call byNameOrNull using the [] syntax.

handleOnAdd

open override fun handleOnAdd(edge: Dataflow)

This connects our dataflow to our "mirror" property. Meaning that if we add a node to nextDFG, we add our thisRef to the "prev" of "next" and vice-versa.

handleOnRemove

open fun handleOnRemove(edge: Dataflow)

This function will be executed after an edge was removed from the container. This can be used to unregister additional handlers, e.g. a TypeObserver.

hashCode

open override fun hashCode(): Int

invoke