com.oracle.truffle.tools.agentscript

Class FrameLibrary

java.lang.Object

com.oracle.truffle.api.nodes.Node

com.oracle.truffle.api.library.Library

com.oracle.truffle.tools.agentscript.FrameLibrary

All Implemented Interfaces:

com.oracle.truffle.api.nodes.NodeInterface, Cloneable

public abstract class FrameLibrary
extends com.oracle.truffle.api.library.Library

Encapsulating access to execution frames. GraalVM Insight scripts can access local variables of the dynamically instrumented source code. This library handles such accesses. Implement your own to respond to various messages (like FrameLibrary.readMember(com.oracle.truffle.tools.agentscript.FrameLibrary.Query, java.lang.String)) in a different way - for example by exposing more than it is in their frames for some specific languages.

It is expected more messages appear in this library during its evolution. Such messages will be provided with their appropriate default implementation.

Since:

20.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	FrameLibrary.Query Holds location, environment, etc.

Nested classes/interfaces inherited from class com.oracle.truffle.api.nodes.Node

com.oracle.truffle.api.nodes.Node.Child, com.oracle.truffle.api.nodes.Node.Children

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FrameLibrary() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	collectNames(FrameLibrary.Query env, Set<String> names) Collect names of local variables.
static FrameLibrary	getUncached() Default implementation of the FrameLibrary.
Object	readMember(FrameLibrary.Query env, String member) Reads a value of a local variable.
void	writeMember(FrameLibrary.Query env, String member, Object value) Assigns new value to an existing local variable.

Methods inherited from class com.oracle.truffle.api.library.Library

accepts

Methods inherited from class com.oracle.truffle.api.nodes.Node

accept, adoptChildren, atomic, atomic, copy, deepCopy, getChildren, getCost, getDebugProperties, getDescription, getEncapsulatingSourceSection, getLock, getParent, getRootNode, getSourceSection, insert, insert, isAdoptable, isSafelyReplaceableBy, lookupContextReference, lookupLanguageReference, notifyInserted, onReplace, replace, replace, reportPolymorphicSpecialize, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

FrameLibrary

protected FrameLibrary()

Default constructor.

Since:

20.1

Method Detail

getUncached

public static FrameLibrary getUncached()

Default implementation of the FrameLibrary. Provides the same view of local variables as available to debugger.

Returns:

a shared instance of the library

Since:

20.1

readMember

public Object readMember(FrameLibrary.Query env,
                         String member)
                  throws com.oracle.truffle.api.interop.UnknownIdentifierException

Reads a value of a local variable.

Parameters:

env - location, environment, etc. to read values from

member - the name of the variable to read

Returns:

value of the variable

Throws:

com.oracle.truffle.api.interop.UnknownIdentifierException - thrown when the member is unknown

Since:

20.1

writeMember

public void writeMember(FrameLibrary.Query env,
                        String member,
                        Object value)
                 throws com.oracle.truffle.api.interop.UnknownIdentifierException,
                        com.oracle.truffle.api.interop.UnsupportedTypeException

Assigns new value to an existing local variable.

Parameters:

env - location, environment, etc. to read values from

member - the name of the variable to modify

value - new value for the variable

Throws:

com.oracle.truffle.api.interop.UnknownIdentifierException - if the variable doesn't exist

com.oracle.truffle.api.interop.UnsupportedTypeException - if the type isn't appropriate

Since:

20.1

collectNames

public void collectNames(FrameLibrary.Query env,
                         Set<String> names)
                  throws com.oracle.truffle.api.interop.InteropException

Collect names of local variables.

Parameters:

env - location, environment, etc. to read values from

names - collection to add the names to

Throws:

com.oracle.truffle.api.interop.InteropException - thrown when something goes wrong

Since:

20.1