org.jdrupes.mdoclet.processors.FlexmarkProcessor Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of doclet Show documentation
Show all versions of doclet Show documentation
A doclet for processing javadoc comments written with Markup
/*
* JDrupes MDoclet
* Copyright (C) 2017, 2021 Michael N. Lipp
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License
* for more details.
*
* You should have received a copy of the GNU Affero General Public License along
* with this program; if not, see `
* : Adds the flexmark extension with the given name to the list of extensions.
* If the name contains a dot, it is assumed to be a fully qualified class
* name. Else, it is expanded using the naming pattern used by flexmark.
*
* The parser also supports disabling the automatic highlight feature.
*
* [^DefLists]: If you use this extension, you'll most likely want to supply a
* modified style sheet because the standard stylesheet assumes all definition
* lists to be parameter defintion lists and formats them accordingly.
*
* Here are the changes made for this documentation:
* ```css
* /* [MOD] {@literal *}/
* /* .contentContainer .description dl dd, {@literal *}/ .contentContainer .details dl dt, ...
* font-size:12px;
* font-weight:bold;
* margin:10px 0 0 0;
* color:#4E4E4E;
* }
* /* [MOD] Added {@literal *}/
* dl dt {
* margin:10px 0 0 0;
* }
*
* /* [MOD] {@literal *}/
* /* .contentContainer .description dl dd, {@literal *}/ .contentContainer .details dl dd, ...
* margin:5px 0 10px 0px;
* font-size:14px;
* font-family:'DejaVu Sans Mono',monospace;
* }
* ```
*
*/
public class FlexmarkProcessor implements MarkdownProcessor {
private static final String OPT_PROFILE = "--parser-profile";
private static final String OPT_CLEAR_EXTENSIONS = "--clear-extensions";
private static final String OPT_EXTENSION = "--extension";
private Parser parser;
private HtmlRenderer renderer;
@Override
public int isSupportedOption(String option) {
switch (option) {
case OPT_CLEAR_EXTENSIONS:
case INTERNAL_OPT_DISABLE_AUTO_HIGHLIGHT:
return 0;
case OPT_PROFILE:
case OPT_EXTENSION:
return 1;
default:
return -1;
}
}
@Override
public void start(String[] options) {
Set> extensions = new HashSet<>();
extensions.add(AbbreviationExtension.class);
extensions.add(AnchorLinkExtension.class);
extensions.add(DefinitionExtension.class);
extensions.add(FootnoteExtension.class);
extensions.add(TablesExtension.class);
extensions.add(TypographicExtension.class);
extensions.add(TocExtension.class);
extensions.add(WikiLinkExtension.class);
extensions.add(TopAnchorLinkExtension.class);
MutableDataSet flexmarkOpts = new MutableDataSet();
flexmarkOpts.set(HtmlRenderer.GENERATE_HEADER_ID, true);
for (String opt : options) {
String[] optAndArgs = opt.split("[= ]");
switch (optAndArgs[0]) {
case OPT_PROFILE:
setFromProfile(flexmarkOpts, optAndArgs[1]);
continue;
case OPT_CLEAR_EXTENSIONS:
extensions.clear();
continue;
case OPT_EXTENSION:
try {
String clsName = optAndArgs[1];
if (!clsName.contains(".")) {
clsName = "com.vladsch.flexmark.ext."
+ optAndArgs[1].toLowerCase() + "." + optAndArgs[1]
+ "Extension";
}
@SuppressWarnings("unchecked")
Class cls
= (Class) getClass()
.getClassLoader().loadClass(clsName);
extensions.add(cls);
continue;
} catch (ClassNotFoundException | ClassCastException e) {
throw new IllegalArgumentException("Cannot find extension "
+ optAndArgs[1] + " (check spelling and classpath).");
}
case INTERNAL_OPT_DISABLE_AUTO_HIGHLIGHT:
flexmarkOpts.set(
HtmlRenderer.FENCED_CODE_NO_LANGUAGE_CLASS, "nohighlight");
continue;
default:
throw new IllegalArgumentException(
"Unknown option: " + optAndArgs[0]);
}
}
List extObjs = new ArrayList<>();
for (Class cls : extensions) {
try {
extObjs.add((Extension) cls.getMethod("create").invoke(null));
} catch (IllegalAccessException | IllegalArgumentException
| InvocationTargetException | NoSuchMethodException
| SecurityException e) {
throw new IllegalArgumentException(
"Cannot create extension of type " + cls + ".");
}
}
if (!extObjs.isEmpty()) {
flexmarkOpts.set(Parser.EXTENSIONS, extObjs);
}
parser = Parser.builder(flexmarkOpts).build();
renderer = HtmlRenderer.builder(flexmarkOpts).build();
}
private void setFromProfile(MutableDataSet fmOpts, String profileName) {
for (ParserEmulationProfile p : ParserEmulationProfile.values()) {
if (p.toString().equalsIgnoreCase(profileName)) {
fmOpts.setFrom(p);
return;
}
}
throw new IllegalArgumentException("Unknown profile: " + profileName);
}
/*
* (non-Javadoc)
*
* @see org.jdrupes.mdoclet.MarkdownProcessor#toHtml(java.lang.String)
*/
@Override
public String toHtml(String markdown) {
Node document = parser.parse(markdown);
return renderer.render(document);
}
/*
* (non-Javadoc)
*
* @see
* org.jdrupes.mdoclet.MarkdownProcessor#toHtmlFragment(java.lang.String)
*/
@Override
public String toHtmlFragment(String markdown) {
markdown = markdown.trim();
String result = toHtml(markdown).trim();
if (markdown.startsWith("<")) {
// We should check if a surrounding tag was added. But until
// this pops up as an issue, let's keep this simple.
return result;
}
if (result.toUpperCase().startsWith("")
&& result.toUpperCase().endsWith("
")) {
return result.substring(3, result.length() - 4);
}
return result;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy