unicode_description.hpp

// Copyright Take Vos 2020-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 "unicode_general_category.hpp"
#include "unicode_bidi_class.hpp"
#include "unicode_bidi_bracket_type.hpp"
#include "unicode_grapheme_cluster_break.hpp"
#include "unicode_line_break.hpp"
#include "unicode_word_break.hpp"
#include "unicode_sentence_break.hpp"
#include "unicode_east_asian_width.hpp"
#include "unicode_decomposition_type.hpp"
#include "unicode_script.hpp"
#include "../required.hpp"
#include "../assert.hpp"
#include "../cast.hpp"
 
namespace hi::inline v1 {
 
constexpr char32_t unicode_replacement_character = U'\ufffd';
constexpr char32_t unicode_LS = U'\u2028';
constexpr char32_t unicode_PS = U'\u2029';
 
class unicode_description {
public:
    constexpr unicode_description() noexcept = default;
    unicode_description(unicode_description const&) = delete;
    unicode_description& operator=(unicode_description const&) = delete;
    constexpr unicode_description(unicode_description&&) noexcept = default;
    constexpr unicode_description& operator=(unicode_description&&) noexcept = default;
 
    [[nodiscard]] constexpr unicode_description(
        unicode_general_category general_category,
        unicode_grapheme_cluster_break grapheme_cluster_break,
        unicode_line_break_class line_break_class,
        unicode_word_break_property word_break_property,
        unicode_sentence_break_property sentence_break_property,
        unicode_east_asian_width east_asian_width,
        unicode_script script,
        unicode_bidi_class bidi_class,
        unicode_bidi_bracket_type bidi_bracket_type,
        char32_t bidi_mirroring_glyph,
        uint8_t canonical_combining_class,
        unicode_decomposition_type decomposition_type,
        uint32_t decomposition_index,
        uint16_t composition_index) noexcept :
        _general_category(to_underlying(general_category)),
        _grapheme_cluster_break(to_underlying(grapheme_cluster_break)),
        _line_break_class(to_underlying(line_break_class)),
        _word_break_property(to_underlying(word_break_property)),
        _sentence_break_property(to_underlying(sentence_break_property)),
        _east_asian_width(to_underlying(east_asian_width)),
        _script(to_underlying(script)),
        _bidi_class(to_underlying(bidi_class)),
        _bidi_bracket_type(to_underlying(bidi_bracket_type)),
        _bidi_mirroring_glyph(truncate<uint32_t>(bidi_mirroring_glyph)),
        _canonical_combining_class(truncate<uint32_t>(canonical_combining_class)),
        _decomposition_type(to_underlying(decomposition_type)),
        _decomposition_index(truncate<uint32_t>(decomposition_index)),
        _composition_index(truncate<uint16_t>(composition_index))
    {
        hi_axiom(to_underlying(general_category) <= 0x1f);
        hi_axiom(to_underlying(grapheme_cluster_break) <= 0x0f);
        hi_axiom(to_underlying(line_break_class) <= 0x3f);
        hi_axiom(to_underlying(word_break_property) <= 0x1f);
        hi_axiom(to_underlying(sentence_break_property) <= 0xf);
        hi_axiom(to_underlying(east_asian_width) <= 0x7);
        hi_axiom(to_underlying(script) <= 0xff);
        hi_axiom(to_underlying(bidi_class) <= 0x1f);
        hi_axiom(to_underlying(bidi_bracket_type) <= 0x03);
        hi_axiom(static_cast<uint32_t>(bidi_mirroring_glyph) <= 0xffff);
        hi_axiom(static_cast<uint32_t>(canonical_combining_class) <= 0xff);
        hi_axiom(to_underlying(decomposition_type) <= 0x1f);
        hi_axiom(static_cast<uint32_t>(decomposition_index) <= 0x1f'ffff);
        hi_axiom(static_cast<uint32_t>(composition_index) <= 0x3fff);
    }
 
    [[nodiscard]] constexpr unicode_general_category general_category() const noexcept
    {
        return static_cast<unicode_general_category>(_general_category);
    }
 
    [[nodiscard]] constexpr unicode_grapheme_cluster_break grapheme_cluster_break() const noexcept
    {
        return static_cast<unicode_grapheme_cluster_break>(_grapheme_cluster_break);
    }
 
    [[nodiscard]] constexpr unicode_line_break_class line_break_class() const noexcept
    {
        return static_cast<unicode_line_break_class>(_line_break_class);
    }
 
    [[nodiscard]] constexpr unicode_word_break_property word_break_property() const noexcept
    {
        return static_cast<unicode_word_break_property>(_word_break_property);
    }
 
    [[nodiscard]] constexpr unicode_sentence_break_property sentence_break_property() const noexcept
    {
        return static_cast<unicode_sentence_break_property>(_sentence_break_property);
    }
 
    [[nodiscard]] constexpr unicode_east_asian_width east_asian_width() const noexcept
    {
        return static_cast<unicode_east_asian_width>(_east_asian_width);
    }
 
    [[nodiscard]] constexpr unicode_bidi_class bidi_class() const noexcept
    {
        return static_cast<unicode_bidi_class>(_bidi_class);
    }
 
    [[nodiscard]] constexpr unicode_script script() const noexcept
    {
        return static_cast<unicode_script>(_script);
    }
 
    [[nodiscard]] constexpr unicode_bidi_bracket_type bidi_bracket_type() const noexcept
    {
        return static_cast<unicode_bidi_bracket_type>(_bidi_bracket_type);
    }
 
    [[nodiscard]] constexpr char32_t bidi_mirroring_glyph() const noexcept
    {
        return truncate<char32_t>(_bidi_mirroring_glyph);
    }
 
    [[nodiscard]] constexpr unicode_decomposition_type decomposition_type() const noexcept
    {
        return static_cast<unicode_decomposition_type>(_decomposition_type);
    }
 
    [[nodiscard]] constexpr uint8_t canonical_combining_class() const noexcept
    {
        return truncate<uint8_t>(_canonical_combining_class);
    }
 
    [[nodiscard]] std::u32string decompose() const noexcept;
 
    [[nodiscard]] char32_t compose(char32_t other) const noexcept;
 
    [[nodiscard]] constexpr char32_t canonical_equivalent() const noexcept
    {
        if (decomposition_type() == unicode_decomposition_type::canonical and _decomposition_index <= 0x1f'ffff) {
            return truncate<char32_t>(_decomposition_index);
        } else {
            return U'\uffff';
        }
    }
 
    [[nodiscard]] static unicode_description const& find(char32_t code_point) noexcept;
 
    [[nodiscard]] friend bool operator==(unicode_description const& lhs, unicode_general_category const& rhs) noexcept
    {
        return lhs.general_category() == rhs;
    }
 
    [[nodiscard]] friend bool operator==(unicode_description const& lhs, unicode_decomposition_type const& rhs) noexcept
    {
        return lhs.decomposition_type() == rhs;
    }
 
    [[nodiscard]] friend bool operator==(unicode_description const& lhs, unicode_bidi_bracket_type const& rhs) noexcept
    {
        return lhs.bidi_bracket_type() == rhs;
    }
 
    [[nodiscard]] friend bool operator==(unicode_description const& lhs, unicode_bidi_class const& rhs) noexcept
    {
        return lhs.bidi_class() == rhs;
    }
    [[nodiscard]] friend bool operator==(unicode_description const& lhs, unicode_east_asian_width const& rhs) noexcept
    {
        return lhs.east_asian_width() == rhs;
    }
 
    [[nodiscard]] friend bool operator==(unicode_description const& lhs, unicode_sentence_break_property const& rhs) noexcept
    {
        return lhs.sentence_break_property() == rhs;
    }
 
    [[nodiscard]] friend bool operator==(unicode_description const& lhs, unicode_line_break_class const& rhs) noexcept
    {
        return lhs.line_break_class() == rhs;
    }
 
    [[nodiscard]] friend bool operator==(unicode_description const& lhs, unicode_word_break_property const& rhs) noexcept
    {
        return lhs.word_break_property() == rhs;
    }
 
    [[nodiscard]] friend bool operator==(unicode_description const& lhs, unicode_grapheme_cluster_break const& rhs) noexcept
    {
        return lhs.grapheme_cluster_break() == rhs;
    }
 
    [[nodiscard]] friend bool is_C(unicode_description const& rhs) noexcept
    {
        return is_C(rhs.general_category());
    }
 
private:
    // 1st qword
    uint64_t _general_category : 5;
    uint64_t _grapheme_cluster_break : 4;
    uint64_t _line_break_class : 6;
    uint64_t _word_break_property : 5;
    uint64_t _sentence_break_property : 4;
    uint64_t _east_asian_width : 3;
    uint64_t _bidi_class : 5;
    uint64_t _bidi_bracket_type : 2;
    uint64_t _bidi_mirroring_glyph : 16;
    uint64_t _canonical_combining_class : 8;
    uint64_t _word0_reserved : 6 = 0;
 
    // 2nd qword
    uint64_t _script : 8;
    uint64_t _decomposition_type : 5;
    uint64_t _decomposition_index : 21;
    uint64_t _composition_index : 14;
    uint64_t _word1_reserved : 16 = 0;
};
 
static_assert(sizeof(unicode_description) == 16);
 
} // namespace hi::inline v1