alef 0.20.0

Opinionated polyglot binding generator for Rust libraries
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
//! Service-API codegen for the Swift backend.
//!
//! Generates one output per [`ServiceDef`] with non-empty registrations:
//!
//! **`Service.swift`** — An idiomatic Swift service class that wraps the C FFI contract,
//! providing typed registration methods and a run method that delegates to the C symbols.
//!
//! The generated Swift service:
//! - Wraps an opaque C handle (returned by C `_new` / freed by `_free`)
//! - Exposes registration methods that accept Swift closures
//! - Wraps each Swift closure as a C callback via a trampoline + context recovery
//! - Calls the C `_register_<method>` symbols with the C-compatible function pointer
//! - Calls the C `_run` / `_finalize` entrypoint symbols via `_ep_<name>`
//!
//! The C FFI contract is emitted by the `ffi` backend in `service.rs` and declares:
//! - `extern "C" fn {prefix}_{service}_new() -> *mut {Service}Opaque`
//! - `extern "C" fn {prefix}_{service}_free(*mut {Service}Opaque)`
//! - `extern "C" fn {prefix}_{service}_register_<method>(owner, callback, ctx, metadata...)`
//! - `extern "C" fn {prefix}_{service}_ep_<entrypoint>(owner, params...)`
//! - Callback typedef: `fn(*mut c_void, *const c_char) -> *mut c_char`

use crate::core::backend::GeneratedFile;
use crate::core::config::ResolvedCrateConfig;
use crate::core::ir::{ApiSurface, RegistrationDef, ServiceDef, TypeRef};
use heck::{ToLowerCamelCase, ToSnakeCase};
use std::path::PathBuf;

// ───────────────────────────────────────────────────────────────── helpers ──

/// Map a `TypeRef` to a Swift type string for function parameters.
fn typeref_to_swift_type(ty: &TypeRef) -> String {
    match ty {
        TypeRef::String => "String".to_owned(),
        TypeRef::Char => "Character".to_owned(),
        TypeRef::Primitive(p) => {
            use crate::core::ir::PrimitiveType;
            match p {
                PrimitiveType::Bool => "Bool".to_owned(),
                PrimitiveType::U8 => "UInt8".to_owned(),
                PrimitiveType::U16 => "UInt16".to_owned(),
                PrimitiveType::U32 => "UInt32".to_owned(),
                PrimitiveType::U64 => "UInt64".to_owned(),
                PrimitiveType::I8 => "Int8".to_owned(),
                PrimitiveType::I16 => "Int16".to_owned(),
                PrimitiveType::I32 => "Int32".to_owned(),
                PrimitiveType::I64 => "Int64".to_owned(),
                PrimitiveType::F32 => "Float".to_owned(),
                PrimitiveType::F64 => "Double".to_owned(),
                PrimitiveType::Usize => "Int".to_owned(),
                PrimitiveType::Isize => "Int".to_owned(),
            }
        }
        TypeRef::Bytes => "Data".to_owned(),
        TypeRef::Unit => "Void".to_owned(),
        _ => "String".to_owned(), // Json, Vec, Map, etc. go through JSON serialization
    }
}

// ──────────────────────────────────────────────────────── Swift output ──

/// Generate the idiomatic Swift service class (`Service.swift`).
///
/// Produces a Swift class that wraps the C FFI contract and exposes:
/// - A constructor that calls the C `_new` symbol and retains the opaque handle.
/// - A deinit that frees the opaque handle via the C `_free` symbol.
/// - Registration methods that accept Swift closures and wrap them as C callbacks.
/// - A `run(...)` method that calls the C `_run` entrypoint.
pub(super) fn gen_service_swift(api: &ApiSurface, service: &ServiceDef) -> String {
    let mut out = String::new();

    let class_name = &service.name;
    let service_snake = class_name.to_snake_case();

    // Class definition with documentation
    if !service.doc.is_empty() {
        out.push_str(&format!("/// {}\n", service.doc.trim()));
    }
    out.push_str(&format!("public final class {class_name} {{\n\n"));

    // Opaque handle field
    out.push_str("    private var opaqueHandle: OpaquePointer?\n\n");

    // Registry to keep handler closures alive (ARC)
    out.push_str("    /// Registry of handler closures, keyed by registration index.\n");
    out.push_str("    /// Keeps closures alive for the lifetime of the service.\n");
    out.push_str("    private var handlerRegistry: [Int: (String) -> String] = [:]\n");
    out.push_str("    private var handlerRegistryIndex: Int = 0\n\n");

    // Constructor
    out.push_str("    /// Create a new service instance.\n");
    out.push_str("    public init() {\n");
    out.push_str(&format!(
        "        self.opaqueHandle = RustBridge.{service_snake}New()\n"
    ));
    out.push_str("    }\n\n");

    // Destructor
    out.push_str("    /// Free the service instance.\n");
    out.push_str("    deinit {\n");
    out.push_str("        if let handle = opaqueHandle {\n");
    out.push_str(&format!("            RustBridge.{service_snake}Free(handle)\n"));
    out.push_str("            opaqueHandle = nil\n");
    out.push_str("        }\n");
    out.push_str("    }\n\n");

    // Registration methods
    for reg in &service.registrations {
        gen_registration_method(&mut out, service, reg, api, &service_snake);
    }

    // Entrypoint methods
    for ep in &service.entrypoints {
        gen_entrypoint_method(&mut out, service, ep, &service_snake);
    }

    out.push_str("}\n");
    out
}

fn gen_registration_method(
    out: &mut String,
    _service: &ServiceDef,
    reg: &RegistrationDef,
    _api: &ApiSurface,
    service_snake: &str,
) {
    let method_name = &reg.method;
    let method_camel = method_name.to_lower_camel_case();

    // Build metadata param signature (excluding the callback param)
    let meta_params: Vec<String> = reg
        .metadata_params
        .iter()
        .map(|p| {
            let swift_type = typeref_to_swift_type(&p.ty);
            format!("{}: {}", p.name, swift_type)
        })
        .collect();

    let meta_sig = if meta_params.is_empty() {
        String::new()
    } else {
        format!(", {}", meta_params.join(", "))
    };

    if !reg.doc.is_empty() {
        out.push_str(&format!("    /// {}\n", reg.doc.trim()));
    }

    // Handler closure parameter: (String) -> String
    out.push_str(&format!(
        "    public func {method_camel}(_ handler: @escaping (String) -> String{meta_sig}) {{\n"
    ));

    // Store handler in registry with index
    out.push_str("        let handlerIndex = handlerRegistryIndex\n");
    out.push_str("        handlerRegistryIndex += 1\n");
    out.push_str("        handlerRegistry[handlerIndex] = handler\n\n");

    // Emit C-compatible trampoline and call registration function
    out.push_str("        // Create a C-compatible callback wrapper\n");
    out.push_str("        let trampolineFunc: @convention(c) (UnsafeMutableRawPointer?, UnsafePointer<CChar>?) -> UnsafeMutablePointer<CChar>? = { contextPtr, requestPtr in\n");
    out.push_str("            guard let contextPtr = contextPtr else { return nil }\n");
    out.push_str("            guard let requestPtr = requestPtr else { return nil }\n\n");

    // Recover the handler from context (stored as an Int index)
    out.push_str("            // Recover the service instance from context\n");
    out.push_str(
        "            let service = Unmanaged<AnyObject>.fromOpaque(contextPtr).takeUnretainedValue() as! MyService\n",
    );
    out.push_str("            let handlerIndex = Int(bitPattern: contextPtr)\n\n");

    // Call the handler
    out.push_str("            if let handler = service.handlerRegistry[handlerIndex] {\n");
    out.push_str("                let requestJSON = String(cString: requestPtr)\n");
    out.push_str("                let responseJSON = handler(requestJSON)\n\n");

    // Allocate and return response
    out.push_str("                // Allocate response string on C heap (caller must free)\n");
    out.push_str("                let responseBytes = responseJSON.utf8CString\n");
    out.push_str(
        "                let responsePtr = UnsafeMutablePointer<CChar>.allocate(capacity: responseBytes.count)\n",
    );
    out.push_str("                responsePtr.initialize(from: responseBytes, count: responseBytes.count)\n");
    out.push_str("                return responsePtr\n");
    out.push_str("            }\n");
    out.push_str("            return nil\n");
    out.push_str("        }\n\n");

    // Call C registration function with metadata
    out.push_str("        guard let handle = opaqueHandle else { return }\n\n");
    out.push_str("        let contextPtr = Unmanaged.passUnretained(self as AnyObject).toOpaque()\n");
    let method_camel_upper = format!(
        "{}{}",
        method_camel.chars().next().unwrap().to_uppercase(),
        &method_camel[1..]
    );
    out.push_str(&format!(
        "        RustBridge.{service_snake}Register{method_camel_upper}(\n            handle,\n            trampolineFunc,\n            contextPtr"
    ));

    // Add metadata parameters
    for meta_param in &reg.metadata_params {
        out.push_str(&format!(",\n            {}", meta_param.name));
    }

    out.push_str("\n        )\n");
    out.push_str("    }\n\n");
}

fn gen_entrypoint_method(
    out: &mut String,
    _service: &ServiceDef,
    ep: &crate::core::ir::EntrypointDef,
    service_snake: &str,
) {
    let ep_method = &ep.method;
    let ep_camel = ep_method.to_lower_camel_case();

    if !ep.doc.is_empty() {
        out.push_str(&format!("    /// {}\n", ep.doc.trim()));
    }

    // Build parameter signature
    let params: Vec<String> = ep
        .params
        .iter()
        .map(|p| {
            let swift_type = typeref_to_swift_type(&p.ty);
            format!("{}: {}", p.name, swift_type)
        })
        .collect();

    let param_sig = params.join(", ");

    // Determine if async
    let async_kw = if ep.is_async { " async" } else { "" };
    let throws_kw = if ep.error_type.is_some() { " throws" } else { "" };

    // Return type
    let return_type = if ep.return_type == TypeRef::Unit {
        "Void".to_owned()
    } else {
        typeref_to_swift_type(&ep.return_type)
    };

    out.push_str(&format!(
        "    public func {ep_camel}({param_sig}){async_kw}{throws_kw} -> {return_type} {{\n"
    ));

    // Call C entrypoint function
    out.push_str("        guard let handle = opaqueHandle else { throw ServiceError.invalidHandle }\n\n");

    let ep_camel_upper = format!("{}{}", ep_camel.chars().next().unwrap().to_uppercase(), &ep_camel[1..]);

    if ep.is_async {
        out.push_str(&format!(
            "        return try await withUnsafeThrowingContinuation {{ continuation in\n\
             \x20\x20\x20\x20Task {{\n\
             \x20\x20\x20\x20\x20\x20RustBridge.{service_snake}Ep{ep_camel_upper}(\n\
             \x20\x20\x20\x20\x20\x20\x20\x20handle"
        ));
    } else {
        out.push_str(&format!(
            "        RustBridge.{service_snake}Ep{ep_camel_upper}(\n            handle"
        ));
    }

    // Add entrypoint parameters
    for ep_param in &ep.params {
        out.push_str(&format!(",\n            {}", ep_param.name));
    }

    out.push_str("\n        ");

    if ep.is_async {
        out.push_str(")\n        }\n        }\n");
    } else {
        out.push_str(")\n");
    }

    out.push_str("    }\n\n");
}

// ──────────────────────────────────────────────────────── public entry point ──

/// Generate all service-API files for the Swift backend.
///
/// Returns one `GeneratedFile` per service when services are present:
/// - `{output_dir}/Service.swift` — Swift service class
pub fn generate(api: &ApiSurface, config: &ResolvedCrateConfig) -> anyhow::Result<Vec<GeneratedFile>> {
    if api.services.is_empty() {
        return Ok(vec![]);
    }

    let mut files = Vec::new();

    for service in &api.services {
        if service.registrations.is_empty() {
            continue;
        }

        let module_name = config.swift_module();
        let base_dir =
            crate::core::config::resolve_output_dir(config.output_paths.get("swift"), &config.name, "packages/swift");
        let base_path = PathBuf::from(&base_dir);

        let path = if config.explicit_output.swift.is_some() {
            base_path.join(format!("{}.swift", service.name))
        } else {
            base_path
                .join("Sources")
                .join(&module_name)
                .join(format!("{}.swift", service.name))
        };

        let content = gen_service_swift(api, service);

        files.push(GeneratedFile {
            path,
            content,
            generated_header: true,
        });
    }

    Ok(files)
}

// ───────────────────────────────────────────────────────────────────── tests ──

#[cfg(test)]
mod tests {
    use super::*;
    use crate::core::ir::{
        EntrypointDef, EntrypointKind, HandlerContractDef, MethodDef, ParamDef, RegistrationDef, ServiceDef, TypeRef,
    };

    fn make_fixture_surface() -> ApiSurface {
        let constructor = MethodDef {
            name: "new".to_owned(),
            params: vec![],
            return_type: TypeRef::Unit,
            is_async: false,
            is_static: true,
            error_type: None,
            doc: "Create a new service owner.".to_owned(),
            receiver: None,
            sanitized: false,
            trait_source: None,
            returns_ref: false,
            returns_cow: false,
            return_newtype_wrapper: None,
            has_default_impl: false,
            binding_excluded: false,
            binding_exclusion_reason: None,
        };

        let registration = RegistrationDef {
            method: "add_handler".to_owned(),
            callback_param: "handler".to_owned(),
            callback_contract: "RequestHandler".to_owned(),
            metadata_params: vec![ParamDef {
                name: "path".to_owned(),
                ty: TypeRef::String,
                optional: false,
                default: None,
                ..ParamDef::default()
            }],
            receiver: Some(crate::core::ir::ReceiverKind::RefMut),
            return_type: TypeRef::Unit,
            error_type: None,
            doc: "Register a request handler.".to_owned(),
        };

        let run_entrypoint = EntrypointDef {
            method: "run".to_owned(),
            kind: EntrypointKind::Run,
            is_async: true,
            params: vec![ParamDef {
                name: "addr".to_owned(),
                ty: TypeRef::String,
                optional: false,
                default: None,
                ..ParamDef::default()
            }],
            return_type: TypeRef::Unit,
            error_type: Some("IoError".to_owned()),
            doc: "Start the service.".to_owned(),
        };

        let handler_contract = HandlerContractDef {
            trait_name: "RequestHandler".to_owned(),
            rust_path: "my_crate::RequestHandler".to_owned(),
            dispatch: MethodDef {
                name: "handle".to_owned(),
                params: vec![ParamDef {
                    name: "req".to_owned(),
                    ty: TypeRef::Named("RequestData".to_owned()),
                    optional: false,
                    default: None,
                    ..ParamDef::default()
                }],
                return_type: TypeRef::Named("Response".to_owned()),
                is_async: true,
                is_static: false,
                error_type: None,
                doc: "Handle a request.".to_owned(),
                receiver: Some(crate::core::ir::ReceiverKind::Ref),
                sanitized: false,
                trait_source: None,
                returns_ref: false,
                returns_cow: false,
                return_newtype_wrapper: None,
                has_default_impl: false,
                binding_excluded: false,
                binding_exclusion_reason: None,
            },
            optional_methods: vec![],
            wire_request_type: Some("RequestData".to_owned()),
            wire_response_type: Some("Response".to_owned()),
            doc: "Handler contract.".to_owned(),
        };

        ApiSurface {
            crate_name: "test_crate".to_owned(),
            version: "1.0.0".to_owned(),
            services: vec![ServiceDef {
                name: "TestService".to_owned(),
                rust_path: "my_crate::TestService".to_owned(),
                constructor,
                configurators: vec![],
                registrations: vec![registration],
                entrypoints: vec![run_entrypoint],
                doc: "Test service.".to_owned(),
                cfg: None,
            }],
            handler_contracts: vec![handler_contract],
            ..ApiSurface::default()
        }
    }

    #[test]
    fn test_gen_service_swift_contains_class() {
        let api = make_fixture_surface();
        let service = &api.services[0];
        let output = gen_service_swift(&api, service);

        assert!(
            output.contains("public final class TestService"),
            "expected `public final class TestService` in output:\n{output}"
        );
    }

    #[test]
    fn test_gen_service_swift_contains_init_and_deinit() {
        let api = make_fixture_surface();
        let service = &api.services[0];
        let output = gen_service_swift(&api, service);

        assert!(
            output.contains("public init()"),
            "expected `public init()` in output:\n{output}"
        );
        assert!(output.contains("deinit"), "expected `deinit` in output:\n{output}");
        assert!(
            output.contains("RustBridge.test_serviceFree"),
            "expected C free call in deinit:\n{output}"
        );
    }

    #[test]
    fn test_gen_service_swift_contains_handler_registry() {
        let api = make_fixture_surface();
        let service = &api.services[0];
        let output = gen_service_swift(&api, service);

        assert!(
            output.contains("private var handlerRegistry"),
            "expected handler registry field:\n{output}"
        );
        assert!(
            output.contains("handlerRegistryIndex"),
            "expected handler registry index field:\n{output}"
        );
    }

    #[test]
    fn test_gen_service_swift_contains_registration_method() {
        let api = make_fixture_surface();
        let service = &api.services[0];
        let output = gen_service_swift(&api, service);

        assert!(
            output.contains("public func addHandler"),
            "expected registration method `addHandler`:\n{output}"
        );
        assert!(
            output.contains("@convention(c)"),
            "expected C-compatible closure:\n{output}"
        );
        assert!(
            output.contains("trampolineFunc"),
            "expected C trampoline function:\n{output}"
        );
    }

    #[test]
    fn test_gen_service_swift_contains_context_recovery() {
        let api = make_fixture_surface();
        let service = &api.services[0];
        let output = gen_service_swift(&api, service);

        assert!(
            output.contains("Unmanaged"),
            "expected Unmanaged for context recovery:\n{output}"
        );
        assert!(
            output.contains("handlerRegistry"),
            "expected handler registry access in trampoline:\n{output}"
        );
    }

    #[test]
    fn test_gen_service_swift_contains_run_method() {
        let api = make_fixture_surface();
        let service = &api.services[0];
        let output = gen_service_swift(&api, service);

        assert!(
            output.contains("public func run"),
            "expected `run` entrypoint method:\n{output}"
        );
        assert!(
            output.contains("async"),
            "expected async keyword for async entrypoint:\n{output}"
        );
        assert!(
            output.contains("RustBridge.test_serviceEpRun"),
            "expected C run symbol call:\n{output}"
        );
    }

    #[test]
    fn test_gen_service_swift_contains_c_ffi_symbols() {
        let api = make_fixture_surface();
        let service = &api.services[0];
        let output = gen_service_swift(&api, service);

        // C symbols from FFI contract
        assert!(
            output.contains("RustBridge.test_serviceNew"),
            "expected C new symbol:\n{output}"
        );
        assert!(
            output.contains("RustBridge.test_serviceFree"),
            "expected C free symbol:\n{output}"
        );
        assert!(
            output.contains("RustBridge.test_serviceRegisterAddHandler"),
            "expected C register symbol:\n{output}"
        );
    }

    #[test]
    fn test_generate_returns_file_for_non_empty_services() {
        let api = make_fixture_surface();
        let config = ResolvedCrateConfig {
            name: "test_crate".to_owned(),
            ..ResolvedCrateConfig::default()
        };

        let files = generate(&api, &config).expect("generate should not fail");
        assert!(!files.is_empty(), "expected at least one generated file");

        let has_service_file = files.iter().any(|f| {
            f.path
                .file_name()
                .and_then(|n| n.to_str())
                .map(|s| s.ends_with("TestService.swift"))
                .unwrap_or(false)
        });
        assert!(has_service_file, "expected TestService.swift in output");
    }

    #[test]
    fn test_generate_returns_empty_for_no_services() {
        let api = ApiSurface::default();
        let config = ResolvedCrateConfig {
            name: "test_crate".to_owned(),
            ..ResolvedCrateConfig::default()
        };

        let files = generate(&api, &config).expect("generate should not fail");
        assert!(files.is_empty(), "expected no files for surface without services");
    }

    #[test]
    fn test_generate_skips_services_without_registrations() {
        let mut api = make_fixture_surface();
        api.services[0].registrations.clear();

        let config = ResolvedCrateConfig {
            name: "test_crate".to_owned(),
            ..ResolvedCrateConfig::default()
        };

        let files = generate(&api, &config).expect("generate should not fail");
        assert!(files.is_empty(), "expected no files for service without registrations");
    }
}