Package ghidra.trace.database.target.visitors

Class CanonicalSuccessorsRelativeVisitor

java.lang.Object

ghidra.trace.database.target.visitors.CanonicalSuccessorsRelativeVisitor

All Implemented Interfaces:

TreeTraversal.Visitor

public class CanonicalSuccessorsRelativeVisitor
extends Object
implements TreeTraversal.Visitor

Field Summary

Fields

Modifier and Type	Field	Description
protected final PathFilter	filter
protected final Set<TraceObject>	seen

Constructor Summary

Constructors

Constructor	Description
CanonicalSuccessorsRelativeVisitor(PathFilter filter)

Method Summary

Modifier and Type	Method	Description
TraceObjectValPath	composePath(TraceObjectValPath pre, TraceObjectValue value)	When descending in a value, what path leads to the value
Lifespan	composeSpan(Lifespan pre, TraceObjectValue value)	When descending in a value, what span to consider in the subtree
TraceObject	continueObject(TraceObjectValue value)	When descending in a value, the object to consider next
Stream<? extends TraceObjectValue>	continueValues(TraceObject object, Lifespan span, TraceObjectValPath pre)	When descending in an object, the values to consider next
protected TraceObjectValue	getCanonicalValue(TraceObject parent, String key)
TreeTraversal.VisitResult	visitValue(TraceObjectValue value, TraceObjectValPath valPath)	Visit a value

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

filter

protected final PathFilter filter

seen

protected final Set<TraceObject> seen

Constructor Details

CanonicalSuccessorsRelativeVisitor

public CanonicalSuccessorsRelativeVisitor(PathFilter filter)

Method Details

composeSpan

public Lifespan composeSpan(Lifespan pre,
 TraceObjectValue value)

Description copied from interface: TreeTraversal.Visitor

When descending in a value, what span to consider in the subtree

Usually this is intersection. See TreeTraversal.SpanIntersectingVisitor

Specified by:

composeSpan in interface TreeTraversal.Visitor

Parameters:

pre - the span composed from values from seed to but excluding the current value

value - the current value

Returns:

the span composed from values from seed to and including the current value

composePath

public TraceObjectValPath composePath(TraceObjectValPath pre,
 TraceObjectValue value)

Description copied from interface: TreeTraversal.Visitor

When descending in a value, what path leads to the value

This is usually TraceObjectValPath.append(TraceObjectValue) or TraceObjectValPath.prepend(TraceObjectValue).

Specified by:

composePath in interface TreeTraversal.Visitor

Parameters:

pre - the path from seed to the but excluding the current value

value - the path from seed to the and including the current value

Returns:

the path from seed to and including the current value

visitValue

public TreeTraversal.VisitResult visitValue(TraceObjectValue value,
 TraceObjectValPath valPath)

Description copied from interface: TreeTraversal.Visitor

Visit a value

Note that the path is the composed path, so it will likely have the current value at its beginning or end.

Specified by:

visitValue in interface TreeTraversal.Visitor

Parameters:

value - the current value

valPath - the path from seed to value

Returns:

directions for how traversal should proceed

continueObject

public TraceObject continueObject(TraceObjectValue value)

Description copied from interface: TreeTraversal.Visitor

When descending in a value, the object to consider next

This is usually TraceObjectValue.getChild() or TraceObjectValue.getParent().

Specified by:

continueObject in interface TreeTraversal.Visitor

Parameters:

value - the current value

Returns:

the next object

getCanonicalValue

protected TraceObjectValue getCanonicalValue(TraceObject parent,
 String key)

continueValues

public Stream<? extends TraceObjectValue> continueValues(TraceObject object,
 Lifespan span,
 TraceObjectValPath pre)

Description copied from interface: TreeTraversal.Visitor

When descending in an object, the values to consider next

Specified by:

continueValues in interface TreeTraversal.Visitor

Parameters:

object - the current object

span - the composed span of values from seed to the current object

pre - the path from seed to the current object

Returns:

the next values