referrerpolicy=no-referrer-when-downgrade

frame_support_procedural/pallet/parse/
hooks.rs

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
// 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 super::helper;
use syn::spanned::Spanned;

/// Implementation of the pallet hooks.
pub struct HooksDef {
	/// A set of usage of instance, must be check for consistency with trait.
	pub instances: Vec<helper::InstanceUsage>,
	/// The where_clause used.
	pub where_clause: Option<syn::WhereClause>,
	/// The span of the pallet::hooks attribute.
	pub attr_span: proc_macro2::Span,
	/// Boolean flag, set to true if the `on_runtime_upgrade` method of hooks was implemented.
	pub has_runtime_upgrade: bool,
}

impl HooksDef {
	pub fn try_from(attr_span: proc_macro2::Span, item: &mut syn::Item) -> syn::Result<Self> {
		let item = if let syn::Item::Impl(item) = item {
			item
		} else {
			let msg = "Invalid pallet::hooks, expected item impl";
			return Err(syn::Error::new(item.span(), msg))
		};

		let instances = vec![
			helper::check_pallet_struct_usage(&item.self_ty)?,
			helper::check_impl_gen(&item.generics, item.impl_token.span())?,
		];

		let item_trait = &item
			.trait_
			.as_ref()
			.ok_or_else(|| {
				let msg = "Invalid pallet::hooks, expected impl<..> Hooks \
					for Pallet<..>";
				syn::Error::new(item.span(), msg)
			})?
			.1;

		if item_trait.segments.len() != 1 || item_trait.segments[0].ident != "Hooks" {
			let msg = format!(
				"Invalid pallet::hooks, expected trait to be `Hooks` found `{}`\
				, you can import from `frame_support::pallet_prelude`",
				quote::quote!(#item_trait)
			);

			return Err(syn::Error::new(item_trait.span(), msg))
		}

		let has_runtime_upgrade = item.items.iter().any(|i| match i {
			syn::ImplItem::Fn(method) => method.sig.ident == "on_runtime_upgrade",
			_ => false,
		});

		Ok(Self {
			attr_span,
			instances,
			has_runtime_upgrade,
			where_clause: item.generics.where_clause.clone(),
		})
	}
}