zerodds-idl-cpp 1.0.0-rc.3.1

OMG IDL4 → C++17 code generator (idl4-cpp-1.0 + DDS-PSM-Cxx + DDS-RPC C++ PSM) for ZeroDDS.
Documentation
// SPDX-License-Identifier: Apache-2.0
// Copyright 2026 ZeroDDS Contributors
//! Error types for the IDL→C++ codegen.

use core::fmt;

/// Top-level error of the C++ code generator.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum CppGenError {
    /// The IDL construct is not supported in the current foundation
    /// scope (C5.1-a). `construct` is a short label (e.g.
    /// `"interface"`, `"valuetype"`, `"fixed"`, `"any"`, `"map"`).
    UnsupportedConstruct {
        /// Name of the unsupported construct.
        construct: String,
        /// Optional: identifier name (type name or member name).
        context: Option<String>,
    },
    /// Identifier collides with a reserved C++ keyword
    /// (§7.4.5 implementation mapping requires collision avoidance).
    InvalidName {
        /// The invalid identifier.
        name: String,
        /// Reason for the rejection (e.g. `"reserved C++ keyword"`).
        reason: String,
    },
    /// Inheritance cycle in the struct graph (self-reference or
    /// indirect loop). Detected before emission.
    InheritanceCycle {
        /// Type name involved in the cycle.
        type_name: String,
    },
    /// The generated output is internally inconsistent (should not
    /// happen — bug indicator).
    Internal(String),
}

impl fmt::Display for CppGenError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::UnsupportedConstruct { construct, context } => match context {
                Some(ctx) => write!(
                    f,
                    "unsupported IDL construct '{construct}' in '{ctx}' (C5.1-a Foundation scope)",
                ),
                None => write!(
                    f,
                    "unsupported IDL construct '{construct}' (C5.1-a Foundation scope)",
                ),
            },
            Self::InvalidName { name, reason } => {
                write!(f, "invalid identifier '{name}': {reason}")
            }
            Self::InheritanceCycle { type_name } => {
                write!(f, "inheritance cycle detected at type '{type_name}'")
            }
            Self::Internal(msg) => write!(f, "internal codegen error: {msg}"),
        }
    }
}

impl std::error::Error for CppGenError {}

#[cfg(test)]
mod tests {
    #![allow(clippy::expect_used, clippy::panic)]
    use super::*;

    #[test]
    fn unsupported_display_has_context() {
        let e = CppGenError::UnsupportedConstruct {
            construct: "interface".into(),
            context: Some("Foo".into()),
        };
        let s = format!("{e}");
        assert!(s.contains("interface"));
        assert!(s.contains("Foo"));
    }

    #[test]
    fn unsupported_display_without_context() {
        let e = CppGenError::UnsupportedConstruct {
            construct: "any".into(),
            context: None,
        };
        let s = format!("{e}");
        assert!(s.contains("any"));
    }

    #[test]
    fn invalid_name_display() {
        let e = CppGenError::InvalidName {
            name: "class".into(),
            reason: "reserved C++ keyword".into(),
        };
        assert!(format!("{e}").contains("reserved"));
    }

    #[test]
    fn inheritance_cycle_display() {
        let e = CppGenError::InheritanceCycle {
            type_name: "Loop".into(),
        };
        assert!(format!("{e}").contains("Loop"));
    }

    #[test]
    fn internal_display() {
        let e = CppGenError::Internal("oops".into());
        assert!(format!("{e}").contains("oops"));
    }
}