// Copyright (C) 2016 xaizek <xaizek@posteo.net>
//
// This file is part of uncov.
//
// uncov is free software: you can redistribute it and/or modify
// it under the terms of version 3 of the GNU Affero General Public License as
// published by the Free Software Foundation.
//
// uncov is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with uncov.  If not, see <http://www.gnu.org/licenses/>.

#ifndef UNCOV_INVOCATION_HPP_
#define UNCOV_INVOCATION_HPP_

#include <string>
#include <vector>

/**
 * @file Invocation.hpp
 *
 * @brief This unit implements parsing of command-line arguments..
 */

/**
 * @brief Breaks command-line arguments into separate fields.
 */
class Invocation
{
public:
    /**
     * @brief Parses argument list.
     *
     * @param args Arguments of the application.
     *
     * @throws std::invalid_argument on empty argument list.
     */
    explicit Invocation(std::vector<std::string> args);

public:
    /**
     * @brief Retrieves usage message.
     *
     * @returns The message.
     */
    std::string getUsage() const;

    /**
     * @brief Retrieves error message, if any.
     *
     * @returns Empty string if there is no error, otherwise error message.
     */
    const std::string & getError() const;

    /**
     * @brief Retrieves path to repository.
     *
     * @returns The path.
     */
    const std::string & getRepositoryPath() const;

    /**
     * @brief Retrieves name of subcommand to execute.
     *
     * @returns The name.
     */
    const std::string & getSubcommandName() const;

    /**
     * @brief Retrieves arguments for subcommand.
     *
     * @returns The arguments.
     */
    const std::vector<std::string> & getSubcommandArgs() const;

    /**
     * @brief Checks whether usage information printing was requested.
     *
     * @returns @c true if so, @c false otherwise.
     */
    bool shouldPrintHelp() const;

    /**
     * @brief Checks whether version information printing was requested.
     *
     * @returns @c true if so, @c false otherwise.
     */
    bool shouldPrintVersion() const;

private:
    //! Name of the program.
    std::string programName;
    //! Error message or empty string.
    std::string error;
    //! Path to repository.
    std::string repositoryPath;
    //! Name of subcommand to execute.
    std::string subcommandName;
    //! Arguments for subcommand.
    std::vector<std::string> subcommandArgs;
    //! Whether usage information printing was requested.
    bool printHelp = false;
    //! Whether version information printing was requested.
    bool printVersion = false;
};

#endif // UNCOV_INVOCATION_HPP_