df_ls_structure 0.3.0-rc.1

A language server for Dwarf Fortress RAW files
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

use df_ls_core::{AllowEmpty, ReferenceTo, Referenceable};
use df_ls_syntax_analysis::TokenDeserialize;
use serde::{Deserialize, Serialize};

#[derive(Serialize, Deserialize, Clone, Debug, TokenDeserialize, PartialEq, Eq)]
pub enum LanguageToken {
    #[token_de(token = "WORD")]
    WordToken(WordToken),
    #[token_de(token = "SYMBOL")]
    SymbolToken(SymbolToken),
    #[token_de(token = "TRANSLATION")]
    TranslationToken(TranslationToken),
}

impl Default for LanguageToken {
    fn default() -> Self {
        Self::WordToken(WordToken::default())
    }
}

#[derive(
    Serialize, Deserialize, Clone, Debug, Default, TokenDeserialize, PartialEq, Eq, Referenceable,
)]
pub struct TranslationToken {
    /// Argument 1 of `TRANSLATION`
    /// The reference for a Translation in other RAW files and tokens
    #[token_de(token = "TRANSLATION", on_duplicate_to_parent, primary_token)]
    #[referenceable(self_reference)]
    pub reference: Option<ReferenceTo<Self>>,
    ///
    #[token_de(token = "T_WORD")]
    pub t_word: Vec<(ReferenceTo<WordToken>, String)>,
}

#[derive(
    Serialize, Deserialize, Clone, Debug, Default, TokenDeserialize, PartialEq, Eq, Referenceable,
)]
pub struct SymbolToken {
    /// Argument 1 of `SYMBOL`
    /// The reference for a Symbol in other RAW files and tokens
    #[token_de(token = "SYMBOL", on_duplicate_to_parent, primary_token)]
    #[referenceable(self_reference)]
    pub reference: Option<ReferenceTo<Self>>,
    ///
    #[token_de(token = "S_WORD")]
    pub s_word: Vec<ReferenceTo<WordToken>>,
}

#[derive(
    Serialize, Deserialize, Clone, Debug, Default, TokenDeserialize, PartialEq, Eq, Referenceable,
)]
pub struct WordToken {
    /// Argument 1 of `WORD`
    /// The reference for a Word in other RAW files and tokens
    #[token_de(token = "WORD", on_duplicate_to_parent, primary_token)]
    #[referenceable(self_reference)]
    pub reference: Option<ReferenceTo<Self>>,
    ///
    #[token_de(token = "NOUN")]
    pub nouns: Vec<NounToken>,
    ///
    #[token_de(token = "ADJ")]
    pub adj: Vec<AdjToken>,
    ///
    #[token_de(token = "VERB")]
    pub verb: Vec<VerbToken>,
    ///
    #[token_de(token = "PREFIX")]
    pub prefix: Vec<PrefixToken>,
}

#[derive(Serialize, Deserialize, Clone, Debug, Default, TokenDeserialize, PartialEq, Eq)]
pub struct NounToken {
    /// Argument 1 of `NOUN`
    ///
    #[token_de(token = "NOUN", on_duplicate_to_parent, primary_token)]
    pub words: Option<(String, AllowEmpty<String>)>,
    ///
    #[token_de(token = "FRONT_COMPOUND_NOUN_SING")]
    pub front_compound_noun_sing: Option<()>,
    ///
    #[token_de(token = "REAR_COMPOUND_NOUN_SING")]
    pub read_compound_noun_sing: Option<()>,
    ///
    #[token_de(token = "THE_COMPOUND_NOUN_SING")]
    pub the_compound_noun_sing: Option<()>,
    ///
    #[token_de(token = "THE_NOUN_SING")]
    pub the_noun_sing: Option<()>,
    ///
    #[token_de(token = "OF_NOUN_SING")]
    pub of_noun_sing: Option<()>,
    ///
    #[token_de(token = "FRONT_COMPOUND_NOUN_PLUR")]
    pub front_compound_noun_plur: Option<()>,
    ///
    #[token_de(token = "REAR_COMPOUND_NOUN_PLUR")]
    pub read_compound_noun_plur: Option<()>,
    ///
    #[token_de(token = "THE_COMPOUND_NOUN_PLUR")]
    pub the_compound_noun_plur: Option<()>,
    ///
    #[token_de(token = "THE_NOUN_PLUR")]
    pub the_noun_plur: Option<()>,
    ///
    #[token_de(token = "OF_NOUN_PLUR")]
    pub of_noun_plur: Option<()>,
}

#[derive(Serialize, Deserialize, Clone, Debug, Default, TokenDeserialize, PartialEq, Eq)]
pub struct VerbToken {
    /// Argument 1 of `VERB`
    #[token_de(token = "VERB", on_duplicate_to_parent, primary_token)]
    pub words: Option<(String, String, String, String, String)>,
    ///
    #[token_de(token = "STANDARD_VERB")]
    pub standard_verb: Option<()>,
    ///
    #[token_de(token = "FRONT_COMPOUND_ADJ")]
    pub front_compound_adj: Option<()>,
    ///
    #[token_de(token = "THE_COMPOUND_ADJ")]
    pub the_compound_adj: Option<()>,
    ///
    #[token_de(token = "REAR_COMPOUND_ADJ")]
    pub rear_compound_adj: Option<()>,
}

#[derive(Serialize, Deserialize, Clone, Debug, Default, TokenDeserialize, PartialEq, Eq)]
pub struct AdjToken {
    /// Argument 1 of `ADJ`
    #[token_de(token = "ADJ", on_duplicate_to_parent, primary_token)]
    pub words: Option<String>,
    ///
    #[token_de(token = "ADJ_DIST")]
    pub adj_dist: Option<i32>,
    ///
    #[token_de(token = "FRONT_COMPOUND_ADJ")]
    pub front_compound_adj: Option<()>,
    ///
    #[token_de(token = "THE_COMPOUND_ADJ")]
    pub the_compound_adj: Option<()>,
    ///
    #[token_de(token = "REAR_COMPOUND_ADJ")]
    pub rear_compound_adj: Option<()>,
}

#[derive(Serialize, Deserialize, Clone, Debug, Default, TokenDeserialize, PartialEq, Eq)]
pub struct PrefixToken {
    /// Argument 1 of `PREFIX`
    #[token_de(token = "PREFIX", on_duplicate_to_parent, primary_token)]
    pub words: Option<String>,
    ///
    #[token_de(token = "FRONT_COMPOUND_PREFIX")]
    pub front_compound_prefix: Option<()>,
    ///
    #[token_de(token = "THE_COMPOUND_PREFIX")]
    pub the_compound_prefix: Option<()>,
}