com.github.rvesse.airline.help.AbstractUsageGenerator Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of airline Show documentation
Show all versions of airline Show documentation
Java library provided an annotation-based framework for parsing Git like command line structures
package com.github.rvesse.airline.help;
import static com.google.common.collect.Iterables.transform;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import java.util.Set;
import com.github.rvesse.airline.model.ArgumentsMetadata;
import com.github.rvesse.airline.model.CommandMetadata;
import com.github.rvesse.airline.model.OptionMetadata;
import com.google.common.base.Function;
import com.google.common.base.Joiner;
import com.google.common.base.Strings;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Lists;
public class AbstractUsageGenerator {
protected static final int DEFAULT_COLUMNS = 79;
private final Comparator optionComparator;
private final Comparator commandComparator;
private final boolean includeHidden;
public AbstractUsageGenerator() {
this(UsageHelper.DEFAULT_OPTION_COMPARATOR, UsageHelper.DEFAULT_COMMAND_COMPARATOR, false);
}
public AbstractUsageGenerator(Comparator optionComparator,
Comparator commandComparator, boolean includeHidden) {
this.optionComparator = optionComparator;
this.commandComparator = commandComparator;
this.includeHidden = includeHidden;
}
/**
* Gets whether hidden commands and options should be included in the output
*
* @return True if hidden commands/options should be included
*/
protected boolean includeHidden() {
return this.includeHidden;
}
protected final Comparator getOptionComparator() {
return this.optionComparator;
}
protected final Comparator getCommandComparator() {
return this.commandComparator;
}
/**
* Sorts the options assuming a non-null comparator was provided at
* instantiation time
*
* @param options
* Options
* @return Sorted options
*/
protected List sortOptions(List options) {
if (optionComparator != null) {
options = new ArrayList(options);
Collections.sort(options, optionComparator);
}
return options;
}
/**
* Sorts the commands assuming a non-null comparator was provided at
* instantiation time
*
* @param commands
* Commands
* @return Sorted commands
*/
protected List sortCommands(List commands) {
if (commandComparator != null) {
commands = new ArrayList<>(commands);
Collections.sort(commands, commandComparator);
}
return commands;
}
/**
* HTMLizes a string i.e. escapes HTML special characters into HTML entities
* and new lines into HTML line breaks
*
* @param value
* String to HTMLize
* @return HTMLized string
*/
protected final String htmlize(final String value) {
return value.replaceAll("<", "<").replaceAll(">", ">").replaceAll("\n", "
");
}
/**
* Converts a command into the default command representation for the usage
* documentation
*
* @param command
* Default command name
* @return
*/
protected String toDefaultCommand(String command) {
if (Strings.isNullOrEmpty(command)) {
return "";
}
StringBuilder stringBuilder = new StringBuilder();
stringBuilder.append("[ ");
stringBuilder.append(command);
stringBuilder.append(" ]");
return stringBuilder.toString();
}
/**
* Converts the options into their synopsis representation for the usage
* documentation
*
* @param options
* Options
* @return
*/
protected List toSynopsisUsage(List options) {
return ImmutableList.copyOf(transform(options, new Function() {
public String apply(OptionMetadata option) {
if (option.isHidden() && !includeHidden()) {
return "";
}
return toUsage(option);
}
}));
}
protected String toUsage(ArgumentsMetadata arguments) {
if (!arguments.getUsage().isEmpty()) {
return arguments.getUsage();
}
boolean required = arguments.isRequired();
StringBuilder stringBuilder = new StringBuilder();
if (!required) {
// TODO: be able to handle required arguments individually, like
// arity for the options
stringBuilder.append("[ ");
}
stringBuilder.append(toDescription(arguments));
if (arguments.isMultiValued()) {
stringBuilder.append("...");
}
if (!required) {
stringBuilder.append(" ]");
}
return stringBuilder.toString();
}
protected String toUsage(OptionMetadata option) {
Set options = option.getOptions();
boolean required = option.isRequired();
StringBuilder stringBuilder = new StringBuilder();
if (!required) {
stringBuilder.append("[ ");
}
if (options.size() > 1) {
stringBuilder.append('{');
}
final String argumentString;
if (option.getArity() > 0) {
argumentString = Joiner.on(" ").join(
transform(ImmutableList.of(option.getTitle()), new Function() {
public String apply(String argument) {
return "<" + argument + ">";
}
}));
} else {
argumentString = null;
}
Joiner.on(" | ").appendTo(stringBuilder, transform(options, new Function() {
public String apply(String option) {
return option;
}
}));
if (options.size() > 1) {
stringBuilder.append('}');
}
if (argumentString != null) {
stringBuilder.append(" " + argumentString);
}
if (option.isMultiValued()) {
stringBuilder.append("...");
}
if (!required) {
stringBuilder.append(" ]");
}
return stringBuilder.toString();
}
protected String toDescription(ArgumentsMetadata arguments) {
if (!arguments.getUsage().isEmpty()) {
return arguments.getUsage();
}
List descriptionTitles = arguments.getTitle();
StringBuilder stringBuilder = new StringBuilder();
for (String title : descriptionTitles) {
if (stringBuilder.length() > 0) {
stringBuilder.append(" ");
}
stringBuilder.append("<");
stringBuilder.append(title);
stringBuilder.append(">");
}
return stringBuilder.toString();
}
protected String toDescription(OptionMetadata option) {
Set options = option.getOptions();
StringBuilder stringBuilder = new StringBuilder();
final String argumentString;
if (option.getArity() > 0) {
argumentString = Joiner.on(" ").join(
Lists.transform(ImmutableList.of(option.getTitle()), new Function() {
public String apply(String argument) {
return "<" + argument + ">";
}
}));
} else {
argumentString = null;
}
Joiner.on(", ").appendTo(stringBuilder, transform(options, new Function() {
public String apply(String option) {
if (argumentString != null) {
return option + " " + argumentString;
}
return option;
}
}));
return stringBuilder.toString();
}
}