theany/argument-parser
1
0
Fork 0
mirror of https://github.com/sametersoylu/argument-parser.git synced 2026-04-13 03:41:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2 from sametersoylu/v3/clearapi

Browse Source 
V3/clearapi
This commit is contained in:
Abdüssamet ERSOYLU
2026-03-16 18:10:46 +04:00
committed by GitHub
parent 061581c510 a12840b241
commit 282c1c6314
34 changed files with 1521 additions and 1323 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
.clang-format Normal file
View File

@@ -0,0 +1,12 @@
---
Language: Cpp
BasedOnStyle: LLVM
UseTab: Always
TabWidth: 4
IndentWidth: 4
NamespaceIndentation: All
AccessModifierOffset: -4
BreakBeforeBraces: Attach
AllowShortFunctionsOnASingleLine: Empty
ColumnLimit: 120
...

18
CMakeLists.txt
View File

@@ -2,18 +2,20 @@ cmake_minimum_required(VERSION 3.15)
project(argument_parser) project(argument_parser)
set(CMAKE_CXX_STANDARD 23) set(CMAKE_CXX_STANDARD 17)
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/bin) set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/bin)
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_Release ${CMAKE_CURRENT_SOURCE_DIR}/bin/release) set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_Release ${CMAKE_CURRENT_SOURCE_DIR}/bin/release)
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_Debug ${CMAKE_CURRENT_SOURCE_DIR}/bin/debug) set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_Debug ${CMAKE_CURRENT_SOURCE_DIR}/bin/debug)
set(CMAKE_EXPORT_COMPILE_COMMANDS ON) set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
include_directories(include) include_directories(src/headers)
include_directories(include/parser) include_directories(src/headers/parser)
include_directories(include/conventions) include_directories(src/headers/conventions)
include_directories(include/conventions/implementations) include_directories(src/headers/conventions/implementations)
include_directories(include/parser/platform_headers) include_directories(src/headers/parser/platform_headers)
include_directories(include/parser/parsing_traits) include_directories(src/headers/parser/parsing_traits)
add_executable(test src/main.cpp) file(GLOB_RECURSE SRC_FILES "src/source/*.cpp" "src/source/**/*.cpp" "src/source/**/**/*.cpp")
add_executable(test src/main.cpp ${SRC_FILES})

8
compile_commands.json
View File

@@ -1,8 +1,8 @@
[ [
{ {
"directory": "/Users/killua/Projects/argument-parser/build", "directory": "C:/Users/samet/Documents/CPP/argparser/argument-parser/build",
"command": "/usr/bin/clang++ -I/Users/killua/Projects/argument-parser/include -I/Users/killua/Projects/argument-parser/include/parser -I/Users/killua/Projects/argument-parser/include/conventions -I/Users/killua/Projects/argument-parser/include/conventions/implementations -I/Users/killua/Projects/argument-parser/include/parser/platform_headers -I/Users/killua/Projects/argument-parser/include/parser/parsing_traits -g -std=gnu++2b -arch arm64 -o CMakeFiles/test.dir/src/main.cpp.o -c /Users/killua/Projects/argument-parser/src/main.cpp", "command": "C:\\PROGRA~2\\MICROS~2\\18\\BUILDT~1\\VC\\Tools\\MSVC\\1450~1.357\\bin\\Hostx64\\x64\\cl.exe /nologo /TP -IC:\\Users\\samet\\Documents\\CPP\\argparser\\argument-parser\\src\\headers -IC:\\Users\\samet\\Documents\\CPP\\argparser\\argument-parser\\src\\headers\\parser -IC:\\Users\\samet\\Documents\\CPP\\argparser\\argument-parser\\src\\headers\\conventions -IC:\\Users\\samet\\Documents\\CPP\\argparser\\argument-parser\\src\\headers\\conventions\\implementations -IC:\\Users\\samet\\Documents\\CPP\\argparser\\argument-parser\\src\\headers\\parser\\platform_headers -IC:\\Users\\samet\\Documents\\CPP\\argparser\\argument-parser\\src\\headers\\parser\\parsing_traits /DWIN32 /D_WINDOWS /GR /EHsc /Zi /Ob0 /Od /RTC1 -std:c++17 -MDd /FoCMakeFiles\\test.dir\\src\\main.cpp.obj /FdCMakeFiles\\test.dir\\ /FS -c C:\\Users\\samet\\Documents\\CPP\\argparser\\argument-parser\\src\\main.cpp",
"file": "/Users/killua/Projects/argument-parser/src/main.cpp", "file": "C:/Users/samet/Documents/CPP/argparser/argument-parser/src/main.cpp",
"output": "/Users/killua/Projects/argument-parser/build/CMakeFiles/test.dir/src/main.cpp.o" "output": "C:/Users/samet/Documents/CPP/argparser/argument-parser/build/CMakeFiles/test.dir/src/main.cpp.obj"
} }
] ]

49
include/conventions/base_convention.hpp
View File

@@ -1,49 +0,0 @@
#pragma once
#include <string>
#include <algorithm>
#include <utility>
#ifndef BASE_CONVENTION_HPP
#define BASE_CONVENTION_HPP
namespace argument_parser::conventions {
enum class argument_type {
SHORT,
LONG,
POSITIONAL,
INTERCHANGABLE,
ERROR
};
using parsed_argument = std::pair<argument_type, std::string>;
class base_convention {
public:
virtual std::string extract_value(std::string const&) const = 0;
virtual parsed_argument get_argument(std::string const&) const = 0;
virtual bool requires_next_token() const = 0;
virtual std::string name() const = 0;
virtual std::string short_prec() const = 0;
virtual std::string long_prec() const = 0;
protected:
base_convention() = default;
~base_convention() = default;
};
using convention = base_convention;
}
namespace argument_parser::conventions::helpers {
static std::string to_lower(std::string s) {
std::transform(s.begin(), s.end(), s.begin(),
[](unsigned char c) { return std::tolower(c); });
return s;
}
static std::string to_upper(std::string s) {
std::transform(s.begin(), s.end(), s.begin(),
[](unsigned char c) { return std::toupper(c); });
return s;
}
}
#endif

98
include/conventions/implementations/gnu_argument_convention.hpp
View File

@@ -1,98 +0,0 @@
#pragma once
#include "base_convention.hpp"
#include <stdexcept>
#ifndef GNU_ARGUMENT_CONVENTION_HPP
#define GNU_ARGUMENT_CONVENTION_HPP
namespace argument_parser::conventions::implementations {
class gnu_argument_convention : public base_convention {
public:
parsed_argument get_argument(std::string const& raw) const override {
if (raw.starts_with(long_prec()))
return {argument_type::LONG, raw.substr(2)};
else if (raw.starts_with(short_prec()))
return {argument_type::SHORT, raw.substr(1)};
else
return {argument_type::ERROR, "GNU standard convention does not allow arguments without a preceding dash."};
}
std::string extract_value(std::string const& /*raw*/) const override {
// In non-equal GNU, value comes in next token
throw std::runtime_error("No inline value in standard GNU convention.");
}
bool requires_next_token() const override {
return true;
}
std::string name() const override {
return "GNU-style long options";
}
std::string short_prec() const override {
return "-";
}
std::string long_prec() const override {
return "--";
}
static gnu_argument_convention instance;
private:
gnu_argument_convention() = default;
};
class gnu_equal_argument_convention : public base_convention {
public:
parsed_argument get_argument(std::string const& raw) const override {
auto pos = raw.find('=');
auto arg = pos != std::string::npos ? raw.substr(0, pos) : raw;
if (arg.starts_with(long_prec()))
return {argument_type::LONG, arg.substr(2) };
else if (arg.starts_with(short_prec()))
return {argument_type::SHORT, arg.substr(1) };
else
return {argument_type::ERROR, "GNU standard convention does not allow arguments without a preceding dash."};
}
std::string extract_value(std::string const& raw) const override {
auto pos = raw.find('=');
if (pos == std::string::npos || pos + 1 >= raw.size())
throw std::runtime_error("Expected value after '='.");
return raw.substr(pos + 1);
}
bool requires_next_token() const override {
return false;
}
std::string name() const override {
return "GNU-style long options (equal signed form)";
}
std::string short_prec() const override {
return "-";
}
std::string long_prec() const override {
return "--";
}
static gnu_equal_argument_convention instance;
private:
gnu_equal_argument_convention() = default;
};
inline gnu_argument_convention gnu_argument_convention::instance{};
inline gnu_equal_argument_convention gnu_equal_argument_convention::instance{};
}
namespace argument_parser::conventions {
static inline const implementations::gnu_argument_convention gnu_argument_convention = implementations::gnu_argument_convention::instance;
static inline const implementations::gnu_equal_argument_convention gnu_equal_argument_convention = implementations::gnu_equal_argument_convention::instance;
}
#endif

120
include/conventions/implementations/windows_argument_convention.hpp
View File

@@ -1,120 +0,0 @@
#pragma once
#include "base_convention.hpp"
#include <stdexcept>
#ifndef WINDOWS_ARGUMENT_CONVENTION_HPP
#define WINDOWS_ARGUMENT_CONVENTION_HPP
#ifndef ALLOW_DASH_FOR_WINDOWS
#define ALLOW_DASH_FOR_WINDOWS 1
#endif
namespace argument_parser::conventions::implementations {
class windows_argument_convention : public base_convention {
public:
explicit windows_argument_convention(bool accept_dash = true)
: accept_dash_(accept_dash) {
}
parsed_argument get_argument(std::string const& raw) const override {
if (raw.empty()) {
return { argument_type::ERROR, "Empty argument token." };
}
const char c0 = raw[0];
const bool ok_prefix = (c0 == '/') || (accept_dash_ && c0 == '-');
if (!ok_prefix) {
return { argument_type::ERROR,
accept_dash_
? "Windows-style expects options to start with '/' (or '-' in compat mode)."
: "Windows-style expects options to start with '/'." };
}
if (raw.find_first_of("=:") != std::string::npos) {
return { argument_type::ERROR,
"Inline values are not allowed in this convention; provide the value in the next token." };
}
std::string name = helpers::to_lower(raw.substr(1));
if (name.empty()) {
return { argument_type::ERROR, "Option name cannot be empty after '/'." };
}
return { argument_type::INTERCHANGABLE, std::move(name) };
}
std::string extract_value(std::string const& /*raw*/) const override {
throw std::runtime_error("No inline value; value must be provided in the next token.");
}
bool requires_next_token() const override { return true; }
std::string name() const override { return "Windows style options (next-token values)"; }
std::string short_prec() const override { return accept_dash_ ? "-" : "/"; }
std::string long_prec() const override { return "/"; }
static windows_argument_convention instance;
private:
bool accept_dash_;
};
class windows_kv_argument_convention : public base_convention {
public:
explicit windows_kv_argument_convention(bool accept_dash = true)
: accept_dash_(accept_dash) {
}
parsed_argument get_argument(std::string const& raw) const override {
if (raw.empty()) {
return { argument_type::ERROR, "Empty argument token." };
}
const char c0 = raw[0];
const bool ok_prefix = (c0 == '/') || (accept_dash_ && c0 == '-');
if (!ok_prefix) {
return { argument_type::ERROR,
accept_dash_
? "Windows-style expects options to start with '/' (or '-' in compat mode)."
: "Windows-style expects options to start with '/'." };
}
const std::size_t sep = raw.find_first_of("=:");
if (sep == std::string::npos) {
return { argument_type::ERROR,
"Expected an inline value using '=' or ':' (e.g., /opt=value or /opt:value)." };
}
if (sep == 1) {
return { argument_type::ERROR, "Option name cannot be empty before '=' or ':'." };
}
std::string name = helpers::to_lower(raw.substr(1, sep - 1));
return { argument_type::INTERCHANGABLE, std::move(name) };
}
std::string extract_value(std::string const& raw) const override {
const std::size_t sep = raw.find_first_of("=:");
if (sep == std::string::npos || sep + 1 >= raw.size())
throw std::runtime_error("Expected a value after '=' or ':'.");
return raw.substr(sep + 1);
}
bool requires_next_token() const override { return false; }
std::string name() const override { return "Windows style options (inline values via '=' or ':')"; }
std::string short_prec() const override { return accept_dash_ ? "-" : "/"; }
std::string long_prec() const override { return "/"; }
static windows_kv_argument_convention instance;
private:
bool accept_dash_;
};
inline windows_argument_convention windows_argument_convention::instance = windows_argument_convention(bool(ALLOW_DASH_FOR_WINDOWS));
inline windows_kv_argument_convention windows_kv_argument_convention::instance = windows_kv_argument_convention(bool(ALLOW_DASH_FOR_WINDOWS));
}
namespace argument_parser::conventions {
static inline const implementations::windows_argument_convention windows_argument_convention = implementations::windows_argument_convention::instance;
static inline const implementations::windows_kv_argument_convention windows_equal_argument_convention = implementations::windows_kv_argument_convention::instance;
}
#endif // WINDOWS_ARGUMENT_CONVENTION_HPP

365
include/parser/argument_parser.hpp
View File

@@ -1,365 +0,0 @@
#pragma once
#include <list>
#include <optional>
#include <type_traits>
#ifndef ARGUMENT_PARSER_HPP
#define ARGUMENT_PARSER_HPP
#include <traits.hpp>
#include <base_convention.hpp>
#include <atomic>
#include <functional>
#include <initializer_list>
#include <iostream>
#include <sstream>
#include <stdexcept>
#include <string>
#include <unordered_map>
#include <utility>
#include <vector>
#include <any>
#include <ranges>
namespace argument_parser {
class action_base {
public:
virtual ~action_base() = default;
[[nodiscard]] virtual bool expects_parameter() const = 0;
virtual void invoke() const = 0;
virtual void invoke_with_parameter(const std::string& param) const = 0;
[[nodiscard]] virtual std::unique_ptr<action_base> clone() const = 0;
};
template <typename T>
class parametered_action : public action_base {
public:
explicit parametered_action(std::function<void(const T&)> const& handler) : handler(handler) {}
using parameter_type = T;
void invoke(const T& arg) const {
handler(arg);
}
[[nodiscard]] bool expects_parameter() const override { return true; }
void invoke() const override {
throw std::runtime_error("Parametered action requires a parameter");
}
void invoke_with_parameter(const std::string& param) const override {
T parsed_value = parsing_traits::parser_trait<T>::parse(param);
invoke(parsed_value);
}
[[nodiscard]] std::unique_ptr<action_base> clone() const override {
return std::make_unique<parametered_action<T>>(handler);
}
private:
std::function<void(const T&)> handler;
};
class non_parametered_action : public action_base {
public:
explicit non_parametered_action(std::function<void()> const& handler) : handler(handler) {}
void invoke() const override {
handler();
}
[[nodiscard]] bool expects_parameter() const override { return false; }
void invoke_with_parameter(const std::string& param) const override {
invoke();
}
[[nodiscard]] std::unique_ptr<action_base> clone() const override {
return std::make_unique<non_parametered_action>(handler);
}
private:
std::function<void()> handler;
};
class base_parser;
class argument {
public:
argument() : id(0), name(), action(std::make_unique<non_parametered_action>([](){})), required(false), invoked(false) {}
template <typename ActionType>
argument(const int id, std::string name, ActionType const& action)
: id(id), name(std::move(name)), action(action.clone()), required(false), invoked(false) {}
argument(const argument& other)
: id(other.id), name(other.name), action(other.action->clone()),
required(other.required), invoked(other.invoked), help_text(other.help_text) {}
argument& operator=(const argument& other) {
if (this != &other) {
id = other.id;
name = other.name;
action = other.action->clone();
required = other.required;
invoked = other.invoked;
help_text = other.help_text;
}
return *this;
}
argument(argument&& other) noexcept = default;
argument& operator=(argument&& other) noexcept = default;
[[nodiscard]] bool is_required() const { return required; }
[[nodiscard]] std::string get_name() const { return name; }
[[nodiscard]] bool is_invoked() const { return invoked; }
[[nodiscard]] bool expects_parameter() const {
return action->expects_parameter();
}
private:
void set_required(bool val) { required = val; }
void set_invoked(bool val) { invoked = val; }
void set_help_text(std::string const& text) { help_text = text; }
friend class base_parser;
int id;
std::string name;
std::unique_ptr<action_base> action;
bool required;
bool invoked;
std::string help_text;
};
namespace helpers {
template<typename T>
static parametered_action<T> make_parametered_action(std::function<void(const T&)> const& function) {
return parametered_action<T>(function);
}
static non_parametered_action make_non_parametered_action(std::function<void()> const& function) {
return non_parametered_action(function);
}
}
class base_parser {
public:
template <typename T>
void add_argument(std::string const& short_arg, std::string const& long_arg, std::string const& help_text, parametered_action<T> const& action, bool required) {
base_add_argument(short_arg, long_arg, help_text, action, required);
}
template<typename T>
void add_argument(std::string const& short_arg, std::string const& long_arg, std::string const& help_text, bool required) {
base_add_argument<T>(short_arg, long_arg, help_text, required);
}
void add_argument(std::string const& short_arg, std::string const& long_arg, std::string const& help_text, non_parametered_action const& action, bool required) {
base_add_argument(short_arg, long_arg, help_text, action, required);
}
void add_argument(std::string const& short_arg, std::string const& long_arg, std::string const& help_text, bool required) {
base_add_argument<void>(short_arg, long_arg, help_text, required);
}
void on_complete(std::function<void(base_parser const&)> const& action) {
on_complete_events.emplace_back(action);
}
template<typename T>
std::optional<T> get_optional(std::string const& arg) const {
auto id = find_argument_id(arg);
if (id.has_value()) {
auto value = stored_arguments.find(id.value());
if (value != stored_arguments.end() && value->second.has_value()) return std::any_cast<T>(value->second);
}
return std::nullopt;
}
[[nodiscard]] std::string build_help_text(std::initializer_list<conventions::convention const* const> convention_types) const {
std::stringstream ss;
ss << "Usage: " << program_name << " [OPTIONS]...\n";
for (auto const& [id, arg] : argument_map) {
auto short_arg = reverse_short_arguments.at(id);
auto long_arg = reverse_long_arguments.at(id);
ss << "\t";
ss << "-" << short_arg << ", --" << long_arg;
ss << "\t\t" << arg.help_text << "\n";
}
return ss.str();
}
argument& get_argument(conventions::parsed_argument const& arg) {
if (arg.first == conventions::argument_type::LONG) {
auto long_pos = long_arguments.find(arg.second);
if (long_pos != long_arguments.end()) return argument_map.at(long_pos->second);
} else if (arg.first == conventions::argument_type::SHORT) {
auto short_pos = short_arguments.find(arg.second);
if (short_pos != short_arguments.end()) return argument_map.at(short_pos->second);
} else if (arg.first == conventions::argument_type::INTERCHANGABLE) {
auto long_pos = long_arguments.find(arg.second);
if (long_pos != long_arguments.end()) return argument_map.at(long_pos->second);
auto short_pos = short_arguments.find(arg.second);
if (short_pos != short_arguments.end()) return argument_map.at(short_pos->second);
}
throw std::runtime_error("Unknown argument: " + arg.second);
}
[[nodiscard]] std::optional<int> find_argument_id(std::string const& arg) const {
auto long_pos = long_arguments.find(arg);
auto short_post = short_arguments.find(arg);
if (long_pos != long_arguments.end()) return long_pos->second;
if (short_post != short_arguments.end()) return short_post->second;
return std::nullopt;
}
void handle_arguments(std::initializer_list<conventions::convention const* const> convention_types) {
for (auto it = parsed_arguments.begin(); it != parsed_arguments.end(); ++it) {
std::stringstream error_stream;
bool arg_correctly_handled = false;
for (auto const& convention_type : convention_types) {
auto extracted = convention_type->get_argument(*it);
if (extracted.first == conventions::argument_type::ERROR) {
error_stream << "Convention \"" << convention_type->name() << "\" failed with: " << extracted.second << "\n";
continue;
}
try {
argument& corresponding_argument = get_argument(extracted);
if (corresponding_argument.expects_parameter()) {
if (convention_type->requires_next_token() && (it + 1) == parsed_arguments.end()) {
throw std::runtime_error("expected value for argument " + extracted.second);
}
auto value_raw = convention_type->requires_next_token() ? *(++it) : convention_type->extract_value(*it);
corresponding_argument.action->invoke_with_parameter(value_raw);
} else {
corresponding_argument.action->invoke();
}
corresponding_argument.set_invoked(true);
arg_correctly_handled = true;
break; // Convention succeeded, move to the next argument token
} catch (const std::runtime_error& e) {
error_stream << "Convention \"" << convention_type->name() << "\" failed with: " << e.what() << "\n";
}
}
if (!arg_correctly_handled) {
throw std::runtime_error("All trials for argument: \n\t\"" + *it + "\"\n failed with: \n" + error_stream.str());
}
}
check_for_required_arguments(convention_types);
fire_on_complete_events();
}
void display_help(std::initializer_list<conventions::convention const* const> convention_types) const {
std::cout << build_help_text(convention_types);
}
protected:
base_parser() = default;
std::string program_name;
std::vector<std::string> parsed_arguments;
private:
void assert_argument_not_exist(std::string const& short_arg, std::string const& long_arg) const {
if (short_arguments.contains(short_arg) || long_arguments.contains(long_arg)) {
throw std::runtime_error("The key already exists!");
}
}
static void set_argument_status(bool is_required, std::string const& help_text, argument& arg) {
arg.set_required(is_required);
arg.set_help_text(help_text);
}
void place_argument(int id, argument const& arg, std::string const& short_arg, std::string const& long_arg) {
argument_map[id] = arg;
short_arguments[short_arg] = id;
reverse_short_arguments[id] = short_arg;
long_arguments[long_arg] = id;
reverse_long_arguments[id] = long_arg;
}
template <typename ActionType>
void base_add_argument(std::string const& short_arg, std::string const& long_arg, std::string const& help_text, ActionType const& action, bool required) {
assert_argument_not_exist(short_arg, long_arg);
int id = id_counter.fetch_add(1);
argument arg(id, short_arg + "|" + long_arg, action);
set_argument_status(required, help_text, arg);
place_argument(id, arg, short_arg, long_arg);
}
template<typename StoreType = void>
void base_add_argument(std::string const& short_arg, std::string const& long_arg, std::string const& help_text, bool required) {
assert_argument_not_exist(short_arg, long_arg);
int id = id_counter.fetch_add(1);
if constexpr (std::is_same_v<StoreType, void>) {
auto action = helpers::make_non_parametered_action([id, this] { stored_arguments[id] = std::any{ true }; });
argument arg(id, short_arg + "|" + long_arg, action);
set_argument_status(required, help_text, arg);
place_argument(id, arg, short_arg, long_arg);
} else {
auto action = helpers::make_parametered_action<StoreType>([id, this](StoreType const& value) { stored_arguments[id] = std::any{ value }; });
argument arg(id, short_arg + "|" + long_arg, action);
set_argument_status(required, help_text, arg);
place_argument(id, arg, short_arg, long_arg);
}
}
void check_for_required_arguments(std::initializer_list<conventions::convention const* const> convention_types) {
std::vector<std::pair<std::string, std::string>> required_args;
for (const auto &arg: argument_map | std::views::values) {
if (arg.is_required() and not arg.is_invoked()) {
required_args.emplace_back<std::pair<std::string, std::string>>({
reverse_short_arguments[arg.id],
reverse_long_arguments[arg.id]
});
}
}
if (not required_args.empty()) {
std::cerr << "These arguments were expected but not provided: ";
for (auto const& [s, l] : required_args) {
std::cerr << "[-" << s << ", --" << l << "] ";
}
std::cerr << "\n";
display_help(convention_types);
}
}
void fire_on_complete_events() const {
for(auto const& event : on_complete_events) {
event(*this);
}
}
inline static std::atomic_int id_counter = 0;
std::unordered_map<int, std::any> stored_arguments;
std::unordered_map<int, argument> argument_map;
std::unordered_map<std::string, int> short_arguments;
std::unordered_map<int, std::string> reverse_short_arguments;
std::unordered_map<std::string, int> long_arguments;
std::unordered_map<int, std::string> reverse_long_arguments;
std::list<std::function<void(base_parser const&)>> on_complete_events;
friend class linux_parser;
friend class windows_parser;
friend class macos_parser;
friend class fake_parser;
};
}
#endif // ARGUMENT_PARSER_HPP

38
include/parser/fake_parser.hpp
View File

@@ -1,38 +0,0 @@
#pragma once
#ifndef FAKE_PARSER_HPP
#define FAKE_PARSER_HPP
#include <argument_parser.hpp>
#include <initializer_list>
#include <string>
namespace argument_parser {
class fake_parser : public base_parser {
public:
fake_parser() = default;
fake_parser(std::string program_name, std::vector<std::string> const& arguments) {
this->program_name = std::move(program_name);
parsed_arguments = arguments;
}
fake_parser(std::string const& program_name, std::vector<std::string>&& arguments) {
this->program_name = program_name;
parsed_arguments = std::move(arguments);
}
fake_parser(std::string const& program_name, std::initializer_list<std::string> const& arguments) :
fake_parser(program_name, std::vector<std::string>(arguments)) {}
void set_program_name(std::string const& program_name) {
this->program_name = program_name;
}
void set_parsed_arguments(std::vector<std::string> const& parsed_arguments) {
this->parsed_arguments = parsed_arguments;
}
};
}
#endif

249
include/parser/parser_v2.hpp
View File

@@ -1,249 +0,0 @@
#pragma once
#include <argument_parser.hpp>
#include <cstdlib>
#include <exception>
#include <fake_parser.hpp>
#include <initializer_list>
#include <iostream>
#include <memory>
#include <optional>
#include <stdexcept>
#include <string>
#include <string_view>
#include <unordered_map>
#include <variant>
#include <vector>
namespace argument_parser::v2 {
namespace internal {
static inline fake_parser fake_parser{};
}
enum class add_argument_flags {
ShortArgument,
LongArgument,
HelpText,
Action,
Required
};
namespace flags {
constexpr static inline add_argument_flags ShortArgument = add_argument_flags::ShortArgument;
constexpr static inline add_argument_flags LongArgument = add_argument_flags::LongArgument;
constexpr static inline add_argument_flags HelpText = add_argument_flags::HelpText;
constexpr static inline add_argument_flags Action = add_argument_flags::Action;
constexpr static inline add_argument_flags Required = add_argument_flags::Required;
}
class base_parser : private argument_parser::base_parser {
public:
template<typename T>
using typed_flag_value = std::variant<std::string, parametered_action<T>, bool>;
using non_typed_flag_value = std::variant<std::string, non_parametered_action, bool>;
template<typename T>
using typed_argument_pair = std::pair<add_argument_flags, typed_flag_value<T>>;
using non_typed_argument_pair = std::pair<add_argument_flags, non_typed_flag_value>;
template<typename T>
void add_argument(std::unordered_map<add_argument_flags, typed_flag_value<T>> const& argument_pairs) {
std::unordered_map<extended_add_argument_flags, bool> found_params {{
extended_add_argument_flags::IsTyped, true
}};
std::string short_arg, long_arg, help_text;
std::unique_ptr<action_base> action;
bool required = false;
if (argument_pairs.contains(add_argument_flags::ShortArgument)) {
found_params[extended_add_argument_flags::ShortArgument] = true;
short_arg = get_or_throw<std::string>(argument_pairs.at(add_argument_flags::ShortArgument), "short");
}
if (argument_pairs.contains(add_argument_flags::LongArgument)) {
found_params[extended_add_argument_flags::LongArgument] = true;
long_arg = get_or_throw<std::string>(argument_pairs.at(add_argument_flags::LongArgument), "long");
if (short_arg.empty()) short_arg = long_arg;
} else {
if (!short_arg.empty()) long_arg = short_arg;
}
if (argument_pairs.contains(add_argument_flags::Action)) {
found_params[extended_add_argument_flags::Action] = true;
action = get_or_throw<parametered_action<T>>(argument_pairs.at(add_argument_flags::Action), "action").clone();
}
if (argument_pairs.contains(add_argument_flags::HelpText)) {
help_text = get_or_throw<std::string>(argument_pairs.at(add_argument_flags::HelpText), "help");
} else {
help_text = short_arg + ", " + long_arg;
}
if (argument_pairs.contains(add_argument_flags::Required) && get_or_throw<bool>(argument_pairs.at(add_argument_flags::Required), "required")) {
required = true;
}
auto suggested_add = suggest_candidate(found_params);
if (suggested_add == candidate_type::unknown) {
throw std::runtime_error("Could not match any add argument overload to given parameters. Are you missing some required parameter?");
}
switch (suggested_add) {
case candidate_type::typed_action:
base::add_argument(short_arg, long_arg, help_text, *static_cast<parametered_action<T>*>(&(*action)), required);
break;
case candidate_type::store_other:
base::add_argument(short_arg, long_arg, help_text, required);
break;
default:
throw std::runtime_error("Could not match the arguments against any overload.");
}
}
template<typename T>
void add_argument(std::initializer_list<typed_argument_pair<T>> const& pairs) {
std::unordered_map<add_argument_flags, typed_flag_value<T>> args;
for (auto& [k, v]: pairs) {
args[k] = v;
}
add_argument<T>(args);
}
void add_argument(std::initializer_list<non_typed_argument_pair> const& pairs) {
std::unordered_map<add_argument_flags, non_typed_flag_value> args;
for (auto& [k, v] : pairs) {
args[k] = v;
}
add_argument(args);
}
void add_argument(std::unordered_map<add_argument_flags, non_typed_flag_value> const& argument_pairs) {
std::unordered_map<extended_add_argument_flags, bool> found_params {{
extended_add_argument_flags::IsTyped, false
}};
std::string short_arg, long_arg, help_text;
std::unique_ptr<action_base> action;
bool required = false;
if (argument_pairs.contains(add_argument_flags::ShortArgument)) {
found_params[extended_add_argument_flags::ShortArgument] = true;
short_arg = get_or_throw<std::string>(argument_pairs.at(add_argument_flags::ShortArgument), "short");
}
if (argument_pairs.contains(add_argument_flags::LongArgument)) {
found_params[extended_add_argument_flags::LongArgument] = true;
long_arg = get_or_throw<std::string>(argument_pairs.at(add_argument_flags::LongArgument), "long");
if (short_arg.empty()) short_arg = long_arg;
} else {
if (!short_arg.empty()) long_arg = short_arg;
}
if (argument_pairs.contains(add_argument_flags::Action)) {
found_params[extended_add_argument_flags::Action] = true;
action = get_or_throw<non_parametered_action>(argument_pairs.at(add_argument_flags::Action), "action").clone();
}
if (argument_pairs.contains(add_argument_flags::HelpText)) {
help_text = get_or_throw<std::string>(argument_pairs.at(add_argument_flags::HelpText), "help");
} else {
help_text = short_arg + ", " + long_arg;
}
if (argument_pairs.contains(add_argument_flags::Required) && get_or_throw<bool>(argument_pairs.at(add_argument_flags::Required), "required")) {
required = true;
}
auto suggested_add = suggest_candidate(found_params);
if (suggested_add == candidate_type::unknown) {
throw std::runtime_error("Could not match any add argument overload to given parameters. Are you missing some required parameter?");
}
switch (suggested_add) {
case candidate_type::non_typed_action:
base::add_argument(short_arg, long_arg, help_text, *static_cast<non_parametered_action*>(&(*action)), required);
break;
case candidate_type::store_boolean:
base::add_argument(short_arg, long_arg, help_text, required);
break;
default:
throw std::runtime_error("Could not match the arguments against any overload. The suggested candidate was: " + std::to_string((int(suggested_add))));
}
}
argument_parser::base_parser& to_v1() {
return *this;
}
void handle_arguments(std::initializer_list<conventions::convention const* const> convention_types) {
base::handle_arguments(convention_types);
}
template<typename T>
std::optional<T> get_optional(std::string const& arg) {
return base::get_optional<T>(arg);
}
void on_complete(std::function<void(argument_parser::base_parser const&)> const& action) {
base::on_complete(action);
}
protected:
void set_program_name(std::string p) {
base::program_name = std::move(p);
}
std::vector<std::string>& ref_parsed_args() {
return base::parsed_arguments;
}
private:
using base = argument_parser::base_parser;
enum class extended_add_argument_flags {
ShortArgument,
LongArgument,
Action,
IsTyped
};
enum class candidate_type {
store_boolean,
store_other,
typed_action,
non_typed_action,
unknown
};
template<typename T, size_t S>
bool satisfies_at_least_one(std::array<T, S> const& arr, std::unordered_map<T, bool> const& map) {
for (const auto& req: arr) {
if (map.contains(req)) return true;
}
return false;
}
candidate_type suggest_candidate(std::unordered_map<extended_add_argument_flags, bool> const& available_vars) {
auto constexpr required_at_least_one = std::array<extended_add_argument_flags, 2> { extended_add_argument_flags::ShortArgument, extended_add_argument_flags::LongArgument };
if (!satisfies_at_least_one(required_at_least_one, available_vars)) return candidate_type::unknown;
if (available_vars.contains(extended_add_argument_flags::Action)) {
if (available_vars.at(extended_add_argument_flags::IsTyped))
return candidate_type::typed_action;
else return candidate_type::non_typed_action;
}
if (available_vars.at(extended_add_argument_flags::IsTyped)) return candidate_type::store_other;
return candidate_type::store_boolean;
}
template<typename T, typename I>
T get_or_throw(typed_flag_value<I> const& v, std::string_view key) {
if (auto p = std::get_if<T>(&v)) return *p;
throw std::invalid_argument(std::string("variant type mismatch for key: ") + std::string(key));
}
template<typename T>
T get_or_throw(non_typed_flag_value const& v, std::string_view key) {
if (auto p = std::get_if<T>(&v)) return *p;
throw std::invalid_argument(std::string("variant type mismatch for key: ") + std::string(key));
}
};
}

53
include/parser/parsing_traits/traits.hpp
View File

@@ -1,53 +0,0 @@
#pragma once
#ifndef PARSING_TRAITS_HPP
#define PARSING_TRAITS_HPP
#include <string>
#include <stdexcept>
namespace argument_parser::parsing_traits {
template <typename T_>
struct parser_trait {
using type = T_;
static T_ parse(const std::string& input);
};
template <>
struct parser_trait<std::string> {
static std::string parse(const std::string& input) {
return input;
}
};
template<>
struct parser_trait<bool> {
static bool parse(const std::string& input) {
if (input == "t" || input == "true" || input == "1") return true;
if (input == "f" || input == "false" || input == "0") return false;
throw std::runtime_error("Invalid boolean value: " + input);
}
};
template <>
struct parser_trait<int> {
static int parse(const std::string& input) {
return std::stoi(input);
}
};
template <>
struct parser_trait<float> {
static float parse(const std::string& input) {
return std::stof(input);
}
};
template <>
struct parser_trait<double> {
static double parse(const std::string& input) {
return std::stod(input);
}
};
}
#endif

25
include/parser/platform_headers/linux_parser.hpp
View File

@@ -1,25 +0,0 @@
#pragma once
#ifdef __linux__
#ifndef LINUX_PARSER_HPP
#define LINUX_PARSER_HPP
#include <fstream>
#include <string>
#include <argument_parser.hpp>
namespace argument_parser {
class linux_parser : public base_parser {
public:
linux_parser() {
std::ifstream command_line_file{"/proc/self/cmdline"};
std::getline(command_line_file, program_name, '\0');
for(std::string line; std::getline(command_line_file, line, '\0');) {
parsed_arguments.emplace_back(line);
}
}
};
}
#endif
#endif

42
include/parser/platform_headers/macos_parser.hpp
View File

@@ -1,42 +0,0 @@
#pragma once
#ifdef __APPLE__
#ifndef MACOS_PARSER_HPP
#define MACOS_PARSER_HPP
#include <argument_parser.hpp>
#include <crt_externs.h>
#include <parser_v2.hpp>
#include <string>
namespace argument_parser {
class macos_parser : public base_parser {
public:
macos_parser() {
const int argc = *_NSGetArgc();
if (char **argv = *_NSGetArgv(); argc > 0 && argv != nullptr && argv[0] != nullptr) {
program_name = (argv[0]);
for (int i = 1; i < argc; ++i) {
if (argv[i] != nullptr) parsed_arguments.emplace_back(argv[i]);
}
}
}
};
namespace v2 {
class macos_parser : public v2::base_parser {
public:
macos_parser() {
const int argc = *_NSGetArgc();
if (char **argv = *_NSGetArgv(); argc > 0 && argv != nullptr && argv[0] != nullptr) {
set_program_name(argv[0]);
for (int i = 1; i < argc; ++i) {
if (argv[i] != nullptr) ref_parsed_args().emplace_back(argv[i]);
}
}
}
};
}
}
#endif
#endif

61
include/parser/platform_headers/windows_parser.hpp
View File

@@ -1,61 +0,0 @@
#pragma once
#ifdef _WIN32
#include <argument_parser.hpp>
#include <memory>
#include <string>
#include <windows.h>
#include <shellapi.h>
namespace argument_parser {
class windows_parser : public base_parser {
public:
windows_parser() {
int nArgs = 0;
LPWSTR* raw = ::CommandLineToArgvW(::GetCommandLineW(), &nArgs);
if (!raw) {
throw std::runtime_error("CommandLineToArgvW failed (" +
std::to_string(::GetLastError()) + ")");
}
std::unique_ptr<LPWSTR, void(*)(LPWSTR*)> argvW{ raw, [](LPWSTR* p){ if (p) ::LocalFree(p); } };
if (nArgs <= 0) {
throw std::runtime_error("No command line arguments found.");
}
{
std::wstring w0 = argvW.get()[0];
auto pos = w0.find_last_of(L"\\/");
std::wstring base = (pos == std::wstring::npos) ? w0 : w0.substr(pos + 1);
program_name = utf8_from_wstring(base);
}
parsed_arguments.reserve(static_cast<size_t>(nArgs > 0 ? nArgs - 1 : 0));
for (int i = 1; i < nArgs; ++i) {
parsed_arguments.emplace_back(utf8_from_wstring(argvW.get()[i]));
}
}
private:
static std::string utf8_from_wstring(const std::wstring& w) {
if (w.empty()) return {};
int needed = ::WideCharToMultiByte(CP_UTF8, WC_ERR_INVALID_CHARS,
w.c_str(), -1, nullptr, 0, nullptr, nullptr);
if (needed <= 0) {
throw std::runtime_error("WideCharToMultiByte sizing failed (" +
std::to_string(::GetLastError()) + ")");
}
std::string out;
out.resize(static_cast<size_t>(needed - 1));
int written = ::WideCharToMultiByte(CP_UTF8, WC_ERR_INVALID_CHARS,
w.c_str(), -1, out.data(), needed - 1, nullptr, nullptr);
if (written <= 0) {
throw std::runtime_error("WideCharToMultiByte convert failed (" +
std::to_string(::GetLastError()) + ")");
}
return out;
}
};
}
#endif

12
include/argparse → src/headers/argparse
View File

@@ -8,16 +8,28 @@
namespace argument_parser { namespace argument_parser {
using parser = linux_parser; using parser = linux_parser;
} }
namespace argument_parser::v2 {
using parser = linux_parser;
}
#elif __APPLE__ #elif __APPLE__
#include <macos_parser.hpp> #include <macos_parser.hpp>
namespace argument_parser { namespace argument_parser {
using parser = macos_parser; using parser = macos_parser;
} }
namespace argument_parser::v2 {
using parser = macos_parser;
}
#elif _WIN32 #elif _WIN32
#include <windows_parser.hpp> #include <windows_parser.hpp>
namespace argument_parser { namespace argument_parser {
using parser = windows_parser; using parser = windows_parser;
} }
namespace argument_parser::v2 {
using parser = windows_parser;
}
#else #else
#error "Unsupported platform" #error "Unsupported platform"
#endif #endif

34
src/headers/conventions/base_convention.hpp Normal file
View File

@@ -0,0 +1,34 @@
#pragma once
#include <string>
#include <utility>
#ifndef BASE_CONVENTION_HPP
#define BASE_CONVENTION_HPP
namespace argument_parser::conventions {
enum class argument_type { SHORT, LONG, POSITIONAL, INTERCHANGABLE, ERROR };
using parsed_argument = std::pair<argument_type, std::string>;
class base_convention {
public:
virtual std::string extract_value(std::string const &) const = 0;
virtual parsed_argument get_argument(std::string const &) const = 0;
virtual bool requires_next_token() const = 0;
virtual std::string name() const = 0;
virtual std::string short_prec() const = 0;
virtual std::string long_prec() const = 0;
protected:
base_convention() = default;
~base_convention() = default;
};
using convention = base_convention;
} // namespace argument_parser::conventions
namespace argument_parser::conventions::helpers {
std::string to_lower(std::string s);
std::string to_upper(std::string s);
} // namespace argument_parser::conventions::helpers
#endif

48
src/headers/conventions/implementations/gnu_argument_convention.hpp Normal file
View File

@@ -0,0 +1,48 @@
#pragma once
#include "base_convention.hpp"
#ifndef GNU_ARGUMENT_CONVENTION_HPP
#define GNU_ARGUMENT_CONVENTION_HPP
namespace argument_parser::conventions::implementations {
class gnu_argument_convention : public base_convention {
public:
parsed_argument get_argument(std::string const &raw) const override;
std::string extract_value(std::string const & /*raw*/) const override;
bool requires_next_token() const override;
std::string name() const override;
std::string short_prec() const override;
std::string long_prec() const override;
static gnu_argument_convention instance;
private:
gnu_argument_convention() = default;
};
class gnu_equal_argument_convention : public base_convention {
public:
parsed_argument get_argument(std::string const &raw) const override;
std::string extract_value(std::string const &raw) const override;
bool requires_next_token() const override;
std::string name() const override;
std::string short_prec() const override;
std::string long_prec() const override;
static gnu_equal_argument_convention instance;
private:
gnu_equal_argument_convention() = default;
};
inline gnu_argument_convention gnu_argument_convention::instance{};
inline gnu_equal_argument_convention gnu_equal_argument_convention::instance{};
} // namespace argument_parser::conventions::implementations
namespace argument_parser::conventions {
static const implementations::gnu_argument_convention gnu_argument_convention =
implementations::gnu_argument_convention::instance;
static const implementations::gnu_equal_argument_convention gnu_equal_argument_convention =
implementations::gnu_equal_argument_convention::instance;
} // namespace argument_parser::conventions
#endif

55
src/headers/conventions/implementations/windows_argument_convention.hpp Normal file
View File

@@ -0,0 +1,55 @@
#pragma once
#include "base_convention.hpp"
#ifndef WINDOWS_ARGUMENT_CONVENTION_HPP
#define WINDOWS_ARGUMENT_CONVENTION_HPP
#ifndef ALLOW_DASH_FOR_WINDOWS
#define ALLOW_DASH_FOR_WINDOWS 1
#endif
namespace argument_parser::conventions::implementations {
class windows_argument_convention : public base_convention {
public:
explicit windows_argument_convention(bool accept_dash = true);
parsed_argument get_argument(std::string const &raw) const override;
std::string extract_value(std::string const & /*raw*/) const override;
bool requires_next_token() const override;
std::string name() const override;
std::string short_prec() const override;
std::string long_prec() const override;
static windows_argument_convention instance;
private:
bool accept_dash_;
};
class windows_kv_argument_convention : public base_convention {
public:
explicit windows_kv_argument_convention(bool accept_dash = true);
parsed_argument get_argument(std::string const &raw) const override;
std::string extract_value(std::string const &raw) const override;
bool requires_next_token() const override;
std::string name() const override;
std::string short_prec() const override;
std::string long_prec() const override;
static windows_kv_argument_convention instance;
private:
bool accept_dash_;
};
inline windows_argument_convention windows_argument_convention::instance =
windows_argument_convention(bool(ALLOW_DASH_FOR_WINDOWS));
inline windows_kv_argument_convention windows_kv_argument_convention::instance =
windows_kv_argument_convention(bool(ALLOW_DASH_FOR_WINDOWS));
} // namespace argument_parser::conventions::implementations
namespace argument_parser::conventions {
static inline const implementations::windows_argument_convention windows_argument_convention =
implementations::windows_argument_convention::instance;
static inline const implementations::windows_kv_argument_convention windows_equal_argument_convention =
implementations::windows_kv_argument_convention::instance;
} // namespace argument_parser::conventions
#endif // WINDOWS_ARGUMENT_CONVENTION_HPP

236
src/headers/parser/argument_parser.hpp Normal file
View File

@@ -0,0 +1,236 @@
#pragma once
#include <list>
#include <optional>
#include <type_traits>
#ifndef ARGUMENT_PARSER_HPP
#define ARGUMENT_PARSER_HPP
#include <any>
#include <atomic>
#include <base_convention.hpp>
#include <functional>
#include <initializer_list>
#include <memory>
#include <stdexcept>
#include <string>
#include <traits.hpp>
#include <unordered_map>
#include <utility>
#include <vector>
namespace argument_parser {
class action_base {
public:
virtual ~action_base() = default;
[[nodiscard]] virtual bool expects_parameter() const = 0;
virtual void invoke() const = 0;
virtual void invoke_with_parameter(const std::string &param) const = 0;
[[nodiscard]] virtual std::unique_ptr<action_base> clone() const = 0;
};
template <typename T> class parametered_action : public action_base {
public:
explicit parametered_action(std::function<void(const T &)> const &handler) : handler(handler) {}
using parameter_type = T;
void invoke(const T &arg) const {
handler(arg);
}
[[nodiscard]] bool expects_parameter() const override {
return true;
}
void invoke() const override {
throw std::runtime_error("Parametered action requires a parameter");
}
void invoke_with_parameter(const std::string &param) const override {
T parsed_value = parsing_traits::parser_trait<T>::parse(param);
invoke(parsed_value);
}
[[nodiscard]] std::unique_ptr<action_base> clone() const override {
return std::make_unique<parametered_action<T>>(handler);
}
private:
std::function<void(const T &)> handler;
};
class non_parametered_action : public action_base {
public:
explicit non_parametered_action(std::function<void()> const &handler) : handler(handler) {}
void invoke() const override {
handler();
}
[[nodiscard]] bool expects_parameter() const override {
return false;
}
void invoke_with_parameter(const std::string &param) const override {
invoke();
}
[[nodiscard]] std::unique_ptr<action_base> clone() const override {
return std::make_unique<non_parametered_action>(handler);
}
private:
std::function<void()> handler;
};
class base_parser;
class argument {
public:
argument();
template <typename ActionType>
argument(const int id, std::string name, ActionType const &action)
: id(id), name(std::move(name)), action(action.clone()), required(false), invoked(false) {}
argument(const argument &other);
argument &operator=(const argument &other);
argument(argument &&other) noexcept = default;
argument &operator=(argument &&other) noexcept = default;
[[nodiscard]] bool is_required() const;
[[nodiscard]] std::string get_name() const;
[[nodiscard]] bool is_invoked() const;
[[nodiscard]] bool expects_parameter() const;
[[nodiscard]] std::string get_help_text() const;
private:
void set_required(bool val);
void set_invoked(bool val);
void set_help_text(std::string const &text);
friend class base_parser;
int id;
std::string name;
std::unique_ptr<action_base> action;
bool required;
bool invoked;
std::string help_text;
};
namespace helpers {
template <typename T>
static parametered_action<T> make_parametered_action(std::function<void(const T &)> const &function) {
return parametered_action<T>(function);
}
static non_parametered_action make_non_parametered_action(std::function<void()> const &function) {
return non_parametered_action(function);
}
} // namespace helpers
class base_parser {
public:
template <typename T>
void add_argument(std::string const &short_arg, std::string const &long_arg, std::string const &help_text,
parametered_action<T> const &action, bool required) {
base_add_argument(short_arg, long_arg, help_text, action, required);
}
template <typename T>
void add_argument(std::string const &short_arg, std::string const &long_arg, std::string const &help_text,
bool required) {
base_add_argument<T>(short_arg, long_arg, help_text, required);
}
void add_argument(std::string const &short_arg, std::string const &long_arg, std::string const &help_text,
non_parametered_action const &action, bool required) {
base_add_argument(short_arg, long_arg, help_text, action, required);
}
void add_argument(std::string const &short_arg, std::string const &long_arg, std::string const &help_text,
bool required) {
base_add_argument<void>(short_arg, long_arg, help_text, required);
}
void on_complete(std::function<void(base_parser const &)> const &action);
template <typename T> std::optional<T> get_optional(std::string const &arg) const {
auto id = find_argument_id(arg);
if (id.has_value()) {
auto value = stored_arguments.find(id.value());
if (value != stored_arguments.end() && value->second.has_value()) {
return std::any_cast<T>(value->second);
}
}
return std::nullopt;
}
[[nodiscard]] std::string
build_help_text(std::initializer_list<conventions::convention const *const> convention_types) const;
argument &get_argument(conventions::parsed_argument const &arg);
[[nodiscard]] std::optional<int> find_argument_id(std::string const &arg) const;
void handle_arguments(std::initializer_list<conventions::convention const *const> convention_types);
void display_help(std::initializer_list<conventions::convention const *const> convention_types) const;
protected:
base_parser() = default;
std::string program_name;
std::vector<std::string> parsed_arguments;
private:
void assert_argument_not_exist(std::string const &short_arg, std::string const &long_arg) const;
static void set_argument_status(bool is_required, std::string const &help_text, argument &arg);
void place_argument(int id, argument const &arg, std::string const &short_arg, std::string const &long_arg);
template <typename ActionType>
void base_add_argument(std::string const &short_arg, std::string const &long_arg, std::string const &help_text,
ActionType const &action, bool required) {
assert_argument_not_exist(short_arg, long_arg);
int id = id_counter.fetch_add(1);
argument arg(id, short_arg + "|" + long_arg, action);
set_argument_status(required, help_text, arg);
place_argument(id, arg, short_arg, long_arg);
}
template <typename StoreType = void>
void base_add_argument(std::string const &short_arg, std::string const &long_arg, std::string const &help_text,
bool required) {
assert_argument_not_exist(short_arg, long_arg);
int id = id_counter.fetch_add(1);
if constexpr (std::is_same_v<StoreType, void>) {
auto action =
helpers::make_non_parametered_action([id, this] { stored_arguments[id] = std::any{true}; });
argument arg(id, short_arg + "|" + long_arg, action);
set_argument_status(required, help_text, arg);
place_argument(id, arg, short_arg, long_arg);
} else {
auto action = helpers::make_parametered_action<StoreType>(
[id, this](StoreType const &value) { stored_arguments[id] = std::any{value}; });
argument arg(id, short_arg + "|" + long_arg, action);
set_argument_status(required, help_text, arg);
place_argument(id, arg, short_arg, long_arg);
}
}
void check_for_required_arguments(std::initializer_list<conventions::convention const *const> convention_types);
void fire_on_complete_events() const;
inline static std::atomic_int id_counter = 0;
std::unordered_map<int, std::any> stored_arguments;
std::unordered_map<int, argument> argument_map;
std::unordered_map<std::string, int> short_arguments;
std::unordered_map<int, std::string> reverse_short_arguments;
std::unordered_map<std::string, int> long_arguments;
std::unordered_map<int, std::string> reverse_long_arguments;
std::list<std::function<void(base_parser const &)>> on_complete_events;
friend class linux_parser;
friend class windows_parser;
friend class macos_parser;
friend class fake_parser;
};
} // namespace argument_parser
#endif // ARGUMENT_PARSER_HPP

23
src/headers/parser/fake_parser.hpp Normal file
View File

@@ -0,0 +1,23 @@
#pragma once
#ifndef FAKE_PARSER_HPP
#define FAKE_PARSER_HPP
#include <argument_parser.hpp>
#include <initializer_list>
#include <string>
namespace argument_parser {
class fake_parser : public base_parser {
public:
fake_parser() = default;
fake_parser(std::string program_name, std::vector<std::string> const &arguments);
fake_parser(std::string const &program_name, std::vector<std::string> &&arguments);
fake_parser(std::string const &program_name, std::initializer_list<std::string> const &arguments);
void set_program_name(std::string const &program_name);
void set_parsed_arguments(std::vector<std::string> const &parsed_arguments);
};
} // namespace argument_parser
#endif

211
src/headers/parser/parser_v2.hpp Normal file
View File

@@ -0,0 +1,211 @@
#pragma once
#include <argument_parser.hpp>
#include <array>
#include <cstdlib>
#include <fake_parser.hpp>
#include <initializer_list>
#include <memory>
#include <optional>
#include <stdexcept>
#include <string>
#include <string_view>
#include <unordered_map>
#include <variant>
#include <vector>
namespace argument_parser::v2 {
namespace internal {
static inline fake_parser fake_parser{};
}
enum class add_argument_flags { ShortArgument, LongArgument, HelpText, Action, Required };
namespace flags {
constexpr static inline add_argument_flags ShortArgument = add_argument_flags::ShortArgument;
constexpr static inline add_argument_flags LongArgument = add_argument_flags::LongArgument;
constexpr static inline add_argument_flags HelpText = add_argument_flags::HelpText;
constexpr static inline add_argument_flags Action = add_argument_flags::Action;
constexpr static inline add_argument_flags Required = add_argument_flags::Required;
} // namespace flags
class base_parser : private argument_parser::base_parser {
public:
template <typename T> using typed_flag_value = std::variant<std::string, parametered_action<T>, bool>;
using non_typed_flag_value = std::variant<std::string, non_parametered_action, bool>;
template <typename T> using typed_argument_pair = std::pair<add_argument_flags, typed_flag_value<T>>;
using non_typed_argument_pair = std::pair<add_argument_flags, non_typed_flag_value>;
template <typename T>
void add_argument(std::unordered_map<add_argument_flags, typed_flag_value<T>> const &argument_pairs) {
add_argument_impl<true, parametered_action<T>, T>(argument_pairs);
}
template <typename T> void add_argument(std::initializer_list<typed_argument_pair<T>> const &pairs) {
std::unordered_map<add_argument_flags, typed_flag_value<T>> args;
for (auto &[k, v] : pairs) {
args[k] = v;
}
add_argument<T>(args);
}
void add_argument(std::initializer_list<non_typed_argument_pair> const &pairs) {
std::unordered_map<add_argument_flags, non_typed_flag_value> args;
for (auto &[k, v] : pairs) {
args[k] = v;
}
add_argument(args);
}
void add_argument(std::unordered_map<add_argument_flags, non_typed_flag_value> const &argument_pairs) {
add_argument_impl<false, non_parametered_action, void>(argument_pairs);
}
argument_parser::base_parser &to_v1() {
return *this;
}
void handle_arguments(std::initializer_list<conventions::convention const *const> convention_types) {
base::handle_arguments(convention_types);
}
template <typename T> std::optional<T> get_optional(std::string const &arg) {
return base::get_optional<T>(arg);
}
void on_complete(std::function<void(argument_parser::base_parser const &)> const &action) {
base::on_complete(action);
}
protected:
void set_program_name(std::string p) {
base::program_name = std::move(p);
}
std::vector<std::string> &ref_parsed_args() {
return base::parsed_arguments;
}
private:
template <bool IsTyped, typename ActionType, typename T, typename ArgsMap>
void add_argument_impl(ArgsMap const &argument_pairs) {
std::unordered_map<extended_add_argument_flags, bool> found_params{
{extended_add_argument_flags::IsTyped, IsTyped}};
std::string short_arg, long_arg, help_text;
std::unique_ptr<action_base> action;
bool required = false;
if (argument_pairs.find(add_argument_flags::ShortArgument) != argument_pairs.end()) {
found_params[extended_add_argument_flags::ShortArgument] = true;
short_arg = get_or_throw<std::string>(argument_pairs.at(add_argument_flags::ShortArgument), "short");
}
if (argument_pairs.find(add_argument_flags::LongArgument) != argument_pairs.end()) {
found_params[extended_add_argument_flags::LongArgument] = true;
long_arg = get_or_throw<std::string>(argument_pairs.at(add_argument_flags::LongArgument), "long");
if (short_arg.empty())
short_arg = long_arg;
} else {
if (!short_arg.empty())
long_arg = short_arg;
}
if (argument_pairs.find(add_argument_flags::Action) != argument_pairs.end()) {
found_params[extended_add_argument_flags::Action] = true;
action = get_or_throw<ActionType>(argument_pairs.at(add_argument_flags::Action), "action").clone();
}
if (argument_pairs.find(add_argument_flags::HelpText) != argument_pairs.end()) {
help_text = get_or_throw<std::string>(argument_pairs.at(add_argument_flags::HelpText), "help");
} else {
help_text = short_arg + ", " + long_arg;
}
if (argument_pairs.find(add_argument_flags::Required) != argument_pairs.end() &&
get_or_throw<bool>(argument_pairs.at(add_argument_flags::Required), "required")) {
required = true;
}
auto suggested_add = suggest_candidate(found_params);
if (suggested_add == candidate_type::unknown) {
throw std::runtime_error("Could not match any add argument overload to given parameters. Are you "
"missing some required parameter?");
}
if constexpr (IsTyped) {
switch (suggested_add) {
case candidate_type::typed_action:
base::add_argument(short_arg, long_arg, help_text, *static_cast<ActionType *>(&(*action)),
required);
break;
case candidate_type::store_other:
base::add_argument<T>(short_arg, long_arg, help_text, required);
break;
default:
throw std::runtime_error("Could not match the arguments against any overload.");
}
} else {
switch (suggested_add) {
case candidate_type::non_typed_action:
base::add_argument(short_arg, long_arg, help_text, *static_cast<ActionType *>(&(*action)),
required);
break;
case candidate_type::store_boolean:
base::add_argument(short_arg, long_arg, help_text, required);
break;
default:
throw std::runtime_error(
"Could not match the arguments against any overload. The suggested candidate was: " +
std::to_string((int(suggested_add))));
}
}
}
using base = argument_parser::base_parser;
enum class extended_add_argument_flags { ShortArgument, LongArgument, Action, IsTyped };
enum class candidate_type { store_boolean, store_other, typed_action, non_typed_action, unknown };
template <typename T, size_t S>
bool satisfies_at_least_one(std::array<T, S> const &arr, std::unordered_map<T, bool> const &map) {
for (const auto &req : arr) {
if (map.find(req) != map.end())
return true;
}
return false;
}
candidate_type suggest_candidate(std::unordered_map<extended_add_argument_flags, bool> const &available_vars) {
auto constexpr required_at_least_one = std::array<extended_add_argument_flags, 2>{
extended_add_argument_flags::ShortArgument, extended_add_argument_flags::LongArgument};
if (!satisfies_at_least_one(required_at_least_one, available_vars))
return candidate_type::unknown;
if (available_vars.find(extended_add_argument_flags::Action) != available_vars.end()) {
if (available_vars.at(extended_add_argument_flags::IsTyped))
return candidate_type::typed_action;
else
return candidate_type::non_typed_action;
}
if (available_vars.at(extended_add_argument_flags::IsTyped))
return candidate_type::store_other;
return candidate_type::store_boolean;
}
template <typename T, typename I> T get_or_throw(typed_flag_value<I> const &v, std::string_view key) {
if (auto p = std::get_if<T>(&v))
return *p;
throw std::invalid_argument(std::string("variant type mismatch for key: ") + std::string(key));
}
template <typename T> T get_or_throw(non_typed_flag_value const &v, std::string_view key) {
if (auto p = std::get_if<T>(&v))
return *p;
throw std::invalid_argument(std::string("variant type mismatch for key: ") + std::string(key));
}
};
} // namespace argument_parser::v2

34
src/headers/parser/parsing_traits/traits.hpp Normal file
View File

@@ -0,0 +1,34 @@
#pragma once
#ifndef PARSING_TRAITS_HPP
#define PARSING_TRAITS_HPP
#include <string>
namespace argument_parser::parsing_traits {
template <typename T_> struct parser_trait {
using type = T_;
static T_ parse(const std::string &input);
};
template <> struct parser_trait<std::string> {
static std::string parse(const std::string &input);
};
template <> struct parser_trait<bool> {
static bool parse(const std::string &input);
};
template <> struct parser_trait<int> {
static int parse(const std::string &input);
};
template <> struct parser_trait<float> {
static float parse(const std::string &input);
};
template <> struct parser_trait<double> {
static double parse(const std::string &input);
};
} // namespace argument_parser::parsing_traits
#endif

25
src/headers/parser/platform_headers/linux_parser.hpp Normal file
View File

@@ -0,0 +1,25 @@
#pragma once
#ifdef __linux__
#ifndef LINUX_PARSER_HPP
#define LINUX_PARSER_HPP
#include <argument_parser.hpp>
#include <parser_v2.hpp>
namespace argument_parser {
class linux_parser : public base_parser {
public:
linux_parser();
};
namespace v2 {
class linux_parser : public v2::base_parser {
public:
linux_parser();
};
} // namespace v2
} // namespace argument_parser
#endif
#endif

26
src/headers/parser/platform_headers/macos_parser.hpp Normal file
View File

@@ -0,0 +1,26 @@
#pragma once
#ifdef __APPLE__
#ifndef MACOS_PARSER_HPP
#define MACOS_PARSER_HPP
#include <argument_parser.hpp>
#include <crt_externs.h>
#include <parser_v2.hpp>
#include <string>
namespace argument_parser {
class macos_parser : public base_parser {
public:
macos_parser();
};
namespace v2 {
class macos_parser : public v2::base_parser {
public:
macos_parser();
};
} // namespace v2
} // namespace argument_parser
#endif
#endif

19
src/headers/parser/platform_headers/windows_parser.hpp Normal file
View File

@@ -0,0 +1,19 @@
#pragma once
#ifdef _WIN32
#include <argument_parser.hpp>
#include <parser_v2.hpp>
namespace argument_parser {
class windows_parser : public base_parser {
public:
windows_parser();
};
namespace v2 {
class windows_parser : public v2::base_parser {
public:
windows_parser();
};
} // namespace v2
} // namespace argument_parser
#endif

132
src/main.cpp
View File

@@ -1,22 +1,19 @@
#include "macos_parser.hpp"
#include <string> #include <string>
#define ALLOW_DASH_FOR_WINDOWS 0 #define ALLOW_DASH_FOR_WINDOWS 0
#include <parser_v2.hpp>
#include <argparse> #include <argparse>
#include <expected>
#include <iostream>
#include <fstream> #include <fstream>
#include <iostream>
#include <parser_v2.hpp>
#include <regex> #include <regex>
#include <sstream>
#include <vector> #include <vector>
struct Point { struct Point {
int x, y; int x, y;
}; };
template<> template <> struct argument_parser::parsing_traits::parser_trait<Point> {
struct argument_parser::parsing_traits::parser_trait<Point> {
static Point parse(const std::string &input) { static Point parse(const std::string &input) {
auto comma_pos = input.find(','); auto comma_pos = input.find(',');
if (comma_pos == std::string::npos) { if (comma_pos == std::string::npos) {
@@ -28,18 +25,16 @@ struct argument_parser::parsing_traits::parser_trait<Point> {
} }
}; };
template<> template <> struct argument_parser::parsing_traits::parser_trait<std::regex> {
struct argument_parser::parsing_traits::parser_trait<std::regex> {
static std::regex parse(const std::string &input) { static std::regex parse(const std::string &input) {
return std::regex(input); return std::regex(input);
} }
}; };
template<> template <> struct argument_parser::parsing_traits::parser_trait<std::vector<int>> {
struct argument_parser::parsing_traits::parser_trait<std::vector<int>> {
static std::vector<int> parse(const std::string &input) { static std::vector<int> parse(const std::string &input) {
std::vector<int> result; std::vector<int> result;
std::stringstream ss(input); std::stringstream ss{input};
std::string item; std::string item;
while (std::getline(ss, item, ',')) { while (std::getline(ss, item, ',')) {
result.push_back(std::stoi(item)); result.push_back(std::stoi(item));
@@ -48,21 +43,10 @@ struct argument_parser::parsing_traits::parser_trait<std::vector<int>> {
} }
}; };
template <> struct argument_parser::parsing_traits::parser_trait<std::vector<std::string>> {
template<>
struct argument_parser::parsing_traits::parser_trait<std::vector<std::string>> {
static std::vector<std::string> parse(const std::string &input) { static std::vector<std::string> parse(const std::string &input) {
std::vector<std::string> result; std::vector<std::string> result;
auto copyInput = input; std::stringstream ss{input};
if (input.starts_with("[")) {
copyInput = input.substr(1, input.size());
if (copyInput.ends_with("]")) {
copyInput = copyInput.substr(0, copyInput.size() - 1);
} else {
throw std::runtime_error("Invalid vector<string> format. Expected closing ']'.");
}
}
std::stringstream ss(copyInput);
std::string item; std::string item;
while (std::getline(ss, item, ',')) { while (std::getline(ss, item, ',')) {
result.push_back(item); result.push_back(item);
@@ -75,17 +59,13 @@ const std::initializer_list<argument_parser::conventions::convention const* cons
&argument_parser::conventions::gnu_argument_convention, &argument_parser::conventions::gnu_argument_convention,
&argument_parser::conventions::gnu_equal_argument_convention, &argument_parser::conventions::gnu_equal_argument_convention,
&argument_parser::conventions::windows_argument_convention, &argument_parser::conventions::windows_argument_convention,
&argument_parser::conventions::windows_equal_argument_convention &argument_parser::conventions::windows_equal_argument_convention};
};
const auto echo = argument_parser::helpers::make_parametered_action<std::string>([](std::string const& text) { const auto echo = argument_parser::helpers::make_parametered_action<std::string>(
std::cout << text << std::endl; [](std::string const &text) { std::cout << text << std::endl; });
});
const auto echo_point = argument_parser::helpers::make_parametered_action<Point>(
const auto echo_point = argument_parser::helpers::make_parametered_action<Point>([](Point const& point) { [](Point const &point) { std::cout << "Point(" << point.x << ", " << point.y << ")" << std::endl; });
std::cout << "Point(" << point.x << ", " << point.y << ")" << std::endl;
});
const auto cat = argument_parser::helpers::make_parametered_action<std::string>([](std::string const &file_name) { const auto cat = argument_parser::helpers::make_parametered_action<std::string>([](std::string const &file_name) {
std::ifstream file(file_name); std::ifstream file(file_name);
@@ -138,83 +118,41 @@ void run_grep(argument_parser::base_parser const& parser) {
} }
} }
void run_store_point(argument_parser::base_parser const &parser) {
int v1Examples() { auto point = parser.get_optional<Point>("store-point");
if (point) {
auto parser = argument_parser::parser{}; std::cout << "Point(" << point->x << ", " << point->y << ")" << std::endl;
parser.add_argument("e", "echo", "echoes given variable", echo, false);
parser.add_argument("ep", "echo-point", "echoes given point", echo_point, false);
parser.add_argument<std::string>("f", "file", "File to grep, required only if using grep", false);
parser.add_argument<std::regex>("g", "grep", "Grep pattern, required only if using grep", false);
parser.add_argument("c", "cat", "Prints the content of the file", cat, false);
parser.add_argument("h", "help", "Displays this help text.", argument_parser::helpers::make_non_parametered_action([&parser]{
parser.display_help(conventions);
}), false);
parser.add_argument<Point>("p", "point", "Test point", false);
parser.add_argument<std::vector<int>>("t", "test", "Test vector<int>", false);
parser.add_argument<std::vector<std::string>>("ts", "test-strings", "Test vector<string>", false);
parser.on_complete(::run_grep);
try {
parser.handle_arguments(conventions);
} catch(std::exception const& e) {
std::cerr << "Error: " << e.what() << std::endl;
parser.display_help(conventions);
return -1;
} }
auto test = parser.get_optional<std::vector<int>>("test");
if (test) {
for (auto const& item : test.value()) {
std::cout << item << std::endl;
}
}
auto test_strings = parser.get_optional<std::vector<std::string>>("test-strings");
if (test_strings) {
for (auto const& item : test_strings.value()) {
std::cout << item << std::endl;
}
}
return 0;
} }
int v2Examples() { int v2Examples() {
using namespace argument_parser::v2::flags; using namespace argument_parser::v2::flags;
argument_parser::v2::macos_parser parser; argument_parser::v2::parser parser;
parser.add_argument<std::string>(
{{ShortArgument, "e"}, {LongArgument, "echo"}, {Action, echo}, {HelpText, "echoes given variable"}});
parser.add_argument<Point>(
{{ShortArgument, "ep"}, {LongArgument, "echo-point"}, {Action, echo_point}, {HelpText, "echoes given point"}});
parser.add_argument<std::string>({ parser.add_argument<std::string>({
{ ShortArgument, "e" }, // stores string for f/file flag
{ LongArgument, "echo" },
{ Action, echo }
});
parser.add_argument<Point>({
{ ShortArgument, "ep" },
{ LongArgument, "echo-point" },
{ Action, echo_point }
});
parser.add_argument<std::string>({ // stores string for f/file flag
{ShortArgument, "f"}, {ShortArgument, "f"},
{LongArgument, "file"}, {LongArgument, "file"},
{HelpText, "File to grep, required only if using grep"},
// if no action, falls to store operation with given type. // if no action, falls to store operation with given type.
}); });
parser.add_argument<std::regex>({ // stores string for g/grep flag parser.add_argument<std::regex>({
// stores string for g/grep flag
{ShortArgument, "g"}, {ShortArgument, "g"},
{LongArgument, "grep"}, {LongArgument, "grep"},
{HelpText, "Grep pattern, required only if using file"},
// same as 'file' flag // same as 'file' flag
}); });
parser.add_argument<std::string>({ parser.add_argument<std::string>(
{ ShortArgument, "c" }, {{ShortArgument, "c"}, {LongArgument, "cat"}, {Action, cat}, {HelpText, "Prints the content of the file"}});
{ LongArgument, "cat" },
{ Action, cat }
});
parser.add_argument<Point>({ parser.add_argument<Point>({
// { ShortArgument, "sp" }, // now if ShortArgument or LongArgument is missing, it will use it for the other. // { ShortArgument, "sp" }, // now if ShortArgument or LongArgument is missing, it will use it for the other.
@@ -223,11 +161,17 @@ int v2Examples() {
}); });
parser.on_complete(::run_grep); parser.on_complete(::run_grep);
parser.on_complete(::run_store_point);
parser.handle_arguments(conventions); parser.handle_arguments(conventions);
return 0; return 0;
} }
int main() { int main() {
try {
return v2Examples(); return v2Examples();
} catch (std::exception const &e) {
std::cerr << "Error: " << e.what() << std::endl;
return -1;
}
} }

14
src/source/conventions/base_convention.cpp Normal file
View File

@@ -0,0 +1,14 @@
#include "base_convention.hpp"
#include <algorithm>
namespace argument_parser::conventions::helpers {
std::string to_lower(std::string s) {
std::transform(s.begin(), s.end(), s.begin(), [](unsigned char c) { return std::tolower(c); });
return s;
}
std::string to_upper(std::string s) {
std::transform(s.begin(), s.end(), s.begin(), [](unsigned char c) { return std::toupper(c); });
return s;
}
} // namespace argument_parser::conventions::helpers

75
src/source/conventions/implementations/gnu_argument_convention.cpp Normal file
View File

@@ -0,0 +1,75 @@
#include "gnu_argument_convention.hpp"
#include "base_convention.hpp"
#include <stdexcept>
bool starts_with(std::string const &s, std::string const &prefix) {
return s.rfind(prefix, 0) == 0;
}
namespace argument_parser::conventions::implementations {
parsed_argument gnu_argument_convention::get_argument(std::string const &raw) const {
if (starts_with(raw, long_prec()))
return {argument_type::LONG, raw.substr(2)};
else if (starts_with(raw, short_prec()))
return {argument_type::SHORT, raw.substr(1)};
else
return {argument_type::ERROR, "GNU standard convention does not allow arguments without a preceding dash."};
}
std::string gnu_argument_convention::extract_value(std::string const & /*raw*/) const {
throw std::runtime_error("No inline value in standard GNU convention.");
}
bool gnu_argument_convention::requires_next_token() const {
return true;
}
std::string gnu_argument_convention::name() const {
return "GNU-style long options";
}
std::string gnu_argument_convention::short_prec() const {
return "-";
}
std::string gnu_argument_convention::long_prec() const {
return "--";
}
} // namespace argument_parser::conventions::implementations
namespace argument_parser::conventions::implementations {
parsed_argument gnu_equal_argument_convention::get_argument(std::string const &raw) const {
auto pos = raw.find('=');
auto arg = pos != std::string::npos ? raw.substr(0, pos) : raw;
if (starts_with(arg, long_prec()))
return {argument_type::LONG, arg.substr(2)};
else if (starts_with(arg, short_prec()))
return {argument_type::SHORT, arg.substr(1)};
else
return {argument_type::ERROR, "GNU standard convention does not allow arguments without a preceding dash."};
}
std::string gnu_equal_argument_convention::extract_value(std::string const &raw) const {
auto pos = raw.find('=');
if (pos == std::string::npos || pos + 1 >= raw.size())
throw std::runtime_error("Expected value after '='.");
return raw.substr(pos + 1);
}
bool gnu_equal_argument_convention::requires_next_token() const {
return false;
}
std::string gnu_equal_argument_convention::name() const {
return "GNU-style long options (equal signed form)";
}
std::string gnu_equal_argument_convention::short_prec() const {
return "-";
}
std::string gnu_equal_argument_convention::long_prec() const {
return "--";
}
} // namespace argument_parser::conventions::implementations

104
src/source/conventions/implementations/windows_argument_convention.cpp Normal file
View File

@@ -0,0 +1,104 @@
#include "windows_argument_convention.hpp"
#include <stdexcept>
namespace argument_parser::conventions::implementations {
windows_argument_convention::windows_argument_convention(bool accept_dash) : accept_dash_(accept_dash) {}
parsed_argument windows_argument_convention::get_argument(std::string const &raw) const {
if (raw.empty()) {
return {argument_type::ERROR, "Empty argument token."};
}
const char c0 = raw[0];
const bool ok_prefix = (c0 == '/') || (accept_dash_ && c0 == '-');
if (!ok_prefix) {
return {argument_type::ERROR,
accept_dash_ ? "Windows-style expects options to start with '/' (or '-' in compat mode)."
: "Windows-style expects options to start with '/'."};
}
if (raw.find_first_of("=:") != std::string::npos) {
return {argument_type::ERROR,
"Inline values are not allowed in this convention; provide the value in the next token."};
}
std::string name = helpers::to_lower(raw.substr(1));
if (name.empty()) {
return {argument_type::ERROR, "Option name cannot be empty after '/'."};
}
return {argument_type::INTERCHANGABLE, std::move(name)};
}
std::string windows_argument_convention::extract_value(std::string const & /*raw*/) const {
throw std::runtime_error("No inline value; value must be provided in the next token.");
}
bool windows_argument_convention::requires_next_token() const {
return true;
}
std::string windows_argument_convention::name() const {
return "Windows style options (next-token values)";
}
std::string windows_argument_convention::short_prec() const {
return accept_dash_ ? "-" : "/";
}
std::string windows_argument_convention::long_prec() const {
return "/";
}
} // namespace argument_parser::conventions::implementations
namespace argument_parser::conventions::implementations {
windows_kv_argument_convention::windows_kv_argument_convention(bool accept_dash) : accept_dash_(accept_dash) {}
parsed_argument windows_kv_argument_convention::get_argument(std::string const &raw) const {
if (raw.empty()) {
return {argument_type::ERROR, "Empty argument token."};
}
const char c0 = raw[0];
const bool ok_prefix = (c0 == '/') || (accept_dash_ && c0 == '-');
if (!ok_prefix) {
return {argument_type::ERROR,
accept_dash_ ? "Windows-style expects options to start with '/' (or '-' in compat mode)."
: "Windows-style expects options to start with '/'."};
}
const std::size_t sep = raw.find_first_of("=:");
if (sep == std::string::npos) {
return {argument_type::ERROR,
"Expected an inline value using '=' or ':' (e.g., /opt=value or /opt:value)."};
}
if (sep == 1) {
return {argument_type::ERROR, "Option name cannot be empty before '=' or ':'."};
}
std::string name = helpers::to_lower(raw.substr(1, sep - 1));
return {argument_type::INTERCHANGABLE, std::move(name)};
}
std::string windows_kv_argument_convention::extract_value(std::string const &raw) const {
const std::size_t sep = raw.find_first_of("=:");
if (sep == std::string::npos || sep + 1 >= raw.size())
throw std::runtime_error("Expected a value after '=' or ':'.");
return raw.substr(sep + 1);
}
bool windows_kv_argument_convention::requires_next_token() const {
return false;
}
std::string windows_kv_argument_convention::name() const {
return "Windows-style options (inline values via '=' or ':')";
}
std::string windows_kv_argument_convention::short_prec() const {
return accept_dash_ ? "-" : "/";
}
std::string windows_kv_argument_convention::long_prec() const {
return "/";
}
} // namespace argument_parser::conventions::implementations

208
src/source/parser/argument_parser.cpp Normal file
View File

@@ -0,0 +1,208 @@
#include "argument_parser.hpp"
#include <iostream>
#include <sstream>
bool contains(std::unordered_map<std::string, int> const &map, std::string const &key) {
return map.find(key) != map.end();
}
namespace argument_parser {
argument::argument()
: id(0), name(), action(std::make_unique<non_parametered_action>([]() {})), required(false), invoked(false) {}
argument::argument(const argument &other)
: id(other.id), name(other.name), action(other.action->clone()), required(other.required),
invoked(other.invoked), help_text(other.help_text) {}
argument &argument::operator=(const argument &other) {
if (this != &other) {
id = other.id;
name = other.name;
action = other.action->clone();
required = other.required;
invoked = other.invoked;
help_text = other.help_text;
}
return *this;
}
bool argument::expects_parameter() const {
return action->expects_parameter();
}
bool argument::is_required() const {
return required;
}
bool argument::is_invoked() const {
return invoked;
}
std::string argument::get_name() const {
return name;
}
std::string argument::get_help_text() const {
return help_text;
}
void argument::set_required(bool val) {
required = val;
}
void argument::set_invoked(bool val) {
invoked = val;
}
void argument::set_help_text(std::string const &text) {
help_text = text;
}
void base_parser::on_complete(std::function<void(base_parser const &)> const &handler) {
on_complete_events.emplace_back(handler);
}
std::string
base_parser::build_help_text(std::initializer_list<conventions::convention const *const> convention_types) const {
std::stringstream ss;
ss << "Usage: " << program_name << " [OPTIONS]...\n";
for (auto const &[id, arg] : argument_map) {
auto short_arg = reverse_short_arguments.at(id);
auto long_arg = reverse_long_arguments.at(id);
ss << "\t";
for (auto const &convention : convention_types) {
ss << convention->short_prec() << short_arg << ", " << convention->long_prec() << long_arg << "\t";
}
ss << arg.help_text << "\n";
}
return ss.str();
}
argument &base_parser::get_argument(conventions::parsed_argument const &arg) {
if (arg.first == conventions::argument_type::LONG) {
auto long_pos = long_arguments.find(arg.second);
if (long_pos != long_arguments.end())
return argument_map.at(long_pos->second);
} else if (arg.first == conventions::argument_type::SHORT) {
auto short_pos = short_arguments.find(arg.second);
if (short_pos != short_arguments.end())
return argument_map.at(short_pos->second);
} else if (arg.first == conventions::argument_type::INTERCHANGABLE) {
auto long_pos = long_arguments.find(arg.second);
if (long_pos != long_arguments.end())
return argument_map.at(long_pos->second);
auto short_pos = short_arguments.find(arg.second);
if (short_pos != short_arguments.end())
return argument_map.at(short_pos->second);
}
throw std::runtime_error("Unknown argument: " + arg.second);
}
void base_parser::handle_arguments(std::initializer_list<conventions::convention const *const> convention_types) {
for (auto it = parsed_arguments.begin(); it != parsed_arguments.end(); ++it) {
std::stringstream error_stream;
bool arg_correctly_handled = false;
for (auto const &convention_type : convention_types) {
auto extracted = convention_type->get_argument(*it);
if (extracted.first == conventions::argument_type::ERROR) {
error_stream << "Convention \"" << convention_type->name() << "\" failed with: " << extracted.second
<< "\n";
continue;
}
try {
argument &corresponding_argument = get_argument(extracted);
if (corresponding_argument.expects_parameter()) {
if (convention_type->requires_next_token() && (it + 1) == parsed_arguments.end()) {
throw std::runtime_error("expected value for argument " + extracted.second);
}
auto value_raw =
convention_type->requires_next_token() ? *(++it) : convention_type->extract_value(*it);
corresponding_argument.action->invoke_with_parameter(value_raw);
} else {
corresponding_argument.action->invoke();
}
corresponding_argument.set_invoked(true);
arg_correctly_handled = true;
break; // Convention succeeded, move to the next argument token
} catch (const std::runtime_error &e) {
error_stream << "Convention \"" << convention_type->name() << "\" failed with: " << e.what()
<< "\n";
}
}
if (!arg_correctly_handled) {
throw std::runtime_error("All trials for argument: \n\t\"" + *it + "\"\n failed with: \n" +
error_stream.str());
}
}
check_for_required_arguments(convention_types);
fire_on_complete_events();
}
void base_parser::display_help(std::initializer_list<conventions::convention const *const> convention_types) const {
std::cout << build_help_text(convention_types);
}
std::optional<int> base_parser::find_argument_id(std::string const &arg) const {
auto long_pos = long_arguments.find(arg);
auto short_post = short_arguments.find(arg);
if (long_pos != long_arguments.end())
return long_pos->second;
if (short_post != short_arguments.end())
return short_post->second;
return std::nullopt;
}
void base_parser::assert_argument_not_exist(std::string const &short_arg, std::string const &long_arg) const {
if (contains(short_arguments, short_arg) || contains(long_arguments, long_arg)) {
throw std::runtime_error("The key already exists!");
}
}
void base_parser::set_argument_status(bool is_required, std::string const &help_text, argument &arg) {
arg.set_required(is_required);
arg.set_help_text(help_text);
}
void base_parser::place_argument(int id, argument const &arg, std::string const &short_arg,
std::string const &long_arg) {
argument_map[id] = arg;
short_arguments[short_arg] = id;
reverse_short_arguments[id] = short_arg;
long_arguments[long_arg] = id;
reverse_long_arguments[id] = long_arg;
}
void base_parser::check_for_required_arguments(
std::initializer_list<conventions::convention const *const> convention_types) {
std::vector<std::pair<std::string, std::string>> required_args;
for (auto const &[key, arg] : argument_map) {
if (arg.is_required() && !arg.is_invoked()) {
required_args.emplace_back<std::pair<std::string, std::string>>(
{reverse_short_arguments[key], reverse_long_arguments[key]});
}
}
if (!required_args.empty()) {
std::cerr << "These arguments were expected but not provided: ";
for (auto const &[s, l] : required_args) {
std::cerr << "[-" << s << ", --" << l << "] ";
}
std::cerr << "\n";
display_help(convention_types);
}
}
void base_parser::fire_on_complete_events() const {
for (auto const &event : on_complete_events) {
event(*this);
}
}
} // namespace argument_parser

24
src/source/parser/fake_parser.cpp Normal file
View File

@@ -0,0 +1,24 @@
#include "fake_parser.hpp"
namespace argument_parser {
fake_parser::fake_parser(std::string program_name, std::vector<std::string> const &arguments) {
this->program_name = std::move(program_name);
parsed_arguments = arguments;
}
fake_parser::fake_parser(std::string const &program_name, std::vector<std::string> &&arguments) {
this->program_name = program_name;
parsed_arguments = std::move(arguments);
}
fake_parser::fake_parser(std::string const &program_name, std::initializer_list<std::string> const &arguments)
: fake_parser(program_name, std::vector<std::string>(arguments)) {}
void fake_parser::set_program_name(std::string const &program_name) {
this->program_name = program_name;
}
void fake_parser::set_parsed_arguments(std::vector<std::string> const &parsed_arguments) {
this->parsed_arguments = parsed_arguments;
}
} // namespace argument_parser

28
src/source/parser/parsing_traits/traits.cpp Normal file
View File

@@ -0,0 +1,28 @@
#include "traits.hpp"
#include <stdexcept>
namespace argument_parser::parsing_traits {
std::string parser_trait<std::string>::parse(const std::string &input) {
return input;
}
bool parser_trait<bool>::parse(const std::string &input) {
if (input == "t" || input == "true" || input == "1")
return true;
if (input == "f" || input == "false" || input == "0")
return false;
throw std::runtime_error("Invalid boolean value: " + input);
}
int parser_trait<int>::parse(const std::string &input) {
return std::stoi(input);
}
float parser_trait<float>::parse(const std::string &input) {
return std::stof(input);
}
double parser_trait<double>::parse(const std::string &input) {
return std::stod(input);
}
} // namespace argument_parser::parsing_traits

31
src/source/parser/platform_parsers/linux_parser.cpp Normal file
View File

@@ -0,0 +1,31 @@
#ifdef __linux__
#include "linux_parser.hpp"
#include <fstream>
#include <string>
namespace argument_parser {
linux_parser::linux_parser() {
std::ifstream command_line_file{"/proc/self/cmdline"};
std::getline(command_line_file, program_name, '\0');
for (std::string line; std::getline(command_line_file, line, '\0');) {
parsed_arguments.emplace_back(line);
}
}
namespace v2 {
linux_parser::linux_parser() {
std::ifstream command_line_file{"/proc/self/cmdline"};
std::string program_name;
std::getline(command_line_file, program_name, '\0');
set_program_name(program_name);
for (std::string line; std::getline(command_line_file, line, '\0');) {
parsed_arguments.emplace_back(line);
}
}
} // namespace v2
} // namespace argument_parser
#endif

31
src/source/parser/platform_parsers/macos_parser.cpp Normal file
View File

@@ -0,0 +1,31 @@
#ifdef __APPLE__
#include "macos_parser.hpp"
namespace argument_parser {
macos_parser::macos_parser() {
const int argc = *_NSGetArgc();
if (char **argv = *_NSGetArgv(); argc > 0 && argv != nullptr && argv[0] != nullptr) {
program_name = (argv[0]);
for (int i = 1; i < argc; ++i) {
if (argv[i] != nullptr)
parsed_arguments.emplace_back(argv[i]);
}
}
}
namespace v2 {
macos_parser::macos_parser() {
const int argc = *_NSGetArgc();
if (char **argv = *_NSGetArgv(); argc > 0 && argv != nullptr && argv[0] != nullptr) {
set_program_name(argv[0]);
for (int i = 1; i < argc; ++i) {
if (argv[i] != nullptr)
ref_parsed_args().emplace_back(argv[i]);
}
}
}
} // namespace v2
} // namespace argument_parser
#endif

102
src/source/parser/platform_parsers/windows_parser.cpp Normal file
View File

@@ -0,0 +1,102 @@
#ifdef _WIN32
#include "windows_parser.hpp"
#include <Windows.h>
#include <iostream>
#include <memory>
#include <shellapi.h>
#include <stdexcept>
#include <string>
using namespace std::string_literals;
struct local_free_deleter {
void operator()(void *ptr) const {
if (ptr == nullptr) {
return;
}
LocalFree(static_cast<HLOCAL>(ptr));
}
};
std::string windows_error_message(DWORD error_code) {
LPSTR messageBuffer = nullptr;
size_t size = FormatMessageA(
FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS, nullptr,
error_code, MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), reinterpret_cast<LPSTR>(&messageBuffer), 0, nullptr);
if (size == 0 || !messageBuffer) {
return "Unknown Error ("s + std::to_string(error_code) + ")";
}
std::unique_ptr<char, local_free_deleter> smartBuffer(messageBuffer);
std::string result(smartBuffer.get(), size);
result.erase(result.find_last_not_of(" \n\r\t") + 1);
return result;
}
std::string utf8_from_wstring(const std::wstring &w) {
if (w.empty())
return {};
int needed = ::WideCharToMultiByte(CP_UTF8, WC_ERR_INVALID_CHARS, w.data(), static_cast<int>(w.size()), nullptr, 0,
nullptr, nullptr);
if (needed <= 0) {
throw std::runtime_error("WideCharToMultiByte sizing failed ("s + windows_error_message(::GetLastError()) +
")");
}
std::string out;
out.resize(needed);
int written = ::WideCharToMultiByte(CP_UTF8, WC_ERR_INVALID_CHARS, w.data(), static_cast<int>(w.size()), out.data(),
needed, nullptr, nullptr);
if (written <= 0) {
throw std::runtime_error(
"WideCharToMultiByte convert failed, Error("s + windows_error_message(::GetLastError()) + ")" +
" Size (Needed): " + std::to_string(needed) + " Size (Written): " + std::to_string(written) +
" Size (Allocated): " + std::to_string(out.size()));
}
return out;
}
void parse_windows_arguments(std::vector<std::string> &parsed_arguments,
std::function<void(std::string)> const &setProgramName) {
int argc_w;
std::unique_ptr<LPWSTR[], local_free_deleter> argv_w(CommandLineToArgvW(GetCommandLineW(), &argc_w));
if (argv_w == nullptr) {
throw std::runtime_error("CommandLineToArgvW failed");
}
if (argc_w <= 0) {
return;
}
setProgramName(utf8_from_wstring(argv_w[0]));
for (int i = 1; i < argc_w; i++) {
try {
std::string arg = utf8_from_wstring(argv_w[i]);
parsed_arguments.emplace_back(arg);
} catch (std::runtime_error e) {
std::cerr << "Error: " << e.what() << std::endl;
}
}
}
namespace argument_parser {
windows_parser::windows_parser() {
parse_windows_arguments(parsed_arguments,
[this](std::string const &program_name) { this->program_name = program_name; });
}
} // namespace argument_parser
namespace argument_parser::v2 {
windows_parser::windows_parser() {
parse_windows_arguments(ref_parsed_args(),
[this](std::string const &program_name) { this->set_program_name(program_name); });
}
} // namespace argument_parser::v2
#endif