theany/argument-parser
1
0
Fork 0
mirror of https://github.com/sametersoylu/argument-parser.git synced 2026-05-28 20:08:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: improve the readability of the generated help text. add type hints for the generation of the help text when description is not given for the variable. use sfinae for the check so that it compiles if not given.

Browse Source
This commit is contained in:
killua
2026-03-16 21:50:05 +04:00
parent d5b99ef407
commit 8e502bcb8b
9 changed files with 190 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
src/source/conventions/implementations/gnu_argument_convention.cpp
View File

@@ -40,25 +40,26 @@ namespace argument_parser::conventions::implementations {
return {}; // no fallback allowed
}
std::string gnu_argument_convention::make_help_text(std::string const &short_arg, std::string const &long_arg,
bool requires_value) const {
std::string res = "";
std::pair<std::string, std::string> gnu_argument_convention::make_help_text(std::string const &short_arg,
std::string const &long_arg,
bool requires_value) const {
std::string s_part = "";
if (short_arg != "-" && short_arg != "") {
res += short_prec() + short_arg;
s_part += short_prec() + short_arg;
if (requires_value) {
res += " <value>";
s_part += " <value>";
}
}
std::string l_part = "";
if (long_arg != "-" && long_arg != "") {
if (!res.empty()) {
res += ", ";
}
res += long_prec() + long_arg;
l_part += long_prec() + long_arg;
if (requires_value) {
res += " <value>";
l_part += " <value>";
}
}
return res;
return {s_part, l_part};
}
} // namespace argument_parser::conventions::implementations
@@ -97,26 +98,26 @@ namespace argument_parser::conventions::implementations {
return "--";
}
std::string gnu_equal_argument_convention::make_help_text(std::string const &short_arg, std::string const &long_arg,
bool requires_value) const {
std::string res = "";
std::pair<std::string, std::string> gnu_equal_argument_convention::make_help_text(std::string const &short_arg,
std::string const &long_arg,
bool requires_value) const {
std::string s_part = "";
if (short_arg != "-" && short_arg != "") {
res += short_prec() + short_arg;
s_part += short_prec() + short_arg;
if (requires_value) {
res += "=<value>";
}
}
if (long_arg != "-" && long_arg != "") {
if (!res.empty()) {
res += ", ";
}
res += long_prec() + long_arg;
if (requires_value) {
res += "=<value>";
s_part += "=<value>";
}
}
return res;
std::string l_part = "";
if (long_arg != "-" && long_arg != "") {
l_part += long_prec() + long_arg;
if (requires_value) {
l_part += "=<value>";
}
}
return {s_part, l_part};
}
std::vector<convention_features> gnu_equal_argument_convention::get_features() const {

41
src/source/conventions/implementations/windows_argument_convention.cpp
View File

@@ -50,27 +50,25 @@ namespace argument_parser::conventions::implementations {
return "/";
}
std::string windows_argument_convention::make_help_text(std::string const &short_arg, std::string const &long_arg,
std::pair<std::string, std::string> windows_argument_convention::make_help_text(std::string const &short_arg, std::string const &long_arg,
bool requires_value) const {
std::string res = "";
std::string s_part = "";
if (short_arg != "-" && short_arg != "") {
res += short_prec() + short_arg;
s_part += short_prec() + short_arg;
if (requires_value) {
res += " <value>";
s_part += " <value>";
}
}
std::string l_part = "";
if (long_arg != "-" && long_arg != "") {
if (!res.empty()) {
res += ", ";
}
res += long_prec() + long_arg;
l_part += long_prec() + long_arg;
if (requires_value) {
res += " <value>";
l_part += " <value>";
}
}
return res;
return {s_part, l_part};
}
std::vector<convention_features> windows_argument_convention::get_features() const {
@@ -130,30 +128,25 @@ namespace argument_parser::conventions::implementations {
return "/";
}
std::string windows_kv_argument_convention::make_help_text(std::string const &short_arg,
std::pair<std::string, std::string> windows_kv_argument_convention::make_help_text(std::string const &short_arg,
std::string const &long_arg, bool requires_value) const {
std::string res = "";
std::string s_part = "";
if (short_arg != "-" && short_arg != "") {
res += short_prec() + short_arg;
s_part += short_prec() + short_arg;
if (requires_value) {
res += "=<value>";
res += ", " + short_prec() + short_arg;
res += ":<value>";
s_part += "=<value>, " + short_prec() + short_arg + ":<value>";
}
}
std::string l_part = "";
if (long_arg != "-" && long_arg != "") {
if (!res.empty()) {
res += ", ";
}
res += long_prec() + long_arg;
l_part += long_prec() + long_arg;
if (requires_value) {
res += "=<value>"
", " +
long_prec() + long_arg + ":<value>";
l_part += "=<value>, " + long_prec() + long_arg + ":<value>";
}
}
return res;
return {s_part, l_part};
}
std::vector<convention_features> windows_kv_argument_convention::get_features() const {

59
src/source/parser/argument_parser.cpp
View File

@@ -1,6 +1,7 @@
#include "argument_parser.hpp"
#include <functional>
#include <iomanip>
#include <iostream>
#include <optional>
#include <sstream>
@@ -86,23 +87,56 @@ namespace argument_parser {
std::stringstream ss;
ss << "Usage: " << program_name << " [OPTIONS]...\n";
size_t max_short_len = 0;
size_t max_long_len = 0;
struct arg_help_info_t {
std::vector<std::pair<std::string, std::string>> convention_parts;
std::string desc;
};
std::vector<arg_help_info_t> help_lines;
for (auto const &[id, arg] : argument_map) {
auto short_arg =
reverse_short_arguments.find(id) != reverse_short_arguments.end() ? reverse_short_arguments.at(id) : "";
auto long_arg =
reverse_long_arguments.find(id) != reverse_long_arguments.end() ? reverse_long_arguments.at(id) : "";
ss << "\t";
std::vector<std::pair<std::string, std::string>> parts;
std::unordered_set<std::string> hasOnce;
for (auto const &convention : convention_types) {
auto generatedHelpText = convention->make_help_text(short_arg, long_arg, arg.expects_parameter());
if (hasOnce.find(generatedHelpText) == hasOnce.end()) {
ss << generatedHelpText << "\t";
hasOnce.insert(generatedHelpText);
auto generatedParts = convention->make_help_text(short_arg, long_arg, arg.expects_parameter());
std::string combined = generatedParts.first + "|" + generatedParts.second;
if (hasOnce.find(combined) == hasOnce.end()) {
parts.push_back(generatedParts);
hasOnce.insert(combined);
if (generatedParts.first.length() > max_short_len) {
max_short_len = generatedParts.first.length();
}
if (generatedParts.second.length() > max_long_len) {
max_long_len = generatedParts.second.length();
}
} else {
parts.push_back({"", ""}); // trigger empty space in the help text
}
}
ss << arg.help_text << "\n";
help_lines.push_back({parts, arg.help_text});
}
for (auto const &line : help_lines) {
ss << "\t";
for (size_t i = 0; i < line.convention_parts.size(); ++i) {
auto const &parts = line.convention_parts[i];
if (i > 0) {
ss << " ";
}
ss << std::left << std::setw(static_cast<int>(max_short_len)) << parts.first << " "
<< std::setw(static_cast<int>(max_long_len)) << parts.second;
}
ss << "\t" << line.desc << "\n";
}
return ss.str();
}
@@ -313,7 +347,18 @@ namespace argument_parser {
for (auto const &[s, l, p] : required_args) {
std::cerr << "\t" << get_one_name(s, l) << ": must be provided as one of [";
for (auto it = convention_types.begin(); it != convention_types.end(); ++it) {
std::cerr << (*it)->make_help_text(s, l, p);
auto generatedParts = (*it)->make_help_text(s, l, p);
std::string help_str = generatedParts.first;
if (!generatedParts.first.empty() && !generatedParts.second.empty()) {
help_str += " ";
}
help_str += generatedParts.second;
size_t last_not_space = help_str.find_last_not_of(" \t");
if (last_not_space != std::string::npos) {
help_str.erase(last_not_space + 1);
}
std::cerr << help_str;
if (it + 1 != convention_types.end()) {
std::cerr << ", ";
}