Package com.google.googlejavaformat

Class DocBuilder

java.lang.Object

com.google.googlejavaformat.DocBuilder

public final class DocBuilder
extends java.lang.Object

A DocBuilder converts a sequence of Ops into a Doc.

Field Summary

Fields

Modifier and Type	Field	Description
private Doc.Level	appendLevel	A possibly earlier Doc.Level for appending text, à la Philip Wadler.
private Doc.Level	base
private java.util.ArrayDeque<Doc.Level>	stack

Constructor Summary

Constructors

Constructor	Description
DocBuilder()	Start to build a DocBuilder.

Method Summary

Modifier and Type	Method	Description
(package private) void	add(Doc doc)	Add a Doc to the current Doc.Level.
(package private) void	breakDoc(Doc.Break breakDoc)	Add a Doc.Break to the current Doc.Level.
Doc	build()	Return the Doc.
(package private) void	close()	Close the current Doc.Level.
(package private) void	open(Indent plusIndent)	Open a new Doc.Level.
java.lang.String	toString()
DocBuilder	withOps(java.util.List<Op> ops)	Add a list of Ops to the OpsBuilder.

Methods inherited from class java.lang.Object

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

Field Detail

base

private final Doc.Level base

stack

private final java.util.ArrayDeque<Doc.Level> stack

appendLevel

private Doc.Level appendLevel

A possibly earlier Doc.Level for appending text, à la Philip Wadler.

Processing Docs presents a subtle problem. Suppose we have a Doc for to an assignment node, a = b, with an optional Doc.Break following the =. Suppose we have 5 characters to write it, so that we think we don't need the break. Unfortunately, this Doc lies in an expression statement Doc for the statement a = b; and this statement does not fit in 3 characters. This is why many formatters sometimes emit lines that are too long, or cheat by using a narrower line length to avoid such problems.

One solution to this problem is not to decide whether a Doc.Level should be broken until later (in this case, after the semicolon has been seen). A simpler approach is to rewrite the Doc as here, so that the semicolon moves inside the inner Doc, and we can decide whether to break that Doc without seeing later text.

Constructor Detail

DocBuilder

public DocBuilder()

Start to build a DocBuilder.

Method Detail

withOps

public DocBuilder withOps(java.util.List<Op> ops)

Add a list of Ops to the OpsBuilder.

Parameters:

ops - the Ops

Returns:

the OpsBuilder

open

void open(Indent plusIndent)

Open a new Doc.Level.

Parameters:

plusIndent - the extra indent for the Doc.Level

close

void close()

Close the current Doc.Level.

add

void add(Doc doc)

Add a Doc to the current Doc.Level.

Parameters:

doc - the Doc

breakDoc

void breakDoc(Doc.Break breakDoc)

Add a Doc.Break to the current Doc.Level.

Parameters:

breakDoc - the Doc.Break

build

public Doc build()

Return the Doc.

Returns:

the Doc

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object