1use minijinja::context;
7use std::fmt::Write;
8
9use alef_codegen::generators::trait_bridge::{
10 BridgeOutput, TraitBridgeGenerator, TraitBridgeSpec, bridge_param_type as param_type, gen_bridge_all,
11 visitor_param_type,
12};
13use alef_core::config::TraitBridgeConfig;
14use alef_core::ir::{ApiSurface, MethodDef, TypeDef, TypeRef};
15use std::collections::HashMap;
16
17pub use alef_codegen::generators::trait_bridge::find_bridge_param;
22
23pub struct PhpBridgeGenerator {
26 pub core_import: String,
28 pub type_paths: HashMap<String, String>,
30 pub error_type: String,
32}
33
34impl TraitBridgeGenerator for PhpBridgeGenerator {
35 fn foreign_object_type(&self) -> &str {
36 "*mut ext_php_rs::types::ZendObject"
37 }
38
39 fn bridge_imports(&self) -> Vec<String> {
40 vec!["std::sync::Arc".to_string()]
41 }
42
43 fn gen_sync_method_body(&self, method: &MethodDef, _spec: &TraitBridgeSpec) -> String {
44 let name = &method.name;
45
46 let has_args = !method.params.is_empty();
47 let args_expr = if has_args {
48 let mut args_parts = Vec::new();
49 for p in &method.params {
50 let arg_expr = match &p.ty {
51 TypeRef::String => format!("ext_php_rs::types::Zval::try_from({}).unwrap_or_default()", p.name),
52 TypeRef::Path => format!(
53 "ext_php_rs::types::Zval::try_from({}.to_string_lossy().to_string()).unwrap_or_default()",
54 p.name
55 ),
56 TypeRef::Bytes => format!(
57 "ext_php_rs::types::Zval::try_from(format!(\"{{:?}}\", {})).unwrap_or_default()",
58 p.name
59 ),
60 TypeRef::Named(_) => {
61 format!(
62 "ext_php_rs::types::Zval::try_from(serde_json::to_string(&{}).unwrap_or_default()).unwrap_or_default()",
63 p.name
64 )
65 }
66 TypeRef::Primitive(_) => {
67 format!("ext_php_rs::types::Zval::try_from({}).unwrap_or_default()", p.name)
68 }
69 _ => format!(
70 "ext_php_rs::types::Zval::try_from(format!(\"{{:?}}\", {})).unwrap_or_default()",
71 p.name
72 ),
73 };
74 args_parts.push(arg_expr);
75 }
76 let args_array = format!("[{}]", args_parts.join(", "));
77 format!(
78 "{}.iter().map(|z| z as &dyn ext_php_rs::convert::IntoZvalDyn).collect()",
79 args_array
80 )
81 } else {
82 "vec![]".to_string()
83 };
84
85 let is_result_type = method.error_type.is_some();
86 let is_unit_return = matches!(method.return_type, TypeRef::Unit);
87
88 crate::template_env::render(
89 "sync_method_body.jinja",
90 context! {
91 method_name => name,
92 args_expr => args_expr,
93 is_result_type => is_result_type,
94 is_unit_return => is_unit_return,
95 core_import => &self.core_import,
96 },
97 )
98 }
99
100 fn gen_async_method_body(&self, method: &MethodDef, spec: &TraitBridgeSpec) -> String {
101 let name = &method.name;
102
103 let string_params: Vec<String> = method
104 .params
105 .iter()
106 .filter(|p| matches!(&p.ty, TypeRef::String))
107 .map(|p| p.name.clone())
108 .collect();
109
110 let has_args = !method.params.is_empty();
111 let args_expr = if has_args {
112 let mut args_parts = Vec::new();
113 for p in &method.params {
114 let arg_expr = match &p.ty {
115 TypeRef::String => format!("ext_php_rs::types::Zval::try_from({}).unwrap_or_default()", p.name),
116 TypeRef::Path => format!(
117 "ext_php_rs::types::Zval::try_from({}.to_string_lossy().to_string()).unwrap_or_default()",
118 p.name
119 ),
120 TypeRef::Bytes => format!(
121 "ext_php_rs::types::Zval::try_from(format!(\"{{:?}}\", {})).unwrap_or_default()",
122 p.name
123 ),
124 TypeRef::Named(_) => {
125 format!(
126 "ext_php_rs::types::Zval::try_from(serde_json::to_string(&{}).unwrap_or_default()).unwrap_or_default()",
127 p.name
128 )
129 }
130 TypeRef::Primitive(_) => {
131 format!("ext_php_rs::types::Zval::try_from({}).unwrap_or_default()", p.name)
132 }
133 _ => format!(
134 "ext_php_rs::types::Zval::try_from(format!(\"{{:?}}\", {})).unwrap_or_default()",
135 p.name
136 ),
137 };
138 args_parts.push(arg_expr);
139 }
140 let args_array = format!("[{}]", args_parts.join(", "));
141 format!(
142 "{}.iter().map(|z| z as &dyn ext_php_rs::convert::IntoZvalDyn).collect()",
143 args_array
144 )
145 } else {
146 "vec![]".to_string()
147 };
148
149 let is_result_type = method.error_type.is_some();
150
151 crate::template_env::render(
152 "async_method_body.jinja",
153 context! {
154 method_name => name,
155 args_expr => args_expr,
156 string_params => string_params,
157 is_result_type => is_result_type,
158 core_import => &spec.core_import,
159 },
160 )
161 }
162
163 fn gen_constructor(&self, spec: &TraitBridgeSpec) -> String {
164 let wrapper = spec.wrapper_name();
165
166 crate::template_env::render(
167 "bridge_constructor.jinja",
168 context! {
169 wrapper => &wrapper,
170 },
171 )
172 }
173
174 fn gen_unregistration_fn(&self, spec: &TraitBridgeSpec) -> String {
175 let Some(unregister_fn) = spec.bridge_config.unregister_fn.as_deref() else {
176 return String::new();
177 };
178 let host_path = alef_codegen::generators::trait_bridge::host_function_path(spec, unregister_fn);
179
180 crate::template_env::render(
181 "bridge_unregister_fn.jinja",
182 context! {
183 unregister_fn => unregister_fn,
184 host_path => &host_path,
185 },
186 )
187 }
188
189 fn gen_clear_fn(&self, spec: &TraitBridgeSpec) -> String {
190 let Some(clear_fn) = spec.bridge_config.clear_fn.as_deref() else {
191 return String::new();
192 };
193 let host_path = alef_codegen::generators::trait_bridge::host_function_path(spec, clear_fn);
194
195 crate::template_env::render(
196 "bridge_clear_fn.jinja",
197 context! {
198 clear_fn => clear_fn,
199 host_path => &host_path,
200 },
201 )
202 }
203
204 fn gen_registration_fn(&self, spec: &TraitBridgeSpec) -> String {
205 let Some(register_fn) = spec.bridge_config.register_fn.as_deref() else {
206 return String::new();
207 };
208 let Some(registry_getter) = spec.bridge_config.registry_getter.as_deref() else {
209 return String::new();
210 };
211 let wrapper = spec.wrapper_name();
212 let trait_path = spec.trait_path();
213
214 let req_methods: Vec<&MethodDef> = spec.required_methods();
215 let required_methods: Vec<minijinja::Value> = req_methods
216 .iter()
217 .map(|m| {
218 minijinja::context! {
219 name => m.name.as_str(),
220 }
221 })
222 .collect();
223
224 let extra_args = spec
225 .bridge_config
226 .register_extra_args
227 .as_deref()
228 .map(|a| format!(", {a}"))
229 .unwrap_or_default();
230
231 crate::template_env::render(
232 "bridge_registration_fn.jinja",
233 context! {
234 register_fn => register_fn,
235 required_methods => required_methods,
236 wrapper => &wrapper,
237 trait_path => &trait_path,
238 registry_getter => registry_getter,
239 extra_args => &extra_args,
240 },
241 )
242 }
243}
244
245pub fn gen_trait_bridge(
247 trait_type: &TypeDef,
248 bridge_cfg: &TraitBridgeConfig,
249 core_import: &str,
250 error_type: &str,
251 error_constructor: &str,
252 api: &ApiSurface,
253) -> BridgeOutput {
254 let type_paths: HashMap<String, String> = api
256 .types
257 .iter()
258 .map(|t| (t.name.clone(), t.rust_path.replace('-', "_")))
259 .chain(
260 api.enums
261 .iter()
262 .map(|e| (e.name.clone(), e.rust_path.replace('-', "_"))),
263 )
264 .collect();
265
266 let is_visitor_bridge = bridge_cfg.type_alias.is_some()
268 && bridge_cfg.register_fn.is_none()
269 && bridge_cfg.super_trait.is_none()
270 && trait_type.methods.iter().all(|m| m.has_default_impl);
271
272 if is_visitor_bridge {
273 let struct_name = format!("Php{}Bridge", bridge_cfg.trait_name);
274 let trait_path = trait_type.rust_path.replace('-', "_");
275 let code = gen_visitor_bridge(trait_type, bridge_cfg, &struct_name, &trait_path, &type_paths);
276 BridgeOutput { imports: vec![], code }
277 } else {
278 let generator = PhpBridgeGenerator {
280 core_import: core_import.to_string(),
281 type_paths: type_paths.clone(),
282 error_type: error_type.to_string(),
283 };
284 let spec = TraitBridgeSpec {
285 trait_def: trait_type,
286 bridge_config: bridge_cfg,
287 core_import,
288 wrapper_prefix: "Php",
289 type_paths,
290 error_type: error_type.to_string(),
291 error_constructor: error_constructor.to_string(),
292 };
293 gen_bridge_all(&spec, &generator)
294 }
295}
296
297fn gen_visitor_bridge(
302 trait_type: &TypeDef,
303 _bridge_cfg: &TraitBridgeConfig,
304 struct_name: &str,
305 trait_path: &str,
306 type_paths: &HashMap<String, String>,
307) -> String {
308 let mut out = String::with_capacity(4096);
309 let core_crate = trait_path
310 .split("::")
311 .next()
312 .filter(|s| !s.is_empty())
313 .unwrap_or_else(|| panic!("trait_path '{trait_path}' must be a qualified path of the form 'crate_name::...'; configure extension_name in alef.toml"))
314 .to_string();
315
316 out.push_str(&crate::template_env::render(
318 "visitor_nodecontext_helper.jinja",
319 context! {
320 core_crate => &core_crate,
321 },
322 ));
323 out.push('\n');
324
325 out.push_str(&crate::template_env::render(
327 "visitor_zval_to_visitresult.jinja",
328 context! {
329 core_crate => &core_crate,
330 },
331 ));
332 out.push('\n');
333
334 out.push_str(&format!(
337 "fn php_visit_result_with_template(val: &ext_php_rs::types::Zval, tmpl_vars: &[(&str, &str)]) -> {core_crate}::VisitResult {{\n"
338 ));
339 out.push_str(" let base = php_zval_to_visit_result(val);\n");
340 out.push_str(&format!(
341 " if let {core_crate}::VisitResult::Custom(tmpl) = base {{\n"
342 ));
343 out.push_str(" let mut s = tmpl;\n");
344 out.push_str(" for (k, v) in tmpl_vars {\n");
345 out.push_str(" s = s.replace(&format!(\"{{{}}}\", k), v);\n");
348 out.push_str(" }\n");
349 out.push_str(&format!(" {core_crate}::VisitResult::Custom(s)\n"));
350 out.push_str(" } else {\n");
351 out.push_str(" base\n");
352 out.push_str(" }\n");
353 out.push_str("}\n\n");
354
355 out.push_str(&crate::template_env::render(
357 "visitor_bridge_struct.jinja",
358 context! {
359 struct_name => struct_name,
360 },
361 ));
362 out.push('\n');
363
364 out.push_str(&format!("impl {trait_path} for {struct_name} {{\n"));
366 for method in &trait_type.methods {
367 if method.trait_source.is_some() {
368 continue;
369 }
370 gen_visitor_method_php(&mut out, method, type_paths);
371 }
372 out.push_str("}\n");
373 out.push('\n');
374
375 out
376}
377
378fn gen_visitor_method_php(out: &mut String, method: &MethodDef, type_paths: &HashMap<String, String>) {
380 let name = &method.name;
381
382 let mut sig_parts = vec!["&mut self".to_string()];
383 for p in &method.params {
384 let ty_str = visitor_param_type(&p.ty, p.is_ref, p.optional, type_paths);
385 sig_parts.push(format!("{}: {}", p.name, ty_str));
386 }
387 let sig = sig_parts.join(", ");
388
389 let ret_ty = match &method.return_type {
390 TypeRef::Named(n) => type_paths.get(n).cloned().unwrap_or_else(|| n.clone()),
391 other => param_type(other, "", false, type_paths),
392 };
393
394 out.push_str(&format!(" fn {name}({sig}) -> {ret_ty} {{\n"));
395
396 out.push_str(" // SAFETY: php_obj is a valid ZendObject pointer for the duration of this call.\n");
398 out.push_str(" let php_obj_ref = unsafe { &mut *self.php_obj };\n");
399
400 let has_args = !method.params.is_empty();
402 if has_args {
403 out.push_str(" let mut args: Vec<ext_php_rs::types::Zval> = Vec::new();\n");
404 for p in &method.params {
405 if let TypeRef::Named(n) = &p.ty {
406 if n == "NodeContext" {
407 out.push_str(&format!(
408 " let ctx_arr = nodecontext_to_php_array({}{});\n",
409 if p.is_ref { "" } else { "&" },
410 p.name
411 ));
412 out.push_str(" args.push(ext_php_rs::convert::IntoZval::into_zval(ctx_arr, false).unwrap_or_default());\n");
413 continue;
414 }
415 }
416 if p.optional && matches!(&p.ty, TypeRef::String) && p.is_ref {
419 out.push_str(&format!(
420 " args.push(match {0} {{ Some(s) => ext_php_rs::types::Zval::try_from(s.to_string()).unwrap_or_default(), None => ext_php_rs::types::Zval::new() }});\n",
421 p.name
422 ));
423 continue;
424 }
425 if matches!(&p.ty, TypeRef::String) {
426 if p.is_ref {
427 out.push_str(&format!(
428 " args.push(ext_php_rs::types::Zval::try_from({}.to_string()).unwrap_or_default());\n",
429 p.name
430 ));
431 } else {
432 out.push_str(&format!(
433 " args.push(ext_php_rs::types::Zval::try_from({}.clone()).unwrap_or_default());\n",
434 p.name
435 ));
436 }
437 continue;
438 }
439 if matches!(&p.ty, TypeRef::Primitive(alef_core::ir::PrimitiveType::Bool)) {
440 out.push_str(&format!(
441 " {{ let mut _zv = ext_php_rs::types::Zval::new(); _zv.set_bool({}); args.push(_zv); }}\n",
442 p.name
443 ));
444 continue;
445 }
446 out.push_str(&format!(
448 " args.push(ext_php_rs::types::Zval::try_from(format!(\"{{:?}}\", {})).unwrap_or_default());\n",
449 p.name
450 ));
451 }
452 }
453
454 if has_args {
458 out.push_str(" let dyn_args: Vec<&dyn ext_php_rs::convert::IntoZvalDyn> = args.iter().map(|z| z as &dyn ext_php_rs::convert::IntoZvalDyn).collect();\n");
459 }
460 let args_expr = if has_args { "dyn_args" } else { "vec![]" };
461 out.push_str(&format!(
462 " let result = php_obj_ref.try_call_method(\"{name}\", {args_expr});\n"
463 ));
464
465 let mut tmpl_var_names: Vec<String> = Vec::new();
468 for p in &method.params {
469 if let TypeRef::Named(n) = &p.ty {
470 if n == "NodeContext" {
471 continue;
472 }
473 }
474 if matches!(&p.ty, TypeRef::Vec(_)) {
476 continue;
477 }
478 let key = p.name.strip_prefix('_').unwrap_or(&p.name);
480 let owned_var = format!("_{key}_s");
481 let expr: String = if p.optional && matches!(&p.ty, TypeRef::String) && p.is_ref {
482 format!("{}.map(|s| s.to_string()).unwrap_or_default()", p.name)
483 } else if matches!(&p.ty, TypeRef::String) && p.is_ref {
484 format!("{}.to_string()", p.name)
485 } else if matches!(&p.ty, TypeRef::String) {
486 format!("{}.clone()", p.name)
487 } else if matches!(&p.ty, TypeRef::Optional(_)) {
488 format!("{}.map(|v| v.to_string()).unwrap_or_default()", p.name)
489 } else {
490 format!("{}.to_string()", p.name)
491 };
492 writeln!(out, " let {owned_var}: String = {expr};").unwrap();
493 tmpl_var_names.push(format!("(\"{key}\", {owned_var}.as_str())"));
494 }
495 let tmpl_vars_expr = if tmpl_var_names.is_empty() {
496 "&[]".to_string()
497 } else {
498 format!("&[{}]", tmpl_var_names.join(", "))
499 };
500
501 out.push_str(" match result {\n");
503 out.push_str(&format!(" Err(_) => {ret_ty}::Continue,\n"));
504 out.push_str(&format!(
505 " Ok(val) => php_visit_result_with_template(&val, {tmpl_vars_expr}),\n"
506 ));
507 out.push_str(" }\n");
508 out.push_str(" }\n");
509 out.push('\n');
510}
511
512#[allow(clippy::too_many_arguments)]
515pub fn gen_bridge_function(
516 func: &alef_core::ir::FunctionDef,
517 bridge_param_idx: usize,
518 bridge_cfg: &TraitBridgeConfig,
519 mapper: &dyn alef_codegen::type_mapper::TypeMapper,
520 opaque_types: &ahash::AHashSet<String>,
521 core_import: &str,
522) -> String {
523 use alef_core::ir::TypeRef;
524
525 let struct_name = format!("Php{}Bridge", bridge_cfg.trait_name);
526 let handle_path = format!("{core_import}::visitor::VisitorHandle");
527 let param_name = &func.params[bridge_param_idx].name;
528 let bridge_param = &func.params[bridge_param_idx];
529 let is_optional = bridge_param.optional || matches!(&bridge_param.ty, TypeRef::Optional(_));
530
531 let mut sig_parts = Vec::new();
533 for (idx, p) in func.params.iter().enumerate() {
534 if idx == bridge_param_idx {
535 let php_obj_ty = "&mut ext_php_rs::types::ZendObject";
539 if is_optional {
540 sig_parts.push(format!("{}: Option<{php_obj_ty}>", p.name));
541 } else {
542 sig_parts.push(format!("{}: {php_obj_ty}", p.name));
543 }
544 } else {
545 let promoted = idx > bridge_param_idx || func.params[..idx].iter().any(|pp| pp.optional);
546 let base = mapper.map_type(&p.ty);
547 let ty = match &p.ty {
550 TypeRef::Named(n) if !opaque_types.contains(n.as_str()) => {
551 if p.optional || promoted {
552 format!("Option<&mut {base}>")
553 } else {
554 format!("&mut {base}")
555 }
556 }
557 TypeRef::Optional(inner) => {
558 if let TypeRef::Named(n) = inner.as_ref() {
559 if !opaque_types.contains(n.as_str()) {
560 format!("Option<&mut {base}>")
561 } else if p.optional || promoted {
562 format!("Option<{base}>")
563 } else {
564 base
565 }
566 } else if p.optional || promoted {
567 format!("Option<{base}>")
568 } else {
569 base
570 }
571 }
572 _ => {
573 if p.optional || promoted {
574 format!("Option<{base}>")
575 } else {
576 base
577 }
578 }
579 };
580 sig_parts.push(format!("{}: {}", p.name, ty));
581 }
582 }
583
584 let params_str = sig_parts.join(", ");
585 let return_type = mapper.map_type(&func.return_type);
586 let ret = mapper.wrap_return(&return_type, func.error_type.is_some());
587
588 let err_conv = ".map_err(|e| ext_php_rs::exception::PhpException::default(e.to_string()))";
589
590 let bridge_wrap = if is_optional {
592 format!(
593 "let {param_name} = {param_name}.map(|v| {{\n \
594 let bridge = {struct_name}::new(v);\n \
595 std::rc::Rc::new(std::cell::RefCell::new(bridge)) as {handle_path}\n \
596 }});"
597 )
598 } else {
599 format!(
600 "let {param_name} = {{\n \
601 let bridge = {struct_name}::new({param_name});\n \
602 std::rc::Rc::new(std::cell::RefCell::new(bridge)) as {handle_path}\n \
603 }};"
604 )
605 };
606
607 let serde_bindings: String = func
609 .params
610 .iter()
611 .enumerate()
612 .filter(|(idx, p)| {
613 if *idx == bridge_param_idx {
614 return false;
615 }
616 let named = match &p.ty {
617 TypeRef::Named(n) => Some(n.as_str()),
618 TypeRef::Optional(inner) => {
619 if let TypeRef::Named(n) = inner.as_ref() {
620 Some(n.as_str())
621 } else {
622 None
623 }
624 }
625 _ => None,
626 };
627 named.is_some_and(|n| !opaque_types.contains(n))
628 })
629 .map(|(_, p)| {
630 let name = &p.name;
631 let core_path = format!(
632 "{core_import}::{}",
633 match &p.ty {
634 TypeRef::Named(n) => n.clone(),
635 TypeRef::Optional(inner) =>
636 if let TypeRef::Named(n) = inner.as_ref() {
637 n.clone()
638 } else {
639 String::new()
640 },
641 _ => String::new(),
642 }
643 );
644 if p.optional || matches!(&p.ty, TypeRef::Optional(_)) {
645 format!(
646 "let {name}_core: Option<{core_path}> = {name}.map(|v| {{\n \
647 let json = serde_json::to_string(&v){err_conv}?;\n \
648 serde_json::from_str(&json){err_conv}\n \
649 }}).transpose()?;\n "
650 )
651 } else {
652 format!(
653 "let {name}_json = serde_json::to_string(&{name}){err_conv}?;\n \
654 let {name}_core: {core_path} = serde_json::from_str(&{name}_json){err_conv}?;\n "
655 )
656 }
657 })
658 .collect();
659
660 let call_args: Vec<String> = func
662 .params
663 .iter()
664 .enumerate()
665 .map(|(idx, p)| {
666 if idx == bridge_param_idx {
667 return p.name.clone();
668 }
669 match &p.ty {
670 TypeRef::Named(n) if opaque_types.contains(n.as_str()) => {
671 if p.optional {
672 format!("{}.as_ref().map(|v| &v.inner)", p.name)
673 } else {
674 format!("&{}.inner", p.name)
675 }
676 }
677 TypeRef::Named(_) => format!("{}_core", p.name),
678 TypeRef::Optional(inner) => {
679 if let TypeRef::Named(n) = inner.as_ref() {
680 if opaque_types.contains(n.as_str()) {
681 format!("{}.as_ref().map(|v| &v.inner)", p.name)
682 } else {
683 format!("{}_core", p.name)
684 }
685 } else {
686 p.name.clone()
687 }
688 }
689 TypeRef::String | TypeRef::Char => {
690 if p.is_ref {
691 format!("&{}", p.name)
692 } else {
693 p.name.clone()
694 }
695 }
696 _ => p.name.clone(),
697 }
698 })
699 .collect();
700 let call_args_str = call_args.join(", ");
701
702 let core_fn_path = {
703 let path = func.rust_path.replace('-', "_");
704 if path.starts_with(core_import) {
705 path
706 } else {
707 format!("{core_import}::{}", func.name)
708 }
709 };
710 let core_call = format!("{core_fn_path}({call_args_str})");
711
712 let return_wrap = match &func.return_type {
713 TypeRef::Named(name) if opaque_types.contains(name.as_str()) => {
714 format!("{name} {{ inner: std::sync::Arc::new(val) }}")
715 }
716 TypeRef::Named(_) => "val.into()".to_string(),
717 TypeRef::String | TypeRef::Bytes => "val.into()".to_string(),
718 _ => "val".to_string(),
719 };
720
721 let body = if func.error_type.is_some() {
722 if return_wrap == "val" {
723 format!("{bridge_wrap}\n {serde_bindings}{core_call}{err_conv}")
724 } else {
725 format!("{bridge_wrap}\n {serde_bindings}{core_call}.map(|val| {return_wrap}){err_conv}")
726 }
727 } else {
728 format!("{bridge_wrap}\n {serde_bindings}{core_call}")
729 };
730
731 let func_name = &func.name;
732 let mut out = String::with_capacity(1024);
733 if func.error_type.is_some() {
734 out.push_str("#[allow(clippy::missing_errors_doc)]\n");
735 }
736 out.push_str(&format!("pub fn {func_name}({params_str}) -> {ret} {{\n"));
737 out.push_str(&format!(" {body}\n"));
738 out.push_str("}\n");
739
740 out
741}