ogma-macros 0.1.6

Ogma DSL builder libs
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
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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
use ogma_libs::clause;
use proc_macro2::{Span, TokenStream};
use quote::ToTokens;
use syn::parse::{Parse, ParseStream};
use syn::punctuated::Punctuated;
use syn::{
    token, Attribute, Error, FnArg, GenericParam, Generics, Ident, ItemFn, Lifetime, LifetimeDef,
    LitStr, Pat, Path, Type, Visibility,
};

pub enum Bdd {
    Given,
    When,
    Then,
}

pub struct Descriptor {
    attrs: Vec<Attribute>,
    name: Ident,
    clause_span: Span,
    clause_str: String,
}

impl Descriptor {
    fn name(&self) -> Ident {
        self.name.clone()
    }

    fn clause(&self) -> LitStr {
        LitStr::new(&self.clause_str, self.clause_span)
    }

    fn attrs(&self) -> Vec<Attribute> {
        self.attrs.clone()
    }

    fn parse_clause(&self) -> Result<Vec<clause::Token>, Error> {
        clause::parse(&self.clause_str)
            .collect::<Result<Vec<clause::Token>, clause::ParseError>>()
            .map_err(|e| Error::new(self.clause_span, e))
    }

    fn parse_var_names(&self) -> Result<Vec<Ident>, Error> {
        self.parse_clause()?
            .into_iter()
            .filter_map(|t| match t {
                clause::Token::Static(_) => None,
                clause::Token::QueryVar(s) => Some(s),
                clause::Token::DataVar(s) => Some(s),
            })
            .map(|s| syn::parse_str::<Ident>(s))
            .collect()
    }

    fn parse_query_var_names(&self) -> Result<Vec<Ident>, Error> {
        self.parse_clause()?
            .into_iter()
            .filter_map(|t| match t {
                clause::Token::QueryVar(s) => Some(s),
                _ => None,
            })
            .map(|s| syn::parse_str::<Ident>(s))
            .collect()
    }

    fn parse_data_var_names(&self) -> Result<Vec<Ident>, Error> {
        self.parse_clause()?
            .into_iter()
            .filter_map(|t| match t {
                clause::Token::DataVar(s) => Some(s),
                _ => None,
            })
            .map(|s| syn::parse_str::<Ident>(s))
            .collect()
    }
}

impl Parse for Descriptor {
    fn parse(input: ParseStream) -> Result<Self, Error> {
        let attrs = Attribute::parse_outer(input)?;
        let name = input.parse()?;
        let _ = input.parse::<token::Comma>()?;
        let clause = input.parse::<LitStr>()?;
        let clause_span = clause.span();
        let clause_str = clause.value();
        Ok(Descriptor {
            attrs,
            name,
            clause_span,
            clause_str,
        })
    }
}

pub struct Func {
    inner: ItemFn,
}

impl Func {
    fn generics(&self) -> Generics {
        self.inner.sig.generics.clone()
    }

    fn vis(&self) -> Visibility {
        self.inner.vis.clone()
    }

    fn name(&self) -> Ident {
        self.inner.sig.ident.clone()
    }

    fn inner(&self) -> ItemFn {
        self.inner.clone()
    }

    fn vars(&self) -> Punctuated<FnArg, token::Comma> {
        self.inner.sig.inputs.clone().into_iter().skip(1).collect()
    }

    fn lifetime(&self) -> Option<LifetimeDef> {
        self.inner.sig.generics.lifetimes().next().cloned()
    }

    fn parse_var_names(&self) -> Result<Vec<Ident>, Error> {
        Ok(self.parse_vars()?.into_iter().map(|v| v.name).collect())
    }

    fn parse_vars(&self) -> Result<Vec<FuncVar>, Error> {
        self.vars()
            .iter()
            .map(|v| match v {
                FnArg::Receiver(r) => {
                    return Err(Error::new(r.self_token.span, "invalid self"));
                }
                FnArg::Typed(t) => {
                    let name = match t.pat.as_ref() {
                        Pat::Ident(n) => n.ident.clone(),
                        t => return Err(Error::new_spanned(t, "invalid argument type")),
                    };
                    let (is_referenced, ty) = match t.ty.as_ref() {
                        Type::Reference(ty) => {
                            if let Some(m) = ty.mutability {
                                return Err(Error::new(m.span, "arguments cannot be mutable"));
                            }
                            if let Some(l) = ty.lifetime.clone() {
                                if Some(l.clone()) != self.lifetime().map(|l| l.lifetime) {
                                    return Err(Error::new(
                                        l.ident.span(),
                                        "mismatching lifetimes",
                                    ));
                                }
                                (false, Box::new(Type::Reference(ty.clone())))
                            } else {
                                (true, ty.elem.clone())
                            }
                        }
                        ty => (false, Box::new(ty.clone())),
                    };
                    Ok(FuncVar {
                        name,
                        is_referenced,
                        ty,
                    })
                }
            })
            .collect()
    }
}

#[derive(Clone)]
pub struct FuncVar {
    name: Ident,
    is_referenced: bool,
    ty: Box<Type>,
}

impl FuncVar {
    pub fn is_static_type(&self) -> bool {
        let mut expecting_lifetime = false;
        for token in self.ty.to_token_stream() {
            match token {
                proc_macro2::TokenTree::Punct(punct) => {
                    if punct.as_char() == '\'' {
                        expecting_lifetime = true;
                    }
                }
                proc_macro2::TokenTree::Ident(ident) => {
                    if expecting_lifetime && ident.to_string() != "static" {
                        return false;
                    }
                    expecting_lifetime = false;
                }
                _ => (),
            }
        }
        true
    }
}

impl Parse for Func {
    fn parse(input: ParseStream) -> Result<Self, Error> {
        let inner = input.parse()?;
        Ok(Func { inner })
    }
}

pub struct Struct {
    attrs: Vec<Attribute>,
    name: Ident,
    vis: Visibility,
    generics: Generics,
    vars: Vec<FuncVar>,
}

impl Struct {
    pub fn build(desc: &Descriptor, func: &Func) -> Result<Self, Error> {
        Ok(Struct {
            attrs: desc.attrs(),
            name: desc.name(),
            vis: func.vis(),
            generics: func.generics(),
            vars: func.parse_vars()?,
        })
    }
}

impl ToTokens for Struct {
    fn to_tokens(&self, tokens: &mut TokenStream) {
        let attrs = &self.attrs;
        let vis = &self.vis;
        let name = &self.name;
        let generics = &self.generics;
        let vars = self.vars.iter().map(|var| {
            let name = &var.name;
            let ty = &var.ty;
            quote! { #name: #ty, }
        });
        tokens.extend(quote! {
            #(#attrs)*
            #vis struct #name #generics {
                #(#vars)*
            }
        });
    }
}

pub struct StructImpl {
    name: Ident,
    generics: Generics,
    clause: LitStr,
    func: ItemFn,
}

impl StructImpl {
    pub fn build(desc: &Descriptor, func: &Func) -> Self {
        let mut generics = func.generics();
        generics.lifetimes_mut().for_each(|mut l| {
            l.lifetime = Lifetime::new(&format!("'_{}", l.lifetime.ident), Span::call_site());
        });
        Self {
            name: desc.name(),
            generics,
            clause: desc.clause(),
            func: func.inner(),
        }
    }
}

impl ToTokens for StructImpl {
    fn to_tokens(&self, tokens: &mut TokenStream) {
        let name = &self.name;
        let generics = &self.generics;
        let clause = &self.clause;
        let func = &self.func;
        tokens.extend(quote! {
            impl #generics #name #generics {
                ::ogma::clause! {
                    const CLAUSE = #clause
                }
                #func
            }
        });
    }
}

pub struct MatchImpl {
    name: Ident,
    struct_generics: Generics,
    impl_generics: Generics,
    lifetime: Lifetime,
    match_ctx: Path,
    bdd: Option<Bdd>,
    query_vars: Vec<FuncVar>,
    data_vars: Vec<FuncVar>,
}

impl MatchImpl {
    pub fn build(desc: &Descriptor, func: &Func, bdd: Option<Bdd>) -> Result<Self, Error> {
        let struct_generics = func.generics();
        let (mut impl_generics, lifetime) = if struct_generics.lifetimes().count() < 1 {
            let lifetime = Lifetime::new("'a", Span::call_site());
            let param = GenericParam::Lifetime(LifetimeDef::new(lifetime.clone()));
            let mut impl_generics = struct_generics.clone();
            impl_generics.params.insert(0, param);
            (impl_generics, lifetime)
        } else {
            let lifetime = struct_generics.lifetimes().next().unwrap().lifetime.clone();
            (struct_generics.clone(), lifetime)
        };
        let match_ctx = if bdd.is_none() {
            let match_ctx = Ident::new("MCtx", Span::call_site());
            impl_generics
                .params
                .push(GenericParam::Type(match_ctx.clone().into()));
            match_ctx.into()
        } else {
            parse_quote!(::ogma::bdd::Step)
        };
        let func_vars = func.parse_vars()?;
        let query_vars = desc
            .parse_query_var_names()?
            .iter()
            .map(|ident| {
                func_vars
                    .iter()
                    .find(|var| &var.name == ident)
                    .cloned()
                    .ok_or_else(|| Error::new(ident.span(), "could not find ariable in func"))
            })
            .collect::<Result<Vec<_>, Error>>()?;
        let data_vars = desc
            .parse_data_var_names()?
            .iter()
            .map(|ident| {
                func_vars
                    .iter()
                    .find(|var| &var.name == ident)
                    .cloned()
                    .ok_or_else(|| Error::new(ident.span(), "could not find ariable in func"))
            })
            .collect::<Result<Vec<_>, Error>>()?;
        Ok(Self {
            name: desc.name(),
            lifetime,
            struct_generics,
            impl_generics,
            match_ctx,
            bdd,
            query_vars,
            data_vars,
        })
    }
}

impl ToTokens for MatchImpl {
    fn to_tokens(&self, tokens: &mut TokenStream) {
        let name = &self.name;
        let struct_generics = &self.struct_generics;
        let impl_generics = &self.impl_generics;
        let lifetime = &self.lifetime;
        let match_ctx = &self.match_ctx;
        let var_declarations = self
            .query_vars
            .iter()
            .chain(self.data_vars.iter())
            .map(|var| {
                let name = &var.name;
                quote! { let mut #name = None; }
            });
        let var_assignments = self
            .query_vars
            .iter()
            .chain(self.data_vars.iter())
            .map(|var| {
                let name = &var.name;
                quote! { #name: #name.ok_or(::ogma::matcher::MatchError::UnfilledVar)?, }
            });
        let query_var_matches = self.query_vars.iter().map(|var| {
            let name = &var.name;
            let name_str = name.to_string();
            if var.is_static_type() {
                quote! { #name_str => #name = Some(m.next_query_owned()?), }
            } else {
                quote! { #name_str => #name = Some(m.next_query()?), }
            }
        });
        let data_var_matches = self.data_vars.iter().map(|var| {
            let name = &var.name;
            let name_str = name.to_string();
            quote! { #name_str => #name = Some(m.next_data()?), }
        });
        let bdd_check = if let Some(ref bdd) = self.bdd {
            let verb = match bdd {
                Bdd::Given => "Given",
                Bdd::When => "When",
                Bdd::Then => "Then",
            };
            quote! {
                let token = match m.next_static()? {
                    #verb => #verb,
                    "And" => "And",
                    _ => return Err(::ogma::matcher::MatchError::MismatchedStaticToken),
                };
                if let Some(next_state) = ctx.next(token) {
                    *ctx = next_state;
                } else {
                    return Err(::ogma::matcher::MatchError::InvalidCtx);
                }
            }
        } else {
            quote! {}
        };
        tokens.extend(quote! {
            impl #impl_generics ::ogma::matcher::Match<#lifetime, #match_ctx> for #name #struct_generics {
                fn match_str(ctx: &mut #match_ctx, s: &#lifetime str) -> Result<Self, ::ogma::matcher::MatchError> {
                    let mut m = ::ogma::matcher::Matcher::new(s);
                    #bdd_check
                    #(#var_declarations)*
                    for token in &Self::CLAUSE {
                        match *token {
                            ::ogma::clause::Token::Static(token) => {
                                if m.next_static()? != token {
                                    return Err(::ogma::matcher::MatchError::MismatchedStaticToken);
                                }
                            },
                            ::ogma::clause::Token::QueryVar(name) => match name {
                                #(#query_var_matches)*
                                _ => return Err(::ogma::matcher::MatchError::UnknownQueryVar),
                            },
                            ::ogma::clause::Token::DataVar(name) => match name {
                                #(#data_var_matches)*
                                _ => return Err(::ogma::matcher::MatchError::UnknownDataVar),
                            },
                        }
                    }
                    if m.is_empty() {
                        Ok(#name {
                            #(#var_assignments)*
                        })
                    } else {
                        Err(::ogma::matcher::MatchError::ExpectedEof)
                    }
                }
            }
        });
    }
}

pub struct CallableImpl {
    name: Ident,
    generics: Generics,
    fn_name: Ident,
    vars: Vec<FuncVar>,
}

impl CallableImpl {
    pub fn build(desc: &Descriptor, func: &Func) -> Result<Self, Error> {
        Ok(Self {
            name: desc.name(),
            generics: func.generics(),
            fn_name: func.name(),
            vars: func.parse_vars()?,
        })
    }
}

impl ToTokens for CallableImpl {
    fn to_tokens(&self, tokens: &mut TokenStream) {
        let name = &self.name;
        let generics = &self.generics;
        let fn_name = &self.fn_name;
        let fn_args = self.vars.iter().map(|var| {
            let name = &var.name;
            if var.is_referenced {
                quote! { &self.#name, }
            } else {
                quote! { self.#name, }
            }
        });
        tokens.extend(quote! {
            impl #generics ::ogma::vm::Callable for #name #generics {
                fn call(&self, ctx: &mut ::ogma::vm::Context) -> Result<(), ::ogma::vm::Trap> {
                    Self::#fn_name(
                        ctx,
                        #(#fn_args)*
                    )?;
                    Ok(())
                }
            }
        })
    }
}

fn check_var_names(desc: &Descriptor, func: &Func) -> Result<(), Error> {
    let possible_names = desc.parse_var_names()?;
    let func_names = func.parse_var_names()?;
    if possible_names.len() != func_names.len() {
        return Err(Error::new(desc.clause().span(), "variable number mismatch"));
    }
    for var in func.parse_var_names()? {
        if !possible_names.iter().any(|v1| v1 == &var) {
            return Err(Error::new(var.span(), "variable not found in clause"));
        }
    }
    Ok(())
}

fn check_generics(func: &Func) -> Result<(), Error> {
    let generics = func.generics();
    if generics.lifetimes().count() > 1 {
        return Err(Error::new(
            generics.lifetimes().nth(1).unwrap().lifetime.ident.span(),
            "invalid multiple lifetimes",
        ));
    }
    Ok(())
}

fn validate(desc: &Descriptor, func: &Func) -> Result<(), Error> {
    check_var_names(desc, func)?;
    check_generics(func)?;
    Ok(())
}

pub fn ogma_fn(desc: &Descriptor, func: &Func, bdd: Option<Bdd>) -> Result<TokenStream, Error> {
    validate(&desc, &func)?;
    let fn_struct = Struct::build(&desc, &func)?;
    let struct_impl = StructImpl::build(&desc, &func);
    let match_impl = MatchImpl::build(&desc, &func, bdd)?;
    let callable_impl = CallableImpl::build(&desc, &func)?;
    Ok(quote! {
        #fn_struct
        #struct_impl
        #match_impl
        #callable_impl
    })
}