de.uka.ilkd.key.util.pp

Class Printer

java.lang.Object

de.uka.ilkd.key.util.pp.Printer

class Printer
extends Object

The intermediate layer of the pretty printing library. Using the block size information provided by the Layouter class, this decides where to insert line breaks. It tries to break as few blocks as possible.

Field Summary

Fields

Modifier and Type	Field and Description
private Backend	back Back-end for the pretty-printed output
private static int	BREAK_MASK Mask for break type flags.
private static int	CONSISTENT Flag to indicate this block will be broken consistently
private static int	FITS Flag to indicate this block fits into the current line
private static int	INCONSISTENT Flag to indicate this block will be broken inconsistently
private int	lineWidth total line length available
private ArrayList<Integer>	marginStack stack to remember value of pos in nested blocks
private int	pos position in current line.
private static String	spaces a String containing SPACES spaces
private static int	SPACES how many spaces

Constructor Summary

Constructors

Constructor and Description
Printer(Backend back) Create a printer.

Method Summary

Modifier and Type	Method and Description
(package private) void	close() Close the output stream.
(package private) void	closeBlock() end a block
(package private) void	flush() Flush the output stream.
(package private) void	indent(int width, int offset)
(package private) int	lineWidth() Return the line width of this Printer.
(package private) void	mark(Object o)
private void	newLine() Start a new line and indent according to pos
(package private) void	openBlock(boolean consistent, int indent, int followingLength) begin a block
private void	pop() Pop one element from the space stack.
(package private) void	print(String s) write the String s to out
(package private) void	printBreak(int width, int offset, int followingLength) write a break.
private void	push(int n, int breaks)
(package private) int	space() Return the amount of space currently left on this line.
private int	top() return the topmost element of the space stack without popping it.
private int	topBreak()
private int	topMargin()
private void	writeSpaces(int n)

Methods inherited from class java.lang.Object

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

Field Detail

BREAK_MASK

private static final int BREAK_MASK

Mask for break type flags. These flags are logically or-ed onto the margins in the marginStack to remember what happens with the block in question.

See Also:

Constant Field Values

FITS

private static final int FITS

Flag to indicate this block fits into the current line

See Also:

Constant Field Values

CONSISTENT

private static final int CONSISTENT

Flag to indicate this block will be broken consistently

See Also:

Constant Field Values

INCONSISTENT

private static final int INCONSISTENT

Flag to indicate this block will be broken inconsistently

See Also:

Constant Field Values

lineWidth

private final int lineWidth

total line length available

pos

private int pos

position in current line.

back

private Backend back

Back-end for the pretty-printed output

marginStack

private ArrayList<Integer> marginStack

stack to remember value of pos in nested blocks

SPACES

private static final int SPACES

how many spaces

See Also:

Constant Field Values

spaces

private static final String spaces

a String containing SPACES spaces

Constructor Detail

Printer

Printer(Backend back)

Create a printer. It will write its output to writer. Lines have a maximum width of lineWidth.

Method Detail

print

void print(String s)
    throws IOException

write the String s to out

Throws:

IOException

openBlock

void openBlock(boolean consistent,
               int indent,
               int followingLength)

begin a block

closeBlock

void closeBlock()

end a block

printBreak

void printBreak(int width,
                int offset,
                int followingLength)
         throws IOException

write a break. followingLength should be the space needed by the material up to the next corresponding closeBlock() or printBreak(), and is used to decide whether the current line is continues, or a new (indented) line is begun.

Throws:

IOException

mark

void mark(Object o)

indent

void indent(int width,
            int offset)
     throws IOException

Throws:

IOException

close

void close()
    throws IOException

Close the output stream.

Throws:

IOException

flush

void flush()
    throws IOException

Flush the output stream.

Throws:

IOException

space

int space()

Return the amount of space currently left on this line.

lineWidth

int lineWidth()

Return the line width of this Printer.

push

private void push(int n,
                  int breaks)

pop

private void pop()

Pop one element from the space stack.

top

private int top()

return the topmost element of the space stack without popping it.

topMargin

private int topMargin()

topBreak

private int topBreak()

newLine

private void newLine()
              throws IOException

Start a new line and indent according to pos

Throws:

IOException

writeSpaces

private void writeSpaces(int n)
                  throws IOException

Throws:

IOException