BLT/include/blt/parse/argparse_v2.h

261 lines
7.2 KiB
C
Raw Normal View History

2025-02-12 02:54:22 -05:00
#pragma once
/*
* Copyright (C) 2024 Brett Terpstra
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#ifndef BLT_PARSE_ARGPARSE_V2_H
#define BLT_PARSE_ARGPARSE_V2_H
#include <blt/std/types.h>
#include <blt/std/hashmap.h>
#include <blt/fs/path_helper.h>
2025-02-12 02:54:22 -05:00
#include <string>
#include <string_view>
#include <vector>
#include <variant>
#include <optional>
#include <memory>
2025-02-12 19:42:50 -05:00
#include <type_traits>
2025-02-12 02:54:22 -05:00
#include <blt/iterator/enumerate.h>
2025-02-12 19:42:50 -05:00
#include <blt/std/ranges.h>
#include <blt/std/utility.h>
2025-02-12 02:54:22 -05:00
namespace blt::argparse
{
class argument_string_t;
class argument_consumer_t;
class argument_parser_t;
class argument_subparser_t;
class parsed_argset_t;
class argument_builder_t;
2025-02-12 02:54:22 -05:00
namespace detail
{
inline hashset_t<std::string_view> allowed_flag_prefixes = {"-", "--", "+"};
std::string flag_prefixes_as_string();
2025-02-12 19:42:50 -05:00
hashset_t<char> prefix_characters();
2025-02-12 02:54:22 -05:00
inline std::string flag_prefix_list_string = flag_prefixes_as_string();
2025-02-12 19:42:50 -05:00
inline auto prefix_characters_set = prefix_characters();
2025-02-12 02:54:22 -05:00
class bad_flag final : public std::runtime_error
{
public:
explicit bad_flag(const std::string& message): std::runtime_error(message)
{
}
explicit bad_flag(const char* message): std::runtime_error(message)
{
}
};
template <typename... Args>
struct arg_data_helper_t
{
using arg_primitive_data_t = std::variant<Args...>;
using arg_list_data_t = std::variant<std::vector<Args>...>;
};
using data_helper_t = arg_data_helper_t<i8, i16, i32, i64, u8, u16, u32, u64, float, double>;
using arg_primitive_data_t = data_helper_t::arg_primitive_data_t;
using arg_list_data_t = data_helper_t::arg_list_data_t;
using arg_data_t = std::variant<arg_primitive_data_t, arg_list_data_t>;
template <typename T>
2025-02-12 19:42:50 -05:00
struct arg_type_t
{
static T convert(const std::string_view value)
{
static_assert(std::is_arithmetic_v<T>, "Type must be arithmetic!");
2025-02-12 19:42:50 -05:00
const std::string temp{value};
if constexpr (std::is_same_v<T, float>)
2025-02-12 19:42:50 -05:00
{
return std::stof(temp);
}
else if constexpr (std::is_same_v<T, double>)
{
return std::stod(temp);
}
else if constexpr (std::is_unsigned_v<T>)
2025-02-12 19:42:50 -05:00
{
return static_cast<T>(std::stoull(temp));
}
else if constexpr (std::is_signed_v<T>)
{
return static_cast<T>(std::stoll(temp));
2025-02-12 19:42:50 -05:00
}
BLT_UNREACHABLE;
}
};
2025-02-12 02:54:22 -05:00
void test();
}
class argument_string_t
{
public:
explicit argument_string_t(const char* input): m_argument(input)
{
if (input == nullptr)
throw detail::bad_flag("Argument cannot be null!");
}
[[nodiscard]] std::string_view get_flag() const
{
if (!m_flag_section)
2025-02-12 02:54:22 -05:00
process_argument();
return *m_flag_section;
2025-02-12 02:54:22 -05:00
}
[[nodiscard]] std::string_view get_name() const
{
if (!m_name_section)
2025-02-12 02:54:22 -05:00
process_argument();
return *m_name_section;
2025-02-12 02:54:22 -05:00
}
[[nodiscard]] std::string_view value() const
{
return get_name();
}
[[nodiscard]] bool is_flag() const
{
if (!m_is_flag)
process_argument();
return *m_is_flag;
}
[[nodiscard]] std::string_view get_argument() const
{
return m_argument;
}
private:
void process_argument() const
{
2025-02-12 15:43:54 -05:00
size_t start = m_argument.size();
for (auto [i, c] : enumerate(m_argument))
2025-02-12 02:54:22 -05:00
{
2025-02-12 19:42:50 -05:00
if (!detail::prefix_characters_set.contains(c))
2025-02-12 15:43:54 -05:00
{
start = i;
2025-02-12 02:54:22 -05:00
break;
2025-02-12 15:43:54 -05:00
}
2025-02-12 02:54:22 -05:00
}
m_is_flag = (start != 0);
m_flag_section = {m_argument.data(), start};
m_name_section = {m_argument.data() + start, m_argument.size() - start};
2025-02-12 02:54:22 -05:00
if (!m_flag_section->empty() && !detail::allowed_flag_prefixes.contains(*m_flag_section))
2025-02-12 02:54:22 -05:00
throw detail::bad_flag(
"Invalid flag " + std::string(*m_flag_section) + " detected, flag is not in allowed list of flags! Must be one of " +
2025-02-12 15:43:54 -05:00
detail::flag_prefix_list_string);
2025-02-12 02:54:22 -05:00
}
std::string_view m_argument;
mutable std::optional<bool> m_is_flag;
mutable std::optional<std::string_view> m_flag_section;
mutable std::optional<std::string_view> m_name_section;
2025-02-12 02:54:22 -05:00
};
class argument_consumer_t
{
public:
explicit argument_consumer_t(const span<argument_string_t>& args): m_args(args)
2025-02-12 02:54:22 -05:00
{
}
2025-02-12 19:42:50 -05:00
[[nodiscard]] argument_string_t peek(const i32 offset = 0) const
2025-02-12 02:54:22 -05:00
{
return m_args[m_forward_index + offset];
2025-02-12 02:54:22 -05:00
}
2025-02-12 19:42:50 -05:00
argument_string_t consume()
2025-02-12 02:54:22 -05:00
{
return m_args[m_forward_index++];
2025-02-12 02:54:22 -05:00
}
[[nodiscard]] i32 position() const
{
return m_forward_index;
2025-02-12 02:54:22 -05:00
}
[[nodiscard]] i32 remaining() const
{
return static_cast<i32>(m_args.size()) - m_forward_index;
2025-02-12 02:54:22 -05:00
}
[[nodiscard]] bool has_next(const i32 offset = 0) const
{
return (offset + m_forward_index) < m_args.size();
}
private:
span<argument_string_t> m_args;
i32 m_forward_index = 0;
};
class argument_builder_t
{
public:
private:
};
class parsed_argset_t
{
public:
private:
};
class argument_parser_t
{
public:
argument_parser_t(const std::optional<std::string_view> name = {}, const std::optional<std::string_view> usage = {}):
m_name(name.value_or(std::optional<std::string>{})), m_usage(usage.value_or(std::optional<std::string>{}))
{
2025-02-12 02:54:22 -05:00
}
argument_parser_t& set_name(const std::string_view name)
{
m_name = name;
return *this;
}
private:
std::optional<std::string> m_name;
std::optional<std::string> m_usage;
std::optional<std::string> m_description;
std::optional<std::string> m_epilogue;
};
class argument_subparser_t
{
public:
2025-02-12 02:54:22 -05:00
private:
2025-02-12 02:54:22 -05:00
};
}
#endif //BLT_PARSE_ARGPARSE_V2_H