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
#![recursion_limit = "128"]
extern crate proc_macro;
use proc_macro::TokenStream;
use quote::quote;
use std::collections::HashSet;
use syn::{
braced, bracketed, parenthesized,
parse::{Error, Parse, ParseStream, Result},
parse_macro_input,
token::{Bracket, Paren},
Ident, Token, Visibility,
};
struct Output(Option<Ident>);
impl Parse for Output {
fn parse(input: ParseStream) -> Result<Self> {
if input.lookahead1().peek(Bracket) {
let output_content;
bracketed!(output_content in input);
Ok(Self(Some(output_content.parse()?)))
} else {
Ok(Self(None))
}
}
}
impl Into<Option<Ident>> for Output {
fn into(self) -> Option<Ident> {
self.0
}
}
struct TransitionEntry {
input_value: Ident,
final_state: Ident,
output: Option<Ident>,
}
impl Parse for TransitionEntry {
fn parse(input: ParseStream) -> Result<Self> {
let input_value = input.parse()?;
input.parse::<Token![=>]>()?;
let final_state = input.parse()?;
let output = input.parse::<Output>()?.into();
Ok(Self {
input_value,
final_state,
output,
})
}
}
struct TransitionDef {
initial_state: Ident,
transitions: Vec<TransitionEntry>,
}
impl Parse for TransitionDef {
fn parse(input: ParseStream) -> Result<Self> {
let initial_state = input.parse()?;
let transitions = if input.lookahead1().peek(Paren) {
let input_content;
parenthesized!(input_content in input);
let input_value = input_content.parse()?;
input.parse::<Token![=>]>()?;
let final_state = input.parse()?;
let output = input.parse::<Output>()?.into();
vec![TransitionEntry {
input_value,
final_state,
output,
}]
} else {
input.parse::<Token![=>]>()?;
let entries_content;
braced!(entries_content in input);
let entries: Vec<_> = entries_content
.parse_terminated::<_, Token![,]>(TransitionEntry::parse)?
.into_iter()
.collect();
if entries.is_empty() {
return Err(Error::new_spanned(
initial_state,
"No transitions provided for a compact representation",
));
}
entries
};
Ok(Self {
initial_state,
transitions,
})
}
}
struct StateMachineDef {
visibility: Visibility,
name: Ident,
initial_state: Ident,
transitions: Vec<TransitionDef>,
}
impl Parse for StateMachineDef {
fn parse(input: ParseStream) -> Result<Self> {
let visibility = input.parse()?;
let name = input.parse()?;
let initial_state_content;
parenthesized!(initial_state_content in input);
let initial_state = initial_state_content.parse()?;
let transitions = input
.parse_terminated::<_, Token![,]>(TransitionDef::parse)?
.into_iter()
.collect();
Ok(Self {
visibility,
name,
initial_state,
transitions,
})
}
}
struct Transition<'a> {
initial_state: &'a Ident,
input_value: &'a Ident,
final_state: &'a Ident,
output: &'a Option<Ident>,
}
#[proc_macro]
pub fn state_machine(tokens: TokenStream) -> TokenStream {
let input = parse_macro_input!(tokens as StateMachineDef);
if input.transitions.is_empty() {
let output = quote! {
compile_error!("rust-fsm: at least one state transition must be provided");
};
return output.into();
}
let struct_name = input.name;
let visibility = input.visibility;
let transitions: Vec<_> = input
.transitions
.iter()
.flat_map(|def| {
def.transitions.iter().map(move |transition| Transition {
initial_state: &def.initial_state,
input_value: &transition.input_value,
final_state: &transition.final_state,
output: &transition.output,
})
})
.collect();
let mut states = HashSet::new();
let mut inputs = HashSet::new();
let mut outputs = HashSet::new();
states.insert(&input.initial_state);
for transition in transitions.iter() {
states.insert(&transition.initial_state);
states.insert(&transition.final_state);
inputs.insert(&transition.input_value);
if let Some(ref output) = transition.output {
outputs.insert(output);
}
}
let states_enum_name = Ident::new(&format!("{}State", struct_name), struct_name.span());
let initial_state_name = &input.initial_state;
let inputs_enum_name = Ident::new(&format!("{}Input", struct_name), struct_name.span());
let mut transition_cases = vec![];
for transition in transitions.iter() {
let initial_state = &transition.initial_state;
let input_value = &transition.input_value;
let final_state = &transition.final_state;
transition_cases.push(quote! {
(#states_enum_name::#initial_state, #inputs_enum_name::#input_value) => {
Some(#states_enum_name::#final_state)
}
});
}
let (outputs_repr, outputs_type, output_impl) = if !outputs.is_empty() {
let outputs_type_name = Ident::new(&format!("{}Output", struct_name), struct_name.span());
let outputs_repr = quote! {
#[derive(Debug, PartialEq)]
#visibility enum #outputs_type_name {
#(#outputs),*
}
};
let outputs_type = quote! { #outputs_type_name };
let mut output_cases = vec![];
for transition in transitions.iter() {
if let Some(output_value) = &transition.output {
let initial_state = &transition.initial_state;
let input_value = &transition.input_value;
output_cases.push(quote! {
(#states_enum_name::#initial_state, #inputs_enum_name::#input_value) => {
Some(#outputs_type_name::#output_value)
}
});
}
}
let output_impl = quote! {
match (state, input) {
#(#output_cases)*
_ => None,
}
};
(outputs_repr, outputs_type, output_impl)
} else {
(quote! {}, quote! { () }, quote! {None})
};
let output = quote! {
#visibility struct #struct_name;
#[derive(Clone, Copy, Debug, PartialEq)]
#visibility enum #states_enum_name {
#(#states),*
}
#[derive(Debug, PartialEq)]
#visibility enum #inputs_enum_name {
#(#inputs),*
}
#outputs_repr
impl rust_fsm::StateMachineImpl for #struct_name {
type Input = #inputs_enum_name;
type State = #states_enum_name;
type Output = #outputs_type;
const INITIAL_STATE: Self::State = #states_enum_name::#initial_state_name;
fn transition(state: &Self::State, input: &Self::Input) -> Option<Self::State> {
match (state, input) {
#(#transition_cases)*
_ => None,
}
}
fn output(state: &Self::State, input: &Self::Input) -> Option<Self::Output> {
#output_impl
}
}
};
output.into()
}