tmf/org.eclipse.tracecompass.tmf.cli.core/src/org/eclipse/tracecompass/internal/provisional/tmf/cli/core/parser/CliOption.java

/*******************************************************************************
 * Copyright (c) 2019 École Polytechnique de Montréal
 *
 * All rights reserved. This program and the accompanying materials are
 * made available under the terms of the Eclipse Public License 2.0 which
 * accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *******************************************************************************/

package org.eclipse.tracecompass.internal.provisional.tmf.cli.core.parser;

import java.util.Objects;

import org.apache.commons.cli.Option;
import org.apache.commons.cli.OptionBuilder;
import org.eclipse.jdt.annotation.Nullable;

/**
 * Describe a command line argument for a CLI parser.
 *
 * TODO Add more types of options to create
 *
 * @author Geneviève Bastien
 */
public class CliOption {

    private static final String DEFAULT_ARG_NAME = "arg"; //$NON-NLS-1$

    private final String fShortOption;
    private final @Nullable String fLongOption;
    private final @Nullable String fDescription;
    private final int fMinArguments;
    // Maximum number of arguments. Use Integer.MAX_VALUE for unbounded.
    private final int fMaxArguments;
    private final String fArgumentName;

    /**
     * Create a new simple options, without arguments.
     *
     * @param optionShort
     *            The short key for this option, cannot be null
     * @param optionLong
     *            The long key for this option
     * @param optionDescription
     *            The option description
     * @return A new option
     */
    public static CliOption createSimpleOption(String optionShort, @Nullable String optionLong, @Nullable String optionDescription) {
        return new CliOption(optionShort, optionLong, optionDescription, 0, 0, DEFAULT_ARG_NAME);
    }

    /**
     * Create an option with arguments
     *
     * @param optionShort
     *            The short key for this options, cannot be null
     * @param optionLong
     *            The long key for this option
     * @param optionDescription
     *            he option description
     * @param mandatory
     *            Whether the arguments to this option are mandatory or
     *            optional. <code>true</code> is mandatory.
     * @param multiple
     *            Whether there can be multiple arguments to this option.
     *            <code>true</code> means multiple arguments
     * @param argName
     *            A help string for the arguments, for the help message. For
     *            instance, if the argument is a path, "path" can be used as
     *            value
     * @return A new option
     */
    public static CliOption createOptionWithArgs(String optionShort, @Nullable String optionLong, @Nullable String optionDescription, boolean mandatory, boolean multiple, String argName) {
        return new CliOption(optionShort, optionLong, optionDescription, mandatory ? 1 : 0, multiple ? Integer.MAX_VALUE : 1, argName);
    }

    private CliOption(String optionShort, @Nullable String optionLong, @Nullable String optionDescription, int min, int max, String argName) {
        fShortOption = optionShort;
        fLongOption = optionLong;
        fDescription = optionDescription;
        fMinArguments = Math.min(min, max);
        fMaxArguments = Math.max(min, max);
        fArgumentName = argName;
    }

    Option toCliOption() {
        OptionBuilder.withArgName(fArgumentName);
        // Number of arguments
        if (fMaxArguments == 0) {
            // No arguments
            OptionBuilder.hasArg(false);
        } else if (fMaxArguments == 1) {
            // 1 argument, optional or mandatory
            if (fMinArguments == 0) {
                OptionBuilder.hasOptionalArg();
            } else {
                OptionBuilder.hasArg();
            }
        } else if (fMaxArguments < Integer.MAX_VALUE) {
            // Many arguments, optional or mandatory
            if (fMinArguments == 0) {
                OptionBuilder.hasOptionalArgs(fMaxArguments);
            } else {
                OptionBuilder.hasArgs(fMaxArguments);
            }
        } else {
            // Unbounded number of optional or mandatory arguments
            if (fMinArguments == 0) {
                OptionBuilder.hasOptionalArgs();
            } else {
                OptionBuilder.hasArgs();
            }
        }
        if (fLongOption != null) {
            OptionBuilder.withLongOpt(fLongOption);
        }
        if (fDescription != null) {
            OptionBuilder.withDescription(fDescription);
        }
        return Objects.requireNonNull(OptionBuilder.create(fShortOption));
    }

    @Override
    public String toString() {
        return '-' + fShortOption;
    }

}