oak-matlab 0.0.11

MATLAB numerical computing language parser with support for scientific computing, data analysis, and visualization.
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

#![doc = include_str!("readme.md")]
use core::range::Range;

/// MATLAB Abstract Syntax Tree Root Node
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct MatlabRoot {
    /// List of items in script or function
    pub items: Vec<Item>,
}

/// Top-level items in MATLAB
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum Item {
    /// Function definition
    Function(Function),
    /// Class definition
    Class(Class),
    /// Statement
    Statement(Statement),
}

/// Function definition
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Function {
    /// Function name
    pub name: String,
    /// Input parameters
    pub inputs: Vec<String>,
    /// Output parameters
    pub outputs: Vec<String>,
    /// Function body
    pub body: Vec<Statement>,
    /// Source code span
    #[cfg_attr(feature = "serde", serde(with = "oak_core::serde_range"))]
    pub span: Range<usize>,
}

/// Class definition
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Class {
    /// Class name
    pub name: String,
    /// Base classes
    pub superclasses: Vec<String>,
    /// Property block
    pub properties: Vec<Property>,
    /// Method block
    pub methods: Vec<Function>,
    /// Source code span
    #[cfg_attr(feature = "serde", serde(with = "oak_core::serde_range"))]
    pub span: Range<usize>,
}

/// Property
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Property {
    /// Property name
    pub name: String,
    /// Default value
    pub default_value: Option<String>,
    /// Source code span
    #[cfg_attr(feature = "serde", serde(with = "oak_core::serde_range"))]
    pub span: Range<usize>,
}

/// Statement
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum Statement {
    /// Assignment statement
    Assignment {
        /// Target of the assignment.
        target: String,
        /// Value assigned.
        value: String,
        /// Source range.
        #[cfg_attr(feature = "serde", serde(with = "oak_core::serde_range"))]
        span: Range<usize>,
    },
    /// Expression statement
    Expression {
        /// Expression value.
        value: String,
        /// Source range.
        #[cfg_attr(feature = "serde", serde(with = "oak_core::serde_range"))]
        span: Range<usize>,
    },
    /// If statement
    If {
        /// Condition.
        condition: String,
        /// Body of the if branch.
        body: Vec<Statement>,
        /// Else-if branches.
        else_ifs: Vec<(String, Vec<Statement>)>,
        /// Else branch body.
        else_body: Option<Vec<Statement>>,
        /// Source range.
        #[cfg_attr(feature = "serde", serde(with = "oak_core::serde_range"))]
        span: Range<usize>,
    },
    /// For loop
    For {
        /// Loop variable.
        variable: String,
        /// Range of the loop.
        range: String,
        /// Body of the loop.
        body: Vec<Statement>,
        /// Source range.
        #[cfg_attr(feature = "serde", serde(with = "oak_core::serde_range"))]
        span: Range<usize>,
    },
    /// While loop
    While {
        /// Loop condition.
        condition: String,
        /// Body of the loop.
        body: Vec<Statement>,
        /// Source range.
        #[cfg_attr(feature = "serde", serde(with = "oak_core::serde_range"))]
        span: Range<usize>,
    },
}

/// Matlab script.
pub struct MatlabScript {
    /// Items in the script.
    pub items: Vec<Item>,
}

impl MatlabScript {
    /// Creates a new `MatlabScript` with the given items.
    pub fn new(items: Vec<Item>) -> Self {
        Self { items }
    }
}