word.hpp

/*
 * CoNLL-U - https://github.com/tugrulgungor/CoNLL-U
 *
 * Copyright (c) 2026. All rights reserved.
 * Tuğrul Güngör - https://conll-u.tugrulgungor.me
 *
 * Distributed under the MIT License.
 * https://opensource.org/license/mit/
 */

 
#ifndef TG_CONLLU_WORD_HPP
#define TG_CONLLU_WORD_HPP 1
 
#include "conllu/token.hpp"
 
namespace tg::conllu {
    class Sentence;

    class Word final {
    public:
        struct Range final {
            TokenId first;
            TokenId last;

            [[nodiscard]] constexpr std::size_t count() const noexcept;
            [[nodiscard]] constexpr bool contains(TokenId id) const noexcept;
            [[nodiscard]] constexpr bool overlaps(Range range) const noexcept;
            [[nodiscard]] constexpr bool equals(Range range) const noexcept;
            [[nodiscard]] constexpr bool is_valid() const noexcept;
            [[nodiscard]] constexpr bool is_valid(TokenId max) const noexcept;
        };
 
    private:
        Range range_{};
        std::optional<std::string> form_{std::nullopt};
        std::optional<std::string> misc_{std::nullopt};
        std::optional<bool> typo_{std::nullopt};
 
        Sentence* sentence_{nullptr};
 
        explicit(true) constexpr Word(Sentence* sentence) noexcept;
 
        friend class Sentence;
        friend class Writer;
 
    public:
        constexpr Word() noexcept = delete;
        constexpr std::error_code set_range(Range range) noexcept;
        constexpr std::error_code set_range(TokenId first, TokenId last) noexcept;
        [[nodiscard]] constexpr TokenId first_id() const noexcept;
        [[nodiscard]] constexpr TokenId last_id() const noexcept;
        [[nodiscard]] constexpr std::optional<std::string_view> get_form() const noexcept;
        constexpr std::error_code set_form(const std::optional<std::string_view>& form) noexcept;
        constexpr void unset_form() noexcept;
        [[nodiscard]] constexpr std::optional<std::string_view> get_misc() const noexcept;
        constexpr std::error_code set_misc(const std::optional<std::string_view>& misc) noexcept;
        constexpr void unset_misc() noexcept;
        [[nodiscard]] constexpr std::optional<bool> get_typo() const noexcept;
        constexpr void set_typo(std::optional<bool> typo) noexcept;
        constexpr void unset_typo() noexcept;
        [[nodiscard]] constexpr auto tokens() const noexcept;
        [[nodiscard]] constexpr std::size_t num_tokens() const noexcept;
        [[nodiscard]] constexpr bool contains_token(Token* token) const noexcept;
        [[nodiscard]] constexpr bool contains_token_id(TokenId id) const noexcept;
        [[nodiscard]] constexpr std::error_code validate() const noexcept;
        constexpr ~Word() noexcept = default;
    };
} // namespace tg::conllu
 
#endif // TG_CONLLU_WORD_HPP