#ifndef TRT_GET_OPTIONS_H
#define TRT_GET_OPTIONS_H

#include <string>
#include <utility>
#include <vector>

namespace nvinfer1
{
namespace utility
{

//! TRTOption defines a command line option. At least 1 of shortName and longName
//! must be defined.
//! If bool initialization is undefined behavior on your system, valueRequired
//! must also be explicitly defined.
//! helpText is optional.
struct TRTOption
{
    char shortName;       //!< Option name in short (single hyphen) form (i.e. -a, -b)
    std::string longName; //!< Option name in long (double hyphen) form (i.e. --foo, --bar)
    bool valueRequired;   //!< True if a value is needed for an option (i.e. -N 4, --foo bar)
    std::string helpText; //!< Text to show when printing out the command usage
};

//! TRTParsedArgs is returned by getOptions after it has parsed a command line
//! argument list (argv).
//!
//! errMsg is a string containing an error message if any errors occurred. If it
//! is empty, no errors occurred.
//!
//! values stores a vector of pairs for each option (ordered by order in the
//! input). Each pair contains an int (the number of occurrences) and a vector
//! of strings (a list of values). The user should know which of these to use,
//! and which options required values. For non-value options, only occurrences is
//! populated. For value-required options, occurrences == # of values. Values do
//! not need to be unique.
//!
//! positionalArgs stores additional arguments that are passed in without an
//! option (these must not start with a hyphen).
struct TRTParsedArgs
{
    std::string errMsg;
    std::vector<std::pair<int, std::vector<std::string>>> values;
    std::vector<std::string> positionalArgs;
};

//! Parse the input arguments passed to main() and extract options as well as
//! positional arguments.
//!
//! Options are supposed to be passed to main() with a preceding hyphen '-'.
//!
//! If there is a single preceding hyphen, there should be exactly 1 character
//! after the hyphen, which is interpreted as the option.
//!
//! If there are 2 preceding hyphens, the entire argument (without the hyphens)
//! is interpreted as the option.
//!
//! If the option requires a value, the next argument is used as the value.
//!
//! Positional arguments must not start with a hyphen.
//!
//! If an argument requires a value, the next argument is interpreted as the
//! value, even if it is the form of a valid option (i.e. --foo --bar will store
//! "--bar" as a value for option "foo" if "foo" requires a value).
//! We also support --name=value syntax. In this case, 'value' would be used as
//! the value, NOT the next argument.
//!
//! For options:
//!   { { 'a', "", false },
//!     { 'b', "", false },
//!     { 0, "cee", false },
//!     { 'd', "", true },
//!     { 'e', "", true },
//!     { 'f', "foo", true } }
//!
//! ./main hello world -a -a --cee -d 12 -f 34
//! and
//! ./main hello world -a -a --cee -d 12 --foo 34
//!
//! will result in:
//!
//! TRTParsedArgs {
//!      errMsg: "",
//!      values: { { 2, {} },
//!                { 0, {} },
//!                { 1, {} },
//!                { 1, {"12"} },
//!                { 0, {} },
//!                { 1, {"34"} } }
//!      positionalArgs: {"hello", "world"},
//! }
//!
//! Non-POSIX behavior:
//!      - Does not support "-abcde" as a shorthand for "-a -b -c -d -e". Each
//!        option must have its own hyphen prefix.
//!      - Does not support -e12 as a shorthand for "-e 12". Values MUST be
//!        whitespace-separated from the option it is for.
//!
//! @param[in] argc The number of arguments passed to main (including the
//!            file name, which is disregarded)
//! @param[in] argv The arguments passed to main (including the file name,
//!            which is disregarded)
//! @param[in] options List of TRTOptions to parse
//! @return TRTParsedArgs. See TRTParsedArgs documentation for descriptions of
//!         the fields.
TRTParsedArgs getOptions(int argc, const char* const* argv, const std::vector<TRTOption>& options);
} // namespace utility
} // namespace nvinfer1

#endif // TRT_GET_OPTIONS_H
