Refactor construct_runtime to procedural (#3810)

* interim

* interim

* interim

* first working section

* cleanup

* finished parsing

* cleanup

* added system module search

* added clone and find_entry

* generic find_module_entry

* interim

* working event

* added generic event with no instance error

* cleanup

* added decl origin

* cleanup

* added all modules

* added outer dispatch

* added modules expansion

* refactored transformations

* updated error message

* added resolve mechanics

* added metadata

* finished config

* finished inherents

* added validate_unsigned

* added compares

* cleanup

* cleanup

* cleanup

* fix

* updated modules for last one wins

* cleanup

* made nested modules

* updated impl version

* removed comment

* cleanup

* added ui tests

* added optional comma

* removed unnecessary to string cast

* removed no compile

* cleanup

* fmt

* returned nocompile

* Update srml/support/procedural/src/construct_runtime/parse.rs

Co-Authored-By: thiolliere <gui.thiolliere@gmail.com>

* added where definition

* updated ui tests

* updated ui test cases

* added test case

* updated tests

* interim

* added parse for module part

* removed totokens

* fixes

* fixed multiple iter

* changed TokenStream

* fmt

* updated trybuild

* added test for arguments

* fmt

* fixes + more tests

* fixes

* fmt

* rolled back runtime

* minor fixes

* empty

* fixes

* fmt

* Update paint/support/procedural/src/lib.rs

Co-Authored-By: Bastian Köcher <bkchr@users.noreply.github.com>

* Update paint/support/procedural/src/lib.rs

Co-Authored-By: Bastian Köcher <bkchr@users.noreply.github.com>

* Update paint/support/procedural/src/construct_runtime/parse.rs

Co-Authored-By: Bastian Köcher <bkchr@users.noreply.github.com>

* interim

* refactored seen_keys

* refactored hash_set

* Update paint/support/procedural/src/construct_runtime/mod.rs

Co-Authored-By: Bastian Köcher <bkchr@users.noreply.github.com>

* refactored find

* fix

* fixed all_modules

* added double declaration check

* small fix

* fmt

* fix

* fix default

* format
This commit is contained in:
Alexey
2019-11-25 19:48:18 +03:00
committed by Bastian Köcher
parent d56d6163ef
commit d7b9dd300b
43 changed files with 1148 additions and 955 deletions
@@ -0,0 +1,350 @@
// Copyright 2019 Parity Technologies (UK) Ltd.
// This file is part of Substrate.
// Substrate is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// Substrate is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with Substrate. If not, see <http://www.gnu.org/licenses/>.
mod parse;
use frame_support_procedural_tools::syn_ext as ext;
use frame_support_procedural_tools::{generate_crate_access, generate_hidden_includes};
use parse::{ModuleDeclaration, RuntimeDefinition, WhereSection};
use proc_macro::TokenStream;
use proc_macro2::{Span, TokenStream as TokenStream2};
use quote::quote;
use syn::{Ident, Result};
pub fn construct_runtime(input: TokenStream) -> TokenStream {
let definition = syn::parse_macro_input!(input as RuntimeDefinition);
construct_runtime_parsed(definition)
.unwrap_or_else(|e| e.to_compile_error())
.into()
}
fn construct_runtime_parsed(definition: RuntimeDefinition) -> Result<TokenStream2> {
let RuntimeDefinition {
name,
where_section: WhereSection {
block,
node_block,
unchecked_extrinsic,
..
},
modules:
ext::Braces {
content: ext::Punctuated { inner: modules, .. },
token: modules_token,
},
..
} = definition;
// Assert we have system module declared
let system_module = match find_system_module(modules.iter()) {
Some(sm) => sm,
None => {
return Err(syn::Error::new(
modules_token.span,
"`System` module declaration is missing. \
Please add this line: `System: system::{Module, Call, Storage, Config, Event},`",
))
}
};
let hidden_crate_name = "construct_runtime";
let scrate = generate_crate_access(&hidden_crate_name, "frame-support");
let scrate_decl = generate_hidden_includes(&hidden_crate_name, "frame-support");
let all_but_system_modules = modules.iter().filter(|module| module.name != "System");
let outer_event = decl_outer_event_or_origin(
&name,
all_but_system_modules.clone(),
&system_module,
&scrate,
DeclOuterKind::Event,
)?;
let outer_origin = decl_outer_event_or_origin(
&name,
all_but_system_modules.clone(),
&system_module,
&scrate,
DeclOuterKind::Origin,
)?;
let all_modules = decl_all_modules(&name, all_but_system_modules);
let dispatch = decl_outer_dispatch(&name, modules.iter(), &scrate);
let metadata = decl_runtime_metadata(&name, modules.iter(), &scrate);
let outer_config = decl_outer_config(&name, modules.iter(), &scrate);
let inherent = decl_outer_inherent(&block, &unchecked_extrinsic, modules.iter(), &scrate);
let validate_unsigned = decl_validate_unsigned(&name, modules.iter(), &scrate);
Ok(quote!(
#scrate_decl
#[derive(Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "std", derive(Debug))]
pub struct #name;
impl #scrate::sr_primitives::traits::GetNodeBlockType for #name {
type NodeBlock = #node_block;
}
impl #scrate::sr_primitives::traits::GetRuntimeBlockType for #name {
type RuntimeBlock = #block;
}
#outer_event
#outer_origin
#all_modules
#dispatch
#metadata
#outer_config
#inherent
#validate_unsigned
)
.into())
}
fn decl_validate_unsigned<'a>(
runtime: &'a Ident,
module_declarations: impl Iterator<Item = &'a ModuleDeclaration>,
scrate: &'a TokenStream2,
) -> TokenStream2 {
let modules_tokens = module_declarations
.filter(|module_declaration| module_declaration.exists_part("ValidateUnsigned"))
.map(|module_declaration| &module_declaration.name);
quote!(
#scrate::impl_outer_validate_unsigned!(
impl ValidateUnsigned for #runtime {
#( #modules_tokens )*
}
);
)
}
fn decl_outer_inherent<'a>(
block: &'a syn::TypePath,
unchecked_extrinsic: &'a syn::TypePath,
module_declarations: impl Iterator<Item = &'a ModuleDeclaration>,
scrate: &'a TokenStream2,
) -> TokenStream2 {
let modules_tokens = module_declarations.filter_map(|module_declaration| {
let maybe_config_part = module_declaration.find_part("Inherent");
maybe_config_part.map(|config_part| {
let arg = config_part
.args
.as_ref()
.and_then(|parens| parens.content.inner.iter().next())
.unwrap_or(&module_declaration.name);
let name = &module_declaration.name;
quote!(#name : #arg,)
})
});
quote!(
#scrate::impl_outer_inherent!(
impl Inherents where Block = #block, UncheckedExtrinsic = #unchecked_extrinsic {
#(#modules_tokens)*
}
);
)
}
fn decl_outer_config<'a>(
runtime: &'a Ident,
module_declarations: impl Iterator<Item = &'a ModuleDeclaration>,
scrate: &'a TokenStream2,
) -> TokenStream2 {
let modules_tokens = module_declarations
.filter_map(|module_declaration| {
module_declaration.find_part("Config").map(|part| {
let transformed_generics: Vec<_> = part
.generics
.params
.iter()
.map(|param| quote!(<#param>))
.collect();
(module_declaration, transformed_generics)
})
})
.map(|(module_declaration, generics)| {
let module = &module_declaration.module;
let name = Ident::new(
&format!("{}Config", module_declaration.name),
module_declaration.name.span(),
);
let instance = module_declaration.instance.as_ref().into_iter();
quote!(
#name =>
#module #(#instance)* #(#generics)*,
)
});
quote!(
#scrate::sr_primitives::impl_outer_config! {
pub struct GenesisConfig for #runtime {
#(#modules_tokens)*
}
}
)
}
fn decl_runtime_metadata<'a>(
runtime: &'a Ident,
module_declarations: impl Iterator<Item = &'a ModuleDeclaration>,
scrate: &'a TokenStream2,
) -> TokenStream2 {
let modules_tokens = module_declarations
.filter_map(|module_declaration| {
module_declaration.find_part("Module").map(|_| {
let filtered_names: Vec<_> = module_declaration
.module_parts()
.into_iter()
.filter(|part| part.name != "Module")
.map(|part| part.name.clone())
.collect();
(module_declaration, filtered_names)
})
})
.map(|(module_declaration, filtered_names)| {
let module = &module_declaration.module;
let name = &module_declaration.name;
let instance = module_declaration
.instance
.as_ref()
.map(|name| quote!(<#name>))
.into_iter();
quote!(#module::Module #(#instance)* as #name with #(#filtered_names)* ,)
});
quote!(
#scrate::impl_runtime_metadata!{
for #runtime with modules
#(#modules_tokens)*
}
)
}
fn decl_outer_dispatch<'a>(
runtime: &'a Ident,
module_declarations: impl Iterator<Item = &'a ModuleDeclaration>,
scrate: &'a TokenStream2,
) -> TokenStream2 {
let modules_tokens = module_declarations
.filter(|module_declaration| module_declaration.exists_part("Call"))
.map(|module_declaration| {
let module = &module_declaration.module;
let name = &module_declaration.name;
quote!(#module::#name)
});
quote!(
#scrate::impl_outer_dispatch! {
pub enum Call for #runtime where origin: Origin {
#(#modules_tokens,)*
}
}
)
}
#[derive(Debug, PartialEq, Eq, Clone, Copy)]
enum DeclOuterKind {
Event,
Origin,
}
fn decl_outer_event_or_origin<'a>(
runtime_name: &'a Ident,
module_declarations: impl Iterator<Item = &'a ModuleDeclaration>,
system_name: &'a Ident,
scrate: &'a TokenStream2,
kind: DeclOuterKind,
) -> syn::Result<TokenStream2> {
let mut modules_tokens = TokenStream2::new();
let kind_str = format!("{:?}", kind);
for module_declaration in module_declarations {
match module_declaration.find_part(&kind_str) {
Some(module_entry) => {
let module = &module_declaration.module;
let instance = module_declaration.instance.as_ref();
let generics = &module_entry.generics;
if instance.is_some() && generics.params.len() == 0 {
let msg = format!(
"Instantiable module with no generic `{}` cannot \
be constructed: module `{}` must have generic `{}`",
kind_str, module_declaration.name, kind_str
);
return Err(syn::Error::new(module_declaration.name.span(), msg));
}
let tokens = quote!(#module #instance #generics ,);
modules_tokens.extend(tokens);
}
None => {}
}
}
let macro_call = match kind {
DeclOuterKind::Event => quote!(#scrate::impl_outer_event!),
DeclOuterKind::Origin => quote!(#scrate::impl_outer_origin!),
};
let enum_name = Ident::new(kind_str.as_str(), Span::call_site());
Ok(quote!(
#macro_call {
pub enum #enum_name for #runtime_name where system = #system_name {
#modules_tokens
}
}
))
}
fn decl_all_modules<'a>(
runtime: &'a Ident,
module_declarations: impl Iterator<Item = &'a ModuleDeclaration>,
) -> TokenStream2 {
let mut types = TokenStream2::new();
let mut names = Vec::new();
for module_declaration in module_declarations {
let type_name = &module_declaration.name;
let module = &module_declaration.module;
let mut generics = vec![quote!(#runtime)];
generics.extend(
module_declaration
.instance
.iter()
.map(|name| quote!(#module::#name)),
);
let type_decl = quote!(
pub type #type_name = #module::Module <#(#generics),*>;
);
types.extend(type_decl);
names.push(&module_declaration.name);
}
// Make nested tuple structure like (((Babe, Consensus), Grandpa), ...)
let all_modules = names.iter().fold(
TokenStream2::default(),
|combined, name| quote!((#name, #combined)),
);
quote!(
pub type System = system::Module<#runtime>;
#types
type AllModules = ( #all_modules );
)
}
fn find_system_module<'a>(
mut module_declarations: impl Iterator<Item = &'a ModuleDeclaration>,
) -> Option<&'a Ident> {
module_declarations
.find(|decl| decl.name == "System")
.map(|decl| &decl.module)
}
@@ -0,0 +1,401 @@
// Copyright 2019 Parity Technologies (UK) Ltd.
// This file is part of Substrate.
// Substrate is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// Substrate is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with Substrate. If not, see <http://www.gnu.org/licenses/>.
use frame_support_procedural_tools::syn_ext as ext;
use proc_macro2::Span;
use std::collections::HashSet;
use syn::{
parse::{Parse, ParseStream},
spanned::Spanned,
token, Error, Ident, Result, Token,
};
mod keyword {
syn::custom_keyword!(Block);
syn::custom_keyword!(NodeBlock);
syn::custom_keyword!(UncheckedExtrinsic);
}
#[derive(Debug)]
pub struct RuntimeDefinition {
pub visibility_token: Token![pub],
pub enum_token: Token![enum],
pub name: Ident,
pub where_section: WhereSection,
pub modules: ext::Braces<ext::Punctuated<ModuleDeclaration, Token![,]>>,
}
impl Parse for RuntimeDefinition {
fn parse(input: ParseStream) -> Result<Self> {
Ok(Self {
visibility_token: input.parse()?,
enum_token: input.parse()?,
name: input.parse()?,
where_section: input.parse()?,
modules: input.parse()?,
})
}
}
#[derive(Debug)]
pub struct WhereSection {
pub block: syn::TypePath,
pub node_block: syn::TypePath,
pub unchecked_extrinsic: syn::TypePath,
}
impl Parse for WhereSection {
fn parse(input: ParseStream) -> Result<Self> {
input.parse::<token::Where>()?;
let mut definitions = Vec::new();
while !input.peek(token::Brace) {
let definition: WhereDefinition = input.parse()?;
definitions.push(definition);
if !input.peek(Token![,]) {
if !input.peek(token::Brace) {
return Err(input.error("Expected `,` or `{`"));
}
break;
}
input.parse::<Token![,]>()?;
}
let block = remove_kind(input, WhereKind::Block, &mut definitions)?.value;
let node_block = remove_kind(input, WhereKind::NodeBlock, &mut definitions)?.value;
let unchecked_extrinsic =
remove_kind(input, WhereKind::UncheckedExtrinsic, &mut definitions)?.value;
if let Some(WhereDefinition {
ref kind_span,
ref kind,
..
}) = definitions.first()
{
let msg = format!(
"`{:?}` was declared above. Please use exactly one delcataion for `{:?}`.",
kind, kind
);
return Err(Error::new(*kind_span, msg));
}
Ok(Self {
block,
node_block,
unchecked_extrinsic,
})
}
}
#[derive(Debug, PartialEq, Eq, Clone, Copy, Hash)]
pub enum WhereKind {
Block,
NodeBlock,
UncheckedExtrinsic,
}
#[derive(Debug)]
pub struct WhereDefinition {
pub kind_span: Span,
pub kind: WhereKind,
pub value: syn::TypePath,
}
impl Parse for WhereDefinition {
fn parse(input: ParseStream) -> Result<Self> {
let lookahead = input.lookahead1();
let (kind_span, kind) = if lookahead.peek(keyword::Block) {
(input.parse::<keyword::Block>()?.span(), WhereKind::Block)
} else if lookahead.peek(keyword::NodeBlock) {
(
input.parse::<keyword::NodeBlock>()?.span(),
WhereKind::NodeBlock,
)
} else if lookahead.peek(keyword::UncheckedExtrinsic) {
(
input.parse::<keyword::UncheckedExtrinsic>()?.span(),
WhereKind::UncheckedExtrinsic,
)
} else {
return Err(lookahead.error());
};
Ok(Self {
kind_span,
kind,
value: {
let _: Token![=] = input.parse()?;
input.parse()?
},
})
}
}
#[derive(Debug)]
pub struct ModuleDeclaration {
pub name: Ident,
pub module: Ident,
pub instance: Option<Ident>,
pub details: Option<ext::Braces<ext::Punctuated<ModuleEntry, Token![,]>>>,
}
impl Parse for ModuleDeclaration {
fn parse(input: ParseStream) -> Result<Self> {
let name = input.parse()?;
let _: Token![:] = input.parse()?;
let module = input.parse()?;
let instance = if input.peek(Token![::]) && input.peek3(Token![<]) {
let _: Token![::] = input.parse()?;
let _: Token![<] = input.parse()?;
let res = Some(input.parse()?);
let _: Token![>] = input.parse()?;
res
} else {
None
};
let details = if input.peek(Token![::]) {
let _: Token![::] = input.parse()?;
Some(input.parse()?)
} else {
None
};
let parsed = Self {
name,
module,
instance,
details,
};
if let Some(ref details) = parsed.details {
let parts = &details.content.inner;
let mut resolved = HashSet::new();
let has_default = parts.into_iter().any(|m| m.is_default());
for entry in parts {
match entry {
ModuleEntry::Part(part) if has_default => {
if part.is_included_in_default() {
let msg = format!(
"`{}` is already included in `default`. Either remove `default` or remove `{}`",
part.name,
part.name
);
return Err(Error::new(part.name.span(), msg));
}
}
ModuleEntry::Part(part) => {
if !resolved.insert(part.name.clone()) {
let msg = format!(
"`{}` was already declared before. Please remove the duplicate declaration",
part.name
);
return Err(Error::new(part.name.span(), msg));
}
}
_ => {}
}
}
}
Ok(parsed)
}
}
impl ModuleDeclaration {
/// Get resolved module parts, i.e. after expanding `default` keyword
/// or empty declaration
pub fn module_parts(&self) -> Vec<ModulePart> {
if let Some(ref details) = self.details {
details
.content
.inner
.iter()
.flat_map(|entry| match entry {
ModuleEntry::Default(ref token) => Self::default_modules(token.span()),
ModuleEntry::Part(ref part) => vec![part.clone()],
})
.collect()
} else {
Self::default_modules(self.module.span())
}
}
pub fn find_part(&self, name: &str) -> Option<ModulePart> {
self.module_parts()
.into_iter()
.find(|part| part.name == name)
}
pub fn exists_part(&self, name: &str) -> bool {
self.find_part(name).is_some()
}
fn default_modules(span: Span) -> Vec<ModulePart> {
let mut res: Vec<_> = ["Module", "Call", "Storage"]
.into_iter()
.map(|name| ModulePart::with_name(name, span))
.collect();
res.extend(
["Event", "Config"]
.into_iter()
.map(|name| ModulePart::with_generics(name, span)),
);
res
}
}
#[derive(Debug)]
pub enum ModuleEntry {
Default(Token![default]),
Part(ModulePart),
}
impl Parse for ModuleEntry {
fn parse(input: ParseStream) -> Result<Self> {
let lookahead = input.lookahead1();
if lookahead.peek(Token![default]) {
Ok(ModuleEntry::Default(input.parse()?))
} else if lookahead.peek(Ident) {
Ok(ModuleEntry::Part(input.parse()?))
} else {
Err(lookahead.error())
}
}
}
impl ModuleEntry {
pub fn is_default(&self) -> bool {
match self {
ModuleEntry::Default(_) => true,
_ => false,
}
}
}
#[derive(Debug, Clone)]
pub struct ModulePart {
pub name: Ident,
pub generics: syn::Generics,
pub args: Option<ext::Parens<ext::Punctuated<Ident, Token![,]>>>,
}
impl Parse for ModulePart {
fn parse(input: ParseStream) -> Result<Self> {
let name = input.parse()?;
let generics: syn::Generics = input.parse()?;
if !generics.params.is_empty() && !Self::is_allowed_generic(&name) {
let valid_generics = ModulePart::format_names(ModulePart::allowed_generics());
let msg = format!(
"`{}` is not allowed to have generics. \
Only the following modules are allowed to have generics: {}.",
name, valid_generics
);
return Err(syn::Error::new(name.span(), msg));
}
let args = if input.peek(token::Paren) {
if !Self::is_allowed_arg(&name) {
let syn::group::Parens { token: parens, .. } = syn::group::parse_parens(input)?;
let valid_names = ModulePart::format_names(ModulePart::allowed_args());
let msg = format!(
"`{}` is not allowed to have arguments in parens. \
Only the following modules are allowed to have arguments in parens: {}.",
name, valid_names
);
return Err(syn::Error::new(parens.span, msg));
}
Some(input.parse()?)
} else {
None
};
Ok(Self {
name,
generics,
args,
})
}
}
impl ModulePart {
pub fn is_allowed_generic(ident: &Ident) -> bool {
Self::allowed_generics().into_iter().any(|n| ident == n)
}
pub fn is_allowed_arg(ident: &Ident) -> bool {
Self::allowed_args().into_iter().any(|n| ident == n)
}
pub fn allowed_generics() -> Vec<&'static str> {
vec!["Event", "Origin", "Config"]
}
pub fn allowed_args() -> Vec<&'static str> {
vec!["Inherent"]
}
pub fn format_names(names: Vec<&'static str>) -> String {
let res: Vec<_> = names.into_iter().map(|s| format!("`{}`", s)).collect();
res.join(", ")
}
pub fn is_included_in_default(&self) -> bool {
["Module", "Call", "Storage", "Event", "Config"]
.into_iter()
.any(|name| self.name == name)
}
/// Plain module name like `Event` or `Call`, etc.
pub fn with_name(name: &str, span: Span) -> Self {
let name = Ident::new(name, span);
Self {
name,
generics: syn::Generics {
lt_token: None,
gt_token: None,
where_clause: None,
..Default::default()
},
args: None,
}
}
/// Module name with generic like `Event<T>` or `Call<T>`, etc.
pub fn with_generics(name: &str, span: Span) -> Self {
let name = Ident::new(name, span);
let typ = Ident::new("T", span);
let generic_param = syn::GenericParam::Type(typ.into());
let generic_params = vec![generic_param].into_iter().collect();
let generics = syn::Generics {
lt_token: Some(syn::token::Lt { spans: [span] }),
params: generic_params,
gt_token: Some(syn::token::Gt { spans: [span] }),
where_clause: None,
};
Self {
name,
generics,
args: None,
}
}
}
fn remove_kind(
input: ParseStream,
kind: WhereKind,
definitions: &mut Vec<WhereDefinition>,
) -> Result<WhereDefinition> {
if let Some(pos) = definitions.iter().position(|d| d.kind == kind) {
Ok(definitions.remove(pos))
} else {
let msg = format!(
"Missing associated type for `{:?}`. Add `{:?}` = ... to where section.",
kind, kind
);
Err(input.error(msg))
}
}