2023-07-29 02:03:28 -04:00
|
|
|
/*
|
|
|
|
* Created by Brett on 28/07/23.
|
|
|
|
* Licensed under GNU General Public License V3.0
|
|
|
|
* See LICENSE file for license detail
|
|
|
|
*/
|
|
|
|
#include <blt/parse/argparse.h>
|
2023-07-29 14:04:46 -04:00
|
|
|
#include "blt/std/logging.h"
|
2023-07-29 02:03:28 -04:00
|
|
|
|
|
|
|
namespace blt::parser {
|
|
|
|
|
2023-08-01 13:43:00 -04:00
|
|
|
arg_vector_t::arg_vector_t(const std::vector<std::string>& args) {
|
2023-07-29 02:03:28 -04:00
|
|
|
for (auto& arg : args)
|
|
|
|
insertAndSort(arg);
|
|
|
|
}
|
|
|
|
|
2023-08-01 13:43:00 -04:00
|
|
|
arg_vector_t::arg_vector_t(std::initializer_list<std::string> args) {
|
2023-07-29 02:03:28 -04:00
|
|
|
for (auto& arg : args)
|
|
|
|
insertAndSort(arg);
|
|
|
|
}
|
|
|
|
|
2023-08-01 13:43:00 -04:00
|
|
|
arg_vector_t::arg_vector_t(const std::string& arg) {
|
2023-07-29 02:03:28 -04:00
|
|
|
insertAndSort(arg);
|
|
|
|
}
|
|
|
|
|
2023-08-01 13:43:00 -04:00
|
|
|
arg_vector_t::arg_vector_t(const char* arg) {
|
2023-07-29 02:03:28 -04:00
|
|
|
insertAndSort(arg);
|
|
|
|
}
|
|
|
|
|
2023-08-01 13:43:00 -04:00
|
|
|
arg_vector_t& arg_vector_t::operator=(const std::string& arg) {
|
2023-07-29 02:03:28 -04:00
|
|
|
insertAndSort(arg);
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
2023-08-01 13:43:00 -04:00
|
|
|
arg_vector_t& arg_vector_t::operator=(const char* arg) {
|
2023-07-29 02:03:28 -04:00
|
|
|
insertAndSort(arg);
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
2023-08-01 13:43:00 -04:00
|
|
|
arg_vector_t& arg_vector_t::operator=(std::initializer_list<std::string>& args) {
|
2023-07-29 02:03:28 -04:00
|
|
|
for (auto& arg : args)
|
|
|
|
insertAndSort(arg);
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
2023-08-01 13:43:00 -04:00
|
|
|
arg_vector_t& arg_vector_t::operator=(std::vector<std::string>& args) {
|
2023-07-29 02:03:28 -04:00
|
|
|
for (auto& arg : args)
|
|
|
|
insertAndSort(arg);
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
2023-08-01 13:43:00 -04:00
|
|
|
void arg_vector_t::insertAndSort(const std::string& str) {
|
2023-07-29 02:03:28 -04:00
|
|
|
if (str.starts_with('-'))
|
|
|
|
flags.push_back(str);
|
|
|
|
else
|
|
|
|
names.push_back(str);
|
|
|
|
}
|
|
|
|
|
2023-08-01 13:43:00 -04:00
|
|
|
arg_nargs_t::arg_nargs_t(char c) {
|
2023-07-29 02:03:28 -04:00
|
|
|
decode(c);
|
|
|
|
}
|
|
|
|
|
2023-08-01 13:43:00 -04:00
|
|
|
arg_nargs_t::arg_nargs_t(std::string s) {
|
2023-07-29 02:03:28 -04:00
|
|
|
decode(s[0]);
|
|
|
|
}
|
|
|
|
|
2023-08-01 13:43:00 -04:00
|
|
|
arg_nargs_t::arg_nargs_t(const char* s) {
|
2023-07-29 02:03:28 -04:00
|
|
|
decode(*s);
|
|
|
|
}
|
|
|
|
|
2023-08-01 13:43:00 -04:00
|
|
|
arg_nargs_t& arg_nargs_t::operator=(const std::string& s) {
|
2023-07-29 02:03:28 -04:00
|
|
|
decode(s[0]);
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
2023-08-01 13:43:00 -04:00
|
|
|
arg_nargs_t& arg_nargs_t::operator=(char c) {
|
2023-07-29 02:03:28 -04:00
|
|
|
decode(c);
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
2023-08-01 13:43:00 -04:00
|
|
|
arg_nargs_t& arg_nargs_t::operator=(int a) {
|
2023-07-29 02:03:28 -04:00
|
|
|
args = a;
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
2023-08-01 13:43:00 -04:00
|
|
|
arg_nargs_t& arg_nargs_t::operator=(const char* s) {
|
2023-07-29 02:03:28 -04:00
|
|
|
decode(*s);
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
2023-08-01 13:43:00 -04:00
|
|
|
void arg_nargs_t::decode(char c) {
|
2023-07-29 02:03:28 -04:00
|
|
|
if (c == '?')
|
2023-08-01 13:43:00 -04:00
|
|
|
flags = UNKNOWN;
|
|
|
|
else if (c == '+')
|
|
|
|
flags = ALL_REQUIRED;
|
|
|
|
else if (c == '*')
|
|
|
|
flags = ALL;
|
|
|
|
else
|
|
|
|
flags = 0;
|
2023-07-29 02:03:28 -04:00
|
|
|
}
|
2023-07-29 13:38:19 -04:00
|
|
|
|
2023-08-01 13:43:00 -04:00
|
|
|
arg_tokenizer_t::arg_tokenizer_t(size_t argc, const char** argv) {
|
2023-07-29 13:38:19 -04:00
|
|
|
for (size_t i = 0; i < argc; i++)
|
|
|
|
args.emplace_back(argv[i]);
|
|
|
|
}
|
|
|
|
|
2023-08-01 13:43:00 -04:00
|
|
|
bool argparse::validateArgument(const arg_properties_t& args) {
|
2023-07-29 14:04:46 -04:00
|
|
|
return !args.a_flags.getFlags().empty() ^ !args.a_flags.getNames().empty();
|
|
|
|
}
|
2023-07-29 13:38:19 -04:00
|
|
|
|
2023-08-01 13:43:00 -04:00
|
|
|
void argparse::addArgument(const arg_properties_t& args) {
|
2023-07-29 14:04:46 -04:00
|
|
|
if (!validateArgument(args)) {
|
|
|
|
BLT_WARN("Argument contains both flags and positional names, this is not allowed!");
|
|
|
|
BLT_WARN("(Discarding argument)");
|
|
|
|
return;
|
|
|
|
}
|
2023-07-30 14:04:59 -04:00
|
|
|
// store one copy of the properties (arg properties could in theory be very large!)
|
2023-08-01 13:43:00 -04:00
|
|
|
auto pos = user_args.arg_storage.size();
|
|
|
|
user_args.arg_storage.push_back(args);
|
|
|
|
auto& arg = user_args.arg_storage[pos];
|
2023-07-30 14:04:59 -04:00
|
|
|
// associate the arg properties per name and flag to allow for quick access when parsing
|
|
|
|
auto& names = args.a_flags.getNames();
|
|
|
|
for (const auto& name : names)
|
2023-08-01 13:43:00 -04:00
|
|
|
user_args.name_associations.emplace_back(name, &arg);
|
2023-07-30 14:04:59 -04:00
|
|
|
|
|
|
|
auto& flags = args.a_flags.getFlags();
|
|
|
|
for (const auto& flag : flags)
|
2023-08-01 13:43:00 -04:00
|
|
|
user_args.flag_associations[flag] = &arg;
|
|
|
|
|
|
|
|
if (args.a_required)
|
|
|
|
user_args.required_vars.insert(args.a_flags);
|
2023-07-30 14:04:59 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
const argparse::arg_results& argparse::parse_args(int argc, const char** argv) {
|
|
|
|
loaded_args = {};
|
2023-08-01 13:43:00 -04:00
|
|
|
arg_tokenizer_t arg_tokenizer(argc, argv);
|
|
|
|
loaded_args.program_name = arg_tokenizer.next();
|
|
|
|
BLT_TRACE("Loading args for %s", loaded_args.program_name.c_str());
|
2023-07-30 14:04:59 -04:00
|
|
|
|
2023-08-01 13:43:00 -04:00
|
|
|
size_t last_positional;
|
|
|
|
while (arg_tokenizer.hasNext()) {
|
|
|
|
// a token isn't a flag it must be a positional arg as flags will consume nargs
|
|
|
|
if (!arg_tokenizer.isFlag()){
|
|
|
|
handlePositionalArgument(arg_tokenizer, last_positional);
|
2023-07-31 13:53:10 -04:00
|
|
|
continue;
|
|
|
|
}
|
2023-08-01 13:43:00 -04:00
|
|
|
handleFlagArgument(arg_tokenizer);
|
2023-07-31 13:53:10 -04:00
|
|
|
}
|
|
|
|
|
2023-07-30 14:04:59 -04:00
|
|
|
return loaded_args;
|
2023-07-29 13:38:19 -04:00
|
|
|
}
|
2023-07-29 14:04:46 -04:00
|
|
|
|
2023-08-01 13:43:00 -04:00
|
|
|
void argparse::printHelp() {
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
void argparse::handlePositionalArgument(arg_tokenizer_t& arg_tokenizer, size_t& last_pos) {
|
|
|
|
// TODO:
|
|
|
|
loaded_args.positional_args[user_args.name_associations[last_pos++].first] = arg_tokenizer.next();
|
|
|
|
}
|
|
|
|
|
|
|
|
void argparse::handleFlagArgument(arg_tokenizer_t& arg_tokenizer) {
|
|
|
|
// token is a flag, find out special information about it
|
|
|
|
auto flag = arg_tokenizer.next();
|
|
|
|
|
|
|
|
auto loc = user_args.flag_associations.find(flag);
|
|
|
|
if (loc == user_args.flag_associations.end()){
|
|
|
|
BLT_WARN("Flag '%s' not an option!");
|
|
|
|
printHelp();
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
auto flag_properties = loc->second;
|
|
|
|
|
|
|
|
arg_data_t data;
|
|
|
|
switch(flag_properties->a_action){
|
|
|
|
case arg_action_t::HELP:
|
|
|
|
printHelp();
|
|
|
|
break;
|
|
|
|
case arg_action_t::STORE:
|
|
|
|
break;
|
|
|
|
case arg_action_t::STORE_CONST:
|
|
|
|
data = flag_properties->a_const;
|
|
|
|
break;
|
|
|
|
case arg_action_t::STORE_FALSE:
|
|
|
|
data = false;
|
|
|
|
break;
|
|
|
|
case arg_action_t::STORE_TRUE:
|
|
|
|
data = true;
|
|
|
|
break;
|
|
|
|
case arg_action_t::APPEND:
|
|
|
|
if (holds_alternative<std::vector<std::string>>(data)){
|
|
|
|
auto& l = get<std::vector<std::string>>(data);
|
|
|
|
|
|
|
|
} else
|
|
|
|
BLT_WARN("Requested append to data which doesn't contain a list!");
|
|
|
|
break;
|
|
|
|
case arg_action_t::APPEND_CONST:
|
|
|
|
break;
|
|
|
|
case arg_action_t::COUNT:
|
|
|
|
break;
|
|
|
|
case arg_action_t::EXTEND:
|
|
|
|
break;
|
|
|
|
case arg_action_t::VERSION:
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
loaded_args.flag_args[flag_properties->a_flags] = data;
|
|
|
|
}
|
|
|
|
|
|
|
|
bool argparse::consumeFlagArguments(arg_tokenizer_t& arg_tokenizer, const arg_properties_t& properties, arg_data_t& arg_data) {
|
|
|
|
// since the function is called after the flag is consumed, isFlag()/ will return information about the next arg
|
|
|
|
if (properties.a_nargs.flags) {
|
|
|
|
|
|
|
|
} else {
|
|
|
|
if (arg_tokenizer.isFlag())
|
|
|
|
return false;
|
|
|
|
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2023-07-29 14:04:46 -04:00
|
|
|
|
2023-07-29 02:03:28 -04:00
|
|
|
}
|