wyal.lang

Interface SyntacticItem

All Superinterfaces:

Comparable<SyntacticItem>, wybs.lang.SyntacticElement

All Known Subinterfaces:

Formula, Formula.ArithmeticEquation, Formula.Equation, WyalFile.Declaration, WyalFile.Declaration.Named, WyalFile.Expr, WyalFile.Stmt, WyalFile.Type, WyalFile.Type.Primitive

All Known Implementing Classes:

AbstractSyntacticItem, Formula.ArithmeticEquality, Formula.Conjunct, Formula.Disjunct, Formula.Equality, Formula.Inequality, Formula.Invoke, Formula.Is, Formula.Quantifier, Formula.Truth, WyalFile.Declaration.Assert, WyalFile.Declaration.Import, WyalFile.Declaration.Named.Function, WyalFile.Declaration.Named.FunctionOrMacro, WyalFile.Declaration.Named.Macro, WyalFile.Declaration.Named.Type, WyalFile.Expr.Addition, WyalFile.Expr.ArrayAccess, WyalFile.Expr.ArrayGenerator, WyalFile.Expr.ArrayInitialiser, WyalFile.Expr.ArrayLength, WyalFile.Expr.ArrayUpdate, WyalFile.Expr.Cast, WyalFile.Expr.Constant, WyalFile.Expr.Dereference, WyalFile.Expr.Division, WyalFile.Expr.Equal, WyalFile.Expr.ExistentialQuantifier, WyalFile.Expr.GreaterThan, WyalFile.Expr.GreaterThanOrEqual, WyalFile.Expr.InfixOperator, WyalFile.Expr.Invoke, WyalFile.Expr.Is, WyalFile.Expr.LessThan, WyalFile.Expr.LessThanOrEqual, WyalFile.Expr.LogicalAnd, WyalFile.Expr.LogicalIff, WyalFile.Expr.LogicalImplication, WyalFile.Expr.LogicalNot, WyalFile.Expr.LogicalOr, WyalFile.Expr.Multiplication, WyalFile.Expr.Negation, WyalFile.Expr.NotEqual, WyalFile.Expr.Operator, WyalFile.Expr.Quantifier, WyalFile.Expr.RecordAccess, WyalFile.Expr.RecordInitialiser, WyalFile.Expr.RecordUpdate, WyalFile.Expr.Remainder, WyalFile.Expr.Subtraction, WyalFile.Expr.UniversalQuantifier, WyalFile.Expr.VariableAccess, WyalFile.FieldDeclaration, WyalFile.Identifier, WyalFile.Name, WyalFile.Pair, WyalFile.Stmt.Block, WyalFile.Stmt.CaseOf, WyalFile.Stmt.ExistentialQuantifier, WyalFile.Stmt.IfThen, WyalFile.Stmt.Quantifier, WyalFile.Stmt.UniversalQuantifier, WyalFile.Tuple, WyalFile.Type.Any, WyalFile.Type.Array, WyalFile.Type.Atom, WyalFile.Type.Bool, WyalFile.Type.Byte, WyalFile.Type.Function, WyalFile.Type.FunctionOrMacroOrInvariant, WyalFile.Type.FunctionOrMethodOrProperty, WyalFile.Type.Int, WyalFile.Type.Intersection, WyalFile.Type.Invariant, WyalFile.Type.Method, WyalFile.Type.Negation, WyalFile.Type.Nominal, WyalFile.Type.Null, WyalFile.Type.Property, WyalFile.Type.Record, WyalFile.Type.Reference, WyalFile.Type.Union, WyalFile.Type.UnionOrIntersection, WyalFile.Type.Void, WyalFile.Value, WyalFile.Value.Bool, WyalFile.Value.Int, WyalFile.Value.Null, WyalFile.Value.UTF8, WyalFile.VariableDeclaration, WyalFile.VerificationError

public interface SyntacticItem
extends wybs.lang.SyntacticElement, Comparable<SyntacticItem>

Nested Class Summary

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

wybs.lang.SyntacticElement.Impl

Method Summary

Modifier and Type	Method and Description
void	allocate(SyntacticHeap heap, int index) Allocated the given item to a syntactic heap.
SyntacticItem	clone(SyntacticItem[] operands) Create a new copy of the given syntactic item with the given operands.
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.
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

Methods inherited from interface wybs.lang.SyntacticElement

attribute, attributes

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getParent

SyntacticHeap getParent()

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.

Returns:

allocate

void allocate(SyntacticHeap heap,
              int index)

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.

Parameters:

heap - The heap into which this item is being allocated

index - The index at which this item is being allocated

getOpcode

WyalFile.Opcode getOpcode()

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.

setOpcode

void setOpcode(WyalFile.Opcode opcode)

Mutate the opcode of this item

Parameters:

opcode -

size

int size()

Get the number of operands in this bytecode

Returns:

getOperand

SyntacticItem getOperand(int i)

Return the ith top-level operand in this bytecode.

Parameters:

i -

Returns:

getOperands

SyntacticItem[] getOperands()

Return the top-level operands in this bytecode.

Returns:

setOperand

void setOperand(int ith,
                SyntacticItem child)

Mutate the ith child of this item

Parameters:

ith -

child -

getIndex

int getIndex()

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

Returns:

getData

Object getData()

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

Returns:

clone

SyntacticItem clone(SyntacticItem[] operands)

Create a new copy of the given syntactic item with the given operands. The number of operands must match size() for this item, and be of appropriate type.

Parameters:

operands -

Returns: