org.jsweet.transpiler.util

Class AbstractTreeScanner

java.lang.Object

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

com.sun.tools.javac.tree.TreeScanner

org.jsweet.transpiler.util.AbstractTreeScanner

Direct Known Subclasses:

AbstractTreePrinter, GlobalBeforeTranslationScanner, OverloadScanner

public abstract class AbstractTreeScanner
extends com.sun.tools.javac.tree.TreeScanner

A Java AST scanner for JSweet.

Author:

Renaud Pawlak

Field Summary

Fields

Modifier and Type	Field and Description
protected com.sun.tools.javac.tree.JCTree.JCCompilationUnit	compilationUnit Holds the compilation being currently scanned.
protected JSweetContext	context The transpiler context.
protected com.sun.tools.javac.util.DiagnosticSource	diagnosticSource The javac diagnostic source object (useful to get line information for instance).
protected Stack<com.sun.tools.javac.tree.JCTree>	stack The scanning stack.
protected Map<String,com.sun.tools.javac.tree.JCTree.JCImport>	staticImports A map holding static import statements.

Constructor Summary

Constructors

Constructor and Description
AbstractTreeScanner(TranspilationHandler logHandler, JSweetContext context, com.sun.tools.javac.tree.JCTree.JCCompilationUnit compilationUnit) Creates a new scanner.

Method Summary

Modifier and Type	Method and Description
protected void	dumpStackTrace() Pretty prints the current scanning trace.
protected void	enter(com.sun.tools.javac.tree.JCTree tree) Enters a tree element (to be scanned for printing).
protected void	exit() Exits a tree element (to be scanned for printing).
com.sun.tools.javac.tree.JCTree.JCCompilationUnit	getCompilationUnit() Gets the currently scanned compilation unit.
JSweetContext	getContext() Gets the transpiler context.
com.sun.tools.javac.tree.JCTree	getCurrent() Returns the currently visited node in the printer's scanning stack.
com.sun.tools.javac.tree.JCTree	getFirstParent(Class<?>... types) Gets the first tree in the scanning stack that matched one of the given tree types.
protected String[]	getGetSource(com.sun.tools.javac.tree.JCTree.JCCompilationUnit compilationUnit) Gets the Java source code for the given compilation unit.
com.sun.tools.javac.tree.JCTree	getParent() Returns the immediate parent in the printer's scanning stack.
<T extends com.sun.tools.javac.tree.JCTree> T	getParent(Class<T> type) Gets the first parent in the scanning stack matching the given type.
<T extends com.sun.tools.javac.tree.JCTree> T	getParent(Class<T> type, com.sun.tools.javac.tree.JCTree from) Gets the first parent matching the given type, looking up from the given tree in the scanning stack.
ExtendedElement	getParentElement() Gets the parent element in the printer's scanning stack.
<T extends Element> T	getParentElement(Class<T> type) Gets the parent element matching the given type within the scanning stack.
com.sun.tools.javac.tree.JCTree	getParentOfParent() Returns the parent of the immediate parent in the printer's scanning stack.
Stack<com.sun.tools.javac.tree.JCTree>	getStack() Returns the printer's scanning stack.
Map<String,com.sun.tools.javac.tree.JCTree.JCImport>	getStaticImports() Gets the map of static imports in the current compilation unit.
protected void	onRollbacked(com.sun.tools.javac.tree.JCTree target) A global handler to be called when a rollback operation terminates.
void	report(com.sun.tools.javac.tree.JCTree tree, JSweetProblem problem, Object... params) Report a JSweet problem on the given program element (tree).
void	report(com.sun.tools.javac.tree.JCTree tree, com.sun.tools.javac.util.Name name, JSweetProblem problem, Object... params) Report a JSweet problem on the given named program element (tree).
protected void	rollback(com.sun.tools.javac.tree.JCTree target, Consumer<com.sun.tools.javac.tree.JCTree> onRollbacked) Rollbacks (undo) the current printing transaction up to the target.
void	scan(ExtendedElement element) Generically scan an extended element.
void	scan(com.sun.tools.javac.tree.JCTree tree) Scans a program tree.
protected void	setCompilationUnit(com.sun.tools.javac.tree.JCTree.JCCompilationUnit compilationUnit) Sets the compilation unit to be scanned.

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

stack

protected Stack<com.sun.tools.javac.tree.JCTree> stack

The scanning stack.

staticImports

protected Map<String,com.sun.tools.javac.tree.JCTree.JCImport> staticImports

A map holding static import statements.

compilationUnit

protected com.sun.tools.javac.tree.JCTree.JCCompilationUnit compilationUnit

Holds the compilation being currently scanned.

context

protected JSweetContext context

The transpiler context.

diagnosticSource

protected com.sun.tools.javac.util.DiagnosticSource diagnosticSource

The javac diagnostic source object (useful to get line information for instance).

Constructor Detail

AbstractTreeScanner

public AbstractTreeScanner(TranspilationHandler logHandler,
                           JSweetContext context,
                           com.sun.tools.javac.tree.JCTree.JCCompilationUnit compilationUnit)

Creates a new scanner.

Parameters:

logHandler - the handler for reporting messages

context - the JSweet transpilation context

compilationUnit - the compilation to be scanned

Method Detail

report

public void report(com.sun.tools.javac.tree.JCTree tree,
                   JSweetProblem problem,
                   Object... params)

Report a JSweet problem on the given program element (tree).

Parameters:

tree - the program element causing the problem

problem - the problem to be reported

params - problem arguments

report

public void report(com.sun.tools.javac.tree.JCTree tree,
                   com.sun.tools.javac.util.Name name,
                   JSweetProblem problem,
                   Object... params)

Report a JSweet problem on the given named program element (tree).

Parameters:

tree - the program element causing the problem

name - the name of that program element

problem - the problem to be reported

params - problem arguments

getStaticImports

public Map<String,com.sun.tools.javac.tree.JCTree.JCImport> getStaticImports()

Gets the map of static imports in the current compilation unit.

See Also:

getCompilationUnit()

getCompilationUnit

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

Gets the currently scanned compilation unit.

getContext

public JSweetContext getContext()

Gets the transpiler context.

getGetSource

protected String[] getGetSource(com.sun.tools.javac.tree.JCTree.JCCompilationUnit compilationUnit)

Gets the Java source code for the given compilation unit.

setCompilationUnit

protected final void setCompilationUnit(com.sun.tools.javac.tree.JCTree.JCCompilationUnit compilationUnit)

Sets the compilation unit to be scanned.

scan

public void scan(ExtendedElement element)

Generically scan an extended element.

scan

public void scan(com.sun.tools.javac.tree.JCTree tree)

Scans a program tree.

Overrides:

scan in class com.sun.tools.javac.tree.TreeScanner

dumpStackTrace

protected void dumpStackTrace()

Pretty prints the current scanning trace.

This is useful for reporting internal errors and give information about what happened to the user.

onRollbacked

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

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

Parameters:

target - the rollback's target

See Also:

rollback(JCTree, Consumer)

rollback

protected void rollback(com.sun.tools.javac.tree.JCTree target,
                        Consumer<com.sun.tools.javac.tree.JCTree> onRollbacked)

Rollbacks (undo) the current printing transaction up to the target.

Parameters:

target - the element up to which the printing should be undone

onRollbacked - the callback to be invoked once the rollback is finished (see also onRollbacked(JCTree)

enter

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

Enters a tree element (to be scanned for printing).

See Also:

exit()

exit

protected void exit()

Exits a tree element (to be scanned for printing).

See Also:

enter(JCTree)

getStack

public Stack<com.sun.tools.javac.tree.JCTree> getStack()

Returns the printer's scanning stack.

getCurrent

public com.sun.tools.javac.tree.JCTree getCurrent()

Returns the currently visited node in the printer's scanning stack.

getParent

public com.sun.tools.javac.tree.JCTree getParent()

Returns the immediate parent in the printer's scanning stack.

getParentOfParent

public com.sun.tools.javac.tree.JCTree getParentOfParent()

Returns the parent of the immediate parent in the printer's scanning stack.

See Also:

getStack()

getParentElement

public ExtendedElement getParentElement()

Gets the parent element in the printer's scanning stack.

See Also:

getStack()

getParent

public <T extends com.sun.tools.javac.tree.JCTree> T getParent(Class<T> type)

Gets the first parent in the scanning stack matching the given type.

Parameters:

type - the type to search for

Returns:

the first matching tree

See Also:

getStack()

getParentElement

public <T extends Element> T getParentElement(Class<T> type)

Gets the parent element matching the given type within the scanning stack.

Parameters:

type - the element type being search for

Returns:

the first matching element

See Also:

getStack()

getFirstParent

public com.sun.tools.javac.tree.JCTree getFirstParent(Class<?>... types)

Gets the first tree in the scanning stack that matched one of the given tree types.

Parameters:

types - the tree types to be checked

Returns:

the first matching tree

See Also:

getStack()

getParent

public <T extends com.sun.tools.javac.tree.JCTree> T getParent(Class<T> type,
                                                               com.sun.tools.javac.tree.JCTree from)

Gets the first parent matching the given type, looking up from the given tree in the scanning stack.

Parameters:

type - the type to search for

from - the tree to start the search from

Returns:

the first matching parent in the scanning stack

See Also:

getStack()