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
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
use num_rational::ParseRatioError;
use std::num::ParseIntError;
use std::str::CharIndices;

pub type Spanned<Tok, Pos, Error> = Result<(Pos, Tok, Pos), Error>;

/// A lexer for producing the primitive GCode tokens in [`LexTok`].
/// Operates as a [Mealy Machine](https://en.wikipedia.org/wiki/Mealy_machine).
pub struct Lexer<'input> {
    input: &'input str,
    chars: CharIndices<'input>,
    state: LexerState,
}

#[derive(Debug, Clone, PartialEq)]
pub enum LexicalError {
    /// This character is not part of the [ASCII character set](https://en.wikipedia.org/wiki/ASCII),
    /// or its presence does not make sense in the context of GCode (i.e. a stray dollar sign)
    UnexpectedCharacter(usize, char),
    /// A [`LexTok::InlineComment`] started but a [`LexTok::Newline`] was encountered before it was finished.
    UnexpectedNewline(usize, LexerState),
    /// Input ended prematurely while building a [`LexTok::String`] or [`LexTok::InlineComment`]
    /// both of which require a closing delimiter
    UnexpectedEOF(usize, LexerState),
    /// A [`LexTok::Integer`] was out of the bounds of a `usize`.
    ParseIntError(ParseIntError, usize, usize),
    ParseRatioError(ParseRatioError, usize, usize),
}

#[derive(Debug, Clone, PartialEq)]
pub enum LexTok<'input> {
    Newline,
    Dot,
    Star,
    Minus,
    Percent,
    String(&'input str),
    InlineComment(&'input str),
    Comment(&'input str),
    Integer(&'input str),
    Letters(&'input str),
    Whitespace(&'input str),
}

impl<'input> LexTok<'input> {
    pub fn lalrpop_name_for_display(lalrpop_name: &str) -> Option<&'static str> {
        match lalrpop_name {
            "TokNewline" => r#"\n"#.into(),
            "TokDot" => ".".into(),
            "TokStar" => "*".into(),
            "TokMinus" => "-".into(),
            "TokPercent" => "%".into(),
            "TokString" => r#"/"[^"]*(""[^"]*)*"/"#.into(),
            "TokInlineComment" => r#"/\(.*?\)/"#.into(),
            "TokComment" => r#"/;[^\n]*/"#.into(),
            "TokInteger" => "/[0-9]+/".into(),
            "TokLetters" => "/[a-zA-Z]+/".into(),
            "TokWhitespace" => r#"/[^\S\n]+/"#.into(),
            _ => None,
        }
    }
}

#[derive(Debug, Clone, PartialEq)]
pub enum LexerState {
    Init,
    Newline(usize),
    Dot(usize),
    Star(usize),
    Minus(usize),
    Percent(usize),
    String {
        start: usize,
        prev_could_be_escaped_quote: bool,
    },
    InlineComment(usize),
    Comment(usize),
    Integer(usize),
    Letters(usize),
    Whitespace(usize),
}

impl Default for LexerState {
    fn default() -> Self {
        Self::Init
    }
}

impl<'input> Lexer<'input> {
    pub fn new(input: &'input str) -> Self {
        Lexer {
            input,
            chars: input.char_indices(),
            state: Default::default(),
        }
    }
}

impl<'input> Iterator for Lexer<'input> {
    type Item = Spanned<LexTok<'input>, usize, LexicalError>;
    fn next(&mut self) -> Option<Self::Item> {
        use LexerState::*;
        use LexicalError::*;
        loop {
            match self.state {
                Init => {
                    match self.chars.next() {
                        Some((pos, '\n')) => self.state = Newline(pos),
                        Some((pos, '"')) => {
                            self.state = String {
                                start: pos,
                                prev_could_be_escaped_quote: false,
                            }
                        }
                        Some((pos, '(')) => self.state = InlineComment(pos),
                        Some((pos, ';')) => self.state = Comment(pos),
                        Some((pos, '.')) => self.state = Dot(pos),
                        Some((pos, '*')) => self.state = Star(pos),
                        Some((pos, '-')) => self.state = Minus(pos),
                        Some((pos, '%')) => self.state = Percent(pos),
                        Some((pos, digit)) if digit.is_ascii_digit() => self.state = Integer(pos),
                        Some((pos, letter)) if letter.is_ascii_alphabetic() => {
                            self.state = Letters(pos)
                        }
                        Some((pos, whitespace))
                            if whitespace.is_ascii_whitespace() && whitespace != '\n' =>
                        {
                            self.state = Whitespace(pos)
                        }
                        Some((pos, c)) => return Some(Err(UnexpectedCharacter(pos, c))),
                        None => return None,
                    };
                }
                Newline(pos) | Dot(pos) | Star(pos) | Minus(pos) | Percent(pos) => {
                    let prev_state = self.state.clone();
                    self.state = Init;
                    return Some(Ok((
                        pos,
                        match prev_state {
                            Newline(_) => LexTok::Newline,
                            Dot(_) => LexTok::Dot,
                            Star(_) => LexTok::Star,
                            Minus(_) => LexTok::Minus,
                            Percent(_) => LexTok::Percent,
                            _ => unreachable!(),
                        },
                        pos + 1,
                    )));
                }
                String {
                    start,
                    prev_could_be_escaped_quote,
                } => match self.chars.next() {
                    Some((_, '"')) => {
                        if !prev_could_be_escaped_quote {
                            self.state = String {
                                start,
                                prev_could_be_escaped_quote: true,
                            }
                        } else {
                            // escaped quote
                            self.state = String {
                                start,
                                prev_could_be_escaped_quote: false,
                            }
                        }
                    }

                    Some((end, c)) if c.is_ascii() => {
                        if prev_could_be_escaped_quote {
                            // string just ended
                            self.state = Init;
                            return Some(Ok((
                                start,
                                LexTok::String(self.input.get(start..end).unwrap()),
                                end,
                            )));
                        }
                    }
                    Some((pos, other)) => return Some(Err(UnexpectedCharacter(pos, other))),
                    None => {
                        if prev_could_be_escaped_quote {
                            self.state = Init;
                            return Some(Ok((
                                start,
                                LexTok::String(self.input.get(start..).unwrap()),
                                self.input.len(),
                            )));
                        } else {
                            return Some(Err(UnexpectedEOF(
                                self.input.len().saturating_sub(1),
                                self.state.clone(),
                            )));
                        }
                    }
                },
                InlineComment(start) => match self.chars.next() {
                    Some((pos, '\n')) => {
                        return Some(Err(UnexpectedNewline(pos, self.state.clone())))
                    }
                    Some((end, ')')) => {
                        self.state = Init;
                        return Some(Ok((
                            start,
                            LexTok::InlineComment(self.input.get(start..=end).unwrap()),
                            // inclusive of last character
                            end + 1,
                        )));
                    }
                    Some((_, c)) if c.is_ascii() => {}
                    Some((pos, other)) => return Some(Err(UnexpectedCharacter(pos, other))),
                    None => {
                        return Some(Err(UnexpectedEOF(
                            self.input.len().saturating_sub(1),
                            self.state.clone(),
                        )))
                    }
                },
                Comment(start) => match self.chars.next() {
                    None => {
                        self.state = Init;
                        return Some(Ok((
                            start,
                            LexTok::Comment(self.input.get(start..).unwrap()),
                            self.input.len(),
                        )));
                    }
                    Some((end, '\n')) => {
                        self.state = Newline(end);
                        return Some(Ok((
                            start,
                            LexTok::Comment(self.input.get(start..end).unwrap()),
                            end,
                        )));
                    }
                    Some((_, c)) if c.is_ascii() => {}
                    Some((pos, other)) => return Some(Err(UnexpectedCharacter(pos, other))),
                },
                Integer(start) | Letters(start) | Whitespace(start) => {
                    let original_state = self.state.clone();
                    let output = match self.chars.next() {
                        None => {
                            self.state = Init;
                            Some((start, self.input.len()))
                        }
                        Some((end, '\n')) => {
                            self.state = Newline(end);
                            Some((start, end))
                        }
                        Some((end, '.')) => {
                            self.state = Dot(end);
                            Some((start, end))
                        }
                        Some((end, '*')) => {
                            self.state = Star(end);
                            Some((start, end))
                        }
                        Some((end, '-')) => {
                            self.state = Minus(end);
                            Some((start, end))
                        }
                        Some((end, '"')) => {
                            self.state = String {
                                start: end,
                                prev_could_be_escaped_quote: false,
                            };
                            Some((start, end))
                        }
                        Some((end, '(')) => {
                            self.state = InlineComment(end);
                            Some((start, end))
                        }
                        Some((end, ';')) => {
                            self.state = Comment(end);
                            Some((start, end))
                        }
                        Some((end, '%')) => {
                            self.state = Percent(end);
                            Some((start, end))
                        }
                        Some((pos, non_ascii)) if !non_ascii.is_ascii() => {
                            return Some(Err(UnexpectedCharacter(pos, non_ascii)));
                        }
                        Some((end, other)) => {
                            if !other.is_ascii_digit()
                                && !other.is_ascii_alphabetic()
                                && !other.is_ascii_whitespace()
                            {
                                return Some(Err(UnexpectedCharacter(end, other)));
                            }
                            if let Letters(_) | Integer(_) = &original_state {
                                if other.is_ascii_whitespace() && other != '\n' {
                                    self.state = Whitespace(end);
                                    Some((start, end))
                                } else {
                                    None
                                }
                            } else {
                                None
                            }
                            .or(if let Whitespace(_) | Integer(_) = &original_state {
                                if other.is_ascii_alphabetic() {
                                    self.state = Letters(end);
                                    Some((start, end))
                                } else {
                                    None
                                }
                            } else {
                                None
                            })
                            .or(
                                if let Whitespace(_) | Letters(_) = &original_state {
                                    if other.is_ascii_digit() {
                                        self.state = Integer(end);
                                        Some((start, end))
                                    } else {
                                        None
                                    }
                                } else {
                                    None
                                },
                            )
                        }
                    };

                    if let Some((start, end)) = output {
                        match original_state {
                            Whitespace(_) => {
                                return Some(Ok((
                                    start,
                                    LexTok::Whitespace(self.input.get(start..end).unwrap()),
                                    end,
                                )))
                            }
                            Letters(_) => {
                                return Some(Ok((
                                    start,
                                    LexTok::Letters(self.input.get(start..end).unwrap()),
                                    end,
                                )))
                            }
                            Integer(_) => {
                                return Some(Ok((
                                    start,
                                    LexTok::Integer(self.input.get(start..end).unwrap()),
                                    end,
                                )))
                            }
                            _ => unreachable!(),
                        }
                    }
                }
            }
        }
    }
}