autumn.lang.compiler

Class AutumnPrettyPrinter

java.lang.Object

autumn.lang.compiler.AutumnPrettyPrinter

public final class AutumnPrettyPrinter
extends java.lang.Object

An instance of this class can pretty-print an abstract-syntax-tree.

Note: The output of this pretty-printer is version-specific.

Constructor Summary

Constructors

Constructor and Description
AutumnPrettyPrinter() Constructor.
AutumnPrettyPrinter(java.io.PrintStream out) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static java.io.PrintStream	createStreamASCII(java.lang.StringBuilder builder) This method creates a PrintStream that prints to a StringBuilder using ASCII.
static java.util.List<IConstruct>	nodesOf(IConstruct node) This method linearizes the nodes in a given abstract-syntax-tree.
void	print(IConstruct node) This method prints an abstract-syntax-tree node to the underlying stream.
java.io.PrintStream	stream() This method retrieves the stream that is being printed to.

Methods inherited from class java.lang.Object

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

Constructor Detail

AutumnPrettyPrinter

public AutumnPrettyPrinter()

Constructor.

Equivalent: AutumnPrettyPrinter(System.out)

AutumnPrettyPrinter

public AutumnPrettyPrinter(java.io.PrintStream out)

Constructor.

Parameters:

out - is the stream to print to.

Method Detail

stream

public java.io.PrintStream stream()

This method retrieves the stream that is being printed to.

Returns:

the aforedescribed stream.

print

public void print(IConstruct node)
           throws UnprintableNodeException,
                  IncompleteNodeException,
                  RepeatedNodeException

This method prints an abstract-syntax-tree node to the underlying stream.

Parameters:

node - is the AST node to print, which may be the root of an entire tree.

Throws:

UnprintableNodeException - if the AST contains a node that is unprintable.

IncompleteNodeException - if the AST is incomplete.

RepeatedNodeException - if the AST contains the same node more than once.

createStreamASCII

public static java.io.PrintStream createStreamASCII(java.lang.StringBuilder builder)

This method creates a PrintStream that prints to a StringBuilder using ASCII.

Note: The returned stream throws an IOException, when non-ASCII encoded text is encountered.

Note: The returned stream cannot be used to print null characters (i.e. ASCII(0)).

Parameters:

builder - is the builder to print ASCII encoded characters to.

Returns:

the aforedescribed stream.

nodesOf

public static java.util.List<IConstruct> nodesOf(IConstruct node)

This method linearizes the nodes in a given abstract-syntax-tree.

Parameters:

node - is the root of the AST.

Returns:

the aforedescribed immutable list.