multiversx-sc-derive 0.66.0

MultiversX smart contract API procedural macros
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

use quote::ToTokens;

use super::{attr_names::*, util::*};

/// unlike the others, this is standard Rust,
/// all doc comments get automatically transformed into "doc" attributes
static ATTR_DOC: &str = "doc";

/// Doc comments are actually syntactic sugar for doc attributes,
/// so extracting doc comments means parsing "doc" attributes.
pub fn extract_doc(attrs: &[syn::Attribute]) -> Vec<String> {
    attrs
        .iter()
        .filter(|attr| {
            if let Some(first_seg) = attr.path().segments.first() {
                first_seg.ident == ATTR_DOC
            } else {
                false
            }
        })
        .map(|attr| match attr.meta.clone() {
            syn::Meta::Path(_) => panic!("wrong format. expected name value, received path"),
            syn::Meta::List(_) => panic!("wrong format. expected name value, received list"),
            syn::Meta::NameValue(meta_name_value) => {
                if let syn::Expr::Lit(lit_str) = meta_name_value.value {
                    if meta_name_value.path.is_ident("doc") {
                        let value = lit_str.lit;
                        if let Some(tuple) = value
                            .to_token_stream()
                            .to_string()
                            .split_once(char::is_whitespace)
                        {
                            remove_backslashes(tuple.1)
                        } else {
                            String::new()
                        }
                    } else {
                        panic!("Attribute doesn't have the 'doc' identifier");
                    }
                } else {
                    panic!("Value is not a string literal");
                }
            }
        })
        .collect()
}

pub fn extract_macro_attributes(attrs: &[syn::Attribute]) -> Vec<String> {
    let mut macro_attributes = Vec::new();

    for a in attrs {
        match &a.meta {
            syn::Meta::List(list) if list.path.is_ident("derive") => {
                for token in list.tokens.clone().into_iter() {
                    if let proc_macro2::TokenTree::Ident(ident) = token {
                        macro_attributes.push(ident.to_string());
                    }
                }
            }
            syn::Meta::Path(path) if path.segments.len() > 1 => {
                let path_str = path
                    .segments
                    .iter()
                    .map(|s| s.ident.to_string())
                    .collect::<Vec<_>>()
                    .join("::");
                macro_attributes.push(path_str);
            }
            _ => {}
        }
    }

    macro_attributes
}

fn remove_backslashes(input: &str) -> String {
    input
        .trim_matches('\"')
        .replace("\\\"", "\"")
        .replace("\\'", "'")
}

pub struct OutputNameAttribute {
    pub output_name: String,
}

impl OutputNameAttribute {
    pub fn parse(attr: &syn::Attribute) -> Option<Self> {
        is_attr_one_string_arg(attr, ATTR_OUTPUT_NAME).map(|arg_str| OutputNameAttribute {
            output_name: arg_str,
        })
    }
}

pub struct TitleAttribute {
    pub title: String,
}

impl TitleAttribute {
    pub fn parse(attr: &syn::Attribute) -> Option<Self> {
        is_attr_one_string_arg(attr, ATTR_TITLE).map(|arg_str| TitleAttribute { title: arg_str })
    }
}