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
use super::super::InkAttribute;
use crate::{
ir::{
self,
attrs::SelectorOrWildcard,
utils,
},
InputsIter,
Receiver,
};
use proc_macro2::Span;
use syn::{
spanned::Spanned as _,
Result,
};
#[derive(Debug, Clone)]
pub enum InkTraitItem<'a> {
Message(InkTraitMessage<'a>),
}
impl<'a> InkTraitItem<'a> {
pub fn ident(&self) -> &syn::Ident {
match self {
Self::Message(message) => message.ident(),
}
}
pub fn ink_attrs(&self) -> InkAttribute {
match self {
Self::Message(message) => message.ink_attrs(),
}
}
pub fn filter_map_message(self) -> Option<InkTraitMessage<'a>> {
match self {
Self::Message(ink_trait_message) => Some(ink_trait_message),
}
}
}
#[derive(Debug, Clone)]
pub struct InkTraitMessage<'a> {
item: &'a syn::TraitItemMethod,
}
impl<'a> InkTraitMessage<'a> {
const INVALID_ATTRIBUTES_ERRSTR: &'static str =
"encountered invalid attributes for ink! trait message";
pub(super) fn new(item: &'a syn::TraitItemMethod) -> Self {
Self { item }
}
pub(super) fn extract_attributes(
span: Span,
attrs: &[syn::Attribute],
) -> Result<(InkAttribute, Vec<syn::Attribute>)> {
let (ink_attrs, non_ink_attrs) = ir::sanitize_attributes(
span,
attrs.iter().cloned(),
&ir::AttributeArgKind::Message,
|arg| {
match arg.kind() {
ir::AttributeArg::Selector(SelectorOrWildcard::Wildcard) =>
Err(Some(format_err!(arg.span(), "wildcard selectors are only supported for inherent ink! messages or constructors, not for traits."))),
ir::AttributeArg::Message
| ir::AttributeArg::Payable
| ir::AttributeArg::Selector(_) => Ok(()),
_ => Err(None),
}
},
)?;
Ok((ink_attrs, non_ink_attrs))
}
pub fn attrs(&self) -> Vec<syn::Attribute> {
let (_, rust_attrs) = Self::extract_attributes(self.span(), &self.item.attrs)
.expect(Self::INVALID_ATTRIBUTES_ERRSTR);
rust_attrs
}
pub fn ink_attrs(&self) -> InkAttribute {
let (ink_attrs, _) = Self::extract_attributes(self.span(), &self.item.attrs)
.expect(Self::INVALID_ATTRIBUTES_ERRSTR);
ink_attrs
}
pub fn sig(&self) -> &syn::Signature {
&self.item.sig
}
pub fn receiver(&self) -> Receiver {
match self.item.sig.inputs.iter().next() {
Some(syn::FnArg::Receiver(receiver)) => {
debug_assert!(receiver.reference.is_some());
if receiver.mutability.is_some() {
Receiver::RefMut
} else {
Receiver::Ref
}
}
_ => unreachable!("encountered invalid receiver argument for ink! message"),
}
}
pub fn inputs(&self) -> InputsIter {
InputsIter::from(self)
}
pub fn output(&self) -> Option<&syn::Type> {
match &self.item.sig.output {
syn::ReturnType::Default => None,
syn::ReturnType::Type(_, return_type) => Some(return_type),
}
}
pub fn ident(&self) -> &syn::Ident {
&self.item.sig.ident
}
pub fn local_id(&self) -> u32 {
utils::local_message_id(self.ident())
}
pub fn span(&self) -> Span {
self.item.span()
}
pub fn mutates(&self) -> bool {
self.sig()
.receiver()
.map(|fn_arg| {
match fn_arg {
syn::FnArg::Receiver(receiver) if receiver.mutability.is_some() => {
true
}
syn::FnArg::Typed(pat_type) => {
match &*pat_type.ty {
syn::Type::Reference(reference)
if reference.mutability.is_some() =>
{
true
}
_ => false,
}
}
_ => false,
}
})
.expect("encountered missing receiver for ink! message")
}
}
impl<'a> From<&'a InkTraitMessage<'a>> for InputsIter<'a> {
fn from(message: &'a InkTraitMessage) -> Self {
Self::new(&message.item.sig.inputs)
}
}