Module aya.pretty
Package org.aya.pretty.doc

Interface Doc

All Superinterfaces:
Docile
All Known Implementing Classes:
Doc.Cat, Doc.Column, Doc.Empty, Doc.FlatAlt, Doc.HyperLinked, Doc.Line, Doc.Nest, Doc.Nesting, Doc.PageWidth, Doc.PlainText, Doc.SpecialSymbol, Doc.Styled, Doc.Union
public sealed interface Doc extends Docile permits Doc.HyperLinked, Doc.Nest, Doc.Union, Doc.FlatAlt, Doc.Styled, Doc.Empty, Doc.PlainText, Doc.SpecialSymbol, Doc.Line, Doc.Cat, Doc.Column, Doc.Nesting, Doc.PageWidth
This class reimplemented Haskell PrettyPrint library's Doc module.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final record 
    Doc.Cat
    Concatenation of two documents
    static final record 
    Doc.Column
    A document that will react on the current cursor position.
    static final record 
    Doc.Empty
    The empty document; conceptually the unit of 'Cat'
    static final record 
    Doc.FlatAlt
    Lay out the defaultDoc 'Doc', but when flattened (via 'group'), prefer the preferWhenFlatten.
    static final record 
    Doc.HyperLinked
    A clickable text line without '\n'.
    static final record 
    Doc.Line
    Hard line break
    static final record 
    Doc.Nest
    Document indented by a number of columns
    static final record 
    Doc.Nesting
    A document that will react on the current nest level.
    static final record 
    Doc.PageWidth
    A document that will react on the page width.
    static final record 
    Doc.PlainText
    A plain text line without '\n'.
    static final record 
    Doc.SpecialSymbol
    A special symbol that may get rendered in a special way
    static final record 
    Doc.Styled
    Styled document
    static final record 
    Doc.Union
    The first lines of first document should be shorter than the first lines of the second one, so the layout algorithm can pick the one that fits best.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final @NotNull Doc
    ALT_WS
     
    static final @NotNull Doc
    COMMA
     
    static final @NotNull Doc
    ONE_WS
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static @NotNull Doc
    align(@NotNull Doc doc)
    align lays out the document with the nesting level set to the current column.
    static @NotNull Doc
    angled(Doc doc)
     
    default @NotNull kala.collection.SeqLike<Doc>
    asSeq()
     
    static @NotNull Doc
    braced(Doc doc)
     
    static @NotNull Doc
    bracedUnless(Doc doc, boolean falsification)
     
    static @NotNull Doc
    cat(@NotNull kala.collection.SeqLike<Doc> docs)
    cat tries laying out the documents separated with nothing, and if this does not fit the page, separates them with newlines.
    static @NotNull Doc
    cat(Doc @NotNull ... docs)
     
    static @NotNull Doc
    cblock(@NotNull Doc prefix, int indent, @NotNull Doc block)
    Creates a C-style indented block of statements.
    static @NotNull Doc
    column(@NotNull IntFunction<Doc> docBuilder)
    Layout a document depending on which column it starts at.
    static @NotNull Doc
    commaList(@NotNull kala.collection.SeqLike<Doc> docs)
     
    default @NotNull String
    commonRender()
    Produce unicode and 80-width output
    default @NotNull String
    debugRender()
    Produce ASCII and infinite-width output
    static @NotNull Doc
    empty()
    The empty document; conceptually the unit of 'Cat'
    static @NotNull Doc
    emptyIf(boolean cond, Supplier<@NotNull Doc> otherwise)
    Return conditional empty()
    static @NotNull Doc
    english(String text)
     
    static @NotNull Doc
    flatAlt(@NotNull Doc defaultDoc, @NotNull Doc preferWhenFlattened)
    By default, flatAlt renders as .
    static @NotNull Doc
    flatAltBracedBlock(Doc defaultDoc, Doc flatDoc)
    Either `{ defaultDoc }` or `{\nflatDoc\n}`
    static @NotNull Doc
    hang(int deltaNest, @NotNull Doc doc)
    hang lays out the document with a nesting level set to the /current column/ plus .
    static @NotNull Doc
    hyperLink(@NotNull String plain, @NotNull LinkId link)
     
    static @NotNull Doc
    hyperLink(@NotNull Doc doc, @NotNull LinkId link)
     
    default boolean
    isEmpty()
     
    default boolean
    isNotEmpty()
     
    static @NotNull Doc
    join(@NotNull Doc delim, @NotNull kala.collection.SeqLike<@NotNull Doc> docs)
     
    static @NotNull Doc
    join(@NotNull Doc delim, Doc @NotNull ... docs)
     
    static @NotNull Doc
    licit(boolean explicit, Doc doc)
     
    static @NotNull Doc
    line()
    Unconditionally line break
    static @NotNull Doc
    linkDef(@NotNull Doc doc, int hashCode)
     
    static @NotNull Doc
    linkRef(@NotNull Doc doc, int hashCode)
     
    static @NotNull Doc
    nest(int indent, @NotNull Doc doc)
    lays out the document with the current nesting level (indentation of the following lines) increased by .
    static @NotNull Doc
    nesting(@NotNull IntFunction<Doc> docBuilder)
    Layout a document depending on the current 'nest'-ing level.
    static @NotNull Doc
    ordinal(int n)
     
    static @NotNull Doc
    pageWidth(@NotNull IntFunction<Doc> docBuilder)
    Layout a document depending on the page width, if one has been specified.
    static @NotNull Doc
    par(int indent, @NotNull Doc doc)
    Indents by columns, and then indent the first line again by columns.
    static @NotNull Doc
    parened(Doc doc)
     
    static @NotNull Doc
    plain(String text)
    Plain text document
    default <Out, Config extends PrinterConfig>
    Out
    render(@NotNull Printer<Out,Config> printer, Config config)
     
    default @NotNull String
    renderToHtml()
     
    default @NotNull String
    renderToHtml(boolean withHeader)
     
    default @NotNull String
    renderToString(@NotNull StringPrinterConfig config)
     
    default @NotNull String
    renderToTeX()
     
    default @NotNull String
    renderWithPageWidth(int pageWidth, boolean unicode)
     
    static @NotNull Doc
    sep(@NotNull kala.collection.SeqLike<Doc> docs)
     
    static @NotNull Doc
    sep(Doc @NotNull ... docs)
    fillSep concatenates the documents horizontally with a space as long as it fits the page, then inserts a 'line' and continues doing that for all documents in .
    static @NotNull Doc
    sepNonEmpty(@NotNull kala.collection.SeqLike<Doc> docs)
     
    static @NotNull Doc
    sepNonEmpty(Doc @NotNull ... docs)
     
    static @NotNull Doc
    spaced(Doc symbol)
     
    static @NotNull Doc
    stickySep(@NotNull kala.collection.SeqLike<@NotNull Doc> docs)
    stickySep concatenates all documents horizontally with a space, i.e.
    static @NotNull Doc
    stickySep(Doc @NotNull ... docs)
     
    static @NotNull Doc
    styled(@NotNull Style style, @NotNull String plain)
     
    static @NotNull Doc
    styled(@NotNull Style style, @NotNull Doc doc)
     
    static @NotNull Doc
    styled(@NotNull Styles builder, @NotNull String plain)
     
    static @NotNull Doc
    styled(@NotNull Styles builder, @NotNull Doc doc)
     
    static @NotNull Doc
    symbol(String text)
     
    default @NotNull Doc
    toDoc()
     
    static @NotNull Doc
    vcat(@NotNull kala.collection.SeqLike<@NotNull Doc> docs)
     
    static @NotNull Doc
    vcat(Doc @NotNull ... docs)
     
    static @NotNull Doc
    vcatNonEmpty(@NotNull kala.collection.SeqLike<Doc> docs)
     
    static @NotNull Doc
    vcatNonEmpty(Doc @NotNull ... docs)
     
    static @NotNull Doc
    vcommaList(@NotNull kala.collection.SeqLike<Doc> docs)
     
    static @NotNull Doc
    wrap(String leftSymbol, String rightSymbol, Doc doc)
     

  • Field Details

    • ONE_WS

      @NotNull static final @NotNull Doc ONE_WS

    • ALT_WS

      @NotNull static final @NotNull Doc ALT_WS

    • COMMA

      @NotNull static final @NotNull Doc COMMA

  • Method Details

    • isNotEmpty

      default boolean isNotEmpty()

    • isEmpty

      default boolean isEmpty()

    • toDoc

      @NotNull default @NotNull Doc toDoc()
      Specified by:
      toDoc in interface Docile

    • asSeq

      @NotNull default @NotNull kala.collection.SeqLike<Doc> asSeq()

    • renderToString

      @NotNull default @NotNull String renderToString(@NotNull @NotNull StringPrinterConfig config)

    • renderToHtml

      @NotNull default @NotNull String renderToHtml()

    • renderToHtml

      @NotNull default @NotNull String renderToHtml(boolean withHeader)

    • renderToTeX

      @NotNull default @NotNull String renderToTeX()

    • render

      @NotNull default <Out, Config extends PrinterConfig> Out render(@NotNull @NotNull Printer<Out,Config> printer, @NotNull Config config)

    • renderWithPageWidth

      @NotNull default @NotNull String renderWithPageWidth(int pageWidth, boolean unicode)

    • debugRender

      @NotNull default @NotNull String debugRender()
      Produce ASCII and infinite-width output

    • commonRender

      @NotNull default @NotNull String commonRender()
      Produce unicode and 80-width output

    • linkDef

      @NotNull static @NotNull Doc linkDef(@NotNull @NotNull Doc doc, int hashCode)

    • linkRef

      @NotNull static @NotNull Doc linkRef(@NotNull @NotNull Doc doc, int hashCode)

    • hyperLink

      @NotNull static @NotNull Doc hyperLink(@NotNull @NotNull Doc doc, @NotNull @NotNull LinkId link)

    • hyperLink

      @NotNull static @NotNull Doc hyperLink(@NotNull @NotNull String plain, @NotNull @NotNull LinkId link)

    • styled

      @NotNull static @NotNull Doc styled(@NotNull @NotNull Style style, @NotNull @NotNull Doc doc)

    • styled

      @NotNull static @NotNull Doc styled(@NotNull @NotNull Style style, @NotNull @NotNull String plain)

    • styled

      @NotNull static @NotNull Doc styled(@NotNull @NotNull Styles builder, @NotNull @NotNull Doc doc)

    • styled

      @NotNull static @NotNull Doc styled(@NotNull @NotNull Styles builder, @NotNull @NotNull String plain)

    • licit

      @NotNull static @NotNull Doc licit(boolean explicit, Doc doc)

    • spaced

      @NotNull static @NotNull Doc spaced(Doc symbol)

    • wrap

      @NotNull static @NotNull Doc wrap(String leftSymbol, String rightSymbol, Doc doc)

    • bracedUnless

      @NotNull static @NotNull Doc bracedUnless(Doc doc, boolean falsification)
      Parameters:
      falsification - when false, add braces

    • braced

      @NotNull static @NotNull Doc braced(Doc doc)

    • flatAltBracedBlock

      @NotNull static @NotNull Doc flatAltBracedBlock(Doc defaultDoc, Doc flatDoc)
      Either `{ defaultDoc }` or `{\nflatDoc\n}`

    • angled

      @NotNull static @NotNull Doc angled(Doc doc)

    • parened

      @NotNull static @NotNull Doc parened(Doc doc)

    • emptyIf

      @NotNull static @NotNull Doc emptyIf(boolean cond, Supplier<@NotNull Doc> otherwise)
      Return conditional empty()
      Parameters:
      cond - condition
      otherwise - otherwise
      Returns:
      Doc.Empty when cond is true, otherwise otherwise

    • empty

      @NotNull static @NotNull Doc empty()
      The empty document; conceptually the unit of 'Cat'
      Returns:
      empty document

    • flatAlt

      @Contract("_, _ -> new") @NotNull static @NotNull Doc flatAlt(@NotNull @NotNull Doc defaultDoc, @NotNull @NotNull Doc preferWhenFlattened)
      By default, flatAlt renders as . However, when 'group'-ed, will be preferred, with as the fallback for the case when doesn't fit.
      Parameters:
      defaultDoc - default document
      preferWhenFlattened - document selected when flattened
      Returns:
      alternative document

    • column

      @Contract("_ -> new") @NotNull static @NotNull Doc column(@NotNull @NotNull IntFunction<Doc> docBuilder)
      Layout a document depending on which column it starts at. align(Doc) is implemented in terms of column.
      Parameters:
      docBuilder - document generator when current position provided
      Returns:
      column action document

    • nesting

      @Contract("_ -> new") @NotNull static @NotNull Doc nesting(@NotNull @NotNull IntFunction<Doc> docBuilder)
      Layout a document depending on the current 'nest'-ing level. align(Doc) is implemented in terms of nesting.
      Parameters:
      docBuilder - document generator when current nest level provided
      Returns:
      nest level action document

    • pageWidth

      @Contract("_ -> new") @NotNull static @NotNull Doc pageWidth(@NotNull @NotNull IntFunction<Doc> docBuilder)
      Layout a document depending on the page width, if one has been specified.
      Parameters:
      docBuilder - document generator when page width provided
      Returns:
      page width action document

    • nest

      @Contract("_, _ -> new") @NotNull static @NotNull Doc nest(int indent, @NotNull @NotNull Doc doc)
      lays out the document with the current nesting level (indentation of the following lines) increased by . Negative values are allowed, and decrease the nesting level accordingly.
      Parameters:
      indent - indentation of the following lines
      doc - the document to lay out
      Returns:
      indented document

    • align

      @Contract("_ -> new") @NotNull static @NotNull Doc align(@NotNull @NotNull Doc doc)
      align lays out the document with the nesting level set to the current column. It is used for example to implement hang(int, Doc).

      As an example, we will put a document right above another one, regardless of the current nesting level. Without 'align'-ment, the second line is put simply below everything we've had so far,

      If we add an 'align' to the mix, the @'vsep'@'s contents all start in the same column,

      Parameters:
      doc - document to be aligned
      Returns:
      aligned document

    • hang

      @Contract("_, _ -> new") @NotNull static @NotNull Doc hang(int deltaNest, @NotNull @NotNull Doc doc)
      hang lays out the document with a nesting level set to the /current column/ plus . Negative values are allowed, and decrease the nesting level accordingly.

      This differs from nest(int, Doc), which is based on the /current nesting level/ plus indent. When you're not sure, try the more efficient 'nest' first. In our example, this would yield

      Parameters:
      deltaNest - change of nesting level, relative to the start of the first line
      doc - document to indent
      Returns:
      hang-ed document

    • par

      @Contract("_, _ -> new") @NotNull static @NotNull Doc par(int indent, @NotNull @NotNull Doc doc)
      Indents by columns, and then indent the first line again by columns.
      Parameters:
      indent - the indented nesting level
      doc - document to indent
      Returns:
      indented document

    • cblock

      @Contract("_, _, _ -> new") @NotNull static @NotNull Doc cblock(@NotNull @NotNull Doc prefix, int indent, @NotNull @NotNull Doc block)
      Creates a C-style indented block of statements. 
         prefix {
   [indent]block
   }

    • ordinal

      @Contract("_ -> new") @NotNull static @NotNull Doc ordinal(int n)

    • plain

      @Contract("_ -> new") @NotNull static @NotNull Doc plain(String text)
      Plain text document
      Parameters:
      text - text that may not contain '\n'
      Returns:
      text document of the whole text

    • english

      @Contract("_ -> new") @NotNull static @NotNull Doc english(String text)

    • symbol

      @Contract("_ -> new") @NotNull static @NotNull Doc symbol(String text)
      Parameters:
      text - '\n' not allowed!
      Returns:
      special symbol

    • cat

      @Contract("_ -> new") @NotNull static @NotNull Doc cat(@NotNull @NotNull kala.collection.SeqLike<Doc> docs)
      cat tries laying out the documents separated with nothing, and if this does not fit the page, separates them with newlines. This is what differentiates it from 'vcat', which always lays out its contents beneath each other.
      Parameters:
      docs - documents to concat
      Returns:
      cat document

    • cat

      @Contract("_ -> new") @NotNull static @NotNull Doc cat(Doc @NotNull ... docs)
      See Also:

    • vcat

      @Contract("_ -> new") @NotNull static @NotNull Doc vcat(Doc @NotNull ... docs)

    • vcat

      @Contract("_ -> new") @NotNull static @NotNull Doc vcat(@NotNull @NotNull kala.collection.SeqLike<@NotNull Doc> docs)

    • vcatNonEmpty

      @Contract("_ -> new") @NotNull static @NotNull Doc vcatNonEmpty(Doc @NotNull ... docs)

    • vcatNonEmpty

      @Contract("_ -> new") @NotNull static @NotNull Doc vcatNonEmpty(@NotNull @NotNull kala.collection.SeqLike<Doc> docs)

    • stickySep

      @Contract("_ -> new") @NotNull static @NotNull Doc stickySep(@NotNull @NotNull kala.collection.SeqLike<@NotNull Doc> docs)
      stickySep concatenates all documents horizontally with a space, i.e. it puts a space between all entries.

      stickySep does not introduce line breaks on its own, even when the page is too narrow:

      Parameters:
      docs - documents to separate
      Returns:
      separated documents

    • stickySep

      @Contract("_ -> new") @NotNull static @NotNull Doc stickySep(Doc @NotNull ... docs)

    • sep

      @Contract("_ -> new") @NotNull static @NotNull Doc sep(Doc @NotNull ... docs)
      fillSep concatenates the documents horizontally with a space as long as it fits the page, then inserts a 'line' and continues doing that for all documents in . 'line' means that if 'group'-ed, the documents are separated with a 'space' instead of newlines. Use cat(kala.collection.SeqLike<org.aya.pretty.doc.Doc>) if you do not want a 'space'.

      Let's print some words to fill the line:

      Parameters:
      docs - documents to separate
      Returns:
      separated documents

    • sep

      @Contract("_ -> new") @NotNull static @NotNull Doc sep(@NotNull @NotNull kala.collection.SeqLike<Doc> docs)

    • sepNonEmpty

      @Contract("_ -> new") @NotNull static @NotNull Doc sepNonEmpty(Doc @NotNull ... docs)

    • sepNonEmpty

      @Contract("_ -> new") @NotNull static @NotNull Doc sepNonEmpty(@NotNull @NotNull kala.collection.SeqLike<Doc> docs)

    • commaList

      @Contract("_ -> new") @NotNull static @NotNull Doc commaList(@NotNull @NotNull kala.collection.SeqLike<Doc> docs)

    • vcommaList

      @Contract("_ -> new") @NotNull static @NotNull Doc vcommaList(@NotNull @NotNull kala.collection.SeqLike<Doc> docs)

    • join

      @Contract("_, _ -> new") @NotNull static @NotNull Doc join(@NotNull @NotNull Doc delim, Doc @NotNull ... docs)

    • join

      @Contract("_, _ -> new") @NotNull static @NotNull Doc join(@NotNull @NotNull Doc delim, @NotNull @NotNull kala.collection.SeqLike<@NotNull Doc> docs)

    • line

      @Contract("-> new") @NotNull static @NotNull Doc line()
      Unconditionally line break
      Returns:
      hard line document