Class StandardTags.ReadVariableTag

java.lang.Object

com.oracle.truffle.api.instrumentation.Tag

com.oracle.truffle.api.instrumentation.StandardTags.ReadVariableTag

Enclosing class:

StandardTags

public static final class StandardTags.ReadVariableTag
extends Tag

Marks program locations to be considered as reads of variables of the languages.

Use case descriptions:

• Language Server Protocol: Marks every read of a variable to support the documentHighlight, hover, definition and references requests.

To determine the name of the variable, it is required that a node tagged with StandardTags.ReadVariableTag also provides a node object that has NAME property. The value of that property is either:

• a String name of the variable (in that case the node's source section is considered as the variable's source section),
• an object that provides name and SourceSection via InteropLibrary.asString(Object) and InteropLibrary.getSourceLocation(Object) respectively,
• an array of objects when multiple variables are being read, where each array element provides name and SourceSection as specified above.

Furthermore, nodes tagged with StandardTags.ReadVariableTag have to provide a source section.

Since:

20.0.0

Nested Class Summary

Nested classes/interfaces inherited from class com.oracle.truffle.api.instrumentation.Tag

Tag.Identifier

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME	Property of the node object that contains name of the variable.

Method Summary

Methods inherited from class com.oracle.truffle.api.instrumentation.Tag

findProvidedTag, getIdentifier

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

Property of the node object that contains name of the variable.

Since:

20.0.0

See Also:

• Constant Field Values