Skip to content

Commit

Permalink
[MISC] Use vector for arguments
Browse files Browse the repository at this point in the history
  • Loading branch information
@eseiler
eseiler committed Feb 12, 2024
1 parent 0f91e17 commit 9c33c36
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 52 deletions.
7 changes: 2 additions & 5 deletions include/sharg/detail/format_parse.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,10 @@ class format_parse : public format_base
~format_parse() = default; //!< Defaulted.

/*!\brief The constructor of the parse format.
* \param[in] argc_ The number of command line arguments.
* \param[in] argv_ The command line arguments to parse.
*/
format_parse(int const argc_, std::vector<std::string> argv_) : argv{std::move(argv_)}
{
(void)argc_;
}
format_parse(std::vector<std::string> argv_) : argv{std::move(argv_)}
{}
//!\}

/*!\brief Adds an sharg::detail::get_option call to be evaluated later on.
Expand Down
104 changes: 57 additions & 47 deletions include/sharg/parser.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -165,8 +165,7 @@ class parser
/*!\brief Initializes an sharg::parser object from the command line arguments.
*
* \param[in] app_name The name of the app that is displayed on the help page.
* \param[in] argc The number of command line arguments.
* \param[in] argv The command line arguments to parse.
* \param[in] arguments The command line arguments to parse.
* \param[in] version_updates Notify users about version updates (default sharg::update_notifications::on).
* \param[in] subcommands A list of subcommands (see \link subcommand_parse subcommand parsing \endlink).
*
Expand All @@ -182,12 +181,12 @@ class parser
* \stableapi{Since version 1.0.}
*/
parser(std::string const & app_name,
int const argc,
char const * const * const argv,
std::vector<std::string> const & arguments,
update_notifications version_updates = update_notifications::on,
std::vector<std::string> subcommands = {}) :
version_check_dev_decision{version_updates},
subcommands{std::move(subcommands)}
subcommands{std::move(subcommands)},
original_arguments{arguments}
{
for (auto & sub : this->subcommands)
{
Expand All @@ -200,9 +199,18 @@ class parser

info.app_name = app_name;

init(argc, argv);
init();
}

//!\overload
parser(std::string const & app_name,
int const argc,
char const * const * const argv,
update_notifications version_updates = update_notifications::on,
std::vector<std::string> subcommands = {}) :
parser{app_name, std::vector<std::string>{argv, argv + argc}, version_updates, std::move(subcommands)}
{}

//!\brief The destructor.
~parser()
{
Expand Down Expand Up @@ -720,20 +728,18 @@ class parser
//!\brief The command line arguments.
std::vector<std::string> cmd_arguments{};

//!\brief The original command line arguments.
std::vector<std::string> original_arguments{};

//!\brief The command that lead to calling this parser, e.g. [./build/bin/raptor, build]
std::vector<std::string> executable_name{};

/*!\brief Initializes the sharg::parser class on construction.
*
* \param[in] argc The number of command line arguments.
* \param[in] argv The command line arguments.
*
* \throws sharg::too_few_arguments if option --export-help was specified without a value
* \throws sharg::too_few_arguments if option --version-check was specified without a value
* \throws sharg::validation_error if the value passed to option --export-help was invalid.
* \throws sharg::validation_error if the value passed to option --version-check was invalid.
* \throws sharg::too_few_arguments if a sub parser was configured at construction but a subcommand is missing.
*
* \details
*
* This function adds all command line parameters to the cmd_arguments member variable
Expand All @@ -755,27 +761,34 @@ class parser
*
* If `--export-help` is specified with a value other than html, man, cwl or ctd, an sharg::parser_error is thrown.
*/
void init(int argc, char const * const * const argv)
void init()
{
assert(argc > 0);
executable_name.emplace_back(argv[0]);
assert(!original_arguments.empty());

executable_name.emplace_back(original_arguments[0]);

bool special_format_was_set{false};

for (int i = 1, argv_len = argc; i < argv_len; ++i) // start at 1 to skip binary name
// Helper function for going to the next argument. This makes it more obvious that we are
// incrementing `it` (version-check, and export-help).
auto go_to_next_arg = [this](auto & it, std::string_view message) -> auto
{
if (++it == original_arguments.end())
throw too_few_arguments{message.data()};
};

// start at 1 to skip binary name
for (auto it = ++original_arguments.begin(); it != original_arguments.end(); ++it)
{
std::string_view arg{argv[i]};
std::string_view arg{*it};

if (!subcommands.empty()) // this is a top_level parser
{
if (std::ranges::find(subcommands, arg) != subcommands.end()) // identified subparser
{
// LCOV_EXCL_START
sub_parser = std::make_unique<parser>(info.app_name + "-" + arg.data(),
argc - i,
argv + i,
std::vector<std::string>{it, original_arguments.end()},
update_notifications::off);
// LCOV_EXCL_STOP

// Add the original calls to the front, e.g. ["raptor"],
// s.t. ["raptor", "build"] will be the list after constructing the subparser
Expand All @@ -790,38 +803,47 @@ class parser
// Flags starting with '-' are allowed for the top-level parser.
// Otherwise, this is a wrongly spelled subcommand. The error will be thrown in parse().
if (!arg.empty() && arg[0] != '-')
{
cmd_arguments.emplace_back(arg);
break;
}
}
}

if (arg == "-h" || arg == "--help")
{
format = detail::format_help{subcommands, version_check_dev_decision, false};
special_format_was_set = true;
format = detail::format_help{subcommands, version_check_dev_decision, false};
}
else if (arg == "-hh" || arg == "--advanced-help")
{
format = detail::format_help{subcommands, version_check_dev_decision, true};
special_format_was_set = true;
format = detail::format_help{subcommands, version_check_dev_decision, true};
}
else if (arg == "--version")
{
special_format_was_set = true;
format = detail::format_version{};
}
else if (arg == "--copyright")
{
special_format_was_set = true;
format = detail::format_copyright{};
}
else if (arg.substr(0, 13) == "--export-help") // --export-help=man is also allowed
{
std::string export_format;
special_format_was_set = true;

std::string_view export_format;

if (arg.size() > 13)
{
export_format = arg.substr(14);
}
else
{
if (argv_len <= i + 1)
throw too_few_arguments{"Option --export-help must be followed by a value."};
export_format = std::string{argv[i + 1]};
go_to_next_arg(it, "Option --export-help must be followed by a value.");
export_format = *it;
}

if (export_format == "html")
Expand All @@ -836,46 +858,34 @@ class parser
throw validation_error{"Validation failed for option --export-help: "
"Value must be one of "
+ detail::supported_exports + "."};
special_format_was_set = true;
}
else if (arg == "--copyright")
{
format = detail::format_copyright{};
special_format_was_set = true;
}
else if (arg == "--version-check")
{
if (++i >= argv_len)
throw too_few_arguments{"Option --version-check must be followed by a value."};

arg = argv[i];
go_to_next_arg(it, "Option --version-check must be followed by a value.");
arg = *it;

if (arg == "1" || arg == "true")
version_check_user_decision = true;
else if (arg == "0" || arg == "false")
version_check_user_decision = false;
else
throw validation_error{"Value for option --version-check must be true (1) or false (0)."};

// in case --version-check is specified it shall not be passed to format_parse()
argc -= 2;
}
else
{
cmd_arguments.emplace_back(arg);
}
}

// all special options have been identified, which might involve deleting them from argv (e.g. version-check)
// check if no actual options remain and then call the short help page.
if (argc <= 1) // no arguments provided
{
format = detail::format_short_help{};
if (special_format_was_set)
return;
}

if (!special_format_was_set)
format = detail::format_parse(argc, cmd_arguments);
// All special options have been handled. If there are no arguments left and we do not have a subparser,
// we call the short help.
if (cmd_arguments.empty() && !sub_parser)
format = detail::format_short_help{};
else
format = detail::format_parse(cmd_arguments);
}

/*!\brief Checks whether the long identifier has already been used before.
Expand Down

0 comments on commit 9c33c36

Please sign in to comment.