wyal.heap

Class AbstractSyntacticItem

java.lang.Object

wybs.lang.SyntacticElement.Impl

wyal.heap.AbstractSyntacticItem

All Implemented Interfaces:

Comparable<SyntacticItem>, SyntacticItem, wybs.lang.SyntacticElement

Direct Known Subclasses:

WyalFile.Declaration.Assert, WyalFile.Declaration.Import, WyalFile.Declaration.Named.FunctionOrMacro, WyalFile.Declaration.Named.Type, WyalFile.Expr.Cast, WyalFile.Expr.Constant, WyalFile.Expr.Invoke, WyalFile.Expr.Is, WyalFile.Expr.Operator, WyalFile.Expr.Quantifier, WyalFile.Expr.RecordAccess, WyalFile.Expr.RecordInitialiser, WyalFile.Expr.RecordUpdate, WyalFile.Expr.VariableAccess, WyalFile.FieldDeclaration, WyalFile.Identifier, WyalFile.Name, WyalFile.Pair, WyalFile.Stmt.Block, WyalFile.Stmt.CaseOf, WyalFile.Stmt.IfThen, WyalFile.Stmt.Quantifier, WyalFile.Tuple, WyalFile.Type.Atom, WyalFile.Type.Negation, WyalFile.Type.Nominal, WyalFile.Type.UnionOrIntersection, WyalFile.Value, WyalFile.VariableDeclaration, WyalFile.VerificationError

public abstract class AbstractSyntacticItem
extends wybs.lang.SyntacticElement.Impl
implements Comparable<SyntacticItem>, SyntacticItem

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractSyntacticItem.Blocks
static class	AbstractSyntacticItem.Extras
static class	AbstractSyntacticItem.Operands
static class	AbstractSyntacticItem.Schema

Nested classes/interfaces inherited from interface wybs.lang.SyntacticElement

wybs.lang.SyntacticElement.Impl

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	data

Constructor Summary

Constructors

Modifier	Constructor and Description
	AbstractSyntacticItem(WyalFile.Opcode opcode)
	AbstractSyntacticItem(WyalFile.Opcode opcode, wybs.lang.Attribute... attributes)
	AbstractSyntacticItem(WyalFile.Opcode opcode, List<SyntacticItem> operands, wybs.lang.Attribute... attributes)
protected	AbstractSyntacticItem(WyalFile.Opcode opcode, Object data, SyntacticItem[] operands, wybs.lang.Attribute... attributes)
	AbstractSyntacticItem(WyalFile.Opcode opcode, SyntacticItem[] operands, wybs.lang.Attribute... attributes)
	AbstractSyntacticItem(WyalFile.Opcode opcode, SyntacticItem operand, wybs.lang.Attribute... attributes)
	AbstractSyntacticItem(WyalFile.Opcode opcode, SyntacticItem first, SyntacticItem second, wybs.lang.Attribute... attributes)
	AbstractSyntacticItem(WyalFile.Opcode opcode, SyntacticItem first, SyntacticItem second, SyntacticItem third, wybs.lang.Attribute... attributes)

Method Summary

Modifier and Type	Method and Description
void	allocate(SyntacticHeap heap, int index) Allocated the given item to a syntactic heap.
int	compareTo(SyntacticItem other)
boolean	equals(Object o)
Object	getData() Get any data associated with this item.
int	getIndex() Get the index of this item in the parent's items table.
WyalFile.Opcode	getOpcode() The opcode which defines what this bytecode does.
SyntacticItem	getOperand(int i) Return the ith top-level operand in this bytecode.
SyntacticItem[]	getOperands() Return the top-level operands in this bytecode.
SyntacticHeap	getParent() Get the enclosing compilation unit in which this syntactic item is contained.
int	hashCode()
void	setOpcode(WyalFile.Opcode opcode) Mutate the opcode of this item
void	setOperand(int ith, SyntacticItem child) Mutate the ith child of this item
int	size() Get the number of operands in this bytecode
String	toString()

Methods inherited from class wybs.lang.SyntacticElement.Impl

attribute, attributes

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface wyal.lang.SyntacticItem

clone

Methods inherited from interface wybs.lang.SyntacticElement

attribute, attributes

Field Detail

data

protected Object data

Constructor Detail

AbstractSyntacticItem

public AbstractSyntacticItem(WyalFile.Opcode opcode)

AbstractSyntacticItem

public AbstractSyntacticItem(WyalFile.Opcode opcode,
                             wybs.lang.Attribute... attributes)

AbstractSyntacticItem

public AbstractSyntacticItem(WyalFile.Opcode opcode,
                             SyntacticItem operand,
                             wybs.lang.Attribute... attributes)

AbstractSyntacticItem

public AbstractSyntacticItem(WyalFile.Opcode opcode,
                             SyntacticItem first,
                             SyntacticItem second,
                             wybs.lang.Attribute... attributes)

AbstractSyntacticItem

public AbstractSyntacticItem(WyalFile.Opcode opcode,
                             SyntacticItem first,
                             SyntacticItem second,
                             SyntacticItem third,
                             wybs.lang.Attribute... attributes)

AbstractSyntacticItem

public AbstractSyntacticItem(WyalFile.Opcode opcode,
                             List<SyntacticItem> operands,
                             wybs.lang.Attribute... attributes)

AbstractSyntacticItem

public AbstractSyntacticItem(WyalFile.Opcode opcode,
                             SyntacticItem[] operands,
                             wybs.lang.Attribute... attributes)

AbstractSyntacticItem

protected AbstractSyntacticItem(WyalFile.Opcode opcode,
                                Object data,
                                SyntacticItem[] operands,
                                wybs.lang.Attribute... attributes)

Method Detail

getParent

public SyntacticHeap getParent()

Description copied from interface: SyntacticItem

Get the enclosing compilation unit in which this syntactic item is contained. This maybe null if the item is not yet allocate to a heap.

Specified by:

getParent in interface SyntacticItem

Returns:

allocate

public void allocate(SyntacticHeap heap,
                     int index)

Description copied from interface: SyntacticItem

Allocated the given item to a syntactic heap. Note that an item can only be allocated to one heap at a time. Therefore, an exception will be raised if this item is already allocated to another heap.

Specified by:

allocate in interface SyntacticItem

Parameters:

heap - The heap into which this item is being allocated

index - The index at which this item is being allocated

getOpcode

public WyalFile.Opcode getOpcode()

Description copied from interface: SyntacticItem

The opcode which defines what this bytecode does. Observe that certain bytecodes must correspond with specific subclasses. For example, opcode == LOAD always indicates that this is an instanceof Load.

Specified by:

getOpcode in interface SyntacticItem

setOpcode

public void setOpcode(WyalFile.Opcode opcode)

Description copied from interface: SyntacticItem

Mutate the opcode of this item

Specified by:

setOpcode in interface SyntacticItem

size

public int size()

Description copied from interface: SyntacticItem

Get the number of operands in this bytecode

Specified by:

size in interface SyntacticItem

Returns:

getOperand

public SyntacticItem getOperand(int i)

Description copied from interface: SyntacticItem

Return the ith top-level operand in this bytecode.

Specified by:

getOperand in interface SyntacticItem

Returns:

setOperand

public void setOperand(int ith,
                       SyntacticItem child)

Description copied from interface: SyntacticItem

Mutate the ith child of this item

Specified by:

setOperand in interface SyntacticItem

getOperands

public SyntacticItem[] getOperands()

Description copied from interface: SyntacticItem

Return the top-level operands in this bytecode.

Specified by:

getOperands in interface SyntacticItem

Returns:

getIndex

public int getIndex()

Description copied from interface: SyntacticItem

Get the index of this item in the parent's items table.

Specified by:

getIndex in interface SyntacticItem

Returns:

getData

public Object getData()

Description copied from interface: SyntacticItem

Get any data associated with this item. This will be null if no data is associated.

Specified by:

getData in interface SyntacticItem

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(SyntacticItem other)

Specified by:

compareTo in interface Comparable<SyntacticItem>