varcon_core/
lib.rs

1#![cfg_attr(docsrs, feature(doc_cfg))]
2#![warn(clippy::print_stderr)]
3#![warn(clippy::print_stdout)]
4
5pub mod borrowed;
6
7#[cfg(feature = "parser")]
8mod parser;
9
10#[cfg(feature = "parser")]
11pub use crate::parser::ClusterIter;
12#[cfg(feature = "parser")]
13pub use crate::parser::ParseError;
14
15#[derive(Clone, PartialEq, Eq, Hash, Debug)]
16pub struct Cluster {
17    pub header: String,
18    pub verified: bool,
19    pub level: usize,
20    pub entries: Vec<Entry>,
21    pub notes: Vec<String>,
22}
23
24impl Cluster {
25    pub fn infer(&mut self) {
26        for entry in self.entries.iter_mut() {
27            entry.infer();
28        }
29    }
30}
31
32#[derive(Clone, PartialEq, Eq, Hash, Debug)]
33pub struct Entry {
34    pub variants: Vec<Variant>,
35    pub pos: Option<Pos>,
36    pub archaic: bool,
37    pub description: Option<String>,
38    pub note: Option<String>,
39    pub comment: Option<String>,
40}
41
42impl Entry {
43    pub fn infer(&mut self) {
44        imply(
45            &mut self.variants,
46            Category::BritishIse,
47            Category::BritishIze,
48        );
49        imply(&mut self.variants, Category::BritishIze, Category::Canadian);
50        imply(
51            &mut self.variants,
52            Category::BritishIse,
53            Category::Australian,
54        );
55    }
56}
57
58fn imply(variants: &mut [Variant], required: Category, missing: Category) {
59    let missing_exists = variants
60        .iter()
61        .any(|v| v.types.iter().any(|t| t.category == missing));
62    if missing_exists {
63        return;
64    }
65
66    for variant in variants.iter_mut() {
67        let types: Vec<_> = variant
68            .types
69            .iter()
70            .filter(|t| t.category == required)
71            .cloned()
72            .map(|mut t| {
73                t.category = missing;
74                t
75            })
76            .collect();
77        variant.types.extend(types);
78    }
79}
80
81#[derive(Clone, PartialEq, Eq, Hash, Debug)]
82pub struct Variant {
83    pub types: Vec<Type>,
84    pub word: String,
85}
86
87#[derive(Copy, Clone, PartialEq, Eq, Hash, Debug)]
88pub struct Type {
89    pub category: Category,
90    pub tag: Option<Tag>,
91    pub num: Option<usize>,
92}
93
94#[cfg_attr(feature = "flags", enumflags2::bitflags)]
95#[derive(Copy, Clone, PartialEq, Eq, Hash, Debug)]
96#[repr(u8)]
97pub enum Category {
98    American = 0x01,
99    BritishIse = 0x02,
100    BritishIze = 0x04,
101    Canadian = 0x08,
102    Australian = 0x10,
103    Other = 0x20,
104}
105
106#[cfg(feature = "flags")]
107pub type CategorySet = enumflags2::BitFlags<Category>;
108
109#[cfg_attr(feature = "flags", enumflags2::bitflags)]
110#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
111#[repr(u8)]
112pub enum Tag {
113    Eq = 0x01,
114    Variant = 0x02,
115    Seldom = 0x04,
116    Possible = 0x08,
117    Improper = 0x10,
118}
119
120#[cfg(feature = "flags")]
121pub type TagSet = enumflags2::BitFlags<Tag>;
122
123#[cfg_attr(feature = "flags", enumflags2::bitflags)]
124#[derive(Copy, Clone, PartialEq, Eq, Hash, Debug)]
125#[repr(u8)]
126pub enum Pos {
127    Noun = 0x01,
128    Verb = 0x02,
129    Adjective = 0x04,
130    Adverb = 0x08,
131    AdjectiveOrAdverb = 0x10,
132    Interjection = 0x20,
133    Preposition = 0x40,
134}
135
136#[cfg(feature = "flags")]
137pub type PosSet = enumflags2::BitFlags<Pos>;
varcon_core/lib.rs

varcon_core/
lib.rs
