leo-ast 4.4.0

// Copyright (C) 2019-2026 Provable Inc.
// This file is part of the Leo library.

// The Leo library 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.

// The Leo library 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 the Leo library. If not, see <https://www.gnu.org/licenses/>.

pub mod member;
pub use member::*;

use crate::{ConstParameter, Identifier, Indent, Mode, Node, NodeID, ProgramId, TypeKind, TypeNode};
use leo_span::{Span, Symbol};

use itertools::Itertools;
use serde::Serialize;
use std::fmt;

use snarkvm::{
    console::program::{RecordType, StructType},
    prelude::{
        EntryType::{Constant, Private, Public},
        Network,
    },
};

/// A composite type definition, e.g., `struct Foo { my_field: Bar }` and `record Token { owner: address, amount: u64}`.
///
/// Type identity is decided by the full path including `identifier`,
/// as the record is nominal, not structural.
/// The fields are named so `struct Foo(u8, u16)` is not allowed.
#[derive(Clone, Debug, Serialize)]
pub struct Composite {
    /// Whether the `export` keyword was written on this composite. `None` when the
    /// concept doesn't apply (records, program-block composites, and structs
    /// imported from another unit, all always reachable).
    pub is_exported: Option<bool>,
    /// The name of the type in the type system in this module.
    pub identifier: Identifier,
    /// The composite's const parameters.
    pub const_parameters: Vec<ConstParameter>,
    /// The fields, constant variables, and functions of this composite.
    pub members: Vec<Member>,
    /// Was this a `record Foo { ... }`?
    /// If so, it wasn't a composite.
    pub is_record: bool,
    /// The entire span of the composite definition.
    pub span: Span,
    /// The ID of the node.
    pub id: NodeID,
}

impl PartialEq for Composite {
    fn eq(&self, other: &Self) -> bool {
        self.identifier == other.identifier
    }
}

impl Eq for Composite {}

impl Composite {
    /// Returns the composite name as a Symbol.
    pub fn name(&self) -> Symbol {
        self.identifier.name
    }

    // No interner in scope at disassembly time; stub types get their canonical handle when
    // the frontend re-interns them during stub merge.
    pub fn from_external_record<N: Network>(input: &RecordType<N>, program_id: ProgramId) -> Self {
        let mut members = Vec::with_capacity(input.entries().len() + 1);
        members.push(Member {
            mode: if input.owner().is_public() { Mode::Public } else { Mode::Private },
            identifier: Identifier::new(Symbol::intern("owner"), Default::default()),
            type_: TypeNode::unchecked(TypeKind::Address, Span::default()),
            span: Default::default(),
            id: Default::default(),
        });
        members.extend(input.entries().iter().map(|(id, entry)| {
            let (mode, type_) = match entry {
                Public(type_) => (Mode::Public, type_),
                Private(type_) => (Mode::Private, type_),
                Constant(type_) => (Mode::Constant, type_),
            };
            Member {
                mode,
                identifier: Identifier::from(id),
                type_: TypeNode::unchecked(TypeKind::from_snarkvm(type_, program_id), Span::default()),
                span: Default::default(),
                id: Default::default(),
            }
        }));
        Self {
            is_exported: None,
            identifier: Identifier::from(input.name()),
            const_parameters: Vec::new(),
            members,
            is_record: true,
            span: Default::default(),
            id: Default::default(),
        }
    }

    // See `from_external_record` for the `unchecked` rationale.
    pub fn from_snarkvm<N: Network>(input: &StructType<N>, program: ProgramId) -> Self {
        Self {
            is_exported: None,
            identifier: Identifier::from(input.name()),
            const_parameters: Vec::new(),
            members: input
                .members()
                .iter()
                .map(|(id, type_)| Member {
                    mode: Mode::None,
                    identifier: Identifier::from(id),
                    type_: TypeNode::unchecked(TypeKind::from_snarkvm(type_, program), Span::default()),
                    span: Default::default(),
                    id: Default::default(),
                })
                .collect(),
            is_record: false,
            span: Default::default(),
            id: Default::default(),
        }
    }
}

impl fmt::Display for Composite {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        if self.is_exported == Some(true) {
            f.write_str("export ")?;
        }
        f.write_str(if self.is_record { "record" } else { "struct" })?;
        write!(f, " {}", self.identifier)?;
        if !self.const_parameters.is_empty() {
            write!(f, "::[{}]", self.const_parameters.iter().format(", "))?;
        }
        writeln!(f, " {{")?;

        for field in self.members.iter() {
            writeln!(f, "{},", Indent(field))?;
        }
        write!(f, "}}")
    }
}

crate::simple_node_impl!(Composite);