wyil.lang

Class SyntaxTree

java.lang.Object

wyil.lang.SyntaxTree

public class SyntaxTree
extends Object

A SyntaxTree representation of the Whiley Intermediate Language (WyIL). Specifically, bytecodes in WyIL are "flat" rather than being nested trees, etc. This makes them easier to work with for performing optimisation, amongst other things. This also means they are close to their byte-level representation on disk. However, the tree-like nature of a typically abstract syntax tree is convenient in many ways, and this class provides a "wrapper" for bytecodes which makes them appear as a tree-like structure.

Author:

David J. Pearce

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SyntaxTree.Location<T extends Bytecode>

Field Summary

Fields

Modifier and Type	Field and Description
static int	ARGUMENTS
static int	BODY
static int	CONDITION Some helpful context to make reading the code using syntax trees simpler.
static int	END
static int	ENVIRONMENT
static int	FALSEBRANCH
static int	LEFTHANDSIDE
static int	PARAMETERS
static int	RIGHTHANDSIDE
static int	START
static int	TRUEBRANCH
static int	VARIABLE

Constructor Summary

Constructors

Constructor and Description
SyntaxTree(WyilFile.Declaration enclosingDeclaration)

Method Summary

Modifier and Type	Method and Description
WyilFile.Declaration	getEnclosingDeclaration() Get the enclosing declaration of this syntax tree.
int	getIndexOf(SyntaxTree.Location<?> location) Get the index of a given location in this tree.
SyntaxTree.Location<?>	getLocation(int index) Get the location at a given index in this syntax tree.
List<SyntaxTree.Location<?>>	getLocations()
SyntaxTree.Location<?>[]	getLocations(int... indices) Get the location at a given index in this syntax tree.
int	size() Returns the number of locations in this syntax tree.

Methods inherited from class java.lang.Object

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

Field Detail

CONDITION

public static final int CONDITION

Some helpful context to make reading the code using syntax trees simpler.

See Also:

Constant Field Values

BODY

public static final int BODY

See Also:

Constant Field Values

VARIABLE

public static final int VARIABLE

See Also:

Constant Field Values

TRUEBRANCH

public static final int TRUEBRANCH

See Also:

Constant Field Values

PARAMETERS

public static final int PARAMETERS

See Also:

Constant Field Values

ARGUMENTS

public static final int ARGUMENTS

See Also:

Constant Field Values

LEFTHANDSIDE

public static final int LEFTHANDSIDE

See Also:

Constant Field Values

START

public static final int START

See Also:

Constant Field Values

FALSEBRANCH

public static final int FALSEBRANCH

See Also:

Constant Field Values

RIGHTHANDSIDE

public static final int RIGHTHANDSIDE

See Also:

Constant Field Values

ENVIRONMENT

public static final int ENVIRONMENT

See Also:

Constant Field Values

END

public static final int END

See Also:

Constant Field Values

Constructor Detail

SyntaxTree

public SyntaxTree(WyilFile.Declaration enclosingDeclaration)

Method Detail

size

public int size()

Returns the number of locations in this syntax tree.

Returns:

getLocation

public SyntaxTree.Location<?> getLocation(int index)

Get the location at a given index in this syntax tree.

Parameters:

index - --- index of location to return

Returns:

getLocations

public SyntaxTree.Location<?>[] getLocations(int... indices)

Get the location at a given index in this syntax tree.

Parameters:

index - --- index of location to return

Returns:

getLocations

public List<SyntaxTree.Location<?>> getLocations()

getIndexOf

public int getIndexOf(SyntaxTree.Location<?> location)

Get the index of a given location in this tree.

Parameters:

location -

Returns:

getEnclosingDeclaration

public WyilFile.Declaration getEnclosingDeclaration()

Get the enclosing declaration of this syntax tree.

Returns: