org.rvpf.processor.engine.rpn

Class Compiler

Object

Compiler

public final class Compiler
extends Object

Compiles RPN programs for an RPN engine.

EBNF

• words = word, {spaces, word};
• word = visible-ascii, {visible-ascii};
• spaces = space, {[forth-comment | c-comment], space};
• c-comment = '/', '*', {any - ('*', '/')}, '*', '/';
• forth-comment = '(', space, {any - ')' }, ')';
• word-def= word-name, spaces, program;
• inline-word-def= ':', spaces, word-def, spaces, ';';
• program = {inline-word-def, spaces}, [';', spaces], words;

See Also:

RPNEngine, MacroDef

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Compiler.CompileException Compile Exception.

Method Summary

Modifier and Type	Method and Description
Serializable	getOperand() Gets the operand.
Optional<OperationReference>	nextReference() Returns the next operation reference.
Optional<OperationReference>	peekReference() Peeks at the next operation reference.

Methods inherited from class Object

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

Method Detail

getOperand

@CheckReturnValue
public Serializable getOperand()

Gets the operand.

Returns:

The operand.

nextReference

@Nonnull
public Optional<OperationReference> nextReference()
                                                     throws Compiler.CompileException

Returns the next operation reference.

Returns:

The next operation reference (may be empty).

Throws:

Compiler.CompileException - On compilation problem.

See Also:

peekReference()

peekReference

@Nonnull
 @CheckReturnValue
public Optional<OperationReference> peekReference()
                                                                         throws Compiler.CompileException

Peeks at the next operation reference.

The returned reference has not been set up yet. It can be queried for its position in the source and its operation. All calls to nextReference() or peekReference() must be made during the reference set up.

Returns:

The next operation reference (may be empty).

Throws:

Compiler.CompileException - On compilation problem.