在 Clojure 中创建 flexmark 扩展
Creating a flexmark extension in Clojure
我正在尝试为 flexmark 编写一个小扩展。我想创建一个
custom AttributeProvider
并且正在尝试完成示例
显示 here.
我的问题是将两个 classes 翻译成 Clojure。
我已将两个相关示例 classes 分离到单独的 Java 源文件中,并将演示程序翻译成 clojure 测试。
Java中的SampleAttributeProvider
:
package cwiki.util;
import com.vladsch.flexmark.ast.Link;
import com.vladsch.flexmark.ast.Node;
import com.vladsch.flexmark.html.AttributeProvider;
import com.vladsch.flexmark.html.AttributeProviderFactory;
import com.vladsch.flexmark.html.IndependentAttributeProviderFactory;
import com.vladsch.flexmark.html.renderer.AttributablePart;
import com.vladsch.flexmark.html.renderer.LinkResolverContext;
import com.vladsch.flexmark.util.html.Attributes;
class SampleAttributeProvider implements AttributeProvider {
@Override
public void setAttributes(final Node node, final AttributablePart part, final Attributes attributes) {
if (node instanceof Link && part == AttributablePart.LINK) {
Link link = (Link) node;
if (link.getText().equals("...")) {
attributes.replaceValue("target", "_top");
}
}
}
static AttributeProviderFactory Factory() {
return new IndependentAttributeProviderFactory() {
@Override
public AttributeProvider create(LinkResolverContext context) {
//noinspection ReturnOfInnerClass
return new SampleAttributeProvider();
}
};
}
}
Java中的SampleExtension
。
package cwiki.util;
import com.vladsch.flexmark.html.HtmlRenderer;
import com.vladsch.flexmark.util.options.MutableDataHolder;
public class SampleExtension implements HtmlRenderer.HtmlRendererExtension {
@Override
public void rendererOptions(final MutableDataHolder options) {
// add any configuration settings to options you want to apply to everything, here
}
@Override
public void extend(final HtmlRenderer.Builder rendererBuilder, final String rendererType) {
rendererBuilder.attributeProviderFactory(cwiki.util.SampleAttributeProvider.Factory());
}
public static SampleExtension create() {
return new SampleExtension();
}
}
翻译示例中的演示程序很简单。 Clojure 中的测试文件:
(ns cwiki.test.util.CWikiAttributeProviderTest
(:require [clojure.test :refer :all])
(:import (com.vladsch.flexmark.util.options MutableDataSet)
(com.vladsch.flexmark.parser Parser Parser$Builder)
(com.vladsch.flexmark.html HtmlRenderer HtmlRenderer$Builder)
(cwiki.util SampleExtension)
(java.util ArrayList)))
(defn commonmark
[markdown]
(let [options (-> (MutableDataSet.)
(.set Parser/EXTENSIONS
(ArrayList. [(SampleExtension/create)]))
(.set HtmlRenderer/SOFT_BREAK "<br/>"))
parser (.build ^Parser$Builder (Parser/builder options))
document (.parse ^Parser parser ^String markdown)
renderer (.build ^HtmlRenderer$Builder (HtmlRenderer/builder options))]
(.render renderer document)))
(deftest cwiki-attribute-provider-test
(testing "The ability of the CWikiAttributeProvider to place the correct attributes in wikilinks."
(let [test-output (commonmark "[...](http://github.com/vsch/flexmark-java)")]
(is (= test-output
"<p><a href=\"http://github.com/vsch/flexmark-java\" target=\"_top\">...</a></p>\n")))))
使用上面的两个 Java class 测试 运行 并通过。
我已经能够将 SampleAttributeProvider
翻译成 Clojure。它编译并生成 class 个文件。我实际上无法 运行 并对其进行测试,因为...
我在翻译示例中的扩展 class 时遇到问题。到目前为止,这是我想出的。 (Class 名称已更改以避免冲突。):
(ns cwiki.util.CWikiAttributeProviderExtension
(:gen-class
:implements [com.vladsch.flexmark.html.HtmlRenderer$HtmlRendererExtension]
:methods [^:static [create [] cwiki.util.CWikiAttributeProviderExtension]])
(:import (com.vladsch.flexmark.html HtmlRenderer$Builder)
(com.vladsch.flexmark.util.options MutableDataHolder)
(cwiki.util CWikiAttributeProvider CWikiAttributeProviderExtension)))
(defn -rendererOptions
[this ^MutableDataHolder options]
; Add any configuration option that you want to apply to everything here.
)
(defn -extend
[this ^HtmlRenderer$Builder rendererBuilder ^String rendererType]
(.attributeProviderFactory rendererBuilder (CWikiAttributeProvider.)))
(defn ^CWikiAttributeProviderExtension -create [this]
(CWikiAttributeProviderExtension.))
正在尝试用
$ lein compile CWikiAttributeProviderExtension
,它会生成以以下内容开头的错误消息:
Compiling cwiki.util.CWikiAttributeProviderExtension
java.lang.ClassNotFoundException: cwiki.util.CWikiAttributeProviderExtension, compiling:(cwiki/util/CWikiAttributeProviderExtension.clj:1:1)
Exception in thread "main" java.lang.ClassNotFoundException: cwiki.util.CWikiAttributeProviderExtension, compiling:(cwiki/util/CWikiAttributeProviderExtension.clj:1:1)
at clojure.lang.Compiler.analyzeSeq(Compiler.java:7010)
at clojure.lang.Compiler.analyze(Compiler.java:6773)
at clojure.lang.Compiler.analyze(Compiler.java:6729)
at clojure.lang.Compiler$BodyExpr$Parser.parse(Compiler.java:6100)
at clojure.lang.Compiler$TryExpr$Parser.parse(Compiler.java:2307)
at clojure.lang.Compiler.analyzeSeq(Compiler.java:7003)
...
IDE(IntelliJ 上的 Cursive)显示一条警告消息,提示无法解析 :gen-class
部分中的 create
方法,但我看不出任何错误与声明或实施。这个翻译类似于我之前在其他程序中使用的构建 Java class 的方法,它向扩展 Java 接口的对象添加方法。它类似于我在示例中用来创建其他相关 class 的内容。但显然有些地方不对。
尝试只使用翻译后的 CWikiAttributeProvider
而不翻译扩展名 class 会导致工具链混淆首先编译 Clojure 中的对象,然后是 Java 部分,然后Clojure 程序的其余部分。所以看来我必须同时翻译两个 classes 或根本不翻译。
为了完整起见,这里是 Clojure 中翻译的属性提供程序 class。
(ns cwiki.util.CWikiAttributeProvider
(:gen-class
:implements [com.vladsch.flexmark.html.AttributeProvider]
:methods [^:static [Factory [] com.vladsch.flexmark.html.AttributeProviderFactory]])
(:import (com.vladsch.flexmark.ast Node Link)
(com.vladsch.flexmark.html AttributeProviderFactory
IndependentAttributeProviderFactory)
(com.vladsch.flexmark.html.renderer AttributablePart
LinkResolverContext)
(com.vladsch.flexmark.util.html Attributes)
(cwiki.util CWikiAttributeProvider)))
(defn -setAttributes
[this ^Node node ^AttributablePart part ^Attributes attributes]
(when (and (= (type node) Link) (= part AttributablePart/LINK))
(let [title (.getText ^Link node)]
(println "node: " node)
(println "title: " title)
(when (= title "...")
(.replaceValue attributes "target" "_top")))))
(defn ^AttributeProviderFactory -Factory [this]
(proxy [IndependentAttributeProviderFactory] []
(create [^LinkResolverContext context]
;; noinspection ReturnOfInnerClass
(CWikiAttributeProvider.))))
您需要将 CWikiAttributeProvider
作为 gen-class
中的 return 值进行前向声明。 在文件顶部:1) 仅包含构造函数,以及 2) 包含(静态)方法和状态的完整声明。
(gen-class
:name cwiki.util.CWikiAttributeProviderExtension
:implements [com.vladsch.flexmark.html.HtmlRenderer$HtmlRendererExtension])
(gen-class
:name cwiki.util.CWikiAttributeProviderExtension
:implements [com.vladsch.flexmark.html.HtmlRenderer$HtmlRendererExtension]
:methods (^:static [create [] cwiki.util.CWikiAttributeProviderExtension]))
我能够使用这些 gen-class
语句并进行以下修改来编译您的示例:
- 从导入语句中删除 class 本身,
- 在方法实现和类型提示中通过其完全限定名称 (
cwiki.util.CWikiAttributeProvider
) 引用 class,并且
- 从静态方法中删除
this
引用(以匹配该方法的 gen-class 声明)。
另请注意,在项目中使用它时需要提前编译 class (AOT)。
我正在尝试为 flexmark 编写一个小扩展。我想创建一个
custom AttributeProvider
并且正在尝试完成示例
显示 here.
我的问题是将两个 classes 翻译成 Clojure。
我已将两个相关示例 classes 分离到单独的 Java 源文件中,并将演示程序翻译成 clojure 测试。
Java中的SampleAttributeProvider
:
package cwiki.util;
import com.vladsch.flexmark.ast.Link;
import com.vladsch.flexmark.ast.Node;
import com.vladsch.flexmark.html.AttributeProvider;
import com.vladsch.flexmark.html.AttributeProviderFactory;
import com.vladsch.flexmark.html.IndependentAttributeProviderFactory;
import com.vladsch.flexmark.html.renderer.AttributablePart;
import com.vladsch.flexmark.html.renderer.LinkResolverContext;
import com.vladsch.flexmark.util.html.Attributes;
class SampleAttributeProvider implements AttributeProvider {
@Override
public void setAttributes(final Node node, final AttributablePart part, final Attributes attributes) {
if (node instanceof Link && part == AttributablePart.LINK) {
Link link = (Link) node;
if (link.getText().equals("...")) {
attributes.replaceValue("target", "_top");
}
}
}
static AttributeProviderFactory Factory() {
return new IndependentAttributeProviderFactory() {
@Override
public AttributeProvider create(LinkResolverContext context) {
//noinspection ReturnOfInnerClass
return new SampleAttributeProvider();
}
};
}
}
Java中的SampleExtension
。
package cwiki.util;
import com.vladsch.flexmark.html.HtmlRenderer;
import com.vladsch.flexmark.util.options.MutableDataHolder;
public class SampleExtension implements HtmlRenderer.HtmlRendererExtension {
@Override
public void rendererOptions(final MutableDataHolder options) {
// add any configuration settings to options you want to apply to everything, here
}
@Override
public void extend(final HtmlRenderer.Builder rendererBuilder, final String rendererType) {
rendererBuilder.attributeProviderFactory(cwiki.util.SampleAttributeProvider.Factory());
}
public static SampleExtension create() {
return new SampleExtension();
}
}
翻译示例中的演示程序很简单。 Clojure 中的测试文件:
(ns cwiki.test.util.CWikiAttributeProviderTest
(:require [clojure.test :refer :all])
(:import (com.vladsch.flexmark.util.options MutableDataSet)
(com.vladsch.flexmark.parser Parser Parser$Builder)
(com.vladsch.flexmark.html HtmlRenderer HtmlRenderer$Builder)
(cwiki.util SampleExtension)
(java.util ArrayList)))
(defn commonmark
[markdown]
(let [options (-> (MutableDataSet.)
(.set Parser/EXTENSIONS
(ArrayList. [(SampleExtension/create)]))
(.set HtmlRenderer/SOFT_BREAK "<br/>"))
parser (.build ^Parser$Builder (Parser/builder options))
document (.parse ^Parser parser ^String markdown)
renderer (.build ^HtmlRenderer$Builder (HtmlRenderer/builder options))]
(.render renderer document)))
(deftest cwiki-attribute-provider-test
(testing "The ability of the CWikiAttributeProvider to place the correct attributes in wikilinks."
(let [test-output (commonmark "[...](http://github.com/vsch/flexmark-java)")]
(is (= test-output
"<p><a href=\"http://github.com/vsch/flexmark-java\" target=\"_top\">...</a></p>\n")))))
使用上面的两个 Java class 测试 运行 并通过。
我已经能够将 SampleAttributeProvider
翻译成 Clojure。它编译并生成 class 个文件。我实际上无法 运行 并对其进行测试,因为...
我在翻译示例中的扩展 class 时遇到问题。到目前为止,这是我想出的。 (Class 名称已更改以避免冲突。):
(ns cwiki.util.CWikiAttributeProviderExtension
(:gen-class
:implements [com.vladsch.flexmark.html.HtmlRenderer$HtmlRendererExtension]
:methods [^:static [create [] cwiki.util.CWikiAttributeProviderExtension]])
(:import (com.vladsch.flexmark.html HtmlRenderer$Builder)
(com.vladsch.flexmark.util.options MutableDataHolder)
(cwiki.util CWikiAttributeProvider CWikiAttributeProviderExtension)))
(defn -rendererOptions
[this ^MutableDataHolder options]
; Add any configuration option that you want to apply to everything here.
)
(defn -extend
[this ^HtmlRenderer$Builder rendererBuilder ^String rendererType]
(.attributeProviderFactory rendererBuilder (CWikiAttributeProvider.)))
(defn ^CWikiAttributeProviderExtension -create [this]
(CWikiAttributeProviderExtension.))
正在尝试用
$ lein compile CWikiAttributeProviderExtension
,它会生成以以下内容开头的错误消息:
Compiling cwiki.util.CWikiAttributeProviderExtension
java.lang.ClassNotFoundException: cwiki.util.CWikiAttributeProviderExtension, compiling:(cwiki/util/CWikiAttributeProviderExtension.clj:1:1)
Exception in thread "main" java.lang.ClassNotFoundException: cwiki.util.CWikiAttributeProviderExtension, compiling:(cwiki/util/CWikiAttributeProviderExtension.clj:1:1)
at clojure.lang.Compiler.analyzeSeq(Compiler.java:7010)
at clojure.lang.Compiler.analyze(Compiler.java:6773)
at clojure.lang.Compiler.analyze(Compiler.java:6729)
at clojure.lang.Compiler$BodyExpr$Parser.parse(Compiler.java:6100)
at clojure.lang.Compiler$TryExpr$Parser.parse(Compiler.java:2307)
at clojure.lang.Compiler.analyzeSeq(Compiler.java:7003)
...
IDE(IntelliJ 上的 Cursive)显示一条警告消息,提示无法解析 :gen-class
部分中的 create
方法,但我看不出任何错误与声明或实施。这个翻译类似于我之前在其他程序中使用的构建 Java class 的方法,它向扩展 Java 接口的对象添加方法。它类似于我在示例中用来创建其他相关 class 的内容。但显然有些地方不对。
尝试只使用翻译后的 CWikiAttributeProvider
而不翻译扩展名 class 会导致工具链混淆首先编译 Clojure 中的对象,然后是 Java 部分,然后Clojure 程序的其余部分。所以看来我必须同时翻译两个 classes 或根本不翻译。
为了完整起见,这里是 Clojure 中翻译的属性提供程序 class。
(ns cwiki.util.CWikiAttributeProvider
(:gen-class
:implements [com.vladsch.flexmark.html.AttributeProvider]
:methods [^:static [Factory [] com.vladsch.flexmark.html.AttributeProviderFactory]])
(:import (com.vladsch.flexmark.ast Node Link)
(com.vladsch.flexmark.html AttributeProviderFactory
IndependentAttributeProviderFactory)
(com.vladsch.flexmark.html.renderer AttributablePart
LinkResolverContext)
(com.vladsch.flexmark.util.html Attributes)
(cwiki.util CWikiAttributeProvider)))
(defn -setAttributes
[this ^Node node ^AttributablePart part ^Attributes attributes]
(when (and (= (type node) Link) (= part AttributablePart/LINK))
(let [title (.getText ^Link node)]
(println "node: " node)
(println "title: " title)
(when (= title "...")
(.replaceValue attributes "target" "_top")))))
(defn ^AttributeProviderFactory -Factory [this]
(proxy [IndependentAttributeProviderFactory] []
(create [^LinkResolverContext context]
;; noinspection ReturnOfInnerClass
(CWikiAttributeProvider.))))
您需要将 CWikiAttributeProvider
作为 gen-class
中的 return 值进行前向声明。
(gen-class
:name cwiki.util.CWikiAttributeProviderExtension
:implements [com.vladsch.flexmark.html.HtmlRenderer$HtmlRendererExtension])
(gen-class
:name cwiki.util.CWikiAttributeProviderExtension
:implements [com.vladsch.flexmark.html.HtmlRenderer$HtmlRendererExtension]
:methods (^:static [create [] cwiki.util.CWikiAttributeProviderExtension]))
我能够使用这些 gen-class
语句并进行以下修改来编译您的示例:
- 从导入语句中删除 class 本身,
- 在方法实现和类型提示中通过其完全限定名称 (
cwiki.util.CWikiAttributeProvider
) 引用 class,并且 - 从静态方法中删除
this
引用(以匹配该方法的 gen-class 声明)。
另请注意,在项目中使用它时需要提前编译 class (AOT)。