mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-27 20:57:59 +00:00
Derive no bound macros (to be also used in pallet macro) (#7280)
* derive no bound macros * explicit different variant for partialeq * fix ui for 1.47 * Apply suggestions from code review Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * move test to frame-support-test * renames, code organization and remove expect as suggested * better doc * remove DebugStripped introduce RuntimeDebugNoBound * rename * fix test * fix ui test * fix line width * Update frame/support/src/lib.rs Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * Update frame/support/procedural/src/clone_no_bound.rs Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * fix confusing dead code Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com>
This commit is contained in:
Guillaume Thiolliere
committed by
GitHub
GitHub
parent
87c18598fc
commit
7ca9baf9b6
@@ -0,0 +1,103 @@
|
||||
// This file is part of Substrate.
|
||||
|
||||
// Copyright (C) 2020 Parity Technologies (UK) Ltd.
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
// 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 syn::spanned::Spanned;
|
||||
|
||||
/// Derive Clone but do not bound any generic.
|
||||
pub fn derive_clone_no_bound(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
|
||||
let input: syn::DeriveInput = match syn::parse(input) {
|
||||
Ok(input) => input,
|
||||
Err(e) => return e.to_compile_error().into(),
|
||||
};
|
||||
|
||||
let name = &input.ident;
|
||||
let (impl_generics, ty_generics, where_clause) = input.generics.split_for_impl();
|
||||
|
||||
let impl_ = match input.data {
|
||||
syn::Data::Struct(struct_) => match struct_.fields {
|
||||
syn::Fields::Named(named) => {
|
||||
let fields = named.named.iter()
|
||||
.map(|i| &i.ident)
|
||||
.map(|i| quote::quote_spanned!(i.span() =>
|
||||
#i: core::clone::Clone::clone(&self.#i)
|
||||
));
|
||||
|
||||
quote::quote!( Self { #( #fields, )* } )
|
||||
},
|
||||
syn::Fields::Unnamed(unnamed) => {
|
||||
let fields = unnamed.unnamed.iter().enumerate()
|
||||
.map(|(i, _)| syn::Index::from(i))
|
||||
.map(|i| quote::quote_spanned!(i.span() =>
|
||||
core::clone::Clone::clone(&self.#i)
|
||||
));
|
||||
|
||||
quote::quote!( Self ( #( #fields, )* ) )
|
||||
},
|
||||
syn::Fields::Unit => {
|
||||
quote::quote!( Self )
|
||||
}
|
||||
},
|
||||
syn::Data::Enum(enum_) => {
|
||||
let variants = enum_.variants.iter()
|
||||
.map(|variant| {
|
||||
let ident = &variant.ident;
|
||||
match &variant.fields {
|
||||
syn::Fields::Named(named) => {
|
||||
let captured = named.named.iter().map(|i| &i.ident);
|
||||
let cloned = captured.clone()
|
||||
.map(|i| quote::quote_spanned!(i.span() =>
|
||||
#i: core::clone::Clone::clone(#i)
|
||||
));
|
||||
quote::quote!(
|
||||
Self::#ident { #( ref #captured, )* } => Self::#ident { #( #cloned, )*}
|
||||
)
|
||||
},
|
||||
syn::Fields::Unnamed(unnamed) => {
|
||||
let captured = unnamed.unnamed.iter().enumerate()
|
||||
.map(|(i, f)| syn::Ident::new(&format!("_{}", i), f.span()));
|
||||
let cloned = captured.clone()
|
||||
.map(|i| quote::quote_spanned!(i.span() =>
|
||||
core::clone::Clone::clone(#i)
|
||||
));
|
||||
quote::quote!(
|
||||
Self::#ident ( #( ref #captured, )* ) => Self::#ident ( #( #cloned, )*)
|
||||
)
|
||||
},
|
||||
syn::Fields::Unit => quote::quote!( Self::#ident => Self::#ident ),
|
||||
}
|
||||
});
|
||||
|
||||
quote::quote!(match self {
|
||||
#( #variants, )*
|
||||
})
|
||||
},
|
||||
syn::Data::Union(_) => {
|
||||
let msg = "Union type not supported by `derive(CloneNoBound)`";
|
||||
return syn::Error::new(input.span(), msg).to_compile_error().into()
|
||||
},
|
||||
};
|
||||
|
||||
quote::quote!(
|
||||
const _: () = {
|
||||
impl #impl_generics core::clone::Clone for #name #ty_generics #where_clause {
|
||||
fn clone(&self) -> Self {
|
||||
#impl_
|
||||
}
|
||||
}
|
||||
};
|
||||
).into()
|
||||
}
|
||||
@@ -0,0 +1,114 @@
|
||||
// This file is part of Substrate.
|
||||
|
||||
// Copyright (C) 2020 Parity Technologies (UK) Ltd.
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
// 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 syn::spanned::Spanned;
|
||||
|
||||
/// Derive Debug but do not bound any generics.
|
||||
pub fn derive_debug_no_bound(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
|
||||
let input: syn::DeriveInput = match syn::parse(input) {
|
||||
Ok(input) => input,
|
||||
Err(e) => return e.to_compile_error().into(),
|
||||
};
|
||||
|
||||
let input_ident = &input.ident;
|
||||
let (impl_generics, ty_generics, where_clause) = input.generics.split_for_impl();
|
||||
|
||||
let impl_ = match input.data {
|
||||
syn::Data::Struct(struct_) => match struct_.fields {
|
||||
syn::Fields::Named(named) => {
|
||||
let fields = named.named.iter()
|
||||
.map(|i| &i.ident)
|
||||
.map(|i| quote::quote_spanned!(i.span() => .field(stringify!(#i), &self.#i) ));
|
||||
|
||||
quote::quote!(
|
||||
fmt.debug_struct(stringify!(#input_ident))
|
||||
#( #fields )*
|
||||
.finish()
|
||||
)
|
||||
},
|
||||
syn::Fields::Unnamed(unnamed) => {
|
||||
let fields = unnamed.unnamed.iter().enumerate()
|
||||
.map(|(i, _)| syn::Index::from(i))
|
||||
.map(|i| quote::quote_spanned!(i.span() => .field(&self.#i) ));
|
||||
|
||||
quote::quote!(
|
||||
fmt.debug_tuple(stringify!(#input_ident))
|
||||
#( #fields )*
|
||||
.finish()
|
||||
)
|
||||
},
|
||||
syn::Fields::Unit => quote::quote!( fmt.write_str(stringify!(#input_ident)) ),
|
||||
},
|
||||
syn::Data::Enum(enum_) => {
|
||||
let variants = enum_.variants.iter()
|
||||
.map(|variant| {
|
||||
let ident = &variant.ident;
|
||||
let full_variant_str = format!("{}::{}", input_ident, ident);
|
||||
match &variant.fields {
|
||||
syn::Fields::Named(named) => {
|
||||
let captured = named.named.iter().map(|i| &i.ident);
|
||||
let debugged = captured.clone()
|
||||
.map(|i| quote::quote_spanned!(i.span() =>
|
||||
.field(stringify!(#i), &#i)
|
||||
));
|
||||
quote::quote!(
|
||||
Self::#ident { #( ref #captured, )* } => {
|
||||
fmt.debug_struct(#full_variant_str)
|
||||
#( #debugged )*
|
||||
.finish()
|
||||
}
|
||||
)
|
||||
},
|
||||
syn::Fields::Unnamed(unnamed) => {
|
||||
let captured = unnamed.unnamed.iter().enumerate()
|
||||
.map(|(i, f)| syn::Ident::new(&format!("_{}", i), f.span()));
|
||||
let debugged = captured.clone()
|
||||
.map(|i| quote::quote_spanned!(i.span() => .field(&#i)));
|
||||
quote::quote!(
|
||||
Self::#ident ( #( ref #captured, )* ) => {
|
||||
fmt.debug_tuple(#full_variant_str)
|
||||
#( #debugged )*
|
||||
.finish()
|
||||
}
|
||||
)
|
||||
},
|
||||
syn::Fields::Unit => quote::quote!(
|
||||
Self::#ident => fmt.write_str(#full_variant_str)
|
||||
),
|
||||
}
|
||||
});
|
||||
|
||||
quote::quote!(match *self {
|
||||
#( #variants, )*
|
||||
})
|
||||
},
|
||||
syn::Data::Union(_) => {
|
||||
let msg = "Union type not supported by `derive(DebugNoBound)`";
|
||||
return syn::Error::new(input.span(), msg).to_compile_error().into()
|
||||
},
|
||||
};
|
||||
|
||||
quote::quote!(
|
||||
const _: () = {
|
||||
impl #impl_generics core::fmt::Debug for #input_ident #ty_generics #where_clause {
|
||||
fn fmt(&self, fmt: &mut core::fmt::Formatter) -> core::fmt::Result {
|
||||
#impl_
|
||||
}
|
||||
}
|
||||
};
|
||||
).into()
|
||||
}
|
||||
@@ -22,6 +22,9 @@
|
||||
mod storage;
|
||||
mod construct_runtime;
|
||||
mod transactional;
|
||||
mod debug_no_bound;
|
||||
mod clone_no_bound;
|
||||
mod partial_eq_no_bound;
|
||||
|
||||
use proc_macro::TokenStream;
|
||||
|
||||
@@ -326,6 +329,75 @@ pub fn transactional(attr: TokenStream, input: TokenStream) -> TokenStream {
|
||||
transactional::transactional(attr, input).unwrap_or_else(|e| e.to_compile_error().into())
|
||||
}
|
||||
|
||||
/// Derive [`Clone`] but do not bound any generic. Docs are at `frame_support::CloneNoBound`.
|
||||
#[proc_macro_derive(CloneNoBound)]
|
||||
pub fn derive_clone_no_bound(input: TokenStream) -> TokenStream {
|
||||
clone_no_bound::derive_clone_no_bound(input)
|
||||
}
|
||||
|
||||
/// Derive [`Debug`] but do not bound any generics. Docs are at `frame_support::DeriveNoBounds`.
|
||||
#[proc_macro_derive(DebugNoBound)]
|
||||
pub fn derive_debug_no_bound(input: TokenStream) -> TokenStream {
|
||||
debug_no_bound::derive_debug_no_bound(input)
|
||||
}
|
||||
|
||||
/// Derive [`Debug`], if `std` is enabled it uses `frame_support::DebugNoBound`, if `std` is not
|
||||
/// enabled it just returns `"<stripped>"`.
|
||||
/// This behaviour is useful to prevent bloating the runtime WASM blob from unneeded code.
|
||||
#[proc_macro_derive(RuntimeDebugNoBound)]
|
||||
pub fn derive_runtime_debug_no_bound(input: TokenStream) -> TokenStream {
|
||||
#[cfg(not(feature = "std"))]
|
||||
{
|
||||
let input: syn::DeriveInput = match syn::parse(input) {
|
||||
Ok(input) => input,
|
||||
Err(e) => return e.to_compile_error().into(),
|
||||
};
|
||||
|
||||
let name = &input.ident;
|
||||
let (impl_generics, ty_generics, where_clause) = input.generics.split_for_impl();
|
||||
|
||||
quote::quote!(
|
||||
const _: () = {
|
||||
impl #impl_generics core::fmt::Debug for #name #ty_generics #where_clause {
|
||||
fn fmt(&self, fmt: &mut core::fmt::Formatter) -> core::fmt::Result {
|
||||
fmt.write_str("<stripped>")
|
||||
}
|
||||
}
|
||||
};
|
||||
).into()
|
||||
}
|
||||
|
||||
#[cfg(feature = "std")]
|
||||
{
|
||||
debug_no_bound::derive_debug_no_bound(input)
|
||||
}
|
||||
}
|
||||
|
||||
/// Derive [`PartialEq`] but do not bound any generic. Docs are at
|
||||
/// `frame_support::PartialEqNoBound`.
|
||||
#[proc_macro_derive(PartialEqNoBound)]
|
||||
pub fn derive_partial_eq_no_bound(input: TokenStream) -> TokenStream {
|
||||
partial_eq_no_bound::derive_partial_eq_no_bound(input)
|
||||
}
|
||||
|
||||
/// derive Eq but do no bound any generic. Docs are at `frame_support::EqNoBound`.
|
||||
#[proc_macro_derive(EqNoBound)]
|
||||
pub fn derive_eq_no_bound(input: TokenStream) -> TokenStream {
|
||||
let input: syn::DeriveInput = match syn::parse(input) {
|
||||
Ok(input) => input,
|
||||
Err(e) => return e.to_compile_error().into(),
|
||||
};
|
||||
|
||||
let name = &input.ident;
|
||||
let (impl_generics, ty_generics, where_clause) = input.generics.split_for_impl();
|
||||
|
||||
quote::quote_spanned!(name.span() =>
|
||||
const _: () = {
|
||||
impl #impl_generics core::cmp::Eq for #name #ty_generics #where_clause {}
|
||||
};
|
||||
).into()
|
||||
}
|
||||
|
||||
#[proc_macro_attribute]
|
||||
pub fn require_transactional(attr: TokenStream, input: TokenStream) -> TokenStream {
|
||||
transactional::require_transactional(attr, input).unwrap_or_else(|e| e.to_compile_error().into())
|
||||
|
||||
@@ -0,0 +1,126 @@
|
||||
// This file is part of Substrate.
|
||||
|
||||
// Copyright (C) 2020 Parity Technologies (UK) Ltd.
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
// 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 syn::spanned::Spanned;
|
||||
|
||||
/// Derive PartialEq but do not bound any generic.
|
||||
pub fn derive_partial_eq_no_bound(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
|
||||
let input: syn::DeriveInput = match syn::parse(input) {
|
||||
Ok(input) => input,
|
||||
Err(e) => return e.to_compile_error().into(),
|
||||
};
|
||||
|
||||
let name = &input.ident;
|
||||
let (impl_generics, ty_generics, where_clause) = input.generics.split_for_impl();
|
||||
|
||||
let impl_ = match input.data {
|
||||
syn::Data::Struct(struct_) => match struct_.fields {
|
||||
syn::Fields::Named(named) => {
|
||||
let fields = named.named.iter()
|
||||
.map(|i| &i.ident)
|
||||
.map(|i| quote::quote_spanned!(i.span() => self.#i == other.#i ));
|
||||
|
||||
quote::quote!( true #( && #fields )* )
|
||||
},
|
||||
syn::Fields::Unnamed(unnamed) => {
|
||||
let fields = unnamed.unnamed.iter().enumerate()
|
||||
.map(|(i, _)| syn::Index::from(i))
|
||||
.map(|i| quote::quote_spanned!(i.span() => self.#i == other.#i ));
|
||||
|
||||
quote::quote!( true #( && #fields )* )
|
||||
},
|
||||
syn::Fields::Unit => {
|
||||
quote::quote!( true )
|
||||
}
|
||||
},
|
||||
syn::Data::Enum(enum_) => {
|
||||
let variants = enum_.variants.iter()
|
||||
.map(|variant| {
|
||||
let ident = &variant.ident;
|
||||
match &variant.fields {
|
||||
syn::Fields::Named(named) => {
|
||||
let names = named.named.iter().map(|i| &i.ident);
|
||||
let other_names = names.clone()
|
||||
.enumerate()
|
||||
.map(|(n, ident)|
|
||||
syn::Ident::new(&format!("_{}", n), ident.span())
|
||||
);
|
||||
|
||||
let capture = names.clone();
|
||||
let other_capture = names.clone().zip(other_names.clone())
|
||||
.map(|(i, other_i)| quote::quote!(#i: #other_i));
|
||||
let eq = names.zip(other_names)
|
||||
.map(|(i, other_i)| quote::quote_spanned!(i.span() => #i == #other_i));
|
||||
quote::quote!(
|
||||
(
|
||||
Self::#ident { #( #capture, )* },
|
||||
Self::#ident { #( #other_capture, )* },
|
||||
) => true #( && #eq )*
|
||||
)
|
||||
},
|
||||
syn::Fields::Unnamed(unnamed) => {
|
||||
let names = unnamed.unnamed.iter().enumerate()
|
||||
.map(|(i, f)| syn::Ident::new(&format!("_{}", i), f.span()));
|
||||
let other_names = unnamed.unnamed.iter().enumerate()
|
||||
.map(|(i, f)| syn::Ident::new(&format!("_{}_other", i), f.span()));
|
||||
let eq = names.clone().zip(other_names.clone())
|
||||
.map(|(i, other_i)| quote::quote_spanned!(i.span() => #i == #other_i));
|
||||
quote::quote!(
|
||||
(
|
||||
Self::#ident ( #( #names, )* ),
|
||||
Self::#ident ( #( #other_names, )* ),
|
||||
) => true #( && #eq )*
|
||||
)
|
||||
},
|
||||
syn::Fields::Unit => quote::quote!( (Self::#ident, Self::#ident) => true ),
|
||||
}
|
||||
});
|
||||
|
||||
let mut different_variants = vec![];
|
||||
for (i, i_variant) in enum_.variants.iter().enumerate() {
|
||||
for (j, j_variant) in enum_.variants.iter().enumerate() {
|
||||
if i != j {
|
||||
let i_ident = &i_variant.ident;
|
||||
let j_ident = &j_variant.ident;
|
||||
different_variants.push(quote::quote!(
|
||||
(Self::#i_ident { .. }, Self::#j_ident { .. }) => false
|
||||
))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
quote::quote!( match (self, other) {
|
||||
#( #variants, )*
|
||||
#( #different_variants, )*
|
||||
})
|
||||
},
|
||||
syn::Data::Union(_) => {
|
||||
let msg = "Union type not supported by `derive(PartialEqNoBound)`";
|
||||
return syn::Error::new(input.span(), msg).to_compile_error().into()
|
||||
},
|
||||
};
|
||||
|
||||
quote::quote!(
|
||||
const _: () = {
|
||||
impl #impl_generics core::cmp::PartialEq for #name #ty_generics #where_clause {
|
||||
fn eq(&self, other: &Self) -> bool {
|
||||
#impl_
|
||||
}
|
||||
}
|
||||
};
|
||||
).into()
|
||||
}
|
||||
Reference in New Issue
Block a user