typescript-definitions-derive 0.1.10

serde support for exporting Typescript definitions
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
#![allow(unused)]

use super::patch::{eq, nl};
use failure::{Error, Fail};
use pest::iterators::Pair;
use pest::Parser;
use pest_derive::Parser;
use proc_macro2::Literal;
use proc_macro2::TokenStream;
use quote::quote;

use proc_macro2::{Ident, Span};

pub fn ident_from_str(s: &str) -> Ident {
    syn::Ident::new(s, Span::call_site())
}

#[derive(Fail, Debug)]
#[fail(display = "{}", _0)]
pub struct TypescriptParseError(pest::error::Error<Rule>);

impl TypescriptParseError {
    /// Return the column of where the error ocurred.
    #[allow(unused)]
    pub fn column(&self) -> usize {
        match self.0.line_col {
            pest::error::LineColLocation::Pos((_, col)) => col,
            pest::error::LineColLocation::Span((_, col), _) => col,
        }
    }
    #[allow(unused)]
    pub fn row(&self) -> usize {
        match self.0.line_col {
            pest::error::LineColLocation::Pos((row, _)) => row,
            pest::error::LineColLocation::Span((row, _), _) => row,
        }
    }
}

#[derive(Parser)]
#[grammar = "typescript.pest"]
struct TypescriptParser;

pub struct Typescript {
    only_first: bool,
    var: i32,
}

struct Ret {
    result: TokenStream,
    need_undef: bool,
}

impl Typescript {
    pub fn new() -> Self {
        Self::with_first(false)
    }
    pub fn with_first(only_first: bool) -> Self {
        Typescript { only_first, var: 0 }
    }
    pub fn verify(typescript: &str) -> Result<pest::iterators::Pairs<'_, Rule>, Error> {
        Ok(TypescriptParser::parse(Rule::typescript, typescript).map_err(TypescriptParseError)?)
    }

    pub fn parse(&mut self, obj: &TokenStream, typescript: &str) -> Result<TokenStream, Error> {
        let pair = TypescriptParser::parse(Rule::typescript, typescript)
            .map_err(TypescriptParseError)?
            .next() // skip SOI
            .unwrap();
        let mut content = vec![];
        let mut need_undef = true;
        for item in pair.into_inner() {
            match item.as_rule() {
                Rule::EOI => break,
                other => assert_eq!(other, Rule::expr),
            }
            content.push({
                let r = self.parse_expr(obj, item)?;
                need_undef = r.need_undef;
                r.result
            });
        }
        assert!(content.len() == 1);
        let newl = nl();

        // obj can't be null or undefined
        assert!(self.level() == 0);
        let guard = if need_undef {
            let eq = eq();
            quote!(if (#obj #eq undefined) return false;)
        } else {
            quote!()
        };

        Ok(quote!(
            {
                #guard
                #(#content)*
                #newl return true;
            }
        ))
    }
    fn parse_expr<'a>(&mut self, obj: &TokenStream, expr: Pair<'a, Rule>) -> Result<Ret, Error> {
        // expr = { union | "(" ~ expr ~ ")" }

        let mut content = vec![];
        let mut is_union = false;
        let mut size = 0;
        for u in expr.into_inner() {
            content.push(match u.as_rule() {
                Rule::union => {
                    is_union = true;
                    let (q, n) = self.parse_union(&obj, u)?;
                    size = n;
                    q
                }
                Rule::expr => self.parse_expr(&obj, u)?,

                _ => unreachable!(),
            })
        }
        assert!(content.len() == 1);

        let c = &content[0].result;
        let n = content[0].need_undef;

        let test = if is_union && size > 1 {
            quote!(if ( !( () => { #c } )() ) return false;)
        } else {
            quote!( #c )
        };
        Ok(Ret {
            result: test,
            need_undef: n,
        })
    }
    fn parse_item<'a>(&mut self, obj: &TokenStream, item: Pair<'a, Rule>) -> Result<Ret, Error> {
        let mut i = item.into_inner();
        // item = { singleton ~ array  }
        let (singleton, array) = (i.next().unwrap(), i.next().unwrap());

        let mut content = vec![];
        let n = array.as_str().len();
        let narr = n / 2;
        assert!(narr * 2 == n);
        let mut size = 0;
        let mut is_union = false;
        let val = &obj; // self.pushvar();
                        // singleton = { str | map | tuple | typ | "(" ~ union ~ ")" }
        for o in singleton.into_inner() {
            content.push(match o.as_rule() {
                Rule::map => self.parse_map(val, o)?,
                Rule::object => self.parse_struct(val, o)?,
                Rule::tuple => self.parse_tuple(val, o)?,
                Rule::base_type => self.parse_typ(val, o)?,
                Rule::union => {
                    is_union = true;
                    let (q, n) = self.parse_union(val, o)?;
                    size = n;
                    q
                }
                _ => unreachable!(),
            });
        }
        assert!(content.len() == 1);
        let c = &content[0].result;
        let n = content[0].need_undef;
        let test = if is_union && size > 1 {
            quote!(if ( !( () => { #c } )() ) return false;)
        } else {
            quote!( #c )
        };
        if narr == 0 {
            // self.popvar();
            Ok(Ret {
                result: test,
                need_undef: n,
            })
        } else {
            let brk = if self.only_first {
                quote!(break;)
            } else {
                quote!()
            };

            let mut vinner = self.pushvar();
            let mut inner = quote!(
                {
                    if (!Array.isArray(#vinner)) return false;
                    for (let #val of #vinner) {
                        #test
                        #brk
                    }
                }
            );
            for i in 0..narr - 1 {
                let vnext = self.pushvar();
                inner = quote!(
                if (!Array.isArray(#vnext)) return false;
                for (let #vinner of #vnext) {
                    #inner
                    #brk
                });
                vinner = vnext;
            }
            for i in 0..narr {
                self.popvar()
            }
            Ok(Ret {
                result: quote!(const #vinner = #obj; #inner;),
                need_undef: false,
            })
        }
    }
    fn parse_typ<'a>(&mut self, obj: &TokenStream, typ: Pair<'a, Rule>) -> Result<Ret, Error> {
        // typ = { "number" | "object" | "string" | "boolean" | "null" }
        let typ = typ.as_str();
        let eq = eq();
        Ok(Ret {
            result: quote!(
               if (!(typeof #obj #eq #typ)) return false;
            ),
            need_undef: false,
        })
    }
    fn parse_map<'a>(&mut self, obj: &TokenStream, map: Pair<'a, Rule>) -> Result<Ret, Error> {
        // map = {  "{" ~ "[" ~ "key" ~ ":" ~ key ~ "]" ~ ":" ~ expr ~ "}" }
        let mut i = map.into_inner();
        let (typ, expr) = (i.next().unwrap(), i.next().unwrap());
        let k = typ.as_str();

        // let typ = self.parse_typ(typ)?;
        let val = self.pushvar();
        let result = self.parse_expr(&val, expr)?;
        let eq = eq();
        let kval = self.pushvar();
        let k = if k == "number" {
            quote! {
                if (+#kval #eq NaN) return false;
            }
        } else {
            // always going to be a string
            quote!()
        };
        let brk = if self.only_first {
            quote!(break;)
        } else {
            quote!()
        };
        self.popvar();
        self.popvar();
        // obj is definitely not undefined... but it might be null...
        let v = result.result;
        Ok(Ret {
            result: quote!(
                if (!(typeof #obj #eq "object")) return false;
                for (let #kval in #obj) {
                    let #val = #obj[#kval];
                    // #val is not undefined....
                    #k;
                    #v;
                    #brk
                }
            ),
            need_undef: false,
        })
    }
    fn parse_union<'a>(
        &mut self,
        obj: &TokenStream,
        union: Pair<'a, Rule>,
    ) -> Result<(Ret, usize), Error> {
        // union = {   item ~ ("|" ~ item)*  }
        let mut results = vec![];
        // let val = self.pushvar();
        for item in union.into_inner() {
            match item.as_rule() {
                Rule::item => results.push(self.parse_item(obj, item)?),
                _ => unreachable!(),
            }
        }
        let newl = nl();
        let nl = (0..results.len()).map(|_| quote!(#newl));
        // self.popvar();
        // obj can't be null or undefined
        let n = results.len();
        // a *single* union doesn't need to check multiple failures
        // looking for a success....
        let content = results.iter().map(|r| &r.result);
        let need = results.iter().any(|r| r.need_undef);
        let ret = if n == 1 {
            quote!(
                #(#content)*
            )
        } else {
            quote!(
                {
                #( #nl if ( ( () => { #content; return true; } )() ) return true; )*
                #newl return false;
                }
            )
        };

        Ok((
            Ret {
                result: ret,
                need_undef: need,
            },
            n,
        ))
    }
    fn parse_tuple<'a>(&mut self, obj: &TokenStream, tuple: Pair<'a, Rule>) -> Result<Ret, Error> {
        // tuple = { "[" ~ expr ~ ("," ~ expr )+ ~ "]" }
        let mut content = vec![];
        let eq = eq();
        let val = self.pushvar();
        for (i, expr) in tuple.into_inner().enumerate() {
            let i = Literal::usize_unsuffixed(i);
            let n = quote!(#obj[#i]);

            match expr.as_rule() {
                Rule::expr => {
                    let v = self.parse_expr(&val, expr)?;
                    let verify = v.result;
                    let guard = if v.need_undef {
                        quote!(if (#n #eq undefined) return false;)
                    } else {
                        quote!()
                    };
                    content.push(quote! {
                        #guard
                        {
                            const #val = #n;
                            #verify;
                        }
                    });
                }
                _ => unreachable!(),
            }
        }
        self.popvar();
        let len = Literal::usize_unsuffixed(content.len());
        // isArray protects us from null obj
        Ok(Ret {
            result: quote!(
                if (!Array.isArray(#obj) || !(#obj.length #eq #len)) return false;
                #(#content)*
            ),
            need_undef: false,
        })
    }
    fn parse_struct<'a>(&mut self, obj: &TokenStream, pair: Pair<'a, Rule>) -> Result<Ret, Error> {
        // str = {  "{" ~ (ident ~ ":" ~ expr)? ~ ("," ~ ident ~ ":" ~ expr )* ~ "}" }
        let mut keys = vec![];
        let mut values = vec![];
        let val = self.pushvar();
        for expr in pair.into_inner() {
            match expr.as_rule() {
                Rule::ident => keys.push(ident_from_str(&expr.as_str())),
                Rule::expr => values.push(self.parse_expr(&val, expr)?),
                _ => unreachable!(),
            }
        }
        let mut ret = vec![];
        let eq = eq();
        for (n, v) in keys.iter().zip(values) {
            let verify = v.result;
            let guard = if v.need_undef {
                quote!(if (#obj.#n #eq undefined) return false;)
            } else {
                quote!()
            };
            ret.push(quote! {
                #guard
                {
                    const #val = #obj.#n;
                    #verify
                }
            });
        }
        self.popvar();
        // need to protect object access from the null object so ==

        Ok(Ret {
            result: quote!(if( !(typeof #obj #eq "object")) return false; #(#ret)*),
            need_undef: false,
        })
    }

    fn pushvar(&mut self) -> TokenStream {
        self.var += 1;

        let n = ident_from_str(&format!("val{}", self.var));
        quote!(#n)
    }
    fn popvar(&mut self) {
        self.var -= 1;
        assert!(self.var >= 0);
    }
    fn level(&self) -> i32 {
        self.var
    }
}

#[cfg(test)]
mod parser {
    use super::Typescript;
    use crate::patch::patch;
    use quote::quote;
    //#[test]
    fn typescript_parser() {
        let mut t = Typescript::new();
        match t.parse(&quote!(obj), &"[number, string]|{ [key: number]: string}[][] | {a: number} | (number|{a:{b:number}})") {
            Ok(q) => {eprintln!("{}", patch(&q.to_string()))},
            Err(msg) => assert!(false, msg)
        }
    }
    #[test]
    fn typescript_parser2() {
        let mut t = Typescript::new();
        match t.parse(&quote!(obj), &"[number, string][]") {
            Ok(q) => eprintln!("{}", patch(&q.to_string())),
            Err(msg) => assert!(false, msg),
        }
    }

}