-module(hanguleam@types).
-compile([no_auto_import, nowarn_unused_vars, nowarn_unused_function, nowarn_nomatch]).
-define(FILEPATH, "src/hanguleam/types.gleam").
-export_type([batchim_type/0, batchim_info/0, choseong/0, jungseong/0, jongseong/0, hangul_syllable/0, hangul_character/0, jamo/0, character_type/0]).

-type batchim_type() :: no_batchim | single | double.

-type batchim_info() :: {batchim_info,
        binary(),
        batchim_type(),
        binary(),
        list(binary())}.

-type choseong() :: {choseong, binary()}.

-type jungseong() :: {jungseong, binary()}.

-type jongseong() :: {jongseong, binary()}.

-type hangul_syllable() :: {hangul_syllable,
        choseong(),
        jungseong(),
        jongseong()}.

-type hangul_character() :: {simple_c_v, choseong(), jungseong()} |
    {compound_c_v, choseong(), jungseong()} |
    {simple_c_v_c, choseong(), jungseong(), jongseong()} |
    {compound_c_v_c, choseong(), jungseong(), jongseong()} |
    {complex_batchim, choseong(), jungseong(), jongseong()} |
    {compound_complex_batchim, choseong(), jungseong(), jongseong()}.

-type jamo() :: {consonant, binary()} | {vowel, binary()}.

-type character_type() :: non_hangul |
    empty |
    {complete_hangul, hangul_syllable()} |
    {incomplete_hangul, jamo()}.