Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
").append(NL);
// sort attributes into case insensitive order
Map attrs = new TreeMap();
for (final Method method : taskClass.getMethods()) {
if (isDocumentableSetter(taskClass, method)) {
String attributeName = getAttributeName(method);
StringBuilder sb = new StringBuilder();
sb.append("
").append(NL);
sb.append(NL);
attrs.put(new Key(required, attributeName), sb.toString());
}
}
// append in sorted order
for (String md : attrs.values()) {
out.append(md);
}
out.append("").append(NL);
out.append("
").append(NL);
}
}
protected boolean isRequired(final Method method) {
String reqd = getAnnotationStringValue(REQUIRED_ANNOTATION, method);
if (reqd == null) {
return false;
} else if (reqd.isEmpty() || reqd.toLowerCase(Locale.ENGLISH).startsWith("yes")) {
return true;
} else {
return false;
}
}
protected String getRequiredText(final Method method) {
String reqd = getAnnotationStringValue(REQUIRED_ANNOTATION, method);
if (reqd == null) {
if (isRequired(method)) {
throw new RuntimeException();
}
return "No";
} else if (reqd.isEmpty()) {
return "Yes";
} else {
return reqd;
}
}
static class Key implements Comparable {
final boolean required;
final String attributeName;
public Key(boolean required, String attributeName) {
this.required = required;
this.attributeName = attributeName;
}
@Override
public int compareTo(Key o) {
if (required && !o.required) {
return -1;
} else if (!required && o.required) {
return 1;
}
return attributeName.compareToIgnoreCase(o.attributeName);
}
}
String markdown(String md) {
Configuration config = Configuration.builder().forceExtentedProfile().setCodeBlockEmitter(new BlockEmitter() {
// Because this gets rendered on the website, and because there
// all code blocks are assumed to be Ceylon (and thus get Try buttons)
// we need to override the block emitter to prevent that
@Override
public void emitBlock(StringBuilder out, List lines, String meta) {
if (lines.isEmpty())
return;
out.append("").append(NL);
out.append("
");
for (final String s : lines) {
for (int i = 0; i < s.length(); i++) {
final char c = s.charAt(i);
switch (c) {
case '&':
out.append("&");
break;
case '<':
out.append("<");
break;
case '>':
out.append(">");
break;
default:
out.append(c);
break;
}
}
out.append(NL);
}
out.append("
\n");
}
}).build();
return Processor.process(md, config);
}
protected void docElement(Appendable out, ToolModel toolModel, Class taskClass, Method method) throws IOException {
String antDoc = getAnnotationStringValue(DOC_ANNOTATION, method);
String option = getAnnotationStringValue(OPTION_EQUIV_ANNOTATION, method);
StringBuilder sb = new StringBuilder();
if (antDoc != null) {
sb.append(antDoc).append(NL);
}
if (option != null) {
if (option.isEmpty()) {
option = isDocumentableSetter(taskClass, method) ? inferOptionNameFromSetter(method) : inferOptionNameFromAdder(method);
}
boolean found = false;
if (toolModel == null) {
System.err.println("@" + OPTION_EQUIV_ANNOTATION.getName() + " but no toolModel on " + method);
} else {
for (OptionModel opt : toolModel.getOptions()) {
if (("--"+opt.getLongName()).equals(option)) {
found = true;
if (getAnnotationBooleanValue(OPTION_EQUIV_ANNOTATION, method, "link")) {
sb.append("Equivalent to the [`--" + opt.getLongName() +"`]("+getToolOptionHref(toolModel.getName(), option)+") command line option.").append(NL);
}
if (getAnnotationBooleanValue(OPTION_EQUIV_ANNOTATION, method, "transclude")) {
sb.append(DocBuilder.getOptionDescription(toolModel, opt)).append(NL);
}
break;
}
}
}
if (!found) {
// Try looking it up as an option on the ceylon tool itself
for (OptionModel opt : rootToolModel.getOptions()) {
if (("--"+opt.getLongName()).equals(option)) {
found = true;
if (getAnnotationBooleanValue(OPTION_EQUIV_ANNOTATION, method, "link")) {
sb.append("Equivalent to the [`--" + opt.getLongName() +"`]("+getToolOptionHref(toolModel.getName(), option)+") command line option.").append(NL);
}
if (getAnnotationBooleanValue(OPTION_EQUIV_ANNOTATION, method, "transclude")) {
sb.append(DocBuilder.getOptionDescription(toolModel, opt)).append(NL);
}
break;
}
}
}
if (!found) {
System.err.println("Option " + option + " for " + method + " not found");
}
}
if (sb.length() == 0){
sb.append("Not documented");
System.err.println("Not documented: " + method);
}
out.append(markdown(sb.toString()));
}
protected String inferOptionNameFromSetter(Method setter) {
if (setter.getName().startsWith("set")) {
return "--" + camelCaseToDashes(setter.getName().substring(3));
} else {
throw new RuntimeException(setter.getName());
}
}
protected String inferOptionNameFromAdder(Method adder) {
if (adder.getName().startsWith("addConfigured")) {
return "--" + camelCaseToDashes(adder.getName().substring(13));
} else if (adder.getName().startsWith("add")) {
return "--" + camelCaseToDashes(adder.getName().substring(3));
} else {
throw new RuntimeException(adder.getName());
}
}
protected String camelCaseToDashes(String name) {
StringBuilder sb = new StringBuilder();
for (char ch : name.toCharArray()) {
if (Character.isUpperCase(ch)) {
if (sb.length() != 0) {
sb.append('-');
}
sb.append(Character.toLowerCase(ch));
} else {
sb.append(ch);
}
}
final String toolName = sb.toString();
return toolName;
}
protected boolean hasSetters(Class elementClass) {
boolean hasSetters = false;
for (Method elementMethod : elementClass.getMethods()) {
if (isDocumentableSetter(elementClass, elementMethod)) {
hasSetters = true;
break;
}
}
return hasSetters;
}
protected boolean isDocumentableAdder(Method method) {
return Modifier.isPublic(method.getModifiers())
&& method.getName().startsWith("add")
&& method.getParameterTypes().length == 1
&& !method.isAnnotationPresent(IGNORE_ANNOTATION)
&& !method.getDeclaringClass().isAssignableFrom(antTaskClass);
}
protected boolean isDocumentableSetter(Class taskClass, Method method) {
try {
return (Modifier.isPublic(method.getModifiers())
&& method.getName().startsWith("set")
&& method.getParameterTypes().length == 1
&& !method.isAnnotationPresent(IGNORE_ANNOTATION)
&& taskClass.getMethod(method.getName(), method.getParameterTypes()).equals(method)
&& !method.getDeclaringClass().isAssignableFrom(antTaskClass))
|| (Modifier.isPublic(method.getModifiers())
&& method.getName().startsWith("setDynamicAttribute")
&& method.getParameterTypes().length == 2
&& !method.isAnnotationPresent(IGNORE_ANNOTATION)
&& taskClass.getMethod(method.getName(), method.getParameterTypes()).equals(method)
&& !method.getDeclaringClass().isAssignableFrom(antTaskClass));
} catch (NoSuchMethodException e) {
throw new RuntimeException(e);
} catch (SecurityException e) {
throw new RuntimeException(e);
}
}
protected String getAttributeName(Method method) {
String name = getAnnotationStringValue(ATTRIBUTE_ANNOTATION, method);
if (name != null) {
return name;
} else {
name = method.getName().replaceFirst("^set", "");
return name.substring(0, 1).toLowerCase(Locale.ENGLISH) + name.substring(1);
}
}
@Override
public void run() throws Exception {
for (Class t : Arrays.asList(
Class.forName("com.redhat.ceylon.ant.CeylonCompileAntTask", false, loader),
Class.forName("com.redhat.ceylon.ant.CeylonCompileJsAntTask", false, loader),
Class.forName("com.redhat.ceylon.ant.CeylonRunAntTask", false, loader),
Class.forName("com.redhat.ceylon.ant.CeylonRunJsAntTask", false, loader),
Class.forName("com.redhat.ceylon.ant.CeylonTestAntTask", false, loader),
Class.forName("com.redhat.ceylon.ant.CeylonTestJsAntTask", false, loader),
Class.forName("com.redhat.ceylon.ant.CeylonDocAntTask", false, loader),
Class.forName("com.redhat.ceylon.ant.CeylonWarAntTask", false, loader),
Class.forName("com.redhat.ceylon.ant.CeylonImportJarAntTask", false, loader),
Class.forName("com.redhat.ceylon.ant.CeylonCopyAntTask", false, loader),
Class.forName("com.redhat.ceylon.ant.CeylonModuleDescriptorTask", false, loader),
Class.forName("com.redhat.ceylon.ant.CeylonPluginAntTask", false, loader)
)) {
if (!antTaskClass.isAssignableFrom(t)) {
System.err.println(t+" is not a "+antTaskClass.getName());
continue;
}
Class task = (Class)t;
String taskName = getTaskName(task);
Writer o = new OutputStreamWriter(new FileOutputStream(new File("ant-"+taskName+".md")), "UTF-8");
try {
documentTask(o, task);
} finally {
o.close();
}
}
}
public static void main(String[] a) throws Exception {
new CeylonAntTaskDocTool().run();
}
}
