leo-errors 4.0.1

// 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/>.

use std::fmt::{Debug, Display};

create_messages!(
    CheckInterfacesError,
    code_mask: 12000i32,
    code_prefix: "CHI",

    @formatted
    interface_not_found {
        args: (name: impl Display),
        msg: format!("Interface `{name}` not found."),
        help: Some("Make sure the interface is defined in the current program or an imported program.".to_string()),
    }

    @formatted
    conflicting_interface_member {
        args: (member_name: impl Display, interface_name: impl Display, parent_name: impl Display),
        msg: format!(
            "Interface `{interface_name}` has a conflicting definition for `{member_name}` inherited from `{parent_name}`. \
             Members with the same name must have identical signatures."
        ),
        help: Some("Ensure both interfaces define the same signature for this member, or rename one of them.".to_string()),
    }

    @formatted
    missing_interface_function {
        args: (func_name: impl Display, interface_name: impl Display, program_name: impl Display),
        msg: format!(
            "Program `{program_name}` implements interface `{interface_name}` but is missing the required function `{func_name}`."
        ),
        help: Some("Add the missing function with the exact signature specified in the interface.".to_string()),
    }

    @formatted
    missing_interface_record {
        args: (record_name: impl Display, interface_name: impl Display, program_name: impl Display),
        msg: format!(
            "Program `{program_name}` implements interface `{interface_name}` but is missing the required record `{record_name}`."
        ),
        help: Some("Add a record definition with the specified name.".to_string()),
    }

    @formatted
    signature_mismatch {
        args: (func_name: impl Display, interface_name: impl Display, expected: impl Display, found: impl Display),
        msg: format!(
            "Function `{func_name}` does not match the signature required by interface `{interface_name}`.\n\
             Expected:\n\
             {expected}\n\
             Found:\n\
             {found}"
        ),
        help: Some("Function signatures must match exactly: same parameter names, types, modes, order, and return type.".to_string()),
    }

    @formatted
    not_an_interface {
        args: (name: impl Display),
        msg: format!("`{name}` is not an interface."),
        help: Some("Only interface declarations can be inherited from.".to_string()),
    }

    @formatted
    missing_interface_mapping {
        args: (mapping_name: impl Display, interface_name: impl Display, program_name: impl Display),
        msg: format!(
            "Program `{program_name}` implements interface `{interface_name}` but is missing the required mapping `{mapping_name}`."
        ),
        help: Some("Add a mapping definition with the specified name.".to_string()),
    }

    @formatted
    missing_interface_storage {
        args: (storage_name: impl Display, interface_name: impl Display, program_name: impl Display),
        msg: format!(
            "Program `{program_name}` implements interface `{interface_name}` but is missing the required storage variable `{storage_name}`."
        ),
        help: Some("Add a storage variable definition with the specified name.".to_string()),
    }

    @formatted
    mapping_type_mismatch {
        args: (mapping_name: impl Display, interface_name: impl Display, expected_key: impl Display, expected_value: impl Display, found_key: impl Display, found_value: impl Display),
        msg: format!(
            "Mapping `{mapping_name}` does not match the type required by interface `{interface_name}`.\n\
             Expected: {expected_key} => {expected_value}\n\
             Found: {found_key} => {found_value}"
        ),
        help: Some("Mapping key and value types must match exactly.".to_string()),
    }

    @formatted
    storage_type_mismatch {
        args: (storage_name: impl Display, interface_name: impl Display, expected: impl Display, found: impl Display),
        msg: format!(
            "Storage variable `{storage_name}` does not match the type required by interface `{interface_name}`.\n\
             Expected: {expected}\n\
             Found: {found}"
        ),
        help: Some("Storage variable types must match exactly.".to_string()),
    }

    @backtraced
    cyclic_interface_inheritance {
        args: (path: impl Display),
        msg: format!("Cyclic interface inheritance detected: {path}"),
        help: Some("Interface inheritance must be acyclic. Remove the circular dependency.".to_string()),
    }

    @formatted
    conflicting_record_field {
        args: (field_name: impl Display, record_name: impl Display, interface_name: impl Display, parent_name: impl Display),
        msg: format!(
            "Record `{record_name}` has a conflicting definition for field `{field_name}` in interface `{interface_name}` \
             inherited from `{parent_name}`. Fields with the same name must have identical types and modes."
        ),
        help: Some("Ensure both interfaces define the same type and mode for this field, or rename one of them.".to_string()),
    }

    @formatted
    record_field_missing {
        args: (field_name: impl Display, record_name: impl Display, interface_name: impl Display, program_name: impl Display),
        msg: format!(
            "Record `{record_name}` in program `{program_name}` is missing required field `{field_name}` \
             specified by interface `{interface_name}`."
        ),
        help: Some("Add the missing field with the exact type and mode specified in the interface.".to_string()),
    }

    @formatted
    record_field_type_mismatch {
        args: (field_name: impl Display, record_name: impl Display, interface_name: impl Display,
               expected: impl Display, found: impl Display),
        msg: format!(
            "Field `{field_name}` in record `{record_name}` does not match the type required by interface `{interface_name}`.\n\
             Expected: {expected}\n\
             Found: {found}"
        ),
        help: Some("Field types and modes must match exactly.".to_string()),
    }

    @formatted
    record_prototype_owner_wrong_type {
        args: (record_name: impl Display, found_type: impl Display),
        msg: format!(
            "Field `owner` in record prototype `{record_name}` must have type `address`, found `{found_type}`. \
             The `owner` field of a record is always `address`."
        ),
        help: None,
    }
);