Module aya.pretty

Package org.aya.pretty.backend.md

Class DocMdPrinter

java.lang.Object

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

org.aya.pretty.backend.html.DocHtmlPrinter<DocMdPrinter.Config>

org.aya.pretty.backend.md.DocMdPrinter

All Implemented Interfaces:

Printer<String,DocMdPrinter.Config>

public class DocMdPrinter
extends DocHtmlPrinter<DocMdPrinter.Config>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DocMdPrinter.Config

Nested classes/interfaces inherited from class org.aya.pretty.backend.string.StringPrinter

StringPrinter.Outer

Field Summary

Fields

Modifier and Type	Field	Description
static final Pattern	MD_ESCAPE
static final Pattern	MD_ESCAPE_FAKE_LIST	`Doc.plain("1.

Fields inherited from class org.aya.pretty.backend.html.DocHtmlPrinter

entityMapping, entityPattern

Fields inherited from class org.aya.pretty.backend.string.StringPrinter

config, FREE

Constructor Summary

Constructors

Constructor	Description
DocMdPrinter()

Method Summary

Modifier and Type	Method	Description
protected @NotNull String	escapePlainText(@NotNull String content, EnumSet<StringPrinter.Outer> outer)
protected void	renderCodeBlock(@NotNull Cursor cursor, Doc.CodeBlock block, 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, @NotNull 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, @NotNull Doc.MathBlock block, EnumSet<StringPrinter.Outer> outer)

Methods inherited from class org.aya.pretty.backend.html.DocHtmlPrinter

normalizeHref, normalizeId, prepareStylist, renderCssStyle, renderTooltip

Methods inherited from class org.aya.pretty.backend.string.StringPrinter

fitsBetter, formatBlock, formatBlock, formatInline, formatList, formatList, makeIndent, predictWidth, render, renderBlockSeparator, renderDoc, renderFlatAlt, renderNest, renderPlainText, renderSpecialSymbol, renderStyled, renderUnionDoc, separateBlockIfNeeded

Methods inherited from class java.lang.Object

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

Field Details

MD_ESCAPE

public static final Pattern MD_ESCAPE

MD_ESCAPE_FAKE_LIST

public static final Pattern MD_ESCAPE_FAKE_LIST

`Doc.plain("1. hello")` should not be rendered as a list, see MdStyleTest

Constructor Details

DocMdPrinter

public DocMdPrinter()

Method Details

renderHeader

protected void renderHeader(@NotNull
 @NotNull Cursor cursor)

Overrides:

renderHeader in class DocHtmlPrinter<DocMdPrinter.Config>

renderFooter

protected void renderFooter(@NotNull
 @NotNull Cursor cursor)

Overrides:

renderFooter in class DocHtmlPrinter<DocMdPrinter.Config>

escapePlainText

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

Overrides:

escapePlainText in class DocHtmlPrinter<DocMdPrinter.Config>

renderHardLineBreak

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

Description copied from class: StringPrinter

This line break is printed in the resulting document (like .pdf generated from .tex or .md). The default implementation is same as StringPrinter.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).

Overrides:

renderHardLineBreak in class DocHtmlPrinter<DocMdPrinter.Config>

renderHyperLinked

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

Overrides:

renderHyperLinked in class DocHtmlPrinter<DocMdPrinter.Config>

renderImage

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

Overrides:

renderImage in class DocHtmlPrinter<DocMdPrinter.Config>

renderList

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

Overrides:

renderList in class DocHtmlPrinter<DocMdPrinter.Config>

renderInlineMath

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

Overrides:

renderInlineMath in class DocHtmlPrinter<DocMdPrinter.Config>

renderMathBlock

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

Overrides:

renderMathBlock in class DocHtmlPrinter<DocMdPrinter.Config>

Implementation Note:

We don't call StringPrinter.separateBlockIfNeeded(org.aya.pretty.backend.string.Cursor, java.util.EnumSet<org.aya.pretty.backend.string.StringPrinter.Outer>), as Markdown spec says: any block is surrounded with Paragraphs, which is handled in MdStylist.formatCustom(org.aya.pretty.doc.Style.CustomStyle) by inserting a blank line to generated source code (just like StringPrinter.separateBlockIfNeeded(org.aya.pretty.backend.string.Cursor, java.util.EnumSet<org.aya.pretty.backend.string.StringPrinter.Outer>)).

renderInlineCode

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

Overrides:

renderInlineCode in class DocHtmlPrinter<DocMdPrinter.Config>

renderCodeBlock

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

Overrides:

renderCodeBlock in class DocHtmlPrinter<DocMdPrinter.Config>

Implementation Note:

We don't call StringPrinter.separateBlockIfNeeded(org.aya.pretty.backend.string.Cursor, java.util.EnumSet<org.aya.pretty.backend.string.StringPrinter.Outer>), as Markdown spec says: any block is surrounded with Paragraphs, which is handled in MdStylist.formatCustom(org.aya.pretty.doc.Style.CustomStyle) by inserting a blank line to generated source code (just like StringPrinter.separateBlockIfNeeded(org.aya.pretty.backend.string.Cursor, java.util.EnumSet<org.aya.pretty.backend.string.StringPrinter.Outer>)).