language_tag_intf.hpp

// Copyright Take Vos 2022.
// Distributed under the Boost Software License, Version 1.0.
// (See accompanying file LICENSE_1_0.txt or copy at https://www.boost.org/LICENSE_1_0.txt)
 
#pragma once
 
#include "iso_15924.hpp"
#include "iso_3166.hpp"
#include "iso_639.hpp"
#include "../utility/utility.hpp"
#include "../algorithm/algorithm.hpp"
#include "../macros.hpp"
#include <vector>
#include <string_view>
#include <coroutine>
#include <format>
#include <string>
 
hi_export_module(hikogui.i18n.language_tag : intf);
 
hi_export namespace hi { inline namespace v1 {
 
hi_export class language_tag {
public:
    iso_639 language;
    iso_15924 script;
    iso_3166 region;
    uint16_t _reserved = 0;
 
    constexpr language_tag() noexcept {}
    constexpr language_tag(language_tag const&) noexcept = default;
    constexpr language_tag(language_tag&&) noexcept = default;
    constexpr language_tag& operator=(language_tag const&) noexcept = default;
    constexpr language_tag& operator=(language_tag&&) noexcept = default;
 
    constexpr language_tag(iso_639 const& language, iso_15924 const& script = {}, iso_3166 const& region = {}) noexcept :
        language(language), script(script), region(region)
    {
    }
 
    constexpr language_tag(iso_639 const& language, iso_3166 const& region) noexcept : language_tag(language, {}, region) {}
 
    language_tag(std::string_view str);
 
    [[nodiscard]] static language_tag parse(std::string_view str);
 
    [[nodiscard]] bool empty() const noexcept
    {
        return language.empty() and script.empty() and region.empty();
    }
 
    explicit operator bool() const noexcept
    {
        return not empty();
    }
 
    [[nodiscard]] generator<language_tag> variants() const noexcept
    {
        co_yield *this;
        if (script and region) {
            co_yield language_tag{language, region};
            co_yield language_tag{language, script};
        }
        if (script or region) {
            co_yield language_tag{language};
        }
    }
 
    [[nodiscard]] generator<language_tag> canonical_variants() const noexcept
    {
        auto const check = expand();
        for (auto const& tag : variants()) {
            if (tag.expand() == check) {
                co_yield tag;
            }
        }
    }
 
    [[nodiscard]] std::vector<language_tag> all_variants() const noexcept
    {
        auto r = make_vector(variants());
 
        // And languages variants from expanded variants.
        for (auto const variant : variants()) {
            auto expanded_variant = variant.expand();
            for (auto const expanded_variant_variants : expanded_variant.variants()) {
                if (std::find(r.begin(), r.end(), expanded_variant_variants) == r.end()) {
                    r.push_back(expanded_variant_variants);
                }
            }
        }
        return r;
    }
 
    [[nodiscard]] language_tag expand() const noexcept;
 
    [[nodiscard]] language_tag shrink() const noexcept
    {
        auto last_variant = *this;
        for (auto const& variant : canonical_variants()) {
            last_variant = variant;
        }
        return last_variant;
    }
 
    [[nodiscard]] iso_15924 default_script() const noexcept
    {
        return expand().script;
    }
 
    [[nodiscard]] bool left_to_right() const noexcept
    {
        return default_script().left_to_right();
    }
 
    [[nodiscard]] constexpr friend std::string to_string(language_tag const &rhs) noexcept
    {
        auto r = std::string{};
        r += rhs.language.code();
        if (rhs.script) {
            r += '-';
            r += rhs.script.code4();
        }
        if (rhs.region) {
            r += "-";
            r += rhs.region.code2();
        }
        return r;
    }
 
    [[nodiscard]] constexpr friend bool matches(language_tag const& lhs, language_tag const& rhs) noexcept
    {
        if (lhs.language and rhs.language and lhs.language != rhs.language) {
            return false;
        }
        if (lhs.script and rhs.script and lhs.script != rhs.script) {
            return false;
        }
        if (lhs.region and rhs.region and lhs.region != rhs.region) {
            return false;
        }
        return true;
    }
 
    [[nodiscard]] constexpr friend bool operator==(language_tag const&, language_tag const&) noexcept = default;
};
 
hi_export [[nodiscard]] std::vector<language_tag> variants(std::vector<language_tag> languages);
 
}} // namespace hi::inline v1
 
hi_export template<>
struct std::hash<hi::language_tag> {
    [[nodiscard]] size_t operator()(hi::language_tag const& rhs) const noexcept
    {
        return hi::hash_mix(
            std::hash<hi::iso_639>{}(rhs.language),
            std::hash<hi::iso_15924>{}(rhs.script),
            std::hash<hi::iso_3166>{}(rhs.region));
    }
};
 
// XXX #617 MSVC bug does not handle partial specialization in modules.
hi_export template<>
struct std::formatter<hi::language_tag, char> : std::formatter<std::string_view, char> {
    auto format(hi::language_tag const& t, auto& fc) const
    {
        return std::formatter<std::string_view, char>::format(to_string(t), fc);
    }
};
 
// XXX #618 C++23 should have this fixed?
// XXX #617 MSVC bug does not handle partial specialization in modules.
hi_export template<>
struct std::formatter<std::vector<hi::language_tag>, char> : std::formatter<std::string_view, char> {
    auto format(std::vector<hi::language_tag> const& t, auto& fc) const
    {
        auto r = std::string{};
        for (auto const language : t) {
            if (not r.empty()) {
                r += ", ";
            }
            r += std::format("{}", language);
        }
        return std::formatter<std::string_view, char>::format(r, fc);
    }
};