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, Json fields stay as `serde_json::Value` in the binding layer (no wrapping).
34    /// Core↔binding conversions are identity since both sides hold the same type.
35    /// Used by NAPI (with `serde-json` feature) so JS callers can pass arbitrary objects
36    /// directly without first stringifying them.
37    pub json_as_value: bool,
38    /// When true, add synthetic metadata field conversion for ConversionResult.
39    /// Only NAPI backend sets this (it adds metadata field to the struct).
40    pub include_cfg_metadata: bool,
41    /// When true, non-optional Duration fields on `has_default` types are stored as
42    /// `Option<u64>` in the binding struct.  The From conversion uses the builder
43    /// pattern so that `None` falls back to the core type's `Default` implementation
44    /// (giving the real default, e.g. `Duration::from_secs(30)`) instead of `Duration::ZERO`.
45    /// Used by PyO3 to prevent validation failures when `request_timeout` is unset.
46    pub option_duration_on_defaults: bool,
47    /// When true, binding enums include data variant fields (Magnus).
48    /// When false (default), binding enums are unit-only and data is lost in conversion.
49    pub binding_enums_have_data: bool,
50    /// Type names excluded from the binding layer. Fields referencing these types
51    /// are skipped in the binding struct and defaulted in From conversions.
52    /// Used by WASM to handle types excluded due to native dependency requirements.
53    pub exclude_types: &'a [String],
54    /// When true, Vec<Named> fields are stored as JSON strings in the binding layer.
55    /// Core→binding uses `serde_json::to_string`, binding→core uses `serde_json::from_str`.
56    /// Used by Magnus (Ruby) where Vec<Named> cannot cross the FFI boundary directly and
57    /// is collapsed to String by `field_type_for_serde`'s catch-all arm.
58    pub vec_named_to_string: bool,
59    /// When true, all Map(K, V) fields are stored as a plain `String` in the binding layer.
60    /// Core→binding uses `format!("{:?}", val.field)`, binding→core uses `Default::default()` (lossy).
61    /// Used by Rustler (Elixir NIFs) where `HashMap` cannot cross the NIF boundary directly.
62    pub map_as_string: bool,
63    /// Set of opaque type names in the binding layer.
64    /// When a field has `CoreWrapper::Arc` and its type is an opaque Named type,
65    /// the binding wrapper holds `inner: Arc<CoreT>` and the conversion must extract
66    /// `.inner` directly instead of calling `.into()` + wrapping in `Arc::new`.
67    pub opaque_types: Option<&'a AHashSet<String>>,
68    /// Type names that should use `Default::default()` in the binding→core From impl.
69    /// Used by PHP to skip bridge type fields (e.g., VisitorHandle) that can't be
70    /// auto-converted via Into and are always handled by the bridge machinery instead.
71    pub from_binding_skip_types: &'a [String],
72    /// When `core_crate_override` is set for a language, the IR's `rust_path` values
73    /// still contain the original source crate prefix (e.g. `mylib_core::Method`).
74    /// This field remaps those paths: `(original_crate_name, override_crate_name)`.
75    /// When set, any `rust_path` whose leading crate segment equals `original_crate_name`
76    /// is rewritten to use `override_crate_name` instead.
77    /// Example: `Some(("mylib_core", "mylib_http"))` rewrites
78    /// `mylib_core::Method` → `mylib_http::Method`.
79    pub source_crate_remaps: &'a [(&'a str, &'a str)],
80    /// Per-field binding name overrides.  Key is `"TypeName.field_name"` (using the original
81    /// IR field name); value is the binding struct's actual Rust field name (e.g. `"class_"`).
82    /// Used when a field name is a reserved keyword in the target language and must be escaped
83    /// in the binding struct (e.g. `class` → `class_`).
84    ///
85    /// When present, `val.<binding_name>` is used for binding-side access and the original
86    /// `field_name` is used for core-side access (struct literal and assignment targets).
87    pub binding_field_renames: Option<&'a std::collections::HashMap<String, String>>,
88    /// When true, U8/U16/U32 (and their signed counterparts I8/I16) need `as i32` casts.
89    /// extendr maps all small integers to R's native integer type (i32), so binding→core
90    /// conversions must cast back to the original unsigned/narrow types.
91    pub cast_uints_to_i32: bool,
92    /// When true, U64/Usize/Isize are mapped to f64 (R's native double type) rather than i64.
93    /// extendr uses f64 for large integers because R has no native 64-bit integer type.
94    /// Binding→core: `as usize`/`as u64` casts; core→binding: `as f64` casts.
95    pub cast_large_ints_to_f64: bool,
96}
97
98impl<'a> ConversionConfig<'a> {
99    /// Look up the binding struct field name for a given type and IR field name.
100    ///
101    /// Returns the escaped name (e.g. `"class_"`) when the field was renamed due to a
102    /// reserved keyword conflict, or the original `field_name` when no rename applies.
103    pub fn binding_field_name<'b>(&self, type_name: &str, field_name: &'b str) -> &'b str
104    where
105        'a: 'b,
106    {
107        // &'b str: we return either the original (which has lifetime 'b from the parameter)
108        // or a &str from the HashMap (which would have lifetime 'a). Since 'a: 'b we can
109        // return either. But Rust's lifetime inference won't let us return `&'a str` from a
110        // `&'b str` parameter without unsafe. Use a helper that returns an owned String instead.
111        let _ = type_name;
112        field_name
113    }
114
115    /// Like `binding_field_name` but returns an owned `String`, suitable for use in
116    /// format strings and string interpolation.
117    pub fn binding_field_name_owned(&self, type_name: &str, field_name: &str) -> String {
118        if let Some(map) = self.binding_field_renames {
119            let key = format!("{type_name}.{field_name}");
120            if let Some(renamed) = map.get(&key) {
121                return renamed.clone();
122            }
123        }
124        field_name.to_string()
125    }
126}
127
128// Re-export all public items so callers continue to use `conversions::foo`.
129pub use binding_to_core::{
130    apply_core_wrapper_to_core, field_conversion_to_core, field_conversion_to_core_cfg, gen_from_binding_to_core,
131    gen_from_binding_to_core_cfg,
132};
133pub use core_to_binding::{
134    field_conversion_from_core, field_conversion_from_core_cfg, gen_from_core_to_binding, gen_from_core_to_binding_cfg,
135};
136pub use enums::{
137    gen_enum_from_binding_to_core, gen_enum_from_binding_to_core_cfg, gen_enum_from_core_to_binding,
138    gen_enum_from_core_to_binding_cfg,
139};
140pub use helpers::{
141    apply_crate_remaps, binding_to_core_match_arm, build_type_path_map, can_generate_conversion,
142    can_generate_enum_conversion, can_generate_enum_conversion_from_core, convertible_types, core_enum_path,
143    core_enum_path_remapped, core_to_binding_convertible_types, core_to_binding_match_arm, core_type_path,
144    core_type_path_remapped, field_references_excluded_type, has_sanitized_fields, input_type_names, is_tuple_variant,
145    resolve_named_path,
146};
147
148#[cfg(test)]
149mod tests {
150    use super::*;
151    use alef_core::ir::*;
152
153    fn simple_type() -> TypeDef {
154        TypeDef {
155            name: "Config".to_string(),
156            rust_path: "my_crate::Config".to_string(),
157            original_rust_path: String::new(),
158            fields: vec![
159                FieldDef {
160                    name: "name".into(),
161                    ty: TypeRef::String,
162                    optional: false,
163                    default: None,
164                    doc: String::new(),
165                    sanitized: false,
166                    is_boxed: false,
167                    type_rust_path: None,
168                    cfg: None,
169                    typed_default: None,
170                    core_wrapper: CoreWrapper::None,
171                    vec_inner_core_wrapper: CoreWrapper::None,
172                    newtype_wrapper: None,
173                },
174                FieldDef {
175                    name: "timeout".into(),
176                    ty: TypeRef::Primitive(PrimitiveType::U64),
177                    optional: true,
178                    default: None,
179                    doc: String::new(),
180                    sanitized: false,
181                    is_boxed: false,
182                    type_rust_path: None,
183                    cfg: None,
184                    typed_default: None,
185                    core_wrapper: CoreWrapper::None,
186                    vec_inner_core_wrapper: CoreWrapper::None,
187                    newtype_wrapper: None,
188                },
189                FieldDef {
190                    name: "backend".into(),
191                    ty: TypeRef::Named("Backend".into()),
192                    optional: true,
193                    default: None,
194                    doc: String::new(),
195                    sanitized: false,
196                    is_boxed: false,
197                    type_rust_path: None,
198                    cfg: None,
199                    typed_default: None,
200                    core_wrapper: CoreWrapper::None,
201                    vec_inner_core_wrapper: CoreWrapper::None,
202                    newtype_wrapper: None,
203                },
204            ],
205            methods: vec![],
206            is_opaque: false,
207            is_clone: true,
208            is_copy: false,
209            is_trait: false,
210            has_default: false,
211            has_stripped_cfg_fields: false,
212            is_return_type: false,
213            serde_rename_all: None,
214            has_serde: false,
215            super_traits: vec![],
216            doc: String::new(),
217            cfg: None,
218        }
219    }
220
221    fn simple_enum() -> EnumDef {
222        EnumDef {
223            name: "Backend".to_string(),
224            rust_path: "my_crate::Backend".to_string(),
225            original_rust_path: String::new(),
226            variants: vec![
227                EnumVariant {
228                    name: "Cpu".into(),
229                    fields: vec![],
230                    is_tuple: false,
231                    doc: String::new(),
232                    is_default: false,
233                    serde_rename: None,
234                },
235                EnumVariant {
236                    name: "Gpu".into(),
237                    fields: vec![],
238                    is_tuple: false,
239                    doc: String::new(),
240                    is_default: false,
241                    serde_rename: None,
242                },
243            ],
244            doc: String::new(),
245            cfg: None,
246            is_copy: false,
247            has_serde: false,
248            serde_tag: None,
249            serde_rename_all: None,
250        }
251    }
252
253    #[test]
254    fn test_from_binding_to_core() {
255        let typ = simple_type();
256        let result = gen_from_binding_to_core(&typ, "my_crate");
257        assert!(result.contains("impl From<Config> for my_crate::Config"));
258        assert!(result.contains("name: val.name"));
259        assert!(result.contains("timeout: val.timeout"));
260        assert!(result.contains("backend: val.backend.map(Into::into)"));
261    }
262
263    #[test]
264    fn test_from_core_to_binding() {
265        let typ = simple_type();
266        let result = gen_from_core_to_binding(&typ, "my_crate", &AHashSet::new());
267        assert!(result.contains("impl From<my_crate::Config> for Config"));
268    }
269
270    #[test]
271    fn test_enum_from_binding_to_core() {
272        let enum_def = simple_enum();
273        let result = gen_enum_from_binding_to_core(&enum_def, "my_crate");
274        assert!(result.contains("impl From<Backend> for my_crate::Backend"));
275        assert!(result.contains("Backend::Cpu => Self::Cpu"));
276        assert!(result.contains("Backend::Gpu => Self::Gpu"));
277    }
278
279    #[test]
280    fn test_enum_from_core_to_binding() {
281        let enum_def = simple_enum();
282        let result = gen_enum_from_core_to_binding(&enum_def, "my_crate");
283        assert!(result.contains("impl From<my_crate::Backend> for Backend"));
284        assert!(result.contains("my_crate::Backend::Cpu => Self::Cpu"));
285        assert!(result.contains("my_crate::Backend::Gpu => Self::Gpu"));
286    }
287
288    #[test]
289    fn test_from_binding_to_core_with_cfg_gated_field() {
290        // Create a type with a cfg-gated field
291        let mut typ = simple_type();
292        typ.has_stripped_cfg_fields = true;
293        typ.fields.push(FieldDef {
294            name: "layout".into(),
295            ty: TypeRef::String,
296            optional: false,
297            default: None,
298            doc: String::new(),
299            sanitized: false,
300            is_boxed: false,
301            type_rust_path: None,
302            cfg: Some("feature = \"layout-detection\"".into()),
303            typed_default: None,
304            core_wrapper: CoreWrapper::None,
305            vec_inner_core_wrapper: CoreWrapper::None,
306            newtype_wrapper: None,
307        });
308
309        let result = gen_from_binding_to_core(&typ, "my_crate");
310
311        // The impl should exist
312        assert!(result.contains("impl From<Config> for my_crate::Config"));
313        // Regular fields should be present
314        assert!(result.contains("name: val.name"));
315        assert!(result.contains("timeout: val.timeout"));
316        // cfg-gated field should NOT be accessed from val (it doesn't exist in binding struct)
317        assert!(!result.contains("layout: val.layout"));
318        // But ..Default::default() should be present to fill cfg-gated fields
319        assert!(result.contains("..Default::default()"));
320    }
321
322    #[test]
323    fn test_from_core_to_binding_with_cfg_gated_field() {
324        // Create a type with a cfg-gated field
325        let mut typ = simple_type();
326        typ.fields.push(FieldDef {
327            name: "layout".into(),
328            ty: TypeRef::String,
329            optional: false,
330            default: None,
331            doc: String::new(),
332            sanitized: false,
333            is_boxed: false,
334            type_rust_path: None,
335            cfg: Some("feature = \"layout-detection\"".into()),
336            typed_default: None,
337            core_wrapper: CoreWrapper::None,
338            vec_inner_core_wrapper: CoreWrapper::None,
339            newtype_wrapper: None,
340        });
341
342        let result = gen_from_core_to_binding(&typ, "my_crate", &AHashSet::new());
343
344        // The impl should exist
345        assert!(result.contains("impl From<my_crate::Config> for Config"));
346        // Regular fields should be present
347        assert!(result.contains("name: val.name"));
348        // cfg-gated field should NOT be in the struct literal
349        assert!(!result.contains("layout:"));
350    }
351
352    #[test]
353    fn test_field_conversion_from_core_map_named_non_optional() {
354        // Map<K, Named> non-optional: each value needs .into() core→binding
355        let result = field_conversion_from_core(
356            "tags",
357            &TypeRef::Map(Box::new(TypeRef::String), Box::new(TypeRef::Named("Tag".into()))),
358            false,
359            false,
360            &AHashSet::new(),
361        );
362        assert_eq!(
363            result,
364            "tags: val.tags.into_iter().map(|(k, v)| (k, v.into())).collect()"
365        );
366    }
367
368    #[test]
369    fn test_field_conversion_from_core_option_map_named() {
370        // Option<Map<K, Named>>: .map() wrapper + per-element .into()
371        let result = field_conversion_from_core(
372            "tags",
373            &TypeRef::Optional(Box::new(TypeRef::Map(
374                Box::new(TypeRef::String),
375                Box::new(TypeRef::Named("Tag".into())),
376            ))),
377            false,
378            false,
379            &AHashSet::new(),
380        );
381        assert_eq!(
382            result,
383            "tags: val.tags.map(|m| m.into_iter().map(|(k, v)| (k, v.into())).collect())"
384        );
385    }
386
387    #[test]
388    fn test_field_conversion_from_core_vec_named_non_optional() {
389        // Vec<Named> non-optional: each element needs .into() core→binding
390        let result = field_conversion_from_core(
391            "items",
392            &TypeRef::Vec(Box::new(TypeRef::Named("Item".into()))),
393            false,
394            false,
395            &AHashSet::new(),
396        );
397        assert_eq!(result, "items: val.items.into_iter().map(Into::into).collect()");
398    }
399
400    #[test]
401    fn test_field_conversion_from_core_option_vec_named() {
402        // Option<Vec<Named>>: .map() wrapper + per-element .into()
403        let result = field_conversion_from_core(
404            "items",
405            &TypeRef::Optional(Box::new(TypeRef::Vec(Box::new(TypeRef::Named("Item".into()))))),
406            false,
407            false,
408            &AHashSet::new(),
409        );
410        assert_eq!(
411            result,
412            "items: val.items.map(|v| v.into_iter().map(Into::into).collect())"
413        );
414    }
415
416    #[test]
417    fn test_field_conversion_to_core_option_map_named_applies_per_value_into() {
418        // Bug A1 regression: Option<Map<K, Named>> must apply per-value .into() so that
419        // binding-side wrapper types (e.g. PyO3 / Magnus structs) are converted correctly.
420        let result = field_conversion_to_core(
421            "patterns",
422            &TypeRef::Map(
423                Box::new(TypeRef::String),
424                Box::new(TypeRef::Named("ExtractionPattern".into())),
425            ),
426            true,
427        );
428        assert!(
429            result.contains("m.into_iter().map(|(k, v)| (k.into(), v.into())).collect()"),
430            "expected per-value v.into() in optional Map<Named> conversion, got: {result}"
431        );
432        assert_eq!(
433            result,
434            "patterns: val.patterns.map(|m| m.into_iter().map(|(k, v)| (k.into(), v.into())).collect())"
435        );
436    }
437
438    #[test]
439    fn test_gen_optionalized_field_to_core_ir_optional_map_named_preserves_option() {
440        // Bug A3 regression: when field_is_ir_optional=true, gen_optionalized_field_to_core must
441        // preserve the Option layer via .map(|m| …) instead of dropping it with unwrap_or_default().
442        use super::binding_to_core::gen_optionalized_field_to_core;
443        let config = ConversionConfig::default();
444        let result = gen_optionalized_field_to_core(
445            "patterns",
446            &TypeRef::Map(
447                Box::new(TypeRef::String),
448                Box::new(TypeRef::Named("ExtractionPattern".into())),
449            ),
450            &config,
451            true,
452        );
453        assert!(
454            result.contains("m.into_iter().map(|(k, v)| (k, v.into())).collect()"),
455            "expected per-value v.into() in ir-optional Map<Named> conversion, got: {result}"
456        );
457        assert_eq!(
458            result,
459            "patterns: val.patterns.map(|m| m.into_iter().map(|(k, v)| (k, v.into())).collect())"
460        );
461    }
462
463    #[test]
464    fn test_optionalized_defaultable_struct_uses_core_default_as_base() {
465        let mut typ = simple_type();
466        typ.has_default = true;
467        typ.fields = vec![
468            FieldDef {
469                name: "language".into(),
470                ty: TypeRef::String,
471                optional: false,
472                default: None,
473                doc: String::new(),
474                sanitized: false,
475                is_boxed: false,
476                type_rust_path: None,
477                cfg: None,
478                typed_default: None,
479                core_wrapper: CoreWrapper::Cow,
480                vec_inner_core_wrapper: CoreWrapper::None,
481                newtype_wrapper: None,
482            },
483            FieldDef {
484                name: "structure".into(),
485                ty: TypeRef::Primitive(PrimitiveType::Bool),
486                optional: false,
487                default: None,
488                doc: String::new(),
489                sanitized: false,
490                is_boxed: false,
491                type_rust_path: None,
492                cfg: None,
493                typed_default: None,
494                core_wrapper: CoreWrapper::None,
495                vec_inner_core_wrapper: CoreWrapper::None,
496                newtype_wrapper: None,
497            },
498        ];
499        let config = ConversionConfig {
500            type_name_prefix: "Js",
501            optionalize_defaults: true,
502            ..ConversionConfig::default()
503        };
504
505        let result = gen_from_binding_to_core_cfg(&typ, "my_crate", &config);
506
507        assert!(result.contains("let mut __result = my_crate::Config::default();"));
508        assert!(result.contains("if let Some(__v) = val.language { __result.language = __v.into(); }"));
509        assert!(result.contains("if let Some(__v) = val.structure { __result.structure = __v; }"));
510        assert!(!result.contains("unwrap_or_default()"));
511    }
512
513    fn arc_field_type(field: FieldDef) -> TypeDef {
514        TypeDef {
515            name: "State".to_string(),
516            rust_path: "my_crate::State".to_string(),
517            original_rust_path: String::new(),
518            fields: vec![field],
519            methods: vec![],
520            is_opaque: false,
521            is_clone: true,
522            is_copy: false,
523            is_trait: false,
524            has_default: false,
525            has_stripped_cfg_fields: false,
526            is_return_type: false,
527            serde_rename_all: None,
528            has_serde: false,
529            super_traits: vec![],
530            doc: String::new(),
531            cfg: None,
532        }
533    }
534
535    fn arc_field(name: &str, ty: TypeRef, optional: bool) -> FieldDef {
536        FieldDef {
537            name: name.into(),
538            ty,
539            optional,
540            default: None,
541            doc: String::new(),
542            sanitized: false,
543            is_boxed: false,
544            type_rust_path: None,
545            cfg: None,
546            typed_default: None,
547            core_wrapper: CoreWrapper::Arc,
548            vec_inner_core_wrapper: CoreWrapper::None,
549            newtype_wrapper: None,
550        }
551    }
552
553    /// Regression: Option<Arc<serde_json::Value>> must not chain `(*v).clone().into()`
554    /// on top of `as_ref().map(ToString::to_string)`, which would emit invalid
555    /// `(*String).clone()` (str: !Clone).
556    #[test]
557    fn test_arc_json_option_field_no_double_chain() {
558        let typ = arc_field_type(arc_field("registered_spec", TypeRef::Json, true));
559        let result = gen_from_core_to_binding(&typ, "my_crate", &AHashSet::new());
560        assert!(
561            result.contains("val.registered_spec.as_ref().map(ToString::to_string)"),
562            "expected as_ref().map(ToString::to_string) for Option<Arc<Value>>, got: {result}"
563        );
564        assert!(
565            !result.contains("map(ToString::to_string).map("),
566            "must not chain a second map() on top of ToString::to_string, got: {result}"
567        );
568    }
569
570    /// Non-optional Arc<Value>: `(*val.X).clone().to_string()` is valid (Value: Clone).
571    #[test]
572    fn test_arc_json_non_optional_field() {
573        let typ = arc_field_type(arc_field("spec", TypeRef::Json, false));
574        let result = gen_from_core_to_binding(&typ, "my_crate", &AHashSet::new());
575        assert!(
576            result.contains("(*val.spec).clone().to_string()"),
577            "expected (*val.spec).clone().to_string() for Arc<Value>, got: {result}"
578        );
579    }
580
581    /// Option<Arc<String>>: simple passthrough → `.map(|v| (*v).clone().into())` is valid
582    /// (String: Clone). Verifies the simple_passthrough branch is preserved.
583    #[test]
584    fn test_arc_string_option_field_passthrough() {
585        let typ = arc_field_type(arc_field("label", TypeRef::String, true));
586        let result = gen_from_core_to_binding(&typ, "my_crate", &AHashSet::new());
587        assert!(
588            result.contains("val.label.map(|v| (*v).clone().into())"),
589            "expected .map(|v| (*v).clone().into()) for Option<Arc<String>>, got: {result}"
590        );
591    }
592}