org.rigwit.forth

Class TypedStack

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.Vector<E>

java.util.Stack<E>

org.rigwit.stack.Stack

org.rigwit.forth.TypedStack

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable, java.util.Collection, java.util.List, java.util.RandomAccess

public class TypedStack
extends org.rigwit.stack.Stack

A Typed Stack.

This handles the Java typing rules for access to the enhanced stack, converting between the Java and Forth representation of values.

This provides the ability to replace the stack with a more strict stack where type is enforced more than it currently is. It also allows the collection of Java to Forth data conversion methods.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.Vector

capacityIncrement, elementCount, elementData

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
TypedStack(int size)

Method Summary

Methods

Modifier and Type	Method and Description
int	popAddr() Pop an Address from the stack, returning an Integer.
boolean	popBool() Pop a value from the stack and return its boolean value.
int	popChar() Pop a Character from the stack, returning an Integer.
long	popDouble() Pop a Forth double (two Integers) off of the stack, returning a Java long.
int	popInt() Pop an integer off the stack returning it as an Integer.
java.lang.Object	popObj() Pop a value from the stack returning it as a generic Object.
long	popUInt() Pop an unsigned integer from the stack returning it as a positive Java long.
XT	popXT() Pop an eXecution Token from the stack, returning it as an XT object.
void	pushAddr(int item) Push an integer onto the data stack as an Address.
void	pushBool(boolean bool) Push a java boolean value onto the stack as a Forth boolean value.
void	pushChar(int ch) Push an integer onto the stack as a Character.
void	pushDouble(java.lang.Long item) Push a Java long into the stack as a Forth double, splitting the value into the upper and lower cells.
void	pushInt(int item) Push an Integer onto the stack.
void	pushObj(java.lang.Object item) Push a generic Object onto the stack, irrespective of type.
void	pushUInt(long uint) Push a Java long onto the stack as an unsigned integer.
void	pushXT(XT xt) Push an eXecution Token onto the stack.

Methods inherited from class org.rigwit.stack.Stack

add, add, drop, duplicate, get, getMaxSize, peek, pop, push, remove, set, setMaxSize, swap, toString

Methods inherited from class java.util.Stack

empty, search

Methods inherited from class java.util.Vector

addAll, addAll, addElement, capacity, clear, clone, contains, containsAll, copyInto, elementAt, elements, ensureCapacity, equals, firstElement, hashCode, indexOf, indexOf, insertElementAt, isEmpty, iterator, lastElement, lastIndexOf, lastIndexOf, listIterator, listIterator, remove, removeAll, removeAllElements, removeElement, removeElementAt, removeRange, retainAll, setElementAt, setSize, size, subList, toArray, toArray, trimToSize

Methods inherited from class java.lang.Object

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

Constructor Detail

TypedStack

public TypedStack(int size)

Method Detail

pushInt

public void pushInt(int item)

Push an Integer onto the stack.

Parameters:

item - Integer to be placed on the stack.

popInt

public int popInt()

Pop an integer off the stack returning it as an Integer.

Returns:

the top of the stack as an integer value.

pushAddr

public void pushAddr(int item)

Push an integer onto the data stack as an Address.

Parameters:

item - Address (integer) to be placed on the stack.

popAddr

public int popAddr()

Pop an Address from the stack, returning an Integer.

Returns:

the top of the stack as an address (integer) value.

pushChar

public void pushChar(int ch)

Push an integer onto the stack as a Character.

Parameters:

ch - Character (integer) to be placed on the stack.

popChar

public int popChar()

Pop a Character from the stack, returning an Integer.

Returns:

the top of the stack as a character (integer) value.

pushObj

public void pushObj(java.lang.Object item)

Push a generic Object onto the stack, irrespective of type.

Parameters:

item - the Java object to be placed on the stack.

popObj

public java.lang.Object popObj()

Pop a value from the stack returning it as a generic Object.

Returns:

the top of the stack as a Java Object.

pushBool

public void pushBool(boolean bool)

Push a java boolean value onto the stack as a Forth boolean value.

Parameters:

bool - the Java boolean value to be placed on the stack.

popBool

public boolean popBool()

Pop a value from the stack and return its boolean value. Uses the Forth rules to convert the value found on the top of the stack into a java boolean flag. I.e., any non-zero value is considered to be true. If the value is an object reference it is false by definition.

Returns:

true if the top of the stack is considered to be true in Forth and false otherwise.

pushUInt

public void pushUInt(long uint)

Push a Java long onto the stack as an unsigned integer.

Parameters:

uint - the unsigned integer (long) to be placed on the stack.

popUInt

public long popUInt()

Pop an unsigned integer from the stack returning it as a positive Java long.

Returns:

a positive long value representing the unsigned integer on the top of the stack.

pushDouble

public void pushDouble(java.lang.Long item)

Push a Java long into the stack as a Forth double, splitting the value into the upper and lower cells.

Parameters:

item - the Java Long value to be placed onto the stack.

popDouble

public long popDouble()

Pop a Forth double (two Integers) off of the stack, returning a Java long. The two integer values that form a Forth double value on the top of the stack are reconstructed into a Java long.

Returns:

a long value representing the double value on the top of the stack.

pushXT

public void pushXT(XT xt)

Push an eXecution Token onto the stack.

Parameters:

xt - the eXecution Token to be placed on the stack.

popXT

public XT popXT()

Pop an eXecution Token from the stack, returning it as an XT object.

Returns:

the top of the stack as an eXecution Token.