PrettyPrinter (KeY API Documentation)

java.lang.Object
- de.uka.ilkd.key.java.PrettyPrinter

Direct Known Subclasses:

CustomPrettyPrinter, ProgramPrinter
```
public class PrettyPrinter
extends Object
```
A configurable pretty printer for Java source elements originally from COMPOST.

Author:

AL CHANGED FOR KeY. Comments are not printed!

Field Summary

Fields
Modifier and Type	Field and Description
`private static char[]`	`BLANKS`
`protected Type`	`classToPrint` Enforces the output of real Java syntax that can be compiled.
`private int`	`column` Column number.
`protected boolean`	`endAlreadyMarked`
`private static char[]`	`FEEDS`
`protected Object`	`firstStatement`
`protected int`	`firstStatementEnd`
`protected int`	`firstStatementStart`
`private int`	`indentation` Indentation (cached).
`protected HashMap<SourceElement,Position>`	`indentMap`
`protected SVInstantiations`	`instantiations`
`private boolean`	`isPrintingSingleLineComments` Flag to indicate if a single line comment is being put out.
`private ArrayList<Range>`	`keywordRanges` Contains the java keyword ranges.
`private Stack<Integer>`	`keywordStarts` Remembers the start of a keyword to create a range.
`protected int`	`level` Level.
`private int`	`line` Line number, not directly used.
`protected boolean`	`noLinefeed`
`protected boolean`	`noSemicolons`
`protected Writer`	`out`
`protected StringBuffer`	`outBuf`
`private boolean`	`overwriteIndentation` Overwrite indentation flag (cached).
`private boolean`	`overwriteParsePositions` Overwrite parse positions flag (cached).
`protected boolean`	`startAlreadyMarked`
`protected int`	`writtenCharacters` The number of charcters that have been send to the writer

Constructor Summary

Constructors
Constructor and Description
`PrettyPrinter(Writer o)` creates a new PrettyPrinter
`PrettyPrinter(Writer o, boolean noLinefeed)`
`PrettyPrinter(Writer o, boolean noLinefeed, SVInstantiations svi)`
`PrettyPrinter(Writer o, SVInstantiations svi)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`changeLevel(int delta)` Change level.
`protected boolean`	`containsDefaultConstructor(ImmutableArray<MemberDeclaration> members)`
`private void`	`dumpComments()`
`protected static String`	`encodeUnicodeChars(String str)` Replace all unicode characters above ? by their explicit representation.
`int`	`getColumn()` Get current column number.
`protected int`	`getCurrentPos()` Numbers of generated characters
`protected int`	`getIndentation()` Get indentation amount (blanks per level).
`int`	`getIndentationLevel()` Get indentation level.
`Range[]`	`getKeywordRanges()`
`int`	`getLine()` Get current line number.
`Range`	`getRangeOfFirstExecutableStatement()`
`protected Position`	`getRelativePosition(SourceElement first)`
`int`	`getTotalIndentation()` Get total indentation.
`static String`	`getTypeNameForAccessMethods(String typeName)`
`protected boolean`	`isOverwritingIndentation()` Returns true if the pretty printer should also reformat existing code.
`protected boolean`	`isOverwritingParsePositions()` Returns true if the pretty printer should reset the parse positions accordingly.
`protected void`	`markEnd(int n, Object stmt)` Marks the end of the first executable statement ...
`protected void`	`markKeywordEnd()` Marks the end of a java keyword and creates a keyword range.
`protected void`	`markKeywordStart()` Marks the start of a java keyword.
`protected void`	`markStart(int n, Object stmt)` Marks the start of the first executable statement ...
`protected void`	`output()`
`void`	`printAllFields(AllFields x)`
`void`	`printAllObjects(AllObjects x)`
`void`	`printArrayDeclaration(ArrayDeclaration type)`
`void`	`printArrayInitializer(ArrayInitializer x)`
`void`	`printArrayLengthReference(ArrayLengthReference x)`
`void`	`printArrayReference(ArrayReference x)`
`void`	`printAssert(Assert x)`
`void`	`printBigintLiteral(BigintLiteral x)`
`void`	`printBinaryAnd(BinaryAnd x)`
`void`	`printBinaryAndAssignment(BinaryAndAssignment x)`
`void`	`printBinaryNot(BinaryNot x)`
`void`	`printBinaryOr(BinaryOr x)`
`void`	`printBinaryOrAssignment(BinaryOrAssignment x)`
`void`	`printBinaryXOr(BinaryXOr x)`
`void`	`printBinaryXOrAssignment(BinaryXOrAssignment x)`
`void`	`printBooleanLiteral(BooleanLiteral x)`
`void`	`printBreak(Break x)`
`void`	`printCase(Case x)`
`void`	`printCatch(Catch x)`
`void`	`printCatchAllStatement(CatchAllStatement x)`
`void`	`printCharLiteral(CharLiteral x)`
`void`	`printClassDeclaration(ClassDeclaration x)`
`void`	`printClassInitializer(ClassInitializer x)`
`void`	`printComment(Comment x)`
`void`	`printCompilationUnit(CompilationUnit x)`
`void`	`printConditional(Conditional x)`
`void`	`printContextStatementBlock(ContextStatementBlock x)`
`void`	`printContinue(Continue x)`
`void`	`printCopyAssignment(CopyAssignment x)`
`void`	`printDefault(Default x)`
`void`	`printDivide(Divide x)`
`void`	`printDivideAssignment(DivideAssignment x)`
`void`	`printDLEmbeddedExpression(DLEmbeddedExpression x)`
`void`	`printDo(Do x)`
`void`	`printDo(Do x, boolean includeBody)`
`void`	`printDoubleLiteral(DoubleLiteral x)`
`void`	`printElse(Else x)`
`void`	`printEmptyMapLiteral(EmptyMapLiteral x)`
`void`	`printEmptySeqLiteral(EmptySeqLiteral x)`
`void`	`printEmptySetLiteral(EmptySetLiteral x)`
`void`	`printEmptyStatement(EmptyStatement x)`
`void`	`printEnhancedFor(EnhancedFor x)`
`void`	`printEnhancedFor(EnhancedFor x, boolean includeBody)`
`void`	`printEquals(Equals x)`
`void`	`printExactInstanceof(ExactInstanceof x)`
`void`	`printExecutionContext(ExecutionContext x)`
`void`	`printExtends(Extends x)`
`void`	`printFieldDeclaration(FieldDeclaration x)`
`void`	`printFieldReference(FieldReference x)`
`void`	`printFinally(Finally x)`
`void`	`printFloatLiteral(FloatLiteral x)`
`protected void`	`printFooter(ProgramElement x)` Print program element footer.
`void`	`printFor(For x)`
`void`	`printFor(For x, boolean includeBody)`
`void`	`printFullMethodSignature(IProgramMethod x)`
`void`	`printGreaterOrEquals(GreaterOrEquals x)`
`void`	`printGreaterThan(GreaterThan x)`
`protected void`	`printHeader(int lf, int levelChange, int blanks, ProgramElement x)` Print program element header.
`protected void`	`printHeader(int lf, int blanks, ProgramElement elem)` Print program element header.
`protected void`	`printHeader(int blanks, ProgramElement elem)` Print program element header.
`protected void`	`printHeader(ProgramElement elem)` Print program element header.
`void`	`printIf(If x)`
`void`	`printIf(If x, boolean includeBranches)`
`void`	`printImplements(Implements x)`
`void`	`printImport(Import x)`
`void`	`printIndexOf(SeqIndexOf x)`
`void`	`printInstanceof(Instanceof x)`
`void`	`printInterfaceDeclaration(InterfaceDeclaration x)`
`void`	`printIntersect(Intersect x)`
`void`	`printIntLiteral(IntLiteral x)`
`void`	`printLabeledStatement(LabeledStatement x)`
`void`	`printLessOrEquals(LessOrEquals x)`
`void`	`printLessThan(LessThan x)`
`void`	`printLocalVariableDeclaration(LocalVariableDeclaration x)`
`void`	`printLogicalAnd(LogicalAnd x)`
`void`	`printLogicalNot(LogicalNot x)`
`void`	`printLogicalOr(LogicalOr x)`
`void`	`printLongLiteral(LongLiteral x)`
`void`	`printMetaClassReference(MetaClassReference x)`
`void`	`printMethod(IProgramMethod x)`
`void`	`printMethodBodyStatement(MethodBodyStatement x)`
`void`	`printMethodDeclaration(MethodDeclaration x)`
`void`	`printMethodFrame(MethodFrame x)`
`void`	`printMethodReference(MethodReference x)`
`protected void`	`printMethodReference(MethodReference x, boolean withSemicolon)`
`void`	`printMinus(Minus x)`
`void`	`printMinusAssignment(MinusAssignment x)`
`void`	`printModifier(Modifier x)`
`void`	`printModulo(Modulo x)`
`void`	`printModuloAssignment(ModuloAssignment x)`
`void`	`printNegative(Negative x)`
`void`	`printNew(New x)`
`void`	`printNewArray(NewArray x)`
`void`	`printNotEquals(NotEquals x)`
`void`	`printNullLiteral(NullLiteral x)`
`protected void`	`printOperator(Operator x, String symbol)`
`void`	`printPackageReference(PackageReference x)`
`void`	`printPackageSpecification(PackageSpecification x)`
`void`	`printParenthesizedExpression(ParenthesizedExpression x)`
`void`	`printPassiveExpression(PassiveExpression x)`
`void`	`printPlus(Plus x)`
`void`	`printPlusAssignment(PlusAssignment x)`
`void`	`printPositive(Positive x)`
`void`	`printPostDecrement(PostDecrement x)`
`void`	`printPostIncrement(PostIncrement x)`
`void`	`printPreDecrement(PreDecrement x)`
`void`	`printPreIncrement(PreIncrement x)`
`void`	`printProgramElementName(ProgramElementName x)`
`void`	`printProgramMetaConstruct(ProgramTransformer x)`
`void`	`printProgramMethod(IProgramMethod x)`
`void`	`printProgramVariable(ProgramVariable x)`
`void`	`printReturn(Return x)`
`void`	`printSchemaTypeReference(SchemaTypeReference x)`
`void`	`printSchemaVariable(SchemaVariable x)`
`void`	`printSeqConcat(SeqConcat x)`
`void`	`printSeqGet(SeqGet x)`
`void`	`printSeqLength(SeqLength x)`
`void`	`printSeqReverse(SeqReverse x)`
`void`	`printSeqSingleton(SeqSingleton x)`
`void`	`printSeqSub(SeqSub x)`
`void`	`printSetMinus(SetMinus x)`
`void`	`printSetUnion(SetUnion x)`
`void`	`printShiftLeft(ShiftLeft x)`
`void`	`printShiftLeftAssignment(ShiftLeftAssignment x)`
`void`	`printShiftRight(ShiftRight x)`
`void`	`printShiftRightAssignment(ShiftRightAssignment x)`
`void`	`printSingleton(Singleton x)`
`void`	`printStatementBlock(StatementBlock x)`
`void`	`printStringLiteral(StringLiteral x)`
`void`	`printSuperConstructorReference(SuperConstructorReference x)`
`void`	`printSuperReference(SuperReference x)`
`void`	`printSwitch(Switch x)`
`void`	`printSwitch(Switch x, boolean includeBranches)`
`void`	`printSynchronizedBlock(SynchronizedBlock x)`
`void`	`printThen(Then x)`
`void`	`printThisConstructorReference(ThisConstructorReference x)`
`void`	`printThisReference(ThisReference x)`
`void`	`printThrow(Throw x)`
`void`	`printThrows(Throws x)`
`void`	`printTimes(Times x)`
`void`	`printTimesAssignment(TimesAssignment x)`
`void`	`printTransactionStatement(TransactionStatement x)`
`void`	`printTry(Try x)`
`void`	`printTypeCast(TypeCast x)`
`void`	`printTypeReference(TypeReference x)`
`void`	`printTypeReference(TypeReference x, boolean fullTypeNames)`
`void`	`printUnsignedShiftRight(UnsignedShiftRight x)`
`void`	`printUnsignedShiftRightAssignment(UnsignedShiftRightAssignment x)`
`void`	`printVariableDeclaration(VariableDeclaration x)`
`void`	`printVariableSpecification(VariableSpecification x)`
`void`	`printWhile(While x)`
`void`	`printWhile(While x, boolean includeBody)`
`private static void`	`removeChar(StringBuffer sb, char c)`
`protected ImmutableArray<Modifier>`	`removeFinal(ImmutableArray<Modifier> ma)`
`protected ImmutableArray<Modifier>`	`replacePrivateByPublic(ImmutableArray<Modifier> ma)`
`void`	`reset()` Resets the state of this pretty printer ...
`protected void`	`scheduleComment(SingleLineComment slc)` Store the given comment until the next line feed is written.
`void`	`setIndentationLevel(int level)` Set indentation level.
`void`	`setWriter(Writer out)` Set a new stream to write to.
`void`	`write(char[] cbuf)` Write.
`void`	`write(char[] cbuf, int off, int len)` Write.
`void`	`write(int c)` Write.
`void`	`write(String str)` Write.
`void`	`write(String str, int off, int len)` Write.
`protected void`	`writeBlockList(ImmutableArray<? extends ProgramElement> list)` Write block list.
`protected void`	`writeBlockList(int firstLF, int levelChange, int firstBlanks, ImmutableArray<? extends ProgramElement> list)` Write a complete ArrayOf using "Block" style.
`protected void`	`writeCommaList(ImmutableArray<? extends ProgramElement> list)` Write comma list.
`protected void`	`writeCommaList(int separationBlanks, ImmutableArray<? extends ProgramElement> list)` Write comma list.
`protected void`	`writeCommaList(int firstLF, int levelChange, int firstBlanks, ImmutableArray<? extends ProgramElement> list)` Write a complete ArrayOf using "Comma" style.
`protected void`	`writeElement(int lf, int levelChange, int blanks, SourceElement elem)` Adds indentation for a program element if necessary and if required, but does not print the indentation itself.
`protected void`	`writeElement(int lf, int blanks, SourceElement elem)` Write a source element.
`protected void`	`writeElement(int blanks, SourceElement elem)` Write source element.
`protected void`	`writeElement(SourceElement elem)` Write source element.
`protected void`	`writeFullMethodSignature(IProgramMethod x)`
`protected void`	`writeImmutableArrayOfProgramElement(int firstLF, int levelChange, int firstBlanks, String separationSymbol, int separationLF, int separationBlanks, ImmutableArray<? extends ProgramElement> list)` Write a complete ArrayOf.
`protected void`	`writeIndentation(int lf, int blanks)` Convenience method to write indentation chars.
`protected void`	`writeIndentation(Position relative)` Convenience method to write indentation chars.
`protected void`	`writeIndentation(SourceElement elem)` Write indentation.
`protected void`	`writeInternalIndentation(SourceElement elem)` Write internal indentation.
`protected void`	`writeKeywordList(ImmutableArray<? extends ProgramElement> list)` Write keyword list.
`protected void`	`writeKeywordList(int firstLF, int levelChange, int firstBlanks, ImmutableArray<? extends ProgramElement> list)` Write a complete ArrayOf using "Keyword" style.
`protected void`	`writeLineList(ImmutableArray<? extends ProgramElement> list)` Write line list.
`protected void`	`writeLineList(int firstLF, int levelChange, int firstBlanks, ImmutableArray<? extends ProgramElement> list)` Write a complete ArrayOf using "Line" style.
`protected void`	`writeSymbol(int lf, int levelChange, String symbol)` Write symbol.
`protected void`	`writeToken(int lf, int blanks, String image, NonTerminalProgramElement parent)` Writes an implicit terminal token of a NonTerminal, including its indentation.
`protected void`	`writeToken(int blanks, String image, NonTerminalProgramElement parent)`
`protected void`	`writeToken(String image, NonTerminalProgramElement parent)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- line
```
private int line
```
  Line number, not directly used.
- column
```
private int column
```
  Column number. Used to keep track of indentations.
- level
```
protected int level
```
  Level.
- out
```
protected Writer out
```
- outBuf
```
protected StringBuffer outBuf
```
- noLinefeed
```
protected boolean noLinefeed
```
- noSemicolons
```
protected boolean noSemicolons
```
- classToPrint
```
protected Type classToPrint
```
  Enforces the output of real Java syntax that can be compiled. See also de.uka.ilkd.key.testgen.pp.unittest.ppAndJavaASTExtension.CompilableJavaCardPP
- firstStatementStart
```
protected int firstStatementStart
```
- firstStatementEnd
```
protected int firstStatementEnd
```
- startAlreadyMarked
```
protected boolean startAlreadyMarked
```
- endAlreadyMarked
```
protected boolean endAlreadyMarked
```
- firstStatement
```
protected Object firstStatement
```
- instantiations
```
protected SVInstantiations instantiations
```
- keywordStarts
```
private final Stack<Integer> keywordStarts
```
  Remembers the start of a keyword to create a range.
- keywordRanges
```
private ArrayList<Range> keywordRanges
```
  Contains the java keyword ranges.
- writtenCharacters
```
protected int writtenCharacters
```
  The number of charcters that have been send to the writer
- isPrintingSingleLineComments
```
private boolean isPrintingSingleLineComments
```
  Flag to indicate if a single line comment is being put out. Needed to disable the worklist meanwhile.
- indentMap
```
protected HashMap<SourceElement,Position> indentMap
```
- BLANKS
```
private static final char[] BLANKS
```
- FEEDS
```
private static final char[] FEEDS
```
- indentation
```
private int indentation
```
  Indentation (cached).
- overwriteIndentation
```
private boolean overwriteIndentation
```
  Overwrite indentation flag (cached).
- overwriteParsePositions
```
private boolean overwriteParsePositions
```
  Overwrite parse positions flag (cached).

Constructor Detail

PrettyPrinter
```
public PrettyPrinter(Writer o)
```
creates a new PrettyPrinter

PrettyPrinter

public PrettyPrinter(Writer o,
                     SVInstantiations svi)

PrettyPrinter

public PrettyPrinter(Writer o,
                     boolean noLinefeed)

PrettyPrinter

public PrettyPrinter(Writer o,
                     boolean noLinefeed,
                     SVInstantiations svi)

Method Detail

output

protected void output()
               throws IOException

Throws:: IOException

getCurrentPos
```
protected int getCurrentPos()
```
Numbers of generated characters

markStart
```
protected void markStart(int n,
                         Object stmt)
```
Marks the start of the first executable statement ...

Parameters:

n - offset from the current position

stmt - current statement;

markEnd
```
protected void markEnd(int n,
                       Object stmt)
```
Marks the end of the first executable statement ...

Parameters:

n - offset from the current position

getRangeOfFirstExecutableStatement
```
public Range getRangeOfFirstExecutableStatement()
```
Returns:

the range of the first executable statement that means the corresponding start and end position in the string representation

markKeywordStart
```
protected final void markKeywordStart()
```
Marks the start of a java keyword.

markKeywordEnd
```
protected final void markKeywordEnd()
```
Marks the end of a java keyword and creates a keyword range.

getKeywordRanges
```
public final Range[] getKeywordRanges()
```
Returns:

ranges of all java keywords printed.

reset
```
public void reset()
```
Resets the state of this pretty printer ...

setWriter
```
public void setWriter(Writer out)
```
Set a new stream to write to. Useful to redirect the output while retaining all other settings. Resets the current source positions and comments.

getLine
```
public int getLine()
```
Get current line number.

Returns:

the line number, starting with 0.

getColumn
```
public int getColumn()
```
Get current column number.

Returns:

the column number, starting with 0.

getIndentationLevel
```
public int getIndentationLevel()
```
Get indentation level.

Returns:

the int value.

setIndentationLevel
```
public void setIndentationLevel(int level)
```
Set indentation level.

Parameters:

level - an int value.

getTotalIndentation
```
public int getTotalIndentation()
```
Get total indentation.

Returns:

the int value.

changeLevel
```
public void changeLevel(int delta)
```
Change level.

Parameters:

delta - an int value.

writeIndentation

protected void writeIndentation(int lf,
                                int blanks)
                         throws IOException

Convenience method to write indentation chars.

Throws:: IOException

writeIndentation

protected void writeIndentation(Position relative)
                         throws IOException

Convenience method to write indentation chars.

Throws:: IOException

writeIndentation
```
protected void writeIndentation(SourceElement elem)
                         throws IOException
```
Write indentation.

Parameters:

elem - a source element.

Throws:

IOException - occasionally thrown.

writeInternalIndentation
```
protected void writeInternalIndentation(SourceElement elem)
                                 throws IOException
```
Write internal indentation.

Parameters:

elem - a source element.

Throws:

IOException - occasionally thrown.

writeSymbol

protected void writeSymbol(int lf,
                           int levelChange,
                           String symbol)
                    throws IOException

Write symbol.

Parameters:: lf - an int value.; levelChange - an int value.; symbol - a string.
Throws:: IOException - occasionally thrown.

encodeUnicodeChars
```
protected static String encodeUnicodeChars(String str)
```
Replace all unicode characters above ? by their explicit representation.

Parameters:

str - the input string.

Returns:

the encoded string.

scheduleComment
```
protected void scheduleComment(SingleLineComment slc)
```
Store the given comment until the next line feed is written.

Parameters:

slc - the comment to delay.

writeElement

protected void writeElement(int lf,
                            int levelChange,
                            int blanks,
                            SourceElement elem)
                     throws IOException

Adds indentation for a program element if necessary and if required, but does not print the indentation itself.

Throws:: IOException

getRelativePosition

protected Position getRelativePosition(SourceElement first)

writeToken

protected void writeToken(int lf,
                          int blanks,
                          String image,
                          NonTerminalProgramElement parent)
                   throws IOException

Writes an implicit terminal token of a NonTerminal, including its indentation. Sets the indentation if it is necessary or required.

Throws:: IOException
See Also:: SourceElement.prettyPrint(de.uka.ilkd.key.java.PrettyPrinter)

writeToken

protected final void writeToken(int blanks,
                                String image,
                                NonTerminalProgramElement parent)
                         throws IOException

Throws:: IOException

writeToken

protected final void writeToken(String image,
                                NonTerminalProgramElement parent)
                         throws IOException

Throws:: IOException

writeElement

protected void writeElement(int lf,
                            int blanks,
                            SourceElement elem)
                     throws IOException

Write a source element.

Parameters:: lf - an int value.; blanks - an int value.; elem - a source element.
Throws:: IOException - occasionally thrown.

writeElement

protected void writeElement(int blanks,
                            SourceElement elem)
                     throws IOException

Write source element.

Parameters:: blanks - an int value.; elem - a source element.
Throws:: IOException - occasionally thrown.

writeElement
```
protected void writeElement(SourceElement elem)
                     throws IOException
```
Write source element.

Parameters:

elem - a source element.

Throws:

IOException - occasionally thrown.

writeImmutableArrayOfProgramElement

protected void writeImmutableArrayOfProgramElement(int firstLF,
                                                   int levelChange,
                                                   int firstBlanks,
                                                   String separationSymbol,
                                                   int separationLF,
                                                   int separationBlanks,
                                                   ImmutableArray<? extends ProgramElement> list)
                                            throws IOException

Write a complete ArrayOf.

Throws:: IOException

writeKeywordList

protected void writeKeywordList(int firstLF,
                                int levelChange,
                                int firstBlanks,
                                ImmutableArray<? extends ProgramElement> list)
                         throws IOException

Write a complete ArrayOf using "Keyword" style.

Throws:: IOException

writeKeywordList

protected void writeKeywordList(ImmutableArray<? extends ProgramElement> list)
                         throws IOException

Write keyword list.

Parameters:: list - a program element list.
Throws:: IOException - occasionally thrown.

writeCommaList

protected void writeCommaList(int firstLF,
                              int levelChange,
                              int firstBlanks,
                              ImmutableArray<? extends ProgramElement> list)
                       throws IOException

Write a complete ArrayOf using "Comma" style.

Throws:: IOException

writeCommaList

protected void writeCommaList(int separationBlanks,
                              ImmutableArray<? extends ProgramElement> list)
                       throws IOException

Write comma list.

Parameters:: list - a program element list.
Throws:: IOException - occasionally thrown.

writeCommaList

protected void writeCommaList(ImmutableArray<? extends ProgramElement> list)
                       throws IOException

Write comma list.

Parameters:: list - a program element list.
Throws:: IOException - occasionally thrown.

writeLineList

protected void writeLineList(int firstLF,
                             int levelChange,
                             int firstBlanks,
                             ImmutableArray<? extends ProgramElement> list)
                      throws IOException

Write a complete ArrayOf using "Line" style.

Throws:: IOException

writeLineList

protected void writeLineList(ImmutableArray<? extends ProgramElement> list)
                      throws IOException

Write line list.

Parameters:: list - a program element list.
Throws:: IOException - occasionally thrown.

writeBlockList

protected void writeBlockList(int firstLF,
                              int levelChange,
                              int firstBlanks,
                              ImmutableArray<? extends ProgramElement> list)
                       throws IOException

Write a complete ArrayOf using "Block" style.

Throws:: IOException

writeBlockList

protected void writeBlockList(ImmutableArray<? extends ProgramElement> list)
                       throws IOException

Write block list.

Parameters:: list - a program element list.
Throws:: IOException - occasionally thrown.

dumpComments

private void dumpComments()
                   throws IOException

Throws:: IOException

write
```
public void write(int c)
           throws IOException
```
Write.

Parameters:

c - an int value.

Throws:

IOException - occasionally thrown.

write
```
public void write(char[] cbuf)
           throws IOException
```
Write.

Parameters:

cbuf - a char value.

Throws:

IOException - occasionally thrown.

write
```
public void write(char[] cbuf,
                  int off,
                  int len)
           throws IOException
```
Write.

Parameters:

cbuf - an array of char.

off - an int value.

len - an int value.

Throws:

IOException - occasionally thrown.

write
```
public void write(String str)
           throws IOException
```
Write.

Parameters:

str - a string.

Throws:

IOException - occasionally thrown.

write

public void write(String str,
                  int off,
                  int len)
           throws IOException

Write.

Parameters:: str - a string.; off - an int value.; len - an int value.
Throws:: IOException - occasionally thrown.

getIndentation
```
protected int getIndentation()
```
Get indentation amount (blanks per level).

Returns:

the value of getIntegerProperty("indentationAmount").

isOverwritingIndentation
```
protected boolean isOverwritingIndentation()
```
Returns true if the pretty printer should also reformat existing code.

Returns:

the value of the overwriteIndentation property.

isOverwritingParsePositions
```
protected boolean isOverwritingParsePositions()
```
Returns true if the pretty printer should reset the parse positions accordingly.

Returns:

the value of the overwriteParsePositions property.

printHeader

protected void printHeader(int lf,
                           int blanks,
                           ProgramElement elem)
                    throws IOException

Print program element header.

Parameters:: lf - an int value.; blanks - an int value.; elem - a program element.
Throws:: IOException - occasionally thrown.

printHeader

protected void printHeader(int blanks,
                           ProgramElement elem)
                    throws IOException

Print program element header.

Parameters:: blanks - an int value.; elem - a program element.
Throws:: IOException - occasionally thrown.

printHeader
```
protected void printHeader(ProgramElement elem)
                    throws IOException
```
Print program element header.

Parameters:

elem - a program element.

Throws:

IOException - occasionally thrown.

printHeader

protected void printHeader(int lf,
                           int levelChange,
                           int blanks,
                           ProgramElement x)
                    throws IOException

Print program element header.

Parameters:: lf - number of line feeds.; levelChange - the level change.; blanks - number of white spaces.; x - the program element.
Throws:: IOException - occasionally thrown.

printFooter
```
protected void printFooter(ProgramElement x)
                    throws IOException
```
Print program element footer.

Parameters:

x - the program element.

Throws:

IOException - occasionally thrown.

printOperator

protected void printOperator(Operator x,
                             String symbol)
                      throws IOException

Throws:: IOException

printProgramElementName

public void printProgramElementName(ProgramElementName x)
                             throws IOException

Throws:: IOException

printProgramVariable

public void printProgramVariable(ProgramVariable x)
                          throws IOException

Throws:: IOException

printProgramMethod

public void printProgramMethod(IProgramMethod x)
                        throws IOException

Throws:: IOException

printProgramMetaConstruct

public void printProgramMetaConstruct(ProgramTransformer x)
                               throws IOException

Throws:: IOException

printContextStatementBlock

public void printContextStatementBlock(ContextStatementBlock x)
                                throws IOException

Throws:: IOException

printIntLiteral

public void printIntLiteral(IntLiteral x)
                     throws IOException

Throws:: IOException

printBigintLiteral

public void printBigintLiteral(BigintLiteral x)
                        throws IOException

Throws:: IOException

printBooleanLiteral

public void printBooleanLiteral(BooleanLiteral x)
                         throws IOException

Throws:: IOException

printEmptySetLiteral

public void printEmptySetLiteral(EmptySetLiteral x)
                          throws IOException

Throws:: IOException

printSingleton

public void printSingleton(Singleton x)
                    throws IOException

Throws:: IOException

printSetUnion

public void printSetUnion(SetUnion x)
                   throws IOException

Throws:: IOException

printIntersect

public void printIntersect(Intersect x)
                    throws IOException

Throws:: IOException

printSetMinus

public void printSetMinus(SetMinus x)
                   throws IOException

Throws:: IOException

printAllFields

public void printAllFields(AllFields x)
                    throws IOException

Throws:: IOException

printAllObjects

public void printAllObjects(AllObjects x)
                     throws IOException

Throws:: IOException

printEmptySeqLiteral

public void printEmptySeqLiteral(EmptySeqLiteral x)
                          throws IOException

Throws:: IOException

printSeqLength

public void printSeqLength(SeqLength x)
                    throws IOException

Throws:: IOException

printSeqGet

public void printSeqGet(SeqGet x)
                 throws IOException

Throws:: IOException

printSeqSingleton

public void printSeqSingleton(SeqSingleton x)
                       throws IOException

Throws:: IOException

printSeqConcat

public void printSeqConcat(SeqConcat x)
                    throws IOException

Throws:: IOException

printIndexOf

public void printIndexOf(SeqIndexOf x)
                  throws IOException

Throws:: IOException

printSeqSub

public void printSeqSub(SeqSub x)
                 throws IOException

Throws:: IOException

printSeqReverse

public void printSeqReverse(SeqReverse x)
                     throws IOException

Throws:: IOException

printDLEmbeddedExpression

public void printDLEmbeddedExpression(DLEmbeddedExpression x)
                               throws IOException

Throws:: IOException

printStringLiteral

public void printStringLiteral(StringLiteral x)
                        throws IOException

Throws:: IOException

printNullLiteral

public void printNullLiteral(NullLiteral x)
                      throws IOException

Throws:: IOException

printCharLiteral

public void printCharLiteral(CharLiteral x)
                      throws IOException

Throws:: IOException

printDoubleLiteral

public void printDoubleLiteral(DoubleLiteral x)
                        throws IOException

Throws:: IOException

printLongLiteral

public void printLongLiteral(LongLiteral x)
                      throws IOException

Throws:: IOException

printFloatLiteral

public void printFloatLiteral(FloatLiteral x)
                       throws IOException

Throws:: IOException

printPackageSpecification

public void printPackageSpecification(PackageSpecification x)
                               throws IOException

Throws:: IOException

printAssert

public void printAssert(Assert x)
                 throws IOException

Throws:: IOException

printArrayDeclaration

public void printArrayDeclaration(ArrayDeclaration type)
                           throws IOException

Throws:: IOException

printTypeReference

public void printTypeReference(TypeReference x)
                        throws IOException

Throws:: IOException

printTypeReference

public void printTypeReference(TypeReference x,
                               boolean fullTypeNames)
                        throws IOException

Throws:: IOException

printSchemaTypeReference

public void printSchemaTypeReference(SchemaTypeReference x)
                              throws IOException

Throws:: IOException

printFieldReference

public void printFieldReference(FieldReference x)
                         throws IOException

Throws:: IOException

printPackageReference

public void printPackageReference(PackageReference x)
                           throws IOException

Throws:: IOException

printThrows

public void printThrows(Throws x)
                 throws IOException

Throws:: IOException

printArrayInitializer

public void printArrayInitializer(ArrayInitializer x)
                           throws IOException

Throws:: IOException

printCompilationUnit

public void printCompilationUnit(CompilationUnit x)
                          throws IOException

Throws:: IOException

printClassDeclaration

public void printClassDeclaration(ClassDeclaration x)
                           throws IOException

Throws:: IOException

containsDefaultConstructor

protected boolean containsDefaultConstructor(ImmutableArray<MemberDeclaration> members)

printInterfaceDeclaration

public void printInterfaceDeclaration(InterfaceDeclaration x)
                               throws IOException

Throws:: IOException

removeFinal

protected ImmutableArray<Modifier> removeFinal(ImmutableArray<Modifier> ma)

replacePrivateByPublic

protected ImmutableArray<Modifier> replacePrivateByPublic(ImmutableArray<Modifier> ma)

printFieldDeclaration

public void printFieldDeclaration(FieldDeclaration x)
                           throws IOException

Throws:: IOException

getTypeNameForAccessMethods

public static String getTypeNameForAccessMethods(String typeName)

printLocalVariableDeclaration

public void printLocalVariableDeclaration(LocalVariableDeclaration x)
                                   throws IOException

Throws:: IOException

printVariableDeclaration

public void printVariableDeclaration(VariableDeclaration x)
                              throws IOException

Throws:: IOException

printMethodDeclaration

public void printMethodDeclaration(MethodDeclaration x)
                            throws IOException

Throws:: IOException

printClassInitializer

public void printClassInitializer(ClassInitializer x)
                           throws IOException

Throws:: IOException

printStatementBlock

public void printStatementBlock(StatementBlock x)
                         throws IOException

Throws:: IOException

printBreak

public void printBreak(Break x)
                throws IOException

Throws:: IOException

printContinue

public void printContinue(Continue x)
                   throws IOException

Throws:: IOException

printReturn

public void printReturn(Return x)
                 throws IOException

Throws:: IOException

printThrow

public void printThrow(Throw x)
                throws IOException

Throws:: IOException

printDo

public void printDo(Do x)
             throws IOException

Throws:: IOException

printDo

public void printDo(Do x,
                    boolean includeBody)
             throws IOException

Throws:: IOException

removeChar

private static void removeChar(StringBuffer sb,
                               char c)

printEnhancedFor

public void printEnhancedFor(EnhancedFor x)
                      throws IOException

Throws:: IOException

printEnhancedFor

public void printEnhancedFor(EnhancedFor x,
                             boolean includeBody)
                      throws IOException

Throws:: IOException

printFor

public void printFor(For x)
              throws IOException

Throws:: IOException

printFor

public void printFor(For x,
                     boolean includeBody)
              throws IOException

Throws:: IOException

printWhile

public void printWhile(While x)
                throws IOException

Throws:: IOException

printWhile

public void printWhile(While x,
                       boolean includeBody)
                throws IOException

Throws:: IOException

printIf

public void printIf(If x)
             throws IOException

Throws:: IOException

printIf

public void printIf(If x,
                    boolean includeBranches)
             throws IOException

Throws:: IOException

printSwitch

public void printSwitch(Switch x)
                 throws IOException

Throws:: IOException

printSwitch

public void printSwitch(Switch x,
                        boolean includeBranches)
                 throws IOException

Throws:: IOException

printTry

public void printTry(Try x)
              throws IOException

Throws:: IOException

printLabeledStatement

public void printLabeledStatement(LabeledStatement x)
                           throws IOException

Throws:: IOException

printMethodFrame

public void printMethodFrame(MethodFrame x)
                      throws IOException

Throws:: IOException

printCatchAllStatement

public void printCatchAllStatement(CatchAllStatement x)
                            throws IOException

Throws:: IOException

printMethodBodyStatement

public void printMethodBodyStatement(MethodBodyStatement x)
                              throws IOException

Throws:: IOException

printSynchronizedBlock

public void printSynchronizedBlock(SynchronizedBlock x)
                            throws IOException

Throws:: IOException

printImport

public void printImport(Import x)
                 throws IOException

Throws:: IOException

printExtends

public void printExtends(Extends x)
                  throws IOException

Throws:: IOException

printImplements

public void printImplements(Implements x)
                     throws IOException

Throws:: IOException

printVariableSpecification

public void printVariableSpecification(VariableSpecification x)
                                throws IOException

Throws:: IOException

printBinaryAnd

public void printBinaryAnd(BinaryAnd x)
                    throws IOException

Throws:: IOException

printBinaryAndAssignment

public void printBinaryAndAssignment(BinaryAndAssignment x)
                              throws IOException

Throws:: IOException

printBinaryOrAssignment

public void printBinaryOrAssignment(BinaryOrAssignment x)
                             throws IOException

Throws:: IOException

printBinaryXOrAssignment

public void printBinaryXOrAssignment(BinaryXOrAssignment x)
                              throws IOException

Throws:: IOException

printCopyAssignment

public void printCopyAssignment(CopyAssignment x)
                         throws IOException

Throws:: IOException

printDivideAssignment

public void printDivideAssignment(DivideAssignment x)
                           throws IOException

Throws:: IOException

printMinusAssignment

public void printMinusAssignment(MinusAssignment x)
                          throws IOException

Throws:: IOException

printModuloAssignment

public void printModuloAssignment(ModuloAssignment x)
                           throws IOException

Throws:: IOException

printPlusAssignment

public void printPlusAssignment(PlusAssignment x)
                         throws IOException

Throws:: IOException

printPostDecrement

public void printPostDecrement(PostDecrement x)
                        throws IOException

Throws:: IOException

printPostIncrement

public void printPostIncrement(PostIncrement x)
                        throws IOException

Throws:: IOException

printPreDecrement

public void printPreDecrement(PreDecrement x)
                       throws IOException

Throws:: IOException

printPreIncrement

public void printPreIncrement(PreIncrement x)
                       throws IOException

Throws:: IOException

printShiftLeftAssignment

public void printShiftLeftAssignment(ShiftLeftAssignment x)
                              throws IOException

Throws:: IOException

printShiftRightAssignment

public void printShiftRightAssignment(ShiftRightAssignment x)
                               throws IOException

Throws:: IOException

printTimesAssignment

public void printTimesAssignment(TimesAssignment x)
                          throws IOException

Throws:: IOException

printUnsignedShiftRightAssignment

public void printUnsignedShiftRightAssignment(UnsignedShiftRightAssignment x)
                                       throws IOException

Throws:: IOException

printBinaryNot

public void printBinaryNot(BinaryNot x)
                    throws IOException

Throws:: IOException

printBinaryOr

public void printBinaryOr(BinaryOr x)
                   throws IOException

Throws:: IOException

printBinaryXOr

public void printBinaryXOr(BinaryXOr x)
                    throws IOException

Throws:: IOException

printConditional

public void printConditional(Conditional x)
                      throws IOException

Throws:: IOException

printDivide

public void printDivide(Divide x)
                 throws IOException

Throws:: IOException

printEquals

public void printEquals(Equals x)
                 throws IOException

Throws:: IOException

printGreaterOrEquals

public void printGreaterOrEquals(GreaterOrEquals x)
                          throws IOException

Throws:: IOException

printGreaterThan

public void printGreaterThan(GreaterThan x)
                      throws IOException

Throws:: IOException

printLessOrEquals

public void printLessOrEquals(LessOrEquals x)
                       throws IOException

Throws:: IOException

printLessThan

public void printLessThan(LessThan x)
                   throws IOException

Throws:: IOException

printNotEquals

public void printNotEquals(NotEquals x)
                    throws IOException

Throws:: IOException

printNewArray

public void printNewArray(NewArray x)
                   throws IOException

Throws:: IOException

printInstanceof

public void printInstanceof(Instanceof x)
                     throws IOException

Throws:: IOException

printExactInstanceof

public void printExactInstanceof(ExactInstanceof x)
                          throws IOException

Throws:: IOException

printNew

public void printNew(New x)
              throws IOException

Throws:: IOException

printTypeCast

public void printTypeCast(TypeCast x)
                   throws IOException

Throws:: IOException

printLogicalAnd

public void printLogicalAnd(LogicalAnd x)
                     throws IOException

Throws:: IOException

printLogicalNot

public void printLogicalNot(LogicalNot x)
                     throws IOException

Throws:: IOException

printLogicalOr

public void printLogicalOr(LogicalOr x)
                    throws IOException

Throws:: IOException

printMinus

public void printMinus(Minus x)
                throws IOException

Throws:: IOException

printModulo

public void printModulo(Modulo x)
                 throws IOException

Throws:: IOException

printNegative

public void printNegative(Negative x)
                   throws IOException

Throws:: IOException

printPlus

public void printPlus(Plus x)
               throws IOException

Throws:: IOException

printPositive

public void printPositive(Positive x)
                   throws IOException

Throws:: IOException

printShiftLeft

public void printShiftLeft(ShiftLeft x)
                    throws IOException

Throws:: IOException

printShiftRight

public void printShiftRight(ShiftRight x)
                     throws IOException

Throws:: IOException

printTimes

public void printTimes(Times x)
                throws IOException

Throws:: IOException

printUnsignedShiftRight

public void printUnsignedShiftRight(UnsignedShiftRight x)
                             throws IOException

Throws:: IOException

printArrayReference

public void printArrayReference(ArrayReference x)
                         throws IOException

Throws:: IOException

printMetaClassReference

public void printMetaClassReference(MetaClassReference x)
                             throws IOException

Throws:: IOException

printMethodReference

public void printMethodReference(MethodReference x)
                          throws IOException

Throws:: IOException

printMethodReference

protected void printMethodReference(MethodReference x,
                                    boolean withSemicolon)
                             throws IOException

Throws:: IOException

printMethod

public void printMethod(IProgramMethod x)
                 throws IOException

Throws:: IOException

printFullMethodSignature

public void printFullMethodSignature(IProgramMethod x)
                              throws IOException

Throws:: IOException

writeFullMethodSignature

protected void writeFullMethodSignature(IProgramMethod x)
                                 throws IOException

Throws:: IOException

printExecutionContext

public void printExecutionContext(ExecutionContext x)
                           throws IOException

Throws:: IOException

printSuperConstructorReference

public void printSuperConstructorReference(SuperConstructorReference x)
                                    throws IOException

Throws:: IOException

printThisConstructorReference

public void printThisConstructorReference(ThisConstructorReference x)
                                   throws IOException

Throws:: IOException

printSuperReference

public void printSuperReference(SuperReference x)
                         throws IOException

Throws:: IOException

printThisReference

public void printThisReference(ThisReference x)
                        throws IOException

Throws:: IOException

printArrayLengthReference

public void printArrayLengthReference(ArrayLengthReference x)
                               throws IOException

Throws:: IOException

printThen

public void printThen(Then x)
               throws IOException

Throws:: IOException

printElse

public void printElse(Else x)
               throws IOException

Throws:: IOException

printCase

public void printCase(Case x)
               throws IOException

Throws:: IOException

printCatch

public void printCatch(Catch x)
                throws IOException

Throws:: IOException

printDefault

public void printDefault(Default x)
                  throws IOException

Throws:: IOException

printFinally

public void printFinally(Finally x)
                  throws IOException

Throws:: IOException

printModifier

public void printModifier(Modifier x)
                   throws IOException

Throws:: IOException

printSchemaVariable

public void printSchemaVariable(SchemaVariable x)
                         throws IOException

Throws:: IOException

printEmptyStatement

public void printEmptyStatement(EmptyStatement x)
                         throws IOException

Throws:: IOException

printComment

public void printComment(Comment x)
                  throws IOException

Throws:: IOException

printParenthesizedExpression

public void printParenthesizedExpression(ParenthesizedExpression x)
                                  throws IOException

Throws:: IOException

printPassiveExpression

public void printPassiveExpression(PassiveExpression x)
                            throws IOException

Throws:: IOException

printTransactionStatement

public void printTransactionStatement(TransactionStatement x)
                               throws IOException

Throws:: IOException

printEmptyMapLiteral

public void printEmptyMapLiteral(EmptyMapLiteral x)
                          throws IOException

Throws:: IOException

Class PrettyPrinter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

line

column

level

out

outBuf

noLinefeed

noSemicolons

classToPrint

firstStatementStart

firstStatementEnd

startAlreadyMarked

endAlreadyMarked

firstStatement

instantiations

keywordStarts

keywordRanges

writtenCharacters

isPrintingSingleLineComments

indentMap

BLANKS

FEEDS

indentation

overwriteIndentation

overwriteParsePositions

Constructor Detail

PrettyPrinter

PrettyPrinter

PrettyPrinter

PrettyPrinter

Method Detail

output

getCurrentPos

markStart

markEnd

getRangeOfFirstExecutableStatement

markKeywordStart

markKeywordEnd

getKeywordRanges

reset

setWriter

getLine

getColumn

getIndentationLevel

setIndentationLevel

getTotalIndentation

changeLevel

writeIndentation

writeIndentation

writeIndentation

writeInternalIndentation

writeSymbol

encodeUnicodeChars

scheduleComment

writeElement

getRelativePosition

writeToken

writeToken

writeToken

writeElement

writeElement

writeElement

writeImmutableArrayOfProgramElement

writeKeywordList

writeKeywordList

writeCommaList

writeCommaList

writeCommaList

writeLineList

writeLineList

writeBlockList

writeBlockList

dumpComments

write

write