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)
protected void	formatBlock(@NotNull Cursor cursor, @NotNull String begin, @NotNull String end, EnumSet<StringPrinter.Outer> outer, @NotNull Runnable inside)	Render the resulting document as:
protected void	formatBlock(@NotNull Cursor cursor, @NotNull Doc doc, @NotNull String begin, @NotNull String end, EnumSet<StringPrinter.Outer> outer)
protected void	formatInline(@NotNull Cursor cursor, @NotNull Doc doc, @NotNull String begin, @NotNull String end, EnumSet<StringPrinter.Outer> outer)	Render the resulting document as:
protected void	formatList(@NotNull Cursor cursor, Doc.List list, EnumSet<StringPrinter.Outer> outer)
protected void	formatList(@NotNull Cursor cursor, Doc.List list, @NotNull IntFunction<String> itemBegin, EnumSet<StringPrinter.Outer> outer)
protected @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	renderBlockSeparator(@NotNull Cursor cursor, EnumSet<StringPrinter.Outer> outer)	This line break makes target source code beautiful (like .tex or .md generated from Doc).
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)	This line break is printed in the resulting document (like .pdf generated from .tex or .md).
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	renderInlineMath(@NotNull Cursor cursor, Doc.InlineMath code, EnumSet<StringPrinter.Outer> outer)
protected void	renderList(@NotNull Cursor cursor, Doc.List list, EnumSet<StringPrinter.Outer> outer)
protected void	renderMathBlock(@NotNull Cursor cursor, Doc.MathBlock block, 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	renderTooltip(@NotNull Cursor cursor, Doc.Tooltip tooltip, EnumSet<StringPrinter.Outer> outer)
protected void	renderUnionDoc(@NotNull Cursor cursor, Doc.Union union, EnumSet<StringPrinter.Outer> outer)
protected void	separateBlockIfNeeded(@NotNull Cursor cursor, EnumSet<StringPrinter.Outer> outer)	renderBlockSeparator if not line start

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
protected @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)

renderBlockSeparator

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

This line break makes target source code beautiful (like .tex or .md generated from Doc). It is not printed in the resulting document (like .pdf generated from .tex or .md), since it only separates different block elements (list, code block, etc.) in generated source files.

The default implementation is to print a single `\n` character and move to new line.

API Note:

This is called by renderCodeBlock(org.aya.pretty.backend.string.Cursor, org.aya.pretty.doc.Doc.CodeBlock, java.util.EnumSet<org.aya.pretty.backend.string.StringPrinter.Outer>), renderMathBlock(org.aya.pretty.backend.string.Cursor, org.aya.pretty.doc.Doc.MathBlock, java.util.EnumSet<org.aya.pretty.backend.string.StringPrinter.Outer>), formatList(org.aya.pretty.backend.string.Cursor, org.aya.pretty.doc.Doc.List, java.util.EnumSet<org.aya.pretty.backend.string.StringPrinter.Outer>), and other block rendering methods to separate the current block from the previous one.

renderHardLineBreak

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

This line break is printed in the resulting document (like .pdf generated from .tex or .md). The default implementation is same as renderBlockSeparator(org.aya.pretty.backend.string.Cursor, java.util.EnumSet<org.aya.pretty.backend.string.StringPrinter.Outer>). Backends may override this method if the source code line break is different from the printed line break, (like LaTeX use '\\' for new line in the printed document).

renderTooltip

protected void renderTooltip(@NotNull
 @NotNull Cursor cursor,
 @NotNull
 Doc.Tooltip tooltip,
 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)

renderMathBlock

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

renderInlineMath

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

renderList

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

formatList

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

formatList

protected void formatList(@NotNull
 @NotNull Cursor cursor,
 @NotNull
 Doc.List list,
 @NotNull
 @NotNull IntFunction<String> itemBegin,
 EnumSet<StringPrinter.Outer> outer)

separateBlockIfNeeded

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

renderBlockSeparator if not line start

formatBlock

protected void formatBlock(@NotNull
 @NotNull Cursor cursor,
 @NotNull
 @NotNull Doc doc,
 @NotNull
 @NotNull String begin,
 @NotNull
 @NotNull String end,
 EnumSet<StringPrinter.Outer> outer)

formatBlock

protected void formatBlock(@NotNull
 @NotNull Cursor cursor,
 @NotNull
 @NotNull String begin,
 @NotNull
 @NotNull String end,
 EnumSet<StringPrinter.Outer> outer,
 @NotNull
 @NotNull Runnable inside)

Render the resulting document as:

 begin\n
 inside()\n
 end\n
 

formatInline

protected void formatInline(@NotNull
 @NotNull Cursor cursor,
 @NotNull
 @NotNull Doc doc,
 @NotNull
 @NotNull String begin,
 @NotNull
 @NotNull String end,
 EnumSet<StringPrinter.Outer> outer)

Render the resulting document as:

 begin·doc·end