org.rigwit.forth.words

Class ToolWords

java.lang.Object

org.rigwit.forth.words.WordSet

org.rigwit.forth.words.ToolWords

public class ToolWords
extends WordSet

Primitives for the Tool and Tool-Ext Wordsets.

Field Summary

Fields inherited from class org.rigwit.forth.words.WordSet

data, mem, vm

Constructor Summary

Constructors

Constructor and Description
ToolWords()

Method Summary

Methods

Modifier and Type	Method and Description
void	bye(XT xt) Return control to the host operating system, if any.
void	displayStack(XT xt) Copy and display the values currently on the data stack.
void	dump(XT xt) Display the contents of top (u) consecutive addresses starting at next (addr).
void	ELSE(XT xt)
void	IF(XT xt)
void	javaComment(XT xt)
void	nextArg(XT xt) Get the next argument from the command line, consuming it; if there is no argument left, return 0 0.
void	THEN(XT xt)

Methods inherited from class org.rigwit.forth.words.WordSet

setVirtualMachine

Methods inherited from class java.lang.Object

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

Constructor Detail

ToolWords

public ToolWords()

Method Detail

displayStack

@Primitive(value=".S")
@Stack(value=" -- ")
public void displayStack(XT xt)
                  throws java.lang.NoSuchMethodException

Copy and display the values currently on the data stack. The format of the display is implementation-dependent.

.S is a debugging convenience found on almost all Forth systems. It is universally mentioned in Forth texts.

Throws:

java.lang.NoSuchMethodException

dump

@Stack(value="addr u -- ")
public void dump(XT xt)

Display the contents of top (u) consecutive addresses starting at next (addr). The format of the display is implementation dependent.

Parameters:

xt -

bye

@Stack(value=" -- ")
public void bye(XT xt)

Return control to the host operating system, if any.

IF

@Primitive(value="[IF]")
@Immediate
public void IF(XT xt)
        throws java.io.IOException

Throws:

java.io.IOException

ELSE

@Primitive(value="[ELSE]")
@Immediate
public void ELSE(XT xt)
          throws java.io.IOException

Throws:

java.io.IOException

THEN

@Primitive(value="[THEN]")
@Immediate
public void THEN(XT xt)

javaComment

@Primitive(value="/**")
@Immediate
public void javaComment(XT xt)
                 throws java.io.IOException

Throws:

java.io.IOException

nextArg

@Primitive(value="next-arg")
@Stack(value=" -- c-addr u")
public void nextArg(XT xt)

Get the next argument from the command line, consuming it; if there is no argument left, return 0 0.