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
extern crate proc_macro;
extern crate syn;
#[macro_use]
extern crate quote;

use proc_macro::TokenStream;
use quote::{ Tokens, ToTokens };
use std::collections::BTreeMap;

const TRANSITIONS_ATTRIBUTE: &'static str = "state_transitions";
const NEW_STATE_OBJ_NAME: &'static str = "new_state";

#[derive(Copy, Clone)]
enum EnumFieldData {
    Unit,
    Struct,
    Tuple,
}

enum Fragment {
    /// Tokens that can be used as an expression.
    Expr(Tokens),
}

macro_rules! quote_expr {
    ($($tt:tt)*) => {
        Fragment::Expr(quote!($($tt)*))
    }
}

macro_rules! quote_block {
    ($($tt:tt)*) => {
        Fragment::Block(quote!($($tt)*))
    }
}

/// Interpolate a fragment as the statements of a block.
struct Stmts(pub Fragment);
impl ToTokens for Stmts {
    fn to_tokens(&self, out: &mut Tokens) {
        match self.0 {
            Fragment::Expr(ref expr) => expr.to_tokens(out),
        }
    }
}

fn ident_with_data(enum_ident: &syn::Ident,
                   item_ident: &syn::Ident,
                   data: EnumFieldData) -> syn::Ident {
    match data {
        EnumFieldData::Unit => syn::Ident::new(format!("{}::{}", enum_ident, item_ident)),
        EnumFieldData::Tuple => syn::Ident::new(format!("{}::{}(_)", enum_ident, item_ident)),
        EnumFieldData::Struct => syn::Ident::new(format!("{}::{}{{..}}", enum_ident, item_ident)),
    }
}

fn serialize_variant(ident: &syn::Ident,
                     new_state_ident: &syn::Ident,
                     variant: &syn::Variant,
                     var_data_map: &BTreeMap<String, EnumFieldData>) -> Tokens {
    let variant_ident = ident_with_data(ident,
                                        &variant.ident,
                                        *var_data_map.get(&variant.ident.to_string())
                                                     .unwrap_or(&EnumFieldData::Unit));
    let transitions: Vec<_> = variant.attrs.iter()
        .filter(|a| a.value.name() == TRANSITIONS_ATTRIBUTE)
        .map(|a| {
            if let syn::MetaItem::List(_, ref nested) = a.value {
                let transitions: Vec<_> = nested.iter()
                    .map(|n| {
                        if let syn::NestedMetaItem::MetaItem(ref mt) = *n {
                            if let syn::MetaItem::Word(ref id) = *mt {
                                let data = *var_data_map.get(&id.to_string())
                                                            .unwrap_or(&EnumFieldData::Unit);
                                let match_id = ident_with_data(ident,
                                                               id,
                                                               data);
                                    Stmts(quote_expr! {
                                        #match_id
                                    })
                            } else {
                                panic!("The syntax for fsm states attribute must be a list-syntax (the same as for #[derive(...)]");
                            }
                        } else {
                            panic!("The syntax for fsm states attribute must be a list-syntax (the same as for #[derive(...)]");
                        }
                    })
                    .collect();
                    if !transitions.is_empty() {
                        return quote! {
                            #variant_ident => match #new_state_ident {
                                #(
                                    #transitions => true,
                                )*
                                _ => false,
                            },
                        }
                    } else {
                        return quote! {
                            _ => false,
                        }
                    }
            } else {
                panic!("The syntax for fsm states attribute must be a list-syntax (the same as for #[derive(...)]");
            }
        })
        .collect();

    quote! {
        #(#transitions)*
    }
}

fn serialize_enum(ident: &syn::Ident, variants: &[syn::Variant]) -> Fragment {
    let var_data_map: BTreeMap<String, EnumFieldData> = variants.iter()
        .map(|var| {
            let field_data = match var.data {
                syn::VariantData::Unit => EnumFieldData::Unit,
                syn::VariantData::Struct(_) => EnumFieldData::Struct,
                syn::VariantData::Tuple(_) => EnumFieldData::Tuple,
            };
            (var.ident.to_string(), field_data)
        })
        .collect();

    let arms: Vec<_> = variants.iter()
        .filter(|variant| variant.attrs.iter()
                          .find(|a| a.value.name() == TRANSITIONS_ATTRIBUTE).is_some())
        .map(|variant| serialize_variant(ident,
                                         &syn::Ident::new(NEW_STATE_OBJ_NAME),
                                         variant,
                                         &var_data_map))
        .collect();

    let others = if arms.len() < variants.len() {
        quote! { _ => false, }
    } else {
        quote! { }
    };
    quote_expr! {
        match *self {
            #(#arms)*
            #others
        }
    }
}

fn get_finish_states(name: &syn::Ident, variants: &[syn::Variant]) -> (Fragment, usize) {
    let var_data_map: BTreeMap<String, EnumFieldData> = variants.iter()
        .map(|var| {
            let field_data = match var.data {
                syn::VariantData::Unit => EnumFieldData::Unit,
                syn::VariantData::Struct(_) => EnumFieldData::Struct,
                syn::VariantData::Tuple(_) => EnumFieldData::Tuple,
            };
            (var.ident.to_string(), field_data)
        })
        .collect();

    let arms: Vec<syn::Ident> = variants.iter()
        .filter(|variant| !variant.attrs.iter()
                          .find(|a| a.value.name() == TRANSITIONS_ATTRIBUTE).is_some())
        .map(|variant| {
            ident_with_data(name,
                            &variant.ident,
                            *var_data_map.get(&variant.ident.to_string())
                                 .unwrap_or(&EnumFieldData::Unit))
        })
        .collect();

    let new_state_obj_name = syn::Ident::new(NEW_STATE_OBJ_NAME);
    let others = if arms.len() < variants.len() {
        quote! { _ => false, }
    } else {
        quote! { }
    };
    let len = arms.len();
    (quote_expr! {
        match #new_state_obj_name {
            #(#arms => true,)*
            #others
        }
    }, len)
}

fn gen_for_clonable(name: &syn::Ident,
                    variants: &[syn::Variant],
                    generics: &syn::Generics) -> Tokens {
    let (impl_generics, ty_generics, where_clause) = generics.split_for_impl();
    let transitions = Stmts(serialize_enum(name, variants));
    let finish_states = get_finish_states(name, variants);
    let finish_states_match = Stmts(finish_states.0);
    let finish_states_len = finish_states.1;
    let new_state_obj_name = syn::Ident::new(NEW_STATE_OBJ_NAME);
    quote! {
        impl #impl_generics fxsm::StateMachine<#name #ty_generics> for #name #ty_generics #where_clause {
            fn change(&mut self,
                      #new_state_obj_name: #name #ty_generics) -> bool {
                if self.can_change(#new_state_obj_name.clone()) {
                    *self = #new_state_obj_name;
                    return true
                }
                false
            }
            fn can_change(&self,
                          #new_state_obj_name: #name #ty_generics) -> bool {
                #transitions
            }
            fn is_finish_state(#new_state_obj_name: #name #ty_generics) -> bool {
                #finish_states_match
            }
            fn at_finish_state(&self) -> bool {
                Self::is_finish_state(self.clone())
            }
            fn finish_states() -> usize {
                #finish_states_len
            }
        }
    }
}

#[proc_macro_derive(StateMachine, attributes(state_transitions))]
pub fn fxsm(input: TokenStream) -> TokenStream {
    // Construct a string representation of the type definition
    let s = input.to_string();

    // Parse the string representation
    let ast = syn::parse_derive_input(&s).unwrap();

    // Build the impl
    let gen = impl_fsm(&ast);

    // Return the generated impl
    gen.parse().unwrap()
}

fn impl_fsm(ast: &syn::DeriveInput) -> Tokens {
    if let syn::Body::Enum(ref variants) = ast.body {
        return gen_for_clonable(&ast.ident, &variants, &ast.generics);
    } else {
        panic!("State Machine must be derived on a enum.");
    }
}