Macros to use path instead of ident (#1474)

Cargo.toml

@@ -345,6 +345,8 @@ members = [
 	"substrate/frame/support/test",
 	"substrate/frame/support/test/compile_pass",
 	"substrate/frame/support/test/pallet",
+	"substrate/frame/support/test/stg_frame_crate/frame",
+	"substrate/frame/support/test/stg_frame_crate",
 	"substrate/frame/system",
 	"substrate/frame/system/benchmarking",
 	"substrate/frame/system/rpc/runtime-api",

substrate/frame/support/procedural/src/benchmark.rs

@@ -18,7 +18,7 @@
 //! Home of the parsing and expansion code for the new pallet benchmarking syntax
 
 use derive_syn_parse::Parse;
-use frame_support_procedural_tools::generate_crate_access_2018;
+use frame_support_procedural_tools::generate_access_from_frame_or_crate;
 use proc_macro::TokenStream;
 use proc_macro2::{Ident, Span, TokenStream as TokenStream2};
 use quote::{quote, ToTokens};
@@ -418,7 +418,8 @@ pub fn benchmarks(
 		true => quote!(T: Config<I>, I: 'static),
 	};
 
-	let krate = generate_crate_access_2018("frame-benchmarking")?;
+	let krate = generate_access_from_frame_or_crate("frame-benchmarking")?;
+	let frame_system = generate_access_from_frame_or_crate("frame-system")?;
 
 	// benchmark name variables
 	let benchmark_names_str: Vec<String> = benchmark_names.iter().map(|n| n.to_string()).collect();
@@ -488,7 +489,7 @@ pub fn benchmarks(
 			}
 			#[cfg(any(feature = "runtime-benchmarks", test))]
 			impl<#type_impl_generics> #krate::Benchmarking for Pallet<#type_use_generics>
-			where T: frame_system::Config, #where_clause
+			where T: #frame_system::Config, #where_clause
 			{
 				fn benchmarks(
 					extra: bool,
@@ -535,7 +536,7 @@ pub fn benchmarks(
 						_ => return Err("Could not find extrinsic.".into()),
 					};
 					let mut whitelist = whitelist.to_vec();
-					let whitelisted_caller_key = <frame_system::Account<
+					let whitelisted_caller_key = <#frame_system::Account<
 						T,
 					> as #krate::__private::storage::StorageMap<_, _,>>::hashed_key_for(
 						#krate::whitelisted_caller::<T::AccountId>()
@@ -571,8 +572,8 @@ pub fn benchmarks(
 						>::instance(&selected_benchmark, c, verify)?;
 
 						// Set the block number to at least 1 so events are deposited.
-						if #krate::__private::Zero::is_zero(&frame_system::Pallet::<T>::block_number()) {
-							frame_system::Pallet::<T>::set_block_number(1u32.into());
+						if #krate::__private::Zero::is_zero(&#frame_system::Pallet::<T>::block_number()) {
+							#frame_system::Pallet::<T>::set_block_number(1u32.into());
 						}
 
 						// Commit the externalities to the database, flushing the DB cache.
@@ -654,7 +655,7 @@ pub fn benchmarks(
 			}
 
 			#[cfg(test)]
-			impl<#type_impl_generics> Pallet<#type_use_generics> where T: ::frame_system::Config, #where_clause {
+			impl<#type_impl_generics> Pallet<#type_use_generics> where T: #frame_system::Config, #where_clause {
 				/// Test a particular benchmark by name.
 				///
 				/// This isn't called `test_benchmark_by_name` just in case some end-user eventually
@@ -719,10 +720,14 @@ fn expand_benchmark(
 	where_clause: TokenStream2,
 ) -> TokenStream2 {
 	// set up variables needed during quoting
-	let krate = match generate_crate_access_2018("frame-benchmarking") {
+	let krate = match generate_access_from_frame_or_crate("frame-benchmarking") {
 		Ok(ident) => ident,
 		Err(err) => return err.to_compile_error().into(),
 	};
+	let frame_system = match generate_access_from_frame_or_crate("frame-system") {
+		Ok(path) => path,
+		Err(err) => return err.to_compile_error().into(),
+	};
 	let codec = quote!(#krate::__private::codec);
 	let traits = quote!(#krate::__private::traits);
 	let setup_stmts = benchmark_def.setup_stmts;
@@ -762,7 +767,7 @@ fn expand_benchmark(
 				Expr::Cast(t) => {
 					let ty = t.ty.clone();
 					quote! {
-						<<T as frame_system::Config>::RuntimeOrigin as From<#ty>>::from(#origin);
+						<<T as #frame_system::Config>::RuntimeOrigin as From<#ty>>::from(#origin);
 					}
 				},
 				_ => quote! {
@@ -932,7 +937,7 @@ fn expand_benchmark(
 		}
 
 		#[cfg(test)]
-		impl<#type_impl_generics> Pallet<#type_use_generics> where T: ::frame_system::Config, #where_clause {
+		impl<#type_impl_generics> Pallet<#type_use_generics> where T: #frame_system::Config, #where_clause {
 			#[allow(unused)]
 			fn #test_ident() -> Result<(), #krate::BenchmarkError> {
 				let selected_benchmark = SelectedBenchmark::#name;
@@ -951,8 +956,8 @@ fn expand_benchmark(
 					>::instance(&selected_benchmark, &c, true)?;
 
 					// Set the block number to at least 1 so events are deposited.
-					if #krate::__private::Zero::is_zero(&frame_system::Pallet::<T>::block_number()) {
-						frame_system::Pallet::<T>::set_block_number(1u32.into());
+					if #krate::__private::Zero::is_zero(&#frame_system::Pallet::<T>::block_number()) {
+						#frame_system::Pallet::<T>::set_block_number(1u32.into());
 					}
 
 					// Run execution + verification

substrate/frame/support/procedural/src/construct_runtime/mod.rs

@@ -214,7 +214,7 @@ mod parse;
 use crate::pallet::parse::helper::two128_str;
 use cfg_expr::Predicate;
 use frame_support_procedural_tools::{
-	generate_crate_access, generate_crate_access_2018, generate_hidden_includes,
+	generate_access_from_frame_or_crate, generate_crate_access, generate_hidden_includes,
 };
 use itertools::Itertools;
 use parse::{ExplicitRuntimeDeclaration, ImplicitRuntimeDeclaration, Pallet, RuntimeDeclaration};
@@ -272,7 +272,7 @@ fn construct_runtime_implicit_to_explicit(
 	input: TokenStream2,
 	definition: ImplicitRuntimeDeclaration,
 ) -> Result<TokenStream2> {
-	let frame_support = generate_crate_access_2018("frame-support")?;
+	let frame_support = generate_access_from_frame_or_crate("frame-support")?;
 	let mut expansion = quote::quote!(
 		#frame_support::construct_runtime! { #input }
 	);
@@ -283,7 +283,7 @@ fn construct_runtime_implicit_to_explicit(
 		expansion = quote::quote!(
 			#frame_support::__private::tt_call! {
 				macro = [{ #pallet_path::tt_default_parts }]
-				frame_support = [{ #frame_support }]
+				your_tt_return = [{ #frame_support::__private::tt_return }]
 				~~> #frame_support::match_and_insert! {
 					target = [{ #expansion }]
 					pattern = [{ #pallet_name: #pallet_path #pallet_instance }]
@@ -308,7 +308,7 @@ fn construct_runtime_explicit_to_explicit_expanded(
 	input: TokenStream2,
 	definition: ExplicitRuntimeDeclaration,
 ) -> Result<TokenStream2> {
-	let frame_support = generate_crate_access_2018("frame-support")?;
+	let frame_support = generate_access_from_frame_or_crate("frame-support")?;
 	let mut expansion = quote::quote!(
 		#frame_support::construct_runtime! { #input }
 	);
@@ -319,7 +319,7 @@ fn construct_runtime_explicit_to_explicit_expanded(
 		expansion = quote::quote!(
 			#frame_support::__private::tt_call! {
 				macro = [{ #pallet_path::tt_extra_parts }]
-				frame_support = [{ #frame_support }]
+				your_tt_return = [{ #frame_support::__private::tt_return }]
 				~~> #frame_support::match_and_insert! {
 					target = [{ #expansion }]
 					pattern = [{ #pallet_name: #pallet_path #pallet_instance }]
@@ -372,7 +372,7 @@ fn construct_runtime_final_expansion(
 	let scrate = generate_crate_access(hidden_crate_name, "frame-support");
 	let scrate_decl = generate_hidden_includes(hidden_crate_name, "frame-support");
 
-	let frame_system = generate_crate_access_2018("frame-system")?;
+	let frame_system = generate_access_from_frame_or_crate("frame-system")?;
 	let block = quote!(<#name as #frame_system::Config>::Block);
 	let unchecked_extrinsic = quote!(<#block as #scrate::sp_runtime::traits::Block>::Extrinsic);
 
@@ -799,7 +799,7 @@ fn decl_static_assertions(
 		quote! {
 			#scrate::__private::tt_call! {
 				macro = [{ #path::tt_error_token }]
-				frame_support = [{ #scrate }]
+				your_tt_return = [{ #scrate::__private::tt_return }]
 				~~> #scrate::assert_error_encoded_size! {
 					path = [{ #path }]
 					runtime = [{ #runtime }]

substrate/frame/support/procedural/src/crate_version.rs

@@ -18,7 +18,7 @@
 //! Implementation of macros related to crate versioning.
 
 use super::get_cargo_env_var;
-use frame_support_procedural_tools::generate_crate_access_2018;
+use frame_support_procedural_tools::generate_access_from_frame_or_crate;
 use proc_macro2::{Span, TokenStream};
 use syn::{Error, Result};
 
@@ -42,7 +42,7 @@ pub fn crate_to_crate_version(input: proc_macro::TokenStream) -> Result<TokenStr
 	let patch_version = get_cargo_env_var::<u8>("CARGO_PKG_VERSION_PATCH")
 		.map_err(|_| create_error("Patch version needs to fit into `u8`"))?;
 
-	let crate_ = generate_crate_access_2018("frame-support")?;
+	let crate_ = generate_access_from_frame_or_crate("frame-support")?;
 
 	Ok(quote::quote! {
 		#crate_::traits::CrateVersion {

substrate/frame/support/procedural/src/key_prefix.rs

@@ -15,6 +15,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+use frame_support_procedural_tools::generate_access_from_frame_or_crate;
 use proc_macro2::{Span, TokenStream};
 use quote::{format_ident, quote, ToTokens};
 use syn::{Ident, Result};
@@ -27,6 +28,7 @@ pub fn impl_key_prefix_for_tuples(input: proc_macro::TokenStream) -> Result<Toke
 	}
 
 	let mut all_trait_impls = TokenStream::new();
+	let frame_support = generate_access_from_frame_or_crate("frame-support")?;
 
 	for i in 2..=MAX_IDENTS {
 		let current_tuple = (0..i)
@@ -64,7 +66,10 @@ pub fn impl_key_prefix_for_tuples(input: proc_macro::TokenStream) -> Result<Toke
 					#(#hashers: ReversibleStorageHasher,)*
 					#(#kargs: EncodeLike<#prefixes>),*
 				> HasReversibleKeyPrefix<( #( #kargs, )* )> for ( #( Key<#hashers, #current_tuple>, )* ) {
-					fn decode_partial_key(key_material: &[u8]) -> Result<Self::Suffix, codec::Error> {
+					fn decode_partial_key(key_material: &[u8]) -> Result<
+						Self::Suffix,
+						#frame_support::__private::codec::Error,
+					> {
 						<#suffix_keygen>::decode_final_key(key_material).map(|k| k.0)
 					}
 				}

substrate/frame/support/procedural/src/lib.rs

@@ -33,7 +33,7 @@ mod storage_alias;
 mod transactional;
 mod tt_macro;
 
-use frame_support_procedural_tools::generate_crate_access_2018;
+use frame_support_procedural_tools::generate_access_from_frame_or_crate;
 use macro_magic::{import_tokens_attr, import_tokens_attr_verbatim};
 use proc_macro::TokenStream;
 use quote::{quote, ToTokens};
@@ -754,9 +754,9 @@ pub fn storage_alias(attributes: TokenStream, input: TokenStream) -> TokenStream
 #[import_tokens_attr_verbatim {
     format!(
         "{}::macro_magic",
-        match generate_crate_access_2018("frame-support") {
+        match generate_access_from_frame_or_crate("frame-support") {
             Ok(path) => Ok(path),
-            Err(_) => generate_crate_access_2018("frame"),
+            Err(_) => generate_access_from_frame_or_crate("frame"),
         }
         .expect("Failed to find either `frame-support` or `frame` in `Cargo.toml` dependencies.")
         .to_token_stream()
@@ -1612,9 +1612,9 @@ pub fn pallet_section(attr: TokenStream, tokens: TokenStream) -> TokenStream {
 #[import_tokens_attr {
     format!(
         "{}::macro_magic",
-        match generate_crate_access_2018("frame-support") {
+        match generate_access_from_frame_or_crate("frame-support") {
             Ok(path) => Ok(path),
-            Err(_) => generate_crate_access_2018("frame"),
+            Err(_) => generate_access_from_frame_or_crate("frame"),
         }
         .expect("Failed to find either `frame-support` or `frame` in `Cargo.toml` dependencies.")
         .to_token_stream()

substrate/frame/support/procedural/src/pallet/expand/error.rs

@@ -42,9 +42,9 @@ pub fn expand_error(def: &mut Def) -> proc_macro2::TokenStream {
 			macro_rules! #error_token_unique_id {
 				{
 					$caller:tt
-					frame_support = [{ $($frame_support:ident)::* }]
+					your_tt_return = [{ $my_tt_return:path }]
 				} => {
-					$($frame_support::)*__private::tt_return! {
+					$my_tt_return! {
 						$caller
 					}
 				};
@@ -170,9 +170,9 @@ pub fn expand_error(def: &mut Def) -> proc_macro2::TokenStream {
 		macro_rules! #error_token_unique_id {
 			{
 				$caller:tt
-				frame_support = [{ $($frame_support:ident)::* }]
+				your_tt_return = [{ $my_tt_return:path }]
 			} => {
-				$($frame_support::)*__private::tt_return! {
+				$my_tt_return! {
 					$caller
 					error = [{ #error_ident }]
 				}

substrate/frame/support/procedural/src/pallet/expand/genesis_config.rs

@@ -17,6 +17,7 @@
 
 use crate::{pallet::Def, COUNTER};
 use frame_support_procedural_tools::get_doc_literals;
+use quote::ToTokens;
 use syn::{spanned::Spanned, Ident};
 
 ///
@@ -79,7 +80,7 @@ pub fn expand_genesis_config(def: &mut Def) -> proc_macro2::TokenStream {
 	let genesis_config_item =
 		&mut def.item.content.as_mut().expect("Checked by def parser").1[genesis_config.index];
 
-	let serde_crate = format!("{}::__private::serde", frame_support);
+	let serde_crate = format!("{}::__private::serde", frame_support.to_token_stream());
 
 	match genesis_config_item {
 		syn::Item::Enum(syn::ItemEnum { attrs, .. }) |

substrate/frame/support/procedural/src/pallet/expand/tt_default_parts.rs

@@ -85,18 +85,16 @@ pub fn expand_tt_default_parts(def: &mut Def) -> proc_macro2::TokenStream {
 		// wrapped inside of braces and finally prepended with double colons, to the caller inside
 		// of a key named `tokens`.
 		//
-		// We need to accept a frame_support argument here, because this macro gets expanded on the
-		// crate that called the `construct_runtime!` macro, and said crate may have renamed
-		// frame-support, and so we need to pass in the frame-support path that said crate
-		// recognizes.
+		// We need to accept a path argument here, because this macro gets expanded on the
+		// crate that called the `construct_runtime!` macro, and the actual path is unknown.
 		#[macro_export]
 		#[doc(hidden)]
 		macro_rules! #default_parts_unique_id {
 			{
 				$caller:tt
-				frame_support = [{ $($frame_support:ident)::* }]
+				your_tt_return = [{ $my_tt_return:path }]
 			} => {
-				$($frame_support)*::__private::tt_return! {
+				$my_tt_return! {
 					$caller
 					tokens = [{
 						expanded::{
@@ -112,7 +110,7 @@ pub fn expand_tt_default_parts(def: &mut Def) -> proc_macro2::TokenStream {
 		pub use #default_parts_unique_id as tt_default_parts;
 
 
-		// This macro is similar to the `tt_default_parts!`. It expands the pallets thare are declared
+		// This macro is similar to the `tt_default_parts!`. It expands the pallets that are declared
 		// explicitly (`System: frame_system::{Pallet, Call}`) with extra parts.
 		//
 		// For example, after expansion an explicit pallet would look like:
@@ -124,9 +122,9 @@ pub fn expand_tt_default_parts(def: &mut Def) -> proc_macro2::TokenStream {
 		macro_rules! #extra_parts_unique_id {
 			{
 				$caller:tt
-				frame_support = [{ $($frame_support:ident)::* }]
+				your_tt_return = [{ $my_tt_return:path }]
 			} => {
-				$($frame_support)*::__private::tt_return! {
+				$my_tt_return! {
 					$caller
 					tokens = [{
 						expanded::{

substrate/frame/support/procedural/src/pallet/parse/composite.rs

@@ -92,7 +92,7 @@ impl CompositeDef {
 	pub fn try_from(
 		attr_span: proc_macro2::Span,
 		index: usize,
-		scrate: &proc_macro2::Ident,
+		scrate: &syn::Path,
 		item: &mut syn::Item,
 	) -> syn::Result<Self> {
 		let item = if let syn::Item::Enum(item) = item {