summaryrefslogtreecommitdiffstats
path: root/src/poem/read.rs
blob: 2b0dd6083d42f4135352ce18f705b1882a7fc667 (plain)
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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
use super::{
    elements::{rune::Rune, verse::Verse, word::Word},
    Poem,
};
use core::fmt;
mod parse;
use crate::compose::Environment;
use crate::{next, poem, remark, string};

#[derive(Debug, PartialEq, Eq)]
pub enum Mishap {
    ParseMishap(usize, usize, char),
    IOMishap(usize, usize, char),
    PartialMishap(usize, usize, char),
}

impl fmt::Display for Mishap {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        let message = match self {
            Mishap::ParseMishap(j, i, c) => {
                format!("parse error on line {} pos {} near '{}'", j, i, c)
            }
            Mishap::IOMishap(j, i, c) => {
                format!(
                    "must provide file for io operation on line {} pos {} near '{}'",
                    j, i, c
                )
            }
            Mishap::PartialMishap(j, i, c) => {
                format!(
                    "partial string or action on line {} pos {} near '{}'",
                    j, i, c
                )
            }
        };

        write!(f, "{}", message)
    }
}

/// A [Poem] can add more [Verse]s to itself
trait Appendable {
    type Type;
    fn add(
        &mut self,
        verse: &mut Self::Type,
        meter: Rune,
        last: Rune,
        env: &Environment,
    ) -> Result<(), Mishap>;
}

impl Appendable for Poem {
    type Type = Verse;

    /// Push a [Verse] to the [Poem]
    ///
    /// Push a [Verse] to the [Poem] after checking that the [Verse] is not
    /// empty. Also sets the meter of the [Verse].
    fn add(
        &mut self,
        verse: &mut Self::Type,
        last: Rune,
        meter: Rune,
        env: &Environment,
    ) -> Result<(), Mishap> {
        if verse.is_empty() {
            return Ok(());
        }

        // Check the meter
        verse.meter = meter;
        if last == Rune::Couplet || meter == Rune::Couplet {
            verse.couplet = true;
        }

        // Check for aliases
        match env.aliases.get(&verse.verb()) {
            Some(alias) => {
                // Interpret the alias (could be a complex poem)
                let mut poem = Poem::read(alias.to_string(), env)?;
                println!("{:?}", poem);

                // Try and get the last verse
                let lv = match poem.last_mut() {
                    Some(lv) => lv,
                    None => unreachable!(), // Should be caught by a Mishap above
                };

                // The last verse inherits the traits from the original
                if verse.couplet {
                    lv.couplet = verse.couplet;
                }
                lv.io = verse.io;
                lv.poems = verse.poems.clone();
                lv.meter = verse.meter;
                if verse.clause().is_some() {
                    for word in verse.clause().unwrap().iter() {
                        lv.stanza.push(word.to_string());
                    }
                }

                // Push verse(s)
                for v in poem.iter() {
                    self.push(v.clone());
                }
            }
            None => {
                // Push verse(s)
                self.push(verse.clone());
            }
        }

        // Clear the current verse stack
        verse.clear();

        // Unit
        Ok(())
    }
}

/// A [Poem] can parse poetry
pub trait Readable {
    fn read(poetry: String, env: &Environment) -> Result<Poem, Mishap>;
}

impl Readable for Poem {
    /// Parse a [Poem] from a raw [String] input
    ///
    /// Takes a shell command/program or file and converts it to a
    /// machine-runnable [Poem]. If there is a parse error, [Poem::read] may
    /// return a [Mishap]. See [Poem::recite][super::recite] for how each
    /// [Verse] in a [Poem] is called.
    fn read(poetry: String, env: &Environment) -> Result<Poem, Mishap> {
        // Get all the characters in the input string as an iterator
        let mut chars = poetry.chars().into_iter();

        // Create a stack to store words
        let mut word: Word = Word::new();

        // Create a stack to store the current verse
        let mut verse: Verse = Verse::new();

        // Create a vector to return
        let mut poem: Self = Poem::new();

        // Keep track of the last rune
        let mut last = Rune::None;

        // Keep track of the line
        let mut j = 0;

        // Keep track of the column
        let mut i = 0;

        // Loop through every char in the iterator
        loop {
            // Get the next character, and unwrap it
            let c = chars.next();
            let c = match c {
                Some(c) => c,
                None => {
                    // Check for IO parse errors
                    if last == Rune::Read || last == Rune::Write || last == Rune::Addendum {
                        return Err(Mishap::IOMishap(j, i, ' '));
                    }

                    // If c is none, it indicates the end of a poem, so wrap up and
                    // then break from the loop
                    verse.add(&mut word);

                    // Throw an error if the verse is empty
                    if verse.is_empty() && (last == Rune::Couplet || last == Rune::And) {
                        return Err(Mishap::ParseMishap(j, i, ' '));
                    }

                    // Push the verse and break
                    poem.add(&mut verse, last, Rune::None, env)?;
                    // append!(poem, last, Rune::None, verse, env);
                    break;
                }
            };

            // Determine the meter based on the character
            let rune = match c {
                ' ' => Rune::Pause,
                '/' => Rune::Path,
                '#' => Rune::Remark,
                '\'' | '"' => Rune::String,
                '`' => Rune::Poem,
                '<' => {
                    verse.couplet = true;
                    Rune::Read
                }
                '>' => next!(chars, i, Rune::Write, Rune::Addendum, '>'),
                '|' => Rune::Couplet,
                '&' => next!(chars, i, Rune::Quiet, Rune::And, '&'),
                ';' => Rune::Continue,
                '\n' => {
                    j += 1;
                    i = 0;
                    Rune::Continue
                }
                '~' => Rune::Home,
                _ => Rune::Else,
            };

            // Some error checking, based on the last character
            match rune {
                Rune::Couplet
                | Rune::Quiet
                | Rune::And
                | Rune::Read
                | Rune::Write
                | Rune::Addendum => {
                    if (last == Rune::Couplet
                        || last == Rune::Quiet
                        || last == Rune::And
                        || last == Rune::Read
                        || last == Rune::Write
                        || last == Rune::Addendum)
                        || verse.is_empty()
                    {
                        return Err(Mishap::ParseMishap(j, i, c));
                    }
                }

                Rune::Continue => {
                    if last == Rune::Read || last == Rune::Write || last == Rune::Addendum {
                        return Err(Mishap::ParseMishap(j, i, c));
                    }
                }

                _ => {
                    if (last == Rune::Read || last == Rune::Write || last == Rune::Addendum)
                        && rune == Rune::None
                        && rune == Rune::Read
                        && rune == Rune::Write
                        && rune == Rune::Addendum
                        && rune == Rune::Couplet
                        && rune == Rune::Quiet
                        && rune == Rune::And
                        && rune == Rune::Continue
                    {
                        return Err(Mishap::IOMishap(j, i, c));
                    }
                }
            };

            // Do some action, based on the rune
            match rune {
                // Indicates the end of a word (space dilineated)
                Rune::Pause => {
                    verse.add(&mut word);
                }

                Rune::Remark => {
                    remark!(chars);
                }

                // Indicates a string (' or ")
                Rune::String => {
                    string!(chars, j, i, c, word);
                    verse.add(&mut word);
                }

                // Indicates a sub-poem
                Rune::Poem => {
                    poem!(chars, j, i, c, verse, word, env);
                }

                // Indicates a file operation (<, >, or >>)
                Rune::Read | Rune::Write | Rune::Addendum => {
                    verse.add(&mut word);
                    word.push('<');
                    verse.add(&mut word);
                    verse.io = rune;
                }

                // These meters indicate the end of a verse
                Rune::Couplet | Rune::Quiet | Rune::And | Rune::Continue => {
                    verse.add(&mut word);
                    poem.add(&mut verse, last, rune, env)?;
                    // append!(poem, last, rune, verse, env);
                }

                // Interpret ~ as $HOME
                Rune::Home => {
                    let mut chars = env!("HOME").chars().collect();
                    word.append(&mut chars);
                }

                // Any other char i.e. Meter::Else
                _ => {
                    word.push(c);
                }
            }

            // Set the last meter
            if rune != Rune::Pause {
                last = rune;
            }

            // Increment i, but don't drift over newlines
            if c != '\n' {
                i += 1;
            }
        }

        // Return the poem
        Ok(poem)
    }
}