ink_codegen 5.1.1

// Copyright (C) Use Ink (UK) Ltd.
//
// 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.

//! The ink! code generation.
//!
//! This module defines everything the ink! procedural macro needs in order to
//! generate Rust code for ink! smart contracts.
//!
//! We avoid structuring things via hidden or private modules, this
//! was the ink! v1 way of doing code generation and it was bug prone
//! and hard to maintain.
//!
//! What we do instead to generate code that is hidden from users is to
//! pack it into anonymous `const` (so `const _: () = { … };`) and connect
//! those to the outside world with private trait implementations.
//!
//! You can see how the generated code looks by installing
//! [`cargo-expand`](https://github.com/dtolnay/cargo-expand)
//! and executing `cargo expand --manifest-path ./integration-tests/flipper/Cargo.toml` in
//! this repository.

#![doc(
    html_logo_url = "https://use.ink/img/crate-docs/logo.png",
    html_favicon_url = "https://use.ink/crate-docs/favicon.png"
)]

mod enforced_error;
mod generator;
mod traits;

pub use generator::generate_type_spec;

use self::{
    enforced_error::EnforcedErrors,
    traits::{
        GenerateCode,
        GenerateCodeUsing,
    },
};
use proc_macro2::TokenStream as TokenStream2;

/// Types for which code can be generated by this crate.
pub trait CodeGenerator: Sized {
    /// The underlying generator generating the code.
    type Generator: From<Self> + GenerateCode;
}

impl<'a> CodeGenerator for &'a ir::Contract {
    type Generator = generator::Contract<'a>;
}

impl<'a> CodeGenerator for &'a ir::Event {
    type Generator = generator::Event<'a>;
}

impl<'a> CodeGenerator for &'a ir::StorageItem {
    type Generator = generator::StorageItem<'a>;
}

impl<'a> CodeGenerator for &'a ir::InkTraitDefinition {
    type Generator = generator::TraitDefinition<'a>;
}

impl<'a> CodeGenerator for &'a ir::InkTest {
    type Generator = generator::InkTest<'a>;
}

impl<'a> CodeGenerator for &'a ir::ChainExtension {
    type Generator = generator::ChainExtension<'a>;
}

impl<'a> CodeGenerator for &'a ir::SelectorMacro<ir::marker::SelectorId> {
    type Generator = generator::SelectorId<'a>;
}

impl<'a> CodeGenerator for &'a ir::SelectorMacro<ir::marker::SelectorBytes> {
    type Generator = generator::SelectorBytes<'a>;
}

impl<'a> CodeGenerator for &'a ir::Blake2x256Macro {
    type Generator = generator::Blake2x256<'a>;
}

/// Generates the entire code for the given ink! contract.
pub fn generate_code<T>(entity: T) -> TokenStream2
where
    T: CodeGenerator,
{
    <T as CodeGenerator>::Generator::from(entity).generate_code()
}