org.jsweet.transpiler.util

Class AbstractTreePrinter

java.lang.Object

com.sun.tools.javac.tree.JCTree.Visitor

com.sun.tools.javac.tree.TreeScanner

org.jsweet.transpiler.util.AbstractTreeScanner

org.jsweet.transpiler.util.AbstractTreePrinter

Direct Known Subclasses:

Java2TypeScriptTranslator

public abstract class AbstractTreePrinter
extends AbstractTreeScanner

A tree printer is a kind of tree scanner specialized in pretty printing the scanned AST of a compilation unit (source file).

Author:

Renaud Pawlak

Field Summary

Fields

Modifier and Type	Field and Description
StringBuilder	footer A footer to be printed at the end of the output.
protected boolean	inArgListTail
protected static String	INDENT The constant string for indentation.
SourceMap	sourceMap The object storing source map information while printing.
TypeChecker	typeChecker A type checker instance.

Fields inherited from class org.jsweet.transpiler.util.AbstractTreeScanner

compilationUnit, context, diagnosticSource, stack, staticImports

Constructor Summary

Constructors

Constructor and Description
AbstractTreePrinter(TranspilationHandler logHandler, JSweetContext context, com.sun.tools.javac.tree.JCTree.JCCompilationUnit compilationUnit, PrinterAdapter adapter, boolean fillSourceMap) Creates a new printer.

Method Summary

Modifier and Type	Method and Description
AbstractTreePrinter	endIndent() Decrements the current indentation value.
protected void	enter(com.sun.tools.javac.tree.JCTree tree) Enters the given tree (se AbstractTreeScanner.scan(JCTree).
protected void	exit() Exits the currently scanned tree.
PrinterAdapter	getAdapter() Gets the adapter attached to this printer.
com.sun.tools.javac.tree.JCTree.JCCompilationUnit	getCompilationUnit() Gets the current compilation unit.
int	getCurrentColumn() Gets the current column of the printed output.
int	getCurrentLine() Gets the current line of the printed output.
int	getCurrentPosition() Gets the current character count of the output.
String	getIdentifier(com.sun.tools.javac.code.Symbol symbol)
int	getIndent()
String	getIndentString() Returns the current indentation as a string.
char	getLastPrintedChar() Gets the lastly printed character.
String	getLastPrintedString(int length) Gets the last printed string for the given length.
String	getOutput() Gets this output of this printer.
Stack<Position>	getPositionStack() The position stack of the scanner.
String	getQualifiedTypeName(com.sun.tools.javac.code.Symbol.TypeSymbol type, boolean globals, boolean ignoreLangTypes)
String	getResult() Gets the printed result as a string.
String	getRootRelativeName(com.sun.tools.javac.code.Symbol symbol)
String	getRootRelativeName(com.sun.tools.javac.code.Symbol symbol, boolean useJavaNames)
boolean	isFillSourceMap() Tells if this printer tries to preserve the original line numbers of the Java input.
protected void	onRollbacked(com.sun.tools.javac.tree.JCTree target) A global handler to be called when a rollback operation terminates.
AbstractTreePrinter	print(com.sun.tools.javac.tree.JCTree tree) Print a given AST.
AbstractTreePrinter	print(String string) Outputs a string (new lines are not allowed).
AbstractTreePrinter	printArgList(com.sun.tools.javac.tree.JCTree.JCMethodInvocation inv) Prints an invocation argument list, with type assignment.
AbstractTreePrinter	printArgList(List<com.sun.tools.javac.code.Type> assignedTypes, List<? extends com.sun.tools.javac.tree.JCTree> args)
AbstractTreePrinter	printArgList(List<com.sun.tools.javac.code.Type> assignedTypes, List<? extends com.sun.tools.javac.tree.JCTree> args, Consumer<com.sun.tools.javac.tree.JCTree> printer) Prints a comma-separated list of subtrees.
abstract AbstractTreePrinter	printConstructorArgList(com.sun.tools.javac.tree.JCTree.JCNewClass newClass, boolean localClass)
AbstractTreePrinter	printIdentifier(com.sun.tools.javac.code.Symbol symbol) Outputs an identifier.
AbstractTreePrinter	printIndent() Prints an indentation for the current indentation value.
AbstractTreePrinter	println() Outputs a new line.
AbstractTreePrinter	println(String string) Outputs a string and new line
AbstractTreePrinter	printTypeArgList(List<? extends com.sun.tools.javac.tree.JCTree> args) Prints a comma-separated list of type subtrees.
AbstractTreePrinter	printVarNameList(List<com.sun.tools.javac.tree.JCTree.JCVariableDecl> args) Prints a comma-separated list of variable names (no types).
AbstractTreePrinter	removeLastChar() Removes the last output character.
boolean	removeLastChar(char expectedChar) removes last character if expectedChar
AbstractTreePrinter	removeLastChars(int count) Removes the last output characters.
AbstractTreePrinter	removeLastIndent() Removes the last printed indentation.
void	setAdapter(PrinterAdapter adapter) Sets the adapter attached to this printer.
AbstractTreePrinter	space() Adds a space to the output.
AbstractTreePrinter	startIndent() Increments the current indentation value.
AbstractTreePrinter	substituteAndPrintAssignedExpression(com.sun.tools.javac.code.Type assignedType, com.sun.tools.javac.tree.JCTree.JCExpression expression) Print an expression being assigned to a type (should handled necessary wraping/unwraping).
abstract AbstractTreePrinter	substituteAndPrintType(com.sun.tools.javac.tree.JCTree typeTree)
protected abstract boolean	substituteAssignedExpression(com.sun.tools.javac.code.Type assignedType, com.sun.tools.javac.tree.JCTree.JCExpression expression) Conditionally substitutes an expression when it is assigned to a given type.

Methods inherited from class org.jsweet.transpiler.util.AbstractTreeScanner

dumpStackTrace, getContext, getCurrent, getFirstParent, getGetSource, getParent, getParent, getParent, getParentElement, getParentElement, getParentOfParent, getStack, getStaticImports, report, report, rollback, scan, scan, setCompilationUnit

Methods inherited from class com.sun.tools.javac.tree.TreeScanner

scan, visitAnnotatedType, visitAnnotation, visitApply, visitAssert, visitAssign, visitAssignop, visitBinary, visitBlock, visitBreak, visitCase, visitCatch, visitClassDef, visitConditional, visitContinue, visitDoLoop, visitErroneous, visitExec, visitForeachLoop, visitForLoop, visitIdent, visitIf, visitImport, visitIndexed, visitLabelled, visitLambda, visitLetExpr, visitLiteral, visitMethodDef, visitModifiers, visitNewArray, visitNewClass, visitParens, visitReference, visitReturn, visitSelect, visitSkip, visitSwitch, visitSynchronized, visitThrow, visitTopLevel, visitTree, visitTry, visitTypeApply, visitTypeArray, visitTypeBoundKind, visitTypeCast, visitTypeIdent, visitTypeIntersection, visitTypeParameter, visitTypeTest, visitTypeUnion, visitUnary, visitVarDef, visitWhileLoop, visitWildcard

Methods inherited from class java.lang.Object

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

Field Detail

footer

public StringBuilder footer

A footer to be printed at the end of the output.

INDENT

protected static final String INDENT

The constant string for indentation.

See Also:

Constant Field Values

typeChecker

public TypeChecker typeChecker

A type checker instance.

sourceMap

public SourceMap sourceMap

The object storing source map information while printing.

inArgListTail

protected boolean inArgListTail

Constructor Detail

AbstractTreePrinter

public AbstractTreePrinter(TranspilationHandler logHandler,
                           JSweetContext context,
                           com.sun.tools.javac.tree.JCTree.JCCompilationUnit compilationUnit,
                           PrinterAdapter adapter,
                           boolean fillSourceMap)

Creates a new printer.

Parameters:

logHandler - the handler that reports logs and problems

context - the scanning context

compilationUnit - the source file to be printed

adapter - the printer adapter

fillSourceMap - tells if printer fills the source map

Method Detail

getPositionStack

public Stack<Position> getPositionStack()

The position stack of the scanner.

getOutput

public String getOutput()

Gets this output of this printer.

print

public AbstractTreePrinter print(com.sun.tools.javac.tree.JCTree tree)

Print a given AST.

enter

protected void enter(com.sun.tools.javac.tree.JCTree tree)

Enters the given tree (se AbstractTreeScanner.scan(JCTree).

Overrides:

enter in class AbstractTreeScanner

See Also:

AbstractTreeScanner.exit()

onRollbacked

protected void onRollbacked(com.sun.tools.javac.tree.JCTree target)

Description copied from class: AbstractTreeScanner

A global handler to be called when a rollback operation terminates.

Overrides:

onRollbacked in class AbstractTreeScanner

Parameters:

target - the rollback's target

See Also:

AbstractTreeScanner.rollback(JCTree, Consumer)

exit

protected void exit()

Exits the currently scanned tree.

Overrides:

exit in class AbstractTreeScanner

See Also:

AbstractTreeScanner.enter(JCTree)

getCurrentPosition

public int getCurrentPosition()

Gets the current character count of the output.

getLastPrintedChar

public char getLastPrintedChar()

Gets the lastly printed character.

getLastPrintedString

public String getLastPrintedString(int length)

Gets the last printed string for the given length.

printIndent

public AbstractTreePrinter printIndent()

Prints an indentation for the current indentation value.

getIndentString

public String getIndentString()

Returns the current indentation as a string.

startIndent

public AbstractTreePrinter startIndent()

Increments the current indentation value.

endIndent

public AbstractTreePrinter endIndent()

Decrements the current indentation value.

print

public AbstractTreePrinter print(String string)

Outputs a string (new lines are not allowed).

println

public AbstractTreePrinter println(String string)

Outputs a string and new line

printIdentifier

public AbstractTreePrinter printIdentifier(com.sun.tools.javac.code.Symbol symbol)

Outputs an identifier.

getQualifiedTypeName

public String getQualifiedTypeName(com.sun.tools.javac.code.Symbol.TypeSymbol type,
                                   boolean globals,
                                   boolean ignoreLangTypes)

getIdentifier

public String getIdentifier(com.sun.tools.javac.code.Symbol symbol)

space

public AbstractTreePrinter space()

Adds a space to the output.

removeLastChar

public boolean removeLastChar(char expectedChar)

removes last character if expectedChar

removeLastChar

public AbstractTreePrinter removeLastChar()

Removes the last output character.

removeLastChars

public AbstractTreePrinter removeLastChars(int count)

Removes the last output characters.

removeLastIndent

public AbstractTreePrinter removeLastIndent()

Removes the last printed indentation.

println

public AbstractTreePrinter println()

Outputs a new line.

getResult

public String getResult()

Gets the printed result as a string.

getAdapter

public PrinterAdapter getAdapter()

Gets the adapter attached to this printer.

setAdapter

public void setAdapter(PrinterAdapter adapter)

Sets the adapter attached to this printer.

printArgList

public AbstractTreePrinter printArgList(List<com.sun.tools.javac.code.Type> assignedTypes,
                                        List<? extends com.sun.tools.javac.tree.JCTree> args,
                                        Consumer<com.sun.tools.javac.tree.JCTree> printer)

Prints a comma-separated list of subtrees.

substituteAndPrintAssignedExpression

public AbstractTreePrinter substituteAndPrintAssignedExpression(com.sun.tools.javac.code.Type assignedType,
                                                                com.sun.tools.javac.tree.JCTree.JCExpression expression)

Print an expression being assigned to a type (should handled necessary wraping/unwraping).

Parameters:

assignedType - the type the expression is being assigned to

expression - the assigned expression

substituteAssignedExpression

protected abstract boolean substituteAssignedExpression(com.sun.tools.javac.code.Type assignedType,
                                                        com.sun.tools.javac.tree.JCTree.JCExpression expression)

Conditionally substitutes an expression when it is assigned to a given type.

Parameters:

assignedType - the type the expression is being assigned to

expression - the assigned expression

Returns:

true if the expression what subtituted

printArgList

public AbstractTreePrinter printArgList(com.sun.tools.javac.tree.JCTree.JCMethodInvocation inv)

Prints an invocation argument list, with type assignment.

printArgList

public AbstractTreePrinter printArgList(List<com.sun.tools.javac.code.Type> assignedTypes,
                                        List<? extends com.sun.tools.javac.tree.JCTree> args)

printConstructorArgList

public abstract AbstractTreePrinter printConstructorArgList(com.sun.tools.javac.tree.JCTree.JCNewClass newClass,
                                                            boolean localClass)

substituteAndPrintType

public abstract AbstractTreePrinter substituteAndPrintType(com.sun.tools.javac.tree.JCTree typeTree)

printVarNameList

public AbstractTreePrinter printVarNameList(List<com.sun.tools.javac.tree.JCTree.JCVariableDecl> args)

Prints a comma-separated list of variable names (no types).

printTypeArgList

public AbstractTreePrinter printTypeArgList(List<? extends com.sun.tools.javac.tree.JCTree> args)

Prints a comma-separated list of type subtrees.

getCurrentLine

public int getCurrentLine()

Gets the current line of the printed output.

getCurrentColumn

public int getCurrentColumn()

Gets the current column of the printed output.

getCompilationUnit

public com.sun.tools.javac.tree.JCTree.JCCompilationUnit getCompilationUnit()

Gets the current compilation unit.

Overrides:

getCompilationUnit in class AbstractTreeScanner

isFillSourceMap

public boolean isFillSourceMap()

Tells if this printer tries to preserve the original line numbers of the Java input.

getRootRelativeName

public String getRootRelativeName(com.sun.tools.javac.code.Symbol symbol)

getRootRelativeName

public String getRootRelativeName(com.sun.tools.javac.code.Symbol symbol,
                                  boolean useJavaNames)

getIndent

public int getIndent()