org.verapdf.cli.FormatterHelper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gui-arlington Show documentation
The newest version!
/**
 * This file is part of VeraPDF Library GUI, a module of the veraPDF project.
 * Copyright (c) 2015, veraPDF Consortium 
 * All rights reserved.
 *
 * VeraPDF Library GUI is free software: you can redistribute it and/or modify
 * it under the terms of either:
 *
 * The GNU General public license GPLv3+.
 * You should have received a copy of the GNU General Public License
 * along with VeraPDF Library GUI as the LICENSE.GPL file in the root of the source
 * tree.  If not, see http://www.gnu.org/licenses/ or
 * https://www.gnu.org/licenses/gpl-3.0.en.html.
 *
 * The Mozilla Public License MPLv2+.
 * You should have received a copy of the Mozilla Public License along with
 * VeraPDF Library GUI as the LICENSE.MPL file in the root of the source tree.
 * If a copy of the MPL was not distributed with this file, you can obtain one at
 * http://mozilla.org/MPL/2.0/.
 */
package org.verapdf.cli;

import com.beust.jcommander.*;
import org.verapdf.extensions.ExtensionObjectType;
import org.verapdf.features.FeatureObjectType;
import org.verapdf.pdfa.flavours.PDFAFlavour;
import org.verapdf.pdfa.validation.profiles.Profiles;
import org.verapdf.processor.FormatOption;

import java.lang.reflect.Type;
import java.util.*;

public class FormatterHelper extends DefaultUsageFormatter {

	private static final String FLAVOUR = "flavour";

	public FormatterHelper(JCommander commander) {
		super(commander);
	}

	@Override
	public void appendAllParametersDetails(StringBuilder out, int indentCount, String indent, List sortedParameters) {
		if (!sortedParameters.isEmpty()) {
			out.append(indent).append("  Options:\n");
		}

		for (ParameterDescription pd : sortedParameters) {
			WrappedParameter parameter = pd.getParameter();
			String description = pd.getDescription();
			boolean hasDescription = !description.isEmpty();

			// First line, command name
			out.append(indent)
			   .append("  ")
			   .append(parameter.required() ? "* " : "  ")
			   .append(pd.getNames())
			   .append('\n');

			if (hasDescription) {
				wrapDescription(out, indentCount, s(indentCount) + description);
			}
			Object def = pd.getDefault();

			if (pd.isDynamicParameter()) {
				String syntax = "Syntax: " + parameter.names()[0] + "key" + parameter.getAssignment() + "value";

				if (hasDescription) {
					out.append(newLineAndIndent(indentCount));
				} else {
					out.append(s(indentCount));
				}
				out.append(syntax);
			}

			if (def != null && !pd.isHelp()) {
				String displayedDef = Strings.isStringEmpty(def.toString()) ? "" : def.toString();
				String defaultText = "Default: " + (parameter.password() ? "********" : displayedDef);

				if (hasDescription) {
					out.append(newLineAndIndent(indentCount));
				} else {
					out.append(s(indentCount));
				}
				out.append(defaultText);
			}
			Class type = pd.getParameterized().getType();

			if (type.isEnum()) {
				String valueList;
				if (PDFAFlavour.class.getCanonicalName().equals(type.getName())) {
					EnumSet flavours = EnumSet.copyOf(Profiles.getVeraProfileDirectory().getPDFAFlavours());
					if (FLAVOUR.equals(pd.getParameterized().getName())) {
						flavours.add(PDFAFlavour.NO_ARLINGTON_FLAVOUR);
					}
					valueList = flavours.toString();
				} else if (FormatOption.class.getCanonicalName().equals(type.getName())) {
					List formatOptions = new LinkedList<>(Arrays.asList(FormatOption.values()));
					formatOptions.remove(FormatOption.MRR);
					valueList = formatOptions.toString();
				}else {
					valueList = EnumSet.allOf((Class) type).toString();
				}
				String possibleValues = "Possible Values: " + valueList;

				// Prevent duplicate values list, since it is set as 'Options: [values]' if the description
				// of an enum field is empty in ParameterDescription#init(..)
				if (!description.contains("Options: " + valueList)) {
					if (hasDescription) {
						out.append(newLineAndIndent(indentCount));
					} else {
						out.append(s(indentCount));
					}
					out.append(possibleValues);
				}
			}

			if (List.class.getCanonicalName().equals(type.getCanonicalName())) {
				Type fieldGenericType = pd.getParameterized().findFieldGenericType();
				String valueList = null;
				if (FeatureObjectType.class.equals(fieldGenericType)) {
					List featuresList = new LinkedList<>(Arrays.asList(FeatureObjectType.values()));
					featuresList.remove(FeatureObjectType.ERROR);
					valueList = featuresList.toString();
				} else if (ExtensionObjectType.class.equals(fieldGenericType)) {
					List extensionsList = new LinkedList<>(Arrays.asList(ExtensionObjectType.values()));
					valueList = extensionsList.toString();
				}
				if (valueList != null) {
					String possibleValues = "Possible Values: " + valueList;
					out.append(newLineAndIndent(indentCount));
					out.append(possibleValues);
				}
			}
			out.append('\n');
		}
	}

	private static String newLineAndIndent(int indent) {
		return '\n' + s(indent);
	}
}