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
// This file is part of Substrate.

// Copyright (C) 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 proc_macro2::TokenStream;
use quote::quote;
use syn::{parse_quote, Data, DeriveInput};

pub fn debug_derive(ast: DeriveInput) -> proc_macro::TokenStream {
	let name_str = ast.ident.to_string();
	let implementation = implementation::derive(&name_str, &ast.data);
	let name = &ast.ident;
	let mut generics = ast.generics.clone();
	let (impl_generics, ty_generics, where_clause) = {
		let wh = generics.make_where_clause();
		for t in ast.generics.type_params() {
			let name = &t.ident;
			wh.predicates.push(parse_quote! { #name : core::fmt::Debug });
		}
		generics.split_for_impl()
	};
	let gen = quote! {
		impl #impl_generics core::fmt::Debug for #name #ty_generics #where_clause {
			fn fmt(&self, fmt: &mut core::fmt::Formatter) -> core::fmt::Result {
				#implementation
			}
		}
	};

	gen.into()
}

#[cfg(all(not(feature = "std"), not(feature = "force-debug")))]
mod implementation {
	use super::*;

	/// Derive the inner implementation of `Debug::fmt` function.
	///
	/// Non-std environment. We do nothing to prevent bloating the size of runtime.
	/// Implement `Printable` if you need to print the details.
	pub fn derive(_name_str: &str, _data: &Data) -> TokenStream {
		quote! {
			fmt.write_str("<wasm:stripped>")
		}
	}
}

#[cfg(any(feature = "std", feature = "force-debug"))]
mod implementation {
	use super::*;
	use proc_macro2::Span;
	use syn::{token::SelfValue, Ident, Index};

	/// Derive the inner implementation of `Debug::fmt` function.
	pub fn derive(name_str: &str, data: &Data) -> TokenStream {
		match *data {
			Data::Struct(ref s) => derive_struct(name_str, &s.fields),
			Data::Union(ref u) => derive_fields(name_str, Fields::new(u.fields.named.iter(), None)),
			Data::Enum(ref e) => derive_enum(name_str, e),
		}
	}

	enum Fields {
		Indexed { indices: Vec<Index> },
		Unnamed { vars: Vec<Ident> },
		Named { names: Vec<Ident>, this: Option<SelfValue> },
	}

	impl Fields {
		fn new<'a>(fields: impl Iterator<Item = &'a syn::Field>, this: Option<SelfValue>) -> Self {
			let mut indices = vec![];
			let mut names = vec![];

			for (i, f) in fields.enumerate() {
				if let Some(ident) = f.ident.clone() {
					names.push(ident);
				} else {
					indices.push(Index::from(i));
				}
			}

			if names.is_empty() {
				Self::Indexed { indices }
			} else {
				Self::Named { names, this }
			}
		}
	}

	fn derive_fields(name_str: &str, fields: Fields) -> TokenStream {
		match fields {
			Fields::Named { names, this } => {
				let names_str: Vec<_> = names.iter().map(|x| x.to_string()).collect();

				let fields = match this {
					None => quote! { #( .field(#names_str, #names) )* },
					Some(this) => quote! { #( .field(#names_str, &#this.#names) )* },
				};

				quote! {
					fmt.debug_struct(#name_str)
						#fields
						.finish()
				}
			},
			Fields::Indexed { indices } => {
				quote! {
					fmt.debug_tuple(#name_str)
						#( .field(&self.#indices) )*
						.finish()
				}
			},
			Fields::Unnamed { vars } => {
				quote! {
					fmt.debug_tuple(#name_str)
						#( .field(#vars) )*
						.finish()
				}
			},
		}
	}

	fn derive_enum(name: &str, e: &syn::DataEnum) -> TokenStream {
		let v = e.variants.iter().map(|v| {
			let name = format!("{}::{}", name, v.ident);
			let ident = &v.ident;
			match v.fields {
				syn::Fields::Named(ref f) => {
					let names: Vec<_> = f.named.iter().flat_map(|f| f.ident.clone()).collect();
					let fields_impl =
						derive_fields(&name, Fields::Named { names: names.clone(), this: None });
					(ident, (quote! { { #( ref #names ),* } }, fields_impl))
				},
				syn::Fields::Unnamed(ref f) => {
					let names = f
						.unnamed
						.iter()
						.enumerate()
						.map(|(id, _)| Ident::new(&format!("a{}", id), Span::call_site()))
						.collect::<Vec<_>>();
					let fields_impl = derive_fields(&name, Fields::Unnamed { vars: names.clone() });
					(ident, (quote! { ( #( ref #names ),* ) }, fields_impl))
				},
				syn::Fields::Unit => {
					let fields_impl = derive_fields(&name, Fields::Indexed { indices: vec![] });
					(ident, (quote! {}, fields_impl))
				},
			}
		});

		type Vecs<A, B> = (Vec<A>, Vec<B>);
		let (variants, others): Vecs<_, _> = v.unzip();
		let (match_fields, variants_impl): Vecs<_, _> = others.into_iter().unzip();

		quote! {
			match self {
				#( Self::#variants #match_fields => #variants_impl, )*
				_ => Ok(()),
			}
		}
	}

	fn derive_struct(name_str: &str, fields: &syn::Fields) -> TokenStream {
		match *fields {
			syn::Fields::Named(ref f) => derive_fields(
				name_str,
				Fields::new(f.named.iter(), Some(syn::Token!(self)(Span::call_site()))),
			),
			syn::Fields::Unnamed(ref f) =>
				derive_fields(name_str, Fields::new(f.unnamed.iter(), None)),
			syn::Fields::Unit => derive_fields(name_str, Fields::Indexed { indices: vec![] }),
		}
	}
}