mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-07-02 03:37:25 +00:00
Bastian Köcher
8e393aa5a8
* Make `decl_error!` errors usable This pr implements support for returning errors of different pallets in a pallet. These errors need to be declared with `decl_error!`. The pr changes the following: - Each dispatchable function now returns a `DispatchResult` which is an alias for `Result<(), DispatchError>`. - `DispatchError` is an enum that has 4 variants: - `Other`: For storing string error messages - `CannotLookup`: Variant that is returned when something returns a `sp_runtime::LookupError` - `BadOrigin`: Variant that is returned for any kind of bad origin - `Module`: The error of a specific module. Contains the `index`, `error` and the `message`. The index is the index of the module in `construct_runtime!`. `error` is the index of the error in the error enum declared by `decl_error!`. `message` is the message to the error variant (this will not be encoded). - `construct_runtime!` now creates a new struct `ModuleToIndex`. This struct implements the trait `ModuleToIndex`. - `frame_system::Trait` has a new associated type: `ModuleToIndex` that expects the `ModuleToIndex` generated by `construct_runtime!`. - All error strings returned in any module are being converted now to `DispatchError`. - `BadOrigin` is the default error returned by any type that implements `EnsureOrigin`. * Fix frame system benchmarks
92 lines
2.7 KiB
Rust
92 lines
2.7 KiB
Rust
// Copyright 2017-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/>.
|
|
|
|
// tag::description[]
|
|
//! Proc macro helpers for procedural macros
|
|
// end::description[]
|
|
|
|
// reexport proc macros
|
|
pub use frame_support_procedural_tools_derive::*;
|
|
|
|
use proc_macro_crate::crate_name;
|
|
use syn::parse::Error;
|
|
use quote::quote;
|
|
|
|
pub mod syn_ext;
|
|
|
|
// FIXME #1569, remove the following functions, which are copied from sp-api-macros
|
|
use proc_macro2::{TokenStream, Span};
|
|
use syn::Ident;
|
|
|
|
fn generate_hidden_includes_mod_name(unique_id: &str) -> Ident {
|
|
Ident::new(&format!("sp_api_hidden_includes_{}", unique_id), Span::call_site())
|
|
}
|
|
|
|
/// Generates the access to the `frame-support` crate.
|
|
pub fn generate_crate_access(unique_id: &str, def_crate: &str) -> TokenStream {
|
|
if std::env::var("CARGO_PKG_NAME").unwrap() == def_crate {
|
|
quote::quote!( frame_support )
|
|
} else {
|
|
let mod_name = generate_hidden_includes_mod_name(unique_id);
|
|
quote::quote!( self::#mod_name::hidden_include )
|
|
}
|
|
}
|
|
|
|
/// Generates the hidden includes that are required to make the macro independent from its scope.
|
|
pub fn generate_hidden_includes(unique_id: &str, def_crate: &str) -> TokenStream {
|
|
if std::env::var("CARGO_PKG_NAME").unwrap() == def_crate {
|
|
TokenStream::new()
|
|
} else {
|
|
let mod_name = generate_hidden_includes_mod_name(unique_id);
|
|
|
|
match crate_name(def_crate) {
|
|
Ok(name) => {
|
|
let name = Ident::new(&name, Span::call_site());
|
|
quote::quote!(
|
|
#[doc(hidden)]
|
|
mod #mod_name {
|
|
pub extern crate #name as hidden_include;
|
|
}
|
|
)
|
|
},
|
|
Err(e) => {
|
|
let err = Error::new(Span::call_site(), &e).to_compile_error();
|
|
quote!( #err )
|
|
}
|
|
}
|
|
|
|
}
|
|
}
|
|
|
|
// fn to remove white spaces around string types
|
|
// (basically whitespaces around tokens)
|
|
pub fn clean_type_string(input: &str) -> String {
|
|
input
|
|
.replace(" ::", "::")
|
|
.replace(":: ", "::")
|
|
.replace(" ,", ",")
|
|
.replace(" ;", ";")
|
|
.replace(" [", "[")
|
|
.replace("[ ", "[")
|
|
.replace(" ]", "]")
|
|
.replace(" (", "(")
|
|
.replace("( ", "(")
|
|
.replace(" )", ")")
|
|
.replace(" <", "<")
|
|
.replace("< ", "<")
|
|
.replace(" >", ">")
|
|
}
|