Class SourceSectionFilter

java.lang.Object

com.oracle.truffle.api.instrumentation.SourceSectionFilter

public final class SourceSectionFilter
extends Object

A source section filter represents an expression for a subset of tagged source sections that are used in an Truffle interpreter.

Start building event filters by calling newBuilder() and complete them by calling SourceSectionFilter.Builder.build().

Since:

0.12

See Also:

• newBuilder()
• Instrumenter.attachExecutionEventFactory(SourceSectionFilter, ExecutionEventNodeFactory)
• Instrumenter.attachExecutionEventListener(SourceSectionFilter, ExecutionEventListener)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
final class	SourceSectionFilter.Builder	Configure your own SourceSectionFilter before creating its instance.
static final class	SourceSectionFilter.IndexRange	Represents a range between two indices within a source section filter.
static interface	SourceSectionFilter.SourcePredicate	Represents a predicate for source objects.

Field Summary

Fields

Modifier and Type	Field	Description
static final SourceSectionFilter	ANY	A filter that matches everything.

Method Summary

Modifier and Type	Method	Description
boolean	includes(Node node)	Checks if the filter includes the given node, i.e.
boolean	includes(RootNode rootNode, SourceSection nodeSourceSection, Set<Class<?>> originalTags)	Checks if the filter includes the given root node, i.e.
static SourceSectionFilter.Builder	newBuilder()	Creates a new SourceSectionFilter expression using a builder pattern.
String	toString()

Methods inherited from class Object

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

Field Details

ANY

public static final SourceSectionFilter ANY

A filter that matches everything.

Since:

0.18

Method Details

newBuilder

public static SourceSectionFilter.Builder newBuilder()

Creates a new SourceSectionFilter expression using a builder pattern. Individual builder statements are interpreted as conjunctions (AND) while multiple parameters for individual filter expressions are treated as disjunctions (OR). To create the final filter finalize the expression using SourceSectionFilter.Builder.build().

Returns:

a new builder to create new SourceSectionFilter instances

Since:

0.12

See Also:

• SourceSectionFilter.Builder.sourceIs(Source...)
• SourceSectionFilter.Builder.mimeTypeIs(String...)
• SourceSectionFilter.Builder.tagIs(Class...)
• SourceSectionFilter.Builder.tagIsNot(Class...)
• SourceSectionFilter.Builder.sourceSectionEquals(SourceSection...)
• SourceSectionFilter.Builder.indexIn(int, int)
• SourceSectionFilter.Builder.lineIn(int, int)
• SourceSectionFilter.Builder.lineIs(int)
• SourceSectionFilter.Builder.rootNameIs(Predicate)
• SourceSectionFilter.Builder.build()

toString

public String toString()

Overrides:

toString in class Object

Returns:

the filter expressions in a human readable form for debugging.

Since:

0.12

includes

public boolean includes(Node node)

Checks if the filter includes the given node, i.e. do the properties of the node's source section meet the conditions set by the filter.

Parameters:

node - The node to check.

Returns:

True of the filter includes the node, false otherwise.

Since:

19.0.

includes

public boolean includes(RootNode rootNode,
 SourceSection nodeSourceSection,
 Set<Class<?>> originalTags)

Checks if the filter includes the given root node, i.e. do the properties of the given source section meet the conditions set by the filter without an instrumented node.

Parameters:

rootNode - The root node to be checked against the filter.

nodeSourceSection - The source section of the node to be checked against the filter.

Returns:

true if the filter includes the source section and node. false otherwise.

Since:

21.3.0