trait_def.rs 3.81 KB
Newer Older
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
// Copyright 2018-2020 Parity Technologies (UK) Ltd.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use crate::GenerateCode;
use derive_more::From;
use heck::CamelCase as _;
use proc_macro2::TokenStream as TokenStream2;
use quote::{
    format_ident,
    quote,
    quote_spanned,
};

/// Generator to create the ink! storage struct and important trait impls.
#[derive(From)]
pub struct TraitDefinition<'a> {
    trait_def: &'a ir::InkTrait,
}

impl<'a> TraitDefinition<'a> {
    fn generate_for_constructor(
        constructor: ir::InkTraitConstructor<'a>,
    ) -> TokenStream2 {
        let span = constructor.span();
        let attrs = constructor.attrs();
        let sig = constructor.sig();
        let ident = &sig.ident;
        let output_ident = format_ident!("{}Out", ident.to_string().to_camel_case());
        let inputs = &sig.inputs;
        quote_spanned!(span =>
            /// Output type of the respective trait constructor.
            type #output_ident;

            #(#attrs)*
            fn #ident(#inputs) -> Self::#output_ident;
        )
    }

    fn generate_for_message(message: ir::InkTraitMessage<'a>) -> TokenStream2 {
        let span = message.span();
        let attrs = message.attrs();
        let sig = message.sig();
        let ident = &sig.ident;
        let inputs = &sig.inputs;
        let output = match &sig.output {
            syn::ReturnType::Default => quote! { () },
            syn::ReturnType::Type(_, ty) => quote! { #ty },
        };
        let output_ident = format_ident!("{}Out", ident.to_string().to_camel_case());
        quote_spanned!(span =>
            /// Output type of the respective trait message.
            type #output_ident: ::ink_lang::ImpliesReturn<#output>;

            #(#attrs)*
            fn #ident(#inputs) -> Self::#output_ident;
        )
    }
}

impl GenerateCode for TraitDefinition<'_> {
    fn generate_code(&self) -> TokenStream2 {
        let span = self.trait_def.span();
        let attrs = self.trait_def.attrs();
        let hash = self.trait_def.verify_hash();
        let ident = self.trait_def.ident();
        let helper_ident = format_ident!(
            "__ink_Checked{}_0x{:X}{:X}{:X}{:X}",
            ident,
            hash[0],
            hash[1],
            hash[2],
            hash[3]
        );
        let verify_hash_id =
            u32::from_be_bytes([hash[0], hash[1], hash[2], hash[3]]) as usize;
        let constructors = self
            .trait_def
            .iter_items()
            .flat_map(ir::InkTraitItem::filter_map_constructor)
            .map(Self::generate_for_constructor);
        let messages = self
            .trait_def
            .iter_items()
            .flat_map(ir::InkTraitItem::filter_map_message)
            .map(Self::generate_for_message);
        quote_spanned!(span =>
            #(#attrs)*
            pub trait #ident: ::ink_lang::CheckedInkTrait<[(); #verify_hash_id]> {
                #[doc(hidden)]
                #[allow(non_camel_case_types)]
                type __ink_Checksum: #helper_ident;

                #(#constructors)*
                #(#messages)*
            }

            #[doc(hidden)]
            #[allow(non_camel_case_types)]
            pub unsafe trait #helper_ident {}

            const _: () = {
                unsafe impl #helper_ident for [(); #verify_hash_id] {}
            };
        )
    }
}