org.pkl.thirdparty.commonmark.renderer.text.TextContentRenderer Maven / Gradle / Ivy
Show all versions of pkl-tools Show documentation
package org.pkl.thirdparty.commonmark.renderer.text;
import org.pkl.thirdparty.commonmark.Extension;
import org.pkl.thirdparty.commonmark.internal.renderer.NodeRendererMap;
import org.pkl.thirdparty.commonmark.node.Node;
import org.pkl.thirdparty.commonmark.renderer.NodeRenderer;
import org.pkl.thirdparty.commonmark.renderer.Renderer;
import java.util.ArrayList;
import java.util.List;
/**
* Renders nodes to plain text content with minimal markup-like additions.
*/
public class TextContentRenderer implements Renderer {
private final LineBreakRendering lineBreakRendering;
private final List nodeRendererFactories;
private TextContentRenderer(Builder builder) {
this.lineBreakRendering = builder.lineBreakRendering;
this.nodeRendererFactories = new ArrayList<>(builder.nodeRendererFactories.size() + 1);
this.nodeRendererFactories.addAll(builder.nodeRendererFactories);
// Add as last. This means clients can override the rendering of core nodes if they want.
this.nodeRendererFactories.add(new TextContentNodeRendererFactory() {
@Override
public NodeRenderer create(TextContentNodeRendererContext context) {
return new CoreTextContentNodeRenderer(context);
}
});
}
/**
* Create a new builder for configuring a {@link TextContentRenderer}.
*
* @return a builder
*/
public static Builder builder() {
return new Builder();
}
@Override
public void render(Node node, Appendable output) {
RendererContext context = new RendererContext(new TextContentWriter(output, lineBreakRendering));
context.render(node);
}
@Override
public String render(Node node) {
StringBuilder sb = new StringBuilder();
render(node, sb);
return sb.toString();
}
/**
* Builder for configuring a {@link TextContentRenderer}. See methods for default configuration.
*/
public static class Builder {
private List nodeRendererFactories = new ArrayList<>();
private LineBreakRendering lineBreakRendering = LineBreakRendering.COMPACT;
/**
* @return the configured {@link TextContentRenderer}
*/
public TextContentRenderer build() {
return new TextContentRenderer(this);
}
/**
* Configure how line breaks (newlines) are rendered, see {@link LineBreakRendering}.
* The default is {@link LineBreakRendering#COMPACT}.
*
* @param lineBreakRendering the mode to use
* @return {@code this}
*/
public Builder lineBreakRendering(LineBreakRendering lineBreakRendering) {
this.lineBreakRendering = lineBreakRendering;
return this;
}
/**
* Set the value of flag for stripping new lines.
*
* @param stripNewlines true for stripping new lines and render text as "single line",
* false for keeping all line breaks
* @return {@code this}
* @deprecated Use {@link #lineBreakRendering(LineBreakRendering)} with {@link LineBreakRendering#STRIP} instead
*/
@Deprecated
public Builder stripNewlines(boolean stripNewlines) {
this.lineBreakRendering = stripNewlines ? LineBreakRendering.STRIP : LineBreakRendering.COMPACT;
return this;
}
/**
* Add a factory for instantiating a node renderer (done when rendering). This allows to override the rendering
* of node types or define rendering for custom node types.
*
* If multiple node renderers for the same node type are created, the one from the factory that was added first
* "wins". (This is how the rendering for core node types can be overridden; the default rendering comes last.)
*
* @param nodeRendererFactory the factory for creating a node renderer
* @return {@code this}
*/
public Builder nodeRendererFactory(TextContentNodeRendererFactory nodeRendererFactory) {
this.nodeRendererFactories.add(nodeRendererFactory);
return this;
}
/**
* @param extensions extensions to use on this text content renderer
* @return {@code this}
*/
public Builder extensions(Iterable extensions) {
for (Extension extension : extensions) {
if (extension instanceof TextContentRenderer.TextContentRendererExtension) {
TextContentRenderer.TextContentRendererExtension textContentRendererExtension =
(TextContentRenderer.TextContentRendererExtension) extension;
textContentRendererExtension.extend(this);
}
}
return this;
}
}
/**
* Extension for {@link TextContentRenderer}.
*/
public interface TextContentRendererExtension extends Extension {
void extend(TextContentRenderer.Builder rendererBuilder);
}
private class RendererContext implements TextContentNodeRendererContext {
private final TextContentWriter textContentWriter;
private final NodeRendererMap nodeRendererMap = new NodeRendererMap();
private RendererContext(TextContentWriter textContentWriter) {
this.textContentWriter = textContentWriter;
for (var factory : nodeRendererFactories) {
var renderer = factory.create(this);
nodeRendererMap.add(renderer);
}
}
@Override
public LineBreakRendering lineBreakRendering() {
return lineBreakRendering;
}
@Override
public boolean stripNewlines() {
return lineBreakRendering == LineBreakRendering.STRIP;
}
@Override
public TextContentWriter getWriter() {
return textContentWriter;
}
@Override
public void render(Node node) {
nodeRendererMap.render(node);
}
}
}