skullbrain-parser 0.1.0

Parses skullbrain tokens into a concrete syntax tree (CST).
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

mod expr;
mod nodes;
mod tokens;
mod utils;

use crate::SyntaxKind;
use utils::{define_cst_node, define_cst_token};

pub use expr::*;
pub use nodes::*;
pub use tokens::*;

/// A utility type alias
pub type SyntaxNode = cstree::syntax::SyntaxNode<SyntaxKind>;
/// A utility type alias
pub type SyntaxToken = cstree::syntax::SyntaxToken<SyntaxKind>;
/// A utility type alias
pub type SyntaxNodeChildren<'a> = cstree::syntax::SyntaxNodeChildren<'a, SyntaxKind>;
/// A utility type alias
pub type SyntaxElementRef<'a> = cstree::syntax::SyntaxElementRef<'a, SyntaxKind>;

/// Core abstraction for typed CST node wrappers
pub trait CstNode: Sized {
    /// Returns true if the given syntax kind can be cast to this node type
    fn can_cast(kind: SyntaxKind) -> bool;

    /// Attempts to cast a raw syntax node to this typed node
    ///
    /// Returns `Some(Self)` if the cast is valid, `None` otherwise
    fn cast(node: SyntaxNode) -> Option<Self>;

    /// Returns a reference to the underlying syntax node
    fn syntax(&self) -> &SyntaxNode;
}

/// Core abstraction for typed CST token wrappers
pub trait CstToken: Sized {
    /// Returns true if the given syntax kind can be cast to this token type
    fn can_cast(kind: SyntaxKind) -> bool;

    /// Attempts to cast a raw syntax token to this typed token
    ///
    /// Returns `Some(Self)` if the cast is valid, `None` otherwise
    fn cast(token: SyntaxToken) -> Option<Self>;

    /// Returns a reference to the underlying syntax token
    fn token(&self) -> &SyntaxToken;
}