difftreelog
misc: Add docs on fields
in: master
1 file changed
crates/evm-coder/procedural/src/abi_derive.rsdiffbeforeafterboth1use quote::quote;23pub(crate) fn impl_abi_macro(ast: &syn::DeriveInput) -> syn::Result<proc_macro2::TokenStream> {4 let name = &ast.ident;5 let docs = ast6 .attrs7 .iter()8 .filter_map(|attr| {9 if let Some(ps) = attr.path.segments.first() {10 if ps.ident == "doc" {11 let meta = match attr.parse_meta() {12 Ok(meta) => meta,13 Err(e) => return Some(Err(e)),14 };15 match meta {16 syn::Meta::NameValue(mnv) => match &mnv.lit {17 syn::Lit::Str(ls) => return Some(Ok(ls.value())),18 _ => unreachable!(),19 },20 _ => unreachable!(),21 }22 }23 }24 None25 })26 .collect::<syn::Result<Vec<_>>>()?;2728 let (is_named_fields, field_names, field_types, params_count) = match &ast.data {29 syn::Data::Struct(ds) => match ds.fields {30 syn::Fields::Named(ref fields) => Ok((31 true,32 fields.named.iter().enumerate().map(map_field_to_name),33 fields.named.iter().map(map_field_to_type),34 fields.named.len(),35 )),36 syn::Fields::Unnamed(ref fields) => Ok((37 false,38 fields.unnamed.iter().enumerate().map(map_field_to_name),39 fields.unnamed.iter().map(map_field_to_type),40 fields.unnamed.len(),41 )),42 syn::Fields::Unit => Err(syn::Error::new(name.span(), "Unit structs not supported")),43 },44 syn::Data::Enum(_) => Err(syn::Error::new(name.span(), "Enums not supported")),45 syn::Data::Union(_) => Err(syn::Error::new(name.span(), "Unions not supported")),46 }?;4748 if params_count == 0 {49 return Err(syn::Error::new(name.span(), "Empty structs not supported"));50 };5152 let can_be_plcaed_in_vec = impl_can_be_placed_in_vec(name);53 let abi_type = impl_abi_type(name, field_types.clone());54 let abi_read = impl_abi_read(55 name,56 is_named_fields,57 field_names.clone(),58 field_types.clone(),59 );60 let abi_write = impl_abi_write(name, is_named_fields, params_count, field_names.clone());61 let solidity_type = impl_solidity_type(name, field_types.clone(), params_count);62 let solidity_type_name = impl_solidity_type_name(name, field_types.clone(), params_count);63 let solidity_struct_collect =64 impl_solidity_struct_collect(name, field_names, field_types, &docs);6566 Ok(quote! {67 #can_be_plcaed_in_vec68 #abi_type69 #abi_read70 #abi_write71 #solidity_type72 #solidity_type_name73 #solidity_struct_collect74 })75}7677fn impl_can_be_placed_in_vec(ident: &syn::Ident) -> proc_macro2::TokenStream {78 quote! {79 impl ::evm_coder::sealed::CanBePlacedInVec for #ident {}80 }81}8283fn map_field_to_name(field: (usize, &syn::Field)) -> syn::Ident {84 match field.1.ident.as_ref() {85 Some(name) => name.clone(),86 None => {87 let mut name = "field".to_string();88 name.push_str(field.0.to_string().as_str());89 syn::Ident::new(name.as_str(), proc_macro2::Span::call_site())90 }91 }92}9394fn map_field_to_type<'a>(field: &'a syn::Field) -> &'a syn::Type {95 &field.ty96}9798fn impl_abi_type<'a>(99 name: &syn::Ident,100 field_types: impl Iterator<Item = &'a syn::Type> + Clone,101) -> proc_macro2::TokenStream {102 let mut params_signature = {103 let types = field_types.clone();104 quote!(105 #(nameof(<#types as ::evm_coder::abi::AbiType>::SIGNATURE) fixed(","))*106 )107 };108109 params_signature.extend(quote!(shift_left(1)));110111 let fields_for_dynamic = field_types.clone();112113 quote! {114 impl ::evm_coder::abi::AbiType for #name {115 const SIGNATURE: ::evm_coder::custom_signature::SignatureUnit = ::evm_coder::make_signature!(116 new fixed("(")117 #params_signature118 fixed(")")119 );120 fn is_dynamic() -> bool {121 false122 #(123 || <#fields_for_dynamic as ::evm_coder::abi::AbiType>::is_dynamic()124 )*125 }126 fn size() -> usize {127 0 #(+ <#field_types as ::evm_coder::abi::AbiType>::size())*128 }129 }130 }131}132133fn impl_abi_read<'a>(134 name: &syn::Ident,135 is_named_fields: bool,136 field_names: impl Iterator<Item = proc_macro2::Ident> + Clone,137 field_types: impl Iterator<Item = &'a syn::Type> + Clone,138) -> proc_macro2::TokenStream {139 let field_names1 = field_names.clone();140141 let struct_constructor = if is_named_fields {142 quote!(Ok(Self { #(#field_names1),* }))143 } else {144 quote!(Ok(Self ( #(#field_names1),* )))145 };146 quote!(147 impl ::evm_coder::abi::AbiRead for #name {148 fn abi_read(reader: &mut ::evm_coder::abi::AbiReader) -> ::evm_coder::execution::Result<Self> {149 let is_dynamic = <Self as ::evm_coder::abi::AbiType>::is_dynamic();150 let size = if !is_dynamic {151 Some(<Self as ::evm_coder::abi::AbiType>::size())152 } else {153 None154 };155 let mut subresult = reader.subresult(size)?;156 #(157 let #field_names = {158 let value = <#field_types as ::evm_coder::abi::AbiRead>::abi_read(&mut subresult)?;159 if !is_dynamic {subresult.bytes_read(<#field_types as ::evm_coder::abi::AbiType>::size())};160 value161 };162 )*163164 #struct_constructor165 }166 }167 )168}169170fn impl_abi_write<'a>(171 name: &syn::Ident,172 is_named_fields: bool,173 params_count: usize,174 field_names: impl Iterator<Item = proc_macro2::Ident> + Clone,175) -> proc_macro2::TokenStream {176 let abi_write = if is_named_fields {177 quote!(178 #(179 ::evm_coder::abi::AbiWrite::abi_write(&self.#field_names, sub);180 )*181 )182 } else {183 let field_names = (0..params_count)184 .into_iter()185 .map(proc_macro2::Literal::usize_unsuffixed);186 quote!(187 #(188 ::evm_coder::abi::AbiWrite::abi_write(&self.#field_names, sub);189 )*190 )191 };192 quote!(193 impl ::evm_coder::abi::AbiWrite for #name {194 fn abi_write(&self, writer: &mut ::evm_coder::abi::AbiWriter) {195 if <Self as ::evm_coder::abi::AbiType>::is_dynamic() {196 let mut sub = ::evm_coder::abi::AbiWriter::new();197 {198 let sub = &mut sub;199 #abi_write200 }201 writer.write_subresult(sub);202 } else {203 let sub = writer;204 #abi_write205 }206 }207 }208 )209}210211fn impl_solidity_type<'a>(212 name: &syn::Ident,213 field_types: impl Iterator<Item = &'a syn::Type> + Clone,214 params_count: usize,215) -> proc_macro2::TokenStream {216 let len = proc_macro2::Literal::usize_suffixed(params_count);217 quote! {218 #[cfg(feature = "stubgen")]219 impl ::evm_coder::solidity::SolidityType for #name {220 fn names(tc: &::evm_coder::solidity::TypeCollector) -> Vec<String> {221 let mut collected =222 Vec::with_capacity(<Self as ::evm_coder::solidity::SolidityType>::len());223 #({224 let mut out = String::new();225 <#field_types as ::evm_coder::solidity::SolidityTypeName>::solidity_name(&mut out, tc)226 .expect("no fmt error");227 collected.push(out);228 })*229 collected230 }231232 fn len() -> usize {233 #len234 }235 }236 }237}238239fn impl_solidity_type_name<'a>(240 name: &syn::Ident,241 field_types: impl Iterator<Item = &'a syn::Type> + Clone,242 params_count: usize,243) -> proc_macro2::TokenStream {244 let arg_dafaults = field_types.enumerate().map(|(i, ty)| {245 let mut defult_value = quote!(<#ty as ::evm_coder::solidity::SolidityTypeName246 >::solidity_default(writer, tc)?;);247 let last_item = params_count - 1;248 if i != last_item {249 defult_value.extend(quote! {write!(writer, ",")?;})250 }251 defult_value252 });253254 quote! {255 #[cfg(feature = "stubgen")]256 impl ::evm_coder::solidity::SolidityTypeName for #name {257 fn solidity_name(258 writer: &mut impl ::core::fmt::Write,259 tc: &::evm_coder::solidity::TypeCollector,260 ) -> ::core::fmt::Result {261 write!(writer, "{}", tc.collect_struct::<Self>())262 }263264 fn is_simple() -> bool {265 false266 }267268 fn solidity_default(269 writer: &mut impl ::core::fmt::Write,270 tc: &::evm_coder::solidity::TypeCollector,271 ) -> ::core::fmt::Result {272 write!(writer, "{}(", tc.collect_struct::<Self>())?;273274 #(#arg_dafaults)*275276 write!(writer, ")")277 }278 }279 }280}281282fn impl_solidity_struct_collect<'a>(283 name: &syn::Ident,284 field_names: impl Iterator<Item = proc_macro2::Ident> + Clone,285 field_types: impl Iterator<Item = &'a syn::Type> + Clone,286 docs: &Vec<String>,287) -> proc_macro2::TokenStream {288 let string_name = name.to_string();289 let name_type = field_names290 .into_iter()291 .zip(field_types.into_iter())292 .map(|(name, ty)| {293 let name = format!("{}", name);294 quote!(295 write!(str, "\t{} ", <#ty as ::evm_coder::solidity::StructCollect>::name()).unwrap();296 write!(str, "{};", #name).unwrap();297 )298 });299 let docs = docs.iter().enumerate().map(|(i, doc)| {300 let doc = doc.trim();301 let dev = if i == 0 { " @dev" } else { "" };302 quote! {303 writeln!(str, "///{} {}", #dev, #doc).unwrap();304 }305 });306307 quote! {308 #[cfg(feature = "stubgen")]309 impl ::evm_coder::solidity::StructCollect for #name {310 fn name() -> String {311 #string_name.into()312 }313314 fn declaration() -> String {315 use std::fmt::Write;316317 let mut str = String::new();318 #(#docs)*319 writeln!(str, "struct {} {{", Self::name()).unwrap();320 #(#name_type)*321 writeln!(str, "}}").unwrap();322 str323 }324 }325 }326}1use quote::quote;23pub(crate) fn impl_abi_macro(ast: &syn::DeriveInput) -> syn::Result<proc_macro2::TokenStream> {4 let name = &ast.ident;5 let docs = extract_docs(&ast.attrs)?;67 let (is_named_fields, field_names, field_types, field_docs, params_count) = match &ast.data {8 syn::Data::Struct(ds) => match ds.fields {9 syn::Fields::Named(ref fields) => Ok((10 true,11 fields.named.iter().enumerate().map(map_field_to_name),12 fields.named.iter().map(map_field_to_type),13 fields.named.iter().map(map_field_to_doc),14 fields.named.len(),15 )),16 syn::Fields::Unnamed(ref fields) => Ok((17 false,18 fields.unnamed.iter().enumerate().map(map_field_to_name),19 fields.unnamed.iter().map(map_field_to_type),20 fields.unnamed.iter().map(map_field_to_doc),21 fields.unnamed.len(),22 )),23 syn::Fields::Unit => Err(syn::Error::new(name.span(), "Unit structs not supported")),24 },25 syn::Data::Enum(_) => Err(syn::Error::new(name.span(), "Enums not supported")),26 syn::Data::Union(_) => Err(syn::Error::new(name.span(), "Unions not supported")),27 }?;2829 if params_count == 0 {30 return Err(syn::Error::new(name.span(), "Empty structs not supported"));31 };3233 let can_be_plcaed_in_vec = impl_can_be_placed_in_vec(name);34 let abi_type = impl_abi_type(name, field_types.clone());35 let abi_read = impl_abi_read(36 name,37 is_named_fields,38 field_names.clone(),39 field_types.clone(),40 );41 let abi_write = impl_abi_write(name, is_named_fields, params_count, field_names.clone());42 let solidity_type = impl_solidity_type(name, field_types.clone(), params_count);43 let solidity_type_name = impl_solidity_type_name(name, field_types.clone(), params_count);44 let solidity_struct_collect =45 impl_solidity_struct_collect(name, field_names, field_types, field_docs, &docs)?;4647 Ok(quote! {48 #can_be_plcaed_in_vec49 #abi_type50 #abi_read51 #abi_write52 #solidity_type53 #solidity_type_name54 #solidity_struct_collect55 })56}5758fn extract_docs(attrs: &Vec<syn::Attribute>) -> syn::Result<Vec<String>> {59 attrs60 .iter()61 .filter_map(|attr| {62 if let Some(ps) = attr.path.segments.first() {63 if ps.ident == "doc" {64 let meta = match attr.parse_meta() {65 Ok(meta) => meta,66 Err(e) => return Some(Err(e)),67 };68 match meta {69 syn::Meta::NameValue(mnv) => match &mnv.lit {70 syn::Lit::Str(ls) => return Some(Ok(ls.value())),71 _ => unreachable!(),72 },73 _ => unreachable!(),74 }75 }76 }77 None78 })79 .collect()80}8182fn map_field_to_name(field: (usize, &syn::Field)) -> syn::Ident {83 match field.1.ident.as_ref() {84 Some(name) => name.clone(),85 None => {86 let mut name = "field".to_string();87 name.push_str(field.0.to_string().as_str());88 syn::Ident::new(name.as_str(), proc_macro2::Span::call_site())89 }90 }91}9293fn map_field_to_type<'a>(field: &'a syn::Field) -> &'a syn::Type {94 &field.ty95}9697fn map_field_to_doc(field: &syn::Field) -> Result<Vec<std::string::String>, syn::Error> {98 extract_docs(&field.attrs)99}100101fn impl_can_be_placed_in_vec(ident: &syn::Ident) -> proc_macro2::TokenStream {102 quote! {103 impl ::evm_coder::sealed::CanBePlacedInVec for #ident {}104 }105}106107fn impl_abi_type<'a>(108 name: &syn::Ident,109 field_types: impl Iterator<Item = &'a syn::Type> + Clone,110) -> proc_macro2::TokenStream {111 let mut params_signature = {112 let types = field_types.clone();113 quote!(114 #(nameof(<#types as ::evm_coder::abi::AbiType>::SIGNATURE) fixed(","))*115 )116 };117118 params_signature.extend(quote!(shift_left(1)));119120 let fields_for_dynamic = field_types.clone();121122 quote! {123 impl ::evm_coder::abi::AbiType for #name {124 const SIGNATURE: ::evm_coder::custom_signature::SignatureUnit = ::evm_coder::make_signature!(125 new fixed("(")126 #params_signature127 fixed(")")128 );129 fn is_dynamic() -> bool {130 false131 #(132 || <#fields_for_dynamic as ::evm_coder::abi::AbiType>::is_dynamic()133 )*134 }135 fn size() -> usize {136 0 #(+ <#field_types as ::evm_coder::abi::AbiType>::size())*137 }138 }139 }140}141142fn impl_abi_read<'a>(143 name: &syn::Ident,144 is_named_fields: bool,145 field_names: impl Iterator<Item = proc_macro2::Ident> + Clone,146 field_types: impl Iterator<Item = &'a syn::Type> + Clone,147) -> proc_macro2::TokenStream {148 let field_names1 = field_names.clone();149150 let struct_constructor = if is_named_fields {151 quote!(Ok(Self { #(#field_names1),* }))152 } else {153 quote!(Ok(Self ( #(#field_names1),* )))154 };155 quote!(156 impl ::evm_coder::abi::AbiRead for #name {157 fn abi_read(reader: &mut ::evm_coder::abi::AbiReader) -> ::evm_coder::execution::Result<Self> {158 let is_dynamic = <Self as ::evm_coder::abi::AbiType>::is_dynamic();159 let size = if !is_dynamic {160 Some(<Self as ::evm_coder::abi::AbiType>::size())161 } else {162 None163 };164 let mut subresult = reader.subresult(size)?;165 #(166 let #field_names = {167 let value = <#field_types as ::evm_coder::abi::AbiRead>::abi_read(&mut subresult)?;168 if !is_dynamic {subresult.bytes_read(<#field_types as ::evm_coder::abi::AbiType>::size())};169 value170 };171 )*172173 #struct_constructor174 }175 }176 )177}178179fn impl_abi_write<'a>(180 name: &syn::Ident,181 is_named_fields: bool,182 params_count: usize,183 field_names: impl Iterator<Item = proc_macro2::Ident> + Clone,184) -> proc_macro2::TokenStream {185 let abi_write = if is_named_fields {186 quote!(187 #(188 ::evm_coder::abi::AbiWrite::abi_write(&self.#field_names, sub);189 )*190 )191 } else {192 let field_names = (0..params_count)193 .into_iter()194 .map(proc_macro2::Literal::usize_unsuffixed);195 quote!(196 #(197 ::evm_coder::abi::AbiWrite::abi_write(&self.#field_names, sub);198 )*199 )200 };201 quote!(202 impl ::evm_coder::abi::AbiWrite for #name {203 fn abi_write(&self, writer: &mut ::evm_coder::abi::AbiWriter) {204 if <Self as ::evm_coder::abi::AbiType>::is_dynamic() {205 let mut sub = ::evm_coder::abi::AbiWriter::new();206 {207 let sub = &mut sub;208 #abi_write209 }210 writer.write_subresult(sub);211 } else {212 let sub = writer;213 #abi_write214 }215 }216 }217 )218}219220fn impl_solidity_type<'a>(221 name: &syn::Ident,222 field_types: impl Iterator<Item = &'a syn::Type> + Clone,223 params_count: usize,224) -> proc_macro2::TokenStream {225 let len = proc_macro2::Literal::usize_suffixed(params_count);226 quote! {227 #[cfg(feature = "stubgen")]228 impl ::evm_coder::solidity::SolidityType for #name {229 fn names(tc: &::evm_coder::solidity::TypeCollector) -> Vec<String> {230 let mut collected =231 Vec::with_capacity(<Self as ::evm_coder::solidity::SolidityType>::len());232 #({233 let mut out = String::new();234 <#field_types as ::evm_coder::solidity::SolidityTypeName>::solidity_name(&mut out, tc)235 .expect("no fmt error");236 collected.push(out);237 })*238 collected239 }240241 fn len() -> usize {242 #len243 }244 }245 }246}247248fn impl_solidity_type_name<'a>(249 name: &syn::Ident,250 field_types: impl Iterator<Item = &'a syn::Type> + Clone,251 params_count: usize,252) -> proc_macro2::TokenStream {253 let arg_dafaults = field_types.enumerate().map(|(i, ty)| {254 let mut defult_value = quote!(<#ty as ::evm_coder::solidity::SolidityTypeName255 >::solidity_default(writer, tc)?;);256 let last_item = params_count - 1;257 if i != last_item {258 defult_value.extend(quote! {write!(writer, ",")?;})259 }260 defult_value261 });262263 quote! {264 #[cfg(feature = "stubgen")]265 impl ::evm_coder::solidity::SolidityTypeName for #name {266 fn solidity_name(267 writer: &mut impl ::core::fmt::Write,268 tc: &::evm_coder::solidity::TypeCollector,269 ) -> ::core::fmt::Result {270 write!(writer, "{}", tc.collect_struct::<Self>())271 }272273 fn is_simple() -> bool {274 false275 }276277 fn solidity_default(278 writer: &mut impl ::core::fmt::Write,279 tc: &::evm_coder::solidity::TypeCollector,280 ) -> ::core::fmt::Result {281 write!(writer, "{}(", tc.collect_struct::<Self>())?;282283 #(#arg_dafaults)*284285 write!(writer, ")")286 }287 }288 }289}290291fn impl_solidity_struct_collect<'a>(292 name: &syn::Ident,293 field_names: impl Iterator<Item = proc_macro2::Ident> + Clone,294 field_types: impl Iterator<Item = &'a syn::Type> + Clone,295 field_docs: impl Iterator<Item = syn::Result<Vec<String>>> + Clone,296 docs: &Vec<String>,297) -> syn::Result<proc_macro2::TokenStream> {298 let string_name = name.to_string();299 let name_type = field_names300 .into_iter()301 .zip(field_types)302 .zip(field_docs)303 .map(|((name, ty), doc)| {304 let field_docs = match doc {305 Ok(doc) => doc.into_iter().enumerate().map(|(i, doc)| {306 let doc = doc.trim();307 let dev = if i == 0 { " @dev" } else { "" };308 quote! {309 writeln!(str, "///{} {}", #dev, #doc).unwrap();310 }311 }),312 Err(e) => unreachable!("{:?}", e),313 };314 let name = format!("{}", name);315 quote!(316 #(#field_docs)*317 write!(str, "\t{} ", <#ty as ::evm_coder::solidity::StructCollect>::name()).unwrap();318 writeln!(str, "{};", #name).unwrap();319 )320 });321 let docs = docs.iter().enumerate().map(|(i, doc)| {322 let doc = doc.trim();323 let dev = if i == 0 { " @dev" } else { "" };324 quote! {325 writeln!(str, "///{} {}", #dev, #doc).unwrap();326 }327 });328329 Ok(quote! {330 #[cfg(feature = "stubgen")]331 impl ::evm_coder::solidity::StructCollect for #name {332 fn name() -> String {333 #string_name.into()334 }335336 fn declaration() -> String {337 use std::fmt::Write;338339 let mut str = String::new();340 #(#docs)*341 writeln!(str, "struct {} {{", Self::name()).unwrap();342 #(#name_type)*343 writeln!(str, "}}").unwrap();344 str345 }346 }347 })348}