ink_codegen/
lib.rs

1// Copyright (C) Use Ink (UK) Ltd.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15//! The ink! code generation.
16//!
17//! This module defines everything the ink! procedural macro needs in order to
18//! generate Rust code for ink! smart contracts.
19//!
20//! We avoid structuring things via hidden or private modules, this
21//! was the ink! v1 way of doing code generation and it was bug prone
22//! and hard to maintain.
23//!
24//! What we do instead to generate code that is hidden from users is to
25//! pack it into anonymous `const` (so `const _: () = { … };`) and connect
26//! those to the outside world with private trait implementations.
27//!
28//! You can see how the generated code looks by installing
29//! [`cargo-expand`](https://github.com/dtolnay/cargo-expand)
30//! and executing `cargo expand --manifest-path ./integration-tests/flipper/Cargo.toml` in
31//! this repository.
32
33#![doc(
34    html_logo_url = "https://use.ink/img/crate-docs/logo.png",
35    html_favicon_url = "https://use.ink/crate-docs/favicon.png"
36)]
37
38pub use ink_primitives::reflect;
39mod enforced_error;
40mod generator;
41mod traits;
42
43pub use generator::generate_type_spec;
44
45use self::{
46    enforced_error::EnforcedErrors,
47    traits::{
48        GenerateCode,
49        GenerateCodeUsing,
50    },
51};
52use proc_macro2::TokenStream as TokenStream2;
53
54/// Types for which code can be generated by this crate.
55pub trait CodeGenerator: Sized {
56    /// The underlying generator generating the code.
57    type Generator: From<Self> + GenerateCode;
58}
59
60impl<'a> CodeGenerator for &'a ir::Contract {
61    type Generator = generator::Contract<'a>;
62}
63
64impl<'a> CodeGenerator for &'a ir::Event {
65    type Generator = generator::Event<'a>;
66}
67
68impl<'a> CodeGenerator for &'a ir::StorageItem {
69    type Generator = generator::StorageItem<'a>;
70}
71
72impl<'a> CodeGenerator for &'a ir::InkTraitDefinition {
73    type Generator = generator::TraitDefinition<'a>;
74}
75
76impl<'a> CodeGenerator for &'a ir::InkTest {
77    type Generator = generator::InkTest<'a>;
78}
79
80impl<'a> CodeGenerator for &'a ir::ChainExtension {
81    type Generator = generator::ChainExtension<'a>;
82}
83
84impl<'a> CodeGenerator for &'a ir::SelectorMacro<ir::marker::SelectorId> {
85    type Generator = generator::SelectorId<'a>;
86}
87
88impl<'a> CodeGenerator for &'a ir::SelectorMacro<ir::marker::SelectorBytes> {
89    type Generator = generator::SelectorBytes<'a>;
90}
91
92impl<'a> CodeGenerator for &'a ir::Blake2x256Macro {
93    type Generator = generator::Blake2x256<'a>;
94}
95
96/// Generates the entire code for the given ink! contract.
97pub fn generate_code<T>(entity: T) -> TokenStream2
98where
99    T: CodeGenerator,
100{
101    <T as CodeGenerator>::Generator::from(entity).generate_code()
102}
ink_codegen/lib.rs

ink_codegen/
lib.rs
