oak-crystal 0.0.11

Crystal language parser with support for modern Crystal syntax and Ruby-like features.
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

#![doc = include_str!("readme.md")]

use core::range::Range;

/// Identifier in the Crystal language
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, PartialEq, Eq, Clone)]
pub struct Identifier {
    /// Name of the identifier.
    pub name: String,
    /// Range of the identifier in the source text.
    #[cfg_attr(feature = "serde", serde(with = "oak_core::serde_range"))]
    pub span: Range<usize>,
}

/// Crystal AST root
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, PartialEq, Clone)]
pub struct CrystalRoot {
    /// Items in the root.
    pub items: Vec<Item>,
}

/// Top-level items: classes, modules, methods, etc.
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, PartialEq, Clone)]
pub enum Item {
    /// Class declaration.
    Class(ClassDeclaration),
    /// Module declaration.
    Module(ModuleDeclaration),
    /// Method declaration.
    Def(MethodDeclaration),
    /// An expression.
    Expression(Expression),
}

/// Class declaration in Crystal
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, PartialEq, Clone)]
pub struct ClassDeclaration {
    /// Name of the class.
    pub name: Identifier,
    /// Body of the class.
    pub body: Vec<Item>,
    /// Range of the class declaration in the source text.
    #[cfg_attr(feature = "serde", serde(with = "oak_core::serde_range"))]
    pub span: Range<usize>,
}

/// Module declaration in Crystal
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, PartialEq, Clone)]
pub struct ModuleDeclaration {
    /// Name of the module.
    pub name: Identifier,
    /// Body of the module.
    pub body: Vec<Item>,
    /// Range of the module declaration in the source text.
    #[cfg_attr(feature = "serde", serde(with = "oak_core::serde_range"))]
    pub span: Range<usize>,
}

/// Method declaration in Crystal
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, PartialEq, Clone)]
pub struct MethodDeclaration {
    /// Name of the method.
    pub name: Identifier,
    /// Parameters of the method.
    pub params: Vec<Parameter>,
    /// Body of the method.
    pub body: Vec<Item>,
    /// Range of the method declaration in the source text.
    #[cfg_attr(feature = "serde", serde(with = "oak_core::serde_range"))]
    pub span: Range<usize>,
}

/// Parameter in a method declaration
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, PartialEq, Clone)]
pub struct Parameter {
    /// Name of the parameter.
    pub name: Identifier,
    /// Type of the parameter.
    pub type_name: Option<Identifier>,
}

/// Basic expression
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, PartialEq, Clone)]
pub enum Expression {
    /// A literal.
    Literal(Literal),
    /// A method call.
    Call(Call),
}

/// Literals in Crystal
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, PartialEq, Clone)]
pub enum Literal {
    /// Numeric literal.
    Number(String),
    /// String literal.
    String(String),
    /// Boolean literal.
    Boolean(bool),
    /// `nil` literal.
    Nil,
}

/// Method call
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, PartialEq, Clone)]
pub struct Call {
    /// Receiver of the call.
    pub receiver: Option<Box<Expression>>,
    /// Name of the method called.
    pub name: Identifier,
    /// Arguments passed to the call.
    pub args: Vec<Expression>,
}