📄 docgenerator.java
字号:
"(?i)(?d)(?m).*<body>(.*)</body>.*", "$1")); //$NON-NLS-1$ //$NON-NLS-2$
} else {
ctx.put("overview", ""); //$NON-NLS-1$ //$NON-NLS-2$
}
processTemplateFile(ctx, "overview.jxp", //$NON-NLS-1$
new File(destDir, "overview.html")); //$NON-NLS-1$
// generating "all plug-ins" page
ctx = createConext(0);
processTemplateFile(ctx, "allplugins.jxp", //$NON-NLS-1$
new File(destDir, "allplugins.html")); //$NON-NLS-1$
// generating "all plug-in fragments" page
ctx = createConext(0);
processTemplateFile(ctx, "allfragments.jxp", //$NON-NLS-1$
new File(destDir, "allfragments.html")); //$NON-NLS-1$
// generating "all extension points" page
ctx = createConext(0);
processTemplateFile(ctx, "allextpoints.jxp", //$NON-NLS-1$
new File(destDir, "allextpoints.html")); //$NON-NLS-1$
// generating "all extensions" page
ctx = createConext(0);
processTemplateFile(ctx, "allexts.jxp", //$NON-NLS-1$
new File(destDir, "allexts.html")); //$NON-NLS-1$
// generating tree page
ctx = createConext(0);
processTemplateFile(ctx, "tree.jxp", //$NON-NLS-1$
new File(destDir, "tree.html")); //$NON-NLS-1$
// per plug-in generation
for (Iterator it = registry.getPluginDescriptors().iterator();
it.hasNext();) {
generateForPluginDescriptor(destDir, (PluginDescriptor) it.next());
}
}
private void generateCss(final File destDir) throws Exception {
Map ctx = createConext(0);
if (stylesheet == null) {
processTemplateFile(ctx, "stylesheet.jxp", //$NON-NLS-1$
new File(destDir, "stylesheet.css")); //$NON-NLS-1$
} else {
processTemplateContent(ctx, stylesheet,
new File(destDir, "stylesheet.css")); //$NON-NLS-1$
}
}
private void generateForPluginDescriptor(final File baseDir,
final PluginDescriptor descr) throws Exception {
File destDir = new File(baseDir, descr.getId());
destDir.mkdirs();
File srcDocsFolder = IoUtil.url2file(
pathResolver.resolvePath(descr, descr.getDocsPath()));
if ((srcDocsFolder != null) && srcDocsFolder.isDirectory()) {
File destDocsFolder = new File(destDir, "extra"); //$NON-NLS-1$
destDocsFolder.mkdir();
IoUtil.copyFolder(srcDocsFolder, destDocsFolder, true);
}
List depenededPlugins = new LinkedList();
for (Iterator it = registry.getPluginDescriptors().iterator();
it.hasNext();) {
PluginDescriptor dependedDescr = (PluginDescriptor) it.next();
if (dependedDescr.getId().equals(descr.getId())) {
continue;
}
for (Iterator it2 = dependedDescr.getPrerequisites().iterator();
it2.hasNext();) {
PluginPrerequisite pre = (PluginPrerequisite) it2.next();
if (pre.getPluginId().equals(descr.getId())
&& pre.matches()) {
depenededPlugins.add(dependedDescr);
break;
}
}
}
Map ctx = createConext(1);
ctx.put("descriptor", descr); //$NON-NLS-1$
ctx.put("dependedPlugins", depenededPlugins); //$NON-NLS-1$
processTemplateFile(ctx, "plugin.jxp", //$NON-NLS-1$
new File(destDir, "index.html")); //$NON-NLS-1$
// per plug-in fragment generation
for (Iterator it = descr.getFragments().iterator(); it.hasNext();) {
generateForPluginFragment(baseDir, (PluginFragment) it.next());
}
// generating extension points
if (!descr.getExtensionPoints().isEmpty()) {
File extPointsDir = new File(destDir, "extp"); //$NON-NLS-1$
extPointsDir.mkdir();
for (Iterator it = descr.getExtensionPoints().iterator();
it.hasNext();) {
ExtensionPoint extPoint = (ExtensionPoint) it.next();
ctx = createConext(3);
ctx.put("extPoint", extPoint); //$NON-NLS-1$
File dir = new File(extPointsDir, extPoint.getId());
dir.mkdir();
processTemplateFile(ctx, "extpoint.jxp", //$NON-NLS-1$
new File(dir, "index.html")); //$NON-NLS-1$
}
}
// generating extensions
if (!descr.getExtensions().isEmpty()) {
File extsDir = new File(destDir, "ext"); //$NON-NLS-1$
extsDir.mkdir();
for (Iterator it = descr.getExtensions().iterator();
it.hasNext();) {
Extension ext = (Extension) it.next();
ctx = createConext(3);
ctx.put("ext", ext); //$NON-NLS-1$
File dir = new File(extsDir, ext.getId());
dir.mkdir();
processTemplateFile(ctx, "ext.jxp", //$NON-NLS-1$
new File(dir, "index.html")); //$NON-NLS-1$
}
}
}
private void generateForPluginFragment(final File baseDir,
final PluginFragment fragment) throws Exception {
File destDir = new File(baseDir, fragment.getId());
destDir.mkdirs();
Map ctx = createConext(1);
ctx.put("fragment", fragment); //$NON-NLS-1$
processTemplateFile(ctx, "fragment.jxp", //$NON-NLS-1$
new File(destDir, "index.html")); //$NON-NLS-1$
}
private Map createConext(final int level) {
Map result = new HashMap();
String relativePath = getRelativePath(level);
result.put("tool", new Tool(relativePath)); //$NON-NLS-1$
result.put("relativePath", relativePath); //$NON-NLS-1$
result.put("registry", registry); //$NON-NLS-1$
result.put("allPluginDescriptors", allPluginDescriptors); //$NON-NLS-1$
result.put("allPluginFragments", allPluginFragments); //$NON-NLS-1$
result.put("allExtensionPoints", allExtensionPoints); //$NON-NLS-1$
result.put("allExtensions", allExtensions); //$NON-NLS-1$
return result;
}
private Collection getAllPluginDescriptors() {
List result = new LinkedList();
result.addAll(registry.getPluginDescriptors());
Collections.sort(result, new IdentityComparator());
return Collections.unmodifiableCollection(result);
}
private Collection getAllPluginFragments() {
List result = new LinkedList();
result.addAll(registry.getPluginFragments());
Collections.sort(result, new IdentityComparator());
return Collections.unmodifiableCollection(result);
}
private Collection getAllExtensionPoints() {
List result = new LinkedList();
for (Iterator it = registry.getPluginDescriptors().iterator();
it.hasNext();) {
result.addAll(((PluginDescriptor) it.next()).getExtensionPoints());
}
Collections.sort(result, new IdentityComparator());
return Collections.unmodifiableCollection(result);
}
private Collection getAllExtensions() {
List result = new LinkedList();
for (Iterator it = registry.getPluginDescriptors().iterator();
it.hasNext();) {
result.addAll(((PluginDescriptor) it.next()).getExtensions());
}
Collections.sort(result, new IdentityComparator());
return Collections.unmodifiableCollection(result);
}
/**
* Utility class to be used from JXP templates.
* @version $Id: DocGenerator.java,v 1.7 2006/08/26 15:14:10 ddimon Exp $
*/
public static final class Tool {
private String relativePath;
protected Tool(final String aRelativePath) {
this.relativePath = aRelativePath;
}
/**
* @param ref documentation reference element
* @return link to be used in "href" attribute
*/
public String getLink(final Documentation.Reference ref) {
if (isAbsoluteUrl(ref.getRef())) {
return ref.getRef();
}
String id;
Identity idt = ref.getDeclaringIdentity();
if (idt instanceof PluginElement) {
PluginElement element = (PluginElement) idt;
PluginFragment fragment = element.getDeclaringPluginFragment();
if (fragment != null) {
id = fragment.getId();
} else {
id = element.getDeclaringPluginDescriptor().getId();
}
} else {
id = idt.getId();
}
return relativePath + "/" + id + "/extra/" + ref.getRef(); //$NON-NLS-1$ //$NON-NLS-2$
}
/**
* @param url an URL to check
* @return <code>true</code> if given link is an absolute URL
*/
public boolean isAbsoluteUrl(final String url) {
try {
String protocol = new URL(url).getProtocol();
return (protocol != null) && (protocol.length() > 0);
} catch (MalformedURLException e) {
return false;
}
}
/**
* Substitutes all ${relativePath} variables with their values.
* @param text text to be processed
* @return processed documentation text
*/
public String processDocText(final String text) {
if ((text == null) || (text.length() == 0)) {
return ""; //$NON-NLS-1$
}
return text.replaceAll("(?d)(?m)\\$\\{relativePath\\}", //$NON-NLS-1$
relativePath);
}
}
static final class IdentityComparator implements Comparator {
/**
* @see java.util.Comparator#compare(java.lang.Object, java.lang.Object)
*/
public int compare(final Object o1, final Object o2) {
return ((Identity) o1).getId().compareTo(
((Identity) o2).getId());
}
}
}
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -