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

ProgramDependences

class ProgramDependences<NodeType : Node> : EdgeSet<NodeType, Edge<NodeType>> , MirroredEdgeCollection<NodeType, Edge<NodeType>>

A container of Edge edges that act as a program dependence graph (PDG). The canonical version of this lives in Node.prevPDGEdges / Node.nextPDGEdges and is populated by the ProgramDependenceGraphPass.

After population, this collection will contain a direct combination of two other edge collections (Dataflows and ControlDependences). If we would only handle an in-memory graph, we could just store the edges in their original collection (e.g. DFG) as well as in the PDG. But the Neo4J OGM does not support this, so unfortunately, we need to clone the edges before inserting them into the collection. If we ever got rid of the Neo4J OGM we could potentially also remove the cloning.

Constructors

ProgramDependences

constructor(thisRef: Node, mirrorProperty: KProperty<MutableCollection<Edge<NodeType>>>, 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: NodeType) -> Edge<NodeType>

mirrorProperty

open override var mirrorProperty: KProperty<MutableCollection<Edge<NodeType>>>

onAdd

open override var onAdd: (Edge<NodeType>) -> Unit?

onRemove

open override var onRemove: (Edge<NodeType>) -> 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: NodeType, init: (Node, NodeType) -> Edge<NodeType> = this.init, builder: Edge<NodeType>.() -> 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(e: Edge<NodeType>): Boolean

addAll

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

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

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: NodeType): Boolean

open operator override fun contains(element: Edge<NodeType>): Boolean

containsAll

open override fun containsAll(elements: Collection<Edge<NodeType>>): 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 fun handleOnAdd(edge: Edge<NodeType>)

This function will be executed after the edge was added to the container. This can be used to propagate the edge to other properties or register additional handlers, e.g. a TypeObserver.

handleOnRemove