sylt-macro 0.1.0

Proc-macros for developing the sylt programming language.
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
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
use lazy_static::lazy_static;
use quote::{format_ident, quote};
use std::collections::HashMap;
use std::path::Path;
use std::str::FromStr;
use std::sync::{Arc, Mutex};
use syn::{
    parse::{Parse, ParseStream, Result},
    parse_macro_input, Expr, Pat, Token,
};

struct ExternBlock {
    pattern: Pat,
    _arrow: Token![->],
    return_ty: Expr,
    _fat_arrow: Token![=>],
    block: Expr,
    _comma: Token![,],
}

struct ExternFunction {
    module: syn::LitStr,
    function: syn::Ident,
    _as: Option<Token![as]>,
    name: Option<syn::Ident>,
    doc: Option<syn::LitStr>,
    blocks: Vec<ExternBlock>,
}

impl Parse for ExternBlock {
    fn parse(input: ParseStream) -> Result<Self> {
        Ok(Self {
            pattern: input.parse()?,
            _arrow: input.parse()?,
            return_ty: input.parse()?,
            _fat_arrow: input.parse()?,
            block: input.parse()?,
            _comma: input.parse()?,
        })
    }
}

impl Parse for ExternFunction {
    fn parse(input: ParseStream) -> Result<Self> {
        let mut res = Self {
            module: input.parse()?,
            function: input.parse()?,
            _as: None,
            name: None,
            doc: None,
            blocks: Vec::new(),
        };
        if input.peek(Token![as]) {
            res._as = input.parse()?;
            res.name = input.parse()?;
        }
        if input.peek(syn::LitStr) {
            res.doc = input.parse()?;
        }
        while !input.is_empty() {
            res.blocks.push(input.parse()?);
        }
        Ok(res)
    }
}

#[proc_macro]
pub fn extern_function(tokens: proc_macro::TokenStream) -> proc_macro::TokenStream {
    let parsed: ExternFunction = parse_macro_input!(tokens);
    let module = parsed.module;
    let function = parsed.function;
    let doc = if parsed.doc.is_some() {
        let doc = parsed.doc.unwrap();
        quote! { #doc }
    } else {
        eprintln!(
            "Missing doc-string: {} :: {}",
            module.value(),
            function.to_string()
        );
        quote! { "Undocumented" }
    };

    #[rustfmt::skip]
    let matches: Vec<_> = parsed
        .blocks
        .iter()
        .map(|ExternBlock { pattern, return_ty, .. }| quote! { #pattern #return_ty })
        .collect();

    let link_name = parsed.name.unwrap_or_else(|| function.clone());

    let typecheck_blocks: Vec<_> = parsed
        .blocks
        .iter()
        .map(|block| {
            let pat = block.pattern.clone();
            let ty = block.return_ty.clone();
            quote! {
                #pat => { Ok(sylt_common::Value::from(#ty)) }
            }
        })
        .collect();

    let eval_blocks: Vec<_> = parsed
        .blocks
        .iter()
        .map(|block| {
            let pat = block.pattern.clone();
            let expr = block.block.clone();
            quote! {
                #pat => #expr
            }
        })
        .collect();

    let tokens = quote! {
        #[sylt_macro::sylt_doc(#function, #doc , #( #matches ),*)]
        #[sylt_macro::sylt_link(#link_name, #module)]
        pub fn #function (
            ctx: sylt_common::RuntimeContext
        ) -> ::std::result::Result<sylt_common::Value, sylt_common::error::RuntimeError>
        {
            use sylt_common::MatchableValue::*;
            use sylt_common::RustFunction;
            use sylt_common::Value::*;
            use sylt_common::value::make_matchable;
            let values = ctx.machine.stack_from_base(ctx.stack_base);
            if ctx.typecheck {
                let matching: Vec<_> = values.iter().map(make_matchable).collect();
                #[allow(unused_variables)]
                match matching.as_slice() {
                    #(#typecheck_blocks),*
                    _ => Err(sylt_common::error::RuntimeError::ExternTypeMismatch(
                        stringify!(#function).to_string(),
                        values.iter().map(|v| sylt_common::Type::from(v)).collect()
                    ))
                }
            } else {
                let matching: Vec<_> = values.iter().map(make_matchable).collect();
                match matching.as_slice() {
                    #(#eval_blocks),*
                    _ => Err(sylt_common::error::RuntimeError::ExternTypeMismatch(
                        stringify!(#function).to_string(),
                        values.iter().map(|v| sylt_common::Type::from(v)).collect()
                    ))
                }
            }
        }
    };
    proc_macro::TokenStream::from(tokens)
}

struct LinkRename {
    _as: Token![as],
    name: syn::Ident,
}

impl Parse for LinkRename {
    fn parse(input: ParseStream) -> Result<Self> {
        Ok(Self {
            _as: input.parse()?,
            name: input.parse()?,
        })
    }
}

struct Link {
    path: syn::Path,
    rename: Option<LinkRename>,
}

impl Parse for Link {
    fn parse(input: ParseStream) -> Result<Self> {
        Ok(Self {
            path: input.parse()?,
            rename: input.parse().ok(),
        })
    }
}

struct Links {
    links: Vec<Link>,
}

impl Parse for Links {
    fn parse(input: ParseStream) -> Result<Self> {
        let mut res = Self { links: Vec::new() };
        while !input.is_empty() {
            res.links.push(input.parse()?);
            let _comma: Option<Token![,]> = input.parse().ok();
        }
        Ok(res)
    }
}

#[proc_macro]
pub fn link(tokens: proc_macro::TokenStream) -> proc_macro::TokenStream {
    let links: Links = parse_macro_input!(tokens);
    let links: Vec<_> = links
        .links
        .iter()
        .map(|link| {
            let name = if let Some(rename) = &link.rename {
                &rename.name
            } else {
                &link.path.segments.last().unwrap().ident
            };
            let path = &link.path;
            quote! {
                (stringify!(#name).to_string(), #path)
            }
        })
        .collect();

    let tokens = quote! {
        vec![ #(#links),* ]
    };
    proc_macro::TokenStream::from(tokens)
}

struct TestSettings {
    errors: String,
    print: bool,
}

impl Default for TestSettings {
    fn default() -> Self {
        Self {
            errors: String::new(),
            print: true,
        }
    }
}

fn parse_test_settings(contents: String) -> TestSettings {
    let mut settings = TestSettings::default();

    let mut errors = Vec::new();
    for line in contents.split("\n") {
        if line.starts_with("// error: ") {
            let mut line = line.strip_prefix("// error: ").unwrap().to_string();
            if line.starts_with("#") {
                line = format!(
                    "Error::RuntimeError {{ kind: RuntimeError::{}, .. }}",
                    &line[1..]
                );
            }
            if line.starts_with("@") {
                line = format!("Error::SyntaxError {{ span: Span {{ line: {}, ..}}, .. }}", &line[1..]);
            }
            errors.push(line);
        } else if line.starts_with("// flags: ") {
            for flag in line.split(" ").skip(2) {
                match flag {
                    "no_print" => {
                        settings.print = false;
                    }
                    _ => {
                        panic!("Unknown test flag '{}'", flag);
                    }
                }
            }
        }
    }

    settings.errors = format!("[ {} ]", errors.join(", "));
    settings
}

fn find_test_paths(directory: &Path) -> proc_macro2::TokenStream {
    let mut tests = quote! {};

    for entry in std::fs::read_dir(directory).unwrap() {
        let path = entry.unwrap().path();
        let file_name = path.file_name().unwrap().to_str().unwrap();

        if file_name.starts_with("_") {
            continue;
        }

        if path.is_dir() {
            tests.extend(find_test_paths(&path));
        } else {
            assert!(
                !path.to_str().unwrap().contains(","),
                "You should be ashamed."
            );

            let path_string = path.to_str().unwrap();
            let test_name = format_ident!("{}", file_name.replace(".sy", ""));

            let settings = parse_test_settings(std::fs::read_to_string(path.clone()).unwrap());
            let print = settings.print;
            let wanted_errs: proc_macro2::TokenStream = settings.errors.parse().unwrap();

            // TODO(ed): Make a flag for skipping the test
            let tokens = quote! {
                test_file!(#test_name, #path_string, #print, #wanted_errs);
            };

            tests.extend(tokens);
        }
    }

    let directory = directory
        .file_name()
        .unwrap()
        .to_str()
        .unwrap()
        .replace("/", "");
    let directory = format_ident!("{}", directory);
    quote! {
        mod #directory {
            #tests
        }
    }
}

#[proc_macro]
pub fn find_tests(tokens: proc_macro::TokenStream) -> proc_macro::TokenStream {
    assert!(tokens.is_empty());

    let tokens = find_test_paths(Path::new("progs/"));
    proc_macro::TokenStream::from(tokens)
}

#[proc_macro_derive(Enumerate)]
pub fn derive_enumerate(item: proc_macro::TokenStream) -> proc_macro::TokenStream {
    assert!(!item.is_empty());
    let parsed: syn::ItemEnum = parse_macro_input!(item);

    let ident = parsed.ident;
    let match_from_usize: Vec<_> = parsed
        .variants
        .iter()
        .enumerate()
        .map(|(i, v)| {
            quote! {
                #i => Ok(#ident::#v),
            }
        })
        .collect();
    let match_from_ident: Vec<_> = parsed
        .variants
        .iter()
        .enumerate()
        .map(|(i, v)| {
            quote! {
                #ident::#v => #i,
            }
        })
        .collect();

    let max = parsed.variants.len();

    let item = quote! {
        impl ::std::convert::TryFrom<usize> for #ident {
            type Error = std::string::String;

            fn try_from(u: usize) -> ::std::result::Result<Self, Self::Error> {
                match u {
                    #(#match_from_usize)*
                    u => Err(format!("{} only has {} variants, tried {}", stringify!(#ident), #max, u)),
                }
            }
        }

        impl ::std::convert::From<#ident> for usize {
            fn from(s: #ident) -> Self {
                match s {
                    #(#match_from_ident)*
                }
            }
        }
    };
    proc_macro::TokenStream::from(item)
}

#[proc_macro_derive(Next)]
pub fn derive_next(item: proc_macro::TokenStream) -> proc_macro::TokenStream {
    assert!(!item.is_empty());
    let parsed: syn::ItemEnum = parse_macro_input!(item);

    let ident = parsed.ident.clone();

    let mut iter = parsed.variants.iter();
    let mut prev = iter.next().expect("Empty enum can't be Next");
    let mut match_arms: Vec<_> = iter
        .map(|v| {
            let tokens = quote! {
                #ident::#prev => #ident::#v,
            };
            prev = v;
            tokens
        })
        .collect();
    match_arms.push(quote! {
        #ident::#prev => #ident::#prev,
    });

    let item = quote! {
        impl Next for #ident {
            fn next(&self) -> Self {
                match self {
                    #(#match_arms)*
                }
            }
        }
    };
    proc_macro::TokenStream::from(item)
}

#[proc_macro_derive(Numbered)]
pub fn derive_numbered(item: proc_macro::TokenStream) -> proc_macro::TokenStream {
    assert!(!item.is_empty());
    let parsed: syn::ItemEnum = parse_macro_input!(item);

    let ident = parsed.ident.clone();

    let match_arms: Vec<_> = parsed.variants.iter().enumerate().map(|(i, v)| {
        let name = v.ident.clone();
        match v.fields {
            syn::Fields::Named(_) => {
                quote! {
                    #ident::#name { .. } => #i,
                }
            }
            syn::Fields::Unnamed(_) => {
                quote! {
                    #ident::#name ( .. ) => #i,
                }
            }
            syn::Fields::Unit => {
                quote! {
                    #ident::#name => #i,
                }
            }
        }
    }).collect();

    let item = quote! {
        impl Numbered for #ident {
            fn to_number(&self) -> usize {
                match self {
                    #(#match_arms)*
                }
            }
        }
    };
    proc_macro::TokenStream::from(item)
}

enum LinkState {
    Open,
    Written,
}

struct ModuleLink {
    state: LinkState,
    mapping: Vec<(String, String)>,
}

impl ModuleLink {
    fn new() -> Self {
        Self {
            state: LinkState::Open,
            mapping: Vec::new(),
        }
    }
}

lazy_static! {
    static ref LINKS: Arc<Mutex<HashMap<String, ModuleLink>>> =
        Arc::new(Mutex::new(HashMap::new()));
}

#[proc_macro]
pub fn sylt_link_gen(tokens: proc_macro::TokenStream) -> proc_macro::TokenStream {
    let module: syn::LitStr = parse_macro_input!(tokens);
    let module = module.value();

    let mut link = LINKS.lock().unwrap();
    let mut link = if let Some(link) = link.get_mut(&module) {
        link
    } else {
        let tokens = quote! {
            std::compile_error!("No functions to link. This call produces nothing.");
        };
        return proc_macro::TokenStream::from(tokens);
    };
    if matches!(link.state, LinkState::Written) {
        let tokens = quote! {
            std::compile_error!("Tried to write linked sylt functions twice.");
        };
        return proc_macro::TokenStream::from(tokens);
    }
    link.state = LinkState::Written;
    let funs: Vec<_> = link
        .mapping
        .iter()
        .map(|(ident, name)| {
            let ident = proc_macro2::TokenStream::from_str(&ident).unwrap();
            quote! {
                (#name.to_string(), #ident),
            }
        })
        .collect();

    let tokens = quote! {
        pub fn _sylt_link() -> Vec<(std::string::String, ::sylt_common::RustFunction)> {
            vec! [ #(#funs)* ]
        }
    };
    proc_macro::TokenStream::from(tokens)
}

struct SyltDoc {
    name: syn::Ident,
    comment: syn::LitStr,
    args: Vec<(syn::Pat, syn::Expr)>,
}

impl Parse for SyltDoc {
    fn parse(input: ParseStream) -> Result<Self> {
        let name: syn::Ident = input.parse()?;
        let _comma: Token![,] = input.parse()?;
        let comment = input.parse()?;

        let mut args = Vec::new();
        while !input.is_empty() {
            let _comma: Token![,] = input.parse()?;
            let arg = (input.parse()?, input.parse()?);
            args.push(arg);
        }

        Ok(SyltDoc {
            name,
            comment,
            args,
        })
    }
}

struct DocFile {
    docs: Vec<String>,
}

lazy_static! {
    static ref DOC: Arc<Mutex<DocFile>> = doc_file();
}

fn doc_file() -> Arc<Mutex<DocFile>> {
    Arc::new(Mutex::new(DocFile { docs: Vec::new() }))
}

impl DocFile {
    fn dump(&mut self) {
        use std::fs::File;
        use std::io::prelude::*;
        match File::create(&Path::new("docs/docs.json")) {
            Err(_msg) => (), //TODO(gu) report errors
            Ok(mut file) => {
                write!(file, "[\n{}\n]", self.docs.join(",\n")).unwrap();
            }
        }
    }
}

#[proc_macro_attribute]
pub fn sylt_doc(
    attrib: proc_macro::TokenStream,
    tokens: proc_macro::TokenStream,
) -> proc_macro::TokenStream {
    let doc: SyltDoc = parse_macro_input!(attrib);

    let doc = format!(
        "{{ \"name\": \"{}\", \"comment\": \"{}\", \"signature\": [{}]}}",
        doc.name.to_string(),
        doc.comment.value().replace("\n", "\\n"),
        doc.args
            .iter()
            .map(|(p, r)| format!("\"{}\"", quote! { #p -> #r }.to_string()))
            .collect::<Vec<_>>()
            .join(",")
            .replace("\n", ""),
    );
    let mut doc_file = DOC.lock().unwrap();
    doc_file.docs.push(doc);
    doc_file.dump();
    drop(doc_file);

    tokens
}

struct SyltLink {
    name: syn::Ident,
    _comma: Token![,],
    module: syn::LitStr,
}

impl Parse for SyltLink {
    fn parse(input: ParseStream) -> Result<Self> {
        Ok(Self {
            name: input.parse()?,
            _comma: input.parse()?,
            module: input.parse()?,
        })
    }
}

#[proc_macro_attribute]
pub fn sylt_link(
    attrib: proc_macro::TokenStream,
    tokens: proc_macro::TokenStream,
) -> proc_macro::TokenStream {
    let parsed: syn::ItemFn = parse_macro_input!(tokens);
    let fun = parsed.sig.ident.clone();
    let link: SyltLink = parse_macro_input!(attrib);

    let mut links = LINKS.lock().unwrap();
    let links = links
        .entry(link.module.value())
        .or_insert(ModuleLink::new());
    if matches!(links.state, LinkState::Written) {
        let tokens = quote! {
            std::compile_error!("Tried to write linked sylt functions twice.");
        };
        return proc_macro::TokenStream::from(tokens);
    }

    links.mapping.push((
        format!("{}::{}", link.module.value(), fun),
        link.name.to_string().clone(),
    ));

    let tokens = quote! {
        #parsed
    };
    proc_macro::TokenStream::from(tokens)
}

#[proc_macro]
pub fn sylt_binop_gen(tokens: proc_macro::TokenStream) -> proc_macro::TokenStream {
    let op: syn::Ident = parse_macro_input!(tokens);

    let tokens = quote! {
        syntree:ExpressionKind:: #op (a, b) => {
            self.expression(&a);
            self.expression(&b);
            self.add_op(statement.span, Op:: #op );
        }
    };
    proc_macro::TokenStream::from(tokens)
}