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
use crate::is_atom_chr;
use crate::is_atom_string_chr;

#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub enum ParsedItem<'a> {
    /// An atom
    ///
    /// The `usize` specifies its byte offset in the input file
    Atom(&'a str, usize),
    /// The start of a list (`(`)
    ///
    /// The `usize` specifies its byte offset in the input file
    ListStart(usize),
    /// The end of a list (`)`)
    ///
    /// The `usize` specifies its byte offset in the input file
    ListEnd(usize),
}

/// Represents a parse error.
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum ParseError {
    /// There is an invalid character
    IllegalChr { pos: usize, chr: char },

    /// There is an invalid character inside a string (enclosed with `"`)
    IllegalChrInString { pos: usize, chr: char },

    /// There is an invalid character inside a comment
    IllegalChrInComment { pos: usize, chr: char },

    /// End-of-file is reached before finding the closing `"`
    UnfinishedString { pos: usize },

    /// Unexpected end-of-file
    UnexpectedEof { pos: usize },

    /// Unexpected `)`
    UnexpectedRightParen { pos: usize },

    /// Found a token when expecting end-of-file
    ExpectedEof { pos: usize },
}

impl core::fmt::Display for ParseError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match *self {
            ParseError::IllegalChr { pos, chr } => {
                write!(f, "illegal character {:?} at byte {}", chr, pos)
            }
            ParseError::IllegalChrInString { pos, chr } => {
                write!(f, "illegal character {:?} in string at byte {}", chr, pos)
            }
            ParseError::IllegalChrInComment { pos, chr } => {
                write!(f, "illegal character {:?} in comment at byte {}", chr, pos)
            }
            ParseError::UnfinishedString { pos } => write!(f, "unfinished string at byte {}", pos),
            ParseError::UnexpectedEof { pos } => {
                write!(f, "unexpected end-of-file at byte {}", pos)
            }
            ParseError::UnexpectedRightParen { pos } => {
                write!(f, "unexpected `)` at byte {}", pos)
            }
            ParseError::ExpectedEof { pos } => write!(f, "expected end-of-file at byte {}", pos),
        }
    }
}

#[cfg(feature = "std")]
impl std::error::Error for ParseError {}

/// Parser that decodes a SISE file into a sequence of [`ParsedItem`].
///
/// # Example
///
/// ```
/// let data = "(test (1 2 3))";
/// let mut parser = sise::Parser::new(data);
/// assert_eq!(parser.next_item().unwrap(), sise::ParsedItem::ListStart(0));
/// assert_eq!(
///     parser.next_item().unwrap(),
///     sise::ParsedItem::Atom("test", 1),
/// );
/// assert_eq!(parser.next_item().unwrap(), sise::ParsedItem::ListStart(6));
/// assert_eq!(parser.next_item().unwrap(), sise::ParsedItem::Atom("1", 7));
/// assert_eq!(parser.next_item().unwrap(), sise::ParsedItem::Atom("2", 9));
/// assert_eq!(parser.next_item().unwrap(), sise::ParsedItem::Atom("3", 11));
/// assert_eq!(parser.next_item().unwrap(), sise::ParsedItem::ListEnd(12));
/// assert_eq!(parser.next_item().unwrap(), sise::ParsedItem::ListEnd(13));
/// parser.finish().unwrap();
/// ```
pub struct Parser<'a> {
    lexer: Lexer<'a>,
    state: State,
}

enum State {
    Beginning,
    Parsing { depth: usize },
    Finishing,
}

impl<'a> Parser<'a> {
    pub fn new(data: &'a str) -> Self {
        Self {
            lexer: Lexer::new(data),
            state: State::Beginning,
        }
    }

    pub fn next_item(&mut self) -> Result<ParsedItem<'a>, ParseError> {
        match self.state {
            State::Beginning => {
                let (pos, token) = self.lexer.get_token()?;
                match token {
                    Token::Eof => Err(ParseError::UnexpectedEof { pos }),
                    Token::LeftParen => {
                        self.state = State::Parsing { depth: 0 };
                        Ok(ParsedItem::ListStart(pos))
                    }
                    Token::RightParen => Err(ParseError::UnexpectedRightParen { pos }),
                    Token::Atom(atom) => {
                        self.state = State::Finishing;
                        Ok(ParsedItem::Atom(atom, pos))
                    }
                }
            }
            State::Parsing { ref mut depth } => {
                let (pos, token) = self.lexer.get_token()?;
                match token {
                    Token::Eof => Err(ParseError::UnexpectedEof { pos }),
                    Token::LeftParen => {
                        *depth += 1;
                        Ok(ParsedItem::ListStart(pos))
                    }
                    Token::RightParen => {
                        if *depth == 0 {
                            self.state = State::Finishing;
                        } else {
                            *depth -= 1;
                        }
                        Ok(ParsedItem::ListEnd(pos))
                    }
                    Token::Atom(atom) => Ok(ParsedItem::Atom(atom, pos)),
                }
            }
            State::Finishing => panic!("parsing finished"),
        }
    }

    pub fn finish(mut self) -> Result<(), ParseError> {
        match self.state {
            State::Finishing => {
                let (pos, token) = self.lexer.get_token()?;
                match token {
                    Token::Eof => Ok(()),
                    _ => Err(ParseError::ExpectedEof { pos }),
                }
            }
            _ => panic!("parsing not finished yet"),
        }
    }
}

#[derive(Clone, Debug, PartialEq, Eq)]
enum Token<'a> {
    Eof,
    LeftParen,
    RightParen,
    Atom(&'a str),
}

struct Lexer<'a> {
    rem_input: &'a str,
    rem_offset: usize,
}

impl<'a> Lexer<'a> {
    fn new(input: &'a str) -> Self {
        Lexer {
            rem_input: input,
            rem_offset: 0,
        }
    }

    #[must_use]
    #[inline]
    fn eat_any_char(&mut self) -> Option<char> {
        let mut iter = self.rem_input.chars();
        if let Some(chr) = iter.next() {
            let new_rem = iter.as_str();
            self.rem_offset += self.rem_input.len() - new_rem.len();
            self.rem_input = new_rem;
            Some(chr)
        } else {
            None
        }
    }

    #[must_use]
    #[inline]
    fn eat_char(&mut self, chr: char) -> bool {
        if let Some(new_rem) = self.rem_input.strip_prefix(chr) {
            self.rem_offset += self.rem_input.len() - new_rem.len();
            self.rem_input = new_rem;
            true
        } else {
            false
        }
    }

    #[must_use]
    #[inline]
    fn eat_char_if(&mut self, pred: impl FnMut(char) -> bool) -> bool {
        if let Some(new_rem) = self.rem_input.strip_prefix(pred) {
            self.rem_offset += self.rem_input.len() - new_rem.len();
            self.rem_input = new_rem;
            true
        } else {
            false
        }
    }

    fn get_token(&mut self) -> Result<(usize, Token<'a>), ParseError> {
        loop {
            let start_str = self.rem_input;
            let chr_pos = self.rem_offset;
            if self.eat_char(' ')
                || self.eat_char('\t')
                || self.eat_char('\n')
                || self.eat_char('\r')
            {
                // skip whitespace
            } else if self.eat_char(';') {
                // skip comments
                loop {
                    let chr_pos = self.rem_offset;
                    match self.eat_any_char() {
                        None => return Ok((self.rem_offset, Token::Eof)),
                        Some('\n' | '\r') => break,
                        Some('\t' | ' '..='~') => {}
                        Some(chr) => {
                            return Err(ParseError::IllegalChrInComment { chr, pos: chr_pos });
                        }
                    }
                }
            } else if self.eat_char('(') {
                return Ok((chr_pos, Token::LeftParen));
            } else if self.eat_char(')') {
                return Ok((chr_pos, Token::RightParen));
            } else if let Some(chr) = self.eat_any_char() {
                if is_atom_chr(chr) || chr == '"' {
                    let begin_pos = chr_pos;
                    let end_pos = self.lex_atom(chr)?;
                    let atom = &start_str[..(end_pos - begin_pos)];
                    return Ok((begin_pos, Token::Atom(atom)));
                } else {
                    // invalid character
                    return Err(ParseError::IllegalChr { chr, pos: chr_pos });
                }
            } else {
                // end-of-file
                return Ok((self.rem_offset, Token::Eof));
            }
        }
    }

    fn lex_atom(&mut self, first_chr: char) -> Result<usize, ParseError> {
        let mut in_string = first_chr == '"';
        loop {
            let chr_pos = self.rem_offset;
            if in_string {
                if self.eat_char('"') {
                    in_string = false;
                } else if self.eat_char('\\') {
                    let chr_pos = self.rem_offset;
                    if let Some(chr) = self.eat_any_char() {
                        if chr != '"' && chr != '\\' && !is_atom_string_chr(chr) {
                            return Err(ParseError::IllegalChrInString { chr, pos: chr_pos });
                        }
                    } else {
                        return Err(ParseError::UnfinishedString { pos: chr_pos });
                    }
                } else if let Some(chr) = self.eat_any_char() {
                    if !is_atom_string_chr(chr) {
                        return Err(ParseError::IllegalChrInString { chr, pos: chr_pos });
                    }
                } else {
                    return Err(ParseError::UnfinishedString { pos: chr_pos });
                }
            } else if self.eat_char('"') {
                in_string = true;
            } else if !self.eat_char_if(is_atom_chr) {
                return Ok(chr_pos);
            }
        }
    }
}