forgedb-parser 0.2.0

Parser for ForgeDB schema language
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
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
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
// Re-export Position from validation crate for consistency
pub use forgedb_validation::Position;

/// Token with position information
#[derive(Debug, Clone, PartialEq)]
pub struct TokenWithPos {
    pub token: Token,
    pub position: Position,
}

/// Token types for the schema language
#[derive(Debug, Clone, PartialEq)]
pub enum Token {
    // Identifiers and literals
    Ident(String),

    // Types
    TypeU32,
    TypeU64,
    TypeI32,
    TypeI64,
    TypeF64,
    TypeBool,
    TypeString,
    TypeUuid,
    TypeTimestamp,
    TypeJson,    // json - variable-length column typed serde_json::Value
    TypeDecimal, // decimal - fixed 16-byte column typed rust_decimal::Decimal
    TypeChar,    // char(N) - fixed-size character array

    // Keywords
    KwStruct, // struct
    KwEnum,   // enum

    // Symbols
    Plus,        // +
    Ampersand,   // &
    Caret,       // ^
    Colon,       // :
    LBrace,      // {
    RBrace,      // }
    LBracket,    // [
    RBracket,    // ]
    Asterisk,    // *
    Question,    // ?
    At,          // @
    LParen,      // (
    RParen,      // )
    Comma,       // ,
    Semicolon,   // ;
    Slash,       // /
    Number(i64), // Numeric literal
    Str(String), // String literal: "..." (directive arguments, e.g. @pattern("^[a-z]+$"))

    // Whitespace and EOF
    Newline,
    Eof,
}

pub struct Lexer {
    input: Vec<char>,
    position: usize,
    pub line: usize,
    pub column: usize,
    /// Start position of the most recently produced token, recorded *after*
    /// leading whitespace/comments are skipped so positions point at the token
    /// itself (not the preceding indentation).
    token_start: Position,
}

impl Lexer {
    pub fn new(input: &str) -> Self {
        Lexer {
            input: input.chars().collect(),
            position: 0,
            line: 1,
            column: 1,
            token_start: Position { line: 1, column: 1 },
        }
    }

    fn current_char(&self) -> Option<char> {
        if self.position < self.input.len() {
            Some(self.input[self.position])
        } else {
            None
        }
    }

    fn advance(&mut self) {
        if let Some(ch) = self.current_char() {
            if ch == '\n' {
                self.line += 1;
                self.column = 1;
            } else {
                self.column += 1;
            }
            self.position += 1;
        }
    }

    fn skip_whitespace(&mut self) {
        while let Some(ch) = self.current_char() {
            if ch == ' ' || ch == '\t' || ch == '\r' {
                self.advance();
            } else {
                break;
            }
        }
    }

    fn skip_whitespace_with_flag(&mut self) -> bool {
        let start_pos = self.position;
        self.skip_whitespace();
        // Return true if we skipped any whitespace, or if we're at the start of a line
        self.position > start_pos || self.column == 1
    }

    fn skip_comment(&mut self) {
        // Skip until end of line
        while let Some(ch) = self.current_char() {
            if ch == '\n' {
                break;
            }
            self.advance();
        }
    }

    fn read_identifier(&mut self) -> String {
        let mut ident = String::new();
        while let Some(ch) = self.current_char() {
            if ch.is_alphanumeric() || ch == '_' {
                ident.push(ch);
                self.advance();
            } else {
                break;
            }
        }
        ident
    }

    fn read_number(&mut self) -> Result<i64, String> {
        let mut num_str = String::new();
        while let Some(ch) = self.current_char() {
            if ch.is_numeric() {
                num_str.push(ch);
                self.advance();
            } else {
                break;
            }
        }
        num_str.parse::<i64>().map_err(|e| {
            format!(
                "Numeric literal '{}' is out of range at line {}, column {}: {}",
                num_str, self.line, self.column, e
            )
        })
    }

    /// Read a double-quoted string literal, consuming the opening and closing quotes.
    /// Supports the escapes `\"`, `\\`, `\n`, `\t`, `\r`. Called with the cursor on the
    /// opening `"`.
    fn read_string(&mut self) -> Result<String, String> {
        let start_line = self.line;
        let start_column = self.column;
        self.advance(); // consume opening quote

        let mut value = String::new();
        loop {
            match self.current_char() {
                None => {
                    return Err(format!(
                        "Unterminated string literal starting at line {}, column {}",
                        start_line, start_column
                    ));
                }
                Some('"') => {
                    self.advance(); // consume closing quote
                    return Ok(value);
                }
                Some('\\') => {
                    self.advance();
                    match self.current_char() {
                        Some('"') => value.push('"'),
                        Some('\\') => value.push('\\'),
                        Some('n') => value.push('\n'),
                        Some('t') => value.push('\t'),
                        Some('r') => value.push('\r'),
                        Some(other) => {
                            return Err(format!(
                                "Invalid escape sequence '\\{}' in string literal at line {}, column {}",
                                other, self.line, self.column
                            ));
                        }
                        None => {
                            return Err(format!(
                                "Unterminated string literal starting at line {}, column {}",
                                start_line, start_column
                            ));
                        }
                    }
                    self.advance();
                }
                Some('\n') => {
                    return Err(format!(
                        "Unterminated string literal starting at line {}, column {} (newline before closing quote)",
                        start_line, start_column
                    ));
                }
                Some(ch) => {
                    value.push(ch);
                    self.advance();
                }
            }
        }
    }

    pub fn next_token(&mut self) -> Result<Token, String> {
        let had_whitespace = self.skip_whitespace_with_flag();
        // Record the token's true start (after skipping indentation/whitespace);
        // comment recursion re-enters here and overwrites this with the real token.
        self.token_start = Position {
            line: self.line,
            column: self.column,
        };

        match self.current_char() {
            None => Ok(Token::Eof),
            Some('\n') => {
                self.advance();
                Ok(Token::Newline)
            }
            Some('/') => {
                self.advance();
                // Only treat // as a comment if there was preceding whitespace or we're at line start
                // This allows tsx://path to work while preserving // comments
                if self.current_char() == Some('/') && had_whitespace {
                    self.advance();
                    self.skip_comment();
                    // After comment, get next token
                    self.next_token()
                } else {
                    // Single slash token (for component paths like tsx://path)
                    Ok(Token::Slash)
                }
            }
            Some('+') => {
                self.advance();
                Ok(Token::Plus)
            }
            Some('&') => {
                self.advance();
                Ok(Token::Ampersand)
            }
            Some('^') => {
                self.advance();
                Ok(Token::Caret)
            }
            Some(':') => {
                self.advance();
                Ok(Token::Colon)
            }
            Some('{') => {
                self.advance();
                Ok(Token::LBrace)
            }
            Some('}') => {
                self.advance();
                Ok(Token::RBrace)
            }
            Some('[') => {
                self.advance();
                Ok(Token::LBracket)
            }
            Some(']') => {
                self.advance();
                Ok(Token::RBracket)
            }
            Some('*') => {
                self.advance();
                Ok(Token::Asterisk)
            }
            Some('?') => {
                self.advance();
                Ok(Token::Question)
            }
            Some('@') => {
                self.advance();
                Ok(Token::At)
            }
            Some('(') => {
                self.advance();
                Ok(Token::LParen)
            }
            Some(')') => {
                self.advance();
                Ok(Token::RParen)
            }
            Some(',') => {
                self.advance();
                Ok(Token::Comma)
            }
            Some(';') => {
                self.advance();
                Ok(Token::Semicolon)
            }
            Some('"') => {
                let s = self.read_string()?;
                Ok(Token::Str(s))
            }
            Some(ch) if ch.is_numeric() => {
                let num = self.read_number()?;
                Ok(Token::Number(num))
            }
            Some(ch) if ch.is_alphabetic() || ch == '_' => {
                let ident = self.read_identifier();
                let token = match ident.as_str() {
                    "u32" => Token::TypeU32,
                    "u64" => Token::TypeU64,
                    "i32" => Token::TypeI32,
                    "i64" => Token::TypeI64,
                    "f64" => Token::TypeF64,
                    "bool" => Token::TypeBool,
                    "string" => Token::TypeString,
                    "uuid" => Token::TypeUuid,
                    "timestamp" => Token::TypeTimestamp,
                    "json" => Token::TypeJson,
                    "decimal" => Token::TypeDecimal,
                    "char" => Token::TypeChar,
                    "struct" => Token::KwStruct,
                    "enum" => Token::KwEnum,
                    _ => Token::Ident(ident),
                };
                Ok(token)
            }
            Some(ch) => Err(format!(
                "Unexpected character '{}' at line {}, column {}",
                ch, self.line, self.column
            )),
        }
    }

    pub fn next_token_with_pos(&mut self) -> Result<TokenWithPos, String> {
        let token = self.next_token()?;
        Ok(TokenWithPos {
            token,
            position: self.token_start,
        })
    }

    pub fn tokenize(&mut self) -> Result<Vec<Token>, String> {
        let mut tokens = Vec::new();
        loop {
            let token = self.next_token()?;
            if token == Token::Eof {
                tokens.push(token);
                break;
            }
            tokens.push(token);
        }
        Ok(tokens)
    }

    pub fn tokenize_with_pos(&mut self) -> Result<Vec<TokenWithPos>, String> {
        let mut tokens = Vec::new();
        loop {
            let token_with_pos = self.next_token_with_pos()?;
            let is_eof = token_with_pos.token == Token::Eof;
            tokens.push(token_with_pos);
            if is_eof {
                break;
            }
        }
        Ok(tokens)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    fn tokens(input: &str) -> Vec<Token> {
        Lexer::new(input).tokenize().expect("lex error")
    }

    #[test]
    fn lexes_basic_string_literal() {
        assert_eq!(
            tokens("\"pending\""),
            vec![Token::Str("pending".to_string()), Token::Eof]
        );
    }

    #[test]
    fn lexes_string_with_regex_metacharacters() {
        // A regex that could never be a bare identifier — the whole point of the feature.
        assert_eq!(
            tokens("\"^[a-z]+$\""),
            vec![Token::Str("^[a-z]+$".to_string()), Token::Eof]
        );
    }

    #[test]
    fn lexes_string_escapes() {
        assert_eq!(
            tokens(r#""a\"b\\c\n\t\r""#),
            vec![Token::Str("a\"b\\c\n\t\r".to_string()), Token::Eof]
        );
    }

    #[test]
    fn empty_string_literal() {
        assert_eq!(tokens("\"\""), vec![Token::Str(String::new()), Token::Eof]);
    }

    #[test]
    fn string_literal_in_directive_context() {
        // @pattern("^[0-9]+$")
        assert_eq!(
            tokens("@pattern(\"^[0-9]+$\")"),
            vec![
                Token::At,
                Token::Ident("pattern".to_string()),
                Token::LParen,
                Token::Str("^[0-9]+$".to_string()),
                Token::RParen,
                Token::Eof,
            ]
        );
    }

    #[test]
    fn unterminated_string_is_an_error() {
        let err = Lexer::new("\"oops").tokenize().unwrap_err();
        assert!(err.contains("Unterminated string literal"), "got: {err}");
    }

    #[test]
    fn newline_before_closing_quote_is_an_error() {
        let err = Lexer::new("\"oops\n\"").tokenize().unwrap_err();
        assert!(err.contains("Unterminated string literal"), "got: {err}");
    }

    #[test]
    fn invalid_escape_is_an_error() {
        let err = Lexer::new("\"a\\q\"").tokenize().unwrap_err();
        assert!(err.contains("Invalid escape sequence"), "got: {err}");
    }

    #[test]
    fn double_slash_comment_still_works_after_string_support() {
        // Guards the tsx://path vs // comment disambiguation is unaffected.
        assert_eq!(tokens("u32 // trailing comment"), vec![Token::TypeU32, Token::Eof]);
    }
}