Module aya.pretty

Package org.aya.pretty.backend.string

Class StringPrinter<Config extends StringPrinterConfig<?>>

java.lang.Object

org.aya.pretty.backend.string.StringPrinter<Config>

All Implemented Interfaces:

Printer<String,Config>

Direct Known Subclasses:

DocHtmlPrinter, DocTermPrinter, DocTeXPrinter

public class StringPrinter<Config extends StringPrinterConfig<?>>
extends Object
implements Printer<String,Config>

The class for all string-output printers.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	StringPrinter.Outer	renderer: where am I?

Field Summary

Fields

Modifier and Type	Field	Description
protected Config	config
static final @NotNull EnumSet<StringPrinter.Outer>	FREE

Constructor Summary

Constructors

Constructor	Description
StringPrinter()

Method Summary

Modifier and Type	Method	Description
protected @NotNull String	escapePlainText(@NotNull String content, EnumSet<StringPrinter.Outer> outer)
protected @NotNull Doc	fitsBetter(@NotNull Cursor cursor, @NotNull Doc a, @NotNull Doc b)
@NotNull String	makeIndent(int indent)
protected int	predictWidth(@NotNull Cursor cursor, @NotNull Doc doc)
protected @NotNull StringStylist	prepareStylist()
@NotNull String	render(Config config, @NotNull Doc doc)	Render a Doc object with a config.
protected void	renderCodeBlock(@NotNull Cursor cursor, Doc.CodeBlock block, EnumSet<StringPrinter.Outer> outer)
protected void	renderDoc(@NotNull Cursor cursor, @NotNull Doc doc, EnumSet<StringPrinter.Outer> outer)
protected void	renderFlatAlt(@NotNull Cursor cursor, Doc.FlatAlt alt, EnumSet<StringPrinter.Outer> outer)
protected void	renderFooter(@NotNull Cursor cursor)
protected void	renderHardLineBreak(@NotNull Cursor cursor, EnumSet<StringPrinter.Outer> outer)
protected void	renderHeader(@NotNull Cursor cursor)
protected void	renderHyperLinked(@NotNull Cursor cursor, Doc.HyperLinked text, EnumSet<StringPrinter.Outer> outer)
protected void	renderImage(@NotNull Cursor cursor, Doc.Image image, EnumSet<StringPrinter.Outer> outer)
protected void	renderInlineCode(@NotNull Cursor cursor, Doc.InlineCode code, EnumSet<StringPrinter.Outer> outer)
protected void	renderList(@NotNull Cursor cursor, Doc.List list, EnumSet<StringPrinter.Outer> outer)
protected static void	renderList(@NotNull StringPrinter<?> printer, @NotNull Cursor cursor, Doc.List list, EnumSet<StringPrinter.Outer> outer)
protected void	renderNest(@NotNull Cursor cursor, Doc.Nest nest, EnumSet<StringPrinter.Outer> outer)
protected void	renderPlainText(@NotNull Cursor cursor, @NotNull String content, EnumSet<StringPrinter.Outer> outer)
protected void	renderSpecialSymbol(@NotNull Cursor cursor, @NotNull String text, EnumSet<StringPrinter.Outer> outer)
protected void	renderStyled(@NotNull Cursor cursor, Doc.Styled styled, EnumSet<StringPrinter.Outer> outer)
protected void	renderUnionDoc(@NotNull Cursor cursor, Doc.Union union, EnumSet<StringPrinter.Outer> outer)

Methods inherited from class java.lang.Object

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

Field Details

FREE

@NotNull
public static final @NotNull EnumSet<StringPrinter.Outer> FREE

config

protected Config extends StringPrinterConfig<?> config

Constructor Details

StringPrinter

public StringPrinter()

Method Details

makeIndent

@NotNull
public @NotNull String makeIndent(int indent)

render

@NotNull
public @NotNull String render(@NotNull
 Config config,
 @NotNull
 @NotNull Doc doc)

Description copied from interface: Printer

Render a Doc object with a config.

Specified by:

render in interface Printer<String,Config extends StringPrinterConfig<?>>

Parameters:

config - printer config

doc - doc object

Returns:

rendered content

predictWidth

protected int predictWidth(@NotNull
 @NotNull Cursor cursor,
 @NotNull
 @NotNull Doc doc)

fitsBetter

@NotNull
protected @NotNull Doc fitsBetter(@NotNull
 @NotNull Cursor cursor,
 @NotNull
 @NotNull Doc a,
 @NotNull
 @NotNull Doc b)

renderHeader

protected void renderHeader(@NotNull
 @NotNull Cursor cursor)

renderFooter

protected void renderFooter(@NotNull
 @NotNull Cursor cursor)

renderDoc

protected void renderDoc(@NotNull
 @NotNull Cursor cursor,
 @NotNull
 @NotNull Doc doc,
 EnumSet<StringPrinter.Outer> outer)

renderSpecialSymbol

protected void renderSpecialSymbol(@NotNull
 @NotNull Cursor cursor,
 @NotNull
 @NotNull String text,
 EnumSet<StringPrinter.Outer> outer)

renderNest

protected void renderNest(@NotNull
 @NotNull Cursor cursor,
 @NotNull
 Doc.Nest nest,
 EnumSet<StringPrinter.Outer> outer)

renderUnionDoc

protected void renderUnionDoc(@NotNull
 @NotNull Cursor cursor,
 @NotNull
 Doc.Union union,
 EnumSet<StringPrinter.Outer> outer)

renderFlatAlt

protected void renderFlatAlt(@NotNull
 @NotNull Cursor cursor,
 @NotNull
 Doc.FlatAlt alt,
 EnumSet<StringPrinter.Outer> outer)

renderHyperLinked

protected void renderHyperLinked(@NotNull
 @NotNull Cursor cursor,
 @NotNull
 Doc.HyperLinked text,
 EnumSet<StringPrinter.Outer> outer)

renderImage

protected void renderImage(@NotNull
 @NotNull Cursor cursor,
 @NotNull
 Doc.Image image,
 EnumSet<StringPrinter.Outer> outer)

renderStyled

protected void renderStyled(@NotNull
 @NotNull Cursor cursor,
 @NotNull
 Doc.Styled styled,
 EnumSet<StringPrinter.Outer> outer)

prepareStylist

@NotNull
protected @NotNull StringStylist prepareStylist()

renderPlainText

protected void renderPlainText(@NotNull
 @NotNull Cursor cursor,
 @NotNull
 @NotNull String content,
 EnumSet<StringPrinter.Outer> outer)

escapePlainText

@NotNull
protected @NotNull String escapePlainText(@NotNull
 @NotNull String content,
 EnumSet<StringPrinter.Outer> outer)

renderHardLineBreak

protected void renderHardLineBreak(@NotNull
 @NotNull Cursor cursor,
 EnumSet<StringPrinter.Outer> outer)

renderCodeBlock

protected void renderCodeBlock(@NotNull
 @NotNull Cursor cursor,
 @NotNull
 Doc.CodeBlock block,
 EnumSet<StringPrinter.Outer> outer)

renderInlineCode

protected void renderInlineCode(@NotNull
 @NotNull Cursor cursor,
 @NotNull
 Doc.InlineCode code,
 EnumSet<StringPrinter.Outer> outer)

renderList

protected void renderList(@NotNull
 @NotNull Cursor cursor,
 @NotNull
 Doc.List list,
 EnumSet<StringPrinter.Outer> outer)

renderList

protected static void renderList(@NotNull
 @NotNull StringPrinter<?> printer,
 @NotNull
 @NotNull Cursor cursor,
 @NotNull
 Doc.List list,
 EnumSet<StringPrinter.Outer> outer)