tnil 0.1.3

Parsing, glossing, and generating utilites for New Ithkuil
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164

//! Defines formative relations.

use crate::{
    category::{
        ArbitraryMoodOrCaseScope, Case, CaseScope, DatalessRelation, IllocutionOrValidation, Mood,
        MoodOrCaseScope, NominalMode, NonDefaultCaseScope, NonDefaultMood,
    },
    specificity::{AsGeneral, TryAsSpecific},
};

/// A formative relation.
///
/// See the type aliases of [`NormalRelation`] and [`NonDefaultRelation`] for common instantiations
/// of the generics to this enum.
#[derive(Clone, Copy, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
pub enum Relation<CaseScopeType, MoodType> {
    /// A nominal formative.
    Nominal {
        /// The mode of this formative (plain nominal, framed, or concatenated).
        mode: NominalMode,

        /// The case scope of this formative.
        case_scope: CaseScopeType,

        /// The case of this formative.
        case: Case,
    },

    /// An unframed verbal formative.
    Verbal {
        /// The mood of this formative.
        mood: MoodType,

        /// The illocution or validation of this formative.
        ivl: IllocutionOrValidation,
    },
}

impl<CaseScopeType, MoodType> Relation<CaseScopeType, MoodType> {
    /// Creates a [`DatalessRelation`] from this [`Relation`].
    pub fn without_data(self) -> DatalessRelation {
        match self {
            Relation::Nominal { mode, .. } => mode.as_general(),
            Relation::Verbal { .. } => DatalessRelation::VRB,
        }
    }
}

impl<CaseScopeType, MoodType> Relation<CaseScopeType, MoodType>
where
    CaseScopeType: Into<CaseScope>,
    MoodType: Into<Mood>,
{
    /// Splits this relation into a [`DatalessRelation`], a [`ArbitraryMoodOrCaseScope`], and a [`Case`].
    pub fn split_as_dataless_cn_vc(self) -> (DatalessRelation, ArbitraryMoodOrCaseScope, Case) {
        match self {
            Relation::Nominal {
                mode,
                case_scope,
                case,
            } => (
                mode.as_general(),
                <CaseScopeType as Into<CaseScope>>::into(case_scope).as_general(),
                case,
            ),
            Relation::Verbal { mood, ivl } => (
                DatalessRelation::VRB,
                <MoodType as Into<Mood>>::into(mood).as_general(),
                ivl.as_vc(),
            ),
        }
    }
}

impl<CaseScopeType, MoodType> Default for Relation<CaseScopeType, MoodType>
where
    CaseScopeType: Default,
{
    fn default() -> Self {
        Self::Nominal {
            mode: NominalMode::NOM,
            case_scope: CaseScopeType::default(),
            case: Case::THM,
        }
    }
}

/// A formative relation that can contain a default case-scope or mood.
pub type NormalRelation = Relation<CaseScope, Mood>;

/// A formative relation that cannot contain a default case-scope or mood.
pub type NonDefaultRelation = Relation<NonDefaultCaseScope, NonDefaultMood>;

impl AsGeneral<NormalRelation> for NonDefaultRelation {
    /// Converts `self` into a [`NormalRelation`].
    fn as_general(self) -> NormalRelation {
        match self {
            Self::Nominal {
                mode,
                case_scope,
                case,
            } => NormalRelation::Nominal {
                mode,
                case_scope: case_scope.as_general(),
                case,
            },

            Self::Verbal { mood, ivl } => NormalRelation::Verbal {
                mood: mood.as_general(),
                ivl,
            },
        }
    }
}

impl From<NonDefaultRelation> for NormalRelation {
    fn from(value: NonDefaultRelation) -> Self {
        value.as_general()
    }
}

impl TryAsSpecific<NonDefaultRelation> for NormalRelation {
    fn try_as_specific(self) -> Option<NonDefaultRelation> {
        Some(match self {
            Self::Nominal {
                mode,
                case_scope,
                case,
            } => NonDefaultRelation::Nominal {
                mode,
                case_scope: match case_scope.try_as_specific() {
                    Some(value) => value,
                    None => return None,
                },
                case,
            },

            Self::Verbal { mood, ivl } => NonDefaultRelation::Verbal {
                mood: match mood.try_as_specific() {
                    Some(value) => value,
                    None => return None,
                },
                ivl,
            },
        })
    }
}

impl NormalRelation {
    /// Gets the mood or case-scope of this relation.
    pub fn mood_or_case_scope(&self) -> MoodOrCaseScope {
        match self {
            Self::Nominal { case_scope, .. } => case_scope.as_general(),
            Self::Verbal { mood, .. } => mood.as_general(),
        }
    }
}

impl NonDefaultRelation {
    /// Gets the mood or case-scope of this relation.
    pub fn mood_or_case_scope(&self) -> MoodOrCaseScope {
        self.as_general().mood_or_case_scope()
    }
}