Strings.hpp

Go to the documentation of this file.

/*
 * ======================================================================================
 *
 * ░▒▓███████▓▒░░▒▓████████▓▒░▒▓███████▓▒░       ░▒▓███████▓▒░ ░▒▓██████▓▒░▒▓████████▓▒░
 * ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░ ░▒▓█▓▒░
 * ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░ ░▒▓█▓▒░
 * ░▒▓███████▓▒░░▒▓██████▓▒░ ░▒▓█▓▒░░▒▓█▓▒░      ░▒▓███████▓▒░░▒▓█▓▒░░▒▓█▓▒░ ░▒▓█▓▒░
 * ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░ ░▒▓█▓▒░
 * ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░ ░▒▓█▓▒░
 * ░▒▓███████▓▒░░▒▓████████▓▒░▒▓█▓▒░░▒▓█▓▒░      ░▒▓███████▓▒░ ░▒▓██████▓▒░  ░▒▓█▓▒░
 *
 * ======================================================================================
 */


 
#pragma once
 
#include <array>
#include <charconv>
#include <concepts>
#include <cstddef> // IWYU pragma: keep - for size_t
#include <expected>
#include <iterator>
#include <ranges>
#include <string>
#include <string_view>
#include <system_error>
#include <utility>

namespace util::strings {
 
using std::ptrdiff_t;
using std::size_t;
using std::string_view;

using StringViewPair = std::pair<string_view, string_view>;


[[nodiscard]] auto trim(string_view text) -> string_view;

[[nodiscard]] auto split_at_first_space(string_view input) -> StringViewPair;

[[nodiscard]] auto split_at_first_space_or_newline(string_view input) -> StringViewPair;

[[nodiscard]] auto find_matching_close_paren(string_view input)
    -> std::expected<size_t, std::string>;

template <std::integral Int>
[[nodiscard]] constexpr auto int_from_string(
    string_view text, Int defaultValue = 0) noexcept
    -> Int;

template <size_t MaxLen = 5uz>
void write_integer(
    std::integral auto value,
    std::string&       output);

[[nodiscard]] auto split_by_delim(string_view text, char delim);

[[nodiscard]] auto lines_view(string_view text);

[[nodiscard]] auto words_view(string_view text);

[[nodiscard, gnu::const]] auto levenshtein_distance(
    string_view first, string_view second) -> size_t;

 
/*
                         ___                           ,--,
      ,---,            ,--.'|_                ,--,   ,--.'|
    ,---.'|            |  | :,'             ,--.'|   |  | :
    |   | :            :  : ' :             |  |,    :  : '    .--.--.
    |   | |   ,---.  .;__,'  /    ,--.--.   `--'_    |  ' |   /  /    '
  ,--.__| |  /     \ |  |   |    /       \  ,' ,'|   '  | |  |  :  /`./
 /   ,'   | /    /  |:__,'| :   .--.  .-. | '  | |   |  | :  |  :  ;_
.   '  /  |.    ' / |  '  : |__  \__\/: . . |  | :   '  : |__ \  \    `.
'   ; |:  |'   ;   /|  |  | '.'| ," .--.; | '  : |__ |  | '.'| `----.   \
|   | '/  ''   |  / |  ;  :    ;/  /  ,.  | |  | '.'|;  :    ;/  /`--'  /__  ___  ___
|   :    :||   :    |  |  ,   /;  :   .'   \;  :    ;|  ,   /'--'.     /  .\/  .\/  .\
 \   \  /   \   \  /    ---`-' |  ,     .-./|  ,   /  ---`-'   `--'---'\  ; \  ; \  ; |
  `----'     `----'             `--`---'     ---`-'                     `--" `--" `--"
 
 */
 
template <std::integral Int>
[[nodiscard]] constexpr Int int_from_string(
    const string_view text, Int defaultValue) noexcept
{
    std::from_chars(
        text.data(),
        std::next(text.data(), static_cast<ptrdiff_t>(text.length())),
        defaultValue);
 
    return defaultValue;
}
 
template <size_t MaxLen>
void write_integer(
    const std::integral auto value,
    std::string&             output)
{
    std::array<char, MaxLen + 1uz> buffer { };
 
    const auto result = std::to_chars(
        buffer.data(),
        std::next(buffer.data(), static_cast<ptrdiff_t>(buffer.size())),
        value);
 
    // simply do nothing on failure
    if (result.ec != std::errc { })
        return;
 
    output.append(
        buffer.data(),
        static_cast<size_t>(std::distance(buffer.data(), result.ptr)));
}
 
inline auto split_by_delim(string_view text, char delim)
{
    return text
         | std::views::split(delim)
         | std::views::transform([](const auto rng) { return string_view { rng }; });
}
 
inline auto lines_view(const string_view text)
{
    return split_by_delim(text, '\n');
}
 
inline auto words_view(const string_view text)
{
    return split_by_delim(text, ' ');
}
 
} // namespace util::strings