rune-macros 0.14.2

Macros for the Rune Language, an embeddable dynamic programming language for Rust.
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

use proc_macro2::TokenStream;
use quote::{quote, ToTokens};
use syn::parse::ParseStream;
use syn::punctuated::Punctuated;

pub(crate) struct ModuleAttrs {
    path: syn::Path,
}

impl ModuleAttrs {
    /// Parse the given parse stream.
    pub(crate) fn parse(input: ParseStream) -> syn::Result<Self> {
        let path = input.parse::<syn::Path>()?;
        let stream = input.parse::<TokenStream>()?;

        if !stream.is_empty() {
            return Err(syn::Error::new_spanned(stream, "Unexpected input"));
        }

        Ok(Self { path })
    }
}

pub(crate) struct Module {
    attributes: Vec<syn::Attribute>,
    docs: syn::ExprArray,
    vis: syn::Visibility,
    signature: syn::Signature,
    remainder: TokenStream,
}

impl Module {
    /// Parse the given parse stream.
    pub(crate) fn parse(input: ParseStream) -> syn::Result<Self> {
        let parsed_attributes = input.call(syn::Attribute::parse_outer)?;

        let mut docs = syn::ExprArray {
            attrs: Vec::new(),
            bracket_token: syn::token::Bracket::default(),
            elems: Punctuated::default(),
        };

        let mut attributes = Vec::new();

        for attr in parsed_attributes {
            if attr.path().is_ident("doc") {
                if let syn::Meta::NameValue(name_value) = &attr.meta {
                    docs.elems.push(name_value.value.clone());
                }
            }

            attributes.push(attr);
        }

        Ok(Self {
            attributes,
            docs,
            vis: input.parse()?,
            signature: input.parse()?,
            remainder: input.parse()?,
        })
    }

    /// Expand the function declaration.
    pub(crate) fn expand(self, attrs: ModuleAttrs) -> syn::Result<TokenStream> {
        let docs = self.docs;

        let item = match attrs.path.leading_colon {
            Some(..) => {
                let mut it = attrs.path.segments.iter();

                let Some(krate) = it.next() else {
                    return Err(syn::Error::new_spanned(
                        &attrs.path,
                        "missing leading segment",
                    ));
                };

                let krate = syn::LitStr::new(&krate.ident.to_string(), krate.ident.span());
                let item = build_item(it);

                if item.elems.is_empty() {
                    quote!(rune::__private::ItemBuf::with_crate(#krate)?)
                } else {
                    quote!(rune::__private::ItemBuf::with_crate_item(#krate, #item)?)
                }
            }
            None => {
                let item = build_item(attrs.path.segments.iter());

                if item.elems.is_empty() {
                    quote!(rune::__private::ItemBuf::new()?)
                } else {
                    quote!(rune::__private::ItemBuf::from_item(#item)?)
                }
            }
        };

        let mut stream = TokenStream::new();

        stream.extend(quote! {
            /// Get module metadata.
            #[automatically_derived]
            #[doc(hidden)]
            fn module_meta() -> rune::alloc::Result<rune::__private::ModuleMetaData> {
                Ok(rune::__private::ModuleMetaData {
                    docs: &#docs[..],
                    item: #item,
                })
            }
        });

        stream.extend(quote!(#[allow(rustdoc::broken_intra_doc_links)]));

        for attribute in self.attributes {
            attribute.to_tokens(&mut stream);
        }

        self.vis.to_tokens(&mut stream);
        self.signature.to_tokens(&mut stream);
        stream.extend(self.remainder);
        Ok(stream)
    }
}

fn build_item(it: syn::punctuated::Iter<'_, syn::PathSegment>) -> syn::ExprArray {
    let mut item = syn::ExprArray {
        attrs: Vec::new(),
        bracket_token: syn::token::Bracket::default(),
        elems: Punctuated::default(),
    };

    for p in it {
        let p = syn::LitStr::new(&p.ident.to_string(), p.ident.span());

        item.elems.push(syn::Expr::Lit(syn::ExprLit {
            attrs: Vec::new(),
            lit: syn::Lit::Str(p),
        }))
    }
    item
}