org.graalvm.compiler.printer

Class BinaryGraphPrinter

java.lang.Object

org.graalvm.compiler.printer.BinaryGraphPrinter

All Implemented Interfaces:

GraphBlocks<org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo,Block,Node>, GraphElements<ResolvedJavaMethod,ResolvedJavaField,Signature,NodeSourcePosition>, GraphLocations<ResolvedJavaMethod,NodeSourcePosition,SourceLanguagePosition>, GraphStructure<org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo,Node,NodeClass<?>,Edges>, GraphTypes

public class BinaryGraphPrinter
extends Object
implements GraphStructure<org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo,Node,NodeClass<?>,Edges>, GraphBlocks<org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo,Block,Node>, GraphElements<ResolvedJavaMethod,ResolvedJavaField,Signature,NodeSourcePosition>, GraphLocations<ResolvedJavaMethod,NodeSourcePosition,SourceLanguagePosition>, GraphTypes

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_CONSTANT_TO_STRING_LENGTH
static List<Class<?>>	TRUSTED_CLASSES Classes whose #toString() method does not run any untrusted code.

Constructor Summary

Constructors

Constructor and Description
BinaryGraphPrinter(DebugContext ctx, SnippetReflectionProvider snippetReflection)

Method Summary

Modifier and Type	Method and Description
void	beginGroup(DebugContext debug, String name, String shortName, ResolvedJavaMethod method, int bci, Map<Object,Object> properties) Starts a new group of graphs with the given name, short name and method byte code index (BCI) as properties.
int	blockId(Block sux) Unique id of a block.
List<Node>	blockNodes(org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo info, Block block)
List<Block>	blocks(org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo graph) All blocks in the graph.
List<Block>	blockSuccessors(Block block)
NodeClass<?>	classForNode(Node node) Finds a node class for node.
void	close()
static String	constantArrayToString(Object array, Set<Object> visited)
static String	constantToString(Object value, Set<Object> visited)
boolean	edgeDirect(Edges port, int index) Checks whether an edge is direct.
String	edgeName(Edges port, int index) The name of an edge.
Collection<? extends Node>	edgeNodes(org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo graph, Node node, Edges port, int i) Nodes where the edges for a port lead to/from.
Object	edgeType(Edges port, int index) Type of an edge.
void	endGroup() Ends the current group.
Object	enumClass(Object enumValue) Recognizes an enum object.
int	enumOrdinal(Object obj) Ordinal of an enum.
String[]	enumTypeValues(Object clazz) All possible values of an enum.
ResolvedJavaField	field(Object object) Recognizes a field.
Object	fieldDeclaringClass(ResolvedJavaField field) Field's declaring class.
int	fieldModifiers(ResolvedJavaField field) Field modifiers.
String	fieldName(ResolvedJavaField field) Name of a field.
String	fieldTypeName(ResolvedJavaField field) Type name of the field.
default String	format(JavaConstant constant) Use the real Object.toString() method for JavaConstants that are wrapping trusted types, otherwise just return the result of JavaConstant#toString().
static StructuredGraph.ScheduleResult	getScheduleOrNull(Graph graph)
SnippetReflectionProvider	getSnippetReflectionProvider()
org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo	graph(org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo currrent, Object obj) Casts obj to graph, if possible.
static boolean	isToStringTrusted(Class<?> c) Determines if invoking Object.toString() on an instance of c will only run trusted code.
String	locationLanguage(SourceLanguagePosition location) Identification of the language.
int	locationLineNumber(SourceLanguagePosition location) Line number of a location.
int	locationOffsetEnd(SourceLanguagePosition location) Offset of the location.
int	locationOffsetStart(SourceLanguagePosition location) Offset of the location.
URI	locationURI(SourceLanguagePosition location) The universal resource identification that contains the location.If the location can be found in an assummably accessible resource, then use such resource identification.
ResolvedJavaMethod	method(Object object) Recognize method.
byte[]	methodCode(ResolvedJavaMethod method) Bytecode for a method.
Object	methodDeclaringClass(ResolvedJavaMethod method) Method's declaring class.
Iterable<SourceLanguagePosition>	methodLocation(ResolvedJavaMethod method, int bci, NodeSourcePosition pos) Stack trace element for a method, index and position.
int	methodModifiers(ResolvedJavaMethod method) Method modifiers.
String	methodName(ResolvedJavaMethod method) Method name.
Signature	methodSignature(ResolvedJavaMethod method) Method's signature.
StackTraceElement	methodStackTraceElement(ResolvedJavaMethod method, int bci, NodeSourcePosition pos) Stack trace element for a method, index and position.
String	nameTemplate(NodeClass<?> nodeClass) The template used to build the name of nodes of this class.
Node	node(Object obj) Finds a node for obj, if possible.
NodeClass<?>	nodeClass(Object obj) Finds a node class for obj, if possible.
Object	nodeClassType(NodeClass<?> node) Java class for a node class.
boolean	nodeHasPredecessor(Node node) Checks if there is a predecessor for a node.
int	nodeId(Node n) Id of node.
void	nodeProperties(org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo info, Node node, Map<String,? super Object> props) Collects node properties.
Iterable<Node>	nodes(org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo info) Nodes of a graph.
int	nodesCount(org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo info) Number of nodes in a graph.
NodeSourcePosition	nodeSourcePosition(Object object) Recognize a source position.
int	nodeSourcePositionBCI(NodeSourcePosition pos) Byte code index of a position.
NodeSourcePosition	nodeSourcePositionCaller(NodeSourcePosition pos) Caller of a position.
ResolvedJavaMethod	nodeSourcePositionMethod(NodeSourcePosition pos) Method for a position.
Edges	portInputs(NodeClass<?> nodeClass) Input ports of a node class.
Edges	portOutputs(NodeClass<?> nodeClass) Output ports of a node class.
int	portSize(Edges port) The number of edges in a port.
void	print(DebugContext debug, Graph graph, Map<Object,Object> properties, int id, String format, Object... args) Prints an entire Graph with the specified title, optionally using short names for nodes.
Signature	signature(Object object) Recognizes signature.
int	signatureParameterCount(Signature signature) Number of parameters of a signature.
String	signatureParameterTypeName(Signature signature, int index) Type name of a signature parameter.
String	signatureReturnTypeName(Signature signature) Type name of a return type.
default Object[]	simplifyClassArgs(Object... args) Replaces all JavaType elements in args with the result of JavaType.getUnqualifiedName().
static String	truncate(String s)
String	typeName(Object obj) Finds Java type name for a given class.
default void	updateStringPropertiesForConstant(Map<Object,Object> props, ConstantNode cn) Sets or updates the "rawvalue" and "toString" properties in props for cn if it's a boxed Object value and snippetReflection can access the raw value.

Methods inherited from class java.lang.Object

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

Field Detail

TRUSTED_CLASSES

public static final List<Class<?>> TRUSTED_CLASSES

Classes whose #toString() method does not run any untrusted code.

MAX_CONSTANT_TO_STRING_LENGTH

public static final int MAX_CONSTANT_TO_STRING_LENGTH

See Also:

Constant Field Values

Constructor Detail

BinaryGraphPrinter

public BinaryGraphPrinter(DebugContext ctx,
                          SnippetReflectionProvider snippetReflection)
                   throws IOException

Throws:

IOException

Method Detail

getSnippetReflectionProvider

public SnippetReflectionProvider getSnippetReflectionProvider()

beginGroup

public void beginGroup(DebugContext debug,
                       String name,
                       String shortName,
                       ResolvedJavaMethod method,
                       int bci,
                       Map<Object,Object> properties)
                throws IOException

Starts a new group of graphs with the given name, short name and method byte code index (BCI) as properties.

Throws:

IOException

endGroup

public void endGroup()
              throws IOException

Ends the current group.

Throws:

IOException

close

public void close()

method

public ResolvedJavaMethod method(Object object)

Description copied from interface: GraphElements

Recognize method. Can the object be seen as a method?

Specified by:

method in interface GraphElements<ResolvedJavaMethod,ResolvedJavaField,Signature,NodeSourcePosition>

Parameters:

object - the object to check

Returns:

null if the object isn't a method, non-null value otherwise

node

public Node node(Object obj)

Description copied from interface: GraphStructure

Finds a node for obj, if possible. If the given object obj can be seen as an instance of node return the properly typed instance of the node class. Otherwise return null.

Specified by:

node in interface GraphStructure<org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo,Node,NodeClass<?>,Edges>

Parameters:

obj - an object to find node for

Returns:

appropriate graph object or null if the object doesn't represent a node

nodeClass

public NodeClass<?> nodeClass(Object obj)

Description copied from interface: GraphStructure

Finds a node class for obj, if possible. If the given object obj can be seen as an instance of node class return the properly typed instance of the node class. Otherwise return null.

Specified by:

nodeClass in interface GraphStructure<org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo,Node,NodeClass<?>,Edges>

Parameters:

obj - an object to find node class for

Returns:

appropriate graph object or null if the object doesn't represent a node class

classForNode

public NodeClass<?> classForNode(Node node)

Description copied from interface: GraphStructure

Finds a node class for node.

Specified by:

classForNode in interface GraphStructure<org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo,Node,NodeClass<?>,Edges>

Parameters:

node - an instance of node in this graph

Returns:

the node's node class, never null

nodeClassType

public Object nodeClassType(NodeClass<?> node)

Description copied from interface: GraphStructure

Java class for a node class.

Specified by:

nodeClassType in interface GraphStructure<org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo,Node,NodeClass<?>,Edges>

Parameters:

node - the node class

Returns:

the Class or other type representation of the node class

nameTemplate

public String nameTemplate(NodeClass<?> nodeClass)

Description copied from interface: GraphStructure

The template used to build the name of nodes of this class. The template may use references to inputs ({i#inputName}) and its properties ({p#propertyName}).

Specified by:

nameTemplate in interface GraphStructure<org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo,Node,NodeClass<?>,Edges>

Parameters:

nodeClass - the node class to find name template for

Returns:

the string representing the template

graph

public final org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo graph(org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo currrent,
                                                                             Object obj)

Description copied from interface: GraphStructure

Casts obj to graph, if possible. If the given object obj can be seen as a graph or sub-graph of a graph, then return the properly typed instance. Otherwise return null

Specified by:

graph in interface GraphStructure<org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo,Node,NodeClass<?>,Edges>

Parameters:

currrent - the currently processed graph

obj - an object to check and view as a graph

Returns:

appropriate graph object or null if the object doesn't represent a graph

nodeId

public int nodeId(Node n)

Description copied from interface: GraphStructure

Id of node. Each node in the graph is uniquely identified by an integer value. If two nodes have the same id, then they shall be == to each other.

Specified by:

nodeId in interface GraphStructure<org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo,Node,NodeClass<?>,Edges>

Parameters:

n - the node to query for an id

Returns:

the id of the node

portInputs

public Edges portInputs(NodeClass<?> nodeClass)

Description copied from interface: GraphStructure

Input ports of a node class. Each node class has a fixed set of ports where individual edges can attach to.

Specified by:

portInputs in interface GraphStructure<org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo,Node,NodeClass<?>,Edges>

Parameters:

nodeClass - the node class

Returns:

input ports for the node class

portOutputs

public Edges portOutputs(NodeClass<?> nodeClass)

Description copied from interface: GraphStructure

Output ports of a node class. Each node class has a fixed set of ports from where individual edges can point to other nodes.

Specified by:

portOutputs in interface GraphStructure<org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo,Node,NodeClass<?>,Edges>

Parameters:

nodeClass - the node class

Returns:

output ports for the node class

blockNodes

public List<Node> blockNodes(org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo info,
                             Block block)

Specified by:

blockNodes in interface GraphBlocks<org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo,Block,Node>

blockId

public int blockId(Block sux)

Description copied from interface: GraphBlocks

Unique id of a block.

Specified by:

blockId in interface GraphBlocks<org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo,Block,Node>

Parameters:

sux - the block

Returns:

the id of the block

blockSuccessors

public List<Block> blockSuccessors(Block block)

Specified by:

blockSuccessors in interface GraphBlocks<org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo,Block,Node>

nodes

public Iterable<Node> nodes(org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo info)

Description copied from interface: GraphStructure

Nodes of a graph. Each graph is composed from a fixed set of nodes. This method returns an iterable which provides access to all of them - the number of nodes provided by the iterable must match the number returned by GraphStructure.nodesCount(java.lang.Object) method.

Specified by:

nodes in interface GraphStructure<org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo,Node,NodeClass<?>,Edges>

Parameters:

info - the graph to query for nodes

Returns:

iterable with all the graph's nodes

See Also:

GraphStructure.nodesCount(java.lang.Object)

nodesCount

public int nodesCount(org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo info)

Description copied from interface: GraphStructure

Number of nodes in a graph. The number must match the content returned by GraphStructure.nodes(java.lang.Object) method.

Specified by:

nodesCount in interface GraphStructure<org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo,Node,NodeClass<?>,Edges>

Parameters:

info - the graph to query

Returns:

the number of nodes that will be returned by GraphStructure.nodes(java.lang.Object)

nodeProperties

public void nodeProperties(org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo info,
                           Node node,
                           Map<String,? super Object> props)

Description copied from interface: GraphStructure

Collects node properties. Each node can be associated with additional properties identified by their name. This method shall copy them into the provided map.

Specified by:

nodeProperties in interface GraphStructure<org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo,Node,NodeClass<?>,Edges>

Parameters:

info - the current graph

node - the node to collect properties for

props - the map to put the properties to

nodeHasPredecessor

public boolean nodeHasPredecessor(Node node)

Description copied from interface: GraphStructure

Checks if there is a predecessor for a node.

Specified by:

nodeHasPredecessor in interface GraphStructure<org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo,Node,NodeClass<?>,Edges>

Parameters:

node - the node to check

Returns:

true if it has a predecessor, false otherwise

blocks

public List<Block> blocks(org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo graph)

Description copied from interface: GraphBlocks

All blocks in the graph.

Specified by:

blocks in interface GraphBlocks<org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo,Block,Node>

Parameters:

graph - the graph

Returns:

collection of blocks in the graph

print

public void print(DebugContext debug,
                  Graph graph,
                  Map<Object,Object> properties,
                  int id,
                  String format,
                  Object... args)
           throws IOException

Prints an entire Graph with the specified title, optionally using short names for nodes.

Throws:

IOException

portSize

public int portSize(Edges port)

Description copied from interface: GraphStructure

The number of edges in a port. The protocol will then call methods GraphStructure.edgeDirect(java.lang.Object, int), GraphStructure.edgeName(java.lang.Object, int), GraphStructure.edgeType(java.lang.Object, int) and GraphStructure.edgeNodes(java.lang.Object, java.lang.Object, java.lang.Object, int) for indexes from 0 to portSize - 1

Specified by:

portSize in interface GraphStructure<org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo,Node,NodeClass<?>,Edges>

Parameters:

port - the port

Returns:

number of edges in this port

edgeDirect

public boolean edgeDirect(Edges port,
                          int index)

Description copied from interface: GraphStructure

Checks whether an edge is direct. Direct edge shall have exactly one node - it is an error to return more than one for such an edge from the method.

Specified by:

edgeDirect in interface GraphStructure<org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo,Node,NodeClass<?>,Edges>

Parameters:

port - the port

index - index from 0 to GraphStructure.portSize(java.lang.Object) minus 1

Returns:

true if only one node can be returned from GraphStructure.edgeNodes(java.lang.Object, java.lang.Object, java.lang.Object, int) method

edgeName

public String edgeName(Edges port,
                       int index)

Description copied from interface: GraphStructure

The name of an edge.

Specified by:

edgeName in interface GraphStructure<org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo,Node,NodeClass<?>,Edges>

Parameters:

port - the port

index - index from 0 to GraphStructure.portSize(java.lang.Object) minus 1

Returns:

the name of the edge

edgeType

public Object edgeType(Edges port,
                       int index)

Description copied from interface: GraphStructure

Type of an edge. The type must be a graph enum - e.g. either real instance of Enum subclass, or something that the GraphOutput.Builder can recognize as enum.

Specified by:

edgeType in interface GraphStructure<org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo,Node,NodeClass<?>,Edges>

index - index from 0 to GraphStructure.portSize(java.lang.Object) minus 1

Returns:

any Enum representing type of the edge

edgeNodes

public Collection<? extends Node> edgeNodes(org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo graph,
                                            Node node,
                                            Edges port,
                                            int i)

Description copied from interface: GraphStructure

Nodes where the edges for a port lead to/from. This method is called for both direct/non-direct edges. In case of a direct edge the returned collection must have exactly one element.

Specified by:

edgeNodes in interface GraphStructure<org.graalvm.compiler.printer.BinaryGraphPrinter.GraphInfo,Node,NodeClass<?>,Edges>

Parameters:

graph - the graph

node - the node in the graph

port - port of the node class

i - index from 0 to GraphStructure.portSize(java.lang.Object) minus 1

Returns:

null if there are no edges associated with given port or collection of nodes where to/from the edges lead to

enumClass

public Object enumClass(Object enumValue)

Description copied from interface: GraphTypes

Recognizes an enum object. If the enumValue object represents an enum, then an object that represents its class shall be returned.

Specified by:

enumClass in interface GraphTypes

Parameters:

enumValue - the value to test

Returns:

null if the value isn't enum, otherwise its class

enumOrdinal

public int enumOrdinal(Object obj)

Description copied from interface: GraphTypes

Ordinal of an enum. If the obj represents an enum, then return its ordinal number otherwise return -1

Specified by:

enumOrdinal in interface GraphTypes

Parameters:

obj - the value to test

Returns:

-1 if the obj isn't enum, otherwise its ordinal number

enumTypeValues

public String[] enumTypeValues(Object clazz)

Description copied from interface: GraphTypes

All possible values of an enum. If the provided maybeEnumClass object represents an enum, then compute enum value names in ordinal order and return them as a string array. Otherwise return null

Specified by:

enumTypeValues in interface GraphTypes

Parameters:

clazz - the class to test

Returns:

null if the clazz isn't an enum, otherwise names of its values

typeName

public String typeName(Object obj)

Description copied from interface: GraphTypes

Finds Java type name for a given class.

Specified by:

typeName in interface GraphTypes

Parameters:

obj - object representing the class

Returns:

the type name of the class or null if the parameter doesn't represent a class

methodCode

public byte[] methodCode(ResolvedJavaMethod method)

Description copied from interface: GraphElements

Bytecode for a method.

Specified by:

methodCode in interface GraphElements<ResolvedJavaMethod,ResolvedJavaField,Signature,NodeSourcePosition>

Parameters:

method - the method

Returns:

bytecode of the method

methodModifiers

public int methodModifiers(ResolvedJavaMethod method)

Description copied from interface: GraphElements

Method modifiers.

Specified by:

methodModifiers in interface GraphElements<ResolvedJavaMethod,ResolvedJavaField,Signature,NodeSourcePosition>

Parameters:

method - the method

Returns:

its modifiers

methodSignature

public Signature methodSignature(ResolvedJavaMethod method)

Description copied from interface: GraphElements

Method's signature.

Specified by:

methodSignature in interface GraphElements<ResolvedJavaMethod,ResolvedJavaField,Signature,NodeSourcePosition>

Parameters:

method - the method

Returns:

signature of the method

methodName

public String methodName(ResolvedJavaMethod method)

Description copied from interface: GraphElements

Method name.

Specified by:

methodName in interface GraphElements<ResolvedJavaMethod,ResolvedJavaField,Signature,NodeSourcePosition>

Parameters:

method - the method

Returns:

name of the method

methodDeclaringClass

public Object methodDeclaringClass(ResolvedJavaMethod method)

Description copied from interface: GraphElements

Method's declaring class. The returned object shall be a Class or be recognizable by GraphTypes.typeName(java.lang.Object) method.

Specified by:

methodDeclaringClass in interface GraphElements<ResolvedJavaMethod,ResolvedJavaField,Signature,NodeSourcePosition>

Parameters:

method - the method

Returns:

object representing class that defined the method

fieldModifiers

public int fieldModifiers(ResolvedJavaField field)

Description copied from interface: GraphElements

Field modifiers.

Specified by:

fieldModifiers in interface GraphElements<ResolvedJavaMethod,ResolvedJavaField,Signature,NodeSourcePosition>

Parameters:

field - the field

Returns:

field modifiers

fieldTypeName

public String fieldTypeName(ResolvedJavaField field)

Description copied from interface: GraphElements

Type name of the field.

Specified by:

fieldTypeName in interface GraphElements<ResolvedJavaMethod,ResolvedJavaField,Signature,NodeSourcePosition>

Parameters:

field - the field

Returns:

the name of the field's type

fieldName

public String fieldName(ResolvedJavaField field)

Description copied from interface: GraphElements

Name of a field.

Specified by:

fieldName in interface GraphElements<ResolvedJavaMethod,ResolvedJavaField,Signature,NodeSourcePosition>

Parameters:

field - the field

Returns:

the name of the field

fieldDeclaringClass

public Object fieldDeclaringClass(ResolvedJavaField field)

Description copied from interface: GraphElements

Field's declaring class. The returned object shall be a Class or be recognizable by GraphTypes.typeName(java.lang.Object) method.

Specified by:

fieldDeclaringClass in interface GraphElements<ResolvedJavaMethod,ResolvedJavaField,Signature,NodeSourcePosition>

Parameters:

field - the field

Returns:

object representing class that defined the field

field

public ResolvedJavaField field(Object object)

Description copied from interface: GraphElements

Recognizes a field. Can the object be seen as a field?

Specified by:

field in interface GraphElements<ResolvedJavaMethod,ResolvedJavaField,Signature,NodeSourcePosition>

Parameters:

object - the object to check

Returns:

null if the object isn't a field, non-null value otherwise

signature

public Signature signature(Object object)

Description copied from interface: GraphElements

Recognizes signature. Can the object be seen as a signature?

Specified by:

signature in interface GraphElements<ResolvedJavaMethod,ResolvedJavaField,Signature,NodeSourcePosition>

Parameters:

object - the object to check

Returns:

null if the object isn't a signature, non-null value otherwise

signatureParameterCount

public int signatureParameterCount(Signature signature)

Description copied from interface: GraphElements

Number of parameters of a signature.

Specified by:

signatureParameterCount in interface GraphElements<ResolvedJavaMethod,ResolvedJavaField,Signature,NodeSourcePosition>

Parameters:

signature - the signature

Returns:

number of parameters

signatureParameterTypeName

public String signatureParameterTypeName(Signature signature,
                                         int index)

Description copied from interface: GraphElements

Type name of a signature parameter.

Specified by:

signatureParameterTypeName in interface GraphElements<ResolvedJavaMethod,ResolvedJavaField,Signature,NodeSourcePosition>

Parameters:

signature - the signature

index - index from 0 to GraphElements.signatureParameterCount(java.lang.Object) - 1

Returns:

the type name

signatureReturnTypeName

public String signatureReturnTypeName(Signature signature)

Description copied from interface: GraphElements

Type name of a return type.

Specified by:

signatureReturnTypeName in interface GraphElements<ResolvedJavaMethod,ResolvedJavaField,Signature,NodeSourcePosition>

Parameters:

signature - the signature

Returns:

the type name

nodeSourcePosition

public NodeSourcePosition nodeSourcePosition(Object object)

Description copied from interface: GraphElements

Recognize a source position. Can the object be seen as a position?

Specified by:

nodeSourcePosition in interface GraphElements<ResolvedJavaMethod,ResolvedJavaField,Signature,NodeSourcePosition>

Parameters:

object - the object to check

Returns:

null if the object isn't a position, non-null otherwise

nodeSourcePositionMethod

public ResolvedJavaMethod nodeSourcePositionMethod(NodeSourcePosition pos)

Description copied from interface: GraphElements

Method for a position.

Specified by:

nodeSourcePositionMethod in interface GraphElements<ResolvedJavaMethod,ResolvedJavaField,Signature,NodeSourcePosition>

Parameters:

pos - the position

Returns:

the method at the position

nodeSourcePositionCaller

public NodeSourcePosition nodeSourcePositionCaller(NodeSourcePosition pos)

Description copied from interface: GraphElements

Caller of a position.

Specified by:

nodeSourcePositionCaller in interface GraphElements<ResolvedJavaMethod,ResolvedJavaField,Signature,NodeSourcePosition>

Parameters:

pos - the position

Returns:

null or another position

nodeSourcePositionBCI

public int nodeSourcePositionBCI(NodeSourcePosition pos)

Description copied from interface: GraphElements

Byte code index of a position.

Specified by:

nodeSourcePositionBCI in interface GraphElements<ResolvedJavaMethod,ResolvedJavaField,Signature,NodeSourcePosition>

Parameters:

pos - the position

Returns:

the BCI of the position

methodStackTraceElement

public StackTraceElement methodStackTraceElement(ResolvedJavaMethod method,
                                                 int bci,
                                                 NodeSourcePosition pos)

Description copied from interface: GraphElements

Stack trace element for a method, index and position. This is the basic version of the method that works with StackTraceElement and is suitable for Java-like languages. Should you need to provide more details about the location of multiple strata, see GraphLocations interface that gives more control over the provided location data.

Specified by:

methodStackTraceElement in interface GraphElements<ResolvedJavaMethod,ResolvedJavaField,Signature,NodeSourcePosition>

Parameters:

method - the method

bci - the index

pos - the position

Returns:

stack trace element for the method, index and position

methodLocation

public Iterable<SourceLanguagePosition> methodLocation(ResolvedJavaMethod method,
                                                       int bci,
                                                       NodeSourcePosition pos)

Description copied from interface: GraphLocations

Stack trace element for a method, index and position. Returns all applicable source locations for given code position. Each provided location is expected to represent location in a different language.

Specified by:

methodLocation in interface GraphLocations<ResolvedJavaMethod,NodeSourcePosition,SourceLanguagePosition>

Parameters:

method - the method

bci - the index

pos - the position

Returns:

elements representing location for all language strata

locationLanguage

public String locationLanguage(SourceLanguagePosition location)

Description copied from interface: GraphLocations

Identification of the language. Each location can point to a source in a different language - e.g. each location can have multiple strata.

Specified by:

locationLanguage in interface GraphLocations<ResolvedJavaMethod,NodeSourcePosition,SourceLanguagePosition>

Parameters:

location - the location

Returns:

id of the language/strata

locationURI

public URI locationURI(SourceLanguagePosition location)

Description copied from interface: GraphLocations

The universal resource identification that contains the location.If the location can be found in an assummably accessible resource, then use such resource identification. It is up to the side processing the URI to load the content from the location. Protocols scheme file, http, or https are assumed to be accessible.

If the location is inside of a virtual source, or source which is unlikely to be accessible outside of running program, then it may be better to encode the whole source into the resource identifier. This can be done by using data URIs like:

 data:text/javascript,alert('Vivat graphs!')
 

Specified by:

locationURI in interface GraphLocations<ResolvedJavaMethod,NodeSourcePosition,SourceLanguagePosition>

Parameters:

location - the location

Returns:

the file name for the given location or null if it is not known

locationLineNumber

public int locationLineNumber(SourceLanguagePosition location)

Description copied from interface: GraphLocations

Line number of a location. The first line in the source file is one. Negative value means the line location isn't available. In such situation one can provide an offset driven location co-ordinates via GraphLocations.locationOffsetStart(java.lang.Object) and GraphLocations.locationOffsetEnd(java.lang.Object) methods.

Specified by:

locationLineNumber in interface GraphLocations<ResolvedJavaMethod,NodeSourcePosition,SourceLanguagePosition>

Parameters:

location - the location

Returns:

the line number for given location, negative value means no line

locationOffsetStart

public int locationOffsetStart(SourceLanguagePosition location)

Description copied from interface: GraphLocations

Offset of the location. In certain situations it is preferrable to specify offset rather than line number of a location in source. In such case return the start offset from this method and end offset via GraphLocations.locationOffsetEnd(java.lang.Object) method. Offsets are counted from 0.

Specified by:

locationOffsetStart in interface GraphLocations<ResolvedJavaMethod,NodeSourcePosition,SourceLanguagePosition>

Parameters:

location - the location

Returns:

the starting offset of the location, negative value means no offset

locationOffsetEnd

public int locationOffsetEnd(SourceLanguagePosition location)

Description copied from interface: GraphLocations

Offset of the location. In certain situations it is preferrable to specify offset rather than line number of a location in source. In such case return the start offset via GraphLocations.locationOffsetStart(java.lang.Object) method and end from this method. Offsets are counted from 0.

Specified by:

locationOffsetEnd in interface GraphLocations<ResolvedJavaMethod,NodeSourcePosition,SourceLanguagePosition>

Parameters:

location - the location

Returns:

the end offset (exclusive) of the location, negative value means no offset

isToStringTrusted

public static boolean isToStringTrusted(Class<?> c)

Determines if invoking Object.toString() on an instance of c will only run trusted code.

format

public String format(JavaConstant constant)

Use the real Object.toString() method for JavaConstants that are wrapping trusted types, otherwise just return the result of JavaConstant#toString().

Specified by:

format in interface JavaConstantFormatter

updateStringPropertiesForConstant

public void updateStringPropertiesForConstant(Map<Object,Object> props,
                                              ConstantNode cn)

Sets or updates the "rawvalue" and "toString" properties in props for cn if it's a boxed Object value and snippetReflection can access the raw value.

simplifyClassArgs

public Object[] simplifyClassArgs(Object... args)

Replaces all JavaType elements in args with the result of JavaType.getUnqualifiedName().

Returns:

a copy of args with the above mentioned substitutions or args if no substitutions were performed

truncate

public static String truncate(String s)

constantToString

public static String constantToString(Object value,
                                      Set<Object> visited)

constantArrayToString

public static String constantArrayToString(Object array,
                                           Set<Object> visited)

getScheduleOrNull

public static StructuredGraph.ScheduleResult getScheduleOrNull(Graph graph)