com.vladsch.flexmark.ext.wikilink.WikiLinkExtension Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of flexmark-ext-wikilink Show documentation
flexmark-java extension parsing and rendering wiki links
There is a newer version: 0.64.8
Show newest version
package com.vladsch.flexmark.ext.wikilink;

import com.vladsch.flexmark.ext.wikilink.internal.*;
import com.vladsch.flexmark.formatter.Formatter;
import com.vladsch.flexmark.html.HtmlRenderer;
import com.vladsch.flexmark.html.renderer.LinkType;
import com.vladsch.flexmark.parser.Parser;
import com.vladsch.flexmark.util.data.DataKey;
import com.vladsch.flexmark.util.data.MutableDataHolder;
import org.jetbrains.annotations.NotNull;

/**
 * Extension for wikilinks
 * 
 * Create it with {@link #create()} and then configure it on the builders
 * 

 * The parsed emoji shortcuts text regions are turned into {@link WikiLink} nodes.
 */
public class WikiLinkExtension implements Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension, Formatter.FormatterExtension {
    final public static DataKey ALLOW_INLINES = new DataKey<>("ALLOW_INLINES", false);
    final public static DataKey ALLOW_ANCHORS = new DataKey<>("ALLOW_ANCHORS", false);
    final public static DataKey ALLOW_ANCHOR_ESCAPE = new DataKey<>("ALLOW_ANCHOR_ESCAPE", false);
    final public static DataKey ALLOW_PIPE_ESCAPE = new DataKey<>("ALLOW_PIPE_ESCAPE", false);
    final public static DataKey DISABLE_RENDERING = new DataKey<>("DISABLE_RENDERING", false);
    final public static DataKey LINK_FIRST_SYNTAX = new DataKey<>("LINK_FIRST_SYNTAX", false);
    final public static DataKey LINK_PREFIX = new DataKey<>("LINK_PREFIX", "");

    /**
     * Link prefix to use for absolute wiki links starting with the '/' character.
     * 

     * 

     * Will get its value from option {@link #LINK_PREFIX} until its own value is set.
     * 
     */
    final public static DataKey LINK_PREFIX_ABSOLUTE = new DataKey<>("LINK_PREFIX_ABSOLUTE", LINK_PREFIX);

    final public static DataKey IMAGE_PREFIX = new DataKey<>("IMAGE_PREFIX", "");

    /**
     * Image prefix to use for absolute wiki image sources starting with the '/' character.
     * 
     * 

     * Will get its value from option {@link #IMAGE_PREFIX} until its own value is set.
     * 
     */
    final public static DataKey IMAGE_PREFIX_ABSOLUTE = new DataKey<>("IMAGE_PREFIX_ABSOLUTE", IMAGE_PREFIX);

    final public static DataKey IMAGE_LINKS = new DataKey<>("IMAGE_LINKS", false);
    final public static DataKey LINK_FILE_EXTENSION = new DataKey<>("LINK_FILE_EXTENSION", "");
    final public static DataKey IMAGE_FILE_EXTENSION = new DataKey<>("IMAGE_FILE_EXTENSION", "");

    /**
     * Characters to escape in wiki links.
     * 
     * 

     * Each character in the configuration string is replaced with a character
     * at the corresponding index in the string given by the configuration
     * option {@link #LINK_REPLACE_CHARS}.
     * 
     */
    final public static DataKey LINK_ESCAPE_CHARS = new DataKey<>("LINK_ESCAPE_CHARS", " +/<>");

    /**
     * Characters to replace {@link #LINK_ESCAPE_CHARS} with.
     *
     * @see #LINK_ESCAPE_CHARS
     */
    final public static DataKey LINK_REPLACE_CHARS = new DataKey<>("LINK_REPLACE_CHARS", "-----");

    final public static LinkType WIKI_LINK = new LinkType("WIKI");

    private WikiLinkExtension() {
    }

    public static WikiLinkExtension create() {
        return new WikiLinkExtension();
    }

    @Override
    public void rendererOptions(@NotNull MutableDataHolder options) {

    }

    @Override
    public void parserOptions(MutableDataHolder options) {

    }

    @Override
    public void extend(Formatter.Builder formatterBuilder) {
        formatterBuilder.nodeFormatterFactory(new WikiLinkNodeFormatter.Factory());
//        formatterBuilder.linkResolverFactory(new WikiLinkLinkResolver.Factory());
    }

    @Override
    public void extend(Parser.Builder parserBuilder) {
        parserBuilder.linkRefProcessorFactory(new WikiLinkLinkRefProcessor.Factory());
    }

    @Override
    public void extend(@NotNull HtmlRenderer.Builder htmlRendererBuilder, @NotNull String rendererType) {
        if (htmlRendererBuilder.isRendererType("HTML")) {
            htmlRendererBuilder.nodeRendererFactory(new WikiLinkNodeRenderer.Factory());
            htmlRendererBuilder.linkResolverFactory(new WikiLinkLinkResolver.Factory());
        } else if (htmlRendererBuilder.isRendererType("JIRA")) {
            htmlRendererBuilder.nodeRendererFactory(new WikiLinkJiraRenderer.Factory());
            htmlRendererBuilder.linkResolverFactory(new WikiLinkLinkResolver.Factory());
        }
    }
}