Class TreePrinter
- java.lang.Object
-
- javax.annotation.processing.AbstractProcessor
-
- org.checkerframework.javacutil.AbstractTypeProcessor
-
- org.checkerframework.common.util.debug.TreePrinter
-
- All Implemented Interfaces:
javax.annotation.processing.Processor
@SupportedAnnotationTypes("*") @SupportedSourceVersion(RELEASE_8) public class TreePrinter extends AbstractTypeProcessor
A utility class for pretty-printing the AST of a program.The class is actually an annotation processor; in order to use it, invoke the compiler on the source file(s) for which you wish to view the AST of the program. You may also wish to use the
-proc:only
javac option to stop compilation after annotation processing. (But, in general-proc:only
causes type annotation processors not to be run.)A simple main method is also provided. You can invoke this tool as:
java org.checkerframework.common.util.debug.TreePrinter *.java
The visitor simply uses the javac Pretty visitor to output a nicely formatted version of the AST.
TODO: I couldn't find a way to display the result of Pretty, therefore I wrote this simple class. If there already was a way, please let me know.
TODO: what I really want is something like SignaturePrinter, but for the whole source of the program, that is, for each type in the program use the factory to determine the defaulted annotations on the type.
- See Also:
TreeDebug
-
-
Constructor Summary
Constructors Constructor Description TreePrinter()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static void
main(java.lang.String[] args)
void
typeProcess(javax.lang.model.element.TypeElement element, com.sun.source.util.TreePath tree)
Processes a fully-analyzed class that contains a supported annotation (seeAbstractProcessor.getSupportedAnnotationTypes()
).-
Methods inherited from class org.checkerframework.javacutil.AbstractTypeProcessor
getCompilerLog, init, process, typeProcessingOver, typeProcessingStart
-
-
-
-
Method Detail
-
typeProcess
public void typeProcess(javax.lang.model.element.TypeElement element, com.sun.source.util.TreePath tree)
Description copied from class:AbstractTypeProcessor
Processes a fully-analyzed class that contains a supported annotation (seeAbstractProcessor.getSupportedAnnotationTypes()
).The passed class is always valid type-checked Java code.
- Specified by:
typeProcess
in classAbstractTypeProcessor
- Parameters:
element
- element of the analyzed classtree
- the tree path to the element, with the leaf being aClassTree
-
main
public static void main(java.lang.String[] args) throws java.lang.Exception
- Throws:
java.lang.Exception
-
-