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
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
//! Decision layer for the C# backend. `CSharpLowerer` walks the
//! `FfiContract` + `AbiContract` IR and produces a `CSharpModule`,
//! the plan the templates render.
//!
//! Every policy decision lives here:
//!
//! - Which records and enums are supported (a joint fixed-point that
//! admits mutually-recursive types together).
//! - Whether a value rides the direct P/Invoke path or the wire-
//! encoded path (blittable records + C-style enums vs. data enums,
//! strings, vecs, options, non-blittable records).
//! - How each param is marshalled (`CSharpParamKind`) and how each
//! return is delivered (`CSharpReturnKind`).
use std::collections::HashSet;
use boltffi_ffi_rules::naming;
use crate::ir::abi::{
AbiCall, AbiEnum, AbiEnumField, AbiEnumPayload, AbiEnumVariant, AbiParam, AbiRecord, CallId,
ParamRole,
};
use crate::ir::codec::{EnumLayout, VecLayout};
use crate::ir::definitions::{
ConstructorDef, EnumDef, EnumRepr, FieldDef, FunctionDef, MethodDef, ParamDef, ParamPassing,
Receiver, RecordDef, ReturnDef, VariantPayload,
};
use crate::ir::ids::{EnumId, FieldName, RecordId};
use crate::ir::ops::{FieldWriteOp, ReadOp, ReadSeq, SizeExpr, ValueExpr, WriteOp, WriteSeq};
use crate::ir::types::TypeExpr;
use crate::ir::{AbiContract, FfiContract};
use super::emit;
use super::plan::{
CSharpEnum, CSharpEnumKind, CSharpEnumVariant, CSharpFunction, CSharpMethod, CSharpModule,
CSharpParam, CSharpParamKind, CSharpReceiver, CSharpRecord, CSharpRecordField,
CSharpReturnKind, CSharpType, CSharpWireWriter, ShadowScope,
};
use super::{CSharpOptions, NamingConvention};
/// Transforms the language-agnostic [`FfiContract`] and [`AbiContract`] into
/// a [`CSharpModule`] containing everything the C# templates need to render.
pub struct CSharpLowerer<'a> {
ffi: &'a FfiContract,
abi: &'a AbiContract,
options: &'a CSharpOptions,
/// Records that are fully supported: every field resolves to a type the
/// C# backend can currently render. Populated up front because whether
/// a record is supported can depend on whether *other* records are
/// supported, so we need a fixed-point pass before lowering individual
/// functions or records.
supported_records: HashSet<String>,
/// Enums that are fully supported. An enum qualifies when every
/// variant's payload fields resolve to supported types. C-style
/// variants have no fields and are trivially admitted.
supported_enums: HashSet<String>,
}
impl<'a> CSharpLowerer<'a> {
pub fn new(ffi: &'a FfiContract, abi: &'a AbiContract, options: &'a CSharpOptions) -> Self {
let (supported_records, supported_enums) = Self::compute_supported_sets(ffi);
Self {
ffi,
abi,
options,
supported_records,
supported_enums,
}
}
/// Computes which records and enums the backend can render, jointly.
///
/// Records and enums can reference each other in either direction:
/// a record field may be a data enum, and a data-enum variant field
/// may be a record. Neither set can be computed independently, so
/// both grow together in one fixed-point loop. Each iteration tries
/// to admit every not-yet-supported record and every not-yet-supported
/// data enum against the current state of both sets, terminating when
/// a pass produces no new admissions. C-style enums have no payload,
/// so any whose repr is a legal C# enum backing type seed the enum set
/// before iteration begins.
///
/// Termination: every non-breaking iteration admits at least one new
/// record or data enum; both catalogs are finite; admissions are
/// monotonic. Mutually recursive types that require each other to be
/// admitted first never make progress: the first pass finds neither
/// admissible, no admissions are made, and the loop exits leaving
/// both out of the supported sets.
fn compute_supported_sets(ffi: &FfiContract) -> (HashSet<String>, HashSet<String>) {
let mut enums: HashSet<String> = ffi
.catalog
.all_enums()
.filter(|e| match &e.repr {
EnumRepr::CStyle { tag_type, .. } => {
CSharpType::enum_backing_for(*tag_type).is_some()
}
EnumRepr::Data { .. } => false,
})
.map(|e| e.id.as_str().to_string())
.collect();
let mut records: HashSet<String> = HashSet::new();
loop {
let record_additions: Vec<String> = ffi
.catalog
.all_records()
.filter(|r| !records.contains(r.id.as_str()))
.filter(|r| {
r.fields
.iter()
.all(|f| Self::is_field_type_supported(&f.type_expr, &records, &enums))
})
.map(|r| r.id.as_str().to_string())
.collect();
let enum_additions: Vec<String> = ffi
.catalog
.all_enums()
.filter(|e| matches!(e.repr, EnumRepr::Data { .. }))
.filter(|e| !enums.contains(e.id.as_str()))
.filter(|e| Self::enum_variant_fields_supported(e, &records, &enums))
.map(|e| e.id.as_str().to_string())
.collect();
if record_additions.is_empty() && enum_additions.is_empty() {
break;
}
records.extend(record_additions);
enums.extend(enum_additions);
}
(records, enums)
}
fn enum_variant_fields_supported(
enum_def: &EnumDef,
records: &HashSet<String>,
enums: &HashSet<String>,
) -> bool {
let EnumRepr::Data { variants, .. } = &enum_def.repr else {
return true;
};
variants.iter().all(|v| match &v.payload {
VariantPayload::Unit => true,
VariantPayload::Tuple(types) => types
.iter()
.all(|t| Self::is_field_type_supported(t, records, enums)),
VariantPayload::Struct(fields) => fields
.iter()
.all(|f| Self::is_field_type_supported(&f.type_expr, records, enums)),
})
}
fn is_field_type_supported(
ty: &TypeExpr,
records: &HashSet<String>,
enums: &HashSet<String>,
) -> bool {
match ty {
TypeExpr::Primitive(_) | TypeExpr::String | TypeExpr::Void => true,
TypeExpr::Record(id) => records.contains(id.as_str()),
TypeExpr::Enum(id) => enums.contains(id.as_str()),
// Vec as a field walks its inner type through the same
// admission rules: any field-admissible type is also a valid
// Vec element, and vice versa.
TypeExpr::Vec(inner) => Self::is_field_type_supported(inner, records, enums),
// C# models `Option<T>` as `T?`, so `Option<Option<T>>`
// would need `T??`, which the language rejects and which
// cannot be flattened without losing the `Some(None)` state.
TypeExpr::Option(inner) => {
!matches!(inner.as_ref(), TypeExpr::Option(_))
&& Self::is_field_type_supported(inner, records, enums)
}
_ => false,
}
}
/// Walk the contracts and produce a C# module plan.
pub fn lower(&self) -> CSharpModule {
let lib_name = self
.options
.library_name
.clone()
.unwrap_or_else(|| naming::library_name(&self.ffi.package.name));
let class_name = NamingConvention::class_name(&self.ffi.package.name);
let namespace = NamingConvention::namespace(&self.ffi.package.name);
let prefix = naming::ffi_prefix().to_string();
let records: Vec<CSharpRecord> = self
.ffi
.catalog
.all_records()
.filter(|r| self.supported_records.contains(r.id.as_str()))
.map(|r| self.lower_record(r))
.collect();
let enums: Vec<CSharpEnum> = self
.ffi
.catalog
.all_enums()
.filter_map(|e| self.lower_enum(e))
.collect();
let functions: Vec<CSharpFunction> = self
.ffi
.functions
.iter()
.filter_map(|f| self.lower_function(f))
.collect();
CSharpModule {
namespace,
class_name,
lib_name,
prefix,
records,
enums,
functions,
}
}
/// Converts a Rust FFI function definition into its C# representation,
/// mapping Rust types to C# types and snake_case names to PascalCase.
///
/// Returns `None` for functions whose signatures include types not yet
/// supported by the C# backend.
fn lower_function(&self, function: &FunctionDef) -> Option<CSharpFunction> {
if function.is_async() {
return None;
}
if !function.params.iter().all(|p| self.is_supported_param(p)) {
return None;
}
let return_type = self.lower_return(&function.returns)?;
let call = self.abi_call_for_function(function)?;
let return_kind = self.return_kind(
&function.returns,
&return_type,
call.returns.decode_ops.as_ref(),
None,
);
let wire_writers = self.wire_writers_for_params(function)?;
let params: Vec<CSharpParam> = function
.params
.iter()
.map(|p| self.lower_param(p, &wire_writers))
.collect::<Option<Vec<_>>>()?;
Some(CSharpFunction {
name: NamingConvention::method_name(function.id.as_str()),
ffi_name: naming::function_ffi_name(function.id.as_str()).into_string(),
params,
return_type,
return_kind,
wire_writers,
})
}
fn return_kind(
&self,
return_def: &ReturnDef,
return_type: &CSharpType,
decode_ops: Option<&ReadSeq>,
scope: Option<&ShadowScope>,
) -> CSharpReturnKind {
if return_type.is_void() {
return CSharpReturnKind::Void;
}
match return_def {
ReturnDef::Value(TypeExpr::String) => CSharpReturnKind::WireDecodeString,
ReturnDef::Value(TypeExpr::Record(id)) if !self.is_blittable_record(id) => {
CSharpReturnKind::WireDecodeObject {
class_name: NamingConvention::class_name(id.as_str()),
}
}
ReturnDef::Value(TypeExpr::Enum(id)) if self.is_data_enum(id) => {
CSharpReturnKind::WireDecodeObject {
class_name: NamingConvention::class_name(id.as_str()),
}
}
ReturnDef::Value(TypeExpr::Vec(inner)) => {
let reader_call = match inner.as_ref() {
TypeExpr::Primitive(p) => emit::primitive_vec_reader_call(*p),
TypeExpr::Record(id) if self.is_blittable_record(id) => format!(
"ReadBlittableArray<{}>()",
NamingConvention::class_name(id.as_str())
),
_ => {
let element_seq = Self::vec_element_read_seq(decode_ops)
.expect("encoded Vec return must carry decode_ops with a Vec ReadOp");
emit::vec_return_reader_call(inner, &element_seq)
}
};
CSharpReturnKind::WireDecodeArray { reader_call }
}
ReturnDef::Value(TypeExpr::Option(_)) => {
// Fully pre-render the decode expression against a
// reader named `reader`. The ABI's decode_ops walks
// every inner shape (primitive, string, record, enum,
// vec) so one helper covers the whole matrix.
let decode_seq = decode_ops
.expect("Option return must carry decode_ops")
.clone();
let decode_expr = emit::emit_reader_read(&decode_seq, scope);
CSharpReturnKind::WireDecodeOption { decode_expr }
}
// Primitives, bools, blittable records, and C-style enums
// are all direct: the CLR marshals them across P/Invoke
// without any wrapper help.
_ => CSharpReturnKind::Direct,
}
}
/// Extract the per-element [`ReadSeq`] from a `ReadSeq` whose top op is
/// a `Vec`. Used to render the inner decode expression that gets wrapped
/// in `ReadEncodedArray<T>(r => ...)`. Primitive-element Vec returns
/// never call into this; they short-circuit on the no-prefix fast path.
fn vec_element_read_seq(decode_ops: Option<&ReadSeq>) -> Option<ReadSeq> {
let decode = decode_ops?;
match decode.ops.first()? {
ReadOp::Vec { element, .. } => Some((**element).clone()),
_ => None,
}
}
fn is_data_enum(&self, id: &EnumId) -> bool {
self.ffi
.catalog
.resolve_enum(id)
.is_some_and(|e| matches!(e.repr, EnumRepr::Data { .. }))
}
/// Whether the record rides across P/Invoke by value with
/// `[StructLayout(Sequential)]` and no wire encoding. Defers entirely
/// to the IR's `is_blittable` flag, which admits all-primitive
/// `#[repr(C)]` records only. A record that carries any user-defined
/// type (record or enum, C-style or data) stays on the wire path.
/// The Rust `#[export]` macro (see `boltffi_macros::data::analysis`)
/// makes the same call, so the two sides agree on whether a given
/// FFI symbol returns a value or an `FfiBuf`. Widening C#'s view
/// without teaching the macro would produce a call-site / ABI
/// mismatch and segfault at runtime.
fn is_blittable_record(&self, id: &RecordId) -> bool {
self.abi_record_for(id).is_some_and(|r| r.is_blittable)
}
fn is_supported_param(&self, param: &ParamDef) -> bool {
param.passing == ParamPassing::Value && self.is_supported_type(¶m.type_expr)
}
fn is_supported_type(&self, ty: &TypeExpr) -> bool {
match ty {
TypeExpr::Primitive(_) | TypeExpr::String | TypeExpr::Void => true,
TypeExpr::Record(id) => self.supported_records.contains(id.as_str()),
TypeExpr::Enum(id) => self.supported_enums.contains(id.as_str()),
TypeExpr::Vec(inner) => self.is_supported_vec_element(inner),
TypeExpr::Option(inner) => {
!matches!(inner.as_ref(), TypeExpr::Option(_)) && self.is_supported_type(inner)
}
_ => false,
}
}
/// Which element types the C# backend currently admits inside a
/// top-level `Vec<_>` param or return. This is only the admission
/// gate: primitives and blittable records can use the blittable
/// path; strings, enums, non-blittable records, and nested vecs
/// travel through the encoded wire form.
fn is_supported_vec_element(&self, ty: &TypeExpr) -> bool {
match ty {
TypeExpr::Primitive(_) | TypeExpr::String => true,
TypeExpr::Record(id) => self.supported_records.contains(id.as_str()),
TypeExpr::Enum(id) => self.supported_enums.contains(id.as_str()),
TypeExpr::Vec(inner) => self.is_supported_vec_element(inner),
TypeExpr::Option(inner) => {
!matches!(inner.as_ref(), TypeExpr::Option(_))
&& self.is_supported_vec_element(inner)
}
_ => false,
}
}
/// Vec element types whose param form is a pinned `T[]` passed
/// directly across P/Invoke. Primitives qualify because their C#
/// mapping is a blittable value type; blittable records qualify
/// because `[StructLayout(Sequential)]` guarantees the same byte
/// layout as Rust's `#[repr(C)]`, so the CLR can hand the native
/// side a pointer straight into the element buffer. C-style enums
/// do NOT qualify even though their C# projection is a fixed-width
/// value type: the Rust `#[export]` macro classifies them as
/// `DataTypeCategory::Scalar` and routes `Vec<CStyleEnum>` through
/// the wire-encoded path (only `Blittable` survives the macro's
/// `supports_direct_vec` gate). Admitting them here would hand the
/// native side a raw enum byte array where it expects a
/// length-prefixed encoded array of I32 tags. Everything not
/// listed rides the wire-encoded path. Tracked: issue #196.
fn is_blittable_vec_element(&self, ty: &TypeExpr) -> bool {
match ty {
TypeExpr::Primitive(_) => true,
TypeExpr::Record(id) => self.is_blittable_record(id),
_ => false,
}
}
fn lower_param(
&self,
param: &ParamDef,
wire_writers: &[CSharpWireWriter],
) -> Option<CSharpParam> {
if param.passing != ParamPassing::Value {
return None;
}
let csharp_type = self.lower_type(¶m.type_expr)?;
let kind = match ¶m.type_expr {
TypeExpr::String => CSharpParamKind::Utf8Bytes,
TypeExpr::Record(id) if !self.is_blittable_record(id) => {
let writer = wire_writers
.iter()
.find(|w| w.param_name == param.name.as_str())?;
CSharpParamKind::WireEncoded {
binding_name: writer.bytes_binding_name.clone(),
}
}
TypeExpr::Enum(id) if self.is_data_enum(id) => {
let writer = wire_writers
.iter()
.find(|w| w.param_name == param.name.as_str())?;
CSharpParamKind::WireEncoded {
binding_name: writer.bytes_binding_name.clone(),
}
}
TypeExpr::Vec(inner) if matches!(inner.as_ref(), TypeExpr::Primitive(_)) => {
CSharpParamKind::DirectArray
}
TypeExpr::Vec(inner) if self.is_blittable_vec_element(inner) => {
// Primitive arrays can use the CLR's built-in direct-array
// path. Record arrays are less predictable once the element
// type stops being blittable to the marshaller, e.g. because
// it contains `bool` or `char`: P/Invoke may marshal through
// a temporary native buffer rather than exposing the managed
// array in place. `fixed` keeps this path zero-copy and
// makes the ABI contract explicit: Rust reads the actual
// managed element buffer, not a marshaled surrogate.
let element_type = match inner.as_ref() {
TypeExpr::Record(id) => NamingConvention::class_name(id.as_str()),
other => todo!(
"C# backend pinned-array param support not yet implemented for {other:?}"
),
};
CSharpParamKind::PinnedArray { element_type }
}
TypeExpr::Vec(inner) if self.is_supported_vec_element(inner) => {
// Vec<String> and Vec<Vec<_>> carry variable-width elements, so
// the param travels wire-encoded rather than as a pinned T[].
let writer = wire_writers
.iter()
.find(|w| w.param_name == param.name.as_str())?;
CSharpParamKind::WireEncoded {
binding_name: writer.bytes_binding_name.clone(),
}
}
TypeExpr::Option(_) => {
// Options are always wire-encoded: the 1-byte tag plus an
// optional payload does not line up with any CLR
// primitive layout.
let writer = wire_writers
.iter()
.find(|w| w.param_name == param.name.as_str())?;
CSharpParamKind::WireEncoded {
binding_name: writer.bytes_binding_name.clone(),
}
}
// Primitives, bools, blittable records, and C-style enums
// pass directly. The CLR marshals them across P/Invoke with
// no extra setup.
_ => CSharpParamKind::Direct,
};
Some(CSharpParam {
name: NamingConvention::field_name(param.name.as_str()),
csharp_type,
kind,
})
}
fn lower_return(&self, return_def: &ReturnDef) -> Option<CSharpType> {
match return_def {
ReturnDef::Void => Some(CSharpType::Void),
ReturnDef::Value(type_expr) => self.lower_type(type_expr),
ReturnDef::Result { .. } => None,
}
}
fn lower_type(&self, type_expr: &TypeExpr) -> Option<CSharpType> {
match type_expr {
TypeExpr::Void => Some(CSharpType::Void),
TypeExpr::Primitive(primitive) => Some(CSharpType::from(*primitive)),
TypeExpr::String => Some(CSharpType::String),
TypeExpr::Record(id) if self.supported_records.contains(id.as_str()) => Some(
CSharpType::Record(NamingConvention::class_name(id.as_str())),
),
TypeExpr::Enum(id) if self.supported_enums.contains(id.as_str()) => {
let enum_def = self.ffi.catalog.resolve_enum(id)?;
Some(CSharpType::for_enum(enum_def))
}
TypeExpr::Vec(inner) if self.is_supported_vec_element(inner) => {
let inner_type = self.lower_type(inner)?;
Some(CSharpType::Array(Box::new(inner_type)))
}
TypeExpr::Option(inner) => {
let inner_type = self.lower_type(inner)?;
Some(CSharpType::Nullable(Box::new(inner_type)))
}
_ => None,
}
}
fn lower_record(&self, record: &RecordDef) -> CSharpRecord {
let class_name = NamingConvention::class_name(record.id.as_str());
// Share one emit context across all fields so pattern-binding
// names (e.g. `sizeOpt0`, `opt0`) stay unique within the
// generated `WireEncodedSize` and `WireEncodeTo` method
// bodies. Otherwise two optional fields would each try to
// declare `sizeOpt0` in the same enclosing scope.
let mut size_ctx = emit::CSharpEmitContext::default();
let mut encode_ctx = emit::CSharpEmitContext::default();
let mut decode_ctx = emit::CSharpEmitContext::default();
let fields = record
.fields
.iter()
.map(|field| {
self.lower_record_field(
&record.id,
field,
&mut size_ctx,
&mut encode_ctx,
&mut decode_ctx,
)
})
.collect();
let is_blittable = self.is_blittable_record(&record.id);
CSharpRecord {
class_name,
fields,
is_blittable,
}
}
/// Lowers a Rust enum definition into the C# plan, or returns `None`
/// when the enum is not in the supported set.
///
/// The two `EnumRepr` arms carry different numbering semantics:
///
/// - **C-style enums** render as `public enum X : Backing`. Each C#
/// member's numeric value IS the Rust discriminant, because the
/// value crosses P/Invoke as its backing primitive and must be
/// bit-for-bit identical on both sides. Gapped or negative
/// discriminants must be preserved.
/// - **Data enums** render as nested `sealed record` variants
/// dispatched by a wire tag. Tags come from the variant's ordinal
/// position (`EnumTagStrategy::OrdinalIndex`). The Rust
/// discriminant is not part of the codec.
fn lower_enum(&self, enum_def: &EnumDef) -> Option<CSharpEnum> {
if !self.supported_enums.contains(enum_def.id.as_str()) {
return None;
}
let class_name = NamingConvention::class_name(enum_def.id.as_str());
// Variant names become nested `sealed record` types; inside the
// abstract record's body they shadow any module-level type sharing
// a name. Collect the set so emit helpers can qualify outer
// references (`Demo.Point.Decode(reader)`) instead of letting them
// resolve to the shadowing variant. Only data enums introduce
// a nested body where shadowing applies.
let abi_enum_for_data = match &enum_def.repr {
EnumRepr::Data { .. } => self.abi.enums.iter().find(|e| e.id == enum_def.id),
_ => None,
};
let shadowed_variant_names: HashSet<String> = abi_enum_for_data
.map(|abi_enum| {
abi_enum
.variants
.iter()
.map(|v| NamingConvention::class_name(v.name.as_str()))
.collect()
})
.unwrap_or_default();
let namespace = NamingConvention::namespace(&self.ffi.package.name);
let method_scope = abi_enum_for_data.map(|_| ShadowScope {
shadowed: &shadowed_variant_names,
namespace: &namespace,
});
let methods = self.lower_enum_methods(enum_def, &class_name, method_scope.as_ref());
match &enum_def.repr {
EnumRepr::CStyle { tag_type, variants } => {
let lowered_variants = variants
.iter()
.enumerate()
.map(|(ordinal, variant)| CSharpEnumVariant {
name: NamingConvention::class_name(variant.name.as_str()),
tag: variant.discriminant as i32,
wire_tag: ordinal as i32,
fields: Vec::new(),
})
.collect();
Some(CSharpEnum {
class_name,
kind: CSharpEnumKind::CStyle,
c_style_tag_type: Some(*tag_type),
variants: lowered_variants,
methods,
})
}
EnumRepr::Data { .. } => {
let abi_enum = abi_enum_for_data?;
let scope = ShadowScope {
shadowed: &shadowed_variant_names,
namespace: &namespace,
};
// Share one encode/size context across all variants of
// this enum because `WireEncodedSize` and `WireEncodeTo`
// render all variant fields inside one method body
// (via a switch statement). A separate decode context
// keeps decode rendering independent. `Decode` builds
// each variant in its own constructor call so no
// pattern-binding leakage happens across variants.
let mut size_ctx = emit::CSharpEmitContext::default();
let mut encode_ctx = emit::CSharpEmitContext::default();
let mut decode_ctx = emit::CSharpEmitContext::default();
let variants = abi_enum
.variants
.iter()
.enumerate()
.map(|(ordinal, variant)| {
self.lower_data_enum_variant(
abi_enum,
variant,
ordinal,
&scope,
&mut size_ctx,
&mut encode_ctx,
&mut decode_ctx,
)
})
.collect();
Some(CSharpEnum {
class_name,
kind: CSharpEnumKind::Data,
c_style_tag_type: None,
variants,
methods,
})
}
}
}
#[allow(clippy::too_many_arguments)]
fn lower_data_enum_variant(
&self,
abi_enum: &AbiEnum,
variant: &AbiEnumVariant,
ordinal: usize,
scope: &ShadowScope,
size_ctx: &mut emit::CSharpEmitContext,
encode_ctx: &mut emit::CSharpEmitContext,
decode_ctx: &mut emit::CSharpEmitContext,
) -> CSharpEnumVariant {
let tag = abi_enum.resolve_codec_tag(ordinal, variant.discriminant) as i32;
let fields = match &variant.payload {
AbiEnumPayload::Unit => Vec::new(),
AbiEnumPayload::Tuple(fields) | AbiEnumPayload::Struct(fields) => fields
.iter()
.map(|f| self.lower_variant_field(f, scope, size_ctx, encode_ctx, decode_ctx))
.collect(),
};
CSharpEnumVariant {
name: NamingConvention::class_name(variant.name.as_str()),
tag,
// For data enums the public surface is a `sealed record`,
// not a numbered enum, so `tag` and `wire_tag` converge:
// both are the ordinal dispatch value used on the wire.
wire_tag: tag,
fields,
}
}
/// Lowers one variant payload field. Write expressions are retargeted
/// from `this.X` to `_v.X` because the template binds each variant in
/// its switch arm (`case Circle _v: …`), not via `this`. Decode
/// expressions pass through the shadowing scope so outer-type
/// references survive being rendered inside the enum's body.
fn lower_variant_field(
&self,
field: &AbiEnumField,
scope: &ShadowScope,
size_ctx: &mut emit::CSharpEmitContext,
encode_ctx: &mut emit::CSharpEmitContext,
decode_ctx: &mut emit::CSharpEmitContext,
) -> CSharpRecordField {
let prefixed = Self::prefix_write_seq(&field.encode, "_v");
let csharp_type = self
.lower_type(&field.type_expr)
.expect("variant field type must be supported")
.qualify_if_shadowed(scope.shadowed, scope.namespace);
CSharpRecordField {
name: NamingConvention::property_name(field.name.as_str()),
csharp_type,
wire_decode_expr: emit::emit_reader_read_shared(&field.decode, Some(scope), decode_ctx),
wire_size_expr: emit::emit_size_expr_shared(&prefixed.size, size_ctx),
wire_encode_expr: emit::emit_write_expr_shared(&prefixed, "wire", encode_ctx),
}
}
/// Walks an enum's `#[data(impl)]` constructors and methods and
/// produces the corresponding C# method plans. Fallible constructors
/// (`Result<Self, _>`), optional constructors (`Option<Self>`),
/// methods that return `Result<_, _>`, async methods, and
/// `&mut self` / `self` receivers are silently dropped. Those
/// shapes are served by later PRs on the roadmap, not by this one.
fn lower_enum_methods(
&self,
enum_def: &EnumDef,
enum_class_name: &str,
scope: Option<&ShadowScope>,
) -> Vec<CSharpMethod> {
let is_data = matches!(enum_def.repr, EnumRepr::Data { .. });
let mut methods = Vec::new();
for (index, ctor) in enum_def.constructors.iter().enumerate() {
if ctor.is_fallible() || ctor.is_optional() {
continue;
}
let call_id = CallId::EnumConstructor {
enum_id: enum_def.id.clone(),
index,
};
let Some(call) = self.abi.calls.iter().find(|c| c.id == call_id) else {
continue;
};
if let Some(method) = self.lower_enum_constructor(ctor, call, enum_class_name, is_data)
{
methods.push(method);
}
}
for method_def in &enum_def.methods {
if method_def.is_async() {
continue;
}
if matches!(
method_def.receiver,
Receiver::RefMutSelf | Receiver::OwnedSelf
) {
continue;
}
if matches!(method_def.returns, ReturnDef::Result { .. }) {
continue;
}
let call_id = CallId::EnumMethod {
enum_id: enum_def.id.clone(),
method_id: method_def.id.clone(),
};
let Some(call) = self.abi.calls.iter().find(|c| c.id == call_id) else {
continue;
};
if let Some(method) =
self.lower_enum_method(method_def, call, enum_class_name, is_data, scope)
{
methods.push(method);
}
}
methods
}
fn lower_enum_constructor(
&self,
ctor: &ConstructorDef,
call: &AbiCall,
enum_class_name: &str,
owner_is_data: bool,
) -> Option<CSharpMethod> {
let raw_name: &str = match ctor.name() {
Some(id) => id.as_str(),
None => "new",
};
let name = NamingConvention::method_name(raw_name);
let return_type = if owner_is_data {
CSharpType::DataEnum(enum_class_name.to_string())
} else {
CSharpType::CStyleEnum(enum_class_name.to_string())
};
let return_kind = if owner_is_data {
CSharpReturnKind::WireDecodeObject {
class_name: enum_class_name.to_string(),
}
} else {
CSharpReturnKind::Direct
};
let mut ctor_size_ctx = emit::CSharpEmitContext::default();
let mut ctor_encode_ctx = emit::CSharpEmitContext::default();
let wire_writers: Vec<CSharpWireWriter> = call
.params
.iter()
.filter_map(|p| self.wire_writer_for_param(p, &mut ctor_size_ctx, &mut ctor_encode_ctx))
.collect();
let param_defs = ctor.params();
let params: Vec<CSharpParam> = param_defs
.iter()
.map(|p| self.lower_param(p, &wire_writers))
.collect::<Option<Vec<_>>>()?;
Some(CSharpMethod {
native_method_name: format!("{enum_class_name}{name}"),
name,
ffi_name: call.symbol.as_str().to_string(),
receiver: CSharpReceiver::Static,
params,
return_type,
return_kind,
wire_writers,
})
}
fn lower_enum_method(
&self,
method_def: &MethodDef,
call: &AbiCall,
enum_class_name: &str,
owner_is_data: bool,
scope: Option<&ShadowScope>,
) -> Option<CSharpMethod> {
let name = NamingConvention::method_name(method_def.id.as_str());
let return_type = match &method_def.returns {
ReturnDef::Void => CSharpType::Void,
ReturnDef::Value(type_expr) => {
self.lower_type(type_expr)?.qualify_if_shadowed_opt(scope)
}
ReturnDef::Result { .. } => return None,
};
let return_kind = self.return_kind(
&method_def.returns,
&return_type,
call.returns.decode_ops.as_ref(),
scope,
);
let receiver = match method_def.receiver {
Receiver::Static => CSharpReceiver::Static,
Receiver::RefSelf | Receiver::RefMutSelf | Receiver::OwnedSelf if owner_is_data => {
CSharpReceiver::InstanceNative
}
Receiver::RefSelf | Receiver::RefMutSelf | Receiver::OwnedSelf => {
CSharpReceiver::InstanceExtension
}
};
// Instance methods have a synthetic `self` prepended to the ABI
// param list; skip it when building wire writers and mapping
// back to the explicit IR params, which never include `self`.
let explicit_abi_params = if matches!(receiver, CSharpReceiver::Static) {
&call.params[..]
} else {
&call.params[1..]
};
let mut method_size_ctx = emit::CSharpEmitContext::default();
let mut method_encode_ctx = emit::CSharpEmitContext::default();
let wire_writers: Vec<CSharpWireWriter> = explicit_abi_params
.iter()
.filter_map(|p| {
self.wire_writer_for_param(p, &mut method_size_ctx, &mut method_encode_ctx)
})
.collect();
let params: Vec<CSharpParam> = method_def
.params
.iter()
.map(|p| self.lower_param(p, &wire_writers))
.collect::<Option<Vec<_>>>()?;
Some(CSharpMethod {
native_method_name: format!("{enum_class_name}{name}"),
name,
ffi_name: call.symbol.as_str().to_string(),
receiver,
params,
return_type,
return_kind,
wire_writers,
})
}
fn lower_record_field(
&self,
record_id: &RecordId,
field: &FieldDef,
size_ctx: &mut emit::CSharpEmitContext,
encode_ctx: &mut emit::CSharpEmitContext,
decode_ctx: &mut emit::CSharpEmitContext,
) -> CSharpRecordField {
let decode_seq = self
.record_field_read_seq(record_id, &field.name)
.expect("record field decode ops");
let encode_seq = self
.record_field_write_seq(record_id, &field.name)
.expect("record field encode ops");
let csharp_type = self
.lower_type(&field.type_expr)
.expect("record field type must be supported");
CSharpRecordField {
name: NamingConvention::property_name(field.name.as_str()),
csharp_type,
wire_decode_expr: emit::emit_reader_read_shared(&decode_seq, None, decode_ctx),
wire_size_expr: emit::emit_size_expr_shared(&encode_seq.size, size_ctx),
wire_encode_expr: emit::emit_write_expr_shared(&encode_seq, "wire", encode_ctx),
}
}
fn record_field_read_seq(
&self,
record_id: &RecordId,
field_name: &FieldName,
) -> Option<ReadSeq> {
self.abi_record_for(record_id)
.and_then(|record| match record.decode_ops.ops.first() {
Some(ReadOp::Record { fields, .. }) => fields
.iter()
.find(|field| field.name == *field_name)
.map(|field| field.seq.clone()),
_ => None,
})
}
fn record_field_write_seq(
&self,
record_id: &RecordId,
field_name: &FieldName,
) -> Option<WriteSeq> {
self.abi_record_for(record_id)
.and_then(|record| match record.encode_ops.ops.first() {
Some(WriteOp::Record { fields, .. }) => fields
.iter()
.find(|field| field.name == *field_name)
.map(|field| field.seq.clone()),
_ => None,
})
}
fn abi_record_for(&self, record_id: &RecordId) -> Option<&AbiRecord> {
self.abi
.records
.iter()
.find(|record| record.id == *record_id)
}
/// Build one [`CSharpWireWriter`] per record param, in param order.
/// Returns `None` if the function's ABI call cannot be found (should
/// not happen for validated contracts).
fn wire_writers_for_params(&self, function: &FunctionDef) -> Option<Vec<CSharpWireWriter>> {
let call = self.abi_call_for_function(function)?;
// One size/encode context per function body so two Option
// params each get fresh `sizeOpt{n}` / `opt{n}` pattern-binding
// names. Their `using var _wire_*` declarations all live in
// the same method scope, so counters must advance together.
let mut size_ctx = emit::CSharpEmitContext::default();
let mut encode_ctx = emit::CSharpEmitContext::default();
Some(
call.params
.iter()
.filter_map(|abi_param| {
self.wire_writer_for_param(abi_param, &mut size_ctx, &mut encode_ctx)
})
.collect(),
)
}
fn wire_writer_for_param(
&self,
param: &AbiParam,
size_ctx: &mut emit::CSharpEmitContext,
encode_ctx: &mut emit::CSharpEmitContext,
) -> Option<CSharpWireWriter> {
let encode_ops = match ¶m.role {
ParamRole::Input {
encode_ops: Some(encode_ops),
..
} => encode_ops.clone(),
_ => return None,
};
if !self.param_needs_wire_buffer(encode_ops.ops.first()?) {
return None;
}
let param_name = param.name.as_str().to_string();
let binding_name = format!("_wire_{}", param_name);
let bytes_binding_name = format!("_{}Bytes", NamingConvention::field_name(¶m_name));
let encode_expr = emit::emit_write_expr_shared(&encode_ops, &binding_name, encode_ctx);
Some(CSharpWireWriter {
binding_name,
bytes_binding_name,
param_name,
size_expr: emit::emit_size_expr_shared(&encode_ops.size, size_ctx),
encode_expr,
})
}
/// Whether a param's encode op requires a `WireWriter` setup block
/// before the native call.
///
/// Primitives pass as value types, strings go through the UTF-8 byte
/// path, raw bytes ride as `byte[]` directly. Blittable records and
/// C-style enums also pass by value. Variable-width payloads
/// (non-blittable records, data enums, vecs) need a length-prefixed
/// buffer serialized up front.
fn param_needs_wire_buffer(&self, op: &WriteOp) -> bool {
match op {
WriteOp::Primitive { .. } | WriteOp::String { .. } | WriteOp::Bytes { .. } => false,
WriteOp::Record { id, .. } => !self.is_blittable_record(id),
WriteOp::Enum {
layout: EnumLayout::Data { .. },
..
} => true,
WriteOp::Enum { .. } => false,
WriteOp::Vec {
layout: VecLayout::Blittable { .. },
..
} => false,
WriteOp::Vec {
layout: VecLayout::Encoded,
..
} => true,
WriteOp::Option { .. } => true,
WriteOp::Result { .. } | WriteOp::Builtin { .. } | WriteOp::Custom { .. } => {
todo!("C# backend has not yet implemented param support for {op:?}")
}
}
}
fn abi_call_for_function(&self, function: &FunctionDef) -> Option<&AbiCall> {
self.abi.calls.iter().find(|call| match &call.id {
CallId::Function(id) => id == &function.id,
_ => false,
})
}
/// Rewrites a [`WriteSeq`] so every reference to the encoded value's
/// instance resolves to `{binding}` instead of the default `this`.
/// Used for data enum variant fields, where the switch statement
/// binds each variant as `case Circle _v:` and field references must
/// go through `_v.Radius` rather than `this.Radius`.
fn prefix_write_seq(seq: &WriteSeq, binding: &str) -> WriteSeq {
WriteSeq {
size: Self::prefix_size_expr(&seq.size, binding),
ops: seq
.ops
.iter()
.map(|op| Self::prefix_write_op(op, binding))
.collect(),
shape: seq.shape,
}
}
fn prefix_write_op(op: &WriteOp, binding: &str) -> WriteOp {
match op {
WriteOp::Primitive { primitive, value } => WriteOp::Primitive {
primitive: *primitive,
value: Self::prefix_value(value, binding),
},
WriteOp::String { value } => WriteOp::String {
value: Self::prefix_value(value, binding),
},
WriteOp::Bytes { value } => WriteOp::Bytes {
value: Self::prefix_value(value, binding),
},
WriteOp::Record { id, value, fields } => WriteOp::Record {
id: id.clone(),
value: Self::prefix_value(value, binding),
fields: fields
.iter()
.map(|f| FieldWriteOp {
name: f.name.clone(),
accessor: Self::prefix_value(&f.accessor, binding),
seq: Self::prefix_write_seq(&f.seq, binding),
})
.collect(),
},
WriteOp::Enum { id, value, layout } => WriteOp::Enum {
id: id.clone(),
value: Self::prefix_value(value, binding),
layout: layout.clone(),
},
WriteOp::Vec {
value,
element_type,
element,
layout,
} => WriteOp::Vec {
value: Self::prefix_value(value, binding),
element_type: element_type.clone(),
// `element` references the per-iteration loop binding
// (`item`), which belongs to the foreach the Vec writer
// emits around the enclosing variant scope. Rewriting it
// to `_v.item` would break the generated loop; leave the
// element seq untouched.
element: element.clone(),
layout: layout.clone(),
},
WriteOp::Option { value, some } => WriteOp::Option {
value: Self::prefix_value(value, binding),
// `some` is written inside an `if (field is { } v)` block
// where inner ops reference `v`, not the outer variant
// binding. Clone as-is, same as `Vec::element`.
some: some.clone(),
},
other => panic!(
"prefix_write_op: unsupported op for C# variant fields: {:?}",
other
),
}
}
fn prefix_value(value: &ValueExpr, binding: &str) -> ValueExpr {
match value {
ValueExpr::Instance => ValueExpr::Var(binding.to_string()),
ValueExpr::Named(name) => ValueExpr::Field(
Box::new(ValueExpr::Var(binding.to_string())),
FieldName::new(name),
),
ValueExpr::Var(_) => value.clone(),
ValueExpr::Field(parent, field) => {
ValueExpr::Field(Box::new(Self::prefix_value(parent, binding)), field.clone())
}
}
}
fn prefix_size_expr(expr: &SizeExpr, binding: &str) -> SizeExpr {
match expr {
SizeExpr::Fixed(_) | SizeExpr::Runtime => expr.clone(),
SizeExpr::StringLen(v) => SizeExpr::StringLen(Self::prefix_value(v, binding)),
SizeExpr::BytesLen(v) => SizeExpr::BytesLen(Self::prefix_value(v, binding)),
SizeExpr::ValueSize(v) => SizeExpr::ValueSize(Self::prefix_value(v, binding)),
SizeExpr::WireSize { value, owner } => SizeExpr::WireSize {
value: Self::prefix_value(value, binding),
owner: owner.clone(),
},
SizeExpr::Sum(parts) => SizeExpr::Sum(
parts
.iter()
.map(|p| Self::prefix_size_expr(p, binding))
.collect(),
),
SizeExpr::VecSize {
value,
inner,
layout,
} => SizeExpr::VecSize {
value: Self::prefix_value(value, binding),
// `inner` uses the per-element loop variable (`item`) the
// encoded-array size lambda binds. The `_v` rewrite only
// applies to the enclosing variant field reference.
inner: inner.clone(),
layout: layout.clone(),
},
SizeExpr::OptionSize { value, inner } => SizeExpr::OptionSize {
value: Self::prefix_value(value, binding),
// `inner` references the unwrapped-option binding `v` that
// the size-option emit lambda introduces, not the enclosing
// variant field. Clone as-is, same as `VecSize::inner`.
inner: inner.clone(),
},
other => panic!(
"prefix_size_expr: unsupported expr for C# variant fields: {:?}",
other
),
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::ir::Lowerer as IrLowerer;
use crate::ir::contract::{FfiContract, PackageInfo};
use crate::ir::definitions::{DataVariant, EnumDef, FunctionDef, ParamDef, ReturnDef};
use crate::ir::types::PrimitiveType;
use boltffi_ffi_rules::callable::ExecutionKind;
use crate::ir::ids::{FunctionId, ParamName};
fn data_enum(id: &str, variants: Vec<DataVariant>) -> EnumDef {
EnumDef {
id: EnumId::new(id),
repr: EnumRepr::Data {
tag_type: PrimitiveType::I32,
variants,
},
is_error: false,
constructors: vec![],
methods: vec![],
doc: None,
deprecated: None,
}
}
fn struct_variant(
name: &str,
discriminant: i128,
fields: Vec<(&str, TypeExpr)>,
) -> DataVariant {
DataVariant {
name: name.into(),
discriminant,
payload: VariantPayload::Struct(
fields
.into_iter()
.map(|(field_name, ty)| FieldDef {
name: field_name.into(),
type_expr: ty,
doc: None,
default: None,
})
.collect(),
),
doc: None,
}
}
fn record_with_one_field(id: &str, field_name: &str, type_expr: TypeExpr) -> RecordDef {
RecordDef {
id: RecordId::new(id),
is_repr_c: false,
is_error: false,
fields: vec![FieldDef {
name: field_name.into(),
type_expr,
doc: None,
default: None,
}],
constructors: vec![],
methods: vec![],
doc: None,
deprecated: None,
}
}
/// A record field that points at a data enum must still let the
/// record qualify as supported. Records and data enums are computed
/// in a joint fixed-point precisely so a record can wait a pass for
/// the data enum it references, and vice versa.
#[test]
fn record_referencing_data_enum_is_admitted_jointly() {
let mut contract = FfiContract {
package: PackageInfo {
name: "demo_lib".to_string(),
version: None,
},
functions: vec![],
catalog: Default::default(),
};
contract.catalog.insert_enum(data_enum(
"shape",
vec![struct_variant(
"Circle",
0,
vec![("radius", TypeExpr::Primitive(PrimitiveType::F64))],
)],
));
contract.catalog.insert_record(record_with_one_field(
"holder",
"shape",
TypeExpr::Enum(EnumId::new("shape")),
));
let (records, enums) = CSharpLowerer::compute_supported_sets(&contract);
assert!(
enums.contains("shape"),
"expecting the data enum to be admitted first so the record can reference it",
);
assert!(
records.contains("holder"),
"expecting the record with a data-enum field to be admitted once the enum joins the set",
);
}
/// A data enum whose variant carries another data enum must still be
/// admitted to `supported_enums`. The fixed-point lets `outer` join
/// on the iteration after `inner` is admitted, even though they're
/// declared in a single pass.
#[test]
fn data_enum_referencing_another_data_enum_is_admitted() {
let mut contract = FfiContract {
package: PackageInfo {
name: "demo_lib".to_string(),
version: None,
},
functions: vec![],
catalog: Default::default(),
};
contract.catalog.insert_enum(data_enum(
"inner",
vec![struct_variant(
"Value",
0,
vec![("n", TypeExpr::Primitive(PrimitiveType::I32))],
)],
));
contract.catalog.insert_enum(data_enum(
"outer",
vec![struct_variant(
"Wrap",
0,
vec![("inner", TypeExpr::Enum(EnumId::new("inner")))],
)],
));
let (_records, enums) = CSharpLowerer::compute_supported_sets(&contract);
assert!(
enums.contains("inner"),
"expecting the leaf data enum to be admitted",
);
assert!(
enums.contains("outer"),
"expecting the data enum referencing another data enum to join on a later fixed-point iteration",
);
}
/// C# enums only support fixed-width integral backing types. A Rust
/// `#[repr(usize)]` C-style enum therefore stays out of the supported
/// set so the backend never tries to render an illegal `enum : nuint`.
#[test]
fn c_style_enum_with_usize_repr_is_not_admitted() {
let mut contract = FfiContract {
package: PackageInfo {
name: "demo_lib".to_string(),
version: None,
},
functions: vec![],
catalog: Default::default(),
};
contract.catalog.insert_enum(EnumDef {
id: EnumId::new("platform_status"),
repr: EnumRepr::CStyle {
tag_type: PrimitiveType::USize,
variants: vec![crate::ir::definitions::CStyleVariant {
name: "Ready".into(),
discriminant: 0,
doc: None,
}],
},
is_error: false,
constructors: vec![],
methods: vec![],
doc: None,
deprecated: None,
});
let (_records, enums) = CSharpLowerer::compute_supported_sets(&contract);
assert!(
!enums.contains("platform_status"),
"expecting repr(usize) C-style enums to stay unsupported until the backend has a legal C# projection",
);
}
/// C# projects `Option<T>` as `T?`, so `Option<Option<i32>>` would
/// need `int??`, which does not parse. Reject the shape at the
/// backend support gate rather than silently emitting uncompilable
/// code or flattening away the `Some(None)` state.
#[test]
fn nested_option_shapes_are_rejected() {
let mut contract = FfiContract {
package: PackageInfo {
name: "demo_lib".to_string(),
version: None,
},
functions: vec![],
catalog: Default::default(),
};
let nested_option = TypeExpr::Option(Box::new(TypeExpr::Option(Box::new(
TypeExpr::Primitive(PrimitiveType::I32),
))));
contract.catalog.insert_record(record_with_one_field(
"holder",
"value",
nested_option.clone(),
));
contract.functions.push(FunctionDef {
id: FunctionId::new("echo_nested_option"),
params: vec![ParamDef {
name: ParamName::new("value"),
type_expr: nested_option.clone(),
passing: ParamPassing::Value,
doc: None,
}],
returns: ReturnDef::Value(nested_option.clone()),
execution_kind: ExecutionKind::Sync,
doc: None,
deprecated: None,
});
let abi = IrLowerer::new(&contract).to_abi_contract();
let options = CSharpOptions::default();
let lowerer = CSharpLowerer::new(&contract, &abi, &options);
let (records, _enums) = CSharpLowerer::compute_supported_sets(&contract);
assert!(
!records.contains("holder"),
"expecting a record with Option<Option<i32>> field to stay unsupported because it would render as int??",
);
assert!(
!lowerer.is_supported_type(&nested_option),
"expecting Option<Option<i32>> to fail the C# support gate before lowering",
);
assert!(
lowerer.lower_function(&contract.functions[0]).is_none(),
"expecting a function with nested Option param/return to be dropped rather than emitting int??",
);
}
}