Skip to main content

alef_codegen/conversions/
mod.rs

1mod binding_to_core;
2mod core_to_binding;
3mod enums;
4pub(crate) mod helpers;
5
6use ahash::AHashSet;
7
8/// Backend-specific configuration for From/field conversion generation.
9/// Enables shared code to handle all backend differences via parameters.
10#[derive(Default, Clone)]
11pub struct ConversionConfig<'a> {
12    /// Prefix for binding type names ("Js" for NAPI/WASM, "" for others).
13    pub type_name_prefix: &'a str,
14    /// U64/Usize/Isize need `as i64` casts (NAPI, PHP — JS/PHP lack native u64).
15    pub cast_large_ints_to_i64: bool,
16    /// Enum names mapped to String in the binding layer (PHP only).
17    /// Named fields referencing these use `format!("{:?}")` in core→binding.
18    pub enum_string_names: Option<&'a AHashSet<String>>,
19    /// Map types use JsValue in the binding layer (WASM only).
20    /// When true, Map fields use `serde_wasm_bindgen` for conversion instead of
21    /// iterator-based collect patterns (JsValue is not iterable).
22    pub map_uses_jsvalue: bool,
23    /// When true, f32 is mapped to f64 (NAPI only — JS has no f32).
24    pub cast_f32_to_f64: bool,
25    /// When true, non-optional fields on defaultable types are wrapped in Option<T>
26    /// in the binding struct and need `.unwrap_or_default()` in binding→core From.
27    /// Used by NAPI to make JS-facing structs fully optional.
28    pub optionalize_defaults: bool,
29    /// When true, Json (serde_json::Value) fields are mapped to String in the binding layer.
30    /// Core→binding uses `.to_string()`, binding→core uses `Default::default()` (lossy).
31    /// Used by PHP where serde_json::Value can't cross the extension boundary.
32    pub json_to_string: bool,
33    /// When true, add synthetic metadata field conversion for ConversionResult.
34    /// Only NAPI backend sets this (it adds metadata field to the struct).
35    pub include_cfg_metadata: bool,
36    /// When true, non-optional Duration fields on `has_default` types are stored as
37    /// `Option<u64>` in the binding struct.  The From conversion uses the builder
38    /// pattern so that `None` falls back to the core type's `Default` implementation
39    /// (giving the real default, e.g. `Duration::from_secs(30)`) instead of `Duration::ZERO`.
40    /// Used by PyO3 to prevent validation failures when `request_timeout` is unset.
41    pub option_duration_on_defaults: bool,
42    /// When true, binding enums include data variant fields (Magnus).
43    /// When false (default), binding enums are unit-only and data is lost in conversion.
44    pub binding_enums_have_data: bool,
45    /// Type names excluded from the binding layer. Fields referencing these types
46    /// are skipped in the binding struct and defaulted in From conversions.
47    /// Used by WASM to handle types excluded due to native dependency requirements.
48    pub exclude_types: &'a [String],
49    /// When true, Vec<Named> fields are stored as JSON strings in the binding layer.
50    /// Core→binding uses `serde_json::to_string`, binding→core uses `serde_json::from_str`.
51    /// Used by Magnus (Ruby) where Vec<Named> cannot cross the FFI boundary directly and
52    /// is collapsed to String by `field_type_for_serde`'s catch-all arm.
53    pub vec_named_to_string: bool,
54}
55
56// Re-export all public items so callers continue to use `conversions::foo`.
57pub use binding_to_core::{
58    field_conversion_to_core, field_conversion_to_core_cfg, gen_from_binding_to_core, gen_from_binding_to_core_cfg,
59};
60pub use core_to_binding::{
61    field_conversion_from_core, field_conversion_from_core_cfg, gen_from_core_to_binding, gen_from_core_to_binding_cfg,
62};
63pub use enums::{
64    gen_enum_from_binding_to_core, gen_enum_from_binding_to_core_cfg, gen_enum_from_core_to_binding,
65    gen_enum_from_core_to_binding_cfg,
66};
67pub use helpers::{
68    binding_to_core_match_arm, build_type_path_map, can_generate_conversion, can_generate_enum_conversion,
69    can_generate_enum_conversion_from_core, convertible_types, core_enum_path, core_to_binding_convertible_types,
70    core_to_binding_match_arm, core_type_path, field_references_excluded_type, has_sanitized_fields, input_type_names,
71    is_tuple_variant, resolve_named_path,
72};
73
74#[cfg(test)]
75mod tests {
76    use super::*;
77    use alef_core::ir::*;
78
79    fn simple_type() -> TypeDef {
80        TypeDef {
81            name: "Config".to_string(),
82            rust_path: "my_crate::Config".to_string(),
83            fields: vec![
84                FieldDef {
85                    name: "name".into(),
86                    ty: TypeRef::String,
87                    optional: false,
88                    default: None,
89                    doc: String::new(),
90                    sanitized: false,
91                    is_boxed: false,
92                    type_rust_path: None,
93                    cfg: None,
94                    typed_default: None,
95                    core_wrapper: CoreWrapper::None,
96                    vec_inner_core_wrapper: CoreWrapper::None,
97                    newtype_wrapper: None,
98                },
99                FieldDef {
100                    name: "timeout".into(),
101                    ty: TypeRef::Primitive(PrimitiveType::U64),
102                    optional: true,
103                    default: None,
104                    doc: String::new(),
105                    sanitized: false,
106                    is_boxed: false,
107                    type_rust_path: None,
108                    cfg: None,
109                    typed_default: None,
110                    core_wrapper: CoreWrapper::None,
111                    vec_inner_core_wrapper: CoreWrapper::None,
112                    newtype_wrapper: None,
113                },
114                FieldDef {
115                    name: "backend".into(),
116                    ty: TypeRef::Named("Backend".into()),
117                    optional: true,
118                    default: None,
119                    doc: String::new(),
120                    sanitized: false,
121                    is_boxed: false,
122                    type_rust_path: None,
123                    cfg: None,
124                    typed_default: None,
125                    core_wrapper: CoreWrapper::None,
126                    vec_inner_core_wrapper: CoreWrapper::None,
127                    newtype_wrapper: None,
128                },
129            ],
130            methods: vec![],
131            is_opaque: false,
132            is_clone: true,
133            is_trait: false,
134            has_default: false,
135            has_stripped_cfg_fields: false,
136            is_return_type: false,
137            serde_rename_all: None,
138            has_serde: false,
139            super_traits: vec![],
140            doc: String::new(),
141            cfg: None,
142        }
143    }
144
145    fn simple_enum() -> EnumDef {
146        EnumDef {
147            name: "Backend".to_string(),
148            rust_path: "my_crate::Backend".to_string(),
149            variants: vec![
150                EnumVariant {
151                    name: "Cpu".into(),
152                    fields: vec![],
153                    doc: String::new(),
154                    is_default: false,
155                    serde_rename: None,
156                },
157                EnumVariant {
158                    name: "Gpu".into(),
159                    fields: vec![],
160                    doc: String::new(),
161                    is_default: false,
162                    serde_rename: None,
163                },
164            ],
165            doc: String::new(),
166            cfg: None,
167            serde_tag: None,
168            serde_rename_all: None,
169        }
170    }
171
172    #[test]
173    fn test_from_binding_to_core() {
174        let typ = simple_type();
175        let result = gen_from_binding_to_core(&typ, "my_crate");
176        assert!(result.contains("impl From<Config> for my_crate::Config"));
177        assert!(result.contains("name: val.name"));
178        assert!(result.contains("timeout: val.timeout"));
179        assert!(result.contains("backend: val.backend.map(Into::into)"));
180    }
181
182    #[test]
183    fn test_from_core_to_binding() {
184        let typ = simple_type();
185        let result = gen_from_core_to_binding(&typ, "my_crate", &AHashSet::new());
186        assert!(result.contains("impl From<my_crate::Config> for Config"));
187    }
188
189    #[test]
190    fn test_enum_from_binding_to_core() {
191        let enum_def = simple_enum();
192        let result = gen_enum_from_binding_to_core(&enum_def, "my_crate");
193        assert!(result.contains("impl From<Backend> for my_crate::Backend"));
194        assert!(result.contains("Backend::Cpu => Self::Cpu"));
195        assert!(result.contains("Backend::Gpu => Self::Gpu"));
196    }
197
198    #[test]
199    fn test_enum_from_core_to_binding() {
200        let enum_def = simple_enum();
201        let result = gen_enum_from_core_to_binding(&enum_def, "my_crate");
202        assert!(result.contains("impl From<my_crate::Backend> for Backend"));
203        assert!(result.contains("my_crate::Backend::Cpu => Self::Cpu"));
204        assert!(result.contains("my_crate::Backend::Gpu => Self::Gpu"));
205    }
206
207    #[test]
208    fn test_from_binding_to_core_with_cfg_gated_field() {
209        // Create a type with a cfg-gated field
210        let mut typ = simple_type();
211        typ.has_stripped_cfg_fields = true;
212        typ.fields.push(FieldDef {
213            name: "layout".into(),
214            ty: TypeRef::String,
215            optional: false,
216            default: None,
217            doc: String::new(),
218            sanitized: false,
219            is_boxed: false,
220            type_rust_path: None,
221            cfg: Some("feature = \"layout-detection\"".into()),
222            typed_default: None,
223            core_wrapper: CoreWrapper::None,
224            vec_inner_core_wrapper: CoreWrapper::None,
225            newtype_wrapper: None,
226        });
227
228        let result = gen_from_binding_to_core(&typ, "my_crate");
229
230        // The impl should exist
231        assert!(result.contains("impl From<Config> for my_crate::Config"));
232        // Regular fields should be present
233        assert!(result.contains("name: val.name"));
234        assert!(result.contains("timeout: val.timeout"));
235        // cfg-gated field should NOT be accessed from val (it doesn't exist in binding struct)
236        assert!(!result.contains("layout: val.layout"));
237        // But ..Default::default() should be present to fill cfg-gated fields
238        assert!(result.contains("..Default::default()"));
239    }
240
241    #[test]
242    fn test_from_core_to_binding_with_cfg_gated_field() {
243        // Create a type with a cfg-gated field
244        let mut typ = simple_type();
245        typ.fields.push(FieldDef {
246            name: "layout".into(),
247            ty: TypeRef::String,
248            optional: false,
249            default: None,
250            doc: String::new(),
251            sanitized: false,
252            is_boxed: false,
253            type_rust_path: None,
254            cfg: Some("feature = \"layout-detection\"".into()),
255            typed_default: None,
256            core_wrapper: CoreWrapper::None,
257            vec_inner_core_wrapper: CoreWrapper::None,
258            newtype_wrapper: None,
259        });
260
261        let result = gen_from_core_to_binding(&typ, "my_crate", &AHashSet::new());
262
263        // The impl should exist
264        assert!(result.contains("impl From<my_crate::Config> for Config"));
265        // Regular fields should be present
266        assert!(result.contains("name: val.name"));
267        // cfg-gated field should NOT be in the struct literal
268        assert!(!result.contains("layout:"));
269    }
270}