org.pkl.thirdparty.commonmark.parser.beta.LinkResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pkl-tools Show documentation

Fat Jar containing pkl-cli, pkl-codegen-java, pkl-codegen-kotlin, pkl-config-java, pkl-core, pkl-doc, and their shaded third-party dependencies.

There is a newer version: 0.27.1

Show newest version

package org.pkl.thirdparty.commonmark.parser.beta;

import org.pkl.thirdparty.commonmark.internal.inline.LinkResultImpl;
import org.pkl.thirdparty.commonmark.node.Node;

/**
 * What to do with a link/image processed by {@link LinkProcessor}.
 */
public interface LinkResult {
    /**
     * Link not handled by processor.
     */
    static LinkResult none() {
        return null;
    }

    /**
     * Wrap the link text in a node. This is the normal behavior for links, e.g. for this:
     * 
     * [my *text*](destination)
     * 
     * The text is {@code my *text*}, a text node and emphasis. The text is wrapped in a
     * {@link org.pkl.thirdparty.commonmark.node.Link} node, which means the text is added as child nodes to it.
     *
     * @param node     the node to which the link text nodes will be added as child nodes
     * @param position the position to continue parsing from
     */
    static LinkResult wrapTextIn(Node node, Position position) {
        return new LinkResultImpl(LinkResultImpl.Type.WRAP, node, position);
    }

    /**
     * Replace the link with a node. E.g. for this:
     * 
     * [^foo]
     * 
     * The processor could decide to create a {@code FootnoteReference} node instead which replaces the link.
     *
     * @param node     the node to replace the link with
     * @param position the position to continue parsing from
     */
    static LinkResult replaceWith(Node node, Position position) {
        return new LinkResultImpl(LinkResultImpl.Type.REPLACE, node, position);
    }

    /**
     * If a {@link LinkInfo#marker()} is present, include it in processing (i.e. treat it the same way as the brackets).
     */
    LinkResult includeMarker();
}