kast-ast 0.1.0

ast parser for kast
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
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
use std::{borrow::Cow, collections::HashSet};

use decursion::FutureExt;
use kast_util::*;

mod lexer;
mod peek2;
mod syntax;

pub use lexer::{is_punctuation, lex, StringType, Token};
pub use syntax::{Associativity, Priority, Syntax, SyntaxDefinition, SyntaxDefinitionPart};

use lexer::*;
use syntax::{BindingPower, Edge};

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum Ast<Data = Span> {
    Simple {
        token: Token,
        data: Data,
    },
    Complex {
        definition: Parc<SyntaxDefinition>,
        values: Tuple<Self>,
        data: Data,
    },
    SyntaxDefinition {
        def: Parc<SyntaxDefinition>,
        data: Data,
    },
    FromScratch {
        next: Option<Box<Self>>,
        data: Data,
    },
}

impl<Data> Ast<Data> {
    pub fn data(&self) -> &Data {
        match self {
            Ast::Simple { data, .. }
            | Ast::Complex { data, .. }
            | Ast::SyntaxDefinition { data, .. }
            | Ast::FromScratch { data, .. } => data,
        }
    }
    pub fn data_mut(&mut self) -> &mut Data {
        match self {
            Ast::Simple { data, .. }
            | Ast::Complex { data, .. }
            | Ast::SyntaxDefinition { data, .. }
            | Ast::FromScratch { data, .. } => data,
        }
    }
    pub fn map_data<NewData>(self, f: impl Fn(Data) -> NewData + Copy) -> Ast<NewData> {
        match self {
            Ast::Simple { token, data } => Ast::Simple {
                token,
                data: f(data),
            },
            Ast::Complex {
                definition,
                values,
                data,
            } => Ast::Complex {
                definition,
                values: values.map(|ast| ast.map_data(f)),
                data: f(data),
            },
            Ast::SyntaxDefinition { def, data } => Ast::SyntaxDefinition { def, data: f(data) },
            Ast::FromScratch { next, data } => Ast::FromScratch {
                next: next.map(|ast| Box::new(ast.map_data(f))),
                data: f(data),
            },
        }
    }
    pub fn as_ident(&self) -> Option<&str> {
        match self {
            Ast::Simple {
                token: Token::Ident { name, .. },
                ..
            } => Some(name),
            _ => None,
        }
    }
}

pub trait HasSpan {
    fn span(&self) -> &Span;
}

impl HasSpan for Span {
    fn span(&self) -> &Span {
        self
    }
}

impl<Data: HasSpan> Ast<Data> {
    pub fn show_short(&self) -> impl std::fmt::Display + '_ {
        struct Show<'a, Data>(&'a Ast<Data>);
        impl<Data: HasSpan> std::fmt::Display for Show<'_, Data> {
            fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
                match &self.0 {
                    Ast::Simple { token, data: _ } => write!(f, "token {token}")?,
                    Ast::Complex {
                        definition,
                        values: _,
                        data: _,
                    } => write!(f, "{:?}", definition.name)?,
                    Ast::SyntaxDefinition { def: _, data: _ } => write!(f, "syntax definition")?,
                    Ast::FromScratch { next: _, data: _ } => write!(f, "syntax from scratch")?,
                }
                write!(f, " at {}", self.0.data().span())
            }
        }
        Show(self)
    }
}

impl<Data> std::fmt::Display for Ast<Data> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Ast::Simple { token, data: _ } => write!(f, "{:?}", token.raw()),
            Ast::Complex {
                definition,
                values,
                data: _,
            } => {
                write!(f, "{}", values.fmt_with_name(&definition.name))
            }
            Ast::SyntaxDefinition { def, data: _ } => write!(f, "syntax {:?}", def.name),
            Ast::FromScratch { next, data: _ } => {
                write!(f, "syntax from scratch")?;
                if let Some(next) = next {
                    write!(f, "{next}")?;
                }
                Ok(())
            }
        }
    }
}

pub fn parse(syntax: &Syntax, source: SourceFile) -> Result<Option<Ast>, Error> {
    let mut parser = Parser {
        reader: lex(source)?,
    };
    let result = parser.read_all(syntax);
    result.map_err(|msg| {
        msg.at(match parser.reader.peek() {
            Some(peek) => peek.span.clone(),
            None => Span {
                start: parser.reader.position(),
                end: parser.reader.position(),
                filename: parser.reader.filename().to_owned(),
            },
        })
    })
}

pub fn read_syntax(source: SourceFile) -> Result<Syntax, Error> {
    let ast = parse(&Syntax::empty(), source)?;
    let mut syntax = Syntax::empty();
    fn collect_syntax_definitions(syntax: &mut Syntax, ast: Ast) -> Result<(), Error> {
        match ast {
            Ast::Simple { .. } => {}
            Ast::Complex {
                definition: _,
                values,
                data: _,
            } => {
                for (_name, value) in values {
                    collect_syntax_definitions(syntax, value)?;
                }
            }
            Ast::SyntaxDefinition { def, data: span } => {
                syntax
                    .insert(def)
                    .map_err(|ErrorMessage(message)| Error { message, span })?;
            }
            Ast::FromScratch { next, data: _ } => {
                if let Some(next) = next {
                    collect_syntax_definitions(syntax, *next)?;
                }
            }
        }
        Ok(())
    }
    if let Some(ast) = ast {
        collect_syntax_definitions(&mut syntax, ast)?;
    }
    Ok(syntax)
}

struct Parser {
    reader: peek2::Reader<SpannedToken>,
}

enum ParsedSyntax {
    Definition(SyntaxDefinition),
    FromScratch,
}

fn read_syntax_def(reader: &mut peek2::Reader<SpannedToken>) -> Result<(ParsedSyntax, Span)> {
    let Span {
        start,
        end: _,
        filename,
    } = match reader.peek().unwrap() {
        token if token.raw() == "syntax" => reader.next().unwrap().span,
        token => return error!("expected a syntax definition, got {}", token.token),
    };
    let name_token = reader.next().expect("expected a name for the syntax");
    if name_token.raw() == "from" {
        let scratch_token = reader.next().expect("expected 'scratch'");
        if scratch_token.raw() != "scratch" {
            return error!("expected 'scratch'");
        }
        return Ok((
            ParsedSyntax::FromScratch,
            Span {
                start,
                end: scratch_token.span.end,
                filename: filename.clone(),
            },
        ));
    }
    let name = match name_token.token {
        Token::Ident { name, .. } => name,
        _ => return error!("name for the syntax must be an identifier"),
    };
    let associativity = match reader.next().expect("expected a associativity").token {
        Token::Punctuation { raw } if raw == "<-" => Associativity::Left,
        Token::Punctuation { raw } if raw == "->" => Associativity::Right,
        _ => return error!("expected associativity (<- or ->)"),
    };
    let priority = match reader.next().expect("expected a priority").token {
        Token::Number { raw } | Token::String { contents: raw, .. } => {
            Priority::new(match raw.parse() {
                Ok(number) => number,
                Err(e) => return error!("failed to parse priority: {e}"),
            })
        }
        _ => return error!("syntax priority must be a number"),
    };
    if reader.next().map(|spanned| spanned.token.raw().to_owned()) != Some("=".to_owned()) {
        return error!("expected a =");
    }
    let mut parts = Vec::new();
    let mut end = None;
    while let Some(token) = reader.peek() {
        parts.push(match &token.token {
            Token::Ident { name, .. } => {
                if name == "_" {
                    SyntaxDefinitionPart::UnnamedBinding
                } else {
                    SyntaxDefinitionPart::NamedBinding(name.clone())
                }
            }
            Token::String { contents, .. } => SyntaxDefinitionPart::Keyword(contents.clone()),
            _ => break,
        });
        end = Some(reader.next().unwrap().span.end);
    }
    Ok((
        ParsedSyntax::Definition(SyntaxDefinition {
            name,
            priority,
            associativity,
            parts,
        }),
        Span {
            start,
            end: end.unwrap(),
            filename: filename.clone(),
        },
    ))
}

// My wife yelled at me for forgetting to lock the front door last night, but later apologized. She
// wanted to be safe, then sorry.

enum ProgressPart {
    Keyword(String, Span),
    Value(Ast),
}

impl ProgressPart {
    pub fn span(&self) -> &Span {
        match self {
            ProgressPart::Keyword(_, span) => span,
            ProgressPart::Value(ast) => ast.data(),
        }
    }
    pub fn into_keyword(self) -> Option<String> {
        match self {
            ProgressPart::Keyword(keyword, _) => Some(keyword),
            ProgressPart::Value(_) => None,
        }
    }
    pub fn into_value(self) -> Option<Ast> {
        match self {
            ProgressPart::Keyword(_, _) => None,
            ProgressPart::Value(value) => Some(value),
        }
    }
    fn format(progress: &[Self]) -> impl std::fmt::Display + '_ {
        struct Format<'a>(&'a [ProgressPart]);
        impl std::fmt::Display for Format<'_> {
            fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
                if self.0.is_empty() {
                    write!(f, "<no progress>")?;
                } else {
                    write!(f, "\"")?;
                    for (index, part) in self.0.iter().enumerate() {
                        if index != 0 {
                            write!(f, " ")?;
                        }
                        write!(f, "{part}")?;
                    }
                    write!(f, "\"")?;
                }
                Ok(())
            }
        }
        Format(progress)
    }
}

impl std::fmt::Display for ProgressPart {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Keyword(keyword, _) => write!(f, "{keyword}"),
            Self::Value(_) => write!(f, "_"),
        }
    }
}

/// Bеst viewers on https://www.twitch.tv/kuviman
enum ReadOneResult {
    /// Progress was made, contains the parsed expr
    Progress(Ast),
    /// No progress could be made, contains original start value
    NoProgress(Option<Ast>),
}

impl Parser {
    fn skip_comments(&mut self) {
        while self.reader.peek().unwrap().is_comment() {
            self.reader.next().unwrap();
        }
    }

    /// Read a single ast node (combine start value with smth if given),
    /// without trying to combine it with the rest of the tokens
    ///
    /// If currently parsing an inner value inside another expr,
    /// binding power of the outer expr must be taken into consideration
    async fn read_one(
        &mut self,
        syntax: &Syntax,
        continuation_keywords: &HashSet<&str>,
        start_value: Option<Ast>,
        outer_bp: Option<BindingPower>,
    ) -> Result<ReadOneResult> {
        tracing::trace!(
            "start reading one with outer_bp={outer_bp:?}, start_value={}",
            display_option(&start_value),
        );
        // first lets see if we can just read a simple value (or a syntax def)
        if start_value.is_none() {
            self.skip_comments();
            let peek = self.reader.peek().unwrap();
            let raw = peek.raw();
            if raw == "syntax" {
                tracing::trace!("see syntax keyword, parsing syntax definition...");
                let (parsed, span) = read_syntax_def(&mut self.reader)?;
                match parsed {
                    ParsedSyntax::Definition(def) => {
                        return Ok(ReadOneResult::Progress(Ast::SyntaxDefinition {
                            def: Parc::new(def),
                            data: span,
                        }));
                    }
                    ParsedSyntax::FromScratch => {
                        let next = self
                            .read_expr(&Syntax::empty(), &Default::default(), None)
                            .decurse()
                            .await?;
                        return Ok(ReadOneResult::Progress(Ast::FromScratch {
                            data: Span {
                                start: span.start,
                                end: next
                                    .as_ref()
                                    .map(|next| next.data().end)
                                    .unwrap_or(span.end),
                                filename: span.filename,
                            },
                            next: next.map(Box::new),
                        }));
                    }
                }
            }
            if !syntax.keywords.contains(raw)
                && matches!(
                    peek.token,
                    Token::String { .. } | Token::Number { .. } | Token::Ident { .. }
                )
            {
                let SpannedToken { token, span } = self.reader.next().unwrap();
                tracing::trace!("seeing a simple value {token}");
                return Ok(ReadOneResult::Progress(Ast::Simple { token, data: span }));
            }
        }
        let mut current_node;
        let mut parsed_parts = Vec::new();
        if let Some(start_value) = start_value {
            parsed_parts.push(ProgressPart::Value(start_value));
            current_node = &syntax.root_with_start_value;
        } else {
            current_node = &syntax.root_without_start_value;
        }
        let mut made_progress = false;
        loop {
            self.skip_comments();
            let peek = self.reader.peek().unwrap();
            let raw = peek.raw();
            tracing::trace!("peek = {raw}");
            if let Some(next_node) = current_node
                .next
                .get(&Edge::Keyword(raw.to_owned()))
                .filter(|_| !continuation_keywords.contains(raw))
            {
                if !should_resume(outer_bp, next_node.binding_power) {
                    tracing::trace!("not continuing with keyword {raw:?} because of outer_bp");
                    break;
                }
                tracing::trace!("continuing with keyword {raw:?}");
                parsed_parts.push({
                    let keyword = self.reader.next().unwrap();
                    ProgressPart::Keyword(keyword.token.into_raw(), keyword.span)
                });
                current_node = next_node;
                made_progress = true;
            } else if let Some(next_node) = current_node.next.get(&Edge::Value) {
                if !should_resume(outer_bp, next_node.binding_power) {
                    tracing::trace!("not trying to read a value because of outer_bp");
                    break;
                }
                let (current_bp, inner_continuation_keywords) = if current_node.is_open_paren {
                    tracing::trace!(
                        "since we just opened a paren, we reset bp and continuation keywords",
                    );
                    (None, HashSet::new())
                } else {
                    let mut keywords = continuation_keywords.clone();
                    for edge in next_node.next.keys() {
                        if edge.is_open_bracket() {
                            // TODO maybe is hack?
                            continue;
                        }
                        if let Edge::Keyword(keyword) = edge {
                            keywords.insert(keyword);
                        }
                    }
                    let bp = if !made_progress {
                        next_node.binding_power
                    } else {
                        current_node.binding_power
                    };
                    (bp, keywords)
                };
                tracing::trace!("trying to read a value to continue with");
                tracing::trace!("current_bp={current_bp:?}");
                tracing::trace!("inner_continuation_keywords={inner_continuation_keywords:?})");
                match self
                    .read_expr(syntax, &inner_continuation_keywords, current_bp)
                    .decurse()
                    .await?
                {
                    Some(value) => {
                        tracing::trace!("continuing with a value");
                        parsed_parts.push(ProgressPart::Value(value));
                        current_node = next_node;
                        made_progress = true;
                    }
                    None => {
                        tracing::trace!("did not read a value, stopping");
                        break;
                    }
                }
            } else {
                break;
            }
        }
        if !made_progress {
            tracing::trace!("no progress was made, returning start_value back");
            assert!(parsed_parts.len() <= 1);
            let start_value = parsed_parts.pop().map(|part| match part {
                ProgressPart::Keyword(_, _) => unreachable!(),
                ProgressPart::Value(value) => value,
            });
            return Ok(ReadOneResult::NoProgress(start_value));
        }
        let Some(definition) = &current_node.finish else {
            return error!(
                "Can not finish parsing {}, expected {}",
                ProgressPart::format(&parsed_parts),
                current_node.format_possible_continuations(),
            );
        };
        tracing::trace!("read one finished, collecting progress");
        let span = Span {
            filename: self.reader.filename().to_owned(),
            start: parsed_parts[0].span().start,
            end: parsed_parts.last().unwrap().span().end,
        };
        Ok(ReadOneResult::Progress(Ast::Complex {
            definition: definition.clone(),
            values: assign_progress(definition, parsed_parts).expect("Failed to assign values"),
            data: span,
        }))
    }
}

impl Parser {
    /// Try to read an expr, maybe inside another expr with given binding power
    /// (can only use stronger binding power then)
    async fn read_expr(
        &mut self,
        syntax: &Syntax,
        continuation_keywords: &HashSet<&str>,
        outer_bp: Option<BindingPower>,
    ) -> Result<Option<Ast>> {
        if self.reader.peek().unwrap().is_eof() {
            return Ok(None);
        }
        tracing::trace!("starting to read expr with outer_bp={outer_bp:?}");
        let mut syntax = Cow::Borrowed(syntax);
        let mut already_parsed = None;
        loop {
            tracing::trace!(
                "trying to read one more node with already_parsed={}",
                display_option(&already_parsed),
            );
            match self
                .read_one(&syntax, continuation_keywords, already_parsed, outer_bp)
                .await?
            {
                ReadOneResult::Progress(value) => {
                    if let Ast::SyntaxDefinition { def, data: _ } = &value {
                        let mut new_syntax = syntax.into_owned();
                        new_syntax.insert(def.clone())?;
                        syntax = Cow::Owned(new_syntax);
                    }
                    already_parsed = Some(value);
                }
                ReadOneResult::NoProgress(value) => {
                    match &value {
                        Some(value) => tracing::trace!("read expr - done! parsed {value}"),
                        None => tracing::trace!("read expr - done! nothing was parsed"),
                    }
                    return Ok(value);
                }
            }
        }
    }

    fn read_all(&mut self, syntax: &Syntax) -> Result<Option<Ast>> {
        let result = decursion::run_decursing(self.read_expr(syntax, &HashSet::new(), None))?;
        let peek = self.reader.peek().unwrap();
        if !peek.is_eof() {
            return error!("unexpected token {:?}", peek.raw());
        }
        Ok(result)
    }
}

fn assign_progress(
    definition: &SyntaxDefinition,
    values: impl IntoIterator<Item = ProgressPart>,
) -> Result<Tuple<Ast>> {
    let mut result = Tuple::empty();
    let mut progress = values.into_iter();
    for part in &definition.parts {
        let progress = progress
            .next()
            .ok_or_else(|| error_fmt!("not enough progress was made"))?;
        match part {
            SyntaxDefinitionPart::Keyword(expected) => {
                assert_eq!(
                    expected.as_str(),
                    progress
                        .into_keyword()
                        .ok_or_else(|| error_fmt!("expected a keyword"))?
                        .as_str(),
                );
            }
            SyntaxDefinitionPart::UnnamedBinding => {
                result.add_unnamed(
                    progress
                        .into_value()
                        .ok_or_else(|| error_fmt!("expected a value"))?,
                );
            }
            SyntaxDefinitionPart::NamedBinding(name) => {
                result.add_named(
                    name.clone(),
                    progress
                        .into_value()
                        .ok_or_else(|| error_fmt!("expected a value"))?,
                );
            }
        }
    }
    if progress.next().is_some() {
        return error!("too many values");
    }
    Ok(result)
}

fn should_resume(outer_bp: Option<BindingPower>, with: Option<BindingPower>) -> bool {
    let Some(outer_bp) = outer_bp else {
        return true;
    };
    match with {
        None => false,
        Some(with) => match outer_bp.priority.cmp(&with.priority) {
            std::cmp::Ordering::Equal => {
                if outer_bp.associativity != with.associativity {
                    panic!("same priority different associativity: {outer_bp:?} & {with:?}");
                }
                match outer_bp.associativity {
                    Associativity::Left => false,
                    Associativity::Right => true,
                }
            }
            std::cmp::Ordering::Less => true,
            std::cmp::Ordering::Greater => false,
        },
    }
}